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_io_stat {
  45         __u64                           ops_requested;
  46         __u64                           bytes_requested;
  47         __u64                           ops_completed;
  48         __u64                           bytes_completed;
  49         __u64                           bytes_not_delivered;
  50         ktime_t                         total_busy_time;
  51         ktime_t                         aggregate_completion_time;
  52 };
  53
  54 struct nfs4_ff_busy_timer {
  55         ktime_t start_time;
  56         atomic_t n_ops;
  57 };
  58
  59 struct nfs4_ff_layoutstat {
  60         struct nfs4_ff_io_stat io_stat;
  61         struct nfs4_ff_busy_timer busy_timer;
  62 };
  63
  64 struct nfs4_ff_layout_mirror {
  65         u32                             ds_count;
  66         u32                             efficiency;
  67         struct nfs4_ff_layout_ds        *mirror_ds;
  68         u32                             fh_versions_cnt;
  69         struct nfs_fh                   *fh_versions;
  70         nfs4_stateid                    stateid;
  71         u32                             uid;
  72         u32                             gid;
  73         struct rpc_cred                 *cred;
  74         spinlock_t                      lock;
  75         struct nfs4_ff_layoutstat       read_stat;
  76         struct nfs4_ff_layoutstat       write_stat;
  77         ktime_t                         start_time;
  78         struct pnfs_layout_segment      *lseg; /* back pointer */
  79 };
  80
  81 struct nfs4_ff_layout_segment {
  82         struct pnfs_layout_segment      generic_hdr;
  83         u64                             stripe_unit;
  84         u32                             mirror_array_cnt;
  85         struct nfs4_ff_layout_mirror    **mirror_array;
  86 };
  87
  88 struct nfs4_flexfile_layout {
  89         struct pnfs_layout_hdr generic_hdr;
  90         struct pnfs_ds_commit_info commit_info;
  91         struct list_head        error_list; /* nfs4_ff_layout_ds_err */
  92 };
  93
  94 static inline struct nfs4_flexfile_layout *
  95 FF_LAYOUT_FROM_HDR(struct pnfs_layout_hdr *lo)
  96 {
  97         return container_of(lo, struct nfs4_flexfile_layout, generic_hdr);
  98 }
  99
 100 static inline struct nfs4_ff_layout_segment *
 101 FF_LAYOUT_LSEG(struct pnfs_layout_segment *lseg)
 102 {
 103         return container_of(lseg,
 104                             struct nfs4_ff_layout_segment,
 105                             generic_hdr);
 106 }
 107
 108 static inline struct nfs4_deviceid_node *
 109 FF_LAYOUT_DEVID_NODE(struct pnfs_layout_segment *lseg, u32 idx)
 110 {
 111         if (idx >= FF_LAYOUT_LSEG(lseg)->mirror_array_cnt ||
 112             FF_LAYOUT_LSEG(lseg)->mirror_array[idx] == NULL ||
 113             FF_LAYOUT_LSEG(lseg)->mirror_array[idx]->mirror_ds == NULL)
 114                 return NULL;
 115         return &FF_LAYOUT_LSEG(lseg)->mirror_array[idx]->mirror_ds->id_node;
 116 }
 117
 118 static inline struct nfs4_ff_layout_ds *
 119 FF_LAYOUT_MIRROR_DS(struct nfs4_deviceid_node *node)
 120 {
 121         return container_of(node, struct nfs4_ff_layout_ds, id_node);
 122 }
 123
 124 static inline struct nfs4_ff_layout_mirror *
 125 FF_LAYOUT_COMP(struct pnfs_layout_segment *lseg, u32 idx)
 126 {
 127         if (idx >= FF_LAYOUT_LSEG(lseg)->mirror_array_cnt)
 128                 return NULL;
 129         return FF_LAYOUT_LSEG(lseg)->mirror_array[idx];
 130 }
 131
 132 static inline u32
 133 FF_LAYOUT_MIRROR_COUNT(struct pnfs_layout_segment *lseg)
 134 {
 135         return FF_LAYOUT_LSEG(lseg)->mirror_array_cnt;
 136 }
 137
 138 static inline bool
 139 ff_layout_test_devid_unavailable(struct nfs4_deviceid_node *node)
 140 {
 141         return nfs4_test_deviceid_unavailable(node);
 142 }
 143
 144 static inline int
 145 nfs4_ff_layout_ds_version(struct pnfs_layout_segment *lseg, u32 ds_idx)
 146 {
 147         return FF_LAYOUT_COMP(lseg, ds_idx)->mirror_ds->ds_versions[0].version;
 148 }
 149
 150 struct nfs4_ff_layout_ds *
 151 nfs4_ff_alloc_deviceid_node(struct nfs_server *server, struct pnfs_device *pdev,
 152                             gfp_t gfp_flags);
 153 void nfs4_ff_layout_put_deviceid(struct nfs4_ff_layout_ds *mirror_ds);
 154 void nfs4_ff_layout_free_deviceid(struct nfs4_ff_layout_ds *mirror_ds);
 155 int ff_layout_track_ds_error(struct nfs4_flexfile_layout *flo,
 156                              struct nfs4_ff_layout_mirror *mirror, u64 offset,
 157                              u64 length, int status, enum nfs_opnum4 opnum,
 158                              gfp_t gfp_flags);
 159 int ff_layout_encode_ds_ioerr(struct nfs4_flexfile_layout *flo,
 160                               struct xdr_stream *xdr, int *count,
 161                               const struct pnfs_layout_range *range);
 162 struct nfs_fh *
 163 nfs4_ff_layout_select_ds_fh(struct pnfs_layout_segment *lseg, u32 mirror_idx);
 164
 165 struct nfs4_pnfs_ds *
 166 nfs4_ff_layout_prepare_ds(struct pnfs_layout_segment *lseg, u32 ds_idx,
 167                           bool fail_return);
 168
 169 struct rpc_clnt *
 170 nfs4_ff_find_or_create_ds_client(struct pnfs_layout_segment *lseg,
 171                                  u32 ds_idx,
 172                                  struct nfs_client *ds_clp,
 173                                  struct inode *inode);
 174 struct rpc_cred *ff_layout_get_ds_cred(struct pnfs_layout_segment *lseg,
 175                                        u32 ds_idx, struct rpc_cred *mdscred);
 176 bool ff_layout_has_available_ds(struct pnfs_layout_segment *lseg);
 177 #endif /* FS_NFS_NFS4FLEXFILELAYOUT_H */