xref: /freebsd/sys/nfsclient/nfsnode.h (revision 29363fb446372cb3f10bc98664e9767c53fbb457)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Rick Macklem at The University of Guelph.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 
35 #ifndef _NFSCLIENT_NFSNODE_H_
36 #define _NFSCLIENT_NFSNODE_H_
37 
38 #include <sys/_task.h>
39 #if !defined(_NFSCLIENT_NFS_H_) && !defined(_KERNEL)
40 #include <nfs/nfs.h>
41 #endif
42 
43 /*
44  * Silly rename structure that hangs off the nfsnode until the name
45  * can be removed by nfs_inactive()
46  */
47 struct sillyrename {
48 	struct	task s_task;
49 	struct	ucred *s_cred;
50 	struct	vnode *s_dvp;
51 	int	(*s_removeit)(struct sillyrename *sp);
52 	long	s_namlen;
53 	char	s_name[32];
54 };
55 
56 /*
57  * This structure is used to save the logical directory offset to
58  * NFS cookie mappings.
59  * The mappings are stored in a list headed
60  * by n_cookies, as required.
61  * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
62  * stored in increasing logical offset byte order.
63  */
64 #define NFSNUMCOOKIES		31
65 
66 struct nfsdmap {
67 	LIST_ENTRY(nfsdmap)	ndm_list;
68 	int			ndm_eocookie;
69 	union {
70 		nfsuint64	ndmu3_cookies[NFSNUMCOOKIES];
71 		uint64_t	ndmu4_cookies[NFSNUMCOOKIES];
72 	} ndm_un1;
73 };
74 
75 #define ndm_cookies	ndm_un1.ndmu3_cookies
76 #define ndm4_cookies	ndm_un1.ndmu4_cookies
77 
78 struct nfs_accesscache {
79 	u_int32_t		mode;		/* ACCESS mode cache */
80 	uid_t			uid;		/* credentials having mode */
81 	time_t			stamp;		/* mode cache timestamp */
82 };
83 
84 /*
85  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
86  * is purely coincidental.
87  * There is a unique nfsnode allocated for each active file,
88  * each current directory, each mounted-on file, text file, and the root.
89  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
90  * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
91  * type definitions), file handles of > 32 bytes should probably be split out
92  * into a separate malloc()'d data structure. (Reduce the size of nfsfh_t by
93  * changing the definition in nfsproto.h of NFS_SMALLFH.)
94  * NB: Hopefully the current order of the fields is such that everything will
95  *     be well aligned and, therefore, tightly packed.
96  */
97 struct nfsnode {
98 	struct mtx 		n_mtx;		/* Protects all of these members */
99 	u_quad_t		n_size;		/* Current size of file */
100 	u_quad_t		n_brev;		/* Modify rev when cached */
101 	u_quad_t		n_lrev;		/* Modify rev for lease */
102 	struct vattr		n_vattr;	/* Vnode attribute cache */
103 	time_t			n_attrstamp;	/* Attr. cache timestamp */
104 	struct nfs_accesscache	n_accesscache[NFS_ACCESSCACHESIZE];
105 	struct timespec		n_mtime;	/* Prev modify time. */
106 	nfsfh_t			*n_fhp;		/* NFS File Handle */
107 	struct vnode		*n_vnode;	/* associated vnode */
108 	struct vnode		*n_dvp;		/* parent vnode */
109 	int			n_error;	/* Save write error value */
110 	union {
111 		struct timespec	nf_atim;	/* Special file times */
112 		nfsuint64	nd_cookieverf;	/* Cookie verifier (dir only) */
113 		u_char		nd4_cookieverf[NFSX_V4VERF];
114 	} n_un1;
115 	union {
116 		struct timespec	nf_mtim;
117 		off_t		nd_direof;	/* Dir. EOF offset cache */
118 	} n_un2;
119 	union {
120 		struct sillyrename *nf_silly;	/* Ptr to silly rename struct */
121 		LIST_HEAD(, nfsdmap) nd_cook;	/* cookies */
122 	} n_un3;
123 	short			n_fhsize;	/* size in bytes, of fh */
124 	short			n_flag;		/* Flag for locking.. */
125 	nfsfh_t			n_fh;		/* Small File Handle */
126 	u_char			*n_name;	/* leaf name, for v4 OPEN op */
127 	uint32_t		n_namelen;
128 	int			n_directio_opens;
129 	int                     n_directio_asyncwr;
130 	struct ucred		*n_writecred;	/* Cred. for putpages */
131 };
132 
133 #define n_atim		n_un1.nf_atim
134 #define n_mtim		n_un2.nf_mtim
135 #define n_sillyrename	n_un3.nf_silly
136 #define n_cookieverf	n_un1.nd_cookieverf
137 #define n4_cookieverf	n_un1.nd4_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 NFSYNCWAIT      0x0002  /* fsync waiting for all directio async writes
145 				  to drain */
146 #define	NMODIFIED	0x0004	/* Might have a modified buffer in bio */
147 #define	NWRITEERR	0x0008	/* Flag write errors so close will know */
148 /* 0x20, 0x40, 0x80 free */
149 #define	NACC		0x0100	/* Special file accessed */
150 #define	NUPD		0x0200	/* Special file updated */
151 #define	NCHG		0x0400	/* Special file times changed */
152 #define	NCREATED	0x0800	/* Opened by nfs_create() */
153 #define	NTRUNCATE	0x1000	/* Opened by nfs_setattr() */
154 #define	NSIZECHANGED	0x2000  /* File size has changed: need cache inval */
155 #define NNONCACHE	0x4000  /* Node marked as noncacheable */
156 #define NDIRCOOKIELK	0x8000	/* Lock to serialize access to directory cookies */
157 
158 /*
159  * Convert between nfsnode pointers and vnode pointers
160  */
161 #define VTONFS(vp)	((struct nfsnode *)(vp)->v_data)
162 #define NFSTOV(np)	((struct vnode *)(np)->n_vnode)
163 
164 #define NFS_TIMESPEC_COMPARE(T1, T2)	(((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
165 
166 /*
167  * NFS iod threads can be in one of these two states once spawned.
168  * NFSIOD_NOT_AVAILABLE - Cannot be assigned an I/O operation at this time.
169  * NFSIOD_AVAILABLE - Available to be assigned an I/O operation.
170  */
171 enum nfsiod_state {
172 	NFSIOD_NOT_AVAILABLE = 0,
173 	NFSIOD_AVAILABLE = 1,
174 };
175 
176 /*
177  * Queue head for nfsiod's
178  */
179 extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
180 extern enum nfsiod_state nfs_iodwant[NFS_MAXASYNCDAEMON];
181 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
182 
183 #if defined(_KERNEL)
184 
185 extern	struct vop_vector	nfs_fifoops;
186 extern	struct vop_vector	nfs_vnodeops;
187 extern struct buf_ops buf_ops_nfs;
188 
189 /*
190  * Prototypes for NFS vnode operations
191  */
192 int	nfs_getpages(struct vop_getpages_args *);
193 int	nfs_putpages(struct vop_putpages_args *);
194 int	nfs_write(struct vop_write_args *);
195 int	nfs_inactive(struct vop_inactive_args *);
196 int	nfs_reclaim(struct vop_reclaim_args *);
197 
198 /* other stuff */
199 int	nfs_removeit(struct sillyrename *);
200 int	nfs_nget(struct mount *, nfsfh_t *, int, struct nfsnode **, int flags);
201 nfsuint64 *nfs_getcookie(struct nfsnode *, off_t, int);
202 void	nfs_invaldir(struct vnode *);
203 int	nfs_upgrade_vnlock(struct vnode *vp);
204 void	nfs_downgrade_vnlock(struct vnode *vp, int old_lock);
205 void	nfs_printf(const char *fmt, ...);
206 
207 void nfs_dircookie_lock(struct nfsnode *np);
208 void nfs_dircookie_unlock(struct nfsnode *np);
209 
210 #endif /* _KERNEL */
211 
212 #endif
213