FreeBSD/Linux Kernel Cross Reference
sys/fs/nfs/nfs.h
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 * 4. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 * $FreeBSD: releng/11.0/sys/fs/nfs/nfs.h 291527 2015-11-30 21:54:27Z rmacklem $
33 */
34
35 #ifndef _NFS_NFS_H_
36 #define _NFS_NFS_H_
37 /*
38 * Tunable constants for nfs
39 */
40
41 #define NFS_MAXIOVEC 34
42 #define NFS_TICKINTVL 500 /* Desired time for a tick (msec) */
43 #define NFS_HZ (hz / nfscl_ticks) /* Ticks/sec */
44 #define NFS_TIMEO (1 * NFS_HZ) /* Default timeout = 1 second */
45 #define NFS_MINTIMEO (1 * NFS_HZ) /* Min timeout to use */
46 #define NFS_MAXTIMEO (60 * NFS_HZ) /* Max timeout to backoff to */
47 #define NFS_TCPTIMEO 300 /* TCP timeout */
48 #define NFS_MAXRCVTIMEO 60 /* 1 minute in seconds */
49 #define NFS_MINIDEMTIMEO (5 * NFS_HZ) /* Min timeout for non-idempotent ops*/
50 #define NFS_MAXREXMIT 100 /* Stop counting after this many */
51 #define NFSV4_CALLBACKTIMEO (2 * NFS_HZ) /* Timeout in ticks */
52 #define NFSV4_CALLBACKRETRY 5 /* Number of retries before failure */
53 #define NFSV4_SLOTS 64 /* Number of slots, fore channel */
54 #define NFSV4_CBSLOTS 8 /* Number of slots, back channel */
55 #define NFSV4_CBRETRYCNT 4 /* # of CBRecall retries upon err */
56 #define NFSV4_UPCALLTIMEO (15 * NFS_HZ) /* Timeout in ticks for upcalls */
57 /* to gssd or nfsuserd */
58 #define NFSV4_UPCALLRETRY 4 /* Number of retries before failure */
59 #define NFS_MAXWINDOW 1024 /* Max number of outstanding requests */
60 #define NFS_RETRANS 10 /* Num of retrans for soft mounts */
61 #define NFS_RETRANS_TCP 2 /* Num of retrans for TCP soft mounts */
62 #define NFS_MAXGRPS 16 /* Max. size of groups list */
63 #define NFS_TRYLATERDEL 15 /* Maximum delay timeout (sec) */
64 #ifndef NFS_REMOVETIMEO
65 #define NFS_REMOVETIMEO 15 /* # sec to wait for delegret in local syscall */
66 #endif
67 #ifndef NFS_MINATTRTIMO
68 #define NFS_MINATTRTIMO 5 /* Attribute cache timeout in sec */
69 #endif
70 #ifndef NFS_MAXATTRTIMO
71 #define NFS_MAXATTRTIMO 60
72 #endif
73 #define NFS_WSIZE 8192 /* Def. write data size <= 8192 */
74 #define NFS_RSIZE 8192 /* Def. read data size <= 8192 */
75 #define NFS_READDIRSIZE 8192 /* Def. readdir size */
76 #define NFS_DEFRAHEAD 1 /* Def. read ahead # blocks */
77 #define NFS_MAXRAHEAD 16 /* Max. read ahead # blocks */
78 #define NFS_MAXASYNCDAEMON 64 /* Max. number async_daemons runnable */
79 #define NFS_MAXUIDHASH 64 /* Max. # of hashed uid entries/mp */
80 #ifndef NFSRV_LEASE
81 #define NFSRV_LEASE 120 /* Lease time in seconds for V4 */
82 #endif /* assigned to nfsrv_lease */
83 #ifndef NFSRV_STALELEASE
84 #define NFSRV_STALELEASE (5 * nfsrv_lease)
85 #endif
86 #ifndef NFSRV_MOULDYLEASE
87 #define NFSRV_MOULDYLEASE 604800 /* One week (in sec) */
88 #endif
89 #ifndef NFSCLIENTHASHSIZE
90 #define NFSCLIENTHASHSIZE 20 /* Size of server client hash table */
91 #endif
92 #ifndef NFSLOCKHASHSIZE
93 #define NFSLOCKHASHSIZE 20 /* Size of server nfslock hash table */
94 #endif
95 #ifndef NFSSESSIONHASHSIZE
96 #define NFSSESSIONHASHSIZE 20 /* Size of server session hash table */
97 #endif
98 #define NFSSTATEHASHSIZE 10 /* Size of server stateid hash table */
99 #ifndef NFSCLDELEGHIGHWATER
100 #define NFSCLDELEGHIGHWATER 10000 /* limit for client delegations */
101 #endif
102 #ifndef NFSCLLAYOUTHIGHWATER
103 #define NFSCLLAYOUTHIGHWATER 10000 /* limit for client pNFS layouts */
104 #endif
105 #ifndef NFSNOOPEN /* Inactive open owner (sec) */
106 #define NFSNOOPEN 120
107 #endif
108 #define NFSRV_LEASEDELTA 15 /* # of seconds to delay beyond lease */
109 #define NFS_IDMAXSIZE 4 /* max sizeof (in_addr_t) */
110 #ifndef NFSRVCACHE_UDPTIMEOUT
111 #define NFSRVCACHE_UDPTIMEOUT 30 /* # of sec to hold cached rpcs(udp) */
112 #endif
113 #ifndef NFSRVCACHE_UDPHIGHWATER
114 #define NFSRVCACHE_UDPHIGHWATER 500 /* Max # of udp cache entries */
115 #endif
116 #ifndef NFSRVCACHE_TCPTIMEOUT
117 #define NFSRVCACHE_TCPTIMEOUT (3600*12) /*#of sec to hold cached rpcs(tcp) */
118 #endif
119 #ifndef NFSRVCACHE_FLOODLEVEL
120 #define NFSRVCACHE_FLOODLEVEL 16384 /* Very high water mark for cache */
121 #endif
122 #ifndef NFSRV_CLIENTHIGHWATER
123 #define NFSRV_CLIENTHIGHWATER 1000
124 #endif
125 #ifndef NFSRV_MAXDUMPLIST
126 #define NFSRV_MAXDUMPLIST 10000
127 #endif
128 #ifndef NFS_ACCESSCACHESIZE
129 #define NFS_ACCESSCACHESIZE 8
130 #endif
131 #define NFSV4_CBPORT 7745 /* Callback port for testing */
132
133 /*
134 * This macro defines the high water mark for issuing V4 delegations.
135 * (It is currently set at a conservative 20% of nfsrv_v4statelimit. This
136 * may want to increase when clients can make more effective use of
137 * delegations.)
138 */
139 #define NFSRV_V4DELEGLIMIT(c) (((c) * 5) > nfsrv_v4statelimit)
140
141 #define NFS_READDIRBLKSIZ DIRBLKSIZ /* Minimal nm_readdirsize */
142
143 /*
144 * Oddballs
145 */
146 #define NFS_CMPFH(n, f, s) \
147 ((n)->n_fhp->nfh_len == (s) && !NFSBCMP((n)->n_fhp->nfh_fh, (caddr_t)(f), (s)))
148 #define NFSRV_CMPFH(nf, ns, f, s) \
149 ((ns) == (s) && !NFSBCMP((caddr_t)(nf), (caddr_t)(f), (s)))
150 #define NFS_CMPTIME(t1, t2) \
151 ((t1).tv_sec == (t2).tv_sec && (t1).tv_nsec == (t2).tv_nsec)
152 #define NFS_SETTIME(t) do { \
153 (t).tv_sec = time.tv_sec; (t).tv_nsec = 1000 * time.tv_usec; } while (0)
154 #define NFS_SRVMAXDATA(n) \
155 (((n)->nd_flag & (ND_NFSV3 | ND_NFSV4)) ? \
156 NFS_SRVMAXIO : NFS_V2MAXDATA)
157 #define NFS64BITSSET 0xffffffffffffffffull
158 #define NFS64BITSMINUS1 0xfffffffffffffffeull
159
160 /*
161 * Structures for the nfssvc(2) syscall. Not that anyone but nfsd, mount_nfs
162 * and nfsloaduser should ever try and use it.
163 */
164 struct nfsd_addsock_args {
165 int sock; /* Socket to serve */
166 caddr_t name; /* Client addr for connection based sockets */
167 int namelen; /* Length of name */
168 };
169
170 /*
171 * nfsd argument for new krpc.
172 */
173 struct nfsd_nfsd_args {
174 const char *principal; /* GSS-API service principal name */
175 int minthreads; /* minimum service thread count */
176 int maxthreads; /* maximum service thread count */
177 };
178
179 /*
180 * Arguments for use by the callback daemon.
181 */
182 struct nfsd_nfscbd_args {
183 const char *principal; /* GSS-API service principal name */
184 };
185
186 struct nfscbd_args {
187 int sock; /* Socket to serve */
188 caddr_t name; /* Client addr for connection based sockets */
189 int namelen; /* Length of name */
190 u_short port; /* Port# for callbacks */
191 };
192
193 struct nfsd_idargs {
194 int nid_flag; /* Flags (see below) */
195 uid_t nid_uid; /* user/group id */
196 gid_t nid_gid;
197 int nid_usermax; /* Upper bound on user name cache */
198 int nid_usertimeout;/* User name timeout (minutes) */
199 u_char *nid_name; /* Name */
200 int nid_namelen; /* and its length */
201 gid_t *nid_grps; /* and the list */
202 int nid_ngroup; /* Size of groups list */
203 };
204
205 struct nfsd_oidargs {
206 int nid_flag; /* Flags (see below) */
207 uid_t nid_uid; /* user/group id */
208 gid_t nid_gid;
209 int nid_usermax; /* Upper bound on user name cache */
210 int nid_usertimeout;/* User name timeout (minutes) */
211 u_char *nid_name; /* Name */
212 int nid_namelen; /* and its length */
213 };
214
215 struct nfsd_clid {
216 int nclid_idlen; /* Length of client id */
217 u_char nclid_id[NFSV4_OPAQUELIMIT]; /* and name */
218 };
219
220 struct nfsd_dumplist {
221 int ndl_size; /* Number of elements */
222 void *ndl_list; /* and the list of elements */
223 };
224
225 struct nfsd_dumpclients {
226 u_int32_t ndcl_flags; /* LCL_xxx flags */
227 u_int32_t ndcl_nopenowners; /* Number of openowners */
228 u_int32_t ndcl_nopens; /* and opens */
229 u_int32_t ndcl_nlockowners; /* and of lockowners */
230 u_int32_t ndcl_nlocks; /* and of locks */
231 u_int32_t ndcl_ndelegs; /* and of delegations */
232 u_int32_t ndcl_nolddelegs; /* and old delegations */
233 sa_family_t ndcl_addrfam; /* Callback address */
234 union {
235 struct in_addr sin_addr;
236 struct in6_addr sin6_addr;
237 } ndcl_cbaddr;
238 struct nfsd_clid ndcl_clid; /* and client id */
239 };
240
241 struct nfsd_dumplocklist {
242 char *ndllck_fname; /* File Name */
243 int ndllck_size; /* Number of elements */
244 void *ndllck_list; /* and the list of elements */
245 };
246
247 struct nfsd_dumplocks {
248 u_int32_t ndlck_flags; /* state flags NFSLCK_xxx */
249 nfsv4stateid_t ndlck_stateid; /* stateid */
250 u_int64_t ndlck_first; /* lock byte range */
251 u_int64_t ndlck_end;
252 struct nfsd_clid ndlck_owner; /* Owner of open/lock */
253 sa_family_t ndlck_addrfam; /* Callback address */
254 union {
255 struct in_addr sin_addr;
256 struct in6_addr sin6_addr;
257 } ndlck_cbaddr;
258 struct nfsd_clid ndlck_clid; /* and client id */
259 };
260
261 /*
262 * Structure for referral information.
263 */
264 struct nfsreferral {
265 u_char *nfr_srvlist; /* List of servers */
266 int nfr_srvcnt; /* number of servers */
267 vnode_t nfr_vp; /* vnode for referral */
268 u_int32_t nfr_dfileno; /* assigned dir inode# */
269 };
270
271 /*
272 * Flags for lc_flags and opsflags for nfsrv_getclient().
273 */
274 #define LCL_NEEDSCONFIRM 0x00000001
275 #define LCL_DONTCLEAN 0x00000002
276 #define LCL_WAKEUPWANTED 0x00000004
277 #define LCL_TCPCALLBACK 0x00000008
278 #define LCL_CALLBACKSON 0x00000010
279 #define LCL_INDEXNOTOK 0x00000020
280 #define LCL_STAMPEDSTABLE 0x00000040
281 #define LCL_EXPIREIT 0x00000080
282 #define LCL_CBDOWN 0x00000100
283 #define LCL_KERBV 0x00000400
284 #define LCL_NAME 0x00000800
285 #define LCL_NEEDSCBNULL 0x00001000
286 #define LCL_GSSINTEGRITY 0x00002000
287 #define LCL_GSSPRIVACY 0x00004000
288 #define LCL_ADMINREVOKED 0x00008000
289 #define LCL_RECLAIMCOMPLETE 0x00010000
290 #define LCL_NFSV41 0x00020000
291
292 #define LCL_GSS LCL_KERBV /* Or of all mechs */
293
294 /*
295 * Bits for flags in nfslock and nfsstate.
296 * The access, deny, NFSLCK_READ and NFSLCK_WRITE bits must be defined as
297 * below, in the correct order, so the shifts work for tests.
298 */
299 #define NFSLCK_READACCESS 0x00000001
300 #define NFSLCK_WRITEACCESS 0x00000002
301 #define NFSLCK_ACCESSBITS (NFSLCK_READACCESS | NFSLCK_WRITEACCESS)
302 #define NFSLCK_SHIFT 2
303 #define NFSLCK_READDENY 0x00000004
304 #define NFSLCK_WRITEDENY 0x00000008
305 #define NFSLCK_DENYBITS (NFSLCK_READDENY | NFSLCK_WRITEDENY)
306 #define NFSLCK_SHAREBITS \
307 (NFSLCK_READACCESS|NFSLCK_WRITEACCESS|NFSLCK_READDENY|NFSLCK_WRITEDENY)
308 #define NFSLCK_LOCKSHIFT 4
309 #define NFSLCK_READ 0x00000010
310 #define NFSLCK_WRITE 0x00000020
311 #define NFSLCK_BLOCKING 0x00000040
312 #define NFSLCK_RECLAIM 0x00000080
313 #define NFSLCK_OPENTOLOCK 0x00000100
314 #define NFSLCK_TEST 0x00000200
315 #define NFSLCK_LOCK 0x00000400
316 #define NFSLCK_UNLOCK 0x00000800
317 #define NFSLCK_OPEN 0x00001000
318 #define NFSLCK_CLOSE 0x00002000
319 #define NFSLCK_CHECK 0x00004000
320 #define NFSLCK_RELEASE 0x00008000
321 #define NFSLCK_NEEDSCONFIRM 0x00010000
322 #define NFSLCK_CONFIRM 0x00020000
323 #define NFSLCK_DOWNGRADE 0x00040000
324 #define NFSLCK_DELEGREAD 0x00080000
325 #define NFSLCK_DELEGWRITE 0x00100000
326 #define NFSLCK_DELEGCUR 0x00200000
327 #define NFSLCK_DELEGPREV 0x00400000
328 #define NFSLCK_OLDDELEG 0x00800000
329 #define NFSLCK_DELEGRECALL 0x01000000
330 #define NFSLCK_SETATTR 0x02000000
331 #define NFSLCK_DELEGPURGE 0x04000000
332 #define NFSLCK_DELEGRETURN 0x08000000
333 #define NFSLCK_WANTWDELEG 0x10000000
334 #define NFSLCK_WANTRDELEG 0x20000000
335 #define NFSLCK_WANTNODELEG 0x40000000
336 #define NFSLCK_WANTBITS \
337 (NFSLCK_WANTWDELEG | NFSLCK_WANTRDELEG | NFSLCK_WANTNODELEG)
338
339 /* And bits for nid_flag */
340 #define NFSID_INITIALIZE 0x0001
341 #define NFSID_ADDUID 0x0002
342 #define NFSID_DELUID 0x0004
343 #define NFSID_ADDUSERNAME 0x0008
344 #define NFSID_DELUSERNAME 0x0010
345 #define NFSID_ADDGID 0x0020
346 #define NFSID_DELGID 0x0040
347 #define NFSID_ADDGROUPNAME 0x0080
348 #define NFSID_DELGROUPNAME 0x0100
349
350 /*
351 * fs.nfs sysctl(3) identifiers
352 */
353 #define NFS_NFSSTATS 1 /* struct: struct nfsstats */
354
355 /*
356 * Here is the definition of the attribute bits array and macros that
357 * manipulate it.
358 * THE MACROS MUST BE MANUALLY MODIFIED IF NFSATTRBIT_MAXWORDS CHANGES!!
359 * It is (NFSATTRBIT_MAX + 31) / 32.
360 */
361 #define NFSATTRBIT_MAXWORDS 3
362
363 typedef struct {
364 u_int32_t bits[NFSATTRBIT_MAXWORDS];
365 } nfsattrbit_t;
366
367 #define NFSZERO_ATTRBIT(b) do { \
368 (b)->bits[0] = 0; \
369 (b)->bits[1] = 0; \
370 (b)->bits[2] = 0; \
371 } while (0)
372
373 #define NFSSET_ATTRBIT(t, f) do { \
374 (t)->bits[0] = (f)->bits[0]; \
375 (t)->bits[1] = (f)->bits[1]; \
376 (t)->bits[2] = (f)->bits[2]; \
377 } while (0)
378
379 #define NFSSETSUPP_ATTRBIT(b) do { \
380 (b)->bits[0] = NFSATTRBIT_SUPP0; \
381 (b)->bits[1] = (NFSATTRBIT_SUPP1 | NFSATTRBIT_SUPPSETONLY); \
382 (b)->bits[2] = NFSATTRBIT_SUPP2; \
383 } while (0)
384
385 #define NFSISSET_ATTRBIT(b, p) ((b)->bits[(p) / 32] & (1 << ((p) % 32)))
386 #define NFSSETBIT_ATTRBIT(b, p) ((b)->bits[(p) / 32] |= (1 << ((p) % 32)))
387 #define NFSCLRBIT_ATTRBIT(b, p) ((b)->bits[(p) / 32] &= ~(1 << ((p) % 32)))
388
389 #define NFSCLRALL_ATTRBIT(b, a) do { \
390 (b)->bits[0] &= ~((a)->bits[0]); \
391 (b)->bits[1] &= ~((a)->bits[1]); \
392 (b)->bits[2] &= ~((a)->bits[2]); \
393 } while (0)
394
395 #define NFSCLRNOT_ATTRBIT(b, a) do { \
396 (b)->bits[0] &= ((a)->bits[0]); \
397 (b)->bits[1] &= ((a)->bits[1]); \
398 (b)->bits[2] &= ((a)->bits[2]); \
399 } while (0)
400
401 #define NFSCLRNOTFILLABLE_ATTRBIT(b) do { \
402 (b)->bits[0] &= NFSATTRBIT_SUPP0; \
403 (b)->bits[1] &= NFSATTRBIT_SUPP1; \
404 (b)->bits[2] &= NFSATTRBIT_SUPP2; \
405 } while (0)
406
407 #define NFSCLRNOTSETABLE_ATTRBIT(b) do { \
408 (b)->bits[0] &= NFSATTRBIT_SETABLE0; \
409 (b)->bits[1] &= NFSATTRBIT_SETABLE1; \
410 (b)->bits[2] &= NFSATTRBIT_SETABLE2; \
411 } while (0)
412
413 #define NFSNONZERO_ATTRBIT(b) ((b)->bits[0] || (b)->bits[1] || (b)->bits[2])
414 #define NFSEQUAL_ATTRBIT(b, p) ((b)->bits[0] == (p)->bits[0] && \
415 (b)->bits[1] == (p)->bits[1] && (b)->bits[2] == (p)->bits[2])
416
417 #define NFSGETATTR_ATTRBIT(b) do { \
418 (b)->bits[0] = NFSATTRBIT_GETATTR0; \
419 (b)->bits[1] = NFSATTRBIT_GETATTR1; \
420 (b)->bits[2] = NFSATTRBIT_GETATTR2; \
421 } while (0)
422
423 #define NFSWCCATTR_ATTRBIT(b) do { \
424 (b)->bits[0] = NFSATTRBIT_WCCATTR0; \
425 (b)->bits[1] = NFSATTRBIT_WCCATTR1; \
426 (b)->bits[2] = NFSATTRBIT_WCCATTR2; \
427 } while (0)
428
429 #define NFSWRITEGETATTR_ATTRBIT(b) do { \
430 (b)->bits[0] = NFSATTRBIT_WRITEGETATTR0; \
431 (b)->bits[1] = NFSATTRBIT_WRITEGETATTR1; \
432 (b)->bits[2] = NFSATTRBIT_WRITEGETATTR2; \
433 } while (0)
434
435 #define NFSCBGETATTR_ATTRBIT(b, c) do { \
436 (c)->bits[0] = ((b)->bits[0] & NFSATTRBIT_CBGETATTR0); \
437 (c)->bits[1] = ((b)->bits[1] & NFSATTRBIT_CBGETATTR1); \
438 (c)->bits[2] = ((b)->bits[2] & NFSATTRBIT_CBGETATTR2); \
439 } while (0)
440
441 #define NFSPATHCONF_GETATTRBIT(b) do { \
442 (b)->bits[0] = NFSGETATTRBIT_PATHCONF0; \
443 (b)->bits[1] = NFSGETATTRBIT_PATHCONF1; \
444 (b)->bits[2] = NFSGETATTRBIT_PATHCONF2; \
445 } while (0)
446
447 #define NFSSTATFS_GETATTRBIT(b) do { \
448 (b)->bits[0] = NFSGETATTRBIT_STATFS0; \
449 (b)->bits[1] = NFSGETATTRBIT_STATFS1; \
450 (b)->bits[2] = NFSGETATTRBIT_STATFS2; \
451 } while (0)
452
453 #define NFSISSETSTATFS_ATTRBIT(b) \
454 (((b)->bits[0] & NFSATTRBIT_STATFS0) || \
455 ((b)->bits[1] & NFSATTRBIT_STATFS1) || \
456 ((b)->bits[2] & NFSATTRBIT_STATFS2))
457
458 #define NFSCLRSTATFS_ATTRBIT(b) do { \
459 (b)->bits[0] &= ~NFSATTRBIT_STATFS0; \
460 (b)->bits[1] &= ~NFSATTRBIT_STATFS1; \
461 (b)->bits[2] &= ~NFSATTRBIT_STATFS2; \
462 } while (0)
463
464 #define NFSREADDIRPLUS_ATTRBIT(b) do { \
465 (b)->bits[0] = NFSATTRBIT_READDIRPLUS0; \
466 (b)->bits[1] = NFSATTRBIT_READDIRPLUS1; \
467 (b)->bits[2] = NFSATTRBIT_READDIRPLUS2; \
468 } while (0)
469
470 #define NFSREFERRAL_ATTRBIT(b) do { \
471 (b)->bits[0] = NFSATTRBIT_REFERRAL0; \
472 (b)->bits[1] = NFSATTRBIT_REFERRAL1; \
473 (b)->bits[2] = NFSATTRBIT_REFERRAL2; \
474 } while (0)
475
476 /*
477 * Store uid, gid creds that were used when the stateid was acquired.
478 * The RPC layer allows NFS_MAXGRPS + 1 groups to go out on the wire,
479 * so that's how many gets stored here.
480 */
481 struct nfscred {
482 uid_t nfsc_uid;
483 gid_t nfsc_groups[NFS_MAXGRPS + 1];
484 int nfsc_ngroups;
485 };
486
487 /*
488 * Constants that define the file handle for the V4 root directory.
489 * (The FSID must never be used by other file systems that are exported.)
490 */
491 #define NFSV4ROOT_FSID0 ((int32_t) -1)
492 #define NFSV4ROOT_FSID1 ((int32_t) -1)
493 #define NFSV4ROOT_REFERRAL ((int32_t) -2)
494 #define NFSV4ROOT_INO 2 /* It's traditional */
495 #define NFSV4ROOT_GEN 1
496
497 /*
498 * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts.
499 * What should be in this set is open to debate, but I believe that since
500 * I/O system calls on ufs are never interrupted by signals the set should
501 * be minimal. My reasoning is that many current programs that use signals
502 * such as SIGALRM will not expect file I/O system calls to be interrupted
503 * by them and break.
504 */
505 #if defined(_KERNEL) || defined(KERNEL)
506
507 struct uio; struct buf; struct vattr; struct nameidata; /* XXX */
508
509 /*
510 * Socket errors ignored for connectionless sockets?
511 * For now, ignore them all
512 */
513 #define NFSIGNORE_SOERROR(s, e) \
514 ((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \
515 ((s) & PR_CONNREQUIRED) == 0)
516
517
518 /*
519 * This structure holds socket information for a connection. Used by the
520 * client and the server for callbacks.
521 */
522 struct nfssockreq {
523 NFSSOCKADDR_T nr_nam;
524 int nr_sotype;
525 int nr_soproto;
526 int nr_soflags;
527 struct ucred *nr_cred;
528 int nr_lock;
529 NFSMUTEX_T nr_mtx;
530 u_int32_t nr_prog;
531 u_int32_t nr_vers;
532 struct __rpc_client *nr_client;
533 AUTH *nr_auth;
534 };
535
536 /*
537 * And associated nr_lock bits.
538 */
539 #define NFSR_SNDLOCK 0x01
540 #define NFSR_WANTSND 0x02
541 #define NFSR_RCVLOCK 0x04
542 #define NFSR_WANTRCV 0x08
543 #define NFSR_RESERVEDPORT 0x10
544 #define NFSR_LOCALHOST 0x20
545
546 /*
547 * Queue head for nfsreq's
548 */
549 TAILQ_HEAD(nfsreqhead, nfsreq);
550
551 /* This is the only nfsreq R_xxx flag still used. */
552 #define R_DONTRECOVER 0x00000100 /* don't initiate recovery when this
553 rpc gets a stale state reply */
554
555 /*
556 * Network address hash list element
557 */
558 union nethostaddr {
559 struct in_addr had_inet;
560 struct in6_addr had_inet6;
561 };
562
563 /*
564 * Structure of list of mechanisms.
565 */
566 struct nfsgss_mechlist {
567 int len;
568 const u_char *str;
569 int totlen;
570 };
571 #define KERBV_MECH 0 /* position in list */
572
573 /*
574 * This structure is used by the server for describing each request.
575 */
576 struct nfsrv_descript {
577 mbuf_t nd_mrep; /* Request mbuf list */
578 mbuf_t nd_md; /* Current dissect mbuf */
579 mbuf_t nd_mreq; /* Reply mbuf list */
580 mbuf_t nd_mb; /* Current build mbuf */
581 NFSSOCKADDR_T nd_nam; /* and socket addr */
582 NFSSOCKADDR_T nd_nam2; /* return socket addr */
583 caddr_t nd_dpos; /* Current dissect pos */
584 caddr_t nd_bpos; /* Current build pos */
585 u_int16_t nd_procnum; /* RPC # */
586 u_int32_t nd_flag; /* nd_flag */
587 u_int32_t nd_repstat; /* Reply status */
588 int *nd_errp; /* Pointer to ret status */
589 u_int32_t nd_retxid; /* Reply xid */
590 struct nfsrvcache *nd_rp; /* Assoc. cache entry */
591 fhandle_t nd_fh; /* File handle */
592 struct ucred *nd_cred; /* Credentials */
593 uid_t nd_saveduid; /* Saved uid */
594 u_int64_t nd_sockref; /* Rcv socket ref# */
595 u_int64_t nd_compref; /* Compound RPC ref# */
596 time_t nd_tcpconntime; /* Time TCP connection est. */
597 nfsquad_t nd_clientid; /* Implied clientid */
598 int nd_gssnamelen; /* principal name length */
599 char *nd_gssname; /* principal name */
600 uint32_t *nd_slotseq; /* ptr to slot seq# in req */
601 uint8_t nd_sessionid[NFSX_V4SESSIONID]; /* Session id */
602 uint32_t nd_slotid; /* Slotid for this RPC */
603 SVCXPRT *nd_xprt; /* Server RPC handle */
604 };
605
606 #define nd_princlen nd_gssnamelen
607 #define nd_principal nd_gssname
608
609 /* Bits for "nd_flag" */
610 #define ND_DONTSAVEREPLY 0x00000001
611 #define ND_SAVEREPLY 0x00000002
612 #define ND_NFSV2 0x00000004
613 #define ND_NFSV3 0x00000008
614 #define ND_NFSV4 0x00000010
615 #define ND_KERBV 0x00000020
616 #define ND_GSSINTEGRITY 0x00000040
617 #define ND_GSSPRIVACY 0x00000080
618 #define ND_WINDOWVERF 0x00000100
619 #define ND_GSSINITREPLY 0x00000200
620 #define ND_STREAMSOCK 0x00000400
621 #define ND_PUBLOOKUP 0x00000800
622 #define ND_USEGSSNAME 0x00001000
623 #define ND_SAMETCPCONN 0x00002000
624 #define ND_IMPLIEDCLID 0x00004000
625 #define ND_NOMOREDATA 0x00008000
626 #define ND_V4WCCATTR 0x00010000
627 #define ND_NFSCB 0x00020000
628 #define ND_AUTHNONE 0x00040000
629 #define ND_EXAUTHSYS 0x00080000
630 #define ND_EXGSS 0x00100000
631 #define ND_EXGSSINTEGRITY 0x00200000
632 #define ND_EXGSSPRIVACY 0x00400000
633 #define ND_INCRSEQID 0x00800000
634 #define ND_NFSCL 0x01000000
635 #define ND_NFSV41 0x02000000
636 #define ND_HASSEQUENCE 0x04000000
637 #define ND_CACHETHIS 0x08000000
638 #define ND_LASTOP 0x10000000
639
640 /*
641 * ND_GSS should be the "or" of all GSS type authentications.
642 */
643 #define ND_GSS (ND_KERBV)
644
645 struct nfsv4_opflag {
646 int retfh;
647 int needscfh;
648 int savereply;
649 int modifyfs;
650 int lktype;
651 int needsseq;
652 };
653
654 /*
655 * Flags used to indicate what to do w.r.t. seqid checking.
656 */
657 #define NFSRVSEQID_FIRST 0x01
658 #define NFSRVSEQID_LAST 0x02
659 #define NFSRVSEQID_OPEN 0x04
660
661 /*
662 * assign a doubly linked list to a new head
663 * and prepend one list into another.
664 */
665 #define LIST_NEWHEAD(nhead, ohead, field) do { \
666 if (((nhead)->lh_first = (ohead)->lh_first) != NULL) \
667 (ohead)->lh_first->field.le_prev = &(nhead)->lh_first; \
668 (ohead)->lh_first = NULL; \
669 } while (0)
670
671 #define LIST_PREPEND(head, phead, lelm, field) do { \
672 if ((head)->lh_first != NULL) { \
673 (lelm)->field.le_next = (head)->lh_first; \
674 (lelm)->field.le_next->field.le_prev = \
675 &(lelm)->field.le_next; \
676 } \
677 (head)->lh_first = (phead)->lh_first; \
678 (head)->lh_first->field.le_prev = &(head)->lh_first; \
679 } while (0)
680
681 /*
682 * File handle structure for client. Malloc'd to the correct length with
683 * malloc type M_NFSFH.
684 */
685 struct nfsfh {
686 u_int16_t nfh_len; /* Length of file handle */
687 u_int8_t nfh_fh[1]; /* and the file handle */
688 };
689
690 /*
691 * File handle structure for server. The NFSRV_MAXFH constant is
692 * set in nfsdport.h. I use a 32bit length, so that alignment is
693 * preserved.
694 */
695 struct nfsrvfh {
696 u_int32_t nfsrvfh_len;
697 u_int8_t nfsrvfh_data[NFSRV_MAXFH];
698 };
699
700 /*
701 * This structure is used for sleep locks on the NFSv4 nfsd threads and
702 * NFSv4 client data structures.
703 */
704 struct nfsv4lock {
705 u_int32_t nfslock_usecnt;
706 u_int8_t nfslock_lock;
707 };
708 #define NFSV4LOCK_LOCK 0x01
709 #define NFSV4LOCK_LOCKWANTED 0x02
710 #define NFSV4LOCK_WANTED 0x04
711
712 /*
713 * Values for the override argument for nfsvno_accchk().
714 */
715 #define NFSACCCHK_NOOVERRIDE 0
716 #define NFSACCCHK_ALLOWROOT 1
717 #define NFSACCCHK_ALLOWOWNER 2
718
719 /*
720 * and values for the vpislocked argument for nfsvno_accchk().
721 */
722 #define NFSACCCHK_VPNOTLOCKED 0
723 #define NFSACCCHK_VPISLOCKED 1
724
725 /*
726 * Slot for the NFSv4.1 Sequence Op.
727 */
728 struct nfsslot {
729 int nfssl_inprog;
730 uint32_t nfssl_seq;
731 struct mbuf *nfssl_reply;
732 };
733
734 #endif /* _KERNEL */
735
736 #endif /* _NFS_NFS_H */
Cache object: ffd0f905a9870c498058f6a391b6eb2e
|