lib/log.c

   1 /*
   2  * Logging of zebra
   3  * Copyright (C) 1997, 1998, 1999 Kunihiro Ishiguro
   4  *
   5  * This file is part of GNU Zebra.
   6  *
   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
  10  * later version.
  11  *
  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.
  16  *
  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
  20  */
  21
  22 #define FRR_DEFINE_DESC_TABLE
  23
  24 #include <zebra.h>
  25
  26 #include "zclient.h"
  27 #include "log.h"
  28 #include "memory.h"
  29 #include "command.h"
  30 #include "lib_errors.h"
  31 #include "lib/hook.h"
  32 #include "printfrr.h"
  33 #include "frr_pthread.h"
  34
  35 #ifdef HAVE_LIBUNWIND
  36 #define UNW_LOCAL_ONLY
  37 #include <libunwind.h>
  38 #include <dlfcn.h>
  39 #endif
  40
  41 /**
  42  * Looks up a message in a message list by key.
  43  *
  44  * If the message is not found, returns the provided error message.
  45  *
  46  * Terminates when it hits a struct message that's all zeros.
  47  *
  48  * @param mz the message list
  49  * @param kz the message key
  50  * @param nf the message to return if not found
  51  * @return the message
  52  */
  53 const char *lookup_msg(const struct message *mz, int kz, const char *nf)
  54 {
  55         static struct message nt = {0};
  56         const char *rz = nf ? nf : "(no message found)";
  57         const struct message *pnt;
  58         for (pnt = mz; memcmp(pnt, &nt, sizeof(struct message)); pnt++)
  59                 if (pnt->key == kz) {
  60                         rz = pnt->str ? pnt->str : rz;
  61                         break;
  62                 }
  63         return rz;
  64 }
  65
  66 /* For time string format. */
  67 size_t quagga_timestamp(int timestamp_precision, char *buf, size_t buflen)
  68 {
  69         static struct {
  70                 time_t last;
  71                 size_t len;
  72                 char buf[28];
  73         } cache;
  74         struct timeval clock;
  75
  76         gettimeofday(&clock, NULL);
  77
  78         /* first, we update the cache if the time has changed */
  79         if (cache.last != clock.tv_sec) {
  80                 struct tm tm;
  81                 cache.last = clock.tv_sec;
  82                 localtime_r(&cache.last, &tm);
  83                 cache.len = strftime(cache.buf, sizeof(cache.buf),
  84                                      "%Y/%m/%d %H:%M:%S", &tm);
  85         }
  86         /* note: it's not worth caching the subsecond part, because
  87            chances are that back-to-back calls are not sufficiently close
  88            together
  89            for the clock not to have ticked forward */
  90
  91         if (buflen > cache.len) {
  92                 memcpy(buf, cache.buf, cache.len);
  93                 if ((timestamp_precision > 0)
  94                     && (buflen > cache.len + 1 + timestamp_precision)) {
  95                         /* should we worry about locale issues? */
  96                         static const int divisor[] = {0,   100000, 10000, 1000,
  97                                                       100, 10,     1};
  98                         int prec;
  99                         char *p = buf + cache.len + 1
 100                                   + (prec = timestamp_precision);
 101                         *p-- = '\0';
 102                         while (prec > 6)
 103                         /* this is unlikely to happen, but protect anyway */
 104                         {
 105                                 *p-- = '0';
 106                                 prec--;
 107                         }
 108                         clock.tv_usec /= divisor[prec];
 109                         do {
 110                                 *p-- = '0' + (clock.tv_usec % 10);
 111                                 clock.tv_usec /= 10;
 112                         } while (--prec > 0);
 113                         *p = '.';
 114                         return cache.len + 1 + timestamp_precision;
 115                 }
 116                 buf[cache.len] = '\0';
 117                 return cache.len;
 118         }
 119         if (buflen > 0)
 120                 buf[0] = '\0';
 121         return 0;
 122 }
 123
 124 /*
 125  * crash handling
 126  *
 127  * NB: only AS-Safe (async-signal) functions can be used here!
 128  */
 129
 130 /* Note: the goal here is to use only async-signal-safe functions. */
 131 void zlog_signal(int signo, const char *action, void *siginfo_v,
 132                  void *program_counter)
 133 {
 134         siginfo_t *siginfo = siginfo_v;
 135         time_t now;
 136         char buf[sizeof("DEFAULT: Received signal S at T (si_addr 0xP, PC 0xP); aborting...")
 137                  + 100];
 138         struct fbuf fb = { .buf = buf, .pos = buf, .len = sizeof(buf) };
 139
 140         time(&now);
 141
 142         bprintfrr(&fb, "Received signal %d at %lld", signo, (long long)now);
 143         if (program_counter)
 144                 bprintfrr(&fb, " (si_addr 0x%tx, PC 0x%tx)",
 145                           (ptrdiff_t)siginfo->si_addr,
 146                           (ptrdiff_t)program_counter);
 147         else
 148                 bprintfrr(&fb, " (si_addr 0x%tx)",
 149                           (ptrdiff_t)siginfo->si_addr);
 150         bprintfrr(&fb, "; %s\n", action);
 151
 152         zlog_sigsafe(fb.buf, fb.pos - fb.buf);
 153
 154         zlog_backtrace_sigsafe(LOG_CRIT, program_counter);
 155
 156         fb.pos = buf;
 157
 158         struct thread *tc;
 159         tc = pthread_getspecific(thread_current);
 160
 161         if (!tc)
 162                 bprintfrr(&fb, "no thread information available\n");
 163         else
 164                 bprintfrr(&fb, "in thread %s scheduled from %s:%d %s()\n",
 165                           tc->xref->funcname, tc->xref->xref.file,
 166                           tc->xref->xref.line, tc->xref->xref.func);
 167
 168         zlog_sigsafe(fb.buf, fb.pos - fb.buf);
 169 }
 170
 171 /* Log a backtrace using only async-signal-safe functions.
 172    Needs to be enhanced to support syslog logging. */
 173 void zlog_backtrace_sigsafe(int priority, void *program_counter)
 174 {
 175 #ifdef HAVE_LIBUNWIND
 176         char buf[256];
 177         struct fbuf fb = { .buf = buf, .len = sizeof(buf) };
 178         unw_cursor_t cursor;
 179         unw_context_t uc;
 180         unw_word_t ip, off, sp;
 181         Dl_info dlinfo;
 182
 183         memset(&uc, 0, sizeof(uc));
 184         memset(&cursor, 0, sizeof(cursor));
 185
 186         unw_getcontext(&uc);
 187         unw_init_local(&cursor, &uc);
 188         while (unw_step(&cursor) > 0) {
 189                 char name[128] = "?";
 190
 191                 unw_get_reg(&cursor, UNW_REG_IP, &ip);
 192                 unw_get_reg(&cursor, UNW_REG_SP, &sp);
 193
 194                 if (!unw_get_proc_name(&cursor, buf, sizeof(buf), &off))
 195                         snprintfrr(name, sizeof(name), "%s+%#lx",
 196                                    buf, (long)off);
 197
 198                 fb.pos = buf;
 199                 if (unw_is_signal_frame(&cursor))
 200                         bprintfrr(&fb, "    ---- signal ----\n");
 201                 bprintfrr(&fb, "%-30s %16lx %16lx", name, (long)ip, (long)sp);
 202                 if (dladdr((void *)ip, &dlinfo))
 203                         bprintfrr(&fb, " %s (mapped at %p)",
 204                                   dlinfo.dli_fname, dlinfo.dli_fbase);
 205                 bprintfrr(&fb, "\n");
 206                 zlog_sigsafe(fb.buf, fb.pos - fb.buf);
 207         }
 208 #elif defined(HAVE_GLIBC_BACKTRACE)
 209         void *array[64];
 210         int size, i;
 211         char buf[128];
 212         struct fbuf fb = { .buf = buf, .pos = buf, .len = sizeof(buf) };
 213         char **bt = NULL;
 214
 215         size = backtrace(array, array_size(array));
 216         if (size <= 0 || (size_t)size > array_size(array))
 217                 return;
 218
 219         bprintfrr(&fb, "Backtrace for %d stack frames:", size);
 220         zlog_sigsafe(fb.pos, fb.buf - fb.pos);
 221
 222         bt = backtrace_symbols(array, size);
 223
 224         for (i = 0; i < size; i++) {
 225                 fb.pos = buf;
 226                 if (bt)
 227                         bprintfrr(&fb, "%s", bt[i]);
 228                 else
 229                         bprintfrr(&fb, "[bt %d] 0x%tx", i,
 230                                   (ptrdiff_t)(array[i]));
 231                 zlog_sigsafe(fb.buf, fb.pos - fb.buf);
 232         }
 233         if (bt)
 234                 free(bt);
 235 #endif /* HAVE_STRACK_TRACE */
 236 }
 237
 238 void zlog_backtrace(int priority)
 239 {
 240 #ifdef HAVE_LIBUNWIND
 241         char buf[100];
 242         unw_cursor_t cursor;
 243         unw_context_t uc;
 244         unw_word_t ip, off, sp;
 245         Dl_info dlinfo;
 246
 247         unw_getcontext(&uc);
 248         unw_init_local(&cursor, &uc);
 249         zlog(priority, "Backtrace:");
 250         while (unw_step(&cursor) > 0) {
 251                 char name[128] = "?";
 252
 253                 unw_get_reg(&cursor, UNW_REG_IP, &ip);
 254                 unw_get_reg(&cursor, UNW_REG_SP, &sp);
 255
 256                 if (unw_is_signal_frame(&cursor))
 257                         zlog(priority, "    ---- signal ----");
 258
 259                 if (!unw_get_proc_name(&cursor, buf, sizeof(buf), &off))
 260                         snprintf(name, sizeof(name), "%s+%#lx",
 261                                 buf, (long)off);
 262
 263                 if (dladdr((void *)ip, &dlinfo))
 264                         zlog(priority, "%-30s %16lx %16lx %s (mapped at %p)",
 265                                 name, (long)ip, (long)sp,
 266                                 dlinfo.dli_fname, dlinfo.dli_fbase);
 267                 else
 268                         zlog(priority, "%-30s %16lx %16lx",
 269                                 name, (long)ip, (long)sp);
 270         }
 271 #elif defined(HAVE_GLIBC_BACKTRACE)
 272         void *array[20];
 273         int size, i;
 274         char **strings;
 275
 276         size = backtrace(array, array_size(array));
 277         if (size <= 0 || (size_t)size > array_size(array)) {
 278                 flog_err_sys(
 279                         EC_LIB_SYSTEM_CALL,
 280                         "Cannot get backtrace, returned invalid # of frames %d (valid range is between 1 and %lu)",
 281                         size, (unsigned long)(array_size(array)));
 282                 return;
 283         }
 284         zlog(priority, "Backtrace for %d stack frames:", size);
 285         if (!(strings = backtrace_symbols(array, size))) {
 286                 flog_err_sys(EC_LIB_SYSTEM_CALL,
 287                              "Cannot get backtrace symbols (out of memory?)");
 288                 for (i = 0; i < size; i++)
 289                         zlog(priority, "[bt %d] %p", i, array[i]);
 290         } else {
 291                 for (i = 0; i < size; i++)
 292                         zlog(priority, "[bt %d] %s", i, strings[i]);
 293                 free(strings);
 294         }
 295 #else /* !HAVE_GLIBC_BACKTRACE && !HAVE_LIBUNWIND */
 296         zlog(priority, "No backtrace available on this platform.");
 297 #endif
 298 }
 299
 300 void zlog_thread_info(int log_level)
 301 {
 302         struct thread *tc;
 303         tc = pthread_getspecific(thread_current);
 304
 305         if (tc)
 306                 zlog(log_level,
 307                      "Current thread function %s, scheduled from file %s, line %u in %s()",
 308                      tc->xref->funcname, tc->xref->xref.file,
 309                      tc->xref->xref.line, tc->xref->xref.func);
 310         else
 311                 zlog(log_level, "Current thread not known/applicable");
 312 }
 313
 314 void memory_oom(size_t size, const char *name)
 315 {
 316         zlog(LOG_CRIT,
 317              "out of memory: failed to allocate %zu bytes for %s object",
 318              size, name);
 319         zlog_backtrace(LOG_CRIT);
 320         log_memstats(stderr, "log");
 321         abort();
 322 }
 323
 324 /* Wrapper around strerror to handle case where it returns NULL. */
 325 const char *safe_strerror(int errnum)
 326 {
 327         const char *s = strerror(errnum);
 328         return (s != NULL) ? s : "Unknown error";
 329 }
 330
 331 #define DESC_ENTRY(T) [(T)] = { (T), (#T), '\0' }
 332 static const struct zebra_desc_table command_types[] = {
 333         DESC_ENTRY(ZEBRA_INTERFACE_ADD),
 334         DESC_ENTRY(ZEBRA_INTERFACE_DELETE),
 335         DESC_ENTRY(ZEBRA_INTERFACE_ADDRESS_ADD),
 336         DESC_ENTRY(ZEBRA_INTERFACE_ADDRESS_DELETE),
 337         DESC_ENTRY(ZEBRA_INTERFACE_UP),
 338         DESC_ENTRY(ZEBRA_INTERFACE_DOWN),
 339         DESC_ENTRY(ZEBRA_INTERFACE_SET_MASTER),
 340         DESC_ENTRY(ZEBRA_ROUTE_ADD),
 341         DESC_ENTRY(ZEBRA_ROUTE_DELETE),
 342         DESC_ENTRY(ZEBRA_ROUTE_NOTIFY_OWNER),
 343         DESC_ENTRY(ZEBRA_REDISTRIBUTE_ADD),
 344         DESC_ENTRY(ZEBRA_REDISTRIBUTE_DELETE),
 345         DESC_ENTRY(ZEBRA_REDISTRIBUTE_DEFAULT_ADD),
 346         DESC_ENTRY(ZEBRA_REDISTRIBUTE_DEFAULT_DELETE),
 347         DESC_ENTRY(ZEBRA_ROUTER_ID_ADD),
 348         DESC_ENTRY(ZEBRA_ROUTER_ID_DELETE),
 349         DESC_ENTRY(ZEBRA_ROUTER_ID_UPDATE),
 350         DESC_ENTRY(ZEBRA_HELLO),
 351         DESC_ENTRY(ZEBRA_CAPABILITIES),
 352         DESC_ENTRY(ZEBRA_NEXTHOP_REGISTER),
 353         DESC_ENTRY(ZEBRA_NEXTHOP_UNREGISTER),
 354         DESC_ENTRY(ZEBRA_NEXTHOP_UPDATE),
 355         DESC_ENTRY(ZEBRA_INTERFACE_NBR_ADDRESS_ADD),
 356         DESC_ENTRY(ZEBRA_INTERFACE_NBR_ADDRESS_DELETE),
 357         DESC_ENTRY(ZEBRA_INTERFACE_BFD_DEST_UPDATE),
 358         DESC_ENTRY(ZEBRA_IMPORT_ROUTE_REGISTER),
 359         DESC_ENTRY(ZEBRA_IMPORT_ROUTE_UNREGISTER),
 360         DESC_ENTRY(ZEBRA_IMPORT_CHECK_UPDATE),
 361         DESC_ENTRY(ZEBRA_BFD_DEST_REGISTER),
 362         DESC_ENTRY(ZEBRA_BFD_DEST_DEREGISTER),
 363         DESC_ENTRY(ZEBRA_BFD_DEST_UPDATE),
 364         DESC_ENTRY(ZEBRA_BFD_DEST_REPLAY),
 365         DESC_ENTRY(ZEBRA_REDISTRIBUTE_ROUTE_ADD),
 366         DESC_ENTRY(ZEBRA_REDISTRIBUTE_ROUTE_DEL),
 367         DESC_ENTRY(ZEBRA_VRF_UNREGISTER),
 368         DESC_ENTRY(ZEBRA_VRF_ADD),
 369         DESC_ENTRY(ZEBRA_VRF_DELETE),
 370         DESC_ENTRY(ZEBRA_VRF_LABEL),
 371         DESC_ENTRY(ZEBRA_INTERFACE_VRF_UPDATE),
 372         DESC_ENTRY(ZEBRA_BFD_CLIENT_REGISTER),
 373         DESC_ENTRY(ZEBRA_BFD_CLIENT_DEREGISTER),
 374         DESC_ENTRY(ZEBRA_INTERFACE_ENABLE_RADV),
 375         DESC_ENTRY(ZEBRA_INTERFACE_DISABLE_RADV),
 376         DESC_ENTRY(ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB),
 377         DESC_ENTRY(ZEBRA_INTERFACE_LINK_PARAMS),
 378         DESC_ENTRY(ZEBRA_MPLS_LABELS_ADD),
 379         DESC_ENTRY(ZEBRA_MPLS_LABELS_DELETE),
 380         DESC_ENTRY(ZEBRA_MPLS_LABELS_REPLACE),
 381         DESC_ENTRY(ZEBRA_SR_POLICY_SET),
 382         DESC_ENTRY(ZEBRA_SR_POLICY_DELETE),
 383         DESC_ENTRY(ZEBRA_SR_POLICY_NOTIFY_STATUS),
 384         DESC_ENTRY(ZEBRA_IPMR_ROUTE_STATS),
 385         DESC_ENTRY(ZEBRA_LABEL_MANAGER_CONNECT),
 386         DESC_ENTRY(ZEBRA_LABEL_MANAGER_CONNECT_ASYNC),
 387         DESC_ENTRY(ZEBRA_GET_LABEL_CHUNK),
 388         DESC_ENTRY(ZEBRA_RELEASE_LABEL_CHUNK),
 389         DESC_ENTRY(ZEBRA_FEC_REGISTER),
 390         DESC_ENTRY(ZEBRA_FEC_UNREGISTER),
 391         DESC_ENTRY(ZEBRA_FEC_UPDATE),
 392         DESC_ENTRY(ZEBRA_ADVERTISE_ALL_VNI),
 393         DESC_ENTRY(ZEBRA_ADVERTISE_DEFAULT_GW),
 394         DESC_ENTRY(ZEBRA_ADVERTISE_SVI_MACIP),
 395         DESC_ENTRY(ZEBRA_ADVERTISE_SUBNET),
 396         DESC_ENTRY(ZEBRA_LOCAL_ES_ADD),
 397         DESC_ENTRY(ZEBRA_LOCAL_ES_DEL),
 398         DESC_ENTRY(ZEBRA_REMOTE_ES_VTEP_ADD),
 399         DESC_ENTRY(ZEBRA_REMOTE_ES_VTEP_DEL),
 400         DESC_ENTRY(ZEBRA_LOCAL_ES_EVI_ADD),
 401         DESC_ENTRY(ZEBRA_LOCAL_ES_EVI_DEL),
 402         DESC_ENTRY(ZEBRA_VNI_ADD),
 403         DESC_ENTRY(ZEBRA_VNI_DEL),
 404         DESC_ENTRY(ZEBRA_L3VNI_ADD),
 405         DESC_ENTRY(ZEBRA_L3VNI_DEL),
 406         DESC_ENTRY(ZEBRA_REMOTE_VTEP_ADD),
 407         DESC_ENTRY(ZEBRA_REMOTE_VTEP_DEL),
 408         DESC_ENTRY(ZEBRA_MACIP_ADD),
 409         DESC_ENTRY(ZEBRA_MACIP_DEL),
 410         DESC_ENTRY(ZEBRA_IP_PREFIX_ROUTE_ADD),
 411         DESC_ENTRY(ZEBRA_IP_PREFIX_ROUTE_DEL),
 412         DESC_ENTRY(ZEBRA_REMOTE_MACIP_ADD),
 413         DESC_ENTRY(ZEBRA_REMOTE_MACIP_DEL),
 414         DESC_ENTRY(ZEBRA_DUPLICATE_ADDR_DETECTION),
 415         DESC_ENTRY(ZEBRA_PW_ADD),
 416         DESC_ENTRY(ZEBRA_PW_DELETE),
 417         DESC_ENTRY(ZEBRA_PW_SET),
 418         DESC_ENTRY(ZEBRA_PW_UNSET),
 419         DESC_ENTRY(ZEBRA_PW_STATUS_UPDATE),
 420         DESC_ENTRY(ZEBRA_RULE_ADD),
 421         DESC_ENTRY(ZEBRA_RULE_DELETE),
 422         DESC_ENTRY(ZEBRA_RULE_NOTIFY_OWNER),
 423         DESC_ENTRY(ZEBRA_TABLE_MANAGER_CONNECT),
 424         DESC_ENTRY(ZEBRA_GET_TABLE_CHUNK),
 425         DESC_ENTRY(ZEBRA_RELEASE_TABLE_CHUNK),
 426         DESC_ENTRY(ZEBRA_IPSET_CREATE),
 427         DESC_ENTRY(ZEBRA_IPSET_DESTROY),
 428         DESC_ENTRY(ZEBRA_IPSET_ENTRY_ADD),
 429         DESC_ENTRY(ZEBRA_IPSET_ENTRY_DELETE),
 430         DESC_ENTRY(ZEBRA_IPSET_NOTIFY_OWNER),
 431         DESC_ENTRY(ZEBRA_IPSET_ENTRY_NOTIFY_OWNER),
 432         DESC_ENTRY(ZEBRA_IPTABLE_ADD),
 433         DESC_ENTRY(ZEBRA_IPTABLE_DELETE),
 434         DESC_ENTRY(ZEBRA_IPTABLE_NOTIFY_OWNER),
 435         DESC_ENTRY(ZEBRA_VXLAN_FLOOD_CONTROL),
 436         DESC_ENTRY(ZEBRA_VXLAN_SG_ADD),
 437         DESC_ENTRY(ZEBRA_VXLAN_SG_DEL),
 438         DESC_ENTRY(ZEBRA_VXLAN_SG_REPLAY),
 439         DESC_ENTRY(ZEBRA_MLAG_PROCESS_UP),
 440         DESC_ENTRY(ZEBRA_MLAG_PROCESS_DOWN),
 441         DESC_ENTRY(ZEBRA_MLAG_CLIENT_REGISTER),
 442         DESC_ENTRY(ZEBRA_MLAG_CLIENT_UNREGISTER),
 443         DESC_ENTRY(ZEBRA_MLAG_FORWARD_MSG),
 444         DESC_ENTRY(ZEBRA_ERROR),
 445         DESC_ENTRY(ZEBRA_CLIENT_CAPABILITIES),
 446         DESC_ENTRY(ZEBRA_OPAQUE_MESSAGE),
 447         DESC_ENTRY(ZEBRA_OPAQUE_REGISTER),
 448         DESC_ENTRY(ZEBRA_OPAQUE_UNREGISTER),
 449         DESC_ENTRY(ZEBRA_NEIGH_DISCOVER),
 450         DESC_ENTRY(ZEBRA_NHG_ADD),
 451         DESC_ENTRY(ZEBRA_NHG_DEL),
 452         DESC_ENTRY(ZEBRA_NHG_NOTIFY_OWNER),
 453         DESC_ENTRY(ZEBRA_ROUTE_NOTIFY_REQUEST),
 454         DESC_ENTRY(ZEBRA_CLIENT_CLOSE_NOTIFY),
 455         DESC_ENTRY(ZEBRA_EVPN_REMOTE_NH_ADD),
 456         DESC_ENTRY(ZEBRA_EVPN_REMOTE_NH_DEL),
 457         DESC_ENTRY(ZEBRA_NHRP_NEIGH_ADDED),
 458         DESC_ENTRY(ZEBRA_NHRP_NEIGH_REMOVED),
 459         DESC_ENTRY(ZEBRA_NHRP_NEIGH_GET),
 460         DESC_ENTRY(ZEBRA_NHRP_NEIGH_REGISTER),
 461         DESC_ENTRY(ZEBRA_NHRP_NEIGH_UNREGISTER),
 462         DESC_ENTRY(ZEBRA_NEIGH_IP_ADD),
 463         DESC_ENTRY(ZEBRA_NEIGH_IP_DEL),
 464         DESC_ENTRY(ZEBRA_CONFIGURE_ARP),
 465         DESC_ENTRY(ZEBRA_GRE_GET),
 466         DESC_ENTRY(ZEBRA_GRE_UPDATE),
 467         DESC_ENTRY(ZEBRA_GRE_SOURCE_SET)};
 468 #undef DESC_ENTRY
 469
 470 static const struct zebra_desc_table unknown = {0, "unknown", '?'};
 471
 472 static const struct zebra_desc_table *zroute_lookup(unsigned int zroute)
 473 {
 474         unsigned int i;
 475
 476         if (zroute >= array_size(route_types)) {
 477                 flog_err(EC_LIB_DEVELOPMENT, "unknown zebra route type: %u",
 478                          zroute);
 479                 return &unknown;
 480         }
 481         if (zroute == route_types[zroute].type)
 482                 return &route_types[zroute];
 483         for (i = 0; i < array_size(route_types); i++) {
 484                 if (zroute == route_types[i].type) {
 485                         zlog_warn(
 486                                 "internal error: route type table out of order while searching for %u, please notify developers",
 487                                 zroute);
 488                         return &route_types[i];
 489                 }
 490         }
 491         flog_err(EC_LIB_DEVELOPMENT,
 492                  "internal error: cannot find route type %u in table!", zroute);
 493         return &unknown;
 494 }
 495
 496 const char *zebra_route_string(unsigned int zroute)
 497 {
 498         return zroute_lookup(zroute)->string;
 499 }
 500
 501 char zebra_route_char(unsigned int zroute)
 502 {
 503         return zroute_lookup(zroute)->chr;
 504 }
 505
 506 const char *zserv_command_string(unsigned int command)
 507 {
 508         if (command >= array_size(command_types)) {
 509                 flog_err(EC_LIB_DEVELOPMENT, "unknown zserv command type: %u",
 510                          command);
 511                 return unknown.string;
 512         }
 513         return command_types[command].string;
 514 }
 515
 516 int proto_name2num(const char *s)
 517 {
 518         unsigned i;
 519
 520         for (i = 0; i < array_size(route_types); ++i)
 521                 if (strcasecmp(s, route_types[i].string) == 0)
 522                         return route_types[i].type;
 523         return -1;
 524 }
 525
 526 int proto_redistnum(int afi, const char *s)
 527 {
 528         if (!s)
 529                 return -1;
 530
 531         if (afi == AFI_IP) {
 532                 if (strmatch(s, "kernel"))
 533                         return ZEBRA_ROUTE_KERNEL;
 534                 else if (strmatch(s, "connected"))
 535                         return ZEBRA_ROUTE_CONNECT;
 536                 else if (strmatch(s, "static"))
 537                         return ZEBRA_ROUTE_STATIC;
 538                 else if (strmatch(s, "rip"))
 539                         return ZEBRA_ROUTE_RIP;
 540                 else if (strmatch(s, "eigrp"))
 541                         return ZEBRA_ROUTE_EIGRP;
 542                 else if (strmatch(s, "ospf"))
 543                         return ZEBRA_ROUTE_OSPF;
 544                 else if (strmatch(s, "isis"))
 545                         return ZEBRA_ROUTE_ISIS;
 546                 else if (strmatch(s, "bgp"))
 547                         return ZEBRA_ROUTE_BGP;
 548                 else if (strmatch(s, "table"))
 549                         return ZEBRA_ROUTE_TABLE;
 550                 else if (strmatch(s, "vnc"))
 551                         return ZEBRA_ROUTE_VNC;
 552                 else if (strmatch(s, "vnc-direct"))
 553                         return ZEBRA_ROUTE_VNC_DIRECT;
 554                 else if (strmatch(s, "nhrp"))
 555                         return ZEBRA_ROUTE_NHRP;
 556                 else if (strmatch(s, "babel"))
 557                         return ZEBRA_ROUTE_BABEL;
 558                 else if (strmatch(s, "sharp"))
 559                         return ZEBRA_ROUTE_SHARP;
 560                 else if (strmatch(s, "openfabric"))
 561                         return ZEBRA_ROUTE_OPENFABRIC;
 562         }
 563         if (afi == AFI_IP6) {
 564                 if (strmatch(s, "kernel"))
 565                         return ZEBRA_ROUTE_KERNEL;
 566                 else if (strmatch(s, "connected"))
 567                         return ZEBRA_ROUTE_CONNECT;
 568                 else if (strmatch(s, "static"))
 569                         return ZEBRA_ROUTE_STATIC;
 570                 else if (strmatch(s, "ripng"))
 571                         return ZEBRA_ROUTE_RIPNG;
 572                 else if (strmatch(s, "ospf6"))
 573                         return ZEBRA_ROUTE_OSPF6;
 574                 else if (strmatch(s, "isis"))
 575                         return ZEBRA_ROUTE_ISIS;
 576                 else if (strmatch(s, "bgp"))
 577                         return ZEBRA_ROUTE_BGP;
 578                 else if (strmatch(s, "table"))
 579                         return ZEBRA_ROUTE_TABLE;
 580                 else if (strmatch(s, "vnc"))
 581                         return ZEBRA_ROUTE_VNC;
 582                 else if (strmatch(s, "vnc-direct"))
 583                         return ZEBRA_ROUTE_VNC_DIRECT;
 584                 else if (strmatch(s, "nhrp"))
 585                         return ZEBRA_ROUTE_NHRP;
 586                 else if (strmatch(s, "babel"))
 587                         return ZEBRA_ROUTE_BABEL;
 588                 else if (strmatch(s, "sharp"))
 589                         return ZEBRA_ROUTE_SHARP;
 590                 else if (strmatch(s, "openfabric"))
 591                         return ZEBRA_ROUTE_OPENFABRIC;
 592         }
 593         return -1;
 594 }
 595
 596 void zlog_hexdump(const void *mem, size_t len)
 597 {
 598         char line[64];
 599         const uint8_t *src = mem;
 600         const uint8_t *end = src + len;
 601
 602         if (len == 0) {
 603                 zlog_debug("%016lx: (zero length / no data)", (long)src);
 604                 return;
 605         }
 606
 607         while (src < end) {
 608                 struct fbuf fb = {
 609                         .buf = line,
 610                         .pos = line,
 611                         .len = sizeof(line),
 612                 };
 613                 const uint8_t *lineend = src + 8;
 614                 unsigned line_bytes = 0;
 615
 616                 bprintfrr(&fb, "%016lx: ", (long)src);
 617
 618                 while (src < lineend && src < end) {
 619                         bprintfrr(&fb, "%02x ", *src++);
 620                         line_bytes++;
 621                 }
 622                 if (line_bytes < 8)
 623                         bprintfrr(&fb, "%*s", (8 - line_bytes) * 3, "");
 624
 625                 src -= line_bytes;
 626                 while (src < lineend && src < end && fb.pos < fb.buf + fb.len) {
 627                         uint8_t byte = *src++;
 628
 629                         if (isprint(byte))
 630                                 *fb.pos++ = byte;
 631                         else
 632                                 *fb.pos++ = '.';
 633                 }
 634
 635                 zlog_debug("%.*s", (int)(fb.pos - fb.buf), fb.buf);
 636         }
 637 }
 638
 639 const char *zlog_sanitize(char *buf, size_t bufsz, const void *in, size_t inlen)
 640 {
 641         const char *inbuf = in;
 642         char *pos = buf, *end = buf + bufsz;
 643         const char *iend = inbuf + inlen;
 644
 645         memset(buf, 0, bufsz);
 646         for (; inbuf < iend; inbuf++) {
 647                 /* don't write partial escape sequence */
 648                 if (end - pos < 5)
 649                         break;
 650
 651                 if (*inbuf == '\n')
 652                         snprintf(pos, end - pos, "\\n");
 653                 else if (*inbuf == '\r')
 654                         snprintf(pos, end - pos, "\\r");
 655                 else if (*inbuf == '\t')
 656                         snprintf(pos, end - pos, "\\t");
 657                 else if (*inbuf < ' ' || *inbuf == '"' || *inbuf >= 127)
 658                         snprintf(pos, end - pos, "\\x%02hhx", *inbuf);
 659                 else
 660                         *pos = *inbuf;
 661
 662                 pos += strlen(pos);
 663         }
 664         return buf;
 665 }