Skip to contentSkip to conversation

trace backend: introduce multi tracing backend

PATCH Superseded Kazuya Saito 3 participants 8 messages Jan 29, 2014 – Feb 5, 2014 Kbuild

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 trace backend: introduce multi tracing backend

This patch implements "multi tracing backend" which enables several tracing backend simultaneously.

QEMU has multiple trace backends, but one of them needs to be chosen at compile time. When investigating issues of QEMU, it'd be much more convenient if we can use multiple trace backends without recompiling, especially 'ftrace backend' and 'dtrace backend'. From the performance perspective, 'ftrace backend' should be the one which runs while the system is in operation, and it provides useful information. But, for some issues, 'dtrace backend' is needed for investigation as 'dtrace backend' provides more information. This patch enables both 'ftrace backend' and 'dtrace backend' (, and some other backends if necessary) at compile time so that we can switch between the two without recompiling.

usage:
We have only to set some tracing backends as follows.

  $ ./configure --enable-trace-backend=ftrace,dtrace

Of course, we can compile with single backend as well as before.

  $ ./configure --enable-trace-backend=simple

Note: Now, we can select nop, ftrace, dtrace, stderr, ust, simple as
tracing backend. However, we can select ftrace, dtrace, stderr, simple when selecting more than two backends. Though it's needless to say about nop, I excluded ust backend because I didn't test it since it doesn't support LTTng 2.x.

---
 Makefile                              |    2 +-
 configure                             |   68 ++++++++++---------
 scripts/tracetool.py                  |    9 ++-
 scripts/tracetool/__init__.py         |   21 ++++--
 scripts/tracetool/backend/__init__.py |   20 ++++--
 scripts/tracetool/backend/common.py   |   78 +++++++++++++++++++++
 scripts/tracetool/backend/dtrace.py   |  107 +++++++++++++++++------------
 scripts/tracetool/backend/ftrace.py   |   60 +++++++++-------
 scripts/tracetool/backend/simple.py   |  124 +++++++++++++++++----------------
 scripts/tracetool/backend/stderr.py   |   44 +++++++-----
 trace/Makefile.objs                   |   22 ++++---
 trace/ftrace.c                        |   25 +------
 trace/ftrace.h                        |    1 +
 trace/multi.c                         |   52 ++++++++++++++
 trace/simple.c                        |   18 +-----
 trace/simple.h                        |    2 +-
 trace/stderr.c                        |   30 --------
 17 files changed, 403 insertions(+), 280 deletions(-)
 create mode 100644 scripts/tracetool/backend/common.py
 create mode 100644 trace/multi.c
 delete mode 100644 trace/stderr.c
Makefile +1 -1
index bdff4e4..7bcacf5 100644
@@ -52,7 +52,7 @@ GENERATED_HEADERS += trace/generated-events.h
 GENERATED_SOURCES += trace/generated-events.c
 
 GENERATED_HEADERS += trace/generated-tracers.h
-ifeq ($(TRACE_BACKEND),dtrace)
+ifeq ($(findstring dtrace,$(TRACE_BACKEND)),dtrace)
 GENERATED_HEADERS += trace/generated-tracers-dtrace.h
 endif
 GENERATED_SOURCES += trace/generated-tracers.c
configure +36 -32

84 lines not on this page · raw message

scripts/tracetool.py +5 -4
index 5f4890f..2c7c0c0 100755
@@ -112,10 +112,11 @@ def main(args):
         error_opt("backend not set")
 
     if check_backend:
-        if tracetool.backend.exists(arg_backend):
-            sys.exit(0)
-        else:
-            sys.exit(1)
+        for backend in arg_backend.split(","):
+            if tracetool.backend.exists(backend):
+                sys.exit(0)
+            else:
+                sys.exit(1)
 
     if arg_format == "stap":
         if binary is None:
