blob: 6380b9405bcde5ac02137cf455b2e88d6bed8d6e [file] [log] [blame]
Ricardo Labiaga85e174b2010-10-20 00:17:58 -04001/*
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
Fred Isaman94ad1c82011-03-01 01:34:14 +000033#include <linux/nfs_page.h>
34
Fred Isaman4541d162011-01-06 11:36:23 +000035enum {
36 NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */
Fred Isamanf7e89172011-01-06 11:36:32 +000037 NFS_LSEG_ROC, /* roc bit received from server */
Fred Isaman4541d162011-01-06 11:36:23 +000038};
39
Andy Adamson974cec82010-10-20 00:18:02 -040040struct pnfs_layout_segment {
Fred Isaman566052c2011-01-06 11:36:20 +000041 struct list_head pls_list;
42 struct pnfs_layout_range pls_range;
Fred Isaman4541d162011-01-06 11:36:23 +000043 atomic_t pls_refcount;
44 unsigned long pls_flags;
Fred Isaman566052c2011-01-06 11:36:20 +000045 struct pnfs_layout_hdr *pls_layout;
Andy Adamson974cec82010-10-20 00:18:02 -040046};
47
Andy Adamson64419a92011-03-01 01:34:16 +000048enum pnfs_try_status {
49 PNFS_ATTEMPTED = 0,
50 PNFS_NOT_ATTEMPTED = 1,
51};
52
Ricardo Labiaga85e174b2010-10-20 00:17:58 -040053#ifdef CONFIG_NFS_V4_1
54
55#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
56
Benny Halevye5e94012010-10-20 00:18:01 -040057enum {
58 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
59 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
Fred Isaman43f1b3d2011-01-06 11:36:30 +000060 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
Fred Isamanf7e89172011-01-06 11:36:32 +000061 NFS_LAYOUT_ROC, /* some lseg had roc bit set */
Fred Isaman4541d162011-01-06 11:36:23 +000062 NFS_LAYOUT_DESTROYED, /* no new use of layout allowed */
Benny Halevye5e94012010-10-20 00:18:01 -040063};
64
Ricardo Labiaga85e174b2010-10-20 00:17:58 -040065/* Per-layout driver specific registration structure */
66struct pnfs_layoutdriver_type {
Fred Isaman02c35fc2010-10-20 00:17:59 -040067 struct list_head pnfs_tblid;
68 const u32 id;
69 const char *name;
70 struct module *owner;
Andy Adamsonb1f69b72010-10-20 00:18:03 -040071 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);
Fred Isaman94ad1c82011-03-01 01:34:14 +000073
74 /* test for nfs page cache coalescing */
75 int (*pg_test)(struct nfs_pageio_descriptor *, struct nfs_page *, struct nfs_page *);
Andy Adamson64419a92011-03-01 01:34:16 +000076
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);
Andy Adamson0382b742011-03-03 15:13:45 +000082 enum pnfs_try_status (*write_pagelist) (struct nfs_write_data *nfs_data, int how);
Ricardo Labiaga85e174b2010-10-20 00:17:58 -040083};
84
Benny Halevye5e94012010-10-20 00:18:01 -040085struct pnfs_layout_hdr {
Fred Isamancc6e5342011-01-06 11:36:28 +000086 atomic_t plh_refcount;
Fred Isamanb7edfaa2011-01-06 11:36:21 +000087 struct list_head plh_layouts; /* other client layouts */
Fred Isaman43f1b3d2011-01-06 11:36:30 +000088 struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
Fred Isamanb7edfaa2011-01-06 11:36:21 +000089 struct list_head plh_segs; /* layout segments list */
Fred Isamanb7edfaa2011-01-06 11:36:21 +000090 nfs4_stateid plh_stateid;
Fred Isamancf7d63f2011-01-06 11:36:25 +000091 atomic_t plh_outstanding; /* number of RPCs out */
Fred Isamanf7e89172011-01-06 11:36:32 +000092 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
Fred Isaman43f1b3d2011-01-06 11:36:30 +000093 u32 plh_barrier; /* ignore lower seqids */
Fred Isaman566052c2011-01-06 11:36:20 +000094 unsigned long plh_flags;
Fred Isamanb7edfaa2011-01-06 11:36:21 +000095 struct inode *plh_inode;
Benny Halevye5e94012010-10-20 00:18:01 -040096};
97
Andy Adamsonb1f69b72010-10-20 00:18:03 -040098struct 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
Fred Isaman02c35fc2010-10-20 00:17:59 -0400108extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
109extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
110
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400111/* nfs4proc.c */
112extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
113 struct pnfs_device *dev);
114extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
115
116/* pnfs.c */
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000117void get_layout_hdr(struct pnfs_layout_hdr *lo);
Fred Isamanbae724e2011-03-01 01:34:15 +0000118void put_lseg(struct pnfs_layout_segment *lseg);
Benny Halevye5e94012010-10-20 00:18:01 -0400119struct pnfs_layout_segment *
120pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
121 enum pnfs_iomode access_type);
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400122void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
123void unset_pnfs_layoutdriver(struct nfs_server *);
Andy Adamson0382b742011-03-03 15:13:45 +0000124enum pnfs_try_status pnfs_try_to_write_data(struct nfs_write_data *,
125 const struct rpc_call_ops *, int);
Andy Adamson64419a92011-03-01 01:34:16 +0000126enum pnfs_try_status pnfs_try_to_read_data(struct nfs_read_data *,
127 const struct rpc_call_ops *);
Fred Isaman94ad1c82011-03-01 01:34:14 +0000128void pnfs_pageio_init_read(struct nfs_pageio_descriptor *, struct inode *);
Fred Isaman44b83792011-03-03 15:13:44 +0000129void pnfs_pageio_init_write(struct nfs_pageio_descriptor *, struct inode *);
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400130int pnfs_layout_process(struct nfs4_layoutget *lgp);
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000131void pnfs_free_lseg_list(struct list_head *tmp_list);
Benny Halevye5e94012010-10-20 00:18:01 -0400132void pnfs_destroy_layout(struct nfs_inode *);
Andy Adamson974cec82010-10-20 00:18:02 -0400133void pnfs_destroy_all_layouts(struct nfs_client *);
Fred Isamancc6e5342011-01-06 11:36:28 +0000134void put_layout_hdr(struct pnfs_layout_hdr *lo);
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000135void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
136 const nfs4_stateid *new,
137 bool update_barrier);
Fred Isamanfd6002e2011-01-06 11:36:22 +0000138int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
139 struct pnfs_layout_hdr *lo,
140 struct nfs4_state *open_state);
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000141int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
142 struct list_head *tmp_list,
143 u32 iomode);
Fred Isamanf7e89172011-01-06 11:36:32 +0000144bool pnfs_roc(struct inode *ino);
145void pnfs_roc_release(struct inode *ino);
146void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
147bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
Benny Halevye5e94012010-10-20 00:18:01 -0400148
149
150static inline int lo_fail_bit(u32 iomode)
151{
152 return iomode == IOMODE_RW ?
153 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
154}
155
Fred Isamand684d2a2011-03-01 01:34:13 +0000156static inline struct pnfs_layout_segment *
157get_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
Benny Halevye5e94012010-10-20 00:18:01 -0400166/* Return true if a layout driver is being used for this mountpoint */
167static inline int pnfs_enabled_sb(struct nfs_server *nfss)
168{
169 return nfss->pnfs_curr_ld != NULL;
170}
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400171
172#else /* CONFIG_NFS_V4_1 */
173
Andy Adamson974cec82010-10-20 00:18:02 -0400174static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
175{
176}
177
Benny Halevye5e94012010-10-20 00:18:01 -0400178static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
179{
180}
181
182static inline struct pnfs_layout_segment *
Fred Isamand684d2a2011-03-01 01:34:13 +0000183get_lseg(struct pnfs_layout_segment *lseg)
184{
185 return NULL;
186}
187
188static inline void put_lseg(struct pnfs_layout_segment *lseg)
189{
190}
191
192static inline struct pnfs_layout_segment *
Benny Halevye5e94012010-10-20 00:18:01 -0400193pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
194 enum pnfs_iomode access_type)
195{
196 return NULL;
197}
198
Andy Adamson64419a92011-03-01 01:34:16 +0000199static inline enum pnfs_try_status
200pnfs_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
Andy Adamson0382b742011-03-03 15:13:45 +0000206static inline enum pnfs_try_status
207pnfs_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
Fred Isamanf7e89172011-01-06 11:36:32 +0000213static inline bool
214pnfs_roc(struct inode *ino)
215{
216 return false;
217}
218
219static inline void
220pnfs_roc_release(struct inode *ino)
221{
222}
223
224static inline void
225pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
226{
227}
228
229static inline bool
230pnfs_roc_drain(struct inode *ino, u32 *barrier)
231{
232 return false;
233}
234
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400235static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
236{
237}
238
239static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
240{
241}
242
Fred Isaman94ad1c82011-03-01 01:34:14 +0000243static inline void
244pnfs_pageio_init_read(struct nfs_pageio_descriptor *pgio, struct inode *ino)
245{
246 pgio->pg_test = NULL;
247}
248
Fred Isaman44b83792011-03-03 15:13:44 +0000249static inline void
250pnfs_pageio_init_write(struct nfs_pageio_descriptor *pgio, struct inode *ino)
251{
252 pgio->pg_test = NULL;
253}
254
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400255#endif /* CONFIG_NFS_V4_1 */
256
257#endif /* FS_NFS_PNFS_H */