sys/vm/uma_int.h

   1 /*-
   2  * Copyright (c) 2002-2005, 2009, 2013 Jeffrey Roberson <jeff@FreeBSD.org>
   3  * Copyright (c) 2004, 2005 Bosko Milekic <bmilekic@FreeBSD.org>
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice unmodified, this list of conditions, and the following
  11  *    disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  *
  29  */
  30
  31 #include <sys/_task.h>
  32
  33 /*
  34  * This file includes definitions, structures, prototypes, and inlines that
  35  * should not be used outside of the actual implementation of UMA.
  36  */
  37
  38 /*
  39  * Here's a quick description of the relationship between the objects:
  40  *
  41  * Kegs contain lists of slabs which are stored in either the full bin, empty
  42  * bin, or partially allocated bin, to reduce fragmentation.  They also contain
  43  * the user supplied value for size, which is adjusted for alignment purposes
  44  * and rsize is the result of that.  The Keg also stores information for
  45  * managing a hash of page addresses that maps pages to uma_slab_t structures
  46  * for pages that don't have embedded uma_slab_t's.
  47  *
  48  * The uma_slab_t may be embedded in a UMA_SLAB_SIZE chunk of memory or it may
  49  * be allocated off the page from a special slab zone.  The free list within a
  50  * slab is managed with a bitmask.  For item sizes that would yield more than
  51  * 10% memory waste we potentially allocate a separate uma_slab_t if this will
  52  * improve the number of items per slab that will fit.
  53  *
  54  * The only really gross cases, with regards to memory waste, are for those
  55  * items that are just over half the page size.   You can get nearly 50% waste,
  56  * so you fall back to the memory footprint of the power of two allocator. I
  57  * have looked at memory allocation sizes on many of the machines available to
  58  * me, and there does not seem to be an abundance of allocations at this range
  59  * so at this time it may not make sense to optimize for it.  This can, of
  60  * course, be solved with dynamic slab sizes.
  61  *
  62  * Kegs may serve multiple Zones but by far most of the time they only serve
  63  * one.  When a Zone is created, a Keg is allocated and setup for it.  While
  64  * the backing Keg stores slabs, the Zone caches Buckets of items allocated
  65  * from the slabs.  Each Zone is equipped with an init/fini and ctor/dtor
  66  * pair, as well as with its own set of small per-CPU caches, layered above
  67  * the Zone's general Bucket cache.
  68  *
  69  * The PCPU caches are protected by critical sections, and may be accessed
  70  * safely only from their associated CPU, while the Zones backed by the same
  71  * Keg all share a common Keg lock (to coalesce contention on the backing
  72  * slabs).  The backing Keg typically only serves one Zone but in the case of
  73  * multiple Zones, one of the Zones is considered the Master Zone and all
  74  * Zone-related stats from the Keg are done in the Master Zone.  For an
  75  * example of a Multi-Zone setup, refer to the Mbuf allocation code.
  76  */
  77
  78 /*
  79  *      This is the representation for normal (Non OFFPAGE slab)
  80  *
  81  *      i == item
  82  *      s == slab pointer
  83  *
  84  *      <----------------  Page (UMA_SLAB_SIZE) ------------------>
  85  *      ___________________________________________________________
  86  *     | _  _  _  _  _  _  _  _  _  _  _  _  _  _  _   ___________ |
  87  *     ||i||i||i||i||i||i||i||i||i||i||i||i||i||i||i| |slab header||
  88  *     ||_||_||_||_||_||_||_||_||_||_||_||_||_||_||_| |___________||
  89  *     |___________________________________________________________|
  90  *
  91  *
  92  *      This is an OFFPAGE slab. These can be larger than UMA_SLAB_SIZE.
  93  *
  94  *      ___________________________________________________________
  95  *     | _  _  _  _  _  _  _  _  _  _  _  _  _  _  _  _  _  _  _   |
  96  *     ||i||i||i||i||i||i||i||i||i||i||i||i||i||i||i||i||i||i||i|  |
  97  *     ||_||_||_||_||_||_||_||_||_||_||_||_||_||_||_||_||_||_||_|  |
  98  *     |___________________________________________________________|
  99  *       ___________    ^
 100  *      |slab header|   |
 101  *      |___________|---*
 102  *
 103  */
 104
 105 #ifndef VM_UMA_INT_H
 106 #define VM_UMA_INT_H
 107
 108 #define UMA_SLAB_SIZE   PAGE_SIZE       /* How big are our slabs? */
 109 #define UMA_SLAB_MASK   (PAGE_SIZE - 1) /* Mask to get back to the page */
 110 #define UMA_SLAB_SHIFT  PAGE_SHIFT      /* Number of bits PAGE_MASK */
 111
 112 #define UMA_BOOT_PAGES          64      /* Pages allocated for startup */
 113
 114 /* Max waste percentage before going to off page slab management */
 115 #define UMA_MAX_WASTE   10
 116
 117 /*
 118  * I doubt there will be many cases where this is exceeded. This is the initial
 119  * size of the hash table for uma_slabs that are managed off page. This hash
 120  * does expand by powers of two.  Currently it doesn't get smaller.
 121  */
 122 #define UMA_HASH_SIZE_INIT      32
 123
 124 /*
 125  * I should investigate other hashing algorithms.  This should yield a low
 126  * number of collisions if the pages are relatively contiguous.
 127  */
 128
 129 #define UMA_HASH(h, s) ((((uintptr_t)s) >> UMA_SLAB_SHIFT) & (h)->uh_hashmask)
 130
 131 #define UMA_HASH_INSERT(h, s, mem)                                      \
 132                 SLIST_INSERT_HEAD(&(h)->uh_slab_hash[UMA_HASH((h),      \
 133                     (mem))], (s), us_hlink)
 134 #define UMA_HASH_REMOVE(h, s, mem)                                      \
 135                 SLIST_REMOVE(&(h)->uh_slab_hash[UMA_HASH((h),           \
 136                     (mem))], (s), uma_slab, us_hlink)
 137
 138 /* Hash table for freed address -> slab translation */
 139
 140 SLIST_HEAD(slabhead, uma_slab);
 141
 142 struct uma_hash {
 143         struct slabhead *uh_slab_hash;  /* Hash table for slabs */
 144         int             uh_hashsize;    /* Current size of the hash table */
 145         int             uh_hashmask;    /* Mask used during hashing */
 146 };
 147
 148 /*
 149  * align field or structure to cache line
 150  */
 151 #if defined(__amd64__)
 152 #define UMA_ALIGN       __aligned(CACHE_LINE_SIZE)
 153 #else
 154 #define UMA_ALIGN
 155 #endif
 156
 157 /*
 158  * Structures for per cpu queues.
 159  */
 160
 161 struct uma_bucket {
 162         LIST_ENTRY(uma_bucket)  ub_link;        /* Link into the zone */
 163         int16_t ub_cnt;                         /* Count of free items. */
 164         int16_t ub_entries;                     /* Max items. */
 165         void    *ub_bucket[];                   /* actual allocation storage */
 166 };
 167
 168 typedef struct uma_bucket * uma_bucket_t;
 169
 170 struct uma_cache {
 171         uma_bucket_t    uc_freebucket;  /* Bucket we're freeing to */
 172         uma_bucket_t    uc_allocbucket; /* Bucket to allocate from */
 173         uint64_t        uc_allocs;      /* Count of allocations */
 174         uint64_t        uc_frees;       /* Count of frees */
 175 } UMA_ALIGN;
 176
 177 typedef struct uma_cache * uma_cache_t;
 178
 179 /*
 180  * Keg management structure
 181  *
 182  * TODO: Optimize for cache line size
 183  *
 184  */
 185 struct uma_keg {
 186         struct mtx_padalign     uk_lock;        /* Lock for the keg */
 187         struct uma_hash uk_hash;
 188
 189         LIST_HEAD(,uma_zone)    uk_zones;       /* Keg's zones */
 190         LIST_HEAD(,uma_slab)    uk_part_slab;   /* partially allocated slabs */
 191         LIST_HEAD(,uma_slab)    uk_free_slab;   /* empty slab list */
 192         LIST_HEAD(,uma_slab)    uk_full_slab;   /* full slabs */
 193
 194         uint32_t        uk_align;       /* Alignment mask */
 195         uint32_t        uk_pages;       /* Total page count */
 196         uint32_t        uk_free;        /* Count of items free in slabs */
 197         uint32_t        uk_reserve;     /* Number of reserved items. */
 198         uint32_t        uk_size;        /* Requested size of each item */
 199         uint32_t        uk_rsize;       /* Real size of each item */
 200         uint32_t        uk_maxpages;    /* Maximum number of pages to alloc */
 201
 202         uma_init        uk_init;        /* Keg's init routine */
 203         uma_fini        uk_fini;        /* Keg's fini routine */
 204         uma_alloc       uk_allocf;      /* Allocation function */
 205         uma_free        uk_freef;       /* Free routine */
 206
 207         u_long          uk_offset;      /* Next free offset from base KVA */
 208         vm_offset_t     uk_kva;         /* Zone base KVA */
 209         uma_zone_t      uk_slabzone;    /* Slab zone backing us, if OFFPAGE */
 210
 211         uint16_t        uk_slabsize;    /* Slab size for this keg */
 212         uint16_t        uk_pgoff;       /* Offset to uma_slab struct */
 213         uint16_t        uk_ppera;       /* pages per allocation from backend */
 214         uint16_t        uk_ipers;       /* Items per slab */
 215         uint32_t        uk_flags;       /* Internal flags */
 216
 217         /* Least used fields go to the last cache line. */
 218         const char      *uk_name;               /* Name of creating zone. */
 219         LIST_ENTRY(uma_keg)     uk_link;        /* List of all kegs */
 220 };
 221 typedef struct uma_keg  * uma_keg_t;
 222
 223 /*
 224  * Free bits per-slab.
 225  */
 226 #define SLAB_SETSIZE    (PAGE_SIZE / UMA_SMALLEST_UNIT)
 227 BITSET_DEFINE(slabbits, SLAB_SETSIZE);
 228
 229 /*
 230  * The slab structure manages a single contiguous allocation from backing
 231  * store and subdivides it into individually allocatable items.
 232  */
 233 struct uma_slab {
 234         uma_keg_t       us_keg;                 /* Keg we live in */
 235         union {
 236                 LIST_ENTRY(uma_slab)    _us_link;       /* slabs in zone */
 237                 unsigned long   _us_size;       /* Size of allocation */
 238         } us_type;
 239         SLIST_ENTRY(uma_slab)   us_hlink;       /* Link for hash table */
 240         uint8_t         *us_data;               /* First item */
 241         struct slabbits us_free;                /* Free bitmask. */
 242 #ifdef INVARIANTS
 243         struct slabbits us_debugfree;           /* Debug bitmask. */
 244 #endif
 245         uint16_t        us_freecount;           /* How many are free? */
 246         uint8_t         us_flags;               /* Page flags see uma.h */
 247         uint8_t         us_pad;                 /* Pad to 32bits, unused. */
 248 };
 249
 250 #define us_link us_type._us_link
 251 #define us_size us_type._us_size
 252
 253 typedef struct uma_slab * uma_slab_t;
 254 typedef uma_slab_t (*uma_slaballoc)(uma_zone_t, uma_keg_t, int);
 255
 256 struct uma_klink {
 257         LIST_ENTRY(uma_klink)   kl_link;
 258         uma_keg_t               kl_keg;
 259 };
 260 typedef struct uma_klink *uma_klink_t;
 261
 262 /*
 263  * Zone management structure
 264  *
 265  * TODO: Optimize for cache line size
 266  *
 267  */
 268 struct uma_zone {
 269         struct mtx_padalign     uz_lock;        /* Lock for the zone */
 270         struct mtx_padalign     *uz_lockptr;
 271         const char              *uz_name;       /* Text name of the zone */
 272
 273         LIST_ENTRY(uma_zone)    uz_link;        /* List of all zones in keg */
 274         LIST_HEAD(,uma_bucket)  uz_buckets;     /* full buckets */
 275
 276         LIST_HEAD(,uma_klink)   uz_kegs;        /* List of kegs. */
 277         struct uma_klink        uz_klink;       /* klink for first keg. */
 278
 279         uma_slaballoc   uz_slab;        /* Allocate a slab from the backend. */
 280         uma_ctor        uz_ctor;        /* Constructor for each allocation */
 281         uma_dtor        uz_dtor;        /* Destructor */
 282         uma_init        uz_init;        /* Initializer for each item */
 283         uma_fini        uz_fini;        /* Finalizer for each item. */
 284         uma_import      uz_import;      /* Import new memory to cache. */
 285         uma_release     uz_release;     /* Release memory from cache. */
 286         void            *uz_arg;        /* Import/release argument. */
 287
 288         uint32_t        uz_flags;       /* Flags inherited from kegs */
 289         uint32_t        uz_size;        /* Size inherited from kegs */
 290
 291         volatile u_long uz_allocs UMA_ALIGN; /* Total number of allocations */
 292         volatile u_long uz_fails;       /* Total number of alloc failures */
 293         volatile u_long uz_frees;       /* Total number of frees */
 294         uint64_t        uz_sleeps;      /* Total number of alloc sleeps */
 295         uint16_t        uz_count;       /* Amount of items in full bucket */
 296         uint16_t        uz_count_min;   /* Minimal amount of items there */
 297
 298         /* The next two fields are used to print a rate-limited warnings. */
 299         const char      *uz_warning;    /* Warning to print on failure */
 300         struct timeval  uz_ratecheck;   /* Warnings rate-limiting */
 301
 302         struct task     uz_maxaction;   /* Task to run when at limit */
 303
 304         /*
 305          * This HAS to be the last item because we adjust the zone size
 306          * based on NCPU and then allocate the space for the zones.
 307          */
 308         struct uma_cache        uz_cpu[1]; /* Per cpu caches */
 309 };
 310
 311 /*
 312  * These flags must not overlap with the UMA_ZONE flags specified in uma.h.
 313  */
 314 #define UMA_ZFLAG_MULTI         0x04000000      /* Multiple kegs in the zone. */
 315 #define UMA_ZFLAG_DRAINING      0x08000000      /* Running zone_drain. */
 316 #define UMA_ZFLAG_BUCKET        0x10000000      /* Bucket zone. */
 317 #define UMA_ZFLAG_INTERNAL      0x20000000      /* No offpage no PCPU. */
 318 #define UMA_ZFLAG_FULL          0x40000000      /* Reached uz_maxpages */
 319 #define UMA_ZFLAG_CACHEONLY     0x80000000      /* Don't ask VM for buckets. */
 320
 321 #define UMA_ZFLAG_INHERIT                                               \
 322     (UMA_ZFLAG_INTERNAL | UMA_ZFLAG_CACHEONLY | UMA_ZFLAG_BUCKET)
 323
 324 static inline uma_keg_t
 325 zone_first_keg(uma_zone_t zone)
 326 {
 327         uma_klink_t klink;
 328
 329         klink = LIST_FIRST(&zone->uz_kegs);
 330         return (klink != NULL) ? klink->kl_keg : NULL;
 331 }
 332
 333 #undef UMA_ALIGN
 334
 335 #ifdef _KERNEL
 336 /* Internal prototypes */
 337 static __inline uma_slab_t hash_sfind(struct uma_hash *hash, uint8_t *data);
 338 void *uma_large_malloc(vm_size_t size, int wait);
 339 void uma_large_free(uma_slab_t slab);
 340
 341 /* Lock Macros */
 342
 343 #define KEG_LOCK_INIT(k, lc)                                    \
 344         do {                                                    \
 345                 if ((lc))                                       \
 346                         mtx_init(&(k)->uk_lock, (k)->uk_name,   \
 347                             (k)->uk_name, MTX_DEF | MTX_DUPOK); \
 348                 else                                            \
 349                         mtx_init(&(k)->uk_lock, (k)->uk_name,   \
 350                             "UMA zone", MTX_DEF | MTX_DUPOK);   \
 351         } while (0)
 352
 353 #define KEG_LOCK_FINI(k)        mtx_destroy(&(k)->uk_lock)
 354 #define KEG_LOCK(k)     mtx_lock(&(k)->uk_lock)
 355 #define KEG_UNLOCK(k)   mtx_unlock(&(k)->uk_lock)
 356
 357 #define ZONE_LOCK_INIT(z, lc)                                   \
 358         do {                                                    \
 359                 if ((lc))                                       \
 360                         mtx_init(&(z)->uz_lock, (z)->uz_name,   \
 361                             (z)->uz_name, MTX_DEF | MTX_DUPOK); \
 362                 else                                            \
 363                         mtx_init(&(z)->uz_lock, (z)->uz_name,   \
 364                             "UMA zone", MTX_DEF | MTX_DUPOK);   \
 365         } while (0)
 366
 367 #define ZONE_LOCK(z)    mtx_lock((z)->uz_lockptr)
 368 #define ZONE_TRYLOCK(z) mtx_trylock((z)->uz_lockptr)
 369 #define ZONE_UNLOCK(z)  mtx_unlock((z)->uz_lockptr)
 370 #define ZONE_LOCK_FINI(z)       mtx_destroy(&(z)->uz_lock)
 371
 372 /*
 373  * Find a slab within a hash table.  This is used for OFFPAGE zones to lookup
 374  * the slab structure.
 375  *
 376  * Arguments:
 377  *      hash  The hash table to search.
 378  *      data  The base page of the item.
 379  *
 380  * Returns:
 381  *      A pointer to a slab if successful, else NULL.
 382  */
 383 static __inline uma_slab_t
 384 hash_sfind(struct uma_hash *hash, uint8_t *data)
 385 {
 386         uma_slab_t slab;
 387         int hval;
 388
 389         hval = UMA_HASH(hash, data);
 390
 391         SLIST_FOREACH(slab, &hash->uh_slab_hash[hval], us_hlink) {
 392                 if ((uint8_t *)slab->us_data == data)
 393                         return (slab);
 394         }
 395         return (NULL);
 396 }
 397
 398 static __inline uma_slab_t
 399 vtoslab(vm_offset_t va)
 400 {
 401         vm_page_t p;
 402
 403         p = PHYS_TO_VM_PAGE(pmap_kextract(va));
 404         return ((uma_slab_t)p->plinks.s.pv);
 405 }
 406
 407 static __inline void
 408 vsetslab(vm_offset_t va, uma_slab_t slab)
 409 {
 410         vm_page_t p;
 411
 412         p = PHYS_TO_VM_PAGE(pmap_kextract(va));
 413         p->plinks.s.pv = slab;
 414 }
 415
 416 /*
 417  * The following two functions may be defined by architecture specific code
 418  * if they can provide more efficient allocation functions.  This is useful
 419  * for using direct mapped addresses.
 420  */
 421 void *uma_small_alloc(uma_zone_t zone, vm_size_t bytes, uint8_t *pflag,
 422     int wait);
 423 void uma_small_free(void *mem, vm_size_t size, uint8_t flags);
 424 #endif /* _KERNEL */
 425
 426 #endif /* VM_UMA_INT_H */