sys/sys/linedisc.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 specinfo {
  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         struct timespec si_atime;
  64         struct timespec si_ctime;
  65         struct timespec si_mtime;
  66         udev_t          si_udev;
  67         LIST_ENTRY(specinfo)    si_hash;
  68         SLIST_HEAD(, vnode)     si_hlist;
  69         LIST_HEAD(, specinfo)   si_children;
  70         LIST_ENTRY(specinfo)    si_siblings;
  71         dev_t           si_parent;
  72         struct snaphead si_snapshots;
  73         int             (*si_copyonwrite)(struct vnode *, struct buf *);
  74         u_int           si_inode;
  75         char            si_name[SPECNAMELEN + 1];
  76         void            *si_drv1, *si_drv2;
  77         struct cdevsw   *si_devsw;
  78         int             si_iosize_max;  /* maximum I/O size (for physio &al) */
  79         uid_t           si_uid;
  80         gid_t           si_gid;
  81         mode_t          si_mode;
  82         union {
  83                 struct {
  84                         struct tty *__sit_tty;
  85                 } __si_tty;
  86                 struct {
  87                         struct disk *__sid_disk;
  88                         struct mount *__sid_mountpoint;
  89                         int __sid_bsize_phys; /* min physical block size */
  90                         int __sid_bsize_best; /* optimal block size */
  91                 } __si_disk;
  92         } __si_u;
  93 };
  94
  95 #define si_tty          __si_u.__si_tty.__sit_tty
  96 #define si_disk         __si_u.__si_disk.__sid_disk
  97 #define si_mountpoint   __si_u.__si_disk.__sid_mountpoint
  98 #define si_bsize_phys   __si_u.__si_disk.__sid_bsize_phys
  99 #define si_bsize_best   __si_u.__si_disk.__sid_bsize_best
 100
 101 /*
 102  * Special device management
 103  */
 104 #define SPECHSZ 64
 105 #define SPECHASH(rdev)  (((unsigned)(minor(rdev)))%SPECHSZ)
 106
 107 /*
 108  * Definitions of device driver entry switches
 109  */
 110
 111 struct bio;
 112 struct buf;
 113 struct thread;
 114 struct uio;
 115 struct knote;
 116
 117 /*
 118  * Note: d_thread_t is provided as a transition aid for those drivers
 119  * that treat struct proc/struct thread as an opaque data type and
 120  * exist in substantially the same form in both 4.x and 5.x.  Writers
 121  * of drivers that dips into the d_thread_t structure should use
 122  * struct thread or struct proc as appropriate for the version of the
 123  * OS they are using.  It is provided in lieu of each device driver
 124  * inventing its own way of doing this.  While it does violate style(9)
 125  * in a number of ways, this violation is deemed to be less
 126  * important than the benefits that a uniform API between releases
 127  * gives.
 128  *
 129  * Users of struct thread/struct proc that aren't device drivers should
 130  * not use d_thread_t.
 131  */
 132
 133 typedef struct thread d_thread_t;
 134
 135 typedef int d_open_t __P((dev_t dev, int oflags, int devtype, d_thread_t *td));
 136 typedef int d_close_t __P((dev_t dev, int fflag, int devtype, d_thread_t *td));
 137 typedef void d_strategy_t __P((struct bio *bp));
 138 typedef int d_ioctl_t __P((dev_t dev, u_long cmd, caddr_t data,
 139                            int fflag, d_thread_t *td));
 140 typedef int d_dump_t __P((dev_t dev));
 141 typedef int d_psize_t __P((dev_t dev));
 142
 143 typedef int d_read_t __P((dev_t dev, struct uio *uio, int ioflag));
 144 typedef int d_write_t __P((dev_t dev, struct uio *uio, int ioflag));
 145 typedef int d_poll_t __P((dev_t dev, int events, d_thread_t *td));
 146 typedef int d_kqfilter_t __P((dev_t dev, struct knote *kn));
 147 typedef int d_mmap_t __P((dev_t dev, vm_offset_t offset, int nprot));
 148
 149 typedef int l_open_t __P((dev_t dev, struct tty *tp));
 150 typedef int l_close_t __P((struct tty *tp, int flag));
 151 typedef int l_read_t __P((struct tty *tp, struct uio *uio, int flag));
 152 typedef int l_write_t __P((struct tty *tp, struct uio *uio, int flag));
 153 typedef int l_ioctl_t __P((struct tty *tp, u_long cmd, caddr_t data,
 154                            int flag, d_thread_t *td));
 155 typedef int l_rint_t __P((int c, struct tty *tp));
 156 typedef int l_start_t __P((struct tty *tp));
 157 typedef int l_modem_t __P((struct tty *tp, int flag));
 158
 159 /*
 160  * XXX: The dummy argument can be used to do what strategy1() never
 161  * did anywhere:  Create a per device flag to lock the device during
 162  * label/slice surgery, all calls with a dummy == 0 gets stalled on
 163  * a queue somewhere, whereas dummy == 1 are let through.  Once out
 164  * of surgery, reset the flag and restart all the stuff on the stall
 165  * queue.
 166  */
 167 #define BIO_STRATEGY(bp, dummy)                                         \
 168         do {                                                            \
 169         if ((!(bp)->bio_cmd) || ((bp)->bio_cmd & ((bp)->bio_cmd - 1)))  \
 170                 Debugger("bio_cmd botch");                              \
 171         (*devsw((bp)->bio_dev)->d_strategy)(bp);                        \
 172         } while (0)
 173
 174 #define DEV_STRATEGY(bp, dummy)                                         \
 175         do {                                                            \
 176         if ((bp)->b_flags & B_PHYS)                                     \
 177                 (bp)->b_io.bio_offset = (bp)->b_offset;                 \
 178         else                                                            \
 179                 (bp)->b_io.bio_offset = dbtob((bp)->b_blkno);           \
 180         (bp)->b_io.bio_done = bufdonebio;                               \
 181         (bp)->b_io.bio_caller2 = (bp);                                  \
 182         BIO_STRATEGY(&(bp)->b_io, dummy);                               \
 183         } while (0)
 184
 185 #endif /* _KERNEL */
 186
 187 /*
 188  * Types for d_flags.
 189  */
 190 #define D_TAPE  0x0001
 191 #define D_DISK  0x0002
 192 #define D_TTY   0x0004
 193 #define D_MEM   0x0008
 194
 195 #ifdef _KERNEL
 196
 197 #define D_TYPEMASK      0xffff
 198
 199 /*
 200  * Flags for d_flags.
 201  */
 202 #define D_MEMDISK       0x00010000      /* memory type disk */
 203 #define D_NAGGED        0x00020000      /* nagged about missing make_dev() */
 204 #define D_CANFREE       0x00040000      /* can free blocks */
 205 #define D_TRACKCLOSE    0x00080000      /* track all closes */
 206 #define D_MMAP_ANON     0x00100000      /* special treatment in vm_mmap.c */
 207 #define D_KQFILTER      0x00200000      /* has kqfilter entry */
 208
 209 /*
 210  * Character device switch table
 211  */
 212 struct cdevsw {
 213         d_open_t        *d_open;
 214         d_close_t       *d_close;
 215         d_read_t        *d_read;
 216         d_write_t       *d_write;
 217         d_ioctl_t       *d_ioctl;
 218         d_poll_t        *d_poll;
 219         d_mmap_t        *d_mmap;
 220         d_strategy_t    *d_strategy;
 221         const char      *d_name;        /* base device name, e.g. 'vn' */
 222         int             d_maj;
 223         d_dump_t        *d_dump;
 224         d_psize_t       *d_psize;
 225         u_int           d_flags;
 226         /* additions below are not binary compatible with 4.2 and below */
 227         d_kqfilter_t    *d_kqfilter;
 228 };
 229
 230 /*
 231  * Line discipline switch table
 232  */
 233 struct linesw {
 234         l_open_t        *l_open;
 235         l_close_t       *l_close;
 236         l_read_t        *l_read;
 237         l_write_t       *l_write;
 238         l_ioctl_t       *l_ioctl;
 239         l_rint_t        *l_rint;
 240         l_start_t       *l_start;
 241         l_modem_t       *l_modem;
 242         u_char          l_hotchar;
 243 };
 244
 245 extern struct linesw linesw[];
 246 extern int nlinesw;
 247
 248 int ldisc_register __P((int , struct linesw *));
 249 void ldisc_deregister __P((int));
 250 #define LDISC_LOAD      -1              /* Loadable line discipline */
 251 #endif /* _KERNEL */
 252
 253 /*
 254  * Swap device table
 255  */
 256 struct swdevt {
 257         udev_t  sw_dev;                 /* For quasibogus swapdev reporting */
 258         int     sw_flags;
 259         int     sw_nblks;
 260         int     sw_used;
 261         struct  vnode *sw_vp;
 262         dev_t   sw_device;
 263 };
 264 #define SW_FREED        0x01
 265 #define SW_SEQUENTIAL   0x02
 266 #define sw_freed        sw_flags        /* XXX compat */
 267
 268 #ifdef _KERNEL
 269 d_open_t        noopen;
 270 d_close_t       noclose;
 271 d_read_t        noread;
 272 d_write_t       nowrite;
 273 d_ioctl_t       noioctl;
 274 d_mmap_t        nommap;
 275 d_kqfilter_t    nokqfilter;
 276 #define nostrategy      ((d_strategy_t *)NULL)
 277 #define nopoll  seltrue
 278
 279 d_dump_t        nodump;
 280
 281 #define NUMCDEVSW 256
 282
 283 /*
 284  * nopsize is little used, so not worth having dummy functions for.
 285  */
 286 #define nopsize ((d_psize_t *)NULL)
 287
 288 d_open_t        nullopen;
 289 d_close_t       nullclose;
 290
 291 l_ioctl_t       l_nullioctl;
 292 l_read_t        l_noread;
 293 l_write_t       l_nowrite;
 294
 295 struct module;
 296
 297 struct devsw_module_data {
 298         int     (*chainevh)(struct module *, int, void *); /* next handler */
 299         void    *chainarg;      /* arg for next event handler */
 300         /* Do not initialize fields hereafter */
 301 };
 302
 303 #define DEV_MODULE(name, evh, arg)                                      \
 304 static moduledata_t name##_mod = {                                      \
 305     #name,                                                              \
 306     evh,                                                                \
 307     arg                                                                 \
 308 };                                                                      \
 309 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
 310
 311
 312 int     cdevsw_add __P((struct cdevsw *new));
 313 int     cdevsw_remove __P((struct cdevsw *old));
 314 int     count_dev __P((dev_t dev));
 315 void    destroy_dev __P((dev_t dev));
 316 struct cdevsw *devsw __P((dev_t dev));
 317 const char *devtoname __P((dev_t dev));
 318 void    dev_depends __P((dev_t pdev, dev_t cdev));
 319 void    freedev __P((dev_t dev));
 320 int     iszerodev __P((dev_t dev));
 321 dev_t   makebdev __P((int maj, int min));
 322 dev_t   make_dev __P((struct cdevsw *devsw, int minor, uid_t uid, gid_t gid, int perms, const char *fmt, ...)) __printflike(6, 7);
 323 dev_t   make_dev_alias __P((dev_t pdev, const char *fmt, ...)) __printflike(2, 3);
 324 int     dev2unit __P((dev_t dev));
 325 int     unit2minor __P((int unit));
 326 void    setconf __P((void));
 327 dev_t   getdiskbyname(char *name);
 328
 329 /* This is type of the function DEVFS uses to hook into the kernel with */
 330 typedef void devfs_create_t __P((dev_t dev));
 331 typedef void devfs_destroy_t __P((dev_t dev));
 332
 333 extern devfs_create_t *devfs_create_hook;
 334 extern devfs_destroy_t *devfs_destroy_hook;
 335 extern int devfs_present;
 336
 337 /*
 338  * XXX: This included for when DEVFS resurfaces
 339  */
 340
 341 #define         UID_ROOT        0
 342 #define         UID_BIN         3
 343 #define         UID_UUCP        66
 344
 345 #define         GID_WHEEL       0
 346 #define         GID_KMEM        2
 347 #define         GID_OPERATOR    5
 348 #define         GID_BIN         7
 349 #define         GID_GAMES       13
 350 #define         GID_DIALER      68
 351
 352 typedef void (*dev_clone_fn) __P((void *arg, char *name, int namelen, dev_t *result));
 353
 354 int dev_stdclone __P((char *name, char **namep, char *stem, int *unit));
 355 EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
 356 #endif /* _KERNEL */
 357
 358 #endif /* !_SYS_CONF_H_ */