From bb26a986e6eb4b295e3a5f8d4a8ae81a18062c56 Mon Sep 17 00:00:00 2001
From: Norman Feske <norman.feske@genode-labs.com>
Date: Tue, 15 Mar 2022 11:50:05 +0100
Subject: [PATCH] sculpt: add trace_logger as optional launcher

This patch adds the trace-logger utility to the default set of packages
along with an optional launcher. With this change, only two steps are
needed to use Genode's tracing mechanism with Sculpt:

- Add 'trace_logger' to the 'launcher:' list of the .sculpt file

- Either manually select the 'trace_logger' from the '+' menu,
  or add the following entry to the deploy configuration:

    <start name="trace_logger"/>

By default, the trace logger is configured to trace all threads
executed in the runtime subsystem and to print a report every 10
seconds. This default policy can be refined in the launcher's <config>
node. Note that the trace logger does not respond to configuration
changes during runtime. Changes come into effect not before restarting
the component.

Issue #4448
---
 .../recipes/pkg/sculpt_distribution/archives  |  1 +
 repos/gems/sculpt/launcher/trace_logger       | 23 +++++++++++++++++++
 repos/os/recipes/pkg/trace_logger/README      |  1 +
 repos/os/recipes/pkg/trace_logger/archives    |  2 ++
 repos/os/recipes/pkg/trace_logger/hash        |  1 +
 repos/os/recipes/pkg/trace_logger/runtime     | 23 +++++++++++++++++++
 6 files changed, 51 insertions(+)
 create mode 100644 repos/gems/sculpt/launcher/trace_logger
 create mode 100644 repos/os/recipes/pkg/trace_logger/README
 create mode 100644 repos/os/recipes/pkg/trace_logger/archives
 create mode 100644 repos/os/recipes/pkg/trace_logger/hash
 create mode 100644 repos/os/recipes/pkg/trace_logger/runtime

diff --git a/repos/gems/recipes/pkg/sculpt_distribution/archives b/repos/gems/recipes/pkg/sculpt_distribution/archives
index c70d752092..730fdbbd1d 100644
--- a/repos/gems/recipes/pkg/sculpt_distribution/archives
+++ b/repos/gems/recipes/pkg/sculpt_distribution/archives
@@ -20,4 +20,5 @@ _/pkg/qt5_textedit
 _/pkg/mesa_gpu-cpu
 _/pkg/usb_webcam
 _/pkg/test-capture
+_/pkg/trace_logger
 _/pkg/mixer
diff --git a/repos/gems/sculpt/launcher/trace_logger b/repos/gems/sculpt/launcher/trace_logger
new file mode 100644
index 0000000000..afe1a4ef76
--- /dev/null
+++ b/repos/gems/sculpt/launcher/trace_logger
@@ -0,0 +1,23 @@
+<launcher pkg="trace_logger">
+
+	<route>
+		<service name="TRACE"> <parent/> </service>
+	</route>
+
+	<config verbose="yes"
+	        session_ram="90M"
+	        session_arg_buffer="1M"
+	        session_parent_levels="3"
+	        period_sec="10"
+	        default_policy="null"
+	        default_buffer="4K">
+
+		<policy label_prefix="init -> runtime -> "/>
+
+		<!-- uncomment to trace the drivers subsystem
+		<policy label_prefix="init -> drivers -> "/>
+		-->
+
+	</config>
+
+</launcher>
diff --git a/repos/os/recipes/pkg/trace_logger/README b/repos/os/recipes/pkg/trace_logger/README
new file mode 100644
index 0000000000..8a5206dd76
--- /dev/null
+++ b/repos/os/recipes/pkg/trace_logger/README
@@ -0,0 +1 @@
+Utility for capturing trace events to the log
diff --git a/repos/os/recipes/pkg/trace_logger/archives b/repos/os/recipes/pkg/trace_logger/archives
new file mode 100644
index 0000000000..7507ad964c
--- /dev/null
+++ b/repos/os/recipes/pkg/trace_logger/archives
@@ -0,0 +1,2 @@
+_/src/trace_logger
+_/src/trace_policy
diff --git a/repos/os/recipes/pkg/trace_logger/hash b/repos/os/recipes/pkg/trace_logger/hash
new file mode 100644
index 0000000000..2024465227
--- /dev/null
+++ b/repos/os/recipes/pkg/trace_logger/hash
@@ -0,0 +1 @@
+2022-03-11 46f96fe1863748eb451475e3efa4f0d5394b4f4c
diff --git a/repos/os/recipes/pkg/trace_logger/runtime b/repos/os/recipes/pkg/trace_logger/runtime
new file mode 100644
index 0000000000..7330daf6f2
--- /dev/null
+++ b/repos/os/recipes/pkg/trace_logger/runtime
@@ -0,0 +1,23 @@
+<runtime ram="100M" caps="1000" binary="trace_logger">
+
+	<requires> <trace/> <timer/> </requires>
+
+	<content>
+		<rom label="trace_logger"/>
+		<rom label="null"/>
+		<rom label="rpc_name"/>
+	</content>
+
+	<config verbose="no"
+	        session_ram="90M"
+	        session_arg_buffer="1M"
+	        session_parent_levels="1"
+	        period_sec="10"
+	        default_policy="null"
+	        default_buffer="8K">
+
+		<policy label_prefix="init -> runtime -> "/>
+
+	</config>
+
+</runtime>