proc->thread stage 4: rework the VFS and DEVICE subsystems to take thread
[dragonfly.git] / sys / vfs / nfs / nfsnode.h
CommitLineData
984263bc
MD
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.9 (Berkeley) 5/14/95
37 * $FreeBSD: src/sys/nfs/nfsnode.h,v 1.32.2.1 2001/06/26 04:20:11 bp Exp $
dadab5e9 38 * $DragonFly: src/sys/vfs/nfs/nfsnode.h,v 1.3 2003/06/25 03:56:07 dillon Exp $
984263bc
MD
39 */
40
41
42#ifndef _NFS_NFSNODE_H_
43#define _NFS_NFSNODE_H_
44
45#if !defined(_NFS_NFS_H_) && !defined(_KERNEL)
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 */
53struct sillyrename {
54 struct ucred *s_cred;
55 struct vnode *s_dvp;
56 long s_namlen;
57 char s_name[20];
58};
59
60/*
61 * This structure is used to save the logical directory offset to
62 * NFS cookie mappings.
63 * The mappings are stored in a list headed
64 * by n_cookies, as required.
65 * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
66 * stored in increasing logical offset byte order.
67 */
68#define NFSNUMCOOKIES 31
69
70struct nfsdmap {
71 LIST_ENTRY(nfsdmap) ndm_list;
72 int ndm_eocookie;
73 nfsuint64 ndm_cookies[NFSNUMCOOKIES];
74};
75
76/*
77 * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
78 * is purely coincidental.
79 * There is a unique nfsnode allocated for each active file,
80 * each current directory, each mounted-on file, text file, and the root.
81 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
82 * If this structure exceeds 256 bytes (it is currently 256 using 4.4BSD-Lite
83 * type definitions), file handles of > 32 bytes should probably be split out
84 * into a separate MALLOC()'d data structure. (Reduce the size of nfsfh_t by
85 * changing the definition in nfsproto.h of NFS_SMALLFH.)
86 * NB: Hopefully the current order of the fields is such that everything will
87 * be well aligned and, therefore, tightly packed.
88 */
89struct nfsnode {
90 struct lock n_lock;
91 LIST_ENTRY(nfsnode) n_hash; /* Hash chain */
92 CIRCLEQ_ENTRY(nfsnode) n_timer; /* Nqnfs timer chain */
93 u_quad_t n_size; /* Current size of file */
94 u_quad_t n_brev; /* Modify rev when cached */
95 u_quad_t n_lrev; /* Modify rev for lease */
96 struct vattr n_vattr; /* Vnode attribute cache */
97 time_t n_attrstamp; /* Attr. cache timestamp */
98 u_int32_t n_mode; /* ACCESS mode cache */
99 uid_t n_modeuid; /* credentials having mode */
100 time_t n_modestamp; /* mode cache timestamp */
101 time_t n_mtime; /* Prev modify time. */
102 time_t n_ctime; /* Prev create time. */
103 time_t n_expiry; /* Lease expiry time */
104 nfsfh_t *n_fhp; /* NFS File Handle */
105 struct vnode *n_vnode; /* associated vnode */
106 struct lockf *n_lockf; /* Locking record of file */
107 int n_error; /* Save write error value */
108 union {
109 struct timespec nf_atim; /* Special file times */
110 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
111 } n_un1;
112 union {
113 struct timespec nf_mtim;
114 off_t nd_direof; /* Dir. EOF offset cache */
115 } n_un2;
116 union {
117 struct sillyrename *nf_silly; /* Ptr to silly rename struct */
118 LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
119 } n_un3;
120 short n_fhsize; /* size in bytes, of fh */
121 short n_flag; /* Flag for locking.. */
122 nfsfh_t n_fh; /* Small File Handle */
123 struct lock n_rslock;
124};
125
126#define n_atim n_un1.nf_atim
127#define n_mtim n_un2.nf_mtim
128#define n_sillyrename n_un3.nf_silly
129#define n_cookieverf n_un1.nd_cookieverf
130#define n_direofoffset n_un2.nd_direof
131#define n_cookies n_un3.nd_cook
132
133/*
134 * Flags for n_flag
135 */
136#define NFLUSHWANT 0x0001 /* Want wakeup from a flush in prog. */
137#define NFLUSHINPROG 0x0002 /* Avoid multiple calls to vinvalbuf() */
138#define NMODIFIED 0x0004 /* Might have a modified buffer in bio */
139#define NWRITEERR 0x0008 /* Flag write errors so close will know */
140#define NQNFSNONCACHE 0x0020 /* Non-cachable lease */
141#define NQNFSWRITE 0x0040 /* Write lease */
142#define NQNFSEVICTED 0x0080 /* Has been evicted */
143#define NACC 0x0100 /* Special file accessed */
144#define NUPD 0x0200 /* Special file updated */
145#define NCHG 0x0400 /* Special file times changed */
146#define NLOCKED 0x0800 /* node is locked */
147#define NWANTED 0x0100 /* someone wants to lock */
148
149/*
150 * Convert between nfsnode pointers and vnode pointers
151 */
152#define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
153#define NFSTOV(np) ((struct vnode *)(np)->n_vnode)
154
155/*
156 * Queue head for nfsiod's
157 */
158extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
dadab5e9 159extern struct thread *nfs_iodwant[NFS_MAXASYNCDAEMON];
984263bc
MD
160extern struct nfsmount *nfs_iodmount[NFS_MAXASYNCDAEMON];
161
162#if defined(_KERNEL)
163
164/*
165 * nfs_rslock - Attempt to obtain lock on nfsnode
166 *
167 * Attempt to obtain a lock on the passed nfsnode, returning ENOLCK
168 * if the lock could not be obtained due to our having to sleep. This
169 * function is generally used to lock around code that modifies an
170 * NFS file's size. In order to avoid deadlocks the lock
171 * should not be obtained while other locks are being held.
172 */
173
174static __inline
175int
dadab5e9 176nfs_rslock(struct nfsnode *np, struct thread *td)
984263bc 177{
dadab5e9 178 return(lockmgr(&np->n_rslock, LK_EXCLUSIVE | LK_CANRECURSE | LK_SLEEPFAIL, NULL, td));
984263bc
MD
179}
180
181static __inline
182void
dadab5e9 183nfs_rsunlock(struct nfsnode *np, struct thread *td)
984263bc 184{
dadab5e9 185 (void)lockmgr(&np->n_rslock, LK_RELEASE, NULL, td);
984263bc
MD
186}
187
188extern vop_t **fifo_nfsv2nodeop_p;
189extern vop_t **nfsv2_vnodeop_p;
190extern vop_t **spec_nfsv2nodeop_p;
191
192/*
193 * Prototypes for NFS vnode operations
194 */
195int nfs_getpages __P((struct vop_getpages_args *));
196int nfs_putpages __P((struct vop_putpages_args *));
197int nfs_write __P((struct vop_write_args *));
198int nqnfs_vop_lease_check __P((struct vop_lease_args *));
199int nfs_inactive __P((struct vop_inactive_args *));
200int nfs_reclaim __P((struct vop_reclaim_args *));
201
202/* other stuff */
203int nfs_removeit __P((struct sillyrename *));
204int nfs_nget __P((struct mount *,nfsfh_t *,int,struct nfsnode **));
205nfsuint64 *nfs_getcookie __P((struct nfsnode *, off_t, int));
206void nfs_invaldir __P((struct vnode *));
207
208#define nqnfs_lease_updatetime nfs_lease_updatetime
209
210#endif /* _KERNEL */
211
212#endif