sys/fs/fuse/fuse_internal.h

   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 extern u_long fuse_lookup_cache_hits;
  72 extern u_long fuse_lookup_cache_misses;
  73
  74 static inline bool
  75 vfs_isrdonly(struct mount *mp)
  76 {
  77         return ((mp->mnt_flag & MNT_RDONLY) != 0);
  78 }
  79
  80 static inline struct mount *
  81 vnode_mount(struct vnode *vp)
  82 {
  83         return (vp->v_mount);
  84 }
  85
  86 static inline enum vtype
  87 vnode_vtype(struct vnode *vp)
  88 {
  89         return (vp->v_type);
  90 }
  91
  92 static inline bool
  93 vnode_isvroot(struct vnode *vp)
  94 {
  95         return ((vp->v_vflag & VV_ROOT) != 0);
  96 }
  97
  98 static inline bool
  99 vnode_isreg(struct vnode *vp)
 100 {
 101         return (vp->v_type == VREG);
 102 }
 103
 104 static inline bool
 105 vnode_isdir(struct vnode *vp)
 106 {
 107         return (vp->v_type == VDIR);
 108 }
 109
 110 static inline bool
 111 vnode_islnk(struct vnode *vp)
 112 {
 113         return (vp->v_type == VLNK);
 114 }
 115
 116 static inline ssize_t
 117 uio_resid(struct uio *uio)
 118 {
 119         return (uio->uio_resid);
 120 }
 121
 122 static inline off_t
 123 uio_offset(struct uio *uio)
 124 {
 125         return (uio->uio_offset);
 126 }
 127
 128 static inline void
 129 uio_setoffset(struct uio *uio, off_t offset)
 130 {
 131         uio->uio_offset = offset;
 132 }
 133
 134 /* miscellaneous */
 135
 136 static inline bool
 137 fuse_isdeadfs(struct vnode *vp)
 138 {
 139         struct fuse_data *data = fuse_get_mpdata(vnode_mount(vp));
 140
 141         return (data->dataflags & FSESS_DEAD);
 142 }
 143
 144 static inline uint64_t
 145 fuse_iosize(struct vnode *vp)
 146 {
 147         return (vp->v_mount->mnt_stat.f_iosize);
 148 }
 149
 150 /*
 151  * Make a cacheable timeout in bintime format value based on a fuse_attr_out
 152  * response
 153  */
 154 static inline void
 155 fuse_validity_2_bintime(uint64_t attr_valid, uint32_t attr_valid_nsec,
 156         struct bintime *timeout)
 157 {
 158         struct timespec now, duration, timeout_ts;
 159
 160         getnanouptime(&now);
 161         /* "+ 2" is the bound of attr_valid_nsec + now.tv_nsec */
 162         /* Why oh why isn't there a TIME_MAX defined? */
 163         if (attr_valid >= INT_MAX || attr_valid + now.tv_sec + 2 >= INT_MAX) {
 164                 timeout->sec = INT_MAX;
 165         } else {
 166                 duration.tv_sec = attr_valid;
 167                 duration.tv_nsec = attr_valid_nsec;
 168                 timespecadd(&duration, &now, &timeout_ts);
 169                 timespec2bintime(&timeout_ts, timeout);
 170         }
 171 }
 172
 173 /*
 174  * Make a cacheable timeout value in timespec format based on the fuse_entry_out
 175  * response
 176  */
 177 static inline void
 178 fuse_validity_2_timespec(const struct fuse_entry_out *feo,
 179         struct timespec *timeout)
 180 {
 181         struct timespec duration, now;
 182
 183         getnanouptime(&now);
 184         /* "+ 2" is the bound of entry_valid_nsec + now.tv_nsec */
 185         if (feo->entry_valid >= INT_MAX ||
 186             feo->entry_valid + now.tv_sec + 2 >= INT_MAX) {
 187                 timeout->tv_sec = INT_MAX;
 188         } else {
 189                 duration.tv_sec = feo->entry_valid;
 190                 duration.tv_nsec = feo->entry_valid_nsec;
 191                 timespecadd(&duration, &now, timeout);
 192         }
 193 }
 194
 195
 196 /* VFS ops */
 197 int
 198 fuse_internal_get_cached_vnode(struct mount*, ino_t, int, struct vnode**);
 199
 200 /* access */
 201 static inline int
 202 fuse_match_cred(struct ucred *basecred, struct ucred *usercred)
 203 {
 204         if (basecred->cr_uid == usercred->cr_uid             &&
 205             basecred->cr_uid == usercred->cr_ruid            &&
 206             basecred->cr_uid == usercred->cr_svuid           &&
 207             basecred->cr_groups[0] == usercred->cr_groups[0] &&
 208             basecred->cr_groups[0] == usercred->cr_rgid      &&
 209             basecred->cr_groups[0] == usercred->cr_svgid)
 210                 return (0);
 211
 212         return (EPERM);
 213 }
 214
 215 int fuse_internal_access(struct vnode *vp, accmode_t mode,
 216     struct thread *td, struct ucred *cred);
 217
 218 /* attributes */
 219 void fuse_internal_cache_attrs(struct vnode *vp, struct fuse_attr *attr,
 220         uint64_t attr_valid, uint32_t attr_valid_nsec, struct vattr *vap);
 221
 222 /* fsync */
 223
 224 int fuse_internal_fsync(struct vnode *vp, struct thread *td, int waitfor,
 225         bool datasync);
 226 int fuse_internal_fsync_callback(struct fuse_ticket *tick, struct uio *uio);
 227
 228 /* getattr */
 229 int fuse_internal_do_getattr(struct vnode *vp, struct vattr *vap,
 230         struct ucred *cred, struct thread *td);
 231 int fuse_internal_getattr(struct vnode *vp, struct vattr *vap,
 232         struct ucred *cred, struct thread *td);
 233
 234 /* asynchronous invalidation */
 235 int fuse_internal_invalidate_entry(struct mount *mp, struct uio *uio);
 236 int fuse_internal_invalidate_inode(struct mount *mp, struct uio *uio);
 237
 238 /* mknod */
 239 int fuse_internal_mknod(struct vnode *dvp, struct vnode **vpp,
 240         struct componentname *cnp, struct vattr *vap);
 241
 242 /* readdir */
 243 struct pseudo_dirent {
 244         uint32_t d_namlen;
 245 };
 246 int fuse_internal_readdir(struct vnode *vp, struct uio *uio, off_t startoff,
 247     struct fuse_filehandle *fufh, struct fuse_iov *cookediov, int *ncookies,
 248     u_long *cookies);
 249 int fuse_internal_readdir_processdata(struct uio *uio, off_t startoff,
 250     int *fnd_start, size_t reqsize, void *buf, size_t bufsize,
 251     struct fuse_iov *cookediov, int *ncookies, u_long **cookiesp);
 252
 253 /* remove */
 254
 255 int fuse_internal_remove(struct vnode *dvp, struct vnode *vp,
 256     struct componentname *cnp, enum fuse_opcode op);
 257
 258 /* rename */
 259
 260 int fuse_internal_rename(struct vnode *fdvp, struct componentname *fcnp,
 261     struct vnode *tdvp, struct componentname *tcnp);
 262
 263 /* revoke */
 264
 265 void fuse_internal_vnode_disappear(struct vnode *vp);
 266
 267 /* setattr */
 268 int fuse_internal_setattr(struct vnode *vp, struct vattr *va,
 269         struct thread *td, struct ucred *cred);
 270
 271 /* strategy */
 272
 273 /* entity creation */
 274
 275 static inline int
 276 fuse_internal_checkentry(struct fuse_entry_out *feo, enum vtype vtyp)
 277 {
 278         if (vtyp != IFTOVT(feo->attr.mode)) {
 279                 return (EINVAL);
 280         }
 281
 282         if (feo->nodeid == FUSE_NULL_ID) {
 283                 return (EINVAL);
 284         }
 285
 286         if (feo->nodeid == FUSE_ROOT_ID) {
 287                 return (EINVAL);
 288         }
 289
 290         return (0);
 291 }
 292
 293 int fuse_internal_newentry(struct vnode *dvp, struct vnode **vpp,
 294     struct componentname *cnp, enum fuse_opcode op, void *buf, size_t bufsize,
 295     enum vtype vtyp);
 296
 297 void fuse_internal_newentry_makerequest(struct mount *mp, uint64_t dnid,
 298     struct componentname *cnp, enum fuse_opcode op, void *buf, size_t bufsize,
 299     struct fuse_dispatcher *fdip);
 300
 301 int fuse_internal_newentry_core(struct vnode *dvp, struct vnode **vpp,
 302     struct componentname *cnp, enum vtype vtyp, struct fuse_dispatcher *fdip);
 303
 304 /* entity destruction */
 305
 306 int fuse_internal_forget_callback(struct fuse_ticket *tick, struct uio *uio);
 307 void fuse_internal_forget_send(struct mount *mp, struct thread *td,
 308     struct ucred *cred, uint64_t nodeid, uint64_t nlookup);
 309
 310 /* fuse start/stop */
 311
 312 int fuse_internal_init_callback(struct fuse_ticket *tick, struct uio *uio);
 313 void fuse_internal_send_init(struct fuse_data *data, struct thread *td);
 314
 315 #endif /* _FUSE_INTERNAL_H_ */