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