4 * Babeltrace Python Module interface file
6 * Copyright 2012 EfficiOS Inc.
8 * Author: Danny Serres <danny.serres@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
23 "BABELTRACE_VERSION_STR
25 Babeltrace is a trace viewer and converter reading and writing the
26 Common Trace Format (CTF). Its main use is to pretty-print CTF
27 traces into a human-readable text output.
29 To use this module, the first step is to create a Context and add a
33 %module(docstring=DOCSTRING) babeltrace
37 #define SWIG_FILE_WITH_INIT
38 #include <babeltrace/babeltrace.h>
39 #include <babeltrace/babeltrace-internal.h>
40 #include <babeltrace/trace-handle.h>
41 #include <babeltrace/trace-handle-internal.h>
42 #include <babeltrace/context.h>
43 #include <babeltrace/context-internal.h>
44 #include <babeltrace/iterator.h>
45 #include <babeltrace/iterator-internal.h>
46 #include <babeltrace/format.h>
47 #include <babeltrace/list.h>
48 #include <babeltrace/types.h>
49 #include <babeltrace/ctf/iterator.h>
50 #include "python-complements.h"
53 typedef unsigned long long uint64_t;
54 typedef long long int64_t;
55 typedef int bt_intern_str;
57 /* =================================================================
58 CONTEXT.H, CONTEXT-INTERNAL.H
59 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
62 %rename("_bt_context_create") bt_context_create(void);
63 %rename("_bt_context_add_trace") bt_context_add_trace(
64 struct bt_context *ctx, const char *path, const char *format,
65 void (*packet_seek)(struct bt_stream_pos *pos, size_t index, int whence),
66 struct bt_mmap_stream_list *stream_list, FILE *metadata);
67 %rename("_bt_context_remove_trace") bt_context_remove_trace(
68 struct bt_context *ctx, int trace_id);
69 %rename("_bt_context_get") bt_context_get(struct bt_context *ctx);
70 %rename("_bt_context_put") bt_context_put(struct bt_context *ctx);
71 %rename("_bt_ctf_event_get_context") bt_ctf_event_get_context(
72 const struct bt_ctf_event *event);
74 struct bt_context *bt_context_create(void);
75 int bt_context_add_trace(struct bt_context *ctx, const char *path, const char *format,
76 void (*packet_seek)(struct bt_stream_pos *pos, size_t index, int whence),
77 struct bt_mmap_stream_list *stream_list, FILE *metadata);
78 void bt_context_remove_trace(struct bt_context *ctx, int trace_id);
79 void bt_context_get(struct bt_context *ctx);
80 void bt_context_put(struct bt_context *ctx);
81 struct bt_context *bt_ctf_event_get_context(const struct bt_ctf_event *event);
83 // class Context to prevent direct access to struct bt_context
87 The context represents the object in which a trace_collection is
88 open. As long as this structure is allocated, the trace_collection
89 is open and the traces it contains can be read and seeked by the
90 iterators and callbacks.
94 self._c = _bt_context_create()
97 _bt_context_put(self._c)
99 def add_trace(self, path, format_str,
100 packet_seek=None, stream_list=None, metadata=None):
102 Add a trace by path to the context.
106 path is the path to the trace, it is not recursive.
107 If "path" is None, stream_list is used instead as a list
108 of mmap streams to open for the trace.
110 format is a string containing the format name in which the trace was
113 packet_seek is not implemented for Python. Should be left None to
114 use the default packet_seek handler provided by the trace format.
116 stream_list is a linked list of streams, it is used to open a trace
117 where the trace data is located in memory mapped areas instead of
118 trace files, this argument should be None when path is not None.
120 The metadata parameter acts as a metadata override when not None,
121 otherwise the format handles the metadata opening.
123 Return: the corresponding TraceHandle on success or None on error.
125 if metadata is not None:
126 metadata = metadata._file
128 ret = _bt_context_add_trace(self._c, path, format_str, packet_seek,
129 stream_list, metadata)
133 th = TraceHandle.__new__(TraceHandle)
137 def add_traces_recursive(self, path, format_str):
139 Open a trace recursively.
141 Find each trace present in the subdirectory starting from the given
142 path, and add them to the context.
144 Return a dict of TraceHandle instances (the full path is the key).
145 Return None on error.
155 for fullpath, dirs, files in os.walk(path):
156 if "metadata" in files:
157 trace_handle = self.add_trace(fullpath, format_str)
158 if trace_handle is None:
162 trace_handles[fullpath] = trace_handle
165 if noTrace and error:
169 def remove_trace(self, trace_handle):
171 Remove a trace from the context.
172 Effectively closing the trace.
175 _bt_context_remove_trace(self._c, trace_handle._id)
176 except AttributeError:
177 raise TypeError("in remove_trace, "
178 "argument 2 must be a TraceHandle instance")
183 /* =================================================================
188 %rename("lookup_format") bt_lookup_format(bt_intern_str qname);
189 %rename("_bt_print_format_list") bt_fprintf_format_list(FILE *fp);
190 %rename("register_format") bt_register_format(struct format *format);
191 %rename("unregister_format") bt_unregister_format(struct bt_format *format);
193 extern struct format *bt_lookup_format(bt_intern_str qname);
194 extern void bt_fprintf_format_list(FILE *fp);
195 extern int bt_register_format(struct bt_format *format);
196 extern void bt_unregister_format(struct bt_format *format);
200 def print_format_list(babeltrace_file):
202 Print a list of available formats to file.
204 babeltrace_file must be a File instance opened in write mode.
207 if babeltrace_file._file is not None:
208 _bt_print_format_list(babeltrace_file._file)
209 except AttributeError:
210 raise TypeError("in print_format_list, "
211 "argument 1 must be a File instance")
216 /* =================================================================
217 ITERATOR.H, ITERATOR-INTERNAL.H
218 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
221 %rename("_bt_iter_create") bt_iter_create(struct bt_context *ctx,
222 const struct bt_iter_pos *begin_pos, const struct bt_iter_pos *end_pos);
223 %rename("_bt_iter_destroy") bt_iter_destroy(struct bt_iter *iter);
224 %rename("_bt_iter_next") bt_iter_next(struct bt_iter *iter);
225 %rename("_bt_iter_get_pos") bt_iter_get_pos(struct bt_iter *iter);
226 %rename("_bt_iter_free_pos") bt_iter_free_pos(struct bt_iter_pos *pos);
227 %rename("_bt_iter_set_pos") bt_iter_set_pos(struct bt_iter *iter,
228 const struct bt_iter_pos *pos);
229 %rename("_bt_iter_create_time_pos") bt_iter_create_time_pos(struct bt_iter *iter,
232 struct bt_iter *bt_iter_create(struct bt_context *ctx,
233 const struct bt_iter_pos *begin_pos, const struct bt_iter_pos *end_pos);
234 void bt_iter_destroy(struct bt_iter *iter);
235 int bt_iter_next(struct bt_iter *iter);
236 struct bt_iter_pos *bt_iter_get_pos(struct bt_iter *iter);
237 void bt_iter_free_pos(struct bt_iter_pos *pos);
238 int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *pos);
239 struct bt_iter_pos *bt_iter_create_time_pos(struct bt_iter *iter, uint64_t timestamp);
241 %rename("_bt_iter_pos") bt_iter_pos;
242 %rename("SEEK_TIME") BT_SEEK_TIME;
243 %rename("SEEK_RESTORE") BT_SEEK_RESTORE;
244 %rename("SEEK_CUR") BT_SEEK_CUR;
245 %rename("SEEK_BEGIN") BT_SEEK_BEGIN;
246 %rename("SEEK_LAST") BT_SEEK_LAST;
248 // This struct is taken from iterator.h
249 // All changes to the struct must also be made here
252 BT_SEEK_TIME, /* uses u.seek_time */
253 BT_SEEK_RESTORE, /* uses u.restore */
260 struct bt_saved_pos *restore;
268 """This class represents the position where to set an iterator."""
272 def __init__(self, seek_type, seek_time = None):
274 seek_type represents the type of seek to use.
275 seek_time is the timestamp to seek to when using SEEK_TIME, it
276 is expressed in nanoseconds
277 Only use SEEK_RESTORE on IterPos obtained from the get_pos function
281 self._pos = _bt_iter_pos()
282 self._pos.type = seek_type
283 if seek_time and seek_type == SEEK_TIME:
284 self._pos.u.seek_time = seek_time
285 self.__can_access = True
288 if not self.__can_access:
289 _bt_iter_free_pos(self._pos)
293 raise AttributeError("seek_type is not available")
294 return self._pos.type
296 def _set_type(self, seek_type):
298 raise AttributeError("seek_type is not available")
299 self._pos.type = seek_type
303 raise AttributeError("seek_time is not available")
305 elif self._pos.type is not SEEK_TIME:
306 raise TypeError("seek_type is not SEEK_TIME")
308 return self._pos.u.seek_time
310 def _set_time(self, time):
312 raise AttributeError("seek_time is not available")
314 elif self._pos.type is not SEEK_TIME:
315 raise TypeError("seek_type is not SEEK_TIME")
317 self._pos.u.seek_time = time
323 seek_type = property(_get_type, _set_type)
324 seek_time = property(_get_time, _set_time)
331 def __init__(self, context, begin_pos = None, end_pos = None, _no_init = None):
333 Allocate a trace collection iterator.
335 begin_pos and end_pos are optional parameters to specify the
336 position at which the trace collection should be seeked upon
337 iterator creation, and the position at which iteration will
338 start returning "EOF".
340 By default, if begin_pos is None, a BT_SEEK_CUR is performed at
341 creation. By default, if end_pos is None, a BT_SEEK_END (end of
342 trace) is the EOF criterion.
345 if begin_pos is None:
350 except AttributeError:
351 raise TypeError("in __init__, "
352 "argument 3 must be a IterPos instance")
359 except AttributeError:
360 raise TypeError("in __init__, "
361 "argument 4 must be a IterPos instance")
364 self._bi = _bt_iter_create(context._c, bp, ep)
365 except AttributeError:
366 raise TypeError("in __init__, "
367 "argument 2 must be a Context instance")
369 self.__with_init = True
376 _bt_iter_destroy(self._bi)
380 Move trace collection position to the next event.
381 Returns 0 on success, a negative value on error.
383 return _bt_iter_next(self._bi)
386 """Return a IterPos class of the current iterator position."""
388 ret.__can_access = False
389 ret._pos = _bt_iter_get_pos(self._bi)
392 def set_pos(self, pos):
394 Move the iterator to a given position.
396 On error, the stream_heap is reinitialized and returned empty.
397 Return 0 for success.
398 Return EOF if the position requested is after the last event of the
400 Return -EINVAL when called with invalid parameter.
401 Return -ENOMEM if the stream_heap could not be properly initialized.
404 return _bt_iter_set_pos(self._bi, pos._pos)
405 except AttributeError:
406 raise TypeError("in set_pos, "
407 "argument 2 must be a IterPos instance")
409 def create_time_pos(self, timestamp):
411 Create a position based on time
412 This function allocates and returns a new IterPos to be able to
413 restore an iterator position based on a timestamp.
417 raise TypeError("timestamp must be an unsigned int")
420 ret.__can_access = False
421 ret._pos = _bt_iter_create_time_pos(self._bi, timestamp)
426 /* =================================================================
429 *** Enum copied from clock-type.h
430 All changes must also be made here
432 %rename("CLOCK_CYCLES") BT_CLOCK_CYCLES;
433 %rename("CLOCK_REAL") BT_CLOCK_REAL;
440 /* =================================================================
441 TRACE-HANDLE.H, TRACE-HANDLE-INTERNAL.H
442 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
445 %rename("_bt_trace_handle_create") bt_trace_handle_create(struct bt_context *ctx);
446 %rename("_bt_trace_handle_destroy") bt_trace_handle_destroy(struct bt_trace_handle *bt);
447 struct bt_trace_handle *bt_trace_handle_create(struct bt_context *ctx);
448 void bt_trace_handle_destroy(struct bt_trace_handle *bt);
450 %rename("_bt_trace_handle_get_path") bt_trace_handle_get_path(struct bt_context *ctx,
452 %rename("_bt_trace_handle_get_timestamp_begin") bt_trace_handle_get_timestamp_begin(
453 struct bt_context *ctx, int handle_id, enum bt_clock_type type);
454 %rename("_bt_trace_handle_get_timestamp_end") bt_trace_handle_get_timestamp_end(
455 struct bt_context *ctx, int handle_id, enum bt_clock_type type);
456 const char *bt_trace_handle_get_path(struct bt_context *ctx, int handle_id);
457 uint64_t bt_trace_handle_get_timestamp_begin(struct bt_context *ctx, int handle_id,
458 enum bt_clock_type type);
459 uint64_t bt_trace_handle_get_timestamp_end(struct bt_context *ctx, int handle_id,
460 enum bt_clock_type type);
462 %rename("_bt_ctf_event_get_handle_id") bt_ctf_event_get_handle_id(
463 const struct bt_ctf_event *event);
464 int bt_ctf_event_get_handle_id(const struct bt_ctf_event *event);
469 class TraceHandle(object):
471 The TraceHandle allows the user to manipulate a trace file directly.
472 It is a unique identifier representing a trace file.
477 raise NotImplementedError("TraceHandle cannot be instantiated")
480 return "Babeltrace TraceHandle: trace_id('{0}')".format(self._id)
483 """Return the TraceHandle id."""
486 def get_path(self, context):
487 """Return the path of a TraceHandle."""
489 return _bt_trace_handle_get_path(context._c, self._id)
490 except AttributeError:
491 raise TypeError("in get_path, "
492 "argument 2 must be a Context instance")
494 def get_timestamp_begin(self, context, clock_type):
495 """Return the creation time of the buffers of a trace."""
497 return _bt_trace_handle_get_timestamp_begin(
498 context._c, self._id,clock_type)
499 except AttributeError:
500 raise TypeError("in get_timestamp_begin, "
501 "argument 2 must be a Context instance")
503 def get_timestamp_end(self, context, clock_type):
504 """Return the destruction timestamp of the buffers of a trace."""
506 return _bt_trace_handle_get_timestamp_end(
507 context._c, self._id, clock_type)
508 except AttributeError:
509 raise TypeError("in get_timestamp_end, "
510 "argument 2 must be a Context instance")
516 // =================================================================
518 // =================================================================
520 /* =================================================================
526 %rename("_bt_ctf_iter_create") bt_ctf_iter_create(struct bt_context *ctx,
527 const struct bt_iter_pos *begin_pos,
528 const struct bt_iter_pos *end_pos);
529 %rename("_bt_ctf_get_iter") bt_ctf_get_iter(struct bt_ctf_iter *iter);
530 %rename("_bt_ctf_iter_destroy") bt_ctf_iter_destroy(struct bt_ctf_iter *iter);
531 %rename("_bt_ctf_iter_read_event") bt_ctf_iter_read_event(struct bt_ctf_iter *iter);
533 struct bt_ctf_iter *bt_ctf_iter_create(struct bt_context *ctx,
534 const struct bt_iter_pos *begin_pos,
535 const struct bt_iter_pos *end_pos);
536 struct bt_iter *bt_ctf_get_iter(struct bt_ctf_iter *iter);
537 void bt_ctf_iter_destroy(struct bt_ctf_iter *iter);
538 struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter);
543 %rename("_bt_ctf_get_top_level_scope") bt_ctf_get_top_level_scope(const struct
544 bt_ctf_event *event, enum bt_ctf_scope scope);
545 %rename("_bt_ctf_event_name") bt_ctf_event_name(const struct bt_ctf_event *ctf_event);
546 %rename("_bt_ctf_get_timestamp") bt_ctf_get_timestamp(
547 const struct bt_ctf_event *ctf_event);
548 %rename("_bt_ctf_get_cycles") bt_ctf_get_cycles(
549 const struct bt_ctf_event *ctf_event);
551 %rename("_bt_ctf_get_field") bt_ctf_get_field(const struct bt_ctf_event *ctf_event,
552 const struct bt_definition *scope, const char *field);
553 %rename("_bt_ctf_get_index") bt_ctf_get_index(const struct bt_ctf_event *ctf_event,
554 const struct bt_definition *field, unsigned int index);
555 %rename("_bt_ctf_field_name") bt_ctf_field_name(const struct bt_definition *field);
556 %rename("_bt_ctf_field_type") bt_ctf_field_type(const struct bt_declaration *field);
557 %rename("_bt_ctf_get_int_signedness") bt_ctf_get_int_signedness(
558 const struct bt_declaration *field);
559 %rename("_bt_ctf_get_int_base") bt_ctf_get_int_base(const struct bt_declaration *field);
560 %rename("_bt_ctf_get_int_byte_order") bt_ctf_get_int_byte_order(
561 const struct bt_declaration *field);
562 %rename("_bt_ctf_get_int_len") bt_ctf_get_int_len(const struct bt_declaration *field);
563 %rename("_bt_ctf_get_enum_int") bt_ctf_get_enum_int(const struct bt_definition *field);
564 %rename("_bt_ctf_get_enum_str") bt_ctf_get_enum_str(const struct bt_definition *field);
565 %rename("_bt_ctf_get_encoding") bt_ctf_get_encoding(const struct bt_declaration *field);
566 %rename("_bt_ctf_get_array_len") bt_ctf_get_array_len(const struct bt_declaration *field);
567 %rename("_bt_ctf_get_uint64") bt_ctf_get_uint64(const struct bt_definition *field);
568 %rename("_bt_ctf_get_int64") bt_ctf_get_int64(const struct bt_definition *field);
569 %rename("_bt_ctf_get_char_array") bt_ctf_get_char_array(const struct bt_definition *field);
570 %rename("_bt_ctf_get_string") bt_ctf_get_string(const struct bt_definition *field);
571 %rename("_bt_ctf_get_float") bt_ctf_get_float(const struct bt_definition *field);
572 %rename("_bt_ctf_get_variant") bt_ctf_get_variant(const struct bt_definition *field);
573 %rename("_bt_ctf_field_get_error") bt_ctf_field_get_error(void);
574 %rename("_bt_ctf_get_decl_event_name") bt_ctf_get_decl_event_name(const struct
575 bt_ctf_event_decl *event);
576 %rename("_bt_ctf_get_decl_field_name") bt_ctf_get_decl_field_name(
577 const struct bt_ctf_field_decl *field);
578 %rename("_bt_ctf_get_decl_from_def") bt_ctf_get_decl_from_def(
579 const struct bt_definition *field);
580 %rename("_bt_array_index") bt_array_index(struct definition_array *array, uint64_t i);
581 %rename("_bt_sequence_len") bt_sequence_len(struct definition_sequence *sequence);
582 %rename("_bt_sequence_index") bt_sequence_index(struct definition_sequence *sequence, uint64_t i);
583 %rename("_bt_ctf_get_struct_field_count") bt_ctf_get_struct_field_count(const struct bt_definition *structure);
584 %rename("_bt_ctf_get_struct_field_index") bt_ctf_get_struct_field_index(const struct bt_definition *structure, uint64_t i);
586 const struct bt_definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *ctf_event,
587 enum bt_ctf_scope scope);
588 const char *bt_ctf_event_name(const struct bt_ctf_event *ctf_event);
589 uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *ctf_event);
590 uint64_t bt_ctf_get_cycles(const struct bt_ctf_event *ctf_event);
591 const struct bt_definition *bt_ctf_get_field(const struct bt_ctf_event *ctf_event,
592 const struct bt_definition *scope,
594 const struct bt_definition *bt_ctf_get_index(const struct bt_ctf_event *ctf_event,
595 const struct bt_definition *field,
597 const char *bt_ctf_field_name(const struct bt_definition *field);
598 enum ctf_type_id bt_ctf_field_type(const struct bt_declaration *field);
599 int bt_ctf_get_int_signedness(const struct bt_declaration *field);
600 int bt_ctf_get_int_base(const struct bt_declaration *field);
601 int bt_ctf_get_int_byte_order(const struct bt_declaration *field);
602 ssize_t bt_ctf_get_int_len(const struct bt_declaration *field);
603 const struct bt_definition *bt_ctf_get_enum_int(const struct bt_definition *field);
604 const char *bt_ctf_get_enum_str(const struct bt_definition *field);
605 enum ctf_string_encoding bt_ctf_get_encoding(const struct bt_declaration *field);
606 int bt_ctf_get_array_len(const struct bt_declaration *field);
607 struct bt_definition *bt_array_index(struct definition_array *array, uint64_t i);
608 uint64_t bt_ctf_get_uint64(const struct bt_definition *field);
609 int64_t bt_ctf_get_int64(const struct bt_definition *field);
610 char *bt_ctf_get_char_array(const struct bt_definition *field);
611 char *bt_ctf_get_string(const struct bt_definition *field);
612 double bt_ctf_get_float(const struct bt_definition *field);
613 const struct bt_definition *bt_ctf_get_variant(const struct bt_definition *field);
614 int bt_ctf_field_get_error(void);
615 const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event);
616 const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field);
617 const struct bt_declaration *bt_ctf_get_decl_from_def(const struct bt_definition *field);
618 uint64_t bt_sequence_len(struct definition_sequence *sequence);
619 struct bt_definition *bt_sequence_index(struct definition_sequence *sequence, uint64_t i);
620 uint64_t bt_ctf_get_struct_field_count(const struct bt_definition *structure);
621 const struct bt_definition *bt_ctf_get_struct_field_index(const struct bt_definition *structure, uint64_t i);
627 #enum equivalent, accessible constants
628 #These are taken directly from ctf/events.h
629 #All changes to enums must also be made here
643 def get_type_id_name(id):
645 constants = [attr for attr in dir(ctf.type_id) if not callable(getattr(ctf.type_id, attr)) and not attr.startswith("__")]
646 for attr in constants:
647 if getattr(ctf.type_id, attr) == id:
653 TRACE_PACKET_HEADER = 0
654 STREAM_PACKET_CONTEXT = 1
655 STREAM_EVENT_HEADER = 2
656 STREAM_EVENT_CONTEXT = 3
660 class string_encoding:
666 class Iterator(Iterator, object):
668 Allocate a CTF trace collection iterator.
670 begin_pos and end_pos are optional parameters to specify the
671 position at which the trace collection should be seeked upon
672 iterator creation, and the position at which iteration will
673 start returning "EOF".
675 By default, if begin_pos is None, a SEEK_CUR is performed at
676 creation. By default, if end_pos is None, a SEEK_END (end of
677 trace) is the EOF criterion.
679 Only one iterator can be created against a context. If more than one
680 iterator is being created for the same context, the second creation
681 will return None. The previous iterator must be destroyed before
682 creation of the new iterator for this function to succeed.
685 def __new__(cls, context, begin_pos = None, end_pos = None):
686 # __new__ is used to control the return value
687 # as the ctf.Iterator class should return None
688 # if bt_ctf_iter_create returns NULL
690 if begin_pos is None:
699 it = _bt_ctf_iter_create(context._c, bp, ep)
700 except AttributeError:
701 raise TypeError("in __init__, "
702 "argument 2 must be a Context instance")
706 ret_class = super(ctf.Iterator, cls).__new__(cls)
710 def __init__(self, context, begin_pos = None, end_pos = None):
711 Iterator.__init__(self, None, None, None,
712 _bt_ctf_get_iter(self._i))
715 _bt_ctf_iter_destroy(self._i)
717 def read_event(self):
719 Read the iterator's current event data.
720 Return current event on success, None on end of trace.
722 ret = _bt_ctf_iter_read_event(self._i)
725 ev = ctf.Event.__new__(ctf.Event)
732 This class represents an event from the trace.
733 It is obtained with read_event() from ctf.Iterator.
738 raise NotImplementedError("ctf.Event cannot be instantiated")
740 def get_top_level_scope(self, scope):
742 Return a definition of the top-level scope
743 Top-level scopes are defined in ctf.scope.
744 In order to get a field or a field list, the user needs to pass a
745 scope as argument, this scope can be a top-level scope or a scope
746 relative to an arbitrary field. This function provides the mapping
747 between the scope and the actual definition of top-level scopes.
748 On error return None.
750 evDef = ctf.Definition.__new__(ctf.Definition)
751 evDef._d = _bt_ctf_get_top_level_scope(self._e, scope)
757 """Return the name of the event or None on error."""
758 return _bt_ctf_event_name(self._e)
760 def get_cycles(self):
762 Return the timestamp of the event as written in
763 the packet (in cycles) or -1ULL on error.
765 return _bt_ctf_get_cycles(self._e)
767 def get_timestamp(self):
769 Return the timestamp of the event offsetted with the
770 system clock source or -1ULL on error.
772 return _bt_ctf_get_timestamp(self._e)
774 def get_field_with_scope(self, scope, field):
776 Return the definition of a specific field.
777 Return None on error.
779 evDef = ctf.Definition.__new__(ctf.Definition)
781 evDef._d = _bt_ctf_get_field(self._e, scope._d, field)
782 except AttributeError:
783 raise TypeError("in get_field, argument 2 must be a "
784 "Definition (scope) instance")
790 def get_field(self, field):
792 Return the definition of fields by a name
795 eventScope = self.get_top_level_scope(ctf.scope.EVENT_FIELDS)
796 streamScope = self.get_top_level_scope(ctf.scope.STREAM_EVENT_CONTEXT)
799 if eventScope is not None:
800 evDef = self.get_field_with_scope(eventScope, field)
801 if evDef is not None:
802 fields_by_name.append(evDef)
804 if streamScope is not None:
805 evDef = self.get_field_with_scope(streamScope, field)
806 if evDef is not None:
807 fields_by_name.append(evDef);
809 if not fields_by_name:
811 return fields_by_name
813 def get_field_list_with_scope(self, scope):
815 Return a list of Definitions associated with the scope
816 Return None on error.
819 field_lc = _bt_python_field_listcaller(self._e, scope._d)
820 except AttributeError:
821 raise TypeError("in get_field_list, argument 2 must be a "
822 "Definition (scope) instance")
830 tmp = ctf.Definition.__new__(ctf.Definition)
831 tmp._d = _bt_python_field_one_from_list(field_lc, i)
834 #Last item of list is None, assured in
835 #_bt_python_field_listcaller
843 def get_field_list(self):
844 """Return a list of Definitions or None on error."""
845 eventScope = self.get_top_level_scope(ctf.scope.EVENT_FIELDS)
846 streamScope = self.get_top_level_scope(ctf.scope.STREAM_EVENT_CONTEXT)
849 if eventScope is not None:
850 event_field_list = self.get_field_list_with_scope(eventScope)
851 if event_field_list is not None:
852 def_list = event_field_list
854 if streamScope is not None:
855 event_field_list = self.get_field_list_with_scope(streamScope)
856 if event_field_list is not None:
857 def_list.extend(event_field_list)
863 def get_index(self, field, index):
865 If the field is an array or a sequence, return the element
866 at position index, otherwise return None
868 evDef = ctf.Definition.__new__(ctf.Definition)
870 evDef._d = _bt_ctf_get_index(self._e, field._d, index)
871 except AttributeError:
872 raise TypeError("in get_index, argument 2 must be a "
873 "Definition (field) instance")
879 def get_handle(self):
881 Get the TraceHandle associated with an event
884 ret = _bt_ctf_event_get_handle_id(self._e)
888 th = TraceHandle.__new__(TraceHandle)
892 def get_context(self):
894 Get the context associated with an event.
895 Return None on error.
898 ctx._c = _bt_ctf_event_get_context(self._e);
904 class FieldError(Exception):
905 def __init__(self, value):
909 return repr(self.value)
911 class Definition(object):
912 """Definition class. Do not instantiate."""
915 raise NotImplementedError("ctf.Definition cannot be instantiated")
918 return "Babeltrace Definition: name('{0}'), type({1})".format(
919 self.field_name(), self.field_type())
921 def field_name(self):
922 """Return the name of a field or None on error."""
923 return _bt_ctf_field_name(self._d)
925 def field_type(self):
926 """Return the type of a field or -1 if unknown."""
927 return _bt_ctf_field_type(_bt_ctf_get_decl_from_def(self._d))
929 def get_int_signedness(self):
931 Return the signedness of an integer:
932 0 if unsigned; 1 if signed; -1 on error.
934 return _bt_ctf_get_int_signedness(_bt_ctf_get_decl_from_def(self._d))
936 def get_int_base(self):
937 """Return the base of an int or a negative value on error."""
938 return _bt_ctf_get_int_base(_bt_ctf_get_decl_from_def(self._d))
940 def get_int_byte_order(self):
942 Return the byte order of an int or a negative
945 return _bt_ctf_get_int_byte_order(_bt_ctf_get_decl_from_def(self._d))
947 def get_int_len(self):
949 Return the size, in bits, of an int or a negative
952 return _bt_ctf_get_int_len(_bt_ctf_get_decl_from_def(self._d))
954 def get_enum_str(self):
956 Return the string matching the current enumeration.
957 Return None on error.
959 return _bt_ctf_get_enum_str(self._d)
961 def get_encoding(self):
963 Return the encoding of an int or a string.
964 Return a negative value on error.
966 return _bt_ctf_get_encoding(_bt_ctf_get_decl_from_def(self._d))
968 def get_array_len(self):
970 Return the len of an array or a negative
973 return _bt_ctf_get_array_len(_bt_ctf_get_decl_from_def(self._d))
975 def get_array_element_at(self, index):
977 Return the array's element at position index.
980 array = _bt_python_get_array_from_def(self._d)
984 element = ctf.Definition.__new__(ctf.Definition)
985 element._d = _bt_array_index(array, index)
986 if element._d is None:
990 def get_sequence_len(self):
992 Return the len of a sequence or a negative
995 seq = _bt_python_get_sequence_from_def(self._d)
996 return _bt_sequence_len(seq)
998 def get_sequence_element_at(self, index):
1000 Return the sequence's element at position index,
1001 otherwise return None
1003 seq = _bt_python_get_sequence_from_def(self._d)
1005 element = ctf.Definition.__new__(ctf.Definition)
1006 element._d = _bt_sequence_index(seq, index)
1007 if element._d is not None:
1011 def get_uint64(self):
1013 Return the value associated with the field.
1014 If the field does not exist or is not of the type requested,
1015 the value returned is undefined. To check if an error occured,
1016 use the ctf.field_error() function after accessing a field.
1018 return _bt_ctf_get_uint64(self._d)
1020 def get_int64(self):
1022 Return the value associated with the field.
1023 If the field does not exist or is not of the type requested,
1024 the value returned is undefined. To check if an error occured,
1025 use the ctf.field_error() function after accessing a field.
1027 return _bt_ctf_get_int64(self._d)
1029 def get_char_array(self):
1031 Return the value associated with the field.
1032 If the field does not exist or is not of the type requested,
1033 the value returned is undefined. To check if an error occured,
1034 use the ctf.field_error() function after accessing a field.
1036 return _bt_ctf_get_char_array(self._d)
1040 Return the value associated with the field.
1041 If the field does not exist or is not of the type requested,
1042 the value returned is undefined. To check if an error occured,
1043 use the ctf.field_error() function after accessing a field.
1045 return _bt_ctf_get_string(self._d)
1047 def get_float(self):
1049 Return the value associated with the field.
1050 If the field does not exist or is not of the type requested,
1051 the value returned is undefined. To check if an error occured,
1052 use the ctf.field_error() function after accessing a field.
1054 return _bt_ctf_get_float(self._d)
1056 def get_variant(self):
1058 Return the variant's selected field.
1059 If the field does not exist or is not of the type requested,
1060 the value returned is undefined. To check if an error occured,
1061 use the ctf.field_error() function after accessing a field.
1063 return _bt_ctf_get_variant(self._d)
1065 def get_struct_field_count(self):
1067 Return the number of fields contained in the structure.
1068 If the field does not exist or is not of the type requested,
1069 the value returned is undefined.
1071 return _bt_ctf_get_struct_field_count(self._d)
1073 def get_struct_field_at(self, i):
1075 Return the structure's field at position i.
1076 If the field does not exist or is not of the type requested,
1077 the value returned is undefined. To check if an error occured,
1078 use the ctf.field_error() function after accessing a field.
1080 return _bt_ctf_get_struct_field_index(self._d, i)
1082 def get_value(self):
1084 Return the value associated with the field according to its type.
1085 Return None on error.
1087 id = self.field_type()
1089 if id == ctf.type_id.STRING:
1090 value = self.get_str()
1091 elif id == ctf.type_id.ARRAY:
1093 for i in range(self.get_array_len()):
1094 element = self.get_array_element_at(i)
1095 value.append(element.get_value())
1096 elif id == ctf.type_id.INTEGER:
1097 if self.get_int_signedness() == 0:
1098 value = self.get_uint64()
1100 value = self.get_int64()
1101 elif id == ctf.type_id.ENUM:
1102 value = self.get_enum_str()
1103 elif id == ctf.type_id.SEQUENCE:
1104 seq_len = self.get_sequence_len()
1106 for i in range(seq_len):
1107 evDef = self.get_sequence_element_at(i)
1108 value.append(evDef.get_value())
1109 elif id == ctf.type_id.FLOAT:
1110 value = self.get_float()
1111 elif id == ctf.type_id.VARIANT:
1112 variant = ctf.Definition.__new__(ctf.Definition)
1113 variant._d = self.get_variant();
1114 value = variant.get_value()
1115 elif id == ctf.type_id.STRUCT:
1117 for i in range(self.get_struct_field_count()):
1118 member = ctf.Definition.__new__(ctf.Definition)
1119 member._d = self.get_struct_field_at(i);
1120 value[member.field_name()] = member.get_value()
1122 if ctf.field_error():
1123 raise ctf.FieldError("Error occured while accessing field {} of type {}".format(self.field_name(), ctf.type_id.get_type_id_name(self.field_type())))
1126 def get_scope(self):
1127 """Return the scope of a field or None on error."""
1130 class EventDecl(object):
1131 """Event declaration class. Do not instantiate."""
1134 raise NotImplementedError("ctf.EventDecl cannot be instantiated")
1137 return "Babeltrace EventDecl: name {0}".format(self.get_name())
1140 """Return the name of the event or None on error"""
1141 return _bt_ctf_get_decl_event_name(self._d)
1143 def get_decl_fields(self, scope):
1145 Return a list of ctf.FieldDecl
1146 Return None on error.
1148 ptr_list = _by_python_field_decl_listcaller(self._d, scope)
1150 if ptr_list is None:
1156 tmp = ctf.FieldDecl.__new__(ctf.FieldDecl)
1157 tmp._d = _bt_python_field_decl_one_from_list(
1161 #Last item of list is None
1164 decl_list.append(tmp)
1169 class FieldDecl(object):
1170 """Field declaration class. Do not instantiate."""
1173 raise NotImplementedError("ctf.FieldDecl cannot be instantiated")
1176 return "Babeltrace FieldDecl: name {0}".format(self.get_name())
1179 """Return the name of a FieldDecl or None on error"""
1180 return _bt_ctf_get_decl_field_name(self._d)
1186 Return the last error code encountered while
1187 accessing a field and reset the error flag.
1188 Return 0 if no error, a negative value otherwise.
1190 return _bt_ctf_field_get_error()
1193 def get_event_decl_list(trace_handle, context):
1195 Return a list of ctf.EventDecl
1196 Return None on error.
1199 handle_id = trace_handle._id
1200 except AttributeError:
1201 raise TypeError("in get_event_decl_list, "
1202 "argument 1 must be a TraceHandle instance")
1204 ptr_list = _bt_python_event_decl_listcaller(handle_id, context._c)
1205 except AttributeError:
1206 raise TypeError("in get_event_decl_list, "
1207 "argument 2 must be a Context instance")
1209 if ptr_list is None:
1215 tmp = ctf.EventDecl.__new__(ctf.EventDecl)
1216 tmp._d = _bt_python_decl_one_from_list(ptr_list, i)
1219 #Last item of list is None
1222 decl_list.append(tmp)
1230 // =================================================================
1232 // File and list-related
1233 // python-complements.h
1234 // =================================================================
1236 %include python-complements.c
1242 Open a file for babeltrace.
1244 file_path is a string containing the path or None to use the
1245 standard output in writing mode.
1247 The mode can be 'r', 'w' or 'a' for reading (default), writing or
1248 appending. The file will be created if it doesn't exist when
1249 opened for writing or appending; it will be truncated when opened
1250 for writing. Add a 'b' to the mode for binary files. Add a '+'
1251 to the mode to allow simultaneous reading and writing.
1254 def __new__(cls, file_path, mode='r'):
1255 # __new__ is used to control the return value
1256 # as the File class should return None
1257 # if _bt_file_open returns NULL
1260 if file_path is not None and type(file_path) is not str:
1261 raise TypeError("in method __init__, argument 2 of type 'str'")
1262 if type(mode) is not str:
1263 raise TypeError("in method __init__, argument 3 of type 'str'")
1266 file_ptr = _bt_file_open(file_path, mode)
1267 if file_ptr is None:
1270 # Class instantiation
1271 file_inst = super(File, cls).__new__(cls)
1272 file_inst._file = file_ptr
1275 def __init__(self, file_path, mode='r'):
1277 self._use_stdout = False
1279 if file_path is None:
1281 file_path = "stdout"
1283 self._use_stdout = True
1285 self._file_path = file_path
1296 return "{0} babeltrace File; file_path('{1}'), mode('{2}')".format(
1297 stat, self._file_path, self._mode)
1300 """Close the file. Is also called using del."""
1301 if self._opened and not self._use_stdout:
1302 _bt_file_close(self._file)
1303 self._opened = False