Implement RFC5424 syslog version 1.

This commit is contained in:
Jonas 'Sortie' Termansen 2022-01-05 21:41:44 +01:00
parent 3c43f71084
commit ac9c24219b
6 changed files with 38 additions and 66 deletions

View File

@ -560,7 +560,6 @@ sys/dnsconfig/setdnsconfig.o \
sys/ioctl/ioctl.o \ sys/ioctl/ioctl.o \
sys/kernelinfo/kernelinfo.o \ sys/kernelinfo/kernelinfo.o \
syslog/closelog.o \ syslog/closelog.o \
syslog/connectlog.o \
sys/futex/futex.o \ sys/futex/futex.o \
syslog/openlog.o \ syslog/openlog.o \
syslog/setlogmask.o \ syslog/setlogmask.o \

View File

@ -85,13 +85,11 @@ extern "C" {
#if defined(__is_sortix_libc) #if defined(__is_sortix_libc)
extern char* __syslog_identity; extern char* __syslog_identity;
extern int __syslog_facility; extern int __syslog_facility;
extern int __syslog_fd;
extern int __syslog_mask; extern int __syslog_mask;
extern int __syslog_option; extern int __syslog_option;
#endif #endif
void closelog(void); void closelog(void);
int connectlog(void);
void openlog(const char*, int, int); void openlog(const char*, int, int);
int setlogmask(int); int setlogmask(int);
__attribute__ ((__format__ (__printf__, 2, 3))) __attribute__ ((__format__ (__printf__, 2, 3)))

View File

@ -22,9 +22,4 @@
void closelog(void) void closelog(void)
{ {
if ( 0 <= __syslog_fd )
{
close(__syslog_fd);
__syslog_fd = -1;
}
} }

View File

@ -1,26 +0,0 @@
/*
* Copyright (c) 2014 Jonas 'Sortie' Termansen.
*
* Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above
* copyright notice and this permission notice appear in all copies.
*
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*
* syslog/connectlog.c
* Returns a file descriptor to the system log.
*/
#include <fcntl.h>
#include <syslog.h>
int connectlog(void)
{
return open("/dev/tty", O_WRONLY | O_CLOEXEC);
}

View File

@ -30,8 +30,4 @@ void openlog(const char* identity, int option, int facility)
// Remember the option and facility parameters for later use. // Remember the option and facility parameters for later use.
__syslog_option = option; __syslog_option = option;
__syslog_facility = facility; __syslog_facility = facility;
// Connect to the system more immediately if we are asked to and need to.
if ( (option & LOG_NDELAY) && __syslog_fd < 0 )
__syslog_fd = connectlog();
} }

View File

@ -1,5 +1,5 @@
/* /*
* Copyright (c) 2014 Jonas 'Sortie' Termansen. * Copyright (c) 2014, 2022 Jonas 'Sortie' Termansen.
* *
* Permission to use, copy, modify, and distribute this software for any * Permission to use, copy, modify, and distribute this software for any
* purpose with or without fee is hereby granted, provided that the above * purpose with or without fee is hereby granted, provided that the above
@ -14,60 +14,70 @@
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
* *
* syslog/vsyslog.c * syslog/vsyslog.c
* Logs a condition to the system log. * Logs an event to the system log.
*/ */
#include <sys/types.h>
#include <limits.h>
#include <stdarg.h> #include <stdarg.h>
#include <stdint.h>
#include <stdio.h> #include <stdio.h>
#include <syslog.h> #include <syslog.h>
#include <time.h> #include <time.h>
#include <unistd.h> #include <unistd.h>
// TODO: The Sortix <limits.h> doesn't expose this at the moment.
#if !defined(HOST_NAME_MAX) && defined(__sortix__)
#include <sortix/limits.h>
#endif
char* __syslog_identity = NULL; char* __syslog_identity = NULL;
int __syslog_facility = LOG_USER; int __syslog_facility = LOG_USER;
int __syslog_fd = -1;
int __syslog_mask = LOG_UPTO(LOG_DEBUG); int __syslog_mask = LOG_UPTO(LOG_DEBUG);
int __syslog_option = 0; int __syslog_option = 0;
// TODO: The transmitted string might be delivered in chunks using this dprintf
// approach (plus there are multiple dprintf calls). We should buffer the
// string fully before transmitting it.
// TODO: The log entry format here is just whatever some other system does. We
// should work out the Sortix system log semantics and adapt this to that.
void vsyslog(int priority, const char* format, va_list ap) void vsyslog(int priority, const char* format, va_list ap)
{ {
// Drop the event if it doesn't fit the current priority mask. // Drop the event if it doesn't fit the current priority mask.
if ( !(LOG_MASK(LOG_PRI(priority)) & __syslog_mask) ) if ( !(LOG_MASK(LOG_PRI(priority)) & __syslog_mask) )
return; return;
// Connect to the system log if a connection hasn't yet been established.
if ( __syslog_fd < 0 && (__syslog_fd = connectlog()) < 0 )
return;
// If no facility is given we'll use the default facility from openlog. // If no facility is given we'll use the default facility from openlog.
if ( !LOG_FAC(priority) ) if ( !LOG_FAC(priority) )
priority |= __syslog_facility; priority |= __syslog_facility;
// Prepare a timestamp for the log event. // Gather the log event metadata.
int version = 1; // RFC 5424
struct timespec now; struct timespec now;
clock_gettime(CLOCK_REALTIME, &now); clock_gettime(CLOCK_REALTIME, &now);
struct tm tm; struct tm tm;
gmtime_r(&now.tv_sec, &tm); gmtime_r(&now.tv_sec, &tm);
char timestamp[32]; char timeformat[64];
strftime(timestamp, sizeof(timestamp), "%b %e %T", &tm); snprintf(timeformat, sizeof(timeformat),
"%%FT%%T.%06liZ", now.tv_nsec / 1000);
// Include the process id of the current process if requested. char timestamp[64];
pid_t pid = (__syslog_option & LOG_PID) ? getpid() : 0; strftime(timestamp, sizeof(timestamp), timeformat, &tm);
char hostname[HOST_NAME_MAX + 1] = "-";
gethostname(hostname, sizeof(hostname));
const char* identity = __syslog_identity ? __syslog_identity : "-";
char pidstr[3 * sizeof(pid_t)] = "-";
if ( __syslog_option & LOG_PID )
snprintf(pidstr, sizeof(pidstr), "%"PRIdPID, getpid());
const char* msgid = "-";
const char* structured_data = "-";
// Transmit the event to the system log. // Transmit the event to the system log.
dprintf(__syslog_fd, "<%d>%s %s%s%.0jd%s: ", flockfile(stderr);
priority, fprintf(stderr, "<%d>%d %s %s %s %s %s %s ",
timestamp, priority,
__syslog_identity ? __syslog_identity : "", version,
"[" + !pid, (intmax_t) pid, "]" + !pid); timestamp,
vdprintf(__syslog_fd, format, ap); hostname,
dprintf(__syslog_fd, "\n"); identity,
pidstr,
msgid,
structured_data);
vfprintf(stderr, format, ap);
fputc('\n', stderr);
funlockfile(stderr);
} }