logger: add loadable logger

pipewire/server/main-loop.h

@@ -27,7 +27,7 @@ extern "C" {
 #include <spa/include/spa/loop.h>
 #include <pipewire/client/loop.h>
 
-/** \class pa_main_loop
+/** \class pw_main_loop
  *
  * \brief PipeWire main-loop interface.
  *

spa/lib/debug.h

@@ -43,8 +43,6 @@ int spa_debug_dump_mem(const void *data, size_t size);
 int spa_debug_dict(const struct spa_dict *dict);
 
 struct spa_log *spa_log_get_default(void);
-void spa_log_default_trace_purge(void);
-
 
 #ifdef __cplusplus
 } /* extern "C" */

spa/lib/props.c

@@ -57,7 +57,7 @@ static int compare_value(enum spa_pod_type type, const void *r1, const void *r2)
 	{
 		const struct spa_fraction *f1 = (struct spa_fraction *) r1,
 		    *f2 = (struct spa_fraction *) r2;
-		uint64_t n1, n2;
+		int64_t n1, n2;
 		n1 = ((int64_t) f1->num) * f2->denom;
 		n2 = ((int64_t) f2->num) * f1->denom;
 		if (n1 < n2)

spa/plugins/logger/logger.c

@@ -0,0 +1,264 @@
+/* Spa
+ * Copyright (C) 2017 Wim Taymans <wim.taymans@gmail.com>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 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
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#include <stddef.h>
+#include <unistd.h>
+#include <string.h>
+#include <errno.h>
+#include <stdio.h>
+#include <sys/eventfd.h>
+
+#include <spa/type-map.h>
+#include <spa/clock.h>
+#include <spa/log.h>
+#include <spa/loop.h>
+#include <spa/node.h>
+#include <spa/param-alloc.h>
+#include <spa/list.h>
+#include <spa/format-builder.h>
+#include <lib/props.h>
+
+#define NAME "logger"
+
+#define DEFAULT_LOG_LEVEL SPA_LOG_LEVEL_INFO
+
+#define TRACE_BUFFER 4096
+
+struct type {
+	uint32_t log;
+};
+
+static inline void init_type(struct type *type, struct spa_type_map *map)
+{
+	type->log = spa_type_map_get_id(map, SPA_TYPE__Log);
+}
+
+struct impl {
+	struct spa_handle handle;
+	struct spa_log log;
+
+	struct type type;
+	struct spa_type_map *map;
+
+	struct spa_ringbuffer trace_rb;
+	uint8_t trace_data[TRACE_BUFFER];
+
+	struct spa_loop *main_loop;
+	bool have_source;
+	struct spa_source trace_source;
+};
+
+static void
+impl_log_logv(struct spa_log *log,
+	      enum spa_log_level level,
+	      const char *file,
+	      int line,
+	      const char *func,
+	      const char *fmt,
+	      va_list args)
+{
+	struct impl *impl = SPA_CONTAINER_OF(log, struct impl, log);
+	char text[512], location[1024];
+	static const char *levels[] = { "-", "E", "W", "I", "D", "T", "*T*" };
+	int size;
+	bool do_trace;
+
+	if ((do_trace = (level == SPA_LOG_LEVEL_TRACE && impl->have_source)))
+		level++;
+
+	vsnprintf(text, sizeof(text), fmt, args);
+	size = snprintf(location, sizeof(location), "[%s][%s:%i %s()] %s\n",
+		levels[level], strrchr(file, '/') + 1, line, func, text);
+
+	if (SPA_UNLIKELY(do_trace)) {
+		uint32_t index;
+		uint64_t count = 1;
+
+		spa_ringbuffer_get_write_index(&impl->trace_rb, &index);
+		spa_ringbuffer_write_data(&impl->trace_rb, impl->trace_data,
+					  index & impl->trace_rb.mask, location, size);
+		spa_ringbuffer_write_update(&impl->trace_rb, index + size);
+
+		write(impl->trace_source.fd, &count, sizeof(uint64_t));
+	} else
+		fputs(location, stderr);
+}
+
+
+static void
+impl_log_log(struct spa_log *log,
+	     enum spa_log_level level,
+	     const char *file,
+	     int line,
+	     const char *func,
+	     const char *fmt, ...)
+{
+	va_list args;
+	va_start(args, fmt);
+	impl_log_logv(log, level, file, line, func, fmt, args);
+	va_end(args);
+}
+
+static const struct spa_log impl_log = {
+	sizeof(struct spa_log),
+	NULL,
+	DEFAULT_LOG_LEVEL,
+        impl_log_log,
+        impl_log_logv,
+};
+
+static void on_trace_event(struct spa_source *source)
+{
+	struct impl *impl = source->data;
+	int32_t avail;
+	uint32_t index;
+	uint64_t count;
+
+	if (read(source->fd, &count, sizeof(uint64_t)) != sizeof(uint64_t))
+		fprintf(stderr, "failed to read event fd: %s", strerror(errno));
+
+	while ((avail = spa_ringbuffer_get_read_index(&impl->trace_rb, &index)) > 0) {
+		uint32_t offset, first;
+
+		if (avail > impl->trace_rb.size) {
+			index += avail - impl->trace_rb.size;
+			avail = impl->trace_rb.size;
+		}
+		offset = index & impl->trace_rb.mask;
+		first = SPA_MIN(avail, impl->trace_rb.size - offset);
+
+		fwrite(impl->trace_data + offset, first, 1, stderr);
+		if (SPA_UNLIKELY(avail > first)) {
+			fwrite(impl->trace_data, avail - first, 1, stderr);
+		}
+		spa_ringbuffer_read_update(&impl->trace_rb, index + avail);
+        }
+}
+
+static int impl_get_interface(struct spa_handle *handle, uint32_t interface_id, void **interface)
+{
+	struct impl *this;
+
+	spa_return_val_if_fail(handle != NULL, SPA_RESULT_INVALID_ARGUMENTS);
+	spa_return_val_if_fail(interface != NULL, SPA_RESULT_INVALID_ARGUMENTS);
+
+	this = (struct impl *) handle;
+
+	if (interface_id == this->type.log)
+		*interface = &this->log;
+	else
+		return SPA_RESULT_UNKNOWN_INTERFACE;
+
+	return SPA_RESULT_OK;
+}
+
+static int impl_clear(struct spa_handle *handle)
+{
+	struct impl *this;
+
+	spa_return_val_if_fail(handle != NULL, SPA_RESULT_INVALID_ARGUMENTS);
+
+	this = (struct impl *) handle;
+
+	if (this->have_source) {
+		spa_loop_remove_source(this->main_loop, &this->trace_source);
+		close(this->trace_source.fd);
+	}
+
+	return SPA_RESULT_OK;
+}
+
+static int
+impl_init(const struct spa_handle_factory *factory,
+	  struct spa_handle *handle,
+	  const struct spa_dict *info,
+	  const struct spa_support *support,
+	  uint32_t n_support)
+{
+	struct impl *this;
+	uint32_t i;
+
+	spa_return_val_if_fail(factory != NULL, SPA_RESULT_INVALID_ARGUMENTS);
+	spa_return_val_if_fail(handle != NULL, SPA_RESULT_INVALID_ARGUMENTS);
+
+	handle->get_interface = impl_get_interface;
+	handle->clear = impl_clear;
+
+	this = (struct impl *) handle;
+
+	this->log = impl_log;
+
+	for (i = 0; i < n_support; i++) {
+		if (strcmp(support[i].type, SPA_TYPE__TypeMap) == 0)
+			this->map = support[i].data;
+		else if (strcmp(support[i].type, SPA_TYPE_LOOP__MainLoop) == 0)
+			this->main_loop = support[i].data;
+	}
+	if (this->map == NULL) {
+		spa_log_error(&this->log, "a type-map is needed");
+		return SPA_RESULT_ERROR;
+	}
+	init_type(&this->type, this->map);
+
+	spa_ringbuffer_init(&this->trace_rb, TRACE_BUFFER);
+
+	if (this->main_loop) {
+		this->trace_source.func = on_trace_event;
+		this->trace_source.data = this;
+		this->trace_source.fd = eventfd(0, EFD_CLOEXEC | EFD_NONBLOCK);
+		this->trace_source.mask = SPA_IO_IN;
+		this->trace_source.rmask = 0;
+		spa_loop_add_source(this->main_loop, &this->trace_source);
+		this->have_source = true;
+	}
+
+	spa_log_info(&this->log, NAME " %p: initialized", this);
+
+	return SPA_RESULT_OK;
+}
+
+static const struct spa_interface_info impl_interfaces[] = {
+	{SPA_TYPE__Log,},
+};
+
+static int
+impl_enum_interface_info(const struct spa_handle_factory *factory,
+			 const struct spa_interface_info **info,
+			 uint32_t index)
+{
+	spa_return_val_if_fail(factory != NULL, SPA_RESULT_INVALID_ARGUMENTS);
+	spa_return_val_if_fail(info != NULL, SPA_RESULT_INVALID_ARGUMENTS);
+
+	switch (index) {
+	case 0:
+		*info = &impl_interfaces[index];
+		break;
+	default:
+		return SPA_RESULT_ENUM_END;
+	}
+	return SPA_RESULT_OK;
+}
+
+const struct spa_handle_factory spa_logger_factory = {
+	NAME,
+	NULL,
+	sizeof(struct impl),
+	impl_init,
+	impl_enum_interface_info,
+};

spa/plugins/logger/meson.build

@@ -0,0 +1,9 @@
+spa_logger_sources = ['logger.c', 'plugin.c']
+
+spa_logger_lib = shared_library('spa-logger',
+                          spa_logger_sources,
+                          include_directories : [ spa_inc, spa_libinc],
+                          dependencies : threads_dep,
+                          link_with : spalib,
+                          install : true,
+                          install_dir : '@0@/spa'.format(get_option('libdir')))

spa/plugins/logger/plugin.c

@@ -0,0 +1,38 @@
+/* Spa Video Test Source plugin
+ * Copyright (C) 2016 Axis Communications AB
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 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
+ * Library General Public License for more details.
+ *
+ * You should have received a copy of the GNU Library General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#include <spa/plugin.h>
+#include <spa/node.h>
+
+extern const struct spa_handle_factory spa_logger_factory;
+
+int
+spa_handle_factory_enum(const struct spa_handle_factory **factory, uint32_t index)
+{
+	spa_return_val_if_fail(factory != NULL, SPA_RESULT_INVALID_ARGUMENTS);
+
+	switch (index) {
+	case 0:
+		*factory = &spa_logger_factory;
+		break;
+	default:
+		return SPA_RESULT_ENUM_END;
+	}
+	return SPA_RESULT_OK;
+}

spa/plugins/meson.build

@@ -2,6 +2,7 @@ subdir('alsa')
 subdir('audiomixer')
 subdir('audiotestsrc')
 subdir('ffmpeg')
+subdir('logger')
 subdir('test')
 subdir('videotestsrc')
 subdir('volume')