1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2012 The FreeBSD Foundation 5 * 6 * This software was developed by Edward Tomasz Napierala under sponsorship 7 * from the FreeBSD Foundation. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 */ 30 31 #ifndef ISCSI_IOCTL_H 32 #define ISCSI_IOCTL_H 33 34 #ifdef ICL_KERNEL_PROXY 35 #include <sys/socket.h> 36 #endif 37 38 #define ISCSI_PATH "/dev/iscsi" 39 #define ISCSI_MAX_DATA_SEGMENT_LENGTH (128 * 1024) 40 41 #define ISCSI_NAME_LEN 224 /* 223 bytes, by RFC 3720, + '\0' */ 42 #define ISCSI_ADDR_LEN 47 /* INET6_ADDRSTRLEN + '\0' */ 43 #define ISCSI_ALIAS_LEN 256 /* XXX: Where did it come from? */ 44 #define ISCSI_SECRET_LEN 17 /* 16 + '\0' */ 45 #define ISCSI_OFFLOAD_LEN 8 46 #define ISCSI_REASON_LEN 64 47 48 #define ISCSI_DIGEST_NONE 0 49 #define ISCSI_DIGEST_CRC32C 1 50 51 /* 52 * Session configuration, set when adding the session. 53 */ 54 struct iscsi_session_conf { 55 char isc_initiator[ISCSI_NAME_LEN]; 56 char isc_initiator_addr[ISCSI_ADDR_LEN]; 57 char isc_initiator_alias[ISCSI_ALIAS_LEN]; 58 char isc_target[ISCSI_NAME_LEN]; 59 char isc_target_addr[ISCSI_ADDR_LEN]; 60 char isc_user[ISCSI_NAME_LEN]; 61 char isc_secret[ISCSI_SECRET_LEN]; 62 char isc_mutual_user[ISCSI_NAME_LEN]; 63 char isc_mutual_secret[ISCSI_SECRET_LEN]; 64 int isc_discovery; 65 int isc_header_digest; 66 int isc_data_digest; 67 int isc_iser; 68 char isc_offload[ISCSI_OFFLOAD_LEN]; 69 int isc_enable; 70 int isc_dscp; 71 int isc_pcp; 72 int isc_ping_timeout; 73 int isc_login_timeout; 74 }; 75 76 /* 77 * Additional constraints imposed by chosen ICL offload module; 78 * iscsid(8) must obey those when negotiating operational parameters. 79 */ 80 struct iscsi_session_limits { 81 size_t isl_spare0; 82 int isl_max_recv_data_segment_length; 83 int isl_max_send_data_segment_length; 84 int isl_max_burst_length; 85 int isl_first_burst_length; 86 int isl_spare[4]; 87 }; 88 89 /* 90 * Session state, negotiated by iscsid(8) and queried by iscsictl(8). 91 */ 92 struct iscsi_session_state { 93 struct iscsi_session_conf iss_conf; 94 unsigned int iss_id; 95 char iss_target_alias[ISCSI_ALIAS_LEN]; 96 int iss_header_digest; 97 int iss_data_digest; 98 int iss_max_recv_data_segment_length; 99 int iss_max_burst_length; 100 int iss_first_burst_length; 101 int iss_immediate_data; 102 int iss_connected; 103 char iss_reason[ISCSI_REASON_LEN]; 104 char iss_offload[ISCSI_OFFLOAD_LEN]; 105 int iss_max_send_data_segment_length; 106 int iss_spare[3]; 107 }; 108 109 /* 110 * The following ioctls are used by iscsid(8). 111 */ 112 struct iscsi_daemon_request { 113 unsigned int idr_session_id; 114 struct iscsi_session_conf idr_conf; 115 uint8_t idr_isid[6]; 116 uint16_t idr_tsih; 117 uint16_t idr_spare_cid; 118 int idr_spare[4]; 119 }; 120 121 struct iscsi_daemon_limits { 122 unsigned int idl_session_id; 123 int idl_socket; 124 struct iscsi_session_limits idl_limits; 125 }; 126 127 struct iscsi_daemon_handoff { 128 unsigned int idh_session_id; 129 int idh_socket; 130 char idh_target_alias[ISCSI_ALIAS_LEN]; 131 int idh_protocol_level; 132 uint16_t idh_spare; 133 uint16_t idh_tsih; 134 uint16_t idh_spare_cid; 135 uint32_t idh_statsn; 136 int idh_header_digest; 137 int idh_data_digest; 138 size_t spare[3]; 139 int idh_immediate_data; 140 int idh_initial_r2t; 141 int idh_max_recv_data_segment_length; 142 int idh_max_send_data_segment_length; 143 int idh_max_burst_length; 144 int idh_first_burst_length; 145 }; 146 147 struct iscsi_daemon_fail { 148 unsigned int idf_session_id; 149 char idf_reason[ISCSI_REASON_LEN]; 150 int idf_spare[4]; 151 }; 152 153 #define ISCSIDWAIT _IOR('I', 0x01, struct iscsi_daemon_request) 154 #define ISCSIDHANDOFF _IOW('I', 0x02, struct iscsi_daemon_handoff) 155 #define ISCSIDFAIL _IOW('I', 0x03, struct iscsi_daemon_fail) 156 #define ISCSIDLIMITS _IOWR('I', 0x07, struct iscsi_daemon_limits) 157 158 #ifdef ICL_KERNEL_PROXY 159 160 /* 161 * When ICL_KERNEL_PROXY is not defined, the iscsid(8) is responsible 162 * for creating the socket, connecting, and performing Login Phase using 163 * the socket in the usual userspace way, and then passing the socket 164 * file descriptor to the kernel part using ISCSIDHANDOFF. 165 * 166 * When ICL_KERNEL_PROXY is defined, the iscsid(8) creates the session 167 * using ISCSICONNECT, performs Login Phase using ISCSISEND/ISCSIRECEIVE 168 * instead of read(2)/write(2), and then calls ISCSIDHANDOFF with 169 * idh_socket set to 0. 170 * 171 * The purpose of ICL_KERNEL_PROXY is to workaround the fact that, 172 * at this time, it's not possible to do iWARP (RDMA) in userspace. 173 */ 174 175 struct iscsi_daemon_connect { 176 unsigned int idc_session_id; 177 int idc_iser; 178 int idc_domain; 179 int idc_socktype; 180 int idc_protocol; 181 struct sockaddr *idc_from_addr; 182 socklen_t idc_from_addrlen; 183 struct sockaddr *idc_to_addr; 184 socklen_t idc_to_addrlen; 185 int idc_spare[4]; 186 }; 187 188 struct iscsi_daemon_send { 189 unsigned int ids_session_id; 190 void *ids_bhs; 191 size_t ids_spare; 192 void *ids_spare2; 193 size_t ids_data_segment_len; 194 void *ids_data_segment; 195 int ids_spare3[4]; 196 }; 197 198 struct iscsi_daemon_receive { 199 unsigned int idr_session_id; 200 void *idr_bhs; 201 size_t idr_spare; 202 void *idr_spare2; 203 size_t idr_data_segment_len; 204 void *idr_data_segment; 205 int idr_spare3[4]; 206 }; 207 208 #define ISCSIDCONNECT _IOWR('I', 0x04, struct iscsi_daemon_connect) 209 #define ISCSIDSEND _IOWR('I', 0x05, struct iscsi_daemon_send) 210 #define ISCSIDRECEIVE _IOWR('I', 0x06, struct iscsi_daemon_receive) 211 212 #endif /* ICL_KERNEL_PROXY */ 213 214 /* 215 * The following ioctls are used by iscsictl(8). 216 */ 217 struct iscsi_session_add { 218 struct iscsi_session_conf isa_conf; 219 int isa_spare[4]; 220 }; 221 222 struct iscsi_session_remove { 223 unsigned int isr_session_id; 224 struct iscsi_session_conf isr_conf; 225 int isr_spare[4]; 226 }; 227 228 struct iscsi_session_list { 229 unsigned int isl_nentries; 230 struct iscsi_session_state *isl_pstates; 231 int isl_spare[4]; 232 }; 233 234 struct iscsi_session_modify { 235 unsigned int ism_session_id; 236 struct iscsi_session_conf ism_conf; 237 int ism_spare[4]; 238 }; 239 240 #define ISCSISADD _IOW('I', 0x11, struct iscsi_session_add) 241 #define ISCSISREMOVE _IOW('I', 0x12, struct iscsi_session_remove) 242 #define ISCSISLIST _IOWR('I', 0x13, struct iscsi_session_list) 243 #define ISCSISMODIFY _IOWR('I', 0x14, struct iscsi_session_modify) 244 245 #endif /* !ISCSI_IOCTL_H */ 246