1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause 3 * 4 * Copyright (c) 2007-2009 Google Inc. and Amit Singh 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions are 9 * met: 10 * 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 16 * distribution. 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. 20 * 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. 32 * 33 * Copyright (C) 2005 Csaba Henk. 34 * All rights reserved. 35 * 36 * Redistribution and use in source and binary forms, with or without 37 * modification, are permitted provided that the following conditions 38 * are met: 39 * 1. Redistributions of source code must retain the above copyright 40 * notice, this list of conditions and the following disclaimer. 41 * 2. Redistributions in binary form must reproduce the above copyright 42 * notice, this list of conditions and the following disclaimer in the 43 * documentation and/or other materials provided with the distribution. 44 * 45 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND 46 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 47 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 48 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE 49 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 50 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 51 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 52 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 53 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 54 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 55 * SUCH DAMAGE. 56 * 57 * $FreeBSD$ 58 */ 59 60 #ifndef _FUSE_INTERNAL_H_ 61 #define _FUSE_INTERNAL_H_ 62 63 #include <sys/types.h> 64 #include <sys/uio.h> 65 #include <sys/stat.h> 66 #include <sys/vnode.h> 67 68 #include "fuse_ipc.h" 69 #include "fuse_node.h" 70 71 static inline bool 72 vfs_isrdonly(struct mount *mp) 73 { 74 return ((mp->mnt_flag & MNT_RDONLY) != 0); 75 } 76 77 static inline struct mount * 78 vnode_mount(struct vnode *vp) 79 { 80 return (vp->v_mount); 81 } 82 83 static inline bool 84 vnode_mountedhere(struct vnode *vp) 85 { 86 return (vp->v_mountedhere != NULL); 87 } 88 89 static inline enum vtype 90 vnode_vtype(struct vnode *vp) 91 { 92 return (vp->v_type); 93 } 94 95 static inline bool 96 vnode_isvroot(struct vnode *vp) 97 { 98 return ((vp->v_vflag & VV_ROOT) != 0); 99 } 100 101 static inline bool 102 vnode_isreg(struct vnode *vp) 103 { 104 return (vp->v_type == VREG); 105 } 106 107 static inline bool 108 vnode_isdir(struct vnode *vp) 109 { 110 return (vp->v_type == VDIR); 111 } 112 113 static inline bool 114 vnode_islnk(struct vnode *vp) 115 { 116 return (vp->v_type == VLNK); 117 } 118 119 static inline ssize_t 120 uio_resid(struct uio *uio) 121 { 122 return (uio->uio_resid); 123 } 124 125 static inline off_t 126 uio_offset(struct uio *uio) 127 { 128 return (uio->uio_offset); 129 } 130 131 static inline void 132 uio_setoffset(struct uio *uio, off_t offset) 133 { 134 uio->uio_offset = offset; 135 } 136 137 static inline void 138 uio_setresid(struct uio *uio, ssize_t resid) 139 { 140 uio->uio_resid = resid; 141 } 142 143 /* miscellaneous */ 144 145 static inline bool 146 fuse_isdeadfs(struct vnode *vp) 147 { 148 struct fuse_data *data = fuse_get_mpdata(vnode_mount(vp)); 149 150 return (data->dataflags & FSESS_DEAD); 151 } 152 153 static inline uint64_t 154 fuse_iosize(struct vnode *vp) 155 { 156 return (vp->v_mount->mnt_stat.f_iosize); 157 } 158 159 /* access */ 160 161 #define FVP_ACCESS_NOOP 0x01 162 163 #define FACCESS_VA_VALID 0x01 164 #define FACCESS_DO_ACCESS 0x02 165 #define FACCESS_STICKY 0x04 166 #define FACCESS_CHOWN 0x08 167 #define FACCESS_NOCHECKSPY 0x10 168 #define FACCESS_SETGID 0x12 169 170 #define FACCESS_XQUERIES (FACCESS_STICKY | FACCESS_CHOWN | FACCESS_SETGID) 171 172 struct fuse_access_param { 173 uid_t xuid; 174 gid_t xgid; 175 uint32_t facc_flags; 176 }; 177 178 static inline int 179 fuse_match_cred(struct ucred *basecred, struct ucred *usercred) 180 { 181 if (basecred->cr_uid == usercred->cr_uid && 182 basecred->cr_uid == usercred->cr_ruid && 183 basecred->cr_uid == usercred->cr_svuid && 184 basecred->cr_groups[0] == usercred->cr_groups[0] && 185 basecred->cr_groups[0] == usercred->cr_rgid && 186 basecred->cr_groups[0] == usercred->cr_svgid) 187 return (0); 188 189 return (EPERM); 190 } 191 192 int fuse_internal_access(struct vnode *vp, mode_t mode, 193 struct fuse_access_param *facp, struct thread *td, struct ucred *cred); 194 195 /* attributes */ 196 197 /* 198 * Cache FUSE attributes 'fat', with nominal expiration 199 * 'attr_valid'.'attr_valid_nsec', in attr cache associated with vnode 'vp'. 200 * Optionally, if argument 'vap' is not NULL, store a copy of the converted 201 * attributes there as well. 202 * 203 * If the nominal attribute cache TTL is zero, do not cache on the 'vp' (but do 204 * return the result to the caller). 205 */ 206 static inline void 207 fuse_internal_attr_fat2vat(struct vnode *vp, struct fuse_attr *fat, 208 uint64_t attr_valid, uint32_t attr_valid_nsec, struct vattr *vap) 209 { 210 struct mount *mp; 211 struct fuse_vnode_data *fvdat; 212 struct vattr *vp_cache_at; 213 214 mp = vnode_mount(vp); 215 fvdat = VTOFUD(vp); 216 217 DEBUGX(FUSE_DEBUG_INTERNAL, "node #%ju, mode 0%o\n", 218 (uintmax_t)fat->ino, fat->mode); 219 220 /* Honor explicit do-not-cache requests from user filesystems. */ 221 if (attr_valid == 0 && attr_valid_nsec == 0) 222 fvdat->valid_attr_cache = false; 223 else 224 fvdat->valid_attr_cache = true; 225 226 vp_cache_at = VTOVA(vp); 227 228 if (vap == NULL && vp_cache_at == NULL) 229 return; 230 231 if (vap == NULL) 232 vap = vp_cache_at; 233 234 vattr_null(vap); 235 236 vap->va_fsid = mp->mnt_stat.f_fsid.val[0]; 237 vap->va_fileid = fat->ino; 238 vap->va_mode = fat->mode & ~S_IFMT; 239 vap->va_nlink = fat->nlink; 240 vap->va_uid = fat->uid; 241 vap->va_gid = fat->gid; 242 vap->va_rdev = fat->rdev; 243 vap->va_size = fat->size; 244 /* XXX on i386, seconds are truncated to 32 bits */ 245 vap->va_atime.tv_sec = fat->atime; 246 vap->va_atime.tv_nsec = fat->atimensec; 247 vap->va_mtime.tv_sec = fat->mtime; 248 vap->va_mtime.tv_nsec = fat->mtimensec; 249 vap->va_ctime.tv_sec = fat->ctime; 250 vap->va_ctime.tv_nsec = fat->ctimensec; 251 vap->va_blocksize = PAGE_SIZE; 252 vap->va_type = IFTOVT(fat->mode); 253 vap->va_bytes = fat->blocks * S_BLKSIZE; 254 vap->va_flags = 0; 255 256 if (vap != vp_cache_at && vp_cache_at != NULL) 257 memcpy(vp_cache_at, vap, sizeof(*vap)); 258 } 259 260 261 #define cache_attrs(vp, fuse_out, vap_out) \ 262 fuse_internal_attr_fat2vat((vp), &(fuse_out)->attr, \ 263 (fuse_out)->attr_valid, (fuse_out)->attr_valid_nsec, (vap_out)) 264 265 /* fsync */ 266 267 int fuse_internal_fsync(struct vnode *vp, struct thread *td, 268 struct ucred *cred, struct fuse_filehandle *fufh); 269 int fuse_internal_fsync_callback(struct fuse_ticket *tick, struct uio *uio); 270 271 /* readdir */ 272 273 struct pseudo_dirent { 274 uint32_t d_namlen; 275 }; 276 277 int fuse_internal_readdir(struct vnode *vp, struct uio *uio, 278 struct fuse_filehandle *fufh, struct fuse_iov *cookediov); 279 int fuse_internal_readdir_processdata(struct uio *uio, size_t reqsize, 280 void *buf, size_t bufsize, void *param); 281 282 /* remove */ 283 284 int fuse_internal_remove(struct vnode *dvp, struct vnode *vp, 285 struct componentname *cnp, enum fuse_opcode op); 286 287 /* rename */ 288 289 int fuse_internal_rename(struct vnode *fdvp, struct componentname *fcnp, 290 struct vnode *tdvp, struct componentname *tcnp); 291 292 /* revoke */ 293 294 void fuse_internal_vnode_disappear(struct vnode *vp); 295 296 /* strategy */ 297 298 /* entity creation */ 299 300 static inline int 301 fuse_internal_checkentry(struct fuse_entry_out *feo, enum vtype vtyp) 302 { 303 DEBUGX(FUSE_DEBUG_INTERNAL, 304 "feo=%p, vtype=%d\n", feo, vtyp); 305 306 if (vtyp != IFTOVT(feo->attr.mode)) { 307 DEBUGX(FUSE_DEBUG_INTERNAL, 308 "EINVAL -- %x != %x\n", vtyp, IFTOVT(feo->attr.mode)); 309 return (EINVAL); 310 } 311 312 if (feo->nodeid == FUSE_NULL_ID) { 313 DEBUGX(FUSE_DEBUG_INTERNAL, 314 "EINVAL -- feo->nodeid is NULL\n"); 315 return (EINVAL); 316 } 317 318 if (feo->nodeid == FUSE_ROOT_ID) { 319 DEBUGX(FUSE_DEBUG_INTERNAL, 320 "EINVAL -- feo->nodeid is FUSE_ROOT_ID\n"); 321 return (EINVAL); 322 } 323 324 return (0); 325 } 326 327 int fuse_internal_newentry(struct vnode *dvp, struct vnode **vpp, 328 struct componentname *cnp, enum fuse_opcode op, void *buf, size_t bufsize, 329 enum vtype vtyp); 330 331 void fuse_internal_newentry_makerequest(struct mount *mp, uint64_t dnid, 332 struct componentname *cnp, enum fuse_opcode op, void *buf, size_t bufsize, 333 struct fuse_dispatcher *fdip); 334 335 int fuse_internal_newentry_core(struct vnode *dvp, struct vnode **vpp, 336 struct componentname *cnp, enum vtype vtyp, struct fuse_dispatcher *fdip); 337 338 /* entity destruction */ 339 340 int fuse_internal_forget_callback(struct fuse_ticket *tick, struct uio *uio); 341 void fuse_internal_forget_send(struct mount *mp, struct thread *td, 342 struct ucred *cred, uint64_t nodeid, uint64_t nlookup); 343 344 /* fuse start/stop */ 345 346 int fuse_internal_init_callback(struct fuse_ticket *tick, struct uio *uio); 347 void fuse_internal_send_init(struct fuse_data *data, struct thread *td); 348 349 #endif /* _FUSE_INTERNAL_H_ */ 350