projects / babeltrace.git / blob
? search:


c39b53ad08866b06fbd9811aac74e3c0e7b6e750
[babeltrace.git] / bindings / python / babeltrace.i.in
1 /*
2 * babeltrace.i.in
3 *
4 * Babeltrace Python Module interface file
5 *
6 * Copyright 2012 EfficiOS Inc.
7 *
8 * Author: Danny Serres <danny.serres@efficios.com>
9 *
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:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 */
20
21
22 %define DOCSTRING
23 "BABELTRACE_VERSION_STR
24
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.
28
29 To use this module, the first step is to create a Context and add a
30 trace to it."
31 %enddef
32
33 %module(docstring=DOCSTRING) babeltrace
34
35 %include "typemaps.i"
36 %{
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"
51 %}
52
53 typedef unsigned long long uint64_t;
54 typedef long long int64_t;
55 typedef int bt_intern_str;
56
57 /* =================================================================
58 CONTEXT.H, CONTEXT-INTERNAL.H
59 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
60 */
61
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);
73
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);
82
83 // class Context to prevent direct access to struct bt_context
84 %pythoncode%{
85 class Context:
86 """
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.
91 """
92
93 def __init__(self):
94 self._c = _bt_context_create()
95
96 def __del__(self):
97 _bt_context_put(self._c)
98
99 def add_trace(self, path, format_str,
100 packet_seek=None, stream_list=None, metadata=None):
101 """
102 Add a trace by path to the context.
103
104 Open a trace.
105
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.
109
110 format is a string containing the format name in which the trace was
111 produced.
112
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.
115
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.
119
120 The metadata parameter acts as a metadata override when not None,
121 otherwise the format handles the metadata opening.
122
123 Return: the corresponding TraceHandle on success or None on error.
124 """
125 if metadata is not None:
126 metadata = metadata._file
127
128 ret = _bt_context_add_trace(self._c, path, format_str, packet_seek,
129 stream_list, metadata)
130 if ret < 0:
131 return None
132
133 th = TraceHandle.__new__(TraceHandle)
134 th._id = ret
135 return th
136
137 def add_traces_recursive(self, path, format_str):
138 """
139 Open a trace recursively.
140
141 Find each trace present in the subdirectory starting from the given
142 path, and add them to the context.
143
144 Return a dict of TraceHandle instances (the full path is the key).
145 Return None on error.
146 """
147
148 import os
149
150 trace_handles = {}
151
152 noTrace = True
153 error = False
154
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:
159 error = True
160 continue
161
162 trace_handles[fullpath] = trace_handle
163 noTrace = False
164
165 if noTrace and error:
166 return None
167 return trace_handles
168
169 def remove_trace(self, trace_handle):
170 """
171 Remove a trace from the context.
172 Effectively closing the trace.
173 """
174 try:
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")
179 %}
180
181
182
183 /* =================================================================
184 FORMAT.H, REGISTRY
185 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
186 */
187
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);
192
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);
197
198 %pythoncode %{
199
200 def print_format_list(babeltrace_file):
201 """
202 Print a list of available formats to file.
203
204 babeltrace_file must be a File instance opened in write mode.
205 """
206 try:
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")
212
213 %}
214
215
216 /* =================================================================
217 ITERATOR.H, ITERATOR-INTERNAL.H
218 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
219 */
220
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,
230 uint64_t timestamp);
231
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);
240
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;
247
248 // This struct is taken from iterator.h
249 // All changes to the struct must also be made here
250 struct bt_iter_pos {
251 enum {
252 BT_SEEK_TIME, /* uses u.seek_time */
253 BT_SEEK_RESTORE, /* uses u.restore */
254 BT_SEEK_CUR,
255 BT_SEEK_BEGIN,
256 BT_SEEK_LAST
257 } type;
258 union {
259 uint64_t seek_time;
260 struct bt_saved_pos *restore;
261 } u;
262 };
263
264
265 %pythoncode%{
266
267 class IterPos:
268 """This class represents the position where to set an iterator."""
269
270 __can_access = False
271
272 def __init__(self, seek_type, seek_time = None):
273 """
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
278 in Iter class.
279 """
280
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
286
287 def __del__(self):
288 if not self.__can_access:
289 _bt_iter_free_pos(self._pos)
290
291 def _get_type(self):
292 if not __can_access:
293 raise AttributeError("seek_type is not available")
294 return self._pos.type
295
296 def _set_type(self, seek_type):
297 if not __can_access:
298 raise AttributeError("seek_type is not available")
299 self._pos.type = seek_type
300
301 def _get_time(self):
302 if not __can_access:
303 raise AttributeError("seek_time is not available")
304
305 elif self._pos.type is not SEEK_TIME:
306 raise TypeError("seek_type is not SEEK_TIME")
307
308 return self._pos.u.seek_time
309
310 def _set_time(self, time):
311 if not __can_access:
312 raise AttributeError("seek_time is not available")
313
314 elif self._pos.type is not SEEK_TIME:
315 raise TypeError("seek_type is not SEEK_TIME")
316
317 self._pos.u.seek_time = time
318
319 def _get_pos(self):
320 return self._pos
321
322
323 seek_type = property(_get_type, _set_type)
324 seek_time = property(_get_time, _set_time)
325
326
327 class Iterator:
328
329 __with_init = False
330
331 def __init__(self, context, begin_pos = None, end_pos = None, _no_init = None):
332 """
333 Allocate a trace collection iterator.
334
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".
339
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.
343 """
344 if _no_init is None:
345 if begin_pos is None:
346 bp = None
347 else:
348 try:
349 bp = begin_pos._pos
350 except AttributeError:
351 raise TypeError("in __init__, "
352 "argument 3 must be a IterPos instance")
353
354 if end_pos is None:
355 ep = None
356 else:
357 try:
358 ep = end_pos._pos
359 except AttributeError:
360 raise TypeError("in __init__, "
361 "argument 4 must be a IterPos instance")
362
363 try:
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")
368
369 self.__with_init = True
370
371 else:
372 self._bi = _no_init
373
374 def __del__(self):
375 if self.__with_init:
376 _bt_iter_destroy(self._bi)
377
378 def next(self):
379 """
380 Move trace collection position to the next event.
381 Returns 0 on success, a negative value on error.
382 """
383 return _bt_iter_next(self._bi)
384
385 def get_pos(self):
386 """Return a IterPos class of the current iterator position."""
387 ret = IterPos(0)
388 ret.__can_access = False
389 ret._pos = _bt_iter_get_pos(self._bi)
390 return ret
391
392 def set_pos(self, pos):
393 """
394 Move the iterator to a given position.
395
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
399 trace collection.
400 Return -EINVAL when called with invalid parameter.
401 Return -ENOMEM if the stream_heap could not be properly initialized.
402 """
403 try:
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")
408
409 def create_time_pos(self, timestamp):
410 """
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.
414 """
415
416 if timestamp < 0:
417 raise TypeError("timestamp must be an unsigned int")
418
419 ret = IterPos(0)
420 ret.__can_access = False
421 ret._pos = _bt_iter_create_time_pos(self._bi, timestamp)
422 return ret
423 %}
424
425
426 /* =================================================================
427 CLOCK-TYPE.H
428 ¯¯¯¯¯¯¯¯¯¯¯¯
429 *** Enum copied from clock-type.h­
430 All changes must also be made here
431 */
432 %rename("CLOCK_CYCLES") BT_CLOCK_CYCLES;
433 %rename("CLOCK_REAL") BT_CLOCK_REAL;
434
435 enum bt_clock_type {
436 BT_CLOCK_CYCLES = 0,
437 BT_CLOCK_REAL
438 };
439
440 /* =================================================================
441 TRACE-HANDLE.H, TRACE-HANDLE-INTERNAL.H
442 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
443 */
444
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);
449
450 %rename("_bt_trace_handle_get_path") bt_trace_handle_get_path(struct bt_context *ctx,
451 int handle_id);
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);
461
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);
465
466
467 %pythoncode%{
468
469 class TraceHandle(object):
470 """
471 The TraceHandle allows the user to manipulate a trace file directly.
472 It is a unique identifier representing a trace file.
473 Do not instantiate.
474 """
475
476 def __init__(self):
477 raise NotImplementedError("TraceHandle cannot be instantiated")
478
479 def __repr__(self):
480 return "Babeltrace TraceHandle: trace_id('{0}')".format(self._id)
481
482 def get_id(self):
483 """Return the TraceHandle id."""
484 return self._id
485
486 def get_path(self, context):
487 """Return the path of a TraceHandle."""
488 try:
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")
493
494 def get_timestamp_begin(self, context, clock_type):
495 """Return the creation time of the buffers of a trace."""
496 try:
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")
502
503 def get_timestamp_end(self, context, clock_type):
504 """Return the destruction timestamp of the buffers of a trace."""
505 try:
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")
511
512 %}
513
514
515
516 // =================================================================
517 // CTF
518 // =================================================================
519
520 /* =================================================================
521 ITERATOR.H, EVENTS.H
522 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
523 */
524
525 //Iterator
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);
532
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);
539
540
541 //Events
542
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);
550
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
584 const struct bt_definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *ctf_event,
585 enum bt_ctf_scope scope);
586 const char *bt_ctf_event_name(const struct bt_ctf_event *ctf_event);
587 uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *ctf_event);
588 uint64_t bt_ctf_get_cycles(const struct bt_ctf_event *ctf_event);
589 const struct bt_definition *bt_ctf_get_field(const struct bt_ctf_event *ctf_event,
590 const struct bt_definition *scope,
591 const char *field);
592 const struct bt_definition *bt_ctf_get_index(const struct bt_ctf_event *ctf_event,
593 const struct bt_definition *field,
594 unsigned int index);
595 const char *bt_ctf_field_name(const struct bt_definition *field);
596 enum ctf_type_id bt_ctf_field_type(const struct bt_declaration *field);
597 int bt_ctf_get_int_signedness(const struct bt_declaration *field);
598 int bt_ctf_get_int_base(const struct bt_declaration *field);
599 int bt_ctf_get_int_byte_order(const struct bt_declaration *field);
600 ssize_t bt_ctf_get_int_len(const struct bt_declaration *field);
601 const struct bt_definition *bt_ctf_get_enum_int(const struct bt_definition *field);
602 const char *bt_ctf_get_enum_str(const struct bt_definition *field);
603 enum ctf_string_encoding bt_ctf_get_encoding(const struct bt_declaration *field);
604 int bt_ctf_get_array_len(const struct bt_declaration *field);
605 struct bt_definition *bt_array_index(struct definition_array *array, uint64_t i);
606 uint64_t bt_ctf_get_uint64(const struct bt_definition *field);
607 int64_t bt_ctf_get_int64(const struct bt_definition *field);
608 char *bt_ctf_get_char_array(const struct bt_definition *field);
609 char *bt_ctf_get_string(const struct bt_definition *field);
610 double bt_ctf_get_float(const struct bt_definition *field);
611 const struct bt_definition *bt_ctf_get_variant(const struct bt_definition *field);
612 int bt_ctf_field_get_error(void);
613 const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event);
614 const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field);
615 const struct bt_declaration *bt_ctf_get_decl_from_def(const struct bt_definition *field);
616 uint64_t bt_sequence_len(struct definition_sequence *sequence);
617 struct bt_definition *bt_sequence_index(struct definition_sequence *sequence, uint64_t i);
618
619 %pythoncode%{
620
621 class ctf:
622
623 #enum equivalent, accessible constants
624 #These are taken directly from ctf/events.h
625 #All changes to enums must also be made here
626 class type_id:
627 UNKNOWN = 0
628 INTEGER = 1
629 FLOAT = 2
630 ENUM = 3
631 STRING = 4
632 STRUCT = 5
633 UNTAGGED_VARIANT = 6
634 VARIANT = 7
635 ARRAY = 8
636 SEQUENCE = 9
637 NR_CTF_TYPES = 10
638
639 def get_type_id_name(id):
640 name = "UNKNOWN"
641 constants = [attr for attr in dir(ctf.type_id) if not callable(getattr(ctf.type_id, attr)) and not attr.startswith("__")]
642 for attr in constants:
643 if getattr(ctf.type_id, attr) == id:
644 name = attr
645 break
646 return name
647
648 class scope:
649 TRACE_PACKET_HEADER = 0
650 STREAM_PACKET_CONTEXT = 1
651 STREAM_EVENT_HEADER = 2
652 STREAM_EVENT_CONTEXT = 3
653 EVENT_CONTEXT = 4
654 EVENT_FIELDS = 5
655
656 class string_encoding:
657 NONE = 0
658 UTF8 = 1
659 ASCII = 2
660 UNKNOWN = 3
661
662 class Iterator(Iterator, object):
663 """
664 Allocate a CTF trace collection iterator.
665
666 begin_pos and end_pos are optional parameters to specify the
667 position at which the trace collection should be seeked upon
668 iterator creation, and the position at which iteration will
669 start returning "EOF".
670
671 By default, if begin_pos is None, a SEEK_CUR is performed at
672 creation. By default, if end_pos is None, a SEEK_END (end of
673 trace) is the EOF criterion.
674
675 Only one iterator can be created against a context. If more than one
676 iterator is being created for the same context, the second creation
677 will return None. The previous iterator must be destroyed before
678 creation of the new iterator for this function to succeed.
679 """
680
681 def __new__(cls, context, begin_pos = None, end_pos = None):
682 # __new__ is used to control the return value
683 # as the ctf.Iterator class should return None
684 # if bt_ctf_iter_create returns NULL
685
686 if begin_pos is None:
687 bp = None
688 else:
689 bp = begin_pos._pos
690 if end_pos is None:
691 ep = None
692 else:
693 ep = end_pos._pos
694 try:
695 it = _bt_ctf_iter_create(context._c, bp, ep)
696 except AttributeError:
697 raise TypeError("in __init__, "
698 "argument 2 must be a Context instance")
699 if it is None:
700 return None
701
702 ret_class = super(ctf.Iterator, cls).__new__(cls)
703 ret_class._i = it
704 return ret_class
705
706 def __init__(self, context, begin_pos = None, end_pos = None):
707 Iterator.__init__(self, None, None, None,
708 _bt_ctf_get_iter(self._i))
709
710 def __del__(self):
711 _bt_ctf_iter_destroy(self._i)
712
713 def read_event(self):
714 """
715 Read the iterator's current event data.
716 Return current event on success, None on end of trace.
717 """
718 ret = _bt_ctf_iter_read_event(self._i)
719 if ret is None:
720 return ret
721 ev = ctf.Event.__new__(ctf.Event)
722 ev._e = ret
723 return ev
724
725
726 class Event(object):
727 """
728 This class represents an event from the trace.
729 It is obtained with read_event() from ctf.Iterator.
730 Do not instantiate.
731 """
732
733 def __init__(self):
734 raise NotImplementedError("ctf.Event cannot be instantiated")
735
736 def get_top_level_scope(self, scope):
737 """
738 Return a definition of the top-level scope
739 Top-level scopes are defined in ctf.scope.
740 In order to get a field or a field list, the user needs to pass a
741 scope as argument, this scope can be a top-level scope or a scope
742 relative to an arbitrary field. This function provides the mapping
743 between the scope and the actual definition of top-level scopes.
744 On error return None.
745 """
746 evDef = ctf.Definition.__new__(ctf.Definition)
747 evDef._d = _bt_ctf_get_top_level_scope(self._e, scope)
748 if evDef._d is None:
749 return None
750 return evDef
751
752 def get_name(self):
753 """Return the name of the event or None on error."""
754 return _bt_ctf_event_name(self._e)
755
756 def get_cycles(self):
757 """
758 Return the timestamp of the event as written in
759 the packet (in cycles) or -1ULL on error.
760 """
761 return _bt_ctf_get_cycles(self._e)
762
763 def get_timestamp(self):
764 """
765 Return the timestamp of the event offsetted with the
766 system clock source or -1ULL on error.
767 """
768 return _bt_ctf_get_timestamp(self._e)
769
770 def get_field_with_scope(self, scope, field):
771 """
772 Return the definition of a specific field.
773 Return None on error.
774 """
775 evDef = ctf.Definition.__new__(ctf.Definition)
776 try:
777 evDef._d = _bt_ctf_get_field(self._e, scope._d, field)
778 except AttributeError:
779 raise TypeError("in get_field, argument 2 must be a "
780 "Definition (scope) instance")
781 if evDef._d is None:
782 return None
783 evDef._s = scope
784 return evDef
785
786 def get_field(self, field):
787 """
788 Return the definition of fields by a name
789 Return None on error
790 """
791 eventScope = self.get_top_level_scope(ctf.scope.EVENT_FIELDS)
792 streamScope = self.get_top_level_scope(ctf.scope.STREAM_EVENT_CONTEXT)
793 fields_by_name = []
794
795 if eventScope is not None:
796 evDef = self.get_field_with_scope(eventScope, field)
797 if evDef is not None:
798 fields_by_name.append(evDef)
799
800 if streamScope is not None:
801 evDef = self.get_field_with_scope(streamScope, field)
802 if evDef is not None:
803 fields_by_name.append(evDef);
804
805 if not fields_by_name:
806 return None
807 return fields_by_name
808
809 def get_field_list_with_scope(self, scope):
810 """
811 Return a list of Definitions associated with the scope
812 Return None on error.
813 """
814 try:
815 field_lc = _bt_python_field_listcaller(self._e, scope._d)
816 except AttributeError:
817 raise TypeError("in get_field_list, argument 2 must be a "
818 "Definition (scope) instance")
819
820 if field_lc is None:
821 return None
822
823 def_list = []
824 i = 0
825 while True:
826 tmp = ctf.Definition.__new__(ctf.Definition)
827 tmp._d = _bt_python_field_one_from_list(field_lc, i)
828
829 if tmp._d is None:
830 #Last item of list is None, assured in
831 #_bt_python_field_listcaller
832 break
833
834 tmp._s = scope
835 def_list.append(tmp)
836 i += 1
837 return def_list
838
839 def get_field_list(self):
840 """Return a list of Definitions or None on error."""
841 eventScope = self.get_top_level_scope(ctf.scope.EVENT_FIELDS)
842 streamScope = self.get_top_level_scope(ctf.scope.STREAM_EVENT_CONTEXT)
843
844 def_list = []
845 if eventScope is not None:
846 event_field_list = self.get_field_list_with_scope(eventScope)
847 if event_field_list is not None:
848 def_list = event_field_list
849
850 if streamScope is not None:
851 event_field_list = self.get_field_list_with_scope(streamScope)
852 if event_field_list is not None:
853 def_list.extend(event_field_list)
854
855 if not def_list:
856 return None
857 return def_list
858
859 def get_index(self, field, index):
860 """
861 If the field is an array or a sequence, return the element
862 at position index, otherwise return None
863 """
864 evDef = ctf.Definition.__new__(ctf.Definition)
865 try:
866 evDef._d = _bt_ctf_get_index(self._e, field._d, index)
867 except AttributeError:
868 raise TypeError("in get_index, argument 2 must be a "
869 "Definition (field) instance")
870
871 if evDef._d is None:
872 return None
873 return evDef
874
875 def get_handle(self):
876 """
877 Get the TraceHandle associated with an event
878 Return None on error
879 """
880 ret = _bt_ctf_event_get_handle_id(self._e)
881 if ret < 0:
882 return None
883
884 th = TraceHandle.__new__(TraceHandle)
885 th._id = ret
886 return th
887
888 def get_context(self):
889 """
890 Get the context associated with an event.
891 Return None on error.
892 """
893 ctx = Context()
894 ctx._c = _bt_ctf_event_get_context(self._e);
895 if ctx._c is None:
896 return None
897 else:
898 return ctx
899
900 class FieldError(Exception):
901 def __init__(self, value):
902 self.value = value
903
904 def __str__(self):
905 return repr(self.value)
906
907 class Definition(object):
908 """Definition class. Do not instantiate."""
909
910 def __init__(self):
911 raise NotImplementedError("ctf.Definition cannot be instantiated")
912
913 def __repr__(self):
914 return "Babeltrace Definition: name('{0}'), type({1})".format(
915 self.field_name(), self.field_type())
916
917 def field_name(self):
918 """Return the name of a field or None on error."""
919 return _bt_ctf_field_name(self._d)
920
921 def field_type(self):
922 """Return the type of a field or -1 if unknown."""
923 return _bt_ctf_field_type(_bt_ctf_get_decl_from_def(self._d))
924
925 def get_int_signedness(self):
926 """
927 Return the signedness of an integer:
928 0 if unsigned; 1 if signed; -1 on error.
929 """
930 return _bt_ctf_get_int_signedness(_bt_ctf_get_decl_from_def(self._d))
931
932 def get_int_base(self):
933 """Return the base of an int or a negative value on error."""
934 return _bt_ctf_get_int_base(_bt_ctf_get_decl_from_def(self._d))
935
936 def get_int_byte_order(self):
937 """
938 Return the byte order of an int or a negative
939 value on error.
940 """
941 return _bt_ctf_get_int_byte_order(_bt_ctf_get_decl_from_def(self._d))
942
943 def get_int_len(self):
944 """
945 Return the size, in bits, of an int or a negative
946 value on error.
947 """
948 return _bt_ctf_get_int_len(_bt_ctf_get_decl_from_def(self._d))
949
950 def get_enum_str(self):
951 """
952 Return the string matching the current enumeration.
953 Return None on error.
954 """
955 return _bt_ctf_get_enum_str(self._d)
956
957 def get_encoding(self):
958 """
959 Return the encoding of an int or a string.
960 Return a negative value on error.
961 """
962 return _bt_ctf_get_encoding(_bt_ctf_get_decl_from_def(self._d))
963
964 def get_array_len(self):
965 """
966 Return the len of an array or a negative
967 value on error.
968 """
969 return _bt_ctf_get_array_len(_bt_ctf_get_decl_from_def(self._d))
970
971 def get_array_element_at(self, index):
972 """
973 Return the array's element at position index.
974 Return None on error
975 """
976 array = _bt_python_get_array_from_def(self._d)
977 if array is None:
978 return None
979
980 element = ctf.Definition.__new__(ctf.Definition)
981 element._d = _bt_array_index(array, index)
982 if element._d is None:
983 return None
984 return element
985
986 def get_sequence_len(self):
987 """
988 Return the len of a sequence or a negative
989 value on error.
990 """
991 seq = _bt_python_get_sequence_from_def(self._d)
992 return _bt_sequence_len(seq)
993
994 def get_sequence_element_at(self, index):
995 """
996 Return the sequence's element at position index,
997 otherwise return None
998 """
999 seq = _bt_python_get_sequence_from_def(self._d)
1000 if seq is not None:
1001 element = ctf.Definition.__new__(ctf.Definition)
1002 element._d = _bt_sequence_index(seq, index)
1003 if element._d is not None:
1004 return element
1005 return None
1006
1007 def get_uint64(self):
1008 """
1009 Return the value associated with the field.
1010 If the field does not exist or is not of the type requested,
1011 the value returned is undefined. To check if an error occured,
1012 use the ctf.field_error() function after accessing a field.
1013 """
1014 return _bt_ctf_get_uint64(self._d)
1015
1016 def get_int64(self):
1017 """
1018 Return the value associated with the field.
1019 If the field does not exist or is not of the type requested,
1020 the value returned is undefined. To check if an error occured,
1021 use the ctf.field_error() function after accessing a field.
1022 """
1023 return _bt_ctf_get_int64(self._d)
1024
1025 def get_char_array(self):
1026 """
1027 Return the value associated with the field.
1028 If the field does not exist or is not of the type requested,
1029 the value returned is undefined. To check if an error occured,
1030 use the ctf.field_error() function after accessing a field.
1031 """
1032 return _bt_ctf_get_char_array(self._d)
1033
1034 def get_str(self):
1035 """
1036 Return the value associated with the field.
1037 If the field does not exist or is not of the type requested,
1038 the value returned is undefined. To check if an error occured,
1039 use the ctf.field_error() function after accessing a field.
1040 """
1041 return _bt_ctf_get_string(self._d)
1042
1043 def get_float(self):
1044 """
1045 Return the value associated with the field.
1046 If the field does not exist or is not of the type requested,
1047 the value returned is undefined. To check if an error occured,
1048 use the ctf.field_error() function after accessing a field.
1049 """
1050 return _bt_ctf_get_float(self._d)
1051
1052 def get_variant(self):
1053 """
1054 Return the variant's selected field.
1055 If the field does not exist or is not of the type requested,
1056 the value returned is undefined. To check if an error occured,
1057 use the ctf.field_error() function after accessing a field.
1058 """
1059 return _bt_ctf_get_variant(self._d)
1060
1061 def get_value(self):
1062 """
1063 Return the value associated with the field according to its type.
1064 Return None on error.
1065 """
1066 id = self.field_type()
1067 value = None
1068 if id == ctf.type_id.STRING:
1069 value = self.get_str()
1070 elif id == ctf.type_id.ARRAY:
1071 value = []
1072 for i in range(self.get_array_len()):
1073 element = self.get_array_element_at(i)
1074 value.append(element.get_value())
1075 elif id == ctf.type_id.INTEGER:
1076 if self.get_int_signedness() == 0:
1077 value = self.get_uint64()
1078 else:
1079 value = self.get_int64()
1080 elif id == ctf.type_id.ENUM:
1081 value = self.get_enum_str()
1082 elif id == ctf.type_id.SEQUENCE:
1083 seq_len = self.get_sequence_len()
1084 value = []
1085 for i in range(seq_len):
1086 evDef = self.get_sequence_element_at(i)
1087 value.append(evDef.get_value())
1088 elif id == ctf.type_id.FLOAT:
1089 value = self.get_float()
1090 elif id == ctf.type_id.VARIANT:
1091 variant = ctf.Definition.__new__(ctf.Definition)
1092 variant._d = self.get_variant();
1093 value = variant.get_value()
1094
1095 if ctf.field_error():
1096 raise ctf.FieldError("Error occured while accessing field {} of type {}".format(self.field_name(), ctf.type_id.get_type_id_name(self.field_type())))
1097 return value
1098
1099 def get_scope(self):
1100 """Return the scope of a field or None on error."""
1101 return self._s
1102
1103 class EventDecl(object):
1104 """Event declaration class. Do not instantiate."""
1105
1106 def __init__(self):
1107 raise NotImplementedError("ctf.EventDecl cannot be instantiated")
1108
1109 def __repr__(self):
1110 return "Babeltrace EventDecl: name {0}".format(self.get_name())
1111
1112 def get_name(self):
1113 """Return the name of the event or None on error"""
1114 return _bt_ctf_get_decl_event_name(self._d)
1115
1116 def get_decl_fields(self, scope):
1117 """
1118 Return a list of ctf.FieldDecl
1119 Return None on error.
1120 """
1121 ptr_list = _by_python_field_decl_listcaller(self._d, scope)
1122
1123 if ptr_list is None:
1124 return None
1125
1126 decl_list = []
1127 i = 0
1128 while True:
1129 tmp = ctf.FieldDecl.__new__(ctf.FieldDecl)
1130 tmp._d = _bt_python_field_decl_one_from_list(
1131 ptr_list, i)
1132
1133 if tmp._d is None:
1134 #Last item of list is None
1135 break
1136
1137 decl_list.append(tmp)
1138 i += 1
1139 return decl_list
1140
1141
1142 class FieldDecl(object):
1143 """Field declaration class. Do not instantiate."""
1144
1145 def __init__(self):
1146 raise NotImplementedError("ctf.FieldDecl cannot be instantiated")
1147
1148 def __repr__(self):
1149 return "Babeltrace FieldDecl: name {0}".format(self.get_name())
1150
1151 def get_name(self):
1152 """Return the name of a FieldDecl or None on error"""
1153 return _bt_ctf_get_decl_field_name(self._d)
1154
1155
1156 @staticmethod
1157 def field_error():
1158 """
1159 Return the last error code encountered while
1160 accessing a field and reset the error flag.
1161 Return 0 if no error, a negative value otherwise.
1162 """
1163 return _bt_ctf_field_get_error()
1164
1165 @staticmethod
1166 def get_event_decl_list(trace_handle, context):
1167 """
1168 Return a list of ctf.EventDecl
1169 Return None on error.
1170 """
1171 try:
1172 handle_id = trace_handle._id
1173 except AttributeError:
1174 raise TypeError("in get_event_decl_list, "
1175 "argument 1 must be a TraceHandle instance")
1176 try:
1177 ptr_list = _bt_python_event_decl_listcaller(handle_id, context._c)
1178 except AttributeError:
1179 raise TypeError("in get_event_decl_list, "
1180 "argument 2 must be a Context instance")
1181
1182 if ptr_list is None:
1183 return None
1184
1185 decl_list = []
1186 i = 0
1187 while True:
1188 tmp = ctf.EventDecl.__new__(ctf.EventDecl)
1189 tmp._d = _bt_python_decl_one_from_list(ptr_list, i)
1190
1191 if tmp._d is None:
1192 #Last item of list is None
1193 break
1194
1195 decl_list.append(tmp)
1196 i += 1
1197 return decl_list
1198
1199 %}
1200
1201
1202
1203 // =================================================================
1204 // NEW FUNCTIONS
1205 // File and list-related
1206 // python-complements.h
1207 // =================================================================
1208
1209 %include python-complements.c
1210
1211 %pythoncode %{
1212
1213 class File(object):
1214 """
1215 Open a file for babeltrace.
1216
1217 file_path is a string containing the path or None to use the
1218 standard output in writing mode.
1219
1220 The mode can be 'r', 'w' or 'a' for reading (default), writing or
1221 appending. The file will be created if it doesn't exist when
1222 opened for writing or appending; it will be truncated when opened
1223 for writing. Add a 'b' to the mode for binary files. Add a '+'
1224 to the mode to allow simultaneous reading and writing.
1225 """
1226
1227 def __new__(cls, file_path, mode='r'):
1228 # __new__ is used to control the return value
1229 # as the File class should return None
1230 # if _bt_file_open returns NULL
1231
1232 # Type check
1233 if file_path is not None and type(file_path) is not str:
1234 raise TypeError("in method __init__, argument 2 of type 'str'")
1235 if type(mode) is not str:
1236 raise TypeError("in method __init__, argument 3 of type 'str'")
1237
1238 # Opening file
1239 file_ptr = _bt_file_open(file_path, mode)
1240 if file_ptr is None:
1241 return None
1242
1243 # Class instantiation
1244 file_inst = super(File, cls).__new__(cls)
1245 file_inst._file = file_ptr
1246 return file_inst
1247
1248 def __init__(self, file_path, mode='r'):
1249 self._opened = True
1250 self._use_stdout = False
1251
1252 if file_path is None:
1253 # use stdout
1254 file_path = "stdout"
1255 mode = 'w'
1256 self._use_stdout = True
1257
1258 self._file_path = file_path
1259 self._mode = mode
1260
1261 def __del__(self):
1262 self.close()
1263
1264 def __repr__(self):
1265 if self._opened:
1266 stat = 'opened'
1267 else:
1268 stat = 'closed'
1269 return "{0} babeltrace File; file_path('{1}'), mode('{2}')".format(
1270 stat, self._file_path, self._mode)
1271
1272 def close(self):
1273 """Close the file. Is also called using del."""
1274 if self._opened and not self._use_stdout:
1275 _bt_file_close(self._file)
1276 self._opened = False
1277 %}
BabelTrace - Trace Format Babel Tower
This page took 0.052396 seconds and 3 git commands to generate.