X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=sysklogd%2Fklogd.c;h=432ded1530be3054bf1f3ee9130d025a803833ee;hb=d60752f8c9be5689a249ad518deb38061d4bc45e;hp=f2ab5ea7e7a89bcce694f64d1ef542e734a71f89;hpb=06c35da6af117f8c27ed16afe3915fbbc6c64de8;p=oweals%2Fbusybox.git diff --git a/sysklogd/klogd.c b/sysklogd/klogd.c index f2ab5ea7e..432ded153 100644 --- a/sysklogd/klogd.c +++ b/sysklogd/klogd.c @@ -2,158 +2,263 @@ /* * Mini klogd implementation for busybox * - * Copyright (C) 2001 by Gennady Feldman . + * Copyright (C) 2001 by Gennady Feldman . * Changes: Made this a standalone busybox module which uses standalone - * syslog() client interface. + * syslog() client interface. * - * Copyright (C) 1999,2000 by Lineo, inc. and Erik Andersen - * Copyright (C) 1999,2000,2001 by Erik Andersen + * Copyright (C) 1999-2004 by Erik Andersen * * Copyright (C) 2000 by Karl M. Hegbloom * - * "circular buffer" Copyright (C) 2000 by Gennady Feldman + * "circular buffer" Copyright (C) 2000 by Gennady Feldman * - * Maintainer: Gennady Feldman as of Mar 12, 2001 - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * Maintainer: Gennady Feldman as of Mar 12, 2001 * + * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ -#include -#include -#include /* for our signal() handlers */ -#include /* strncpy() */ -#include /* errno and friends */ -#include -#include -#include - -#if __GNU_LIBRARY__ < 5 -# ifdef __alpha__ -# define klogctl syslog -# endif -#else +//usage:#define klogd_trivial_usage +//usage: "[-c N] [-n]" +//usage:#define klogd_full_usage "\n\n" +//usage: "Kernel logger\n" +//usage: "\n -c N Print to console messages more urgent than prio N (1-8)" +//usage: "\n -n Run in foreground" + +#include "libbb.h" +#include + + +/* The Linux-specific klogctl(3) interface does not rely on the filesystem and + * allows us to change the console loglevel. Alternatively, we read the + * messages from _PATH_KLOG. */ + +#if ENABLE_FEATURE_KLOGD_KLOGCTL + # include -#endif -#include "busybox.h" +static void klogd_open(void) +{ + /* "Open the log. Currently a NOP" */ + klogctl(1, NULL, 0); +} -static void klogd_signal(int sig) +static void klogd_setloglevel(int lvl) { - klogctl(7, NULL, 0); - klogctl(0, 0, 0); - /* logMessage(0, "Kernel log daemon exiting."); */ - syslog_msg(LOG_SYSLOG, LOG_NOTICE, "Kernel log daemon exiting."); - exit(TRUE); + /* "printk() prints a message on the console only if it has a loglevel + * less than console_loglevel". Here we set console_loglevel = lvl. */ + klogctl(8, NULL, lvl); } -static void doKlogd(void) __attribute__ ((noreturn)); -static void doKlogd(void) +static int klogd_read(char *bufp, int len) { - int priority = LOG_INFO; - char log_buffer[4096]; - int i, n, lastc; - char *start; - - /* Set up sig handlers */ - signal(SIGINT, klogd_signal); - signal(SIGKILL, klogd_signal); - signal(SIGTERM, klogd_signal); - signal(SIGHUP, SIG_IGN); + return klogctl(2, bufp, len); +} +# define READ_ERROR "klogctl(2) error" - /* "Open the log. Currently a NOP." */ - klogctl(1, NULL, 0); +static void klogd_close(void) +{ + /* FYI: cmd 7 is equivalent to setting console_loglevel to 7 + * via klogctl(8, NULL, 7). */ + klogctl(7, NULL, 0); /* "7 -- Enable printk's to console" */ + klogctl(0, NULL, 0); /* "0 -- Close the log. Currently a NOP" */ +} - syslog_msg(LOG_SYSLOG, LOG_NOTICE, "klogd started: " BB_BANNER); +#else - while (1) { - /* Use kernel syscalls */ - memset(log_buffer, '\0', sizeof(log_buffer)); - n = klogctl(2, log_buffer, sizeof(log_buffer)); - if (n < 0) { - char message[80]; +# include +# ifndef _PATH_KLOG +# ifdef __GNU__ +# define _PATH_KLOG "/dev/klog" +# else +# error "your system's _PATH_KLOG is unknown" +# endif +# endif +# define PATH_PRINTK "/proc/sys/kernel/printk" - if (errno == EINTR) - continue; - snprintf(message, 79, - "klogd: Error return from sys_sycall: %d - %s.\n", errno, - strerror(errno)); - syslog_msg(LOG_SYSLOG, LOG_ERR, message); - exit(1); - } +enum { klogfd = 3 }; - /* klogctl buffer parsing modelled after code in dmesg.c */ - start = &log_buffer[0]; - lastc = '\0'; - for (i = 0; i < n; i++) { - if (lastc == '\0' && log_buffer[i] == '<') { - priority = 0; - i++; - while (isdigit(log_buffer[i])) { - priority = priority * 10 + (log_buffer[i] - '0'); - i++; - } - if (log_buffer[i] == '>') - i++; - start = &log_buffer[i]; - } - if (log_buffer[i] == '\n') { - log_buffer[i] = '\0'; /* zero terminate this message */ - syslog_msg(LOG_KERN, priority, start); - start = &log_buffer[i + 1]; - priority = LOG_INFO; - } - lastc = log_buffer[i]; - } +static void klogd_open(void) +{ + int fd = xopen(_PATH_KLOG, O_RDONLY); + xmove_fd(fd, klogfd); +} + +static void klogd_setloglevel(int lvl) +{ + FILE *fp = fopen_or_warn(PATH_PRINTK, "w"); + if (fp) { + /* This changes only first value: + * "messages with a higher priority than this + * [that is, with numerically lower value] + * will be printed to the console". + * The other three values in this pseudo-file aren't changed. + */ + fprintf(fp, "%u\n", lvl); + fclose(fp); } } -extern int klogd_main(int argc, char **argv) +static int klogd_read(char *bufp, int len) +{ + return read(klogfd, bufp, len); +} +# define READ_ERROR "read error" + +static void klogd_close(void) { - /* no options, no getopt */ + klogd_setloglevel(7); + if (ENABLE_FEATURE_CLEAN_UP) + close(klogfd); +} + +#endif + +#define log_buffer bb_common_bufsiz1 +enum { + KLOGD_LOGBUF_SIZE = sizeof(log_buffer), + OPT_LEVEL = (1 << 0), + OPT_FOREGROUND = (1 << 1), +}; + +/* TODO: glibc openlog(LOG_KERN) reverts to LOG_USER instead, + * because that's how they interpret word "default" + * in the openlog() manpage: + * LOG_USER (default) + * generic user-level messages + * and the fact that LOG_KERN is a constant 0. + * glibc interprets it as "0 in openlog() call means 'use default'". + * I think it means "if openlog wasn't called before syslog() is called, + * use default". + * Convincing glibc maintainers otherwise is, as usual, nearly impossible. + * Should we open-code syslog() here to use correct facility? + */ + +int klogd_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; +int klogd_main(int argc UNUSED_PARAM, char **argv) +{ + int i = 0; + char *opt_c; int opt; - int doFork = TRUE; + int used; + + opt = getopt32(argv, "c:n", &opt_c); + if (opt & OPT_LEVEL) { + /* Valid levels are between 1 and 8 */ + i = xatou_range(opt_c, 1, 8); + } + if (!(opt & OPT_FOREGROUND)) { + bb_daemonize_or_rexec(DAEMON_CHDIR_ROOT, argv); + } + + logmode = LOGMODE_SYSLOG; + + /* klogd_open() before openlog(), since it might use fixed fd 3, + * and openlog() also may use the same fd 3 if we swap them: + */ + klogd_open(); + openlog("kernel", 0, LOG_KERN); + /* + * glibc problem: for some reason, glibc changes LOG_KERN to LOG_USER + * above. The logic behind this is that standard + * http://pubs.opengroup.org/onlinepubs/9699919799/functions/syslog.html + * says the following about openlog and syslog: + * "LOG_USER + * Messages generated by arbitrary processes. + * This is the default facility identifier if none is specified." + * + * I believe glibc misinterpreted this text as "if openlog's + * third parameter is 0 (=LOG_KERN), treat it as LOG_USER". + * Whereas it was meant to say "if *syslog* is called with facility + * 0 in its 1st parameter without prior call to openlog, then perform + * implicit openlog(LOG_USER)". + * + * As a result of this, eh, feature, standard klogd was forced + * to open-code its own openlog and syslog implementation (!). + * + * Note that prohibiting openlog(LOG_KERN) on libc level does not + * add any security: any process can open a socket to "/dev/log" + * and write a string "<0>Voila, a LOG_KERN + LOG_EMERG message" + * + * Google code search tells me there is no widespread use of + * openlog("foo", 0, 0), thus fixing glibc won't break userspace. + * + * The bug against glibc was filed: + * bugzilla.redhat.com/show_bug.cgi?id=547000 + */ + + if (i) + klogd_setloglevel(i); + + signal(SIGHUP, SIG_IGN); + /* We want klogd_read to not be restarted, thus _norestart: */ + bb_signals_recursive_norestart(BB_FATAL_SIGS, record_signo); + + syslog(LOG_NOTICE, "klogd started: %s", bb_banner); + + write_pidfile(CONFIG_PID_FILE_PATH "/klogd.pid"); - /* do normal option parsing */ - while ((opt = getopt(argc, argv, "n")) > 0) { - switch (opt) { - case 'n': - doFork = FALSE; + used = 0; + while (!bb_got_signal) { + int n; + int priority; + char *start; + + /* "2 -- Read from the log." */ + start = log_buffer + used; + n = klogd_read(start, KLOGD_LOGBUF_SIZE-1 - used); + if (n < 0) { + if (errno == EINTR) + continue; + bb_perror_msg(READ_ERROR); break; - default: - show_usage(); } - } + start[n] = '\0'; - if (doFork) { -#if !defined(__UCLIBC__) || defined(__UCLIBC_HAS_MMU__) - if (daemon(0, 1) < 0) - perror_msg_and_die("daemon"); -#else - error_msg_and_die("daemon not supported"); -#endif + /* Process each newline-terminated line in the buffer */ + start = log_buffer; + while (1) { + char *newline = strchrnul(start, '\n'); + + if (*newline == '\0') { + /* This line is incomplete */ + + /* move it to the front of the buffer */ + overlapping_strcpy(log_buffer, start); + used = newline - start; + if (used < KLOGD_LOGBUF_SIZE-1) { + /* buffer isn't full */ + break; + } + /* buffer is full, log it anyway */ + used = 0; + newline = NULL; + } else { + *newline++ = '\0'; + } + + /* Extract the priority */ + priority = LOG_INFO; + if (*start == '<') { + start++; + if (*start) + priority = strtoul(start, &start, 10); + if (*start == '>') + start++; + } + /* Log (only non-empty lines) */ + if (*start) + syslog(priority, "%s", start); + + if (!newline) + break; + start = newline; + } } - doKlogd(); - return EXIT_SUCCESS; + klogd_close(); + syslog(LOG_NOTICE, "klogd: exiting"); + remove_pidfile(CONFIG_PID_FILE_PATH "/klogd.pid"); + if (bb_got_signal) + kill_myself_with_sig(bb_got_signal); + return EXIT_FAILURE; } - -/* -Local Variables -c-file-style: "linux" -c-basic-offset: 4 -tab-width: 4 -End: -*/