virlog.c 48.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
#include <stdarg.h>
#include <time.h>
#include <sys/time.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
30
#include <unistd.h>
D
Daniel P. Berrange 已提交
31
#include <sys/uio.h>
D
Daniel Veillard 已提交
32
#if HAVE_SYSLOG_H
33
# include <syslog.h>
D
Daniel Veillard 已提交
34
#endif
D
Daniel P. Berrange 已提交
35 36 37 38
#include <sys/socket.h>
#if HAVE_SYS_UN_H
# include <sys/un.h>
#endif
39
#include <fnmatch.h>
D
Daniel Veillard 已提交
40

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

E
Eric Blake 已提交
53 54 55 56 57 58
/* 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

59 60
#define VIR_FROM_THIS VIR_FROM_NONE

61 62
VIR_LOG_INIT("util.log");

J
Ján Tomko 已提交
63
static GRegex *virLogRegex;
64
static char virLogHostname[HOST_NAME_MAX+1];
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
VIR_ENUM_DECL(virLogDestination);
77 78
VIR_ENUM_IMPL(virLogDestination,
              VIR_LOG_TO_OUTPUT_LAST,
79 80
              "stderr", "syslog", "file", "journald",
);
81

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

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

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

109
static char *virLogDefaultOutput;
110 111
static virLogOutputPtr *virLogOutputs;
static size_t virLogNbOutputs;
D
Daniel Veillard 已提交
112 113 114 115

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

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

131

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

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


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

150

151
static void
152 153
virLogSetDefaultOutputToStderr(void)
{
154 155
    virLogDefaultOutput = g_strdup_printf("%d:stderr",
                                          virLogDefaultPriority);
156 157 158
}


159
static void
160 161 162 163 164 165 166 167 168
virLogSetDefaultOutputToJournald(void)
{
    virLogPriority priority = virLogDefaultPriority;

    /* By default we don't want to log too much stuff into journald as
     * it may employ rate limiting and thus block libvirt execution. */
    if (priority == VIR_LOG_DEBUG)
        priority = VIR_LOG_INFO;

169
    virLogDefaultOutput = g_strdup_printf("%d:journald", priority);
170 171 172 173
}


static int
174
virLogSetDefaultOutputToFile(const char *binary, bool privileged)
175
{
176
    g_autofree char *logdir = NULL;
177 178 179
    mode_t old_umask;

    if (privileged) {
180 181
        virLogDefaultOutput = g_strdup_printf("%d:file:%s/log/libvirt/%s.log",
                                              virLogDefaultPriority, LOCALSTATEDIR, binary);
182 183
    } else {
        if (!(logdir = virGetUserCacheDirectory()))
184
            return -1;
185 186 187 188

        old_umask = umask(077);
        if (virFileMakePath(logdir) < 0) {
            umask(old_umask);
189
            return -1;
190 191 192
        }
        umask(old_umask);

193 194
        virLogDefaultOutput = g_strdup_printf("%d:file:%s/%s.log",
                                              virLogDefaultPriority, logdir, binary);
195 196
    }

197
    return 0;
198 199 200 201 202
}


/*
 * virLogSetDefaultOutput:
203 204
 * @binary: the binary for which logging is performed. The log file name
 *          will be derived from the binary name, with ".log" appended.
205 206 207 208
 * @godaemon: whether we're running daemonized
 * @privileged: whether we're running with root privileges or not (session)
 *
 * Decides on what the default output (journald, file, stderr) should be
209
 * according to @binary, @godaemon, @privileged. This function should be run
210 211
 * exactly once at daemon startup, so no locks are used.
 */
212
void
213
virLogSetDefaultOutput(const char *binary, bool godaemon, bool privileged)
214
{
215 216 217 218
    bool have_journald = access("/run/systemd/journal/socket", W_OK) >= 0;

    if (godaemon) {
        if (have_journald)
219 220 221
            virLogSetDefaultOutputToJournald();
        else
            virLogSetDefaultOutputToFile(binary, privileged);
222 223
    } else {
        if (!isatty(STDIN_FILENO) && have_journald)
224 225 226
            virLogSetDefaultOutputToJournald();
        else
            virLogSetDefaultOutputToStderr();
227
    }
228 229 230 231 232 233 234 235 236 237
}


char *
virLogGetDefaultOutput(void)
{
    return virLogDefaultOutput;
}


238 239 240
static const char *
virLogPriorityString(virLogPriority lvl)
{
D
Daniel Veillard 已提交
241
    switch (lvl) {
242 243 244 245 246 247 248 249
    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 已提交
250
    }
251
    return "unknown";
D
Daniel Veillard 已提交
252 253 254
}


