xref: /freebsd/sys/nfsclient/nfsnode.h (revision 17ee9d00bc1ae1e598c38f25826f861e4bc6c3ce)
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  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by the University of
19  *	California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	@(#)nfsnode.h	8.4 (Berkeley) 2/13/94
37  * $Id: nfsnode.h,v 1.7 1994/10/02 17:27:06 phk Exp $
38  */
39 
40 #ifndef _NFS_NFSNODE_H_
41 #define _NFS_NFSNODE_H_
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	ucred *s_cred;
49 	struct	vnode *s_dvp;
50 	long	s_namlen;
51 	char	s_name[20];
52 };
53 
54 /*
55  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
56  * is purely coincidental.
57  * There is a unique nfsnode allocated for each active file,
58  * each current directory, each mounted-on file, text file, and the root.
59  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
60  */
61 
62 struct nfsnode {
63 	LIST_ENTRY(nfsnode) n_hash;	/* Hash chain */
64 	CIRCLEQ_ENTRY(nfsnode) n_timer;	/* Nqnfs timer chain */
65 	nfsv2fh_t n_fh;			/* NFS File Handle */
66 	long	n_flag;			/* Flag for locking.. */
67 	struct	vnode *n_vnode;		/* vnode associated with this node */
68 	struct	vattr n_vattr;		/* Vnode attribute cache */
69 	time_t	n_attrstamp;		/* Time stamp for cached attributes */
70 	struct	sillyrename *n_sillyrename; /* Ptr to silly rename struct */
71 	u_quad_t n_size;		/* Current size of file */
72 	struct	lockf *n_lockf;		/* Locking record of file */
73 	int	n_error;		/* Save write error value */
74 	u_long	n_direofoffset;		/* Dir. EOF offset cache */
75 	time_t	n_mtime;		 /* Prev modify time. */
76 	time_t	n_ctime;		 /* Prev create time. */
77 	u_quad_t n_brev;		 /* Modify rev when cached */
78 	u_quad_t n_lrev;		 /* Modify rev for lease */
79 	time_t	n_expiry;		 /* Lease expiry time */
80 	struct	sillyrename n_silly;	/* Silly rename struct */
81 	struct	timeval n_atim;		/* Special file times */
82 	struct	timeval n_mtim;
83 };
84 
85 /*
86  * Flags for n_flag
87  */
88 #define	NFLUSHWANT	0x0001	/* Want wakeup from a flush in prog. */
89 #define	NFLUSHINPROG	0x0002	/* Avoid multiple calls to vinvalbuf() */
90 #define	NMODIFIED	0x0004	/* Might have a modified buffer in bio */
91 #define	NWRITEERR	0x0008	/* Flag write errors so close will know */
92 #define	NQNFSNONCACHE	0x0020	/* Non-cachable lease */
93 #define	NQNFSWRITE	0x0040	/* Write lease */
94 #define	NQNFSEVICTED	0x0080	/* Has been evicted */
95 #define	NACC		0x0100	/* Special file accessed */
96 #define	NUPD		0x0200	/* Special file updated */
97 #define	NCHG		0x0400	/* Special file times changed */
98 
99 /*
100  * Convert between nfsnode pointers and vnode pointers
101  */
102 #define VTONFS(vp)	((struct nfsnode *)(vp)->v_data)
103 #define NFSTOV(np)	((struct vnode *)(np)->n_vnode)
104 
105 /*
106  * Queue head for nfsiod's
107  */
108 TAILQ_HEAD(, buf) nfs_bufq;
109 
110 #ifdef KERNEL
111 /*
112  * Prototypes for NFS vnode operations
113  */
114 int	nfs_lookup __P((struct vop_lookup_args *));
115 int	nfs_create __P((struct vop_create_args *));
116 int	nfs_mknod __P((struct vop_mknod_args *));
117 int	nfs_open __P((struct vop_open_args *));
118 int	nfs_close __P((struct vop_close_args *));
119 int	nfsspec_close __P((struct vop_close_args *));
120 int	nfsfifo_close __P((struct vop_close_args *));
121 int	nfs_access __P((struct vop_access_args *));
122 int	nfsspec_access __P((struct vop_access_args *));
123 int	nfs_getattr __P((struct vop_getattr_args *));
124 int	nfs_setattr __P((struct vop_setattr_args *));
125 int	nfs_read __P((struct vop_read_args *));
126 int	nfs_write __P((struct vop_write_args *));
127 int	nfsspec_read __P((struct vop_read_args *));
128 int	nfsspec_write __P((struct vop_write_args *));
129 int	nfsfifo_read __P((struct vop_read_args *));
130 int	nfsfifo_write __P((struct vop_write_args *));
131 #define nfs_ioctl ((int (*) __P((struct  vop_ioctl_args *)))enoioctl)
132 #define nfs_select ((int (*) __P((struct  vop_select_args *)))seltrue)
133 int	nfs_mmap __P((struct vop_mmap_args *));
134 int	nfs_fsync __P((struct vop_fsync_args *));
135 #define nfs_seek ((int (*) __P((struct  vop_seek_args *)))nullop)
136 int	nfs_remove __P((struct vop_remove_args *));
137 int	nfs_link __P((struct vop_link_args *));
138 int	nfs_rename __P((struct vop_rename_args *));
139 int	nfs_mkdir __P((struct vop_mkdir_args *));
140 int	nfs_rmdir __P((struct vop_rmdir_args *));
141 int	nfs_symlink __P((struct vop_symlink_args *));
142 int	nfs_readdir __P((struct vop_readdir_args *));
143 int	nfs_readlink __P((struct vop_readlink_args *));
144 int	nfs_abortop __P((struct vop_abortop_args *));
145 int	nfs_inactive __P((struct vop_inactive_args *));
146 int	nfs_reclaim __P((struct vop_reclaim_args *));
147 int	nfs_lock __P((struct vop_lock_args *));
148 int	nfs_unlock __P((struct vop_unlock_args *));
149 int	nfs_bmap __P((struct vop_bmap_args *));
150 int	nfs_strategy __P((struct vop_strategy_args *));
151 int	nfs_print __P((struct vop_print_args *));
152 int	nfs_islocked __P((struct vop_islocked_args *));
153 int	nfs_pathconf __P((struct vop_pathconf_args *));
154 int	nfs_advlock __P((struct vop_advlock_args *));
155 int	nfs_blkatoff __P((struct vop_blkatoff_args *));
156 int	nfs_vget __P((struct mount *, ino_t, struct vnode **));
157 int	nfs_valloc __P((struct vop_valloc_args *));
158 #define nfs_reallocblks \
159 	((int (*) __P((struct  vop_reallocblks_args *)))eopnotsupp)
160 int	nfs_vfree __P((struct vop_vfree_args *));
161 int	nfs_truncate __P((struct vop_truncate_args *));
162 int	nfs_update __P((struct vop_update_args *));
163 int	nfs_bwrite __P((struct vop_bwrite_args *));
164 
165 /* other stuff */
166 int	nfs_removeit __P((struct sillyrename *));
167 int	nfs_nget __P((struct mount *,nfsv2fh_t *,struct nfsnode **));
168 int	nfs_lookitup __P((struct sillyrename *,nfsv2fh_t *,struct proc *));
169 int	nfs_sillyrename __P((struct vnode *,struct vnode *,struct componentname *));
170 
171 #endif /* KERNEL */
172 
173 #endif
174