xref: /titanic_41/usr/src/uts/common/sys/kmem.h (revision 7206bf49b1fe641544165ee97f63856da95e0868)
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 (c) 1988, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright (c) 2012 by Delphix. All rights reserved.
25  * Copyright 2013 Nexenta Systems, Inc.  All rights reserved.
26  */
27 
28 /*	Copyright (c) 1984, 1986, 1987, 1988, 1989 AT&T */
29 /*	  All Rights Reserved	*/
30 
31 #ifndef _SYS_KMEM_H
32 #define	_SYS_KMEM_H
33 
34 #include <sys/types.h>
35 #include <sys/vmem.h>
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 /*
42  * Kernel memory allocator: DDI interfaces.
43  * See kmem_alloc(9F) for details.
44  */
45 
46 #define	KM_SLEEP	0x0000	/* can block for memory; success guaranteed */
47 #define	KM_NOSLEEP	0x0001	/* cannot block for memory; may fail */
48 #define	KM_PANIC	0x0002	/* if memory cannot be allocated, panic */
49 #define	KM_PUSHPAGE	0x0004	/* can block for memory; may use reserve */
50 #define	KM_NORMALPRI	0x0008  /* with KM_NOSLEEP, lower priority allocation */
51 #define	KM_VMFLAGS	0x00ff	/* flags that must match VM_* flags */
52 
53 #define	KM_FLAGS	0xffff	/* all settable kmem flags */
54 
55 #if defined(_KERNEL) || defined(_FAKE_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 extern void kmem_dump_init(size_t);
62 extern void kmem_dump_begin(void);
63 extern size_t kmem_dump_finish(char *buf, size_t size);
64 
65 #endif	/* _KERNEL */
66 
67 /*
68  * Kernel memory allocator: private interfaces.
69  * These interfaces are still evolving.
70  * Do not use them in unbundled drivers.
71  */
72 
73 /*
74  * Flags for kmem_cache_create()
75  */
76 #define	KMC_NOTOUCH	0x00010000
77 #define	KMC_NODEBUG	0x00020000
78 #define	KMC_NOMAGAZINE	0x00040000
79 #define	KMC_NOHASH	0x00080000
80 #define	KMC_QCACHE	0x00100000
81 #define	KMC_KMEM_ALLOC	0x00200000	/* internal use only */
82 #define	KMC_IDENTIFIER	0x00400000	/* internal use only */
83 #define	KMC_PREFILL	0x00800000
84 
85 struct kmem_cache;		/* cache structure is opaque to kmem clients */
86 
87 typedef struct kmem_cache kmem_cache_t;
88 
89 /* Client response to kmem move callback */
90 typedef enum kmem_cbrc {
91 	KMEM_CBRC_YES,
92 	KMEM_CBRC_NO,
93 	KMEM_CBRC_LATER,
94 	KMEM_CBRC_DONT_NEED,
95 	KMEM_CBRC_DONT_KNOW
96 } kmem_cbrc_t;
97 
98 #if defined(_KERNEL) || defined(_FAKE_KERNEL)
99 
100 /*
101  * Helps clients implementing the move() callback to recognize known objects by
102  * testing a client-designated pointer member. Takes advantage of the fact that
103  * any scribbling to freed memory done by kmem is guaranteed to set one of the
104  * two low order bits.
105  */
106 #define	POINTER_IS_VALID(p)	(!((uintptr_t)(p) & 0x3))
107 #define	POINTER_INVALIDATE(pp)	(*(pp) = (void *)((uintptr_t)(*(pp)) | 0x1))
108 
109 extern int kmem_ready;
110 extern pgcnt_t kmem_reapahead;
111 extern size_t kmem_max_cached;
112 
113 extern void kmem_init(void);
114 extern void kmem_thread_init(void);
115 extern void kmem_mp_init(void);
116 extern void kmem_reap(void);
117 extern void kmem_reap_idspace(void);
118 extern int kmem_debugging(void);
119 extern size_t kmem_avail(void);
120 extern size_t kmem_maxavail(void);
121 
122 extern kmem_cache_t *kmem_cache_create(char *, size_t, size_t,
123 	int (*)(void *, void *, int), void (*)(void *, void *),
124 	void (*)(void *), void *, vmem_t *, int);
125 extern void kmem_cache_set_move(kmem_cache_t *,
126 	kmem_cbrc_t (*)(void *, void *, size_t, void *));
127 extern void kmem_cache_destroy(kmem_cache_t *);
128 extern void *kmem_cache_alloc(kmem_cache_t *, int);
129 extern void kmem_cache_free(kmem_cache_t *, void *);
130 extern uint64_t kmem_cache_stat(kmem_cache_t *, char *);
131 extern void kmem_cache_reap_now(kmem_cache_t *);
132 extern void kmem_cache_move_notify(kmem_cache_t *, void *);
133 
134 #endif	/* _KERNEL */
135 
136 #ifdef	__cplusplus
137 }
138 #endif
139 
140 #endif	/* _SYS_KMEM_H */
141