[mirror_ubuntu-bionic-kernel.git] / fs / nfs / nfs4filelayout.h

/*
 *  NFSv4 file layout driver data structures.
 *
 *  Copyright (c) 2002
 *  The Regents of the University of Michigan
 *  All Rights Reserved
 *
 *  Dean Hildebrand <dhildebz@umich.edu>
 *
 *  Permission is granted to use, copy, create derivative works, and
 *  redistribute this software and such derivative works for any purpose,
 *  so long as the name of the University of Michigan is not used in
 *  any advertising or publicity pertaining to the use or distribution
 *  of this software without specific, written prior authorization. If
 *  the above copyright notice or any other identification of the
 *  University of Michigan is included in any copy of any portion of
 *  this software, then the disclaimer below must also be included.
 *
 *  This software is provided as is, without representation or warranty
 *  of any kind either express or implied, including without limitation
 *  the implied warranties of merchantability, fitness for a particular
 *  purpose, or noninfringement.  The Regents of the University of
 *  Michigan shall not be liable for any damages, including special,
 *  indirect, incidental, or consequential damages, with respect to any
 *  claim arising out of or in connection with the use of the software,
 *  even if it has been or is hereafter advised of the possibility of
 *  such damages.
 */

#ifndef FS_NFS_NFS4FILELAYOUT_H
#define FS_NFS_NFS4FILELAYOUT_H

#include "pnfs.h"

/*
 * Default data server connection timeout and retrans vaules.
 * Set by module paramters dataserver_timeo and dataserver_retrans.
 */
#define NFS4_DEF_DS_TIMEO   600 /* in tenths of a second */
#define NFS4_DEF_DS_RETRANS 5

/*
 * Field testing shows we need to support up to 4096 stripe indices.
 * We store each index as a u8 (u32 on the wire) to keep the memory footprint
 * reasonable. This in turn means we support a maximum of 256
 * RFC 5661 multipath_list4 structures.
 */
#define NFS4_PNFS_MAX_STRIPE_CNT 4096
#define NFS4_PNFS_MAX_MULTI_CNT  256 /* 256 fit into a u8 stripe_index */

/* error codes for internal use */
#define NFS4ERR_RESET_TO_MDS   12001

enum stripetype4 {
	STRIPE_SPARSE = 1,
	STRIPE_DENSE = 2
};

/* Individual ip address */
struct nfs4_pnfs_ds_addr {
	struct sockaddr_storage	da_addr;
	size_t			da_addrlen;
	struct list_head	da_node;  /* nfs4_pnfs_dev_hlist dev_dslist */
	char			*da_remotestr;	/* human readable addr+port */
};

struct nfs4_pnfs_ds {
	struct list_head	ds_node;  /* nfs4_pnfs_dev_hlist dev_dslist */
	char			*ds_remotestr;	/* comma sep list of addrs */
	struct list_head	ds_addrs;
	struct nfs_client	*ds_clp;
	atomic_t		ds_count;
	unsigned long		ds_state;
#define NFS4DS_CONNECTING	0	/* ds is establishing connection */
};

struct nfs4_file_layout_dsaddr {
	struct nfs4_deviceid_node	id_node;
	u32				stripe_count;
	u8				*stripe_indices;
	u32				ds_num;
	struct nfs4_pnfs_ds		*ds_list[1];
};

struct nfs4_filelayout_segment {
	struct pnfs_layout_segment generic_hdr;
	u32 stripe_type;
	u32 commit_through_mds;
	u32 stripe_unit;
	u32 first_stripe_index;
	u64 pattern_offset;
	struct nfs4_file_layout_dsaddr *dsaddr; /* Point to GETDEVINFO data */
	unsigned int num_fh;
	struct nfs_fh **fh_array;
};

struct nfs4_filelayout {
	struct pnfs_layout_hdr generic_hdr;
	struct pnfs_ds_commit_info commit_info;
};

static inline struct nfs4_filelayout *
FILELAYOUT_FROM_HDR(struct pnfs_layout_hdr *lo)
{
	return container_of(lo, struct nfs4_filelayout, generic_hdr);
}

static inline struct nfs4_filelayout_segment *
FILELAYOUT_LSEG(struct pnfs_layout_segment *lseg)
{
	return container_of(lseg,
			    struct nfs4_filelayout_segment,
			    generic_hdr);
}

static inline struct nfs4_deviceid_node *
FILELAYOUT_DEVID_NODE(struct pnfs_layout_segment *lseg)
{
	return &FILELAYOUT_LSEG(lseg)->dsaddr->id_node;
}

static inline void
filelayout_mark_devid_invalid(struct nfs4_deviceid_node *node)
{
	u32 *p = (u32 *)&node->deviceid;

	printk(KERN_WARNING "NFS: Deviceid [%x%x%x%x] marked out of use.\n",
		p[0], p[1], p[2], p[3]);

	set_bit(NFS_DEVICEID_INVALID, &node->flags);
}

static inline bool
filelayout_test_devid_invalid(struct nfs4_deviceid_node *node)
{
	return test_bit(NFS_DEVICEID_INVALID, &node->flags);
}

extern bool
filelayout_test_devid_unavailable(struct nfs4_deviceid_node *node);

extern struct nfs_fh *
nfs4_fl_select_ds_fh(struct pnfs_layout_segment *lseg, u32 j);

