1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 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 * $FreeBSD$ 31 */ 32 33 #ifndef ISCSI_IOCTL_H 34 #define ISCSI_IOCTL_H 35 36 #ifdef ICL_KERNEL_PROXY 37 #include <sys/socket.h> 38 #endif 39 40 #define ISCSI_PATH "/dev/iscsi" 41 #define ISCSI_MAX_DATA_SEGMENT_LENGTH (128 * 1024) 42 43 #define ISCSI_NAME_LEN 224 /* 223 bytes, by RFC 3720, + '\0' */ 44 #define ISCSI_ADDR_LEN 47 /* INET6_ADDRSTRLEN + '\0' */ 45 #define ISCSI_ALIAS_LEN 256 /* XXX: Where did it come from? */ 46 #define ISCSI_SECRET_LEN 17 /* 16 + '\0' */ 47 #define ISCSI_OFFLOAD_LEN 8 48 #define ISCSI_REASON_LEN 64 49 50 #define ISCSI_DIGEST_NONE 0 51 #define ISCSI_DIGEST_CRC32C 1 52 53 /* 54 * Session configuration, set when adding the session. 55 */ 56 struct iscsi_session_conf { 57 char isc_initiator[ISCSI_NAME_LEN]; 58 char isc_initiator_addr[ISCSI_ADDR_LEN]; 59 char isc_initiator_alias[ISCSI_ALIAS_LEN]; 60 char isc_target[ISCSI_NAME_LEN]; 61 char isc_target_addr[ISCSI_ADDR_LEN]; 62 char isc_user[ISCSI_NAME_LEN]; 63 char isc_secret[ISCSI_SECRET_LEN]; 64 char isc_mutual_user[ISCSI_NAME_LEN]; 65 char isc_mutual_secret[ISCSI_SECRET_LEN]; 66 int isc_discovery; 67 int isc_header_digest; 68 int isc_data_digest; 69 int isc_iser; 70 char isc_offload[ISCSI_OFFLOAD_LEN]; 71 int isc_enable; 72 int isc_dscp; 73 int isc_pcp; 74 int isc_spare[2]; 75 }; 76 77 /* 78 * Additional constraints imposed by chosen ICL offload module; 79 * iscsid(8) must obey those when negotiating operational parameters. 80 */ 81 struct iscsi_session_limits { 82 size_t isl_spare0; 83 int isl_max_recv_data_segment_length; 84 int isl_max_send_data_segment_length; 85 int isl_max_burst_length; 86 int isl_first_burst_length; 87 int isl_spare[4]; 88 }; 89 90 /* 91 * Session state, negotiated by iscsid(8) and queried by iscsictl(8). 92 */ 93 struct iscsi_session_state { 94 struct iscsi_session_conf iss_conf; 95 unsigned int iss_id; 96 char iss_target_alias[ISCSI_ALIAS_LEN]; 97 int iss_header_digest; 98 int iss_data_digest; 99 int iss_max_recv_data_segment_length; 100 int iss_max_burst_length; 101 int iss_first_burst_length; 102 int iss_immediate_data; 103 int iss_connected; 104 char iss_reason[ISCSI_REASON_LEN]; 105 char iss_offload[ISCSI_OFFLOAD_LEN]; 106 int iss_max_send_data_segment_length; 107 int iss_spare[3]; 108 }; 109 110 /* 111 * The following ioctls are used by iscsid(8). 112 */ 113 struct iscsi_daemon_request { 114 unsigned int idr_session_id; 115 struct iscsi_session_conf idr_conf; 116 uint8_t idr_isid[6]; 117 uint16_t idr_tsih; 118 uint16_t idr_spare_cid; 119 struct iscsi_session_limits idr_limits; 120 int idr_spare[4]; 121 }; 122 123 struct iscsi_daemon_handoff { 124 unsigned int idh_session_id; 125 int idh_socket; 126 char idh_target_alias[ISCSI_ALIAS_LEN]; 127 int idh_protocol_level; 128 uint16_t idh_spare; 129 uint16_t idh_tsih; 130 uint16_t idh_spare_cid; 131 uint32_t idh_statsn; 132 int idh_header_digest; 133 int idh_data_digest; 134 size_t spare[3]; 135 int idh_immediate_data; 136 int idh_initial_r2t; 137 int idh_max_recv_data_segment_length; 138 int idh_max_send_data_segment_length; 139 int idh_max_burst_length; 140 int idh_first_burst_length; 141 }; 142 143 struct iscsi_daemon_fail { 144 unsigned int idf_session_id; 145 char idf_reason[ISCSI_REASON_LEN]; 146 int idf_spare[4]; 147 }; 148 149 #define ISCSIDWAIT _IOR('I', 0x01, struct iscsi_daemon_request) 150 #define ISCSIDHANDOFF _IOW('I', 0x02, struct iscsi_daemon_handoff) 151 #define ISCSIDFAIL _IOW('I', 0x03, struct iscsi_daemon_fail) 152 153 #ifdef ICL_KERNEL_PROXY 154 155 /* 156 * When ICL_KERNEL_PROXY is not defined, the iscsid(8) is responsible 157 * for creating the socket, connecting, and performing Login Phase using 158 * the socket in the usual userspace way, and then passing the socket 159 * file descriptor to the kernel part using ISCSIDHANDOFF. 160 * 161 * When ICL_KERNEL_PROXY is defined, the iscsid(8) creates the session 162 * using ISCSICONNECT, performs Login Phase using ISCSISEND/ISCSIRECEIVE 163 * instead of read(2)/write(2), and then calls ISCSIDHANDOFF with 164 * idh_socket set to 0. 165 * 166 * The purpose of ICL_KERNEL_PROXY is to workaround the fact that, 167 * at this time, it's not possible to do iWARP (RDMA) in userspace. 168 */ 169 170 struct iscsi_daemon_connect { 171 unsigned int idc_session_id; 172 int idc_iser; 173 int idc_domain; 174 int idc_socktype; 175 int idc_protocol; 176 struct sockaddr *idc_from_addr; 177 socklen_t idc_from_addrlen; 178 struct sockaddr *idc_to_addr; 179 socklen_t idc_to_addrlen; 180 int idc_spare[4]; 181 }; 182 183 struct iscsi_daemon_send { 184 unsigned int ids_session_id; 185 void *ids_bhs; 186 size_t ids_spare; 187 void *ids_spare2; 188 size_t ids_data_segment_len; 189 void *ids_data_segment; 190 int ids_spare3[4]; 191 }; 192 193 struct iscsi_daemon_receive { 194 unsigned int idr_session_id; 195 void *idr_bhs; 196 size_t idr_spare; 197 void *idr_spare2; 198 size_t idr_data_segment_len; 199 void *idr_data_segment; 200 int idr_spare3[4]; 201 }; 202 203 #define ISCSIDCONNECT _IOWR('I', 0x04, struct iscsi_daemon_connect) 204 #define ISCSIDSEND _IOWR('I', 0x05, struct iscsi_daemon_send) 205 #define ISCSIDRECEIVE _IOWR('I', 0x06, struct iscsi_daemon_receive) 206 207 #endif /* ICL_KERNEL_PROXY */ 208 209 /* 210 * The following ioctls are used by iscsictl(8). 211 */ 212 struct iscsi_session_add { 213 struct iscsi_session_conf isa_conf; 214 int isa_spare[4]; 215 }; 216 217 struct iscsi_session_remove { 218 unsigned int isr_session_id; 219 struct iscsi_session_conf isr_conf; 220 int isr_spare[4]; 221 }; 222 223 struct iscsi_session_list { 224 unsigned int isl_nentries; 225 struct iscsi_session_state *isl_pstates; 226 int isl_spare[4]; 227 }; 228 229 struct iscsi_session_modify { 230 unsigned int ism_session_id; 231 struct iscsi_session_conf ism_conf; 232 int ism_spare[4]; 233 }; 234 235 #define ISCSISADD _IOW('I', 0x11, struct iscsi_session_add) 236 #define ISCSISREMOVE _IOW('I', 0x12, struct iscsi_session_remove) 237 #define ISCSISLIST _IOWR('I', 0x13, struct iscsi_session_list) 238 #define ISCSISMODIFY _IOWR('I', 0x14, struct iscsi_session_modify) 239 240 #endif /* !ISCSI_IOCTL_H */ 241