NFS - Remove old nfsiod, start adding new kernel thread infrastructure
[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
79e5012e 37 * $FreeBSD: /repoman/r/ncvs/src/sys/nfsclient/nfsnode.h,v 1.43 2004/04/14 23:23:55 peadar Exp $
2313ec23 38 * $DragonFly: src/sys/vfs/nfs/nfsnode.h,v 1.18 2006/05/06 16:01:21 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)
1f2de5d4 46#include "nfs.h"
984263bc
MD
47#endif
48
508ceb09
JS
49#include <sys/lockf.h>
50
984263bc
MD
51/*
52 * Silly rename structure that hangs off the nfsnode until the name
53 * can be removed by nfs_inactive()
54 */
55struct sillyrename {
56 struct ucred *s_cred;
57 struct vnode *s_dvp;
58 long s_namlen;
59 char s_name[20];
60};
61
01f31ab3
JS
62/*
63 * Entries of directories in the buffer cache.
64 */
65struct nfs_dirent {
66 ino_t nfs_ino; /* file number of entry */
67 uint16_t nfs_namlen; /* strlen(d_name) */
68 uint16_t nfs_reclen; /* total record length */
69 uint8_t nfs_type; /* file type */
70 uint8_t nfs_padding1;
71 uint8_t nfs_padding2;
72 uint8_t nfs_padding3;
73 char nfs_name[]; /* name, NUL-terminated */
74};
75
984263bc
MD
76/*
77 * This structure is used to save the logical directory offset to
78 * NFS cookie mappings.
79 * The mappings are stored in a list headed
80 * by n_cookies, as required.
81 * There is one mapping for each NFS_DIRBLKSIZ bytes of directory information
82 * stored in increasing logical offset byte order.
83 */
84#define NFSNUMCOOKIES 31
85
86struct nfsdmap {
87 LIST_ENTRY(nfsdmap) ndm_list;
88 int ndm_eocookie;
89 nfsuint64 ndm_cookies[NFSNUMCOOKIES];
90};
91
92/*
93 * The nfsnode is the nfs equivalent to ufs's inode. Any similarity
c1cf1e59
MD
94 * is purely coincidental. There is a unique nfsnode allocated for
95 * each active file, each current directory, each mounted-on file,
96 * text file, and the root.
97 *
984263bc 98 * An nfsnode is 'named' by its file handle. (nget/nfs_node.c)
c1cf1e59
MD
99 *
100 * File handles are accessed via n_fhp, which will point to n_fh if the
101 * file handle is small enough (<= NFS_SMALLFH). Otherwise the file handle
102 * will be allocated.
103 *
104 * DragonFly does not pass ucreds to read and write operations, since such
105 * operations are not possible unless the ucred has already been validated.
106 * Validating ucreds are stored in nfsnode to pass on to NFS read/write RPCs.
984263bc
MD
107 */
108struct nfsnode {
984263bc 109 LIST_ENTRY(nfsnode) n_hash; /* Hash chain */
984263bc
MD
110 u_quad_t n_size; /* Current size of file */
111 u_quad_t n_brev; /* Modify rev when cached */
984263bc
MD
112 struct vattr n_vattr; /* Vnode attribute cache */
113 time_t n_attrstamp; /* Attr. cache timestamp */
114 u_int32_t n_mode; /* ACCESS mode cache */
115 uid_t n_modeuid; /* credentials having mode */
116 time_t n_modestamp; /* mode cache timestamp */
5a9187cb 117 time_t n_mtime; /* Last known modified time */
984263bc
MD
118 time_t n_ctime; /* Prev create time. */
119 time_t n_expiry; /* Lease expiry time */
120 nfsfh_t *n_fhp; /* NFS File Handle */
c1cf1e59
MD
121 struct ucred *n_rucred;
122 struct ucred *n_wucred;
984263bc 123 struct vnode *n_vnode; /* associated vnode */
508ceb09 124 struct lockf n_lockf; /* Locking record of file */
984263bc
MD
125 int n_error; /* Save write error value */
126 union {
127 struct timespec nf_atim; /* Special file times */
128 nfsuint64 nd_cookieverf; /* Cookie verifier (dir only) */
129 } n_un1;
130 union {
131 struct timespec nf_mtim;
132 off_t nd_direof; /* Dir. EOF offset cache */
133 } n_un2;
134 union {
135 struct sillyrename *nf_silly; /* Ptr to silly rename struct */
136 LIST_HEAD(, nfsdmap) nd_cook; /* cookies */
137 } n_un3;
138 short n_fhsize; /* size in bytes, of fh */
139 short n_flag; /* Flag for locking.. */
140 nfsfh_t n_fh; /* Small File Handle */
141 struct lock n_rslock;
142};
143
144#define n_atim n_un1.nf_atim
145#define n_mtim n_un2.nf_mtim
146#define n_sillyrename n_un3.nf_silly
147#define n_cookieverf n_un1.nd_cookieverf
148#define n_direofoffset n_un2.nd_direof
149#define n_cookies n_un3.nd_cook
150
151/*
152 * Flags for n_flag
153 */
154#define NFLUSHWANT 0x0001 /* Want wakeup from a flush in prog. */
155#define NFLUSHINPROG 0x0002 /* Avoid multiple calls to vinvalbuf() */
5a9187cb 156#define NLMODIFIED 0x0004 /* Client has pending modifications */
984263bc 157#define NWRITEERR 0x0008 /* Flag write errors so close will know */
e07fef60
MD
158#define NDONTCACHE 0x0020 /* Non-cachable */
159#define NUNUSED040 0x0040
984263bc
MD
160#define NQNFSEVICTED 0x0080 /* Has been evicted */
161#define NACC 0x0100 /* Special file accessed */
162#define NUPD 0x0200 /* Special file updated */
163#define NCHG 0x0400 /* Special file times changed */
9ebbf428
DR
164#define NLOCKED 0x0800 /* node is locked */
165#define NWANTED 0x0100 /* someone wants to lock */
5a9187cb 166#define NRMODIFIED 0x2000 /* Server has unsynchronized modifications */
984263bc
MD
167
168/*
169 * Convert between nfsnode pointers and vnode pointers
170 */
9ebbf428
DR
171#define VTONFS(vp) ((struct nfsnode *)(vp)->v_data)
172#define NFSTOV(np) ((struct vnode *)(np)->n_vnode)
984263bc
MD
173
174/*
175 * Queue head for nfsiod's
176 */
177extern TAILQ_HEAD(nfs_bufq, buf) nfs_bufq;
984263bc
MD
178
179#if defined(_KERNEL)
180
181/*
182 * nfs_rslock - Attempt to obtain lock on nfsnode
183 *
184 * Attempt to obtain a lock on the passed nfsnode, returning ENOLCK
185 * if the lock could not be obtained due to our having to sleep. This
186 * function is generally used to lock around code that modifies an
187 * NFS file's size. In order to avoid deadlocks the lock
188 * should not be obtained while other locks are being held.
189 */
190
191static __inline
192int
2313ec23 193nfs_rslock(struct nfsnode *np)
984263bc 194{
9ebbf428 195 return(lockmgr(&np->n_rslock, LK_EXCLUSIVE | LK_CANRECURSE |
df4f70a6 196 LK_SLEEPFAIL));
984263bc
MD
197}
198
199static __inline
200void
2313ec23 201nfs_rsunlock(struct nfsnode *np)
984263bc 202{
df4f70a6 203 lockmgr(&np->n_rslock, LK_RELEASE);
984263bc
MD
204}
205
c1cf1e59
MD
206static __inline
207struct ucred *
208nfs_vpcred(struct vnode *vp, int ndflag)
209{
210 struct nfsnode *np = VTONFS(vp);
211
212 if (np && (ndflag & ND_WRITE) && np->n_wucred)
213 return(np->n_wucred);
214 if (np && (ndflag & ND_READ) && np->n_rucred)
215 return(np->n_rucred);
216 return(VFSTONFS((vp)->v_mount)->nm_cred);
217}
218
984263bc
MD
219/*
220 * Prototypes for NFS vnode operations
221 */
a6ee311a
RG
222int nfs_getpages (struct vop_getpages_args *);
223int nfs_putpages (struct vop_putpages_args *);
224int nfs_write (struct vop_write_args *);
a6ee311a
RG
225int nfs_inactive (struct vop_inactive_args *);
226int nfs_reclaim (struct vop_reclaim_args *);
5a9187cb 227int nfs_flush (struct vnode *, int, struct thread *, int);
984263bc
MD
228
229/* other stuff */
a6ee311a
RG
230int nfs_removeit (struct sillyrename *);
231int nfs_nget (struct mount *,nfsfh_t *,int,struct nfsnode **);
232nfsuint64 *nfs_getcookie (struct nfsnode *, off_t, int);
9ebbf428 233void nfs_invaldir (struct vnode *);
984263bc 234
984263bc
MD
235#endif /* _KERNEL */
236
237#endif