2 * Copyright (c) 2013 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Antonio Huete Jimenez <tuxillo@quantumachine.net>
6 * by Matthew Dillon <dillon@dragonflybsd.org>
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
18 * 3. Neither the name of The DragonFly Project nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific, prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
28 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
30 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
31 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
32 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 #ifndef _SYS_VFS_DIRFS_DIRFS_H_
38 #define _SYS_VFS_DIRFS_DIRFS_H_
42 #include <sys/lockf.h>
44 #include <sys/vnode.h>
46 MALLOC_DECLARE(M_DIRFS);
47 MALLOC_DECLARE(M_DIRFS_NODE);
48 MALLOC_DECLARE(M_DIRFS_MISC);
51 #define KTR_DIRFS KTR_ALL
54 #define DIRFS_NOFD -1 /* No fd present */
56 #define DIRFS_ROOT 0x00000001
57 #define DIRFS_PASVFD 0x00000002
58 #define DIRFS_NODE_RD 0x00000004
59 #define DIRFS_NODE_WR 0x00000008
60 #define DIRFS_NODE_EXE 0x00000010
62 #define DIRFS_TXTFLG "pasvfd"
64 /* Used for buffer cache operations */
66 #define BMASK (BSIZE - 1)
69 * XXX This should be temporary. A semi-proper solution would be to expose
70 * below prototypes in the _KERNEL_VIRTUAL case.
72 extern int getdirentries(int, char *, int, long *);
73 extern int statfs(const char *, struct statfs *);
80 * 1 Calls to VFS operations (mount, umount, ...)
81 * 3 Calls to VN operations (open, close, read, ...)
82 * 5 Calls to subroutines
86 #define dbg(lvl, fmt, ...) do { \
87 debug(lvl, "%s: " fmt, __func__, ##__VA_ARGS__); \
90 #define debug_node(s) do { \
91 dbg(9, "mode=%u flags=%u dn_name=%s " \
92 "uid=%u gid=%u objtype=%u nlinks=%d " \
93 "size=%jd ctime=%ju atime=%ju mtime=%ju\n", \
94 s->dn_mode, s->dn_flags, s->dn_name, \
95 s->dn_uid, s->dn_gid, s->dn_type, \
96 s->dn_links, s->dn_size, \
97 s->dn_ctime, s->dn_atime, \
101 #define debug_node2(n) do { \
102 dbg(9, "dnp=%p name=%s fd=%d parent=%p vnode=%p " \
103 "refcnt=%d state=%s\n", \
104 n, n->dn_name, n->dn_fd, n->dn_parent, n->dn_vnode, \
105 n->dn_refcnt, dirfs_flag2str(n)); \
111 #define dirfs_node_islocked(n) (lockstatus(&(n)->dn_lock,curthread) == LK_EXCLUSIVE)
112 #define dirfs_node_lock(n) lockmgr(&(n)->dn_lock, LK_EXCLUSIVE|LK_RETRY)
113 #define dirfs_node_unlock(n) lockmgr(&(n)->dn_lock, LK_RELEASE)
114 #define dirfs_mount_lock(m) lockmgr(&(m)->dm_lock, LK_EXCLUSIVE|LK_RETRY)
115 #define dirfs_mount_unlock(m) lockmgr(&(m)->dm_lock, LK_RELEASE)
116 #define dirfs_mount_gettoken(m) lwkt_gettoken(&(m)->dm_token)
117 #define dirfs_mount_reltoken(m) lwkt_reltoken(&(m)->dm_token)
122 #define dirfs_node_isroot(n) (n->dn_state & DIRFS_ROOT)
125 * Main in-memory node structure which will represent a host file when active.
126 * Upon VOP_NRESOLVE() an attempt to initialize its generic fields will be made
127 * via a fstatat(2)/lstat(2) call.
130 enum vtype dn_type; /* Node type. Same as vnode
131 type for simplicty */
133 int dn_state; /* Node state flags */
135 TAILQ_ENTRY(dirfs_node) dn_fdentry; /* Passive fd cache */
136 RB_ENTRY(dirfs_node) dn_rbentry; /* Inode no. lookup */
138 int dn_refcnt; /* Refs from children */
139 int dn_fd; /* File des. for open(2) */
141 struct dirfs_node * dn_parent; /* Pointer to parent node */
143 struct vnode * dn_vnode; /* Reference to its vnode on
148 struct lockf dn_advlock;
151 uint32_t dn_st_dev; /* Device number */
153 /* Generic attributes */
162 int32_t dn_atimensec;
164 int32_t dn_mtimensec;
166 int32_t dn_ctimensec;
167 unsigned long dn_gen;
170 typedef struct dirfs_node *dirfs_node_t;
173 * In-memory dirfs mount structure. It corresponds to a mounted
177 RB_HEAD(, dn_rbentry) dm_inotree;
178 TAILQ_HEAD(, dirfs_node) dm_fdlist;
181 struct lwkt_token dm_token;
182 dirfs_node_t dm_root; /* Root dirfs node */
183 struct mount * dm_mount;
186 int dm_fd_used; /* Opened file descriptors */
188 uid_t dm_uid; /* User running the vkernel */
191 char dm_path[MAXPATHLEN];
193 typedef struct dirfs_mount *dirfs_mount_t;
196 * VFS <-> DIRFS conversion macros
198 #define VFS_TO_DIRFS(mp) ((dirfs_mount_t)((mp)->mnt_data))
199 #define DIRFS_TO_VFS(dmp) ((struct mount *)((dmp)->dm_mount))
200 #define VP_TO_NODE(vp) ((dirfs_node_t)((vp)->v_data))
201 #define NODE_TO_VP(dnp) ((dnp)->dn_vnode)
205 extern int dirfs_fd_limit;
206 extern int dirfs_fd_used;
207 extern long passive_fd_list_miss;
208 extern long passive_fd_list_hits;
210 extern struct vop_ops dirfs_vnode_vops;
214 * Misc functions for node operations
217 dirfs_node_ref(dirfs_node_t dnp)
219 atomic_add_int(&dnp->dn_refcnt, 1);
223 dirfs_node_unref(dirfs_node_t dnp)
226 * Returns non-zero on last unref.
228 KKASSERT(dnp->dn_refcnt > 0);
229 return (atomic_fetchadd_int(&dnp->dn_refcnt, -1) == 1);
233 dirfs_node_setflags(dirfs_node_t dnp, int flags)
235 atomic_set_int(&dnp->dn_state, flags);
239 dirfs_node_clrflags(dirfs_node_t dnp, int flags)
241 atomic_clear_int(&dnp->dn_state, flags);
249 dirfs_node_t dirfs_node_alloc(struct mount *);
250 int dirfs_node_stat(int, const char *, dirfs_node_t);
251 int dirfs_nodetype(struct stat *);
252 void dirfs_node_setname(dirfs_node_t, const char *, int);
253 char *dirfs_node_fullpath(dirfs_mount_t, const char *);
254 int dirfs_node_free(dirfs_mount_t, dirfs_node_t);
255 void dirfs_node_drop(dirfs_mount_t dmp, dirfs_node_t dnp);
256 void dirfs_node_setpassive(dirfs_mount_t dmp, dirfs_node_t dnp, int state);
257 void dirfs_alloc_vp(struct mount *, struct vnode **, int, dirfs_node_t);
258 void dirfs_free_vp(dirfs_mount_t, dirfs_node_t);
259 int dirfs_alloc_file(dirfs_mount_t, dirfs_node_t *, dirfs_node_t,
260 struct namecache *, struct vnode **, struct vattr *, int);
261 dirfs_node_t dirfs_findfd(dirfs_mount_t dmp, dirfs_node_t cur,
262 char **pathto, char **pathfree);
263 void dirfs_dropfd(dirfs_mount_t dmp, dirfs_node_t dnp1, char *pathfree);
264 char *dirfs_node_absolute_path(dirfs_mount_t, dirfs_node_t, char **);
265 char *dirfs_node_absolute_path_plus(dirfs_mount_t, dirfs_node_t,
267 int dirfs_open_helper(dirfs_mount_t, dirfs_node_t, int, char *);
268 int dirfs_close_helper(dirfs_node_t);
269 int dirfs_node_refcnt(dirfs_node_t);
270 char *dirfs_flag2str(dirfs_node_t);
271 int dirfs_node_getperms(dirfs_node_t, int *);
272 int dirfs_node_chflags(dirfs_node_t, int, struct ucred *);
273 int dirfs_node_chtimes(dirfs_node_t);
274 int dirfs_node_chmod(dirfs_mount_t, dirfs_node_t, mode_t cur_mode);
275 int dirfs_node_chown(dirfs_mount_t, dirfs_node_t,
276 uid_t cur_uid, uid_t cur_gid, mode_t cur_mode);
277 int dirfs_node_chsize(dirfs_node_t, off_t);
278 void debug(int, const char *, ...);
280 #endif /* _SYS_VFS_DIRFS_DIRFS_H_ */