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_field_get_error") bt_ctf_field_get_error(void);
572 %rename("_bt_ctf_get_decl_event_name") bt_ctf_get_decl_event_name(const struct
573 bt_ctf_event_decl *event);
574 %rename("_bt_ctf_get_decl_field_name") bt_ctf_get_decl_field_name(
575 const struct bt_ctf_field_decl *field);
576 %rename("_bt_ctf_get_decl_from_def") bt_ctf_get_decl_from_def(
577 const struct bt_definition *field);
578 %rename("_bt_array_index") bt_array_index(struct definition_array *array, uint64_t i);
579 %rename("_bt_sequence_len") bt_sequence_len(struct definition_sequence *sequence);
580 %rename("_bt_sequence_index") bt_sequence_index(struct definition_sequence *sequence, uint64_t i);
582 const struct bt_definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *ctf_event,
583 enum bt_ctf_scope scope);
584 const char *bt_ctf_event_name(const struct bt_ctf_event *ctf_event);
585 uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *ctf_event);
586 uint64_t bt_ctf_get_cycles(const struct bt_ctf_event *ctf_event);
587 const struct bt_definition *bt_ctf_get_field(const struct bt_ctf_event *ctf_event,
588 const struct bt_definition *scope,
590 const struct bt_definition *bt_ctf_get_index(const struct bt_ctf_event *ctf_event,
591 const struct bt_definition *field,
593 const char *bt_ctf_field_name(const struct bt_definition *field);
594 enum ctf_type_id bt_ctf_field_type(const struct bt_declaration *field);
595 int bt_ctf_get_int_signedness(const struct bt_declaration *field);
596 int bt_ctf_get_int_base(const struct bt_declaration *field);
597 int bt_ctf_get_int_byte_order(const struct bt_declaration *field);
598 ssize_t bt_ctf_get_int_len(const struct bt_declaration *field);
599 const struct bt_definition *bt_ctf_get_enum_int(const struct bt_definition *field);
600 const char *bt_ctf_get_enum_str(const struct bt_definition *field);
601 enum ctf_string_encoding bt_ctf_get_encoding(const struct bt_declaration *field);
602 int bt_ctf_get_array_len(const struct bt_declaration *field);
603 struct bt_definition *bt_array_index(struct definition_array *array, uint64_t i);
604 uint64_t bt_ctf_get_uint64(const struct bt_definition *field);
605 int64_t bt_ctf_get_int64(const struct bt_definition *field);
606 char *bt_ctf_get_char_array(const struct bt_definition *field);
607 char *bt_ctf_get_string(const struct bt_definition *field);
608 int bt_ctf_field_get_error(void);
609 const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event);
610 const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field);
611 const struct bt_declaration *bt_ctf_get_decl_from_def(const struct bt_definition *field);
612 uint64_t bt_sequence_len(struct definition_sequence *sequence);
613 struct bt_definition *bt_sequence_index(struct definition_sequence *sequence, uint64_t i);
619 #enum equivalent, accessible constants
620 #These are taken directly from ctf/events.h
621 #All changes to enums must also be made here
636 TRACE_PACKET_HEADER = 0
637 STREAM_PACKET_CONTEXT = 1
638 STREAM_EVENT_HEADER = 2
639 STREAM_EVENT_CONTEXT = 3
643 class string_encoding:
649 class Iterator(Iterator, object):
651 Allocate a CTF trace collection iterator.
653 begin_pos and end_pos are optional parameters to specify the
654 position at which the trace collection should be seeked upon
655 iterator creation, and the position at which iteration will
656 start returning "EOF".
658 By default, if begin_pos is None, a SEEK_CUR is performed at
659 creation. By default, if end_pos is None, a SEEK_END (end of
660 trace) is the EOF criterion.
662 Only one iterator can be created against a context. If more than one
663 iterator is being created for the same context, the second creation
664 will return None. The previous iterator must be destroyed before
665 creation of the new iterator for this function to succeed.
668 def __new__(cls, context, begin_pos = None, end_pos = None):
669 # __new__ is used to control the return value
670 # as the ctf.Iterator class should return None
671 # if bt_ctf_iter_create returns NULL
673 if begin_pos is None:
682 it = _bt_ctf_iter_create(context._c, bp, ep)
683 except AttributeError:
684 raise TypeError("in __init__, "
685 "argument 2 must be a Context instance")
689 ret_class = super(ctf.Iterator, cls).__new__(cls)
693 def __init__(self, context, begin_pos = None, end_pos = None):
694 Iterator.__init__(self, None, None, None,
695 _bt_ctf_get_iter(self._i))
698 _bt_ctf_iter_destroy(self._i)
700 def read_event(self):
702 Read the iterator's current event data.
703 Return current event on success, None on end of trace.
705 ret = _bt_ctf_iter_read_event(self._i)
708 ev = ctf.Event.__new__(ctf.Event)
715 This class represents an event from the trace.
716 It is obtained with read_event() from ctf.Iterator.
721 raise NotImplementedError("ctf.Event cannot be instantiated")
723 def get_top_level_scope(self, scope):
725 Return a definition of the top-level scope
726 Top-level scopes are defined in ctf.scope.
727 In order to get a field or a field list, the user needs to pass a
728 scope as argument, this scope can be a top-level scope or a scope
729 relative to an arbitrary field. This function provides the mapping
730 between the scope and the actual definition of top-level scopes.
731 On error return None.
733 evDef = ctf.Definition.__new__(ctf.Definition)
734 evDef._d = _bt_ctf_get_top_level_scope(self._e, scope)
740 """Return the name of the event or None on error."""
741 return _bt_ctf_event_name(self._e)
743 def get_cycles(self):
745 Return the timestamp of the event as written in
746 the packet (in cycles) or -1ULL on error.
748 return _bt_ctf_get_cycles(self._e)
750 def get_timestamp(self):
752 Return the timestamp of the event offsetted with the
753 system clock source or -1ULL on error.
755 return _bt_ctf_get_timestamp(self._e)
757 def get_field_with_scope(self, scope, field):
759 Return the definition of a specific field.
760 Return None on error.
762 evDef = ctf.Definition.__new__(ctf.Definition)
764 evDef._d = _bt_ctf_get_field(self._e, scope._d, field)
765 except AttributeError:
766 raise TypeError("in get_field, argument 2 must be a "
767 "Definition (scope) instance")
773 def get_field(self, field):
775 Return the definition of fields by a name
778 eventScope = self.get_top_level_scope(ctf.scope.EVENT_FIELDS)
779 streamScope = self.get_top_level_scope(ctf.scope.STREAM_EVENT_CONTEXT)
782 if eventScope is not None:
783 evDef = self.get_field_with_scope(eventScope, field)
784 if evDef is not None:
785 fields_by_name.append(evDef)
787 if streamScope is not None:
788 evDef = self.get_field_with_scope(streamScope, field)
789 if evDef is not None:
790 fields_by_name.append(evDef);
792 if not fields_by_name:
794 return fields_by_name
796 def get_field_list_with_scope(self, scope):
798 Return a list of Definitions associated with the scope
799 Return None on error.
802 field_lc = _bt_python_field_listcaller(self._e, scope._d)
803 except AttributeError:
804 raise TypeError("in get_field_list, argument 2 must be a "
805 "Definition (scope) instance")
813 tmp = ctf.Definition.__new__(ctf.Definition)
814 tmp._d = _bt_python_field_one_from_list(field_lc, i)
817 #Last item of list is None, assured in
818 #_bt_python_field_listcaller
826 def get_field_list(self):
827 """Return a list of Definitions or None on error."""
828 eventScope = self.get_top_level_scope(ctf.scope.EVENT_FIELDS)
829 streamScope = self.get_top_level_scope(ctf.scope.STREAM_EVENT_CONTEXT)
832 if eventScope is not None:
833 event_field_list = self.get_field_list_with_scope(eventScope)
834 if event_field_list is not None:
835 def_list = event_field_list
837 if streamScope is not None:
838 event_field_list = self.get_field_list_with_scope(streamScope)
839 if event_field_list is not None:
840 def_list.extend(event_field_list)
846 def get_index(self, field, index):
848 If the field is an array or a sequence, return the element
849 at position index, otherwise return None
851 evDef = ctf.Definition.__new__(ctf.Definition)
853 evDef._d = _bt_ctf_get_index(self._e, field._d, index)
854 except AttributeError:
855 raise TypeError("in get_index, argument 2 must be a "
856 "Definition (field) instance")
862 def get_handle(self):
864 Get the TraceHandle associated with an event
867 ret = _bt_ctf_event_get_handle_id(self._e)
871 th = TraceHandle.__new__(TraceHandle)
875 def get_context(self):
877 Get the context associated with an event.
878 Return None on error.
881 ctx._c = _bt_ctf_event_get_context(self._e);
888 class Definition(object):
889 """Definition class. Do not instantiate."""
892 raise NotImplementedError("ctf.Definition cannot be instantiated")
895 return "Babeltrace Definition: name('{0}'), type({1})".format(
896 self.field_name(), self.field_type())
898 def field_name(self):
899 """Return the name of a field or None on error."""
900 return _bt_ctf_field_name(self._d)
902 def field_type(self):
903 """Return the type of a field or -1 if unknown."""
904 return _bt_ctf_field_type(_bt_ctf_get_decl_from_def(self._d))
906 def get_int_signedness(self):
908 Return the signedness of an integer:
909 0 if unsigned; 1 if signed; -1 on error.
911 return _bt_ctf_get_int_signedness(_bt_ctf_get_decl_from_def(self._d))
913 def get_int_base(self):
914 """Return the base of an int or a negative value on error."""
915 return _bt_ctf_get_int_base(_bt_ctf_get_decl_from_def(self._d))
917 def get_int_byte_order(self):
919 Return the byte order of an int or a negative
922 return _bt_ctf_get_int_byte_order(_bt_ctf_get_decl_from_def(self._d))
924 def get_int_len(self):
926 Return the size, in bits, of an int or a negative
929 return _bt_ctf_get_int_len(_bt_ctf_get_decl_from_def(self._d))
931 def get_enum_str(self):
933 Return the string matching the current enumeration.
934 Return None on error.
936 return _bt_ctf_get_enum_str(self._d)
938 def get_encoding(self):
940 Return the encoding of an int or a string.
941 Return a negative value on error.
943 return _bt_ctf_get_encoding(_bt_ctf_get_decl_from_def(self._d))
945 def get_array_len(self):
947 Return the len of an array or a negative
950 return _bt_ctf_get_array_len(_bt_ctf_get_decl_from_def(self._d))
952 def get_array_element_at(self, index):
954 Return the array's element at position index.
957 array = _bt_python_get_array_from_def(self._d)
961 element = ctf.Definition.__new__(ctf.Definition)
962 element._d = _bt_array_index(array, index)
963 if element._d is None:
967 def get_sequence_len(self):
969 Return the len of a sequence or a negative
972 seq = _bt_python_get_sequence_from_def(self._d)
973 return _bt_sequence_len(seq)
975 def get_sequence_element_at(self, index):
977 Return the sequence's element at position index,
978 otherwise return None
980 seq = _bt_python_get_sequence_from_def(self._d)
982 element = ctf.Definition.__new__(ctf.Definition)
983 element._d = _bt_sequence_index(seq, index)
984 if element._d is not None:
988 def get_uint64(self):
990 Return the value associated with the field.
991 If the field does not exist or is not of the type requested,
992 the value returned is undefined. To check if an error occured,
993 use the ctf.field_error() function after accessing a field.
995 return _bt_ctf_get_uint64(self._d)
999 Return the value associated with the field.
1000 If the field does not exist or is not of the type requested,
1001 the value returned is undefined. To check if an error occured,
1002 use the ctf.field_error() function after accessing a field.
1004 return _bt_ctf_get_int64(self._d)
1006 def get_char_array(self):
1008 Return the value associated with the field.
1009 If the field does not exist or is not of the type requested,
1010 the value returned is undefined. To check if an error occured,
1011 use the ctf.field_error() function after accessing a field.
1013 return _bt_ctf_get_char_array(self._d)
1017 Return the value associated with the field.
1018 If the field does not exist or is not of the type requested,
1019 the value returned is undefined. To check if an error occured,
1020 use the ctf.field_error() function after accessing a field.
1022 return _bt_ctf_get_string(self._d)
1024 def get_value(self):
1026 Return the value associated with the field according to its type.
1027 Return None on error.
1029 id = self.field_type()
1030 if id == ctf.type_id.STRING:
1031 return self.get_str()
1032 if id == ctf.type_id.ARRAY:
1034 for i in range(self.get_array_len()):
1035 element = self.get_array_element_at(i)
1036 array.append(element.get_value())
1038 if id == ctf.type_id.INTEGER:
1039 if self.get_int_signedness() == 0:
1040 return self.get_uint64()
1042 return self.get_int64()
1043 if id == ctf.type_id.ENUM:
1044 return self.get_enum_str()
1045 if id == ctf.type_id.SEQUENCE:
1046 seq_len = self.get_sequence_len()
1048 for i in range(seq_len):
1049 evDef = self.get_sequence_element_at(i)
1050 values.append(evDef.get_value())
1054 def get_scope(self):
1055 """Return the scope of a field or None on error."""
1058 class EventDecl(object):
1059 """Event declaration class. Do not instantiate."""
1062 raise NotImplementedError("ctf.EventDecl cannot be instantiated")
1065 return "Babeltrace EventDecl: name {0}".format(self.get_name())
1068 """Return the name of the event or None on error"""
1069 return _bt_ctf_get_decl_event_name(self._d)
1071 def get_decl_fields(self, scope):
1073 Return a list of ctf.FieldDecl
1074 Return None on error.
1076 ptr_list = _by_python_field_decl_listcaller(self._d, scope)
1078 if ptr_list is None:
1084 tmp = ctf.FieldDecl.__new__(ctf.FieldDecl)
1085 tmp._d = _bt_python_field_decl_one_from_list(
1089 #Last item of list is None
1092 decl_list.append(tmp)
1097 class FieldDecl(object):
1098 """Field declaration class. Do not instantiate."""
1101 raise NotImplementedError("ctf.FieldDecl cannot be instantiated")
1104 return "Babeltrace FieldDecl: name {0}".format(self.get_name())
1107 """Return the name of a FieldDecl or None on error"""
1108 return _bt_ctf_get_decl_field_name(self._d)
1114 Return the last error code encountered while
1115 accessing a field and reset the error flag.
1116 Return 0 if no error, a negative value otherwise.
1118 return _bt_ctf_field_get_error()
1121 def get_event_decl_list(trace_handle, context):
1123 Return a list of ctf.EventDecl
1124 Return None on error.
1127 handle_id = trace_handle._id
1128 except AttributeError:
1129 raise TypeError("in get_event_decl_list, "
1130 "argument 1 must be a TraceHandle instance")
1132 ptr_list = _bt_python_event_decl_listcaller(handle_id, context._c)
1133 except AttributeError:
1134 raise TypeError("in get_event_decl_list, "
1135 "argument 2 must be a Context instance")
1137 if ptr_list is None:
1143 tmp = ctf.EventDecl.__new__(ctf.EventDecl)
1144 tmp._d = _bt_python_decl_one_from_list(ptr_list, i)
1147 #Last item of list is None
1150 decl_list.append(tmp)
1158 // =================================================================
1160 // File and list-related
1161 // python-complements.h
1162 // =================================================================
1164 %include python-complements.c
1170 Open a file for babeltrace.
1172 file_path is a string containing the path or None to use the
1173 standard output in writing mode.
1175 The mode can be 'r', 'w' or 'a' for reading (default), writing or
1176 appending. The file will be created if it doesn't exist when
1177 opened for writing or appending; it will be truncated when opened
1178 for writing. Add a 'b' to the mode for binary files. Add a '+'
1179 to the mode to allow simultaneous reading and writing.
1182 def __new__(cls, file_path, mode='r'):
1183 # __new__ is used to control the return value
1184 # as the File class should return None
1185 # if _bt_file_open returns NULL
1188 if file_path is not None and type(file_path) is not str:
1189 raise TypeError("in method __init__, argument 2 of type 'str'")
1190 if type(mode) is not str:
1191 raise TypeError("in method __init__, argument 3 of type 'str'")
1194 file_ptr = _bt_file_open(file_path, mode)
1195 if file_ptr is None:
1198 # Class instantiation
1199 file_inst = super(File, cls).__new__(cls)
1200 file_inst._file = file_ptr
1203 def __init__(self, file_path, mode='r'):
1205 self._use_stdout = False
1207 if file_path is None:
1209 file_path = "stdout"
1211 self._use_stdout = True
1213 self._file_path = file_path
1224 return "{0} babeltrace File; file_path('{1}'), mode('{2}')".format(
1225 stat, self._file_path, self._mode)
1228 """Close the file. Is also called using del."""
1229 if self._opened and not self._use_stdout:
1230 _bt_file_close(self._file)
1231 self._opened = False