[deliverable/linux.git] / drivers / block / aoe / aoe.h

/* Copyright (c) 2013 Coraid, Inc.  See COPYING for GPL terms. */
#define VERSION "85"
#define AOE_MAJOR 152
#define DEVICE_NAME "aoe"

/* set AOE_PARTITIONS to 1 to use whole-disks only
 * default is 16, which is 15 partitions plus the whole disk
 */
#ifndef AOE_PARTITIONS
#define AOE_PARTITIONS (16)
#endif

#define WHITESPACE " \t\v\f\n,"

enum {
	AOECMD_ATA,
	AOECMD_CFG,
	AOECMD_VEND_MIN = 0xf0,

	AOEFL_RSP = (1<<3),
	AOEFL_ERR = (1<<2),

	AOEAFL_EXT = (1<<6),
	AOEAFL_DEV = (1<<4),
	AOEAFL_ASYNC = (1<<1),
	AOEAFL_WRITE = (1<<0),

	AOECCMD_READ = 0,
	AOECCMD_TEST,
	AOECCMD_PTEST,
	AOECCMD_SET,
	AOECCMD_FSET,

	AOE_HVER = 0x10,
};

struct aoe_hdr {
	unsigned char dst[6];
	unsigned char src[6];
	__be16 type;
	unsigned char verfl;
	unsigned char err;
	__be16 major;
	unsigned char minor;
	unsigned char cmd;
	__be32 tag;
};

struct aoe_atahdr {
	unsigned char aflags;
	unsigned char errfeat;
	unsigned char scnt;
	unsigned char cmdstat;
	unsigned char lba0;
	unsigned char lba1;
	unsigned char lba2;
	unsigned char lba3;
	unsigned char lba4;
	unsigned char lba5;
	unsigned char res[2];
};

struct aoe_cfghdr {
	__be16 bufcnt;
	__be16 fwver;
	unsigned char scnt;
	unsigned char aoeccmd;
	unsigned char cslen[2];
};

enum {
	DEVFL_UP = 1,	/* device is installed in system and ready for AoE->ATA commands */
	DEVFL_TKILL = (1<<1),	/* flag for timer to know when to kill self */
	DEVFL_EXT = (1<<2),	/* device accepts lba48 commands */
	DEVFL_GDALLOC = (1<<3),	/* need to alloc gendisk */
	DEVFL_GD_NOW = (1<<4),	/* allocating gendisk */
	DEVFL_KICKME = (1<<5),	/* slow polling network card catch */
	DEVFL_NEWSIZE = (1<<6),	/* need to update dev size in block layer */
	DEVFL_FREEING = (1<<7),	/* set when device is being cleaned up */
	DEVFL_FREED = (1<<8),	/* device has been cleaned up */
};

enum {
	DEFAULTBCNT = 2 * 512,	/* 2 sectors */
	MIN_BUFS = 16,
	NTARGETS = 4,
	NAOEIFS = 8,
	NSKBPOOLMAX = 256,
	NFACTIVE = 61,

	TIMERTICK = HZ / 10,
	RTTSCALE = 8,
	RTTDSCALE = 3,
	RTTAVG_INIT = USEC_PER_SEC / 4 << RTTSCALE,
	RTTDEV_INIT = RTTAVG_INIT / 4,

	HARD_SCORN_SECS = 10,	/* try another remote port after this */
	MAX_TAINT = 1000,	/* cap on aoetgt taint */
};

struct buf {
	ulong nframesout;
	struct bio *bio;
	struct bvec_iter iter;
	struct request *rq;
};

enum frame_flags {
	FFL_PROBE = 1,
};

struct frame {
	struct list_head head;
	u32 tag;
	struct timeval sent;	/* high-res time packet was sent */
	u32 sent_jiffs;		/* low-res jiffies-based sent time */
	ulong waited;
	ulong waited_total;
	struct aoetgt *t;		/* parent target I belong to */
	struct sk_buff *skb;		/* command skb freed on module exit */
	struct sk_buff *r_skb;		/* response skb for async processing */
	struct buf *buf;
	struct bvec_iter iter;
	char flags;
};

