2 * Copyright (c) 2000 Doug Rabson
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
26 * $FreeBSD: src/sys/sys/kobj.h,v 1.8 2003/09/22 21:32:49 peter Exp $
27 * $DragonFly: src/sys/sys/kobj.h,v 1.10 2006/05/20 02:42:13 dillon Exp $
34 #include <sys/types.h>
37 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
38 #error "This file should not be included by userland programs."
42 * Forward declarations
44 typedef struct kobj *kobj_t;
45 typedef struct kobj_class *kobj_class_t;
46 typedef struct kobj_method kobj_method_t;
47 typedef int (*kobjop_t)(void);
48 typedef struct kobj_ops *kobj_ops_t;
49 typedef struct kobjop_desc *kobjop_desc_t;
58 * A class is simply a method table and a sizeof value. When the first
59 * instance of the class is created, the method table will be compiled
60 * into a form more suited to efficient method dispatch. This compiled
61 * method table is always the first field of the object.
63 #define KOBJ_CLASS_FIELDS \
64 const char *name; /* class name */ \
65 kobj_method_t *methods; /* method table */ \
66 size_t size; /* object size */ \
67 kobj_class_t *baseclasses; /* base classes */ \
68 u_int refs; /* reference count */ \
69 kobj_ops_t ops /* compiled method table */
76 * Implementation of kobj.
86 * The ops table is used as a cache of results from kobj_lookup_method().
89 #define KOBJ_CACHE_SIZE 256
92 kobj_method_t *cache[KOBJ_CACHE_SIZE];
97 unsigned int id; /* unique ID */
98 kobj_method_t *deflt; /* default implementation */
102 * Shorthand for constructing method tables.
104 #define KOBJMETHOD(NAME, FUNC) { &NAME##_desc, (kobjop_t) FUNC }
107 * Declare a class (which should be defined in another file.
109 #define DECLARE_CLASS(name) extern struct kobj_class name
112 * Define a class with no base classes (api backward-compatible. with
113 * FreeBSD-5.1 and earlier).
115 #define DEFINE_CLASS(name, methods, size) \
116 DEFINE_CLASS_0(name, name ## _class, methods, size)
119 * Define a class with no base classes. Use like this:
121 * DEFINE_CLASS_0(foo, foo_class, foo_methods, sizeof(foo_softc));
123 #define DEFINE_CLASS_0(name, classvar, methods, size) \
125 struct kobj_class classvar = { \
126 #name, methods, size, NULL, 0, NULL \
130 * Define a class inheriting a single base class. Use like this:
132 * DEFINE_CLASS1(foo, foo_class, foo_methods, sizeof(foo_softc),
135 #define DEFINE_CLASS_1(name, classvar, methods, size, \
138 static kobj_class_t name ## _baseclasses[] = { \
141 struct kobj_class classvar = { \
142 #name, methods, size, name ## _baseclasses \
146 * Define a class inheriting two base classes. Use like this:
148 * DEFINE_CLASS2(foo, foo_class, foo_methods, sizeof(foo_softc),
151 #define DEFINE_CLASS_2(name, methods, size, \
154 static kobj_class_t name ## _baseclasses[] = { \
158 struct kobj_class name ## _class = { \
159 #name, methods, size, name ## _baseclasses \
163 * Define a class inheriting three base classes. Use like this:
165 * DEFINE_CLASS3(foo, foo_class, foo_methods, sizeof(foo_softc),
168 #define DEFINE_CLASS_3(name, methods, size, \
169 base1, base2, base3) \
171 static kobj_class_t name ## _baseclasses[] = { \
176 struct kobj_class name ## _class = { \
177 #name, methods, size, name ## _baseclasses \
183 * Compile class for the first instance and add a reference.
185 void kobj_class_instantiate(kobj_class_t cls);
188 * Remove a reference and free method table with the last instance.
190 void kobj_class_uninstantiate(kobj_class_t cls);
193 * Allocate memory for and initialise a new object.
195 kobj_t kobj_create(kobj_class_t cls,
196 struct malloc_type *mtype,
200 * Initialise a pre-allocated object.
202 void kobj_init(kobj_t obj, kobj_class_t cls);
205 * Delete an object. If mtype is non-zero, free the memory.
207 void kobj_delete(kobj_t obj, struct malloc_type *mtype);
210 * Maintain stats on hits/misses in lookup caches.
213 extern u_int kobj_lookup_hits;
214 extern u_int kobj_lookup_misses;
218 * Lookup the method in the cache and if it isn't there look it up the
222 #define KOBJOPLOOKUP(OPS,OP) do { \
223 kobjop_desc_t _desc = &OP##_##desc; \
224 kobj_method_t **_cep = \
225 &OPS->cache[_desc->id & (KOBJ_CACHE_SIZE-1)]; \
226 kobj_method_t *_ce = *_cep; \
227 kobj_lookup_hits++; /* assume hit */ \
228 if (_ce->desc != _desc) \
229 _ce = kobj_lookup_method(OPS->cls, \
234 #define KOBJOPLOOKUP(OPS,OP) do { \
235 kobjop_desc_t _desc = &OP##_##desc; \
236 kobj_method_t **_cep = \
237 &OPS->cache[_desc->id & (KOBJ_CACHE_SIZE-1)]; \
238 kobj_method_t *_ce = *_cep; \
239 if (_ce->desc != _desc) \
240 _ce = kobj_lookup_method(OPS->cls, \
246 kobj_method_t *kobj_lookup_method(kobj_class_t cls,
251 * Default method implementation. Returns ENXIO.
253 int kobj_error_method(void);
257 #endif /* !_SYS_KOBJ_H_ */