sys/cam/ctl/ctl_frontend_iscsi.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 CTL_FRONTEND_ISCSI_H
  33 #define CTL_FRONTEND_ISCSI_H
  34
  35 #define CFISCSI_TARGET_STATE_INVALID    0
  36 #define CFISCSI_TARGET_STATE_ACTIVE     1
  37 #define CFISCSI_TARGET_STATE_DYING      2
  38
  39 struct cfiscsi_target {
  40         TAILQ_ENTRY(cfiscsi_target)     ct_next;
  41         uint32_t                        ct_luns[CTL_MAX_LUNS];
  42         struct cfiscsi_softc            *ct_softc;
  43         volatile u_int                  ct_refcount;
  44         char                            ct_name[CTL_ISCSI_NAME_LEN];
  45         char                            ct_alias[CTL_ISCSI_ALIAS_LEN];
  46         int                             ct_state;
  47         int                             ct_online;
  48         struct ctl_port                 ct_port;
  49 };
  50
  51 struct cfiscsi_data_wait {
  52         TAILQ_ENTRY(cfiscsi_data_wait)  cdw_next;
  53         union ctl_io                    *cdw_ctl_io;
  54         uint32_t                        cdw_target_transfer_tag;
  55         uint32_t                        cdw_initiator_task_tag;
  56         int                             cdw_sg_index;
  57         char                            *cdw_sg_addr;
  58         size_t                          cdw_sg_len;
  59 };
  60
  61 #define CFISCSI_SESSION_STATE_INVALID           0
  62 #define CFISCSI_SESSION_STATE_BHS               1
  63 #define CFISCSI_SESSION_STATE_AHS               2
  64 #define CFISCSI_SESSION_STATE_HEADER_DIGEST     3
  65 #define CFISCSI_SESSION_STATE_DATA              4
  66 #define CFISCSI_SESSION_STATE_DATA_DIGEST       5
  67
  68 struct cfiscsi_session {
  69         TAILQ_ENTRY(cfiscsi_session)    cs_next;
  70         struct mtx                      cs_lock;
  71         struct icl_conn                 *cs_conn;
  72         uint32_t                        cs_cmdsn;
  73         uint32_t                        cs_statsn;
  74         uint32_t                        cs_target_transfer_tag;
  75         volatile u_int                  cs_outstanding_ctl_pdus;
  76         TAILQ_HEAD(, cfiscsi_data_wait) cs_waiting_for_data_out;
  77         struct cfiscsi_target           *cs_target;
  78         struct callout                  cs_callout;
  79         int                             cs_timeout;
  80         int                             cs_portal_group_tag;
  81         struct cv                       cs_maintenance_cv;
  82         bool                            cs_terminating;
  83         size_t                          cs_max_data_segment_length;
  84         size_t                          cs_max_burst_length;
  85         bool                            cs_immediate_data;
  86         char                            cs_initiator_name[CTL_ISCSI_NAME_LEN];
  87         char                            cs_initiator_addr[CTL_ISCSI_ADDR_LEN];
  88         char                            cs_initiator_alias[CTL_ISCSI_ALIAS_LEN];
  89         char                            cs_initiator_isid[6];
  90         char                            cs_initiator_id[CTL_ISCSI_NAME_LEN + 5 + 6 + 1];
  91         unsigned int                    cs_id;
  92         int                             cs_ctl_initid;
  93 #ifdef ICL_KERNEL_PROXY
  94         struct sockaddr                 *cs_initiator_sa;
  95         int                             cs_portal_id;
  96         bool                            cs_login_phase;
  97         bool                            cs_waiting_for_ctld;
  98         struct cv                       cs_login_cv;
  99         struct icl_pdu                  *cs_login_pdu;
 100 #endif
 101 };
 102
 103 #ifdef ICL_KERNEL_PROXY
 104 struct icl_listen;
 105 #endif
 106
 107 struct cfiscsi_softc {
 108         struct mtx                      lock;
 109         char                            port_name[32];
 110         int                             online;
 111         unsigned int                    last_session_id;
 112         TAILQ_HEAD(, cfiscsi_target)    targets;
 113         TAILQ_HEAD(, cfiscsi_session)   sessions;
 114         char                            ctl_initids[CTL_MAX_INIT_PER_PORT];
 115         int                             max_initiators;
 116 #ifdef ICL_KERNEL_PROXY
 117         struct icl_listen               *listener;
 118         struct cv                       accept_cv;
 119 #endif
 120 };
 121
 122 #endif /* !CTL_FRONTEND_ISCSI_H */