blob: 4cab22a376853fe4500346d60984a86404ca2747 [file] [log] [blame]
Harald Welte3fb0b6f2010-05-19 19:02:52 +02001/* OpenBSC logging helper for the VTY */
2/* (C) 2009-2010 by Harald Welte <laforge@gnumonks.org>
3 * (C) 2009-2010 by Holger Hans Peter Freyther
4 * All Rights Reserved
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 */
21
22#include <stdlib.h>
23#include <string.h>
24
Harald Welte28222962011-02-18 20:37:04 +010025#include "../../config.h"
26
Pablo Neira Ayuso83419342011-03-22 16:36:13 +010027#include <osmocom/core/talloc.h>
28#include <osmocom/core/logging.h>
29#include <osmocom/core/utils.h>
Harald Welte3fb0b6f2010-05-19 19:02:52 +020030
31//#include <openbsc/vty.h>
32
33#include <osmocom/vty/command.h>
34#include <osmocom/vty/buffer.h>
35#include <osmocom/vty/vty.h>
36#include <osmocom/vty/telnet_interface.h>
37#include <osmocom/vty/logging.h>
38
Harald Welte28222962011-02-18 20:37:04 +010039#define LOG_STR "Configure logging sub-system\n"
40
Harald Welte4ebdf742010-05-19 19:54:00 +020041extern const struct log_info *osmo_log_info;
Harald Welte3fb0b6f2010-05-19 19:02:52 +020042
Harald Welte76e72ab2011-02-17 15:52:39 +010043static void _vty_output(struct log_target *tgt,
44 unsigned int level, const char *line)
Harald Welte3fb0b6f2010-05-19 19:02:52 +020045{
46 struct vty *vty = tgt->tgt_vty.vty;
47 vty_out(vty, "%s", line);
48 /* This is an ugly hack, but there is no easy way... */
49 if (strchr(line, '\n'))
50 vty_out(vty, "\r");
51}
52
53struct log_target *log_target_create_vty(struct vty *vty)
54{
55 struct log_target *target;
56
57 target = log_target_create();
58 if (!target)
59 return NULL;
60
61 target->tgt_vty.vty = vty;
62 target->output = _vty_output;
63 return target;
64}
65
66DEFUN(enable_logging,
67 enable_logging_cmd,
68 "logging enable",
69 LOGGING_STR
70 "Enables logging to this vty\n")
71{
72 struct telnet_connection *conn;
73
74 conn = (struct telnet_connection *) vty->priv;
75 if (conn->dbg) {
76 vty_out(vty, "Logging already enabled.%s", VTY_NEWLINE);
77 return CMD_WARNING;
78 }
79
80 conn->dbg = log_target_create_vty(vty);
81 if (!conn->dbg)
82 return CMD_WARNING;
83
84 log_add_target(conn->dbg);
85 return CMD_SUCCESS;
86}
87
Harald Weltea62648b2011-02-18 21:03:27 +010088struct log_target *osmo_log_vty2tgt(struct vty *vty)
89{
90 struct telnet_connection *conn;
91
92 if (vty->node == CFG_LOG_NODE)
93 return vty->index;
94
95
96 conn = (struct telnet_connection *) vty->priv;
97 if (!conn->dbg)
98 vty_out(vty, "Logging was not enabled.%s", VTY_NEWLINE);
99
100 return conn->dbg;
101}
102
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200103DEFUN(logging_fltr_all,
104 logging_fltr_all_cmd,
105 "logging filter all (0|1)",
106 LOGGING_STR FILTER_STR
107 "Do you want to log all messages?\n"
108 "Only print messages matched by other filters\n"
109 "Bypass filter and print all messages\n")
110{
Harald Weltea62648b2011-02-18 21:03:27 +0100111 struct log_target *tgt = osmo_log_vty2tgt(vty);
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200112
Harald Weltea62648b2011-02-18 21:03:27 +0100113 if (!tgt)
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200114 return CMD_WARNING;
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200115
Harald Weltea62648b2011-02-18 21:03:27 +0100116 log_set_all_filter(tgt, atoi(argv[0]));
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200117 return CMD_SUCCESS;
118}
119
120DEFUN(logging_use_clr,
121 logging_use_clr_cmd,
122 "logging color (0|1)",
123 LOGGING_STR "Configure color-printing for log messages\n"
124 "Don't use color for printing messages\n"
125 "Use color for printing messages\n")
126{
Harald Weltea62648b2011-02-18 21:03:27 +0100127 struct log_target *tgt = osmo_log_vty2tgt(vty);
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200128
Harald Weltea62648b2011-02-18 21:03:27 +0100129 if (!tgt)
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200130 return CMD_WARNING;
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200131
Harald Weltea62648b2011-02-18 21:03:27 +0100132 log_set_use_color(tgt, atoi(argv[0]));
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200133 return CMD_SUCCESS;
134}
135
136DEFUN(logging_prnt_timestamp,
137 logging_prnt_timestamp_cmd,
138 "logging timestamp (0|1)",
139 LOGGING_STR "Configure log message timestamping\n"
140 "Don't prefix each log message\n"
141 "Prefix each log message with current timestamp\n")
142{
Harald Weltea62648b2011-02-18 21:03:27 +0100143 struct log_target *tgt = osmo_log_vty2tgt(vty);
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200144
Harald Weltea62648b2011-02-18 21:03:27 +0100145 if (!tgt)
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200146 return CMD_WARNING;
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200147
Harald Weltea62648b2011-02-18 21:03:27 +0100148 log_set_print_timestamp(tgt, atoi(argv[0]));
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200149 return CMD_SUCCESS;
150}
151
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200152DEFUN(logging_level,
153 logging_level_cmd,
Pablo Neira Ayuso04139f12011-03-09 13:05:08 +0100154 NULL, /* cmdstr is dynamically set in logging_vty_add_cmds(). */
155 NULL) /* same thing for helpstr. */
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200156{
Harald Weltea62648b2011-02-18 21:03:27 +0100157 int category = log_parse_category(argv[0]);
158 int level = log_parse_level(argv[1]);
159 struct log_target *tgt = osmo_log_vty2tgt(vty);
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200160
Harald Weltea62648b2011-02-18 21:03:27 +0100161 if (!tgt)
162 return CMD_WARNING;
163
164 if (level < 0) {
165 vty_out(vty, "Invalid level `%s'%s", argv[1], VTY_NEWLINE);
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200166 return CMD_WARNING;
167 }
168
Harald Weltea62648b2011-02-18 21:03:27 +0100169 /* Check for special case where we want to set global log level */
170 if (!strcmp(argv[0], "all")) {
171 log_set_log_level(tgt, level);
172 return CMD_SUCCESS;
173 }
174
175 if (category < 0) {
176 vty_out(vty, "Invalid category `%s'%s", argv[0], VTY_NEWLINE);
177 return CMD_WARNING;
178 }
179
180 tgt->categories[category].enabled = 1;
181 tgt->categories[category].loglevel = level;
182
183 return CMD_SUCCESS;
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200184}
185
186DEFUN(logging_set_category_mask,
187 logging_set_category_mask_cmd,
188 "logging set log mask MASK",
189 LOGGING_STR
190 "Decide which categories to output.\n")
191{
Harald Weltea62648b2011-02-18 21:03:27 +0100192 struct log_target *tgt = osmo_log_vty2tgt(vty);
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200193
Harald Weltea62648b2011-02-18 21:03:27 +0100194 if (!tgt)
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200195 return CMD_WARNING;
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200196
Harald Weltea62648b2011-02-18 21:03:27 +0100197 log_parse_category_mask(tgt, argv[0]);
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200198 return CMD_SUCCESS;
199}
200
201DEFUN(diable_logging,
202 disable_logging_cmd,
203 "logging disable",
204 LOGGING_STR
205 "Disables logging to this vty\n")
206{
Harald Weltea62648b2011-02-18 21:03:27 +0100207 struct log_target *tgt = osmo_log_vty2tgt(vty);
208 struct telnet_connection *conn = (struct telnet_connection *) vty->priv;
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200209
Harald Weltea62648b2011-02-18 21:03:27 +0100210 if (!tgt)
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200211 return CMD_WARNING;
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200212
Harald Weltea62648b2011-02-18 21:03:27 +0100213 log_del_target(tgt);
214 talloc_free(tgt);
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200215 conn->dbg = NULL;
Harald Weltea62648b2011-02-18 21:03:27 +0100216
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200217 return CMD_SUCCESS;
218}
219
220static void vty_print_logtarget(struct vty *vty, const struct log_info *info,
221 const struct log_target *tgt)
222{
223 unsigned int i;
224
225 vty_out(vty, " Global Loglevel: %s%s",
226 log_level_str(tgt->loglevel), VTY_NEWLINE);
227 vty_out(vty, " Use color: %s, Print Timestamp: %s%s",
228 tgt->use_color ? "On" : "Off",
229 tgt->print_timestamp ? "On" : "Off", VTY_NEWLINE);
230
231 vty_out(vty, " Log Level specific information:%s", VTY_NEWLINE);
232
233 for (i = 0; i < info->num_cat; i++) {
234 const struct log_category *cat = &tgt->categories[i];
235 vty_out(vty, " %-10s %-10s %-8s %s%s",
236 info->cat[i].name+1, log_level_str(cat->loglevel),
237 cat->enabled ? "Enabled" : "Disabled",
238 info->cat[i].description,
239 VTY_NEWLINE);
240 }
241}
242
243#define SHOW_LOG_STR "Show current logging configuration\n"
244
245DEFUN(show_logging_vty,
246 show_logging_vty_cmd,
247 "show logging vty",
248 SHOW_STR SHOW_LOG_STR
249 "Show current logging configuration for this vty\n")
250{
Harald Weltea62648b2011-02-18 21:03:27 +0100251 struct log_target *tgt = osmo_log_vty2tgt(vty);
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200252
Harald Weltea62648b2011-02-18 21:03:27 +0100253 if (!tgt)
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200254 return CMD_WARNING;
Harald Weltea62648b2011-02-18 21:03:27 +0100255
256 vty_print_logtarget(vty, osmo_log_info, tgt);
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200257
258 return CMD_SUCCESS;
259}
260
261gDEFUN(cfg_description, cfg_description_cmd,
262 "description .TEXT",
263 "Save human-readable decription of the object\n")
264{
265 char **dptr = vty->index_sub;
266
267 if (!dptr) {
268 vty_out(vty, "vty->index_sub == NULL%s", VTY_NEWLINE);
269 return CMD_WARNING;
270 }
271
272 *dptr = argv_concat(argv, argc, 0);
273 if (!dptr)
274 return CMD_WARNING;
275
276 return CMD_SUCCESS;
277}
278
279gDEFUN(cfg_no_description, cfg_no_description_cmd,
280 "no description",
281 NO_STR
282 "Remove description of the object\n")
283{
284 char **dptr = vty->index_sub;
285
286 if (!dptr) {
287 vty_out(vty, "vty->index_sub == NULL%s", VTY_NEWLINE);
288 return CMD_WARNING;
289 }
290
291 if (*dptr) {
292 talloc_free(*dptr);
293 *dptr = NULL;
294 }
295
296 return CMD_SUCCESS;
297}
298
Harald Welte28222962011-02-18 20:37:04 +0100299/* Support for configuration of log targets != the current vty */
300
301struct cmd_node cfg_log_node = {
302 CFG_LOG_NODE,
303 "%s(config-log)# ",
304 1
305};
306
Harald Welte28222962011-02-18 20:37:04 +0100307#ifdef HAVE_SYSLOG_H
308
309#include <syslog.h>
310
311static const int local_sysl_map[] = {
312 [0] = LOG_LOCAL0,
313 [1] = LOG_LOCAL1,
314 [2] = LOG_LOCAL2,
315 [3] = LOG_LOCAL3,
316 [4] = LOG_LOCAL4,
317 [5] = LOG_LOCAL5,
318 [6] = LOG_LOCAL6,
319 [7] = LOG_LOCAL7
320};
321
Harald Weltede79cee2011-02-24 23:47:57 +0100322/* From VTY core code */
323extern struct host host;
324
Harald Welte28222962011-02-18 20:37:04 +0100325static int _cfg_log_syslog(struct vty *vty, int facility)
326{
327 struct log_target *tgt;
328
329 /* First delete the old syslog target, if any */
330 tgt = log_target_find(LOG_TGT_TYPE_SYSLOG, NULL);
331 if (tgt)
332 log_target_destroy(tgt);
333
Harald Weltede79cee2011-02-24 23:47:57 +0100334 tgt = log_target_create_syslog(host.app_info->name, 0, facility);
Harald Welte28222962011-02-18 20:37:04 +0100335 if (!tgt) {
336 vty_out(vty, "%% Unable to open syslog%s", VTY_NEWLINE);
337 return CMD_WARNING;
338 }
339 log_add_target(tgt);
340
341 vty->index = tgt;
342 vty->node = CFG_LOG_NODE;
343
344 return CMD_SUCCESS;
345}
346
347DEFUN(cfg_log_syslog_local, cfg_log_syslog_local_cmd,
348 "log syslog local <0-7>",
349 LOG_STR "Logging via syslog\n" "Syslog LOCAL facility\n"
350 "Local facility number\n")
351{
352 int local = atoi(argv[0]);
353 int facility = local_sysl_map[local];
354
355 return _cfg_log_syslog(vty, facility);
356}
357
358static struct value_string sysl_level_names[] = {
359 { LOG_AUTHPRIV, "authpriv" },
360 { LOG_CRON, "cron" },
361 { LOG_DAEMON, "daemon" },
362 { LOG_FTP, "ftp" },
363 { LOG_LPR, "lpr" },
364 { LOG_MAIL, "mail" },
365 { LOG_NEWS, "news" },
366 { LOG_USER, "user" },
367 { LOG_UUCP, "uucp" },
368 /* only for value -> string conversion */
369 { LOG_LOCAL0, "local 0" },
370 { LOG_LOCAL1, "local 1" },
371 { LOG_LOCAL2, "local 2" },
372 { LOG_LOCAL3, "local 3" },
373 { LOG_LOCAL4, "local 4" },
374 { LOG_LOCAL5, "local 5" },
375 { LOG_LOCAL6, "local 6" },
376 { LOG_LOCAL7, "local 7" },
377 { 0, NULL }
378};
379
380DEFUN(cfg_log_syslog, cfg_log_syslog_cmd,
381 "log syslog (authpriv|cron|daemon|ftp|lpr|mail|news|user|uucp)",
382 LOG_STR "Logging via syslog\n")
383{
384 int facility = get_string_value(sysl_level_names, argv[0]);
385
386 return _cfg_log_syslog(vty, facility);
387}
388
389DEFUN(cfg_no_log_syslog, cfg_no_log_syslog_cmd,
390 "no log syslog",
391 NO_STR LOG_STR "Logging via syslog\n")
392{
393 struct log_target *tgt;
394
395 tgt = log_target_find(LOG_TGT_TYPE_SYSLOG, NULL);
396 if (!tgt) {
397 vty_out(vty, "%% No syslog target found%s",
398 VTY_NEWLINE);
399 return CMD_WARNING;
400 }
401
402 log_target_destroy(tgt);
403
404 return CMD_SUCCESS;
405}
406#endif /* HAVE_SYSLOG_H */
407
408DEFUN(cfg_log_stderr, cfg_log_stderr_cmd,
409 "log stderr",
410 LOG_STR "Logging via STDERR of the process\n")
411{
412 struct log_target *tgt;
413
414 tgt = log_target_find(LOG_TGT_TYPE_STDERR, NULL);
415 if (!tgt) {
416 tgt = log_target_create_stderr();
417 if (!tgt) {
418 vty_out(vty, "%% Unable to create stderr log%s",
419 VTY_NEWLINE);
420 return CMD_WARNING;
421 }
422 log_add_target(tgt);
423 }
424
425 vty->index = tgt;
426 vty->node = CFG_LOG_NODE;
427
428 return CMD_SUCCESS;
429}
430
431DEFUN(cfg_no_log_stderr, cfg_no_log_stderr_cmd,
432 "no log stderr",
433 NO_STR LOG_STR "Logging via STDERR of the process\n")
434{
435 struct log_target *tgt;
436
437 tgt = log_target_find(LOG_TGT_TYPE_STDERR, NULL);
438 if (!tgt) {
439 vty_out(vty, "%% No stderr logging active%s", VTY_NEWLINE);
440 return CMD_WARNING;
441 }
442
443 log_target_destroy(tgt);
444
445 return CMD_SUCCESS;
446}
447
448DEFUN(cfg_log_file, cfg_log_file_cmd,
449 "log file .FILENAME",
450 LOG_STR "Logging to text file\n" "Filename\n")
451{
452 const char *fname = argv[0];
453 struct log_target *tgt;
454
455 tgt = log_target_find(LOG_TGT_TYPE_FILE, fname);
456 if (!tgt) {
457 tgt = log_target_create_file(fname);
458 if (!tgt) {
459 vty_out(vty, "%% Unable to create file `%s'%s",
460 fname, VTY_NEWLINE);
461 return CMD_WARNING;
462 }
463 log_add_target(tgt);
464 }
465
466 vty->index = tgt;
467 vty->node = CFG_LOG_NODE;
468
469 return CMD_SUCCESS;
470}
471
472
473DEFUN(cfg_no_log_file, cfg_no_log_file_cmd,
474 "no log file .FILENAME",
475 NO_STR LOG_STR "Logging to text file\n" "Filename\n")
476{
477 const char *fname = argv[0];
478 struct log_target *tgt;
479
480 tgt = log_target_find(LOG_TGT_TYPE_FILE, fname);
481 if (!tgt) {
482 vty_out(vty, "%% No such log file `%s'%s",
483 fname, VTY_NEWLINE);
484 return CMD_WARNING;
485 }
486
487 log_target_destroy(tgt);
488
489 return CMD_SUCCESS;
490}
491
492static int config_write_log_single(struct vty *vty, struct log_target *tgt)
493{
494 int i;
495 char level_lower[32];
496
497 switch (tgt->type) {
498 case LOG_TGT_TYPE_VTY:
499 return 1;
500 break;
501 case LOG_TGT_TYPE_STDERR:
502 vty_out(vty, "log stderr%s", VTY_NEWLINE);
503 break;
504 case LOG_TGT_TYPE_SYSLOG:
505#ifdef HAVE_SYSLOG_H
506 vty_out(vty, "log syslog %s%s",
507 get_value_string(sysl_level_names,
508 tgt->tgt_syslog.facility),
509 VTY_NEWLINE);
510#endif
511 break;
512 case LOG_TGT_TYPE_FILE:
513 vty_out(vty, "log file %s%s", tgt->tgt_file.fname, VTY_NEWLINE);
514 break;
515 }
516
517 vty_out(vty, " logging color %u%s", tgt->use_color ? 1 : 0,
518 VTY_NEWLINE);
519 vty_out(vty, " logging timestamp %u%s", tgt->print_timestamp ? 1 : 0,
520 VTY_NEWLINE);
521
522 /* stupid old osmo logging API uses uppercase strings... */
523 osmo_str2lower(level_lower, log_level_str(tgt->loglevel));
524 vty_out(vty, " logging level all %s%s", level_lower, VTY_NEWLINE);
525
526 for (i = 0; i < osmo_log_info->num_cat; i++) {
527 const struct log_category *cat = &tgt->categories[i];
528 char cat_lower[32];
529
530 /* stupid old osmo logging API uses uppercase strings... */
531 osmo_str2lower(cat_lower, osmo_log_info->cat[i].name+1);
532 osmo_str2lower(level_lower, log_level_str(cat->loglevel));
533
534 vty_out(vty, " logging level %s %s%s", cat_lower, level_lower,
535 VTY_NEWLINE);
536 }
537
538 /* FIXME: levels */
539
540 return 1;
541}
542
543static int config_write_log(struct vty *vty)
544{
545 struct log_target *dbg = vty->index;
546
547 llist_for_each_entry(dbg, &osmo_log_target_list, entry)
548 config_write_log_single(vty, dbg);
549
550 return 1;
551}
552
Pablo Neira Ayuso04139f12011-03-09 13:05:08 +0100553void logging_vty_add_cmds(const struct log_info *cat)
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200554{
555 install_element_ve(&enable_logging_cmd);
556 install_element_ve(&disable_logging_cmd);
557 install_element_ve(&logging_fltr_all_cmd);
558 install_element_ve(&logging_use_clr_cmd);
559 install_element_ve(&logging_prnt_timestamp_cmd);
560 install_element_ve(&logging_set_category_mask_cmd);
Pablo Neira Ayuso04139f12011-03-09 13:05:08 +0100561
562 /* Logging level strings are generated dynamically. */
563 logging_level_cmd.string = log_vty_command_string(cat);
564 logging_level_cmd.doc = log_vty_command_description(cat);
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200565 install_element_ve(&logging_level_cmd);
566 install_element_ve(&show_logging_vty_cmd);
Harald Welte28222962011-02-18 20:37:04 +0100567
568 install_node(&cfg_log_node, config_write_log);
Harald Weltea62648b2011-02-18 21:03:27 +0100569 install_element(CFG_LOG_NODE, &logging_fltr_all_cmd);
570 install_element(CFG_LOG_NODE, &logging_use_clr_cmd);
571 install_element(CFG_LOG_NODE, &logging_prnt_timestamp_cmd);
572 install_element(CFG_LOG_NODE, &logging_level_cmd);
Harald Welte28222962011-02-18 20:37:04 +0100573
574 install_element(CONFIG_NODE, &cfg_log_stderr_cmd);
575 install_element(CONFIG_NODE, &cfg_no_log_stderr_cmd);
576 install_element(CONFIG_NODE, &cfg_log_file_cmd);
577 install_element(CONFIG_NODE, &cfg_no_log_file_cmd);
578#ifdef HAVE_SYSLOG_H
579 install_element(CONFIG_NODE, &cfg_log_syslog_cmd);
580 install_element(CONFIG_NODE, &cfg_log_syslog_local_cmd);
581 install_element(CONFIG_NODE, &cfg_no_log_syslog_cmd);
582#endif
Harald Welte3fb0b6f2010-05-19 19:02:52 +0200583}