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  * 4. Neither the name of the University nor the names of its contributors
  21  *    may be used to endorse or promote products derived from this software
  22  *    without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34  * SUCH DAMAGE.
  35  *
  36  *      @(#)conf.h      8.5 (Berkeley) 1/9/95
  37  * $FreeBSD$
  38  */
  39
  40 #ifndef _SYS_CONF_H_
  41 #define _SYS_CONF_H_
  42
  43 #ifdef _KERNEL
  44 #include <sys/eventhandler.h>
  45 #else
  46 #include <sys/queue.h>
  47 #endif
  48
  49 struct tty;
  50 struct disk;
  51 struct vnode;
  52 struct buf;
  53 struct snapdata;
  54
  55 struct cdev {
  56         u_int           si_flags;
  57 #define SI_ALIAS        0x0002  /* carrier of alias name */
  58 #define SI_NAMED        0x0004  /* make_dev{_alias} has been called */
  59 #define SI_CHEAPCLONE   0x0008  /* can be removed_dev'ed when vnode reclaims */
  60 #define SI_CHILD        0x0010  /* child of another struct cdev **/
  61 #define SI_DEVOPEN      0x0020  /* opened by device */
  62 #define SI_CONSOPEN     0x0040  /* opened by console */
  63 #define SI_DUMPDEV      0x0080  /* is kernel dumpdev */
  64 #define SI_CANDELETE    0x0100  /* can do BIO_DELETE */
  65 #define SI_CLONELIST    0x0200  /* on a clone list */
  66         struct timespec si_atime;
  67         struct timespec si_ctime;
  68         struct timespec si_mtime;
  69         dev_t           si_udev;
  70         int             si_refcount;
  71         LIST_ENTRY(cdev)        si_list;
  72         LIST_ENTRY(cdev)        si_clone;
  73         LIST_ENTRY(cdev)        si_hash;
  74         SLIST_HEAD(, vnode)     si_hlist;
  75         LIST_HEAD(, cdev)       si_children;
  76         LIST_ENTRY(cdev)        si_siblings;
  77         struct cdev *si_parent;
  78         u_int           si_inode;
  79         char            *si_name;
  80         void            *si_drv1, *si_drv2;
  81         struct cdevsw   *si_devsw;
  82         int             si_iosize_max;  /* maximum I/O size (for physio &al) */
  83         uid_t           si_uid;
  84         gid_t           si_gid;
  85         mode_t          si_mode;
  86         u_long          si_usecount;
  87         u_long          si_threadcount;
  88         union {
  89                 struct {
  90                         struct tty *__sit_tty;
  91                 } __si_tty;
  92                 struct {
  93                         struct mount *__sid_mountpoint;
  94                         int __sid_bsize_phys; /* min physical block size */
  95                         struct snapdata *__sid_snapdata;
  96                 } __si_disk;
  97         } __si_u;
  98         char            __si_namebuf[SPECNAMELEN + 1];
  99 };
 100
 101 #define si_tty          __si_u.__si_tty.__sit_tty
 102 #define si_mountpoint   __si_u.__si_disk.__sid_mountpoint
 103 #define si_bsize_phys   __si_u.__si_disk.__sid_bsize_phys
 104 #define si_snapdata     __si_u.__si_disk.__sid_snapdata
 105
 106 #ifdef _KERNEL
 107
 108 /*
 109  * Definitions of device driver entry switches
 110  */
 111
 112 struct bio;
 113 struct buf;
 114 struct thread;
 115 struct uio;
 116 struct knote;
 117 struct clonedevs;
 118
 119 /*
 120  * Note: d_thread_t is provided as a transition aid for those drivers
 121  * that treat struct proc/struct thread as an opaque data type and
 122  * exist in substantially the same form in both 4.x and 5.x.  Writers
 123  * of drivers that dips into the d_thread_t structure should use
 124  * struct thread or struct proc as appropriate for the version of the
 125  * OS they are using.  It is provided in lieu of each device driver
 126  * inventing its own way of doing this.  While it does violate style(9)
 127  * in a number of ways, this violation is deemed to be less
 128  * important than the benefits that a uniform API between releases
 129  * gives.
 130  *
 131  * Users of struct thread/struct proc that aren't device drivers should
 132  * not use d_thread_t.
 133  */
 134
 135 typedef struct thread d_thread_t;
 136
 137 typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td);
 138 typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, int fdidx);
 139 typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td);
 140 typedef void d_strategy_t(struct bio *bp);
 141 typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data,
 142                       int fflag, struct thread *td);
 143
 144 typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag);
 145 typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag);
 146 typedef int d_poll_t(struct cdev *dev, int events, struct thread *td);
 147 typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn);
 148 typedef int d_mmap_t(struct cdev *dev, vm_offset_t offset, vm_paddr_t *paddr,
 149                      int nprot);
 150 typedef void d_purge_t(struct cdev *dev);
 151
 152 typedef int d_spare2_t(struct cdev *dev);
 153
 154 typedef int dumper_t(
 155         void *priv,             /* Private to the driver. */
 156         void *virtual,          /* Virtual (mapped) address. */
 157         vm_offset_t physical,   /* Physical address of virtual. */
 158         off_t offset,           /* Byte-offset to write at. */
 159         size_t length);         /* Number of bytes to dump. */
 160
 161 #endif /* _KERNEL */
 162
 163 /*
 164  * Types for d_flags.
 165  */
 166 #define D_TAPE  0x0001
 167 #define D_DISK  0x0002
 168 #define D_TTY   0x0004
 169 #define D_MEM   0x0008
 170
 171 #ifdef _KERNEL
 172
 173 #define D_TYPEMASK      0xffff
 174
 175 /*
 176  * Flags for d_flags which the drivers can set.
 177  */
 178 #define D_MEMDISK       0x00010000      /* memory type disk */
 179 #define D_TRACKCLOSE    0x00080000      /* track all closes */
 180 #define D_MMAP_ANON     0x00100000      /* special treatment in vm_mmap.c */
 181 #define D_PSEUDO        0x00200000      /* make_dev() can return NULL */
 182 #define D_NEEDGIANT     0x00400000      /* driver want Giant */
 183
 184 /*
 185  * Version numbers.
 186  */
 187 #define D_VERSION_00    0x20011966
 188 #define D_VERSION       D_VERSION_00
 189
 190 /*
 191  * Flags used for internal housekeeping
 192  */
 193 #define D_INIT          0x80000000      /* cdevsw initialized */
 194 #define D_ALLOCMAJ      0x40000000      /* major# is allocated */
 195
 196 /*
 197  * Character device switch table
 198  */
 199 struct cdevsw {
 200         int                     d_version;
 201         int                     d_maj;
 202         u_int                   d_flags;
 203         const char              *d_name;
 204         d_open_t                *d_open;
 205         d_fdopen_t              *d_fdopen;
 206         d_close_t               *d_close;
 207         d_read_t                *d_read;
 208         d_write_t               *d_write;
 209         d_ioctl_t               *d_ioctl;
 210         d_poll_t                *d_poll;
 211         d_mmap_t                *d_mmap;
 212         d_strategy_t            *d_strategy;
 213         dumper_t                *d_dump;
 214         d_kqfilter_t            *d_kqfilter;
 215         d_purge_t               *d_purge;
 216         d_spare2_t              *d_spare2;
 217
 218         /* These fields should not be messed with by drivers */
 219         LIST_ENTRY(cdevsw)      d_list;
 220         LIST_HEAD(, cdev)       d_devs;
 221         int                     d_spare3;
 222 };
 223
 224 #endif /* _KERNEL */
 225
 226 #ifdef _KERNEL
 227
 228 #define NUMCDEVSW 256
 229
 230 /*
 231  * XXX: do not use MAJOR_AUTO unless you have no choice.  In general drivers
 232  * should just not initialize .d_maj and that will DTRT.
 233  */
 234 #define MAJOR_AUTO      0       /* XXX: Not GM */
 235
 236 struct module;
 237
 238 struct devsw_module_data {
 239         int     (*chainevh)(struct module *, int, void *); /* next handler */
 240         void    *chainarg;      /* arg for next event handler */
 241         /* Do not initialize fields hereafter */
 242 };
 243
 244 #define DEV_MODULE(name, evh, arg)                                      \
 245 static moduledata_t name##_mod = {                                      \
 246     #name,                                                              \
 247     evh,                                                                \
 248     arg                                                                 \
 249 };                                                                      \
 250 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
 251
 252
 253 void clone_setup(struct clonedevs **cdp);
 254 void clone_cleanup(struct clonedevs **);
 255 #define CLONE_UNITMASK 0xfffff
 256 #define CLONE_FLAG0 (CLONE_UNITMASK + 1)
 257 int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, u_int extra);
 258
 259 int     count_dev(struct cdev *_dev);
 260 void    destroy_dev(struct cdev *_dev);
 261 struct cdevsw *dev_refthread(struct cdev *_dev);
 262 void    dev_relthread(struct cdev *_dev);
 263 const char *devtoname(struct cdev *_dev);
 264 int     dev_named(struct cdev *_pdev, const char *_name);
 265 void    dev_depends(struct cdev *_pdev, struct cdev *_cdev);
 266 void    dev_ref(struct cdev *dev);
 267 void    dev_rel(struct vnode *vp);
 268 void    dev_strategy(struct buf *bp);
 269 struct cdev *makebdev(int _maj, int _min);
 270 struct cdev *make_dev(struct cdevsw *_devsw, int _minor, uid_t _uid, gid_t _gid,
 271                 int _perms, const char *_fmt, ...) __printflike(6, 7);
 272 struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...) __printflike(2, 3);
 273 int     dev2unit(struct cdev *_dev);
 274 void    dev_lock(void);
 275 void    dev_unlock(void);
 276 int     unit2minor(int _unit);
 277 void    setconf(void);
 278 struct cdev *getdiskbyname(char *_name);
 279
 280 void devfs_create(struct cdev *dev);
 281 void devfs_destroy(struct cdev *dev);
 282
 283 #define         UID_ROOT        0
 284 #define         UID_BIN         3
 285 #define         UID_UUCP        66
 286
 287 #define         GID_WHEEL       0
 288 #define         GID_KMEM        2
 289 #define         GID_OPERATOR    5
 290 #define         GID_BIN         7
 291 #define         GID_GAMES       13
 292 #define         GID_DIALER      68
 293
 294 typedef void (*dev_clone_fn)(void *arg, char *name, int namelen, struct cdev **result);
 295
 296 int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit);
 297 EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
 298
 299 /* Stuff relating to kernel-dump */
 300
 301 struct dumperinfo {
 302         dumper_t *dumper;       /* Dumping function. */
 303         void    *priv;          /* Private parts. */
 304         u_int   blocksize;      /* Size of block in bytes. */
 305         off_t   mediaoffset;    /* Initial offset in bytes. */
 306         off_t   mediasize;      /* Space available in bytes. */
 307 };
 308
 309 int set_dumper(struct dumperinfo *);
 310 void dumpsys(struct dumperinfo *);
 311 extern int dumping;             /* system is dumping */
 312
 313 /* D_TTY related functions */
 314 d_close_t        ttyclose;
 315 d_ioctl_t        ttyioctl;
 316 d_kqfilter_t     ttykqfilter;
 317 d_open_t         ttyopen;
 318 d_poll_t         ttypoll;
 319 d_read_t         ttyread;
 320 d_write_t        ttywrite;
 321
 322 #endif /* _KERNEL */
 323
 324 #endif /* !_SYS_CONF_H_ */