255 256
static int
virLogOnceInit(void)
257
{
258 259
    int r;

260 261 262
    if (virMutexInit(&virLogMutex) < 0)
        return -1;

D
Daniel Veillard 已提交
263
    virLogLock();
264
    virLogDefaultPriority = VIR_LOG_DEFAULT;
265

J
Ján Tomko 已提交
266
    virLogRegex = g_regex_new(VIR_LOG_REGEX, G_REGEX_OPTIMIZE, 0, NULL);
267

268 269 270
    /* We get and remember the hostname early, because at later time
     * it might not be possible to load NSS modules via getaddrinfo()
     * (e.g. at container startup the host filesystem will not be
271 272 273 274 275 276
     * accessible anymore.
     * Must not use virGetHostname though as that causes re-entrancy
     * problems if it triggers logging codepaths
     */
    r = gethostname(virLogHostname, sizeof(virLogHostname));
    if (r == -1) {
277
        ignore_value(virStrcpyStatic(virLogHostname, "(unknown)"));
278 279 280
    } else {
        NUL_TERMINATE(virLogHostname);
    }
281

D
Daniel Veillard 已提交
282
    virLogUnlock();
283
    return 0;
D
Daniel Veillard 已提交
284 285
}

286
VIR_ONCE_GLOBAL_INIT(virLog);
287

288

D
Daniel Veillard 已提交
289 290 291 292 293 294 295
/**
 * virLogReset:
 *
 * Reset the logging module to its default initial state
 *
 * Returns 0 if successful, and -1 in case or error
 */
296 297 298
int
virLogReset(void)
{
299 300
    if (virLogInitialize() < 0)
        return -1;
D
Daniel Veillard 已提交
301 302 303 304

    virLogLock();
    virLogResetFilters();
    virLogResetOutputs();
305
    virLogDefaultPriority = VIR_LOG_DEFAULT;
D
Daniel Veillard 已提交
306
    virLogUnlock();
307
    return 0;
D
Daniel Veillard 已提交
308 309 310 311 312 313 314 315 316 317 318 319
}

/**
 * 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.
 */
320 321 322
int
virLogSetDefaultPriority(virLogPriority priority)
{
323
    if ((priority < VIR_LOG_DEBUG) || (priority > VIR_LOG_ERROR)) {
324 325 326
        virReportError(VIR_ERR_INVALID_ARG,
                       _("Failed to set logging priority, argument '%u' is "
                         "invalid"), priority);
327
        return -1;
328
    }
329 330 331
    if (virLogInitialize() < 0)
        return -1;

D
Daniel Veillard 已提交
332
    virLogDefaultPriority = priority;
333
    return 0;
D
Daniel Veillard 已提交
334 335
}

336

D
Daniel Veillard 已提交
337 338 339 340 341
/**
 * virLogResetFilters:
 *
 * Removes the set of logging filters defined.
 */
342
static void
343 344
virLogResetFilters(void)
{
345 346
    virLogFilterListFree(virLogFilters, virLogNbFilters);
    virLogFilters = NULL;
D
Daniel Veillard 已提交
347
    virLogNbFilters = 0;
348
    virLogFiltersSerial++;
D
Daniel Veillard 已提交
349 350
}

351

352 353 354 355 356 357 358 359 360 361
void
virLogFilterFree(virLogFilterPtr filter)
{
    if (!filter)
        return;

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

362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383

/**
 * 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 已提交
384 385 386 387 388
/**
 * virLogResetOutputs:
 *
 * Removes the set of logging output defined.
 */
389
static void
390 391
virLogResetOutputs(void)
{
392 393
    virLogOutputListFree(virLogOutputs, virLogNbOutputs);
    virLogOutputs = NULL;
D
Daniel Veillard 已提交
394 395 396
    virLogNbOutputs = 0;
}

397

398 399 400 401 402 403 404 405 406 407 408 409 410
void
virLogOutputFree(virLogOutputPtr output)
{
    if (!output)
        return;

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

}

411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432

/**
 * 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);
}


433
static void
434
virLogFormatString(char **msg,
435
                   int linenr,
436
                   const char *funcname,
437
                   virLogPriority priority,
438 439
                   const char *str)
{
440 441 442 443 444 445 446
    /*
     * 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.
     */
447
    if ((funcname != NULL)) {
448
        *msg = g_strdup_printf("%llu: %s : %s:%d : %s\n",
449 450
                               virThreadSelfID(), virLogPriorityString(priority),
                               funcname, linenr, str);
451
    } else {
452
        *msg = g_strdup_printf("%llu: %s : %s\n",
453 454
                               virThreadSelfID(), virLogPriorityString(priority),
                               str);
455 456 457
    }
}

