virlog.c 47.8 KB
Newer Older
1
/*
2
 * virlog.c: internal logging and debugging
3
 *
4
 * Copyright (C) 2008, 2010-2014 Red Hat, Inc.
5 6 7 8 9 10 11 12 13 14 15 16
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with this library.  If not, see
O
Osier Yang 已提交
18
 * <http://www.gnu.org/licenses/>.
19 20 21 22 23
 *
 */

#include <config.h>

D
Daniel Veillard 已提交
24 25 26 27 28 29 30 31
#include <stdio.h>
#include <stdarg.h>
#include <stdlib.h>
#include <time.h>
#include <sys/time.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
32
#include <unistd.h>
33
#include <execinfo.h>
34
#include <regex.h>
D
Daniel Veillard 已提交
35
#if HAVE_SYSLOG_H
36
# include <syslog.h>
D
Daniel Veillard 已提交
37
#endif
D
Daniel P. Berrange 已提交
38 39 40 41
#include <sys/socket.h>
#if HAVE_SYS_UN_H
# include <sys/un.h>
#endif
D
Daniel Veillard 已提交
42

43
#include "virerror.h"
44
#include "virlog.h"
45
#include "viralloc.h"
46
#include "virutil.h"
47
#include "virbuffer.h"
48
#include "virthread.h"
E
Eric Blake 已提交
49
#include "virfile.h"
50
#include "virtime.h"
D
Daniel P. Berrange 已提交
51
#include "intprops.h"
52
#include "virstring.h"
53

E
Eric Blake 已提交
54 55 56 57 58 59
/* Journald output is only supported on Linux new enough to expose
 * htole64.  */
#if HAVE_SYSLOG_H && defined(__linux__) && HAVE_DECL_HTOLE64
# define USE_JOURNALD 1
#endif

60 61
#define VIR_FROM_THIS VIR_FROM_NONE

62 63
VIR_LOG_INIT("util.log");

64
static regex_t *virLogRegex;
65 66


67 68
#define VIR_LOG_DATE_REGEX "[0-9]{4}-[0-9]{2}-[0-9]{2}"
#define VIR_LOG_TIME_REGEX "[0-9]{2}:[0-9]{2}:[0-9]{2}\\.[0-9]{3}\\+[0-9]{4}"
69
#define VIR_LOG_PID_REGEX "[0-9]+"
70
#define VIR_LOG_LEVEL_REGEX "(debug|info|warning|error)"
71 72 73 74

#define VIR_LOG_REGEX \
    VIR_LOG_DATE_REGEX " " VIR_LOG_TIME_REGEX ": " \
    VIR_LOG_PID_REGEX ": " VIR_LOG_LEVEL_REGEX " : "
D
Daniel Veillard 已提交
75

76 77 78 79
VIR_ENUM_DECL(virLogDestination);
VIR_ENUM_IMPL(virLogDestination, VIR_LOG_TO_OUTPUT_LAST,
              "stderr", "syslog", "file", "journald");

D
Daniel Veillard 已提交
80 81 82 83 84
/*
 * Filters are used to refine the rules on what to keep or drop
 * based on a matching pattern (currently a substring)
 */
struct _virLogFilter {
85
    char *match;
86
    virLogPriority priority;
87
    unsigned int flags;
D
Daniel Veillard 已提交
88 89
};

90
static int virLogFiltersSerial = 1;
91 92
static virLogFilterPtr *virLogFilters;
static size_t virLogNbFilters;
D
Daniel Veillard 已提交
93 94 95 96 97 98

/*
 * Outputs are used to emit the messages retained
 * after filtering, multiple output can be used simultaneously
 */
struct _virLogOutput {
99
    bool logInitMessage;
D
Daniel Veillard 已提交
100 101 102
    void *data;
    virLogOutputFunc f;
    virLogCloseFunc c;
103
    virLogPriority priority;
104
    virLogDestination dest;
105
    char *name;
D
Daniel Veillard 已提交
106 107
};

108 109
static virLogOutputPtr *virLogOutputs;
static size_t virLogNbOutputs;
D
Daniel Veillard 已提交
110 111 112 113

/*
 * Default priorities
 */
114
static virLogPriority virLogDefaultPriority = VIR_LOG_DEFAULT;
D
Daniel Veillard 已提交
115

116 117
static void virLogResetFilters(void);
static void virLogResetOutputs(void);
118
static void virLogOutputToFd(virLogSourcePtr src,
119
                             virLogPriority priority,
120
                             const char *filename,
121
                             int linenr,
122
                             const char *funcname,
123
                             const char *timestamp,
M
Miloslav Trmač 已提交
124
                             virLogMetadataPtr metadata,
125
                             unsigned int flags,
126 127
                             const char *rawstr,
                             const char *str,
128
                             void *data);
D
Daniel Veillard 已提交
129

130

D
Daniel Veillard 已提交
131 132 133
/*
 * Logs accesses must be serialized though a mutex
 */
134
virMutex virLogMutex;
D
Daniel Veillard 已提交
135

136 137
void
virLogLock(void)
D
Daniel Veillard 已提交
138
{
139
    virMutexLock(&virLogMutex);
D
Daniel Veillard 已提交
140
}
141 142 143 144


void
virLogUnlock(void)
D
Daniel Veillard 已提交
145
{
146
    virMutexUnlock(&virLogMutex);
D
Daniel Veillard 已提交
147 148
}

149 150 151 152

static const char *
virLogPriorityString(virLogPriority lvl)
{
D
Daniel Veillard 已提交
153
    switch (lvl) {
154 155 156 157 158 159 160 161
    case VIR_LOG_DEBUG:
        return "debug";
    case VIR_LOG_INFO:
        return "info";
    case VIR_LOG_WARN:
        return "warning";
    case VIR_LOG_ERROR:
        return "error";
D
Daniel Veillard 已提交
162
    }
163
    return "unknown";
D
Daniel Veillard 已提交
164 165 166
}


167 168
static int
virLogOnceInit(void)
169
{
170 171 172
    if (virMutexInit(&virLogMutex) < 0)
        return -1;

D
Daniel Veillard 已提交
173
    virLogLock();
174
    virLogDefaultPriority = VIR_LOG_DEFAULT;
175

176
    if (VIR_ALLOC_QUIET(virLogRegex) >= 0) {
177 178 179 180
        if (regcomp(virLogRegex, VIR_LOG_REGEX, REG_EXTENDED) != 0)
            VIR_FREE(virLogRegex);
    }

D
Daniel Veillard 已提交
181
    virLogUnlock();
182
    return 0;
D
Daniel Veillard 已提交
183 184
}

185 186
VIR_ONCE_GLOBAL_INIT(virLog)

187

D
Daniel Veillard 已提交
188 189 190 191 192 193 194
/**
 * virLogReset:
 *
 * Reset the logging module to its default initial state
 *
 * Returns 0 if successful, and -1 in case or error
 */
195 196 197
int
virLogReset(void)
{
198 199
    if (virLogInitialize() < 0)
        return -1;
D
Daniel Veillard 已提交
200 201 202 203

    virLogLock();
    virLogResetFilters();
    virLogResetOutputs();
204
    virLogDefaultPriority = VIR_LOG_DEFAULT;
D
Daniel Veillard 已提交
205
    virLogUnlock();
206
    return 0;
D
Daniel Veillard 已提交
207 208 209 210 211 212 213 214 215 216 217 218
}

/**
 * virLogSetDefaultPriority:
 * @priority: the default priority level
 *
 * Set the default priority level, i.e. any logged data of a priority
 * equal or superior to this level will be logged, unless a specific rule
 * was defined for the log category of the message.
 *
 * Returns 0 if successful, -1 in case of error.
 */
