usr/src/uts/common/sys/kmem.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 (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21
  22 /*
  23  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
  24  * Use is subject to license terms.
  25  */
  26
  27 /*      Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
  28 /*        All Rights Reserved   */
  29
  30 #ifndef _SYS_KMEM_H
  31 #define _SYS_KMEM_H
  32
  33 #pragma ident   "%Z%%M% %I%     %E% SMI"
  34
  35 #include <sys/types.h>
  36 #include <sys/vmem.h>
  37
  38 #ifdef  __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 /*
  43  * Kernel memory allocator: DDI interfaces.
  44  * See kmem_alloc(9F) for details.
  45  */
  46
  47 #define KM_SLEEP        0x0000  /* can block for memory; success guaranteed */
  48 #define KM_NOSLEEP      0x0001  /* cannot block for memory; may fail */
  49 #define KM_PANIC        0x0002  /* if memory cannot be allocated, panic */
  50 #define KM_PUSHPAGE     0x0004  /* can block for memory; may use reserve */
  51 #define KM_VMFLAGS      0x00ff  /* flags that must match VM_* flags */
  52
  53 #define KM_FLAGS        0xffff  /* all settable kmem flags */
  54
  55 #ifdef _KERNEL
  56
  57 extern void *kmem_alloc(size_t size, int kmflags);
  58 extern void *kmem_zalloc(size_t size, int kmflags);
  59 extern void kmem_free(void *buf, size_t size);
  60 extern void *kmem_alloc_tryhard(size_t size, size_t *alloc_size, int kmflags);
  61
  62 #endif  /* _KERNEL */
  63
  64 /*
  65  * Kernel memory allocator: private interfaces.
  66  * These interfaces are still evolving.
  67  * Do not use them in unbundled drivers.
  68  */
  69
  70 /*
  71  * Flags for kmem_cache_create()
  72  */
  73 #define KMC_NOTOUCH     0x00010000
  74 #define KMC_NODEBUG     0x00020000
  75 #define KMC_NOMAGAZINE  0x00040000
  76 #define KMC_NOHASH      0x00080000
  77 #define KMC_QCACHE      0x00100000
  78 #define KMC_KMEM_ALLOC  0x00200000      /* internal use only */
  79 #define KMC_IDENTIFIER  0x00400000      /* internal use only */
  80
  81 struct kmem_cache;              /* cache structure is opaque to kmem clients */
  82
  83 typedef struct kmem_cache kmem_cache_t;
  84
  85 /* Client response to kmem move callback */
  86 typedef enum kmem_cbrc {
  87         KMEM_CBRC_YES,
  88         KMEM_CBRC_NO,
  89         KMEM_CBRC_LATER,
  90         KMEM_CBRC_DONT_NEED,
  91         KMEM_CBRC_DONT_KNOW
  92 } kmem_cbrc_t;
  93
  94 #ifdef _KERNEL
  95
  96 extern int kmem_ready;
  97 extern pgcnt_t kmem_reapahead;
  98
  99 extern void kmem_init(void);
 100 extern void kmem_thread_init(void);
 101 extern void kmem_mp_init(void);
 102 extern void kmem_reap(void);
 103 extern void kmem_reap_idspace(void);
 104 extern int kmem_debugging(void);
 105 extern size_t kmem_avail(void);
 106 extern size_t kmem_maxavail(void);
 107
 108 extern kmem_cache_t *kmem_cache_create(char *, size_t, size_t,
 109         int (*)(void *, void *, int), void (*)(void *, void *),
 110         void (*)(void *), void *, vmem_t *, int);
 111 extern void kmem_cache_set_move(kmem_cache_t *,
 112         kmem_cbrc_t (*)(void *, void *, size_t, void *));
 113 extern void kmem_cache_destroy(kmem_cache_t *);
 114 extern void *kmem_cache_alloc(kmem_cache_t *, int);
 115 extern void kmem_cache_free(kmem_cache_t *, void *);
 116 extern uint64_t kmem_cache_stat(kmem_cache_t *, char *);
 117 extern void kmem_cache_reap_now(kmem_cache_t *);
 118 extern void kmem_cache_move_notify(kmem_cache_t *, void *);
 119
 120 #endif  /* _KERNEL */
 121
 122 #ifdef  __cplusplus
 123 }
 124 #endif
 125
 126 #endif  /* _SYS_KMEM_H */