ocs_iscsi.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015, Emulex
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */

/**
 * @file
 * Defines the iSCSI interface functions to the os specific code. Contains many
 * of the iSCSI configuration parameters and structures.
 * This code should be OS independant.
 */

#ifndef _OCS_ISCSI_H
#define _OCS_ISCSI_H

#include "ocs_os.h"
#include "ocs_hal.h"
#include "ocs_ioctl.h"

/* Used to test the network configuration APIs */
//#define OCS_TEST_HAL_APIS
//#define OCS_SET_MAC_ADDRESS

/*
 * Define parameters for LUN mappings.
 */
#define ISCSI_LUN_ADDRESS_METHOD_SHIFT  6
#define ISCSI_LUN_ADDRESS_METHOD_MASK   0xc0
#define ISCSI_LUN_ADDR_METHOD_PERIPHERAL    0x0
#define ISCSI_LUN_ADDR_METHOD_FLAT  0x1
#define ISCSI_LUN_ADDR_METHOD_LOGICAL   0x2
#define ISCSI_LUN_ADDR_METHOD_EXTENDED  0x3

#define ISCSI_LUN_ADDR_SIMPLE_MAX       0xff
#define ISCSI_LUN_ADDR_FLAT_MAX     0x3fff

/*
 * Functions to do the serial number arithmetic on cmdSn, etc.
 */
#define LOW_THRESH  0x10000000
#define HIGH_THRESH 0xefffffff

/* checks whether a > b when they are wrapped around
   usually a is max_cmdsn and b is exp_cmdsn
*/
#define GT_WRAPPED(a_cmd_sn, b_cmd_sn) (((b_cmd_sn) > HIGH_THRESH) &&   \
                    ((a_cmd_sn) < LOW_THRESH))

/* checks whether a > b in normal scenario
   usually a is max_cmdsn and b is exp_cmdsn
*/
#define GT_NOTWRAPPED(a,b) (((a) > (b)) && (((a) < HIGH_THRESH) ||  \
                        ((b) > LOW_THRESH)))

/* Considers both wrap and non-wrap scenarios and returns true
   return TRUE
   when cmdsn a is greater than cmdsn b
   usually a is max_cmdsn and b is exp_cmdsn
*/
#define GT_WRAP(a,b) (GT_NOTWRAPPED((a), (b)) || GT_WRAPPED((a), (b)))

/*
  Consider both equal to and greater than cases
  return TRUE
  when cmdsn a is equal to cmdsn b or cmdsn a is greater than cmdsn b
*/
#define GTE_WRAP(a,b) ( ( (a)==(b) ) || GT_WRAP((a),(b)) )

/**
 * @brief iSCSI PDU processing return codes
 */
typedef enum {
    OCS_PDU_RTN_PROCESSED = 0,
    OCS_PDU_RTN_CBIT_QUEUED,
    OCS_PDU_RTN_SEND_REJECT,
    OCS_PDU_RTN_NO_RESOURCES,
    OCS_PDU_RTN_GENERAL_ERROR
} ocs_pdu_process_rtn_e;

/**
 * @brief iSCSI object memory tracker
 *
 * Structure used to group allocation of objects into chucks and then pull them
 * out. This is done because DMA memory allocations is done in pages
 * which causes wasted space. By grouping the structures together, we attempt
 * to consoldiate as many per page as possible. This structure will allocate
 * tracking SGLs that are used to free the memory later as well as enumerate
 * the individual structures at initialization.
 */
typedef struct ocs_iscsi_mem_tracker_s {
    uint32_t   num_objs;
    ocs_dma_t *pages;
    uint32_t   num_pages;
    uint32_t   obj_per_page;
    uint32_t   obj_size;
    uint32_t   obj_size_padded;
} ocs_iscsi_mem_tracker_t;


/**
 * @brief The types of requests that may be retried.
 */
typedef enum {
    OCS_RETRY_REQ_RECV_LOGIN_RSP,
    OCS_RETRY_REQ_RECV_LOGOUT,
    OCS_RETRY_REQ_SEND_ASYNC,
    OCS_RETRY_REQ_SEND_LOGIN,
    OCS_RETRY_REQ_SEND_LOGIN_RSP_INVALID,
    OCS_RETRY_REQ_SEND_LOGOUT,
    OCS_RETRY_REQ_SEND_LOGOUT_RSP,
    OCS_RETRY_REQ_SEND_NOP_IN,
    OCS_RETRY_REQ_SEND_NOP_OUT,
    OCS_RETRY_REQ_SEND_REJECT
} ocs_iscsi_retry_type_e;

