source: rtems-libbsd/freebsd/sys/vm/uma.h

5-freebsd-12
Last change on this file was dbb2407, checked in by Sebastian Huber <sebastian.huber@…>, on Oct 23, 2018 at 10:11:54 AM

ZONE(9): Disable UMA_ZONE_NUMA

There is no NUMA support in RTEMS currently.

  • Property mode set to 100644
File size: 21.9 KB
Line 
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2002, 2003, 2004, 2005 Jeffrey Roberson <jeff@FreeBSD.org>
5 * Copyright (c) 2004, 2005 Bosko Milekic <bmilekic@FreeBSD.org>
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice unmodified, this list of conditions, and the following
13 *    disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * $FreeBSD$
30 *
31 */
32
33/*
34 * uma.h - External definitions for the Universal Memory Allocator
35 *
36*/
37
38#ifndef _VM_UMA_H_
39#define _VM_UMA_H_
40
41#include <sys/param.h>          /* For NULL */
42#include <sys/malloc.h>         /* For M_* */
43
44/* User visible parameters */
45#define UMA_SMALLEST_UNIT       (PAGE_SIZE / 256) /* Smallest item allocated */
46
47/* Types and type defs */
48
49struct uma_zone;
50/* Opaque type used as a handle to the zone */
51typedef struct uma_zone * uma_zone_t;
52
53void zone_drain(uma_zone_t);
54
55/*
56 * Item constructor
57 *
58 * Arguments:
59 *      item  A pointer to the memory which has been allocated.
60 *      arg   The arg field passed to uma_zalloc_arg
61 *      size  The size of the allocated item
62 *      flags See zalloc flags
63 *
64 * Returns:
65 *      0      on success
66 *      errno  on failure
67 *
68 * Discussion:
69 *      The constructor is called just before the memory is returned
70 *      to the user. It may block if necessary.
71 */
72typedef int (*uma_ctor)(void *mem, int size, void *arg, int flags);
73
74/*
75 * Item destructor
76 *
77 * Arguments:
78 *      item  A pointer to the memory which has been allocated.
79 *      size  The size of the item being destructed.
80 *      arg   Argument passed through uma_zfree_arg
81 *
82 * Returns:
83 *      Nothing
84 *
85 * Discussion:
86 *      The destructor may perform operations that differ from those performed
87 *      by the initializer, but it must leave the object in the same state.
88 *      This IS type stable storage.  This is called after EVERY zfree call.
89 */
90typedef void (*uma_dtor)(void *mem, int size, void *arg);
91
92/*
93 * Item initializer
94 *
95 * Arguments:
96 *      item  A pointer to the memory which has been allocated.
97 *      size  The size of the item being initialized.
98 *      flags See zalloc flags
99 *
100 * Returns:
101 *      0      on success
102 *      errno  on failure
103 *
104 * Discussion:
105 *      The initializer is called when the memory is cached in the uma zone.
106 *      The initializer and the destructor should leave the object in the same
107 *      state.
108 */
109typedef int (*uma_init)(void *mem, int size, int flags);
110
111/*
112 * Item discard function
113 *
114 * Arguments:
115 *      item  A pointer to memory which has been 'freed' but has not left the
116 *            zone's cache.
117 *      size  The size of the item being discarded.
118 *
119 * Returns:
120 *      Nothing
121 *
122 * Discussion:
123 *      This routine is called when memory leaves a zone and is returned to the
124 *      system for other uses.  It is the counter-part to the init function.
125 */
126typedef void (*uma_fini)(void *mem, int size);
127
128/*
129 * Import new memory into a cache zone.
130 */
131typedef int (*uma_import)(void *arg, void **store, int count, int domain,
132    int flags);
133
134/*
135 * Free memory from a cache zone.
136 */
137typedef void (*uma_release)(void *arg, void **store, int count);
138
139/*
140 * What's the difference between initializing and constructing?
141 *
142 * The item is initialized when it is cached, and this is the state that the
143 * object should be in when returned to the allocator. The purpose of this is
144 * to remove some code which would otherwise be called on each allocation by
145 * utilizing a known, stable state.  This differs from the constructor which
146 * will be called on EVERY allocation.
147 *
148 * For example, in the initializer you may want to initialize embedded locks,
149 * NULL list pointers, set up initial states, magic numbers, etc.  This way if
150 * the object is held in the allocator and re-used it won't be necessary to
151 * re-initialize it.
152 *
153 * The constructor may be used to lock a data structure, link it on to lists,
154 * bump reference counts or total counts of outstanding structures, etc.
155 *
156 */
157
158
159/* Function proto types */
160
161/*
162 * Create a new uma zone
163 *
164 * Arguments:
165 *      name  The text name of the zone for debugging and stats. This memory
166 *              should not be freed until the zone has been deallocated.
167 *      size  The size of the object that is being created.
168 *      ctor  The constructor that is called when the object is allocated.
169 *      dtor  The destructor that is called when the object is freed.
170 *      init  An initializer that sets up the initial state of the memory.
171 *      fini  A discard function that undoes initialization done by init.
172 *              ctor/dtor/init/fini may all be null, see notes above.
173 *      align A bitmask that corresponds to the requested alignment
174 *              eg 4 would be 0x3
175 *      flags A set of parameters that control the behavior of the zone.
176 *
177 * Returns:
178 *      A pointer to a structure which is intended to be opaque to users of
179 *      the interface.  The value may be null if the wait flag is not set.
180 */
181uma_zone_t uma_zcreate(const char *name, size_t size, uma_ctor ctor,
182                    uma_dtor dtor, uma_init uminit, uma_fini fini,
183                    int align, uint32_t flags);
184
185/*
186 * Create a secondary uma zone
187 *
188 * Arguments:
189 *      name  The text name of the zone for debugging and stats. This memory
190 *              should not be freed until the zone has been deallocated.
191 *      ctor  The constructor that is called when the object is allocated.
192 *      dtor  The destructor that is called when the object is freed.
193 *      zinit  An initializer that sets up the initial state of the memory
194 *              as the object passes from the Keg's slab to the Zone's cache.
195 *      zfini  A discard function that undoes initialization done by init
196 *              as the object passes from the Zone's cache to the Keg's slab.
197 *
198 *              ctor/dtor/zinit/zfini may all be null, see notes above.
199 *              Note that the zinit and zfini specified here are NOT
200 *              exactly the same as the init/fini specified to uma_zcreate()
201 *              when creating a master zone.  These zinit/zfini are called
202 *              on the TRANSITION from keg to zone (and vice-versa). Once
203 *              these are set, the primary zone may alter its init/fini
204 *              (which are called when the object passes from VM to keg)
205 *              using uma_zone_set_init/fini()) as well as its own
206 *              zinit/zfini (unset by default for master zone) with
207 *              uma_zone_set_zinit/zfini() (note subtle 'z' prefix).
208 *
209 *      master  A reference to this zone's Master Zone (Primary Zone),
210 *              which contains the backing Keg for the Secondary Zone
211 *              being added.
212 *
213 * Returns:
214 *      A pointer to a structure which is intended to be opaque to users of
215 *      the interface.  The value may be null if the wait flag is not set.
216 */
217uma_zone_t uma_zsecond_create(char *name, uma_ctor ctor, uma_dtor dtor,
218                    uma_init zinit, uma_fini zfini, uma_zone_t master);
219
220/*
221 * Add a second master to a secondary zone.  This provides multiple data
222 * backends for objects with the same size.  Both masters must have
223 * compatible allocation flags.  Presently, UMA_ZONE_MALLOC type zones are
224 * the only supported.
225 *
226 * Returns:
227 *      Error on failure, 0 on success.
228 */
229int uma_zsecond_add(uma_zone_t zone, uma_zone_t master);
230
231/*
232 * Create cache-only zones.
233 *
234 * This allows uma's per-cpu cache facilities to handle arbitrary
235 * pointers.  Consumers must specify the import and release functions to
236 * fill and destroy caches.  UMA does not allocate any memory for these
237 * zones.  The 'arg' parameter is passed to import/release and is caller
238 * specific.
239 */
240uma_zone_t uma_zcache_create(char *name, int size, uma_ctor ctor, uma_dtor dtor,
241                    uma_init zinit, uma_fini zfini, uma_import zimport,
242                    uma_release zrelease, void *arg, int flags);
243
244/*
245 * Definitions for uma_zcreate flags
246 *
247 * These flags share space with UMA_ZFLAGs in uma_int.h.  Be careful not to
248 * overlap when adding new features.  0xff000000 is in use by uma_int.h.
249 */
250#define UMA_ZONE_PAGEABLE       0x0001  /* Return items not fully backed by
251                                           physical memory XXX Not yet */
252#define UMA_ZONE_ZINIT          0x0002  /* Initialize with zeros */
253#define UMA_ZONE_STATIC         0x0004  /* Statically sized zone */
254#define UMA_ZONE_OFFPAGE        0x0008  /* Force the slab structure allocation
255                                           off of the real memory */
256#define UMA_ZONE_MALLOC         0x0010  /* For use by malloc(9) only! */
257#define UMA_ZONE_NOFREE         0x0020  /* Do not free slabs of this type! */
258#define UMA_ZONE_MTXCLASS       0x0040  /* Create a new lock class */
259#define UMA_ZONE_VM             0x0080  /*
260                                         * Used for internal vm datastructures
261                                         * only.
262                                         */
263#define UMA_ZONE_HASH           0x0100  /*
264                                         * Use a hash table instead of caching
265                                         * information in the vm_page.
266                                         */
267#define UMA_ZONE_SECONDARY      0x0200  /* Zone is a Secondary Zone */
268#define UMA_ZONE_NOBUCKET       0x0400  /* Do not use buckets. */
269#define UMA_ZONE_MAXBUCKET      0x0800  /* Use largest buckets. */
270#define UMA_ZONE_CACHESPREAD    0x1000  /*
271                                         * Spread memory start locations across
272                                         * all possible cache lines.  May
273                                         * require many virtually contiguous
274                                         * backend pages and can fail early.
275                                         */
276#define UMA_ZONE_VTOSLAB        0x2000  /* Zone uses vtoslab for lookup. */
277#define UMA_ZONE_NODUMP         0x4000  /*
278                                         * Zone's pages will not be included in
279                                         * mini-dumps.
280                                         */
281#define UMA_ZONE_PCPU           0x8000  /*
282                                         * Allocates mp_maxid + 1 slabs of PAGE_SIZE
283                                         */
284#ifndef __rtems__
285#define UMA_ZONE_NUMA           0x10000 /*
286                                         * NUMA aware Zone.  Implements a best
287                                         * effort first-touch policy.
288                                         */
289#endif /* __rtems__ */
290#define UMA_ZONE_NOBUCKETCACHE  0x20000 /*
291                                         * Don't cache full buckets.  Limit
292                                         * UMA to per-cpu state.
293                                         */
294
295/*
296 * These flags are shared between the keg and zone.  In zones wishing to add
297 * new kegs these flags must be compatible.  Some are determined based on
298 * physical parameters of the request and may not be provided by the consumer.
299 */
300#define UMA_ZONE_INHERIT                                                \
301    (UMA_ZONE_OFFPAGE | UMA_ZONE_MALLOC | UMA_ZONE_NOFREE |             \
302    UMA_ZONE_HASH | UMA_ZONE_VTOSLAB | UMA_ZONE_PCPU)
303
304/* Definitions for align */
305#define UMA_ALIGN_PTR   (sizeof(void *) - 1)    /* Alignment fit for ptr */
306#define UMA_ALIGN_LONG  (sizeof(long) - 1)      /* "" long */
307#define UMA_ALIGN_INT   (sizeof(int) - 1)       /* "" int */
308#define UMA_ALIGN_SHORT (sizeof(short) - 1)     /* "" short */
309#define UMA_ALIGN_CHAR  (sizeof(char) - 1)      /* "" char */
310#define UMA_ALIGN_CACHE (0 - 1)                 /* Cache line size align */
311#define UMA_ALIGNOF(type) (_Alignof(type) - 1)  /* Alignment fit for 'type' */
312
313/*
314 * Destroys an empty uma zone.  If the zone is not empty uma complains loudly.
315 *
316 * Arguments:
317 *      zone  The zone we want to destroy.
318 *
319 */
320void uma_zdestroy(uma_zone_t zone);
321
322/*
323 * Allocates an item out of a zone
324 *
325 * Arguments:
326 *      zone  The zone we are allocating from
327 *      arg   This data is passed to the ctor function
328 *      flags See sys/malloc.h for available flags.
329 *
330 * Returns:
331 *      A non-null pointer to an initialized element from the zone is
332 *      guaranteed if the wait flag is M_WAITOK.  Otherwise a null pointer
333 *      may be returned if the zone is empty or the ctor failed.
334 */
335
336void *uma_zalloc_arg(uma_zone_t zone, void *arg, int flags);
337void *uma_zalloc_pcpu_arg(uma_zone_t zone, void *arg, int flags);
338
339/*
340 * Allocate an item from a specific NUMA domain.  This uses a slow path in
341 * the allocator but is guaranteed to allocate memory from the requested
342 * domain if M_WAITOK is set.
343 *
344 * Arguments:
345 *      zone  The zone we are allocating from
346 *      arg   This data is passed to the ctor function
347 *      domain The domain to allocate from.
348 *      flags See sys/malloc.h for available flags.
349 */
350void *uma_zalloc_domain(uma_zone_t zone, void *arg, int domain, int flags);
351
352/*
353 * Allocates an item out of a zone without supplying an argument
354 *
355 * This is just a wrapper for uma_zalloc_arg for convenience.
356 *
357 */
358static __inline void *uma_zalloc(uma_zone_t zone, int flags);
359static __inline void *uma_zalloc_pcpu(uma_zone_t zone, int flags);
360
361static __inline void *
362uma_zalloc(uma_zone_t zone, int flags)
363{
364        return uma_zalloc_arg(zone, NULL, flags);
365}
366
367static __inline void *
368uma_zalloc_pcpu(uma_zone_t zone, int flags)
369{
370        return uma_zalloc_pcpu_arg(zone, NULL, flags);
371}
372
373/*
374 * Frees an item back into the specified zone.
375 *
376 * Arguments:
377 *      zone  The zone the item was originally allocated out of.
378 *      item  The memory to be freed.
379 *      arg   Argument passed to the destructor
380 *
381 * Returns:
382 *      Nothing.
383 */
384
385void uma_zfree_arg(uma_zone_t zone, void *item, void *arg);
386void uma_zfree_pcpu_arg(uma_zone_t zone, void *item, void *arg);
387
388/*
389 * Frees an item back to the specified zone's domain specific pool.
390 *
391 * Arguments:
392 *      zone  The zone the item was originally allocated out of.
393 *      item  The memory to be freed.
394 *      arg   Argument passed to the destructor
395 */
396void uma_zfree_domain(uma_zone_t zone, void *item, void *arg);
397
398/*
399 * Frees an item back to a zone without supplying an argument
400 *
401 * This is just a wrapper for uma_zfree_arg for convenience.
402 *
403 */
404static __inline void uma_zfree(uma_zone_t zone, void *item);
405static __inline void uma_zfree_pcpu(uma_zone_t zone, void *item);
406
407static __inline void
408uma_zfree(uma_zone_t zone, void *item)
409{
410        uma_zfree_arg(zone, item, NULL);
411}
412
413static __inline void
414uma_zfree_pcpu(uma_zone_t zone, void *item)
415{
416        uma_zfree_pcpu_arg(zone, item, NULL);
417}
418
419/*
420 * Wait until the specified zone can allocate an item.
421 */
422void uma_zwait(uma_zone_t zone);
423
424/*
425 * Backend page supplier routines
426 *
427 * Arguments:
428 *      zone  The zone that is requesting pages.
429 *      size  The number of bytes being requested.
430 *      pflag Flags for these memory pages, see below.
431 *      domain The NUMA domain that we prefer for this allocation.
432 *      wait  Indicates our willingness to block.
433 *
434 * Returns:
435 *      A pointer to the allocated memory or NULL on failure.
436 */
437
438typedef void *(*uma_alloc)(uma_zone_t zone, vm_size_t size, int domain,
439    uint8_t *pflag, int wait);
440
441/*
442 * Backend page free routines
443 *
444 * Arguments:
445 *      item  A pointer to the previously allocated pages.
446 *      size  The original size of the allocation.
447 *      pflag The flags for the slab.  See UMA_SLAB_* below.
448 *
449 * Returns:
450 *      None
451 */
452typedef void (*uma_free)(void *item, vm_size_t size, uint8_t pflag);
453
454/*
455 * Reclaims unused memory for all zones
456 *
457 * Arguments:
458 *      None
459 * Returns:
460 *      None
461 *
462 * This should only be called by the page out daemon.
463 */
464
465void uma_reclaim(void);
466
467/*
468 * Sets the alignment mask to be used for all zones requesting cache
469 * alignment.  Should be called by MD boot code prior to starting VM/UMA.
470 *
471 * Arguments:
472 *      align The alignment mask
473 *
474 * Returns:
475 *      Nothing
476 */
477void uma_set_align(int align);
478
479/*
480 * Set a reserved number of items to hold for M_USE_RESERVE allocations.  All
481 * other requests must allocate new backing pages.
482 */
483void uma_zone_reserve(uma_zone_t zone, int nitems);
484
485/*
486 * Reserves the maximum KVA space required by the zone and configures the zone
487 * to use a VM_ALLOC_NOOBJ-based backend allocator.
488 *
489 * Arguments:
490 *      zone  The zone to update.
491 *      nitems  The upper limit on the number of items that can be allocated.
492 *
493 * Returns:
494 *      0  if KVA space can not be allocated
495 *      1  if successful
496 *
497 * Discussion:
498 *      When the machine supports a direct map and the zone's items are smaller
499 *      than a page, the zone will use the direct map instead of allocating KVA
500 *      space.
501 */
502int uma_zone_reserve_kva(uma_zone_t zone, int nitems);
503
504/*
505 * Sets a high limit on the number of items allowed in a zone
506 *
507 * Arguments:
508 *      zone  The zone to limit
509 *      nitems  The requested upper limit on the number of items allowed
510 *
511 * Returns:
512 *      int  The effective value of nitems after rounding up based on page size
513 */
514int uma_zone_set_max(uma_zone_t zone, int nitems);
515
516/*
517 * Obtains the effective limit on the number of items in a zone
518 *
519 * Arguments:
520 *      zone  The zone to obtain the effective limit from
521 *
522 * Return:
523 *      0  No limit
524 *      int  The effective limit of the zone
525 */
526int uma_zone_get_max(uma_zone_t zone);
527
528/*
529 * Sets a warning to be printed when limit is reached
530 *
531 * Arguments:
532 *      zone  The zone we will warn about
533 *      warning  Warning content
534 *
535 * Returns:
536 *      Nothing
537 */
538void uma_zone_set_warning(uma_zone_t zone, const char *warning);
539
540/*
541 * Sets a function to run when limit is reached
542 *
543 * Arguments:
544 *      zone  The zone to which this applies
545 *      fx  The function ro run
546 *
547 * Returns:
548 *      Nothing
549 */
550typedef void (*uma_maxaction_t)(uma_zone_t, int);
551void uma_zone_set_maxaction(uma_zone_t zone, uma_maxaction_t);
552
553/*
554 * Obtains the approximate current number of items allocated from a zone
555 *
556 * Arguments:
557 *      zone  The zone to obtain the current allocation count from
558 *
559 * Return:
560 *      int  The approximate current number of items allocated from the zone
561 */
562int uma_zone_get_cur(uma_zone_t zone);
563
564/*
565 * The following two routines (uma_zone_set_init/fini)
566 * are used to set the backend init/fini pair which acts on an
567 * object as it becomes allocated and is placed in a slab within
568 * the specified zone's backing keg.  These should probably not
569 * be changed once allocations have already begun, but only be set
570 * immediately upon zone creation.
571 */
572void uma_zone_set_init(uma_zone_t zone, uma_init uminit);
573void uma_zone_set_fini(uma_zone_t zone, uma_fini fini);
574
575/*
576 * The following two routines (uma_zone_set_zinit/zfini) are
577 * used to set the zinit/zfini pair which acts on an object as
578 * it passes from the backing Keg's slab cache to the
579 * specified Zone's bucket cache.  These should probably not
580 * be changed once allocations have already begun, but only be set
581 * immediately upon zone creation.
582 */
583void uma_zone_set_zinit(uma_zone_t zone, uma_init zinit);
584void uma_zone_set_zfini(uma_zone_t zone, uma_fini zfini);
585
586/*
587 * Replaces the standard backend allocator for this zone.
588 *
589 * Arguments:
590 *      zone   The zone whose backend allocator is being changed.
591 *      allocf A pointer to the allocation function
592 *
593 * Returns:
594 *      Nothing
595 *
596 * Discussion:
597 *      This could be used to implement pageable allocation, or perhaps
598 *      even DMA allocators if used in conjunction with the OFFPAGE
599 *      zone flag.
600 */
601
602void uma_zone_set_allocf(uma_zone_t zone, uma_alloc allocf);
603
604/*
605 * Used for freeing memory provided by the allocf above
606 *
607 * Arguments:
608 *      zone  The zone that intends to use this free routine.
609 *      freef The page freeing routine.
610 *
611 * Returns:
612 *      Nothing
613 */
614
615void uma_zone_set_freef(uma_zone_t zone, uma_free freef);
616
617/*
618 * These flags are setable in the allocf and visible in the freef.
619 */
620#ifndef __rtems__
621#define UMA_SLAB_BOOT   0x01            /* Slab alloced from boot pages */
622#endif /* __rtems__ */
623#define UMA_SLAB_KERNEL 0x04            /* Slab alloced from kmem */
624#ifndef __rtems__
625#define UMA_SLAB_PRIV   0x08            /* Slab alloced from priv allocator */
626#define UMA_SLAB_OFFP   0x10            /* Slab is managed separately  */
627#define UMA_SLAB_MALLOC 0x20            /* Slab is a large malloc slab */
628/* 0x02, 0x40, and 0x80 are available */
629#endif /* __rtems__ */
630
631/*
632 * Used to pre-fill a zone with some number of items
633 *
634 * Arguments:
635 *      zone    The zone to fill
636 *      itemcnt The number of items to reserve
637 *
638 * Returns:
639 *      Nothing
640 *
641 * NOTE: This is blocking and should only be done at startup
642 */
643void uma_prealloc(uma_zone_t zone, int itemcnt);
644
645/*
646 * Used to determine if a fixed-size zone is exhausted.
647 *
648 * Arguments:
649 *      zone    The zone to check
650 *
651 * Returns:
652 *      Non-zero if zone is exhausted.
653 */
654int uma_zone_exhausted(uma_zone_t zone);
655int uma_zone_exhausted_nolock(uma_zone_t zone);
656
657/*
658 * Common UMA_ZONE_PCPU zones.
659 */
660extern uma_zone_t pcpu_zone_64;
661extern uma_zone_t pcpu_zone_ptr;
662
663/*
664 * Exported statistics structures to be used by user space monitoring tools.
665 * Statistics stream consists of a uma_stream_header, followed by a series of
666 * alternative uma_type_header and uma_type_stat structures.
667 */
668#define UMA_STREAM_VERSION      0x00000001
669struct uma_stream_header {
670        uint32_t        ush_version;    /* Stream format version. */
671        uint32_t        ush_maxcpus;    /* Value of MAXCPU for stream. */
672        uint32_t        ush_count;      /* Number of records. */
673        uint32_t        _ush_pad;       /* Pad/reserved field. */
674};
675
676#define UTH_MAX_NAME    32
677#define UTH_ZONE_SECONDARY      0x00000001
678struct uma_type_header {
679        /*
680         * Static per-zone data, some extracted from the supporting keg.
681         */
682        char            uth_name[UTH_MAX_NAME];
683        uint32_t        uth_align;      /* Keg: alignment. */
684        uint32_t        uth_size;       /* Keg: requested size of item. */
685        uint32_t        uth_rsize;      /* Keg: real size of item. */
686        uint32_t        uth_maxpages;   /* Keg: maximum number of pages. */
687        uint32_t        uth_limit;      /* Keg: max items to allocate. */
688
689        /*
690         * Current dynamic zone/keg-derived statistics.
691         */
692        uint32_t        uth_pages;      /* Keg: pages allocated. */
693        uint32_t        uth_keg_free;   /* Keg: items free. */
694        uint32_t        uth_zone_free;  /* Zone: items free. */
695        uint32_t        uth_bucketsize; /* Zone: desired bucket size. */
696        uint32_t        uth_zone_flags; /* Zone: flags. */
697        uint64_t        uth_allocs;     /* Zone: number of allocations. */
698        uint64_t        uth_frees;      /* Zone: number of frees. */
699        uint64_t        uth_fails;      /* Zone: number of alloc failures. */
700        uint64_t        uth_sleeps;     /* Zone: number of alloc sleeps. */
701        uint64_t        _uth_reserved1[2];      /* Reserved. */
702};
703
704struct uma_percpu_stat {
705        uint64_t        ups_allocs;     /* Cache: number of allocations. */
706        uint64_t        ups_frees;      /* Cache: number of frees. */
707        uint64_t        ups_cache_free; /* Cache: free items in cache. */
708        uint64_t        _ups_reserved[5];       /* Reserved. */
709};
710
711void uma_reclaim_wakeup(void);
712void uma_reclaim_worker(void *);
713
714unsigned long uma_limit(void);
715
716/* Return the amount of memory managed by UMA. */
717unsigned long uma_size(void);
718
719/* Return the amount of memory remaining.  May be negative. */
720long uma_avail(void);
721
722#ifdef __rtems__
723void rtems_uma_drain_timeout(void);
724#endif /* __rtems__ */
725#endif  /* _VM_UMA_H_ */
Note: See TracBrowser for help on using the repository browser.