sysklogd/syslogd.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Mini syslogd implementation for busybox
   4  *
   5  * Copyright (C) 1999,2000 by Lineo, inc. and Erik Andersen
   6  * Copyright (C) 1999,2000,2001 by Erik Andersen <andersee@debian.org>
   7  *
   8  * Copyright (C) 2000 by Karl M. Hegbloom <karlheg@debian.org>
   9  *
  10  * "circular buffer" Copyright (C) 2001 by Gennady Feldman <gfeldman@gena01.com>
  11  *
  12  * Maintainer: Gennady Feldman <gfeldman@gena01.com> as of Mar 12, 2001
  13  *
  14  * This program is free software; you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation; either version 2 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  22  * General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program; if not, write to the Free Software
  26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  27  *
  28  */
  29
  30 #include <stdio.h>
  31 #include <stdlib.h>
  32 #include <ctype.h>
  33 #include <errno.h>
  34 #include <fcntl.h>
  35 #include <netdb.h>
  36 #include <paths.h>
  37 #include <signal.h>
  38 #include <stdarg.h>
  39 #include <time.h>
  40 #include <string.h>
  41 #include <unistd.h>
  42 #include <sys/socket.h>
  43 #include <sys/types.h>
  44 #include <sys/un.h>
  45 #include <sys/param.h>
  46
  47 #include "busybox.h"
  48
  49 /* SYSLOG_NAMES defined to pull some extra junk from syslog.h */
  50 #define SYSLOG_NAMES
  51 #include <sys/syslog.h>
  52 #include <sys/uio.h>
  53
  54 /* Path for the file where all log messages are written */
  55 #define __LOG_FILE "/var/log/messages"
  56
  57 /* Path to the unix socket */
  58 static char lfile[MAXPATHLEN];
  59
  60 static char *logFilePath = __LOG_FILE;
  61
  62 /* interval between marks in seconds */
  63 static int MarkInterval = 20 * 60;
  64
  65 /* localhost's name */
  66 static char LocalHostName[64];
  67
  68 #ifdef CONFIG_FEATURE_REMOTE_LOG
  69 #include <netinet/in.h>
  70 /* udp socket for logging to remote host */
  71 static int remotefd = -1;
  72
  73 /* where do we log? */
  74 static char *RemoteHost;
  75
  76 /* what port to log to? */
  77 static int RemotePort = 514;
  78
  79 /* To remote log or not to remote log, that is the question. */
  80 static int doRemoteLog = FALSE;
  81 static int local_logging = FALSE;
  82 #endif
  83
  84
  85 #define MAXLINE         1024    /* maximum line length */
  86
  87
  88 /* circular buffer variables/structures */
  89 #ifdef CONFIG_FEATURE_IPC_SYSLOG
  90 #if __GNU_LIBRARY__ < 5
  91 #error Sorry.  Looks like you are using libc5.
  92 #error libc5 shm support isnt good enough.
  93 #error Please disable CONFIG_FEATURE_IPC_SYSLOG
  94 #endif
  95
  96 #include <sys/ipc.h>
  97 #include <sys/sem.h>
  98 #include <sys/shm.h>
  99
 100 /* our shared key */
 101 static const long KEY_ID = 0x414e4547;  /*"GENA" */
 102
 103 // Semaphore operation structures
 104 static struct shbuf_ds {
 105         int size;                       // size of data written
 106         int head;                       // start of message list
 107         int tail;                       // end of message list
 108         char data[1];           // data/messages
 109 } *buf = NULL;                  // shared memory pointer
 110
 111 static struct sembuf SMwup[1] = { {1, -1, IPC_NOWAIT} };        // set SMwup
 112 static struct sembuf SMwdn[3] = { {0, 0}, {1, 0}, {1, +1} };    // set SMwdn
 113
 114 static int shmid = -1;  // ipc shared memory id
 115 static int s_semid = -1;        // ipc semaphore id
 116 int data_size = 16000;  // data size
 117 int shm_size = 16000 + sizeof(*buf);    // our buffer size
 118 static int circular_logging = FALSE;
 119
 120 /*
 121  * sem_up - up()'s a semaphore.
 122  */
 123 static inline void sem_up(int semid)
 124 {
 125         if (semop(semid, SMwup, 1) == -1) {
 126                 perror_msg_and_die("semop[SMwup]");
 127         }
 128 }
 129
 130 /*
 131  * sem_down - down()'s a semaphore
 132  */
 133 static inline void sem_down(int semid)
 134 {
 135         if (semop(semid, SMwdn, 3) == -1) {
 136                 perror_msg_and_die("semop[SMwdn]");
 137         }
 138 }
 139
 140
 141 void ipcsyslog_cleanup(void)
 142 {
 143         printf("Exiting Syslogd!\n");
 144         if (shmid != -1) {
 145                 shmdt(buf);
 146         }
 147
 148         if (shmid != -1) {
 149                 shmctl(shmid, IPC_RMID, NULL);
 150         }
 151         if (s_semid != -1) {
 152                 semctl(s_semid, 0, IPC_RMID, 0);
 153         }
 154 }
 155
 156 void ipcsyslog_init(void)
 157 {
 158         if (buf == NULL) {
 159                 if ((shmid = shmget(KEY_ID, shm_size, IPC_CREAT | 1023)) == -1) {
 160                         perror_msg_and_die("shmget");
 161                 }
 162
 163                 if ((buf = shmat(shmid, NULL, 0)) == NULL) {
 164                         perror_msg_and_die("shmat");
 165                 }
 166
 167                 buf->size = data_size;
 168                 buf->head = buf->tail = 0;
 169
 170                 // we'll trust the OS to set initial semval to 0 (let's hope)
 171                 if ((s_semid = semget(KEY_ID, 2, IPC_CREAT | IPC_EXCL | 1023)) == -1) {
 172                         if (errno == EEXIST) {
 173                                 if ((s_semid = semget(KEY_ID, 2, 0)) == -1) {
 174                                         perror_msg_and_die("semget");
 175                                 }
 176                         } else {
 177                                 perror_msg_and_die("semget");
 178                         }
 179                 }
 180         } else {
 181                 printf("Buffer already allocated just grab the semaphore?");
 182         }
 183 }
 184
 185 /* write message to buffer */
 186 void circ_message(const char *msg)
 187 {
 188         int l = strlen(msg) + 1;        /* count the whole message w/ '\0' included */
 189
 190         sem_down(s_semid);
 191
 192         /*
 193          * Circular Buffer Algorithm:
 194          * --------------------------
 195          *
 196          * Start-off w/ empty buffer of specific size SHM_SIZ
 197          * Start filling it up w/ messages. I use '\0' as separator to break up messages.
 198          * This is also very handy since we can do printf on message.
 199          *
 200          * Once the buffer is full we need to get rid of the first message in buffer and
 201          * insert the new message. (Note: if the message being added is >1 message then
 202          * we will need to "remove" >1 old message from the buffer). The way this is done
 203          * is the following:
 204          *      When we reach the end of the buffer we set a mark and start from the beginning.
 205          *      Now what about the beginning and end of the buffer? Well we have the "head"
 206          *      index/pointer which is the starting point for the messages and we have "tail"
 207          *      index/pointer which is the ending point for the messages. When we "display" the
 208          *      messages we start from the beginning and continue until we reach "tail". If we
 209          *      reach end of buffer, then we just start from the beginning (offset 0). "head" and
 210          *      "tail" are actually offsets from the beginning of the buffer.
 211          *
 212          * Note: This algorithm uses Linux IPC mechanism w/ shared memory and semaphores to provide
 213          *       a threasafe way of handling shared memory operations.
 214          */
 215         if ((buf->tail + l) < buf->size) {
 216                 /* before we append the message we need to check the HEAD so that we won't
 217                    overwrite any of the message that we still need and adjust HEAD to point
 218                    to the next message! */
 219                 if (buf->tail < buf->head) {
 220                         if ((buf->tail + l) >= buf->head) {
 221                                 /* we need to move the HEAD to point to the next message
 222                                  * Theoretically we have enough room to add the whole message to the
 223                                  * buffer, because of the first outer IF statement, so we don't have
 224                                  * to worry about overflows here!
 225                                  */
 226                                 int k = buf->tail + l - buf->head;      /* we need to know how many bytes
 227                                                                                                            we are overwriting to make
 228                                                                                                            enough room */
 229                                 char *c =
 230                                         memchr(buf->data + buf->head + k, '\0',
 231                                                    buf->size - (buf->head + k));
 232                                 if (c != NULL) {        /* do a sanity check just in case! */
 233                                         buf->head = c - buf->data + 1;  /* we need to convert pointer to
 234                                                                                                            offset + skip the '\0' since
 235                                                                                                            we need to point to the beginning
 236                                                                                                            of the next message */
 237                                         /* Note: HEAD is only used to "retrieve" messages, it's not used
 238                                            when writing messages into our buffer */
 239                                 } else {        /* show an error message to know we messed up? */
 240                                         printf("Weird! Can't find the terminator token??? \n");
 241                                         buf->head = 0;
 242                                 }
 243                         }
 244                 }
 245
 246                 /* in other cases no overflows have been done yet, so we don't care! */
 247                 /* we should be ok to append the message now */
 248                 strncpy(buf->data + buf->tail, msg, l); /* append our message */
 249                 buf->tail += l; /* count full message w/ '\0' terminating char */
 250         } else {
 251                 /* we need to break up the message and "circle" it around */
 252                 char *c;
 253                 int k = buf->tail + l - buf->size;      /* count # of bytes we don't fit */
 254
 255                 /* We need to move HEAD! This is always the case since we are going
 256                  * to "circle" the message.
 257                  */
 258                 c = memchr(buf->data + k, '\0', buf->size - k);
 259
 260                 if (c != NULL) {        /* if we don't have '\0'??? weird!!! */
 261                         /* move head pointer */
 262                         buf->head = c - buf->data + 1;
 263
 264                         /* now write the first part of the message */
 265                         strncpy(buf->data + buf->tail, msg, l - k - 1);
 266
 267                         /* ALWAYS terminate end of buffer w/ '\0' */
 268                         buf->data[buf->size - 1] = '\0';
 269
 270                         /* now write out the rest of the string to the beginning of the buffer */
 271                         strcpy(buf->data, &msg[l - k - 1]);
 272
 273                         /* we need to place the TAIL at the end of the message */
 274                         buf->tail = k + 1;
 275                 } else {
 276                         printf
 277                                 ("Weird! Can't find the terminator token from the beginning??? \n");
 278                         buf->head = buf->tail = 0;      /* reset buffer, since it's probably corrupted */
 279                 }
 280
 281         }
 282         sem_up(s_semid);
 283 }
 284 #endif                                                  /* CONFIG_FEATURE_IPC_SYSLOG */
 285
 286 /* Note: There is also a function called "message()" in init.c */
 287 /* Print a message to the log file. */
 288 static void message(char *fmt, ...) __attribute__ ((format(printf, 1, 2)));
 289 static void message(char *fmt, ...)
 290 {
 291         int fd;
 292         struct flock fl;
 293         va_list arguments;
 294
 295         fl.l_whence = SEEK_SET;
 296         fl.l_start = 0;
 297         fl.l_len = 1;
 298
 299 #ifdef CONFIG_FEATURE_IPC_SYSLOG
 300         if ((circular_logging == TRUE) && (buf != NULL)) {
 301                 char b[1024];
 302
 303                 va_start(arguments, fmt);
 304                 vsnprintf(b, sizeof(b) - 1, fmt, arguments);
 305                 va_end(arguments);
 306                 circ_message(b);
 307
 308         } else
 309 #endif
 310         if ((fd =
 311                          device_open(logFilePath,
 312                                                          O_WRONLY | O_CREAT | O_NOCTTY | O_APPEND |
 313                                                          O_NONBLOCK)) >= 0) {
 314                 fl.l_type = F_WRLCK;
 315                 fcntl(fd, F_SETLKW, &fl);
 316                 va_start(arguments, fmt);
 317                 vdprintf(fd, fmt, arguments);
 318                 va_end(arguments);
 319                 fl.l_type = F_UNLCK;
 320                 fcntl(fd, F_SETLKW, &fl);
 321                 close(fd);
 322         } else {
 323                 /* Always send console messages to /dev/console so people will see them. */
 324                 if ((fd =
 325                          device_open(_PATH_CONSOLE,
 326                                                  O_WRONLY | O_NOCTTY | O_NONBLOCK)) >= 0) {
 327                         va_start(arguments, fmt);
 328                         vdprintf(fd, fmt, arguments);
 329                         va_end(arguments);
 330                         close(fd);
 331                 } else {
 332                         fprintf(stderr, "Bummer, can't print: ");
 333                         va_start(arguments, fmt);
 334                         vfprintf(stderr, fmt, arguments);
 335                         fflush(stderr);
 336                         va_end(arguments);
 337                 }
 338         }
 339 }
 340
 341 static void logMessage(int pri, char *msg)
 342 {
 343         time_t now;
 344         char *timestamp;
 345         static char res[20] = "";
 346         CODE *c_pri, *c_fac;
 347
 348         if (pri != 0) {
 349                 for (c_fac = facilitynames;
 350                          c_fac->c_name && !(c_fac->c_val == LOG_FAC(pri) << 3); c_fac++);
 351                 for (c_pri = prioritynames;
 352                          c_pri->c_name && !(c_pri->c_val == LOG_PRI(pri)); c_pri++);
 353                 if (c_fac->c_name == NULL || c_pri->c_name == NULL) {
 354                         snprintf(res, sizeof(res), "<%d>", pri);
 355                 } else {
 356                         snprintf(res, sizeof(res), "%s.%s", c_fac->c_name, c_pri->c_name);
 357                 }
 358         }
 359
 360         if (strlen(msg) < 16 || msg[3] != ' ' || msg[6] != ' ' ||
 361                 msg[9] != ':' || msg[12] != ':' || msg[15] != ' ') {
 362                 time(&now);
 363                 timestamp = ctime(&now) + 4;
 364                 timestamp[15] = '\0';
 365         } else {
 366                 timestamp = msg;
 367                 timestamp[15] = '\0';
 368                 msg += 16;
 369         }
 370
 371         /* todo: supress duplicates */
 372
 373 #ifdef CONFIG_FEATURE_REMOTE_LOG
 374         /* send message to remote logger */
 375         if (-1 != remotefd) {
 376                 static const int IOV_COUNT = 2;
 377                 struct iovec iov[IOV_COUNT];
 378                 struct iovec *v = iov;
 379
 380                 memset(&res, 0, sizeof(res));
 381                 snprintf(res, sizeof(res), "<%d>", pri);
 382                 v->iov_base = res;
 383                 v->iov_len = strlen(res);
 384                 v++;
 385
 386                 v->iov_base = msg;
 387                 v->iov_len = strlen(msg);
 388           writev_retry:
 389                 if ((-1 == writev(remotefd, iov, IOV_COUNT)) && (errno == EINTR)) {
 390                         goto writev_retry;
 391                 }
 392         }
 393         if (local_logging == TRUE)
 394 #endif
 395                 /* now spew out the message to wherever it is supposed to go */
 396                 message("%s %s %s %s\n", timestamp, LocalHostName, res, msg);
 397 }
 398
 399 static void quit_signal(int sig)
 400 {
 401         logMessage(LOG_SYSLOG | LOG_INFO, "System log daemon exiting.");
 402         unlink(lfile);
 403 #ifdef CONFIG_FEATURE_IPC_SYSLOG
 404         ipcsyslog_cleanup();
 405 #endif
 406
 407         exit(TRUE);
 408 }
 409
 410 static void domark(int sig)
 411 {
 412         if (MarkInterval > 0) {
 413                 logMessage(LOG_SYSLOG | LOG_INFO, "-- MARK --");
 414                 alarm(MarkInterval);
 415         }
 416 }
 417
 418 /* This must be a #define, since when DODEBUG and BUFFERS_GO_IN_BSS are
 419  * enabled, we otherwise get a "storage size isn't constant error. */
 420 static int serveConnection(char *tmpbuf, int n_read)
 421 {
 422         char *p = tmpbuf;
 423
 424         while (p < tmpbuf + n_read) {
 425
 426                 int pri = (LOG_USER | LOG_NOTICE);
 427                 char line[MAXLINE + 1];
 428                 unsigned char c;
 429
 430                 char *q = line;
 431
 432                 while ((c = *p) && q < &line[sizeof(line) - 1]) {
 433                         if (c == '<') {
 434                                 /* Parse the magic priority number. */
 435                                 pri = 0;
 436                                 while (isdigit(*(++p))) {
 437                                         pri = 10 * pri + (*p - '0');
 438                                 }
 439                                 if (pri & ~(LOG_FACMASK | LOG_PRIMASK)) {
 440                                         pri = (LOG_USER | LOG_NOTICE);
 441                                 }
 442                         } else if (c == '\n') {
 443                                 *q++ = ' ';
 444                         } else if (iscntrl(c) && (c < 0177)) {
 445                                 *q++ = '^';
 446                                 *q++ = c ^ 0100;
 447                         } else {
 448                                 *q++ = c;
 449                         }
 450                         p++;
 451                 }
 452                 *q = '\0';
 453                 p++;
 454                 /* Now log it */
 455                 logMessage(pri, line);
 456         }
 457         return n_read;
 458 }
 459
 460
 461 #ifdef CONFIG_FEATURE_REMOTE_LOG
 462 static void init_RemoteLog(void)
 463 {
 464
 465         struct sockaddr_in remoteaddr;
 466         struct hostent *hostinfo;
 467         int len = sizeof(remoteaddr);
 468
 469         memset(&remoteaddr, 0, len);
 470
 471         remotefd = socket(AF_INET, SOCK_DGRAM, 0);
 472
 473         if (remotefd < 0) {
 474                 error_msg_and_die("cannot create socket");
 475         }
 476
 477         hostinfo = xgethostbyname(RemoteHost);
 478
 479         remoteaddr.sin_family = AF_INET;
 480         remoteaddr.sin_addr = *(struct in_addr *) *hostinfo->h_addr_list;
 481         remoteaddr.sin_port = htons(RemotePort);
 482
 483         /* Since we are using UDP sockets, connect just sets the default host and port
 484          * for future operations
 485          */
 486         if (0 != (connect(remotefd, (struct sockaddr *) &remoteaddr, len))) {
 487                 error_msg_and_die("cannot connect to remote host %s:%d", RemoteHost,
 488                                                   RemotePort);
 489         }
 490
 491 }
 492 #endif
 493
 494 static void doSyslogd(void) __attribute__ ((noreturn));
 495 static void doSyslogd(void)
 496 {
 497         struct sockaddr_un sunx;
 498         socklen_t addrLength;
 499
 500         int sock_fd;
 501         fd_set fds;
 502
 503         /* Set up signal handlers. */
 504         signal(SIGINT, quit_signal);
 505         signal(SIGTERM, quit_signal);
 506         signal(SIGQUIT, quit_signal);
 507         signal(SIGHUP, SIG_IGN);
 508         signal(SIGCHLD, SIG_IGN);
 509 #ifdef SIGCLD
 510         signal(SIGCLD, SIG_IGN);
 511 #endif
 512         signal(SIGALRM, domark);
 513         alarm(MarkInterval);
 514
 515         /* Create the syslog file so realpath() can work. */
 516         if (realpath(_PATH_LOG, lfile) != NULL) {
 517                 unlink(lfile);
 518         }
 519
 520         memset(&sunx, 0, sizeof(sunx));
 521         sunx.sun_family = AF_UNIX;
 522         strncpy(sunx.sun_path, lfile, sizeof(sunx.sun_path));
 523         if ((sock_fd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0) {
 524                 perror_msg_and_die("Couldn't get file descriptor for socket "
 525                                                    _PATH_LOG);
 526         }
 527
 528         addrLength = sizeof(sunx.sun_family) + strlen(sunx.sun_path);
 529         if (bind(sock_fd, (struct sockaddr *) &sunx, addrLength) < 0) {
 530                 perror_msg_and_die("Could not connect to socket " _PATH_LOG);
 531         }
 532
 533         if (chmod(lfile, 0666) < 0) {
 534                 perror_msg_and_die("Could not set permission on " _PATH_LOG);
 535         }
 536 #ifdef CONFIG_FEATURE_IPC_SYSLOG
 537         if (circular_logging == TRUE) {
 538                 ipcsyslog_init();
 539         }
 540 #endif
 541
 542 #ifdef CONFIG_FEATURE_REMOTE_LOG
 543         if (doRemoteLog == TRUE) {
 544                 init_RemoteLog();
 545         }
 546 #endif
 547
 548         logMessage(LOG_SYSLOG | LOG_INFO, "syslogd started: " BB_BANNER);
 549
 550         for (;;) {
 551
 552                 FD_ZERO(&fds);
 553                 FD_SET(sock_fd, &fds);
 554
 555                 if (select(sock_fd + 1, &fds, NULL, NULL, NULL) < 0) {
 556                         if (errno == EINTR) {
 557                                 /* alarm may have happened. */
 558                                 continue;
 559                         }
 560                         perror_msg_and_die("select error");
 561                 }
 562
 563                 if (FD_ISSET(sock_fd, &fds)) {
 564                         int i;
 565
 566                         RESERVE_CONFIG_BUFFER(tmpbuf, BUFSIZ + 1);
 567
 568                         memset(tmpbuf, '\0', BUFSIZ + 1);
 569                         if ((i = recv(sock_fd, tmpbuf, BUFSIZ, 0)) > 0) {
 570                                 serveConnection(tmpbuf, i);
 571                         } else {
 572                                 perror_msg_and_die("UNIX socket error");
 573                         }
 574                         RELEASE_CONFIG_BUFFER(tmpbuf);
 575                 }                               /* FD_ISSET() */
 576         }                                       /* for main loop */
 577 }
 578
 579 extern int syslogd_main(int argc, char **argv)
 580 {
 581         int opt;
 582
 583 #if ! defined(__uClinux__)
 584         int doFork = TRUE;
 585 #endif
 586
 587         char *p;
 588
 589         /* do normal option parsing */
 590         while ((opt = getopt(argc, argv, "m:nO:R:LC")) > 0) {
 591                 switch (opt) {
 592                 case 'm':
 593                         MarkInterval = atoi(optarg) * 60;
 594                         break;
 595 #if ! defined(__uClinux__)
 596                 case 'n':
 597                         doFork = FALSE;
 598                         break;
 599 #endif
 600                 case 'O':
 601                         logFilePath = xstrdup(optarg);
 602                         break;
 603 #ifdef CONFIG_FEATURE_REMOTE_LOG
 604                 case 'R':
 605                         RemoteHost = xstrdup(optarg);
 606                         if ((p = strchr(RemoteHost, ':'))) {
 607                                 RemotePort = atoi(p + 1);
 608                                 *p = '\0';
 609                         }
 610                         doRemoteLog = TRUE;
 611                         break;
 612                 case 'L':
 613                         local_logging = TRUE;
 614                         break;
 615 #endif
 616 #ifdef CONFIG_FEATURE_IPC_SYSLOG
 617                 case 'C':
 618                         circular_logging = TRUE;
 619                         break;
 620 #endif
 621                 default:
 622                         show_usage();
 623                 }
 624         }
 625
 626 #ifdef CONFIG_FEATURE_REMOTE_LOG
 627         /* If they have not specified remote logging, then log locally */
 628         if (doRemoteLog == FALSE)
 629                 local_logging = TRUE;
 630 #endif
 631
 632
 633         /* Store away localhost's name before the fork */
 634         gethostname(LocalHostName, sizeof(LocalHostName));
 635         if ((p = strchr(LocalHostName, '.'))) {
 636                 *p++ = '\0';
 637         }
 638
 639         umask(0);
 640
 641 #if ! defined(__uClinux__)
 642         if ((doFork == TRUE) && (daemon(0, 1) < 0)) {
 643                 perror_msg_and_die("daemon");
 644         }
 645 #endif
 646         doSyslogd();
 647
 648         return EXIT_SUCCESS;
 649 }
 650
 651 /*
 652 Local Variables
 653 c-file-style: "linux"
 654 c-basic-offset: 4
 655 tab-width: 4
 656 End:
 657 */