mirrors/bird
mirrors/bird
0
0
Fork 0
mirror of https://gitlab.nic.cz/labs/bird.git synced 2024-12-22 09:41:54 +00:00
Code Releases Activity

Logging now doesn't lock with each message

Browse Source 
The original logging routines were locking a common mutex. This led to
massive underperformance and unwanted serialization when heavily logging
due to lock contention. Now the logging is lockless, though still
serializing on write() syscalls to the same filedescriptor.

This change also brings in a persistent logging channel structures and
thus avoids writing into active configuration data structures during
regular run.
This commit is contained in:
Maria Matejka 2023-08-21 18:44:10 +02:00
parent d64a37e124
commit d089f1b0a7
10 changed files with 357 additions and 124 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
conf/conf.c
View File

@ -101,7 +101,6 @@ config_alloc(const char *name)
init_list(&c->tests);
init_list(&c->symbols);
c->mrtdump_file = -1; /* Hack, this should be sysdep-specific */
c->pool = p;
c->mem = l;
c->file_name = ndup;

2
conf/conf.h
View File

@ -25,7 +25,7 @@ struct config {
list tests; /* Configured unit tests (f_bt_test_suite) */
list symbols; /* Configured symbols in config order */
int mrtdump_file; /* Configured MRTDump file (sysdep, fd in unix) */
struct rfile *mrtdump_file; /* Configured MRTDump file */
const char *syslog_name; /* Name used for syslog (NULL -> no syslog) */
struct symbol *def_tables[NET_MAX]; /* Default routing tables for each network */
struct iface_patt *router_id_from; /* Configured list of router ID iface patterns */

1
lib/locking.h
View File

@ -21,6 +21,7 @@ struct lock_order {
struct domain_generic *service;
struct domain_generic *rtable;
struct domain_generic *attrs;
struct domain_generic *logging;
struct domain_generic *resource;
};

3
sysdep/unix/config.Y
View File

@ -55,7 +55,6 @@ log_file:
this_log->rf = rf_open(new_config->pool, $1, RF_APPEND);
if (!this_log->rf) cf_error("Unable to open log file '%s': %m", $1);
}
this_log->pos = -1;
this_log->filename = $1;
}
| SYSLOG syslog_name { this_log->rf = NULL; new_config->syslog_name = $2; }
@ -94,7 +93,7 @@ mrtdump_base:
{
struct rfile *f = rf_open(new_config->pool, $2, RF_APPEND);
if (!f) cf_error("Unable to open MRTDump file '%s': %m", $2);
new_config->mrtdump_file = rf_fileno(f);
new_config->mrtdump_file = f;
}
}
;

13
sysdep/unix/io-loop.c
View File

