[mirror_ubuntu-bionic-kernel.git] / include / scsi / libiscsi_tcp.h

/*
 * iSCSI over TCP/IP Data-Path lib
 *
 * Copyright (C) 2008 Mike Christie
 * Copyright (C) 2008 Red Hat, Inc.  All rights reserved.
 * maintained by open-iscsi@googlegroups.com
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * See the file COPYING included with this distribution for more details.
 */

#ifndef LIBISCSI_TCP_H
#define LIBISCSI_TCP_H

#include <scsi/libiscsi.h>

struct iscsi_tcp_conn;
struct iscsi_segment;
struct sk_buff;
struct ahash_request;

typedef int iscsi_segment_done_fn_t(struct iscsi_tcp_conn *,
				    struct iscsi_segment *);

struct iscsi_segment {
	unsigned char		*data;
	unsigned int		size;
	unsigned int		copied;
	unsigned int		total_size;
	unsigned int		total_copied;

	struct ahash_request	*hash;
	unsigned char		padbuf[ISCSI_PAD_LEN];
	unsigned char		recv_digest[ISCSI_DIGEST_SIZE];
	unsigned char		digest[ISCSI_DIGEST_SIZE];
	unsigned int		digest_len;

	struct scatterlist	*sg;
	void			*sg_mapped;
	unsigned int		sg_offset;
	bool			atomic_mapped;

	iscsi_segment_done_fn_t	*done;
};

/* Socket connection receive helper */
struct iscsi_tcp_recv {
	struct iscsi_hdr	*hdr;
	struct iscsi_segment	segment;

	/* Allocate buffer for BHS + AHS */
	uint32_t		hdr_buf[64];

	/* copied and flipped values */
	int			datalen;
};

struct iscsi_tcp_conn {
	struct iscsi_conn	*iscsi_conn;
	void			*dd_data;
	int			stop_stage;	/* conn_stop() flag: *
						 * stop to recover,  *
						 * stop to terminate */
	/* control data */
	struct iscsi_tcp_recv	in;		/* TCP receive context */
	/* CRC32C (Rx) LLD should set this is they do not offload */
	struct ahash_request	*rx_hash;
};

struct iscsi_tcp_task {
	uint32_t		exp_datasn;	/* expected target's R2TSN/DataSN */
	int			data_offset;
	struct iscsi_r2t_info	*r2t;		/* in progress solict R2T */
	struct iscsi_pool	r2tpool;
	struct kfifo		r2tqueue;
	void			*dd_data;
	spinlock_t		pool2queue;
	spinlock_t		queue2pool;
};

enum {
	ISCSI_TCP_SEGMENT_DONE,		/* curr seg has been processed */
	ISCSI_TCP_SKB_DONE,		/* skb is out of data */
	ISCSI_TCP_CONN_ERR,		/* iscsi layer has fired a conn err */
	ISCSI_TCP_SUSPENDED,		/* conn is suspended */
};

extern void iscsi_tcp_hdr_recv_prep(struct iscsi_tcp_conn *tcp_conn);
extern int iscsi_tcp_recv_skb(struct iscsi_conn *conn, struct sk_buff *skb,
			      unsigned int offset, bool offloaded, int *status);
extern void iscsi_tcp_cleanup_task(struct iscsi_task *task);
extern int iscsi_tcp_task_init(struct iscsi_task *task);
extern int iscsi_tcp_task_xmit(struct iscsi_task *task);

/* segment helpers */
extern int iscsi_tcp_recv_segment_is_hdr(struct iscsi_tcp_conn *tcp_conn);
extern int iscsi_tcp_segment_done(struct iscsi_tcp_conn *tcp_conn,
				  struct iscsi_segment *segment, int recv,
				  unsigned copied);
extern void iscsi_tcp_segment_unmap(struct iscsi_segment *segment);

