nfsnode.h revision 330897 
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 * 4. 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 *	@(#)nfsnode.h	8.9 (Berkeley) 5/14/95
35 * $FreeBSD: stable/11/sys/nfsclient/nfsnode.h 330897 2018-03-14 03:19:51Z eadler $
36 */
37
38#ifndef _NFSCLIENT_NFSNODE_H_
39#define _NFSCLIENT_NFSNODE_H_
40
41#include <sys/_task.h>
42#if !defined(_NFSCLIENT_NFS_H_) && !defined(_KERNEL)
43#include <nfs/nfs.h>
44#endif
45
46/*
47 * Silly rename structure that hangs off the nfsnode until the name
48 * can be removed by nfs_inactive()
49 */
50struct sillyrename {
51	struct	task s_task;
52	struct	ucred *s_cred;
53	struct	vnode *s_dvp;
54	int	(*s_removeit)(struct sillyrename *sp);
55	long	s_namlen;
56	char	s_name[32];
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
69struct nfsdmap {
70	LIST_ENTRY(nfsdmap)	ndm_list;
71	int			ndm_eocookie;
72	union {
73		nfsuint64	ndmu3_cookies[NFSNUMCOOKIES];
74		uint64_t	ndmu4_cookies[NFSNUMCOOKIES];
75	} ndm_un1;
76};
77
78#define ndm_cookies	ndm_un1.ndmu3_cookies
79#define ndm4_cookies	ndm_un1.ndmu4_cookies
80
81struct nfs_accesscache {
82	u_int32_t		mode;		/* ACCESS mode cache */
83	uid_t			uid;		/* credentials having mode */
84	time_t			stamp;		/* mode cache timestamp */
85};
86
87/*
88 * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
89 * is purely coincidental.
90 * There is a unique nfsnode allocated for each active file,
91 * each current directory, each mounted-on file, text file, and the root.
92 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
93 * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
94 * type definitions), file handles of > 32 bytes should probably be split out
95 * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
96 * changing the definition in nfsproto.h of NFS_SMALLFH.)
97 * NB: Hopefully the current order of the fields is such that everything will
98 *     be well aligned and, therefore, tightly packed.
99 */
100struct nfsnode {
101	struct mtx 		n_mtx;		/* Protects all of these members */
102	u_quad_t		n_size;		/* Current size of file */
103	u_quad_t		n_brev;		/* Modify rev when cached */
104	u_quad_t		n_lrev;		/* Modify rev for lease */
105	struct vattr		n_vattr;	/* Vnode attribute cache */
106	time_t			n_attrstamp;	/* Attr. cache timestamp */
107	struct nfs_accesscache	n_accesscache[NFS_ACCESSCACHESIZE];
108	struct timespec		n_mtime;	/* Prev modify time. */
109	nfsfh_t			*n_fhp;		/* NFS File Handle */
110	struct vnode		*n_vnode;	/* associated vnode */
111	struct vnode		*n_dvp;		/* parent vnode */
112	int			n_error;	/* Save write error value */
113	union {
114		struct timespec	nf_atim;	/* Special file times */
115		nfsuint64	nd_cookieverf;	/* Cookie verifier (dir only) */
116		u_char		nd4_cookieverf[NFSX_V4VERF];
117	} n_un1;
118	union {
119		struct timespec	nf_mtim;
120		off_t		nd_direof;	/* Dir. EOF offset cache */
121	} n_un2;
122	union {
123		struct sillyrename *nf_silly;	/* Ptr to silly rename struct */
124		LIST_HEAD(, nfsdmap) nd_cook;	/* cookies */
125	} n_un3;
126	short			n_fhsize;	/* size in bytes, of fh */
127	short			n_flag;		/* Flag for locking.. */
128	nfsfh_t			n_fh;		/* Small File Handle */
129	u_char			*n_name;	/* leaf name, for v4 OPEN op */
130	uint32_t		n_namelen;
131	int			n_directio_opens;
132	int                     n_directio_asyncwr;
133	struct ucred		*n_writecred;	/* Cred. for putpages */
134};
135
136#define n_atim		n_un1.nf_atim
137#define n_mtim		n_un2.nf_mtim
138#define n_sillyrename	n_un3.nf_silly
139#define n_cookieverf	n_un1.nd_cookieverf
140#define n4_cookieverf	n_un1.nd4_cookieverf
141#define n_direofoffset	n_un2.nd_direof
142#define n_cookies	n_un3.nd_cook
143
144/*
145 * Flags for n_flag
146 */
147#define NFSYNCWAIT      0x0002  /* fsync waiting for all directio async writes
148				  to drain */
149#define	NMODIFIED	0x0004	/* Might have a modified buffer in bio */
150#define	NWRITEERR	0x0008	/* Flag write errors so close will know */
151/* 0x20, 0x40, 0x80 free */
152#define	NACC		0x0100	/* Special file accessed */
153#define	NUPD		0x0200	/* Special file updated */
154#define	NCHG		0x0400	/* Special file times changed */
155#define	NCREATED	0x0800	/* Opened by nfs_create() */
156#define	NTRUNCATE	0x1000	/* Opened by nfs_setattr() */
157#define	NSIZECHANGED	0x2000  /* File size has changed: need cache inval */
158#define NNONCACHE	0x4000  /* Node marked as noncacheable */
159#define NDIRCOOKIELK	0x8000	/* Lock to serialize access to directory cookies */
160
161/*
162 * Convert between nfsnode pointers and vnode pointers
163 */
164#define VTONFS(vp)	((struct nfsnode *)(vp)->v_data)
165#define NFSTOV(np)	((struct vnode *)(np)->n_vnode)
166
167#define NFS_TIMESPEC_COMPARE(T1, T2)	(((T1)->tv_sec != (T2)->tv_sec) || ((T1)->tv_nsec != (T2)->tv_nsec))
168
169/*
170 * NFS iod threads can be in one of these two states once spawned.
171 * NFSIOD_NOT_AVAILABLE - Cannot be assigned an I/O operation at this time.
172 * NFSIOD_AVAILABLE - Available to be assigned an I/O operation.
173 */
174enum nfsiod_state {
175	NFSIOD_NOT_AVAILABLE = 0,
176	NFSIOD_AVAILABLE = 1,
177};
178
179/*
180 * Queue head for nfsiod's
181 */
182extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
183extern enum nfsiod_state nfs_iodwant[NFS_MAXASYNCDAEMON];
184extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
185
186#if defined(_KERNEL)
187
188extern	struct vop_vector	nfs_fifoops;
189extern	struct vop_vector	nfs_vnodeops;
190extern struct buf_ops buf_ops_nfs;
191
192/*
193 * Prototypes for NFS vnode operations
194 */
195int	nfs_getpages(struct vop_getpages_args *);
196int	nfs_putpages(struct vop_putpages_args *);
197int	nfs_write(struct vop_write_args *);
198int	nfs_inactive(struct vop_inactive_args *);
199int	nfs_reclaim(struct vop_reclaim_args *);
200
201/* other stuff */
202int	nfs_removeit(struct sillyrename *);
203int	nfs_nget(struct mount *, nfsfh_t *, int, struct nfsnode **, int flags);
204nfsuint64 *nfs_getcookie(struct nfsnode *, off_t, int);
205void	nfs_invaldir(struct vnode *);
206int	nfs_upgrade_vnlock(struct vnode *vp);
207void	nfs_downgrade_vnlock(struct vnode *vp, int old_lock);
208void	nfs_printf(const char *fmt, ...);
209
210void nfs_dircookie_lock(struct nfsnode *np);
211void nfs_dircookie_unlock(struct nfsnode *np);
212
213#endif /* _KERNEL */
214
215#endif
216