219 220 221
int
virLogSetDefaultPriority(virLogPriority priority)
{
222
    if ((priority < VIR_LOG_DEBUG) || (priority > VIR_LOG_ERROR)) {
223 224 225
        virReportError(VIR_ERR_INVALID_ARG,
                       _("Failed to set logging priority, argument '%u' is "
                         "invalid"), priority);
226
        return -1;
227
    }
228 229 230
    if (virLogInitialize() < 0)
        return -1;

D
Daniel Veillard 已提交
231
    virLogDefaultPriority = priority;
232
    return 0;
D
Daniel Veillard 已提交
233 234
}

235

D
Daniel Veillard 已提交
236 237 238 239 240
/**
 * virLogResetFilters:
 *
 * Removes the set of logging filters defined.
 */
241
static void
242 243
virLogResetFilters(void)
{
244 245
    virLogFilterListFree(virLogFilters, virLogNbFilters);
    virLogFilters = NULL;
D
Daniel Veillard 已提交
246
    virLogNbFilters = 0;
247
    virLogFiltersSerial++;
D
Daniel Veillard 已提交
248 249
}

250

251 252 253 254 255 256 257 258 259 260
void
virLogFilterFree(virLogFilterPtr filter)
{
    if (!filter)
        return;

    VIR_FREE(filter->match);
    VIR_FREE(filter);
}

261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282

/**
 * virLogFilterFreeList:
 * @list: list of filters to be freed
 * @count: number of elements in the list
 *
 * Frees a list of filters.
 */
void
virLogFilterListFree(virLogFilterPtr *list, int count)
{
    size_t i;

    if (!list || count < 0)
        return;

    for (i = 0; i < count; i++)
        virLogFilterFree(list[i]);
    VIR_FREE(list);
}


D
Daniel Veillard 已提交
283 284 285 286 287
/**
 * virLogResetOutputs:
 *
 * Removes the set of logging output defined.
 */
288
static void
289 290
virLogResetOutputs(void)
{
291 292
    virLogOutputListFree(virLogOutputs, virLogNbOutputs);
    virLogOutputs = NULL;
D
Daniel Veillard 已提交
293 294 295
    virLogNbOutputs = 0;
}

296

297 298 299 300 301 302 303 304 305 306 307 308 309
void
virLogOutputFree(virLogOutputPtr output)
{
    if (!output)
        return;

    if (output->c)
        output->c(output->data);
    VIR_FREE(output->name);
    VIR_FREE(output);

}

310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331

/**
 * virLogOutputsFreeList:
 * @list: list of outputs to be freed
 * @count: number of elements in the list
 *
 * Frees a list of outputs.
 */
void
virLogOutputListFree(virLogOutputPtr *list, int count)
{
    size_t i;

    if (!list || count < 0)
        return;

    for (i = 0; i < count; i++)
        virLogOutputFree(list[i]);
    VIR_FREE(list);
}


332 333
static int
virLogFormatString(char **msg,
334
                   int linenr,
335
                   const char *funcname,
336
                   virLogPriority priority,
337 338 339
                   const char *str)
{
    int ret;
340 341 342 343 344 345 346 347

    /*
     * Be careful when changing the following log message formatting, we rely
     * on it when stripping libvirt debug messages from qemu log files. So when
     * changing this, you might also need to change the code there.
     * virLogFormatString() function name is mentioned there so it's sufficient
     * to just grep for it to find the right place.
     */
348
    if ((funcname != NULL)) {
349 350 351
        ret = virAsprintfQuiet(msg, "%llu: %s : %s:%d : %s\n",
                               virThreadSelfID(), virLogPriorityString(priority),
                               funcname, linenr, str);
352
    } else {
353 354 355
        ret = virAsprintfQuiet(msg, "%llu: %s : %s\n",
                               virThreadSelfID(), virLogPriorityString(priority),
                               str);
356 357 358 359
    }
    return ret;
}

360

361
static int
362 363
virLogVersionString(const char **rawmsg,
                    char **msg)
364
{
365 366
    *rawmsg = VIR_LOG_VERSION_STRING;
    return virLogFormatString(msg, 0, NULL, VIR_LOG_INFO, VIR_LOG_VERSION_STRING);
367 368
}

369 370 371 372
/* Similar to virGetHostname() but avoids use of error
 * reporting APIs or logging APIs, to prevent recursion
 */
static int
373
virLogHostnameString(char **rawmsg,
374 375 376 377 378 379 380 381 382 383 384 385
                     char **msg)
{
    char *hostname = virGetHostnameQuiet();
    char *hoststr;

    if (!hostname)
        return -1;

    if (virAsprintfQuiet(&hoststr, "hostname: %s", hostname) < 0) {
        VIR_FREE(hostname);
        return -1;
    }
386
    VIR_FREE(hostname);
387 388 389 390 391 392 393 394 395

    if (virLogFormatString(msg, 0, NULL, VIR_LOG_INFO, hoststr) < 0) {
        VIR_FREE(hoststr);
        return -1;
    }
    *rawmsg = hoststr;
    return 0;
}

396

397 398 399 400 401 402 403 404 405 406
static void
virLogSourceUpdate(virLogSourcePtr source)
{
    virLogLock();
    if (source->serial < virLogFiltersSerial) {
        unsigned int priority = virLogDefaultPriority;
        unsigned int flags = 0;
        size_t i;

        for (i = 0; i < virLogNbFilters; i++) {
407 408 409
            if (strstr(source->name, virLogFilters[i]->match)) {
                priority = virLogFilters[i]->priority;
                flags = virLogFilters[i]->flags;
410 411 412 413 414 415 416 417 418 419 420
                break;
            }
        }

        source->priority = priority;
        source->flags = flags;
        source->serial = virLogFiltersSerial;
    }
    virLogUnlock();
}

D
Daniel Veillard 已提交
421 422
/**
 * virLogMessage:
423
 * @source: where is that message coming from
D
Daniel Veillard 已提交
424
 * @priority: the priority level
425
 * @filename: file where the message was emitted
426
 * @linenr: line where the message was emitted
427
 * @funcname: the function emitting the (debug) message
428
 * @metadata: NULL or metadata array, terminated by an item with NULL key
D
Daniel Veillard 已提交
429 430 431
 * @fmt: the string format
 * @...: the arguments
 *
E
Eric Blake 已提交
432
 * Call the libvirt logger with some information. Based on the configuration
D
Daniel Veillard 已提交
433 434
 * the message may be stored, sent to output or just discarded
 */
435
void
436
virLogMessage(virLogSourcePtr source,
437
              virLogPriority priority,
438
              const char *filename,
439
              int linenr,
440
              const char *funcname,
441
              virLogMetadataPtr metadata,
442
              const char *fmt, ...)
443 444 445
{
    va_list ap;
    va_start(ap, fmt);
446
    virLogVMessage(source, priority,
447
                   filename, linenr, funcname,
448
                   metadata, fmt, ap);
449 450 451
    va_end(ap);
}

452

453 454
/**
 * virLogVMessage:
455
 * @source: where is that message coming from
456
 * @priority: the priority level
457
 * @filename: file where the message was emitted
458
 * @linenr: line where the message was emitted
459
 * @funcname: the function emitting the (debug) message
460
 * @metadata: NULL or metadata array, terminated by an item with NULL key
461 462 463 464 465 466
 * @fmt: the string format
 * @vargs: format args
 *
 * Call the libvirt logger with some information. Based on the configuration
 * the message may be stored, sent to output or just discarded
 */
