4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
30 #pragma ident "%Z%%M% %I% %E% SMI"
32 #include <sys/types.h>
33 #include <sys/vnode.h>
34 #include <sys/mutex.h>
35 #include <sys/dirent.h>
36 #include <sys/extdirent.h>
44 #define GFS_CACHE_VNODE 0x1
46 typedef struct gfs_dirent {
47 char *gfse_name; /* entry name */
48 vnode_t *(*gfse_ctor)(vnode_t *); /* constructor */
49 int gfse_flags; /* flags */
50 list_node_t gfse_link; /* dynamic list */
51 vnode_t *gfse_vnode; /* cached vnode */
54 typedef enum gfs_type {
59 typedef struct gfs_file {
60 vnode_t *gfs_vnode; /* current vnode */
61 vnode_t *gfs_parent; /* parent vnode */
62 size_t gfs_size; /* size of private data structure */
63 gfs_type_t gfs_type; /* type of vnode */
64 int gfs_index; /* index in parent dir */
65 ino64_t gfs_ino; /* inode for this vnode */
68 typedef int (*gfs_readdir_cb)(vnode_t *, void *, int *, offset_t *,
69 offset_t *, void *, int);
70 typedef int (*gfs_lookup_cb)(vnode_t *, const char *, vnode_t **, ino64_t *,
71 cred_t *, int, int *, pathname_t *);
72 typedef ino64_t (*gfs_inode_cb)(vnode_t *, int);
74 typedef struct gfs_dir {
75 gfs_file_t gfsd_file; /* generic file attributes */
76 gfs_dirent_t *gfsd_static; /* statically defined entries */
77 int gfsd_nstatic; /* # static entries */
78 kmutex_t gfsd_lock; /* protects entries */
79 int gfsd_maxlen; /* maximum name length */
80 gfs_readdir_cb gfsd_readdir; /* readdir() callback */
81 gfs_lookup_cb gfsd_lookup; /* lookup() callback */
82 gfs_inode_cb gfsd_inode; /* get an inode number */
87 extern vnode_t *gfs_file_create(size_t, vnode_t *, vfs_t *, vnodeops_t *);
88 extern vnode_t *gfs_dir_create(size_t, vnode_t *, vfs_t *, vnodeops_t *,
89 gfs_dirent_t *, gfs_inode_cb, int, gfs_readdir_cb, gfs_lookup_cb);
90 extern vnode_t *gfs_root_create(size_t, vfs_t *, vnodeops_t *, ino64_t,
91 gfs_dirent_t *, gfs_inode_cb, int, gfs_readdir_cb, gfs_lookup_cb);
92 extern vnode_t *gfs_root_create_file(size_t, struct vfs *, vnodeops_t *,
95 extern void *gfs_file_inactive(vnode_t *);
96 extern void *gfs_dir_inactive(vnode_t *);
98 extern int gfs_dir_case_lookup(vnode_t *, const char *, vnode_t **, cred_t *,
99 int, int *, pathname_t *);
100 extern int gfs_dir_lookup(vnode_t *, const char *, vnode_t **, cred_t *,
101 int, int *, pathname_t *);
102 extern int gfs_vop_lookup(vnode_t *, char *, vnode_t **, pathname_t *,
103 int, vnode_t *, cred_t *, caller_context_t *, int *, pathname_t *);
104 extern int gfs_dir_readdir(vnode_t *, uio_t *, int *, int *, u_long **, void *,
105 cred_t *, int flags);
107 #define gfs_dir_lock(gd) mutex_enter(&(gd)->gfsd_lock)
108 #define gfs_dir_unlock(gd) mutex_exit(&(gd)->gfsd_lock)
109 #define GFS_DIR_LOCKED(gd) MUTEX_HELD(&(gd)->gfsd_lock)
111 #define gfs_file_parent(vp) (((gfs_file_t *)(vp)->v_data)->gfs_parent)
113 #define gfs_file_index(vp) (((gfs_file_t *)(vp)->v_data)->gfs_index)
114 #define gfs_file_set_index(vp, idx) \
115 (((gfs_file_t *)(vp)->v_data)->gfs_index = (idx))
117 #define gfs_file_inode(vp) (((gfs_file_t *)(vp)->v_data)->gfs_ino)
118 #define gfs_file_set_inode(vp, ino) \
119 (((gfs_file_t *)(vp)->v_data)->gfs_ino = (ino))
121 typedef struct gfs_readdir_state {
122 void *grd_dirent; /* directory entry buffer */
123 size_t grd_namlen; /* max file name length */
124 size_t grd_ureclen; /* exported record size */
125 ssize_t grd_oresid; /* original uio_resid */
126 ino64_t grd_parent; /* inode of parent */
127 ino64_t grd_self; /* inode of self */
128 int grd_flags; /* flags from VOP_READDIR */
129 } gfs_readdir_state_t;
131 extern int gfs_readdir_init(gfs_readdir_state_t *, int, int, uio_t *, ino64_t,
133 extern int gfs_readdir_emit(gfs_readdir_state_t *, uio_t *, offset_t, ino64_t,
134 const char *, int, int *, u_long **);
135 extern int gfs_readdir_pred(gfs_readdir_state_t *, uio_t *, offset_t *, int *,
137 extern int gfs_readdir_fini(gfs_readdir_state_t *, int, int *, int);
138 extern int gfs_get_parent_ino(vnode_t *, cred_t *, caller_context_t *,
139 ino64_t *, ino64_t *);
142 * Objects with real extended attributes will get their . and ..
143 * readdir entries from the real xattr directory. GFS_STATIC_ENTRY_OFFSET
144 * lets us skip right to the static entries in the GFS directory.
146 #define GFS_STATIC_ENTRY_OFFSET ((offset_t)2)
148 extern int gfs_lookup_dot(vnode_t **, vnode_t *, vnode_t *, const char *);
150 extern int gfs_vop_readdir(struct vop_readdir_args *);
151 extern int gfs_vop_inactive(struct vop_inactive_args *);
158 #endif /* _SYS_GFS_H */