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: src/sys/sys/conf.h,v 1.103.2.6 2002/03/11 01:14:55 dd Exp $
  40  * $DragonFly: src/sys/sys/conf.h,v 1.3 2003/06/23 17:55:50 dillon Exp $
  41  */
  42
  43 #ifndef _SYS_CONF_H_
  44 #define _SYS_CONF_H_
  45
  46 #include <sys/queue.h>
  47
  48 #define SPECNAMELEN     15
  49
  50 struct tty;
  51 struct disk;
  52 struct vnode;
  53
  54 struct specinfo {
  55         u_int           si_flags;
  56 #define SI_STASHED      0x0001  /* created in stashed storage */
  57         udev_t          si_udev;
  58         LIST_ENTRY(specinfo)    si_hash;
  59         SLIST_HEAD(, vnode) si_hlist;
  60         char            si_name[SPECNAMELEN + 1];
  61         void            *si_drv1, *si_drv2;
  62         struct cdevsw   *si_devsw;
  63         int             si_iosize_max;  /* maximum I/O size (for physio &al) */
  64         union {
  65                 struct {
  66                         struct tty *__sit_tty;
  67                 } __si_tty;
  68                 struct {
  69                         struct disk *__sid_disk;
  70                         struct mount *__sid_mountpoint;
  71                         int __sid_bsize_phys; /* min physical block size */
  72                         int __sid_bsize_best; /* optimal block size */
  73                 } __si_disk;
  74         } __si_u;
  75 };
  76
  77 #define si_tty          __si_u.__si_tty.__sit_tty
  78 #define si_disk         __si_u.__si_disk.__sid_disk
  79 #define si_mountpoint   __si_u.__si_disk.__sid_mountpoint
  80 #define si_bsize_phys   __si_u.__si_disk.__sid_bsize_phys
  81 #define si_bsize_best   __si_u.__si_disk.__sid_bsize_best
  82
  83 /*
  84  * Exported shorthand
  85  */
  86 #define v_hashchain v_rdev->si_hlist
  87 #define v_specmountpoint v_rdev->si_mountpoint
  88
  89 /*
  90  * Special device management
  91  */
  92 #define SPECHSZ 64
  93 #define SPECHASH(rdev)  (((unsigned)(minor(rdev)))%SPECHSZ)
  94
  95 /*
  96  * Definitions of device driver entry switches
  97  */
  98
  99 struct buf;
 100 struct proc;
 101 struct uio;
 102 struct knote;
 103
 104 /*
 105  * Note: d_thread_t is provided as a transition aid for those drivers
 106  * that treat struct proc/struct thread as an opaque data type and
 107  * exist in substantially the same form in both 4.x and 5.x.  Writers
 108  * of drivers that dips into the d_thread_t structure should use
 109  * struct thread or struct proc as appropriate for the version of the
 110  * OS they are using.  It is provided in lieu of each device driver
 111  * inventing its own way of doing this.  While it does violate style(9)
 112  * in a number of ways, this violation is deemed to be less
 113  * important than the benefits that a uniform API between releases
 114  * gives.
 115  *
 116  * Users of struct thread/struct proc that aren't device drivers should
 117  * not use d_thread_t.
 118  */
 119
 120 struct thread;
 121 struct lwkt_wait;
 122
 123 typedef struct thread d_thread_t;
 124 typedef int d_open_t __P((dev_t dev, int oflags, int devtype, d_thread_t *td));
 125 typedef int d_close_t __P((dev_t dev, int fflag, int devtype, d_thread_t *td));
 126 typedef void d_strategy_t __P((struct buf *bp));
 127 typedef int d_parms_t __P((dev_t dev, struct specinfo *sinfo, int ctl));
 128 typedef int d_ioctl_t __P((dev_t dev, u_long cmd, caddr_t data,
 129                            int fflag, d_thread_t *td));
 130 typedef int d_dump_t __P((dev_t dev));
 131 typedef int d_psize_t __P((dev_t dev));
 132
 133 typedef int d_read_t __P((dev_t dev, struct uio *uio, int ioflag));
 134 typedef int d_write_t __P((dev_t dev, struct uio *uio, int ioflag));
 135 typedef int d_poll_t __P((dev_t dev, int events, d_thread_t *td));
 136 typedef int d_kqfilter_t __P((dev_t dev, struct knote *kn));
 137 typedef int d_mmap_t __P((dev_t dev, vm_offset_t offset, int nprot));
 138
 139 typedef int l_open_t __P((dev_t dev, struct tty *tp));
 140 typedef int l_close_t __P((struct tty *tp, int flag));
 141 typedef int l_read_t __P((struct tty *tp, struct uio *uio, int flag));
 142 typedef int l_write_t __P((struct tty *tp, struct uio *uio, int flag));
 143 typedef int l_ioctl_t __P((struct tty *tp, u_long cmd, caddr_t data,
 144                            int flag, d_thread_t *td));
 145 typedef int l_rint_t __P((int c, struct tty *tp));
 146 typedef int l_start_t __P((struct tty *tp));
 147 typedef int l_modem_t __P((struct tty *tp, int flag));
 148
 149 /*
 150  * XXX: The dummy argument can be used to do what strategy1() never
 151  * did anywhere:  Create a per device flag to lock the device during
 152  * label/slice surgery, all calls with a dummy == 0 gets stalled on
 153  * a queue somewhere, whereas dummy == 1 are let through.  Once out
 154  * of surgery, reset the flag and restart all the stuff on the stall
 155  * queue.
 156  */
 157 #define BUF_STRATEGY(bp, dummy) (*devsw((bp)->b_dev)->d_strategy)(bp)
 158 /*
 159  * Types for d_flags.
 160  */
 161 #define D_TAPE  0x0001
 162 #define D_DISK  0x0002
 163 #define D_TTY   0x0004
 164 #define D_MEM   0x0008
 165
 166 #define D_TYPEMASK      0xffff
 167
 168 /*
 169  * Flags for d_flags.
 170  */
 171 #define D_MEMDISK       0x00010000      /* memory type disk */
 172 #define D_NAGGED        0x00020000      /* nagged about missing make_dev() */
 173 #define D_CANFREE       0x00040000      /* can free blocks */
 174 #define D_TRACKCLOSE    0x00080000      /* track all closes */
 175 #define D_KQFILTER      0x00200000      /* has kqfilter entry */
 176
 177 /*
 178  * Character device switch table
 179  */
 180 struct cdevsw {
 181         d_open_t        *d_open;
 182         d_close_t       *d_close;
 183         d_read_t        *d_read;
 184         d_write_t       *d_write;
 185         d_ioctl_t       *d_ioctl;
 186         d_poll_t        *d_poll;
 187         d_mmap_t        *d_mmap;
 188         d_strategy_t    *d_strategy;
 189         const char      *d_name;        /* base device name, e.g. 'vn' */
 190         int             d_maj;
 191         d_dump_t        *d_dump;
 192         d_psize_t       *d_psize;
 193         u_int           d_flags;
 194         int             d_bmaj;
 195         /* additions below are not binary compatible with 4.2 and below */
 196         d_kqfilter_t    *d_kqfilter;
 197 };
 198
 199 /*
 200  * Line discipline switch table
 201  */
 202 struct linesw {
 203         l_open_t        *l_open;
 204         l_close_t       *l_close;
 205         l_read_t        *l_read;
 206         l_write_t       *l_write;
 207         l_ioctl_t       *l_ioctl;
 208         l_rint_t        *l_rint;
 209         l_start_t       *l_start;
 210         l_modem_t       *l_modem;
 211         u_char          l_hotchar;
 212 };
 213
 214 #ifdef _KERNEL
 215 extern struct linesw linesw[];
 216 extern int nlinesw;
 217
 218 int ldisc_register __P((int , struct linesw *));
 219 void ldisc_deregister __P((int));
 220 #define LDISC_LOAD      -1              /* Loadable line discipline */
 221 #endif
 222
 223 /*
 224  * Swap device table
 225  */
 226 struct swdevt {
 227         udev_t  sw_dev;                 /* For quasibogus swapdev reporting */
 228         int     sw_flags;
 229         int     sw_nblks;
 230         struct  vnode *sw_vp;
 231         dev_t   sw_device;
 232 };
 233 #define SW_FREED        0x01
 234 #define SW_SEQUENTIAL   0x02
 235 #define sw_freed        sw_flags        /* XXX compat */
 236
 237 #ifdef _KERNEL
 238 d_open_t        noopen;
 239 d_close_t       noclose;
 240 d_read_t        noread;
 241 d_write_t       nowrite;
 242 d_ioctl_t       noioctl;
 243 d_mmap_t        nommap;
 244 d_kqfilter_t    nokqfilter;
 245 #define nostrategy      ((d_strategy_t *)NULL)
 246 #define nopoll  seltrue
 247
 248 d_dump_t        nodump;
 249
 250 #define NUMCDEVSW 256
 251
 252 /*
 253  * nopsize is little used, so not worth having dummy functions for.
 254  */
 255 #define nopsize ((d_psize_t *)NULL)
 256
 257 d_open_t        nullopen;
 258 d_close_t       nullclose;
 259
 260 l_ioctl_t       l_nullioctl;
 261 l_read_t        l_noread;
 262 l_write_t       l_nowrite;
 263
 264 struct module;
 265
 266 struct devsw_module_data {
 267         int     (*chainevh)(struct module *, int, void *); /* next handler */
 268         void    *chainarg;      /* arg for next event handler */
 269         /* Do not initialize fields hereafter */
 270 };
 271
 272 #define DEV_MODULE(name, evh, arg)                                      \
 273 static moduledata_t name##_mod = {                                      \
 274     #name,                                                              \
 275     evh,                                                                \
 276     arg                                                                 \
 277 };                                                                      \
 278 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
 279
 280
 281 int     cdevsw_add __P((struct cdevsw *new));
 282 int     cdevsw_remove __P((struct cdevsw *old));
 283 int     count_dev __P((dev_t dev));
 284 void    destroy_dev __P((dev_t dev));
 285 struct cdevsw *devsw __P((dev_t dev));
 286 const char *devtoname __P((dev_t dev));
 287 void    freedev __P((dev_t dev));
 288 int     iszerodev __P((dev_t dev));
 289 dev_t   makebdev __P((int maj, int min));
 290 dev_t   make_dev __P((struct cdevsw *devsw, int minor, uid_t uid, gid_t gid, int perms, const char *fmt, ...)) __printflike(6, 7);
 291 int     lminor __P((dev_t dev));
 292 void    setconf __P((void));
 293 dev_t   getdiskbyname(char *name);
 294
 295 /*
 296  * XXX: This included for when DEVFS resurfaces
 297  */
 298
 299 #define         UID_ROOT        0
 300 #define         UID_BIN         3
 301 #define         UID_UUCP        66
 302
 303 #define         GID_WHEEL       0
 304 #define         GID_KMEM        2
 305 #define         GID_OPERATOR    5
 306 #define         GID_BIN         7
 307 #define         GID_GAMES       13
 308 #define         GID_DIALER      68
 309
 310 #endif /* _KERNEL */
 311
 312 #endif /* !_SYS_CONF_H_ */