iscsit_common.h revision 42bf653b44c42fc6b637ae50e590489d69399241
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
*/
#ifndef _ISCSIT_COMMON_H_
#define _ISCSIT_COMMON_H_
#ifdef _KERNEL
#else
#include <libnvpair.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
#define ISCSIT_API_VERS0 0
#define ISCSIT_MODNAME "iscsit"
#define ISCSIT_NODE "/devices/pseudo/iscsit@0:iscsit"
typedef enum {
ITCFG_SUCCESS = 0,
/*
* This structure is passed back to the driver during ISCSIT_IOC_ENABLE_SVC
* in order to provide the fully qualified hostname for use as the EID
* by iSNS.
*/
#define ISCSIT_MAX_HOSTNAME_LEN 256
typedef struct iscsit_hostinfo_s {
char fqhn[ISCSIT_MAX_HOSTNAME_LEN];
#define ISCSIT_IOC_SET_CONFIG 1
#define ISCSIT_IOC_GET_STATE 2
#define ISCSIT_IOC_ENABLE_SVC 101
#define ISCSIT_IOC_DISABLE_SVC 102
/* XXX Rationalize these with other error values (used in it_smf.c */
#define ITADM_SUCCESS 0
#define ITADM_FATAL_ERROR 0x1
#define ITADM_NO_MEM 0x2
#define ITADM_INVALID 0x4
#define ITADM_NODATA 0x8
#define ITADM_PERM 0x10
#define PROP_AUTH "auth"
#define PROP_ALIAS "alias"
#define PROP_CHAP_USER "chapuser"
#define PROP_CHAP_SECRET "chapsecret"
#define PROP_TARGET_CHAP_USER "targetchapuser"
#define PROP_TARGET_CHAP_SECRET "targetchapsecret"
#define PROP_RADIUS_SERVER "radiusserver"
#define PROP_RADIUS_SECRET "radiussecret"
#define PROP_ISNS_ENABLED "isns"
#define PROP_ISNS_SERVER "isnsserver"
#define PROP_OLD_TARGET_NAME "oldtargetname"
#define PA_AUTH_RADIUS "radius"
#define PA_AUTH_CHAP "chap"
#define PA_AUTH_NONE "none"
typedef struct {
int set_cfg_vers;
int set_cfg_pnvlist_len;
typedef struct {
int getst_vers;
int getst_pnvlist_len;
char *getst_pnvlist;
#ifdef _SYSCALL32
typedef struct {
int set_cfg_vers;
int set_cfg_pnvlist_len;
typedef struct {
int getst_vers;
int getst_pnvlist_len;
#endif /* _SYSCALL32 */
/* Maximum size of a Target Portal Group name */
/* Maximum size of an iSCSI Target Node name */
/*
* A target portal group tag is a binding between a target and a target
* portal group along with a numerical value associated with that binding.
* The numerical identifier is used as the 'target portal group tag' defined
* in RFC3720.
*
* tpgt_tpg_name The name of the target portal group associated with
* this target portal group tag.
* tpgt_generation Generation number which is incremented each time the
* structure changes.
* tpgt_next Next target portal group tag in th list of target portal
* group tags. If tpgt_next is NUL, then this is the last
* target portal group in the list.
* tpgt_tag A numerical identifier that uniquely identifies a
* target portal group within the associated target node.
*/
typedef struct it_tpgt_s {
char tpgt_tpg_name[MAX_TPG_NAMELEN];
} it_tpgt_t;
/*
* An iSCSI target node is represented by an it_tgt_structure. Each
* target node includes a list of associated target portal group tags
* and a list of properties.
*
* tgt_name The iSCSI target node name in either IQN or EUI
* format (see RFC3720).
* tgt_generation Generation number which is incremented each time
* the structure changes.
* tgt_next Next target in the list of targets. If tgt_next
* is NULL, then this is the last target in the list.
* tgt_tpgt_list A linked list representing the current target
* portal group tags associated with this target.
* tgt_tpgt_count The number of currently defined target portal
* group tags.
* tgt_properties An nvlist representation of the properties
* associated with this target. This list can be
* manipulated using libnvpair(3lib), and should be
* validated and stored using it_tgt_setprop().
*
* Target nvlist Properties:
*
* nvlist Key Type Valid Values
* --------------------------------------------------------------------
* targetchapuser string any string or "none" to remove
* targetchapsecret string string of at least 12 characters
* but not more than 255 characters.
* secret will be base64 encoded when
* stored.
* alias string any string or "none" to remove
* auth string "radius", "chap", or "none"
*
*/
typedef struct it_tgt_s {
char tgt_name[MAX_ISCSI_NODENAMELEN];
} it_tgt_t;
/*
* A target portal is represented by an IP address and a listening
* TCP port.
*
* portal_addr sockaddr_storage structure representing the
* IPv4 or IPv6 address and TCP port associated
* with the portal.
* portal_next Next portal in the list of portals. If
* portal_next is NULL, this is the last portal
* in the list.
*/
typedef struct it_portal_s {
struct sockaddr_storage portal_addr;
struct it_portal_s *portal_next;
} it_portal_t;
/*
* A portal is an IP address and TCP port and a portal group is a set
* of portals. Each defined portal belongs to exactly one portal group.
* Applications can associate a target portal group with a particular
* target using a target portal group name. Initiators can only connect
* to targets through the portals associated with the target's target
* portal group tags.
*
* tpg_name Identifier for the target portal group.
* tpg_generation Generation number which is incremented each
* time this structure changes.
* tpg_next Next target portal group in the list of target
* portal groups. If tpg_next is NULL, this is the
* last target portal group in the list.
* tpg_portal_count Number of it_portal_t structures in the list.
* tpg_portal_list Linked list of it_portal_t structures.
*/
typedef struct it_tpg_s {
char tpg_name[MAX_TPG_NAMELEN];
} it_tpg_t;
/*
* A context representing a remote iSCSI initiator node. The purpose
* of this structure is to maintain information specific to a remote
* initiator such as the CHAP username and CHAP secret.
*
* ini_name the iSCSI node name of the remote initiator.
* ini_generation Generation number which is incremented each
* time this structure changes.
* ini_next Next initiator in the list of initiators.
* If ini_next is NULL, this is the last initiator
* in the list.
* associated with the initiator context. This list
* can be manipulated using libnvpair(3lib), and should
* be validated and stored using it_ini_setprop().
*
* Initiator nvlist Properties:
*
* nvlist Key Type Valid Values
* --------------------------------------------------------------------
* chapuser string any string
* chapsecret string string of at least 12 characters
* but not more than 255 characters.
* secret will be base64 encoded when
* stored.
*/
typedef struct it_ini_s {
char ini_name[MAX_ISCSI_NODENAMELEN];
} it_ini_t;
/*
* This structure represents a complete configuration for the iscsit
* port provider. In addition to the global configuration, it_config_t
* includes lists of child objects including targets, target portal
* groups and initiator contexts. Each object includes a "generation"
* value which is used by the iscsit kernel driver to identify changes
* from one configuration update to the next.
*
* stmf_token A uint64_t that contains the value returned from a
* successful call to stmfGetProviderDataProt(3STMF).
* This token is used to verify that the configuration
* data persistently stored in COMSTAR has not been
* modified since this version was loaded.
* config_version Version number for this configuration structure
* config_tgt_list Linked list of target contexts representing the
* currently defined targets. Applications can add
* targets to or remove targets from this list using
* the it_tgt_create and it_tgt_delete functions.
* config_tgt_count The number of currently defined targets.
* config_tpg_list Linked list of target portal group contexts.
* Applications can add or remove target portal groups
* it_tpg_delete functions.
* config_tpg_count The number of currently defined target portal groups
* config_ini_list Linked list of initiator contexts. Applications
* can add initiator contexts or remove initiator
* contexts from this list using the it_ini_create
* and it_ini_delete functions.
* config_ini_count The number of currently defined initiator contexts.
* config_global_properties
* property settings. This list can be manipulated
* using libnvpair(3lib), and should be validated
* and stored using it_config_setprop().
* config_isns_svr_list
* Linked list of currently defined iSNS servers.
* Applications can add or remove iSNS servers by
* using the it_config_setprop() function and changing
* the array of iSNS servers stored in the "isnsserver"
* property.
* config_isns_svr_count
* The number of currently defined iSNS servers.
*
* Global nvlist Properties:
*
* nvlist Key Type Valid Values
* --------------------------------------------------------------------
* alias string any string
* auth string "radius", "chap", or "none"
* isns boolean B_TRUE, B_FALSE
* isnsserver string array Array of portal specifications of
* the form IPaddress:port. Port
* is optional; if not specified, the
* default iSNS port number of 3205 will
* be used. IPv6 addresses should
* be enclosed in square brackets '[' ']'.
* If "none" is specified, all defined
* iSNS servers will be removed from the
* configuration.
* radiusserver string IPaddress:port specification as
* described for 'isnsserver'.
* radiussecret string string of at least 12 characters
* but not more than 255 characters.
* secret will be base64 encoded when
* stored.
*/
typedef struct it_config_s {
} it_config_t;
int
/*
* nvlist version of config is 3 list-of-list, + 1 proplist. arrays
* are interesting, but lists-of-lists are more useful when doing
* individual lookups when we later add support for it. Also, no
* need to store name in individual struct representation.
*/
int
int
int
int
int
int
int
int
int
int
int
int
int
int
int
int
int
it_tgt_t *
it_tpg_t *
int
/*
* Convert a sockaddr to the string representation, suitable for
* storing in an nvlist or printing out in a list.
*/
int
/*
* Convert a char string to a sockaddr structure
*
* default_port should be the port to be used, if not specified
* as part of the supplied string 'arg'.
*/
struct sockaddr_storage *
/*
* Convert an string array of IP-addr:port to a portal list
*/
int
/*
* Function: it_config_free_cmn()
*
* Free any resources associated with the it_config_t structure.
*
* Parameters:
* cfg A C representation of the current iSCSI configuration
*/
void
/*
* Function: it_tgt_free_cmn()
*
* Frees an it_tgt_t structure. If tgt_next is not NULL, frees
* all structures in the list.
*/
void
/*
* Function: it_tpgt_free_cmn()
*
* Deallocates resources of an it_tpgt_t structure. If tpgt->next
* is not NULL, frees all members of the list.
*/
void
/*
* Function: it_tpg_free_cmn()
*
* Deallocates resources associated with an it_tpg_t structure.
* If tpg->next is not NULL, frees all members of the list.
*/
void
/*
* Function: it_ini_free_cmn()
*
* Deallocates resources of an it_ini_t structure. If ini->next is
* not NULL, frees all members of the list.
*/
void
/*
* Function: iscsi_binary_to_base64_str()
*
* Encodes a byte array into a base64 string.
*/
int
char *base64_str_buf, int base64_buf_len);
/*
* Function: iscsi_base64_str_to_binary()
*
* Decodes a base64 string into a byte array
*/
int
#ifdef __cplusplus
}
#endif
#endif /* _ISCSIT_COMMON_H_ */