[Qemu-devel] [PATCH 06/12] trace: [tcg] Declare TCG tracing helper routines

[Lluís Vilanova]

Generate header "trace/generated-helpers.h" with the necessary TCG helper
declarations for tracing events in guest code:

* gen_helper_trace_${event}_tcg

  Routine to transform mixed native and TCG argument types to TCG types and call
  TCG helper 'gen_helper_trace_${event}_tcg_proxy'.

* helper_trace_${event}_tcg_proxy

  TCG helper to cast TCG-compatible argument types to native types and call
  tracing routine 'trace_${event}'.

NOTE: 'gen_gelper_trace_${event}_tcg_proxy' is generated by the TCG helper
      machinery.


Signed-off-by: Lluís Vilanova <address@hidden>
---
 .gitignore                               |    1 
 Makefile                                 |    2 +
 include/exec/def-helper.h                |    9 +++
 scripts/tracetool/__init__.py            |    1 
 scripts/tracetool/backend/tcg.py         |   85 ++++++++++++++++++++++++++++++
 scripts/tracetool/format/tcg_helper_h.py |   38 +++++++++++++
 trace/Makefile.objs                      |   24 +++++++-
 7 files changed, 155 insertions(+), 5 deletions(-)
 create mode 100644 scripts/tracetool/backend/tcg.py
 create mode 100644 scripts/tracetool/format/tcg_helper_h.py

diff --git a/.gitignore b/.gitignore
index 1c9d63d..8e61ca1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -10,6 +10,7 @@ trace/generated-tracers-dtrace.h
 trace/generated-tracers.dtrace
 trace/generated-events.h
 trace/generated-events.c
+trace/generated-helpers.h
 libcacard/trace/generated-tracers.c
 *-timestamp
 *-softmmu
diff --git a/Makefile b/Makefile
index a9b6e39..d1ec29b 100644
--- a/Makefile
+++ b/Makefile
@@ -57,6 +57,8 @@ GENERATED_HEADERS += trace/generated-tracers-dtrace.h
 endif
 GENERATED_SOURCES += trace/generated-tracers.c
 
+GENERATED_HEADERS += trace/generated-helpers.h
+
 # Don't try to regenerate Makefile or configure
 # We don't generate any of them
 Makefile: ;
diff --git a/include/exec/def-helper.h b/include/exec/def-helper.h
index 73d51f9..8e096d1 100644
--- a/include/exec/def-helper.h
+++ b/include/exec/def-helper.h
@@ -13,6 +13,11 @@
    helper.c, defining:
     GEN_HELPER 1 to produce op generation functions (gen_helper_*)
     GEN_HELPER 2 to do runtime registration helper functions.
+
+   After including this header the GEN_HELPER_CODE macro will have the 
following
+   values:
+    1  : op generation functions were produced (GEN_HELPER was 1)
+    -1 : otherwise
  */
 
 #ifndef DEF_HELPER_H
