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 51struct snapdata; 52struct devfs_dirent; 53struct cdevsw; 54struct file; 55 56struct 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 102struct bio; 103struct buf; 104struct dumperinfo; 105struct kerneldumpheader; 106struct thread; 107struct uio; 108struct knote; 109struct clonedevs; 110struct vm_object; 111struct vnode; 112 113typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td); 114typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, struct file *fp); 115typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td); 116typedef void d_strategy_t(struct bio *bp); 117typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data, 118 int fflag, struct thread *td); 119 120typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag); 121typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag); 122typedef int d_poll_t(struct cdev *dev, int events, struct thread *td); 123typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn); 124typedef int d_mmap_t(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr, 125 int nprot, vm_memattr_t *memattr); 126typedef int d_mmap_single_t(struct cdev *cdev, vm_ooffset_t *offset, 127 vm_size_t size, struct vm_object **object, int nprot); 128typedef void d_purge_t(struct cdev *dev); 129 130typedef 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. */ 136typedef int dumper_start_t(struct dumperinfo *di); 137typedef int dumper_hdr_t(struct dumperinfo *di, struct kerneldumpheader *kdh, 138 void *key, uint32_t keylen); 139 140#endif /* _KERNEL */ 141 142/* 143 * Types for d_flags. 144 */ 145#define D_TAPE 0x0001 146#define D_DISK 0x0002 147#define D_TTY 0x0004 148#define D_MEM 0x0008 /* /dev/(k)mem */ 149 150#ifdef _KERNEL 151 152#define D_TYPEMASK 0xffff 153 154/* 155 * Flags for d_flags which the drivers can set. 156 */ 157#define D_TRACKCLOSE 0x00080000 /* track all closes */ 158#define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */ 159#define D_NEEDGIANT 0x00400000 /* driver want Giant */ 160#define D_NEEDMINOR 0x00800000 /* driver uses clone_create() */ 161 162/* 163 * Version numbers. 164 */ 165#define D_VERSION_00 0x20011966 166#define D_VERSION_01 0x17032005 /* Add d_uid,gid,mode & kind */ 167#define D_VERSION_02 0x28042009 /* Add d_mmap_single */ 168#define D_VERSION_03 0x17122009 /* d_mmap takes memattr,vm_ooffset_t */ 169#define D_VERSION D_VERSION_03 170 171/* 172 * Flags used for internal housekeeping 173 */ 174#define D_INIT 0x80000000 /* cdevsw initialized */ 175 176/* 177 * Character device switch table 178 */ 179struct cdevsw { 180 int d_version; 181 u_int d_flags; 182 const char *d_name; 183 d_open_t *d_open; 184 d_fdopen_t *d_fdopen; 185 d_close_t *d_close; 186 d_read_t *d_read; 187 d_write_t *d_write; 188 d_ioctl_t *d_ioctl; 189 d_poll_t *d_poll; 190 d_mmap_t *d_mmap; 191 d_strategy_t *d_strategy; 192 dumper_t *d_dump; 193 d_kqfilter_t *d_kqfilter; 194 d_purge_t *d_purge; 195 d_mmap_single_t *d_mmap_single; 196 197 int32_t d_spare0[3]; 198 void *d_spare1[3]; 199 200 /* These fields should not be messed with by drivers */ 201 LIST_HEAD(, cdev) d_devs; 202 int d_spare2; 203 union { 204 struct cdevsw *gianttrick; 205 SLIST_ENTRY(cdevsw) postfree_list; 206 } __d_giant; 207}; 208#define d_gianttrick __d_giant.gianttrick 209#define d_postfree_list __d_giant.postfree_list 210 211struct module; 212 213struct devsw_module_data { 214 int (*chainevh)(struct module *, int, void *); /* next handler */ 215 void *chainarg; /* arg for next event handler */ 216 /* Do not initialize fields hereafter */ 217}; 218 219#define DEV_MODULE_ORDERED(name, evh, arg, ord) \ 220static moduledata_t name##_mod = { \ 221 #name, \ 222 evh, \ 223 arg \ 224}; \ 225DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, ord) 226 227#define DEV_MODULE(name, evh, arg) \ 228 DEV_MODULE_ORDERED(name, evh, arg, SI_ORDER_MIDDLE) 229 230void clone_setup(struct clonedevs **cdp); 231void clone_cleanup(struct clonedevs **); 232#define CLONE_UNITMASK 0xfffff 233#define CLONE_FLAG0 (CLONE_UNITMASK + 1) 234int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, int extra); 235 236#define MAKEDEV_REF 0x01 237#define MAKEDEV_WHTOUT 0x02 238#define MAKEDEV_NOWAIT 0x04 239#define MAKEDEV_WAITOK 0x08 240#define MAKEDEV_ETERNAL 0x10 241#define MAKEDEV_CHECKNAME 0x20 242struct make_dev_args { 243 size_t mda_size; 244 int mda_flags; 245 struct cdevsw *mda_devsw; 246 struct ucred *mda_cr; 247 uid_t mda_uid; 248 gid_t mda_gid; 249 int mda_mode; 250 int mda_unit; 251 void *mda_si_drv1; 252 void *mda_si_drv2; 253}; 254void make_dev_args_init_impl(struct make_dev_args *_args, size_t _sz); 255#define make_dev_args_init(a) \ 256 make_dev_args_init_impl((a), sizeof(struct make_dev_args)) 257 258int count_dev(struct cdev *_dev); 259void delist_dev(struct cdev *_dev); 260void destroy_dev(struct cdev *_dev); 261int destroy_dev_sched(struct cdev *dev); 262int destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg); 263void destroy_dev_drain(struct cdevsw *csw); 264void drain_dev_clone_events(void); 265struct cdevsw *dev_refthread(struct cdev *_dev, int *_ref); 266struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp, int *_ref); 267void dev_relthread(struct cdev *_dev, int _ref); 268void dev_depends(struct cdev *_pdev, struct cdev *_cdev); 269void dev_ref(struct cdev *dev); 270void dev_refl(struct cdev *dev); 271void dev_rel(struct cdev *dev); 272struct cdev *make_dev(struct cdevsw *_devsw, int _unit, uid_t _uid, gid_t _gid, 273 int _perms, const char *_fmt, ...) __printflike(6, 7); 274struct cdev *make_dev_cred(struct cdevsw *_devsw, int _unit, 275 struct ucred *_cr, uid_t _uid, gid_t _gid, int _perms, 276 const char *_fmt, ...) __printflike(7, 8); 277struct cdev *make_dev_credf(int _flags, 278 struct cdevsw *_devsw, int _unit, 279 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode, 280 const char *_fmt, ...) __printflike(8, 9); 281int make_dev_p(int _flags, struct cdev **_cdev, struct cdevsw *_devsw, 282 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode, 283 const char *_fmt, ...) __printflike(8, 9); 284int make_dev_s(struct make_dev_args *_args, struct cdev **_cdev, 285 const char *_fmt, ...) __printflike(3, 4); 286struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...) 287 __printflike(2, 3); 288int make_dev_alias_p(int _flags, struct cdev **_cdev, struct cdev *_pdev, 289 const char *_fmt, ...) __printflike(4, 5); 290int make_dev_physpath_alias(int _flags, struct cdev **_cdev, 291 struct cdev *_pdev, struct cdev *_old_alias, 292 const char *_physpath); 293void dev_lock(void); 294void dev_unlock(void); 295 296#ifdef KLD_MODULE 297#define MAKEDEV_ETERNAL_KLD 0 298#else 299#define MAKEDEV_ETERNAL_KLD MAKEDEV_ETERNAL 300#endif 301 302#define dev2unit(d) ((d)->si_drv0) 303 304typedef void d_priv_dtor_t(void *data); 305int devfs_get_cdevpriv(void **datap); 306int devfs_set_cdevpriv(void *priv, d_priv_dtor_t *dtr); 307void devfs_clear_cdevpriv(void); 308 309ino_t devfs_alloc_cdp_inode(void); 310void devfs_free_cdp_inode(ino_t ino); 311 312#define UID_ROOT 0 313#define UID_BIN 3 314#define UID_UUCP 66 315#define UID_NOBODY 65534 316 317#define GID_WHEEL 0 318#define GID_KMEM 2 319#define GID_TTY 4 320#define GID_OPERATOR 5 321#define GID_BIN 7 322#define GID_GAMES 13 323#define GID_VIDEO 44 324#define GID_DIALER 68 325#define GID_NOGROUP 65533 326#define GID_NOBODY 65534 327 328typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name, 329 int namelen, struct cdev **result); 330 331int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit); 332EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn); 333 334/* Stuff relating to kernel-dump */ 335struct kerneldumpcrypto; 336struct kerneldumpheader; 337 338struct dumperinfo { 339 dumper_t *dumper; /* Dumping function. */ 340 dumper_start_t *dumper_start; /* Dumper callback for dump_start(). */ 341 dumper_hdr_t *dumper_hdr; /* Dumper callback for writing headers. */ 342 void *priv; /* Private parts. */ 343 u_int blocksize; /* Size of block in bytes. */ 344 u_int maxiosize; /* Max size allowed for an individual I/O */ 345 off_t mediaoffset; /* Initial offset in bytes. */ 346 off_t mediasize; /* Space available in bytes. */ 347 348 /* MI kernel dump state. */ 349 void *blockbuf; /* Buffer for padding shorter dump blocks */ 350 off_t dumpoff; /* Offset of ongoing kernel dump. */ 351 off_t origdumpoff; /* Starting dump offset. */ 352 struct kerneldumpcrypto *kdcrypto; /* Kernel dump crypto. */ 353 struct kerneldumpcomp *kdcomp; /* Kernel dump compression. */ 354}; 355 356extern int dumping; /* system is dumping */ 357 358int doadump(boolean_t); 359int set_dumper(struct dumperinfo *di, const char *devname, struct thread *td, 360 uint8_t compression, uint8_t encryption, const uint8_t *key, 361 uint32_t encryptedkeysize, const uint8_t *encryptedkey); 362int clear_dumper(struct thread *td); 363 364int dump_start(struct dumperinfo *di, struct kerneldumpheader *kdh); 365int dump_append(struct dumperinfo *, void *, vm_offset_t, size_t); 366int dump_write(struct dumperinfo *, void *, vm_offset_t, off_t, size_t); 367int dump_finish(struct dumperinfo *di, struct kerneldumpheader *kdh); 368void dump_init_header(const struct dumperinfo *di, struct kerneldumpheader *kdh, 369 char *magic, uint32_t archver, uint64_t dumplen); 370 371#endif /* _KERNEL */ 372 373#endif /* !_SYS_CONF_H_ */ 374