458

459
static void
460 461
virLogVersionString(const char **rawmsg,
                    char **msg)
462
{
463
    *rawmsg = VIR_LOG_VERSION_STRING;
464
    virLogFormatString(msg, 0, NULL, VIR_LOG_INFO, VIR_LOG_VERSION_STRING);
465 466
}

467 468 469
/* Similar to virGetHostname() but avoids use of error
 * reporting APIs or logging APIs, to prevent recursion
 */
470
static void
471
virLogHostnameString(char **rawmsg,
472 473 474 475
                     char **msg)
{
    char *hoststr;

476
    hoststr = g_strdup_printf("hostname: %s", virLogHostname);
477

478
    virLogFormatString(msg, 0, NULL, VIR_LOG_INFO, hoststr);
479 480 481
    *rawmsg = hoststr;
}

482

483 484 485 486 487 488 489 490 491
static void
virLogSourceUpdate(virLogSourcePtr source)
{
    virLogLock();
    if (source->serial < virLogFiltersSerial) {
        unsigned int priority = virLogDefaultPriority;
        size_t i;

        for (i = 0; i < virLogNbFilters; i++) {
492
            if (fnmatch(virLogFilters[i]->match, source->name, 0) == 0) {
493
                priority = virLogFilters[i]->priority;
494 495 496 497 498 499 500 501 502 503
                break;
            }
        }

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

D
Daniel Veillard 已提交
504 505
/**
 * virLogMessage:
506
 * @source: where is that message coming from
D
Daniel Veillard 已提交
507
 * @priority: the priority level
508
 * @filename: file where the message was emitted
509
 * @linenr: line where the message was emitted
510
 * @funcname: the function emitting the (debug) message
511
 * @metadata: NULL or metadata array, terminated by an item with NULL key
D
Daniel Veillard 已提交
512 513 514
 * @fmt: the string format
 * @...: the arguments
 *
E
Eric Blake 已提交
515
 * Call the libvirt logger with some information. Based on the configuration
D
Daniel Veillard 已提交
516 517
 * the message may be stored, sent to output or just discarded
 */
518
void
519
virLogMessage(virLogSourcePtr source,
520
              virLogPriority priority,
521
              const char *filename,
522
              int linenr,
523
              const char *funcname,
524
              virLogMetadataPtr metadata,
525
              const char *fmt, ...)
526 527 528
{
    va_list ap;
    va_start(ap, fmt);
529
    virLogVMessage(source, priority,
530
                   filename, linenr, funcname,
531
                   metadata, fmt, ap);
532 533 534
    va_end(ap);
}

535

536 537
/**
 * virLogVMessage:
538
 * @source: where is that message coming from
539
 * @priority: the priority level
540
 * @filename: file where the message was emitted
541
 * @linenr: line where the message was emitted
542
 * @funcname: the function emitting the (debug) message
543
 * @metadata: NULL or metadata array, terminated by an item with NULL key
544 545 546 547 548 549
 * @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
 */
550
void
551
virLogVMessage(virLogSourcePtr source,
552
               virLogPriority priority,
553
               const char *filename,
554
               int linenr,
555
               const char *funcname,
M
Miloslav Trmač 已提交
556
               virLogMetadataPtr metadata,
557 558
               const char *fmt,
               va_list vargs)
559
{
560
    static bool logInitMessageStderr = true;
D
Daniel Veillard 已提交
561
    char *str = NULL;
562
    char *msg = NULL;
563
    char timestamp[VIR_TIME_STRING_BUFLEN];
564
    size_t i;
565
    int saved_errno = errno;
D
Daniel Veillard 已提交
566

567 568
    if (virLogInitialize() < 0)
        return;
D
Daniel Veillard 已提交
569 570

    if (fmt == NULL)
571
        return;
D
Daniel Veillard 已提交
572 573

    /*
574 575 576 577 578 579
     * 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 已提交
580
     */
581 582 583
    if (source->serial < virLogFiltersSerial)
        virLogSourceUpdate(source);
    if (priority < source->priority)
584 585
        goto cleanup;

D
Daniel Veillard 已提交
586 587 588
    /*
     * serialize the error message, add level and timestamp
     */
589
    str = g_strdup_vprintf(fmt, vargs);
D
Daniel Veillard 已提交
590

591
    virLogFormatString(&msg, linenr, funcname, priority, str);
D
Daniel Veillard 已提交
592

593 594
    if (virTimeStringNowRaw(timestamp) < 0)
        timestamp[0] = '\0';
595

596 597
    virLogLock();

D
Daniel Veillard 已提交
598
    /*
599
     * Push the message to the outputs defined, if none exist then
D
Daniel Veillard 已提交
600 601
     * use stderr.
     */
602
    for (i = 0; i < virLogNbOutputs; i++) {
603 604
        if (priority >= virLogOutputs[i]->priority) {
            if (virLogOutputs[i]->logInitMessage) {
605
                const char *rawinitmsg;
606
                char *hoststr = NULL;
607
                char *initmsg = NULL;
608 609 610 611 612
                virLogVersionString(&rawinitmsg, &initmsg);
                virLogOutputs[i]->f(&virLogSelf, VIR_LOG_INFO,
                                    __FILE__, __LINE__, __func__,
                                    timestamp, NULL, rawinitmsg, initmsg,
                                    virLogOutputs[i]->data);
613
                VIR_FREE(initmsg);
614 615 616 617 618 619

                virLogHostnameString(&hoststr, &initmsg);
                virLogOutputs[i]->f(&virLogSelf, VIR_LOG_INFO,
                                    __FILE__, __LINE__, __func__,
                                    timestamp, NULL, hoststr, initmsg,
                                    virLogOutputs[i]->data);
620
                VIR_FREE(hoststr);
621
                VIR_FREE(initmsg);
622
                virLogOutputs[i]->logInitMessage = false;
623
            }
624
            virLogOutputs[i]->f(source, priority,
625
                                filename, linenr, funcname,
626
                                timestamp, metadata,
627
                                str, msg, virLogOutputs[i]->data);
628
        }
D
Daniel Veillard 已提交
629
    }
630
    if (virLogNbOutputs == 0) {
631 632
        if (logInitMessageStderr) {
            const char *rawinitmsg;
633
            char *hoststr = NULL;
634
            char *initmsg = NULL;
635 636 637 638 639
            virLogVersionString(&rawinitmsg, &initmsg);
            virLogOutputToFd(&virLogSelf, VIR_LOG_INFO,
                             __FILE__, __LINE__, __func__,
                             timestamp, NULL, rawinitmsg, initmsg,
                             (void *) STDERR_FILENO);
640
            VIR_FREE(initmsg);
641 642 643 644 645 646

            virLogHostnameString(&hoststr, &initmsg);
            virLogOutputToFd(&virLogSelf, VIR_LOG_INFO,
                             __FILE__, __LINE__, __func__,
                             timestamp, NULL, hoststr, initmsg,
                             (void *) STDERR_FILENO);
647
            VIR_FREE(hoststr);
648 649
            VIR_FREE(initmsg);
            logInitMessageStderr = false;
650
        }
651
        virLogOutputToFd(source, priority,
652
                         filename, linenr, funcname,
653
                         timestamp, metadata,
654
                         str, msg, (void *) STDERR_FILENO);
655
    }
D
Daniel Veillard 已提交
656 657
    virLogUnlock();

658
 cleanup:
659
    VIR_FREE(str);
660
    VIR_FREE(msg);
661
    errno = saved_errno;
D
Daniel Veillard 已提交
662 663
}

664

665
static void
J
Ján Tomko 已提交
666 667 668 669 670
virLogOutputToFd(virLogSourcePtr source G_GNUC_UNUSED,
                 virLogPriority priority G_GNUC_UNUSED,
                 const char *filename G_GNUC_UNUSED,
                 int linenr G_GNUC_UNUSED,
                 const char *funcname G_GNUC_UNUSED,
671
                 const char *timestamp,
J
Ján Tomko 已提交
672 673
                 virLogMetadataPtr metadata G_GNUC_UNUSED,
                 const char *rawstr G_GNUC_UNUSED,
674 675
                 const char *str,
                 void *data)
676
{
677
    int fd = (intptr_t) data;
678
    char *msg;
D
Daniel Veillard 已提交
679 680

    if (fd < 0)
681
        return;
682

683
    msg = g_strdup_printf("%s: %s", timestamp, str);
684
    ignore_value(safewrite(fd, msg, strlen(msg)));
685
    VIR_FREE(msg);
D
Daniel Veillard 已提交
686 687
}

688 689 690

static void
virLogCloseFd(void *data)
691
{
692
    int fd = (intptr_t) data;
D
Daniel Veillard 已提交
693

694
    VIR_LOG_CLOSE(fd);
D
Daniel Veillard 已提交
695 696
}

697

698
static virLogOutputPtr
699 700 701 702 703 704 705
virLogNewOutputToStderr(virLogPriority priority)
{
    return virLogOutputNew(virLogOutputToFd, NULL, (void *)STDERR_FILENO,
                           priority, VIR_LOG_TO_STDERR, NULL);
}


706
static virLogOutputPtr
707 708 709 710 711 712 713
virLogNewOutputToFile(virLogPriority priority,
                      const char *file)
{
    int fd;
    virLogOutputPtr ret = NULL;

    fd = open(file, O_CREAT | O_APPEND | O_WRONLY, S_IRUSR | S_IWUSR);
714 715
    if (fd < 0) {
        virReportSystemError(errno, _("failed to open %s"), file);
716
        return NULL;
717
    }
718 719 720 721 722 723 724 725 726 727 728

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


729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
#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

745 746
static int
virLogPrioritySyslog(virLogPriority priority)
747 748 749 750 751 752 753 754 755 756 757 758 759 760
{
    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;
    }
}
761
#endif /* HAVE_SYSLOG_H || USE_JOURNALD */
762

763

764
#if HAVE_SYSLOG_H
765
static void
J
Ján Tomko 已提交
766
virLogOutputToSyslog(virLogSourcePtr source G_GNUC_UNUSED,
767
                     virLogPriority priority,
J
Ján Tomko 已提交
768 769 770 771 772 773
                     const char *filename G_GNUC_UNUSED,
                     int linenr G_GNUC_UNUSED,
                     const char *funcname G_GNUC_UNUSED,
                     const char *timestamp G_GNUC_UNUSED,
                     virLogMetadataPtr metadata G_GNUC_UNUSED,
                     const char *rawstr G_GNUC_UNUSED,
774
                     const char *str,
J
Ján Tomko 已提交
775
                     void *data G_GNUC_UNUSED)
776
{
777
    syslog(virLogPrioritySyslog(priority), "%s", str);
D
Daniel Veillard 已提交
778 779
}

780
static char *current_ident;
781

782 783

static void
J
Ján Tomko 已提交
784
virLogCloseSyslog(void *data G_GNUC_UNUSED)
785
{
D
Daniel Veillard 已提交
786
    closelog();
787
    VIR_FREE(current_ident);
D
Daniel Veillard 已提交
788 789
}

790

791
static virLogOutputPtr
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
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);
818
        current_ident = g_strdup(ident);
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834

        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 已提交
835
# if USE_JOURNALD
836 837 838 839 840
#  define IOVEC_SET(iov, data, size) \
    do { \
        struct iovec *_i = &(iov); \
        _i->iov_base = (void*)(data); \
        _i->iov_len = (size); \
D
Daniel P. Berrange 已提交
841 842
    } while (0)

843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907
#  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 已提交
908 909

static void
910
virLogOutputToJournald(virLogSourcePtr source,
D
Daniel P. Berrange 已提交
911 912 913 914
                       virLogPriority priority,
                       const char *filename,
                       int linenr,
                       const char *funcname,
J
Ján Tomko 已提交
915
                       const char *timestamp G_GNUC_UNUSED,
916
                       virLogMetadataPtr metadata,
D
Daniel P. Berrange 已提交
917
                       const char *rawstr,
J
Ján Tomko 已提交
918
                       const char *str G_GNUC_UNUSED,
919
                       void *data)
D
Daniel P. Berrange 已提交
920 921
{
    int buffd = -1;
922
    int journalfd = (intptr_t) data;
D
Daniel P. Berrange 已提交
923 924 925 926 927 928 929 930 931 932 933
    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";
934
    size_t nmetadata = 0;
D
Daniel P. Berrange 已提交
935

936 937 938
#  define NUM_FIELDS_CORE 6
#  define NUM_FIELDS_META 5
#  define NUM_FIELDS (NUM_FIELDS_CORE + NUM_FIELDS_META)
939 940 941
    struct iovec iov[NUM_FIELDS * 5];
    char iov_bufs[NUM_FIELDS][JOURNAL_BUF_SIZE];
    struct journalState state;
D
Daniel P. Berrange 已提交
942

943
    state.iov = iov;
944
    state.iov_end = iov + G_N_ELEMENTS(iov);
945
    state.bufs = iov_bufs;
946
    state.bufs_end = iov_bufs + G_N_ELEMENTS(iov_bufs);
D
Daniel P. Berrange 已提交
947

E
Eric Blake 已提交
948
    journalAddString(&state, "MESSAGE", rawstr);
949 950
    journalAddInt(&state, "PRIORITY",
                  virLogPrioritySyslog(priority));
951
    journalAddInt(&state, "SYSLOG_FACILITY", LOG_DAEMON);
952
    journalAddString(&state, "LIBVIRT_SOURCE", source->name);
953 954
    if (filename)
        journalAddString(&state, "CODE_FILE", filename);
955
    journalAddInt(&state, "CODE_LINE", linenr);
956 957
    if (funcname)
        journalAddString(&state, "CODE_FUNC", funcname);
958 959 960 961 962 963 964 965 966 967 968
    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 已提交
969 970 971

    memset(&sa, 0, sizeof(sa));
    sa.sun_family = AF_UNIX;
972
    if (virStrcpyStatic(sa.sun_path, "/run/systemd/journal/socket") < 0)
D
Daniel P. Berrange 已提交
973 974 975 976 977 978
        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;
979
    mh.msg_iovlen = state.iov - iov;
D
Daniel P. Berrange 已提交
980 981 982 983 984 985 986 987 988 989 990

    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
     */

J
Ján Tomko 已提交
991
    if ((buffd = g_mkstemp_full(path, O_RDWR | O_CLOEXEC, S_IRUSR | S_IWUSR)) < 0)
D
Daniel P. Berrange 已提交
992 993 994 995 996
        return;

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

997
    if (writev(buffd, iov, state.iov - iov) < 0)
D
Daniel P. Berrange 已提交
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
        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;

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

1017
 cleanup:
D
Daniel P. Berrange 已提交
1018 1019 1020 1021
    VIR_LOG_CLOSE(buffd);
}


1022
static virLogOutputPtr
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044
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 已提交
1045
# endif /* USE_JOURNALD */
J
Ján Tomko 已提交
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066

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 */
J
Ján Tomko 已提交
1067
int virLogPriorityFromSyslog(int priority G_GNUC_UNUSED)
J
Ján Tomko 已提交
1068 1069 1070
{
    return VIR_LOG_ERROR;
}
D
Daniel Veillard 已提交
1071 1072
#endif /* HAVE_SYSLOG_H */

1073

1074 1075 1076 1077 1078
/**
 * virLogGetDefaultPriority:
 *
 * Returns the current logging priority level.
 */
1079 1080 1081
virLogPriority
virLogGetDefaultPriority(void)
{
1082
    return virLogDefaultPriority;
1083 1084
}

1085

1086 1087 1088 1089 1090 1091 1092
/**
 * virLogGetFilters:
 *
 * Returns a string listing the current filters, in the format originally
 * specified in the config file or environment. Caller must free the
 * result.
 */
1093 1094 1095
char *
virLogGetFilters(void)
{
1096
    size_t i;
1097 1098 1099 1100
    virBuffer filterbuf = VIR_BUFFER_INITIALIZER;

    virLogLock();
    for (i = 0; i < virLogNbFilters; i++) {
1101 1102
        const char *sep = ":";
        virBufferAsprintf(&filterbuf, "%d%s%s ",
1103
                          virLogFilters[i]->priority,
1104
                          sep,
1105
                          virLogFilters[i]->match);
1106 1107 1108 1109 1110 1111
    }
    virLogUnlock();

    return virBufferContentAndReset(&filterbuf);
}

1112

1113 1114 1115 1116 1117 1118 1119
/**
 * virLogGetOutputs:
 *
 * Returns a string listing the current outputs, in the format originally
 * specified in the config file or environment. Caller must free the
 * result.
 */
1120 1121 1122
char *
virLogGetOutputs(void)
{
1123
    size_t i;
1124 1125 1126 1127
    virBuffer outputbuf = VIR_BUFFER_INITIALIZER;

    virLogLock();
    for (i = 0; i < virLogNbOutputs; i++) {
1128
        virLogDestination dest = virLogOutputs[i]->dest;
1129
        if (i)
1130
            virBufferAddChar(&outputbuf, ' ');
1131 1132 1133
        switch (dest) {
            case VIR_LOG_TO_SYSLOG:
            case VIR_LOG_TO_FILE:
1134
                virBufferAsprintf(&outputbuf, "%d:%s:%s",
1135
                                  virLogOutputs[i]->priority,
1136
                                  virLogDestinationTypeToString(dest),
1137
                                  virLogOutputs[i]->name);
1138
                break;
1139 1140
            case VIR_LOG_TO_STDERR:
            case VIR_LOG_TO_JOURNALD:
1141
                virBufferAsprintf(&outputbuf, "%d:%s",
1142
                                  virLogOutputs[i]->priority,
1143
                                  virLogDestinationTypeToString(dest));
1144 1145 1146 1147 1148
                break;
            case VIR_LOG_TO_OUTPUT_LAST:
            default:
                virReportEnumRangeError(virLogDestination, dest);
                goto error;
1149 1150 1151
        }
    }

1152
    virLogUnlock();
1153
    return virBufferContentAndReset(&outputbuf);
1154 1155 1156 1157 1158

 error:
    virLogUnlock();
    virBufferFreeAndReset(&outputbuf);
    return NULL;
1159 1160
}

1161

1162 1163 1164 1165 1166
/**
 * virLogGetNbFilters:
 *
 * Returns the current number of defined log filters.
 */
1167 1168 1169
int
virLogGetNbFilters(void)
{
1170
    return virLogNbFilters;
1171 1172
}

1173

1174 1175 1176 1177 1178
/**
 * virLogGetNbOutputs:
 *
 * Returns the current number of defined log outputs.
 */
1179 1180 1181
int
virLogGetNbOutputs(void)
{
1182
    return virLogNbOutputs;
1183
}
1184

1185

1186 1187
/**
 * virLogParseDefaultPriority:
1188 1189
 * @priority: string defining the desired logging level (either a numeric or a
 *            word form, see below)
1190
 *
1191 1192 1193 1194 1195 1196
 * 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
1197
 *
1198 1199 1200 1201
 *
 * Returns the corresponding priority enum on success, -1 in case of error. A
 * call to virLogSetDefaultPriority should be issued upon returning from this
 * function.
1202
 */
1203 1204 1205
int
virLogParseDefaultPriority(const char *priority)
{
1206
    if (STREQ(priority, "1") || STREQ(priority, "debug"))
1207
        return VIR_LOG_DEBUG;
1208
    else if (STREQ(priority, "2") || STREQ(priority, "info"))
1209
        return VIR_LOG_INFO;
1210
    else if (STREQ(priority, "3") || STREQ(priority, "warning"))
1211
        return VIR_LOG_WARN;
1212
    else if (STREQ(priority, "4") || STREQ(priority, "error"))
1213 1214
        return VIR_LOG_ERROR;
    return -1;
1215 1216
}

1217

1218 1219 1220 1221 1222 1223
/**
 * virLogSetFromEnv:
 *
 * Sets virLogDefaultPriority, virLogFilters and virLogOutputs based on
 * environment variables.
 */
1224 1225 1226
void
virLogSetFromEnv(void)
{
1227
    const char *debugEnv;
1228

1229 1230 1231
    if (virLogInitialize() < 0)
        return;

1232
    debugEnv = getenv("LIBVIRT_DEBUG");
1233
    if (debugEnv && *debugEnv)
1234
        virLogSetDefaultPriority(virLogParseDefaultPriority(debugEnv));
1235
    debugEnv = getenv("LIBVIRT_LOG_FILTERS");
1236
    if (debugEnv && *debugEnv)
1237
        virLogSetFilters(debugEnv);
1238
    debugEnv = getenv("LIBVIRT_LOG_OUTPUTS");
1239
    if (debugEnv && *debugEnv)
1240
        virLogSetOutputs(debugEnv);
1241
}
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252


/*
 * 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)
{
    if (!virLogRegex)
        return false;
J
Ján Tomko 已提交
1253 1254 1255
    if (g_regex_match(virLogRegex, str, 0, NULL))
        return true;
    return false;
1256
}
E
Erik Skultety 已提交
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292


/**
 * 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;
        }

1293
        ndup = g_strdup(name);
E
Erik Skultety 已提交
1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310
    }

    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 已提交
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329


/**
 * virLogFilterNew:
 * @match: the pattern to match
 * @priority: the priority to give to messages matching the pattern
 *
 * 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,
1330
                virLogPriority priority)
E
Erik Skultety 已提交
1331 1332 1333
{
    virLogFilterPtr ret = NULL;
    char *mdup = NULL;
1334
    size_t mlen = strlen(match);
E
Erik Skultety 已提交
1335 1336 1337 1338 1339 1340 1341

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

1342 1343 1344 1345
    /* We must treat 'foo' as equiv to '*foo*' for fnmatch
     * todo substring matches, so add 2 extra bytes
     */
    if (VIR_ALLOC_N_QUIET(mdup, mlen + 3) < 0)
E
Erik Skultety 已提交
1346 1347
        return NULL;

1348 1349 1350 1351
    mdup[0] = '*';
    memcpy(mdup + 1, match, mlen);
    mdup[mlen + 1] = '*';

E
Erik Skultety 已提交
1352 1353 1354 1355 1356 1357 1358 1359 1360 1361
    if (VIR_ALLOC_QUIET(ret) < 0) {
        VIR_FREE(mdup);
        return NULL;
    }

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

    return ret;
}
E
Erik Skultety 已提交
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393


