1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2007 Pawel Jakub Dawidek <pjd@FreeBSD.org> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 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 #define OSD_KHELP 2 50 51 #define OSD_FIRST OSD_THREAD 52 #define OSD_LAST OSD_KHELP 53 54 typedef void (*osd_destructor_t)(void *value); 55 typedef int (*osd_method_t)(void *obj, void *data); 56 57 int osd_register(u_int type, osd_destructor_t destructor, 58 osd_method_t *methods); 59 void osd_deregister(u_int type, u_int slot); 60 61 int osd_set(u_int type, struct osd *osd, u_int slot, void *value); 62 void **osd_reserve(u_int slot); 63 int osd_set_reserved(u_int type, struct osd *osd, u_int slot, void **rsv, 64 void *value); 65 void osd_free_reserved(void **rsv); 66 void *osd_get(u_int type, struct osd *osd, u_int slot); 67 void osd_del(u_int type, struct osd *osd, u_int slot); 68 int osd_call(u_int type, u_int method, void *obj, void *data); 69 70 void osd_exit(u_int type, struct osd *osd); 71 72 #define osd_thread_register(destructor) \ 73 osd_register(OSD_THREAD, (destructor), NULL) 74 #define osd_thread_deregister(slot) \ 75 osd_deregister(OSD_THREAD, (slot)) 76 #define osd_thread_set(td, slot, value) \ 77 osd_set(OSD_THREAD, &(td)->td_osd, (slot), (value)) 78 #define osd_thread_set_reserved(td, slot, rsv, value) \ 79 osd_set_reserved(OSD_THREAD, &(td)->td_osd, (slot), (rsv), (value)) 80 #define osd_thread_get(td, slot) \ 81 osd_get(OSD_THREAD, &(td)->td_osd, (slot)) 82 #define osd_thread_del(td, slot) do { \ 83 KASSERT((td) == curthread, ("Not curthread.")); \ 84 osd_del(OSD_THREAD, &(td)->td_osd, (slot)); \ 85 } while (0) 86 #define osd_thread_call(td, method, data) \ 87 osd_call(OSD_THREAD, (method), (td), (data)) 88 #define osd_thread_exit(td) \ 89 osd_exit(OSD_THREAD, &(td)->td_osd) 90 91 #define osd_jail_register(destructor, methods) \ 92 osd_register(OSD_JAIL, (destructor), (methods)) 93 #define osd_jail_deregister(slot) \ 94 osd_deregister(OSD_JAIL, (slot)) 95 #define osd_jail_set(pr, slot, value) \ 96 osd_set(OSD_JAIL, &(pr)->pr_osd, (slot), (value)) 97 #define osd_jail_set_reserved(pr, slot, rsv, value) \ 98 osd_set_reserved(OSD_JAIL, &(pr)->pr_osd, (slot), (rsv), (value)) 99 #define osd_jail_get(pr, slot) \ 100 osd_get(OSD_JAIL, &(pr)->pr_osd, (slot)) 101 #define osd_jail_del(pr, slot) \ 102 osd_del(OSD_JAIL, &(pr)->pr_osd, (slot)) 103 #define osd_jail_call(pr, method, data) \ 104 osd_call(OSD_JAIL, (method), (pr), (data)) 105 #define osd_jail_exit(pr) \ 106 osd_exit(OSD_JAIL, &(pr)->pr_osd) 107 108 #endif /* _KERNEL */ 109 110 #endif /* !_SYS_OSD_H_ */ 111