xref: /netbsd/sys/sys/thmap.h (revision 3bbb0617)
1 /*-
2  * Copyright (c) 2018 Mindaugas Rasiukevicius <rmind at noxt eu>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #ifndef _SYS_THMAP_H_
28 #define _SYS_THMAP_H_
29 
30 #if !defined(_KERNEL)
31 #error "not supposed to be exposed to userland"
32 #endif
33 
34 __BEGIN_DECLS
35 
36 struct thmap;
37 typedef struct thmap thmap_t;
38 
39 #define	THMAP_NOCOPY	0x01
40 #define	THMAP_SETROOT	0x02
41 
42 typedef struct {
43 	uintptr_t	(*alloc)(size_t);
44 	void		(*free)(uintptr_t, size_t);
45 } thmap_ops_t;
46 
47 thmap_t *	thmap_create(uintptr_t, const thmap_ops_t *, unsigned);
48 void		thmap_destroy(thmap_t *);
49 
50 void *		thmap_get(thmap_t *, const void *, size_t);
51 void *		thmap_put(thmap_t *, const void *, size_t, void *);
52 void *		thmap_del(thmap_t *, const void *, size_t);
53 
54 void *		thmap_stage_gc(thmap_t *);
55 void		thmap_gc(thmap_t *, void *);
56 
57 int		thmap_setroot(thmap_t *, uintptr_t);
58 uintptr_t	thmap_getroot(const thmap_t *);
59 
60 __END_DECLS
61 
62 #endif
63