Turn virLogSource into a struct instead of an enum

As part of the goal to get away from doing string matching on
filenames when deciding whether to emit a log message, turn
the virLogSource enum into a struct which contains a log
"name". There will eventually be one virLogSource instance
statically declared per source file. To minimise churn in this
commit though, a single global instance is used.

Signed-off-by: Daniel P. Berrange <berrange@redhat.com>

diff --git a/src/libvirt_private.syms b/src/libvirt_private.syms
index aaaac2f73bccfb5ff9d545c98f594c9ca46d04ce..3a7ae6ef7d9524019a97fa0b02b36832e85bd0b4 100644 (file)
--- a/src/libvirt_private.syms
+++ b/src/libvirt_private.syms
@@ -1462,6 +1462,7 @@ virLogParseOutputs;
 virLogPriorityFromSyslog;
 virLogProbablyLogMessage;
 virLogReset;
+virLogSelf;
 virLogSetBufferSize;
 virLogSetDefaultPriority;
 virLogSetFromEnv;

diff --git a/src/node_device/node_device_udev.c b/src/node_device/node_device_udev.c
index 5d499682f2456e39d19e37dad4a35e0fcbf95a41..5c48fe88d354ac6ea0621e8a4b76bd3691fee041 100644 (file)
--- a/src/node_device/node_device_udev.c
+++ b/src/node_device/node_device_udev.c
@@ -374,7 +374,7 @@ udevLogFunction(struct udev *udev ATTRIBUTE_UNUSED,
 
     format = virBufferContentAndReset(&buf);
 
-    virLogVMessage(VIR_LOG_FROM_LIBRARY,
+    virLogVMessage(&virLogSelf,
                    virLogPriorityFromSyslog(priority),
                    file, line, fn, NULL, format ? format : fmt, args);
 

diff --git a/src/qemu/qemu_capabilities.c b/src/qemu/qemu_capabilities.c
index 47f8bcb9f9887571367868ce8c5332d689c85649..c6224bd3050e2f8d962b687f117856a6c81e7cea 100644 (file)
--- a/src/qemu/qemu_capabilities.c
+++ b/src/qemu/qemu_capabilities.c
@@ -3178,7 +3178,7 @@ virQEMUCapsLogProbeFailure(const char *binary)
     };
     virErrorPtr err = virGetLastError();
 
-    virLogMessage(VIR_LOG_FROM_FILE,
+    virLogMessage(&virLogSelf,
                   VIR_LOG_WARN,
                   __FILE__, __LINE__, __func__,
                   meta,

diff --git a/src/util/viraudit.c b/src/util/viraudit.c
index 5dd4e1fc74f06152da4ed920a0fab01f618220be..ac787f88499bdf201b896d71ab7c4e66df41c9e0 100644 (file)
--- a/src/util/viraudit.c
+++ b/src/util/viraudit.c
@@ -74,7 +74,8 @@ void virAuditLog(int logging)
 }
 
 
-void virAuditSend(const char *filename,
+void virAuditSend(virLogSourcePtr source,
+                  const char *filename,
                   size_t linenr,
                   const char *funcname,
                   const char *clienttty ATTRIBUTE_UNUSED,
@@ -104,11 +105,11 @@ void virAuditSend(const char *filename,
 
     if (auditlog && str) {
         if (success)
-            virLogMessage(VIR_LOG_FROM_AUDIT, VIR_LOG_INFO,
+            virLogMessage(source, VIR_LOG_INFO,
                           filename, linenr, funcname,
                           NULL, "success=yes %s", str);
         else
-            virLogMessage(VIR_LOG_FROM_AUDIT, VIR_LOG_WARN,
+            virLogMessage(source, VIR_LOG_WARN,
                           filename, linenr, funcname,
                           NULL, "success=no %s", str);
     }

diff --git a/src/util/viraudit.h b/src/util/viraudit.h
index b0356da0cb0a3480f25d43f4a73d03cce3deca0f..cf3da6c420099ecab7ed8f2754283f97ea0ef9e7 100644 (file)
--- a/src/util/viraudit.h
+++ b/src/util/viraudit.h
@@ -24,6 +24,7 @@
 # define __LIBVIRT_AUDIT_H__
 
 # include "internal.h"
+# include "virlog.h"
 
 enum virAuditRecordType {
     VIR_AUDIT_RECORD_MACHINE_CONTROL,
@@ -35,22 +36,23 @@ int virAuditOpen(void);
 
 void virAuditLog(int enabled);
 
-void virAuditSend(const char *filename, size_t linenr, const char *funcname,
+void virAuditSend(virLogSourcePtr source,
+                  const char *filename, size_t linenr, const char *funcname,
                   const char *clienttty, const char *clientaddr,
                   enum virAuditRecordType type, bool success,
                   const char *fmt, ...)
-    ATTRIBUTE_FMT_PRINTF(8, 9);
+    ATTRIBUTE_FMT_PRINTF(9, 10);
 
 char *virAuditEncode(const char *key, const char *value);
 
 void virAuditClose(void);
 
 # define VIR_AUDIT(type, success, ...)                         \
-    virAuditSend(__FILE__, __LINE__, __func__,                  \
+    virAuditSend(&virLogSelf, __FILE__, __LINE__, __func__,     \
                  NULL, NULL, type, success, __VA_ARGS__);
 
 # define VIR_AUDIT_USER(type, success, clienttty, clientaddr, ...)     \
-    virAuditSend(__FILE__, __LINE__, __func__,                          \
+    virAuditSend(&virLogSelf, __FILE__, __LINE__, __func__,             \
                  clienttty, clientaddr, type, success, __VA_ARGS__);
 
 # define VIR_AUDIT_STR(str) \

diff --git a/src/util/virerror.c b/src/util/virerror.c
index ae303d57a526aff214d04165a202f38e87efc7e2..009d894d697821202e3aa42a7f4f786187c9c5f1 100644 (file)
--- a/src/util/virerror.c
+++ b/src/util/virerror.c
@@ -719,7 +719,7 @@ virRaiseErrorFull(const char *filename ATTRIBUTE_UNUSED,
      */
     if (virLogGetNbOutputs() > 0 ||
         virErrorLogPriorityFilter)
-        virLogMessage(VIR_LOG_FROM_ERROR,
+        virLogMessage(&virLogSelf,
                       priority,
                       filename, linenr, funcname,
                       meta, "%s", str);

diff --git a/src/util/virlog.c b/src/util/virlog.c
index 801f25952ee147ed56a6d51ee07a08bf86e6d276..b53562313042e084cece78f1a2124efeea228151 100644 (file)
--- a/src/util/virlog.c
+++ b/src/util/virlog.c
@@ -60,14 +60,6 @@
 
 #define VIR_FROM_THIS VIR_FROM_NONE
 
-VIR_ENUM_DECL(virLogSource)
-VIR_ENUM_IMPL(virLogSource, VIR_LOG_FROM_LAST,
-              "file",
-              "error",
-              "audit",
-              "trace",
-              "library");
-
 /*
  * A logging buffer to keep some history over logs
  */
@@ -104,6 +96,8 @@ typedef virLogFilter *virLogFilterPtr;
 static virLogFilterPtr virLogFilters = NULL;
 static int virLogNbFilters = 0;
 
+virLogSource virLogSelf = { .name = "util.log" };
+
 /*
  * Outputs are used to emit the messages retained
  * after filtering, multiple output can be used simultaneously
@@ -130,7 +124,7 @@ static virLogPriority virLogDefaultPriority = VIR_LOG_DEFAULT;
 
 static int virLogResetFilters(void);
 static int virLogResetOutputs(void);
-static void virLogOutputToFd(virLogSource src,
+static void virLogOutputToFd(virLogSourcePtr src,
                              virLogPriority priority,
                              const char *filename,
                              int linenr,
@@ -142,6 +136,7 @@ static void virLogOutputToFd(virLogSource src,
                              const char *str,
                              void *data);
 
+
 /*
  * Logs accesses must be serialized though a mutex
  */
@@ -765,7 +760,7 @@ virLogVersionString(const char **rawmsg,
  * the message may be stored, sent to output or just discarded
  */
 void
-virLogMessage(virLogSource source,
+virLogMessage(virLogSourcePtr source,
               virLogPriority priority,
               const char *filename,
               int linenr,
@@ -797,7 +792,7 @@ virLogMessage(virLogSource source,
  * the message may be stored, sent to output or just discarded
  */
 void
-virLogVMessage(virLogSource source,
+virLogVMessage(virLogSourcePtr source,
                virLogPriority priority,
                const char *filename,
                int linenr,
@@ -869,7 +864,7 @@ virLogVMessage(virLogSource source,
                 const char *rawver;
                 char *ver = NULL;
                 if (virLogVersionString(&rawver, &ver) >= 0)
-                    virLogOutputs[i].f(VIR_LOG_FROM_FILE, VIR_LOG_INFO,
+                    virLogOutputs[i].f(&virLogSelf, VIR_LOG_INFO,
                                        __FILE__, __LINE__, __func__,
                                        timestamp, NULL, 0, rawver, ver,
                                        virLogOutputs[i].data);
@@ -887,7 +882,7 @@ virLogVMessage(virLogSource source,
             const char *rawver;
             char *ver = NULL;
             if (virLogVersionString(&rawver, &ver) >= 0)
-                virLogOutputToFd(VIR_LOG_FROM_FILE, VIR_LOG_INFO,
+                virLogOutputToFd(&virLogSelf, VIR_LOG_INFO,
                                  __FILE__, __LINE__, __func__,
                                  timestamp, NULL, 0, rawver, ver,
                                  (void *) STDERR_FILENO);
@@ -929,7 +924,7 @@ virLogStackTraceToFd(int fd)
 }
 
 static void
-virLogOutputToFd(virLogSource source ATTRIBUTE_UNUSED,
+virLogOutputToFd(virLogSourcePtr source ATTRIBUTE_UNUSED,
                  virLogPriority priority ATTRIBUTE_UNUSED,
                  const char *filename ATTRIBUTE_UNUSED,
                  int linenr ATTRIBUTE_UNUSED,
@@ -1033,7 +1028,7 @@ virLogPrioritySyslog(virLogPriority priority)
 
 #if HAVE_SYSLOG_H
 static void
-virLogOutputToSyslog(virLogSource source ATTRIBUTE_UNUSED,
+virLogOutputToSyslog(virLogSourcePtr source ATTRIBUTE_UNUSED,
                      virLogPriority priority,
                      const char *filename ATTRIBUTE_UNUSED,
                      int linenr ATTRIBUTE_UNUSED,
@@ -1160,7 +1155,7 @@ journalAddInt(struct journalState *state, const char *field, int value)
 static int journalfd = -1;
 
 static void
-virLogOutputToJournald(virLogSource source,
+virLogOutputToJournald(virLogSourcePtr source,
                        virLogPriority priority,
                        const char *filename,
                        int linenr,
@@ -1202,8 +1197,7 @@ virLogOutputToJournald(virLogSource source,
     journalAddString(&state, "MESSAGE", rawstr);
     journalAddInt(&state, "PRIORITY",
                   virLogPrioritySyslog(priority));
-    journalAddString(&state, "LIBVIRT_SOURCE",
-                     virLogSourceTypeToString(source));
+    journalAddString(&state, "LIBVIRT_SOURCE", source->name);
     if (filename)
         journalAddString(&state, "CODE_FILE", filename);
     journalAddInt(&state, "CODE_LINE", linenr);

diff --git a/src/util/virlog.h b/src/util/virlog.h
index 6ba2daa4e731f597afad8ec325688c8ca22c5f83..4ac4c47f5e2796acba3e5d1c25870bf512195529 100644 (file)
--- a/src/util/virlog.h
+++ b/src/util/virlog.h
@@ -44,15 +44,14 @@ typedef enum {
     VIR_LOG_TO_JOURNALD,
 } virLogDestination;
 
-typedef enum {
-    VIR_LOG_FROM_FILE,    /* General debugging */
-    VIR_LOG_FROM_ERROR,   /* Errors reported */
-    VIR_LOG_FROM_AUDIT,   /* Audit operations */
-    VIR_LOG_FROM_TRACE,   /* DTrace probe pointers */
-    VIR_LOG_FROM_LIBRARY, /* 3rd party libraries */
+typedef struct _virLogSource virLogSource;
+typedef virLogSource *virLogSourcePtr;
+
+struct _virLogSource {
+    const char *name;
+};
 
-    VIR_LOG_FROM_LAST,
-} virLogSource;
+extern virLogSource virLogSelf;
 
 /*
  * If configured with --enable-debug=yes then library calls
@@ -68,7 +67,7 @@ typedef enum {
  *
  * Do nothing but eat parameters.
  */
-static inline void virLogEatParams(virLogSource unused, ...)
+static inline void virLogEatParams(virLogSourcePtr unused, ...)
 {
     /* Silence gcc */
     unused = unused;
@@ -85,13 +84,13 @@ static inline void virLogEatParams(virLogSource unused, ...)
     virLogMessage(src, VIR_LOG_ERROR, filename, linenr, funcname, NULL, __VA_ARGS__)
 
 # define VIR_DEBUG(...)                                                 \
-    VIR_DEBUG_INT(VIR_LOG_FROM_FILE, __FILE__, __LINE__, __func__, __VA_ARGS__)
+    VIR_DEBUG_INT(&virLogSelf, __FILE__, __LINE__, __func__, __VA_ARGS__)
 # define VIR_INFO(...)                                                  \
-    VIR_INFO_INT(VIR_LOG_FROM_FILE, __FILE__, __LINE__, __func__, __VA_ARGS__)
+    VIR_INFO_INT(&virLogSelf, __FILE__, __LINE__, __func__, __VA_ARGS__)
 # define VIR_WARN(...)                                                  \
-    VIR_WARN_INT(VIR_LOG_FROM_FILE, __FILE__, __LINE__, __func__, __VA_ARGS__)
+    VIR_WARN_INT(&virLogSelf, __FILE__, __LINE__, __func__, __VA_ARGS__)
 # define VIR_ERROR(...)                                                 \
-    VIR_ERROR_INT(VIR_LOG_FROM_FILE, __FILE__, __LINE__, __func__, __VA_ARGS__)
+    VIR_ERROR_INT(&virLogSelf, __FILE__, __LINE__, __func__, __VA_ARGS__)
 
 
 struct _virLogMetadata {
@@ -105,7 +104,7 @@ typedef struct _virLogMetadata *virLogMetadataPtr;
 
 /**
  * virLogOutputFunc:
- * @src: the src for the message
+ * @src: the source of the log message
  * @priority: the priority for the message
  * @filename: file where the message was emitted
  * @linenr: line where the message was emitted
@@ -119,7 +118,7 @@ typedef struct _virLogMetadata *virLogMetadataPtr;
  *
  * Callback function used to output messages
  */
-typedef void (*virLogOutputFunc) (virLogSource src,
+typedef void (*virLogOutputFunc) (virLogSourcePtr src,
                                   virLogPriority priority,
                                   const char *filename,
                                   int linenr,
@@ -172,14 +171,14 @@ extern int virLogParseDefaultPriority(const char *priority);
 extern int virLogParseFilters(const char *filters);
 extern int virLogParseOutputs(const char *output);
 extern int virLogPriorityFromSyslog(int priority);
-extern void virLogMessage(virLogSource src,
+extern void virLogMessage(virLogSourcePtr source,
                           virLogPriority priority,
                           const char *filename,
                           int linenr,
                           const char *funcname,
                           virLogMetadataPtr metadata,
                           const char *fmt, ...) ATTRIBUTE_FMT_PRINTF(7, 8);
-extern void virLogVMessage(virLogSource src,
+extern void virLogVMessage(virLogSourcePtr source,
                            virLogPriority priority,
                            const char *filename,
                            int linenr,

diff --git a/src/util/virprobe.h b/src/util/virprobe.h
index 3950e4980f4d38c3d683fa269dfb221dfb690060..fe3c4220b6c86edc3192abed2ecc05a817492b7f 100644 (file)
--- a/src/util/virprobe.h
+++ b/src/util/virprobe.h
@@ -83,7 +83,7 @@
 
 #  define PROBE_EXPAND(NAME, ARGS) NAME(ARGS)
 #  define PROBE(NAME, FMT, ...)                              \
-    VIR_DEBUG_INT(VIR_LOG_FROM_TRACE,                        \
+    VIR_DEBUG_INT(&virLogSelf,                               \
                   NULL, __LINE__, __func__,                  \
                   #NAME ": " FMT, __VA_ARGS__);              \
     if (LIBVIRT_ ## NAME ## _ENABLED()) {                    \
@@ -92,7 +92,7 @@
     }
 # else
 #  define PROBE(NAME, FMT, ...)                              \
-    VIR_DEBUG_INT(VIR_LOG_FROM_TRACE,                        \
+    VIR_DEBUG_INT(&virLogSelf,                               \
                   NULL, __LINE__, __func__,                  \
                   #NAME ": " FMT, __VA_ARGS__);
 # endif

diff --git a/tests/testutils.c b/tests/testutils.c
index ede623924e3ec670e1c322758258fc782a7d8ce1..f5c815fb3a69ddb275b52f730c908e09328d8668 100644 (file)
--- a/tests/testutils.c
+++ b/tests/testutils.c
@@ -584,7 +584,7 @@ struct virtTestLogData {
 static struct virtTestLogData testLog = { VIR_BUFFER_INITIALIZER };
 
 static void
-virtTestLogOutput(virLogSource source ATTRIBUTE_UNUSED,
+virtTestLogOutput(virLogSourcePtr source ATTRIBUTE_UNUSED,
                   virLogPriority priority ATTRIBUTE_UNUSED,
                   const char *filename ATTRIBUTE_UNUSED,
                   int lineno ATTRIBUTE_UNUSED,