1/* SPDX-License-Identifier: GPL-2.0 */ 2/* 3 * include/linux/nfs4.h 4 * 5 * NFSv4 protocol definitions. 6 * 7 * Copyright (c) 2002 The Regents of the University of Michigan. 8 * All rights reserved. 9 * 10 * Kendrick Smith <kmsmith@umich.edu> 11 * Andy Adamson <andros@umich.edu> 12 */ 13#ifndef _LINUX_NFS4_H 14#define _LINUX_NFS4_H 15 16#include <linux/list.h> 17#include <linux/uidgid.h> 18#include <uapi/linux/nfs4.h> 19#include <linux/sunrpc/msg_prot.h> 20 21enum nfs4_acl_whotype { 22 NFS4_ACL_WHO_NAMED = 0, 23 NFS4_ACL_WHO_OWNER, 24 NFS4_ACL_WHO_GROUP, 25 NFS4_ACL_WHO_EVERYONE, 26}; 27 28struct nfs4_ace { 29 uint32_t type; 30 uint32_t flag; 31 uint32_t access_mask; 32 int whotype; 33 union { 34 kuid_t who_uid; 35 kgid_t who_gid; 36 }; 37}; 38 39struct nfs4_acl { 40 uint32_t naces; 41 struct nfs4_ace aces[]; 42}; 43 44#define NFS4_MAXLABELLEN 2048 45 46struct nfs4_label { 47 uint32_t lfs; 48 uint32_t pi; 49 u32 len; 50 char *label; 51}; 52 53typedef struct { char data[NFS4_VERIFIER_SIZE]; } nfs4_verifier; 54 55struct nfs4_stateid_struct { 56 union { 57 char data[NFS4_STATEID_SIZE]; 58 struct { 59 __be32 seqid; 60 char other[NFS4_STATEID_OTHER_SIZE]; 61 } __attribute__ ((packed)); 62 }; 63 64 enum { 65 NFS4_INVALID_STATEID_TYPE = 0, 66 NFS4_SPECIAL_STATEID_TYPE, 67 NFS4_OPEN_STATEID_TYPE, 68 NFS4_LOCK_STATEID_TYPE, 69 NFS4_DELEGATION_STATEID_TYPE, 70 NFS4_LAYOUT_STATEID_TYPE, 71 NFS4_PNFS_DS_STATEID_TYPE, 72 NFS4_REVOKED_STATEID_TYPE, 73 } type; 74}; 75 76typedef struct nfs4_stateid_struct nfs4_stateid; 77 78enum nfs_opnum4 { 79 OP_ACCESS = 3, 80 OP_CLOSE = 4, 81 OP_COMMIT = 5, 82 OP_CREATE = 6, 83 OP_DELEGPURGE = 7, 84 OP_DELEGRETURN = 8, 85 OP_GETATTR = 9, 86 OP_GETFH = 10, 87 OP_LINK = 11, 88 OP_LOCK = 12, 89 OP_LOCKT = 13, 90 OP_LOCKU = 14, 91 OP_LOOKUP = 15, 92 OP_LOOKUPP = 16, 93 OP_NVERIFY = 17, 94 OP_OPEN = 18, 95 OP_OPENATTR = 19, 96 OP_OPEN_CONFIRM = 20, 97 OP_OPEN_DOWNGRADE = 21, 98 OP_PUTFH = 22, 99 OP_PUTPUBFH = 23, 100 OP_PUTROOTFH = 24, 101 OP_READ = 25, 102 OP_READDIR = 26, 103 OP_READLINK = 27, 104 OP_REMOVE = 28, 105 OP_RENAME = 29, 106 OP_RENEW = 30, 107 OP_RESTOREFH = 31, 108 OP_SAVEFH = 32, 109 OP_SECINFO = 33, 110 OP_SETATTR = 34, 111 OP_SETCLIENTID = 35, 112 OP_SETCLIENTID_CONFIRM = 36, 113 OP_VERIFY = 37, 114 OP_WRITE = 38, 115 OP_RELEASE_LOCKOWNER = 39, 116 117 /* nfs41 */ 118 OP_BACKCHANNEL_CTL = 40, 119 OP_BIND_CONN_TO_SESSION = 41, 120 OP_EXCHANGE_ID = 42, 121 OP_CREATE_SESSION = 43, 122 OP_DESTROY_SESSION = 44, 123 OP_FREE_STATEID = 45, 124 OP_GET_DIR_DELEGATION = 46, 125 OP_GETDEVICEINFO = 47, 126 OP_GETDEVICELIST = 48, 127 OP_LAYOUTCOMMIT = 49, 128 OP_LAYOUTGET = 50, 129 OP_LAYOUTRETURN = 51, 130 OP_SECINFO_NO_NAME = 52, 131 OP_SEQUENCE = 53, 132 OP_SET_SSV = 54, 133 OP_TEST_STATEID = 55, 134 OP_WANT_DELEGATION = 56, 135 OP_DESTROY_CLIENTID = 57, 136 OP_RECLAIM_COMPLETE = 58, 137 138 /* nfs42 */ 139 OP_ALLOCATE = 59, 140 OP_COPY = 60, 141 OP_COPY_NOTIFY = 61, 142 OP_DEALLOCATE = 62, 143 OP_IO_ADVISE = 63, 144 OP_LAYOUTERROR = 64, 145 OP_LAYOUTSTATS = 65, 146 OP_OFFLOAD_CANCEL = 66, 147 OP_OFFLOAD_STATUS = 67, 148 OP_READ_PLUS = 68, 149 OP_SEEK = 69, 150 OP_WRITE_SAME = 70, 151 OP_CLONE = 71, 152 153 /* xattr support (RFC8276) */ 154 OP_GETXATTR = 72, 155 OP_SETXATTR = 73, 156 OP_LISTXATTRS = 74, 157 OP_REMOVEXATTR = 75, 158 159 OP_ILLEGAL = 10044, 160}; 161 162/*Defining first and last NFS4 operations implemented. 163Needs to be updated if more operations are defined in future.*/ 164 165#define FIRST_NFS4_OP OP_ACCESS 166#define LAST_NFS40_OP OP_RELEASE_LOCKOWNER 167#define LAST_NFS41_OP OP_RECLAIM_COMPLETE 168#define LAST_NFS42_OP OP_REMOVEXATTR 169#define LAST_NFS4_OP LAST_NFS42_OP 170 171enum nfsstat4 { 172 NFS4_OK = 0, 173 NFS4ERR_PERM = 1, 174 NFS4ERR_NOENT = 2, 175 NFS4ERR_IO = 5, 176 NFS4ERR_NXIO = 6, 177 NFS4ERR_ACCESS = 13, 178 NFS4ERR_EXIST = 17, 179 NFS4ERR_XDEV = 18, 180 /* Unused/reserved 19 */ 181 NFS4ERR_NOTDIR = 20, 182 NFS4ERR_ISDIR = 21, 183 NFS4ERR_INVAL = 22, 184 NFS4ERR_FBIG = 27, 185 NFS4ERR_NOSPC = 28, 186 NFS4ERR_ROFS = 30, 187 NFS4ERR_MLINK = 31, 188 NFS4ERR_NAMETOOLONG = 63, 189 NFS4ERR_NOTEMPTY = 66, 190 NFS4ERR_DQUOT = 69, 191 NFS4ERR_STALE = 70, 192 NFS4ERR_BADHANDLE = 10001, 193 NFS4ERR_BAD_COOKIE = 10003, 194 NFS4ERR_NOTSUPP = 10004, 195 NFS4ERR_TOOSMALL = 10005, 196 NFS4ERR_SERVERFAULT = 10006, 197 NFS4ERR_BADTYPE = 10007, 198 NFS4ERR_DELAY = 10008, 199 NFS4ERR_SAME = 10009, 200 NFS4ERR_DENIED = 10010, 201 NFS4ERR_EXPIRED = 10011, 202 NFS4ERR_LOCKED = 10012, 203 NFS4ERR_GRACE = 10013, 204 NFS4ERR_FHEXPIRED = 10014, 205 NFS4ERR_SHARE_DENIED = 10015, 206 NFS4ERR_WRONGSEC = 10016, 207 NFS4ERR_CLID_INUSE = 10017, 208 NFS4ERR_RESOURCE = 10018, 209 NFS4ERR_MOVED = 10019, 210 NFS4ERR_NOFILEHANDLE = 10020, 211 NFS4ERR_MINOR_VERS_MISMATCH = 10021, 212 NFS4ERR_STALE_CLIENTID = 10022, 213 NFS4ERR_STALE_STATEID = 10023, 214 NFS4ERR_OLD_STATEID = 10024, 215 NFS4ERR_BAD_STATEID = 10025, 216 NFS4ERR_BAD_SEQID = 10026, 217 NFS4ERR_NOT_SAME = 10027, 218 NFS4ERR_LOCK_RANGE = 10028, 219 NFS4ERR_SYMLINK = 10029, 220 NFS4ERR_RESTOREFH = 10030, 221 NFS4ERR_LEASE_MOVED = 10031, 222 NFS4ERR_ATTRNOTSUPP = 10032, 223 NFS4ERR_NO_GRACE = 10033, 224 NFS4ERR_RECLAIM_BAD = 10034, 225 NFS4ERR_RECLAIM_CONFLICT = 10035, 226 NFS4ERR_BADXDR = 10036, 227 NFS4ERR_LOCKS_HELD = 10037, 228 NFS4ERR_OPENMODE = 10038, 229 NFS4ERR_BADOWNER = 10039, 230 NFS4ERR_BADCHAR = 10040, 231 NFS4ERR_BADNAME = 10041, 232 NFS4ERR_BAD_RANGE = 10042, 233 NFS4ERR_LOCK_NOTSUPP = 10043, 234 NFS4ERR_OP_ILLEGAL = 10044, 235 NFS4ERR_DEADLOCK = 10045, 236 NFS4ERR_FILE_OPEN = 10046, 237 NFS4ERR_ADMIN_REVOKED = 10047, 238 NFS4ERR_CB_PATH_DOWN = 10048, 239 240 /* nfs41 */ 241 NFS4ERR_BADIOMODE = 10049, 242 NFS4ERR_BADLAYOUT = 10050, 243 NFS4ERR_BAD_SESSION_DIGEST = 10051, 244 NFS4ERR_BADSESSION = 10052, 245 NFS4ERR_BADSLOT = 10053, 246 NFS4ERR_COMPLETE_ALREADY = 10054, 247 NFS4ERR_CONN_NOT_BOUND_TO_SESSION = 10055, 248 NFS4ERR_DELEG_ALREADY_WANTED = 10056, 249 NFS4ERR_BACK_CHAN_BUSY = 10057, /* backchan reqs outstanding */ 250 NFS4ERR_LAYOUTTRYLATER = 10058, 251 NFS4ERR_LAYOUTUNAVAILABLE = 10059, 252 NFS4ERR_NOMATCHING_LAYOUT = 10060, 253 NFS4ERR_RECALLCONFLICT = 10061, 254 NFS4ERR_UNKNOWN_LAYOUTTYPE = 10062, 255 NFS4ERR_SEQ_MISORDERED = 10063, /* unexpected seq.id in req */ 256 NFS4ERR_SEQUENCE_POS = 10064, /* [CB_]SEQ. op not 1st op */ 257 NFS4ERR_REQ_TOO_BIG = 10065, /* request too big */ 258 NFS4ERR_REP_TOO_BIG = 10066, /* reply too big */ 259 NFS4ERR_REP_TOO_BIG_TO_CACHE = 10067, /* rep. not all cached */ 260 NFS4ERR_RETRY_UNCACHED_REP = 10068, /* retry & rep. uncached */ 261 NFS4ERR_UNSAFE_COMPOUND = 10069, /* retry/recovery too hard */ 262 NFS4ERR_TOO_MANY_OPS = 10070, /* too many ops in [CB_]COMP */ 263 NFS4ERR_OP_NOT_IN_SESSION = 10071, /* op needs [CB_]SEQ. op */ 264 NFS4ERR_HASH_ALG_UNSUPP = 10072, /* hash alg. not supp. */ 265 /* Error 10073 is unused. */ 266 NFS4ERR_CLIENTID_BUSY = 10074, /* clientid has state */ 267 NFS4ERR_PNFS_IO_HOLE = 10075, /* IO to _SPARSE file hole */ 268 NFS4ERR_SEQ_FALSE_RETRY = 10076, /* retry not original */ 269 NFS4ERR_BAD_HIGH_SLOT = 10077, /* sequence arg bad */ 270 NFS4ERR_DEADSESSION = 10078, /* persistent session dead */ 271 NFS4ERR_ENCR_ALG_UNSUPP = 10079, /* SSV alg mismatch */ 272 NFS4ERR_PNFS_NO_LAYOUT = 10080, /* direct I/O with no layout */ 273 NFS4ERR_NOT_ONLY_OP = 10081, /* bad compound */ 274 NFS4ERR_WRONG_CRED = 10082, /* permissions:state change */ 275 NFS4ERR_WRONG_TYPE = 10083, /* current operation mismatch */ 276 NFS4ERR_DIRDELEG_UNAVAIL = 10084, /* no directory delegation */ 277 NFS4ERR_REJECT_DELEG = 10085, /* on callback */ 278 NFS4ERR_RETURNCONFLICT = 10086, /* outstanding layoutreturn */ 279 NFS4ERR_DELEG_REVOKED = 10087, /* deleg./layout revoked */ 280 281 /* nfs42 */ 282 NFS4ERR_PARTNER_NOTSUPP = 10088, 283 NFS4ERR_PARTNER_NO_AUTH = 10089, 284 NFS4ERR_UNION_NOTSUPP = 10090, 285 NFS4ERR_OFFLOAD_DENIED = 10091, 286 NFS4ERR_WRONG_LFS = 10092, 287 NFS4ERR_BADLABEL = 10093, 288 NFS4ERR_OFFLOAD_NO_REQS = 10094, 289 290 /* xattr (RFC8276) */ 291 NFS4ERR_NOXATTR = 10095, 292 NFS4ERR_XATTR2BIG = 10096, 293}; 294 295/* error codes for internal client use */ 296#define NFS4ERR_RESET_TO_MDS 12001 297#define NFS4ERR_RESET_TO_PNFS 12002 298 299static inline bool seqid_mutating_err(u32 err) 300{ 301 /* See RFC 7530, section 9.1.7 */ 302 switch (err) { 303 case NFS4ERR_STALE_CLIENTID: 304 case NFS4ERR_STALE_STATEID: 305 case NFS4ERR_BAD_STATEID: 306 case NFS4ERR_BAD_SEQID: 307 case NFS4ERR_BADXDR: 308 case NFS4ERR_RESOURCE: 309 case NFS4ERR_NOFILEHANDLE: 310 case NFS4ERR_MOVED: 311 return false; 312 } 313 return true; 314} 315 316/* 317 * Note: NF4BAD is not actually part of the protocol; it is just used 318 * internally by nfsd. 319 */ 320enum nfs_ftype4 { 321 NF4BAD = 0, 322 NF4REG = 1, /* Regular File */ 323 NF4DIR = 2, /* Directory */ 324 NF4BLK = 3, /* Special File - block device */ 325 NF4CHR = 4, /* Special File - character device */ 326 NF4LNK = 5, /* Symbolic Link */ 327 NF4SOCK = 6, /* Special File - socket */ 328 NF4FIFO = 7, /* Special File - fifo */ 329 NF4ATTRDIR = 8, /* Attribute Directory */ 330 NF4NAMEDATTR = 9 /* Named Attribute */ 331}; 332 333enum open_claim_type4 { 334 NFS4_OPEN_CLAIM_NULL = 0, 335 NFS4_OPEN_CLAIM_PREVIOUS = 1, 336 NFS4_OPEN_CLAIM_DELEGATE_CUR = 2, 337 NFS4_OPEN_CLAIM_DELEGATE_PREV = 3, 338 NFS4_OPEN_CLAIM_FH = 4, /* 4.1 */ 339 NFS4_OPEN_CLAIM_DELEG_CUR_FH = 5, /* 4.1 */ 340 NFS4_OPEN_CLAIM_DELEG_PREV_FH = 6, /* 4.1 */ 341}; 342 343enum opentype4 { 344 NFS4_OPEN_NOCREATE = 0, 345 NFS4_OPEN_CREATE = 1 346}; 347 348enum createmode4 { 349 NFS4_CREATE_UNCHECKED = 0, 350 NFS4_CREATE_GUARDED = 1, 351 NFS4_CREATE_EXCLUSIVE = 2, 352 /* 353 * New to NFSv4.1. If session is persistent, 354 * GUARDED4 MUST be used. Otherwise, use 355 * EXCLUSIVE4_1 instead of EXCLUSIVE4. 356 */ 357 NFS4_CREATE_EXCLUSIVE4_1 = 3 358}; 359 360enum limit_by4 { 361 NFS4_LIMIT_SIZE = 1, 362 NFS4_LIMIT_BLOCKS = 2 363}; 364 365enum open_delegation_type4 { 366 NFS4_OPEN_DELEGATE_NONE = 0, 367 NFS4_OPEN_DELEGATE_READ = 1, 368 NFS4_OPEN_DELEGATE_WRITE = 2, 369 NFS4_OPEN_DELEGATE_NONE_EXT = 3, /* 4.1 */ 370}; 371 372enum why_no_delegation4 { /* new to v4.1 */ 373 WND4_NOT_WANTED = 0, 374 WND4_CONTENTION = 1, 375 WND4_RESOURCE = 2, 376 WND4_NOT_SUPP_FTYPE = 3, 377 WND4_WRITE_DELEG_NOT_SUPP_FTYPE = 4, 378 WND4_NOT_SUPP_UPGRADE = 5, 379 WND4_NOT_SUPP_DOWNGRADE = 6, 380 WND4_CANCELLED = 7, 381 WND4_IS_DIR = 8, 382}; 383 384enum lock_type4 { 385 NFS4_UNLOCK_LT = 0, 386 NFS4_READ_LT = 1, 387 NFS4_WRITE_LT = 2, 388 NFS4_READW_LT = 3, 389 NFS4_WRITEW_LT = 4 390}; 391 392/* 393 * Symbol names and values are from RFC 7531 Section 2. 394 * "XDR Description of NFSv4.0" 395 */ 396enum { 397 FATTR4_SUPPORTED_ATTRS = 0, 398 FATTR4_TYPE = 1, 399 FATTR4_FH_EXPIRE_TYPE = 2, 400 FATTR4_CHANGE = 3, 401 FATTR4_SIZE = 4, 402 FATTR4_LINK_SUPPORT = 5, 403 FATTR4_SYMLINK_SUPPORT = 6, 404 FATTR4_NAMED_ATTR = 7, 405 FATTR4_FSID = 8, 406 FATTR4_UNIQUE_HANDLES = 9, 407 FATTR4_LEASE_TIME = 10, 408 FATTR4_RDATTR_ERROR = 11, 409 FATTR4_ACL = 12, 410 FATTR4_ACLSUPPORT = 13, 411 FATTR4_ARCHIVE = 14, 412 FATTR4_CANSETTIME = 15, 413 FATTR4_CASE_INSENSITIVE = 16, 414 FATTR4_CASE_PRESERVING = 17, 415 FATTR4_CHOWN_RESTRICTED = 18, 416 FATTR4_FILEHANDLE = 19, 417 FATTR4_FILEID = 20, 418 FATTR4_FILES_AVAIL = 21, 419 FATTR4_FILES_FREE = 22, 420 FATTR4_FILES_TOTAL = 23, 421 FATTR4_FS_LOCATIONS = 24, 422 FATTR4_HIDDEN = 25, 423 FATTR4_HOMOGENEOUS = 26, 424 FATTR4_MAXFILESIZE = 27, 425 FATTR4_MAXLINK = 28, 426 FATTR4_MAXNAME = 29, 427 FATTR4_MAXREAD = 30, 428 FATTR4_MAXWRITE = 31, 429 FATTR4_MIMETYPE = 32, 430 FATTR4_MODE = 33, 431 FATTR4_NO_TRUNC = 34, 432 FATTR4_NUMLINKS = 35, 433 FATTR4_OWNER = 36, 434 FATTR4_OWNER_GROUP = 37, 435 FATTR4_QUOTA_AVAIL_HARD = 38, 436 FATTR4_QUOTA_AVAIL_SOFT = 39, 437 FATTR4_QUOTA_USED = 40, 438 FATTR4_RAWDEV = 41, 439 FATTR4_SPACE_AVAIL = 42, 440 FATTR4_SPACE_FREE = 43, 441 FATTR4_SPACE_TOTAL = 44, 442 FATTR4_SPACE_USED = 45, 443 FATTR4_SYSTEM = 46, 444 FATTR4_TIME_ACCESS = 47, 445 FATTR4_TIME_ACCESS_SET = 48, 446 FATTR4_TIME_BACKUP = 49, 447 FATTR4_TIME_CREATE = 50, 448 FATTR4_TIME_DELTA = 51, 449 FATTR4_TIME_METADATA = 52, 450 FATTR4_TIME_MODIFY = 53, 451 FATTR4_TIME_MODIFY_SET = 54, 452 FATTR4_MOUNTED_ON_FILEID = 55, 453}; 454 455/* 456 * Symbol names and values are from RFC 5662 Section 2. 457 * "XDR Description of NFSv4.1" 458 */ 459enum { 460 FATTR4_DIR_NOTIF_DELAY = 56, 461 FATTR4_DIRENT_NOTIF_DELAY = 57, 462 FATTR4_DACL = 58, 463 FATTR4_SACL = 59, 464 FATTR4_CHANGE_POLICY = 60, 465 FATTR4_FS_STATUS = 61, 466 FATTR4_FS_LAYOUT_TYPES = 62, 467 FATTR4_LAYOUT_HINT = 63, 468 FATTR4_LAYOUT_TYPES = 64, 469 FATTR4_LAYOUT_BLKSIZE = 65, 470 FATTR4_LAYOUT_ALIGNMENT = 66, 471 FATTR4_FS_LOCATIONS_INFO = 67, 472 FATTR4_MDSTHRESHOLD = 68, 473 FATTR4_RETENTION_GET = 69, 474 FATTR4_RETENTION_SET = 70, 475 FATTR4_RETENTEVT_GET = 71, 476 FATTR4_RETENTEVT_SET = 72, 477 FATTR4_RETENTION_HOLD = 73, 478 FATTR4_MODE_SET_MASKED = 74, 479 FATTR4_SUPPATTR_EXCLCREAT = 75, 480 FATTR4_FS_CHARSET_CAP = 76, 481}; 482 483/* 484 * Symbol names and values are from RFC 7863 Section 2. 485 * "XDR Description of NFSv4.2" 486 */ 487enum { 488 FATTR4_CLONE_BLKSIZE = 77, 489 FATTR4_SPACE_FREED = 78, 490 FATTR4_CHANGE_ATTR_TYPE = 79, 491 FATTR4_SEC_LABEL = 80, 492}; 493 494/* 495 * Symbol names and values are from RFC 8275 Section 5. 496 * "The mode_umask Attribute" 497 */ 498enum { 499 FATTR4_MODE_UMASK = 81, 500}; 501 502/* 503 * Symbol names and values are from RFC 8276 Section 8.6. 504 * "Numeric Values Assigned to Protocol Extensions" 505 */ 506enum { 507 FATTR4_XATTR_SUPPORT = 82, 508}; 509 510/* 511 * The following internal definitions enable processing the above 512 * attribute bits within 32-bit word boundaries. 513 */ 514 515/* Mandatory Attributes */ 516#define FATTR4_WORD0_SUPPORTED_ATTRS BIT(FATTR4_SUPPORTED_ATTRS) 517#define FATTR4_WORD0_TYPE BIT(FATTR4_TYPE) 518#define FATTR4_WORD0_FH_EXPIRE_TYPE BIT(FATTR4_FH_EXPIRE_TYPE) 519#define FATTR4_WORD0_CHANGE BIT(FATTR4_CHANGE) 520#define FATTR4_WORD0_SIZE BIT(FATTR4_SIZE) 521#define FATTR4_WORD0_LINK_SUPPORT BIT(FATTR4_LINK_SUPPORT) 522#define FATTR4_WORD0_SYMLINK_SUPPORT BIT(FATTR4_SYMLINK_SUPPORT) 523#define FATTR4_WORD0_NAMED_ATTR BIT(FATTR4_NAMED_ATTR) 524#define FATTR4_WORD0_FSID BIT(FATTR4_FSID) 525#define FATTR4_WORD0_UNIQUE_HANDLES BIT(FATTR4_UNIQUE_HANDLES) 526#define FATTR4_WORD0_LEASE_TIME BIT(FATTR4_LEASE_TIME) 527#define FATTR4_WORD0_RDATTR_ERROR BIT(FATTR4_RDATTR_ERROR) 528/* Mandatory in NFSv4.1 */ 529#define FATTR4_WORD2_SUPPATTR_EXCLCREAT BIT(FATTR4_SUPPATTR_EXCLCREAT - 64) 530 531/* Recommended Attributes */ 532#define FATTR4_WORD0_ACL BIT(FATTR4_ACL) 533#define FATTR4_WORD0_ACLSUPPORT BIT(FATTR4_ACLSUPPORT) 534#define FATTR4_WORD0_ARCHIVE BIT(FATTR4_ARCHIVE) 535#define FATTR4_WORD0_CANSETTIME BIT(FATTR4_CANSETTIME) 536#define FATTR4_WORD0_CASE_INSENSITIVE BIT(FATTR4_CASE_INSENSITIVE) 537#define FATTR4_WORD0_CASE_PRESERVING BIT(FATTR4_CASE_PRESERVING) 538#define FATTR4_WORD0_CHOWN_RESTRICTED BIT(FATTR4_CHOWN_RESTRICTED) 539#define FATTR4_WORD0_FILEHANDLE BIT(FATTR4_FILEHANDLE) 540#define FATTR4_WORD0_FILEID BIT(FATTR4_FILEID) 541#define FATTR4_WORD0_FILES_AVAIL BIT(FATTR4_FILES_AVAIL) 542#define FATTR4_WORD0_FILES_FREE BIT(FATTR4_FILES_FREE) 543#define FATTR4_WORD0_FILES_TOTAL BIT(FATTR4_FILES_TOTAL) 544#define FATTR4_WORD0_FS_LOCATIONS BIT(FATTR4_FS_LOCATIONS) 545#define FATTR4_WORD0_HIDDEN BIT(FATTR4_HIDDEN) 546#define FATTR4_WORD0_HOMOGENEOUS BIT(FATTR4_HOMOGENEOUS) 547#define FATTR4_WORD0_MAXFILESIZE BIT(FATTR4_MAXFILESIZE) 548#define FATTR4_WORD0_MAXLINK BIT(FATTR4_MAXLINK) 549#define FATTR4_WORD0_MAXNAME BIT(FATTR4_MAXNAME) 550#define FATTR4_WORD0_MAXREAD BIT(FATTR4_MAXREAD) 551#define FATTR4_WORD0_MAXWRITE BIT(FATTR4_MAXWRITE) 552 553#define FATTR4_WORD1_MIMETYPE BIT(FATTR4_MIMETYPE - 32) 554#define FATTR4_WORD1_MODE BIT(FATTR4_MODE - 32) 555#define FATTR4_WORD1_NO_TRUNC BIT(FATTR4_NO_TRUNC - 32) 556#define FATTR4_WORD1_NUMLINKS BIT(FATTR4_NUMLINKS - 32) 557#define FATTR4_WORD1_OWNER BIT(FATTR4_OWNER - 32) 558#define FATTR4_WORD1_OWNER_GROUP BIT(FATTR4_OWNER_GROUP - 32) 559#define FATTR4_WORD1_QUOTA_HARD BIT(FATTR4_QUOTA_AVAIL_HARD - 32) 560#define FATTR4_WORD1_QUOTA_SOFT BIT(FATTR4_QUOTA_AVAIL_SOFT - 32) 561#define FATTR4_WORD1_QUOTA_USED BIT(FATTR4_QUOTA_USED - 32) 562#define FATTR4_WORD1_RAWDEV BIT(FATTR4_RAWDEV - 32) 563#define FATTR4_WORD1_SPACE_AVAIL BIT(FATTR4_SPACE_AVAIL - 32) 564#define FATTR4_WORD1_SPACE_FREE BIT(FATTR4_SPACE_FREE - 32) 565#define FATTR4_WORD1_SPACE_TOTAL BIT(FATTR4_SPACE_TOTAL - 32) 566#define FATTR4_WORD1_SPACE_USED BIT(FATTR4_SPACE_USED - 32) 567#define FATTR4_WORD1_SYSTEM BIT(FATTR4_SYSTEM - 32) 568#define FATTR4_WORD1_TIME_ACCESS BIT(FATTR4_TIME_ACCESS - 32) 569#define FATTR4_WORD1_TIME_ACCESS_SET BIT(FATTR4_TIME_ACCESS_SET - 32) 570#define FATTR4_WORD1_TIME_BACKUP BIT(FATTR4_TIME_BACKUP - 32) 571#define FATTR4_WORD1_TIME_CREATE BIT(FATTR4_TIME_CREATE - 32) 572#define FATTR4_WORD1_TIME_DELTA BIT(FATTR4_TIME_DELTA - 32) 573#define FATTR4_WORD1_TIME_METADATA BIT(FATTR4_TIME_METADATA - 32) 574#define FATTR4_WORD1_TIME_MODIFY BIT(FATTR4_TIME_MODIFY - 32) 575#define FATTR4_WORD1_TIME_MODIFY_SET BIT(FATTR4_TIME_MODIFY_SET - 32) 576#define FATTR4_WORD1_MOUNTED_ON_FILEID BIT(FATTR4_MOUNTED_ON_FILEID - 32) 577#define FATTR4_WORD1_DACL BIT(FATTR4_DACL - 32) 578#define FATTR4_WORD1_SACL BIT(FATTR4_SACL - 32) 579#define FATTR4_WORD1_FS_LAYOUT_TYPES BIT(FATTR4_FS_LAYOUT_TYPES - 32) 580 581#define FATTR4_WORD2_LAYOUT_TYPES BIT(FATTR4_LAYOUT_TYPES - 64) 582#define FATTR4_WORD2_LAYOUT_BLKSIZE BIT(FATTR4_LAYOUT_BLKSIZE - 64) 583#define FATTR4_WORD2_MDSTHRESHOLD BIT(FATTR4_MDSTHRESHOLD - 64) 584#define FATTR4_WORD2_CLONE_BLKSIZE BIT(FATTR4_CLONE_BLKSIZE - 64) 585#define FATTR4_WORD2_CHANGE_ATTR_TYPE BIT(FATTR4_CHANGE_ATTR_TYPE - 64) 586#define FATTR4_WORD2_SECURITY_LABEL BIT(FATTR4_SEC_LABEL - 64) 587#define FATTR4_WORD2_MODE_UMASK BIT(FATTR4_MODE_UMASK - 64) 588#define FATTR4_WORD2_XATTR_SUPPORT BIT(FATTR4_XATTR_SUPPORT - 64) 589 590/* MDS threshold bitmap bits */ 591#define THRESHOLD_RD (1UL << 0) 592#define THRESHOLD_WR (1UL << 1) 593#define THRESHOLD_RD_IO (1UL << 2) 594#define THRESHOLD_WR_IO (1UL << 3) 595 596#define NFSPROC4_NULL 0 597#define NFSPROC4_COMPOUND 1 598#define NFS4_VERSION 4 599#define NFS4_MINOR_VERSION 0 600 601#define NFS4_DEBUG 1 602 603/* 604 * Index of predefined Linux client operations 605 * 606 * To ensure that /proc/net/rpc/nfs remains correctly ordered, please 607 * append only to this enum when adding new client operations. 608 */ 609 610enum { 611 NFSPROC4_CLNT_NULL = 0, /* Unused */ 612 NFSPROC4_CLNT_READ, 613 NFSPROC4_CLNT_WRITE, 614 NFSPROC4_CLNT_COMMIT, 615 NFSPROC4_CLNT_OPEN, 616 NFSPROC4_CLNT_OPEN_CONFIRM, 617 NFSPROC4_CLNT_OPEN_NOATTR, 618 NFSPROC4_CLNT_OPEN_DOWNGRADE, 619 NFSPROC4_CLNT_CLOSE, 620 NFSPROC4_CLNT_SETATTR, 621 NFSPROC4_CLNT_FSINFO, 622 NFSPROC4_CLNT_RENEW, 623 NFSPROC4_CLNT_SETCLIENTID, 624 NFSPROC4_CLNT_SETCLIENTID_CONFIRM, 625 NFSPROC4_CLNT_LOCK, 626 NFSPROC4_CLNT_LOCKT, 627 NFSPROC4_CLNT_LOCKU, 628 NFSPROC4_CLNT_ACCESS, 629 NFSPROC4_CLNT_GETATTR, 630 NFSPROC4_CLNT_LOOKUP, 631 NFSPROC4_CLNT_LOOKUP_ROOT, 632 NFSPROC4_CLNT_REMOVE, 633 NFSPROC4_CLNT_RENAME, 634 NFSPROC4_CLNT_LINK, 635 NFSPROC4_CLNT_SYMLINK, 636 NFSPROC4_CLNT_CREATE, 637 NFSPROC4_CLNT_PATHCONF, 638 NFSPROC4_CLNT_STATFS, 639 NFSPROC4_CLNT_READLINK, 640 NFSPROC4_CLNT_READDIR, 641 NFSPROC4_CLNT_SERVER_CAPS, 642 NFSPROC4_CLNT_DELEGRETURN, 643 NFSPROC4_CLNT_GETACL, 644 NFSPROC4_CLNT_SETACL, 645 NFSPROC4_CLNT_FS_LOCATIONS, 646 NFSPROC4_CLNT_RELEASE_LOCKOWNER, 647 NFSPROC4_CLNT_SECINFO, 648 NFSPROC4_CLNT_FSID_PRESENT, 649 650 NFSPROC4_CLNT_EXCHANGE_ID, 651 NFSPROC4_CLNT_CREATE_SESSION, 652 NFSPROC4_CLNT_DESTROY_SESSION, 653 NFSPROC4_CLNT_SEQUENCE, 654 NFSPROC4_CLNT_GET_LEASE_TIME, 655 NFSPROC4_CLNT_RECLAIM_COMPLETE, 656 NFSPROC4_CLNT_LAYOUTGET, 657 NFSPROC4_CLNT_GETDEVICEINFO, 658 NFSPROC4_CLNT_LAYOUTCOMMIT, 659 NFSPROC4_CLNT_LAYOUTRETURN, 660 NFSPROC4_CLNT_SECINFO_NO_NAME, 661 NFSPROC4_CLNT_TEST_STATEID, 662 NFSPROC4_CLNT_FREE_STATEID, 663 NFSPROC4_CLNT_GETDEVICELIST, 664 NFSPROC4_CLNT_BIND_CONN_TO_SESSION, 665 NFSPROC4_CLNT_DESTROY_CLIENTID, 666 667 NFSPROC4_CLNT_SEEK, 668 NFSPROC4_CLNT_ALLOCATE, 669 NFSPROC4_CLNT_DEALLOCATE, 670 NFSPROC4_CLNT_LAYOUTSTATS, 671 NFSPROC4_CLNT_CLONE, 672 NFSPROC4_CLNT_COPY, 673 NFSPROC4_CLNT_OFFLOAD_CANCEL, 674 675 NFSPROC4_CLNT_LOOKUPP, 676 NFSPROC4_CLNT_LAYOUTERROR, 677 NFSPROC4_CLNT_COPY_NOTIFY, 678 679 NFSPROC4_CLNT_GETXATTR, 680 NFSPROC4_CLNT_SETXATTR, 681 NFSPROC4_CLNT_LISTXATTRS, 682 NFSPROC4_CLNT_REMOVEXATTR, 683 NFSPROC4_CLNT_READ_PLUS, 684}; 685 686/* nfs41 types */ 687struct nfs4_sessionid { 688 unsigned char data[NFS4_MAX_SESSIONID_LEN]; 689}; 690 691/* Create Session Flags */ 692#define SESSION4_PERSIST 0x001 693#define SESSION4_BACK_CHAN 0x002 694#define SESSION4_RDMA 0x004 695 696#define SESSION4_FLAG_MASK_A 0x007 697 698enum state_protect_how4 { 699 SP4_NONE = 0, 700 SP4_MACH_CRED = 1, 701 SP4_SSV = 2 702}; 703 704enum pnfs_layouttype { 705 LAYOUT_NFSV4_1_FILES = 1, 706 LAYOUT_OSD2_OBJECTS = 2, 707 LAYOUT_BLOCK_VOLUME = 3, 708 LAYOUT_FLEX_FILES = 4, 709 LAYOUT_SCSI = 5, 710 LAYOUT_TYPE_MAX 711}; 712 713/* used for both layout return and recall */ 714enum pnfs_layoutreturn_type { 715 RETURN_FILE = 1, 716 RETURN_FSID = 2, 717 RETURN_ALL = 3 718}; 719 720enum pnfs_iomode { 721 IOMODE_READ = 1, 722 IOMODE_RW = 2, 723 IOMODE_ANY = 3, 724}; 725 726enum pnfs_notify_deviceid_type4 { 727 NOTIFY_DEVICEID4_CHANGE = 1 << 1, 728 NOTIFY_DEVICEID4_DELETE = 1 << 2, 729}; 730 731enum pnfs_block_volume_type { 732 PNFS_BLOCK_VOLUME_SIMPLE = 0, 733 PNFS_BLOCK_VOLUME_SLICE = 1, 734 PNFS_BLOCK_VOLUME_CONCAT = 2, 735 PNFS_BLOCK_VOLUME_STRIPE = 3, 736 PNFS_BLOCK_VOLUME_SCSI = 4, 737}; 738 739enum pnfs_block_extent_state { 740 PNFS_BLOCK_READWRITE_DATA = 0, 741 PNFS_BLOCK_READ_DATA = 1, 742 PNFS_BLOCK_INVALID_DATA = 2, 743 PNFS_BLOCK_NONE_DATA = 3, 744}; 745 746/* on the wire size of a block layout extent */ 747#define PNFS_BLOCK_EXTENT_SIZE \ 748 (7 * sizeof(__be32) + NFS4_DEVICEID4_SIZE) 749 750/* on the wire size of a scsi commit range */ 751#define PNFS_SCSI_RANGE_SIZE \ 752 (4 * sizeof(__be32)) 753 754enum scsi_code_set { 755 PS_CODE_SET_BINARY = 1, 756 PS_CODE_SET_ASCII = 2, 757 PS_CODE_SET_UTF8 = 3 758}; 759 760enum scsi_designator_type { 761 PS_DESIGNATOR_T10 = 1, 762 PS_DESIGNATOR_EUI64 = 2, 763 PS_DESIGNATOR_NAA = 3, 764 PS_DESIGNATOR_NAME = 8 765}; 766 767#define NFL4_UFLG_MASK 0x0000003F 768#define NFL4_UFLG_DENSE 0x00000001 769#define NFL4_UFLG_COMMIT_THRU_MDS 0x00000002 770#define NFL4_UFLG_STRIPE_UNIT_SIZE_MASK 0xFFFFFFC0 771 772/* Encoded in the loh_body field of type layouthint4 */ 773enum filelayout_hint_care4 { 774 NFLH4_CARE_DENSE = NFL4_UFLG_DENSE, 775 NFLH4_CARE_COMMIT_THRU_MDS = NFL4_UFLG_COMMIT_THRU_MDS, 776 NFLH4_CARE_STRIPE_UNIT_SIZE = 0x00000040, 777 NFLH4_CARE_STRIPE_COUNT = 0x00000080 778}; 779 780#define NFS4_DEVICEID4_SIZE 16 781 782struct nfs4_deviceid { 783 char data[NFS4_DEVICEID4_SIZE]; 784}; 785 786enum data_content4 { 787 NFS4_CONTENT_DATA = 0, 788 NFS4_CONTENT_HOLE = 1, 789}; 790 791enum pnfs_update_layout_reason { 792 PNFS_UPDATE_LAYOUT_UNKNOWN = 0, 793 PNFS_UPDATE_LAYOUT_NO_PNFS, 794 PNFS_UPDATE_LAYOUT_RD_ZEROLEN, 795 PNFS_UPDATE_LAYOUT_MDSTHRESH, 796 PNFS_UPDATE_LAYOUT_NOMEM, 797 PNFS_UPDATE_LAYOUT_BULK_RECALL, 798 PNFS_UPDATE_LAYOUT_IO_TEST_FAIL, 799 PNFS_UPDATE_LAYOUT_FOUND_CACHED, 800 PNFS_UPDATE_LAYOUT_RETURN, 801 PNFS_UPDATE_LAYOUT_RETRY, 802 PNFS_UPDATE_LAYOUT_BLOCKED, 803 PNFS_UPDATE_LAYOUT_INVALID_OPEN, 804 PNFS_UPDATE_LAYOUT_SEND_LAYOUTGET, 805 PNFS_UPDATE_LAYOUT_EXIT, 806}; 807 808#define NFS4_OP_MAP_NUM_LONGS \ 809 DIV_ROUND_UP(LAST_NFS4_OP, 8 * sizeof(unsigned long)) 810#define NFS4_OP_MAP_NUM_WORDS \ 811 (NFS4_OP_MAP_NUM_LONGS * sizeof(unsigned long) / sizeof(u32)) 812struct nfs4_op_map { 813 union { 814 unsigned long longs[NFS4_OP_MAP_NUM_LONGS]; 815 u32 words[NFS4_OP_MAP_NUM_WORDS]; 816 } u; 817}; 818 819struct nfs42_netaddr { 820 char netid[RPCBIND_MAXNETIDLEN]; 821 char addr[RPCBIND_MAXUADDRLEN + 1]; 822 u32 netid_len; 823 u32 addr_len; 824}; 825 826enum netloc_type4 { 827 NL4_NAME = 1, 828 NL4_URL = 2, 829 NL4_NETADDR = 3, 830}; 831 832struct nl4_server { 833 enum netloc_type4 nl4_type; 834 union { 835 struct { /* NL4_NAME, NL4_URL */ 836 int nl4_str_sz; 837 char nl4_str[NFS4_OPAQUE_LIMIT + 1]; 838 }; 839 struct nfs42_netaddr nl4_addr; /* NL4_NETADDR */ 840 } u; 841}; 842 843enum nfs4_change_attr_type { 844 NFS4_CHANGE_TYPE_IS_MONOTONIC_INCR = 0, 845 NFS4_CHANGE_TYPE_IS_VERSION_COUNTER = 1, 846 NFS4_CHANGE_TYPE_IS_VERSION_COUNTER_NOPNFS = 2, 847 NFS4_CHANGE_TYPE_IS_TIME_METADATA = 3, 848 NFS4_CHANGE_TYPE_IS_UNDEFINED = 4, 849}; 850 851/* 852 * Options for setxattr. These match the flags for setxattr(2). 853 */ 854enum nfs4_setxattr_options { 855 SETXATTR4_EITHER = 0, 856 SETXATTR4_CREATE = 1, 857 SETXATTR4_REPLACE = 2, 858}; 859 860enum { 861 RCA4_TYPE_MASK_RDATA_DLG = 0, 862 RCA4_TYPE_MASK_WDATA_DLG = 1, 863 RCA4_TYPE_MASK_DIR_DLG = 2, 864 RCA4_TYPE_MASK_FILE_LAYOUT = 3, 865 RCA4_TYPE_MASK_BLK_LAYOUT = 4, 866 RCA4_TYPE_MASK_OBJ_LAYOUT_MIN = 8, 867 RCA4_TYPE_MASK_OBJ_LAYOUT_MAX = 9, 868 RCA4_TYPE_MASK_OTHER_LAYOUT_MIN = 12, 869 RCA4_TYPE_MASK_OTHER_LAYOUT_MAX = 15, 870}; 871 872enum nfs_cb_opnum4 { 873 OP_CB_GETATTR = 3, 874 OP_CB_RECALL = 4, 875 876 /* Callback operations new to NFSv4.1 */ 877 OP_CB_LAYOUTRECALL = 5, 878 OP_CB_NOTIFY = 6, 879 OP_CB_PUSH_DELEG = 7, 880 OP_CB_RECALL_ANY = 8, 881 OP_CB_RECALLABLE_OBJ_AVAIL = 9, 882 OP_CB_RECALL_SLOT = 10, 883 OP_CB_SEQUENCE = 11, 884 OP_CB_WANTS_CANCELLED = 12, 885 OP_CB_NOTIFY_LOCK = 13, 886 OP_CB_NOTIFY_DEVICEID = 14, 887 888 /* Callback operations new to NFSv4.2 */ 889 OP_CB_OFFLOAD = 15, 890 891 OP_CB_ILLEGAL = 10044, 892}; 893 894#endif 895