sysklogd/syslogd.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Mini syslogd implementation for busybox
   4  *
   5  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
   6  *
   7  * Copyright (C) 2000 by Karl M. Hegbloom <karlheg@debian.org>
   8  *
   9  * "circular buffer" Copyright (C) 2001 by Gennady Feldman <gfeldman@gena01.com>
  10  *
  11  * Maintainer: Gennady Feldman <gfeldman@gena01.com> as of Mar 12, 2001
  12  *
  13  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  14  */
  15
  16 //usage:#define syslogd_trivial_usage
  17 //usage:       "[OPTIONS]"
  18 //usage:#define syslogd_full_usage "\n\n"
  19 //usage:       "System logging utility\n"
  20 //usage:        IF_NOT_FEATURE_SYSLOGD_CFG(
  21 //usage:       "(this version of syslogd ignores /etc/syslog.conf)\n"
  22 //usage:        )
  23 //usage:     "\n        -n              Run in foreground"
  24 //usage:     "\n        -O FILE         Log to FILE (default:/var/log/messages)"
  25 //usage:     "\n        -l N            Log only messages more urgent than prio N (1-8)"
  26 //usage:     "\n        -S              Smaller output"
  27 //usage:        IF_FEATURE_ROTATE_LOGFILE(
  28 //usage:     "\n        -s SIZE         Max size (KB) before rotation (default:200KB, 0=off)"
  29 //usage:     "\n        -b N            N rotated logs to keep (default:1, max=99, 0=purge)"
  30 //usage:        )
  31 //usage:        IF_FEATURE_REMOTE_LOG(
  32 //usage:     "\n        -R HOST[:PORT]  Log to IP or hostname on PORT (default PORT=514/UDP)"
  33 //usage:     "\n        -L              Log locally and via network (default is network only if -R)"
  34 //usage:        )
  35 //usage:        IF_FEATURE_SYSLOGD_DUP(
  36 //usage:     "\n        -D              Drop duplicates"
  37 //usage:        )
  38 //usage:        IF_FEATURE_IPC_SYSLOG(
  39 /* NB: -Csize shouldn't have space (because size is optional) */
  40 //usage:     "\n        -C[size_kb]     Log to shared mem buffer (use logread to read it)"
  41 //usage:        )
  42 //usage:        IF_FEATURE_SYSLOGD_CFG(
  43 //usage:     "\n        -f FILE         Use FILE as config (default:/etc/syslog.conf)"
  44 //usage:        )
  45 /* //usage:  "\n        -m MIN          Minutes between MARK lines (default:20, 0=off)" */
  46 //usage:        IF_FEATURE_KMSG_SYSLOG(
  47 //usage:     "\n        -K              Log to kernel printk buffer (use dmesg to read it)"
  48 //usage:        )
  49 //usage:
  50 //usage:#define syslogd_example_usage
  51 //usage:       "$ syslogd -R masterlog:514\n"
  52 //usage:       "$ syslogd -R 192.168.1.1:601\n"
  53
  54 /*
  55  * Done in syslogd_and_logger.c:
  56 #include "libbb.h"
  57 #define SYSLOG_NAMES
  58 #define SYSLOG_NAMES_CONST
  59 #include <syslog.h>
  60 */
  61
  62 #include <sys/un.h>
  63 #include <sys/uio.h>
  64
  65 #if ENABLE_FEATURE_REMOTE_LOG
  66 #include <netinet/in.h>
  67 #endif
  68
  69 #if ENABLE_FEATURE_IPC_SYSLOG
  70 #include <sys/ipc.h>
  71 #include <sys/sem.h>
  72 #include <sys/shm.h>
  73 #endif
  74
  75
  76 #define DEBUG 0
  77
  78 /* MARK code is not very useful, is bloat, and broken:
  79  * can deadlock if alarmed to make MARK while writing to IPC buffer
  80  * (semaphores are down but do_mark routine tries to down them again) */
  81 #undef SYSLOGD_MARK
  82
  83 /* Write locking does not seem to be useful either */
  84 #undef SYSLOGD_WRLOCK
  85
  86 enum {
  87         MAX_READ = CONFIG_FEATURE_SYSLOGD_READ_BUFFER_SIZE,
  88         DNS_WAIT_SEC = 2 * 60,
  89 };
  90
  91 /* Semaphore operation structures */
  92 struct shbuf_ds {
  93         int32_t size;   /* size of data - 1 */
  94         int32_t tail;   /* end of message list */
  95         char data[1];   /* data/messages */
  96 };
  97
  98 #if ENABLE_FEATURE_REMOTE_LOG
  99 typedef struct {
 100         int remoteFD;
 101         unsigned last_dns_resolve;
 102         len_and_sockaddr *remoteAddr;
 103         const char *remoteHostname;
 104 } remoteHost_t;
 105 #endif
 106
 107 typedef struct logFile_t {
 108         const char *path;
 109         int fd;
 110 #if ENABLE_FEATURE_ROTATE_LOGFILE
 111         unsigned size;
 112         uint8_t isRegular;
 113 #endif
 114 } logFile_t;
 115
 116 #if ENABLE_FEATURE_SYSLOGD_CFG
 117 typedef struct logRule_t {
 118         uint8_t enabled_facility_priomap[LOG_NFACILITIES];
 119         struct logFile_t *file;
 120         struct logRule_t *next;
 121 } logRule_t;
 122 #endif
 123
 124 /* Allows us to have smaller initializer. Ugly. */
 125 #define GLOBALS \
 126         logFile_t logFile;                      \
 127         /* interval between marks in seconds */ \
 128         /*int markInterval;*/                   \
 129         /* level of messages to be logged */    \
 130         int logLevel;                           \
 131 IF_FEATURE_ROTATE_LOGFILE( \
 132         /* max size of file before rotation */  \
 133         unsigned logFileSize;                   \
 134         /* number of rotated message files */   \
 135         unsigned logFileRotate;                 \
 136 ) \
 137 IF_FEATURE_IPC_SYSLOG( \
 138         int shmid; /* ipc shared memory id */   \
 139         int s_semid; /* ipc semaphore id */     \
 140         int shm_size;                           \
 141         struct sembuf SMwup[1];                 \
 142         struct sembuf SMwdn[3];                 \
 143 ) \
 144 IF_FEATURE_SYSLOGD_CFG( \
 145         logRule_t *log_rules; \
 146 ) \
 147 IF_FEATURE_KMSG_SYSLOG( \
 148         int kmsgfd; \
 149         int primask; \
 150 )
 151
 152 struct init_globals {
 153         GLOBALS
 154 };
 155
 156 struct globals {
 157         GLOBALS
 158
 159 #if ENABLE_FEATURE_REMOTE_LOG
 160         llist_t *remoteHosts;
 161 #endif
 162 #if ENABLE_FEATURE_IPC_SYSLOG
 163         struct shbuf_ds *shbuf;
 164 #endif
 165         time_t last_log_time;
 166         /* localhost's name. We print only first 64 chars */
 167         char *hostname;
 168
 169         /* We recv into recvbuf... */
 170         char recvbuf[MAX_READ * (1 + ENABLE_FEATURE_SYSLOGD_DUP)];
 171         /* ...then copy to parsebuf, escaping control chars */
 172         /* (can grow x2 max) */
 173         char parsebuf[MAX_READ*2];
 174         /* ...then sprintf into printbuf, adding timestamp (15 chars),
 175          * host (64), fac.prio (20) to the message */
 176         /* (growth by: 15 + 64 + 20 + delims = ~110) */
 177         char printbuf[MAX_READ*2 + 128];
 178 };
 179
 180 static const struct init_globals init_data = {
 181         .logFile = {
 182                 .path = "/var/log/messages",
 183                 .fd = -1,
 184         },
 185 #ifdef SYSLOGD_MARK
 186         .markInterval = 20 * 60,
 187 #endif
 188         .logLevel = 8,
 189 #if ENABLE_FEATURE_ROTATE_LOGFILE
 190         .logFileSize = 200 * 1024,
 191         .logFileRotate = 1,
 192 #endif
 193 #if ENABLE_FEATURE_IPC_SYSLOG
 194         .shmid = -1,
 195         .s_semid = -1,
 196         .shm_size = ((CONFIG_FEATURE_IPC_SYSLOG_BUFFER_SIZE)*1024), /* default shm size */
 197         .SMwup = { {1, -1, IPC_NOWAIT} },
 198         .SMwdn = { {0, 0}, {1, 0}, {1, +1} },
 199 #endif
 200 };
 201
 202 #define G (*ptr_to_globals)
 203 #define INIT_G() do { \
 204         SET_PTR_TO_GLOBALS(memcpy(xzalloc(sizeof(G)), &init_data, sizeof(init_data))); \
 205 } while (0)
 206
 207
 208 /* Options */
 209 enum {
 210         OPTBIT_mark = 0, // -m
 211         OPTBIT_nofork, // -n
 212         OPTBIT_outfile, // -O
 213         OPTBIT_loglevel, // -l
 214         OPTBIT_small, // -S
 215         IF_FEATURE_ROTATE_LOGFILE(OPTBIT_filesize   ,)  // -s
 216         IF_FEATURE_ROTATE_LOGFILE(OPTBIT_rotatecnt  ,)  // -b
 217         IF_FEATURE_REMOTE_LOG(    OPTBIT_remotelog  ,)  // -R
 218         IF_FEATURE_REMOTE_LOG(    OPTBIT_locallog   ,)  // -L
 219         IF_FEATURE_IPC_SYSLOG(    OPTBIT_circularlog,)  // -C
 220         IF_FEATURE_SYSLOGD_DUP(   OPTBIT_dup        ,)  // -D
 221         IF_FEATURE_SYSLOGD_CFG(   OPTBIT_cfg        ,)  // -f
 222         IF_FEATURE_KMSG_SYSLOG(   OPTBIT_kmsg       ,)  // -K
 223
 224         OPT_mark        = 1 << OPTBIT_mark    ,
 225         OPT_nofork      = 1 << OPTBIT_nofork  ,
 226         OPT_outfile     = 1 << OPTBIT_outfile ,
 227         OPT_loglevel    = 1 << OPTBIT_loglevel,
 228         OPT_small       = 1 << OPTBIT_small   ,
 229         OPT_filesize    = IF_FEATURE_ROTATE_LOGFILE((1 << OPTBIT_filesize   )) + 0,
 230         OPT_rotatecnt   = IF_FEATURE_ROTATE_LOGFILE((1 << OPTBIT_rotatecnt  )) + 0,
 231         OPT_remotelog   = IF_FEATURE_REMOTE_LOG(    (1 << OPTBIT_remotelog  )) + 0,
 232         OPT_locallog    = IF_FEATURE_REMOTE_LOG(    (1 << OPTBIT_locallog   )) + 0,
 233         OPT_circularlog = IF_FEATURE_IPC_SYSLOG(    (1 << OPTBIT_circularlog)) + 0,
 234         OPT_dup         = IF_FEATURE_SYSLOGD_DUP(   (1 << OPTBIT_dup        )) + 0,
 235         OPT_cfg         = IF_FEATURE_SYSLOGD_CFG(   (1 << OPTBIT_cfg        )) + 0,
 236         OPT_kmsg        = IF_FEATURE_KMSG_SYSLOG(   (1 << OPTBIT_kmsg       )) + 0,
 237
 238 };
 239 #define OPTION_STR "m:nO:l:S" \
 240         IF_FEATURE_ROTATE_LOGFILE("s:" ) \
 241         IF_FEATURE_ROTATE_LOGFILE("b:" ) \
 242         IF_FEATURE_REMOTE_LOG(    "R:" ) \
 243         IF_FEATURE_REMOTE_LOG(    "L"  ) \
 244         IF_FEATURE_IPC_SYSLOG(    "C::") \
 245         IF_FEATURE_SYSLOGD_DUP(   "D"  ) \
 246         IF_FEATURE_SYSLOGD_CFG(   "f:" ) \
 247         IF_FEATURE_KMSG_SYSLOG(   "K"  )
 248 #define OPTION_DECL *opt_m, *opt_l \
 249         IF_FEATURE_ROTATE_LOGFILE(,*opt_s) \
 250         IF_FEATURE_ROTATE_LOGFILE(,*opt_b) \
 251         IF_FEATURE_IPC_SYSLOG(    ,*opt_C = NULL) \
 252         IF_FEATURE_SYSLOGD_CFG(   ,*opt_f = NULL)
 253 #define OPTION_PARAM &opt_m, &(G.logFile.path), &opt_l \
 254         IF_FEATURE_ROTATE_LOGFILE(,&opt_s) \
 255         IF_FEATURE_ROTATE_LOGFILE(,&opt_b) \
 256         IF_FEATURE_REMOTE_LOG(    ,&remoteAddrList) \
 257         IF_FEATURE_IPC_SYSLOG(    ,&opt_C) \
 258         IF_FEATURE_SYSLOGD_CFG(   ,&opt_f)
 259
 260
 261 #if ENABLE_FEATURE_SYSLOGD_CFG
 262 static const CODE* find_by_name(char *name, const CODE* c_set)
 263 {
 264         for (; c_set->c_name; c_set++) {
 265                 if (strcmp(name, c_set->c_name) == 0)
 266                         return c_set;
 267         }
 268         return NULL;
 269 }
 270 #endif
 271 static const CODE* find_by_val(int val, const CODE* c_set)
 272 {
 273         for (; c_set->c_name; c_set++) {
 274                 if (c_set->c_val == val)
 275                         return c_set;
 276         }
 277         return NULL;
 278 }
 279
 280 #if ENABLE_FEATURE_SYSLOGD_CFG
 281 static void parse_syslogdcfg(const char *file)
 282 {
 283         char *t;
 284         logRule_t **pp_rule;
 285         /* tok[0] set of selectors */
 286         /* tok[1] file name */
 287         /* tok[2] has to be NULL */
 288         char *tok[3];
 289         parser_t *parser;
 290
 291         parser = config_open2(file ? file : "/etc/syslog.conf",
 292                                 file ? xfopen_for_read : fopen_for_read);
 293         if (!parser)
 294                 /* didn't find default /etc/syslog.conf */
 295                 /* proceed as if we built busybox without config support */
 296                 return;
 297
 298         /* use ptr to ptr to avoid checking whether head was initialized */
 299         pp_rule = &G.log_rules;
 300         /* iterate through lines of config, skipping comments */
 301         while (config_read(parser, tok, 3, 2, "# \t", PARSE_NORMAL | PARSE_MIN_DIE)) {
 302                 char *cur_selector;
 303                 logRule_t *cur_rule;
 304
 305                 /* unexpected trailing token? */
 306                 if (tok[2])
 307                         goto cfgerr;
 308
 309                 cur_rule = *pp_rule = xzalloc(sizeof(*cur_rule));
 310
 311                 cur_selector = tok[0];
 312                 /* iterate through selectors: "kern.info;kern.!err;..." */
 313                 do {
 314                         const CODE *code;
 315                         char *next_selector;
 316                         uint8_t negated_prio; /* "kern.!err" */
 317                         uint8_t single_prio;  /* "kern.=err" */
 318                         uint32_t facmap; /* bitmap of enabled facilities */
 319                         uint8_t primap;  /* bitmap of enabled priorities */
 320                         unsigned i;
 321
 322                         next_selector = strchr(cur_selector, ';');
 323                         if (next_selector)
 324                                 *next_selector++ = '\0';
 325
 326                         t = strchr(cur_selector, '.');
 327                         if (!t)
 328                                 goto cfgerr;
 329                         *t++ = '\0'; /* separate facility from priority */
 330
 331                         negated_prio = 0;
 332                         single_prio = 0;
 333                         if (*t == '!') {
 334                                 negated_prio = 1;
 335                                 ++t;
 336                         }
 337                         if (*t == '=') {
 338                                 single_prio = 1;
 339                                 ++t;
 340                         }
 341
 342                         /* parse priority */
 343                         if (*t == '*')
 344                                 primap = 0xff; /* all 8 log levels enabled */
 345                         else {
 346                                 uint8_t priority;
 347                                 code = find_by_name(t, prioritynames);
 348                                 if (!code)
 349                                         goto cfgerr;
 350                                 primap = 0;
 351                                 priority = code->c_val;
 352                                 if (priority == INTERNAL_NOPRI) {
 353                                         /* ensure we take "enabled_facility_priomap[fac] &= 0" branch below */
 354                                         negated_prio = 1;
 355                                 } else {
 356                                         priority = 1 << priority;
 357                                         do {
 358                                                 primap |= priority;
 359                                                 if (single_prio)
 360                                                         break;
 361                                                 priority >>= 1;
 362                                         } while (priority);
 363                                         if (negated_prio)
 364                                                 primap = ~primap;
 365                                 }
 366                         }
 367
 368                         /* parse facility */
 369                         if (*cur_selector == '*')
 370                                 facmap = (1<<LOG_NFACILITIES) - 1;
 371                         else {
 372                                 char *next_facility;
 373                                 facmap = 0;
 374                                 t = cur_selector;
 375                                 /* iterate through facilities: "kern,daemon.<priospec>" */
 376                                 do {
 377                                         next_facility = strchr(t, ',');
 378                                         if (next_facility)
 379                                                 *next_facility++ = '\0';
 380                                         code = find_by_name(t, facilitynames);
 381                                         if (!code)
 382                                                 goto cfgerr;
 383                                         /* "mark" is not a real facility, skip it */
 384                                         if (code->c_val != INTERNAL_MARK)
 385                                                 facmap |= 1<<(LOG_FAC(code->c_val));
 386                                         t = next_facility;
 387                                 } while (t);
 388                         }
 389
 390                         /* merge result with previous selectors */
 391                         for (i = 0; i < LOG_NFACILITIES; ++i) {
 392                                 if (!(facmap & (1<<i)))
 393                                         continue;
 394                                 if (negated_prio)
 395                                         cur_rule->enabled_facility_priomap[i] &= primap;
 396                                 else
 397                                         cur_rule->enabled_facility_priomap[i] |= primap;
 398                         }
 399
 400                         cur_selector = next_selector;
 401                 } while (cur_selector);
 402
 403                 /* check whether current file name was mentioned in previous rules or
 404                  * as global logfile (G.logFile).
 405                  */
 406                 if (strcmp(G.logFile.path, tok[1]) == 0) {
 407                         cur_rule->file = &G.logFile;
 408                         goto found;
 409                 }
 410                 /* temporarily use cur_rule as iterator, but *pp_rule still points
 411                  * to currently processing rule entry.
 412                  * NOTE: *pp_rule points to the current (and last in the list) rule.
 413                  */
 414                 for (cur_rule = G.log_rules; cur_rule != *pp_rule; cur_rule = cur_rule->next) {
 415                         if (strcmp(cur_rule->file->path, tok[1]) == 0) {
 416                                 /* found - reuse the same file structure */
 417                                 (*pp_rule)->file = cur_rule->file;
 418                                 cur_rule = *pp_rule;
 419                                 goto found;
 420                         }
 421                 }
 422                 cur_rule->file = xzalloc(sizeof(*cur_rule->file));
 423                 cur_rule->file->fd = -1;
 424                 cur_rule->file->path = xstrdup(tok[1]);
 425  found:
 426                 pp_rule = &cur_rule->next;
 427         }
 428         config_close(parser);
 429         return;
 430
 431  cfgerr:
 432         bb_error_msg_and_die("error in '%s' at line %d", file, parser->lineno);
 433 }
 434 #endif
 435
 436 /* circular buffer variables/structures */
 437 #if ENABLE_FEATURE_IPC_SYSLOG
 438
 439 #if CONFIG_FEATURE_IPC_SYSLOG_BUFFER_SIZE < 4
 440 #error Sorry, you must set the syslogd buffer size to at least 4KB.
 441 #error Please check CONFIG_FEATURE_IPC_SYSLOG_BUFFER_SIZE
 442 #endif
 443
 444 /* our shared key (syslogd.c and logread.c must be in sync) */
 445 enum { KEY_ID = 0x414e4547 }; /* "GENA" */
 446
 447 static void ipcsyslog_cleanup(void)
 448 {
 449         if (G.shmid != -1) {
 450                 shmdt(G.shbuf);
 451         }
 452         if (G.shmid != -1) {
 453                 shmctl(G.shmid, IPC_RMID, NULL);
 454         }
 455         if (G.s_semid != -1) {
 456                 semctl(G.s_semid, 0, IPC_RMID, 0);
 457         }
 458 }
 459
 460 static void ipcsyslog_init(void)
 461 {
 462         if (DEBUG)
 463                 printf("shmget(%x, %d,...)\n", (int)KEY_ID, G.shm_size);
 464
 465         G.shmid = shmget(KEY_ID, G.shm_size, IPC_CREAT | 0644);
 466         if (G.shmid == -1) {
 467                 bb_perror_msg_and_die("shmget");
 468         }
 469
 470         G.shbuf = shmat(G.shmid, NULL, 0);
 471         if (G.shbuf == (void*) -1L) { /* shmat has bizarre error return */
 472                 bb_perror_msg_and_die("shmat");
 473         }
 474
 475         memset(G.shbuf, 0, G.shm_size);
 476         G.shbuf->size = G.shm_size - offsetof(struct shbuf_ds, data) - 1;
 477         /*G.shbuf->tail = 0;*/
 478
 479         /* we'll trust the OS to set initial semval to 0 (let's hope) */
 480         G.s_semid = semget(KEY_ID, 2, IPC_CREAT | IPC_EXCL | 1023);
 481         if (G.s_semid == -1) {
 482                 if (errno == EEXIST) {
 483                         G.s_semid = semget(KEY_ID, 2, 0);
 484                         if (G.s_semid != -1)
 485                                 return;
 486                 }
 487                 bb_perror_msg_and_die("semget");
 488         }
 489 }
 490
 491 /* Write message to shared mem buffer */
 492 static void log_to_shmem(const char *msg)
 493 {
 494         int old_tail, new_tail;
 495         int len;
 496
 497         if (semop(G.s_semid, G.SMwdn, 3) == -1) {
 498                 bb_perror_msg_and_die("SMwdn");
 499         }
 500
 501         /* Circular Buffer Algorithm:
 502          * --------------------------
 503          * tail == position where to store next syslog message.
 504          * tail's max value is (shbuf->size - 1)
 505          * Last byte of buffer is never used and remains NUL.
 506          */
 507         len = strlen(msg) + 1; /* length with NUL included */
 508  again:
 509         old_tail = G.shbuf->tail;
 510         new_tail = old_tail + len;
 511         if (new_tail < G.shbuf->size) {
 512                 /* store message, set new tail */
 513                 memcpy(G.shbuf->data + old_tail, msg, len);
 514                 G.shbuf->tail = new_tail;
 515         } else {
 516                 /* k == available buffer space ahead of old tail */
 517                 int k = G.shbuf->size - old_tail;
 518                 /* copy what fits to the end of buffer, and repeat */
 519                 memcpy(G.shbuf->data + old_tail, msg, k);
 520                 msg += k;
 521                 len -= k;
 522                 G.shbuf->tail = 0;
 523                 goto again;
 524         }
 525         if (semop(G.s_semid, G.SMwup, 1) == -1) {
 526                 bb_perror_msg_and_die("SMwup");
 527         }
 528         if (DEBUG)
 529                 printf("tail:%d\n", G.shbuf->tail);
 530 }
 531 #else
 532 static void ipcsyslog_cleanup(void) {}
 533 static void ipcsyslog_init(void) {}
 534 void log_to_shmem(const char *msg);
 535 #endif /* FEATURE_IPC_SYSLOG */
 536
 537 #if ENABLE_FEATURE_KMSG_SYSLOG
 538 static void kmsg_init(void)
 539 {
 540         G.kmsgfd = xopen("/dev/kmsg", O_WRONLY);
 541
 542         /*
 543          * kernel < 3.5 expects single char printk KERN_* priority prefix,
 544          * from 3.5 onwards the full syslog facility/priority format is supported
 545          */
 546         if (get_linux_version_code() < KERNEL_VERSION(3,5,0))
 547                 G.primask = LOG_PRIMASK;
 548         else
 549                 G.primask = -1;
 550 }
 551
 552 static void kmsg_cleanup(void)
 553 {
 554         if (ENABLE_FEATURE_CLEAN_UP)
 555                 close(G.kmsgfd);
 556 }
 557
 558 /* Write message to /dev/kmsg */
 559 static void log_to_kmsg(int pri, const char *msg)
 560 {
 561         /*
 562          * kernel < 3.5 expects single char printk KERN_* priority prefix,
 563          * from 3.5 onwards the full syslog facility/priority format is supported
 564          */
 565         pri &= G.primask;
 566
 567         write(G.kmsgfd, G.printbuf, sprintf(G.printbuf, "<%d>%s\n", pri, msg));
 568 }
 569 #else
 570 static void kmsg_init(void) {}
 571 static void kmsg_cleanup(void) {}
 572 static void log_to_kmsg(int pri UNUSED_PARAM, const char *msg UNUSED_PARAM) {}
 573 #endif /* FEATURE_KMSG_SYSLOG */
 574
 575 /* Print a message to the log file. */
 576 static void log_locally(time_t now, char *msg, logFile_t *log_file)
 577 {
 578 #ifdef SYSLOGD_WRLOCK
 579         struct flock fl;
 580 #endif
 581         int len = strlen(msg);
 582
 583         if (log_file->fd >= 0) {
 584                 /* Reopen log file every second. This allows admin
 585                  * to delete the file and not worry about restarting us.
 586                  * This costs almost nothing since it happens
 587                  * _at most_ once a second.
 588                  */
 589                 if (!now)
 590                         now = time(NULL);
 591                 if (G.last_log_time != now) {
 592                         G.last_log_time = now;
 593                         close(log_file->fd);
 594                         goto reopen;
 595                 }
 596         } else {
 597  reopen:
 598                 log_file->fd = open(log_file->path, O_WRONLY | O_CREAT
 599                                         | O_NOCTTY | O_APPEND | O_NONBLOCK,
 600                                         0666);
 601                 if (log_file->fd < 0) {
 602                         /* cannot open logfile? - print to /dev/console then */
 603                         int fd = device_open(DEV_CONSOLE, O_WRONLY | O_NOCTTY | O_NONBLOCK);
 604                         if (fd < 0)
 605                                 fd = 2; /* then stderr, dammit */
 606                         full_write(fd, msg, len);
 607                         if (fd != 2)
 608                                 close(fd);
 609                         return;
 610                 }
 611 #if ENABLE_FEATURE_ROTATE_LOGFILE
 612                 {
 613                         struct stat statf;
 614                         log_file->isRegular = (fstat(log_file->fd, &statf) == 0 && S_ISREG(statf.st_mode));
 615                         /* bug (mostly harmless): can wrap around if file > 4gb */
 616                         log_file->size = statf.st_size;
 617                 }
 618 #endif
 619         }
 620
 621 #ifdef SYSLOGD_WRLOCK
 622         fl.l_whence = SEEK_SET;
 623         fl.l_start = 0;
 624         fl.l_len = 1;
 625         fl.l_type = F_WRLCK;
 626         fcntl(log_file->fd, F_SETLKW, &fl);
 627 #endif
 628
 629 #if ENABLE_FEATURE_ROTATE_LOGFILE
 630         if (G.logFileSize && log_file->isRegular && log_file->size > G.logFileSize) {
 631                 if (G.logFileRotate) { /* always 0..99 */
 632                         int i = strlen(log_file->path) + 3 + 1;
 633                         char oldFile[i];
 634                         char newFile[i];
 635                         i = G.logFileRotate - 1;
 636                         /* rename: f.8 -> f.9; f.7 -> f.8; ... */
 637                         while (1) {
 638                                 sprintf(newFile, "%s.%d", log_file->path, i);
 639                                 if (i == 0) break;
 640                                 sprintf(oldFile, "%s.%d", log_file->path, --i);
 641                                 /* ignore errors - file might be missing */
 642                                 rename(oldFile, newFile);
 643                         }
 644                         /* newFile == "f.0" now */
 645                         rename(log_file->path, newFile);
 646                         /* Incredibly, if F and F.0 are hardlinks, POSIX
 647                          * _demands_ that rename returns 0 but does not
 648                          * remove F!!!
 649                          * (hardlinked F/F.0 pair was observed after
 650                          * power failure during rename()).
 651                          * Ensure old file is gone:
 652                          */
 653                         unlink(log_file->path);
 654 #ifdef SYSLOGD_WRLOCK
 655                         fl.l_type = F_UNLCK;
 656                         fcntl(log_file->fd, F_SETLKW, &fl);
 657 #endif
 658                         close(log_file->fd);
 659                         goto reopen;
 660                 }
 661                 ftruncate(log_file->fd, 0);
 662         }
 663         log_file->size +=
 664 #endif
 665                         full_write(log_file->fd, msg, len);
 666 #ifdef SYSLOGD_WRLOCK
 667         fl.l_type = F_UNLCK;
 668         fcntl(log_file->fd, F_SETLKW, &fl);
 669 #endif
 670 }
 671
 672 static void parse_fac_prio_20(int pri, char *res20)
 673 {
 674         const CODE *c_pri, *c_fac;
 675
 676         c_fac = find_by_val(LOG_FAC(pri) << 3, facilitynames);
 677         if (c_fac) {
 678                 c_pri = find_by_val(LOG_PRI(pri), prioritynames);
 679                 if (c_pri) {
 680                         snprintf(res20, 20, "%s.%s", c_fac->c_name, c_pri->c_name);
 681                         return;
 682                 }
 683         }
 684         snprintf(res20, 20, "<%d>", pri);
 685 }
 686
 687 /* len parameter is used only for "is there a timestamp?" check.
 688  * NB: some callers cheat and supply len==0 when they know
 689  * that there is no timestamp, short-circuiting the test. */
 690 static void timestamp_and_log(int pri, char *msg, int len)
 691 {
 692         char *timestamp;
 693         time_t now;
 694
 695         /* Jan 18 00:11:22 msg... */
 696         /* 01234567890123456 */
 697         if (len < 16 || msg[3] != ' ' || msg[6] != ' '
 698          || msg[9] != ':' || msg[12] != ':' || msg[15] != ' '
 699         ) {
 700                 time(&now);
 701                 timestamp = ctime(&now) + 4; /* skip day of week */
 702         } else {
 703                 now = 0;
 704                 timestamp = msg;
 705                 msg += 16;
 706         }
 707         timestamp[15] = '\0';
 708
 709         if (option_mask32 & OPT_kmsg) {
 710                 log_to_kmsg(pri, msg);
 711                 return;
 712         }
 713
 714         if (option_mask32 & OPT_small)
 715                 sprintf(G.printbuf, "%s %s\n", timestamp, msg);
 716         else {
 717                 char res[20];
 718                 parse_fac_prio_20(pri, res);
 719                 sprintf(G.printbuf, "%s %.64s %s %s\n", timestamp, G.hostname, res, msg);
 720         }
 721
 722         /* Log message locally (to file or shared mem) */
 723 #if ENABLE_FEATURE_SYSLOGD_CFG
 724         {
 725                 bool match = 0;
 726                 logRule_t *rule;
 727                 uint8_t facility = LOG_FAC(pri);
 728                 uint8_t prio_bit = 1 << LOG_PRI(pri);
 729
 730                 for (rule = G.log_rules; rule; rule = rule->next) {
 731                         if (rule->enabled_facility_priomap[facility] & prio_bit) {
 732                                 log_locally(now, G.printbuf, rule->file);
 733                                 match = 1;
 734                         }
 735                 }
 736                 if (match)
 737                         return;
 738         }
 739 #endif
 740         if (LOG_PRI(pri) < G.logLevel) {
 741 #if ENABLE_FEATURE_IPC_SYSLOG
 742                 if ((option_mask32 & OPT_circularlog) && G.shbuf) {
 743                         log_to_shmem(G.printbuf);
 744                         return;
 745                 }
 746 #endif
 747                 log_locally(now, G.printbuf, &G.logFile);
 748         }
 749 }
 750
 751 static void timestamp_and_log_internal(const char *msg)
 752 {
 753         /* -L, or no -R */
 754         if (ENABLE_FEATURE_REMOTE_LOG && !(option_mask32 & OPT_locallog))
 755                 return;
 756         timestamp_and_log(LOG_SYSLOG | LOG_INFO, (char*)msg, 0);
 757 }
 758
 759 /* tmpbuf[len] is a NUL byte (set by caller), but there can be other,
 760  * embedded NULs. Split messages on each of these NULs, parse prio,
 761  * escape control chars and log each locally. */
 762 static void split_escape_and_log(char *tmpbuf, int len)
 763 {
 764         char *p = tmpbuf;
 765
 766         tmpbuf += len;
 767         while (p < tmpbuf) {
 768                 char c;
 769                 char *q = G.parsebuf;
 770                 int pri = (LOG_USER | LOG_NOTICE);
 771
 772                 if (*p == '<') {
 773                         /* Parse the magic priority number */
 774                         pri = bb_strtou(p + 1, &p, 10);
 775                         if (*p == '>')
 776                                 p++;
 777                         if (pri & ~(LOG_FACMASK | LOG_PRIMASK))
 778                                 pri = (LOG_USER | LOG_NOTICE);
 779                 }
 780
 781                 while ((c = *p++)) {
 782                         if (c == '\n')
 783                                 c = ' ';
 784                         if (!(c & ~0x1f) && c != '\t') {
 785                                 *q++ = '^';
 786                                 c += '@'; /* ^@, ^A, ^B... */
 787                         }
 788                         *q++ = c;
 789                 }
 790                 *q = '\0';
 791
 792                 /* Now log it */
 793                 timestamp_and_log(pri, G.parsebuf, q - G.parsebuf);
 794         }
 795 }
 796
 797 #ifdef SYSLOGD_MARK
 798 static void do_mark(int sig)
 799 {
 800         if (G.markInterval) {
 801                 timestamp_and_log_internal("-- MARK --");
 802                 alarm(G.markInterval);
 803         }
 804 }
 805 #endif
 806
 807 /* Don't inline: prevent struct sockaddr_un to take up space on stack
 808  * permanently */
 809 static NOINLINE int create_socket(void)
 810 {
 811         struct sockaddr_un sunx;
 812         int sock_fd;
 813         char *dev_log_name;
 814
 815 #if ENABLE_FEATURE_SYSTEMD
 816         if (sd_listen_fds() == 1)
 817                 return SD_LISTEN_FDS_START;
 818 #endif
 819
 820         memset(&sunx, 0, sizeof(sunx));
 821         sunx.sun_family = AF_UNIX;
 822
 823         /* Unlink old /dev/log or object it points to. */
 824         /* (if it exists, bind will fail) */
 825         strcpy(sunx.sun_path, "/dev/log");
 826         dev_log_name = xmalloc_follow_symlinks("/dev/log");
 827         if (dev_log_name) {
 828                 safe_strncpy(sunx.sun_path, dev_log_name, sizeof(sunx.sun_path));
 829                 free(dev_log_name);
 830         }
 831         unlink(sunx.sun_path);
 832
 833         sock_fd = xsocket(AF_UNIX, SOCK_DGRAM, 0);
 834         xbind(sock_fd, (struct sockaddr *) &sunx, sizeof(sunx));
 835         chmod("/dev/log", 0666);
 836
 837         return sock_fd;
 838 }
 839
 840 #if ENABLE_FEATURE_REMOTE_LOG
 841 static int try_to_resolve_remote(remoteHost_t *rh)
 842 {
 843         if (!rh->remoteAddr) {
 844                 unsigned now = monotonic_sec();
 845
 846                 /* Don't resolve name too often - DNS timeouts can be big */
 847                 if ((now - rh->last_dns_resolve) < DNS_WAIT_SEC)
 848                         return -1;
 849                 rh->last_dns_resolve = now;
 850                 rh->remoteAddr = host2sockaddr(rh->remoteHostname, 514);
 851                 if (!rh->remoteAddr)
 852                         return -1;
 853         }
 854         return xsocket(rh->remoteAddr->u.sa.sa_family, SOCK_DGRAM, 0);
 855 }
 856 #endif
 857
 858 static void do_syslogd(void) NORETURN;
 859 static void do_syslogd(void)
 860 {
 861         int sock_fd;
 862 #if ENABLE_FEATURE_REMOTE_LOG
 863         llist_t *item;
 864 #endif
 865 #if ENABLE_FEATURE_SYSLOGD_DUP
 866         int last_sz = -1;
 867         char *last_buf;
 868         char *recvbuf = G.recvbuf;
 869 #else
 870 #define recvbuf (G.recvbuf)
 871 #endif
 872
 873         /* Set up signal handlers (so that they interrupt read()) */
 874         signal_no_SA_RESTART_empty_mask(SIGTERM, record_signo);
 875         signal_no_SA_RESTART_empty_mask(SIGINT, record_signo);
 876         //signal_no_SA_RESTART_empty_mask(SIGQUIT, record_signo);
 877         signal(SIGHUP, SIG_IGN);
 878 #ifdef SYSLOGD_MARK
 879         signal(SIGALRM, do_mark);
 880         alarm(G.markInterval);
 881 #endif
 882         sock_fd = create_socket();
 883
 884         if (option_mask32 & OPT_circularlog)
 885                 ipcsyslog_init();
 886
 887         if (option_mask32 & OPT_kmsg)
 888                 kmsg_init();
 889
 890         timestamp_and_log_internal("syslogd started: BusyBox v" BB_VER);
 891
 892         while (!bb_got_signal) {
 893                 ssize_t sz;
 894
 895 #if ENABLE_FEATURE_SYSLOGD_DUP
 896                 last_buf = recvbuf;
 897                 if (recvbuf == G.recvbuf)
 898                         recvbuf = G.recvbuf + MAX_READ;
 899                 else
 900                         recvbuf = G.recvbuf;
 901 #endif
 902  read_again:
 903                 sz = read(sock_fd, recvbuf, MAX_READ - 1);
 904                 if (sz < 0) {
 905                         if (!bb_got_signal)
 906                                 bb_perror_msg("read from /dev/log");
 907                         break;
 908                 }
 909
 910                 /* Drop trailing '\n' and NULs (typically there is one NUL) */
 911                 while (1) {
 912                         if (sz == 0)
 913                                 goto read_again;
 914                         /* man 3 syslog says: "A trailing newline is added when needed".
 915                          * However, neither glibc nor uclibc do this:
 916                          * syslog(prio, "test")   sends "test\0" to /dev/log,
 917                          * syslog(prio, "test\n") sends "test\n\0".
 918                          * IOW: newline is passed verbatim!
 919                          * I take it to mean that it's syslogd's job
 920                          * to make those look identical in the log files. */
 921                         if (recvbuf[sz-1] != '\0' && recvbuf[sz-1] != '\n')
 922                                 break;
 923                         sz--;
 924                 }
 925 #if ENABLE_FEATURE_SYSLOGD_DUP
 926                 if ((option_mask32 & OPT_dup) && (sz == last_sz))
 927                         if (memcmp(last_buf, recvbuf, sz) == 0)
 928                                 continue;
 929                 last_sz = sz;
 930 #endif
 931 #if ENABLE_FEATURE_REMOTE_LOG
 932                 /* Stock syslogd sends it '\n'-terminated
 933                  * over network, mimic that */
 934                 recvbuf[sz] = '\n';
 935
 936                 /* We are not modifying log messages in any way before send */
 937                 /* Remote site cannot trust _us_ anyway and need to do validation again */
 938                 for (item = G.remoteHosts; item != NULL; item = item->link) {
 939                         remoteHost_t *rh = (remoteHost_t *)item->data;
 940
 941                         if (rh->remoteFD == -1) {
 942                                 rh->remoteFD = try_to_resolve_remote(rh);
 943                                 if (rh->remoteFD == -1)
 944                                         continue;
 945                         }
 946
 947                         /* Send message to remote logger.
 948                          * On some errors, close and set remoteFD to -1
 949                          * so that DNS resolution is retried.
 950                          */
 951                         if (sendto(rh->remoteFD, recvbuf, sz+1,
 952                                         MSG_DONTWAIT | MSG_NOSIGNAL,
 953                                         &(rh->remoteAddr->u.sa), rh->remoteAddr->len) == -1
 954                         ) {
 955                                 switch (errno) {
 956                                 case ECONNRESET:
 957                                 case ENOTCONN: /* paranoia */
 958                                 case EPIPE:
 959                                         close(rh->remoteFD);
 960                                         rh->remoteFD = -1;
 961                                         free(rh->remoteAddr);
 962                                         rh->remoteAddr = NULL;
 963                                 }
 964                         }
 965                 }
 966 #endif
 967                 if (!ENABLE_FEATURE_REMOTE_LOG || (option_mask32 & OPT_locallog)) {
 968                         recvbuf[sz] = '\0'; /* ensure it *is* NUL terminated */
 969                         split_escape_and_log(recvbuf, sz);
 970                 }
 971         } /* while (!bb_got_signal) */
 972
 973         timestamp_and_log_internal("syslogd exiting");
 974         puts("syslogd exiting");
 975         remove_pidfile(CONFIG_PID_FILE_PATH "/syslogd.pid");
 976         ipcsyslog_cleanup();
 977         if (option_mask32 & OPT_kmsg)
 978                 kmsg_cleanup();
 979         kill_myself_with_sig(bb_got_signal);
 980 #undef recvbuf
 981 }
 982
 983 int syslogd_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 984 int syslogd_main(int argc UNUSED_PARAM, char **argv)
 985 {
 986         int opts;
 987         char OPTION_DECL;
 988 #if ENABLE_FEATURE_REMOTE_LOG
 989         llist_t *remoteAddrList = NULL;
 990 #endif
 991
 992         INIT_G();
 993
 994         /* No non-option params, -R can occur multiple times */
 995         opt_complementary = "=0" IF_FEATURE_REMOTE_LOG(":R::");
 996         opts = getopt32(argv, OPTION_STR, OPTION_PARAM);
 997 #if ENABLE_FEATURE_REMOTE_LOG
 998         while (remoteAddrList) {
 999                 remoteHost_t *rh = xzalloc(sizeof(*rh));
1000                 rh->remoteHostname = llist_pop(&remoteAddrList);
1001                 rh->remoteFD = -1;
1002                 rh->last_dns_resolve = monotonic_sec() - DNS_WAIT_SEC - 1;
1003                 llist_add_to(&G.remoteHosts, rh);
1004         }
1005 #endif
1006
1007 #ifdef SYSLOGD_MARK
1008         if (opts & OPT_mark) // -m
1009                 G.markInterval = xatou_range(opt_m, 0, INT_MAX/60) * 60;
1010 #endif
1011         //if (opts & OPT_nofork) // -n
1012         //if (opts & OPT_outfile) // -O
1013         if (opts & OPT_loglevel) // -l
1014                 G.logLevel = xatou_range(opt_l, 1, 8);
1015         //if (opts & OPT_small) // -S
1016 #if ENABLE_FEATURE_ROTATE_LOGFILE
1017         if (opts & OPT_filesize) // -s
1018                 G.logFileSize = xatou_range(opt_s, 0, INT_MAX/1024) * 1024;
1019         if (opts & OPT_rotatecnt) // -b
1020                 G.logFileRotate = xatou_range(opt_b, 0, 99);
1021 #endif
1022 #if ENABLE_FEATURE_IPC_SYSLOG
1023         if (opt_C) // -Cn
1024                 G.shm_size = xatoul_range(opt_C, 4, INT_MAX/1024) * 1024;
1025 #endif
1026         /* If they have not specified remote logging, then log locally */
1027         if (ENABLE_FEATURE_REMOTE_LOG && !(opts & OPT_remotelog)) // -R
1028                 option_mask32 |= OPT_locallog;
1029 #if ENABLE_FEATURE_SYSLOGD_CFG
1030         parse_syslogdcfg(opt_f);
1031 #endif
1032
1033         /* Store away localhost's name before the fork */
1034         G.hostname = safe_gethostname();
1035         *strchrnul(G.hostname, '.') = '\0';
1036
1037         if (!(opts & OPT_nofork)) {
1038                 bb_daemonize_or_rexec(DAEMON_CHDIR_ROOT, argv);
1039         }
1040
1041         //umask(0); - why??
1042         write_pidfile(CONFIG_PID_FILE_PATH "/syslogd.pid");
1043
1044         do_syslogd();
1045         /* return EXIT_SUCCESS; */
1046 }
1047
1048 /* Clean up. Needed because we are included from syslogd_and_logger.c */
1049 #undef DEBUG
1050 #undef SYSLOGD_MARK
1051 #undef SYSLOGD_WRLOCK
1052 #undef G
1053 #undef GLOBALS
1054 #undef INIT_G
1055 #undef OPTION_STR
1056 #undef OPTION_DECL
1057 #undef OPTION_PARAM