blob: f91d0d45551cc67cd11a3509bf6b5e9192069ba4 [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 */
35};
36
Andy Adamson974cec82010-10-20 00:18:02 -040037struct pnfs_layout_segment {
Fred Isaman566052c2011-01-06 11:36:20 +000038 struct list_head pls_list;
39 struct pnfs_layout_range pls_range;
Fred Isaman4541d162011-01-06 11:36:23 +000040 atomic_t pls_refcount;
41 unsigned long pls_flags;
Fred Isaman566052c2011-01-06 11:36:20 +000042 struct pnfs_layout_hdr *pls_layout;
Andy Adamson974cec82010-10-20 00:18:02 -040043};
44
Ricardo Labiaga85e174b2010-10-20 00:17:58 -040045#ifdef CONFIG_NFS_V4_1
46
47#define LAYOUT_NFSV4_1_MODULE_PREFIX "nfs-layouttype4"
48
Benny Halevye5e94012010-10-20 00:18:01 -040049enum {
50 NFS_LAYOUT_RO_FAILED = 0, /* get ro layout failed stop trying */
51 NFS_LAYOUT_RW_FAILED, /* get rw layout failed stop trying */
Fred Isaman43f1b3d2011-01-06 11:36:30 +000052 NFS_LAYOUT_BULK_RECALL, /* bulk recall affecting layout */
Fred Isaman4541d162011-01-06 11:36:23 +000053 NFS_LAYOUT_DESTROYED, /* no new use of layout allowed */
Benny Halevye5e94012010-10-20 00:18:01 -040054};
55
Ricardo Labiaga85e174b2010-10-20 00:17:58 -040056/* Per-layout driver specific registration structure */
57struct pnfs_layoutdriver_type {
Fred Isaman02c35fc2010-10-20 00:17:59 -040058 struct list_head pnfs_tblid;
59 const u32 id;
60 const char *name;
61 struct module *owner;
Trond Myklebust1c787092010-10-21 16:56:48 -040062 int (*set_layoutdriver) (struct nfs_server *);
63 int (*clear_layoutdriver) (struct nfs_server *);
Andy Adamsonb1f69b72010-10-20 00:18:03 -040064 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr);
65 void (*free_lseg) (struct pnfs_layout_segment *lseg);
Ricardo Labiaga85e174b2010-10-20 00:17:58 -040066};
67
Benny Halevye5e94012010-10-20 00:18:01 -040068struct pnfs_layout_hdr {
Fred Isamancc6e5342011-01-06 11:36:28 +000069 atomic_t plh_refcount;
Fred Isamanb7edfaa2011-01-06 11:36:21 +000070 struct list_head plh_layouts; /* other client layouts */
Fred Isaman43f1b3d2011-01-06 11:36:30 +000071 struct list_head plh_bulk_recall; /* clnt list of bulk recalls */
Fred Isamanb7edfaa2011-01-06 11:36:21 +000072 struct list_head plh_segs; /* layout segments list */
Fred Isamanb7edfaa2011-01-06 11:36:21 +000073 nfs4_stateid plh_stateid;
Fred Isamancf7d63f2011-01-06 11:36:25 +000074 atomic_t plh_outstanding; /* number of RPCs out */
Fred Isaman43f1b3d2011-01-06 11:36:30 +000075 u32 plh_barrier; /* ignore lower seqids */
Fred Isaman566052c2011-01-06 11:36:20 +000076 unsigned long plh_flags;
Fred Isamanb7edfaa2011-01-06 11:36:21 +000077 struct inode *plh_inode;
Benny Halevye5e94012010-10-20 00:18:01 -040078};
79
Andy Adamsonb1f69b72010-10-20 00:18:03 -040080struct pnfs_device {
81 struct nfs4_deviceid dev_id;
82 unsigned int layout_type;
83 unsigned int mincount;
84 struct page **pages;
85 void *area;
86 unsigned int pgbase;
87 unsigned int pglen;
88};
89
90/*
91 * Device ID RCU cache. A device ID is unique per client ID and layout type.
92 */
93#define NFS4_DEVICE_ID_HASH_BITS 5
94#define NFS4_DEVICE_ID_HASH_SIZE (1 << NFS4_DEVICE_ID_HASH_BITS)
95#define NFS4_DEVICE_ID_HASH_MASK (NFS4_DEVICE_ID_HASH_SIZE - 1)
96
97static inline u32
98nfs4_deviceid_hash(struct nfs4_deviceid *id)
99{
100 unsigned char *cptr = (unsigned char *)id->data;
101 unsigned int nbytes = NFS4_DEVICEID4_SIZE;
102 u32 x = 0;
103
104 while (nbytes--) {
105 x *= 37;
106 x += *cptr++;
107 }
108 return x & NFS4_DEVICE_ID_HASH_MASK;
109}
110
111struct pnfs_deviceid_node {
112 struct hlist_node de_node;
113 struct nfs4_deviceid de_id;
114 atomic_t de_ref;
115};
116
117struct pnfs_deviceid_cache {
118 spinlock_t dc_lock;
119 atomic_t dc_ref;
120 void (*dc_free_callback)(struct pnfs_deviceid_node *);
121 struct hlist_head dc_deviceids[NFS4_DEVICE_ID_HASH_SIZE];
122};
123
124extern int pnfs_alloc_init_deviceid_cache(struct nfs_client *,
125 void (*free_callback)(struct pnfs_deviceid_node *));
126extern void pnfs_put_deviceid_cache(struct nfs_client *);
127extern struct pnfs_deviceid_node *pnfs_find_get_deviceid(
128 struct pnfs_deviceid_cache *,
129 struct nfs4_deviceid *);
130extern struct pnfs_deviceid_node *pnfs_add_deviceid(
131 struct pnfs_deviceid_cache *,
132 struct pnfs_deviceid_node *);
133extern void pnfs_put_deviceid(struct pnfs_deviceid_cache *c,
134 struct pnfs_deviceid_node *devid);
135
Fred Isaman02c35fc2010-10-20 00:17:59 -0400136extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
137extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
138
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400139/* nfs4proc.c */
140extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
141 struct pnfs_device *dev);
142extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
143
144/* pnfs.c */
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000145void get_layout_hdr(struct pnfs_layout_hdr *lo);
Benny Halevye5e94012010-10-20 00:18:01 -0400146struct pnfs_layout_segment *
147pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
148 enum pnfs_iomode access_type);
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400149void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
150void unset_pnfs_layoutdriver(struct nfs_server *);
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400151int pnfs_layout_process(struct nfs4_layoutget *lgp);
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000152void pnfs_free_lseg_list(struct list_head *tmp_list);
Benny Halevye5e94012010-10-20 00:18:01 -0400153void pnfs_destroy_layout(struct nfs_inode *);
Andy Adamson974cec82010-10-20 00:18:02 -0400154void pnfs_destroy_all_layouts(struct nfs_client *);
Fred Isamancc6e5342011-01-06 11:36:28 +0000155void put_layout_hdr(struct pnfs_layout_hdr *lo);
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000156void pnfs_set_layout_stateid(struct pnfs_layout_hdr *lo,
157 const nfs4_stateid *new,
158 bool update_barrier);
Fred Isamanfd6002e2011-01-06 11:36:22 +0000159int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
160 struct pnfs_layout_hdr *lo,
161 struct nfs4_state *open_state);
Fred Isaman43f1b3d2011-01-06 11:36:30 +0000162int mark_matching_lsegs_invalid(struct pnfs_layout_hdr *lo,
163 struct list_head *tmp_list,
164 u32 iomode);
Benny Halevye5e94012010-10-20 00:18:01 -0400165
166
167static inline int lo_fail_bit(u32 iomode)
168{
169 return iomode == IOMODE_RW ?
170 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
171}
172
173/* Return true if a layout driver is being used for this mountpoint */
174static inline int pnfs_enabled_sb(struct nfs_server *nfss)
175{
176 return nfss->pnfs_curr_ld != NULL;
177}
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400178
179#else /* CONFIG_NFS_V4_1 */
180
Andy Adamson974cec82010-10-20 00:18:02 -0400181static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
182{
183}
184
Benny Halevye5e94012010-10-20 00:18:01 -0400185static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
186{
187}
188
189static inline struct pnfs_layout_segment *
190pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
191 enum pnfs_iomode access_type)
192{
193 return NULL;
194}
195
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400196static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
197{
198}
199
200static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
201{
202}
203
204#endif /* CONFIG_NFS_V4_1 */
205
206#endif /* FS_NFS_PNFS_H */