projects / babeltrace.git / blob
? search:


3e228ecccc7aed2c056b6346587d3ef349cb0645
[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_field_get_error") bt_ctf_field_get_error(void);
573 %rename("_bt_ctf_get_decl_event_name") bt_ctf_get_decl_event_name(const struct
574 bt_ctf_event_decl *event);
575 %rename("_bt_ctf_get_decl_field_name") bt_ctf_get_decl_field_name(
576 const struct bt_ctf_field_decl *field);
577 %rename("_bt_ctf_get_decl_from_def") bt_ctf_get_decl_from_def(
578 const struct bt_definition *field);
579 %rename("_bt_array_index") bt_array_index(struct definition_array *array, uint64_t i);
580 %rename("_bt_sequence_len") bt_sequence_len(struct definition_sequence *sequence);
581 %rename("_bt_sequence_index") bt_sequence_index(struct definition_sequence *sequence, uint64_t i);
582
583 const struct bt_definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *ctf_event,
584 enum bt_ctf_scope scope);
585 const char *bt_ctf_event_name(const struct bt_ctf_event *ctf_event);
586 uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *ctf_event);
587 uint64_t bt_ctf_get_cycles(const struct bt_ctf_event *ctf_event);
588 const struct bt_definition *bt_ctf_get_field(const struct bt_ctf_event *ctf_event,
589 const struct bt_definition *scope,
590 const char *field);
591 const struct bt_definition *bt_ctf_get_index(const struct bt_ctf_event *ctf_event,
592 const struct bt_definition *field,
593 unsigned int index);
594 const char *bt_ctf_field_name(const struct bt_definition *field);
595 enum ctf_type_id bt_ctf_field_type(const struct bt_declaration *field);
596 int bt_ctf_get_int_signedness(const struct bt_declaration *field);
597 int bt_ctf_get_int_base(const struct bt_declaration *field);
598 int bt_ctf_get_int_byte_order(const struct bt_declaration *field);
599 ssize_t bt_ctf_get_int_len(const struct bt_declaration *field);
600 const struct bt_definition *bt_ctf_get_enum_int(const struct bt_definition *field);
601 const char *bt_ctf_get_enum_str(const struct bt_definition *field);
602 enum ctf_string_encoding bt_ctf_get_encoding(const struct bt_declaration *field);
603 int bt_ctf_get_array_len(const struct bt_declaration *field);
604 struct bt_definition *bt_array_index(struct definition_array *array, uint64_t i);
605 uint64_t bt_ctf_get_uint64(const struct bt_definition *field);
606 int64_t bt_ctf_get_int64(const struct bt_definition *field);
607 char *bt_ctf_get_char_array(const struct bt_definition *field);
608 char *bt_ctf_get_string(const struct bt_definition *field);
609 double bt_ctf_get_float(const struct bt_definition *field);
610 int bt_ctf_field_get_error(void);
611 const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event);
612 const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field);
613 const struct bt_declaration *bt_ctf_get_decl_from_def(const struct bt_definition *field);
614 uint64_t bt_sequence_len(struct definition_sequence *sequence);
615 struct bt_definition *bt_sequence_index(struct definition_sequence *sequence, uint64_t i);
616
617 %pythoncode%{
618
619 class ctf:
620
621 #enum equivalent, accessible constants
622 #These are taken directly from ctf/events.h
623 #All changes to enums must also be made here
624 class type_id:
625 UNKNOWN = 0
626 INTEGER = 1
627 FLOAT = 2
628 ENUM = 3
629 STRING = 4
630 STRUCT = 5
631 UNTAGGED_VARIANT = 6
632 VARIANT = 7
633 ARRAY = 8
634 SEQUENCE = 9
635 NR_CTF_TYPES = 10
636
637 def get_type_id_name(id):
638 name = "UNKNOWN"
639 constants = [attr for attr in dir(ctf.type_id) if not callable(getattr(ctf.type_id, attr)) and not attr.startswith("__")]
640 for attr in constants:
641 if getattr(ctf.type_id, attr) == id:
642 name = attr
643 break
644 return name
645
646 class scope:
647 TRACE_PACKET_HEADER = 0
648 STREAM_PACKET_CONTEXT = 1
649 STREAM_EVENT_HEADER = 2
650 STREAM_EVENT_CONTEXT = 3
651 EVENT_CONTEXT = 4
652 EVENT_FIELDS = 5
653
654 class string_encoding:
655 NONE = 0
656 UTF8 = 1
657 ASCII = 2
658 UNKNOWN = 3
659
660 class Iterator(Iterator, object):
661 """
662 Allocate a CTF trace collection iterator.
663
664 begin_pos and end_pos are optional parameters to specify the
665 position at which the trace collection should be seeked upon
666 iterator creation, and the position at which iteration will
667 start returning "EOF".
668
669 By default, if begin_pos is None, a SEEK_CUR is performed at
670 creation. By default, if end_pos is None, a SEEK_END (end of
671 trace) is the EOF criterion.
672
673 Only one iterator can be created against a context. If more than one
674 iterator is being created for the same context, the second creation
675 will return None. The previous iterator must be destroyed before
676 creation of the new iterator for this function to succeed.
677 """
678
679 def __new__(cls, context, begin_pos = None, end_pos = None):
680 # __new__ is used to control the return value
681 # as the ctf.Iterator class should return None
682 # if bt_ctf_iter_create returns NULL
683
684 if begin_pos is None:
685 bp = None
686 else:
687 bp = begin_pos._pos
688 if end_pos is None:
689 ep = None
690 else:
691 ep = end_pos._pos
692 try:
693 it = _bt_ctf_iter_create(context._c, bp, ep)
694 except AttributeError:
695 raise TypeError("in __init__, "
696 "argument 2 must be a Context instance")
697 if it is None:
698 return None
699
700 ret_class = super(ctf.Iterator, cls).__new__(cls)
701 ret_class._i = it
702 return ret_class
703
704 def __init__(self, context, begin_pos = None, end_pos = None):
705 Iterator.__init__(self, None, None, None,
706 _bt_ctf_get_iter(self._i))
707
708 def __del__(self):
709 _bt_ctf_iter_destroy(self._i)
710
711 def read_event(self):
712 """
713 Read the iterator's current event data.
714 Return current event on success, None on end of trace.
715 """
716 ret = _bt_ctf_iter_read_event(self._i)
717 if ret is None:
718 return ret
719 ev = ctf.Event.__new__(ctf.Event)
720 ev._e = ret
721 return ev
722
723
724 class Event(object):
725 """
726 This class represents an event from the trace.
727 It is obtained with read_event() from ctf.Iterator.
728 Do not instantiate.
729 """
730
731 def __init__(self):
732 raise NotImplementedError("ctf.Event cannot be instantiated")
733
734 def get_top_level_scope(self, scope):
735 """
736 Return a definition of the top-level scope
737 Top-level scopes are defined in ctf.scope.
738 In order to get a field or a field list, the user needs to pass a
739 scope as argument, this scope can be a top-level scope or a scope
740 relative to an arbitrary field. This function provides the mapping
741 between the scope and the actual definition of top-level scopes.
742 On error return None.
743 """
744 evDef = ctf.Definition.__new__(ctf.Definition)
745 evDef._d = _bt_ctf_get_top_level_scope(self._e, scope)
746 if evDef._d is None:
747 return None
748 return evDef
749
750 def get_name(self):
751 """Return the name of the event or None on error."""
752 return _bt_ctf_event_name(self._e)
753
754 def get_cycles(self):
755 """
756 Return the timestamp of the event as written in
757 the packet (in cycles) or -1ULL on error.
758 """
759 return _bt_ctf_get_cycles(self._e)
760
761 def get_timestamp(self):
762 """
763 Return the timestamp of the event offsetted with the
764 system clock source or -1ULL on error.
765 """
766 return _bt_ctf_get_timestamp(self._e)
767
768 def get_field_with_scope(self, scope, field):
769 """
770 Return the definition of a specific field.
771 Return None on error.
772 """
773 evDef = ctf.Definition.__new__(ctf.Definition)
774 try:
775 evDef._d = _bt_ctf_get_field(self._e, scope._d, field)
776 except AttributeError:
777 raise TypeError("in get_field, argument 2 must be a "
778 "Definition (scope) instance")
779 if evDef._d is None:
780 return None
781 evDef._s = scope
782 return evDef
783
784 def get_field(self, field):
785 """
786 Return the definition of fields by a name
787 Return None on error
788 """
789 eventScope = self.get_top_level_scope(ctf.scope.EVENT_FIELDS)
790 streamScope = self.get_top_level_scope(ctf.scope.STREAM_EVENT_CONTEXT)
791 fields_by_name = []
792
793 if eventScope is not None:
794 evDef = self.get_field_with_scope(eventScope, field)
795 if evDef is not None:
796 fields_by_name.append(evDef)
797
798 if streamScope is not None:
799 evDef = self.get_field_with_scope(streamScope, field)
800 if evDef is not None:
801 fields_by_name.append(evDef);
802
803 if not fields_by_name:
804 return None
805 return fields_by_name
806
807 def get_field_list_with_scope(self, scope):
808 """
809 Return a list of Definitions associated with the scope
810 Return None on error.
811 """
812 try:
813 field_lc = _bt_python_field_listcaller(self._e, scope._d)
814 except AttributeError:
815 raise TypeError("in get_field_list, argument 2 must be a "
816 "Definition (scope) instance")
817
818 if field_lc is None:
819 return None
820
821 def_list = []
822 i = 0
823 while True:
824 tmp = ctf.Definition.__new__(ctf.Definition)
825 tmp._d = _bt_python_field_one_from_list(field_lc, i)
826
827 if tmp._d is None:
828 #Last item of list is None, assured in
829 #_bt_python_field_listcaller
830 break
831
832 tmp._s = scope
833 def_list.append(tmp)
834 i += 1
835 return def_list
836
837 def get_field_list(self):
838 """Return a list of Definitions or None on error."""
839 eventScope = self.get_top_level_scope(ctf.scope.EVENT_FIELDS)
840 streamScope = self.get_top_level_scope(ctf.scope.STREAM_EVENT_CONTEXT)
841
842 def_list = []
843 if eventScope is not None:
844 event_field_list = self.get_field_list_with_scope(eventScope)
845 if event_field_list is not None:
846 def_list = event_field_list
847
848 if streamScope is not None:
849 event_field_list = self.get_field_list_with_scope(streamScope)
850 if event_field_list is not None:
851 def_list.extend(event_field_list)
852
853 if not def_list:
854 return None
855 return def_list
856
857 def get_index(self, field, index):
858 """
859 If the field is an array or a sequence, return the element
860 at position index, otherwise return None
861 """
862 evDef = ctf.Definition.__new__(ctf.Definition)
863 try:
864 evDef._d = _bt_ctf_get_index(self._e, field._d, index)
865 except AttributeError:
866 raise TypeError("in get_index, argument 2 must be a "
867 "Definition (field) instance")
868
869 if evDef._d is None:
870 return None
871 return evDef
872
873 def get_handle(self):
874 """
875 Get the TraceHandle associated with an event
876 Return None on error
877 """
878 ret = _bt_ctf_event_get_handle_id(self._e)
879 if ret < 0:
880 return None
881
882 th = TraceHandle.__new__(TraceHandle)
883 th._id = ret
884 return th
885
886 def get_context(self):
887 """
888 Get the context associated with an event.
889 Return None on error.
890 """
891 ctx = Context()
892 ctx._c = _bt_ctf_event_get_context(self._e);
893 if ctx._c is None:
894 return None
895 else:
896 return ctx
897
898 class FieldError(Exception):
899 def __init__(self, value):
900 self.value = value
901
902 def __str__(self):
903 return repr(self.value)
904
905 class Definition(object):
906 """Definition class. Do not instantiate."""
907
908 def __init__(self):
909 raise NotImplementedError("ctf.Definition cannot be instantiated")
910
911 def __repr__(self):
912 return "Babeltrace Definition: name('{0}'), type({1})".format(
913 self.field_name(), self.field_type())
914
915 def field_name(self):
916 """Return the name of a field or None on error."""
917 return _bt_ctf_field_name(self._d)
918
919 def field_type(self):
920 """Return the type of a field or -1 if unknown."""
921 return _bt_ctf_field_type(_bt_ctf_get_decl_from_def(self._d))
922
923 def get_int_signedness(self):
924 """
925 Return the signedness of an integer:
926 0 if unsigned; 1 if signed; -1 on error.
927 """
928 return _bt_ctf_get_int_signedness(_bt_ctf_get_decl_from_def(self._d))
929
930 def get_int_base(self):
931 """Return the base of an int or a negative value on error."""
932 return _bt_ctf_get_int_base(_bt_ctf_get_decl_from_def(self._d))
933
934 def get_int_byte_order(self):
935 """
936 Return the byte order of an int or a negative
937 value on error.
938 """
939 return _bt_ctf_get_int_byte_order(_bt_ctf_get_decl_from_def(self._d))
940
941 def get_int_len(self):
942 """
943 Return the size, in bits, of an int or a negative
944 value on error.
945 """
946 return _bt_ctf_get_int_len(_bt_ctf_get_decl_from_def(self._d))
947
948 def get_enum_str(self):
949 """
950 Return the string matching the current enumeration.
951 Return None on error.
952 """
953 return _bt_ctf_get_enum_str(self._d)
954
955 def get_encoding(self):
956 """
957 Return the encoding of an int or a string.
958 Return a negative value on error.
959 """
960 return _bt_ctf_get_encoding(_bt_ctf_get_decl_from_def(self._d))
961
962 def get_array_len(self):
963 """
964 Return the len of an array or a negative
965 value on error.
966 """
967 return _bt_ctf_get_array_len(_bt_ctf_get_decl_from_def(self._d))
968
969 def get_array_element_at(self, index):
970 """
971 Return the array's element at position index.
972 Return None on error
973 """
974 array = _bt_python_get_array_from_def(self._d)
975 if array is None:
976 return None
977
978 element = ctf.Definition.__new__(ctf.Definition)
979 element._d = _bt_array_index(array, index)
980 if element._d is None:
981 return None
982 return element
983
984 def get_sequence_len(self):
985 """
986 Return the len of a sequence or a negative
987 value on error.
988 """
989 seq = _bt_python_get_sequence_from_def(self._d)
990 return _bt_sequence_len(seq)
991
992 def get_sequence_element_at(self, index):
993 """
994 Return the sequence's element at position index,
995 otherwise return None
996 """
997 seq = _bt_python_get_sequence_from_def(self._d)
998 if seq is not None:
999 element = ctf.Definition.__new__(ctf.Definition)
1000 element._d = _bt_sequence_index(seq, index)
1001 if element._d is not None:
1002 return element
1003 return None
1004
1005 def get_uint64(self):
1006 """
1007 Return the value associated with the field.
1008 If the field does not exist or is not of the type requested,
1009 the value returned is undefined. To check if an error occured,
1010 use the ctf.field_error() function after accessing a field.
1011 """
1012 return _bt_ctf_get_uint64(self._d)
1013
1014 def get_int64(self):
1015 """
1016 Return the value associated with the field.
1017 If the field does not exist or is not of the type requested,
1018 the value returned is undefined. To check if an error occured,
1019 use the ctf.field_error() function after accessing a field.
1020 """
1021 return _bt_ctf_get_int64(self._d)
1022
1023 def get_char_array(self):
1024 """
1025 Return the value associated with the field.
1026 If the field does not exist or is not of the type requested,
1027 the value returned is undefined. To check if an error occured,
1028 use the ctf.field_error() function after accessing a field.
1029 """
1030 return _bt_ctf_get_char_array(self._d)
1031
1032 def get_str(self):
1033 """
1034 Return the value associated with the field.
1035 If the field does not exist or is not of the type requested,
1036 the value returned is undefined. To check if an error occured,
1037 use the ctf.field_error() function after accessing a field.
1038 """
1039 return _bt_ctf_get_string(self._d)
1040
1041 def get_float(self):
1042 """
1043 Return the value associated with the field.
1044 If the field does not exist or is not of the type requested,
1045 the value returned is undefined. To check if an error occured,
1046 use the ctf.field_error() function after accessing a field.
1047 """
1048 return _bt_ctf_get_float(self._d)
1049
1050 def get_value(self):
1051 """
1052 Return the value associated with the field according to its type.
1053 Return None on error.
1054 """
1055 id = self.field_type()
1056 value = None
1057 if id == ctf.type_id.STRING:
1058 value = self.get_str()
1059 elif id == ctf.type_id.ARRAY:
1060 value = []
1061 for i in range(self.get_array_len()):
1062 element = self.get_array_element_at(i)
1063 value.append(element.get_value())
1064 elif id == ctf.type_id.INTEGER:
1065 if self.get_int_signedness() == 0:
1066 value = self.get_uint64()
1067 else:
1068 value = self.get_int64()
1069 elif id == ctf.type_id.ENUM:
1070 value = self.get_enum_str()
1071 elif id == ctf.type_id.SEQUENCE:
1072 seq_len = self.get_sequence_len()
1073 value = []
1074 for i in range(seq_len):
1075 evDef = self.get_sequence_element_at(i)
1076 value.append(evDef.get_value())
1077 elif id == ctf.type_id.FLOAT:
1078 value = self.get_float()
1079
1080 if ctf.field_error():
1081 raise ctf.FieldError("Error occured while accessing field {} of type {}".format(self.field_name(), ctf.type_id.get_type_id_name(self.field_type())))
1082 return value
1083
1084 def get_scope(self):
1085 """Return the scope of a field or None on error."""
1086 return self._s
1087
1088 class EventDecl(object):
1089 """Event declaration class. Do not instantiate."""
1090
1091 def __init__(self):
1092 raise NotImplementedError("ctf.EventDecl cannot be instantiated")
1093
1094 def __repr__(self):
1095 return "Babeltrace EventDecl: name {0}".format(self.get_name())
1096
1097 def get_name(self):
1098 """Return the name of the event or None on error"""
1099 return _bt_ctf_get_decl_event_name(self._d)
1100
1101 def get_decl_fields(self, scope):
1102 """
1103 Return a list of ctf.FieldDecl
1104 Return None on error.
1105 """
1106 ptr_list = _by_python_field_decl_listcaller(self._d, scope)
1107
1108 if ptr_list is None:
1109 return None
1110
1111 decl_list = []
1112 i = 0
1113 while True:
1114 tmp = ctf.FieldDecl.__new__(ctf.FieldDecl)
1115 tmp._d = _bt_python_field_decl_one_from_list(
1116 ptr_list, i)
1117
1118 if tmp._d is None:
1119 #Last item of list is None
1120 break
1121
1122 decl_list.append(tmp)
1123 i += 1
1124 return decl_list
1125
1126
1127 class FieldDecl(object):
1128 """Field declaration class. Do not instantiate."""
1129
1130 def __init__(self):
1131 raise NotImplementedError("ctf.FieldDecl cannot be instantiated")
1132
1133 def __repr__(self):
1134 return "Babeltrace FieldDecl: name {0}".format(self.get_name())
1135
1136 def get_name(self):
1137 """Return the name of a FieldDecl or None on error"""
1138 return _bt_ctf_get_decl_field_name(self._d)
1139
1140
1141 @staticmethod
1142 def field_error():
1143 """
1144 Return the last error code encountered while
1145 accessing a field and reset the error flag.
1146 Return 0 if no error, a negative value otherwise.
1147 """
1148 return _bt_ctf_field_get_error()
1149
1150 @staticmethod
1151 def get_event_decl_list(trace_handle, context):
1152 """
1153 Return a list of ctf.EventDecl
1154 Return None on error.
1155 """
1156 try:
1157 handle_id = trace_handle._id
1158 except AttributeError:
1159 raise TypeError("in get_event_decl_list, "
1160 "argument 1 must be a TraceHandle instance")
1161 try:
1162 ptr_list = _bt_python_event_decl_listcaller(handle_id, context._c)
1163 except AttributeError:
1164 raise TypeError("in get_event_decl_list, "
1165 "argument 2 must be a Context instance")
1166
1167 if ptr_list is None:
1168 return None
1169
1170 decl_list = []
1171 i = 0
1172 while True:
1173 tmp = ctf.EventDecl.__new__(ctf.EventDecl)
1174 tmp._d = _bt_python_decl_one_from_list(ptr_list, i)
1175
1176 if tmp._d is None:
1177 #Last item of list is None
1178 break
1179
1180 decl_list.append(tmp)
1181 i += 1
1182 return decl_list
1183
1184 %}
1185
1186
1187
1188 // =================================================================
1189 // NEW FUNCTIONS
1190 // File and list-related
1191 // python-complements.h
1192 // =================================================================
1193
1194 %include python-complements.c
1195
1196 %pythoncode %{
1197
1198 class File(object):
1199 """
1200 Open a file for babeltrace.
1201
1202 file_path is a string containing the path or None to use the
1203 standard output in writing mode.
1204
1205 The mode can be 'r', 'w' or 'a' for reading (default), writing or
1206 appending. The file will be created if it doesn't exist when
1207 opened for writing or appending; it will be truncated when opened
1208 for writing. Add a 'b' to the mode for binary files. Add a '+'
1209 to the mode to allow simultaneous reading and writing.
1210 """
1211
1212 def __new__(cls, file_path, mode='r'):
1213 # __new__ is used to control the return value
1214 # as the File class should return None
1215 # if _bt_file_open returns NULL
1216
1217 # Type check
1218 if file_path is not None and type(file_path) is not str:
1219 raise TypeError("in method __init__, argument 2 of type 'str'")
1220 if type(mode) is not str:
1221 raise TypeError("in method __init__, argument 3 of type 'str'")
1222
1223 # Opening file
1224 file_ptr = _bt_file_open(file_path, mode)
1225 if file_ptr is None:
1226 return None
1227
1228 # Class instantiation
1229 file_inst = super(File, cls).__new__(cls)
1230 file_inst._file = file_ptr
1231 return file_inst
1232
1233 def __init__(self, file_path, mode='r'):
1234 self._opened = True
1235 self._use_stdout = False
1236
1237 if file_path is None:
1238 # use stdout
1239 file_path = "stdout"
1240 mode = 'w'
1241 self._use_stdout = True
1242
1243 self._file_path = file_path
1244 self._mode = mode
1245
1246 def __del__(self):
1247 self.close()
1248
1249 def __repr__(self):
1250 if self._opened:
1251 stat = 'opened'
1252 else:
1253 stat = 'closed'
1254 return "{0} babeltrace File; file_path('{1}'), mode('{2}')".format(
1255 stat, self._file_path, self._mode)
1256
1257 def close(self):
1258 """Close the file. Is also called using del."""
1259 if self._opened and not self._use_stdout:
1260 _bt_file_close(self._file)
1261 self._opened = False
1262 %}
BabelTrace - Trace Format Babel Tower
This page took 0.052128 seconds and 3 git commands to generate.