@@ -157,6 +162,7 @@ dh_ctype(ret) HELPER(name) (dh_ctype(t1), dh_ctype(t2), 
dh_ctype(t3), \
 
 #undef GEN_HELPER
 #define GEN_HELPER -1
+#define GEN_HELPER_CODE -1
 
 #elif GEN_HELPER == 1
 /* Gen functions.  */
@@ -236,6 +242,7 @@ static inline void glue(gen_helper_, 
name)(dh_retvar_decl(ret) \
 
 #undef GEN_HELPER
 #define GEN_HELPER -1
+#define GEN_HELPER_CODE 1
 
 #elif GEN_HELPER == 2
 /* Register helpers.  */
@@ -259,6 +266,7 @@ DEF_HELPER_FLAGS_0(name, flags, ret)
 
 #undef GEN_HELPER
 #define GEN_HELPER -1
+#define GEN_HELPER_CODE -1
 
 #elif GEN_HELPER == -1
 /* Undefine macros.  */
@@ -270,5 +278,6 @@ DEF_HELPER_FLAGS_0(name, flags, ret)
 #undef DEF_HELPER_FLAGS_4
 #undef DEF_HELPER_FLAGS_5
 #undef GEN_HELPER
+#undef GEN_HELPER_CODE
 
 #endif
diff --git a/scripts/tracetool/__init__.py b/scripts/tracetool/__init__.py
index aab6d31..aefdce1 100644
--- a/scripts/tracetool/__init__.py
+++ b/scripts/tracetool/__init__.py
@@ -195,6 +195,7 @@ class Event(object):
                                           self.fmt)
 
     QEMU_TRACE              = "trace_%(name)s"
+    QEMU_TRACE_TCG          = "trace_%(name)s_tcg"
 
     def api(self, fmt=None):
         if fmt is None:
diff --git a/scripts/tracetool/backend/tcg.py b/scripts/tracetool/backend/tcg.py
new file mode 100644
index 0000000..04aa2b8
--- /dev/null
+++ b/scripts/tracetool/backend/tcg.py
@@ -0,0 +1,85 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+Default TCG instrumentation helpers.
+"""
+
+__author__     = "Lluís Vilanova <address@hidden>"
+__copyright__  = "Copyright 2012-2014, Lluís Vilanova <address@hidden>"
+__license__    = "GPL version 2 or (at your option) any later version"
+
+__maintainer__ = "Stefan Hajnoczi"
+__email__      = "address@hidden"
+
+
+from tracetool import out
+from tracetool.transform import *
+
+
+def tcg_helper_h(events):
+    out('#define tcg_temp_new_nop(v) (v)',
+        '#define tcg_temp_free_nop(v)',
+        '',
+        )
+
+    for e in events:
+        if "tcg" not in e.properties:
+            continue
+
+        # tracetool.generate always transformes types to host
+        e = e.original
+
+        # TCG helper proxy declaration
+        fmt = "DEF_HELPER_FLAGS_%(argc)d(%(name)s, %(flags)svoid%(types)s)"
+        args = e.args.transform(HOST_2_TCG_COMPAT, HOST_2_TCG,
+                                TCG_2_TCG_HELPER_DECL)
+        types = ", ".join(args.types())
+        if types != "":
+            types = ", " + types
+
+        flags = "TCG_CALL_NO_RWG, "
+
+        out(fmt,
+            flags=flags,
+            argc=len(args),
+            name=e.api(e.QEMU_TRACE_TCG) + "_proxy",
+            types=types,
+            )
+
+        # mixed-type to TCG helper bridge
+        args_tcg_compat = e.args.transform(HOST_2_TCG_COMPAT)
+
+        code_new = [
+            "%(tcg_type)s __%(name)s = %(tcg_func)s(%(name)s);" %
+            {"tcg_type": transform_type(type_, HOST_2_TCG),
+             "tcg_func": transform_type(type_, HOST_2_TCG_TMP_NEW),
+             "name": name}
+            for (type_, name) in args_tcg_compat
+        ]
+
+        code_free = [
+            "%(tcg_func)s(__%(name)s);" %
+            {"tcg_func": transform_type(type_, HOST_2_TCG_TMP_FREE),
+             "name": name}
+            for (type_, name) in args_tcg_compat
+        ]
+
+        gen_name = "gen_helper_" + e.api(e.QEMU_TRACE_TCG)
+
+        out(
+            '#if GEN_HELPER_CODE == 1',
+            'static inline void %(name)s(%(args)s)',
+            '{',
+            '    %(code_new)s',
+            '    %(proxy_name)s(%(tmp_names)s);',
+            '    %(code_free)s',
+            '}',
+            '#endif',
+            name=gen_name,
+            args=e.args,
+            proxy_name=gen_name + "_proxy",
+            code_new="\n    ".join(code_new),
+            code_free="\n    ".join(code_free),
+            tmp_names=", ".join(["__%s" % name for _, name in e.args]),
+            )
diff --git a/scripts/tracetool/format/tcg_helper_h.py 
b/scripts/tracetool/format/tcg_helper_h.py
new file mode 100644
index 0000000..821df71
--- /dev/null
+++ b/scripts/tracetool/format/tcg_helper_h.py
@@ -0,0 +1,38 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+Generate trace/generated-helpers.h.
+"""
+
+__author__     = "Lluís Vilanova <address@hidden>"
+__copyright__  = "Copyright 2012-2014, Lluís Vilanova <address@hidden>"
+__license__    = "GPL version 2 or (at your option) any later version"
+
+__maintainer__ = "Stefan Hajnoczi"
+__email__      = "address@hidden"
+
+
+from tracetool import out
+
+
+def begin(events):
+    out('/* This file is autogenerated by tracetool, do not edit. */',
+        '/* You must include this file in your helper.h */',
+        '',
+        )
+
+
+def nop(events):
+    for e in events:
+        if "tcg" not in e.properties:
+            continue
+
+        out('#if GEN_HELPER_CODE == 1',
+            'static inline void %(name)s(%(args)s)',
+            '{',
+            '}',
+            '#endif',
+            name="gen_helper_" + e.api(e.QEMU_TRACE_TCG),
+            args=e.args,
+            )
diff --git a/trace/Makefile.objs b/trace/Makefile.objs
index 3b88e49..c2a0ac0 100644
--- a/trace/Makefile.objs
+++ b/trace/Makefile.objs
@@ -25,6 +25,9 @@ util-obj-y += generated-events.o
 ######################################################################
 # Auto-generated tracing routines
 
+##################################################
+# Execution level
+
 $(obj)/generated-tracers.h: $(obj)/generated-tracers.h-timestamp
        @cmp -s $< $@ || cp $< $@
 $(obj)/generated-tracers.h-timestamp: $(SRC_PATH)/trace-events 
$(BUILD_DIR)/config-host.mak
@@ -33,8 +36,8 @@ $(obj)/generated-tracers.h-timestamp: 
$(SRC_PATH)/trace-events $(BUILD_DIR)/conf
                --backend=$(TRACE_BACKEND) \
                < $< > $@,"  GEN   $(patsubst %-timestamp,%,$@)")
 