467
void
468
virLogVMessage(virLogSourcePtr source,
469
               virLogPriority priority,
470
               const char *filename,
471
               int linenr,
472
               const char *funcname,
M
Miloslav Trmač 已提交
473
               virLogMetadataPtr metadata,
474 475
               const char *fmt,
               va_list vargs)
476
{
477
    static bool logInitMessageStderr = true;
D
Daniel Veillard 已提交
478
    char *str = NULL;
479
    char *msg = NULL;
480
    char timestamp[VIR_TIME_STRING_BUFLEN];
481
    int ret;
482
    size_t i;
483
    int saved_errno = errno;
484
    unsigned int filterflags = 0;
D
Daniel Veillard 已提交
485

486 487
    if (virLogInitialize() < 0)
        return;
D
Daniel Veillard 已提交
488 489

    if (fmt == NULL)
490
        return;
D
Daniel Veillard 已提交
491 492

    /*
493 494 495 496 497 498
     * 3 intentionally non-thread safe variable reads.
     * Since writes to the variable are serialized on
     * virLogLock, worst case result is a log message
     * is accidentally dropped or emitted, if another
     * thread is updating log filter list concurrently
     * with a log message emission.
D
Daniel Veillard 已提交
499
     */
500 501 502
    if (source->serial < virLogFiltersSerial)
        virLogSourceUpdate(source);
    if (priority < source->priority)
503
        goto cleanup;
504
    filterflags = source->flags;
505

D
Daniel Veillard 已提交
506 507 508
    /*
     * serialize the error message, add level and timestamp
     */
509
    if (virVasprintfQuiet(&str, fmt, vargs) < 0)
510
        goto cleanup;
D
Daniel Veillard 已提交
511

512
    ret = virLogFormatString(&msg, linenr, funcname, priority, str);
513 514
    if (ret < 0)
        goto cleanup;
D
Daniel Veillard 已提交
515

516 517
    if (virTimeStringNowRaw(timestamp) < 0)
        timestamp[0] = '\0';
518

519 520
    virLogLock();

D
Daniel Veillard 已提交
521
    /*
522
     * Push the message to the outputs defined, if none exist then
D
Daniel Veillard 已提交
523 524
     * use stderr.
     */
525
    for (i = 0; i < virLogNbOutputs; i++) {
526 527
        if (priority >= virLogOutputs[i]->priority) {
            if (virLogOutputs[i]->logInitMessage) {
528
                const char *rawinitmsg;
529
                char *hoststr = NULL;
530 531
                char *initmsg = NULL;
                if (virLogVersionString(&rawinitmsg, &initmsg) >= 0)
532
                    virLogOutputs[i]->f(&virLogSelf, VIR_LOG_INFO,
533 534
                                       __FILE__, __LINE__, __func__,
                                       timestamp, NULL, 0, rawinitmsg, initmsg,
535
                                       virLogOutputs[i]->data);
536
                VIR_FREE(initmsg);
537
                if (virLogHostnameString(&hoststr, &initmsg) >= 0)
538
                    virLogOutputs[i]->f(&virLogSelf, VIR_LOG_INFO,
539
                                       __FILE__, __LINE__, __func__,
540
                                       timestamp, NULL, 0, hoststr, initmsg,
541
                                       virLogOutputs[i]->data);
542
                VIR_FREE(hoststr);
543
                VIR_FREE(initmsg);
544
                virLogOutputs[i]->logInitMessage = false;
545
            }
546
            virLogOutputs[i]->f(source, priority,
547
                               filename, linenr, funcname,
M
Miloslav Trmač 已提交
548
                               timestamp, metadata, filterflags,
549
                               str, msg, virLogOutputs[i]->data);
550
        }
D
Daniel Veillard 已提交
551
    }
552
    if (virLogNbOutputs == 0) {
553 554
        if (logInitMessageStderr) {
            const char *rawinitmsg;
555
            char *hoststr = NULL;
556 557 558 559 560 561 562
            char *initmsg = NULL;
            if (virLogVersionString(&rawinitmsg, &initmsg) >= 0)
                virLogOutputToFd(&virLogSelf, VIR_LOG_INFO,
                                 __FILE__, __LINE__, __func__,
                                 timestamp, NULL, 0, rawinitmsg, initmsg,
                                 (void *) STDERR_FILENO);
            VIR_FREE(initmsg);
563
            if (virLogHostnameString(&hoststr, &initmsg) >= 0)
564
                virLogOutputToFd(&virLogSelf, VIR_LOG_INFO,
565
                                 __FILE__, __LINE__, __func__,
566
                                 timestamp, NULL, 0, hoststr, initmsg,
567
                                 (void *) STDERR_FILENO);
568
            VIR_FREE(hoststr);
569 570
            VIR_FREE(initmsg);
            logInitMessageStderr = false;
571
        }
572
        virLogOutputToFd(source, priority,
573
                         filename, linenr, funcname,
M
Miloslav Trmač 已提交
574
                         timestamp, metadata, filterflags,
575
                         str, msg, (void *) STDERR_FILENO);
576
    }
D
Daniel Veillard 已提交
577 578
    virLogUnlock();

579
 cleanup:
580
    VIR_FREE(str);
581
    VIR_FREE(msg);
582
    errno = saved_errno;
D
Daniel Veillard 已提交
583 584
}

585

586 587
static void
virLogStackTraceToFd(int fd)
588 589 590
{
    void *array[100];
    int size;
591
    static bool doneWarning;
592
    const char *msg = "Stack trace not available on this platform\n";
593 594 595 596 597 598 599

#define STRIP_DEPTH 3
    size = backtrace(array, ARRAY_CARDINALITY(array));
    if (size) {
        backtrace_symbols_fd(array +  STRIP_DEPTH, size - STRIP_DEPTH, fd);
        ignore_value(safewrite(fd, "\n", 1));
    } else if (!doneWarning) {
600 601 602
        ignore_value(safewrite(fd, msg, strlen(msg)));
        doneWarning = true;
    }
603
#undef STRIP_DEPTH
604 605
}

606
static void
607
virLogOutputToFd(virLogSourcePtr source ATTRIBUTE_UNUSED,
608
                 virLogPriority priority ATTRIBUTE_UNUSED,
609
                 const char *filename ATTRIBUTE_UNUSED,
610
                 int linenr ATTRIBUTE_UNUSED,
611
                 const char *funcname ATTRIBUTE_UNUSED,
612
                 const char *timestamp,
M
Miloslav Trmač 已提交
613
                 virLogMetadataPtr metadata ATTRIBUTE_UNUSED,
614 615 616 617
                 unsigned int flags,
                 const char *rawstr ATTRIBUTE_UNUSED,
                 const char *str,
                 void *data)
618
{
619
    int fd = (intptr_t) data;
620
    char *msg;
D
Daniel Veillard 已提交
621 622

    if (fd < 0)
623
        return;
624

625
    if (virAsprintfQuiet(&msg, "%s: %s", timestamp, str) < 0)
626
        return;
627

628
    ignore_value(safewrite(fd, msg, strlen(msg)));
629 630
    VIR_FREE(msg);

631 632
    if (flags & VIR_LOG_STACK_TRACE)
        virLogStackTraceToFd(fd);
D
Daniel Veillard 已提交
633 634
}

635 636 637

static void
virLogCloseFd(void *data)
638
{
639
    int fd = (intptr_t) data;
D
Daniel Veillard 已提交
640

641
    VIR_LOG_CLOSE(fd);
D
Daniel Veillard 已提交
642 643
}

644

645
static virLogOutputPtr
646 647 648 649 650 651 652
virLogNewOutputToStderr(virLogPriority priority)
{
    return virLogOutputNew(virLogOutputToFd, NULL, (void *)STDERR_FILENO,
                           priority, VIR_LOG_TO_STDERR, NULL);
}


