]>
Commit | Line | Data |
---|---|---|
85e174ba RL |
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 | ||
30 | #ifndef FS_NFS_PNFS_H | |
31 | #define FS_NFS_PNFS_H | |
32 | ||
94ad1c80 FI |
33 | #include <linux/nfs_page.h> |
34 | ||
4541d16c FI |
35 | enum { |
36 | NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */ | |
f7e8917a | 37 | NFS_LSEG_ROC, /* roc bit received from server */ |
4541d16c FI |
38 | }; |
39 | ||
974cec8c | 40 | struct pnfs_layout_segment { |
566052c5 FI |
41 | struct list_head pls_list; |
42 | struct pnfs_layout_range pls_range; | |
4541d16c FI |
43 | atomic_t pls_refcount; |
44 | unsigned long pls_flags; | |
566052c5 | 45 | struct pnfs_layout_hdr *pls_layout; |
974cec8c AA |
46 | }; |
47 | ||
64419a9b AA |
48 | enum pnfs_try_status { |
49 | PNFS_ATTEMPTED = 0, | |
50 | PNFS_NOT_ATTEMPTED = 1, | |
51 | }; | |
52 | ||
85e174ba RL |
53 | #ifdef CONFIG_NFS_V4_1 |
54 | ||
55 | #define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4" | |
56 | ||
e5e94017 BH |
57 | enum { |
58 | NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */ | |
59 | NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */ | |
43f1b3da | 60 | NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */ |
f7e8917a | 61 | NFS_LAYOUT_ROC, /* some lseg had roc bit set */ |
4541d16c | 62 | NFS_LAYOUT_DESTROYED, /* no new use of layout allowed */ |
e5e94017 BH |
63 | }; |
64 | ||
85e174ba RL |
65 | /* Per-layout driver specific registration structure */ |
66 | struct pnfs_layoutdriver_type { | |
02c35fca FI |
67 | struct list_head pnfs_tblid; |
68 | const u32 id; | |
69 | const char *name; | |
70 | struct module *owner; | |
b1f69b75 AA |
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); | |
94ad1c80 FI |
73 | |
74 | /* test for nfs page cache coalescing */ | |
75 | int (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *); | |
64419a9b AA |
76 | |
77 | /* | |
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 | |
80 | */ | |
81 | enum pnfs_try_status (*read_pagelist) (struct nfs_read_data *nfs_data); | |
0382b744 | 82 | enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how); |
85e174ba RL |
83 | }; |
84 | ||
e5e94017 | 85 | struct pnfs_layout_hdr { |
cc6e5340 | 86 | atomic_t plh_refcount; |
b7edfaa1 | 87 | struct list_head plh_layouts; /* other client layouts */ |
43f1b3da | 88 | struct list_head plh_bulk_recall; /* clnt list of bulk recalls */ |
b7edfaa1 | 89 | struct list_head plh_segs; /* layout segments list */ |
b7edfaa1 | 90 | nfs4_stateid plh_stateid; |
cf7d63f1 | 91 | atomic_t plh_outstanding; /* number of RPCs out */ |
f7e8917a | 92 | unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */ |
43f1b3da | 93 | u32 plh_barrier; /* ignore lower seqids */ |
566052c5 | 94 | unsigned long plh_flags; |
b7edfaa1 | 95 | struct inode *plh_inode; |
e5e94017 BH |
96 | }; |
97 | ||
b1f69b75 AA |
98 | struct pnfs_device { |
99 | struct nfs4_deviceid dev_id; | |
100 | unsigned int layout_type; | |
101 | unsigned int mincount; | |
102 | struct page **pages; | |
103 | void *area; | |
104 | unsigned int pgbase; | |
105 | unsigned int pglen; | |
106 | }; | |
107 | ||
02c35fca FI |
108 | extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *); |
109 | extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *); | |
110 | ||
b1f69b75 AA |
111 | /* nfs4proc.c */ |
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); | |
115 | ||
116 | /* pnfs.c */ | |
43f1b3da | 117 | void get_layout_hdr(struct pnfs_layout_hdr *lo); |
bae724ef | 118 | void put_lseg(struct pnfs_layout_segment *lseg); |
e5e94017 BH |
119 | struct pnfs_layout_segment * |
120 | pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx, | |
121 | enum pnfs_iomode access_type); | |
85e174ba RL |
122 | void set_pnfs_layoutdriver(struct nfs_server *, u32 id); |
123 | void unset_pnfs_layoutdriver(struct nfs_server *); | |
0382b744 AA |
124 | enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *, |
125 | const struct rpc_call_ops *, int); | |
64419a9b AA |
126 | enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *, |
127 | const struct rpc_call_ops *); | |
94ad1c80 | 128 | void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *); |
44b83799 | 129 | void pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *); |
b1f69b75 | 130 | int pnfs_layout_process(struct nfs4_layoutget *lgp); |
43f1b3da | 131 | void pnfs_free_lseg_list(struct list_head *tmp_list); |
e5e94017 | 132 | void pnfs_destroy_layout(struct nfs_inode *); |
974cec8c | 133 | void pnfs_destroy_all_layouts(struct nfs_client *); |
cc6e5340 | 134 | void put_layout_hdr(struct pnfs_layout_hdr *lo); |
43f1b3da FI |
135 | void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo, |
136 | const nfs4_stateid *new, | |
137 | bool update_barrier); | |
fd6002e9 FI |
138 | int pnfs_choose_layoutget_stateid(nfs4_stateid *dst, |
139 | struct pnfs_layout_hdr *lo, | |
140 | struct nfs4_state *open_state); | |
43f1b3da FI |
141 | int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo, |
142 | struct list_head *tmp_list, | |
143 | u32 iomode); | |
f7e8917a FI |
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); | |
e5e94017 BH |
148 | |
149 | ||
150 | static inline int lo_fail_bit(u32 iomode) | |
151 | { | |
152 | return iomode == IOMODE_RW ? | |
153 | NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED; | |
154 | } | |
155 | ||
d684d2ae FI |
156 | static inline struct pnfs_layout_segment * |
157 | get_lseg(struct pnfs_layout_segment *lseg) | |
158 | { | |
159 | if (lseg) { | |
160 | atomic_inc(&lseg->pls_refcount); | |
161 | smp_mb__after_atomic_inc(); | |
162 | } | |
163 | return lseg; | |
164 | } | |
165 | ||
e5e94017 BH |
166 | /* Return true if a layout driver is being used for this mountpoint */ |
167 | static inline int pnfs_enabled_sb(struct nfs_server *nfss) | |
168 | { | |
169 | return nfss->pnfs_curr_ld != NULL; | |
170 | } | |
85e174ba RL |
171 | |
172 | #else /* CONFIG_NFS_V4_1 */ | |
173 | ||
974cec8c AA |
174 | static inline void pnfs_destroy_all_layouts(struct nfs_client *clp) |
175 | { | |
176 | } | |
177 | ||
e5e94017 BH |
178 | static inline void pnfs_destroy_layout(struct nfs_inode *nfsi) |
179 | { | |
180 | } | |
181 | ||
d684d2ae FI |
182 | static inline struct pnfs_layout_segment * |
183 | get_lseg(struct pnfs_layout_segment *lseg) | |
184 | { | |
185 | return NULL; | |
186 | } | |
187 | ||
188 | static inline void put_lseg(struct pnfs_layout_segment *lseg) | |
189 | { | |
190 | } | |
191 | ||
e5e94017 BH |
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) | |
195 | { | |
196 | return NULL; | |
197 | } | |
198 | ||
64419a9b AA |
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) | |
202 | { | |
203 | return PNFS_NOT_ATTEMPTED; | |
204 | } | |
205 | ||
0382b744 AA |
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) | |
209 | { | |
210 | return PNFS_NOT_ATTEMPTED; | |
211 | } | |
212 | ||
f7e8917a FI |
213 | static inline bool |
214 | pnfs_roc(struct inode *ino) | |
215 | { | |
216 | return false; | |
217 | } | |
218 | ||
219 | static inline void | |
220 | pnfs_roc_release(struct inode *ino) | |
221 | { | |
222 | } | |
223 | ||
224 | static inline void | |
225 | pnfs_roc_set_barrier(struct inode *ino, u32 barrier) | |
226 | { | |
227 | } | |
228 | ||
229 | static inline bool | |
230 | pnfs_roc_drain(struct inode *ino, u32 *barrier) | |
231 | { | |
232 | return false; | |
233 | } | |
234 | ||
85e174ba RL |
235 | static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id) |
236 | { | |
237 | } | |
238 | ||
239 | static inline void unset_pnfs_layoutdriver(struct nfs_server *s) | |
240 | { | |
241 | } | |
242 | ||
94ad1c80 FI |
243 | static inline void |
244 | pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *ino) | |
245 | { | |
246 | pgio->pg_test = NULL; | |
247 | } | |
248 | ||
44b83799 FI |
249 | static inline void |
250 | pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *ino) | |
251 | { | |
252 | pgio->pg_test = NULL; | |
253 | } | |
254 | ||
85e174ba RL |
255 | #endif /* CONFIG_NFS_V4_1 */ |
256 | ||
257 | #endif /* FS_NFS_PNFS_H */ |