2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 1990, 1993
5 * The Regents of the University of California. All rights reserved.
7 * Poul-Henning Kamp. All rights reserved.
8 * (c) UNIX System Laboratories, Inc.
9 * All or some portions of this file are derived from material licensed
10 * to the University of California by American Telephone and Telegraph
11 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
12 * the permission of UNIX System Laboratories, Inc.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
22 * 3. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * @(#)conf.h 8.5 (Berkeley) 1/9/95
46 #include <sys/_eventhandler.h>
48 #include <sys/queue.h>
59 #define SI_ETERNAL 0x0001 /* never destroyed */
60 #define SI_ALIAS 0x0002 /* carrier of alias name */
61 #define SI_NAMED 0x0004 /* make_dev{_alias} has been called */
62 #define SI_UNUSED1 0x0008 /* unused */
63 #define SI_CHILD 0x0010 /* child of another struct cdev **/
64 #define SI_DUMPDEV 0x0080 /* is kernel dumpdev */
65 #define SI_CLONELIST 0x0200 /* on a clone list */
66 #define SI_UNMAPPED 0x0400 /* can handle unmapped I/O */
67 #define SI_NOSPLIT 0x0800 /* I/O should not be split up */
68 struct timespec si_atime;
69 struct timespec si_ctime;
70 struct timespec si_mtime;
74 struct ucred *si_cred; /* cached clone-time credential */
77 LIST_ENTRY(cdev) si_list;
78 LIST_ENTRY(cdev) si_clone;
79 LIST_HEAD(, cdev) si_children;
80 LIST_ENTRY(cdev) si_siblings;
81 struct cdev *si_parent;
82 struct mount *si_mountpt;
83 void *si_drv1, *si_drv2;
84 struct cdevsw *si_devsw;
85 int si_iosize_max; /* maximum I/O size (for physio &al) */
87 u_long si_threadcount;
89 struct snapdata *__sid_snapdata;
91 char si_name[SPECNAMELEN + 1];
94 #define si_snapdata __si_u.__sid_snapdata
99 * Definitions of device driver entry switches
105 struct kerneldumpheader;
113 typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td);
114 typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, struct file *fp);
115 typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td);
116 typedef void d_strategy_t(struct bio *bp);
117 typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data,
118 int fflag, struct thread *td);
120 typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag);
121 typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag);
122 typedef int d_poll_t(struct cdev *dev, int events, struct thread *td);
123 typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn);
124 typedef int d_mmap_t(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
125 int nprot, vm_memattr_t *memattr);
126 typedef int d_mmap_single_t(struct cdev *cdev, vm_ooffset_t *offset,
127 vm_size_t size, struct vm_object **object, int nprot);
128 typedef void d_purge_t(struct cdev *dev);
130 typedef int dumper_t(
131 void *_priv, /* Private to the driver. */
132 void *_virtual, /* Virtual (mapped) address. */
133 vm_offset_t _physical, /* Physical address of virtual. */
134 off_t _offset, /* Byte-offset to write at. */
135 size_t _length); /* Number of bytes to dump. */
136 typedef int dumper_start_t(struct dumperinfo *di);
137 typedef int dumper_hdr_t(struct dumperinfo *di, struct kerneldumpheader *kdh,
138 void *key, uint32_t keylen);
145 #define D_TAPE 0x0001
146 #define D_DISK 0x0002
148 #define D_MEM 0x0008 /* /dev/(k)mem */
150 /* Defined uid and gid values. */
154 #define UID_NOBODY 65534
159 #define GID_OPERATOR 5
163 #define GID_DIALER 68
164 #define GID_NOGROUP 65533
165 #define GID_NOBODY 65534
169 #define D_TYPEMASK 0xffff
172 * Flags for d_flags which the drivers can set.
174 #define D_TRACKCLOSE 0x00080000 /* track all closes */
175 #define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */
176 #define D_NEEDGIANT 0x00400000 /* driver want Giant */
177 #define D_NEEDMINOR 0x00800000 /* driver uses clone_create() */
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_03 0x17122009 /* d_mmap takes memattr,vm_ooffset_t */
186 #define D_VERSION_04 0x5c48c353 /* SPECNAMELEN bumped to MAXNAMLEN */
187 #define D_VERSION D_VERSION_04
190 * Flags used for internal housekeeping
192 #define D_INIT 0x80000000 /* cdevsw initialized */
195 * Character device switch table
202 d_fdopen_t *d_fdopen;
209 d_strategy_t *d_strategy;
211 d_kqfilter_t *d_kqfilter;
213 d_mmap_single_t *d_mmap_single;
218 /* These fields should not be messed with by drivers */
219 LIST_HEAD(, cdev) d_devs;
222 struct cdevsw *gianttrick;
223 SLIST_ENTRY(cdevsw) postfree_list;
226 #define d_gianttrick __d_giant.gianttrick
227 #define d_postfree_list __d_giant.postfree_list
231 struct devsw_module_data {
232 int (*chainevh)(struct module *, int, void *); /* next handler */
233 void *chainarg; /* arg for next event handler */
234 /* Do not initialize fields hereafter */
237 #define DEV_MODULE_ORDERED(name, evh, arg, ord) \
238 static moduledata_t name##_mod = { \
243 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, ord)
245 #define DEV_MODULE(name, evh, arg) \
246 DEV_MODULE_ORDERED(name, evh, arg, SI_ORDER_MIDDLE)
248 void clone_setup(struct clonedevs **cdp);
249 void clone_cleanup(struct clonedevs **);
250 #define CLONE_UNITMASK 0xfffff
251 #define CLONE_FLAG0 (CLONE_UNITMASK + 1)
252 int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, int extra);
254 #define MAKEDEV_REF 0x01
255 #define MAKEDEV_WHTOUT 0x02
256 #define MAKEDEV_NOWAIT 0x04
257 #define MAKEDEV_WAITOK 0x08
258 #define MAKEDEV_ETERNAL 0x10
259 #define MAKEDEV_CHECKNAME 0x20
260 struct make_dev_args {
263 struct cdevsw *mda_devsw;
264 struct ucred *mda_cr;
272 void make_dev_args_init_impl(struct make_dev_args *_args, size_t _sz);
273 #define make_dev_args_init(a) \
274 make_dev_args_init_impl((a), sizeof(struct make_dev_args))
276 void delist_dev(struct cdev *_dev);
277 void destroy_dev(struct cdev *_dev);
278 int destroy_dev_sched(struct cdev *dev);
279 int destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg);
280 void destroy_dev_drain(struct cdevsw *csw);
281 void drain_dev_clone_events(void);
282 struct cdevsw *dev_refthread(struct cdev *_dev, int *_ref);
283 struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp, int *_ref);
284 void dev_relthread(struct cdev *_dev, int _ref);
285 void dev_depends(struct cdev *_pdev, struct cdev *_cdev);
286 void dev_ref(struct cdev *dev);
287 void dev_refl(struct cdev *dev);
288 void dev_rel(struct cdev *dev);
289 struct cdev *make_dev(struct cdevsw *_devsw, int _unit, uid_t _uid, gid_t _gid,
290 int _perms, const char *_fmt, ...) __printflike(6, 7);
291 struct cdev *make_dev_cred(struct cdevsw *_devsw, int _unit,
292 struct ucred *_cr, uid_t _uid, gid_t _gid, int _perms,
293 const char *_fmt, ...) __printflike(7, 8);
294 struct cdev *make_dev_credf(int _flags,
295 struct cdevsw *_devsw, int _unit,
296 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode,
297 const char *_fmt, ...) __printflike(8, 9);
298 int make_dev_p(int _flags, struct cdev **_cdev, struct cdevsw *_devsw,
299 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode,
300 const char *_fmt, ...) __printflike(8, 9);
301 int make_dev_s(struct make_dev_args *_args, struct cdev **_cdev,
302 const char *_fmt, ...) __printflike(3, 4);
303 struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...)
305 int make_dev_alias_p(int _flags, struct cdev **_cdev, struct cdev *_pdev,
306 const char *_fmt, ...) __printflike(4, 5);
307 int make_dev_physpath_alias(int _flags, struct cdev **_cdev,
308 struct cdev *_pdev, struct cdev *_old_alias,
309 const char *_physpath);
311 void dev_unlock(void);
314 #define MAKEDEV_ETERNAL_KLD 0
316 #define MAKEDEV_ETERNAL_KLD MAKEDEV_ETERNAL
319 #define dev2unit(d) ((d)->si_drv0)
321 typedef void d_priv_dtor_t(void *data);
322 int devfs_get_cdevpriv(void **datap);
323 int devfs_set_cdevpriv(void *priv, d_priv_dtor_t *dtr);
324 void devfs_clear_cdevpriv(void);
326 ino_t devfs_alloc_cdp_inode(void);
327 void devfs_free_cdp_inode(ino_t ino);
329 typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name,
330 int namelen, struct cdev **result);
332 int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit);
333 EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
335 /* Stuff relating to kernel-dump */
336 struct kerneldumpcrypto;
337 struct kerneldumpheader;
340 dumper_t *dumper; /* Dumping function. */
341 dumper_start_t *dumper_start; /* Dumper callback for dump_start(). */
342 dumper_hdr_t *dumper_hdr; /* Dumper callback for writing headers. */
343 void *priv; /* Private parts. */
344 u_int blocksize; /* Size of block in bytes. */
345 u_int maxiosize; /* Max size allowed for an individual I/O */
346 off_t mediaoffset; /* Initial offset in bytes. */
347 off_t mediasize; /* Space available in bytes. */
349 /* MI kernel dump state. */
350 void *blockbuf; /* Buffer for padding shorter dump blocks */
351 off_t dumpoff; /* Offset of ongoing kernel dump. */
352 off_t origdumpoff; /* Starting dump offset. */
353 struct kerneldumpcrypto *kdcrypto; /* Kernel dump crypto. */
354 struct kerneldumpcomp *kdcomp; /* Kernel dump compression. */
356 TAILQ_ENTRY(dumperinfo) di_next;
361 extern int dumping; /* system is dumping */
363 int doadump(boolean_t);
364 struct diocskerneldump_arg;
365 int dumper_insert(const struct dumperinfo *di_template, const char *devname,
366 const struct diocskerneldump_arg *kda);
367 int dumper_remove(const char *devname, const struct diocskerneldump_arg *kda);
369 /* For ddb(4)-time use only. */
370 void dumper_ddb_insert(struct dumperinfo *);
371 void dumper_ddb_remove(struct dumperinfo *);
373 int dump_start(struct dumperinfo *di, struct kerneldumpheader *kdh);
374 int dump_append(struct dumperinfo *, void *, vm_offset_t, size_t);
375 int dump_write(struct dumperinfo *, void *, vm_offset_t, off_t, size_t);
376 int dump_finish(struct dumperinfo *di, struct kerneldumpheader *kdh);
377 void dump_init_header(const struct dumperinfo *di, struct kerneldumpheader *kdh,
378 const char *magic, uint32_t archver, uint64_t dumplen);
382 #endif /* !_SYS_CONF_H_ */