* [Qemu-devel] [PATCH v8 0/7] trace: Generic event state description
@ 2012-12-24 18:31 Lluís Vilanova
2012-12-24 18:31 ` [Qemu-devel] [PATCH v8 1/7] trace: [tracetool] Explicitly identify public backends Lluís Vilanova
` (6 more replies)
0 siblings, 7 replies; 8+ messages in thread
From: Lluís Vilanova @ 2012-12-24 18:31 UTC (permalink / raw)
To: qemu-devel; +Cc: Blue Swirl, Stefan Hajnoczi
Provides a generic event state description structure (TraceEvent) and a more
detailed event control and query interface.
This is achieved by creating a new "non-public" tracing backend (i.e., not
selectable by the user at configure time) that will generate the appropriate
event description information.
Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
---
Changes in v8:
* Rebase on a2685bc from master.
* Fixed typo in commit message for "trace: Provide a detailed event control
interface".
Changes in v7:
* Rebase on a8a826a from master.
* Moved compilation & code generation for "trace/" into a separate makefile.
* Renamed targets and moved rules according to the new makefile structure.
Changes in v6:
* Fixed typos in the documentation of the 'TraceEvent' struct.
Changes in v5:
* Rebase on dbaf26b3 from master.
* Always initialize temporary 'ev' in 'trace_backend_init_events'.
* Make common sanity checks in 'trace_event_set_state_dynamic' and delay
backend-specific code to 'trace_event_set_state_dynamic_backend'.
Changes in v4:
* Documentation fixes and (re)formatting.
Changes in v3:
* Add some assertions.
* Remove debugging printf's.
* Improve documentation.
* Make 'trace_event_get_state_static' use run-time information, and leave
TRACE_*_ENABLED for compile-time checks.
Changes in v2:
* Minor compilation fixes.
Lluís Vilanova (7):
trace: [tracetool] Explicitly identify public backends
trace: Provide a generic tracing event descriptor
trace: Provide a detailed event control interface
trace: [monitor] Use new event control interface
trace: [default] Port to generic event information and new control interface
trace: [simple] Port to generic event information and new control interface
trace: [stderr] Port to generic event information and new control interface
Makefile | 3 +
docs/tracing.txt | 44 +++-----
monitor.c | 15 ++-
scripts/tracetool.py | 4 -
scripts/tracetool/backend/__init__.py | 16 +++
scripts/tracetool/backend/dtrace.py | 3 +
scripts/tracetool/backend/events.py | 23 ++++
scripts/tracetool/backend/simple.py | 22 ++--
scripts/tracetool/backend/stderr.py | 28 ++---
scripts/tracetool/backend/ust.py | 3 +
scripts/tracetool/format/events_c.py | 39 +++++++
scripts/tracetool/format/events_h.py | 50 +++++++++
scripts/tracetool/format/h.py | 9 --
trace/Makefile.objs | 22 ++++
trace/control-internal.h | 60 +++++++++++
trace/control.c | 99 +++++++++++++++---
trace/control.h | 185 ++++++++++++++++++++++++++++++---
trace/default.c | 6 +
trace/event-internal.h | 33 ++++++
trace/simple.c | 33 +-----
trace/simple.h | 6 -
trace/stderr.c | 35 +-----
trace/stderr.h | 11 --
23 files changed, 572 insertions(+), 177 deletions(-)
create mode 100644 scripts/tracetool/backend/events.py
create mode 100644 scripts/tracetool/format/events_c.py
create mode 100644 scripts/tracetool/format/events_h.py
create mode 100644 trace/control-internal.h
create mode 100644 trace/event-internal.h
delete mode 100644 trace/stderr.h
To: qemu-devel@nongnu.org
Cc: Stefan Hajnoczi <stefanha@gmail.com>
Cc: Blue Swirl <blauwirbel@gmail.com>
^ permalink raw reply [flat|nested] 8+ messages in thread
* [Qemu-devel] [PATCH v8 1/7] trace: [tracetool] Explicitly identify public backends
2012-12-24 18:31 [Qemu-devel] [PATCH v8 0/7] trace: Generic event state description Lluís Vilanova
@ 2012-12-24 18:31 ` Lluís Vilanova
2012-12-24 18:31 ` [Qemu-devel] [PATCH v8 2/7] trace: Provide a generic tracing event descriptor Lluís Vilanova
` (5 subsequent siblings)
6 siblings, 0 replies; 8+ messages in thread
From: Lluís Vilanova @ 2012-12-24 18:31 UTC (permalink / raw)
To: qemu-devel; +Cc: Blue Swirl, Stefan Hajnoczi
Public backends are those printed by "--list-backends" and thus considered valid
by the configure script.
Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
---
scripts/tracetool.py | 4 ++--
scripts/tracetool/backend/__init__.py | 16 +++++++++++++++-
scripts/tracetool/backend/dtrace.py | 3 +++
scripts/tracetool/backend/simple.py | 4 ++++
scripts/tracetool/backend/stderr.py | 3 +++
scripts/tracetool/backend/ust.py | 3 +++
6 files changed, 30 insertions(+), 3 deletions(-)
diff --git a/scripts/tracetool.py b/scripts/tracetool.py
index c003cf6..a79ec0f 100755
--- a/scripts/tracetool.py
+++ b/scripts/tracetool.py
@@ -90,8 +90,8 @@ def main(args):
arg_format = arg
elif opt == "--list-backends":
- backends = tracetool.backend.get_list()
- out(", ".join([ b for b,_ in backends ]))
+ public_backends = tracetool.backend.get_list(only_public = True)
+ out(", ".join([ b for b,_ in public_backends ]))
sys.exit(0)
elif opt == "--check-backend":
check_backend = True
diff --git a/scripts/tracetool/backend/__init__.py b/scripts/tracetool/backend/__init__.py
index be43472..f0314ee 100644
--- a/scripts/tracetool/backend/__init__.py
+++ b/scripts/tracetool/backend/__init__.py
@@ -17,6 +17,16 @@ considered its short description.
All backends must generate their contents through the 'tracetool.out' routine.
+Backend attributes
+------------------
+
+========= ====================================================================
+Attribute Description
+========= ====================================================================
+PUBLIC If exists and is set to 'True', the backend is considered "public".
+========= ====================================================================
+
+
Backend functions
-----------------
@@ -42,7 +52,7 @@ import os
import tracetool
-def get_list():
+def get_list(only_public = False):
"""Get a list of (name, description) pairs."""
res = [("nop", "Tracing disabled.")]
modnames = []
@@ -57,6 +67,10 @@ def get_list():
continue
module = module[1]
+ public = getattr(module, "PUBLIC", False)
+ if only_public and not public:
+ continue
+
doc = module.__doc__
if doc is None:
doc = ""
diff --git a/scripts/tracetool/backend/dtrace.py b/scripts/tracetool/backend/dtrace.py
index ad5eb3b..e31bc79 100644
--- a/scripts/tracetool/backend/dtrace.py
+++ b/scripts/tracetool/backend/dtrace.py
@@ -16,6 +16,9 @@ __email__ = "stefanha@linux.vnet.ibm.com"
from tracetool import out
+PUBLIC = True
+
+
PROBEPREFIX = None
def _probeprefix():
diff --git a/scripts/tracetool/backend/simple.py b/scripts/tracetool/backend/simple.py
index e4b4a7f..ac864f3 100644
--- a/scripts/tracetool/backend/simple.py
+++ b/scripts/tracetool/backend/simple.py
@@ -15,6 +15,10 @@ __email__ = "stefanha@linux.vnet.ibm.com"
from tracetool import out
+
+PUBLIC = True
+
+
def is_string(arg):
strtype = ('const char*', 'char*', 'const char *', 'char *')
if arg.lstrip().startswith(strtype):
diff --git a/scripts/tracetool/backend/stderr.py b/scripts/tracetool/backend/stderr.py
index 917fde7..a10fbb8 100644
--- a/scripts/tracetool/backend/stderr.py
+++ b/scripts/tracetool/backend/stderr.py
@@ -16,6 +16,9 @@ __email__ = "stefanha@linux.vnet.ibm.com"
from tracetool import out
+PUBLIC = True
+
+
def c(events):
out('#include "trace.h"',
'',
diff --git a/scripts/tracetool/backend/ust.py b/scripts/tracetool/backend/ust.py
index 31a2ff0..ea36995 100644
--- a/scripts/tracetool/backend/ust.py
+++ b/scripts/tracetool/backend/ust.py
@@ -16,6 +16,9 @@ __email__ = "stefanha@linux.vnet.ibm.com"
from tracetool import out
+PUBLIC = True
+
+
def c(events):
out('#include <ust/marker.h>',
'#undef mutex_lock',
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [Qemu-devel] [PATCH v8 2/7] trace: Provide a generic tracing event descriptor
2012-12-24 18:31 [Qemu-devel] [PATCH v8 0/7] trace: Generic event state description Lluís Vilanova
2012-12-24 18:31 ` [Qemu-devel] [PATCH v8 1/7] trace: [tracetool] Explicitly identify public backends Lluís Vilanova
@ 2012-12-24 18:31 ` Lluís Vilanova
2012-12-24 18:31 ` [Qemu-devel] [PATCH v8 3/7] trace: Provide a detailed event control interface Lluís Vilanova
` (4 subsequent siblings)
6 siblings, 0 replies; 8+ messages in thread
From: Lluís Vilanova @ 2012-12-24 18:31 UTC (permalink / raw)
To: qemu-devel; +Cc: Blue Swirl, Stefan Hajnoczi
Uses tracetool to generate a backend-independent tracing event description
(struct TraceEvent).
The values for such structure are generated with the non-public "events"
backend ("events-c" frontend).
The generation of the defines to check if an event is statically enabled is also
moved to the "events" backend ("events-h" frontend).
Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
---
Makefile | 3 ++
scripts/tracetool/backend/events.py | 23 ++++++++++++++++
scripts/tracetool/format/events_c.py | 39 +++++++++++++++++++++++++++
scripts/tracetool/format/events_h.py | 50 ++++++++++++++++++++++++++++++++++
scripts/tracetool/format/h.py | 9 +-----
trace/Makefile.objs | 22 +++++++++++++++
trace/event-internal.h | 33 ++++++++++++++++++++++
7 files changed, 171 insertions(+), 8 deletions(-)
create mode 100644 scripts/tracetool/backend/events.py
create mode 100644 scripts/tracetool/format/events_c.py
create mode 100644 scripts/tracetool/format/events_h.py
create mode 100644 trace/event-internal.h
diff --git a/Makefile b/Makefile
index a7ac04b..1e3927d 100644
--- a/Makefile
+++ b/Makefile
@@ -35,6 +35,9 @@ GENERATED_HEADERS = config-host.h qemu-options.def
GENERATED_HEADERS += qmp-commands.h qapi-types.h qapi-visit.h
GENERATED_SOURCES += qmp-marshal.c qapi-types.c qapi-visit.c
+GENERATED_HEADERS += trace/generated-events.h
+GENERATED_SOURCES += trace/generated-events.c
+
GENERATED_HEADERS += trace/generated-tracers.h
ifeq ($(TRACE_BACKEND),dtrace)
GENERATED_HEADERS += trace/generated-tracers-dtrace.h
diff --git a/scripts/tracetool/backend/events.py b/scripts/tracetool/backend/events.py
new file mode 100644
index 0000000..5afce3e
--- /dev/null
+++ b/scripts/tracetool/backend/events.py
@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+Generic event description.
+
+This is a dummy backend to establish appropriate frontend/backend compatibility
+checks.
+"""
+
+__author__ = "Lluís Vilanova <vilanova@ac.upc.edu>"
+__copyright__ = "Copyright 2012, Lluís Vilanova <vilanova@ac.upc.edu>"
+__license__ = "GPL version 2 or (at your option) any later version"
+
+__maintainer__ = "Stefan Hajnoczi"
+__email__ = "stefanha@linux.vnet.ibm.com"
+
+
+def events_h(events):
+ pass
+
+def events_c(events):
+ pass
diff --git a/scripts/tracetool/format/events_c.py b/scripts/tracetool/format/events_c.py
new file mode 100644
index 0000000..d670ec8
--- /dev/null
+++ b/scripts/tracetool/format/events_c.py
@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+Generate .c for event description.
+"""
+
+__author__ = "Lluís Vilanova <vilanova@ac.upc.edu>"
+__copyright__ = "Copyright 2012, Lluís Vilanova <vilanova@ac.upc.edu>"
+__license__ = "GPL version 2 or (at your option) any later version"
+
+__maintainer__ = "Stefan Hajnoczi"
+__email__ = "stefanha@linux.vnet.ibm.com"
+
+
+from tracetool import out
+
+
+def begin(events):
+ out('/* This file is autogenerated by tracetool, do not edit. */',
+ '',
+ '#include "trace.h"',
+ '#include "trace/generated-events.h"',
+ '#include "trace/control.h"',
+ '',
+ )
+
+ out('TraceEvent trace_events[TRACE_EVENT_COUNT] = {')
+
+ for e in events:
+ out(' { .id = %(id)s, .name = \"%(name)s\", .sstate = %(sstate)s, .dstate = 0 },',
+ id = "TRACE_" + e.name.upper(),
+ name = e.name,
+ sstate = "TRACE_%s_ENABLED" % e.name.upper(),
+ )
+
+ out('};',
+ '',
+ )
diff --git a/scripts/tracetool/format/events_h.py b/scripts/tracetool/format/events_h.py
new file mode 100644
index 0000000..d30ccea
--- /dev/null
+++ b/scripts/tracetool/format/events_h.py
@@ -0,0 +1,50 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+Generate .h for event description.
+"""
+
+__author__ = "Lluís Vilanova <vilanova@ac.upc.edu>"
+__copyright__ = "Copyright 2012, Lluís Vilanova <vilanova@ac.upc.edu>"
+__license__ = "GPL version 2 or (at your option) any later version"
+
+__maintainer__ = "Stefan Hajnoczi"
+__email__ = "stefanha@linux.vnet.ibm.com"
+
+
+from tracetool import out
+
+
+def begin(events):
+ out('/* This file is autogenerated by tracetool, do not edit. */',
+ '',
+ '#ifndef TRACE__GENERATED_EVENTS_H',
+ '#define TRACE__GENERATED_EVENTS_H',
+ '',
+ '#include <stdbool.h>',
+ ''
+ )
+
+ # event identifiers
+ out('typedef enum {')
+
+ for e in events:
+ out(' TRACE_%s,' % e.name.upper())
+
+ out(' TRACE_EVENT_COUNT',
+ '} TraceEventID;',
+ )
+
+ # static state
+ for e in events:
+ if 'disable' in e.properties:
+ enabled = 0
+ else:
+ enabled = 1
+ out('#define TRACE_%s_ENABLED %d' % (e.name.upper(), enabled))
+
+ out('#include "trace/event-internal.h"',
+ '',
+ '#endif /* TRACE__GENERATED_EVENTS_H */',
+ )
diff --git a/scripts/tracetool/format/h.py b/scripts/tracetool/format/h.py
index 9a58de1..93132fc 100644
--- a/scripts/tracetool/format/h.py
+++ b/scripts/tracetool/format/h.py
@@ -25,14 +25,7 @@ def begin(events):
'#include "qemu-common.h"')
def end(events):
- for e in events:
- if "disable" in e.properties:
- enabled = 0
- else:
- enabled = 1
- out('#define TRACE_%s_ENABLED %d' % (e.name.upper(), enabled))
- out('',
- '#endif /* TRACE__GENERATED_TRACERS_H */')
+ out('#endif /* TRACE__GENERATED_TRACERS_H */')
def nop(events):
for e in events:
diff --git a/trace/Makefile.objs b/trace/Makefile.objs
index b791723..9617c02 100644
--- a/trace/Makefile.objs
+++ b/trace/Makefile.objs
@@ -1,6 +1,28 @@
# -*- mode: makefile -*-
######################################################################
+# Auto-generated event descriptions
+
+$(obj)/generated-events.h: $(obj)/generated-events.h-timestamp
+$(obj)/generated-events.h-timestamp: $(SRC_PATH)/trace-events
+ $(call quiet-command,$(TRACETOOL) \
+ --format=events-h \
+ --backend=events \
+ < $< > $@," GEN $(patsubst %-timestamp,%,$@)")
+ @cmp -s $@ $(patsubst %-timestamp,%,$@) || cp $@ $(patsubst %-timestamp,%,$@)
+
+$(obj)/generated-events.c: $(obj)/generated-events.c-timestamp
+$(obj)/generated-events.c-timestamp: $(SRC_PATH)/trace-events
+ $(call quiet-command,$(TRACETOOL) \
+ --format=events-c \
+ --backend=events \
+ < $< > $@," GEN $(patsubst %-timestamp,%,$@)")
+ @cmp -s $@ $(patsubst %-timestamp,%,$@) || cp $@ $(patsubst %-timestamp,%,$@)
+
+trace-obj-y += generated-events.o
+
+
+######################################################################
# Auto-generated tracing routines
ifeq ($(TRACE_BACKEND),dtrace)
diff --git a/trace/event-internal.h b/trace/event-internal.h
new file mode 100644
index 0000000..b2310d9
--- /dev/null
+++ b/trace/event-internal.h
@@ -0,0 +1,33 @@
+/*
+ * Interface for configuring and controlling the state of tracing events.
+ *
+ * Copyright (C) 2012 Lluís Vilanova <vilanova@ac.upc.edu>
+ *
+ * This work is licensed under the terms of the GNU GPL, version 2 or later.
+ * See the COPYING file in the top-level directory.
+ */
+
+#ifndef TRACE__EVENT_INTERNAL_H
+#define TRACE__EVENT_INTERNAL_H
+
+#include "trace/generated-events.h"
+
+
+/**
+ * TraceEvent:
+ * @id: Unique event identifier.
+ * @name: Event name.
+ * @sstate: Static tracing state.
+ * @dstate: Dynamic tracing state.
+ *
+ * Opaque generic description of a tracing event.
+ */
+typedef struct TraceEvent {
+ TraceEventID id;
+ const char * name;
+ const bool sstate;
+ bool dstate;
+} TraceEvent;
+
+
+#endif /* TRACE__EVENT_INTERNAL_H */
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [Qemu-devel] [PATCH v8 3/7] trace: Provide a detailed event control interface
2012-12-24 18:31 [Qemu-devel] [PATCH v8 0/7] trace: Generic event state description Lluís Vilanova
2012-12-24 18:31 ` [Qemu-devel] [PATCH v8 1/7] trace: [tracetool] Explicitly identify public backends Lluís Vilanova
2012-12-24 18:31 ` [Qemu-devel] [PATCH v8 2/7] trace: Provide a generic tracing event descriptor Lluís Vilanova
@ 2012-12-24 18:31 ` Lluís Vilanova
2012-12-24 18:32 ` [Qemu-devel] [PATCH v8 4/7] trace: [monitor] Use new " Lluís Vilanova
` (3 subsequent siblings)
6 siblings, 0 replies; 8+ messages in thread
From: Lluís Vilanova @ 2012-12-24 18:31 UTC (permalink / raw)
To: qemu-devel; +Cc: Blue Swirl, Stefan Hajnoczi
This interface decouples event obtaining from interaction.
Events can be obtained through three different methods:
* identifier
* name
* simple wildcard pattern
Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
---
docs/tracing.txt | 44 ++++-------
trace/control-internal.h | 60 +++++++++++++++
trace/control.c | 99 +++++++++++++++++++++----
trace/control.h | 185 +++++++++++++++++++++++++++++++++++++++++-----
4 files changed, 330 insertions(+), 58 deletions(-)
create mode 100644 trace/control-internal.h
diff --git a/docs/tracing.txt b/docs/tracing.txt
index 453cc4a..58c61af 100644
--- a/docs/tracing.txt
+++ b/docs/tracing.txt
@@ -100,49 +100,37 @@ respectively. This ensures portability between 32- and 64-bit platforms.
== Generic interface and monitor commands ==
-You can programmatically query and control the dynamic state of trace events
-through a backend-agnostic interface:
+You can programmatically query and control the state of trace events through a
+backend-agnostic interface provided by the header "trace/control.h".
-* trace_print_events
+Note that some of the backends do not provide an implementation for some parts
+of this interface, in which case QEMU will just print a warning (please refer to
+header "trace/control.h" to see which routines are backend-dependent).
-* trace_event_set_state
- Enables or disables trace events at runtime inside QEMU.
- The function returns "true" if the state of the event has been successfully
- changed, or "false" otherwise:
-
- #include "trace/control.h"
-
- trace_event_set_state("virtio_irq", true); /* enable */
- [...]
- trace_event_set_state("virtio_irq", false); /* disable */
-
-Note that some of the backends do not provide an implementation for this
-interface, in which case QEMU will just print a warning.
-
-This functionality is also provided through monitor commands:
+The state of events can also be queried and modified through monitor commands:
* info trace-events
View available trace events and their state. State 1 means enabled, state 0
means disabled.
* trace-event NAME on|off
- Enable/disable a given trace event or a group of events having common prefix
- through wildcard.
+ Enable/disable a given trace event or a group of events (using wildcards).
The "-trace events=<file>" command line argument can be used to enable the
events listed in <file> from the very beginning of the program. This file must
contain one event name per line.
-A basic wildcard matching is supported in both the monitor command "trace
--event" and the events list file. That means you can enable/disable the events
-having a common prefix in a batch. For example, virtio-blk trace events could
-be enabled using:
- trace-event virtio_blk_* on
-
If a line in the "-trace events=<file>" file begins with a '-', the trace event
will be disabled instead of enabled. This is useful when a wildcard was used
to enable an entire family of events but one noisy event needs to be disabled.
+Wildcard matching is supported in both the monitor command "trace-event" and the
+events list file. That means you can enable/disable the events having a common
+prefix in a batch. For example, virtio-blk trace events could be enabled using
+the following monitor command:
+
+ trace-event virtio_blk_* on
+
== Trace backends ==
The "tracetool" script automates tedious trace event code generation and also
@@ -263,3 +251,7 @@ guard such computations and avoid its compilation when the event is disabled:
}
return ptr;
}
+
+You can check both if the event has been disabled and is dynamically enabled at
+the same time using the 'trace_event_get_state' routine (see header
+"trace/control.h" for more information).
diff --git a/trace/control-internal.h b/trace/control-internal.h
new file mode 100644
index 0000000..bebaefa
--- /dev/null
+++ b/trace/control-internal.h
@@ -0,0 +1,60 @@
+/*
+ * Interface for configuring and controlling the state of tracing events.
+ *
+ * Copyright (C) 2011-2012 Lluís Vilanova <vilanova@ac.upc.edu>
+ *
+ * This work is licensed under the terms of the GNU GPL, version 2 or later.
+ * See the COPYING file in the top-level directory.
+ */
+
+
+extern TraceEvent trace_events[];
+
+
+static inline TraceEvent *trace_event_id(TraceEventID id)
+{
+ assert(id < trace_event_count());
+ return &trace_events[id];
+}
+
+static inline TraceEventID trace_event_count(void)
+{
+ return TRACE_EVENT_COUNT;
+}
+
+static inline bool trace_event_is_pattern(const char *str)
+{
+ assert(str != NULL);
+
+ while (*str != '\0') {
+ if (*str == '*') {
+ return true;
+ }
+ str++;
+ }
+ return false;
+}
+
+static inline TraceEventID trace_event_get_id(TraceEvent *ev)
+{
+ assert(ev != NULL);
+ return ev->id;
+}
+
+static inline const char * trace_event_get_name(TraceEvent *ev)
+{
+ assert(ev != NULL);
+ return ev->name;
+}
+
+static inline bool trace_event_get_state_static(TraceEvent *ev)
+{
+ assert(ev != NULL);
+ return ev->sstate;
+}
+
+static inline bool trace_event_get_state_dynamic(TraceEvent *ev)
+{
+ assert(ev != NULL);
+ return ev->dstate;
+}
diff --git a/trace/control.c b/trace/control.c
index be05efb..5706904 100644
--- a/trace/control.c
+++ b/trace/control.c
@@ -1,19 +1,86 @@
/*
* Interface for configuring and controlling the state of tracing events.
*
- * Copyright (C) 2011 Lluís Vilanova <vilanova@ac.upc.edu>
+ * Copyright (C) 2011-2012 Lluís Vilanova <vilanova@ac.upc.edu>
*
- * This work is licensed under the terms of the GNU GPL, version 2. See
- * the COPYING file in the top-level directory.
+ * This work is licensed under the terms of the GNU GPL, version 2 or later.
+ * See the COPYING file in the top-level directory.
*/
#include "trace/control.h"
-void trace_backend_init_events(const char *fname)
+TraceEvent *trace_event_name(const char *name)
+{
+ assert(name != NULL);
+
+ TraceEventID i;
+ for (i = 0; i < trace_event_count(); i++) {
+ TraceEvent *ev = trace_event_id(i);
+ if (strcmp(trace_event_get_name(ev), name) == 0) {
+ return ev;
+ }
+ }
+ return NULL;
+}
+
+static bool glob(const char *pat, const char *ev)
+{
+ while (*pat != '\0' && *ev != '\0') {
+ if (*pat == *ev) {
+ pat++;
+ ev++;
+ }
+ else if (*pat == '*') {
+ if (glob(pat, ev+1)) {
+ return true;
+ } else if (glob(pat+1, ev)) {
+ return true;
+ } else {
+ return false;
+ }
+ } else {
+ return false;
+ }
+ }
+
+ while (*pat == '*') {
+ pat++;
+ }
+
+ if (*pat == '\0' && *ev == '\0') {
+ return true;
+ } else {
+ return false;
+ }
+}
+
+TraceEvent *trace_event_pattern(const char *pat, TraceEvent *ev)
{
- int ret;
+ assert(pat != NULL);
+ TraceEventID i;
+
+ if (ev == NULL) {
+ i = -1;
+ } else {
+ i = trace_event_get_id(ev);
+ }
+ i++;
+
+ while (i < trace_event_count()) {
+ TraceEvent *res = trace_event_id(i);
+ if (glob(pat, trace_event_get_name(res))) {
+ return res;
+ }
+ i++;
+ }
+
+ return NULL;
+}
+
+void trace_backend_init_events(const char *fname)
+{
if (fname == NULL) {
return;
}
@@ -32,15 +99,21 @@ void trace_backend_init_events(const char *fname)
if ('#' == line_buf[0]) { /* skip commented lines */
continue;
}
- if ('-' == line_buf[0]) {
- ret = trace_event_set_state(line_buf+1, false);
+ const bool enable = ('-' != line_buf[0]);
+ char *line_ptr = enable ? line_buf : line_buf + 1;
+ if (trace_event_is_pattern(line_ptr)) {
+ TraceEvent *ev;
+ while ((ev = trace_event_pattern(line_ptr, ev)) != NULL) {
+ trace_event_set_state_dynamic(ev, enable);
+ }
} else {
- ret = trace_event_set_state(line_buf, true);
- }
- if (!ret) {
- fprintf(stderr,
- "error: trace event '%s' does not exist\n", line_buf);
- exit(1);
+ TraceEvent *ev = trace_event_name(line_ptr);
+ if (ev == NULL) {
+ fprintf(stderr,
+ "error: trace event '%s' does not exist\n", line_ptr);
+ exit(1);
+ }
+ trace_event_set_state_dynamic(ev, enable);
}
}
}
diff --git a/trace/control.h b/trace/control.h
index 2acaa42..9ca510d 100644
--- a/trace/control.h
+++ b/trace/control.h
@@ -1,41 +1,188 @@
/*
* Interface for configuring and controlling the state of tracing events.
*
- * Copyright (C) 2011 Lluís Vilanova <vilanova@ac.upc.edu>
+ * Copyright (C) 2011-2012 Lluís Vilanova <vilanova@ac.upc.edu>
*
- * This work is licensed under the terms of the GNU GPL, version 2. See
- * the COPYING file in the top-level directory.
+ * This work is licensed under the terms of the GNU GPL, version 2 or later.
+ * See the COPYING file in the top-level directory.
*/
-#ifndef TRACE_CONTROL_H
-#define TRACE_CONTROL_H
+#ifndef TRACE__CONTROL_H
+#define TRACE__CONTROL_H
#include "qemu-common.h"
+#include "trace/generated-events.h"
-/** Print the state of all events. */
-void trace_print_events(FILE *stream, fprintf_function stream_printf);
-/** Set the state of an event.
+/**
+ * TraceEventID:
+ *
+ * Unique tracing event identifier.
+ *
+ * These are named as 'TRACE_${EVENT_NAME}'.
+ *
+ * See also: "trace/generated-events.h"
+ */
+enum TraceEventID;
+
+/**
+ * trace_event_id:
+ * @id: Event identifier.
+ *
+ * Get an event by its identifier.
+ *
+ * This routine has a constant cost, as opposed to trace_event_name and
+ * trace_event_pattern.
+ *
+ * Pre-conditions: The identifier is valid.
+ *
+ * Returns: pointer to #TraceEvent.
+ *
+ */
+static TraceEvent *trace_event_id(TraceEventID id);
+
+/**
+ * trace_event_name:
+ * @id: Event name.
+ *
+ * Search an event by its name.
+ *
+ * Returns: pointer to #TraceEvent or NULL if not found.
+ */
+TraceEvent *trace_event_name(const char *name);
+
+/**
+ * trace_event_pattern:
+ * @pat: Event name pattern.
+ * @ev: Event to start searching from (not included).
+ *
+ * Get all events with a given name pattern.
+ *
+ * Returns: pointer to #TraceEvent or NULL if not found.
+ */
+TraceEvent *trace_event_pattern(const char *pat, TraceEvent *ev);
+
+/**
+ * trace_event_is_pattern:
+ *
+ * Whether the given string is an event name pattern.
+ */
+static bool trace_event_is_pattern(const char *str);
+
+/**
+ * trace_event_count:
+ *
+ * Return the number of events.
+ */
+static TraceEventID trace_event_count(void);
+
+
+
+/**
+ * trace_event_get_id:
+ *
+ * Get the identifier of an event.
+ */
+static TraceEventID trace_event_get_id(TraceEvent *ev);
+
+/**
+ * trace_event_get_name:
+ *
+ * Get the name of an event.
+ */
+static const char * trace_event_get_name(TraceEvent *ev);
+
+/**
+ * trace_event_get_state:
+ * @id: Event identifier.
+ *
+ * Get the tracing state of an event (both static and dynamic).
+ *
+ * If the event has the disabled property, the check will have no performance
+ * impact.
+ *
+ * As a down side, you must always use an immediate #TraceEventID value.
+ */
+#define trace_event_get_state(id) \
+ ((id ##_ENABLED) && trace_event_get_state_dynamic(trace_event_id(id)))
+
+/**
+ * trace_event_get_state_static:
+ * @id: Event identifier.
+ *
+ * Get the static tracing state of an event.
+ *
+ * Use the define 'TRACE_${EVENT_NAME}_ENABLED' for compile-time checks (it will
+ * be set to 1 or 0 according to the presence of the disabled property).
+ */
+static bool trace_event_get_state_static(TraceEvent *ev);
+
+/**
+ * trace_event_get_state_dynamic:
*
- * @return Whether the state changed.
+ * Get the dynamic tracing state of an event.
*/
-bool trace_event_set_state(const char *name, bool state);
+static bool trace_event_get_state_dynamic(TraceEvent *ev);
+/**
+ * trace_event_set_state:
+ *
+ * Set the tracing state of an event.
+ */
+#define trace_event_set_state(id, state) \
+ do { \
+ if ((id ##_ENABLED)) { \
+ TraceEvent *_e = trace_event_id(id); \
+ trace_event_set_state_dynamic(_e, state); \
+ } \
+ } while (0)
-/** Initialize the tracing backend.
+/**
+ * trace_event_set_state_dynamic:
+ *
+ * Set the dynamic tracing state of an event.
*
- * @events Name of file with events to be enabled at startup; may be NULL.
- * Corresponds to commandline option "-trace events=...".
- * @file Name of trace output file; may be NULL.
- * Corresponds to commandline option "-trace file=...".
- * @return Whether the backend could be successfully initialized.
+ * Warning: This function must be implemented by each tracing backend.
+ */
+void trace_event_set_state_dynamic(TraceEvent *ev, bool state);
+
+
+
+/**
+ * trace_print_events:
+ *
+ * Print the state of all events.
+ *
+ * Warning: This function must be implemented by each tracing backend.
+ *
+ * TODO: Should this be moved to generic code?
+ */
+void trace_print_events(FILE *stream, fprintf_function stream_printf);
+
+/**
+ * trace_backend_init:
+ * @events: Name of file with events to be enabled at startup; may be NULL.
+ * Corresponds to commandline option "-trace events=...".
+ * @file: Name of trace output file; may be NULL.
+ * Corresponds to commandline option "-trace file=...".
+ *
+ * Initialize the tracing backend.
+ *
+ * Warning: This function must be implemented by each tracing backend.
+ *
+ * Returns: Whether the backend could be successfully initialized.
*/
bool trace_backend_init(const char *events, const char *file);
-/** Generic function to initialize the state of events.
+/**
+ * trace_backend_init_events:
+ * @fname: Name of file with events to enable; may be NULL.
*
- * @fname Name of file with events to enable; may be NULL.
+ * Generic function to initialize the state of events.
*/
void trace_backend_init_events(const char *fname);
-#endif /* TRACE_CONTROL_H */
+
+#include "trace/control-internal.h"
+
+#endif /* TRACE__CONTROL_H */
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [Qemu-devel] [PATCH v8 4/7] trace: [monitor] Use new event control interface
2012-12-24 18:31 [Qemu-devel] [PATCH v8 0/7] trace: Generic event state description Lluís Vilanova
` (2 preceding siblings ...)
2012-12-24 18:31 ` [Qemu-devel] [PATCH v8 3/7] trace: Provide a detailed event control interface Lluís Vilanova
@ 2012-12-24 18:32 ` Lluís Vilanova
2012-12-24 18:32 ` [Qemu-devel] [PATCH v8 5/7] trace: [default] Port to generic event information and new " Lluís Vilanova
` (2 subsequent siblings)
6 siblings, 0 replies; 8+ messages in thread
From: Lluís Vilanova @ 2012-12-24 18:32 UTC (permalink / raw)
To: qemu-devel; +Cc: Blue Swirl, Stefan Hajnoczi
Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
---
monitor.c | 15 ++++++++++++---
1 file changed, 12 insertions(+), 3 deletions(-)
diff --git a/monitor.c b/monitor.c
index 9cf419b..dc3fbca 100644
--- a/monitor.c
+++ b/monitor.c
@@ -735,10 +735,19 @@ static void do_trace_event_set_state(Monitor *mon, const QDict *qdict)
{
const char *tp_name = qdict_get_str(qdict, "name");
bool new_state = qdict_get_bool(qdict, "option");
- int ret = trace_event_set_state(tp_name, new_state);
- if (!ret) {
- monitor_printf(mon, "unknown event name \"%s\"\n", tp_name);
+ if (trace_event_is_pattern(tp_name)) {
+ TraceEvent *ev = NULL;
+ while ((ev = trace_event_pattern(tp_name, ev)) != NULL) {
+ trace_event_set_state_dynamic(ev, new_state);
+ }
+ } else {
+ TraceEvent *ev = trace_event_name(tp_name);
+ if (ev == NULL) {
+ monitor_printf(mon, "unknown event name \"%s\"\n", tp_name);
+ } else {
+ trace_event_set_state_dynamic(ev, new_state);
+ }
}
}
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [Qemu-devel] [PATCH v8 5/7] trace: [default] Port to generic event information and new control interface
2012-12-24 18:31 [Qemu-devel] [PATCH v8 0/7] trace: Generic event state description Lluís Vilanova
` (3 preceding siblings ...)
2012-12-24 18:32 ` [Qemu-devel] [PATCH v8 4/7] trace: [monitor] Use new " Lluís Vilanova
@ 2012-12-24 18:32 ` Lluís Vilanova
2012-12-24 18:32 ` [Qemu-devel] [PATCH v8 6/7] trace: [simple] " Lluís Vilanova
2012-12-24 18:32 ` [Qemu-devel] [PATCH v8 7/7] trace: [stderr] " Lluís Vilanova
6 siblings, 0 replies; 8+ messages in thread
From: Lluís Vilanova @ 2012-12-24 18:32 UTC (permalink / raw)
To: qemu-devel; +Cc: Blue Swirl, Stefan Hajnoczi
Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
---
trace/default.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/trace/default.c b/trace/default.c
index c9b27a2..2b61224 100644
--- a/trace/default.c
+++ b/trace/default.c
@@ -1,7 +1,7 @@
/*
* Default implementation for backend initialization from commandline.
*
- * Copyright (C) 2011 Lluís Vilanova <vilanova@ac.upc.edu>
+ * Copyright (C) 2011-2012 Lluís Vilanova <vilanova@ac.upc.edu>
*
* This work is licensed under the terms of the GNU GPL, version 2. See
* the COPYING file in the top-level directory.
@@ -18,11 +18,11 @@ void trace_print_events(FILE *stream, fprintf_function stream_printf)
"operation not supported with the current backend\n");
}
-bool trace_event_set_state(const char *name, bool state)
+void trace_event_set_state_dynamic(TraceEvent *ev, bool state)
{
+ assert(ev != NULL);
fprintf(stderr, "warning: "
"cannot set the state of a trace event with the current backend\n");
- return false;
}
bool trace_backend_init(const char *events, const char *file)
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [Qemu-devel] [PATCH v8 6/7] trace: [simple] Port to generic event information and new control interface
2012-12-24 18:31 [Qemu-devel] [PATCH v8 0/7] trace: Generic event state description Lluís Vilanova
` (4 preceding siblings ...)
2012-12-24 18:32 ` [Qemu-devel] [PATCH v8 5/7] trace: [default] Port to generic event information and new " Lluís Vilanova
@ 2012-12-24 18:32 ` Lluís Vilanova
2012-12-24 18:32 ` [Qemu-devel] [PATCH v8 7/7] trace: [stderr] " Lluís Vilanova
6 siblings, 0 replies; 8+ messages in thread
From: Lluís Vilanova @ 2012-12-24 18:32 UTC (permalink / raw)
To: qemu-devel; +Cc: Blue Swirl, Stefan Hajnoczi
Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
---
scripts/tracetool/backend/simple.py | 18 +++++-------------
trace/simple.c | 33 ++++++---------------------------
trace/simple.h | 6 +-----
3 files changed, 12 insertions(+), 45 deletions(-)
diff --git a/scripts/tracetool/backend/simple.py b/scripts/tracetool/backend/simple.py
index ac864f3..37ef599 100644
--- a/scripts/tracetool/backend/simple.py
+++ b/scripts/tracetool/backend/simple.py
@@ -28,17 +28,10 @@ def is_string(arg):
def c(events):
out('#include "trace.h"',
+ '#include "trace/control.h"',
'#include "trace/simple.h"',
'',
- 'TraceEvent trace_list[] = {')
-
- for e in events:
- out('{.tp_name = "%(name)s", .state=0},',
- name = e.name,
- )
-
- out('};',
- '')
+ )
for num, event in enumerate(events):
out('void trace_%(name)s(%(args)s)',
@@ -63,7 +56,9 @@ def c(events):
out('',
- ' if (!trace_list[%(event_id)s].state) {',
+ ' TraceEvent *eventp = trace_event_id(%(event_id)s);',
+ ' bool _state = trace_event_get_state_dynamic(eventp);',
+ ' if (!_state) {',
' return;',
' }',
'',
@@ -106,6 +101,3 @@ def h(events):
name = event.name,
args = event.args,
)
- out('')
- out('#define NR_TRACE_EVENTS %d' % len(events))
- out('extern TraceEvent trace_list[NR_TRACE_EVENTS];')
diff --git a/trace/simple.c b/trace/simple.c
index ce17d64..ac1cee8 100644
--- a/trace/simple.c
+++ b/trace/simple.c
@@ -356,38 +356,17 @@ void trace_print_events(FILE *stream, fprintf_function stream_printf)
{
unsigned int i;
- for (i = 0; i < NR_TRACE_EVENTS; 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_list[i].tp_name, i, trace_list[i].state);
+ trace_event_get_name(ev), i, trace_event_get_state_dynamic(ev));
}
}
-bool trace_event_set_state(const char *name, bool state)
+void trace_event_set_state_dynamic(TraceEvent *ev, bool state)
{
- unsigned int i;
- unsigned int len;
- bool wildcard = false;
- bool matched = false;
-
- len = strlen(name);
- if (len > 0 && name[len - 1] == '*') {
- wildcard = true;
- len -= 1;
- }
- for (i = 0; i < NR_TRACE_EVENTS; i++) {
- if (wildcard) {
- if (!strncmp(trace_list[i].tp_name, name, len)) {
- trace_list[i].state = state;
- matched = true;
- }
- continue;
- }
- if (!strcmp(trace_list[i].tp_name, name)) {
- trace_list[i].state = state;
- return true;
- }
- }
- return matched;
+ assert(ev != NULL);
+ ev->dstate = state;
}
/* Helper function to create a thread with signals blocked. Use glib's
diff --git a/trace/simple.h b/trace/simple.h
index 2ab96a8..5260d9a 100644
--- a/trace/simple.h
+++ b/trace/simple.h
@@ -15,12 +15,8 @@
#include <stdbool.h>
#include <stdio.h>
-typedef uint64_t TraceEventID;
+#include "trace/generated-events.h"
-typedef struct {
- const char *tp_name;
- bool state;
-} TraceEvent;
void st_print_trace_file_status(FILE *stream, fprintf_function stream_printf);
void st_set_trace_file_enabled(bool enable);
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [Qemu-devel] [PATCH v8 7/7] trace: [stderr] Port to generic event information and new control interface
2012-12-24 18:31 [Qemu-devel] [PATCH v8 0/7] trace: Generic event state description Lluís Vilanova
` (5 preceding siblings ...)
2012-12-24 18:32 ` [Qemu-devel] [PATCH v8 6/7] trace: [simple] " Lluís Vilanova
@ 2012-12-24 18:32 ` Lluís Vilanova
6 siblings, 0 replies; 8+ messages in thread
From: Lluís Vilanova @ 2012-12-24 18:32 UTC (permalink / raw)
To: qemu-devel; +Cc: Blue Swirl, Stefan Hajnoczi
Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
---
scripts/tracetool/backend/stderr.py | 27 ++++++++-------------------
trace/stderr.c | 35 +++++++----------------------------
trace/stderr.h | 11 -----------
3 files changed, 15 insertions(+), 58 deletions(-)
delete mode 100644 trace/stderr.h
diff --git a/scripts/tracetool/backend/stderr.py b/scripts/tracetool/backend/stderr.py
index a10fbb8..6f93dbd 100644
--- a/scripts/tracetool/backend/stderr.py
+++ b/scripts/tracetool/backend/stderr.py
@@ -20,40 +20,29 @@ PUBLIC = True
def c(events):
- out('#include "trace.h"',
- '',
- 'TraceEvent trace_list[] = {')
-
- for e in events:
- out('{.tp_name = "%(name)s", .state=0},',
- name = e.name,
- )
-
- out('};')
+ pass
def h(events):
out('#include <stdio.h>',
- '#include "trace/stderr.h"',
+ '#include "trace/control.h"',
'',
- 'extern TraceEvent trace_list[];')
+ )
- for num, e in enumerate(events):
+ for e in events:
argnames = ", ".join(e.args.names())
if len(e.args) > 0:
argnames = ", " + argnames
out('static inline void trace_%(name)s(%(args)s)',
'{',
- ' if (trace_list[%(event_num)s].state != 0) {',
+ ' bool _state = trace_event_get_state(%(event_id)s);',
+ ' if (_state) {',
' fprintf(stderr, "%(name)s " %(fmt)s "\\n" %(argnames)s);',
' }',
'}',
name = e.name,
args = e.args,
- event_num = num,
- fmt = e.fmt,
+ event_id = "TRACE_" + e.name.upper(),
+ fmt = e.fmt.rstrip("\n"),
argnames = argnames,
)
-
- out('',
- '#define NR_TRACE_EVENTS %d' % len(events))
diff --git a/trace/stderr.c b/trace/stderr.c
index 0810d6f..3d5f313 100644
--- a/trace/stderr.c
+++ b/trace/stderr.c
@@ -4,40 +4,19 @@
void trace_print_events(FILE *stream, fprintf_function stream_printf)
{
- unsigned int i;
+ TraceEventID i;
- for (i = 0; i < NR_TRACE_EVENTS; 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_list[i].tp_name, i, trace_list[i].state);
+ trace_event_get_name(ev), i, trace_event_get_state_dynamic(ev));
}
}
-bool trace_event_set_state(const char *name, bool state)
+void trace_event_set_state_dynamic(TraceEvent *ev, bool state)
{
- unsigned int i;
- unsigned int len;
- bool wildcard = false;
- bool matched = false;
-
- len = strlen(name);
- if (len > 0 && name[len - 1] == '*') {
- wildcard = true;
- len -= 1;
- }
- for (i = 0; i < NR_TRACE_EVENTS; i++) {
- if (wildcard) {
- if (!strncmp(trace_list[i].tp_name, name, len)) {
- trace_list[i].state = state;
- matched = true;
- }
- continue;
- }
- if (!strcmp(trace_list[i].tp_name, name)) {
- trace_list[i].state = state;
- return true;
- }
- }
- return matched;
+ assert(ev != NULL);
+ ev->dstate = state;
}
bool trace_backend_init(const char *events, const char *file)
diff --git a/trace/stderr.h b/trace/stderr.h
deleted file mode 100644
index d575b61..0000000
--- a/trace/stderr.h
+++ /dev/null
@@ -1,11 +0,0 @@
-#ifndef TRACE_STDERR_H
-#define TRACE_STDERR_H
-
-typedef uint64_t TraceEventID;
-
-typedef struct {
- const char *tp_name;
- bool state;
-} TraceEvent;
-
-#endif /* ! TRACE_STDERR_H */
^ permalink raw reply related [flat|nested] 8+ messages in thread
end of thread, other threads:[~2012-12-24 18:32 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2012-12-24 18:31 [Qemu-devel] [PATCH v8 0/7] trace: Generic event state description Lluís Vilanova
2012-12-24 18:31 ` [Qemu-devel] [PATCH v8 1/7] trace: [tracetool] Explicitly identify public backends Lluís Vilanova
2012-12-24 18:31 ` [Qemu-devel] [PATCH v8 2/7] trace: Provide a generic tracing event descriptor Lluís Vilanova
2012-12-24 18:31 ` [Qemu-devel] [PATCH v8 3/7] trace: Provide a detailed event control interface Lluís Vilanova
2012-12-24 18:32 ` [Qemu-devel] [PATCH v8 4/7] trace: [monitor] Use new " Lluís Vilanova
2012-12-24 18:32 ` [Qemu-devel] [PATCH v8 5/7] trace: [default] Port to generic event information and new " Lluís Vilanova
2012-12-24 18:32 ` [Qemu-devel] [PATCH v8 6/7] trace: [simple] " Lluís Vilanova
2012-12-24 18:32 ` [Qemu-devel] [PATCH v8 7/7] trace: [stderr] " Lluís Vilanova
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.