ctl_frontend_iscsi.h revision 276613
1/*-
2 * Copyright (c) 2012 The FreeBSD Foundation
3 * All rights reserved.
4 *
5 * This software was developed by Edward Tomasz Napierala under sponsorship
6 * from the FreeBSD Foundation.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD: stable/10/sys/cam/ctl/ctl_frontend_iscsi.h 276613 2015-01-03 13:08:08Z mav $
30 */
31
32#ifndef CTL_FRONTEND_ISCSI_H
33#define	CTL_FRONTEND_ISCSI_H
34
35#define CFISCSI_TARGET_STATE_INVALID	0
36#define CFISCSI_TARGET_STATE_ACTIVE	1
37#define CFISCSI_TARGET_STATE_DYING	2
38
39struct cfiscsi_target {
40	TAILQ_ENTRY(cfiscsi_target)	ct_next;
41	uint32_t			ct_luns[CTL_MAX_LUNS];
42	struct cfiscsi_softc		*ct_softc;
43	volatile u_int			ct_refcount;
44	char				ct_name[CTL_ISCSI_NAME_LEN];
45	char				ct_alias[CTL_ISCSI_ALIAS_LEN];
46	int				ct_state;
47	int				ct_online;
48	int				ct_target_id;
49	struct ctl_port			ct_port;
50};
51
52struct cfiscsi_data_wait {
53	TAILQ_ENTRY(cfiscsi_data_wait)	cdw_next;
54	union ctl_io			*cdw_ctl_io;
55	uint32_t			cdw_target_transfer_tag;
56	uint32_t			cdw_initiator_task_tag;
57	int				cdw_sg_index;
58	char				*cdw_sg_addr;
59	size_t				cdw_sg_len;
60	uint32_t			cdw_r2t_end;
61	uint32_t			cdw_datasn;
62};
63
64#define CFISCSI_SESSION_STATE_INVALID		0
65#define CFISCSI_SESSION_STATE_BHS		1
66#define CFISCSI_SESSION_STATE_AHS		2
67#define CFISCSI_SESSION_STATE_HEADER_DIGEST	3
68#define CFISCSI_SESSION_STATE_DATA		4
69#define CFISCSI_SESSION_STATE_DATA_DIGEST	5
70
71struct cfiscsi_session {
72	TAILQ_ENTRY(cfiscsi_session)	cs_next;
73	struct mtx			cs_lock;
74	struct icl_conn			*cs_conn;
75	uint32_t			cs_cmdsn;
76	uint32_t			cs_statsn;
77	uint32_t			cs_target_transfer_tag;
78	volatile u_int			cs_outstanding_ctl_pdus;
79	TAILQ_HEAD(, cfiscsi_data_wait)	cs_waiting_for_data_out;
80	struct cfiscsi_target		*cs_target;
81	struct callout			cs_callout;
82	int				cs_timeout;
83	int				cs_portal_group_tag;
84	struct cv			cs_maintenance_cv;
85	bool				cs_terminating;
86	bool				cs_tasks_aborted;
87	size_t				cs_max_data_segment_length;
88	size_t				cs_max_burst_length;
89	bool				cs_immediate_data;
90	char				cs_initiator_name[CTL_ISCSI_NAME_LEN];
91	char				cs_initiator_addr[CTL_ISCSI_ADDR_LEN];
92	char				cs_initiator_alias[CTL_ISCSI_ALIAS_LEN];
93	char				cs_initiator_isid[6];
94	char				cs_initiator_id[CTL_ISCSI_NAME_LEN + 5 + 6 + 1];
95	unsigned int			cs_id;
96	int				cs_ctl_initid;
97#ifdef ICL_KERNEL_PROXY
98	struct sockaddr			*cs_initiator_sa;
99	int				cs_portal_id;
100	bool				cs_login_phase;
101	bool				cs_waiting_for_ctld;
102	struct cv			cs_login_cv;
103	struct icl_pdu			*cs_login_pdu;
104#endif
105};
106
107#ifdef ICL_KERNEL_PROXY
108struct icl_listen;
109#endif
110
111struct cfiscsi_softc {
112	struct mtx			lock;
113	char				port_name[32];
114	int				online;
115	int				last_target_id;
116	unsigned int			last_session_id;
117	TAILQ_HEAD(, cfiscsi_target)	targets;
118	TAILQ_HEAD(, cfiscsi_session)	sessions;
119	struct cv			sessions_cv;
120#ifdef ICL_KERNEL_PROXY
121	struct icl_listen		*listener;
122	struct cv			accept_cv;
123#endif
124};
125
126#endif /* !CTL_FRONTEND_ISCSI_H */
127