FreeBSD/Linux Kernel Cross Reference
sys/nfs/nfsnode.h
1 /*
2 * Copyright (c) 1989, 1993
3 * The Regents of the University of California. All rights reserved.
4 *
5 * This code is derived from software contributed to Berkeley by
6 * Rick Macklem at The University of Guelph.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by the University of
19 * California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 * @(#)nfsnode.h 8.9 (Berkeley) 5/14/95
37 * $FreeBSD$
38 */
39
40
41 #ifndef _NFS_NFSNODE_H_
42 #define _NFS_NFSNODE_H_
43
44 #if !defined(_NFS_NFS_H_) && !defined(_KERNEL)
45 #include <nfs/nfs.h>
46 #endif
47
48 /*
49 * Silly rename structure that hangs off the nfsnode until the name
50 * can be removed by nfs_inactive()
51 */
52 struct sillyrename {
53 struct ucred *s_cred;
54 struct vnode *s_dvp;
55 long s_namlen;
56 char s_name[20];
57 };
58
59 /*
60 * This structure is used to save the logical directory offset to
61 * NFS cookie mappings.
62 * The mappings are stored in a list headed
63 * by n_cookies, as required.
64 * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
65 * stored in increasing logical offset byte order.
66 */
67 #define NFSNUMCOOKIES 31
68
69 struct nfsdmap {
70 LIST_ENTRY(nfsdmap) ndm_list;
71 int ndm_eocookie;
72 nfsuint64 ndm_cookies[NFSNUMCOOKIES];
73 };
74
75 /*
76 * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
77 * is purely coincidental.
78 * There is a unique nfsnode allocated for each active file,
79 * each current directory, each mounted-on file, text file, and the root.
80 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
81 * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
82 * type definitions), file handles of > 32 bytes should probably be split out
83 * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
84 * changing the definition in nfsproto.h of NFS_SMALLFH.)
85 * NB: Hopefully the current order of the fields is such that everything will
86 * be well aligned and, therefore, tightly packed.
87 */
88 struct nfsnode {
89 struct lock n_lock;
90 LIST_ENTRY(nfsnode) n_hash; /* Hash chain */
91 CIRCLEQ_ENTRY(nfsnode) n_timer; /* Nqnfs timer chain */
92 u_quad_t n_size; /* Current size of file */
93 u_quad_t n_brev; /* Modify rev when cached */
94 u_quad_t n_lrev; /* Modify rev for lease */
95 struct vattr n_vattr; /* Vnode attribute cache */
96 time_t n_attrstamp; /* Attr. cache timestamp */
97 u_int32_t n_mode; /* ACCESS mode cache */
98 uid_t n_modeuid; /* credentials having mode */
99 time_t n_modestamp; /* mode cache timestamp */
100 time_t n_mtime; /* Prev modify time. */
101 time_t n_ctime; /* Prev create time. */
102 time_t n_expiry; /* Lease expiry time */
103 nfsfh_t *n_fhp; /* NFS File Handle */
104 struct vnode *n_vnode; /* associated vnode */
105 struct lockf *n_lockf; /* Locking record of file */
106 int n_error; /* Save write error value */
107 union {
108 struct timespec nf_atim; /* Special file times */
109 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
110 } n_un1;
111 union {
112 struct timespec nf_mtim;
113 off_t nd_direof; /* Dir. EOF offset cache */
114 } n_un2;
115 union {
116 struct sillyrename *nf_silly; /* Ptr to silly rename struct */
117 LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
118 } n_un3;
119 short n_fhsize; /* size in bytes, of fh */
120 short n_flag; /* Flag for locking.. */
121 nfsfh_t n_fh; /* Small File Handle */
122 struct lock n_rslock;
123 };
124
125 #define n_atim n_un1.nf_atim
126 #define n_mtim n_un2.nf_mtim
127 #define n_sillyrename n_un3.nf_silly
128 #define n_cookieverf n_un1.nd_cookieverf
129 #define n_direofoffset n_un2.nd_direof
130 #define n_cookies n_un3.nd_cook
131
132 /*
133 * Flags for n_flag
134 */
135 #define NFLUSHWANT 0x0001 /* Want wakeup from a flush in prog. */
136 #define NFLUSHINPROG 0x0002 /* Avoid multiple calls to vinvalbuf() */
137 #define NMODIFIED 0x0004 /* Might have a modified buffer in bio */
138 #define NWRITEERR 0x0008 /* Flag write errors so close will know */
139 #define NQNFSNONCACHE 0x0020 /* Non-cachable lease */
140 #define NQNFSWRITE 0x0040 /* Write lease */
141 #define NQNFSEVICTED 0x0080 /* Has been evicted */
142 #define NACC 0x0100 /* Special file accessed */
143 #define NUPD 0x0200 /* Special file updated */
144 #define NCHG 0x0400 /* Special file times changed */
145 #define NLOCKED 0x0800 /* node is locked */
146 #define NWANTED 0x0100 /* someone wants to lock */
147 #define NSIZECHANGED 0x2000 /* File size has changed: need cache inval */
148
149 /*
150 * Convert between nfsnode pointers and vnode pointers
151 */
152 #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
153 #define NFSTOV(np) ((struct vnode *)(np)->n_vnode)
154
155 /*
156 * Queue head for nfsiod's
157 */
158 extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
159 extern struct proc *nfs_iodwant[NFS_MAXASYNCDAEMON];
160 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
161
162 #if defined(_KERNEL)
163
164 /*
165 * nfs_rslock - Attempt to obtain lock on nfsnode
166 *
167 * Attempt to obtain a lock on the passed nfsnode, returning ENOLCK
168 * if the lock could not be obtained due to our having to sleep. This
169 * function is generally used to lock around code that modifies an
170 * NFS file's size. In order to avoid deadlocks the lock
171 * should not be obtained while other locks are being held.
172 */
173
174 static __inline
175 int
176 nfs_rslock(struct nfsnode *np, struct proc *p)
177 {
178 return(lockmgr(&np->n_rslock, LK_EXCLUSIVE | LK_CANRECURSE | LK_SLEEPFAIL, NULL, p));
179 }
180
181 static __inline
182 void
183 nfs_rsunlock(struct nfsnode *np, struct proc *p)
184 {
185 (void)lockmgr(&np->n_rslock, LK_RELEASE, NULL, p);
186 }
187
188 extern vop_t **fifo_nfsv2nodeop_p;
189 extern vop_t **nfsv2_vnodeop_p;
190 extern vop_t **spec_nfsv2nodeop_p;
191
192 /*
193 * Prototypes for NFS vnode operations
194 */
195 int nfs_getpages __P((struct vop_getpages_args *));
196 int nfs_putpages __P((struct vop_putpages_args *));
197 int nfs_write __P((struct vop_write_args *));
198 int nqnfs_vop_lease_check __P((struct vop_lease_args *));
199 int nfs_inactive __P((struct vop_inactive_args *));
200 int nfs_reclaim __P((struct vop_reclaim_args *));
201
202 /* other stuff */
203 int nfs_removeit __P((struct sillyrename *));
204 int nfs_nget __P((struct mount *,nfsfh_t *,int,struct nfsnode **));
205 nfsuint64 *nfs_getcookie __P((struct nfsnode *, off_t, int));
206 void nfs_invaldir __P((struct vnode *));
207
208 #define nqnfs_lease_updatetime nfs_lease_updatetime
209
210 #endif /* _KERNEL */
211
212 #endif
Cache object: def7e0024807f0aa0c0a542aeabe0c94
|