sys/fs/fuse/fuse_node.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  * Copyright (c) 2019 The FreeBSD Foundation
  37  *
  38  * Portions of this software were developed by BFF Storage Systems, LLC under
  39  * sponsorship from the FreeBSD Foundation.
  40  *
  41  * Redistribution and use in source and binary forms, with or without
  42  * modification, are permitted provided that the following conditions
  43  * are met:
  44  * 1. Redistributions of source code must retain the above copyright
  45  *    notice, this list of conditions and the following disclaimer.
  46  * 2. Redistributions in binary form must reproduce the above copyright
  47  *    notice, this list of conditions and the following disclaimer in the
  48  *    documentation and/or other materials provided with the distribution.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  53  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  54  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  55  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  56  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  57  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  58  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  59  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  60  * SUCH DAMAGE.
  61  *
  62  * $FreeBSD$
  63  */
  64
  65 #ifndef _FUSE_NODE_H_
  66 #define _FUSE_NODE_H_
  67
  68 #include <sys/fnv_hash.h>
  69 #include <sys/types.h>
  70 #include <sys/mutex.h>
  71 #include <sys/buf.h>
  72
  73 #include "fuse_file.h"
  74
  75 #define FN_REVOKED              0x00000020
  76 #define FN_FLUSHINPROG          0x00000040
  77 #define FN_FLUSHWANT            0x00000080
  78 /*
  79  * Indicates that the file's size is dirty; the kernel has changed it but not
  80  * yet send the change to the daemon.  When this bit is set, the
  81  * cache_attrs.va_size field does not time out.
  82  */
  83 #define FN_SIZECHANGE           0x00000100
  84 #define FN_DIRECTIO             0x00000200
  85 /* Indicates that parent_nid is valid */
  86 #define FN_PARENT_NID           0x00000400
  87
  88 /*
  89  * Indicates that the file's cached timestamps are dirty.  They will be flushed
  90  * during the next SETATTR or WRITE.  Until then, the cached fields will not
  91  * time out.
  92  */
  93 #define FN_MTIMECHANGE          0x00000800
  94 #define FN_CTIMECHANGE          0x00001000
  95
  96 struct fuse_vnode_data {
  97         /** self **/
  98         uint64_t        nid;
  99         uint64_t        generation;
 100
 101         /** parent **/
 102         uint64_t        parent_nid;
 103
 104         /** I/O **/
 105         /* List of file handles for all of the vnode's open file descriptors */
 106         LIST_HEAD(, fuse_filehandle)    handles;
 107
 108         /** flags **/
 109         uint32_t        flag;
 110
 111         /** meta **/
 112         /* The monotonic time after which the attr cache is invalid */
 113         struct bintime  attr_cache_timeout;
 114         /*
 115          * Monotonic time after which the entry is invalid.  Used for lookups
 116          * by nodeid instead of pathname.
 117          */
 118         struct bintime  entry_cache_timeout;
 119         struct vattr    cached_attrs;
 120         uint64_t        nlookup;
 121         enum vtype      vtype;
 122         struct vn_clusterw clusterw;
 123 };
 124
 125 /*
 126  * This overlays the fid structure (see mount.h). Mostly the same as the types
 127  * used by UFS and ext2.
 128  */
 129 struct fuse_fid {
 130         uint16_t        len;    /* Length of structure. */
 131         uint16_t        pad;    /* Force 32-bit alignment. */
 132         uint32_t        gen;    /* Generation number. */
 133         uint64_t        nid;    /* FUSE node id. */
 134 };
 135
 136 #define VTOFUD(vp) \
 137         ((struct fuse_vnode_data *)((vp)->v_data))
 138 #define VTOI(vp)    (VTOFUD(vp)->nid)
 139 static inline bool
 140 fuse_vnode_attr_cache_valid(struct vnode *vp)
 141 {
 142         struct bintime now;
 143
 144         getbinuptime(&now);
 145         return (bintime_cmp(&(VTOFUD(vp)->attr_cache_timeout), &now, >));
 146 }
 147
 148 static inline struct vattr*
 149 VTOVA(struct vnode *vp)
 150 {
 151         if (fuse_vnode_attr_cache_valid(vp))
 152                 return &(VTOFUD(vp)->cached_attrs);
 153         else
 154                 return NULL;
 155 }
 156
 157 static inline void
 158 fuse_vnode_clear_attr_cache(struct vnode *vp)
 159 {
 160         bintime_clear(&VTOFUD(vp)->attr_cache_timeout);
 161 }
 162
 163 static uint32_t inline
 164 fuse_vnode_hash(uint64_t id)
 165 {
 166         return (fnv_32_buf(&id, sizeof(id), FNV1_32_INIT));
 167 }
 168
 169 #define VTOILLU(vp) ((uint64_t)(VTOFUD(vp) ? VTOI(vp) : 0))
 170
 171 #define FUSE_NULL_ID 0
 172
 173 extern struct vop_vector fuse_fifoops;
 174 extern struct vop_vector fuse_vnops;
 175
 176 int fuse_vnode_cmp(struct vnode *vp, void *nidp);
 177
 178 static inline void
 179 fuse_vnode_setparent(struct vnode *vp, struct vnode *dvp)
 180 {
 181         if (dvp != NULL && vp->v_type == VDIR) {
 182                 MPASS(dvp->v_type == VDIR);
 183                 VTOFUD(vp)->parent_nid = VTOI(dvp);
 184                 VTOFUD(vp)->flag |= FN_PARENT_NID;
 185         } else {
 186                 VTOFUD(vp)->flag &= ~FN_PARENT_NID;
 187         }
 188 }
 189
 190 int fuse_vnode_size(struct vnode *vp, off_t *filesize, struct ucred *cred,
 191         struct thread *td);
 192
 193 void fuse_vnode_destroy(struct vnode *vp);
 194
 195 int fuse_vnode_get(struct mount *mp, struct fuse_entry_out *feo,
 196     uint64_t nodeid, struct vnode *dvp, struct vnode **vpp,
 197     struct componentname *cnp, enum vtype vtyp);
 198
 199 void fuse_vnode_open(struct vnode *vp, int32_t fuse_open_flags,
 200     struct thread *td);
 201
 202 int fuse_vnode_savesize(struct vnode *vp, struct ucred *cred, pid_t pid);
 203
 204 int fuse_vnode_setsize(struct vnode *vp, off_t newsize, bool from_server);
 205
 206 void fuse_vnode_undirty_cached_timestamps(struct vnode *vp);
 207
 208 void fuse_vnode_update(struct vnode *vp, int flags);
 209
 210 void fuse_node_init(void);
 211 void fuse_node_destroy(void);
 212 #endif /* _FUSE_NODE_H_ */