source: rtems/cpukit/libnetworking/nfs/nfsproto.h @ 4bf1801

4.104.114.84.95
Last change on this file since 4bf1801 was 39e6e65a, checked in by Joel Sherrill <joel.sherrill@…>, on 08/19/98 at 21:32:28

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