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 snapdata; |
---|
50 | struct devfs_dirent; |
---|
51 | struct cdevsw; |
---|
52 | struct file; |
---|
53 | #ifdef __rtems__ |
---|
54 | struct ucred; |
---|
55 | #endif /* __rtems__ */ |
---|
56 | |
---|
57 | struct cdev { |
---|
58 | struct mount *si_mountpt; |
---|
59 | u_int si_flags; |
---|
60 | #define SI_ETERNAL 0x0001 /* never destroyed */ |
---|
61 | #define SI_ALIAS 0x0002 /* carrier of alias name */ |
---|
62 | #define SI_NAMED 0x0004 /* make_dev{_alias} has been called */ |
---|
63 | #define SI_CHEAPCLONE 0x0008 /* can be removed_dev'ed when vnode reclaims */ |
---|
64 | #define SI_CHILD 0x0010 /* child of another struct cdev **/ |
---|
65 | #define SI_DEVOPEN 0x0020 /* opened by device */ |
---|
66 | #define SI_CONSOPEN 0x0040 /* opened by console */ |
---|
67 | #define SI_DUMPDEV 0x0080 /* is kernel dumpdev */ |
---|
68 | #define SI_CANDELETE 0x0100 /* can do BIO_DELETE */ |
---|
69 | #define SI_CLONELIST 0x0200 /* on a clone list */ |
---|
70 | #define SI_UNMAPPED 0x0400 /* can handle unmapped I/O */ |
---|
71 | #ifndef __rtems__ |
---|
72 | struct timespec si_atime; |
---|
73 | struct timespec si_ctime; |
---|
74 | struct timespec si_mtime; |
---|
75 | uid_t si_uid; |
---|
76 | gid_t si_gid; |
---|
77 | mode_t si_mode; |
---|
78 | struct ucred *si_cred; /* cached clone-time credential */ |
---|
79 | #endif /* __rtems__ */ |
---|
80 | int si_drv0; |
---|
81 | #ifndef __rtems__ |
---|
82 | int si_refcount; |
---|
83 | LIST_ENTRY(cdev) si_list; |
---|
84 | LIST_ENTRY(cdev) si_clone; |
---|
85 | LIST_HEAD(, cdev) si_children; |
---|
86 | LIST_ENTRY(cdev) si_siblings; |
---|
87 | struct cdev *si_parent; |
---|
88 | char *si_name; |
---|
89 | #endif /* __rtems__ */ |
---|
90 | void *si_drv1, *si_drv2; |
---|
91 | #ifndef __rtems__ |
---|
92 | struct cdevsw *si_devsw; |
---|
93 | int si_iosize_max; /* maximum I/O size (for physio &al) */ |
---|
94 | u_long si_usecount; |
---|
95 | u_long si_threadcount; |
---|
96 | union { |
---|
97 | struct snapdata *__sid_snapdata; |
---|
98 | } __si_u; |
---|
99 | char __si_namebuf[SPECNAMELEN + 1]; |
---|
100 | #endif /* __rtems__ */ |
---|
101 | }; |
---|
102 | |
---|
103 | #define si_snapdata __si_u.__sid_snapdata |
---|
104 | |
---|
105 | #ifdef _KERNEL |
---|
106 | |
---|
107 | /* |
---|
108 | * Definitions of device driver entry switches |
---|
109 | */ |
---|
110 | |
---|
111 | struct bio; |
---|
112 | struct buf; |
---|
113 | struct thread; |
---|
114 | struct uio; |
---|
115 | struct knote; |
---|
116 | struct clonedevs; |
---|
117 | struct vm_object; |
---|
118 | struct vnode; |
---|
119 | |
---|
120 | /* |
---|
121 | * Note: d_thread_t is provided as a transition aid for those drivers |
---|
122 | * that treat struct proc/struct thread as an opaque data type and |
---|
123 | * exist in substantially the same form in both 4.x and 5.x. Writers |
---|
124 | * of drivers that dips into the d_thread_t structure should use |
---|
125 | * struct thread or struct proc as appropriate for the version of the |
---|
126 | * OS they are using. It is provided in lieu of each device driver |
---|
127 | * inventing its own way of doing this. While it does violate style(9) |
---|
128 | * in a number of ways, this violation is deemed to be less |
---|
129 | * important than the benefits that a uniform API between releases |
---|
130 | * gives. |
---|
131 | * |
---|
132 | * Users of struct thread/struct proc that aren't device drivers should |
---|
133 | * not use d_thread_t. |
---|
134 | */ |
---|
135 | |
---|
136 | typedef struct thread d_thread_t; |
---|
137 | |
---|
138 | typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td); |
---|
139 | typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, struct file *fp); |
---|
140 | typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td); |
---|
141 | typedef void d_strategy_t(struct bio *bp); |
---|
142 | typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data, |
---|
143 | int fflag, struct thread *td); |
---|
144 | |
---|
145 | typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag); |
---|
146 | typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag); |
---|
147 | typedef int d_poll_t(struct cdev *dev, int events, struct thread *td); |
---|
148 | typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn); |
---|
149 | typedef int d_mmap_t(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr, |
---|
150 | int nprot, vm_memattr_t *memattr); |
---|
151 | typedef int d_mmap_single_t(struct cdev *cdev, vm_ooffset_t *offset, |
---|
152 | vm_size_t size, struct vm_object **object, int nprot); |
---|
153 | typedef void d_purge_t(struct cdev *dev); |
---|
154 | |
---|
155 | typedef int dumper_t( |
---|
156 | void *_priv, /* Private to the driver. */ |
---|
157 | void *_virtual, /* Virtual (mapped) address. */ |
---|
158 | vm_offset_t _physical, /* Physical address of virtual. */ |
---|
159 | off_t _offset, /* Byte-offset to write at. */ |
---|
160 | size_t _length); /* Number of bytes to dump. */ |
---|
161 | |
---|
162 | #endif /* _KERNEL */ |
---|
163 | |
---|
164 | /* |
---|
165 | * Types for d_flags. |
---|
166 | */ |
---|
167 | #define D_TAPE 0x0001 |
---|
168 | #define D_DISK 0x0002 |
---|
169 | #define D_TTY 0x0004 |
---|
170 | #define D_MEM 0x0008 |
---|
171 | |
---|
172 | #ifdef _KERNEL |
---|
173 | |
---|
174 | #define D_TYPEMASK 0xffff |
---|
175 | |
---|
176 | /* |
---|
177 | * Flags for d_flags which the drivers can set. |
---|
178 | */ |
---|
179 | #define D_TRACKCLOSE 0x00080000 /* track all closes */ |
---|
180 | #define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */ |
---|
181 | #define D_PSEUDO 0x00200000 /* make_dev() can return NULL */ |
---|
182 | #define D_NEEDGIANT 0x00400000 /* driver want Giant */ |
---|
183 | #define D_NEEDMINOR 0x00800000 /* driver uses clone_create() */ |
---|
184 | #define D_UNMAPPED_IO 0x01000000 /* d_strategy can accept unmapped IO */ |
---|
185 | |
---|
186 | /* |
---|
187 | * Version numbers. |
---|
188 | */ |
---|
189 | #define D_VERSION_00 0x20011966 |
---|
190 | #define D_VERSION_01 0x17032005 /* Add d_uid,gid,mode & kind */ |
---|
191 | #define D_VERSION_02 0x28042009 /* Add d_mmap_single */ |
---|
192 | #define D_VERSION_03 0x17122009 /* d_mmap takes memattr,vm_ooffset_t */ |
---|
193 | #define D_VERSION D_VERSION_03 |
---|
194 | |
---|
195 | /* |
---|
196 | * Flags used for internal housekeeping |
---|
197 | */ |
---|
198 | #define D_INIT 0x80000000 /* cdevsw initialized */ |
---|
199 | |
---|
200 | /* |
---|
201 | * Character device switch table |
---|
202 | */ |
---|
203 | struct cdevsw { |
---|
204 | int d_version; |
---|
205 | u_int d_flags; |
---|
206 | const char *d_name; |
---|
207 | d_open_t *d_open; |
---|
208 | d_fdopen_t *d_fdopen; |
---|
209 | d_close_t *d_close; |
---|
210 | d_read_t *d_read; |
---|
211 | d_write_t *d_write; |
---|
212 | d_ioctl_t *d_ioctl; |
---|
213 | d_poll_t *d_poll; |
---|
214 | d_mmap_t *d_mmap; |
---|
215 | d_strategy_t *d_strategy; |
---|
216 | dumper_t *d_dump; |
---|
217 | d_kqfilter_t *d_kqfilter; |
---|
218 | d_purge_t *d_purge; |
---|
219 | d_mmap_single_t *d_mmap_single; |
---|
220 | |
---|
221 | int32_t d_spare0[3]; |
---|
222 | void *d_spare1[3]; |
---|
223 | |
---|
224 | /* These fields should not be messed with by drivers */ |
---|
225 | LIST_HEAD(, cdev) d_devs; |
---|
226 | int d_spare2; |
---|
227 | union { |
---|
228 | struct cdevsw *gianttrick; |
---|
229 | SLIST_ENTRY(cdevsw) postfree_list; |
---|
230 | } __d_giant; |
---|
231 | }; |
---|
232 | #define d_gianttrick __d_giant.gianttrick |
---|
233 | #define d_postfree_list __d_giant.postfree_list |
---|
234 | |
---|
235 | struct module; |
---|
236 | |
---|
237 | struct devsw_module_data { |
---|
238 | int (*chainevh)(struct module *, int, void *); /* next handler */ |
---|
239 | void *chainarg; /* arg for next event handler */ |
---|
240 | /* Do not initialize fields hereafter */ |
---|
241 | }; |
---|
242 | |
---|
243 | #define DEV_MODULE(name, evh, arg) \ |
---|
244 | static moduledata_t name##_mod = { \ |
---|
245 | #name, \ |
---|
246 | evh, \ |
---|
247 | arg \ |
---|
248 | }; \ |
---|
249 | DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE) |
---|
250 | |
---|
251 | |
---|
252 | void clone_setup(struct clonedevs **cdp); |
---|
253 | void clone_cleanup(struct clonedevs **); |
---|
254 | #define CLONE_UNITMASK 0xfffff |
---|
255 | #define CLONE_FLAG0 (CLONE_UNITMASK + 1) |
---|
256 | int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, int extra); |
---|
257 | |
---|
258 | int count_dev(struct cdev *_dev); |
---|
259 | void delist_dev(struct cdev *_dev); |
---|
260 | void destroy_dev(struct cdev *_dev); |
---|
261 | int destroy_dev_sched(struct cdev *dev); |
---|
262 | int destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg); |
---|
263 | void destroy_dev_drain(struct cdevsw *csw); |
---|
264 | void drain_dev_clone_events(void); |
---|
265 | struct cdevsw *dev_refthread(struct cdev *_dev, int *_ref); |
---|
266 | struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp, int *_ref); |
---|
267 | void dev_relthread(struct cdev *_dev, int _ref); |
---|
268 | void dev_depends(struct cdev *_pdev, struct cdev *_cdev); |
---|
269 | void dev_ref(struct cdev *dev); |
---|
270 | void dev_refl(struct cdev *dev); |
---|
271 | void dev_rel(struct cdev *dev); |
---|
272 | void dev_strategy(struct cdev *dev, struct buf *bp); |
---|
273 | void dev_strategy_csw(struct cdev *dev, struct cdevsw *csw, struct buf *bp); |
---|
274 | struct cdev *make_dev(struct cdevsw *_devsw, int _unit, uid_t _uid, gid_t _gid, |
---|
275 | int _perms, const char *_fmt, ...) __printflike(6, 7); |
---|
276 | struct cdev *make_dev_cred(struct cdevsw *_devsw, int _unit, |
---|
277 | struct ucred *_cr, uid_t _uid, gid_t _gid, int _perms, |
---|
278 | const char *_fmt, ...) __printflike(7, 8); |
---|
279 | #define MAKEDEV_REF 0x01 |
---|
280 | #define MAKEDEV_WHTOUT 0x02 |
---|
281 | #define MAKEDEV_NOWAIT 0x04 |
---|
282 | #define MAKEDEV_WAITOK 0x08 |
---|
283 | #define MAKEDEV_ETERNAL 0x10 |
---|
284 | #define MAKEDEV_CHECKNAME 0x20 |
---|
285 | struct cdev *make_dev_credf(int _flags, |
---|
286 | struct cdevsw *_devsw, int _unit, |
---|
287 | struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode, |
---|
288 | const char *_fmt, ...) __printflike(8, 9); |
---|
289 | int make_dev_p(int _flags, struct cdev **_cdev, struct cdevsw *_devsw, |
---|
290 | struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode, |
---|
291 | const char *_fmt, ...) __printflike(8, 9); |
---|
292 | struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...) |
---|
293 | __printflike(2, 3); |
---|
294 | int make_dev_alias_p(int _flags, struct cdev **_cdev, struct cdev *_pdev, |
---|
295 | const char *_fmt, ...) __printflike(4, 5); |
---|
296 | int make_dev_physpath_alias(int _flags, struct cdev **_cdev, |
---|
297 | struct cdev *_pdev, struct cdev *_old_alias, |
---|
298 | const char *_physpath); |
---|
299 | void dev_lock(void); |
---|
300 | void dev_unlock(void); |
---|
301 | void setconf(void); |
---|
302 | |
---|
303 | #ifdef KLD_MODULE |
---|
304 | #define MAKEDEV_ETERNAL_KLD 0 |
---|
305 | #else |
---|
306 | #define MAKEDEV_ETERNAL_KLD MAKEDEV_ETERNAL |
---|
307 | #endif |
---|
308 | |
---|
309 | #define dev2unit(d) ((d)->si_drv0) |
---|
310 | |
---|
311 | typedef void (*cdevpriv_dtr_t)(void *data); |
---|
312 | int devfs_get_cdevpriv(void **datap); |
---|
313 | int devfs_set_cdevpriv(void *priv, cdevpriv_dtr_t dtr); |
---|
314 | void devfs_clear_cdevpriv(void); |
---|
315 | void devfs_fpdrop(struct file *fp); /* XXX This is not public KPI */ |
---|
316 | |
---|
317 | ino_t devfs_alloc_cdp_inode(void); |
---|
318 | void devfs_free_cdp_inode(ino_t ino); |
---|
319 | |
---|
320 | #define UID_ROOT 0 |
---|
321 | #define UID_BIN 3 |
---|
322 | #define UID_UUCP 66 |
---|
323 | #define UID_NOBODY 65534 |
---|
324 | |
---|
325 | #define GID_WHEEL 0 |
---|
326 | #define GID_KMEM 2 |
---|
327 | #define GID_TTY 4 |
---|
328 | #define GID_OPERATOR 5 |
---|
329 | #define GID_BIN 7 |
---|
330 | #define GID_GAMES 13 |
---|
331 | #define GID_DIALER 68 |
---|
332 | #define GID_NOBODY 65534 |
---|
333 | |
---|
334 | typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name, |
---|
335 | int namelen, struct cdev **result); |
---|
336 | |
---|
337 | int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit); |
---|
338 | EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn); |
---|
339 | |
---|
340 | /* Stuff relating to kernel-dump */ |
---|
341 | |
---|
342 | struct dumperinfo { |
---|
343 | dumper_t *dumper; /* Dumping function. */ |
---|
344 | void *priv; /* Private parts. */ |
---|
345 | u_int blocksize; /* Size of block in bytes. */ |
---|
346 | u_int maxiosize; /* Max size allowed for an individual I/O */ |
---|
347 | off_t mediaoffset; /* Initial offset in bytes. */ |
---|
348 | off_t mediasize; /* Space available in bytes. */ |
---|
349 | }; |
---|
350 | |
---|
351 | int set_dumper(struct dumperinfo *); |
---|
352 | int dump_write(struct dumperinfo *, void *, vm_offset_t, off_t, size_t); |
---|
353 | void dumpsys(struct dumperinfo *); |
---|
354 | int doadump(boolean_t); |
---|
355 | #ifndef __rtems__ |
---|
356 | extern int dumping; /* system is dumping */ |
---|
357 | #else /* __rtems__ */ |
---|
358 | #define dumping 0 |
---|
359 | #endif /* __rtems__ */ |
---|
360 | |
---|
361 | #endif /* _KERNEL */ |
---|
362 | |
---|
363 | #endif /* !_SYS_CONF_H_ */ |
---|