653
static virLogOutputPtr
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
virLogNewOutputToFile(virLogPriority priority,
                      const char *file)
{
    int fd;
    virLogOutputPtr ret = NULL;

    fd = open(file, O_CREAT | O_APPEND | O_WRONLY, S_IRUSR | S_IWUSR);
    if (fd < 0)
        return NULL;

    if (!(ret = virLogOutputNew(virLogOutputToFd, virLogCloseFd,
                                (void *)(intptr_t)fd,
                                priority, VIR_LOG_TO_FILE, file))) {
        VIR_LOG_CLOSE(fd);
        return NULL;
    }
    return ret;
}


674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
#if HAVE_SYSLOG_H || USE_JOURNALD

/* Compat in case we build with journald, but no syslog */
# ifndef LOG_DEBUG
#  define LOG_DEBUG 7
# endif
# ifndef LOG_INFO
#  define LOG_INFO 6
# endif
# ifndef LOG_WARNING
#  define LOG_WARNING 4
# endif
# ifndef LOG_ERR
#  define LOG_ERR 3
# endif

690 691
static int
virLogPrioritySyslog(virLogPriority priority)
692 693 694 695 696 697 698 699 700 701 702 703 704 705
{
    switch (priority) {
    case VIR_LOG_DEBUG:
        return LOG_DEBUG;
    case VIR_LOG_INFO:
        return LOG_INFO;
    case VIR_LOG_WARN:
        return LOG_WARNING;
    case VIR_LOG_ERROR:
        return LOG_ERR;
    default:
        return LOG_ERR;
    }
}
706
#endif /* HAVE_SYSLOG_H || USE_JOURNALD */
707

708

709
#if HAVE_SYSLOG_H
710
static void
711
virLogOutputToSyslog(virLogSourcePtr source ATTRIBUTE_UNUSED,
712
                     virLogPriority priority,
713
                     const char *filename ATTRIBUTE_UNUSED,
714
                     int linenr ATTRIBUTE_UNUSED,
715
                     const char *funcname ATTRIBUTE_UNUSED,
716
                     const char *timestamp ATTRIBUTE_UNUSED,
M
Miloslav Trmač 已提交
717
                     virLogMetadataPtr metadata ATTRIBUTE_UNUSED,
718 719 720 721
                     unsigned int flags,
                     const char *rawstr ATTRIBUTE_UNUSED,
                     const char *str,
                     void *data ATTRIBUTE_UNUSED)
722
{
723
    virCheckFlags(VIR_LOG_STACK_TRACE,);
724

725
    syslog(virLogPrioritySyslog(priority), "%s", str);
D
Daniel Veillard 已提交
726 727
}

728
static char *current_ident;
729

730 731 732 733

static void
virLogCloseSyslog(void *data ATTRIBUTE_UNUSED)
{
D
Daniel Veillard 已提交
734
    closelog();
735
    VIR_FREE(current_ident);
D
Daniel Veillard 已提交
736 737
}

738

739
static virLogOutputPtr
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
virLogNewOutputToSyslog(virLogPriority priority,
                        const char *ident)
{
    virLogOutputPtr ret = NULL;
    int at = -1;

    /* There are a couple of issues with syslog:
     * 1) If we re-opened the connection by calling openlog now, it would change
     * the message tag immediately which is not what we want, since we might be
     * in the middle of parsing of a new set of outputs where anything still can
     * go wrong and we would introduce an inconsistent state to the log. We're
     * also not holding a lock on the logger if we tried to change the tag
     * while other workers are actively logging.
     *
     * 2) Syslog keeps the open file descriptor private, so we can't just dup()
     * it like we would do with files if an output already existed.
     *
     * If a syslog connection already exists changing the message tag has to be
     * therefore special-cased and postponed until the very last moment.
     */
    if ((at = virLogFindOutput(virLogOutputs, virLogNbOutputs,
                               VIR_LOG_TO_SYSLOG, NULL)) < 0) {
        /*
         * rather than copying @ident, syslog uses caller's reference instead
         */
        VIR_FREE(current_ident);
        if (VIR_STRDUP(current_ident, ident) < 0)
            return NULL;

        openlog(current_ident, 0, 0);
    }

    if (!(ret = virLogOutputNew(virLogOutputToSyslog, virLogCloseSyslog,
                                NULL, priority, VIR_LOG_TO_SYSLOG, ident))) {
        if (at < 0) {
            closelog();
            VIR_FREE(current_ident);
        }
        return NULL;
    }
    return ret;
}


E
Eric Blake 已提交
784
# if USE_JOURNALD
785 786 787 788 789
#  define IOVEC_SET(iov, data, size)            \
    do {                                        \
        struct iovec *_i = &(iov);              \
        _i->iov_base = (void*)(data);           \
        _i->iov_len = (size);                   \
D
Daniel P. Berrange 已提交
790 791
    } while (0)

792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856
#  define IOVEC_SET_STRING(iov, str) IOVEC_SET(iov, str, strlen(str))

/* Used for conversion of numbers to strings, and for length of binary data */
#  define JOURNAL_BUF_SIZE (MAX(INT_BUFSIZE_BOUND(int), sizeof(uint64_t)))

struct journalState
{
    struct iovec *iov, *iov_end;
    char (*bufs)[JOURNAL_BUF_SIZE], (*bufs_end)[JOURNAL_BUF_SIZE];
};

static void
journalAddString(struct journalState *state, const char *field,
                 const char *value)
{
    static const char newline = '\n', equals = '=';

    if (strchr(value, '\n') != NULL) {
        uint64_t nstr;

        /* If 'str' contains a newline, then we must
         * encode the string length, since we can't
         * rely on the newline for the field separator
         */
        if (state->iov_end - state->iov < 5 || state->bufs == state->bufs_end)
            return; /* Silently drop */
        nstr = htole64(strlen(value));
        memcpy(state->bufs[0], &nstr, sizeof(nstr));

        IOVEC_SET_STRING(state->iov[0], field);
        IOVEC_SET(state->iov[1], &newline, sizeof(newline));
        IOVEC_SET(state->iov[2], state->bufs[0], sizeof(nstr));
        state->bufs++;
        state->iov += 3;
    } else {
        if (state->iov_end - state->iov < 4)
            return; /* Silently drop */
        IOVEC_SET_STRING(state->iov[0], field);
        IOVEC_SET(state->iov[1], (void *)&equals, sizeof(equals));
        state->iov += 2;
    }
    IOVEC_SET_STRING(state->iov[0], value);
    IOVEC_SET(state->iov[1], (void *)&newline, sizeof(newline));
    state->iov += 2;
}

static void
journalAddInt(struct journalState *state, const char *field, int value)
{
    static const char newline = '\n', equals = '=';

    char *num;

    if (state->iov_end - state->iov < 4 || state->bufs == state->bufs_end)
        return; /* Silently drop */

    num = virFormatIntDecimal(state->bufs[0], sizeof(state->bufs[0]), value);

    IOVEC_SET_STRING(state->iov[0], field);
    IOVEC_SET(state->iov[1], (void *)&equals, sizeof(equals));
    IOVEC_SET_STRING(state->iov[2], num);
    IOVEC_SET(state->iov[3], (void *)&newline, sizeof(newline));
    state->bufs++;
    state->iov += 4;
}
D
Daniel P. Berrange 已提交
857 858

