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 "log_int.h"
  29 #include "memory.h"
  30 #include "command.h"
  31 #ifndef SUNOS_5
  32 #include <sys/un.h>
  33 #endif
  34 /* for printstack on solaris */
  35 #ifdef HAVE_UCONTEXT_H
  36 #include <ucontext.h>
  37 #endif
  38
  39 DEFINE_MTYPE_STATIC(LIB, ZLOG, "Logging")
  40
  41 static int logfile_fd = -1;     /* Used in signal handler. */
  42
  43 struct zlog *zlog_default = NULL;
  44
  45 const char *zlog_priority[] =
  46 {
  47   "emergencies",
  48   "alerts",
  49   "critical",
  50   "errors",
  51   "warnings",
  52   "notifications",
  53   "informational",
  54   "debugging",
  55   NULL,
  56 };
  57
  58 /*
  59  * write_wrapper
  60  *
  61  * glibc has declared that the return value from write *must* not be
  62  * ignored.
  63  * gcc see's this problem and issues a warning for the line.
  64  *
  65  * Why is this a big deal you say?  Because both of them are right
  66  * and if you have -Werror enabled then all calls to write
  67  * generate a build error and the build stops.
  68  *
  69  * clang has helpfully allowed this construct:
  70  * (void)write(...)
  71  * to tell the compiler yeah I know it has a return value
  72  * I don't care about it at this time.
  73  * gcc doesn't have this ability.
  74  *
  75  * This code was written such that it didn't care about the
  76  * return value from write.  At this time do I want
  77  * to go through and fix and test this code for correctness.
  78  * So just wrapper the bad behavior and move on.
  79  */
  80 static void write_wrapper (int fd, const void *buf, size_t count)
  81 {
  82   if (write (fd, buf, count) <= 0)
  83     return;
  84
  85   return;
  86 }
  87
  88 /**
  89  * Looks up a message in a message list by key.
  90  *
  91  * If the message is not found, returns the provided error message.
  92  *
  93  * Terminates when it hits a struct message that's all zeros.
  94  *
  95  * @param mz the message list
  96  * @param kz the message key
  97  * @param nf the message to return if not found
  98  * @return the message
  99  */
 100 const char *
 101 lookup_msg(const struct message *mz, int kz, const char *nf)
 102 {
 103   static struct message nt = { 0 };
 104   const char *rz = nf ? nf : "(no message found)";
 105   const struct message *pnt;
 106   for (pnt = mz; memcmp(pnt, &nt, sizeof(struct message)); pnt++)
 107     if (pnt->key == kz) {
 108       rz = pnt->str ? pnt->str : rz;
 109       break;
 110     }
 111   return rz;
 112 }
 113
 114 /* For time string format. */
 115 size_t
 116 quagga_timestamp(int timestamp_precision, char *buf, size_t buflen)
 117 {
 118   static struct {
 119     time_t last;
 120     size_t len;
 121     char buf[28];
 122   } cache;
 123   struct timeval clock;
 124
 125   gettimeofday(&clock, NULL);
 126
 127   /* first, we update the cache if the time has changed */
 128   if (cache.last != clock.tv_sec)
 129     {
 130       struct tm *tm;
 131       cache.last = clock.tv_sec;
 132       tm = localtime(&cache.last);
 133       cache.len = strftime(cache.buf, sizeof(cache.buf),
 134                            "%Y/%m/%d %H:%M:%S", tm);
 135     }
 136   /* note: it's not worth caching the subsecond part, because
 137      chances are that back-to-back calls are not sufficiently close together
 138      for the clock not to have ticked forward */
 139
 140   if (buflen > cache.len)
 141     {
 142       memcpy(buf, cache.buf, cache.len);
 143       if ((timestamp_precision > 0) &&
 144           (buflen > cache.len+1+timestamp_precision))
 145         {
 146           /* should we worry about locale issues? */
 147           static const int divisor[] = {0, 100000, 10000, 1000, 100, 10, 1};
 148           int prec;
 149           char *p = buf+cache.len+1+(prec = timestamp_precision);
 150           *p-- = '\0';
 151           while (prec > 6)
 152             /* this is unlikely to happen, but protect anyway */
 153             {
 154               *p-- = '0';
 155               prec--;
 156             }
 157           clock.tv_usec /= divisor[prec];
 158           do
 159             {
 160               *p-- = '0'+(clock.tv_usec % 10);
 161               clock.tv_usec /= 10;
 162             }
 163           while (--prec > 0);
 164           *p = '.';
 165           return cache.len+1+timestamp_precision;
 166         }
 167       buf[cache.len] = '\0';
 168       return cache.len;
 169     }
 170   if (buflen > 0)
 171     buf[0] = '\0';
 172   return 0;
 173 }
 174
 175 /* Utility routine for current time printing. */
 176 static void
 177 time_print(FILE *fp, struct timestamp_control *ctl)
 178 {
 179   if (!ctl->already_rendered)
 180     {
 181       ctl->len = quagga_timestamp(ctl->precision, ctl->buf, sizeof(ctl->buf));
 182       ctl->already_rendered = 1;
 183     }
 184   fprintf(fp, "%s ", ctl->buf);
 185 }
 186
 187
 188 /* va_list version of zlog. */
 189 void
 190 vzlog (int priority, const char *format, va_list args)
 191 {
 192   char proto_str[32];
 193   int original_errno = errno;
 194   struct timestamp_control tsctl;
 195   tsctl.already_rendered = 0;
 196   struct zlog *zl = zlog_default;
 197
 198   /* When zlog_default is also NULL, use stderr for logging. */
 199   if (zl == NULL)
 200     {
 201       tsctl.precision = 0;
 202       time_print(stderr, &tsctl);
 203       fprintf (stderr, "%s: ", "unknown");
 204       vfprintf (stderr, format, args);
 205       fprintf (stderr, "\n");
 206       fflush (stderr);
 207
 208       /* In this case we return at here. */
 209       errno = original_errno;
 210       return;
 211     }
 212   tsctl.precision = zl->timestamp_precision;
 213
 214   /* Syslog output */
 215   if (priority <= zl->maxlvl[ZLOG_DEST_SYSLOG])
 216     {
 217       va_list ac;
 218       va_copy(ac, args);
 219       vsyslog (priority|zlog_default->facility, format, ac);
 220       va_end(ac);
 221     }
 222
 223   if (zl->instance)
 224    sprintf (proto_str, "%s[%d]: ", zl->protoname, zl->instance);
 225   else
 226    sprintf (proto_str, "%s: ", zl->protoname);
 227
 228   /* File output. */
 229   if ((priority <= zl->maxlvl[ZLOG_DEST_FILE]) && zl->fp)
 230     {
 231       va_list ac;
 232       time_print (zl->fp, &tsctl);
 233       if (zl->record_priority)
 234         fprintf (zl->fp, "%s: ", zlog_priority[priority]);
 235       fprintf (zl->fp, "%s", proto_str);
 236       va_copy(ac, args);
 237       vfprintf (zl->fp, format, ac);
 238       va_end(ac);
 239       fprintf (zl->fp, "\n");
 240       fflush (zl->fp);
 241     }
 242
 243   /* stdout output. */
 244   if (priority <= zl->maxlvl[ZLOG_DEST_STDOUT])
 245     {
 246       va_list ac;
 247       time_print (stdout, &tsctl);
 248       if (zl->record_priority)
 249         fprintf (stdout, "%s: ", zlog_priority[priority]);
 250       fprintf (stdout, "%s", proto_str);
 251       va_copy(ac, args);
 252       vfprintf (stdout, format, ac);
 253       va_end(ac);
 254       fprintf (stdout, "\n");
 255       fflush (stdout);
 256     }
 257
 258   /* Terminal monitor. */
 259   if (priority <= zl->maxlvl[ZLOG_DEST_MONITOR])
 260     vty_log ((zl->record_priority ? zlog_priority[priority] : NULL),
 261              proto_str, format, &tsctl, args);
 262
 263   errno = original_errno;
 264 }
 265
 266 int
 267 vzlog_test (int priority)
 268 {
 269   struct zlog *zl = zlog_default;
 270
 271   /* When zlog_default is also NULL, use stderr for logging. */
 272   if (zl == NULL)
 273     {
 274       return 1;
 275     }
 276
 277   /* Syslog output */
 278   if (priority <= zl->maxlvl[ZLOG_DEST_SYSLOG])
 279     {
 280       return 1;
 281     }
 282
 283   /* File output. */
 284   if ((priority <= zl->maxlvl[ZLOG_DEST_FILE]) && zl->fp)
 285     {
 286       return 1;
 287     }
 288
 289   /* stdout output. */
 290   if (priority <= zl->maxlvl[ZLOG_DEST_STDOUT])
 291     {
 292       return 1;
 293     }
 294
 295   /* Terminal monitor. */
 296   if (priority <= zl->maxlvl[ZLOG_DEST_MONITOR])
 297     return 1;
 298
 299   return 0;
 300 }
 301
 302 static char *
 303 str_append(char *dst, int len, const char *src)
 304 {
 305   while ((len-- > 0) && *src)
 306     *dst++ = *src++;
 307   return dst;
 308 }
 309
 310 static char *
 311 num_append(char *s, int len, u_long x)
 312 {
 313   char buf[30];
 314   char *t;
 315
 316   if (!x)
 317     return str_append(s,len,"0");
 318   *(t = &buf[sizeof(buf)-1]) = '\0';
 319   while (x && (t > buf))
 320     {
 321       *--t = '0'+(x % 10);
 322       x /= 10;
 323     }
 324   return str_append(s,len,t);
 325 }
 326
 327 #if defined(SA_SIGINFO) || defined(HAVE_STACK_TRACE)
 328 static char *
 329 hex_append(char *s, int len, u_long x)
 330 {
 331   char buf[30];
 332   char *t;
 333
 334   if (!x)
 335     return str_append(s,len,"0");
 336   *(t = &buf[sizeof(buf)-1]) = '\0';
 337   while (x && (t > buf))
 338     {
 339       u_int cc = (x % 16);
 340       *--t = ((cc < 10) ? ('0'+cc) : ('a'+cc-10));
 341       x /= 16;
 342     }
 343   return str_append(s,len,t);
 344 }
 345 #endif
 346
 347 /* Needs to be enhanced to support Solaris. */
 348 static int
 349 syslog_connect(void)
 350 {
 351 #ifdef SUNOS_5
 352   return -1;
 353 #else
 354   int fd;
 355   char *s;
 356   struct sockaddr_un addr;
 357
 358   if ((fd = socket(AF_UNIX,SOCK_DGRAM,0)) < 0)
 359     return -1;
 360   addr.sun_family = AF_UNIX;
 361 #ifdef _PATH_LOG
 362 #define SYSLOG_SOCKET_PATH _PATH_LOG
 363 #else
 364 #define SYSLOG_SOCKET_PATH "/dev/log"
 365 #endif
 366   s = str_append(addr.sun_path,sizeof(addr.sun_path),SYSLOG_SOCKET_PATH);
 367 #undef SYSLOG_SOCKET_PATH
 368   *s = '\0';
 369   if (connect(fd,(struct sockaddr *)&addr,sizeof(addr)) < 0)
 370     {
 371       close(fd);
 372       return -1;
 373     }
 374   return fd;
 375 #endif
 376 }
 377
 378 static void
 379 syslog_sigsafe(int priority, const char *msg, size_t msglen)
 380 {
 381   static int syslog_fd = -1;
 382   char buf[sizeof("<1234567890>ripngd[1234567890]: ")+msglen+50];
 383   char *s;
 384
 385   if ((syslog_fd < 0) && ((syslog_fd = syslog_connect()) < 0))
 386     return;
 387
 388 #define LOC s,buf+sizeof(buf)-s
 389   s = buf;
 390   s = str_append(LOC,"<");
 391   s = num_append(LOC,priority);
 392   s = str_append(LOC,">");
 393   /* forget about the timestamp, too difficult in a signal handler */
 394   s = str_append(LOC,zlog_default->ident);
 395   if (zlog_default->syslog_options & LOG_PID)
 396     {
 397       s = str_append(LOC,"[");
 398       s = num_append(LOC,getpid());
 399       s = str_append(LOC,"]");
 400     }
 401   s = str_append(LOC,": ");
 402   s = str_append(LOC,msg);
 403   write_wrapper (syslog_fd,buf,s-buf);
 404 #undef LOC
 405 }
 406
 407 static int
 408 open_crashlog(void)
 409 {
 410 #define CRASHLOG_PREFIX "/var/tmp/quagga."
 411 #define CRASHLOG_SUFFIX "crashlog"
 412   if (zlog_default && zlog_default->ident)
 413     {
 414       /* Avoid strlen since it is not async-signal-safe. */
 415       const char *p;
 416       size_t ilen;
 417
 418       for (p = zlog_default->ident, ilen = 0; *p; p++)
 419         ilen++;
 420       {
 421         char buf[sizeof(CRASHLOG_PREFIX)+ilen+sizeof(CRASHLOG_SUFFIX)+3];
 422         char *s = buf;
 423 #define LOC s,buf+sizeof(buf)-s
 424         s = str_append(LOC, CRASHLOG_PREFIX);
 425         s = str_append(LOC, zlog_default->ident);
 426         s = str_append(LOC, ".");
 427         s = str_append(LOC, CRASHLOG_SUFFIX);
 428 #undef LOC
 429         *s = '\0';
 430         return open(buf, O_WRONLY|O_CREAT|O_EXCL, LOGFILE_MASK);
 431       }
 432     }
 433   return open(CRASHLOG_PREFIX CRASHLOG_SUFFIX, O_WRONLY|O_CREAT|O_EXCL,
 434               LOGFILE_MASK);
 435 #undef CRASHLOG_SUFFIX
 436 #undef CRASHLOG_PREFIX
 437 }
 438
 439 /* Note: the goal here is to use only async-signal-safe functions. */
 440 void
 441 zlog_signal(int signo, const char *action
 442 #ifdef SA_SIGINFO
 443             , siginfo_t *siginfo, void *program_counter
 444 #endif
 445            )
 446 {
 447   time_t now;
 448   char buf[sizeof("DEFAULT: Received signal S at T (si_addr 0xP, PC 0xP); aborting...")+100];
 449   char *s = buf;
 450   char *msgstart = buf;
 451 #define LOC s,buf+sizeof(buf)-s
 452
 453   time(&now);
 454   if (zlog_default)
 455     {
 456       s = str_append(LOC,zlog_default->protoname);
 457       *s++ = ':';
 458       *s++ = ' ';
 459       msgstart = s;
 460     }
 461   s = str_append(LOC,"Received signal ");
 462   s = num_append(LOC,signo);
 463   s = str_append(LOC," at ");
 464   s = num_append(LOC,now);
 465 #ifdef SA_SIGINFO
 466   s = str_append(LOC," (si_addr 0x");
 467   s = hex_append(LOC,(u_long)(siginfo->si_addr));
 468   if (program_counter)
 469     {
 470       s = str_append(LOC,", PC 0x");
 471       s = hex_append(LOC,(u_long)program_counter);
 472     }
 473   s = str_append(LOC,"); ");
 474 #else /* SA_SIGINFO */
 475   s = str_append(LOC,"; ");
 476 #endif /* SA_SIGINFO */
 477   s = str_append(LOC,action);
 478   if (s < buf+sizeof(buf))
 479     *s++ = '\n';
 480
 481   /* N.B. implicit priority is most severe */
 482 #define PRI LOG_CRIT
 483
 484 #define DUMP(FD) write_wrapper(FD, buf, s-buf);
 485   /* If no file logging configured, try to write to fallback log file. */
 486   if ((logfile_fd >= 0) || ((logfile_fd = open_crashlog()) >= 0))
 487     DUMP(logfile_fd)
 488   if (!zlog_default)
 489     DUMP(STDERR_FILENO)
 490   else
 491     {
 492       if (PRI <= zlog_default->maxlvl[ZLOG_DEST_STDOUT])
 493         DUMP(STDOUT_FILENO)
 494       /* Remove trailing '\n' for monitor and syslog */
 495       *--s = '\0';
 496       if (PRI <= zlog_default->maxlvl[ZLOG_DEST_MONITOR])
 497         vty_log_fixed(buf,s-buf);
 498       if (PRI <= zlog_default->maxlvl[ZLOG_DEST_SYSLOG])
 499         syslog_sigsafe(PRI|zlog_default->facility,msgstart,s-msgstart);
 500     }
 501 #undef DUMP
 502
 503   zlog_backtrace_sigsafe(PRI,
 504 #ifdef SA_SIGINFO
 505                          program_counter
 506 #else
 507                          NULL
 508 #endif
 509                         );
 510
 511   s = buf;
 512   if (!thread_current)
 513     s = str_append (LOC, "no thread information available\n");
 514   else
 515     {
 516       s = str_append (LOC, "in thread ");
 517       s = str_append (LOC, thread_current->funcname);
 518       s = str_append (LOC, " scheduled from ");
 519       s = str_append (LOC, thread_current->schedfrom);
 520       s = str_append (LOC, ":");
 521       s = num_append (LOC, thread_current->schedfrom_line);
 522       s = str_append (LOC, "\n");
 523     }
 524
 525 #define DUMP(FD) write_wrapper(FD, buf, s-buf);
 526   /* If no file logging configured, try to write to fallback log file. */
 527   if (logfile_fd >= 0)
 528     DUMP(logfile_fd)
 529   if (!zlog_default)
 530     DUMP(STDERR_FILENO)
 531   else
 532     {
 533       if (PRI <= zlog_default->maxlvl[ZLOG_DEST_STDOUT])
 534         DUMP(STDOUT_FILENO)
 535       /* Remove trailing '\n' for monitor and syslog */
 536       *--s = '\0';
 537       if (PRI <= zlog_default->maxlvl[ZLOG_DEST_MONITOR])
 538         vty_log_fixed(buf,s-buf);
 539       if (PRI <= zlog_default->maxlvl[ZLOG_DEST_SYSLOG])
 540         syslog_sigsafe(PRI|zlog_default->facility,msgstart,s-msgstart);
 541     }
 542 #undef DUMP
 543
 544 #undef PRI
 545 #undef LOC
 546 }
 547
 548 /* Log a backtrace using only async-signal-safe functions.
 549    Needs to be enhanced to support syslog logging. */
 550 void
 551 zlog_backtrace_sigsafe(int priority, void *program_counter)
 552 {
 553 #ifdef HAVE_STACK_TRACE
 554   static const char pclabel[] = "Program counter: ";
 555   void *array[64];
 556   int size;
 557   char buf[100];
 558   char *s, **bt = NULL;
 559 #define LOC s,buf+sizeof(buf)-s
 560
 561 #ifdef HAVE_GLIBC_BACKTRACE
 562   size = backtrace(array, array_size(array));
 563   if (size <= 0 || (size_t)size > array_size(array))
 564     return;
 565
 566 #define DUMP(FD) { \
 567   if (program_counter) \
 568     { \
 569       write_wrapper(FD, pclabel, sizeof(pclabel)-1); \
 570       backtrace_symbols_fd(&program_counter, 1, FD); \
 571     } \
 572   write_wrapper(FD, buf, s-buf);        \
 573   backtrace_symbols_fd(array, size, FD); \
 574 }
 575 #elif defined(HAVE_PRINTSTACK)
 576 #define DUMP(FD) { \
 577   if (program_counter) \
 578     write_wrapper((FD), pclabel, sizeof(pclabel)-1); \
 579   write_wrapper((FD), buf, s-buf); \
 580   printstack((FD)); \
 581 }
 582 #endif /* HAVE_GLIBC_BACKTRACE, HAVE_PRINTSTACK */
 583
 584   s = buf;
 585   s = str_append(LOC,"Backtrace for ");
 586   s = num_append(LOC,size);
 587   s = str_append(LOC," stack frames:\n");
 588
 589   if ((logfile_fd >= 0) || ((logfile_fd = open_crashlog()) >= 0))
 590     DUMP(logfile_fd)
 591   if (!zlog_default)
 592     DUMP(STDERR_FILENO)
 593   else
 594     {
 595       if (priority <= zlog_default->maxlvl[ZLOG_DEST_STDOUT])
 596         DUMP(STDOUT_FILENO)
 597       /* Remove trailing '\n' for monitor and syslog */
 598       *--s = '\0';
 599       if (priority <= zlog_default->maxlvl[ZLOG_DEST_MONITOR])
 600         vty_log_fixed(buf,s-buf);
 601       if (priority <= zlog_default->maxlvl[ZLOG_DEST_SYSLOG])
 602         syslog_sigsafe(priority|zlog_default->facility,buf,s-buf);
 603       {
 604         int i;
 605 #ifdef HAVE_GLIBC_BACKTRACE
 606         bt = backtrace_symbols(array, size);
 607 #endif
 608         /* Just print the function addresses. */
 609         for (i = 0; i < size; i++)
 610           {
 611             s = buf;
 612             if (bt)
 613               s = str_append(LOC, bt[i]);
 614             else {
 615               s = str_append(LOC,"[bt ");
 616               s = num_append(LOC,i);
 617               s = str_append(LOC,"] 0x");
 618               s = hex_append(LOC,(u_long)(array[i]));
 619             }
 620             *s = '\0';
 621             if (priority <= zlog_default->maxlvl[ZLOG_DEST_MONITOR])
 622               vty_log_fixed(buf,s-buf);
 623             if (priority <= zlog_default->maxlvl[ZLOG_DEST_SYSLOG])
 624               syslog_sigsafe(priority|zlog_default->facility,buf,s-buf);
 625           }
 626           if (bt)
 627             free(bt);
 628       }
 629     }
 630 #undef DUMP
 631 #undef LOC
 632 #endif /* HAVE_STRACK_TRACE */
 633 }
 634
 635 void
 636 zlog_backtrace(int priority)
 637 {
 638 #ifndef HAVE_GLIBC_BACKTRACE
 639   zlog(priority, "No backtrace available on this platform.");
 640 #else
 641   void *array[20];
 642   int size, i;
 643   char **strings;
 644
 645   size = backtrace(array, array_size(array));
 646   if (size <= 0 || (size_t)size > array_size(array))
 647     {
 648       zlog_err("Cannot get backtrace, returned invalid # of frames %d "
 649                "(valid range is between 1 and %lu)",
 650                size, (unsigned long)(array_size(array)));
 651       return;
 652     }
 653   zlog(priority, "Backtrace for %d stack frames:", size);
 654   if (!(strings = backtrace_symbols(array, size)))
 655     {
 656       zlog_err("Cannot get backtrace symbols (out of memory?)");
 657       for (i = 0; i < size; i++)
 658         zlog(priority, "[bt %d] %p",i,array[i]);
 659     }
 660   else
 661     {
 662       for (i = 0; i < size; i++)
 663         zlog(priority, "[bt %d] %s",i,strings[i]);
 664       free(strings);
 665     }
 666 #endif /* HAVE_GLIBC_BACKTRACE */
 667 }
 668
 669 void
 670 zlog (int priority, const char *format, ...)
 671 {
 672   va_list args;
 673
 674   va_start(args, format);
 675   vzlog (priority, format, args);
 676   va_end (args);
 677 }
 678
 679 #define ZLOG_FUNC(FUNCNAME,PRIORITY) \
 680 void \
 681 FUNCNAME(const char *format, ...) \
 682 { \
 683   va_list args; \
 684   va_start(args, format); \
 685   vzlog (PRIORITY, format, args); \
 686   va_end(args); \
 687 }
 688
 689 ZLOG_FUNC(zlog_err, LOG_ERR)
 690
 691 ZLOG_FUNC(zlog_warn, LOG_WARNING)
 692
 693 ZLOG_FUNC(zlog_info, LOG_INFO)
 694
 695 ZLOG_FUNC(zlog_notice, LOG_NOTICE)
 696
 697 ZLOG_FUNC(zlog_debug, LOG_DEBUG)
 698
 699 #undef ZLOG_FUNC
 700
 701 void zlog_thread_info (int log_level)
 702 {
 703   if (thread_current)
 704     zlog(log_level, "Current thread function %s, scheduled from "
 705          "file %s, line %u", thread_current->funcname,
 706          thread_current->schedfrom, thread_current->schedfrom_line);
 707   else
 708     zlog(log_level, "Current thread not known/applicable");
 709 }
 710
 711 void
 712 _zlog_assert_failed (const char *assertion, const char *file,
 713                      unsigned int line, const char *function)
 714 {
 715   /* Force fallback file logging? */
 716   if (zlog_default && !zlog_default->fp &&
 717       ((logfile_fd = open_crashlog()) >= 0) &&
 718       ((zlog_default->fp = fdopen(logfile_fd, "w")) != NULL))
 719     zlog_default->maxlvl[ZLOG_DEST_FILE] = LOG_ERR;
 720   zlog(LOG_CRIT, "Assertion `%s' failed in file %s, line %u, function %s",
 721        assertion,file,line,(function ? function : "?"));
 722   zlog_backtrace(LOG_CRIT);
 723   zlog_thread_info(LOG_CRIT);
 724   log_memstats_stderr ("log");
 725   abort();
 726 }
 727
 728 void
 729 memory_oom (size_t size, const char *name)
 730 {
 731         zlog_err("out of memory: failed to allocate %zu bytes for %s"
 732                  "object", size, name);
 733         zlog_backtrace(LOG_ERR);
 734         abort();
 735 }
 736
 737 /* Open log stream */
 738 void
 739 openzlog (const char *progname, const char *protoname, u_short instance,
 740           int syslog_flags, int syslog_facility)
 741 {
 742   struct zlog *zl;
 743   u_int i;
 744
 745   zl = XCALLOC(MTYPE_ZLOG, sizeof (struct zlog));
 746
 747   zl->ident = progname;
 748   zl->protoname = protoname;
 749   zl->instance = instance;
 750   zl->facility = syslog_facility;
 751   zl->syslog_options = syslog_flags;
 752
 753   /* Set default logging levels. */
 754   for (i = 0; i < array_size(zl->maxlvl); i++)
 755     zl->maxlvl[i] = ZLOG_DISABLED;
 756   zl->maxlvl[ZLOG_DEST_MONITOR] = LOG_DEBUG;
 757   zl->default_lvl = LOG_DEBUG;
 758
 759   openlog (progname, syslog_flags, zl->facility);
 760   zlog_default = zl;
 761
 762 #ifdef HAVE_GLIBC_BACKTRACE
 763   /* work around backtrace() using lazily resolved dynamically linked
 764    * symbols, which will otherwise cause funny breakage in the SEGV handler.
 765    * (particularly, the dynamic linker can call malloc(), which uses locks
 766    * in programs linked with -pthread, thus can deadlock.) */
 767   void *bt[4];
 768   backtrace (bt, array_size(bt));
 769   free (backtrace_symbols (bt, 0));
 770   backtrace_symbols_fd (bt, 0, 0);
 771 #endif
 772 }
 773
 774 void
 775 closezlog (void)
 776 {
 777   struct zlog *zl = zlog_default;
 778
 779   closelog();
 780
 781   if (zl->fp != NULL)
 782     fclose (zl->fp);
 783
 784   if (zl->filename != NULL)
 785     XFREE(MTYPE_ZLOG, zl->filename);
 786
 787   XFREE (MTYPE_ZLOG, zl);
 788   zlog_default = NULL;
 789 }
 790
 791 /* Called from command.c. */
 792 void
 793 zlog_set_level (zlog_dest_t dest, int log_level)
 794 {
 795   zlog_default->maxlvl[dest] = log_level;
 796 }
 797
 798 int
 799 zlog_set_file (const char *filename, int log_level)
 800 {
 801   struct zlog *zl = zlog_default;
 802   FILE *fp;
 803   mode_t oldumask;
 804
 805   /* There is opend file.  */
 806   zlog_reset_file ();
 807
 808   /* Open file. */
 809   oldumask = umask (0777 & ~LOGFILE_MASK);
 810   fp = fopen (filename, "a");
 811   umask(oldumask);
 812   if (fp == NULL)
 813     return 0;
 814
 815   /* Set flags. */
 816   zl->filename = XSTRDUP(MTYPE_ZLOG, filename);
 817   zl->maxlvl[ZLOG_DEST_FILE] = log_level;
 818   zl->fp = fp;
 819   logfile_fd = fileno(fp);
 820
 821   return 1;
 822 }
 823
 824 /* Reset opend file. */
 825 int
 826 zlog_reset_file (void)
 827 {
 828   struct zlog *zl = zlog_default;
 829
 830   if (zl->fp)
 831     fclose (zl->fp);
 832   zl->fp = NULL;
 833   logfile_fd = -1;
 834   zl->maxlvl[ZLOG_DEST_FILE] = ZLOG_DISABLED;
 835
 836   if (zl->filename)
 837     XFREE(MTYPE_ZLOG, zl->filename);
 838   zl->filename = NULL;
 839
 840   return 1;
 841 }
 842
 843 /* Reopen log file. */
 844 int
 845 zlog_rotate (void)
 846 {
 847   struct zlog *zl = zlog_default;
 848   int level;
 849
 850   if (zl->fp)
 851     fclose (zl->fp);
 852   zl->fp = NULL;
 853   logfile_fd = -1;
 854   level = zl->maxlvl[ZLOG_DEST_FILE];
 855   zl->maxlvl[ZLOG_DEST_FILE] = ZLOG_DISABLED;
 856
 857   if (zl->filename)
 858     {
 859       mode_t oldumask;
 860       int save_errno;
 861
 862       oldumask = umask (0777 & ~LOGFILE_MASK);
 863       zl->fp = fopen (zl->filename, "a");
 864       save_errno = errno;
 865       umask(oldumask);
 866       if (zl->fp == NULL)
 867         {
 868           zlog_err("Log rotate failed: cannot open file %s for append: %s",
 869                    zl->filename, safe_strerror(save_errno));
 870           return -1;
 871         }
 872       logfile_fd = fileno(zl->fp);
 873       zl->maxlvl[ZLOG_DEST_FILE] = level;
 874     }
 875
 876   return 1;
 877 }
 878
 879 /* Wrapper around strerror to handle case where it returns NULL. */
 880 const char *
 881 safe_strerror(int errnum)
 882 {
 883   const char *s = strerror(errnum);
 884   return (s != NULL) ? s : "Unknown error";
 885 }
 886
 887 #define DESC_ENTRY(T) [(T)] = { (T), (#T), '\0' }
 888 static const struct zebra_desc_table command_types[] = {
 889   DESC_ENTRY    (ZEBRA_INTERFACE_ADD),
 890   DESC_ENTRY    (ZEBRA_INTERFACE_DELETE),
 891   DESC_ENTRY    (ZEBRA_INTERFACE_ADDRESS_ADD),
 892   DESC_ENTRY    (ZEBRA_INTERFACE_ADDRESS_DELETE),
 893   DESC_ENTRY    (ZEBRA_INTERFACE_UP),
 894   DESC_ENTRY    (ZEBRA_INTERFACE_DOWN),
 895   DESC_ENTRY    (ZEBRA_IPV4_ROUTE_ADD),
 896   DESC_ENTRY    (ZEBRA_IPV4_ROUTE_DELETE),
 897   DESC_ENTRY    (ZEBRA_IPV6_ROUTE_ADD),
 898   DESC_ENTRY    (ZEBRA_IPV6_ROUTE_DELETE),
 899   DESC_ENTRY    (ZEBRA_REDISTRIBUTE_ADD),
 900   DESC_ENTRY    (ZEBRA_REDISTRIBUTE_DELETE),
 901   DESC_ENTRY    (ZEBRA_REDISTRIBUTE_DEFAULT_ADD),
 902   DESC_ENTRY    (ZEBRA_REDISTRIBUTE_DEFAULT_DELETE),
 903   DESC_ENTRY    (ZEBRA_ROUTER_ID_ADD),
 904   DESC_ENTRY    (ZEBRA_ROUTER_ID_DELETE),
 905   DESC_ENTRY    (ZEBRA_ROUTER_ID_UPDATE),
 906   DESC_ENTRY    (ZEBRA_HELLO),
 907   DESC_ENTRY    (ZEBRA_NEXTHOP_REGISTER),
 908   DESC_ENTRY    (ZEBRA_NEXTHOP_UNREGISTER),
 909   DESC_ENTRY    (ZEBRA_NEXTHOP_UPDATE),
 910   DESC_ENTRY    (ZEBRA_INTERFACE_NBR_ADDRESS_ADD),
 911   DESC_ENTRY    (ZEBRA_INTERFACE_NBR_ADDRESS_DELETE),
 912   DESC_ENTRY    (ZEBRA_INTERFACE_BFD_DEST_UPDATE),
 913   DESC_ENTRY    (ZEBRA_IMPORT_ROUTE_REGISTER),
 914   DESC_ENTRY    (ZEBRA_IMPORT_ROUTE_UNREGISTER),
 915   DESC_ENTRY    (ZEBRA_IMPORT_CHECK_UPDATE),
 916   DESC_ENTRY    (ZEBRA_IPV4_ROUTE_IPV6_NEXTHOP_ADD),
 917   DESC_ENTRY    (ZEBRA_BFD_DEST_REGISTER),
 918   DESC_ENTRY    (ZEBRA_BFD_DEST_DEREGISTER),
 919   DESC_ENTRY    (ZEBRA_BFD_DEST_UPDATE),
 920   DESC_ENTRY    (ZEBRA_BFD_DEST_REPLAY),
 921   DESC_ENTRY    (ZEBRA_REDISTRIBUTE_IPV4_ADD),
 922   DESC_ENTRY    (ZEBRA_REDISTRIBUTE_IPV4_DEL),
 923   DESC_ENTRY    (ZEBRA_REDISTRIBUTE_IPV6_ADD),
 924   DESC_ENTRY    (ZEBRA_REDISTRIBUTE_IPV6_DEL),
 925   DESC_ENTRY    (ZEBRA_VRF_UNREGISTER),
 926   DESC_ENTRY    (ZEBRA_VRF_ADD),
 927   DESC_ENTRY    (ZEBRA_VRF_DELETE),
 928   DESC_ENTRY    (ZEBRA_INTERFACE_VRF_UPDATE),
 929   DESC_ENTRY    (ZEBRA_BFD_CLIENT_REGISTER),
 930   DESC_ENTRY    (ZEBRA_INTERFACE_ENABLE_RADV),
 931   DESC_ENTRY    (ZEBRA_INTERFACE_DISABLE_RADV),
 932   DESC_ENTRY    (ZEBRA_IPV4_NEXTHOP_LOOKUP_MRIB),
 933   DESC_ENTRY    (ZEBRA_INTERFACE_LINK_PARAMS),
 934   DESC_ENTRY    (ZEBRA_MPLS_LABELS_ADD),
 935   DESC_ENTRY    (ZEBRA_MPLS_LABELS_DELETE),
 936   DESC_ENTRY    (ZEBRA_IPV4_NEXTHOP_ADD),
 937   DESC_ENTRY    (ZEBRA_IPV4_NEXTHOP_DELETE),
 938   DESC_ENTRY    (ZEBRA_IPV6_NEXTHOP_ADD),
 939   DESC_ENTRY    (ZEBRA_IPV6_NEXTHOP_DELETE),
 940   DESC_ENTRY    (ZEBRA_IPMR_ROUTE_STATS),
 941   DESC_ENTRY    (ZEBRA_LABEL_MANAGER_CONNECT),
 942   DESC_ENTRY    (ZEBRA_GET_LABEL_CHUNK),
 943   DESC_ENTRY    (ZEBRA_RELEASE_LABEL_CHUNK),
 944 };
 945 #undef DESC_ENTRY
 946
 947 static const struct zebra_desc_table unknown = { 0, "unknown", '?' };
 948
 949 static const struct zebra_desc_table *
 950 zroute_lookup(u_int zroute)
 951 {
 952   u_int i;
 953
 954   if (zroute >= array_size(route_types))
 955     {
 956       zlog_err("unknown zebra route type: %u", zroute);
 957       return &unknown;
 958     }
 959   if (zroute == route_types[zroute].type)
 960     return &route_types[zroute];
 961   for (i = 0; i < array_size(route_types); i++)
 962     {
 963       if (zroute == route_types[i].type)
 964         {
 965           zlog_warn("internal error: route type table out of order "
 966                     "while searching for %u, please notify developers", zroute);
 967           return &route_types[i];
 968         }
 969     }
 970   zlog_err("internal error: cannot find route type %u in table!", zroute);
 971   return &unknown;
 972 }
 973
 974 const char *
 975 zebra_route_string(u_int zroute)
 976 {
 977   return zroute_lookup(zroute)->string;
 978 }
 979
 980 char
 981 zebra_route_char(u_int zroute)
 982 {
 983   return zroute_lookup(zroute)->chr;
 984 }
 985
 986 const char *
 987 zserv_command_string (unsigned int command)
 988 {
 989   if (command >= array_size(command_types))
 990     {
 991       zlog_err ("unknown zserv command type: %u", command);
 992       return unknown.string;
 993     }
 994   return command_types[command].string;
 995 }
 996
 997 int
 998 proto_name2num(const char *s)
 999 {
1000    unsigned i;
1001
1002    for (i=0; i<array_size(route_types); ++i)
1003      if (strcasecmp(s, route_types[i].string) == 0)
1004        return route_types[i].type;
1005    return -1;
1006 }
1007
1008 int
1009 proto_redistnum(int afi, const char *s)
1010 {
1011   if (! s)
1012     return -1;
1013
1014   if (afi == AFI_IP)
1015     {
1016       if (strmatch (s, "kernel"))
1017         return ZEBRA_ROUTE_KERNEL;
1018       else if (strmatch (s, "connected"))
1019         return ZEBRA_ROUTE_CONNECT;
1020       else if (strmatch (s, "static"))
1021         return ZEBRA_ROUTE_STATIC;
1022       else if (strmatch (s, "rip"))
1023         return ZEBRA_ROUTE_RIP;
1024       else if (strmatch (s, "eigrp"))
1025         return ZEBRA_ROUTE_EIGRP;
1026       else if (strmatch (s, "ospf"))
1027         return ZEBRA_ROUTE_OSPF;
1028       else if (strmatch (s, "isis"))
1029         return ZEBRA_ROUTE_ISIS;
1030       else if (strmatch (s, "bgp"))
1031         return ZEBRA_ROUTE_BGP;
1032       else if (strmatch (s, "table"))
1033         return ZEBRA_ROUTE_TABLE;
1034       else if (strmatch (s, "vnc"))
1035         return ZEBRA_ROUTE_VNC;
1036       else if (strmatch (s, "vnc-direct"))
1037         return ZEBRA_ROUTE_VNC_DIRECT;
1038       else if (strmatch (s, "nhrp"))
1039         return ZEBRA_ROUTE_NHRP;
1040       else if (strmatch (s, "babel"))
1041         return ZEBRA_ROUTE_BABEL;
1042     }
1043   if (afi == AFI_IP6)
1044     {
1045       if (strmatch (s, "kernel"))
1046         return ZEBRA_ROUTE_KERNEL;
1047       else if (strmatch (s, "connected"))
1048         return ZEBRA_ROUTE_CONNECT;
1049       else if (strmatch (s, "static"))
1050         return ZEBRA_ROUTE_STATIC;
1051       else if (strmatch (s, "ripng"))
1052         return ZEBRA_ROUTE_RIPNG;
1053       else if (strmatch (s, "ospf6"))
1054         return ZEBRA_ROUTE_OSPF6;
1055       else if (strmatch (s, "isis"))
1056         return ZEBRA_ROUTE_ISIS;
1057       else if (strmatch (s, "bgp"))
1058         return ZEBRA_ROUTE_BGP;
1059       else if (strmatch (s, "table"))
1060         return ZEBRA_ROUTE_TABLE;
1061       else if (strmatch (s, "vnc"))
1062         return ZEBRA_ROUTE_VNC;
1063       else if (strmatch (s, "vnc-direct"))
1064         return ZEBRA_ROUTE_VNC_DIRECT;
1065       else if (strmatch (s, "nhrp"))
1066         return ZEBRA_ROUTE_NHRP;
1067       else if (strmatch (s, "babel"))
1068         return ZEBRA_ROUTE_BABEL;
1069     }
1070   return -1;
1071 }
1072
1073 void
1074 zlog_hexdump (const void *mem, unsigned int len) {
1075   unsigned long i = 0;
1076   unsigned int j = 0;
1077   unsigned int columns = 8;
1078   char buf[(len * 4) + ((len/4) * 20) + 30];
1079   char *s = buf;
1080
1081   for (i = 0; i < len + ((len % columns) ? (columns - len % columns) : 0); i++)
1082     {
1083       /* print offset */
1084       if (i % columns == 0)
1085         s += sprintf(s, "0x%016lx: ", (unsigned long)mem + i);
1086
1087       /* print hex data */
1088       if (i < len)
1089         s += sprintf(s, "%02x ", 0xFF & ((const char*)mem)[i]);
1090
1091       /* end of block, just aligning for ASCII dump */
1092       else
1093         s += sprintf(s, "   ");
1094
1095       /* print ASCII dump */
1096       if (i % columns == (columns - 1))
1097         {
1098           for (j = i - (columns - 1); j <= i; j++)
1099             {
1100               if (j >= len) /* end of block, not really printing */
1101                 s += sprintf(s, " ");
1102
1103               else if(isprint((int)((const char *)mem)[j])) /* printable char */
1104                 s += sprintf(s, "%c", 0xFF & ((const char *)mem)[j]);
1105
1106               else /* other char */
1107                 s += sprintf(s, ".");
1108             }
1109           s += sprintf(s, "\n");
1110         }
1111     }
1112     zlog_debug("\n%s", buf);
1113 }
1114
1115 const char *
1116 zlog_sanitize (char *buf, size_t bufsz, const void *in, size_t inlen)
1117 {
1118   const char *inbuf = in;
1119   char *pos = buf, *end = buf + bufsz;
1120   const char *iend = inbuf + inlen;
1121
1122   memset (buf, 0, bufsz);
1123   for (; inbuf < iend; inbuf++)
1124     {
1125       /* don't write partial escape sequence */
1126       if (end - pos < 5)
1127         break;
1128
1129       if (*inbuf == '\n')
1130         snprintf (pos, end - pos, "\\n");
1131       else if (*inbuf == '\r')
1132         snprintf (pos, end - pos, "\\r");
1133       else if (*inbuf == '\t')
1134         snprintf (pos, end - pos, "\\t");
1135       else if (*inbuf < ' ' || *inbuf == '"' || *inbuf >= 127)
1136         snprintf (pos, end - pos, "\\x%02hhx", *inbuf);
1137       else
1138         *pos = *inbuf;
1139
1140       pos += strlen (pos);
1141     }
1142   return buf;
1143 }