diff options
author | Bjørn Mork <bjorn@mork.no> | 2015-05-15 10:20:47 +0200 |
---|---|---|
committer | Bjørn Mork <bjorn@mork.no> | 2015-05-15 10:20:47 +0200 |
commit | 73b16af8feec390afbabd9356d6e5e83c0390838 (patch) | |
tree | 3730020ba2f9caeb9d7815a975af51830b51ce11 /sysklogd |
busybox: imported from http://www.busybox.net/downloads/busybox-1.13.3.tar.bz2busybox-1.13.3
Signed-off-by: Bjørn Mork <bjorn@mork.no>
Diffstat (limited to 'sysklogd')
-rw-r--r-- | sysklogd/Config.in | 118 | ||||
-rw-r--r-- | sysklogd/Kbuild | 11 | ||||
-rw-r--r-- | sysklogd/klogd.c | 135 | ||||
-rw-r--r-- | sysklogd/logger.c | 157 | ||||
-rw-r--r-- | sysklogd/logread.c | 185 | ||||
-rw-r--r-- | sysklogd/syslogd.c | 702 | ||||
-rw-r--r-- | sysklogd/syslogd_and_logger.c | 51 |
7 files changed, 1359 insertions, 0 deletions
diff --git a/sysklogd/Config.in b/sysklogd/Config.in new file mode 100644 index 0000000..0664be0 --- /dev/null +++ b/sysklogd/Config.in @@ -0,0 +1,118 @@ +# +# For a description of the syntax of this configuration file, +# see scripts/kbuild/config-language.txt. +# + +menu "System Logging Utilities" + +config SYSLOGD + bool "syslogd" + default n + help + The syslogd utility is used to record logs of all the + significant events that occur on a system. Every + message that is logged records the date and time of the + event, and will generally also record the name of the + application that generated the message. When used in + conjunction with klogd, messages from the Linux kernel + can also be recorded. This is terribly useful, + especially for finding what happened when something goes + wrong. And something almost always will go wrong if + you wait long enough.... + +config FEATURE_ROTATE_LOGFILE + bool "Rotate message files" + default n + depends on SYSLOGD + help + This enables syslogd to rotate the message files + on his own. No need to use an external rotatescript. + +config FEATURE_REMOTE_LOG + bool "Remote Log support" + default n + depends on SYSLOGD + help + When you enable this feature, the syslogd utility can + be used to send system log messages to another system + connected via a network. This allows the remote + machine to log all the system messages, which can be + terribly useful for reducing the number of serial + cables you use. It can also be a very good security + measure to prevent system logs from being tampered with + by an intruder. + +config FEATURE_SYSLOGD_DUP + bool "Support -D (drop dups) option" + default n + depends on SYSLOGD + help + Option -D instructs syslogd to drop consecutive messages + which are totally the same. + +config FEATURE_IPC_SYSLOG + bool "Circular Buffer support" + default n + depends on SYSLOGD + help + When you enable this feature, the syslogd utility will + use a circular buffer to record system log messages. + When the buffer is filled it will continue to overwrite + the oldest messages. This can be very useful for + systems with little or no permanent storage, since + otherwise system logs can eventually fill up your + entire filesystem, which may cause your system to + break badly. + +config FEATURE_IPC_SYSLOG_BUFFER_SIZE + int "Circular buffer size in Kbytes (minimum 4KB)" + default 16 + range 4 2147483647 + depends on FEATURE_IPC_SYSLOG + help + This option sets the size of the circular buffer + used to record system log messages. + +config LOGREAD + bool "logread" + default y + depends on FEATURE_IPC_SYSLOG + help + If you enabled Circular Buffer support, you almost + certainly want to enable this feature as well. This + utility will allow you to read the messages that are + stored in the syslogd circular buffer. + +config FEATURE_LOGREAD_REDUCED_LOCKING + bool "Double buffering" + default n + depends on LOGREAD + help + 'logread' ouput to slow serial terminals can have + side effects on syslog because of the semaphore. + This option make logread to double buffer copy + from circular buffer, minimizing semaphore + contention at some minor memory expense. + +config KLOGD + bool "klogd" + default n + help + klogd is a utility which intercepts and logs all + messages from the Linux kernel and sends the messages + out to the 'syslogd' utility so they can be logged. If + you wish to record the messages produced by the kernel, + you should enable this option. + +config LOGGER + bool "logger" + default n + select FEATURE_SYSLOG + help + The logger utility allows you to send arbitrary text + messages to the system log (i.e. the 'syslogd' utility) so + they can be logged. This is generally used to help locate + problems that occur within programs and scripts. + +endmenu + diff --git a/sysklogd/Kbuild b/sysklogd/Kbuild new file mode 100644 index 0000000..d802198 --- /dev/null +++ b/sysklogd/Kbuild @@ -0,0 +1,11 @@ +# Makefile for busybox +# +# Copyright (C) 1999-2005 by Erik Andersen <andersen@codepoet.org> +# +# Licensed under the GPL v2, see the file LICENSE in this tarball. + +lib-y:= +lib-$(CONFIG_KLOGD) += klogd.o +lib-$(CONFIG_LOGGER) += syslogd_and_logger.o +lib-$(CONFIG_LOGREAD) += logread.o +lib-$(CONFIG_SYSLOGD) += syslogd_and_logger.o diff --git a/sysklogd/klogd.c b/sysklogd/klogd.c new file mode 100644 index 0000000..a27ddf4 --- /dev/null +++ b/sysklogd/klogd.c @@ -0,0 +1,135 @@ +/* vi: set sw=4 ts=4: */ +/* + * Mini klogd implementation for busybox + * + * Copyright (C) 2001 by Gennady Feldman <gfeldman@gena01.com>. + * Changes: Made this a standalone busybox module which uses standalone + * syslog() client interface. + * + * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org> + * + * Copyright (C) 2000 by Karl M. Hegbloom <karlheg@debian.org> + * + * "circular buffer" Copyright (C) 2000 by Gennady Feldman <gfeldman@gena01.com> + * + * Maintainer: Gennady Feldman <gfeldman@gena01.com> as of Mar 12, 2001 + * + * Licensed under the GPL v2 or later, see the file LICENSE in this tarball. + */ + +#include "libbb.h" +#include <syslog.h> +#include <sys/klog.h> + +static void klogd_signal(int sig) +{ + /* 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(LOG_NOTICE, "klogd: exiting"); + kill_myself_with_sig(sig); +} + +#define log_buffer bb_common_bufsiz1 +enum { + KLOGD_LOGBUF_SIZE = sizeof(log_buffer), + OPT_LEVEL = (1 << 0), + OPT_FOREGROUND = (1 << 1), +}; + +int klogd_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; +int klogd_main(int argc UNUSED_PARAM, char **argv) +{ + int i = 0; + char *start; + int opt; + int used = 0; + + opt = getopt32(argv, "c:n", &start); + if (opt & OPT_LEVEL) { + /* Valid levels are between 1 and 8 */ + i = xatou_range(start, 1, 8); + } + if (!(opt & OPT_FOREGROUND)) { + bb_daemonize_or_rexec(DAEMON_CHDIR_ROOT, argv); + } + + openlog("kernel", 0, LOG_KERN); + + bb_signals(0 + + (1 << SIGINT) + + (1 << SIGTERM) + , klogd_signal); + signal(SIGHUP, SIG_IGN); + + /* "Open the log. Currently a NOP" */ + klogctl(1, NULL, 0); + + /* "printk() prints a message on the console only if it has a loglevel + * less than console_loglevel". Here we set console_loglevel = i. */ + if (i) + klogctl(8, NULL, i); + + syslog(LOG_NOTICE, "klogd started: %s", bb_banner); + + while (1) { + int n; + int priority; + + /* "2 -- Read from the log." */ + n = klogctl(2, log_buffer + used, KLOGD_LOGBUF_SIZE-1 - used); + if (n < 0) { + if (errno == EINTR) + continue; + syslog(LOG_ERR, "klogd: error %d in klogctl(2): %m", + errno); + break; + } + log_buffer[used + n] = '\0'; + + /* klogctl buffer parsing modelled after code in dmesg.c */ + start = &log_buffer[0]; + + /* Process each newline-terminated line in the buffer */ + while (1) { + char *newline = strchr(start, '\n'); + + if (!newline) { + /* This line is incomplete... */ + if (start != log_buffer) { + /* move it to the front of the buffer */ + overlapping_strcpy(log_buffer, start); + /* don't log it yet */ + used = strlen(log_buffer); + break; + } + /* ...but buffer is full, so log it anyway */ + used = 0; + } else { + *newline++ = '\0'; + } + + /* Extract the priority */ + priority = LOG_INFO; + if (*start == '<') { + start++; + if (*start) { + /* kernel never generates multi-digit prios */ + priority = (*start - '0'); + start++; + } + if (*start == '>') { + start++; + } + } + if (*start) + syslog(priority, "%s", start); + if (!newline) + break; + start = newline; + } + } + + return EXIT_FAILURE; +} diff --git a/sysklogd/logger.c b/sysklogd/logger.c new file mode 100644 index 0000000..6258113 --- /dev/null +++ b/sysklogd/logger.c @@ -0,0 +1,157 @@ +/* vi: set sw=4 ts=4: */ +/* + * Mini logger implementation for busybox + * + * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org> + * + * Licensed under GPLv2 or later, see file LICENSE in this tarball for details. + */ + +/* + * Done in syslogd_and_logger.c: +#include "libbb.h" +#define SYSLOG_NAMES +#define SYSLOG_NAMES_CONST +#include <syslog.h> +*/ + +/* Decode a symbolic name to a numeric value + * this function is based on code + * Copyright (c) 1983, 1993 + * The Regents of the University of California. All rights reserved. + * + * Original copyright notice is retained at the end of this file. + */ +static int decode(char *name, const CODE *codetab) +{ + const CODE *c; + + if (isdigit(*name)) + return atoi(name); + for (c = codetab; c->c_name; c++) { + if (!strcasecmp(name, c->c_name)) { + return c->c_val; + } + } + + return -1; +} + +/* Decode a symbolic name to a numeric value + * this function is based on code + * Copyright (c) 1983, 1993 + * The Regents of the University of California. All rights reserved. + * + * Original copyright notice is retained at the end of this file. + */ +static int pencode(char *s) +{ + char *save; + int lev, fac = LOG_USER; + + for (save = s; *s && *s != '.'; ++s) + ; + if (*s) { + *s = '\0'; + fac = decode(save, facilitynames); + if (fac < 0) + bb_error_msg_and_die("unknown %s name: %s", "facility", save); + *s++ = '.'; + } else { + s = save; + } + lev = decode(s, prioritynames); + if (lev < 0) + bb_error_msg_and_die("unknown %s name: %s", "priority", save); + return ((lev & LOG_PRIMASK) | (fac & LOG_FACMASK)); +} + +#define strbuf bb_common_bufsiz1 + +int logger_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; +int logger_main(int argc, char **argv) +{ + char *str_p, *str_t; + int i = 0; + char name[80]; + + /* Fill out the name string early (may be overwritten later) */ + bb_getpwuid(name, sizeof(name), geteuid()); + str_t = name; + + /* Parse any options */ + getopt32(argv, "p:st:", &str_p, &str_t); + + if (option_mask32 & 0x2) /* -s */ + i |= LOG_PERROR; + //if (option_mask32 & 0x4) /* -t */ + openlog(str_t, i, 0); + i = LOG_USER | LOG_NOTICE; + if (option_mask32 & 0x1) /* -p */ + i = pencode(str_p); + + argc -= optind; + argv += optind; + if (!argc) { + while (fgets(strbuf, COMMON_BUFSIZE, stdin)) { + if (strbuf[0] + && NOT_LONE_CHAR(strbuf, '\n') + ) { + /* Neither "" nor "\n" */ + syslog(i, "%s", strbuf); + } + } + } else { + char *message = NULL; + int len = 0; + int pos = 0; + do { + len += strlen(*argv) + 1; + message = xrealloc(message, len + 1); + sprintf(message + pos, " %s", *argv), + pos = len; + } while (*++argv); + syslog(i, "%s", message + 1); /* skip leading " " */ + } + + closelog(); + return EXIT_SUCCESS; +} + +/* Clean up. Needed because we are included from syslogd_and_logger.c */ +#undef strbuf + +/*- + * Copyright (c) 1983, 1993 + * The Regents of the University of California. All rights reserved. + * + * This is the original license statement for the decode and pencode functions. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * 3. <BSD Advertising Clause omitted per the July 22, 1999 licensing change + * ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change> + * + * 4. Neither the name of the University nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ diff --git a/sysklogd/logread.c b/sysklogd/logread.c new file mode 100644 index 0000000..603a377 --- /dev/null +++ b/sysklogd/logread.c @@ -0,0 +1,185 @@ +/* vi: set sw=4 ts=4: */ +/* + * circular buffer syslog implementation for busybox + * + * Copyright (C) 2000 by Gennady Feldman <gfeldman@gena01.com> + * + * Maintainer: Gennady Feldman <gfeldman@gena01.com> as of Mar 12, 2001 + * + * Licensed under GPLv2 or later, see file LICENSE in this tarball for details. + */ + +#include "libbb.h" +#include <sys/ipc.h> +#include <sys/sem.h> +#include <sys/shm.h> + +#define DEBUG 0 + +/* our shared key (syslogd.c and logread.c must be in sync) */ +enum { KEY_ID = 0x414e4547 }; /* "GENA" */ + +struct shbuf_ds { + int32_t size; // size of data - 1 + int32_t tail; // end of message list + char data[1]; // messages +}; + +static const struct sembuf init_sem[3] = { + {0, -1, IPC_NOWAIT | SEM_UNDO}, + {1, 0}, {0, +1, SEM_UNDO} +}; + +struct globals { + struct sembuf SMrup[1]; // {0, -1, IPC_NOWAIT | SEM_UNDO}, + struct sembuf SMrdn[2]; // {1, 0}, {0, +1, SEM_UNDO} + struct shbuf_ds *shbuf; +}; +#define G (*(struct globals*)&bb_common_bufsiz1) +#define SMrup (G.SMrup) +#define SMrdn (G.SMrdn) +#define shbuf (G.shbuf) +#define INIT_G() do { \ + memcpy(SMrup, init_sem, sizeof(init_sem)); \ +} while (0) + +static void error_exit(const char *str) NORETURN; +static void error_exit(const char *str) +{ + //release all acquired resources + shmdt(shbuf); + bb_perror_msg_and_die(str); +} + +/* + * sem_up - up()'s a semaphore. + */ +static void sem_up(int semid) +{ + if (semop(semid, SMrup, 1) == -1) + error_exit("semop[SMrup]"); +} + +static void interrupted(int sig UNUSED_PARAM) +{ + signal(SIGINT, SIG_IGN); + shmdt(shbuf); + exit(EXIT_SUCCESS); +} + +int logread_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; +int logread_main(int argc UNUSED_PARAM, char **argv) +{ + unsigned cur; + int log_semid; /* ipc semaphore id */ + int log_shmid; /* ipc shared memory id */ + smallint follow = getopt32(argv, "f"); + + INIT_G(); + + log_shmid = shmget(KEY_ID, 0, 0); + if (log_shmid == -1) + bb_perror_msg_and_die("can't find syslogd buffer"); + + /* Attach shared memory to our char* */ + shbuf = shmat(log_shmid, NULL, SHM_RDONLY); + if (shbuf == NULL) + bb_perror_msg_and_die("can't access syslogd buffer"); + + log_semid = semget(KEY_ID, 0, 0); + if (log_semid == -1) + error_exit("can't get access to semaphores for syslogd buffer"); + + signal(SIGINT, interrupted); + + /* Suppose atomic memory read */ + /* Max possible value for tail is shbuf->size - 1 */ + cur = shbuf->tail; + + /* Loop for logread -f, one pass if there was no -f */ + do { + unsigned shbuf_size; + unsigned shbuf_tail; + const char *shbuf_data; +#if ENABLE_FEATURE_LOGREAD_REDUCED_LOCKING + int i; + int len_first_part; + int len_total = len_total; /* for gcc */ + char *copy = copy; /* for gcc */ +#endif + if (semop(log_semid, SMrdn, 2) == -1) + error_exit("semop[SMrdn]"); + + /* Copy the info, helps gcc to realize that it doesn't change */ + shbuf_size = shbuf->size; + shbuf_tail = shbuf->tail; + shbuf_data = shbuf->data; /* pointer! */ + + if (DEBUG) + printf("cur:%d tail:%i size:%i\n", + cur, shbuf_tail, shbuf_size); + + if (!follow) { + /* advance to oldest complete message */ + /* find NUL */ + cur += strlen(shbuf_data + cur); + if (cur >= shbuf_size) { /* last byte in buffer? */ + cur = strnlen(shbuf_data, shbuf_tail); + if (cur == shbuf_tail) + goto unlock; /* no complete messages */ + } + /* advance to first byte of the message */ + cur++; + if (cur >= shbuf_size) /* last byte in buffer? */ + cur = 0; + } else { /* logread -f */ + if (cur == shbuf_tail) { + sem_up(log_semid); + fflush(stdout); + sleep(1); /* TODO: replace me with a sleep_on */ + continue; + } + } + + /* Read from cur to tail */ +#if ENABLE_FEATURE_LOGREAD_REDUCED_LOCKING + len_first_part = len_total = shbuf_tail - cur; + if (len_total < 0) { + /* message wraps: */ + /* [SECOND PART.........FIRST PART] */ + /* ^data ^tail ^cur ^size */ + len_total += shbuf_size; + } + copy = xmalloc(len_total + 1); + if (len_first_part < 0) { + /* message wraps (see above) */ + len_first_part = shbuf_size - cur; + memcpy(copy + len_first_part, shbuf_data, shbuf_tail); + } + memcpy(copy, shbuf_data + cur, len_first_part); + copy[len_total] = '\0'; + cur = shbuf_tail; +#else + while (cur != shbuf_tail) { + fputs(shbuf_data + cur, stdout); + cur += strlen(shbuf_data + cur) + 1; + if (cur >= shbuf_size) + cur = 0; + } +#endif + unlock: + /* release the lock on the log chain */ + sem_up(log_semid); + +#if ENABLE_FEATURE_LOGREAD_REDUCED_LOCKING + for (i = 0; i < len_total; i += strlen(copy + i) + 1) { + fputs(copy + i, stdout); + } + free(copy); +#endif + } while (follow); + + shmdt(shbuf); + + fflush_stdout_and_exit(EXIT_SUCCESS); +} diff --git a/sysklogd/syslogd.c b/sysklogd/syslogd.c new file mode 100644 index 0000000..f624eb7 --- /dev/null +++ b/sysklogd/syslogd.c @@ -0,0 +1,702 @@ +/* vi: set sw=4 ts=4: */ +/* + * Mini syslogd implementation for busybox + * + * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org> + * + * Copyright (C) 2000 by Karl M. Hegbloom <karlheg@debian.org> + * + * "circular buffer" Copyright (C) 2001 by Gennady Feldman <gfeldman@gena01.com> + * + * Maintainer: Gennady Feldman <gfeldman@gena01.com> as of Mar 12, 2001 + * + * Licensed under the GPL v2 or later, see the file LICENSE in this tarball. + */ + +/* + * Done in syslogd_and_logger.c: +#include "libbb.h" +#define SYSLOG_NAMES +#define SYSLOG_NAMES_CONST +#include <syslog.h> +*/ + +#include <paths.h> +#include <sys/un.h> +#include <sys/uio.h> + +#if ENABLE_FEATURE_REMOTE_LOG +#include <netinet/in.h> +#endif + +#if ENABLE_FEATURE_IPC_SYSLOG +#include <sys/ipc.h> +#include <sys/sem.h> +#include <sys/shm.h> +#endif + + +#define DEBUG 0 + +/* MARK code is not very useful, is bloat, and broken: + * can deadlock if alarmed to make MARK while writing to IPC buffer + * (semaphores are down but do_mark routine tries to down them again) */ +#undef SYSLOGD_MARK + +enum { + MAX_READ = 256, + DNS_WAIT_SEC = 2 * 60, +}; + +/* Semaphore operation structures */ +struct shbuf_ds { + int32_t size; /* size of data - 1 */ + int32_t tail; /* end of message list */ + char data[1]; /* data/messages */ +}; + +/* Allows us to have smaller initializer. Ugly. */ +#define GLOBALS \ + const char *logFilePath; \ + int logFD; \ + /* interval between marks in seconds */ \ + /*int markInterval;*/ \ + /* level of messages to be logged */ \ + int logLevel; \ +USE_FEATURE_ROTATE_LOGFILE( \ + /* max size of file before rotation */ \ + unsigned logFileSize; \ + /* number of rotated message files */ \ + unsigned logFileRotate; \ + unsigned curFileSize; \ + smallint isRegular; \ +) \ +USE_FEATURE_REMOTE_LOG( \ + /* udp socket for remote logging */ \ + int remoteFD; \ + len_and_sockaddr* remoteAddr; \ +) \ +USE_FEATURE_IPC_SYSLOG( \ + int shmid; /* ipc shared memory id */ \ + int s_semid; /* ipc semaphore id */ \ + int shm_size; \ + struct sembuf SMwup[1]; \ + struct sembuf SMwdn[3]; \ +) + +struct init_globals { + GLOBALS +}; + +struct globals { + GLOBALS + +#if ENABLE_FEATURE_REMOTE_LOG + unsigned last_dns_resolve; + char *remoteAddrStr; +#endif + +#if ENABLE_FEATURE_IPC_SYSLOG + struct shbuf_ds *shbuf; +#endif + time_t last_log_time; + /* localhost's name. We print only first 64 chars */ + char *hostname; + + /* We recv into recvbuf... */ + char recvbuf[MAX_READ * (1 + ENABLE_FEATURE_SYSLOGD_DUP)]; + /* ...then copy to parsebuf, escaping control chars */ + /* (can grow x2 max) */ + char parsebuf[MAX_READ*2]; + /* ...then sprintf into printbuf, adding timestamp (15 chars), + * host (64), fac.prio (20) to the message */ + /* (growth by: 15 + 64 + 20 + delims = ~110) */ + char printbuf[MAX_READ*2 + 128]; +}; + +static const struct init_globals init_data = { + .logFilePath = "/var/log/messages", + .logFD = -1, +#ifdef SYSLOGD_MARK + .markInterval = 20 * 60, +#endif + .logLevel = 8, +#if ENABLE_FEATURE_ROTATE_LOGFILE + .logFileSize = 200 * 1024, + .logFileRotate = 1, +#endif +#if ENABLE_FEATURE_REMOTE_LOG + .remoteFD = -1, +#endif +#if ENABLE_FEATURE_IPC_SYSLOG + .shmid = -1, + .s_semid = -1, + .shm_size = ((CONFIG_FEATURE_IPC_SYSLOG_BUFFER_SIZE)*1024), // default shm size + .SMwup = { {1, -1, IPC_NOWAIT} }, + .SMwdn = { {0, 0}, {1, 0}, {1, +1} }, +#endif +}; + +#define G (*ptr_to_globals) +#define INIT_G() do { \ + SET_PTR_TO_GLOBALS(memcpy(xzalloc(sizeof(G)), &init_data, sizeof(init_data))); \ +} while (0) + + +/* Options */ +enum { + OPTBIT_mark = 0, // -m + OPTBIT_nofork, // -n + OPTBIT_outfile, // -O + OPTBIT_loglevel, // -l + OPTBIT_small, // -S + USE_FEATURE_ROTATE_LOGFILE(OPTBIT_filesize ,) // -s + USE_FEATURE_ROTATE_LOGFILE(OPTBIT_rotatecnt ,) // -b + USE_FEATURE_REMOTE_LOG( OPTBIT_remote ,) // -R + USE_FEATURE_REMOTE_LOG( OPTBIT_locallog ,) // -L + USE_FEATURE_IPC_SYSLOG( OPTBIT_circularlog,) // -C + USE_FEATURE_SYSLOGD_DUP( OPTBIT_dup ,) // -D + + OPT_mark = 1 << OPTBIT_mark , + OPT_nofork = 1 << OPTBIT_nofork , + OPT_outfile = 1 << OPTBIT_outfile , + OPT_loglevel = 1 << OPTBIT_loglevel, + OPT_small = 1 << OPTBIT_small , + OPT_filesize = USE_FEATURE_ROTATE_LOGFILE((1 << OPTBIT_filesize )) + 0, + OPT_rotatecnt = USE_FEATURE_ROTATE_LOGFILE((1 << OPTBIT_rotatecnt )) + 0, + OPT_remotelog = USE_FEATURE_REMOTE_LOG( (1 << OPTBIT_remote )) + 0, + OPT_locallog = USE_FEATURE_REMOTE_LOG( (1 << OPTBIT_locallog )) + 0, + OPT_circularlog = USE_FEATURE_IPC_SYSLOG( (1 << OPTBIT_circularlog)) + 0, + OPT_dup = USE_FEATURE_SYSLOGD_DUP( (1 << OPTBIT_dup )) + 0, +}; +#define OPTION_STR "m:nO:l:S" \ + USE_FEATURE_ROTATE_LOGFILE("s:" ) \ + USE_FEATURE_ROTATE_LOGFILE("b:" ) \ + USE_FEATURE_REMOTE_LOG( "R:" ) \ + USE_FEATURE_REMOTE_LOG( "L" ) \ + USE_FEATURE_IPC_SYSLOG( "C::") \ + USE_FEATURE_SYSLOGD_DUP( "D" ) +#define OPTION_DECL *opt_m, *opt_l \ + USE_FEATURE_ROTATE_LOGFILE(,*opt_s) \ + USE_FEATURE_ROTATE_LOGFILE(,*opt_b) \ + USE_FEATURE_IPC_SYSLOG( ,*opt_C = NULL) +#define OPTION_PARAM &opt_m, &G.logFilePath, &opt_l \ + USE_FEATURE_ROTATE_LOGFILE(,&opt_s) \ + USE_FEATURE_ROTATE_LOGFILE(,&opt_b) \ + USE_FEATURE_REMOTE_LOG( ,&G.remoteAddrStr) \ + USE_FEATURE_IPC_SYSLOG( ,&opt_C) + + +/* circular buffer variables/structures */ +#if ENABLE_FEATURE_IPC_SYSLOG + +#if CONFIG_FEATURE_IPC_SYSLOG_BUFFER_SIZE < 4 +#error Sorry, you must set the syslogd buffer size to at least 4KB. +#error Please check CONFIG_FEATURE_IPC_SYSLOG_BUFFER_SIZE +#endif + +/* our shared key (syslogd.c and logread.c must be in sync) */ +enum { KEY_ID = 0x414e4547 }; /* "GENA" */ + +static void ipcsyslog_cleanup(void) +{ + if (G.shmid != -1) { + shmdt(G.shbuf); + } + if (G.shmid != -1) { + shmctl(G.shmid, IPC_RMID, NULL); + } + if (G.s_semid != -1) { + semctl(G.s_semid, 0, IPC_RMID, 0); + } +} + +static void ipcsyslog_init(void) +{ + if (DEBUG) + printf("shmget(%x, %d,...)\n", (int)KEY_ID, G.shm_size); + + G.shmid = shmget(KEY_ID, G.shm_size, IPC_CREAT | 0644); + if (G.shmid == -1) { + bb_perror_msg_and_die("shmget"); + } + + G.shbuf = shmat(G.shmid, NULL, 0); + if (G.shbuf == (void*) -1L) { /* shmat has bizarre error return */ + bb_perror_msg_and_die("shmat"); + } + + memset(G.shbuf, 0, G.shm_size); + G.shbuf->size = G.shm_size - offsetof(struct shbuf_ds, data) - 1; + /*G.shbuf->tail = 0;*/ + + // we'll trust the OS to set initial semval to 0 (let's hope) + G.s_semid = semget(KEY_ID, 2, IPC_CREAT | IPC_EXCL | 1023); + if (G.s_semid == -1) { + if (errno == EEXIST) { + G.s_semid = semget(KEY_ID, 2, 0); + if (G.s_semid != -1) + return; + } + bb_perror_msg_and_die("semget"); + } +} + +/* Write message to shared mem buffer */ +static void log_to_shmem(const char *msg, int len) +{ + int old_tail, new_tail; + + if (semop(G.s_semid, G.SMwdn, 3) == -1) { + bb_perror_msg_and_die("SMwdn"); + } + + /* Circular Buffer Algorithm: + * -------------------------- + * tail == position where to store next syslog message. + * tail's max value is (shbuf->size - 1) + * Last byte of buffer is never used and remains NUL. + */ + len++; /* length with NUL included */ + again: + old_tail = G.shbuf->tail; + new_tail = old_tail + len; + if (new_tail < G.shbuf->size) { + /* store message, set new tail */ + memcpy(G.shbuf->data + old_tail, msg, len); + G.shbuf->tail = new_tail; + } else { + /* k == available buffer space ahead of old tail */ + int k = G.shbuf->size - old_tail; + /* copy what fits to the end of buffer, and repeat */ + memcpy(G.shbuf->data + old_tail, msg, k); + msg += k; + len -= k; + G.shbuf->tail = 0; + goto again; + } + if (semop(G.s_semid, G.SMwup, 1) == -1) { + bb_perror_msg_and_die("SMwup"); + } + if (DEBUG) + printf("tail:%d\n", G.shbuf->tail); +} +#else +void ipcsyslog_cleanup(void); +void ipcsyslog_init(void); +void log_to_shmem(const char *msg); +#endif /* FEATURE_IPC_SYSLOG */ + + +/* Print a message to the log file. */ +static void log_locally(time_t now, char *msg) +{ + struct flock fl; + int len = strlen(msg); + +#if ENABLE_FEATURE_IPC_SYSLOG + if ((option_mask32 & OPT_circularlog) && G.shbuf) { + log_to_shmem(msg, len); + return; + } +#endif + if (G.logFD >= 0) { + /* Reopen log file every second. This allows admin + * to delete the file and not worry about restarting us. + * This costs almost nothing since it happens + * _at most_ once a second. + */ + if (!now) + now = time(NULL); + if (G.last_log_time != now) { + G.last_log_time = now; + close(G.logFD); + goto reopen; + } + } else { + reopen: + G.logFD = open(G.logFilePath, O_WRONLY | O_CREAT + | O_NOCTTY | O_APPEND | O_NONBLOCK, + 0666); + if (G.logFD < 0) { + /* cannot open logfile? - print to /dev/console then */ + int fd = device_open(DEV_CONSOLE, O_WRONLY | O_NOCTTY | O_NONBLOCK); + if (fd < 0) + fd = 2; /* then stderr, dammit */ + full_write(fd, msg, len); + if (fd != 2) + close(fd); + return; + } +#if ENABLE_FEATURE_ROTATE_LOGFILE + { + struct stat statf; + G.isRegular = (fstat(G.logFD, &statf) == 0 && S_ISREG(statf.st_mode)); + /* bug (mostly harmless): can wrap around if file > 4gb */ + G.curFileSize = statf.st_size; + } +#endif + } + + fl.l_whence = SEEK_SET; + fl.l_start = 0; + fl.l_len = 1; + fl.l_type = F_WRLCK; + fcntl(G.logFD, F_SETLKW, &fl); + +#if ENABLE_FEATURE_ROTATE_LOGFILE + if (G.logFileSize && G.isRegular && G.curFileSize > G.logFileSize) { + if (G.logFileRotate) { /* always 0..99 */ + int i = strlen(G.logFilePath) + 3 + 1; + char oldFile[i]; + char newFile[i]; + i = G.logFileRotate - 1; + /* rename: f.8 -> f.9; f.7 -> f.8; ... */ + while (1) { + sprintf(newFile, "%s.%d", G.logFilePath, i); + if (i == 0) break; + sprintf(oldFile, "%s.%d", G.logFilePath, --i); + /* ignore errors - file might be missing */ + rename(oldFile, newFile); + } + /* newFile == "f.0" now */ + rename(G.logFilePath, newFile); + fl.l_type = F_UNLCK; + fcntl(G.logFD, F_SETLKW, &fl); + close(G.logFD); + goto reopen; + } + ftruncate(G.logFD, 0); + } + G.curFileSize += +#endif + full_write(G.logFD, msg, len); + fl.l_type = F_UNLCK; + fcntl(G.logFD, F_SETLKW, &fl); +} + +static void parse_fac_prio_20(int pri, char *res20) +{ + const CODE *c_pri, *c_fac; + + if (pri != 0) { + c_fac = facilitynames; + while (c_fac->c_name) { + if (c_fac->c_val != (LOG_FAC(pri) << 3)) { + c_fac++; + continue; + } + /* facility is found, look for prio */ + c_pri = prioritynames; + while (c_pri->c_name) { + if (c_pri->c_val != LOG_PRI(pri)) { + c_pri++; + continue; + } + snprintf(res20, 20, "%s.%s", + c_fac->c_name, c_pri->c_name); + return; + } + /* prio not found, bail out */ + break; + } + snprintf(res20, 20, "<%d>", pri); + } +} + +/* len parameter is used only for "is there a timestamp?" check. + * NB: some callers cheat and supply len==0 when they know + * that there is no timestamp, short-circuiting the test. */ +static void timestamp_and_log(int pri, char *msg, int len) +{ + char *timestamp; + time_t now; + + if (len < 16 || msg[3] != ' ' || msg[6] != ' ' + || msg[9] != ':' || msg[12] != ':' || msg[15] != ' ' + ) { + time(&now); + timestamp = ctime(&now) + 4; /* skip day of week */ + } else { + now = 0; + timestamp = msg; + msg += 16; + } + timestamp[15] = '\0'; + + if (option_mask32 & OPT_small) + sprintf(G.printbuf, "%s %s\n", timestamp, msg); + else { + char res[20]; + parse_fac_prio_20(pri, res); + sprintf(G.printbuf, "%s %.64s %s %s\n", timestamp, G.hostname, res, msg); + } + + /* Log message locally (to file or shared mem) */ + log_locally(now, G.printbuf); +} + +static void timestamp_and_log_internal(const char *msg) +{ + if (ENABLE_FEATURE_REMOTE_LOG && !(option_mask32 & OPT_locallog)) + return; + timestamp_and_log(LOG_SYSLOG | LOG_INFO, (char*)msg, 0); +} + +/* tmpbuf[len] is a NUL byte (set by caller), but there can be other, + * embedded NULs. Split messages on each of these NULs, parse prio, + * escape control chars and log each locally. */ +static void split_escape_and_log(char *tmpbuf, int len) +{ + char *p = tmpbuf; + + tmpbuf += len; + while (p < tmpbuf) { + char c; + char *q = G.parsebuf; + int pri = (LOG_USER | LOG_NOTICE); + + if (*p == '<') { + /* Parse the magic priority number */ + pri = bb_strtou(p + 1, &p, 10); + if (*p == '>') + p++; + if (pri & ~(LOG_FACMASK | LOG_PRIMASK)) + pri = (LOG_USER | LOG_NOTICE); + } + + while ((c = *p++)) { + if (c == '\n') + c = ' '; + if (!(c & ~0x1f) && c != '\t') { + *q++ = '^'; + c += '@'; /* ^@, ^A, ^B... */ + } + *q++ = c; + } + *q = '\0'; + + /* Now log it */ + if (LOG_PRI(pri) < G.logLevel) + timestamp_and_log(pri, G.parsebuf, q - G.parsebuf); + } +} + +static void quit_signal(int sig) +{ + timestamp_and_log_internal("syslogd exiting"); + puts("syslogd exiting"); + if (ENABLE_FEATURE_IPC_SYSLOG) + ipcsyslog_cleanup(); + kill_myself_with_sig(sig); +} + +#ifdef SYSLOGD_MARK +static void do_mark(int sig) +{ + if (G.markInterval) { + timestamp_and_log_internal("-- MARK --"); + alarm(G.markInterval); + } +} +#endif + +/* Don't inline: prevent struct sockaddr_un to take up space on stack + * permanently */ +static NOINLINE int create_socket(void) +{ + struct sockaddr_un sunx; + int sock_fd; + char *dev_log_name; + + memset(&sunx, 0, sizeof(sunx)); + sunx.sun_family = AF_UNIX; + + /* Unlink old /dev/log or object it points to. */ + /* (if it exists, bind will fail) */ + strcpy(sunx.sun_path, "/dev/log"); + dev_log_name = xmalloc_follow_symlinks("/dev/log"); + if (dev_log_name) { + safe_strncpy(sunx.sun_path, dev_log_name, sizeof(sunx.sun_path)); + free(dev_log_name); + } + unlink(sunx.sun_path); + + sock_fd = xsocket(AF_UNIX, SOCK_DGRAM, 0); + xbind(sock_fd, (struct sockaddr *) &sunx, sizeof(sunx)); + chmod("/dev/log", 0666); + + return sock_fd; +} + +#if ENABLE_FEATURE_REMOTE_LOG +static int try_to_resolve_remote(void) +{ + if (!G.remoteAddr) { + unsigned now = monotonic_sec(); + + /* Don't resolve name too often - DNS timeouts can be big */ + if ((now - G.last_dns_resolve) < DNS_WAIT_SEC) + return -1; + G.last_dns_resolve = now; + G.remoteAddr = host2sockaddr(G.remoteAddrStr, 514); + if (!G.remoteAddr) + return -1; + } + return socket(G.remoteAddr->u.sa.sa_family, SOCK_DGRAM, 0); +} +#endif + +static void do_syslogd(void) NORETURN; +static void do_syslogd(void) +{ + int sock_fd; +#if ENABLE_FEATURE_SYSLOGD_DUP + int last_sz = -1; + char *last_buf; + char *recvbuf = G.recvbuf; +#else +#define recvbuf (G.recvbuf) +#endif + + /* Set up signal handlers */ + bb_signals(0 + + (1 << SIGINT) + + (1 << SIGTERM) + + (1 << SIGQUIT) + , quit_signal); + signal(SIGHUP, SIG_IGN); + /* signal(SIGCHLD, SIG_IGN); - why? */ +#ifdef SYSLOGD_MARK + signal(SIGALRM, do_mark); + alarm(G.markInterval); +#endif + sock_fd = create_socket(); + + if (ENABLE_FEATURE_IPC_SYSLOG && (option_mask32 & OPT_circularlog)) { + ipcsyslog_init(); + } + + timestamp_and_log_internal("syslogd started: BusyBox v" BB_VER); + + for (;;) { + ssize_t sz; + +#if ENABLE_FEATURE_SYSLOGD_DUP + last_buf = recvbuf; + if (recvbuf == G.recvbuf) + recvbuf = G.recvbuf + MAX_READ; + else + recvbuf = G.recvbuf; +#endif + read_again: + sz = safe_read(sock_fd, recvbuf, MAX_READ - 1); + if (sz < 0) + bb_perror_msg_and_die("read from /dev/log"); + + /* Drop trailing '\n' and NULs (typically there is one NUL) */ + while (1) { + if (sz == 0) + goto read_again; + /* man 3 syslog says: "A trailing newline is added when needed". + * However, neither glibc nor uclibc do this: + * syslog(prio, "test") sends "test\0" to /dev/log, + * syslog(prio, "test\n") sends "test\n\0". + * IOW: newline is passed verbatim! + * I take it to mean that it's syslogd's job + * to make those look identical in the log files. */ + if (recvbuf[sz-1] != '\0' && recvbuf[sz-1] != '\n') + break; + sz--; + } +#if ENABLE_FEATURE_SYSLOGD_DUP + if ((option_mask32 & OPT_dup) && (sz == last_sz)) + if (memcmp(last_buf, recvbuf, sz) == 0) + continue; + last_sz = sz; +#endif +#if ENABLE_FEATURE_REMOTE_LOG + /* We are not modifying log messages in any way before send */ + /* Remote site cannot trust _us_ anyway and need to do validation again */ + if (G.remoteAddrStr) { + if (-1 == G.remoteFD) { + G.remoteFD = try_to_resolve_remote(); + if (-1 == G.remoteFD) + goto no_luck; + } + /* Stock syslogd sends it '\n'-terminated + * over network, mimic that */ + recvbuf[sz] = '\n'; + /* send message to remote logger, ignore possible error */ + /* TODO: on some errors, close and set G.remoteFD to -1 + * so that DNS resolution and connect is retried? */ + sendto(G.remoteFD, recvbuf, sz+1, MSG_DONTWAIT, + &G.remoteAddr->u.sa, G.remoteAddr->len); + no_luck: ; + } +#endif + if (!ENABLE_FEATURE_REMOTE_LOG || (option_mask32 & OPT_locallog)) { + recvbuf[sz] = '\0'; /* ensure it *is* NUL terminated */ + split_escape_and_log(recvbuf, sz); + } + } /* for (;;) */ +#undef recvbuf +} + +int syslogd_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; +int syslogd_main(int argc UNUSED_PARAM, char **argv) +{ + char OPTION_DECL; + + INIT_G(); +#if ENABLE_FEATURE_REMOTE_LOG + G.last_dns_resolve = monotonic_sec() - DNS_WAIT_SEC - 1; +#endif + + /* do normal option parsing */ + opt_complementary = "=0"; /* no non-option params */ + getopt32(argv, OPTION_STR, OPTION_PARAM); +#ifdef SYSLOGD_MARK + if (option_mask32 & OPT_mark) // -m + G.markInterval = xatou_range(opt_m, 0, INT_MAX/60) * 60; +#endif + //if (option_mask32 & OPT_nofork) // -n + //if (option_mask32 & OPT_outfile) // -O + if (option_mask32 & OPT_loglevel) // -l + G.logLevel = xatou_range(opt_l, 1, 8); + //if (option_mask32 & OPT_small) // -S +#if ENABLE_FEATURE_ROTATE_LOGFILE + if (option_mask32 & OPT_filesize) // -s + G.logFileSize = xatou_range(opt_s, 0, INT_MAX/1024) * 1024; + if (option_mask32 & OPT_rotatecnt) // -b + G.logFileRotate = xatou_range(opt_b, 0, 99); +#endif +#if ENABLE_FEATURE_IPC_SYSLOG + if (opt_C) // -Cn + G.shm_size = xatoul_range(opt_C, 4, INT_MAX/1024) * 1024; +#endif + + /* If they have not specified remote logging, then log locally */ + if (ENABLE_FEATURE_REMOTE_LOG && !(option_mask32 & OPT_remotelog)) + option_mask32 |= OPT_locallog; + + /* Store away localhost's name before the fork */ + G.hostname = safe_gethostname(); + *strchrnul(G.hostname, '.') = '\0'; + + if (!(option_mask32 & OPT_nofork)) { + bb_daemonize_or_rexec(DAEMON_CHDIR_ROOT, argv); + } + umask(0); + write_pidfile("/var/run/syslogd.pid"); + do_syslogd(); + /* return EXIT_SUCCESS; */ +} + +/* Clean up. Needed because we are included from syslogd_and_logger.c */ +#undef G +#undef GLOBALS +#undef INIT_G +#undef OPTION_STR +#undef OPTION_DECL +#undef OPTION_PARAM diff --git a/sysklogd/syslogd_and_logger.c b/sysklogd/syslogd_and_logger.c new file mode 100644 index 0000000..51573bd --- /dev/null +++ b/sysklogd/syslogd_and_logger.c @@ -0,0 +1,51 @@ +/* vi: set sw=4 ts=4: */ +/* + * prioritynames[] and facilitynames[] + * + * Copyright (C) 2008 by Denys Vlasenko <vda.linux@gmail.com> + * + * Licensed under GPLv2, see file LICENSE in this tarball for details. + */ + +#include "libbb.h" +#define SYSLOG_NAMES +#define SYSLOG_NAMES_CONST +#include <syslog.h> + +#if 0 +/* For the record: with SYSLOG_NAMES <syslog.h> defines + * (not declares) the following: + */ +typedef struct _code { + /*const*/ char *c_name; + int c_val; +} CODE; +/*const*/ CODE prioritynames[] = { + { "alert", LOG_ALERT }, +... + { NULL, -1 } +}; +/* same for facilitynames[] */ + +/* This MUST occur only once per entire executable, + * therefore we can't just do it in syslogd.c and logger.c - + * there will be two copies of it. + * + * We cannot even do it in separate file and then just reference + * prioritynames[] from syslogd.c and logger.c - bare <syslog.h> + * will not emit extern decls for prioritynames[]! Attempts to + * emit "matching" struct _code declaration defeat the whole purpose + * of <syslog.h>. + * + * For now, syslogd.c and logger.c are simply compiled into + * one object file. + */ +#endif + +#if ENABLE_SYSLOGD +#include "syslogd.c" +#endif + +#if ENABLE_LOGGER +#include "logger.c" +#endif |