static void
859
virLogOutputToJournald(virLogSourcePtr source,
D
Daniel P. Berrange 已提交
860 861 862 863 864
                       virLogPriority priority,
                       const char *filename,
                       int linenr,
                       const char *funcname,
                       const char *timestamp ATTRIBUTE_UNUSED,
865
                       virLogMetadataPtr metadata,
D
Daniel P. Berrange 已提交
866 867 868
                       unsigned int flags,
                       const char *rawstr,
                       const char *str ATTRIBUTE_UNUSED,
869
                       void *data)
D
Daniel P. Berrange 已提交
870 871 872
{
    virCheckFlags(VIR_LOG_STACK_TRACE,);
    int buffd = -1;
873
    int journalfd = (intptr_t) data;
D
Daniel P. Berrange 已提交
874 875 876 877 878 879 880 881 882 883 884
    struct msghdr mh;
    struct sockaddr_un sa;
    union {
        struct cmsghdr cmsghdr;
        uint8_t buf[CMSG_SPACE(sizeof(int))];
    } control;
    struct cmsghdr *cmsg;
    /* We use /dev/shm instead of /tmp here, since we want this to
     * be a tmpfs, and one that is available from early boot on
     * and where unprivileged users can create files. */
    char path[] = "/dev/shm/journal.XXXXXX";
885
    size_t nmetadata = 0;
D
Daniel P. Berrange 已提交
886

887 888 889
#  define NUM_FIELDS_CORE 6
#  define NUM_FIELDS_META 5
#  define NUM_FIELDS (NUM_FIELDS_CORE + NUM_FIELDS_META)
890 891 892
    struct iovec iov[NUM_FIELDS * 5];
    char iov_bufs[NUM_FIELDS][JOURNAL_BUF_SIZE];
    struct journalState state;
D
Daniel P. Berrange 已提交
893

894 895 896 897
    state.iov = iov;
    state.iov_end = iov + ARRAY_CARDINALITY(iov);
    state.bufs = iov_bufs;
    state.bufs_end = iov_bufs + ARRAY_CARDINALITY(iov_bufs);
D
Daniel P. Berrange 已提交
898

E
Eric Blake 已提交
899
    journalAddString(&state, "MESSAGE", rawstr);
900 901
    journalAddInt(&state, "PRIORITY",
                  virLogPrioritySyslog(priority));
902
    journalAddInt(&state, "SYSLOG_FACILITY", LOG_DAEMON);
903
    journalAddString(&state, "LIBVIRT_SOURCE", source->name);
904 905
    if (filename)
        journalAddString(&state, "CODE_FILE", filename);
906
    journalAddInt(&state, "CODE_LINE", linenr);
907 908
    if (funcname)
        journalAddString(&state, "CODE_FUNC", funcname);
909 910 911 912 913 914 915 916 917 918 919
    if (metadata != NULL) {
        while (metadata->key != NULL &&
               nmetadata < NUM_FIELDS_META) {
            if (metadata->s != NULL)
                journalAddString(&state, metadata->key, metadata->s);
            else
                journalAddInt(&state, metadata->key, metadata->iv);
            metadata++;
            nmetadata++;
        }
    }
D
Daniel P. Berrange 已提交
920 921 922 923 924 925 926 927 928 929

    memset(&sa, 0, sizeof(sa));
    sa.sun_family = AF_UNIX;
    if (!virStrcpy(sa.sun_path, "/run/systemd/journal/socket", sizeof(sa.sun_path)))
        return;

    memset(&mh, 0, sizeof(mh));
    mh.msg_name = &sa;
    mh.msg_namelen = offsetof(struct sockaddr_un, sun_path) + strlen(sa.sun_path);
    mh.msg_iov = iov;
930
    mh.msg_iovlen = state.iov - iov;
D
Daniel P. Berrange 已提交
931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953

    if (sendmsg(journalfd, &mh, MSG_NOSIGNAL) >= 0)
        return;

    if (errno != EMSGSIZE && errno != ENOBUFS)
        return;

    /* Message was too large, so dump to temporary file
     * and pass an FD to the journal
     */

    /* NB: mkostemp is not declared async signal safe by
     * POSIX, but this is Linux only code and the GLibc
     * impl is safe enough, only using open() and inline
     * asm to read a timestamp (falling back to gettimeofday
     * on some arches
     */
    if ((buffd = mkostemp(path, O_CLOEXEC|O_RDWR)) < 0)
        return;

    if (unlink(path) < 0)
        goto cleanup;

954
    if (writev(buffd, iov, state.iov - iov) < 0)
D
Daniel P. Berrange 已提交
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
        goto cleanup;

    mh.msg_iov = NULL;
    mh.msg_iovlen = 0;

    memset(&control, 0, sizeof(control));
    mh.msg_control = &control;
    mh.msg_controllen = sizeof(control);

    cmsg = CMSG_FIRSTHDR(&mh);
    cmsg->cmsg_level = SOL_SOCKET;
    cmsg->cmsg_type = SCM_RIGHTS;
    cmsg->cmsg_len = CMSG_LEN(sizeof(int));
    memcpy(CMSG_DATA(cmsg), &buffd, sizeof(int));

    mh.msg_controllen = cmsg->cmsg_len;

972
    ignore_value(sendmsg(journalfd, &mh, MSG_NOSIGNAL));
D
Daniel P. Berrange 已提交
973

974
 cleanup:
D
Daniel P. Berrange 已提交
975 976 977 978
    VIR_LOG_CLOSE(buffd);
}


979
static virLogOutputPtr
980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
virLogNewOutputToJournald(int priority)
{
    int journalfd;
    virLogOutputPtr ret = NULL;

    if ((journalfd = socket(AF_UNIX, SOCK_DGRAM, 0)) < 0)
        return NULL;

    if (virSetInherit(journalfd, false) < 0) {
        VIR_LOG_CLOSE(journalfd);
        return NULL;
    }

    if (!(ret = virLogOutputNew(virLogOutputToJournald, virLogCloseFd,
                                (void *)(intptr_t) journalfd, priority,
                                VIR_LOG_TO_JOURNALD, NULL))) {
        VIR_LOG_CLOSE(journalfd);
        return NULL;
    }

    return ret;
}
E
Eric Blake 已提交
1002
# endif /* USE_JOURNALD */
J
Ján Tomko 已提交
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027

int virLogPriorityFromSyslog(int priority)
{
    switch (priority) {
    case LOG_EMERG:
    case LOG_ALERT:
    case LOG_CRIT:
    case LOG_ERR:
        return VIR_LOG_ERROR;
    case LOG_WARNING:
    case LOG_NOTICE:
        return VIR_LOG_WARN;
    case LOG_INFO:
        return VIR_LOG_INFO;
    case LOG_DEBUG:
        return VIR_LOG_DEBUG;
    }
    return VIR_LOG_ERROR;
}

#else /* HAVE_SYSLOG_H */
int virLogPriorityFromSyslog(int priority ATTRIBUTE_UNUSED)
{
    return VIR_LOG_ERROR;
}
D
Daniel Veillard 已提交
1028 1029
#endif /* HAVE_SYSLOG_H */

1030

1031 1032 1033 1034 1035
/**
 * virLogGetDefaultPriority:
 *
 * Returns the current logging priority level.
 */
1036 1037 1038
virLogPriority
virLogGetDefaultPriority(void)
{
1039
    return virLogDefaultPriority;
1040 1041
}

1042

1043 1044 1045 1046 1047 1048 1049
/**
 * virLogGetFilters:
 *
 * Returns a string listing the current filters, in the format originally
 * specified in the config file or environment. Caller must free the
 * result.
 */
