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 #define FN_ATIMECHANGE 0x00002000 96 97 struct fuse_vnode_data { 98 /** self **/ 99 uint64_t nid; 100 uint64_t generation; 101 102 /** parent **/ 103 uint64_t parent_nid; 104 105 /** I/O **/ 106 /* List of file handles for all of the vnode's open file descriptors */ 107 LIST_HEAD(, fuse_filehandle) handles; 108 109 /** flags **/ 110 uint32_t flag; 111 112 /** meta **/ 113 /* The monotonic time after which the attr cache is invalid */ 114 struct bintime attr_cache_timeout; 115 /* 116 * Monotonic time after which the entry is invalid. Used for lookups 117 * by nodeid instead of pathname. 118 */ 119 struct bintime entry_cache_timeout; 120 /* 121 * Monotonic time of the last FUSE operation that modified the file 122 * size. Used to avoid races between mutator ops like VOP_SETATTR and 123 * unlocked accessor ops like VOP_LOOKUP. 124 */ 125 struct timespec last_local_modify; 126 struct vattr cached_attrs; 127 uint64_t nlookup; 128 enum vtype vtype; 129 struct vn_clusterw clusterw; 130 }; 131 132 /* 133 * This overlays the fid structure (see mount.h). Mostly the same as the types 134 * used by UFS and ext2. 135 */ 136 struct fuse_fid { 137 uint16_t len; /* Length of structure. */ 138 uint16_t pad; /* Force 32-bit alignment. */ 139 uint32_t gen; /* Generation number. */ 140 uint64_t nid; /* FUSE node id. */ 141 }; 142 143 #define VTOFUD(vp) \ 144 ((struct fuse_vnode_data *)((vp)->v_data)) 145 #define VTOI(vp) (VTOFUD(vp)->nid) 146 static inline bool 147 fuse_vnode_attr_cache_valid(struct vnode *vp) 148 { 149 struct bintime now; 150 151 getbinuptime(&now); 152 return (bintime_cmp(&(VTOFUD(vp)->attr_cache_timeout), &now, >)); 153 } 154 155 static inline struct vattr* 156 VTOVA(struct vnode *vp) 157 { 158 if (fuse_vnode_attr_cache_valid(vp)) 159 return &(VTOFUD(vp)->cached_attrs); 160 else 161 return NULL; 162 } 163 164 static inline void 165 fuse_vnode_clear_attr_cache(struct vnode *vp) 166 { 167 bintime_clear(&VTOFUD(vp)->attr_cache_timeout); 168 } 169 170 static uint32_t inline 171 fuse_vnode_hash(uint64_t id) 172 { 173 return (fnv_32_buf(&id, sizeof(id), FNV1_32_INIT)); 174 } 175 176 #define VTOILLU(vp) ((uint64_t)(VTOFUD(vp) ? VTOI(vp) : 0)) 177 178 #define FUSE_NULL_ID 0 179 180 extern struct vop_vector fuse_fifoops; 181 extern struct vop_vector fuse_vnops; 182 183 int fuse_vnode_cmp(struct vnode *vp, void *nidp); 184 185 static inline void 186 fuse_vnode_setparent(struct vnode *vp, struct vnode *dvp) 187 { 188 if (dvp != NULL && vp->v_type == VDIR) { 189 MPASS(dvp->v_type == VDIR); 190 VTOFUD(vp)->parent_nid = VTOI(dvp); 191 VTOFUD(vp)->flag |= FN_PARENT_NID; 192 } else { 193 VTOFUD(vp)->flag &= ~FN_PARENT_NID; 194 } 195 } 196 197 int fuse_vnode_size(struct vnode *vp, off_t *filesize, struct ucred *cred, 198 struct thread *td); 199 200 void fuse_vnode_destroy(struct vnode *vp); 201 202 int fuse_vnode_get(struct mount *mp, struct fuse_entry_out *feo, 203 uint64_t nodeid, struct vnode *dvp, struct vnode **vpp, 204 struct componentname *cnp, enum vtype vtyp); 205 206 void fuse_vnode_open(struct vnode *vp, int32_t fuse_open_flags, 207 struct thread *td); 208 209 int fuse_vnode_savesize(struct vnode *vp, struct ucred *cred, pid_t pid); 210 211 int fuse_vnode_setsize(struct vnode *vp, off_t newsize, bool from_server); 212 213 void fuse_vnode_undirty_cached_timestamps(struct vnode *vp, bool atime); 214 215 void fuse_vnode_update(struct vnode *vp, int flags); 216 217 void fuse_node_init(void); 218 void fuse_node_destroy(void); 219 #endif /* _FUSE_NODE_H_ */ 220