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