ocs_iscsi_api.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 higher level iSCSI software
 */

#ifndef _OCS_ISCSI_API_H
#define _OCS_ISCSI_API_H

#include "ocs_os.h"

/**
 * @brief enum identifying the types of IP addresses.
 */
typedef enum {
    /* Valid for requesting addresses */
    OCS_IP_TYPE_V4 = 1,
    OCS_IP_TYPE_DHCP_V4,
    OCS_IP_TYPE_V6,
    OCS_IP_TYPE_AUTO_V6,
} ocs_ip_type_e;

/**
 * @brief enum identifying the types of IP addresses.
 */
typedef enum {
    /* Valid for requesting addresses */
    OCS_SESSION_TYPE_DISCOVERY = 1,
    OCS_SESSION_TYPE_NORMAL,
} ocs_session_type_e;

/**
 * @brief enum identifying the link state.
 */
typedef enum {
    OCS_LINK_STATE_UP = 1,
    OCS_LINK_STATE_DOWN
} ocs_link_state_e;

/**
 * @brief structure wrapping an IP address together with it's type.
 */
typedef struct {
    ocs_ip_type_e ip_type;
    uint8_t       ip_address[16];
} ocs_ip_address_t;

/**
 * @brief structure wrapping an IP address and subnet together with their type.
 */
typedef struct {
    ocs_ip_type_e  ip_type;
    uint8_t        ip_address[16];
    uint8_t        subnet[16];
} ocs_ip_address_subnet_t;

/**
 * @brief structure for storing CHAP usernames and passwords.
 */
typedef struct ocs_chap_user_s {
    ocs_list_link_t link;
    uint32_t type;      /* CHAP type indicates Incoming (one-way) or Outgoing (mutual-chap) */
    uint32_t mode;      /* OCS initiator or target */
    char username[32];
    char secret[32];
} ocs_chap_user_t;

/**
 * @brief structure for storing VLAN id and interface handle together
 */
typedef struct ocs_vlan_portal_info_s {
    ocs_list_link_t link;
    ocs_hal_portal_t iface_handle;
    uint32_t vlan_id;
} ocs_vlan_portal_info_t;

struct iscsi_api_s;

/***************************************************************************
 * iSCSI API objects
 *
 * Several objects used by the iSCSI API layer so that they can be used by the
 * managment code. These structures should be modified as required to represent
 * a customer implementation.
 */


/**
 * @brief Stores information needed to manage targets
 */
typedef struct iscsi_api_tgt_s
{
    ocs_list_link_t link;
    char tgt_name[OCS_MAX_ISCSI_NAME];
    char tgt_alias[OCS_ISCSI_MAX_ALIAS_SIZE];
} iscsi_api_tgt_t;

typedef struct iscsi_api_s
{
    ocs_sem_t link_cfg_sem;
    ocs_thread_t link_cfg_thread;
    bool set_gateway;
    bool link_configured;
    bool cfg_thread_started;
    bool is_shutdown;

    char ini_name[OCS_MAX_ISCSI_NAME];
    ocs_hal_portal_t portal;

    ocs_ip_address_subnet_t ipsub; /* for initial cofiguration only */
    ocs_ip_address_t subnet;
    ocs_ip_address_t gateway;
    ocs_ip_address_t *isns_servers;
    bool enable_mgmt_flag;
    bool isns_registered;
    char isns_eid[40];

    ocs_lock_t api_list_lock;
    ocs_list_t tgt_list;
    ocs_list_t chap_list;
    ocs_list_t portal_list;
} iscsi_api_t;


/* *****************************************************************
 * Calls from transport code to higher level driver.
 * *****************************************************************
 */

/* call related to targets */
char* ocs_iscsi_tgt_get_names(ocs_t *ocs, uint32_t index);
char* ocs_iscsi_tgt_get_alias(ocs_t *ocs, uint32_t index);
ocs_ip_address_t *ocs_iscsi_tgt_get_ip_address(ocs_t *ocs, char *tgt_name, uint32_t index);
uint32_t ocs_iscsi_tgt_get_portal_group(ocs_t *ocs, char *tgt_name, ocs_ip_address_t *ip_address);
uint8_t ocs_iscsi_tgt_require_chap(ocs_t *ocs, char *tgt_name, ocs_session_type_e type);

uint32_t ocs_iscsi_tgt_is_access_allowed(ocs_t *ocs, char *tgt_name, char *ini_name);

/* call related to initiator */
char* ocs_iscsi_ini_get_name(ocs_t *ocs);
char* ocs_iscsi_ini_get_alias(ocs_t *ocs);

/* call related to initiators and targets */
int32_t ocs_iscsi_api_initialize(ocs_t *ocs);
int32_t ocs_iscsi_api_shutdown(ocs_t *ocs);
void ocs_iscsi_api_link_state(ocs_t *ocs, ocs_link_state_e link_state);
char *ocs_iscsi_get_chap_name(ocs_t *ocs, uint8_t sess_type,
                  uint32_t mode, uint32_t type);
