2 * pNFS client data structures.
5 * The Regents of the University of Michigan
8 * Dean Hildebrand <dhildebz@umich.edu>
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.
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
33 #include <linux/nfs_page.h>
36 NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */
37 NFS_LSEG_ROC, /* roc bit received from server */
40 struct pnfs_layout_segment {
41 struct list_head pls_list;
42 struct pnfs_layout_range pls_range;
43 atomic_t pls_refcount;
44 unsigned long pls_flags;
45 struct pnfs_layout_hdr *pls_layout;
48 enum pnfs_try_status {
50 PNFS_NOT_ATTEMPTED = 1,
53 #ifdef CONFIG_NFS_V4_1
55 #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
58 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
59 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
60 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
61 NFS_LAYOUT_ROC, /* some lseg had roc bit set */
62 NFS_LAYOUT_DESTROYED, /* no new use of layout allowed */
65 /* Per-layout driver specific registration structure */
66 struct pnfs_layoutdriver_type {
67 struct list_head pnfs_tblid;
71 int (*set_layoutdriver) (struct nfs_server *);
72 int (*clear_layoutdriver) (struct nfs_server *);
73 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr);
74 void (*free_lseg) (struct pnfs_layout_segment *lseg);
76 /* test for nfs page cache coalescing */
77 int (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *);
80 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
81 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
83 enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data);
86 struct pnfs_layout_hdr {
87 atomic_t plh_refcount;
88 struct list_head plh_layouts; /* other client layouts */
89 struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
90 struct list_head plh_segs; /* layout segments list */
91 nfs4_stateid plh_stateid;
92 atomic_t plh_outstanding; /* number of RPCs out */
93 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
94 u32 plh_barrier; /* ignore lower seqids */
95 unsigned long plh_flags;
96 struct inode *plh_inode;
100 struct nfs4_deviceid dev_id;
101 unsigned int layout_type;
102 unsigned int mincount;
110 * Device ID RCU cache. A device ID is unique per client ID and layout type.
112 #define NFS4_DEVICE_ID_HASH_BITS 5
113 #define NFS4_DEVICE_ID_HASH_SIZE (1 << NFS4_DEVICE_ID_HASH_BITS)
114 #define NFS4_DEVICE_ID_HASH_MASK (NFS4_DEVICE_ID_HASH_SIZE - 1)
117 nfs4_deviceid_hash(struct nfs4_deviceid *id)
119 unsigned char *cptr = (unsigned char *)id->data;
120 unsigned int nbytes = NFS4_DEVICEID4_SIZE;
127 return x & NFS4_DEVICE_ID_HASH_MASK;
130 struct pnfs_deviceid_node {
131 struct hlist_node de_node;
132 struct nfs4_deviceid de_id;
136 struct pnfs_deviceid_cache {
139 void (*dc_free_callback)(struct pnfs_deviceid_node *);
140 struct hlist_head dc_deviceids[NFS4_DEVICE_ID_HASH_SIZE];
143 extern int pnfs_alloc_init_deviceid_cache(struct nfs_client *,
144 void (*free_callback)(struct pnfs_deviceid_node *));
145 extern void pnfs_put_deviceid_cache(struct nfs_client *);
146 extern struct pnfs_deviceid_node *pnfs_find_get_deviceid(
147 struct pnfs_deviceid_cache *,
148 struct nfs4_deviceid *);
149 extern struct pnfs_deviceid_node *pnfs_add_deviceid(
150 struct pnfs_deviceid_cache *,
151 struct pnfs_deviceid_node *);
152 extern void pnfs_put_deviceid(struct pnfs_deviceid_cache *c,
153 struct pnfs_deviceid_node *devid);
155 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
156 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
159 extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
160 struct pnfs_device *dev);
161 extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
164 void get_layout_hdr(struct pnfs_layout_hdr *lo);
165 void put_lseg(struct pnfs_layout_segment *lseg);
166 struct pnfs_layout_segment *
167 pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
168 enum pnfs_iomode access_type);
169 void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
170 void unset_pnfs_layoutdriver(struct nfs_server *);
171 enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *,
172 const struct rpc_call_ops *);
173 void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *);
174 int pnfs_layout_process(struct nfs4_layoutget *lgp);
175 void pnfs_free_lseg_list(struct list_head *tmp_list);
176 void pnfs_destroy_layout(struct nfs_inode *);
177 void pnfs_destroy_all_layouts(struct nfs_client *);
178 void put_layout_hdr(struct pnfs_layout_hdr *lo);
179 void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
180 const nfs4_stateid *new,
181 bool update_barrier);
182 int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
183 struct pnfs_layout_hdr *lo,
184 struct nfs4_state *open_state);
185 int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
186 struct list_head *tmp_list,
188 bool pnfs_roc(struct inode *ino);
189 void pnfs_roc_release(struct inode *ino);
190 void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
191 bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
194 static inline int lo_fail_bit(u32 iomode)
196 return iomode == IOMODE_RW ?
197 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
200 static inline struct pnfs_layout_segment *
201 get_lseg(struct pnfs_layout_segment *lseg)
204 atomic_inc(&lseg->pls_refcount);
205 smp_mb__after_atomic_inc();
210 /* Return true if a layout driver is being used for this mountpoint */
211 static inline int pnfs_enabled_sb(struct nfs_server *nfss)
213 return nfss->pnfs_curr_ld != NULL;
216 #else /* CONFIG_NFS_V4_1 */
218 static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
222 static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
226 static inline struct pnfs_layout_segment *
227 get_lseg(struct pnfs_layout_segment *lseg)
232 static inline void put_lseg(struct pnfs_layout_segment *lseg)
236 static inline struct pnfs_layout_segment *
237 pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
238 enum pnfs_iomode access_type)
243 static inline enum pnfs_try_status
244 pnfs_try_to_read_data(struct nfs_read_data *data,
245 const struct rpc_call_ops *call_ops)
247 return PNFS_NOT_ATTEMPTED;
251 pnfs_roc(struct inode *ino)
257 pnfs_roc_release(struct inode *ino)
262 pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
267 pnfs_roc_drain(struct inode *ino, u32 *barrier)
272 static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
276 static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
281 pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *ino)
283 pgio->pg_test = NULL;
286 #endif /* CONFIG_NFS_V4_1 */
288 #endif /* FS_NFS_PNFS_H */