iscsi_target_parameters.h 9.8 KB

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