xref: /original-bsd/sys/nfs/nfsnode.h (revision 0ac4996f)
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  * %sccs.include.redist.c%
9  *
10  *	@(#)nfsnode.h	8.9 (Berkeley) 05/14/95
11  */
12 
13 
14 #ifndef _NFS_NFSNODE_H_
15 #define _NFS_NFSNODE_H_
16 
17 #ifndef _NFS_NFS_H_
18 #include <nfs/nfs.h>
19 #endif
20 
21 /*
22  * Silly rename structure that hangs off the nfsnode until the name
23  * can be removed by nfs_inactive()
24  */
25 struct sillyrename {
26 	struct	ucred *s_cred;
27 	struct	vnode *s_dvp;
28 	long	s_namlen;
29 	char	s_name[20];
30 };
31 
32 /*
33  * This structure is used to save the logical directory offset to
34  * NFS cookie mappings.
35  * The mappings are stored in a list headed
36  * by n_cookies, as required.
37  * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
38  * stored in increasing logical offset byte order.
39  */
40 #define NFSNUMCOOKIES		31
41 
42 struct nfsdmap {
43 	LIST_ENTRY(nfsdmap)	ndm_list;
44 	int			ndm_eocookie;
45 	nfsuint64		ndm_cookies[NFSNUMCOOKIES];
46 };
47 
48 /*
49  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
50  * is purely coincidental.
51  * There is a unique nfsnode allocated for each active file,
52  * each current directory, each mounted-on file, text file, and the root.
53  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
54  * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
55  * type definitions), file handles of > 32 bytes should probably be split out
56  * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
57  * changing the definition in sys/mount.h of NFS_SMALLFH.)
58  * NB: Hopefully the current order of the fields is such that everything will
59  *     be well aligned and, therefore, tightly packed.
60  */
61 struct nfsnode {
62 	LIST_ENTRY(nfsnode)	n_hash;		/* Hash chain */
63 	CIRCLEQ_ENTRY(nfsnode)	n_timer;	/* Nqnfs timer chain */
64 	u_quad_t		n_size;		/* Current size of file */
65 	u_quad_t		n_brev;		/* Modify rev when cached */
66 	u_quad_t		n_lrev;		/* Modify rev for lease */
67 	struct vattr		n_vattr;	/* Vnode attribute cache */
68 	time_t			n_attrstamp;	/* Attr. cache timestamp */
69 	time_t			n_mtime;	/* Prev modify time. */
70 	time_t			n_ctime;	/* Prev create time. */
71 	time_t			n_expiry;	/* Lease expiry time */
72 	nfsfh_t			*n_fhp;		/* NFS File Handle */
73 	struct vnode		*n_vnode;	/* associated vnode */
74 	struct lockf		*n_lockf;	/* Locking record of file */
75 	int			n_error;	/* Save write error value */
76 	union {
77 		struct timespec	nf_atim;	/* Special file times */
78 		nfsuint64	nd_cookieverf;	/* Cookie verifier (dir only) */
79 	} n_un1;
80 	union {
81 		struct timespec	nf_mtim;
82 		off_t		nd_direof;	/* Dir. EOF offset cache */
83 	} n_un2;
84 	union {
85 		struct sillyrename *nf_silly;	/* Ptr to silly rename struct */
86 		LIST_HEAD(, nfsdmap) nd_cook;	/* cookies */
87 	} n_un3;
88 	short			n_fhsize;	/* size in bytes, of fh */
89 	short			n_flag;		/* Flag for locking.. */
90 	nfsfh_t			n_fh;		/* Small File Handle */
91 };
92 
93 #define n_atim		n_un1.nf_atim
94 #define n_mtim		n_un2.nf_mtim
95 #define n_sillyrename	n_un3.nf_silly
96 #define n_cookieverf	n_un1.nd_cookieverf
97 #define n_direofoffset	n_un2.nd_direof
98 #define n_cookies	n_un3.nd_cook
99 
100 /*
101  * Flags for n_flag
102  */
103 #define	NFLUSHWANT	0x0001	/* Want wakeup from a flush in prog. */
104 #define	NFLUSHINPROG	0x0002	/* Avoid multiple calls to vinvalbuf() */
105 #define	NMODIFIED	0x0004	/* Might have a modified buffer in bio */
106 #define	NWRITEERR	0x0008	/* Flag write errors so close will know */
107 #define	NQNFSNONCACHE	0x0020	/* Non-cachable lease */
108 #define	NQNFSWRITE	0x0040	/* Write lease */
109 #define	NQNFSEVICTED	0x0080	/* Has been evicted */
110 #define	NACC		0x0100	/* Special file accessed */
111 #define	NUPD		0x0200	/* Special file updated */
112 #define	NCHG		0x0400	/* Special file times changed */
113 
114 /*
115  * Convert between nfsnode pointers and vnode pointers
116  */
117 #define VTONFS(vp)	((struct nfsnode *)(vp)->v_data)
118 #define NFSTOV(np)	((struct vnode *)(np)->n_vnode)
119 
120 /*
121  * Queue head for nfsiod's
122  */
123 TAILQ_HEAD(, buf) nfs_bufq;
124 
125 #ifdef KERNEL
126 /*
127  * Prototypes for NFS vnode operations
128  */
129 int	nfs_lookup __P((struct vop_lookup_args *));
130 int	nfs_create __P((struct vop_create_args *));
131 int	nfs_mknod __P((struct vop_mknod_args *));
132 int	nfs_open __P((struct vop_open_args *));
133 int	nfs_close __P((struct vop_close_args *));
134 int	nfsspec_close __P((struct vop_close_args *));
135 int	nfsfifo_close __P((struct vop_close_args *));
136 int	nfs_access __P((struct vop_access_args *));
137 int	nfsspec_access __P((struct vop_access_args *));
138 int	nfs_getattr __P((struct vop_getattr_args *));
139 int	nfs_setattr __P((struct vop_setattr_args *));
140 int	nfs_read __P((struct vop_read_args *));
141 int	nfs_write __P((struct vop_write_args *));
142 #define	nfs_lease_check ((int (*) __P((struct  vop_lease_args *)))nullop)
143 #define nqnfs_vop_lease_check	lease_check
144 int	nfsspec_read __P((struct vop_read_args *));
145 int	nfsspec_write __P((struct vop_write_args *));
146 int	nfsfifo_read __P((struct vop_read_args *));
147 int	nfsfifo_write __P((struct vop_write_args *));
148 #define nfs_ioctl ((int (*) __P((struct  vop_ioctl_args *)))enoioctl)
149 #define nfs_select ((int (*) __P((struct  vop_select_args *)))seltrue)
150 #define nfs_revoke vop_revoke
151 int	nfs_mmap __P((struct vop_mmap_args *));
152 int	nfs_fsync __P((struct vop_fsync_args *));
153 #define nfs_seek ((int (*) __P((struct  vop_seek_args *)))nullop)
154 int	nfs_remove __P((struct vop_remove_args *));
155 int	nfs_link __P((struct vop_link_args *));
156 int	nfs_rename __P((struct vop_rename_args *));
157 int	nfs_mkdir __P((struct vop_mkdir_args *));
158 int	nfs_rmdir __P((struct vop_rmdir_args *));
159 int	nfs_symlink __P((struct vop_symlink_args *));
160 int	nfs_readdir __P((struct vop_readdir_args *));
161 int	nfs_readlink __P((struct vop_readlink_args *));
162 int	nfs_abortop __P((struct vop_abortop_args *));
163 int	nfs_inactive __P((struct vop_inactive_args *));
164 int	nfs_reclaim __P((struct vop_reclaim_args *));
165 #define nfs_lock ((int (*) __P((struct vop_lock_args *)))vop_nolock)
166 #define nfs_unlock ((int (*) __P((struct vop_unlock_args *)))vop_nounlock)
167 #define nfs_islocked ((int (*) __P((struct vop_islocked_args *)))vop_noislocked)
168 int	nfs_bmap __P((struct vop_bmap_args *));
169 int	nfs_strategy __P((struct vop_strategy_args *));
170 int	nfs_print __P((struct vop_print_args *));
171 int	nfs_pathconf __P((struct vop_pathconf_args *));
172 int	nfs_advlock __P((struct vop_advlock_args *));
173 int	nfs_blkatoff __P((struct vop_blkatoff_args *));
174 int	nfs_bwrite __P((struct vop_bwrite_args *));
175 int	nfs_vget __P((struct mount *, ino_t, struct vnode **));
176 int	nfs_valloc __P((struct vop_valloc_args *));
177 #define nfs_reallocblks \
178 	((int (*) __P((struct  vop_reallocblks_args *)))eopnotsupp)
179 int	nfs_vfree __P((struct vop_vfree_args *));
180 int	nfs_truncate __P((struct vop_truncate_args *));
181 int	nfs_update __P((struct vop_update_args *));
182 
183 /* other stuff */
184 int	nfs_removeit __P((struct sillyrename *));
185 int	nfs_nget __P((struct mount *,nfsfh_t *,int,struct nfsnode **));
186 int	nfs_lookitup __P((struct vnode *,char *,int,struct ucred *,struct proc *,struct nfsnode **));
187 int	nfs_sillyrename __P((struct vnode *,struct vnode *,struct componentname *));
188 nfsuint64 *nfs_getcookie __P((struct nfsnode *, off_t, int));
189 void nfs_invaldir __P((struct vnode *));
190 #define nqnfs_lease_updatetime	lease_updatetime
191 
192 #endif /* KERNEL */
193 
194 #endif
195