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 struct pnfs_layout_segment
* (*alloc_lseg
) (struct pnfs_layout_hdr
*layoutid
, struct nfs4_layoutget_res
*lgr
);
72 void (*free_lseg
) (struct pnfs_layout_segment
*lseg
);
74 /* test for nfs page cache coalescing */
75 int (*pg_test
)(struct nfs_pageio_descriptor
*, struct nfs_page
*, struct nfs_page
*);
78 * Return PNFS_ATTEMPTED to indicate the layout code has attempted
79 * I/O, else return PNFS_NOT_ATTEMPTED to fall back to normal NFS
81 enum pnfs_try_status (*read_pagelist
) (struct nfs_read_data
*nfs_data
);
82 enum pnfs_try_status (*write_pagelist
) (struct nfs_write_data
*nfs_data
, int how
);
85 struct pnfs_layout_hdr
{
86 atomic_t plh_refcount
;
87 struct list_head plh_layouts
; /* other client layouts */
88 struct list_head plh_bulk_recall
; /* clnt list of bulk recalls */
89 struct list_head plh_segs
; /* layout segments list */
90 nfs4_stateid plh_stateid
;
91 atomic_t plh_outstanding
; /* number of RPCs out */
92 unsigned long plh_block_lgets
; /* block LAYOUTGET if >0 */
93 u32 plh_barrier
; /* ignore lower seqids */
94 unsigned long plh_flags
;
95 struct inode
*plh_inode
;
99 struct nfs4_deviceid dev_id
;
100 unsigned int layout_type
;
101 unsigned int mincount
;
108 extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type
*);
109 extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type
*);
112 extern int nfs4_proc_getdeviceinfo(struct nfs_server
*server
,
113 struct pnfs_device
*dev
);
114 extern int nfs4_proc_layoutget(struct nfs4_layoutget
*lgp
);
117 void get_layout_hdr(struct pnfs_layout_hdr
*lo
);
118 void put_lseg(struct pnfs_layout_segment
*lseg
);
119 struct pnfs_layout_segment
*
120 pnfs_update_layout(struct inode
*ino
, struct nfs_open_context
*ctx
,
121 enum pnfs_iomode access_type
);
122 void set_pnfs_layoutdriver(struct nfs_server
*, u32 id
);
123 void unset_pnfs_layoutdriver(struct nfs_server
*);
124 enum pnfs_try_status
pnfs_try_to_write_data(struct nfs_write_data
*,
125 const struct rpc_call_ops
*, int);
126 enum pnfs_try_status
pnfs_try_to_read_data(struct nfs_read_data
*,
127 const struct rpc_call_ops
*);
128 void pnfs_pageio_init_read(struct nfs_pageio_descriptor
*, struct inode
*);
129 void pnfs_pageio_init_write(struct nfs_pageio_descriptor
*, struct inode
*);
130 int pnfs_layout_process(struct nfs4_layoutget
*lgp
);
131 void pnfs_free_lseg_list(struct list_head
*tmp_list
);
132 void pnfs_destroy_layout(struct nfs_inode
*);
133 void pnfs_destroy_all_layouts(struct nfs_client
*);
134 void put_layout_hdr(struct pnfs_layout_hdr
*lo
);
135 void pnfs_set_layout_stateid(struct pnfs_layout_hdr
*lo
,
136 const nfs4_stateid
*new,
137 bool update_barrier
);
138 int pnfs_choose_layoutget_stateid(nfs4_stateid
*dst
,
139 struct pnfs_layout_hdr
*lo
,
140 struct nfs4_state
*open_state
);
141 int mark_matching_lsegs_invalid(struct pnfs_layout_hdr
*lo
,
142 struct list_head
*tmp_list
,
144 bool pnfs_roc(struct inode
*ino
);
145 void pnfs_roc_release(struct inode
*ino
);
146 void pnfs_roc_set_barrier(struct inode
*ino
, u32 barrier
);
147 bool pnfs_roc_drain(struct inode
*ino
, u32
*barrier
);
150 static inline int lo_fail_bit(u32 iomode
)
152 return iomode
== IOMODE_RW
?
153 NFS_LAYOUT_RW_FAILED
: NFS_LAYOUT_RO_FAILED
;
156 static inline struct pnfs_layout_segment
*
157 get_lseg(struct pnfs_layout_segment
*lseg
)
160 atomic_inc(&lseg
->pls_refcount
);
161 smp_mb__after_atomic_inc();
166 /* Return true if a layout driver is being used for this mountpoint */
167 static inline int pnfs_enabled_sb(struct nfs_server
*nfss
)
169 return nfss
->pnfs_curr_ld
!= NULL
;
172 #else /* CONFIG_NFS_V4_1 */
174 static inline void pnfs_destroy_all_layouts(struct nfs_client
*clp
)
178 static inline void pnfs_destroy_layout(struct nfs_inode
*nfsi
)
182 static inline struct pnfs_layout_segment
*
183 get_lseg(struct pnfs_layout_segment
*lseg
)
188 static inline void put_lseg(struct pnfs_layout_segment
*lseg
)
192 static inline struct pnfs_layout_segment
*
193 pnfs_update_layout(struct inode
*ino
, struct nfs_open_context
*ctx
,
194 enum pnfs_iomode access_type
)
199 static inline enum pnfs_try_status
200 pnfs_try_to_read_data(struct nfs_read_data
*data
,
201 const struct rpc_call_ops
*call_ops
)
203 return PNFS_NOT_ATTEMPTED
;
206 static inline enum pnfs_try_status
207 pnfs_try_to_write_data(struct nfs_write_data
*data
,
208 const struct rpc_call_ops
*call_ops
, int how
)
210 return PNFS_NOT_ATTEMPTED
;
214 pnfs_roc(struct inode
*ino
)
220 pnfs_roc_release(struct inode
*ino
)
225 pnfs_roc_set_barrier(struct inode
*ino
, u32 barrier
)
230 pnfs_roc_drain(struct inode
*ino
, u32
*barrier
)
235 static inline void set_pnfs_layoutdriver(struct nfs_server
*s
, u32 id
)
239 static inline void unset_pnfs_layoutdriver(struct nfs_server
*s
)
244 pnfs_pageio_init_read(struct nfs_pageio_descriptor
*pgio
, struct inode
*ino
)
246 pgio
->pg_test
= NULL
;
250 pnfs_pageio_init_write(struct nfs_pageio_descriptor
*pgio
, struct inode
*ino
)
252 pgio
->pg_test
= NULL
;
255 #endif /* CONFIG_NFS_V4_1 */
257 #endif /* FS_NFS_PNFS_H */