[ceph.git] / ceph / src / spdk / lib / iscsi / tgt_node.h

/*-
 *   BSD LICENSE
 *
 *   Copyright (C) 2008-2012 Daisuke Aoyama <aoyama@peach.ne.jp>.
 *   Copyright (c) Intel Corporation.
 *   All rights reserved.
 *
 *   Redistribution and use in source and binary forms, with or without
 *   modification, are permitted provided that the following conditions
 *   are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of Intel Corporation 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
 *   OWNER 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.
 */

#ifndef SPDK_ISCSI_TGT_NODE_H_
#define SPDK_ISCSI_TGT_NODE_H_

#include "spdk/stdinc.h"

#include "iscsi/iscsi.h"

struct spdk_iscsi_conn;
struct spdk_iscsi_init_grp;
struct spdk_iscsi_portal_grp;
struct spdk_iscsi_portal;
struct spdk_json_write_ctx;

#define MAX_TARGET_MAP			256
#define SPDK_TN_TAG_MAX			0x0000ffff

typedef void (*iscsi_tgt_node_destruct_cb)(void *cb_arg, int rc);

struct spdk_iscsi_ig_map {
	struct spdk_iscsi_init_grp *ig;
	TAILQ_ENTRY(spdk_iscsi_ig_map) tailq;
};

struct spdk_iscsi_pg_map {
	struct spdk_iscsi_portal_grp *pg;
	int num_ig_maps;
	TAILQ_HEAD(, spdk_iscsi_ig_map) ig_map_head;
	TAILQ_ENTRY(spdk_iscsi_pg_map) tailq ;
};

struct spdk_iscsi_tgt_node {
	int num;
	char name[MAX_TARGET_NAME + 1];
	char alias[MAX_TARGET_NAME + 1];

	pthread_mutex_t mutex;

	bool disable_chap;
	bool require_chap;
	bool mutual_chap;
	int chap_group;
	bool header_digest;
	bool data_digest;
	int queue_depth;

	struct spdk_scsi_dev *dev;
	/**
	 * Counts number of active iSCSI connections associated with this
	 *  target node.
	 */
	uint32_t num_active_conns;
	struct spdk_iscsi_poll_group *pg;

	int num_pg_maps;
	TAILQ_HEAD(, spdk_iscsi_pg_map) pg_map_head;
	TAILQ_ENTRY(spdk_iscsi_tgt_node) tailq;

	bool destructed;
	struct spdk_poller *destruct_poller;
	iscsi_tgt_node_destruct_cb destruct_cb_fn;
	void *destruct_cb_arg;
};

int iscsi_parse_tgt_nodes(void);

void iscsi_shutdown_tgt_nodes(void);
void iscsi_shutdown_tgt_node_by_name(const char *target_name,
				     iscsi_tgt_node_destruct_cb cb_fn, void *cb_arg);
bool iscsi_tgt_node_is_destructed(struct spdk_iscsi_tgt_node *target);
int iscsi_send_tgts(struct spdk_iscsi_conn *conn, const char *iiqn,
		    const char *iaddr, const char *tiqn, uint8_t *data, int alloc_len,
		    int data_len);

/*
 * bdev_name_list and lun_id_list are equal sized arrays of size num_luns.
 * bdev_name_list refers to the names of the bdevs that will be used for the LUNs on the
 *  new target node.
 * lun_id_list refers to the LUN IDs that will be used for the LUNs on the target node.
 */
struct spdk_iscsi_tgt_node *iscsi_tgt_node_construct(int target_index,
		const char *name, const char *alias,
		int *pg_tag_list, int *ig_tag_list, uint16_t num_maps,
		const char *bdev_name_list[], int *lun_id_list, int num_luns,
		int queue_depth,
		bool disable_chap, bool require_chap, bool mutual_chap, int chap_group,
		bool header_digest, bool data_digest);

bool iscsi_check_chap_params(bool disable, bool require, bool mutual, int group);

int iscsi_target_node_add_pg_ig_maps(struct spdk_iscsi_tgt_node *target,
				     int *pg_tag_list, int *ig_tag_list,
				     uint16_t num_maps);
int iscsi_target_node_remove_pg_ig_maps(struct spdk_iscsi_tgt_node *target,
					int *pg_tag_list, int *ig_tag_list,
					uint16_t num_maps);

