1 /* $OpenBSD: nfsnode.h,v 1.26 2007/06/21 22:59:49 thib Exp $ */
2 /* $NetBSD: nfsnode.h,v 1.16 1996/02/18 11:54:04 fvdl Exp $ */
3
4 /*
5 * Copyright (c) 1989, 1993
6 * The Regents of the University of California. All rights reserved.
7 *
8 * This code is derived from software contributed to Berkeley by
9 * Rick Macklem at The University of Guelph.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 * @(#)nfsnode.h 8.9 (Berkeley) 5/14/95
36 */
37
38
39 #ifndef _NFS_NFSNODE_H_
40 #define _NFS_NFSNODE_H_
41
42 #ifndef _NFS_NFS_H_
43 #include <nfs/nfs.h>
44 #endif
45
46 #include <sys/rwlock.h>
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 sys/mount.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 LIST_ENTRY(nfsnode) n_hash; /* Hash chain */
90 u_quad_t n_size; /* Current size of file */
91 u_quad_t n_brev; /* Modify rev when cached */
92 u_quad_t n_lrev; /* Modify rev for lease */
93 struct vattr n_vattr; /* Vnode attribute cache */
94 time_t n_attrstamp; /* Attr. cache timestamp */
95 time_t n_mtime; /* Prev modify time. */
96 time_t n_ctime; /* Prev create time. */
97 time_t n_expiry; /* Lease expiry time */
98 nfsfh_t *n_fhp; /* NFS File Handle */
99 struct vnode *n_vnode; /* associated vnode */
100 struct lockf *n_lockf; /* Locking record of file */
101 int n_error; /* Save write error value */
102 union {
103 struct timespec nf_atim; /* Special file times */
104 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
105 } n_un1;
106 union {
107 struct timespec nf_mtim;
108 off_t nd_direof; /* Dir. EOF offset cache */
109 } n_un2;
110 union {
111 struct sillyrename *nf_silly; /* Ptr to silly rename struct */
112 LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
113 } n_un3;
114 short n_fhsize; /* size in bytes, of fh */
115 short n_flag; /* Flag for locking.. */
116 nfsfh_t n_fh; /* Small File Handle */
117 struct ucred *n_rcred;
118 struct ucred *n_wcred;
119
120 off_t n_pushedlo; /* 1st blk in commited range */
121 off_t n_pushedhi; /* Last block in range */
122 off_t n_pushlo; /* 1st block in commit range */
123 off_t n_pushhi; /* Last block in range */
124 struct rwlock n_commitlock; /* Serialize commits */
125 int n_commitflags;
126 };
127
128 /*
129 * Values for n_commitflags
130 */
131 #define NFS_COMMIT_PUSH_VALID 0x0001 /* push range valid */
132 #define NFS_COMMIT_PUSHED_VALID 0x0002 /* pushed range valid */
133
134 #define n_atim n_un1.nf_atim
135 #define n_mtim n_un2.nf_mtim
136 #define n_sillyrename n_un3.nf_silly
137 #define n_cookieverf n_un1.nd_cookieverf
138 #define n_direofoffset n_un2.nd_direof
139 #define n_cookies n_un3.nd_cook
140
141 /*
142 * Flags for n_flag
143 */
144 #define NFLUSHWANT 0x0001 /* Want wakeup from a flush in prog. */
145 #define NFLUSHINPROG 0x0002 /* Avoid multiple calls to vinvalbuf() */
146 #define NMODIFIED 0x0004 /* Might have a modified buffer in bio */
147 #define NWRITEERR 0x0008 /* Flag write errors so close will know */
148 #define NACC 0x0100 /* Special file accessed */
149 #define NUPD 0x0200 /* Special file updated */
150 #define NCHG 0x0400 /* Special file times changed */
151
152 /*
153 * Convert between nfsnode pointers and vnode pointers
154 */
155 #define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
156 #define NFSTOV(np) ((np)->n_vnode)
157
158 /*
159 * Queue head for nfsiod's
160 */
161 extern TAILQ_HEAD(nfs_bufqhead, buf) nfs_bufq;
162
163 #endif /* _NFS_NFSNODE_H_ */