1 /*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22 /*
23 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
24 */
25
26 /* Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T */
27 /* All Rights Reserved */
28
29 /*
30 * Copyright 2018 Nexenta Systems, Inc.
31 * Copyright (c) 2013 by Delphix. All rights reserved.
32 */
33
34 #ifndef _NFS_NFS_H
35 #define _NFS_NFS_H
36
37 #include <sys/isa_defs.h>
38 #include <sys/vfs.h>
39 #include <sys/stream.h>
40 #include <rpc/types.h>
41 #include <sys/types32.h>
42 #ifdef _KERNEL
43 #include <rpc/rpc_rdma.h>
44 #include <rpc/rpc.h>
45 #include <sys/fcntl.h>
46 #include <sys/kstat.h>
47 #include <sys/dirent.h>
48 #include <sys/zone.h>
49 #include <sys/tsol/label.h>
50 #include <sys/nvpair.h>
51 #include <nfs/mount.h>
52 #include <sys/vfs_opreg.h>
53 #endif
54 #include <vm/page.h>
55 #include <rpc/rpc_sztypes.h>
56 #include <sys/sysmacros.h>
57 #ifdef __cplusplus
58 extern "C" {
59 #endif
60
61 /*
62 * remote file service numbers
63 */
64 #define NFS_PROGRAM ((rpcprog_t)100003)
65 #define NFS_VERSMIN ((rpcvers_t)2)
66 #define NFS_VERSMAX ((rpcvers_t)4)
67 #define NFS_VERSION ((rpcvers_t)2)
68 #define NFS_PORT 2049
69
70 /*
71 * Used to determine registration and service handling of versions
72 */
73 #define NFS_VERSMIN_DEFAULT ((rpcvers_t)2)
74 #define NFS_VERSMAX_DEFAULT ((rpcvers_t)4)
75
76 /*
77 * Used to track the state of the server so that initialization
78 * can be done properly.
79 */
80 typedef enum {
81 NFS_SERVER_STOPPED, /* server state destroyed */
82 NFS_SERVER_STOPPING, /* server state being destroyed */
83 NFS_SERVER_RUNNING,
84 NFS_SERVER_QUIESCED, /* server state preserved */
85 NFS_SERVER_OFFLINE /* server pool offline */
86 } nfs_server_running_t;
87
88 /*
89 * Zone globals variables of NFS server
90 */
91 typedef struct nfs_globals {
92 rpcvers_t nfs_versmin;
93 rpcvers_t nfs_versmax;
94
95 /* NFS server locks and state */
96 nfs_server_running_t nfs_server_upordown;
97 kmutex_t nfs_server_upordown_lock;
98 kcondvar_t nfs_server_upordown_cv;
99
100 /* RDMA wait variables */
101 kcondvar_t rdma_wait_cv;
102 kmutex_t rdma_wait_mutex;
103 } nfs_globals_t;
104
105 /*
106 * Default delegation setting for the server ==> "on"
107 */
108 #define NFS_SERVER_DELEGATION_DEFAULT (TRUE)
109
110 /* Maximum size of data portion of a remote request */
111 #define NFS_MAXDATA 8192
112 #define NFS_MAXNAMLEN 255
113 #define NFS_MAXPATHLEN 1024
114
115 /*
116 * Rpc retransmission parameters
117 */
118 #define NFS_TIMEO 11 /* initial timeout for clts in 10th of a sec */
119 #define NFS_RETRIES 5 /* times to retry request */
120 #define NFS_COTS_TIMEO 600 /* initial timeout for cots in 10th of a sec */
121
122 /*
123 * The value of UID_NOBODY/GID_NOBODY presented to the world via NFS.
124 * UID_NOBODY/GID_NOBODY is translated to NFS_UID_NOBODY/NFS_GID_NOBODY
125 * when being sent out over the network and NFS_UID_NOBODY/NFS_GID_NOBODY
126 * is translated to UID_NOBODY/GID_NOBODY when received.
127 */
128 #define NFS_UID_NOBODY -2
129 #define NFS_GID_NOBODY -2
130
131 /*
132 * maximum transfer size for different interfaces
133 */
134 #define ECTSIZE 2048
135 #define IETSIZE 8192
136
137 /*
138 * WebNFS error status
139 */
140 enum wnfsstat {
141 WNFSERR_CLNT_FLAVOR = 20001 /* invalid client sec flavor */
142 };
143
144 /*
145 * Error status
146 * Should include all possible net errors.
147 * For now we just cast errno into an enum nfsstat.
148 */
149 enum nfsstat {
150 NFS_OK = 0, /* no error */
151 NFSERR_PERM = 1, /* Not owner */
152 NFSERR_NOENT = 2, /* No such file or directory */
153 NFSERR_IO = 5, /* I/O error */
154 NFSERR_NXIO = 6, /* No such device or address */
155 NFSERR_ACCES = 13, /* Permission denied */
156 NFSERR_EXIST = 17, /* File exists */
157 NFSERR_XDEV = 18, /* Cross-device link */
158 NFSERR_NODEV = 19, /* No such device */
159 NFSERR_NOTDIR = 20, /* Not a directory */
160 NFSERR_ISDIR = 21, /* Is a directory */
161 NFSERR_INVAL = 22, /* Invalid argument */
162 NFSERR_FBIG = 27, /* File too large */
163 NFSERR_NOSPC = 28, /* No space left on device */
164 NFSERR_ROFS = 30, /* Read-only file system */
165 NFSERR_OPNOTSUPP = 45, /* Operation not supported */
166 NFSERR_NAMETOOLONG = 63, /* File name too long */
167 NFSERR_NOTEMPTY = 66, /* Directory not empty */
168 NFSERR_DQUOT = 69, /* Disc quota exceeded */
169 NFSERR_STALE = 70, /* Stale NFS file handle */
170 NFSERR_REMOTE = 71, /* Object is remote */
171 NFSERR_WFLUSH = 99 /* write cache flushed */
172 };
173
174 typedef enum nfsstat nfsstat;
175
176 /*
177 * File types
178 */
179 enum nfsftype {
180 NFNON,
181 NFREG, /* regular file */
182 NFDIR, /* directory */
183 NFBLK, /* block special */
184 NFCHR, /* character special */
185 NFLNK, /* symbolic link */
186 NFSOC /* socket */
187 };
188
189 /*
190 * Macros for converting device numbers to and from the format
191 * SunOS 4.x used. SVR4 uses 14 bit majors and 18 bits minors,
192 * SunOS 4.x used 8 bit majors and 8 bit minors. It isn't sufficient
193 * to use the cmpdev() and expdev() macros because they only compress
194 * 7 bit (and smaller) majors. We must compress 8 bit majors too.
195 * If the major or minor exceeds 8 bits, then we send it out in
196 * full 32 bit format and hope that the peer can deal with it.
197 */
198
199 #define SO4_BITSMAJOR 8 /* # of SunOS 4.x major device bits */
200 #define SO4_BITSMINOR 8 /* # of SunOS 4.x minor device bits */
201 #define SO4_MAXMAJ 0xff /* SunOS 4.x max major value */
202 #define SO4_MAXMIN 0xff /* SunOS 4.x max minor value */
203
204 /*
205 * Convert to over-the-wire device number format
206 */
207 #define nfsv2_cmpdev(x) \
208 ((uint32_t) \
209 ((getmajor(x) > SO4_MAXMAJ || getminor(x) > SO4_MAXMIN) ? NODEV : \
210 ((getmajor(x) << SO4_BITSMINOR) | (getminor(x) & SO4_MAXMIN))))
211
212 /*
213 * Convert from over-the-wire format to SVR4 device number format
214 */
215 #define nfsv2_expdev(x) \
216 makedevice((((x) >> SO4_BITSMINOR) & SO4_MAXMAJ), (x) & SO4_MAXMIN)
217
218 /*
219 * Special kludge for fifos (named pipes) [to adhere to NFS Protocol Spec]
220 *
221 * VFIFO is not in the protocol spec (VNON will be replaced by VFIFO)
222 * so the over-the-wire representation is VCHR with a '-1' device number.
223 *
224 * NOTE: This kludge becomes unnecessary with the Protocol Revision,
225 * but it may be necessary to support it (backwards compatibility).
226 */
227 #define NFS_FIFO_TYPE NFCHR
228 #define NFS_FIFO_MODE S_IFCHR
229 #define NFS_FIFO_DEV ((uint32_t)-1)
230
231 /* identify fifo in nfs attributes */
232 #define NA_ISFIFO(NA) (((NA)->na_type == NFS_FIFO_TYPE) && \
233 ((NA)->na_rdev == NFS_FIFO_DEV))
234
235 /* set fifo in nfs attributes */
236 #define NA_SETFIFO(NA) { \
237 (NA)->na_type = NFS_FIFO_TYPE; \
238 (NA)->na_rdev = NFS_FIFO_DEV; \
239 (NA)->na_mode = ((NA)->na_mode & ~S_IFMT) | NFS_FIFO_MODE; \
240 }
241
242 /*
243 * Check for time overflow using a kernel tunable to determine whether
244 * we should accept or reject an unsigned 32-bit time value. Time value in NFS
245 * v2/3 protocol is unsigned 32 bit, but ILP32 kernel only allows 31 bits.
246 * In nfsv4, time value is a signed 64 bit, so needs to be checked for
247 * overflow as well (e.g. for setattr). So define the tunable as follows:
248 * nfs_allow_preepoch_time is TRUE if pre-epoch (negative) times are allowed
249 * and is FALSE (the default) otherwise. For nfsv2/3 this means that
250 * if negative times are allowed, the uint32_t time value is interpreted
251 * as a signed int, otherwise as a large positive number. For nfsv4,
252 * we use the value as is - except that if negative times are not allowed,
253 * we will not accept a negative value otw.
254 *
255 * So for nfsv2/3 (uint32_t):
256 *
257 * If nfs_allow_preepoch_time is
258 * FALSE, the maximum time value is INT32_MAX for 32-bit kernels and
259 * UINT32_MAX for 64-bit kernels (to allow times larger than 2038)
260 * and the minimum is zero. Note that in that case, a 32-bit application
261 * running on a 64-bit kernel will not be able to access files with
262 * the larger time values.
263 * If nfs_allow_preepoch_time is TRUE, the maximum time value is INT32_MAX
264 * for both kernel configurations and the minimum is INT32_MIN.
265 *
266 * And for nfsv4 (int64_t):
267 *
268 * nfsv4 allows for negative values in the protocol, and has a 64-bit
269 * time field, so nfs_allow_preepoch_time can be ignored.
270 */
271 #ifdef _KERNEL
272
273 extern volatile bool_t nfs_allow_preepoch_time;
274
275 #ifdef _LP64
276
277 /*
278 * If no negative otw values are allowed, may use the full 32-bits of the
279 * time to represent time later than 2038, by presenting the value as an
280 * unsigned (but this can only be used by 64-bit apps due to cstat32
281 * restrictions). If negative values are allowed, cannot represent times
282 * after 2038. Either way, all 32 bits have a valid representation.
283 */
284
285 /* Check if nfstime4 seconds (int64_t) can be stored in the system time */
286 #define NFS4_TIME_OK(tt) TRUE
287
288
289 #define NFS3_TIME_OVERFLOW(tt) (FALSE)
290 #define NFS2_TIME_OVERFLOW(tt) (FALSE)
291
292 /*
293 * check if a time_t (int64_t) is ok when preepoch times are allowed -
294 * nfsv2/3: every 32-bit value is accepted, but can't overflow 64->32.
295 * nfsv4: every value is valid.
296 */
297 #define NFS_PREEPOCH_TIME_T_OK(tt) \
298 (((tt) >= (time_t)INT32_MIN) && ((tt) <= (time_t)INT32_MAX))
299
300 /*
301 * check if a time_t (int64_t) is ok when preepoch times are not allowed -
302 * nfsv2/3: every positive 32-bit value is accepted, but can't overflow 64->32.
303 * nfsv4: every value is valid.
304 */
305 #define NFS_NO_PREEPOCH_TIME_T_OK(tt) \
306 (((tt) >= 0) && ((tt) <= (time_t)(ulong_t)UINT32_MAX))
307
308 #else /* not _LP64 */
309
310 /*
311 * Cannot represent times after 2038 in a 32-bit kernel, but we may wish to
312 * restrict the use of negative values (which violate the protocol).
313 * So if negative times allowed, all uint32 time values are valid. Otherwise
314 * only those which are less than INT32_MAX (msb=0).
315 *
316 * NFSv4 uses int64_t for the time, so in a 32-bit kernel the nfsv4 value
317 * must fit in an int32_t.
318 */
319
320 /* Only allow signed 32-bit time values */
321
322 /* Check if an nfstime4 (int64_t) can be stored in the system time */
323 #define NFS4_TIME_OK(tt) \
324 (((tt) <= INT32_MAX) && ((tt) >= INT32_MIN))
325
326 #define NFS3_TIME_OVERFLOW(tt) ((tt) > INT32_MAX)
327 #define NFS2_TIME_OVERFLOW(tt) ((tt) > INT32_MAX)
328
329 /*
330 * check if a time_t (int32_t) is ok when preepoch times are allowed -
331 * every 32-bit value is accepted
332 */
333 #define NFS_PREEPOCH_TIME_T_OK(tt) TRUE
334
335 /*
336 * check if a time_t (int32_t) is ok when preepoch times are not allowed -
337 * only positive values are accepted.
338 */
339 #define NFS_NO_PREEPOCH_TIME_T_OK(tt) ((tt) >= 0)
340
341 #endif /* _LP64 */
342
343 /* Check if an nfstime3 (uint32_t) can be stored in the system time */
344 #define NFS3_TIME_OK(tt) \
345 (nfs_allow_preepoch_time || (!NFS3_TIME_OVERFLOW(tt)))
346
347 /* Check if an nfs2_timeval (uint32_t) can be stored in the system time. */
348 #define NFS2_TIME_OK(tt) \
349 (nfs_allow_preepoch_time || (!NFS2_TIME_OVERFLOW(tt)))
350
351 /*
352 * Test if time_t (signed long) can be sent over the wire - for v2/3 only if:
353 * 1. The time value can fit in a uint32_t; and
354 * 2. Either the time value is positive or allow preepoch times.
355 * No restrictions for nfsv4.
356 */
357 #define NFS_TIME_T_OK(tt) \
358 (nfs_allow_preepoch_time ? \
359 NFS_PREEPOCH_TIME_T_OK(tt) : NFS_NO_PREEPOCH_TIME_T_OK(tt))
360
361 #define NFS4_TIME_T_OK(tt) TRUE
362
363 /* Test if all attr times are valid */
364 #define NFS_VAP_TIME_OK(vap) \
365 (nfs_allow_preepoch_time ? \
366 (NFS_PREEPOCH_TIME_T_OK((vap)->va_atime.tv_sec) && \
367 NFS_PREEPOCH_TIME_T_OK((vap)->va_mtime.tv_sec) && \
368 NFS_PREEPOCH_TIME_T_OK((vap)->va_ctime.tv_sec)) : \
369 (NFS_NO_PREEPOCH_TIME_T_OK((vap)->va_atime.tv_sec) && \
370 NFS_NO_PREEPOCH_TIME_T_OK((vap)->va_mtime.tv_sec) && \
371 NFS_NO_PREEPOCH_TIME_T_OK((vap)->va_ctime.tv_sec)))
372
373 #define NFS4_VAP_TIME_OK(vap) TRUE
374
375 /*
376 * To extend the sign or not extend the sign, that is the question.
377 * Note: The correct way is to code a macro:
378 * #define NFS_TIME_T_CONVERT(tt) \
379 * (nfs_allow_preepoch_time ? (int32_t)(tt) : (uint32_t)(tt))
380 * But the 64-bit compiler does not extend the sign in that case (why?)
381 * so we'll do it the ugly way...
382 */
383 #define NFS_TIME_T_CONVERT(systt, tt) \
384 if (nfs_allow_preepoch_time) { \
385 systt = (int32_t)(tt); \
386 } else { \
387 systt = (uint32_t)(tt); \
388 }
389
390 /* macro to check for overflowed time attribute fields - version 3 */
391 #define NFS3_FATTR_TIME_OK(attrs) \
392 (NFS3_TIME_OK((attrs)->atime.seconds) && \
393 NFS3_TIME_OK((attrs)->mtime.seconds) && \
394 NFS3_TIME_OK((attrs)->ctime.seconds))
395
396 /* macro to check for overflowed time attribute fields - version 2 */
397 #define NFS2_FATTR_TIME_OK(attrs) \
398 (NFS2_TIME_OK((attrs)->na_atime.tv_sec) && \
399 NFS2_TIME_OK((attrs)->na_mtime.tv_sec) && \
400 NFS2_TIME_OK((attrs)->na_ctime.tv_sec))
401
402 /* Check that a size3 value is not overflowed */
403 #define NFS3_SIZE_OK(size) ((size) <= MAXOFFSET_T)
404
405 #endif /* _KERNEL */
406
407 /*
408 * Size of an fhandle in bytes
409 */
410 #define NFS_FHSIZE 32
411
412 struct nfs_fid {
413 ushort_t nf_len;
414 ushort_t nf_pad;
415 char nf_data[NFS_FHSIZE];
416 };
417
418 /*
419 * "Legacy" filehandles use NFS_FHMAXDATA (10) byte fids. Filesystems that
420 * return a larger fid than NFS_FHMAXDATA, such as ZFS's .zfs snapshot
421 * directory, can use up to (((64 - 8) / 2) - 2) bytes for their fid.
422 * This currently holds for both NFSv3 and NFSv4.
423 */
424 #define NFS_FHMAXDATA 10
425 #define NFS_FH3MAXDATA 26
426 #define NFS_FH4MAXDATA 26
427
428 /*
429 * The original nfs file handle size for version 3 was 32 which was
430 * the same in version 2; now we're making it bigger to to deal with
431 * ZFS snapshot FIDs.
432 *
433 * If the size of fhandle3_t changes or if Version 3 uses some other
434 * filehandle format, this constant may need to change.
435 */
436
437 #define NFS3_OLDFHSIZE 32
438 #define NFS3_MAXFHSIZE 64
439
440 /*
441 * This is the actual definition of a legacy filehandle. There is some
442 * dependence on this layout in NFS-related code, particularly in the
443 * user-level lock manager, so be careful about changing it.
444 *
445 * Currently only NFSv2 uses this structure.
446 */
447
448 typedef struct svcfh {
449 fsid_t fh_fsid; /* filesystem id */
450 ushort_t fh_len; /* file number length */
451 char fh_data[NFS_FHMAXDATA]; /* and data */
452 ushort_t fh_xlen; /* export file number length */
453 char fh_xdata[NFS_FHMAXDATA]; /* and data */
454 } fhandle_t;
455
456 /*
457 * This is the in-memory structure for an NFSv3 extended filehandle.
458 */
459 typedef struct {
460 fsid_t _fh3_fsid; /* filesystem id */
461 ushort_t _fh3_len; /* file number length */
462 char _fh3_data[NFS_FH3MAXDATA]; /* and data */
463 ushort_t _fh3_xlen; /* export file number length */
464 char _fh3_xdata[NFS_FH3MAXDATA]; /* and data */
465 } fhandle3_t;
466
467 /*
468 * This is the in-memory structure for an NFSv4 extended filehandle.
469 */
470 typedef struct {
471 fsid_t fhx_fsid; /* filesystem id */
472 ushort_t fhx_len; /* file number length */
473 char fhx_data[NFS_FH4MAXDATA]; /* and data */
474 ushort_t fhx_xlen; /* export file number length */
475 char fhx_xdata[NFS_FH4MAXDATA]; /* and data */
476 } fhandle4_t;
477
478 /*
479 * Arguments to remote write and writecache
480 */
481 /*
482 * The `over the wire' representation of the first four arguments.
483 */
484 struct otw_nfswriteargs {
485 fhandle_t otw_wa_fhandle;
486 uint32_t otw_wa_begoff;
487 uint32_t otw_wa_offset;
488 uint32_t otw_wa_totcount;
489 };
490
491 struct nfswriteargs {
492 struct otw_nfswriteargs *wa_args; /* ptr to the otw arguments */
493 struct otw_nfswriteargs wa_args_buf; /* space for otw arguments */
494 uint32_t wa_count;
495 char *wa_data; /* data to write (up to NFS_MAXDATA) */
496 mblk_t *wa_mblk; /* pointer to mblks containing data */
497 #ifdef _KERNEL
498 /* rdma related info */
499 struct clist *wa_rlist;
500 CONN *wa_conn;
501 #endif /* _KERNEL */
502 };
503 #define wa_fhandle wa_args->otw_wa_fhandle
504 #define wa_begoff wa_args->otw_wa_begoff
505 #define wa_offset wa_args->otw_wa_offset
506 #define wa_totcount wa_args->otw_wa_totcount
507
508 /*
509 * NFS timeval struct using unsigned int as specified in V2 protocol.
510 * tv_sec and tv_usec used to match existing code.
511 */
512 struct nfs2_timeval {
513 uint32_t tv_sec;
514 uint32_t tv_usec;
515 };
516 typedef struct nfs2_timeval nfs2_timeval;
517
518 /*
519 * File attributes
520 */
521 struct nfsfattr {
522 enum nfsftype na_type; /* file type */
523 uint32_t na_mode; /* protection mode bits */
524 uint32_t na_nlink; /* # hard links */
525 uint32_t na_uid; /* owner user id */
526 uint32_t na_gid; /* owner group id */
527 uint32_t na_size; /* file size in bytes */
528 uint32_t na_blocksize; /* preferred block size */
529 uint32_t na_rdev; /* special device # */
530 uint32_t na_blocks; /* Kb of disk used by file */
531 uint32_t na_fsid; /* device # */
532 uint32_t na_nodeid; /* inode # */
533 struct nfs2_timeval na_atime; /* time of last access */
534 struct nfs2_timeval na_mtime; /* time of last modification */
535 struct nfs2_timeval na_ctime; /* time of last change */
536 };
537
538 #define n2v_type(x) (NA_ISFIFO(x) ? VFIFO : nf_to_vt[(x)->na_type])
539 #define n2v_rdev(x) (NA_ISFIFO(x) ? 0 : (x)->na_rdev)
540
541 /*
542 * Arguments to remote read
543 */
544 struct nfsreadargs {
545 fhandle_t ra_fhandle; /* handle for file */
546 uint32_t ra_offset; /* byte offset in file */
547 uint32_t ra_count; /* immediate read count */
548 uint32_t ra_totcount; /* total read cnt (from this offset) */
549 #ifdef _KERNEL
550 /* used in rdma transports */
551 caddr_t ra_data; /* destination for read data */
552 struct clist *ra_wlist;
553 CONN *ra_conn;
554 #endif
555 };
556
557 /*
558 * Status OK portion of remote read reply
559 */
560 struct nfsrrok {
561 struct nfsfattr rrok_attr; /* attributes, need for pagin */
562 uint32_t rrok_count; /* bytes of data */
563 char *rrok_data; /* data (up to NFS_MAXDATA bytes) */
564 uint_t rrok_bufsize; /* size of kmem_alloc'd buffer */
565 mblk_t *rrok_mp; /* mblk_t contains data for reply */
566 #ifdef _KERNEL
567 uint_t rrok_wlist_len;
568 struct clist *rrok_wlist;
569 #endif
570 };
571
572 /*
573 * Reply from remote read
574 */
575 struct nfsrdresult {
576 nfsstat rr_status; /* status of read */
577 union {
578 struct nfsrrok rr_ok_u; /* attributes, need for pagin */
579 } rr_u;
580 };
581 #define rr_ok rr_u.rr_ok_u
582 #define rr_attr rr_u.rr_ok_u.rrok_attr
583 #define rr_count rr_u.rr_ok_u.rrok_count
584 #define rr_bufsize rr_u.rr_ok_u.rrok_bufsize
585 #define rr_data rr_u.rr_ok_u.rrok_data
586 #define rr_mp rr_u.rr_ok_u.rrok_mp
587
588 /*
589 * File attributes which can be set
590 */
591 struct nfssattr {
592 uint32_t sa_mode; /* protection mode bits */
593 uint32_t sa_uid; /* owner user id */
594 uint32_t sa_gid; /* owner group id */
595 uint32_t sa_size; /* file size in bytes */
596 struct nfs2_timeval sa_atime; /* time of last access */
597 struct nfs2_timeval sa_mtime; /* time of last modification */
598 };
599
600
601 /*
602 * Reply status with file attributes
603 */
604 struct nfsattrstat {
605 nfsstat ns_status; /* reply status */
606 union {
607 struct nfsfattr ns_attr_u; /* NFS_OK: file attributes */
608 } ns_u;
609 };
610 #define ns_attr ns_u.ns_attr_u
611
612
613 /*
614 * NFS_OK part of read sym link reply union
615 */
616 struct nfssrok {
617 uint32_t srok_count; /* size of string */
618 char *srok_data; /* string (up to NFS_MAXPATHLEN bytes) */
619 };
620
621 /*
622 * Result of reading symbolic link
623 */
624 struct nfsrdlnres {
625 nfsstat rl_status; /* status of symlink read */
626 union {
627 struct nfssrok rl_srok_u; /* name of linked to */
628 } rl_u;
629 };
630 #define rl_srok rl_u.rl_srok_u
631 #define rl_count rl_u.rl_srok_u.srok_count
632 #define rl_data rl_u.rl_srok_u.srok_data
633
634
635 /*
636 * Arguments to readdir
637 */
638 struct nfsrddirargs {
639 fhandle_t rda_fh; /* directory handle */
640 uint32_t rda_offset; /* offset in directory (opaque) */
641 uint32_t rda_count; /* number of directory bytes to read */
642 };
643
644 /*
645 * Entry structure
646 */
647 struct nfsentry {
648 uint32_t fileid;
649 char *name;
650 uint32_t cookie;
651 struct nfsentry *nextentry;
652 };
653
654 /*
655 * NFS_OK part of readdir result
656 */
657 struct nfsrdok {
658 struct nfsentry *rdok_entries; /* variable number of entries */
659 bool_t rdok_eof; /* true if last entry is in result */
660
661 uint32_t rdok_offset; /* next offset (opaque) */
662 uint32_t rdok_size; /* size in bytes of entries */
663 struct dirent64 *rdok_dirents; /* variable number of entries */
664 };
665
666 /*
667 * Readdir result
668 */
669 struct nfsrddirres {
670 nfsstat rd_status;
671 union {
672 struct nfsrdok rd_rdok_u;
673 } rd_u;
674 };
675 #define rd_rdok rd_u.rd_rdok_u
676 #define rd_entries rd_u.rd_rdok_u.rdok_entries
677 #define rd_eof rd_u.rd_rdok_u.rdok_eof
678
679 #define rd_offset rd_u.rd_rdok_u.rdok_offset
680 #define rd_size rd_u.rd_rdok_u.rdok_size
681 #define rd_dirents rd_u.rd_rdok_u.rdok_dirents
682
683
684 /*
685 * Arguments for directory operations
686 */
687 struct nfsdiropargs {
688 fhandle_t *da_fhandle; /* pointer to directory file handle */
689 char *da_name; /* name (up to NFS_MAXNAMLEN bytes) */
690 fhandle_t da_fhandle_buf; /* directory file handle */
691 int da_flags; /* flags, see below */
692 };
693 #define DA_FREENAME 1
694
695 /*
696 * NFS_OK part of directory operation result
697 */
698 struct nfsdrok {
699 fhandle_t drok_fhandle; /* result file handle */
700 struct nfsfattr drok_attr; /* result file attributes */
701 };
702
703 /*
704 * Results from directory operation
705 */
706 struct nfsdiropres {
707 nfsstat dr_status; /* result status */
708 union {
709 struct nfsdrok dr_drok_u; /* NFS_OK result */
710 } dr_u;
711 };
712 #define dr_drok dr_u.dr_drok_u
713 #define dr_fhandle dr_u.dr_drok_u.drok_fhandle
714 #define dr_attr dr_u.dr_drok_u.drok_attr
715
716 /*
717 * arguments to setattr
718 */
719 struct nfssaargs {
720 fhandle_t saa_fh; /* fhandle of file to be set */
721 struct nfssattr saa_sa; /* new attributes */
722 };
723
724 /*
725 * arguments to create and mkdir
726 */
727 struct nfscreatargs {
728 struct nfsdiropargs ca_da; /* file name to create and parent dir */
729 struct nfssattr *ca_sa; /* initial attributes */
730 struct nfssattr ca_sa_buf; /* space to store attributes */
731 };
732
733 /*
734 * arguments to link
735 */
736 struct nfslinkargs {
737 fhandle_t *la_from; /* old file */
738 fhandle_t la_from_buf; /* old file */
739 struct nfsdiropargs la_to; /* new file and parent dir */
740 };
741
742 /*
743 * arguments to rename
744 */
745 struct nfsrnmargs {
746 struct nfsdiropargs rna_from; /* old file and parent dir */
747 struct nfsdiropargs rna_to; /* new file and parent dir */
748 };
749
750 /*
751 * arguments to symlink
752 */
753 struct nfsslargs {
754 struct nfsdiropargs sla_from; /* old file and parent dir */
755 char *sla_tnm; /* new name */
756 int sla_tnm_flags; /* flags for name */
757 struct nfssattr *sla_sa; /* attributes */
758 struct nfssattr sla_sa_buf; /* attributes buffer */
759 };
760 #define SLA_FREETNM 1
761
762 /*
763 * NFS_OK part of statfs operation
764 */
765 struct nfsstatfsok {
766 uint32_t fsok_tsize; /* preferred transfer size in bytes */
767 uint32_t fsok_bsize; /* fundamental file system block size */
768 uint32_t fsok_blocks; /* total blocks in file system */
769 uint32_t fsok_bfree; /* free blocks in fs */
770 uint32_t fsok_bavail; /* free blocks avail to non-superuser */
771 };
772
773 /*
774 * Results of statfs operation
775 */
776 struct nfsstatfs {
777 nfsstat fs_status; /* result status */
778 union {
779 struct nfsstatfsok fs_fsok_u; /* NFS_OK result */
780 } fs_u;
781 };
782 #define fs_fsok fs_u.fs_fsok_u
783 #define fs_tsize fs_u.fs_fsok_u.fsok_tsize
784 #define fs_bsize fs_u.fs_fsok_u.fsok_bsize
785 #define fs_blocks fs_u.fs_fsok_u.fsok_blocks
786 #define fs_bfree fs_u.fs_fsok_u.fsok_bfree
787 #define fs_bavail fs_u.fs_fsok_u.fsok_bavail
788
789 #ifdef _KERNEL
790 /*
791 * XDR routines for handling structures defined above
792 */
793 extern bool_t xdr_attrstat(XDR *, struct nfsattrstat *);
794 extern bool_t xdr_fastattrstat(XDR *, struct nfsattrstat *);
795 extern bool_t xdr_creatargs(XDR *, struct nfscreatargs *);
796 extern bool_t xdr_diropargs(XDR *, struct nfsdiropargs *);
797 extern bool_t xdr_diropres(XDR *, struct nfsdiropres *);
798 extern bool_t xdr_fastdiropres(XDR *, struct nfsdiropres *);
799 extern bool_t xdr_drok(XDR *, struct nfsdrok *);
800 #ifdef _LITTLE_ENDIAN
801 extern bool_t xdr_fastdrok(XDR *, struct nfsdrok *);
802 extern bool_t xdr_fastfattr(XDR *, struct nfsfattr *);
803 #endif
804 extern bool_t xdr_fattr(XDR *, struct nfsfattr *);
805 extern bool_t xdr_fhandle(XDR *, fhandle_t *);
806 extern bool_t xdr_fastfhandle(XDR *, fhandle_t **);
807 extern bool_t xdr_linkargs(XDR *, struct nfslinkargs *);
808 extern bool_t xdr_rddirargs(XDR *, struct nfsrddirargs *);
809 extern bool_t xdr_putrddirres(XDR *, struct nfsrddirres *);
810 extern bool_t xdr_getrddirres(XDR *, struct nfsrddirres *);
811 extern bool_t xdr_rdlnres(XDR *, struct nfsrdlnres *);
812 extern bool_t xdr_rdresult(XDR *, struct nfsrdresult *);
813 extern bool_t xdr_readargs(XDR *, struct nfsreadargs *);
814 extern bool_t xdr_readlink(XDR *, fhandle_t *);
815 extern bool_t xdr_rnmargs(XDR *, struct nfsrnmargs *);
816 extern bool_t xdr_rrok(XDR *, struct nfsrrok *);
817 extern bool_t xdr_saargs(XDR *, struct nfssaargs *);
818 extern bool_t xdr_sattr(XDR *, struct nfssattr *);
819 extern bool_t xdr_slargs(XDR *, struct nfsslargs *);
820 extern bool_t xdr_srok(XDR *, struct nfssrok *);
821 extern bool_t xdr_nfs2_timeval(XDR *, struct nfs2_timeval *);
822 extern bool_t xdr_writeargs(XDR *, struct nfswriteargs *);
823 extern bool_t xdr_fsok(XDR *, struct nfsstatfsok *);
824 #ifdef _LITTLE_ENDIAN
825 extern bool_t xdr_fastfsok(XDR *, struct nfsstatfsok *);
826 extern bool_t xdr_fastenum(XDR *, enum_t *);
827 #endif
828 extern bool_t xdr_statfs(XDR *, struct nfsstatfs *);
829 extern bool_t xdr_faststatfs(XDR *, struct nfsstatfs *);
830 #endif
831
832 /*
833 * Remote file service routines
834 */
835 #define RFS_NULL 0
836 #define RFS_GETATTR 1
837 #define RFS_SETATTR 2
838 #define RFS_ROOT 3
839 #define RFS_LOOKUP 4
840 #define RFS_READLINK 5
841 #define RFS_READ 6
842 #define RFS_WRITECACHE 7
843 #define RFS_WRITE 8
844 #define RFS_CREATE 9
845 #define RFS_REMOVE 10
846 #define RFS_RENAME 11
847 #define RFS_LINK 12
848 #define RFS_SYMLINK 13
849 #define RFS_MKDIR 14
850 #define RFS_RMDIR 15
851 #define RFS_READDIR 16
852 #define RFS_STATFS 17
853 #define RFS_NPROC 18
854
855 #ifdef _KERNEL
856 /*
857 * The NFS Version 2 service procedures
858 */
859 struct exportinfo; /* defined in nfs/export.h */
860 struct servinfo; /* defined in nfs/nfs_clnt.h */
861 struct mntinfo; /* defined in nfs/nfs_clnt.h */
862
863 extern void rfs_getattr(fhandle_t *, struct nfsattrstat *,
864 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
865 extern void *rfs_getattr_getfh(fhandle_t *);
866 extern void rfs_setattr(struct nfssaargs *, struct nfsattrstat *,
867 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
868 extern void *rfs_setattr_getfh(struct nfssaargs *);
869 extern void rfs_lookup(struct nfsdiropargs *, struct nfsdiropres *,
870 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
871 extern void *rfs_lookup_getfh(struct nfsdiropargs *);
872 extern void rfs_readlink(fhandle_t *, struct nfsrdlnres *,
873 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
874 extern void *rfs_readlink_getfh(fhandle_t *);
875 extern void rfs_rlfree(struct nfsrdlnres *);
876 extern void rfs_read(struct nfsreadargs *, struct nfsrdresult *,
877 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
878 extern void *rfs_read_getfh(struct nfsreadargs *);
879 extern void rfs_rdfree(struct nfsrdresult *);
880 extern void rfs_write_sync(struct nfswriteargs *, struct nfsattrstat *,
881 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
882 extern void rfs_write(struct nfswriteargs *, struct nfsattrstat *,
883 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
884 extern void *rfs_write_getfh(struct nfswriteargs *);
885 extern void rfs_create(struct nfscreatargs *, struct nfsdiropres *,
886 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
887 extern void *rfs_create_getfh(struct nfscreatargs *);
888 extern void rfs_remove(struct nfsdiropargs *, enum nfsstat *,
889 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
890 extern void *rfs_remove_getfh(struct nfsdiropargs *);
891 extern void rfs_rename(struct nfsrnmargs *, enum nfsstat *,
892 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
893 extern void *rfs_rename_getfh(struct nfsrnmargs *);
894 extern void rfs_link(struct nfslinkargs *, enum nfsstat *,
895 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
896 extern void *rfs_link_getfh(struct nfslinkargs *);
897 extern void rfs_symlink(struct nfsslargs *, enum nfsstat *,
898 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
899 extern void *rfs_symlink_getfh(struct nfsslargs *);
900 extern void rfs_mkdir(struct nfscreatargs *, struct nfsdiropres *,
901 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
902 extern void *rfs_mkdir_getfh(struct nfscreatargs *);
903 extern void rfs_rmdir(struct nfsdiropargs *, enum nfsstat *,
904 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
905 extern void *rfs_rmdir_getfh(struct nfsdiropargs *);
906 extern void rfs_readdir(struct nfsrddirargs *, struct nfsrddirres *,
907 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
908 extern void *rfs_readdir_getfh(struct nfsrddirargs *);
909 extern void rfs_rddirfree(struct nfsrddirres *);
910 extern void rfs_statfs(fhandle_t *, struct nfsstatfs *, struct exportinfo *,
911 struct svc_req *, cred_t *, bool_t);
912 extern void *rfs_statfs_getfh(fhandle_t *);
913 extern void rfs_srvrinit(void);
914 extern void rfs_srvrfini(void);
915
916 /*
917 * flags to define path types during Multi Component Lookups
918 * using the public filehandle
919 */
920 #define URLPATH 0x01 /* Universal Resource Locator path */
921 #define NATIVEPATH 0x02 /* Native path, i.e., via mount protocol */
922 #define SECURITY_QUERY 0x04 /* Security query */
923
924 /* index for svstat_ptr */
925 enum nfs_svccounts {NFS_CALLS, NFS_BADCALLS, NFS_REFERRALS, NFS_REFERLINKS};
926
927 /* function defs for NFS kernel */
928 extern int nfs_waitfor_purge_complete(vnode_t *);
929 extern int nfs_validate_caches(vnode_t *, cred_t *);
930 extern void nfs_purge_caches(vnode_t *, int, cred_t *);
931 extern void nfs_purge_rddir_cache(vnode_t *);
932 extern void nfs_attrcache(vnode_t *, struct nfsfattr *, hrtime_t);
933 extern int nfs_cache_fattr(vnode_t *, struct nfsfattr *, vattr_t *,
934 hrtime_t, cred_t *);
935 extern void nfs_attr_cache(vnode_t *, vattr_t *, hrtime_t, cred_t *);
936 extern void nfs_attrcache_va(vnode_t *, struct vattr *);
937 extern int nfs_getattr_otw(vnode_t *, struct vattr *, cred_t *);
938 extern int nfsgetattr(vnode_t *, struct vattr *, cred_t *);
939 extern int nattr_to_vattr(vnode_t *, struct nfsfattr *, struct vattr *);
940 extern void nfs_async_manager(struct vfs *);
941 extern void nfs_async_manager_stop(struct vfs *);
942 extern void nfs_async_stop(struct vfs *);
943 extern int nfs_async_stop_sig(struct vfs *);
944 extern int nfs_clntinit(void);
945 extern void nfs_clntfini(void);
946 extern int nfstsize(void);
947 extern void nfs_srvinit(void);
948 extern void nfs_srvfini(void);
949 extern int vattr_to_sattr(struct vattr *, struct nfssattr *);
950 extern void setdiropargs(struct nfsdiropargs *, char *, vnode_t *);
951 extern int setdirgid(vnode_t *, gid_t *, cred_t *);
952 extern int setdirmode(vnode_t *, mode_t *, cred_t *);
953 extern int newnum(void);
954 extern char *newname(void);
955 extern int nfs_subrinit(void);
956 extern void nfs_subrfini(void);
957 extern enum nfsstat puterrno(int);
958 extern int geterrno(enum nfsstat);
959 extern int nfsinit(int, char *);
960 extern void nfsfini(void);
961 extern int nfs_vfsinit(void);
962 extern void nfs_vfsfini(void);
963 extern int nfs_dump(vnode_t *, caddr_t, offset_t, offset_t,
964 caller_context_t *);
965 extern void nfs_perror(int, char *, ...);
966 extern void nfs_cmn_err(int, int, char *, ...);
967 extern int nfs_addcllock(vnode_t *, struct flock64 *);
968 extern void nfs_rmcllock(vnode_t *, struct flock64 *);
969 extern void nfs_lockrelease(vnode_t *, int, offset_t, cred_t *);
970 extern int vattr_to_nattr(struct vattr *, struct nfsfattr *);
971 extern int mount_root(char *, char *, int, struct nfs_args *, int *);
972 extern void nfs_lockcompletion(vnode_t *, int);
973 extern void nfs_add_locking_id(vnode_t *, pid_t, int, char *, int);
974 extern void nfs3copyfh(caddr_t, vnode_t *);
975 extern void nfscopyfh(caddr_t, vnode_t *);
976 extern int nfs3lookup(vnode_t *, char *, vnode_t **, struct pathname *,
977 int, vnode_t *, cred_t *, int);
978 extern int nfslookup(vnode_t *, char *, vnode_t **, struct pathname *, int,
979 vnode_t *, cred_t *, int);
980 extern void sv_free(struct servinfo *);
981 extern int nfsauth_access(struct exportinfo *, struct svc_req *, cred_t *,
982 uid_t *, gid_t *, uint_t *, gid_t **);
983 extern void nfsauth_init(void);
984 extern void nfsauth_fini(void);
985 extern int nfs_setopts(vnode_t *, model_t, struct nfs_args *);
986 extern int nfs_mount_label_policy(vfs_t *, struct netbuf *,
987 struct knetconfig *, cred_t *);
988 extern boolean_t nfs_has_ctty(void);
989 extern void nfs_srv_stop_all(void);
990 extern void nfs_srv_quiesce_all(void);
991 extern int rfs4_dss_setpaths(char *, size_t);
992 extern int nfs_setmod_check(page_t *);
993
994 extern time_t rfs4_lease_time;
995 extern time_t rfs4_grace_period;
996 extern nvlist_t *rfs4_dss_paths, *rfs4_dss_oldpaths;
997
998 extern kstat_named_t *global_svstat_ptr[];
999
1000 extern zone_key_t rfs4_zone_key;
1001 extern zone_key_t nfssrv_zone_key;
1002 extern krwlock_t rroklock;
1003 extern vtype_t nf_to_vt[];
1004 extern kstat_named_t *rfsproccnt_v2_ptr;
1005 extern kstat_t **rfsprocio_v2_ptr;
1006 extern kmutex_t nfs_minor_lock;
1007 extern int nfs_major;
1008 extern int nfs_minor;
1009 extern vfsops_t *nfs_vfsops;
1010 extern struct vnodeops *nfs_vnodeops;
1011 extern const struct fs_operation_def nfs_vnodeops_template[];
1012 extern int nfsfstyp;
1013 extern void (*nfs_srv_quiesce_func)(void);
1014 extern int (*nfs_srv_dss_func)(char *, size_t);
1015
1016 /*
1017 * Per-zone stats
1018 */
1019 struct nfs_version_stats {
1020 kstat_named_t *aclreqcnt_ptr; /* nfs_acl:0:aclreqcnt_v? */
1021 kstat_named_t *aclproccnt_ptr; /* nfs_acl:0:aclproccnt_v? */
1022 kstat_t **aclprocio_ptr; /* nfs_acl:0:aclprocio_v?_* */
1023 kmutex_t aclprocio_lock; /* protects aclprocio */
1024 kstat_named_t *rfsreqcnt_ptr; /* nfs:0:rfsreqcnt_v? */
1025 kstat_named_t *rfsproccnt_ptr; /* nfs:0:rfsproccnt_v? */
1026 kstat_t **rfsprocio_ptr; /* nfs:0:rfsprocio_v?_* */
1027 kmutex_t rfsprocio_lock; /* protects rfsprocio */
1028 };
1029
1030 /*
1031 * A bit of asymmetry: nfs:0:nfs_client isn't part of this structure.
1032 */
1033 struct nfs_stats {
1034 kstat_named_t *nfs_stats_svstat_ptr[NFS_VERSMAX + 1];
1035 struct nfs_version_stats nfs_stats_v2;
1036 struct nfs_version_stats nfs_stats_v3;
1037 struct nfs_version_stats nfs_stats_v4;
1038 };
1039
1040 /*
1041 * Key used to retrieve counters.
1042 */
1043 extern zone_key_t nfsstat_zone_key;
1044
1045 /*
1046 * Zone callback functions.
1047 */
1048 extern void *nfsstat_zone_init(zoneid_t);
1049 extern void nfsstat_zone_fini(zoneid_t, void *);
1050
1051 /*
1052 * Per-exportinfo stats
1053 */
1054 struct exp_kstats {
1055 kstat_t *share_kstat; /* Generic share kstat */
1056 struct {
1057 kstat_named_t path; /* Shared path */
1058 kstat_named_t filesystem; /* pseudo|real */
1059 } share_kstat_data; /* Generic share kstat data */
1060 char *share_path; /* Shared path string */
1061 kstat_t **rfsshr_v3_ptr; /* NFS v3 per share stats */
1062 kstat_t **rfsshr_v4_ptr; /* NFS v4 per share stats */
1063 kmutex_t procio_lock; /* protects all exp_kstats */
1064 };
1065
1066 extern struct exp_kstats *exp_kstats_init(zoneid_t, int, const char *, size_t,
1067 bool_t);
1068 extern void exp_kstats_delete(struct exp_kstats *);
1069 extern void exp_kstats_fini(struct exp_kstats *);
1070 extern void exp_kstats_reset(struct exp_kstats *, const char *, size_t, bool_t);
1071
1072 extern kstat_t *exp_kstats_v2(struct exp_kstats *, uint_t);
1073 extern kstat_t *exp_kstats_v3(struct exp_kstats *, uint_t);
1074 extern kstat_t *exp_kstats_v4(struct exp_kstats *, uint_t);
1075
1076 #endif /* _KERNEL */
1077
1078 /*
1079 * Version 3 declarations and definitions.
1080 */
1081
1082 #define NFS3_FHSIZE 64
1083 #define NFS3_COOKIEVERFSIZE 8
1084 #define NFS3_CREATEVERFSIZE 8
1085 #define NFS3_WRITEVERFSIZE 8
1086
1087 typedef char *filename3;
1088
1089 typedef char *nfspath3;
1090
1091 #define nfs3nametoolong ((char *)-1)
1092
1093 typedef uint64 fileid3;
1094
1095 typedef uint64 cookie3;
1096
1097 typedef uint32 uid3;
1098
1099 typedef uint32 gid3;
1100
1101 typedef uint64 size3;
1102
1103 typedef uint64 offset3;
1104
1105 typedef uint32 mode3;
1106
1107 typedef uint32 count3;
1108
1109 /*
1110 * These three are really opaque arrays, but we treat them as
1111 * uint64 for efficiency sake
1112 */
1113 typedef uint64 cookieverf3;
1114
1115 typedef uint64 createverf3;
1116
1117 typedef uint64 writeverf3;
1118
1119 typedef struct nfs_fh3 {
1120 uint_t fh3_length;
1121 union nfs_fh3_u {
1122 struct nfs_fh3_i {
1123 fhandle3_t fh3_i;
1124 } nfs_fh3_i;
1125 char data[NFS3_FHSIZE];
1126 } fh3_u;
1127 uint_t fh3_flags;
1128 } nfs_fh3;
1129 #define fh3_fsid fh3_u.nfs_fh3_i.fh3_i._fh3_fsid
1130 #define fh3_len fh3_u.nfs_fh3_i.fh3_i._fh3_len
1131 #define fh3_data fh3_u.nfs_fh3_i.fh3_i._fh3_data
1132 #define fh3_xlen fh3_u.nfs_fh3_i.fh3_i._fh3_xlen
1133 #define fh3_xdata fh3_u.nfs_fh3_i.fh3_i._fh3_xdata
1134 #define FH3TOFIDP(fh) ((fid_t *)&((fh)->fh3_len))
1135 #define FH3TOXFIDP(fh) ((fid_t *)&((fh)->fh3_xlen))
1136
1137 /*
1138 * nfs_fh3.fh3_flags values
1139 */
1140 #define FH_WEBNFS 0x1 /* fh is WebNFS overloaded - see makefh3_ol() */
1141
1142 /*
1143 * Two elements were added to the
1144 * diropargs3 structure for performance (xdr-inlining).
1145 * They are not included as part of the args
1146 * that are encoded or decoded:
1147 * dirp - ptr to the nfs_fh3
1148 * flag indicating when to free the name that was
1149 * allocated during decode.
1150 */
1151 struct diropargs3 {
1152 nfs_fh3 *dirp;
1153 nfs_fh3 dir;
1154 filename3 name;
1155 int flags;
1156 };
1157 typedef struct diropargs3 diropargs3;
1158
1159 struct nfstime3 {
1160 uint32 seconds;
1161 uint32 nseconds;
1162 };
1163 typedef struct nfstime3 nfstime3;
1164
1165 struct specdata3 {
1166 uint32 specdata1;
1167 uint32 specdata2;
1168 };
1169 typedef struct specdata3 specdata3;
1170
1171 enum nfsstat3 {
1172 NFS3_OK = 0,
1173 NFS3ERR_PERM = 1,
1174 NFS3ERR_NOENT = 2,
1175 NFS3ERR_IO = 5,
1176 NFS3ERR_NXIO = 6,
1177 NFS3ERR_ACCES = 13,
1178 NFS3ERR_EXIST = 17,
1179 NFS3ERR_XDEV = 18,
1180 NFS3ERR_NODEV = 19,
1181 NFS3ERR_NOTDIR = 20,
1182 NFS3ERR_ISDIR = 21,
1183 NFS3ERR_INVAL = 22,
1184 NFS3ERR_FBIG = 27,
1185 NFS3ERR_NOSPC = 28,
1186 NFS3ERR_ROFS = 30,
1187 NFS3ERR_MLINK = 31,
1188 NFS3ERR_NAMETOOLONG = 63,
1189 NFS3ERR_NOTEMPTY = 66,
1190 NFS3ERR_DQUOT = 69,
1191 NFS3ERR_STALE = 70,
1192 NFS3ERR_REMOTE = 71,
1193 NFS3ERR_BADHANDLE = 10001,
1194 NFS3ERR_NOT_SYNC = 10002,
1195 NFS3ERR_BAD_COOKIE = 10003,
1196 NFS3ERR_NOTSUPP = 10004,
1197 NFS3ERR_TOOSMALL = 10005,
1198 NFS3ERR_SERVERFAULT = 10006,
1199 NFS3ERR_BADTYPE = 10007,
1200 NFS3ERR_JUKEBOX = 10008
1201 };
1202 typedef enum nfsstat3 nfsstat3;
1203
1204 enum ftype3 {
1205 NF3REG = 1,
1206 NF3DIR = 2,
1207 NF3BLK = 3,
1208 NF3CHR = 4,
1209 NF3LNK = 5,
1210 NF3SOCK = 6,
1211 NF3FIFO = 7
1212 };
1213 typedef enum ftype3 ftype3;
1214
1215 struct fattr3 {
1216 ftype3 type;
1217 mode3 mode;
1218 uint32 nlink;
1219 uid3 uid;
1220 gid3 gid;
1221 size3 size;
1222 size3 used;
1223 specdata3 rdev;
1224 uint64 fsid;
1225 fileid3 fileid;
1226 nfstime3 atime;
1227 nfstime3 mtime;
1228 nfstime3 ctime;
1229 };
1230 typedef struct fattr3 fattr3;
1231
1232 #define NFS3_SIZEOF_FATTR3 (21)
1233
1234 #ifdef _KERNEL
1235 struct fattr3_res {
1236 nfsstat3 status;
1237 vattr_t *vap;
1238 vnode_t *vp;
1239 };
1240 typedef struct fattr3_res fattr3_res;
1241 #endif /* _KERNEL */
1242
1243 struct post_op_attr {
1244 bool_t attributes;
1245 fattr3 attr;
1246 };
1247 typedef struct post_op_attr post_op_attr;
1248
1249 #ifdef _KERNEL
1250 struct post_op_vattr {
1251 bool_t attributes;
1252 fattr3_res fres;
1253 };
1254 typedef struct post_op_vattr post_op_vattr;
1255 #endif /* _KERNEL */
1256
1257 struct wcc_attr {
1258 size3 size;
1259 nfstime3 mtime;
1260 nfstime3 ctime;
1261 };
1262 typedef struct wcc_attr wcc_attr;
1263
1264 struct pre_op_attr {
1265 bool_t attributes;
1266 wcc_attr attr;
1267 };
1268 typedef struct pre_op_attr pre_op_attr;
1269
1270 struct wcc_data {
1271 pre_op_attr before;
1272 post_op_attr after;
1273 };
1274 typedef struct wcc_data wcc_data;
1275
1276 struct post_op_fh3 {
1277 bool_t handle_follows;
1278 nfs_fh3 handle;
1279 };
1280 typedef struct post_op_fh3 post_op_fh3;
1281
1282 enum time_how {
1283 DONT_CHANGE = 0,
1284 SET_TO_SERVER_TIME = 1,
1285 SET_TO_CLIENT_TIME = 2
1286 };
1287 typedef enum time_how time_how;
1288
1289 struct set_mode3 {
1290 bool_t set_it;
1291 mode3 mode;
1292 };
1293 typedef struct set_mode3 set_mode3;
1294
1295 struct set_uid3 {
1296 bool_t set_it;
1297 uid3 uid;
1298 };
1299 typedef struct set_uid3 set_uid3;
1300
1301 struct set_gid3 {
1302 bool_t set_it;
1303 gid3 gid;
1304 };
1305 typedef struct set_gid3 set_gid3;
1306
1307 struct set_size3 {
1308 bool_t set_it;
1309 size3 size;
1310 };
1311 typedef struct set_size3 set_size3;
1312
1313 struct set_atime {
1314 time_how set_it;
1315 nfstime3 atime;
1316 };
1317 typedef struct set_atime set_atime;
1318
1319 struct set_mtime {
1320 time_how set_it;
1321 nfstime3 mtime;
1322 };
1323 typedef struct set_mtime set_mtime;
1324
1325 struct sattr3 {
1326 set_mode3 mode;
1327 set_uid3 uid;
1328 set_gid3 gid;
1329 set_size3 size;
1330 set_atime atime;
1331 set_mtime mtime;
1332 };
1333 typedef struct sattr3 sattr3;
1334
1335 /*
1336 * A couple of defines to make resok and resfail look like the
1337 * correct things in a response type independent manner.
1338 */
1339 #define resok res_u.ok
1340 #define resfail res_u.fail
1341
1342 struct GETATTR3args {
1343 nfs_fh3 object;
1344 };
1345 typedef struct GETATTR3args GETATTR3args;
1346
1347 struct GETATTR3resok {
1348 fattr3 obj_attributes;
1349 };
1350 typedef struct GETATTR3resok GETATTR3resok;
1351
1352 struct GETATTR3res {
1353 nfsstat3 status;
1354 union {
1355 GETATTR3resok ok;
1356 } res_u;
1357 };
1358 typedef struct GETATTR3res GETATTR3res;
1359
1360 #ifdef _KERNEL
1361 struct GETATTR3vres {
1362 nfsstat3 status;
1363 fattr3_res fres;
1364 };
1365 typedef struct GETATTR3vres GETATTR3vres;
1366 #endif /* _KERNEL */
1367
1368 struct sattrguard3 {
1369 bool_t check;
1370 nfstime3 obj_ctime;
1371 };
1372 typedef struct sattrguard3 sattrguard3;
1373
1374 struct SETATTR3args {
1375 nfs_fh3 object;
1376 sattr3 new_attributes;
1377 sattrguard3 guard;
1378 };
1379 typedef struct SETATTR3args SETATTR3args;
1380
1381 struct SETATTR3resok {
1382 wcc_data obj_wcc;
1383 };
1384 typedef struct SETATTR3resok SETATTR3resok;
1385
1386 struct SETATTR3resfail {
1387 wcc_data obj_wcc;
1388 };
1389 typedef struct SETATTR3resfail SETATTR3resfail;
1390
1391 struct SETATTR3res {
1392 nfsstat3 status;
1393 union {
1394 SETATTR3resok ok;
1395 SETATTR3resfail fail;
1396 } res_u;
1397 };
1398 typedef struct SETATTR3res SETATTR3res;
1399
1400 struct LOOKUP3args {
1401 diropargs3 what;
1402 };
1403 typedef struct LOOKUP3args LOOKUP3args;
1404
1405 struct LOOKUP3resok {
1406 nfs_fh3 object;
1407 post_op_attr obj_attributes;
1408 post_op_attr dir_attributes;
1409 };
1410 typedef struct LOOKUP3resok LOOKUP3resok;
1411
1412 struct LOOKUP3resfail {
1413 post_op_attr dir_attributes;
1414 };
1415 typedef struct LOOKUP3resfail LOOKUP3resfail;
1416
1417 struct LOOKUP3res {
1418 nfsstat3 status;
1419 union {
1420 LOOKUP3resok ok;
1421 LOOKUP3resfail fail;
1422 } res_u;
1423 };
1424 typedef struct LOOKUP3res LOOKUP3res;
1425
1426 #ifdef _KERNEL
1427 struct LOOKUP3vres {
1428 nfsstat3 status;
1429 nfs_fh3 object;
1430 post_op_vattr dir_attributes;
1431 post_op_vattr obj_attributes;
1432 };
1433 typedef struct LOOKUP3vres LOOKUP3vres;
1434 #endif /* _KERNEL */
1435
1436 struct ACCESS3args {
1437 nfs_fh3 object;
1438 uint32 access;
1439 };
1440 typedef struct ACCESS3args ACCESS3args;
1441 #define ACCESS3_READ 0x1
1442 #define ACCESS3_LOOKUP 0x2
1443 #define ACCESS3_MODIFY 0x4
1444 #define ACCESS3_EXTEND 0x8
1445 #define ACCESS3_DELETE 0x10
1446 #define ACCESS3_EXECUTE 0x20
1447
1448 struct ACCESS3resok {
1449 post_op_attr obj_attributes;
1450 uint32 access;
1451 };
1452 typedef struct ACCESS3resok ACCESS3resok;
1453
1454 struct ACCESS3resfail {
1455 post_op_attr obj_attributes;
1456 };
1457 typedef struct ACCESS3resfail ACCESS3resfail;
1458
1459 struct ACCESS3res {
1460 nfsstat3 status;
1461 union {
1462 ACCESS3resok ok;
1463 ACCESS3resfail fail;
1464 } res_u;
1465 };
1466 typedef struct ACCESS3res ACCESS3res;
1467
1468 struct READLINK3args {
1469 nfs_fh3 symlink;
1470 };
1471 typedef struct READLINK3args READLINK3args;
1472
1473 struct READLINK3resok {
1474 post_op_attr symlink_attributes;
1475 nfspath3 data;
1476 };
1477 typedef struct READLINK3resok READLINK3resok;
1478
1479 struct READLINK3resfail {
1480 post_op_attr symlink_attributes;
1481 };
1482 typedef struct READLINK3resfail READLINK3resfail;
1483
1484 struct READLINK3res {
1485 nfsstat3 status;
1486 union {
1487 READLINK3resok ok;
1488 READLINK3resfail fail;
1489 } res_u;
1490 };
1491 typedef struct READLINK3res READLINK3res;
1492
1493 struct READ3args {
1494 nfs_fh3 file;
1495 offset3 offset;
1496 count3 count;
1497 #ifdef _KERNEL
1498 /* for read using rdma */
1499 char *res_data_val_alt;
1500 struct uio *res_uiop;
1501 struct clist *wlist;
1502 CONN *conn;
1503 #endif
1504 };
1505 typedef struct READ3args READ3args;
1506
1507 struct READ3resok {
1508 post_op_attr file_attributes;
1509 count3 count;
1510 bool_t eof;
1511 struct {
1512 uint_t data_len;
1513 char *data_val;
1514 mblk_t *mp;
1515 } data;
1516 uint_t size;
1517 #ifdef _KERNEL
1518 uint_t wlist_len;
1519 struct clist *wlist;
1520 frtn_t zcopy;
1521 #endif
1522 };
1523 typedef struct READ3resok READ3resok;
1524
1525 struct READ3resfail {
1526 post_op_attr file_attributes;
1527 };
1528 typedef struct READ3resfail READ3resfail;
1529
1530 struct READ3res {
1531 nfsstat3 status;
1532 union {
1533 READ3resok ok;
1534 READ3resfail fail;
1535 } res_u;
1536 };
1537 typedef struct READ3res READ3res;
1538
1539 #ifdef _KERNEL
1540 /*
1541 * READ3 reply that directly decodes fattr3 directly into vattr
1542 */
1543 struct READ3vres {
1544 nfsstat3 status;
1545 struct post_op_vattr pov;
1546 count3 count;
1547 bool_t eof;
1548 struct {
1549 uint_t data_len;
1550 char *data_val;
1551 } data;
1552 uint_t size;
1553
1554 uint_t wlist_len;
1555 struct clist *wlist;
1556 };
1557 typedef struct READ3vres READ3vres;
1558 #endif /* _KERNEL */
1559
1560 /*
1561 * READ3 reply that uiomoves data directly into a struct uio
1562 * ignores any attributes returned
1563 */
1564 struct READ3uiores {
1565 nfsstat3 status;
1566 count3 count;
1567 bool_t eof;
1568 struct uio *uiop;
1569 uint_t size; /* maximum reply size */
1570 #ifdef _KERNEL
1571 uint_t wlist_len;
1572 struct clist *wlist;
1573 #endif
1574 };
1575 typedef struct READ3uiores READ3uiores;
1576
1577 enum stable_how {
1578 UNSTABLE = 0,
1579 DATA_SYNC = 1,
1580 FILE_SYNC = 2
1581 };
1582 typedef enum stable_how stable_how;
1583
1584 struct WRITE3args {
1585 nfs_fh3 file;
1586 offset3 offset;
1587 count3 count;
1588 stable_how stable;
1589 struct {
1590 uint_t data_len;
1591 char *data_val;
1592 } data;
1593 mblk_t *mblk;
1594 #ifdef _KERNEL
1595 struct clist *rlist;
1596 CONN *conn;
1597 #endif
1598 };
1599 typedef struct WRITE3args WRITE3args;
1600
1601 struct WRITE3resok {
1602 wcc_data file_wcc;
1603 count3 count;
1604 stable_how committed;
1605 writeverf3 verf;
1606 };
1607 typedef struct WRITE3resok WRITE3resok;
1608
1609 struct WRITE3resfail {
1610 wcc_data file_wcc;
1611 };
1612 typedef struct WRITE3resfail WRITE3resfail;
1613
1614 struct WRITE3res {
1615 nfsstat3 status;
1616 union {
1617 WRITE3resok ok;
1618 WRITE3resfail fail;
1619 } res_u;
1620 };
1621 typedef struct WRITE3res WRITE3res;
1622
1623 enum createmode3 {
1624 UNCHECKED = 0,
1625 GUARDED = 1,
1626 EXCLUSIVE = 2
1627 };
1628 typedef enum createmode3 createmode3;
1629
1630 struct createhow3 {
1631 createmode3 mode;
1632 union {
1633 sattr3 obj_attributes;
1634 createverf3 verf;
1635 } createhow3_u;
1636 };
1637 typedef struct createhow3 createhow3;
1638
1639 struct CREATE3args {
1640 diropargs3 where;
1641 createhow3 how;
1642 };
1643 typedef struct CREATE3args CREATE3args;
1644
1645 struct CREATE3resok {
1646 post_op_fh3 obj;
1647 post_op_attr obj_attributes;
1648 wcc_data dir_wcc;
1649 };
1650 typedef struct CREATE3resok CREATE3resok;
1651
1652 struct CREATE3resfail {
1653 wcc_data dir_wcc;
1654 };
1655 typedef struct CREATE3resfail CREATE3resfail;
1656
1657 struct CREATE3res {
1658 nfsstat3 status;
1659 union {
1660 CREATE3resok ok;
1661 CREATE3resfail fail;
1662 } res_u;
1663 };
1664 typedef struct CREATE3res CREATE3res;
1665
1666 struct MKDIR3args {
1667 diropargs3 where;
1668 sattr3 attributes;
1669 };
1670 typedef struct MKDIR3args MKDIR3args;
1671
1672 struct MKDIR3resok {
1673 post_op_fh3 obj;
1674 post_op_attr obj_attributes;
1675 wcc_data dir_wcc;
1676 };
1677 typedef struct MKDIR3resok MKDIR3resok;
1678
1679 struct MKDIR3resfail {
1680 wcc_data dir_wcc;
1681 };
1682 typedef struct MKDIR3resfail MKDIR3resfail;
1683
1684 struct MKDIR3res {
1685 nfsstat3 status;
1686 union {
1687 MKDIR3resok ok;
1688 MKDIR3resfail fail;
1689 } res_u;
1690 };
1691 typedef struct MKDIR3res MKDIR3res;
1692
1693 struct symlinkdata3 {
1694 sattr3 symlink_attributes;
1695 nfspath3 symlink_data;
1696 };
1697 typedef struct symlinkdata3 symlinkdata3;
1698
1699 struct SYMLINK3args {
1700 diropargs3 where;
1701 symlinkdata3 symlink;
1702 };
1703 typedef struct SYMLINK3args SYMLINK3args;
1704
1705 struct SYMLINK3resok {
1706 post_op_fh3 obj;
1707 post_op_attr obj_attributes;
1708 wcc_data dir_wcc;
1709 };
1710 typedef struct SYMLINK3resok SYMLINK3resok;
1711
1712 struct SYMLINK3resfail {
1713 wcc_data dir_wcc;
1714 };
1715 typedef struct SYMLINK3resfail SYMLINK3resfail;
1716
1717 struct SYMLINK3res {
1718 nfsstat3 status;
1719 union {
1720 SYMLINK3resok ok;
1721 SYMLINK3resfail fail;
1722 } res_u;
1723 };
1724 typedef struct SYMLINK3res SYMLINK3res;
1725
1726 struct devicedata3 {
1727 sattr3 dev_attributes;
1728 specdata3 spec;
1729 };
1730 typedef struct devicedata3 devicedata3;
1731
1732 struct mknoddata3 {
1733 ftype3 type;
1734 union {
1735 devicedata3 device;
1736 sattr3 pipe_attributes;
1737 } mknoddata3_u;
1738 };
1739 typedef struct mknoddata3 mknoddata3;
1740
1741 struct MKNOD3args {
1742 diropargs3 where;
1743 mknoddata3 what;
1744 };
1745 typedef struct MKNOD3args MKNOD3args;
1746
1747 struct MKNOD3resok {
1748 post_op_fh3 obj;
1749 post_op_attr obj_attributes;
1750 wcc_data dir_wcc;
1751 };
1752 typedef struct MKNOD3resok MKNOD3resok;
1753
1754 struct MKNOD3resfail {
1755 wcc_data dir_wcc;
1756 };
1757 typedef struct MKNOD3resfail MKNOD3resfail;
1758
1759 struct MKNOD3res {
1760 nfsstat3 status;
1761 union {
1762 MKNOD3resok ok;
1763 MKNOD3resfail fail;
1764 } res_u;
1765 };
1766 typedef struct MKNOD3res MKNOD3res;
1767
1768 struct REMOVE3args {
1769 diropargs3 object;
1770 };
1771 typedef struct REMOVE3args REMOVE3args;
1772
1773 struct REMOVE3resok {
1774 wcc_data dir_wcc;
1775 };
1776 typedef struct REMOVE3resok REMOVE3resok;
1777
1778 struct REMOVE3resfail {
1779 wcc_data dir_wcc;
1780 };
1781 typedef struct REMOVE3resfail REMOVE3resfail;
1782
1783 struct REMOVE3res {
1784 nfsstat3 status;
1785 union {
1786 REMOVE3resok ok;
1787 REMOVE3resfail fail;
1788 } res_u;
1789 };
1790 typedef struct REMOVE3res REMOVE3res;
1791
1792 struct RMDIR3args {
1793 diropargs3 object;
1794 };
1795 typedef struct RMDIR3args RMDIR3args;
1796
1797 struct RMDIR3resok {
1798 wcc_data dir_wcc;
1799 };
1800 typedef struct RMDIR3resok RMDIR3resok;
1801
1802 struct RMDIR3resfail {
1803 wcc_data dir_wcc;
1804 };
1805 typedef struct RMDIR3resfail RMDIR3resfail;
1806
1807 struct RMDIR3res {
1808 nfsstat3 status;
1809 union {
1810 RMDIR3resok ok;
1811 RMDIR3resfail fail;
1812 } res_u;
1813 };
1814 typedef struct RMDIR3res RMDIR3res;
1815
1816 struct RENAME3args {
1817 diropargs3 from;
1818 diropargs3 to;
1819 };
1820 typedef struct RENAME3args RENAME3args;
1821
1822 struct RENAME3resok {
1823 wcc_data fromdir_wcc;
1824 wcc_data todir_wcc;
1825 };
1826 typedef struct RENAME3resok RENAME3resok;
1827
1828 struct RENAME3resfail {
1829 wcc_data fromdir_wcc;
1830 wcc_data todir_wcc;
1831 };
1832 typedef struct RENAME3resfail RENAME3resfail;
1833
1834 struct RENAME3res {
1835 nfsstat3 status;
1836 union {
1837 RENAME3resok ok;
1838 RENAME3resfail fail;
1839 } res_u;
1840 };
1841 typedef struct RENAME3res RENAME3res;
1842
1843 struct LINK3args {
1844 nfs_fh3 file;
1845 diropargs3 link;
1846 };
1847 typedef struct LINK3args LINK3args;
1848
1849 struct LINK3resok {
1850 post_op_attr file_attributes;
1851 wcc_data linkdir_wcc;
1852 };
1853 typedef struct LINK3resok LINK3resok;
1854
1855 struct LINK3resfail {
1856 post_op_attr file_attributes;
1857 wcc_data linkdir_wcc;
1858 };
1859 typedef struct LINK3resfail LINK3resfail;
1860
1861 struct LINK3res {
1862 nfsstat3 status;
1863 union {
1864 LINK3resok ok;
1865 LINK3resfail fail;
1866 } res_u;
1867 };
1868 typedef struct LINK3res LINK3res;
1869
1870 struct READDIR3args {
1871 nfs_fh3 dir;
1872 cookie3 cookie;
1873 cookieverf3 cookieverf;
1874 count3 count;
1875 };
1876 typedef struct READDIR3args READDIR3args;
1877
1878 struct entry3 {
1879 fileid3 fileid;
1880 filename3 name;
1881 cookie3 cookie;
1882 struct entry3 *nextentry;
1883 };
1884 typedef struct entry3 entry3;
1885
1886 struct dirlist3 {
1887 entry3 *entries;
1888 bool_t eof;
1889 };
1890 typedef struct dirlist3 dirlist3;
1891
1892 struct READDIR3resok {
1893 post_op_attr dir_attributes;
1894 cookieverf3 cookieverf;
1895 dirlist3 reply;
1896 };
1897 typedef struct READDIR3resok READDIR3resok;
1898
1899 struct READDIR3resfail {
1900 post_op_attr dir_attributes;
1901 };
1902 typedef struct READDIR3resfail READDIR3resfail;
1903
1904 struct READDIR3res {
1905 nfsstat3 status;
1906 union {
1907 READDIR3resok ok;
1908 READDIR3resfail fail;
1909 } res_u;
1910 };
1911 typedef struct READDIR3res READDIR3res;
1912
1913 #ifdef _KERNEL
1914 struct READDIR3vres {
1915 nfsstat3 status;
1916 post_op_vattr dir_attributes;
1917 cookieverf3 cookieverf;
1918 dirent64_t *entries; /* decoded dirent64s */
1919 uint_t size; /* actual size of entries */
1920 uint_t entries_size; /* max size of entries */
1921 off64_t loff; /* last offset/cookie */
1922 bool_t eof; /* End of directory */
1923 };
1924 typedef struct READDIR3vres READDIR3vres;
1925 #endif /* _KERNEL */
1926
1927 struct READDIRPLUS3args {
1928 nfs_fh3 dir;
1929 cookie3 cookie;
1930 cookieverf3 cookieverf;
1931 count3 dircount;
1932 count3 maxcount;
1933 };
1934 typedef struct READDIRPLUS3args READDIRPLUS3args;
1935
1936 struct entryplus3 {
1937 fileid3 fileid;
1938 filename3 name;
1939 cookie3 cookie;
1940 post_op_attr name_attributes;
1941 post_op_fh3 name_handle;
1942 struct entryplus3 *nextentry;
1943 };
1944 typedef struct entryplus3 entryplus3;
1945
1946 struct dirlistplus3 {
1947 entryplus3 *entries;
1948 bool_t eof;
1949 };
1950 typedef struct dirlistplus3 dirlistplus3;
1951
1952 struct READDIRPLUS3resok {
1953 post_op_attr dir_attributes;
1954 cookieverf3 cookieverf;
1955 dirlistplus3 reply;
1956 };
1957 typedef struct READDIRPLUS3resok READDIRPLUS3resok;
1958
1959 struct READDIRPLUS3resfail {
1960 post_op_attr dir_attributes;
1961 };
1962 typedef struct READDIRPLUS3resfail READDIRPLUS3resfail;
1963
1964 struct READDIRPLUS3res {
1965 nfsstat3 status;
1966 union {
1967 READDIRPLUS3resok ok;
1968 READDIRPLUS3resfail fail;
1969 } res_u;
1970 };
1971 typedef struct READDIRPLUS3res READDIRPLUS3res;
1972
1973 #ifdef _KERNEL
1974 struct entryplus3_va_fh {
1975 int va_valid;
1976 int fh_valid;
1977 vattr_t va;
1978 nfs_fh3 fh;
1979 char *d_name; /* back pointer into entries */
1980 };
1981
1982 struct READDIRPLUS3vres {
1983 nfsstat3 status;
1984 post_op_vattr dir_attributes;
1985 cookieverf3 cookieverf;
1986 dirent64_t *entries; /* decoded dirent64s */
1987 uint_t size; /* actual size of entries */
1988 uint_t entries_size; /* max size of entries */
1989 bool_t eof; /* End of directory */
1990 off64_t loff; /* last offset/cookie */
1991 cred_t *credentials; /* caller's credentials */
1992 hrtime_t time; /* time of READDIRPLUS call */
1993 };
1994 typedef struct READDIRPLUS3vres READDIRPLUS3vres;
1995 #endif /* _KERNEL */
1996
1997 struct FSSTAT3args {
1998 nfs_fh3 fsroot;
1999 };
2000 typedef struct FSSTAT3args FSSTAT3args;
2001
2002 struct FSSTAT3resok {
2003 post_op_attr obj_attributes;
2004 size3 tbytes;
2005 size3 fbytes;
2006 size3 abytes;
2007 size3 tfiles;
2008 size3 ffiles;
2009 size3 afiles;
2010 uint32 invarsec;
2011 };
2012 typedef struct FSSTAT3resok FSSTAT3resok;
2013
2014 struct FSSTAT3resfail {
2015 post_op_attr obj_attributes;
2016 };
2017 typedef struct FSSTAT3resfail FSSTAT3resfail;
2018
2019 struct FSSTAT3res {
2020 nfsstat3 status;
2021 union {
2022 FSSTAT3resok ok;
2023 FSSTAT3resfail fail;
2024 } res_u;
2025 };
2026 typedef struct FSSTAT3res FSSTAT3res;
2027
2028 struct FSINFO3args {
2029 nfs_fh3 fsroot;
2030 };
2031 typedef struct FSINFO3args FSINFO3args;
2032
2033 struct FSINFO3resok {
2034 post_op_attr obj_attributes;
2035 uint32 rtmax;
2036 uint32 rtpref;
2037 uint32 rtmult;
2038 uint32 wtmax;
2039 uint32 wtpref;
2040 uint32 wtmult;
2041 uint32 dtpref;
2042 size3 maxfilesize;
2043 nfstime3 time_delta;
2044 uint32 properties;
2045 };
2046 typedef struct FSINFO3resok FSINFO3resok;
2047
2048 struct FSINFO3resfail {
2049 post_op_attr obj_attributes;
2050 };
2051 typedef struct FSINFO3resfail FSINFO3resfail;
2052 #define FSF3_LINK 0x1
2053 #define FSF3_SYMLINK 0x2
2054 #define FSF3_HOMOGENEOUS 0x8
2055 #define FSF3_CANSETTIME 0x10
2056
2057 struct FSINFO3res {
2058 nfsstat3 status;
2059 union {
2060 FSINFO3resok ok;
2061 FSINFO3resfail fail;
2062 } res_u;
2063 };
2064 typedef struct FSINFO3res FSINFO3res;
2065
2066 struct PATHCONF3args {
2067 nfs_fh3 object;
2068 };
2069 typedef struct PATHCONF3args PATHCONF3args;
2070
2071 struct nfs3_pathconf_info {
2072 uint32 link_max;
2073 uint32 name_max;
2074 bool_t no_trunc;
2075 bool_t chown_restricted;
2076 bool_t case_insensitive;
2077 bool_t case_preserving;
2078 };
2079 typedef struct nfs3_pathconf_info nfs3_pathconf_info;
2080
2081 struct PATHCONF3resok {
2082 post_op_attr obj_attributes;
2083 nfs3_pathconf_info info;
2084 };
2085 typedef struct PATHCONF3resok PATHCONF3resok;
2086
2087 struct PATHCONF3resfail {
2088 post_op_attr obj_attributes;
2089 };
2090 typedef struct PATHCONF3resfail PATHCONF3resfail;
2091
2092 struct PATHCONF3res {
2093 nfsstat3 status;
2094 union {
2095 PATHCONF3resok ok;
2096 PATHCONF3resfail fail;
2097 } res_u;
2098 };
2099 typedef struct PATHCONF3res PATHCONF3res;
2100
2101 struct COMMIT3args {
2102 nfs_fh3 file;
2103 offset3 offset;
2104 count3 count;
2105 };
2106 typedef struct COMMIT3args COMMIT3args;
2107
2108 struct COMMIT3resok {
2109 wcc_data file_wcc;
2110 writeverf3 verf;
2111 };
2112 typedef struct COMMIT3resok COMMIT3resok;
2113
2114 struct COMMIT3resfail {
2115 wcc_data file_wcc;
2116 };
2117 typedef struct COMMIT3resfail COMMIT3resfail;
2118
2119 struct COMMIT3res {
2120 nfsstat3 status;
2121 union {
2122 COMMIT3resok ok;
2123 COMMIT3resfail fail;
2124 } res_u;
2125 };
2126 typedef struct COMMIT3res COMMIT3res;
2127
2128 #define NFS3_PROGRAM ((rpcprog_t)100003)
2129 #define NFS_V3 ((rpcvers_t)3)
2130 #define NFSPROC3_NULL ((rpcproc_t)0)
2131 #define NFSPROC3_GETATTR ((rpcproc_t)1)
2132 #define NFSPROC3_SETATTR ((rpcproc_t)2)
2133 #define NFSPROC3_LOOKUP ((rpcproc_t)3)
2134 #define NFSPROC3_ACCESS ((rpcproc_t)4)
2135 #define NFSPROC3_READLINK ((rpcproc_t)5)
2136 #define NFSPROC3_READ ((rpcproc_t)6)
2137 #define NFSPROC3_WRITE ((rpcproc_t)7)
2138 #define NFSPROC3_CREATE ((rpcproc_t)8)
2139 #define NFSPROC3_MKDIR ((rpcproc_t)9)
2140 #define NFSPROC3_SYMLINK ((rpcproc_t)10)
2141 #define NFSPROC3_MKNOD ((rpcproc_t)11)
2142 #define NFSPROC3_REMOVE ((rpcproc_t)12)
2143 #define NFSPROC3_RMDIR ((rpcproc_t)13)
2144 #define NFSPROC3_RENAME ((rpcproc_t)14)
2145 #define NFSPROC3_LINK ((rpcproc_t)15)
2146 #define NFSPROC3_READDIR ((rpcproc_t)16)
2147 #define NFSPROC3_READDIRPLUS ((rpcproc_t)17)
2148 #define NFSPROC3_FSSTAT ((rpcproc_t)18)
2149 #define NFSPROC3_FSINFO ((rpcproc_t)19)
2150 #define NFSPROC3_PATHCONF ((rpcproc_t)20)
2151 #define NFSPROC3_COMMIT ((rpcproc_t)21)
2152
2153 #ifndef _KERNEL
2154 extern void *nfsproc3_null_3();
2155 extern GETATTR3res *nfsproc3_getattr_3();
2156 extern SETATTR3res *nfsproc3_setattr_3();
2157 extern LOOKUP3res *nfsproc3_lookup_3();
2158 extern ACCESS3res *nfsproc3_access_3();
2159 extern READLINK3res *nfsproc3_readlink_3();
2160 extern READ3res *nfsproc3_read_3();
2161 extern WRITE3res *nfsproc3_write_3();
2162 extern CREATE3res *nfsproc3_create_3();
2163 extern MKDIR3res *nfsproc3_mkdir_3();
2164 extern SYMLINK3res *nfsproc3_symlink_3();
2165 extern MKNOD3res *nfsproc3_mknod_3();
2166 extern REMOVE3res *nfsproc3_remove_3();
2167 extern RMDIR3res *nfsproc3_rmdir_3();
2168 extern RENAME3res *nfsproc3_rename_3();
2169 extern LINK3res *nfsproc3_link_3();
2170 extern READDIR3res *nfsproc3_readdir_3();
2171 extern READDIRPLUS3res *nfsproc3_readdirplus_3();
2172 extern FSSTAT3res *nfsproc3_fsstat_3();
2173 extern FSINFO3res *nfsproc3_fsinfo_3();
2174 extern PATHCONF3res *nfsproc3_pathconf_3();
2175 extern COMMIT3res *nfsproc3_commit_3();
2176 #endif /* !_KERNEL */
2177
2178 #ifdef _KERNEL
2179 /* the NFS Version 3 XDR functions */
2180
2181 extern bool_t xdr_nfs_fh3(XDR *, nfs_fh3 *);
2182 extern bool_t xdr_nfslog_nfs_fh3(XDR *, nfs_fh3 *);
2183 extern bool_t xdr_nfs_fh3_server(XDR *, nfs_fh3 *);
2184 extern bool_t xdr_diropargs3(XDR *, diropargs3 *);
2185 extern bool_t xdr_post_op_attr(XDR *, post_op_attr *);
2186 extern bool_t xdr_post_op_fh3(XDR *, post_op_fh3 *);
2187 extern bool_t xdr_GETATTR3res(XDR *, GETATTR3res *);
2188 extern bool_t xdr_GETATTR3vres(XDR *, GETATTR3vres *);
2189 extern bool_t xdr_SETATTR3args(XDR *, SETATTR3args *);
2190 extern bool_t xdr_SETATTR3res(XDR *, SETATTR3res *);
2191 extern bool_t xdr_LOOKUP3res(XDR *, LOOKUP3res *);
2192 extern bool_t xdr_LOOKUP3vres(XDR *, LOOKUP3vres *);
2193 extern bool_t xdr_ACCESS3args(XDR *, ACCESS3args *);
2194 extern bool_t xdr_ACCESS3res(XDR *, ACCESS3res *);
2195 extern bool_t xdr_READLINK3args(XDR *, READLINK3args *);
2196 extern bool_t xdr_READLINK3res(XDR *, READLINK3res *);
2197 extern bool_t xdr_READ3args(XDR *, READ3args *);
2198 extern bool_t xdr_READ3res(XDR *, READ3res *);
2199 extern bool_t xdr_READ3vres(XDR *, READ3vres *);
2200 extern bool_t xdr_READ3uiores(XDR *, READ3uiores *);
2201 extern bool_t xdr_WRITE3args(XDR *, WRITE3args *);
2202 extern bool_t xdr_WRITE3res(XDR *, WRITE3res *);
2203 extern bool_t xdr_CREATE3args(XDR *, CREATE3args *);
2204 extern bool_t xdr_CREATE3res(XDR *, CREATE3res *);
2205 extern bool_t xdr_MKDIR3args(XDR *, MKDIR3args *);
2206 extern bool_t xdr_MKDIR3res(XDR *, MKDIR3res *);
2207 extern bool_t xdr_SYMLINK3args(XDR *, SYMLINK3args *);
2208 extern bool_t xdr_SYMLINK3res(XDR *, SYMLINK3res *);
2209 extern bool_t xdr_MKNOD3args(XDR *, MKNOD3args *);
2210 extern bool_t xdr_MKNOD3res(XDR *, MKNOD3res *);
2211 extern bool_t xdr_REMOVE3res(XDR *, REMOVE3res *);
2212 extern bool_t xdr_RMDIR3resfail(XDR *, RMDIR3resfail *);
2213 extern bool_t xdr_RMDIR3res(XDR *, RMDIR3res *);
2214 extern bool_t xdr_RENAME3args(XDR *, RENAME3args *);
2215 extern bool_t xdr_RENAME3res(XDR *, RENAME3res *);
2216 extern bool_t xdr_LINK3args(XDR *, LINK3args *);
2217 extern bool_t xdr_LINK3res(XDR *, LINK3res *);
2218 extern bool_t xdr_READDIR3args(XDR *, READDIR3args *);
2219 extern bool_t xdr_READDIR3res(XDR *, READDIR3res *);
2220 extern bool_t xdr_READDIR3vres(XDR *, READDIR3vres *);
2221 extern bool_t xdr_READDIRPLUS3args(XDR *, READDIRPLUS3args *);
2222 extern bool_t xdr_READDIRPLUS3res(XDR *, READDIRPLUS3res *);
2223 extern bool_t xdr_READDIRPLUS3vres(XDR *, READDIRPLUS3vres *);
2224 extern bool_t xdr_FSSTAT3res(XDR *, FSSTAT3res *);
2225 extern bool_t xdr_FSINFO3res(XDR *, FSINFO3res *);
2226 extern bool_t xdr_PATHCONF3res(XDR *, PATHCONF3res *);
2227 extern bool_t xdr_COMMIT3args(XDR *, COMMIT3args *);
2228 extern bool_t xdr_COMMIT3res(XDR *, COMMIT3res *);
2229 extern bool_t xdr_fastnfs_fh3(XDR *, nfs_fh3 **);
2230
2231 /*
2232 * The NFS Version 3 service procedures.
2233 */
2234 struct exportinfo; /* defined in nfs/export.h */
2235 struct servinfo; /* defined in nfs/nfs_clnt.h */
2236 struct mntinfo; /* defined in nfs/nfs_clnt.h */
2237 struct sec_ol; /* defined in nfs/export.h */
2238
2239 extern void rfs3_getattr(GETATTR3args *, GETATTR3res *, struct exportinfo *,
2240 struct svc_req *, cred_t *, bool_t);
2241 extern void *rfs3_getattr_getfh(GETATTR3args *);
2242 extern void rfs3_setattr(SETATTR3args *, SETATTR3res *, struct exportinfo *,
2243 struct svc_req *, cred_t *, bool_t);
2244 extern void *rfs3_setattr_getfh(SETATTR3args *);
2245 extern void rfs3_lookup(LOOKUP3args *, LOOKUP3res *, struct exportinfo *,
2246 struct svc_req *, cred_t *, bool_t);
2247 extern void *rfs3_lookup_getfh(LOOKUP3args *);
2248 extern void rfs3_access(ACCESS3args *, ACCESS3res *, struct exportinfo *,
2249 struct svc_req *, cred_t *, bool_t);
2250 extern void *rfs3_access_getfh(ACCESS3args *);
2251 extern void rfs3_readlink(READLINK3args *, READLINK3res *,
2252 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
2253 extern void *rfs3_readlink_getfh(READLINK3args *);
2254 extern void rfs3_readlink_free(READLINK3res *);
2255 extern void rfs3_read(READ3args *, READ3res *, struct exportinfo *,
2256 struct svc_req *, cred_t *, bool_t);
2257 extern void *rfs3_read_getfh(READ3args *);
2258 extern void rfs3_read_free(READ3res *);
2259 extern void rfs3_write(WRITE3args *, WRITE3res *, struct exportinfo *,
2260 struct svc_req *, cred_t *, bool_t);
2261 extern void *rfs3_write_getfh(WRITE3args *);
2262 extern void rfs3_create(CREATE3args *, CREATE3res *, struct exportinfo *,
2263 struct svc_req *, cred_t *, bool_t);
2264 extern void *rfs3_create_getfh(CREATE3args *);
2265 extern void rfs3_mkdir(MKDIR3args *, MKDIR3res *, struct exportinfo *,
2266 struct svc_req *, cred_t *, bool_t);
2267 extern void *rfs3_mkdir_getfh(MKDIR3args *);
2268 extern void rfs3_symlink(SYMLINK3args *, SYMLINK3res *, struct exportinfo *,
2269 struct svc_req *, cred_t *, bool_t);
2270 extern void *rfs3_symlink_getfh(SYMLINK3args *);
2271 extern void rfs3_mknod(MKNOD3args *, MKNOD3res *, struct exportinfo *,
2272 struct svc_req *, cred_t *, bool_t);
2273 extern void *rfs3_mknod_getfh(MKNOD3args *);
2274 extern void rfs3_remove(REMOVE3args *, REMOVE3res *, struct exportinfo *,
2275 struct svc_req *, cred_t *, bool_t);
2276 extern void *rfs3_remove_getfh(REMOVE3args *);
2277 extern void rfs3_rmdir(RMDIR3args *, RMDIR3res *, struct exportinfo *,
2278 struct svc_req *, cred_t *, bool_t);
2279 extern void *rfs3_rmdir_getfh(RMDIR3args *);
2280 extern void rfs3_rename(RENAME3args *, RENAME3res *, struct exportinfo *,
2281 struct svc_req *, cred_t *, bool_t);
2282 extern void *rfs3_rename_getfh(RENAME3args *);
2283 extern void rfs3_link(LINK3args *, LINK3res *, struct exportinfo *,
2284 struct svc_req *, cred_t *, bool_t);
2285 extern void *rfs3_link_getfh(LINK3args *);
2286 extern void rfs3_readdir(READDIR3args *, READDIR3res *, struct exportinfo *,
2287 struct svc_req *, cred_t *, bool_t);
2288 extern void *rfs3_readdir_getfh(READDIR3args *);
2289 extern void rfs3_readdir_free(READDIR3res *);
2290 extern void rfs3_readdirplus(READDIRPLUS3args *, READDIRPLUS3res *,
2291 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
2292 extern void *rfs3_readdirplus_getfh(READDIRPLUS3args *);
2293 extern void rfs3_readdirplus_free(READDIRPLUS3res *);
2294 extern void rfs3_fsstat(FSSTAT3args *, FSSTAT3res *, struct exportinfo *,
2295 struct svc_req *, cred_t *, bool_t);
2296 extern void *rfs3_fsstat_getfh(FSSTAT3args *);
2297 extern void rfs3_fsinfo(FSINFO3args *, FSINFO3res *, struct exportinfo *,
2298 struct svc_req *, cred_t *, bool_t);
2299 extern void *rfs3_fsinfo_getfh(FSINFO3args *);
2300 extern void rfs3_pathconf(PATHCONF3args *, PATHCONF3res *,
2301 struct exportinfo *, struct svc_req *, cred_t *, bool_t);
2302 extern void *rfs3_pathconf_getfh(PATHCONF3args *);
2303 extern void rfs3_commit(COMMIT3args *, COMMIT3res *, struct exportinfo *,
2304 struct svc_req *, cred_t *, bool_t);
2305 extern void *rfs3_commit_getfh(COMMIT3args *);
2306 extern void rfs3_srvrinit(void);
2307 extern void rfs3_srvrfini(void);
2308
2309 extern int nfs3_validate_caches(vnode_t *, cred_t *);
2310 extern void nfs3_cache_post_op_attr(vnode_t *, post_op_attr *, hrtime_t,
2311 cred_t *);
2312 extern void nfs3_cache_post_op_vattr(vnode_t *, post_op_vattr *, hrtime_t,
2313 cred_t *);
2314 extern void nfs3_cache_wcc_data(vnode_t *, wcc_data *, hrtime_t, cred_t *);
2315 extern void nfs3_attrcache(vnode_t *, fattr3 *, hrtime_t);
2316 extern int nfs3_cache_fattr3(vnode_t *, fattr3 *, vattr_t *, hrtime_t,
2317 cred_t *);
2318 extern int nfs3_getattr_otw(vnode_t *, struct vattr *, cred_t *);
2319 extern int nfs3getattr(vnode_t *, struct vattr *, cred_t *);
2320 extern int fattr3_to_vattr(vnode_t *, fattr3 *, struct vattr *);
2321 extern int nfs3tsize(void);
2322 extern uint_t nfs3_tsize(struct knetconfig *);
2323 extern uint_t rfs3_tsize(struct svc_req *);
2324 extern int vattr_to_sattr3(struct vattr *, sattr3 *);
2325 extern void setdiropargs3(diropargs3 *, char *, vnode_t *);
2326 extern enum nfsstat3 puterrno3(int);
2327 extern int geterrno3(enum nfsstat3);
2328 extern int nfs3init(int, char *);
2329 extern void nfs3fini(void);
2330 extern int nfs3_vfsinit(void);
2331 extern void nfs3_vfsfini(void);
2332 extern void vattr_to_post_op_attr(struct vattr *, post_op_attr *);
2333 extern void mblk_to_iov(mblk_t *, int, struct iovec *);
2334 extern int rfs_publicfh_mclookup(char *, vnode_t *, cred_t *, vnode_t **,
2335 struct exportinfo **, struct sec_ol *);
2336 extern int rfs_pathname(char *, vnode_t **, vnode_t **, vnode_t *,
2337 cred_t *, int);
2338 extern int rfs_cross_mnt(vnode_t **, struct exportinfo **);
2339 extern int rfs_climb_crossmnt(vnode_t **, struct exportinfo **, cred_t *);
2340
2341 extern vtype_t nf3_to_vt[];
2342 extern kstat_named_t *rfsproccnt_v3_ptr;
2343 extern kstat_t **rfsprocio_v3_ptr;
2344 extern vfsops_t *nfs3_vfsops;
2345 extern struct vnodeops *nfs3_vnodeops;
2346 extern const struct fs_operation_def nfs3_vnodeops_template[];
2347
2348 /*
2349 * Some servers do not properly update the attributes of the
2350 * directory when changes are made. To allow interoperability
2351 * with these broken servers, the nfs_disable_rddir_cache
2352 * parameter can be used to disable readdir response caching.
2353 */
2354 extern volatile int nfs_disable_rddir_cache;
2355
2356 /*
2357 * External functions called by the v2/v3 code into the v4 code
2358 */
2359 extern void nfs4_clnt_init(void);
2360 extern void nfs4_clnt_fini(void);
2361
2362 /*
2363 * Does NFS4 server have a vnode delegated? TRUE if so, FALSE if not.
2364 */
2365 extern bool_t rfs4_check_delegated(int mode, vnode_t *, bool_t trunc);
2366 /*
2367 * VOP_GETATTR call. If a NFS4 delegation is present on the supplied vnode
2368 * call back to the delegated client to get attributes for AT_MTIME and
2369 * AT_SIZE. Invoke VOP_GETATTR to get all other attributes or all attributes
2370 * if no delegation is present.
2371 */
2372 extern int rfs4_delegated_getattr(vnode_t *, vattr_t *, int, cred_t *);
2373
2374 extern int do_xattr_exists_check(vnode_t *, ulong_t *, cred_t *);
2375
2376 extern int protect_zfs_mntpt(vnode_t *);
2377
2378 extern ts_label_t *nfs_getflabel(vnode_t *, struct exportinfo *);
2379 extern boolean_t do_rfs_label_check(bslabel_t *, vnode_t *, int,
2380 struct exportinfo *);
2381
2382 /*
2383 * Copy Reduction support.
2384 * xuio_t wrapper with additional private data.
2385 */
2386
2387 typedef struct nfs_xuio {
2388 xuio_t nu_uio;
2389 vnode_t *nu_vp;
2390 uint_t nu_ref;
2391 frtn_t nu_frtn;
2392 } nfs_xuio_t;
2393
2394 extern xuio_t *rfs_setup_xuio(vnode_t *);
2395 extern mblk_t *uio_to_mblk(uio_t *);
2396 extern mblk_t *rfs_read_alloc(uint_t, struct iovec **, int *);
2397 extern void rfs_rndup_mblks(mblk_t *, uint_t, int);
2398 extern void rfs_free_xuio(void *);
2399
2400 #endif /* _KERNEL */
2401
2402 #ifdef __cplusplus
2403 }
2404 #endif
2405
2406 #endif /* _NFS_NFS_H */