xref: /illumos-gate/usr/src/uts/common/sys/gfs.h (revision 8711765099ae73ec6eb3cd5d1134031d8f11d4f7)
1 /*
2  * CDDL HEADER START
3  *
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.
7  *
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.
12  *
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]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _SYS_GFS_H
28 #define	_SYS_GFS_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include <sys/types.h>
33 #include <sys/vnode.h>
34 #include <sys/vfs_opreg.h>
35 #include <sys/mutex.h>
36 #include <sys/dirent.h>
37 #include <sys/uio.h>
38 #include <sys/list.h>
39 #include <sys/pathname.h>
40 
41 #ifdef	__cplusplus
42 extern "C" {
43 #endif
44 
45 typedef struct gfs_opsvec {
46 	const char		*gfsv_name;	/* vnode description */
47 	const fs_operation_def_t *gfsv_template; /* ops template */
48 	vnodeops_t		**gfsv_ops;	/* ptr to result */
49 } gfs_opsvec_t;
50 
51 int gfs_make_opsvec(gfs_opsvec_t *);
52 
53 #define	GFS_CACHE_VNODE		0x1
54 
55 typedef struct gfs_dirent {
56 	char			*gfse_name;	/* entry name */
57 	vnode_t *(*gfse_ctor)(vnode_t *);	/* constructor */
58 	int			gfse_flags;	/* flags */
59 	list_node_t		gfse_link;	/* dynamic list */
60 	vnode_t			*gfse_vnode;	/* cached vnode */
61 } gfs_dirent_t;
62 
63 typedef enum gfs_type {
64 	GFS_DIR,
65 	GFS_FILE
66 } gfs_type_t;
67 
68 typedef struct gfs_file {
69 	vnode_t		*gfs_vnode;	/* current vnode */
70 	vnode_t		*gfs_parent;	/* parent vnode */
71 	size_t		gfs_size;	/* size of private data structure */
72 	gfs_type_t	gfs_type;	/* type of vnode */
73 	int		gfs_index;	/* index in parent dir */
74 	ino64_t		gfs_ino;	/* inode for this vnode */
75 } gfs_file_t;
76 
77 typedef int (*gfs_readdir_cb)(vnode_t *, struct dirent64 *, int *, offset_t *,
78     offset_t *, void *);
79 typedef int (*gfs_lookup_cb)(vnode_t *, const char *, vnode_t **, ino64_t *,
80     cred_t *);
81 typedef ino64_t (*gfs_inode_cb)(vnode_t *, int);
82 
83 typedef struct gfs_dir {
84 	gfs_file_t	gfsd_file;	/* generic file attributes */
85 	gfs_dirent_t	*gfsd_static;	/* statically defined entries */
86 	int		gfsd_nstatic;	/* # static entries */
87 	kmutex_t	gfsd_lock;	/* protects entries */
88 	int		gfsd_maxlen;	/* maximum name length */
89 	gfs_readdir_cb	gfsd_readdir;	/* readdir() callback */
90 	gfs_lookup_cb	gfsd_lookup;	/* lookup() callback */
91 	gfs_inode_cb	gfsd_inode;	/* get an inode number */
92 } gfs_dir_t;
93 
94 struct vfs;
95 
96 extern vnode_t *gfs_file_create(size_t, vnode_t *, vnodeops_t *);
97 extern vnode_t *gfs_dir_create(size_t, vnode_t *, vnodeops_t *,
98     gfs_dirent_t *, gfs_inode_cb, int, gfs_readdir_cb, gfs_lookup_cb);
99 extern vnode_t *gfs_root_create(size_t, struct vfs *, vnodeops_t *, ino64_t,
100     gfs_dirent_t *, gfs_inode_cb, int, gfs_readdir_cb, gfs_lookup_cb);
101 extern vnode_t *gfs_root_create_file(size_t, struct vfs *, vnodeops_t *,
102     ino64_t);
103 
104 extern void *gfs_file_inactive(vnode_t *);
105 extern void *gfs_dir_inactive(vnode_t *);
106 
107 extern int gfs_dir_lookup(vnode_t *, const char *, vnode_t **, cred_t *);
108 extern int gfs_dir_readdir(vnode_t *, uio_t *, int *, void *, cred_t *,
109     caller_context_t *);
110 
111 #define	gfs_dir_lock(gd)	mutex_enter(&(gd)->gfsd_lock)
112 #define	gfs_dir_unlock(gd)	mutex_exit(&(gd)->gfsd_lock)
113 
114 #define	gfs_file_parent(vp)	(((gfs_file_t *)(vp)->v_data)->gfs_parent)
115 
116 #define	gfs_file_index(vp)	(((gfs_file_t *)(vp)->v_data)->gfs_index)
117 #define	gfs_file_set_index(vp, idx)	\
118 	(((gfs_file_t *)(vp)->v_data)->gfs_index = (idx))
119 
120 #define	gfs_file_inode(vp)	(((gfs_file_t *)(vp)->v_data)->gfs_ino)
121 #define	gfs_file_set_inode(vp, ino)	\
122 	(((gfs_file_t *)(vp)->v_data)->gfs_ino = (ino))
123 
124 typedef struct gfs_readdir_state {
125 	struct dirent64 *grd_dirent;	/* directory entry buffer */
126 	size_t		grd_namlen;	/* max file name length */
127 	size_t		grd_ureclen;	/* exported record size */
128 	ssize_t		grd_oresid;	/* original uio_resid */
129 	ino64_t		grd_parent;	/* inode of parent */
130 	ino64_t		grd_self;	/* inode of self */
131 } gfs_readdir_state_t;
132 
133 extern int gfs_readdir_init(gfs_readdir_state_t *, int, int, uio_t *, ino64_t,
134     ino64_t);
135 extern int gfs_readdir_emit(gfs_readdir_state_t *, uio_t *, offset_t, ino64_t,
136     const char *);
137 extern int gfs_readdir_emitn(gfs_readdir_state_t *, uio_t *, offset_t, ino64_t,
138     unsigned long);
139 extern int gfs_readdir_pred(gfs_readdir_state_t *, uio_t *, offset_t *);
140 extern int gfs_readdir_fini(gfs_readdir_state_t *, int, int *, int);
141 
142 /*
143  * Objects with real extended attributes will get their . and ..
144  * readdir entries from the real xattr directory. GFS_STATIC_ENTRY_OFFSET
145  * lets us skip right to the static entries in the GFS directory.
146  */
147 #define	GFS_STATIC_ENTRY_OFFSET	((offset_t)2)
148 
149 extern int gfs_lookup_dot(vnode_t **, vnode_t *, vnode_t *, const char *);
150 
151 extern int gfs_vop_lookup(vnode_t *, char *, vnode_t **, pathname_t *,
152     int, vnode_t *, cred_t *, caller_context_t *, int *, pathname_t *);
153 extern int gfs_vop_readdir(vnode_t *, uio_t *, cred_t *, int *,
154     caller_context_t *, int);
155 extern int gfs_vop_map(vnode_t *, offset_t, struct as *, caddr_t *,
156     size_t, uchar_t, uchar_t, uint_t, cred_t *, caller_context_t *);
157 extern void gfs_vop_inactive(vnode_t *, cred_t *, caller_context_t *);
158 
159 
160 #ifdef	__cplusplus
161 }
162 #endif
163 
164 #endif	/* _SYS_GFS_H */
165