char *ocs_iscsi_get_chap_secret(ocs_t *ocs, char *name, uint32_t mode,
                uint32_t type, uint32_t *secret_len);
uint32_t ocs_iscsi_get_max_cxns(ocs_t *ocs, char *tgt_name, char *ini_name);


/* *****************************************************************
 * Calls from the higher level driver to the transport code
 * *****************************************************************
 */
void ocs_iscsi_tgt_del_sport(ocs_t *ocs, uint32_t sport_index);
int32_t ocs_iscsi_tgt_add_sport(ocs_t *ocs, ocs_sport_t *sport);
ocs_sport_t *ocs_iscsi_tgt_get_free_sport(ocs_t *ocs);
int32_t ocs_iscsi_tgt_add(ocs_t *ocs, char* name, char* alias);
int32_t ocs_iscsi_mac_set(ocs_t *ocs, uint8_t *mac_address);
uint8_t *ocs_iscsi_mac_get(ocs_t *ocs);
int32_t ocs_iscsi_ip_address_add(ocs_t *ocs,
                 ocs_hal_portal_t portal,
                 ocs_ip_address_subnet_t *ipsub);
int32_t ocs_iscsi_ip_address_remove(ocs_t *ocs,
                    ocs_hal_portal_t portal,
                    ocs_ip_address_subnet_t *ipsub);
int32_t ocs_iscsi_ip_address_query(ocs_t *ocs,
                   ocs_hal_portal_t portal,
                   ocs_ip_type_e ip_type,
                   uint32_t max_entries,
                   uint32_t *num_ips,
                   ocs_ip_address_subnet_t *ipsub);

int32_t ocs_iscsi_find_portal_from_vlan(ocs_t *ocs, uint32_t vlan_id,
                    ocs_hal_portal_t *iface_handle);
int32_t ocs_iscsi_portal_remove_ip_addresses(ocs_t *ocs,
                         ocs_hal_portal_t iface_handle);
int32_t ocs_iscsi_find_portal_from_vlan(ocs_t *ocs, uint32_t vlan_id,
                    ocs_hal_portal_t *iface_handle);
ocs_hal_portal_t ocs_iscsi_portal_get_default(ocs_t *ocs);
int32_t ocs_iscsi_portal_create(ocs_t *ocs, unsigned int vlan_tag,
                ocs_hal_portal_t *portal);
int32_t ocs_iscsi_portal_delete(ocs_t *ocs, ocs_hal_portal_t portal);

int32_t ocs_iscsi_listen_start(ocs_t *ocs, ocs_ip_address_t *ip,
                   uint16_t tcp_port);
int32_t ocs_iscsi_listen_stop(ocs_t *ocs, ocs_ip_address_t *ip,
                  uint16_t tcp_port);
int32_t ocs_iscsi_gateway_set(ocs_t *ocs, ocs_ip_address_t *gateway);
int32_t ocs_iscsi_mtu_set(ocs_t *ocs, uint8_t is_jumbo);
int32_t ocs_iscsi_isns_discover(ocs_t *ocs, ocs_hal_portal_t portal,
                uint32_t max_entries,
                uint32_t *num_ips,
                ocs_ip_address_t *ip);
int32_t ocs_iscsi_isns_esi_listen_start(ocs_t *ocs, ocs_ip_address_t *ip,
                    uint16_t tcp_port);
int32_t ocs_iscsi_isns_esi_listen_stop(ocs_t *ocs, ocs_ip_address_t *ip,
                       uint16_t tcp_port);
int32_t ocs_iscsi_isns_send(ocs_t *ocs, ocs_ip_address_t *isns_server,
                uint32_t tcp_port,
                void *pkt, uint32_t *pkt_len, uint32_t buff_len);

int32_t ocs_iscsi_chap_user_add(ocs_t *ocs, char *username, char *secret,
                uint32_t type, uint32_t mode);
int32_t ocs_iscsi_chap_user_del(ocs_t *ocs, char *username,
                uint32_t type, uint32_t mode);
int32_t ocs_iscsi_chap_list_get(ocs_t *ocs, char *userbuf, int32_t buflen);

typedef int32_t (*ocs_iscsi_pdu_cb_t)(ocs_io_t *io, uint32_t exp_cmdsn, uint32_t max_cmdsn, uint8_t response);
int32_t ocs_iscsi_unassisted_pdu_send(ocs_t *ocs, ocs_io_t *io, ocs_cxn_t *cxn, void *bhs, void *data,
                      uint32_t data_size, bool is_login, bool set_dm,
                      ocs_iscsi_pdu_cb_t cb);
int32_t ocs_iscsi_send_context_udpate(ocs_cxn_t *cxn);

#endif /* !_OCS_ISCSI_API_H */

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