bool iscsi_tgt_node_access(struct spdk_iscsi_conn *conn,
			   struct spdk_iscsi_tgt_node *target, const char *iqn,
			   const char *addr);
struct spdk_iscsi_tgt_node *iscsi_find_tgt_node(const char *target_name);
int iscsi_tgt_node_cleanup_luns(struct spdk_iscsi_conn *conn,
				struct spdk_iscsi_tgt_node *target);
void iscsi_tgt_node_delete_map(struct spdk_iscsi_portal_grp *portal_group,
			       struct spdk_iscsi_init_grp *initiator_group);
int iscsi_tgt_node_add_lun(struct spdk_iscsi_tgt_node *target,
			   const char *bdev_name, int lun_id);
int iscsi_tgt_node_set_chap_params(struct spdk_iscsi_tgt_node *target,
				   bool disable_chap, bool require_chap,
				   bool mutual_chap, int32_t chap_group);
void iscsi_tgt_nodes_config_text(FILE *fp);
void iscsi_tgt_nodes_info_json(struct spdk_json_write_ctx *w);
void iscsi_tgt_nodes_config_json(struct spdk_json_write_ctx *w);
#endif /* SPDK_ISCSI_TGT_NODE_H_ */
Commit	Line	Data
7c673cae FG	1	/*-
	2	* BSD LICENSE
	3	*
	4	* Copyright (C) 2008-2012 Daisuke Aoyama <aoyama@peach.ne.jp>.
	5	* Copyright (c) Intel Corporation.
	6	* All rights reserved.
	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	*
	12	* * Redistributions of source code must retain the above copyright
	13	* notice, this list of conditions and the following disclaimer.
	14	* * Redistributions in binary form must reproduce the above copyright
	15	* notice, this list of conditions and the following disclaimer in
	16	* the documentation and/or other materials provided with the
	17	* distribution.
	18	* * Neither the name of Intel Corporation nor the names of its
	19	* contributors may be used to endorse or promote products derived
	20	* from this software without specific prior written permission.
	21	*
	22	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	23	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	24	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	25	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	26	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	27	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	28	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	29	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	30	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	31	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	32	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	33	*/
	34
	35	#ifndef SPDK_ISCSI_TGT_NODE_H_
	36	#define SPDK_ISCSI_TGT_NODE_H_
	37
11fdf7f2	38	#include "spdk/stdinc.h"
7c673cae	39
f67539c2	40	#include "iscsi/iscsi.h"
7c673cae FG	41
7c673cae FG	42	struct spdk_iscsi_conn;
11fdf7f2 TL	43	struct spdk_iscsi_init_grp;
	44	struct spdk_iscsi_portal_grp;
	45	struct spdk_iscsi_portal;
	46	struct spdk_json_write_ctx;
