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 snapdata;
  50 struct devfs_dirent;
  51 struct cdevsw;
  52 struct file;
  53
  54 struct cdev {
  55         void            *si_spare0;
  56         u_int           si_flags;
  57 #define SI_ETERNAL      0x0001  /* never destroyed */
  58 #define SI_ALIAS        0x0002  /* carrier of alias name */
  59 #define SI_NAMED        0x0004  /* make_dev{_alias} has been called */
  60 #define SI_CHEAPCLONE   0x0008  /* can be removed_dev'ed when vnode reclaims */
  61 #define SI_CHILD        0x0010  /* child of another struct cdev **/
  62 #define SI_DUMPDEV      0x0080  /* is kernel dumpdev */
  63 #define SI_CLONELIST    0x0200  /* on a clone list */
  64         struct timespec si_atime;
  65         struct timespec si_ctime;
  66         struct timespec si_mtime;
  67         uid_t           si_uid;
  68         gid_t           si_gid;
  69         mode_t          si_mode;
  70         struct ucred    *si_cred;       /* cached clone-time credential */
  71         int             si_drv0;
  72         int             si_refcount;
  73         LIST_ENTRY(cdev)        si_list;
  74         LIST_ENTRY(cdev)        si_clone;
  75         LIST_HEAD(, cdev)       si_children;
  76         LIST_ENTRY(cdev)        si_siblings;
  77         struct cdev *si_parent;
  78         struct mount    *si_mountpt;
  79         void            *si_drv1, *si_drv2;
  80         struct cdevsw   *si_devsw;
  81         int             si_iosize_max;  /* maximum I/O size (for physio &al) */
  82         u_long          si_usecount;
  83         u_long          si_threadcount;
  84         union {
  85                 struct snapdata *__sid_snapdata;
  86         } __si_u;
  87         char            si_name[SPECNAMELEN + 1];
  88 };
  89
  90 #define si_snapdata     __si_u.__sid_snapdata
  91
  92 #ifdef _KERNEL
  93
  94 /*
  95  * Definitions of device driver entry switches
  96  */
  97
  98 struct bio;
  99 struct buf;
 100 struct thread;
 101 struct uio;
 102 struct knote;
 103 struct clonedevs;
 104 struct vm_object;
 105 struct vnode;
 106
 107 /*
 108  * Note: d_thread_t is provided as a transition aid for those drivers
 109  * that treat struct proc/struct thread as an opaque data type and
 110  * exist in substantially the same form in both 4.x and 5.x.  Writers
 111  * of drivers that dips into the d_thread_t structure should use
 112  * struct thread or struct proc as appropriate for the version of the
 113  * OS they are using.  It is provided in lieu of each device driver
 114  * inventing its own way of doing this.  While it does violate style(9)
 115  * in a number of ways, this violation is deemed to be less
 116  * important than the benefits that a uniform API between releases
 117  * gives.
 118  *
 119  * Users of struct thread/struct proc that aren't device drivers should
 120  * not use d_thread_t.
 121  */
 122
 123 typedef struct thread d_thread_t;
 124
 125 typedef int d_open_t(struct cdev *dev, int oflags, int devtype, struct thread *td);
 126 typedef int d_fdopen_t(struct cdev *dev, int oflags, struct thread *td, struct file *fp);
 127 typedef int d_close_t(struct cdev *dev, int fflag, int devtype, struct thread *td);
 128 typedef void d_strategy_t(struct bio *bp);
 129 typedef int d_ioctl_t(struct cdev *dev, u_long cmd, caddr_t data,
 130                       int fflag, struct thread *td);
 131
 132 typedef int d_read_t(struct cdev *dev, struct uio *uio, int ioflag);
 133 typedef int d_write_t(struct cdev *dev, struct uio *uio, int ioflag);
 134 typedef int d_poll_t(struct cdev *dev, int events, struct thread *td);
 135 typedef int d_kqfilter_t(struct cdev *dev, struct knote *kn);
 136 typedef int d_mmap_t(struct cdev *dev, vm_ooffset_t offset, vm_paddr_t *paddr,
 137                      int nprot, vm_memattr_t *memattr);
 138 typedef int d_mmap_single_t(struct cdev *cdev, vm_ooffset_t *offset,
 139     vm_size_t size, struct vm_object **object, int nprot);
 140 typedef void d_purge_t(struct cdev *dev);
 141
 142 typedef int dumper_t(
 143         void *_priv,            /* Private to the driver. */
 144         void *_virtual,         /* Virtual (mapped) address. */
 145         vm_offset_t _physical,  /* Physical address of virtual. */
 146         off_t _offset,          /* Byte-offset to write at. */
 147         size_t _length);        /* Number of bytes to dump. */
 148
 149 #endif /* _KERNEL */
 150
 151 /*
 152  * Types for d_flags.
 153  */
 154 #define D_TAPE  0x0001
 155 #define D_DISK  0x0002
 156 #define D_TTY   0x0004
 157 #define D_MEM   0x0008
 158
 159 #ifdef _KERNEL
 160
 161 #define D_TYPEMASK      0xffff
 162
 163 /*
 164  * Flags for d_flags which the drivers can set.
 165  */
 166 #define D_TRACKCLOSE    0x00080000      /* track all closes */
 167 #define D_MMAP_ANON     0x00100000      /* special treatment in vm_mmap.c */
 168 #define D_NEEDGIANT     0x00400000      /* driver want Giant */
 169 #define D_NEEDMINOR     0x00800000      /* driver uses clone_create() */
 170 #define D_UNMAPPED_IO   0x01000000      /* d_strategy can accept unmapped IO */
 171
 172 /*
 173  * Version numbers.
 174  */
 175 #define D_VERSION_00    0x20011966
 176 #define D_VERSION_01    0x17032005      /* Add d_uid,gid,mode & kind */
 177 #define D_VERSION_02    0x28042009      /* Add d_mmap_single */
 178 #define D_VERSION_03    0x17122009      /* d_mmap takes memattr,vm_ooffset_t */
 179 #define D_VERSION       D_VERSION_03
 180
 181 /*
 182  * Flags used for internal housekeeping
 183  */
 184 #define D_INIT          0x80000000      /* cdevsw initialized */
 185
 186 /*
 187  * Character device switch table
 188  */
 189 struct cdevsw {
 190         int                     d_version;
 191         u_int                   d_flags;
 192         const char              *d_name;
 193         d_open_t                *d_open;
 194         d_fdopen_t              *d_fdopen;
 195         d_close_t               *d_close;
 196         d_read_t                *d_read;
 197         d_write_t               *d_write;
 198         d_ioctl_t               *d_ioctl;
 199         d_poll_t                *d_poll;
 200         d_mmap_t                *d_mmap;
 201         d_strategy_t            *d_strategy;
 202         dumper_t                *d_dump;
 203         d_kqfilter_t            *d_kqfilter;
 204         d_purge_t               *d_purge;
 205         d_mmap_single_t         *d_mmap_single;
 206
 207         int32_t                 d_spare0[3];
 208         void                    *d_spare1[3];
 209
 210         /* These fields should not be messed with by drivers */
 211         LIST_HEAD(, cdev)       d_devs;
 212         int                     d_spare2;
 213         union {
 214                 struct cdevsw           *gianttrick;
 215                 SLIST_ENTRY(cdevsw)     postfree_list;
 216         } __d_giant;
 217 };
 218 #define d_gianttrick            __d_giant.gianttrick
 219 #define d_postfree_list         __d_giant.postfree_list
 220
 221 struct module;
 222
 223 struct devsw_module_data {
 224         int     (*chainevh)(struct module *, int, void *); /* next handler */
 225         void    *chainarg;      /* arg for next event handler */
 226         /* Do not initialize fields hereafter */
 227 };
 228
 229 #define DEV_MODULE(name, evh, arg)                                      \
 230 static moduledata_t name##_mod = {                                      \
 231     #name,                                                              \
 232     evh,                                                                \
 233     arg                                                                 \
 234 };                                                                      \
 235 DECLARE_MODULE(name, name##_mod, SI_SUB_DRIVERS, SI_ORDER_MIDDLE)
 236
 237
 238 void clone_setup(struct clonedevs **cdp);
 239 void clone_cleanup(struct clonedevs **);
 240 #define CLONE_UNITMASK  0xfffff
 241 #define CLONE_FLAG0     (CLONE_UNITMASK + 1)
 242 int clone_create(struct clonedevs **, struct cdevsw *, int *unit, struct cdev **dev, int extra);
 243
 244 int     count_dev(struct cdev *_dev);
 245 void    destroy_dev(struct cdev *_dev);
 246 int     destroy_dev_sched(struct cdev *dev);
 247 int     destroy_dev_sched_cb(struct cdev *dev, void (*cb)(void *), void *arg);
 248 void    destroy_dev_drain(struct cdevsw *csw);
 249 void    drain_dev_clone_events(void);
 250 struct cdevsw *dev_refthread(struct cdev *_dev, int *_ref);
 251 struct cdevsw *devvn_refthread(struct vnode *vp, struct cdev **devp, int *_ref);
 252 void    dev_relthread(struct cdev *_dev, int _ref);
 253 void    dev_depends(struct cdev *_pdev, struct cdev *_cdev);
 254 void    dev_ref(struct cdev *dev);
 255 void    dev_refl(struct cdev *dev);
 256 void    dev_rel(struct cdev *dev);
 257 void    dev_strategy(struct cdev *dev, struct buf *bp);
 258 void    dev_strategy_csw(struct cdev *dev, struct cdevsw *csw, struct buf *bp);
 259 struct cdev *make_dev(struct cdevsw *_devsw, int _unit, uid_t _uid, gid_t _gid,
 260                 int _perms, const char *_fmt, ...) __printflike(6, 7);
 261 struct cdev *make_dev_cred(struct cdevsw *_devsw, int _unit,
 262                 struct ucred *_cr, uid_t _uid, gid_t _gid, int _perms,
 263                 const char *_fmt, ...) __printflike(7, 8);
 264 #define MAKEDEV_REF             0x01
 265 #define MAKEDEV_WHTOUT          0x02
 266 #define MAKEDEV_NOWAIT          0x04
 267 #define MAKEDEV_WAITOK          0x08
 268 #define MAKEDEV_ETERNAL         0x10
 269 #define MAKEDEV_CHECKNAME       0x20
 270 struct cdev *make_dev_credf(int _flags,
 271                 struct cdevsw *_devsw, int _unit,
 272                 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode,
 273                 const char *_fmt, ...) __printflike(8, 9);
 274 int     make_dev_p(int _flags, struct cdev **_cdev, struct cdevsw *_devsw,
 275                 struct ucred *_cr, uid_t _uid, gid_t _gid, int _mode,
 276                 const char *_fmt, ...) __printflike(8, 9);
 277 struct cdev *make_dev_alias(struct cdev *_pdev, const char *_fmt, ...)
 278                 __printflike(2, 3);
 279 int     make_dev_alias_p(int _flags, struct cdev **_cdev, struct cdev *_pdev,
 280                 const char *_fmt, ...) __printflike(4, 5);
 281 int     make_dev_physpath_alias(int _flags, struct cdev **_cdev,
 282                 struct cdev *_pdev, struct cdev *_old_alias,
 283                 const char *_physpath);
 284 void    dev_lock(void);
 285 void    dev_unlock(void);
 286 void    setconf(void);
 287
 288 #ifdef KLD_MODULE
 289 #define MAKEDEV_ETERNAL_KLD     0
 290 #else
 291 #define MAKEDEV_ETERNAL_KLD     MAKEDEV_ETERNAL
 292 #endif
 293
 294 #define dev2unit(d)     ((d)->si_drv0)
 295
 296 typedef void (*cdevpriv_dtr_t)(void *data);
 297 int     devfs_get_cdevpriv(void **datap);
 298 int     devfs_set_cdevpriv(void *priv, cdevpriv_dtr_t dtr);
 299 void    devfs_clear_cdevpriv(void);
 300 void    devfs_fpdrop(struct file *fp);  /* XXX This is not public KPI */
 301
 302 ino_t   devfs_alloc_cdp_inode(void);
 303 void    devfs_free_cdp_inode(ino_t ino);
 304
 305 #define         UID_ROOT        0
 306 #define         UID_BIN         3
 307 #define         UID_UUCP        66
 308 #define         UID_NOBODY      65534
 309
 310 #define         GID_WHEEL       0
 311 #define         GID_KMEM        2
 312 #define         GID_TTY         4
 313 #define         GID_OPERATOR    5
 314 #define         GID_BIN         7
 315 #define         GID_GAMES       13
 316 #define         GID_DIALER      68
 317 #define         GID_NOBODY      65534
 318
 319 typedef void (*dev_clone_fn)(void *arg, struct ucred *cred, char *name,
 320             int namelen, struct cdev **result);
 321
 322 int dev_stdclone(char *_name, char **_namep, const char *_stem, int *_unit);
 323 EVENTHANDLER_DECLARE(dev_clone, dev_clone_fn);
 324
 325 /* Stuff relating to kernel-dump */
 326
 327 struct dumperinfo {
 328         dumper_t *dumper;       /* Dumping function. */
 329         void    *priv;          /* Private parts. */
 330         u_int   blocksize;      /* Size of block in bytes. */
 331         u_int   maxiosize;      /* Max size allowed for an individual I/O */
 332         off_t   mediaoffset;    /* Initial offset in bytes. */
 333         off_t   mediasize;      /* Space available in bytes. */
 334 };
 335
 336 int set_dumper(struct dumperinfo *, const char *_devname);
 337 int dump_write(struct dumperinfo *, void *, vm_offset_t, off_t, size_t);
 338 void dumpsys(struct dumperinfo *);
 339 int doadump(boolean_t);
 340 extern int dumping;             /* system is dumping */
 341
 342 #endif /* _KERNEL */
 343
 344 #endif /* !_SYS_CONF_H_ */