1050 1051 1052
char *
virLogGetFilters(void)
{
1053
    size_t i;
1054 1055 1056 1057
    virBuffer filterbuf = VIR_BUFFER_INITIALIZER;

    virLogLock();
    for (i = 0; i < virLogNbFilters; i++) {
1058
        const char *sep = ":";
1059
        if (virLogFilters[i]->flags & VIR_LOG_STACK_TRACE)
1060 1061
            sep = ":+";
        virBufferAsprintf(&filterbuf, "%d%s%s ",
1062
                          virLogFilters[i]->priority,
1063
                          sep,
1064
                          virLogFilters[i]->match);
1065 1066 1067
    }
    virLogUnlock();

1068 1069
    if (virBufferError(&filterbuf)) {
        virBufferFreeAndReset(&filterbuf);
1070
        return NULL;
1071
    }
1072 1073 1074 1075

    return virBufferContentAndReset(&filterbuf);
}

1076

1077 1078 1079 1080 1081 1082 1083
/**
 * virLogGetOutputs:
 *
 * Returns a string listing the current outputs, in the format originally
 * specified in the config file or environment. Caller must free the
 * result.
 */
1084 1085 1086
char *
virLogGetOutputs(void)
{
1087
    size_t i;
1088 1089 1090 1091
    virBuffer outputbuf = VIR_BUFFER_INITIALIZER;

    virLogLock();
    for (i = 0; i < virLogNbOutputs; i++) {
1092
        virLogDestination dest = virLogOutputs[i]->dest;
1093
        if (i)
1094
            virBufferAddChar(&outputbuf, ' ');
1095 1096 1097
        switch (dest) {
            case VIR_LOG_TO_SYSLOG:
            case VIR_LOG_TO_FILE:
1098
                virBufferAsprintf(&outputbuf, "%d:%s:%s",
1099
                                  virLogOutputs[i]->priority,
1100
                                  virLogDestinationTypeToString(dest),
1101
                                  virLogOutputs[i]->name);
1102 1103
                break;
            default:
1104
                virBufferAsprintf(&outputbuf, "%d:%s",
1105
                                  virLogOutputs[i]->priority,
1106
                                  virLogDestinationTypeToString(dest));
1107 1108 1109 1110
        }
    }
    virLogUnlock();

1111 1112
    if (virBufferError(&outputbuf)) {
        virBufferFreeAndReset(&outputbuf);
1113
        return NULL;
1114
    }
1115 1116 1117 1118

    return virBufferContentAndReset(&outputbuf);
}

1119

1120 1121 1122 1123 1124
/**
 * virLogGetNbFilters:
 *
 * Returns the current number of defined log filters.
 */
1125 1126 1127
int
virLogGetNbFilters(void)
{
1128
    return virLogNbFilters;
1129 1130
}

1131

1132 1133 1134 1135 1136
/**
 * virLogGetNbOutputs:
 *
 * Returns the current number of defined log outputs.
 */
1137 1138 1139
int
virLogGetNbOutputs(void)
{
1140
    return virLogNbOutputs;
1141
}
1142

1143

1144 1145
/**
 * virLogParseDefaultPriority:
1146 1147
 * @priority: string defining the desired logging level (either a numeric or a
 *            word form, see below)
1148
 *
1149 1150 1151 1152 1153 1154
 * Parses the desired log priority level. The input @priority shall conform to
 * one of the following levels:
 *    1 = DEBUG
 *    2 = INFO
 *    3 = WARNING
 *    4 = ERROR
1155
 *
1156 1157 1158 1159
 *
 * Returns the corresponding priority enum on success, -1 in case of error. A
 * call to virLogSetDefaultPriority should be issued upon returning from this
 * function.
1160
 */
1161 1162 1163
int
virLogParseDefaultPriority(const char *priority)
{
1164
    if (STREQ(priority, "1") || STREQ(priority, "debug"))
1165
        return VIR_LOG_DEBUG;
1166
    else if (STREQ(priority, "2") || STREQ(priority, "info"))
1167
        return VIR_LOG_INFO;
1168
    else if (STREQ(priority, "3") || STREQ(priority, "warning"))
1169
        return VIR_LOG_WARN;
1170
    else if (STREQ(priority, "4") || STREQ(priority, "error"))
1171 1172
        return VIR_LOG_ERROR;
    return -1;
1173 1174
}

1175

1176 1177 1178 1179 1180 1181
/**
 * virLogSetFromEnv:
 *
 * Sets virLogDefaultPriority, virLogFilters and virLogOutputs based on
 * environment variables.
 */
1182 1183 1184
void
virLogSetFromEnv(void)
{
1185
    const char *debugEnv;
1186

1187 1188 1189
    if (virLogInitialize() < 0)
        return;

1190
    debugEnv = virGetEnvAllowSUID("LIBVIRT_DEBUG");
1191
    if (debugEnv && *debugEnv)
1192
        virLogSetDefaultPriority(virLogParseDefaultPriority(debugEnv));
1193
    debugEnv = virGetEnvAllowSUID("LIBVIRT_LOG_FILTERS");
1194
    if (debugEnv && *debugEnv)
1195
        virLogSetFilters(debugEnv);
1196
    debugEnv = virGetEnvAllowSUID("LIBVIRT_LOG_OUTPUTS");
1197
    if (debugEnv && *debugEnv)
1198
        virLogSetOutputs(debugEnv);
1199
}
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215


/*
 * Returns a true value if the first line in @str is
 * probably a log message generated by the libvirt
 * logging layer
 */
bool virLogProbablyLogMessage(const char *str)
{
    bool ret = false;
    if (!virLogRegex)
        return false;
    if (regexec(virLogRegex, str, 0, NULL, 0) == 0)
        ret = true;
    return ret;
}
E
Erik Skultety 已提交
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270


/**
 * virLogOutputNew:
 * @f: the function to call to output a message
 * @c: the function to call to close the output (or NULL)
 * @data: extra data passed as first arg to functions @f and @c
 * @priority: minimal priority for this filter, use 0 for none
 * @dest: where to send output of this priority (see virLogDestination)
 * @name: additional data associated with syslog and file-based outputs (ident
 *        and filename respectively)
 *
 * Allocates and returns a new log output object. The object has to be later
 * defined, so that the output will be taken into account when emitting a
 * message.
 *
 * Returns reference to a newly created object or NULL in case of failure.
 */
virLogOutputPtr
virLogOutputNew(virLogOutputFunc f,
                virLogCloseFunc c,
                void *data,
                virLogPriority priority,
                virLogDestination dest,
                const char *name)
{
    virLogOutputPtr ret = NULL;
    char *ndup = NULL;

    if (dest == VIR_LOG_TO_SYSLOG || dest == VIR_LOG_TO_FILE) {
        if (!name) {
            virReportError(VIR_ERR_INVALID_ARG, "%s",
                           _("Missing auxiliary data in output definition"));
            return NULL;
        }

        if (VIR_STRDUP(ndup, name) < 0)
            return NULL;
    }

    if (VIR_ALLOC(ret) < 0) {
        VIR_FREE(ndup);
        return NULL;
    }

    ret->logInitMessage = true;
    ret->f = f;
    ret->c = c;
    ret->data = data;
    ret->priority = priority;
    ret->dest = dest;
    ret->name = ndup;

    return ret;
}
E
Erik Skultety 已提交
1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318


/**
 * virLogFilterNew:
 * @match: the pattern to match
 * @priority: the priority to give to messages matching the pattern
 * @flags: extra flags, see virLogFilterFlags enum
 *
 * Allocates and returns a new log filter object. The object has to be later
 * defined, so that the pattern will be taken into account when executing the
 * log filters (to select or reject a particular message) on messages.
 *
 * The filter defines a rules that will apply only to messages matching
 * the pattern (currently if @match is a substring of the message category)
 *
 * Returns a reference to a newly created filter that needs to be defined using
 * virLogDefineFilters, or NULL in case of an error.
 */
