sys/fs/devfs/devfs.h

   1 /*-
   2  * Copyright (c) 1992, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 2000
   5  *      Poul-Henning Kamp.  All rights reserved.
   6  * Copyright (c) 2002
   7  *      Dima Dorfman.  All rights reserved.
   8  *
   9  * This code is derived from software donated to Berkeley by
  10  * Jan-Simon Pendry.
  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. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)kernfs.h    8.6 (Berkeley) 3/29/95
  34  * From: FreeBSD: src/sys/miscfs/kernfs/kernfs.h 1.14
  35  *
  36  * $FreeBSD$
  37  */
  38
  39 #ifndef _FS_DEVFS_DEVFS_H_
  40 #define _FS_DEVFS_DEVFS_H_
  41
  42 #define DEVFS_MAGIC     0xdb0a087a
  43
  44 /*
  45  * Identifiers.  The ruleset and rule numbers are 16-bit values.  The
  46  * "rule ID" is a combination of the ruleset and rule number; it
  47  * should be able to univocally describe a rule in the system.  In
  48  * this implementation, the upper 16 bits of the rule ID is the
  49  * ruleset number; the lower 16 bits, the rule number within the
  50  * aforementioned ruleset.
  51  */
  52 typedef uint16_t devfs_rnum;
  53 typedef uint16_t devfs_rsnum;
  54 typedef uint32_t devfs_rid;
  55
  56 /*
  57  * Identifier manipulators.
  58  */
  59 #define rid2rsn(rid)    ((rid) >> 16)
  60 #define rid2rn(rid)     ((rid) & 0xffff)
  61 #define mkrid(rsn, rn)  ((rn) | ((rsn) << 16))
  62
  63 /*
  64  * Plain DEVFS rule.  This gets shared between kernel and userland
  65  * verbatim, so it shouldn't contain any pointers or other kernel- or
  66  * userland-specific values.
  67  */
  68 struct devfs_rule {
  69         uint32_t dr_magic;                      /* Magic number. */
  70         devfs_rid dr_id;                        /* Identifier. */
  71
  72         /*
  73          * Conditions under which this rule should be applied.  These
  74          * are ANDed together since OR can be simulated by using
  75          * multiple rules.  dr_icond determines which of the other
  76          * variables we should process.
  77          */
  78         int     dr_icond;
  79 #define DRC_DSWFLAGS    0x001
  80 #define DRC_PATHPTRN    0x002
  81 #define DRC_MAJOR       0x004
  82         int     dr_dswflags;                    /* cdevsw flags to match. */
  83 #define DEVFS_MAXPTRNLEN        200
  84         char    dr_pathptrn[DEVFS_MAXPTRNLEN];  /* Pattern to match path. */
  85         int     dr_major;                       /* Device major number. */
  86
  87         /*
  88          * Things to change.  dr_iacts determines which of the other
  89          * variables we should process.
  90          */
  91         int     dr_iacts;
  92 #define DRA_BACTS       0x001
  93 #define DRA_UID         0x002
  94 #define DRA_GID         0x004
  95 #define DRA_MODE        0x008
  96 #define DRA_INCSET      0x010
  97         int     dr_bacts;                       /* Boolean (on/off) action. */
  98 #define DRB_HIDE        0x001                   /* Hide entry (DE_WHITEOUT). */
  99 #define DRB_UNHIDE      0x002                   /* Unhide entry. */
 100         uid_t   dr_uid;
 101         gid_t   dr_gid;
 102         mode_t  dr_mode;
 103         devfs_rsnum dr_incset;                  /* Included ruleset. */
 104 };
 105
 106 /*
 107  * Rule-related ioctls.
 108  */
 109 #define DEVFSIO_RADD            _IOWR('D', 0, struct devfs_rule)
 110 #define DEVFSIO_RDEL            _IOW('D', 1, devfs_rid)
 111 #define DEVFSIO_RAPPLY          _IOW('D', 2, struct devfs_rule)
 112 #define DEVFSIO_RAPPLYID        _IOW('D', 3, devfs_rid)
 113 #define DEVFSIO_RGETNEXT        _IOWR('D', 4, struct devfs_rule)
 114
 115 #define DEVFSIO_SUSE            _IOW('D', 10, devfs_rsnum)
 116 #define DEVFSIO_SAPPLY          _IOW('D', 11, devfs_rsnum)
 117 #define DEVFSIO_SGETNEXT        _IOWR('D', 12, devfs_rsnum)
 118
 119 /* XXX: DEVFSIO_RS_GET_INFO for refcount, active if any, etc. */
 120
 121 #ifdef _KERNEL
 122
 123 /*
 124  * These are default sizes for the DEVFS inode table and the overflow
 125  * table.  If the default table overflows we allocate the overflow
 126  * table, the size of which can also be set with a sysctl.  If the
 127  * overflow table fills you're toast.
 128  */
 129 #ifndef NDEVFSINO
 130 #define NDEVFSINO 1024
 131 #endif
 132
 133 #ifndef NDEVFSOVERFLOW
 134 #define NDEVFSOVERFLOW 32768
 135 #endif
 136
 137 /*
 138  * This is the first "per mount" inode, these are used for directories
 139  * and symlinks and the like.  Must be larger than the number of "true"
 140  * device nodes and symlinks.  It is.
 141  */
 142 #define DEVFSINOMOUNT   0x2000000
 143
 144 #ifdef MALLOC_DECLARE
 145 MALLOC_DECLARE(M_DEVFS);
 146 #endif
 147
 148 struct devfs_dirent {
 149         int     de_inode;
 150         int     de_flags;
 151 #define DE_WHITEOUT     0x1
 152 #define DE_DOT          0x2
 153 #define DE_DOTDOT       0x4
 154         struct dirent *de_dirent;
 155         TAILQ_ENTRY(devfs_dirent) de_list;
 156         TAILQ_HEAD(, devfs_dirent) de_dlist;
 157         struct devfs_dirent *de_dir;
 158         int     de_links;
 159         mode_t  de_mode;
 160         uid_t   de_uid;
 161         gid_t   de_gid;
 162         struct label    de_label;
 163         struct timespec de_atime;
 164         struct timespec de_mtime;
 165         struct timespec de_ctime;
 166         struct vnode *de_vnode;
 167         char *  de_symlink;
 168 };
 169
 170 struct devfs_mount {
 171         struct mount    *dm_mount;
 172         struct devfs_dirent *dm_rootdir;
 173         struct devfs_dirent *dm_basedir;
 174         unsigned        dm_generation;
 175         struct devfs_dirent **dm_dirent;
 176         struct devfs_dirent **dm_overflow;
 177         int     dm_inode;
 178         struct lock dm_lock;
 179         devfs_rsnum dm_ruleset;
 180 };
 181
 182 /*
 183  * This is what we fill in dm_dirent[N] for a deleted entry.
 184  */
 185 #define DE_DELETED ((struct devfs_dirent *)sizeof(struct devfs_dirent))
 186
 187 #define VFSTODEVFS(mp)  ((struct devfs_mount *)((mp)->mnt_data))
 188
 189 void devfs_rules_apply(struct devfs_mount *dm, struct devfs_dirent *de);
 190 void devfs_rules_init(void);
 191 int devfs_rules_ioctl(struct mount *mp, u_long cmd, caddr_t data, struct thread *td);
 192 void devfs_rules_newmount(struct devfs_mount *dm, struct thread *td);
 193 int devfs_allocv (struct devfs_dirent *de, struct mount *mp, struct vnode **vpp, struct thread *td);
 194 dev_t *devfs_itod (int inode);
 195 struct devfs_dirent **devfs_itode (struct devfs_mount *dm, int inode);
 196 int devfs_populate (struct devfs_mount *dm);
 197 struct devfs_dirent *devfs_newdirent (char *name, int namelen);
 198 void devfs_purge (struct devfs_dirent *dd);
 199 struct devfs_dirent *devfs_vmkdir (char *name, int namelen, struct devfs_dirent *dotdot);
 200
 201 #endif /* _KERNEL */
 202
 203 #endif /* !_FS_DEVFS_DEVFS_H_ */