ocs_isns.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 iSNS functions to register and query the iSNS server
 * This code should be OS independant.
 */

#ifndef _OCS_ISNS_H
#define _OCS_ISNS_H

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

#define PDU_MEM_SIZE 1000
#define ISCSI_PROTOCOL 2
#define ISNS_ESI_PORT 5001
#define ISNS_ESI_INTERVAL 360

#define ISNS_VERSION 0x0001

#define ISNS_TRANSACTION_ID_1 0xdead
#define ISNS_TRANSACTION_ID_2 0xbeef

#define ISNS_STARTING_SEQ_ID 0x0000

/* isns function names */
#define ISNS_FUNC_DEV_ATTR_REG 0x0001
#define ISNS_FUNC_DEV_ATTR_QRY 0x0002
#define ISNS_FUNC_DEV_ATTR_DEREG 0x0004

#define ISNS_FLAG_FIRST (1 << 10)
#define ISNS_FLAG_LAST (1 << 11)
#define ISNS_FLAG_REPLACE (1 << 12)
#define ISNS_FLAG_AUTEHNT_BLOCK (1 << 13)
#define ISNS_FLAG_SERVER (1 << 14)
#define ISNS_FLAG_CLIENT (1 << 15)

/* set to 1 to enable ESI */
#define ISNS_ENABLE_ESI 1

/* ocs_keep_alive timer in seconds */
#define ISNS_KEEP_ALIVE_TIMER_PERIOD 30

/* isns tag names */
#define ISNS_TAG_DELIMITER          0
#define ISNS_TAG_ENTITY_IDENTIFIER  1
#define ISNS_TAG_ENTITY_PROTOCOL    2
#define ISNS_TAG_MGMT_IP_ADDRESS    3
#define ISNS_TAG_TIMIMESTAMP        4
#define ISNS_TAG_PROTOCOL_RANGE     5
#define ISNS_TAG_REG_PERIOD         6
#define ISNS_TAG_ENTITY_INDEX       7
#define ISNS_TAG_ENTITY_NEXT_INDEX  8
#define ISNS_TAG_PORTAL_IP_ADDRESS  16
#define ISNS_TAG_PORTAL_TCP_PORT    17
#define ISNS_TAG_ESI_INTERVAL       19
#define ISNS_TAG_ESI_PORT           20
#define ISNS_TAG_PORTAL_INDEX       22
#define ISNS_TAG_SCN_PORT           23
#define ISNS_TAG_ISCSI_NAME         32
#define ISNS_TAG_ISCSI_NODE_TYPE    33
#define ISNS_TAG_ISCSI_ALIAS        34

/*isns error names */
#define ISNS_ERROR_UNKNOWN                  1
#define ISNS_ERROR_MSG_FORMAT               2
#define ISNS_ERROR_INVALID_REG              3
#define ISNS_ERROR_RESERVED                 4
#define ISNS_ERROR_INVALID_QUERY            5
#define ISNS_ERROR_SOURCE_UNKNOWN           6
#define ISNS_ERROR_SOURCE_ABSENT            7
#define ISNS_ERROR_SOURCE_UNATHORIZED       8
#define ISNS_ERROR_NO_SUCH_ENTRY            9
#define ISNS_ERROR_VERSION_NOT_SUPPORTED    10
#define ISNS_ERROR_INTERNAL_ERROR           11
#define ISNS_ERROR_BUSY                     12
#define ISNS_ERROR_OPTION_NOT_UNDERSTOOD    13
#define ISNS_ERROR_INVALID_UPDATE           14
#define ISNS_ERROR_FUNC_ID                  15
#define ISNS_ERROR_SCN_EVENT_REJ            16
#define ISNS_ERROR_SCN_REG_REJ              17
#define ISNS_ERROR_NOT_IMPL                 18
#define ISNS_ERROR_DOMAIN_ID_UNAVAILABLE    19
#define ISNS_ERROR_UNALLCATED_DOMAIN_ID     20
#define ISNS_ERROR_ESI_UNAVAILABLE          21
#define ISNS_ERROR_INVALID_DEREG            22
#define ISNS_ERROR_REG_FEATURE_UNSUPPORTED  23


typedef struct isns_hdr_s {
#if BYTE_ORDER == LITTLE_ENDIAN
        uint16_t    iSNSP_version;
        uint16_t    function_id;
        uint16_t    payload_length;
        uint16_t    flags;
        uint16_t    transaction_id;
        uint16_t    sequence_id;

#else
#error big endian version not defined
#endif
} isns_hdr_t;

typedef struct ocs_isns_ip_port_s {
    char ip[48];
    uint16_t port;
} ocs_isns_ip_port_t;

typedef struct ocs_isns_node_s {
    char iname[256];
    uint16_t ipp_count;
    ocs_isns_ip_port_t *ipp;
} ocs_isns_node_t;


/* Initialization and Configuration */
int32_t ocs_isns_initialize(ocs_iscsi_t *);
int32_t ocs_isns_teardown(ocs_iscsi_t *);

/* Utility functions */
int8_t ocs_isns_register(ocs_iscsi_t *, uint8_t, uint8_t, ocs_ip_address_t *, char *);
void* ocs_isns_qry_tgts(ocs_iscsi_t * , ocs_ip_address_t *, uint16_t *);
int8_t ocs_isns_deregister(ocs_t *, ocs_ip_address_t *, char *);

/* Nodes helper functions */
char * ocs_get_iscsi_name(ocs_iscsi_t *, void *, uint16_t);
uint16_t ocs_get_iscsi_ipp_count(ocs_iscsi_t *, void *, uint16_t);
char * ocs_get_ip(ocs_iscsi_t *, void *, uint16_t, uint16_t);
uint16_t ocs_get_port(ocs_iscsi_t *, void *, uint16_t, uint16_t);

void ocs_str_to_ip_struct(ocs_iscsi_t *, char *, ocs_ip_address_t *);


/* isns log function */
#define ocs_isns_log(os, fmt, ...)  \
    do { \
        if (ocs_debug_is_enabled(OCS_DEBUG_ENABLE_ISNS_LOG))    \
        ocs_log_info(os, fmt, ##__VA_ARGS__); \
    } while (0)


#endif /* !_OCS_ISNS_H */

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