sys/sys/conf.h

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