FreeBSD/Linux Kernel Cross Reference
sys/sys/conf.h
1 /*-
2 * Copyright (c) 1990, 1993
3 * The Regents of the University of California. All rights reserved.
4 * Copyright (c) 2000
5 * Poul-Henning Kamp. All rights reserved.
6 * (c) UNIX System Laboratories, Inc.
7 * All or some portions of this file are derived from material licensed
8 * to the University of California by American Telephone and Telegraph
9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10 * the permission of UNIX System Laboratories, Inc.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 * @(#)conf.h 8.5 (Berkeley) 1/9/95
37 * $FreeBSD: releng/7.3/sys/sys/conf.h 198595 2009-10-29 15:10:38Z jhb $
38 */
39
40 #ifndef _SYS_CONF_H_
41 #define _SYS_CONF_H_
42
43 #ifdef _KERNEL
44 #include <sys/eventhandler.h>
45 #else
46 #include <sys/queue.h>
47 #endif
48
49 struct tty;
50 struct snapdata;
51 struct devfs_dirent;
52 struct cdevsw;
53 struct file;
54
55 struct cdev {
56 struct cdev_priv *si_priv;
57 u_int si_flags;
58 #define SI_ALIAS 0x0002 /* carrier of alias name */
59 #define SI_NAMED 0x0004 /* make_dev{_alias} has been called */
60 #define SI_CHEAPCLONE 0x0008 /* can be removed_dev'ed when vnode reclaims */
61 #define SI_CHILD 0x0010 /* child of another struct cdev **/
62 #define SI_DEVOPEN 0x0020 /* opened by device */
63 #define SI_CONSOPEN 0x0040 /* opened by console */
64 #define SI_DUMPDEV 0x0080 /* is kernel dumpdev */
65 #define SI_CANDELETE 0x0100 /* can do BIO_DELETE */
66 #define SI_CLONELIST 0x0200 /* on a clone list */
67 struct timespec si_atime;
68 struct timespec si_ctime;
69 struct timespec si_mtime;
70 uid_t si_uid;
71 gid_t si_gid;
72 mode_t si_mode;
73 struct ucred *si_cred; /* cached clone-time credential */
74 u_int si_drv0;
75 int si_refcount;
76 LIST_ENTRY(cdev) si_list;
77 LIST_ENTRY(cdev) si_clone;
78 LIST_HEAD(, cdev) si_children;
79 LIST_ENTRY(cdev) si_siblings;
80 struct cdev *si_parent;
81 char *si_name;
82 void *si_drv1, *si_drv2;
83 struct cdevsw *si_devsw;
84 int si_iosize_max; /* maximum I/O size (for physio &al) */
85 u_long si_usecount;
86 u_long si_threadcount;
87 union {
88 struct tty *__sit_tty;
89 struct snapdata *__sid_snapdata;
90 } __si_u;
91 char __si_namebuf[SPECNAMELEN + 1];
92 };
93
94 #define si_tty __si_u.__sit_tty
95 #define si_snapdata __si_u.__sid_snapdata
96
97 #ifdef _KERNEL
98
99 /*
100 * Definitions of device driver entry switches
101 */
102
103 struct bio;
104 struct buf;
105 struct thread;
106 struct uio;
107 struct knote;
108 struct clonedevs;
109 struct vm_object;
110 struct vnode;
111
112 /*
113 * Note: d_thread_t is provided as a transition aid for those drivers
114 * that treat struct proc/struct thread as an opaque data type and
115 * exist in substantially the same form in both 4.x and 5.x. Writers
116 * of drivers that dips into the d_thread_t structure should use
117 * struct thread or struct proc as appropriate for the version of the
118 * OS they are using. It is provided in lieu of each device driver
119 * inventing its own way of doing this. While it does violate style(9)
120 * in a number of ways, this violation is deemed to be less
121 * important than the benefits that a uniform API between releases
122 * gives.
123 *
124 * Users of struct thread/struct proc that aren't device drivers should
125 * not use d_thread_t.
126 */
127
128 typedef struct thread d_thread_t;
129
130 typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td);
131 typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, struct file *fp);
132 typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td);
133 typedef void d_strategy_t(struct bio *bp);
134 typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data,
135 int fflag, struct thread *td);
136
137 typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag);
138 typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag);
139 typedef int d_poll_t(struct cdev *dev, int events, struct thread *td);
140 typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn);
141 typedef int d_mmap_t(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr,
142 int nprot);
143 typedef int d_mmap2_t(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr,
144 int nprot, vm_memattr_t *memattr);
145 typedef int d_mmap_single_t(struct cdev *cdev, vm_ooffset_t *offset,
146 vm_size_t size, struct vm_object **object, int nprot);
147 typedef void d_purge_t(struct cdev *dev);
148
149 typedef int dumper_t(
150 void *priv, /* Private to the driver. */
151 void *virtual, /* Virtual (mapped) address. */
152 vm_offset_t physical, /* Physical address of virtual. */
153 off_t offset, /* Byte-offset to write at. */
154 size_t length); /* Number of bytes to dump. */
155
156 #endif /* _KERNEL */
157
158 /*
159 * Types for d_flags.
160 */
161 #define D_TAPE 0x0001
162 #define D_DISK 0x0002
163 #define D_TTY 0x0004
164 #define D_MEM 0x0008
165
166 #ifdef _KERNEL
167
168 #define D_TYPEMASK 0xffff
169
170 /*
171 * Flags for d_flags which the drivers can set.
172 */
173 #define D_TRACKCLOSE 0x00080000 /* track all closes */
174 #define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */
175 #define D_PSEUDO 0x00200000 /* make_dev() can return NULL */
176 #define D_NEEDGIANT 0x00400000 /* driver want Giant */
177 #define D_MMAP2 0x01000000 /* driver uses d_mmap2() */
178
179 /*
180 * Version numbers.
181 */
182 #define D_VERSION_00 0x20011966
183 #define D_VERSION_01 0x17032005 /* Add d_uid,gid,mode & kind */
184 #define D_VERSION_02 0x28042009 /* Add d_mmap_single */
185 #define D_VERSION D_VERSION_02
186
187 /*
188 * Flags used for internal housekeeping
189 */
190 #define D_INIT 0x80000000 /* cdevsw initialized */
191
192 /*
193 * Character device switch table
194 */
195 struct cdevsw {
196 int d_version;
197 u_int d_flags;
198 const char *d_name;
199 d_open_t *d_open;
200 d_fdopen_t *d_fdopen;
201 d_close_t *d_close;
202 d_read_t *d_read;
203 d_write_t *d_write;
204 d_ioctl_t *d_ioctl;
205 d_poll_t *d_poll;
206 union {
207 d_mmap_t *old;
208 d_mmap2_t *new;
209 } __d_mmap;
210 d_strategy_t *d_strategy;
211 dumper_t *d_dump;
212 d_kqfilter_t *d_kqfilter;
213 d_purge_t *d_purge;
214 d_mmap_single_t *d_mmap_single;
215 uid_t d_uid;
216 gid_t d_gid;
217 mode_t d_mode;
218 const char *d_kind;
219
220 /* These fields should not be messed with by drivers */
221 LIST_ENTRY(cdevsw) d_list;
222 LIST_HEAD(, cdev) d_devs;
223 int d_spare3;
224 union {
225 struct cdevsw *gianttrick;
226 SLIST_ENTRY(cdevsw) postfree_list;
227 } __d_giant;
228 };
229 #define d_mmap __d_mmap.old
230 #define d_mmap2 __d_mmap.new
231 #define d_gianttrick __d_giant.gianttrick
232 #define d_postfree_list __d_giant.postfree_list
233
234 #define NUMCDEVSW 256
235
236 #define MAXMINOR 0xffff00ffU
237
238 struct module;
239
240 struct devsw_module_data {
241 int (*chainevh)(struct module *, int, void *); /* next handler */
242 void *chainarg; /* arg for next event handler */
243 /* Do not initialize fields hereafter */
244 };
245
246 #define DEV_MODULE(name, evh, arg) \
247 static moduledata_t name##_mod = { \
248 #name, \
249 evh, \
250 arg \
251 }; \
252 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
253
254
255 void clone_setup(struct clonedevs **cdp);
256 void clone_cleanup(struct clonedevs **);
257 #define CLONE_UNITMASK 0xfffff
258 #define CLONE_FLAG0 (CLONE_UNITMASK + 1)
259 int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, int extra);
260
261 int count_dev(struct cdev *_dev);
262 void destroy_dev(struct cdev *_dev);
263 int destroy_dev_sched(struct cdev *dev);
264 int destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg);
265 void destroy_dev_drain(struct cdevsw *csw);
266 void drain_dev_clone_events(void);
267 struct cdevsw *dev_refthread(struct cdev *_dev);
268 struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp);
269 void dev_relthread(struct cdev *_dev);
270 void dev_depends(struct cdev *_pdev, struct cdev *_cdev);
271 void dev_ref(struct cdev *dev);
272 void dev_refl(struct cdev *dev);
273 void dev_rel(struct cdev *dev);
274 void dev_strategy(struct cdev *dev, struct buf *bp);
275 struct cdev *make_dev(struct cdevsw *_devsw, int _minor, uid_t _uid, gid_t _gid,
276 int _perms, const char *_fmt, ...) __printflike(6, 7);
277 struct cdev *make_dev_cred(struct cdevsw *_devsw, int _minor,
278 struct ucred *_cr, uid_t _uid, gid_t _gid, int _perms,
279 const char *_fmt, ...) __printflike(7, 8);
280 #define MAKEDEV_REF 0x1
281 #define MAKEDEV_WHTOUT 0x2
282 struct cdev *make_dev_credf(int _flags,
283 struct cdevsw *_devsw, int _minornr,
284 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode,
285 const char *_fmt, ...) __printflike(8, 9);
286 struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...) __printflike(2, 3);
287 int dev2unit(struct cdev *_dev);
288 void dev_lock(void);
289 void dev_unlock(void);
290 int unit2minor(int _unit);
291 u_int minor2unit(u_int _minor);
292 void setconf(void);
293
294 typedef void (*cdevpriv_dtr_t)(void *data);
295 int devfs_get_cdevpriv(void **datap);
296 int devfs_set_cdevpriv(void *priv, cdevpriv_dtr_t dtr);
297 void devfs_clear_cdevpriv(void);
298 void devfs_fpdrop(struct file *fp); /* XXX This is not public KPI */
299
300 #define UID_ROOT 0
301 #define UID_BIN 3
302 #define UID_UUCP 66
303 #define UID_NOBODY 65534
304
305 #define GID_WHEEL 0
306 #define GID_KMEM 2
307 #define GID_OPERATOR 5
308 #define GID_BIN 7
309 #define GID_GAMES 13
310 #define GID_DIALER 68
311
312 typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name,
313 int namelen, struct cdev **result);
314
315 int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit);
316 EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
317
318 /* Stuff relating to kernel-dump */
319
320 struct dumperinfo {
321 dumper_t *dumper; /* Dumping function. */
322 void *priv; /* Private parts. */
323 u_int blocksize; /* Size of block in bytes. */
324 off_t mediaoffset; /* Initial offset in bytes. */
325 off_t mediasize; /* Space available in bytes. */
326 };
327
328 int set_dumper(struct dumperinfo *);
329 int dump_write(struct dumperinfo *, void *, vm_offset_t, off_t, size_t);
330 void dumpsys(struct dumperinfo *);
331 extern int dumping; /* system is dumping */
332
333 /* D_TTY related functions */
334 d_close_t ttyclose;
335 d_ioctl_t ttyioctl;
336 d_kqfilter_t ttykqfilter;
337 d_open_t ttyopen;
338 d_poll_t ttypoll;
339 d_read_t ttyread;
340 d_write_t ttywrite;
341
342 #endif /* _KERNEL */
343
344 #endif /* !_SYS_CONF_H_ */
Cache object: 7495165b5ade68974ed5ba7f2612ef83
|