Enable event logging for cloud hypervisor

Signed-off-by: Muminul Islam <[email protected]>

Author: russell-islam

src/ch/ch_conf.c

@@ -146,7 +146,8 @@ virCHDriverConfigNew(void)
     cfg->logDir = g_strdup(CH_LOG_DIR);
     cfg->configDir = g_strdup(CH_CONF_BASE_DIR);
     cfg->autostartDir = g_strdup_printf("%s/autostart", cfg->configDir);
-
+    cfg->logTimestamp = true;
+    cfg->stdioLogD = false;
     cfg->cgroupControllers = -1; /* Auto detect */
 
     return cfg;

src/ch/ch_conf.h

@@ -46,7 +46,8 @@ struct _virCHDriverConfig {
     char *configDir;
     char *autostartDir;
     int cgroupControllers;
-
+    bool logTimestamp;
+    bool stdioLogD;
     bool macFilter;
 };
 

src/ch/ch_domain.c

@@ -23,10 +23,14 @@
 #include "ch_domain.h"
 #include "datatypes.h"
 #include "domain_driver.h"
+#include "virfile.h"
 #include "viralloc.h"
 #include "virlog.h"
 #include "virtime.h"
 #include "virsystemd.h"
+#include "virutil.h"
+
+#include <fcntl.h>
 
 #define VIR_FROM_THIS VIR_FROM_CH
 
