Home | History | Annotate | Line # | Download | only in nfs
nfsnode.h revision 1.35
      1 /*	 $NetBSD: nfsnode.h,v 1.35 2002/10/21 12:52:36 yamt Exp $	*/
      2 
      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. All advertising materials mentioning features or use of this software
     19  *    must display the following acknowledgement:
     20  *	This product includes software developed by the University of
     21  *	California, Berkeley and its contributors.
     22  * 4. Neither the name of the University nor the names of its contributors
     23  *    may be used to endorse or promote products derived from this software
     24  *    without specific prior written permission.
     25  *
     26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     36  * SUCH DAMAGE.
     37  *
     38  *	@(#)nfsnode.h	8.9 (Berkeley) 5/14/95
     39  */
     40 
     41 
     42 #ifndef _NFS_NFSNODE_H_
     43 #define _NFS_NFSNODE_H_
     44 
     45 #ifndef _NFS_NFS_H_
     46 #include <nfs/nfs.h>
     47 #endif
     48 #include <miscfs/genfs/genfs.h>
     49 #include <miscfs/genfs/genfs_node.h>
     50 
     51 /*
     52  * Silly rename structure that hangs off the nfsnode until the name
     53  * can be removed by nfs_inactive()
     54  */
     55 struct sillyrename {
     56 	struct	ucred *s_cred;
     57 	struct	vnode *s_dvp;
     58 	long	s_namlen;
     59 	char	s_name[20];
     60 };
     61 
     62 /*
     63  * Definitions for the directory cache. Because directory cookies
     64  * are an opaque 64 bit entity, we need to provide some sort of
     65  * mapping between cookies and logical blocknumbers. Also,
     66  * we should store the cookies from the server somewhere,
     67  * to be able to satisfy VOP_READDIR requests for cookies.
     68  * We can't store the cookies in the dirent structure, as some
     69  * other systems.
     70  *
     71  * Each offset is hashed into a per-nfsnode hashtable. An entry
     72  * found therein contains information about the (faked up)
     73  * logical blocknumber, and also a pointer to a buffer where
     74  * the cookies are stored.
     75  */
     76 
     77 extern u_long nfsdirhashmask;
     78 
     79 LIST_HEAD(nfsdirhashhead, nfsdircache);
     80 TAILQ_HEAD(nfsdirchainhead, nfsdircache);
     81 
     82 struct nfsdircache {
     83 	off_t		dc_cookie;		/* Own offset (key) */
     84 	off_t		dc_blkcookie;		/* Offset of block we're in */
     85 	LIST_ENTRY(nfsdircache) dc_hash;	/* Hash chain */
     86 	TAILQ_ENTRY(nfsdircache) dc_chain;	/* Least recently entered chn */
     87 	u_int32_t	dc_cookie32;		/* Key for 64<->32 xlate case */
     88 	daddr_t		dc_blkno;		/* Number of block we're in */
     89 	int		dc_entry;		/* Entry number within block */
     90 };
     91 
     92 
     93 /*
     94  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
     95  * is purely coincidental.
     96  * There is a unique nfsnode allocated for each active file,
     97  * each current directory, each mounted-on file, text file, and the root.
     98  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
     99  */
    100 struct nfsnode {
    101 	struct genfs_node	n_gnode;
    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 	union {
    106 		struct timespec	nf_mtim;
    107 		off_t		nd_direof;	/* Dir. EOF offset cache */
    108 	} n_un2;
    109 	union {
    110 		struct timespec	nf_atim;	/* Special file times */
    111 		nfsuint64	nd_cookieverf;	/* Cookie verifier (dir only) */
    112 	} n_un1;
    113 	union {
    114 		struct sillyrename *nf_silly;	/* Ptr to silly rename struct */
    115 		struct nfsdirhashhead *nd_dircache;
    116 	} n_un3;
    117 	LIST_ENTRY(nfsnode)	n_hash;		/* Hash chain */
    118 	CIRCLEQ_ENTRY(nfsnode)	n_timer;	/* Nqnfs timer chain */
    119 	struct nfsdirchainhead	n_dirchain;	/* Chain of dir cookies */
    120 	nfsfh_t			*n_fhp;		/* NFS File Handle */
    121 	struct vattr		*n_vattr;	/* Vnode attribute cache */
    122 	struct vnode		*n_vnode;	/* associated vnode */
    123 	struct lockf		*n_lockf;	/* Locking record of file */
    124 	unsigned		*n_dirgens;	/* 32<->64bit xlate gen. no. */
    125 	time_t			n_attrstamp;	/* Attr. cache timestamp */
    126 	time_t			n_mtime;	/* Prev modify time. */
    127 	time_t			n_ctime;	/* Prev create time. */
    128 	time_t			n_nctime;	/* Last neg cache entry (dir) */
    129 	time_t			n_expiry;	/* Lease expiry time */
    130 	daddr_t			n_dblkno;	/* To keep faked dir blkno */
    131 	unsigned		n_dircachesize;	/* Size of dir cookie cache */
    132 	int			n_error;	/* Save write error value */
    133 	short			n_fhsize;	/* size in bytes, of fh */
    134 	short			n_flag;		/* Flag for locking.. */
    135 	nfsfh_t			n_fh;		/* Small File Handle */
    136 	time_t			n_accstamp;	/* Access cache timestamp */
    137 	uid_t			n_accuid;	/* Last access requester */
    138 	int			n_accmode;	/* Mode last requested */
    139 	int			n_accerror;	/* Error last returned */
    140 	off_t			n_pushedlo;	/* 1st blk in commited range */
    141 	off_t			n_pushedhi;	/* Last block in range */
    142 	off_t			n_pushlo;	/* 1st block in commit range */
    143 	off_t			n_pushhi;	/* Last block in range */
    144 	struct lock		n_commitlock;	/* Serialize commits XXX */
    145 	int			n_commitflags;
    146 	struct ucred		*n_rcred;
    147 	struct ucred		*n_wcred;
    148 };
    149 
    150 /*
    151  * Values for n_commitflags
    152  */
    153 #define NFS_COMMIT_PUSH_VALID	0x0001		/* push range valid */
    154 #define NFS_COMMIT_PUSHED_VALID	0x0002		/* pushed range valid */
    155 
    156 #define n_atim		n_un1.nf_atim
    157 #define n_mtim		n_un2.nf_mtim
    158 #define n_sillyrename	n_un3.nf_silly
    159 #define n_cookieverf	n_un1.nd_cookieverf
    160 #define n_direofoffset	n_un2.nd_direof
    161 #define n_dircache	n_un3.nd_dircache
    162 
    163 /*
    164  * Flags for n_flag
    165  */
    166 #define	NFLUSHWANT	0x0001	/* Want wakeup from a flush in prog. */
    167 #define	NFLUSHINPROG	0x0002	/* Avoid multiple calls to vinvalbuf() */
    168 #define	NMODIFIED	0x0004	/* Might have a modified buffer in bio */
    169 #define	NWRITEERR	0x0008	/* Flag write errors so close will know */
    170 #define	NQNFSNONCACHE	0x0020	/* Non-cachable lease */
    171 #define	NQNFSWRITE	0x0040	/* Write lease */
    172 #define	NQNFSEVICTED	0x0080	/* Has been evicted */
    173 #define	NACC		0x0100	/* Special file accessed */
    174 #define	NUPD		0x0200	/* Special file updated */
    175 #define	NCHG		0x0400	/* Special file times changed */
    176 #define	NTRUNCDELAYED	0x1000	/* Should be truncated later */
    177 
    178 /*
    179  * Convert between nfsnode pointers and vnode pointers
    180  */
    181 #define VTONFS(vp)	((struct nfsnode *)(vp)->v_data)
    182 #define NFSTOV(np)	((np)->n_vnode)
    183 
    184 /*
    185  * Queue head for nfsiod's
    186  */
    187 extern struct proc *nfs_iodwant[NFS_MAXASYNCDAEMON];
    188 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
    189 
    190 #ifdef _KERNEL
    191 /*
    192  * Prototypes for NFS vnode operations
    193  */
    194 int	nfs_lookup	__P((void *));
    195 int	nfs_create	__P((void *));
    196 int	nfs_mknod	__P((void *));
    197 int	nfs_open	__P((void *));
    198 int	nfs_close	__P((void *));
    199 int	nfsspec_close	__P((void *));
    200 int	nfsfifo_close	__P((void *));
    201 int	nfs_access	__P((void *));
    202 int	nfsspec_access	__P((void *));
    203 int	nfs_getattr	__P((void *));
    204 int	nfs_setattr	__P((void *));
    205 int	nfs_read	__P((void *));
    206 int	nfs_write	__P((void *));
    207 #define	nfs_lease_check	genfs_nullop
    208 int	nfsspec_read	__P((void *));
    209 int	nfsspec_write	__P((void *));
    210 int	nfsfifo_read	__P((void *));
    211 int	nfsfifo_write	__P((void *));
    212 #define	nfs_ioctl	genfs_enoioctl
    213 #define	nfs_poll	genfs_poll
    214 #define nfs_revoke	genfs_revoke
    215 #define	nfs_mmap	genfs_mmap
    216 int	nfs_fsync	__P((void *));
    217 #define nfs_seek	genfs_seek
    218 int	nfs_remove	__P((void *));
    219 int	nfs_link	__P((void *));
    220 int	nfs_rename	__P((void *));
    221 int	nfs_mkdir	__P((void *));
    222 int	nfs_rmdir	__P((void *));
    223 int	nfs_symlink	__P((void *));
    224 int	nfs_readdir	__P((void *));
    225 int	nfs_readlink	__P((void *));
    226 #define	nfs_abortop	genfs_abortop
    227 int	nfs_inactive	__P((void *));
    228 int	nfs_reclaim	__P((void *));
    229 #define nfs_lock	genfs_lock
    230 int nfs_unlock	__P((void *));
    231 #define nfs_islocked	genfs_islocked
    232 int	nfs_bmap	__P((void *));
    233 int	nfs_strategy	__P((void *));
    234 int	nfs_print	__P((void *));
    235 int	nfs_pathconf	__P((void *));
    236 int	nfs_advlock	__P((void *));
    237 #define	nfs_blkatoff	genfs_eopnotsupp
    238 int	nfs_bwrite	__P((void *));
    239 #define	nfs_valloc	genfs_eopnotsupp
    240 #define nfs_reallocblks	genfs_eopnotsupp
    241 #define	nfs_vfree	genfs_nullop
    242 int	nfs_truncate	__P((void *));
    243 int	nfs_update	__P((void *));
    244 int	nfs_getpages	__P((void *));
    245 int	nfs_putpages	__P((void *));
    246 int	nfs_gop_write(struct vnode *, struct vm_page **, int, int);
    247 
    248 extern int (**nfsv2_vnodeop_p) __P((void *));
    249 
    250 #endif /* _KERNEL */
    251 
    252 #endif
    253