xref: /freebsd/sys/fs/fuse/fuse_node.h (revision eb69d1f144a6fcc765d1b9d44a5ae8082353e70b)
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_NODE_H_
61 #define _FUSE_NODE_H_
62 
63 #include <sys/types.h>
64 #include <sys/mutex.h>
65 
66 #include "fuse_file.h"
67 
68 #define FN_REVOKED           0x00000020
69 #define FN_FLUSHINPROG       0x00000040
70 #define FN_FLUSHWANT         0x00000080
71 #define FN_SIZECHANGE        0x00000100
72 #define FN_DIRECTIO          0x00000200
73 
74 struct fuse_vnode_data {
75     /** self **/
76     uint64_t   nid;
77 
78     /** parent **/
79     /* XXXIP very likely to be stale, it's not updated in rename() */
80     uint64_t   parent_nid;
81 
82     /** I/O **/
83     struct     fuse_filehandle fufh[FUFH_MAXTYPE];
84 
85     /** flags **/
86     uint32_t   flag;
87 
88     /** meta **/
89     struct vattr      cached_attrs;
90     off_t             filesize;
91     uint64_t          nlookup;
92     enum vtype        vtype;
93 };
94 
95 #define VTOFUD(vp) \
96     ((struct fuse_vnode_data *)((vp)->v_data))
97 #define VTOI(vp)    (VTOFUD(vp)->nid)
98 #define VTOVA(vp)   (&(VTOFUD(vp)->cached_attrs))
99 #define VTOILLU(vp) ((uint64_t)(VTOFUD(vp) ? VTOI(vp) : 0))
100 
101 #define FUSE_NULL_ID 0
102 
103 extern struct vop_vector fuse_vnops;
104 
105 static __inline void
106 fuse_vnode_setparent(struct vnode *vp, struct vnode *dvp)
107 {
108     if (dvp != NULL && vp->v_type == VDIR) {
109         MPASS(dvp->v_type == VDIR);
110         VTOFUD(vp)->parent_nid = VTOI(dvp);
111     }
112 }
113 
114 void fuse_vnode_destroy(struct vnode *vp);
115 
116 int fuse_vnode_get(struct mount         *mp,
117                    uint64_t              nodeid,
118                    struct vnode         *dvp,
119                    struct vnode        **vpp,
120                    struct componentname *cnp,
121                    enum vtype            vtyp);
122 
123 void fuse_vnode_open(struct vnode *vp,
124                      int32_t fuse_open_flags,
125                      struct thread *td);
126 
127 void fuse_vnode_refreshsize(struct vnode *vp, struct ucred *cred);
128 
129 int fuse_vnode_savesize(struct vnode *vp, struct ucred *cred);
130 
131 int fuse_vnode_setsize(struct vnode *vp, struct ucred *cred, off_t newsize);
132 
133 #endif /* _FUSE_NODE_H_ */
134