iscsi_target_parameters.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2#ifndef ISCSI_PARAMETERS_H
  3#define ISCSI_PARAMETERS_H
  4
  5#include <linux/types.h>
  6#include <scsi/iscsi_proto.h>
  7
  8struct iscsi_extra_response {
  9	char key[KEY_MAXLEN];
 10	char value[32];
 11	struct list_head er_list;
 12} ____cacheline_aligned;
 13
 14struct iscsi_param {
 15	char *name;
 16	char *value;
 17	u8 set_param;
 18	u8 phase;
 19	u8 scope;
 20	u8 sender;
 21	u8 type;
 22	u8 use;
 23	u16 type_range;
 24	u32 state;
 25	struct list_head p_list;
 26} ____cacheline_aligned;
 27
 28struct iscsit_conn;
 29struct iscsi_conn_ops;
 30struct iscsi_param_list;
 31struct iscsi_sess_ops;
 32
 33extern int iscsi_login_rx_data(struct iscsit_conn *, char *, int);
 34extern int iscsi_login_tx_data(struct iscsit_conn *, char *, char *, int);
 35extern int iscsi_create_default_params(struct iscsi_param_list **);
 36extern int iscsi_set_keys_to_negotiate(struct iscsi_param_list *, bool);
 37extern int iscsi_set_keys_irrelevant_for_discovery(struct iscsi_param_list *);
 38extern int iscsi_copy_param_list(struct iscsi_param_list **,
 39			struct iscsi_param_list *, int);
 40extern int iscsi_change_param_value(char *, struct iscsi_param_list *, int);
 41extern void iscsi_release_param_list(struct iscsi_param_list *);
 42extern struct iscsi_param *iscsi_find_param_from_key(char *, struct iscsi_param_list *);
 43extern int iscsi_extract_key_value(char *, char **, char **);
 44extern int iscsi_update_param_value(struct iscsi_param *, char *);
 45extern int iscsi_decode_text_input(u8, u8, char *, u32, struct iscsit_conn *);
 46extern int iscsi_encode_text_output(u8, u8, char *, u32 *,
 47			struct iscsi_param_list *, bool);
 48extern int iscsi_check_negotiated_keys(struct iscsi_param_list *);
 49extern void iscsi_set_connection_parameters(struct iscsi_conn_ops *,
 50			struct iscsi_param_list *);
 51extern void iscsi_set_session_parameters(struct iscsi_sess_ops *,
 52			struct iscsi_param_list *, int);
 53
 54#define YES				"Yes"
 55#define NO				"No"
 56#define ALL				"All"
 57#define IRRELEVANT			"Irrelevant"
 58#define NONE				"None"
 59#define NOTUNDERSTOOD			"NotUnderstood"
 60#define REJECT				"Reject"
 61
 62/*
 63 * The Parameter Names.
 64 */
 65#define AUTHMETHOD			"AuthMethod"
 66#define HEADERDIGEST			"HeaderDigest"
 67#define DATADIGEST			"DataDigest"
 68#define MAXCONNECTIONS			"MaxConnections"
 69#define SENDTARGETS			"SendTargets"
 70#define TARGETNAME			"TargetName"
 71#define INITIATORNAME			"InitiatorName"
 72#define TARGETALIAS			"TargetAlias"
 73#define INITIATORALIAS			"InitiatorAlias"
 74#define TARGETADDRESS			"TargetAddress"
 75#define TARGETPORTALGROUPTAG		"TargetPortalGroupTag"
 76#define INITIALR2T			"InitialR2T"
 77#define IMMEDIATEDATA			"ImmediateData"
 78#define MAXRECVDATASEGMENTLENGTH	"MaxRecvDataSegmentLength"
 79#define MAXXMITDATASEGMENTLENGTH	"MaxXmitDataSegmentLength"
 80#define MAXBURSTLENGTH			"MaxBurstLength"
 81#define FIRSTBURSTLENGTH		"FirstBurstLength"
 82#define DEFAULTTIME2WAIT		"DefaultTime2Wait"
 83#define DEFAULTTIME2RETAIN		"DefaultTime2Retain"
 84#define MAXOUTSTANDINGR2T		"MaxOutstandingR2T"
 85#define DATAPDUINORDER			"DataPDUInOrder"
 86#define DATASEQUENCEINORDER		"DataSequenceInOrder"
 87#define ERRORRECOVERYLEVEL		"ErrorRecoveryLevel"
 88#define SESSIONTYPE			"SessionType"
 89#define IFMARKER			"IFMarker"
 90#define OFMARKER			"OFMarker"
 91#define IFMARKINT			"IFMarkInt"
 92#define OFMARKINT			"OFMarkInt"
 93
 94/*
 95 * Parameter names of iSCSI Extentions for RDMA (iSER).  See RFC-5046
 96 */
 97#define RDMAEXTENSIONS			"RDMAExtensions"
 98#define INITIATORRECVDATASEGMENTLENGTH	"InitiatorRecvDataSegmentLength"
 99#define TARGETRECVDATASEGMENTLENGTH	"TargetRecvDataSegmentLength"
