2 * iSCSI User/Kernel Shares (Defines, Constants, Protocol definitions, etc)
4 * Copyright (C) 2005 Dmitry Yusupov
5 * Copyright (C) 2005 Alex Aizman
6 * maintained by open-iscsi@googlegroups.com
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.
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.
18 * See the file COPYING included with this distribution for more details.
24 #include <scsi/iscsi_proto.h>
26 #include <linux/in6.h>
28 #define ISCSI_NL_GRP_ISCSID 1
29 #define ISCSI_NL_GRP_UIP 2
31 #define UEVENT_BASE 10
32 #define KEVENT_BASE 100
33 #define ISCSI_ERR_BASE 1000
36 ISCSI_UEVENT_UNKNOWN
= 0,
39 ISCSI_UEVENT_CREATE_SESSION
= UEVENT_BASE
+ 1,
40 ISCSI_UEVENT_DESTROY_SESSION
= UEVENT_BASE
+ 2,
41 ISCSI_UEVENT_CREATE_CONN
= UEVENT_BASE
+ 3,
42 ISCSI_UEVENT_DESTROY_CONN
= UEVENT_BASE
+ 4,
43 ISCSI_UEVENT_BIND_CONN
= UEVENT_BASE
+ 5,
44 ISCSI_UEVENT_SET_PARAM
= UEVENT_BASE
+ 6,
45 ISCSI_UEVENT_START_CONN
= UEVENT_BASE
+ 7,
46 ISCSI_UEVENT_STOP_CONN
= UEVENT_BASE
+ 8,
47 ISCSI_UEVENT_SEND_PDU
= UEVENT_BASE
+ 9,
48 ISCSI_UEVENT_GET_STATS
= UEVENT_BASE
+ 10,
49 ISCSI_UEVENT_GET_PARAM
= UEVENT_BASE
+ 11,
51 ISCSI_UEVENT_TRANSPORT_EP_CONNECT
= UEVENT_BASE
+ 12,
52 ISCSI_UEVENT_TRANSPORT_EP_POLL
= UEVENT_BASE
+ 13,
53 ISCSI_UEVENT_TRANSPORT_EP_DISCONNECT
= UEVENT_BASE
+ 14,
55 ISCSI_UEVENT_TGT_DSCVR
= UEVENT_BASE
+ 15,
56 ISCSI_UEVENT_SET_HOST_PARAM
= UEVENT_BASE
+ 16,
57 ISCSI_UEVENT_UNBIND_SESSION
= UEVENT_BASE
+ 17,
58 ISCSI_UEVENT_CREATE_BOUND_SESSION
= UEVENT_BASE
+ 18,
59 ISCSI_UEVENT_TRANSPORT_EP_CONNECT_THROUGH_HOST
= UEVENT_BASE
+ 19,
61 ISCSI_UEVENT_PATH_UPDATE
= UEVENT_BASE
+ 20,
62 ISCSI_UEVENT_SET_IFACE_PARAMS
= UEVENT_BASE
+ 21,
63 ISCSI_UEVENT_PING
= UEVENT_BASE
+ 22,
64 ISCSI_UEVENT_GET_CHAP
= UEVENT_BASE
+ 23,
65 ISCSI_UEVENT_DELETE_CHAP
= UEVENT_BASE
+ 24,
68 ISCSI_KEVENT_RECV_PDU
= KEVENT_BASE
+ 1,
69 ISCSI_KEVENT_CONN_ERROR
= KEVENT_BASE
+ 2,
70 ISCSI_KEVENT_IF_ERROR
= KEVENT_BASE
+ 3,
71 ISCSI_KEVENT_DESTROY_SESSION
= KEVENT_BASE
+ 4,
72 ISCSI_KEVENT_UNBIND_SESSION
= KEVENT_BASE
+ 5,
73 ISCSI_KEVENT_CREATE_SESSION
= KEVENT_BASE
+ 6,
75 ISCSI_KEVENT_PATH_REQ
= KEVENT_BASE
+ 7,
76 ISCSI_KEVENT_IF_DOWN
= KEVENT_BASE
+ 8,
77 ISCSI_KEVENT_CONN_LOGIN_STATE
= KEVENT_BASE
+ 9,
78 ISCSI_KEVENT_HOST_EVENT
= KEVENT_BASE
+ 10,
79 ISCSI_KEVENT_PING_COMP
= KEVENT_BASE
+ 11,
82 enum iscsi_tgt_dscvr
{
83 ISCSI_TGT_DSCVR_SEND_TARGETS
= 1,
84 ISCSI_TGT_DSCVR_ISNS
= 2,
85 ISCSI_TGT_DSCVR_SLP
= 3,
88 enum iscsi_host_event_code
{
89 ISCSI_EVENT_LINKUP
= 1,
91 /* must always be last */
96 uint32_t type
; /* k/u events type */
97 uint32_t iferror
; /* carries interface or resource errors */
98 uint64_t transport_handle
;
101 /* messages u -> k */
102 struct msg_create_session
{
103 uint32_t initial_cmdsn
;
105 uint16_t queue_depth
;
107 struct msg_create_bound_session
{
109 uint32_t initial_cmdsn
;
111 uint16_t queue_depth
;
113 struct msg_destroy_session
{
116 struct msg_create_conn
{
120 struct msg_bind_conn
{
123 uint64_t transport_eph
;
126 struct msg_destroy_conn
{
130 struct msg_send_pdu
{
136 struct msg_set_param
{
139 uint32_t param
; /* enum iscsi_param */
142 struct msg_start_conn
{
146 struct msg_stop_conn
{
149 uint64_t conn_handle
;
152 struct msg_get_stats
{
156 struct msg_transport_connect
{
157 uint32_t non_blocking
;
159 struct msg_transport_connect_through_host
{
161 uint32_t non_blocking
;
162 } ep_connect_through_host
;
163 struct msg_transport_poll
{
167 struct msg_transport_disconnect
{
170 struct msg_tgt_dscvr
{
171 enum iscsi_tgt_dscvr type
;
174 * enable = 1 to establish a new connection
175 * with the server. enable = 0 to disconnect
176 * from the server. Used primarily to switch
177 * from one iSNS server to another.
181 struct msg_set_host_param
{
183 uint32_t param
; /* enum iscsi_host_param */
186 struct msg_set_path
{
189 struct msg_set_iface_params
{
193 struct msg_iscsi_ping
{
197 uint32_t payload_size
;
198 uint32_t pid
; /* unique ping id associated
199 with each ping request */
201 struct msg_get_chap
{
203 uint32_t num_entries
; /* number of CHAP entries
204 * on request, number of
205 * valid CHAP entries on
207 uint16_t chap_tbl_idx
;
209 struct msg_delete_chap
{
211 uint16_t chap_tbl_idx
;
215 /* messages k -> u */
217 struct msg_create_session_ret
{
221 struct msg_create_conn_ret
{
225 struct msg_unbind_session
{
229 struct msg_recv_req
{
232 uint64_t recv_handle
;
234 struct msg_conn_login
{
237 uint32_t state
; /* enum iscsi_conn_state */
239 struct msg_conn_error
{
242 uint32_t error
; /* enum iscsi_err */
244 struct msg_session_destroyed
{
248 struct msg_transport_connect_ret
{
251 struct msg_req_path
{
254 struct msg_notify_if_down
{
257 struct msg_host_event
{
260 enum iscsi_host_event_code code
;
262 struct msg_ping_comp
{
265 uint32_t pid
; /* unique ping id associated
266 with each ping request */
270 } __attribute__ ((aligned (sizeof(uint64_t))));
272 enum iscsi_param_type
{
273 ISCSI_PARAM
, /* iscsi_param (session, conn, target, LU) */
274 ISCSI_HOST_PARAM
, /* iscsi_host_param */
275 ISCSI_NET_PARAM
, /* iscsi_net_param */
278 struct iscsi_iface_param_info
{
279 uint32_t iface_num
; /* iface number, 0 - n */
280 uint32_t len
; /* Actual length of the param */
281 uint16_t param
; /* iscsi param value */
282 uint8_t iface_type
; /* IPv4 or IPv6 */
283 uint8_t param_type
; /* iscsi_param_type */
284 uint8_t value
[0]; /* length sized value follows */
288 * To keep the struct iscsi_uevent size the same for userspace code
289 * compatibility, the main structure for ISCSI_UEVENT_PATH_UPDATE and
290 * ISCSI_KEVENT_PATH_REQ is defined separately and comes after the
291 * struct iscsi_uevent in the NETLINK_ISCSI message.
296 uint8_t mac_addr_old
[6];
297 uint32_t ip_addr_len
; /* 4 or 16 */
299 struct in_addr v4_addr
;
300 struct in6_addr v6_addr
;
303 struct in_addr v4_addr
;
304 struct in6_addr v6_addr
;
308 } __attribute__ ((aligned (sizeof(uint64_t))));
310 /* iscsi iface enabled/disabled setting */
311 #define ISCSI_IFACE_DISABLE 0x01
312 #define ISCSI_IFACE_ENABLE 0x02
315 #define ISCSI_BOOTPROTO_STATIC 0x01
316 #define ISCSI_BOOTPROTO_DHCP 0x02
318 /* ipv6 addr autoconfig type */
319 #define ISCSI_IPV6_AUTOCFG_DISABLE 0x01
320 #define ISCSI_IPV6_AUTOCFG_ND_ENABLE 0x02
321 #define ISCSI_IPV6_AUTOCFG_DHCPV6_ENABLE 0x03
323 /* ipv6 link local addr type */
324 #define ISCSI_IPV6_LINKLOCAL_AUTOCFG_ENABLE 0x01
325 #define ISCSI_IPV6_LINKLOCAL_AUTOCFG_DISABLE 0x02
327 /* ipv6 router addr type */
328 #define ISCSI_IPV6_ROUTER_AUTOCFG_ENABLE 0x01
329 #define ISCSI_IPV6_ROUTER_AUTOCFG_DISABLE 0x02
331 #define ISCSI_IFACE_TYPE_IPV4 0x01
332 #define ISCSI_IFACE_TYPE_IPV6 0x02
334 #define ISCSI_MAX_VLAN_ID 4095
335 #define ISCSI_MAX_VLAN_PRIORITY 7
337 /* iscsi vlan enable/disabled setting */
338 #define ISCSI_VLAN_DISABLE 0x01
339 #define ISCSI_VLAN_ENABLE 0x02
341 /* iSCSI network params */
342 enum iscsi_net_param
{
343 ISCSI_NET_PARAM_IPV4_ADDR
= 1,
344 ISCSI_NET_PARAM_IPV4_SUBNET
= 2,
345 ISCSI_NET_PARAM_IPV4_GW
= 3,
346 ISCSI_NET_PARAM_IPV4_BOOTPROTO
= 4,
347 ISCSI_NET_PARAM_MAC
= 5,
348 ISCSI_NET_PARAM_IPV6_LINKLOCAL
= 6,
349 ISCSI_NET_PARAM_IPV6_ADDR
= 7,
350 ISCSI_NET_PARAM_IPV6_ROUTER
= 8,
351 ISCSI_NET_PARAM_IPV6_ADDR_AUTOCFG
= 9,
352 ISCSI_NET_PARAM_IPV6_LINKLOCAL_AUTOCFG
= 10,
353 ISCSI_NET_PARAM_IPV6_ROUTER_AUTOCFG
= 11,
354 ISCSI_NET_PARAM_IFACE_ENABLE
= 12,
355 ISCSI_NET_PARAM_VLAN_ID
= 13,
356 ISCSI_NET_PARAM_VLAN_PRIORITY
= 14,
357 ISCSI_NET_PARAM_VLAN_ENABLED
= 15,
358 ISCSI_NET_PARAM_VLAN_TAG
= 16,
359 ISCSI_NET_PARAM_IFACE_TYPE
= 17,
360 ISCSI_NET_PARAM_IFACE_NAME
= 18,
361 ISCSI_NET_PARAM_MTU
= 19,
362 ISCSI_NET_PARAM_PORT
= 20,
365 enum iscsi_conn_state
{
366 ISCSI_CONN_STATE_FREE
,
367 ISCSI_CONN_STATE_XPT_WAIT
,
368 ISCSI_CONN_STATE_IN_LOGIN
,
369 ISCSI_CONN_STATE_LOGGED_IN
,
370 ISCSI_CONN_STATE_IN_LOGOUT
,
371 ISCSI_CONN_STATE_LOGOUT_REQUESTED
,
372 ISCSI_CONN_STATE_CLEANUP_WAIT
,
381 ISCSI_ERR_DATASN
= ISCSI_ERR_BASE
+ 1,
382 ISCSI_ERR_DATA_OFFSET
= ISCSI_ERR_BASE
+ 2,
383 ISCSI_ERR_MAX_CMDSN
= ISCSI_ERR_BASE
+ 3,
384 ISCSI_ERR_EXP_CMDSN
= ISCSI_ERR_BASE
+ 4,
385 ISCSI_ERR_BAD_OPCODE
= ISCSI_ERR_BASE
+ 5,
386 ISCSI_ERR_DATALEN
= ISCSI_ERR_BASE
+ 6,
387 ISCSI_ERR_AHSLEN
= ISCSI_ERR_BASE
+ 7,
388 ISCSI_ERR_PROTO
= ISCSI_ERR_BASE
+ 8,
389 ISCSI_ERR_LUN
= ISCSI_ERR_BASE
+ 9,
390 ISCSI_ERR_BAD_ITT
= ISCSI_ERR_BASE
+ 10,
391 ISCSI_ERR_CONN_FAILED
= ISCSI_ERR_BASE
+ 11,
392 ISCSI_ERR_R2TSN
= ISCSI_ERR_BASE
+ 12,
393 ISCSI_ERR_SESSION_FAILED
= ISCSI_ERR_BASE
+ 13,
394 ISCSI_ERR_HDR_DGST
= ISCSI_ERR_BASE
+ 14,
395 ISCSI_ERR_DATA_DGST
= ISCSI_ERR_BASE
+ 15,
396 ISCSI_ERR_PARAM_NOT_FOUND
= ISCSI_ERR_BASE
+ 16,
397 ISCSI_ERR_NO_SCSI_CMD
= ISCSI_ERR_BASE
+ 17,
398 ISCSI_ERR_INVALID_HOST
= ISCSI_ERR_BASE
+ 18,
399 ISCSI_ERR_XMIT_FAILED
= ISCSI_ERR_BASE
+ 19,
400 ISCSI_ERR_TCP_CONN_CLOSE
= ISCSI_ERR_BASE
+ 20,
401 ISCSI_ERR_SCSI_EH_SESSION_RST
= ISCSI_ERR_BASE
+ 21,
405 * iSCSI Parameters (RFC3720)
408 /* passed in using netlink set param */
409 ISCSI_PARAM_MAX_RECV_DLENGTH
,
410 ISCSI_PARAM_MAX_XMIT_DLENGTH
,
411 ISCSI_PARAM_HDRDGST_EN
,
412 ISCSI_PARAM_DATADGST_EN
,
413 ISCSI_PARAM_INITIAL_R2T_EN
,
415 ISCSI_PARAM_IMM_DATA_EN
,
416 ISCSI_PARAM_FIRST_BURST
,
417 ISCSI_PARAM_MAX_BURST
,
418 ISCSI_PARAM_PDU_INORDER_EN
,
419 ISCSI_PARAM_DATASEQ_INORDER_EN
,
421 ISCSI_PARAM_IFMARKER_EN
,
422 ISCSI_PARAM_OFMARKER_EN
,
423 ISCSI_PARAM_EXP_STATSN
,
424 ISCSI_PARAM_TARGET_NAME
,
426 ISCSI_PARAM_PERSISTENT_ADDRESS
,
427 ISCSI_PARAM_PERSISTENT_PORT
,
428 ISCSI_PARAM_SESS_RECOVERY_TMO
,
430 /* passed in through bind conn using transport_fd */
431 ISCSI_PARAM_CONN_PORT
,
432 ISCSI_PARAM_CONN_ADDRESS
,
434 ISCSI_PARAM_USERNAME
,
435 ISCSI_PARAM_USERNAME_IN
,
436 ISCSI_PARAM_PASSWORD
,
437 ISCSI_PARAM_PASSWORD_IN
,
439 ISCSI_PARAM_FAST_ABORT
,
440 ISCSI_PARAM_ABORT_TMO
,
441 ISCSI_PARAM_LU_RESET_TMO
,
442 ISCSI_PARAM_HOST_RESET_TMO
,
444 ISCSI_PARAM_PING_TMO
,
445 ISCSI_PARAM_RECV_TMO
,
447 ISCSI_PARAM_IFACE_NAME
,
449 ISCSI_PARAM_INITIATOR_NAME
,
451 ISCSI_PARAM_TGT_RESET_TMO
,
452 ISCSI_PARAM_TARGET_ALIAS
,
454 ISCSI_PARAM_CHAP_IN_IDX
,
455 ISCSI_PARAM_CHAP_OUT_IDX
,
456 /* must always be last */
460 /* iSCSI HBA params */
461 enum iscsi_host_param
{
462 ISCSI_HOST_PARAM_HWADDRESS
,
463 ISCSI_HOST_PARAM_INITIATOR_NAME
,
464 ISCSI_HOST_PARAM_NETDEV_NAME
,
465 ISCSI_HOST_PARAM_IPADDRESS
,
466 ISCSI_HOST_PARAM_PORT_STATE
,
467 ISCSI_HOST_PARAM_PORT_SPEED
,
468 ISCSI_HOST_PARAM_MAX
,
471 /* iSCSI port Speed */
472 enum iscsi_port_speed
{
473 ISCSI_PORT_SPEED_UNKNOWN
= 0x1,
474 ISCSI_PORT_SPEED_10MBPS
= 0x2,
475 ISCSI_PORT_SPEED_100MBPS
= 0x4,
476 ISCSI_PORT_SPEED_1GBPS
= 0x8,
477 ISCSI_PORT_SPEED_10GBPS
= 0x10,
480 /* iSCSI port state */
481 enum iscsi_port_state
{
482 ISCSI_PORT_STATE_DOWN
= 0x1,
483 ISCSI_PORT_STATE_UP
= 0x2,
486 #define iscsi_ptr(_handle) ((void*)(unsigned long)_handle)
487 #define iscsi_handle(_ptr) ((uint64_t)(unsigned long)_ptr)
490 * These flags presents iSCSI Data-Path capabilities.
492 #define CAP_RECOVERY_L0 0x1
493 #define CAP_RECOVERY_L1 0x2
494 #define CAP_RECOVERY_L2 0x4
495 #define CAP_MULTI_R2T 0x8
496 #define CAP_HDRDGST 0x10
497 #define CAP_DATADGST 0x20
498 #define CAP_MULTI_CONN 0x40
499 #define CAP_TEXT_NEGO 0x80
500 #define CAP_MARKERS 0x100
501 #define CAP_FW_DB 0x200
502 #define CAP_SENDTARGETS_OFFLOAD 0x400 /* offload discovery process */
503 #define CAP_DATA_PATH_OFFLOAD 0x800 /* offload entire IO path */
504 #define CAP_DIGEST_OFFLOAD 0x1000 /* offload hdr and data digests */
505 #define CAP_PADDING_OFFLOAD 0x2000 /* offload padding insertion, removal,
507 #define CAP_LOGIN_OFFLOAD 0x4000 /* offload session login */
510 * These flags describes reason of stop_conn() call
512 #define STOP_CONN_TERM 0x1
513 #define STOP_CONN_SUSPEND 0x2
514 #define STOP_CONN_RECOVER 0x3
516 #define ISCSI_STATS_CUSTOM_MAX 32
517 #define ISCSI_STATS_CUSTOM_DESC_MAX 64
518 struct iscsi_stats_custom
{
519 char desc
[ISCSI_STATS_CUSTOM_DESC_MAX
];
524 * struct iscsi_stats - iSCSI Statistics (iSCSI MIB)
526 * Note: this structure contains counters collected on per-connection basis.
530 uint64_t txdata_octets
;
531 uint64_t rxdata_octets
;
535 uint32_t scsicmd_pdus
;
536 uint32_t tmfcmd_pdus
;
539 uint32_t dataout_pdus
;
540 uint32_t logout_pdus
;
545 uint32_t scsirsp_pdus
;
546 uint32_t tmfrsp_pdus
;
547 uint32_t textrsp_pdus
;
548 uint32_t datain_pdus
;
549 uint32_t logoutrsp_pdus
;
556 uint32_t timeout_err
;
559 * iSCSI Custom Statistics support, i.e. Transport could
560 * extend existing MIB statistics with its own specific statistics
561 * up to ISCSI_STATS_CUSTOM_MAX
563 uint32_t custom_length
;
564 struct iscsi_stats_custom custom
[0]
565 __attribute__ ((aligned (sizeof(uint64_t))));
573 #define ISCSI_CHAP_AUTH_NAME_MAX_LEN 256
574 #define ISCSI_CHAP_AUTH_SECRET_MAX_LEN 256
575 struct iscsi_chap_rec
{
576 uint16_t chap_tbl_idx
;
577 enum chap_type_e chap_type
;
578 char username
[ISCSI_CHAP_AUTH_NAME_MAX_LEN
];
579 uint8_t password
[ISCSI_CHAP_AUTH_SECRET_MAX_LEN
];
580 uint8_t password_length
;