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 * @(#)conf.h 8.5 (Berkeley) 1/9/95 39 * $FreeBSD$ 40 */ 41 42 #ifndef _SYS_CONF_H_ 43 #define _SYS_CONF_H_ 44 45 #ifdef _KERNEL 46 #include <sys/_eventhandler.h> 47 #else 48 #include <sys/queue.h> 49 #endif 50 51 struct snapdata; 52 struct devfs_dirent; 53 struct cdevsw; 54 struct file; 55 56 struct cdev { 57 void *si_spare0; 58 u_int si_flags; 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; 71 uid_t si_uid; 72 gid_t si_gid; 73 mode_t si_mode; 74 struct ucred *si_cred; /* cached clone-time credential */ 75 int si_drv0; 76 int si_refcount; 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) */ 86 u_long si_usecount; 87 u_long si_threadcount; 88 union { 89 struct snapdata *__sid_snapdata; 90 } __si_u; 91 char si_name[SPECNAMELEN + 1]; 92 }; 93 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 dumperinfo; 105 struct kerneldumpheader; 106 struct thread; 107 struct uio; 108 struct knote; 109 struct clonedevs; 110 struct vm_object; 111 struct vnode; 112 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); 119 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); 129 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, void *key, uint32_t keysize); 137 typedef int dumper_hdr_t(struct dumperinfo *di, struct kerneldumpheader *kdh); 138 139 #endif /* _KERNEL */ 140 141 /* 142 * Types for d_flags. 143 */ 144 #define D_TAPE 0x0001 145 #define D_DISK 0x0002 146 #define D_TTY 0x0004 147 #define D_MEM 0x0008 /* /dev/(k)mem */ 148 149 /* Defined uid and gid values. */ 150 #define UID_ROOT 0 151 #define UID_BIN 3 152 #define UID_UUCP 66 153 #define UID_NOBODY 65534 154 155 #define GID_WHEEL 0 156 #define GID_KMEM 2 157 #define GID_TTY 4 158 #define GID_OPERATOR 5 159 #define GID_BIN 7 160 #define GID_GAMES 13 161 #define GID_VIDEO 44 162 #define GID_RT_PRIO 47 163 #define GID_ID_PRIO 48 164 #define GID_DIALER 68 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 181 /* 182 * Version numbers. 183 */ 184 #define D_VERSION_00 0x20011966 185 #define D_VERSION_01 0x17032005 /* Add d_uid,gid,mode & kind */ 186 #define D_VERSION_02 0x28042009 /* Add d_mmap_single */ 187 #define D_VERSION_03 0x17122009 /* d_mmap takes memattr,vm_ooffset_t */ 188 #define D_VERSION_04 0x5c48c353 /* SPECNAMELEN bumped to MAXNAMLEN */ 189 #define D_VERSION D_VERSION_04 190 191 /* 192 * Flags used for internal housekeeping 193 */ 194 #define D_INIT 0x80000000 /* cdevsw initialized */ 195 196 /* 197 * Character device switch table 198 */ 199 struct cdevsw { 200 int d_version; 201 u_int d_flags; 202 const char *d_name; 203 d_open_t *d_open; 204 d_fdopen_t *d_fdopen; 205 d_close_t *d_close; 206 d_read_t *d_read; 207 d_write_t *d_write; 208 d_ioctl_t *d_ioctl; 209 d_poll_t *d_poll; 210 d_mmap_t *d_mmap; 211 d_strategy_t *d_strategy; 212 dumper_t *d_dump; 213 d_kqfilter_t *d_kqfilter; 214 d_purge_t *d_purge; 215 d_mmap_single_t *d_mmap_single; 216 217 int32_t d_spare0[3]; 218 void *d_spare1[3]; 219 220 /* These fields should not be messed with by drivers */ 221 LIST_HEAD(, cdev) d_devs; 222 int d_spare2; 223 union { 224 struct cdevsw *gianttrick; 225 SLIST_ENTRY(cdevsw) postfree_list; 226 } __d_giant; 227 }; 228 #define d_gianttrick __d_giant.gianttrick 229 #define d_postfree_list __d_giant.postfree_list 230 231 struct module; 232 233 struct devsw_module_data { 234 int (*chainevh)(struct module *, int, void *); /* next handler */ 235 void *chainarg; /* arg for next event handler */ 236 /* Do not initialize fields hereafter */ 237 }; 238 239 #define DEV_MODULE_ORDERED(name, evh, arg, ord) \ 240 static moduledata_t name##_mod = { \ 241 #name, \ 242 evh, \ 243 arg \ 244 }; \ 245 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, ord) 246 247 #define DEV_MODULE(name, evh, arg) \ 248 DEV_MODULE_ORDERED(name, evh, arg, SI_ORDER_MIDDLE) 249 250 void clone_setup(struct clonedevs **cdp); 251 void clone_cleanup(struct clonedevs **); 252 #define CLONE_UNITMASK 0xfffff 253 #define CLONE_FLAG0 (CLONE_UNITMASK + 1) 254 int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, int extra); 255 256 #define MAKEDEV_REF 0x01 257 #define MAKEDEV_WHTOUT 0x02 258 #define MAKEDEV_NOWAIT 0x04 259 #define MAKEDEV_WAITOK 0x08 260 #define MAKEDEV_ETERNAL 0x10 261 #define MAKEDEV_CHECKNAME 0x20 262 struct make_dev_args { 263 size_t mda_size; 264 int mda_flags; 265 struct cdevsw *mda_devsw; 266 struct ucred *mda_cr; 267 uid_t mda_uid; 268 gid_t mda_gid; 269 int mda_mode; 270 int mda_unit; 271 void *mda_si_drv1; 272 void *mda_si_drv2; 273 }; 274 void make_dev_args_init_impl(struct make_dev_args *_args, size_t _sz); 275 #define make_dev_args_init(a) \ 276 make_dev_args_init_impl((a), sizeof(struct make_dev_args)) 277 278 void delist_dev(struct cdev *_dev); 279 void destroy_dev(struct cdev *_dev); 280 int destroy_dev_sched(struct cdev *dev); 281 int destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg); 282 void destroy_dev_drain(struct cdevsw *csw); 283 void drain_dev_clone_events(void); 284 struct cdevsw *dev_refthread(struct cdev *_dev, int *_ref); 285 struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp, int *_ref); 286 void dev_relthread(struct cdev *_dev, int _ref); 287 void dev_depends(struct cdev *_pdev, struct cdev *_cdev); 288 void dev_ref(struct cdev *dev); 289 void dev_refl(struct cdev *dev); 290 void dev_rel(struct cdev *dev); 291 struct cdev *make_dev(struct cdevsw *_devsw, int _unit, uid_t _uid, gid_t _gid, 292 int _perms, const char *_fmt, ...) __printflike(6, 7); 293 struct cdev *make_dev_cred(struct cdevsw *_devsw, int _unit, 294 struct ucred *_cr, uid_t _uid, gid_t _gid, int _perms, 295 const char *_fmt, ...) __printflike(7, 8); 296 struct cdev *make_dev_credf(int _flags, 297 struct cdevsw *_devsw, int _unit, 298 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode, 299 const char *_fmt, ...) __printflike(8, 9); 300 int make_dev_p(int _flags, struct cdev **_cdev, struct cdevsw *_devsw, 301 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode, 302 const char *_fmt, ...) __printflike(8, 9); 303 int make_dev_s(struct make_dev_args *_args, struct cdev **_cdev, 304 const char *_fmt, ...) __printflike(3, 4); 305 struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...) 306 __printflike(2, 3); 307 int make_dev_alias_p(int _flags, struct cdev **_cdev, struct cdev *_pdev, 308 const char *_fmt, ...) __printflike(4, 5); 309 int make_dev_physpath_alias(int _flags, struct cdev **_cdev, 310 struct cdev *_pdev, struct cdev *_old_alias, 311 const char *_physpath); 312 void dev_lock(void); 313 void dev_unlock(void); 314 315 #ifdef KLD_MODULE 316 #define MAKEDEV_ETERNAL_KLD 0 317 #else 318 #define MAKEDEV_ETERNAL_KLD MAKEDEV_ETERNAL 319 #endif 320 321 #define dev2unit(d) ((d)->si_drv0) 322 323 typedef void d_priv_dtor_t(void *data); 324 int devfs_get_cdevpriv(void **datap); 325 int devfs_set_cdevpriv(void *priv, d_priv_dtor_t *dtr); 326 void devfs_clear_cdevpriv(void); 327 328 ino_t devfs_alloc_cdp_inode(void); 329 void devfs_free_cdp_inode(ino_t ino); 330 331 typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name, 332 int namelen, struct cdev **result); 333 334 int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit); 335 EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn); 336 337 /* Stuff relating to kernel-dump */ 338 struct kerneldumpcrypto; 339 struct kerneldumpheader; 340 341 struct 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 363 extern int dumping; /* system is dumping */ 364 365 void dump_savectx(void); 366 int doadump(boolean_t); 367 struct diocskerneldump_arg; 368 int dumper_create(const struct dumperinfo *di_template, const char *devname, 369 const struct diocskerneldump_arg *kda, struct dumperinfo **dip); 370 void dumper_destroy(struct dumperinfo *di); 371 int dumper_insert(const struct dumperinfo *di_template, const char *devname, 372 const struct diocskerneldump_arg *kda); 373 int dumper_remove(const char *devname, const struct diocskerneldump_arg *kda); 374 375 /* For ddb(4)-time use only. */ 376 void dumper_ddb_insert(struct dumperinfo *); 377 void dumper_ddb_remove(struct dumperinfo *); 378 379 int dump_start(struct dumperinfo *di, struct kerneldumpheader *kdh); 380 int dump_append(struct dumperinfo *, void *, vm_offset_t, size_t); 381 int dump_write(struct dumperinfo *, void *, vm_offset_t, off_t, size_t); 382 int dump_finish(struct dumperinfo *di, struct kerneldumpheader *kdh); 383 void dump_init_header(const struct dumperinfo *di, struct kerneldumpheader *kdh, 384 const char *magic, uint32_t archver, uint64_t dumplen); 385 386 #endif /* _KERNEL */ 387 388 #endif /* !_SYS_CONF_H_ */ 389