blob: 8aaab56b794f604124ee2a6415c835ad230b4068 [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 Isaman4541d162011-01-06 11:36:23 +000052 NFS_LAYOUT_DESTROYED, /* no new use of layout allowed */
Benny Halevye5e94012010-10-20 00:18:01 -040053};
54
Ricardo Labiaga85e174b2010-10-20 00:17:58 -040055/* Per-layout driver specific registration structure */
56struct pnfs_layoutdriver_type {
Fred Isaman02c35fc2010-10-20 00:17:59 -040057 struct list_head pnfs_tblid;
58 const u32 id;
59 const char *name;
60 struct module *owner;
Trond Myklebust1c787092010-10-21 16:56:48 -040061 int (*set_layoutdriver) (struct nfs_server *);
62 int (*clear_layoutdriver) (struct nfs_server *);
Andy Adamsonb1f69b72010-10-20 00:18:03 -040063 struct pnfs_layout_segment * (*alloc_lseg) (struct pnfs_layout_hdr *layoutid, struct nfs4_layoutget_res *lgr);
64 void (*free_lseg) (struct pnfs_layout_segment *lseg);
Ricardo Labiaga85e174b2010-10-20 00:17:58 -040065};
66
Benny Halevye5e94012010-10-20 00:18:01 -040067struct pnfs_layout_hdr {
Fred Isamancc6e5342011-01-06 11:36:28 +000068 atomic_t plh_refcount;
Fred Isamanb7edfaa2011-01-06 11:36:21 +000069 struct list_head plh_layouts; /* other client layouts */
70 struct list_head plh_segs; /* layout segments list */
Fred Isamanb7edfaa2011-01-06 11:36:21 +000071 nfs4_stateid plh_stateid;
Fred Isamancf7d63f2011-01-06 11:36:25 +000072 atomic_t plh_outstanding; /* number of RPCs out */
Fred Isaman566052c2011-01-06 11:36:20 +000073 unsigned long plh_flags;
Fred Isamanb7edfaa2011-01-06 11:36:21 +000074 struct inode *plh_inode;
Benny Halevye5e94012010-10-20 00:18:01 -040075};
76
Andy Adamsonb1f69b72010-10-20 00:18:03 -040077struct pnfs_device {
78 struct nfs4_deviceid dev_id;
79 unsigned int layout_type;
80 unsigned int mincount;
81 struct page **pages;
82 void *area;
83 unsigned int pgbase;
84 unsigned int pglen;
85};
86
87/*
88 * Device ID RCU cache. A device ID is unique per client ID and layout type.
89 */
90#define NFS4_DEVICE_ID_HASH_BITS 5
91#define NFS4_DEVICE_ID_HASH_SIZE (1 << NFS4_DEVICE_ID_HASH_BITS)
92#define NFS4_DEVICE_ID_HASH_MASK (NFS4_DEVICE_ID_HASH_SIZE - 1)
93
94static inline u32
95nfs4_deviceid_hash(struct nfs4_deviceid *id)
96{
97 unsigned char *cptr = (unsigned char *)id->data;
98 unsigned int nbytes = NFS4_DEVICEID4_SIZE;
99 u32 x = 0;
100
101 while (nbytes--) {
102 x *= 37;
103 x += *cptr++;
104 }
105 return x & NFS4_DEVICE_ID_HASH_MASK;
106}
107
108struct pnfs_deviceid_node {
109 struct hlist_node de_node;
110 struct nfs4_deviceid de_id;
111 atomic_t de_ref;
112};
113
114struct pnfs_deviceid_cache {
115 spinlock_t dc_lock;
116 atomic_t dc_ref;
117 void (*dc_free_callback)(struct pnfs_deviceid_node *);
118 struct hlist_head dc_deviceids[NFS4_DEVICE_ID_HASH_SIZE];
119};
120
121extern int pnfs_alloc_init_deviceid_cache(struct nfs_client *,
122 void (*free_callback)(struct pnfs_deviceid_node *));
123extern void pnfs_put_deviceid_cache(struct nfs_client *);
124extern struct pnfs_deviceid_node *pnfs_find_get_deviceid(
125 struct pnfs_deviceid_cache *,
126 struct nfs4_deviceid *);
127extern struct pnfs_deviceid_node *pnfs_add_deviceid(
128 struct pnfs_deviceid_cache *,
129 struct pnfs_deviceid_node *);
130extern void pnfs_put_deviceid(struct pnfs_deviceid_cache *c,
131 struct pnfs_deviceid_node *devid);
132
Fred Isaman02c35fc2010-10-20 00:17:59 -0400133extern int pnfs_register_layoutdriver(struct pnfs_layoutdriver_type *);
134extern void pnfs_unregister_layoutdriver(struct pnfs_layoutdriver_type *);
135
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400136/* nfs4proc.c */
137extern int nfs4_proc_getdeviceinfo(struct nfs_server *server,
138 struct pnfs_device *dev);
139extern int nfs4_proc_layoutget(struct nfs4_layoutget *lgp);
140
141/* pnfs.c */
Benny Halevye5e94012010-10-20 00:18:01 -0400142struct pnfs_layout_segment *
143pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
144 enum pnfs_iomode access_type);
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400145void set_pnfs_layoutdriver(struct nfs_server *, u32 id);
146void unset_pnfs_layoutdriver(struct nfs_server *);
Andy Adamsonb1f69b72010-10-20 00:18:03 -0400147int pnfs_layout_process(struct nfs4_layoutget *lgp);
Benny Halevye5e94012010-10-20 00:18:01 -0400148void pnfs_destroy_layout(struct nfs_inode *);
Andy Adamson974cec82010-10-20 00:18:02 -0400149void pnfs_destroy_all_layouts(struct nfs_client *);
Fred Isamancc6e5342011-01-06 11:36:28 +0000150void put_layout_hdr(struct pnfs_layout_hdr *lo);
Fred Isamanfd6002e2011-01-06 11:36:22 +0000151int pnfs_choose_layoutget_stateid(nfs4_stateid *dst,
152 struct pnfs_layout_hdr *lo,
153 struct nfs4_state *open_state);
Benny Halevye5e94012010-10-20 00:18:01 -0400154
155
156static inline int lo_fail_bit(u32 iomode)
157{
158 return iomode == IOMODE_RW ?
159 NFS_LAYOUT_RW_FAILED : NFS_LAYOUT_RO_FAILED;
160}
161
162/* Return true if a layout driver is being used for this mountpoint */
163static inline int pnfs_enabled_sb(struct nfs_server *nfss)
164{
165 return nfss->pnfs_curr_ld != NULL;
166}
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400167
168#else /* CONFIG_NFS_V4_1 */
169
Andy Adamson974cec82010-10-20 00:18:02 -0400170static inline void pnfs_destroy_all_layouts(struct nfs_client *clp)
171{
172}
173
Benny Halevye5e94012010-10-20 00:18:01 -0400174static inline void pnfs_destroy_layout(struct nfs_inode *nfsi)
175{
176}
177
178static inline struct pnfs_layout_segment *
179pnfs_update_layout(struct inode *ino, struct nfs_open_context *ctx,
180 enum pnfs_iomode access_type)
181{
182 return NULL;
183}
184
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400185static inline void set_pnfs_layoutdriver(struct nfs_server *s, u32 id)
186{
187}
188
189static inline void unset_pnfs_layoutdriver(struct nfs_server *s)
190{
191}
192
193#endif /* CONFIG_NFS_V4_1 */
194
195#endif /* FS_NFS_PNFS_H */