sysklogd/klogd.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Mini klogd implementation for busybox
   4  *
   5  * Copyright (C) 2001 by Gennady Feldman <gfeldman@gena01.com>.
   6  * Changes: Made this a standalone busybox module which uses standalone
   7  * syslog() client interface.
   8  *
   9  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
  10  *
  11  * Copyright (C) 2000 by Karl M. Hegbloom <karlheg@debian.org>
  12  *
  13  * "circular buffer" Copyright (C) 2000 by Gennady Feldman <gfeldman@gena01.com>
  14  *
  15  * Maintainer: Gennady Feldman <gfeldman@gena01.com> as of Mar 12, 2001
  16  *
  17  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  18  */
  19
  20 //usage:#define klogd_trivial_usage
  21 //usage:       "[-c N] [-n]"
  22 //usage:#define klogd_full_usage "\n\n"
  23 //usage:       "Kernel logger\n"
  24 //usage:     "\nOptions:"
  25 //usage:     "\n        -c N    Only messages with level < N are printed to console"
  26 //usage:     "\n        -n      Run in foreground"
  27
  28 #include "libbb.h"
  29 #include <syslog.h>
  30
  31
  32 /* The Linux-specific klogctl(3) interface does not rely on the filesystem and
  33  * allows us to change the console loglevel. Alternatively, we read the
  34  * messages from _PATH_KLOG. */
  35
  36 #if ENABLE_FEATURE_KLOGD_KLOGCTL
  37
  38 # include <sys/klog.h>
  39
  40 static void klogd_open(void)
  41 {
  42         /* "Open the log. Currently a NOP" */
  43         klogctl(1, NULL, 0);
  44 }
  45
  46 static void klogd_setloglevel(int lvl)
  47 {
  48         /* "printk() prints a message on the console only if it has a loglevel
  49          * less than console_loglevel". Here we set console_loglevel = lvl. */
  50         klogctl(8, NULL, lvl);
  51 }
  52
  53 static int klogd_read(char *bufp, int len)
  54 {
  55         return klogctl(2, bufp, len);
  56 }
  57 # define READ_ERROR "klogctl(2) error"
  58
  59 static void klogd_close(void)
  60 {
  61         /* FYI: cmd 7 is equivalent to setting console_loglevel to 7
  62          * via klogctl(8, NULL, 7). */
  63         klogctl(7, NULL, 0); /* "7 -- Enable printk's to console" */
  64         klogctl(0, NULL, 0); /* "0 -- Close the log. Currently a NOP" */
  65 }
  66
  67 #else
  68
  69 # include <paths.h>
  70 # ifndef _PATH_KLOG
  71 #  ifdef __GNU__
  72 #   define _PATH_KLOG "/dev/klog"
  73 #  else
  74 #   error "your system's _PATH_KLOG is unknown"
  75 #  endif
  76 # endif
  77 # define PATH_PRINTK "/proc/sys/kernel/printk"
  78
  79 enum { klogfd = 3 };
  80
  81 static void klogd_open(void)
  82 {
  83         int fd = xopen(_PATH_KLOG, O_RDONLY);
  84         xmove_fd(fd, klogfd);
  85 }
  86
  87 static void klogd_setloglevel(int lvl)
  88 {
  89         FILE *fp = fopen_or_warn(PATH_PRINTK, "w");
  90         if (fp) {
  91                 /* This changes only first value:
  92                  * "messages with a higher priority than this
  93                  * [that is, with numerically lower value]
  94                  * will be printed to the console".
  95                  * The other three values in this pseudo-file aren't changed.
  96                  */
  97                 fprintf(fp, "%u\n", lvl);
  98                 fclose(fp);
  99         }
 100 }
 101
 102 static int klogd_read(char *bufp, int len)
 103 {
 104         return read(klogfd, bufp, len);
 105 }
 106 # define READ_ERROR "read error"
 107
 108 static void klogd_close(void)
 109 {
 110         klogd_setloglevel(7);
 111         if (ENABLE_FEATURE_CLEAN_UP)
 112                 close(klogfd);
 113 }
 114
 115 #endif
 116
 117 #define log_buffer bb_common_bufsiz1
 118 enum {
 119         KLOGD_LOGBUF_SIZE = sizeof(log_buffer),
 120         OPT_LEVEL      = (1 << 0),
 121         OPT_FOREGROUND = (1 << 1),
 122 };
 123
 124 /* TODO: glibc openlog(LOG_KERN) reverts to LOG_USER instead,
 125  * because that's how they interpret word "default"
 126  * in the openlog() manpage:
 127  *      LOG_USER (default)
 128  *              generic user-level messages
 129  * and the fact that LOG_KERN is a constant 0.
 130  * glibc interprets it as "0 in openlog() call means 'use default'".
 131  * I think it means "if openlog wasn't called before syslog() is called,
 132  * use default".
 133  * Convincing glibc maintainers otherwise is, as usual, nearly impossible.
 134  * Should we open-code syslog() here to use correct facility?
 135  */
 136
 137 int klogd_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 138 int klogd_main(int argc UNUSED_PARAM, char **argv)
 139 {
 140         int i = 0;
 141         char *opt_c;
 142         int opt;
 143         int used;
 144
 145         opt = getopt32(argv, "c:n", &opt_c);
 146         if (opt & OPT_LEVEL) {
 147                 /* Valid levels are between 1 and 8 */
 148                 i = xatou_range(opt_c, 1, 8);
 149         }
 150         if (!(opt & OPT_FOREGROUND)) {
 151                 bb_daemonize_or_rexec(DAEMON_CHDIR_ROOT, argv);
 152         }
 153
 154         logmode = LOGMODE_SYSLOG;
 155
 156         /* klogd_open() before openlog(), since it might use fixed fd 3,
 157          * and openlog() also may use the same fd 3 if we swap them:
 158          */
 159         klogd_open();
 160         openlog("kernel", 0, LOG_KERN);
 161         /*
 162          * glibc problem: for some reason, glibc changes LOG_KERN to LOG_USER
 163          * above. The logic behind this is that standard
 164          * http://pubs.opengroup.org/onlinepubs/9699919799/functions/syslog.html
 165          * says the following about openlog and syslog:
 166          * "LOG_USER
 167          *  Messages generated by arbitrary processes.
 168          *  This is the default facility identifier if none is specified."
 169          *
 170          * I believe glibc misinterpreted this text as "if openlog's
 171          * third parameter is 0 (=LOG_KERN), treat it as LOG_USER".
 172          * Whereas it was meant to say "if *syslog* is called with facility
 173          * 0 in its 1st parameter without prior call to openlog, then perform
 174          * implicit openlog(LOG_USER)".
 175          *
 176          * As a result of this, eh, feature, standard klogd was forced
 177          * to open-code its own openlog and syslog implementation (!).
 178          *
 179          * Note that prohibiting openlog(LOG_KERN) on libc level does not
 180          * add any security: any process can open a socket to "/dev/log"
 181          * and write a string "<0>Voila, a LOG_KERN + LOG_EMERG message"
 182          *
 183          * Google code search tells me there is no widespread use of
 184          * openlog("foo", 0, 0), thus fixing glibc won't break userspace.
 185          *
 186          * The bug against glibc was filed:
 187          * bugzilla.redhat.com/show_bug.cgi?id=547000
 188          */
 189
 190         if (i)
 191                 klogd_setloglevel(i);
 192
 193         signal(SIGHUP, SIG_IGN);
 194         /* We want klogd_read to not be restarted, thus _norestart: */
 195         bb_signals_recursive_norestart(BB_FATAL_SIGS, record_signo);
 196
 197         syslog(LOG_NOTICE, "klogd started: %s", bb_banner);
 198
 199         used = 0;
 200         while (!bb_got_signal) {
 201                 int n;
 202                 int priority;
 203                 char *start;
 204
 205                 /* "2 -- Read from the log." */
 206                 start = log_buffer + used;
 207                 n = klogd_read(start, KLOGD_LOGBUF_SIZE-1 - used);
 208                 if (n < 0) {
 209                         if (errno == EINTR)
 210                                 continue;
 211                         bb_perror_msg(READ_ERROR);
 212                         break;
 213                 }
 214                 start[n] = '\0';
 215
 216                 /* Process each newline-terminated line in the buffer */
 217                 start = log_buffer;
 218                 while (1) {
 219                         char *newline = strchrnul(start, '\n');
 220
 221                         if (*newline == '\0') {
 222                                 /* This line is incomplete */
 223
 224                                 /* move it to the front of the buffer */
 225                                 overlapping_strcpy(log_buffer, start);
 226                                 used = newline - start;
 227                                 if (used < KLOGD_LOGBUF_SIZE-1) {
 228                                         /* buffer isn't full */
 229                                         break;
 230                                 }
 231                                 /* buffer is full, log it anyway */
 232                                 used = 0;
 233                                 newline = NULL;
 234                         } else {
 235                                 *newline++ = '\0';
 236                         }
 237
 238                         /* Extract the priority */
 239                         priority = LOG_INFO;
 240                         if (*start == '<') {
 241                                 start++;
 242                                 if (*start) {
 243                                         /* kernel never generates multi-digit prios */
 244                                         priority = (*start - '0');
 245                                         start++;
 246                                 }
 247                                 if (*start == '>')
 248                                         start++;
 249                         }
 250                         /* Log (only non-empty lines) */
 251                         if (*start)
 252                                 syslog(priority, "%s", start);
 253
 254                         if (!newline)
 255                                 break;
 256                         start = newline;
 257                 }
 258         }
 259
 260         klogd_close();
 261         syslog(LOG_NOTICE, "klogd: exiting");
 262         if (bb_got_signal)
 263                 kill_myself_with_sig(bb_got_signal);
 264         return EXIT_FAILURE;
 265 }