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.
   6  * Written by Erik Andersen <andersen@lineo.com>, <andersee@debian.org>
   7  *
   8  * Copyright (C) 2000 by Karl M. Hegbloom <karlheg@debian.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  18  * General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  23  *
  24  */
  25
  26 #include "internal.h"
  27 #include <stdio.h>
  28 #include <stdlib.h>
  29 #include <ctype.h>
  30 #include <errno.h>
  31 #include <fcntl.h>
  32 #include <netdb.h>
  33 #include <paths.h>
  34 #include <signal.h>
  35 #include <stdarg.h>
  36 #include <time.h>
  37 #include <unistd.h>
  38 #include <sys/socket.h>
  39 #include <sys/types.h>
  40 #include <sys/un.h>
  41 #include <sys/param.h>
  42
  43 #if ! defined __GLIBC__ && ! defined __UCLIBC__
  44
  45 typedef unsigned int socklen_t;
  46
  47 #ifndef __alpha__
  48 # define __NR_klogctl __NR_syslog
  49 static inline _syscall3(int, klogctl, int, type, char *, b, int, len);
  50 #else                                                   /* __alpha__ */
  51 #define klogctl syslog
  52 #endif
  53
  54 #else
  55 # include <sys/klog.h>
  56 #endif
  57
  58
  59
  60 /* SYSLOG_NAMES defined to pull some extra junk from syslog.h */
  61 #define SYSLOG_NAMES
  62 #include <sys/syslog.h>
  63 #include <sys/uio.h>
  64
  65 /* Path for the file where all log messages are written */
  66 #define __LOG_FILE "/var/log/messages"
  67
  68 /* Path to the unix socket */
  69 char lfile[BUFSIZ] = "";
  70
  71 static char *logFilePath = __LOG_FILE;
  72
  73 /* interval between marks in seconds */
  74 static int MarkInterval = 20 * 60;
  75
  76 /* localhost's name */
  77 static char LocalHostName[32];
  78
  79 #ifdef BB_FEATURE_REMOTE_LOG
  80 #include <netinet/in.h>
  81 /* udp socket for logging to remote host */
  82 static int  remotefd = -1;
  83 /* where do we log? */
  84 static char *RemoteHost;
  85 /* what port to log to? */
  86 static int  RemotePort = 514;
  87 /* To remote log or not to remote log, that is the question. */
  88 static int  doRemoteLog = FALSE;
  89 #endif
  90
  91 /* Note: There is also a function called "message()" in init.c */
  92 /* Print a message to the log file. */
  93 static void message (char *fmt, ...) __attribute__ ((format (printf, 1, 2)));
  94 static void message (char *fmt, ...)
  95 {
  96         int fd;
  97         struct flock fl;
  98         va_list arguments;
  99
 100         fl.l_whence = SEEK_SET;
 101         fl.l_start  = 0;
 102         fl.l_len    = 1;
 103
 104         if ((fd = device_open (logFilePath,
 105                                                    O_WRONLY | O_CREAT | O_NOCTTY | O_APPEND |
 106                                                    O_NONBLOCK)) >= 0) {
 107                 fl.l_type = F_WRLCK;
 108                 fcntl (fd, F_SETLKW, &fl);
 109                 va_start (arguments, fmt);
 110                 vdprintf (fd, fmt, arguments);
 111                 va_end (arguments);
 112                 fl.l_type = F_UNLCK;
 113                 fcntl (fd, F_SETLKW, &fl);
 114                 close (fd);
 115         } else {
 116                 /* Always send console messages to /dev/console so people will see them. */
 117                 if ((fd = device_open (_PATH_CONSOLE,
 118                                                            O_WRONLY | O_NOCTTY | O_NONBLOCK)) >= 0) {
 119                         va_start (arguments, fmt);
 120                         vdprintf (fd, fmt, arguments);
 121                         va_end (arguments);
 122                         close (fd);
 123                 } else {
 124                         fprintf (stderr, "Bummer, can't print: ");
 125                         va_start (arguments, fmt);
 126                         vfprintf (stderr, fmt, arguments);
 127                         fflush (stderr);
 128                         va_end (arguments);
 129                 }
 130         }
 131 }
 132
 133 static void logMessage (int pri, char *msg)
 134 {
 135         time_t now;
 136         char *timestamp;
 137         static char res[20] = "";
 138         CODE *c_pri, *c_fac;
 139
 140         if (pri != 0) {
 141                 for (c_fac = facilitynames;
 142                          c_fac->c_name && !(c_fac->c_val == LOG_FAC(pri) << 3); c_fac++);
 143                 for (c_pri = prioritynames;
 144                          c_pri->c_name && !(c_pri->c_val == LOG_PRI(pri)); c_pri++);
 145                 if (*c_fac->c_name == '\0' || *c_pri->c_name == '\0')
 146                         snprintf(res, sizeof(res), "<%d>", pri);
 147                 else
 148                         snprintf(res, sizeof(res), "%s.%s", c_fac->c_name, c_pri->c_name);
 149         }
 150
 151         if (strlen(msg) < 16 || msg[3] != ' ' || msg[6] != ' ' ||
 152                 msg[9] != ':' || msg[12] != ':' || msg[15] != ' ') {
 153                 time(&now);
 154                 timestamp = ctime(&now) + 4;
 155                 timestamp[15] = '\0';
 156         } else {
 157                 timestamp = msg;
 158                 timestamp[15] = '\0';
 159                 msg += 16;
 160         }
 161
 162         /* todo: supress duplicates */
 163
 164         /* now spew out the message to wherever it is supposed to go */
 165         message("%s %s %s %s\n", timestamp, LocalHostName, res, msg);
 166
 167 #ifdef BB_FEATURE_REMOTE_LOG
 168         /* send message to remote logger */
 169         if ( -1 != remotefd){
 170 #define IOV_COUNT 2
 171           struct iovec iov[IOV_COUNT];
 172           struct iovec *v = iov;
 173
 174           bzero(&res, sizeof(res));
 175           snprintf(res, sizeof(res), "<%d>", pri);
 176           v->iov_base = res ;
 177           v->iov_len = strlen(res);
 178           v++;
 179
 180           v->iov_base = msg;
 181           v->iov_len = strlen(msg);
 182
 183           if ( -1 == writev(remotefd,iov, IOV_COUNT)){
 184             fatalError("syslogd: cannot write to remote file handle on"
 185                        "%s:%d\n",RemoteHost,RemotePort);
 186           }
 187         }
 188 #endif
 189
 190 }
 191
 192 static void quit_signal(int sig)
 193 {
 194         logMessage(0, "System log daemon exiting.");
 195         unlink(lfile);
 196         exit(TRUE);
 197 }
 198
 199 static void domark(int sig)
 200 {
 201         if (MarkInterval > 0) {
 202                 logMessage(LOG_SYSLOG | LOG_INFO, "-- MARK --");
 203                 alarm(MarkInterval);
 204         }
 205 }
 206
 207 #define BUFSIZE 1023
 208 static int serveConnection (int conn)
 209 {
 210         char   buf[ BUFSIZE + 1 ];
 211         int    n_read;
 212
 213         while ((n_read = read (conn, buf, BUFSIZE )) > 0) {
 214
 215                 int           pri = (LOG_USER | LOG_NOTICE);
 216                 char          line[ BUFSIZE + 1 ];
 217                 unsigned char c;
 218
 219                 char *p = buf, *q = line;
 220
 221                 buf[ n_read - 1 ] = '\0';
 222
 223                 while (p && (c = *p) && q < &line[ sizeof (line) - 1 ]) {
 224                         if (c == '<') {
 225                         /* Parse the magic priority number. */
 226                                 pri = 0;
 227                                 while (isdigit (*(++p))) {
 228                                         pri = 10 * pri + (*p - '0');
 229                                 }
 230                                 if (pri & ~(LOG_FACMASK | LOG_PRIMASK)){
 231                                         pri = (LOG_USER | LOG_NOTICE);
 232                                 }
 233                         } else if (c == '\n') {
 234                                 *q++ = ' ';
 235                         } else if (iscntrl (c) && (c < 0177)) {
 236                                 *q++ = '^';
 237                                 *q++ = c ^ 0100;
 238                         } else {
 239                                 *q++ = c;
 240                         }
 241                         p++;
 242                 }
 243                 *q = '\0';
 244                 /* Now log it */
 245                 logMessage (pri, line);
 246         }
 247         return (0);
 248 }
 249
 250
 251 #ifdef BB_FEATURE_REMOTE_LOG
 252 static void init_RemoteLog (void){
 253
 254   struct sockaddr_in remoteaddr;
 255   struct hostent *hostinfo;
 256   int len = sizeof(remoteaddr);
 257
 258   bzero(&remoteaddr, len);
 259
 260   remotefd = socket(AF_INET, SOCK_DGRAM, 0);
 261
 262   if (remotefd < 0) {
 263     fatalError("syslogd: cannot create socket\n");
 264   }
 265
 266   hostinfo = (struct hostent *) gethostbyname(RemoteHost);
 267
 268   if (!hostinfo) {
 269     fatalError("syslogd: cannot resolve remote host name [%s]\n", RemoteHost);
 270   }
 271
 272   remoteaddr.sin_family = AF_INET;
 273   remoteaddr.sin_addr = *(struct in_addr *) *hostinfo->h_addr_list;
 274   remoteaddr.sin_port = htons(RemotePort);
 275
 276   /*
 277      Since we are using UDP sockets, connect just sets the default host and port
 278      for future operations
 279   */
 280   if ( 0 != (connect(remotefd, (struct sockaddr *) &remoteaddr, len))){
 281     fatalError("syslogd: cannot connect to remote host %s:%d\n", RemoteHost, RemotePort);
 282   }
 283
 284 }
 285 #endif
 286
 287 static void doSyslogd (void) __attribute__ ((noreturn));
 288 static void doSyslogd (void)
 289 {
 290         struct sockaddr_un sunx;
 291         socklen_t addrLength;
 292
 293
 294         int sock_fd;
 295         fd_set fds;
 296
 297         char lfile[BUFSIZ];
 298
 299         /* Set up signal handlers. */
 300         signal (SIGINT,  quit_signal);
 301         signal (SIGTERM, quit_signal);
 302         signal (SIGQUIT, quit_signal);
 303         signal (SIGHUP,  SIG_IGN);
 304         signal (SIGCLD,  SIG_IGN);
 305         signal (SIGALRM, domark);
 306         alarm (MarkInterval);
 307
 308         /* Create the syslog file so realpath() can work. */
 309         close (open (_PATH_LOG, O_RDWR | O_CREAT, 0644));
 310         if (realpath (_PATH_LOG, lfile) == NULL)
 311                 fatalError ("Could not resolv path to " _PATH_LOG ": %s\n", strerror (errno));
 312
 313         unlink (lfile);
 314
 315         memset (&sunx, 0, sizeof (sunx));
 316         sunx.sun_family = AF_UNIX;
 317         strncpy (sunx.sun_path, lfile, sizeof (sunx.sun_path));
 318         if ((sock_fd = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
 319                 fatalError ("Couldn't obtain descriptor for socket " _PATH_LOG ": %s\n", strerror (errno));
 320
 321         addrLength = sizeof (sunx.sun_family) + strlen (sunx.sun_path);
 322         if ((bind (sock_fd, (struct sockaddr *) &sunx, addrLength)) || (listen (sock_fd, 5)))
 323                 fatalError ("Could not connect to socket " _PATH_LOG ": %s\n", strerror (errno));
 324
 325         if (chmod (lfile, 0666) < 0)
 326                 fatalError ("Could not set permission on " _PATH_LOG ": %s\n", strerror (errno));
 327
 328         FD_ZERO (&fds);
 329         FD_SET (sock_fd, &fds);
 330
 331         #ifdef BB_FEATURE_REMOTE_LOG
 332         if (doRemoteLog == TRUE){
 333           init_RemoteLog();
 334         }
 335         #endif
 336
 337         logMessage (0, "syslogd started: BusyBox v" BB_VER " (" BB_BT ")");
 338
 339         for (;;) {
 340
 341                 fd_set readfds;
 342                 int    n_ready;
 343                 int    fd;
 344
 345                 memcpy (&readfds, &fds, sizeof (fds));
 346
 347                 if ((n_ready = select (FD_SETSIZE, &readfds, NULL, NULL, NULL)) < 0) {
 348                         if (errno == EINTR) continue; /* alarm may have happened. */
 349                         fatalError ("select error: %s\n", strerror (errno));
 350                 }
 351
 352                 for (fd = 0; (n_ready > 0) && (fd < FD_SETSIZE); fd++) {
 353                         if (FD_ISSET (fd, &readfds)) {
 354
 355                                 --n_ready;
 356
 357                                 if (fd == sock_fd) {
 358
 359                                         int   conn;
 360                                         pid_t pid;
 361
 362                                         if ((conn = accept (sock_fd, (struct sockaddr *) &sunx, &addrLength)) < 0) {
 363                                                 fatalError ("accept error: %s\n", strerror (errno));
 364                                         }
 365
 366                                         pid = fork();
 367
 368                                         if (pid < 0) {
 369                                                 perror ("syslogd: fork");
 370                                                 close (conn);
 371                                                 continue;
 372                                         }
 373
 374                                         if (pid == 0) {
 375                                                 serveConnection (conn);
 376                                                 close (conn);
 377                                                 exit( TRUE);
 378                                         }
 379                                         close (conn);
 380                                 }
 381                         }
 382                 }
 383         }
 384 }
 385
 386 #ifdef BB_FEATURE_KLOGD
 387
 388 static void klogd_signal(int sig)
 389 {
 390         klogctl(7, NULL, 0);
 391         klogctl(0, 0, 0);
 392         logMessage(0, "Kernel log daemon exiting.");
 393         exit(TRUE);
 394 }
 395
 396 static void doKlogd (void) __attribute__ ((noreturn));
 397 static void doKlogd (void)
 398 {
 399         int priority = LOG_INFO;
 400         char log_buffer[4096];
 401         char *logp;
 402
 403         /* Set up sig handlers */
 404         signal(SIGINT, klogd_signal);
 405         signal(SIGKILL, klogd_signal);
 406         signal(SIGTERM, klogd_signal);
 407         signal(SIGHUP, SIG_IGN);
 408
 409 #ifdef BB_FEATURE_REMOTE_LOG
 410         if (doRemoteLog == TRUE){
 411           init_RemoteLog();
 412         }
 413 #endif
 414
 415         logMessage(0, "klogd started: "
 416                            "BusyBox v" BB_VER " (" BB_BT ")");
 417
 418         klogctl(1, NULL, 0);
 419
 420         while (1) {
 421                 /* Use kernel syscalls */
 422                 memset(log_buffer, '\0', sizeof(log_buffer));
 423                 if (klogctl(2, log_buffer, sizeof(log_buffer)) < 0) {
 424                         char message[80];
 425
 426                         if (errno == EINTR)
 427                                 continue;
 428                         snprintf(message, 79, "klogd: Error return from sys_sycall: " \
 429                                          "%d - %s.\n", errno, strerror(errno));
 430                         logMessage(LOG_SYSLOG | LOG_ERR, message);
 431                         exit(1);
 432                 }
 433                 logp = log_buffer;
 434                 if (*log_buffer == '<') {
 435                         switch (*(log_buffer + 1)) {
 436                         case '0':
 437                                 priority = LOG_EMERG;
 438                                 break;
 439                         case '1':
 440                                 priority = LOG_ALERT;
 441                                 break;
 442                         case '2':
 443                                 priority = LOG_CRIT;
 444                                 break;
 445                         case '3':
 446                                 priority = LOG_ERR;
 447                                 break;
 448                         case '4':
 449                                 priority = LOG_WARNING;
 450                                 break;
 451                         case '5':
 452                                 priority = LOG_NOTICE;
 453                                 break;
 454                         case '6':
 455                                 priority = LOG_INFO;
 456                                 break;
 457                         case '7':
 458                         default:
 459                                 priority = LOG_DEBUG;
 460                         }
 461                         logp += 3;
 462                 }
 463                 logMessage(LOG_KERN | priority, logp);
 464         }
 465
 466 }
 467
 468 #endif
 469
 470 static void daemon_init (char **argv, char *dz, void fn (void))
 471 {
 472         setsid();
 473         chdir ("/");
 474         strncpy(argv[0], dz, strlen(argv[0]));
 475         fn();
 476         exit(0);
 477 }
 478
 479 extern int syslogd_main(int argc, char **argv)
 480 {
 481         int pid, klogd_pid;
 482         int doFork = TRUE;
 483
 484 #ifdef BB_FEATURE_KLOGD
 485         int startKlogd = TRUE;
 486 #endif
 487         int stopDoingThat = FALSE;
 488         char *p;
 489         char **argv1 = argv;
 490
 491         while (--argc > 0 && **(++argv1) == '-') {
 492                 stopDoingThat = FALSE;
 493                 while (stopDoingThat == FALSE && *(++(*argv1))) {
 494                         switch (**argv1) {
 495                         case 'm':
 496                                 if (--argc == 0) {
 497                                         usage(syslogd_usage);
 498                                 }
 499                                 MarkInterval = atoi(*(++argv1)) * 60;
 500                                 break;
 501                         case 'n':
 502                                 doFork = FALSE;
 503                                 break;
 504 #ifdef BB_FEATURE_KLOGD
 505                         case 'K':
 506                                 startKlogd = FALSE;
 507                                 break;
 508 #endif
 509                         case 'O':
 510                                 if (--argc == 0) {
 511                                         usage(syslogd_usage);
 512                                 }
 513                                 logFilePath = *(++argv1);
 514                                 stopDoingThat = TRUE;
 515                                 break;
 516 #ifdef BB_FEATURE_REMOTE_LOG
 517                         case 'R':
 518                           if (--argc == 0) {
 519                             usage(syslogd_usage);
 520                           }
 521                           RemoteHost = *(++argv1);
 522                           if ( (p = strchr(RemoteHost, ':'))){
 523                             RemotePort = atoi(p+1);
 524                             *p = '\0';
 525                           }
 526                           doRemoteLog = TRUE;
 527                           stopDoingThat = TRUE;
 528                           break;
 529 #endif
 530                         default:
 531                                 usage(syslogd_usage);
 532                         }
 533                 }
 534         }
 535
 536         if (argc > 0)
 537                 usage(syslogd_usage);
 538
 539         /* Store away localhost's name before the fork */
 540         gethostname(LocalHostName, sizeof(LocalHostName));
 541         if ((p = strchr(LocalHostName, '.'))) {
 542                 *p++ = '\0';
 543         }
 544
 545         umask(0);
 546
 547 #ifdef BB_FEATURE_KLOGD
 548         /* Start up the klogd process */
 549         if (startKlogd == TRUE) {
 550                 klogd_pid = fork();
 551                 if (klogd_pid == 0) {
 552                         daemon_init (argv, "klogd", doKlogd);
 553                 }
 554         }
 555 #endif
 556
 557         if (doFork == TRUE) {
 558                 pid = fork();
 559                 if (pid < 0)
 560                         exit(pid);
 561                 else if (pid == 0) {
 562                         daemon_init (argv, "syslogd", doSyslogd);
 563                 }
 564         } else {
 565                 doSyslogd();
 566         }
 567
 568         return(TRUE);
 569 }
 570
 571 /*
 572 Local Variables
 573 c-file-style: "linux"
 574 c-basic-offset: 4
 575 tab-width: 4
 576 End:
 577 */