blob: 5d04cdfd62109caeb2bc6aadde3595b62cfd9365 [file] [log] [blame]
Daniel Willmann1264cb42010-10-21 15:00:36 +02001/* SNMP-like status interface
2 *
3 * (C) 2010-2011 by Daniel Willmann <daniel@totalueberwachung.de>
4 * (C) 2010-2011 by On-Waves
5 *
6 * All Rights Reserved
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 *
22 */
23
Holger Hans Peter Freyther267fd862015-03-18 21:52:38 +010024#include "config.h"
25
Daniel Willmann1264cb42010-10-21 15:00:36 +020026#include <errno.h>
Daniel Willmann0834a342011-07-19 12:12:10 +020027#include <inttypes.h>
Daniel Willmann1264cb42010-10-21 15:00:36 +020028#include <stdio.h>
29#include <stdlib.h>
30#include <string.h>
31#include <time.h>
32#include <unistd.h>
33
34#include <arpa/inet.h>
35
Holger Hans Peter Freyther5e211312014-08-21 16:31:52 +020036#include <netinet/in.h>
Harald Weltee15ac062014-12-04 14:15:36 +010037#ifdef HAVE_NETINET_TCP_H
38#include <netinet/tcp.h>
39#endif
Daniel Willmann1264cb42010-10-21 15:00:36 +020040
Harald Weltee15ac062014-12-04 14:15:36 +010041#include <fcntl.h>
Daniel Willmann1264cb42010-10-21 15:00:36 +020042#include <sys/ioctl.h>
43#include <sys/socket.h>
44#include <sys/types.h>
45
Harald Welte1238cc62014-08-20 19:50:04 +020046#include <osmocom/ctrl/control_cmd.h>
47#include <osmocom/ctrl/control_if.h>
Daniel Willmann1264cb42010-10-21 15:00:36 +020048
49#include <osmocom/core/msgb.h>
Daniel Willmanne9f58942011-04-21 11:43:55 +020050#include <osmocom/core/rate_ctr.h>
Daniel Willmann1264cb42010-10-21 15:00:36 +020051#include <osmocom/core/select.h>
Daniel Willmanne9f58942011-04-21 11:43:55 +020052#include <osmocom/core/statistics.h>
Daniel Willmann1264cb42010-10-21 15:00:36 +020053#include <osmocom/core/talloc.h>
Harald Welte1238cc62014-08-20 19:50:04 +020054#include <osmocom/core/socket.h>
Daniel Willmann1264cb42010-10-21 15:00:36 +020055
Harald Welte1238cc62014-08-20 19:50:04 +020056#include <osmocom/gsm/protocol/ipaccess.h>
Harald Welteacbb4c92014-08-20 22:51:25 +020057#include <osmocom/gsm/ipa.h>
Daniel Willmann1264cb42010-10-21 15:00:36 +020058
59#include <osmocom/vty/command.h>
60#include <osmocom/vty/vector.h>
61
Harald Welte79c137c2017-04-16 19:08:49 +020062extern int osmo_fsm_ctrl_cmds_install(void);
63
Daniel Willmann1264cb42010-10-21 15:00:36 +020064vector ctrl_node_vec;
65
Harald Welted6b1f852017-04-16 16:57:40 +020066/* global list of control interface lookup helpers */
67struct lookup_helper {
68 struct llist_head list;
69 ctrl_cmd_lookup lookup;
70};
71static LLIST_HEAD(ctrl_lookup_helpers);
72
Harald Welte528134b2014-08-21 15:13:08 +020073int ctrl_parse_get_num(vector vline, int i, long *num)
74{
75 char *token, *tmp;
76
77 if (i >= vector_active(vline))
78 return 0;
79 token = vector_slot(vline, i);
80
81 errno = 0;
82 if (token[0] == '\0')
83 return 0;
84
85 *num = strtol(token, &tmp, 10);
86 if (tmp[0] != '\0' || errno != 0)
87 return 0;
88
89 return 1;
90}
91
Daniel Willmann35a1b3b2011-05-06 16:38:11 +020092/* Send command to all */
93int ctrl_cmd_send_to_all(struct ctrl_handle *ctrl, struct ctrl_cmd *cmd)
94{
95 struct ctrl_connection *ccon;
96 int ret = 0;
97
98 llist_for_each_entry(ccon, &ctrl->ccon_list, list_entry) {
99 if (ccon == cmd->ccon)
100 continue;
101 if (ctrl_cmd_send(&ccon->write_queue, cmd))
102 ret++;
103 }
104 return ret;
105}
106
Daniel Willmann1264cb42010-10-21 15:00:36 +0200107int ctrl_cmd_send(struct osmo_wqueue *queue, struct ctrl_cmd *cmd)
108{
109 int ret;
110 struct msgb *msg;
111
112 msg = ctrl_cmd_make(cmd);
113 if (!msg) {
Harald Welte7fd0c832014-08-20 19:58:13 +0200114 LOGP(DLCTRL, LOGL_ERROR, "Could not generate msg\n");
Daniel Willmann1264cb42010-10-21 15:00:36 +0200115 return -1;
116 }
117
Harald Welteacbb4c92014-08-20 22:51:25 +0200118 ipa_prepend_header_ext(msg, IPAC_PROTO_EXT_CTRL);
119 ipa_prepend_header(msg, IPAC_PROTO_OSMO);
Daniel Willmann1264cb42010-10-21 15:00:36 +0200120
121 ret = osmo_wqueue_enqueue(queue, msg);
122 if (ret != 0) {
Harald Welte7fd0c832014-08-20 19:58:13 +0200123 LOGP(DLCTRL, LOGL_ERROR, "Failed to enqueue the command.\n");
Daniel Willmann1264cb42010-10-21 15:00:36 +0200124 msgb_free(msg);
125 }
126 return ret;
127}
128
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200129/*! Send TRAP over given Control Interface
Maxbc067eb2016-08-04 11:07:08 +0200130 * \param[in] ctrl Control Interface over which TRAP will be sent
131 * \param[in] name Name of the TRAP variable
132 * \param[in] value Value of the TRAP variable
133 * \return Negative value on error, result of ctrl_cmd_send_to_all() otherwise
134 */
135int ctrl_cmd_send_trap(struct ctrl_handle *ctrl, const char *name, char *value)
136{
137 int r;
138 struct ctrl_cmd *cmd = ctrl_cmd_create(NULL, CTRL_TYPE_TRAP);
139 if (!cmd)
140 return -ENOMEM;
141
142 cmd->id = "0"; /* It's a TRAP! */
Harald Weltef12d40f2017-02-08 15:46:53 +0000143 cmd->variable = (char *) name;
Maxbc067eb2016-08-04 11:07:08 +0200144 cmd->reply = value;
145 r = ctrl_cmd_send_to_all(ctrl, cmd);
146 talloc_free(cmd);
147 return r;
148}
149
Daniel Willmannf2e75d42011-07-22 18:08:31 +0200150struct ctrl_cmd *ctrl_cmd_trap(struct ctrl_cmd *cmd)
151{
152 struct ctrl_cmd *trap;
153
Harald Weltec9df37d2014-08-20 19:55:17 +0200154 trap = ctrl_cmd_cpy(cmd, cmd);
Daniel Willmannf2e75d42011-07-22 18:08:31 +0200155 if (!trap)
156 return NULL;
157
158 trap->ccon = cmd->ccon;
159 trap->type = CTRL_TYPE_TRAP;
160 return trap;
161}
162
Daniel Willmann1264cb42010-10-21 15:00:36 +0200163static void control_close_conn(struct ctrl_connection *ccon)
164{
Harald Welte39c9e7b2014-08-22 00:28:51 +0200165 struct ctrl_cmd_def *cd, *cd2;
166
Harald Welte6d96dd72013-03-16 10:13:04 +0100167 osmo_wqueue_clear(&ccon->write_queue);
Daniel Willmann1264cb42010-10-21 15:00:36 +0200168 close(ccon->write_queue.bfd.fd);
169 osmo_fd_unregister(&ccon->write_queue.bfd);
Daniel Willmann0e0cf372011-05-06 16:37:25 +0200170 llist_del(&ccon->list_entry);
Daniel Willmann1264cb42010-10-21 15:00:36 +0200171 if (ccon->closed_cb)
172 ccon->closed_cb(ccon);
Jacob Erlbeck141de622014-03-31 13:42:11 +0200173 msgb_free(ccon->pending_msg);
Harald Welte39c9e7b2014-08-22 00:28:51 +0200174
175 /* clean up deferred commands */
176 llist_for_each_entry_safe(cd, cd2, &ccon->def_cmds, list) {
177 /* delete from list of def_cmds for this ccon */
178 llist_del(&cd->list);
179 /* not strictly needed as this is a slave to the ccon which we
180 * are about to free anyway */
181 talloc_free(cd->cmd);
182 /* set the CMD to null, this is the indication to the user that
183 * the connection for this command has gone */
184 cd->cmd = NULL;
185 }
186
Daniel Willmann1264cb42010-10-21 15:00:36 +0200187 talloc_free(ccon);
188}
189
Harald Welte528134b2014-08-21 15:13:08 +0200190int ctrl_cmd_handle(struct ctrl_handle *ctrl, struct ctrl_cmd *cmd,
191 void *data)
192{
193 char *request;
194 int i, j, ret, node;
Max33c7ba62017-05-02 16:24:12 +0200195 bool break_cycle = false;
Harald Welte528134b2014-08-21 15:13:08 +0200196 vector vline, cmdvec, cmds_vec;
197
Max2ed36592017-02-24 14:48:45 +0100198 if (cmd->type == CTRL_TYPE_SET_REPLY ||
199 cmd->type == CTRL_TYPE_GET_REPLY) {
200 if (strncmp(cmd->reply, "OK", 2) == 0) {
201 LOGP(DLCTRL, LOGL_DEBUG, "%s <%s> for %s is OK\n",
202 get_value_string(ctrl_type_vals, cmd->type),
203 cmd->id, cmd->variable);
204 return CTRL_CMD_HANDLED;
205 }
206 }
207
208 if (cmd->type == CTRL_TYPE_ERROR) {
209 LOGP(DLCTRL, LOGL_ERROR, "%s <%s> for %s is %s\n",
210 get_value_string(ctrl_type_vals, cmd->type),
211 cmd->id, cmd->variable, cmd->reply);
212 return CTRL_CMD_HANDLED;
213 }
214
Harald Welte528134b2014-08-21 15:13:08 +0200215 ret = CTRL_CMD_ERROR;
216 cmd->reply = NULL;
217 node = CTRL_NODE_ROOT;
218 cmd->node = data;
219
220 request = talloc_strdup(cmd, cmd->variable);
221 if (!request)
222 goto err;
223
224 for (i=0;i<strlen(request);i++) {
225 if (request[i] == '.')
226 request[i] = ' ';
227 }
228
229 vline = cmd_make_strvec(request);
230 talloc_free(request);
231 if (!vline) {
232 cmd->reply = "cmd_make_strvec failed.";
233 goto err;
234 }
235
236 for (i=0;i<vector_active(vline);i++) {
Harald Welted6b1f852017-04-16 16:57:40 +0200237 struct lookup_helper *lh;
Harald Welte528134b2014-08-21 15:13:08 +0200238 int rc;
239
240 if (ctrl->lookup)
241 rc = ctrl->lookup(data, vline, &node, &cmd->node, &i);
242 else
243 rc = 0;
244
Harald Welted6b1f852017-04-16 16:57:40 +0200245 if (!rc) {
246 llist_for_each_entry(lh, &ctrl_lookup_helpers, list) {
247 rc = lh->lookup(data, vline, &node, &cmd->node, &i);
248 if (rc)
249 break;
250 }
251 }
252
Max33c7ba62017-05-02 16:24:12 +0200253 switch (rc) {
254 case 1: /* do nothing */
255 break;
256 case -ENODEV:
257 cmd_free_strvec(vline);
258 cmd->type = CTRL_TYPE_ERROR;
259 cmd->reply = "Error while resolving object";
260 return ret;
261 case -ERANGE:
262 cmd_free_strvec(vline);
263 cmd->type = CTRL_TYPE_ERROR;
264 cmd->reply = "Error while parsing the index.";
265 return ret;
266 default: /* If we're here the rest must be the command */
Harald Welte528134b2014-08-21 15:13:08 +0200267 cmdvec = vector_init(vector_active(vline)-i);
268 for (j=i; j<vector_active(vline); j++) {
269 vector_set(cmdvec, vector_slot(vline, j));
270 }
271
272 /* Get the command vector of the right node */
273 cmds_vec = vector_lookup(ctrl_node_vec, node);
274
275 if (!cmds_vec) {
276 cmd->reply = "Command not found.";
277 vector_free(cmdvec);
278 break;
279 }
280
281 ret = ctrl_cmd_exec(cmdvec, cmd, cmds_vec, data);
Harald Welte528134b2014-08-21 15:13:08 +0200282 vector_free(cmdvec);
Max33c7ba62017-05-02 16:24:12 +0200283 break_cycle = true;
Harald Welte528134b2014-08-21 15:13:08 +0200284 break;
285 }
286
Max33c7ba62017-05-02 16:24:12 +0200287 if (break_cycle)
288 break;
289
Harald Welte528134b2014-08-21 15:13:08 +0200290 if (i+1 == vector_active(vline))
291 cmd->reply = "Command not present.";
292 }
293
294 cmd_free_strvec(vline);
295
296err:
297 if (!cmd->reply) {
298 if (ret == CTRL_CMD_ERROR) {
Thorsten Alteholza81055d2017-03-02 22:13:48 +0100299 cmd->reply = "An error has occurred.";
Harald Welte528134b2014-08-21 15:13:08 +0200300 LOGP(DLCTRL, LOGL_NOTICE,
301 "%s: cmd->reply has not been set (ERROR).\n",
302 cmd->variable);
303 } else if (ret == CTRL_CMD_REPLY) {
304 LOGP(DLCTRL, LOGL_NOTICE,
305 "%s: cmd->reply has not been set (type = %d).\n",
306 cmd->variable, cmd->type);
307 cmd->reply = "";
308 } else {
309 cmd->reply = "Command has been handled.";
310 }
311 }
312
313 if (ret == CTRL_CMD_ERROR)
314 cmd->type = CTRL_TYPE_ERROR;
315 return ret;
Harald Welte528134b2014-08-21 15:13:08 +0200316}
317
318
Daniel Willmann1264cb42010-10-21 15:00:36 +0200319static int handle_control_read(struct osmo_fd * bfd)
320{
Pablo Neira Ayuso10dfc262011-08-17 22:44:07 +0200321 int ret = -1;
Daniel Willmann1264cb42010-10-21 15:00:36 +0200322 struct osmo_wqueue *queue;
323 struct ctrl_connection *ccon;
324 struct ipaccess_head *iph;
325 struct ipaccess_head_ext *iph_ext;
Alexander Huemer1d3634e2011-10-12 00:29:30 +0200326 struct msgb *msg = NULL;
Daniel Willmann1264cb42010-10-21 15:00:36 +0200327 struct ctrl_cmd *cmd;
328 struct ctrl_handle *ctrl = bfd->data;
329
330 queue = container_of(bfd, struct osmo_wqueue, bfd);
331 ccon = container_of(queue, struct ctrl_connection, write_queue);
332
Jacob Erlbeck141de622014-03-31 13:42:11 +0200333 ret = ipa_msg_recv_buffered(bfd->fd, &msg, &ccon->pending_msg);
Pablo Neira Ayuso10dfc262011-08-17 22:44:07 +0200334 if (ret <= 0) {
Jacob Erlbeck141de622014-03-31 13:42:11 +0200335 if (ret == -EAGAIN)
336 return 0;
Pablo Neira Ayuso10dfc262011-08-17 22:44:07 +0200337 if (ret == 0)
Harald Welte7fd0c832014-08-20 19:58:13 +0200338 LOGP(DLCTRL, LOGL_INFO, "The control connection was closed\n");
Daniel Willmann1264cb42010-10-21 15:00:36 +0200339 else
Harald Welte7fd0c832014-08-20 19:58:13 +0200340 LOGP(DLCTRL, LOGL_ERROR, "Failed to parse ip access message: %d\n", ret);
Daniel Willmann1264cb42010-10-21 15:00:36 +0200341
342 goto err;
343 }
344
345 if (msg->len < sizeof(*iph) + sizeof(*iph_ext)) {
Harald Welte7fd0c832014-08-20 19:58:13 +0200346 LOGP(DLCTRL, LOGL_ERROR, "The message is too short.\n");
Daniel Willmann1264cb42010-10-21 15:00:36 +0200347 goto err;
348 }
349
350 iph = (struct ipaccess_head *) msg->data;
351 if (iph->proto != IPAC_PROTO_OSMO) {
Harald Welte7fd0c832014-08-20 19:58:13 +0200352 LOGP(DLCTRL, LOGL_ERROR, "Protocol mismatch. We got 0x%x\n", iph->proto);
Daniel Willmann1264cb42010-10-21 15:00:36 +0200353 goto err;
354 }
355
356 iph_ext = (struct ipaccess_head_ext *) iph->data;
357 if (iph_ext->proto != IPAC_PROTO_EXT_CTRL) {
Harald Welte7fd0c832014-08-20 19:58:13 +0200358 LOGP(DLCTRL, LOGL_ERROR, "Extended protocol mismatch. We got 0x%x\n", iph_ext->proto);
Daniel Willmann1264cb42010-10-21 15:00:36 +0200359 goto err;
360 }
361
362 msg->l2h = iph_ext->data;
363
364 cmd = ctrl_cmd_parse(ccon, msg);
365
366 if (cmd) {
367 cmd->ccon = ccon;
Harald Welte528134b2014-08-21 15:13:08 +0200368 if (ctrl_cmd_handle(ctrl, cmd, ctrl->data) != CTRL_CMD_HANDLED) {
Daniel Willmann1264cb42010-10-21 15:00:36 +0200369 ctrl_cmd_send(queue, cmd);
370 talloc_free(cmd);
371 }
372 } else {
373 cmd = talloc_zero(ccon, struct ctrl_cmd);
374 if (!cmd)
375 goto err;
Harald Welte7fd0c832014-08-20 19:58:13 +0200376 LOGP(DLCTRL, LOGL_ERROR, "Command parser error.\n");
Daniel Willmann1264cb42010-10-21 15:00:36 +0200377 cmd->type = CTRL_TYPE_ERROR;
378 cmd->id = "err";
379 cmd->reply = "Command parser error.";
380 ctrl_cmd_send(queue, cmd);
381 talloc_free(cmd);
382 }
383
384 msgb_free(msg);
385 return 0;
386
387err:
388 control_close_conn(ccon);
389 msgb_free(msg);
390 return ret;
391}
392
393static int control_write_cb(struct osmo_fd *bfd, struct msgb *msg)
394{
395 int rc;
396
397 rc = write(bfd->fd, msg->data, msg->len);
398 if (rc != msg->len)
Harald Welte7fd0c832014-08-20 19:58:13 +0200399 LOGP(DLCTRL, LOGL_ERROR, "Failed to write message to the control connection.\n");
Daniel Willmann1264cb42010-10-21 15:00:36 +0200400
401 return rc;
402}
403
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200404/*! Allocate CTRL connection
Maxfa9e05e2017-02-20 11:53:11 +0100405 * \param[in] ctx Context from which talloc should allocate it
406 * \param[in] data caller's private data parameter which should assigned to
407 write queue's file descriptor data parameter.
408 * \return Allocated CTRL connection structure or NULL in case of errors
409 */
410struct ctrl_connection *osmo_ctrl_conn_alloc(void *ctx, void *data)
Daniel Willmann1264cb42010-10-21 15:00:36 +0200411{
412 struct ctrl_connection *ccon = talloc_zero(ctx, struct ctrl_connection);
413 if (!ccon)
414 return NULL;
415
416 osmo_wqueue_init(&ccon->write_queue, 100);
417 /* Error handling here? */
418
419 INIT_LLIST_HEAD(&ccon->cmds);
Harald Welte39c9e7b2014-08-22 00:28:51 +0200420 INIT_LLIST_HEAD(&ccon->def_cmds);
421
Maxfa9e05e2017-02-20 11:53:11 +0100422 ccon->write_queue.bfd.data = data;
423 ccon->write_queue.write_cb = control_write_cb;
Max9756c462017-02-24 13:03:32 +0100424 ccon->write_queue.read_cb = handle_control_read;
Maxfa9e05e2017-02-20 11:53:11 +0100425
Daniel Willmann1264cb42010-10-21 15:00:36 +0200426 return ccon;
427}
428
429static int listen_fd_cb(struct osmo_fd *listen_bfd, unsigned int what)
430{
431 int ret, fd, on;
Daniel Willmann0e0cf372011-05-06 16:37:25 +0200432 struct ctrl_handle *ctrl;
Daniel Willmann1264cb42010-10-21 15:00:36 +0200433 struct ctrl_connection *ccon;
434 struct sockaddr_in sa;
435 socklen_t sa_len = sizeof(sa);
436
437
438 if (!(what & BSC_FD_READ))
439 return 0;
440
441 fd = accept(listen_bfd->fd, (struct sockaddr *) &sa, &sa_len);
442 if (fd < 0) {
443 perror("accept");
444 return fd;
445 }
Harald Welte7fd0c832014-08-20 19:58:13 +0200446 LOGP(DLCTRL, LOGL_INFO, "accept()ed new control connection from %s\n",
Daniel Willmann1264cb42010-10-21 15:00:36 +0200447 inet_ntoa(sa.sin_addr));
448
Harald Weltee15ac062014-12-04 14:15:36 +0100449#ifdef TCP_NODELAY
Daniel Willmann1264cb42010-10-21 15:00:36 +0200450 on = 1;
451 ret = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof(on));
452 if (ret != 0) {
Harald Welte7fd0c832014-08-20 19:58:13 +0200453 LOGP(DLCTRL, LOGL_ERROR, "Failed to set TCP_NODELAY: %s\n", strerror(errno));
Daniel Willmann1264cb42010-10-21 15:00:36 +0200454 close(fd);
455 return ret;
456 }
Harald Weltee15ac062014-12-04 14:15:36 +0100457#endif
Maxfa9e05e2017-02-20 11:53:11 +0100458 ctrl = listen_bfd->data;
459 ccon = osmo_ctrl_conn_alloc(listen_bfd->data, ctrl);
Daniel Willmann1264cb42010-10-21 15:00:36 +0200460 if (!ccon) {
Harald Welte7fd0c832014-08-20 19:58:13 +0200461 LOGP(DLCTRL, LOGL_ERROR, "Failed to allocate.\n");
Daniel Willmann1264cb42010-10-21 15:00:36 +0200462 close(fd);
463 return -1;
464 }
465
Daniel Willmann1264cb42010-10-21 15:00:36 +0200466 ccon->write_queue.bfd.fd = fd;
467 ccon->write_queue.bfd.when = BSC_FD_READ;
Daniel Willmann1264cb42010-10-21 15:00:36 +0200468
469 ret = osmo_fd_register(&ccon->write_queue.bfd);
470 if (ret < 0) {
Harald Welte7fd0c832014-08-20 19:58:13 +0200471 LOGP(DLCTRL, LOGL_ERROR, "Could not register FD.\n");
Daniel Willmann1264cb42010-10-21 15:00:36 +0200472 close(ccon->write_queue.bfd.fd);
473 talloc_free(ccon);
474 }
475
Daniel Willmann0e0cf372011-05-06 16:37:25 +0200476 llist_add(&ccon->list_entry, &ctrl->ccon_list);
477
Daniel Willmann1264cb42010-10-21 15:00:36 +0200478 return ret;
479}
480
Daniel Willmanne9f58942011-04-21 11:43:55 +0200481static uint64_t get_rate_ctr_value(const struct rate_ctr *ctr, int intv)
482{
483 if (intv >= RATE_CTR_INTV_NUM)
484 return 0;
485
486 /* Absolute value */
487 if (intv == -1) {
488 return ctr->current;
489 } else {
490 return ctr->intv[intv].rate;
491 }
492}
493
Harald Weltec9df37d2014-08-20 19:55:17 +0200494static char *get_all_rate_ctr_in_group(void *ctx, const struct rate_ctr_group *ctrg, int intv)
Daniel Willmanne9f58942011-04-21 11:43:55 +0200495{
496 int i;
Harald Weltec9df37d2014-08-20 19:55:17 +0200497 char *counters = talloc_strdup(ctx, "");
Daniel Willmanne9f58942011-04-21 11:43:55 +0200498 if (!counters)
499 return NULL;
500
501 for (i=0;i<ctrg->desc->num_ctr;i++) {
Daniel Willmann0834a342011-07-19 12:12:10 +0200502 counters = talloc_asprintf_append(counters, "\n%s.%u.%s %"PRIu64,
Daniel Willmanne9f58942011-04-21 11:43:55 +0200503 ctrg->desc->group_name_prefix, ctrg->idx,
504 ctrg->desc->ctr_desc[i].name,
505 get_rate_ctr_value(&ctrg->ctr[i], intv));
506 if (!counters)
507 return NULL;
508 }
509 return counters;
510}
511
Daniel Willmanne9f58942011-04-21 11:43:55 +0200512static int get_rate_ctr_group_idx(const struct rate_ctr_group *ctrg, int intv, struct ctrl_cmd *cmd)
513{
514 char *counters;
515
Harald Weltec9df37d2014-08-20 19:55:17 +0200516 counters = get_all_rate_ctr_in_group(cmd, ctrg, intv);
Daniel Willmanne9f58942011-04-21 11:43:55 +0200517 if (!counters)
518 goto oom;
519
520 cmd->reply = talloc_asprintf(cmd, "All counters in %s.%u%s",
521 ctrg->desc->group_name_prefix, ctrg->idx, counters);
522 talloc_free(counters);
523 if (!cmd->reply)
524 goto oom;
525
526 return CTRL_CMD_REPLY;
527oom:
528 cmd->reply = "OOM.";
529 return CTRL_CMD_ERROR;
530}
531
532/* rate_ctr */
533CTRL_CMD_DEFINE(rate_ctr, "rate_ctr *");
Daniel Willmannf7c74e52011-08-05 11:48:18 +0200534static int get_rate_ctr(struct ctrl_cmd *cmd, void *data)
Daniel Willmanne9f58942011-04-21 11:43:55 +0200535{
536 int intv;
537 unsigned int idx;
Neels Hofmeyr5b34f772016-09-19 14:15:03 +0200538 char *ctr_group, *ctr_idx, *tmp, *dup, *saveptr, *interval;
Daniel Willmanne9f58942011-04-21 11:43:55 +0200539 struct rate_ctr_group *ctrg;
540 const struct rate_ctr *ctr;
541
542 dup = talloc_strdup(cmd, cmd->variable);
543 if (!dup)
544 goto oom;
545
546 /* Skip over possible prefixes (net.) */
547 tmp = strstr(dup, "rate_ctr");
548 if (!tmp) {
549 talloc_free(dup);
550 cmd->reply = "rate_ctr not a token in rate_ctr command!";
551 goto err;
552 }
553
554 strtok_r(tmp, ".", &saveptr);
555 interval = strtok_r(NULL, ".", &saveptr);
556 if (!interval) {
557 talloc_free(dup);
558 cmd->reply = "Missing interval.";
559 goto err;
560 }
561
562 if (!strcmp(interval, "abs")) {
563 intv = -1;
564 } else if (!strcmp(interval, "per_sec")) {
565 intv = RATE_CTR_INTV_SEC;
566 } else if (!strcmp(interval, "per_min")) {
567 intv = RATE_CTR_INTV_MIN;
568 } else if (!strcmp(interval, "per_hour")) {
569 intv = RATE_CTR_INTV_HOUR;
570 } else if (!strcmp(interval, "per_day")) {
571 intv = RATE_CTR_INTV_DAY;
572 } else {
573 talloc_free(dup);
574 cmd->reply = "Wrong interval.";
575 goto err;
576 }
577
578 ctr_group = strtok_r(NULL, ".", &saveptr);
Max22886d92016-06-14 18:17:06 +0200579 ctr_idx = strtok_r(NULL, ".", &saveptr);
580 if (!ctr_group || !ctr_idx) {
Daniel Willmanne9f58942011-04-21 11:43:55 +0200581 talloc_free(dup);
Max22886d92016-06-14 18:17:06 +0200582 cmd->reply = "Counter group must be of name.index form e. g. "
583 "e1inp.0";
Daniel Willmanne9f58942011-04-21 11:43:55 +0200584 goto err;
585 }
Daniel Willmanne9f58942011-04-21 11:43:55 +0200586
Daniel Willmanne9f58942011-04-21 11:43:55 +0200587 idx = atoi(ctr_idx);
588
589 ctrg = rate_ctr_get_group_by_name_idx(ctr_group, idx);
590 if (!ctrg) {
591 talloc_free(dup);
Max22886d92016-06-14 18:17:06 +0200592 cmd->reply = "Counter group with given name and index not found";
Daniel Willmanne9f58942011-04-21 11:43:55 +0200593 goto err;
594 }
595
Max22886d92016-06-14 18:17:06 +0200596 if (!strlen(saveptr)) {
Daniel Willmanne9f58942011-04-21 11:43:55 +0200597 talloc_free(dup);
598 return get_rate_ctr_group_idx(ctrg, intv, cmd);
599 }
600
Max22886d92016-06-14 18:17:06 +0200601 ctr = rate_ctr_get_by_name(ctrg, saveptr);
Daniel Willmanne9f58942011-04-21 11:43:55 +0200602 if (!ctr) {
603 cmd->reply = "Counter name not found.";
604 talloc_free(dup);
605 goto err;
606 }
607
608 talloc_free(dup);
609
Holger Hans Peter Freytherad6451f2012-03-16 12:18:39 +0100610 cmd->reply = talloc_asprintf(cmd, "%"PRIu64, get_rate_ctr_value(ctr, intv));
Daniel Willmanne9f58942011-04-21 11:43:55 +0200611 if (!cmd->reply)
612 goto oom;
613
614 return CTRL_CMD_REPLY;
615oom:
616 cmd->reply = "OOM";
617err:
618 return CTRL_CMD_ERROR;
619}
620
Daniel Willmannf7c74e52011-08-05 11:48:18 +0200621static int set_rate_ctr(struct ctrl_cmd *cmd, void *data)
Daniel Willmanne9f58942011-04-21 11:43:55 +0200622{
623 cmd->reply = "Can't set rate counter.";
624
625 return CTRL_CMD_ERROR;
626}
627
Daniel Willmannf7c74e52011-08-05 11:48:18 +0200628static int verify_rate_ctr(struct ctrl_cmd *cmd, const char *value, void *data)
Daniel Willmanne9f58942011-04-21 11:43:55 +0200629{
630 return 0;
631}
632
633/* counter */
634CTRL_CMD_DEFINE(counter, "counter *");
Daniel Willmannf7c74e52011-08-05 11:48:18 +0200635static int get_counter(struct ctrl_cmd *cmd, void *data)
Daniel Willmanne9f58942011-04-21 11:43:55 +0200636{
637 char *ctr_name, *tmp, *dup, *saveptr;
638 struct osmo_counter *counter;
639
640 cmd->reply = "OOM";
641 dup = talloc_strdup(cmd, cmd->variable);
642 if (!dup)
643 goto err;
644
645
646 tmp = strstr(dup, "counter");
647 if (!tmp) {
648 talloc_free(dup);
649 goto err;
650 }
651
652 strtok_r(tmp, ".", &saveptr);
653 ctr_name = strtok_r(NULL, "\0", &saveptr);
654
655 if (!ctr_name)
656 goto err;
657
658 counter = osmo_counter_get_by_name(ctr_name);
659 if (!counter) {
660 cmd->reply = "Counter name not found.";
661 talloc_free(dup);
662 goto err;
663 }
664
665 talloc_free(dup);
666
667 cmd->reply = talloc_asprintf(cmd, "%lu", counter->value);
668 if (!cmd->reply) {
669 cmd->reply = "OOM";
670 goto err;
671 }
672
673 return CTRL_CMD_REPLY;
674err:
675 return CTRL_CMD_ERROR;
676}
677
Daniel Willmannf7c74e52011-08-05 11:48:18 +0200678static int set_counter(struct ctrl_cmd *cmd, void *data)
Daniel Willmanne9f58942011-04-21 11:43:55 +0200679{
680
681 cmd->reply = "Can't set counter.";
682
683 return CTRL_CMD_ERROR;
684}
685
Daniel Willmannf7c74e52011-08-05 11:48:18 +0200686static int verify_counter(struct ctrl_cmd *cmd, const char *value, void *data)
Daniel Willmanne9f58942011-04-21 11:43:55 +0200687{
688 return 0;
689}
690
Harald Welteae2fcb22014-08-21 15:20:00 +0200691struct ctrl_handle *ctrl_interface_setup(void *data, uint16_t port,
692 ctrl_cmd_lookup lookup)
Daniel Willmann1264cb42010-10-21 15:00:36 +0200693{
Neels Hofmeyr49343092016-02-24 00:09:40 +0100694 return ctrl_interface_setup_dynip(data, "127.0.0.1", port, lookup);
695}
696
Harald Welte79c137c2017-04-16 19:08:49 +0200697static int ctrl_initialized = 0;
698
699/* global ctrl initialization */
700static int ctrl_init(void)
701{
702 int ret;
703
704 if (ctrl_initialized)
705 return 0;
706
Harald Welte0b2f7152017-04-16 19:49:24 +0200707 ctrl_node_vec = vector_init(_LAST_CTRL_NODE);
Harald Welte79c137c2017-04-16 19:08:49 +0200708 if (!ctrl_node_vec)
709 goto err;
710
711 ret = ctrl_cmd_install(CTRL_NODE_ROOT, &cmd_rate_ctr);
712 if (ret)
713 goto err_vec;
714 ret = ctrl_cmd_install(CTRL_NODE_ROOT, &cmd_counter);
715 if (ret)
716 goto err_vec;
717
Harald Welte31c0fef2017-04-16 17:26:30 +0200718 ret = osmo_fsm_ctrl_cmds_install();
719 if (ret)
720 goto err_vec;
721
Harald Welte79c137c2017-04-16 19:08:49 +0200722 ctrl_initialized = 1;
723 return 0;
724
725err_vec:
726 vector_free(ctrl_node_vec);
727 ctrl_node_vec = NULL;
728err:
729 return -1;
730}
731
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200732/*! Allocate a CTRL interface handle
Harald Welte79c137c2017-04-16 19:08:49 +0200733 * \param[in] ctx Tallo callocation context to be used
734 * \param[in] data Pointer which will be made available to each
735 set_..() get_..() verify_..() control command function
736 * \param[in] lookup Lookup function pointer, can be NULL
737 * \returns ctrl_handle pointer or NULL in case of errors
738 */
739struct ctrl_handle *ctrl_handle_alloc(void *ctx, void *data, ctrl_cmd_lookup lookup)
740{
741 struct ctrl_handle *ctrl;
742
743 ctrl_init();
744
745 ctrl = talloc_zero(ctx, struct ctrl_handle);
746 if (!ctrl)
747 return NULL;
748
749 INIT_LLIST_HEAD(&ctrl->ccon_list);
750
751 ctrl->data = data;
752 ctrl->lookup = lookup;
753
754 return ctrl;
755}
756
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200757/*! Setup CTRL interface on a given address
Max32ee5af2017-02-16 17:44:09 +0100758 * \param[in] data Pointer which will be made available to each
759 set_..() get_..() verify_..() control command function
760 * \param[in] bind_addr Address on which CTRL socket shall listen
761 * \param[in] port Port on which CTRL socket shall listen
762 * \param[in] lookup Lookup function pointer, can be NULL
763 * \returns ctrl_handle pointer or NULL in case of errors
764 */
Neels Hofmeyr49343092016-02-24 00:09:40 +0100765struct ctrl_handle *ctrl_interface_setup_dynip(void *data,
766 const char *bind_addr,
767 uint16_t port,
768 ctrl_cmd_lookup lookup)
769{
Daniel Willmann1264cb42010-10-21 15:00:36 +0200770 int ret;
771 struct ctrl_handle *ctrl;
772
Harald Welte79c137c2017-04-16 19:08:49 +0200773 ctrl = ctrl_handle_alloc(data, data, lookup);
Daniel Willmann1264cb42010-10-21 15:00:36 +0200774 if (!ctrl)
Daniel Willmann782974b2011-07-22 17:55:42 +0200775 return NULL;
Daniel Willmann1264cb42010-10-21 15:00:36 +0200776
Daniel Willmann1264cb42010-10-21 15:00:36 +0200777 /* Listen for control connections */
Harald Welte1238cc62014-08-20 19:50:04 +0200778 ctrl->listen_fd.cb = listen_fd_cb;
779 ctrl->listen_fd.data = ctrl;
780 ret = osmo_sock_init_ofd(&ctrl->listen_fd, AF_INET, SOCK_STREAM, IPPROTO_TCP,
Neels Hofmeyr49343092016-02-24 00:09:40 +0100781 bind_addr, port, OSMO_SOCK_F_BIND);
Harald Welte79c137c2017-04-16 19:08:49 +0200782 if (ret < 0) {
783 talloc_free(ctrl);
784 return NULL;
785 }
Daniel Willmanne9f58942011-04-21 11:43:55 +0200786
Neels Hofmeyr38d232e2016-09-19 14:17:30 +0200787 LOGP(DLCTRL, LOGL_NOTICE, "CTRL at %s %u\n", bind_addr, port);
Daniel Willmann782974b2011-07-22 17:55:42 +0200788 return ctrl;
Daniel Willmann1264cb42010-10-21 15:00:36 +0200789}
Harald Welted6b1f852017-04-16 16:57:40 +0200790
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200791/*! Install a lookup helper function for control nodes
Harald Welted6b1f852017-04-16 16:57:40 +0200792 * This function is used by e.g. library code to install lookup helpers
793 * for additional nodes in the control interface.
794 * \param[in] lookup The lookup helper function
795 * \retuns - on success; negative on error.
796 */
797int ctrl_lookup_register(ctrl_cmd_lookup lookup)
798{
799 struct lookup_helper *lh;
800
801 /* avoid double registration */
802 llist_for_each_entry(lh, &ctrl_lookup_helpers, list) {
803 if (lh->lookup == lookup)
804 return -EEXIST;
805 }
806
807 lh = talloc_zero(NULL, struct lookup_helper);
808 if (!lh)
809 return -ENOMEM;
810
811 lh->lookup = lookup;
812 llist_add_tail(&lh->list, &ctrl_lookup_helpers);
813 return 0;
814}
Harald Weltef85861d2017-04-16 19:17:10 +0200815
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200816/*! Helper for "local execution" of a CTRL command from a string
Harald Weltef85861d2017-04-16 19:17:10 +0200817 * The function will parse + execute the given control command string
818 * and return a corresponding ctrl_cmd. Caller is responsible to
819 * talloc_free() the return value.
820 * \param[in] Control Interface Command String
821 * \returns parsed command, including reply; NULL on error */
822struct ctrl_cmd *ctrl_cmd_exec_from_string(struct ctrl_handle *ch, const char *cmdstr)
823{
824 struct msgb *msg = msgb_alloc(1024, "ctrl-cmd");
825 struct ctrl_cmd *cmd;
826
827 if (!msg)
828 return NULL;
829 msg->l2h = msg->data;
830 osmo_strlcpy((char *)msg->data, cmdstr, msgb_tailroom(msg));
831 msgb_put(msg, strlen(cmdstr));
832
833 cmd = ctrl_cmd_parse(ch, msg);
834 msgb_free(msg);
835 if (!cmd)
836 return NULL;
837 if (ctrl_cmd_handle(ch, cmd, NULL) < 0) {
838 talloc_free(cmd);
839 return NULL;
840 }
841 return cmd;
842}