nfs4.h 12 KB

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