master
1/* $NetBSD: nfsproto.h,v 1.17 2006/12/27 12:10:09 yamt 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 (60*1024)
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 (12/*sizeof(fhandle_t)*/+16)
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(nsfh, v3) (((v3) ? NFSX_UNSIGNED : 0) + NFSRVFH_SIZE(nsfh))
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#define NFSX_FHTOOBIG_P(sz, v3) ((sz) > ((v3) ? NFSX_V3FHMAX : NFSX_V2FH))
148
149/* nfs rpc procedure numbers (before version mapping) */
150#define NFSPROC_NULL 0
151#define NFSPROC_GETATTR 1
152#define NFSPROC_SETATTR 2
153#define NFSPROC_LOOKUP 3
154#define NFSPROC_ACCESS 4
155#define NFSPROC_READLINK 5
156#define NFSPROC_READ 6
157#define NFSPROC_WRITE 7
158#define NFSPROC_CREATE 8
159#define NFSPROC_MKDIR 9
160#define NFSPROC_SYMLINK 10
161#define NFSPROC_MKNOD 11
162#define NFSPROC_REMOVE 12
163#define NFSPROC_RMDIR 13
164#define NFSPROC_RENAME 14
165#define NFSPROC_LINK 15
166#define NFSPROC_READDIR 16
167#define NFSPROC_READDIRPLUS 17
168#define NFSPROC_FSSTAT 18
169#define NFSPROC_FSINFO 19
170#define NFSPROC_PATHCONF 20
171#define NFSPROC_COMMIT 21
172#define NFSPROC_NOOP 22
173#define NFS_NPROCS 23
174
175/* Actual Version 2 procedure numbers */
176#define NFSV2PROC_NULL 0
177#define NFSV2PROC_GETATTR 1
178#define NFSV2PROC_SETATTR 2
179#define NFSV2PROC_NOOP 3
180#define NFSV2PROC_ROOT NFSV2PROC_NOOP /* Obsolete */
181#define NFSV2PROC_LOOKUP 4
182#define NFSV2PROC_READLINK 5
183#define NFSV2PROC_READ 6
184#define NFSV2PROC_WRITECACHE NFSV2PROC_NOOP /* Obsolete */
185#define NFSV2PROC_WRITE 8
186#define NFSV2PROC_CREATE 9
187#define NFSV2PROC_REMOVE 10
188#define NFSV2PROC_RENAME 11
189#define NFSV2PROC_LINK 12
190#define NFSV2PROC_SYMLINK 13
191#define NFSV2PROC_MKDIR 14
192#define NFSV2PROC_RMDIR 15
193#define NFSV2PROC_READDIR 16
194#define NFSV2PROC_STATFS 17
195
196/*
197 * Constants used by the Version 3 protocol for various RPCs
198 */
199#define NFSV3SATTRTIME_DONTCHANGE 0
200#define NFSV3SATTRTIME_TOSERVER 1
201#define NFSV3SATTRTIME_TOCLIENT 2
202
203#define NFSV3ACCESS_READ 0x01
204#define NFSV3ACCESS_LOOKUP 0x02
205#define NFSV3ACCESS_MODIFY 0x04
206#define NFSV3ACCESS_EXTEND 0x08
207#define NFSV3ACCESS_DELETE 0x10
208#define NFSV3ACCESS_EXECUTE 0x20
209
210#define NFSV3WRITE_UNSTABLE 0
211#define NFSV3WRITE_DATASYNC 1
212#define NFSV3WRITE_FILESYNC 2
213
214#define NFSV3CREATE_UNCHECKED 0
215#define NFSV3CREATE_GUARDED 1
216#define NFSV3CREATE_EXCLUSIVE 2
217
218#define NFSV3FSINFO_LINK 0x01
219#define NFSV3FSINFO_SYMLINK 0x02
220#define NFSV3FSINFO_HOMOGENEOUS 0x08
221#define NFSV3FSINFO_CANSETTIME 0x10
222
223/* Conversion macros */
224#define vtonfsv2_mode(t,m) \
225 txdr_unsigned(((t) == VFIFO) ? MAKEIMODE(VCHR, (m)) : \
226 MAKEIMODE((t), (m)))
227#define vtonfsv3_mode(m) txdr_unsigned((m) & ALLPERMS)
228#define nfstov_mode(a) (fxdr_unsigned(u_int32_t, (a)) & ALLPERMS)
229#define vtonfsv2_type(a) txdr_unsigned(nfsv2_type[((int32_t)(a))])
230#define vtonfsv3_type(a) txdr_unsigned(nfsv3_type[((int32_t)(a))])
231#define nfsv2tov_type(a) nv2tov_type[fxdr_unsigned(u_int32_t,(a))&0x7]
232#define nfsv3tov_type(a) nv3tov_type[fxdr_unsigned(u_int32_t,(a))&0x7]
233
234/* File types */
235typedef enum { NFNON=0, NFREG=1, NFDIR=2, NFBLK=3, NFCHR=4, NFLNK=5,
236 NFSOCK=6, NFFIFO=7 } nfstype;
237
238/* Structs for common parts of the rpc's */
239/*
240 * File Handle (32 bytes for version 2), variable up to 64 for version 3.
241 * File Handles of up to NFS_SMALLFH in size are stored directly in the
242 * nfs node, whereas larger ones are malloc'd. (This never happens when
243 * NFS_SMALLFH is set to 64.)
244 * NFS_SMALLFH should be in the range of 32 to 64 and be divisible by 4.
245 */
246#ifndef NFS_SMALLFH
247#define NFS_SMALLFH 64
248#endif
249union nfsfh {
250#ifdef _KERNEL
251 fhandle_t fh_generic;
252#endif
253 u_char fh_bytes[NFS_SMALLFH];
254};
255typedef union nfsfh nfsfh_t;
256
257struct nfsv2_time {
258 u_int32_t nfsv2_sec;
259 u_int32_t nfsv2_usec;
260};
261typedef struct nfsv2_time nfstime2;
262
263struct nfsv3_time {
264 u_int32_t nfsv3_sec;
265 u_int32_t nfsv3_nsec;
266};
267typedef struct nfsv3_time nfstime3;
268
269/*
270 * Quads are defined as arrays of 2 longs to ensure dense packing for the
271 * protocol and to facilitate xdr conversion.
272 */
273struct nfs_uquad {
274 u_int32_t nfsuquad[2];
275};
276typedef struct nfs_uquad nfsuint64;
277
278/*
279 * Used to convert between two u_longs and a u_quad_t.
280 */
281union nfs_quadconvert {
282 u_int32_t lval[2];
283 u_quad_t qval;
284};
285typedef union nfs_quadconvert nfsquad_t;
286
287/*
288 * NFS Version 3 special file number.
289 */
290struct nfsv3_spec {
291 u_int32_t specdata1;
292 u_int32_t specdata2;
293};
294typedef struct nfsv3_spec nfsv3spec;
295
296/*
297 * File attributes and setable attributes. These structures cover both
298 * NFS version 2 and the version 3 protocol. Note that the union is only
299 * used so that one pointer can refer to both variants. These structures
300 * go out on the wire and must be densely packed, so no quad data types
301 * are used. (all fields are longs or u_longs or structures of same)
302 * NB: You can't do sizeof(struct nfs_fattr), you must use the
303 * NFSX_FATTR(v3) macro.
304 */
305struct nfs_fattr {
306 u_int32_t fa_type;
307 u_int32_t fa_mode;
308 u_int32_t fa_nlink;
309 u_int32_t fa_uid;
310 u_int32_t fa_gid;
311 union {
312 struct {
313 u_int32_t nfsv2fa_size;
314 u_int32_t nfsv2fa_blocksize;
315 u_int32_t nfsv2fa_rdev;
316 u_int32_t nfsv2fa_blocks;
317 u_int32_t nfsv2fa_fsid;
318 u_int32_t nfsv2fa_fileid;
319 nfstime2 nfsv2fa_atime;
320 nfstime2 nfsv2fa_mtime;
321 nfstime2 nfsv2fa_ctime;
322 } fa_nfsv2;
323 struct {
324 nfsuint64 nfsv3fa_size;
325 nfsuint64 nfsv3fa_used;
326 nfsv3spec nfsv3fa_rdev;
327 nfsuint64 nfsv3fa_fsid;
328 nfsuint64 nfsv3fa_fileid;
329 nfstime3 nfsv3fa_atime;
330 nfstime3 nfsv3fa_mtime;
331 nfstime3 nfsv3fa_ctime;
332 } fa_nfsv3;
333 } fa_un;
334};
335
336/* and some ugly defines for accessing union components */
337#define fa2_size fa_un.fa_nfsv2.nfsv2fa_size
338#define fa2_blocksize fa_un.fa_nfsv2.nfsv2fa_blocksize
339#define fa2_rdev fa_un.fa_nfsv2.nfsv2fa_rdev
340#define fa2_blocks fa_un.fa_nfsv2.nfsv2fa_blocks
341#define fa2_fsid fa_un.fa_nfsv2.nfsv2fa_fsid
342#define fa2_fileid fa_un.fa_nfsv2.nfsv2fa_fileid
343#define fa2_atime fa_un.fa_nfsv2.nfsv2fa_atime
344#define fa2_mtime fa_un.fa_nfsv2.nfsv2fa_mtime
345#define fa2_ctime fa_un.fa_nfsv2.nfsv2fa_ctime
346#define fa3_size fa_un.fa_nfsv3.nfsv3fa_size
347#define fa3_used fa_un.fa_nfsv3.nfsv3fa_used
348#define fa3_rdev fa_un.fa_nfsv3.nfsv3fa_rdev
349#define fa3_fsid fa_un.fa_nfsv3.nfsv3fa_fsid
350#define fa3_fileid fa_un.fa_nfsv3.nfsv3fa_fileid
351#define fa3_atime fa_un.fa_nfsv3.nfsv3fa_atime
352#define fa3_mtime fa_un.fa_nfsv3.nfsv3fa_mtime
353#define fa3_ctime fa_un.fa_nfsv3.nfsv3fa_ctime
354
355struct nfsv2_sattr {
356 u_int32_t sa_mode;
357 u_int32_t sa_uid;
358 u_int32_t sa_gid;
359 u_int32_t sa_size;
360 nfstime2 sa_atime;
361 nfstime2 sa_mtime;
362};
363
364/*
365 * NFS Version 3 sattr structure for the new node creation case.
366 */
367struct nfsv3_sattr {
368 u_int32_t sa_modetrue;
369 u_int32_t sa_mode;
370 u_int32_t sa_uidfalse;
371 u_int32_t sa_gidfalse;
372 u_int32_t sa_sizefalse;
373 u_int32_t sa_atimetype;
374 nfstime3 sa_atime;
375 u_int32_t sa_mtimetype;
376 nfstime3 sa_mtime;
377};
378
379struct nfs_statfs {
380 union {
381 struct {
382 u_int32_t nfsv2sf_tsize;
383 u_int32_t nfsv2sf_bsize;
384 u_int32_t nfsv2sf_blocks;
385 u_int32_t nfsv2sf_bfree;
386 u_int32_t nfsv2sf_bavail;
387 } sf_nfsv2;
388 struct {
389 nfsuint64 nfsv3sf_tbytes;
390 nfsuint64 nfsv3sf_fbytes;
391 nfsuint64 nfsv3sf_abytes;
392 nfsuint64 nfsv3sf_tfiles;
393 nfsuint64 nfsv3sf_ffiles;
394 nfsuint64 nfsv3sf_afiles;
395 u_int32_t nfsv3sf_invarsec;
396 } sf_nfsv3;
397 } sf_un;
398};
399
400#define sf_tsize sf_un.sf_nfsv2.nfsv2sf_tsize
401#define sf_bsize sf_un.sf_nfsv2.nfsv2sf_bsize
402#define sf_blocks sf_un.sf_nfsv2.nfsv2sf_blocks
403#define sf_bfree sf_un.sf_nfsv2.nfsv2sf_bfree
404#define sf_bavail sf_un.sf_nfsv2.nfsv2sf_bavail
405#define sf_tbytes sf_un.sf_nfsv3.nfsv3sf_tbytes
406#define sf_fbytes sf_un.sf_nfsv3.nfsv3sf_fbytes
407#define sf_abytes sf_un.sf_nfsv3.nfsv3sf_abytes
408#define sf_tfiles sf_un.sf_nfsv3.nfsv3sf_tfiles
409#define sf_ffiles sf_un.sf_nfsv3.nfsv3sf_ffiles
410#define sf_afiles sf_un.sf_nfsv3.nfsv3sf_afiles
411#define sf_invarsec sf_un.sf_nfsv3.nfsv3sf_invarsec
412
413struct nfsv3_fsinfo {
414 u_int32_t fs_rtmax;
415 u_int32_t fs_rtpref;
416 u_int32_t fs_rtmult;
417 u_int32_t fs_wtmax;
418 u_int32_t fs_wtpref;
419 u_int32_t fs_wtmult;
420 u_int32_t fs_dtpref;
421 nfsuint64 fs_maxfilesize;
422 nfstime3 fs_timedelta;
423 u_int32_t fs_properties;
424};
425
426struct nfsv3_pathconf {
427 u_int32_t pc_linkmax;
428 u_int32_t pc_namemax;
429 u_int32_t pc_notrunc;
430 u_int32_t pc_chownrestricted;
431 u_int32_t pc_caseinsensitive;
432 u_int32_t pc_casepreserving;
433};
434
435#endif