xref: /openbsd/sys/nfs/nfsnode.h (revision a43f2b81)
1 /*	$OpenBSD: nfsnode.h,v 1.43 2024/04/30 17:04:23 miod 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/lock.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[24];
57 };
58 
59 /*
60  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
61  * is purely coincidental.
62  * There is a unique nfsnode allocated for each active file,
63  * each current directory, each mounted-on file, text file, and the root.
64  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
65  */
66 struct nfsnode {
67 	RB_ENTRY(nfsnode)	n_entry;	/* filehandle/node tree. */
68 	u_quad_t		n_size;		/* Current size of file */
69 	struct vattr		n_vattr;	/* Vnode attribute cache */
70 	time_t			n_attrstamp;	/* Attr. cache timestamp */
71 	struct timespec 	n_mtime;	/* Prev modify time. */
72 	time_t			n_ctime;	/* Prev create time. */
73 	nfsfh_t			*n_fhp;		/* NFS File Handle */
74 	struct vnode		*n_vnode;	/* associated vnode */
75 	struct lockf_state	*n_lockf;	/* Locking record of file */
76 	struct rrwlock		n_lock;		/* NFSnode lock */
77 	int			n_error;	/* Save write error value */
78 	union {
79 		struct timespec	nf_atim;	/* Special file times */
80 		nfsuint64	nd_cookieverf;	/* Cookie verifier (dir only) */
81 	} n_un1;
82 	union {
83 		struct timespec	nf_mtim;
84 		off_t		nd_direof;	/* Dir. EOF offset cache */
85 	} n_un2;
86 	struct sillyrename	*n_sillyrename;	/* Ptr to silly rename struct */
87 	short			n_fhsize;	/* size in bytes, of fh */
88 	short			n_flag;		/* Flag for locking.. */
89 	nfsfh_t			n_fh;		/* Small File Handle */
90 	time_t			n_accstamp;	/* Access cache timestamp */
91 	uid_t			n_accuid;	/* Last access requester */
92 	int			n_accmode;	/* Last mode requested */
93 	int			n_accerror;	/* Last returned error */
94 	struct ucred		*n_rcred;
95 	struct ucred		*n_wcred;
96 
97 	off_t			n_pushedlo;	/* 1st blk in committed range */
98 	off_t			n_pushedhi;	/* Last block in range */
99 	off_t			n_pushlo;	/* 1st block in commit range */
100 	off_t			n_pushhi;	/* Last block in range */
101 	struct rwlock		n_commitlock;	/* Serialize commits */
102 	int			n_commitflags;
103 };
104 
105 /*
106  * Values for n_commitflags
107  */
108 #define NFS_COMMIT_PUSH_VALID   0x0001          /* push range valid */
109 #define NFS_COMMIT_PUSHED_VALID 0x0002          /* pushed range valid */
110 
111 #define n_atim		n_un1.nf_atim
112 #define n_mtim		n_un2.nf_mtim
113 #define n_cookieverf	n_un1.nd_cookieverf
114 #define n_direofoffset	n_un2.nd_direof
115 
116 /*
117  * Flags for n_flag
118  */
119 #define	NFLUSHWANT	0x0001	/* Want wakeup from a flush in prog. */
120 #define	NFLUSHINPROG	0x0002	/* Avoid multiple calls to vinvalbuf() */
121 #define	NMODIFIED	0x0004	/* Might have a modified buffer in bio */
122 #define	NWRITEERR	0x0008	/* Flag write errors so close will know */
123 #define	NACC		0x0100	/* Special file accessed */
124 #define	NUPD		0x0200	/* Special file updated */
125 #define	NCHG		0x0400	/* Special file times changed */
126 
127 #define NFS_INVALIDATE_ATTRCACHE(np)	((np)->n_attrstamp = 0)
128 
129 /*
130  * Convert between nfsnode pointers and vnode pointers
131  */
132 #define VTONFS(vp)	((struct nfsnode *)(vp)->v_data)
133 #define NFSTOV(np)	((np)->n_vnode)
134 
135 /*
136  * Queue head for nfsiod's
137  */
138 extern TAILQ_HEAD(nfs_bufqhead, buf) nfs_bufq;
139 extern uint32_t nfs_bufqlen, nfs_bufqmax;
140 
141 #endif		/* _NFS_NFSNODE_H_ */
142