sys/sys/conf.h

   1 /*-
   2  * Copyright (c) 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * (c) UNIX System Laboratories, Inc.
   5  * All or some portions of this file are derived from material licensed
   6  * to the University of California by American Telephone and Telegraph
   7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
   8  * the permission of UNIX System Laboratories, Inc.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  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$
  40  */
  41
  42 #ifndef _SYS_CONF_H_
  43 #define _SYS_CONF_H_
  44
  45 #include <sys/queue.h>
  46
  47 #define SPECNAMELEN     15
  48
  49 struct tty;
  50 struct disk;
  51 struct vnode;
  52
  53 struct specinfo {
  54         u_int           si_flags;
  55 #define SI_STASHED      0x0001  /* created in stashed storage */
  56         udev_t          si_udev;
  57         LIST_ENTRY(specinfo)    si_hash;
  58         SLIST_HEAD(, vnode) si_hlist;
  59         char            si_name[SPECNAMELEN + 1];
  60         void            *si_drv1, *si_drv2;
  61         struct cdevsw   *si_devsw;
  62         void            *si_devfs;      /* save cookie for devfs operations */
  63         void            *si_bdevfs;     /* XXX block device (should go away) */
  64         int             si_iosize_max;  /* maximum I/O size (for physio &al) */
  65         union {
  66                 struct {
  67                         struct tty *__sit_tty;
  68                 } __si_tty;
  69                 struct {
  70                         struct disk *__sid_disk;
  71                         struct mount *__sid_mountpoint;
  72                         int __sid_bsize_phys; /* min physical block size */
  73                         int __sid_bsize_best; /* optimal block size */
  74                 } __si_disk;
  75         } __si_u;
  76 };
  77
  78 #define si_tty          __si_u.__si_tty.__sit_tty
  79 #define si_disk         __si_u.__si_disk.__sid_disk
  80 #define si_mountpoint   __si_u.__si_disk.__sid_mountpoint
  81 #define si_bsize_phys   __si_u.__si_disk.__sid_bsize_phys
  82 #define si_bsize_best   __si_u.__si_disk.__sid_bsize_best
  83
  84 /*
  85  * Exported shorthand
  86  */
  87 #define v_hashchain v_rdev->si_hlist
  88 #define v_specmountpoint v_rdev->si_mountpoint
  89
  90 /*
  91  * Special device management
  92  */
  93 #define SPECHSZ 64
  94 #define SPECHASH(rdev)  (((unsigned)(minor(rdev)))%SPECHSZ)
  95
  96 /*
  97  * Definitions of device driver entry switches
  98  */
  99
 100 struct buf;
 101 struct proc;
 102 struct uio;
 103
 104 typedef int d_open_t __P((dev_t dev, int oflags, int devtype, struct proc *p));
 105 typedef int d_close_t __P((dev_t dev, int fflag, int devtype, struct proc *p));
 106 typedef void d_strategy_t __P((struct buf *bp));
 107 typedef int d_parms_t __P((dev_t dev, struct specinfo *sinfo, int ctl));
 108 typedef int d_ioctl_t __P((dev_t dev, u_long cmd, caddr_t data,
 109                            int fflag, struct proc *p));
 110 typedef int d_dump_t __P((dev_t dev));
 111 typedef int d_psize_t __P((dev_t dev));
 112
 113 typedef int d_read_t __P((dev_t dev, struct uio *uio, int ioflag));
 114 typedef int d_write_t __P((dev_t dev, struct uio *uio, int ioflag));
 115 typedef int d_poll_t __P((dev_t dev, int events, struct proc *p));
 116 typedef int d_mmap_t __P((dev_t dev, vm_offset_t offset, int nprot));
 117
 118 typedef int l_open_t __P((dev_t dev, struct tty *tp));
 119 typedef int l_close_t __P((struct tty *tp, int flag));
 120 typedef int l_read_t __P((struct tty *tp, struct uio *uio, int flag));
 121 typedef int l_write_t __P((struct tty *tp, struct uio *uio, int flag));
 122 typedef int l_ioctl_t __P((struct tty *tp, u_long cmd, caddr_t data,
 123                            int flag, struct proc *p));
 124 typedef int l_rint_t __P((int c, struct tty *tp));
 125 typedef int l_start_t __P((struct tty *tp));
 126 typedef int l_modem_t __P((struct tty *tp, int flag));
 127
 128 /* This is type of the function DEVFS uses to hook into the kernel with */
 129 typedef void devfs_create_t __P((dev_t dev, uid_t uid, gid_t gid, int perms));
 130 typedef void devfs_remove_t __P((dev_t dev));
 131
 132 /*
 133  * XXX: The dummy argument can be used to do what strategy1() never
 134  * did anywhere:  Create a per device flag to lock the device during
 135  * label/slice surgery, all calls with a dummy == 0 gets stalled on
 136  * a queue somewhere, whereas dummy == 1 are let through.  Once out
 137  * of surgery, reset the flag and restart all the stuff on the stall
 138  * queue.
 139  */
 140 #define BUF_STRATEGY(bp, dummy) (*devsw((bp)->b_dev)->d_strategy)(bp)
 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
 148
 149 #define D_TYPEMASK      0xffff
 150
 151 /*
 152  * Flags for d_flags.
 153  */
 154 #define D_NOCLUSTERR    0x10000         /* disables cluter read */
 155 #define D_NOCLUSTERW    0x20000         /* disables cluster write */
 156 #define D_NOCLUSTERRW   (D_NOCLUSTERR | D_NOCLUSTERW)
 157 #define D_CANFREE       0x40000         /* can free blocks */
 158 #define D_TRACKCLOSE    0x80000         /* track all closes */
 159
 160 /*
 161  * Character device switch table
 162  */
 163 struct cdevsw {
 164         d_open_t        *d_open;
 165         d_close_t       *d_close;
 166         d_read_t        *d_read;
 167         d_write_t       *d_write;
 168         d_ioctl_t       *d_ioctl;
 169         d_poll_t        *d_poll;
 170         d_mmap_t        *d_mmap;
 171         d_strategy_t    *d_strategy;
 172         const char      *d_name;        /* base device name, e.g. 'vn' */
 173         int             d_maj;
 174         d_dump_t        *d_dump;
 175         d_psize_t       *d_psize;
 176         u_int           d_flags;
 177         int             d_bmaj;
 178 };
 179
 180 /*
 181  * Line discipline switch table
 182  */
 183 struct linesw {
 184         l_open_t        *l_open;
 185         l_close_t       *l_close;
 186         l_read_t        *l_read;
 187         l_write_t       *l_write;
 188         l_ioctl_t       *l_ioctl;
 189         l_rint_t        *l_rint;
 190         l_start_t       *l_start;
 191         l_modem_t       *l_modem;
 192         u_char          l_hotchar;
 193 };
 194
 195 #ifdef KERNEL
 196 extern struct linesw linesw[];
 197 extern int nlinesw;
 198
 199 int ldisc_register __P((int , struct linesw *));
 200 void ldisc_deregister __P((int));
 201 #define LDISC_LOAD      -1              /* Loadable line discipline */
 202 #endif
 203
 204 /*
 205  * Swap device table
 206  */
 207 struct swdevt {
 208         udev_t  sw_dev;                 /* For quasibogus swapdev reporting */
 209         int     sw_flags;
 210         int     sw_nblks;
 211         struct  vnode *sw_vp;
 212         dev_t   sw_device;
 213 };
 214 #define SW_FREED        0x01
 215 #define SW_SEQUENTIAL   0x02
 216 #define sw_freed        sw_flags        /* XXX compat */
 217
 218 #ifdef KERNEL
 219 d_open_t        noopen;
 220 d_close_t       noclose;
 221 d_read_t        noread;
 222 d_write_t       nowrite;
 223 d_ioctl_t       noioctl;
 224 d_mmap_t        nommap;
 225 #define nostrategy      ((d_strategy_t *)NULL)
 226 #define nopoll  seltrue
 227
 228 d_dump_t        nodump;
 229
 230 #define NUMCDEVSW 256
 231
 232 /*
 233  * nopsize is little used, so not worth having dummy functions for.
 234  */
 235 #define nopsize ((d_psize_t *)NULL)
 236
 237 d_open_t        nullopen;
 238 d_close_t       nullclose;
 239
 240 l_read_t        l_noread;
 241 l_write_t       l_nowrite;
 242
 243 struct module;
 244
 245 struct devsw_module_data {
 246         int     (*chainevh)(struct module *, int, void *); /* next handler */
 247         void    *chainarg;      /* arg for next event handler */
 248         struct  cdevsw *cdevsw; /* device functions */
 249         /* Do not initialize fields hereafter */
 250 };
 251
 252 #define DEV_MODULE(name, cmaj, bmaj, devsw, evh, arg)                   \
 253 static struct devsw_module_data name##_devsw_mod = {                    \
 254     evh, arg, &devsw                                                    \
 255 };                                                                      \
 256                                                                         \
 257 static moduledata_t name##_mod = {                                      \
 258     #name,                                                              \
 259     devsw_module_handler,                                               \
 260     &name##_devsw_mod                                                   \
 261 };                                                                      \
 262 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE+cmaj*256+bmaj)
 263
 264
 265 int     cdevsw_add __P((struct cdevsw *new));
 266 int     cdevsw_remove __P((struct cdevsw *old));
 267 dev_t   chrtoblk __P((dev_t dev));
 268 struct cdevsw *devsw __P((dev_t dev));
 269 int     devsw_module_handler __P((struct module *mod, int what, void *arg));
 270 const char *devtoname __P((dev_t dev));
 271 void    freedev __P((dev_t dev));
 272 int     iskmemdev __P((dev_t dev));
 273 int     iszerodev __P((dev_t dev));
 274 dev_t   makebdev __P((int maj, int min));
 275 dev_t   make_dev __P((struct cdevsw *devsw, int minor, uid_t uid, gid_t gid, int perms, char *fmt, ...)) __printflike(6, 7);
 276 int     lminor __P((dev_t dev));
 277 void    remove_dev __P((dev_t dev));
 278 void    setconf __P((void));
 279
 280 extern devfs_create_t *devfs_create_hook;
 281
 282 /*
 283  * XXX: This included for when DEVFS resurfaces
 284  */
 285
 286 #define         UID_ROOT        0
 287 #define         UID_BIN         3
 288 #define         UID_UUCP        66
 289
 290 #define         GID_WHEEL       0
 291 #define         GID_KMEM        2
 292 #define         GID_OPERATOR    5
 293 #define         GID_BIN         7
 294 #define         GID_GAMES       13
 295 #define         GID_DIALER      68
 296
 297 #endif /* KERNEL */
 298
 299 #endif /* !_SYS_CONF_H_ */