[sysprof] libsysprof-capture: add simplified collector API
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [sysprof] libsysprof-capture: add simplified collector API
- Date: Fri, 14 Feb 2020 02:59:33 +0000 (UTC)
commit c546d31ad973c386c968c82ae0a04e378e84783b
Author: Christian Hergert <chergert redhat com>
Date: Thu Feb 13 18:56:31 2020 -0800
libsysprof-capture: add simplified collector API
This is a simplified API for the inferior to use (such as from a
LD_PRELOAD) that will use mmap()'d ring buffer created by Sysprof. Doing
so can reduce the amount of overhead in the inferior enough to make some
workloads useful. For example, collecting memory statistics and backtraces
is now fast enough to be useful.
src/libsysprof-capture/meson.build | 4 +
src/libsysprof-capture/sysprof-capture.h | 1 +
src/libsysprof-capture/sysprof-collector.c | 404 +++++++++++++++++++++++++++++
src/libsysprof-capture/sysprof-collector.h | 108 ++++++++
4 files changed, 517 insertions(+)
---
diff --git a/src/libsysprof-capture/meson.build b/src/libsysprof-capture/meson.build
index 22b00bd..8ed7934 100644
--- a/src/libsysprof-capture/meson.build
+++ b/src/libsysprof-capture/meson.build
@@ -6,6 +6,7 @@ libsysprof_capture_headers = files([
'sysprof-capture-reader.h',
'sysprof-capture-types.h',
'sysprof-capture-writer.h',
+ 'sysprof-collector.h',
'sysprof-platform.h',
'sysprof-capture.h',
'sysprof-version-macros.h',
@@ -22,6 +23,7 @@ libsysprof_capture_sources = files([
'sysprof-capture-util.c',
'sysprof-capture-writer.c',
'sysprof-capture-writer-cat.c',
+ 'sysprof-collector.c',
'sysprof-clock.c',
'sysprof-platform.c',
])
@@ -35,6 +37,8 @@ configure_file(
libsysprof_capture_deps = [
glib_dep,
+ gio_dep,
+ gio_unix_dep,
]
libsysprof_capture = static_library(
diff --git a/src/libsysprof-capture/sysprof-capture.h b/src/libsysprof-capture/sysprof-capture.h
index fc14950..59b68b9 100644
--- a/src/libsysprof-capture/sysprof-capture.h
+++ b/src/libsysprof-capture/sysprof-capture.h
@@ -67,6 +67,7 @@ G_BEGIN_DECLS
# include "sysprof-capture-cursor.h"
# include "sysprof-capture-reader.h"
# include "sysprof-capture-writer.h"
+# include "sysprof-collector.h"
# include "sysprof-clock.h"
# include "sysprof-platform.h"
# include "sysprof-version.h"
diff --git a/src/libsysprof-capture/sysprof-collector.c b/src/libsysprof-capture/sysprof-collector.c
new file mode 100644
index 0000000..5694cc9
--- /dev/null
+++ b/src/libsysprof-capture/sysprof-collector.c
@@ -0,0 +1,404 @@
+/* sysprof-collector.c
+ *
+ * Copyright 2020 Christian Hergert <chergert redhat com>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * Subject to the terms and conditions of this license, each copyright holder
+ * and contributor hereby grants to those receiving rights under this license
+ * a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+ * irrevocable (except for failure to satisfy the conditions of this license)
+ * patent license to make, have made, use, offer to sell, sell, import, and
+ * otherwise transfer this software, where such license applies only to those
+ * patent claims, already acquired or hereafter acquired, licensable by such
+ * copyright holder or contributor that are necessarily infringed by:
+ *
+ * (a) their Contribution(s) (the licensed copyrights of copyright holders
+ * and non-copyrightable additions of contributors, in source or binary
+ * form) alone; or
+ *
+ * (b) combination of their Contribution(s) with the work of authorship to
+ * which such Contribution(s) was added by such copyright holder or
+ * contributor, if, at the time the Contribution is added, such addition
+ * causes such combination to be necessarily infringed. The patent license
+ * shall not apply to any other combinations which include the
+ * Contribution.
+ *
+ * Except as expressly stated above, no rights or licenses from any copyright
+ * holder or contributor is granted under this license, whether expressly, by
+ * implication, estoppel or otherwise.
+ *
+ * DISCLAIMER
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * SPDX-License-Identifier: BSD-2-Clause-Patent
+ */
+
+#define G_LOG_DOMAIN "sysprof-collector"
+
+#ifndef _GNU_SOURCE
+# define _GNU_SOURCE
+#endif
+
+#include <glib-unix.h>
+#include <gio/gio.h>
+#include <gio/gunixconnection.h>
+#ifdef __linux__
+# include <sched.h>
+#endif
+#include <stdlib.h>
+#include <string.h>
+#include <sys/syscall.h>
+#include <unistd.h>
+
+#include "mapped-ring-buffer.h"
+
+#include "sysprof-capture-writer.h"
+#include "sysprof-collector.h"
+
+#define MAX_UNWIND_DEPTH 128
+#define CREATRING "CreatRing\0"
+#define CREATRING_LEN 10
+
+typedef struct
+{
+ MappedRingBuffer *buffer;
+ gboolean is_shared;
+ int tid;
+ int pid;
+} SysprofCollector;
+
+#ifdef __linux__
+# define sysprof_current_cpu (sched_getcpu())
+#else
+# define sysprof_current_cpu (-1)
+#endif
+
+#define COLLECTOR_MAGIC_CREATING ((gpointer)&creating)
+
+static MappedRingBuffer *request_writer (void);
+static void sysprof_collector_free (gpointer data);
+static const SysprofCollector *sysprof_collector_get (void);
+
+static G_LOCK_DEFINE (control_fd);
+static GPrivate collector_key = G_PRIVATE_INIT (sysprof_collector_free);
+static GPrivate single_trace_key = G_PRIVATE_INIT (NULL);
+static SysprofCollector *shared_collector;
+static SysprofCollector creating;
+
+static inline gboolean
+use_single_trace (void)
+{
+ return GPOINTER_TO_INT (g_private_get (&single_trace_key));
+}
+
+static inline int
+_do_getcpu (void)
+{
+#ifdef __linux__
+ return sched_getcpu ();
+#else
+ return -1;
+#endif
+}
+
+static void
+_realign (gsize *pos)
+{
+ *pos = (*pos + SYSPROF_CAPTURE_ALIGN - 1) & ~(SYSPROF_CAPTURE_ALIGN - 1);
+}
+
+static MappedRingBuffer *
+request_writer (void)
+{
+ static GUnixConnection *conn;
+ MappedRingBuffer *buffer = NULL;
+
+ if (conn == NULL)
+ {
+ const gchar *fdstr = g_getenv ("SYSPROF_CONTROL_FD");
+ int peer_fd = -1;
+
+ if (fdstr != NULL)
+ peer_fd = atoi (fdstr);
+
+ if (peer_fd > 0)
+ {
+ g_autoptr(GSocket) sock = NULL;
+
+ g_unix_set_fd_nonblocking (peer_fd, FALSE, NULL);
+
+ if ((sock = g_socket_new_from_fd (peer_fd, NULL)))
+ {
+ g_autoptr(GSocketConnection) scon = NULL;
+
+ g_socket_set_blocking (sock, TRUE);
+
+ if ((scon = g_socket_connection_factory_create_connection (sock)) &&
+ G_IS_UNIX_CONNECTION (scon))
+ conn = g_object_ref (G_UNIX_CONNECTION (scon));
+ }
+ }
+ }
+
+ if (conn != NULL)
+ {
+ GOutputStream *out_stream;
+ gsize len;
+
+ out_stream = g_io_stream_get_output_stream (G_IO_STREAM (conn));
+
+ if (g_output_stream_write_all (G_OUTPUT_STREAM (out_stream), CREATRING, CREATRING_LEN, &len, NULL,
NULL) &&
+ len == CREATRING_LEN)
+ {
+ gint ring_fd = g_unix_connection_receive_fd (conn, NULL, NULL);
+
+ if (ring_fd > -1)
+ {
+ buffer = mapped_ring_buffer_new_writer (ring_fd);
+ close (ring_fd);
+ }
+ }
+ }
+
+ return g_steal_pointer (&buffer);
+}
+
+static void
+sysprof_collector_free (gpointer data)
+{
+ SysprofCollector *collector = data;
+
+ if (collector != NULL && collector != COLLECTOR_MAGIC_CREATING)
+ {
+ g_clear_pointer (&collector->buffer, mapped_ring_buffer_unref);
+ g_free (collector);
+ }
+}
+
+static const SysprofCollector *
+sysprof_collector_get (void)
+{
+ const SysprofCollector *collector = g_private_get (&collector_key);
+
+ /* We might have gotten here recursively */
+ if G_UNLIKELY (collector == COLLECTOR_MAGIC_CREATING)
+ return COLLECTOR_MAGIC_CREATING;
+
+ if G_LIKELY (collector != NULL)
+ return collector;
+
+ if (use_single_trace () && shared_collector != COLLECTOR_MAGIC_CREATING)
+ return shared_collector;
+
+ {
+ SysprofCollector *self;
+
+ g_private_replace (&collector_key, COLLECTOR_MAGIC_CREATING);
+
+ G_LOCK (control_fd);
+
+ self = g_new0 (SysprofCollector, 1);
+ self->pid = getpid ();
+#ifdef __linux__
+ self->tid = syscall (__NR_gettid, 0);
+#endif
+
+ if (g_getenv ("SYSPROF_CONTROL_FD") != NULL)
+ {
+ self->buffer = request_writer ();
+ }
+#if 0
+ else
+ {
+ /* TODO: Fix envvar name */
+ const gchar *trace_fd = g_getenv ("SYSPROF_TRACE_FD");
+
+ if (trace_fd != NULL)
+ {
+ int fd = atoi (trace_fd);
+
+ if (fd > 0)
+ {
+ self->writer = sysprof_capture_writer_new_from_fd (fd, 0);
+ self->is_shared = TRUE;
+ }
+ }
+
+ if (self->writer == NULL && g_getenv ("SYSPROF_TRACE") != NULL)
+ {
+ g_autofree gchar *filename = g_strdup_printf ("capture.%d.syscap", (int)getpid ());
+
+ self->writer = sysprof_capture_writer_new (filename, 0);
+ self->is_shared = TRUE;
+ }
+ }
+#endif
+
+ if (self->is_shared)
+ shared_collector = self;
+ else
+ g_private_replace (&collector_key, self);
+
+ G_UNLOCK (control_fd);
+
+ return self;
+ }
+}
+
+void
+sysprof_collector_init (void)
+{
+ static gsize once_init;
+
+ if (g_once_init_enter (&once_init))
+ {
+ sysprof_clock_init ();
+ (void)sysprof_collector_get ();
+ g_once_init_leave (&once_init, TRUE);
+ }
+}
+
+#define COLLECTOR_BEGIN \
+ G_STMT_START { \
+ const SysprofCollector *collector = sysprof_collector_get (); \
+ if G_LIKELY (collector->buffer) \
+ { \
+ if G_UNLIKELY (collector->is_shared) \
+ G_LOCK (control_fd); \
+ \
+ {
+
+#define COLLECTOR_END \
+ } \
+ \
+ if G_UNLIKELY (collector->is_shared) \
+ G_UNLOCK (control_fd); \
+ } \
+ } G_STMT_END
+
+void
+sysprof_collector_embed_file (const gchar *path,
+ const guint8 *data,
+ gsize data_len)
+{
+}
+
+void
+sysprof_collector_embed_file_fd (const gchar *path,
+ int fd)
+{
+}
+
+void
+sysprof_collector_mark (gint64 time,
+ guint64 duration,
+ const gchar *group,
+ const gchar *name,
+ const gchar *message)
+{
+}
+
+void
+sysprof_collector_set_metadata (const gchar *id,
+ const gchar *value,
+ gssize value_len)
+{
+}
+
+void
+sysprof_collector_sample (gint64 time,
+ const SysprofCaptureAddress *addrs,
+ guint n_addrs)
+{
+}
+
+void
+sysprof_collector_log (GLogLevelFlags severity,
+ const gchar *domain,
+ const gchar *message)
+{
+}
+
+SysprofCaptureAddress
+sysprof_collector_map_jitted_ip (const gchar *name)
+{
+ return 0;
+}
+
+void
+sysprof_collector_allocate (SysprofCaptureAddress alloc_addr,
+ gint64 alloc_size,
+ SysprofBacktraceFunc backtrace_func,
+ gpointer backtrace_data)
+{
+ COLLECTOR_BEGIN {
+ SysprofCaptureAllocation *ev;
+ gsize len;
+
+ len = sizeof *ev + (sizeof (SysprofCaptureAllocation) * MAX_UNWIND_DEPTH);
+ _realign (&len);
+
+ if ((ev = mapped_ring_buffer_allocate (collector->buffer, len)))
+ {
+ ev->frame.type = SYSPROF_CAPTURE_FRAME_ALLOCATION;
+ ev->frame.len = len;
+ ev->frame.cpu = _do_getcpu ();
+ ev->frame.pid = collector->pid;
+ ev->frame.time = SYSPROF_CAPTURE_CURRENT_TIME;
+ ev->tid = collector->tid;
+ ev->alloc_addr = alloc_addr;
+ ev->alloc_size = alloc_size;
+ ev->n_addrs = 0;
+
+ if (backtrace_func)
+ ev->n_addrs = backtrace_func (ev->addrs, MAX_UNWIND_DEPTH, backtrace_data);
+
+ len = sizeof *ev + sizeof (SysprofCaptureAddress) * ev->n_addrs;
+ _realign (&len);
+ ev->frame.len = len;
+
+ mapped_ring_buffer_advance (collector->buffer, len);
+ }
+
+ } COLLECTOR_END;
+}
+
+guint
+sysprof_collector_reserve_counters (guint n_counters)
+{
+ return 0;
+}
+
+void
+sysprof_collector_define_counters (const SysprofCaptureCounter *counters,
+ guint n_counters)
+{
+}
+
+void
+sysprof_collector_publish_counters (const guint *counters_ids,
+ const SysprofCaptureCounterValue *values,
+ guint n_counters)
+{
+}
diff --git a/src/libsysprof-capture/sysprof-collector.h b/src/libsysprof-capture/sysprof-collector.h
new file mode 100644
index 0000000..bc23fb0
--- /dev/null
+++ b/src/libsysprof-capture/sysprof-collector.h
@@ -0,0 +1,108 @@
+/* sysprof-collector.h
+ *
+ * Copyright 2020 Christian Hergert <chergert redhat com>
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ *
+ * Subject to the terms and conditions of this license, each copyright holder
+ * and contributor hereby grants to those receiving rights under this license
+ * a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+ * irrevocable (except for failure to satisfy the conditions of this license)
+ * patent license to make, have made, use, offer to sell, sell, import, and
+ * otherwise transfer this software, where such license applies only to those
+ * patent claims, already acquired or hereafter acquired, licensable by such
+ * copyright holder or contributor that are necessarily infringed by:
+ *
+ * (a) their Contribution(s) (the licensed copyrights of copyright holders
+ * and non-copyrightable additions of contributors, in source or binary
+ * form) alone; or
+ *
+ * (b) combination of their Contribution(s) with the work of authorship to
+ * which such Contribution(s) was added by such copyright holder or
+ * contributor, if, at the time the Contribution is added, such addition
+ * causes such combination to be necessarily infringed. The patent license
+ * shall not apply to any other combinations which include the
+ * Contribution.
+ *
+ * Except as expressly stated above, no rights or licenses from any copyright
+ * holder or contributor is granted under this license, whether expressly, by
+ * implication, estoppel or otherwise.
+ *
+ * DISCLAIMER
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+ * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * SPDX-License-Identifier: BSD-2-Clause-Patent
+ */
+
+#pragma once
+
+#include "sysprof-capture-types.h"
+#include "sysprof-capture-writer.h"
+
+G_BEGIN_DECLS
+
+SYSPROF_AVAILABLE_IN_3_36
+void sysprof_collector_init (void);
+SYSPROF_AVAILABLE_IN_3_36
+void sysprof_collector_embed_file (const gchar *path,
+ const guint8 *data,
+ gsize data_len);
+SYSPROF_AVAILABLE_IN_3_36
+void sysprof_collector_embed_file_fd (const gchar *path,
+ gint fd);
+SYSPROF_AVAILABLE_IN_3_36
+void sysprof_collector_mark (gint64 time,
+ guint64 duration,
+ const gchar *group,
+ const gchar *name,
+ const gchar *mesage);
+SYSPROF_AVAILABLE_IN_3_36
+void sysprof_collector_set_metadata (const gchar *id,
+ const gchar *value,
+ gssize value_len);
+SYSPROF_AVAILABLE_IN_3_36
+void sysprof_collector_sample (gint64 time,
+ const SysprofCaptureAddress *addrs,
+ guint n_addrs);
+SYSPROF_AVAILABLE_IN_3_36
+void sysprof_collector_log (GLogLevelFlags severity,
+ const gchar *domain,
+ const gchar *message);
+SYSPROF_AVAILABLE_IN_3_36
+SysprofCaptureAddress sysprof_collector_map_jitted_ip (const gchar *name);
+SYSPROF_AVAILABLE_IN_3_36
+void sysprof_collector_allocate (SysprofCaptureAddress alloc_addr,
+ gint64 alloc_size,
+ SysprofBacktraceFunc backtrace_func,
+ gpointer backtrace_data);
+SYSPROF_AVAILABLE_IN_3_36
+guint sysprof_collector_reserve_counters (guint n_counters);
+SYSPROF_AVAILABLE_IN_3_36
+void sysprof_collector_define_counters (const SysprofCaptureCounter *counters,
+ guint n_counters);
+SYSPROF_AVAILABLE_IN_3_36
+void sysprof_collector_publish_counters (const guint *counters_ids,
+ const SysprofCaptureCounterValue *values,
+ guint n_counters);
+
+G_END_DECLS
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
