blob: 6ab34c7b1c78b166df4281eb40c15028f4e074ca [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
Maxbc067eb2016-08-04 11:07:08 +0200129/*! \brief Send TRAP over given Control Interface
130 * \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;
195
196 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
Harald Welte528134b2014-08-21 15:13:08 +0200253 if (rc == 1) {
254 /* do nothing */
255 } else if (rc == -ENODEV)
256 goto err_missing;
257 else if (rc == -ERANGE)
258 goto err_index;
259 else {
260 /* If we're here the rest must be the command */
261 cmdvec = vector_init(vector_active(vline)-i);
262 for (j=i; j<vector_active(vline); j++) {
263 vector_set(cmdvec, vector_slot(vline, j));
264 }
265
266 /* Get the command vector of the right node */
267 cmds_vec = vector_lookup(ctrl_node_vec, node);
268
269 if (!cmds_vec) {
270 cmd->reply = "Command not found.";
271 vector_free(cmdvec);
272 break;
273 }
274
275 ret = ctrl_cmd_exec(cmdvec, cmd, cmds_vec, data);
276
277 vector_free(cmdvec);
278 break;
279 }
280
281 if (i+1 == vector_active(vline))
282 cmd->reply = "Command not present.";
283 }
284
285 cmd_free_strvec(vline);
286
287err:
288 if (!cmd->reply) {
289 if (ret == CTRL_CMD_ERROR) {
Thorsten Alteholza81055d2017-03-02 22:13:48 +0100290 cmd->reply = "An error has occurred.";
Harald Welte528134b2014-08-21 15:13:08 +0200291 LOGP(DLCTRL, LOGL_NOTICE,
292 "%s: cmd->reply has not been set (ERROR).\n",
293 cmd->variable);
294 } else if (ret == CTRL_CMD_REPLY) {
295 LOGP(DLCTRL, LOGL_NOTICE,
296 "%s: cmd->reply has not been set (type = %d).\n",
297 cmd->variable, cmd->type);
298 cmd->reply = "";
299 } else {
300 cmd->reply = "Command has been handled.";
301 }
302 }
303
304 if (ret == CTRL_CMD_ERROR)
305 cmd->type = CTRL_TYPE_ERROR;
306 return ret;
307
308err_missing:
309 cmd_free_strvec(vline);
310 cmd->type = CTRL_TYPE_ERROR;
311 cmd->reply = "Error while resolving object";
312 return ret;
313err_index:
314 cmd_free_strvec(vline);
315 cmd->type = CTRL_TYPE_ERROR;
316 cmd->reply = "Error while parsing the index.";
317 return ret;
318}
319
320
Daniel Willmann1264cb42010-10-21 15:00:36 +0200321static int handle_control_read(struct osmo_fd * bfd)
322{
Pablo Neira Ayuso10dfc262011-08-17 22:44:07 +0200323 int ret = -1;
Daniel Willmann1264cb42010-10-21 15:00:36 +0200324 struct osmo_wqueue *queue;
325 struct ctrl_connection *ccon;
326 struct ipaccess_head *iph;
327 struct ipaccess_head_ext *iph_ext;
Alexander Huemer1d3634e2011-10-12 00:29:30 +0200328 struct msgb *msg = NULL;
Daniel Willmann1264cb42010-10-21 15:00:36 +0200329 struct ctrl_cmd *cmd;
330 struct ctrl_handle *ctrl = bfd->data;
331
332 queue = container_of(bfd, struct osmo_wqueue, bfd);
333 ccon = container_of(queue, struct ctrl_connection, write_queue);
334
Jacob Erlbeck141de622014-03-31 13:42:11 +0200335 ret = ipa_msg_recv_buffered(bfd->fd, &msg, &ccon->pending_msg);
Pablo Neira Ayuso10dfc262011-08-17 22:44:07 +0200336 if (ret <= 0) {
Jacob Erlbeck141de622014-03-31 13:42:11 +0200337 if (ret == -EAGAIN)
338 return 0;
Pablo Neira Ayuso10dfc262011-08-17 22:44:07 +0200339 if (ret == 0)
Harald Welte7fd0c832014-08-20 19:58:13 +0200340 LOGP(DLCTRL, LOGL_INFO, "The control connection was closed\n");
Daniel Willmann1264cb42010-10-21 15:00:36 +0200341 else
Harald Welte7fd0c832014-08-20 19:58:13 +0200342 LOGP(DLCTRL, LOGL_ERROR, "Failed to parse ip access message: %d\n", ret);
Daniel Willmann1264cb42010-10-21 15:00:36 +0200343
344 goto err;
345 }
346
347 if (msg->len < sizeof(*iph) + sizeof(*iph_ext)) {
Harald Welte7fd0c832014-08-20 19:58:13 +0200348 LOGP(DLCTRL, LOGL_ERROR, "The message is too short.\n");
Daniel Willmann1264cb42010-10-21 15:00:36 +0200349 goto err;
350 }
351
352 iph = (struct ipaccess_head *) msg->data;
353 if (iph->proto != IPAC_PROTO_OSMO) {
Harald Welte7fd0c832014-08-20 19:58:13 +0200354 LOGP(DLCTRL, LOGL_ERROR, "Protocol mismatch. We got 0x%x\n", iph->proto);
Daniel Willmann1264cb42010-10-21 15:00:36 +0200355 goto err;
356 }
357
358 iph_ext = (struct ipaccess_head_ext *) iph->data;
359 if (iph_ext->proto != IPAC_PROTO_EXT_CTRL) {
Harald Welte7fd0c832014-08-20 19:58:13 +0200360 LOGP(DLCTRL, LOGL_ERROR, "Extended protocol mismatch. We got 0x%x\n", iph_ext->proto);
Daniel Willmann1264cb42010-10-21 15:00:36 +0200361 goto err;
362 }
363
364 msg->l2h = iph_ext->data;
365
366 cmd = ctrl_cmd_parse(ccon, msg);
367
368 if (cmd) {
369 cmd->ccon = ccon;
Harald Welte528134b2014-08-21 15:13:08 +0200370 if (ctrl_cmd_handle(ctrl, cmd, ctrl->data) != CTRL_CMD_HANDLED) {
Daniel Willmann1264cb42010-10-21 15:00:36 +0200371 ctrl_cmd_send(queue, cmd);
372 talloc_free(cmd);
373 }
374 } else {
375 cmd = talloc_zero(ccon, struct ctrl_cmd);
376 if (!cmd)
377 goto err;
Harald Welte7fd0c832014-08-20 19:58:13 +0200378 LOGP(DLCTRL, LOGL_ERROR, "Command parser error.\n");
Daniel Willmann1264cb42010-10-21 15:00:36 +0200379 cmd->type = CTRL_TYPE_ERROR;
380 cmd->id = "err";
381 cmd->reply = "Command parser error.";
382 ctrl_cmd_send(queue, cmd);
383 talloc_free(cmd);
384 }
385
386 msgb_free(msg);
387 return 0;
388
389err:
390 control_close_conn(ccon);
391 msgb_free(msg);
392 return ret;
393}
394
395static int control_write_cb(struct osmo_fd *bfd, struct msgb *msg)
396{
397 int rc;
398
399 rc = write(bfd->fd, msg->data, msg->len);
400 if (rc != msg->len)
Harald Welte7fd0c832014-08-20 19:58:13 +0200401 LOGP(DLCTRL, LOGL_ERROR, "Failed to write message to the control connection.\n");
Daniel Willmann1264cb42010-10-21 15:00:36 +0200402
403 return rc;
404}
405
Maxfa9e05e2017-02-20 11:53:11 +0100406/*! \brief Allocate CTRL connection
407 * \param[in] ctx Context from which talloc should allocate it
408 * \param[in] data caller's private data parameter which should assigned to
409 write queue's file descriptor data parameter.
410 * \return Allocated CTRL connection structure or NULL in case of errors
411 */
412struct ctrl_connection *osmo_ctrl_conn_alloc(void *ctx, void *data)
Daniel Willmann1264cb42010-10-21 15:00:36 +0200413{
414 struct ctrl_connection *ccon = talloc_zero(ctx, struct ctrl_connection);
415 if (!ccon)
416 return NULL;
417
418 osmo_wqueue_init(&ccon->write_queue, 100);
419 /* Error handling here? */
420
421 INIT_LLIST_HEAD(&ccon->cmds);
Harald Welte39c9e7b2014-08-22 00:28:51 +0200422 INIT_LLIST_HEAD(&ccon->def_cmds);
423
Maxfa9e05e2017-02-20 11:53:11 +0100424 ccon->write_queue.bfd.data = data;
425 ccon->write_queue.write_cb = control_write_cb;
Max9756c462017-02-24 13:03:32 +0100426 ccon->write_queue.read_cb = handle_control_read;
Maxfa9e05e2017-02-20 11:53:11 +0100427
Daniel Willmann1264cb42010-10-21 15:00:36 +0200428 return ccon;
429}
430
431static int listen_fd_cb(struct osmo_fd *listen_bfd, unsigned int what)
432{
433 int ret, fd, on;
Daniel Willmann0e0cf372011-05-06 16:37:25 +0200434 struct ctrl_handle *ctrl;
Daniel Willmann1264cb42010-10-21 15:00:36 +0200435 struct ctrl_connection *ccon;
436 struct sockaddr_in sa;
437 socklen_t sa_len = sizeof(sa);
438
439
440 if (!(what & BSC_FD_READ))
441 return 0;
442
443 fd = accept(listen_bfd->fd, (struct sockaddr *) &sa, &sa_len);
444 if (fd < 0) {
445 perror("accept");
446 return fd;
447 }
Harald Welte7fd0c832014-08-20 19:58:13 +0200448 LOGP(DLCTRL, LOGL_INFO, "accept()ed new control connection from %s\n",
Daniel Willmann1264cb42010-10-21 15:00:36 +0200449 inet_ntoa(sa.sin_addr));
450
Harald Weltee15ac062014-12-04 14:15:36 +0100451#ifdef TCP_NODELAY
Daniel Willmann1264cb42010-10-21 15:00:36 +0200452 on = 1;
453 ret = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof(on));
454 if (ret != 0) {
Harald Welte7fd0c832014-08-20 19:58:13 +0200455 LOGP(DLCTRL, LOGL_ERROR, "Failed to set TCP_NODELAY: %s\n", strerror(errno));
Daniel Willmann1264cb42010-10-21 15:00:36 +0200456 close(fd);
457 return ret;
458 }
Harald Weltee15ac062014-12-04 14:15:36 +0100459#endif
Maxfa9e05e2017-02-20 11:53:11 +0100460 ctrl = listen_bfd->data;
461 ccon = osmo_ctrl_conn_alloc(listen_bfd->data, ctrl);
Daniel Willmann1264cb42010-10-21 15:00:36 +0200462 if (!ccon) {
Harald Welte7fd0c832014-08-20 19:58:13 +0200463 LOGP(DLCTRL, LOGL_ERROR, "Failed to allocate.\n");
Daniel Willmann1264cb42010-10-21 15:00:36 +0200464 close(fd);
465 return -1;
466 }
467
Daniel Willmann1264cb42010-10-21 15:00:36 +0200468 ccon->write_queue.bfd.fd = fd;
469 ccon->write_queue.bfd.when = BSC_FD_READ;
Daniel Willmann1264cb42010-10-21 15:00:36 +0200470
471 ret = osmo_fd_register(&ccon->write_queue.bfd);
472 if (ret < 0) {
Harald Welte7fd0c832014-08-20 19:58:13 +0200473 LOGP(DLCTRL, LOGL_ERROR, "Could not register FD.\n");
Daniel Willmann1264cb42010-10-21 15:00:36 +0200474 close(ccon->write_queue.bfd.fd);
475 talloc_free(ccon);
476 }
477
Daniel Willmann0e0cf372011-05-06 16:37:25 +0200478 llist_add(&ccon->list_entry, &ctrl->ccon_list);
479
Daniel Willmann1264cb42010-10-21 15:00:36 +0200480 return ret;
481}
482
Daniel Willmanne9f58942011-04-21 11:43:55 +0200483static uint64_t get_rate_ctr_value(const struct rate_ctr *ctr, int intv)
484{
485 if (intv >= RATE_CTR_INTV_NUM)
486 return 0;
487
488 /* Absolute value */
489 if (intv == -1) {
490 return ctr->current;
491 } else {
492 return ctr->intv[intv].rate;
493 }
494}
495
Harald Weltec9df37d2014-08-20 19:55:17 +0200496static char *get_all_rate_ctr_in_group(void *ctx, const struct rate_ctr_group *ctrg, int intv)
Daniel Willmanne9f58942011-04-21 11:43:55 +0200497{
498 int i;
Harald Weltec9df37d2014-08-20 19:55:17 +0200499 char *counters = talloc_strdup(ctx, "");
Daniel Willmanne9f58942011-04-21 11:43:55 +0200500 if (!counters)
501 return NULL;
502
503 for (i=0;i<ctrg->desc->num_ctr;i++) {
Daniel Willmann0834a342011-07-19 12:12:10 +0200504 counters = talloc_asprintf_append(counters, "\n%s.%u.%s %"PRIu64,
Daniel Willmanne9f58942011-04-21 11:43:55 +0200505 ctrg->desc->group_name_prefix, ctrg->idx,
506 ctrg->desc->ctr_desc[i].name,
507 get_rate_ctr_value(&ctrg->ctr[i], intv));
508 if (!counters)
509 return NULL;
510 }
511 return counters;
512}
513
Daniel Willmanne9f58942011-04-21 11:43:55 +0200514static int get_rate_ctr_group_idx(const struct rate_ctr_group *ctrg, int intv, struct ctrl_cmd *cmd)
515{
516 char *counters;
517
Harald Weltec9df37d2014-08-20 19:55:17 +0200518 counters = get_all_rate_ctr_in_group(cmd, ctrg, intv);
Daniel Willmanne9f58942011-04-21 11:43:55 +0200519 if (!counters)
520 goto oom;
521
522 cmd->reply = talloc_asprintf(cmd, "All counters in %s.%u%s",
523 ctrg->desc->group_name_prefix, ctrg->idx, counters);
524 talloc_free(counters);
525 if (!cmd->reply)
526 goto oom;
527
528 return CTRL_CMD_REPLY;
529oom:
530 cmd->reply = "OOM.";
531 return CTRL_CMD_ERROR;
532}
533
534/* rate_ctr */
535CTRL_CMD_DEFINE(rate_ctr, "rate_ctr *");
Daniel Willmannf7c74e52011-08-05 11:48:18 +0200536static int get_rate_ctr(struct ctrl_cmd *cmd, void *data)
Daniel Willmanne9f58942011-04-21 11:43:55 +0200537{
538 int intv;
539 unsigned int idx;
Neels Hofmeyr5b34f772016-09-19 14:15:03 +0200540 char *ctr_group, *ctr_idx, *tmp, *dup, *saveptr, *interval;
Daniel Willmanne9f58942011-04-21 11:43:55 +0200541 struct rate_ctr_group *ctrg;
542 const struct rate_ctr *ctr;
543
544 dup = talloc_strdup(cmd, cmd->variable);
545 if (!dup)
546 goto oom;
547
548 /* Skip over possible prefixes (net.) */
549 tmp = strstr(dup, "rate_ctr");
550 if (!tmp) {
551 talloc_free(dup);
552 cmd->reply = "rate_ctr not a token in rate_ctr command!";
553 goto err;
554 }
555
556 strtok_r(tmp, ".", &saveptr);
557 interval = strtok_r(NULL, ".", &saveptr);
558 if (!interval) {
559 talloc_free(dup);
560 cmd->reply = "Missing interval.";
561 goto err;
562 }
563
564 if (!strcmp(interval, "abs")) {
565 intv = -1;
566 } else if (!strcmp(interval, "per_sec")) {
567 intv = RATE_CTR_INTV_SEC;
568 } else if (!strcmp(interval, "per_min")) {
569 intv = RATE_CTR_INTV_MIN;
570 } else if (!strcmp(interval, "per_hour")) {
571 intv = RATE_CTR_INTV_HOUR;
572 } else if (!strcmp(interval, "per_day")) {
573 intv = RATE_CTR_INTV_DAY;
574 } else {
575 talloc_free(dup);
576 cmd->reply = "Wrong interval.";
577 goto err;
578 }
579
580 ctr_group = strtok_r(NULL, ".", &saveptr);
Max22886d92016-06-14 18:17:06 +0200581 ctr_idx = strtok_r(NULL, ".", &saveptr);
582 if (!ctr_group || !ctr_idx) {
Daniel Willmanne9f58942011-04-21 11:43:55 +0200583 talloc_free(dup);
Max22886d92016-06-14 18:17:06 +0200584 cmd->reply = "Counter group must be of name.index form e. g. "
585 "e1inp.0";
Daniel Willmanne9f58942011-04-21 11:43:55 +0200586 goto err;
587 }
Daniel Willmanne9f58942011-04-21 11:43:55 +0200588
Daniel Willmanne9f58942011-04-21 11:43:55 +0200589 idx = atoi(ctr_idx);
590
591 ctrg = rate_ctr_get_group_by_name_idx(ctr_group, idx);
592 if (!ctrg) {
593 talloc_free(dup);
Max22886d92016-06-14 18:17:06 +0200594 cmd->reply = "Counter group with given name and index not found";
Daniel Willmanne9f58942011-04-21 11:43:55 +0200595 goto err;
596 }
597
Max22886d92016-06-14 18:17:06 +0200598 if (!strlen(saveptr)) {
Daniel Willmanne9f58942011-04-21 11:43:55 +0200599 talloc_free(dup);
600 return get_rate_ctr_group_idx(ctrg, intv, cmd);
601 }
602
Max22886d92016-06-14 18:17:06 +0200603 ctr = rate_ctr_get_by_name(ctrg, saveptr);
Daniel Willmanne9f58942011-04-21 11:43:55 +0200604 if (!ctr) {
605 cmd->reply = "Counter name not found.";
606 talloc_free(dup);
607 goto err;
608 }
609
610 talloc_free(dup);
611
Holger Hans Peter Freytherad6451f2012-03-16 12:18:39 +0100612 cmd->reply = talloc_asprintf(cmd, "%"PRIu64, get_rate_ctr_value(ctr, intv));
Daniel Willmanne9f58942011-04-21 11:43:55 +0200613 if (!cmd->reply)
614 goto oom;
615
616 return CTRL_CMD_REPLY;
617oom:
618 cmd->reply = "OOM";
619err:
620 return CTRL_CMD_ERROR;
621}
622
Daniel Willmannf7c74e52011-08-05 11:48:18 +0200623static int set_rate_ctr(struct ctrl_cmd *cmd, void *data)
Daniel Willmanne9f58942011-04-21 11:43:55 +0200624{
625 cmd->reply = "Can't set rate counter.";
626
627 return CTRL_CMD_ERROR;
628}
629
Daniel Willmannf7c74e52011-08-05 11:48:18 +0200630static int verify_rate_ctr(struct ctrl_cmd *cmd, const char *value, void *data)
Daniel Willmanne9f58942011-04-21 11:43:55 +0200631{
632 return 0;
633}
634
635/* counter */
636CTRL_CMD_DEFINE(counter, "counter *");
Daniel Willmannf7c74e52011-08-05 11:48:18 +0200637static int get_counter(struct ctrl_cmd *cmd, void *data)
Daniel Willmanne9f58942011-04-21 11:43:55 +0200638{
639 char *ctr_name, *tmp, *dup, *saveptr;
640 struct osmo_counter *counter;
641
642 cmd->reply = "OOM";
643 dup = talloc_strdup(cmd, cmd->variable);
644 if (!dup)
645 goto err;
646
647
648 tmp = strstr(dup, "counter");
649 if (!tmp) {
650 talloc_free(dup);
651 goto err;
652 }
653
654 strtok_r(tmp, ".", &saveptr);
655 ctr_name = strtok_r(NULL, "\0", &saveptr);
656
657 if (!ctr_name)
658 goto err;
659
660 counter = osmo_counter_get_by_name(ctr_name);
661 if (!counter) {
662 cmd->reply = "Counter name not found.";
663 talloc_free(dup);
664 goto err;
665 }
666
667 talloc_free(dup);
668
669 cmd->reply = talloc_asprintf(cmd, "%lu", counter->value);
670 if (!cmd->reply) {
671 cmd->reply = "OOM";
672 goto err;
673 }
674
675 return CTRL_CMD_REPLY;
676err:
677 return CTRL_CMD_ERROR;
678}
679
Daniel Willmannf7c74e52011-08-05 11:48:18 +0200680static int set_counter(struct ctrl_cmd *cmd, void *data)
Daniel Willmanne9f58942011-04-21 11:43:55 +0200681{
682
683 cmd->reply = "Can't set counter.";
684
685 return CTRL_CMD_ERROR;
686}
687
Daniel Willmannf7c74e52011-08-05 11:48:18 +0200688static int verify_counter(struct ctrl_cmd *cmd, const char *value, void *data)
Daniel Willmanne9f58942011-04-21 11:43:55 +0200689{
690 return 0;
691}
692
Harald Welteae2fcb22014-08-21 15:20:00 +0200693struct ctrl_handle *ctrl_interface_setup(void *data, uint16_t port,
694 ctrl_cmd_lookup lookup)
Daniel Willmann1264cb42010-10-21 15:00:36 +0200695{
Neels Hofmeyr49343092016-02-24 00:09:40 +0100696 return ctrl_interface_setup_dynip(data, "127.0.0.1", port, lookup);
697}
698
Harald Welte79c137c2017-04-16 19:08:49 +0200699static int ctrl_initialized = 0;
700
701/* global ctrl initialization */
702static int ctrl_init(void)
703{
704 int ret;
705
706 if (ctrl_initialized)
707 return 0;
708
709 ctrl_node_vec = vector_init(5);
710 if (!ctrl_node_vec)
711 goto err;
712
713 ret = ctrl_cmd_install(CTRL_NODE_ROOT, &cmd_rate_ctr);
714 if (ret)
715 goto err_vec;
716 ret = ctrl_cmd_install(CTRL_NODE_ROOT, &cmd_counter);
717 if (ret)
718 goto err_vec;
719
Harald Welte31c0fef2017-04-16 17:26:30 +0200720 ret = osmo_fsm_ctrl_cmds_install();
721 if (ret)
722 goto err_vec;
723
Harald Welte79c137c2017-04-16 19:08:49 +0200724 ctrl_initialized = 1;
725 return 0;
726
727err_vec:
728 vector_free(ctrl_node_vec);
729 ctrl_node_vec = NULL;
730err:
731 return -1;
732}
733
734/*! \brief Allocate a CTRL interface handle
735 * \param[in] ctx Tallo callocation context to be used
736 * \param[in] data Pointer which will be made available to each
737 set_..() get_..() verify_..() control command function
738 * \param[in] lookup Lookup function pointer, can be NULL
739 * \returns ctrl_handle pointer or NULL in case of errors
740 */
741struct ctrl_handle *ctrl_handle_alloc(void *ctx, void *data, ctrl_cmd_lookup lookup)
742{
743 struct ctrl_handle *ctrl;
744
745 ctrl_init();
746
747 ctrl = talloc_zero(ctx, struct ctrl_handle);
748 if (!ctrl)
749 return NULL;
750
751 INIT_LLIST_HEAD(&ctrl->ccon_list);
752
753 ctrl->data = data;
754 ctrl->lookup = lookup;
755
756 return ctrl;
757}
758
Max32ee5af2017-02-16 17:44:09 +0100759/*! \brief Setup CTRL interface on a given address
760 * \param[in] data Pointer which will be made available to each
761 set_..() get_..() verify_..() control command function
762 * \param[in] bind_addr Address on which CTRL socket shall listen
763 * \param[in] port Port on which CTRL socket shall listen
764 * \param[in] lookup Lookup function pointer, can be NULL
765 * \returns ctrl_handle pointer or NULL in case of errors
766 */
Neels Hofmeyr49343092016-02-24 00:09:40 +0100767struct ctrl_handle *ctrl_interface_setup_dynip(void *data,
768 const char *bind_addr,
769 uint16_t port,
770 ctrl_cmd_lookup lookup)
771{
Daniel Willmann1264cb42010-10-21 15:00:36 +0200772 int ret;
773 struct ctrl_handle *ctrl;
774
Harald Welte79c137c2017-04-16 19:08:49 +0200775 ctrl = ctrl_handle_alloc(data, data, lookup);
Daniel Willmann1264cb42010-10-21 15:00:36 +0200776 if (!ctrl)
Daniel Willmann782974b2011-07-22 17:55:42 +0200777 return NULL;
Daniel Willmann1264cb42010-10-21 15:00:36 +0200778
Daniel Willmann1264cb42010-10-21 15:00:36 +0200779 /* Listen for control connections */
Harald Welte1238cc62014-08-20 19:50:04 +0200780 ctrl->listen_fd.cb = listen_fd_cb;
781 ctrl->listen_fd.data = ctrl;
782 ret = osmo_sock_init_ofd(&ctrl->listen_fd, AF_INET, SOCK_STREAM, IPPROTO_TCP,
Neels Hofmeyr49343092016-02-24 00:09:40 +0100783 bind_addr, port, OSMO_SOCK_F_BIND);
Harald Welte79c137c2017-04-16 19:08:49 +0200784 if (ret < 0) {
785 talloc_free(ctrl);
786 return NULL;
787 }
Daniel Willmanne9f58942011-04-21 11:43:55 +0200788
Neels Hofmeyr38d232e2016-09-19 14:17:30 +0200789 LOGP(DLCTRL, LOGL_NOTICE, "CTRL at %s %u\n", bind_addr, port);
Daniel Willmann782974b2011-07-22 17:55:42 +0200790 return ctrl;
Daniel Willmann1264cb42010-10-21 15:00:36 +0200791}
Harald Welted6b1f852017-04-16 16:57:40 +0200792
793/*! \brief Install a lookup helper function for control nodes
794 * This function is used by e.g. library code to install lookup helpers
795 * for additional nodes in the control interface.
796 * \param[in] lookup The lookup helper function
797 * \retuns - on success; negative on error.
798 */
799int ctrl_lookup_register(ctrl_cmd_lookup lookup)
800{
801 struct lookup_helper *lh;
802
803 /* avoid double registration */
804 llist_for_each_entry(lh, &ctrl_lookup_helpers, list) {
805 if (lh->lookup == lookup)
806 return -EEXIST;
807 }
808
809 lh = talloc_zero(NULL, struct lookup_helper);
810 if (!lh)
811 return -ENOMEM;
812
813 lh->lookup = lookup;
814 llist_add_tail(&lh->list, &ctrl_lookup_helpers);
815 return 0;
816}
Harald Weltef85861d2017-04-16 19:17:10 +0200817
818/*! \brief Helper for "local execution" of a CTRL command from a string
819 * The function will parse + execute the given control command string
820 * and return a corresponding ctrl_cmd. Caller is responsible to
821 * talloc_free() the return value.
822 * \param[in] Control Interface Command String
823 * \returns parsed command, including reply; NULL on error */
824struct ctrl_cmd *ctrl_cmd_exec_from_string(struct ctrl_handle *ch, const char *cmdstr)
825{
826 struct msgb *msg = msgb_alloc(1024, "ctrl-cmd");
827 struct ctrl_cmd *cmd;
828
829 if (!msg)
830 return NULL;
831 msg->l2h = msg->data;
832 osmo_strlcpy((char *)msg->data, cmdstr, msgb_tailroom(msg));
833 msgb_put(msg, strlen(cmdstr));
834
835 cmd = ctrl_cmd_parse(ch, msg);
836 msgb_free(msg);
837 if (!cmd)
838 return NULL;
839 if (ctrl_cmd_handle(ch, cmd, NULL) < 0) {
840 talloc_free(cmd);
841 return NULL;
842 }
843 return cmd;
844}