2 * Copyright (c) 2018 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
17 #include <vlib/vlib.h>
23 vlib_log_level_t level;
24 vlib_log_class_t class;
33 // level of log messages kept for this subclass
34 vlib_log_level_t level;
35 // level of log messages sent to syslog for this subclass
36 vlib_log_level_t syslog_level;
37 // flag saying whether this subclass is logged to syslog
38 f64 last_event_timestamp;
42 } vlib_log_subclass_data_t;
48 vlib_log_subclass_data_t *subclasses;
49 } vlib_log_class_data_t;
53 vlib_log_entry_t *entries;
54 vlib_log_class_data_t *classes;
55 int size, next, count;
57 /* our own log class */
58 vlib_log_class_t log_class;
60 int default_rate_limit;
61 int default_log_level;
62 int default_syslog_log_level;
67 struct timeval time_zero_timeval;
72 vlib_log_main_t log_main = {
73 .default_log_level = VLIB_LOG_LEVEL_NOTICE,
74 .default_syslog_log_level = VLIB_LOG_LEVEL_WARNING,
77 .default_rate_limit = 50,
83 vlib_log_main_t *lm = &log_main;
86 i = lm->next - lm->count;
93 static vlib_log_class_data_t *
94 get_class_data (vlib_log_class_t ci)
96 vlib_log_main_t *lm = &log_main;
97 return vec_elt_at_index (lm->classes, (ci >> 16));
100 static vlib_log_subclass_data_t *
101 get_subclass_data (vlib_log_class_t ci)
103 vlib_log_class_data_t *c = get_class_data (ci);
104 return vec_elt_at_index (c->subclasses, (ci & 0xffff));
108 vlib_log_level_to_syslog_priority (vlib_log_level_t level)
112 #define LOG_DISABLED LOG_DEBUG
114 case VLIB_LOG_LEVEL_##uc:\
116 foreach_vlib_log_level
124 format_vlib_log_class (u8 * s, va_list * args)
126 vlib_log_class_t ci = va_arg (*args, vlib_log_class_t);
127 vlib_log_class_data_t *c = get_class_data (ci);
128 vlib_log_subclass_data_t *sc = get_subclass_data (ci);
131 return format (s, "%v/%v", c->name, sc->name);
133 return format (s, "%v", c->name, 0);
138 vlib_log (vlib_log_level_t level, vlib_log_class_t class, char *fmt, ...)
140 vlib_main_t *vm = vlib_get_main ();
141 vlib_log_main_t *lm = &log_main;
143 vlib_log_subclass_data_t *sc = get_subclass_data (class);
145 f64 t = vlib_time_now (vm);
146 f64 delta = t - sc->last_event_timestamp;
148 bool use_formatted_log_entry = true;
150 vec_validate (lm->entries, lm->size);
151 /* make sure we are running on the main thread to avoid use in dataplane
152 code, for dataplane logging consider use of event-logger */
153 ASSERT (vlib_get_thread_index () == 0);
155 if (level > sc->level)
157 use_formatted_log_entry = false;
161 if ((delta > lm->unthrottle_time) ||
162 (sc->is_throttling == 0 && (delta > 1)))
164 sc->last_event_timestamp = t;
165 sc->last_sec_count = 0;
166 sc->is_throttling = 0;
170 sc->last_sec_count++;
171 if (sc->last_sec_count > sc->rate_limit)
173 else if (sc->last_sec_count == sc->rate_limit)
175 vec_reset_length (s);
176 s = format (0, "--- message(s) throttled ---");
177 sc->is_throttling = 1;
184 s = va_format (s, fmt, &va);
188 e = vec_elt_at_index (lm->entries, lm->next);
189 vec_free (e->string);
195 lm->next = (lm->next + 1) % lm->size;
196 if (lm->size > lm->count)
200 if (sc->syslog_level != VLIB_LOG_LEVEL_DISABLED &&
201 level <= sc->syslog_level)
203 u8 *tmp = format (NULL, "%U", format_vlib_log_class, class);
204 if (use_formatted_log_entry)
206 syslog (vlib_log_level_to_syslog_priority (level), "%.*s: %.*s",
207 (int) vec_len (tmp), tmp,
209 (vec_c_string_is_terminated (s) ? 1 : 0)), s);
213 tmp = format (tmp, ": ");
215 tmp = va_format (tmp, fmt, &va);
217 syslog (vlib_log_level_to_syslog_priority (level), "%.*s",
218 (int) (vec_len (tmp) -
219 (vec_c_string_is_terminated (tmp) ? 1 : 0)), tmp);
227 vlib_log_register_class (char *class, char *subclass)
229 vlib_log_main_t *lm = &log_main;
230 vlib_log_class_data_t *c = NULL;
231 vlib_log_subclass_data_t *s;
232 vlib_log_class_data_t *tmp;
233 vec_foreach (tmp, lm->classes)
235 if (!memcmp (class, tmp->name, vec_len (tmp->name)))
243 vec_add2 (lm->classes, c, 1);
244 c->index = c - lm->classes;
245 c->name = format (0, "%s", class);
248 vec_add2 (c->subclasses, s, 1);
249 s->index = s - c->subclasses;
250 s->name = subclass ? format (0, "%s", subclass) : 0;
251 s->rate_limit = lm->default_rate_limit;
252 s->level = lm->default_log_level;
253 s->syslog_level = lm->default_syslog_log_level;
254 return (c->index << 16) | (s->index);
258 format_vlib_log_level (u8 * s, va_list * args)
260 vlib_log_level_t i = va_arg (*args, vlib_log_level_t);
265 #define _(v,uc,lc) case VLIB_LOG_LEVEL_##uc: t = #lc; break;
266 foreach_vlib_log_level
269 return format (s, "unknown");
271 return format (s, "%s", t);
275 vlib_log_get_indent ()
277 return log_main.indent;
280 static clib_error_t *
281 vlib_log_init (vlib_main_t * vm)
283 vlib_log_main_t *lm = &log_main;
285 gettimeofday (&lm->time_zero_timeval, 0);
286 lm->time_zero = vlib_time_now (vm);
288 vec_validate (lm->entries, lm->size);
289 lm->log_class = vlib_log_register_class ("log", 0);
290 u8 *tmp = format (NULL, "%U %-10U %-10U ", format_time_float, 0, (f64) 0,
291 format_white_space, 255, format_white_space, 255);
292 log_main.indent = vec_len (tmp);
297 VLIB_INIT_FUNCTION (vlib_log_init);
300 static clib_error_t *
301 show_log (vlib_main_t * vm,
302 unformat_input_t * input, vlib_cli_command_t * cmd)
304 clib_error_t *error = 0;
305 vlib_log_main_t *lm = &log_main;
307 int i = last_log_entry ();
308 int count = lm->count;
311 time_offset = (f64) lm->time_zero_timeval.tv_sec
312 + (((f64) lm->time_zero_timeval.tv_usec) * 1e-6) - lm->time_zero;
316 e = vec_elt_at_index (lm->entries, i);
317 vlib_cli_output (vm, "%U %-10U %-10U %v",
318 format_time_float, 0, e->timestamp + time_offset,
319 format_vlib_log_level, e->level,
320 format_vlib_log_class, e->class, e->string);
321 i = (i + 1) % lm->size;
328 VLIB_CLI_COMMAND (cli_show_log, static) = {
329 .path = "show logging",
330 .short_help = "show logging",
331 .function = show_log,
335 static clib_error_t *
336 show_log_config (vlib_main_t * vm,
337 unformat_input_t * input, vlib_cli_command_t * cmd)
339 clib_error_t *error = 0;
340 vlib_log_main_t *lm = &log_main;
341 vlib_log_class_data_t *c;
342 vlib_log_subclass_data_t *sc;
344 vlib_cli_output (vm, "%-20s %u entries", "Buffer Size:", lm->size);
345 vlib_cli_output (vm, "Defaults:\n");
346 vlib_cli_output (vm, "%-20s %U", " Log Level:",
347 format_vlib_log_level, lm->default_log_level);
348 vlib_cli_output (vm, "%-20s %U", " Syslog Log Level:",
349 format_vlib_log_level, lm->default_syslog_log_level);
350 vlib_cli_output (vm, "%-20s %u msgs/sec", " Rate Limit:",
351 lm->default_rate_limit);
352 vlib_cli_output (vm, "\n");
353 vlib_cli_output (vm, "%-22s %-14s %-14s %s",
354 "Class/Subclass", "Level", "Syslog Level", "Rate Limit");
357 u8 *defstr = format (0, "default");
358 vec_foreach (c, lm->classes)
360 vlib_cli_output (vm, "%v", c->name);
361 vec_foreach (sc, c->subclasses)
363 vlib_cli_output (vm, " %-20v %-14U %-14U %d",
364 sc->name ? sc->name : defstr,
365 format_vlib_log_level, sc->level,
366 format_vlib_log_level, sc->syslog_level,
376 VLIB_CLI_COMMAND (cli_show_log_config, static) = {
377 .path = "show logging configuration",
378 .short_help = "show logging configuration",
379 .function = show_log_config,
383 static clib_error_t *
384 clear_log (vlib_main_t * vm,
385 unformat_input_t * input, vlib_cli_command_t * cmd)
387 clib_error_t *error = 0;
388 vlib_log_main_t *lm = &log_main;
390 int i = last_log_entry ();
391 int count = lm->count;
395 e = vec_elt_at_index (lm->entries, i);
396 vec_free (e->string);
397 i = (i + 1) % lm->size;
402 vlib_log_info (lm->log_class, "log cleared");
407 VLIB_CLI_COMMAND (cli_clear_log, static) = {
408 .path = "clear logging",
409 .short_help = "clear logging",
410 .function = clear_log,
415 unformat_vlib_log_level (unformat_input_t * input, va_list * args)
417 vlib_log_level_t *level = va_arg (*args, vlib_log_level_t *);
418 u8 *level_str = NULL;
420 if (unformat (input, "%s", &level_str))
422 #define _(v, uc, lc) \
423 const char __##uc[] = #lc; \
424 if (!strcmp ((const char *) level_str, __##uc)) \
426 *level = VLIB_LOG_LEVEL_##uc; \
430 foreach_vlib_log_level;
435 vec_free (level_str);
440 unformat_vlib_log_class (unformat_input_t * input, va_list * args)
442 vlib_log_class_data_t **class = va_arg (*args, vlib_log_class_data_t **);
444 u8 *class_str = NULL;
445 vlib_log_main_t *lm = &log_main;
446 if (unformat (input, "%v", &class_str))
448 vlib_log_class_data_t *cdata;
449 vec_foreach (cdata, lm->classes)
451 if (vec_is_equal (cdata->name, class_str))
459 vec_free (class_str);
463 static clib_error_t *
464 set_log_class (vlib_main_t * vm,
465 unformat_input_t * input, vlib_cli_command_t * cmd)
467 unformat_input_t _line_input, *line_input = &_line_input;
468 clib_error_t *rv = NULL;
470 bool set_rate_limit = false;
471 bool set_level = false;
472 bool set_syslog_level = false;
473 vlib_log_level_t level;
474 vlib_log_level_t syslog_level;
476 /* Get a line of input. */
477 if (!unformat_user (input, unformat_line_input, line_input))
480 vlib_log_class_data_t *class = NULL;
481 if (!unformat (line_input, "%U", unformat_vlib_log_class, &class))
483 return clib_error_return (0, "unknown log class `%U'",
484 format_unformat_error, line_input);
486 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
488 if (unformat (line_input, "rate-limit %d", &rate_limit))
490 set_rate_limit = true;
494 (line_input, "level %U", unformat_vlib_log_level, &level))
500 (line_input, "syslog-level %U", unformat_vlib_log_level,
503 set_syslog_level = true;
507 return clib_error_return (0, "unknown input `%U'",
508 format_unformat_error, line_input);
514 vlib_log_subclass_data_t *subclass;
515 vec_foreach (subclass, class->subclasses)
517 subclass->level = level;
520 if (set_syslog_level)
522 vlib_log_subclass_data_t *subclass;
523 vec_foreach (subclass, class->subclasses)
525 subclass->syslog_level = syslog_level;
530 vlib_log_subclass_data_t *subclass;
531 vec_foreach (subclass, class->subclasses)
533 subclass->rate_limit = rate_limit;
541 VLIB_CLI_COMMAND (cli_set_log, static) = {
542 .path = "set logging class",
543 .short_help = "set loggging class <class> [rate-limit <int>] "
544 "[level <level>] [syslog-level <level>]",
545 .function = set_log_class,
549 static clib_error_t *
550 set_log_unth_time (vlib_main_t * vm,
551 unformat_input_t * input, vlib_cli_command_t * cmd)
553 unformat_input_t _line_input, *line_input = &_line_input;
554 clib_error_t *rv = NULL;
556 vlib_log_main_t *lm = &log_main;
558 /* Get a line of input. */
559 if (!unformat_user (input, unformat_line_input, line_input))
562 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
564 if (unformat (line_input, "%d", &unthrottle_time))
565 lm->unthrottle_time = unthrottle_time;
567 return clib_error_return (0, "unknown input `%U'",
568 format_unformat_error, line_input);
575 VLIB_CLI_COMMAND (cli_set_log_params, static) = {
576 .path = "set logging unthrottle-time",
577 .short_help = "set logging unthrottle-time <int>",
578 .function = set_log_unth_time,
582 static clib_error_t *
583 set_log_size (vlib_main_t * vm,
584 unformat_input_t * input, vlib_cli_command_t * cmd)
586 unformat_input_t _line_input, *line_input = &_line_input;
587 clib_error_t *rv = NULL;
589 vlib_log_main_t *lm = &log_main;
591 /* Get a line of input. */
592 if (!unformat_user (input, unformat_line_input, line_input))
595 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
597 if (unformat (line_input, "%d", &size))
600 vec_validate (lm->entries, lm->size);
603 return clib_error_return (0, "unknown input `%U'",
604 format_unformat_error, line_input);
611 VLIB_CLI_COMMAND (cli_set_log_size, static) = {
612 .path = "set logging size",
613 .short_help = "set logging size <int>",
614 .function = set_log_size,
619 unformat_vlib_log_subclass (unformat_input_t * input, va_list * args)
621 vlib_log_class_data_t *class = va_arg (*args, vlib_log_class_data_t *);
622 vlib_log_subclass_data_t **subclass =
623 va_arg (*args, vlib_log_subclass_data_t **);
625 u8 *subclass_str = NULL;
626 if (unformat (input, "%v", &subclass_str))
628 vlib_log_subclass_data_t *scdata;
629 vec_foreach (scdata, class->subclasses)
631 if (vec_is_equal (scdata->name, subclass_str))
639 vec_free (subclass_str);
643 static clib_error_t *
644 test_log_class_subclass (vlib_main_t * vm,
645 unformat_input_t * input, vlib_cli_command_t * cmd)
647 unformat_input_t _line_input, *line_input = &_line_input;
648 /* Get a line of input. */
649 if (!unformat_user (input, unformat_line_input, line_input))
652 vlib_log_class_data_t *class = NULL;
653 vlib_log_subclass_data_t *subclass = NULL;
654 vlib_log_level_t level;
655 if (unformat (line_input, "%U", unformat_vlib_log_level, &level))
657 if (unformat (line_input, "%U", unformat_vlib_log_class, &class))
660 (line_input, "%U", unformat_vlib_log_subclass, class,
664 (class->index << 16) | (subclass->index), "%U",
665 format_unformat_input, line_input);
669 return clib_error_return (0,
670 "unknown log subclass near beginning of `%U'",
671 format_unformat_error, line_input);
676 return clib_error_return (0,
677 "unknown log class near beginning of `%U'",
678 format_unformat_error, line_input);
683 return clib_error_return (0, "unknown log level near beginning of `%U'",
684 format_unformat_error, line_input);
690 VLIB_CLI_COMMAND (cli_test_log, static) = {
692 .short_help = "test log <class> <subclass> <level> <message",
693 .function = test_log_class_subclass,
697 static clib_error_t *
698 log_config (vlib_main_t * vm, unformat_input_t * input)
700 vlib_log_main_t *lm = &log_main;
702 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
704 if (unformat (input, "size %d", &lm->size))
705 vec_validate (lm->entries, lm->size);
706 else if (unformat (input, "unthrottle-time %d", &lm->unthrottle_time))
708 else if (unformat (input, "default-log-level %U",
709 unformat_vlib_log_level, &lm->default_log_level))
711 else if (unformat (input, "default-syslog-log-level %U",
712 unformat_vlib_log_level,
713 &lm->default_syslog_log_level))
717 return unformat_parse_error (input);
724 VLIB_EARLY_CONFIG_FUNCTION (log_config, "logging");
727 * fd.io coding-style-patch-verification: ON
730 * eval: (c-set-style "gnu")