xref: /freebsd/sys/fs/devfs/devfs.h (revision ad30f8e79bd1007cc2476e491bd21b4f5e389e0a)
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 	int	dr_dswflags;			/* cdevsw flags to match. */
82 #define	DEVFS_MAXPTRNLEN	200
83 	char	dr_pathptrn[DEVFS_MAXPTRNLEN];	/* Pattern to match path. */
84 
85 	/*
86 	 * Things to change.  dr_iacts determines which of the other
87 	 * variables we should process.
88 	 */
89 	int	dr_iacts;
90 #define	DRA_BACTS	0x001
91 #define	DRA_UID		0x002
92 #define	DRA_GID		0x004
93 #define	DRA_MODE	0x008
94 #define	DRA_INCSET	0x010
95 	int	dr_bacts;			/* Boolean (on/off) action. */
96 #define	DRB_HIDE	0x001			/* Hide entry (DE_WHITEOUT). */
97 #define	DRB_UNHIDE	0x002			/* Unhide entry. */
98 	uid_t	dr_uid;
99 	gid_t	dr_gid;
100 	mode_t	dr_mode;
101 	devfs_rsnum dr_incset;			/* Included ruleset. */
102 };
103 
104 /*
105  * Rule-related ioctls.
106  */
107 #define	DEVFSIO_RADD		_IOWR('D', 0, struct devfs_rule)
108 #define	DEVFSIO_RDEL		_IOW('D', 1, devfs_rid)
109 #define	DEVFSIO_RAPPLY		_IOW('D', 2, struct devfs_rule)
110 #define	DEVFSIO_RAPPLYID	_IOW('D', 3, devfs_rid)
111 #define	DEVFSIO_RGETNEXT       	_IOWR('D', 4, struct devfs_rule)
112 
113 #define	DEVFSIO_SUSE		_IOW('D', 10, devfs_rsnum)
114 #define	DEVFSIO_SAPPLY		_IOW('D', 11, devfs_rsnum)
115 #define	DEVFSIO_SGETNEXT	_IOWR('D', 12, devfs_rsnum)
116 
117 /* XXX: DEVFSIO_RS_GET_INFO for refcount, active if any, etc. */
118 
119 #ifdef _KERNEL
120 
121 #ifdef MALLOC_DECLARE
122 MALLOC_DECLARE(M_DEVFS);
123 #endif
124 
125 struct componentname;
126 
127 TAILQ_HEAD(devfs_dlist_head, devfs_dirent);
128 
129 struct devfs_dirent {
130 	struct cdev_priv	*de_cdp;
131 	int			de_inode;
132 	int			de_flags;
133 #define	DE_WHITEOUT	0x01
134 #define	DE_DOT		0x02
135 #define	DE_DOTDOT	0x04
136 #define	DE_DOOMED	0x08
137 #define	DE_COVERED	0x10
138 #define	DE_USER		0x20
139 	int			de_holdcnt;
140 	struct dirent 		*de_dirent;
141 	TAILQ_ENTRY(devfs_dirent) de_list;
142 	struct devfs_dlist_head	de_dlist;
143 	struct devfs_dirent	*de_dir;
144 	int			de_links;
145 	mode_t			de_mode;
146 	uid_t			de_uid;
147 	gid_t			de_gid;
148 	struct label		*de_label;
149 	struct timespec 	de_atime;
150 	struct timespec 	de_mtime;
151 	struct timespec 	de_ctime;
152 	struct vnode 		*de_vnode;
153 	char 			*de_symlink;
154 };
155 
156 struct devfs_mount {
157 	u_int			dm_idx;
158 	struct mount		*dm_mount;
159 	struct devfs_dirent	*dm_rootdir;
160 	unsigned		dm_generation;
161 	int			dm_holdcnt;
162 	struct sx		dm_lock;
163 	devfs_rsnum		dm_ruleset;
164 };
165 
166 #define DEVFS_ROOTINO 2
167 
168 extern unsigned devfs_rule_depth;
169 
170 #define VFSTODEVFS(mp)	((struct devfs_mount *)((mp)->mnt_data))
171 
172 #define DEVFS_DE_HOLD(de)	((de)->de_holdcnt++)
173 #define DEVFS_DE_DROP(de)	(--(de)->de_holdcnt == 0)
174 
175 #define DEVFS_DMP_HOLD(dmp)	((dmp)->dm_holdcnt++)
176 #define DEVFS_DMP_DROP(dmp)	(--(dmp)->dm_holdcnt == 0)
177 
178 #define	DEVFS_DEL_VNLOCKED	0x01
179 #define	DEVFS_DEL_NORECURSE	0x02
180 
181 void	devfs_rules_apply(struct devfs_mount *, struct devfs_dirent *);
182 void	devfs_rules_cleanup(struct devfs_mount *);
183 int	devfs_rules_ioctl(struct devfs_mount *, u_long, caddr_t,
184 	    struct thread *);
185 int	devfs_allocv(struct devfs_dirent *, struct mount *, int,
186 	    struct vnode **);
187 char	*devfs_fqpn(char *, struct devfs_mount *, struct devfs_dirent *,
188 	    struct componentname *);
189 void	devfs_delete(struct devfs_mount *, struct devfs_dirent *, int);
190 void	devfs_dirent_free(struct devfs_dirent *);
191 void	devfs_populate(struct devfs_mount *);
192 void	devfs_cleanup(struct devfs_mount *);
193 void	devfs_unmount_final(struct devfs_mount *);
194 struct devfs_dirent	*devfs_newdirent(char *, int);
195 struct devfs_dirent	*devfs_parent_dirent(struct devfs_dirent *);
196 struct devfs_dirent	*devfs_vmkdir(struct devfs_mount *, char *, int,
197 			    struct devfs_dirent *, u_int);
198 struct devfs_dirent	*devfs_find(struct devfs_dirent *, const char *, int,
199 			    int);
200 
201 #endif /* _KERNEL */
202 
203 #endif /* !_FS_DEVFS_DEVFS_H_ */
204