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