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 */
39struct 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#define	OSD_KHELP	2
50
51#define	OSD_FIRST	OSD_THREAD
52#define	OSD_LAST	OSD_KHELP
53
54typedef void (*osd_destructor_t)(void *value);
55typedef int (*osd_method_t)(void *obj, void *data);
56
57int osd_register(u_int type, osd_destructor_t destructor,
58    osd_method_t *methods);
59void osd_deregister(u_int type, u_int slot);
60
61int osd_set(u_int type, struct osd *osd, u_int slot, void *value);
62void *osd_get(u_int type, struct osd *osd, u_int slot);
63void osd_del(u_int type, struct osd *osd, u_int slot);
64int osd_call(u_int type, u_int method, void *obj, void *data);
65
66void osd_exit(u_int type, struct osd *osd);
67
68#define	osd_thread_register(destructor)					\
69	osd_register(OSD_THREAD, (destructor), NULL)
70#define	osd_thread_deregister(slot)					\
71	osd_deregister(OSD_THREAD, (slot))
72#define	osd_thread_set(td, slot, value)					\
73	osd_set(OSD_THREAD, &(td)->td_osd, (slot), (value))
74#define	osd_thread_get(td, slot)					\
75	osd_get(OSD_THREAD, &(td)->td_osd, (slot))
76#define	osd_thread_del(td, slot)	do {				\
77	KASSERT((td) == curthread, ("Not curthread."));			\
78	osd_del(OSD_THREAD, &(td)->td_osd, (slot));			\
79} while (0)
80#define	osd_thread_call(td, method, data)				\
81	osd_call(OSD_THREAD, (method), (td), (data))
82#define	osd_thread_exit(td)						\
83	osd_exit(OSD_THREAD, &(td)->td_osd)
84
85#define	osd_jail_register(destructor, methods)				\
86	osd_register(OSD_JAIL, (destructor), (methods))
87#define	osd_jail_deregister(slot)					\
88	osd_deregister(OSD_JAIL, (slot))
89#define	osd_jail_set(pr, slot, value)					\
90	osd_set(OSD_JAIL, &(pr)->pr_osd, (slot), (value))
91#define	osd_jail_get(pr, slot)						\
92	osd_get(OSD_JAIL, &(pr)->pr_osd, (slot))
93#define	osd_jail_del(pr, slot)						\
94	osd_del(OSD_JAIL, &(pr)->pr_osd, (slot))
95#define	osd_jail_call(pr, method, data)					\
96	osd_call(OSD_JAIL, (method), (pr), (data))
97#define	osd_jail_exit(pr)						\
98	osd_exit(OSD_JAIL, &(pr)->pr_osd)
99
100#endif	/* _KERNEL */
101
102#endif	/* !_SYS_OSD_H_ */
103