virLogFilterPtr
virLogFilterNew(const char *match,
                virLogPriority priority,
                unsigned int flags)
{
    virLogFilterPtr ret = NULL;
    char *mdup = NULL;

    virCheckFlags(VIR_LOG_STACK_TRACE, NULL);

    if (priority < VIR_LOG_DEBUG || priority > VIR_LOG_ERROR) {
        virReportError(VIR_ERR_INVALID_ARG, _("Invalid log priority %d"),
                       priority);
        return NULL;
    }

    if (VIR_STRDUP_QUIET(mdup, match) < 0)
        return NULL;

    if (VIR_ALLOC_QUIET(ret) < 0) {
        VIR_FREE(mdup);
        return NULL;
    }

    ret->match = mdup;
    ret->priority = priority;
    ret->flags = flags;

    return ret;
}
E
Erik Skultety 已提交
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350


/**
 * virLogFindOutput:
 * @outputs: a list of outputs where to look for the output of type @dest
 * @noutputs: number of elements in @outputs
 * @dest: destination type of an output
 * @opaque: opaque data to the method (only filename at the moment)
 *
 * Looks for an output of destination type @dest in the source list @outputs.
 * If such an output exists, index of the object in the list is returned.
 * In case of the destination being of type FILE also a comparison of the
 * output's filename with @opaque is performed first.
 *
 * Returns the index of the object in the list or -1 if no object matching the
 * specified @dest type and/or @opaque data one was found.
 */
int
virLogFindOutput(virLogOutputPtr *outputs, size_t noutputs,
                 virLogDestination dest, const void *opaque)
{
    size_t i;
    const char *name = opaque;

    for (i = 0; i < noutputs; i++) {
        if (dest == outputs[i]->dest &&
            (STREQ_NULLABLE(outputs[i]->name, name)))
                return i;
    }

    return -1;
}
1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364


/**
 * virLogDefineOutputs:
 * @outputs: new set of outputs to be defined
 * @noutputs: number of outputs in @outputs
 *
 * Resets any existing set of outputs and defines a completely new one.
 *
 * Returns number of outputs successfully defined or -1 in case of error;
 */
int
virLogDefineOutputs(virLogOutputPtr *outputs, size_t noutputs)
{
1365
#if HAVE_SYSLOG_H
1366 1367
    int id;
    char *tmp = NULL;
1368
#endif /* HAVE_SYSLOG_H */
1369

1370 1371 1372 1373 1374
    if (virLogInitialize() < 0)
        return -1;

    virLogLock();
    virLogResetOutputs();
1375

1376
#if HAVE_SYSLOG_H
1377 1378 1379 1380 1381 1382 1383
    /* syslog needs to be special-cased, since it keeps the fd in private */
    if ((id = virLogFindOutput(outputs, noutputs, VIR_LOG_TO_SYSLOG,
                               current_ident)) != -1) {
        /* nothing can go wrong now (except for malloc) and since we're also
         * holding the lock so it's safe to call openlog and change the message
         * tag
         */
1384 1385 1386 1387
        if (VIR_STRDUP_QUIET(tmp, outputs[id]->name) < 0) {
            virLogUnlock();
            return -1;
        }
1388 1389 1390 1391
        VIR_FREE(current_ident);
        current_ident = tmp;
        openlog(current_ident, 0, 0);
    }
1392
#endif /* HAVE_SYSLOG_H */
1393

1394 1395 1396
    virLogOutputs = outputs;
    virLogNbOutputs = noutputs;

1397
    virLogUnlock();
1398
    return 0;
1399
}
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426


/**
 * virLogDefineFilters:
 * @filters: new set of filters to be defined
 * @nfilters: number of filters in @filters
 *
 * Resets any existing set of filters and defines a completely new one. The
 * resulting set can also be empty in which case NULL should be passed to
 * @filters.
 *
 * Returns 0 on success or -1 in case of error.
 */
int
virLogDefineFilters(virLogFilterPtr *filters, size_t nfilters)
{
    if (virLogInitialize() < 0)
        return -1;

    virLogLock();
    virLogResetFilters();
    virLogFilters = filters;
    virLogNbFilters = nfilters;
    virLogUnlock();

    return 0;
}
1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471


/**
 * virLogParseOutput:
 * @src: string defining a single output
 *
 * The format of @src should be one of the following:
 *    x:stderr - output is sent to stderr
 *    x:journald - output is sent to journald
 *    x:syslog:name - output is sent to syslog using 'name' as the message tag
 *    x:file:abs_file_path - output is sent to file specified by 'abs_file_path'
 *
 *      'x' - minimal priority level which acts as a filter meaning that only
 *            messages with priority level greater than or equal to 'x' will be
 *            sent to output @src; supported values for 'x' are as follows:
 *              1: DEBUG
 *              2: INFO
 *              3: WARNING
 *              4: ERROR
 *
 * Parses @src string into a logging object type. If running in setuid mode,
 * then only destination of type 'stderr' is permitted.
 *
 * Returns a newly created logging object from @src on success or NULL in case
 * of an error.
 */
virLogOutputPtr
virLogParseOutput(const char *src)
{
    virLogOutputPtr ret = NULL;
    char **tokens = NULL;
    char *abspath = NULL;
    size_t count = 0;
    virLogPriority prio;
    int dest;
    bool isSUID = virIsSUID();

    VIR_DEBUG("output=%s", src);

    /* split our format prio:destination:additional_data to tokens and parse
     * them individually
     */
    if (!(tokens = virStringSplitCount(src, ":", 0, &count)) || count < 2) {
        virReportError(VIR_ERR_INVALID_ARG,
                       _("Malformed format for output '%s'"), src);
1472
        goto cleanup;
1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535
    }

    if (virStrToLong_uip(tokens[0], NULL, 10, &prio) < 0 ||
        (prio < VIR_LOG_DEBUG) || (prio > VIR_LOG_ERROR)) {
        virReportError(VIR_ERR_INVALID_ARG,
                       _("Invalid priority '%s' for output '%s'"),
                       tokens[0], src);
        goto cleanup;
    }

    if ((dest = virLogDestinationTypeFromString(tokens[1])) < 0) {
        virReportError(VIR_ERR_INVALID_ARG,
                       _("Invalid destination '%s' for output '%s'"),
                       tokens[1], src);
        goto cleanup;
    }

    if (((dest == VIR_LOG_TO_STDERR ||
          dest == VIR_LOG_TO_JOURNALD) && count != 2) ||
        ((dest == VIR_LOG_TO_FILE ||
          dest == VIR_LOG_TO_SYSLOG) && count != 3)) {
        virReportError(VIR_ERR_INVALID_ARG,
                       _("Output '%s' does not meet the format requirements "
                         "for destination type '%s'"), src, tokens[1]);
        goto cleanup;
    }

    /* if running with setuid, only 'stderr' is allowed */
    if (isSUID && dest != VIR_LOG_TO_STDERR) {
        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                       _("Running with SUID permits only destination of type "
                         "'stderr'"));
        goto cleanup;
    }

    switch ((virLogDestination) dest) {
    case VIR_LOG_TO_STDERR:
        ret = virLogNewOutputToStderr(prio);
        break;
    case VIR_LOG_TO_SYSLOG:
#if HAVE_SYSLOG_H
        ret = virLogNewOutputToSyslog(prio, tokens[2]);
#endif
        break;
    case VIR_LOG_TO_FILE:
        if (virFileAbsPath(tokens[2], &abspath) < 0)
            goto cleanup;
        ret = virLogNewOutputToFile(prio, abspath);
        VIR_FREE(abspath);
        break;
    case VIR_LOG_TO_JOURNALD:
#if USE_JOURNALD
        ret = virLogNewOutputToJournald(prio);
#endif
        break;
    case VIR_LOG_TO_OUTPUT_LAST:
        break;
    }

 cleanup:
    virStringFreeList(tokens);
    return ret;
}
1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580