extern void iscsi_segment_init_linear(struct iscsi_segment *segment,
				      void *data, size_t size,
				      iscsi_segment_done_fn_t *done,
				      struct ahash_request *hash);
extern int
iscsi_segment_seek_sg(struct iscsi_segment *segment,
		      struct scatterlist *sg_list, unsigned int sg_count,
		      unsigned int offset, size_t size,
		      iscsi_segment_done_fn_t *done,
		      struct ahash_request *hash);

/* digest helpers */
extern void iscsi_tcp_dgst_header(struct ahash_request *hash, const void *hdr,
				  size_t hdrlen,
				  unsigned char digest[ISCSI_DIGEST_SIZE]);
extern struct iscsi_cls_conn *
iscsi_tcp_conn_setup(struct iscsi_cls_session *cls_session, int dd_data_size,
		     uint32_t conn_idx);
extern void iscsi_tcp_conn_teardown(struct iscsi_cls_conn *cls_conn);

/* misc helpers */
extern int iscsi_tcp_r2tpool_alloc(struct iscsi_session *session);
extern void iscsi_tcp_r2tpool_free(struct iscsi_session *session);
extern int iscsi_tcp_set_max_r2t(struct iscsi_conn *conn, char *buf);
extern void iscsi_tcp_conn_get_stats(struct iscsi_cls_conn *cls_conn,
				     struct iscsi_stats *stats);
#endif /* LIBISCSI_TCP_H */
Commit	Line	Data
a081c13e MC	1	/*
	2	* iSCSI over TCP/IP Data-Path lib
	3	*
	4	* Copyright (C) 2008 Mike Christie
	5	* Copyright (C) 2008 Red Hat, Inc. All rights reserved.
	6	* maintained by open-iscsi@googlegroups.com
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License as published
	10	* by the Free Software Foundation; either version 2 of the License, or
	11	* (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful, but
	14	* WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	* General Public License for more details.
	17	*
	18	* See the file COPYING included with this distribution for more details.
	19	*/
	20
	21	#ifndef LIBISCSI_TCP_H
	22	#define LIBISCSI_TCP_H
	23
	24	#include <scsi/libiscsi.h>
	25
	26	struct iscsi_tcp_conn;
	27	struct iscsi_segment;
	28	struct sk_buff;
5d6ac29b	29	struct ahash_request;
a081c13e MC	30
	31	typedef int iscsi_segment_done_fn_t(struct iscsi_tcp_conn *,
	32	struct iscsi_segment *);
	33
	34	struct iscsi_segment {
	35	unsigned char *data;
	36	unsigned int size;
	37	unsigned int copied;
	38	unsigned int total_size;
	39	unsigned int total_copied;
	40
5d6ac29b	41	struct ahash_request *hash;
2856830b	42	unsigned char padbuf[ISCSI_PAD_LEN];
a081c13e MC	43	unsigned char recv_digest[ISCSI_DIGEST_SIZE];
	44	unsigned char digest[ISCSI_DIGEST_SIZE];
	45	unsigned int digest_len;
	46
	47	struct scatterlist *sg;
	48	void *sg_mapped;
	49	unsigned int sg_offset;
70c7c88a	50	bool atomic_mapped;
a081c13e MC	51
	52	iscsi_segment_done_fn_t *done;
	53	};
	54
