include/linux/nfs4.h

   1 /*
   2  *  include/linux/nfs4.h
   3  *
   4  *  NFSv4 protocol definitions.
   5  *
   6  *  Copyright (c) 2002 The Regents of the University of Michigan.
   7  *  All rights reserved.
   8  *
   9  *  Kendrick Smith <kmsmith@umich.edu>
  10  *  Andy Adamson   <andros@umich.edu>
  11  */
  12
  13 #ifndef _LINUX_NFS4_H
  14 #define _LINUX_NFS4_H
  15
  16 #define NFS4_VERIFIER_SIZE      8
  17 #define NFS4_FHSIZE             128
  18 #define NFS4_MAXNAMLEN          NAME_MAX
  19
  20 #define NFS4_ACCESS_READ        0x0001
  21 #define NFS4_ACCESS_LOOKUP      0x0002
  22 #define NFS4_ACCESS_MODIFY      0x0004
  23 #define NFS4_ACCESS_EXTEND      0x0008
  24 #define NFS4_ACCESS_DELETE      0x0010
  25 #define NFS4_ACCESS_EXECUTE     0x0020
  26
  27 #define NFS4_FH_PERISTENT               0x0000
  28 #define NFS4_FH_NOEXPIRE_WITH_OPEN      0x0001
  29 #define NFS4_FH_VOLATILE_ANY            0x0002
  30 #define NFS4_FH_VOL_MIGRATION           0x0004
  31 #define NFS4_FH_VOL_RENAME              0x0008
  32
  33 #define NFS4_OPEN_RESULT_CONFIRM 0x0002
  34
  35 #define NFS4_SHARE_ACCESS_READ  0x0001
  36 #define NFS4_SHARE_ACCESS_WRITE 0x0002
  37 #define NFS4_SHARE_ACCESS_BOTH  0x0003
  38 #define NFS4_SHARE_DENY_READ    0x0001
  39 #define NFS4_SHARE_DENY_WRITE   0x0002
  40 #define NFS4_SHARE_DENY_BOTH    0x0003
  41
  42 #define NFS4_SET_TO_SERVER_TIME 0
  43 #define NFS4_SET_TO_CLIENT_TIME 1
  44
  45 #define NFS4_ACE_ACCESS_ALLOWED_ACE_TYPE 0
  46 #define NFS4_ACE_ACCESS_DENIED_ACE_TYPE  1
  47 #define NFS4_ACE_SYSTEM_AUDIT_ACE_TYPE   2
  48 #define NFS4_ACE_SYSTEM_ALARM_ACE_TYPE   3
  49
  50 #define ACL4_SUPPORT_ALLOW_ACL 0x01
  51 #define ACL4_SUPPORT_DENY_ACL  0x02
  52 #define ACL4_SUPPORT_AUDIT_ACL 0x04
  53 #define ACL4_SUPPORT_ALARM_ACL 0x08
  54
  55 typedef struct { char data[NFS4_VERIFIER_SIZE]; } nfs4_verifier;
  56 typedef struct { char data[16]; } nfs4_stateid;
  57
  58 enum nfs_opnum4 {
  59         OP_ACCESS = 3,
  60         OP_CLOSE = 4,
  61         OP_COMMIT = 5,
  62         OP_CREATE = 6,
  63         OP_DELEGPURGE = 7,
  64         OP_DELEGRETURN = 8,
  65         OP_GETATTR = 9,
  66         OP_GETFH = 10,
  67         OP_LINK = 11,
  68         OP_LOCK = 12,
  69         OP_LOCKT = 13,
  70         OP_LOCKU = 14,
  71         OP_LOOKUP = 15,
  72         OP_LOOKUPP = 16,
  73         OP_NVERIFY = 17,
  74         OP_OPEN = 18,
  75         OP_OPENATTR = 19,
  76         OP_OPEN_CONFIRM = 20,
  77         OP_OPEN_DOWNGRADE = 21,
  78         OP_PUTFH = 22,
  79         OP_PUTPUBFH = 23,
  80         OP_PUTROOTFH = 24,
  81         OP_READ = 25,
  82         OP_READDIR = 26,
  83         OP_READLINK = 27,
  84         OP_REMOVE = 28,
  85         OP_RENAME = 29,
  86         OP_RENEW = 30,
  87         OP_RESTOREFH = 31,
  88         OP_SAVEFH = 32,
  89         OP_SECINFO = 33,
  90         OP_SETATTR = 34,
  91         OP_SETCLIENTID = 35,
  92         OP_SETCLIENTID_CONFIRM = 36,
  93         OP_VERIFY = 37,
  94         OP_WRITE = 38,
  95         OP_RELEASE_LOCKOWNER = 39,
  96         OP_ILLEGAL = 10044,
  97 };
  98
  99 enum nfsstat4 {
 100         NFS4_OK = 0,
 101         NFS4ERR_PERM = 1,
 102         NFS4ERR_NOENT = 2,
 103         NFS4ERR_IO = 5,
 104         NFS4ERR_NXIO = 6,
 105         NFS4ERR_ACCESS = 13,
 106         NFS4ERR_EXIST = 17,
 107         NFS4ERR_XDEV = 18,
 108         /* Unused/reserved 19 */
 109         NFS4ERR_NOTDIR = 20,
 110         NFS4ERR_ISDIR = 21,
 111         NFS4ERR_INVAL = 22,
 112         NFS4ERR_FBIG = 27,
 113         NFS4ERR_NOSPC = 28,
 114         NFS4ERR_ROFS = 30,
 115         NFS4ERR_MLINK = 31,
 116         NFS4ERR_NAMETOOLONG = 63,
 117         NFS4ERR_NOTEMPTY = 66,
 118         NFS4ERR_DQUOT = 69,
 119         NFS4ERR_STALE = 70,
 120         NFS4ERR_BADHANDLE = 10001,
 121         NFS4ERR_BAD_COOKIE = 10003,
 122         NFS4ERR_NOTSUPP = 10004,
 123         NFS4ERR_TOOSMALL = 10005,
 124         NFS4ERR_SERVERFAULT = 10006,
 125         NFS4ERR_BADTYPE = 10007,
 126         NFS4ERR_DELAY = 10008,
 127         NFS4ERR_SAME = 10009,
 128         NFS4ERR_DENIED = 10010,
 129         NFS4ERR_EXPIRED = 10011,
 130         NFS4ERR_LOCKED = 10012,
 131         NFS4ERR_GRACE = 10013,
 132         NFS4ERR_FHEXPIRED = 10014,
 133         NFS4ERR_SHARE_DENIED = 10015,
 134         NFS4ERR_WRONGSEC = 10016,
 135         NFS4ERR_CLID_INUSE = 10017,
 136         NFS4ERR_RESOURCE = 10018,
 137         NFS4ERR_MOVED = 10019,
 138         NFS4ERR_NOFILEHANDLE = 10020,
 139         NFS4ERR_MINOR_VERS_MISMATCH = 10021,
 140         NFS4ERR_STALE_CLIENTID = 10022,
 141         NFS4ERR_STALE_STATEID = 10023,
 142         NFS4ERR_OLD_STATEID = 10024,
 143         NFS4ERR_BAD_STATEID = 10025,
 144         NFS4ERR_BAD_SEQID = 10026,
 145         NFS4ERR_NOT_SAME = 10027,
 146         NFS4ERR_LOCK_RANGE = 10028,
 147         NFS4ERR_SYMLINK = 10029,
 148         NFS4ERR_RESTOREFH = 10030,
 149         NFS4ERR_LEASE_MOVED = 10031,
 150         NFS4ERR_ATTRNOTSUPP = 10032,
 151         NFS4ERR_NO_GRACE = 10033,
 152         NFS4ERR_RECLAIM_BAD = 10034,
 153         NFS4ERR_RECLAIM_CONFLICT = 10035,
 154         NFS4ERR_BADXDR = 10036,
 155         NFS4ERR_LOCKS_HELD = 10037,
 156         NFS4ERR_OPENMODE = 10038,
 157         NFS4ERR_BADOWNER = 10039,
 158         NFS4ERR_BADCHAR = 10040,
 159         NFS4ERR_BADNAME = 10041,
 160         NFS4ERR_BAD_RANGE = 10042,
 161         NFS4ERR_LOCK_NOTSUPP = 10043,
 162         NFS4ERR_OP_ILLEGAL = 10044,
 163         NFS4ERR_DEADLOCK = 10045,
 164         NFS4ERR_FILE_OPEN = 10046,
 165         NFS4ERR_ADMIN_REVOKED = 10047,
 166         NFS4ERR_CB_PATH_DOWN = 10048
 167 };
 168
 169 /*
 170  * Note: NF4BAD is not actually part of the protocol; it is just used
 171  * internally by nfsd.
 172  */
 173 enum nfs_ftype4 {
 174         NF4BAD          = 0,
 175         NF4REG          = 1,    /* Regular File */
 176         NF4DIR          = 2,    /* Directory */
 177         NF4BLK          = 3,    /* Special File - block device */
 178         NF4CHR          = 4,    /* Special File - character device */
 179         NF4LNK          = 5,    /* Symbolic Link */
 180         NF4SOCK         = 6,    /* Special File - socket */
 181         NF4FIFO         = 7,    /* Special File - fifo */
 182         NF4ATTRDIR      = 8,    /* Attribute Directory */
 183         NF4NAMEDATTR    = 9     /* Named Attribute */
 184 };
 185
 186 enum open_claim_type4 {
 187         NFS4_OPEN_CLAIM_NULL = 0,
 188         NFS4_OPEN_CLAIM_PREVIOUS = 1,
 189         NFS4_OPEN_CLAIM_DELEGATE_CUR = 2,
 190         NFS4_OPEN_CLAIM_DELEGATE_PREV = 3
 191 };
 192
 193 enum opentype4 {
 194         NFS4_OPEN_NOCREATE = 0,
 195         NFS4_OPEN_CREATE = 1
 196 };
 197
 198 enum createmode4 {
 199         NFS4_CREATE_UNCHECKED = 0,
 200         NFS4_CREATE_GUARDED = 1,
 201         NFS4_CREATE_EXCLUSIVE = 2
 202 };
 203
 204 enum limit_by4 {
 205         NFS4_LIMIT_SIZE = 1,
 206         NFS4_LIMIT_BLOCKS = 2
 207 };
 208
 209 enum open_delegation_type4 {
 210         NFS4_OPEN_DELEGATE_NONE = 0,
 211         NFS4_OPEN_DELEGATE_READ = 1,
 212         NFS4_OPEN_DELEGATE_WRITE = 2
 213 };
 214
 215 enum lock_type4 {
 216         NFS4_UNLOCK_LT = 0,
 217         NFS4_READ_LT = 1,
 218         NFS4_WRITE_LT = 2,
 219         NFS4_READW_LT = 3,
 220         NFS4_WRITEW_LT = 4
 221 };
 222
 223
 224 /* Mandatory Attributes */
 225 #define FATTR4_WORD0_SUPPORTED_ATTRS    (1UL << 0)
 226 #define FATTR4_WORD0_TYPE               (1UL << 1)
 227 #define FATTR4_WORD0_FH_EXPIRE_TYPE     (1UL << 2)
 228 #define FATTR4_WORD0_CHANGE             (1UL << 3)
 229 #define FATTR4_WORD0_SIZE               (1UL << 4)
 230 #define FATTR4_WORD0_LINK_SUPPORT       (1UL << 5)
 231 #define FATTR4_WORD0_SYMLINK_SUPPORT    (1UL << 6)
 232 #define FATTR4_WORD0_NAMED_ATTR         (1UL << 7)
 233 #define FATTR4_WORD0_FSID               (1UL << 8)
 234 #define FATTR4_WORD0_UNIQUE_HANDLES     (1UL << 9)
 235 #define FATTR4_WORD0_LEASE_TIME         (1UL << 10)
 236 #define FATTR4_WORD0_RDATTR_ERROR       (1UL << 11)
 237
 238 /* Recommended Attributes */
 239 #define FATTR4_WORD0_ACL                (1UL << 12)
 240 #define FATTR4_WORD0_ACLSUPPORT         (1UL << 13)
 241 #define FATTR4_WORD0_ARCHIVE            (1UL << 14)
 242 #define FATTR4_WORD0_CANSETTIME         (1UL << 15)
 243 #define FATTR4_WORD0_CASE_INSENSITIVE   (1UL << 16)
 244 #define FATTR4_WORD0_CASE_PRESERVING    (1UL << 17)
 245 #define FATTR4_WORD0_CHOWN_RESTRICTED   (1UL << 18)
 246 #define FATTR4_WORD0_FILEHANDLE         (1UL << 19)
 247 #define FATTR4_WORD0_FILEID             (1UL << 20)
 248 #define FATTR4_WORD0_FILES_AVAIL        (1UL << 21)
 249 #define FATTR4_WORD0_FILES_FREE         (1UL << 22)
 250 #define FATTR4_WORD0_FILES_TOTAL        (1UL << 23)
 251 #define FATTR4_WORD0_FS_LOCATIONS       (1UL << 24)
 252 #define FATTR4_WORD0_HIDDEN             (1UL << 25)
 253 #define FATTR4_WORD0_HOMOGENEOUS        (1UL << 26)
 254 #define FATTR4_WORD0_MAXFILESIZE        (1UL << 27)
 255 #define FATTR4_WORD0_MAXLINK            (1UL << 28)
 256 #define FATTR4_WORD0_MAXNAME            (1UL << 29)
 257 #define FATTR4_WORD0_MAXREAD            (1UL << 30)
 258 #define FATTR4_WORD0_MAXWRITE           (1UL << 31)
 259 #define FATTR4_WORD1_MIMETYPE           (1UL << 0)
 260 #define FATTR4_WORD1_MODE               (1UL << 1)
 261 #define FATTR4_WORD1_NO_TRUNC           (1UL << 2)
 262 #define FATTR4_WORD1_NUMLINKS           (1UL << 3)
 263 #define FATTR4_WORD1_OWNER              (1UL << 4)
 264 #define FATTR4_WORD1_OWNER_GROUP        (1UL << 5)
 265 #define FATTR4_WORD1_QUOTA_HARD         (1UL << 6)
 266 #define FATTR4_WORD1_QUOTA_SOFT         (1UL << 7)
 267 #define FATTR4_WORD1_QUOTA_USED         (1UL << 8)
 268 #define FATTR4_WORD1_RAWDEV             (1UL << 9)
 269 #define FATTR4_WORD1_SPACE_AVAIL        (1UL << 10)
 270 #define FATTR4_WORD1_SPACE_FREE         (1UL << 11)
 271 #define FATTR4_WORD1_SPACE_TOTAL        (1UL << 12)
 272 #define FATTR4_WORD1_SPACE_USED         (1UL << 13)
 273 #define FATTR4_WORD1_SYSTEM             (1UL << 14)
 274 #define FATTR4_WORD1_TIME_ACCESS        (1UL << 15)
 275 #define FATTR4_WORD1_TIME_ACCESS_SET    (1UL << 16)
 276 #define FATTR4_WORD1_TIME_BACKUP        (1UL << 17)
 277 #define FATTR4_WORD1_TIME_CREATE        (1UL << 18)
 278 #define FATTR4_WORD1_TIME_DELTA         (1UL << 19)
 279 #define FATTR4_WORD1_TIME_METADATA      (1UL << 20)
 280 #define FATTR4_WORD1_TIME_MODIFY        (1UL << 21)
 281 #define FATTR4_WORD1_TIME_MODIFY_SET    (1UL << 22)
 282 #define FATTR4_WORD1_MOUNTED_ON_FILEID  (1UL << 23)
 283
 284 #define NFSPROC4_NULL 0
 285 #define NFSPROC4_COMPOUND 1
 286 #define NFS4_MINOR_VERSION 0
 287 #define NFS4_DEBUG 1
 288
 289 #ifdef __KERNEL__
 290
 291 /* Index of predefined Linux client operations */
 292
 293 enum {
 294         NFSPROC4_CLNT_NULL = 0,         /* Unused */
 295         NFSPROC4_CLNT_READ,
 296         NFSPROC4_CLNT_WRITE,
 297         NFSPROC4_CLNT_COMMIT,
 298         NFSPROC4_CLNT_OPEN,
 299         NFSPROC4_CLNT_OPEN_CONFIRM,
 300         NFSPROC4_CLNT_OPEN_RECLAIM,
 301         NFSPROC4_CLNT_OPEN_DOWNGRADE,
 302         NFSPROC4_CLNT_CLOSE,
 303         NFSPROC4_CLNT_SETATTR,
 304         NFSPROC4_CLNT_FSINFO,
 305         NFSPROC4_CLNT_RENEW,
 306         NFSPROC4_CLNT_SETCLIENTID,
 307         NFSPROC4_CLNT_SETCLIENTID_CONFIRM,
 308         NFSPROC4_CLNT_LOCK,
 309         NFSPROC4_CLNT_LOCKT,
 310         NFSPROC4_CLNT_LOCKU,
 311         NFSPROC4_CLNT_ACCESS,
 312         NFSPROC4_CLNT_GETATTR,
 313         NFSPROC4_CLNT_LOOKUP,
 314         NFSPROC4_CLNT_LOOKUP_ROOT,
 315         NFSPROC4_CLNT_REMOVE,
 316         NFSPROC4_CLNT_RENAME,
 317         NFSPROC4_CLNT_LINK,
 318         NFSPROC4_CLNT_CREATE,
 319         NFSPROC4_CLNT_PATHCONF,
 320         NFSPROC4_CLNT_STATFS,
 321         NFSPROC4_CLNT_READLINK,
 322         NFSPROC4_CLNT_READDIR,
 323         NFSPROC4_CLNT_SERVER_CAPS,
 324 };
 325
 326 #endif
 327 #endif
 328
 329 /*
 330  * Local variables:
 331  *  c-basic-offset: 8
 332  * End:
 333  */