back to topotato report
topotato coverage report
Current view: top level - lib - log.c (source / functions) Hit Total Coverage
Test: test_bgp_ecmp_enhe.py::BGP_Unnumbered_ECMP Lines: 55 239 23.0 %
Date: 2023-11-16 17:19:14 Functions: 8 34 23.5 %

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

Generated by: LCOV version v1.16-topotato