xref: /spdk/lib/iscsi/portal_grp.h (revision 1fa071d332db21bf893d581a8e93b425ba788a24)
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_PORTAL_GRP_H
36 #define SPDK_PORTAL_GRP_H
37 
38 #include "spdk/conf.h"
39 #include "spdk/cpuset.h"
40 #include "iscsi/iscsi.h"
41 
42 struct spdk_json_write_ctx;
43 
44 struct spdk_iscsi_portal {
45 	struct spdk_iscsi_portal_grp	*group;
46 	char				host[MAX_PORTAL_ADDR + 1];
47 	char				port[MAX_PORTAL_PORT + 1];
48 	struct spdk_sock		*sock;
49 	struct spdk_poller		*acceptor_poller;
50 	TAILQ_ENTRY(spdk_iscsi_portal)	per_pg_tailq;
51 	TAILQ_ENTRY(spdk_iscsi_portal)	g_tailq;
52 };
53 
54 struct spdk_iscsi_portal_grp {
55 	int					ref;
56 	int					tag;
57 	bool					disable_chap;
58 	bool					require_chap;
59 	bool					mutual_chap;
60 	int32_t					chap_group;
61 	TAILQ_ENTRY(spdk_iscsi_portal_grp)	tailq;
62 	TAILQ_HEAD(, spdk_iscsi_portal)		head;
63 };
64 
65 /* SPDK iSCSI Portal Group management API */
66 
67 struct spdk_iscsi_portal *iscsi_portal_create(const char *host, const char *port);
68 void iscsi_portal_destroy(struct spdk_iscsi_portal *p);
69 
70 struct spdk_iscsi_portal_grp *iscsi_portal_grp_create(int tag);
71 void iscsi_portal_grp_add_portal(struct spdk_iscsi_portal_grp *pg,
72 				 struct spdk_iscsi_portal *p);
73 void iscsi_portal_grp_destroy(struct spdk_iscsi_portal_grp *pg);
74 void iscsi_portal_grp_release(struct spdk_iscsi_portal_grp *pg);
75 int iscsi_parse_portal_grps(void);
76 void iscsi_portal_grps_destroy(void);
77 int iscsi_portal_grp_register(struct spdk_iscsi_portal_grp *pg);
78 struct spdk_iscsi_portal_grp *iscsi_portal_grp_unregister(int tag);
79 struct spdk_iscsi_portal_grp *iscsi_portal_grp_find_by_tag(int tag);
80 int iscsi_portal_grp_open(struct spdk_iscsi_portal_grp *pg);
81 int iscsi_portal_grp_set_chap_params(struct spdk_iscsi_portal_grp *pg,
82 				     bool disable_chap, bool require_chap,
83 				     bool mutual_chap, int32_t chap_group);
84 
85 void iscsi_portal_grp_close_all(void);
86 void iscsi_portal_grps_config_text(FILE *fp);
87 void iscsi_portal_grps_info_json(struct spdk_json_write_ctx *w);
88 void iscsi_portal_grps_config_json(struct spdk_json_write_ctx *w);
89 
90 #endif /* SPDK_PORTAL_GRP_H */
91