usr/src/lib/libumem/common/umem.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License, Version 1.0 only
   6  * (the "License").  You may not use this file except in compliance
   7  * with the License.
   8  *
   9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  10  * or http://www.opensolaris.org/os/licensing.
  11  * See the License for the specific language governing permissions
  12  * and limitations under the License.
  13  *
  14  * When distributing Covered Code, include this CDDL HEADER in each
  15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  16  * If applicable, add the following below this CDDL HEADER, with the
  17  * fields enclosed by brackets "[]" replaced with your own identifying
  18  * information: Portions Copyright [yyyy] [name of copyright owner]
  19  *
  20  * CDDL HEADER END
  21  */
  22 /*
  23  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
  24  * Use is subject to license terms.
  25  */
  26
  27 #ifndef _UMEM_H
  28 #define _UMEM_H
  29
  30 #pragma ident   "%Z%%M% %I%     %E% SMI"
  31
  32 #include <sys/types.h>
  33 #include <sys/vmem.h>
  34 #include <stdlib.h>
  35
  36 #ifdef  __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 #define UMEM_DEFAULT    0x0000  /* normal -- may fail */
  41 #define UMEM_NOFAIL     0x0100  /* Never fails -- may call exit(2) */
  42
  43 #define UMEM_FLAGS      0xffff  /* all settable umem flags */
  44
  45 extern void *umem_alloc(size_t, int);
  46 extern void *umem_alloc_align(size_t, size_t, int);
  47 extern void *umem_zalloc(size_t, int);
  48 extern void umem_free(void *, size_t);
  49 extern void umem_free_align(void *, size_t);
  50
  51 /*
  52  * Flags for umem_cache_create()
  53  */
  54 #define UMC_NOTOUCH     0x00010000
  55 #define UMC_NODEBUG     0x00020000
  56 #define UMC_NOMAGAZINE  0x00040000
  57 #define UMC_NOHASH      0x00080000
  58
  59 struct umem_cache;              /* cache structure is opaque to umem clients */
  60
  61 typedef struct umem_cache umem_cache_t;
  62 typedef int umem_constructor_t(void *, void *, int);
  63 typedef void umem_destructor_t(void *, void *);
  64 typedef void umem_reclaim_t(void *);
  65
  66 typedef int umem_nofail_callback_t(void);
  67 #define UMEM_CALLBACK_RETRY             0
  68 #define UMEM_CALLBACK_EXIT(status)      (0x100 | ((status) & 0xFF))
  69
  70 extern void umem_nofail_callback(umem_nofail_callback_t *);
  71
  72 extern umem_cache_t *umem_cache_create(char *, size_t,
  73     size_t, umem_constructor_t *, umem_destructor_t *, umem_reclaim_t *,
  74     void *, vmem_t *, int);
  75 extern void umem_cache_destroy(umem_cache_t *);
  76
  77 extern void *umem_cache_alloc(umem_cache_t *, int);
  78 extern void umem_cache_free(umem_cache_t *, void *);
  79
  80 extern void umem_reap(void);
  81
  82 #ifdef  __cplusplus
  83 }
  84 #endif
  85
  86 #endif  /* _UMEM_H */