xref: /freebsd/sys/contrib/openzfs/include/os/freebsd/spl/sys/vnode.h (revision 718519f4efc71096422fc71dab90b2a3369871ff)
1 /*
2  * Copyright (c) 2007 Pawel Jakub Dawidek <pjd@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _OPENSOLARIS_SYS_VNODE_H_
30 #define	_OPENSOLARIS_SYS_VNODE_H_
31 
32 struct vnode;
33 struct vattr;
34 struct xucred;
35 
36 typedef struct flock	flock64_t;
37 typedef	struct vnode	vnode_t;
38 typedef	struct vattr	vattr_t;
39 #if __FreeBSD_version < 1400093
40 typedef enum vtype vtype_t;
41 #else
42 #define	vtype_t __enum_uint8(vtype)
43 #endif
44 
45 #include <sys/types.h>
46 #include <sys/queue.h>
47 #include_next <sys/sdt.h>
48 #include <sys/namei.h>
49 enum symfollow { NO_FOLLOW = NOFOLLOW };
50 
51 #define	NOCRED	((struct ucred *)0)	/* no credential available */
52 #define	F_FREESP	11 	/* Free file space */
53 
54 #include <sys/proc.h>
55 #include <sys/vnode_impl.h>
56 #ifndef IN_BASE
57 #include_next <sys/vnode.h>
58 #endif
59 #include <sys/ccompat.h>
60 #include <sys/mount.h>
61 #include <sys/cred.h>
62 #include <sys/fcntl.h>
63 #include <sys/refcount.h>
64 #include <sys/file.h>
65 #include <sys/filedesc.h>
66 #include <sys/syscallsubr.h>
67 #include <sys/vm.h>
68 #include <vm/vm_object.h>
69 #include <vm/vnode_pager.h>
70 
71 typedef	struct vop_vector	vnodeops_t;
72 #define	VOP_FID		VOP_VPTOFH
73 #define	vop_fid		vop_vptofh
74 #define	vop_fid_args	vop_vptofh_args
75 #define	a_fid		a_fhp
76 
77 #define	rootvfs		(rootvnode == NULL ? NULL : rootvnode->v_mount)
78 
79 #ifndef IN_BASE
80 static __inline int
vn_is_readonly(vnode_t * vp)81 vn_is_readonly(vnode_t *vp)
82 {
83 	return (vp->v_mount->mnt_flag & MNT_RDONLY);
84 }
85 #endif
86 #define	vn_vfswlock(vp)		(0)
87 #define	vn_vfsunlock(vp)	do { } while (0)
88 #define	vn_ismntpt(vp)	   \
89 	((vp)->v_type == VDIR && (vp)->v_mountedhere != NULL)
90 #define	vn_mountedvfs(vp)	((vp)->v_mountedhere)
91 #define	vn_has_cached_data(vp)	\
92 	((vp)->v_object != NULL && \
93 	(vp)->v_object->resident_page_count > 0)
94 
95 #ifndef IN_BASE
96 static __inline void
vn_flush_cached_data(vnode_t * vp,boolean_t sync)97 vn_flush_cached_data(vnode_t *vp, boolean_t sync)
98 {
99 	if (vm_object_mightbedirty(vp->v_object)) {
100 		int flags = sync ? OBJPC_SYNC : 0;
101 		zfs_vmobject_wlock(vp->v_object);
102 		vm_object_page_clean(vp->v_object, 0, 0, flags);
103 		zfs_vmobject_wunlock(vp->v_object);
104 	}
105 }
106 #endif
107 
108 #define	vn_exists(vp)		do { } while (0)
109 #define	vn_invalid(vp)		do { } while (0)
110 #define	vn_free(vp)		do { } while (0)
111 #define	vn_matchops(vp, vops)	((vp)->v_op == &(vops))
112 
113 #define	VN_HOLD(v)	vref(v)
114 #define	VN_RELE(v)	vrele(v)
115 #define	VN_URELE(v)	vput(v)
116 
117 #define	vnevent_create(vp, ct)			do { } while (0)
118 #define	vnevent_link(vp, ct)			do { } while (0)
119 #define	vnevent_remove(vp, dvp, name, ct)	do { } while (0)
120 #define	vnevent_rmdir(vp, dvp, name, ct)	do { } while (0)
121 #define	vnevent_rename_src(vp, dvp, name, ct)	do { } while (0)
122 #define	vnevent_rename_dest(vp, dvp, name, ct)	do { } while (0)
123 #define	vnevent_rename_dest_dir(vp, ct)		do { } while (0)
124 
125 #define	specvp(vp, rdev, type, cr)	(VN_HOLD(vp), (vp))
126 #define	MANDLOCK(vp, mode)	(0)
127 
128 /*
129  * We will use va_spare is place of Solaris' va_mask.
130  * This field is initialized in zfs_setattr().
131  */
132 #define	va_mask		va_spare
133 /* TODO: va_fileid is shorter than va_nodeid !!! */
134 #define	va_nodeid	va_fileid
135 /* TODO: This field needs conversion! */
136 #define	va_nblocks	va_bytes
137 #define	va_blksize	va_blocksize
138 
139 #define	MAXOFFSET_T	OFF_MAX
140 
141 #define	FIGNORECASE	0x00
142 
143 /*
144  * Attributes of interest to the caller of setattr or getattr.
145  */
146 
147 #undef AT_UID
148 #undef AT_GID
149 
150 #define	AT_MODE		0x00002
151 #define	AT_UID		0x00004
152 #define	AT_GID		0x00008
153 #define	AT_FSID		0x00010
154 #define	AT_NODEID	0x00020
155 #define	AT_NLINK	0x00040
156 #define	AT_SIZE		0x00080
157 #define	AT_ATIME	0x00100
158 #define	AT_MTIME	0x00200
159 #define	AT_CTIME	0x00400
160 #define	AT_RDEV		0x00800
161 #define	AT_BLKSIZE	0x01000
162 #define	AT_NBLOCKS	0x02000
163 /*			0x04000 */	/* unused */
164 #define	AT_SEQ		0x08000
165 /*
166  * If AT_XVATTR is set then there are additional bits to process in
167  * the xvattr_t's attribute bitmap.  If this is not set then the bitmap
168  * MUST be ignored.  Note that this bit must be set/cleared explicitly.
169  * That is, setting AT_ALL will NOT set AT_XVATTR.
170  */
171 #define	AT_XVATTR	0x10000
172 
173 #define	AT_ALL		(AT_MODE|AT_UID|AT_GID|AT_FSID|AT_NODEID|\
174 			AT_NLINK|AT_SIZE|AT_ATIME|AT_MTIME|AT_CTIME|\
175 			AT_RDEV|AT_BLKSIZE|AT_NBLOCKS|AT_SEQ)
176 
177 #define	AT_STAT		(AT_MODE|AT_UID|AT_GID|AT_FSID|AT_NODEID|AT_NLINK|\
178 			AT_SIZE|AT_ATIME|AT_MTIME|AT_CTIME|AT_RDEV)
179 
180 #define	AT_TIMES	(AT_ATIME|AT_MTIME|AT_CTIME)
181 
182 #define	AT_NOSET	(AT_NLINK|AT_RDEV|AT_FSID|AT_NODEID|\
183 			AT_BLKSIZE|AT_NBLOCKS|AT_SEQ)
184 
185 #ifndef IN_BASE
186 static __inline void
vattr_init_mask(vattr_t * vap)187 vattr_init_mask(vattr_t *vap)
188 {
189 
190 	vap->va_mask = 0;
191 
192 	if (vap->va_uid != (uid_t)VNOVAL)
193 		vap->va_mask |= AT_UID;
194 	if (vap->va_gid != (gid_t)VNOVAL)
195 		vap->va_mask |= AT_GID;
196 	if (vap->va_size != (u_quad_t)VNOVAL)
197 		vap->va_mask |= AT_SIZE;
198 	if (vap->va_atime.tv_sec != VNOVAL)
199 		vap->va_mask |= AT_ATIME;
200 	if (vap->va_mtime.tv_sec != VNOVAL)
201 		vap->va_mask |= AT_MTIME;
202 	if (vap->va_mode != (uint16_t)VNOVAL)
203 		vap->va_mask |= AT_MODE;
204 	if (vap->va_flags != VNOVAL)
205 		vap->va_mask |= AT_XVATTR;
206 }
207 #endif
208 
209 #define		RLIM64_INFINITY 0
210 
211 #include <sys/vfs.h>
212 
213 #endif	/* _OPENSOLARIS_SYS_VNODE_H_ */
214