From: Mathieu Desnoyers Date: Fri, 29 Nov 2013 06:19:33 +0000 (+0100) Subject: Merge branch 'master' into bindings/python X-Git-Tag: v1.2.0-rc1~39 X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=commitdiff_plain;h=024e61817685a20caceb4e3ef3bdc019a7af6b6e;hp=8382544f2fbd3c07bc36a73d02541ad31edac6a6 Merge branch 'master' into bindings/python Signed-off-by: Mathieu Desnoyers --- diff --git a/.gitignore b/.gitignore index 2b5af7e2..782da3e9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +*~ /tests/lib/test_bitfield /tests/lib/test_seek *.o @@ -17,7 +18,12 @@ ctf-parser-test /config.h.in /config.status *.log -*.m4 +aclocal.m4 +/m4/libtool.m4 +/m4/lt~obsolete.m4 +/m4/ltoptions.m4 +/m4/ltsugar.m4 +/m4/ltversion.m4 libtool /configure Makefile @@ -28,4 +34,7 @@ converter/babeltrace-log core formats/ctf/metadata/ctf-parser.output stamp-h1 +bindings/python/babeltrace.i +bindings/python/babeltrace.py +bindings/python/babeltrace_wrap.c babeltrace.pc diff --git a/Makefile.am b/Makefile.am index e5eca77f..c3c64e09 100644 --- a/Makefile.am +++ b/Makefile.am @@ -2,7 +2,7 @@ AM_CFLAGS = $(PACKAGE_CFLAGS) -I$(top_srcdir)/include ACLOCAL_AMFLAGS = -I m4 -SUBDIRS = include types compat lib formats converter tests doc extras +SUBDIRS = include types compat lib formats converter bindings tests doc extras dist_doc_DATA = ChangeLog LICENSE mit-license.txt gpl-2.0.txt \ std-ext-lib.txt diff --git a/README b/README index 8195cd3e..d76d6980 100644 --- a/README +++ b/README @@ -25,7 +25,6 @@ BUILDING make install ldconfig - DEPENDENCIES ------------ @@ -44,6 +43,19 @@ To compile Babeltrace, you will need: libpopt >= 1.13 development libraries (Debian : libpopt-dev) (Fedora : popt) + python headers (optional) + (Debian/Ubuntu : python3-dev) + swig >= 2.0 (optional) + (Debian/Ubuntu : swig2.0) + python 3.0 or better (optional) + (Debian/Ubuntu : python3) + + If you want Python bindings, run ./configure --enable-python-bindings. + Please note that some distributions will need the following + environment variables set before running configure: + + export PYTHON="python3" + export PYTHON_CONFIG="/usr/bin/python3-config" For developers using the git tree: diff --git a/bindings/Makefile.am b/bindings/Makefile.am new file mode 100644 index 00000000..dcd868da --- /dev/null +++ b/bindings/Makefile.am @@ -0,0 +1,3 @@ +if USE_PYTHON +SUBDIRS = python +endif diff --git a/bindings/python/Makefile.am b/bindings/python/Makefile.am new file mode 100644 index 00000000..0d967000 --- /dev/null +++ b/bindings/python/Makefile.am @@ -0,0 +1,30 @@ +babeltrace.i: babeltrace.i.in + sed "s/BABELTRACE_VERSION_STR/Babeltrace $(PACKAGE_VERSION)/g" < \ + $(top_srcdir)/bindings/python/babeltrace.i.in > \ + $(top_builddir)/bindings/python/babeltrace.i + +AM_CFLAGS = $(PYTHON_INCLUDE) -I$(top_srcdir)/include/ + +EXTRA_DIST = babeltrace.i.in +nodist_python_PYTHON = babeltrace.py +pyexec_LTLIBRARIES = _babeltrace.la + +MAINTAINERCLEANFILES = babeltrace_wrap.c babeltrace.py + +nodist__babeltrace_la_SOURCES = babeltrace_wrap.c +_babeltrace_la_SOURCES = python-complements.h python-complements.c +_babeltrace_la_LDFLAGS = -module + +_babeltrace_la_CFLAGS = $(GLIB_CFLAGS) $(AM_CFLAGS) + +_babeltrace_la_LIBS = $(GLIB_LIBS) + +_babeltrace_la_LIBADD = $(top_builddir)/formats/ctf/libbabeltrace-ctf.la \ + $(top_builddir)/formats/ctf-text/libbabeltrace-ctf-text.la + +# SWIG 'warning md variable unused' fixed after SWIG build: +babeltrace_wrap.c: babeltrace.i + $(SWIG) -python -Wall -I. -I$(top_srcdir)/include \ + $(top_builddir)/bindings/python/babeltrace.i + +CLEANFILES = babeltrace.i babeltrace.py babeltrace_wrap.c diff --git a/bindings/python/babeltrace.i.in b/bindings/python/babeltrace.i.in new file mode 100644 index 00000000..aaa400aa --- /dev/null +++ b/bindings/python/babeltrace.i.in @@ -0,0 +1,2166 @@ +/* + * babeltrace.i.in + * + * Babeltrace Python Module interface file + * + * Copyright 2012 EfficiOS Inc. + * + * Author: Danny Serres + * Author: Jérémie Galarneau + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + */ + + +%define DOCSTRING +"BABELTRACE_VERSION_STR + +Babeltrace is a trace viewer and converter reading and writing the +Common Trace Format (CTF). Its main use is to pretty-print CTF +traces into a human-readable text output. + +To use this module, the first step is to create a TraceCollection and add a +trace to it." +%enddef + +%module(docstring=DOCSTRING) babeltrace + +%include "typemaps.i" +%{ +#define SWIG_FILE_WITH_INIT +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "python-complements.h" +#include +#include +#include +#include +#include +#include +%} + +typedef unsigned long long uint64_t; +typedef long long int64_t; +typedef int bt_intern_str; + +/* ================================================================= + PYTHON-COMPLEMENTS.H + ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ +*/ + +FILE *_bt_file_open(char *file_path, char *mode); +void _bt_file_close(FILE *fp); +struct bt_definition **_bt_python_field_listcaller( + const struct bt_ctf_event *ctf_event, + const struct bt_definition *scope, + unsigned int *OUTPUT); +struct bt_definition *_bt_python_field_one_from_list( + struct bt_definition **list, int index); +struct bt_ctf_event_decl **_bt_python_event_decl_listcaller( + int handle_id, + struct bt_context *ctx, + unsigned int *OUTPUT); +struct bt_ctf_event_decl *_bt_python_decl_one_from_list( + struct bt_ctf_event_decl **list, int index); +struct bt_ctf_field_decl **_by_python_field_decl_listcaller( + struct bt_ctf_event_decl *event_decl, + enum bt_ctf_scope scope, + unsigned int *OUTPUT); +struct bt_ctf_field_decl *_bt_python_field_decl_one_from_list( + struct bt_ctf_field_decl **list, int index); +struct definition_array *_bt_python_get_array_from_def( + struct bt_definition *field); +struct definition_sequence *_bt_python_get_sequence_from_def( + struct bt_definition *field); +int _bt_python_field_integer_get_signedness(const struct bt_ctf_field *field); +enum ctf_type_id _bt_python_get_field_type(const struct bt_ctf_field *field); + +/* ================================================================= + CONTEXT.H, CONTEXT-INTERNAL.H + ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ +*/ + +%rename("_bt_context_create") bt_context_create(void); +%rename("_bt_context_add_trace") bt_context_add_trace( + struct bt_context *ctx, const char *path, const char *format, + void (*packet_seek)(struct bt_stream_pos *pos, size_t index, int whence), + struct bt_mmap_stream_list *stream_list, FILE *metadata); +%rename("_bt_context_remove_trace") bt_context_remove_trace( + struct bt_context *ctx, int trace_id); +%rename("_bt_context_get") bt_context_get(struct bt_context *ctx); +%rename("_bt_context_put") bt_context_put(struct bt_context *ctx); +%rename("_bt_ctf_event_get_context") bt_ctf_event_get_context( + const struct bt_ctf_event *event); + +struct bt_context *bt_context_create(void); +int bt_context_add_trace(struct bt_context *ctx, const char *path, const char *format, + void (*packet_seek)(struct bt_stream_pos *pos, size_t index, int whence), + struct bt_mmap_stream_list *stream_list, FILE *metadata); +void bt_context_remove_trace(struct bt_context *ctx, int trace_id); +void bt_context_get(struct bt_context *ctx); +void bt_context_put(struct bt_context *ctx); +struct bt_context *bt_ctf_event_get_context(const struct bt_ctf_event *event); + +// class TraceCollection to prevent direct access to struct bt_context +%pythoncode%{ +class TraceCollection: + """ + The TraceCollection is the object that contains all currently opened traces. + """ + + def __init__(self): + self._tc = _bt_context_create() + + def __del__(self): + _bt_context_put(self._tc) + + def add_trace(self, path, format_str): + """ + Add a trace by path to the TraceCollection. + + Open a trace. + + path is the path to the trace, it is not recursive. + If "path" is None, stream_list is used instead as a list + of mmap streams to open for the trace. + + format is a string containing the format name in which the trace was + produced. + + Return: the corresponding TraceHandle on success or None on error. + """ + ret = _bt_context_add_trace(self._tc, path, format_str, None, None, None) + if ret < 0: + return None + + th = TraceHandle.__new__(TraceHandle) + th._id = ret + th._trace_collection = self + return th + + def add_traces_recursive(self, path, format_str): + """ + Open a trace recursively. + + Find each trace present in the subdirectory starting from the given + path, and add them to the TraceCollection. + + Return a dict of TraceHandle instances (the full path is the key). + Return None on error. + """ + + import os + + trace_handles = {} + + noTrace = True + error = False + + for fullpath, dirs, files in os.walk(path): + if "metadata" in files: + trace_handle = self.add_trace(fullpath, format_str) + if trace_handle is None: + error = True + continue + + trace_handles[fullpath] = trace_handle + noTrace = False + + if noTrace and error: + return None + return trace_handles + + def remove_trace(self, trace_handle): + """ + Remove a trace from the TraceCollection. + Effectively closing the trace. + """ + try: + _bt_context_remove_trace(self._tc, trace_handle._id) + except AttributeError: + raise TypeError("in remove_trace, " + "argument 2 must be a TraceHandle instance") + + @property + def events(self): + """ + Generator function to iterate over the events of open in the current + TraceCollection. + """ + begin_pos_ptr = _bt_iter_pos() + end_pos_ptr = _bt_iter_pos() + begin_pos_ptr.type = SEEK_BEGIN + end_pos_ptr.type = SEEK_LAST + + for event in self._events(begin_pos_ptr, end_pos_ptr): + yield event + + def events_timestamps(self, timestamp_begin, timestamp_end): + """ + Generator function to iterate over the events of open in the current + TraceCollection from timestamp_begin to timestamp_end. + """ + begin_pos_ptr = _bt_iter_pos() + end_pos_ptr = _bt_iter_pos() + begin_pos_ptr.type = end_pos_ptr.type = SEEK_TIME + begin_pos_ptr.u.seek_time = timestamp_begin + end_pos_ptr.u.seek_time = timestamp_end + + for event in self._events(begin_pos_ptr, end_pos_ptr): + yield event + + @property + def timestamp_begin(self): + pos_ptr = _bt_iter_pos() + pos_ptr.type = SEEK_BEGIN + return self._timestamp_at_pos(pos_ptr) + + @property + def timestamp_end(self): + pos_ptr = _bt_iter_pos() + pos_ptr.type = SEEK_LAST + return self._timestamp_at_pos(pos_ptr) + + def _timestamp_at_pos(self, pos_ptr): + ctf_it_ptr = _bt_ctf_iter_create(self._tc, pos_ptr, pos_ptr) + if ctf_it_ptr is None: + raise NotImplementedError("Creation of multiple iterators is unsupported.") + ev_ptr = _bt_ctf_iter_read_event(ctf_it_ptr) + _bt_ctf_iter_destroy(ctf_it_ptr) + if ev_ptr is None: + return None; + + def _events(self, begin_pos_ptr, end_pos_ptr): + ctf_it_ptr = _bt_ctf_iter_create(self._tc, begin_pos_ptr, end_pos_ptr) + if ctf_it_ptr is None: + raise NotImplementedError( + "Creation of multiple iterators is unsupported.") + + while True: + ev_ptr = _bt_ctf_iter_read_event(ctf_it_ptr) + if ev_ptr is None: + break + + ev = Event.__new__(Event) + ev._e = ev_ptr + try: + yield ev + except GeneratorExit: + break + + ret = _bt_iter_next(_bt_ctf_get_iter(ctf_it_ptr)) + if ret != 0: + break + + _bt_ctf_iter_destroy(ctf_it_ptr) + +%} + + + +/* ================================================================= + FORMAT.H, REGISTRY + ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ +*/ + +%rename("lookup_format") bt_lookup_format(bt_intern_str qname); +%rename("_bt_print_format_list") bt_fprintf_format_list(FILE *fp); +%rename("register_format") bt_register_format(struct format *format); +%rename("unregister_format") bt_unregister_format(struct bt_format *format); + +extern struct format *bt_lookup_format(bt_intern_str qname); +extern void bt_fprintf_format_list(FILE *fp); +extern int bt_register_format(struct bt_format *format); +extern void bt_unregister_format(struct bt_format *format); + +%pythoncode %{ + +def print_format_list(babeltrace_file): + """ + Print a list of available formats to file. + + babeltrace_file must be a File instance opened in write mode. + """ + try: + if babeltrace_file._file is not None: + _bt_print_format_list(babeltrace_file._file) + except AttributeError: + raise TypeError("in print_format_list, " + "argument 1 must be a File instance") + +%} + + +/* ================================================================= + ITERATOR.H, ITERATOR-INTERNAL.H + ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ +*/ + +%rename("_bt_iter_create") bt_iter_create(struct bt_context *ctx, + const struct bt_iter_pos *begin_pos, const struct bt_iter_pos *end_pos); +%rename("_bt_iter_destroy") bt_iter_destroy(struct bt_iter *iter); +%rename("_bt_iter_next") bt_iter_next(struct bt_iter *iter); +%rename("_bt_iter_get_pos") bt_iter_get_pos(struct bt_iter *iter); +%rename("_bt_iter_free_pos") bt_iter_free_pos(struct bt_iter_pos *pos); +%rename("_bt_iter_set_pos") bt_iter_set_pos(struct bt_iter *iter, + const struct bt_iter_pos *pos); +%rename("_bt_iter_create_time_pos") bt_iter_create_time_pos(struct bt_iter *iter, + uint64_t timestamp); + +struct bt_iter *bt_iter_create(struct bt_context *ctx, + const struct bt_iter_pos *begin_pos, const struct bt_iter_pos *end_pos); +void bt_iter_destroy(struct bt_iter *iter); +int bt_iter_next(struct bt_iter *iter); +struct bt_iter_pos *bt_iter_get_pos(struct bt_iter *iter); +void bt_iter_free_pos(struct bt_iter_pos *pos); +int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *pos); +struct bt_iter_pos *bt_iter_create_time_pos(struct bt_iter *iter, uint64_t timestamp); + +%rename("_bt_iter_pos") bt_iter_pos; +%rename("SEEK_TIME") BT_SEEK_TIME; +%rename("SEEK_RESTORE") BT_SEEK_RESTORE; +%rename("SEEK_CUR") BT_SEEK_CUR; +%rename("SEEK_BEGIN") BT_SEEK_BEGIN; +%rename("SEEK_LAST") BT_SEEK_LAST; + +// This struct is taken from iterator.h +// All changes to the struct must also be made here +struct bt_iter_pos { + enum { + BT_SEEK_TIME, /* uses u.seek_time */ + BT_SEEK_RESTORE, /* uses u.restore */ + BT_SEEK_CUR, + BT_SEEK_BEGIN, + BT_SEEK_LAST + } type; + union { + uint64_t seek_time; + struct bt_saved_pos *restore; + } u; +}; + +/* ================================================================= + TRACE-HANDLE.H, TRACE-HANDLE-INTERNAL.H + ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ +*/ + +%rename("_bt_trace_handle_create") bt_trace_handle_create(struct bt_context *ctx); +%rename("_bt_trace_handle_destroy") bt_trace_handle_destroy(struct bt_trace_handle *bt); +struct bt_trace_handle *bt_trace_handle_create(struct bt_context *ctx); +void bt_trace_handle_destroy(struct bt_trace_handle *bt); + +%rename("_bt_trace_handle_get_path") bt_trace_handle_get_path(struct bt_context *ctx, + int handle_id); +%rename("_bt_trace_handle_get_timestamp_begin") bt_trace_handle_get_timestamp_begin( + struct bt_context *ctx, int handle_id, enum bt_clock_type type); +%rename("_bt_trace_handle_get_timestamp_end") bt_trace_handle_get_timestamp_end( + struct bt_context *ctx, int handle_id, enum bt_clock_type type); +const char *bt_trace_handle_get_path(struct bt_context *ctx, int handle_id); +uint64_t bt_trace_handle_get_timestamp_begin(struct bt_context *ctx, int handle_id, + enum bt_clock_type type); +uint64_t bt_trace_handle_get_timestamp_end(struct bt_context *ctx, int handle_id, + enum bt_clock_type type); + +%rename("_bt_ctf_event_get_handle_id") bt_ctf_event_get_handle_id( + const struct bt_ctf_event *event); +int bt_ctf_event_get_handle_id(const struct bt_ctf_event *event); + + +%pythoncode%{ + +# Based on enum bt_clock_type in clock-type.h­ +class ClockType: + CLOCK_CYCLES = 0 + CLOCK_REAL = 1 + +class TraceHandle(object): + """ + The TraceHandle allows the user to manipulate a trace file directly. + It is a unique identifier representing a trace file. + Do not instantiate. + """ + + def __init__(self): + raise NotImplementedError("TraceHandle cannot be instantiated") + + def __repr__(self): + return "Babeltrace TraceHandle: trace_id('{0}')".format(self._id) + + @property + def id(self): + """Return the TraceHandle id.""" + return self._id + + @property + def path(self): + """Return the path of a TraceHandle.""" + return _bt_trace_handle_get_path(self._trace_collection._tc, self._id) + + @property + def timestamp_begin(self): + """Return the creation time of the buffers of a trace.""" + return _bt_trace_handle_get_timestamp_begin( + self._trace_collection._tc, self._id, ClockType.CLOCK_REAL) + + @property + def timestamp_end(self): + """Return the destruction timestamp of the buffers of a trace.""" + return _bt_trace_handle_get_timestamp_end( + self._trace_collection._tc, self._id, ClockType.CLOCK_REAL) + + @property + def events(self): + """ + Generator returning all events (EventDeclaration) in a trace. + """ + ret = _bt_python_event_decl_listcaller(self.id, self._trace_collection._tc) + + if not isinstance(ret, list): + return + + ptr_list, count = ret + for i in range(count): + tmp = EventDeclaration.__new__(EventDeclaration) + tmp._ed = _bt_python_decl_one_from_list(ptr_list, i) + yield tmp + +%} + + + +// ================================================================= +// CTF +// ================================================================= + +/* ================================================================= + ITERATOR.H, EVENTS.H + ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ +*/ + +//Iterator +%rename("_bt_ctf_iter_create") bt_ctf_iter_create(struct bt_context *ctx, + const struct bt_iter_pos *begin_pos, + const struct bt_iter_pos *end_pos); +%rename("_bt_ctf_get_iter") bt_ctf_get_iter(struct bt_ctf_iter *iter); +%rename("_bt_ctf_iter_destroy") bt_ctf_iter_destroy(struct bt_ctf_iter *iter); +%rename("_bt_ctf_iter_read_event") bt_ctf_iter_read_event(struct bt_ctf_iter *iter); + +struct bt_ctf_iter *bt_ctf_iter_create(struct bt_context *ctx, + const struct bt_iter_pos *begin_pos, + const struct bt_iter_pos *end_pos); +struct bt_iter *bt_ctf_get_iter(struct bt_ctf_iter *iter); +void bt_ctf_iter_destroy(struct bt_ctf_iter *iter); +struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter); + + +//Events +%rename("_bt_ctf_get_top_level_scope") bt_ctf_get_top_level_scope(const struct + bt_ctf_event *event, enum bt_ctf_scope scope); +%rename("_bt_ctf_event_name") bt_ctf_event_name(const struct bt_ctf_event *ctf_event); +%rename("_bt_ctf_get_timestamp") bt_ctf_get_timestamp( + const struct bt_ctf_event *ctf_event); +%rename("_bt_ctf_get_cycles") bt_ctf_get_cycles( + const struct bt_ctf_event *ctf_event); + +%rename("_bt_ctf_get_field") bt_ctf_get_field(const struct bt_ctf_event *ctf_event, + const struct bt_definition *scope, const char *field); +%rename("_bt_ctf_get_index") bt_ctf_get_index(const struct bt_ctf_event *ctf_event, + const struct bt_definition *field, unsigned int index); +%rename("_bt_ctf_field_name") bt_ctf_field_name(const struct bt_definition *field); +%rename("_bt_ctf_field_type") bt_ctf_field_type(const struct bt_declaration *field); +%rename("_bt_ctf_get_int_signedness") bt_ctf_get_int_signedness( + const struct bt_declaration *field); +%rename("_bt_ctf_get_int_base") bt_ctf_get_int_base(const struct bt_declaration *field); +%rename("_bt_ctf_get_int_byte_order") bt_ctf_get_int_byte_order( + const struct bt_declaration *field); +%rename("_bt_ctf_get_int_len") bt_ctf_get_int_len(const struct bt_declaration *field); +%rename("_bt_ctf_get_enum_int") bt_ctf_get_enum_int(const struct bt_definition *field); +%rename("_bt_ctf_get_enum_str") bt_ctf_get_enum_str(const struct bt_definition *field); +%rename("_bt_ctf_get_encoding") bt_ctf_get_encoding(const struct bt_declaration *field); +%rename("_bt_ctf_get_array_len") bt_ctf_get_array_len(const struct bt_declaration *field); +%rename("_bt_ctf_get_uint64") bt_ctf_get_uint64(const struct bt_definition *field); +%rename("_bt_ctf_get_int64") bt_ctf_get_int64(const struct bt_definition *field); +%rename("_bt_ctf_get_char_array") bt_ctf_get_char_array(const struct bt_definition *field); +%rename("_bt_ctf_get_string") bt_ctf_get_string(const struct bt_definition *field); +%rename("_bt_ctf_get_float") bt_ctf_get_float(const struct bt_definition *field); +%rename("_bt_ctf_get_variant") bt_ctf_get_variant(const struct bt_definition *field); +%rename("_bt_ctf_field_get_error") bt_ctf_field_get_error(void); +%rename("_bt_ctf_get_decl_event_name") bt_ctf_get_decl_event_name(const struct + bt_ctf_event_decl *event); +%rename("_bt_ctf_get_decl_field_name") bt_ctf_get_decl_field_name( + const struct bt_ctf_field_decl *field); +%rename("_bt_ctf_get_decl_from_def") bt_ctf_get_decl_from_def( + const struct bt_definition *field); +%rename("_bt_ctf_get_decl_from_field_decl") bt_ctf_get_decl_from_field_decl( + const struct bt_ctf_field_decl *field); +%rename("_bt_array_index") bt_array_index(struct definition_array *array, uint64_t i); +%rename("_bt_sequence_len") bt_sequence_len(struct definition_sequence *sequence); +%rename("_bt_sequence_index") bt_sequence_index(struct definition_sequence *sequence, uint64_t i); +%rename("_bt_ctf_get_struct_field_count") bt_ctf_get_struct_field_count(const struct bt_definition *structure); +%rename("_bt_ctf_get_struct_field_index") bt_ctf_get_struct_field_index(const struct bt_definition *structure, uint64_t i); + +const struct bt_definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *ctf_event, + enum bt_ctf_scope scope); +const char *bt_ctf_event_name(const struct bt_ctf_event *ctf_event); +uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *ctf_event); +uint64_t bt_ctf_get_cycles(const struct bt_ctf_event *ctf_event); +const struct bt_definition *bt_ctf_get_field(const struct bt_ctf_event *ctf_event, + const struct bt_definition *scope, + const char *field); +const struct bt_definition *bt_ctf_get_index(const struct bt_ctf_event *ctf_event, + const struct bt_definition *field, + unsigned int index); +const char *bt_ctf_field_name(const struct bt_definition *field); +enum ctf_type_id bt_ctf_field_type(const struct bt_declaration *field); +int bt_ctf_get_int_signedness(const struct bt_declaration *field); +int bt_ctf_get_int_base(const struct bt_declaration *field); +int bt_ctf_get_int_byte_order(const struct bt_declaration *field); +ssize_t bt_ctf_get_int_len(const struct bt_declaration *field); +const struct bt_definition *bt_ctf_get_enum_int(const struct bt_definition *field); +const char *bt_ctf_get_enum_str(const struct bt_definition *field); +enum ctf_string_encoding bt_ctf_get_encoding(const struct bt_declaration *field); +int bt_ctf_get_array_len(const struct bt_declaration *field); +struct bt_definition *bt_array_index(struct definition_array *array, uint64_t i); +uint64_t bt_ctf_get_uint64(const struct bt_definition *field); +int64_t bt_ctf_get_int64(const struct bt_definition *field); +char *bt_ctf_get_char_array(const struct bt_definition *field); +char *bt_ctf_get_string(const struct bt_definition *field); +double bt_ctf_get_float(const struct bt_definition *field); +const struct bt_definition *bt_ctf_get_variant(const struct bt_definition *field); +int bt_ctf_field_get_error(void); +const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event); +const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field); +const struct bt_declaration *bt_ctf_get_decl_from_def(const struct bt_definition *field); +const struct bt_declaration *bt_ctf_get_decl_from_field_decl(const struct bt_ctf_field_decl *field); +uint64_t bt_sequence_len(struct definition_sequence *sequence); +struct bt_definition *bt_sequence_index(struct definition_sequence *sequence, uint64_t i); +uint64_t bt_ctf_get_struct_field_count(const struct bt_definition *structure); +const struct bt_definition *bt_ctf_get_struct_field_index(const struct bt_definition *structure, uint64_t i); + +%pythoncode%{ + +class CTFStringEncoding: + NONE = 0 + UTF8 = 1 + ASCII = 2 + UNKNOWN = 3 + +# Based on the enum in ctf-writer/writer.h +class ByteOrder: + BYTE_ORDER_NATIVE = 0 + BYTE_ORDER_LITTLE_ENDIAN = 1 + BYTE_ORDER_BIG_ENDIAN = 2 + BYTE_ORDER_NETWORK = 3 + BYTE_ORDER_UNKNOWN = 4 # Python-specific entry + +#enum equivalent, accessible constants +#These are taken directly from ctf/events.h +#All changes to enums must also be made here +class CTFTypeId: + UNKNOWN = 0 + INTEGER = 1 + FLOAT = 2 + ENUM = 3 + STRING = 4 + STRUCT = 5 + UNTAGGED_VARIANT = 6 + VARIANT = 7 + ARRAY = 8 + SEQUENCE = 9 + NR_CTF_TYPES = 10 + + def type_name(id): + name = "UNKNOWN_TYPE" + constants = [attr for attr in dir(CTFTypeId) if not callable(getattr(CTFTypeId, attr)) and not attr.startswith("__")] + for attr in constants: + if getattr(CTFTypeId, attr) == id: + name = attr + break + return name + +class CTFScope: + TRACE_PACKET_HEADER = 0 + STREAM_PACKET_CONTEXT = 1 + STREAM_EVENT_HEADER = 2 + STREAM_EVENT_CONTEXT = 3 + EVENT_CONTEXT = 4 + EVENT_FIELDS = 5 + + def scope_name(scope): + name = "UNKNOWN_SCOPE" + constants = [attr for attr in dir(CTFScope) if not callable(getattr(CTFScope, attr)) and not attr.startswith("__")] + for attr in constants: + if getattr(CTFScope, attr) == scope: + name = attr + break + return name + +# Priority of the scopes when searching for event fields +_scopes = [CTFScope.EVENT_FIELDS, CTFScope.EVENT_CONTEXT, CTFScope.STREAM_EVENT_CONTEXT, + CTFScope.STREAM_EVENT_HEADER, CTFScope.STREAM_PACKET_CONTEXT, CTFScope.TRACE_PACKET_HEADER] + +import collections +class Event(collections.Mapping): + """ + This class represents an event from the trace. + It is obtained using the TraceCollection generator functions. + Do not instantiate. + """ + def __init__(self): + raise NotImplementedError("Event cannot be instantiated") + + @property + def name(self): + """Return the name of the event or None on error.""" + return _bt_ctf_event_name(self._e) + + @property + def cycles(self): + """ + Return the timestamp of the event as written in + the packet (in cycles) or -1ULL on error. + """ + return _bt_ctf_get_cycles(self._e) + + @property + def timestamp(self): + """ + Return the timestamp of the event offset with the + system clock source or -1ULL on error. + """ + return _bt_ctf_get_timestamp(self._e) + + def field_with_scope(self, field_name, scope): + """ + Get field_name's value in scope. + None is returned if no field matches field_name. + """ + if not scope in _scopes: + raise ValueError("Invalid scope provided") + field = self._field_with_scope(field_name, scope) + if field is not None: + return field.value + return None + + def field_list_with_scope(self, scope): + """Return a list of field names in scope.""" + if not scope in _scopes: + raise ValueError("Invalid scope provided") + field_names = [] + for field in self._field_list_with_scope(scope): + field_names.append(field.name) + return field_names + + @property + def handle(self): + """ + Get the TraceHandle associated with this event + Return None on error + """ + ret = _bt_ctf_event_get_handle_id(self._e) + if ret < 0: + return None + + th = TraceHandle.__new__(TraceHandle) + th._id = ret + th._trace_collection = self.get_trace_collection() + return th + + @property + def trace_collection(self): + """ + Get the TraceCollection associated with this event. + Return None on error. + """ + trace_collection = TraceCollection() + trace_collection._tc = _bt_ctf_event_get_context(self._e); + if trace_collection._tc is None: + return None + else: + return trace_collection + + def __getitem__(self, field_name): + """ + Get field_name's value. If the field_name exists in multiple + scopes, the first field found is returned. The scopes are searched + in the following order: + 1) EVENT_FIELDS + 2) EVENT_CONTEXT + 3) STREAM_EVENT_CONTEXT + 4) STREAM_EVENT_HEADER + 5) STREAM_PACKET_CONTEXT + 6) TRACE_PACKET_HEADER + None is returned if no field matches field_name. + + Use field_with_scope() to explicitly access fields in a given + scope. + """ + field = self._field(field_name) + if field is not None: + return field.value + raise KeyError(field_name) + + def __iter__(self): + for key in self.keys(): + yield key + + def __len__(self): + count = 0 + for scope in _scopes: + scope_ptr = _bt_ctf_get_top_level_scope(self._e, scope) + ret = _bt_python_field_listcaller(self._e, scope_ptr) + if isinstance(ret, list): + count += ret[1] + return count + + def __contains__(self, field_name): + return self._field(field_name) is not None + + def keys(self): + """Return a list of field names.""" + field_names = set() + for scope in _scopes: + for name in self.field_list_with_scope(scope): + field_names.add(name) + return list(field_names) + + def get(self, field_name, default = None): + field = self._field(field_name) + if field is None: + return default + return field.value + + def items(self): + for field in self.keys(): + yield (field, self[field]) + + def _field_with_scope(self, field_name, scope): + scope_ptr = _bt_ctf_get_top_level_scope(self._e, scope) + if scope_ptr is None: + return None + + definition_ptr = _bt_ctf_get_field(self._e, scope_ptr, field_name) + if definition_ptr is None: + return None + + field = _Definition(definition_ptr, scope) + return field + + def _field(self, field_name): + field = None + for scope in _scopes: + field = self._field_with_scope(field_name, scope) + if field is not None: + break + return field + + def _field_list_with_scope(self, scope): + fields = [] + scope_ptr = _bt_ctf_get_top_level_scope(self._e, scope) + + # Returns a list [list_ptr, count]. If list_ptr is NULL, SWIG will only + # provide the "count" return value + count = 0 + list_ptr = None + ret = _bt_python_field_listcaller(self._e, scope_ptr) + if isinstance(ret, list): + list_ptr, count = ret + + for i in range(count): + definition_ptr = _bt_python_field_one_from_list(list_ptr, i) + if definition_ptr is not None: + definition = _Definition(definition_ptr, scope) + fields.append(definition) + return fields + +class FieldError(Exception): + def __init__(self, value): + self.value = value + + def __str__(self): + return repr(self.value) + +class EventDeclaration(object): + """Event declaration class. Do not instantiate.""" + + def __init__(self): + raise NotImplementedError("EventDeclaration cannot be instantiated") + + @property + def name(self): + """Return the name of the event or None on error""" + return _bt_ctf_get_decl_event_name(self._ed) + + @property + def fields(self): + """ + Generator returning all FieldDeclarations of an event, going through + each scope in the following order: + 1) EVENT_FIELDS + 2) EVENT_CONTEXT + 3) STREAM_EVENT_CONTEXT + 4) STREAM_EVENT_HEADER + 5) STREAM_PACKET_CONTEXT + 6) TRACE_PACKET_HEADER + """ + for scope in _scopes: + for declaration in self.fields_scope(scope): + yield declaration + + def fields_scope(self, scope): + """ + Generator returning FieldDeclarations of the current event in scope. + """ + ret = _by_python_field_decl_listcaller(self._ed, scope) + + if not isinstance(ret, list): + return + + list_ptr, count = ret + for i in range(count): + field_declaration_ptr = _bt_python_field_decl_one_from_list(list_ptr, i) + if field_declaration_ptr is not None: + declaration_ptr = _bt_ctf_get_decl_from_field_decl(field_declaration_ptr) + field_declaration = _create_field_declaration(declaration_ptr, _bt_ctf_get_decl_field_name(field_declaration_ptr), scope) + yield field_declaration + +class FieldDeclaration(object): + """Field declaration class. Do not instantiate.""" + def __init__(self): + raise NotImplementedError("FieldDeclaration cannot be instantiated") + + def __repr__(self): + return "({0}) {1} {2}".format(CTFScope.scope_name(self.scope), CTFTypeId.type_name(self.type), self.name) + + @property + def name(self): + """Return the name of a FieldDeclaration or None on error.""" + return self._name + + @property + def type(self): + """ + Return the FieldDeclaration's type. One of the entries in class + CTFTypeId. + """ + return _bt_ctf_field_type(self._fd) + + @property + def scope(self): + """ + Return the FieldDeclaration's scope. + """ + return self._s + +class IntegerFieldDeclaration(FieldDeclaration): + """Do not instantiate.""" + def __init__(self): + raise NotImplementedError("IntegerFieldDeclaration cannot be instantiated") + + @property + def signedness(self): + """ + Return the signedness of an integer: + 0 if unsigned; 1 if signed; -1 on error. + """ + return _bt_ctf_get_int_signedness(self._fd) + + @property + def base(self): + """Return the base of an int or a negative value on error.""" + return _bt_ctf_get_int_base(self._fd) + + @property + def byte_order(self): + """ + Return the byte order. One of class ByteOrder's entries. + """ + ret = _bt_ctf_get_int_byte_order(self._fd) + if ret == 1234: + return ByteOrder.BYTE_ORDER_LITTLE_ENDIAN + elif ret == 4321: + return ByteOrder.BYTE_ORDER_BIG_ENDIAN + else: + return ByteOrder.BYTE_ORDER_UNKNOWN + + @property + def length(self): + """ + Return the size, in bits, of an int or a negative + value on error. + """ + return _bt_ctf_get_int_len(self._fd) + + @property + def encoding(self): + """ + Return the encoding. One of class CTFStringEncoding's entries. + Return a negative value on error. + """ + return _bt_ctf_get_encoding(self._fd) + +class EnumerationFieldDeclaration(FieldDeclaration): + """Do not instantiate.""" + def __init__(self): + raise NotImplementedError("EnumerationFieldDeclaration cannot be instantiated") + +class ArrayFieldDeclaration(FieldDeclaration): + """Do not instantiate.""" + def __init__(self): + raise NotImplementedError("ArrayFieldDeclaration cannot be instantiated") + + @property + def length(self): + """ + Return the length of an array or a negative + value on error. + """ + return _bt_ctf_get_array_len(self._fd) + +class SequenceFieldDeclaration(FieldDeclaration): + """Do not instantiate.""" + def __init__(self): + raise NotImplementedError("SequenceFieldDeclaration cannot be instantiated") + +class FloatFieldDeclaration(FieldDeclaration): + """Do not instantiate.""" + def __init__(self): + raise NotImplementedError("FloatFieldDeclaration cannot be instantiated") + +class StructureFieldDeclaration(FieldDeclaration): + """Do not instantiate.""" + def __init__(self): + raise NotImplementedError("StructureFieldDeclaration cannot be instantiated") + +class StringFieldDeclaration(FieldDeclaration): + """Do not instantiate.""" + def __init__(self): + raise NotImplementedError("StringFieldDeclaration cannot be instantiated") + +class VariantFieldDeclaration(FieldDeclaration): + """Do not instantiate.""" + def __init__(self): + raise NotImplementedError("VariantFieldDeclaration cannot be instantiated") + +def field_error(): + """ + Return the last error code encountered while + accessing a field and reset the error flag. + Return 0 if no error, a negative value otherwise. + """ + return _bt_ctf_field_get_error() + +def _create_field_declaration(declaration_ptr, name, scope): + """ + Private field declaration factory. + """ + if declaration_ptr is None: + raise ValueError("declaration_ptr must be valid") + if not scope in _scopes: + raise ValueError("Invalid scope provided") + + type = _bt_ctf_field_type(declaration_ptr) + declaration = None + if type == CTFTypeId.INTEGER: + declaration = IntegerFieldDeclaration.__new__(IntegerFieldDeclaration) + elif type == CTFTypeId.ENUM: + declaration = EnumerationFieldDeclaration.__new__(EnumerationFieldDeclaration) + elif type == CTFTypeId.ARRAY: + declaration = ArrayFieldDeclaration.__new__(ArrayFieldDeclaration) + elif type == CTFTypeId.SEQUENCE: + declaration = SequenceFieldDeclaration.__new__(SequenceFieldDeclaration) + elif type == CTFTypeId.FLOAT: + declaration = FloatFieldDeclaration.__new__(FloatFieldDeclaration) + elif type == CTFTypeId.STRUCT: + declaration = StructureFieldDeclaration.__new__(StructureFieldDeclaration) + elif type == CTFTypeId.STRING: + declaration = StringFieldDeclaration.__new__(StringFieldDeclaration) + elif type == CTFTypeId.VARIANT: + declaration = VariantFieldDeclaration.__new__(VariantFieldDeclaration) + else: + return declaration + + declaration._fd = declaration_ptr + declaration._s = scope + declaration._name = name + return declaration + +class _Definition(object): + def __init__(self, definition_ptr, scope): + self._d = definition_ptr + self._s = scope + if not scope in _scopes: + ValueError("Invalid scope provided") + + @property + def name(self): + """Return the name of a field or None on error.""" + return _bt_ctf_field_name(self._d) + + @property + def type(self): + """Return the type of a field or -1 if unknown.""" + return _bt_ctf_field_type(_bt_ctf_get_decl_from_def(self._d)) + + @property + def declaration(self): + """Return the associated Definition object.""" + return _create_field_declaration(_bt_ctf_get_decl_from_def(self._d), self.name, self.scope) + + def _get_enum_str(self): + """ + Return the string matching the current enumeration. + Return None on error. + """ + return _bt_ctf_get_enum_str(self._d) + + def _get_array_element_at(self, index): + """ + Return the array's element at position index. + Return None on error + """ + array_ptr = _bt_python_get_array_from_def(self._d) + if array_ptr is None: + return None + + definition_ptr = _bt_array_index(array_ptr, index) + if definition_ptr is None: + return None + return _Definition(definition_ptr, self.scope) + + def _get_sequence_len(self): + """ + Return the len of a sequence or a negative + value on error. + """ + seq = _bt_python_get_sequence_from_def(self._d) + return _bt_sequence_len(seq) + + def _get_sequence_element_at(self, index): + """ + Return the sequence's element at position index, + otherwise return None + """ + seq = _bt_python_get_sequence_from_def(self._d) + if seq is not None: + definition_ptr = _bt_sequence_index(seq, index) + if definition_ptr is not None: + return _Definition(definition_ptr, self.scope) + return None + + def _get_uint64(self): + """ + Return the value associated with the field. + If the field does not exist or is not of the type requested, + the value returned is undefined. To check if an error occured, + use the field_error() function after accessing a field. + """ + return _bt_ctf_get_uint64(self._d) + + def _get_int64(self): + """ + Return the value associated with the field. + If the field does not exist or is not of the type requested, + the value returned is undefined. To check if an error occured, + use the field_error() function after accessing a field. + """ + return _bt_ctf_get_int64(self._d) + + def _get_char_array(self): + """ + Return the value associated with the field. + If the field does not exist or is not of the type requested, + the value returned is undefined. To check if an error occurred, + use the field_error() function after accessing a field. + """ + return _bt_ctf_get_char_array(self._d) + + def _get_str(self): + """ + Return the value associated with the field. + If the field does not exist or is not of the type requested, + the value returned is undefined. To check if an error occurred, + use the field_error() function after accessing a field. + """ + return _bt_ctf_get_string(self._d) + + def _get_float(self): + """ + Return the value associated with the field. + If the field does not exist or is not of the type requested, + the value returned is undefined. To check if an error occurred, + use the field_error() function after accessing a field. + """ + return _bt_ctf_get_float(self._d) + + def _get_variant(self): + """ + Return the variant's selected field. + If the field does not exist or is not of the type requested, + the value returned is undefined. To check if an error occurred, + use the field_error() function after accessing a field. + """ + return _bt_ctf_get_variant(self._d) + + def _get_struct_field_count(self): + """ + Return the number of fields contained in the structure. + If the field does not exist or is not of the type requested, + the value returned is undefined. + """ + return _bt_ctf_get_struct_field_count(self._d) + + def _get_struct_field_at(self, i): + """ + Return the structure's field at position i. + If the field does not exist or is not of the type requested, + the value returned is undefined. To check if an error occurred, + use the field_error() function after accessing a field. + """ + return _bt_ctf_get_struct_field_index(self._d, i) + + @property + def value(self): + """ + Return the value associated with the field according to its type. + Return None on error. + """ + id = self.type + value = None + if id == CTFTypeId.STRING: + value = self._get_str() + elif id == CTFTypeId.ARRAY: + value = [] + for i in range(self.declaration.length): + element = self._get_array_element_at(i) + value.append(element.value) + elif id == CTFTypeId.INTEGER: + if self.declaration.signedness == 0: + value = self._get_uint64() + else: + value = self._get_int64() + elif id == CTFTypeId.ENUM: + value = self._get_enum_str() + elif id == CTFTypeId.SEQUENCE: + seq_len = self._get_sequence_len() + value = [] + for i in range(seq_len): + evDef = self._get_sequence_element_at(i) + value.append(evDef.value) + elif id == CTFTypeId.FLOAT: + value = self._get_float() + elif id == CTFTypeId.VARIANT: + variant = _Definition.__new__(_Definition) + variant._d = self._get_variant(); + value = variant.value + elif id == CTFTypeId.STRUCT: + value = {} + for i in range(self._get_struct_field_count()): + member = _Definition(self._get_struct_field_at(i), self.scope) + value[member.name] = member.value + + if field_error(): + raise FieldError("Error occurred while accessing field {} of type {}".format(self.name, CTFTypeId.type_name(self.declaration.type))) + return value + + @property + def scope(self): + """Return the scope of a field or None on error.""" + return self._s + +%} + + +// ================================================================= +// CTF Writer +// ================================================================= + +/* ================================================================= + CLOCK.H + ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ +*/ +%rename("_bt_ctf_clock_create") bt_ctf_clock_create(const char *name); +%rename("_bt_ctf_clock_set_description") bt_ctf_clock_set_description(struct bt_ctf_clock *clock, const char *desc); +%rename("_bt_ctf_clock_set_frequency") bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock, uint64_t freq); +%rename("_bt_ctf_clock_set_precision") bt_ctf_clock_set_precision(struct bt_ctf_clock *clock, uint64_t precision); +%rename("_bt_ctf_clock_set_offset_s") bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, uint64_t offset_s); +%rename("_bt_ctf_clock_set_offset") bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, uint64_t offset); +%rename("_bt_ctf_clock_set_is_absolute") bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock, int is_absolute); +%rename("_bt_ctf_clock_set_time") bt_ctf_clock_set_time(struct bt_ctf_clock *clock, uint64_t time); +%rename("_bt_ctf_clock_get") bt_ctf_clock_get(struct bt_ctf_clock *clock); +%rename("_bt_ctf_clock_put") bt_ctf_clock_put(struct bt_ctf_clock *clock); + +struct bt_ctf_clock *bt_ctf_clock_create(const char *name); +int bt_ctf_clock_set_description(struct bt_ctf_clock *clock, const char *desc); +int bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock, uint64_t freq); +int bt_ctf_clock_set_precision(struct bt_ctf_clock *clock, uint64_t precision); +int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, uint64_t offset_s); +int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, uint64_t offset); +int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock, int is_absolute); +int bt_ctf_clock_set_time(struct bt_ctf_clock *clock, uint64_t time); +void bt_ctf_clock_get(struct bt_ctf_clock *clock); +void bt_ctf_clock_put(struct bt_ctf_clock *clock); + +/* ================================================================= + EVENT-TYPES.H + ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ +*/ +%rename("_bt_ctf_field_type_integer_create") bt_ctf_field_type_integer_create(unsigned int size); +%rename("_bt_ctf_field_type_integer_set_signed") bt_ctf_field_type_integer_set_signed(struct bt_ctf_field_type *integer, int is_signed); +%rename("_bt_ctf_field_type_integer_set_base") bt_ctf_field_type_integer_set_base(struct bt_ctf_field_type *integer, enum bt_ctf_integer_base base); +%rename("_bt_ctf_field_type_integer_set_encoding") bt_ctf_field_type_integer_set_encoding(struct bt_ctf_field_type *integer, enum ctf_string_encoding encoding); +%rename("_bt_ctf_field_type_enumeration_create") bt_ctf_field_type_enumeration_create(struct bt_ctf_field_type *integer_container_type); +%rename("_bt_ctf_field_type_enumeration_add_mapping") bt_ctf_field_type_enumeration_add_mapping(struct bt_ctf_field_type *enumeration, const char *string, int64_t range_start, int64_t range_end); +%rename("_bt_ctf_field_type_floating_point_create") bt_ctf_field_type_floating_point_create(void); +%rename("_bt_ctf_field_type_floating_point_set_exponent_digits") bt_ctf_field_type_floating_point_set_exponent_digits(struct bt_ctf_field_type *floating_point, unsigned int exponent_digits); +%rename("_bt_ctf_field_type_floating_point_set_mantissa_digits") bt_ctf_field_type_floating_point_set_mantissa_digits(struct bt_ctf_field_type *floating_point, unsigned int mantissa_digits); +%rename("_bt_ctf_field_type_structure_create") bt_ctf_field_type_structure_create(void); +%rename("_bt_ctf_field_type_structure_add_field") bt_ctf_field_type_structure_add_field(struct bt_ctf_field_type *structure, struct bt_ctf_field_type *field_type, const char *field_name); +%rename("_bt_ctf_field_type_variant_create") bt_ctf_field_type_variant_create(struct bt_ctf_field_type *enum_tag, const char *tag_name); +%rename("_bt_ctf_field_type_variant_add_field") bt_ctf_field_type_variant_add_field(struct bt_ctf_field_type *variant, struct bt_ctf_field_type *field_type, const char *field_name); +%rename("_bt_ctf_field_type_array_create") bt_ctf_field_type_array_create(struct bt_ctf_field_type *element_type, unsigned int length); +%rename("_bt_ctf_field_type_sequence_create") bt_ctf_field_type_sequence_create(struct bt_ctf_field_type *element_type, const char *length_field_name); +%rename("_bt_ctf_field_type_string_create") bt_ctf_field_type_string_create(void); +%rename("_bt_ctf_field_type_string_set_encoding") bt_ctf_field_type_string_set_encoding(struct bt_ctf_field_type *string, enum ctf_string_encoding encoding); +%rename("_bt_ctf_field_type_set_alignment") bt_ctf_field_type_set_alignment(struct bt_ctf_field_type *type, unsigned int alignment); +%rename("_bt_ctf_field_type_set_byte_order") bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type *type, enum bt_ctf_byte_order byte_order); +%rename("_bt_ctf_field_type_get") bt_ctf_field_type_get(struct bt_ctf_field_type *type); +%rename("_bt_ctf_field_type_put") bt_ctf_field_type_put(struct bt_ctf_field_type *type); + +struct bt_ctf_field_type *bt_ctf_field_type_integer_create(unsigned int size); +int bt_ctf_field_type_integer_set_signed(struct bt_ctf_field_type *integer, int is_signed); +int bt_ctf_field_type_integer_set_base(struct bt_ctf_field_type *integer, enum bt_ctf_integer_base base); +int bt_ctf_field_type_integer_set_encoding(struct bt_ctf_field_type *integer, enum ctf_string_encoding encoding); +struct bt_ctf_field_type *bt_ctf_field_type_enumeration_create(struct bt_ctf_field_type *integer_container_type); +int bt_ctf_field_type_enumeration_add_mapping(struct bt_ctf_field_type *enumeration, const char *string, int64_t range_start, int64_t range_end); +struct bt_ctf_field_type *bt_ctf_field_type_floating_point_create(void); +int bt_ctf_field_type_floating_point_set_exponent_digits(struct bt_ctf_field_type *floating_point, unsigned int exponent_digits); +int bt_ctf_field_type_floating_point_set_mantissa_digits(struct bt_ctf_field_type *floating_point, unsigned int mantissa_digits); +struct bt_ctf_field_type *bt_ctf_field_type_structure_create(void); +int bt_ctf_field_type_structure_add_field(struct bt_ctf_field_type *structure, struct bt_ctf_field_type *field_type, const char *field_name); +struct bt_ctf_field_type *bt_ctf_field_type_variant_create(struct bt_ctf_field_type *enum_tag, const char *tag_name); +int bt_ctf_field_type_variant_add_field(struct bt_ctf_field_type *variant, struct bt_ctf_field_type *field_type, const char *field_name); +struct bt_ctf_field_type *bt_ctf_field_type_array_create(struct bt_ctf_field_type *element_type, unsigned int length); +struct bt_ctf_field_type *bt_ctf_field_type_sequence_create(struct bt_ctf_field_type *element_type, const char *length_field_name); +struct bt_ctf_field_type *bt_ctf_field_type_string_create(void); +int bt_ctf_field_type_string_set_encoding(struct bt_ctf_field_type *string, enum ctf_string_encoding encoding); +int bt_ctf_field_type_set_alignment(struct bt_ctf_field_type *type, unsigned int alignment); +int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type *type, enum bt_ctf_byte_order byte_order); +void bt_ctf_field_type_get(struct bt_ctf_field_type *type); +void bt_ctf_field_type_put(struct bt_ctf_field_type *type); + +/* ================================================================= + EVENT-FIELDS.H + ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ +*/ +%rename("_bt_ctf_field_create") bt_ctf_field_create(struct bt_ctf_field_type *type); +%rename("_bt_ctf_field_structure_get_field") bt_ctf_field_structure_get_field(struct bt_ctf_field *structure, const char *name); +%rename("_bt_ctf_field_array_get_field") bt_ctf_field_array_get_field(struct bt_ctf_field *array, uint64_t index); +%rename("_bt_ctf_field_sequence_set_length") bt_ctf_field_sequence_set_length(struct bt_ctf_field *sequence, struct bt_ctf_field *length_field); +%rename("_bt_ctf_field_sequence_get_field") bt_ctf_field_sequence_get_field(struct bt_ctf_field *sequence, uint64_t index); +%rename("_bt_ctf_field_variant_get_field") bt_ctf_field_variant_get_field(struct bt_ctf_field *variant, struct bt_ctf_field *tag); +%rename("_bt_ctf_field_enumeration_get_container") bt_ctf_field_enumeration_get_container(struct bt_ctf_field *enumeration); +%rename("_bt_ctf_field_signed_integer_set_value") bt_ctf_field_signed_integer_set_value(struct bt_ctf_field *integer, int64_t value); +%rename("_bt_ctf_field_unsigned_integer_set_value") bt_ctf_field_unsigned_integer_set_value(struct bt_ctf_field *integer, uint64_t value); +%rename("_bt_ctf_field_floating_point_set_value") bt_ctf_field_floating_point_set_value(struct bt_ctf_field *floating_point, double value); +%rename("_bt_ctf_field_string_set_value") bt_ctf_field_string_set_value(struct bt_ctf_field *string, const char *value); +%rename("_bt_ctf_field_get") bt_ctf_field_get(struct bt_ctf_field *field); +%rename("_bt_ctf_field_put") bt_ctf_field_put(struct bt_ctf_field *field); + +struct bt_ctf_field *bt_ctf_field_create(struct bt_ctf_field_type *type); +struct bt_ctf_field *bt_ctf_field_structure_get_field(struct bt_ctf_field *structure, const char *name); +struct bt_ctf_field *bt_ctf_field_array_get_field(struct bt_ctf_field *array, uint64_t index); +int bt_ctf_field_sequence_set_length(struct bt_ctf_field *sequence, struct bt_ctf_field *length_field); +struct bt_ctf_field *bt_ctf_field_sequence_get_field(struct bt_ctf_field *sequence, uint64_t index); +struct bt_ctf_field *bt_ctf_field_variant_get_field(struct bt_ctf_field *variant, struct bt_ctf_field *tag); +struct bt_ctf_field *bt_ctf_field_enumeration_get_container(struct bt_ctf_field *enumeration); +int bt_ctf_field_signed_integer_set_value(struct bt_ctf_field *integer, int64_t value); +int bt_ctf_field_unsigned_integer_set_value(struct bt_ctf_field *integer, uint64_t value); +int bt_ctf_field_floating_point_set_value(struct bt_ctf_field *floating_point, double value); +int bt_ctf_field_string_set_value(struct bt_ctf_field *string, const char *value); +void bt_ctf_field_get(struct bt_ctf_field *field); +void bt_ctf_field_put(struct bt_ctf_field *field); + +/* ================================================================= + EVENT.H + ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ +*/ +%rename("_bt_ctf_event_class_create") bt_ctf_event_class_create(const char *name); +%rename("_bt_ctf_event_class_add_field") bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class, struct bt_ctf_field_type *type, const char *name); +%rename("_bt_ctf_event_class_get") bt_ctf_event_class_get(struct bt_ctf_event_class *event_class); +%rename("_bt_ctf_event_class_put") bt_ctf_event_class_put(struct bt_ctf_event_class *event_class); +%rename("_bt_ctf_event_create") bt_ctf_event_create(struct bt_ctf_event_class *event_class); +%rename("_bt_ctf_event_set_payload") bt_ctf_event_set_payload(struct bt_ctf_event *event, const char *name, struct bt_ctf_field *value); +%rename("_bt_ctf_event_get_payload") bt_ctf_event_get_payload(struct bt_ctf_event *event, const char *name); +%rename("_bt_ctf_event_get") bt_ctf_event_get(struct bt_ctf_event *event); +%rename("_bt_ctf_event_put") bt_ctf_event_put(struct bt_ctf_event *event); + +struct bt_ctf_event_class *bt_ctf_event_class_create(const char *name); +int bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class, struct bt_ctf_field_type *type, const char *name); +void bt_ctf_event_class_get(struct bt_ctf_event_class *event_class); +void bt_ctf_event_class_put(struct bt_ctf_event_class *event_class); +struct bt_ctf_event *bt_ctf_event_create(struct bt_ctf_event_class *event_class); +int bt_ctf_event_set_payload(struct bt_ctf_event *event, const char *name, struct bt_ctf_field *value); +struct bt_ctf_field *bt_ctf_event_get_payload(struct bt_ctf_event *event, const char *name); +void bt_ctf_event_get(struct bt_ctf_event *event); +void bt_ctf_event_put(struct bt_ctf_event *event); + +/* ================================================================= + STREAM.H + ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ +*/ +%rename("_bt_ctf_stream_class_create") bt_ctf_stream_class_create(const char *name); +%rename("_bt_ctf_stream_class_set_clock") bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class *stream_class, struct bt_ctf_clock *clock); +%rename("_bt_ctf_stream_class_add_event_class") bt_ctf_stream_class_add_event_class(struct bt_ctf_stream_class *stream_class, struct bt_ctf_event_class *event_class); +%rename("_bt_ctf_stream_class_get") bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class); +%rename("_bt_ctf_stream_class_put") bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class); +%rename("_bt_ctf_stream_append_discarded_events") bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream, uint64_t event_count); +%rename("_bt_ctf_stream_append_event") bt_ctf_stream_append_event(struct bt_ctf_stream *stream, struct bt_ctf_event *event); +%rename("_bt_ctf_stream_flush") bt_ctf_stream_flush(struct bt_ctf_stream *stream); +%rename("_bt_ctf_stream_get") bt_ctf_stream_get(struct bt_ctf_stream *stream); +%rename("_bt_ctf_stream_put") bt_ctf_stream_put(struct bt_ctf_stream *stream); + +struct bt_ctf_stream_class *bt_ctf_stream_class_create(const char *name); +int bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class *stream_class, struct bt_ctf_clock *clock); +int bt_ctf_stream_class_add_event_class(struct bt_ctf_stream_class *stream_class, struct bt_ctf_event_class *event_class); +void bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class); +void bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class); +void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream, uint64_t event_count); +int bt_ctf_stream_append_event(struct bt_ctf_stream *stream, struct bt_ctf_event *event); +int bt_ctf_stream_flush(struct bt_ctf_stream *stream); +void bt_ctf_stream_get(struct bt_ctf_stream *stream); +void bt_ctf_stream_put(struct bt_ctf_stream *stream); + +/* ================================================================= + WRITER.H + ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ +*/ +%rename("_bt_ctf_writer_create") bt_ctf_writer_create(const char *path); +%rename("_bt_ctf_writer_create_stream") bt_ctf_writer_create_stream(struct bt_ctf_writer *writer, struct bt_ctf_stream_class *stream_class); +%rename("_bt_ctf_writer_add_environment_field") bt_ctf_writer_add_environment_field(struct bt_ctf_writer *writer, const char *name, const char *value); +%rename("_bt_ctf_writer_add_clock") bt_ctf_writer_add_clock(struct bt_ctf_writer *writer, struct bt_ctf_clock *clock); +%newobject bt_ctf_writer_get_metadata_string; +%rename("_bt_ctf_writer_get_metadata_string") bt_ctf_writer_get_metadata_string(struct bt_ctf_writer *writer); +%rename("_bt_ctf_writer_flush_metadata") bt_ctf_writer_flush_metadata(struct bt_ctf_writer *writer); +%rename("_bt_ctf_writer_set_byte_order") bt_ctf_writer_set_byte_order(struct bt_ctf_writer *writer, enum bt_ctf_byte_order byte_order); +%rename("_bt_ctf_writer_get") bt_ctf_writer_get(struct bt_ctf_writer *writer); +%rename("_bt_ctf_writer_put") bt_ctf_writer_put(struct bt_ctf_writer *writer); + +struct bt_ctf_writer *bt_ctf_writer_create(const char *path); +struct bt_ctf_stream *bt_ctf_writer_create_stream(struct bt_ctf_writer *writer, struct bt_ctf_stream_class *stream_class); +int bt_ctf_writer_add_environment_field(struct bt_ctf_writer *writer, const char *name, const char *value); +int bt_ctf_writer_add_clock(struct bt_ctf_writer *writer, struct bt_ctf_clock *clock); +char *bt_ctf_writer_get_metadata_string(struct bt_ctf_writer *writer); +void bt_ctf_writer_flush_metadata(struct bt_ctf_writer *writer); +int bt_ctf_writer_set_byte_order(struct bt_ctf_writer *writer, enum bt_ctf_byte_order byte_order); +void bt_ctf_writer_get(struct bt_ctf_writer *writer); +void bt_ctf_writer_put(struct bt_ctf_writer *writer); + +%pythoncode %{ + +class CTFWriter: + + class Clock: + def __init__(self, name): + self._c = _bt_ctf_clock_create(name) + if self._c is None: + raise ValueError("Invalid clock name.") + + def __del__(self): + _bt_ctf_clock_put(self._c) + + """ + Get the clock's description. + """ + @property + def description(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set the clock's description. The description appears in the clock's TSDL + meta-data. + """ + @description.setter + def description(self, desc): + ret = _bt_ctf_clock_set_description(self._c, str(desc)) + if ret < 0: + raise ValueError("Invalid clock description.") + + """ + Get the clock's frequency (Hz). + """ + @property + def frequency(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set the clock's frequency (Hz). + """ + @frequency.setter + def frequency(self, freq): + ret = _bt_ctf_clock_set_frequency(self._c, freq) + if ret < 0: + raise ValueError("Invalid frequency value.") + + """ + Get the clock's precision (in clock ticks). + """ + @property + def precision(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set the clock's precision (in clock ticks). + """ + @precision.setter + def precision(self, precision): + ret = _bt_ctf_clock_set_precision(self._c, precision) + + """ + Get the clock's offset in seconds from POSIX.1 Epoch. + """ + @property + def offset_seconds(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set the clock's offset in seconds from POSIX.1 Epoch. + """ + @offset_seconds.setter + def offset_seconds(self, offset_s): + ret = _bt_ctf_clock_set_offset_s(self._c, offset_s) + if ret < 0: + raise ValueError("Invalid offset value.") + + """ + Get the clock's offset in ticks from POSIX.1 Epoch + offset in seconds. + """ + @property + def offset(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set the clock's offset in ticks from POSIX.1 Epoch + offset in seconds. + """ + @offset.setter + def offset(self, offset): + ret = _bt_ctf_clock_set_offset(self._c, offset) + if ret < 0: + raise ValueError("Invalid offset value.") + + """ + Get a clock's absolute attribute. A clock is absolute if the clock + is a global reference across the trace's other clocks. + """ + @property + def absolute(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set a clock's absolute attribute. A clock is absolute if the clock + is a global reference across the trace's other clocks. + """ + @absolute.setter + def absolute(self, is_absolute): + ret = _bt_ctf_clock_set_is_absolute(self._c, int(is_absolute)) + if ret < 0: + raise ValueError("Could not set the clock's absolute attribute.") + + """ + Get the current time in nanoseconds since the clock's origin (offset and + offset_s attributes). + """ + @property + def time(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set the current time in nanoseconds since the clock's origin (offset and + offset_s attributes). The clock's value will be sampled as events are + appended to a stream. + """ + @time.setter + def time(self, time): + ret = _bt_ctf_clock_set_time(self._c, time) + if ret < 0: + raise ValueError("Invalid time value.") + + class FieldDeclaration: + """ + FieldDeclaration should not be instantiated directly. Please instantiate + one of the concrete FieldDeclaration classes. + """ + class IntegerBase: + # These values are based on the bt_ctf_integer_base enum + # declared in event-types.h. + INTEGER_BASE_UNKNOWN = -1 + INTEGER_BASE_BINARY = 2 + INTEGER_BASE_OCTAL = 8 + INTEGER_BASE_DECIMAL = 10 + INTEGER_BASE_HEXADECIMAL = 16 + + def __init__(self): + if self._ft is None: + raise ValueError("FieldDeclaration creation failed.") + + def __del__(self): + _bt_ctf_field_type_put(self._ft) + + """ + Get the field type's alignment. + """ + @property + def alignment(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set the field type's alignment. Defaults to 1 (bit-aligned). However, + some types, such as structures and string, may impose other alignment + constraints. + """ + @alignment.setter + def alignment(self, alignment): + ret = _bt_ctf_field_type_set_alignment(self._ft, alignment) + if ret < 0: + raise ValueError("Invalid alignment value.") + + """ + Get the field type's byte order. One of the ByteOrder's constant. + """ + @property + def byte_order(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set the field type's byte order. Use constants defined in the ByteOrder + class. + """ + @byte_order.setter + def byte_order(self, byte_order): + ret = _bt_ctf_field_type_set_byte_order(self._ft, byte_order) + if ret < 0: + raise ValueError("Could not set byte order value.") + + class IntegerFieldDeclaration(FieldDeclaration): + """ + Create a new integer field type of the given size. + """ + def __init__(self, size): + self._ft = _bt_ctf_field_type_integer_create(size) + super().__init__() + + """ + Get an integer's signedness attribute. + """ + @property + def signed(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set an integer's signedness attribute. + """ + @signed.setter + def signed(self, signed): + ret = _bt_ctf_field_type_integer_set_signed(self._ft, signed) + if ret < 0: + raise ValueError("Could not set signed attribute.") + + """ + Get the integer's base used to pretty-print the resulting trace. + """ + @property + def base(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set the integer's base used to pretty-print the resulting trace. + The base must be a constant of the IntegerBase class. + """ + @base.setter + def base(self, base): + ret = _bt_ctf_field_type_integer_set_base(self._ft, base) + if ret < 0: + raise ValueError("Could not set base value.") + + """ + Get the integer's encoding (one of the constants of the + CTFStringEncoding class). + """ + @property + def encoding(self): + raise NotImplementedError("Getter not implemented.") + + """ + An integer encoding may be set to signal that the integer must be printed + as a text character. Must be a constant from the CTFStringEncoding class. + """ + @encoding.setter + def encoding(self, encoding): + ret = _bt_ctf_field_type_integer_set_encoding(self._ft, encoding) + if ret < 0: + raise ValueError("Could not set integer encoding.") + + class EnumerationFieldDeclaration(FieldDeclaration): + """ + Create a new enumeration field type with the given underlying type. + """ + def __init__(self, integer_type): + if integer_type is None or not isinstance(integer_type, CTFWriter.IntegerFieldDeclaration): + raise TypeError("Invalid integer container.") + + self._ft = _bt_ctf_field_type_enumeration_create(integer_type._ft) + super().__init__() + + """ + Add a mapping to the enumeration. The range's values are inclusive. + """ + def add_mapping(self, name, range_start, range_end): + ret = _bt_ctf_field_type_enumeration_add_mapping(self._ft, str(name), range_start, range_end) + if ret < 0: + raise ValueError("Could not add mapping to enumeration type.") + + class FloatFieldDeclaration(FieldDeclaration): + FLT_EXP_DIG = 8 + DBL_EXP_DIG = 11 + FLT_MANT_DIG = 24 + DBL_MANT_DIG = 53 + + """ + Create a new floating point field type. + """ + def __init__(self): + self._ft = _bt_ctf_field_type_floating_point_create() + super().__init__() + + """ + Get the number of exponent digits to use to store the floating point field. + """ + @property + def exponent_digits(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set the number of exponent digits to use to store the floating point field. + The only values currently supported are FLT_EXP_DIG and DBL_EXP_DIG which + are defined as constants of this class. + """ + @exponent_digits.setter + def exponent_digits(self, exponent_digits): + ret = _bt_ctf_field_type_floating_point_set_exponent_digits(self._ft, exponent_digits) + if ret < 0: + raise ValueError("Could not set exponent digit count.") + + """ + Get the number of mantissa digits to use to store the floating point field. + """ + @property + def mantissa_digits(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set the number of mantissa digits to use to store the floating point field. + The only values currently supported are FLT_MANT_DIG and DBL_MANT_DIG which + are defined as constants of this class. + """ + @mantissa_digits.setter + def mantissa_digits(self, mantissa_digits): + ret = _bt_ctf_field_type_floating_point_set_mantissa_digits(self._ft, mantissa_digits) + if ret < 0: + raise ValueError("Could not set mantissa digit count.") + + class StructureFieldDeclaration(FieldDeclaration): + """ + Create a new structure field type. + """ + def __init__(self): + self._ft = _bt_ctf_field_type_structure_create() + super().__init__() + + """ + Add a field of type "field_type" to the structure. + """ + def add_field(self, field_type, field_name): + ret = _bt_ctf_field_type_structure_add_field(self._ft, field_type._ft, str(field_name)) + if ret < 0: + raise ValueError("Could not add field to structure.") + + class VariantFieldDeclaration(FieldDeclaration): + """ + Create a new variant field type. + """ + def __init__(self, enum_tag, tag_name): + if enum_tag is None or not isinstance(enum_tag, CTFWriter.EnumerationFieldDeclaration): + raise TypeError("Invalid tag type; must be of type EnumerationFieldDeclaration.") + + self._ft = _bt_ctf_field_type_variant_create(enum_tag._ft, str(tag_name)) + super().__init__() + + """ + Add a field of type "field_type" to the variant. + """ + def add_field(self, field_type, field_name): + ret = _bt_ctf_field_type_variant_add_field(self._ft, field_type._ft, str(field_name)) + if ret < 0: + raise ValueError("Could not add field to variant.") + + class ArrayFieldDeclaration(FieldDeclaration): + """ + Create a new array field type. + """ + def __init__(self, element_type, length): + self._ft = _bt_ctf_field_type_array_create(element_type._ft, length) + super().__init__() + + class SequenceFieldDeclaration(FieldDeclaration): + """ + Create a new sequence field type. + """ + def __init__(self, element_type, length_field_name): + self._ft = _bt_ctf_field_type_sequence_create(element_type._ft, str(length_field_name)) + super().__init__() + + class StringFieldDeclaration(FieldDeclaration): + """ + Create a new string field type. + """ + def __init__(self): + self._ft = _bt_ctf_field_type_string_create() + super().__init__() + + """ + Get a string type's encoding (a constant from the CTFStringEncoding class). + """ + @property + def encoding(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set a string type's encoding. Must be a constant from the CTFStringEncoding class. + """ + @encoding.setter + def encoding(self, encoding): + ret = _bt_ctf_field_type_string_set_encoding(self._ft, encoding) + if ret < 0: + raise ValueError("Could not set string encoding.") + + """ + Create an instance of a field. + """ + @staticmethod + def create_field(self, field_type): + if field_type is None or not isinstance(field_type, CTFWriter.FieldDeclaration): + raise TypeError("Invalid field_type. Type must be a FieldDeclaration-derived class.") + + if isinstance(field_type, CTFWriter.IntegerFieldDeclaration): + return CTFWriter.IntegerField(field_type) + elif isinstance(field_type, CTFWriter.EnumerationFieldDeclaration): + return CTFWriter.EnumerationField(field_type) + elif isinstance(field_type, CTFWriter.FloatFieldDeclaration): + return CTFWriter.FloatFieldingPoint(field_type) + elif isinstance(field_type, CTFWriter.StructureFieldDeclaration): + return CTFWriter.StructureField(field_type) + elif isinstance(field_type, CTFWriter.VariantFieldDeclaration): + return CTFWriter.VariantField(field_type) + elif isinstance(field_type, CTFWriter.ArrayFieldDeclaration): + return CTFWriter.ArrayField(field_type) + elif isinstance(field_type, CTFWriter.SequenceFieldDeclaration): + return CTFWriter.SequenceField(field_type) + elif isinstance(field_type, CTFWriter.StringFieldDeclaration): + return CTFWriter.StringField(field_type) + + class Field: + """ + Base class, do not instantiate. + """ + def __init__(self, field_type): + if not isinstance(field_type, CTFWriter.FieldDeclaration): + raise TypeError("Invalid field_type argument.") + + self._f = _bt_ctf_field_create(field_type._ft) + if self._f is None: + raise ValueError("Field creation failed.") + + def __del__(self): + _bt_ctf_field_put(self._f) + + @staticmethod + def _create_field_from_native_instance(native_field_instance): + type_dict = { + CTFTypeId.INTEGER : CTFWriter.IntegerField, + CTFTypeId.FLOAT : CTFWriter.FloatFieldingPoint, + CTFTypeId.ENUM : CTFWriter.EnumerationField, + CTFTypeId.STRING : CTFWriter.StringField, + CTFTypeId.STRUCT : CTFWriter.StructureField, + CTFTypeId.VARIANT : CTFWriter.VariantField, + CTFTypeId.ARRAY : CTFWriter.ArrayField, + CTFTypeId.SEQUENCE : CTFWriter.SequenceField + } + + field_type = _bt_python_get_field_type(native_field_instance) + if field_type == CTFTypeId.UNKNOWN: + raise TypeError("Invalid field instance") + + field = CTFWriter.Field.__new__(CTFWriter.Field) + field._f = native_field_instance + field.__class__ = type_dict[field_type] + return field + + class IntegerField(Field): + """ + Get an integer field's value. + """ + @property + def value(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set an integer field's value. + """ + @value.setter + def value(self, value): + signedness = _bt_python_field_integer_get_signedness(self._f) + if signedness < 0: + raise TypeError("Invalid integer instance.") + + if signedness == 0: + ret = _bt_ctf_field_unsigned_integer_set_value(self._f, value) + else: + ret = _bt_ctf_field_signed_integer_set_value(self._f, value) + + if ret < 0: + raise ValueError("Could not set integer field value.") + + class EnumerationField(Field): + """ + Return the enumeration's underlying container field (an integer field). + """ + @property + def container(self): + container = CTFWriter.IntegerField.__new__(CTFWriter.IntegerField) + container._f = _bt_ctf_field_enumeration_get_container(self._f) + if container._f is None: + raise TypeError("Invalid enumeration field type.") + return container + + class FloatFieldingPoint(Field): + """ + Get a floating point field's value. + """ + @property + def value(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set a floating point field's value. + """ + @value.setter + def value(self, value): + ret = _bt_ctf_field_floating_point_set_value(self._f, float(value)) + if ret < 0: + raise ValueError("Could not set floating point field value.") + + class StructureField(Field): + """ + Get the structure's field corresponding to the provided field name. + """ + def field(self, field_name): + native_instance = _bt_ctf_field_structure_get_field(self._f, str(field_name)) + if native_instance is None: + raise ValueError("Invalid field_name provided.") + return CTFWriter.Field._create_field_from_native_instance(native_instance) + + class VariantField(Field): + """ + Return the variant's selected field. The "tag" field is the selector enum field. + """ + def field(self, tag): + native_instance = _bt_ctf_field_variant_get_field(self._f, tag._f) + if native_instance is None: + raise ValueError("Invalid tag provided.") + return CTFWriter.Field._create_field_from_native_instance(native_instance) + + class ArrayField(Field): + """ + Return the array's field at position "index". + """ + def field(self, index): + native_instance = _bt_ctf_field_array_get_field(self._f, index) + if native_instance is None: + raise IndexError("Invalid index provided.") + return CTFWriter.Field._create_field_from_native_instance(native_instance) + + class SequenceField(Field): + """ + Get the sequence's length field (IntegerField). + """ + @property + def length(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set the sequence's length field (IntegerField). + """ + @length.setter + def length(self, length_field): + if not isinstance(length, CTFWriter.IntegerField): + raise TypeError("Invalid length field.") + ret = _bt_ctf_field_sequence_set_length(self._f, length._f) + if ret < 0: + raise ValueError("Could not set sequence length.") + + """ + Return the sequence's field at position "index". + """ + def field(self, index): + native_instance = _bt_ctf_field_sequence_get_field(self._f, index) + if native_instance is None: + raise ValueError("Could not get sequence element at index.") + return CTFWriter.Field._create_field_from_native_instance(native_instance) + + class StringField(Field): + """ + Get a string field's value. + """ + @property + def value(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set a string field's value. + """ + @value.setter + def value(self, value): + ret = _bt_ctf_field_string_set_value(self._f, str(value)) + if ret < 0: + raise ValueError("Could not set string field value.") + + class EventClass: + """ + Create a new event class of the given name. + """ + def __init__(self, name): + self._ec = _bt_ctf_event_class_create(name) + if self._ec is None: + raise ValueError("Event class creation failed.") + + def __del__(self): + _bt_ctf_event_class_put(self._ec) + + """ + Add a field of type "field_type" to the event class. + """ + def add_field(self, field_type, field_name): + ret = _bt_ctf_event_class_add_field(self._ec, field_type._ft, str(field_name)) + if ret < 0: + raise ValueError("Could not add field to event class.") + + class Event: + """ + Create a new event of the given event class. + """ + def __init__(self, event_class): + if not isinstance(event_class, CTFWriter.EventClass): + raise TypeError("Invalid event_class argument.") + + self._e = _bt_ctf_event_create(event_class._ec) + if self._e is None: + raise ValueError("Event creation failed.") + + def __del__(self): + _bt_ctf_event_put(self._e) + + """ + Set a manually created field as an event's payload. + """ + def set_payload(self, field_name, value_field): + if not isinstance(value, CTFWriter.Field): + raise TypeError("Invalid value type.") + ret = _bt_ctf_event_set_payload(self._e, str(field_name), value._f) + if ret < 0: + raise ValueError("Could not set event field payload.") + + """ + Get a field from event. + """ + def payload(self, field_name): + native_instance = _bt_ctf_event_get_payload(self._e, str(field_name)) + if native_instance is None: + raise ValueError("Could not get event payload.") + return CTFWriter.Field._create_field_from_native_instance(native_instance) + + class StreamClass: + """ + Create a new stream class of the given name. + """ + def __init__(self, name): + self._sc = _bt_ctf_stream_class_create(name) + if self._sc is None: + raise ValueError("Stream class creation failed.") + + def __del__(self): + _bt_ctf_stream_class_put(self._sc) + + """ + Get a stream class' clock. + """ + @property + def clock(self): + raise NotImplementedError("Getter not implemented.") + + """ + Assign a clock to a stream class. + """ + @clock.setter + def clock(self, clock): + if not isinstance(clock, CTFWriter.Clock): + raise TypeError("Invalid clock type.") + + ret = _bt_ctf_stream_class_set_clock(self._sc, clock._c) + if ret < 0: + raise ValueError("Could not set stream class clock.") + + """ + Add an event class to a stream class. New events can be added even after a + stream has been instantiated and events have been appended. However, a stream + will not accept events of a class that has not been registered beforehand. + """ + def add_event_class(self, event_class): + if not isinstance(event_class, CTFWriter.EventClass): + raise TypeError("Invalid event_class type.") + + ret = _bt_ctf_stream_class_add_event_class(self._sc, event_class._ec) + if ret < 0: + raise ValueError("Could not add event class.") + + class Stream: + """ + Create a stream of the given class. + """ + def __init__(self, stream_class): + if not isinstance(stream_class, CTFWriter.StreamClass): + raise TypeError("Invalid stream_class type.") + + self._s = _bt_ctf_stream_create(stream_class._sc) + if self._s is None: + raise ValueError("Stream creation failed.") + + def __del__(self): + _bt_ctf_stream_put(self._s) + + """ + Increase the current packet's discarded event count. + """ + def append_discarded_events(self, event_count): + ret = _bt_ctf_stream_append_discarded_events(self._s, event_count) + if ret < 0: + raise ValueError("Could not append discarded events.") + + """ + Append "event" to the stream's current packet. The stream's associated clock + will be sampled during this call. The event shall not be modified after + being appended to a stream. + """ + def append_event(self, event): + ret = _bt_ctf_stream_append_event(self._s, event._e) + if ret < 0: + raise ValueError("Could not append event to stream.") + + """ + The stream's current packet's events will be flushed to disk. Events + subsequently appended to the stream will be added to a new packet. + """ + def flush(self): + ret = _bt_ctf_stream_flush(self._s) + if ret < 0: + raise ValueError("Could not flush stream.") + + class Writer: + """ + Create a new writer that will produce a trace in the given path. + """ + def __init__(self, path): + self._w = _bt_ctf_writer_create(path) + if self._w is None: + raise ValueError("Writer creation failed.") + + def __del__(self): + _bt_ctf_writer_put(self._w) + + """ + Create a new stream instance and register it to the writer. + """ + def create_stream(self, stream_class): + if not isinstance(stream_class, CTFWriter.StreamClass): + raise TypeError("Invalid stream_class type.") + + stream = CTFWriter.Stream.__new__(CTFWriter.Stream) + stream._s = _bt_ctf_writer_create_stream(self._w, stream_class._sc) + return stream + + """ + Add an environment field to the trace. + """ + def add_environment_field(self, name, value): + ret = _bt_ctf_writer_add_environment_field(self._w, str(name), str(value)) + if ret < 0: + raise ValueError("Could not add environment field to trace.") + + """ + Add a clock to the trace. Clocks assigned to stream classes must be + registered to the writer. + """ + def add_clock(self, clock): + ret = _bt_ctf_writer_add_clock(self._w, clock._c) + if ret < 0: + raise ValueError("Could not add clock to Writer.") + + """ + Get the trace's TSDL meta-data. + """ + @property + def metadata(self): + return _bt_ctf_writer_get_metadata_string(self._w) + + """ + Flush the trace's metadata to the metadata file. + """ + def flush_metadata(self): + _bt_ctf_writer_flush_metadata(self._w) + + """ + Get the trace's byte order. Must be a constant from the ByteOrder + class. + """ + @property + def byte_order(self): + raise NotImplementedError("Getter not implemented.") + + """ + Set the trace's byte order. Must be a constant from the ByteOrder + class. Defaults to BYTE_ORDER_NATIVE, the host machine's endianness. + """ + @byte_order.setter + def byte_order(self, byte_order): + ret = _bt_ctf_writer_set_byte_order(self._w, byte_order) + if ret < 0: + raise ValueError("Could not set trace's byte order.") + +%} diff --git a/bindings/python/examples/babeltrace_and_lttng.py b/bindings/python/examples/babeltrace_and_lttng.py new file mode 100644 index 00000000..42ebc85e --- /dev/null +++ b/bindings/python/examples/babeltrace_and_lttng.py @@ -0,0 +1,118 @@ +#!/usr/bin/env python3 +# babeltrace_and_lttng.py +# +# Babeltrace and LTTng example script +# +# Copyright 2012 EfficiOS Inc. +# +# Author: Danny Serres +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. + + +# This script uses both lttng-tools and babeltrace +# python modules. It creates a session, enables +# events, starts tracing for 2 seconds, stops tracing, +# destroys the session and outputs the trace in the +# specified output file. +# +# WARNING: will destroy any existing trace having +# the same name as ses_name + + +# ------------------------------------------------------ +ses_name = "babeltrace-lttng-test" +trace_path = "/lttng-traces/babeltrace-lttng-trace/" +out_file = "babeltrace-lttng-trace-text-output.txt" +# ------------------------------------------------------ + + +import time +try: + import babeltrace, lttng +except ImportError: + raise ImportError( "both babeltrace and lttng-tools " + "python modules must be installed" ) + + +# Errors to raise if something goes wrong +class LTTngError(Exception): + pass +class BabeltraceError(Exception): + pass + + +# LTTNG-TOOLS + +# Making sure session does not already exist +lttng.destroy(ses_name) + +# Creating a new session and handle +ret = lttng.create(ses_name,trace_path) +if ret < 0: + raise LTTngError(lttng.strerror(ret)) + +domain = lttng.Domain() +domain.type = lttng.DOMAIN_KERNEL + +han = None +han = lttng.Handle(ses_name, domain) +if han is None: + raise LTTngError("Handle not created") + + +# Enabling all events +event = lttng.Event() +event.type = lttng.EVENT_ALL +event.loglevel_type = lttng.EVENT_LOGLEVEL_ALL +ret = lttng.enable_event(han, event, None) +if ret < 0: + raise LTTngError(lttng.strerror(ret)) + +# Start, wait, stop +ret = lttng.start(ses_name) +if ret < 0: + raise LTTngError(lttng.strerror(ret)) +print("Tracing...") +time.sleep(2) +print("Stopped.") +ret = lttng.stop(ses_name) +if ret < 0: + raise LTTngError(lttng.strerror(ret)) + + +# Destroying tracing session +ret = lttng.destroy(ses_name) +if ret < 0: + raise LTTngError(lttng.strerror(ret)) + + +# BABELTRACE + +# Create TraceCollecion and add trace: +traces = babeltrace.TraceCollection() +ret = traces.add_trace(trace_path + "/kernel", "ctf") +if ret is None: + raise BabeltraceError("Error adding trace") + +# Reading events from trace +# and outputting timestamps and event names +# in out_file +print("Writing trace file...") +output = open(out_file, "wt") + +for event in traces.events: + output.write("TS: {}, {} : {}\n".format(event.timestamp, event.cycles, event.name)) + +# Closing file +output.close() + +print("Done.") diff --git a/bindings/python/examples/ctf_writer.py b/bindings/python/examples/ctf_writer.py new file mode 100644 index 00000000..e3d48fc1 --- /dev/null +++ b/bindings/python/examples/ctf_writer.py @@ -0,0 +1,99 @@ +#!/usr/bin/env python3 +# ctf_writer.py +# +# Babeltrace CTF Writer example script. +# +# Copyright 2013 EfficiOS Inc. +# +# Author: Jérémie Galarneau +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. + +import sys +import tempfile +from babeltrace import * + +trace_path = tempfile.mkdtemp() + +print("Writing trace at {}".format(trace_path)) +writer = CTFWriter.Writer(trace_path) + +clock = CTFWriter.Clock("A_clock") +clock.description = "Simple clock" + +writer.add_clock(clock) +writer.add_environment_field("Python_version", str(sys.version_info)) + +stream_class = CTFWriter.StreamClass("test_stream") +stream_class.clock = clock + +event_class = CTFWriter.EventClass("SimpleEvent") + +# Create a int32_t equivalent type +int32_type = CTFWriter.IntegerFieldDeclaration(32) +int32_type.signed = True + +# Create a string type +string_type = CTFWriter.StringFieldDeclaration() + +# Create a structure type containing both an integer and a string +structure_type = CTFWriter.StructureFieldDeclaration() +structure_type.add_field(int32_type, "an_integer") +structure_type.add_field(string_type, "a_string_field") +event_class.add_field(structure_type, "structure_field") + +# Create a floating point type +floating_point_type = CTFWriter.FloatFieldDeclaration() +floating_point_type.exponent_digits = CTFWriter.FloatFieldDeclaration.FLT_EXP_DIG +floating_point_type.mantissa_digits = CTFWriter.FloatFieldDeclaration.FLT_MANT_DIG +event_class.add_field(floating_point_type, "float_field") + +# Create an enumeration type +int10_type = CTFWriter.IntegerFieldDeclaration(10) +enumeration_type = CTFWriter.EnumerationFieldDeclaration(int10_type) +enumeration_type.add_mapping("FIRST_ENTRY", 0, 4) +enumeration_type.add_mapping("SECOND_ENTRY", 5, 5) +enumeration_type.add_mapping("THIRD_ENTRY", 6, 10) +event_class.add_field(enumeration_type, "enum_field") + +# Create an array type +array_type = CTFWriter.ArrayFieldDeclaration(int10_type, 5) +event_class.add_field(array_type, "array_field") + +stream_class.add_event_class(event_class) +stream = writer.create_stream(stream_class) + +for i in range(100): + event = CTFWriter.Event(event_class) + + clock.time = i * 1000 + structure_field = event.payload("structure_field") + integer_field = structure_field.field("an_integer") + integer_field.value = i + + string_field = structure_field.field("a_string_field") + string_field.value = "Test string." + + float_field = event.payload("float_field") + float_field.value = float(i) + (float(i) / 100.0) + + array_field = event.payload("array_field") + for j in range(5): + element = array_field.field(j) + element.value = i + j + + enumeration_field = event.payload("enum_field") + integer_field = enumeration_field.container + integer_field.value = i % 10 + + stream.append_event(event) + +stream.flush() diff --git a/bindings/python/examples/example-api-test.py b/bindings/python/examples/example-api-test.py new file mode 100644 index 00000000..56a8f88f --- /dev/null +++ b/bindings/python/examples/example-api-test.py @@ -0,0 +1,60 @@ +#!/usr/bin/env python3 +# example_api_test.py +# +# Babeltrace example script based on the Babeltrace API test script +# +# Copyright 2012 EfficiOS Inc. +# +# Author: Danny Serres +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. + +# This example uses the babeltrace python module +# to partially test the api. + +import sys +from babeltrace import * + +# Check for path arg: +if len(sys.argv) < 2: + raise TypeError("Usage: python example-api-test.py path/to/file") + +# Create TraceCollection and add trace: +traces = TraceCollection() +trace_handle = traces.add_trace(sys.argv[1], "ctf") +if trace_handle is None: + raise IOError("Error adding trace") + +# Listing events +print("--- Event list ---") +for event_declaration in trace_handle.events: + print("event : {}".format(event_declaration.name)) + if event_declaration.name == "sched_switch": + for field_declaration in event_declaration.fields: + print(field_declaration) +print("--- Done ---") + +for event in traces.events: + print("TS: {}, {} : {}".format(event.timestamp, event.cycles, event.name)) + + if event.name == "sched_switch": + prev_comm = event["prev_comm"] + if prev_comm is None: + print("ERROR: Missing prev_comm context info") + else: + print("sched_switch prev_comm: {}".format(prev_comm)) + + if event.name == "exit_syscall": + ret_code = event["ret"] + if ret_code is None: + print("ERROR: Unable to extract ret") + else: + print("exit_syscall ret: {}".format(ret_code)) diff --git a/bindings/python/examples/sched_switch.py b/bindings/python/examples/sched_switch.py new file mode 100644 index 00000000..ce116c14 --- /dev/null +++ b/bindings/python/examples/sched_switch.py @@ -0,0 +1,70 @@ +#!/usr/bin/env python3 +# sched_switch.py +# +# Babeltrace example script with sched_switch events +# +# Copyright 2012 EfficiOS Inc. +# +# Author: Danny Serres +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. + +# The script takes one optional argument (pid) +# The script will read events based on pid and +# print the scheduler switches happening with the process. +# If no arguments are passed, it displays all the scheduler switches. +# This can be used to understand which tasks schedule out the current +# process being traced, and when it gets scheduled in again. +# The trace needs PID context (lttng add-context -k -t pid) + +import sys +from babeltrace import * + +if len(sys.argv) < 2 or len(sys.argv) > 3: + raise TypeError("Usage: python sched_switch.py [pid] path/to/trace") +elif len(sys.argv) == 3: + usePID = True +else: + usePID = False + +traces = TraceCollection() +ret = traces.add_trace(sys.argv[len(sys.argv)-1], "ctf") +if ret is None: + raise IOError("Error adding trace") + +for event in traces.events: + while True: + if event.name == "sched_switch": + # Getting PID + pid = event.field_with_scope("pid", CTFScope.STREAM_EVENT_CONTEXT) + if pid is None: + print("ERROR: Missing PID info for sched_switch") + break # Next event + + if usePID and (pid != long(sys.argv[1])): + break # Next event + + prev_comm = event["prev_comm"] + prev_tid = event["prev_tid"] + prev_prio = event["prev_prio"] + prev_state = event["prev_state"] + next_comm = event["next_comm"] + next_tid = event["next_tid"] + next_prio = event["next_prio"] + + # Output + print("sched_switch, pid = {}, TS = {}, prev_comm = {},\n\t" + "prev_tid = {}, prev_prio = {}, prev_state = {},\n\t" + "next_comm = {}, next_tid = {}, next_prio = {}".format( + pid, event.timestamp, prev_comm, prev_tid, + prev_prio, prev_state, next_comm, next_tid, next_prio)) + + break # Next event diff --git a/bindings/python/examples/sequence_test.py b/bindings/python/examples/sequence_test.py new file mode 100644 index 00000000..c6313b7e --- /dev/null +++ b/bindings/python/examples/sequence_test.py @@ -0,0 +1,58 @@ +#!/usr/bin/env python3 +# sequence_test.py +# +# Babeltrace example script based on the Babeltrace API test script +# +# Copyright 2013 Xiaona Han +# Copyright 2012 EfficiOS Inc. +# +# Author: Danny Serres +# Author: Xiaona Han +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. + +# This example uses the babeltrace python module +# to partially test the sequence API + +import sys +from babeltrace import * + +# Check for path arg: +if len(sys.argv) < 2: + raise TypeError("Usage: sequence_test.py path/to/file") + +# Create TraceCollection and add trace: +traces = TraceCollection() +trace_handle = traces.add_trace(sys.argv[1], "ctf") +if trace_handle is None: + raise IOError("Error adding trace") + +# Listing events +print("--- Event list ---") +for event_declaration in trace_handle.events: + print("event : {}".format(event_declaration.name)) +print("--- Done ---") + +for event in traces.events: + print("TS: {}, {} : {}".format(event.timestamp, + event.cycles, event.name)) + + try: + sequence = event["seq_int_field"] + print("int sequence values: {}". format(sequence)) + except KeyError: + pass + + try: + sequence = event["seq_long_field"] + print("long sequence values: {}". format(sequence)) + except KeyError: + pass diff --git a/bindings/python/python-complements.c b/bindings/python/python-complements.c new file mode 100644 index 00000000..b6f1d5a8 --- /dev/null +++ b/bindings/python/python-complements.c @@ -0,0 +1,176 @@ +/* + * python-complements.c + * + * Babeltrace Python module complements, required for Python bindings + * + * Copyright 2012 EfficiOS Inc. + * + * Author: Danny Serres + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + */ + +#include "python-complements.h" +#include +#include + +/* FILE functions + ---------------------------------------------------- +*/ + +FILE *_bt_file_open(char *file_path, char *mode) +{ + FILE *fp = stdout; + if (file_path != NULL) + fp = fopen(file_path, mode); + return fp; +} + +void _bt_file_close(FILE *fp) +{ + if (fp != NULL) + fclose(fp); +} + + +/* List-related functions + ---------------------------------------------------- +*/ + +/* ctf-field-list */ +struct bt_definition **_bt_python_field_listcaller( + const struct bt_ctf_event *ctf_event, + const struct bt_definition *scope, + unsigned int *len) +{ + struct bt_definition **list; + int ret; + + ret = bt_ctf_get_field_list(ctf_event, scope, + (const struct bt_definition * const **)&list, len); + + if (ret < 0) /* For python to know an error occured */ + list = NULL; + + return list; +} + +struct bt_definition *_bt_python_field_one_from_list( + struct bt_definition **list, int index) +{ + return list[index]; +} + +/* event_decl_list */ +struct bt_ctf_event_decl **_bt_python_event_decl_listcaller( + int handle_id, + struct bt_context *ctx, + unsigned int *len) +{ + struct bt_ctf_event_decl **list; + int ret; + + ret = bt_ctf_get_event_decl_list(handle_id, ctx, + (struct bt_ctf_event_decl * const **)&list, len); + + if (ret < 0) /* For python to know an error occured */ + list = NULL; + + return list; +} + +struct bt_ctf_event_decl *_bt_python_decl_one_from_list( + struct bt_ctf_event_decl **list, int index) +{ + return list[index]; +} + +/* decl_fields */ +struct bt_ctf_field_decl **_by_python_field_decl_listcaller( + struct bt_ctf_event_decl *event_decl, + enum bt_ctf_scope scope, + unsigned int *len) +{ + struct bt_ctf_field_decl **list; + int ret; + + ret = bt_ctf_get_decl_fields(event_decl, scope, + (const struct bt_ctf_field_decl * const **)&list, len); + + if (ret < 0) /* For python to know an error occured */ + list = NULL; + + return list; +} + +struct bt_ctf_field_decl *_bt_python_field_decl_one_from_list( + struct bt_ctf_field_decl **list, int index) +{ + return list[index]; +} + +struct definition_array *_bt_python_get_array_from_def( + struct bt_definition *field) +{ + const struct bt_declaration *array_decl; + struct definition_array *array = NULL; + + if (!field) { + goto end; + } + + array_decl = bt_ctf_get_decl_from_def(field); + if (bt_ctf_field_type(array_decl) == CTF_TYPE_ARRAY) { + array = container_of(field, struct definition_array, p); + } +end: + return array; +} + +struct definition_sequence *_bt_python_get_sequence_from_def( + struct bt_definition *field) +{ + if (field && bt_ctf_field_type( + bt_ctf_get_decl_from_def(field)) == CTF_TYPE_SEQUENCE) { + return container_of(field, struct definition_sequence, p); + } + + return NULL; +} + +int _bt_python_field_integer_get_signedness(const struct bt_ctf_field *field) +{ + int ret; + + if (!field || field->type->declaration->id != CTF_TYPE_INTEGER) { + ret = -1; + goto end; + } + + const struct bt_ctf_field_type_integer *type = container_of(field->type, + const struct bt_ctf_field_type_integer, parent); + ret = type->declaration.signedness; +end: + return ret; +} + +enum ctf_type_id _bt_python_get_field_type(const struct bt_ctf_field *field) +{ + enum ctf_type_id type_id = CTF_TYPE_UNKNOWN; + + if (!field) { + goto end; + } + + type_id = field->type->declaration->id; +end: + return type_id; +} diff --git a/bindings/python/python-complements.h b/bindings/python/python-complements.h new file mode 100644 index 00000000..43b77197 --- /dev/null +++ b/bindings/python/python-complements.h @@ -0,0 +1,67 @@ +/* + * python-complements.h + * + * Babeltrace Python module complements header, required for Python bindings + * + * Copyright 2012 EfficiOS Inc. + * + * Author: Danny Serres + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +/* File */ +FILE *_bt_file_open(char *file_path, char *mode); +void _bt_file_close(FILE *fp); + +/* ctf-field-list */ +struct bt_definition **_bt_python_field_listcaller( + const struct bt_ctf_event *ctf_event, + const struct bt_definition *scope, + unsigned int *len); +struct bt_definition *_bt_python_field_one_from_list( + struct bt_definition **list, int index); + +/* event_decl_list */ +struct bt_ctf_event_decl **_bt_python_event_decl_listcaller( + int handle_id, + struct bt_context *ctx, + unsigned int *len); +struct bt_ctf_event_decl *_bt_python_decl_one_from_list( + struct bt_ctf_event_decl **list, int index); + +/* decl_fields */ +struct bt_ctf_field_decl **_by_python_field_decl_listcaller( + struct bt_ctf_event_decl *event_decl, + enum bt_ctf_scope scope, + unsigned int *len); +struct bt_ctf_field_decl *_bt_python_field_decl_one_from_list( + struct bt_ctf_field_decl **list, int index); + +/* definitions */ +struct definition_array *_bt_python_get_array_from_def( + struct bt_definition *field); +struct definition_sequence *_bt_python_get_sequence_from_def( + struct bt_definition *field); + +/* ctf writer */ +int _bt_python_field_integer_get_signedness(const struct bt_ctf_field *field); +enum ctf_type_id _bt_python_get_field_type(const struct bt_ctf_field *field); diff --git a/configure.ac b/configure.ac index 6ea5ef3c..1b927ff0 100644 --- a/configure.ac +++ b/configure.ac @@ -101,6 +101,43 @@ AC_CHECK_LIB([popt], [poptGetContext], [], [AC_MSG_ERROR([Cannot find popt.])] ) + +# For Python +# SWIG version needed or newer: +swig_version=2.0.0 + +AC_ARG_ENABLE([python-bindings], + [AC_HELP_STRING([--enable-python-bindings], + [generate Python bindings])], + [enable_python=yes], [enable_python=no]) + +AM_CONDITIONAL([USE_PYTHON], [test "x${enable_python:-yes}" = xyes]) + +if test "x${enable_python:-yes}" = xyes; then + AX_PKG_SWIG($swig_version, [], [ AC_MSG_ERROR([SWIG $swig_version or newer is needed]) ]) + AM_PATH_PYTHON + + AC_ARG_VAR([PYTHON_INCLUDE], [Include flags for python, bypassing python-config]) + AC_ARG_VAR([PYTHON_CONFIG], [Path to python-config]) + AS_IF([test -z "$PYTHON_INCLUDE"], [ + AS_IF([test -z "$PYTHON_CONFIG"], [ + AC_PATH_PROGS([PYTHON_CONFIG], + [python$PYTHON_VERSION-config python-config], + [no], + [`dirname $PYTHON`]) + AS_IF([test "$PYTHON_CONFIG" = no], [AC_MSG_ERROR([cannot find python-config for $PYTHON. Do you have python-dev installed?])]) + ]) + AC_MSG_CHECKING([python include flags]) + PYTHON_INCLUDE=`$PYTHON_CONFIG --includes` + AC_MSG_RESULT([$PYTHON_INCLUDE]) + ]) + +else + AC_MSG_NOTICE([You may configure with --enable-python-bindings ]dnl +[if you want Python bindings.]) + +fi + pkg_modules="gmodule-2.0 >= 2.0.0" PKG_CHECK_MODULES(GMODULE, [$pkg_modules]) AC_SUBST(PACKAGE_LIBS) @@ -136,6 +173,8 @@ AC_CONFIG_FILES([ lib/Makefile lib/prio_heap/Makefile include/Makefile + bindings/Makefile + bindings/python/Makefile tests/Makefile tests/bin/Makefile tests/lib/Makefile diff --git a/doc/python-howto.txt b/doc/python-howto.txt new file mode 100644 index 00000000..5ac8e078 --- /dev/null +++ b/doc/python-howto.txt @@ -0,0 +1,70 @@ +PYTHON BINDINGS +---------------- + +This is a brief howto for using the Babeltrace Python module. + + +INSTALLATION: + +By default, the Python bindings are not generated. +If you wish to generate and install the Python bindings, you can use the +--enable-python-bindings configure option. + + $ ./configure --enable-python-bindings + +The Python module is automatically generated using SWIG, therefore the +swig2.0 package on Debian/Ubuntu is requied. + + +USAGE: + +Once installed, the Python module can be used by importing it in Python. +In the Python interpreter: + + >>> import babeltrace + +Then the starting point is to create a context and add a trace to it. + + >>> ctx = babeltrace.Context() + >>> ctx.add_trace("path/to/trace", ) + +Where is a string containing the format name in which the trace +was produced. To print a list of available formats to the standard +output, it is possible to use the print_format_list function. + + >>> out = babeltrace.File(None) # This returns stdout + >>> babeltrace.print_format_list(out) + +When a trace is added to a context, it is opened and ready to read using +an iterator. While creating an iterator, optional starting and ending +position may be specified. So far, only ctf iterator are supported. + + >>> begin_pos = babeltrace.IterPos(babeltrace.SEEK_BEGIN) + >>> iterator = babeltrace.ctf.Iterator(ctx, begin_pos) + +From there, it is possible to read the events. + + >>> event = iterator.read_event() + +It is simple to obtain the timestamp of that event. + + >>> timestamp = event.get_timestamp() + +Let's say that we want to extract the prev_comm context info for a +sched_switch event. To do so, it is needed to set an event scope +with which we can obtain the field wanted. + + >>> if event.get_name == "sched_switch": + ... #prev_comm only for sched_switch events + ... scope = event.get_top_level_scope(babeltrace.ctf.scope.EVENT_FIELDS) + ... field = event.get_field(scope, "_prev_comm") + ... prev_comm = field.get_char_array() + +It is also possible to move on to the next event. + + >>> ret = iterator.next() # Move the iterator + >>> if ret == 0: # No error occured + ... event = iterator.read_event() # Read the next event + +For many usage script examples of the Babeltrace Python module, see the +bindings/python/examples directory. diff --git a/formats/ctf/events.c b/formats/ctf/events.c index af376a44..8174293b 100644 --- a/formats/ctf/events.c +++ b/formats/ctf/events.c @@ -608,6 +608,75 @@ char *bt_ctf_get_string(const struct bt_definition *field) return ret; } +double bt_ctf_get_float(const struct bt_definition *field) +{ + double ret = 0.0; + + if (field && bt_ctf_field_type(bt_ctf_get_decl_from_def(field)) == CTF_TYPE_FLOAT) { + ret = bt_get_float(field); + } else { + bt_ctf_field_set_error(-EINVAL); + } + + return ret; +} + +const struct bt_definition *bt_ctf_get_variant(const struct bt_definition *field) +{ + const struct bt_definition *ret = NULL; + + if (field && bt_ctf_field_type( + bt_ctf_get_decl_from_def(field)) == CTF_TYPE_VARIANT) { + struct definition_variant *variant = container_of(field, + struct definition_variant, p); + + ret = bt_variant_get_current_field(variant); + } else { + bt_ctf_field_set_error(-EINVAL); + } + + return ret; +} + +uint64_t bt_ctf_get_struct_field_count(const struct bt_definition *field) +{ + uint64_t ret = -1; + const struct bt_declaration *declaration = + bt_ctf_get_decl_from_def(field); + + if (field && bt_ctf_field_type(declaration) == CTF_TYPE_STRUCT) { + const struct declaration_struct *struct_declaration = + container_of(declaration, struct declaration_struct, p); + + ret = bt_struct_declaration_len(struct_declaration); + } else { + bt_ctf_field_set_error(-EINVAL); + } + + return ret; +} + +const struct bt_definition *bt_ctf_get_struct_field_index( + const struct bt_definition *field, uint64_t i) +{ + const struct bt_definition *ret = NULL; + + if (field && bt_ctf_field_type( + bt_ctf_get_decl_from_def(field)) == CTF_TYPE_STRUCT && + i < bt_ctf_get_struct_field_count(field)) { + const struct definition_struct *structure = container_of( + field, struct definition_struct, p); + + ret = bt_struct_definition_get_field_from_index(structure, i); + } + + if (!ret) { + bt_ctf_field_set_error(-EINVAL); + } + + return ret; +} + int bt_ctf_get_event_decl_list(int handle_id, struct bt_context *ctx, struct bt_ctf_event_decl * const **list, unsigned int *count) diff --git a/formats/ctf/iterator.c b/formats/ctf/iterator.c index d2cd914e..d1152fca 100644 --- a/formats/ctf/iterator.c +++ b/formats/ctf/iterator.c @@ -126,6 +126,11 @@ struct bt_ctf_event *bt_ctf_iter_read_event_flags(struct bt_ctf_iter *iter, goto stop; } stream = &file_stream->parent; + if (iter->parent.end_pos && + iter->parent.end_pos->type == BT_SEEK_TIME && + stream->real_timestamp > iter->parent.end_pos->u.seek_time) { + goto stop; + } ret->parent = g_ptr_array_index(stream->events_by_id, stream->event_id); diff --git a/formats/ctf/types/array.c b/formats/ctf/types/array.c index b1e8d6c5..979f7a3d 100644 --- a/formats/ctf/types/array.c +++ b/formats/ctf/types/array.c @@ -57,9 +57,11 @@ int ctf_array_read(struct bt_stream_pos *ppos, struct bt_definition *definition) g_string_insert_len(array_definition->string, 0, (char *) ctf_get_pos_addr(pos), array_declaration->len); - if (!ctf_move_pos(pos, array_declaration->len * CHAR_BIT)) - return -EFAULT; - return 0; + /* + * We want to populate both the string + * and the underlying values, so carry + * on calling bt_array_rw(). + */ } } } diff --git a/formats/ctf/types/float.c b/formats/ctf/types/float.c index 5fcae004..b82f68db 100644 --- a/formats/ctf/types/float.c +++ b/formats/ctf/types/float.c @@ -284,6 +284,14 @@ end: return ret; } +double bt_get_float(const struct bt_definition *field) +{ + struct definition_float *definition = + container_of(field, struct definition_float, p); + + return definition->value; +} + static void __attribute__((constructor)) ctf_float_init(void) { diff --git a/formats/ctf/writer/event-fields.c b/formats/ctf/writer/event-fields.c index c2ad4c24..c4d1b968 100644 --- a/formats/ctf/writer/event-fields.c +++ b/formats/ctf/writer/event-fields.c @@ -941,7 +941,7 @@ void bt_ctf_field_string_destroy(struct bt_ctf_field *field) static int bt_ctf_field_generic_validate(struct bt_ctf_field *field) { - return !(field && field->payload_set); + return (field && field->payload_set) ? 0 : -1; } static diff --git a/include/babeltrace/ctf/events.h b/include/babeltrace/ctf/events.h index c92470cf..c81d8852 100644 --- a/include/babeltrace/ctf/events.h +++ b/include/babeltrace/ctf/events.h @@ -211,6 +211,12 @@ enum ctf_string_encoding bt_ctf_get_encoding(const struct bt_declaration *decl); */ int bt_ctf_get_array_len(const struct bt_declaration *decl); +/* + * bt_ctf_get_struct_field_count: return the number of fields in a structure. + * Returns a negative value on error. + */ +uint64_t bt_ctf_get_struct_field_count(const struct bt_definition *field); + /* * Field access functions * @@ -231,6 +237,10 @@ const struct bt_definition *bt_ctf_get_enum_int(const struct bt_definition *fiel const char *bt_ctf_get_enum_str(const struct bt_definition *field); char *bt_ctf_get_char_array(const struct bt_definition *field); char *bt_ctf_get_string(const struct bt_definition *field); +double bt_ctf_get_float(const struct bt_definition *field); +const struct bt_definition *bt_ctf_get_variant(const struct bt_definition *field); +const struct bt_definition *bt_ctf_get_struct_field_index( + const struct bt_definition *field, uint64_t i); /* * bt_ctf_field_get_error: returns the last error code encountered while diff --git a/include/babeltrace/types.h b/include/babeltrace/types.h index 8d660bea..677818b9 100644 --- a/include/babeltrace/types.h +++ b/include/babeltrace/types.h @@ -435,6 +435,10 @@ struct declaration_string * char *bt_get_string(const struct bt_definition *field); enum ctf_string_encoding bt_get_string_encoding(const struct bt_definition *field); +double bt_get_float(const struct bt_definition *field); + +const struct bt_definition *bt_get_variant_field(struct bt_definition *definition); + struct declaration_struct * bt_struct_declaration_new(struct declaration_scope *parent_scope, uint64_t min_align); @@ -453,10 +457,10 @@ struct declaration_field * bt_struct_declaration_get_field_from_index(struct declaration_struct *struct_declaration, int index); struct bt_definition * -bt_struct_definition_get_field_from_index(struct definition_struct *struct_definition, +bt_struct_definition_get_field_from_index(const struct definition_struct *struct_definition, int index); int bt_struct_rw(struct bt_stream_pos *pos, struct bt_definition *definition); -uint64_t bt_struct_declaration_len(struct declaration_struct *struct_declaration); +uint64_t bt_struct_declaration_len(const struct declaration_struct *struct_declaration); /* * The tag enumeration is validated to ensure that it contains only mappings diff --git a/lib/iterator.c b/lib/iterator.c index 3280f4a8..a2a7bb57 100644 --- a/lib/iterator.c +++ b/lib/iterator.c @@ -705,23 +705,17 @@ int bt_iter_init(struct bt_iter *iter, for (filenr = 0; filenr < stream->streams->len; filenr++) { struct ctf_file_stream *file_stream; + struct bt_iter_pos pos; file_stream = g_ptr_array_index(stream->streams, filenr); if (!file_stream) continue; - if (begin_pos) { - ret = babeltrace_filestream_seek( - file_stream, - begin_pos, - stream_id); - } else { - struct bt_iter_pos pos; - pos.type = BT_SEEK_BEGIN; - ret = babeltrace_filestream_seek( - file_stream, &pos, - stream_id); - } + + pos.type = BT_SEEK_BEGIN; + ret = babeltrace_filestream_seek(file_stream, + &pos, stream_id); + if (ret == EOF) { ret = 0; continue; @@ -737,7 +731,11 @@ int bt_iter_init(struct bt_iter *iter, } ctx->current_iterator = iter; - return 0; + if (begin_pos && begin_pos->type != BT_SEEK_BEGIN) { + ret = bt_iter_set_pos(iter, begin_pos); + } + + return ret; error: bt_heap_free(iter->stream_heap); diff --git a/m4/ax_pkg_swig.m4 b/m4/ax_pkg_swig.m4 new file mode 100644 index 00000000..e112f3d3 --- /dev/null +++ b/m4/ax_pkg_swig.m4 @@ -0,0 +1,135 @@ +# =========================================================================== +# http://www.gnu.org/software/autoconf-archive/ax_pkg_swig.html +# =========================================================================== +# +# SYNOPSIS +# +# AX_PKG_SWIG([major.minor.micro], [action-if-found], [action-if-not-found]) +# +# DESCRIPTION +# +# This macro searches for a SWIG installation on your system. If found, +# then SWIG is AC_SUBST'd; if not found, then $SWIG is empty. If SWIG is +# found, then SWIG_LIB is set to the SWIG library path, and AC_SUBST'd. +# +# You can use the optional first argument to check if the version of the +# available SWIG is greater than or equal to the value of the argument. It +# should have the format: N[.N[.N]] (N is a number between 0 and 999. Only +# the first N is mandatory.) If the version argument is given (e.g. +# 1.3.17), AX_PKG_SWIG checks that the swig package is this version number +# or higher. +# +# As usual, action-if-found is executed if SWIG is found, otherwise +# action-if-not-found is executed. +# +# In configure.in, use as: +# +# AX_PKG_SWIG(1.3.17, [], [ AC_MSG_ERROR([SWIG is required to build..]) ]) +# AX_SWIG_ENABLE_CXX +# AX_SWIG_MULTI_MODULE_SUPPORT +# AX_SWIG_PYTHON +# +# LICENSE +# +# Copyright (c) 2008 Sebastian Huber +# Copyright (c) 2008 Alan W. Irwin +# Copyright (c) 2008 Rafael Laboissiere +# Copyright (c) 2008 Andrew Collier +# Copyright (c) 2011 Murray Cumming +# +# This program is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by the +# Free Software Foundation; either version 2 of the License, or (at your +# option) any later version. +# +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General +# Public License for more details. +# +# You should have received a copy of the GNU General Public License along +# with this program. If not, see . +# +# As a special exception, the respective Autoconf Macro's copyright owner +# gives unlimited permission to copy, distribute and modify the configure +# scripts that are the output of Autoconf when processing the Macro. You +# need not follow the terms of the GNU General Public License when using +# or distributing such scripts, even though portions of the text of the +# Macro appear in them. The GNU General Public License (GPL) does govern +# all other use of the material that constitutes the Autoconf Macro. +# +# This special exception to the GPL applies to versions of the Autoconf +# Macro released by the Autoconf Archive. When you make and distribute a +# modified version of the Autoconf Macro, you may extend this special +# exception to the GPL to apply to your modified version as well. + +#serial 8 + +AC_DEFUN([AX_PKG_SWIG],[ + # Ubuntu has swig 2.0 as /usr/bin/swig2.0 + AC_PATH_PROGS([SWIG],[swig swig2.0]) + if test -z "$SWIG" ; then + m4_ifval([$3],[$3],[:]) + elif test -n "$1" ; then + AC_MSG_CHECKING([SWIG version]) + [swig_version=`$SWIG -version 2>&1 | grep 'SWIG Version' | sed 's/.*\([0-9][0-9]*\.[0-9][0-9]*\.[0-9][0-9]*\).*/\1/g'`] + AC_MSG_RESULT([$swig_version]) + if test -n "$swig_version" ; then + # Calculate the required version number components + [required=$1] + [required_major=`echo $required | sed 's/[^0-9].*//'`] + if test -z "$required_major" ; then + [required_major=0] + fi + [required=`echo $required | sed 's/[0-9]*[^0-9]//'`] + [required_minor=`echo $required | sed 's/[^0-9].*//'`] + if test -z "$required_minor" ; then + [required_minor=0] + fi + [required=`echo $required | sed 's/[0-9]*[^0-9]//'`] + [required_patch=`echo $required | sed 's/[^0-9].*//'`] + if test -z "$required_patch" ; then + [required_patch=0] + fi + # Calculate the available version number components + [available=$swig_version] + [available_major=`echo $available | sed 's/[^0-9].*//'`] + if test -z "$available_major" ; then + [available_major=0] + fi + [available=`echo $available | sed 's/[0-9]*[^0-9]//'`] + [available_minor=`echo $available | sed 's/[^0-9].*//'`] + if test -z "$available_minor" ; then + [available_minor=0] + fi + [available=`echo $available | sed 's/[0-9]*[^0-9]//'`] + [available_patch=`echo $available | sed 's/[^0-9].*//'`] + if test -z "$available_patch" ; then + [available_patch=0] + fi + # Convert the version tuple into a single number for easier comparison. + # Using base 100 should be safe since SWIG internally uses BCD values + # to encode its version number. + required_swig_vernum=`expr $required_major \* 10000 \ + \+ $required_minor \* 100 \+ $required_patch` + available_swig_vernum=`expr $available_major \* 10000 \ + \+ $available_minor \* 100 \+ $available_patch` + + if test $available_swig_vernum -lt $required_swig_vernum; then + AC_MSG_WARN([SWIG version >= $1 is required. You have $swig_version.]) + SWIG='' + m4_ifval([$3],[$3],[]) + else + AC_MSG_CHECKING([for SWIG library]) + SWIG_LIB=`$SWIG -swiglib` + AC_MSG_RESULT([$SWIG_LIB]) + m4_ifval([$2],[$2],[]) + fi + else + AC_MSG_WARN([cannot determine SWIG version]) + SWIG='' + m4_ifval([$3],[$3],[]) + fi + fi + AC_SUBST([SWIG_LIB]) +]) diff --git a/tests/ctf-traces/succeed/sequence/channel0_0 b/tests/ctf-traces/succeed/sequence/channel0_0 new file mode 100644 index 00000000..5038a227 Binary files /dev/null and b/tests/ctf-traces/succeed/sequence/channel0_0 differ diff --git a/tests/ctf-traces/succeed/sequence/channel0_1 b/tests/ctf-traces/succeed/sequence/channel0_1 new file mode 100644 index 00000000..fd947382 Binary files /dev/null and b/tests/ctf-traces/succeed/sequence/channel0_1 differ diff --git a/tests/ctf-traces/succeed/sequence/channel0_2 b/tests/ctf-traces/succeed/sequence/channel0_2 new file mode 100644 index 00000000..9d848fcb Binary files /dev/null and b/tests/ctf-traces/succeed/sequence/channel0_2 differ diff --git a/tests/ctf-traces/succeed/sequence/channel0_3 b/tests/ctf-traces/succeed/sequence/channel0_3 new file mode 100644 index 00000000..ef385c38 Binary files /dev/null and b/tests/ctf-traces/succeed/sequence/channel0_3 differ diff --git a/tests/ctf-traces/succeed/sequence/metadata b/tests/ctf-traces/succeed/sequence/metadata new file mode 100644 index 00000000..2163abfc --- /dev/null +++ b/tests/ctf-traces/succeed/sequence/metadata @@ -0,0 +1,106 @@ +/* CTF 1.8 */ +typealias integer { size = 8; align = 8; signed = false; } := uint8_t; +typealias integer { size = 16; align = 8; signed = false; } := uint16_t; +typealias integer { size = 32; align = 8; signed = false; } := uint32_t; +typealias integer { size = 64; align = 8; signed = false; } := uint64_t; +typealias integer { size = 64; align = 8; signed = false; } := unsigned long; +typealias integer { size = 5; align = 1; signed = false; } := uint5_t; +typealias integer { size = 27; align = 1; signed = false; } := uint27_t; + +trace { + major = 1; + minor = 8; + uuid = "59052333-e490-4ed9-af7a-b652437fba9a"; + byte_order = le; + packet.header := struct { + uint32_t magic; + uint8_t uuid[16]; + uint32_t stream_id; + }; +}; + +env { + hostname = "host"; + domain = "ust"; + tracer_name = "lttng-ust"; + tracer_major = 2; + tracer_minor = 3; +}; + +clock { + name = monotonic; + uuid = "5f3ed925-9d73-4637-b8e4-02077abc8c8f"; + description = "Monotonic Clock"; + freq = 1000000000; /* Frequency, in Hz */ + /* clock value offset from Epoch is: offset * (1/freq) */ + offset = 1375437179542680815; +}; + +typealias integer { + size = 27; align = 1; signed = false; + map = clock.monotonic.value; +} := uint27_clock_monotonic_t; + +typealias integer { + size = 32; align = 8; signed = false; + map = clock.monotonic.value; +} := uint32_clock_monotonic_t; + +typealias integer { + size = 64; align = 8; signed = false; + map = clock.monotonic.value; +} := uint64_clock_monotonic_t; + +struct packet_context { + uint64_clock_monotonic_t timestamp_begin; + uint64_clock_monotonic_t timestamp_end; + uint64_t content_size; + uint64_t packet_size; + unsigned long events_discarded; + uint32_t cpu_id; +}; + +struct event_header_compact { + enum : uint5_t { compact = 0 ... 30, extended = 31 } id; + variant { + struct { + uint27_clock_monotonic_t timestamp; + } compact; + struct { + uint32_t id; + uint64_clock_monotonic_t timestamp; + } extended; + } v; +} align(8); + +struct event_header_large { + enum : uint16_t { compact = 0 ... 65534, extended = 65535 } id; + variant { + struct { + uint32_clock_monotonic_t timestamp; + } compact; + struct { + uint32_t id; + uint64_clock_monotonic_t timestamp; + } extended; + } v; +} align(8); + +stream { + id = 0; + event.header := struct event_header_compact; + packet.context := struct packet_context; +}; + +event { + name = "sequence event"; + id = 0; + stream_id = 0; + loglevel = 1; + fields := struct { + integer { size = 64; align = 8; signed = 0; encoding = none; base = 10; } __seq_int_field_length; + integer { size = 32; align = 8; signed = 1; encoding = none; base = 10; } _seq_int_field[ __seq_int_field_length ]; + integer { size = 64; align = 8; signed = 0; encoding = none; base = 10; } __seq_long_field_length; + integer { size = 64; align = 8; signed = 1; encoding = none; base = 10; } _seq_long_field[ __seq_long_field_length ]; + }; +}; diff --git a/tests/tests-python.py b/tests/tests-python.py new file mode 100644 index 00000000..8695f61c --- /dev/null +++ b/tests/tests-python.py @@ -0,0 +1,116 @@ +#!/usr/bin/env python3 +import unittest +import sys +from babeltrace import * + +class TestBabeltracePythonModule(unittest.TestCase): + + def test_handle_decl(self): + #Context creation, adding trace + ctx = Context() + trace_handle = ctx.add_trace( + "ctf-traces/succeed/lttng-modules-2.0-pre5", + "ctf") + self.assertIsNotNone(trace_handle, "Error adding trace") + + #TraceHandle test + ts_begin = trace_handle.get_timestamp_begin(ctx, CLOCK_REAL) + ts_end = trace_handle.get_timestamp_end(ctx, CLOCK_REAL) + self.assertGreater(ts_end, ts_begin, "Error get_timestamp from trace_handle") + + lst = ctf.get_event_decl_list(trace_handle, ctx) + self.assertIsNotNone(lst, "Error get_event_decl_list") + + name = lst[0].get_name() + self.assertIsNotNone(name) + + fields = lst[0].get_decl_fields(ctf.scope.EVENT_FIELDS) + self.assertIsNotNone(fields, "Error getting FieldDecl list") + + if len(fields) > 0: + self.assertIsNotNone(fields[0].get_name(), + "Error getting name from FieldDecl") + + #Remove trace + ctx.remove_trace(trace_handle) + del ctx + del trace_handle + + + def test_iterator_event(self): + #Context creation, adding trace + ctx = Context() + trace_handle = ctx.add_trace( + "ctf-traces/succeed/lttng-modules-2.0-pre5", + "ctf") + self.assertIsNotNone(trace_handle, "Error adding trace") + + begin_pos = IterPos(SEEK_BEGIN) + it = ctf.Iterator(ctx, begin_pos) + self.assertIsNotNone(it, "Error creating iterator") + + event = it.read_event() + self.assertIsNotNone(event, "Error reading event") + + handle = event.get_handle() + self.assertIsNotNone(handle, "Error getting handle") + + context = event.get_context() + self.assertIsNotNone(context, "Error getting context") + + name = "" + while event is not None and name != "sched_switch": + name = event.get_name() + self.assertIsNotNone(name, "Error getting event name") + + ts = event.get_timestamp() + self.assertGreaterEqual(ts, 0, "Error getting timestamp") + + cycles = event.get_cycles() + self.assertGreaterEqual(cycles, 0, "Error getting cycles") + + if name == "sched_switch": + scope = event.get_top_level_scope(ctf.scope.STREAM_PACKET_CONTEXT) + self.assertIsNotNone(scope, "Error getting scope definition") + + field = event.get_field(scope, "cpu_id") + prev_comm_str = field.get_uint64() + self.assertEqual(ctf.field_error(), 0, "Error getting vec info") + + field_lst = event.get_field_list(scope) + self.assertIsNotNone(field_lst, "Error getting field list") + + fname = field.field_name() + self.assertIsNotNone(fname, "Error getting field name") + + ftype = field.field_type() + self.assertIsNot(ftype, -1, "Error getting field type (unknown)") + + ret = it.next() + self.assertGreaterEqual(ret, 0, "Error moving iterator") + + event = it.read_event() + + pos = it.get_pos() + self.assertIsNotNone(pos._pos, "Error getting iterator position") + + ret = it.set_pos(pos) + self.assertEqual(ret, 0, "Error setting iterator position") + + pos = it.create_time_pos(ts) + self.assertIsNotNone(pos._pos, "Error creating time-based iterator position") + + del it, pos + set_pos = IterPos(SEEK_TIME, ts) + it = ctf.Iterator(ctx, begin_pos, set_pos) + self.assertIsNotNone(it, "Error creating iterator with end_pos") + + + def test_file_class(self): + f = File("test-bitfield.c") + self.assertIsNotNone(f, "Error opening file") + f.close() + + +if __name__ == "__main__": + unittest.main() diff --git a/types/array.c b/types/array.c index c9b973bf..e4b43d8b 100644 --- a/types/array.c +++ b/types/array.c @@ -131,11 +131,6 @@ struct bt_definition * || integer_declaration->encoding == CTF_STRING_ASCII) { array->string = g_string_new(""); - - if (integer_declaration->len == CHAR_BIT - && integer_declaration->p.alignment == CHAR_BIT) { - return &array->p; - } } } diff --git a/types/struct.c b/types/struct.c index b9fb6799..7eaa4242 100644 --- a/types/struct.c +++ b/types/struct.c @@ -242,7 +242,7 @@ struct declaration_field * * field returned only valid as long as the field structure is not appended to. */ struct bt_definition * -bt_struct_definition_get_field_from_index(struct definition_struct *_struct, +bt_struct_definition_get_field_from_index(const struct definition_struct *_struct, int index) { if (index < 0) @@ -250,7 +250,7 @@ bt_struct_definition_get_field_from_index(struct definition_struct *_struct, return g_ptr_array_index(_struct->fields, index); } -uint64_t bt_struct_declaration_len(struct declaration_struct *struct_declaration) +uint64_t bt_struct_declaration_len(const struct declaration_struct *struct_declaration) { return struct_declaration->fields->len; }