sys/sys/conf.h

   1 /*-
   2  * Copyright (c) 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 2000
   5  *      Poul-Henning Kamp.  All rights reserved.
   6  * (c) UNIX System Laboratories, Inc.
   7  * All or some portions of this file are derived from material licensed
   8  * to the University of California by American Telephone and Telegraph
   9  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
  10  * the permission of UNIX System Laboratories, Inc.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. All advertising materials mentioning features or use of this software
  21  *    must display the following acknowledgement:
  22  *      This product includes software developed by the University of
  23  *      California, Berkeley and its contributors.
  24  * 4. Neither the name of the University nor the names of its contributors
  25  *    may be used to endorse or promote products derived from this software
  26  *    without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  38  * SUCH DAMAGE.
  39  *
  40  *      @(#)conf.h      8.5 (Berkeley) 1/9/95
  41  * $FreeBSD$
  42  */
  43
  44 #ifndef _SYS_CONF_H_
  45 #define _SYS_CONF_H_
  46
  47 #ifdef _KERNEL
  48 #include <sys/eventhandler.h>
  49
  50 struct tty;
  51 struct disk;
  52 struct vnode;
  53 struct buf;
  54 TAILQ_HEAD(snaphead, inode);
  55
  56 struct cdev {
  57         u_int           si_flags;
  58 #define SI_STASHED      0x0001  /* created in stashed storage */
  59 #define SI_ALIAS        0x0002  /* carrier of alias name */
  60 #define SI_NAMED        0x0004  /* make_dev{_alias} has been called */
  61 #define SI_CHEAPCLONE   0x0008  /* can be removed_dev'ed when vnode reclaims */
  62 #define SI_CHILD        0x0010  /* child of another dev_t */
  63 #define SI_DEVOPEN      0x0020  /* opened by device */
  64 #define SI_CONSOPEN     0x0040  /* opened by console */
  65 #define SI_DUMPDEV      0x0080  /* is kernel dumpdev */
  66 #define SI_CANDELETE    0x0100  /* can do BIO_DELETE */
  67         struct timespec si_atime;
  68         struct timespec si_ctime;
  69         struct timespec si_mtime;
  70         udev_t          si_udev;
  71         LIST_ENTRY(cdev)        si_hash;
  72         SLIST_HEAD(, vnode)     si_hlist;
  73         LIST_HEAD(, cdev)       si_children;
  74         LIST_ENTRY(cdev)        si_siblings;
  75         dev_t           si_parent;
  76         u_int           si_inode;
  77         char            *si_name;
  78         void            *si_drv1, *si_drv2;
  79         struct cdevsw   *si_devsw;
  80         int             si_iosize_max;  /* maximum I/O size (for physio &al) */
  81         u_int           si_stripesize;
  82         u_int           si_stripeoffset;
  83         uid_t           si_uid;
  84         gid_t           si_gid;
  85         mode_t          si_mode;
  86         u_long          si_usecount;
  87         union {
  88                 struct {
  89                         struct tty *__sit_tty;
  90                 } __si_tty;
  91                 struct {
  92                         struct mount *__sid_mountpoint;
  93                         int __sid_bsize_phys; /* min physical block size */
  94                         int __sid_bsize_best; /* optimal block size */
  95                         struct snaphead __sid_snapshots;
  96                         daddr_t __sid_snaplistsize; /* size of snapblklist. */
  97                         daddr_t *__sid_snapblklist; /* known snapshot blocks. */
  98                         int (*__sid_copyonwrite)(struct vnode *, struct buf *);
  99                 } __si_disk;
 100         } __si_u;
 101         char            __si_namebuf[SPECNAMELEN + 1];
 102 };
 103
 104 #define si_tty          __si_u.__si_tty.__sit_tty
 105 #define si_mountpoint   __si_u.__si_disk.__sid_mountpoint
 106 #define si_bsize_phys   __si_u.__si_disk.__sid_bsize_phys
 107 #define si_bsize_best   __si_u.__si_disk.__sid_bsize_best
 108 #define si_snapshots    __si_u.__si_disk.__sid_snapshots
 109 #define si_snaplistsize __si_u.__si_disk.__sid_snaplistsize
 110 #define si_snapblklist  __si_u.__si_disk.__sid_snapblklist
 111 #define si_copyonwrite  __si_u.__si_disk.__sid_copyonwrite
 112
 113 /*
 114  * Special device management
 115  */
 116 #define SPECHSZ 64
 117 #define SPECHASH(rdev)  (((unsigned)(minor(rdev)))%SPECHSZ)
 118
 119 /*
 120  * Definitions of device driver entry switches
 121  */
 122
 123 struct bio;
 124 struct buf;
 125 struct thread;
 126 struct uio;
 127 struct knote;
 128
 129 /*
 130  * Note: d_thread_t is provided as a transition aid for those drivers
 131  * that treat struct proc/struct thread as an opaque data type and
 132  * exist in substantially the same form in both 4.x and 5.x.  Writers
 133  * of drivers that dips into the d_thread_t structure should use
 134  * struct thread or struct proc as appropriate for the version of the
 135  * OS they are using.  It is provided in lieu of each device driver
 136  * inventing its own way of doing this.  While it does violate style(9)
 137  * in a number of ways, this violation is deemed to be less
 138  * important than the benefits that a uniform API between releases
 139  * gives.
 140  *
 141  * Users of struct thread/struct proc that aren't device drivers should
 142  * not use d_thread_t.
 143  */
 144
 145 typedef struct thread d_thread_t;
 146
 147 typedef int d_open_t(dev_t dev, int oflags, int devtype, struct thread *td);
 148 typedef int d_close_t(dev_t dev, int fflag, int devtype, struct thread *td);
 149 typedef void d_strategy_t(struct bio *bp);
 150 typedef int d_ioctl_t(dev_t dev, u_long cmd, caddr_t data,
 151                       int fflag, struct thread *td);
 152
 153 typedef int d_read_t(dev_t dev, struct uio *uio, int ioflag);
 154 typedef int d_write_t(dev_t dev, struct uio *uio, int ioflag);
 155 typedef int d_poll_t(dev_t dev, int events, struct thread *td);
 156 typedef int d_kqfilter_t(dev_t dev, struct knote *kn);
 157 typedef int d_mmap_t(dev_t dev, vm_offset_t offset, vm_paddr_t *paddr,
 158                      int nprot);
 159
 160 typedef int l_open_t(dev_t dev, struct tty *tp);
 161 typedef int l_close_t(struct tty *tp, int flag);
 162 typedef int l_read_t(struct tty *tp, struct uio *uio, int flag);
 163 typedef int l_write_t(struct tty *tp, struct uio *uio, int flag);
 164 typedef int l_ioctl_t(struct tty *tp, u_long cmd, caddr_t data,
 165                       int flag, struct thread *td);
 166 typedef int l_rint_t(int c, struct tty *tp);
 167 typedef int l_start_t(struct tty *tp);
 168 typedef int l_modem_t(struct tty *tp, int flag);
 169
 170 typedef int dumper_t(
 171         void *priv,             /* Private to the driver. */
 172         void *virtual,          /* Virtual (mapped) address. */
 173         vm_offset_t physical,   /* Physical address of virtual. */
 174         off_t offset,           /* Byte-offset to write at. */
 175         size_t length);         /* Number of bytes to dump. */
 176
 177 #define BIO_STRATEGY(bp)                                                \
 178         do {                                                            \
 179         if ((!(bp)->bio_cmd) || ((bp)->bio_cmd & ((bp)->bio_cmd - 1)))  \
 180                 Debugger("bio_cmd botch");                              \
 181         (*devsw((bp)->bio_dev)->d_strategy)(bp);                        \
 182         } while (0)
 183
 184 #define DEV_STRATEGY(bp)                                                \
 185         do {                                                            \
 186         if ((bp)->b_flags & B_PHYS)                                     \
 187                 (bp)->b_io.bio_offset = (bp)->b_offset;                 \
 188         else                                                            \
 189                 (bp)->b_io.bio_offset = dbtob((bp)->b_blkno);           \
 190         (bp)->b_io.bio_done = bufdonebio;                               \
 191         (bp)->b_io.bio_caller2 = (bp);                                  \
 192         BIO_STRATEGY(&(bp)->b_io);                                      \
 193         } while (0)
 194
 195 #endif /* _KERNEL */
 196
 197 /*
 198  * Types for d_flags.
 199  */
 200 #define D_TAPE  0x0001
 201 #define D_DISK  0x0002
 202 #define D_TTY   0x0004
 203 #define D_MEM   0x0008
 204
 205 #ifdef _KERNEL
 206
 207 #define D_TYPEMASK      0xffff
 208
 209 /*
 210  * Flags for d_flags.
 211  */
 212 #define D_MEMDISK       0x00010000      /* memory type disk */
 213 #define D_NAGGED        0x00020000      /* nagged about missing make_dev() */
 214 #define D_TRACKCLOSE    0x00080000      /* track all closes */
 215 #define D_MMAP_ANON     0x00100000      /* special treatment in vm_mmap.c */
 216 #define D_NOGIANT       0x00400000      /* Doesn't want Giant */
 217
 218 /*
 219  * Character device switch table
 220  */
 221 struct cdevsw {
 222         int             d_maj;
 223         u_int           d_flags;
 224         const char      *d_name;
 225         d_open_t        *d_open;
 226         d_close_t       *d_close;
 227         d_read_t        *d_read;
 228         d_write_t       *d_write;
 229         d_ioctl_t       *d_ioctl;
 230         d_poll_t        *d_poll;
 231         d_mmap_t        *d_mmap;
 232         d_strategy_t    *d_strategy;
 233         dumper_t        *d_dump;
 234         d_kqfilter_t    *d_kqfilter;
 235 };
 236
 237 /*
 238  * Line discipline switch table
 239  */
 240 struct linesw {
 241         l_open_t        *l_open;
 242         l_close_t       *l_close;
 243         l_read_t        *l_read;
 244         l_write_t       *l_write;
 245         l_ioctl_t       *l_ioctl;
 246         l_rint_t        *l_rint;
 247         l_start_t       *l_start;
 248         l_modem_t       *l_modem;
 249         u_char          l_hotchar;
 250 };
 251
 252 extern struct linesw linesw[];
 253 extern int nlinesw;
 254
 255 int ldisc_register(int , struct linesw *);
 256 void ldisc_deregister(int);
 257 #define LDISC_LOAD      -1              /* Loadable line discipline */
 258 #endif /* _KERNEL */
 259
 260 #ifdef _KERNEL
 261
 262 #define NUMCDEVSW 256
 263
 264 /*
 265  * XXX: do not use MAJOR_AUTO unless you have no choice.  In general drivers
 266  * should just not initialize .d_maj and that will DTRT.
 267  */
 268 #define MAJOR_AUTO      0       /* XXX: Not GM */
 269
 270 l_ioctl_t       l_nullioctl;
 271 l_read_t        l_noread;
 272 l_write_t       l_nowrite;
 273
 274 struct module;
 275
 276 struct devsw_module_data {
 277         int     (*chainevh)(struct module *, int, void *); /* next handler */
 278         void    *chainarg;      /* arg for next event handler */
 279         /* Do not initialize fields hereafter */
 280 };
 281
 282 #define DEV_MODULE(name, evh, arg)                                      \
 283 static moduledata_t name##_mod = {                                      \
 284     #name,                                                              \
 285     evh,                                                                \
 286     arg                                                                 \
 287 };                                                                      \
 288 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
 289
 290
 291 int     count_dev(dev_t _dev);
 292 void    destroy_dev(dev_t _dev);
 293 struct cdevsw *devsw(dev_t _dev);
 294 const char *devtoname(dev_t _dev);
 295 int     dev_named(dev_t _pdev, const char *_name);
 296 void    dev_depends(dev_t _pdev, dev_t _cdev);
 297 void    freedev(dev_t _dev);
 298 dev_t   makebdev(int _maj, int _min);
 299 dev_t   make_dev(struct cdevsw *_devsw, int _minor, uid_t _uid, gid_t _gid,
 300                 int _perms, const char *_fmt, ...) __printflike(6, 7);
 301 dev_t   make_dev_alias(dev_t _pdev, const char *_fmt, ...) __printflike(2, 3);
 302 int     dev2unit(dev_t _dev);
 303 int     unit2minor(int _unit);
 304 void    setconf(void);
 305 dev_t   getdiskbyname(char *_name);
 306
 307 void devfs_create(dev_t dev);
 308 void devfs_destroy(dev_t dev);
 309
 310 #define         UID_ROOT        0
 311 #define         UID_BIN         3
 312 #define         UID_UUCP        66
 313
 314 #define         GID_WHEEL       0
 315 #define         GID_KMEM        2
 316 #define         GID_OPERATOR    5
 317 #define         GID_BIN         7
 318 #define         GID_GAMES       13
 319 #define         GID_DIALER      68
 320
 321 typedef void (*dev_clone_fn)(void *arg, char *name, int namelen, dev_t *result);
 322
 323 int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit);
 324 EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
 325
 326 /* Stuff relating to kernel-dump */
 327
 328 struct dumperinfo {
 329         dumper_t *dumper;       /* Dumping function. */
 330         void    *priv;          /* Private parts. */
 331         u_int   blocksize;      /* Size of block in bytes. */
 332         off_t   mediaoffset;    /* Initial offset in bytes. */
 333         off_t   mediasize;      /* Space available in bytes. */
 334 };
 335
 336 int set_dumper(struct dumperinfo *);
 337 void dumpsys(struct dumperinfo *);
 338 extern int dumping;             /* system is dumping */
 339
 340 #endif /* _KERNEL */
 341
 342 #endif /* !_SYS_CONF_H_ */