/**
 * @brief object to queue login requests waiting for buffers
 */
typedef struct ocs_iscsi_lgn_retry_s {
    ocs_list_link_t link;
    ocs_cxn_t *cxn;
    ocs_iscsi_retry_type_e type;
    bool    is_discovery;
    uint8_t immediate;
    uint8_t  reason;
    uint64_t lun;
    uint32_t itt;
    uint32_t ttt;
    uint16_t param1;
    uint16_t param2;
    uint16_t param3;
    char    virt_buffer[64];
    ocs_hal_rq_buffer_t *hdr;
    uint32_t    hdr_len;
    ocs_hal_rq_buffer_t *data;
    uint32_t    data_len;
} ocs_iscsi_lgn_retry_t;

/**
 * @brief Structure used to hold the response entries of set_route_table
 * command.
 */
typedef struct {
    ocs_hal_ip_address_t ip_addr;
    ocs_hal_ip_address_t subnet;
    ocs_hal_ip_address_t gateway;
} ocs_iscsi_route_table_entry_t;

typedef struct {
    uint32_t entry_count;
    ocs_iscsi_route_table_entry_t entry[OCS_ISCSI_ROUTE_TABLE_ENTRIES_MAX];
} ocs_iscsi_route_table_t;

#define OCS_CNFG_CTX_COMPL_TIMEOUT  (3 * 1000000)

/**
 * @brief The types of mailbox operations we want to wait for
 */
typedef enum {
    OCS_CNFG_CTX_IP_ADD,
    OCS_CNFG_CTX_IP_QUERY,
    OCS_CNFG_CTX_IP_REMOVE,
    OCS_CNFG_CTX_ISNS_DISC,
    OCS_CNFG_CTX_ISNS_SEND,
    OCS_CNFG_CTX_LISTEN_START,
    OCS_CNFG_CTX_LISTEN_STOP,
    OCS_CNFG_CTX_PORTAL_CREATE,
    OCS_CNFG_CTX_PORTAL_DELETE,
    OCS_CNFG_CTX_SET_GATEWAY,
    OCS_CNFG_CTX_SET_MAC,
    OCS_CNFG_CTX_SET_MTU,
    OCS_CNFG_CTX_SET_VLAN,
    OCS_CNFG_CTX_SET_ROUTE_TABLE,
    OCS_CNFG_CTX_GET_ROUTE_TABLE,
    OCS_CNFG_CTX_MAX /* Must remain last */
} ocs_config_ctx_e;

/**
 * @brief structure used to signal when a mailbox command callback is complete
 * and passes the status and any other parameters back to the caller.
 */
typedef struct {
    struct ocs_iscsi_s *iscsi;
    ocs_atomic_t in_use;
    ocs_sem_t sem;

    int32_t status;
    uint32_t ext_status;

    /* Fields for iSNS send */
    void *isns_pkt; /* Used to copy the response on callback */
    uint32_t isns_pkt_len;
    uint32_t isns_buff_len;

    /* parameters for specific commands */
    ocs_hal_portal_t iface;
    uint32_t num_ips;
    ocs_ip_address_t ip[32];
    ocs_ip_address_subnet_t ipsub[32];
    ocs_route_table_t route_table;
} ocs_config_ctx_t;

/**
 * @brief Template for a function to be called when the link
 *        state changes.
 */
typedef void (*ocs_link_state_cb_t)(ocs_t*, ocs_link_state_e);

#define OCS_ISCSI_MAX_LINK_STATE_CALLBACKS 2

/*
 * ocs_iscsi_cluster_tgt_info_s
 *  iSCSI cluster target info
 */
#define OCS_CLUST_TARGET_KEY_RETCNT (9999)
typedef struct ocs_iscsi_cluster_tgt_info_s {
    ocs_list_link_t link;
    char tgt_name[OCS_MAX_ISCSI_NAME];
    char tgt_addr[32];
} ocs_iscsi_cluster_tgt_t;
/*
 * iSCSI cluster target list is transferred in text response with
 * a special ttt OCS_CLUST_TARGET_TTT.
 */
#define OCS_CLUST_TARGET_TTT    (0xFFFFFF00)