@ -1184,7 +1184,6 @@ bird_thread_sync_all(struct bird_thread_syncer *sync,
void (*done)(struct bird_thread_syncer *), const char *name)
{
sync->lock = DOMAIN_NEW(control);
DOMAIN_SETUP(control, sync->lock, name, NULL);
LOCK_DOMAIN(control, sync->lock);
sync->pool = rp_new(&root_pool, sync->lock.control, name);
@ -1350,18 +1349,6 @@ cmd_show_threads_done(struct bird_thread_syncer *sync)
void
cmd_show_threads(int show_loops)
{
uint total_threads = 0, total_loops = 0;
for (int i=0; i<2; i++)
{
struct birdloop_pickup_group *group = &pickup_groups[i];
LOCK_DOMAIN(attrs, group->domain);
total_threads += group->thread_count;
total_loops += group->loop_count;
UNLOCK_DOMAIN(attrs, group->domain);
}
/* Total number of lines must be recalculated when changing the code! */
struct bird_thread_show_data *tsd = mb_allocz(&root_pool, sizeof(struct bird_thread_show_data));
tsd->cli = this_cli;
tsd->show_loops = show_loops;

61
sysdep/unix/io.c
View File

@ -18,6 +18,7 @@
#include <time.h>
#include <sys/time.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/socket.h>
#include <sys/uio.h>
#include <sys/un.h>
@ -64,7 +65,9 @@
struct rfile {
resource r;
struct stat stat;
int fd;
_Atomic off_t pos;
};
struct rfile rf_stderr = {
@ -96,8 +99,8 @@ static struct resclass rf_class = {
NULL
};
struct rfile *
rf_open(pool *p, const char *name, enum rf_mode mode)
static int
rf_open_get_fd(const char *name, enum rf_mode mode)
{
int omode = S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH;
int flags;
@ -112,19 +115,65 @@ rf_open(pool *p, const char *name, enum rf_mode mode)
bug("rf_open() must have the mode set");
}
int fd = open(name, flags, omode);
return open(name, flags, omode);
}
static void
rf_stat(struct rfile *r)
{
if (fstat(r->fd, &r->stat) < 0)
die("fstat() failed: %m");
}
struct rfile *
rf_open(pool *p, const char *name, enum rf_mode mode)
{
int fd = rf_open_get_fd(name, mode);
if (fd < 0)
return NULL; /* The caller takes care of printing %m. */
struct rfile *r = ralloc(p, &rf_class);
r->fd = fd;
switch (mode)
{
case RF_APPEND:
rf_stat(r);
r->pos = S_ISREG(r->stat.st_mode) ? r->stat.st_size : 0;
break;
default:
bug("rf_open() must have the mode set");
}
return r;
}
int
rf_fileno(struct rfile *f)
off_t
rf_size(struct rfile *r)
{
return f->fd;
return atomic_load_explicit(&r->pos, memory_order_relaxed);
}
int
rf_same(struct rfile *a, struct rfile *b)
{
rf_stat(a);
rf_stat(b);
return
(a->stat.st_mode == b->stat.st_mode) &&
(a->stat.st_dev == b->stat.st_dev) &&
(a->stat.st_ino == b->stat.st_ino);
}
void
rf_write(struct rfile *r, const void *buf, size_t count)
{
while ((write(r->fd, buf, count) < 0) && (errno == EINTR))
;
atomic_fetch_add_explicit(&r->pos, count, memory_order_relaxed);
}

383
sysdep/unix/log.c
View File

@ -20,8 +20,6 @@
#include <stdlib.h>
#include <stdarg.h>
#include <time.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <errno.h>
@ -31,25 +29,31 @@
#include "lib/string.h"
#include "lib/lists.h"
#include "sysdep/unix/unix.h"
#include "sysdep/unix/io-loop.h"
static pool *log_pool;
static struct rfile *dbg_rf;
static list *current_log_list;
static char *current_syslog_name; /* NULL -> syslog closed */
static char *current_syslog_name = NULL; /* NULL -> syslog closed */
_Atomic uint max_thread_id = ATOMIC_VAR_INIT(1);
_Thread_local uint this_thread_id;
#include <pthread.h>
static pthread_mutex_t log_mutex;
static inline void log_lock(void) { pthread_mutex_lock(&log_mutex); }
static inline void log_unlock(void) { pthread_mutex_unlock(&log_mutex); }
DEFINE_DOMAIN(logging);
static DOMAIN(logging) log_domain;
#define log_lock() LOCK_DOMAIN(logging, log_domain);
#define log_unlock() UNLOCK_DOMAIN(logging, log_domain);
static struct log_channel * _Atomic global_logs;
/* Logging flags to validly prepare logging messages */
#define LOGGING_TO_TERMINAL 0x1
#define LOGGING_TO_FILE 0x2
static _Atomic uint logging_flags;
static _Atomic uint logging_mask;
#ifdef HAVE_SYSLOG_H
#include <sys/syslog.h>
@ -81,53 +85,76 @@ static char *class_names[] = {
"BUG"
};
static inline off_t
log_size(struct log_config *l)
struct log_channel {
struct log_channel * _Atomic next;
const char *filename; /* Log filename */
const char *backup; /* Secondary filename (for log rotation) */
struct rfile * _Atomic rf; /* File handle */
off_t limit; /* Log size limit */
_Atomic uint mask; /* Classes to log */
uint new_mask; /* Pending new mask */
uint terminal:1; /* Is terminal */
};
struct log_thread_syncer {
struct bird_thread_syncer sync;
struct log_channel *lc_close;
struct rfile *rf_close;
const char *name;
event lts_event;
};
static void
lts_done(struct bird_thread_syncer *sync)
{
struct stat st;
return (!fstat(rf_fileno(l->rf), &st) && S_ISREG(st.st_mode)) ? st.st_size : 0;
struct log_thread_syncer *lts = SKIP_BACK(struct log_thread_syncer, sync, sync);
log_lock();
if (lts->lc_close)
{
lts->rf_close = atomic_load_explicit(&lts->lc_close->rf, memory_order_relaxed);
mb_free(lts->lc_close);
}
if (lts->rf_close && lts->rf_close != &rf_stderr)
rfree(lts->rf_close);
mb_free(lts);
log_unlock();
}
static void
log_close(struct log_config *l)
lts_event(void *_lts)
{
if (l->rf != &rf_stderr)
rfree(l->rf);
l->rf = NULL;
struct log_thread_syncer *lts = _lts;
bird_thread_sync_all(&lts->sync, NULL, lts_done, lts->name);
}
static int
log_open(struct log_config *l)
static void
lts_request(struct log_channel *lc_close, struct rfile *rf_close, const char *name)
{
l->rf = rf_open(config->pool, l->filename, RF_APPEND);
if (!l->rf)
{
/* Well, we cannot do much in case of error as log is closed */
l->mask = 0;
return -1;
}
l->pos = log_size(l);
return 0;
struct log_thread_syncer *lts = mb_allocz(log_pool, sizeof *lts);
lts->lc_close = lc_close;
lts->rf_close = rf_close;
lts->name = name;
lts->lts_event = (event) { .hook = lts_event, .data = lts, };
ev_send_loop(&main_birdloop, &lts->lts_event);
}
static int
log_rotate(struct log_config *l)
static void
log_rotate(struct log_channel *lc)
{
log_close(l);
struct log_thread_syncer *lts = mb_allocz(log_pool, sizeof *lts);
/* If we cannot rename the logfile, we at least try to delete it
in order to continue logging and not exceeding logfile size */
if ((rename(l->filename, l->backup) < 0) &&
(unlink(l->filename) < 0))
{
l->mask = 0;
return -1;
}
if ((rename(lc->filename, lc->backup) < 0) && (unlink(lc->filename) < 0))
return lts_request(lc, NULL, "Log Rotate Failed");
return log_open(l);
struct rfile *rf = rf_open(log_pool, lc->filename, RF_APPEND);
if (!rf)
return lts_request(lc, NULL, "Log Rotate Failed");
lts_request(NULL, atomic_load_explicit(&lc->rf, memory_order_relaxed), "Log Rotate Close Old File");
atomic_store_explicit(&lc->rf, rf, memory_order_release);
}
#define LOG_MSG_OFFSET (TM_DATETIME_BUFFER_SIZE + 64)
@ -148,29 +175,40 @@ log_rotate(struct log_config *l)
void
log_commit(log_buffer *buf)
{
struct log_config *l;
if (buf->buf.pos == buf->buf.end)
#define TOO_LONG " ... <too long>"
memcpy(buf->buf.end - sizeof TOO_LONG, TOO_LONG, sizeof TOO_LONG);
#undef TOO_LONG
log_lock();
WALK_LIST(l, *current_log_list)
for (
struct log_channel *l = atomic_load_explicit(&global_logs, memory_order_acquire);
l;
l = atomic_load_explicit(&l->next, memory_order_acquire)
)
{
if (!(l->mask & (1 << buf->class)))
continue;
if (l->rf && buf->tm_pos)
{
*buf->buf.pos = '\n';
byte *begin = l->terminal_flag ? buf->buf.start : buf->tm_pos;
off_t msg_len = buf->buf.pos - begin + 1;
if (l->limit && (l->pos + msg_len > l->limit) && (log_rotate(l) < 0))
uint mask = atomic_load_explicit(&l->mask, memory_order_acquire);
if (!(mask & (1 << buf->class)))
continue;
l->pos += msg_len;
while ((write(rf_fileno(l->rf), buf->tm_pos, msg_len) < 0) && (errno == EINTR))
;
struct rfile *rf = atomic_load_explicit(&l->rf, memory_order_acquire);
if (rf && buf->tm_pos)
{
*buf->buf.pos = '\n';
byte *begin = l->terminal ? buf->buf.start : buf->tm_pos;
off_t msg_len = buf->buf.pos - begin + 1;
if (l->limit && (rf_size(rf) + msg_len > l->limit))
{
log_lock();
rf = atomic_load_explicit(&l->rf, memory_order_acquire);
if (rf_size(rf) + msg_len > l->limit)
{
log_rotate(l);
rf = atomic_load_explicit(&l->rf, memory_order_relaxed);
}
log_unlock();
}
rf_write(l->rf, buf->tm_pos, msg_len);
}
#ifdef HAVE_SYSLOG_H
else
@ -180,7 +218,6 @@ log_commit(log_buffer *buf)
}
#endif
}
log_unlock();
buf->msg_pos = buf->tm_pos = NULL;
}
@ -220,6 +257,10 @@ vlog(int class, const char *msg, va_list args)
{
static _Thread_local log_buffer buf;
/* No logging at all if nobody would receive the message either */
if (!(atomic_load_explicit(&logging_mask, memory_order_acquire) & (1 << class)))
return;
log_prepare(&buf, class);
buffer_vprint(&buf.buf, msg, args);
log_commit(&buf);
@ -328,7 +369,7 @@ debug(const char *msg, ...)
if (s < 0)
bug("Extremely long debug output, split it.");
write(rf_fileno(dbg_rf), buf, s);
rf_write(dbg_rf, buf, s);
}
va_end(args);
}
@ -345,7 +386,7 @@ void
debug_safe(const char *msg)
{
if (dbg_rf)
write(rf_fileno(dbg_rf), msg, strlen(msg));
rf_write(dbg_rf, msg, strlen(msg));
}
static list *
@ -397,68 +438,224 @@ default_log_list(int initial, const char **syslog_name)
void
log_switch(int initial, list *logs, const char *new_syslog_name)
{
struct log_config *l;
/* We should not manipulate with log list when other threads may use it */
if (initial)
{
log_domain = DOMAIN_NEW(logging);
log_lock();
log_pool = rp_new(&root_pool, log_domain.logging, "Log files");
#if HAVE_SYSLOG_H
/* Create syslog channel */
struct log_channel *lc = mb_alloc(log_pool, sizeof *lc);
*lc = (struct log_channel) {};
ASSERT_DIE(NULL == atomic_exchange_explicit(&global_logs, lc, memory_order_release));
#endif
log_unlock();
}
if (!logs || EMPTY_LIST(*logs))
logs = default_log_list(initial, &new_syslog_name);
/* Close the logs to avoid pinning them on disk when deleted */
if (current_log_list)
WALK_LIST(l, *current_log_list)
if (l->rf)
log_close(l);
ASSERT_DIE(logs);
/* Reopen the logs, needed for 'configure undo' */
uint flags = 0;
if (logs)
/* Prepare the new log configuration */
struct log_config *l;
WALK_LIST(l, *logs)
{
if (l->terminal_flag)
flags |= LOGGING_TO_TERMINAL;
if (l->filename && !l->rf)
log_open(l);
if (l->rf)
flags |= LOGGING_TO_FILE;
int erf = 0;
log_lock();
if (l->rf && (l->rf != &rf_stderr))
rmove(l->rf, log_pool);
else if (l->filename)
{
l->rf = rf_open(log_pool, l->filename, RF_APPEND);
erf = l->rf ? 0 : errno;
}
log_unlock();
if (erf)
log(L_ERR "Failed to open log file '%s': %M", l->filename, erf);
}
atomic_store_explicit(&logging_flags, flags, memory_order_release);
uint total_mask = 0;
uint flags = 0;
current_log_list = logs;
/* Update pre-existing log channels */
for (
struct log_channel * _Atomic *pprev = &global_logs, *ol;
ol = atomic_load_explicit(pprev, memory_order_acquire);
pprev = &ol->next)
{
ol->new_mask = 0;
if (ol->rf)
{
WALK_LIST(l, *logs)
if (l->rf && rf_same(l->rf, ol->rf))
{
/* Merge the mask */
ol->new_mask |= l->mask;
total_mask |= l->mask;
/* Merge flags */
flags |= LOGGING_TO_FILE;
if (l->terminal_flag)
{
flags |= LOGGING_TO_TERMINAL;
ol->terminal = 1;
}
/* The filehandle is no longer needed */
if (l->rf != &rf_stderr)
{
log_lock();
rfree(l->rf);
log_unlock();
}
l->rf = NULL;
}
}
else
WALK_LIST(l, *logs)
if (!l->filename && !l->rf)
{
ol->new_mask |= l->mask;
total_mask |= l->mask;
}
/* First only extend masks */
atomic_fetch_or_explicit(&ol->mask, ol->new_mask, memory_order_acq_rel);
}
atomic_fetch_or_explicit(&logging_mask, total_mask, memory_order_acq_rel);
/* Open new log channels */
WALK_LIST(l, *logs)
{
if (!l->rf)
continue;
/* Truly new log channel */
log_lock();
struct log_channel *lc = mb_alloc(log_pool, sizeof *lc);
log_unlock();
*lc = (struct log_channel) {
.filename = l->filename,
.backup = l->backup,
.rf = l->rf,
.limit = l->limit,
.new_mask = l->mask,
.terminal = l->terminal_flag,
};
total_mask |= l->mask;
/* Message preparation flags */
flags |= LOGGING_TO_FILE;
if (l->terminal_flag)
{
flags |= LOGGING_TO_TERMINAL;
lc->terminal = 1;
}
/* Now the file handle ownership is transferred to the log channel */
l->rf = NULL;
/* Find more */
for (struct log_config *ll = NODE_NEXT(l); NODE_VALID(ll); ll = NODE_NEXT(ll))
if (ll->filename && ll->rf && rf_same(lc->rf, ll->rf))
{
/* Merged with this channel */
lc->new_mask |= ll->mask;
total_mask |= ll->mask;
if (l->rf != &rf_stderr)
{
log_lock();
rfree(ll->rf);
log_unlock();
}
ll->rf = NULL;
}
atomic_store_explicit(&lc->mask, lc->new_mask, memory_order_release);
/* Insert into the main log list */
struct log_channel *head = atomic_load_explicit(&global_logs, memory_order_acquire);
do atomic_store_explicit(&lc->next, head, memory_order_release);
while (!atomic_compare_exchange_strong_explicit(
&global_logs, &head, lc,
memory_order_acq_rel, memory_order_acquire));
}
/* Merge overall flags */
atomic_fetch_or_explicit(&logging_flags, flags, memory_order_acq_rel);
atomic_fetch_or_explicit(&logging_mask, total_mask, memory_order_acq_rel);
/* Close end-of-life log channels */
for (struct log_channel * _Atomic *pprev = &global_logs,
*ol = atomic_load_explicit(pprev, memory_order_acquire);
ol; )
{
/* Store new mask after opening new files to minimize missing log message race conditions */
atomic_store_explicit(&ol->mask, ol->new_mask, memory_order_release);
/* Never close syslog channel */
if (ol->new_mask || !ol->rf)
{
pprev = &ol->next;
ol = atomic_load_explicit(pprev, memory_order_acquire);
}
else
{
/* This file has no logging set up, remove from list */
struct log_channel *next = atomic_load_explicit(&ol->next, memory_order_acquire);
atomic_store_explicit(pprev, next, memory_order_release);
/* Free the channel after all worker threads leave the critical section */
log_lock();
lts_request(ol, NULL, "Log Reconfigure Close Old File");
log_unlock();
/* Continue to next */
ol = next;
}
}
/* Set overall flags after files are closed */
atomic_store_explicit(&logging_flags, flags, memory_order_release);
atomic_store_explicit(&logging_mask, total_mask, memory_order_release);
#ifdef HAVE_SYSLOG_H
if (!bstrcmp(current_syslog_name, new_syslog_name))
goto done;
if (current_syslog_name)
if ((!current_syslog_name != !new_syslog_name)
|| bstrcmp(current_syslog_name, new_syslog_name))
{
closelog();
xfree(current_syslog_name);
current_syslog_name = NULL;
}
char *old_syslog_name = current_syslog_name;
if (new_syslog_name)
{
current_syslog_name = xstrdup(new_syslog_name);
openlog(current_syslog_name, LOG_CONS | LOG_NDELAY, LOG_DAEMON);
}
else
{
current_syslog_name = NULL;
closelog();
}
if (old_syslog_name)
xfree(old_syslog_name);
}
#endif
done:
/* Logs exchange done, let the threads log as before */
log_unlock();
}
void
log_init_debug(char *f)
{
clock_gettime(CLOCK_MONOTONIC, &dbg_time_start);
if (dbg_rf && dbg_rf != &rf_stderr)
close(rf_fileno(dbg_rf));
ASSERT_DIE(!dbg_rf);
if (!f)
dbg_rf = NULL;

2
sysdep/unix/main.c
View File

@ -896,12 +896,12 @@ main(int argc, char **argv)
times_update();
parse_args(argc, argv);
log_switch(1, NULL, NULL);
the_bird_lock();
random_init();
resource_init();
log_switch(1, NULL, NULL);
birdloop_init();
olock_init();
rt_init();

7
sysdep/unix/unix.h
View File

@ -120,7 +120,9 @@ enum rf_mode {
};
struct rfile *rf_open(struct pool *, const char *name, enum rf_mode mode);
int rf_fileno(struct rfile *f);
off_t rf_size(struct rfile *);
int rf_same(struct rfile *, struct rfile *);
void rf_write(struct rfile *, const void *, size_t);
extern struct rfile rf_stderr;
@ -138,10 +140,9 @@ void log_switch(int initial, list *l, const char *);
struct log_config {
node n;
uint mask; /* Classes to log */
struct rfile *rf; /* Resource for log file; NULL=syslog */
struct rfile *rf; /* File handle */
const char *filename; /* Log filename */
const char *backup; /* Secondary filename (for log rotation) */
off_t pos; /* Position/size of current log */
off_t limit; /* Log size limit */
int terminal_flag;
};

2
test/bt-utils.c
View File

@ -60,10 +60,10 @@ bt_bird_init(void)
{
if(bt_verbose)
log_init_debug("");
log_switch(bt_verbose != 0, NULL, NULL);
olock_init();
rt_init();
log_switch(1, NULL, NULL);
io_init();
if_init();
config_init();