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 49 struct snapdata; 50 struct devfs_dirent; 51 struct cdevsw; 52 struct file; 53 54 struct 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 100 struct bio; 101 struct buf; 102 struct dumperinfo; 103 struct kerneldumpheader; 104 struct thread; 105 struct uio; 106 struct knote; 107 struct clonedevs; 108 struct vm_object; 109 struct vnode; 110 111 typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td); 112 typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, struct file *fp); 113 typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td); 114 typedef void d_strategy_t(struct bio *bp); 115 typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data, 116 int fflag, struct thread *td); 117 118 typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag); 119 typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag); 120 typedef int d_poll_t(struct cdev *dev, int events, struct thread *td); 121 typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn); 122 typedef int d_mmap_t(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr, 123 int nprot, vm_memattr_t *memattr); 124 typedef int d_mmap_single_t(struct cdev *cdev, vm_ooffset_t *offset, 125 vm_size_t size, struct vm_object **object, int nprot); 126 typedef void d_purge_t(struct cdev *dev); 127 128 typedef 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. */ 133 typedef int dumper_start_t(struct dumperinfo *di, void *key, uint32_t keysize); 134 typedef 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_AUDIO 43 159 #define GID_VIDEO 44 160 #define GID_RT_PRIO 47 161 #define GID_ID_PRIO 48 162 #define GID_DIALER 68 163 #define GID_U2F 116 164 #define GID_VMM 978 165 #define GID_NOGROUP 65533 166 #define GID_NOBODY 65534 167 168 #ifdef _KERNEL 169 170 #define D_TYPEMASK 0xffff 171 172 /* 173 * Flags for d_flags which the drivers can set. 174 */ 175 #define D_TRACKCLOSE 0x00080000 /* track all closes */ 176 #define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */ 177 #define D_GIANTOK 0x00200000 /* suppress warning about using Giant */ 178 #define D_NEEDGIANT 0x00400000 /* driver want Giant */ 179 #define D_NEEDMINOR 0x00800000 /* driver uses clone_create() */ 180 #define D_NONPASSABLE 0x01000000 /* file is not passable with 181 SCM_RIGHTS or fork(2) */ 182 183 /* 184 * Version numbers. 185 */ 186 #define D_VERSION_00 0x20011966 187 #define D_VERSION_01 0x17032005 /* Add d_uid,gid,mode & kind */ 188 #define D_VERSION_02 0x28042009 /* Add d_mmap_single */ 189 #define D_VERSION_03 0x17122009 /* d_mmap takes memattr,vm_ooffset_t */ 190 #define D_VERSION_04 0x5c48c353 /* SPECNAMELEN bumped to MAXNAMLEN */ 191 #define D_VERSION D_VERSION_04 192 193 /* 194 * Flags used for internal housekeeping 195 */ 196 #define D_INIT 0x80000000 /* cdevsw initialized */ 197 198 /* 199 * Character device switch table 200 */ 201 struct cdevsw { 202 int d_version; 203 u_int d_flags; 204 const char *d_name; 205 d_open_t *d_open; 206 d_fdopen_t *d_fdopen; 207 d_close_t *d_close; 208 d_read_t *d_read; 209 d_write_t *d_write; 210 d_ioctl_t *d_ioctl; 211 d_poll_t *d_poll; 212 d_mmap_t *d_mmap; 213 d_strategy_t *d_strategy; 214 void *d_spare0; 215 d_kqfilter_t *d_kqfilter; 216 d_purge_t *d_purge; 217 d_mmap_single_t *d_mmap_single; 218 219 int32_t d_spare1[3]; 220 void *d_spare2[3]; 221 222 /* These fields should not be messed with by drivers */ 223 LIST_HEAD(, cdev) d_devs; 224 int d_spare3; 225 union { 226 struct cdevsw *gianttrick; 227 SLIST_ENTRY(cdevsw) postfree_list; 228 } __d_giant; 229 }; 230 #define d_gianttrick __d_giant.gianttrick 231 #define d_postfree_list __d_giant.postfree_list 232 233 struct module; 234 235 struct devsw_module_data { 236 int (*chainevh)(struct module *, int, void *); /* next handler */ 237 void *chainarg; /* arg for next event handler */ 238 /* Do not initialize fields hereafter */ 239 }; 240 241 #define DEV_MODULE_ORDERED(name, evh, arg, ord) \ 242 static moduledata_t name##_mod = { \ 243 #name, \ 244 evh, \ 245 arg \ 246 }; \ 247 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, ord) 248 249 #define DEV_MODULE(name, evh, arg) \ 250 DEV_MODULE_ORDERED(name, evh, arg, SI_ORDER_MIDDLE) 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 #define MAKEDEV_REF 0x01 259 #define MAKEDEV_WHTOUT 0x02 260 #define MAKEDEV_NOWAIT 0x04 261 #define MAKEDEV_WAITOK 0x08 262 #define MAKEDEV_ETERNAL 0x10 263 #define MAKEDEV_CHECKNAME 0x20 264 struct make_dev_args { 265 size_t mda_size; 266 int mda_flags; 267 struct cdevsw *mda_devsw; 268 struct ucred *mda_cr; 269 uid_t mda_uid; 270 gid_t mda_gid; 271 int mda_mode; 272 int mda_unit; 273 void *mda_si_drv1; 274 void *mda_si_drv2; 275 }; 276 void make_dev_args_init_impl(struct make_dev_args *_args, size_t _sz); 277 #define make_dev_args_init(a) \ 278 make_dev_args_init_impl((a), sizeof(struct make_dev_args)) 279 280 void delist_dev(struct cdev *_dev); 281 void destroy_dev(struct cdev *_dev); 282 int destroy_dev_sched(struct cdev *dev); 283 int destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg); 284 void destroy_dev_drain(struct cdevsw *csw); 285 void dev_copyname(struct cdev *dev, char *path, size_t len); 286 struct cdevsw *dev_refthread(struct cdev *_dev, int *_ref); 287 struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp, int *_ref); 288 void dev_relthread(struct cdev *_dev, int _ref); 289 void dev_depends(struct cdev *_pdev, struct cdev *_cdev); 290 void dev_ref(struct cdev *dev); 291 void dev_refl(struct cdev *dev); 292 void dev_rel(struct cdev *dev); 293 struct cdev *make_dev(struct cdevsw *_devsw, int _unit, uid_t _uid, gid_t _gid, 294 int _perms, const char *_fmt, ...) __printflike(6, 7); 295 struct cdev *make_dev_cred(struct cdevsw *_devsw, int _unit, 296 struct ucred *_cr, uid_t _uid, gid_t _gid, int _perms, 297 const char *_fmt, ...) __printflike(7, 8); 298 struct cdev *make_dev_credf(int _flags, 299 struct cdevsw *_devsw, int _unit, 300 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode, 301 const char *_fmt, ...) __printflike(8, 9); 302 int make_dev_p(int _flags, struct cdev **_cdev, struct cdevsw *_devsw, 303 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode, 304 const char *_fmt, ...) __printflike(8, 9); 305 int make_dev_s(struct make_dev_args *_args, struct cdev **_cdev, 306 const char *_fmt, ...) __printflike(3, 4); 307 struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...) 308 __printflike(2, 3); 309 int make_dev_alias_p(int _flags, struct cdev **_cdev, struct cdev *_pdev, 310 const char *_fmt, ...) __printflike(4, 5); 311 int make_dev_physpath_alias(int _flags, struct cdev **_cdev, 312 struct cdev *_pdev, struct cdev *_old_alias, 313 const char *_physpath); 314 void dev_lock(void); 315 void dev_unlock(void); 316 317 #ifdef KLD_MODULE 318 #define MAKEDEV_ETERNAL_KLD 0 319 #else 320 #define MAKEDEV_ETERNAL_KLD MAKEDEV_ETERNAL 321 #endif 322 323 #define dev2unit(d) ((d)->si_drv0) 324 325 typedef void d_priv_dtor_t(void *data); 326 int devfs_get_cdevpriv(void **datap); 327 int devfs_set_cdevpriv(void *priv, d_priv_dtor_t *dtr); 328 void devfs_clear_cdevpriv(void); 329 int devfs_foreach_cdevpriv(struct cdev *dev, 330 int (*cb)(void *data, void *arg), void *arg); 331 332 ino_t devfs_alloc_cdp_inode(void); 333 void devfs_free_cdp_inode(ino_t ino); 334 335 typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name, 336 int namelen, struct cdev **result); 337 338 int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit); 339 EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn); 340 341 /* Stuff relating to kernel-dump */ 342 struct kerneldumpcrypto; 343 struct kerneldumpheader; 344 345 struct dumperinfo { 346 dumper_t *dumper; /* Dumping function. */ 347 dumper_start_t *dumper_start; /* Dumper callback for dump_start(). */ 348 dumper_hdr_t *dumper_hdr; /* Dumper callback for writing headers. */ 349 void *priv; /* Private parts. */ 350 u_int blocksize; /* Size of block in bytes. */ 351 u_int maxiosize; /* Max size allowed for an individual I/O */ 352 off_t mediaoffset; /* Initial offset in bytes. */ 353 off_t mediasize; /* Space available in bytes. */ 354 355 /* MI kernel dump state. */ 356 void *blockbuf; /* Buffer for padding shorter dump blocks */ 357 off_t dumpoff; /* Offset of ongoing kernel dump. */ 358 off_t origdumpoff; /* Starting dump offset. */ 359 struct kerneldumpcrypto *kdcrypto; /* Kernel dump crypto. */ 360 struct kerneldumpcomp *kdcomp; /* Kernel dump compression. */ 361 362 TAILQ_ENTRY(dumperinfo) di_next; 363 364 char di_devname[]; 365 }; 366 367 extern int dumping; /* system is dumping */ 368 extern bool dumped_core; /* system successfully dumped kernel core */ 369 370 /* 371 * Save registers for later extraction from a kernel dump. 372 * 373 * This must be inlined into the caller, which in turn must be the function that 374 * calls (mini)dumpsys(). Otherwise, the saved frame pointer will reference a 375 * stack frame that may be clobbered by subsequent function calls. 376 */ 377 #define dump_savectx() do { \ 378 extern struct pcb dumppcb; \ 379 extern lwpid_t dumptid; \ 380 \ 381 savectx(&dumppcb); \ 382 dumptid = curthread->td_tid; \ 383 } while (0) 384 385 int doadump(boolean_t); 386 struct diocskerneldump_arg; 387 int dumper_create(const struct dumperinfo *di_template, const char *devname, 388 const struct diocskerneldump_arg *kda, struct dumperinfo **dip); 389 void dumper_destroy(struct dumperinfo *di); 390 int dumper_insert(const struct dumperinfo *di_template, const char *devname, 391 const struct diocskerneldump_arg *kda); 392 int dumper_remove(const char *devname, const struct diocskerneldump_arg *kda); 393 394 /* For ddb(4)-time use only. */ 395 void dumper_ddb_insert(struct dumperinfo *); 396 void dumper_ddb_remove(struct dumperinfo *); 397 398 int dump_start(struct dumperinfo *di, struct kerneldumpheader *kdh); 399 int dump_append(struct dumperinfo *, void *, size_t); 400 int dump_write(struct dumperinfo *, void *, off_t, size_t); 401 int dump_finish(struct dumperinfo *di, struct kerneldumpheader *kdh); 402 void dump_init_header(const struct dumperinfo *di, struct kerneldumpheader *kdh, 403 const char *magic, uint32_t archver, uint64_t dumplen); 404 405 #endif /* _KERNEL */ 406 407 #endif /* !_SYS_CONF_H_ */ 408