25985edc	55	/* Socket connection receive helper */
a081c13e MC	56	struct iscsi_tcp_recv {
	57	struct iscsi_hdr *hdr;
	58	struct iscsi_segment segment;
	59
	60	/* Allocate buffer for BHS + AHS */
	61	uint32_t hdr_buf[64];
	62
	63	/* copied and flipped values */
	64	int datalen;
	65	};
	66
	67	struct iscsi_tcp_conn {
	68	struct iscsi_conn *iscsi_conn;
	69	void *dd_data;
	70	int stop_stage; /* conn_stop() flag: *
	71	* stop to recover, *
	72	* stop to terminate */
	73	/* control data */
	74	struct iscsi_tcp_recv in; /* TCP receive context */
	75	/* CRC32C (Rx) LLD should set this is they do not offload */
5d6ac29b	76	struct ahash_request *rx_hash;
a081c13e MC	77	};
	78
	79	struct iscsi_tcp_task {
	80	uint32_t exp_datasn; /* expected target's R2TSN/DataSN */
	81	int data_offset;
	82	struct iscsi_r2t_info r2t; / in progress solict R2T */
	83	struct iscsi_pool r2tpool;
45465487	84	struct kfifo r2tqueue;
a081c13e	85	void *dd_data;
659743b0 SP	86	spinlock_t pool2queue;
659743b0 SP	87	spinlock_t queue2pool;
a081c13e MC	88	};
	89
	90	enum {
	91	ISCSI_TCP_SEGMENT_DONE, /* curr seg has been processed */
	92	ISCSI_TCP_SKB_DONE, /* skb is out of data */
	93	ISCSI_TCP_CONN_ERR, /* iscsi layer has fired a conn err */
	94	ISCSI_TCP_SUSPENDED, /* conn is suspended */
	95	};
	96
	97	extern void iscsi_tcp_hdr_recv_prep(struct iscsi_tcp_conn *tcp_conn);
	98	extern int iscsi_tcp_recv_skb(struct iscsi_conn conn, struct sk_buff skb,
	99	unsigned int offset, bool offloaded, int *status);
	100	extern void iscsi_tcp_cleanup_task(struct iscsi_task *task);
	101	extern int iscsi_tcp_task_init(struct iscsi_task *task);
	102	extern int iscsi_tcp_task_xmit(struct iscsi_task *task);
	103
	104	/* segment helpers */
	105	extern int iscsi_tcp_recv_segment_is_hdr(struct iscsi_tcp_conn *tcp_conn);
6df19a79 MC	106	extern int iscsi_tcp_segment_done(struct iscsi_tcp_conn *tcp_conn,
6df19a79 MC	107	struct iscsi_segment *segment, int recv,
a081c13e MC	108	unsigned copied);
	109	extern void iscsi_tcp_segment_unmap(struct iscsi_segment *segment);
	110
	111	extern void iscsi_segment_init_linear(struct iscsi_segment *segment,
	112	void *data, size_t size,
	113	iscsi_segment_done_fn_t *done,
5d6ac29b	114	struct ahash_request *hash);
a081c13e MC	115	extern int
	116	iscsi_segment_seek_sg(struct iscsi_segment *segment,
	117	struct scatterlist *sg_list, unsigned int sg_count,
	118	unsigned int offset, size_t size,
5d6ac29b HX	119	iscsi_segment_done_fn_t *done,
5d6ac29b HX	120	struct ahash_request *hash);
a081c13e MC	121
a081c13e MC	122	/* digest helpers */
5d6ac29b	123	extern void iscsi_tcp_dgst_header(struct ahash_request hash, const void hdr,
a081c13e MC	124	size_t hdrlen,
	125	unsigned char digest[ISCSI_DIGEST_SIZE]);
	126	extern struct iscsi_cls_conn *
	127	iscsi_tcp_conn_setup(struct iscsi_cls_session *cls_session, int dd_data_size,
	128	uint32_t conn_idx);
	129	extern void iscsi_tcp_conn_teardown(struct iscsi_cls_conn *cls_conn);
	130
	131	/* misc helpers */
	132	extern int iscsi_tcp_r2tpool_alloc(struct iscsi_session *session);
	133	extern void iscsi_tcp_r2tpool_free(struct iscsi_session *session);
1304be5f	134	extern int iscsi_tcp_set_max_r2t(struct iscsi_conn conn, char buf);
a081c13e MC	135	extern void iscsi_tcp_conn_get_stats(struct iscsi_cls_conn *cls_conn,
	136	struct iscsi_stats *stats);
	137	#endif /* LIBISCSI_TCP_H */