Home | History | Annotate | Line # | Download | only in nfs
nfsnode.h revision 1.21
      1 /*	$NetBSD: nfsnode.h,v 1.21 1997/10/10 01:53:32 fvdl 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 
     49 /*
     50  * Silly rename structure that hangs off the nfsnode until the name
     51  * can be removed by nfs_inactive()
     52  */
     53 struct sillyrename {
     54 	struct	ucred *s_cred;
     55 	struct	vnode *s_dvp;
     56 	long	s_namlen;
     57 	char	s_name[20];
     58 };
     59 
     60 /*
     61  * Definitions for the directory cache. Because directory cookies
     62  * are an opaque 64 bit entity, we need to provide some sort of
     63  * mapping between cookies and logical blocknumbers. Also,
     64  * we should store the cookies from the server somewhere,
     65  * to be able to satisfy VOP_READDIR requests for cookies.
     66  * We can't store the cookies in the dirent structure, as some
     67  * other systems.
     68  *
     69  * Each offset is hashed into a per-nfsnode hashtable. An entry
     70  * found therein contains information about the (faked up)
     71  * logical blocknumber, and also a pointer to a buffer where
     72  * the cookies are stored.
     73  */
     74 
     75 extern u_long nfsdirhashmask;
     76 
     77 LIST_HEAD(nfsdirhashhead, nfsdircache);
     78 TAILQ_HEAD(nfsdirchainhead, nfsdircache);
     79 
     80 struct nfsdircache {
     81 	LIST_ENTRY(nfsdircache) dc_hash;
     82 	TAILQ_ENTRY(nfsdircache) dc_chain;
     83 	off_t	dc_cookie;
     84 	daddr_t	dc_blkno;
     85 	int	dc_entry;
     86 };
     87 
     88 
     89 /*
     90  * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
     91  * is purely coincidental.
     92  * There is a unique nfsnode allocated for each active file,
     93  * each current directory, each mounted-on file, text file, and the root.
     94  * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
     95  * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
     96  * type definitions), file handles of > 32 bytes should probably be split out
     97  * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
     98  * changing the definition in sys/mount.h of NFS_SMALLFH.)
     99  * NB: Hopefully the current order of the fields is such that everything will
    100  *     be well aligned and, therefore, tightly packed.
    101  */
    102 struct nfsnode {
    103 	LIST_ENTRY(nfsnode)	n_hash;		/* Hash chain */
    104 	CIRCLEQ_ENTRY(nfsnode)	n_timer;	/* Nqnfs timer chain */
    105 	u_quad_t		n_size;		/* Current size of file */
    106 	u_quad_t		n_brev;		/* Modify rev when cached */
    107 	u_quad_t		n_lrev;		/* Modify rev for lease */
    108 	struct vattr		n_vattr;	/* Vnode attribute cache */
    109 	time_t			n_attrstamp;	/* Attr. cache timestamp */
    110 	time_t			n_mtime;	/* Prev modify time. */
    111 	time_t			n_ctime;	/* Prev create time. */
    112 	time_t			n_expiry;	/* Lease expiry time */
    113 	nfsfh_t			*n_fhp;		/* NFS File Handle */
    114 	struct vnode		*n_vnode;	/* associated vnode */
    115 	struct lockf		*n_lockf;	/* Locking record of file */
    116 	int			n_error;	/* Save write error value */
    117 	union {
    118 		struct timespec	nf_atim;	/* Special file times */
    119 		nfsuint64	nd_cookieverf;	/* Cookie verifier (dir only) */
    120 	} n_un1;
    121 	union {
    122 		struct timespec	nf_mtim;
    123 		off_t		nd_direof;	/* Dir. EOF offset cache */
    124 	} n_un2;
    125 	union {
    126 		struct sillyrename *nf_silly;	/* Ptr to silly rename struct */
    127 		struct nfsdirhashhead *nd_dircache;
    128 	} n_un3;
    129 	short			n_fhsize;	/* size in bytes, of fh */
    130 	short			n_flag;		/* Flag for locking.. */
    131 	nfsfh_t			n_fh;		/* Small File Handle */
    132 	daddr_t			n_dblkno;	/* To keep faked dir blkno */
    133 	unsigned		n_dircachesize;	/* Size of dir cookie cache */
    134 	struct nfsdirchainhead	n_dirchain;	/* Chain of dir cookies */
    135 };
    136 
    137 #define n_atim		n_un1.nf_atim
    138 #define n_mtim		n_un2.nf_mtim
    139 #define n_sillyrename	n_un3.nf_silly
    140 #define n_cookieverf	n_un1.nd_cookieverf
    141 #define n_direofoffset	n_un2.nd_direof
    142 #define n_dircache	n_un3.nd_dircache
    143 
    144 /*
    145  * Flags for n_flag
    146  */
    147 #define	NFLUSHWANT	0x0001	/* Want wakeup from a flush in prog. */
    148 #define	NFLUSHINPROG	0x0002	/* Avoid multiple calls to vinvalbuf() */
    149 #define	NMODIFIED	0x0004	/* Might have a modified buffer in bio */
    150 #define	NWRITEERR	0x0008	/* Flag write errors so close will know */
    151 #define	NQNFSNONCACHE	0x0020	/* Non-cachable lease */
    152 #define	NQNFSWRITE	0x0040	/* Write lease */
    153 #define	NQNFSEVICTED	0x0080	/* Has been evicted */
    154 #define	NACC		0x0100	/* Special file accessed */
    155 #define	NUPD		0x0200	/* Special file updated */
    156 #define	NCHG		0x0400	/* Special file times changed */
    157 
    158 /*
    159  * Convert between nfsnode pointers and vnode pointers
    160  */
    161 #define VTONFS(vp)	((struct nfsnode *)(vp)->v_data)
    162 #define NFSTOV(np)	((struct vnode *)(np)->n_vnode)
    163 
    164 /*
    165  * Queue head for nfsiod's
    166  */
    167 extern struct proc *nfs_iodwant[NFS_MAXASYNCDAEMON];
    168 extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
    169 
    170 #ifdef _KERNEL
    171 /*
    172  * Prototypes for NFS vnode operations
    173  */
    174 int	nfs_lookup	__P((void *));
    175 int	nfs_create	__P((void *));
    176 int	nfs_mknod	__P((void *));
    177 int	nfs_open	__P((void *));
    178 int	nfs_close	__P((void *));
    179 int	nfsspec_close	__P((void *));
    180 int	nfsfifo_close	__P((void *));
    181 int	nfs_access	__P((void *));
    182 int	nfsspec_access	__P((void *));
    183 int	nfs_getattr	__P((void *));
    184 int	nfs_setattr	__P((void *));
    185 int	nfs_read	__P((void *));
    186 int	nfs_write	__P((void *));
    187 #define	nfs_lease_check	genfs_nullop
    188 #define	nqnfs_vop_lease_check	lease_check
    189 int	nfsspec_read	__P((void *));
    190 int	nfsspec_write	__P((void *));
    191 int	nfsfifo_read	__P((void *));
    192 int	nfsfifo_write	__P((void *));
    193 #define nfs_ioctl	((int (*)	__P((void *)))enoioctl)
    194 #define	nfs_poll	genfs_poll
    195 #ifdef Lite2_integrated
    196 #define nfs_revoke	vop_revoke
    197 #endif
    198 int	nfs_mmap	__P((void *));
    199 int	nfs_fsync	__P((void *));
    200 #define nfs_seek	genfs_seek
    201 int	nfs_remove	__P((void *));
    202 int	nfs_link	__P((void *));
    203 int	nfs_rename	__P((void *));
    204 int	nfs_mkdir	__P((void *));
    205 int	nfs_rmdir	__P((void *));
    206 int	nfs_symlink	__P((void *));
    207 int	nfs_readdir	__P((void *));
    208 int	nfs_readlink	__P((void *));
    209 #define	nfs_abortop	genfs_abortop
    210 int	nfs_inactive	__P((void *));
    211 int	nfs_reclaim	__P((void *));
    212 #ifdef Lite2_integrated
    213 #define nfs_lock	((int (*) __P((void *)))vop_nolock)
    214 #define nfs_unlock	((int (*) __P((void *)))vop_nounlock)
    215 #define nfs_islocked	((int (*) __P((void *)))vop_noislocked)
    216 #else
    217 int	nfs_lock	__P((void *));
    218 int	nfs_unlock	__P((void *));
    219 int	nfs_islocked	__P((void *));
    220 #endif /* Lite2_integrated */
    221 int	nfs_bmap	__P((void *));
    222 int	nfs_strategy	__P((void *));
    223 int	nfs_print	__P((void *));
    224 int	nfs_pathconf	__P((void *));
    225 int	nfs_advlock	__P((void *));
    226 #define	nfs_blkatoff	genfs_eopnotsupp
    227 int	nfs_bwrite	__P((void *));
    228 int	nfs_vget	__P((struct mount *, ino_t, struct vnode **));
    229 #define	nfs_valloc	genfs_eopnotsupp
    230 #define nfs_reallocblks	genfs_eopnotsupp
    231 #define	nfs_vfree	genfs_nullop
    232 int	nfs_truncate	__P((void *));
    233 int	nfs_update	__P((void *));
    234 
    235 extern int (**nfsv2_vnodeop_p) __P((void *));
    236 
    237 #endif /* _KERNEL */
    238 
    239 #endif
    240