FreeBSD/Linux Kernel Cross Reference
sys/nfs/nqnfs.h
1 /*
2 * Copyright (c) 1992, 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 * @(#)nqnfs.h 8.3 (Berkeley) 3/30/95
37 * $FreeBSD$
38 */
39
40
41 #ifndef _NFS_NQNFS_H_
42 #define _NFS_NQNFS_H_
43
44 /*
45 * Definitions for NQNFS (Not Quite NFS) cache consistency protocol.
46 */
47
48 /* Tunable constants */
49 #define NQ_CLOCKSKEW 3 /* Clock skew factor (sec) */
50 #define NQ_WRITESLACK 5 /* Delay for write cache flushing */
51 #define NQ_MAXLEASE 60 /* Max lease duration (sec) */
52 #define NQ_MINLEASE 5 /* Min lease duration (sec) */
53 #define NQ_DEFLEASE 30 /* Default lease duration (sec) */
54 #define NQ_RENEWAL 3 /* Time before expiry (sec) to renew */
55 #define NQ_TRYLATERDEL 15 /* Initial try later delay (sec) */
56 #define NQ_MAXNUMLEASE 2048 /* Upper bound on number of server leases */
57 #define NQ_DEADTHRESH NQ_NEVERDEAD /* Default nm_deadthresh */
58 #define NQ_NEVERDEAD 9 /* Greater than max. nm_timeouts */
59 #define NQLCHSZ 256 /* Server hash table size */
60
61 #define NQNFS_PROG 300105 /* As assigned by Sun */
62 #define NQNFS_VER3 3
63 #define NQNFS_EVICTSIZ 156 /* Size of eviction request in bytes */
64
65 #if defined(_KERNEL)
66 /*
67 * Definitions used for saving the "last lease expires" time in Non-volatile
68 * RAM on the server. The default definitions below assume that NOVRAM is not
69 * available.
70 */
71 #ifdef HASNVRAM
72 # undef HASNVRAM
73 #endif
74 #define NQSTORENOVRAM(t)
75 #define NQLOADNOVRAM(t)
76
77 /*
78 * Defn and structs used on the server to maintain state for current leases.
79 * The list of host(s) that hold the lease are kept as nqhost structures.
80 * The first one lives in nqlease and any others are held in a linked
81 * list of nqm structures hanging off of nqlease.
82 *
83 * Each nqlease structure is chained into two lists. The first is a list
84 * ordered by increasing expiry time for nqsrv_timer() and the second is a chain
85 * hashed on lc_fh.
86 */
87 #define LC_MOREHOSTSIZ 10
88
89 struct nqhost {
90 u_int16_t lph_flag;
91 u_int16_t lph_port;
92 struct nfssvc_sock *lph_slp;
93
94 union {
95 struct {
96 union nethostaddr udp_haddr;
97 } un_udp;
98 struct {
99 int dummy;
100 } un_conn;
101 } lph_un;
102 };
103 #define lph_haddr lph_un.un_udp.udp_haddr
104 #define lph_inetaddr lph_un.un_udp.udp_haddr.had_inetaddr
105
106 struct nqlease {
107 LIST_ENTRY(nqlease) lc_hash; /* Fhandle hash list */
108 CIRCLEQ_ENTRY(nqlease) lc_timer; /* Timer queue list */
109 time_t lc_expiry; /* Expiry time (sec) */
110 struct nqhost lc_host; /* Host that got lease */
111 struct nqm *lc_morehosts; /* Other hosts that share read lease */
112 fsid_t lc_fsid; /* Fhandle */
113 char lc_fiddata[MAXFIDSZ];
114 struct vnode *lc_vp; /* Soft reference to associated vnode */
115 };
116 #define lc_flag lc_host.lph_flag
117
118 /* lc_flag bits */
119 #define LC_VALID 0x0001 /* Host address valid */
120 #define LC_WRITE 0x0002 /* Write cache */
121 #define LC_NONCACHABLE 0x0004 /* Non-cachable lease */
122 #define LC_LOCKED 0x0008 /* Locked */
123 #define LC_WANTED 0x0010 /* Lock wanted */
124 #define LC_EXPIREDWANTED 0x0020 /* Want lease when expired */
125 #define LC_UDP 0x0040 /* Host address for udp socket */
126 /* 0x0080 free */
127 #define LC_LOCAL 0x0100 /* Host is server */
128 #define LC_VACATED 0x0200 /* Host has vacated lease */
129 #define LC_WRITTEN 0x0400 /* Recently wrote to the leased file */
130 #define LC_SREF 0x0800 /* Holds a nfssvc_sock reference */
131
132 struct nqm {
133 struct nqm *lpm_next;
134 struct nqhost lpm_hosts[LC_MOREHOSTSIZ];
135 };
136
137 /*
138 * Special value for slp for local server calls.
139 */
140 #define NQLOCALSLP ((struct nfssvc_sock *) -1)
141
142 /*
143 * Server side macros.
144 */
145 #define nqsrv_getl(v, l) \
146 (void) nqsrv_getlease((v), &nfsd->nd_duration, \
147 ((nfsd->nd_flag & ND_LEASE) ? (nfsd->nd_flag & ND_LEASE) : \
148 ((l) | ND_CHECK)), \
149 slp, procp, nfsd->nd_nam, &cache, &frev, cred)
150
151 /*
152 * Client side macros that check for a valid lease.
153 */
154 #define NQNFS_CKINVALID(v, n, f) \
155 ((time_second > (n)->n_expiry && \
156 VFSTONFS((v)->v_mount)->nm_timeouts < VFSTONFS((v)->v_mount)->nm_deadthresh) \
157 || ((f) == ND_WRITE && ((n)->n_flag & NQNFSWRITE) == 0))
158
159 #define NQNFS_CKCACHABLE(v, f) \
160 ((time_second <= VTONFS(v)->n_expiry || \
161 VFSTONFS((v)->v_mount)->nm_timeouts >= VFSTONFS((v)->v_mount)->nm_deadthresh) \
162 && (VTONFS(v)->n_flag & NQNFSNONCACHE) == 0 && \
163 ((f) == ND_READ || (VTONFS(v)->n_flag & NQNFSWRITE)))
164
165 #define NQNFS_NEEDLEASE(v, p) \
166 (time_second > VTONFS(v)->n_expiry ? \
167 ((VTONFS(v)->n_flag & NQNFSEVICTED) ? 0 : nqnfs_piggy[p]) : \
168 (((time_second + NQ_RENEWAL) > VTONFS(v)->n_expiry && \
169 nqnfs_piggy[p]) ? \
170 ((VTONFS(v)->n_flag & NQNFSWRITE) ? \
171 ND_WRITE : nqnfs_piggy[p]) : 0))
172
173 /*
174 * List head for timer queue.
175 */
176 extern CIRCLEQ_HEAD(nqtimerhead, nqlease) nqtimerhead;
177
178 /*
179 * List head for the file handle hash table.
180 */
181 #define NQFHHASH(f) \
182 (&nqfhhashtbl[(*((u_int32_t *)(f))) & nqfhhash])
183 extern LIST_HEAD(nqfhhashhead, nqlease) *nqfhhashtbl;
184 extern u_long nqfhhash;
185
186 /*
187 * Nqnfs return status numbers.
188 */
189 #define NQNFS_EXPIRED 500
190 #define NQNFS_TRYLATER 501
191
192 void nqnfs_lease_check __P((struct vnode *, struct proc *, struct ucred *, int));
193 void nqnfs_lease_updatetime __P((int));
194 int nqsrv_getlease __P((struct vnode *, u_int32_t *, int,
195 struct nfssvc_sock *, struct proc *,
196 struct sockaddr *, int *, u_quad_t *,
197 struct ucred *));
198 int nqnfs_getlease __P((struct vnode *,int,struct ucred *,struct proc *));
199 int nqnfs_callback __P((struct nfsmount *,struct mbuf *,struct mbuf *,caddr_t));
200 int nqnfs_clientd __P((struct nfsmount *,struct ucred *,struct nfsd_cargs *,int,caddr_t,struct proc *));
201 struct nfsnode;
202 void nqnfs_clientlease __P((struct nfsmount *, struct nfsnode *, int, int, time_t, u_quad_t));
203 void nqnfs_serverd __P((void));
204 int nqnfsrv_getlease __P((struct nfsrv_descript *, struct nfssvc_sock *, struct proc *, struct mbuf **));
205 int nqnfsrv_vacated __P((struct nfsrv_descript *, struct nfssvc_sock *, struct proc *, struct mbuf **));
206 #endif
207
208 #endif
Cache object: 56bedcc69f56d64d6657b40a0ab82f46
|