LXR linux/fs/nfs/filelayout/filelayout.h

   1/*
   2 *  NFSv4 file layout driver 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_NFS4FILELAYOUT_H
  31#define FS_NFS_NFS4FILELAYOUT_H
  32
  33#include "../pnfs.h"
  34
  35/*
  36 * Default data server connection timeout and retrans vaules.
  37 * Set by module paramters dataserver_timeo and dataserver_retrans.
  38 */
  39#define NFS4_DEF_DS_TIMEO   600 /* in tenths of a second */
  40#define NFS4_DEF_DS_RETRANS 5
  41
  42/*
  43 * Field testing shows we need to support up to 4096 stripe indices.
  44 * We store each index as a u8 (u32 on the wire) to keep the memory footprint
  45 * reasonable. This in turn means we support a maximum of 256
  46 * RFC 5661 multipath_list4 structures.
  47 */
  48#define NFS4_PNFS_MAX_STRIPE_CNT 4096
  49#define NFS4_PNFS_MAX_MULTI_CNT  256 /* 256 fit into a u8 stripe_index */
  50
  51/* error codes for internal use */
  52#define NFS4ERR_RESET_TO_MDS   12001
  53
  54enum stripetype4 {
  55        STRIPE_SPARSE = 1,
  56        STRIPE_DENSE = 2
  57};
  58
  59/* Individual ip address */
  60struct nfs4_pnfs_ds_addr {
  61        struct sockaddr_storage da_addr;
  62        size_t                  da_addrlen;
  63        struct list_head        da_node;  /* nfs4_pnfs_dev_hlist dev_dslist */
  64        char                    *da_remotestr;  /* human readable addr+port */
  65};
  66
  67struct nfs4_pnfs_ds {
  68        struct list_head        ds_node;  /* nfs4_pnfs_dev_hlist dev_dslist */
  69        char                    *ds_remotestr;  /* comma sep list of addrs */
  70        struct list_head        ds_addrs;
  71        struct nfs_client       *ds_clp;
  72        atomic_t                ds_count;
  73        unsigned long           ds_state;
  74#define NFS4DS_CONNECTING       0       /* ds is establishing connection */
  75};
  76
  77struct nfs4_file_layout_dsaddr {
  78        struct nfs4_deviceid_node       id_node;
  79        u32                             stripe_count;
  80        u8                              *stripe_indices;
  81        u32                             ds_num;
  82        struct nfs4_pnfs_ds             *ds_list[1];
  83};
  84
  85struct nfs4_filelayout_segment {
  86        struct pnfs_layout_segment generic_hdr;
  87        u32 stripe_type;
  88        u32 commit_through_mds;
  89        u32 stripe_unit;
  90        u32 first_stripe_index;
  91        u64 pattern_offset;
  92        struct nfs4_file_layout_dsaddr *dsaddr; /* Point to GETDEVINFO data */
  93        unsigned int num_fh;
  94        struct nfs_fh **fh_array;
  95};
  96
  97struct nfs4_filelayout {
  98        struct pnfs_layout_hdr generic_hdr;
  99        struct pnfs_ds_commit_info commit_info;
 100};
 101
 102static inline struct nfs4_filelayout *
 103FILELAYOUT_FROM_HDR(struct pnfs_layout_hdr *lo)
 104{
 105        return container_of(lo, struct nfs4_filelayout, generic_hdr);
 106}
 107
 108static inline struct nfs4_filelayout_segment *
 109FILELAYOUT_LSEG(struct pnfs_layout_segment *lseg)
 110{
 111        return container_of(lseg,
 112                            struct nfs4_filelayout_segment,
 113                            generic_hdr);
 114}
 115
 116static inline struct nfs4_deviceid_node *
 117FILELAYOUT_DEVID_NODE(struct pnfs_layout_segment *lseg)
 118{
 119        return &FILELAYOUT_LSEG(lseg)->dsaddr->id_node;
 120}
 121
 122static inline void
 123filelayout_mark_devid_invalid(struct nfs4_deviceid_node *node)
 124{
 125        u32 *p = (u32 *)&node->deviceid;
 126
 127        printk(KERN_WARNING "NFS: Deviceid [%x%x%x%x] marked out of use.\n",
 128                p[0], p[1], p[2], p[3]);
 129
 130        set_bit(NFS_DEVICEID_INVALID, &node->flags);
 131}
 132
 133static inline bool
 134filelayout_test_devid_invalid(struct nfs4_deviceid_node *node)
 135{
 136        return test_bit(NFS_DEVICEID_INVALID, &node->flags);
 137}
 138
 139extern bool
 140filelayout_test_devid_unavailable(struct nfs4_deviceid_node *node);
 141
 142extern struct nfs_fh *
 143nfs4_fl_select_ds_fh(struct pnfs_layout_segment *lseg, u32 j);
 144
 145extern void print_ds(struct nfs4_pnfs_ds *ds);
 146u32 nfs4_fl_calc_j_index(struct pnfs_layout_segment *lseg, loff_t offset);
 147u32 nfs4_fl_calc_ds_index(struct pnfs_layout_segment *lseg, u32 j);
 148struct nfs4_pnfs_ds *nfs4_fl_prepare_ds(struct pnfs_layout_segment *lseg,
 149                                        u32 ds_idx);
 150
 151extern struct nfs4_file_layout_dsaddr *
 152nfs4_fl_alloc_deviceid_node(struct nfs_server *server,
 153        struct pnfs_device *pdev, gfp_t gfp_flags);
 154extern void nfs4_fl_put_deviceid(struct nfs4_file_layout_dsaddr *dsaddr);
 155extern void nfs4_fl_free_deviceid(struct nfs4_file_layout_dsaddr *dsaddr);
 156
 157#endif /* FS_NFS_NFS4FILELAYOUT_H */
 158