@@ -40,6 +44,41 @@ VIR_ENUM_IMPL(virCHDomainJob,
 
 VIR_LOG_INIT("ch.ch_domain");
 
+struct _chDomainLogContext {
+    GObject parent;
+
+    int writefd;
+    int readfd; /* Only used if manager == NULL */
+    off_t pos;
+    ino_t inode; /* Only used if manager != NULL */
+    char *path;
+    virLogManagerPtr manager;
+};
+static void chDomainLogContextFinalize(GObject *obj);
+static void ch_domain_log_context_init(chDomainLogContext *logctxt G_GNUC_UNUSED)
+{
+}
+static void ch_domain_log_context_class_init(chDomainLogContextClass *klass)
+{
+    GObjectClass *obj = G_OBJECT_CLASS(klass);
+
+    obj->finalize = chDomainLogContextFinalize;
+}
+
+G_DEFINE_TYPE(chDomainLogContext, ch_domain_log_context, G_TYPE_OBJECT);
+
+static void
+chDomainLogContextFinalize(GObject *object)
+{
+    chDomainLogContextPtr ctxt = CH_DOMAIN_LOG_CONTEXT(object);
+    VIR_DEBUG("ctxt=%p", ctxt);
+
+    virLogManagerFree(ctxt->manager);
+    g_free(ctxt->path);
+    VIR_FORCE_CLOSE(ctxt->writefd);
+    VIR_FORCE_CLOSE(ctxt->readfd);
+    G_OBJECT_CLASS(ch_domain_log_context_parent_class)->finalize(object);
+}
 static int
 virCHDomainObjInitJob(virCHDomainObjPrivatePtr priv)
 {
@@ -485,3 +524,146 @@ virCHDomainObjFromDomain(virDomainPtr domain)
 
     return vm;
 }
+
+
+chDomainLogContextPtr chDomainLogContextNew(virCHDriverPtr driver,
+                                                virDomainObjPtr vm,
+                                                chDomainLogContextMode mode)
+{
+    g_autoptr(virCHDriverConfig) cfg = virCHDriverGetConfig(driver);
+    chDomainLogContextPtr ctxt = CH_DOMAIN_LOG_CONTEXT(g_object_new(CH_TYPE_DOMAIN_LOG_CONTEXT, NULL));
+
+    VIR_DEBUG("Context new %p stdioLogD=%d", ctxt, cfg->stdioLogD);
+    ctxt->writefd = -1;
+    ctxt->readfd = -1;
+
+    ctxt->path = g_strdup_printf("%s/%s.log", cfg->logDir, vm->def->name);
+
+    if (cfg->stdioLogD) {
+        ctxt->manager = virLogManagerNew(driver->privileged);
+        if (!ctxt->manager)
+            goto error;
+
+        ctxt->writefd = virLogManagerDomainOpenLogFile(ctxt->manager,
+                                                       "ch",
+                                                       vm->def->uuid,
+                                                       vm->def->name,
+                                                       ctxt->path,
+                                                       0,
+                                                       &ctxt->inode,
+                                                       &ctxt->pos);
+        if (ctxt->writefd < 0)
+            goto error;
+    } else {
+        if ((ctxt->writefd = open(ctxt->path, O_WRONLY | O_CREAT | O_APPEND, S_IRUSR | S_IWUSR)) < 0) {
+            virReportSystemError(errno, _("failed to create logfile %s"),
+                                 ctxt->path);
+            goto error;
+        }
+        if (virSetCloseExec(ctxt->writefd) < 0) {
+            virReportSystemError(errno, _("failed to set close-on-exec flag on %s"),
+                                 ctxt->path);
+            goto error;
+        }
+
+        /* For unprivileged startup we must truncate the file since
+         * we can't rely on logrotate. We don't use O_TRUNC since
+         * it is better for SELinux policy if we truncate afterwards */
+        if (mode == CH_DOMAIN_LOG_CONTEXT_MODE_START &&
+            !driver->privileged &&
+            ftruncate(ctxt->writefd, 0) < 0) {
+            virReportSystemError(errno, _("failed to truncate %s"),
+                                 ctxt->path);
+            goto error;
+        }
+
+        if (mode == CH_DOMAIN_LOG_CONTEXT_MODE_START) {
+            if ((ctxt->readfd = open(ctxt->path, O_RDONLY, S_IRUSR | S_IWUSR)) < 0) {
+                virReportSystemError(errno, _("failed to open logfile %s"),
+                                     ctxt->path);
+                goto error;
+            }
+            if (virSetCloseExec(ctxt->readfd) < 0) {
+                virReportSystemError(errno, _("failed to set close-on-exec flag on %s"),
+                                     ctxt->path);
+                goto error;
+            }
+        }
+
+        if ((ctxt->pos = lseek(ctxt->writefd, 0, SEEK_END)) < 0) {
+            virReportSystemError(errno, _("failed to seek in log file %s"),
+                                 ctxt->path);
+            goto error;
+        }
+    }
+
+    return ctxt;
+
+ error:
+    g_clear_object(&ctxt);
+    return NULL;
+}
+
+/**
+ * chDomainLogAppendMessage:
+ *
+ * This is a best-effort attempt to add a log message to the ch log file
+ * either by using virtlogd or the legacy approach */
+int
+chDomainLogAppendMessage(virCHDriverPtr driver,
+                           virDomainObjPtr vm,
+                           const char *fmt,
+                           ...)
+{
+    g_autoptr(virCHDriverConfig) cfg = virCHDriverGetConfig(driver);
+    virLogManagerPtr manager = NULL;
+    va_list ap;
+    g_autofree char *path = NULL;
+    int writefd = -1;
+    g_autofree char *message = NULL;
+    int ret = -1;
+
+    va_start(ap, fmt);
+
+    message = g_strdup_vprintf(fmt, ap);
+
+    VIR_DEBUG("Append log message (vm='%s' message='%s) stdioLogD=%d",
+              vm->def->name, message, cfg->stdioLogD);
+
+    path = g_strdup_printf("%s/%s.log", cfg->logDir, vm->def->name);
+
+    if (cfg->stdioLogD) {
+        if (!(manager = virLogManagerNew(driver->privileged)))
+            goto cleanup;
+
+        if (virLogManagerDomainAppendMessage(manager, "ch", vm->def->uuid,
+                                             vm->def->name, path, message, 0) < 0)
+            goto cleanup;
+    } else {
+        if ((writefd = open(path, O_WRONLY | O_CREAT | O_APPEND, S_IRUSR | S_IWUSR)) < 0) {
+            virReportSystemError(errno, _("failed to create logfile %s"),
+                                 path);
+            goto cleanup;
+        }
+
+        if (safewrite(writefd, message, strlen(message)) < 0)
+            goto cleanup;
+    }
+
+    ret = 0;
+
+ cleanup:
+    va_end(ap);
+    VIR_FORCE_CLOSE(writefd);
+    virLogManagerFree(manager);
+
+    return ret;
+}
+
+
+int chDomainLogContextGetWriteFD(chDomainLogContextPtr ctxt)
+{
+    return ctxt->writefd;
+}
+
+

src/ch/ch_domain.h

@@ -20,10 +20,12 @@
 
 #pragma once
 
+#include <glib-object.h>
 #include "ch_conf.h"
 #include "ch_monitor.h"
 #include "virchrdev.h"
 #include "vircgroup.h"
+#include "logging/log_manager.h"
 
 #define CH_DEV_VFIO "/dev/vfio/vfio"
 
@@ -43,7 +45,16 @@ enum virCHDomainJob {
 };
 VIR_ENUM_DECL(virCHDomainJob);
 
+typedef enum {
+    CH_DOMAIN_LOG_CONTEXT_MODE_START,
+    CH_DOMAIN_LOG_CONTEXT_MODE_ATTACH,
+    CH_DOMAIN_LOG_CONTEXT_MODE_STOP,
+} chDomainLogContextMode;
 
+
+#define CH_TYPE_DOMAIN_LOG_CONTEXT ch_domain_log_context_get_type()
+G_DECLARE_FINAL_TYPE(chDomainLogContext, ch_domain_log_context, CH, DOMAIN_LOG_CONTEXT, GObject);
+typedef chDomainLogContext *chDomainLogContextPtr;
 struct _virCHDomainJobObj {
     virCond cond;                       /* Use to coordinate jobs */
     enum virCHDomainJob active;        /* Currently running job */
@@ -103,6 +114,17 @@ struct _virCHDomainVcpuPrivate {
 extern virDomainXMLPrivateDataCallbacks virCHDriverPrivateDataCallbacks;
 extern virDomainDefParserConfig virCHDriverDomainDefParserConfig;
 
+
+chDomainLogContextPtr chDomainLogContextNew(virCHDriverPtr driver,
+                                                virDomainObjPtr vm,
+                                                chDomainLogContextMode mode);
+int chDomainLogContextGetWriteFD(chDomainLogContextPtr ctxt);
+
+
+int chDomainLogAppendMessage(virCHDriverPtr driver,
+                               virDomainObjPtr vm,
+                               const char *fmt,
+                               ...) G_GNUC_PRINTF(3, 4);
 int
 virCHDomainObjBeginJob(virDomainObjPtr obj, enum virCHDomainJob job)
     G_GNUC_WARN_UNUSED_RESULT;

src/ch/ch_monitor.c

@@ -721,6 +721,7 @@ static int virCHMonitorProcessEvent(virCHMonitorPtr mon,
     const char *source;
     virDomainObjPtr vm = mon->vm;
     virCHMonitorEvent ev;
+    g_autofree char *timestamp = NULL;
 
     if (virJSONValueObjectHasKey(eventJSON, "source") == 0) {
         VIR_WARN("Invalid JSON from monitor, no source key");
@@ -735,6 +736,10 @@ static int virCHMonitorProcessEvent(virCHMonitorPtr mon,
 
     ev = virCHMonitorEventFromString(source, event);
     VIR_DEBUG("Source: %s Event: %s, ev: %d", source, event, ev);
+    virCHDriverPtr driver = CH_DOMAIN_PRIVATE(vm)->driver;
+
+    if ((timestamp = virTimeStringNow()) != NULL)
+        chDomainLogAppendMessage(driver, vm, "%s: Source: %s Event: %s, ev: %d\n", timestamp,source, event, ev);
     switch (ev) {
         case virCHMonitorVmEventBooted:
         case virCHMonitorVmEventResumed:
@@ -752,7 +757,6 @@ static int virCHMonitorProcessEvent(virCHMonitorPtr mon,
         case virCHMonitorVmmEventShutdown: // shutdown inside vmm
         case virCHMonitorVmEventShutdown:
             {
-                virCHDriverPtr driver = CH_DOMAIN_PRIVATE(vm)->driver;
                 g_autoptr(virCHDriverConfig) cfg = virCHDriverGetConfig(driver);
                 virDomainState state;
 
@@ -1163,6 +1167,8 @@ virCHMonitorNew(virDomainObjPtr vm, virCHDriverPtr driver)
     virCHMonitorPtr mon = NULL;
     virCommandPtr cmd = NULL;
     int i;
+    int logfile = -1;
+    g_autoptr(chDomainLogContext) logCtxt = NULL;
 
     if (virCHMonitorInitialize() < 0)
         goto cleanup;
@@ -1211,8 +1217,23 @@ virCHMonitorNew(virDomainObjPtr vm, virCHDriverPtr driver)
 
     virCommandAddArg(cmd, "--event-monitor");
     virCommandAddArgFormat(cmd, "path=%s", mon->monitorpath);
+    if (virFileMakePath(cfg->logDir) < 0) {
+        virReportSystemError(errno,
+                             _("cannot create log directory %s"),
+                             cfg->logDir);
+        goto cleanup;
+    }
 
+    VIR_DEBUG("Creating domain log file");
+    if (!(logCtxt = chDomainLogContextNew(driver, vm,
+                                            CH_DOMAIN_LOG_CONTEXT_MODE_START))) {
+        virLastErrorPrefixMessage("%s", _("can't connect to virtlogd"));
+        goto cleanup;
+    }
+    logfile = chDomainLogContextGetWriteFD(logCtxt);
     /* TODO enable */
+    virCommandSetOutputFD(cmd, &logfile);
+    virCommandSetErrorFD(cmd, &logfile);
     virCommandSetPidFile(cmd, priv->pidfile);
     virCommandDaemonize(cmd);
     virCommandRequireHandshake(cmd);