struct aoeif {
	struct net_device *nd;
	ulong lost;
	int bcnt;
};

struct aoetgt {
	unsigned char addr[6];
	ushort nframes;		/* cap on frames to use */
	struct aoedev *d;			/* parent device I belong to */
	struct list_head ffree;			/* list of free frames */
	struct aoeif ifs[NAOEIFS];
	struct aoeif *ifp;	/* current aoeif in use */
	ushort nout;		/* number of AoE commands outstanding */
	ushort maxout;		/* current value for max outstanding */
	ushort next_cwnd;	/* incr maxout after decrementing to zero */
	ushort ssthresh;	/* slow start threshold */
	ulong falloc;		/* number of allocated frames */
	int taint;		/* how much we want to avoid this aoetgt */
	int minbcnt;
	int wpkts, rpkts;
	char nout_probes;
};

struct aoedev {
	struct aoedev *next;
	ulong sysminor;
	ulong aoemajor;
	u32 rttavg;		/* scaled AoE round trip time average */
	u32 rttdev;		/* scaled round trip time mean deviation */
	u16 aoeminor;
	u16 flags;
	u16 nopen;		/* (bd_openers isn't available without sleeping) */
	u16 fw_ver;		/* version of blade's firmware */
	u16 lasttag;		/* last tag sent */
	u16 useme;
	ulong ref;
	struct work_struct work;/* disk create work struct */
	struct gendisk *gd;
	struct dentry *debugfs;
	struct request_queue *blkq;
	struct hd_geometry geo;
	sector_t ssize;
	struct timer_list timer;
	spinlock_t lock;
	struct sk_buff_head skbpool;
	mempool_t *bufpool;	/* for deadlock-free Buf allocation */
	struct {		/* pointers to work in progress */
		struct buf *buf;
		struct bio *nxbio;
		struct request *rq;
	} ip;
	ulong maxbcnt;
	struct list_head factive[NFACTIVE];	/* hash of active frames */
	struct list_head rexmitq; /* deferred retransmissions */
	struct aoetgt **targets;
	ulong ntargets;		/* number of allocated aoetgt pointers */
	struct aoetgt **tgt;	/* target in use when working */
	ulong kicked;
	char ident[512];
};

/* kthread tracking */
struct ktstate {
	struct completion rendez;
	struct task_struct *task;
	wait_queue_head_t *waitq;
	int (*fn) (int);
	char name[12];
	spinlock_t *lock;
	int id;
	int active;
};

int aoeblk_init(void);
void aoeblk_exit(void);
void aoeblk_gdalloc(void *);
void aoedisk_rm_debugfs(struct aoedev *d);
void aoedisk_rm_sysfs(struct aoedev *d);

int aoechr_init(void);
void aoechr_exit(void);
void aoechr_error(char *);

void aoecmd_work(struct aoedev *d);
void aoecmd_cfg(ushort aoemajor, unsigned char aoeminor);
struct sk_buff *aoecmd_ata_rsp(struct sk_buff *);
void aoecmd_cfg_rsp(struct sk_buff *);
void aoecmd_sleepwork(struct work_struct *);
void aoecmd_wreset(struct aoetgt *t);
void aoecmd_cleanslate(struct aoedev *);
void aoecmd_exit(void);
int aoecmd_init(void);
struct sk_buff *aoecmd_ata_id(struct aoedev *);
void aoe_freetframe(struct frame *);
void aoe_flush_iocq(void);
void aoe_flush_iocq_by_index(int);
void aoe_end_request(struct aoedev *, struct request *, int);
int aoe_ktstart(struct ktstate *k);
void aoe_ktstop(struct ktstate *k);

int aoedev_init(void);
void aoedev_exit(void);
struct aoedev *aoedev_by_aoeaddr(ulong maj, int min, int do_alloc);
void aoedev_downdev(struct aoedev *d);
int aoedev_flush(const char __user *str, size_t size);
void aoe_failbuf(struct aoedev *, struct buf *);
void aoedev_put(struct aoedev *);

