devfs.h revision 191990
150477Speter/*- 281077Speter * Copyright (c) 1992, 1993 341199Skato * The Regents of the University of California. All rights reserved. 433080Skato * Copyright (c) 2000 516359Sasami * Poul-Henning Kamp. All rights reserved. 616359Sasami * Copyright (c) 2002 734458Skato * Dima Dorfman. All rights reserved. 855966Skato * 944082Skato * This code is derived from software donated to Berkeley by 1029006Skato * Jan-Simon Pendry. 1129006Skato * 1229006Skato * Redistribution and use in source and binary forms, with or without 1316359Sasami * modification, are permitted provided that the following conditions 1432939Skato * are met: 1516359Sasami * 1. Redistributions of source code must retain the above copyright 1616359Sasami * notice, this list of conditions and the following disclaimer. 1726477Skato * 2. Neither the name of the University nor the names of its contributors 1832092Skato * may be used to endorse or promote products derived from this software 1927844Skato * without specific prior written permission. 2027844Skato * 2158287Speter * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 2261628Skato * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2383366Sjulian * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2417256Sasami * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2555656Sbde * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2655656Sbde * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2755656Sbde * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2855656Sbde * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2955656Sbde * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 3055656Sbde * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3155656Sbde * SUCH DAMAGE. 3270264Skato * 3370264Skato * @(#)kernfs.h 8.6 (Berkeley) 3/29/95 3441975Skato * From: FreeBSD: src/sys/miscfs/kernfs/kernfs.h 1.14 3525572Skato * 3625195Skato * $FreeBSD: head/sys/fs/devfs/devfs.h 191990 2009-05-11 15:33:26Z attilio $ 3783757Speter */ 3883757Speter 3983757Speter#ifndef _FS_DEVFS_DEVFS_H_ 4033080Skato#define _FS_DEVFS_DEVFS_H_ 4133080Skato 4233080Skato#define DEVFS_MAGIC 0xdb0a087a 4344633Skato 4418208Sasami/* 4531556Skato * Identifiers. The ruleset and rule numbers are 16-bit values. The 4627392Skato * "rule ID" is a combination of the ruleset and rule number; it 4727392Skato * should be able to univocally describe a rule in the system. In 4833019Skato * this implementation, the upper 16 bits of the rule ID is the 4947976Skato * ruleset number; the lower 16 bits, the rule number within the 5027391Skato * aforementioned ruleset. 5133019Skato */ 5233019Skatotypedef uint16_t devfs_rnum; 5333019Skatotypedef uint16_t devfs_rsnum; 5433019Skatotypedef uint32_t devfs_rid; 5561616Skato 5633019Skato/* 5761616Skato * Identifier manipulators. 5833019Skato */ 5933019Skato#define rid2rsn(rid) ((rid) >> 16) 6033019Skato#define rid2rn(rid) ((rid) & 0xffff) 6140003Skato#define mkrid(rsn, rn) ((rn) | ((rsn) << 16)) 6233019Skato 6333019Skato/* 6442163Skato * Plain DEVFS rule. This gets shared between kernel and userland 6579699Snyan * verbatim, so it shouldn't contain any pointers or other kernel- or 6690590Sdwmalone * userland-specific values. 6719122Sasami */ 6829006Skatostruct devfs_rule { 6929006Skato uint32_t dr_magic; /* Magic number. */ 7029006Skato devfs_rid dr_id; /* Identifier. */ 7129006Skato 7229006Skato /* 7329006Skato * Conditions under which this rule should be applied. These 7418265Sasami * are ANDed together since OR can be simulated by using 7548175Skato * multiple rules. dr_icond determines which of the other 7685147Snyan * variables we should process. 7785147Snyan */ 7848175Skato int dr_icond; 7948175Skato#define DRC_DSWFLAGS 0x001 8048175Skato#define DRC_PATHPTRN 0x002 8148175Skato int dr_dswflags; /* cdevsw flags to match. */ 8229137Skato#define DEVFS_MAXPTRNLEN 200 8353053Snyan char dr_pathptrn[DEVFS_MAXPTRNLEN]; /* Pattern to match path. */ 8453053Snyan 8533270Skato /* 8648175Skato * Things to change. dr_iacts determines which of the other 8748175Skato * variables we should process. 8848175Skato */ 8948175Skato int dr_iacts; 9053053Snyan#define DRA_BACTS 0x001 9153053Snyan#define DRA_UID 0x002 9248175Skato#define DRA_GID 0x004 9348175Skato#define DRA_MODE 0x008 9453053Snyan#define DRA_INCSET 0x010 9518208Sasami int dr_bacts; /* Boolean (on/off) action. */ 9642795Skato#define DRB_HIDE 0x001 /* Hide entry (DE_WHITEOUT). */ 9742795Skato#define DRB_UNHIDE 0x002 /* Unhide entry. */ 9854880Skato uid_t dr_uid; 9927173Skato gid_t dr_gid; 10021773Skato mode_t dr_mode; 10121773Skato devfs_rsnum dr_incset; /* Included ruleset. */ 10290761Snyan}; 10390761Snyan 10444635Skato/* 10542795Skato * Rule-related ioctls. 10642795Skato */ 10742795Skato#define DEVFSIO_RADD _IOWR('D', 0, struct devfs_rule) 10842795Skato#define DEVFSIO_RDEL _IOW('D', 1, devfs_rid) 10942795Skato#define DEVFSIO_RAPPLY _IOW('D', 2, struct devfs_rule) 11021773Skato#define DEVFSIO_RAPPLYID _IOW('D', 3, devfs_rid) 11123847Skato#define DEVFSIO_RGETNEXT _IOWR('D', 4, struct devfs_rule) 11229533Skato 11342283Skato#define DEVFSIO_SUSE _IOW('D', 10, devfs_rsnum) 11442283Skato#define DEVFSIO_SAPPLY _IOW('D', 11, devfs_rsnum) 11542283Skato#define DEVFSIO_SGETNEXT _IOWR('D', 12, devfs_rsnum) 11642283Skato 11742283Skato/* XXX: DEVFSIO_RS_GET_INFO for refcount, active if any, etc. */ 11842283Skato 11942283Skato#ifdef _KERNEL 12042283Skato 12142283Skato#ifdef MALLOC_DECLARE 12242283SkatoMALLOC_DECLARE(M_DEVFS); 12342283Skato#endif 12442283Skato 12558887Skatostruct devfs_dirent { 12642283Skato struct cdev_priv *de_cdp; 12738225Skato int de_inode; 12838225Skato int de_flags; 12949522Skato#define DE_WHITEOUT 0x1 13042163Skato#define DE_DOT 0x2 13142163Skato#define DE_DOTDOT 0x4 13242163Skato#define DE_DOOMED 0x8 13342163Skato int de_holdcnt; 13442163Skato struct dirent *de_dirent; 13542163Skato TAILQ_ENTRY(devfs_dirent) de_list; 13642163Skato TAILQ_HEAD(, devfs_dirent) de_dlist; 13742163Skato struct devfs_dirent *de_dir; 13866916Skato int de_links; 13949522Skato mode_t de_mode; 14042163Skato uid_t de_uid; 14142163Skato gid_t de_gid; 14242163Skato struct label *de_label; 14342163Skato struct timespec de_atime; 14442163Skato struct timespec de_mtime; 14542163Skato struct timespec de_ctime; 14642163Skato struct vnode *de_vnode; 14766916Skato char *de_symlink; 14849522Skato}; 14942163Skato 15049522Skatostruct devfs_mount { 15175051Snyan u_int dm_idx; 15288389Snyan struct mount *dm_mount; 15342163Skato struct devfs_dirent *dm_rootdir; 15442163Skato unsigned dm_generation; 15542163Skato int dm_holdcnt; 15642163Skato struct sx dm_lock; 15742163Skato devfs_rsnum dm_ruleset; 15842163Skato}; 15942163Skato 16042163Skato#define DEVFS_ROOTINO 2 16142163Skato 16242163Skatoextern unsigned devfs_rule_depth; 16342163Skato 16454880Skato#define VFSTODEVFS(mp) ((struct devfs_mount *)((mp)->mnt_data)) 16549522Skato 16644825Skato#define DEVFS_DE_HOLD(de) ((de)->de_holdcnt++) 16744825Skato#define DEVFS_DE_DROP(de) (--(de)->de_holdcnt == 0) 16844825Skato 16944825Skato#define DEVFS_DMP_HOLD(dmp) ((dmp)->dm_holdcnt++) 17033715Skato#define DEVFS_DMP_DROP(dmp) (--(dmp)->dm_holdcnt == 0) 17133715Skato 17236690Skatovoid devfs_rules_apply(struct devfs_mount *dm, struct devfs_dirent *de); 17333715Skatovoid devfs_rules_cleanup (struct devfs_mount *dm); 17479697Snonint devfs_rules_ioctl(struct devfs_mount *dm, u_long cmd, caddr_t data, struct thread *td); 17579697Snonint devfs_allocv (struct devfs_dirent *de, struct mount *mp, 17679697Snon struct vnode **vpp); 17779697Snonvoid devfs_delete(struct devfs_mount *dm, struct devfs_dirent *de, int vp_locked); 17834405Skatovoid devfs_dirent_free(struct devfs_dirent *de); 17934405Skatovoid devfs_populate (struct devfs_mount *dm); 18034405Skatovoid devfs_cleanup (struct devfs_mount *dm); 18133715Skatovoid devfs_unmount_final(struct devfs_mount *mp); 18233715Skatostruct devfs_dirent *devfs_newdirent (char *name, int namelen); 18334643Skatostruct devfs_dirent *devfs_vmkdir (struct devfs_mount *, char *name, int namelen, struct devfs_dirent *dotdot, u_int inode); 18433715Skatostruct devfs_dirent *devfs_find (struct devfs_dirent *dd, const char *name, int namelen); 18539347Skato 18659780Snyan#endif /* _KERNEL */ 18771262Speter 18871257Speter#endif /* !_FS_DEVFS_DEVFS_H_ */ 18981050Syokota