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 static __inline int
  72 vfs_isrdonly(struct mount *mp)
  73 {
  74     return ((mp->mnt_flag & MNT_RDONLY) != 0 ? 1 : 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 int
  84 vnode_mountedhere(struct vnode *vp)
  85 {
  86         return (vp->v_mountedhere != NULL ? 1 : 0);
  87 }
  88
  89 static __inline enum vtype
  90 vnode_vtype(struct vnode *vp)
  91 {
  92     return (vp->v_type);
  93 }
  94
  95 static __inline int
  96 vnode_isvroot(struct vnode *vp)
  97 {
  98     return ((vp->v_vflag & VV_ROOT) != 0 ? 1 : 0);
  99 }
 100
 101 static __inline int
 102 vnode_isreg(struct vnode *vp)
 103 {
 104     return (vp->v_type == VREG ? 1 : 0);
 105 }
 106
 107 static __inline int
 108 vnode_isdir(struct vnode *vp)
 109 {
 110     return (vp->v_type == VDIR ? 1 : 0);
 111 }
 112
 113 static __inline int
 114 vnode_islnk(struct vnode *vp)
 115 {
 116     return (vp->v_type == VLNK ? 1 : 0);
 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__
 146 int
 147 fuse_isdeadfs(struct vnode *vp)
 148 {
 149     struct fuse_data *data = fuse_get_mpdata(vnode_mount(vp));
 150
 151     return (data->dataflags & FSESS_DEAD);
 152 }
 153
 154 static __inline__
 155 int
 156 fuse_iosize(struct vnode *vp)
 157 {
 158     return vp->v_mount->mnt_stat.f_iosize;
 159 }
 160
 161 /* access */
 162
 163 #define FVP_ACCESS_NOOP   0x01
 164
 165 #define FACCESS_VA_VALID   0x01
 166 #define FACCESS_DO_ACCESS  0x02
 167 #define FACCESS_STICKY     0x04
 168 #define FACCESS_CHOWN      0x08
 169 #define FACCESS_NOCHECKSPY 0x10
 170 #define FACCESS_SETGID     0x12
 171
 172 #define FACCESS_XQUERIES FACCESS_STICKY | FACCESS_CHOWN | FACCESS_SETGID
 173
 174 struct fuse_access_param {
 175     uid_t    xuid;
 176     gid_t    xgid;
 177     uint32_t facc_flags;
 178 };
 179
 180 static __inline int
 181 fuse_match_cred(struct ucred *basecred, struct ucred *usercred)
 182 {
 183         if (basecred->cr_uid == usercred->cr_uid             &&
 184             basecred->cr_uid == usercred->cr_ruid            &&
 185             basecred->cr_uid == usercred->cr_svuid           &&
 186             basecred->cr_groups[0] == usercred->cr_groups[0] &&
 187             basecred->cr_groups[0] == usercred->cr_rgid      &&
 188             basecred->cr_groups[0] == usercred->cr_svgid)
 189                 return 0;
 190
 191         return EPERM;
 192 }
 193
 194 int
 195 fuse_internal_access(struct vnode *vp,
 196                      mode_t mode,
 197                      struct fuse_access_param *facp,
 198                      struct thread *td,
 199                      struct ucred *cred);
 200
 201 /* attributes */
 202
 203 static __inline
 204 void
 205 fuse_internal_attr_fat2vat(struct mount *mp,
 206                            struct fuse_attr *fat,
 207                            struct vattr *vap)
 208 {
 209     DEBUGX(FUSE_DEBUG_INTERNAL,
 210         "node #%ju, mode 0%o\n", (uintmax_t)fat->ino, fat->mode);
 211
 212     vattr_null(vap);
 213
 214     vap->va_fsid = mp->mnt_stat.f_fsid.val[0];
 215     vap->va_fileid = fat->ino;
 216     vap->va_mode = fat->mode & ~S_IFMT;
 217     vap->va_nlink     = fat->nlink;
 218     vap->va_uid       = fat->uid;
 219     vap->va_gid       = fat->gid;
 220     vap->va_rdev      = fat->rdev;
 221     vap->va_size      = fat->size;
 222     vap->va_atime.tv_sec  = fat->atime; /* XXX on some platforms cast from 64 bits to 32 */
 223     vap->va_atime.tv_nsec = fat->atimensec;
 224     vap->va_mtime.tv_sec  = fat->mtime;
 225     vap->va_mtime.tv_nsec = fat->mtimensec;
 226     vap->va_ctime.tv_sec  = fat->ctime;
 227     vap->va_ctime.tv_nsec = fat->ctimensec;
 228     vap->va_blocksize = PAGE_SIZE;
 229     vap->va_type = IFTOVT(fat->mode);
 230
 231 #if (S_BLKSIZE == 512)
 232     /* Optimize this case */
 233     vap->va_bytes = fat->blocks << 9;
 234 #else
 235     vap->va_bytes = fat->blocks * S_BLKSIZE;
 236 #endif
 237
 238     vap->va_flags = 0;
 239 }
 240
 241
 242 #define cache_attrs(vp, fuse_out)                                       \
 243         fuse_internal_attr_fat2vat(vnode_mount(vp), &(fuse_out)->attr,  \
 244             VTOVA(vp));
 245
 246 /* fsync */
 247
 248 int
 249 fuse_internal_fsync(struct vnode           *vp,
 250                     struct thread          *td,
 251                     struct ucred           *cred,
 252                     struct fuse_filehandle *fufh);
 253
 254 int
 255 fuse_internal_fsync_callback(struct fuse_ticket *tick, struct uio *uio);
 256
 257 /* readdir */
 258
 259 struct pseudo_dirent {
 260     uint32_t d_namlen;
 261 };
 262
 263 int
 264 fuse_internal_readdir(struct vnode           *vp,
 265                       struct uio             *uio,
 266                       struct fuse_filehandle *fufh,
 267                       struct fuse_iov        *cookediov);
 268
 269 int
 270 fuse_internal_readdir_processdata(struct uio *uio,
 271                                   size_t reqsize,
 272                                   void *buf,
 273                                   size_t bufsize,
 274                                   void *param);
 275
 276 /* remove */
 277
 278 int
 279 fuse_internal_remove(struct vnode *dvp,
 280                      struct vnode *vp,
 281                      struct componentname *cnp,
 282                      enum fuse_opcode op);
 283
 284 /* rename */
 285
 286 int
 287 fuse_internal_rename(struct vnode *fdvp,
 288                      struct componentname *fcnp,
 289                      struct vnode *tdvp,
 290                      struct componentname *tcnp);
 291 /* revoke */
 292
 293 void
 294 fuse_internal_vnode_disappear(struct vnode *vp);
 295
 296 /* strategy */
 297
 298 /* entity creation */
 299
 300 static __inline
 301 int
 302 fuse_internal_checkentry(struct fuse_entry_out *feo, enum vtype vtyp)
 303 {
 304     DEBUGX(FUSE_DEBUG_INTERNAL,
 305         "feo=%p, vtype=%d\n", feo, vtyp);
 306
 307     if (vtyp != IFTOVT(feo->attr.mode)) {
 308         DEBUGX(FUSE_DEBUG_INTERNAL,
 309             "EINVAL -- %x != %x\n", vtyp, IFTOVT(feo->attr.mode));
 310         return EINVAL;
 311     }
 312
 313     if (feo->nodeid == FUSE_NULL_ID) {
 314         DEBUGX(FUSE_DEBUG_INTERNAL,
 315             "EINVAL -- feo->nodeid is NULL\n");
 316         return EINVAL;
 317     }
 318
 319     if (feo->nodeid == FUSE_ROOT_ID) {
 320         DEBUGX(FUSE_DEBUG_INTERNAL,
 321             "EINVAL -- feo->nodeid is FUSE_ROOT_ID\n");
 322         return EINVAL;
 323     }
 324
 325     return 0;
 326 }
 327
 328 int
 329 fuse_internal_newentry(struct vnode *dvp,
 330                        struct vnode **vpp,
 331                        struct componentname *cnp,
 332                        enum fuse_opcode op,
 333                        void *buf,
 334                        size_t bufsize,
 335                        enum vtype vtyp);
 336
 337 void
 338 fuse_internal_newentry_makerequest(struct mount *mp,
 339                                    uint64_t dnid,
 340                                    struct componentname *cnp,
 341                                    enum fuse_opcode op,
 342                                    void *buf,
 343                                    size_t bufsize,
 344                                    struct fuse_dispatcher *fdip);
 345
 346 int
 347 fuse_internal_newentry_core(struct vnode *dvp,
 348                             struct vnode **vpp,
 349                             struct componentname   *cnp,
 350                             enum vtype vtyp,
 351                             struct fuse_dispatcher *fdip);
 352
 353 /* entity destruction */
 354
 355 int
 356 fuse_internal_forget_callback(struct fuse_ticket *tick, struct uio *uio);
 357
 358 void
 359 fuse_internal_forget_send(struct mount *mp,
 360                           struct thread *td,
 361                           struct ucred *cred,
 362                           uint64_t nodeid,
 363                           uint64_t nlookup);
 364
 365 /* fuse start/stop */
 366
 367 int fuse_internal_init_callback(struct fuse_ticket *tick, struct uio *uio);
 368 void fuse_internal_send_init(struct fuse_data *data, struct thread *td);
 369
 370 #endif /* _FUSE_INTERNAL_H_ */