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