sys/fs/fuse/fuse_node.c

   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
  58 #include <sys/cdefs.h>
  59 __FBSDID("$FreeBSD$");
  60
  61 #include <sys/types.h>
  62 #include <sys/module.h>
  63 #include <sys/systm.h>
  64 #include <sys/errno.h>
  65 #include <sys/param.h>
  66 #include <sys/kernel.h>
  67 #include <sys/conf.h>
  68 #include <sys/uio.h>
  69 #include <sys/malloc.h>
  70 #include <sys/queue.h>
  71 #include <sys/lock.h>
  72 #include <sys/sx.h>
  73 #include <sys/mutex.h>
  74 #include <sys/proc.h>
  75 #include <sys/vnode.h>
  76 #include <sys/namei.h>
  77 #include <sys/mount.h>
  78 #include <sys/sysctl.h>
  79 #include <sys/fcntl.h>
  80 #include <sys/fnv_hash.h>
  81 #include <sys/priv.h>
  82 #include <security/mac/mac_framework.h>
  83 #include <vm/vm.h>
  84 #include <vm/vm_extern.h>
  85
  86 #include "fuse.h"
  87 #include "fuse_node.h"
  88 #include "fuse_internal.h"
  89 #include "fuse_io.h"
  90 #include "fuse_ipc.h"
  91
  92 #define FUSE_DEBUG_MODULE VNOPS
  93 #include "fuse_debug.h"
  94
  95 MALLOC_DEFINE(M_FUSEVN, "fuse_vnode", "fuse vnode private data");
  96
  97 static int fuse_node_count = 0;
  98
  99 SYSCTL_INT(_vfs_fuse, OID_AUTO, node_count, CTLFLAG_RD,
 100     &fuse_node_count, 0, "Count of FUSE vnodes");
 101
 102 int     fuse_data_cache_enable = 1;
 103
 104 SYSCTL_INT(_vfs_fuse, OID_AUTO, data_cache_enable, CTLFLAG_RW,
 105     &fuse_data_cache_enable, 0,
 106     "enable caching of FUSE file data (including dirty data)");
 107
 108 int     fuse_data_cache_invalidate = 0;
 109
 110 SYSCTL_INT(_vfs_fuse, OID_AUTO, data_cache_invalidate, CTLFLAG_RW,
 111     &fuse_data_cache_invalidate, 0,
 112     "If non-zero, discard cached clean file data when there are no active file"
 113     " users");
 114
 115 int     fuse_mmap_enable = 1;
 116
 117 SYSCTL_INT(_vfs_fuse, OID_AUTO, mmap_enable, CTLFLAG_RW,
 118     &fuse_mmap_enable, 0,
 119     "If non-zero, and data_cache_enable is also non-zero, enable mmap(2) of "
 120     "FUSE files");
 121
 122 int     fuse_refresh_size = 0;
 123
 124 SYSCTL_INT(_vfs_fuse, OID_AUTO, refresh_size, CTLFLAG_RW,
 125     &fuse_refresh_size, 0,
 126     "If non-zero, and no dirty file extension data is buffered, fetch file "
 127     "size before write operations");
 128
 129 int     fuse_sync_resize = 1;
 130
 131 SYSCTL_INT(_vfs_fuse, OID_AUTO, sync_resize, CTLFLAG_RW,
 132     &fuse_sync_resize, 0,
 133     "If a cached write extended a file, inform FUSE filesystem of the changed"
 134     "size immediately subsequent to the issued writes");
 135
 136 int     fuse_fix_broken_io = 0;
 137
 138 SYSCTL_INT(_vfs_fuse, OID_AUTO, fix_broken_io, CTLFLAG_RW,
 139     &fuse_fix_broken_io, 0,
 140     "If non-zero, print a diagnostic warning if a userspace filesystem returns"
 141     " EIO on reads of recently extended portions of files");
 142
 143 static void
 144 fuse_vnode_init(struct vnode *vp, struct fuse_vnode_data *fvdat,
 145     uint64_t nodeid, enum vtype vtyp)
 146 {
 147         int i;
 148
 149         fvdat->nid = nodeid;
 150         vattr_null(&fvdat->cached_attrs);
 151         if (nodeid == FUSE_ROOT_ID) {
 152                 vp->v_vflag |= VV_ROOT;
 153         }
 154         vp->v_type = vtyp;
 155         vp->v_data = fvdat;
 156
 157         for (i = 0; i < FUFH_MAXTYPE; i++)
 158                 fvdat->fufh[i].fh_type = FUFH_INVALID;
 159
 160         atomic_add_acq_int(&fuse_node_count, 1);
 161 }
 162
 163 void
 164 fuse_vnode_destroy(struct vnode *vp)
 165 {
 166         struct fuse_vnode_data *fvdat = vp->v_data;
 167
 168         vp->v_data = NULL;
 169         free(fvdat, M_FUSEVN);
 170
 171         atomic_subtract_acq_int(&fuse_node_count, 1);
 172 }
 173
 174 static int
 175 fuse_vnode_cmp(struct vnode *vp, void *nidp)
 176 {
 177         return (VTOI(vp) != *((uint64_t *)nidp));
 178 }
 179
 180 static uint32_t __inline
 181 fuse_vnode_hash(uint64_t id)
 182 {
 183         return (fnv_32_buf(&id, sizeof(id), FNV1_32_INIT));
 184 }
 185
 186 static int
 187 fuse_vnode_alloc(struct mount *mp,
 188     struct thread *td,
 189     uint64_t nodeid,
 190     enum vtype vtyp,
 191     struct vnode **vpp)
 192 {
 193         struct fuse_vnode_data *fvdat;
 194         struct vnode *vp2;
 195         int err = 0;
 196
 197         FS_DEBUG("been asked for vno #%ju\n", (uintmax_t)nodeid);
 198
 199         if (vtyp == VNON) {
 200                 return EINVAL;
 201         }
 202         *vpp = NULL;
 203         err = vfs_hash_get(mp, fuse_vnode_hash(nodeid), LK_EXCLUSIVE, td, vpp,
 204             fuse_vnode_cmp, &nodeid);
 205         if (err)
 206                 return (err);
 207
 208         if (*vpp) {
 209                 MPASS((*vpp)->v_type == vtyp && (*vpp)->v_data != NULL);
 210                 FS_DEBUG("vnode taken from hash\n");
 211                 return (0);
 212         }
 213         fvdat = malloc(sizeof(*fvdat), M_FUSEVN, M_WAITOK | M_ZERO);
 214         err = getnewvnode("fuse", mp, &fuse_vnops, vpp);
 215         if (err) {
 216                 free(fvdat, M_FUSEVN);
 217                 return (err);
 218         }
 219         lockmgr((*vpp)->v_vnlock, LK_EXCLUSIVE, NULL);
 220         fuse_vnode_init(*vpp, fvdat, nodeid, vtyp);
 221         err = insmntque(*vpp, mp);
 222         ASSERT_VOP_ELOCKED(*vpp, "fuse_vnode_alloc");
 223         if (err) {
 224                 free(fvdat, M_FUSEVN);
 225                 *vpp = NULL;
 226                 return (err);
 227         }
 228         err = vfs_hash_insert(*vpp, fuse_vnode_hash(nodeid), LK_EXCLUSIVE,
 229             td, &vp2, fuse_vnode_cmp, &nodeid);
 230         if (err)
 231                 return (err);
 232         if (vp2 != NULL) {
 233                 *vpp = vp2;
 234                 return (0);
 235         }
 236
 237         ASSERT_VOP_ELOCKED(*vpp, "fuse_vnode_alloc");
 238
 239         return (0);
 240 }
 241
 242 int
 243 fuse_vnode_get(struct mount *mp,
 244     struct fuse_entry_out *feo,
 245     uint64_t nodeid,
 246     struct vnode *dvp,
 247     struct vnode **vpp,
 248     struct componentname *cnp,
 249     enum vtype vtyp)
 250 {
 251         struct thread *td = (cnp != NULL ? cnp->cn_thread : curthread);
 252         int err = 0;
 253
 254         debug_printf("dvp=%p\n", dvp);
 255
 256         err = fuse_vnode_alloc(mp, td, nodeid, vtyp, vpp);
 257         if (err) {
 258                 return err;
 259         }
 260         if (dvp != NULL) {
 261                 MPASS((cnp->cn_flags & ISDOTDOT) == 0);
 262                 MPASS(!(cnp->cn_namelen == 1 && cnp->cn_nameptr[0] == '.'));
 263                 fuse_vnode_setparent(*vpp, dvp);
 264         }
 265         if (dvp != NULL && cnp != NULL && (cnp->cn_flags & MAKEENTRY) != 0 &&
 266             feo != NULL &&
 267             (feo->entry_valid != 0 || feo->entry_valid_nsec != 0)) {
 268                 ASSERT_VOP_LOCKED(*vpp, "fuse_vnode_get");
 269                 ASSERT_VOP_LOCKED(dvp, "fuse_vnode_get");
 270                 cache_enter(dvp, *vpp, cnp);
 271         }
 272
 273         /*
 274          * In userland, libfuse uses cached lookups for dot and dotdot entries,
 275          * thus it does not really bump the nlookup counter for forget.
 276          * Follow the same semantic and avoid tu bump it in order to keep
 277          * nlookup counters consistent.
 278          */
 279         if (cnp == NULL || ((cnp->cn_flags & ISDOTDOT) == 0 &&
 280             (cnp->cn_namelen != 1 || cnp->cn_nameptr[0] != '.')))
 281                 VTOFUD(*vpp)->nlookup++;
 282
 283         return 0;
 284 }
 285
 286 void
 287 fuse_vnode_open(struct vnode *vp, int32_t fuse_open_flags, struct thread *td)
 288 {
 289         /*
 290          * Funcation is called for every vnode open.
 291          * Merge fuse_open_flags it may be 0
 292          */
 293         /*
 294          * Ideally speaking, direct io should be enabled on
 295          * fd's but do not see of any way of providing that
 296          * this implementation.
 297          *
 298          * Also cannot think of a reason why would two
 299          * different fd's on same vnode would like
 300          * have DIRECT_IO turned on and off. But linux
 301          * based implementation works on an fd not an
 302          * inode and provides such a feature.
 303          *
 304          * XXXIP: Handle fd based DIRECT_IO
 305          */
 306         if (fuse_open_flags & FOPEN_DIRECT_IO) {
 307                 ASSERT_VOP_ELOCKED(vp, __func__);
 308                 VTOFUD(vp)->flag |= FN_DIRECTIO;
 309                 fuse_io_invalbuf(vp, td);
 310         } else {
 311                 if ((fuse_open_flags & FOPEN_KEEP_CACHE) == 0)
 312                         fuse_io_invalbuf(vp, td);
 313                 VTOFUD(vp)->flag &= ~FN_DIRECTIO;
 314         }
 315
 316         if (vnode_vtype(vp) == VREG) {
 317                 /* XXXIP prevent getattr, by using cached node size */
 318                 vnode_create_vobject(vp, 0, td);
 319         }
 320 }
 321
 322 int
 323 fuse_vnode_savesize(struct vnode *vp, struct ucred *cred)
 324 {
 325         struct fuse_vnode_data *fvdat = VTOFUD(vp);
 326         struct thread *td = curthread;
 327         struct fuse_filehandle *fufh = NULL;
 328         struct fuse_dispatcher fdi;
 329         struct fuse_setattr_in *fsai;
 330         int err = 0;
 331
 332         FS_DEBUG("inode=%ju size=%ju\n", (uintmax_t)VTOI(vp),
 333             (uintmax_t)fvdat->filesize);
 334         ASSERT_VOP_ELOCKED(vp, "fuse_io_extend");
 335
 336         if (fuse_isdeadfs(vp)) {
 337                 return EBADF;
 338         }
 339         if (vnode_vtype(vp) == VDIR) {
 340                 return EISDIR;
 341         }
 342         if (vfs_isrdonly(vnode_mount(vp))) {
 343                 return EROFS;
 344         }
 345         if (cred == NULL) {
 346                 cred = td->td_ucred;
 347         }
 348         fdisp_init(&fdi, sizeof(*fsai));
 349         fdisp_make_vp(&fdi, FUSE_SETATTR, vp, td, cred);
 350         fsai = fdi.indata;
 351         fsai->valid = 0;
 352
 353         /* Truncate to a new value. */
 354         fsai->size = fvdat->filesize;
 355         fsai->valid |= FATTR_SIZE;
 356
 357         fuse_filehandle_getrw(vp, FUFH_WRONLY, &fufh);
 358         if (fufh) {
 359                 fsai->fh = fufh->fh_id;
 360                 fsai->valid |= FATTR_FH;
 361         }
 362         err = fdisp_wait_answ(&fdi);
 363         fdisp_destroy(&fdi);
 364         if (err == 0)
 365                 fvdat->flag &= ~FN_SIZECHANGE;
 366
 367         return err;
 368 }
 369
 370 void
 371 fuse_vnode_refreshsize(struct vnode *vp, struct ucred *cred)
 372 {
 373
 374         struct fuse_vnode_data *fvdat = VTOFUD(vp);
 375         struct vattr va;
 376
 377         if ((fvdat->flag & FN_SIZECHANGE) != 0 ||
 378             (fuse_refresh_size == 0 && fvdat->filesize != 0))
 379                 return;
 380
 381         VOP_GETATTR(vp, &va, cred);
 382         FS_DEBUG("refreshed file size: %jd\n", (intmax_t)VTOFUD(vp)->filesize);
 383 }
 384
 385 int
 386 fuse_vnode_setsize(struct vnode *vp, struct ucred *cred, off_t newsize)
 387 {
 388         struct fuse_vnode_data *fvdat = VTOFUD(vp);
 389         off_t oldsize;
 390         int err = 0;
 391
 392         FS_DEBUG("inode=%ju oldsize=%ju newsize=%ju\n",
 393             (uintmax_t)VTOI(vp), (uintmax_t)fvdat->filesize,
 394             (uintmax_t)newsize);
 395         ASSERT_VOP_ELOCKED(vp, "fuse_vnode_setsize");
 396
 397         oldsize = fvdat->filesize;
 398         fvdat->filesize = newsize;
 399         fvdat->flag |= FN_SIZECHANGE;
 400
 401         if (newsize < oldsize) {
 402                 err = vtruncbuf(vp, cred, newsize, fuse_iosize(vp));
 403         }
 404         vnode_pager_setsize(vp, newsize);
 405         return err;
 406 }