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