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