int aoenet_init(void);
void aoenet_exit(void);
void aoenet_xmit(struct sk_buff_head *);
int is_aoe_netif(struct net_device *ifp);
int set_aoe_iflist(const char __user *str, size_t size);
Commit	Line	Data
ca47bbd9	1	/* Copyright (c) 2013 Coraid, Inc. See COPYING for GPL terms. */
896dcd9a	2	#define VERSION "85"
1da177e4 LT	3	#define AOE_MAJOR 152
1da177e4 LT	4	#define DEVICE_NAME "aoe"
fc458dcd	5
	6	/* set AOE_PARTITIONS to 1 to use whole-disks only
	7	* default is 16, which is 15 partitions plus the whole disk
	8	*/
1da177e4	9	#ifndef AOE_PARTITIONS
e39526e6	10	#define AOE_PARTITIONS (16)
1da177e4	11	#endif
fc458dcd	12
4a6c9ee9	13	#define WHITESPACE " \t\v\f\n,"
1da177e4 LT	14
	15	enum {
	16	AOECMD_ATA,
	17	AOECMD_CFG,
b6d6c517	18	AOECMD_VEND_MIN = 0xf0,
1da177e4 LT	19
	20	AOEFL_RSP = (1<<3),
	21	AOEFL_ERR = (1<<2),
	22
	23	AOEAFL_EXT = (1<<6),
	24	AOEAFL_DEV = (1<<4),
	25	AOEAFL_ASYNC = (1<<1),
	26	AOEAFL_WRITE = (1<<0),
	27
	28	AOECCMD_READ = 0,
	29	AOECCMD_TEST,
	30	AOECCMD_PTEST,
	31	AOECCMD_SET,
	32	AOECCMD_FSET,
	33
	34	AOE_HVER = 0x10,
	35	};
	36
	37	struct aoe_hdr {
	38	unsigned char dst[6];
	39	unsigned char src[6];
63e9cc5d	40	__be16 type;
1da177e4 LT	41	unsigned char verfl;
1da177e4 LT	42	unsigned char err;
63e9cc5d	43	__be16 major;
1da177e4 LT	44	unsigned char minor;
1da177e4 LT	45	unsigned char cmd;
63e9cc5d	46	__be32 tag;
1da177e4 LT	47	};
	48
	49	struct aoe_atahdr {
	50	unsigned char aflags;
	51	unsigned char errfeat;
	52	unsigned char scnt;
	53	unsigned char cmdstat;
	54	unsigned char lba0;
	55	unsigned char lba1;
	56	unsigned char lba2;
	57	unsigned char lba3;
	58	unsigned char lba4;
	59	unsigned char lba5;
	60	unsigned char res[2];
	61	};
	62
	63	struct aoe_cfghdr {
63e9cc5d	64	__be16 bufcnt;
63e9cc5d	65	__be16 fwver;
19bf2635	66	unsigned char scnt;
1da177e4 LT	67	unsigned char aoeccmd;
	68	unsigned char cslen[2];
	69	};
	70
	71	enum {
	72	DEVFL_UP = 1, /* device is installed in system and ready for AoE->ATA commands */
	73	DEVFL_TKILL = (1<<1), /* flag for timer to know when to kill self */
	74	DEVFL_EXT = (1<<2), /* device accepts lba48 commands */
b21faa25	75	DEVFL_GDALLOC = (1<<3), /* need to alloc gendisk */
e52a2932 EC	76	DEVFL_GD_NOW = (1<<4), /* allocating gendisk */
	77	DEVFL_KICKME = (1<<5), /* slow polling network card catch */
	78	DEVFL_NEWSIZE = (1<<6), /* need to update dev size in block layer */
	79	DEVFL_FREEING = (1<<7), /* set when device is being cleaned up */
	80	DEVFL_FREED = (1<<8), /* device has been cleaned up */
1da177e4 LT	81	};
	82
	83	enum {
19bf2635	84	DEFAULTBCNT = 2 * 512, /* 2 sectors */
68e0d42f	85	MIN_BUFS = 16,
71114ec4	86	NTARGETS = 4,
68e0d42f	87	NAOEIFS = 8,
69cf2d85	88	NSKBPOOLMAX = 256,
64a80f5a	89	NFACTIVE = 61,
68e0d42f EC	90
68e0d42f EC	91	TIMERTICK = HZ / 10,
3a0c40d2 EC	92	RTTSCALE = 8,
3a0c40d2 EC	93	RTTDSCALE = 3,
5f0c9c48	94	RTTAVG_INIT = USEC_PER_SEC / 4 << RTTSCALE,
3a0c40d2	95	RTTDEV_INIT = RTTAVG_INIT / 4,
bbb44e30 EC	96
	97	HARD_SCORN_SECS = 10, /* try another remote port after this */
	98	MAX_TAINT = 1000, /* cap on aoetgt taint */
1da177e4 LT	99	};
	100
	101	struct buf {
1da177e4	102	ulong nframesout;
1da177e4	103	struct bio *bio;
feb261e2	104	struct bvec_iter iter;
69cf2d85	105	struct request *rq;
1da177e4 LT	106	};
1da177e4 LT	107
bbb44e30 EC	108	enum frame_flags {
	109	FFL_PROBE = 1,
	110	};
	111
