]> git.saurik.com Git - apple/xnu.git/blob - bsd/nfs/nfsproto.h
8b077777df7a1d6bc28769093b7bd7f6a3e0cfb4
[apple/xnu.git] / bsd / nfs / nfsproto.h
1 /*
2 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * Copyright (c) 1999-2003 Apple Computer, Inc. All Rights Reserved.
7 *
8 * This file contains Original Code and/or Modifications of Original Code
9 * as defined in and that are subject to the Apple Public Source License
10 * Version 2.0 (the 'License'). You may not use this file except in
11 * compliance with the License. Please obtain a copy of the License at
12 * http://www.opensource.apple.com/apsl/ and read it before using this
13 * file.
14 *
15 * The Original Code and all software distributed under the License are
16 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
17 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
18 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
20 * Please see the License for the specific language governing rights and
21 * limitations under the License.
22 *
23 * @APPLE_LICENSE_HEADER_END@
24 */
25 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
26 /*
27 * Copyright (c) 1989, 1993
28 * The Regents of the University of California. All rights reserved.
29 *
30 * This code is derived from software contributed to Berkeley by
31 * Rick Macklem at The University of Guelph.
32 *
33 * Redistribution and use in source and binary forms, with or without
34 * modification, are permitted provided that the following conditions
35 * are met:
36 * 1. Redistributions of source code must retain the above copyright
37 * notice, this list of conditions and the following disclaimer.
38 * 2. Redistributions in binary form must reproduce the above copyright
39 * notice, this list of conditions and the following disclaimer in the
40 * documentation and/or other materials provided with the distribution.
41 * 3. All advertising materials mentioning features or use of this software
42 * must display the following acknowledgement:
43 * This product includes software developed by the University of
44 * California, Berkeley and its contributors.
45 * 4. Neither the name of the University nor the names of its contributors
46 * may be used to endorse or promote products derived from this software
47 * without specific prior written permission.
48 *
49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59 * SUCH DAMAGE.
60 *
61 * @(#)nfsproto.h 8.2 (Berkeley) 3/30/95
62 * FreeBSD-Id: nfsproto.h,v 1.3 1997/02/22 09:42:50 peter Exp $
63 */
64
65 #ifndef _NFS_NFSPROTO_H_
66 #define _NFS_NFSPROTO_H_
67
68 #include <sys/appleapiopts.h>
69
70 #ifdef __APPLE_API_PRIVATE
71 /*
72 * nfs definitions as per the Version 2 and 3 specs
73 */
74
75 /*
76 * Constants as defined in the Sun NFS Version 2 and 3 specs.
77 * "NFS: Network File System Protocol Specification" RFC1094
78 * and in the "NFS: Network File System Version 3 Protocol
79 * Specification"
80 */
81
82 /* Only define these if nfs_prot.h hasn't been included */
83 #ifndef NFS_PROGRAM
84
85 #define NFS_PORT 2049
86 #define NFS_PROG 100003
87 #define NFS_VER2 2
88 #define NFS_VER3 3
89 #define NFS_V2MAXDATA 8192
90 #define NFS_MAXDGRAMDATA 16384
91 #define NFS_MAXDATA 32768
92 #define NFS_MAXPATHLEN 1024
93 #define NFS_MAXNAMLEN 255
94 #define NFS_MAXPKTHDR 404
95 #define NFS_MAXPACKET (NFS_MAXPKTHDR + NFS_MAXDATA)
96 #define NFS_MINPACKET 20
97 #define NFS_FABLKSIZE 512 /* Size in bytes of a block wrt fa_blocks */
98
99 /* Stat numbers for rpc returns (version 2 and 3) */
100 #define NFS_OK 0
101 #define NFSERR_PERM 1
102 #define NFSERR_NOENT 2
103 #define NFSERR_IO 5
104 #define NFSERR_NXIO 6
105 #define NFSERR_ACCES 13
106 #define NFSERR_EXIST 17
107 #define NFSERR_XDEV 18 /* Version 3 only */
108 #define NFSERR_NODEV 19
109 #define NFSERR_NOTDIR 20
110 #define NFSERR_ISDIR 21
111 #define NFSERR_INVAL 22 /* Version 3 only */
112 #define NFSERR_FBIG 27
113 #define NFSERR_NOSPC 28
114 #define NFSERR_ROFS 30
115 #define NFSERR_MLINK 31 /* Version 3 only */
116 #define NFSERR_NAMETOL 63
117 #define NFSERR_NOTEMPTY 66
118 #define NFSERR_DQUOT 69
119 #define NFSERR_STALE 70
120 #define NFSERR_REMOTE 71 /* Version 3 only */
121 #define NFSERR_WFLUSH 99 /* Version 2 only */
122 #define NFSERR_BADHANDLE 10001 /* The rest Version 3 only */
123 #define NFSERR_NOT_SYNC 10002
124 #define NFSERR_BAD_COOKIE 10003
125 #define NFSERR_NOTSUPP 10004
126 #define NFSERR_TOOSMALL 10005
127 #define NFSERR_SERVERFAULT 10006
128 #define NFSERR_BADTYPE 10007
129 #define NFSERR_JUKEBOX 10008
130 #define NFSERR_TRYLATER NFSERR_JUKEBOX
131 #define NFSERR_STALEWRITEVERF 30001 /* Fake return for nfs_commit() */
132
133 #define NFSERR_RETVOID 0x20000000 /* Return void, not error */
134 #define NFSERR_AUTHERR 0x40000000 /* Mark an authentication error */
135 #define NFSERR_RETERR 0x80000000 /* Mark an error return for V3 */
136
137 #endif /* !NFS_PROGRAM */
138
139 /* Sizes in bytes of various nfs rpc components */
140 #define NFSX_UNSIGNED 4
141
142 /* specific to NFS Version 2 */
143 #define NFSX_V2FH 32
144 #define NFSX_V2FATTR 68
145 #define NFSX_V2SATTR 32
146 #define NFSX_V2COOKIE 4
147 #define NFSX_V2STATFS 20
148
149 /* specific to NFS Version 3 */
150 #define NFSX_V3FH (sizeof (fhandle_t)) /* size this server uses */
151 #define NFSX_V3FHMAX 64 /* max. allowed by protocol */
152 #define NFSX_V3FATTR 84
153 #define NFSX_V3SATTR 60 /* max. all fields filled in */
154 #define NFSX_V3SRVSATTR (sizeof (struct nfsv3_sattr))
155 #define NFSX_V3POSTOPATTR (NFSX_V3FATTR + NFSX_UNSIGNED)
156 #define NFSX_V3WCCDATA (NFSX_V3POSTOPATTR + 8 * NFSX_UNSIGNED)
157 #define NFSX_V3COOKIEVERF 8
158 #define NFSX_V3WRITEVERF 8
159 #define NFSX_V3CREATEVERF 8
160 #define NFSX_V3STATFS 52
161 #define NFSX_V3FSINFO 48
162 #define NFSX_V3PATHCONF 24
163
164 /* variants for both versions */
165 #define NFSX_FH(v3) ((v3) ? (NFSX_V3FHMAX + NFSX_UNSIGNED) : \
166 NFSX_V2FH)
167 #define NFSX_SRVFH(v3) ((v3) ? NFSX_V3FH : NFSX_V2FH)
168 #define NFSX_FATTR(v3) ((v3) ? NFSX_V3FATTR : NFSX_V2FATTR)
169 #define NFSX_PREOPATTR(v3) ((v3) ? (7 * NFSX_UNSIGNED) : 0)
170 #define NFSX_POSTOPATTR(v3) ((v3) ? (NFSX_V3FATTR + NFSX_UNSIGNED) : 0)
171 #define NFSX_POSTOPORFATTR(v3) ((v3) ? (NFSX_V3FATTR + NFSX_UNSIGNED) : \
172 NFSX_V2FATTR)
173 #define NFSX_WCCDATA(v3) ((v3) ? NFSX_V3WCCDATA : 0)
174 #define NFSX_WCCORFATTR(v3) ((v3) ? NFSX_V3WCCDATA : NFSX_V2FATTR)
175 #define NFSX_SATTR(v3) ((v3) ? NFSX_V3SATTR : NFSX_V2SATTR)
176 #define NFSX_COOKIEVERF(v3) ((v3) ? NFSX_V3COOKIEVERF : 0)
177 #define NFSX_WRITEVERF(v3) ((v3) ? NFSX_V3WRITEVERF : 0)
178 #define NFSX_READDIR(v3) ((v3) ? (5 * NFSX_UNSIGNED) : \
179 (2 * NFSX_UNSIGNED))
180 #define NFSX_STATFS(v3) ((v3) ? NFSX_V3STATFS : NFSX_V2STATFS)
181
182 /* Only define these if nfs_prot.h hasn't been included */
183 #ifndef NFS_PROGRAM
184
185 /* nfs rpc procedure numbers (before version mapping) */
186 #define NFSPROC_NULL 0
187 #define NFSPROC_GETATTR 1
188 #define NFSPROC_SETATTR 2
189 #define NFSPROC_LOOKUP 3
190 #define NFSPROC_ACCESS 4
191 #define NFSPROC_READLINK 5
192 #define NFSPROC_READ 6
193 #define NFSPROC_WRITE 7
194 #define NFSPROC_CREATE 8
195 #define NFSPROC_MKDIR 9
196 #define NFSPROC_SYMLINK 10
197 #define NFSPROC_MKNOD 11
198 #define NFSPROC_REMOVE 12
199 #define NFSPROC_RMDIR 13
200 #define NFSPROC_RENAME 14
201 #define NFSPROC_LINK 15
202 #define NFSPROC_READDIR 16
203 #define NFSPROC_READDIRPLUS 17
204 #define NFSPROC_FSSTAT 18
205 #define NFSPROC_FSINFO 19
206 #define NFSPROC_PATHCONF 20
207 #define NFSPROC_COMMIT 21
208
209 #endif /* !NFS_PROGRAM */
210
211 /* And leasing (nqnfs) procedure numbers (must be last) */
212 #define NQNFSPROC_GETLEASE 22
213 #define NQNFSPROC_VACATED 23
214 #define NQNFSPROC_EVICTED 24
215
216 #define NFSPROC_NOOP 25
217 #define NFS_NPROCS 26
218
219 /* Actual Version 2 procedure numbers */
220 #define NFSV2PROC_NULL 0
221 #define NFSV2PROC_GETATTR 1
222 #define NFSV2PROC_SETATTR 2
223 #define NFSV2PROC_NOOP 3
224 #define NFSV2PROC_ROOT NFSV2PROC_NOOP /* Obsolete */
225 #define NFSV2PROC_LOOKUP 4
226 #define NFSV2PROC_READLINK 5
227 #define NFSV2PROC_READ 6
228 #define NFSV2PROC_WRITECACHE NFSV2PROC_NOOP /* Obsolete */
229 #define NFSV2PROC_WRITE 8
230 #define NFSV2PROC_CREATE 9
231 #define NFSV2PROC_REMOVE 10
232 #define NFSV2PROC_RENAME 11
233 #define NFSV2PROC_LINK 12
234 #define NFSV2PROC_SYMLINK 13
235 #define NFSV2PROC_MKDIR 14
236 #define NFSV2PROC_RMDIR 15
237 #define NFSV2PROC_READDIR 16
238 #define NFSV2PROC_STATFS 17
239
240 /*
241 * Constants used by the Version 3 protocol for various RPCs
242 */
243 #define NFSV3SATTRTIME_DONTCHANGE 0
244 #define NFSV3SATTRTIME_TOSERVER 1
245 #define NFSV3SATTRTIME_TOCLIENT 2
246
247 #define NFSV3ACCESS_READ 0x01
248 #define NFSV3ACCESS_LOOKUP 0x02
249 #define NFSV3ACCESS_MODIFY 0x04
250 #define NFSV3ACCESS_EXTEND 0x08
251 #define NFSV3ACCESS_DELETE 0x10
252 #define NFSV3ACCESS_EXECUTE 0x20
253
254 #define NFSV3WRITE_UNSTABLE 0
255 #define NFSV3WRITE_DATASYNC 1
256 #define NFSV3WRITE_FILESYNC 2
257
258 #define NFSV3CREATE_UNCHECKED 0
259 #define NFSV3CREATE_GUARDED 1
260 #define NFSV3CREATE_EXCLUSIVE 2
261
262 #define NFSV3FSINFO_LINK 0x01
263 #define NFSV3FSINFO_SYMLINK 0x02
264 #define NFSV3FSINFO_HOMOGENEOUS 0x08
265 #define NFSV3FSINFO_CANSETTIME 0x10
266
267 /* Conversion macros */
268 #define vtonfsv2_mode(t,m) \
269 txdr_unsigned(((t) == VFIFO) ? MAKEIMODE(VCHR, (m)) : \
270 MAKEIMODE((t), (m)))
271 #define vtonfsv3_mode(m) txdr_unsigned((m) & 07777)
272 #define nfstov_mode(a) (fxdr_unsigned(u_short, (a))&07777)
273 #define vtonfsv2_type(a) txdr_unsigned(nfsv2_type[((long)(a))])
274 #define vtonfsv3_type(a) txdr_unsigned(nfsv3_type[((long)(a))])
275 #define nfsv2tov_type(a) nv2tov_type[fxdr_unsigned(u_long,(a))&0x7]
276 #define nfsv3tov_type(a) nv3tov_type[fxdr_unsigned(u_long,(a))&0x7]
277
278 /* Only define these if nfs_prot.h hasn't been included */
279 #ifndef NFS_PROGRAM
280
281 /* File types */
282 typedef enum { NFNON=0, NFREG=1, NFDIR=2, NFBLK=3, NFCHR=4, NFLNK=5,
283 NFSOCK=6, NFFIFO=7 } nfstype;
284 #endif /* !NFS_PROGRAM */
285
286 /* Structs for common parts of the rpc's */
287 /*
288 * File Handle (32 bytes for version 2), variable up to 64 for version 3.
289 * File Handles of up to NFS_SMALLFH in size are stored directly in the
290 * nfs node, whereas larger ones are malloc'd. (This never happens when
291 * NFS_SMALLFH is set to 64.)
292 * NFS_SMALLFH should be in the range of 32 to 64 and be divisible by 4.
293 */
294 #ifndef NFS_SMALLFH
295 #define NFS_SMALLFH 64
296 #endif
297 union nfsfh {
298 fhandle_t fh_generic;
299 u_char fh_bytes[NFS_SMALLFH];
300 };
301 typedef union nfsfh nfsfh_t;
302
303 struct nfsv2_time {
304 u_long nfsv2_sec;
305 u_long nfsv2_usec;
306 };
307 typedef struct nfsv2_time nfstime2;
308
309 struct nfsv3_time {
310 u_long nfsv3_sec;
311 u_long nfsv3_nsec;
312 };
313 typedef struct nfsv3_time nfstime3;
314
315 /*
316 * Quads are defined as arrays of 2 longs to ensure dense packing for the
317 * protocol and to facilitate xdr conversion.
318 */
319 struct nfs_uquad {
320 u_long nfsuquad[2];
321 };
322 typedef struct nfs_uquad nfsuint64;
323
324 /*
325 * Used to convert between two u_longs and a u_quad_t.
326 */
327 union nfs_quadconvert {
328 u_long lval[2];
329 u_quad_t qval;
330 };
331 typedef union nfs_quadconvert nfsquad_t;
332
333 /*
334 * NFS Version 3 special file number.
335 */
336 struct nfsv3_spec {
337 u_long specdata1;
338 u_long specdata2;
339 };
340 typedef struct nfsv3_spec nfsv3spec;
341
342 /*
343 * File attributes and setable attributes. These structures cover both
344 * NFS version 2 and the version 3 protocol. Note that the union is only
345 * used so that one pointer can refer to both variants. These structures
346 * go out on the wire and must be densely packed, so no quad data types
347 * are used. (all fields are longs or u_longs or structures of same)
348 * NB: You can't do sizeof(struct nfs_fattr), you must use the
349 * NFSX_FATTR(v3) macro.
350 */
351 struct nfs_fattr {
352 u_long fa_type;
353 u_long fa_mode;
354 u_long fa_nlink;
355 u_long fa_uid;
356 u_long fa_gid;
357 union {
358 struct {
359 u_long nfsv2fa_size;
360 u_long nfsv2fa_blocksize;
361 u_long nfsv2fa_rdev;
362 u_long nfsv2fa_blocks;
363 u_long nfsv2fa_fsid;
364 u_long nfsv2fa_fileid;
365 nfstime2 nfsv2fa_atime;
366 nfstime2 nfsv2fa_mtime;
367 nfstime2 nfsv2fa_ctime;
368 } fa_nfsv2;
369 struct {
370 nfsuint64 nfsv3fa_size;
371 nfsuint64 nfsv3fa_used;
372 nfsv3spec nfsv3fa_rdev;
373 nfsuint64 nfsv3fa_fsid;
374 nfsuint64 nfsv3fa_fileid;
375 nfstime3 nfsv3fa_atime;
376 nfstime3 nfsv3fa_mtime;
377 nfstime3 nfsv3fa_ctime;
378 } fa_nfsv3;
379 } fa_un;
380 };
381
382 /* and some ugly defines for accessing union components */
383 #define fa2_size fa_un.fa_nfsv2.nfsv2fa_size
384 #define fa2_blocksize fa_un.fa_nfsv2.nfsv2fa_blocksize
385 #define fa2_rdev fa_un.fa_nfsv2.nfsv2fa_rdev
386 #define fa2_blocks fa_un.fa_nfsv2.nfsv2fa_blocks
387 #define fa2_fsid fa_un.fa_nfsv2.nfsv2fa_fsid
388 #define fa2_fileid fa_un.fa_nfsv2.nfsv2fa_fileid
389 #define fa2_atime fa_un.fa_nfsv2.nfsv2fa_atime
390 #define fa2_mtime fa_un.fa_nfsv2.nfsv2fa_mtime
391 #define fa2_ctime fa_un.fa_nfsv2.nfsv2fa_ctime
392 #define fa3_size fa_un.fa_nfsv3.nfsv3fa_size
393 #define fa3_used fa_un.fa_nfsv3.nfsv3fa_used
394 #define fa3_rdev fa_un.fa_nfsv3.nfsv3fa_rdev
395 #define fa3_fsid fa_un.fa_nfsv3.nfsv3fa_fsid
396 #define fa3_fileid fa_un.fa_nfsv3.nfsv3fa_fileid
397 #define fa3_atime fa_un.fa_nfsv3.nfsv3fa_atime
398 #define fa3_mtime fa_un.fa_nfsv3.nfsv3fa_mtime
399 #define fa3_ctime fa_un.fa_nfsv3.nfsv3fa_ctime
400
401 struct nfsv2_sattr {
402 u_long sa_mode;
403 u_long sa_uid;
404 u_long sa_gid;
405 u_long sa_size;
406 nfstime2 sa_atime;
407 nfstime2 sa_mtime;
408 };
409
410 /*
411 * NFS Version 3 sattr structure for the new node creation case.
412 */
413 struct nfsv3_sattr {
414 u_long sa_modetrue;
415 u_long sa_mode;
416 u_long sa_uidtrue;
417 u_long sa_uid;
418 u_long sa_gidtrue;
419 u_long sa_gid;
420 u_long sa_sizefalse;
421 u_long sa_atimetype;
422 u_long sa_mtimetype;
423 };
424
425 struct nfs_statfs {
426 union {
427 struct {
428 u_long nfsv2sf_tsize;
429 u_long nfsv2sf_bsize;
430 u_long nfsv2sf_blocks;
431 u_long nfsv2sf_bfree;
432 u_long nfsv2sf_bavail;
433 } sf_nfsv2;
434 struct {
435 nfsuint64 nfsv3sf_tbytes;
436 nfsuint64 nfsv3sf_fbytes;
437 nfsuint64 nfsv3sf_abytes;
438 nfsuint64 nfsv3sf_tfiles;
439 nfsuint64 nfsv3sf_ffiles;
440 nfsuint64 nfsv3sf_afiles;
441 u_long nfsv3sf_invarsec;
442 } sf_nfsv3;
443 } sf_un;
444 };
445
446 #define sf_tsize sf_un.sf_nfsv2.nfsv2sf_tsize
447 #define sf_bsize sf_un.sf_nfsv2.nfsv2sf_bsize
448 #define sf_blocks sf_un.sf_nfsv2.nfsv2sf_blocks
449 #define sf_bfree sf_un.sf_nfsv2.nfsv2sf_bfree
450 #define sf_bavail sf_un.sf_nfsv2.nfsv2sf_bavail
451 #define sf_tbytes sf_un.sf_nfsv3.nfsv3sf_tbytes
452 #define sf_fbytes sf_un.sf_nfsv3.nfsv3sf_fbytes
453 #define sf_abytes sf_un.sf_nfsv3.nfsv3sf_abytes
454 #define sf_tfiles sf_un.sf_nfsv3.nfsv3sf_tfiles
455 #define sf_ffiles sf_un.sf_nfsv3.nfsv3sf_ffiles
456 #define sf_afiles sf_un.sf_nfsv3.nfsv3sf_afiles
457 #define sf_invarsec sf_un.sf_nfsv3.nfsv3sf_invarsec
458
459 struct nfsv3_fsinfo {
460 u_long fs_rtmax;
461 u_long fs_rtpref;
462 u_long fs_rtmult;
463 u_long fs_wtmax;
464 u_long fs_wtpref;
465 u_long fs_wtmult;
466 u_long fs_dtpref;
467 nfsuint64 fs_maxfilesize;
468 nfstime3 fs_timedelta;
469 u_long fs_properties;
470 };
471
472 struct nfsv3_pathconf {
473 u_long pc_linkmax;
474 u_long pc_namemax;
475 u_long pc_notrunc;
476 u_long pc_chownrestricted;
477 u_long pc_caseinsensitive;
478 u_long pc_casepreserving;
479 };
480
481 #endif /* __APPLE_API_PRIVATE */
482 #endif /* _NFS_NFSPROTO_H_ */