blob: 172f15e3dfd63d2e7a5dde72dbe3e42a752e31b8 [file] [log] [blame]
Thomas Gleixnerc942fdd2019-05-27 08:55:06 +02001/* SPDX-License-Identifier: GPL-2.0-or-later */
Mike Christiea081c132008-12-02 00:32:11 -06002/*
3 * iSCSI over TCP/IP Data-Path lib
4 *
5 * Copyright (C) 2008 Mike Christie
6 * Copyright (C) 2008 Red Hat, Inc. All rights reserved.
7 * maintained by open-iscsi@googlegroups.com
8 *
Mike Christiea081c132008-12-02 00:32:11 -06009 * See the file COPYING included with this distribution for more details.
10 */
11
12#ifndef LIBISCSI_TCP_H
13#define LIBISCSI_TCP_H
14
15#include <scsi/libiscsi.h>
16
17struct iscsi_tcp_conn;
18struct iscsi_segment;
19struct sk_buff;
Herbert Xu5d6ac292016-01-24 21:19:41 +080020struct ahash_request;
Mike Christiea081c132008-12-02 00:32:11 -060021
22typedef int iscsi_segment_done_fn_t(struct iscsi_tcp_conn *,
23 struct iscsi_segment *);
24
25struct iscsi_segment {
26 unsigned char *data;
27 unsigned int size;
28 unsigned int copied;
29 unsigned int total_size;
30 unsigned int total_copied;
31
Herbert Xu5d6ac292016-01-24 21:19:41 +080032 struct ahash_request *hash;
Karen Xie28568302009-01-10 19:06:07 -080033 unsigned char padbuf[ISCSI_PAD_LEN];
Mike Christiea081c132008-12-02 00:32:11 -060034 unsigned char recv_digest[ISCSI_DIGEST_SIZE];
35 unsigned char digest[ISCSI_DIGEST_SIZE];
36 unsigned int digest_len;
37
38 struct scatterlist *sg;
39 void *sg_mapped;
40 unsigned int sg_offset;
Mike Christie70c7c882011-03-17 16:22:17 -050041 bool atomic_mapped;
Mike Christiea081c132008-12-02 00:32:11 -060042
43 iscsi_segment_done_fn_t *done;
44};
45
Lucas De Marchi25985ed2011-03-30 22:57:33 -030046/* Socket connection receive helper */
Mike Christiea081c132008-12-02 00:32:11 -060047struct iscsi_tcp_recv {
48 struct iscsi_hdr *hdr;
49 struct iscsi_segment segment;
50
51 /* Allocate buffer for BHS + AHS */
52 uint32_t hdr_buf[64];
53
54 /* copied and flipped values */
55 int datalen;
56};
57
58struct iscsi_tcp_conn {
59 struct iscsi_conn *iscsi_conn;
60 void *dd_data;
61 int stop_stage; /* conn_stop() flag: *
62 * stop to recover, *
63 * stop to terminate */
64 /* control data */
65 struct iscsi_tcp_recv in; /* TCP receive context */
66 /* CRC32C (Rx) LLD should set this is they do not offload */
Herbert Xu5d6ac292016-01-24 21:19:41 +080067 struct ahash_request *rx_hash;
Mike Christiea081c132008-12-02 00:32:11 -060068};
69
70struct iscsi_tcp_task {
71 uint32_t exp_datasn; /* expected target's R2TSN/DataSN */
72 int data_offset;
73 struct iscsi_r2t_info *r2t; /* in progress solict R2T */
74 struct iscsi_pool r2tpool;
Stefani Seibold45465482009-12-21 14:37:26 -080075 struct kfifo r2tqueue;
Mike Christiea081c132008-12-02 00:32:11 -060076 void *dd_data;
Shlomo Pongratz659743b2014-02-07 00:41:38 -060077 spinlock_t pool2queue;
78 spinlock_t queue2pool;
Mike Christiea081c132008-12-02 00:32:11 -060079};
80
81enum {
82 ISCSI_TCP_SEGMENT_DONE, /* curr seg has been processed */
83 ISCSI_TCP_SKB_DONE, /* skb is out of data */
84 ISCSI_TCP_CONN_ERR, /* iscsi layer has fired a conn err */
85 ISCSI_TCP_SUSPENDED, /* conn is suspended */
86};
87
88extern void iscsi_tcp_hdr_recv_prep(struct iscsi_tcp_conn *tcp_conn);
89extern int iscsi_tcp_recv_skb(struct iscsi_conn *conn, struct sk_buff *skb,
90 unsigned int offset, bool offloaded, int *status);
91extern void iscsi_tcp_cleanup_task(struct iscsi_task *task);
92extern int iscsi_tcp_task_init(struct iscsi_task *task);
93extern int iscsi_tcp_task_xmit(struct iscsi_task *task);
94
95/* segment helpers */
96extern int iscsi_tcp_recv_segment_is_hdr(struct iscsi_tcp_conn *tcp_conn);
Mike Christie6df19a72008-12-02 00:32:16 -060097extern int iscsi_tcp_segment_done(struct iscsi_tcp_conn *tcp_conn,
98 struct iscsi_segment *segment, int recv,
Mike Christiea081c132008-12-02 00:32:11 -060099 unsigned copied);
100extern void iscsi_tcp_segment_unmap(struct iscsi_segment *segment);
101
102extern void iscsi_segment_init_linear(struct iscsi_segment *segment,
103 void *data, size_t size,
104 iscsi_segment_done_fn_t *done,
Herbert Xu5d6ac292016-01-24 21:19:41 +0800105 struct ahash_request *hash);
Mike Christiea081c132008-12-02 00:32:11 -0600106extern int
107iscsi_segment_seek_sg(struct iscsi_segment *segment,
108 struct scatterlist *sg_list, unsigned int sg_count,
109 unsigned int offset, size_t size,
Herbert Xu5d6ac292016-01-24 21:19:41 +0800110 iscsi_segment_done_fn_t *done,
111 struct ahash_request *hash);
Mike Christiea081c132008-12-02 00:32:11 -0600112
113/* digest helpers */
Herbert Xu5d6ac292016-01-24 21:19:41 +0800114extern void iscsi_tcp_dgst_header(struct ahash_request *hash, const void *hdr,
Mike Christiea081c132008-12-02 00:32:11 -0600115 size_t hdrlen,
116 unsigned char digest[ISCSI_DIGEST_SIZE]);
117extern struct iscsi_cls_conn *
118iscsi_tcp_conn_setup(struct iscsi_cls_session *cls_session, int dd_data_size,
119 uint32_t conn_idx);
120extern void iscsi_tcp_conn_teardown(struct iscsi_cls_conn *cls_conn);
121
122/* misc helpers */
123extern int iscsi_tcp_r2tpool_alloc(struct iscsi_session *session);
124extern void iscsi_tcp_r2tpool_free(struct iscsi_session *session);
Mike Christie1304be52012-01-26 21:13:10 -0600125extern int iscsi_tcp_set_max_r2t(struct iscsi_conn *conn, char *buf);
Mike Christiea081c132008-12-02 00:32:11 -0600126extern void iscsi_tcp_conn_get_stats(struct iscsi_cls_conn *cls_conn,
127 struct iscsi_stats *stats);
128#endif /* LIBISCSI_TCP_H */