extern void print_ds(struct nfs4_pnfs_ds *ds);
u32 nfs4_fl_calc_j_index(struct pnfs_layout_segment *lseg, loff_t offset);
u32 nfs4_fl_calc_ds_index(struct pnfs_layout_segment *lseg, u32 j);
struct nfs4_pnfs_ds *nfs4_fl_prepare_ds(struct pnfs_layout_segment *lseg,
					u32 ds_idx);
extern void nfs4_fl_put_deviceid(struct nfs4_file_layout_dsaddr *dsaddr);
extern void nfs4_fl_free_deviceid(struct nfs4_file_layout_dsaddr *dsaddr);
struct nfs4_file_layout_dsaddr *
filelayout_get_device_info(struct inode *inode, struct nfs4_deviceid *dev_id,
		struct rpc_cred *cred, gfp_t gfp_flags);

#endif /* FS_NFS_NFS4FILELAYOUT_H */
Commit	Line	Data
16b374ca AA	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
98fc685a AA	35	/*
	36	* Default data server connection timeout and retrans vaules.
	37	* Set by module paramters dataserver_timeo and dataserver_retrans.
	38	*/
eb97cbb4	39	#define NFS4_DEF_DS_TIMEO 600 /* in tenths of a second */
98fc685a AA	40	#define NFS4_DEF_DS_RETRANS 5
98fc685a AA	41
16b374ca	42	/*
25985edc	43	* Field testing shows we need to support up to 4096 stripe indices.
16b374ca AA	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
e7dd79af AA	51	/* error codes for internal use */
	52	#define NFS4ERR_RESET_TO_MDS 12001
	53
16b374ca AA	54	enum stripetype4 {
	55	STRIPE_SPARSE = 1,
	56	STRIPE_DENSE = 2
	57	};
	58
	59	/* Individual ip address */
14f9a607 WAA	60	struct 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
16b374ca AA	67	struct nfs4_pnfs_ds {
16b374ca AA	68	struct list_head ds_node; /* nfs4_pnfs_dev_hlist dev_dslist */
14f9a607 WAA	69	char ds_remotestr; / comma sep list of addrs */
14f9a607 WAA	70	struct list_head ds_addrs;
16b374ca AA	71	struct nfs_client *ds_clp;
16b374ca AA	72	atomic_t ds_count;
c23266d5 AA	73	unsigned long ds_state;
c23266d5 AA	74	#define NFS4DS_CONNECTING 0 /* ds is establishing connection */
16b374ca AA	75	};
	76
	77	struct nfs4_file_layout_dsaddr {
a1eaecbc	78	struct nfs4_deviceid_node id_node;
16b374ca AA	79	u32 stripe_count;
	80	u8 *stripe_indices;
	81	u32 ds_num;
	82	struct nfs4_pnfs_ds *ds_list[1];
	83	};
	84
	85	struct 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
799ba8d5 FI	97	struct nfs4_filelayout {
799ba8d5 FI	98	struct pnfs_layout_hdr generic_hdr;
ea2cf228	99	struct pnfs_ds_commit_info commit_info;
799ba8d5 FI	100	};
	101
	102	static inline struct nfs4_filelayout *
	103	FILELAYOUT_FROM_HDR(struct pnfs_layout_hdr *lo)
	104	{
	105	return container_of(lo, struct nfs4_filelayout, generic_hdr);
	106	}
	107
16b374ca AA	108	static inline struct nfs4_filelayout_segment *
	109	FILELAYOUT_LSEG(struct pnfs_layout_segment *lseg)
	110	{
	111	return container_of(lseg,
	112	struct nfs4_filelayout_segment,
	113	generic_hdr);
	114	}
	115
c47abcf8 AA	116	static inline struct nfs4_deviceid_node *
	117	FILELAYOUT_DEVID_NODE(struct pnfs_layout_segment *lseg)
	118	{
	119	return &FILELAYOUT_LSEG(lseg)->dsaddr->id_node;
	120	}
	121
554d458d AA	122	static inline void
	123	filelayout_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
	133	static inline bool
	134	filelayout_test_devid_invalid(struct nfs4_deviceid_node *node)
	135	{
	136	return test_bit(NFS_DEVICEID_INVALID, &node->flags);
	137	}
	138
1dfed273 TM	139	extern bool
1dfed273 TM	140	filelayout_test_devid_unavailable(struct nfs4_deviceid_node *node);
041245c8	141
cfe7f412 FI	142	extern struct nfs_fh *
	143	nfs4_fl_select_ds_fh(struct pnfs_layout_segment *lseg, u32 j);
	144
16b374ca	145	extern void print_ds(struct nfs4_pnfs_ds *ds);
cfe7f412 FI	146	u32 nfs4_fl_calc_j_index(struct pnfs_layout_segment *lseg, loff_t offset);
	147	u32 nfs4_fl_calc_ds_index(struct pnfs_layout_segment *lseg, u32 j);
	148	struct nfs4_pnfs_ds nfs4_fl_prepare_ds(struct pnfs_layout_segment lseg,
	149	u32 ds_idx);
ea8eecdd	150	extern void nfs4_fl_put_deviceid(struct nfs4_file_layout_dsaddr *dsaddr);
1775bc34	151	extern void nfs4_fl_free_deviceid(struct nfs4_file_layout_dsaddr *dsaddr);
16b374ca	152	struct nfs4_file_layout_dsaddr *
cd5875fe TM	153	filelayout_get_device_info(struct inode inode, struct nfs4_deviceid dev_id,
cd5875fe TM	154	struct rpc_cred *cred, gfp_t gfp_flags);
16b374ca AA	155
16b374ca AA	156	#endif /* FS_NFS_NFS4FILELAYOUT_H */