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