/* 
 * ocs_iscsi_cluster_sendtargets_s
 *  iSCSI cluster target info is for the targets within
 *  the same network entity.  Target will send this list of items
 *  to initiator during send targets discovery phase.
 */
typedef struct ocs_iscsi_cluster_sendtargets_s {
    ocs_list_t list;
    ocs_atomic_t cnt;
    /* 
     * iscsi cluster targets are send in text response in multiples
     * of 8K size. ctgt_next holds the item from where the subsequent
     * transfer starts within the clisttgt_list.
     */
    ocs_iscsi_cluster_tgt_t *ctgt_next;
    bool st_last;
    bool send_en;
}ocs_iscsi_cluster_sendtargets_t;

/**
 * @brief Stores information needed IP addresses for targets
 */
typedef struct ocs_iscsi_tgt_ip_s
{
    ocs_hal_portal_t portal;
    ocs_ip_address_t ip;
    ocs_ip_address_t subnet;
    uint16_t tcp_port;
    uint16_t esi_port;
    uint32_t ip_added:1,
        listening:1,
        esi_listening:1;
} ocs_iscsi_tgt_ip_t;

#define OCS_MAX_IP  256

/**
 * @brief iSCSI object
 */
typedef struct ocs_iscsi_s {
    ocs_os_handle_t os;
    ocs_hal_t   *hal;

    uint32_t device_instance;
    uint32_t num_tgts;
    uint32_t num_cxns;
    uint32_t num_ios;

    ocs_timer_t idle_timer;
    uint32_t pf_num; /* function number retrieved from the SLI IF */

    bool            shutting_down;
    bool            is_hal_initialized;
    bool            is_init_complete;
    bool            has_ue_occurred;

    /* fields for ocs_cxn */
    ocs_iscsi_mem_tracker_t cxn_login_hdr;
    ocs_iscsi_mem_tracker_t cxn_login_data;

    /* fields for ocs_session */
    ocs_lock_t      sess_queue_lock;
    ocs_list_t      sess_free;
    ocs_list_t      sess_busy;
    ocs_session_t          *sess_mem;

    /* fields for management API */
    ocs_config_ctx_t    *ctx;

    /* Fields managed by ocs_login.c */
    ocs_lock_t      lgn_queue_lock;
    ocs_iscsi_lgn_retry_t  *lgn_retry;
    ocs_list_t      login_retry_free;
    ocs_list_t      login_retry_busy;
    uint8_t         chap_ident;

    /* Fields for managing IP addresses */
    uint32_t        num_ips;
    ocs_iscsi_tgt_ip_t  *ip_info;

#ifdef OCS_TEST_HAL_APIS
    ocs_hal_portal_t iface_vlan_1;
#endif

    /* for transport layer API */
    ocs_hal_unsol_cb_t unsol_ini;
    ocs_lock_t link_state_cb_lock;
    ocs_link_state_cb_t link_state_callbacks[OCS_ISCSI_MAX_LINK_STATE_CALLBACKS];

    /* for isns ESI timer */
    ocs_timer_t     isns_timer;
    ocs_ip_address_t    isns_ip;
    uint32_t        isns_reg_period;

    ocs_iscsi_cluster_sendtargets_t clusttgt;
} ocs_iscsi_t;

/* Initialization and Configuration */
int32_t ocs_iscsi_interrupts_required(ocs_os_handle_t, ocs_hal_t *);
int32_t ocs_iscsi_initialize(ocs_os_handle_t, ocs_iscsi_t *, ocs_hal_t *, uint32_t);
void ocs_iscsi_uninitialize(ocs_iscsi_t *);
int32_t ocs_iscsi_teardown(ocs_iscsi_t *);
int32_t ocs_iscsi_register_link_state_callback(ocs_t *ocs, ocs_link_state_cb_t);
void ocs_iscsi_unregister_link_state_callback(ocs_t *ocs, ocs_link_state_cb_t);

/* Utility functions */
void ocs_iscsi_rx_buffers_free(ocs_iscsi_t *, ocs_hal_rq_buffer_t *, ocs_hal_rq_buffer_t *);
void ocs_iscsi_cxn_req_invalidate(ocs_iscsi_t *iscsi);

