The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/nfs/nfsproto.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

    1 /*-
    2  * SPDX-License-Identifier: BSD-3-Clause
    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  * $FreeBSD: stable/12/sys/nfs/nfsproto.h 326023 2017-11-20 19:43:44Z pfg $
   36  */
   37 
   38 #ifndef _NFS_NFSPROTO_H_
   39 #define _NFS_NFSPROTO_H_
   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"
   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_VER4        4
   57 
   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     /* XXXv4 this needs to be adjust for v4 */
   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, 3 and 4) */
   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, 4 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_SAME             10009   /* The rest Version 4 only */
  101 #define NFSERR_DENIED           10010
  102 #define NFSERR_EXPIRED          10011
  103 #define NFSERR_LOCKED           10012
  104 #define NFSERR_GRACE            10013
  105 #define NFSERR_FHEXPIRED        10014
  106 #define NFSERR_SHARDE_DENIED    10015
  107 #define NFSERR_WRONGSEC         10016
  108 #define NFSERR_CLID_INUSE       10017
  109 #define NFSERR_RESOURCE         10018
  110 #define NFSERR_MOVED            10019
  111 #define NFSERR_NOFILEHANDLE     10020
  112 #define NFSERR_MINOR_VERS_MISMATCH 10021
  113 #define NFSERR_STALE_CLIENTID   10022
  114 #define NFSERR_STALE_STATEID    10023
  115 #define NFSERR_OLD_STATEID      10024
  116 #define NFSERR_BAD_STATEID      10025
  117 #define NFSERR_BAD_SEQID        10026
  118 #define NFSERR_NOT_SAME         10027
  119 #define NFSERR_LOCK_RANGE       10028
  120 #define NFSERR_SYMLINK          10029
  121 #define NFSERR_READDIR_NOSPC    10030
  122 #define NFSERR_LEASE_MOVED      10031
  123 #define NFSERR_ATTRNOTSUPP      10032
  124 #define NFSERR_NO_GRACE         10033
  125 #define NFSERR_RECLAIM_BAD      10034
  126 #define NFSERR_RECLAIM_CONFLICT 10035
  127 #define NFSERR_BADXDR           10036
  128 #define NFSERR_LOCKS_HELD       10037
  129 #define NFSERR_OPENMODE         10038
  130 #define NFSERR_BADOWNER         10039
  131 #define NFSERR_BADCHAR          10040
  132 #define NFSERR_BADNAME          10041
  133 #define NFSERR_BAD_RANGE        10042
  134 #define NFSERR_LOCK_NOTSUPP     10043
  135 #define NFSERR_OP_ILLEGAL       10044
  136 #define NFSERR_DEADLOCK         10045
  137 #define NFSERR_FILE_OPEN        10046
  138 #define NFSERR_STALEWRITEVERF   30001   /* Fake return for nfs_commit() */
  139 
  140 
  141 
  142 #define NFSERR_RETVOID          0x20000000 /* Return void, not error */
  143 #define NFSERR_AUTHERR          0x40000000 /* Mark an authentication error */
  144 #define NFSERR_RETERR           0x80000000 /* Mark an error return for V3 */
  145 
  146 /* Sizes in bytes of various nfs rpc components */
  147 #define NFSX_UNSIGNED   4
  148 
  149 /* specific to NFS Version 2 */
  150 #define NFSX_V2FH       32
  151 #define NFSX_V2FATTR    68
  152 #define NFSX_V2SATTR    32
  153 #define NFSX_V2COOKIE   4
  154 #define NFSX_V2STATFS   20
  155 
  156 /* specific to NFS Version 3 */
  157 #define NFSX_V3FH               (sizeof (fhandle_t)) /* size this server uses */
  158 #define NFSX_V3FHMAX            64      /* max. allowed by protocol */
  159 #define NFSX_V3FATTR            84
  160 #define NFSX_V3SATTR            60      /* max. all fields filled in */
  161 #define NFSX_V3SRVSATTR         (sizeof (struct nfsv3_sattr))
  162 #define NFSX_V3POSTOPATTR       (NFSX_V3FATTR + NFSX_UNSIGNED)
  163 #define NFSX_V3WCCDATA          (NFSX_V3POSTOPATTR + 8 * NFSX_UNSIGNED)
  164 #define NFSX_V3COOKIEVERF       8
  165 #define NFSX_V3WRITEVERF        8
  166 #define NFSX_V3CREATEVERF       8
  167 #define NFSX_V3STATFS           52
  168 #define NFSX_V3FSINFO           48
  169 #define NFSX_V3PATHCONF         24
  170 
  171 /* specific to NFS Version 4 */
  172 #define NFSX_V4VERF             8
  173 #define NFSX_V4FH               128
  174 #define NFSX_V4STATEID          16
  175 
  176 /* variants for both versions */
  177 #define NFSX_FH(v3)             ((v3) ? (NFSX_V3FHMAX + NFSX_UNSIGNED) : \
  178                                         NFSX_V2FH)
  179 #define NFSX_SRVFH(v3)          ((v3) ? NFSX_V3FH : NFSX_V2FH)
  180 #define NFSX_FATTR(v3)          ((v3) ? NFSX_V3FATTR : NFSX_V2FATTR)
  181 #define NFSX_PREOPATTR(v3)      ((v3) ? (7 * NFSX_UNSIGNED) : 0)
  182 #define NFSX_POSTOPATTR(v3)     ((v3) ? (NFSX_V3FATTR + NFSX_UNSIGNED) : 0)
  183 #define NFSX_POSTOPORFATTR(v3)  ((v3) ? (NFSX_V3FATTR + NFSX_UNSIGNED) : \
  184                                         NFSX_V2FATTR)
  185 #define NFSX_WCCDATA(v3)        ((v3) ? NFSX_V3WCCDATA : 0)
  186 #define NFSX_WCCORFATTR(v3)     ((v3) ? NFSX_V3WCCDATA : NFSX_V2FATTR)
  187 #define NFSX_SATTR(v3)          ((v3) ? NFSX_V3SATTR : NFSX_V2SATTR)
  188 #define NFSX_COOKIEVERF(v3)     ((v3) ? NFSX_V3COOKIEVERF : 0)
  189 #define NFSX_WRITEVERF(v3)      ((v3) ? NFSX_V3WRITEVERF : 0)
  190 #define NFSX_READDIR(v3)        ((v3) ? (5 * NFSX_UNSIGNED) : \
  191                                         (2 * NFSX_UNSIGNED))
  192 #define NFSX_STATFS(v3)         ((v3) ? NFSX_V3STATFS : NFSX_V2STATFS)
  193 
  194 /* nfs rpc procedure numbers (before version mapping) */
  195 #define NFSPROC_NULL            0
  196 #define NFSPROC_GETATTR         1
  197 #define NFSPROC_SETATTR         2
  198 #define NFSPROC_LOOKUP          3
  199 #define NFSPROC_ACCESS          4
  200 #define NFSPROC_READLINK        5
  201 #define NFSPROC_READ            6
  202 #define NFSPROC_WRITE           7
  203 #define NFSPROC_CREATE          8
  204 #define NFSPROC_MKDIR           9
  205 #define NFSPROC_SYMLINK         10
  206 #define NFSPROC_MKNOD           11
  207 #define NFSPROC_REMOVE          12
  208 #define NFSPROC_RMDIR           13
  209 #define NFSPROC_RENAME          14
  210 #define NFSPROC_LINK            15
  211 #define NFSPROC_READDIR         16
  212 #define NFSPROC_READDIRPLUS     17
  213 #define NFSPROC_FSSTAT          18
  214 #define NFSPROC_FSINFO          19
  215 #define NFSPROC_PATHCONF        20
  216 #define NFSPROC_COMMIT          21
  217 #define NFSPROC_NOOP            22
  218 #define NFS_NPROCS              23
  219 
  220 /* Actual Version 2 procedure numbers */
  221 #define NFSV2PROC_NULL          0
  222 #define NFSV2PROC_GETATTR       1
  223 #define NFSV2PROC_SETATTR       2
  224 #define NFSV2PROC_NOOP          3
  225 #define NFSV2PROC_ROOT          NFSV2PROC_NOOP  /* Obsolete */
  226 #define NFSV2PROC_LOOKUP        4
  227 #define NFSV2PROC_READLINK      5
  228 #define NFSV2PROC_READ          6
  229 #define NFSV2PROC_WRITECACHE    NFSV2PROC_NOOP  /* Obsolete */
  230 #define NFSV2PROC_WRITE         8
  231 #define NFSV2PROC_CREATE        9
  232 #define NFSV2PROC_REMOVE        10
  233 #define NFSV2PROC_RENAME        11
  234 #define NFSV2PROC_LINK          12
  235 #define NFSV2PROC_SYMLINK       13
  236 #define NFSV2PROC_MKDIR         14
  237 #define NFSV2PROC_RMDIR         15
  238 #define NFSV2PROC_READDIR       16
  239 #define NFSV2PROC_STATFS        17
  240 
  241 /* Version 4 procedure numbers */
  242 #define NFSV4PROC_NULL         0
  243 #define NFSV4PROC_COMPOUND     1
  244 
  245 /* Version 4 operation numbers */
  246 #define NFSV4OP_ACCESS          3
  247 #define NFSV4OP_CLOSE           4
  248 #define NFSV4OP_COMMIT          5
  249 #define NFSV4OP_CREATE          6
  250 #define NFSV4OP_DELEGPURGE      7
  251 #define NFSV4OP_DELEGRETURN     8
  252 #define NFSV4OP_GETATTR         9
  253 #define NFSV4OP_GETFH           10
  254 #define NFSV4OP_LINK            11
  255 #define NFSV4OP_LOCK            12
  256 #define NFSV4OP_LOCKT           13
  257 #define NFSV4OP_LOCKU           14
  258 #define NFSV4OP_LOOKUP          15
  259 #define NFSV4OP_LOOKUPP         16
  260 #define NFSV4OP_NVERIFY         17
  261 #define NFSV4OP_OPEN            18
  262 #define NFSV4OP_OPENATTR        19
  263 #define NFSV4OP_OPEN_CONFIRM    20
  264 #define NFSV4OP_OPEN_DOWNGRADE  21
  265 #define NFSV4OP_PUTFH           22
  266 #define NFSV4OP_PUTPUBFH        23
  267 #define NFSV4OP_PUTROOTFH       24
  268 #define NFSV4OP_READ            25
  269 #define NFSV4OP_READDIR         26
  270 #define NFSV4OP_READLINK        27
  271 #define NFSV4OP_REMOVE          28
  272 #define NFSV4OP_RENAME          29
  273 #define NFSV4OP_RENEW           30
  274 #define NFSV4OP_RESTOREFH       31
  275 #define NFSV4OP_SAVEFH          32
  276 #define NFSV4OP_SECINFO         33
  277 #define NFSV4OP_SETATTR         34
  278 #define NFSV4OP_SETCLIENTID     35
  279 #define NFSV4OP_SETCLIENTID_CONFIRM 36
  280 #define NFSV4OP_VERIFY          37
  281 #define NFSV4OP_WRITE           38
  282 
  283 /*
  284  * Constants used by the Version 3 protocol for various RPCs
  285  */
  286 #define NFSV3SATTRTIME_DONTCHANGE       0
  287 #define NFSV3SATTRTIME_TOSERVER         1
  288 #define NFSV3SATTRTIME_TOCLIENT         2
  289 
  290 #define NFSV3ACCESS_READ                0x01
  291 #define NFSV3ACCESS_LOOKUP              0x02
  292 #define NFSV3ACCESS_MODIFY              0x04
  293 #define NFSV3ACCESS_EXTEND              0x08
  294 #define NFSV3ACCESS_DELETE              0x10
  295 #define NFSV3ACCESS_EXECUTE             0x20
  296 
  297 #define NFSV3WRITE_UNSTABLE             0
  298 #define NFSV3WRITE_DATASYNC             1
  299 #define NFSV3WRITE_FILESYNC             2
  300 
  301 #define NFSV3CREATE_UNCHECKED           0
  302 #define NFSV3CREATE_GUARDED             1
  303 #define NFSV3CREATE_EXCLUSIVE           2
  304 
  305 #define NFSV3FSINFO_LINK                0x01
  306 #define NFSV3FSINFO_SYMLINK             0x02
  307 #define NFSV3FSINFO_HOMOGENEOUS         0x08
  308 #define NFSV3FSINFO_CANSETTIME          0x10
  309 
  310 /*
  311  * Constants used by the Version 4 protocol for various RPCs
  312  */
  313 
  314 #define NFSV4ACCESS_READ                0x01
  315 #define NFSV4ACCESS_LOOKUP              0x02
  316 #define NFSV4ACCESS_MODIFY              0x04
  317 #define NFSV4ACCESS_EXTEND              0x08
  318 #define NFSV4ACCESS_DELETE              0x10
  319 #define NFSV4ACCESS_EXECUTE             0x20
  320 
  321 #define NFSV4OPENRES_MLOCK              0x01
  322 #define NFSV4OPENRES_CONFIRM            0x02
  323 
  324 #define NFSV4OPENSHARE_ACCESS_READ      0x01
  325 #define NFSV4OPENSHARE_ACCESS_WRITE     0x02
  326 #define NFSV4OPENSHARE_ACCESS_BOTH      0x03
  327 #define NFSV4OPENSHARE_DENY_NONE        0x00
  328 #define NFSV4OPENSHARE_DENY_READ        0x01
  329 #define NFSV4OPENSHARE_DENY_WRITE       0x02
  330 #define NFSV4OPENSHARE_DENY_BOTH        0x03
  331 
  332 /* File types */
  333 typedef enum {
  334         NFNON=0,
  335         NFREG=1,
  336         NFDIR=2,
  337         NFBLK=3,
  338         NFCHR=4,
  339         NFLNK=5,
  340         NFSOCK=6,
  341         NFFIFO=7,
  342         NFATTRDIR = 8,
  343         NFNAMEDATTR = 9,
  344         NFBAD = 10,
  345 } nfstype;      
  346 
  347 /* NFSv4 claim type */
  348 typedef enum {
  349         NCLNULL = 0,
  350         NCLPREV = 1,
  351         NCLDELEGCUR = 2,
  352         NCLDELEGPREV = 3,
  353 } nfsv4cltype;
  354 
  355 /* Other NFSv4 types */
  356 typedef enum {
  357         NSHUNSTABLE = 0,
  358         NSHDATASYNC = 1,
  359         NSHFILESYNC = 2,
  360 } nfsv4stablehow;
  361 
  362 typedef enum { OTNOCREATE = 0, OTCREATE = 1 } nfsv4opentype;
  363 typedef enum { CMUNCHECKED = 0, CMGUARDED = 1, CMEXCLUSIVE = 2 } nfsv4createmode;
  364 typedef enum { THSERVERTIME = 0, THCLIENTTIME = 1 } nfsv4timehow;
  365 typedef enum { ODNONE = 0, ODREAD = 1, ODWRITE = 2 } nfsv4opendelegtype;
  366 
  367 /* Structs for common parts of the rpc's */
  368 
  369 /*
  370  * File Handle (32 bytes for version 2), variable up to 64 for version 3.
  371  * File Handles of up to NFS_SMALLFH in size are stored directly in the
  372  * nfs node, whereas larger ones are malloc'd. (This never happens when
  373  * NFS_SMALLFH is set to 64.)
  374  * NFS_SMALLFH should be in the range of 32 to 64 and be divisible by 4.
  375  */
  376 #ifndef NFS_SMALLFH
  377 #define NFS_SMALLFH     128
  378 #endif
  379 union nfsfh {
  380         fhandle_t       fh_generic;
  381         u_char          fh_bytes[NFS_SMALLFH];
  382 };
  383 typedef union nfsfh nfsfh_t;
  384 
  385 struct nfsv2_time {
  386         u_int32_t       nfsv2_sec;
  387         u_int32_t       nfsv2_usec;
  388 };
  389 typedef struct nfsv2_time       nfstime2;
  390 
  391 struct nfsv3_time {
  392         u_int32_t       nfsv3_sec;
  393         u_int32_t       nfsv3_nsec;
  394 };
  395 typedef struct nfsv3_time       nfstime3;
  396 
  397 /*
  398  * Quads are defined as arrays of 2 longs to ensure dense packing for the
  399  * protocol and to facilitate xdr conversion.
  400  */
  401 struct nfs_uquad {
  402         u_int32_t       nfsuquad[2];
  403 };
  404 typedef struct nfs_uquad        nfsuint64;
  405 
  406 /*
  407  * Used to convert between two u_longs and a u_quad_t.
  408  */
  409 union nfs_quadconvert {
  410         u_int32_t       lval[2];
  411         u_quad_t        qval;
  412 };
  413 typedef union nfs_quadconvert   nfsquad_t;
  414 
  415 /*
  416  * NFS Version 3 special file number.
  417  */
  418 struct nfsv3_spec {
  419         u_int32_t       specdata1;
  420         u_int32_t       specdata2;
  421 };
  422 typedef struct nfsv3_spec       nfsv3spec;
  423 
  424 /*
  425  * NFS Version 4 bitmap.
  426  */
  427 struct nfsv4_bitmap {
  428         uint32_t        bmlen;
  429         uint32_t        *bmval;
  430 };
  431 typedef struct nfsv4_bitmap nfsv4bitmap;
  432 
  433 struct nfsv4_changeinfo {
  434         u_int           ciatomic;
  435         uint64_t        cibefore;
  436         uint64_t        ciafter;
  437 };
  438 typedef struct nfsv4_changeinfo nfsv4changeinfo;
  439 
  440 /*
  441  * File attributes and setable attributes. These structures cover both
  442  * NFS version 2 and the version 3 protocol. Note that the union is only
  443  * used so that one pointer can refer to both variants. These structures
  444  * go out on the wire and must be densely packed, so no quad data types
  445  * are used. (all fields are longs or u_longs or structures of same)
  446  * NB: You can't do sizeof(struct nfs_fattr), you must use the
  447  *     NFSX_FATTR(v3) macro.
  448  */
  449 struct nfs_fattr {
  450         u_int32_t       fa_type;
  451         u_int32_t       fa_mode;
  452         u_int32_t       fa_nlink;
  453         u_int32_t       fa_uid;
  454         u_int32_t       fa_gid;
  455         union {
  456                 struct {
  457                         u_int32_t       nfsv2fa_size;
  458                         u_int32_t       nfsv2fa_blocksize;
  459                         u_int32_t       nfsv2fa_rdev;
  460                         u_int32_t       nfsv2fa_blocks;
  461                         u_int32_t       nfsv2fa_fsid;
  462                         u_int32_t       nfsv2fa_fileid;
  463                         nfstime2        nfsv2fa_atime;
  464                         nfstime2        nfsv2fa_mtime;
  465                         nfstime2        nfsv2fa_ctime;
  466                 } fa_nfsv2;
  467                 struct {
  468                         nfsuint64       nfsv3fa_size;
  469                         nfsuint64       nfsv3fa_used;
  470                         nfsv3spec       nfsv3fa_rdev;
  471                         nfsuint64       nfsv3fa_fsid;
  472                         nfsuint64       nfsv3fa_fileid;
  473                         nfstime3        nfsv3fa_atime;
  474                         nfstime3        nfsv3fa_mtime;
  475                         nfstime3        nfsv3fa_ctime;
  476                 } fa_nfsv3;
  477         } fa_un;
  478 };
  479 
  480 /* and some ugly defines for accessing union components */
  481 #define fa2_size                fa_un.fa_nfsv2.nfsv2fa_size
  482 #define fa2_blocksize           fa_un.fa_nfsv2.nfsv2fa_blocksize
  483 #define fa2_rdev                fa_un.fa_nfsv2.nfsv2fa_rdev
  484 #define fa2_blocks              fa_un.fa_nfsv2.nfsv2fa_blocks
  485 #define fa2_fsid                fa_un.fa_nfsv2.nfsv2fa_fsid
  486 #define fa2_fileid              fa_un.fa_nfsv2.nfsv2fa_fileid
  487 #define fa2_atime               fa_un.fa_nfsv2.nfsv2fa_atime
  488 #define fa2_mtime               fa_un.fa_nfsv2.nfsv2fa_mtime
  489 #define fa2_ctime               fa_un.fa_nfsv2.nfsv2fa_ctime
  490 #define fa3_size                fa_un.fa_nfsv3.nfsv3fa_size
  491 #define fa3_used                fa_un.fa_nfsv3.nfsv3fa_used
  492 #define fa3_rdev                fa_un.fa_nfsv3.nfsv3fa_rdev
  493 #define fa3_fsid                fa_un.fa_nfsv3.nfsv3fa_fsid
  494 #define fa3_fileid              fa_un.fa_nfsv3.nfsv3fa_fileid
  495 #define fa3_atime               fa_un.fa_nfsv3.nfsv3fa_atime
  496 #define fa3_mtime               fa_un.fa_nfsv3.nfsv3fa_mtime
  497 #define fa3_ctime               fa_un.fa_nfsv3.nfsv3fa_ctime
  498 
  499 struct nfsv4_fattr {
  500         u_int           fa4_valid;
  501         nfstype         fa4_type;
  502         off_t           fa4_size;
  503         uint64_t        fa4_fsid_major;
  504         uint64_t        fa4_fsid_minor;
  505         uint64_t        fa4_fileid;
  506         mode_t          fa4_mode;
  507         nlink_t         fa4_nlink;
  508         uid_t           fa4_uid;
  509         gid_t           fa4_gid;
  510         uint32_t        fa4_rdev_major;
  511         uint32_t        fa4_rdev_minor;
  512         struct timespec fa4_atime;
  513         struct timespec fa4_btime;
  514         struct timespec fa4_ctime;
  515         struct timespec fa4_mtime;
  516         uint64_t        fa4_maxread;
  517         uint64_t        fa4_maxwrite;
  518         uint64_t        fa4_ffree;
  519         uint64_t        fa4_ftotal;
  520         uint32_t        fa4_maxname;
  521         uint64_t        fa4_savail;
  522         uint64_t        fa4_sfree;
  523         uint64_t        fa4_stotal;
  524         uint64_t        fa4_changeid;
  525         uint32_t        fa4_lease_time;
  526         uint64_t        fa4_maxfilesize;
  527 };
  528 
  529 /* Flags for fa4_valid */
  530 #define FA4V_SIZE       0x00000001
  531 #define FA4V_FSID       0x00000002
  532 #define FA4V_FILEID     0x00000004
  533 #define FA4V_MODE       0x00000008
  534 #define FA4V_NLINK      0x00000010
  535 #define FA4V_UID        0x00000020
  536 #define FA4V_GID        0x00000040
  537 #define FA4V_RDEV       0x00000080
  538 #define FA4V_ATIME      0x00000100
  539 #define FA4V_BTIME      0x00000200
  540 #define FA4V_CTIME      0x00000400
  541 #define FA4V_MTIME      0x00000800
  542 #define FA4V_MAXREAD    0x00001000
  543 #define FA4V_MAXWRITE   0x00002000
  544 #define FA4V_TYPE       0x00004000
  545 #define FA4V_FFREE      0x00008000
  546 #define FA4V_FTOTAL     0x00010000
  547 #define FA4V_MAXNAME    0x00020000
  548 #define FA4V_SAVAIL     0x00040000
  549 #define FA4V_SFREE      0x00080000
  550 #define FA4V_STOTAL     0x00100000
  551 #define FA4V_CHANGEID   0x00200000
  552 #define FA4V_LEASE_TIME 0x00400000
  553 #define FA4V_MAXFILESIZE 0x00800000
  554 #define FA4V_ACL        0x01000000
  555 
  556 /* Offsets into bitmask */
  557 #define FA4_SUPPORTED_ATTRS     0
  558 #define FA4_TYPE                1
  559 #define FA4_FH_EXPIRE_TYPE      2
  560 #define FA4_CHANGE              3
  561 #define FA4_SIZE                4
  562 #define FA4_LINK_SUPPORT        5
  563 #define FA4_SYMLINK_SUPPORT     6
  564 #define FA4_NAMED_ATTR          7
  565 #define FA4_FSID                8
  566 #define FA4_UNIQUE_HANDLES      9
  567 #define FA4_LEASE_TIME          10
  568 #define FA4_RDATTR_ERROR        11
  569 #define FA4_ACL                 12
  570 #define FA4_ACLSUPPORT          13
  571 #define FA4_ARCHIVE             14
  572 #define FA4_CANSETTIME          15
  573 #define FA4_CASE_INSENSITIVE    16
  574 #define FA4_CASE_PRESERVING     17 
  575 #define FA4_CHOWN_RESTRICTED    18
  576 #define FA4_FILEHANDLE          19
  577 #define FA4_FILEID              20
  578 #define FA4_FILES_AVAIL         21
  579 #define FA4_FILES_FREE          22
  580 #define FA4_FILES_TOTAL         23
  581 #define FA4_FS_LOCATIONS        24
  582 #define FA4_HIDDEN              25
  583 #define FA4_HOMOGENEOUS         26
  584 #define FA4_MAXFILESIZE         27
  585 #define FA4_MAXLINK             28
  586 #define FA4_MAXNAME             29
  587 #define FA4_MAXREAD             30
  588 #define FA4_MAXWRITE            31
  589 #define FA4_MIMETYPE            32
  590 #define FA4_MODE                33
  591 #define FA4_NO_TRUNC            34
  592 #define FA4_NUMLINKS            35
  593 #define FA4_OWNER               36
  594 #define FA4_OWNER_GROUP         37
  595 #define FA4_QUOTA_HARD          38
  596 #define FA4_QUOTA_SOFT          39
  597 #define FA4_QUOTA_USED          40
  598 #define FA4_RAWDEV              41
  599 #define FA4_SPACE_AVAIL         42
  600 #define FA4_SPACE_FREE          43
  601 #define FA4_SPACE_TOTAL         44
  602 #define FA4_SPACE_USED          45
  603 #define FA4_SYSTEM              46
  604 #define FA4_TIME_ACCESS         47
  605 #define FA4_TIME_ACCESS_SET     48
  606 #define FA4_TIME_BACKUP         49
  607 #define FA4_TIME_CREATE         50
  608 #define FA4_TIME_DELTA          51
  609 #define FA4_TIME_METADATA       52
  610 #define FA4_TIME_MODIFY         53
  611 #define FA4_TIME_MODIFY_SET     54
  612 #define FA4_ATTR_MAX            55
  613 
  614 /* Macros for v4 fattr manipulation */
  615 #define FA4_SET(n, p)   ((p)[(n)/32] |= (1 << ((n) % 32)))
  616 #define FA4_CLR(n, p)   ((p)[(n)/32] &= ~(1 << ((n) % 32)))
  617 #define FA4_ISSET(n, p) ((p)[(n)/32] & (1 << ((n) % 32)))
  618 #define FA4_ZERO(p)     bzero((p), 8)
  619 #define FA4_SKIP(p)     ((p) += 2)
  620 
  621 struct nfsv2_sattr {
  622         u_int32_t       sa_mode;
  623         u_int32_t       sa_uid;
  624         u_int32_t       sa_gid;
  625         u_int32_t       sa_size;
  626         nfstime2        sa_atime;
  627         nfstime2        sa_mtime;
  628 };
  629 
  630 /*
  631  * NFS Version 3 sattr structure for the new node creation case.
  632  */
  633 struct nfsv3_sattr {
  634         u_int32_t       sa_modetrue;
  635         u_int32_t       sa_mode;
  636         u_int32_t       sa_uidfalse;
  637         u_int32_t       sa_gidfalse;
  638         u_int32_t       sa_sizefalse;
  639         u_int32_t       sa_atimetype;
  640         nfstime3        sa_atime;
  641         u_int32_t       sa_mtimetype;
  642         nfstime3        sa_mtime;
  643 };
  644 
  645 struct nfs_statfs {
  646         union {
  647                 struct {
  648                         u_int32_t       nfsv2sf_tsize;
  649                         u_int32_t       nfsv2sf_bsize;
  650                         u_int32_t       nfsv2sf_blocks;
  651                         u_int32_t       nfsv2sf_bfree;
  652                         u_int32_t       nfsv2sf_bavail;
  653                 } sf_nfsv2;
  654                 struct {
  655                         nfsuint64       nfsv3sf_tbytes;
  656                         nfsuint64       nfsv3sf_fbytes;
  657                         nfsuint64       nfsv3sf_abytes;
  658                         nfsuint64       nfsv3sf_tfiles;
  659                         nfsuint64       nfsv3sf_ffiles;
  660                         nfsuint64       nfsv3sf_afiles;
  661                         u_int32_t       nfsv3sf_invarsec;
  662                 } sf_nfsv3;
  663         } sf_un;
  664 };
  665 
  666 #define sf_tsize        sf_un.sf_nfsv2.nfsv2sf_tsize
  667 #define sf_bsize        sf_un.sf_nfsv2.nfsv2sf_bsize
  668 #define sf_blocks       sf_un.sf_nfsv2.nfsv2sf_blocks
  669 #define sf_bfree        sf_un.sf_nfsv2.nfsv2sf_bfree
  670 #define sf_bavail       sf_un.sf_nfsv2.nfsv2sf_bavail
  671 #define sf_tbytes       sf_un.sf_nfsv3.nfsv3sf_tbytes
  672 #define sf_fbytes       sf_un.sf_nfsv3.nfsv3sf_fbytes
  673 #define sf_abytes       sf_un.sf_nfsv3.nfsv3sf_abytes
  674 #define sf_tfiles       sf_un.sf_nfsv3.nfsv3sf_tfiles
  675 #define sf_ffiles       sf_un.sf_nfsv3.nfsv3sf_ffiles
  676 #define sf_afiles       sf_un.sf_nfsv3.nfsv3sf_afiles
  677 #define sf_invarsec     sf_un.sf_nfsv3.nfsv3sf_invarsec
  678 
  679 struct nfsv3_fsinfo {
  680         u_int32_t       fs_rtmax;
  681         u_int32_t       fs_rtpref;
  682         u_int32_t       fs_rtmult;
  683         u_int32_t       fs_wtmax;
  684         u_int32_t       fs_wtpref;
  685         u_int32_t       fs_wtmult;
  686         u_int32_t       fs_dtpref;
  687         nfsuint64       fs_maxfilesize;
  688         nfstime3        fs_timedelta;
  689         u_int32_t       fs_properties;
  690 };
  691 
  692 struct nfsv3_pathconf {
  693         u_int32_t       pc_linkmax;
  694         u_int32_t       pc_namemax;
  695         u_int32_t       pc_notrunc;
  696         u_int32_t       pc_chownrestricted;
  697         u_int32_t       pc_caseinsensitive;
  698         u_int32_t       pc_casepreserving;
  699 };
  700 
  701 #endif

Cache object: 378718bfbba3135760f59ad44c2021d3


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.