1 /* vi: set sw=4 ts=4: */
3 * Mini syslogd implementation for busybox
5 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
7 * Copyright (C) 2000 by Karl M. Hegbloom <karlheg@debian.org>
9 * "circular buffer" Copyright (C) 2001 by Gennady Feldman <gfeldman@gena01.com>
11 * Maintainer: Gennady Feldman <gfeldman@gena01.com> as of Mar 12, 2001
13 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
15 //config:config SYSLOGD
16 //config: bool "syslogd (14 kb)"
19 //config: The syslogd utility is used to record logs of all the
20 //config: significant events that occur on a system. Every
21 //config: message that is logged records the date and time of the
22 //config: event, and will generally also record the name of the
23 //config: application that generated the message. When used in
24 //config: conjunction with klogd, messages from the Linux kernel
25 //config: can also be recorded. This is terribly useful,
26 //config: especially for finding what happened when something goes
27 //config: wrong. And something almost always will go wrong if
28 //config: you wait long enough....
30 //config:config FEATURE_ROTATE_LOGFILE
31 //config: bool "Rotate message files"
33 //config: depends on SYSLOGD
35 //config: This enables syslogd to rotate the message files
36 //config: on his own. No need to use an external rotate script.
38 //config:config FEATURE_REMOTE_LOG
39 //config: bool "Remote Log support"
41 //config: depends on SYSLOGD
43 //config: When you enable this feature, the syslogd utility can
44 //config: be used to send system log messages to another system
45 //config: connected via a network. This allows the remote
46 //config: machine to log all the system messages, which can be
47 //config: terribly useful for reducing the number of serial
48 //config: cables you use. It can also be a very good security
49 //config: measure to prevent system logs from being tampered with
50 //config: by an intruder.
52 //config:config FEATURE_SYSLOGD_DUP
53 //config: bool "Support -D (drop dups) option"
55 //config: depends on SYSLOGD
57 //config: Option -D instructs syslogd to drop consecutive messages
58 //config: which are totally the same.
60 //config:config FEATURE_SYSLOGD_CFG
61 //config: bool "Support syslog.conf"
63 //config: depends on SYSLOGD
65 //config: Supports restricted syslogd config. See docs/syslog.conf.txt
67 //config:config FEATURE_SYSLOGD_PRECISE_TIMESTAMPS
68 //config: bool "Include milliseconds in timestamps"
70 //config: depends on SYSLOGD
72 //config: Includes milliseconds (HH:MM:SS.mmm) in timestamp when
73 //config: timestamps are added.
75 //config:config FEATURE_SYSLOGD_READ_BUFFER_SIZE
76 //config: int "Read buffer size in bytes"
78 //config: range 256 20000
79 //config: depends on SYSLOGD
81 //config: This option sets the size of the syslog read buffer.
82 //config: Actual memory usage increases around five times the
83 //config: change done here.
85 //config:config FEATURE_IPC_SYSLOG
86 //config: bool "Circular Buffer support"
88 //config: depends on SYSLOGD
90 //config: When you enable this feature, the syslogd utility will
91 //config: use a circular buffer to record system log messages.
92 //config: When the buffer is filled it will continue to overwrite
93 //config: the oldest messages. This can be very useful for
94 //config: systems with little or no permanent storage, since
95 //config: otherwise system logs can eventually fill up your
96 //config: entire filesystem, which may cause your system to
97 //config: break badly.
99 //config:config FEATURE_IPC_SYSLOG_BUFFER_SIZE
100 //config: int "Circular buffer size in Kbytes (minimum 4KB)"
102 //config: range 4 2147483647
103 //config: depends on FEATURE_IPC_SYSLOG
105 //config: This option sets the size of the circular buffer
106 //config: used to record system log messages.
108 //config:config FEATURE_KMSG_SYSLOG
109 //config: bool "Linux kernel printk buffer support"
111 //config: depends on SYSLOGD
113 //config: When you enable this feature, the syslogd utility will
114 //config: write system log message to the Linux kernel's printk buffer.
115 //config: This can be used as a smaller alternative to the syslogd IPC
116 //config: support, as klogd and logread aren't needed.
118 //config: NOTICE: Syslog facilities in log entries needs kernel 3.5+.
120 //applet:IF_SYSLOGD(APPLET(syslogd, BB_DIR_SBIN, BB_SUID_DROP))
122 //kbuild:lib-$(CONFIG_SYSLOGD) += syslogd_and_logger.o
124 //usage:#define syslogd_trivial_usage
126 //usage:#define syslogd_full_usage "\n\n"
127 //usage: "System logging utility\n"
128 //usage: IF_NOT_FEATURE_SYSLOGD_CFG(
129 //usage: "(this version of syslogd ignores /etc/syslog.conf)\n"
131 //usage: "\n -n Run in foreground"
132 //usage: IF_FEATURE_REMOTE_LOG(
133 //usage: "\n -R HOST[:PORT] Log to HOST:PORT (default PORT:514)"
134 //usage: "\n -L Log locally and via network (default is network only if -R)"
136 //usage: IF_FEATURE_IPC_SYSLOG(
137 /* NB: -Csize shouldn't have space (because size is optional) */
138 //usage: "\n -C[size_kb] Log to shared mem buffer (use logread to read it)"
140 //usage: IF_FEATURE_KMSG_SYSLOG(
141 //usage: "\n -K Log to kernel printk buffer (use dmesg to read it)"
143 //usage: "\n -O FILE Log to FILE (default: /var/log/messages, stdout if -)"
144 //usage: IF_FEATURE_ROTATE_LOGFILE(
145 //usage: "\n -s SIZE Max size (KB) before rotation (default 200KB, 0=off)"
146 //usage: "\n -b N N rotated logs to keep (default 1, max 99, 0=purge)"
148 //usage: "\n -l N Log only messages more urgent than prio N (1-8)"
149 //usage: "\n -S Smaller output"
150 //usage: "\n -t Strip client-generated timestamps"
151 //usage: IF_FEATURE_SYSLOGD_DUP(
152 //usage: "\n -D Drop duplicates"
154 //usage: IF_FEATURE_SYSLOGD_CFG(
155 //usage: "\n -f FILE Use FILE as config (default:/etc/syslog.conf)"
157 /* //usage: "\n -m MIN Minutes between MARK lines (default 20, 0=off)" */
159 //usage:#define syslogd_example_usage
160 //usage: "$ syslogd -R masterlog:514\n"
161 //usage: "$ syslogd -R 192.168.1.1:601\n"
164 * Done in syslogd_and_logger.c:
167 #define SYSLOG_NAMES_CONST
171 #define _PATH_LOG "/dev/log"
177 #if ENABLE_FEATURE_REMOTE_LOG
178 #include <netinet/in.h>
181 #if ENABLE_FEATURE_IPC_SYSLOG
190 /* MARK code is not very useful, is bloat, and broken:
191 * can deadlock if alarmed to make MARK while writing to IPC buffer
192 * (semaphores are down but do_mark routine tries to down them again) */
195 /* Write locking does not seem to be useful either */
196 #undef SYSLOGD_WRLOCK
199 MAX_READ
= CONFIG_FEATURE_SYSLOGD_READ_BUFFER_SIZE
,
200 DNS_WAIT_SEC
= 2 * 60,
203 /* Semaphore operation structures */
205 int32_t size
; /* size of data - 1 */
206 int32_t tail
; /* end of message list */
207 char data
[1]; /* data/messages */
210 #if ENABLE_FEATURE_REMOTE_LOG
213 unsigned last_dns_resolve
;
214 len_and_sockaddr
*remoteAddr
;
215 const char *remoteHostname
;
219 typedef struct logFile_t
{
222 time_t last_log_time
;
223 #if ENABLE_FEATURE_ROTATE_LOGFILE
229 #if ENABLE_FEATURE_SYSLOGD_CFG
230 typedef struct logRule_t
{
231 uint8_t enabled_facility_priomap
[LOG_NFACILITIES
];
232 struct logFile_t
*file
;
233 struct logRule_t
*next
;
237 /* Allows us to have smaller initializer. Ugly. */
240 /* interval between marks in seconds */ \
241 /*int markInterval;*/ \
242 /* level of messages to be logged */ \
244 IF_FEATURE_ROTATE_LOGFILE( \
245 /* max size of file before rotation */ \
246 unsigned logFileSize; \
247 /* number of rotated message files */ \
248 unsigned logFileRotate; \
250 IF_FEATURE_IPC_SYSLOG( \
251 int shmid; /* ipc shared memory id */ \
252 int s_semid; /* ipc semaphore id */ \
254 struct sembuf SMwup[1]; \
255 struct sembuf SMwdn[3]; \
257 IF_FEATURE_SYSLOGD_CFG( \
258 logRule_t *log_rules; \
260 IF_FEATURE_KMSG_SYSLOG( \
265 struct init_globals
{
272 #if ENABLE_FEATURE_REMOTE_LOG
273 llist_t
*remoteHosts
;
275 #if ENABLE_FEATURE_IPC_SYSLOG
276 struct shbuf_ds
*shbuf
;
278 /* localhost's name. We print only first 64 chars */
281 /* We recv into recvbuf... */
282 char recvbuf
[MAX_READ
* (1 + ENABLE_FEATURE_SYSLOGD_DUP
)];
283 /* ...then copy to parsebuf, escaping control chars */
284 /* (can grow x2 max) */
285 char parsebuf
[MAX_READ
*2];
286 /* ...then sprintf into printbuf, adding timestamp (15 or 19 chars),
287 * host (64), fac.prio (20) to the message */
288 /* (growth by: 15 + 64 + 20 + delims = ~110) */
289 char printbuf
[MAX_READ
*2 + 128];
292 static const struct init_globals init_data
= {
294 .path
= "/var/log/messages",
298 .markInterval
= 20 * 60,
301 #if ENABLE_FEATURE_ROTATE_LOGFILE
302 .logFileSize
= 200 * 1024,
305 #if ENABLE_FEATURE_IPC_SYSLOG
308 .shm_size
= ((CONFIG_FEATURE_IPC_SYSLOG_BUFFER_SIZE
)*1024), /* default shm size */
309 .SMwup
= { {1, -1, IPC_NOWAIT
} },
310 .SMwdn
= { {0, 0}, {1, 0}, {1, +1} },
314 #define G (*ptr_to_globals)
315 #define INIT_G() do { \
316 SET_PTR_TO_GLOBALS(memcpy(xzalloc(sizeof(G)), &init_data, sizeof(init_data))); \
322 OPTBIT_mark
= 0, // -m
324 OPTBIT_outfile
, // -O
325 OPTBIT_loglevel
, // -l
327 OPTBIT_timestamp
, // -t
328 IF_FEATURE_ROTATE_LOGFILE(OPTBIT_filesize
,) // -s
329 IF_FEATURE_ROTATE_LOGFILE(OPTBIT_rotatecnt
,) // -b
330 IF_FEATURE_REMOTE_LOG( OPTBIT_remotelog
,) // -R
331 IF_FEATURE_REMOTE_LOG( OPTBIT_locallog
,) // -L
332 IF_FEATURE_IPC_SYSLOG( OPTBIT_circularlog
,) // -C
333 IF_FEATURE_SYSLOGD_DUP( OPTBIT_dup
,) // -D
334 IF_FEATURE_SYSLOGD_CFG( OPTBIT_cfg
,) // -f
335 IF_FEATURE_KMSG_SYSLOG( OPTBIT_kmsg
,) // -K
337 OPT_mark
= 1 << OPTBIT_mark
,
338 OPT_nofork
= 1 << OPTBIT_nofork
,
339 OPT_outfile
= 1 << OPTBIT_outfile
,
340 OPT_loglevel
= 1 << OPTBIT_loglevel
,
341 OPT_small
= 1 << OPTBIT_small
,
342 OPT_timestamp
= 1 << OPTBIT_timestamp
,
343 OPT_filesize
= IF_FEATURE_ROTATE_LOGFILE((1 << OPTBIT_filesize
)) + 0,
344 OPT_rotatecnt
= IF_FEATURE_ROTATE_LOGFILE((1 << OPTBIT_rotatecnt
)) + 0,
345 OPT_remotelog
= IF_FEATURE_REMOTE_LOG( (1 << OPTBIT_remotelog
)) + 0,
346 OPT_locallog
= IF_FEATURE_REMOTE_LOG( (1 << OPTBIT_locallog
)) + 0,
347 OPT_circularlog
= IF_FEATURE_IPC_SYSLOG( (1 << OPTBIT_circularlog
)) + 0,
348 OPT_dup
= IF_FEATURE_SYSLOGD_DUP( (1 << OPTBIT_dup
)) + 0,
349 OPT_cfg
= IF_FEATURE_SYSLOGD_CFG( (1 << OPTBIT_cfg
)) + 0,
350 OPT_kmsg
= IF_FEATURE_KMSG_SYSLOG( (1 << OPTBIT_kmsg
)) + 0,
352 #define OPTION_STR "m:nO:l:St" \
353 IF_FEATURE_ROTATE_LOGFILE("s:" ) \
354 IF_FEATURE_ROTATE_LOGFILE("b:" ) \
355 IF_FEATURE_REMOTE_LOG( "R:*") \
356 IF_FEATURE_REMOTE_LOG( "L" ) \
357 IF_FEATURE_IPC_SYSLOG( "C::") \
358 IF_FEATURE_SYSLOGD_DUP( "D" ) \
359 IF_FEATURE_SYSLOGD_CFG( "f:" ) \
360 IF_FEATURE_KMSG_SYSLOG( "K" )
361 #define OPTION_DECL *opt_m, *opt_l \
362 IF_FEATURE_ROTATE_LOGFILE(,*opt_s) \
363 IF_FEATURE_ROTATE_LOGFILE(,*opt_b) \
364 IF_FEATURE_IPC_SYSLOG( ,*opt_C = NULL) \
365 IF_FEATURE_SYSLOGD_CFG( ,*opt_f = NULL)
366 #define OPTION_PARAM &opt_m, &(G.logFile.path), &opt_l \
367 IF_FEATURE_ROTATE_LOGFILE(,&opt_s) \
368 IF_FEATURE_ROTATE_LOGFILE(,&opt_b) \
369 IF_FEATURE_REMOTE_LOG( ,&remoteAddrList) \
370 IF_FEATURE_IPC_SYSLOG( ,&opt_C) \
371 IF_FEATURE_SYSLOGD_CFG( ,&opt_f)
374 #if ENABLE_FEATURE_SYSLOGD_CFG
375 static const CODE
* find_by_name(char *name
, const CODE
* c_set
)
377 for (; c_set
->c_name
; c_set
++) {
378 if (strcmp(name
, c_set
->c_name
) == 0)
384 static const CODE
* find_by_val(int val
, const CODE
* c_set
)
386 for (; c_set
->c_name
; c_set
++) {
387 if (c_set
->c_val
== val
)
393 #if ENABLE_FEATURE_SYSLOGD_CFG
394 static void parse_syslogdcfg(const char *file
)
398 /* tok[0] set of selectors */
399 /* tok[1] file name */
400 /* tok[2] has to be NULL */
404 parser
= config_open2(file
? file
: "/etc/syslog.conf",
405 file
? xfopen_for_read
: fopen_for_read
);
407 /* didn't find default /etc/syslog.conf */
408 /* proceed as if we built busybox without config support */
411 /* use ptr to ptr to avoid checking whether head was initialized */
412 pp_rule
= &G
.log_rules
;
413 /* iterate through lines of config, skipping comments */
414 while (config_read(parser
, tok
, 3, 2, "# \t", PARSE_NORMAL
| PARSE_MIN_DIE
)) {
418 /* unexpected trailing token? */
422 cur_rule
= *pp_rule
= xzalloc(sizeof(*cur_rule
));
424 cur_selector
= tok
[0];
425 /* iterate through selectors: "kern.info;kern.!err;..." */
429 uint8_t negated_prio
; /* "kern.!err" */
430 uint8_t single_prio
; /* "kern.=err" */
431 uint32_t facmap
; /* bitmap of enabled facilities */
432 uint8_t primap
; /* bitmap of enabled priorities */
435 next_selector
= strchr(cur_selector
, ';');
437 *next_selector
++ = '\0';
439 t
= strchr(cur_selector
, '.');
442 *t
++ = '\0'; /* separate facility from priority */
457 primap
= 0xff; /* all 8 log levels enabled */
460 code
= find_by_name(t
, bb_prioritynames
);
464 priority
= code
->c_val
;
465 if (priority
== INTERNAL_NOPRI
) {
466 /* ensure we take "enabled_facility_priomap[fac] &= 0" branch below */
469 priority
= 1 << priority
;
482 if (*cur_selector
== '*')
483 facmap
= (1<<LOG_NFACILITIES
) - 1;
488 /* iterate through facilities: "kern,daemon.<priospec>" */
490 next_facility
= strchr(t
, ',');
492 *next_facility
++ = '\0';
493 code
= find_by_name(t
, bb_facilitynames
);
496 /* "mark" is not a real facility, skip it */
497 if (code
->c_val
!= INTERNAL_MARK
)
498 facmap
|= 1<<(LOG_FAC(code
->c_val
));
503 /* merge result with previous selectors */
504 for (i
= 0; i
< LOG_NFACILITIES
; ++i
) {
505 if (!(facmap
& (1<<i
)))
508 cur_rule
->enabled_facility_priomap
[i
] &= primap
;
510 cur_rule
->enabled_facility_priomap
[i
] |= primap
;
513 cur_selector
= next_selector
;
514 } while (cur_selector
);
516 /* check whether current file name was mentioned in previous rules or
517 * as global logfile (G.logFile).
519 if (strcmp(G
.logFile
.path
, tok
[1]) == 0) {
520 cur_rule
->file
= &G
.logFile
;
523 /* temporarily use cur_rule as iterator, but *pp_rule still points
524 * to currently processing rule entry.
525 * NOTE: *pp_rule points to the current (and last in the list) rule.
527 for (cur_rule
= G
.log_rules
; cur_rule
!= *pp_rule
; cur_rule
= cur_rule
->next
) {
528 if (strcmp(cur_rule
->file
->path
, tok
[1]) == 0) {
529 /* found - reuse the same file structure */
530 (*pp_rule
)->file
= cur_rule
->file
;
535 cur_rule
->file
= xzalloc(sizeof(*cur_rule
->file
));
536 cur_rule
->file
->fd
= -1;
537 cur_rule
->file
->path
= xstrdup(tok
[1]);
539 pp_rule
= &cur_rule
->next
;
541 config_close(parser
);
545 bb_error_msg_and_die("error in '%s' at line %d",
546 file
? file
: "/etc/syslog.conf",
551 /* circular buffer variables/structures */
552 #if ENABLE_FEATURE_IPC_SYSLOG
554 #if CONFIG_FEATURE_IPC_SYSLOG_BUFFER_SIZE < 4
555 #error Sorry, you must set the syslogd buffer size to at least 4KB.
556 #error Please check CONFIG_FEATURE_IPC_SYSLOG_BUFFER_SIZE
559 /* our shared key (syslogd.c and logread.c must be in sync) */
560 enum { KEY_ID
= 0x414e4547 }; /* "GENA" */
562 static void ipcsyslog_cleanup(void)
568 shmctl(G
.shmid
, IPC_RMID
, NULL
);
570 if (G
.s_semid
!= -1) {
571 semctl(G
.s_semid
, 0, IPC_RMID
, 0);
575 static void ipcsyslog_init(void)
578 printf("shmget(%x, %d,...)\n", (int)KEY_ID
, G
.shm_size
);
580 G
.shmid
= shmget(KEY_ID
, G
.shm_size
, IPC_CREAT
| 0644);
582 bb_simple_perror_msg_and_die("shmget");
585 G
.shbuf
= shmat(G
.shmid
, NULL
, 0);
586 if (G
.shbuf
== (void*) -1L) { /* shmat has bizarre error return */
587 bb_simple_perror_msg_and_die("shmat");
590 memset(G
.shbuf
, 0, G
.shm_size
);
591 G
.shbuf
->size
= G
.shm_size
- offsetof(struct shbuf_ds
, data
) - 1;
592 /*G.shbuf->tail = 0;*/
594 /* we'll trust the OS to set initial semval to 0 (let's hope) */
595 G
.s_semid
= semget(KEY_ID
, 2, IPC_CREAT
| IPC_EXCL
| 1023);
596 if (G
.s_semid
== -1) {
597 if (errno
== EEXIST
) {
598 G
.s_semid
= semget(KEY_ID
, 2, 0);
602 bb_simple_perror_msg_and_die("semget");
606 /* Write message to shared mem buffer */
607 static void log_to_shmem(const char *msg
)
609 int old_tail
, new_tail
;
612 if (semop(G
.s_semid
, G
.SMwdn
, 3) == -1) {
613 bb_simple_perror_msg_and_die("SMwdn");
616 /* Circular Buffer Algorithm:
617 * --------------------------
618 * tail == position where to store next syslog message.
619 * tail's max value is (shbuf->size - 1)
620 * Last byte of buffer is never used and remains NUL.
622 len
= strlen(msg
) + 1; /* length with NUL included */
624 old_tail
= G
.shbuf
->tail
;
625 new_tail
= old_tail
+ len
;
626 if (new_tail
< G
.shbuf
->size
) {
627 /* store message, set new tail */
628 memcpy(G
.shbuf
->data
+ old_tail
, msg
, len
);
629 G
.shbuf
->tail
= new_tail
;
631 /* k == available buffer space ahead of old tail */
632 int k
= G
.shbuf
->size
- old_tail
;
633 /* copy what fits to the end of buffer, and repeat */
634 memcpy(G
.shbuf
->data
+ old_tail
, msg
, k
);
640 if (semop(G
.s_semid
, G
.SMwup
, 1) == -1) {
641 bb_simple_perror_msg_and_die("SMwup");
644 printf("tail:%d\n", G
.shbuf
->tail
);
647 static void ipcsyslog_cleanup(void) {}
648 static void ipcsyslog_init(void) {}
649 void log_to_shmem(const char *msg
);
650 #endif /* FEATURE_IPC_SYSLOG */
652 #if ENABLE_FEATURE_KMSG_SYSLOG
653 static void kmsg_init(void)
655 G
.kmsgfd
= xopen("/dev/kmsg", O_WRONLY
);
658 * kernel < 3.5 expects single char printk KERN_* priority prefix,
659 * from 3.5 onwards the full syslog facility/priority format is supported
661 if (get_linux_version_code() < KERNEL_VERSION(3,5,0))
662 G
.primask
= LOG_PRIMASK
;
667 static void kmsg_cleanup(void)
669 if (ENABLE_FEATURE_CLEAN_UP
)
673 /* Write message to /dev/kmsg */
674 static void log_to_kmsg(int pri
, const char *msg
)
677 * kernel < 3.5 expects single char printk KERN_* priority prefix,
678 * from 3.5 onwards the full syslog facility/priority format is supported
682 full_write(G
.kmsgfd
, G
.printbuf
, sprintf(G
.printbuf
, "<%d>%s\n", pri
, msg
));
685 static void kmsg_init(void) {}
686 static void kmsg_cleanup(void) {}
687 static void log_to_kmsg(int pri UNUSED_PARAM
, const char *msg UNUSED_PARAM
) {}
688 #endif /* FEATURE_KMSG_SYSLOG */
690 /* Print a message to the log file. */
691 static void log_locally(time_t now
, char *msg
, logFile_t
*log_file
)
693 #ifdef SYSLOGD_WRLOCK
696 int len
= strlen(msg
);
698 /* fd can't be 0 (we connect fd 0 to /dev/log socket) */
699 /* fd is 1 if "-O -" is in use */
700 if (log_file
->fd
> 1) {
701 /* Reopen log files every second. This allows admin
702 * to delete the files and not worry about restarting us.
703 * This costs almost nothing since it happens
704 * _at most_ once a second for each file, and happens
705 * only when each file is actually written.
709 if (log_file
->last_log_time
!= now
) {
710 log_file
->last_log_time
= now
;
715 else if (log_file
->fd
== 1) {
716 /* We are logging to stdout: do nothing */
719 if (LONE_DASH(log_file
->path
)) {
721 /* log_file->isRegular = 0; - already is */
724 log_file
->fd
= open(log_file
->path
, O_WRONLY
| O_CREAT
725 | O_NOCTTY
| O_APPEND
| O_NONBLOCK
,
727 if (log_file
->fd
< 0) {
728 /* cannot open logfile? - print to /dev/console then */
729 int fd
= device_open(DEV_CONSOLE
, O_WRONLY
| O_NOCTTY
| O_NONBLOCK
);
731 fd
= 2; /* then stderr, dammit */
732 full_write(fd
, msg
, len
);
737 #if ENABLE_FEATURE_ROTATE_LOGFILE
740 log_file
->isRegular
= (fstat(log_file
->fd
, &statf
) == 0 && S_ISREG(statf
.st_mode
));
741 /* bug (mostly harmless): can wrap around if file > 4gb */
742 log_file
->size
= statf
.st_size
;
748 #ifdef SYSLOGD_WRLOCK
749 fl
.l_whence
= SEEK_SET
;
753 fcntl(log_file
->fd
, F_SETLKW
, &fl
);
756 #if ENABLE_FEATURE_ROTATE_LOGFILE
757 if (G
.logFileSize
&& log_file
->isRegular
&& log_file
->size
> G
.logFileSize
) {
758 if (G
.logFileRotate
) { /* always 0..99 */
759 int i
= strlen(log_file
->path
) + 3 + 1;
762 i
= G
.logFileRotate
- 1;
763 /* rename: f.8 -> f.9; f.7 -> f.8; ... */
765 sprintf(newFile
, "%s.%d", log_file
->path
, i
);
767 sprintf(oldFile
, "%s.%d", log_file
->path
, --i
);
768 /* ignore errors - file might be missing */
769 rename(oldFile
, newFile
);
771 /* newFile == "f.0" now */
772 rename(log_file
->path
, newFile
);
775 /* We may or may not have just renamed the file away;
776 * if we didn't rename because we aren't keeping any backlog,
777 * then it's time to clobber the file. If we did rename it...,
778 * incredibly, if F and F.0 are hardlinks, POSIX _demands_
779 * that rename returns 0 but does not remove F!!!
780 * (hardlinked F/F.0 pair was observed after
781 * power failure during rename()).
782 * So ensure old file is gone in any case:
784 unlink(log_file
->path
);
785 #ifdef SYSLOGD_WRLOCK
787 fcntl(log_file
->fd
, F_SETLKW
, &fl
);
792 /* TODO: what to do on write errors ("disk full")? */
793 len
= full_write(log_file
->fd
, msg
, len
);
795 log_file
->size
+= len
;
797 full_write(log_file
->fd
, msg
, len
);
800 #ifdef SYSLOGD_WRLOCK
802 fcntl(log_file
->fd
, F_SETLKW
, &fl
);
806 static void parse_fac_prio_20(int pri
, char *res20
)
808 const CODE
*c_pri
, *c_fac
;
810 c_fac
= find_by_val(LOG_FAC(pri
) << 3, bb_facilitynames
);
812 c_pri
= find_by_val(LOG_PRI(pri
), bb_prioritynames
);
814 snprintf(res20
, 20, "%s.%s", c_fac
->c_name
, c_pri
->c_name
);
818 snprintf(res20
, 20, "<%d>", pri
);
821 /* len parameter is used only for "is there a timestamp?" check.
822 * NB: some callers cheat and supply len==0 when they know
823 * that there is no timestamp, short-circuiting the test. */
824 static void timestamp_and_log(int pri
, char *msg
, int len
)
826 char *timestamp
= NULL
;
829 /* Jan 18 00:11:22 msg... */
830 /* 01234567890123456 */
831 if (len
>= 16 && msg
[3] == ' ' && msg
[6] == ' '
832 && msg
[9] == ':' && msg
[12] == ':' && msg
[15] == ' '
834 if (!(option_mask32
& OPT_timestamp
)) {
835 /* use message timestamp */
842 #if ENABLE_FEATURE_SYSLOGD_PRECISE_TIMESTAMPS
847 timestamp
= ctime(&now
) + 4; /* skip day of week */
848 /* overwrite year by milliseconds, zero terminate */
849 sprintf(timestamp
+ 15, ".%03u", (unsigned)tv
.tv_usec
/ 1000u);
851 timestamp
[15] = '\0';
856 timestamp
= ctime(&now
) + 4; /* skip day of week */
858 timestamp
[15] = '\0';
861 if (option_mask32
& OPT_kmsg
) {
862 log_to_kmsg(pri
, msg
);
866 if (option_mask32
& OPT_small
)
867 sprintf(G
.printbuf
, "%s %s\n", timestamp
, msg
);
870 parse_fac_prio_20(pri
, res
);
871 sprintf(G
.printbuf
, "%s %.64s %s %s\n", timestamp
, G
.hostname
, res
, msg
);
874 /* Log message locally (to file or shared mem) */
875 #if ENABLE_FEATURE_SYSLOGD_CFG
879 uint8_t facility
= LOG_FAC(pri
);
880 uint8_t prio_bit
= 1 << LOG_PRI(pri
);
882 for (rule
= G
.log_rules
; rule
; rule
= rule
->next
) {
883 if (rule
->enabled_facility_priomap
[facility
] & prio_bit
) {
884 log_locally(now
, G
.printbuf
, rule
->file
);
892 if (LOG_PRI(pri
) < G
.logLevel
) {
893 #if ENABLE_FEATURE_IPC_SYSLOG
894 if ((option_mask32
& OPT_circularlog
) && G
.shbuf
) {
895 log_to_shmem(G
.printbuf
);
899 log_locally(now
, G
.printbuf
, &G
.logFile
);
903 static void timestamp_and_log_internal(const char *msg
)
906 if (ENABLE_FEATURE_REMOTE_LOG
&& !(option_mask32
& OPT_locallog
))
908 timestamp_and_log(LOG_SYSLOG
| LOG_INFO
, (char*)msg
, 0);
911 /* tmpbuf[len] is a NUL byte (set by caller), but there can be other,
912 * embedded NULs. Split messages on each of these NULs, parse prio,
913 * escape control chars and log each locally. */
914 static void split_escape_and_log(char *tmpbuf
, int len
)
921 char *q
= G
.parsebuf
;
922 int pri
= (LOG_USER
| LOG_NOTICE
);
925 /* Parse the magic priority number */
926 pri
= bb_strtou(p
+ 1, &p
, 10);
929 if (pri
& ~(LOG_FACMASK
| LOG_PRIMASK
))
930 pri
= (LOG_USER
| LOG_NOTICE
);
936 if (!(c
& ~0x1f) && c
!= '\t') {
938 c
+= '@'; /* ^@, ^A, ^B... */
945 timestamp_and_log(pri
, G
.parsebuf
, q
- G
.parsebuf
);
950 static void do_mark(int sig
)
952 if (G
.markInterval
) {
953 timestamp_and_log_internal("-- MARK --");
954 alarm(G
.markInterval
);
959 static int create_socket(void)
961 struct sockaddr_un sunx
;
965 memset(&sunx
, 0, sizeof(sunx
));
966 sunx
.sun_family
= AF_UNIX
;
968 /* Unlink old /dev/log or object it points to. */
969 /* (if it exists, bind will fail) */
970 strcpy(sunx
.sun_path
, _PATH_LOG
);
971 dev_log_name
= xmalloc_follow_symlinks(_PATH_LOG
);
973 safe_strncpy(sunx
.sun_path
, dev_log_name
, sizeof(sunx
.sun_path
));
976 unlink(sunx
.sun_path
);
978 sock_fd
= xsocket(AF_UNIX
, SOCK_DGRAM
, 0);
979 xbind(sock_fd
, (struct sockaddr
*) &sunx
, sizeof(sunx
));
980 chmod(_PATH_LOG
, 0666);
985 #if ENABLE_FEATURE_REMOTE_LOG
986 static int try_to_resolve_remote(remoteHost_t
*rh
)
988 if (!rh
->remoteAddr
) {
989 unsigned now
= monotonic_sec();
991 /* Don't resolve name too often - DNS timeouts can be big */
992 if ((now
- rh
->last_dns_resolve
) < DNS_WAIT_SEC
)
994 rh
->last_dns_resolve
= now
;
995 rh
->remoteAddr
= host2sockaddr(rh
->remoteHostname
, 514);
999 return xsocket(rh
->remoteAddr
->u
.sa
.sa_family
, SOCK_DGRAM
, 0);
1003 /* By doing init in a separate function we decrease stack usage
1006 static int NOINLINE
syslogd_init(char **argv
)
1011 #if ENABLE_FEATURE_REMOTE_LOG
1012 llist_t
*remoteAddrList
= NULL
;
1015 /* No non-option params */
1016 opts
= getopt32(argv
, "^"OPTION_STR
"\0""=0", OPTION_PARAM
);
1017 #if ENABLE_FEATURE_REMOTE_LOG
1018 while (remoteAddrList
) {
1019 remoteHost_t
*rh
= xzalloc(sizeof(*rh
));
1020 rh
->remoteHostname
= llist_pop(&remoteAddrList
);
1022 rh
->last_dns_resolve
= monotonic_sec() - DNS_WAIT_SEC
- 1;
1023 llist_add_to(&G
.remoteHosts
, rh
);
1028 if (opts
& OPT_mark
) // -m
1029 G
.markInterval
= xatou_range(opt_m
, 0, INT_MAX
/60) * 60;
1031 //if (opts & OPT_nofork) // -n
1032 //if (opts & OPT_outfile) // -O
1033 if (opts
& OPT_loglevel
) // -l
1034 G
.logLevel
= xatou_range(opt_l
, 1, 8);
1035 //if (opts & OPT_small) // -S
1036 #if ENABLE_FEATURE_ROTATE_LOGFILE
1037 if (opts
& OPT_filesize
) // -s
1038 G
.logFileSize
= xatou_range(opt_s
, 0, INT_MAX
/1024) * 1024;
1039 if (opts
& OPT_rotatecnt
) // -b
1040 G
.logFileRotate
= xatou_range(opt_b
, 0, 99);
1042 #if ENABLE_FEATURE_IPC_SYSLOG
1044 G
.shm_size
= xatoul_range(opt_C
, 4, INT_MAX
/1024) * 1024;
1046 /* If they have not specified remote logging, then log locally */
1047 if (ENABLE_FEATURE_REMOTE_LOG
&& !(opts
& OPT_remotelog
)) // -R
1048 option_mask32
|= OPT_locallog
;
1049 #if ENABLE_FEATURE_SYSLOGD_CFG
1050 parse_syslogdcfg(opt_f
);
1053 /* Store away localhost's name before the fork */
1054 G
.hostname
= safe_gethostname();
1055 *strchrnul(G
.hostname
, '.') = '\0';
1057 fd
= create_socket();
1059 if (opts
& OPT_circularlog
)
1062 if (opts
& OPT_kmsg
)
1065 if (!(opts
& OPT_nofork
)) {
1066 bb_daemonize_or_rexec(DAEMON_CHDIR_ROOT
, argv
);
1069 xmove_fd(fd
, STDIN_FILENO
);
1071 /* Set up signal handlers (so that they interrupt read()) */
1072 signal_no_SA_RESTART_empty_mask(SIGTERM
, record_signo
);
1073 signal_no_SA_RESTART_empty_mask(SIGINT
, record_signo
);
1074 //signal_no_SA_RESTART_empty_mask(SIGQUIT, record_signo);
1075 signal(SIGHUP
, SIG_IGN
);
1077 signal(SIGALRM
, do_mark
);
1078 alarm(G
.markInterval
);
1083 int syslogd_main(int argc
, char **argv
) MAIN_EXTERNALLY_VISIBLE
;
1084 int syslogd_main(int argc UNUSED_PARAM
, char **argv
)
1087 #if ENABLE_FEATURE_REMOTE_LOG
1090 #if ENABLE_FEATURE_SYSLOGD_DUP
1095 #define recvbuf (G.recvbuf)
1099 opts
= syslogd_init(argv
);
1101 timestamp_and_log_internal("syslogd started: BusyBox v" BB_VER
);
1102 write_pidfile_std_path_and_ext("syslogd");
1104 #if ENABLE_FEATURE_SYSLOGD_DUP
1105 recvbuf
= G
.recvbuf
;
1107 while (!bb_got_signal
) {
1110 #if ENABLE_FEATURE_SYSLOGD_DUP
1112 if (recvbuf
== G
.recvbuf
)
1113 recvbuf
= G
.recvbuf
+ MAX_READ
;
1115 recvbuf
= G
.recvbuf
;
1118 sz
= read(STDIN_FILENO
, recvbuf
, MAX_READ
- 1);
1121 bb_perror_msg("read from %s", _PATH_LOG
);
1125 /* Drop trailing '\n' and NULs (typically there is one NUL) */
1129 /* man 3 syslog says: "A trailing newline is added when needed".
1130 * However, neither glibc nor uclibc do this:
1131 * syslog(prio, "test") sends "test\0" to /dev/log,
1132 * syslog(prio, "test\n") sends "test\n\0".
1133 * IOW: newline is passed verbatim!
1134 * I take it to mean that it's syslogd's job
1135 * to make those look identical in the log files. */
1136 if (recvbuf
[sz
-1] != '\0' && recvbuf
[sz
-1] != '\n')
1140 #if ENABLE_FEATURE_SYSLOGD_DUP
1141 if ((opts
& OPT_dup
) && (sz
== last_sz
))
1142 if (memcmp(last_buf
, recvbuf
, sz
) == 0)
1146 #if ENABLE_FEATURE_REMOTE_LOG
1147 /* Stock syslogd sends it '\n'-terminated
1148 * over network, mimic that */
1151 /* We are not modifying log messages in any way before send */
1152 /* Remote site cannot trust _us_ anyway and need to do validation again */
1153 for (item
= G
.remoteHosts
; item
!= NULL
; item
= item
->link
) {
1154 remoteHost_t
*rh
= (remoteHost_t
*)item
->data
;
1156 if (rh
->remoteFD
== -1) {
1157 rh
->remoteFD
= try_to_resolve_remote(rh
);
1158 if (rh
->remoteFD
== -1)
1162 /* Send message to remote logger.
1163 * On some errors, close and set remoteFD to -1
1164 * so that DNS resolution is retried.
1166 if (sendto(rh
->remoteFD
, recvbuf
, sz
+1,
1167 MSG_DONTWAIT
| MSG_NOSIGNAL
,
1168 &(rh
->remoteAddr
->u
.sa
), rh
->remoteAddr
->len
) == -1
1172 case ENOTCONN
: /* paranoia */
1174 close(rh
->remoteFD
);
1176 free(rh
->remoteAddr
);
1177 rh
->remoteAddr
= NULL
;
1182 if (!ENABLE_FEATURE_REMOTE_LOG
|| (opts
& OPT_locallog
)) {
1183 recvbuf
[sz
] = '\0'; /* ensure it *is* NUL terminated */
1184 split_escape_and_log(recvbuf
, sz
);
1186 } /* while (!bb_got_signal) */
1188 timestamp_and_log_internal("syslogd exiting");
1189 remove_pidfile_std_path_and_ext("syslogd");
1190 ipcsyslog_cleanup();
1191 if (opts
& OPT_kmsg
)
1193 kill_myself_with_sig(bb_got_signal
);
1197 /* Clean up. Needed because we are included from syslogd_and_logger.c */
1200 #undef SYSLOGD_WRLOCK