Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 1 | /*! \file control_if.c |
| 2 | * SNMP-like status interface. */ |
| 3 | /* |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 4 | * (C) 2010-2011 by Daniel Willmann <daniel@totalueberwachung.de> |
| 5 | * (C) 2010-2011 by On-Waves |
| 6 | * |
| 7 | * All Rights Reserved |
| 8 | * |
| 9 | * This program is free software; you can redistribute it and/or modify |
| 10 | * it under the terms of the GNU General Public License as published by |
| 11 | * the Free Software Foundation; either version 2 of the License, or |
| 12 | * (at your option) any later version. |
| 13 | * |
| 14 | * This program is distributed in the hope that it will be useful, |
| 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | * GNU General Public License for more details. |
| 18 | * |
| 19 | * You should have received a copy of the GNU General Public License along |
| 20 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 21 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 22 | * |
| 23 | */ |
| 24 | |
Holger Hans Peter Freyther | 267fd86 | 2015-03-18 21:52:38 +0100 | [diff] [blame] | 25 | #include "config.h" |
| 26 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 27 | #include <errno.h> |
Daniel Willmann | 0834a34 | 2011-07-19 12:12:10 +0200 | [diff] [blame] | 28 | #include <inttypes.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 29 | #include <stdio.h> |
| 30 | #include <stdlib.h> |
| 31 | #include <string.h> |
| 32 | #include <time.h> |
| 33 | #include <unistd.h> |
| 34 | |
| 35 | #include <arpa/inet.h> |
| 36 | |
Holger Hans Peter Freyther | 5e21131 | 2014-08-21 16:31:52 +0200 | [diff] [blame] | 37 | #include <netinet/in.h> |
Harald Welte | e15ac06 | 2014-12-04 14:15:36 +0100 | [diff] [blame] | 38 | #ifdef HAVE_NETINET_TCP_H |
| 39 | #include <netinet/tcp.h> |
| 40 | #endif |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 41 | |
Harald Welte | e15ac06 | 2014-12-04 14:15:36 +0100 | [diff] [blame] | 42 | #include <fcntl.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 43 | #include <sys/ioctl.h> |
| 44 | #include <sys/socket.h> |
| 45 | #include <sys/types.h> |
| 46 | |
Harald Welte | 1238cc6 | 2014-08-20 19:50:04 +0200 | [diff] [blame] | 47 | #include <osmocom/ctrl/control_cmd.h> |
| 48 | #include <osmocom/ctrl/control_if.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 49 | |
| 50 | #include <osmocom/core/msgb.h> |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 51 | #include <osmocom/core/rate_ctr.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 52 | #include <osmocom/core/select.h> |
Harald Welte | 216338c | 2017-10-15 19:46:19 +0200 | [diff] [blame] | 53 | #include <osmocom/core/counter.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 54 | #include <osmocom/core/talloc.h> |
Harald Welte | 1238cc6 | 2014-08-20 19:50:04 +0200 | [diff] [blame] | 55 | #include <osmocom/core/socket.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 56 | |
Harald Welte | 1238cc6 | 2014-08-20 19:50:04 +0200 | [diff] [blame] | 57 | #include <osmocom/gsm/protocol/ipaccess.h> |
Harald Welte | acbb4c9 | 2014-08-20 22:51:25 +0200 | [diff] [blame] | 58 | #include <osmocom/gsm/ipa.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 59 | |
| 60 | #include <osmocom/vty/command.h> |
| 61 | #include <osmocom/vty/vector.h> |
| 62 | |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 63 | extern int osmo_fsm_ctrl_cmds_install(void); |
| 64 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 65 | vector ctrl_node_vec; |
| 66 | |
Harald Welte | d6b1f85 | 2017-04-16 16:57:40 +0200 | [diff] [blame] | 67 | /* global list of control interface lookup helpers */ |
| 68 | struct lookup_helper { |
| 69 | struct llist_head list; |
| 70 | ctrl_cmd_lookup lookup; |
| 71 | }; |
| 72 | static LLIST_HEAD(ctrl_lookup_helpers); |
| 73 | |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 74 | int ctrl_parse_get_num(vector vline, int i, long *num) |
| 75 | { |
| 76 | char *token, *tmp; |
| 77 | |
| 78 | if (i >= vector_active(vline)) |
| 79 | return 0; |
| 80 | token = vector_slot(vline, i); |
| 81 | |
| 82 | errno = 0; |
| 83 | if (token[0] == '\0') |
| 84 | return 0; |
| 85 | |
| 86 | *num = strtol(token, &tmp, 10); |
| 87 | if (tmp[0] != '\0' || errno != 0) |
| 88 | return 0; |
| 89 | |
| 90 | return 1; |
| 91 | } |
| 92 | |
Daniel Willmann | 35a1b3b | 2011-05-06 16:38:11 +0200 | [diff] [blame] | 93 | /* Send command to all */ |
| 94 | int ctrl_cmd_send_to_all(struct ctrl_handle *ctrl, struct ctrl_cmd *cmd) |
| 95 | { |
| 96 | struct ctrl_connection *ccon; |
| 97 | int ret = 0; |
| 98 | |
| 99 | llist_for_each_entry(ccon, &ctrl->ccon_list, list_entry) { |
| 100 | if (ccon == cmd->ccon) |
| 101 | continue; |
| 102 | if (ctrl_cmd_send(&ccon->write_queue, cmd)) |
| 103 | ret++; |
| 104 | } |
| 105 | return ret; |
| 106 | } |
| 107 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 108 | int ctrl_cmd_send(struct osmo_wqueue *queue, struct ctrl_cmd *cmd) |
| 109 | { |
| 110 | int ret; |
| 111 | struct msgb *msg; |
| 112 | |
| 113 | msg = ctrl_cmd_make(cmd); |
| 114 | if (!msg) { |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 115 | LOGP(DLCTRL, LOGL_ERROR, "Could not generate msg\n"); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 116 | return -1; |
| 117 | } |
| 118 | |
Harald Welte | acbb4c9 | 2014-08-20 22:51:25 +0200 | [diff] [blame] | 119 | ipa_prepend_header_ext(msg, IPAC_PROTO_EXT_CTRL); |
| 120 | ipa_prepend_header(msg, IPAC_PROTO_OSMO); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 121 | |
| 122 | ret = osmo_wqueue_enqueue(queue, msg); |
| 123 | if (ret != 0) { |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 124 | LOGP(DLCTRL, LOGL_ERROR, "Failed to enqueue the command.\n"); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 125 | msgb_free(msg); |
| 126 | } |
| 127 | return ret; |
| 128 | } |
| 129 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 130 | /*! Send TRAP over given Control Interface |
Max | bc067eb | 2016-08-04 11:07:08 +0200 | [diff] [blame] | 131 | * \param[in] ctrl Control Interface over which TRAP will be sent |
| 132 | * \param[in] name Name of the TRAP variable |
| 133 | * \param[in] value Value of the TRAP variable |
| 134 | * \return Negative value on error, result of ctrl_cmd_send_to_all() otherwise |
| 135 | */ |
| 136 | int ctrl_cmd_send_trap(struct ctrl_handle *ctrl, const char *name, char *value) |
| 137 | { |
| 138 | int r; |
| 139 | struct ctrl_cmd *cmd = ctrl_cmd_create(NULL, CTRL_TYPE_TRAP); |
| 140 | if (!cmd) |
| 141 | return -ENOMEM; |
| 142 | |
| 143 | cmd->id = "0"; /* It's a TRAP! */ |
Harald Welte | f12d40f | 2017-02-08 15:46:53 +0000 | [diff] [blame] | 144 | cmd->variable = (char *) name; |
Max | bc067eb | 2016-08-04 11:07:08 +0200 | [diff] [blame] | 145 | cmd->reply = value; |
| 146 | r = ctrl_cmd_send_to_all(ctrl, cmd); |
| 147 | talloc_free(cmd); |
| 148 | return r; |
| 149 | } |
| 150 | |
Daniel Willmann | f2e75d4 | 2011-07-22 18:08:31 +0200 | [diff] [blame] | 151 | struct ctrl_cmd *ctrl_cmd_trap(struct ctrl_cmd *cmd) |
| 152 | { |
| 153 | struct ctrl_cmd *trap; |
| 154 | |
Harald Welte | c9df37d | 2014-08-20 19:55:17 +0200 | [diff] [blame] | 155 | trap = ctrl_cmd_cpy(cmd, cmd); |
Daniel Willmann | f2e75d4 | 2011-07-22 18:08:31 +0200 | [diff] [blame] | 156 | if (!trap) |
| 157 | return NULL; |
| 158 | |
| 159 | trap->ccon = cmd->ccon; |
| 160 | trap->type = CTRL_TYPE_TRAP; |
| 161 | return trap; |
| 162 | } |
| 163 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 164 | static void control_close_conn(struct ctrl_connection *ccon) |
| 165 | { |
Harald Welte | 39c9e7b | 2014-08-22 00:28:51 +0200 | [diff] [blame] | 166 | struct ctrl_cmd_def *cd, *cd2; |
| 167 | |
Harald Welte | 6d96dd7 | 2013-03-16 10:13:04 +0100 | [diff] [blame] | 168 | osmo_wqueue_clear(&ccon->write_queue); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 169 | close(ccon->write_queue.bfd.fd); |
| 170 | osmo_fd_unregister(&ccon->write_queue.bfd); |
Daniel Willmann | 0e0cf37 | 2011-05-06 16:37:25 +0200 | [diff] [blame] | 171 | llist_del(&ccon->list_entry); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 172 | if (ccon->closed_cb) |
| 173 | ccon->closed_cb(ccon); |
Jacob Erlbeck | 141de62 | 2014-03-31 13:42:11 +0200 | [diff] [blame] | 174 | msgb_free(ccon->pending_msg); |
Harald Welte | 39c9e7b | 2014-08-22 00:28:51 +0200 | [diff] [blame] | 175 | |
| 176 | /* clean up deferred commands */ |
| 177 | llist_for_each_entry_safe(cd, cd2, &ccon->def_cmds, list) { |
| 178 | /* delete from list of def_cmds for this ccon */ |
| 179 | llist_del(&cd->list); |
| 180 | /* not strictly needed as this is a slave to the ccon which we |
| 181 | * are about to free anyway */ |
| 182 | talloc_free(cd->cmd); |
| 183 | /* set the CMD to null, this is the indication to the user that |
| 184 | * the connection for this command has gone */ |
| 185 | cd->cmd = NULL; |
| 186 | } |
| 187 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 188 | talloc_free(ccon); |
| 189 | } |
| 190 | |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 191 | int ctrl_cmd_handle(struct ctrl_handle *ctrl, struct ctrl_cmd *cmd, |
| 192 | void *data) |
| 193 | { |
| 194 | char *request; |
| 195 | int i, j, ret, node; |
Max | 33c7ba6 | 2017-05-02 16:24:12 +0200 | [diff] [blame] | 196 | bool break_cycle = false; |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 197 | vector vline, cmdvec, cmds_vec; |
| 198 | |
Max | 2ed3659 | 2017-02-24 14:48:45 +0100 | [diff] [blame] | 199 | if (cmd->type == CTRL_TYPE_SET_REPLY || |
| 200 | cmd->type == CTRL_TYPE_GET_REPLY) { |
| 201 | if (strncmp(cmd->reply, "OK", 2) == 0) { |
| 202 | LOGP(DLCTRL, LOGL_DEBUG, "%s <%s> for %s is OK\n", |
| 203 | get_value_string(ctrl_type_vals, cmd->type), |
| 204 | cmd->id, cmd->variable); |
| 205 | return CTRL_CMD_HANDLED; |
| 206 | } |
| 207 | } |
| 208 | |
| 209 | if (cmd->type == CTRL_TYPE_ERROR) { |
| 210 | LOGP(DLCTRL, LOGL_ERROR, "%s <%s> for %s is %s\n", |
| 211 | get_value_string(ctrl_type_vals, cmd->type), |
| 212 | cmd->id, cmd->variable, cmd->reply); |
| 213 | return CTRL_CMD_HANDLED; |
| 214 | } |
| 215 | |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 216 | ret = CTRL_CMD_ERROR; |
| 217 | cmd->reply = NULL; |
| 218 | node = CTRL_NODE_ROOT; |
| 219 | cmd->node = data; |
| 220 | |
| 221 | request = talloc_strdup(cmd, cmd->variable); |
| 222 | if (!request) |
| 223 | goto err; |
| 224 | |
| 225 | for (i=0;i<strlen(request);i++) { |
| 226 | if (request[i] == '.') |
| 227 | request[i] = ' '; |
| 228 | } |
| 229 | |
| 230 | vline = cmd_make_strvec(request); |
| 231 | talloc_free(request); |
| 232 | if (!vline) { |
| 233 | cmd->reply = "cmd_make_strvec failed."; |
| 234 | goto err; |
| 235 | } |
| 236 | |
| 237 | for (i=0;i<vector_active(vline);i++) { |
Harald Welte | d6b1f85 | 2017-04-16 16:57:40 +0200 | [diff] [blame] | 238 | struct lookup_helper *lh; |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 239 | int rc; |
| 240 | |
| 241 | if (ctrl->lookup) |
| 242 | rc = ctrl->lookup(data, vline, &node, &cmd->node, &i); |
| 243 | else |
| 244 | rc = 0; |
| 245 | |
Harald Welte | d6b1f85 | 2017-04-16 16:57:40 +0200 | [diff] [blame] | 246 | if (!rc) { |
| 247 | llist_for_each_entry(lh, &ctrl_lookup_helpers, list) { |
| 248 | rc = lh->lookup(data, vline, &node, &cmd->node, &i); |
| 249 | if (rc) |
| 250 | break; |
| 251 | } |
| 252 | } |
| 253 | |
Max | 33c7ba6 | 2017-05-02 16:24:12 +0200 | [diff] [blame] | 254 | switch (rc) { |
| 255 | case 1: /* do nothing */ |
| 256 | break; |
| 257 | case -ENODEV: |
| 258 | cmd_free_strvec(vline); |
| 259 | cmd->type = CTRL_TYPE_ERROR; |
| 260 | cmd->reply = "Error while resolving object"; |
| 261 | return ret; |
| 262 | case -ERANGE: |
| 263 | cmd_free_strvec(vline); |
| 264 | cmd->type = CTRL_TYPE_ERROR; |
| 265 | cmd->reply = "Error while parsing the index."; |
| 266 | return ret; |
| 267 | default: /* If we're here the rest must be the command */ |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 268 | cmdvec = vector_init(vector_active(vline)-i); |
| 269 | for (j=i; j<vector_active(vline); j++) { |
| 270 | vector_set(cmdvec, vector_slot(vline, j)); |
| 271 | } |
| 272 | |
| 273 | /* Get the command vector of the right node */ |
| 274 | cmds_vec = vector_lookup(ctrl_node_vec, node); |
| 275 | |
| 276 | if (!cmds_vec) { |
| 277 | cmd->reply = "Command not found."; |
| 278 | vector_free(cmdvec); |
| 279 | break; |
| 280 | } |
| 281 | |
| 282 | ret = ctrl_cmd_exec(cmdvec, cmd, cmds_vec, data); |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 283 | vector_free(cmdvec); |
Max | 33c7ba6 | 2017-05-02 16:24:12 +0200 | [diff] [blame] | 284 | break_cycle = true; |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 285 | break; |
| 286 | } |
| 287 | |
Max | 33c7ba6 | 2017-05-02 16:24:12 +0200 | [diff] [blame] | 288 | if (break_cycle) |
| 289 | break; |
| 290 | |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 291 | if (i+1 == vector_active(vline)) |
| 292 | cmd->reply = "Command not present."; |
| 293 | } |
| 294 | |
| 295 | cmd_free_strvec(vline); |
| 296 | |
| 297 | err: |
| 298 | if (!cmd->reply) { |
| 299 | if (ret == CTRL_CMD_ERROR) { |
Thorsten Alteholz | a81055d | 2017-03-02 22:13:48 +0100 | [diff] [blame] | 300 | cmd->reply = "An error has occurred."; |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 301 | LOGP(DLCTRL, LOGL_NOTICE, |
| 302 | "%s: cmd->reply has not been set (ERROR).\n", |
| 303 | cmd->variable); |
| 304 | } else if (ret == CTRL_CMD_REPLY) { |
| 305 | LOGP(DLCTRL, LOGL_NOTICE, |
| 306 | "%s: cmd->reply has not been set (type = %d).\n", |
| 307 | cmd->variable, cmd->type); |
| 308 | cmd->reply = ""; |
| 309 | } else { |
| 310 | cmd->reply = "Command has been handled."; |
| 311 | } |
| 312 | } |
| 313 | |
| 314 | if (ret == CTRL_CMD_ERROR) |
| 315 | cmd->type = CTRL_TYPE_ERROR; |
| 316 | return ret; |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 317 | } |
| 318 | |
| 319 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 320 | static int handle_control_read(struct osmo_fd * bfd) |
| 321 | { |
Pablo Neira Ayuso | 10dfc26 | 2011-08-17 22:44:07 +0200 | [diff] [blame] | 322 | int ret = -1; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 323 | struct osmo_wqueue *queue; |
| 324 | struct ctrl_connection *ccon; |
| 325 | struct ipaccess_head *iph; |
| 326 | struct ipaccess_head_ext *iph_ext; |
Alexander Huemer | 1d3634e | 2011-10-12 00:29:30 +0200 | [diff] [blame] | 327 | struct msgb *msg = NULL; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 328 | struct ctrl_cmd *cmd; |
| 329 | struct ctrl_handle *ctrl = bfd->data; |
| 330 | |
| 331 | queue = container_of(bfd, struct osmo_wqueue, bfd); |
| 332 | ccon = container_of(queue, struct ctrl_connection, write_queue); |
| 333 | |
Jacob Erlbeck | 141de62 | 2014-03-31 13:42:11 +0200 | [diff] [blame] | 334 | ret = ipa_msg_recv_buffered(bfd->fd, &msg, &ccon->pending_msg); |
Pablo Neira Ayuso | 10dfc26 | 2011-08-17 22:44:07 +0200 | [diff] [blame] | 335 | if (ret <= 0) { |
Jacob Erlbeck | 141de62 | 2014-03-31 13:42:11 +0200 | [diff] [blame] | 336 | if (ret == -EAGAIN) |
| 337 | return 0; |
Pablo Neira Ayuso | 10dfc26 | 2011-08-17 22:44:07 +0200 | [diff] [blame] | 338 | if (ret == 0) |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 339 | LOGP(DLCTRL, LOGL_INFO, "The control connection was closed\n"); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 340 | else |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 341 | LOGP(DLCTRL, LOGL_ERROR, "Failed to parse ip access message: %d\n", ret); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 342 | |
| 343 | goto err; |
| 344 | } |
| 345 | |
| 346 | if (msg->len < sizeof(*iph) + sizeof(*iph_ext)) { |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 347 | LOGP(DLCTRL, LOGL_ERROR, "The message is too short.\n"); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 348 | goto err; |
| 349 | } |
| 350 | |
| 351 | iph = (struct ipaccess_head *) msg->data; |
| 352 | if (iph->proto != IPAC_PROTO_OSMO) { |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 353 | LOGP(DLCTRL, LOGL_ERROR, "Protocol mismatch. We got 0x%x\n", iph->proto); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 354 | goto err; |
| 355 | } |
| 356 | |
| 357 | iph_ext = (struct ipaccess_head_ext *) iph->data; |
| 358 | if (iph_ext->proto != IPAC_PROTO_EXT_CTRL) { |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 359 | LOGP(DLCTRL, LOGL_ERROR, "Extended protocol mismatch. We got 0x%x\n", iph_ext->proto); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 360 | goto err; |
| 361 | } |
| 362 | |
| 363 | msg->l2h = iph_ext->data; |
| 364 | |
| 365 | cmd = ctrl_cmd_parse(ccon, msg); |
| 366 | |
| 367 | if (cmd) { |
| 368 | cmd->ccon = ccon; |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 369 | if (ctrl_cmd_handle(ctrl, cmd, ctrl->data) != CTRL_CMD_HANDLED) { |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 370 | ctrl_cmd_send(queue, cmd); |
| 371 | talloc_free(cmd); |
| 372 | } |
| 373 | } else { |
| 374 | cmd = talloc_zero(ccon, struct ctrl_cmd); |
| 375 | if (!cmd) |
| 376 | goto err; |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 377 | LOGP(DLCTRL, LOGL_ERROR, "Command parser error.\n"); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 378 | cmd->type = CTRL_TYPE_ERROR; |
| 379 | cmd->id = "err"; |
| 380 | cmd->reply = "Command parser error."; |
| 381 | ctrl_cmd_send(queue, cmd); |
| 382 | talloc_free(cmd); |
| 383 | } |
| 384 | |
| 385 | msgb_free(msg); |
| 386 | return 0; |
| 387 | |
| 388 | err: |
| 389 | control_close_conn(ccon); |
| 390 | msgb_free(msg); |
| 391 | return ret; |
| 392 | } |
| 393 | |
| 394 | static int control_write_cb(struct osmo_fd *bfd, struct msgb *msg) |
| 395 | { |
| 396 | int rc; |
| 397 | |
| 398 | rc = write(bfd->fd, msg->data, msg->len); |
| 399 | if (rc != msg->len) |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 400 | LOGP(DLCTRL, LOGL_ERROR, "Failed to write message to the control connection.\n"); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 401 | |
| 402 | return rc; |
| 403 | } |
| 404 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 405 | /*! Allocate CTRL connection |
Max | fa9e05e | 2017-02-20 11:53:11 +0100 | [diff] [blame] | 406 | * \param[in] ctx Context from which talloc should allocate it |
| 407 | * \param[in] data caller's private data parameter which should assigned to |
| 408 | write queue's file descriptor data parameter. |
| 409 | * \return Allocated CTRL connection structure or NULL in case of errors |
| 410 | */ |
| 411 | struct ctrl_connection *osmo_ctrl_conn_alloc(void *ctx, void *data) |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 412 | { |
| 413 | struct ctrl_connection *ccon = talloc_zero(ctx, struct ctrl_connection); |
| 414 | if (!ccon) |
| 415 | return NULL; |
| 416 | |
| 417 | osmo_wqueue_init(&ccon->write_queue, 100); |
| 418 | /* Error handling here? */ |
| 419 | |
| 420 | INIT_LLIST_HEAD(&ccon->cmds); |
Harald Welte | 39c9e7b | 2014-08-22 00:28:51 +0200 | [diff] [blame] | 421 | INIT_LLIST_HEAD(&ccon->def_cmds); |
| 422 | |
Max | fa9e05e | 2017-02-20 11:53:11 +0100 | [diff] [blame] | 423 | ccon->write_queue.bfd.data = data; |
| 424 | ccon->write_queue.write_cb = control_write_cb; |
Max | 9756c46 | 2017-02-24 13:03:32 +0100 | [diff] [blame] | 425 | ccon->write_queue.read_cb = handle_control_read; |
Max | fa9e05e | 2017-02-20 11:53:11 +0100 | [diff] [blame] | 426 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 427 | return ccon; |
| 428 | } |
| 429 | |
| 430 | static int listen_fd_cb(struct osmo_fd *listen_bfd, unsigned int what) |
| 431 | { |
| 432 | int ret, fd, on; |
Daniel Willmann | 0e0cf37 | 2011-05-06 16:37:25 +0200 | [diff] [blame] | 433 | struct ctrl_handle *ctrl; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 434 | struct ctrl_connection *ccon; |
| 435 | struct sockaddr_in sa; |
| 436 | socklen_t sa_len = sizeof(sa); |
| 437 | |
| 438 | |
| 439 | if (!(what & BSC_FD_READ)) |
| 440 | return 0; |
| 441 | |
| 442 | fd = accept(listen_bfd->fd, (struct sockaddr *) &sa, &sa_len); |
| 443 | if (fd < 0) { |
| 444 | perror("accept"); |
| 445 | return fd; |
| 446 | } |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 447 | LOGP(DLCTRL, LOGL_INFO, "accept()ed new control connection from %s\n", |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 448 | inet_ntoa(sa.sin_addr)); |
| 449 | |
Harald Welte | e15ac06 | 2014-12-04 14:15:36 +0100 | [diff] [blame] | 450 | #ifdef TCP_NODELAY |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 451 | on = 1; |
| 452 | ret = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof(on)); |
| 453 | if (ret != 0) { |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 454 | LOGP(DLCTRL, LOGL_ERROR, "Failed to set TCP_NODELAY: %s\n", strerror(errno)); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 455 | close(fd); |
| 456 | return ret; |
| 457 | } |
Harald Welte | e15ac06 | 2014-12-04 14:15:36 +0100 | [diff] [blame] | 458 | #endif |
Max | fa9e05e | 2017-02-20 11:53:11 +0100 | [diff] [blame] | 459 | ctrl = listen_bfd->data; |
| 460 | ccon = osmo_ctrl_conn_alloc(listen_bfd->data, ctrl); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 461 | if (!ccon) { |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 462 | LOGP(DLCTRL, LOGL_ERROR, "Failed to allocate.\n"); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 463 | close(fd); |
| 464 | return -1; |
| 465 | } |
| 466 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 467 | ccon->write_queue.bfd.fd = fd; |
| 468 | ccon->write_queue.bfd.when = BSC_FD_READ; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 469 | |
| 470 | ret = osmo_fd_register(&ccon->write_queue.bfd); |
| 471 | if (ret < 0) { |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 472 | LOGP(DLCTRL, LOGL_ERROR, "Could not register FD.\n"); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 473 | close(ccon->write_queue.bfd.fd); |
| 474 | talloc_free(ccon); |
| 475 | } |
| 476 | |
Daniel Willmann | 0e0cf37 | 2011-05-06 16:37:25 +0200 | [diff] [blame] | 477 | llist_add(&ccon->list_entry, &ctrl->ccon_list); |
| 478 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 479 | return ret; |
| 480 | } |
| 481 | |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 482 | static uint64_t get_rate_ctr_value(const struct rate_ctr *ctr, int intv) |
| 483 | { |
| 484 | if (intv >= RATE_CTR_INTV_NUM) |
| 485 | return 0; |
| 486 | |
| 487 | /* Absolute value */ |
| 488 | if (intv == -1) { |
| 489 | return ctr->current; |
| 490 | } else { |
| 491 | return ctr->intv[intv].rate; |
| 492 | } |
| 493 | } |
| 494 | |
Harald Welte | c9df37d | 2014-08-20 19:55:17 +0200 | [diff] [blame] | 495 | static char *get_all_rate_ctr_in_group(void *ctx, const struct rate_ctr_group *ctrg, int intv) |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 496 | { |
| 497 | int i; |
Harald Welte | c9df37d | 2014-08-20 19:55:17 +0200 | [diff] [blame] | 498 | char *counters = talloc_strdup(ctx, ""); |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 499 | if (!counters) |
| 500 | return NULL; |
| 501 | |
| 502 | for (i=0;i<ctrg->desc->num_ctr;i++) { |
Daniel Willmann | 0834a34 | 2011-07-19 12:12:10 +0200 | [diff] [blame] | 503 | counters = talloc_asprintf_append(counters, "\n%s.%u.%s %"PRIu64, |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 504 | ctrg->desc->group_name_prefix, ctrg->idx, |
| 505 | ctrg->desc->ctr_desc[i].name, |
| 506 | get_rate_ctr_value(&ctrg->ctr[i], intv)); |
| 507 | if (!counters) |
| 508 | return NULL; |
| 509 | } |
| 510 | return counters; |
| 511 | } |
| 512 | |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 513 | static int get_rate_ctr_group_idx(const struct rate_ctr_group *ctrg, int intv, struct ctrl_cmd *cmd) |
| 514 | { |
| 515 | char *counters; |
| 516 | |
Harald Welte | c9df37d | 2014-08-20 19:55:17 +0200 | [diff] [blame] | 517 | counters = get_all_rate_ctr_in_group(cmd, ctrg, intv); |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 518 | if (!counters) |
| 519 | goto oom; |
| 520 | |
| 521 | cmd->reply = talloc_asprintf(cmd, "All counters in %s.%u%s", |
| 522 | ctrg->desc->group_name_prefix, ctrg->idx, counters); |
| 523 | talloc_free(counters); |
| 524 | if (!cmd->reply) |
| 525 | goto oom; |
| 526 | |
| 527 | return CTRL_CMD_REPLY; |
| 528 | oom: |
| 529 | cmd->reply = "OOM."; |
| 530 | return CTRL_CMD_ERROR; |
| 531 | } |
| 532 | |
| 533 | /* rate_ctr */ |
| 534 | CTRL_CMD_DEFINE(rate_ctr, "rate_ctr *"); |
Daniel Willmann | f7c74e5 | 2011-08-05 11:48:18 +0200 | [diff] [blame] | 535 | static int get_rate_ctr(struct ctrl_cmd *cmd, void *data) |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 536 | { |
| 537 | int intv; |
| 538 | unsigned int idx; |
Neels Hofmeyr | 5b34f77 | 2016-09-19 14:15:03 +0200 | [diff] [blame] | 539 | char *ctr_group, *ctr_idx, *tmp, *dup, *saveptr, *interval; |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 540 | struct rate_ctr_group *ctrg; |
| 541 | const struct rate_ctr *ctr; |
| 542 | |
| 543 | dup = talloc_strdup(cmd, cmd->variable); |
| 544 | if (!dup) |
| 545 | goto oom; |
| 546 | |
| 547 | /* Skip over possible prefixes (net.) */ |
| 548 | tmp = strstr(dup, "rate_ctr"); |
| 549 | if (!tmp) { |
| 550 | talloc_free(dup); |
| 551 | cmd->reply = "rate_ctr not a token in rate_ctr command!"; |
| 552 | goto err; |
| 553 | } |
| 554 | |
| 555 | strtok_r(tmp, ".", &saveptr); |
| 556 | interval = strtok_r(NULL, ".", &saveptr); |
| 557 | if (!interval) { |
| 558 | talloc_free(dup); |
| 559 | cmd->reply = "Missing interval."; |
| 560 | goto err; |
| 561 | } |
| 562 | |
| 563 | if (!strcmp(interval, "abs")) { |
| 564 | intv = -1; |
| 565 | } else if (!strcmp(interval, "per_sec")) { |
| 566 | intv = RATE_CTR_INTV_SEC; |
| 567 | } else if (!strcmp(interval, "per_min")) { |
| 568 | intv = RATE_CTR_INTV_MIN; |
| 569 | } else if (!strcmp(interval, "per_hour")) { |
| 570 | intv = RATE_CTR_INTV_HOUR; |
| 571 | } else if (!strcmp(interval, "per_day")) { |
| 572 | intv = RATE_CTR_INTV_DAY; |
| 573 | } else { |
| 574 | talloc_free(dup); |
| 575 | cmd->reply = "Wrong interval."; |
| 576 | goto err; |
| 577 | } |
| 578 | |
| 579 | ctr_group = strtok_r(NULL, ".", &saveptr); |
Max | 22886d9 | 2016-06-14 18:17:06 +0200 | [diff] [blame] | 580 | ctr_idx = strtok_r(NULL, ".", &saveptr); |
| 581 | if (!ctr_group || !ctr_idx) { |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 582 | talloc_free(dup); |
Max | 22886d9 | 2016-06-14 18:17:06 +0200 | [diff] [blame] | 583 | cmd->reply = "Counter group must be of name.index form e. g. " |
| 584 | "e1inp.0"; |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 585 | goto err; |
| 586 | } |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 587 | |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 588 | idx = atoi(ctr_idx); |
| 589 | |
| 590 | ctrg = rate_ctr_get_group_by_name_idx(ctr_group, idx); |
| 591 | if (!ctrg) { |
| 592 | talloc_free(dup); |
Max | 22886d9 | 2016-06-14 18:17:06 +0200 | [diff] [blame] | 593 | cmd->reply = "Counter group with given name and index not found"; |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 594 | goto err; |
| 595 | } |
| 596 | |
Max | 22886d9 | 2016-06-14 18:17:06 +0200 | [diff] [blame] | 597 | if (!strlen(saveptr)) { |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 598 | talloc_free(dup); |
| 599 | return get_rate_ctr_group_idx(ctrg, intv, cmd); |
| 600 | } |
| 601 | |
Max | 22886d9 | 2016-06-14 18:17:06 +0200 | [diff] [blame] | 602 | ctr = rate_ctr_get_by_name(ctrg, saveptr); |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 603 | if (!ctr) { |
| 604 | cmd->reply = "Counter name not found."; |
| 605 | talloc_free(dup); |
| 606 | goto err; |
| 607 | } |
| 608 | |
| 609 | talloc_free(dup); |
| 610 | |
Holger Hans Peter Freyther | ad6451f | 2012-03-16 12:18:39 +0100 | [diff] [blame] | 611 | cmd->reply = talloc_asprintf(cmd, "%"PRIu64, get_rate_ctr_value(ctr, intv)); |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 612 | if (!cmd->reply) |
| 613 | goto oom; |
| 614 | |
| 615 | return CTRL_CMD_REPLY; |
| 616 | oom: |
| 617 | cmd->reply = "OOM"; |
| 618 | err: |
| 619 | return CTRL_CMD_ERROR; |
| 620 | } |
| 621 | |
Daniel Willmann | f7c74e5 | 2011-08-05 11:48:18 +0200 | [diff] [blame] | 622 | static int set_rate_ctr(struct ctrl_cmd *cmd, void *data) |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 623 | { |
| 624 | cmd->reply = "Can't set rate counter."; |
| 625 | |
| 626 | return CTRL_CMD_ERROR; |
| 627 | } |
| 628 | |
Daniel Willmann | f7c74e5 | 2011-08-05 11:48:18 +0200 | [diff] [blame] | 629 | static int verify_rate_ctr(struct ctrl_cmd *cmd, const char *value, void *data) |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 630 | { |
| 631 | return 0; |
| 632 | } |
| 633 | |
| 634 | /* counter */ |
| 635 | CTRL_CMD_DEFINE(counter, "counter *"); |
Daniel Willmann | f7c74e5 | 2011-08-05 11:48:18 +0200 | [diff] [blame] | 636 | static int get_counter(struct ctrl_cmd *cmd, void *data) |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 637 | { |
| 638 | char *ctr_name, *tmp, *dup, *saveptr; |
| 639 | struct osmo_counter *counter; |
| 640 | |
| 641 | cmd->reply = "OOM"; |
| 642 | dup = talloc_strdup(cmd, cmd->variable); |
| 643 | if (!dup) |
| 644 | goto err; |
| 645 | |
| 646 | |
| 647 | tmp = strstr(dup, "counter"); |
| 648 | if (!tmp) { |
| 649 | talloc_free(dup); |
| 650 | goto err; |
| 651 | } |
| 652 | |
| 653 | strtok_r(tmp, ".", &saveptr); |
| 654 | ctr_name = strtok_r(NULL, "\0", &saveptr); |
| 655 | |
| 656 | if (!ctr_name) |
| 657 | goto err; |
| 658 | |
| 659 | counter = osmo_counter_get_by_name(ctr_name); |
| 660 | if (!counter) { |
| 661 | cmd->reply = "Counter name not found."; |
| 662 | talloc_free(dup); |
| 663 | goto err; |
| 664 | } |
| 665 | |
| 666 | talloc_free(dup); |
| 667 | |
| 668 | cmd->reply = talloc_asprintf(cmd, "%lu", counter->value); |
| 669 | if (!cmd->reply) { |
| 670 | cmd->reply = "OOM"; |
| 671 | goto err; |
| 672 | } |
| 673 | |
| 674 | return CTRL_CMD_REPLY; |
| 675 | err: |
| 676 | return CTRL_CMD_ERROR; |
| 677 | } |
| 678 | |
Daniel Willmann | f7c74e5 | 2011-08-05 11:48:18 +0200 | [diff] [blame] | 679 | static int set_counter(struct ctrl_cmd *cmd, void *data) |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 680 | { |
| 681 | |
| 682 | cmd->reply = "Can't set counter."; |
| 683 | |
| 684 | return CTRL_CMD_ERROR; |
| 685 | } |
| 686 | |
Daniel Willmann | f7c74e5 | 2011-08-05 11:48:18 +0200 | [diff] [blame] | 687 | static int verify_counter(struct ctrl_cmd *cmd, const char *value, void *data) |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 688 | { |
| 689 | return 0; |
| 690 | } |
| 691 | |
Harald Welte | ae2fcb2 | 2014-08-21 15:20:00 +0200 | [diff] [blame] | 692 | struct ctrl_handle *ctrl_interface_setup(void *data, uint16_t port, |
| 693 | ctrl_cmd_lookup lookup) |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 694 | { |
Neels Hofmeyr | 4934309 | 2016-02-24 00:09:40 +0100 | [diff] [blame] | 695 | return ctrl_interface_setup_dynip(data, "127.0.0.1", port, lookup); |
| 696 | } |
| 697 | |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 698 | static int ctrl_initialized = 0; |
| 699 | |
| 700 | /* global ctrl initialization */ |
| 701 | static int ctrl_init(void) |
| 702 | { |
| 703 | int ret; |
| 704 | |
| 705 | if (ctrl_initialized) |
| 706 | return 0; |
| 707 | |
Harald Welte | 0b2f715 | 2017-04-16 19:49:24 +0200 | [diff] [blame] | 708 | ctrl_node_vec = vector_init(_LAST_CTRL_NODE); |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 709 | if (!ctrl_node_vec) |
| 710 | goto err; |
| 711 | |
| 712 | ret = ctrl_cmd_install(CTRL_NODE_ROOT, &cmd_rate_ctr); |
| 713 | if (ret) |
| 714 | goto err_vec; |
| 715 | ret = ctrl_cmd_install(CTRL_NODE_ROOT, &cmd_counter); |
| 716 | if (ret) |
| 717 | goto err_vec; |
| 718 | |
Harald Welte | 31c0fef | 2017-04-16 17:26:30 +0200 | [diff] [blame] | 719 | ret = osmo_fsm_ctrl_cmds_install(); |
| 720 | if (ret) |
| 721 | goto err_vec; |
| 722 | |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 723 | ctrl_initialized = 1; |
| 724 | return 0; |
| 725 | |
| 726 | err_vec: |
| 727 | vector_free(ctrl_node_vec); |
| 728 | ctrl_node_vec = NULL; |
| 729 | err: |
| 730 | return -1; |
| 731 | } |
| 732 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 733 | /*! Allocate a CTRL interface handle |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 734 | * \param[in] ctx Tallo callocation context to be used |
| 735 | * \param[in] data Pointer which will be made available to each |
| 736 | set_..() get_..() verify_..() control command function |
| 737 | * \param[in] lookup Lookup function pointer, can be NULL |
| 738 | * \returns ctrl_handle pointer or NULL in case of errors |
| 739 | */ |
| 740 | struct ctrl_handle *ctrl_handle_alloc(void *ctx, void *data, ctrl_cmd_lookup lookup) |
| 741 | { |
| 742 | struct ctrl_handle *ctrl; |
| 743 | |
| 744 | ctrl_init(); |
| 745 | |
| 746 | ctrl = talloc_zero(ctx, struct ctrl_handle); |
| 747 | if (!ctrl) |
| 748 | return NULL; |
| 749 | |
| 750 | INIT_LLIST_HEAD(&ctrl->ccon_list); |
| 751 | |
| 752 | ctrl->data = data; |
| 753 | ctrl->lookup = lookup; |
| 754 | |
| 755 | return ctrl; |
| 756 | } |
| 757 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 758 | /*! Setup CTRL interface on a given address |
Max | 32ee5af | 2017-02-16 17:44:09 +0100 | [diff] [blame] | 759 | * \param[in] data Pointer which will be made available to each |
| 760 | set_..() get_..() verify_..() control command function |
| 761 | * \param[in] bind_addr Address on which CTRL socket shall listen |
| 762 | * \param[in] port Port on which CTRL socket shall listen |
| 763 | * \param[in] lookup Lookup function pointer, can be NULL |
| 764 | * \returns ctrl_handle pointer or NULL in case of errors |
| 765 | */ |
Neels Hofmeyr | 4934309 | 2016-02-24 00:09:40 +0100 | [diff] [blame] | 766 | struct ctrl_handle *ctrl_interface_setup_dynip(void *data, |
| 767 | const char *bind_addr, |
| 768 | uint16_t port, |
| 769 | ctrl_cmd_lookup lookup) |
| 770 | { |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 771 | int ret; |
| 772 | struct ctrl_handle *ctrl; |
| 773 | |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 774 | ctrl = ctrl_handle_alloc(data, data, lookup); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 775 | if (!ctrl) |
Daniel Willmann | 782974b | 2011-07-22 17:55:42 +0200 | [diff] [blame] | 776 | return NULL; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 777 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 778 | /* Listen for control connections */ |
Harald Welte | 1238cc6 | 2014-08-20 19:50:04 +0200 | [diff] [blame] | 779 | ctrl->listen_fd.cb = listen_fd_cb; |
| 780 | ctrl->listen_fd.data = ctrl; |
| 781 | ret = osmo_sock_init_ofd(&ctrl->listen_fd, AF_INET, SOCK_STREAM, IPPROTO_TCP, |
Neels Hofmeyr | 4934309 | 2016-02-24 00:09:40 +0100 | [diff] [blame] | 782 | bind_addr, port, OSMO_SOCK_F_BIND); |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 783 | if (ret < 0) { |
| 784 | talloc_free(ctrl); |
| 785 | return NULL; |
| 786 | } |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 787 | |
Neels Hofmeyr | 38d232e | 2016-09-19 14:17:30 +0200 | [diff] [blame] | 788 | LOGP(DLCTRL, LOGL_NOTICE, "CTRL at %s %u\n", bind_addr, port); |
Daniel Willmann | 782974b | 2011-07-22 17:55:42 +0200 | [diff] [blame] | 789 | return ctrl; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 790 | } |
Harald Welte | d6b1f85 | 2017-04-16 16:57:40 +0200 | [diff] [blame] | 791 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 792 | /*! Install a lookup helper function for control nodes |
Harald Welte | d6b1f85 | 2017-04-16 16:57:40 +0200 | [diff] [blame] | 793 | * This function is used by e.g. library code to install lookup helpers |
| 794 | * for additional nodes in the control interface. |
| 795 | * \param[in] lookup The lookup helper function |
| 796 | * \retuns - on success; negative on error. |
| 797 | */ |
| 798 | int ctrl_lookup_register(ctrl_cmd_lookup lookup) |
| 799 | { |
| 800 | struct lookup_helper *lh; |
| 801 | |
| 802 | /* avoid double registration */ |
| 803 | llist_for_each_entry(lh, &ctrl_lookup_helpers, list) { |
| 804 | if (lh->lookup == lookup) |
| 805 | return -EEXIST; |
| 806 | } |
| 807 | |
| 808 | lh = talloc_zero(NULL, struct lookup_helper); |
| 809 | if (!lh) |
| 810 | return -ENOMEM; |
| 811 | |
| 812 | lh->lookup = lookup; |
| 813 | llist_add_tail(&lh->list, &ctrl_lookup_helpers); |
| 814 | return 0; |
| 815 | } |
Harald Welte | f85861d | 2017-04-16 19:17:10 +0200 | [diff] [blame] | 816 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 817 | /*! Helper for "local execution" of a CTRL command from a string |
Harald Welte | f85861d | 2017-04-16 19:17:10 +0200 | [diff] [blame] | 818 | * The function will parse + execute the given control command string |
| 819 | * and return a corresponding ctrl_cmd. Caller is responsible to |
| 820 | * talloc_free() the return value. |
| 821 | * \param[in] Control Interface Command String |
| 822 | * \returns parsed command, including reply; NULL on error */ |
| 823 | struct ctrl_cmd *ctrl_cmd_exec_from_string(struct ctrl_handle *ch, const char *cmdstr) |
| 824 | { |
| 825 | struct msgb *msg = msgb_alloc(1024, "ctrl-cmd"); |
| 826 | struct ctrl_cmd *cmd; |
| 827 | |
| 828 | if (!msg) |
| 829 | return NULL; |
| 830 | msg->l2h = msg->data; |
| 831 | osmo_strlcpy((char *)msg->data, cmdstr, msgb_tailroom(msg)); |
| 832 | msgb_put(msg, strlen(cmdstr)); |
| 833 | |
| 834 | cmd = ctrl_cmd_parse(ch, msg); |
| 835 | msgb_free(msg); |
| 836 | if (!cmd) |
| 837 | return NULL; |
| 838 | if (ctrl_cmd_handle(ch, cmd, NULL) < 0) { |
| 839 | talloc_free(cmd); |
| 840 | return NULL; |
| 841 | } |
| 842 | return cmd; |
| 843 | } |