xref: /freebsd-13-stable/sys/contrib/openzfs/include/os/freebsd/spl/sys/vnode.h (revision b9c2c366db1beb2ed276947056f45938ad8f57ec)
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/mount.h>
60 #include <sys/cred.h>
61 #include <sys/fcntl.h>
62 #include <sys/refcount.h>
63 #include <sys/file.h>
64 #include <sys/filedesc.h>
65 #include <sys/syscallsubr.h>
66 #include <sys/vm.h>
67 #include <vm/vm_object.h>
68 #include <vm/vnode_pager.h>
69 
70 typedef	struct vop_vector	vnodeops_t;
71 #define	VOP_FID		VOP_VPTOFH
72 #define	vop_fid		vop_vptofh
73 #define	vop_fid_args	vop_vptofh_args
74 #define	a_fid		a_fhp
75 
76 #define	rootvfs		(rootvnode == NULL ? NULL : rootvnode->v_mount)
77 
78 #ifndef IN_BASE
79 static __inline int
vn_is_readonly(vnode_t * vp)80 vn_is_readonly(vnode_t *vp)
81 {
82 	return (vp->v_mount->mnt_flag & MNT_RDONLY);
83 }
84 #endif
85 #define	vn_vfswlock(vp)		(0)
86 #define	vn_vfsunlock(vp)	do { } while (0)
87 #define	vn_ismntpt(vp)	   \
88 	((vp)->v_type == VDIR && (vp)->v_mountedhere != NULL)
89 #define	vn_mountedvfs(vp)	((vp)->v_mountedhere)
90 #define	vn_has_cached_data(vp)	\
91 	((vp)->v_object != NULL && \
92 	(vp)->v_object->resident_page_count > 0)
93 
94 #ifndef IN_BASE
95 static __inline void
vn_flush_cached_data(vnode_t * vp,boolean_t sync)96 vn_flush_cached_data(vnode_t *vp, boolean_t sync)
97 {
98 #if __FreeBSD_version > 1300054
99 	if (vm_object_mightbedirty(vp->v_object)) {
100 #else
101 	if (vp->v_object->flags & OBJ_MIGHTBEDIRTY) {
102 #endif
103 		vn_lock(vp, LK_SHARED | LK_RETRY);
104 		if (sync)
105 			vnode_pager_clean_sync(vp);
106 		else
107 			vnode_pager_clean_async(vp);
108 		VOP_UNLOCK(vp);
109 	}
110 }
111 #endif
112 
113 #define	vn_exists(vp)		do { } while (0)
114 #define	vn_invalid(vp)		do { } while (0)
115 #define	vn_renamepath(tdvp, svp, tnm, lentnm)	do { } while (0)
116 #define	vn_free(vp)		do { } while (0)
117 #define	vn_matchops(vp, vops)	((vp)->v_op == &(vops))
118 
119 #define	VN_HOLD(v)	vref(v)
120 #define	VN_RELE(v)	vrele(v)
121 #define	VN_URELE(v)	vput(v)
122 
123 #define	vnevent_create(vp, ct)			do { } while (0)
124 #define	vnevent_link(vp, ct)			do { } while (0)
125 #define	vnevent_remove(vp, dvp, name, ct)	do { } while (0)
126 #define	vnevent_rmdir(vp, dvp, name, ct)	do { } while (0)
127 #define	vnevent_rename_src(vp, dvp, name, ct)	do { } while (0)
128 #define	vnevent_rename_dest(vp, dvp, name, ct)	do { } while (0)
129 #define	vnevent_rename_dest_dir(vp, ct)		do { } while (0)
130 
131 #define	specvp(vp, rdev, type, cr)	(VN_HOLD(vp), (vp))
132 #define	MANDLOCK(vp, mode)	(0)
133 
134 /*
135  * We will use va_spare is place of Solaris' va_mask.
136  * This field is initialized in zfs_setattr().
137  */
138 #define	va_mask		va_spare
139 /* TODO: va_fileid is shorter than va_nodeid !!! */
140 #define	va_nodeid	va_fileid
141 /* TODO: This field needs conversion! */
142 #define	va_nblocks	va_bytes
143 #define	va_blksize	va_blocksize
144 
145 #define	MAXOFFSET_T	OFF_MAX
146 #define	EXCL		0
147 
148 #define	FCREAT		O_CREAT
149 #define	FTRUNC		O_TRUNC
150 #define	FEXCL		O_EXCL
151 #ifndef FDSYNC
152 #define	FDSYNC		FFSYNC
153 #endif
154 #define	FRSYNC		FFSYNC
155 #define	FSYNC		FFSYNC
156 #define	FOFFMAX		0x00
157 #define	FIGNORECASE	0x00
158 
159 /*
160  * Attributes of interest to the caller of setattr or getattr.
161  */
162 #define	AT_MODE		0x00002
163 #define	AT_UID		0x00004
164 #define	AT_GID		0x00008
165 #define	AT_FSID		0x00010
166 #define	AT_NODEID	0x00020
167 #define	AT_NLINK	0x00040
168 #define	AT_SIZE		0x00080
169 #define	AT_ATIME	0x00100
170 #define	AT_MTIME	0x00200
171 #define	AT_CTIME	0x00400
172 #define	AT_RDEV		0x00800
173 #define	AT_BLKSIZE	0x01000
174 #define	AT_NBLOCKS	0x02000
175 /*			0x04000 */	/* unused */
176 #define	AT_SEQ		0x08000
177 /*
178  * If AT_XVATTR is set then there are additional bits to process in
179  * the xvattr_t's attribute bitmap.  If this is not set then the bitmap
180  * MUST be ignored.  Note that this bit must be set/cleared explicitly.
181  * That is, setting AT_ALL will NOT set AT_XVATTR.
182  */
183 #define	AT_XVATTR	0x10000
184 
185 #define	AT_ALL		(AT_MODE|AT_UID|AT_GID|AT_FSID|AT_NODEID|\
186 			AT_NLINK|AT_SIZE|AT_ATIME|AT_MTIME|AT_CTIME|\
187 			AT_RDEV|AT_BLKSIZE|AT_NBLOCKS|AT_SEQ)
188 
189 #define	AT_STAT		(AT_MODE|AT_UID|AT_GID|AT_FSID|AT_NODEID|AT_NLINK|\
190 			AT_SIZE|AT_ATIME|AT_MTIME|AT_CTIME|AT_RDEV)
191 
192 #define	AT_TIMES	(AT_ATIME|AT_MTIME|AT_CTIME)
193 
194 #define	AT_NOSET	(AT_NLINK|AT_RDEV|AT_FSID|AT_NODEID|\
195 			AT_BLKSIZE|AT_NBLOCKS|AT_SEQ)
196 
197 #ifndef IN_BASE
198 static __inline void
199 vattr_init_mask(vattr_t *vap)
200 {
201 
202 	vap->va_mask = 0;
203 
204 	if (vap->va_uid != (uid_t)VNOVAL)
205 		vap->va_mask |= AT_UID;
206 	if (vap->va_gid != (gid_t)VNOVAL)
207 		vap->va_mask |= AT_GID;
208 	if (vap->va_size != (u_quad_t)VNOVAL)
209 		vap->va_mask |= AT_SIZE;
210 	if (vap->va_atime.tv_sec != VNOVAL)
211 		vap->va_mask |= AT_ATIME;
212 	if (vap->va_mtime.tv_sec != VNOVAL)
213 		vap->va_mask |= AT_MTIME;
214 	if (vap->va_mode != (uint16_t)VNOVAL)
215 		vap->va_mask |= AT_MODE;
216 	if (vap->va_flags != VNOVAL)
217 		vap->va_mask |= AT_XVATTR;
218 }
219 #endif
220 
221 #define		RLIM64_INFINITY 0
222 
223 static __inline int
224 vn_rename(char *from, char *to, enum uio_seg seg)
225 {
226 
227 	ASSERT(seg == UIO_SYSSPACE);
228 
229 	return (kern_renameat(curthread, AT_FDCWD, from, AT_FDCWD, to, seg));
230 }
231 
232 #include <sys/vfs.h>
233 
234 #endif	/* _OPENSOLARIS_SYS_VNODE_H_ */
235