/**
 * 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;
}
1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407


/**
 * 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)
{
1408
#if HAVE_SYSLOG_H
1409 1410
    int id;
    char *tmp = NULL;
1411
#endif /* HAVE_SYSLOG_H */
1412

1413 1414 1415 1416 1417
    if (virLogInitialize() < 0)
        return -1;

    virLogLock();
    virLogResetOutputs();
1418

1419
#if HAVE_SYSLOG_H
1420 1421 1422 1423 1424 1425 1426
    /* 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
         */
1427
        tmp = g_strdup(outputs[id]->name);
1428 1429 1430 1431
        VIR_FREE(current_ident);
        current_ident = tmp;
        openlog(current_ident, 0, 0);
    }
1432
#endif /* HAVE_SYSLOG_H */
1433

1434 1435 1436
    virLogOutputs = outputs;
    virLogNbOutputs = noutputs;

1437
    virLogUnlock();
1438
    return 0;
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


/**
 * 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;
}
1467 1468 1469 1470 1471 1472 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


/**
 * 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;

    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);
1511
        goto cleanup;
1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 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
    }

    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;
    }

    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:
1564
    virStringListFree(tokens);
1565 1566
    return ret;
}
1567 1568 1569 1570 1571 1572


/**
 * virLogParseFilter:
 * @src: string defining a single filter
 *
1573
 * The format of @src should be:
1574 1575 1576 1577 1578 1579 1580 1581 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
 *    x:name - filter affecting all modules which match 'name'
 *      '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;
    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);
1608
        goto cleanup;
1609 1610 1611 1612 1613
    }

    if (virStrToLong_uip(tokens[0], NULL, 10, &prio) < 0 ||
        (prio < VIR_LOG_DEBUG) || (prio > VIR_LOG_ERROR)) {
        virReportError(VIR_ERR_INVALID_ARG,
1614
                       _("Invalid priority '%s' for filter '%s'"),
1615 1616 1617 1618 1619 1620
                       tokens[0], src);
        goto cleanup;
    }

    match = tokens[1];
    if (match[0] == '+') {
1621 1622 1623
        /* '+' used to indicate printing a stack trace,
         * but we dropped that feature, so just chomp
         * that leading '+' */
