xref: /titanic_50/usr/src/uts/common/sys/kmem.h (revision 69112edd987c28fa551d4f8d9362a84a45365f17)
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 2009 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 #include <sys/types.h>
34 #include <sys/vmem.h>
35 
36 #ifdef	__cplusplus
37 extern "C" {
38 #endif
39 
40 /*
41  * Kernel memory allocator: DDI interfaces.
42  * See kmem_alloc(9F) for details.
43  */
44 
45 #define	KM_SLEEP	0x0000	/* can block for memory; success guaranteed */
46 #define	KM_NOSLEEP	0x0001	/* cannot block for memory; may fail */
47 #define	KM_PANIC	0x0002	/* if memory cannot be allocated, panic */
48 #define	KM_PUSHPAGE	0x0004	/* can block for memory; may use reserve */
49 #define	KM_VMFLAGS	0x00ff	/* flags that must match VM_* flags */
50 
51 #define	KM_FLAGS	0xffff	/* all settable kmem flags */
52 
53 #ifdef _KERNEL
54 
55 extern void *kmem_alloc(size_t size, int kmflags);
56 extern void *kmem_zalloc(size_t size, int kmflags);
57 extern void kmem_free(void *buf, size_t size);
58 extern void *kmem_alloc_tryhard(size_t size, size_t *alloc_size, int kmflags);
59 extern void kmem_dump_init(size_t);
60 extern void kmem_dump_begin(void);
61 extern size_t kmem_dump_finish(char *buf, size_t size);
62 
63 #endif	/* _KERNEL */
64 
65 /*
66  * Kernel memory allocator: private interfaces.
67  * These interfaces are still evolving.
68  * Do not use them in unbundled drivers.
69  */
70 
71 /*
72  * Flags for kmem_cache_create()
73  */
74 #define	KMC_NOTOUCH	0x00010000
75 #define	KMC_NODEBUG	0x00020000
76 #define	KMC_NOMAGAZINE	0x00040000
77 #define	KMC_NOHASH	0x00080000
78 #define	KMC_QCACHE	0x00100000
79 #define	KMC_KMEM_ALLOC	0x00200000	/* internal use only */
80 #define	KMC_IDENTIFIER	0x00400000	/* internal use only */
81 
82 struct kmem_cache;		/* cache structure is opaque to kmem clients */
83 
84 typedef struct kmem_cache kmem_cache_t;
85 
86 /* Client response to kmem move callback */
87 typedef enum kmem_cbrc {
88 	KMEM_CBRC_YES,
89 	KMEM_CBRC_NO,
90 	KMEM_CBRC_LATER,
91 	KMEM_CBRC_DONT_NEED,
92 	KMEM_CBRC_DONT_KNOW
93 } kmem_cbrc_t;
94 
95 #ifdef _KERNEL
96 
97 extern int kmem_ready;
98 extern pgcnt_t kmem_reapahead;
99 
100 extern void kmem_init(void);
101 extern void kmem_thread_init(void);
102 extern void kmem_mp_init(void);
103 extern void kmem_reap(void);
104 extern void kmem_reap_idspace(void);
105 extern int kmem_debugging(void);
106 extern size_t kmem_avail(void);
107 extern size_t kmem_maxavail(void);
108 
109 extern kmem_cache_t *kmem_cache_create(char *, size_t, size_t,
110 	int (*)(void *, void *, int), void (*)(void *, void *),
111 	void (*)(void *), void *, vmem_t *, int);
112 extern void kmem_cache_set_move(kmem_cache_t *,
113 	kmem_cbrc_t (*)(void *, void *, size_t, void *));
114 extern void kmem_cache_destroy(kmem_cache_t *);
115 extern void *kmem_cache_alloc(kmem_cache_t *, int);
116 extern void kmem_cache_free(kmem_cache_t *, void *);
117 extern uint64_t kmem_cache_stat(kmem_cache_t *, char *);
118 extern void kmem_cache_reap_now(kmem_cache_t *);
119 extern void kmem_cache_move_notify(kmem_cache_t *, void *);
120 
121 #endif	/* _KERNEL */
122 
123 #ifdef	__cplusplus
124 }
125 #endif
126 
127 #endif	/* _SYS_KMEM_H */
128