back to topotato report
topotato coverage report
Current view: top level - lib - log.c (source / functions) Hit Total Coverage
Test: test_bgp_set_aspath_replace.py::BGPSetAspathReplace Lines: 49 232 21.1 %
Date: 2023-02-24 18:37:49 Functions: 6 16 37.5 %

          Line data    Source code
       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          10 : const char *lookup_msg(const struct message *mz, int kz, const char *nf)
      54             : {
      55          10 :         static struct message nt = {0};
      56          10 :         const char *rz = nf ? nf : "(no message found)";
      57          10 :         const struct message *pnt;
      58         170 :         for (pnt = mz; memcmp(pnt, &nt, sizeof(struct message)); pnt++)
      59         170 :                 if (pnt->key == kz) {
      60          10 :                         rz = pnt->str ? pnt->str : rz;
      61             :                         break;
      62             :                 }
      63          10 :         return rz;
      64             : }
      65             : 
      66             : /* For time string format. */
      67          10 : size_t frr_timestamp(int timestamp_precision, char *buf, size_t buflen)
      68             : {
      69          10 :         static struct {
      70             :                 time_t last;
      71             :                 size_t len;
      72             :                 char buf[28];
      73             :         } cache;
      74          10 :         struct timeval clock;
      75             : 
      76          10 :         gettimeofday(&clock, NULL);
      77             : 
      78             :         /* first, we update the cache if the time has changed */
      79          10 :         if (cache.last != clock.tv_sec) {
      80           3 :                 struct tm tm;
      81           3 :                 cache.last = clock.tv_sec;
      82           3 :                 localtime_r(&cache.last, &tm);
      83           3 :                 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          10 :         if (buflen > cache.len) {
      92          10 :                 memcpy(buf, cache.buf, cache.len);
      93          10 :                 if ((timestamp_precision > 0)
      94          10 :                     && (buflen > cache.len + 1 + timestamp_precision)) {
      95             :                         /* should we worry about locale issues? */
      96          10 :                         static const int divisor[] = {0,   100000, 10000, 1000,
      97             :                                                       100, 10,     1};
      98          10 :                         int prec;
      99          10 :                         char *p = buf + cache.len + 1
     100          10 :                                   + (prec = timestamp_precision);
     101          10 :                         *p-- = '\0';
     102          10 :                         while (prec > 6)
     103             :                         /* this is unlikely to happen, but protect anyway */
     104             :                         {
     105           0 :                                 *p-- = '0';
     106           0 :                                 prec--;
     107             :                         }
     108          10 :                         clock.tv_usec /= divisor[prec];
     109          20 :                         do {
     110          20 :                                 *p-- = '0' + (clock.tv_usec % 10);
     111          20 :                                 clock.tv_usec /= 10;
     112          20 :                         } while (--prec > 0);
     113          10 :                         *p = '.';
     114          10 :                         return cache.len + 1 + timestamp_precision;
     115             :                 }
     116           0 :                 buf[cache.len] = '\0';
     117           0 :                 return cache.len;
     118             :         }
     119           0 :         if (buflen > 0)
     120           0 :                 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           0 : void zlog_signal(int signo, const char *action, void *siginfo_v,
     132             :                  void *program_counter)
     133             : {
     134           0 :         siginfo_t *siginfo = siginfo_v;
     135           0 :         time_t now;
     136           0 :         char buf[sizeof("DEFAULT: Received signal S at T (si_addr 0xP, PC 0xP); aborting...")
     137             :                  + 100];
     138           0 :         struct fbuf fb = { .buf = buf, .pos = buf, .len = sizeof(buf) };
     139             : 
     140           0 :         time(&now);
     141             : 
     142           0 :         bprintfrr(&fb, "Received signal %d at %lld", signo, (long long)now);
     143           0 :         if (program_counter)
     144           0 :                 bprintfrr(&fb, " (si_addr 0x%tx, PC 0x%tx)",
     145           0 :                           (ptrdiff_t)siginfo->si_addr,
     146             :                           (ptrdiff_t)program_counter);
     147             :         else
     148           0 :                 bprintfrr(&fb, " (si_addr 0x%tx)",
     149           0 :                           (ptrdiff_t)siginfo->si_addr);
     150           0 :         bprintfrr(&fb, "; %s\n", action);
     151             : 
     152           0 :         zlog_sigsafe(fb.buf, fb.pos - fb.buf);
     153             : 
     154           0 :         zlog_backtrace_sigsafe(LOG_CRIT, program_counter);
     155             : 
     156           0 :         fb.pos = buf;
     157             : 
     158           0 :         struct thread *tc;
     159           0 :         tc = pthread_getspecific(thread_current);
     160             : 
     161           0 :         if (!tc)
     162           0 :                 bprintfrr(&fb, "no thread information available\n");
     163             :         else
     164           0 :                 bprintfrr(&fb, "in thread %s scheduled from %s:%d %s()\n",
     165           0 :                           tc->xref->funcname, tc->xref->xref.file,
     166           0 :                           tc->xref->xref.line, tc->xref->xref.func);
     167             : 
     168           0 :         zlog_sigsafe(fb.buf, fb.pos - fb.buf);
     169           0 : }
     170             : 
     171             : /* Log a backtrace using only async-signal-safe functions.
     172             :    Needs to be enhanced to support syslog logging. */
     173           0 : void zlog_backtrace_sigsafe(int priority, void *program_counter)
     174             : {
     175             : #ifdef HAVE_LIBUNWIND
     176           0 :         char buf[256];
     177           0 :         struct fbuf fb = { .buf = buf, .len = sizeof(buf) };
     178           0 :         unw_cursor_t cursor;
     179           0 :         unw_context_t uc;
     180           0 :         unw_word_t ip, off, sp;
     181           0 :         Dl_info dlinfo;
     182             : 
     183           0 :         memset(&uc, 0, sizeof(uc));
     184           0 :         memset(&cursor, 0, sizeof(cursor));
     185             : 
     186           0 :         unw_getcontext(&uc);
     187           0 :         unw_init_local(&cursor, &uc);
     188           0 :         while (unw_step(&cursor) > 0) {
     189           0 :                 char name[128] = "?";
     190             : 
     191           0 :                 unw_get_reg(&cursor, UNW_REG_IP, &ip);
     192           0 :                 unw_get_reg(&cursor, UNW_REG_SP, &sp);
     193             : 
     194           0 :                 if (!unw_get_proc_name(&cursor, buf, sizeof(buf), &off))
     195           0 :                         snprintfrr(name, sizeof(name), "%s+%#lx",
     196             :                                    buf, (long)off);
     197             : 
     198           0 :                 fb.pos = buf;
     199           0 :                 if (unw_is_signal_frame(&cursor))
     200           0 :                         bprintfrr(&fb, "    ---- signal ----\n");
     201           0 :                 bprintfrr(&fb, "%-30s %16lx %16lx", name, (long)ip, (long)sp);
     202           0 :                 if (dladdr((void *)ip, &dlinfo))
     203           0 :                         bprintfrr(&fb, " %s (mapped at %p)",
     204             :                                   dlinfo.dli_fname, dlinfo.dli_fbase);
     205           0 :                 bprintfrr(&fb, "\n");
     206           0 :                 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           0 : }
     237             : 
     238           0 : void zlog_backtrace(int priority)
     239             : {
     240             : #ifdef HAVE_LIBUNWIND
     241           0 :         char buf[100];
     242           0 :         unw_cursor_t cursor = {};
     243           0 :         unw_context_t uc;
     244           0 :         unw_word_t ip, off, sp;
     245           0 :         Dl_info dlinfo;
     246             : 
     247           0 :         unw_getcontext(&uc);
     248           0 :         unw_init_local(&cursor, &uc);
     249           0 :         zlog(priority, "Backtrace:");
     250           0 :         while (unw_step(&cursor) > 0) {
     251           0 :                 char name[128] = "?";
     252             : 
     253           0 :                 unw_get_reg(&cursor, UNW_REG_IP, &ip);
     254           0 :                 unw_get_reg(&cursor, UNW_REG_SP, &sp);
     255             : 
     256           0 :                 if (unw_is_signal_frame(&cursor))
     257           0 :                         zlog(priority, "    ---- signal ----");
     258             : 
     259           0 :                 if (!unw_get_proc_name(&cursor, buf, sizeof(buf), &off))
     260           0 :                         snprintf(name, sizeof(name), "%s+%#lx",
     261             :                                 buf, (long)off);
     262             : 
     263           0 :                 if (dladdr((void *)ip, &dlinfo))
     264           0 :                         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           0 :                         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           0 : }
     299             : 
     300           0 : void zlog_thread_info(int log_level)
     301             : {
     302           0 :         struct thread *tc;
     303           0 :         tc = pthread_getspecific(thread_current);
     304             : 
     305           0 :         if (tc)
     306           0 :                 zlog(log_level,
     307             :                      "Current thread function %s, scheduled from file %s, line %u in %s()",
     308           0 :                      tc->xref->funcname, tc->xref->xref.file,
     309           0 :                      tc->xref->xref.line, tc->xref->xref.func);
     310             :         else
     311           0 :                 zlog(log_level, "Current thread not known/applicable");
     312           0 : }
     313             : 
     314           0 : void memory_oom(size_t size, const char *name)
     315             : {
     316           0 :         zlog(LOG_CRIT,
     317             :              "out of memory: failed to allocate %zu bytes for %s object",
     318             :              size, name);
     319           0 :         zlog_backtrace(LOG_CRIT);
     320           0 :         log_memstats(stderr, "log");
     321           0 :         abort();
     322             : }
     323             : 
     324             : /* Wrapper around strerror to handle case where it returns NULL. */
     325          10 : const char *safe_strerror(int errnum)
     326             : {
     327          10 :         const char *s = strerror(errnum);
     328          10 :         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_INTERFACE_SET_PROTODOWN),
     341             :         DESC_ENTRY(ZEBRA_ROUTE_ADD),
     342             :         DESC_ENTRY(ZEBRA_ROUTE_DELETE),
     343             :         DESC_ENTRY(ZEBRA_ROUTE_NOTIFY_OWNER),
     344             :         DESC_ENTRY(ZEBRA_REDISTRIBUTE_ADD),
     345             :         DESC_ENTRY(ZEBRA_REDISTRIBUTE_DELETE),
     346             :         DESC_ENTRY(ZEBRA_REDISTRIBUTE_DEFAULT_ADD),
     347             :         DESC_ENTRY(ZEBRA_REDISTRIBUTE_DEFAULT_DELETE),
     348             :         DESC_ENTRY(ZEBRA_ROUTER_ID_ADD),
     349             :         DESC_ENTRY(ZEBRA_ROUTER_ID_DELETE),
     350             :         DESC_ENTRY(ZEBRA_ROUTER_ID_UPDATE),
     351             :         DESC_ENTRY(ZEBRA_HELLO),
     352             :         DESC_ENTRY(ZEBRA_CAPABILITIES),
     353             :         DESC_ENTRY(ZEBRA_NEXTHOP_REGISTER),
     354             :         DESC_ENTRY(ZEBRA_NEXTHOP_UNREGISTER),
     355             :         DESC_ENTRY(ZEBRA_NEXTHOP_UPDATE),
     356             :         DESC_ENTRY(ZEBRA_INTERFACE_NBR_ADDRESS_ADD),
     357             :         DESC_ENTRY(ZEBRA_INTERFACE_NBR_ADDRESS_DELETE),
     358             :         DESC_ENTRY(ZEBRA_INTERFACE_BFD_DEST_UPDATE),
     359             :         DESC_ENTRY(ZEBRA_BFD_DEST_REGISTER),
     360             :         DESC_ENTRY(ZEBRA_BFD_DEST_DEREGISTER),
     361             :         DESC_ENTRY(ZEBRA_BFD_DEST_UPDATE),
     362             :         DESC_ENTRY(ZEBRA_BFD_DEST_REPLAY),
     363             :         DESC_ENTRY(ZEBRA_REDISTRIBUTE_ROUTE_ADD),
     364             :         DESC_ENTRY(ZEBRA_REDISTRIBUTE_ROUTE_DEL),
     365             :         DESC_ENTRY(ZEBRA_VRF_UNREGISTER),
     366             :         DESC_ENTRY(ZEBRA_VRF_ADD),
     367             :         DESC_ENTRY(ZEBRA_VRF_DELETE),
     368             :         DESC_ENTRY(ZEBRA_VRF_LABEL),
     369             :         DESC_ENTRY(ZEBRA_INTERFACE_VRF_UPDATE),
     370             :         DESC_ENTRY(ZEBRA_BFD_CLIENT_REGISTER),
     371             :         DESC_ENTRY(ZEBRA_BFD_CLIENT_DEREGISTER),
     372             :         DESC_ENTRY(ZEBRA_INTERFACE_ENABLE_RADV),
     373             :         DESC_ENTRY(ZEBRA_INTERFACE_DISABLE_RADV),
     374             :         DESC_ENTRY(ZEBRA_NEXTHOP_LOOKUP_MRIB),
     375             :         DESC_ENTRY(ZEBRA_INTERFACE_LINK_PARAMS),
     376             :         DESC_ENTRY(ZEBRA_MPLS_LABELS_ADD),
     377             :         DESC_ENTRY(ZEBRA_MPLS_LABELS_DELETE),
     378             :         DESC_ENTRY(ZEBRA_MPLS_LABELS_REPLACE),
     379             :         DESC_ENTRY(ZEBRA_SR_POLICY_SET),
     380             :         DESC_ENTRY(ZEBRA_SR_POLICY_DELETE),
     381             :         DESC_ENTRY(ZEBRA_SR_POLICY_NOTIFY_STATUS),
     382             :         DESC_ENTRY(ZEBRA_IPMR_ROUTE_STATS),
     383             :         DESC_ENTRY(ZEBRA_LABEL_MANAGER_CONNECT),
     384             :         DESC_ENTRY(ZEBRA_LABEL_MANAGER_CONNECT_ASYNC),
     385             :         DESC_ENTRY(ZEBRA_GET_LABEL_CHUNK),
     386             :         DESC_ENTRY(ZEBRA_RELEASE_LABEL_CHUNK),
     387             :         DESC_ENTRY(ZEBRA_FEC_REGISTER),
     388             :         DESC_ENTRY(ZEBRA_FEC_UNREGISTER),
     389             :         DESC_ENTRY(ZEBRA_FEC_UPDATE),
     390             :         DESC_ENTRY(ZEBRA_ADVERTISE_DEFAULT_GW),
     391             :         DESC_ENTRY(ZEBRA_ADVERTISE_SVI_MACIP),
     392             :         DESC_ENTRY(ZEBRA_ADVERTISE_SUBNET),
     393             :         DESC_ENTRY(ZEBRA_ADVERTISE_ALL_VNI),
     394             :         DESC_ENTRY(ZEBRA_LOCAL_ES_ADD),
     395             :         DESC_ENTRY(ZEBRA_LOCAL_ES_DEL),
     396             :         DESC_ENTRY(ZEBRA_REMOTE_ES_VTEP_ADD),
     397             :         DESC_ENTRY(ZEBRA_REMOTE_ES_VTEP_DEL),
     398             :         DESC_ENTRY(ZEBRA_LOCAL_ES_EVI_ADD),
     399             :         DESC_ENTRY(ZEBRA_LOCAL_ES_EVI_DEL),
     400             :         DESC_ENTRY(ZEBRA_VNI_ADD),
     401             :         DESC_ENTRY(ZEBRA_VNI_DEL),
     402             :         DESC_ENTRY(ZEBRA_L3VNI_ADD),
     403             :         DESC_ENTRY(ZEBRA_L3VNI_DEL),
     404             :         DESC_ENTRY(ZEBRA_REMOTE_VTEP_ADD),
     405             :         DESC_ENTRY(ZEBRA_REMOTE_VTEP_DEL),
     406             :         DESC_ENTRY(ZEBRA_MACIP_ADD),
     407             :         DESC_ENTRY(ZEBRA_MACIP_DEL),
     408             :         DESC_ENTRY(ZEBRA_IP_PREFIX_ROUTE_ADD),
     409             :         DESC_ENTRY(ZEBRA_IP_PREFIX_ROUTE_DEL),
     410             :         DESC_ENTRY(ZEBRA_REMOTE_MACIP_ADD),
     411             :         DESC_ENTRY(ZEBRA_REMOTE_MACIP_DEL),
     412             :         DESC_ENTRY(ZEBRA_DUPLICATE_ADDR_DETECTION),
     413             :         DESC_ENTRY(ZEBRA_PW_ADD),
     414             :         DESC_ENTRY(ZEBRA_PW_DELETE),
     415             :         DESC_ENTRY(ZEBRA_PW_SET),
     416             :         DESC_ENTRY(ZEBRA_PW_UNSET),
     417             :         DESC_ENTRY(ZEBRA_PW_STATUS_UPDATE),
     418             :         DESC_ENTRY(ZEBRA_RULE_ADD),
     419             :         DESC_ENTRY(ZEBRA_RULE_DELETE),
     420             :         DESC_ENTRY(ZEBRA_RULE_NOTIFY_OWNER),
     421             :         DESC_ENTRY(ZEBRA_TABLE_MANAGER_CONNECT),
     422             :         DESC_ENTRY(ZEBRA_GET_TABLE_CHUNK),
     423             :         DESC_ENTRY(ZEBRA_RELEASE_TABLE_CHUNK),
     424             :         DESC_ENTRY(ZEBRA_IPSET_CREATE),
     425             :         DESC_ENTRY(ZEBRA_IPSET_DESTROY),
     426             :         DESC_ENTRY(ZEBRA_IPSET_ENTRY_ADD),
     427             :         DESC_ENTRY(ZEBRA_IPSET_ENTRY_DELETE),
     428             :         DESC_ENTRY(ZEBRA_IPSET_NOTIFY_OWNER),
     429             :         DESC_ENTRY(ZEBRA_IPSET_ENTRY_NOTIFY_OWNER),
     430             :         DESC_ENTRY(ZEBRA_IPTABLE_ADD),
     431             :         DESC_ENTRY(ZEBRA_IPTABLE_DELETE),
     432             :         DESC_ENTRY(ZEBRA_IPTABLE_NOTIFY_OWNER),
     433             :         DESC_ENTRY(ZEBRA_VXLAN_FLOOD_CONTROL),
     434             :         DESC_ENTRY(ZEBRA_VXLAN_SG_ADD),
     435             :         DESC_ENTRY(ZEBRA_VXLAN_SG_DEL),
     436             :         DESC_ENTRY(ZEBRA_VXLAN_SG_REPLAY),
     437             :         DESC_ENTRY(ZEBRA_MLAG_PROCESS_UP),
     438             :         DESC_ENTRY(ZEBRA_MLAG_PROCESS_DOWN),
     439             :         DESC_ENTRY(ZEBRA_MLAG_CLIENT_REGISTER),
     440             :         DESC_ENTRY(ZEBRA_MLAG_CLIENT_UNREGISTER),
     441             :         DESC_ENTRY(ZEBRA_MLAG_FORWARD_MSG),
     442             :         DESC_ENTRY(ZEBRA_NHG_ADD),
     443             :         DESC_ENTRY(ZEBRA_NHG_DEL),
     444             :         DESC_ENTRY(ZEBRA_NHG_NOTIFY_OWNER),
     445             :         DESC_ENTRY(ZEBRA_EVPN_REMOTE_NH_ADD),
     446             :         DESC_ENTRY(ZEBRA_EVPN_REMOTE_NH_DEL),
     447             :         DESC_ENTRY(ZEBRA_SRV6_LOCATOR_ADD),
     448             :         DESC_ENTRY(ZEBRA_SRV6_LOCATOR_DELETE),
     449             :         DESC_ENTRY(ZEBRA_SRV6_MANAGER_GET_LOCATOR_CHUNK),
     450             :         DESC_ENTRY(ZEBRA_SRV6_MANAGER_RELEASE_LOCATOR_CHUNK),
     451             :         DESC_ENTRY(ZEBRA_ERROR),
     452             :         DESC_ENTRY(ZEBRA_CLIENT_CAPABILITIES),
     453             :         DESC_ENTRY(ZEBRA_OPAQUE_MESSAGE),
     454             :         DESC_ENTRY(ZEBRA_OPAQUE_REGISTER),
     455             :         DESC_ENTRY(ZEBRA_OPAQUE_UNREGISTER),
     456             :         DESC_ENTRY(ZEBRA_NEIGH_DISCOVER),
     457             :         DESC_ENTRY(ZEBRA_ROUTE_NOTIFY_REQUEST),
     458             :         DESC_ENTRY(ZEBRA_CLIENT_CLOSE_NOTIFY),
     459             :         DESC_ENTRY(ZEBRA_NHRP_NEIGH_ADDED),
     460             :         DESC_ENTRY(ZEBRA_NHRP_NEIGH_REMOVED),
     461             :         DESC_ENTRY(ZEBRA_NHRP_NEIGH_GET),
     462             :         DESC_ENTRY(ZEBRA_NHRP_NEIGH_REGISTER),
     463             :         DESC_ENTRY(ZEBRA_NHRP_NEIGH_UNREGISTER),
     464             :         DESC_ENTRY(ZEBRA_NEIGH_IP_ADD),
     465             :         DESC_ENTRY(ZEBRA_NEIGH_IP_DEL),
     466             :         DESC_ENTRY(ZEBRA_CONFIGURE_ARP),
     467             :         DESC_ENTRY(ZEBRA_GRE_GET),
     468             :         DESC_ENTRY(ZEBRA_GRE_UPDATE),
     469             :         DESC_ENTRY(ZEBRA_GRE_SOURCE_SET),
     470             :         DESC_ENTRY(ZEBRA_TC_QDISC_INSTALL),
     471             :         DESC_ENTRY(ZEBRA_TC_QDISC_UNINSTALL),
     472             :         DESC_ENTRY(ZEBRA_TC_CLASS_ADD),
     473             :         DESC_ENTRY(ZEBRA_TC_CLASS_DELETE),
     474             :         DESC_ENTRY(ZEBRA_TC_FILTER_ADD),
     475             :         DESC_ENTRY(ZEBRA_TC_FILTER_DELETE)};
     476             : #undef DESC_ENTRY
     477             : 
     478             : static const struct zebra_desc_table unknown = {0, "unknown", '?'};
     479             : 
     480          24 : static const struct zebra_desc_table *zroute_lookup(unsigned int zroute)
     481             : {
     482          24 :         unsigned int i;
     483             : 
     484          24 :         if (zroute >= array_size(route_types)) {
     485           0 :                 flog_err(EC_LIB_DEVELOPMENT, "unknown zebra route type: %u",
     486             :                          zroute);
     487           0 :                 return &unknown;
     488             :         }
     489          24 :         if (zroute == route_types[zroute].type)
     490          24 :                 return &route_types[zroute];
     491           0 :         for (i = 0; i < array_size(route_types); i++) {
     492           0 :                 if (zroute == route_types[i].type) {
     493           0 :                         zlog_warn(
     494             :                                 "internal error: route type table out of order while searching for %u, please notify developers",
     495             :                                 zroute);
     496           0 :                         return &route_types[i];
     497             :                 }
     498             :         }
     499           0 :         flog_err(EC_LIB_DEVELOPMENT,
     500             :                  "internal error: cannot find route type %u in table!", zroute);
     501           0 :         return &unknown;
     502             : }
     503             : 
     504          24 : const char *zebra_route_string(unsigned int zroute)
     505             : {
     506          24 :         return zroute_lookup(zroute)->string;
     507             : }
     508             : 
     509           0 : char zebra_route_char(unsigned int zroute)
     510             : {
     511           0 :         return zroute_lookup(zroute)->chr;
     512             : }
     513             : 
     514           0 : const char *zserv_command_string(unsigned int command)
     515             : {
     516           0 :         if (command >= array_size(command_types)) {
     517           0 :                 flog_err(EC_LIB_DEVELOPMENT, "unknown zserv command type: %u",
     518             :                          command);
     519           0 :                 return unknown.string;
     520             :         }
     521           0 :         return command_types[command].string;
     522             : }
     523             : 
     524           0 : int proto_name2num(const char *s)
     525             : {
     526           0 :         unsigned i;
     527             : 
     528           0 :         for (i = 0; i < array_size(route_types); ++i)
     529           0 :                 if (strcasecmp(s, route_types[i].string) == 0)
     530           0 :                         return route_types[i].type;
     531             :         return -1;
     532             : }
     533             : 
     534           1 : int proto_redistnum(int afi, const char *s)
     535             : {
     536           1 :         if (!s)
     537             :                 return -1;
     538             : 
     539           1 :         if (afi == AFI_IP) {
     540           1 :                 if (strmatch(s, "kernel"))
     541             :                         return ZEBRA_ROUTE_KERNEL;
     542           1 :                 else if (strmatch(s, "connected"))
     543             :                         return ZEBRA_ROUTE_CONNECT;
     544           0 :                 else if (strmatch(s, "static"))
     545             :                         return ZEBRA_ROUTE_STATIC;
     546           0 :                 else if (strmatch(s, "rip"))
     547             :                         return ZEBRA_ROUTE_RIP;
     548           0 :                 else if (strmatch(s, "eigrp"))
     549             :                         return ZEBRA_ROUTE_EIGRP;
     550           0 :                 else if (strmatch(s, "ospf"))
     551             :                         return ZEBRA_ROUTE_OSPF;
     552           0 :                 else if (strmatch(s, "isis"))
     553             :                         return ZEBRA_ROUTE_ISIS;
     554           0 :                 else if (strmatch(s, "bgp"))
     555             :                         return ZEBRA_ROUTE_BGP;
     556           0 :                 else if (strmatch(s, "table"))
     557             :                         return ZEBRA_ROUTE_TABLE;
     558           0 :                 else if (strmatch(s, "vnc"))
     559             :                         return ZEBRA_ROUTE_VNC;
     560           0 :                 else if (strmatch(s, "vnc-direct"))
     561             :                         return ZEBRA_ROUTE_VNC_DIRECT;
     562           0 :                 else if (strmatch(s, "nhrp"))
     563             :                         return ZEBRA_ROUTE_NHRP;
     564           0 :                 else if (strmatch(s, "babel"))
     565             :                         return ZEBRA_ROUTE_BABEL;
     566           0 :                 else if (strmatch(s, "sharp"))
     567             :                         return ZEBRA_ROUTE_SHARP;
     568           0 :                 else if (strmatch(s, "openfabric"))
     569             :                         return ZEBRA_ROUTE_OPENFABRIC;
     570             :         }
     571           0 :         if (afi == AFI_IP6) {
     572           0 :                 if (strmatch(s, "kernel"))
     573             :                         return ZEBRA_ROUTE_KERNEL;
     574           0 :                 else if (strmatch(s, "connected"))
     575             :                         return ZEBRA_ROUTE_CONNECT;
     576           0 :                 else if (strmatch(s, "static"))
     577             :                         return ZEBRA_ROUTE_STATIC;
     578           0 :                 else if (strmatch(s, "ripng"))
     579             :                         return ZEBRA_ROUTE_RIPNG;
     580           0 :                 else if (strmatch(s, "ospf6"))
     581             :                         return ZEBRA_ROUTE_OSPF6;
     582           0 :                 else if (strmatch(s, "isis"))
     583             :                         return ZEBRA_ROUTE_ISIS;
     584           0 :                 else if (strmatch(s, "bgp"))
     585             :                         return ZEBRA_ROUTE_BGP;
     586           0 :                 else if (strmatch(s, "table"))
     587             :                         return ZEBRA_ROUTE_TABLE;
     588           0 :                 else if (strmatch(s, "vnc"))
     589             :                         return ZEBRA_ROUTE_VNC;
     590           0 :                 else if (strmatch(s, "vnc-direct"))
     591             :                         return ZEBRA_ROUTE_VNC_DIRECT;
     592           0 :                 else if (strmatch(s, "nhrp"))
     593             :                         return ZEBRA_ROUTE_NHRP;
     594           0 :                 else if (strmatch(s, "babel"))
     595             :                         return ZEBRA_ROUTE_BABEL;
     596           0 :                 else if (strmatch(s, "sharp"))
     597             :                         return ZEBRA_ROUTE_SHARP;
     598           0 :                 else if (strmatch(s, "openfabric"))
     599           0 :                         return ZEBRA_ROUTE_OPENFABRIC;
     600             :         }
     601             :         return -1;
     602             : }
     603             : 
     604           0 : void zlog_hexdump(const void *mem, size_t len)
     605             : {
     606           0 :         char line[64];
     607           0 :         const uint8_t *src = mem;
     608           0 :         const uint8_t *end = src + len;
     609             : 
     610           0 :         if (len == 0) {
     611           0 :                 zlog_debug("%016lx: (zero length / no data)", (long)src);
     612           0 :                 return;
     613             :         }
     614             : 
     615           0 :         while (src < end) {
     616           0 :                 struct fbuf fb = {
     617             :                         .buf = line,
     618             :                         .pos = line,
     619             :                         .len = sizeof(line),
     620             :                 };
     621           0 :                 const uint8_t *lineend = src + 8;
     622           0 :                 unsigned line_bytes = 0;
     623             : 
     624           0 :                 bprintfrr(&fb, "%016lx: ", (long)src);
     625             : 
     626           0 :                 while (src < lineend && src < end) {
     627           0 :                         bprintfrr(&fb, "%02x ", *src++);
     628           0 :                         line_bytes++;
     629             :                 }
     630           0 :                 if (line_bytes < 8)
     631           0 :                         bprintfrr(&fb, "%*s", (8 - line_bytes) * 3, "");
     632             : 
     633           0 :                 src -= line_bytes;
     634           0 :                 while (src < lineend && src < end && fb.pos < fb.buf + fb.len) {
     635           0 :                         uint8_t byte = *src++;
     636             : 
     637           0 :                         if (isprint(byte))
     638           0 :                                 *fb.pos++ = byte;
     639             :                         else
     640           0 :                                 *fb.pos++ = '.';
     641             :                 }
     642             : 
     643           0 :                 zlog_debug("%.*s", (int)(fb.pos - fb.buf), fb.buf);
     644             :         }
     645             : }
     646             : 
     647           0 : const char *zlog_sanitize(char *buf, size_t bufsz, const void *in, size_t inlen)
     648             : {
     649           0 :         const char *inbuf = in;
     650           0 :         char *pos = buf, *end = buf + bufsz;
     651           0 :         const char *iend = inbuf + inlen;
     652             : 
     653           0 :         memset(buf, 0, bufsz);
     654           0 :         for (; inbuf < iend; inbuf++) {
     655             :                 /* don't write partial escape sequence */
     656           0 :                 if (end - pos < 5)
     657             :                         break;
     658             : 
     659           0 :                 if (*inbuf == '\n')
     660           0 :                         snprintf(pos, end - pos, "\\n");
     661           0 :                 else if (*inbuf == '\r')
     662           0 :                         snprintf(pos, end - pos, "\\r");
     663           0 :                 else if (*inbuf == '\t')
     664           0 :                         snprintf(pos, end - pos, "\\t");
     665           0 :                 else if (*inbuf < ' ' || *inbuf == '"' || *inbuf >= 127)
     666           0 :                         snprintf(pos, end - pos, "\\x%02hhx", *inbuf);
     667             :                 else
     668           0 :                         *pos = *inbuf;
     669             : 
     670           0 :                 pos += strlen(pos);
     671             :         }
     672           0 :         return buf;
     673             : }

Generated by: LCOV version v1.16-topotato