-######################################################################
-# Auto-generated tracing routines (non-DTrace)
+##############################
+# non-DTrace
 
 ifneq ($(TRACE_BACKEND),dtrace)
 $(obj)/generated-tracers.c: $(obj)/generated-tracers.c-timestamp
@@ -48,9 +51,8 @@ $(obj)/generated-tracers.c-timestamp: 
$(SRC_PATH)/trace-events $(BUILD_DIR)/conf
 $(obj)/generated-tracers.o: $(obj)/generated-tracers.c 
$(obj)/generated-tracers.h
 endif
 
-
-######################################################################
-# Auto-generated DTrace code
+##############################
+# DTrace
 
 # 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
@@ -70,6 +72,18 @@ $(obj)/generated-tracers-dtrace.h: 
$(obj)/generated-tracers.dtrace
 $(obj)/generated-tracers.o: $(obj)/generated-tracers.dtrace
 endif
 
+##################################################
+# Translation level
+
+$(obj)/generated-helpers.h: $(obj)/generated-helpers.h-timestamp
+$(obj)/generated-helpers.h-timestamp: $(SRC_PATH)/trace-events 
$(BUILD_DIR)/config-host.mak
+       $(call quiet-command,$(TRACETOOL) \
+               --format=tcg-helper-h \
+               --backend=tcg \
+               < $< > $@,"  GEN   $(patsubst %-timestamp,%,$@)")
+       @cmp -s $@ $(patsubst %-timestamp,%,$@) || cp $@ $(patsubst 
%-timestamp,%,$@)
+
+
 ######################################################################
 # Backend code