int32_t ocs_iscsi_inet_pton4(const char * src, ocs_ip_address_t *ip);
int32_t ocs_iscsi_inet_pton6(const char *src, ocs_ip_address_t *ip);
ocs_hal_ip_type_e ocs_iscsi_convert_to_hal_ip_type(ocs_ip_type_e ip_type);
ocs_ip_type_e ocs_iscsi_convert_to_ip_type(ocs_hal_ip_type_e ip_type);
void ocs_iscsi_convert_to_hal_ip(ocs_ip_address_t *ip, ocs_hal_ip_address_t *hal_ip);
void ocs_iscsi_convert_to_ip(ocs_ip_address_t *ip, ocs_hal_ip_address_t *hal_ip);
void ocs_iscsi_ipsub_combine(ocs_ip_address_subnet_t *ipsub,
                 ocs_ip_address_t *ip,
                 ocs_ip_address_t *subnet);
void ocs_iscsi_ipsub_split(ocs_ip_address_subnet_t *ipsub,
               ocs_ip_address_t *ip,
               ocs_ip_address_t *subnet);
void format_ip_address(ocs_ip_type_e ip_type, uint8_t *address, char* buffer, int size);
void format_mac_address(uint8_t *address, char *buffer, int size);
int32_t parse_mac_address(const char *src, uint8_t *dest);

int32_t ocs_iscsi_send_tmf_resp(ocs_io_t *io, uint8_t response,
                ocs_scsi_io_cb_t cb, void *arg);

int32_t ocs_scsi_io_dispatch(ocs_io_t *io, void *cb);
void ocs_scsi_pending_cleanup(ocs_node_t *node);

void ocs_target_io_aborted_nop_cmpl(ocs_cxn_t *cxn);
int32_t ocs_iscsi_add_ip_to_tbl(ocs_t *ocs,
                       char *desc,
                       ocs_ip_address_subnet_t *ipsub,
                       ocs_hal_portal_t portal);
int32_t ocs_iscsi_remove_ip_from_tbl(ocs_t *ocs,
                        ocs_ip_address_subnet_t *ipsub,
                     ocs_hal_portal_t portal);
int32_t
ocs_iscsi_is_ip_in_tbl(ocs_t *ocs,
               ocs_ip_address_subnet_t *ipsub);

/* Target function to process PDUs - called by session code */
ocs_pdu_process_rtn_e ocs_iscsi_tgt_process_cmd_sn(ocs_iscsi_t *iscsi,
                           ocs_cxn_t *cxn,
                           ocs_hal_rq_buffer_t *hdr,
                           uint32_t   hdr_len,
                           ocs_hal_rq_buffer_t *data,
                           uint32_t   data_len,
                           uint8_t    code,
                           uint8_t    *reject_reason);


/* Functions for using memory trackers */
void ocs_iscsi_tracker_init(ocs_iscsi_mem_tracker_t *tracker);
void ocs_iscsi_tracker_free(ocs_iscsi_t *iscsi,
                ocs_iscsi_mem_tracker_t *tracker);
int32_t ocs_iscsi_tracker_alloc(ocs_iscsi_t *iscsi,
                ocs_iscsi_mem_tracker_t *tracker,
                uint8_t  zero,
                uint32_t object_size,
                uint32_t alignment,
                uint32_t num_objects);
ocs_dma_t *ocs_iscsi_tracker_calc(ocs_iscsi_mem_tracker_t *tracker,
                  uint32_t      obj_offset);
int32_t ocs_iscsi_portal_read_vlan_ids(ocs_t *ocs, void *arg_out,
                       uint32_t arg_out_length);
int32_t ocs_iscsi_portal_del_vlan(ocs_t *ocs, ocs_hal_portal_t iface);
int32_t ocs_iscsi_route_table_del_entry(ocs_t *ocs,
                    ocs_ip_address_subnet_t *ipsub,
                    ocs_ip_address_t *gateway);
int32_t ocs_iscsi_route_table_read(ocs_t *ocs, ocs_route_table_t *route_table);
int32_t ocs_iscsi_route_table_add_entry(ocs_t *ocs,
                    ocs_ip_address_subnet_t *ipsub,
                    ocs_ip_address_t *gateway);
void ocs_iscsi_cluster_tgts_free(ocs_iscsi_t *iscsi);
extern bool ocs_scsi_check_cxn_wq_full(ocs_t *ocs, ocs_cxn_t *cxn);

#endif /* !_OCS_ISCSI_H */

/* vim: set noexpandtab textwidth=120: */