1da177e4	112	struct frame {
896831f5 EC	113	struct list_head head;
896831f5 EC	114	u32 tag;
5f0c9c48 EC	115	struct timeval sent; /* high-res time packet was sent */
5f0c9c48 EC	116	u32 sent_jiffs; /* low-res jiffies-based sent time */
1da177e4	117	ulong waited;
3fc9b032	118	ulong waited_total;
896831f5	119	struct aoetgt t; / parent target I belong to */
896831f5 EC	120	struct sk_buff skb; / command skb freed on module exit */
896831f5 EC	121	struct sk_buff r_skb; / response skb for async processing */
69cf2d85	122	struct buf *buf;
feb261e2	123	struct bvec_iter iter;
bbb44e30	124	char flags;
1da177e4 LT	125	};
1da177e4 LT	126
68e0d42f EC	127	struct aoeif {
68e0d42f EC	128	struct net_device *nd;
3f0f0133 EC	129	ulong lost;
3f0f0133 EC	130	int bcnt;
68e0d42f EC	131	};
	132
	133	struct aoetgt {
	134	unsigned char addr[6];
1b8a1636	135	ushort nframes; /* cap on frames to use */
896831f5	136	struct aoedev d; / parent device I belong to */
896831f5	137	struct list_head ffree; /* list of free frames */
68e0d42f EC	138	struct aoeif ifs[NAOEIFS];
68e0d42f EC	139	struct aoeif ifp; / current aoeif in use */
72837600	140	ushort nout; /* number of AoE commands outstanding */
1b8a1636	141	ushort maxout; /* current value for max outstanding */
3a0c40d2 EC	142	ushort next_cwnd; /* incr maxout after decrementing to zero */
3a0c40d2 EC	143	ushort ssthresh; /* slow start threshold */
1b8a1636	144	ulong falloc; /* number of allocated frames */
bbb44e30	145	int taint; /* how much we want to avoid this aoetgt */
3f0f0133	146	int minbcnt;
68e0d42f	147	int wpkts, rpkts;
bbb44e30	148	char nout_probes;
68e0d42f EC	149	};
68e0d42f EC	150
1da177e4 LT	151	struct aoedev {
1da177e4 LT	152	struct aoedev *next;
1da177e4 LT	153	ulong sysminor;
1da177e4 LT	154	ulong aoemajor;
5f0c9c48 EC	155	u32 rttavg; /* scaled AoE round trip time average */
5f0c9c48 EC	156	u32 rttdev; /* scaled round trip time mean deviation */
68e0d42f EC	157	u16 aoeminor;
68e0d42f EC	158	u16 flags;
dced3a05	159	u16 nopen; /* (bd_openers isn't available without sleeping) */
1da177e4	160	u16 fw_ver; /* version of blade's firmware */
64a80f5a EC	161	u16 lasttag; /* last tag sent */
64a80f5a EC	162	u16 useme;
69cf2d85	163	ulong ref;
1da177e4 LT	164	struct work_struct work;/* disk create work struct */
1da177e4 LT	165	struct gendisk *gd;
e8866cf2	166	struct dentry *debugfs;
7135a71b	167	struct request_queue *blkq;
a04b41cd	168	struct hd_geometry geo;
1da177e4 LT	169	sector_t ssize;
	170	struct timer_list timer;
	171	spinlock_t lock;
e9bb8fb0	172	struct sk_buff_head skbpool;
1da177e4	173	mempool_t bufpool; / for deadlock-free Buf allocation */
69cf2d85 EC	174	struct { /* pointers to work in progress */
	175	struct buf *buf;
	176	struct bio *nxbio;
	177	struct request *rq;
	178	} ip;
3f0f0133	179	ulong maxbcnt;
64a80f5a	180	struct list_head factive[NFACTIVE]; /* hash of active frames */
3a0c40d2	181	struct list_head rexmitq; /* deferred retransmissions */
71114ec4 EC	182	struct aoetgt **targets;
71114ec4 EC	183	ulong ntargets; /* number of allocated aoetgt pointers */
68e0d42f	184	struct aoetgt *tgt; / target in use when working */
896831f5	185	ulong kicked;
667be1e7	186	char ident[512];
1da177e4 LT	187	};
1da177e4 LT	188
896831f5 EC	189	/* kthread tracking */
	190	struct ktstate {
	191	struct completion rendez;
	192	struct task_struct *task;
	193	wait_queue_head_t *waitq;
8030d343 EC	194	int (*fn) (int);
8030d343 EC	195	char name[12];
896831f5	196	spinlock_t *lock;
8030d343 EC	197	int id;
8030d343 EC	198	int active;
896831f5	199	};
1da177e4 LT	200
	201	int aoeblk_init(void);
	202	void aoeblk_exit(void);
	203	void aoeblk_gdalloc(void *);
