1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
|
/* syslog_async is Copyright (c) 2007 Simon Kelley
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 dated June, 1991, or
(at your option) version 3 dated 29 June, 2007.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/un.h>
#include <sys/file.h>
#include <sys/syslog.h>
#include <netinet/in.h>
#include <signal.h>
#include <fcntl.h>
#include <sys/uio.h>
#include <sys/wait.h>
#include <netdb.h>
#include <string.h>
#include <time.h>
#include <unistd.h>
#include <errno.h>
#include <stdarg.h>
#include <stdlib.h>
#ifdef HAVE_PATHS_H
# include <paths.h>
#else
# define _PATH_LOG "/dev/log"
# define _PATH_CONSOLE "/dev/console"
#endif
#include <stdio.h>
#include <ctype.h>
#include "syslog_async.h"
#ifndef MSG_NOSIGNAL
# define MSG_NOSIGNAL 0
#endif
#ifndef LOG_PERROR
# define LOG_PERROR 0
#endif
#ifndef LOG_PRI
# define LOG_PRI(x) ((x) & LOG_PRIMASK)
#endif
/* From RFC 3164 */
#define MAX_MESSAGE 1024
#define DEF_BACKLOG 5
#define DEF_DELAY 1000 /* doesn't come into effect until backlog > 10 */
static int log_fac = LOG_USER;
static int log_opts = LOG_ODELAY;
static const char *log_tag = "syslog";
static int log_mask = 0xff;
static int log_backlog = DEF_BACKLOG;
static int log_delay = DEF_DELAY;
static int log_fd = -1;
static int entries_alloced = 0;
static int entries_lost = 0;
static int connection_good = 1;
struct log_entry {
int offset, length;
struct log_entry *next;
char payload[MAX_MESSAGE];
};
static struct log_entry *entries = NULL;
static struct log_entry *free_entries = NULL;
static int mksock(int type)
{
int flags;
int fd = socket(AF_UNIX, type, 0);
if (fd != -1)
{
if ((flags = fcntl(fd, F_GETFL)) == -1 ||
fcntl(fd, F_SETFL, flags | O_NONBLOCK) == -1 ||
(flags = fcntl(fd, F_GETFD)) == -1 ||
fcntl(fd, F_SETFD, flags | FD_CLOEXEC) == -1)
{
close(fd);
fd = -1;
}
}
return fd;
}
void openlog_async(const char *ident, int option, int facility)
{
if (ident)
log_tag = ident;
log_opts = option;
if (facility != 0 && (facility &~ LOG_FACMASK) == 0)
log_fac = facility;
if (log_opts & LOG_NDELAY)
log_fd = mksock(SOCK_DGRAM);
}
int setlogmask_async(int mask)
{
int old = log_mask;
if (mask != 0)
log_mask = mask;
return old;
}
void tunelog_async(int backlog, int delay)
{
/* we need at least one buffer, and the
delay calculations overflow for more than 99 */
if (backlog < 1)
backlog = 1;
else if (backlog > 99)
backlog = 99;
/* don't lose existing buffers */
if (backlog < entries_alloced)
log_backlog = entries_alloced;
else
log_backlog = backlog;
if (delay < 0)
log_delay = 0;
else if (delay > 1000)
log_delay = 1000;
else
log_delay = delay;
}
void closelog_async(void)
{
/* maybe last chance to flush */
log_write_async();
if (log_fd != -1)
{
close(log_fd);
log_fd = -1;
}
/* restore defaults */
log_fac = LOG_USER;
log_opts = LOG_ODELAY;
log_tag = "syslog";
log_mask = 0xff;
log_delay = DEF_DELAY;
if (entries_alloced < DEF_BACKLOG)
log_backlog = entries_alloced;
else
log_backlog = DEF_BACKLOG;
}
int log_fd_async(void)
{
return log_fd;
}
void log_write_async(void)
{
ssize_t rc;
int fd, tried_stream = 0;
struct log_entry *tmp;
#if MSG_NOSIGNAL == 0
void (*sigfun) (int sig) = signal (SIGPIPE, SIG_IGN);
#endif
while (entries)
{
if (log_fd == -1 &&
(log_fd = mksock(SOCK_DGRAM)) == -1)
goto fail;
connection_good = 1;
if ((rc = send(log_fd,
entries->payload + entries->offset,
entries->length,
MSG_NOSIGNAL)) != -1)
{
entries->length -= rc;
entries->offset += rc;
connection_good = 1;
if (entries->length == 0)
goto free;
continue;
}
if (errno == EINTR)
continue;
if (errno == EAGAIN)
break;
/* *BSD, returns this instead of blocking? */
if (errno == ENOBUFS)
{
connection_good = 0;
break;
}
/* A stream socket closed at the other end goes into EPIPE
forever, close and re-open. */
if (errno == EPIPE)
goto reopen_stream;
if (errno == ECONNREFUSED ||
errno == ENOTCONN ||
errno == EDESTADDRREQ ||
errno == ECONNRESET)
{
/* socket went (syslogd down?), try and reconnect. If we fail,
stop trying until the next call to my_syslog()
ECONNREFUSED -> connection went down
ENOTCONN -> nobody listening
(ECONNRESET, EDESTADDRREQ are *BSD equivalents) */
struct sockaddr_un logaddr;
logaddr.sun_family = AF_UNIX;
strncpy(logaddr.sun_path, _PATH_LOG, sizeof(logaddr.sun_path));
/* Got connection back? try again. */
if (connect(log_fd, (struct sockaddr *)&logaddr,
sizeof(logaddr)) != -1)
continue;
/* errors from connect which mean we should keep trying */
if (errno == ENOENT ||
errno == EALREADY ||
errno == ECONNREFUSED ||
errno == EISCONN ||
errno == EINTR ||
errno == EAGAIN)
{
/* try again on next syslog() call */
connection_good = 0;
break;
}
/* we start with a SOCK_DGRAM socket, but syslog may want SOCK_STREAM */
if (!tried_stream && errno == EPROTOTYPE)
{
reopen_stream:
tried_stream = 1;
close(log_fd);
if ((log_fd = mksock(SOCK_STREAM)) != -1)
continue;
}
}
fail:
tried_stream = 0;
/* give up - try to write to console if we've been asked
take care not to block in open() or write() */
if ((log_opts & LOG_CONS) &&
(fd = open(_PATH_CONSOLE, O_WRONLY | O_NONBLOCK, 0)) != -1)
{
char *start = strchr(entries->payload, '>') + 1;
int flags = fcntl(fd, F_GETFL);
if (flags != -1)
fcntl(fd, F_SETFL, flags | O_NONBLOCK);
entries->length -= start - entries->payload;
/* move down to remove the tag, and make room for the \r\n */
memmove(entries->payload, start, entries->length);
entries->payload[entries->length - 1] = '\r';
entries->payload[entries->length] = '\n';
write(fd, entries->payload, entries->length + 1);
close(fd);
}
free:
tmp = entries;
entries = tmp->next;
tmp->next = free_entries;
free_entries = tmp;
if (entries_lost != 0)
{
int e = entries_lost;
entries_lost = 0; /* avoid wild recursion */
syslog_async(LOG_WARNING, "async_syslog overflow: %d log entries lost", e);
}
continue;
}
#if MSG_NOSIGNAL == 0
signal (SIGPIPE, sigfun);
#endif
}
static int find_percent_m(const char *format)
{
const char *p = format;
while (*p && (p = strchr(p, '%')))
if (p[1] == 'm')
return p - format;
else
p++;
return -1;
}
static void vsyslog_async_logger(int priority, int ec,
const char *format, va_list ap)
{
struct log_entry *entry;
time_t time_now;
char *p, *q, *r;
size_t len;
char fmtbuf[MAX_MESSAGE];
int mpos;
if (!(log_mask & LOG_MASK(LOG_PRI(priority))) || (priority &~ (LOG_PRIMASK|LOG_FACMASK)))
return;
if ((entry = free_entries))
free_entries = entry->next;
else if (entries_alloced < log_backlog && (entry = malloc(sizeof(struct log_entry))))
entries_alloced++;
if (!entry)
entries_lost++;
else
{
/* add to end of list, consumed from the start */
entry->next = NULL;
if (!entries)
entries = entry;
else
{
struct log_entry *tmp;
for (tmp = entries; tmp->next; tmp = tmp->next);
tmp->next = entry;
}
time(&time_now);
p = entry->payload;
if (!(priority & LOG_FACMASK))
priority |= log_fac;
p += sprintf(p, "<%d>", priority);
q = p;
if (log_opts & LOG_PID)
p += sprintf(p, "%.15s %s[%d]: ", ctime(&time_now) + 4, log_tag, getpid());
else
p += sprintf(p, "%.15s %s: ", ctime(&time_now) + 4, log_tag);
len = p - entry->payload;
if ((mpos = find_percent_m(format)) != -1 && mpos < MAX_MESSAGE - len) {
const char *errmsg;
int errlen;
int fmtlen;
int rest_len;
memcpy(fmtbuf, format, mpos);
fmtlen = mpos;
mpos += 2;
errmsg = strerror(ec);
errlen = strlen(errmsg);
if (fmtlen + errlen >= sizeof(fmtbuf))
errlen = sizeof(fmtbuf) - fmtlen - 1;
memcpy(fmtbuf + fmtlen, errmsg, errlen);
fmtlen += errlen;
rest_len = strlen(format) - mpos;
if (rest_len >= sizeof(fmtbuf) - fmtlen)
rest_len = sizeof(fmtbuf) - fmtlen - 1;
if (rest_len)
memcpy(fmtbuf + fmtlen, format + mpos, rest_len);
fmtbuf[fmtlen + rest_len] = 0;
format = fmtbuf;
}
len += vsnprintf(p, MAX_MESSAGE - len, format, ap) + 1; /* include zero-terminator */
entry->length = len > MAX_MESSAGE ? MAX_MESSAGE : len;
/* remove trailing '\n's passed to us. */
for (r = &entry->payload[entry->length - 2]; r >= entry->payload; r--)
if (*r == '\n')
entry->length--;
else
break;
entry->offset = 0;
if (log_opts & LOG_PERROR)
{
ssize_t rc, s = entry->length - (q - entry->payload);
/* replace terminator with \n */
entry->payload[entry->length - 1] = '\n';
while (s != 0)
if ((rc = write(STDERR_FILENO, q, s)) != -1)
{
s -= rc;
q += rc;
continue;
}
else if (errno == EINTR)
continue;
else
break;
}
entry->payload[entry->length - 1] = 0;
}
/* almost always, logging won't block, so try and write this now,
to save collecting too many log messages during a select loop. */
log_write_async();
/* Since we're doing things asynchronously, we
can now generate log lines very fast. With a small buffer (desirable),
that means it can overflow the log-buffer very quickly.
To avoid this, we delay here, the delay growing exponentially
with queue length. Delay is limited to 1 second, by default
but can be tuned for less if needed. Note that for a responsive
syslog, the log-line we just created will have been writen by the
call the log_write_async() above, so that this doesn't delay at all. */
if (entries && log_delay != 0)
{
struct timespec waiter;
int d;
for (d = 1,entry = entries; entry->next; entry = entry->next)
{
d *= 2;
if (d >= log_delay) /* limit to 999ms */
{
d = log_delay - 1;
break;
}
}
waiter.tv_sec = 0;
waiter.tv_nsec = d * 1000000; /* 1 ms */
nanosleep(&waiter, NULL);
/* try and write again */
log_write_async();
}
}
void syslog_async(int priority, const char *format, ...)
{
va_list ap;
int ec = errno;
va_start(ap, format);
vsyslog_async_logger(priority, ec, format, ap);
va_end(ap);
}
void vsyslog_async(int priority, const char *format, va_list ap)
{
vsyslog_async_logger(priority, errno, format, ap);
}
|