1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
#ifndef HICNLIGHT_CONFIG_COMMAND
#define HICNLIGHT_CONFIG_COMMAND
/**
* @file command.h
* @brief Commands.
*/
#include <stddef.h> // offsetof
#include <hicn/util/ip_address.h>
#include <hicn/ctrl/api.h>
/* Update sscanf accordingly in parse_cmd.c */
#define MAX_PARAMETERS 10
#define MAX_SCANF_PARAM_LEN 100
typedef int (*parser_hook_t)(void *arg);
typedef enum {
TYPENAME_UNDEFINED,
TYPENAME_INT,
TYPENAME_UINT,
TYPENAME_INT16,
TYPENAME_UINT16,
TYPENAME_STR,
TYPENAME_SYMBOLIC_OR_ID,
TYPENAME_INTERFACE_NAME,
TYPENAME_IP_ADDRESS,
TYPENAME_IP_PREFIX,
TYPENAME_ON_OFF,
TYPENAME_ENUM,
TYPENAME_POLICY_STATE,
} parser_typename_t;
typedef struct {
parser_typename_t name;
union {
struct {
size_t max_size;
} str;
struct {
int min;
int max;
} integer;
struct {
int (*from_str)(const char *str);
} enum_;
struct {
policy_tag_t tag;
} policy_state;
};
} parser_type_t;
typedef struct {
const char *name;
const char *help;
parser_type_t type;
size_t offset;
/*
* quick hack to let the functions update two or more parameters, like for
* IP_ADDRESS or IP_PREFIX types
*/
size_t offset2;
size_t offset3;
} command_parameter_t;
typedef struct {
hc_action_t action;
hc_object_type_t object_type;
unsigned nparams;
command_parameter_t parameters[MAX_PARAMETERS];
parser_hook_t post_hook;
} command_parser_t;
/*
* NOTE: we now use strings everywhere to parse in the same way parameters
* coming from the commandline through getopt (strings), and those coming from
* sscanf (used to be variables, now all strings also.
*/
#define TYPE_STRN(N) \
(parser_type_t) { \
.name = TYPENAME_STR, \
.str = { \
.max_size = N, \
}, \
}
#define TYPE_INT(MIN, MAX) \
(parser_type_t) { \
.name = TYPENAME_INT, \
.integer = { \
.min = (MIN), \
.max = (MAX), \
}, \
}
#define TYPE_UINT(MIN, MAX) \
(parser_type_t) { \
.name = TYPENAME_UINT, \
.integer = { \
.min = (MIN), \
.max = (MAX), \
}, \
}
#define TYPE_INT16(MIN, MAX) \
(parser_type_t) { \
.name = TYPENAME_INT16, \
.integer = { \
.min = (MIN), \
.max = (MAX), \
}, \
}
#define TYPE_UINT16(MIN, MAX) \
(parser_type_t) { \
.name = TYPENAME_UINT16, \
.integer = { \
.min = (MIN), \
.max = (MAX), \
}, \
}
#define TYPE_SYMBOLIC_OR_ID TYPE_STRN(SYMBOLIC_NAME_LEN)
#define TYPE_INTERFACE_NAME TYPE_STRN(INTERFACE_LEN)
#define TYPE_IP_ADDRESS \
(parser_type_t) { .name = TYPENAME_IP_ADDRESS, }
#define TYPE_IP_PREFIX \
(parser_type_t) { .name = TYPENAME_IP_PREFIX, }
#define TYPE_ON_OFF \
(parser_type_t) { .name = TYPENAME_ON_OFF, }
#define TYPE_ENUM(x) \
(parser_type_t) { \
.name = TYPENAME_ENUM, \
.enum_ = { \
.from_str = (int (*)(const char *))x##_from_str, \
}, \
}
/* We need to allocate room for the intermediate string */
#define TYPE_POLICY_STATE(TAG) \
(parser_type_t) { \
.name = TYPENAME_POLICY_STATE, \
.policy_state = { \
.tag = TAG, \
}, \
}
/* We need to allocate room for the intermediate string */
/**
* \brief Register a protocol
* \param protocol Pointer to a protocol_t structure describing the protocol to
* register \return None
*/
void command_register(const command_parser_t *command);
/**
* \brief Search a registered protocol in the library according to its name
* \param[in] action The action of the command.
* \param[in] object The object of the command.
* \param[in] nparams The number of parameters expected in the command.
* \return A pointer to the corresponding command if any, NULL othewise
*/
const command_parser_t *command_search(hc_action_t action,
hc_object_type_t object,
unsigned nparams);
/**
* @brief List the commands associated with the specified object and/or action.
* Use OBJECT_UNDEFINED and ACTION_UNDEFINED to list all the available objects.
* Use ACTION_UNDEFINED to list all the actions associated to the specified
* object.
*
* @param object The action of the command
* @param action The object of the command
*/
void command_list(hc_object_type_t object, hc_action_t action);
#define COMMAND_REGISTER(MOD) \
static void __init_##MOD(void) __attribute__((constructor)); \
static void __init_##MOD(void) { command_register(&MOD); }
#endif /* HICNLIGHT_CONFIG_COMMAND */
|
