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 | * |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 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> |
Neels Hofmeyr | a16b50c | 2021-09-12 21:25:28 +0200 | [diff] [blame] | 34 | #include <limits.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 35 | |
| 36 | #include <arpa/inet.h> |
| 37 | |
Holger Hans Peter Freyther | 5e21131 | 2014-08-21 16:31:52 +0200 | [diff] [blame] | 38 | #include <netinet/in.h> |
Harald Welte | e15ac06 | 2014-12-04 14:15:36 +0100 | [diff] [blame] | 39 | #ifdef HAVE_NETINET_TCP_H |
| 40 | #include <netinet/tcp.h> |
| 41 | #endif |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 42 | |
Harald Welte | e15ac06 | 2014-12-04 14:15:36 +0100 | [diff] [blame] | 43 | #include <fcntl.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 44 | #include <sys/ioctl.h> |
| 45 | #include <sys/socket.h> |
| 46 | #include <sys/types.h> |
| 47 | |
Harald Welte | 1238cc6 | 2014-08-20 19:50:04 +0200 | [diff] [blame] | 48 | #include <osmocom/ctrl/control_cmd.h> |
| 49 | #include <osmocom/ctrl/control_if.h> |
Max | 3f79ce8 | 2022-12-03 17:59:19 +0300 | [diff] [blame] | 50 | #include <osmocom/ctrl/control_vty.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 51 | |
| 52 | #include <osmocom/core/msgb.h> |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 53 | #include <osmocom/core/rate_ctr.h> |
Neels Hofmeyr | a16b50c | 2021-09-12 21:25:28 +0200 | [diff] [blame] | 54 | #include <osmocom/core/stat_item.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 55 | #include <osmocom/core/select.h> |
Harald Welte | 216338c | 2017-10-15 19:46:19 +0200 | [diff] [blame] | 56 | #include <osmocom/core/counter.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 57 | #include <osmocom/core/talloc.h> |
Harald Welte | 1238cc6 | 2014-08-20 19:50:04 +0200 | [diff] [blame] | 58 | #include <osmocom/core/socket.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 59 | |
Harald Welte | 1238cc6 | 2014-08-20 19:50:04 +0200 | [diff] [blame] | 60 | #include <osmocom/gsm/protocol/ipaccess.h> |
Harald Welte | acbb4c9 | 2014-08-20 22:51:25 +0200 | [diff] [blame] | 61 | #include <osmocom/gsm/ipa.h> |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 62 | |
| 63 | #include <osmocom/vty/command.h> |
| 64 | #include <osmocom/vty/vector.h> |
| 65 | |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 66 | extern int osmo_fsm_ctrl_cmds_install(void); |
| 67 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 68 | vector ctrl_node_vec; |
| 69 | |
Harald Welte | d6b1f85 | 2017-04-16 16:57:40 +0200 | [diff] [blame] | 70 | /* global list of control interface lookup helpers */ |
| 71 | struct lookup_helper { |
| 72 | struct llist_head list; |
| 73 | ctrl_cmd_lookup lookup; |
| 74 | }; |
| 75 | static LLIST_HEAD(ctrl_lookup_helpers); |
| 76 | |
Harald Welte | b418682 | 2018-05-26 17:25:11 +0200 | [diff] [blame] | 77 | /*! Parse ascii-encoded decimal number at vline[i] |
| 78 | * \param[in] vline vector containing a tokenized line |
| 79 | * \param[in] i index into the vector \a vline |
| 80 | * \param[out] num parsed decimal integer number at vline[i] |
| 81 | * \returns 1 on success; 0 in case of error */ |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 82 | int ctrl_parse_get_num(vector vline, int i, long *num) |
| 83 | { |
Neels Hofmeyr | 34907fe | 2021-09-05 19:50:34 +0200 | [diff] [blame] | 84 | char *token; |
| 85 | int64_t val; |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 86 | |
| 87 | if (i >= vector_active(vline)) |
| 88 | return 0; |
| 89 | token = vector_slot(vline, i); |
| 90 | |
Neels Hofmeyr | 34907fe | 2021-09-05 19:50:34 +0200 | [diff] [blame] | 91 | if (osmo_str_to_int64(&val, token, 10, LONG_MIN, LONG_MAX)) |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 92 | return 0; |
Neels Hofmeyr | 34907fe | 2021-09-05 19:50:34 +0200 | [diff] [blame] | 93 | *num = (long)val; |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 94 | return 1; |
| 95 | } |
| 96 | |
Harald Welte | b418682 | 2018-05-26 17:25:11 +0200 | [diff] [blame] | 97 | /*! Send a CTRL command to all connections. |
| 98 | * \param[in] ctrl global control handle |
Vadim Yanitskiy | 64277a0 | 2023-02-28 03:30:27 +0700 | [diff] [blame] | 99 | * \param[in] cmd command to send to all connections in ctrl |
Harald Welte | b418682 | 2018-05-26 17:25:11 +0200 | [diff] [blame] | 100 | * \returns number of times the command has been sent */ |
Daniel Willmann | 35a1b3b | 2011-05-06 16:38:11 +0200 | [diff] [blame] | 101 | int ctrl_cmd_send_to_all(struct ctrl_handle *ctrl, struct ctrl_cmd *cmd) |
| 102 | { |
| 103 | struct ctrl_connection *ccon; |
| 104 | int ret = 0; |
| 105 | |
| 106 | llist_for_each_entry(ccon, &ctrl->ccon_list, list_entry) { |
| 107 | if (ccon == cmd->ccon) |
| 108 | continue; |
Harald Welte | 319a77e | 2024-03-02 18:48:39 +0100 | [diff] [blame] | 109 | if (ctrl_cmd_send2(ccon, cmd)) |
Daniel Willmann | 35a1b3b | 2011-05-06 16:38:11 +0200 | [diff] [blame] | 110 | ret++; |
| 111 | } |
| 112 | return ret; |
| 113 | } |
| 114 | |
Harald Welte | 319a77e | 2024-03-02 18:48:39 +0100 | [diff] [blame] | 115 | /*! Encode a CTRL command and append it to the given ctrl_connection |
Harald Welte | b418682 | 2018-05-26 17:25:11 +0200 | [diff] [blame] | 116 | * \param[inout] queue write queue to which encoded \a cmd shall be appended |
| 117 | * \param[in] cmd decoded command representation |
| 118 | * \returns 0 in case of success; negative on error */ |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 119 | int ctrl_cmd_send(struct osmo_wqueue *queue, struct ctrl_cmd *cmd) |
| 120 | { |
Harald Welte | 319a77e | 2024-03-02 18:48:39 +0100 | [diff] [blame] | 121 | struct ctrl_connection *ccon = container_of(queue, struct ctrl_connection, write_queue); |
| 122 | return ctrl_cmd_send2(ccon, cmd); |
| 123 | } |
| 124 | |
| 125 | /*! Encode a CTRL command and append it to the given ctrl_connection |
| 126 | * \param[inout] queue write queue to which encoded \a cmd shall be appended |
| 127 | * \param[in] cmd decoded command representation |
| 128 | * \returns 0 in case of success; negative on error */ |
| 129 | int ctrl_cmd_send2(struct ctrl_connection *ccon, struct ctrl_cmd *cmd) |
| 130 | { |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 131 | int ret; |
| 132 | struct msgb *msg; |
| 133 | |
| 134 | msg = ctrl_cmd_make(cmd); |
| 135 | if (!msg) { |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 136 | LOGP(DLCTRL, LOGL_ERROR, "Could not generate msg\n"); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 137 | return -1; |
| 138 | } |
| 139 | |
Harald Welte | acbb4c9 | 2014-08-20 22:51:25 +0200 | [diff] [blame] | 140 | ipa_prepend_header_ext(msg, IPAC_PROTO_EXT_CTRL); |
| 141 | ipa_prepend_header(msg, IPAC_PROTO_OSMO); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 142 | |
Harald Welte | 319a77e | 2024-03-02 18:48:39 +0100 | [diff] [blame] | 143 | ret = osmo_wqueue_enqueue(&ccon->write_queue, msg); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 144 | if (ret != 0) { |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 145 | LOGP(DLCTRL, LOGL_ERROR, "Failed to enqueue the command.\n"); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 146 | msgb_free(msg); |
| 147 | } |
| 148 | return ret; |
| 149 | } |
| 150 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 151 | /*! Send TRAP over given Control Interface |
Max | bc067eb | 2016-08-04 11:07:08 +0200 | [diff] [blame] | 152 | * \param[in] ctrl Control Interface over which TRAP will be sent |
| 153 | * \param[in] name Name of the TRAP variable |
| 154 | * \param[in] value Value of the TRAP variable |
| 155 | * \return Negative value on error, result of ctrl_cmd_send_to_all() otherwise |
| 156 | */ |
| 157 | int ctrl_cmd_send_trap(struct ctrl_handle *ctrl, const char *name, char *value) |
| 158 | { |
| 159 | int r; |
| 160 | struct ctrl_cmd *cmd = ctrl_cmd_create(NULL, CTRL_TYPE_TRAP); |
| 161 | if (!cmd) |
| 162 | return -ENOMEM; |
| 163 | |
Max | 30b2e34 | 2018-11-26 10:38:55 +0100 | [diff] [blame] | 164 | cmd->id = CTRL_CMD_TRAP_ID; /* It's a TRAP! */ |
Harald Welte | f12d40f | 2017-02-08 15:46:53 +0000 | [diff] [blame] | 165 | cmd->variable = (char *) name; |
Max | bc067eb | 2016-08-04 11:07:08 +0200 | [diff] [blame] | 166 | cmd->reply = value; |
| 167 | r = ctrl_cmd_send_to_all(ctrl, cmd); |
| 168 | talloc_free(cmd); |
| 169 | return r; |
| 170 | } |
| 171 | |
Harald Welte | b418682 | 2018-05-26 17:25:11 +0200 | [diff] [blame] | 172 | /*! Copy given \a cmd and convert copy to CTRL_TYPE_TRAP. |
| 173 | * \param[in] cmd command to be copied |
| 174 | * \returns pointer to newly-allocated copy of type TRAP. Allocated as sibling of \a cmd */ |
Daniel Willmann | f2e75d4 | 2011-07-22 18:08:31 +0200 | [diff] [blame] | 175 | struct ctrl_cmd *ctrl_cmd_trap(struct ctrl_cmd *cmd) |
| 176 | { |
| 177 | struct ctrl_cmd *trap; |
| 178 | |
Harald Welte | c9df37d | 2014-08-20 19:55:17 +0200 | [diff] [blame] | 179 | trap = ctrl_cmd_cpy(cmd, cmd); |
Daniel Willmann | f2e75d4 | 2011-07-22 18:08:31 +0200 | [diff] [blame] | 180 | if (!trap) |
| 181 | return NULL; |
| 182 | |
| 183 | trap->ccon = cmd->ccon; |
| 184 | trap->type = CTRL_TYPE_TRAP; |
| 185 | return trap; |
| 186 | } |
| 187 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 188 | static void control_close_conn(struct ctrl_connection *ccon) |
| 189 | { |
Harald Welte | 39c9e7b | 2014-08-22 00:28:51 +0200 | [diff] [blame] | 190 | struct ctrl_cmd_def *cd, *cd2; |
Harald Welte | 29e2798 | 2017-12-22 16:47:18 +0100 | [diff] [blame] | 191 | char *name = osmo_sock_get_name(ccon, ccon->write_queue.bfd.fd); |
| 192 | |
| 193 | LOGP(DLCTRL, LOGL_INFO, "close()d CTRL connection %s\n", name); |
| 194 | talloc_free(name); |
Harald Welte | 39c9e7b | 2014-08-22 00:28:51 +0200 | [diff] [blame] | 195 | |
Harald Welte | 6d96dd7 | 2013-03-16 10:13:04 +0100 | [diff] [blame] | 196 | osmo_wqueue_clear(&ccon->write_queue); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 197 | close(ccon->write_queue.bfd.fd); |
| 198 | osmo_fd_unregister(&ccon->write_queue.bfd); |
Daniel Willmann | 0e0cf37 | 2011-05-06 16:37:25 +0200 | [diff] [blame] | 199 | llist_del(&ccon->list_entry); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 200 | if (ccon->closed_cb) |
| 201 | ccon->closed_cb(ccon); |
Jacob Erlbeck | 141de62 | 2014-03-31 13:42:11 +0200 | [diff] [blame] | 202 | msgb_free(ccon->pending_msg); |
Harald Welte | 39c9e7b | 2014-08-22 00:28:51 +0200 | [diff] [blame] | 203 | |
| 204 | /* clean up deferred commands */ |
| 205 | llist_for_each_entry_safe(cd, cd2, &ccon->def_cmds, list) { |
| 206 | /* delete from list of def_cmds for this ccon */ |
| 207 | llist_del(&cd->list); |
| 208 | /* not strictly needed as this is a slave to the ccon which we |
| 209 | * are about to free anyway */ |
| 210 | talloc_free(cd->cmd); |
| 211 | /* set the CMD to null, this is the indication to the user that |
| 212 | * the connection for this command has gone */ |
| 213 | cd->cmd = NULL; |
| 214 | } |
| 215 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 216 | talloc_free(ccon); |
| 217 | } |
| 218 | |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 219 | int ctrl_cmd_handle(struct ctrl_handle *ctrl, struct ctrl_cmd *cmd, |
| 220 | void *data) |
| 221 | { |
| 222 | char *request; |
| 223 | int i, j, ret, node; |
Max | 33c7ba6 | 2017-05-02 16:24:12 +0200 | [diff] [blame] | 224 | bool break_cycle = false; |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 225 | vector vline, cmdvec, cmds_vec; |
| 226 | |
Max | 2ed3659 | 2017-02-24 14:48:45 +0100 | [diff] [blame] | 227 | if (cmd->type == CTRL_TYPE_SET_REPLY || |
| 228 | cmd->type == CTRL_TYPE_GET_REPLY) { |
Pau Espin Pedrol | 9584cd7 | 2021-01-05 18:36:17 +0100 | [diff] [blame] | 229 | if (ctrl->reply_cb) { |
| 230 | ctrl->reply_cb(ctrl, cmd, data); |
| 231 | return CTRL_CMD_HANDLED; |
| 232 | } |
Max | 2ed3659 | 2017-02-24 14:48:45 +0100 | [diff] [blame] | 233 | if (strncmp(cmd->reply, "OK", 2) == 0) { |
| 234 | LOGP(DLCTRL, LOGL_DEBUG, "%s <%s> for %s is OK\n", |
| 235 | get_value_string(ctrl_type_vals, cmd->type), |
| 236 | cmd->id, cmd->variable); |
| 237 | return CTRL_CMD_HANDLED; |
| 238 | } |
| 239 | } |
| 240 | |
| 241 | if (cmd->type == CTRL_TYPE_ERROR) { |
| 242 | LOGP(DLCTRL, LOGL_ERROR, "%s <%s> for %s is %s\n", |
| 243 | get_value_string(ctrl_type_vals, cmd->type), |
| 244 | cmd->id, cmd->variable, cmd->reply); |
| 245 | return CTRL_CMD_HANDLED; |
| 246 | } |
| 247 | |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 248 | ret = CTRL_CMD_ERROR; |
| 249 | cmd->reply = NULL; |
| 250 | node = CTRL_NODE_ROOT; |
| 251 | cmd->node = data; |
| 252 | |
| 253 | request = talloc_strdup(cmd, cmd->variable); |
| 254 | if (!request) |
| 255 | goto err; |
| 256 | |
Harald Welte | 3b8921f | 2018-05-26 11:43:43 +0200 | [diff] [blame] | 257 | for (i = 0; i < strlen(request); i++) { |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 258 | if (request[i] == '.') |
| 259 | request[i] = ' '; |
| 260 | } |
| 261 | |
| 262 | vline = cmd_make_strvec(request); |
| 263 | talloc_free(request); |
| 264 | if (!vline) { |
| 265 | cmd->reply = "cmd_make_strvec failed."; |
| 266 | goto err; |
| 267 | } |
| 268 | |
Harald Welte | 3b8921f | 2018-05-26 11:43:43 +0200 | [diff] [blame] | 269 | for (i = 0; i < vector_active(vline); i++) { |
Harald Welte | d6b1f85 | 2017-04-16 16:57:40 +0200 | [diff] [blame] | 270 | struct lookup_helper *lh; |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 271 | int rc; |
| 272 | |
| 273 | if (ctrl->lookup) |
| 274 | rc = ctrl->lookup(data, vline, &node, &cmd->node, &i); |
| 275 | else |
| 276 | rc = 0; |
| 277 | |
Harald Welte | d6b1f85 | 2017-04-16 16:57:40 +0200 | [diff] [blame] | 278 | if (!rc) { |
| 279 | llist_for_each_entry(lh, &ctrl_lookup_helpers, list) { |
| 280 | rc = lh->lookup(data, vline, &node, &cmd->node, &i); |
| 281 | if (rc) |
| 282 | break; |
| 283 | } |
| 284 | } |
| 285 | |
Max | 33c7ba6 | 2017-05-02 16:24:12 +0200 | [diff] [blame] | 286 | switch (rc) { |
| 287 | case 1: /* do nothing */ |
| 288 | break; |
| 289 | case -ENODEV: |
| 290 | cmd_free_strvec(vline); |
| 291 | cmd->type = CTRL_TYPE_ERROR; |
| 292 | cmd->reply = "Error while resolving object"; |
| 293 | return ret; |
| 294 | case -ERANGE: |
| 295 | cmd_free_strvec(vline); |
| 296 | cmd->type = CTRL_TYPE_ERROR; |
| 297 | cmd->reply = "Error while parsing the index."; |
| 298 | return ret; |
| 299 | default: /* If we're here the rest must be the command */ |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 300 | cmdvec = vector_init(vector_active(vline)-i); |
Harald Welte | 3b8921f | 2018-05-26 11:43:43 +0200 | [diff] [blame] | 301 | for (j = i; j < vector_active(vline); j++) { |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 302 | vector_set(cmdvec, vector_slot(vline, j)); |
| 303 | } |
| 304 | |
| 305 | /* Get the command vector of the right node */ |
| 306 | cmds_vec = vector_lookup(ctrl_node_vec, node); |
| 307 | |
| 308 | if (!cmds_vec) { |
| 309 | cmd->reply = "Command not found."; |
| 310 | vector_free(cmdvec); |
| 311 | break; |
| 312 | } |
| 313 | |
| 314 | ret = ctrl_cmd_exec(cmdvec, cmd, cmds_vec, data); |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 315 | vector_free(cmdvec); |
Max | 33c7ba6 | 2017-05-02 16:24:12 +0200 | [diff] [blame] | 316 | break_cycle = true; |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 317 | break; |
| 318 | } |
| 319 | |
Max | 33c7ba6 | 2017-05-02 16:24:12 +0200 | [diff] [blame] | 320 | if (break_cycle) |
| 321 | break; |
| 322 | |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 323 | if (i+1 == vector_active(vline)) |
| 324 | cmd->reply = "Command not present."; |
| 325 | } |
| 326 | |
| 327 | cmd_free_strvec(vline); |
| 328 | |
| 329 | err: |
| 330 | if (!cmd->reply) { |
| 331 | if (ret == CTRL_CMD_ERROR) { |
Thorsten Alteholz | a81055d | 2017-03-02 22:13:48 +0100 | [diff] [blame] | 332 | cmd->reply = "An error has occurred."; |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 333 | LOGP(DLCTRL, LOGL_NOTICE, |
| 334 | "%s: cmd->reply has not been set (ERROR).\n", |
| 335 | cmd->variable); |
| 336 | } else if (ret == CTRL_CMD_REPLY) { |
| 337 | LOGP(DLCTRL, LOGL_NOTICE, |
| 338 | "%s: cmd->reply has not been set (type = %d).\n", |
| 339 | cmd->variable, cmd->type); |
| 340 | cmd->reply = ""; |
| 341 | } else { |
| 342 | cmd->reply = "Command has been handled."; |
| 343 | } |
| 344 | } |
| 345 | |
| 346 | if (ret == CTRL_CMD_ERROR) |
| 347 | cmd->type = CTRL_TYPE_ERROR; |
| 348 | return ret; |
Harald Welte | 528134b | 2014-08-21 15:13:08 +0200 | [diff] [blame] | 349 | } |
| 350 | |
| 351 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 352 | static int handle_control_read(struct osmo_fd * bfd) |
| 353 | { |
Pau Espin Pedrol | 686eba9 | 2018-05-04 18:20:35 +0200 | [diff] [blame] | 354 | int ret; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 355 | struct osmo_wqueue *queue; |
| 356 | struct ctrl_connection *ccon; |
Alexander Huemer | 1d3634e | 2011-10-12 00:29:30 +0200 | [diff] [blame] | 357 | struct msgb *msg = NULL; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 358 | struct ctrl_handle *ctrl = bfd->data; |
| 359 | |
| 360 | queue = container_of(bfd, struct osmo_wqueue, bfd); |
| 361 | ccon = container_of(queue, struct ctrl_connection, write_queue); |
| 362 | |
Jacob Erlbeck | 141de62 | 2014-03-31 13:42:11 +0200 | [diff] [blame] | 363 | ret = ipa_msg_recv_buffered(bfd->fd, &msg, &ccon->pending_msg); |
Pau Espin Pedrol | 686eba9 | 2018-05-04 18:20:35 +0200 | [diff] [blame] | 364 | if (ret == 0) { |
Neels Hofmeyr | d53d216 | 2017-12-16 03:57:56 +0100 | [diff] [blame] | 365 | /* msg was already discarded. */ |
Pau Espin Pedrol | 686eba9 | 2018-05-04 18:20:35 +0200 | [diff] [blame] | 366 | goto close_fd; |
| 367 | } else if (ret == -EAGAIN) { |
| 368 | /* received part of a message, it is stored in ccon->pending_msg and there's |
| 369 | * nothing left to do now. */ |
| 370 | return 0; |
| 371 | } else if (ret < 0) { |
Max | a66de71 | 2018-11-23 16:50:50 +0100 | [diff] [blame] | 372 | LOGP(DLCTRL, LOGL_ERROR, "Failed to parse ip access message: %d (%s)\n", ret, strerror(-ret)); |
Pau Espin Pedrol | 686eba9 | 2018-05-04 18:20:35 +0200 | [diff] [blame] | 373 | return 0; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 374 | } |
| 375 | |
Neels Hofmeyr | d53d216 | 2017-12-16 03:57:56 +0100 | [diff] [blame] | 376 | ret = ctrl_handle_msg(ctrl, ccon, msg); |
| 377 | msgb_free(msg); |
| 378 | if (ret) |
Pau Espin Pedrol | 686eba9 | 2018-05-04 18:20:35 +0200 | [diff] [blame] | 379 | goto close_fd; |
| 380 | |
| 381 | return 0; |
| 382 | |
| 383 | close_fd: |
| 384 | control_close_conn(ccon); |
| 385 | return -EBADF; |
Neels Hofmeyr | d53d216 | 2017-12-16 03:57:56 +0100 | [diff] [blame] | 386 | } |
| 387 | |
Harald Welte | b418682 | 2018-05-26 17:25:11 +0200 | [diff] [blame] | 388 | /*! Handle a received CTRL command contained in a \ref msgb. |
| 389 | * \param[in] ctrl CTRL interface handle |
| 390 | * \param[in] ccon CTRL connection through which the command was received |
| 391 | * \param[in] msg message buffer containing CTRL command including IPA+IPA_EXT headers |
| 392 | * \returns 0 on success; negative on error */ |
Neels Hofmeyr | d53d216 | 2017-12-16 03:57:56 +0100 | [diff] [blame] | 393 | int ctrl_handle_msg(struct ctrl_handle *ctrl, struct ctrl_connection *ccon, struct msgb *msg) |
| 394 | { |
| 395 | struct ctrl_cmd *cmd; |
Pau Espin Pedrol | 59e6059 | 2018-07-12 19:39:56 +0200 | [diff] [blame] | 396 | bool parse_failed; |
Neels Hofmeyr | d53d216 | 2017-12-16 03:57:56 +0100 | [diff] [blame] | 397 | struct ipaccess_head *iph; |
| 398 | struct ipaccess_head_ext *iph_ext; |
Neels Hofmeyr | 7c0031f | 2018-04-03 17:00:11 +0200 | [diff] [blame] | 399 | int result; |
Neels Hofmeyr | d53d216 | 2017-12-16 03:57:56 +0100 | [diff] [blame] | 400 | |
Stefan Sperling | e484d42 | 2018-10-09 14:09:04 +0200 | [diff] [blame] | 401 | if (msg->len < sizeof(*iph)) { |
| 402 | LOGP(DLCTRL, LOGL_ERROR, "The message is too short.\n"); |
| 403 | return -EINVAL; |
| 404 | } |
| 405 | iph = (struct ipaccess_head *) msg->data; |
| 406 | if (iph->proto == IPAC_PROTO_IPACCESS) { |
| 407 | uint8_t msg_type = *(msg->l2h); |
| 408 | switch (msg_type) { |
| 409 | case IPAC_MSGT_PING: |
| 410 | if (ipa_ccm_send_pong(ccon->write_queue.bfd.fd) < 0) |
| 411 | LOGP(DLINP, LOGL_ERROR, "Cannot send PONG message. Reason: %s\n", strerror(errno)); |
| 412 | break; |
| 413 | case IPAC_MSGT_PONG: |
| 414 | break; |
| 415 | case IPAC_MSGT_ID_ACK: |
| 416 | if (ipa_ccm_send_id_ack(ccon->write_queue.bfd.fd) < 0) |
| 417 | LOGP(DLINP, LOGL_ERROR, "Cannot send ID_ACK message. Reason: %s\n", strerror(errno)); |
| 418 | break; |
| 419 | default: |
| 420 | LOGP(DLCTRL, LOGL_DEBUG, "Received unhandled IPACCESS protocol message of type 0x%x: %s\n", |
| 421 | msg_type, msgb_hexdump(msg)); |
| 422 | break; |
| 423 | } |
| 424 | return 0; |
| 425 | } |
| 426 | if (iph->proto != IPAC_PROTO_OSMO) { |
| 427 | LOGP(DLCTRL, LOGL_ERROR, "Protocol mismatch. Received protocol 0x%x message: %s\n", |
| 428 | iph->proto, msgb_hexdump(msg)); |
| 429 | return -EINVAL; |
| 430 | } |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 431 | if (msg->len < sizeof(*iph) + sizeof(*iph_ext)) { |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 432 | LOGP(DLCTRL, LOGL_ERROR, "The message is too short.\n"); |
Neels Hofmeyr | d53d216 | 2017-12-16 03:57:56 +0100 | [diff] [blame] | 433 | return -EINVAL; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 434 | } |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 435 | iph_ext = (struct ipaccess_head_ext *) iph->data; |
| 436 | if (iph_ext->proto != IPAC_PROTO_EXT_CTRL) { |
Stefan Sperling | e484d42 | 2018-10-09 14:09:04 +0200 | [diff] [blame] | 437 | LOGP(DLCTRL, LOGL_ERROR, "Extended protocol mismatch. Received protocol 0x%x message: %s\n", |
| 438 | iph_ext->proto, msgb_hexdump(msg)); |
Neels Hofmeyr | d53d216 | 2017-12-16 03:57:56 +0100 | [diff] [blame] | 439 | return -EINVAL; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 440 | } |
| 441 | |
| 442 | msg->l2h = iph_ext->data; |
| 443 | |
Pau Espin Pedrol | 59e6059 | 2018-07-12 19:39:56 +0200 | [diff] [blame] | 444 | cmd = ctrl_cmd_parse3(ccon, msg, &parse_failed); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 445 | |
Neels Hofmeyr | c0b0b62 | 2017-12-16 01:12:35 +0100 | [diff] [blame] | 446 | if (!cmd) { |
| 447 | /* should never happen */ |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 448 | cmd = talloc_zero(ccon, struct ctrl_cmd); |
| 449 | if (!cmd) |
Neels Hofmeyr | d53d216 | 2017-12-16 03:57:56 +0100 | [diff] [blame] | 450 | return -ENOMEM; |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 451 | LOGP(DLCTRL, LOGL_ERROR, "Command parser error.\n"); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 452 | cmd->type = CTRL_TYPE_ERROR; |
| 453 | cmd->id = "err"; |
| 454 | cmd->reply = "Command parser error."; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 455 | } |
| 456 | |
Neels Hofmeyr | 7c0031f | 2018-04-03 17:00:11 +0200 | [diff] [blame] | 457 | /* In case of error, reply with the error message right away. */ |
Pau Espin Pedrol | 59e6059 | 2018-07-12 19:39:56 +0200 | [diff] [blame] | 458 | if (cmd->type == CTRL_TYPE_ERROR && parse_failed) |
Neels Hofmeyr | 7c0031f | 2018-04-03 17:00:11 +0200 | [diff] [blame] | 459 | goto send_reply; |
Neels Hofmeyr | cdbc9af | 2018-04-03 16:51:49 +0200 | [diff] [blame] | 460 | |
Neels Hofmeyr | 7c0031f | 2018-04-03 17:00:11 +0200 | [diff] [blame] | 461 | cmd->ccon = ccon; |
| 462 | result = ctrl_cmd_handle(ctrl, cmd, ctrl->data); |
Neels Hofmeyr | cdbc9af | 2018-04-03 16:51:49 +0200 | [diff] [blame] | 463 | |
Neels Hofmeyr | 7c0031f | 2018-04-03 17:00:11 +0200 | [diff] [blame] | 464 | |
| 465 | if (cmd->defer) { |
| 466 | /* The command is still stored as ctrl_cmd_def.cmd, in the def_cmds list. |
| 467 | * Just leave hanging for deferred handling. Reply will happen later. */ |
| 468 | return 0; |
Neels Hofmeyr | c0b0b62 | 2017-12-16 01:12:35 +0100 | [diff] [blame] | 469 | } |
| 470 | |
Neels Hofmeyr | 7c0031f | 2018-04-03 17:00:11 +0200 | [diff] [blame] | 471 | /* On CTRL_CMD_HANDLED, no reply needs to be sent back. */ |
| 472 | if (result == CTRL_CMD_HANDLED) |
| 473 | goto just_free; |
Neels Hofmeyr | c0b0b62 | 2017-12-16 01:12:35 +0100 | [diff] [blame] | 474 | |
Neels Hofmeyr | 7c0031f | 2018-04-03 17:00:11 +0200 | [diff] [blame] | 475 | send_reply: |
| 476 | /* There is a reply or error that should be reported back to the sender. */ |
Harald Welte | 319a77e | 2024-03-02 18:48:39 +0100 | [diff] [blame] | 477 | ctrl_cmd_send2(ccon, cmd); |
Neels Hofmeyr | 7c0031f | 2018-04-03 17:00:11 +0200 | [diff] [blame] | 478 | just_free: |
| 479 | talloc_free(cmd); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 480 | return 0; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 481 | } |
| 482 | |
| 483 | static int control_write_cb(struct osmo_fd *bfd, struct msgb *msg) |
| 484 | { |
Harald Welte | f360b42 | 2017-12-22 16:43:24 +0100 | [diff] [blame] | 485 | struct osmo_wqueue *queue; |
| 486 | struct ctrl_connection *ccon; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 487 | int rc; |
| 488 | |
Harald Welte | f360b42 | 2017-12-22 16:43:24 +0100 | [diff] [blame] | 489 | queue = container_of(bfd, struct osmo_wqueue, bfd); |
| 490 | ccon = container_of(queue, struct ctrl_connection, write_queue); |
| 491 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 492 | rc = write(bfd->fd, msg->data, msg->len); |
Pau Espin Pedrol | 686eba9 | 2018-05-04 18:20:35 +0200 | [diff] [blame] | 493 | if (rc == 0) { |
Harald Welte | f360b42 | 2017-12-22 16:43:24 +0100 | [diff] [blame] | 494 | control_close_conn(ccon); |
Pau Espin Pedrol | 686eba9 | 2018-05-04 18:20:35 +0200 | [diff] [blame] | 495 | return -EBADF; |
| 496 | } |
Pau Espin Pedrol | d1b0716 | 2021-06-10 14:24:06 +0200 | [diff] [blame] | 497 | if (rc < 0) { |
Harald Welte | 5995281 | 2017-12-22 18:03:44 +0100 | [diff] [blame] | 498 | LOGP(DLCTRL, LOGL_ERROR, "Failed to write message to the CTRL connection.\n"); |
Pau Espin Pedrol | d1b0716 | 2021-06-10 14:24:06 +0200 | [diff] [blame] | 499 | return 0; |
| 500 | } |
| 501 | if (rc < msg->len) { |
| 502 | msgb_pull(msg, rc); |
| 503 | return -EAGAIN; |
| 504 | } |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 505 | |
Pau Espin Pedrol | 686eba9 | 2018-05-04 18:20:35 +0200 | [diff] [blame] | 506 | return 0; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 507 | } |
| 508 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 509 | /*! Allocate CTRL connection |
Max | fa9e05e | 2017-02-20 11:53:11 +0100 | [diff] [blame] | 510 | * \param[in] ctx Context from which talloc should allocate it |
| 511 | * \param[in] data caller's private data parameter which should assigned to |
| 512 | write queue's file descriptor data parameter. |
| 513 | * \return Allocated CTRL connection structure or NULL in case of errors |
| 514 | */ |
| 515 | struct ctrl_connection *osmo_ctrl_conn_alloc(void *ctx, void *data) |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 516 | { |
| 517 | struct ctrl_connection *ccon = talloc_zero(ctx, struct ctrl_connection); |
| 518 | if (!ccon) |
| 519 | return NULL; |
| 520 | |
| 521 | osmo_wqueue_init(&ccon->write_queue, 100); |
| 522 | /* Error handling here? */ |
| 523 | |
| 524 | INIT_LLIST_HEAD(&ccon->cmds); |
Harald Welte | 39c9e7b | 2014-08-22 00:28:51 +0200 | [diff] [blame] | 525 | INIT_LLIST_HEAD(&ccon->def_cmds); |
| 526 | |
Max | fa9e05e | 2017-02-20 11:53:11 +0100 | [diff] [blame] | 527 | ccon->write_queue.bfd.data = data; |
Pau Espin Pedrol | 377645d | 2021-01-27 16:54:15 +0100 | [diff] [blame] | 528 | ccon->write_queue.bfd.fd = -1; |
Max | fa9e05e | 2017-02-20 11:53:11 +0100 | [diff] [blame] | 529 | ccon->write_queue.write_cb = control_write_cb; |
Max | 9756c46 | 2017-02-24 13:03:32 +0100 | [diff] [blame] | 530 | ccon->write_queue.read_cb = handle_control_read; |
Max | fa9e05e | 2017-02-20 11:53:11 +0100 | [diff] [blame] | 531 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 532 | return ccon; |
| 533 | } |
| 534 | |
| 535 | static int listen_fd_cb(struct osmo_fd *listen_bfd, unsigned int what) |
| 536 | { |
| 537 | int ret, fd, on; |
Daniel Willmann | 0e0cf37 | 2011-05-06 16:37:25 +0200 | [diff] [blame] | 538 | struct ctrl_handle *ctrl; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 539 | struct ctrl_connection *ccon; |
Harald Welte | 5995281 | 2017-12-22 18:03:44 +0100 | [diff] [blame] | 540 | char *name; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 541 | |
| 542 | |
Harald Welte | 1688699 | 2019-03-20 10:26:39 +0100 | [diff] [blame] | 543 | if (!(what & OSMO_FD_READ)) |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 544 | return 0; |
| 545 | |
Harald Welte | 5995281 | 2017-12-22 18:03:44 +0100 | [diff] [blame] | 546 | fd = accept(listen_bfd->fd, NULL, NULL); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 547 | if (fd < 0) { |
| 548 | perror("accept"); |
| 549 | return fd; |
| 550 | } |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 551 | |
Harald Welte | e15ac06 | 2014-12-04 14:15:36 +0100 | [diff] [blame] | 552 | #ifdef TCP_NODELAY |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 553 | on = 1; |
| 554 | ret = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof(on)); |
| 555 | if (ret != 0) { |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 556 | 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] | 557 | close(fd); |
| 558 | return ret; |
| 559 | } |
Harald Welte | e15ac06 | 2014-12-04 14:15:36 +0100 | [diff] [blame] | 560 | #endif |
Max | fa9e05e | 2017-02-20 11:53:11 +0100 | [diff] [blame] | 561 | ctrl = listen_bfd->data; |
| 562 | ccon = osmo_ctrl_conn_alloc(listen_bfd->data, ctrl); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 563 | if (!ccon) { |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 564 | LOGP(DLCTRL, LOGL_ERROR, "Failed to allocate.\n"); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 565 | close(fd); |
| 566 | return -1; |
| 567 | } |
| 568 | |
Harald Welte | 5995281 | 2017-12-22 18:03:44 +0100 | [diff] [blame] | 569 | name = osmo_sock_get_name(ccon, fd); |
| 570 | LOGP(DLCTRL, LOGL_INFO, "accept()ed new CTRL connection from %s\n", name); |
| 571 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 572 | ccon->write_queue.bfd.fd = fd; |
Harald Welte | 1688699 | 2019-03-20 10:26:39 +0100 | [diff] [blame] | 573 | ccon->write_queue.bfd.when = OSMO_FD_READ; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 574 | |
| 575 | ret = osmo_fd_register(&ccon->write_queue.bfd); |
| 576 | if (ret < 0) { |
Harald Welte | 7fd0c83 | 2014-08-20 19:58:13 +0200 | [diff] [blame] | 577 | LOGP(DLCTRL, LOGL_ERROR, "Could not register FD.\n"); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 578 | close(ccon->write_queue.bfd.fd); |
| 579 | talloc_free(ccon); |
| 580 | } |
| 581 | |
Daniel Willmann | 0e0cf37 | 2011-05-06 16:37:25 +0200 | [diff] [blame] | 582 | llist_add(&ccon->list_entry, &ctrl->ccon_list); |
| 583 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 584 | return ret; |
| 585 | } |
| 586 | |
Max | b214af5 | 2017-11-24 13:51:57 +0100 | [diff] [blame] | 587 | 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] | 588 | { |
Max | b214af5 | 2017-11-24 13:51:57 +0100 | [diff] [blame] | 589 | if (intv >= RATE_CTR_INTV_NUM) { |
| 590 | LOGP(DLCTRL, LOGL_ERROR, "Unexpected interval value %d while trying to get rate counter value in %s\n", |
| 591 | intv, grp); |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 592 | return 0; |
Max | b214af5 | 2017-11-24 13:51:57 +0100 | [diff] [blame] | 593 | } |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 594 | |
| 595 | /* Absolute value */ |
| 596 | if (intv == -1) { |
| 597 | return ctr->current; |
| 598 | } else { |
| 599 | return ctr->intv[intv].rate; |
| 600 | } |
| 601 | } |
| 602 | |
Pau Espin Pedrol | 7b894a7 | 2021-06-04 18:17:12 +0200 | [diff] [blame] | 603 | static int get_rate_ctr_group_idx(struct rate_ctr_group *ctrg, int intv, struct ctrl_cmd *cmd) |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 604 | { |
Max | 7dc8e88 | 2017-11-24 13:53:33 +0100 | [diff] [blame] | 605 | unsigned int i; |
| 606 | for (i = 0; i < ctrg->desc->num_ctr; i++) { |
| 607 | ctrl_cmd_reply_printf(cmd, "%s %"PRIu64";", ctrg->desc->ctr_desc[i].name, |
Pau Espin Pedrol | 7b894a7 | 2021-06-04 18:17:12 +0200 | [diff] [blame] | 608 | get_rate_ctr_value(rate_ctr_group_get_ctr(ctrg, i), intv, ctrg->desc->group_name_prefix)); |
Max | 7dc8e88 | 2017-11-24 13:53:33 +0100 | [diff] [blame] | 609 | if (!cmd->reply) { |
| 610 | cmd->reply = "OOM"; |
| 611 | return CTRL_CMD_ERROR; |
| 612 | } |
| 613 | } |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 614 | |
| 615 | return CTRL_CMD_REPLY; |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 616 | } |
| 617 | |
Max | 52a38dd | 2017-11-23 20:34:02 +0100 | [diff] [blame] | 618 | static int ctrl_rate_ctr_group_handler(struct rate_ctr_group *ctrg, void *data) |
| 619 | { |
| 620 | struct ctrl_cmd *cmd = data; |
| 621 | |
| 622 | cmd->reply = talloc_asprintf_append(cmd->reply, "%s.%u;", ctrg->desc->group_name_prefix, ctrg->idx); |
| 623 | if (!cmd->reply) { |
| 624 | cmd->reply = "OOM"; |
| 625 | return -1; |
| 626 | } |
| 627 | |
| 628 | return 0; |
| 629 | } |
| 630 | |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 631 | /* rate_ctr */ |
| 632 | CTRL_CMD_DEFINE(rate_ctr, "rate_ctr *"); |
Daniel Willmann | f7c74e5 | 2011-08-05 11:48:18 +0200 | [diff] [blame] | 633 | static int get_rate_ctr(struct ctrl_cmd *cmd, void *data) |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 634 | { |
| 635 | int intv; |
| 636 | unsigned int idx; |
Neels Hofmeyr | 5b34f77 | 2016-09-19 14:15:03 +0200 | [diff] [blame] | 637 | char *ctr_group, *ctr_idx, *tmp, *dup, *saveptr, *interval; |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 638 | struct rate_ctr_group *ctrg; |
| 639 | const struct rate_ctr *ctr; |
| 640 | |
| 641 | dup = talloc_strdup(cmd, cmd->variable); |
| 642 | if (!dup) |
| 643 | goto oom; |
| 644 | |
| 645 | /* Skip over possible prefixes (net.) */ |
| 646 | tmp = strstr(dup, "rate_ctr"); |
| 647 | if (!tmp) { |
| 648 | talloc_free(dup); |
| 649 | cmd->reply = "rate_ctr not a token in rate_ctr command!"; |
| 650 | goto err; |
| 651 | } |
| 652 | |
| 653 | strtok_r(tmp, ".", &saveptr); |
| 654 | interval = strtok_r(NULL, ".", &saveptr); |
| 655 | if (!interval) { |
| 656 | talloc_free(dup); |
| 657 | cmd->reply = "Missing interval."; |
| 658 | goto err; |
| 659 | } |
| 660 | |
| 661 | if (!strcmp(interval, "abs")) { |
| 662 | intv = -1; |
| 663 | } else if (!strcmp(interval, "per_sec")) { |
| 664 | intv = RATE_CTR_INTV_SEC; |
| 665 | } else if (!strcmp(interval, "per_min")) { |
| 666 | intv = RATE_CTR_INTV_MIN; |
| 667 | } else if (!strcmp(interval, "per_hour")) { |
| 668 | intv = RATE_CTR_INTV_HOUR; |
| 669 | } else if (!strcmp(interval, "per_day")) { |
| 670 | intv = RATE_CTR_INTV_DAY; |
Max | 52a38dd | 2017-11-23 20:34:02 +0100 | [diff] [blame] | 671 | } else if (!strcmp(interval, "*")) { |
| 672 | intv = rate_ctr_for_each_group(ctrl_rate_ctr_group_handler, cmd); |
| 673 | if (intv < 0) |
| 674 | return CTRL_CMD_ERROR; |
| 675 | return CTRL_CMD_REPLY; |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 676 | } else { |
| 677 | talloc_free(dup); |
Max | b4718fd | 2017-11-24 11:28:35 +0100 | [diff] [blame] | 678 | 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] | 679 | goto err; |
| 680 | } |
| 681 | |
| 682 | ctr_group = strtok_r(NULL, ".", &saveptr); |
Max | 22886d9 | 2016-06-14 18:17:06 +0200 | [diff] [blame] | 683 | ctr_idx = strtok_r(NULL, ".", &saveptr); |
| 684 | if (!ctr_group || !ctr_idx) { |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 685 | talloc_free(dup); |
Max | 22886d9 | 2016-06-14 18:17:06 +0200 | [diff] [blame] | 686 | cmd->reply = "Counter group must be of name.index form e. g. " |
| 687 | "e1inp.0"; |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 688 | goto err; |
| 689 | } |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 690 | |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 691 | idx = atoi(ctr_idx); |
| 692 | |
| 693 | ctrg = rate_ctr_get_group_by_name_idx(ctr_group, idx); |
| 694 | if (!ctrg) { |
| 695 | talloc_free(dup); |
Max | 22886d9 | 2016-06-14 18:17:06 +0200 | [diff] [blame] | 696 | cmd->reply = "Counter group with given name and index not found"; |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 697 | goto err; |
| 698 | } |
| 699 | |
Max | 22886d9 | 2016-06-14 18:17:06 +0200 | [diff] [blame] | 700 | if (!strlen(saveptr)) { |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 701 | talloc_free(dup); |
| 702 | return get_rate_ctr_group_idx(ctrg, intv, cmd); |
| 703 | } |
| 704 | |
Max | 22886d9 | 2016-06-14 18:17:06 +0200 | [diff] [blame] | 705 | ctr = rate_ctr_get_by_name(ctrg, saveptr); |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 706 | if (!ctr) { |
| 707 | cmd->reply = "Counter name not found."; |
| 708 | talloc_free(dup); |
| 709 | goto err; |
| 710 | } |
| 711 | |
| 712 | talloc_free(dup); |
| 713 | |
Max | b214af5 | 2017-11-24 13:51:57 +0100 | [diff] [blame] | 714 | 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] | 715 | if (!cmd->reply) |
| 716 | goto oom; |
| 717 | |
| 718 | return CTRL_CMD_REPLY; |
| 719 | oom: |
| 720 | cmd->reply = "OOM"; |
| 721 | err: |
| 722 | return CTRL_CMD_ERROR; |
| 723 | } |
| 724 | |
Daniel Willmann | f7c74e5 | 2011-08-05 11:48:18 +0200 | [diff] [blame] | 725 | static int set_rate_ctr(struct ctrl_cmd *cmd, void *data) |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 726 | { |
| 727 | cmd->reply = "Can't set rate counter."; |
| 728 | |
| 729 | return CTRL_CMD_ERROR; |
| 730 | } |
| 731 | |
Daniel Willmann | f7c74e5 | 2011-08-05 11:48:18 +0200 | [diff] [blame] | 732 | 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] | 733 | { |
| 734 | return 0; |
| 735 | } |
| 736 | |
Neels Hofmeyr | a16b50c | 2021-09-12 21:25:28 +0200 | [diff] [blame] | 737 | /* Expose all stat_item groups on CTRL, as read-only variables of the form: |
| 738 | * stat_item.(last|...).group_name.N.item_name |
| 739 | * stat_item.(last|...).group_name.by_name.group_idx_name.item_name |
| 740 | */ |
| 741 | CTRL_CMD_DEFINE_RO(stat_item, "stat_item *"); |
| 742 | static int get_stat_item(struct ctrl_cmd *cmd, void *data) |
| 743 | { |
| 744 | char *dup; |
| 745 | char *saveptr; |
| 746 | char *value_type; |
| 747 | char *group_name; |
| 748 | char *group_idx_str; |
| 749 | char *item_name; |
| 750 | char *tmp; |
| 751 | int32_t val; |
| 752 | struct osmo_stat_item_group *statg; |
| 753 | const struct osmo_stat_item *stat_item; |
| 754 | |
| 755 | /* cmd will be freed in control_if.c after handling here, so no need to free the dup string. */ |
| 756 | dup = talloc_strdup(cmd, cmd->variable); |
| 757 | if (!dup) { |
| 758 | cmd->reply = "OOM"; |
| 759 | return CTRL_CMD_ERROR; |
| 760 | } |
| 761 | |
| 762 | /* Split off the first "stat_item." part */ |
| 763 | tmp = strtok_r(dup, ".", &saveptr); |
| 764 | if (!tmp || strcmp(tmp, "stat_item") != 0) |
| 765 | goto format_error; |
| 766 | |
| 767 | /* Split off the "last." part (validated further below) */ |
| 768 | value_type = strtok_r(NULL, ".", &saveptr); |
| 769 | if (!value_type) |
| 770 | goto format_error; |
| 771 | |
| 772 | /* Split off the "group_name." part */ |
| 773 | group_name = strtok_r(NULL, ".", &saveptr); |
| 774 | if (!group_name) |
| 775 | goto format_error; |
| 776 | |
| 777 | /* Split off the "N." part */ |
| 778 | group_idx_str = strtok_r(NULL, ".", &saveptr); |
| 779 | if (!group_idx_str) |
| 780 | goto format_error; |
| 781 | if (strcmp(group_idx_str, "by_name") == 0) { |
| 782 | /* The index is not given by "N" but by "by_name.foo". Get the "foo" idx-name */ |
| 783 | group_idx_str = strtok_r(NULL, ".", &saveptr); |
| 784 | statg = osmo_stat_item_get_group_by_name_idxname(group_name, group_idx_str); |
| 785 | } else { |
| 786 | int idx; |
| 787 | if (osmo_str_to_int(&idx, group_idx_str, 10, 0, INT_MAX)) |
| 788 | goto format_error; |
| 789 | statg = osmo_stat_item_get_group_by_name_idx(group_name, idx); |
| 790 | } |
| 791 | if (!statg) { |
| 792 | cmd->reply = "Stat group with given name and index not found"; |
| 793 | return CTRL_CMD_ERROR; |
| 794 | } |
| 795 | |
| 796 | /* Split off the "item_name" part */ |
| 797 | item_name = strtok_r(NULL, ".", &saveptr); |
| 798 | if (!item_name) |
| 799 | goto format_error; |
| 800 | stat_item = osmo_stat_item_get_by_name(statg, item_name); |
| 801 | if (!stat_item) { |
| 802 | cmd->reply = "No such stat item found"; |
| 803 | return CTRL_CMD_ERROR; |
| 804 | } |
| 805 | |
| 806 | tmp = strtok_r(NULL, "", &saveptr); |
| 807 | if (tmp) { |
| 808 | cmd->reply = "Garbage after stat item name"; |
| 809 | return CTRL_CMD_ERROR; |
| 810 | } |
| 811 | |
| 812 | if (!strcmp(value_type, "last")) |
| 813 | val = osmo_stat_item_get_last(stat_item); |
| 814 | else |
| 815 | goto format_error; |
| 816 | |
| 817 | cmd->reply = talloc_asprintf(cmd, "%"PRIu32, val); |
| 818 | if (!cmd->reply) { |
| 819 | cmd->reply = "OOM"; |
| 820 | return CTRL_CMD_ERROR; |
| 821 | } |
| 822 | |
| 823 | return CTRL_CMD_REPLY; |
| 824 | |
| 825 | format_error: |
| 826 | cmd->reply = "Stat item must be of form stat_item.type.group_name.N.item_name," |
| 827 | " e.g. 'stat_item.last.bsc.0.msc_num:connected'"; |
| 828 | return CTRL_CMD_ERROR; |
| 829 | } |
| 830 | |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 831 | /* counter */ |
| 832 | CTRL_CMD_DEFINE(counter, "counter *"); |
Daniel Willmann | f7c74e5 | 2011-08-05 11:48:18 +0200 | [diff] [blame] | 833 | static int get_counter(struct ctrl_cmd *cmd, void *data) |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 834 | { |
| 835 | char *ctr_name, *tmp, *dup, *saveptr; |
| 836 | struct osmo_counter *counter; |
| 837 | |
| 838 | cmd->reply = "OOM"; |
| 839 | dup = talloc_strdup(cmd, cmd->variable); |
| 840 | if (!dup) |
| 841 | goto err; |
| 842 | |
| 843 | |
| 844 | tmp = strstr(dup, "counter"); |
| 845 | if (!tmp) { |
| 846 | talloc_free(dup); |
| 847 | goto err; |
| 848 | } |
| 849 | |
| 850 | strtok_r(tmp, ".", &saveptr); |
| 851 | ctr_name = strtok_r(NULL, "\0", &saveptr); |
| 852 | |
| 853 | if (!ctr_name) |
| 854 | goto err; |
| 855 | |
| 856 | counter = osmo_counter_get_by_name(ctr_name); |
| 857 | if (!counter) { |
| 858 | cmd->reply = "Counter name not found."; |
| 859 | talloc_free(dup); |
| 860 | goto err; |
| 861 | } |
| 862 | |
| 863 | talloc_free(dup); |
| 864 | |
| 865 | cmd->reply = talloc_asprintf(cmd, "%lu", counter->value); |
| 866 | if (!cmd->reply) { |
| 867 | cmd->reply = "OOM"; |
| 868 | goto err; |
| 869 | } |
| 870 | |
| 871 | return CTRL_CMD_REPLY; |
| 872 | err: |
| 873 | return CTRL_CMD_ERROR; |
| 874 | } |
| 875 | |
Daniel Willmann | f7c74e5 | 2011-08-05 11:48:18 +0200 | [diff] [blame] | 876 | static int set_counter(struct ctrl_cmd *cmd, void *data) |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 877 | { |
| 878 | |
| 879 | cmd->reply = "Can't set counter."; |
| 880 | |
| 881 | return CTRL_CMD_ERROR; |
| 882 | } |
| 883 | |
Daniel Willmann | f7c74e5 | 2011-08-05 11:48:18 +0200 | [diff] [blame] | 884 | 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] | 885 | { |
| 886 | return 0; |
| 887 | } |
| 888 | |
Harald Welte | ae2fcb2 | 2014-08-21 15:20:00 +0200 | [diff] [blame] | 889 | struct ctrl_handle *ctrl_interface_setup(void *data, uint16_t port, |
| 890 | ctrl_cmd_lookup lookup) |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 891 | { |
Max | 3f79ce8 | 2022-12-03 17:59:19 +0300 | [diff] [blame] | 892 | return ctrl_interface_setup2(data, port, lookup, 0); |
Neels Hofmeyr | 4934309 | 2016-02-24 00:09:40 +0100 | [diff] [blame] | 893 | } |
| 894 | |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 895 | static int ctrl_initialized = 0; |
| 896 | |
| 897 | /* global ctrl initialization */ |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 898 | static int ctrl_init(unsigned int node_count) |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 899 | { |
| 900 | int ret; |
| 901 | |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 902 | if (!node_count) |
| 903 | node_count = _LAST_CTRL_NODE; |
| 904 | OSMO_ASSERT(node_count >= _LAST_CTRL_NODE); |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 905 | |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 906 | if (ctrl_initialized) { |
| 907 | OSMO_ASSERT(ctrl_initialized == node_count); |
| 908 | return 0; |
| 909 | } |
| 910 | |
| 911 | ctrl_node_vec = vector_init(node_count); |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 912 | if (!ctrl_node_vec) |
| 913 | goto err; |
| 914 | |
| 915 | ret = ctrl_cmd_install(CTRL_NODE_ROOT, &cmd_rate_ctr); |
| 916 | if (ret) |
| 917 | goto err_vec; |
Neels Hofmeyr | a16b50c | 2021-09-12 21:25:28 +0200 | [diff] [blame] | 918 | ret = ctrl_cmd_install(CTRL_NODE_ROOT, &cmd_stat_item); |
| 919 | if (ret) |
| 920 | goto err_vec; |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 921 | ret = ctrl_cmd_install(CTRL_NODE_ROOT, &cmd_counter); |
| 922 | if (ret) |
| 923 | goto err_vec; |
| 924 | |
Harald Welte | 31c0fef | 2017-04-16 17:26:30 +0200 | [diff] [blame] | 925 | ret = osmo_fsm_ctrl_cmds_install(); |
| 926 | if (ret) |
| 927 | goto err_vec; |
| 928 | |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 929 | ctrl_initialized = node_count; |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 930 | return 0; |
| 931 | |
| 932 | err_vec: |
| 933 | vector_free(ctrl_node_vec); |
| 934 | ctrl_node_vec = NULL; |
| 935 | err: |
| 936 | return -1; |
| 937 | } |
| 938 | |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 939 | /*! Allocate a CTRL interface handle. |
| 940 | * \param[in] ctx Talloc allocation context to be used |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 941 | * \param[in] data Pointer which will be made available to each |
| 942 | set_..() get_..() verify_..() control command function |
| 943 | * \param[in] lookup Lookup function pointer, can be NULL |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 944 | * \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] | 945 | * \returns ctrl_handle pointer or NULL in case of errors |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 946 | * |
| 947 | * Please see ctrl_interface_setup_dynip2() for a detailed description of \a |
| 948 | * node_count semantics. |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 949 | */ |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 950 | struct ctrl_handle *ctrl_handle_alloc2(void *ctx, void *data, |
| 951 | ctrl_cmd_lookup lookup, |
| 952 | unsigned int node_count) |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 953 | { |
| 954 | struct ctrl_handle *ctrl; |
| 955 | |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 956 | ctrl_init(node_count); |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 957 | |
| 958 | ctrl = talloc_zero(ctx, struct ctrl_handle); |
| 959 | if (!ctrl) |
| 960 | return NULL; |
| 961 | |
| 962 | INIT_LLIST_HEAD(&ctrl->ccon_list); |
| 963 | |
| 964 | ctrl->data = data; |
| 965 | ctrl->lookup = lookup; |
| 966 | |
| 967 | return ctrl; |
| 968 | } |
| 969 | |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 970 | /*! Allocate a CTRL interface handle. |
| 971 | * \param[in] ctx Talloc allocation context to be used |
| 972 | * \param[in] data Pointer which will be made available to each |
| 973 | set_..() get_..() verify_..() control command function |
| 974 | * \param[in] lookup Lookup function pointer, can be NULL |
| 975 | * \returns ctrl_handle pointer or NULL in case of errors |
| 976 | */ |
| 977 | struct ctrl_handle *ctrl_handle_alloc(void *ctx, void *data, ctrl_cmd_lookup lookup) |
| 978 | { |
| 979 | return ctrl_handle_alloc2(ctx, data, lookup, 0); |
| 980 | } |
| 981 | |
| 982 | /*! Setup CTRL interface on a given address. |
Max | 32ee5af | 2017-02-16 17:44:09 +0100 | [diff] [blame] | 983 | * \param[in] data Pointer which will be made available to each |
| 984 | set_..() get_..() verify_..() control command function |
| 985 | * \param[in] bind_addr Address on which CTRL socket shall listen |
| 986 | * \param[in] port Port on which CTRL socket shall listen |
| 987 | * \param[in] lookup Lookup function pointer, can be NULL |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 988 | * \param[in] node_count Number of CTRL nodes to allocate, 0 for default. |
Max | 32ee5af | 2017-02-16 17:44:09 +0100 | [diff] [blame] | 989 | * \returns ctrl_handle pointer or NULL in case of errors |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 990 | * |
| 991 | * Control interface nodes are identified by a node handle; some of these are |
| 992 | * defined in enum ctrl_node_type, here in libosmocore. However, applications |
| 993 | * defining own nodes may add own control nodes without having to extend the |
| 994 | * enum in libosmocore. For example, in the calling application, define an enum |
| 995 | * like "enum more_ctrl_nodes { CTRL_NODE_FOO = _LAST_CTRL_NODE, CTRL_NODE_BAR, |
| 996 | * _LAST_CTRL_NODE_EXTENDED }". In order to provide space for the additional |
| 997 | * control nodes, pass _LAST_CTRL_NODE_EXTENDED to the \a node_count parameter. |
| 998 | * Passing 0 is identical to passing _LAST_CTRL_NODE, i.e. to not define own |
| 999 | * control nodes apart from libosmocore ones. |
Max | 32ee5af | 2017-02-16 17:44:09 +0100 | [diff] [blame] | 1000 | */ |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 1001 | struct ctrl_handle *ctrl_interface_setup_dynip2(void *data, |
| 1002 | const char *bind_addr, |
| 1003 | uint16_t port, |
| 1004 | ctrl_cmd_lookup lookup, |
| 1005 | unsigned int node_count) |
Neels Hofmeyr | 4934309 | 2016-02-24 00:09:40 +0100 | [diff] [blame] | 1006 | { |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 1007 | int ret; |
| 1008 | struct ctrl_handle *ctrl; |
| 1009 | |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 1010 | ctrl = ctrl_handle_alloc2(data, data, lookup, node_count); |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 1011 | if (!ctrl) |
Daniel Willmann | 782974b | 2011-07-22 17:55:42 +0200 | [diff] [blame] | 1012 | return NULL; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 1013 | |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 1014 | /* Listen for control connections */ |
Harald Welte | 1238cc6 | 2014-08-20 19:50:04 +0200 | [diff] [blame] | 1015 | ctrl->listen_fd.cb = listen_fd_cb; |
| 1016 | ctrl->listen_fd.data = ctrl; |
| 1017 | 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] | 1018 | bind_addr, port, OSMO_SOCK_F_BIND); |
Harald Welte | 79c137c | 2017-04-16 19:08:49 +0200 | [diff] [blame] | 1019 | if (ret < 0) { |
| 1020 | talloc_free(ctrl); |
| 1021 | return NULL; |
| 1022 | } |
Daniel Willmann | e9f5894 | 2011-04-21 11:43:55 +0200 | [diff] [blame] | 1023 | |
Neels Hofmeyr | 38d232e | 2016-09-19 14:17:30 +0200 | [diff] [blame] | 1024 | LOGP(DLCTRL, LOGL_NOTICE, "CTRL at %s %u\n", bind_addr, port); |
Daniel Willmann | 782974b | 2011-07-22 17:55:42 +0200 | [diff] [blame] | 1025 | return ctrl; |
Daniel Willmann | 1264cb4 | 2010-10-21 15:00:36 +0200 | [diff] [blame] | 1026 | } |
Harald Welte | d6b1f85 | 2017-04-16 16:57:40 +0200 | [diff] [blame] | 1027 | |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 1028 | /*! Setup CTRL interface on a given address. |
| 1029 | * \param[in] data Pointer which will be made available to each |
| 1030 | set_..() get_..() verify_..() control command function |
| 1031 | * \param[in] bind_addr Address on which CTRL socket shall listen |
| 1032 | * \param[in] port Port on which CTRL socket shall listen |
| 1033 | * \param[in] lookup Lookup function pointer, can be NULL |
| 1034 | * \returns ctrl_handle pointer or NULL in case of errors |
| 1035 | */ |
| 1036 | struct ctrl_handle *ctrl_interface_setup_dynip(void *data, |
| 1037 | const char *bind_addr, |
| 1038 | uint16_t port, |
| 1039 | ctrl_cmd_lookup lookup) |
| 1040 | { |
| 1041 | return ctrl_interface_setup_dynip2(data, bind_addr, port, lookup, 0); |
| 1042 | } |
| 1043 | |
Max | 3f79ce8 | 2022-12-03 17:59:19 +0300 | [diff] [blame] | 1044 | /*! Initializes CTRL interface using the configured bind addr/port. |
| 1045 | * \param[in] data Pointer which will be made available to each set_..() get_..() verify_..() control command function |
| 1046 | * \param[in] default_port TCP port number to bind to if not explicitly configured |
| 1047 | * \param[in] lookup Lookup function pointer, can be NULL |
| 1048 | * \param[in] node_count Number of CTRL nodes to allocate, 0 for default. |
| 1049 | */ |
| 1050 | struct ctrl_handle *ctrl_interface_setup2(void *data, uint16_t default_port, ctrl_cmd_lookup lookup, |
| 1051 | unsigned int node_count) |
| 1052 | { |
| 1053 | return ctrl_interface_setup_dynip2(data, ctrl_vty_get_bind_addr(), ctrl_vty_get_bind_port(default_port), lookup, |
| 1054 | node_count); |
| 1055 | } |
Neels Hofmeyr | ea66852 | 2017-10-16 16:18:01 +0200 | [diff] [blame] | 1056 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 1057 | /*! Install a lookup helper function for control nodes |
Harald Welte | d6b1f85 | 2017-04-16 16:57:40 +0200 | [diff] [blame] | 1058 | * This function is used by e.g. library code to install lookup helpers |
| 1059 | * for additional nodes in the control interface. |
| 1060 | * \param[in] lookup The lookup helper function |
Vadim Yanitskiy | 64277a0 | 2023-02-28 03:30:27 +0700 | [diff] [blame] | 1061 | * \returns - on success; negative on error. |
Harald Welte | d6b1f85 | 2017-04-16 16:57:40 +0200 | [diff] [blame] | 1062 | */ |
| 1063 | int ctrl_lookup_register(ctrl_cmd_lookup lookup) |
| 1064 | { |
| 1065 | struct lookup_helper *lh; |
| 1066 | |
| 1067 | /* avoid double registration */ |
| 1068 | llist_for_each_entry(lh, &ctrl_lookup_helpers, list) { |
| 1069 | if (lh->lookup == lookup) |
| 1070 | return -EEXIST; |
| 1071 | } |
| 1072 | |
| 1073 | lh = talloc_zero(NULL, struct lookup_helper); |
| 1074 | if (!lh) |
| 1075 | return -ENOMEM; |
| 1076 | |
| 1077 | lh->lookup = lookup; |
| 1078 | llist_add_tail(&lh->list, &ctrl_lookup_helpers); |
| 1079 | return 0; |
| 1080 | } |
Harald Welte | f85861d | 2017-04-16 19:17:10 +0200 | [diff] [blame] | 1081 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 1082 | /*! Helper for "local execution" of a CTRL command from a string |
Harald Welte | f85861d | 2017-04-16 19:17:10 +0200 | [diff] [blame] | 1083 | * The function will parse + execute the given control command string |
| 1084 | * and return a corresponding ctrl_cmd. Caller is responsible to |
| 1085 | * talloc_free() the return value. |
| 1086 | * \param[in] Control Interface Command String |
| 1087 | * \returns parsed command, including reply; NULL on error */ |
| 1088 | struct ctrl_cmd *ctrl_cmd_exec_from_string(struct ctrl_handle *ch, const char *cmdstr) |
| 1089 | { |
| 1090 | struct msgb *msg = msgb_alloc(1024, "ctrl-cmd"); |
| 1091 | struct ctrl_cmd *cmd; |
| 1092 | |
| 1093 | if (!msg) |
| 1094 | return NULL; |
| 1095 | msg->l2h = msg->data; |
| 1096 | osmo_strlcpy((char *)msg->data, cmdstr, msgb_tailroom(msg)); |
| 1097 | msgb_put(msg, strlen(cmdstr)); |
| 1098 | |
Neels Hofmeyr | c0b0b62 | 2017-12-16 01:12:35 +0100 | [diff] [blame] | 1099 | cmd = ctrl_cmd_parse2(ch, msg); |
Harald Welte | f85861d | 2017-04-16 19:17:10 +0200 | [diff] [blame] | 1100 | msgb_free(msg); |
| 1101 | if (!cmd) |
| 1102 | return NULL; |
Neels Hofmeyr | c0b0b62 | 2017-12-16 01:12:35 +0100 | [diff] [blame] | 1103 | if (cmd->type == CTRL_TYPE_ERROR) |
| 1104 | return cmd; |
| 1105 | if (ctrl_cmd_handle(ch, cmd, NULL) == CTRL_CMD_HANDLED) { |
| 1106 | /* No reply should be sent back. */ |
Harald Welte | f85861d | 2017-04-16 19:17:10 +0200 | [diff] [blame] | 1107 | talloc_free(cmd); |
Neels Hofmeyr | c0b0b62 | 2017-12-16 01:12:35 +0100 | [diff] [blame] | 1108 | cmd = NULL; |
Harald Welte | f85861d | 2017-04-16 19:17:10 +0200 | [diff] [blame] | 1109 | } |
| 1110 | return cmd; |
| 1111 | } |