[gnome-builder/wip/chergert/pipeline: 23/48] log: add IdeBuildLog
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-builder/wip/chergert/pipeline: 23/48] log: add IdeBuildLog
- Date: Sat, 4 Feb 2017 00:10:45 +0000 (UTC)
commit eca82bfa71874f976c3b500dd8b878eb281bb16b
Author: Christian Hergert <chergert redhat com>
Date: Fri Feb 3 12:26:13 2017 -0800
log: add IdeBuildLog
This is a simplified logging infrastructure for use by the upcoming build
pipeline. It extracts some of the techniques we were doing in
IdeBuildResult into a more specific logging helper so that we don't
overload too much complexity into one object.
libide/Makefile.am | 3 +
libide/buildsystem/ide-build-log-private.h | 47 ++++++
libide/buildsystem/ide-build-log.c | 242 ++++++++++++++++++++++++++++
libide/buildsystem/ide-build-log.h | 39 +++++
4 files changed, 331 insertions(+), 0 deletions(-)
---
diff --git a/libide/Makefile.am b/libide/Makefile.am
index 1839c33..bd5c12f 100644
--- a/libide/Makefile.am
+++ b/libide/Makefile.am
@@ -30,6 +30,7 @@ libide_1_0_la_public_headers = \
buffers/ide-buffer.h \
buffers/ide-unsaved-file.h \
buffers/ide-unsaved-files.h \
+ buildsystem/ide-build-log.h \
buildsystem/ide-build-command.h \
buildsystem/ide-build-command-queue.h \
buildsystem/ide-build-manager.h \
@@ -370,6 +371,8 @@ libide_1_0_la_SOURCES = \
application/ide-application-private.h \
application/ide-application-tests.c \
application/ide-application-tests.h \
+ buildsystem/ide-build-log.c \
+ buildsystem/ide-build-log-private.h \
editor/ide-editor-frame-actions.c \
editor/ide-editor-frame-actions.h \
editor/ide-editor-frame-private.h \
diff --git a/libide/buildsystem/ide-build-log-private.h b/libide/buildsystem/ide-build-log-private.h
new file mode 100644
index 0000000..83e9866
--- /dev/null
+++ b/libide/buildsystem/ide-build-log-private.h
@@ -0,0 +1,47 @@
+/* ide-build-log-private.h
+ *
+ * Copyright (C) 2016 Christian Hergert <chergert redhat com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef IDE_BUILD_LOG_PRIVATE_H
+#define IDE_BUILD_LOG_PRIVATE_H
+
+#include <gio/gio.h>
+
+#include "ide-build-log.h"
+
+G_BEGIN_DECLS
+
+#define IDE_TYPE_BUILD_LOG (ide_build_log_get_type())
+
+G_DECLARE_FINAL_TYPE (IdeBuildLog, ide_build_log, IDE, BUILD_LOG, GObject)
+
+IdeBuildLog *ide_build_log_new (void);
+void ide_build_log_observer (IdeBuildLogStream stream,
+ const gchar *message,
+ gssize message_len,
+ gpointer user_data);
+guint ide_build_log_add_observer (IdeBuildLog *self,
+ IdeBuildLogObserver observer,
+ gpointer observer_data,
+ GDestroyNotify observer_data_destroy);
+gboolean ide_build_log_remove_observer (IdeBuildLog *self,
+ guint observer_id);
+
+
+G_END_DECLS
+
+#endif /* IDE_BUILD_LOG_PRIVATE_H */
diff --git a/libide/buildsystem/ide-build-log.c b/libide/buildsystem/ide-build-log.c
new file mode 100644
index 0000000..eccceae
--- /dev/null
+++ b/libide/buildsystem/ide-build-log.c
@@ -0,0 +1,242 @@
+/* ide-build-log.c
+ *
+ * Copyright (C) 2016 Christian Hergert <chergert redhat com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#define G_LOG_DOMAIN "ide-build-log"
+
+#include <string.h>
+
+#include "application/ide-application.h"
+#include "buildsystem/ide-build-log.h"
+#include "buildsystem/ide-build-log-private.h"
+
+#define POINTER_MARK(p) GSIZE_TO_POINTER(GPOINTER_TO_SIZE(p)|1)
+#define POINTER_UNMARK(p) GSIZE_TO_POINTER(GPOINTER_TO_SIZE(p)&~(gsize)1)
+#define POINTER_MARKED(p) (GPOINTER_TO_SIZE(p)&1)
+#define DISPATCH_MAX 20
+
+struct _IdeBuildLog
+{
+ GObject parent_instance;
+
+ GArray *observers;
+ GAsyncQueue *log_queue;
+ GSource *log_source;
+
+ guint sequence;
+};
+
+typedef struct
+{
+ IdeBuildLogObserver callback;
+ gpointer data;
+ GDestroyNotify destroy;
+ guint id;
+} Observer;
+
+G_DEFINE_TYPE (IdeBuildLog, ide_build_log, G_TYPE_OBJECT)
+
+static gboolean
+emit_log_from_main (gpointer user_data)
+{
+ IdeBuildLog *self = user_data;
+ g_autoptr(GPtrArray) ar = g_ptr_array_new ();
+ gpointer item;
+
+ g_assert (IDE_IS_BUILD_LOG (self));
+
+ /*
+ * Pull up to DISPATCH_MAX items from the log queue. We have an upper
+ * bound here so that we don't stall the main loop. Additionally, we
+ * update the ready-time when we run out of items while holding the
+ * async queue lock to synchronize with the caller for further wakeups.
+ */
+ g_async_queue_lock (self->log_queue);
+ for (guint i = 0; i < DISPATCH_MAX; i++)
+ {
+ if (NULL == (item = g_async_queue_try_pop_unlocked (self->log_queue)))
+ {
+ g_source_set_ready_time (self->log_source, -1);
+ break;
+ }
+ g_ptr_array_add (ar, item);
+ }
+ g_async_queue_unlock (self->log_queue);
+
+ for (guint i = 0; i < ar->len; i++)
+ {
+ IdeBuildLogStream stream = IDE_BUILD_LOG_STDOUT;
+ gchar *message;
+ gsize message_len;
+
+ item = g_ptr_array_index (ar, i);
+ message = POINTER_UNMARK (item);
+ message_len = strlen (message);
+
+ if (POINTER_MARKED (item))
+ stream = IDE_BUILD_LOG_STDERR;
+
+ for (guint j = 0; j < self->observers->len; j++)
+ {
+ const Observer *observer = &g_array_index (self->observers, Observer, j);
+
+ observer->callback (stream, message, message_len, observer->data);
+ }
+
+ g_free (message);
+ }
+
+ return G_SOURCE_CONTINUE;
+}
+
+static void
+ide_build_log_finalize (GObject *object)
+{
+ IdeBuildLog *self = (IdeBuildLog *)object;
+
+ g_clear_pointer (&self->log_queue, g_async_queue_unref);
+ g_clear_pointer (&self->log_source, g_source_destroy);
+ g_clear_pointer (&self->observers, g_array_unref);
+
+ G_OBJECT_CLASS (ide_build_log_parent_class)->finalize (object);
+}
+
+static void
+ide_build_log_class_init (IdeBuildLogClass *klass)
+{
+ GObjectClass *object_class = G_OBJECT_CLASS (klass);
+
+ object_class->finalize = ide_build_log_finalize;
+}
+
+static void
+ide_build_log_init (IdeBuildLog *self)
+{
+ self->observers = g_array_new (FALSE, FALSE, sizeof (Observer));
+
+ self->log_queue = g_async_queue_new ();
+
+ self->log_source = g_timeout_source_new (G_MAXINT);
+ g_source_set_ready_time (self->log_source, -1);
+ g_source_set_name (self->log_source, "[ide] IdeBuildLog");
+ g_source_set_callback (self->log_source, emit_log_from_main, self, NULL);
+ g_source_attach (self->log_source, g_main_context_default ());
+}
+
+static void
+ide_build_log_via_main (IdeBuildLog *self,
+ IdeBuildLogStream stream,
+ const gchar *message,
+ gsize message_len)
+{
+ gchar *copied = g_strndup (message, message_len);
+
+ if G_UNLIKELY (stream == IDE_BUILD_LOG_STDERR)
+ copied = POINTER_MARK (copied);
+
+ /*
+ * Add the log entry to our queue to be dispatched in the main thread.
+ * However, we hold the async queue lock while updating the source ready
+ * time so we are synchronized with the main thread for setting the
+ * ready time. This is needed because the main thread may not dispatch
+ * all available items in a single dispatch (to avoid stalling the
+ * main loop).
+ */
+
+ g_async_queue_lock (self->log_queue);
+ g_async_queue_push_unlocked (self->log_queue, copied);
+ g_source_set_ready_time (self->log_source, 0);
+ g_async_queue_unlock (self->log_queue);
+}
+
+void
+ide_build_log_observer (IdeBuildLogStream stream,
+ const gchar *message,
+ gssize message_len,
+ gpointer user_data)
+{
+ IdeBuildLog *self = user_data;
+
+ g_assert (message != NULL);
+
+ if (message_len < 0)
+ message_len = strlen (message);
+
+ g_assert (message[message_len] == '\0');
+
+ if G_LIKELY (IDE_IS_MAIN_THREAD ())
+ {
+ for (guint i = 0; i < self->observers->len; i++)
+ {
+ const Observer *observer = &g_array_index (self->observers, Observer, i);
+
+ observer->callback (stream, message, message_len, observer->data);
+ }
+ }
+ else
+ {
+ ide_build_log_via_main (self, stream, message, message_len);
+ }
+}
+
+guint
+ide_build_log_add_observer (IdeBuildLog *self,
+ IdeBuildLogObserver observer,
+ gpointer observer_data,
+ GDestroyNotify observer_data_destroy)
+{
+ Observer ele;
+
+ g_return_val_if_fail (IDE_IS_BUILD_LOG (self), 0);
+ g_return_val_if_fail (observer != NULL, 0);
+
+ ele.id = ++self->sequence;
+ ele.callback = observer;
+ ele.data = observer_data;
+ ele.destroy = observer_data_destroy;
+
+ g_array_append_val (self->observers, ele);
+
+ return ele.id;
+}
+
+gboolean
+ide_build_log_remove_observer (IdeBuildLog *self,
+ guint observer_id)
+{
+ g_return_val_if_fail (IDE_IS_BUILD_LOG (self), FALSE);
+ g_return_val_if_fail (observer_id > 0, FALSE);
+
+ for (guint i = 0; i < self->observers->len; i++)
+ {
+ const Observer *observer = &g_array_index (self->observers, Observer, i);
+
+ if (observer->id == observer_id)
+ {
+ g_array_remove_index (self->observers, i);
+ return TRUE;
+ }
+ }
+
+ return FALSE;
+}
+
+IdeBuildLog *
+ide_build_log_new (void)
+{
+ return g_object_new (IDE_TYPE_BUILD_LOG, NULL);
+}
diff --git a/libide/buildsystem/ide-build-log.h b/libide/buildsystem/ide-build-log.h
new file mode 100644
index 0000000..a6c807d
--- /dev/null
+++ b/libide/buildsystem/ide-build-log.h
@@ -0,0 +1,39 @@
+/* ide-build-log.h
+ *
+ * Copyright (C) 2016 Christian Hergert <chergert redhat com>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef IDE_BUILD_LOG_H
+#define IDE_BUILD_LOG_H
+
+#include <glib.h>
+
+G_BEGIN_DECLS
+
+typedef enum
+{
+ IDE_BUILD_LOG_STDOUT,
+ IDE_BUILD_LOG_STDERR,
+} IdeBuildLogStream;
+
+typedef void (*IdeBuildLogObserver) (IdeBuildLogStream log_stream,
+ const gchar *message,
+ gssize message_len,
+ gpointer user_data);
+
+G_END_DECLS
+
+#endif /* IDE_BUILD_LOG_H */
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
