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_spare[2]; 73 }; 74 75 /* 76 * Additional constraints imposed by chosen ICL offload module; 77 * iscsid(8) must obey those when negotiating operational parameters. 78 */ 79 struct iscsi_session_limits { 80 size_t isl_spare0; 81 int isl_max_recv_data_segment_length; 82 int isl_max_send_data_segment_length; 83 int isl_max_burst_length; 84 int isl_first_burst_length; 85 int isl_spare[4]; 86 }; 87 88 /* 89 * Session state, negotiated by iscsid(8) and queried by iscsictl(8). 90 */ 91 struct iscsi_session_state { 92 struct iscsi_session_conf iss_conf; 93 unsigned int iss_id; 94 char iss_target_alias[ISCSI_ALIAS_LEN]; 95 int iss_header_digest; 96 int iss_data_digest; 97 int iss_max_recv_data_segment_length; 98 int iss_max_burst_length; 99 int iss_first_burst_length; 100 int iss_immediate_data; 101 int iss_connected; 102 char iss_reason[ISCSI_REASON_LEN]; 103 char iss_offload[ISCSI_OFFLOAD_LEN]; 104 int iss_max_send_data_segment_length; 105 int iss_spare[3]; 106 }; 107 108 /* 109 * The following ioctls are used by iscsid(8). 110 */ 111 struct iscsi_daemon_request { 112 unsigned int idr_session_id; 113 struct iscsi_session_conf idr_conf; 114 uint8_t idr_isid[6]; 115 uint16_t idr_tsih; 116 uint16_t idr_spare_cid; 117 int idr_spare[4]; 118 }; 119 120 struct iscsi_daemon_limits { 121 unsigned int idl_session_id; 122 int idl_socket; 123 struct iscsi_session_limits idl_limits; 124 }; 125 126 struct iscsi_daemon_handoff { 127 unsigned int idh_session_id; 128 int idh_socket; 129 char idh_target_alias[ISCSI_ALIAS_LEN]; 130 int idh_protocol_level; 131 uint16_t idh_spare; 132 uint16_t idh_tsih; 133 uint16_t idh_spare_cid; 134 uint32_t idh_statsn; 135 int idh_header_digest; 136 int idh_data_digest; 137 size_t spare[3]; 138 int idh_immediate_data; 139 int idh_initial_r2t; 140 int idh_max_recv_data_segment_length; 141 int idh_max_send_data_segment_length; 142 int idh_max_burst_length; 143 int idh_first_burst_length; 144 }; 145 146 struct iscsi_daemon_fail { 147 unsigned int idf_session_id; 148 char idf_reason[ISCSI_REASON_LEN]; 149 int idf_spare[4]; 150 }; 151 152 #define ISCSIDWAIT _IOR('I', 0x01, struct iscsi_daemon_request) 153 #define ISCSIDHANDOFF _IOW('I', 0x02, struct iscsi_daemon_handoff) 154 #define ISCSIDFAIL _IOW('I', 0x03, struct iscsi_daemon_fail) 155 #define ISCSIDLIMITS _IOWR('I', 0x07, struct iscsi_daemon_limits) 156 157 #ifdef ICL_KERNEL_PROXY 158 159 /* 160 * When ICL_KERNEL_PROXY is not defined, the iscsid(8) is responsible 161 * for creating the socket, connecting, and performing Login Phase using 162 * the socket in the usual userspace way, and then passing the socket 163 * file descriptor to the kernel part using ISCSIDHANDOFF. 164 * 165 * When ICL_KERNEL_PROXY is defined, the iscsid(8) creates the session 166 * using ISCSICONNECT, performs Login Phase using ISCSISEND/ISCSIRECEIVE 167 * instead of read(2)/write(2), and then calls ISCSIDHANDOFF with 168 * idh_socket set to 0. 169 * 170 * The purpose of ICL_KERNEL_PROXY is to workaround the fact that, 171 * at this time, it's not possible to do iWARP (RDMA) in userspace. 172 */ 173 174 struct iscsi_daemon_connect { 175 unsigned int idc_session_id; 176 int idc_iser; 177 int idc_domain; 178 int idc_socktype; 179 int idc_protocol; 180 struct sockaddr *idc_from_addr; 181 socklen_t idc_from_addrlen; 182 struct sockaddr *idc_to_addr; 183 socklen_t idc_to_addrlen; 184 int idc_spare[4]; 185 }; 186 187 struct iscsi_daemon_send { 188 unsigned int ids_session_id; 189 void *ids_bhs; 190 size_t ids_spare; 191 void *ids_spare2; 192 size_t ids_data_segment_len; 193 void *ids_data_segment; 194 int ids_spare3[4]; 195 }; 196 197 struct iscsi_daemon_receive { 198 unsigned int idr_session_id; 199 void *idr_bhs; 200 size_t idr_spare; 201 void *idr_spare2; 202 size_t idr_data_segment_len; 203 void *idr_data_segment; 204 int idr_spare3[4]; 205 }; 206 207 #define ISCSIDCONNECT _IOWR('I', 0x04, struct iscsi_daemon_connect) 208 #define ISCSIDSEND _IOWR('I', 0x05, struct iscsi_daemon_send) 209 #define ISCSIDRECEIVE _IOWR('I', 0x06, struct iscsi_daemon_receive) 210 211 #endif /* ICL_KERNEL_PROXY */ 212 213 /* 214 * The following ioctls are used by iscsictl(8). 215 */ 216 struct iscsi_session_add { 217 struct iscsi_session_conf isa_conf; 218 int isa_spare[4]; 219 }; 220 221 struct iscsi_session_remove { 222 unsigned int isr_session_id; 223 struct iscsi_session_conf isr_conf; 224 int isr_spare[4]; 225 }; 226 227 struct iscsi_session_list { 228 unsigned int isl_nentries; 229 struct iscsi_session_state *isl_pstates; 230 int isl_spare[4]; 231 }; 232 233 struct iscsi_session_modify { 234 unsigned int ism_session_id; 235 struct iscsi_session_conf ism_conf; 236 int ism_spare[4]; 237 }; 238 239 #define ISCSISADD _IOW('I', 0x11, struct iscsi_session_add) 240 #define ISCSISREMOVE _IOW('I', 0x12, struct iscsi_session_remove) 241 #define ISCSISLIST _IOWR('I', 0x13, struct iscsi_session_list) 242 #define ISCSISMODIFY _IOWR('I', 0x14, struct iscsi_session_modify) 243 244 #endif /* !ISCSI_IOCTL_H */ 245