2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2007-2009 Google Inc. and Amit Singh
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above
14 * copyright notice, this list of conditions and the following disclaimer
15 * in the documentation and/or other materials provided with the
17 * * Neither the name of Google Inc. nor the names of its
18 * contributors may be used to endorse or promote products derived from
19 * this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 * Copyright (C) 2005 Csaba Henk.
34 * All rights reserved.
36 * Copyright (c) 2019 The FreeBSD Foundation
38 * Portions of this software were developed by BFF Storage Systems, LLC under
39 * sponsorship from the FreeBSD Foundation.
41 * Redistribution and use in source and binary forms, with or without
42 * modification, are permitted provided that the following conditions
44 * 1. Redistributions of source code must retain the above copyright
45 * notice, this list of conditions and the following disclaimer.
46 * 2. Redistributions in binary form must reproduce the above copyright
47 * notice, this list of conditions and the following disclaimer in the
48 * documentation and/or other materials provided with the distribution.
50 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
51 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
52 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
53 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
54 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
55 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
56 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
57 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
58 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
59 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
65 #ifndef _FUSE_INTERNAL_H_
66 #define _FUSE_INTERNAL_H_
68 #include <sys/types.h>
69 #include <sys/counter.h>
70 #include <sys/limits.h>
73 #include <sys/vnode.h>
76 #include "fuse_node.h"
78 extern counter_u64_t fuse_lookup_cache_hits;
79 extern counter_u64_t fuse_lookup_cache_misses;
82 vfs_isrdonly(struct mount *mp)
84 return ((mp->mnt_flag & MNT_RDONLY) != 0);
87 static inline struct mount *
88 vnode_mount(struct vnode *vp)
93 static inline enum vtype
94 vnode_vtype(struct vnode *vp)
100 vnode_isvroot(struct vnode *vp)
102 return ((vp->v_vflag & VV_ROOT) != 0);
106 vnode_isreg(struct vnode *vp)
108 return (vp->v_type == VREG);
112 vnode_isdir(struct vnode *vp)
114 return (vp->v_type == VDIR);
118 vnode_islnk(struct vnode *vp)
120 return (vp->v_type == VLNK);
123 static inline ssize_t
124 uio_resid(struct uio *uio)
126 return (uio->uio_resid);
130 uio_offset(struct uio *uio)
132 return (uio->uio_offset);
136 uio_setoffset(struct uio *uio, off_t offset)
138 uio->uio_offset = offset;
144 fuse_isdeadfs(struct vnode *vp)
146 struct fuse_data *data = fuse_get_mpdata(vnode_mount(vp));
148 return (data->dataflags & FSESS_DEAD);
151 static inline uint64_t
152 fuse_iosize(struct vnode *vp)
154 return (vp->v_mount->mnt_stat.f_iosize);
158 * Make a cacheable timeout in bintime format value based on a fuse_attr_out
162 fuse_validity_2_bintime(uint64_t attr_valid, uint32_t attr_valid_nsec,
163 struct bintime *timeout)
165 struct timespec now, duration, timeout_ts;
168 /* "+ 2" is the bound of attr_valid_nsec + now.tv_nsec */
169 /* Why oh why isn't there a TIME_MAX defined? */
170 if (attr_valid >= INT_MAX || attr_valid + now.tv_sec + 2 >= INT_MAX) {
171 timeout->sec = INT_MAX;
173 duration.tv_sec = attr_valid;
174 duration.tv_nsec = attr_valid_nsec;
175 timespecadd(&duration, &now, &timeout_ts);
176 timespec2bintime(&timeout_ts, timeout);
181 * Make a cacheable timeout value in timespec format based on the fuse_entry_out
185 fuse_validity_2_timespec(const struct fuse_entry_out *feo,
186 struct timespec *timeout)
188 struct timespec duration, now;
191 /* "+ 2" is the bound of entry_valid_nsec + now.tv_nsec */
192 if (feo->entry_valid >= INT_MAX ||
193 feo->entry_valid + now.tv_sec + 2 >= INT_MAX) {
194 timeout->tv_sec = INT_MAX;
196 duration.tv_sec = feo->entry_valid;
197 duration.tv_nsec = feo->entry_valid_nsec;
198 timespecadd(&duration, &now, timeout);
205 fuse_internal_get_cached_vnode(struct mount*, ino_t, int, struct vnode**);
209 fuse_match_cred(struct ucred *basecred, struct ucred *usercred)
211 if (basecred->cr_uid == usercred->cr_uid &&
212 basecred->cr_uid == usercred->cr_ruid &&
213 basecred->cr_uid == usercred->cr_svuid &&
214 basecred->cr_groups[0] == usercred->cr_groups[0] &&
215 basecred->cr_groups[0] == usercred->cr_rgid &&
216 basecred->cr_groups[0] == usercred->cr_svgid)
222 int fuse_internal_access(struct vnode *vp, accmode_t mode,
223 struct thread *td, struct ucred *cred);
226 void fuse_internal_cache_attrs(struct vnode *vp, struct fuse_attr *attr,
227 uint64_t attr_valid, uint32_t attr_valid_nsec, struct vattr *vap);
231 int fuse_internal_fsync(struct vnode *vp, struct thread *td, int waitfor,
233 int fuse_internal_fsync_callback(struct fuse_ticket *tick, struct uio *uio);
236 int fuse_internal_do_getattr(struct vnode *vp, struct vattr *vap,
237 struct ucred *cred, struct thread *td);
238 int fuse_internal_getattr(struct vnode *vp, struct vattr *vap,
239 struct ucred *cred, struct thread *td);
241 /* asynchronous invalidation */
242 int fuse_internal_invalidate_entry(struct mount *mp, struct uio *uio);
243 int fuse_internal_invalidate_inode(struct mount *mp, struct uio *uio);
246 int fuse_internal_mknod(struct vnode *dvp, struct vnode **vpp,
247 struct componentname *cnp, struct vattr *vap);
250 struct pseudo_dirent {
253 int fuse_internal_readdir(struct vnode *vp, struct uio *uio, off_t startoff,
254 struct fuse_filehandle *fufh, struct fuse_iov *cookediov, int *ncookies,
256 int fuse_internal_readdir_processdata(struct uio *uio, off_t startoff,
257 int *fnd_start, size_t reqsize, void *buf, size_t bufsize,
258 struct fuse_iov *cookediov, int *ncookies, u_long **cookiesp);
262 int fuse_internal_remove(struct vnode *dvp, struct vnode *vp,
263 struct componentname *cnp, enum fuse_opcode op);
267 int fuse_internal_rename(struct vnode *fdvp, struct componentname *fcnp,
268 struct vnode *tdvp, struct componentname *tcnp);
272 void fuse_internal_vnode_disappear(struct vnode *vp);
275 int fuse_internal_setattr(struct vnode *vp, struct vattr *va,
276 struct thread *td, struct ucred *cred);
280 /* entity creation */
283 fuse_internal_checkentry(struct fuse_entry_out *feo, enum vtype vtyp)
285 if (vtyp != IFTOVT(feo->attr.mode)) {
289 if (feo->nodeid == FUSE_NULL_ID) {
293 if (feo->nodeid == FUSE_ROOT_ID) {
300 int fuse_internal_newentry(struct vnode *dvp, struct vnode **vpp,
301 struct componentname *cnp, enum fuse_opcode op, void *buf, size_t bufsize,
304 void fuse_internal_newentry_makerequest(struct mount *mp, uint64_t dnid,
305 struct componentname *cnp, enum fuse_opcode op, void *buf, size_t bufsize,
306 struct fuse_dispatcher *fdip);
308 int fuse_internal_newentry_core(struct vnode *dvp, struct vnode **vpp,
309 struct componentname *cnp, enum vtype vtyp, struct fuse_dispatcher *fdip);
311 /* entity destruction */
313 int fuse_internal_forget_callback(struct fuse_ticket *tick, struct uio *uio);
314 void fuse_internal_forget_send(struct mount *mp, struct thread *td,
315 struct ucred *cred, uint64_t nodeid, uint64_t nlookup);
317 /* fuse start/stop */
319 int fuse_internal_init_callback(struct fuse_ticket *tick, struct uio *uio);
320 void fuse_internal_send_init(struct fuse_data *data, struct thread *td);
322 /* module load/unload */
323 void fuse_internal_init(void);
324 void fuse_internal_destroy(void);
326 #endif /* _FUSE_INTERNAL_H_ */