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$
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
54 struct cdev {
55 struct cdev_priv *si_priv;
56 u_int si_flags;
57 #define SI_ALIAS 0x0002 /* carrier of alias name */
58 #define SI_NAMED 0x0004 /* make_dev{_alias} has been called */
59 #define SI_CHEAPCLONE 0x0008 /* can be removed_dev'ed when vnode reclaims */
60 #define SI_CHILD 0x0010 /* child of another struct cdev **/
61 #define SI_DEVOPEN 0x0020 /* opened by device */
62 #define SI_CONSOPEN 0x0040 /* opened by console */
63 #define SI_DUMPDEV 0x0080 /* is kernel dumpdev */
64 #define SI_CANDELETE 0x0100 /* can do BIO_DELETE */
65 #define SI_CLONELIST 0x0200 /* on a clone list */
66 struct timespec si_atime;
67 struct timespec si_ctime;
68 struct timespec si_mtime;
69 uid_t si_uid;
70 gid_t si_gid;
71 mode_t si_mode;
72 struct ucred *si_cred; /* cached clone-time credential */
73 u_int si_drv0;
74 int si_refcount;
75 LIST_ENTRY(cdev) si_list;
76 LIST_ENTRY(cdev) si_clone;
77 LIST_HEAD(, cdev) si_children;
78 LIST_ENTRY(cdev) si_siblings;
79 struct cdev *si_parent;
80 char *si_name;
81 void *si_drv1, *si_drv2;
82 struct cdevsw *si_devsw;
83 int si_iosize_max; /* maximum I/O size (for physio &al) */
84 u_long si_usecount;
85 u_long si_threadcount;
86 union {
87 struct tty *__sit_tty;
88 struct snapdata *__sid_snapdata;
89 } __si_u;
90 char __si_namebuf[SPECNAMELEN + 1];
91 };
92
93 #define si_tty __si_u.__sit_tty
94 #define si_snapdata __si_u.__sid_snapdata
95
96 #ifdef _KERNEL
97
98 /*
99 * Definitions of device driver entry switches
100 */
101
102 struct bio;
103 struct buf;
104 struct thread;
105 struct uio;
106 struct knote;
107 struct clonedevs;
108 struct vnode;
109
110 /*
111 * Note: d_thread_t is provided as a transition aid for those drivers
112 * that treat struct proc/struct thread as an opaque data type and
113 * exist in substantially the same form in both 4.x and 5.x. Writers
114 * of drivers that dips into the d_thread_t structure should use
115 * struct thread or struct proc as appropriate for the version of the
116 * OS they are using. It is provided in lieu of each device driver
117 * inventing its own way of doing this. While it does violate style(9)
118 * in a number of ways, this violation is deemed to be less
119 * important than the benefits that a uniform API between releases
120 * gives.
121 *
122 * Users of struct thread/struct proc that aren't device drivers should
123 * not use d_thread_t.
124 */
125
126 typedef struct thread d_thread_t;
127
128 typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td);
129 typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, int fdidx);
130 typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td);
131 typedef void d_strategy_t(struct bio *bp);
132 typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data,
133 int fflag, struct thread *td);
134
135 typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag);
136 typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag);
137 typedef int d_poll_t(struct cdev *dev, int events, struct thread *td);
138 typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn);
139 typedef int d_mmap_t(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr,
140 int nprot);
141 typedef void d_purge_t(struct cdev *dev);
142
143 typedef int d_spare2_t(struct cdev *dev);
144
145 typedef int dumper_t(
146 void *priv, /* Private to the driver. */
147 void *virtual, /* Virtual (mapped) address. */
148 vm_offset_t physical, /* Physical address of virtual. */
149 off_t offset, /* Byte-offset to write at. */
150 size_t length); /* Number of bytes to dump. */
151
152 #endif /* _KERNEL */
153
154 /*
155 * Types for d_flags.
156 */
157 #define D_TAPE 0x0001
158 #define D_DISK 0x0002
159 #define D_TTY 0x0004
160 #define D_MEM 0x0008
161
162 #ifdef _KERNEL
163
164 #define D_TYPEMASK 0xffff
165
166 /*
167 * Flags for d_flags which the drivers can set.
168 */
169 #define D_MEMDISK 0x00010000 /* memory type disk */
170 #define D_TRACKCLOSE 0x00080000 /* track all closes */
171 #define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */
172 #define D_PSEUDO 0x00200000 /* make_dev() can return NULL */
173 #define D_NEEDGIANT 0x00400000 /* driver want Giant */
174
175 /*
176 * Version numbers.
177 */
178 #define D_VERSION_00 0x20011966
179 #define D_VERSION_01 0x17032005 /* Add d_uid,gid,mode & kind */
180 #define D_VERSION D_VERSION_01
181
182 /*
183 * Flags used for internal housekeeping
184 */
185 #define D_INIT 0x80000000 /* cdevsw initialized */
186
187 /*
188 * Character device switch table
189 */
190 struct cdevsw {
191 int d_version;
192 u_int d_flags;
193 const char *d_name;
194 d_open_t *d_open;
195 d_fdopen_t *d_fdopen;
196 d_close_t *d_close;
197 d_read_t *d_read;
198 d_write_t *d_write;
199 d_ioctl_t *d_ioctl;
200 d_poll_t *d_poll;
201 d_mmap_t *d_mmap;
202 d_strategy_t *d_strategy;
203 dumper_t *d_dump;
204 d_kqfilter_t *d_kqfilter;
205 d_purge_t *d_purge;
206 d_spare2_t *d_spare2;
207 uid_t d_uid;
208 gid_t d_gid;
209 mode_t d_mode;
210 const char *d_kind;
211
212 /* These fields should not be messed with by drivers */
213 LIST_ENTRY(cdevsw) d_list;
214 LIST_HEAD(, cdev) d_devs;
215 int d_spare3;
216 struct cdevsw *d_gianttrick;
217 };
218
219 #define NUMCDEVSW 256
220
221 #define MAXMINOR 0xffff00ffU
222
223 struct module;
224
225 struct devsw_module_data {
226 int (*chainevh)(struct module *, int, void *); /* next handler */
227 void *chainarg; /* arg for next event handler */
228 /* Do not initialize fields hereafter */
229 };
230
231 #define DEV_MODULE(name, evh, arg) \
232 static moduledata_t name##_mod = { \
233 #name, \
234 evh, \
235 arg \
236 }; \
237 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
238
239
240 void clone_setup(struct clonedevs **cdp);
241 void clone_cleanup(struct clonedevs **);
242 #define CLONE_UNITMASK 0xfffff
243 #define CLONE_FLAG0 (CLONE_UNITMASK + 1)
244 int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, int extra);
245
246 int count_dev(struct cdev *_dev);
247 void destroy_dev(struct cdev *_dev);
248 struct cdevsw *dev_refthread(struct cdev *_dev);
249 struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp);
250 void dev_relthread(struct cdev *_dev);
251 void dev_depends(struct cdev *_pdev, struct cdev *_cdev);
252 void dev_ref(struct cdev *dev);
253 void dev_refl(struct cdev *dev);
254 void dev_rel(struct cdev *dev);
255 void dev_strategy(struct cdev *dev, struct buf *bp);
256 struct cdev *make_dev(struct cdevsw *_devsw, int _minor, uid_t _uid, gid_t _gid,
257 int _perms, const char *_fmt, ...) __printflike(6, 7);
258 struct cdev *make_dev_cred(struct cdevsw *_devsw, int _minor,
259 struct ucred *_cr, uid_t _uid, gid_t _gid, int _perms,
260 const char *_fmt, ...) __printflike(7, 8);
261 struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...) __printflike(2, 3);
262 int dev2unit(struct cdev *_dev);
263 void dev_lock(void);
264 void dev_unlock(void);
265 int unit2minor(int _unit);
266 u_int minor2unit(u_int _minor);
267 void setconf(void);
268
269 #define UID_ROOT 0
270 #define UID_BIN 3
271 #define UID_UUCP 66
272
273 #define GID_WHEEL 0
274 #define GID_KMEM 2
275 #define GID_OPERATOR 5
276 #define GID_BIN 7
277 #define GID_GAMES 13
278 #define GID_DIALER 68
279
280 typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name,
281 int namelen, struct cdev **result);
282
283 int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit);
284 EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
285
286 /* Stuff relating to kernel-dump */
287
288 struct dumperinfo {
289 dumper_t *dumper; /* Dumping function. */
290 void *priv; /* Private parts. */
291 u_int blocksize; /* Size of block in bytes. */
292 off_t mediaoffset; /* Initial offset in bytes. */
293 off_t mediasize; /* Space available in bytes. */
294 };
295
296 int set_dumper(struct dumperinfo *);
297 void dumpsys(struct dumperinfo *);
298 extern int dumping; /* system is dumping */
299
300 /* D_TTY related functions */
301 d_close_t ttyclose;
302 d_ioctl_t ttyioctl;
303 d_kqfilter_t ttykqfilter;
304 d_open_t ttyopen;
305 d_poll_t ttypoll;
306 d_read_t ttyread;
307 d_write_t ttywrite;
308
309 #endif /* _KERNEL */
310
311 #endif /* !_SYS_CONF_H_ */
Cache object: 468378679374e4f65e26197c1d0dc3b8
|