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>
21 vlib_log_main_t log_main = {
22 .default_log_level = VLIB_LOG_LEVEL_NOTICE,
23 .default_syslog_log_level = VLIB_LOG_LEVEL_WARNING,
26 .default_rate_limit = 50,
32 vlib_log_main_t *lm = &log_main;
35 i = lm->next - lm->count;
42 static vlib_log_class_data_t *
43 get_class_data (vlib_log_class_t ci)
45 vlib_log_main_t *lm = &log_main;
46 return vec_elt_at_index (lm->classes, (ci >> 16));
49 static vlib_log_subclass_data_t *
50 get_subclass_data (vlib_log_class_t ci)
52 vlib_log_class_data_t *c = get_class_data (ci);
53 return vec_elt_at_index (c->subclasses, (ci & 0xffff));
57 vlib_log_level_to_syslog_priority (vlib_log_level_t level)
61 #define LOG_DISABLED LOG_DEBUG
63 case VLIB_LOG_LEVEL_##uc:\
65 foreach_vlib_log_level
73 format_vlib_log_class (u8 * s, va_list * args)
75 vlib_log_class_t ci = va_arg (*args, vlib_log_class_t);
76 vlib_log_class_data_t *c = get_class_data (ci);
77 vlib_log_subclass_data_t *sc = get_subclass_data (ci);
80 return format (s, "%v/%v", c->name, sc->name);
82 return format (s, "%v", c->name, 0);
87 vlib_log (vlib_log_level_t level, vlib_log_class_t class, char *fmt, ...)
89 vlib_main_t *vm = vlib_get_main ();
90 vlib_log_main_t *lm = &log_main;
92 vlib_log_subclass_data_t *sc = get_subclass_data (class);
94 f64 t = vlib_time_now (vm);
95 f64 delta = t - sc->last_event_timestamp;
97 bool use_formatted_log_entry = true;
99 vec_validate (lm->entries, lm->size);
100 /* make sure we are running on the main thread to avoid use in dataplane
101 code, for dataplane logging consider use of event-logger */
102 ASSERT (vlib_get_thread_index () == 0);
104 if (level > sc->level)
106 use_formatted_log_entry = false;
110 if ((delta > lm->unthrottle_time) ||
111 (sc->is_throttling == 0 && (delta > 1)))
113 sc->last_event_timestamp = t;
114 sc->last_sec_count = 0;
115 sc->is_throttling = 0;
119 sc->last_sec_count++;
120 if (sc->last_sec_count > sc->rate_limit)
122 else if (sc->last_sec_count == sc->rate_limit)
124 vec_reset_length (s);
125 s = format (0, "--- message(s) throttled ---");
126 sc->is_throttling = 1;
133 s = va_format (s, fmt, &va);
137 e = vec_elt_at_index (lm->entries, lm->next);
138 vec_free (e->string);
144 lm->next = (lm->next + 1) % lm->size;
145 if (lm->size > lm->count)
149 if (sc->syslog_level != VLIB_LOG_LEVEL_DISABLED &&
150 level <= sc->syslog_level)
152 u8 *tmp = format (NULL, "%U", format_vlib_log_class, class);
153 if (use_formatted_log_entry)
155 syslog (vlib_log_level_to_syslog_priority (level), "%.*s: %.*s",
156 (int) vec_len (tmp), tmp,
158 (vec_c_string_is_terminated (s) ? 1 : 0)), s);
162 tmp = format (tmp, ": ");
164 tmp = va_format (tmp, fmt, &va);
166 syslog (vlib_log_level_to_syslog_priority (level), "%.*s",
167 (int) (vec_len (tmp) -
168 (vec_c_string_is_terminated (tmp) ? 1 : 0)), tmp);
175 static vlib_log_class_t
176 vlib_log_register_class_internal (char *class, char *subclass, u32 limit)
178 vlib_log_main_t *lm = &log_main;
179 vlib_log_class_data_t *c = NULL;
180 vlib_log_subclass_data_t *s;
181 vlib_log_class_data_t *tmp;
182 vec_foreach (tmp, lm->classes)
184 if (vec_len (tmp->name) != strlen (class))
186 if (!memcmp (class, tmp->name, vec_len (tmp->name)))
194 vec_add2 (lm->classes, c, 1);
195 c->index = c - lm->classes;
196 c->name = format (0, "%s", class);
199 vec_add2 (c->subclasses, s, 1);
200 s->index = s - c->subclasses;
201 s->name = subclass ? format (0, "%s", subclass) : 0;
202 s->rate_limit = (limit == 0) ? lm->default_rate_limit : limit;
203 s->level = lm->default_log_level;
204 s->syslog_level = lm->default_syslog_log_level;
205 return (c->index << 16) | (s->index);
209 vlib_log_register_class (char *class, char *subclass)
211 return vlib_log_register_class_internal (class, subclass,
212 0 /* default rate limit */ );
216 vlib_log_register_class_rate_limit (char *class, char *subclass, u32 limit)
218 return vlib_log_register_class_internal (class, subclass, limit);
223 format_vlib_log_level (u8 * s, va_list * args)
225 vlib_log_level_t i = va_arg (*args, vlib_log_level_t);
230 #define _(v,uc,lc) case VLIB_LOG_LEVEL_##uc: t = #lc; break;
231 foreach_vlib_log_level
234 return format (s, "unknown");
236 return format (s, "%s", t);
240 vlib_log_get_indent ()
242 return log_main.indent;
245 static clib_error_t *
246 vlib_log_init (vlib_main_t * vm)
248 vlib_log_main_t *lm = &log_main;
250 gettimeofday (&lm->time_zero_timeval, 0);
251 lm->time_zero = vlib_time_now (vm);
253 vec_validate (lm->entries, lm->size);
254 lm->log_class = vlib_log_register_class ("log", 0);
255 u8 *tmp = format (NULL, "%U %-10U %-10U ", format_time_float, 0, (f64) 0,
256 format_white_space, 255, format_white_space, 255);
257 log_main.indent = vec_len (tmp);
262 VLIB_INIT_FUNCTION (vlib_log_init);
265 static clib_error_t *
266 show_log (vlib_main_t * vm,
267 unformat_input_t * input, vlib_cli_command_t * cmd)
269 clib_error_t *error = 0;
270 vlib_log_main_t *lm = &log_main;
272 int i = last_log_entry ();
273 int count = lm->count;
276 time_offset = (f64) lm->time_zero_timeval.tv_sec
277 + (((f64) lm->time_zero_timeval.tv_usec) * 1e-6) - lm->time_zero;
281 e = vec_elt_at_index (lm->entries, i);
282 vlib_cli_output (vm, "%U %-10U %-14U %v",
283 format_time_float, 0, e->timestamp + time_offset,
284 format_vlib_log_level, e->level,
285 format_vlib_log_class, e->class, e->string);
286 i = (i + 1) % lm->size;
293 VLIB_CLI_COMMAND (cli_show_log, static) = {
294 .path = "show logging",
295 .short_help = "show logging",
296 .function = show_log,
300 static clib_error_t *
301 show_log_config (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;
306 vlib_log_class_data_t *c;
307 vlib_log_subclass_data_t *sc;
309 vlib_cli_output (vm, "%-20s %u entries", "Buffer Size:", lm->size);
310 vlib_cli_output (vm, "Defaults:\n");
311 vlib_cli_output (vm, "%-20s %U", " Log Level:",
312 format_vlib_log_level, lm->default_log_level);
313 vlib_cli_output (vm, "%-20s %U", " Syslog Log Level:",
314 format_vlib_log_level, lm->default_syslog_log_level);
315 vlib_cli_output (vm, "%-20s %u msgs/sec", " Rate Limit:",
316 lm->default_rate_limit);
317 vlib_cli_output (vm, "\n");
318 vlib_cli_output (vm, "%-22s %-14s %-14s %s",
319 "Class/Subclass", "Level", "Syslog Level", "Rate Limit");
322 u8 *defstr = format (0, "default");
323 vec_foreach (c, lm->classes)
325 vlib_cli_output (vm, "%v", c->name);
326 vec_foreach (sc, c->subclasses)
328 vlib_cli_output (vm, " %-20v %-14U %-14U %d",
329 sc->name ? sc->name : defstr,
330 format_vlib_log_level, sc->level,
331 format_vlib_log_level, sc->syslog_level,
341 VLIB_CLI_COMMAND (cli_show_log_config, static) = {
342 .path = "show logging configuration",
343 .short_help = "show logging configuration",
344 .function = show_log_config,
348 static clib_error_t *
349 clear_log (vlib_main_t * vm,
350 unformat_input_t * input, vlib_cli_command_t * cmd)
352 clib_error_t *error = 0;
353 vlib_log_main_t *lm = &log_main;
355 int i = last_log_entry ();
356 int count = lm->count;
360 e = vec_elt_at_index (lm->entries, i);
361 vec_free (e->string);
362 i = (i + 1) % lm->size;
367 vlib_log_info (lm->log_class, "log cleared");
372 VLIB_CLI_COMMAND (cli_clear_log, static) = {
373 .path = "clear logging",
374 .short_help = "clear logging",
375 .function = clear_log,
380 unformat_vlib_log_level (unformat_input_t * input, va_list * args)
382 vlib_log_level_t *level = va_arg (*args, vlib_log_level_t *);
383 u8 *level_str = NULL;
385 if (unformat (input, "%s", &level_str))
387 #define _(v, uc, lc) \
388 const char __##uc[] = #lc; \
389 if (!strcmp ((const char *) level_str, __##uc)) \
391 *level = VLIB_LOG_LEVEL_##uc; \
395 foreach_vlib_log_level;
400 vec_free (level_str);
405 unformat_vlib_log_class (unformat_input_t * input, va_list * args)
407 vlib_log_class_data_t **class = va_arg (*args, vlib_log_class_data_t **);
409 u8 *class_str = NULL;
410 vlib_log_main_t *lm = &log_main;
411 if (unformat (input, "%v", &class_str))
413 vlib_log_class_data_t *cdata;
414 vec_foreach (cdata, lm->classes)
416 if (vec_is_equal (cdata->name, class_str))
424 vec_free (class_str);
428 static clib_error_t *
429 set_log_class (vlib_main_t * vm,
430 unformat_input_t * input, vlib_cli_command_t * cmd)
432 unformat_input_t _line_input, *line_input = &_line_input;
433 clib_error_t *rv = NULL;
435 bool set_rate_limit = false;
436 bool set_level = false;
437 bool set_syslog_level = false;
438 vlib_log_level_t level;
439 vlib_log_level_t syslog_level;
441 /* Get a line of input. */
442 if (!unformat_user (input, unformat_line_input, line_input))
445 vlib_log_class_data_t *class = NULL;
446 if (!unformat (line_input, "%U", unformat_vlib_log_class, &class))
448 return clib_error_return (0, "unknown log class `%U'",
449 format_unformat_error, line_input);
451 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
453 if (unformat (line_input, "rate-limit %d", &rate_limit))
455 set_rate_limit = true;
459 (line_input, "level %U", unformat_vlib_log_level, &level))
465 (line_input, "syslog-level %U", unformat_vlib_log_level,
468 set_syslog_level = true;
472 return clib_error_return (0, "unknown input `%U'",
473 format_unformat_error, line_input);
479 vlib_log_subclass_data_t *subclass;
480 vec_foreach (subclass, class->subclasses)
482 subclass->level = level;
485 if (set_syslog_level)
487 vlib_log_subclass_data_t *subclass;
488 vec_foreach (subclass, class->subclasses)
490 subclass->syslog_level = syslog_level;
495 vlib_log_subclass_data_t *subclass;
496 vec_foreach (subclass, class->subclasses)
498 subclass->rate_limit = rate_limit;
506 VLIB_CLI_COMMAND (cli_set_log, static) = {
507 .path = "set logging class",
508 .short_help = "set logging class <class> [rate-limit <int>] "
509 "[level <level>] [syslog-level <level>]",
510 .function = set_log_class,
514 static clib_error_t *
515 set_log_unth_time (vlib_main_t * vm,
516 unformat_input_t * input, vlib_cli_command_t * cmd)
518 unformat_input_t _line_input, *line_input = &_line_input;
519 clib_error_t *rv = NULL;
521 vlib_log_main_t *lm = &log_main;
523 /* Get a line of input. */
524 if (!unformat_user (input, unformat_line_input, line_input))
527 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
529 if (unformat (line_input, "%d", &unthrottle_time))
530 lm->unthrottle_time = unthrottle_time;
532 return clib_error_return (0, "unknown input `%U'",
533 format_unformat_error, line_input);
540 VLIB_CLI_COMMAND (cli_set_log_params, static) = {
541 .path = "set logging unthrottle-time",
542 .short_help = "set logging unthrottle-time <int>",
543 .function = set_log_unth_time,
547 static clib_error_t *
548 set_log_size (vlib_main_t * vm,
549 unformat_input_t * input, vlib_cli_command_t * cmd)
551 unformat_input_t _line_input, *line_input = &_line_input;
552 clib_error_t *rv = NULL;
554 vlib_log_main_t *lm = &log_main;
556 /* Get a line of input. */
557 if (!unformat_user (input, unformat_line_input, line_input))
560 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
562 if (unformat (line_input, "%d", &size))
565 vec_validate (lm->entries, lm->size);
568 return clib_error_return (0, "unknown input `%U'",
569 format_unformat_error, line_input);
576 VLIB_CLI_COMMAND (cli_set_log_size, static) = {
577 .path = "set logging size",
578 .short_help = "set logging size <int>",
579 .function = set_log_size,
584 unformat_vlib_log_subclass (unformat_input_t * input, va_list * args)
586 vlib_log_class_data_t *class = va_arg (*args, vlib_log_class_data_t *);
587 vlib_log_subclass_data_t **subclass =
588 va_arg (*args, vlib_log_subclass_data_t **);
590 u8 *subclass_str = NULL;
591 if (unformat (input, "%v", &subclass_str))
593 vlib_log_subclass_data_t *scdata;
594 vec_foreach (scdata, class->subclasses)
596 if (vec_is_equal (scdata->name, subclass_str))
604 vec_free (subclass_str);
608 static clib_error_t *
609 test_log_class_subclass (vlib_main_t * vm,
610 unformat_input_t * input, vlib_cli_command_t * cmd)
612 unformat_input_t _line_input, *line_input = &_line_input;
613 /* Get a line of input. */
614 if (!unformat_user (input, unformat_line_input, line_input))
617 vlib_log_class_data_t *class = NULL;
618 vlib_log_subclass_data_t *subclass = NULL;
619 vlib_log_level_t level;
620 if (unformat (line_input, "%U", unformat_vlib_log_level, &level))
622 if (unformat (line_input, "%U", unformat_vlib_log_class, &class))
625 (line_input, "%U", unformat_vlib_log_subclass, class,
629 (class->index << 16) | (subclass->index), "%U",
630 format_unformat_input, line_input);
634 return clib_error_return (0,
635 "unknown log subclass near beginning of `%U'",
636 format_unformat_error, line_input);
641 return clib_error_return (0,
642 "unknown log class near beginning of `%U'",
643 format_unformat_error, line_input);
648 return clib_error_return (0, "unknown log level near beginning of `%U'",
649 format_unformat_error, line_input);
655 VLIB_CLI_COMMAND (cli_test_log, static) = {
657 .short_help = "test log <level> <class> <subclass> <message>",
658 .function = test_log_class_subclass,
662 static clib_error_t *
663 log_config (vlib_main_t * vm, unformat_input_t * input)
665 vlib_log_main_t *lm = &log_main;
667 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
669 if (unformat (input, "size %d", &lm->size))
670 vec_validate (lm->entries, lm->size);
671 else if (unformat (input, "unthrottle-time %d", &lm->unthrottle_time))
673 else if (unformat (input, "default-log-level %U",
674 unformat_vlib_log_level, &lm->default_log_level))
676 else if (unformat (input, "default-syslog-log-level %U",
677 unformat_vlib_log_level,
678 &lm->default_syslog_log_level))
682 return unformat_parse_error (input);
689 VLIB_EARLY_CONFIG_FUNCTION (log_config, "logging");
692 * fd.io coding-style-patch-verification: ON
695 * eval: (c-set-style "gnu")