xref: /freebsd/sys/sys/osd.h (revision 39beb93c)
1 /*-
2  * Copyright (c) 2007 Pawel Jakub Dawidek <pjd@FreeBSD.org>
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 AUTHORS 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 AUTHORS 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  * $FreeBSD$
27  */
28 
29 #ifndef _SYS_OSD_H_
30 #define _SYS_OSD_H_
31 
32 #include <sys/queue.h>
33 
34 /*
35  * Lock key:
36  *   (c) container lock (e.g. jail's pr_mtx) and/or osd_object_lock
37  *   (l) osd_list_lock
38  */
39 struct osd {
40 	u_int		  osd_nslots;	/* (c) */
41 	void		**osd_slots;	/* (c) */
42 	LIST_ENTRY(osd)	  osd_next;	/* (l) */
43 };
44 
45 #ifdef _KERNEL
46 
47 #define	OSD_THREAD	0
48 #define	OSD_JAIL	1
49 
50 #define	OSD_FIRST	OSD_THREAD
51 #define	OSD_LAST	OSD_JAIL
52 
53 typedef void (*osd_destructor_t)(void *value);
54 typedef int (*osd_method_t)(void *obj, void *data);
55 
56 int osd_register(u_int type, osd_destructor_t destructor,
57     osd_method_t *methods);
58 void osd_deregister(u_int type, u_int slot);
59 
60 int osd_set(u_int type, struct osd *osd, u_int slot, void *value);
61 void *osd_get(u_int type, struct osd *osd, u_int slot);
62 void osd_del(u_int type, struct osd *osd, u_int slot);
63 int osd_call(u_int type, u_int method, void *obj, void *data);
64 
65 void osd_exit(u_int type, struct osd *osd);
66 
67 #define	osd_thread_register(destructor)					\
68 	osd_register(OSD_THREAD, (destructor), NULL)
69 #define	osd_thread_deregister(slot)					\
70 	osd_deregister(OSD_THREAD, (slot))
71 #define	osd_thread_set(td, slot, value)					\
72 	osd_set(OSD_THREAD, &(td)->td_osd, (slot), (value))
73 #define	osd_thread_get(td, slot)					\
74 	osd_get(OSD_THREAD, &(td)->td_osd, (slot))
75 #define	osd_thread_del(td, slot)	do {				\
76 	KASSERT((td) == curthread, ("Not curthread."));			\
77 	osd_del(OSD_THREAD, &(td)->td_osd, (slot));			\
78 } while (0)
79 #define	osd_thread_call(td, method, data)				\
80 	osd_call(OSD_THREAD, (method), (td), (data))
81 #define	osd_thread_exit(td)						\
82 	osd_exit(OSD_THREAD, &(td)->td_osd)
83 
84 #define	osd_jail_register(destructor)					\
85 	osd_register(OSD_JAIL, (destructor), NULL)
86 #define	osd_jail_deregister(slot)					\
87 	osd_deregister(OSD_JAIL, (slot))
88 #define	osd_jail_set(pr, slot, value)					\
89 	osd_set(OSD_JAIL, &(pr)->pr_osd, (slot), (value))
90 #define	osd_jail_get(pr, slot)						\
91 	osd_get(OSD_JAIL, &(pr)->pr_osd, (slot))
92 #define	osd_jail_del(pr, slot)						\
93 	osd_del(OSD_JAIL, &(pr)->pr_osd, (slot))
94 #define	osd_jail_call(pr, method, data)					\
95 	osd_call(OSD_JAIL, (method), (pr), (data))
96 #define	osd_jail_exit(pr)						\
97 	osd_exit(OSD_JAIL, &(pr)->pr_osd)
98 
99 #endif	/* _KERNEL */
100 
101 #endif	/* !_SYS_OSD_H_ */
102