1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634
        match++;
    }

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

        goto cleanup;
    }

1635
    if (!(ret = virLogFilterNew(match, prio)))
1636 1637 1638
        goto cleanup;

 cleanup:
1639
    virStringListFree(tokens);
1640 1641
    return ret;
}
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 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

/**
 * 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:
1699
    virStringListFree(strings);
1700 1701
    return ret;
}
1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 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

/**
 * 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:
1749
    virStringListFree(strings);
1750 1751
    return ret;
}
E
Erik Skultety 已提交
1752 1753 1754 1755 1756 1757

/**
 * virLogSetOutputs:
 * @outputs: string defining a (set of) output(s)
 *
 * Replaces the current set of defined outputs with a new set of outputs.
1758 1759
 * Should the set be empty or NULL, a default output is used according to the
 * daemon's runtime attributes.
E
Erik Skultety 已提交
1760 1761 1762 1763 1764 1765 1766 1767
 *
 * Returns 0 on success or -1 in case of an error.
 */
int
virLogSetOutputs(const char *src)
{
    int ret = -1;
    int noutputs = 0;
1768
    const char *outputstr = virLogDefaultOutput;
E
Erik Skultety 已提交
1769 1770 1771 1772 1773
    virLogOutputPtr *outputs = NULL;

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

1774 1775 1776
    if (src && *src)
        outputstr = src;

1777 1778 1779 1780 1781 1782 1783
    /* This can only happen during daemon init when the default output is not
     * determined yet. It's safe to do, since it's the only place setting the
     * default output.
     */
    if (!outputstr)
        return 0;

1784
    if ((noutputs = virLogParseOutputs(outputstr, &outputs)) < 0)
E
Erik Skultety 已提交
1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795
        goto cleanup;

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

    outputs = NULL;
    ret = 0;
 cleanup:
    virLogOutputListFree(outputs, noutputs);
    return ret;
}
E
Erik Skultety 已提交
1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827


/**
 * 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;
}