nfs/flexfilelayout/flexfilelayout.h

0001 /* SPDX-License-Identifier: GPL-2.0 */
0002 /*
0003  * NFSv4 flexfile layout driver data structures.
0004  *
0005  * Copyright (c) 2014, Primary Data, Inc. All rights reserved.
0006  *
0007  * Tao Peng <bergwolf@primarydata.com>
0008  */
0009
0010 #ifndef FS_NFS_NFS4FLEXFILELAYOUT_H
0011 #define FS_NFS_NFS4FLEXFILELAYOUT_H
0012
0013 #define FF_FLAGS_NO_LAYOUTCOMMIT 1
0014 #define FF_FLAGS_NO_IO_THRU_MDS  2
0015 #define FF_FLAGS_NO_READ_IO      4
0016
0017 #include <linux/refcount.h>
0018 #include "../pnfs.h"
0019
0020 /* XXX: Let's filter out insanely large mirror count for now to avoid oom
0021  * due to network error etc. */
0022 #define NFS4_FLEXFILE_LAYOUT_MAX_MIRROR_CNT 4096
0023
0024 /* LAYOUTSTATS report interval in ms */
0025 #define FF_LAYOUTSTATS_REPORT_INTERVAL (60000L)
0026 #define FF_LAYOUTSTATS_MAXDEV 4
0027
0028 struct nfs4_ff_ds_version {
0029     u32             version;
0030     u32             minor_version;
0031     u32             rsize;
0032     u32             wsize;
0033     bool                tightly_coupled;
0034 };
0035
0036 /* chained in global deviceid hlist */
0037 struct nfs4_ff_layout_ds {
0038     struct nfs4_deviceid_node   id_node;
0039     u32             ds_versions_cnt;
0040     struct nfs4_ff_ds_version   *ds_versions;
0041     struct nfs4_pnfs_ds     *ds;
0042 };
0043
0044 struct nfs4_ff_layout_ds_err {
0045     struct list_head        list; /* linked in mirror error_list */
0046     u64             offset;
0047     u64             length;
0048     int             status;
0049     enum nfs_opnum4         opnum;
0050     nfs4_stateid            stateid;
0051     struct nfs4_deviceid        deviceid;
0052 };
0053
0054 struct nfs4_ff_io_stat {
0055     __u64               ops_requested;
0056     __u64               bytes_requested;
0057     __u64               ops_completed;
0058     __u64               bytes_completed;
0059     __u64               bytes_not_delivered;
0060     ktime_t             total_busy_time;
0061     ktime_t             aggregate_completion_time;
0062 };
0063
0064 struct nfs4_ff_busy_timer {
0065     ktime_t start_time;
0066     atomic_t n_ops;
0067 };
0068
0069 struct nfs4_ff_layoutstat {
0070     struct nfs4_ff_io_stat io_stat;
0071     struct nfs4_ff_busy_timer busy_timer;
0072 };
0073
0074 struct nfs4_ff_layout_mirror {
0075     struct pnfs_layout_hdr      *layout;
0076     struct list_head        mirrors;
0077     u32             ds_count;
0078     u32             efficiency;
0079     struct nfs4_deviceid        devid;
0080     struct nfs4_ff_layout_ds    *mirror_ds;
0081     u32             fh_versions_cnt;
0082     struct nfs_fh           *fh_versions;
0083     nfs4_stateid            stateid;
0084     const struct cred __rcu     *ro_cred;
0085     const struct cred __rcu     *rw_cred;
0086     refcount_t          ref;
0087     spinlock_t          lock;
0088     unsigned long           flags;
0089     struct nfs4_ff_layoutstat   read_stat;
0090     struct nfs4_ff_layoutstat   write_stat;
0091     ktime_t             start_time;
0092     u32             report_interval;
0093 };
0094
0095 #define NFS4_FF_MIRROR_STAT_AVAIL   (0)
0096
0097 struct nfs4_ff_layout_segment {
0098     struct pnfs_layout_segment  generic_hdr;
0099     u64             stripe_unit;
0100     u32             flags;
0101     u32             mirror_array_cnt;
0102     struct nfs4_ff_layout_mirror    *mirror_array[];
0103 };
0104
0105 struct nfs4_flexfile_layout {
0106     struct pnfs_layout_hdr generic_hdr;
0107     struct pnfs_ds_commit_info commit_info;
0108     struct list_head    mirrors;
0109     struct list_head    error_list; /* nfs4_ff_layout_ds_err */
0110     ktime_t         last_report_time; /* Layoutstat report times */
0111 };
0112
0113 struct nfs4_flexfile_layoutreturn_args {
0114     struct list_head errors;
0115     struct nfs42_layoutstat_devinfo devinfo[FF_LAYOUTSTATS_MAXDEV];
0116     unsigned int num_errors;
0117     unsigned int num_dev;
0118     struct page *pages[1];
0119 };
0120
0121 static inline struct nfs4_flexfile_layout *
0122 FF_LAYOUT_FROM_HDR(struct pnfs_layout_hdr *lo)
0123 {
0124     return container_of(lo, struct nfs4_flexfile_layout, generic_hdr);
0125 }
0126
0127 static inline struct nfs4_ff_layout_segment *
0128 FF_LAYOUT_LSEG(struct pnfs_layout_segment *lseg)
0129 {
0130     return container_of(lseg,
0131                 struct nfs4_ff_layout_segment,
0132                 generic_hdr);
0133 }
0134
0135 static inline struct nfs4_ff_layout_ds *
0136 FF_LAYOUT_MIRROR_DS(struct nfs4_deviceid_node *node)
0137 {
0138     return container_of(node, struct nfs4_ff_layout_ds, id_node);
0139 }
0140
0141 static inline struct nfs4_ff_layout_mirror *
0142 FF_LAYOUT_COMP(struct pnfs_layout_segment *lseg, u32 idx)
0143 {
0144     struct nfs4_ff_layout_segment *fls = FF_LAYOUT_LSEG(lseg);
0145
0146     if (idx < fls->mirror_array_cnt)
0147         return fls->mirror_array[idx];
0148     return NULL;
0149 }
0150
0151 static inline struct nfs4_deviceid_node *
0152 FF_LAYOUT_DEVID_NODE(struct pnfs_layout_segment *lseg, u32 idx)
0153 {
0154     struct nfs4_ff_layout_mirror *mirror = FF_LAYOUT_COMP(lseg, idx);
0155
0156     if (mirror != NULL) {
0157         struct nfs4_ff_layout_ds *mirror_ds = mirror->mirror_ds;
0158
0159         if (!IS_ERR_OR_NULL(mirror_ds))
0160             return &mirror_ds->id_node;
0161     }
0162     return NULL;
0163 }
0164
0165 static inline u32
0166 FF_LAYOUT_MIRROR_COUNT(struct pnfs_layout_segment *lseg)
0167 {
0168     return FF_LAYOUT_LSEG(lseg)->mirror_array_cnt;
0169 }
0170
0171 static inline bool
0172 ff_layout_no_fallback_to_mds(struct pnfs_layout_segment *lseg)
0173 {
0174     return FF_LAYOUT_LSEG(lseg)->flags & FF_FLAGS_NO_IO_THRU_MDS;
0175 }
0176
0177 static inline bool
0178 ff_layout_no_read_on_rw(struct pnfs_layout_segment *lseg)
0179 {
0180     return FF_LAYOUT_LSEG(lseg)->flags & FF_FLAGS_NO_READ_IO;
0181 }
0182
0183 static inline int
0184 nfs4_ff_layout_ds_version(const struct nfs4_ff_layout_mirror *mirror)
0185 {
0186     return mirror->mirror_ds->ds_versions[0].version;
0187 }
0188
0189 struct nfs4_ff_layout_ds *
0190 nfs4_ff_alloc_deviceid_node(struct nfs_server *server, struct pnfs_device *pdev,
0191                 gfp_t gfp_flags);
0192 void nfs4_ff_layout_put_deviceid(struct nfs4_ff_layout_ds *mirror_ds);
0193 void nfs4_ff_layout_free_deviceid(struct nfs4_ff_layout_ds *mirror_ds);
0194 int ff_layout_track_ds_error(struct nfs4_flexfile_layout *flo,
0195                  struct nfs4_ff_layout_mirror *mirror, u64 offset,
0196                  u64 length, int status, enum nfs_opnum4 opnum,
0197                  gfp_t gfp_flags);
0198 void ff_layout_send_layouterror(struct pnfs_layout_segment *lseg);
0199 int ff_layout_encode_ds_ioerr(struct xdr_stream *xdr, const struct list_head *head);
0200 void ff_layout_free_ds_ioerr(struct list_head *head);
0201 unsigned int ff_layout_fetch_ds_ioerr(struct pnfs_layout_hdr *lo,
0202         const struct pnfs_layout_range *range,
0203         struct list_head *head,
0204         unsigned int maxnum);
0205 struct nfs_fh *
0206 nfs4_ff_layout_select_ds_fh(struct nfs4_ff_layout_mirror *mirror);
0207 void
0208 nfs4_ff_layout_select_ds_stateid(const struct nfs4_ff_layout_mirror *mirror,
0209         nfs4_stateid *stateid);
0210
0211 struct nfs4_pnfs_ds *
0212 nfs4_ff_layout_prepare_ds(struct pnfs_layout_segment *lseg,
0213               struct nfs4_ff_layout_mirror *mirror,
0214               bool fail_return);
0215
0216 struct rpc_clnt *
0217 nfs4_ff_find_or_create_ds_client(struct nfs4_ff_layout_mirror *mirror,
0218                  struct nfs_client *ds_clp,
0219                  struct inode *inode);
0220 const struct cred *ff_layout_get_ds_cred(struct nfs4_ff_layout_mirror *mirror,
0221                      const struct pnfs_layout_range *range,
0222                      const struct cred *mdscred);
0223 bool ff_layout_avoid_mds_available_ds(struct pnfs_layout_segment *lseg);
0224 bool ff_layout_avoid_read_on_rw(struct pnfs_layout_segment *lseg);
0225
0226 #endif /* FS_NFS_NFS4FLEXFILELAYOUT_H */