3 * Copyright (C) 1997, 1998, 1999 Kunihiro Ishiguro
5 * This file is part of GNU Zebra.
7 * GNU Zebra is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License as published by the
9 * Free Software Foundation; either version 2, or (at your option) any
12 * GNU Zebra is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; see the file COPYING; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 #define FRR_DEFINE_DESC_TABLE
31 #include "lib_errors.h"
36 /* for printstack on solaris */
37 #ifdef HAVE_UCONTEXT_H
41 DEFINE_MTYPE_STATIC(LIB
, ZLOG
, "Logging")
43 static int logfile_fd
= -1; /* Used in signal handler. */
45 struct zlog
*zlog_default
= NULL
;
46 bool zlog_startup_stderr
= true;
48 /* lock protecting zlog_default for mt-safe zlog */
49 pthread_mutex_t loglock
= PTHREAD_MUTEX_INITIALIZER
;
51 const char *zlog_priority
[] = {
52 "emergencies", "alerts", "critical", "errors", "warnings",
53 "notifications", "informational", "debugging", NULL
,
59 * glibc has declared that the return value from write *must* not be
61 * gcc see's this problem and issues a warning for the line.
63 * Why is this a big deal you say? Because both of them are right
64 * and if you have -Werror enabled then all calls to write
65 * generate a build error and the build stops.
67 * clang has helpfully allowed this construct:
69 * to tell the compiler yeah I know it has a return value
70 * I don't care about it at this time.
71 * gcc doesn't have this ability.
73 * This code was written such that it didn't care about the
74 * return value from write. At this time do I want
75 * to go through and fix and test this code for correctness.
76 * So just wrapper the bad behavior and move on.
78 static void write_wrapper(int fd
, const void *buf
, size_t count
)
80 if (write(fd
, buf
, count
) <= 0)
87 * Looks up a message in a message list by key.
89 * If the message is not found, returns the provided error message.
91 * Terminates when it hits a struct message that's all zeros.
93 * @param mz the message list
94 * @param kz the message key
95 * @param nf the message to return if not found
98 const char *lookup_msg(const struct message
*mz
, int kz
, const char *nf
)
100 static struct message nt
= {0};
101 const char *rz
= nf
? nf
: "(no message found)";
102 const struct message
*pnt
;
103 for (pnt
= mz
; memcmp(pnt
, &nt
, sizeof(struct message
)); pnt
++)
104 if (pnt
->key
== kz
) {
105 rz
= pnt
->str
? pnt
->str
: rz
;
111 /* For time string format. */
112 size_t quagga_timestamp(int timestamp_precision
, char *buf
, size_t buflen
)
119 struct timeval clock
;
121 gettimeofday(&clock
, NULL
);
123 /* first, we update the cache if the time has changed */
124 if (cache
.last
!= clock
.tv_sec
) {
126 cache
.last
= clock
.tv_sec
;
127 tm
= localtime(&cache
.last
);
128 cache
.len
= strftime(cache
.buf
, sizeof(cache
.buf
),
129 "%Y/%m/%d %H:%M:%S", tm
);
131 /* note: it's not worth caching the subsecond part, because
132 chances are that back-to-back calls are not sufficiently close
134 for the clock not to have ticked forward */
136 if (buflen
> cache
.len
) {
137 memcpy(buf
, cache
.buf
, cache
.len
);
138 if ((timestamp_precision
> 0)
139 && (buflen
> cache
.len
+ 1 + timestamp_precision
)) {
140 /* should we worry about locale issues? */
141 static const int divisor
[] = {0, 100000, 10000, 1000,
144 char *p
= buf
+ cache
.len
+ 1
145 + (prec
= timestamp_precision
);
148 /* this is unlikely to happen, but protect anyway */
153 clock
.tv_usec
/= divisor
[prec
];
155 *p
-- = '0' + (clock
.tv_usec
% 10);
157 } while (--prec
> 0);
159 return cache
.len
+ 1 + timestamp_precision
;
161 buf
[cache
.len
] = '\0';
169 /* Utility routine for current time printing. */
170 static void time_print(FILE *fp
, struct timestamp_control
*ctl
)
172 if (!ctl
->already_rendered
) {
173 ctl
->len
= quagga_timestamp(ctl
->precision
, ctl
->buf
,
175 ctl
->already_rendered
= 1;
177 fprintf(fp
, "%s ", ctl
->buf
);
181 static void vzlog_file(struct zlog
*zl
, struct timestamp_control
*tsctl
,
182 const char *proto_str
, int record_priority
, int priority
,
183 FILE *fp
, const char *format
, va_list args
)
187 time_print(fp
, tsctl
);
189 fprintf(fp
, "%s: ", zlog_priority
[priority
]);
191 fprintf(fp
, "%s", proto_str
);
193 vfprintf(fp
, format
, ac
);
199 /* va_list version of zlog. */
200 void vzlog(int priority
, const char *format
, va_list args
)
202 pthread_mutex_lock(&loglock
);
205 int original_errno
= errno
;
206 struct timestamp_control tsctl
;
207 tsctl
.already_rendered
= 0;
208 struct zlog
*zl
= zlog_default
;
210 /* When zlog_default is also NULL, use stderr for logging. */
213 time_print(stderr
, &tsctl
);
214 fprintf(stderr
, "%s: ", "unknown");
215 vfprintf(stderr
, format
, args
);
216 fprintf(stderr
, "\n");
219 /* In this case we return at here. */
220 errno
= original_errno
;
221 pthread_mutex_unlock(&loglock
);
224 tsctl
.precision
= zl
->timestamp_precision
;
227 if (priority
<= zl
->maxlvl
[ZLOG_DEST_SYSLOG
]) {
230 vsyslog(priority
| zlog_default
->facility
, format
, ac
);
235 sprintf(proto_str
, "%s[%d]: ", zl
->protoname
, zl
->instance
);
237 sprintf(proto_str
, "%s: ", zl
->protoname
);
240 if ((priority
<= zl
->maxlvl
[ZLOG_DEST_FILE
]) && zl
->fp
)
241 vzlog_file(zl
, &tsctl
, proto_str
, zl
->record_priority
, priority
,
242 zl
->fp
, format
, args
);
244 /* fixed-config logging to stderr while we're stating up & haven't
245 * daemonized / reached mainloop yet
247 * note the "else" on stdout output -- we don't want to print the same
248 * message to both stderr and stdout. */
249 if (zlog_startup_stderr
&& priority
<= LOG_WARNING
)
250 vzlog_file(zl
, &tsctl
, proto_str
, 1, priority
, stderr
, format
,
252 else if (priority
<= zl
->maxlvl
[ZLOG_DEST_STDOUT
])
253 vzlog_file(zl
, &tsctl
, proto_str
, zl
->record_priority
, priority
,
254 stdout
, format
, args
);
256 /* Terminal monitor. */
257 if (priority
<= zl
->maxlvl
[ZLOG_DEST_MONITOR
])
258 vty_log((zl
->record_priority
? zlog_priority
[priority
] : NULL
),
259 proto_str
, format
, &tsctl
, args
);
261 errno
= original_errno
;
262 pthread_mutex_unlock(&loglock
);
265 int vzlog_test(int priority
)
267 pthread_mutex_lock(&loglock
);
271 struct zlog
*zl
= zlog_default
;
273 /* When zlog_default is also NULL, use stderr for logging. */
277 else if (priority
<= zl
->maxlvl
[ZLOG_DEST_SYSLOG
])
280 else if ((priority
<= zl
->maxlvl
[ZLOG_DEST_FILE
]) && zl
->fp
)
283 else if (priority
<= zl
->maxlvl
[ZLOG_DEST_STDOUT
])
285 /* Terminal monitor. */
286 else if (priority
<= zl
->maxlvl
[ZLOG_DEST_MONITOR
])
289 pthread_mutex_unlock(&loglock
);
294 static char *str_append(char *dst
, int len
, const char *src
)
296 while ((len
-- > 0) && *src
)
301 static char *num_append(char *s
, int len
, unsigned long x
)
307 return str_append(s
, len
, "0");
308 *(t
= &buf
[sizeof(buf
) - 1]) = '\0';
309 while (x
&& (t
> buf
)) {
310 *--t
= '0' + (x
% 10);
313 return str_append(s
, len
, t
);
316 #if defined(SA_SIGINFO) || defined(HAVE_STACK_TRACE)
317 static char *hex_append(char *s
, int len
, unsigned long x
)
323 return str_append(s
, len
, "0");
324 *(t
= &buf
[sizeof(buf
) - 1]) = '\0';
325 while (x
&& (t
> buf
)) {
326 unsigned int cc
= (x
% 16);
327 *--t
= ((cc
< 10) ? ('0' + cc
) : ('a' + cc
- 10));
330 return str_append(s
, len
, t
);
334 /* Needs to be enhanced to support Solaris. */
335 static int syslog_connect(void)
342 struct sockaddr_un addr
;
344 if ((fd
= socket(AF_UNIX
, SOCK_DGRAM
, 0)) < 0)
346 addr
.sun_family
= AF_UNIX
;
348 #define SYSLOG_SOCKET_PATH _PATH_LOG
350 #define SYSLOG_SOCKET_PATH "/dev/log"
352 s
= str_append(addr
.sun_path
, sizeof(addr
.sun_path
),
354 #undef SYSLOG_SOCKET_PATH
356 if (connect(fd
, (struct sockaddr
*)&addr
, sizeof(addr
)) < 0) {
364 static void syslog_sigsafe(int priority
, const char *msg
, size_t msglen
)
366 static int syslog_fd
= -1;
367 char buf
[sizeof("<1234567890>ripngd[1234567890]: ") + msglen
+ 50];
370 if ((syslog_fd
< 0) && ((syslog_fd
= syslog_connect()) < 0))
373 #define LOC s,buf+sizeof(buf)-s
375 s
= str_append(LOC
, "<");
376 s
= num_append(LOC
, priority
);
377 s
= str_append(LOC
, ">");
378 /* forget about the timestamp, too difficult in a signal handler */
379 s
= str_append(LOC
, zlog_default
->ident
);
380 if (zlog_default
->syslog_options
& LOG_PID
) {
381 s
= str_append(LOC
, "[");
382 s
= num_append(LOC
, getpid());
383 s
= str_append(LOC
, "]");
385 s
= str_append(LOC
, ": ");
386 s
= str_append(LOC
, msg
);
387 write_wrapper(syslog_fd
, buf
, s
- buf
);
391 static int open_crashlog(void)
393 #define CRASHLOG_PREFIX "/var/tmp/quagga."
394 #define CRASHLOG_SUFFIX "crashlog"
395 if (zlog_default
&& zlog_default
->ident
) {
396 /* Avoid strlen since it is not async-signal-safe. */
400 for (p
= zlog_default
->ident
, ilen
= 0; *p
; p
++)
403 char buf
[sizeof(CRASHLOG_PREFIX
) + ilen
404 + sizeof(CRASHLOG_SUFFIX
) + 3];
406 #define LOC s,buf+sizeof(buf)-s
407 s
= str_append(LOC
, CRASHLOG_PREFIX
);
408 s
= str_append(LOC
, zlog_default
->ident
);
409 s
= str_append(LOC
, ".");
410 s
= str_append(LOC
, CRASHLOG_SUFFIX
);
413 return open(buf
, O_WRONLY
| O_CREAT
| O_EXCL
,
417 return open(CRASHLOG_PREFIX CRASHLOG_SUFFIX
,
418 O_WRONLY
| O_CREAT
| O_EXCL
, LOGFILE_MASK
);
419 #undef CRASHLOG_SUFFIX
420 #undef CRASHLOG_PREFIX
423 /* Note: the goal here is to use only async-signal-safe functions. */
424 void zlog_signal(int signo
, const char *action
427 siginfo_t
*siginfo
, void *program_counter
432 char buf
[sizeof("DEFAULT: Received signal S at T (si_addr 0xP, PC 0xP); aborting...")
435 char *msgstart
= buf
;
436 #define LOC s,buf+sizeof(buf)-s
440 s
= str_append(LOC
, zlog_default
->protoname
);
445 s
= str_append(LOC
, "Received signal ");
446 s
= num_append(LOC
, signo
);
447 s
= str_append(LOC
, " at ");
448 s
= num_append(LOC
, now
);
450 s
= str_append(LOC
, " (si_addr 0x");
451 s
= hex_append(LOC
, (unsigned long)(siginfo
->si_addr
));
452 if (program_counter
) {
453 s
= str_append(LOC
, ", PC 0x");
454 s
= hex_append(LOC
, (unsigned long)program_counter
);
456 s
= str_append(LOC
, "); ");
457 #else /* SA_SIGINFO */
458 s
= str_append(LOC
, "; ");
459 #endif /* SA_SIGINFO */
460 s
= str_append(LOC
, action
);
461 if (s
< buf
+ sizeof(buf
))
464 /* N.B. implicit priority is most severe */
467 #define DUMP(FD) write_wrapper(FD, buf, s-buf);
468 /* If no file logging configured, try to write to fallback log file. */
469 if ((logfile_fd
>= 0) || ((logfile_fd
= open_crashlog()) >= 0))
474 if (PRI
<= zlog_default
->maxlvl
[ZLOG_DEST_STDOUT
])
476 /* Remove trailing '\n' for monitor and syslog */
478 if (PRI
<= zlog_default
->maxlvl
[ZLOG_DEST_MONITOR
])
479 vty_log_fixed(buf
, s
- buf
);
480 if (PRI
<= zlog_default
->maxlvl
[ZLOG_DEST_SYSLOG
])
481 syslog_sigsafe(PRI
| zlog_default
->facility
, msgstart
,
486 zlog_backtrace_sigsafe(PRI
,
496 tc
= pthread_getspecific(thread_current
);
498 s
= str_append(LOC
, "no thread information available\n");
500 s
= str_append(LOC
, "in thread ");
501 s
= str_append(LOC
, tc
->funcname
);
502 s
= str_append(LOC
, " scheduled from ");
503 s
= str_append(LOC
, tc
->schedfrom
);
504 s
= str_append(LOC
, ":");
505 s
= num_append(LOC
, tc
->schedfrom_line
);
506 s
= str_append(LOC
, "\n");
509 #define DUMP(FD) write_wrapper(FD, buf, s-buf);
510 /* If no file logging configured, try to write to fallback log file. */
516 if (PRI
<= zlog_default
->maxlvl
[ZLOG_DEST_STDOUT
])
518 /* Remove trailing '\n' for monitor and syslog */
520 if (PRI
<= zlog_default
->maxlvl
[ZLOG_DEST_MONITOR
])
521 vty_log_fixed(buf
, s
- buf
);
522 if (PRI
<= zlog_default
->maxlvl
[ZLOG_DEST_SYSLOG
])
523 syslog_sigsafe(PRI
| zlog_default
->facility
, msgstart
,
532 /* Log a backtrace using only async-signal-safe functions.
533 Needs to be enhanced to support syslog logging. */
534 void zlog_backtrace_sigsafe(int priority
, void *program_counter
)
536 #ifdef HAVE_STACK_TRACE
537 static const char pclabel
[] = "Program counter: ";
541 char *s
, **bt
= NULL
;
542 #define LOC s,buf+sizeof(buf)-s
544 #ifdef HAVE_GLIBC_BACKTRACE
545 size
= backtrace(array
, array_size(array
));
546 if (size
<= 0 || (size_t)size
> array_size(array
))
551 if (program_counter) { \
552 write_wrapper(FD, pclabel, sizeof(pclabel) - 1); \
553 backtrace_symbols_fd(&program_counter, 1, FD); \
555 write_wrapper(FD, buf, s - buf); \
556 backtrace_symbols_fd(array, size, FD); \
558 #elif defined(HAVE_PRINTSTACK)
561 if (program_counter) \
562 write_wrapper((FD), pclabel, sizeof(pclabel) - 1); \
563 write_wrapper((FD), buf, s - buf); \
566 #endif /* HAVE_GLIBC_BACKTRACE, HAVE_PRINTSTACK */
569 s
= str_append(LOC
, "Backtrace for ");
570 s
= num_append(LOC
, size
);
571 s
= str_append(LOC
, " stack frames:\n");
573 if ((logfile_fd
>= 0) || ((logfile_fd
= open_crashlog()) >= 0))
578 if (priority
<= zlog_default
->maxlvl
[ZLOG_DEST_STDOUT
])
580 /* Remove trailing '\n' for monitor and syslog */
582 if (priority
<= zlog_default
->maxlvl
[ZLOG_DEST_MONITOR
])
583 vty_log_fixed(buf
, s
- buf
);
584 if (priority
<= zlog_default
->maxlvl
[ZLOG_DEST_SYSLOG
])
585 syslog_sigsafe(priority
| zlog_default
->facility
, buf
,
589 #ifdef HAVE_GLIBC_BACKTRACE
590 bt
= backtrace_symbols(array
, size
);
592 /* Just print the function addresses. */
593 for (i
= 0; i
< size
; i
++) {
596 s
= str_append(LOC
, bt
[i
]);
598 s
= str_append(LOC
, "[bt ");
599 s
= num_append(LOC
, i
);
600 s
= str_append(LOC
, "] 0x");
602 LOC
, (unsigned long)(array
[i
]));
606 <= zlog_default
->maxlvl
[ZLOG_DEST_MONITOR
])
607 vty_log_fixed(buf
, s
- buf
);
609 <= zlog_default
->maxlvl
[ZLOG_DEST_SYSLOG
])
622 #endif /* HAVE_STRACK_TRACE */
625 void zlog_backtrace(int priority
)
627 #ifndef HAVE_GLIBC_BACKTRACE
628 zlog(priority
, "No backtrace available on this platform.");
634 size
= backtrace(array
, array_size(array
));
635 if (size
<= 0 || (size_t)size
> array_size(array
)) {
638 "Cannot get backtrace, returned invalid # of frames %d "
639 "(valid range is between 1 and %lu)",
640 size
, (unsigned long)(array_size(array
)));
643 zlog(priority
, "Backtrace for %d stack frames:", size
);
644 if (!(strings
= backtrace_symbols(array
, size
))) {
645 flog_err_sys(LIB_ERR_SYSTEM_CALL
,
646 "Cannot get backtrace symbols (out of memory?)");
647 for (i
= 0; i
< size
; i
++)
648 zlog(priority
, "[bt %d] %p", i
, array
[i
]);
650 for (i
= 0; i
< size
; i
++)
651 zlog(priority
, "[bt %d] %s", i
, strings
[i
]);
654 #endif /* HAVE_GLIBC_BACKTRACE */
657 void zlog(int priority
, const char *format
, ...)
661 va_start(args
, format
);
662 vzlog(priority
, format
, args
);
666 #define ZLOG_FUNC(FUNCNAME, PRIORITY) \
667 void FUNCNAME(const char *format, ...) \
670 va_start(args, format); \
671 vzlog(PRIORITY, format, args); \
675 ZLOG_FUNC(zlog_err
, LOG_ERR
)
677 ZLOG_FUNC(zlog_warn
, LOG_WARNING
)
679 ZLOG_FUNC(zlog_info
, LOG_INFO
)
681 ZLOG_FUNC(zlog_notice
, LOG_NOTICE
)
683 ZLOG_FUNC(zlog_debug
, LOG_DEBUG
)
687 void zlog_thread_info(int log_level
)
690 tc
= pthread_getspecific(thread_current
);
694 "Current thread function %s, scheduled from "
696 tc
->funcname
, tc
->schedfrom
, tc
->schedfrom_line
);
698 zlog(log_level
, "Current thread not known/applicable");
701 void _zlog_assert_failed(const char *assertion
, const char *file
,
702 unsigned int line
, const char *function
)
704 /* Force fallback file logging? */
705 if (zlog_default
&& !zlog_default
->fp
706 && ((logfile_fd
= open_crashlog()) >= 0)
707 && ((zlog_default
->fp
= fdopen(logfile_fd
, "w")) != NULL
))
708 zlog_default
->maxlvl
[ZLOG_DEST_FILE
] = LOG_ERR
;
709 zlog(LOG_CRIT
, "Assertion `%s' failed in file %s, line %u, function %s",
710 assertion
, file
, line
, (function
? function
: "?"));
711 zlog_backtrace(LOG_CRIT
);
712 zlog_thread_info(LOG_CRIT
);
713 log_memstats(stderr
, "log");
717 void memory_oom(size_t size
, const char *name
)
719 flog_err_sys(LIB_ERR_SYSTEM_CALL
,
720 "out of memory: failed to allocate %zu bytes for %s"
723 zlog_backtrace(LOG_ERR
);
727 /* Open log stream */
728 void openzlog(const char *progname
, const char *protoname
,
729 unsigned short instance
, int syslog_flags
, int syslog_facility
)
734 zl
= XCALLOC(MTYPE_ZLOG
, sizeof(struct zlog
));
736 zl
->ident
= progname
;
737 zl
->protoname
= protoname
;
738 zl
->instance
= instance
;
739 zl
->facility
= syslog_facility
;
740 zl
->syslog_options
= syslog_flags
;
742 /* Set default logging levels. */
743 for (i
= 0; i
< array_size(zl
->maxlvl
); i
++)
744 zl
->maxlvl
[i
] = ZLOG_DISABLED
;
745 zl
->maxlvl
[ZLOG_DEST_MONITOR
] = LOG_DEBUG
;
746 zl
->default_lvl
= LOG_DEBUG
;
748 openlog(progname
, syslog_flags
, zl
->facility
);
750 pthread_mutex_lock(&loglock
);
752 pthread_mutex_unlock(&loglock
);
754 #ifdef HAVE_GLIBC_BACKTRACE
755 /* work around backtrace() using lazily resolved dynamically linked
756 * symbols, which will otherwise cause funny breakage in the SEGV
758 * (particularly, the dynamic linker can call malloc(), which uses locks
759 * in programs linked with -pthread, thus can deadlock.) */
761 backtrace(bt
, array_size(bt
));
762 free(backtrace_symbols(bt
, 0));
763 backtrace_symbols_fd(bt
, 0, 0);
769 pthread_mutex_lock(&loglock
);
770 struct zlog
*zl
= zlog_default
;
777 if (zl
->filename
!= NULL
)
778 XFREE(MTYPE_ZLOG
, zl
->filename
);
780 XFREE(MTYPE_ZLOG
, zl
);
782 pthread_mutex_unlock(&loglock
);
785 /* Called from command.c. */
786 void zlog_set_level(zlog_dest_t dest
, int log_level
)
788 pthread_mutex_lock(&loglock
);
789 zlog_default
->maxlvl
[dest
] = log_level
;
790 pthread_mutex_unlock(&loglock
);
793 int zlog_set_file(const char *filename
, int log_level
)
800 /* There is opend file. */
804 oldumask
= umask(0777 & ~LOGFILE_MASK
);
805 fp
= fopen(filename
, "a");
810 pthread_mutex_lock(&loglock
);
814 zl
->filename
= XSTRDUP(MTYPE_ZLOG
, filename
);
815 zl
->maxlvl
[ZLOG_DEST_FILE
] = log_level
;
817 logfile_fd
= fileno(fp
);
818 pthread_mutex_unlock(&loglock
);
824 /* Reset opend file. */
825 int zlog_reset_file(void)
827 pthread_mutex_lock(&loglock
);
829 struct zlog
*zl
= zlog_default
;
835 zl
->maxlvl
[ZLOG_DEST_FILE
] = ZLOG_DISABLED
;
838 XFREE(MTYPE_ZLOG
, zl
->filename
);
841 pthread_mutex_unlock(&loglock
);
846 /* Reopen log file. */
847 int zlog_rotate(void)
849 pthread_mutex_lock(&loglock
);
851 struct zlog
*zl
= zlog_default
;
859 level
= zl
->maxlvl
[ZLOG_DEST_FILE
];
860 zl
->maxlvl
[ZLOG_DEST_FILE
] = ZLOG_DISABLED
;
866 oldumask
= umask(0777 & ~LOGFILE_MASK
);
867 zl
->fp
= fopen(zl
->filename
, "a");
870 if (zl
->fp
== NULL
) {
872 pthread_mutex_unlock(&loglock
);
876 "Log rotate failed: cannot open file %s for append: %s",
877 zl
->filename
, safe_strerror(save_errno
));
880 pthread_mutex_lock(&loglock
);
882 logfile_fd
= fileno(zl
->fp
);
883 zl
->maxlvl
[ZLOG_DEST_FILE
] = level
;
887 pthread_mutex_unlock(&loglock
);
892 /* Wrapper around strerror to handle case where it returns NULL. */
893 const char *safe_strerror(int errnum
)
895 const char *s
= strerror(errnum
);
896 return (s
!= NULL
) ? s
: "Unknown error";
899 #define DESC_ENTRY(T) [(T)] = { (T), (#T), '\0' }
900 static const struct zebra_desc_table command_types
[] = {
901 DESC_ENTRY(ZEBRA_INTERFACE_ADD
),
902 DESC_ENTRY(ZEBRA_INTERFACE_DELETE
),
903 DESC_ENTRY(ZEBRA_INTERFACE_ADDRESS_ADD
),
904 DESC_ENTRY(ZEBRA_INTERFACE_ADDRESS_DELETE
),
905 DESC_ENTRY(ZEBRA_INTERFACE_UP
),
906 DESC_ENTRY(ZEBRA_INTERFACE_DOWN
),
907 DESC_ENTRY(ZEBRA_INTERFACE_SET_MASTER
),
908 DESC_ENTRY(ZEBRA_ROUTE_ADD
),
909 DESC_ENTRY(ZEBRA_ROUTE_DELETE
),
910 DESC_ENTRY(ZEBRA_ROUTE_NOTIFY_OWNER
),
911 DESC_ENTRY(ZEBRA_REDISTRIBUTE_ADD
),
912 DESC_ENTRY(ZEBRA_REDISTRIBUTE_DELETE
),
913 DESC_ENTRY(ZEBRA_REDISTRIBUTE_DEFAULT_ADD
),
914 DESC_ENTRY(ZEBRA_REDISTRIBUTE_DEFAULT_DELETE
),
915 DESC_ENTRY(ZEBRA_ROUTER_ID_ADD
),
916 DESC_ENTRY(ZEBRA_ROUTER_ID_DELETE
),
917 DESC_ENTRY(ZEBRA_ROUTER_ID_UPDATE
),
918 DESC_ENTRY(ZEBRA_HELLO
),
919 DESC_ENTRY(ZEBRA_NEXTHOP_REGISTER
),
920 DESC_ENTRY(ZEBRA_NEXTHOP_UNREGISTER
),
921 DESC_ENTRY(ZEBRA_NEXTHOP_UPDATE
),
922 DESC_ENTRY(ZEBRA_INTERFACE_NBR_ADDRESS_ADD
),
923 DESC_ENTRY(ZEBRA_INTERFACE_NBR_ADDRESS_DELETE
),
924 DESC_ENTRY(ZEBRA_INTERFACE_BFD_DEST_UPDATE
),
925 DESC_ENTRY(ZEBRA_IMPORT_ROUTE_REGISTER
),
926 DESC_ENTRY(ZEBRA_IMPORT_ROUTE_UNREGISTER
),
927 DESC_ENTRY(ZEBRA_IMPORT_CHECK_UPDATE
),
928 DESC_ENTRY(ZEBRA_IPV4_ROUTE_IPV6_NEXTHOP_ADD
),
929 DESC_ENTRY(ZEBRA_BFD_DEST_REGISTER
),
930 DESC_ENTRY(ZEBRA_BFD_DEST_DEREGISTER
),
931 DESC_ENTRY(ZEBRA_BFD_DEST_UPDATE
),
932 DESC_ENTRY(ZEBRA_BFD_DEST_REPLAY
),
933 DESC_ENTRY(ZEBRA_REDISTRIBUTE_ROUTE_ADD
),
934 DESC_ENTRY(ZEBRA_REDISTRIBUTE_ROUTE_DEL
),
935 DESC_ENTRY(ZEBRA_VRF_UNREGISTER
),
936 DESC_ENTRY(ZEBRA_VRF_ADD
),
937 DESC_ENTRY(ZEBRA_VRF_DELETE
),
938 DESC_ENTRY(ZEBRA_VRF_LABEL
),
939 DESC_ENTRY(ZEBRA_INTERFACE_VRF_UPDATE
),
940 DESC_ENTRY(ZEBRA_BFD_CLIENT_REGISTER
),
941 DESC_ENTRY(ZEBRA_INTERFACE_ENABLE_RADV
),
942 DESC_ENTRY(ZEBRA_INTERFACE_DISABLE_RADV
),
943 DESC_ENTRY(ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB
),
944 DESC_ENTRY(ZEBRA_INTERFACE_LINK_PARAMS
),
945 DESC_ENTRY(ZEBRA_MPLS_LABELS_ADD
),
946 DESC_ENTRY(ZEBRA_MPLS_LABELS_DELETE
),
947 DESC_ENTRY(ZEBRA_IPMR_ROUTE_STATS
),
948 DESC_ENTRY(ZEBRA_LABEL_MANAGER_CONNECT
),
949 DESC_ENTRY(ZEBRA_GET_LABEL_CHUNK
),
950 DESC_ENTRY(ZEBRA_RELEASE_LABEL_CHUNK
),
951 DESC_ENTRY(ZEBRA_ADVERTISE_ALL_VNI
),
952 DESC_ENTRY(ZEBRA_ADVERTISE_DEFAULT_GW
),
953 DESC_ENTRY(ZEBRA_ADVERTISE_SUBNET
),
954 DESC_ENTRY(ZEBRA_LOCAL_ES_ADD
),
955 DESC_ENTRY(ZEBRA_LOCAL_ES_DEL
),
956 DESC_ENTRY(ZEBRA_VNI_ADD
),
957 DESC_ENTRY(ZEBRA_VNI_DEL
),
958 DESC_ENTRY(ZEBRA_L3VNI_ADD
),
959 DESC_ENTRY(ZEBRA_L3VNI_DEL
),
960 DESC_ENTRY(ZEBRA_REMOTE_VTEP_ADD
),
961 DESC_ENTRY(ZEBRA_REMOTE_VTEP_DEL
),
962 DESC_ENTRY(ZEBRA_MACIP_ADD
),
963 DESC_ENTRY(ZEBRA_MACIP_DEL
),
964 DESC_ENTRY(ZEBRA_IP_PREFIX_ROUTE_ADD
),
965 DESC_ENTRY(ZEBRA_IP_PREFIX_ROUTE_DEL
),
966 DESC_ENTRY(ZEBRA_REMOTE_MACIP_ADD
),
967 DESC_ENTRY(ZEBRA_REMOTE_MACIP_DEL
),
968 DESC_ENTRY(ZEBRA_PW_ADD
),
969 DESC_ENTRY(ZEBRA_PW_DELETE
),
970 DESC_ENTRY(ZEBRA_PW_SET
),
971 DESC_ENTRY(ZEBRA_PW_UNSET
),
972 DESC_ENTRY(ZEBRA_PW_STATUS_UPDATE
),
973 DESC_ENTRY(ZEBRA_RULE_ADD
),
974 DESC_ENTRY(ZEBRA_RULE_DELETE
),
975 DESC_ENTRY(ZEBRA_RULE_NOTIFY_OWNER
),
976 DESC_ENTRY(ZEBRA_TABLE_MANAGER_CONNECT
),
977 DESC_ENTRY(ZEBRA_GET_TABLE_CHUNK
),
978 DESC_ENTRY(ZEBRA_RELEASE_TABLE_CHUNK
),
979 DESC_ENTRY(ZEBRA_IPSET_CREATE
),
980 DESC_ENTRY(ZEBRA_IPSET_DESTROY
),
981 DESC_ENTRY(ZEBRA_IPSET_ENTRY_ADD
),
982 DESC_ENTRY(ZEBRA_IPSET_ENTRY_DELETE
),
986 static const struct zebra_desc_table unknown
= {0, "unknown", '?'};
988 static const struct zebra_desc_table
*zroute_lookup(unsigned int zroute
)
992 if (zroute
>= array_size(route_types
)) {
993 flog_err(LIB_ERR_DEVELOPMENT
, "unknown zebra route type: %u",
997 if (zroute
== route_types
[zroute
].type
)
998 return &route_types
[zroute
];
999 for (i
= 0; i
< array_size(route_types
); i
++) {
1000 if (zroute
== route_types
[i
].type
) {
1002 "internal error: route type table out of order "
1003 "while searching for %u, please notify developers",
1005 return &route_types
[i
];
1008 flog_err(LIB_ERR_DEVELOPMENT
,
1009 "internal error: cannot find route type %u in table!",
1014 const char *zebra_route_string(unsigned int zroute
)
1016 return zroute_lookup(zroute
)->string
;
1019 char zebra_route_char(unsigned int zroute
)
1021 return zroute_lookup(zroute
)->chr
;
1024 const char *zserv_command_string(unsigned int command
)
1026 if (command
>= array_size(command_types
)) {
1027 flog_err(LIB_ERR_DEVELOPMENT
, "unknown zserv command type: %u",
1029 return unknown
.string
;
1031 return command_types
[command
].string
;
1034 int proto_name2num(const char *s
)
1038 for (i
= 0; i
< array_size(route_types
); ++i
)
1039 if (strcasecmp(s
, route_types
[i
].string
) == 0)
1040 return route_types
[i
].type
;
1044 int proto_redistnum(int afi
, const char *s
)
1049 if (afi
== AFI_IP
) {
1050 if (strmatch(s
, "kernel"))
1051 return ZEBRA_ROUTE_KERNEL
;
1052 else if (strmatch(s
, "connected"))
1053 return ZEBRA_ROUTE_CONNECT
;
1054 else if (strmatch(s
, "static"))
1055 return ZEBRA_ROUTE_STATIC
;
1056 else if (strmatch(s
, "rip"))
1057 return ZEBRA_ROUTE_RIP
;
1058 else if (strmatch(s
, "eigrp"))
1059 return ZEBRA_ROUTE_EIGRP
;
1060 else if (strmatch(s
, "ospf"))
1061 return ZEBRA_ROUTE_OSPF
;
1062 else if (strmatch(s
, "isis"))
1063 return ZEBRA_ROUTE_ISIS
;
1064 else if (strmatch(s
, "bgp"))
1065 return ZEBRA_ROUTE_BGP
;
1066 else if (strmatch(s
, "table"))
1067 return ZEBRA_ROUTE_TABLE
;
1068 else if (strmatch(s
, "vnc"))
1069 return ZEBRA_ROUTE_VNC
;
1070 else if (strmatch(s
, "vnc-direct"))
1071 return ZEBRA_ROUTE_VNC_DIRECT
;
1072 else if (strmatch(s
, "nhrp"))
1073 return ZEBRA_ROUTE_NHRP
;
1074 else if (strmatch(s
, "babel"))
1075 return ZEBRA_ROUTE_BABEL
;
1076 else if (strmatch(s
, "sharp"))
1077 return ZEBRA_ROUTE_SHARP
;
1079 if (afi
== AFI_IP6
) {
1080 if (strmatch(s
, "kernel"))
1081 return ZEBRA_ROUTE_KERNEL
;
1082 else if (strmatch(s
, "connected"))
1083 return ZEBRA_ROUTE_CONNECT
;
1084 else if (strmatch(s
, "static"))
1085 return ZEBRA_ROUTE_STATIC
;
1086 else if (strmatch(s
, "ripng"))
1087 return ZEBRA_ROUTE_RIPNG
;
1088 else if (strmatch(s
, "ospf6"))
1089 return ZEBRA_ROUTE_OSPF6
;
1090 else if (strmatch(s
, "isis"))
1091 return ZEBRA_ROUTE_ISIS
;
1092 else if (strmatch(s
, "bgp"))
1093 return ZEBRA_ROUTE_BGP
;
1094 else if (strmatch(s
, "table"))
1095 return ZEBRA_ROUTE_TABLE
;
1096 else if (strmatch(s
, "vnc"))
1097 return ZEBRA_ROUTE_VNC
;
1098 else if (strmatch(s
, "vnc-direct"))
1099 return ZEBRA_ROUTE_VNC_DIRECT
;
1100 else if (strmatch(s
, "nhrp"))
1101 return ZEBRA_ROUTE_NHRP
;
1102 else if (strmatch(s
, "babel"))
1103 return ZEBRA_ROUTE_BABEL
;
1104 else if (strmatch(s
, "sharp"))
1105 return ZEBRA_ROUTE_SHARP
;
1110 void zlog_hexdump(const void *mem
, unsigned int len
)
1112 unsigned long i
= 0;
1114 unsigned int columns
= 8;
1116 * 19 bytes for 0xADDRESS:
1117 * 24 bytes for data; 2 chars plus a space per data byte
1119 * 8 bytes for ASCII representation
1120 * 1 byte for a newline
1121 * =====================
1122 * 53 bytes per 8 bytes of data
1123 * 1 byte for null term
1125 size_t bs
= ((len
/ 8) + 1) * 53 + 1;
1129 memset(buf
, 0, sizeof(buf
));
1131 for (i
= 0; i
< len
+ ((len
% columns
) ? (columns
- len
% columns
) : 0);
1134 if (i
% columns
== 0)
1135 s
+= snprintf(s
, bs
- (s
- buf
),
1136 "0x%016lx: ", (unsigned long)mem
+ i
);
1138 /* print hex data */
1140 s
+= snprintf(s
, bs
- (s
- buf
), "%02x ",
1141 0xFF & ((const char *)mem
)[i
]);
1143 /* end of block, just aligning for ASCII dump */
1145 s
+= snprintf(s
, bs
- (s
- buf
), " ");
1147 /* print ASCII dump */
1148 if (i
% columns
== (columns
- 1)) {
1149 for (j
= i
- (columns
- 1); j
<= i
; j
++) {
1150 /* end of block not really printing */
1152 s
+= snprintf(s
, bs
- (s
- buf
), " ");
1153 else if (isprint((int)((const char *)mem
)[j
]))
1155 s
, bs
- (s
- buf
), "%c",
1156 0xFF & ((const char *)mem
)[j
]);
1157 else /* other char */
1158 s
+= snprintf(s
, bs
- (s
- buf
), ".");
1160 s
+= snprintf(s
, bs
- (s
- buf
), "\n");
1163 zlog_debug("\n%s", buf
);
1166 const char *zlog_sanitize(char *buf
, size_t bufsz
, const void *in
, size_t inlen
)
1168 const char *inbuf
= in
;
1169 char *pos
= buf
, *end
= buf
+ bufsz
;
1170 const char *iend
= inbuf
+ inlen
;
1172 memset(buf
, 0, bufsz
);
1173 for (; inbuf
< iend
; inbuf
++) {
1174 /* don't write partial escape sequence */
1179 snprintf(pos
, end
- pos
, "\\n");
1180 else if (*inbuf
== '\r')
1181 snprintf(pos
, end
- pos
, "\\r");
1182 else if (*inbuf
== '\t')
1183 snprintf(pos
, end
- pos
, "\\t");
1184 else if (*inbuf
< ' ' || *inbuf
== '"' || *inbuf
>= 127)
1185 snprintf(pos
, end
- pos
, "\\x%02hhx", *inbuf
);