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
  72 #include "fuse_file.h"
  73
  74 #define FN_REVOKED              0x00000020
  75 #define FN_FLUSHINPROG          0x00000040
  76 #define FN_FLUSHWANT            0x00000080
  77 /*
  78  * Indicates that the file's size is dirty; the kernel has changed it but not
  79  * yet send the change to the daemon.  When this bit is set, the
  80  * cache_attrs.va_size field does not time out.
  81  */
  82 #define FN_SIZECHANGE           0x00000100
  83 #define FN_DIRECTIO             0x00000200
  84 /* Indicates that parent_nid is valid */
  85 #define FN_PARENT_NID           0x00000400
  86
  87 /*
  88  * Indicates that the file's cached timestamps are dirty.  They will be flushed
  89  * during the next SETATTR or WRITE.  Until then, the cached fields will not
  90  * time out.
  91  */
  92 #define FN_MTIMECHANGE          0x00000800
  93 #define FN_CTIMECHANGE          0x00001000
  94
  95 struct fuse_vnode_data {
  96         /** self **/
  97         uint64_t        nid;
  98         uint64_t        generation;
  99
 100         /** parent **/
 101         uint64_t        parent_nid;
 102
 103         /** I/O **/
 104         /* List of file handles for all of the vnode's open file descriptors */
 105         LIST_HEAD(, fuse_filehandle)    handles;
 106
 107         /** flags **/
 108         uint32_t        flag;
 109
 110         /** meta **/
 111         /* The monotonic time after which the attr cache is invalid */
 112         struct bintime  attr_cache_timeout;
 113         /*
 114          * Monotonic time after which the entry is invalid.  Used for lookups
 115          * by nodeid instead of pathname.
 116          */
 117         struct bintime  entry_cache_timeout;
 118         struct vattr    cached_attrs;
 119         uint64_t        nlookup;
 120         enum vtype      vtype;
 121 };
 122
 123 /*
 124  * This overlays the fid structure (see mount.h). Mostly the same as the types
 125  * used by UFS and ext2.
 126  */
 127 struct fuse_fid {
 128         uint16_t        len;    /* Length of structure. */
 129         uint16_t        pad;    /* Force 32-bit alignment. */
 130         uint32_t        gen;    /* Generation number. */
 131         uint64_t        nid;    /* FUSE node id. */
 132 };
 133
 134 #define VTOFUD(vp) \
 135         ((struct fuse_vnode_data *)((vp)->v_data))
 136 #define VTOI(vp)    (VTOFUD(vp)->nid)
 137 static inline bool
 138 fuse_vnode_attr_cache_valid(struct vnode *vp)
 139 {
 140         struct bintime now;
 141
 142         getbinuptime(&now);
 143         return (bintime_cmp(&(VTOFUD(vp)->attr_cache_timeout), &now, >));
 144 }
 145
 146 static inline struct vattr*
 147 VTOVA(struct vnode *vp)
 148 {
 149         if (fuse_vnode_attr_cache_valid(vp))
 150                 return &(VTOFUD(vp)->cached_attrs);
 151         else
 152                 return NULL;
 153 }
 154
 155 static inline void
 156 fuse_vnode_clear_attr_cache(struct vnode *vp)
 157 {
 158         bintime_clear(&VTOFUD(vp)->attr_cache_timeout);
 159 }
 160
 161 static uint32_t inline
 162 fuse_vnode_hash(uint64_t id)
 163 {
 164         return (fnv_32_buf(&id, sizeof(id), FNV1_32_INIT));
 165 }
 166
 167 #define VTOILLU(vp) ((uint64_t)(VTOFUD(vp) ? VTOI(vp) : 0))
 168
 169 #define FUSE_NULL_ID 0
 170
 171 extern struct vop_vector fuse_fifoops;
 172 extern struct vop_vector fuse_vnops;
 173
 174 int fuse_vnode_cmp(struct vnode *vp, void *nidp);
 175
 176 static inline void
 177 fuse_vnode_setparent(struct vnode *vp, struct vnode *dvp)
 178 {
 179         if (dvp != NULL && vp->v_type == VDIR) {
 180                 MPASS(dvp->v_type == VDIR);
 181                 VTOFUD(vp)->parent_nid = VTOI(dvp);
 182                 VTOFUD(vp)->flag |= FN_PARENT_NID;
 183         } else {
 184                 VTOFUD(vp)->flag &= ~FN_PARENT_NID;
 185         }
 186 }
 187
 188 int fuse_vnode_size(struct vnode *vp, off_t *filesize, struct ucred *cred,
 189         struct thread *td);
 190
 191 void fuse_vnode_destroy(struct vnode *vp);
 192
 193 int fuse_vnode_get(struct mount *mp, struct fuse_entry_out *feo,
 194     uint64_t nodeid, struct vnode *dvp, struct vnode **vpp,
 195     struct componentname *cnp, enum vtype vtyp);
 196
 197 void fuse_vnode_open(struct vnode *vp, int32_t fuse_open_flags,
 198     struct thread *td);
 199
 200 int fuse_vnode_savesize(struct vnode *vp, struct ucred *cred, pid_t pid);
 201
 202 int fuse_vnode_setsize(struct vnode *vp, off_t newsize);
 203
 204 void fuse_vnode_undirty_cached_timestamps(struct vnode *vp);
 205
 206 void fuse_vnode_update(struct vnode *vp, int flags);
 207
 208 void fuse_node_init(void);
 209 void fuse_node_destroy(void);
 210 #endif /* _FUSE_NODE_H_ */