Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 1 | /*! \file control_cmd.h */ |
| 2 | |
Harald Welte | 5ddd435 | 2014-08-21 15:42:44 +0200 | [diff] [blame] | 3 | #pragma once |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 4 | |
| 5 | #include <osmocom/core/msgb.h> |
Holger Hans Peter Freyther | 43a11db | 2013-01-09 16:54:49 +0100 | [diff] [blame] | 6 | #include <osmocom/core/talloc.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 7 | #include <osmocom/core/write_queue.h> |
Harald Welte | 1238cc6 | 2014-08-20 19:50:04 +0200 | [diff] [blame] | 8 | #include <osmocom/core/logging.h> |
Max | 70c7d41 | 2017-02-24 13:59:14 +0100 | [diff] [blame] | 9 | #include <osmocom/core/utils.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 10 | #include <osmocom/vty/vector.h> |
| 11 | |
| 12 | #define CTRL_CMD_ERROR -1 |
| 13 | #define CTRL_CMD_HANDLED 0 |
| 14 | #define CTRL_CMD_REPLY 1 |
| 15 | |
Daniel Willmann | 35a1b3b | 2011-05-06 16:38:11 +0200 | [diff] [blame] | 16 | struct ctrl_handle; |
| 17 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 18 | enum ctrl_node_type { |
| 19 | CTRL_NODE_ROOT, /* Root elements */ |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 20 | CTRL_NODE_BTS, /* BTS specific (net.btsN.) */ |
| 21 | CTRL_NODE_TRX, /* TRX specific (net.btsN.trxM.) */ |
| 22 | CTRL_NODE_TS, /* TS specific (net.btsN.trxM.tsI.) */ |
Harald Welte | 31c0fef | 2017-04-16 17:26:30 +0200 | [diff] [blame] | 23 | CTRL_NODE_FSM, /* Finite State Machine (description) */ |
| 24 | CTRL_NODE_FSM_INST, /* Finite State Machine (instance) */ |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 25 | _LAST_CTRL_NODE |
| 26 | }; |
| 27 | |
| 28 | enum ctrl_type { |
Neels Hofmeyr | 7c1ec8c | 2017-03-02 14:32:52 +0100 | [diff] [blame] | 29 | CTRL_TYPE_UNKNOWN, |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 30 | CTRL_TYPE_GET, |
| 31 | CTRL_TYPE_SET, |
| 32 | CTRL_TYPE_GET_REPLY, |
| 33 | CTRL_TYPE_SET_REPLY, |
| 34 | CTRL_TYPE_TRAP, |
| 35 | CTRL_TYPE_ERROR |
| 36 | }; |
| 37 | |
Max | 70c7d41 | 2017-02-24 13:59:14 +0100 | [diff] [blame] | 38 | extern const struct value_string ctrl_type_vals[]; |
| 39 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 40 | struct ctrl_connection { |
| 41 | struct llist_head list_entry; |
| 42 | |
| 43 | /* The queue for sending data back */ |
| 44 | struct osmo_wqueue write_queue; |
| 45 | |
Jacob Erlbeck | 141de62 | 2014-03-31 13:42:11 +0200 | [diff] [blame] | 46 | /* Buffer for partial input data */ |
| 47 | struct msgb *pending_msg; |
| 48 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 49 | /* Callback if the connection was closed */ |
| 50 | void (*closed_cb)(struct ctrl_connection *conn); |
| 51 | |
| 52 | /* Pending commands for this connection */ |
| 53 | struct llist_head cmds; |
Harald Welte | 39c9e7b | 2014-08-22 00:28:51 +0200 | [diff] [blame] | 54 | |
| 55 | /* Pending deferred commands for this connection */ |
| 56 | struct llist_head def_cmds; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 57 | }; |
| 58 | |
| 59 | struct ctrl_cmd { |
| 60 | struct ctrl_connection *ccon; |
| 61 | enum ctrl_type type; |
Neels Hofmeyr | 694f72d | 2016-10-20 13:46:23 +0200 | [diff] [blame] | 62 | char *id; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 63 | void *node; |
Neels Hofmeyr | 694f72d | 2016-10-20 13:46:23 +0200 | [diff] [blame] | 64 | char *variable; |
| 65 | char *value; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 66 | char *reply; |
| 67 | }; |
| 68 | |
| 69 | struct ctrl_cmd_struct { |
| 70 | int nr_commands; |
| 71 | char **command; |
| 72 | }; |
| 73 | |
| 74 | struct ctrl_cmd_element { |
| 75 | const char *name; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 76 | struct ctrl_cmd_struct strcmd; |
| 77 | int (*set)(struct ctrl_cmd *cmd, void *data); |
| 78 | int (*get)(struct ctrl_cmd *cmd, void *data); |
| 79 | int (*verify)(struct ctrl_cmd *cmd, const char *value, void *data); |
| 80 | }; |
| 81 | |
| 82 | struct ctrl_cmd_map { |
| 83 | char *cmd; |
| 84 | enum ctrl_type type; |
| 85 | }; |
| 86 | |
Harald Welte | 39c9e7b | 2014-08-22 00:28:51 +0200 | [diff] [blame] | 87 | /* deferred control command, i.e. responded asynchronously */ |
| 88 | struct ctrl_cmd_def { |
| 89 | struct llist_head list; /* ctrl_connection.def_cmds */ |
| 90 | struct ctrl_cmd *cmd; |
| 91 | void *data; /* opaque user data */ |
| 92 | }; |
| 93 | |
| 94 | struct ctrl_cmd_def * |
| 95 | ctrl_cmd_def_make(const void *ctx, struct ctrl_cmd *cmd, void *data, unsigned int secs); |
| 96 | int ctrl_cmd_def_is_zombie(struct ctrl_cmd_def *cd); |
| 97 | int ctrl_cmd_def_send(struct ctrl_cmd_def *cd); |
| 98 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 99 | int ctrl_cmd_exec(vector vline, struct ctrl_cmd *command, vector node, void *data); |
| 100 | int ctrl_cmd_install(enum ctrl_node_type node, struct ctrl_cmd_element *cmd); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 101 | int ctrl_cmd_send(struct osmo_wqueue *queue, struct ctrl_cmd *cmd); |
Daniel Willmann | 35a1b3b | 2011-05-06 16:38:11 +0200 | [diff] [blame] | 102 | int ctrl_cmd_send_to_all(struct ctrl_handle *ctrl, struct ctrl_cmd *cmd); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 103 | struct ctrl_cmd *ctrl_cmd_parse(void *ctx, struct msgb *msg); |
| 104 | struct msgb *ctrl_cmd_make(struct ctrl_cmd *cmd); |
Daniel Willmann | 8b7a962 | 2011-03-17 15:37:54 +0100 | [diff] [blame] | 105 | struct ctrl_cmd *ctrl_cmd_cpy(void *ctx, struct ctrl_cmd *cmd); |
Holger Hans Peter Freyther | a6b3401 | 2011-08-22 23:44:32 +0200 | [diff] [blame] | 106 | struct ctrl_cmd *ctrl_cmd_create(void *ctx, enum ctrl_type); |
Daniel Willmann | f2e75d4 | 2011-07-22 18:08:31 +0200 | [diff] [blame] | 107 | struct ctrl_cmd *ctrl_cmd_trap(struct ctrl_cmd *cmd); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 108 | |
Holger Hans Peter Freyther | 6217930 | 2014-05-15 15:33:46 +0200 | [diff] [blame] | 109 | #define CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, verify_name) \ |
| 110 | static struct ctrl_cmd_element cmd_##cmdname = { \ |
| 111 | .name = cmdstr, \ |
| 112 | .get = &get_##cmdname, \ |
| 113 | .set = &set_##cmdname, \ |
| 114 | .verify = verify_name, \ |
| 115 | } |
Holger Hans Peter Freyther | 05f655e | 2013-02-22 10:09:45 +0100 | [diff] [blame] | 116 | |
| 117 | #define CTRL_HELPER_GET_INT(cmdname, dtype, element) \ |
Holger Hans Peter Freyther | 17e7e5a | 2013-01-09 17:11:50 +0100 | [diff] [blame] | 118 | static int get_##cmdname(struct ctrl_cmd *cmd, void *_data) \ |
Daniel Willmann | fcf010f | 2011-05-05 17:01:09 +0200 | [diff] [blame] | 119 | { \ |
Holger Hans Peter Freyther | 17e7e5a | 2013-01-09 17:11:50 +0100 | [diff] [blame] | 120 | dtype *node = cmd->node; \ |
Daniel Willmann | fcf010f | 2011-05-05 17:01:09 +0200 | [diff] [blame] | 121 | cmd->reply = talloc_asprintf(cmd, "%i", node->element); \ |
| 122 | if (!cmd->reply) { \ |
| 123 | cmd->reply = "OOM"; \ |
| 124 | return CTRL_CMD_ERROR; \ |
| 125 | } \ |
| 126 | return CTRL_CMD_REPLY; \ |
Holger Hans Peter Freyther | 05f655e | 2013-02-22 10:09:45 +0100 | [diff] [blame] | 127 | } |
| 128 | #define CTRL_HELPER_SET_INT(cmdname, dtype, element) \ |
Holger Hans Peter Freyther | 17e7e5a | 2013-01-09 17:11:50 +0100 | [diff] [blame] | 129 | static int set_##cmdname(struct ctrl_cmd *cmd, void *_data) \ |
Daniel Willmann | fcf010f | 2011-05-05 17:01:09 +0200 | [diff] [blame] | 130 | { \ |
Holger Hans Peter Freyther | 17e7e5a | 2013-01-09 17:11:50 +0100 | [diff] [blame] | 131 | dtype *node = cmd->node; \ |
Daniel Willmann | fcf010f | 2011-05-05 17:01:09 +0200 | [diff] [blame] | 132 | int tmp = atoi(cmd->value); \ |
| 133 | node->element = tmp; \ |
Holger Hans Peter Freyther | 17e7e5a | 2013-01-09 17:11:50 +0100 | [diff] [blame] | 134 | return get_##cmdname(cmd, _data); \ |
Holger Hans Peter Freyther | 05f655e | 2013-02-22 10:09:45 +0100 | [diff] [blame] | 135 | } |
| 136 | #define CTRL_HELPER_VERIFY_RANGE(cmdname, min, max) \ |
Holger Hans Peter Freyther | 17e7e5a | 2013-01-09 17:11:50 +0100 | [diff] [blame] | 137 | static int verify_##cmdname(struct ctrl_cmd *cmd, const char *value, void *_data) \ |
Daniel Willmann | fcf010f | 2011-05-05 17:01:09 +0200 | [diff] [blame] | 138 | { \ |
| 139 | int tmp = atoi(value); \ |
| 140 | if ((tmp >= min)&&(tmp <= max)) { \ |
| 141 | return 0; \ |
| 142 | } \ |
Holger Hans Peter Freyther | e9f7be1 | 2013-02-22 10:53:29 +0100 | [diff] [blame] | 143 | cmd->reply = "Input not within the range"; \ |
Daniel Willmann | fcf010f | 2011-05-05 17:01:09 +0200 | [diff] [blame] | 144 | return -1; \ |
Holger Hans Peter Freyther | 05f655e | 2013-02-22 10:09:45 +0100 | [diff] [blame] | 145 | } |
| 146 | |
| 147 | #define CTRL_CMD_DEFINE_RANGE(cmdname, cmdstr, dtype, element, min, max) \ |
| 148 | CTRL_HELPER_GET_INT(cmdname, dtype, element) \ |
| 149 | CTRL_HELPER_SET_INT(cmdname, dtype, element) \ |
| 150 | CTRL_HELPER_VERIFY_RANGE(cmdname, min, max) \ |
Holger Hans Peter Freyther | 0e7b67c | 2014-05-15 17:27:12 +0200 | [diff] [blame] | 151 | CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, verify_##cmdname) |
Daniel Willmann | fcf010f | 2011-05-05 17:01:09 +0200 | [diff] [blame] | 152 | |
Holger Hans Peter Freyther | 416e316 | 2013-02-22 11:04:35 +0100 | [diff] [blame] | 153 | #define CTRL_HELPER_GET_STRING(cmdname, dtype, element) \ |
Holger Hans Peter Freyther | 43a11db | 2013-01-09 16:54:49 +0100 | [diff] [blame] | 154 | static int get_##cmdname(struct ctrl_cmd *cmd, void *_data) \ |
Daniel Willmann | fcf010f | 2011-05-05 17:01:09 +0200 | [diff] [blame] | 155 | { \ |
Holger Hans Peter Freyther | 17e7e5a | 2013-01-09 17:11:50 +0100 | [diff] [blame] | 156 | dtype *data = cmd->node; \ |
Daniel Willmann | fcf010f | 2011-05-05 17:01:09 +0200 | [diff] [blame] | 157 | cmd->reply = talloc_asprintf(cmd, "%s", data->element); \ |
| 158 | if (!cmd->reply) { \ |
| 159 | cmd->reply = "OOM"; \ |
| 160 | return CTRL_CMD_ERROR; \ |
| 161 | } \ |
| 162 | return CTRL_CMD_REPLY; \ |
Holger Hans Peter Freyther | 416e316 | 2013-02-22 11:04:35 +0100 | [diff] [blame] | 163 | } |
| 164 | #define CTRL_HELPER_SET_STRING(cmdname, dtype, element) \ |
Holger Hans Peter Freyther | 43a11db | 2013-01-09 16:54:49 +0100 | [diff] [blame] | 165 | static int set_##cmdname(struct ctrl_cmd *cmd, void *_data) \ |
Daniel Willmann | fcf010f | 2011-05-05 17:01:09 +0200 | [diff] [blame] | 166 | { \ |
Holger Hans Peter Freyther | 17e7e5a | 2013-01-09 17:11:50 +0100 | [diff] [blame] | 167 | dtype *data = cmd->node; \ |
Harald Welte | f3c7e85 | 2014-08-20 22:50:47 +0200 | [diff] [blame] | 168 | osmo_talloc_replace_string(cmd->node, &data->element, cmd->value); \ |
Holger Hans Peter Freyther | 17e7e5a | 2013-01-09 17:11:50 +0100 | [diff] [blame] | 169 | return get_##cmdname(cmd, _data); \ |
Holger Hans Peter Freyther | 416e316 | 2013-02-22 11:04:35 +0100 | [diff] [blame] | 170 | } |
| 171 | #define CTRL_CMD_DEFINE_STRING(cmdname, cmdstr, dtype, element) \ |
| 172 | CTRL_HELPER_GET_STRING(cmdname, dtype, element) \ |
| 173 | CTRL_HELPER_SET_STRING(cmdname, dtype, element) \ |
Holger Hans Peter Freyther | 6217930 | 2014-05-15 15:33:46 +0200 | [diff] [blame] | 174 | CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, NULL) |
Daniel Willmann | fcf010f | 2011-05-05 17:01:09 +0200 | [diff] [blame] | 175 | |
| 176 | #define CTRL_CMD_DEFINE(cmdname, cmdstr) \ |
Daniel Willmann | f7c74e5 | 2011-08-05 11:48:18 +0200 | [diff] [blame] | 177 | static int get_##cmdname(struct ctrl_cmd *cmd, void *data); \ |
| 178 | static int set_##cmdname(struct ctrl_cmd *cmd, void *data); \ |
| 179 | static int verify_##cmdname(struct ctrl_cmd *cmd, const char *value, void *data); \ |
Holger Hans Peter Freyther | 6217930 | 2014-05-15 15:33:46 +0200 | [diff] [blame] | 180 | CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, verify_##cmdname) |
Daniel Willmann | fcf010f | 2011-05-05 17:01:09 +0200 | [diff] [blame] | 181 | |
Holger Hans Peter Freyther | c08c551 | 2014-05-14 09:50:27 +0200 | [diff] [blame] | 182 | #define CTRL_CMD_DEFINE_RO(cmdname, cmdstr) \ |
| 183 | static int get_##cmdname(struct ctrl_cmd *cmd, void *data); \ |
| 184 | static int set_##cmdname(struct ctrl_cmd *cmd, void *data) \ |
| 185 | { \ |
| 186 | cmd->reply = "Read Only attribute"; \ |
| 187 | return CTRL_CMD_ERROR; \ |
| 188 | } \ |
| 189 | static int verify_##cmdname(struct ctrl_cmd *cmd, const char *value, void *data) \ |
| 190 | { \ |
| 191 | cmd->reply = "Read Only attribute"; \ |
| 192 | return 1; \ |
| 193 | } \ |
Holger Hans Peter Freyther | 6217930 | 2014-05-15 15:33:46 +0200 | [diff] [blame] | 194 | CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, verify_##cmdname) |
Holger Hans Peter Freyther | c08c551 | 2014-05-14 09:50:27 +0200 | [diff] [blame] | 195 | |
Max | 8928747 | 2017-01-11 17:47:04 +0100 | [diff] [blame] | 196 | #define CTRL_CMD_DEFINE_WO(cmdname, cmdstr) \ |
| 197 | static int set_##cmdname(struct ctrl_cmd *cmd, void *data); \ |
| 198 | static int get_##cmdname(struct ctrl_cmd *cmd, void *data) \ |
| 199 | { \ |
| 200 | cmd->reply = "Write Only attribute"; \ |
| 201 | return CTRL_CMD_ERROR; \ |
| 202 | } \ |
| 203 | static int verify_##cmdname(struct ctrl_cmd *cmd, const char *val, void *data); \ |
| 204 | CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, verify_##cmdname) |
| 205 | |
| 206 | |
| 207 | #define CTRL_CMD_DEFINE_WO_NOVRF(cmdname, cmdstr) \ |
| 208 | static int set_##cmdname(struct ctrl_cmd *cmd, void *data); \ |
| 209 | static int get_##cmdname(struct ctrl_cmd *cmd, void *data) \ |
| 210 | { \ |
| 211 | cmd->reply = "Write Only attribute"; \ |
| 212 | return CTRL_CMD_ERROR; \ |
| 213 | } \ |
| 214 | static int verify_##cmdname(struct ctrl_cmd *cmd, const char *val, void *data) \ |
| 215 | { \ |
| 216 | return 0; \ |
| 217 | } \ |
| 218 | CTRL_CMD_DEFINE_STRUCT(cmdname, cmdstr, verify_##cmdname) |
| 219 | |
Harald Welte | 18b70b5 | 2011-07-13 14:14:03 +0200 | [diff] [blame] | 220 | struct gsm_network; |