1/*
2 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28/*
29 * Copyright 1997,1998 Julian Elischer. All rights reserved.
30 * julian@freebsd.org
31 *
32 * Redistribution and use in source and binary forms, with or without
33 * modification, are permitted provided that the following conditions are
34 * met:
35 * 1. Redistributions of source code must retain the above copyright
36 * notice, this list of conditions and the following disclaimer.
37 * 2. Redistributions in binary form must reproduce the above copyright notice,
38 * this list of conditions and the following disclaimer in the documentation
39 * and/or other materials provided with the distribution.
40 *
41 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS
42 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
43 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE HOLDER OR CONTRIBUTORS BE LIABLE FOR
45 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
47 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
48 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51 * SUCH DAMAGE.
52 *
53 * devfsdefs.h
54 */
55/*
56 * NOTICE: This file was modified by McAfee Research in 2004 to introduce
57 * support for mandatory and extensible security protections. This notice
58 * is included in support of clause 2.2 (b) of the Apple Public License,
59 * Version 2.0.
60 */
61
62/*
63 * HISTORY
64 * 8-April-1999 Dieter Siegmund (dieter@apple.com)
65 * Ported to from FreeBSD 3.1
66 * Removed unnecessary/unused defines
67 * Renamed structures/elements to clarify usage in code.
68 */
69
70#ifndef __DEVFS_DEVFSDEFS_H__
71#define __DEVFS_DEVFSDEFS_H__
72
73#include <sys/appleapiopts.h>
74
75__BEGIN_DECLS
76#ifdef __APPLE_API_PRIVATE
77#define DEVMAXNAMESIZE 32 /* XXX */
78#define DEVMAXPATHSIZE 128 /* XXX */
79
80typedef enum {
81 DEV_DIR,
82 DEV_BDEV,
83 DEV_CDEV,
84 DEV_SLNK,
85#if FDESC
86 DEV_DEVFD
87#endif /* FDESC */
88} devfstype_t;
89
90extern int (**devfs_vnodeop_p)(void *); /* our own vector array for dirs */
91extern int (**devfs_spec_vnodeop_p)(void *); /* our own vector array for devs */
92extern struct vfsops devfs_vfsops;
93
94typedef struct devnode devnode_t;
95typedef struct devdirent devdirent_t;
96typedef union devnode_type devnode_type_t;
97
98struct devfs_stats {
99 int nodes;
100 int entries;
101 int mounts;
102 int stringspace;
103};
104
105union devnode_type {
106 dev_t dev;
107 struct {
108 devdirent_t * dirlist;
109 devdirent_t * * dirlast;
110 devnode_t * parent;
111 devdirent_t * myname; /* my entry in .. */
112 int entrycount;
113 }Dir;
114 struct {
115 char * name; /* must be allocated separately */
116 int namelen;
117 }Slnk;
118};
119
120#define DEV_MAX_VNODE_RETRY 8 /* Max number of retries when we try to
121 get a vnode for the devnode */
122struct devnode
123{
124 devfstype_t dn_type;
125 /*
126 * Number of vnodes that point to this devnode. Note, we do not
127 * add another reference for a lookup which finds an existing
128 * vnode; a reference is added when a vnode is created and removed
129 * when a vnode is reclaimed. A devnode will not be freed while
130 * there are outstanding references. A refcount can be added to
131 * prevent the free of a devnode in situations where there is not
132 * guaranteed to be a vnode holding a ref, but it is important to
133 * make sure that a deferred delete eventually happens if it is
134 * blocked behind that reference.
135 */
136 int dn_refcount;
137 u_short dn_mode;
138 uid_t dn_uid;
139 gid_t dn_gid;
140 struct timespec dn_atime;/* time of last access */
141 struct timespec dn_mtime;/* time of last modification */
142 struct timespec dn_ctime;/* time file changed */
143 int (***dn_ops)(void *);/* yuk... pointer to pointer(s) to funcs */
144 int dn_links;/* how many file links does this node have? */
145 struct devfsmount * dn_dvm; /* the mount structure for this 'plane' */
146 struct vnode * dn_vn; /* address of last vnode that represented us */
147 int dn_len; /* of any associated info (e.g. dir data) */
148 devdirent_t * dn_linklist;/* circular list of hardlinks to this node */
149 devnode_t * dn_nextsibling; /* the list of equivalent nodes */
150 devnode_t * * dn_prevsiblingp;/* backpointer for the above */
151 devnode_type_t dn_typeinfo;
152 int dn_change;
153 int dn_update;
154 int dn_access;
155 int dn_lflags;
156 ino_t dn_ino;
157 int (*dn_clone)(dev_t dev, int action); /* get minor # */
158 struct label * dn_label; /* security label */
159};
160
161#define DN_DELETE 0x02
162#define DN_CREATE 0x04
163#define DN_CREATEWAIT 0x08
164
165
166struct devdirent
167{
168 /*-----------------------directory entry fields-------------*/
169 char de_name[DEVMAXNAMESIZE];
170 devnode_t * de_dnp; /* the "inode" (devnode) pointer */
171 devnode_t * de_parent; /* backpointer to the directory itself */
172 devdirent_t * de_next; /* next object in this directory */
173 devdirent_t * *de_prevp; /* previous pointer in directory linked list */
174 devdirent_t * de_nextlink; /* next hardlink to this node */
175 devdirent_t * *de_prevlinkp; /* previous hardlink pointer for this node */
176};
177
178extern devdirent_t * dev_root;
179extern struct devfs_stats devfs_stats;
180extern lck_mtx_t devfs_mutex;
181extern lck_mtx_t devfs_attr_mutex;
182
183/*
184 * Rules for front nodes:
185 * Dirs hava a strict 1:1 relationship with their OWN devnode
186 * Symlinks similarly
187 * Device Nodes ALWAYS point to the devnode that is linked
188 * to the Backing node. (with a ref count)
189 */
190
191/*
192 * DEVFS specific per/mount information, used to link a monted fs to a
193 * particular 'plane' of front nodes.
194 */
195struct devfsmount
196{
197 struct mount * mount; /* vfs mount struct for this fs */
198 devdirent_t * plane_root;/* the root of this 'plane' */
199};
200
201/*
202 * Prototypes for DEVFS virtual filesystem operations
203 */
204#include <sys/lock.h>
205#include <miscfs/devfs/devfs_proto.h>
206#include <libkern/OSAtomic.h> /* required for OSAddAtomic() */
207
208//#define HIDDEN_MOUNTPOINT 1
209
210/* misc */
211#define M_DEVFSNAME M_DEVFS
212#define M_DEVFSNODE M_DEVFS
213#define M_DEVFSMNT M_DEVFS
214
215#define VTODN(vp) ((devnode_t *)(vp)->v_data)
216
217#define DEVFS_LOCK() lck_mtx_lock(&devfs_mutex)
218#define DEVFS_UNLOCK() lck_mtx_unlock(&devfs_mutex)
219
220#define DEVFS_ATTR_LOCK_SPIN() lck_mtx_lock_spin(&devfs_attr_mutex);
221#define DEVFS_ATTR_UNLOCK() lck_mtx_unlock(&devfs_attr_mutex);
222
223/*
224 * XXX all the (SInt32 *) casts below assume sizeof(int) == sizeof(long)
225 */
226static __inline__ void
227DEVFS_INCR_ENTRIES(void)
228{
229 OSAddAtomic(1, &devfs_stats.entries);
230}
231
232static __inline__ void
233DEVFS_DECR_ENTRIES(void)
234{
235 OSAddAtomic(-1, &devfs_stats.entries);
236}
237
238static __inline__ void
239DEVFS_INCR_NODES(void)
240{
241 OSAddAtomic(1, &devfs_stats.nodes);
242}
243
244static __inline__ void
245DEVFS_DECR_NODES(void)
246{
247 OSAddAtomic(-1, &devfs_stats.nodes);
248}
249
250static __inline__ void
251DEVFS_INCR_MOUNTS(void)
252{
253 OSAddAtomic(1, &devfs_stats.mounts);
254}
255
256static __inline__ void
257DEVFS_DECR_MOUNTS(void)
258{
259 OSAddAtomic(-1, &devfs_stats.mounts);
260}
261
262static __inline__ void
263DEVFS_INCR_STRINGSPACE(int space)
264{
265 OSAddAtomic(space, &devfs_stats.stringspace);
266}
267
268static __inline__ void
269DEVFS_DECR_STRINGSPACE(int space)
270{
271 OSAddAtomic(-space, &devfs_stats.stringspace);
272}
273
274/*
275 * Access, change, and modify times are protected by a separate lock,
276 * which allows tty times to be updated (no more than once per second)
277 * in the I/O path without too much fear of contention.
278 *
279 * For getattr, update times to current time if the last update was recent;
280 * preserve legacy behavior that frequent stats can yield sub-second resolutions.
281 * If the last time is old, however, we know that the event that triggered
282 * the need for an update was no more than 1s after the last update. In that case,
283 * use (last update + 1s) as the time, avoiding the illusion that last update happened
284 * much later than it really did.
285 */
286#define DEVFS_LAZY_UPDATE_SECONDS 1
287
288#define DEVFS_UPDATE_CHANGE 0x1
289#define DEVFS_UPDATE_MOD 0x2
290#define DEVFS_UPDATE_ACCESS 0x4
291
292static __inline__ void
293dn_copy_times(devnode_t * target, devnode_t * source)
294{
295 DEVFS_ATTR_LOCK_SPIN();
296 target->dn_atime = source->dn_atime;
297 target->dn_mtime = source->dn_mtime;
298 target->dn_ctime = source->dn_ctime;
299 DEVFS_ATTR_UNLOCK();
300 return;
301}
302
303#ifdef BSD_KERNEL_PRIVATE
304int devfs_make_symlink(devnode_t *dir_p, char *name, int mode, char *target, devdirent_t **newent);
305#endif /* BSD_KERNEL_PRIVATE */
306
307#endif /* __APPLE_API_PRIVATE */
308
309__END_DECLS
310
311#endif /* __DEVFS_DEVFSDEFS_H__ */
312