sys/dev/iscsi/iscsi_ioctl.h

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