e8866cf2	204	void aoedisk_rm_debugfs(struct aoedev *d);
1da177e4 LT	205	void aoedisk_rm_sysfs(struct aoedev *d);
	206
	207	int aoechr_init(void);
	208	void aoechr_exit(void);
	209	void aoechr_error(char *);
	210
	211	void aoecmd_work(struct aoedev *d);
3ae1c24e	212	void aoecmd_cfg(ushort aoemajor, unsigned char aoeminor);
896831f5	213	struct sk_buff aoecmd_ata_rsp(struct sk_buff );
1da177e4	214	void aoecmd_cfg_rsp(struct sk_buff *);
c4028958	215	void aoecmd_sleepwork(struct work_struct *);
3a0c40d2	216	void aoecmd_wreset(struct aoetgt *t);
68e0d42f	217	void aoecmd_cleanslate(struct aoedev *);
896831f5 EC	218	void aoecmd_exit(void);
896831f5 EC	219	int aoecmd_init(void);
68e0d42f	220	struct sk_buff aoecmd_ata_id(struct aoedev );
896831f5	221	void aoe_freetframe(struct frame *);
69cf2d85	222	void aoe_flush_iocq(void);
8030d343	223	void aoe_flush_iocq_by_index(int);
69cf2d85	224	void aoe_end_request(struct aoedev , struct request , int);
eb086ec5 EC	225	int aoe_ktstart(struct ktstate *k);
eb086ec5 EC	226	void aoe_ktstop(struct ktstate *k);
1da177e4 LT	227
	228	int aoedev_init(void);
	229	void aoedev_exit(void);
0c966214	230	struct aoedev *aoedev_by_aoeaddr(ulong maj, int min, int do_alloc);
1da177e4	231	void aoedev_downdev(struct aoedev *d);
262bf541	232	int aoedev_flush(const char __user *str, size_t size);
69cf2d85 EC	233	void aoe_failbuf(struct aoedev , struct buf );
69cf2d85 EC	234	void aoedev_put(struct aoedev *);
1da177e4 LT	235
	236	int aoenet_init(void);
	237	void aoenet_exit(void);
e9bb8fb0	238	void aoenet_xmit(struct sk_buff_head *);
1da177e4 LT	239	int is_aoe_netif(struct net_device *ifp);
1da177e4 LT	240	int set_aoe_iflist(const char __user *str, size_t size);