![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to nqnfs.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Apple XNU] / XNU / bsd / nfs|
Return to nqnfs.h CVS log | Up to [Apple XNU] / XNU / bsd / nfs |
1.1 root 1: /*
2: * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
3: *
4: * @APPLE_LICENSE_HEADER_START@
5: *
6: * The contents of this file constitute Original Code as defined in and
7: * are subject to the Apple Public Source License Version 1.1 (the
8: * "License"). You may not use this file except in compliance with the
9: * License. Please obtain a copy of the License at
10: * http://www.apple.com/publicsource and read it before using this file.
11: *
12: * This Original Code and all software distributed under the License are
13: * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
14: * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
15: * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
16: * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
17: * License for the specific language governing rights and limitations
18: * under the License.
19: *
20: * @APPLE_LICENSE_HEADER_END@
21: */
22: /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
23: /*
24: * Copyright (c) 1992, 1993
25: * The Regents of the University of California. All rights reserved.
26: *
27: * This code is derived from software contributed to Berkeley by
28: * Rick Macklem at The University of Guelph.
29: *
30: * Redistribution and use in source and binary forms, with or without
31: * modification, are permitted provided that the following conditions
32: * are met:
33: * 1. Redistributions of source code must retain the above copyright
34: * notice, this list of conditions and the following disclaimer.
35: * 2. Redistributions in binary form must reproduce the above copyright
36: * notice, this list of conditions and the following disclaimer in the
37: * documentation and/or other materials provided with the distribution.
38: * 3. All advertising materials mentioning features or use of this software
39: * must display the following acknowledgement:
40: * This product includes software developed by the University of
41: * California, Berkeley and its contributors.
42: * 4. Neither the name of the University nor the names of its contributors
43: * may be used to endorse or promote products derived from this software
44: * without specific prior written permission.
45: *
46: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
47: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
49: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
50: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
51: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
52: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
53: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
54: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
55: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
56: * SUCH DAMAGE.
57: *
58: * @(#)nqnfs.h 8.3 (Berkeley) 3/30/95
59: * FreeBSD-Id: nqnfs.h,v 1.14 1997/08/16 19:16:05 wollman Exp $
60: */
61:
62:
63: #ifndef _NFS_NQNFS_H_
64: #define _NFS_NQNFS_H_
65:
66: /*
67: * Definitions for NQNFS (Not Quite NFS) cache consistency protocol.
68: */
69:
70: /* Tunable constants */
71: #define NQ_CLOCKSKEW 3 /* Clock skew factor (sec) */
72: #define NQ_WRITESLACK 5 /* Delay for write cache flushing */
73: #define NQ_MAXLEASE 60 /* Max lease duration (sec) */
74: #define NQ_MINLEASE 5 /* Min lease duration (sec) */
75: #define NQ_DEFLEASE 30 /* Default lease duration (sec) */
76: #define NQ_RENEWAL 3 /* Time before expiry (sec) to renew */
77: #define NQ_TRYLATERDEL 15 /* Initial try later delay (sec) */
78: #define NQ_MAXNUMLEASE 2048 /* Upper bound on number of server leases */
79: #define NQ_DEADTHRESH NQ_NEVERDEAD /* Default nm_deadthresh */
80: #define NQ_NEVERDEAD 9 /* Greater than max. nm_timeouts */
81: #define NQLCHSZ 256 /* Server hash table size */
82:
83: #define NQNFS_PROG 300105 /* As assigned by Sun */
84: #define NQNFS_VER3 3
85: #define NQNFS_EVICTSIZ 156 /* Size of eviction request in bytes */
86:
87: /*
88: * Definitions used for saving the "last lease expires" time in Non-volatile
89: * RAM on the server. The default definitions below assume that NOVRAM is not
90: * available.
91: */
92: #ifdef HASNVRAM
93: # undef HASNVRAM
94: #endif
95: #define NQSTORENOVRAM(t)
96: #define NQLOADNOVRAM(t)
97:
98: /*
99: * Defn and structs used on the server to maintain state for current leases.
100: * The list of host(s) that hold the lease are kept as nqhost structures.
101: * The first one lives in nqlease and any others are held in a linked
102: * list of nqm structures hanging off of nqlease.
103: *
104: * Each nqlease structure is chained into two lists. The first is a list
105: * ordered by increasing expiry time for nqsrv_timer() and the second is a chain
106: * hashed on lc_fh.
107: */
108: #define LC_MOREHOSTSIZ 10
109:
110: struct nqhost {
111: union {
112: struct {
113: u_short udp_flag;
114: u_short udp_port;
115: union nethostaddr udp_haddr;
116: } un_udp;
117: struct {
118: u_short connless_flag;
119: u_short connless_spare;
120: union nethostaddr connless_haddr;
121: } un_connless;
122: struct {
123: u_short conn_flag;
124: u_short conn_spare;
125: struct nfssvc_sock *conn_slp;
126: } un_conn;
127: } lph_un;
128: };
129: #define lph_flag lph_un.un_udp.udp_flag
130: #define lph_port lph_un.un_udp.udp_port
131: #define lph_haddr lph_un.un_udp.udp_haddr
132: #define lph_inetaddr lph_un.un_udp.udp_haddr.had_inetaddr
133: #define lph_claddr lph_un.un_connless.connless_haddr
134: #define lph_nam lph_un.un_connless.connless_haddr.had_nam
135: #define lph_slp lph_un.un_conn.conn_slp
136:
137: struct nqlease {
138: LIST_ENTRY(nqlease) lc_hash; /* Fhandle hash list */
139: CIRCLEQ_ENTRY(nqlease) lc_timer; /* Timer queue list */
140: time_t lc_expiry; /* Expiry time (sec) */
141: struct nqhost lc_host; /* Host that got lease */
142: struct nqm *lc_morehosts; /* Other hosts that share read lease */
143: fsid_t lc_fsid; /* Fhandle */
144: char lc_fiddata[MAXFIDSZ];
145: struct vnode *lc_vp; /* Soft reference to associated vnode */
146: };
147: #define lc_flag lc_host.lph_un.un_udp.udp_flag
148:
149: /* lc_flag bits */
150: #define LC_VALID 0x0001 /* Host address valid */
151: #define LC_WRITE 0x0002 /* Write cache */
152: #define LC_NONCACHABLE 0x0004 /* Non-cachable lease */
153: #define LC_LOCKED 0x0008 /* Locked */
154: #define LC_WANTED 0x0010 /* Lock wanted */
155: #define LC_EXPIREDWANTED 0x0020 /* Want lease when expired */
156: #define LC_UDP 0x0040 /* Host address for udp socket */
157: #define LC_CLTP 0x0080 /* Host address for other connectionless */
158: #define LC_LOCAL 0x0100 /* Host is server */
159: #define LC_VACATED 0x0200 /* Host has vacated lease */
160: #define LC_WRITTEN 0x0400 /* Recently wrote to the leased file */
161: #define LC_SREF 0x0800 /* Holds a nfssvc_sock reference */
162:
163: struct nqm {
164: struct nqm *lpm_next;
165: struct nqhost lpm_hosts[LC_MOREHOSTSIZ];
166: };
167:
168: /*
169: * Special value for slp for local server calls.
170: */
171: #define NQLOCALSLP ((struct nfssvc_sock *) -1)
172:
173: /*
174: * Server side macros.
175: */
176: #define nqsrv_getl(v, l) \
177: (void) nqsrv_getlease((v), &nfsd->nd_duration, \
178: ((nfsd->nd_flag & ND_LEASE) ? (nfsd->nd_flag & ND_LEASE) : \
179: ((l) | ND_CHECK)), \
180: slp, procp, nfsd->nd_nam, &cache, &frev, cred)
181:
182: /*
183: * Client side macros that check for a valid lease.
184: */
185: #define NQNFS_CKINVALID(v, n, f) \
186: ((time.tv_sec > (n)->n_expiry && \
187: VFSTONFS((v)->v_mount)->nm_timeouts < VFSTONFS((v)->v_mount)->nm_deadthresh) \
188: || ((f) == ND_WRITE && ((n)->n_flag & NQNFSWRITE) == 0))
189:
190: #define NQNFS_CKCACHABLE(v, f) \
191: ((time.tv_sec <= VTONFS(v)->n_expiry || \
192: VFSTONFS((v)->v_mount)->nm_timeouts >= VFSTONFS((v)->v_mount)->nm_deadthresh) \
193: && (VTONFS(v)->n_flag & NQNFSNONCACHE) == 0 && \
194: ((f) == ND_READ || (VTONFS(v)->n_flag & NQNFSWRITE)))
195:
196: #define NQNFS_NEEDLEASE(v, p) \
197: (time.tv_sec > VTONFS(v)->n_expiry ? \
198: ((VTONFS(v)->n_flag & NQNFSEVICTED) ? 0 : nqnfs_piggy[p]) : \
199: (((time.tv_sec + NQ_RENEWAL) > VTONFS(v)->n_expiry && \
200: nqnfs_piggy[p]) ? \
201: ((VTONFS(v)->n_flag & NQNFSWRITE) ? \
202: ND_WRITE : nqnfs_piggy[p]) : 0))
203:
204: /*
205: * List head for timer queue.
206: */
207: extern CIRCLEQ_HEAD(nqtimerhead, nqlease) nqtimerhead;
208:
209: /*
210: * List head for the file handle hash table.
211: */
212: #define NQFHHASH(f) \
213: (&nqfhhashtbl[(*((u_long *)(f))) & nqfhhash])
214: extern LIST_HEAD(nqfhhashhead, nqlease) *nqfhhashtbl;
215: extern u_long nqfhhash;
216:
217: /*
218: * Nqnfs return status numbers.
219: */
220: #define NQNFS_EXPIRED 500
221: #define NQNFS_TRYLATER 501
222:
223: #if defined(KERNEL)
224: void nqnfs_lease_check __P((struct vnode *, struct proc *, struct ucred *, int));
225: void nqnfs_lease_updatetime __P((int));
226: int nqsrv_getlease __P((struct vnode *, u_long *, int,
227: struct nfssvc_sock *, struct proc *,
228: struct mbuf *, int *, u_quad_t *,
229: struct ucred *));
230: int nqnfs_getlease __P((struct vnode *,int,struct ucred *,struct proc *));
231: int nqnfs_callback __P((struct nfsmount *,struct mbuf *,struct mbuf *,caddr_t));
232: int nqnfs_clientd __P((struct nfsmount *,struct ucred *,struct nfsd_cargs *,int,caddr_t,struct proc *));
233: struct nfsnode;
234: void nqnfs_clientlease __P((struct nfsmount *, struct nfsnode *, int, int, time_t, u_quad_t));
235: void nqnfs_serverd __P((void));
236: int nqnfsrv_getlease __P((struct nfsrv_descript *, struct nfssvc_sock *, struct proc *, struct mbuf **));
237: int nqnfsrv_vacated __P((struct nfsrv_descript *, struct nfssvc_sock *, struct proc *, struct mbuf **));
238: #endif
239:
240: #endif
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.