nfsnode.h revision 1.1.1.1.10.3 1 1.1.1.1.10.2 tls /* $NetBSD: nfsnode.h,v 1.1.1.1.10.3 2017/12/03 11:38:42 jdolecek Exp $ */
2 1.1.1.1.10.2 tls /*-
3 1.1.1.1.10.2 tls * Copyright (c) 1989, 1993
4 1.1.1.1.10.2 tls * The Regents of the University of California. All rights reserved.
5 1.1.1.1.10.2 tls *
6 1.1.1.1.10.2 tls * This code is derived from software contributed to Berkeley by
7 1.1.1.1.10.2 tls * Rick Macklem at The University of Guelph.
8 1.1.1.1.10.2 tls *
9 1.1.1.1.10.2 tls * Redistribution and use in source and binary forms, with or without
10 1.1.1.1.10.2 tls * modification, are permitted provided that the following conditions
11 1.1.1.1.10.2 tls * are met:
12 1.1.1.1.10.2 tls * 1. Redistributions of source code must retain the above copyright
13 1.1.1.1.10.2 tls * notice, this list of conditions and the following disclaimer.
14 1.1.1.1.10.2 tls * 2. Redistributions in binary form must reproduce the above copyright
15 1.1.1.1.10.2 tls * notice, this list of conditions and the following disclaimer in the
16 1.1.1.1.10.2 tls * documentation and/or other materials provided with the distribution.
17 1.1.1.1.10.2 tls * 4. Neither the name of the University nor the names of its contributors
18 1.1.1.1.10.2 tls * may be used to endorse or promote products derived from this software
19 1.1.1.1.10.2 tls * without specific prior written permission.
20 1.1.1.1.10.2 tls *
21 1.1.1.1.10.2 tls * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 1.1.1.1.10.2 tls * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 1.1.1.1.10.2 tls * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 1.1.1.1.10.2 tls * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 1.1.1.1.10.2 tls * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 1.1.1.1.10.2 tls * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 1.1.1.1.10.2 tls * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 1.1.1.1.10.2 tls * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 1.1.1.1.10.2 tls * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 1.1.1.1.10.2 tls * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 1.1.1.1.10.2 tls * SUCH DAMAGE.
32 1.1.1.1.10.2 tls *
33 1.1.1.1.10.3 jdolecek * FreeBSD: head/sys/fs/nfsclient/nfsnode.h 303715 2016-08-03 15:58:20Z kib
34 1.1.1.1.10.2 tls * $NetBSD: nfsnode.h,v 1.1.1.1.10.3 2017/12/03 11:38:42 jdolecek Exp $
35 1.1.1.1.10.2 tls */
36 1.1.1.1.10.2 tls
37 1.1.1.1.10.2 tls #ifndef _NFSCLIENT_NFSNODE_H_
38 1.1.1.1.10.2 tls #define _NFSCLIENT_NFSNODE_H_
39 1.1.1.1.10.2 tls
40 1.1.1.1.10.2 tls /*
41 1.1.1.1.10.2 tls * Silly rename structure that hangs off the nfsnode until the name
42 1.1.1.1.10.2 tls * can be removed by nfs_inactive()
43 1.1.1.1.10.2 tls */
44 1.1.1.1.10.2 tls struct sillyrename {
45 1.1.1.1.10.2 tls struct ucred *s_cred;
46 1.1.1.1.10.2 tls struct vnode *s_dvp;
47 1.1.1.1.10.2 tls long s_namlen;
48 1.1.1.1.10.2 tls char s_name[32];
49 1.1.1.1.10.2 tls };
50 1.1.1.1.10.2 tls
51 1.1.1.1.10.2 tls /*
52 1.1.1.1.10.2 tls * This structure is used to save the logical directory offset to
53 1.1.1.1.10.2 tls * NFS cookie mappings.
54 1.1.1.1.10.2 tls * The mappings are stored in a list headed
55 1.1.1.1.10.2 tls * by n_cookies, as required.
56 1.1.1.1.10.2 tls * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
57 1.1.1.1.10.2 tls * stored in increasing logical offset byte order.
58 1.1.1.1.10.2 tls */
59 1.1.1.1.10.2 tls #define NFSNUMCOOKIES 31
60 1.1.1.1.10.2 tls
61 1.1.1.1.10.2 tls struct nfsdmap {
62 1.1.1.1.10.2 tls LIST_ENTRY(nfsdmap) ndm_list;
63 1.1.1.1.10.2 tls int ndm_eocookie;
64 1.1.1.1.10.2 tls union {
65 1.1.1.1.10.2 tls nfsuint64 ndmu3_cookies[NFSNUMCOOKIES];
66 1.1.1.1.10.2 tls uint64_t ndmu4_cookies[NFSNUMCOOKIES];
67 1.1.1.1.10.2 tls } ndm_un1;
68 1.1.1.1.10.2 tls };
69 1.1.1.1.10.2 tls
70 1.1.1.1.10.2 tls #define ndm_cookies ndm_un1.ndmu3_cookies
71 1.1.1.1.10.2 tls #define ndm4_cookies ndm_un1.ndmu4_cookies
72 1.1.1.1.10.2 tls
73 1.1.1.1.10.2 tls struct nfs_accesscache {
74 1.1.1.1.10.2 tls u_int32_t mode; /* ACCESS mode cache */
75 1.1.1.1.10.2 tls uid_t uid; /* credentials having mode */
76 1.1.1.1.10.2 tls time_t stamp; /* mode cache timestamp */
77 1.1.1.1.10.2 tls };
78 1.1.1.1.10.2 tls
79 1.1.1.1.10.2 tls /*
80 1.1.1.1.10.2 tls * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
81 1.1.1.1.10.2 tls * is purely coincidental.
82 1.1.1.1.10.2 tls * There is a unique nfsnode allocated for each active file,
83 1.1.1.1.10.2 tls * each current directory, each mounted-on file, text file, and the root.
84 1.1.1.1.10.2 tls * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
85 1.1.1.1.10.2 tls * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
86 1.1.1.1.10.2 tls * type definitions), file handles of > 32 bytes should probably be split out
87 1.1.1.1.10.2 tls * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
88 1.1.1.1.10.2 tls * changing the definition in nfsproto.h of NFS_SMALLFH.)
89 1.1.1.1.10.2 tls * NB: Hopefully the current order of the fields is such that everything will
90 1.1.1.1.10.2 tls * be well aligned and, therefore, tightly packed.
91 1.1.1.1.10.2 tls */
92 1.1.1.1.10.2 tls struct nfsnode {
93 1.1.1.1.10.3 jdolecek kmutex_t n_mtx; /* Protects all of these members */
94 1.1.1.1.10.2 tls u_quad_t n_size; /* Current size of file */
95 1.1.1.1.10.2 tls u_quad_t n_brev; /* Modify rev when cached */
96 1.1.1.1.10.2 tls u_quad_t n_lrev; /* Modify rev for lease */
97 1.1.1.1.10.2 tls struct nfsvattr n_vattr; /* Vnode attribute cache */
98 1.1.1.1.10.2 tls time_t n_attrstamp; /* Attr. cache timestamp */
99 1.1.1.1.10.2 tls struct nfs_accesscache n_accesscache[NFS_ACCESSCACHESIZE];
100 1.1.1.1.10.2 tls struct timespec n_mtime; /* Prev modify time. */
101 1.1.1.1.10.2 tls struct nfsfh *n_fhp; /* NFS File Handle */
102 1.1.1.1.10.2 tls struct vnode *n_vnode; /* associated vnode */
103 1.1.1.1.10.2 tls struct vnode *n_dvp; /* parent vnode */
104 1.1.1.1.10.2 tls struct lockf *n_lockf; /* Locking record of file */
105 1.1.1.1.10.2 tls int n_error; /* Save write error value */
106 1.1.1.1.10.2 tls union {
107 1.1.1.1.10.2 tls struct timespec nf_atim; /* Special file times */
108 1.1.1.1.10.2 tls nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
109 1.1.1.1.10.2 tls u_char nd4_cookieverf[NFSX_VERF];
110 1.1.1.1.10.2 tls } n_un1;
111 1.1.1.1.10.2 tls union {
112 1.1.1.1.10.2 tls struct timespec nf_mtim;
113 1.1.1.1.10.2 tls off_t nd_direof; /* Dir. EOF offset cache */
114 1.1.1.1.10.2 tls } n_un2;
115 1.1.1.1.10.2 tls union {
116 1.1.1.1.10.2 tls struct sillyrename *nf_silly; /* Ptr to silly rename struct */
117 1.1.1.1.10.2 tls LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
118 1.1.1.1.10.2 tls } n_un3;
119 1.1.1.1.10.2 tls short n_fhsize; /* size in bytes, of fh */
120 1.1.1.1.10.2 tls u_int32_t n_flag; /* Flag for locking.. */
121 1.1.1.1.10.2 tls int n_directio_opens;
122 1.1.1.1.10.2 tls int n_directio_asyncwr;
123 1.1.1.1.10.2 tls u_int64_t n_change; /* old Change attribute */
124 1.1.1.1.10.2 tls struct nfsv4node *n_v4; /* extra V4 stuff */
125 1.1.1.1.10.2 tls struct ucred *n_writecred; /* Cred. for putpages */
126 1.1.1.1.10.2 tls };
127 1.1.1.1.10.2 tls
128 1.1.1.1.10.2 tls #define n_atim n_un1.nf_atim
129 1.1.1.1.10.2 tls #define n_mtim n_un2.nf_mtim
130 1.1.1.1.10.2 tls #define n_sillyrename n_un3.nf_silly
131 1.1.1.1.10.2 tls #define n_cookieverf n_un1.nd_cookieverf
132 1.1.1.1.10.2 tls #define n4_cookieverf n_un1.nd4_cookieverf
133 1.1.1.1.10.2 tls #define n_direofoffset n_un2.nd_direof
134 1.1.1.1.10.2 tls #define n_cookies n_un3.nd_cook
135 1.1.1.1.10.2 tls
136 1.1.1.1.10.2 tls /*
137 1.1.1.1.10.2 tls * Flags for n_flag
138 1.1.1.1.10.2 tls */
139 1.1.1.1.10.2 tls #define NDIRCOOKIELK 0x00000001 /* Lock to serialize access to directory cookies */
140 1.1.1.1.10.2 tls #define NFSYNCWAIT 0x00000002 /* fsync waiting for all directio async
141 1.1.1.1.10.2 tls writes to drain */
142 1.1.1.1.10.2 tls #define NMODIFIED 0x00000004 /* Might have a modified buffer in bio */
143 1.1.1.1.10.2 tls #define NWRITEERR 0x00000008 /* Flag write errors so close will know */
144 1.1.1.1.10.2 tls #define NCREATED 0x00000010 /* Opened by nfs_create() */
145 1.1.1.1.10.2 tls #define NTRUNCATE 0x00000020 /* Opened by nfs_setattr() */
146 1.1.1.1.10.2 tls #define NSIZECHANGED 0x00000040 /* File size has changed: need cache inval */
147 1.1.1.1.10.2 tls #define NNONCACHE 0x00000080 /* Node marked as noncacheable */
148 1.1.1.1.10.2 tls #define NACC 0x00000100 /* Special file accessed */
149 1.1.1.1.10.2 tls #define NUPD 0x00000200 /* Special file updated */
150 1.1.1.1.10.2 tls #define NCHG 0x00000400 /* Special file times changed */
151 1.1.1.1.10.2 tls #define NDELEGMOD 0x00000800 /* Modified delegation */
152 1.1.1.1.10.2 tls #define NDELEGRECALL 0x00001000 /* Recall in progress */
153 1.1.1.1.10.2 tls #define NREMOVEINPROG 0x00002000 /* Remove in progress */
154 1.1.1.1.10.2 tls #define NREMOVEWANT 0x00004000 /* Want notification that remove is done */
155 1.1.1.1.10.2 tls #define NLOCK 0x00008000 /* Sleep lock the node */
156 1.1.1.1.10.2 tls #define NLOCKWANT 0x00010000 /* Want the sleep lock */
157 1.1.1.1.10.2 tls #define NNOLAYOUT 0x00020000 /* Can't get a layout for this file */
158 1.1.1.1.10.2 tls #define NWRITEOPENED 0x00040000 /* Has been opened for writing */
159 1.1.1.1.10.3 jdolecek #define NHASBEENLOCKED 0x00080000 /* Has been file locked. */
160 1.1.1.1.10.2 tls
161 1.1.1.1.10.2 tls /*
162 1.1.1.1.10.2 tls * Convert between nfsnode pointers and vnode pointers
163 1.1.1.1.10.2 tls */
164 1.1.1.1.10.2 tls #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
165 1.1.1.1.10.2 tls #define NFSTOV(np) ((struct vnode *)(np)->n_vnode)
166 1.1.1.1.10.2 tls
167 1.1.1.1.10.2 tls #define NFS_TIMESPEC_COMPARE(T1, T2) (((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
168 1.1.1.1.10.2 tls
169 1.1.1.1.10.2 tls #if defined(_KERNEL)
170 1.1.1.1.10.2 tls
171 1.1.1.1.10.2 tls /*
172 1.1.1.1.10.2 tls * Prototypes for NFS vnode operations
173 1.1.1.1.10.2 tls */
174 1.1.1.1.10.2 tls int ncl_getpages(struct vop_getpages_args *);
175 1.1.1.1.10.2 tls int ncl_putpages(struct vop_putpages_args *);
176 1.1.1.1.10.2 tls int ncl_write(struct vop_write_args *);
177 1.1.1.1.10.2 tls int ncl_inactive(struct vop_inactive_args *);
178 1.1.1.1.10.2 tls int ncl_reclaim(struct vop_reclaim_args *);
179 1.1.1.1.10.2 tls
180 1.1.1.1.10.2 tls /* other stuff */
181 1.1.1.1.10.2 tls int ncl_removeit(struct sillyrename *, struct vnode *);
182 1.1.1.1.10.2 tls int ncl_nget(struct mount *, u_int8_t *, int, struct nfsnode **, int);
183 1.1.1.1.10.2 tls nfsuint64 *ncl_getcookie(struct nfsnode *, off_t, int);
184 1.1.1.1.10.2 tls void ncl_invaldir(struct vnode *);
185 1.1.1.1.10.2 tls int ncl_upgrade_vnlock(struct vnode *);
186 1.1.1.1.10.2 tls void ncl_downgrade_vnlock(struct vnode *, int);
187 1.1.1.1.10.2 tls void ncl_dircookie_lock(struct nfsnode *);
188 1.1.1.1.10.2 tls void ncl_dircookie_unlock(struct nfsnode *);
189 1.1.1.1.10.2 tls
190 1.1.1.1.10.2 tls #endif /* _KERNEL */
191 1.1.1.1.10.2 tls
192 1.1.1.1.10.2 tls #endif /* _NFSCLIENT_NFSNODE_H_ */
193