sys/vfs/devfs/devfs.h

   1 /*
   2  * Copyright (c) 2009 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Alex Hornung <ahornung@gmail.com>
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34 #ifndef _VFS_DEVFS_H_
  35 #define _VFS_DEVFS_H_
  36
  37 #if !defined(_KERNEL) && !defined(_KERNEL_STRUCTURES)
  38 #error "This file should not be included by userland programs."
  39 #endif
  40
  41 #ifndef _SYS_QUEUE_H_
  42 #include <sys/queue.h>
  43 #endif
  44 #ifndef _SYS_LOCK_H_
  45 #include <sys/lock.h>
  46 #endif
  47 #ifndef _SYS_CONF_H_
  48 #include <sys/conf.h>
  49 #endif
  50 #ifndef _SYS_MSGPORT_H_
  51 #include <sys/msgport.h>
  52 #endif
  53 #ifndef _SYS_DIRENT_H_
  54 #include <sys/dirent.h>
  55 #endif
  56 #ifndef _SYS_DEVICE_H_
  57 #include <sys/device.h>
  58 #endif
  59 #ifndef _SYS_UCRED_H_
  60 #include <sys/ucred.h>
  61 #endif
  62
  63
  64 typedef enum {
  65         Proot,          /* the filesystem root */
  66         Plink,
  67         Preg,
  68         Pdir,
  69         Pdev
  70 } devfs_nodetype;
  71
  72 struct devfs_dirent {
  73         ino_t           d_ino;          /* file number of entry */
  74         uint16_t        d_namlen;       /* strlen(d_name) */
  75         uint8_t         d_type;         /* file type */
  76         char            *d_name;
  77 };
  78
  79 struct devfs_fid {
  80         uint16_t        fid_len;        /* Length of structure. */
  81         uint16_t        fid_pad;        /* Force 32-bit alignment. */
  82         uint32_t        fid_gen;
  83         ino_t           fid_ino;        /* File number (ino). */
  84 };
  85
  86 struct devfs_node {
  87         cdev_t          d_dev;          /* device assoicated with this node */
  88
  89         struct mount    *mp;            /* mount point of this node */
  90         struct devfs_dirent d_dir;      /* dirent data (name, inode, ...) */
  91         struct vnode    *v_node;        /* assoicated vnode */
  92         struct devfs_node *parent;      /* parent of this node */
  93         devfs_nodetype  node_type;      /* devfs node type */
  94
  95         u_int64_t       refs;           /* number of open references */
  96         size_t          nchildren;      /* number of children of a parent */
  97         u_int64_t       cookie_jar;     /* cookie pool for children */
  98         u_int64_t       cookie;         /* directory entry cookie for readdir */
  99
 100         struct devfs_node *link_target; /* target of this autolink-type node */
 101         size_t          nlinks;         /* hard links */
 102
 103         char            *symlink_name;  /* symlink name for readlink */
 104         size_t          symlink_namelen; /* symlink name length for readlink */
 105
 106         u_short         mode;           /* files access mode and type */
 107         uid_t           uid;            /* owner user id */
 108         gid_t           gid;            /* owner group id */
 109         u_long          flags;
 110
 111         struct timespec atime;          /* time of last access */
 112         struct timespec mtime;          /* time of last modification */
 113         struct timespec ctime;          /* time file changed */
 114
 115         TAILQ_ENTRY(devfs_node) link;
 116         TAILQ_HEAD(, devfs_node) list;  /* linked list of children */
 117 };
 118
 119 struct devfs_orphan {
 120         struct devfs_node *node;
 121         TAILQ_ENTRY(devfs_orphan) link;
 122 };
 123
 124 struct devfs_mnt_data {
 125         TAILQ_HEAD(, devfs_orphan) orphan_list;
 126         TAILQ_ENTRY(devfs_mnt_data) link;
 127
 128         struct devfs_node *root_node;
 129         struct mount    *mp;
 130         uint32_t        mnt_type;
 131         long            leak_count;
 132         int             jailed;
 133         size_t          mntonnamelen;
 134 };
 135
 136 struct devfs_clone_handler {
 137         char            *name;
 138         u_char          namlen;
 139         d_clone_t       *nhandler;
 140         TAILQ_ENTRY(devfs_clone_handler) link;
 141 };
 142
 143
 144 struct devfs_alias {
 145         char            *name;
 146         size_t          namlen;
 147         cdev_t          dev_target;
 148         TAILQ_ENTRY(devfs_alias) link;
 149 };
 150
 151
 152 typedef struct devfs_msg {
 153         struct lwkt_msg hdr;
 154
 155         union {
 156                 struct {
 157                         cdev_t  dev;
 158                         uid_t   uid;
 159                         gid_t   gid;
 160                         int     perms;
 161                 } __m_dev;
 162                 struct {
 163                         struct devfs_mnt_data *mnt;
 164                 } __m_mnt;
 165                 struct {
 166                         const char      *name;
 167                         d_clone_t       *nhandler;
 168                 } __m_chandler;
 169                 struct {
 170                         void *load;
 171                 } __m_gen;
 172                 struct {
 173                         void *resp;
 174                 } __m_resp;
 175                 struct {
 176                         udev_t  udev;
 177                 } __m_udev;
 178                 struct {
 179                         cdev_t  cdev;
 180                 } __m_cdev;
 181                 struct {
 182                         char    *name;
 183                 } __m_name;
 184                 struct {
 185                         char    *basename;
 186                         u_char  unit;
 187                         struct vnode *vp;
 188                 } __m_clone;
 189                 struct {
 190                         struct devfs_node *node;
 191                 } __m_node;
 192                 struct {
 193                         char    *name;
 194                         char    *target;
 195                         struct mount *mp;
 196                 } __m_link;
 197                 struct {
 198                         struct dev_ops *ops;
 199                         int     minor;
 200                 } __m_ops;
 201                 struct {
 202                         char    *name;
 203                         uint32_t        flag;
 204                 } __m_flags;
 205                 struct {
 206                         ino_t   ino;
 207                         struct vnode *vp;
 208                         struct mount *mp;
 209                 } __m_ino;
 210         } __m_u;
 211 } *devfs_msg_t;
 212
 213 #define mdv_chandler    __m_u.__m_chandler
 214 #define mdv_mnt         __m_u.__m_mnt.mnt
 215 #define mdv_load        __m_u.__m_gen.load
 216 #define mdv_response    __m_u.__m_resp.resp
 217 #define mdv_dev         __m_u.__m_dev
 218 #define mdv_link        __m_u.__m_link
 219 #define mdv_udev        __m_u.__m_udev.udev
 220 #define mdv_cdev        __m_u.__m_cdev.cdev
 221 #define mdv_name        __m_u.__m_name.name
 222 #define mdv_clone       __m_u.__m_clone
 223 #define mdv_node        __m_u.__m_node.node
 224 #define mdv_ops         __m_u.__m_ops
 225 #define mdv_flags       __m_u.__m_flags
 226 #define mdv_ino         __m_u.__m_ino
 227
 228
 229 typedef struct devfs_core_args {
 230         thread_t     td;
 231 } *devfs_core_args_t;
 232
 233 TAILQ_HEAD(devfs_node_head, devfs_node);
 234 TAILQ_HEAD(devfs_dev_head, cdev);
 235 TAILQ_HEAD(devfs_mnt_head, devfs_mnt_data);
 236 TAILQ_HEAD(devfs_chandler_head, devfs_clone_handler);
 237 TAILQ_HEAD(devfs_alias_head, devfs_alias);
 238
 239 typedef void (devfs_scan_t)(cdev_t);
 240 typedef void* (devfs_iterate_callback_t)(struct devfs_node *, void *);
 241
 242 #define DEVFS_NODE(x)           ((struct devfs_node *)((x)->v_data))
 243 #define DEVFS_MNTDATA(x)        ((struct devfs_mnt_data *)((x)->mnt_data))
 244 #define DEVFS_ORPHANLIST(x)     (&(DEVFS_MNTDATA(x)->orphan_list))
 245 #define DEVFS_DENODE_HEAD(x)    (&((x)->list))
 246 #define DEVFS_ISDIGIT(x)        ((x >= '0') && (x <= '9'))
 247
 248 /*
 249  * -rwxr-xr-x
 250  */
 251 #define DEVFS_DEFAULT_MODE      ((VREAD|VWRITE|VEXEC) | ((VREAD|VEXEC)>>3) | \
 252                                  ((VREAD|VEXEC)>>6));
 253
 254 #define DEVFS_DEFAULT_UID       0       /* root */
 255 #define DEVFS_DEFAULT_GID       5       /* operator */
 256
 257 /*
 258  * debug levels
 259  */
 260 #define DEVFS_DEBUG_SHOW        0x00
 261 #define DEVFS_DEBUG_WARNING     0x01
 262 #define DEVFS_DEBUG_INFO        0x02
 263 #define DEVFS_DEBUG_DEBUG       0x03
 264
 265 /*
 266  * Message ids
 267  */
 268 #define DEVFS_TERMINATE_CORE            0x01
 269 #define DEVFS_DEVICE_CREATE             0x02
 270 #define DEVFS_DEVICE_DESTROY            0x03
 271 #define DEVFS_MOUNT_ADD                 0x04
 272 #define DEVFS_MOUNT_DEL                 0x05
 273 #define DEVFS_CREATE_ALL_DEV            0x06
 274 #define DEVFS_DESTROY_SUBNAMES          0x07
 275 #define DEVFS_DESTROY_DEV_BY_OPS        0x08
 276 #define DEVFS_CHANDLER_ADD              0x09
 277 #define DEVFS_CHANDLER_DEL              0x0A
 278 #define DEVFS_FIND_DEVICE_BY_UDEV       0x0B
 279 #define DEVFS_FIND_DEVICE_BY_NAME       0x0C
 280 #define DEVFS_MAKE_ALIAS                0x0D
 281 #define DEVFS_APPLY_RULES               0x0F
 282 #define DEVFS_RESET_RULES               0x10
 283 #define DEVFS_SCAN_CALLBACK             0x11
 284 #define DEVFS_CLR_SUBNAMES_FLAG         0x12
 285 #define DEVFS_DESTROY_SUBNAMES_WO_FLAG  0x13
 286 #define DEVFS_INODE_TO_VNODE            0x14
 287 #define DEVFS_SYNC                      0x99
 288
 289 /*
 290  * Node flags
 291  *
 292  * HIDDEN       Makes node inaccessible, apart from already allocated vnodes
 293  * INVISIBLE    Makes node invisible in a readdir()
 294  */
 295 #define DEVFS_NODE_LINKED               0x001   /* Linked into topology */
 296 #define DEVFS_USER_CREATED              0x002   /* Node was user-created */
 297 #define DEVFS_ORPHANED                  0x004   /* on orphan list */
 298 #define DEVFS_CLONED                    0x008   /* Created by cloning code */
 299 #define DEVFS_HIDDEN                    0x010   /* Makes node inaccessible */
 300 #define DEVFS_INVISIBLE                 0x020   /* Makes node invisible */
 301 #define DEVFS_PTY                       0x040   /* PTY device */
 302 #define DEVFS_DESTROYED                 0x080   /* Sanity check */
 303 #define DEVFS_RULE_CREATED              0x100   /* Node was rule-created */
 304
 305
 306 /*
 307  * Clone helper stuff
 308  */
 309 #define DEVFS_BITMAP_INITIAL_SIZE       1
 310 #define DEVFS_CLONE_BITMAP(name)        devfs_ ## name ## _clone_bitmap
 311 #define DEVFS_DECLARE_CLONE_BITMAP(name) \
 312                                 struct devfs_bitmap DEVFS_CLONE_BITMAP(name)
 313 #define devfs_clone_bitmap_put          devfs_clone_bitmap_rst
 314
 315 struct devfs_bitmap {
 316         int             chunks;
 317         unsigned long   *bitmap;
 318 };
 319
 320 struct devfs_unit_hash {
 321         struct devfs_unit_hash *next;
 322         int             unit_no;
 323         cdev_t          dev;
 324 };
 325
 326 void devfs_clone_bitmap_init(struct devfs_bitmap *);
 327 void devfs_clone_bitmap_uninit(struct devfs_bitmap *);
 328 void devfs_clone_bitmap_resize(struct devfs_bitmap *, int);
 329 int devfs_clone_bitmap_fff(struct devfs_bitmap *);
 330 void devfs_clone_bitmap_set(struct devfs_bitmap *, int);
 331 void devfs_clone_bitmap_rst(struct devfs_bitmap *, int);
 332 int devfs_clone_bitmap_get(struct devfs_bitmap *, int);
 333 int devfs_clone_bitmap_chk(struct devfs_bitmap *, int);
 334
 335 /*
 336  * Prototypes
 337  */
 338 int devfs_debug(int level, char *fmt, ...);
 339 int devfs_allocv(struct vnode **, struct devfs_node *);
 340 struct devfs_node *devfs_allocp(devfs_nodetype, char *, struct devfs_node *,
 341                                 struct mount *, cdev_t);
 342 int devfs_allocvp(struct mount *, struct vnode **, devfs_nodetype, char *,
 343                                 struct devfs_node *, cdev_t);
 344
 345 int devfs_freep(struct devfs_node *);
 346
 347 int devfs_unlinkp(struct devfs_node *);
 348
 349 void devfs_tracer_add_orphan(struct devfs_node *);
 350 void devfs_tracer_del_orphan(struct devfs_node *);
 351 size_t devfs_tracer_orphan_count(struct mount *, int);
 352
 353 int devfs_set_perms(struct devfs_node *, uid_t, gid_t, u_short, u_long);
 354 int devfs_gc(struct devfs_node *);
 355
 356 int devfs_create_dev(cdev_t, uid_t, gid_t, int);
 357 int devfs_destroy_dev(cdev_t);
 358
 359 devfs_msg_t devfs_msg_send_sync(uint32_t, devfs_msg_t);
 360 void devfs_msg_send(uint32_t, devfs_msg_t);
 361 void devfs_msg_send_dev(uint32_t, cdev_t dev, uid_t, gid_t, int);
 362 void devfs_msg_send_mount(uint32_t, struct devfs_mnt_data *);
 363 void devfs_msg_send_ops(uint32_t, struct dev_ops *, int);
 364 void devfs_msg_send_chandler(uint32_t, char *, d_clone_t);
 365 void devfs_msg_send_generic(uint32_t, void *);
 366 void devfs_msg_send_name(uint32_t, char *);
 367 void devfs_msg_send_link(uint32_t, char *, char *, struct mount *);
 368
 369 devfs_msg_t devfs_msg_get(void);
 370 int devfs_msg_put(devfs_msg_t);
 371
 372 int devfs_mount_add(struct devfs_mnt_data *);
 373 int devfs_mount_del(struct devfs_mnt_data *);
 374
 375 int devfs_create_all_dev(struct devfs_node *);
 376
 377 struct devfs_node *devfs_resolve_or_create_path(
 378                                 struct devfs_node *, char *, int);
 379 int devfs_resolve_name_path(char *, char *, char **, char **);
 380 struct devfs_node *devfs_create_device_node(struct devfs_node *, cdev_t,
 381                                 char *, char *, ...);
 382
 383 int devfs_destroy_device_node(struct devfs_node *, cdev_t);
 384 int devfs_destroy_subnames(char *);
 385 int devfs_destroy_dev_by_ops(struct dev_ops *, int);
 386 struct devfs_node *devfs_find_device_node_by_name(struct devfs_node *, char *);
 387
 388 cdev_t devfs_new_cdev(struct dev_ops *, int);
 389
 390 cdev_t devfs_find_device_by_name(const char *, ...);
 391 cdev_t devfs_find_device_by_udev(udev_t);
 392
 393 struct vnode *devfs_inode_to_vnode(struct mount *, ino_t);
 394
 395 int devfs_clone_handler_add(const char *, d_clone_t *);
 396 int devfs_clone_handler_del(const char *);
 397 cdev_t devfs_clone(cdev_t, const char *, size_t, int, struct ucred *);
 398
 399 int devfs_link_dev(cdev_t);
 400
 401 int devfs_make_alias(const char *, cdev_t);
 402
 403 int devfs_alias_create(char *, struct devfs_node *, int);
 404
 405 int devfs_apply_rules(char *);
 406 int devfs_reset_rules(char *);
 407
 408 int devfs_scan_callback(devfs_scan_t *);
 409 int devfs_node_to_path(struct devfs_node *, char *);
 410
 411 int devfs_clr_subnames_flag(char *, uint32_t);
 412 int devfs_destroy_subnames_without_flag(char *, uint32_t);
 413 int devfs_node_is_accessible(struct devfs_node *);
 414
 415 int devfs_reference_ops(struct dev_ops *);
 416 void devfs_release_ops(struct dev_ops *);
 417
 418 void devfs_config(void);
 419
 420 void *devfs_iterate_topology(struct devfs_node *node,
 421                 devfs_iterate_callback_t *callback, void *arg1);
 422
 423 void *devfs_find_device_node_callback(struct devfs_node *, cdev_t);
 424
 425 #endif /* _VFS_DEVFS_H_ */