7c673cae	47
7c673cae	48	#define MAX_TARGET_MAP 256
11fdf7f2	49	#define SPDK_TN_TAG_MAX 0x0000ffff
7c673cae	50
9f95a23c TL	51	typedef void (iscsi_tgt_node_destruct_cb)(void cb_arg, int rc);
9f95a23c TL	52
11fdf7f2 TL	53	struct spdk_iscsi_ig_map {
	54	struct spdk_iscsi_init_grp *ig;
	55	TAILQ_ENTRY(spdk_iscsi_ig_map) tailq;
	56	};
	57
	58	struct spdk_iscsi_pg_map {
	59	struct spdk_iscsi_portal_grp *pg;
	60	int num_ig_maps;
	61	TAILQ_HEAD(, spdk_iscsi_ig_map) ig_map_head;
	62	TAILQ_ENTRY(spdk_iscsi_pg_map) tailq ;
7c673cae FG	63	};
	64
	65	struct spdk_iscsi_tgt_node {
	66	int num;
f67539c2 TL	67	char name[MAX_TARGET_NAME + 1];
f67539c2 TL	68	char alias[MAX_TARGET_NAME + 1];
7c673cae FG	69
	70	pthread_mutex_t mutex;
	71
11fdf7f2 TL	72	bool disable_chap;
	73	bool require_chap;
	74	bool mutual_chap;
	75	int chap_group;
	76	bool header_digest;
	77	bool data_digest;
7c673cae FG	78	int queue_depth;
	79
	80	struct spdk_scsi_dev *dev;
	81	/**
	82	* Counts number of active iSCSI connections associated with this
	83	* target node.
	84	*/
	85	uint32_t num_active_conns;
f67539c2	86	struct spdk_iscsi_poll_group *pg;
7c673cae	87
11fdf7f2 TL	88	int num_pg_maps;
	89	TAILQ_HEAD(, spdk_iscsi_pg_map) pg_map_head;
	90	TAILQ_ENTRY(spdk_iscsi_tgt_node) tailq;
9f95a23c TL	91
	92	bool destructed;
	93	struct spdk_poller *destruct_poller;
	94	iscsi_tgt_node_destruct_cb destruct_cb_fn;
	95	void *destruct_cb_arg;
7c673cae FG	96	};
7c673cae FG	97
f67539c2	98	int iscsi_parse_tgt_nodes(void);
7c673cae	99
f67539c2 TL	100	void iscsi_shutdown_tgt_nodes(void);
	101	void iscsi_shutdown_tgt_node_by_name(const char *target_name,
	102	iscsi_tgt_node_destruct_cb cb_fn, void *cb_arg);
	103	bool iscsi_tgt_node_is_destructed(struct spdk_iscsi_tgt_node *target);
	104	int iscsi_send_tgts(struct spdk_iscsi_conn conn, const char iiqn,
	105	const char iaddr, const char tiqn, uint8_t *data, int alloc_len,
	106	int data_len);
7c673cae	107
11fdf7f2 TL	108	/*
	109	* bdev_name_list and lun_id_list are equal sized arrays of size num_luns.
	110	* bdev_name_list refers to the names of the bdevs that will be used for the LUNs on the
	111	* new target node.
	112	* lun_id_list refers to the LUN IDs that will be used for the LUNs on the target node.
	113	*/
f67539c2 TL	114	struct spdk_iscsi_tgt_node *iscsi_tgt_node_construct(int target_index,
	115	const char name, const char alias,
	116	int pg_tag_list, int ig_tag_list, uint16_t num_maps,
	117	const char bdev_name_list[], int lun_id_list, int num_luns,
	118	int queue_depth,
	119	bool disable_chap, bool require_chap, bool mutual_chap, int chap_group,
	120	bool header_digest, bool data_digest);
	121
	122	bool iscsi_check_chap_params(bool disable, bool require, bool mutual, int group);
	123
	124	int iscsi_target_node_add_pg_ig_maps(struct spdk_iscsi_tgt_node *target,
	125	int pg_tag_list, int ig_tag_list,
	126	uint16_t num_maps);
	127	int iscsi_target_node_remove_pg_ig_maps(struct spdk_iscsi_tgt_node *target,
	128	int pg_tag_list, int ig_tag_list,
	129	uint16_t num_maps);
	130
	131	bool iscsi_tgt_node_access(struct spdk_iscsi_conn *conn,
	132	struct spdk_iscsi_tgt_node target, const char iqn,
	133	const char *addr);
	134	struct spdk_iscsi_tgt_node iscsi_find_tgt_node(const char target_name);
	135	int iscsi_tgt_node_cleanup_luns(struct spdk_iscsi_conn *conn,
	136	struct spdk_iscsi_tgt_node *target);
	137	void iscsi_tgt_node_delete_map(struct spdk_iscsi_portal_grp *portal_group,
	138	struct spdk_iscsi_init_grp *initiator_group);
	139	int iscsi_tgt_node_add_lun(struct spdk_iscsi_tgt_node *target,
	140	const char *bdev_name, int lun_id);
	141	int iscsi_tgt_node_set_chap_params(struct spdk_iscsi_tgt_node *target,
	142	bool disable_chap, bool require_chap,
	143	bool mutual_chap, int32_t chap_group);
	144	void iscsi_tgt_nodes_config_text(FILE *fp);
	145	void iscsi_tgt_nodes_info_json(struct spdk_json_write_ctx *w);
	146	void iscsi_tgt_nodes_config_json(struct spdk_json_write_ctx *w);
7c673cae	147	#endif /* SPDK_ISCSI_TGT_NODE_H_ */