scripts/tracetool/__init__.py +13 -8
index 175df08..a0addb5 100644
@@ -242,14 +242,19 @@ def generate(fevents, format, backend,
     if not tracetool.format.exists(mformat):
         raise TracetoolError("unknown format: %s" % format)
 
-    backend = str(backend)
+    backends = str(backend).split(",")
     if len(backend) is 0:
         raise TracetoolError("backend not set")
-    mbackend = backend.replace("-", "_")
-    if not tracetool.backend.exists(mbackend):
-        raise TracetoolError("unknown backend: %s" % backend)
 
-    if not tracetool.backend.compatible(mbackend, mformat):
+    compat = False
+    for backend in backends:
+        mbackend = backend.replace("-", "_")
+        if not tracetool.backend.exists(mbackend):
+            raise TracetoolError("unknown backend: %s" % backend)
+
+        compat |= tracetool.backend.compatible(mbackend, mformat)
+
+    if not compat:
         raise TracetoolError("backend '%s' not compatible with format '%s'" %
                              (backend, format))
 
@@ -259,15 +264,15 @@ def generate(fevents, format, backend,
 
     events = _read_events(fevents)
 
-    if backend == "nop":
+    if backends == ["nop"]:
         ( e.properies.add("disable") for e in events )
 
     tracetool.format.generate_begin(mformat, events)
-    tracetool.backend.generate("nop", format,
+    tracetool.backend.generate(["nop"], format,
                                [ e
                                  for e in events
                                  if "disable" in e.properties ])
-    tracetool.backend.generate(backend, format,
+    tracetool.backend.generate(backends, format,
                                [ e
                                  for e in events
                                  if "disable" not in e.properties ])
scripts/tracetool/backend/__init__.py +14 -6
index f0314ee..40efcb5 100644
@@ -110,20 +110,28 @@ def compatible(backend, format):
 def _empty(events):
     pass
 
-def generate(backend, format, events):
+def generate(backends, format, events):
     """Generate the per-event output for the given (backend, format) pair."""
-    if not compatible(backend, format):
+    compat = False
+    for backend in backends:
+        compat |= compatible(backend, format)
+    if not compat:
         raise ValueError("backend '%s' not compatible with format '%s'" %
                          (backend, format))
 
-    backend = backend.replace("-", "_")
+    backends = map(lambda x: x.replace("-", "_"), backends)
     format = format.replace("-", "_")
 
-    if backend == "nop":
+    if backends == ["nop"]:
         func = tracetool.try_import("tracetool.format." + format,
                                     "nop", _empty)[1]
+        func(events)
+    elif set(backends).issubset(["dtrace", "ftrace", "simple", "stderr"]):
+        func = tracetool.try_import("tracetool.backend.common",
+                                    format, None)[1]
+        func(backends, events)
     else:
         func = tracetool.try_import("tracetool.backend." + backend,
                                     format, None)[1]
-
-    func(events)
+        func(events)
+
scripts/tracetool/backend/common.py new file +78 -0

78 lines not on this page · raw message

scripts/tracetool/backend/dtrace.py +63 -44

130 lines not on this page · raw message

scripts/tracetool/backend/ftrace.py +35 -25

68 lines not on this page · raw message

scripts/tracetool/backend/simple.py +63 -61

140 lines not on this page · raw message

scripts/tracetool/backend/stderr.py +26 -18

53 lines not on this page · raw message

trace/Makefile.objs +13 -9
index 3b88e49..7eb0f69 100644
@@ -35,8 +35,7 @@ $(obj)/generated-tracers.h-timestamp: $(SRC_PATH)/trace-events $(BUILD_DIR)/conf
 
 ######################################################################
 # Auto-generated tracing routines (non-DTrace)
-
-ifneq ($(TRACE_BACKEND),dtrace)
+ifneq ($(findstring dtrace,$(TRACE_BACKEND)),dtrace)
 $(obj)/generated-tracers.c: $(obj)/generated-tracers.c-timestamp
 	@cmp -s $< $@ || cp $< $@
 $(obj)/generated-tracers.c-timestamp: $(SRC_PATH)/trace-events $(BUILD_DIR)/config-host.mak
@@ -44,18 +43,23 @@ $(obj)/generated-tracers.c-timestamp: $(SRC_PATH)/trace-events $(BUILD_DIR)/conf
 		--format=c \
 		--backend=$(TRACE_BACKEND) \
 		< $< > $@,"  GEN   $(patsubst %-timestamp,%,$@)")
-
 $(obj)/generated-tracers.o: $(obj)/generated-tracers.c $(obj)/generated-tracers.h
 endif
 
-
 ######################################################################
 # Auto-generated DTrace code
 
 # Normal practice is to name DTrace probe file with a '.d' extension
 # but that gets picked up by QEMU's Makefile as an external dependency
 # rule file. So we use '.dtrace' instead
-ifeq ($(TRACE_BACKEND),dtrace)
+ifeq ($(findstring dtrace,$(TRACE_BACKEND)),dtrace)
+$(obj)/generated-tracers.c: $(obj)/generated-tracers.c-timestamp
+	@cmp -s $< $@ || cp $< $@
+$(obj)/generated-tracers.c-timestamp: $(SRC_PATH)/trace-events $(BUILD_DIR)/config-host.mak
+	$(call quiet-command,$(TRACETOOL) \
+		--format=c \
+		--backend=$(TRACE_BACKEND) \
+		< $< > $@,"  GEN   $(patsubst %-timestamp,%,$@)")
 $(obj)/generated-tracers.dtrace: $(obj)/generated-tracers.dtrace-timestamp
 $(obj)/generated-tracers.dtrace-timestamp: $(SRC_PATH)/trace-events $(BUILD_DIR)/config-host.mak
 	$(call quiet-command,$(TRACETOOL) \
@@ -67,15 +71,15 @@ $(obj)/generated-tracers.dtrace-timestamp: $(SRC_PATH)/trace-events $(BUILD_DIR)
 $(obj)/generated-tracers-dtrace.h: $(obj)/generated-tracers.dtrace
 	$(call quiet-command,dtrace -o $@ -h -s $<, "  GEN   $@")
 
-$(obj)/generated-tracers.o: $(obj)/generated-tracers.dtrace
+$(obj)/generated-tracers.o: $(obj)/generated-tracers.dtrace $(obj)/generated-tracers.c $(obj)/generated-tracers.h
 endif
 
 ######################################################################
 # Backend code
 
 util-obj-$(CONFIG_TRACE_DEFAULT) += default.o
-util-obj-$(CONFIG_TRACE_SIMPLE) += simple.o
-util-obj-$(CONFIG_TRACE_STDERR) += stderr.o
-util-obj-$(CONFIG_TRACE_FTRACE) += ftrace.o
+util-obj-$(CONFIG_TRACE_SIMPLE) += multi.o simple.o
+util-obj-$(CONFIG_TRACE_STDERR) += multi.o
+util-obj-$(CONFIG_TRACE_FTRACE) += multi.o ftrace.o
 util-obj-y += control.o
 util-obj-y += generated-tracers.o
trace/ftrace.c +1 -24
index 46b7fdb..e2f118e 100644
@@ -42,35 +42,13 @@ static int find_debugfs(char *debugfs)
     return 1;
 }
 
-void trace_print_events(FILE *stream, fprintf_function stream_printf)
-{
-    TraceEventID i;
-
-    for (i = 0; i < trace_event_count(); i++) {
-        TraceEvent *ev = trace_event_id(i);
-        stream_printf(stream, "%s [Event ID %u] : state %u\n",
-                      trace_event_get_name(ev), i, trace_event_get_state_dynamic(ev));
-    }
-}
-
-void trace_event_set_state_dynamic_backend(TraceEvent *ev, bool state)
-{
-    ev->dstate = state;
-}
-
-bool trace_backend_init(const char *events, const char *file)
+bool ftrace_backend_init(const char *events, const char *file)
 {
     char debugfs[PATH_MAX];
     char path[PATH_MAX];
     int debugfs_found;
     int trace_fd = -1;
 
-    if (file) {
-        fprintf(stderr, "error: -trace file=...: "
-                "option not supported by the selected tracing backend\n");
-        return false;
-    }
-
     debugfs_found = find_debugfs(debugfs);
     if (debugfs_found) {
         snprintf(path, PATH_MAX, "%s/tracing/tracing_on", debugfs);
@@ -97,6 +75,5 @@ bool trace_backend_init(const char *events, const char *file)
         return false;
     }
 
-    trace_backend_init_events(events);
     return true;
 }
trace/ftrace.h +1 -0
index 94cb8d5..f508f33 100644
@@ -6,5 +6,6 @@
 #define STR(x) _STR(x)
 
 extern int trace_marker_fd;
+bool ftrace_backend_init(const char *events, const char *file);
 
 #endif /* ! TRACE_FTRACE_H */
trace/multi.c new file +52 -0

52 lines not on this page · raw message

trace/simple.c +1 -17
index 1e3f691..75c8e17 100644
@@ -356,22 +356,6 @@ void st_flush_trace_buffer(void)
     flush_trace_file(true);
 }
 
-void trace_print_events(FILE *stream, fprintf_function stream_printf)
-{
-    unsigned int i;
-
-    for (i = 0; i < trace_event_count(); i++) {
-        TraceEvent *ev = trace_event_id(i);
-        stream_printf(stream, "%s [Event ID %u] : state %u\n",
-                      trace_event_get_name(ev), i, trace_event_get_state_dynamic(ev));
-    }
-}
-
-void trace_event_set_state_dynamic_backend(TraceEvent *ev, bool state)
-{
-    ev->dstate = state;
-}
-
 /* Helper function to create a thread with signals blocked.  Use glib's
  * portable threads since QEMU abstractions cannot be used due to reentrancy in
  * the tracer.  Also note the signal masking on POSIX hosts so that the thread
@@ -400,7 +384,7 @@ static GThread *trace_thread_create(GThreadFunc fn)
     return thread;
 }
 
-bool trace_backend_init(const char *events, const char *file)
+bool simpletrace_backend_init(const char *events, const char *file)
 {
     GThread *thread;
 
trace/simple.h +1 -1
index 5260d9a..da9b7f6 100644
@@ -53,5 +53,5 @@ void trace_record_write_str(TraceBufferRecord *rec, const char *s, uint32_t slen
  * Don't append any more arguments to the trace record after calling this.
  */
 void trace_record_finish(TraceBufferRecord *rec);
-
+bool simpletrace_backend_init(const char *events, const char *file);
 #endif /* TRACE_SIMPLE_H */
trace/stderr.c deleted +0 -30
deleted file mode 100644
index e212efd..0000000
@@ -1,30 +0,0 @@
-#include "trace.h"
-#include "trace/control.h"
-
-
-void trace_print_events(FILE *stream, fprintf_function stream_printf)
-{
-    TraceEventID i;
-
-    for (i = 0; i < trace_event_count(); i++) {
-        TraceEvent *ev = trace_event_id(i);
-        stream_printf(stream, "%s [Event ID %u] : state %u\n",
-                      trace_event_get_name(ev), i, trace_event_get_state_dynamic(ev));
-    }
-}
-
-void trace_event_set_state_dynamic_backend(TraceEvent *ev, bool state)
-{
-    ev->dstate = state;
-}
-
-bool trace_backend_init(const char *events, const char *file)
-{
-    if (file) {
-        fprintf(stderr, "error: -trace file=...: "
-                "option not supported by the selected tracing backend\n");
-        return false;
-    }
-    trace_backend_init_events(events);
-    return true;
-}
Signature · 1 line
1.7.1
#1 lore raw

On Tue, Jan 28, 2014 at 01:35:20PM +0900, Kazuya Saito wrote:

Some initial comments, I will continue reviewing tomorrow.

Quoted 15 lines

This patch implements "multi tracing backend" which enables several tracing backend simultaneously.

QEMU has multiple trace backends, but one of them needs to be chosen at compile time. When investigating issues of QEMU, it'd be much more convenient if we can use multiple trace backends without recompiling, especially 'ftrace backend' and 'dtrace backend'. From the performance perspective, 'ftrace backend' should be the one which runs while the system is in operation, and it provides useful information. But, for some issues, 'dtrace backend' is needed for investigation as 'dtrace backend' provides more information. This patch enables both 'ftrace backend' and 'dtrace backend' (, and some other backends if necessary) at compile time so that we can switch between the two without recompiling.

Quoted 8 lines

usage:
We have only to set some tracing backends as follows.

  $ ./configure --enable-trace-backend=ftrace,dtrace

Of course, we can compile with single backend as well as before.

  $ ./configure --enable-trace-backend=simple

Great, this functionality has been suggested before so I'm sure it will come in handy.

Quoted 5 lines

Note: Now, we can select nop, ftrace, dtrace, stderr, ust, simple as
tracing backend. However, we can select ftrace, dtrace, stderr, simple when selecting more than two backends. Though it's needless to say about nop, I excluded ust backend because I didn't test it since it doesn't support LTTng 2.x.

I have just reviewed and merged the LTTng 2.x patch series.

You can base your patch on:
git://github.com/stefanha/qemu.git tracing-next

Quoted 55 lines
---
 Makefile                              |    2 +-
 configure                             |   68 ++++++++++---------
 scripts/tracetool.py                  |    9 ++-
 scripts/tracetool/__init__.py         |   21 ++++--
 scripts/tracetool/backend/__init__.py |   20 ++++--
 scripts/tracetool/backend/common.py   |   78 +++++++++++++++++++++
 scripts/tracetool/backend/dtrace.py   |  107 +++++++++++++++++------------
 scripts/tracetool/backend/ftrace.py   |   60 +++++++++-------
 scripts/tracetool/backend/simple.py   |  124 +++++++++++++++++----------------
 scripts/tracetool/backend/stderr.py   |   44 +++++++-----
 trace/Makefile.objs                   |   22 ++++---
 trace/ftrace.c                        |   25 +------
 trace/ftrace.h                        |    1 +
 trace/multi.c                         |   52 ++++++++++++++
 trace/simple.c                        |   18 +-----
 trace/simple.h                        |    2 +-
 trace/stderr.c                        |   30 --------
 17 files changed, 403 insertions(+), 280 deletions(-)
 create mode 100644 scripts/tracetool/backend/common.py
 create mode 100644 trace/multi.c
 delete mode 100644 trace/stderr.c
Makefile +1 -1
index bdff4e4..7bcacf5 100644
@@ -52,7 +52,7 @@ GENERATED_HEADERS += trace/generated-events.h
 GENERATED_SOURCES += trace/generated-events.c
 
 GENERATED_HEADERS += trace/generated-tracers.h
-ifeq ($(TRACE_BACKEND),dtrace)
+ifeq ($(findstring dtrace,$(TRACE_BACKEND)),dtrace)
 GENERATED_HEADERS += trace/generated-tracers-dtrace.h
 endif
 GENERATED_SOURCES += trace/generated-tracers.c
configure +3 -7
index 3782a6a..ce3d7d6 100755
@@ -3375,15 +3375,18 @@ fi
 
 ##########################################
 # For 'dtrace' backend, test if 'dtrace' command is present
-if test "$trace_backend" = "dtrace"; then
-  if ! has 'dtrace' ; then
-    error_exit "dtrace command is not found in PATH $PATH"
-  fi
-  trace_backend_stap="no"
-  if has 'stap' ; then
-    trace_backend_stap="yes"
+IFS=','
+for backend in ${trace_backend}; do
+  if test "$backend" = "dtrace"; then

configure fi · line 3389

Quoted 10 lines
configure +8 -1
+    if ! has 'dtrace' ; then
+      error_exit "dtrace command is not found in PATH $PATH"
+    fi
+    trace_backend_stap="no"
+    if has 'stap' ; then
+      trace_backend_stap="yes"
+    fi
   fi
-fi
+done

Please unset IFS, either at the end of the loop (if you're sure the body of the loop doesn't depend on the default IFS whitespace splitting) or both in the body and at the end of the loop:

IFS=','
for backend in ${trace_backend}; do

    unset IFS
    ...
    IFS=','

done
unset IFS

Failure to unset IFS means the rest of the script will split on commas instead of whitespace.

I think the following is an easier solution:
if grep dtrace "$trace_backend" >/dev/null; then

    ...

fi

Quoted 87 lines
configure +25 -24
 ##########################################
 # check and set a backend for coroutine
@@ -4262,33 +4265,34 @@ echo "TRACE_BACKEND=$trace_backend" >> $config_host_mak
 if test "$trace_backend" = "nop"; then
   echo "CONFIG_TRACE_NOP=y" >> $config_host_mak
 fi
-if test "$trace_backend" = "simple"; then
-  echo "CONFIG_TRACE_SIMPLE=y" >> $config_host_mak
-  trace_default=no
-  # Set the appropriate trace file.
-  trace_file="\"$trace_file-\" FMT_pid"
-fi
-if test "$trace_backend" = "stderr"; then
-  echo "CONFIG_TRACE_STDERR=y" >> $config_host_mak
-  trace_default=no
-fi
-if test "$trace_backend" = "ust"; then
-  echo "CONFIG_TRACE_UST=y" >> $config_host_mak
-fi
-if test "$trace_backend" = "dtrace"; then
-  echo "CONFIG_TRACE_DTRACE=y" >> $config_host_mak
-  if test "$trace_backend_stap" = "yes" ; then
-    echo "CONFIG_TRACE_SYSTEMTAP=y" >> $config_host_mak
+
+for backend in ${trace_backend}; do
+  if test "$backend" = "simple"; then
+    echo "CONFIG_TRACE_SIMPLE=y" >> $config_host_mak
+    trace_default=no
+    # Set the appropriate trace file.
+    trace_file="\"$trace_file-\" FMT_pid"
   fi
-fi
-if test "$trace_backend" = "ftrace"; then
-  if test "$linux" = "yes" ; then
-    echo "CONFIG_TRACE_FTRACE=y" >> $config_host_mak
+  if test "$backend" = "stderr"; then
+    echo "CONFIG_TRACE_STDERR=y" >> $config_host_mak
     trace_default=no
-  else
-    feature_not_found "ftrace(trace backend)"
   fi
-fi
+  if test "$backend" = "dtrace"; then
+    echo "CONFIG_TRACE_DTRACE=y" >> $config_host_mak
+    if test "$trace_backend_stap" = "yes" ; then
+      echo "CONFIG_TRACE_SYSTEMTAP=y" >> $config_host_mak
+    fi
+  fi
+  if test "$backend" = "ftrace"; then
+    if test "$linux" = "yes" ; then
+      echo "CONFIG_TRACE_FTRACE=y" >> $config_host_mak
+      trace_default=no
+    else
+      feature_not_found "ftrace(trace backend)"
+    fi
+  fi
+done
+
 echo "CONFIG_TRACE_FILE=$trace_file" >> $config_host_mak
 if test "$trace_default" = "yes"; then
   echo "CONFIG_TRACE_DEFAULT=y" >> $config_host_mak
scripts/tracetool.py +5 -4
index 5f4890f..2c7c0c0 100755
@@ -112,10 +112,11 @@ def main(args):
         error_opt("backend not set")
 
     if check_backend:
-        if tracetool.backend.exists(arg_backend):
-            sys.exit(0)
-        else:
-            sys.exit(1)
+        for backend in arg_backend.split(","):
+            if tracetool.backend.exists(backend):
+                sys.exit(0)
+            else:
+                sys.exit(1)
 
     if arg_format == "stap":
         if binary is None:
scripts/tracetool/__init__.py +0 -0
index 175df08..a0addb5 100644

scripts/tracetool/__init__.py def generate(fevents, format, backend, · line 246

Quoted 6 lines
scripts/tracetool/__init__.py +1 -1
@@ -242,14 +242,19 @@ def generate(fevents, format, backend,
     if not tracetool.format.exists(mformat):
         raise TracetoolError("unknown format: %s" % format)
 
-    backend = str(backend)
+    backends = str(backend).split(",")
     if len(backend) is 0:

Before you modified the code it converted 'backend' to a string. Now it tests len(backend) without converting it to a string.

I suggest s/backend/backends/ in this line to avoid that semantic change.

Quoted 7 lines
scripts/tracetool/__init__.py +1 -4
         raise TracetoolError("backend not set")
-    mbackend = backend.replace("-", "_")
-    if not tracetool.backend.exists(mbackend):
-        raise TracetoolError("unknown backend: %s" % backend)
 
-    if not tracetool.backend.compatible(mbackend, mformat):
+    compat = False

scripts/tracetool/__init__.py def generate(fevents, format, backend, · line 259

Quoted 10 lines
scripts/tracetool/__init__.py +8 -0
+    for backend in backends:
+        mbackend = backend.replace("-", "_")
+        if not tracetool.backend.exists(mbackend):
+            raise TracetoolError("unknown backend: %s" % backend)
+
+        compat |= tracetool.backend.compatible(mbackend, mformat)
+
+    if not compat:
         raise TracetoolError("backend '%s' not compatible with format '%s'" %
                              (backend, format))

This suggests we will generate output in formats that only some backends suggest. It might be help to add a comment like:
# At least one backend must support the format

Just a hint to the reader that this behavior is intentional.

#2 lore raw
Quoted 2 lines · Kazuya Saito

Some initial comments, I will continue reviewing tomorrow.

Thank you for your comment.

Quoted 33 lines
Quoted 15 lines

This patch implements "multi tracing backend" which enables several tracing backend simultaneously.

QEMU has multiple trace backends, but one of them needs to be chosen at compile time. When investigating issues of QEMU, it'd be much more convenient if we can use multiple trace backends without recompiling, especially 'ftrace backend' and 'dtrace backend'. From the performance perspective, 'ftrace backend' should be the one which runs while the system is in operation, and it provides useful information. But, for some issues, 'dtrace backend' is needed for investigation as 'dtrace backend' provides more information. This patch enables both 'ftrace backend' and 'dtrace backend' (, and some other backends if necessary) at compile time so that we can switch between the two without recompiling.

Quoted 8 lines

usage:
We have only to set some tracing backends as follows.

  $ ./configure --enable-trace-backend=ftrace,dtrace

Of course, we can compile with single backend as well as before.

  $ ./configure --enable-trace-backend=simple

Great, this functionality has been suggested before so I'm sure it will come in handy.

Quoted 5 lines

Note: Now, we can select nop, ftrace, dtrace, stderr, ust, simple as
tracing backend. However, we can select ftrace, dtrace, stderr, simple when selecting more than two backends. Though it's needless to say about nop, I excluded ust backend because I didn't test it since it doesn't support LTTng 2.x.

Quoted 4 lines

I have just reviewed and merged the LTTng 2.x patch series.

You can base your patch on:
git://github.com/stefanha/qemu.git tracing-next

Thank you for the information. I'll base my patch on tracing-next branch and post it here.

Quoted 78 lines
Quoted 55 lines
---
 Makefile                              |    2 +-
 configure                             |   68 ++++++++++---------
 scripts/tracetool.py                  |    9 ++-
 scripts/tracetool/__init__.py         |   21 ++++--
 scripts/tracetool/backend/__init__.py |   20 ++++--
 scripts/tracetool/backend/common.py   |   78 +++++++++++++++++++++
 scripts/tracetool/backend/dtrace.py   |  107 +++++++++++++++++------------
 scripts/tracetool/backend/ftrace.py   |   60 +++++++++-------
 scripts/tracetool/backend/simple.py   |  124 +++++++++++++++++----------------
 scripts/tracetool/backend/stderr.py   |   44 +++++++-----
 trace/Makefile.objs                   |   22 ++++---
 trace/ftrace.c                        |   25 +------
 trace/ftrace.h                        |    1 +
 trace/multi.c                         |   52 ++++++++++++++
 trace/simple.c                        |   18 +-----
 trace/simple.h                        |    2 +-
 trace/stderr.c                        |   30 --------
 17 files changed, 403 insertions(+), 280 deletions(-)
 create mode 100644 scripts/tracetool/backend/common.py
 create mode 100644 trace/multi.c
 delete mode 100644 trace/stderr.c
Makefile +1 -1
index bdff4e4..7bcacf5 100644
@@ -52,7 +52,7 @@ GENERATED_HEADERS += trace/generated-events.h
 GENERATED_SOURCES += trace/generated-events.c
 
 GENERATED_HEADERS += trace/generated-tracers.h
-ifeq ($(TRACE_BACKEND),dtrace)
+ifeq ($(findstring dtrace,$(TRACE_BACKEND)),dtrace)
 GENERATED_HEADERS += trace/generated-tracers-dtrace.h
 endif
 GENERATED_SOURCES += trace/generated-tracers.c
configure +3 -7
index 3782a6a..ce3d7d6 100755
@@ -3375,15 +3375,18 @@ fi
 
 ##########################################
 # For 'dtrace' backend, test if 'dtrace' command is present
-if test "$trace_backend" = "dtrace"; then
-  if ! has 'dtrace' ; then
-    error_exit "dtrace command is not found in PATH $PATH"
-  fi
-  trace_backend_stap="no"
-  if has 'stap' ; then
-    trace_backend_stap="yes"
+IFS=','
+for backend in ${trace_backend}; do
+  if test "$backend" = "dtrace"; then

configure fi · line 3389

Quoted 10 lines
configure +8 -1
+    if ! has 'dtrace' ; then
+      error_exit "dtrace command is not found in PATH $PATH"
+    fi
+    trace_backend_stap="no"
+    if has 'stap' ; then
+      trace_backend_stap="yes"
+    fi
   fi
-fi
+done

Please unset IFS, either at the end of the loop (if you're sure the body of the loop doesn't depend on the default IFS whitespace splitting) or both in the body and at the end of the loop:

IFS=','
for backend in ${trace_backend}; do

    unset IFS
    ...
    IFS=','

done
unset IFS

Quoted 7 lines

Failure to unset IFS means the rest of the script will split on commas instead of whitespace.

I think the following is an easier solution:
if grep dtrace "$trace_backend" >/dev/null; then

    ...

fi

I'll fix it as you said. And the following loops (tracing backend-specific routines) will be fixed in a similar way.

Quoted 96 lines
Quoted 86 lines
configure +25 -24
 ##########################################
 # check and set a backend for coroutine
@@ -4262,33 +4265,34 @@ echo "TRACE_BACKEND=$trace_backend" >> $config_host_mak
 if test "$trace_backend" = "nop"; then
   echo "CONFIG_TRACE_NOP=y" >> $config_host_mak
 fi
-if test "$trace_backend" = "simple"; then
-  echo "CONFIG_TRACE_SIMPLE=y" >> $config_host_mak
-  trace_default=no
-  # Set the appropriate trace file.
-  trace_file="\"$trace_file-\" FMT_pid"
-fi
-if test "$trace_backend" = "stderr"; then
-  echo "CONFIG_TRACE_STDERR=y" >> $config_host_mak
-  trace_default=no
-fi
-if test "$trace_backend" = "ust"; then
-  echo "CONFIG_TRACE_UST=y" >> $config_host_mak
-fi
-if test "$trace_backend" = "dtrace"; then
-  echo "CONFIG_TRACE_DTRACE=y" >> $config_host_mak
-  if test "$trace_backend_stap" = "yes" ; then
-    echo "CONFIG_TRACE_SYSTEMTAP=y" >> $config_host_mak
+
+for backend in ${trace_backend}; do
+  if test "$backend" = "simple"; then
+    echo "CONFIG_TRACE_SIMPLE=y" >> $config_host_mak
+    trace_default=no
+    # Set the appropriate trace file.
+    trace_file="\"$trace_file-\" FMT_pid"
   fi
-fi
-if test "$trace_backend" = "ftrace"; then
-  if test "$linux" = "yes" ; then
-    echo "CONFIG_TRACE_FTRACE=y" >> $config_host_mak
+  if test "$backend" = "stderr"; then
+    echo "CONFIG_TRACE_STDERR=y" >> $config_host_mak
     trace_default=no
-  else
-    feature_not_found "ftrace(trace backend)"
   fi
-fi
+  if test "$backend" = "dtrace"; then
+    echo "CONFIG_TRACE_DTRACE=y" >> $config_host_mak
+    if test "$trace_backend_stap" = "yes" ; then
+      echo "CONFIG_TRACE_SYSTEMTAP=y" >> $config_host_mak
+    fi
+  fi
+  if test "$backend" = "ftrace"; then
+    if test "$linux" = "yes" ; then
+      echo "CONFIG_TRACE_FTRACE=y" >> $config_host_mak
+      trace_default=no
+    else
+      feature_not_found "ftrace(trace backend)"
+    fi
+  fi
+done
+
 echo "CONFIG_TRACE_FILE=$trace_file" >> $config_host_mak
 if test "$trace_default" = "yes"; then
   echo "CONFIG_TRACE_DEFAULT=y" >> $config_host_mak
scripts/tracetool.py +5 -4
index 5f4890f..2c7c0c0 100755
@@ -112,10 +112,11 @@ def main(args):
         error_opt("backend not set")
 
     if check_backend:
-        if tracetool.backend.exists(arg_backend):
-            sys.exit(0)
-        else:
-            sys.exit(1)
+        for backend in arg_backend.split(","):
+            if tracetool.backend.exists(backend):
+                sys.exit(0)
+            else:
+                sys.exit(1)
 
     if arg_format == "stap":
         if binary is None:
scripts/tracetool/__init__.py +0 -0
index 175df08..a0addb5 100644

scripts/tracetool/__init__.py def generate(fevents, format, backend, · line 246

Quoted 6 lines
scripts/tracetool/__init__.py +1 -1
@@ -242,14 +242,19 @@ def generate(fevents, format, backend,
     if not tracetool.format.exists(mformat):
         raise TracetoolError("unknown format: %s" % format)
 
-    backend = str(backend)
+    backends = str(backend).split(",")
     if len(backend) is 0:

Before you modified the code it converted 'backend' to a string. Now it tests len(backend) without converting it to a string.

Quoted 2 lines

I suggest s/backend/backends/ in this line to avoid that semantic change.

"backends" is a list not a string. So, I'll modify it to the following.

backends = str(backend).split(",")
for backend in backends:
if len(backend) is 0:

Quoted 22 lines
Quoted 7 lines
scripts/tracetool/__init__.py +1 -4
         raise TracetoolError("backend not set")
-    mbackend = backend.replace("-", "_")
-    if not tracetool.backend.exists(mbackend):
-        raise TracetoolError("unknown backend: %s" % backend)
 
-    if not tracetool.backend.compatible(mbackend, mformat):
+    compat = False

scripts/tracetool/__init__.py def generate(fevents, format, backend, · line 259

Quoted 10 lines
scripts/tracetool/__init__.py +8 -0
+    for backend in backends:
+        mbackend = backend.replace("-", "_")
+        if not tracetool.backend.exists(mbackend):
+            raise TracetoolError("unknown backend: %s" % backend)
+
+        compat |= tracetool.backend.compatible(mbackend, mformat)
+
+    if not compat:
         raise TracetoolError("backend '%s' not compatible with format '%s'" %
                              (backend, format))

This suggests we will generate output in formats that only some backends suggest. It might be help to add a comment like:
# At least one backend must support the format

Quoted 1 line

Just a hint to the reader that this behavior is intentional.

OK, I'll insert the comment so that the reader can understand easier.

Thanks,
Kazuya Saito

#3 lore raw
Quoted 16 lines · Kazuya Saito
Quoted 15 lines · Kazuya Saito

scripts/tracetool/__init__.py def generate(fevents, format, backend, · line 246

Quoted 11 lines
scripts/tracetool/__init__.py +1 -1
index 175df08..a0addb5 100644
@@ -242,14 +242,19 @@ def generate(fevents, format, backend,
     if not tracetool.format.exists(mformat):
         raise TracetoolError("unknown format: %s" % format)
 
-    backend = str(backend)
+    backends = str(backend).split(",")
     if len(backend) is 0:

Before you modified the code it converted 'backend' to a string. Now it tests len(backend) without converting it to a string.

Quoted 8 lines
Quoted 2 lines

I suggest s/backend/backends/ in this line to avoid that semantic change.

"backends" is a list not a string. So, I'll modify it to the following.

backends = str(backend).split(",")
for backend in backends:
if len(backend) is 0:

You are right:

Quoted 1 line
Quoted 1 line

scripts/tracetool/__init__.py def generate(fevents, format, backend, · line 247

Quoted 1 line
scripts/tracetool/__init__.py +0 -0
 ''.split(',')

['']

I thought it returns [].

Stefan

#4 lore raw
In reply to Kazuya Saito

On Tue, Jan 28, 2014 at 01:35:20PM +0900, Kazuya Saito wrote:

Okay, more feedback after looking at the rest of the patch.

I think "ust" backend support will simplify the patch a little (see details below).

Looking forward to the next revision. Let me know if you have any questions about my feedback.

scripts/tracetool/backend/__init__.py def compatible(backend, format): · line 114

Quoted 11 lines
scripts/tracetool/backend/__init__.py +1 -1
index f0314ee..40efcb5 100644
@@ -110,20 +110,28 @@ def compatible(backend, format):
 def _empty(events):
     pass
 
-def generate(backend, format, events):
+def generate(backends, format, events):
     """Generate the per-event output for the given (backend, format) pair."""

Please update the doc comment to reflect the new argument.

Quoted 14 lines
scripts/tracetool/backend/__init__.py +6 -3
-    if not compatible(backend, format):
+    compat = False
+    for backend in backends:
+        compat |= compatible(backend, format)
+    if not compat:
         raise ValueError("backend '%s' not compatible with format '%s'" %
                          (backend, format))
 
-    backend = backend.replace("-", "_")
+    backends = map(lambda x: x.replace("-", "_"), backends)
     format = format.replace("-", "_")
 
-    if backend == "nop":
+    if backends == ["nop"]:

scripts/tracetool/backend/__init__.py def compatible(backend, format): · line 135

Quoted 10 lines
scripts/tracetool/backend/__init__.py +5 -0
         func = tracetool.try_import("tracetool.format." + format,
                                     "nop", _empty)[1]
+        func(events)
+    elif set(backends).issubset(["dtrace", "ftrace", "simple", "stderr"]):
+        func = tracetool.try_import("tracetool.backend.common",
+                                    format, None)[1]
+        func(backends, events)
     else:
         func = tracetool.try_import("tracetool.backend." + backend,
                                     format, None)[1]

This extra case exists because "ust" isn't converted yet?

backend/__init__.py should not know about all backends (it's a pain to hardcode the backend names and keep them up-to-date). I hope this change can be dropped in the next revision of the patch since the "ust" backend will no longer be different.

Quoted 7 lines
scripts/tracetool/backend/__init__.py +7 -0
+def c(backends, events):
+    func_head_lst = []
+    func_body_lst = []
+    for backend in backends:
+        func_head_lst.append(tracetool.try_import("tracetool.backend." + backend,
+                                                  "c_head", None)[1])
+        func_body_lst.append(tracetool.try_import("tracetool.backend." + backend,

scripts/tracetool/backend/__init__.py def compatible(backend, format):

Quoted 10 lines
scripts/tracetool/backend/__init__.py +10 -0
+                                                  "c_body", None)[1])
+
+    out('#include "trace/control.h"',
+        '#ifndef CONFIG_TRACE_DTRACE',
+        '#include "trace.h"',
+        '#endif'
+        '',
+        )
+    for func_head in func_head_lst:
+        func_head()

Can the CONFIG_TRACE_DTRACE include be emitted by dtrace.c_head()? Then we don't need to hardcode it into this generic file (it shouldn't know about specific backends).

Perhaps you could even make a c_include() interface, if necessary.

Quoted 2 lines

def h(events):
+ pass

I thought all code generation now happens in backends.common.h(), so this function will not be called anymore?

The same is true for c() defined in this file.

scripts/tracetool/backend/__init__.py

Quoted 12 lines

def d(events):

scripts/tracetool/backend/__init__.py +7 -2
+    d_head()
     out('provider qemu {')
-
     for e in events:
-        args = str(e.args)
+        d_body(e)
+    out('',
+    '};')
+
+def d_head():
+    pass

This function seems unnecessary. Can you drop it?

Quoted 20 lines
scripts/tracetool/backend/__init__.py +1 -14
@@ -86,24 +99,30 @@ RESERVED_WORDS = (
     )
 
 def stap(events):
+    stap_head()
     for e in events:
-        # Define prototype for probe arguments
-        out('probe %(probeprefix)s.%(name)s = process("%(binary)s").mark("%(name)s")',
-            '{',
-            probeprefix = _probeprefix(),
-            name = e.name,
-            binary = _binary(),
-            )
-
-        i = 1
-        if len(e.args) > 0:
-            for name in e.args.names():
-                # Append underscore to reserved keywords
-                if name in RESERVED_WORDS:
-                    name += '_'

scripts/tracetool/backend/__init__.py RESERVED_WORDS = ( · line 108

Quoted 10 lines
scripts/tracetool/backend/__init__.py +4 -5
-                out('  %s = $arg%d;' % (name, i))
-                i += 1
-
-        out('}')
-
+        stap_body(e)
     out()
+
+def stap_head():
+    pass

Same here, I think it can be dropped.

scripts/tracetool/backend/__init__.py RESERVED_WORDS = (

Quoted 9 lines
scripts/tracetool/backend/__init__.py +2 -3
 ######################################################################
 # Backend code
 
 util-obj-$(CONFIG_TRACE_DEFAULT) += default.o
-util-obj-$(CONFIG_TRACE_SIMPLE) += simple.o
-util-obj-$(CONFIG_TRACE_STDERR) += stderr.o
-util-obj-$(CONFIG_TRACE_FTRACE) += ftrace.o
+util-obj-$(CONFIG_TRACE_SIMPLE) += multi.o simple.o
+util-obj-$(CONFIG_TRACE_STDERR) += multi.o

What happened to stderr.o?

Quoted 1 line

+util-obj-$(CONFIG_TRACE_FTRACE) += multi.o ftrace.o

How about adding multi.o to util-obj-y just like control.o below? All these object files are added to libqemuutil.a. The linker will only pull in object files that are needed (based on symbol dependencies) so there is no harm in uncoditionally building multi.o.

(In fact, I think it's better to always build it to avoid bitrot.)

Quoted 31 lines
trace/multi.c new file +25 -0
new file mode 100644
index 0000000..ab2b79f
@@ -0,0 +1,52 @@
+/*
+ * Multi trace backend
+ */
+
+#include <stdio.h>
+#include "trace.h"
+#include "trace/control.h"
+
+void trace_print_events(FILE *stream, fprintf_function stream_printf)
+{
+    TraceEventID i;
+
+    for (i = 0; i < trace_event_count(); i++) {
+        TraceEvent *ev = trace_event_id(i);
+        stream_printf(stream, "%s [Event ID %u] : state %u\n",
+                      trace_event_get_name(ev), i, trace_event_get_state_dynamic(ev));
+    }
+}
+
+void trace_event_set_state_dynamic_backend(TraceEvent *ev, bool state)
+{
+    ev->dstate = state;
+}
+
+bool trace_backend_init(const char *events, const char *file)

trace/multi.c line 35

Quoted 10 lines
trace/multi.c new file +10 -0
+{
+    bool retval = true;
+
+#ifndef CONFIG_TRACE_SIMPLE
+    if (file) {
+        fprintf(stderr, "error: -trace file=...: "
+                "option not supported by the selected tracing backend\n");
+        return false;
+    }
+#endif

Not sure if this is right. We may need to use -trace file=... for simple or ftrace. stderr should just ignore it.

trace/multi.c line 48

Quoted 13 lines
trace/multi.c new file +13 -0
+
+#ifdef CONFIG_TRACE_SIMPLE
+    retval &= simpletrace_backend_init(events, file);
+#endif
+
+#ifdef CONFIG_TRACE_FTRACE
+    retval &= ftrace_backend_init(events, file);
+#endif
+
+    if (!retval){
+        fprintf(stderr, "failed to initialize tracing backend.\n");
+	return false;
+    }

Instead of retval &= it would be helpful to check the return value after each *_init() call and print a more detailed error message:

#ifdef CONFIG_TRACE_SIMPLE
    if (!simpletrace_backend_init(events, file)) {
        fprintf(stderr, "failed to initialize simple tracing backend.\n");
	return false;
    }

#endif

That way the user has a better chance of figuring out what is wrong (although the error message still isn't very detailed :)).

#5 lore raw
Quoted 2 lines · Kazuya Saito

Okay, more feedback after looking at the rest of the patch.

Thank you for the feedback.

Quoted 2 lines

I think "ust" backend support will simplify the patch a little (see details below).

I'll try to support "ust" backend in the next revision.

Quoted 11 lines

Looking forward to the next revision. Let me know if you have any questions about my feedback.

Quoted 8 lines
scripts/tracetool/backend/__init__.py +0 -0
index f0314ee..40efcb5 100644
@@ -110,20 +110,28 @@ def compatible(backend, format):
 def _empty(events):
     pass
 
Quoted 5 lines

scripts/tracetool/backend/__init__.py def compatible(backend, format): · line 114

Quoted 3 lines
scripts/tracetool/backend/__init__.py +1 -1
-def generate(backend, format, events):
+def generate(backends, format, events):
     """Generate the per-event output for the given (backend, format) pair."""

Please update the doc comment to reflect the new argument.

I see.

Quoted 25 lines
Quoted 14 lines
scripts/tracetool/backend/__init__.py +6 -3
-    if not compatible(backend, format):
+    compat = False
+    for backend in backends:
+        compat |= compatible(backend, format)
+    if not compat:
         raise ValueError("backend '%s' not compatible with format '%s'" %
                          (backend, format))
 
-    backend = backend.replace("-", "_")
+    backends = map(lambda x: x.replace("-", "_"), backends)
     format = format.replace("-", "_")
 
-    if backend == "nop":
+    if backends == ["nop"]:

scripts/tracetool/backend/__init__.py def compatible(backend, format): · line 135

Quoted 10 lines
scripts/tracetool/backend/__init__.py +5 -0
         func = tracetool.try_import("tracetool.format." + format,
                                     "nop", _empty)[1]
+        func(events)
+    elif set(backends).issubset(["dtrace", "ftrace", "simple", "stderr"]):
+        func = tracetool.try_import("tracetool.backend.common",
+                                    format, None)[1]
+        func(backends, events)
     else:
         func = tracetool.try_import("tracetool.backend." + backend,
                                     format, None)[1]
Quoted 1 line

This extra case exists because "ust" isn't converted yet?

Yes, you're right.

Quoted 2 lines

backend/__init__.py should not know about all backends (it's a pain to hardcode the backend names and keep them up-to-date).

I agree with you.

Quoted 3 lines

I hope this
change can be dropped in the next revision of the patch since the "ust" backend will no longer be different.

OK. I'll try it.
However, the above should be changed because of "events" backend even if it supports "ust" backend. I think there is two solutions for this. The first is to define common.events_h() and common.events_c(). The other is to branch it for "events" backend as below.

    if backends == ["nop"]:
        func = tracetool.try_import("tracetool.format." + format,
                                    "nop", _empty)[1]
        func(events)
    elif backends == ["events"]:
        func = tracetool.try_import("tracetool.backend.events",
                                    format, None)[1]
        func(events)
    else:
        func = tracetool.try_import("tracetool.backend.common",
                                    format, None)[1]
        func(backends, events)

I think the first is better because backend/__init__.py shouldn't care "events" backend. Do you have any suggestions?

Quoted 13 lines
Quoted 13 lines
scripts/tracetool/backend/__init__.py +13 -0
+def c(backends, events):
+    func_head_lst = []
+    func_body_lst = []
+    for backend in backends:
+        func_head_lst.append(tracetool.try_import("tracetool.backend." + backEnd,
+                                                  "c_head", None)[1])
+        func_body_lst.append(tracetool.try_import("tracetool.backend." + backend,
+                                                  "c_body", None)[1])
+
+    out('#include "trace/control.h"',
+        '#ifndef CONFIG_TRACE_DTRACE',
+        '#include "trace.h"',
+        '#endif'
Quoted 8 lines

scripts/tracetool/backend/__init__.py

Quoted 4 lines
scripts/tracetool/backend/__init__.py +4 -0
+        '',
+        )
+    for func_head in func_head_lst:
+        func_head()

Can the CONFIG_TRACE_DTRACE include be emitted by dtrace.c_head()? Then we don't need to hardcode it into this generic file (it shouldn't know about specific backends).

You're right. I'll fix it.

Quoted 7 lines

Perhaps you could even make a c_include() interface, if necessary.

Quoted 2 lines

def h(events):
+ pass

I thought all code generation now happens in backends.common.h(), so this function will not be called anymore?

It is called in tracetool.backend.compatible(). So, it is required when selecting only dtrace backend.

Quoted 1 line

The same is true for c() defined in this file.

It is also required for the same reason as dtrace.h().

Quoted 6 lines
Quoted 6 lines

def d(events):

scripts/tracetool/backend/__init__.py +1 -2
+    d_head()
     out('provider qemu {')
-
     for e in events:
-        args = str(e.args)
Quoted 8 lines

scripts/tracetool/backend/__init__.py

Quoted 6 lines
scripts/tracetool/backend/__init__.py +6 -0
+        d_body(e)
+    out('',
+    '};')
+
+def d_head():
+    pass

This function seems unnecessary. Can you drop it?

OK. Although I thought that it would be useful for something by splitting this function in the same way as other functions, it is only used in dtrace backend. So, I'm going to revert it back.

Quoted 24 lines
Quoted 24 lines
scripts/tracetool/backend/__init__.py +1 -18
@@ -86,24 +99,30 @@ RESERVED_WORDS = (
     )
 
 def stap(events):
+    stap_head()
     for e in events:
-        # Define prototype for probe arguments
-        out('probe %(probeprefix)s.%(name)s = process("%(binary)s").mark("%(name)s")',
-            '{',
-            probeprefix = _probeprefix(),
-            name = e.name,
-            binary = _binary(),
-            )
-
-        i = 1
-        if len(e.args) > 0:
-            for name in e.args.names():
-                # Append underscore to reserved keywords
-                if name in RESERVED_WORDS:
-                    name += '_'
-                out('  %s = $arg%d;' % (name, i))
-                i += 1
-
-        out('}')
Quoted 8 lines

scripts/tracetool/backend/__init__.py RESERVED_WORDS = ( · line 108

Quoted 6 lines
scripts/tracetool/backend/__init__.py +4 -1
-
+        stap_body(e)
     out()
+
+def stap_head():
+    pass

Same here, I think it can be dropped.

OK, I'm going to revert it back as well as dtrace.d().

Quoted 11 lines

scripts/tracetool/backend/__init__.py RESERVED_WORDS = (

Quoted 9 lines
scripts/tracetool/backend/__init__.py +2 -3
 ######################################################################
 # Backend code
 
 util-obj-$(CONFIG_TRACE_DEFAULT) += default.o
-util-obj-$(CONFIG_TRACE_SIMPLE) += simple.o
-util-obj-$(CONFIG_TRACE_STDERR) += stderr.o
-util-obj-$(CONFIG_TRACE_FTRACE) += ftrace.o
+util-obj-$(CONFIG_TRACE_SIMPLE) += multi.o simple.o
+util-obj-$(CONFIG_TRACE_STDERR) += multi.o

What happened to stderr.o?

The all functions defined in stderr.o was moved into multi.o because there was no function which was only executed when selecting stderr backend. So, stderr.o was eliminated.

Quoted 6 lines
Quoted 1 line

+util-obj-$(CONFIG_TRACE_FTRACE) += multi.o ftrace.o

How about adding multi.o to util-obj-y just like control.o below? All these object files are added to libqemuutil.a. The linker will only pull in object files that are needed (based on symbol dependencies) so there is no harm in uncoditionally building multi.o.

If adding multi.o to util-obj-y, compile error occurs when selecting only dtrace backend. This is because the function trace_print_events(), trace_event_set_state_dynamic_backend() and trace_backend_init() are declared doubly in multi.o and default.o.
So, I'm going to leave it. Do you have any suggestions?

Quoted 38 lines

(In fact, I think it's better to always build it to avoid bitrot.)

Quoted 36 lines
trace/multi.c new file +30 -0
new file mode 100644
index 0000000..ab2b79f
@@ -0,0 +1,52 @@
+/*
+ * Multi trace backend
+ */
+
+#include <stdio.h>
+#include "trace.h"
+#include "trace/control.h"
+
+void trace_print_events(FILE *stream, fprintf_function stream_printf)
+{
+    TraceEventID i;
+
+    for (i = 0; i < trace_event_count(); i++) {
+        TraceEvent *ev = trace_event_id(i);
+        stream_printf(stream, "%s [Event ID %u] : state %u\n",
+                      trace_event_get_name(ev), i, trace_event_get_state_dynamic(ev));
+    }
+}
+
+void trace_event_set_state_dynamic_backend(TraceEvent *ev, bool state)
+{
+    ev->dstate = state;
+}
+
+bool trace_backend_init(const char *events, const char *file)
+{
+    bool retval = true;
+
+#ifndef CONFIG_TRACE_SIMPLE
+    if (file) {
Quoted 8 lines

trace/multi.c line 35

Quoted 5 lines
trace/multi.c new file +5 -0
+        fprintf(stderr, "error: -trace file=...: "
+                "option not supported by the selected tracing backend\n");
+        return false;
+    }
+#endif

Not sure if this is right. We may need to use -trace file=... for simple or ftrace. stderr should just ignore it.

The error message is output if the argument "file" is set when using "stderr", "ftrace" or "dtrace" backend. In other words, only "simple" backend uses -trace file=...
This is the reason why I implemented it as seen above.

Quoted 22 lines

trace/multi.c line 48

Quoted 13 lines
trace/multi.c new file +13 -0
+
+#ifdef CONFIG_TRACE_SIMPLE
+    retval &= simpletrace_backend_init(events, file);
+#endif
+
+#ifdef CONFIG_TRACE_FTRACE
+    retval &= ftrace_backend_init(events, file);
+#endif
+
+    if (!retval){
+        fprintf(stderr, "failed to initialize tracing backend.\n");
+	return false;
+    }

Instead of retval &= it would be helpful to check the return value after each *_init() call and print a more detailed error message:

#ifdef CONFIG_TRACE_SIMPLE
    if (!simpletrace_backend_init(events, file)) {
        fprintf(stderr, "failed to initialize simple tracing backend.\n");
	return false;
    }
Quoted 4 lines

#endif

That way the user has a better chance of figuring out what is wrong (although the error message still isn't very detailed :)).

I see. That is better for the user.
I'll fix it as you said.

Thank you very much for your valuable advice. I'll post the next revision as soon as possible.

Thanks,
Kazuya Saito

#6 lore raw
Quoted 24 lines · Kazuya Saito
Quoted 3 lines · Kazuya Saito

I hope this
change can be dropped in the next revision of the patch since the "ust" backend will no longer be different.

OK. I'll try it.
However, the above should be changed because of "events" backend even if it supports "ust" backend. I think there is two solutions for this. The first is to define common.events_h() and common.events_c(). The other is to branch it for "events" backend as below.

    if backends == ["nop"]:
        func = tracetool.try_import("tracetool.format." + format,
                                    "nop", _empty)[1]
        func(events)
    elif backends == ["events"]:
        func = tracetool.try_import("tracetool.backend.events",
                                    format, None)[1]
        func(events)
    else:
        func = tracetool.try_import("tracetool.backend.common",
                                    format, None)[1]
        func(backends, events)
Quoted 2 lines

I think the first is better because backend/__init__.py shouldn't care "events" backend. Do you have any suggestions?

Yes, I prefer less special cases too.

Quoted 6 lines
Quoted 5 lines
Quoted 2 lines

def h(events):
+ pass

I thought all code generation now happens in backends.common.h(), so this function will not be called anymore?

Quoted 6 lines

It is called in tracetool.backend.compatible(). So, it is required when selecting only dtrace backend.

Quoted 1 line

The same is true for c() defined in this file.

It is also required for the same reason as dtrace.h().

tracetool.backend.compatible() is testing for the existence of a function that is not used anywhere else. Backend code doesn't make it obvious why this is necessary.

We should either make compatible() work (e.g. by testing body_<format> and ensuring all formats use the "body_" function prefix) or with something explicit like a <backend>.supported_formats = ['c', 'h'] list.

Quoted 7 lines
Quoted 6 lines
Quoted 1 line

+util-obj-$(CONFIG_TRACE_FTRACE) += multi.o ftrace.o

How about adding multi.o to util-obj-y just like control.o below? All these object files are added to libqemuutil.a. The linker will only pull in object files that are needed (based on symbol dependencies) so there is no harm in uncoditionally building multi.o.

Quoted 5 lines

If adding multi.o to util-obj-y, compile error occurs when selecting only dtrace backend. This is because the function trace_print_events(), trace_event_set_state_dynamic_backend() and trace_backend_init() are declared doubly in multi.o and default.o.
So, I'm going to leave it. Do you have any suggestions?

I guess it should be:

ifeq ($(CONFIG_TRACE_DEFAULT),y)
util-obj-y += default.o
else
util-obj-y += multi.o
endif

Quoted 15 lines
Quoted 6 lines
Quoted 6 lines
trace/multi.c new file +6 -0
+bool trace_backend_init(const char *events, const char *file)
+{
+    bool retval = true;
+
+#ifndef CONFIG_TRACE_SIMPLE
+    if (file) {
Quoted 8 lines

trace/multi.c line 35

Quoted 5 lines
trace/multi.c new file +5 -0
+        fprintf(stderr, "error: -trace file=...: "
+                "option not supported by the selected tracing backend\n");
+        return false;
+    }
+#endif

Not sure if this is right. We may need to use -trace file=... for simple or ftrace. stderr should just ignore it.

Quoted 4 lines

The error message is output if the argument "file" is set when using "stderr", "ftrace" or "dtrace" backend. In other words, only "simple" backend uses -trace file=...
This is the reason why I implemented it as seen above.

oops, I misread the code. I thought #ifdef instead of #ifndef.

#7 lore raw
Quoted 12 lines · Kazuya Saito
Quoted 12 lines
Quoted 12 lines
Quoted 5 lines · Kazuya Saito
Quoted 5 lines
Quoted 2 lines
Quoted 2 lines

def h(events):
+ pass

I thought all code generation now happens in backends.common.h(), so this function will not be called anymore?

It is called in tracetool.backend.compatible(). So, it is required when selecting only dtrace backend.

Quoted 1 line
Quoted 1 line

The same is true for c() defined in this file.

Quoted 8 lines
Quoted 1 line
Quoted 1 line

It is also required for the same reason as dtrace.h().

tracetool.backend.compatible() is testing for the existence of a function that is not used anywhere else. Backend code doesn't make it obvious why this is necessary.

We should either make compatible() work (e.g. by testing body_<format> and ensuring all formats use the "body_" function prefix) or with something explicit like a <backend>.supported_formats = ['c', 'h'] list.

I think that checking <bakcend>.supported_formats is better. I'll change compatible() like that.

Quoted 12 lines
Quoted 7 lines
Quoted 7 lines
Quoted 6 lines
Quoted 6 lines
Quoted 1 line
Quoted 1 line

+util-obj-$(CONFIG_TRACE_FTRACE) += multi.o ftrace.o

How about adding multi.o to util-obj-y just like control.o below? All these object files are added to libqemuutil.a. The linker will only pull in object files that are needed (based on symbol dependencies) so there is no harm in uncoditionally building multi.o.

Quoted 5 lines
Quoted 5 lines

If adding multi.o to util-obj-y, compile error occurs when selecting only dtrace backend. This is because the function trace_print_events(), trace_event_set_state_dynamic_backend() and trace_backend_init() are declared doubly in multi.o and default.o.
So, I'm going to leave it. Do you have any suggestions?

Quoted 7 lines

I guess it should be:

ifeq ($(CONFIG_TRACE_DEFAULT),y)
util-obj-y += default.o
else
util-obj-y += multi.o
endif

Thank you. I'll fix it as above.

Thanks,
Kazuya Saito