1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1990, 1993
5 * The Regents of the University of California. All rights reserved.
6 * Copyright (c) 2000
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.
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
16 * are met:
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.
25 *
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
36 * SUCH DAMAGE.
37 */
38
39#ifndef _SYS_CONF_H_
40#define _SYS_CONF_H_
41
42#ifdef _KERNEL
43#include <sys/_eventhandler.h>
44#else
45#include <sys/queue.h>
46#endif
47#include <sys/_timespec.h>
48
49struct snapdata;
50struct devfs_dirent;
51struct cdevsw;
52struct file;
53
54struct cdev {
55 void *si_spare0;
56 u_int si_flags;
57#define SI_ETERNAL 0x0001 /* never destroyed */
58#define SI_ALIAS 0x0002 /* carrier of alias name */
59#define SI_NAMED 0x0004 /* make_dev{_alias} has been called */
60#define SI_UNUSED1 0x0008 /* unused */
61#define SI_CHILD 0x0010 /* child of another struct cdev **/
62#define SI_DUMPDEV 0x0080 /* is kernel dumpdev */
63#define SI_CLONELIST 0x0200 /* on a clone list */
64#define SI_UNMAPPED 0x0400 /* can handle unmapped I/O */
65#define SI_NOSPLIT 0x0800 /* I/O should not be split up */
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 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 struct mount *si_mountpt;
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 snapdata *__sid_snapdata;
88 } __si_u;
89 char si_name[SPECNAMELEN + 1];
90};
91
92#define si_snapdata __si_u.__sid_snapdata
93
94#ifdef _KERNEL
95
96/*
97 * Definitions of device driver entry switches
98 */
99
100struct bio;
101struct buf;
102struct dumperinfo;
103struct kerneldumpheader;
104struct thread;
105struct uio;
106struct knote;
107struct clonedevs;
108struct vm_object;
109struct vnode;
110
111typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td);
112typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, struct file *fp);
113typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td);
114typedef void d_strategy_t(struct bio *bp);
115typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data,
116 int fflag, struct thread *td);
117
118typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag);
119typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag);
120typedef int d_poll_t(struct cdev *dev, int events, struct thread *td);
121typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn);
122typedef int d_mmap_t(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
123 int nprot, vm_memattr_t *memattr);
124typedef int d_mmap_single_t(struct cdev *cdev, vm_ooffset_t *offset,
125 vm_size_t size, struct vm_object **object, int nprot);
126typedef void d_purge_t(struct cdev *dev);
127
128typedef int dumper_t(
129 void *_priv, /* Private to the driver. */
130 void *_virtual, /* Virtual (mapped) address. */
131 off_t _offset, /* Byte-offset to write at. */
132 size_t _length); /* Number of bytes to dump. */
133typedef int dumper_start_t(struct dumperinfo *di, void *key, uint32_t keysize);
134typedef int dumper_hdr_t(struct dumperinfo *di, struct kerneldumpheader *kdh);
135
136#endif /* _KERNEL */
137
138/*
139 * Types for d_flags.
140 */
141#define D_TAPE 0x0001
142#define D_DISK 0x0002
143#define D_TTY 0x0004
144#define D_MEM 0x0008 /* /dev/(k)mem */
145
146/* Defined uid and gid values. */
147#define UID_ROOT 0
148#define UID_BIN 3
149#define UID_UUCP 66
150#define UID_NOBODY 65534
151
152#define GID_WHEEL 0
153#define GID_KMEM 2
154#define GID_TTY 4
155#define GID_OPERATOR 5
156#define GID_BIN 7
157#define GID_GAMES 13
158#define GID_VIDEO 44
159#define GID_RT_PRIO 47
160#define GID_ID_PRIO 48
161#define GID_DIALER 68
162#define GID_U2F 116
163#define GID_NOGROUP 65533
164#define GID_NOBODY 65534
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_GIANTOK 0x00200000 /* suppress warning about using Giant */
176#define D_NEEDGIANT 0x00400000 /* driver want Giant */
177#define D_NEEDMINOR 0x00800000 /* driver uses clone_create() */
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_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
188
189/*
190 * Flags used for internal housekeeping
191 */
192#define D_INIT 0x80000000 /* cdevsw initialized */
193
194/*
195 * Character device switch table
196 */
197struct cdevsw {
198 int d_version;
199 u_int d_flags;
200 const char *d_name;
201 d_open_t *d_open;
202 d_fdopen_t *d_fdopen;
203 d_close_t *d_close;
204 d_read_t *d_read;
205 d_write_t *d_write;
206 d_ioctl_t *d_ioctl;
207 d_poll_t *d_poll;
208 d_mmap_t *d_mmap;
209 d_strategy_t *d_strategy;
210 void *d_spare0;
211 d_kqfilter_t *d_kqfilter;
212 d_purge_t *d_purge;
213 d_mmap_single_t *d_mmap_single;
214
215 int32_t d_spare1[3];
216 void *d_spare2[3];
217
218 /* These fields should not be messed with by drivers */
219 LIST_HEAD(, cdev) d_devs;
220 int d_spare3;
221 union {
222 struct cdevsw *gianttrick;
223 SLIST_ENTRY(cdevsw) postfree_list;
224 } __d_giant;
225};
226#define d_gianttrick __d_giant.gianttrick
227#define d_postfree_list __d_giant.postfree_list
228
229struct module;
230
231struct 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 */
235};
236
237#define DEV_MODULE_ORDERED(name, evh, arg, ord) \
238static moduledata_t name##_mod = { \
239 #name, \
240 evh, \
241 arg \
242}; \
243DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, ord)
244
245#define DEV_MODULE(name, evh, arg) \
246 DEV_MODULE_ORDERED(name, evh, arg, SI_ORDER_MIDDLE)
247
248void clone_setup(struct clonedevs **cdp);
249void clone_cleanup(struct clonedevs **);
250#define CLONE_UNITMASK 0xfffff
251#define CLONE_FLAG0 (CLONE_UNITMASK + 1)
252int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, int extra);
253
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
260struct make_dev_args {
261 size_t mda_size;
262 int mda_flags;
263 struct cdevsw *mda_devsw;
264 struct ucred *mda_cr;
265 uid_t mda_uid;
266 gid_t mda_gid;
267 int mda_mode;
268 int mda_unit;
269 void *mda_si_drv1;
270 void *mda_si_drv2;
271};
272void 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))
275
276void delist_dev(struct cdev *_dev);
277void destroy_dev(struct cdev *_dev);
278int destroy_dev_sched(struct cdev *dev);
279int destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg);
280void destroy_dev_drain(struct cdevsw *csw);
281void dev_copyname(struct cdev *dev, char *path, size_t len);
282struct cdevsw *dev_refthread(struct cdev *_dev, int *_ref);
283struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp, int *_ref);
284void dev_relthread(struct cdev *_dev, int _ref);
285void dev_depends(struct cdev *_pdev, struct cdev *_cdev);
286void dev_ref(struct cdev *dev);
287void dev_refl(struct cdev *dev);
288void dev_rel(struct cdev *dev);
289struct cdev *make_dev(struct cdevsw *_devsw, int _unit, uid_t _uid, gid_t _gid,
290 int _perms, const char *_fmt, ...) __printflike(6, 7);
291struct 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);
294struct 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);
298int 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);
301int make_dev_s(struct make_dev_args *_args, struct cdev **_cdev,
302 const char *_fmt, ...) __printflike(3, 4);
303struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...)
304 __printflike(2, 3);
305int make_dev_alias_p(int _flags, struct cdev **_cdev, struct cdev *_pdev,
306 const char *_fmt, ...) __printflike(4, 5);
307int make_dev_physpath_alias(int _flags, struct cdev **_cdev,
308 struct cdev *_pdev, struct cdev *_old_alias,
309 const char *_physpath);
310void dev_lock(void);
311void dev_unlock(void);
312
313#ifdef KLD_MODULE
314#define MAKEDEV_ETERNAL_KLD 0
315#else
316#define MAKEDEV_ETERNAL_KLD MAKEDEV_ETERNAL
317#endif
318
319#define dev2unit(d) ((d)->si_drv0)
320
321typedef void d_priv_dtor_t(void *data);
322int devfs_get_cdevpriv(void **datap);
323int devfs_set_cdevpriv(void *priv, d_priv_dtor_t *dtr);
324void devfs_clear_cdevpriv(void);
325int devfs_foreach_cdevpriv(struct cdev *dev,
326 int (*cb)(void *data, void *arg), void *arg);
327
328ino_t devfs_alloc_cdp_inode(void);
329void devfs_free_cdp_inode(ino_t ino);
330
331typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name,
332 int namelen, struct cdev **result);
333
334int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit);
335EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
336
337/* Stuff relating to kernel-dump */
338struct kerneldumpcrypto;
339struct kerneldumpheader;
340
341struct dumperinfo {
342 dumper_t *dumper; /* Dumping function. */
343 dumper_start_t *dumper_start; /* Dumper callback for dump_start(). */
344 dumper_hdr_t *dumper_hdr; /* Dumper callback for writing headers. */
345 void *priv; /* Private parts. */
346 u_int blocksize; /* Size of block in bytes. */
347 u_int maxiosize; /* Max size allowed for an individual I/O */
348 off_t mediaoffset; /* Initial offset in bytes. */
349 off_t mediasize; /* Space available in bytes. */
350
351 /* MI kernel dump state. */
352 void *blockbuf; /* Buffer for padding shorter dump blocks */
353 off_t dumpoff; /* Offset of ongoing kernel dump. */
354 off_t origdumpoff; /* Starting dump offset. */
355 struct kerneldumpcrypto *kdcrypto; /* Kernel dump crypto. */
356 struct kerneldumpcomp *kdcomp; /* Kernel dump compression. */
357
358 TAILQ_ENTRY(dumperinfo) di_next;
359
360 char di_devname[];
361};
362
363extern int dumping; /* system is dumping */
364extern bool dumped_core; /* system successfully dumped kernel core */
365
366/*
367 * Save registers for later extraction from a kernel dump.
368 *
369 * This must be inlined into the caller, which in turn must be the function that
370 * calls (mini)dumpsys(). Otherwise, the saved frame pointer will reference a
371 * stack frame that may be clobbered by subsequent function calls.
372 */
373#define dump_savectx() do { \
374 extern struct pcb dumppcb; \
375 extern lwpid_t dumptid; \
376 \
377 savectx(&dumppcb); \
378 dumptid = curthread->td_tid; \
379} while (0)
380
381int doadump(boolean_t);
382struct diocskerneldump_arg;
383int dumper_create(const struct dumperinfo *di_template, const char *devname,
384 const struct diocskerneldump_arg *kda, struct dumperinfo **dip);
385void dumper_destroy(struct dumperinfo *di);
386int dumper_insert(const struct dumperinfo *di_template, const char *devname,
387 const struct diocskerneldump_arg *kda);
388int dumper_remove(const char *devname, const struct diocskerneldump_arg *kda);
389
390/* For ddb(4)-time use only. */
391void dumper_ddb_insert(struct dumperinfo *);
392void dumper_ddb_remove(struct dumperinfo *);
393
394int dump_start(struct dumperinfo *di, struct kerneldumpheader *kdh);
395int dump_append(struct dumperinfo *, void *, size_t);
396int dump_write(struct dumperinfo *, void *, off_t, size_t);
397int dump_finish(struct dumperinfo *di, struct kerneldumpheader *kdh);
398void dump_init_header(const struct dumperinfo *di, struct kerneldumpheader *kdh,
399 const char *magic, uint32_t archver, uint64_t dumplen);
400
401#endif /* _KERNEL */
402
403#endif /* !_SYS_CONF_H_ */