blob: e2612ea0cbed0162d9fcfb74e2824d1617dfd054 [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 Isaman4541d162011-01-06 11:36:23 +000033enum {
34 NFS_LSEG_VALID = 0, /* cleared when lseg is recalled/returned */
Fred Isamanf7e89172011-01-06 11:36:32 +000035 NFS_LSEG_ROC, /* roc bit received from server */
Fred Isaman4541d162011-01-06 11:36:23 +000036};
37
Andy Adamson974cec82010-10-20 00:18:02 -040038struct pnfs_layout_segment {
Fred Isaman566052c2011-01-06 11:36:20 +000039 struct list_head pls_list;
40 struct pnfs_layout_range pls_range;
Fred Isaman4541d162011-01-06 11:36:23 +000041 atomic_t pls_refcount;
42 unsigned long pls_flags;
Fred Isaman566052c2011-01-06 11:36:20 +000043 struct pnfs_layout_hdr *pls_layout;
Andy Adamson974cec82010-10-20 00:18:02 -040044};
45
Ricardo Labiaga85e174b2010-10-20 00:17:58 -040046#ifdef CONFIG_NFS_V4_1
47
48#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
49
Benny Halevye5e94012010-10-20 00:18:01 -040050enum {
51 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
52 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
Fred Isaman43f1b3d2011-01-06 11:36:30 +000053 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
Fred Isamanf7e89172011-01-06 11:36:32 +000054 NFS_LAYOUT_ROC, /* some lseg had roc bit set */
Fred Isaman4541d162011-01-06 11:36:23 +000055 NFS_LAYOUT_DESTROYED, /* no new use of layout allowed */
Benny Halevye5e94012010-10-20 00:18:01 -040056};
57
Ricardo Labiaga85e174b2010-10-20 00:17:58 -040058/* Per-layout driver specific registration structure */
59struct pnfs_layoutdriver_type {
Fred Isaman02c35fc2010-10-20 00:17:59 -040060 struct list_head pnfs_tblid;
61 const u32 id;
62 const char *name;
63 struct module *owner;
Trond Myklebust1c787092010-10-21 16:56:48 -040064 int (*set_layoutdriver) (struct nfs_server *);
65 int (*clear_layoutdriver) (struct nfs_server *);
Andy Adamsonb1f69b72010-10-20 00:18:03 -040066 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr);
67 void (*free_lseg) (struct pnfs_layout_segment *lseg);
Ricardo Labiaga85e174b2010-10-20 00:17:58 -040068};
69
Benny Halevye5e94012010-10-20 00:18:01 -040070struct pnfs_layout_hdr {
Fred Isamancc6e5342011-01-06 11:36:28 +000071 atomic_t plh_refcount;
Fred Isamanb7edfaa2011-01-06 11:36:21 +000072 struct list_head plh_layouts; /* other client layouts */
Fred Isaman43f1b3d2011-01-06 11:36:30 +000073 struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
Fred Isamanb7edfaa2011-01-06 11:36:21 +000074 struct list_head plh_segs; /* layout segments list */
Fred Isamanb7edfaa2011-01-06 11:36:21 +000075 nfs4_stateid plh_stateid;
Fred Isamancf7d63f2011-01-06 11:36:25 +000076 atomic_t plh_outstanding; /* number of RPCs out */
Fred Isamanf7e89172011-01-06 11:36:32 +000077 unsigned long plh_block_lgets; /* block LAYOUTGET if >0 */
Fred Isaman43f1b3d2011-01-06 11:36:30 +000078 u32 plh_barrier; /* ignore lower seqids */
Fred Isaman566052c2011-01-06 11:36:20 +000079 unsigned long plh_flags;
Fred Isamanb7edfaa2011-01-06 11:36:21 +000080 struct inode *plh_inode;
Benny Halevye5e94012010-10-20 00:18:01 -040081};
82
Andy Adamsonb1f69b72010-10-20 00:18:03 -040083struct pnfs_device {
84 struct nfs4_deviceid dev_id;
85 unsigned int layout_type;
86 unsigned int mincount;
87 struct page **pages;
88 void *area;
89 unsigned int pgbase;
90 unsigned int pglen;
91};
92
93/*
94 * Device ID RCU cache. A device ID is unique per client ID and layout type.
95 */
96#define NFS4_DEVICE_ID_HASH_BITS 5
97#define NFS4_DEVICE_ID_HASH_SIZE (1 << NFS4_DEVICE_ID_HASH_BITS)
98#define NFS4_DEVICE_ID_HASH_MASK (NFS4_DEVICE_ID_HASH_SIZE - 1)
99
100static inline u32
101nfs4_deviceid_hash(struct nfs4_deviceid *id)
102{
103 unsigned char *cptr = (unsigned char *)id->data;
104 unsigned int nbytes = NFS4_DEVICEID4_SIZE;
105 u32 x = 0;
106
107 while (nbytes--) {
108 x *= 37;
109 x += *cptr++;
110 }
111 return x & NFS4_DEVICE_ID_HASH_MASK;
112}
113
114struct pnfs_deviceid_node {
115 struct hlist_node de_node;
116 struct nfs4_deviceid de_id;
117 atomic_t de_ref;
118};
119
120struct pnfs_deviceid_cache {
121 spinlock_t dc_lock;
122 atomic_t dc_ref;
123 void (*dc_free_callback)(struct pnfs_deviceid_node *);
124 struct hlist_head dc_deviceids[NFS4_DEVICE_ID_HASH_SIZE];
125};
126
127extern int pnfs_alloc_init_deviceid_cache(struct nfs_client *,
128 void (*free_callback)(struct pnfs_deviceid_node *));
129extern void pnfs_put_deviceid_cache(struct nfs_client *);
130extern struct pnfs_deviceid_node *pnfs_find_get_deviceid(
131 struct pnfs_deviceid_cache *,
132 struct nfs4_deviceid *);
133extern struct pnfs_deviceid_node *pnfs_add_deviceid(
134 struct pnfs_deviceid_cache *,
135 struct pnfs_deviceid_node *);
136extern void pnfs_put_deviceid(struct pnfs_deviceid_cache *c,
137 struct pnfs_deviceid_node *devid);
138
Fred Isaman02c35fc2010-10-20 00:17:59 -0400139extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
140extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
141
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400142/* nfs4proc.c */
143extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
144 struct pnfs_device *dev);
145extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
146
147/* pnfs.c */
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000148void get_layout_hdr(struct pnfs_layout_hdr *lo);
Benny Halevye5e94012010-10-20 00:18:01 -0400149struct pnfs_layout_segment *
150pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
151 enum pnfs_iomode access_type);
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400152void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
153void unset_pnfs_layoutdriver(struct nfs_server *);
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400154int pnfs_layout_process(struct nfs4_layoutget *lgp);
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000155void pnfs_free_lseg_list(struct list_head *tmp_list);
Benny Halevye5e94012010-10-20 00:18:01 -0400156void pnfs_destroy_layout(struct nfs_inode *);
Andy Adamson974cec82010-10-20 00:18:02 -0400157void pnfs_destroy_all_layouts(struct nfs_client *);
Fred Isamancc6e5342011-01-06 11:36:28 +0000158void put_layout_hdr(struct pnfs_layout_hdr *lo);
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000159void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
160 const nfs4_stateid *new,
161 bool update_barrier);
Fred Isamanfd6002e2011-01-06 11:36:22 +0000162int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
163 struct pnfs_layout_hdr *lo,
164 struct nfs4_state *open_state);
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000165int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
166 struct list_head *tmp_list,
167 u32 iomode);
Fred Isamanf7e89172011-01-06 11:36:32 +0000168bool pnfs_roc(struct inode *ino);
169void pnfs_roc_release(struct inode *ino);
170void pnfs_roc_set_barrier(struct inode *ino, u32 barrier);
171bool pnfs_roc_drain(struct inode *ino, u32 *barrier);
Benny Halevye5e94012010-10-20 00:18:01 -0400172
173
174static inline int lo_fail_bit(u32 iomode)
175{
176 return iomode == IOMODE_RW ?
177 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
178}
179
180/* Return true if a layout driver is being used for this mountpoint */
181static inline int pnfs_enabled_sb(struct nfs_server *nfss)
182{
183 return nfss->pnfs_curr_ld != NULL;
184}
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400185
186#else /* CONFIG_NFS_V4_1 */
187
Andy Adamson974cec82010-10-20 00:18:02 -0400188static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
189{
190}
191
Benny Halevye5e94012010-10-20 00:18:01 -0400192static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
193{
194}
195
196static inline struct pnfs_layout_segment *
197pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
198 enum pnfs_iomode access_type)
199{
200 return NULL;
201}
202
Fred Isamanf7e89172011-01-06 11:36:32 +0000203static inline bool
204pnfs_roc(struct inode *ino)
205{
206 return false;
207}
208
209static inline void
210pnfs_roc_release(struct inode *ino)
211{
212}
213
214static inline void
215pnfs_roc_set_barrier(struct inode *ino, u32 barrier)
216{
217}
218
219static inline bool
220pnfs_roc_drain(struct inode *ino, u32 *barrier)
221{
222 return false;
223}
224
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400225static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
226{
227}
228
229static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
230{
231}
232
233#endif /* CONFIG_NFS_V4_1 */
234
235#endif /* FS_NFS_PNFS_H */