xref: /spdk/lib/iscsi/param.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_ISCSI_PARAM_H
36 #define SPDK_ISCSI_PARAM_H
37 
38 #include "spdk/stdinc.h"
39 
40 struct spdk_iscsi_conn;
41 
42 enum iscsi_param_type {
43 	ISPT_INVALID = -1,
44 	ISPT_NOTSPECIFIED = 0,
45 	ISPT_LIST,
46 	ISPT_NUMERICAL_MIN,
47 	ISPT_NUMERICAL_MAX,
48 	ISPT_NUMERICAL_DECLARATIVE,
49 	ISPT_DECLARATIVE,
50 	ISPT_BOOLEAN_OR,
51 	ISPT_BOOLEAN_AND,
52 };
53 
54 struct iscsi_param {
55 	struct iscsi_param *next;
56 	char *key;
57 	char *val;
58 	char *list;
59 	int type;
60 	int state_index;
61 };
62 
63 void
64 iscsi_param_free(struct iscsi_param *params);
65 struct iscsi_param *
66 iscsi_param_find(struct iscsi_param *params, const char *key);
67 int
68 iscsi_param_del(struct iscsi_param **params, const char *key);
69 int
70 iscsi_param_add(struct iscsi_param **params, const char *key,
71 		const char *val, const char *list, int type);
72 int
73 iscsi_param_set(struct iscsi_param *params, const char *key,
74 		const char *val);
75 int
76 iscsi_param_set_int(struct iscsi_param *params, const char *key, uint32_t val);
77 int
78 iscsi_parse_params(struct iscsi_param **params, const uint8_t *data,
79 		   int len, bool cbit_enabled, char **partial_parameter);
80 char *
81 iscsi_param_get_val(struct iscsi_param *params, const char *key);
82 int
83 iscsi_param_eq_val(struct iscsi_param *params, const char *key,
84 		   const char *val);
85 
86 int iscsi_negotiate_params(struct spdk_iscsi_conn *conn,
87 			   struct iscsi_param **params_p, uint8_t *data,
88 			   int alloc_len, int data_len);
89 int iscsi_copy_param2var(struct spdk_iscsi_conn *conn);
90 
91 int iscsi_conn_params_init(struct iscsi_param **params);
92 int iscsi_sess_params_init(struct iscsi_param **params);
93 
94 #endif /* SPDK_ISCSI_PARAM_H */
95