Fix: Variable name typo in SequenceField and Event classes
[babeltrace.git] / bindings / python / babeltrace.i.in
CommitLineData
24a3136a
DS
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>
74ea15ad 9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
24a3136a
DS
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 */
21
22
23%define DOCSTRING
24"BABELTRACE_VERSION_STR
25
26Babeltrace is a trace viewer and converter reading and writing the
27Common Trace Format (CTF). Its main use is to pretty-print CTF
28traces into a human-readable text output.
29
74ea15ad 30To use this module, the first step is to create a TraceCollection and add a
24a3136a
DS
31trace to it."
32%enddef
33
34%module(docstring=DOCSTRING) babeltrace
35
36%include "typemaps.i"
37%{
38#define SWIG_FILE_WITH_INIT
39#include <babeltrace/babeltrace.h>
40#include <babeltrace/babeltrace-internal.h>
41#include <babeltrace/trace-handle.h>
42#include <babeltrace/trace-handle-internal.h>
43#include <babeltrace/context.h>
44#include <babeltrace/context-internal.h>
45#include <babeltrace/iterator.h>
46#include <babeltrace/iterator-internal.h>
47#include <babeltrace/format.h>
48#include <babeltrace/list.h>
24a3136a
DS
49#include <babeltrace/types.h>
50#include <babeltrace/ctf/iterator.h>
51#include "python-complements.h"
ec8c88d7
JG
52#include <babeltrace/ctf-writer/clock.h>
53#include <babeltrace/ctf-writer/event-fields.h>
54#include <babeltrace/ctf-writer/event-types.h>
55#include <babeltrace/ctf-writer/event.h>
56#include <babeltrace/ctf-writer/stream.h>
57#include <babeltrace/ctf-writer/writer.h>
24a3136a
DS
58%}
59
60typedef unsigned long long uint64_t;
61typedef long long int64_t;
62typedef int bt_intern_str;
5792eb34 63typedef int64_t ssize_t;
24a3136a 64
cebae8c3
JG
65/* =================================================================
66 PYTHON-COMPLEMENTS.H
67 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
68*/
69
70FILE *_bt_file_open(char *file_path, char *mode);
71void _bt_file_close(FILE *fp);
72struct bt_definition **_bt_python_field_listcaller(
73 const struct bt_ctf_event *ctf_event,
74 const struct bt_definition *scope,
75 unsigned int *OUTPUT);
76struct bt_definition *_bt_python_field_one_from_list(
77 struct bt_definition **list, int index);
78struct bt_ctf_event_decl **_bt_python_event_decl_listcaller(
79 int handle_id,
80 struct bt_context *ctx,
81 unsigned int *OUTPUT);
82struct bt_ctf_event_decl *_bt_python_decl_one_from_list(
83 struct bt_ctf_event_decl **list, int index);
84struct bt_ctf_field_decl **_by_python_field_decl_listcaller(
85 struct bt_ctf_event_decl *event_decl,
86 enum bt_ctf_scope scope,
87 unsigned int *OUTPUT);
88struct bt_ctf_field_decl *_bt_python_field_decl_one_from_list(
89 struct bt_ctf_field_decl **list, int index);
90struct definition_array *_bt_python_get_array_from_def(
91 struct bt_definition *field);
92struct definition_sequence *_bt_python_get_sequence_from_def(
93 struct bt_definition *field);
5792eb34
JG
94struct bt_declaration *_bt_python_get_array_element_declaration(
95 struct bt_declaration *field);
96const char *_bt_python_get_array_string(struct bt_definition *field);
ec8c88d7
JG
97int _bt_python_field_integer_get_signedness(const struct bt_ctf_field *field);
98enum ctf_type_id _bt_python_get_field_type(const struct bt_ctf_field *field);
cebae8c3 99
24a3136a
DS
100/* =================================================================
101 CONTEXT.H, CONTEXT-INTERNAL.H
102 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
103*/
104
105%rename("_bt_context_create") bt_context_create(void);
106%rename("_bt_context_add_trace") bt_context_add_trace(
107 struct bt_context *ctx, const char *path, const char *format,
2c0df204
XH
108 void (*packet_seek)(struct bt_stream_pos *pos, size_t index, int whence),
109 struct bt_mmap_stream_list *stream_list, FILE *metadata);
24a3136a
DS
110%rename("_bt_context_remove_trace") bt_context_remove_trace(
111 struct bt_context *ctx, int trace_id);
112%rename("_bt_context_get") bt_context_get(struct bt_context *ctx);
113%rename("_bt_context_put") bt_context_put(struct bt_context *ctx);
114%rename("_bt_ctf_event_get_context") bt_ctf_event_get_context(
115 const struct bt_ctf_event *event);
116
117struct bt_context *bt_context_create(void);
118int bt_context_add_trace(struct bt_context *ctx, const char *path, const char *format,
2c0df204
XH
119 void (*packet_seek)(struct bt_stream_pos *pos, size_t index, int whence),
120 struct bt_mmap_stream_list *stream_list, FILE *metadata);
24a3136a
DS
121void bt_context_remove_trace(struct bt_context *ctx, int trace_id);
122void bt_context_get(struct bt_context *ctx);
123void bt_context_put(struct bt_context *ctx);
124struct bt_context *bt_ctf_event_get_context(const struct bt_ctf_event *event);
125
74ea15ad 126// class TraceCollection to prevent direct access to struct bt_context
24a3136a 127%pythoncode%{
74ea15ad 128class TraceCollection:
24a3136a 129 """
74ea15ad 130 The TraceCollection is the object that contains all currently opened traces.
24a3136a
DS
131 """
132
133 def __init__(self):
74ea15ad 134 self._tc = _bt_context_create()
24a3136a
DS
135
136 def __del__(self):
74ea15ad 137 _bt_context_put(self._tc)
24a3136a 138
74ea15ad 139 def add_trace(self, path, format_str):
24a3136a 140 """
74ea15ad 141 Add a trace by path to the TraceCollection.
24a3136a
DS
142
143 Open a trace.
144
145 path is the path to the trace, it is not recursive.
146 If "path" is None, stream_list is used instead as a list
147 of mmap streams to open for the trace.
148
149 format is a string containing the format name in which the trace was
150 produced.
151
24a3136a
DS
152 Return: the corresponding TraceHandle on success or None on error.
153 """
464425e1 154 ret = _bt_context_add_trace(self._tc, path, format_str, None, None, None)
24a3136a
DS
155 if ret < 0:
156 return None
157
158 th = TraceHandle.__new__(TraceHandle)
159 th._id = ret
464425e1 160 th._trace_collection = self
24a3136a
DS
161 return th
162
163 def add_traces_recursive(self, path, format_str):
164 """
165 Open a trace recursively.
166
167 Find each trace present in the subdirectory starting from the given
74ea15ad 168 path, and add them to the TraceCollection.
24a3136a
DS
169
170 Return a dict of TraceHandle instances (the full path is the key).
171 Return None on error.
172 """
173
174 import os
175
176 trace_handles = {}
177
178 noTrace = True
179 error = False
180
181 for fullpath, dirs, files in os.walk(path):
182 if "metadata" in files:
183 trace_handle = self.add_trace(fullpath, format_str)
184 if trace_handle is None:
185 error = True
186 continue
187
188 trace_handles[fullpath] = trace_handle
189 noTrace = False
190
191 if noTrace and error:
192 return None
193 return trace_handles
194
195 def remove_trace(self, trace_handle):
196 """
74ea15ad 197 Remove a trace from the TraceCollection.
24a3136a
DS
198 Effectively closing the trace.
199 """
200 try:
74ea15ad 201 _bt_context_remove_trace(self._tc, trace_handle._id)
24a3136a
DS
202 except AttributeError:
203 raise TypeError("in remove_trace, "
204 "argument 2 must be a TraceHandle instance")
74ea15ad
JG
205
206 @property
207 def events(self):
208 """
209 Generator function to iterate over the events of open in the current
210 TraceCollection.
211 """
212 begin_pos_ptr = _bt_iter_pos()
213 end_pos_ptr = _bt_iter_pos()
214 begin_pos_ptr.type = SEEK_BEGIN
215 end_pos_ptr.type = SEEK_LAST
216
217 for event in self._events(begin_pos_ptr, end_pos_ptr):
218 yield event
219
220 def events_timestamps(self, timestamp_begin, timestamp_end):
221 """
222 Generator function to iterate over the events of open in the current
223 TraceCollection from timestamp_begin to timestamp_end.
224 """
225 begin_pos_ptr = _bt_iter_pos()
226 end_pos_ptr = _bt_iter_pos()
227 begin_pos_ptr.type = end_pos_ptr.type = SEEK_TIME
228 begin_pos_ptr.u.seek_time = timestamp_begin
229 end_pos_ptr.u.seek_time = timestamp_end
230
231 for event in self._events(begin_pos_ptr, end_pos_ptr):
232 yield event
233
234 @property
235 def timestamp_begin(self):
236 pos_ptr = _bt_iter_pos()
237 pos_ptr.type = SEEK_BEGIN
238 return self._timestamp_at_pos(pos_ptr)
239
240 @property
241 def timestamp_end(self):
242 pos_ptr = _bt_iter_pos()
243 pos_ptr.type = SEEK_LAST
244 return self._timestamp_at_pos(pos_ptr)
245
246 def _timestamp_at_pos(self, pos_ptr):
247 ctf_it_ptr = _bt_ctf_iter_create(self._tc, pos_ptr, pos_ptr)
248 if ctf_it_ptr is None:
249 raise NotImplementedError("Creation of multiple iterators is unsupported.")
250 ev_ptr = _bt_ctf_iter_read_event(ctf_it_ptr)
251 _bt_ctf_iter_destroy(ctf_it_ptr)
252 if ev_ptr is None:
253 return None;
254
255 def _events(self, begin_pos_ptr, end_pos_ptr):
256 ctf_it_ptr = _bt_ctf_iter_create(self._tc, begin_pos_ptr, end_pos_ptr)
257 if ctf_it_ptr is None:
258 raise NotImplementedError(
259 "Creation of multiple iterators is unsupported.")
260
261 while True:
262 ev_ptr = _bt_ctf_iter_read_event(ctf_it_ptr)
263 if ev_ptr is None:
264 break
265
78d714e8 266 ev = Event.__new__(Event)
74ea15ad
JG
267 ev._e = ev_ptr
268 try:
269 yield ev
270 except GeneratorExit:
271 break
272
273 ret = _bt_iter_next(_bt_ctf_get_iter(ctf_it_ptr))
274 if ret != 0:
275 break
276
277 _bt_ctf_iter_destroy(ctf_it_ptr)
278
24a3136a
DS
279%}
280
281
282
283/* =================================================================
284 FORMAT.H, REGISTRY
285 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
286*/
287
288%rename("lookup_format") bt_lookup_format(bt_intern_str qname);
289%rename("_bt_print_format_list") bt_fprintf_format_list(FILE *fp);
290%rename("register_format") bt_register_format(struct format *format);
cc26a15a 291%rename("unregister_format") bt_unregister_format(struct bt_format *format);
24a3136a
DS
292
293extern struct format *bt_lookup_format(bt_intern_str qname);
294extern void bt_fprintf_format_list(FILE *fp);
2c0df204 295extern int bt_register_format(struct bt_format *format);
cc26a15a 296extern void bt_unregister_format(struct bt_format *format);
24a3136a 297
24a3136a
DS
298%pythoncode %{
299
300def print_format_list(babeltrace_file):
301 """
302 Print a list of available formats to file.
303
304 babeltrace_file must be a File instance opened in write mode.
305 """
306 try:
307 if babeltrace_file._file is not None:
308 _bt_print_format_list(babeltrace_file._file)
309 except AttributeError:
310 raise TypeError("in print_format_list, "
311 "argument 1 must be a File instance")
312
313%}
314
315
316/* =================================================================
317 ITERATOR.H, ITERATOR-INTERNAL.H
318 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
319*/
320
321%rename("_bt_iter_create") bt_iter_create(struct bt_context *ctx,
322 const struct bt_iter_pos *begin_pos, const struct bt_iter_pos *end_pos);
323%rename("_bt_iter_destroy") bt_iter_destroy(struct bt_iter *iter);
324%rename("_bt_iter_next") bt_iter_next(struct bt_iter *iter);
325%rename("_bt_iter_get_pos") bt_iter_get_pos(struct bt_iter *iter);
326%rename("_bt_iter_free_pos") bt_iter_free_pos(struct bt_iter_pos *pos);
327%rename("_bt_iter_set_pos") bt_iter_set_pos(struct bt_iter *iter,
328 const struct bt_iter_pos *pos);
329%rename("_bt_iter_create_time_pos") bt_iter_create_time_pos(struct bt_iter *iter,
330 uint64_t timestamp);
331
332struct bt_iter *bt_iter_create(struct bt_context *ctx,
333 const struct bt_iter_pos *begin_pos, const struct bt_iter_pos *end_pos);
334void bt_iter_destroy(struct bt_iter *iter);
335int bt_iter_next(struct bt_iter *iter);
336struct bt_iter_pos *bt_iter_get_pos(struct bt_iter *iter);
337void bt_iter_free_pos(struct bt_iter_pos *pos);
338int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *pos);
339struct bt_iter_pos *bt_iter_create_time_pos(struct bt_iter *iter, uint64_t timestamp);
340
341%rename("_bt_iter_pos") bt_iter_pos;
342%rename("SEEK_TIME") BT_SEEK_TIME;
343%rename("SEEK_RESTORE") BT_SEEK_RESTORE;
344%rename("SEEK_CUR") BT_SEEK_CUR;
345%rename("SEEK_BEGIN") BT_SEEK_BEGIN;
ef42f9eb 346%rename("SEEK_LAST") BT_SEEK_LAST;
24a3136a
DS
347
348// This struct is taken from iterator.h
349// All changes to the struct must also be made here
350struct bt_iter_pos {
351 enum {
352 BT_SEEK_TIME, /* uses u.seek_time */
353 BT_SEEK_RESTORE, /* uses u.restore */
354 BT_SEEK_CUR,
355 BT_SEEK_BEGIN,
ef42f9eb 356 BT_SEEK_LAST
24a3136a
DS
357 } type;
358 union {
359 uint64_t seek_time;
360 struct bt_saved_pos *restore;
361 } u;
362};
363
24a3136a
DS
364/* =================================================================
365 TRACE-HANDLE.H, TRACE-HANDLE-INTERNAL.H
366 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
367*/
368
369%rename("_bt_trace_handle_create") bt_trace_handle_create(struct bt_context *ctx);
370%rename("_bt_trace_handle_destroy") bt_trace_handle_destroy(struct bt_trace_handle *bt);
371struct bt_trace_handle *bt_trace_handle_create(struct bt_context *ctx);
372void bt_trace_handle_destroy(struct bt_trace_handle *bt);
373
374%rename("_bt_trace_handle_get_path") bt_trace_handle_get_path(struct bt_context *ctx,
375 int handle_id);
376%rename("_bt_trace_handle_get_timestamp_begin") bt_trace_handle_get_timestamp_begin(
377 struct bt_context *ctx, int handle_id, enum bt_clock_type type);
378%rename("_bt_trace_handle_get_timestamp_end") bt_trace_handle_get_timestamp_end(
379 struct bt_context *ctx, int handle_id, enum bt_clock_type type);
24a3136a
DS
380const char *bt_trace_handle_get_path(struct bt_context *ctx, int handle_id);
381uint64_t bt_trace_handle_get_timestamp_begin(struct bt_context *ctx, int handle_id,
382 enum bt_clock_type type);
383uint64_t bt_trace_handle_get_timestamp_end(struct bt_context *ctx, int handle_id,
384 enum bt_clock_type type);
385
386%rename("_bt_ctf_event_get_handle_id") bt_ctf_event_get_handle_id(
387 const struct bt_ctf_event *event);
388int bt_ctf_event_get_handle_id(const struct bt_ctf_event *event);
389
390
391%pythoncode%{
392
d0f6c523 393# Based on enum bt_clock_type in clock-type.h
464425e1
JG
394class ClockType:
395 CLOCK_CYCLES = 0
396 CLOCK_REAL = 1
397
24a3136a
DS
398class TraceHandle(object):
399 """
400 The TraceHandle allows the user to manipulate a trace file directly.
401 It is a unique identifier representing a trace file.
402 Do not instantiate.
403 """
404
405 def __init__(self):
406 raise NotImplementedError("TraceHandle cannot be instantiated")
407
408 def __repr__(self):
288209fb 409 return "Babeltrace TraceHandle: trace_id('{0}')".format(self._id)
24a3136a 410
464425e1
JG
411 @property
412 def id(self):
24a3136a
DS
413 """Return the TraceHandle id."""
414 return self._id
415
464425e1
JG
416 @property
417 def path(self):
24a3136a 418 """Return the path of a TraceHandle."""
464425e1 419 return _bt_trace_handle_get_path(self._trace_collection._tc, self._id)
24a3136a 420
464425e1
JG
421 @property
422 def timestamp_begin(self):
24a3136a 423 """Return the creation time of the buffers of a trace."""
464425e1
JG
424 return _bt_trace_handle_get_timestamp_begin(
425 self._trace_collection._tc, self._id, ClockType.CLOCK_REAL)
24a3136a 426
464425e1
JG
427 @property
428 def timestamp_end(self):
24a3136a 429 """Return the destruction timestamp of the buffers of a trace."""
464425e1
JG
430 return _bt_trace_handle_get_timestamp_end(
431 self._trace_collection._tc, self._id, ClockType.CLOCK_REAL)
24a3136a 432
8bb27181
JG
433 @property
434 def events(self):
435 """
436 Generator returning all events (EventDeclaration) in a trace.
437 """
438 ret = _bt_python_event_decl_listcaller(self.id, self._trace_collection._tc)
439
440 if not isinstance(ret, list):
441 return
442
443 ptr_list, count = ret
444 for i in range(count):
445 tmp = EventDeclaration.__new__(EventDeclaration)
446 tmp._ed = _bt_python_decl_one_from_list(ptr_list, i)
447 yield tmp
448
24a3136a
DS
449%}
450
451
452
453// =================================================================
454// CTF
455// =================================================================
456
457/* =================================================================
458 ITERATOR.H, EVENTS.H
459 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
460*/
461
462//Iterator
463%rename("_bt_ctf_iter_create") bt_ctf_iter_create(struct bt_context *ctx,
464 const struct bt_iter_pos *begin_pos,
465 const struct bt_iter_pos *end_pos);
466%rename("_bt_ctf_get_iter") bt_ctf_get_iter(struct bt_ctf_iter *iter);
467%rename("_bt_ctf_iter_destroy") bt_ctf_iter_destroy(struct bt_ctf_iter *iter);
468%rename("_bt_ctf_iter_read_event") bt_ctf_iter_read_event(struct bt_ctf_iter *iter);
469
470struct bt_ctf_iter *bt_ctf_iter_create(struct bt_context *ctx,
471 const struct bt_iter_pos *begin_pos,
472 const struct bt_iter_pos *end_pos);
473struct bt_iter *bt_ctf_get_iter(struct bt_ctf_iter *iter);
474void bt_ctf_iter_destroy(struct bt_ctf_iter *iter);
475struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter);
476
477
478//Events
24a3136a
DS
479%rename("_bt_ctf_get_top_level_scope") bt_ctf_get_top_level_scope(const struct
480 bt_ctf_event *event, enum bt_ctf_scope scope);
481%rename("_bt_ctf_event_name") bt_ctf_event_name(const struct bt_ctf_event *ctf_event);
482%rename("_bt_ctf_get_timestamp") bt_ctf_get_timestamp(
483 const struct bt_ctf_event *ctf_event);
484%rename("_bt_ctf_get_cycles") bt_ctf_get_cycles(
485 const struct bt_ctf_event *ctf_event);
486
487%rename("_bt_ctf_get_field") bt_ctf_get_field(const struct bt_ctf_event *ctf_event,
2c0df204 488 const struct bt_definition *scope, const char *field);
24a3136a 489%rename("_bt_ctf_get_index") bt_ctf_get_index(const struct bt_ctf_event *ctf_event,
2c0df204
XH
490 const struct bt_definition *field, unsigned int index);
491%rename("_bt_ctf_field_name") bt_ctf_field_name(const struct bt_definition *field);
492%rename("_bt_ctf_field_type") bt_ctf_field_type(const struct bt_declaration *field);
24a3136a 493%rename("_bt_ctf_get_int_signedness") bt_ctf_get_int_signedness(
2c0df204
XH
494 const struct bt_declaration *field);
495%rename("_bt_ctf_get_int_base") bt_ctf_get_int_base(const struct bt_declaration *field);
24a3136a 496%rename("_bt_ctf_get_int_byte_order") bt_ctf_get_int_byte_order(
2c0df204
XH
497 const struct bt_declaration *field);
498%rename("_bt_ctf_get_int_len") bt_ctf_get_int_len(const struct bt_declaration *field);
4191bcd2
XH
499%rename("_bt_ctf_get_enum_int") bt_ctf_get_enum_int(const struct bt_definition *field);
500%rename("_bt_ctf_get_enum_str") bt_ctf_get_enum_str(const struct bt_definition *field);
2c0df204
XH
501%rename("_bt_ctf_get_encoding") bt_ctf_get_encoding(const struct bt_declaration *field);
502%rename("_bt_ctf_get_array_len") bt_ctf_get_array_len(const struct bt_declaration *field);
503%rename("_bt_ctf_get_uint64") bt_ctf_get_uint64(const struct bt_definition *field);
504%rename("_bt_ctf_get_int64") bt_ctf_get_int64(const struct bt_definition *field);
505%rename("_bt_ctf_get_char_array") bt_ctf_get_char_array(const struct bt_definition *field);
506%rename("_bt_ctf_get_string") bt_ctf_get_string(const struct bt_definition *field);
e5a73b90 507%rename("_bt_ctf_get_float") bt_ctf_get_float(const struct bt_definition *field);
812e6682 508%rename("_bt_ctf_get_variant") bt_ctf_get_variant(const struct bt_definition *field);
24a3136a
DS
509%rename("_bt_ctf_field_get_error") bt_ctf_field_get_error(void);
510%rename("_bt_ctf_get_decl_event_name") bt_ctf_get_decl_event_name(const struct
511 bt_ctf_event_decl *event);
512%rename("_bt_ctf_get_decl_field_name") bt_ctf_get_decl_field_name(
513 const struct bt_ctf_field_decl *field);
f01efa78 514%rename("_bt_ctf_get_decl_from_def") bt_ctf_get_decl_from_def(
2c0df204 515 const struct bt_definition *field);
8bb27181
JG
516%rename("_bt_ctf_get_decl_from_field_decl") bt_ctf_get_decl_from_field_decl(
517 const struct bt_ctf_field_decl *field);
3c2ce778 518%rename("_bt_array_index") bt_array_index(struct definition_array *array, uint64_t i);
786207e0
XH
519%rename("_bt_sequence_len") bt_sequence_len(struct definition_sequence *sequence);
520%rename("_bt_sequence_index") bt_sequence_index(struct definition_sequence *sequence, uint64_t i);
3a068915
JG
521%rename("_bt_ctf_get_struct_field_count") bt_ctf_get_struct_field_count(const struct bt_definition *structure);
522%rename("_bt_ctf_get_struct_field_index") bt_ctf_get_struct_field_index(const struct bt_definition *structure, uint64_t i);
24a3136a 523
2c0df204 524const struct bt_definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *ctf_event,
24a3136a
DS
525 enum bt_ctf_scope scope);
526const char *bt_ctf_event_name(const struct bt_ctf_event *ctf_event);
527uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *ctf_event);
528uint64_t bt_ctf_get_cycles(const struct bt_ctf_event *ctf_event);
2c0df204
XH
529const struct bt_definition *bt_ctf_get_field(const struct bt_ctf_event *ctf_event,
530 const struct bt_definition *scope,
24a3136a 531 const char *field);
2c0df204
XH
532const struct bt_definition *bt_ctf_get_index(const struct bt_ctf_event *ctf_event,
533 const struct bt_definition *field,
24a3136a 534 unsigned int index);
2c0df204
XH
535const char *bt_ctf_field_name(const struct bt_definition *field);
536enum ctf_type_id bt_ctf_field_type(const struct bt_declaration *field);
537int bt_ctf_get_int_signedness(const struct bt_declaration *field);
538int bt_ctf_get_int_base(const struct bt_declaration *field);
539int bt_ctf_get_int_byte_order(const struct bt_declaration *field);
540ssize_t bt_ctf_get_int_len(const struct bt_declaration *field);
4191bcd2
XH
541const struct bt_definition *bt_ctf_get_enum_int(const struct bt_definition *field);
542const char *bt_ctf_get_enum_str(const struct bt_definition *field);
2c0df204
XH
543enum ctf_string_encoding bt_ctf_get_encoding(const struct bt_declaration *field);
544int bt_ctf_get_array_len(const struct bt_declaration *field);
3c2ce778 545struct bt_definition *bt_array_index(struct definition_array *array, uint64_t i);
2c0df204
XH
546uint64_t bt_ctf_get_uint64(const struct bt_definition *field);
547int64_t bt_ctf_get_int64(const struct bt_definition *field);
548char *bt_ctf_get_char_array(const struct bt_definition *field);
549char *bt_ctf_get_string(const struct bt_definition *field);
e5a73b90 550double bt_ctf_get_float(const struct bt_definition *field);
812e6682 551const struct bt_definition *bt_ctf_get_variant(const struct bt_definition *field);
24a3136a
DS
552int bt_ctf_field_get_error(void);
553const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event);
554const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field);
2c0df204 555const struct bt_declaration *bt_ctf_get_decl_from_def(const struct bt_definition *field);
8bb27181 556const struct bt_declaration *bt_ctf_get_decl_from_field_decl(const struct bt_ctf_field_decl *field);
786207e0
XH
557uint64_t bt_sequence_len(struct definition_sequence *sequence);
558struct bt_definition *bt_sequence_index(struct definition_sequence *sequence, uint64_t i);
3a068915
JG
559uint64_t bt_ctf_get_struct_field_count(const struct bt_definition *structure);
560const struct bt_definition *bt_ctf_get_struct_field_index(const struct bt_definition *structure, uint64_t i);
24a3136a
DS
561
562%pythoncode%{
563
24d5c942
JG
564class CTFStringEncoding:
565 NONE = 0
566 UTF8 = 1
567 ASCII = 2
568 UNKNOWN = 3
569
8bb27181
JG
570# Based on the enum in ctf-writer/writer.h
571class ByteOrder:
572 BYTE_ORDER_NATIVE = 0
573 BYTE_ORDER_LITTLE_ENDIAN = 1
574 BYTE_ORDER_BIG_ENDIAN = 2
575 BYTE_ORDER_NETWORK = 3
576 BYTE_ORDER_UNKNOWN = 4 # Python-specific entry
577
24d5c942
JG
578#enum equivalent, accessible constants
579#These are taken directly from ctf/events.h
580#All changes to enums must also be made here
581class CTFTypeId:
582 UNKNOWN = 0
583 INTEGER = 1
584 FLOAT = 2
585 ENUM = 3
586 STRING = 4
587 STRUCT = 5
588 UNTAGGED_VARIANT = 6
589 VARIANT = 7
590 ARRAY = 8
591 SEQUENCE = 9
592 NR_CTF_TYPES = 10
593
8bb27181
JG
594 def type_name(id):
595 name = "UNKNOWN_TYPE"
24d5c942
JG
596 constants = [attr for attr in dir(CTFTypeId) if not callable(getattr(CTFTypeId, attr)) and not attr.startswith("__")]
597 for attr in constants:
598 if getattr(CTFTypeId, attr) == id:
599 name = attr
600 break
601 return name
602
8bb27181 603class CTFScope:
78d714e8
JG
604 TRACE_PACKET_HEADER = 0
605 STREAM_PACKET_CONTEXT = 1
606 STREAM_EVENT_HEADER = 2
607 STREAM_EVENT_CONTEXT = 3
608 EVENT_CONTEXT = 4
609 EVENT_FIELDS = 5
610
8bb27181
JG
611 def scope_name(scope):
612 name = "UNKNOWN_SCOPE"
613 constants = [attr for attr in dir(CTFScope) if not callable(getattr(CTFScope, attr)) and not attr.startswith("__")]
614 for attr in constants:
615 if getattr(CTFScope, attr) == scope:
616 name = attr
617 break
618 return name
619
e404272a 620# Priority of the scopes when searching for event fields
8bb27181
JG
621_scopes = [CTFScope.EVENT_FIELDS, CTFScope.EVENT_CONTEXT, CTFScope.STREAM_EVENT_CONTEXT,
622 CTFScope.STREAM_EVENT_HEADER, CTFScope.STREAM_PACKET_CONTEXT, CTFScope.TRACE_PACKET_HEADER]
e404272a 623
78d714e8
JG
624import collections
625class Event(collections.Mapping):
626 """
627 This class represents an event from the trace.
628 It is obtained using the TraceCollection generator functions.
629 Do not instantiate.
630 """
78d714e8
JG
631 def __init__(self):
632 raise NotImplementedError("Event cannot be instantiated")
633
634 @property
635 def name(self):
636 """Return the name of the event or None on error."""
637 return _bt_ctf_event_name(self._e)
638
639 @property
640 def cycles(self):
24a3136a 641 """
78d714e8
JG
642 Return the timestamp of the event as written in
643 the packet (in cycles) or -1ULL on error.
24a3136a 644 """
78d714e8 645 return _bt_ctf_get_cycles(self._e)
24a3136a 646
78d714e8
JG
647 @property
648 def timestamp(self):
649 """
650 Return the timestamp of the event offset with the
651 system clock source or -1ULL on error.
652 """
653 return _bt_ctf_get_timestamp(self._e)
654
655 def field_with_scope(self, field_name, scope):
656 """
657 Get field_name's value in scope.
658 None is returned if no field matches field_name.
659 """
e404272a 660 if not scope in _scopes:
78d714e8
JG
661 raise ValueError("Invalid scope provided")
662 field = self._field_with_scope(field_name, scope)
663 if field is not None:
664 return field.value
665 return None
666
667 def field_list_with_scope(self, scope):
668 """Return a list of field names in scope."""
e404272a 669 if not scope in _scopes:
78d714e8
JG
670 raise ValueError("Invalid scope provided")
671 field_names = []
672 for field in self._field_list_with_scope(scope):
673 field_names.append(field.name)
674 return field_names
675
676 @property
677 def handle(self):
678 """
679 Get the TraceHandle associated with this event
680 Return None on error
681 """
682 ret = _bt_ctf_event_get_handle_id(self._e)
683 if ret < 0:
786207e0
XH
684 return None
685
78d714e8
JG
686 th = TraceHandle.__new__(TraceHandle)
687 th._id = ret
688 th._trace_collection = self.get_trace_collection()
689 return th
690
691 @property
692 def trace_collection(self):
693 """
694 Get the TraceCollection associated with this event.
695 Return None on error.
24a3136a 696 """
78d714e8
JG
697 trace_collection = TraceCollection()
698 trace_collection._tc = _bt_ctf_event_get_context(self._e);
699 if trace_collection._tc is None:
700 return None
701 else:
702 return trace_collection
703
704 def __getitem__(self, field_name):
24a3136a 705 """
78d714e8
JG
706 Get field_name's value. If the field_name exists in multiple
707 scopes, the first field found is returned. The scopes are searched
708 in the following order:
709 1) EVENT_FIELDS
710 2) EVENT_CONTEXT
711 3) STREAM_EVENT_CONTEXT
712 4) STREAM_EVENT_HEADER
713 5) STREAM_PACKET_CONTEXT
714 6) TRACE_PACKET_HEADER
715 None is returned if no field matches field_name.
716
717 Use field_with_scope() to explicitly access fields in a given
718 scope.
719 """
720 field = self._field(field_name)
721 if field is not None:
722 return field.value
723 raise KeyError(field_name)
724
725 def __iter__(self):
726 for key in self.keys():
727 yield key
728
729 def __len__(self):
730 count = 0
e404272a 731 for scope in _scopes:
78d714e8
JG
732 scope_ptr = _bt_ctf_get_top_level_scope(self._e, scope)
733 ret = _bt_python_field_listcaller(self._e, scope_ptr)
734 if isinstance(ret, list):
735 count += ret[1]
736 return count
737
738 def __contains__(self, field_name):
739 return self._field(field_name) is not None
740
741 def keys(self):
742 """Return a list of field names."""
743 field_names = set()
e404272a 744 for scope in _scopes:
78d714e8
JG
745 for name in self.field_list_with_scope(scope):
746 field_names.add(name)
747 return list(field_names)
748
749 def get(self, field_name, default = None):
750 field = self._field(field_name)
751 if field is None:
752 return default
753 return field.value
754
755 def items(self):
756 for field in self.keys():
757 yield (field, self[field])
758
759 def _field_with_scope(self, field_name, scope):
760 scope_ptr = _bt_ctf_get_top_level_scope(self._e, scope)
761 if scope_ptr is None:
762 return None
763
764 definition_ptr = _bt_ctf_get_field(self._e, scope_ptr, field_name)
765 if definition_ptr is None:
766 return None
24a3136a 767
78d714e8
JG
768 field = _Definition(definition_ptr, scope)
769 return field
770
771 def _field(self, field_name):
772 field = None
e404272a 773 for scope in _scopes:
78d714e8
JG
774 field = self._field_with_scope(field_name, scope)
775 if field is not None:
776 break
777 return field
778
779 def _field_list_with_scope(self, scope):
780 fields = []
781 scope_ptr = _bt_ctf_get_top_level_scope(self._e, scope)
782
783 # Returns a list [list_ptr, count]. If list_ptr is NULL, SWIG will only
784 # provide the "count" return value
785 count = 0
786 list_ptr = None
787 ret = _bt_python_field_listcaller(self._e, scope_ptr)
788 if isinstance(ret, list):
789 list_ptr, count = ret
790
791 for i in range(count):
792 definition_ptr = _bt_python_field_one_from_list(list_ptr, i)
793 if definition_ptr is not None:
794 definition = _Definition(definition_ptr, scope)
795 fields.append(definition)
796 return fields
797
798class FieldError(Exception):
799 def __init__(self, value):
800 self.value = value
801
802 def __str__(self):
803 return repr(self.value)
804
cb1fcc68 805class EventDeclaration(object):
78d714e8
JG
806 """Event declaration class. Do not instantiate."""
807
808 def __init__(self):
cb1fcc68 809 raise NotImplementedError("EventDeclaration cannot be instantiated")
78d714e8 810
cb1fcc68
JG
811 @property
812 def name(self):
78d714e8 813 """Return the name of the event or None on error"""
cb1fcc68 814 return _bt_ctf_get_decl_event_name(self._ed)
78d714e8 815
8bb27181
JG
816 @property
817 def fields(self):
24a3136a 818 """
8bb27181
JG
819 Generator returning all FieldDeclarations of an event, going through
820 each scope in the following order:
821 1) EVENT_FIELDS
822 2) EVENT_CONTEXT
823 3) STREAM_EVENT_CONTEXT
824 4) STREAM_EVENT_HEADER
825 5) STREAM_PACKET_CONTEXT
826 6) TRACE_PACKET_HEADER
827 """
828 for scope in _scopes:
829 for declaration in self.fields_scope(scope):
830 yield declaration
831
832 def fields_scope(self, scope):
833 """
834 Generator returning FieldDeclarations of the current event in scope.
24a3136a 835 """
cb1fcc68 836 ret = _by_python_field_decl_listcaller(self._ed, scope)
24a3136a 837
cb1fcc68 838 if not isinstance(ret, list):
8bb27181 839 return
24a3136a 840
cb1fcc68 841 list_ptr, count = ret
cb1fcc68 842 for i in range(count):
8bb27181
JG
843 field_declaration_ptr = _bt_python_field_decl_one_from_list(list_ptr, i)
844 if field_declaration_ptr is not None:
845 declaration_ptr = _bt_ctf_get_decl_from_field_decl(field_declaration_ptr)
846 field_declaration = _create_field_declaration(declaration_ptr, _bt_ctf_get_decl_field_name(field_declaration_ptr), scope)
847 yield field_declaration
cb1fcc68
JG
848
849class FieldDeclaration(object):
850 """Field declaration class. Do not instantiate."""
78d714e8 851 def __init__(self):
cb1fcc68 852 raise NotImplementedError("FieldDeclaration cannot be instantiated")
78d714e8 853
8bb27181
JG
854 def __repr__(self):
855 return "({0}) {1} {2}".format(CTFScope.scope_name(self.scope), CTFTypeId.type_name(self.type), self.name)
856
cb1fcc68
JG
857 @property
858 def name(self):
8bb27181
JG
859 """Return the name of a FieldDeclaration or None on error."""
860 return self._name
861
862 @property
863 def type(self):
864 """
865 Return the FieldDeclaration's type. One of the entries in class
866 CTFTypeId.
867 """
868 return _bt_ctf_field_type(self._fd)
869
870 @property
871 def scope(self):
872 """
873 Return the FieldDeclaration's scope.
874 """
875 return self._s
876
877class IntegerFieldDeclaration(FieldDeclaration):
878 """Do not instantiate."""
879 def __init__(self):
880 raise NotImplementedError("IntegerFieldDeclaration cannot be instantiated")
881
882 @property
883 def signedness(self):
884 """
885 Return the signedness of an integer:
886 0 if unsigned; 1 if signed; -1 on error.
887 """
888 return _bt_ctf_get_int_signedness(self._fd)
889
890 @property
891 def base(self):
892 """Return the base of an int or a negative value on error."""
893 return _bt_ctf_get_int_base(self._fd)
894
895 @property
896 def byte_order(self):
897 """
898 Return the byte order. One of class ByteOrder's entries.
899 """
900 ret = _bt_ctf_get_int_byte_order(self._fd)
901 if ret == 1234:
902 return ByteOrder.BYTE_ORDER_LITTLE_ENDIAN
903 elif ret == 4321:
904 return ByteOrder.BYTE_ORDER_BIG_ENDIAN
905 else:
906 return ByteOrder.BYTE_ORDER_UNKNOWN
907
908 @property
909 def length(self):
910 """
911 Return the size, in bits, of an int or a negative
912 value on error.
913 """
914 return _bt_ctf_get_int_len(self._fd)
915
916 @property
917 def encoding(self):
918 """
919 Return the encoding. One of class CTFStringEncoding's entries.
920 Return a negative value on error.
921 """
922 return _bt_ctf_get_encoding(self._fd)
923
924class EnumerationFieldDeclaration(FieldDeclaration):
925 """Do not instantiate."""
926 def __init__(self):
927 raise NotImplementedError("EnumerationFieldDeclaration cannot be instantiated")
928
929class ArrayFieldDeclaration(FieldDeclaration):
930 """Do not instantiate."""
931 def __init__(self):
932 raise NotImplementedError("ArrayFieldDeclaration cannot be instantiated")
933
934 @property
935 def length(self):
936 """
937 Return the length of an array or a negative
938 value on error.
939 """
940 return _bt_ctf_get_array_len(self._fd)
941
5792eb34
JG
942 @property
943 def element_declaration(self):
944 """
945 Return element declaration.
946 """
947 field_decl_ptr = _bt_python_get_array_element_declaration(self._fd)
948 return _create_field_declaration(field_decl_ptr, "", self.scope)
949
8bb27181
JG
950class SequenceFieldDeclaration(FieldDeclaration):
951 """Do not instantiate."""
952 def __init__(self):
953 raise NotImplementedError("SequenceFieldDeclaration cannot be instantiated")
954
955class FloatFieldDeclaration(FieldDeclaration):
956 """Do not instantiate."""
957 def __init__(self):
958 raise NotImplementedError("FloatFieldDeclaration cannot be instantiated")
959
960class StructureFieldDeclaration(FieldDeclaration):
961 """Do not instantiate."""
962 def __init__(self):
963 raise NotImplementedError("StructureFieldDeclaration cannot be instantiated")
964
965class StringFieldDeclaration(FieldDeclaration):
966 """Do not instantiate."""
967 def __init__(self):
968 raise NotImplementedError("StringFieldDeclaration cannot be instantiated")
969
970class VariantFieldDeclaration(FieldDeclaration):
971 """Do not instantiate."""
972 def __init__(self):
973 raise NotImplementedError("VariantFieldDeclaration cannot be instantiated")
78d714e8
JG
974
975def field_error():
976 """
977 Return the last error code encountered while
978 accessing a field and reset the error flag.
979 Return 0 if no error, a negative value otherwise.
980 """
981 return _bt_ctf_field_get_error()
982
8bb27181 983def _create_field_declaration(declaration_ptr, name, scope):
78d714e8 984 """
8bb27181 985 Private field declaration factory.
78d714e8 986 """
8bb27181
JG
987 if declaration_ptr is None:
988 raise ValueError("declaration_ptr must be valid")
989 if not scope in _scopes:
990 raise ValueError("Invalid scope provided")
991
992 type = _bt_ctf_field_type(declaration_ptr)
993 declaration = None
994 if type == CTFTypeId.INTEGER:
995 declaration = IntegerFieldDeclaration.__new__(IntegerFieldDeclaration)
996 elif type == CTFTypeId.ENUM:
997 declaration = EnumerationFieldDeclaration.__new__(EnumerationFieldDeclaration)
998 elif type == CTFTypeId.ARRAY:
999 declaration = ArrayFieldDeclaration.__new__(ArrayFieldDeclaration)
1000 elif type == CTFTypeId.SEQUENCE:
1001 declaration = SequenceFieldDeclaration.__new__(SequenceFieldDeclaration)
1002 elif type == CTFTypeId.FLOAT:
1003 declaration = FloatFieldDeclaration.__new__(FloatFieldDeclaration)
1004 elif type == CTFTypeId.STRUCT:
1005 declaration = StructureFieldDeclaration.__new__(StructureFieldDeclaration)
1006 elif type == CTFTypeId.STRING:
1007 declaration = StringFieldDeclaration.__new__(StringFieldDeclaration)
1008 elif type == CTFTypeId.VARIANT:
1009 declaration = VariantFieldDeclaration.__new__(VariantFieldDeclaration)
1010 else:
1011 return declaration
1012
1013 declaration._fd = declaration_ptr
1014 declaration._s = scope
1015 declaration._name = name
1016 return declaration
78d714e8
JG
1017
1018class _Definition(object):
1019 def __init__(self, definition_ptr, scope):
1020 self._d = definition_ptr
1021 self._s = scope
e404272a 1022 if not scope in _scopes:
78d714e8
JG
1023 ValueError("Invalid scope provided")
1024
78d714e8
JG
1025 @property
1026 def name(self):
1027 """Return the name of a field or None on error."""
1028 return _bt_ctf_field_name(self._d)
1029
5792eb34 1030 @property
78d714e8
JG
1031 def type(self):
1032 """Return the type of a field or -1 if unknown."""
1033 return _bt_ctf_field_type(_bt_ctf_get_decl_from_def(self._d))
1034
8bb27181
JG
1035 @property
1036 def declaration(self):
1037 """Return the associated Definition object."""
1038 return _create_field_declaration(_bt_ctf_get_decl_from_def(self._d), self.name, self.scope)
78d714e8 1039
8bb27181 1040 def _get_enum_str(self):
78d714e8
JG
1041 """
1042 Return the string matching the current enumeration.
1043 Return None on error.
1044 """
1045 return _bt_ctf_get_enum_str(self._d)
1046
8bb27181 1047 def _get_array_element_at(self, index):
78d714e8
JG
1048 """
1049 Return the array's element at position index.
1050 Return None on error
1051 """
1052 array_ptr = _bt_python_get_array_from_def(self._d)
1053 if array_ptr is None:
1054 return None
1055
1056 definition_ptr = _bt_array_index(array_ptr, index)
1057 if definition_ptr is None:
1058 return None
1059 return _Definition(definition_ptr, self.scope)
1060
8bb27181 1061 def _get_sequence_len(self):
78d714e8
JG
1062 """
1063 Return the len of a sequence or a negative
1064 value on error.
1065 """
1066 seq = _bt_python_get_sequence_from_def(self._d)
1067 return _bt_sequence_len(seq)
1068
8bb27181 1069 def _get_sequence_element_at(self, index):
78d714e8
JG
1070 """
1071 Return the sequence's element at position index,
1072 otherwise return None
1073 """
1074 seq = _bt_python_get_sequence_from_def(self._d)
1075 if seq is not None:
1076 definition_ptr = _bt_sequence_index(seq, index)
1077 if definition_ptr is not None:
1078 return _Definition(definition_ptr, self.scope)
1079 return None
1080
8bb27181 1081 def _get_uint64(self):
78d714e8
JG
1082 """
1083 Return the value associated with the field.
1084 If the field does not exist or is not of the type requested,
1085 the value returned is undefined. To check if an error occured,
1086 use the field_error() function after accessing a field.
1087 """
1088 return _bt_ctf_get_uint64(self._d)
1089
8bb27181 1090 def _get_int64(self):
78d714e8
JG
1091 """
1092 Return the value associated with the field.
1093 If the field does not exist or is not of the type requested,
1094 the value returned is undefined. To check if an error occured,
1095 use the field_error() function after accessing a field.
1096 """
1097 return _bt_ctf_get_int64(self._d)
1098
8bb27181 1099 def _get_char_array(self):
78d714e8
JG
1100 """
1101 Return the value associated with the field.
1102 If the field does not exist or is not of the type requested,
1103 the value returned is undefined. To check if an error occurred,
1104 use the field_error() function after accessing a field.
1105 """
1106 return _bt_ctf_get_char_array(self._d)
1107
8bb27181 1108 def _get_str(self):
78d714e8
JG
1109 """
1110 Return the value associated with the field.
1111 If the field does not exist or is not of the type requested,
1112 the value returned is undefined. To check if an error occurred,
1113 use the field_error() function after accessing a field.
1114 """
1115 return _bt_ctf_get_string(self._d)
1116
8bb27181 1117 def _get_float(self):
78d714e8
JG
1118 """
1119 Return the value associated with the field.
1120 If the field does not exist or is not of the type requested,
1121 the value returned is undefined. To check if an error occurred,
1122 use the field_error() function after accessing a field.
1123 """
1124 return _bt_ctf_get_float(self._d)
1125
8bb27181 1126 def _get_variant(self):
78d714e8
JG
1127 """
1128 Return the variant's selected field.
1129 If the field does not exist or is not of the type requested,
1130 the value returned is undefined. To check if an error occurred,
1131 use the field_error() function after accessing a field.
1132 """
1133 return _bt_ctf_get_variant(self._d)
1134
8bb27181 1135 def _get_struct_field_count(self):
78d714e8
JG
1136 """
1137 Return the number of fields contained in the structure.
1138 If the field does not exist or is not of the type requested,
1139 the value returned is undefined.
1140 """
1141 return _bt_ctf_get_struct_field_count(self._d)
1142
8bb27181 1143 def _get_struct_field_at(self, i):
78d714e8
JG
1144 """
1145 Return the structure's field at position i.
1146 If the field does not exist or is not of the type requested,
1147 the value returned is undefined. To check if an error occurred,
1148 use the field_error() function after accessing a field.
1149 """
1150 return _bt_ctf_get_struct_field_index(self._d, i)
1151
1152 @property
1153 def value(self):
1154 """
1155 Return the value associated with the field according to its type.
1156 Return None on error.
1157 """
1158 id = self.type
1159 value = None
5792eb34 1160
78d714e8 1161 if id == CTFTypeId.STRING:
8bb27181 1162 value = self._get_str()
78d714e8 1163 elif id == CTFTypeId.ARRAY:
5792eb34
JG
1164 element_decl = self.declaration.element_declaration
1165 if ((element_decl.type == CTFTypeId.INTEGER
1166 and element_decl.length == 8)
1167 and (element_decl.encoding == CTFStringEncoding.ASCII or element_decl.encoding == CTFStringEncoding.UTF8)):
1168 value = _bt_python_get_array_string(self._d)
1169 else:
1170 value = []
1171 for i in range(self.declaration.length):
1172 element = self._get_array_element_at(i)
1173 value.append(element.value)
78d714e8 1174 elif id == CTFTypeId.INTEGER:
8bb27181
JG
1175 if self.declaration.signedness == 0:
1176 value = self._get_uint64()
78d714e8 1177 else:
8bb27181 1178 value = self._get_int64()
78d714e8 1179 elif id == CTFTypeId.ENUM:
8bb27181 1180 value = self._get_enum_str()
78d714e8 1181 elif id == CTFTypeId.SEQUENCE:
8bb27181 1182 seq_len = self._get_sequence_len()
78d714e8
JG
1183 value = []
1184 for i in range(seq_len):
8bb27181 1185 evDef = self._get_sequence_element_at(i)
78d714e8
JG
1186 value.append(evDef.value)
1187 elif id == CTFTypeId.FLOAT:
8bb27181 1188 value = self._get_float()
78d714e8 1189 elif id == CTFTypeId.VARIANT:
8bb27181
JG
1190 variant = _Definition.__new__(_Definition)
1191 variant._d = self._get_variant();
78d714e8
JG
1192 value = variant.value
1193 elif id == CTFTypeId.STRUCT:
1194 value = {}
8bb27181
JG
1195 for i in range(self._get_struct_field_count()):
1196 member = _Definition(self._get_struct_field_at(i), self.scope)
78d714e8
JG
1197 value[member.name] = member.value
1198
1199 if field_error():
5792eb34 1200 raise FieldError("Error occurred while accessing field {} of type {}".format(self.name, CTFTypeId.type_name(id)))
78d714e8
JG
1201 return value
1202
1203 @property
1204 def scope(self):
1205 """Return the scope of a field or None on error."""
1206 return self._s
1207
24a3136a
DS
1208%}
1209
1210
ec8c88d7
JG
1211// =================================================================
1212// CTF Writer
1213// =================================================================
1214
1215/* =================================================================
1216 CLOCK.H
1217 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
1218*/
1219%rename("_bt_ctf_clock_create") bt_ctf_clock_create(const char *name);
1220%rename("_bt_ctf_clock_set_description") bt_ctf_clock_set_description(struct bt_ctf_clock *clock, const char *desc);
1221%rename("_bt_ctf_clock_set_frequency") bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock, uint64_t freq);
1222%rename("_bt_ctf_clock_set_precision") bt_ctf_clock_set_precision(struct bt_ctf_clock *clock, uint64_t precision);
1223%rename("_bt_ctf_clock_set_offset_s") bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, uint64_t offset_s);
1224%rename("_bt_ctf_clock_set_offset") bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, uint64_t offset);
1225%rename("_bt_ctf_clock_set_is_absolute") bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock, int is_absolute);
1226%rename("_bt_ctf_clock_set_time") bt_ctf_clock_set_time(struct bt_ctf_clock *clock, uint64_t time);
1227%rename("_bt_ctf_clock_get") bt_ctf_clock_get(struct bt_ctf_clock *clock);
1228%rename("_bt_ctf_clock_put") bt_ctf_clock_put(struct bt_ctf_clock *clock);
1229
1230struct bt_ctf_clock *bt_ctf_clock_create(const char *name);
1231int bt_ctf_clock_set_description(struct bt_ctf_clock *clock, const char *desc);
1232int bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock, uint64_t freq);
1233int bt_ctf_clock_set_precision(struct bt_ctf_clock *clock, uint64_t precision);
1234int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, uint64_t offset_s);
1235int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, uint64_t offset);
1236int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock, int is_absolute);
1237int bt_ctf_clock_set_time(struct bt_ctf_clock *clock, uint64_t time);
1238void bt_ctf_clock_get(struct bt_ctf_clock *clock);
1239void bt_ctf_clock_put(struct bt_ctf_clock *clock);
1240
1241/* =================================================================
1242 EVENT-TYPES.H
1243 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
1244*/
1245%rename("_bt_ctf_field_type_integer_create") bt_ctf_field_type_integer_create(unsigned int size);
1246%rename("_bt_ctf_field_type_integer_set_signed") bt_ctf_field_type_integer_set_signed(struct bt_ctf_field_type *integer, int is_signed);
1247%rename("_bt_ctf_field_type_integer_set_base") bt_ctf_field_type_integer_set_base(struct bt_ctf_field_type *integer, enum bt_ctf_integer_base base);
1248%rename("_bt_ctf_field_type_integer_set_encoding") bt_ctf_field_type_integer_set_encoding(struct bt_ctf_field_type *integer, enum ctf_string_encoding encoding);
1249%rename("_bt_ctf_field_type_enumeration_create") bt_ctf_field_type_enumeration_create(struct bt_ctf_field_type *integer_container_type);
1250%rename("_bt_ctf_field_type_enumeration_add_mapping") bt_ctf_field_type_enumeration_add_mapping(struct bt_ctf_field_type *enumeration, const char *string, int64_t range_start, int64_t range_end);
1251%rename("_bt_ctf_field_type_floating_point_create") bt_ctf_field_type_floating_point_create(void);
1252%rename("_bt_ctf_field_type_floating_point_set_exponent_digits") bt_ctf_field_type_floating_point_set_exponent_digits(struct bt_ctf_field_type *floating_point, unsigned int exponent_digits);
1253%rename("_bt_ctf_field_type_floating_point_set_mantissa_digits") bt_ctf_field_type_floating_point_set_mantissa_digits(struct bt_ctf_field_type *floating_point, unsigned int mantissa_digits);
1254%rename("_bt_ctf_field_type_structure_create") bt_ctf_field_type_structure_create(void);
1255%rename("_bt_ctf_field_type_structure_add_field") bt_ctf_field_type_structure_add_field(struct bt_ctf_field_type *structure, struct bt_ctf_field_type *field_type, const char *field_name);
1256%rename("_bt_ctf_field_type_variant_create") bt_ctf_field_type_variant_create(struct bt_ctf_field_type *enum_tag, const char *tag_name);
1257%rename("_bt_ctf_field_type_variant_add_field") bt_ctf_field_type_variant_add_field(struct bt_ctf_field_type *variant, struct bt_ctf_field_type *field_type, const char *field_name);
1258%rename("_bt_ctf_field_type_array_create") bt_ctf_field_type_array_create(struct bt_ctf_field_type *element_type, unsigned int length);
1259%rename("_bt_ctf_field_type_sequence_create") bt_ctf_field_type_sequence_create(struct bt_ctf_field_type *element_type, const char *length_field_name);
1260%rename("_bt_ctf_field_type_string_create") bt_ctf_field_type_string_create(void);
1261%rename("_bt_ctf_field_type_string_set_encoding") bt_ctf_field_type_string_set_encoding(struct bt_ctf_field_type *string, enum ctf_string_encoding encoding);
1262%rename("_bt_ctf_field_type_set_alignment") bt_ctf_field_type_set_alignment(struct bt_ctf_field_type *type, unsigned int alignment);
1263%rename("_bt_ctf_field_type_set_byte_order") bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type *type, enum bt_ctf_byte_order byte_order);
1264%rename("_bt_ctf_field_type_get") bt_ctf_field_type_get(struct bt_ctf_field_type *type);
1265%rename("_bt_ctf_field_type_put") bt_ctf_field_type_put(struct bt_ctf_field_type *type);
1266
1267struct bt_ctf_field_type *bt_ctf_field_type_integer_create(unsigned int size);
1268int bt_ctf_field_type_integer_set_signed(struct bt_ctf_field_type *integer, int is_signed);
1269int bt_ctf_field_type_integer_set_base(struct bt_ctf_field_type *integer, enum bt_ctf_integer_base base);
1270int bt_ctf_field_type_integer_set_encoding(struct bt_ctf_field_type *integer, enum ctf_string_encoding encoding);
1271struct bt_ctf_field_type *bt_ctf_field_type_enumeration_create(struct bt_ctf_field_type *integer_container_type);
1272int bt_ctf_field_type_enumeration_add_mapping(struct bt_ctf_field_type *enumeration, const char *string, int64_t range_start, int64_t range_end);
1273struct bt_ctf_field_type *bt_ctf_field_type_floating_point_create(void);
1274int bt_ctf_field_type_floating_point_set_exponent_digits(struct bt_ctf_field_type *floating_point, unsigned int exponent_digits);
1275int bt_ctf_field_type_floating_point_set_mantissa_digits(struct bt_ctf_field_type *floating_point, unsigned int mantissa_digits);
1276struct bt_ctf_field_type *bt_ctf_field_type_structure_create(void);
1277int bt_ctf_field_type_structure_add_field(struct bt_ctf_field_type *structure, struct bt_ctf_field_type *field_type, const char *field_name);
1278struct bt_ctf_field_type *bt_ctf_field_type_variant_create(struct bt_ctf_field_type *enum_tag, const char *tag_name);
1279int bt_ctf_field_type_variant_add_field(struct bt_ctf_field_type *variant, struct bt_ctf_field_type *field_type, const char *field_name);
1280struct bt_ctf_field_type *bt_ctf_field_type_array_create(struct bt_ctf_field_type *element_type, unsigned int length);
1281struct bt_ctf_field_type *bt_ctf_field_type_sequence_create(struct bt_ctf_field_type *element_type, const char *length_field_name);
1282struct bt_ctf_field_type *bt_ctf_field_type_string_create(void);
1283int bt_ctf_field_type_string_set_encoding(struct bt_ctf_field_type *string, enum ctf_string_encoding encoding);
1284int bt_ctf_field_type_set_alignment(struct bt_ctf_field_type *type, unsigned int alignment);
1285int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type *type, enum bt_ctf_byte_order byte_order);
1286void bt_ctf_field_type_get(struct bt_ctf_field_type *type);
1287void bt_ctf_field_type_put(struct bt_ctf_field_type *type);
1288
1289/* =================================================================
1290 EVENT-FIELDS.H
1291 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
1292*/
1293%rename("_bt_ctf_field_create") bt_ctf_field_create(struct bt_ctf_field_type *type);
1294%rename("_bt_ctf_field_structure_get_field") bt_ctf_field_structure_get_field(struct bt_ctf_field *structure, const char *name);
1295%rename("_bt_ctf_field_array_get_field") bt_ctf_field_array_get_field(struct bt_ctf_field *array, uint64_t index);
1296%rename("_bt_ctf_field_sequence_set_length") bt_ctf_field_sequence_set_length(struct bt_ctf_field *sequence, struct bt_ctf_field *length_field);
1297%rename("_bt_ctf_field_sequence_get_field") bt_ctf_field_sequence_get_field(struct bt_ctf_field *sequence, uint64_t index);
1298%rename("_bt_ctf_field_variant_get_field") bt_ctf_field_variant_get_field(struct bt_ctf_field *variant, struct bt_ctf_field *tag);
1299%rename("_bt_ctf_field_enumeration_get_container") bt_ctf_field_enumeration_get_container(struct bt_ctf_field *enumeration);
1300%rename("_bt_ctf_field_signed_integer_set_value") bt_ctf_field_signed_integer_set_value(struct bt_ctf_field *integer, int64_t value);
1301%rename("_bt_ctf_field_unsigned_integer_set_value") bt_ctf_field_unsigned_integer_set_value(struct bt_ctf_field *integer, uint64_t value);
1302%rename("_bt_ctf_field_floating_point_set_value") bt_ctf_field_floating_point_set_value(struct bt_ctf_field *floating_point, double value);
1303%rename("_bt_ctf_field_string_set_value") bt_ctf_field_string_set_value(struct bt_ctf_field *string, const char *value);
1304%rename("_bt_ctf_field_get") bt_ctf_field_get(struct bt_ctf_field *field);
1305%rename("_bt_ctf_field_put") bt_ctf_field_put(struct bt_ctf_field *field);
1306
1307struct bt_ctf_field *bt_ctf_field_create(struct bt_ctf_field_type *type);
1308struct bt_ctf_field *bt_ctf_field_structure_get_field(struct bt_ctf_field *structure, const char *name);
1309struct bt_ctf_field *bt_ctf_field_array_get_field(struct bt_ctf_field *array, uint64_t index);
1310int bt_ctf_field_sequence_set_length(struct bt_ctf_field *sequence, struct bt_ctf_field *length_field);
1311struct bt_ctf_field *bt_ctf_field_sequence_get_field(struct bt_ctf_field *sequence, uint64_t index);
1312struct bt_ctf_field *bt_ctf_field_variant_get_field(struct bt_ctf_field *variant, struct bt_ctf_field *tag);
1313struct bt_ctf_field *bt_ctf_field_enumeration_get_container(struct bt_ctf_field *enumeration);
1314int bt_ctf_field_signed_integer_set_value(struct bt_ctf_field *integer, int64_t value);
1315int bt_ctf_field_unsigned_integer_set_value(struct bt_ctf_field *integer, uint64_t value);
1316int bt_ctf_field_floating_point_set_value(struct bt_ctf_field *floating_point, double value);
1317int bt_ctf_field_string_set_value(struct bt_ctf_field *string, const char *value);
1318void bt_ctf_field_get(struct bt_ctf_field *field);
1319void bt_ctf_field_put(struct bt_ctf_field *field);
1320
1321/* =================================================================
1322 EVENT.H
1323 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
1324*/
1325%rename("_bt_ctf_event_class_create") bt_ctf_event_class_create(const char *name);
1326%rename("_bt_ctf_event_class_add_field") bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class, struct bt_ctf_field_type *type, const char *name);
1327%rename("_bt_ctf_event_class_get") bt_ctf_event_class_get(struct bt_ctf_event_class *event_class);
1328%rename("_bt_ctf_event_class_put") bt_ctf_event_class_put(struct bt_ctf_event_class *event_class);
1329%rename("_bt_ctf_event_create") bt_ctf_event_create(struct bt_ctf_event_class *event_class);
1330%rename("_bt_ctf_event_set_payload") bt_ctf_event_set_payload(struct bt_ctf_event *event, const char *name, struct bt_ctf_field *value);
1331%rename("_bt_ctf_event_get_payload") bt_ctf_event_get_payload(struct bt_ctf_event *event, const char *name);
1332%rename("_bt_ctf_event_get") bt_ctf_event_get(struct bt_ctf_event *event);
1333%rename("_bt_ctf_event_put") bt_ctf_event_put(struct bt_ctf_event *event);
1334
1335struct bt_ctf_event_class *bt_ctf_event_class_create(const char *name);
1336int bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class, struct bt_ctf_field_type *type, const char *name);
1337void bt_ctf_event_class_get(struct bt_ctf_event_class *event_class);
1338void bt_ctf_event_class_put(struct bt_ctf_event_class *event_class);
1339struct bt_ctf_event *bt_ctf_event_create(struct bt_ctf_event_class *event_class);
1340int bt_ctf_event_set_payload(struct bt_ctf_event *event, const char *name, struct bt_ctf_field *value);
1341struct bt_ctf_field *bt_ctf_event_get_payload(struct bt_ctf_event *event, const char *name);
1342void bt_ctf_event_get(struct bt_ctf_event *event);
1343void bt_ctf_event_put(struct bt_ctf_event *event);
1344
1345/* =================================================================
1346 STREAM.H
1347 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
1348*/
1349%rename("_bt_ctf_stream_class_create") bt_ctf_stream_class_create(const char *name);
1350%rename("_bt_ctf_stream_class_set_clock") bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class *stream_class, struct bt_ctf_clock *clock);
1351%rename("_bt_ctf_stream_class_add_event_class") bt_ctf_stream_class_add_event_class(struct bt_ctf_stream_class *stream_class, struct bt_ctf_event_class *event_class);
1352%rename("_bt_ctf_stream_class_get") bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class);
1353%rename("_bt_ctf_stream_class_put") bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class);
1354%rename("_bt_ctf_stream_append_discarded_events") bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream, uint64_t event_count);
1355%rename("_bt_ctf_stream_append_event") bt_ctf_stream_append_event(struct bt_ctf_stream *stream, struct bt_ctf_event *event);
1356%rename("_bt_ctf_stream_flush") bt_ctf_stream_flush(struct bt_ctf_stream *stream);
1357%rename("_bt_ctf_stream_get") bt_ctf_stream_get(struct bt_ctf_stream *stream);
1358%rename("_bt_ctf_stream_put") bt_ctf_stream_put(struct bt_ctf_stream *stream);
1359
1360struct bt_ctf_stream_class *bt_ctf_stream_class_create(const char *name);
1361int bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class *stream_class, struct bt_ctf_clock *clock);
1362int bt_ctf_stream_class_add_event_class(struct bt_ctf_stream_class *stream_class, struct bt_ctf_event_class *event_class);
1363void bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class);
1364void bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class);
1365void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream, uint64_t event_count);
1366int bt_ctf_stream_append_event(struct bt_ctf_stream *stream, struct bt_ctf_event *event);
1367int bt_ctf_stream_flush(struct bt_ctf_stream *stream);
1368void bt_ctf_stream_get(struct bt_ctf_stream *stream);
1369void bt_ctf_stream_put(struct bt_ctf_stream *stream);
1370
1371/* =================================================================
1372 WRITER.H
1373 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
1374*/
1375%rename("_bt_ctf_writer_create") bt_ctf_writer_create(const char *path);
1376%rename("_bt_ctf_writer_create_stream") bt_ctf_writer_create_stream(struct bt_ctf_writer *writer, struct bt_ctf_stream_class *stream_class);
1377%rename("_bt_ctf_writer_add_environment_field") bt_ctf_writer_add_environment_field(struct bt_ctf_writer *writer, const char *name, const char *value);
1378%rename("_bt_ctf_writer_add_clock") bt_ctf_writer_add_clock(struct bt_ctf_writer *writer, struct bt_ctf_clock *clock);
1379%newobject bt_ctf_writer_get_metadata_string;
1380%rename("_bt_ctf_writer_get_metadata_string") bt_ctf_writer_get_metadata_string(struct bt_ctf_writer *writer);
1381%rename("_bt_ctf_writer_flush_metadata") bt_ctf_writer_flush_metadata(struct bt_ctf_writer *writer);
1382%rename("_bt_ctf_writer_set_byte_order") bt_ctf_writer_set_byte_order(struct bt_ctf_writer *writer, enum bt_ctf_byte_order byte_order);
1383%rename("_bt_ctf_writer_get") bt_ctf_writer_get(struct bt_ctf_writer *writer);
1384%rename("_bt_ctf_writer_put") bt_ctf_writer_put(struct bt_ctf_writer *writer);
1385
1386struct bt_ctf_writer *bt_ctf_writer_create(const char *path);
1387struct bt_ctf_stream *bt_ctf_writer_create_stream(struct bt_ctf_writer *writer, struct bt_ctf_stream_class *stream_class);
1388int bt_ctf_writer_add_environment_field(struct bt_ctf_writer *writer, const char *name, const char *value);
1389int bt_ctf_writer_add_clock(struct bt_ctf_writer *writer, struct bt_ctf_clock *clock);
1390char *bt_ctf_writer_get_metadata_string(struct bt_ctf_writer *writer);
1391void bt_ctf_writer_flush_metadata(struct bt_ctf_writer *writer);
1392int bt_ctf_writer_set_byte_order(struct bt_ctf_writer *writer, enum bt_ctf_byte_order byte_order);
1393void bt_ctf_writer_get(struct bt_ctf_writer *writer);
1394void bt_ctf_writer_put(struct bt_ctf_writer *writer);
1395
1396%pythoncode %{
1397
1398class CTFWriter:
ec8c88d7
JG
1399
1400 class Clock:
1401 def __init__(self, name):
1402 self._c = _bt_ctf_clock_create(name)
1403 if self._c is None:
1404 raise ValueError("Invalid clock name.")
1405
1406 def __del__(self):
1407 _bt_ctf_clock_put(self._c)
1408
14001277
JG
1409 """
1410 Get the clock's description.
1411 """
1412 @property
1413 def description(self):
1414 raise NotImplementedError("Getter not implemented.")
1415
ec8c88d7
JG
1416 """
1417 Set the clock's description. The description appears in the clock's TSDL
1418 meta-data.
1419 """
14001277
JG
1420 @description.setter
1421 def description(self, desc):
1422 ret = _bt_ctf_clock_set_description(self._c, str(desc))
ec8c88d7
JG
1423 if ret < 0:
1424 raise ValueError("Invalid clock description.")
1425
14001277
JG
1426 """
1427 Get the clock's frequency (Hz).
1428 """
1429 @property
1430 def frequency(self):
1431 raise NotImplementedError("Getter not implemented.")
1432
ec8c88d7
JG
1433 """
1434 Set the clock's frequency (Hz).
1435 """
14001277
JG
1436 @frequency.setter
1437 def frequency(self, freq):
ec8c88d7
JG
1438 ret = _bt_ctf_clock_set_frequency(self._c, freq)
1439 if ret < 0:
1440 raise ValueError("Invalid frequency value.")
1441
14001277
JG
1442 """
1443 Get the clock's precision (in clock ticks).
1444 """
1445 @property
1446 def precision(self):
1447 raise NotImplementedError("Getter not implemented.")
1448
ec8c88d7
JG
1449 """
1450 Set the clock's precision (in clock ticks).
1451 """
14001277
JG
1452 @precision.setter
1453 def precision(self, precision):
ec8c88d7
JG
1454 ret = _bt_ctf_clock_set_precision(self._c, precision)
1455
14001277
JG
1456 """
1457 Get the clock's offset in seconds from POSIX.1 Epoch.
1458 """
1459 @property
1460 def offset_seconds(self):
1461 raise NotImplementedError("Getter not implemented.")
1462
ec8c88d7
JG
1463 """
1464 Set the clock's offset in seconds from POSIX.1 Epoch.
1465 """
14001277
JG
1466 @offset_seconds.setter
1467 def offset_seconds(self, offset_s):
ec8c88d7
JG
1468 ret = _bt_ctf_clock_set_offset_s(self._c, offset_s)
1469 if ret < 0:
1470 raise ValueError("Invalid offset value.")
1471
14001277
JG
1472 """
1473 Get the clock's offset in ticks from POSIX.1 Epoch + offset in seconds.
1474 """
1475 @property
1476 def offset(self):
1477 raise NotImplementedError("Getter not implemented.")
1478
ec8c88d7
JG
1479 """
1480 Set the clock's offset in ticks from POSIX.1 Epoch + offset in seconds.
1481 """
14001277
JG
1482 @offset.setter
1483 def offset(self, offset):
ec8c88d7
JG
1484 ret = _bt_ctf_clock_set_offset(self._c, offset)
1485 if ret < 0:
1486 raise ValueError("Invalid offset value.")
1487
14001277
JG
1488 """
1489 Get a clock's absolute attribute. A clock is absolute if the clock
1490 is a global reference across the trace's other clocks.
1491 """
1492 @property
1493 def absolute(self):
1494 raise NotImplementedError("Getter not implemented.")
1495
ec8c88d7
JG
1496 """
1497 Set a clock's absolute attribute. A clock is absolute if the clock
1498 is a global reference across the trace's other clocks.
1499 """
14001277
JG
1500 @absolute.setter
1501 def absolute(self, is_absolute):
1502 ret = _bt_ctf_clock_set_is_absolute(self._c, int(is_absolute))
ec8c88d7
JG
1503 if ret < 0:
1504 raise ValueError("Could not set the clock's absolute attribute.")
1505
14001277
JG
1506 """
1507 Get the current time in nanoseconds since the clock's origin (offset and
1508 offset_s attributes).
1509 """
1510 @property
1511 def time(self):
1512 raise NotImplementedError("Getter not implemented.")
1513
ec8c88d7
JG
1514 """
1515 Set the current time in nanoseconds since the clock's origin (offset and
1516 offset_s attributes). The clock's value will be sampled as events are
1517 appended to a stream.
1518 """
14001277
JG
1519 @time.setter
1520 def time(self, time):
ec8c88d7
JG
1521 ret = _bt_ctf_clock_set_time(self._c, time)
1522 if ret < 0:
1523 raise ValueError("Invalid time value.")
1524
14001277 1525 class FieldDeclaration:
ec8c88d7 1526 """
14001277
JG
1527 FieldDeclaration should not be instantiated directly. Please instantiate
1528 one of the concrete FieldDeclaration classes.
ec8c88d7
JG
1529 """
1530 class IntegerBase:
1531 # These values are based on the bt_ctf_integer_base enum
1532 # declared in event-types.h.
1533 INTEGER_BASE_UNKNOWN = -1
1534 INTEGER_BASE_BINARY = 2
1535 INTEGER_BASE_OCTAL = 8
1536 INTEGER_BASE_DECIMAL = 10
1537 INTEGER_BASE_HEXADECIMAL = 16
1538
1539 def __init__(self):
1540 if self._ft is None:
14001277 1541 raise ValueError("FieldDeclaration creation failed.")
ec8c88d7
JG
1542
1543 def __del__(self):
1544 _bt_ctf_field_type_put(self._ft)
1545
14001277
JG
1546 """
1547 Get the field type's alignment.
1548 """
1549 @property
1550 def alignment(self):
1551 raise NotImplementedError("Getter not implemented.")
1552
ec8c88d7
JG
1553 """
1554 Set the field type's alignment. Defaults to 1 (bit-aligned). However,
1555 some types, such as structures and string, may impose other alignment
1556 constraints.
1557 """
14001277
JG
1558 @alignment.setter
1559 def alignment(self, alignment):
ec8c88d7
JG
1560 ret = _bt_ctf_field_type_set_alignment(self._ft, alignment)
1561 if ret < 0:
1562 raise ValueError("Invalid alignment value.")
1563
14001277
JG
1564 """
1565 Get the field type's byte order. One of the ByteOrder's constant.
1566 """
1567 @property
1568 def byte_order(self):
1569 raise NotImplementedError("Getter not implemented.")
1570
ec8c88d7
JG
1571 """
1572 Set the field type's byte order. Use constants defined in the ByteOrder
1573 class.
1574 """
14001277
JG
1575 @byte_order.setter
1576 def byte_order(self, byte_order):
ec8c88d7
JG
1577 ret = _bt_ctf_field_type_set_byte_order(self._ft, byte_order)
1578 if ret < 0:
1579 raise ValueError("Could not set byte order value.")
1580
14001277 1581 class IntegerFieldDeclaration(FieldDeclaration):
ec8c88d7
JG
1582 """
1583 Create a new integer field type of the given size.
1584 """
1585 def __init__(self, size):
1586 self._ft = _bt_ctf_field_type_integer_create(size)
1587 super().__init__()
1588
1589 """
14001277
JG
1590 Get an integer's signedness attribute.
1591 """
1592 @property
1593 def signed(self):
1594 raise NotImplementedError("Getter not implemented.")
1595
1596 """
1597 Set an integer's signedness attribute.
ec8c88d7 1598 """
14001277
JG
1599 @signed.setter
1600 def signed(self, signed):
ec8c88d7
JG
1601 ret = _bt_ctf_field_type_integer_set_signed(self._ft, signed)
1602 if ret < 0:
1603 raise ValueError("Could not set signed attribute.")
1604
1605 """
14001277
JG
1606 Get the integer's base used to pretty-print the resulting trace.
1607 """
1608 @property
1609 def base(self):
1610 raise NotImplementedError("Getter not implemented.")
1611
1612 """
1613 Set the integer's base used to pretty-print the resulting trace.
ec8c88d7
JG
1614 The base must be a constant of the IntegerBase class.
1615 """
14001277
JG
1616 @base.setter
1617 def base(self, base):
ec8c88d7
JG
1618 ret = _bt_ctf_field_type_integer_set_base(self._ft, base)
1619 if ret < 0:
1620 raise ValueError("Could not set base value.")
1621
14001277
JG
1622 """
1623 Get the integer's encoding (one of the constants of the
1624 CTFStringEncoding class).
1625 """
1626 @property
1627 def encoding(self):
1628 raise NotImplementedError("Getter not implemented.")
1629
ec8c88d7
JG
1630 """
1631 An integer encoding may be set to signal that the integer must be printed
1632 as a text character. Must be a constant from the CTFStringEncoding class.
1633 """
14001277
JG
1634 @encoding.setter
1635 def encoding(self, encoding):
ec8c88d7
JG
1636 ret = _bt_ctf_field_type_integer_set_encoding(self._ft, encoding)
1637 if ret < 0:
1638 raise ValueError("Could not set integer encoding.")
1639
14001277 1640 class EnumerationFieldDeclaration(FieldDeclaration):
ec8c88d7
JG
1641 """
1642 Create a new enumeration field type with the given underlying type.
1643 """
1644 def __init__(self, integer_type):
14001277 1645 if integer_type is None or not isinstance(integer_type, CTFWriter.IntegerFieldDeclaration):
ec8c88d7
JG
1646 raise TypeError("Invalid integer container.")
1647
1648 self._ft = _bt_ctf_field_type_enumeration_create(integer_type._ft)
1649 super().__init__()
1650
1651 """
1652 Add a mapping to the enumeration. The range's values are inclusive.
1653 """
1654 def add_mapping(self, name, range_start, range_end):
14001277 1655 ret = _bt_ctf_field_type_enumeration_add_mapping(self._ft, str(name), range_start, range_end)
ec8c88d7
JG
1656 if ret < 0:
1657 raise ValueError("Could not add mapping to enumeration type.")
1658
14001277 1659 class FloatFieldDeclaration(FieldDeclaration):
ec8c88d7
JG
1660 FLT_EXP_DIG = 8
1661 DBL_EXP_DIG = 11
1662 FLT_MANT_DIG = 24
1663 DBL_MANT_DIG = 53
1664
1665 """
1666 Create a new floating point field type.
1667 """
1668 def __init__(self):
1669 self._ft = _bt_ctf_field_type_floating_point_create()
1670 super().__init__()
1671
1672 """
14001277
JG
1673 Get the number of exponent digits to use to store the floating point field.
1674 """
1675 @property
1676 def exponent_digits(self):
1677 raise NotImplementedError("Getter not implemented.")
1678
1679 """
1680 Set the number of exponent digits to use to store the floating point field.
ec8c88d7
JG
1681 The only values currently supported are FLT_EXP_DIG and DBL_EXP_DIG which
1682 are defined as constants of this class.
1683 """
14001277
JG
1684 @exponent_digits.setter
1685 def exponent_digits(self, exponent_digits):
ec8c88d7
JG
1686 ret = _bt_ctf_field_type_floating_point_set_exponent_digits(self._ft, exponent_digits)
1687 if ret < 0:
1688 raise ValueError("Could not set exponent digit count.")
1689
1690 """
14001277
JG
1691 Get the number of mantissa digits to use to store the floating point field.
1692 """
1693 @property
1694 def mantissa_digits(self):
1695 raise NotImplementedError("Getter not implemented.")
1696
1697 """
1698 Set the number of mantissa digits to use to store the floating point field.
ec8c88d7
JG
1699 The only values currently supported are FLT_MANT_DIG and DBL_MANT_DIG which
1700 are defined as constants of this class.
1701 """
14001277
JG
1702 @mantissa_digits.setter
1703 def mantissa_digits(self, mantissa_digits):
ec8c88d7
JG
1704 ret = _bt_ctf_field_type_floating_point_set_mantissa_digits(self._ft, mantissa_digits)
1705 if ret < 0:
1706 raise ValueError("Could not set mantissa digit count.")
1707
14001277 1708 class StructureFieldDeclaration(FieldDeclaration):
ec8c88d7
JG
1709 """
1710 Create a new structure field type.
1711 """
1712 def __init__(self):
1713 self._ft = _bt_ctf_field_type_structure_create()
1714 super().__init__()
1715
1716 """
1717 Add a field of type "field_type" to the structure.
1718 """
1719 def add_field(self, field_type, field_name):
14001277 1720 ret = _bt_ctf_field_type_structure_add_field(self._ft, field_type._ft, str(field_name))
ec8c88d7
JG
1721 if ret < 0:
1722 raise ValueError("Could not add field to structure.")
1723
14001277 1724 class VariantFieldDeclaration(FieldDeclaration):
ec8c88d7
JG
1725 """
1726 Create a new variant field type.
1727 """
1728 def __init__(self, enum_tag, tag_name):
14001277
JG
1729 if enum_tag is None or not isinstance(enum_tag, CTFWriter.EnumerationFieldDeclaration):
1730 raise TypeError("Invalid tag type; must be of type EnumerationFieldDeclaration.")
ec8c88d7 1731
14001277 1732 self._ft = _bt_ctf_field_type_variant_create(enum_tag._ft, str(tag_name))
ec8c88d7
JG
1733 super().__init__()
1734
1735 """
1736 Add a field of type "field_type" to the variant.
1737 """
1738 def add_field(self, field_type, field_name):
14001277 1739 ret = _bt_ctf_field_type_variant_add_field(self._ft, field_type._ft, str(field_name))
ec8c88d7
JG
1740 if ret < 0:
1741 raise ValueError("Could not add field to variant.")
1742
14001277 1743 class ArrayFieldDeclaration(FieldDeclaration):
ec8c88d7
JG
1744 """
1745 Create a new array field type.
1746 """
1747 def __init__(self, element_type, length):
1748 self._ft = _bt_ctf_field_type_array_create(element_type._ft, length)
1749 super().__init__()
1750
14001277 1751 class SequenceFieldDeclaration(FieldDeclaration):
ec8c88d7
JG
1752 """
1753 Create a new sequence field type.
1754 """
1755 def __init__(self, element_type, length_field_name):
14001277 1756 self._ft = _bt_ctf_field_type_sequence_create(element_type._ft, str(length_field_name))
ec8c88d7
JG
1757 super().__init__()
1758
14001277 1759 class StringFieldDeclaration(FieldDeclaration):
ec8c88d7
JG
1760 """
1761 Create a new string field type.
1762 """
1763 def __init__(self):
1764 self._ft = _bt_ctf_field_type_string_create()
1765 super().__init__()
1766
14001277
JG
1767 """
1768 Get a string type's encoding (a constant from the CTFStringEncoding class).
1769 """
1770 @property
1771 def encoding(self):
1772 raise NotImplementedError("Getter not implemented.")
1773
ec8c88d7
JG
1774 """
1775 Set a string type's encoding. Must be a constant from the CTFStringEncoding class.
1776 """
14001277
JG
1777 @encoding.setter
1778 def encoding(self, encoding):
ec8c88d7
JG
1779 ret = _bt_ctf_field_type_string_set_encoding(self._ft, encoding)
1780 if ret < 0:
1781 raise ValueError("Could not set string encoding.")
1782
1783 """
1784 Create an instance of a field.
1785 """
1786 @staticmethod
1787 def create_field(self, field_type):
14001277
JG
1788 if field_type is None or not isinstance(field_type, CTFWriter.FieldDeclaration):
1789 raise TypeError("Invalid field_type. Type must be a FieldDeclaration-derived class.")
1790
1791 if isinstance(field_type, CTFWriter.IntegerFieldDeclaration):
1792 return CTFWriter.IntegerField(field_type)
1793 elif isinstance(field_type, CTFWriter.EnumerationFieldDeclaration):
1794 return CTFWriter.EnumerationField(field_type)
1795 elif isinstance(field_type, CTFWriter.FloatFieldDeclaration):
1796 return CTFWriter.FloatFieldingPoint(field_type)
1797 elif isinstance(field_type, CTFWriter.StructureFieldDeclaration):
1798 return CTFWriter.StructureField(field_type)
1799 elif isinstance(field_type, CTFWriter.VariantFieldDeclaration):
1800 return CTFWriter.VariantField(field_type)
1801 elif isinstance(field_type, CTFWriter.ArrayFieldDeclaration):
1802 return CTFWriter.ArrayField(field_type)
1803 elif isinstance(field_type, CTFWriter.SequenceFieldDeclaration):
1804 return CTFWriter.SequenceField(field_type)
1805 elif isinstance(field_type, CTFWriter.StringFieldDeclaration):
1806 return CTFWriter.StringField(field_type)
ec8c88d7
JG
1807
1808 class Field:
1809 """
1810 Base class, do not instantiate.
1811 """
1812 def __init__(self, field_type):
14001277 1813 if not isinstance(field_type, CTFWriter.FieldDeclaration):
ec8c88d7
JG
1814 raise TypeError("Invalid field_type argument.")
1815
1816 self._f = _bt_ctf_field_create(field_type._ft)
1817 if self._f is None:
1818 raise ValueError("Field creation failed.")
1819
1820 def __del__(self):
1821 _bt_ctf_field_put(self._f)
1822
1823 @staticmethod
1824 def _create_field_from_native_instance(native_field_instance):
1825 type_dict = {
14001277
JG
1826 CTFTypeId.INTEGER : CTFWriter.IntegerField,
1827 CTFTypeId.FLOAT : CTFWriter.FloatFieldingPoint,
1828 CTFTypeId.ENUM : CTFWriter.EnumerationField,
1829 CTFTypeId.STRING : CTFWriter.StringField,
1830 CTFTypeId.STRUCT : CTFWriter.StructureField,
1831 CTFTypeId.VARIANT : CTFWriter.VariantField,
1832 CTFTypeId.ARRAY : CTFWriter.ArrayField,
1833 CTFTypeId.SEQUENCE : CTFWriter.SequenceField
ec8c88d7
JG
1834 }
1835
1836 field_type = _bt_python_get_field_type(native_field_instance)
1837 if field_type == CTFTypeId.UNKNOWN:
1838 raise TypeError("Invalid field instance")
1839
1840 field = CTFWriter.Field.__new__(CTFWriter.Field)
1841 field._f = native_field_instance
1842 field.__class__ = type_dict[field_type]
1843 return field
1844
14001277
JG
1845 class IntegerField(Field):
1846 """
1847 Get an integer field's value.
1848 """
1849 @property
1850 def value(self):
1851 raise NotImplementedError("Getter not implemented.")
1852
ec8c88d7
JG
1853 """
1854 Set an integer field's value.
1855 """
14001277
JG
1856 @value.setter
1857 def value(self, value):
ec8c88d7
JG
1858 signedness = _bt_python_field_integer_get_signedness(self._f)
1859 if signedness < 0:
1860 raise TypeError("Invalid integer instance.")
1861
1862 if signedness == 0:
1863 ret = _bt_ctf_field_unsigned_integer_set_value(self._f, value)
1864 else:
1865 ret = _bt_ctf_field_signed_integer_set_value(self._f, value)
1866
1867 if ret < 0:
1868 raise ValueError("Could not set integer field value.")
1869
14001277 1870 class EnumerationField(Field):
ec8c88d7
JG
1871 """
1872 Return the enumeration's underlying container field (an integer field).
1873 """
14001277
JG
1874 @property
1875 def container(self):
1876 container = CTFWriter.IntegerField.__new__(CTFWriter.IntegerField)
ec8c88d7
JG
1877 container._f = _bt_ctf_field_enumeration_get_container(self._f)
1878 if container._f is None:
1879 raise TypeError("Invalid enumeration field type.")
1880 return container
1881
14001277
JG
1882 class FloatFieldingPoint(Field):
1883 """
1884 Get a floating point field's value.
1885 """
1886 @property
1887 def value(self):
1888 raise NotImplementedError("Getter not implemented.")
1889
ec8c88d7
JG
1890 """
1891 Set a floating point field's value.
1892 """
14001277
JG
1893 @value.setter
1894 def value(self, value):
1895 ret = _bt_ctf_field_floating_point_set_value(self._f, float(value))
ec8c88d7
JG
1896 if ret < 0:
1897 raise ValueError("Could not set floating point field value.")
1898
14001277 1899 class StructureField(Field):
ec8c88d7
JG
1900 """
1901 Get the structure's field corresponding to the provided field name.
1902 """
14001277
JG
1903 def field(self, field_name):
1904 native_instance = _bt_ctf_field_structure_get_field(self._f, str(field_name))
ec8c88d7
JG
1905 if native_instance is None:
1906 raise ValueError("Invalid field_name provided.")
1907 return CTFWriter.Field._create_field_from_native_instance(native_instance)
1908
14001277 1909 class VariantField(Field):
ec8c88d7
JG
1910 """
1911 Return the variant's selected field. The "tag" field is the selector enum field.
1912 """
14001277 1913 def field(self, tag):
ec8c88d7
JG
1914 native_instance = _bt_ctf_field_variant_get_field(self._f, tag._f)
1915 if native_instance is None:
1916 raise ValueError("Invalid tag provided.")
1917 return CTFWriter.Field._create_field_from_native_instance(native_instance)
1918
14001277 1919 class ArrayField(Field):
ec8c88d7
JG
1920 """
1921 Return the array's field at position "index".
1922 """
14001277 1923 def field(self, index):
ec8c88d7
JG
1924 native_instance = _bt_ctf_field_array_get_field(self._f, index)
1925 if native_instance is None:
1926 raise IndexError("Invalid index provided.")
1927 return CTFWriter.Field._create_field_from_native_instance(native_instance)
1928
14001277
JG
1929 class SequenceField(Field):
1930 """
1931 Get the sequence's length field (IntegerField).
1932 """
1933 @property
1934 def length(self):
1935 raise NotImplementedError("Getter not implemented.")
1936
ec8c88d7
JG
1937 """
1938 Set the sequence's length field (IntegerField).
1939 """
14001277
JG
1940 @length.setter
1941 def length(self, length_field):
46395f8f 1942 if not isinstance(length_field, CTFWriter.IntegerField):
ec8c88d7 1943 raise TypeError("Invalid length field.")
46395f8f 1944 ret = _bt_ctf_field_sequence_set_length(self._f, length_field._f)
ec8c88d7
JG
1945 if ret < 0:
1946 raise ValueError("Could not set sequence length.")
1947
1948 """
1949 Return the sequence's field at position "index".
1950 """
14001277 1951 def field(self, index):
ec8c88d7
JG
1952 native_instance = _bt_ctf_field_sequence_get_field(self._f, index)
1953 if native_instance is None:
1954 raise ValueError("Could not get sequence element at index.")
1955 return CTFWriter.Field._create_field_from_native_instance(native_instance)
1956
14001277
JG
1957 class StringField(Field):
1958 """
1959 Get a string field's value.
1960 """
1961 @property
1962 def value(self):
1963 raise NotImplementedError("Getter not implemented.")
1964
ec8c88d7
JG
1965 """
1966 Set a string field's value.
1967 """
14001277
JG
1968 @value.setter
1969 def value(self, value):
1970 ret = _bt_ctf_field_string_set_value(self._f, str(value))
ec8c88d7
JG
1971 if ret < 0:
1972 raise ValueError("Could not set string field value.")
1973
1974 class EventClass:
1975 """
1976 Create a new event class of the given name.
1977 """
1978 def __init__(self, name):
1979 self._ec = _bt_ctf_event_class_create(name)
1980 if self._ec is None:
1981 raise ValueError("Event class creation failed.")
1982
1983 def __del__(self):
1984 _bt_ctf_event_class_put(self._ec)
1985
1986 """
1987 Add a field of type "field_type" to the event class.
1988 """
1989 def add_field(self, field_type, field_name):
14001277 1990 ret = _bt_ctf_event_class_add_field(self._ec, field_type._ft, str(field_name))
ec8c88d7
JG
1991 if ret < 0:
1992 raise ValueError("Could not add field to event class.")
1993
1994 class Event:
1995 """
1996 Create a new event of the given event class.
1997 """
1998 def __init__(self, event_class):
1999 if not isinstance(event_class, CTFWriter.EventClass):
2000 raise TypeError("Invalid event_class argument.")
2001
2002 self._e = _bt_ctf_event_create(event_class._ec)
2003 if self._e is None:
2004 raise ValueError("Event creation failed.")
2005
2006 def __del__(self):
2007 _bt_ctf_event_put(self._e)
2008
2009 """
2010 Set a manually created field as an event's payload.
2011 """
14001277 2012 def set_payload(self, field_name, value_field):
ec8c88d7
JG
2013 if not isinstance(value, CTFWriter.Field):
2014 raise TypeError("Invalid value type.")
46395f8f 2015 ret = _bt_ctf_event_set_payload(self._e, str(field_name), value_field._f)
ec8c88d7
JG
2016 if ret < 0:
2017 raise ValueError("Could not set event field payload.")
2018
2019 """
14001277 2020 Get a field from event.
ec8c88d7 2021 """
14001277
JG
2022 def payload(self, field_name):
2023 native_instance = _bt_ctf_event_get_payload(self._e, str(field_name))
ec8c88d7
JG
2024 if native_instance is None:
2025 raise ValueError("Could not get event payload.")
2026 return CTFWriter.Field._create_field_from_native_instance(native_instance)
2027
2028 class StreamClass:
2029 """
2030 Create a new stream class of the given name.
2031 """
2032 def __init__(self, name):
2033 self._sc = _bt_ctf_stream_class_create(name)
2034 if self._sc is None:
2035 raise ValueError("Stream class creation failed.")
2036
2037 def __del__(self):
2038 _bt_ctf_stream_class_put(self._sc)
2039
14001277
JG
2040 """
2041 Get a stream class' clock.
2042 """
2043 @property
2044 def clock(self):
2045 raise NotImplementedError("Getter not implemented.")
2046
ec8c88d7
JG
2047 """
2048 Assign a clock to a stream class.
2049 """
14001277
JG
2050 @clock.setter
2051 def clock(self, clock):
ec8c88d7
JG
2052 if not isinstance(clock, CTFWriter.Clock):
2053 raise TypeError("Invalid clock type.")
2054
2055 ret = _bt_ctf_stream_class_set_clock(self._sc, clock._c)
2056 if ret < 0:
2057 raise ValueError("Could not set stream class clock.")
2058
2059 """
2060 Add an event class to a stream class. New events can be added even after a
14001277 2061 stream has been instantiated and events have been appended. However, a stream
ec8c88d7
JG
2062 will not accept events of a class that has not been registered beforehand.
2063 """
2064 def add_event_class(self, event_class):
2065 if not isinstance(event_class, CTFWriter.EventClass):
2066 raise TypeError("Invalid event_class type.")
2067
2068 ret = _bt_ctf_stream_class_add_event_class(self._sc, event_class._ec)
2069 if ret < 0:
2070 raise ValueError("Could not add event class.")
2071
2072 class Stream:
2073 """
2074 Create a stream of the given class.
2075 """
2076 def __init__(self, stream_class):
2077 if not isinstance(stream_class, CTFWriter.StreamClass):
2078 raise TypeError("Invalid stream_class type.")
2079
2080 self._s = _bt_ctf_stream_create(stream_class._sc)
2081 if self._s is None:
2082 raise ValueError("Stream creation failed.")
2083
2084 def __del__(self):
2085 _bt_ctf_stream_put(self._s)
2086
2087 """
2088 Increase the current packet's discarded event count.
2089 """
2090 def append_discarded_events(self, event_count):
2091 ret = _bt_ctf_stream_append_discarded_events(self._s, event_count)
2092 if ret < 0:
2093 raise ValueError("Could not append discarded events.")
2094
2095 """
2096 Append "event" to the stream's current packet. The stream's associated clock
2097 will be sampled during this call. The event shall not be modified after
2098 being appended to a stream.
2099 """
2100 def append_event(self, event):
2101 ret = _bt_ctf_stream_append_event(self._s, event._e)
2102 if ret < 0:
2103 raise ValueError("Could not append event to stream.")
2104
2105 """
2106 The stream's current packet's events will be flushed to disk. Events
2107 subsequently appended to the stream will be added to a new packet.
2108 """
2109 def flush(self):
2110 ret = _bt_ctf_stream_flush(self._s)
2111 if ret < 0:
2112 raise ValueError("Could not flush stream.")
2113
2114 class Writer:
2115 """
2116 Create a new writer that will produce a trace in the given path.
2117 """
2118 def __init__(self, path):
2119 self._w = _bt_ctf_writer_create(path)
2120 if self._w is None:
2121 raise ValueError("Writer creation failed.")
2122
2123 def __del__(self):
2124 _bt_ctf_writer_put(self._w)
2125
2126 """
2127 Create a new stream instance and register it to the writer.
2128 """
2129 def create_stream(self, stream_class):
2130 if not isinstance(stream_class, CTFWriter.StreamClass):
2131 raise TypeError("Invalid stream_class type.")
2132
2133 stream = CTFWriter.Stream.__new__(CTFWriter.Stream)
2134 stream._s = _bt_ctf_writer_create_stream(self._w, stream_class._sc)
2135 return stream
2136
2137 """
2138 Add an environment field to the trace.
2139 """
2140 def add_environment_field(self, name, value):
14001277 2141 ret = _bt_ctf_writer_add_environment_field(self._w, str(name), str(value))
ec8c88d7
JG
2142 if ret < 0:
2143 raise ValueError("Could not add environment field to trace.")
2144
2145 """
2146 Add a clock to the trace. Clocks assigned to stream classes must be
2147 registered to the writer.
2148 """
2149 def add_clock(self, clock):
2150 ret = _bt_ctf_writer_add_clock(self._w, clock._c)
2151 if ret < 0:
2152 raise ValueError("Could not add clock to Writer.")
2153
2154 """
2155 Get the trace's TSDL meta-data.
2156 """
14001277
JG
2157 @property
2158 def metadata(self):
ec8c88d7
JG
2159 return _bt_ctf_writer_get_metadata_string(self._w)
2160
2161 """
2162 Flush the trace's metadata to the metadata file.
2163 """
2164 def flush_metadata(self):
2165 _bt_ctf_writer_flush_metadata(self._w)
2166
14001277
JG
2167 """
2168 Get the trace's byte order. Must be a constant from the ByteOrder
2169 class.
2170 """
2171 @property
2172 def byte_order(self):
2173 raise NotImplementedError("Getter not implemented.")
2174
ec8c88d7
JG
2175 """
2176 Set the trace's byte order. Must be a constant from the ByteOrder
2177 class. Defaults to BYTE_ORDER_NATIVE, the host machine's endianness.
2178 """
14001277
JG
2179 @byte_order.setter
2180 def byte_order(self, byte_order):
ec8c88d7
JG
2181 ret = _bt_ctf_writer_set_byte_order(self._w, byte_order)
2182 if ret < 0:
2183 raise ValueError("Could not set trace's byte order.")
2184
2185%}
This page took 0.12021 seconds and 4 git commands to generate.