275e4b735247f49224e9ccbe39f3e9726eae0b7a
[firefly-linux-kernel-4.4.55.git] / fs / nfs / flexfilelayout / flexfilelayout.h
1 /*
2  * NFSv4 flexfile layout driver data structures.
3  *
4  * Copyright (c) 2014, Primary Data, Inc. All rights reserved.
5  *
6  * Tao Peng <bergwolf@primarydata.com>
7  */
8
9 #ifndef FS_NFS_NFS4FLEXFILELAYOUT_H
10 #define FS_NFS_NFS4FLEXFILELAYOUT_H
11
12 #include "../pnfs.h"
13
14 /* XXX: Let's filter out insanely large mirror count for now to avoid oom
15  * due to network error etc. */
16 #define NFS4_FLEXFILE_LAYOUT_MAX_MIRROR_CNT 4096
17
18 struct nfs4_ff_ds_version {
19         u32                             version;
20         u32                             minor_version;
21         u32                             rsize;
22         u32                             wsize;
23         bool                            tightly_coupled;
24 };
25
26 /* chained in global deviceid hlist */
27 struct nfs4_ff_layout_ds {
28         struct nfs4_deviceid_node       id_node;
29         u32                             ds_versions_cnt;
30         struct nfs4_ff_ds_version       *ds_versions;
31         struct nfs4_pnfs_ds             *ds;
32 };
33
34 struct nfs4_ff_layout_ds_err {
35         struct list_head                list; /* linked in mirror error_list */
36         u64                             offset;
37         u64                             length;
38         int                             status;
39         enum nfs_opnum4                 opnum;
40         nfs4_stateid                    stateid;
41         struct nfs4_deviceid            deviceid;
42 };
43
44 struct nfs4_ff_layout_mirror {
45         u32                             ds_count;
46         u32                             efficiency;
47         struct nfs4_ff_layout_ds        *mirror_ds;
48         u32                             fh_versions_cnt;
49         struct nfs_fh                   *fh_versions;
50         nfs4_stateid                    stateid;
51         u32                             uid;
52         u32                             gid;
53         struct rpc_cred                 *cred;
54         spinlock_t                      lock;
55 };
56
57 struct nfs4_ff_layout_segment {
58         struct pnfs_layout_segment      generic_hdr;
59         u64                             stripe_unit;
60         u32                             mirror_array_cnt;
61         struct nfs4_ff_layout_mirror    **mirror_array;
62 };
63
64 struct nfs4_flexfile_layout {
65         struct pnfs_layout_hdr generic_hdr;
66         struct pnfs_ds_commit_info commit_info;
67         struct list_head        error_list; /* nfs4_ff_layout_ds_err */
68 };
69
70 static inline struct nfs4_flexfile_layout *
71 FF_LAYOUT_FROM_HDR(struct pnfs_layout_hdr *lo)
72 {
73         return container_of(lo, struct nfs4_flexfile_layout, generic_hdr);
74 }
75
76 static inline struct nfs4_ff_layout_segment *
77 FF_LAYOUT_LSEG(struct pnfs_layout_segment *lseg)
78 {
79         return container_of(lseg,
80                             struct nfs4_ff_layout_segment,
81                             generic_hdr);
82 }
83
84 static inline struct nfs4_deviceid_node *
85 FF_LAYOUT_DEVID_NODE(struct pnfs_layout_segment *lseg, u32 idx)
86 {
87         if (idx >= FF_LAYOUT_LSEG(lseg)->mirror_array_cnt ||
88             FF_LAYOUT_LSEG(lseg)->mirror_array[idx] == NULL ||
89             FF_LAYOUT_LSEG(lseg)->mirror_array[idx]->mirror_ds == NULL)
90                 return NULL;
91         return &FF_LAYOUT_LSEG(lseg)->mirror_array[idx]->mirror_ds->id_node;
92 }
93
94 static inline struct nfs4_ff_layout_ds *
95 FF_LAYOUT_MIRROR_DS(struct nfs4_deviceid_node *node)
96 {
97         return container_of(node, struct nfs4_ff_layout_ds, id_node);
98 }
99
100 static inline struct nfs4_ff_layout_mirror *
101 FF_LAYOUT_COMP(struct pnfs_layout_segment *lseg, u32 idx)
102 {
103         if (idx >= FF_LAYOUT_LSEG(lseg)->mirror_array_cnt)
104                 return NULL;
105         return FF_LAYOUT_LSEG(lseg)->mirror_array[idx];
106 }
107
108 static inline u32
109 FF_LAYOUT_MIRROR_COUNT(struct pnfs_layout_segment *lseg)
110 {
111         return FF_LAYOUT_LSEG(lseg)->mirror_array_cnt;
112 }
113
114 static inline bool
115 ff_layout_test_devid_unavailable(struct nfs4_deviceid_node *node)
116 {
117         return nfs4_test_deviceid_unavailable(node);
118 }
119
120 static inline int
121 nfs4_ff_layout_ds_version(struct pnfs_layout_segment *lseg, u32 ds_idx)
122 {
123         return FF_LAYOUT_COMP(lseg, ds_idx)->mirror_ds->ds_versions[0].version;
124 }
125
126 struct nfs4_ff_layout_ds *
127 nfs4_ff_alloc_deviceid_node(struct nfs_server *server, struct pnfs_device *pdev,
128                             gfp_t gfp_flags);
129 void nfs4_ff_layout_put_deviceid(struct nfs4_ff_layout_ds *mirror_ds);
130 void nfs4_ff_layout_free_deviceid(struct nfs4_ff_layout_ds *mirror_ds);
131 int ff_layout_track_ds_error(struct nfs4_flexfile_layout *flo,
132                              struct nfs4_ff_layout_mirror *mirror, u64 offset,
133                              u64 length, int status, enum nfs_opnum4 opnum,
134                              gfp_t gfp_flags);
135 int ff_layout_encode_ds_ioerr(struct nfs4_flexfile_layout *flo,
136                               struct xdr_stream *xdr, int *count,
137                               const struct pnfs_layout_range *range);
138 struct nfs_fh *
139 nfs4_ff_layout_select_ds_fh(struct pnfs_layout_segment *lseg, u32 mirror_idx);
140
141 struct nfs4_pnfs_ds *
142 nfs4_ff_layout_prepare_ds(struct pnfs_layout_segment *lseg, u32 ds_idx,
143                           bool fail_return);
144
145 struct rpc_clnt *
146 nfs4_ff_find_or_create_ds_client(struct pnfs_layout_segment *lseg,
147                                  u32 ds_idx,
148                                  struct nfs_client *ds_clp,
149                                  struct inode *inode);
150 struct rpc_cred *ff_layout_get_ds_cred(struct pnfs_layout_segment *lseg,
151                                        u32 ds_idx, struct rpc_cred *mdscred);
152 bool ff_layout_has_available_ds(struct pnfs_layout_segment *lseg);
153 #endif /* FS_NFS_NFS4FLEXFILELAYOUT_H */