ceph/src/spdk/lib/iscsi/conn.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (C) 2008-2012 Daisuke Aoyama <aoyama@peach.ne.jp>.
   5  *   Copyright (c) Intel Corporation.
   6  *   All rights reserved.
   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  *
  12  *     * Redistributions of source code must retain the above copyright
  13  *       notice, this list of conditions and the following disclaimer.
  14  *     * Redistributions in binary form must reproduce the above copyright
  15  *       notice, this list of conditions and the following disclaimer in
  16  *       the documentation and/or other materials provided with the
  17  *       distribution.
  18  *     * Neither the name of Intel Corporation nor the names of its
  19  *       contributors may be used to endorse or promote products derived
  20  *       from this software without specific prior written permission.
  21  *
  22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  */
  34
  35 #ifndef SPDK_ISCSI_CONN_H
  36 #define SPDK_ISCSI_CONN_H
  37
  38 #include "spdk/stdinc.h"
  39
  40 #include "iscsi/iscsi.h"
  41 #include "spdk/queue.h"
  42 #include "spdk/cpuset.h"
  43 #include "spdk/scsi.h"
  44
  45 /*
  46  * MAX_CONNECTION_PARAMS: The numbers of the params in conn_param_table
  47  * MAX_SESSION_PARAMS: The numbers of the params in sess_param_table
  48  */
  49 #define MAX_CONNECTION_PARAMS 14
  50 #define MAX_SESSION_PARAMS 19
  51
  52 #define MAX_ADDRBUF 64
  53 #define MAX_INITIATOR_ADDR (MAX_ADDRBUF)
  54 #define MAX_TARGET_ADDR (MAX_ADDRBUF)
  55
  56 #define OWNER_ISCSI_CONN                0x1
  57
  58 #define OBJECT_ISCSI_PDU                0x1
  59
  60 #define TRACE_GROUP_ISCSI               0x1
  61 #define TRACE_ISCSI_READ_FROM_SOCKET_DONE       SPDK_TPOINT_ID(TRACE_GROUP_ISCSI, 0x0)
  62 #define TRACE_ISCSI_FLUSH_WRITEBUF_START        SPDK_TPOINT_ID(TRACE_GROUP_ISCSI, 0x1)
  63 #define TRACE_ISCSI_FLUSH_WRITEBUF_DONE         SPDK_TPOINT_ID(TRACE_GROUP_ISCSI, 0x2)
  64 #define TRACE_ISCSI_READ_PDU                    SPDK_TPOINT_ID(TRACE_GROUP_ISCSI, 0x3)
  65 #define TRACE_ISCSI_TASK_DONE                   SPDK_TPOINT_ID(TRACE_GROUP_ISCSI, 0x4)
  66 #define TRACE_ISCSI_TASK_QUEUE                  SPDK_TPOINT_ID(TRACE_GROUP_ISCSI, 0x5)
  67 #define TRACE_ISCSI_TASK_EXECUTED               SPDK_TPOINT_ID(TRACE_GROUP_ISCSI, 0x6)
  68 #define TRACE_ISCSI_PDU_COMPLETED               SPDK_TPOINT_ID(TRACE_GROUP_ISCSI, 0x7)
  69
  70 enum iscsi_pdu_recv_state {
  71         /* Ready to wait for PDU */
  72         ISCSI_PDU_RECV_STATE_AWAIT_PDU_READY,
  73
  74         /* Active connection waiting for any PDU header */
  75         ISCSI_PDU_RECV_STATE_AWAIT_PDU_HDR,
  76
  77         /* Active connection waiting for payload */
  78         ISCSI_PDU_RECV_STATE_AWAIT_PDU_PAYLOAD,
  79
  80         /* Active connection does not wait for payload */
  81         ISCSI_PDU_RECV_STATE_ERROR,
  82 };
  83
  84 struct spdk_poller;
  85 struct spdk_iscsi_conn;
  86
  87 struct spdk_iscsi_lun {
  88         struct spdk_iscsi_conn          *conn;
  89         struct spdk_scsi_lun            *lun;
  90         struct spdk_scsi_lun_desc       *desc;
  91         struct spdk_poller              *remove_poller;
  92 };
  93
  94 struct spdk_iscsi_conn {
  95         int                             id;
  96         int                             is_valid;
  97         /*
  98          * All fields below this point are reinitialized each time the
  99          *  connection object is allocated.  Make sure to update the
 100          *  SPDK_ISCSI_CONNECTION_MEMSET() macro if changing which fields
 101          *  are initialized when allocated.
 102          */
 103         struct spdk_iscsi_portal        *portal;
 104         int                             pg_tag;
 105         char                            portal_host[MAX_PORTAL_ADDR + 1];
 106         char                            portal_port[MAX_PORTAL_ADDR + 1];
 107         struct spdk_iscsi_poll_group    *pg;
 108         struct spdk_sock                *sock;
 109         struct spdk_iscsi_sess          *sess;
 110
 111         enum iscsi_connection_state     state;
 112         int                             login_phase;
 113         bool                            is_logged_out;
 114         struct spdk_iscsi_pdu           *login_rsp_pdu;
 115
 116         uint64_t        last_flush;
 117         uint64_t        last_fill;
 118         uint64_t        last_nopin;
 119
 120         /* Timer used to destroy connection after requesting logout if
 121          *  initiator does not send logout request.
 122          */
 123         struct spdk_poller *logout_request_timer;
 124
 125         /* Timer used to destroy connection after logout if initiator does
 126          *  not close the connection.
 127          */
 128         struct spdk_poller *logout_timer;
 129
 130         /* Timer used to wait for connection to close
 131          */
 132         struct spdk_poller *shutdown_timer;
 133
 134         struct spdk_iscsi_pdu *pdu_in_progress;
 135         enum iscsi_pdu_recv_state pdu_recv_state;
 136
 137         TAILQ_HEAD(, spdk_iscsi_pdu) write_pdu_list;
 138         TAILQ_HEAD(, spdk_iscsi_pdu) snack_pdu_list;
 139
 140         int pending_r2t;
 141
 142         uint16_t cid;
 143
 144         /* IP address */
 145         char initiator_addr[MAX_INITIATOR_ADDR];
 146         char target_addr[MAX_TARGET_ADDR];
 147
 148         /* Initiator/Target port binds */
 149         char                            initiator_name[MAX_INITIATOR_NAME];
 150         struct spdk_scsi_port           *initiator_port;
 151         char                            target_short_name[MAX_TARGET_NAME];
 152         struct spdk_scsi_port           *target_port;
 153         struct spdk_iscsi_tgt_node      *target;
 154         struct spdk_scsi_dev            *dev;
 155
 156         /* for fast access */
 157         int header_digest;
 158         int data_digest;
 159         int full_feature;
 160
 161         struct iscsi_param *params;
 162         bool sess_param_state_negotiated[MAX_SESSION_PARAMS];
 163         bool conn_param_state_negotiated[MAX_CONNECTION_PARAMS];
 164         struct iscsi_chap_auth auth;
 165         bool authenticated;
 166         bool disable_chap;
 167         bool require_chap;
 168         bool mutual_chap;
 169         int32_t chap_group;
 170         uint32_t pending_task_cnt;
 171         uint32_t data_out_cnt;
 172         uint32_t data_in_cnt;
 173
 174         uint64_t timeout;
 175         uint64_t nopininterval;
 176         bool nop_outstanding;
 177
 178         /*
 179          * This is the maximum data segment length that iscsi target can send
 180          *  to the initiator on this connection.  Not to be confused with the
 181          *  maximum data segment length that initiators can send to iscsi target, which
 182          *  is statically defined as SPDK_ISCSI_MAX_RECV_DATA_SEGMENT_LENGTH.
 183          */
 184         int MaxRecvDataSegmentLength;
 185
 186         uint32_t StatSN;
 187         uint32_t exp_statsn;
 188         uint32_t ttt; /* target transfer tag */
 189         char *partial_text_parameter;
 190
 191         STAILQ_ENTRY(spdk_iscsi_conn) pg_link;
 192         bool                    is_stopped;  /* Set true when connection is stopped for migration */
 193         TAILQ_HEAD(queued_r2t_tasks, spdk_iscsi_task)   queued_r2t_tasks;
 194         TAILQ_HEAD(active_r2t_tasks, spdk_iscsi_task)   active_r2t_tasks;
 195         TAILQ_HEAD(queued_datain_tasks, spdk_iscsi_task)        queued_datain_tasks;
 196
 197         struct spdk_iscsi_lun   *luns[SPDK_SCSI_DEV_MAX_LUN];
 198
 199         TAILQ_ENTRY(spdk_iscsi_conn)    conn_link;
 200 };
 201
 202 extern struct spdk_iscsi_conn *g_conns_array;
 203
 204 void iscsi_task_cpl(struct spdk_scsi_task *scsi_task);
 205 void iscsi_task_mgmt_cpl(struct spdk_scsi_task *scsi_task);
 206
 207 int initialize_iscsi_conns(void);
 208 void shutdown_iscsi_conns(void);
 209 void iscsi_conns_request_logout(struct spdk_iscsi_tgt_node *target);
 210 int iscsi_get_active_conns(struct spdk_iscsi_tgt_node *target);
 211
 212 int iscsi_conn_construct(struct spdk_iscsi_portal *portal, struct spdk_sock *sock);
 213 void iscsi_conn_destruct(struct spdk_iscsi_conn *conn);
 214 void iscsi_conn_handle_nop(struct spdk_iscsi_conn *conn);
 215 void iscsi_conn_schedule(struct spdk_iscsi_conn *conn);
 216 void iscsi_conn_logout(struct spdk_iscsi_conn *conn);
 217 int iscsi_drop_conns(struct spdk_iscsi_conn *conn,
 218                      const char *conn_match, int drop_all);
 219 int iscsi_conn_handle_queued_datain_tasks(struct spdk_iscsi_conn *conn);
 220 int iscsi_conn_abort_queued_datain_task(struct spdk_iscsi_conn *conn,
 221                                         uint32_t ref_task_tag);
 222 int iscsi_conn_abort_queued_datain_tasks(struct spdk_iscsi_conn *conn,
 223                 struct spdk_scsi_lun *lun,
 224                 struct spdk_iscsi_pdu *pdu);
 225
 226 int iscsi_conn_read_data(struct spdk_iscsi_conn *conn, int len, void *buf);
 227 int iscsi_conn_readv_data(struct spdk_iscsi_conn *conn,
 228                           struct iovec *iov, int iovcnt);
 229 void iscsi_conn_write_pdu(struct spdk_iscsi_conn *conn, struct spdk_iscsi_pdu *pdu,
 230                           iscsi_conn_xfer_complete_cb cb_fn,
 231                           void *cb_arg);
 232
 233 void iscsi_conn_free_pdu(struct spdk_iscsi_conn *conn, struct spdk_iscsi_pdu *pdu);
 234
 235 void iscsi_conn_info_json(struct spdk_json_write_ctx *w, struct spdk_iscsi_conn *conn);
 236 void iscsi_conn_pdu_generic_complete(void *cb_arg);
 237 #endif /* SPDK_ISCSI_CONN_H */