The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/sys/conf.h

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: 7b989cffe500e4964718d5eb4d516d7f


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.