100
101/*
102 * For AuthMethod.
103 */
104#define KRB5				"KRB5"
105#define SPKM1				"SPKM1"
106#define SPKM2				"SPKM2"
107#define SRP				"SRP"
108#define CHAP				"CHAP"
109
110/*
111 * Initial values for Parameter Negotiation.
112 */
113#define INITIAL_AUTHMETHOD			CHAP
114#define INITIAL_HEADERDIGEST			"CRC32C,None"
115#define INITIAL_DATADIGEST			"CRC32C,None"
116#define INITIAL_MAXCONNECTIONS			"1"
117#define INITIAL_SENDTARGETS			ALL
118#define INITIAL_TARGETNAME			"LIO.Target"
119#define INITIAL_INITIATORNAME			"LIO.Initiator"
120#define INITIAL_TARGETALIAS			"LIO Target"
121#define INITIAL_INITIATORALIAS			"LIO Initiator"
122#define INITIAL_TARGETADDRESS			"0.0.0.0:0000,0"
123#define INITIAL_TARGETPORTALGROUPTAG		"1"
124#define INITIAL_INITIALR2T			YES
125#define INITIAL_IMMEDIATEDATA			YES
126#define INITIAL_MAXRECVDATASEGMENTLENGTH	"8192"
127/*
128 * Match outgoing MXDSL default to incoming Open-iSCSI default
129 */
130#define INITIAL_MAXXMITDATASEGMENTLENGTH	"262144"
131#define INITIAL_MAXBURSTLENGTH			"262144"
132#define INITIAL_FIRSTBURSTLENGTH		"65536"
133#define INITIAL_DEFAULTTIME2WAIT		"2"
134#define INITIAL_DEFAULTTIME2RETAIN		"20"
135#define INITIAL_MAXOUTSTANDINGR2T		"1"
136#define INITIAL_DATAPDUINORDER			YES
137#define INITIAL_DATASEQUENCEINORDER		YES
138#define INITIAL_ERRORRECOVERYLEVEL		"0"
139#define INITIAL_SESSIONTYPE			NORMAL
140#define INITIAL_IFMARKER			NO
141#define INITIAL_OFMARKER			NO
142#define INITIAL_IFMARKINT			REJECT
143#define INITIAL_OFMARKINT			REJECT
144
145/*
146 * Initial values for iSER parameters following RFC-5046 Section 6
147 */
148#define INITIAL_RDMAEXTENSIONS			NO
149#define INITIAL_INITIATORRECVDATASEGMENTLENGTH	"262144"
150#define INITIAL_TARGETRECVDATASEGMENTLENGTH	"8192"
151
152/*
153 * For [Header,Data]Digests.
154 */
155#define CRC32C				"CRC32C"
156
157/*
158 * For SessionType.
159 */
160#define DISCOVERY			"Discovery"
161#define NORMAL				"Normal"
162
163/*
164 * struct iscsi_param->use
165 */
166#define USE_LEADING_ONLY		0x01
167#define USE_INITIAL_ONLY		0x02
168#define USE_ALL				0x04
169
170#define IS_USE_LEADING_ONLY(p)		((p)->use & USE_LEADING_ONLY)
171#define IS_USE_INITIAL_ONLY(p)		((p)->use & USE_INITIAL_ONLY)
172#define IS_USE_ALL(p)			((p)->use & USE_ALL)
173
174#define SET_USE_INITIAL_ONLY(p)		((p)->use |= USE_INITIAL_ONLY)
175
176/*
177 * struct iscsi_param->sender
178 */
179#define	SENDER_INITIATOR		0x01
180#define SENDER_TARGET			0x02
181#define SENDER_BOTH			0x03
182/* Used in iscsi_check_key() */
183#define SENDER_RECEIVER			0x04
184
185#define IS_SENDER_INITIATOR(p)		((p)->sender & SENDER_INITIATOR)
186#define IS_SENDER_TARGET(p)		((p)->sender & SENDER_TARGET)
187#define IS_SENDER_BOTH(p)		((p)->sender & SENDER_BOTH)
188
189/*
190 * struct iscsi_param->scope
191 */
192#define SCOPE_CONNECTION_ONLY		0x01
193#define SCOPE_SESSION_WIDE		0x02
194
195#define IS_SCOPE_CONNECTION_ONLY(p)	((p)->scope & SCOPE_CONNECTION_ONLY)
196#define IS_SCOPE_SESSION_WIDE(p)	((p)->scope & SCOPE_SESSION_WIDE)
197
198/*
199 * struct iscsi_param->phase
200 */
201#define PHASE_SECURITY			0x01
202#define PHASE_OPERATIONAL		0x02
203#define PHASE_DECLARATIVE		0x04
204#define PHASE_FFP0			0x08
205
206#define IS_PHASE_SECURITY(p)		((p)->phase & PHASE_SECURITY)
207#define IS_PHASE_OPERATIONAL(p)		((p)->phase & PHASE_OPERATIONAL)
208#define IS_PHASE_DECLARATIVE(p)		((p)->phase & PHASE_DECLARATIVE)
209#define IS_PHASE_FFP0(p)		((p)->phase & PHASE_FFP0)
210
211/*
212 * struct iscsi_param->type
213 */
214#define TYPE_BOOL_AND			0x01
215#define TYPE_BOOL_OR			0x02
216#define TYPE_NUMBER			0x04
217#define TYPE_NUMBER_RANGE		0x08
218#define TYPE_STRING			0x10
219#define TYPE_VALUE_LIST			0x20
220
221#define IS_TYPE_BOOL_AND(p)		((p)->type & TYPE_BOOL_AND)
222#define IS_TYPE_BOOL_OR(p)		((p)->type & TYPE_BOOL_OR)
223#define IS_TYPE_NUMBER(p)		((p)->type & TYPE_NUMBER)
224#define IS_TYPE_NUMBER_RANGE(p)		((p)->type & TYPE_NUMBER_RANGE)
225#define IS_TYPE_STRING(p)		((p)->type & TYPE_STRING)
226#define IS_TYPE_VALUE_LIST(p)		((p)->type & TYPE_VALUE_LIST)
227
228/*
229 * struct iscsi_param->type_range
230 */
231#define TYPERANGE_BOOL_AND		0x0001
232#define TYPERANGE_BOOL_OR		0x0002
233#define TYPERANGE_0_TO_2		0x0004
234#define TYPERANGE_0_TO_3600		0x0008
235#define TYPERANGE_0_TO_32767		0x0010
236#define TYPERANGE_0_TO_65535		0x0020
237#define TYPERANGE_1_TO_65535		0x0040
238#define TYPERANGE_2_TO_3600		0x0080
239#define TYPERANGE_512_TO_16777215	0x0100
240#define TYPERANGE_AUTH			0x0200
241#define TYPERANGE_DIGEST		0x0400
242#define TYPERANGE_ISCSINAME		0x0800
243#define TYPERANGE_SESSIONTYPE		0x1000
244#define TYPERANGE_TARGETADDRESS		0x2000
245#define TYPERANGE_UTF8			0x4000
246
247#define IS_TYPERANGE_0_TO_2(p)		((p)->type_range & TYPERANGE_0_TO_2)
248#define IS_TYPERANGE_0_TO_3600(p)	((p)->type_range & TYPERANGE_0_TO_3600)
249#define IS_TYPERANGE_0_TO_32767(p)	((p)->type_range & TYPERANGE_0_TO_32767)
250#define IS_TYPERANGE_0_TO_65535(p)	((p)->type_range & TYPERANGE_0_TO_65535)
251#define IS_TYPERANGE_1_TO_65535(p)	((p)->type_range & TYPERANGE_1_TO_65535)
252#define IS_TYPERANGE_2_TO_3600(p)	((p)->type_range & TYPERANGE_2_TO_3600)
253#define IS_TYPERANGE_512_TO_16777215(p)	((p)->type_range & \
254						TYPERANGE_512_TO_16777215)
255#define IS_TYPERANGE_AUTH_PARAM(p)	((p)->type_range & TYPERANGE_AUTH)
256#define IS_TYPERANGE_DIGEST_PARAM(p)	((p)->type_range & TYPERANGE_DIGEST)
257#define IS_TYPERANGE_SESSIONTYPE(p)	((p)->type_range & \
258						TYPERANGE_SESSIONTYPE)
259
260/*
261 * struct iscsi_param->state
262 */
263#define PSTATE_ACCEPTOR			0x01
264#define PSTATE_NEGOTIATE		0x02
265#define PSTATE_PROPOSER			0x04
266#define PSTATE_IRRELEVANT		0x08
267#define PSTATE_REJECT			0x10
268#define PSTATE_REPLY_OPTIONAL		0x20
269#define PSTATE_RESPONSE_GOT		0x40
270#define PSTATE_RESPONSE_SENT		0x80
271
272#define IS_PSTATE_ACCEPTOR(p)		((p)->state & PSTATE_ACCEPTOR)
273#define IS_PSTATE_NEGOTIATE(p)		((p)->state & PSTATE_NEGOTIATE)
274#define IS_PSTATE_PROPOSER(p)		((p)->state & PSTATE_PROPOSER)
275#define IS_PSTATE_IRRELEVANT(p)		((p)->state & PSTATE_IRRELEVANT)
276#define IS_PSTATE_REJECT(p)		((p)->state & PSTATE_REJECT)
277#define IS_PSTATE_REPLY_OPTIONAL(p)	((p)->state & PSTATE_REPLY_OPTIONAL)
278#define IS_PSTATE_RESPONSE_GOT(p)	((p)->state & PSTATE_RESPONSE_GOT)
279#define IS_PSTATE_RESPONSE_SENT(p)	((p)->state & PSTATE_RESPONSE_SENT)
280
281#define SET_PSTATE_ACCEPTOR(p)		((p)->state |= PSTATE_ACCEPTOR)
282#define SET_PSTATE_NEGOTIATE(p)		((p)->state |= PSTATE_NEGOTIATE)
283#define SET_PSTATE_PROPOSER(p)		((p)->state |= PSTATE_PROPOSER)
284#define SET_PSTATE_IRRELEVANT(p)	((p)->state |= PSTATE_IRRELEVANT)
285#define SET_PSTATE_REJECT(p)		((p)->state |= PSTATE_REJECT)
286#define SET_PSTATE_REPLY_OPTIONAL(p)	((p)->state |= PSTATE_REPLY_OPTIONAL)
287#define SET_PSTATE_RESPONSE_GOT(p)	((p)->state |= PSTATE_RESPONSE_GOT)
288#define SET_PSTATE_RESPONSE_SENT(p)	((p)->state |= PSTATE_RESPONSE_SENT)
289
290#endif /* ISCSI_PARAMETERS_H */