conf.h revision 330897
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 * 4. 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: stable/11/sys/sys/conf.h 330897 2018-03-14 03:19:51Z eadler $ 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_CHEAPCLONE 0x0008 /* can be removed_dev'ed when vnode reclaims */ 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 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 vm_offset_t _physical, /* Physical address of virtual. */ 132 off_t _offset, /* Byte-offset to write at. */ 133 size_t _length); /* Number of bytes to dump. */ 134 135#endif /* _KERNEL */ 136 137/* 138 * Types for d_flags. 139 */ 140#define D_TAPE 0x0001 141#define D_DISK 0x0002 142#define D_TTY 0x0004 143#define D_MEM 0x0008 /* /dev/(k)mem */ 144 145#ifdef _KERNEL 146 147#define D_TYPEMASK 0xffff 148 149/* 150 * Flags for d_flags which the drivers can set. 151 */ 152#define D_TRACKCLOSE 0x00080000 /* track all closes */ 153#define D_MMAP_ANON 0x00100000 /* special treatment in vm_mmap.c */ 154#define D_NEEDGIANT 0x00400000 /* driver want Giant */ 155#define D_NEEDMINOR 0x00800000 /* driver uses clone_create() */ 156 157/* 158 * Version numbers. 159 */ 160#define D_VERSION_00 0x20011966 161#define D_VERSION_01 0x17032005 /* Add d_uid,gid,mode & kind */ 162#define D_VERSION_02 0x28042009 /* Add d_mmap_single */ 163#define D_VERSION_03 0x17122009 /* d_mmap takes memattr,vm_ooffset_t */ 164#define D_VERSION D_VERSION_03 165 166/* 167 * Flags used for internal housekeeping 168 */ 169#define D_INIT 0x80000000 /* cdevsw initialized */ 170 171/* 172 * Character device switch table 173 */ 174struct cdevsw { 175 int d_version; 176 u_int d_flags; 177 const char *d_name; 178 d_open_t *d_open; 179 d_fdopen_t *d_fdopen; 180 d_close_t *d_close; 181 d_read_t *d_read; 182 d_write_t *d_write; 183 d_ioctl_t *d_ioctl; 184 d_poll_t *d_poll; 185 d_mmap_t *d_mmap; 186 d_strategy_t *d_strategy; 187 dumper_t *d_dump; 188 d_kqfilter_t *d_kqfilter; 189 d_purge_t *d_purge; 190 d_mmap_single_t *d_mmap_single; 191 192 int32_t d_spare0[3]; 193 void *d_spare1[3]; 194 195 /* These fields should not be messed with by drivers */ 196 LIST_HEAD(, cdev) d_devs; 197 int d_spare2; 198 union { 199 struct cdevsw *gianttrick; 200 SLIST_ENTRY(cdevsw) postfree_list; 201 } __d_giant; 202}; 203#define d_gianttrick __d_giant.gianttrick 204#define d_postfree_list __d_giant.postfree_list 205 206struct module; 207 208struct devsw_module_data { 209 int (*chainevh)(struct module *, int, void *); /* next handler */ 210 void *chainarg; /* arg for next event handler */ 211 /* Do not initialize fields hereafter */ 212}; 213 214#define DEV_MODULE_ORDERED(name, evh, arg, ord) \ 215static moduledata_t name##_mod = { \ 216 #name, \ 217 evh, \ 218 arg \ 219}; \ 220DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, ord) 221 222#define DEV_MODULE(name, evh, arg) \ 223 DEV_MODULE_ORDERED(name, evh, arg, SI_ORDER_MIDDLE) 224 225void clone_setup(struct clonedevs **cdp); 226void clone_cleanup(struct clonedevs **); 227#define CLONE_UNITMASK 0xfffff 228#define CLONE_FLAG0 (CLONE_UNITMASK + 1) 229int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, int extra); 230 231#define MAKEDEV_REF 0x01 232#define MAKEDEV_WHTOUT 0x02 233#define MAKEDEV_NOWAIT 0x04 234#define MAKEDEV_WAITOK 0x08 235#define MAKEDEV_ETERNAL 0x10 236#define MAKEDEV_CHECKNAME 0x20 237struct make_dev_args { 238 size_t mda_size; 239 int mda_flags; 240 struct cdevsw *mda_devsw; 241 struct ucred *mda_cr; 242 uid_t mda_uid; 243 gid_t mda_gid; 244 int mda_mode; 245 int mda_unit; 246 void *mda_si_drv1; 247 void *mda_si_drv2; 248}; 249void make_dev_args_init_impl(struct make_dev_args *_args, size_t _sz); 250#define make_dev_args_init(a) \ 251 make_dev_args_init_impl((a), sizeof(struct make_dev_args)) 252 253int count_dev(struct cdev *_dev); 254void delist_dev(struct cdev *_dev); 255void destroy_dev(struct cdev *_dev); 256int destroy_dev_sched(struct cdev *dev); 257int destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg); 258void destroy_dev_drain(struct cdevsw *csw); 259void drain_dev_clone_events(void); 260struct cdevsw *dev_refthread(struct cdev *_dev, int *_ref); 261struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp, int *_ref); 262void dev_relthread(struct cdev *_dev, int _ref); 263void dev_depends(struct cdev *_pdev, struct cdev *_cdev); 264void dev_ref(struct cdev *dev); 265void dev_refl(struct cdev *dev); 266void dev_rel(struct cdev *dev); 267struct cdev *make_dev(struct cdevsw *_devsw, int _unit, uid_t _uid, gid_t _gid, 268 int _perms, const char *_fmt, ...) __printflike(6, 7); 269struct cdev *make_dev_cred(struct cdevsw *_devsw, int _unit, 270 struct ucred *_cr, uid_t _uid, gid_t _gid, int _perms, 271 const char *_fmt, ...) __printflike(7, 8); 272struct cdev *make_dev_credf(int _flags, 273 struct cdevsw *_devsw, int _unit, 274 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode, 275 const char *_fmt, ...) __printflike(8, 9); 276int make_dev_p(int _flags, struct cdev **_cdev, struct cdevsw *_devsw, 277 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode, 278 const char *_fmt, ...) __printflike(8, 9); 279int make_dev_s(struct make_dev_args *_args, struct cdev **_cdev, 280 const char *_fmt, ...) __printflike(3, 4); 281struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...) 282 __printflike(2, 3); 283int make_dev_alias_p(int _flags, struct cdev **_cdev, struct cdev *_pdev, 284 const char *_fmt, ...) __printflike(4, 5); 285int make_dev_physpath_alias(int _flags, struct cdev **_cdev, 286 struct cdev *_pdev, struct cdev *_old_alias, 287 const char *_physpath); 288void dev_lock(void); 289void dev_unlock(void); 290 291#ifdef KLD_MODULE 292#define MAKEDEV_ETERNAL_KLD 0 293#else 294#define MAKEDEV_ETERNAL_KLD MAKEDEV_ETERNAL 295#endif 296 297#define dev2unit(d) ((d)->si_drv0) 298 299typedef void d_priv_dtor_t(void *data); 300int devfs_get_cdevpriv(void **datap); 301int devfs_set_cdevpriv(void *priv, d_priv_dtor_t *dtr); 302void devfs_clear_cdevpriv(void); 303 304ino_t devfs_alloc_cdp_inode(void); 305void devfs_free_cdp_inode(ino_t ino); 306 307#define UID_ROOT 0 308#define UID_BIN 3 309#define UID_UUCP 66 310#define UID_NOBODY 65534 311 312#define GID_WHEEL 0 313#define GID_KMEM 2 314#define GID_TTY 4 315#define GID_OPERATOR 5 316#define GID_BIN 7 317#define GID_GAMES 13 318#define GID_VIDEO 44 319#define GID_DIALER 68 320#define GID_NOGROUP 65533 321#define GID_NOBODY 65534 322 323typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name, 324 int namelen, struct cdev **result); 325 326int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit); 327EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn); 328 329/* Stuff relating to kernel-dump */ 330 331struct dumperinfo { 332 dumper_t *dumper; /* Dumping function. */ 333 void *priv; /* Private parts. */ 334 u_int blocksize; /* Size of block in bytes. */ 335 u_int maxiosize; /* Max size allowed for an individual I/O */ 336 off_t mediaoffset; /* Initial offset in bytes. */ 337 off_t mediasize; /* Space available in bytes. */ 338 void *blockbuf; /* Buffer for padding shorter dump blocks */ 339}; 340 341int set_dumper(struct dumperinfo *, const char *_devname, struct thread *td); 342int dump_write(struct dumperinfo *, void *, vm_offset_t, off_t, size_t); 343int dump_write_pad(struct dumperinfo *, void *, vm_offset_t, off_t, size_t, 344 size_t *); 345int doadump(boolean_t); 346extern int dumping; /* system is dumping */ 347 348#endif /* _KERNEL */ 349 350#endif /* !_SYS_CONF_H_ */ 351