/**
 * virLogParseFilter:
 * @src: string defining a single filter
 *
 * The format of @src should be one of the following:
 *    x:name - filter affecting all modules which match 'name'
 *    x:+name
 *
 *      '+' - hints the logger to also include a stack trace for every message
 *      'name' - match string which either matches a name of a directory in
 *               libvirt's source tree which in turn affects all modules in
 *               that directory or it can matches a specific module within a
 *               directory, e.g. 'util.file' will only affect messages from
 *               module virfile.c inside src/util/ directory
 *      'x' - minimal priority level which acts as a filter meaning that only
 *            messages with priority level greater than or equal to 'x' will be
 *            sent to output; supported values for 'x' are as follows:
 *              1: DEBUG
 *              2: INFO
 *              3: WARNING
 *              4: ERROR
 *
 * Parses @src string into a logging object type.
 *
 * Returns a newly created logging object from @src on success or NULL in case
 * of an error.
 */
virLogFilterPtr
virLogParseFilter(const char *src)
{
    virLogFilterPtr ret = NULL;
    size_t count = 0;
    virLogPriority prio;
    char **tokens = NULL;
    unsigned int flags = 0;
    char *match = NULL;

    VIR_DEBUG("filter=%s", src);

    /* split our format prio:match_str to tokens and parse them individually */
    if (!(tokens = virStringSplitCount(src, ":", 0, &count)) || count != 2) {
        virReportError(VIR_ERR_INVALID_ARG,
                       _("Malformed format for filter '%s'"), src);
1581
        goto cleanup;
1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
    }

    if (virStrToLong_uip(tokens[0], NULL, 10, &prio) < 0 ||
        (prio < VIR_LOG_DEBUG) || (prio > VIR_LOG_ERROR)) {
        virReportError(VIR_ERR_INVALID_ARG,
                       _("Invalid priority '%s' for output '%s'"),
                       tokens[0], src);
        goto cleanup;
    }

    match = tokens[1];
    if (match[0] == '+') {
        flags |= VIR_LOG_STACK_TRACE;
        match++;
    }

    /* match string cannot comprise just from a single '+' */
    if (!*match) {
        virReportError(VIR_ERR_INVALID_ARG,
                       _("Invalid match string '%s'"), tokens[1]);

        goto cleanup;
    }

    if (!(ret = virLogFilterNew(match, prio, flags)))
        goto cleanup;

 cleanup:
    virStringFreeList(tokens);
    return ret;
}
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672

/**
 * virLogParseOutputs:
 * @src: string defining a (set of) output(s)
 * @outputs: user-supplied list where parsed outputs from @src shall be stored
 *
 * Parses a (set of) output(s) into a list of logging objects. Multiple outputs
 * can be defined within @src string, they just need to be separated by spaces.
 * If running in setuid mode, then only the 'stderr' output will be allowed.
 *
 * Returns the number of outputs parsed or -1 in case of error.
 */
int
virLogParseOutputs(const char *src, virLogOutputPtr **outputs)
{
    int ret = -1;
    int at = -1;
    size_t noutputs = 0;
    size_t i, count;
    char **strings = NULL;
    virLogOutputPtr output = NULL;
    virLogOutputPtr *list = NULL;

    VIR_DEBUG("outputs=%s", src);

    if (!(strings = virStringSplitCount(src, " ", 0, &count)))
        goto cleanup;

    for (i = 0; i < count; i++) {
        /* virStringSplit may return empty strings */
        if (STREQ(strings[i], ""))
            continue;

        if (!(output = virLogParseOutput(strings[i])))
            goto cleanup;

        /* let's check if a duplicate output does not already exist in which
         * case we need to replace it with its last occurrence, however, rather
         * than first deleting the duplicate and then adding the new one, the
         * new output object is added first so in case of an error we don't
         * lose the old entry
         */
        at = virLogFindOutput(list, noutputs, output->dest, output->name);
        if (VIR_APPEND_ELEMENT(list, noutputs, output) < 0) {
            virLogOutputFree(output);
            goto cleanup;
        }
        if (at >= 0) {
            virLogOutputFree(list[at]);
            VIR_DELETE_ELEMENT(list, at, noutputs);
        }
    }

    ret = noutputs;
    *outputs = list;
    list = NULL;
 cleanup:
    virStringFreeList(strings);
    return ret;
}
1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722

/**
 * virLogParseFilters:
 * @src: string defining a (set of) filter(s)
 * @filters: pointer to a list where the individual filters shall be parsed
 *
 * This method parses @src and produces a list of individual filters which then
 * needs to be passed to virLogDefineFilters in order to be set and taken into
 * effect.
 * Multiple filters can be defined in a single @src, they just need to be
 * separated by spaces.
 *
 * Returns the number of filter parsed or -1 in case of error.
 */
int
virLogParseFilters(const char *src, virLogFilterPtr **filters)
{
    int ret = -1;
    size_t nfilters = 0;
    size_t i, count;
    char **strings = NULL;
    virLogFilterPtr filter = NULL;
    virLogFilterPtr *list = NULL;

    VIR_DEBUG("filters=%s", src);

    if (!(strings = virStringSplitCount(src, " ", 0, &count)))
        goto cleanup;

    for (i = 0; i < count; i++) {
        /* virStringSplit may return empty strings */
        if (STREQ(strings[i], ""))
            continue;

        if (!(filter = virLogParseFilter(strings[i])))
            goto cleanup;

        if (VIR_APPEND_ELEMENT(list, nfilters, filter)) {
            virLogFilterFree(filter);
            goto cleanup;
        }
    }

    ret = nfilters;
    *filters = list;
    list = NULL;
 cleanup:
    virStringFreeList(strings);
    return ret;
}
E
Erik Skultety 已提交
1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753

/**
 * virLogSetOutputs:
 * @outputs: string defining a (set of) output(s)
 *
 * Replaces the current set of defined outputs with a new set of outputs.
 *
 * Returns 0 on success or -1 in case of an error.
 */
int
virLogSetOutputs(const char *src)
{
    int ret = -1;
    int noutputs = 0;
    virLogOutputPtr *outputs = NULL;

    if (virLogInitialize() < 0)
        return -1;

    if ((noutputs = virLogParseOutputs(src, &outputs)) < 0)
        goto cleanup;

    if (virLogDefineOutputs(outputs, noutputs) < 0)
        goto cleanup;

    outputs = NULL;
    ret = 0;
 cleanup:
    virLogOutputListFree(outputs, noutputs);
    return ret;
}
E
Erik Skultety 已提交
1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785


/**
 * virLogSetFilters:
 * @src: string defining a (set of) filter(s)
 *
 * Replaces the current set of defined filters with a new set of filters.
 *
 * Returns 0 on success or -1 in case of an error.
 */
int
virLogSetFilters(const char *src)
{
    int ret = -1;
    int nfilters = 0;
    virLogFilterPtr *filters = NULL;

    if (virLogInitialize() < 0)
        return -1;

    if (src && (nfilters = virLogParseFilters(src, &filters)) < 0)
        goto cleanup;

    if (virLogDefineFilters(filters, nfilters) < 0)
        goto cleanup;

    filters = NULL;
    ret = 0;
 cleanup:
    virLogFilterListFree(filters, nfilters);
    return ret;
}