pnfs.h 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524
  1. /*
  2. * pNFS client data structures.
  3. *
  4. * Copyright (c) 2002
  5. * The Regents of the University of Michigan
  6. * All Rights Reserved
  7. *
  8. * Dean Hildebrand <dhildebz@umich.edu>
  9. *
  10. * Permission is granted to use, copy, create derivative works, and
  11. * redistribute this software and such derivative works for any purpose,
  12. * so long as the name of the University of Michigan is not used in
  13. * any advertising or publicity pertaining to the use or distribution
  14. * of this software without specific, written prior authorization. If
  15. * the above copyright notice or any other identification of the
  16. * University of Michigan is included in any copy of any portion of
  17. * this software, then the disclaimer below must also be included.
  18. *
  19. * This software is provided as is, without representation or warranty
  20. * of any kind either express or implied, including without limitation
  21. * the implied warranties of merchantability, fitness for a particular
  22. * purpose, or noninfringement. The Regents of the University of
  23. * Michigan shall not be liable for any damages, including special,
  24. * indirect, incidental, or consequential damages, with respect to any
  25. * claim arising out of or in connection with the use of the software,
  26. * even if it has been or is hereafter advised of the possibility of
  27. * such damages.
  28. */
  29. #ifndef FS_NFS_PNFS_H
  30. #define FS_NFS_PNFS_H
  31. #include <linux/nfs_fs.h>
  32. #include <linux/nfs_page.h>
  33. enum {
  34. NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */
  35. NFS_LSEG_ROC, /* roc bit received from server */
  36. NFS_LSEG_LAYOUTCOMMIT, /* layoutcommit bit set for layoutcommit */
  37. };
  38. struct pnfs_layout_segment {
  39. struct list_head pls_list;
  40. struct list_head pls_lc_list;
  41. struct pnfs_layout_range pls_range;
  42. atomic_t pls_refcount;
  43. unsigned long pls_flags;
  44. struct pnfs_layout_hdr *pls_layout;
  45. };
  46. enum pnfs_try_status {
  47. PNFS_ATTEMPTED = 0,
  48. PNFS_NOT_ATTEMPTED = 1,
  49. };
  50. #ifdef CONFIG_NFS_V4_1
  51. #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
  52. enum {
  53. NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
  54. NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
  55. NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
  56. NFS_LAYOUT_ROC, /* some lseg had roc bit set */
  57. NFS_LAYOUT_RETURN, /* Return this layout ASAP */
  58. };
  59. enum layoutdriver_policy_flags {
  60. /* Should the pNFS client commit and return the layout upon a setattr */
  61. PNFS_LAYOUTRET_ON_SETATTR = 1 << 0,
  62. PNFS_LAYOUTRET_ON_ERROR = 1 << 1,
  63. };
  64. struct nfs4_deviceid_node;
  65. /* Per-layout driver specific registration structure */
  66. struct pnfs_layoutdriver_type {
  67. struct list_head pnfs_tblid;
  68. const u32 id;
  69. const char *name;
  70. struct module *owner;
  71. unsigned flags;
  72. int (*set_layoutdriver) (struct nfs_server *, const struct nfs_fh *);
  73. int (*clear_layoutdriver) (struct nfs_server *);
  74. struct pnfs_layout_hdr * (*alloc_layout_hdr) (struct inode *inode, gfp_t gfp_flags);
  75. void (*free_layout_hdr) (struct pnfs_layout_hdr *);
  76. struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr, gfp_t gfp_flags);
  77. void (*free_lseg) (struct pnfs_layout_segment *lseg);
  78. /* test for nfs page cache coalescing */
  79. const struct nfs_pageio_ops *pg_read_ops;
  80. const struct nfs_pageio_ops *pg_write_ops;
  81. struct pnfs_ds_commit_info *(*get_ds_info) (struct inode *inode);
  82. void (*mark_request_commit) (struct nfs_page *req,
  83. struct pnfs_layout_segment *lseg,
  84. struct nfs_commit_info *cinfo);
  85. void (*clear_request_commit) (struct nfs_page *req,
  86. struct nfs_commit_info *cinfo);
  87. int (*scan_commit_lists) (struct nfs_commit_info *cinfo,
  88. int max);
  89. void (*recover_commit_reqs) (struct list_head *list,
  90. struct nfs_commit_info *cinfo);
  91. int (*commit_pagelist)(struct inode *inode,
  92. struct list_head *mds_pages,
  93. int how,
  94. struct nfs_commit_info *cinfo);
  95. /*
  96. * Return PNFS_ATTEMPTED to indicate the layout code has attempted
  97. * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
  98. */
  99. enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
  100. enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
  101. void (*free_deviceid_node) (struct nfs4_deviceid_node *);
  102. void (*encode_layoutreturn) (struct pnfs_layout_hdr *layoutid,
  103. struct xdr_stream *xdr,
  104. const struct nfs4_layoutreturn_args *args);
  105. void (*cleanup_layoutcommit) (struct nfs4_layoutcommit_data *data);
  106. void (*encode_layoutcommit) (struct pnfs_layout_hdr *layoutid,
  107. struct xdr_stream *xdr,
  108. const struct nfs4_layoutcommit_args *args);
  109. };
  110. struct pnfs_layout_hdr {
  111. atomic_t plh_refcount;
  112. struct list_head plh_layouts; /* other client layouts */
  113. struct list_head plh_bulk_destroy;
  114. struct list_head plh_segs; /* layout segments list */
  115. nfs4_stateid plh_stateid;
  116. atomic_t plh_outstanding; /* number of RPCs out */
  117. unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
  118. u32 plh_barrier; /* ignore lower seqids */
  119. unsigned long plh_retry_timestamp;
  120. unsigned long plh_flags;
  121. loff_t plh_lwb; /* last write byte for layoutcommit */
  122. struct rpc_cred *plh_lc_cred; /* layoutcommit cred */
  123. struct inode *plh_inode;
  124. };
  125. struct pnfs_device {
  126. struct nfs4_deviceid dev_id;
  127. unsigned int layout_type;
  128. unsigned int mincount;
  129. struct page **pages;
  130. unsigned int pgbase;
  131. unsigned int pglen;
  132. };
  133. #define NFS4_PNFS_GETDEVLIST_MAXNUM 16
  134. struct pnfs_devicelist {
  135. unsigned int eof;
  136. unsigned int num_devs;
  137. struct nfs4_deviceid dev_id[NFS4_PNFS_GETDEVLIST_MAXNUM];
  138. };
  139. extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
  140. extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
  141. /* nfs4proc.c */
  142. extern int nfs4_proc_getdevicelist(struct nfs_server *server,
  143. const struct nfs_fh *fh,
  144. struct pnfs_devicelist *devlist);
  145. extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
  146. struct pnfs_device *dev,
  147. struct rpc_cred *cred);
  148. extern struct pnfs_layout_segment* nfs4_proc_layoutget(struct nfs4_layoutget *lgp, gfp_t gfp_flags);
  149. extern int nfs4_proc_layoutreturn(struct nfs4_layoutreturn *lrp);
  150. /* pnfs.c */
  151. void pnfs_get_layout_hdr(struct pnfs_layout_hdr *lo);
  152. void pnfs_put_lseg(struct pnfs_layout_segment *lseg);
  153. void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *,
  154. const struct nfs_pgio_completion_ops *);
  155. void pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *,
  156. int, const struct nfs_pgio_completion_ops *);
  157. void set_pnfs_layoutdriver(struct nfs_server *, const struct nfs_fh *, u32);
  158. void unset_pnfs_layoutdriver(struct nfs_server *);
  159. void pnfs_generic_pg_init_read(struct nfs_pageio_descriptor *, struct nfs_page *);
  160. int pnfs_generic_pg_readpages(struct nfs_pageio_descriptor *desc);
  161. void pnfs_generic_pg_init_write(struct nfs_pageio_descriptor *pgio,
  162. struct nfs_page *req, u64 wb_size);
  163. int pnfs_generic_pg_writepages(struct nfs_pageio_descriptor *desc);
  164. bool pnfs_generic_pg_test(struct nfs_pageio_descriptor *pgio, struct nfs_page *prev, struct nfs_page *req);
  165. void pnfs_set_lo_fail(struct pnfs_layout_segment *lseg);
  166. struct pnfs_layout_segment *pnfs_layout_process(struct nfs4_layoutget *lgp);
  167. void pnfs_free_lseg_list(struct list_head *tmp_list);
  168. void pnfs_destroy_layout(struct nfs_inode *);
  169. void pnfs_destroy_all_layouts(struct nfs_client *);
  170. int pnfs_destroy_layouts_byfsid(struct nfs_client *clp,
  171. struct nfs_fsid *fsid,
  172. bool is_recall);
  173. int pnfs_destroy_layouts_byclid(struct nfs_client *clp,
  174. bool is_recall);
  175. void pnfs_put_layout_hdr(struct pnfs_layout_hdr *lo);
  176. void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
  177. const nfs4_stateid *new,
  178. bool update_barrier);
  179. int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
  180. struct pnfs_layout_hdr *lo,
  181. struct nfs4_state *open_state);
  182. int pnfs_mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
  183. struct list_head *tmp_list,
  184. struct pnfs_layout_range *recall_range);
  185. bool pnfs_roc(struct inode *ino);
  186. void pnfs_roc_release(struct inode *ino);
  187. void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
  188. bool pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task);
  189. void pnfs_set_layoutcommit(struct nfs_write_data *wdata);
  190. void pnfs_cleanup_layoutcommit(struct nfs4_layoutcommit_data *data);
  191. int pnfs_layoutcommit_inode(struct inode *inode, bool sync);
  192. int _pnfs_return_layout(struct inode *);
  193. int pnfs_commit_and_return_layout(struct inode *);
  194. void pnfs_ld_write_done(struct nfs_write_data *);
  195. void pnfs_ld_read_done(struct nfs_read_data *);
  196. struct pnfs_layout_segment *pnfs_update_layout(struct inode *ino,
  197. struct nfs_open_context *ctx,
  198. loff_t pos,
  199. u64 count,
  200. enum pnfs_iomode iomode,
  201. gfp_t gfp_flags);
  202. void nfs4_deviceid_mark_client_invalid(struct nfs_client *clp);
  203. int pnfs_read_done_resend_to_mds(struct inode *inode, struct list_head *head,
  204. const struct nfs_pgio_completion_ops *compl_ops,
  205. struct nfs_direct_req *dreq);
  206. int pnfs_write_done_resend_to_mds(struct inode *inode, struct list_head *head,
  207. const struct nfs_pgio_completion_ops *compl_ops,
  208. struct nfs_direct_req *dreq);
  209. struct nfs4_threshold *pnfs_mdsthreshold_alloc(void);
  210. /* nfs4_deviceid_flags */
  211. enum {
  212. NFS_DEVICEID_INVALID = 0, /* set when MDS clientid recalled */
  213. NFS_DEVICEID_UNAVAILABLE, /* device temporarily unavailable */
  214. };
  215. /* pnfs_dev.c */
  216. struct nfs4_deviceid_node {
  217. struct hlist_node node;
  218. struct hlist_node tmpnode;
  219. const struct pnfs_layoutdriver_type *ld;
  220. const struct nfs_client *nfs_client;
  221. unsigned long flags;
  222. unsigned long timestamp_unavailable;
  223. struct nfs4_deviceid deviceid;
  224. atomic_t ref;
  225. };
  226. struct nfs4_deviceid_node *nfs4_find_get_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
  227. void nfs4_delete_deviceid(const struct pnfs_layoutdriver_type *, const struct nfs_client *, const struct nfs4_deviceid *);
  228. void nfs4_init_deviceid_node(struct nfs4_deviceid_node *,
  229. const struct pnfs_layoutdriver_type *,
  230. const struct nfs_client *,
  231. const struct nfs4_deviceid *);
  232. struct nfs4_deviceid_node *nfs4_insert_deviceid_node(struct nfs4_deviceid_node *);
  233. bool nfs4_put_deviceid_node(struct nfs4_deviceid_node *);
  234. void nfs4_mark_deviceid_unavailable(struct nfs4_deviceid_node *node);
  235. bool nfs4_test_deviceid_unavailable(struct nfs4_deviceid_node *node);
  236. void nfs4_deviceid_purge_client(const struct nfs_client *);
  237. static inline struct pnfs_layout_segment *
  238. pnfs_get_lseg(struct pnfs_layout_segment *lseg)
  239. {
  240. if (lseg) {
  241. atomic_inc(&lseg->pls_refcount);
  242. smp_mb__after_atomic_inc();
  243. }
  244. return lseg;
  245. }
  246. /* Return true if a layout driver is being used for this mountpoint */
  247. static inline int pnfs_enabled_sb(struct nfs_server *nfss)
  248. {
  249. return nfss->pnfs_curr_ld != NULL;
  250. }
  251. static inline int
  252. pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
  253. struct nfs_commit_info *cinfo)
  254. {
  255. if (cinfo->ds == NULL || cinfo->ds->ncommitting == 0)
  256. return PNFS_NOT_ATTEMPTED;
  257. return NFS_SERVER(inode)->pnfs_curr_ld->commit_pagelist(inode, mds_pages, how, cinfo);
  258. }
  259. static inline struct pnfs_ds_commit_info *
  260. pnfs_get_ds_info(struct inode *inode)
  261. {
  262. struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
  263. if (ld == NULL || ld->get_ds_info == NULL)
  264. return NULL;
  265. return ld->get_ds_info(inode);
  266. }
  267. static inline bool
  268. pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
  269. struct nfs_commit_info *cinfo)
  270. {
  271. struct inode *inode = req->wb_context->dentry->d_inode;
  272. struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
  273. if (lseg == NULL || ld->mark_request_commit == NULL)
  274. return false;
  275. ld->mark_request_commit(req, lseg, cinfo);
  276. return true;
  277. }
  278. static inline bool
  279. pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
  280. {
  281. struct inode *inode = req->wb_context->dentry->d_inode;
  282. struct pnfs_layoutdriver_type *ld = NFS_SERVER(inode)->pnfs_curr_ld;
  283. if (ld == NULL || ld->clear_request_commit == NULL)
  284. return false;
  285. ld->clear_request_commit(req, cinfo);
  286. return true;
  287. }
  288. static inline int
  289. pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
  290. int max)
  291. {
  292. if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
  293. return 0;
  294. else
  295. return NFS_SERVER(inode)->pnfs_curr_ld->scan_commit_lists(cinfo, max);
  296. }
  297. static inline void
  298. pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
  299. struct nfs_commit_info *cinfo)
  300. {
  301. if (cinfo->ds == NULL || cinfo->ds->nwritten == 0)
  302. return;
  303. NFS_SERVER(inode)->pnfs_curr_ld->recover_commit_reqs(list, cinfo);
  304. }
  305. /* Should the pNFS client commit and return the layout upon a setattr */
  306. static inline bool
  307. pnfs_ld_layoutret_on_setattr(struct inode *inode)
  308. {
  309. if (!pnfs_enabled_sb(NFS_SERVER(inode)))
  310. return false;
  311. return NFS_SERVER(inode)->pnfs_curr_ld->flags &
  312. PNFS_LAYOUTRET_ON_SETATTR;
  313. }
  314. static inline int pnfs_return_layout(struct inode *ino)
  315. {
  316. struct nfs_inode *nfsi = NFS_I(ino);
  317. struct nfs_server *nfss = NFS_SERVER(ino);
  318. if (pnfs_enabled_sb(nfss) && nfsi->layout)
  319. return _pnfs_return_layout(ino);
  320. return 0;
  321. }
  322. static inline bool
  323. pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
  324. struct nfs_server *nfss)
  325. {
  326. return (dst && src && src->bm != 0 && nfss->pnfs_curr_ld &&
  327. nfss->pnfs_curr_ld->id == src->l_type);
  328. }
  329. #ifdef NFS_DEBUG
  330. void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id);
  331. #else
  332. static inline void nfs4_print_deviceid(const struct nfs4_deviceid *dev_id)
  333. {
  334. }
  335. #endif /* NFS_DEBUG */
  336. #else /* CONFIG_NFS_V4_1 */
  337. static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
  338. {
  339. }
  340. static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
  341. {
  342. }
  343. static inline struct pnfs_layout_segment *
  344. pnfs_get_lseg(struct pnfs_layout_segment *lseg)
  345. {
  346. return NULL;
  347. }
  348. static inline void pnfs_put_lseg(struct pnfs_layout_segment *lseg)
  349. {
  350. }
  351. static inline int pnfs_return_layout(struct inode *ino)
  352. {
  353. return 0;
  354. }
  355. static inline int pnfs_commit_and_return_layout(struct inode *inode)
  356. {
  357. return 0;
  358. }
  359. static inline bool
  360. pnfs_ld_layoutret_on_setattr(struct inode *inode)
  361. {
  362. return false;
  363. }
  364. static inline bool
  365. pnfs_roc(struct inode *ino)
  366. {
  367. return false;
  368. }
  369. static inline void
  370. pnfs_roc_release(struct inode *ino)
  371. {
  372. }
  373. static inline void
  374. pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
  375. {
  376. }
  377. static inline bool
  378. pnfs_roc_drain(struct inode *ino, u32 *barrier, struct rpc_task *task)
  379. {
  380. return false;
  381. }
  382. static inline void set_pnfs_layoutdriver(struct nfs_server *s,
  383. const struct nfs_fh *mntfh, u32 id)
  384. {
  385. }
  386. static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
  387. {
  388. }
  389. static inline void pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *inode,
  390. const struct nfs_pgio_completion_ops *compl_ops)
  391. {
  392. nfs_pageio_init_read(pgio, inode, compl_ops);
  393. }
  394. static inline void pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *inode, int ioflags,
  395. const struct nfs_pgio_completion_ops *compl_ops)
  396. {
  397. nfs_pageio_init_write(pgio, inode, ioflags, compl_ops);
  398. }
  399. static inline int
  400. pnfs_commit_list(struct inode *inode, struct list_head *mds_pages, int how,
  401. struct nfs_commit_info *cinfo)
  402. {
  403. return PNFS_NOT_ATTEMPTED;
  404. }
  405. static inline struct pnfs_ds_commit_info *
  406. pnfs_get_ds_info(struct inode *inode)
  407. {
  408. return NULL;
  409. }
  410. static inline bool
  411. pnfs_mark_request_commit(struct nfs_page *req, struct pnfs_layout_segment *lseg,
  412. struct nfs_commit_info *cinfo)
  413. {
  414. return false;
  415. }
  416. static inline bool
  417. pnfs_clear_request_commit(struct nfs_page *req, struct nfs_commit_info *cinfo)
  418. {
  419. return false;
  420. }
  421. static inline int
  422. pnfs_scan_commit_lists(struct inode *inode, struct nfs_commit_info *cinfo,
  423. int max)
  424. {
  425. return 0;
  426. }
  427. static inline void
  428. pnfs_recover_commit_reqs(struct inode *inode, struct list_head *list,
  429. struct nfs_commit_info *cinfo)
  430. {
  431. }
  432. static inline int pnfs_layoutcommit_inode(struct inode *inode, bool sync)
  433. {
  434. return 0;
  435. }
  436. static inline bool
  437. pnfs_use_threshold(struct nfs4_threshold **dst, struct nfs4_threshold *src,
  438. struct nfs_server *nfss)
  439. {
  440. return false;
  441. }
  442. static inline struct nfs4_threshold *pnfs_mdsthreshold_alloc(void)
  443. {
  444. return NULL;
  445. }
  446. #endif /* CONFIG_NFS_V4_1 */
  447. #endif /* FS_NFS_PNFS_H */