Print this page
more copy-editting from Josh


  24      void
  25      vmem_destroy(vmem_t *vmp);
  26 
  27 INTERFACE LEVEL
  28      illumos DDI specific
  29 
  30 PARAMETERS
  31      name    A character string giving a name to the vmem arena to be created.
  32 
  33      base    An address indicating the lowest possible value in the arena.
  34 
  35      size    The size of the arena to create.
  36 
  37      quantum
  38              The arena's ``quantum''.  The granularity of the arena.  The
  39              amount allocated at minimum by each request.  Must be a power of
  40              2.
  41 
  42      afunc   A function which is called to import new spans from source, which
  43              may be NULL if this arena does not import from another.  When
  44              calling vmem_create() afunc is an vmem_alloc_t a function taking
  45              three parameters and returning a pointer to void (the imported
  46              space):
  47 
  48              vmem_t *
  49                      The source arena from which we'll import.  The source
  50                      argument to vmem_create().
  51 
  52              size_t  The size to import
  53 
  54              int     The vmflag argument used for the import.
  55 
  56              When calling vmem_xcreate() afunc is an vmem_ximport_t a function
  57              taking four parameters and returning a pointer to void (the
  58              imported space):
  59 
  60              vmem_t *
  61                      The source arena from which we'll import.  The source
  62                      argument to vmem_xcreate().
  63 
  64              size_t *
  65                      The size of the import, afunc may increase this size if
  66                      that is desirable, but must never decrease it.
  67 
  68              size_t  The desired alignment of the imported space.
  69 
  70              int     the vmflag argument used for the import.
  71 
  72      ffunc   A function which is called to return spans to source, which may
  73              be NULL if this arena does not import from another.  This is a
  74              vmem_free_t a function taking three parametes and returning void:

  75 
  76              vmem_t  The arena to which space is being returned.  The source
  77                      argument to vmem_create() or vmem_xcreate().
  78 
  79              void *  The span being returned to the source arena.
  80 
  81              size_t  The size of the span being returned to the source arena.
  82 
  83      source  An arena from which this arena will import, which may be NULL if
  84              this arena does not import from another.
  85 
  86      qcache_max
  87              Each arena offers caching of integer multiples of quantum up to
  88              qcache_max, which may be 0.
  89 
  90      vmflag  A bitmask of flags indicating the characteristics of this arena.
  91 
  92              VMC_IDENTIFIER
  93                      The arena represents arbitrary integer identifiers,
  94                      rather than virtual memory.




  24      void
  25      vmem_destroy(vmem_t *vmp);
  26 
  27 INTERFACE LEVEL
  28      illumos DDI specific
  29 
  30 PARAMETERS
  31      name    A character string giving a name to the vmem arena to be created.
  32 
  33      base    An address indicating the lowest possible value in the arena.
  34 
  35      size    The size of the arena to create.
  36 
  37      quantum
  38              The arena's ``quantum''.  The granularity of the arena.  The
  39              amount allocated at minimum by each request.  Must be a power of
  40              2.
  41 
  42      afunc   A function which is called to import new spans from source, which
  43              may be NULL if this arena does not import from another.  When
  44              calling vmem_create(), afunc is a vmem_alloc_t, a function taking
  45              three parameters and returning a pointer to void (the imported
  46              space):
  47 
  48              vmem_t *
  49                      The source arena from which we'll import.  The source
  50                      argument to vmem_create().
  51 
  52              size_t  The size to import.
  53 
  54              int     The vmflag argument used for the import.
  55 
  56              When calling vmem_xcreate(), afunc is a vmem_ximport_t, a
  57              function taking four parameters and returning a pointer to void
  58              (the imported space):
  59 
  60              vmem_t *
  61                      The source arena from which we'll import.  The source
  62                      argument to vmem_xcreate().
  63 
  64              size_t *
  65                      The size of the import.  afunc may increase this size if
  66                      that is desirable, but must never decrease it.
  67 
  68              size_t  The desired alignment of the imported space.
  69 
  70              int     The vmflag argument used for the import.
  71 
  72      ffunc   A function which is called to return spans to source, which may
  73              be NULL if this arena does not import from another.  This is a
  74              vmem_free_t, a function taking three parameters and returning
  75              void:
  76 
  77              vmem_t  The arena to which space is being returned.  The source
  78                      argument to vmem_create() or vmem_xcreate().
  79 
  80              void *  The span being returned to the source arena.
  81 
  82              size_t  The size of the span being returned to the source arena.
  83 
  84      source  An arena from which this arena will import, which may be NULL if
  85              this arena does not import from another.
  86 
  87      qcache_max
  88              Each arena offers caching of integer multiples of quantum up to
  89              qcache_max, which may be 0.
  90 
  91      vmflag  A bitmask of flags indicating the characteristics of this arena.
  92 
  93              VMC_IDENTIFIER
  94                      The arena represents arbitrary integer identifiers,
  95                      rather than virtual memory.