nfsd.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341
  1. /*
  2. * Hodge-podge collection of knfsd-related stuff.
  3. * I will sort this out later.
  4. *
  5. * Copyright (C) 1995-1997 Olaf Kirch <okir@monad.swb.de>
  6. */
  7. #ifndef LINUX_NFSD_NFSD_H
  8. #define LINUX_NFSD_NFSD_H
  9. #include <linux/types.h>
  10. #include <linux/mount.h>
  11. #include <linux/nfsd/debug.h>
  12. #include <linux/nfsd/export.h>
  13. #include <linux/nfsd/stats.h>
  14. /*
  15. * nfsd version
  16. */
  17. #define NFSD_SUPPORTED_MINOR_VERSION 1
  18. struct readdir_cd {
  19. __be32 err; /* 0, nfserr, or nfserr_eof */
  20. };
  21. extern struct svc_program nfsd_program;
  22. extern struct svc_version nfsd_version2, nfsd_version3,
  23. nfsd_version4;
  24. extern u32 nfsd_supported_minorversion;
  25. extern struct mutex nfsd_mutex;
  26. extern struct svc_serv *nfsd_serv;
  27. extern spinlock_t nfsd_drc_lock;
  28. extern unsigned int nfsd_drc_max_mem;
  29. extern unsigned int nfsd_drc_mem_used;
  30. extern const struct seq_operations nfs_exports_op;
  31. /*
  32. * Function prototypes.
  33. */
  34. int nfsd_svc(unsigned short port, int nrservs);
  35. int nfsd_dispatch(struct svc_rqst *rqstp, __be32 *statp);
  36. int nfsd_nrthreads(void);
  37. int nfsd_nrpools(void);
  38. int nfsd_get_nrthreads(int n, int *);
  39. int nfsd_set_nrthreads(int n, int *);
  40. #if defined(CONFIG_NFSD_V2_ACL) || defined(CONFIG_NFSD_V3_ACL)
  41. #ifdef CONFIG_NFSD_V2_ACL
  42. extern struct svc_version nfsd_acl_version2;
  43. #else
  44. #define nfsd_acl_version2 NULL
  45. #endif
  46. #ifdef CONFIG_NFSD_V3_ACL
  47. extern struct svc_version nfsd_acl_version3;
  48. #else
  49. #define nfsd_acl_version3 NULL
  50. #endif
  51. #endif
  52. enum vers_op {NFSD_SET, NFSD_CLEAR, NFSD_TEST, NFSD_AVAIL };
  53. int nfsd_vers(int vers, enum vers_op change);
  54. int nfsd_minorversion(u32 minorversion, enum vers_op change);
  55. void nfsd_reset_versions(void);
  56. int nfsd_create_serv(void);
  57. extern int nfsd_max_blksize;
  58. static inline int nfsd_v4client(struct svc_rqst *rq)
  59. {
  60. return rq->rq_prog == NFS_PROGRAM && rq->rq_vers == 4;
  61. }
  62. /*
  63. * NFSv4 State
  64. */
  65. #ifdef CONFIG_NFSD_V4
  66. extern unsigned int max_delegations;
  67. int nfs4_state_init(void);
  68. void nfsd4_free_slabs(void);
  69. int nfs4_state_start(void);
  70. void nfs4_state_shutdown(void);
  71. void nfs4_reset_lease(time_t leasetime);
  72. int nfs4_reset_recoverydir(char *recdir);
  73. #else
  74. static inline int nfs4_state_init(void) { return 0; }
  75. static inline void nfsd4_free_slabs(void) { }
  76. static inline int nfs4_state_start(void) { return 0; }
  77. static inline void nfs4_state_shutdown(void) { }
  78. static inline void nfs4_reset_lease(time_t leasetime) { }
  79. static inline int nfs4_reset_recoverydir(char *recdir) { return 0; }
  80. #endif
  81. /*
  82. * lockd binding
  83. */
  84. void nfsd_lockd_init(void);
  85. void nfsd_lockd_shutdown(void);
  86. /*
  87. * These macros provide pre-xdr'ed values for faster operation.
  88. */
  89. #define nfs_ok cpu_to_be32(NFS_OK)
  90. #define nfserr_perm cpu_to_be32(NFSERR_PERM)
  91. #define nfserr_noent cpu_to_be32(NFSERR_NOENT)
  92. #define nfserr_io cpu_to_be32(NFSERR_IO)
  93. #define nfserr_nxio cpu_to_be32(NFSERR_NXIO)
  94. #define nfserr_eagain cpu_to_be32(NFSERR_EAGAIN)
  95. #define nfserr_acces cpu_to_be32(NFSERR_ACCES)
  96. #define nfserr_exist cpu_to_be32(NFSERR_EXIST)
  97. #define nfserr_xdev cpu_to_be32(NFSERR_XDEV)
  98. #define nfserr_nodev cpu_to_be32(NFSERR_NODEV)
  99. #define nfserr_notdir cpu_to_be32(NFSERR_NOTDIR)
  100. #define nfserr_isdir cpu_to_be32(NFSERR_ISDIR)
  101. #define nfserr_inval cpu_to_be32(NFSERR_INVAL)
  102. #define nfserr_fbig cpu_to_be32(NFSERR_FBIG)
  103. #define nfserr_nospc cpu_to_be32(NFSERR_NOSPC)
  104. #define nfserr_rofs cpu_to_be32(NFSERR_ROFS)
  105. #define nfserr_mlink cpu_to_be32(NFSERR_MLINK)
  106. #define nfserr_opnotsupp cpu_to_be32(NFSERR_OPNOTSUPP)
  107. #define nfserr_nametoolong cpu_to_be32(NFSERR_NAMETOOLONG)
  108. #define nfserr_notempty cpu_to_be32(NFSERR_NOTEMPTY)
  109. #define nfserr_dquot cpu_to_be32(NFSERR_DQUOT)
  110. #define nfserr_stale cpu_to_be32(NFSERR_STALE)
  111. #define nfserr_remote cpu_to_be32(NFSERR_REMOTE)
  112. #define nfserr_wflush cpu_to_be32(NFSERR_WFLUSH)
  113. #define nfserr_badhandle cpu_to_be32(NFSERR_BADHANDLE)
  114. #define nfserr_notsync cpu_to_be32(NFSERR_NOT_SYNC)
  115. #define nfserr_badcookie cpu_to_be32(NFSERR_BAD_COOKIE)
  116. #define nfserr_notsupp cpu_to_be32(NFSERR_NOTSUPP)
  117. #define nfserr_toosmall cpu_to_be32(NFSERR_TOOSMALL)
  118. #define nfserr_serverfault cpu_to_be32(NFSERR_SERVERFAULT)
  119. #define nfserr_badtype cpu_to_be32(NFSERR_BADTYPE)
  120. #define nfserr_jukebox cpu_to_be32(NFSERR_JUKEBOX)
  121. #define nfserr_denied cpu_to_be32(NFSERR_DENIED)
  122. #define nfserr_deadlock cpu_to_be32(NFSERR_DEADLOCK)
  123. #define nfserr_expired cpu_to_be32(NFSERR_EXPIRED)
  124. #define nfserr_bad_cookie cpu_to_be32(NFSERR_BAD_COOKIE)
  125. #define nfserr_same cpu_to_be32(NFSERR_SAME)
  126. #define nfserr_clid_inuse cpu_to_be32(NFSERR_CLID_INUSE)
  127. #define nfserr_stale_clientid cpu_to_be32(NFSERR_STALE_CLIENTID)
  128. #define nfserr_resource cpu_to_be32(NFSERR_RESOURCE)
  129. #define nfserr_moved cpu_to_be32(NFSERR_MOVED)
  130. #define nfserr_nofilehandle cpu_to_be32(NFSERR_NOFILEHANDLE)
  131. #define nfserr_minor_vers_mismatch cpu_to_be32(NFSERR_MINOR_VERS_MISMATCH)
  132. #define nfserr_share_denied cpu_to_be32(NFSERR_SHARE_DENIED)
  133. #define nfserr_stale_stateid cpu_to_be32(NFSERR_STALE_STATEID)
  134. #define nfserr_old_stateid cpu_to_be32(NFSERR_OLD_STATEID)
  135. #define nfserr_bad_stateid cpu_to_be32(NFSERR_BAD_STATEID)
  136. #define nfserr_bad_seqid cpu_to_be32(NFSERR_BAD_SEQID)
  137. #define nfserr_symlink cpu_to_be32(NFSERR_SYMLINK)
  138. #define nfserr_not_same cpu_to_be32(NFSERR_NOT_SAME)
  139. #define nfserr_lock_range cpu_to_be32(NFSERR_LOCK_RANGE)
  140. #define nfserr_restorefh cpu_to_be32(NFSERR_RESTOREFH)
  141. #define nfserr_attrnotsupp cpu_to_be32(NFSERR_ATTRNOTSUPP)
  142. #define nfserr_bad_xdr cpu_to_be32(NFSERR_BAD_XDR)
  143. #define nfserr_openmode cpu_to_be32(NFSERR_OPENMODE)
  144. #define nfserr_badowner cpu_to_be32(NFSERR_BADOWNER)
  145. #define nfserr_locks_held cpu_to_be32(NFSERR_LOCKS_HELD)
  146. #define nfserr_op_illegal cpu_to_be32(NFSERR_OP_ILLEGAL)
  147. #define nfserr_grace cpu_to_be32(NFSERR_GRACE)
  148. #define nfserr_no_grace cpu_to_be32(NFSERR_NO_GRACE)
  149. #define nfserr_reclaim_bad cpu_to_be32(NFSERR_RECLAIM_BAD)
  150. #define nfserr_badname cpu_to_be32(NFSERR_BADNAME)
  151. #define nfserr_cb_path_down cpu_to_be32(NFSERR_CB_PATH_DOWN)
  152. #define nfserr_locked cpu_to_be32(NFSERR_LOCKED)
  153. #define nfserr_wrongsec cpu_to_be32(NFSERR_WRONGSEC)
  154. #define nfserr_badiomode cpu_to_be32(NFS4ERR_BADIOMODE)
  155. #define nfserr_badlayout cpu_to_be32(NFS4ERR_BADLAYOUT)
  156. #define nfserr_bad_session_digest cpu_to_be32(NFS4ERR_BAD_SESSION_DIGEST)
  157. #define nfserr_badsession cpu_to_be32(NFS4ERR_BADSESSION)
  158. #define nfserr_badslot cpu_to_be32(NFS4ERR_BADSLOT)
  159. #define nfserr_complete_already cpu_to_be32(NFS4ERR_COMPLETE_ALREADY)
  160. #define nfserr_conn_not_bound_to_session cpu_to_be32(NFS4ERR_CONN_NOT_BOUND_TO_SESSION)
  161. #define nfserr_deleg_already_wanted cpu_to_be32(NFS4ERR_DELEG_ALREADY_WANTED)
  162. #define nfserr_back_chan_busy cpu_to_be32(NFS4ERR_BACK_CHAN_BUSY)
  163. #define nfserr_layouttrylater cpu_to_be32(NFS4ERR_LAYOUTTRYLATER)
  164. #define nfserr_layoutunavailable cpu_to_be32(NFS4ERR_LAYOUTUNAVAILABLE)
  165. #define nfserr_nomatching_layout cpu_to_be32(NFS4ERR_NOMATCHING_LAYOUT)
  166. #define nfserr_recallconflict cpu_to_be32(NFS4ERR_RECALLCONFLICT)
  167. #define nfserr_unknown_layouttype cpu_to_be32(NFS4ERR_UNKNOWN_LAYOUTTYPE)
  168. #define nfserr_seq_misordered cpu_to_be32(NFS4ERR_SEQ_MISORDERED)
  169. #define nfserr_sequence_pos cpu_to_be32(NFS4ERR_SEQUENCE_POS)
  170. #define nfserr_req_too_big cpu_to_be32(NFS4ERR_REQ_TOO_BIG)
  171. #define nfserr_rep_too_big cpu_to_be32(NFS4ERR_REP_TOO_BIG)
  172. #define nfserr_rep_too_big_to_cache cpu_to_be32(NFS4ERR_REP_TOO_BIG_TO_CACHE)
  173. #define nfserr_retry_uncached_rep cpu_to_be32(NFS4ERR_RETRY_UNCACHED_REP)
  174. #define nfserr_unsafe_compound cpu_to_be32(NFS4ERR_UNSAFE_COMPOUND)
  175. #define nfserr_too_many_ops cpu_to_be32(NFS4ERR_TOO_MANY_OPS)
  176. #define nfserr_op_not_in_session cpu_to_be32(NFS4ERR_OP_NOT_IN_SESSION)
  177. #define nfserr_hash_alg_unsupp cpu_to_be32(NFS4ERR_HASH_ALG_UNSUPP)
  178. #define nfserr_clientid_busy cpu_to_be32(NFS4ERR_CLIENTID_BUSY)
  179. #define nfserr_pnfs_io_hole cpu_to_be32(NFS4ERR_PNFS_IO_HOLE)
  180. #define nfserr_seq_false_retry cpu_to_be32(NFS4ERR_SEQ_FALSE_RETRY)
  181. #define nfserr_bad_high_slot cpu_to_be32(NFS4ERR_BAD_HIGH_SLOT)
  182. #define nfserr_deadsession cpu_to_be32(NFS4ERR_DEADSESSION)
  183. #define nfserr_encr_alg_unsupp cpu_to_be32(NFS4ERR_ENCR_ALG_UNSUPP)
  184. #define nfserr_pnfs_no_layout cpu_to_be32(NFS4ERR_PNFS_NO_LAYOUT)
  185. #define nfserr_not_only_op cpu_to_be32(NFS4ERR_NOT_ONLY_OP)
  186. #define nfserr_wrong_cred cpu_to_be32(NFS4ERR_WRONG_CRED)
  187. #define nfserr_wrong_type cpu_to_be32(NFS4ERR_WRONG_TYPE)
  188. #define nfserr_dirdeleg_unavail cpu_to_be32(NFS4ERR_DIRDELEG_UNAVAIL)
  189. #define nfserr_reject_deleg cpu_to_be32(NFS4ERR_REJECT_DELEG)
  190. #define nfserr_returnconflict cpu_to_be32(NFS4ERR_RETURNCONFLICT)
  191. #define nfserr_deleg_revoked cpu_to_be32(NFS4ERR_DELEG_REVOKED)
  192. /* error codes for internal use */
  193. /* if a request fails due to kmalloc failure, it gets dropped.
  194. * Client should resend eventually
  195. */
  196. #define nfserr_dropit cpu_to_be32(30000)
  197. /* end-of-file indicator in readdir */
  198. #define nfserr_eof cpu_to_be32(30001)
  199. /* replay detected */
  200. #define nfserr_replay_me cpu_to_be32(11001)
  201. /* nfs41 replay detected */
  202. #define nfserr_replay_cache cpu_to_be32(11002)
  203. /* Check for dir entries '.' and '..' */
  204. #define isdotent(n, l) (l < 3 && n[0] == '.' && (l == 1 || n[1] == '.'))
  205. /*
  206. * Time of server startup
  207. */
  208. extern struct timeval nfssvc_boot;
  209. #ifdef CONFIG_NFSD_V4
  210. extern time_t nfsd4_lease;
  211. extern time_t nfsd4_grace;
  212. /* before processing a COMPOUND operation, we have to check that there
  213. * is enough space in the buffer for XDR encode to succeed. otherwise,
  214. * we might process an operation with side effects, and be unable to
  215. * tell the client that the operation succeeded.
  216. *
  217. * COMPOUND_SLACK_SPACE - this is the minimum bytes of buffer space
  218. * needed to encode an "ordinary" _successful_ operation. (GETATTR,
  219. * READ, READDIR, and READLINK have their own buffer checks.) if we
  220. * fall below this level, we fail the next operation with NFS4ERR_RESOURCE.
  221. *
  222. * COMPOUND_ERR_SLACK_SPACE - this is the minimum bytes of buffer space
  223. * needed to encode an operation which has failed with NFS4ERR_RESOURCE.
  224. * care is taken to ensure that we never fall below this level for any
  225. * reason.
  226. */
  227. #define COMPOUND_SLACK_SPACE 140 /* OP_GETFH */
  228. #define COMPOUND_ERR_SLACK_SPACE 12 /* OP_SETATTR */
  229. #define NFSD_LAUNDROMAT_MINTIMEOUT 1 /* seconds */
  230. /*
  231. * The following attributes are currently not supported by the NFSv4 server:
  232. * ARCHIVE (deprecated anyway)
  233. * HIDDEN (unlikely to be supported any time soon)
  234. * MIMETYPE (unlikely to be supported any time soon)
  235. * QUOTA_* (will be supported in a forthcoming patch)
  236. * SYSTEM (unlikely to be supported any time soon)
  237. * TIME_BACKUP (unlikely to be supported any time soon)
  238. * TIME_CREATE (unlikely to be supported any time soon)
  239. */
  240. #define NFSD4_SUPPORTED_ATTRS_WORD0 \
  241. (FATTR4_WORD0_SUPPORTED_ATTRS | FATTR4_WORD0_TYPE | FATTR4_WORD0_FH_EXPIRE_TYPE \
  242. | FATTR4_WORD0_CHANGE | FATTR4_WORD0_SIZE | FATTR4_WORD0_LINK_SUPPORT \
  243. | FATTR4_WORD0_SYMLINK_SUPPORT | FATTR4_WORD0_NAMED_ATTR | FATTR4_WORD0_FSID \
  244. | FATTR4_WORD0_UNIQUE_HANDLES | FATTR4_WORD0_LEASE_TIME | FATTR4_WORD0_RDATTR_ERROR \
  245. | FATTR4_WORD0_ACLSUPPORT | FATTR4_WORD0_CANSETTIME | FATTR4_WORD0_CASE_INSENSITIVE \
  246. | FATTR4_WORD0_CASE_PRESERVING | FATTR4_WORD0_CHOWN_RESTRICTED \
  247. | FATTR4_WORD0_FILEHANDLE | FATTR4_WORD0_FILEID | FATTR4_WORD0_FILES_AVAIL \
  248. | FATTR4_WORD0_FILES_FREE | FATTR4_WORD0_FILES_TOTAL | FATTR4_WORD0_FS_LOCATIONS | FATTR4_WORD0_HOMOGENEOUS \
  249. | FATTR4_WORD0_MAXFILESIZE | FATTR4_WORD0_MAXLINK | FATTR4_WORD0_MAXNAME \
  250. | FATTR4_WORD0_MAXREAD | FATTR4_WORD0_MAXWRITE | FATTR4_WORD0_ACL)
  251. #define NFSD4_SUPPORTED_ATTRS_WORD1 \
  252. (FATTR4_WORD1_MODE | FATTR4_WORD1_NO_TRUNC | FATTR4_WORD1_NUMLINKS \
  253. | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP | FATTR4_WORD1_RAWDEV \
  254. | FATTR4_WORD1_SPACE_AVAIL | FATTR4_WORD1_SPACE_FREE | FATTR4_WORD1_SPACE_TOTAL \
  255. | FATTR4_WORD1_SPACE_USED | FATTR4_WORD1_TIME_ACCESS | FATTR4_WORD1_TIME_ACCESS_SET \
  256. | FATTR4_WORD1_TIME_DELTA | FATTR4_WORD1_TIME_METADATA \
  257. | FATTR4_WORD1_TIME_MODIFY | FATTR4_WORD1_TIME_MODIFY_SET | FATTR4_WORD1_MOUNTED_ON_FILEID)
  258. #define NFSD4_SUPPORTED_ATTRS_WORD2 0
  259. #define NFSD4_1_SUPPORTED_ATTRS_WORD0 \
  260. NFSD4_SUPPORTED_ATTRS_WORD0
  261. #define NFSD4_1_SUPPORTED_ATTRS_WORD1 \
  262. NFSD4_SUPPORTED_ATTRS_WORD1
  263. #define NFSD4_1_SUPPORTED_ATTRS_WORD2 \
  264. (NFSD4_SUPPORTED_ATTRS_WORD2 | FATTR4_WORD2_SUPPATTR_EXCLCREAT)
  265. static inline u32 nfsd_suppattrs0(u32 minorversion)
  266. {
  267. return minorversion ? NFSD4_1_SUPPORTED_ATTRS_WORD0
  268. : NFSD4_SUPPORTED_ATTRS_WORD0;
  269. }
  270. static inline u32 nfsd_suppattrs1(u32 minorversion)
  271. {
  272. return minorversion ? NFSD4_1_SUPPORTED_ATTRS_WORD1
  273. : NFSD4_SUPPORTED_ATTRS_WORD1;
  274. }
  275. static inline u32 nfsd_suppattrs2(u32 minorversion)
  276. {
  277. return minorversion ? NFSD4_1_SUPPORTED_ATTRS_WORD2
  278. : NFSD4_SUPPORTED_ATTRS_WORD2;
  279. }
  280. /* These will return ERR_INVAL if specified in GETATTR or READDIR. */
  281. #define NFSD_WRITEONLY_ATTRS_WORD1 \
  282. (FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)
  283. /* These are the only attrs allowed in CREATE/OPEN/SETATTR. */
  284. #define NFSD_WRITEABLE_ATTRS_WORD0 \
  285. (FATTR4_WORD0_SIZE | FATTR4_WORD0_ACL )
  286. #define NFSD_WRITEABLE_ATTRS_WORD1 \
  287. (FATTR4_WORD1_MODE | FATTR4_WORD1_OWNER | FATTR4_WORD1_OWNER_GROUP \
  288. | FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET)
  289. #define NFSD_WRITEABLE_ATTRS_WORD2 0
  290. #define NFSD_SUPPATTR_EXCLCREAT_WORD0 \
  291. NFSD_WRITEABLE_ATTRS_WORD0
  292. /*
  293. * we currently store the exclusive create verifier in the v_{a,m}time
  294. * attributes so the client can't set these at create time using EXCLUSIVE4_1
  295. */
  296. #define NFSD_SUPPATTR_EXCLCREAT_WORD1 \
  297. (NFSD_WRITEABLE_ATTRS_WORD1 & \
  298. ~(FATTR4_WORD1_TIME_ACCESS_SET | FATTR4_WORD1_TIME_MODIFY_SET))
  299. #define NFSD_SUPPATTR_EXCLCREAT_WORD2 \
  300. NFSD_WRITEABLE_ATTRS_WORD2
  301. #endif /* CONFIG_NFSD_V4 */
  302. #endif /* LINUX_NFSD_NFSD_H */