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 void fuse_internal_cache_attrs(struct vnode *vp, struct fuse_attr *attr, 197 uint64_t attr_valid, uint32_t attr_valid_nsec, struct vattr *vap); 198 199 /* fsync */ 200 201 int fuse_internal_fsync(struct vnode *vp, struct thread *td, 202 struct ucred *cred, struct fuse_filehandle *fufh); 203 int fuse_internal_fsync_callback(struct fuse_ticket *tick, struct uio *uio); 204 205 /* readdir */ 206 207 struct pseudo_dirent { 208 uint32_t d_namlen; 209 }; 210 211 int fuse_internal_readdir(struct vnode *vp, struct uio *uio, 212 struct fuse_filehandle *fufh, struct fuse_iov *cookediov); 213 int fuse_internal_readdir_processdata(struct uio *uio, size_t reqsize, 214 void *buf, size_t bufsize, void *param); 215 216 /* remove */ 217 218 int fuse_internal_remove(struct vnode *dvp, struct vnode *vp, 219 struct componentname *cnp, enum fuse_opcode op); 220 221 /* rename */ 222 223 int fuse_internal_rename(struct vnode *fdvp, struct componentname *fcnp, 224 struct vnode *tdvp, struct componentname *tcnp); 225 226 /* revoke */ 227 228 void fuse_internal_vnode_disappear(struct vnode *vp); 229 230 /* strategy */ 231 232 /* entity creation */ 233 234 static inline int 235 fuse_internal_checkentry(struct fuse_entry_out *feo, enum vtype vtyp) 236 { 237 if (vtyp != IFTOVT(feo->attr.mode)) { 238 return (EINVAL); 239 } 240 241 if (feo->nodeid == FUSE_NULL_ID) { 242 return (EINVAL); 243 } 244 245 if (feo->nodeid == FUSE_ROOT_ID) { 246 return (EINVAL); 247 } 248 249 return (0); 250 } 251 252 int fuse_internal_newentry(struct vnode *dvp, struct vnode **vpp, 253 struct componentname *cnp, enum fuse_opcode op, void *buf, size_t bufsize, 254 enum vtype vtyp); 255 256 void fuse_internal_newentry_makerequest(struct mount *mp, uint64_t dnid, 257 struct componentname *cnp, enum fuse_opcode op, void *buf, size_t bufsize, 258 struct fuse_dispatcher *fdip); 259 260 int fuse_internal_newentry_core(struct vnode *dvp, struct vnode **vpp, 261 struct componentname *cnp, enum vtype vtyp, struct fuse_dispatcher *fdip); 262 263 /* entity destruction */ 264 265 int fuse_internal_forget_callback(struct fuse_ticket *tick, struct uio *uio); 266 void fuse_internal_forget_send(struct mount *mp, struct thread *td, 267 struct ucred *cred, uint64_t nodeid, uint64_t nlookup); 268 269 /* fuse start/stop */ 270 271 int fuse_internal_init_callback(struct fuse_ticket *tick, struct uio *uio); 272 void fuse_internal_send_init(struct fuse_data *data, struct thread *td); 273 274 #endif /* _FUSE_INTERNAL_H_ */ 275