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