Commit | Line | Data |
---|---|---|
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 | ||
26 | Babeltrace is a trace viewer and converter reading and writing the | |
27 | Common Trace Format (CTF). Its main use is to pretty-print CTF | |
28 | traces into a human-readable text output. | |
29 | ||
74ea15ad | 30 | To use this module, the first step is to create a TraceCollection and add a |
24a3136a DS |
31 | trace to it." |
32 | %enddef | |
33 | ||
34 | %module(docstring=DOCSTRING) babeltrace | |
35 | ||
38f28df6 | 36 | %include "stdint.i" |
24a3136a DS |
37 | %include "typemaps.i" |
38 | %{ | |
39 | #define SWIG_FILE_WITH_INIT | |
40 | #include <babeltrace/babeltrace.h> | |
41 | #include <babeltrace/babeltrace-internal.h> | |
42 | #include <babeltrace/trace-handle.h> | |
43 | #include <babeltrace/trace-handle-internal.h> | |
44 | #include <babeltrace/context.h> | |
45 | #include <babeltrace/context-internal.h> | |
46 | #include <babeltrace/iterator.h> | |
47 | #include <babeltrace/iterator-internal.h> | |
48 | #include <babeltrace/format.h> | |
49 | #include <babeltrace/list.h> | |
24a3136a DS |
50 | #include <babeltrace/types.h> |
51 | #include <babeltrace/ctf/iterator.h> | |
52 | #include "python-complements.h" | |
ec8c88d7 JG |
53 | #include <babeltrace/ctf-writer/clock.h> |
54 | #include <babeltrace/ctf-writer/event-fields.h> | |
55 | #include <babeltrace/ctf-writer/event-types.h> | |
56 | #include <babeltrace/ctf-writer/event.h> | |
57 | #include <babeltrace/ctf-writer/stream.h> | |
58 | #include <babeltrace/ctf-writer/writer.h> | |
24a3136a DS |
59 | %} |
60 | ||
24a3136a | 61 | typedef int bt_intern_str; |
5792eb34 | 62 | typedef int64_t ssize_t; |
24a3136a | 63 | |
cebae8c3 JG |
64 | /* ================================================================= |
65 | PYTHON-COMPLEMENTS.H | |
66 | ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ | |
67 | */ | |
68 | ||
cebae8c3 JG |
69 | struct bt_definition **_bt_python_field_listcaller( |
70 | const struct bt_ctf_event *ctf_event, | |
71 | const struct bt_definition *scope, | |
72 | unsigned int *OUTPUT); | |
73 | struct bt_definition *_bt_python_field_one_from_list( | |
74 | struct bt_definition **list, int index); | |
75 | struct bt_ctf_event_decl **_bt_python_event_decl_listcaller( | |
76 | int handle_id, | |
77 | struct bt_context *ctx, | |
78 | unsigned int *OUTPUT); | |
79 | struct bt_ctf_event_decl *_bt_python_decl_one_from_list( | |
80 | struct bt_ctf_event_decl **list, int index); | |
81 | struct bt_ctf_field_decl **_by_python_field_decl_listcaller( | |
82 | struct bt_ctf_event_decl *event_decl, | |
83 | enum bt_ctf_scope scope, | |
84 | unsigned int *OUTPUT); | |
85 | struct bt_ctf_field_decl *_bt_python_field_decl_one_from_list( | |
86 | struct bt_ctf_field_decl **list, int index); | |
87 | struct definition_array *_bt_python_get_array_from_def( | |
88 | struct bt_definition *field); | |
89 | struct definition_sequence *_bt_python_get_sequence_from_def( | |
90 | struct bt_definition *field); | |
5792eb34 JG |
91 | struct bt_declaration *_bt_python_get_array_element_declaration( |
92 | struct bt_declaration *field); | |
3866c850 JG |
93 | struct bt_declaration *_bt_python_get_sequence_element_declaration( |
94 | struct bt_declaration *field); | |
5792eb34 | 95 | const char *_bt_python_get_array_string(struct bt_definition *field); |
3866c850 | 96 | const char *_bt_python_get_sequence_string(struct bt_definition *field); |
ec8c88d7 JG |
97 | int _bt_python_field_integer_get_signedness(const struct bt_ctf_field *field); |
98 | enum ctf_type_id _bt_python_get_field_type(const struct bt_ctf_field *field); | |
b4b5e4b5 JG |
99 | const char *_bt_python_ctf_field_type_enumeration_get_mapping( |
100 | struct bt_ctf_field_type *enumeration, size_t index, | |
101 | int64_t *OUTPUT, int64_t *OUTPUT); | |
102 | const char *_bt_python_ctf_field_type_enumeration_get_mapping_unsigned( | |
103 | struct bt_ctf_field_type *enumeration, size_t index, | |
104 | uint64_t *OUTPUT, uint64_t *OUTPUT); | |
105 | const char *_bt_python_ctf_field_type_structure_get_field_name( | |
106 | struct bt_ctf_field_type *structure, size_t index); | |
107 | struct bt_ctf_field_type *_bt_python_ctf_field_type_structure_get_field_type( | |
108 | struct bt_ctf_field_type *structure, size_t index); | |
109 | const char *_bt_python_ctf_field_type_variant_get_field_name( | |
110 | struct bt_ctf_field_type *variant, size_t index); | |
111 | struct bt_ctf_field_type *_bt_python_ctf_field_type_variant_get_field_type( | |
112 | struct bt_ctf_field_type *variant, size_t index); | |
38f28df6 JG |
113 | const char *_bt_python_ctf_event_class_get_field_name( |
114 | struct bt_ctf_event_class *event_class, size_t index); | |
115 | struct bt_ctf_field_type *_bt_python_ctf_event_class_get_field_type( | |
116 | struct bt_ctf_event_class *event_class, size_t index); | |
cebae8c3 | 117 | |
24a3136a DS |
118 | /* ================================================================= |
119 | CONTEXT.H, CONTEXT-INTERNAL.H | |
120 | ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ | |
121 | */ | |
122 | ||
123 | %rename("_bt_context_create") bt_context_create(void); | |
124 | %rename("_bt_context_add_trace") bt_context_add_trace( | |
125 | struct bt_context *ctx, const char *path, const char *format, | |
2c0df204 XH |
126 | void (*packet_seek)(struct bt_stream_pos *pos, size_t index, int whence), |
127 | struct bt_mmap_stream_list *stream_list, FILE *metadata); | |
24a3136a DS |
128 | %rename("_bt_context_remove_trace") bt_context_remove_trace( |
129 | struct bt_context *ctx, int trace_id); | |
130 | %rename("_bt_context_get") bt_context_get(struct bt_context *ctx); | |
131 | %rename("_bt_context_put") bt_context_put(struct bt_context *ctx); | |
132 | %rename("_bt_ctf_event_get_context") bt_ctf_event_get_context( | |
133 | const struct bt_ctf_event *event); | |
134 | ||
135 | struct bt_context *bt_context_create(void); | |
136 | int bt_context_add_trace(struct bt_context *ctx, const char *path, const char *format, | |
2c0df204 XH |
137 | void (*packet_seek)(struct bt_stream_pos *pos, size_t index, int whence), |
138 | struct bt_mmap_stream_list *stream_list, FILE *metadata); | |
24a3136a DS |
139 | void bt_context_remove_trace(struct bt_context *ctx, int trace_id); |
140 | void bt_context_get(struct bt_context *ctx); | |
141 | void bt_context_put(struct bt_context *ctx); | |
142 | struct bt_context *bt_ctf_event_get_context(const struct bt_ctf_event *event); | |
143 | ||
74ea15ad | 144 | // class TraceCollection to prevent direct access to struct bt_context |
24a3136a | 145 | %pythoncode%{ |
74ea15ad | 146 | class TraceCollection: |
24a3136a | 147 | """ |
74ea15ad | 148 | The TraceCollection is the object that contains all currently opened traces. |
24a3136a DS |
149 | """ |
150 | ||
151 | def __init__(self): | |
74ea15ad | 152 | self._tc = _bt_context_create() |
24a3136a DS |
153 | |
154 | def __del__(self): | |
74ea15ad | 155 | _bt_context_put(self._tc) |
24a3136a | 156 | |
74ea15ad | 157 | def add_trace(self, path, format_str): |
24a3136a | 158 | """ |
74ea15ad | 159 | Add a trace by path to the TraceCollection. |
24a3136a DS |
160 | |
161 | Open a trace. | |
162 | ||
163 | path is the path to the trace, it is not recursive. | |
164 | If "path" is None, stream_list is used instead as a list | |
165 | of mmap streams to open for the trace. | |
166 | ||
167 | format is a string containing the format name in which the trace was | |
168 | produced. | |
169 | ||
24a3136a DS |
170 | Return: the corresponding TraceHandle on success or None on error. |
171 | """ | |
464425e1 | 172 | ret = _bt_context_add_trace(self._tc, path, format_str, None, None, None) |
24a3136a DS |
173 | if ret < 0: |
174 | return None | |
175 | ||
176 | th = TraceHandle.__new__(TraceHandle) | |
177 | th._id = ret | |
464425e1 | 178 | th._trace_collection = self |
24a3136a DS |
179 | return th |
180 | ||
181 | def add_traces_recursive(self, path, format_str): | |
182 | """ | |
183 | Open a trace recursively. | |
184 | ||
185 | Find each trace present in the subdirectory starting from the given | |
74ea15ad | 186 | path, and add them to the TraceCollection. |
24a3136a DS |
187 | |
188 | Return a dict of TraceHandle instances (the full path is the key). | |
189 | Return None on error. | |
190 | """ | |
191 | ||
192 | import os | |
193 | ||
194 | trace_handles = {} | |
195 | ||
196 | noTrace = True | |
197 | error = False | |
198 | ||
199 | for fullpath, dirs, files in os.walk(path): | |
200 | if "metadata" in files: | |
201 | trace_handle = self.add_trace(fullpath, format_str) | |
202 | if trace_handle is None: | |
203 | error = True | |
204 | continue | |
205 | ||
206 | trace_handles[fullpath] = trace_handle | |
207 | noTrace = False | |
208 | ||
209 | if noTrace and error: | |
210 | return None | |
211 | return trace_handles | |
212 | ||
213 | def remove_trace(self, trace_handle): | |
214 | """ | |
74ea15ad | 215 | Remove a trace from the TraceCollection. |
24a3136a DS |
216 | Effectively closing the trace. |
217 | """ | |
218 | try: | |
74ea15ad | 219 | _bt_context_remove_trace(self._tc, trace_handle._id) |
24a3136a DS |
220 | except AttributeError: |
221 | raise TypeError("in remove_trace, " | |
222 | "argument 2 must be a TraceHandle instance") | |
74ea15ad JG |
223 | |
224 | @property | |
225 | def events(self): | |
226 | """ | |
227 | Generator function to iterate over the events of open in the current | |
228 | TraceCollection. | |
229 | """ | |
230 | begin_pos_ptr = _bt_iter_pos() | |
231 | end_pos_ptr = _bt_iter_pos() | |
232 | begin_pos_ptr.type = SEEK_BEGIN | |
233 | end_pos_ptr.type = SEEK_LAST | |
234 | ||
235 | for event in self._events(begin_pos_ptr, end_pos_ptr): | |
236 | yield event | |
237 | ||
238 | def events_timestamps(self, timestamp_begin, timestamp_end): | |
239 | """ | |
240 | Generator function to iterate over the events of open in the current | |
241 | TraceCollection from timestamp_begin to timestamp_end. | |
242 | """ | |
243 | begin_pos_ptr = _bt_iter_pos() | |
244 | end_pos_ptr = _bt_iter_pos() | |
245 | begin_pos_ptr.type = end_pos_ptr.type = SEEK_TIME | |
246 | begin_pos_ptr.u.seek_time = timestamp_begin | |
247 | end_pos_ptr.u.seek_time = timestamp_end | |
248 | ||
249 | for event in self._events(begin_pos_ptr, end_pos_ptr): | |
250 | yield event | |
251 | ||
252 | @property | |
253 | def timestamp_begin(self): | |
254 | pos_ptr = _bt_iter_pos() | |
255 | pos_ptr.type = SEEK_BEGIN | |
256 | return self._timestamp_at_pos(pos_ptr) | |
257 | ||
258 | @property | |
259 | def timestamp_end(self): | |
260 | pos_ptr = _bt_iter_pos() | |
261 | pos_ptr.type = SEEK_LAST | |
262 | return self._timestamp_at_pos(pos_ptr) | |
263 | ||
264 | def _timestamp_at_pos(self, pos_ptr): | |
265 | ctf_it_ptr = _bt_ctf_iter_create(self._tc, pos_ptr, pos_ptr) | |
266 | if ctf_it_ptr is None: | |
267 | raise NotImplementedError("Creation of multiple iterators is unsupported.") | |
268 | ev_ptr = _bt_ctf_iter_read_event(ctf_it_ptr) | |
269 | _bt_ctf_iter_destroy(ctf_it_ptr) | |
270 | if ev_ptr is None: | |
271 | return None; | |
272 | ||
273 | def _events(self, begin_pos_ptr, end_pos_ptr): | |
274 | ctf_it_ptr = _bt_ctf_iter_create(self._tc, begin_pos_ptr, end_pos_ptr) | |
275 | if ctf_it_ptr is None: | |
276 | raise NotImplementedError( | |
277 | "Creation of multiple iterators is unsupported.") | |
278 | ||
279 | while True: | |
280 | ev_ptr = _bt_ctf_iter_read_event(ctf_it_ptr) | |
281 | if ev_ptr is None: | |
282 | break | |
283 | ||
78d714e8 | 284 | ev = Event.__new__(Event) |
74ea15ad JG |
285 | ev._e = ev_ptr |
286 | try: | |
287 | yield ev | |
288 | except GeneratorExit: | |
289 | break | |
290 | ||
291 | ret = _bt_iter_next(_bt_ctf_get_iter(ctf_it_ptr)) | |
292 | if ret != 0: | |
293 | break | |
294 | ||
295 | _bt_ctf_iter_destroy(ctf_it_ptr) | |
296 | ||
24a3136a DS |
297 | %} |
298 | ||
299 | ||
300 | ||
301 | /* ================================================================= | |
302 | FORMAT.H, REGISTRY | |
303 | ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ | |
304 | */ | |
305 | ||
306 | %rename("lookup_format") bt_lookup_format(bt_intern_str qname); | |
307 | %rename("_bt_print_format_list") bt_fprintf_format_list(FILE *fp); | |
308 | %rename("register_format") bt_register_format(struct format *format); | |
cc26a15a | 309 | %rename("unregister_format") bt_unregister_format(struct bt_format *format); |
24a3136a DS |
310 | |
311 | extern struct format *bt_lookup_format(bt_intern_str qname); | |
312 | extern void bt_fprintf_format_list(FILE *fp); | |
2c0df204 | 313 | extern int bt_register_format(struct bt_format *format); |
cc26a15a | 314 | extern void bt_unregister_format(struct bt_format *format); |
24a3136a | 315 | |
24a3136a DS |
316 | %pythoncode %{ |
317 | ||
318 | def print_format_list(babeltrace_file): | |
319 | """ | |
320 | Print a list of available formats to file. | |
321 | ||
322 | babeltrace_file must be a File instance opened in write mode. | |
323 | """ | |
324 | try: | |
325 | if babeltrace_file._file is not None: | |
326 | _bt_print_format_list(babeltrace_file._file) | |
327 | except AttributeError: | |
328 | raise TypeError("in print_format_list, " | |
329 | "argument 1 must be a File instance") | |
330 | ||
331 | %} | |
332 | ||
333 | ||
334 | /* ================================================================= | |
335 | ITERATOR.H, ITERATOR-INTERNAL.H | |
336 | ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ | |
337 | */ | |
338 | ||
339 | %rename("_bt_iter_create") bt_iter_create(struct bt_context *ctx, | |
340 | const struct bt_iter_pos *begin_pos, const struct bt_iter_pos *end_pos); | |
341 | %rename("_bt_iter_destroy") bt_iter_destroy(struct bt_iter *iter); | |
342 | %rename("_bt_iter_next") bt_iter_next(struct bt_iter *iter); | |
343 | %rename("_bt_iter_get_pos") bt_iter_get_pos(struct bt_iter *iter); | |
344 | %rename("_bt_iter_free_pos") bt_iter_free_pos(struct bt_iter_pos *pos); | |
345 | %rename("_bt_iter_set_pos") bt_iter_set_pos(struct bt_iter *iter, | |
346 | const struct bt_iter_pos *pos); | |
347 | %rename("_bt_iter_create_time_pos") bt_iter_create_time_pos(struct bt_iter *iter, | |
348 | uint64_t timestamp); | |
349 | ||
350 | struct bt_iter *bt_iter_create(struct bt_context *ctx, | |
351 | const struct bt_iter_pos *begin_pos, const struct bt_iter_pos *end_pos); | |
352 | void bt_iter_destroy(struct bt_iter *iter); | |
353 | int bt_iter_next(struct bt_iter *iter); | |
354 | struct bt_iter_pos *bt_iter_get_pos(struct bt_iter *iter); | |
355 | void bt_iter_free_pos(struct bt_iter_pos *pos); | |
356 | int bt_iter_set_pos(struct bt_iter *iter, const struct bt_iter_pos *pos); | |
357 | struct bt_iter_pos *bt_iter_create_time_pos(struct bt_iter *iter, uint64_t timestamp); | |
358 | ||
359 | %rename("_bt_iter_pos") bt_iter_pos; | |
360 | %rename("SEEK_TIME") BT_SEEK_TIME; | |
361 | %rename("SEEK_RESTORE") BT_SEEK_RESTORE; | |
362 | %rename("SEEK_CUR") BT_SEEK_CUR; | |
363 | %rename("SEEK_BEGIN") BT_SEEK_BEGIN; | |
ef42f9eb | 364 | %rename("SEEK_LAST") BT_SEEK_LAST; |
24a3136a DS |
365 | |
366 | // This struct is taken from iterator.h | |
367 | // All changes to the struct must also be made here | |
368 | struct bt_iter_pos { | |
369 | enum { | |
370 | BT_SEEK_TIME, /* uses u.seek_time */ | |
371 | BT_SEEK_RESTORE, /* uses u.restore */ | |
372 | BT_SEEK_CUR, | |
373 | BT_SEEK_BEGIN, | |
ef42f9eb | 374 | BT_SEEK_LAST |
24a3136a DS |
375 | } type; |
376 | union { | |
377 | uint64_t seek_time; | |
378 | struct bt_saved_pos *restore; | |
379 | } u; | |
380 | }; | |
381 | ||
24a3136a DS |
382 | /* ================================================================= |
383 | TRACE-HANDLE.H, TRACE-HANDLE-INTERNAL.H | |
384 | ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ | |
385 | */ | |
386 | ||
387 | %rename("_bt_trace_handle_create") bt_trace_handle_create(struct bt_context *ctx); | |
388 | %rename("_bt_trace_handle_destroy") bt_trace_handle_destroy(struct bt_trace_handle *bt); | |
389 | struct bt_trace_handle *bt_trace_handle_create(struct bt_context *ctx); | |
390 | void bt_trace_handle_destroy(struct bt_trace_handle *bt); | |
391 | ||
392 | %rename("_bt_trace_handle_get_path") bt_trace_handle_get_path(struct bt_context *ctx, | |
393 | int handle_id); | |
394 | %rename("_bt_trace_handle_get_timestamp_begin") bt_trace_handle_get_timestamp_begin( | |
395 | struct bt_context *ctx, int handle_id, enum bt_clock_type type); | |
396 | %rename("_bt_trace_handle_get_timestamp_end") bt_trace_handle_get_timestamp_end( | |
397 | struct bt_context *ctx, int handle_id, enum bt_clock_type type); | |
24a3136a DS |
398 | const char *bt_trace_handle_get_path(struct bt_context *ctx, int handle_id); |
399 | uint64_t bt_trace_handle_get_timestamp_begin(struct bt_context *ctx, int handle_id, | |
400 | enum bt_clock_type type); | |
401 | uint64_t bt_trace_handle_get_timestamp_end(struct bt_context *ctx, int handle_id, | |
402 | enum bt_clock_type type); | |
403 | ||
404 | %rename("_bt_ctf_event_get_handle_id") bt_ctf_event_get_handle_id( | |
405 | const struct bt_ctf_event *event); | |
406 | int bt_ctf_event_get_handle_id(const struct bt_ctf_event *event); | |
407 | ||
408 | ||
409 | %pythoncode%{ | |
410 | ||
8a2cd19a | 411 | # Based on enum bt_clock_type in clock-type.h |
464425e1 JG |
412 | class ClockType: |
413 | CLOCK_CYCLES = 0 | |
414 | CLOCK_REAL = 1 | |
415 | ||
24a3136a DS |
416 | class TraceHandle(object): |
417 | """ | |
418 | The TraceHandle allows the user to manipulate a trace file directly. | |
419 | It is a unique identifier representing a trace file. | |
420 | Do not instantiate. | |
421 | """ | |
422 | ||
423 | def __init__(self): | |
424 | raise NotImplementedError("TraceHandle cannot be instantiated") | |
425 | ||
426 | def __repr__(self): | |
288209fb | 427 | return "Babeltrace TraceHandle: trace_id('{0}')".format(self._id) |
24a3136a | 428 | |
464425e1 JG |
429 | @property |
430 | def id(self): | |
24a3136a DS |
431 | """Return the TraceHandle id.""" |
432 | return self._id | |
433 | ||
464425e1 JG |
434 | @property |
435 | def path(self): | |
24a3136a | 436 | """Return the path of a TraceHandle.""" |
464425e1 | 437 | return _bt_trace_handle_get_path(self._trace_collection._tc, self._id) |
24a3136a | 438 | |
464425e1 JG |
439 | @property |
440 | def timestamp_begin(self): | |
24a3136a | 441 | """Return the creation time of the buffers of a trace.""" |
464425e1 JG |
442 | return _bt_trace_handle_get_timestamp_begin( |
443 | self._trace_collection._tc, self._id, ClockType.CLOCK_REAL) | |
24a3136a | 444 | |
464425e1 JG |
445 | @property |
446 | def timestamp_end(self): | |
24a3136a | 447 | """Return the destruction timestamp of the buffers of a trace.""" |
464425e1 JG |
448 | return _bt_trace_handle_get_timestamp_end( |
449 | self._trace_collection._tc, self._id, ClockType.CLOCK_REAL) | |
24a3136a | 450 | |
8bb27181 JG |
451 | @property |
452 | def events(self): | |
453 | """ | |
454 | Generator returning all events (EventDeclaration) in a trace. | |
455 | """ | |
456 | ret = _bt_python_event_decl_listcaller(self.id, self._trace_collection._tc) | |
457 | ||
458 | if not isinstance(ret, list): | |
459 | return | |
460 | ||
461 | ptr_list, count = ret | |
462 | for i in range(count): | |
463 | tmp = EventDeclaration.__new__(EventDeclaration) | |
464 | tmp._ed = _bt_python_decl_one_from_list(ptr_list, i) | |
465 | yield tmp | |
466 | ||
24a3136a DS |
467 | %} |
468 | ||
469 | ||
470 | ||
471 | // ================================================================= | |
472 | // CTF | |
473 | // ================================================================= | |
474 | ||
475 | /* ================================================================= | |
476 | ITERATOR.H, EVENTS.H | |
477 | ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ | |
478 | */ | |
479 | ||
480 | //Iterator | |
481 | %rename("_bt_ctf_iter_create") bt_ctf_iter_create(struct bt_context *ctx, | |
482 | const struct bt_iter_pos *begin_pos, | |
483 | const struct bt_iter_pos *end_pos); | |
484 | %rename("_bt_ctf_get_iter") bt_ctf_get_iter(struct bt_ctf_iter *iter); | |
485 | %rename("_bt_ctf_iter_destroy") bt_ctf_iter_destroy(struct bt_ctf_iter *iter); | |
486 | %rename("_bt_ctf_iter_read_event") bt_ctf_iter_read_event(struct bt_ctf_iter *iter); | |
487 | ||
488 | struct bt_ctf_iter *bt_ctf_iter_create(struct bt_context *ctx, | |
489 | const struct bt_iter_pos *begin_pos, | |
490 | const struct bt_iter_pos *end_pos); | |
491 | struct bt_iter *bt_ctf_get_iter(struct bt_ctf_iter *iter); | |
492 | void bt_ctf_iter_destroy(struct bt_ctf_iter *iter); | |
493 | struct bt_ctf_event *bt_ctf_iter_read_event(struct bt_ctf_iter *iter); | |
494 | ||
495 | ||
496 | //Events | |
24a3136a DS |
497 | %rename("_bt_ctf_get_top_level_scope") bt_ctf_get_top_level_scope(const struct |
498 | bt_ctf_event *event, enum bt_ctf_scope scope); | |
499 | %rename("_bt_ctf_event_name") bt_ctf_event_name(const struct bt_ctf_event *ctf_event); | |
500 | %rename("_bt_ctf_get_timestamp") bt_ctf_get_timestamp( | |
501 | const struct bt_ctf_event *ctf_event); | |
502 | %rename("_bt_ctf_get_cycles") bt_ctf_get_cycles( | |
503 | const struct bt_ctf_event *ctf_event); | |
504 | ||
505 | %rename("_bt_ctf_get_field") bt_ctf_get_field(const struct bt_ctf_event *ctf_event, | |
2c0df204 | 506 | const struct bt_definition *scope, const char *field); |
24a3136a | 507 | %rename("_bt_ctf_get_index") bt_ctf_get_index(const struct bt_ctf_event *ctf_event, |
2c0df204 XH |
508 | const struct bt_definition *field, unsigned int index); |
509 | %rename("_bt_ctf_field_name") bt_ctf_field_name(const struct bt_definition *field); | |
510 | %rename("_bt_ctf_field_type") bt_ctf_field_type(const struct bt_declaration *field); | |
24a3136a | 511 | %rename("_bt_ctf_get_int_signedness") bt_ctf_get_int_signedness( |
2c0df204 XH |
512 | const struct bt_declaration *field); |
513 | %rename("_bt_ctf_get_int_base") bt_ctf_get_int_base(const struct bt_declaration *field); | |
24a3136a | 514 | %rename("_bt_ctf_get_int_byte_order") bt_ctf_get_int_byte_order( |
2c0df204 XH |
515 | const struct bt_declaration *field); |
516 | %rename("_bt_ctf_get_int_len") bt_ctf_get_int_len(const struct bt_declaration *field); | |
4191bcd2 XH |
517 | %rename("_bt_ctf_get_enum_int") bt_ctf_get_enum_int(const struct bt_definition *field); |
518 | %rename("_bt_ctf_get_enum_str") bt_ctf_get_enum_str(const struct bt_definition *field); | |
2c0df204 XH |
519 | %rename("_bt_ctf_get_encoding") bt_ctf_get_encoding(const struct bt_declaration *field); |
520 | %rename("_bt_ctf_get_array_len") bt_ctf_get_array_len(const struct bt_declaration *field); | |
521 | %rename("_bt_ctf_get_uint64") bt_ctf_get_uint64(const struct bt_definition *field); | |
522 | %rename("_bt_ctf_get_int64") bt_ctf_get_int64(const struct bt_definition *field); | |
523 | %rename("_bt_ctf_get_char_array") bt_ctf_get_char_array(const struct bt_definition *field); | |
524 | %rename("_bt_ctf_get_string") bt_ctf_get_string(const struct bt_definition *field); | |
e5a73b90 | 525 | %rename("_bt_ctf_get_float") bt_ctf_get_float(const struct bt_definition *field); |
812e6682 | 526 | %rename("_bt_ctf_get_variant") bt_ctf_get_variant(const struct bt_definition *field); |
24a3136a DS |
527 | %rename("_bt_ctf_field_get_error") bt_ctf_field_get_error(void); |
528 | %rename("_bt_ctf_get_decl_event_name") bt_ctf_get_decl_event_name(const struct | |
529 | bt_ctf_event_decl *event); | |
78564612 AM |
530 | %rename("_bt_ctf_get_decl_event_id") bt_ctf_get_decl_event_id(const struct |
531 | bt_ctf_event_decl *event); | |
24a3136a DS |
532 | %rename("_bt_ctf_get_decl_field_name") bt_ctf_get_decl_field_name( |
533 | const struct bt_ctf_field_decl *field); | |
f01efa78 | 534 | %rename("_bt_ctf_get_decl_from_def") bt_ctf_get_decl_from_def( |
2c0df204 | 535 | const struct bt_definition *field); |
8bb27181 JG |
536 | %rename("_bt_ctf_get_decl_from_field_decl") bt_ctf_get_decl_from_field_decl( |
537 | const struct bt_ctf_field_decl *field); | |
3c2ce778 | 538 | %rename("_bt_array_index") bt_array_index(struct definition_array *array, uint64_t i); |
786207e0 XH |
539 | %rename("_bt_sequence_len") bt_sequence_len(struct definition_sequence *sequence); |
540 | %rename("_bt_sequence_index") bt_sequence_index(struct definition_sequence *sequence, uint64_t i); | |
3a068915 JG |
541 | %rename("_bt_ctf_get_struct_field_count") bt_ctf_get_struct_field_count(const struct bt_definition *structure); |
542 | %rename("_bt_ctf_get_struct_field_index") bt_ctf_get_struct_field_index(const struct bt_definition *structure, uint64_t i); | |
24a3136a | 543 | |
2c0df204 | 544 | const struct bt_definition *bt_ctf_get_top_level_scope(const struct bt_ctf_event *ctf_event, |
24a3136a DS |
545 | enum bt_ctf_scope scope); |
546 | const char *bt_ctf_event_name(const struct bt_ctf_event *ctf_event); | |
547 | uint64_t bt_ctf_get_timestamp(const struct bt_ctf_event *ctf_event); | |
548 | uint64_t bt_ctf_get_cycles(const struct bt_ctf_event *ctf_event); | |
2c0df204 XH |
549 | const struct bt_definition *bt_ctf_get_field(const struct bt_ctf_event *ctf_event, |
550 | const struct bt_definition *scope, | |
24a3136a | 551 | const char *field); |
2c0df204 XH |
552 | const struct bt_definition *bt_ctf_get_index(const struct bt_ctf_event *ctf_event, |
553 | const struct bt_definition *field, | |
24a3136a | 554 | unsigned int index); |
2c0df204 XH |
555 | const char *bt_ctf_field_name(const struct bt_definition *field); |
556 | enum ctf_type_id bt_ctf_field_type(const struct bt_declaration *field); | |
557 | int bt_ctf_get_int_signedness(const struct bt_declaration *field); | |
558 | int bt_ctf_get_int_base(const struct bt_declaration *field); | |
559 | int bt_ctf_get_int_byte_order(const struct bt_declaration *field); | |
560 | ssize_t bt_ctf_get_int_len(const struct bt_declaration *field); | |
4191bcd2 XH |
561 | const struct bt_definition *bt_ctf_get_enum_int(const struct bt_definition *field); |
562 | const char *bt_ctf_get_enum_str(const struct bt_definition *field); | |
2c0df204 XH |
563 | enum ctf_string_encoding bt_ctf_get_encoding(const struct bt_declaration *field); |
564 | int bt_ctf_get_array_len(const struct bt_declaration *field); | |
3c2ce778 | 565 | struct bt_definition *bt_array_index(struct definition_array *array, uint64_t i); |
2c0df204 XH |
566 | uint64_t bt_ctf_get_uint64(const struct bt_definition *field); |
567 | int64_t bt_ctf_get_int64(const struct bt_definition *field); | |
568 | char *bt_ctf_get_char_array(const struct bt_definition *field); | |
569 | char *bt_ctf_get_string(const struct bt_definition *field); | |
e5a73b90 | 570 | double bt_ctf_get_float(const struct bt_definition *field); |
812e6682 | 571 | const struct bt_definition *bt_ctf_get_variant(const struct bt_definition *field); |
24a3136a DS |
572 | int bt_ctf_field_get_error(void); |
573 | const char *bt_ctf_get_decl_event_name(const struct bt_ctf_event_decl *event); | |
78564612 | 574 | uint64_t bt_ctf_get_decl_event_id(const struct bt_ctf_event_decl *event); |
24a3136a | 575 | const char *bt_ctf_get_decl_field_name(const struct bt_ctf_field_decl *field); |
2c0df204 | 576 | const struct bt_declaration *bt_ctf_get_decl_from_def(const struct bt_definition *field); |
8bb27181 | 577 | const struct bt_declaration *bt_ctf_get_decl_from_field_decl(const struct bt_ctf_field_decl *field); |
786207e0 XH |
578 | uint64_t bt_sequence_len(struct definition_sequence *sequence); |
579 | struct bt_definition *bt_sequence_index(struct definition_sequence *sequence, uint64_t i); | |
3a068915 JG |
580 | uint64_t bt_ctf_get_struct_field_count(const struct bt_definition *structure); |
581 | const struct bt_definition *bt_ctf_get_struct_field_index(const struct bt_definition *structure, uint64_t i); | |
24a3136a DS |
582 | |
583 | %pythoncode%{ | |
584 | ||
24d5c942 JG |
585 | class CTFStringEncoding: |
586 | NONE = 0 | |
587 | UTF8 = 1 | |
588 | ASCII = 2 | |
589 | UNKNOWN = 3 | |
590 | ||
8bb27181 JG |
591 | # Based on the enum in ctf-writer/writer.h |
592 | class ByteOrder: | |
593 | BYTE_ORDER_NATIVE = 0 | |
594 | BYTE_ORDER_LITTLE_ENDIAN = 1 | |
595 | BYTE_ORDER_BIG_ENDIAN = 2 | |
596 | BYTE_ORDER_NETWORK = 3 | |
597 | BYTE_ORDER_UNKNOWN = 4 # Python-specific entry | |
598 | ||
24d5c942 JG |
599 | #enum equivalent, accessible constants |
600 | #These are taken directly from ctf/events.h | |
601 | #All changes to enums must also be made here | |
602 | class CTFTypeId: | |
603 | UNKNOWN = 0 | |
604 | INTEGER = 1 | |
605 | FLOAT = 2 | |
606 | ENUM = 3 | |
607 | STRING = 4 | |
608 | STRUCT = 5 | |
609 | UNTAGGED_VARIANT = 6 | |
610 | VARIANT = 7 | |
611 | ARRAY = 8 | |
612 | SEQUENCE = 9 | |
613 | NR_CTF_TYPES = 10 | |
8bb27181 JG |
614 | def type_name(id): |
615 | name = "UNKNOWN_TYPE" | |
24d5c942 JG |
616 | constants = [attr for attr in dir(CTFTypeId) if not callable(getattr(CTFTypeId, attr)) and not attr.startswith("__")] |
617 | for attr in constants: | |
618 | if getattr(CTFTypeId, attr) == id: | |
619 | name = attr | |
620 | break | |
621 | return name | |
622 | ||
8bb27181 | 623 | class CTFScope: |
78d714e8 JG |
624 | TRACE_PACKET_HEADER = 0 |
625 | STREAM_PACKET_CONTEXT = 1 | |
626 | STREAM_EVENT_HEADER = 2 | |
627 | STREAM_EVENT_CONTEXT = 3 | |
628 | EVENT_CONTEXT = 4 | |
629 | EVENT_FIELDS = 5 | |
630 | ||
8bb27181 JG |
631 | def scope_name(scope): |
632 | name = "UNKNOWN_SCOPE" | |
633 | constants = [attr for attr in dir(CTFScope) if not callable(getattr(CTFScope, attr)) and not attr.startswith("__")] | |
634 | for attr in constants: | |
635 | if getattr(CTFScope, attr) == scope: | |
636 | name = attr | |
637 | break | |
638 | return name | |
639 | ||
e404272a | 640 | # Priority of the scopes when searching for event fields |
8bb27181 JG |
641 | _scopes = [CTFScope.EVENT_FIELDS, CTFScope.EVENT_CONTEXT, CTFScope.STREAM_EVENT_CONTEXT, |
642 | CTFScope.STREAM_EVENT_HEADER, CTFScope.STREAM_PACKET_CONTEXT, CTFScope.TRACE_PACKET_HEADER] | |
e404272a | 643 | |
78d714e8 JG |
644 | import collections |
645 | class Event(collections.Mapping): | |
646 | """ | |
647 | This class represents an event from the trace. | |
648 | It is obtained using the TraceCollection generator functions. | |
649 | Do not instantiate. | |
650 | """ | |
78d714e8 JG |
651 | def __init__(self): |
652 | raise NotImplementedError("Event cannot be instantiated") | |
653 | ||
654 | @property | |
655 | def name(self): | |
656 | """Return the name of the event or None on error.""" | |
657 | return _bt_ctf_event_name(self._e) | |
658 | ||
659 | @property | |
660 | def cycles(self): | |
24a3136a | 661 | """ |
78d714e8 JG |
662 | Return the timestamp of the event as written in |
663 | the packet (in cycles) or -1ULL on error. | |
24a3136a | 664 | """ |
78d714e8 | 665 | return _bt_ctf_get_cycles(self._e) |
24a3136a | 666 | |
78d714e8 JG |
667 | @property |
668 | def timestamp(self): | |
669 | """ | |
670 | Return the timestamp of the event offset with the | |
671 | system clock source or -1ULL on error. | |
672 | """ | |
673 | return _bt_ctf_get_timestamp(self._e) | |
674 | ||
675 | def field_with_scope(self, field_name, scope): | |
676 | """ | |
677 | Get field_name's value in scope. | |
678 | None is returned if no field matches field_name. | |
679 | """ | |
e404272a | 680 | if not scope in _scopes: |
78d714e8 JG |
681 | raise ValueError("Invalid scope provided") |
682 | field = self._field_with_scope(field_name, scope) | |
683 | if field is not None: | |
684 | return field.value | |
685 | return None | |
686 | ||
687 | def field_list_with_scope(self, scope): | |
688 | """Return a list of field names in scope.""" | |
e404272a | 689 | if not scope in _scopes: |
78d714e8 JG |
690 | raise ValueError("Invalid scope provided") |
691 | field_names = [] | |
692 | for field in self._field_list_with_scope(scope): | |
693 | field_names.append(field.name) | |
694 | return field_names | |
695 | ||
696 | @property | |
697 | def handle(self): | |
698 | """ | |
699 | Get the TraceHandle associated with this event | |
700 | Return None on error | |
701 | """ | |
702 | ret = _bt_ctf_event_get_handle_id(self._e) | |
703 | if ret < 0: | |
786207e0 XH |
704 | return None |
705 | ||
78d714e8 JG |
706 | th = TraceHandle.__new__(TraceHandle) |
707 | th._id = ret | |
708 | th._trace_collection = self.get_trace_collection() | |
709 | return th | |
710 | ||
711 | @property | |
712 | def trace_collection(self): | |
713 | """ | |
714 | Get the TraceCollection associated with this event. | |
715 | Return None on error. | |
24a3136a | 716 | """ |
78d714e8 JG |
717 | trace_collection = TraceCollection() |
718 | trace_collection._tc = _bt_ctf_event_get_context(self._e); | |
719 | if trace_collection._tc is None: | |
720 | return None | |
721 | else: | |
722 | return trace_collection | |
723 | ||
724 | def __getitem__(self, field_name): | |
24a3136a | 725 | """ |
78d714e8 JG |
726 | Get field_name's value. If the field_name exists in multiple |
727 | scopes, the first field found is returned. The scopes are searched | |
728 | in the following order: | |
729 | 1) EVENT_FIELDS | |
730 | 2) EVENT_CONTEXT | |
731 | 3) STREAM_EVENT_CONTEXT | |
732 | 4) STREAM_EVENT_HEADER | |
733 | 5) STREAM_PACKET_CONTEXT | |
734 | 6) TRACE_PACKET_HEADER | |
735 | None is returned if no field matches field_name. | |
736 | ||
737 | Use field_with_scope() to explicitly access fields in a given | |
738 | scope. | |
739 | """ | |
740 | field = self._field(field_name) | |
741 | if field is not None: | |
742 | return field.value | |
743 | raise KeyError(field_name) | |
744 | ||
745 | def __iter__(self): | |
746 | for key in self.keys(): | |
747 | yield key | |
748 | ||
749 | def __len__(self): | |
750 | count = 0 | |
e404272a | 751 | for scope in _scopes: |
78d714e8 JG |
752 | scope_ptr = _bt_ctf_get_top_level_scope(self._e, scope) |
753 | ret = _bt_python_field_listcaller(self._e, scope_ptr) | |
754 | if isinstance(ret, list): | |
755 | count += ret[1] | |
756 | return count | |
757 | ||
758 | def __contains__(self, field_name): | |
759 | return self._field(field_name) is not None | |
760 | ||
761 | def keys(self): | |
762 | """Return a list of field names.""" | |
763 | field_names = set() | |
e404272a | 764 | for scope in _scopes: |
78d714e8 JG |
765 | for name in self.field_list_with_scope(scope): |
766 | field_names.add(name) | |
767 | return list(field_names) | |
768 | ||
769 | def get(self, field_name, default = None): | |
770 | field = self._field(field_name) | |
771 | if field is None: | |
772 | return default | |
773 | return field.value | |
774 | ||
775 | def items(self): | |
776 | for field in self.keys(): | |
777 | yield (field, self[field]) | |
778 | ||
779 | def _field_with_scope(self, field_name, scope): | |
780 | scope_ptr = _bt_ctf_get_top_level_scope(self._e, scope) | |
781 | if scope_ptr is None: | |
782 | return None | |
783 | ||
784 | definition_ptr = _bt_ctf_get_field(self._e, scope_ptr, field_name) | |
785 | if definition_ptr is None: | |
786 | return None | |
24a3136a | 787 | |
78d714e8 JG |
788 | field = _Definition(definition_ptr, scope) |
789 | return field | |
790 | ||
791 | def _field(self, field_name): | |
792 | field = None | |
e404272a | 793 | for scope in _scopes: |
78d714e8 JG |
794 | field = self._field_with_scope(field_name, scope) |
795 | if field is not None: | |
796 | break | |
797 | return field | |
798 | ||
799 | def _field_list_with_scope(self, scope): | |
800 | fields = [] | |
801 | scope_ptr = _bt_ctf_get_top_level_scope(self._e, scope) | |
802 | ||
803 | # Returns a list [list_ptr, count]. If list_ptr is NULL, SWIG will only | |
804 | # provide the "count" return value | |
805 | count = 0 | |
806 | list_ptr = None | |
807 | ret = _bt_python_field_listcaller(self._e, scope_ptr) | |
808 | if isinstance(ret, list): | |
809 | list_ptr, count = ret | |
810 | ||
811 | for i in range(count): | |
812 | definition_ptr = _bt_python_field_one_from_list(list_ptr, i) | |
813 | if definition_ptr is not None: | |
814 | definition = _Definition(definition_ptr, scope) | |
815 | fields.append(definition) | |
816 | return fields | |
817 | ||
818 | class FieldError(Exception): | |
819 | def __init__(self, value): | |
820 | self.value = value | |
821 | ||
822 | def __str__(self): | |
823 | return repr(self.value) | |
824 | ||
cb1fcc68 | 825 | class EventDeclaration(object): |
78d714e8 | 826 | """Event declaration class. Do not instantiate.""" |
78564612 | 827 | MAX_UINT64 = 0xFFFFFFFFFFFFFFFF |
78d714e8 JG |
828 | |
829 | def __init__(self): | |
cb1fcc68 | 830 | raise NotImplementedError("EventDeclaration cannot be instantiated") |
78d714e8 | 831 | |
cb1fcc68 JG |
832 | @property |
833 | def name(self): | |
78d714e8 | 834 | """Return the name of the event or None on error""" |
cb1fcc68 | 835 | return _bt_ctf_get_decl_event_name(self._ed) |
78d714e8 | 836 | |
78564612 AM |
837 | @property |
838 | def id(self): | |
839 | """Return the event-ID of the event or -1 on error""" | |
840 | id = _bt_ctf_get_decl_event_id(self._ed) | |
841 | if id == self.MAX_UINT64: | |
842 | id = -1 | |
843 | return id | |
844 | ||
8bb27181 JG |
845 | @property |
846 | def fields(self): | |
24a3136a | 847 | """ |
8bb27181 JG |
848 | Generator returning all FieldDeclarations of an event, going through |
849 | each scope in the following order: | |
850 | 1) EVENT_FIELDS | |
851 | 2) EVENT_CONTEXT | |
852 | 3) STREAM_EVENT_CONTEXT | |
853 | 4) STREAM_EVENT_HEADER | |
854 | 5) STREAM_PACKET_CONTEXT | |
855 | 6) TRACE_PACKET_HEADER | |
856 | """ | |
857 | for scope in _scopes: | |
858 | for declaration in self.fields_scope(scope): | |
859 | yield declaration | |
860 | ||
861 | def fields_scope(self, scope): | |
862 | """ | |
863 | Generator returning FieldDeclarations of the current event in scope. | |
24a3136a | 864 | """ |
cb1fcc68 | 865 | ret = _by_python_field_decl_listcaller(self._ed, scope) |
24a3136a | 866 | |
cb1fcc68 | 867 | if not isinstance(ret, list): |
8bb27181 | 868 | return |
24a3136a | 869 | |
cb1fcc68 | 870 | list_ptr, count = ret |
cb1fcc68 | 871 | for i in range(count): |
8bb27181 JG |
872 | field_declaration_ptr = _bt_python_field_decl_one_from_list(list_ptr, i) |
873 | if field_declaration_ptr is not None: | |
874 | declaration_ptr = _bt_ctf_get_decl_from_field_decl(field_declaration_ptr) | |
875 | field_declaration = _create_field_declaration(declaration_ptr, _bt_ctf_get_decl_field_name(field_declaration_ptr), scope) | |
876 | yield field_declaration | |
cb1fcc68 JG |
877 | |
878 | class FieldDeclaration(object): | |
879 | """Field declaration class. Do not instantiate.""" | |
78d714e8 | 880 | def __init__(self): |
cb1fcc68 | 881 | raise NotImplementedError("FieldDeclaration cannot be instantiated") |
78d714e8 | 882 | |
8bb27181 JG |
883 | def __repr__(self): |
884 | return "({0}) {1} {2}".format(CTFScope.scope_name(self.scope), CTFTypeId.type_name(self.type), self.name) | |
885 | ||
cb1fcc68 JG |
886 | @property |
887 | def name(self): | |
8bb27181 JG |
888 | """Return the name of a FieldDeclaration or None on error.""" |
889 | return self._name | |
890 | ||
891 | @property | |
892 | def type(self): | |
893 | """ | |
894 | Return the FieldDeclaration's type. One of the entries in class | |
895 | CTFTypeId. | |
896 | """ | |
897 | return _bt_ctf_field_type(self._fd) | |
898 | ||
899 | @property | |
900 | def scope(self): | |
901 | """ | |
902 | Return the FieldDeclaration's scope. | |
903 | """ | |
904 | return self._s | |
905 | ||
906 | class IntegerFieldDeclaration(FieldDeclaration): | |
907 | """Do not instantiate.""" | |
908 | def __init__(self): | |
909 | raise NotImplementedError("IntegerFieldDeclaration cannot be instantiated") | |
910 | ||
911 | @property | |
912 | def signedness(self): | |
913 | """ | |
914 | Return the signedness of an integer: | |
915 | 0 if unsigned; 1 if signed; -1 on error. | |
916 | """ | |
917 | return _bt_ctf_get_int_signedness(self._fd) | |
918 | ||
919 | @property | |
920 | def base(self): | |
921 | """Return the base of an int or a negative value on error.""" | |
922 | return _bt_ctf_get_int_base(self._fd) | |
923 | ||
924 | @property | |
925 | def byte_order(self): | |
926 | """ | |
927 | Return the byte order. One of class ByteOrder's entries. | |
928 | """ | |
929 | ret = _bt_ctf_get_int_byte_order(self._fd) | |
930 | if ret == 1234: | |
931 | return ByteOrder.BYTE_ORDER_LITTLE_ENDIAN | |
932 | elif ret == 4321: | |
933 | return ByteOrder.BYTE_ORDER_BIG_ENDIAN | |
934 | else: | |
935 | return ByteOrder.BYTE_ORDER_UNKNOWN | |
936 | ||
937 | @property | |
938 | def length(self): | |
939 | """ | |
940 | Return the size, in bits, of an int or a negative | |
941 | value on error. | |
942 | """ | |
943 | return _bt_ctf_get_int_len(self._fd) | |
944 | ||
945 | @property | |
946 | def encoding(self): | |
947 | """ | |
948 | Return the encoding. One of class CTFStringEncoding's entries. | |
949 | Return a negative value on error. | |
950 | """ | |
951 | return _bt_ctf_get_encoding(self._fd) | |
952 | ||
953 | class EnumerationFieldDeclaration(FieldDeclaration): | |
954 | """Do not instantiate.""" | |
955 | def __init__(self): | |
956 | raise NotImplementedError("EnumerationFieldDeclaration cannot be instantiated") | |
957 | ||
958 | class ArrayFieldDeclaration(FieldDeclaration): | |
959 | """Do not instantiate.""" | |
960 | def __init__(self): | |
961 | raise NotImplementedError("ArrayFieldDeclaration cannot be instantiated") | |
962 | ||
963 | @property | |
964 | def length(self): | |
965 | """ | |
966 | Return the length of an array or a negative | |
967 | value on error. | |
968 | """ | |
969 | return _bt_ctf_get_array_len(self._fd) | |
970 | ||
5792eb34 JG |
971 | @property |
972 | def element_declaration(self): | |
973 | """ | |
974 | Return element declaration. | |
975 | """ | |
976 | field_decl_ptr = _bt_python_get_array_element_declaration(self._fd) | |
977 | return _create_field_declaration(field_decl_ptr, "", self.scope) | |
978 | ||
8bb27181 JG |
979 | class SequenceFieldDeclaration(FieldDeclaration): |
980 | """Do not instantiate.""" | |
981 | def __init__(self): | |
982 | raise NotImplementedError("SequenceFieldDeclaration cannot be instantiated") | |
983 | ||
3866c850 JG |
984 | @property |
985 | def element_declaration(self): | |
986 | """ | |
987 | Return element declaration. | |
988 | """ | |
989 | field_decl_ptr = _bt_python_get_sequence_element_declaration(self._fd) | |
990 | return _create_field_declaration(field_decl_ptr, "", self.scope) | |
991 | ||
8bb27181 JG |
992 | class FloatFieldDeclaration(FieldDeclaration): |
993 | """Do not instantiate.""" | |
994 | def __init__(self): | |
995 | raise NotImplementedError("FloatFieldDeclaration cannot be instantiated") | |
996 | ||
997 | class StructureFieldDeclaration(FieldDeclaration): | |
998 | """Do not instantiate.""" | |
999 | def __init__(self): | |
1000 | raise NotImplementedError("StructureFieldDeclaration cannot be instantiated") | |
1001 | ||
1002 | class StringFieldDeclaration(FieldDeclaration): | |
1003 | """Do not instantiate.""" | |
1004 | def __init__(self): | |
1005 | raise NotImplementedError("StringFieldDeclaration cannot be instantiated") | |
1006 | ||
1007 | class VariantFieldDeclaration(FieldDeclaration): | |
1008 | """Do not instantiate.""" | |
1009 | def __init__(self): | |
1010 | raise NotImplementedError("VariantFieldDeclaration cannot be instantiated") | |
78d714e8 JG |
1011 | |
1012 | def field_error(): | |
1013 | """ | |
1014 | Return the last error code encountered while | |
1015 | accessing a field and reset the error flag. | |
1016 | Return 0 if no error, a negative value otherwise. | |
1017 | """ | |
1018 | return _bt_ctf_field_get_error() | |
1019 | ||
8bb27181 | 1020 | def _create_field_declaration(declaration_ptr, name, scope): |
78d714e8 | 1021 | """ |
8bb27181 | 1022 | Private field declaration factory. |
78d714e8 | 1023 | """ |
8bb27181 JG |
1024 | if declaration_ptr is None: |
1025 | raise ValueError("declaration_ptr must be valid") | |
1026 | if not scope in _scopes: | |
1027 | raise ValueError("Invalid scope provided") | |
1028 | ||
1029 | type = _bt_ctf_field_type(declaration_ptr) | |
1030 | declaration = None | |
1031 | if type == CTFTypeId.INTEGER: | |
1032 | declaration = IntegerFieldDeclaration.__new__(IntegerFieldDeclaration) | |
1033 | elif type == CTFTypeId.ENUM: | |
1034 | declaration = EnumerationFieldDeclaration.__new__(EnumerationFieldDeclaration) | |
1035 | elif type == CTFTypeId.ARRAY: | |
1036 | declaration = ArrayFieldDeclaration.__new__(ArrayFieldDeclaration) | |
1037 | elif type == CTFTypeId.SEQUENCE: | |
1038 | declaration = SequenceFieldDeclaration.__new__(SequenceFieldDeclaration) | |
1039 | elif type == CTFTypeId.FLOAT: | |
1040 | declaration = FloatFieldDeclaration.__new__(FloatFieldDeclaration) | |
1041 | elif type == CTFTypeId.STRUCT: | |
1042 | declaration = StructureFieldDeclaration.__new__(StructureFieldDeclaration) | |
1043 | elif type == CTFTypeId.STRING: | |
1044 | declaration = StringFieldDeclaration.__new__(StringFieldDeclaration) | |
1045 | elif type == CTFTypeId.VARIANT: | |
1046 | declaration = VariantFieldDeclaration.__new__(VariantFieldDeclaration) | |
1047 | else: | |
1048 | return declaration | |
1049 | ||
1050 | declaration._fd = declaration_ptr | |
1051 | declaration._s = scope | |
1052 | declaration._name = name | |
1053 | return declaration | |
78d714e8 JG |
1054 | |
1055 | class _Definition(object): | |
1056 | def __init__(self, definition_ptr, scope): | |
1057 | self._d = definition_ptr | |
1058 | self._s = scope | |
e404272a | 1059 | if not scope in _scopes: |
78d714e8 JG |
1060 | ValueError("Invalid scope provided") |
1061 | ||
78d714e8 JG |
1062 | @property |
1063 | def name(self): | |
1064 | """Return the name of a field or None on error.""" | |
1065 | return _bt_ctf_field_name(self._d) | |
1066 | ||
5792eb34 | 1067 | @property |
78d714e8 JG |
1068 | def type(self): |
1069 | """Return the type of a field or -1 if unknown.""" | |
1070 | return _bt_ctf_field_type(_bt_ctf_get_decl_from_def(self._d)) | |
1071 | ||
8bb27181 JG |
1072 | @property |
1073 | def declaration(self): | |
1074 | """Return the associated Definition object.""" | |
1075 | return _create_field_declaration(_bt_ctf_get_decl_from_def(self._d), self.name, self.scope) | |
78d714e8 | 1076 | |
8bb27181 | 1077 | def _get_enum_str(self): |
78d714e8 JG |
1078 | """ |
1079 | Return the string matching the current enumeration. | |
1080 | Return None on error. | |
1081 | """ | |
1082 | return _bt_ctf_get_enum_str(self._d) | |
1083 | ||
8bb27181 | 1084 | def _get_array_element_at(self, index): |
78d714e8 JG |
1085 | """ |
1086 | Return the array's element at position index. | |
1087 | Return None on error | |
1088 | """ | |
1089 | array_ptr = _bt_python_get_array_from_def(self._d) | |
1090 | if array_ptr is None: | |
1091 | return None | |
1092 | ||
1093 | definition_ptr = _bt_array_index(array_ptr, index) | |
1094 | if definition_ptr is None: | |
1095 | return None | |
1096 | return _Definition(definition_ptr, self.scope) | |
1097 | ||
8bb27181 | 1098 | def _get_sequence_len(self): |
78d714e8 JG |
1099 | """ |
1100 | Return the len of a sequence or a negative | |
1101 | value on error. | |
1102 | """ | |
1103 | seq = _bt_python_get_sequence_from_def(self._d) | |
1104 | return _bt_sequence_len(seq) | |
1105 | ||
8bb27181 | 1106 | def _get_sequence_element_at(self, index): |
78d714e8 JG |
1107 | """ |
1108 | Return the sequence's element at position index, | |
1109 | otherwise return None | |
1110 | """ | |
1111 | seq = _bt_python_get_sequence_from_def(self._d) | |
1112 | if seq is not None: | |
1113 | definition_ptr = _bt_sequence_index(seq, index) | |
1114 | if definition_ptr is not None: | |
1115 | return _Definition(definition_ptr, self.scope) | |
1116 | return None | |
1117 | ||
8bb27181 | 1118 | def _get_uint64(self): |
78d714e8 JG |
1119 | """ |
1120 | Return the value associated with the field. | |
1121 | If the field does not exist or is not of the type requested, | |
1122 | the value returned is undefined. To check if an error occured, | |
1123 | use the field_error() function after accessing a field. | |
1124 | """ | |
1125 | return _bt_ctf_get_uint64(self._d) | |
1126 | ||
8bb27181 | 1127 | def _get_int64(self): |
78d714e8 JG |
1128 | """ |
1129 | Return the value associated with the field. | |
1130 | If the field does not exist or is not of the type requested, | |
1131 | the value returned is undefined. To check if an error occured, | |
1132 | use the field_error() function after accessing a field. | |
1133 | """ | |
1134 | return _bt_ctf_get_int64(self._d) | |
1135 | ||
8bb27181 | 1136 | def _get_char_array(self): |
78d714e8 JG |
1137 | """ |
1138 | Return the value associated with the field. | |
1139 | If the field does not exist or is not of the type requested, | |
1140 | the value returned is undefined. To check if an error occurred, | |
1141 | use the field_error() function after accessing a field. | |
1142 | """ | |
1143 | return _bt_ctf_get_char_array(self._d) | |
1144 | ||
8bb27181 | 1145 | def _get_str(self): |
78d714e8 JG |
1146 | """ |
1147 | Return the value associated with the field. | |
1148 | If the field does not exist or is not of the type requested, | |
1149 | the value returned is undefined. To check if an error occurred, | |
1150 | use the field_error() function after accessing a field. | |
1151 | """ | |
1152 | return _bt_ctf_get_string(self._d) | |
1153 | ||
8bb27181 | 1154 | def _get_float(self): |
78d714e8 JG |
1155 | """ |
1156 | Return the value associated with the field. | |
1157 | If the field does not exist or is not of the type requested, | |
1158 | the value returned is undefined. To check if an error occurred, | |
1159 | use the field_error() function after accessing a field. | |
1160 | """ | |
1161 | return _bt_ctf_get_float(self._d) | |
1162 | ||
8bb27181 | 1163 | def _get_variant(self): |
78d714e8 JG |
1164 | """ |
1165 | Return the variant's selected field. | |
1166 | If the field does not exist or is not of the type requested, | |
1167 | the value returned is undefined. To check if an error occurred, | |
1168 | use the field_error() function after accessing a field. | |
1169 | """ | |
1170 | return _bt_ctf_get_variant(self._d) | |
1171 | ||
8bb27181 | 1172 | def _get_struct_field_count(self): |
78d714e8 JG |
1173 | """ |
1174 | Return the number of fields contained in the structure. | |
1175 | If the field does not exist or is not of the type requested, | |
1176 | the value returned is undefined. | |
1177 | """ | |
1178 | return _bt_ctf_get_struct_field_count(self._d) | |
1179 | ||
8bb27181 | 1180 | def _get_struct_field_at(self, i): |
78d714e8 JG |
1181 | """ |
1182 | Return the structure's field at position i. | |
1183 | If the field does not exist or is not of the type requested, | |
1184 | the value returned is undefined. To check if an error occurred, | |
1185 | use the field_error() function after accessing a field. | |
1186 | """ | |
1187 | return _bt_ctf_get_struct_field_index(self._d, i) | |
1188 | ||
1189 | @property | |
1190 | def value(self): | |
1191 | """ | |
1192 | Return the value associated with the field according to its type. | |
1193 | Return None on error. | |
1194 | """ | |
1195 | id = self.type | |
1196 | value = None | |
5792eb34 | 1197 | |
78d714e8 | 1198 | if id == CTFTypeId.STRING: |
8bb27181 | 1199 | value = self._get_str() |
78d714e8 | 1200 | elif id == CTFTypeId.ARRAY: |
5792eb34 JG |
1201 | element_decl = self.declaration.element_declaration |
1202 | if ((element_decl.type == CTFTypeId.INTEGER | |
1203 | and element_decl.length == 8) | |
1204 | and (element_decl.encoding == CTFStringEncoding.ASCII or element_decl.encoding == CTFStringEncoding.UTF8)): | |
1205 | value = _bt_python_get_array_string(self._d) | |
1206 | else: | |
1207 | value = [] | |
1208 | for i in range(self.declaration.length): | |
1209 | element = self._get_array_element_at(i) | |
1210 | value.append(element.value) | |
78d714e8 | 1211 | elif id == CTFTypeId.INTEGER: |
8bb27181 JG |
1212 | if self.declaration.signedness == 0: |
1213 | value = self._get_uint64() | |
78d714e8 | 1214 | else: |
8bb27181 | 1215 | value = self._get_int64() |
78d714e8 | 1216 | elif id == CTFTypeId.ENUM: |
8bb27181 | 1217 | value = self._get_enum_str() |
78d714e8 | 1218 | elif id == CTFTypeId.SEQUENCE: |
3866c850 JG |
1219 | element_decl = self.declaration.element_declaration |
1220 | if ((element_decl.type == CTFTypeId.INTEGER | |
1221 | and element_decl.length == 8) | |
1222 | and (element_decl.encoding == CTFStringEncoding.ASCII or element_decl.encoding == CTFStringEncoding.UTF8)): | |
1223 | value = _bt_python_get_sequence_string(self._d) | |
1224 | else: | |
1225 | seq_len = self._get_sequence_len() | |
1226 | value = [] | |
1227 | for i in range(seq_len): | |
1228 | evDef = self._get_sequence_element_at(i) | |
1229 | value.append(evDef.value) | |
78d714e8 | 1230 | elif id == CTFTypeId.FLOAT: |
8bb27181 | 1231 | value = self._get_float() |
78d714e8 | 1232 | elif id == CTFTypeId.VARIANT: |
8bb27181 JG |
1233 | variant = _Definition.__new__(_Definition) |
1234 | variant._d = self._get_variant(); | |
78d714e8 JG |
1235 | value = variant.value |
1236 | elif id == CTFTypeId.STRUCT: | |
1237 | value = {} | |
8bb27181 JG |
1238 | for i in range(self._get_struct_field_count()): |
1239 | member = _Definition(self._get_struct_field_at(i), self.scope) | |
78d714e8 JG |
1240 | value[member.name] = member.value |
1241 | ||
1242 | if field_error(): | |
5792eb34 | 1243 | raise FieldError("Error occurred while accessing field {} of type {}".format(self.name, CTFTypeId.type_name(id))) |
78d714e8 JG |
1244 | return value |
1245 | ||
1246 | @property | |
1247 | def scope(self): | |
1248 | """Return the scope of a field or None on error.""" | |
1249 | return self._s | |
1250 | ||
24a3136a DS |
1251 | %} |
1252 | ||
1253 | ||
ec8c88d7 JG |
1254 | // ================================================================= |
1255 | // CTF Writer | |
1256 | // ================================================================= | |
1257 | ||
1258 | /* ================================================================= | |
1259 | CLOCK.H | |
1260 | ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ | |
1261 | */ | |
1262 | %rename("_bt_ctf_clock_create") bt_ctf_clock_create(const char *name); | |
b0bb560c JG |
1263 | %rename("_bt_ctf_clock_get_name") bt_ctf_clock_get_name(struct bt_ctf_clock *clock); |
1264 | %rename("_bt_ctf_clock_get_description") bt_ctf_clock_get_description(struct bt_ctf_clock *clock); | |
ec8c88d7 | 1265 | %rename("_bt_ctf_clock_set_description") bt_ctf_clock_set_description(struct bt_ctf_clock *clock, const char *desc); |
b0bb560c | 1266 | %rename("_bt_ctf_clock_get_frequency") bt_ctf_clock_get_frequency(struct bt_ctf_clock *clock); |
ec8c88d7 | 1267 | %rename("_bt_ctf_clock_set_frequency") bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock, uint64_t freq); |
b0bb560c | 1268 | %rename("_bt_ctf_clock_get_precision") bt_ctf_clock_get_precision(struct bt_ctf_clock *clock); |
ec8c88d7 | 1269 | %rename("_bt_ctf_clock_set_precision") bt_ctf_clock_set_precision(struct bt_ctf_clock *clock, uint64_t precision); |
b0bb560c | 1270 | %rename("_bt_ctf_clock_get_offset_s") bt_ctf_clock_get_offset_s(struct bt_ctf_clock *clock); |
ec8c88d7 | 1271 | %rename("_bt_ctf_clock_set_offset_s") bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, uint64_t offset_s); |
b0bb560c | 1272 | %rename("_bt_ctf_clock_get_offset") bt_ctf_clock_get_offset(struct bt_ctf_clock *clock); |
ec8c88d7 | 1273 | %rename("_bt_ctf_clock_set_offset") bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, uint64_t offset); |
b0bb560c | 1274 | %rename("_bt_ctf_clock_get_is_absolute") bt_ctf_clock_get_is_absolute(struct bt_ctf_clock *clock); |
ec8c88d7 | 1275 | %rename("_bt_ctf_clock_set_is_absolute") bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock, int is_absolute); |
b0bb560c | 1276 | %rename("_bt_ctf_clock_get_time") bt_ctf_clock_get_time(struct bt_ctf_clock *clock); |
ec8c88d7 JG |
1277 | %rename("_bt_ctf_clock_set_time") bt_ctf_clock_set_time(struct bt_ctf_clock *clock, uint64_t time); |
1278 | %rename("_bt_ctf_clock_get") bt_ctf_clock_get(struct bt_ctf_clock *clock); | |
1279 | %rename("_bt_ctf_clock_put") bt_ctf_clock_put(struct bt_ctf_clock *clock); | |
1280 | ||
1281 | struct bt_ctf_clock *bt_ctf_clock_create(const char *name); | |
b0bb560c JG |
1282 | const char *bt_ctf_clock_get_name(struct bt_ctf_clock *clock); |
1283 | const char *bt_ctf_clock_get_description(struct bt_ctf_clock *clock); | |
ec8c88d7 | 1284 | int bt_ctf_clock_set_description(struct bt_ctf_clock *clock, const char *desc); |
b0bb560c | 1285 | uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock *clock); |
ec8c88d7 | 1286 | int bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock, uint64_t freq); |
b0bb560c | 1287 | uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock *clock); |
ec8c88d7 | 1288 | int bt_ctf_clock_set_precision(struct bt_ctf_clock *clock, uint64_t precision); |
b0bb560c | 1289 | uint64_t bt_ctf_clock_get_offset_s(struct bt_ctf_clock *clock); |
ec8c88d7 | 1290 | int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock, uint64_t offset_s); |
b0bb560c | 1291 | uint64_t bt_ctf_clock_get_offset(struct bt_ctf_clock *clock); |
ec8c88d7 | 1292 | int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock, uint64_t offset); |
b0bb560c | 1293 | int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock *clock); |
ec8c88d7 | 1294 | int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock, int is_absolute); |
b0bb560c | 1295 | uint64_t bt_ctf_clock_get_time(struct bt_ctf_clock *clock); |
ec8c88d7 JG |
1296 | int bt_ctf_clock_set_time(struct bt_ctf_clock *clock, uint64_t time); |
1297 | void bt_ctf_clock_get(struct bt_ctf_clock *clock); | |
1298 | void bt_ctf_clock_put(struct bt_ctf_clock *clock); | |
1299 | ||
1300 | /* ================================================================= | |
1301 | EVENT-TYPES.H | |
1302 | ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ | |
1303 | */ | |
1304 | %rename("_bt_ctf_field_type_integer_create") bt_ctf_field_type_integer_create(unsigned int size); | |
b4b5e4b5 JG |
1305 | %rename("_bt_ctf_field_type_integer_get_size") bt_ctf_field_type_integer_get_size(struct bt_ctf_field_type *integer); |
1306 | %rename("_bt_ctf_field_type_integer_get_signed") bt_ctf_field_type_integer_get_signed(struct bt_ctf_field_type *integer); | |
ec8c88d7 | 1307 | %rename("_bt_ctf_field_type_integer_set_signed") bt_ctf_field_type_integer_set_signed(struct bt_ctf_field_type *integer, int is_signed); |
b4b5e4b5 | 1308 | %rename("_bt_ctf_field_type_integer_get_base") bt_ctf_field_type_integer_get_base(struct bt_ctf_field_type *integer); |
ec8c88d7 | 1309 | %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); |
b4b5e4b5 | 1310 | %rename("_bt_ctf_field_type_integer_get_encoding") bt_ctf_field_type_integer_get_encoding(struct bt_ctf_field_type *integer); |
ec8c88d7 JG |
1311 | %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); |
1312 | %rename("_bt_ctf_field_type_enumeration_create") bt_ctf_field_type_enumeration_create(struct bt_ctf_field_type *integer_container_type); | |
b4b5e4b5 JG |
1313 | %rename("_bt_ctf_field_type_enumeration_get_container_type") bt_ctf_field_type_enumeration_get_container_type(struct bt_ctf_field_type *enumeration); |
1314 | %rename("_bt_ctf_field_type_enumeration_add_mapping") bt_ctf_field_type_enumeration_add_mapping(struct bt_ctf_field_type *enumeration, const char *name, int64_t range_start, int64_t range_end); | |
1315 | %rename("_bt_ctf_field_type_enumeration_add_mapping_unsigned") bt_ctf_field_type_enumeration_add_mapping_unsigned(struct bt_ctf_field_type *enumeration, const char *name, uint64_t range_start, uint64_t range_end); | |
1316 | %rename("_bt_ctf_field_type_enumeration_get_mapping_count") bt_ctf_field_type_enumeration_get_mapping_count(struct bt_ctf_field_type *enumeration); | |
1317 | %rename("_bt_ctf_field_type_enumeration_get_mapping") bt_ctf_field_type_enumeration_get_mapping(struct bt_ctf_field_type *enumeration, size_t index, const char **name, int64_t *range_start, int64_t *range_end); | |
1318 | %rename("_bt_ctf_field_type_enumeration_get_mapping_unsigned") bt_ctf_field_type_enumeration_get_mapping_unsigned(struct bt_ctf_field_type *enumeration, size_t index, const char **name, uint64_t *range_start, uint64_t *range_end); | |
1319 | %rename("_bt_ctf_field_type_enumeration_get_mapping_index_by_name") bt_ctf_field_type_enumeration_get_mapping_index_by_name(struct bt_ctf_field_type *enumeration, const char *name, size_t *index); | |
1320 | %rename("_bt_ctf_field_type_enumeration_get_mapping_index_by_value") bt_ctf_field_type_enumeration_get_mapping_index_by_value(struct bt_ctf_field_type *enumeration, int64_t value, size_t *index); | |
1321 | %rename("_bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value") bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value(struct bt_ctf_field_type *enumeration, uint64_t value, size_t *index); | |
ec8c88d7 | 1322 | %rename("_bt_ctf_field_type_floating_point_create") bt_ctf_field_type_floating_point_create(void); |
b4b5e4b5 | 1323 | %rename("_bt_ctf_field_type_floating_point_get_exponent_digits") bt_ctf_field_type_floating_point_get_exponent_digits(struct bt_ctf_field_type *floating_point); |
ec8c88d7 | 1324 | %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); |
b4b5e4b5 | 1325 | %rename("_bt_ctf_field_type_floating_point_get_mantissa_digits") bt_ctf_field_type_floating_point_get_mantissa_digits(struct bt_ctf_field_type *floating_point); |
ec8c88d7 JG |
1326 | %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); |
1327 | %rename("_bt_ctf_field_type_structure_create") bt_ctf_field_type_structure_create(void); | |
1328 | %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); | |
b4b5e4b5 JG |
1329 | %rename("_bt_ctf_field_type_structure_get_field_count") bt_ctf_field_type_structure_get_field_count(struct bt_ctf_field_type *structure); |
1330 | %rename("_bt_ctf_field_type_structure_get_field") bt_ctf_field_type_structure_get_field(struct bt_ctf_field_type *structure, const char **field_name, struct bt_ctf_field_type **field_type, size_t index); | |
1331 | %rename("_bt_ctf_field_type_structure_get_field_type_by_name") bt_ctf_field_type_structure_get_field_type_by_name(struct bt_ctf_field_type *structure, const char *field_name); | |
ec8c88d7 | 1332 | %rename("_bt_ctf_field_type_variant_create") bt_ctf_field_type_variant_create(struct bt_ctf_field_type *enum_tag, const char *tag_name); |
b4b5e4b5 JG |
1333 | %rename("_bt_ctf_field_type_variant_get_tag_type") bt_ctf_field_type_variant_get_tag_type(struct bt_ctf_field_type *variant); |
1334 | %rename("_bt_ctf_field_type_variant_get_tag_name") bt_ctf_field_type_variant_get_tag_name(struct bt_ctf_field_type *variant); | |
ec8c88d7 | 1335 | %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); |
b4b5e4b5 JG |
1336 | %rename("_bt_ctf_field_type_variant_get_field_type_by_name") bt_ctf_field_type_variant_get_field_type_by_name(struct bt_ctf_field_type *variant, const char *field_name); |
1337 | %rename("_bt_ctf_field_type_variant_get_field_type_from_tag") bt_ctf_field_type_variant_get_field_type_from_tag(struct bt_ctf_field_type *variant, struct bt_ctf_field *tag); | |
1338 | %rename("_bt_ctf_field_type_variant_get_field_count") bt_ctf_field_type_variant_get_field_count(struct bt_ctf_field_type *variant); | |
1339 | %rename("_bt_ctf_field_type_variant_get_field") bt_ctf_field_type_variant_get_field(struct bt_ctf_field_type *variant, const char **field_name, struct bt_ctf_field_type **field_type, size_t index); | |
ec8c88d7 | 1340 | %rename("_bt_ctf_field_type_array_create") bt_ctf_field_type_array_create(struct bt_ctf_field_type *element_type, unsigned int length); |
b4b5e4b5 JG |
1341 | %rename("_bt_ctf_field_type_array_get_element_type") bt_ctf_field_type_array_get_element_type(struct bt_ctf_field_type *array); |
1342 | %rename("_bt_ctf_field_type_array_get_length") bt_ctf_field_type_array_get_length(struct bt_ctf_field_type *array); | |
ec8c88d7 | 1343 | %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); |
b4b5e4b5 JG |
1344 | %rename("_bt_ctf_field_type_sequence_get_element_type") bt_ctf_field_type_sequence_get_element_type(struct bt_ctf_field_type *sequence); |
1345 | %rename("_bt_ctf_field_type_sequence_get_length_field_name") bt_ctf_field_type_sequence_get_length_field_name(struct bt_ctf_field_type *sequence); | |
ec8c88d7 | 1346 | %rename("_bt_ctf_field_type_string_create") bt_ctf_field_type_string_create(void); |
b4b5e4b5 JG |
1347 | %rename("_bt_ctf_field_type_string_get_encoding") bt_ctf_field_type_string_get_encoding(struct bt_ctf_field_type *string_type); |
1348 | %rename("_bt_ctf_field_type_string_set_encoding") bt_ctf_field_type_string_set_encoding(struct bt_ctf_field_type *string_type, enum ctf_string_encoding encoding); | |
1349 | %rename("_bt_ctf_field_type_get_alignment") bt_ctf_field_type_get_alignment(struct bt_ctf_field_type *type); | |
ec8c88d7 | 1350 | %rename("_bt_ctf_field_type_set_alignment") bt_ctf_field_type_set_alignment(struct bt_ctf_field_type *type, unsigned int alignment); |
b4b5e4b5 | 1351 | %rename("_bt_ctf_field_type_get_byte_order") bt_ctf_field_type_get_byte_order(struct bt_ctf_field_type *type); |
ec8c88d7 | 1352 | %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); |
b4b5e4b5 | 1353 | %rename("_bt_ctf_field_type_get_type_id") bt_ctf_field_type_get_type_id(struct bt_ctf_field_type *type); |
ec8c88d7 JG |
1354 | %rename("_bt_ctf_field_type_get") bt_ctf_field_type_get(struct bt_ctf_field_type *type); |
1355 | %rename("_bt_ctf_field_type_put") bt_ctf_field_type_put(struct bt_ctf_field_type *type); | |
1356 | ||
1357 | struct bt_ctf_field_type *bt_ctf_field_type_integer_create(unsigned int size); | |
b4b5e4b5 JG |
1358 | int bt_ctf_field_type_integer_get_size(struct bt_ctf_field_type *integer); |
1359 | int bt_ctf_field_type_integer_get_signed(struct bt_ctf_field_type *integer); | |
ec8c88d7 | 1360 | int bt_ctf_field_type_integer_set_signed(struct bt_ctf_field_type *integer, int is_signed); |
b4b5e4b5 | 1361 | enum bt_ctf_integer_base bt_ctf_field_type_integer_get_base(struct bt_ctf_field_type *integer); |
ec8c88d7 | 1362 | int bt_ctf_field_type_integer_set_base(struct bt_ctf_field_type *integer, enum bt_ctf_integer_base base); |
b4b5e4b5 | 1363 | enum ctf_string_encoding bt_ctf_field_type_integer_get_encoding(struct bt_ctf_field_type *integer); |
ec8c88d7 JG |
1364 | int bt_ctf_field_type_integer_set_encoding(struct bt_ctf_field_type *integer, enum ctf_string_encoding encoding); |
1365 | struct bt_ctf_field_type *bt_ctf_field_type_enumeration_create(struct bt_ctf_field_type *integer_container_type); | |
b4b5e4b5 JG |
1366 | struct bt_ctf_field_type *bt_ctf_field_type_enumeration_get_container_type(struct bt_ctf_field_type *enumeration); |
1367 | int bt_ctf_field_type_enumeration_add_mapping(struct bt_ctf_field_type *enumeration, const char *name, int64_t range_start, int64_t range_end); | |
1368 | int bt_ctf_field_type_enumeration_add_mapping_unsigned(struct bt_ctf_field_type *enumeration, const char *name, uint64_t range_start, uint64_t range_end); | |
1369 | int64_t bt_ctf_field_type_enumeration_get_mapping_count(struct bt_ctf_field_type *enumeration); | |
1370 | int bt_ctf_field_type_enumeration_get_mapping(struct bt_ctf_field_type *enumeration, size_t index, const char **OUTPUT, int64_t *OUTPUT, int64_t *OUTPUT); | |
1371 | int bt_ctf_field_type_enumeration_get_mapping_unsigned(struct bt_ctf_field_type *enumeration, size_t index, const char **OUTPUT, uint64_t *OUTPUT, uint64_t *OUTPUT); | |
1372 | int bt_ctf_field_type_enumeration_get_mapping_index_by_name(struct bt_ctf_field_type *enumeration, const char *name, size_t *OUTPUT); | |
1373 | int bt_ctf_field_type_enumeration_get_mapping_index_by_value(struct bt_ctf_field_type *enumeration, int64_t value, size_t *OUTPUT); | |
1374 | int bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value(struct bt_ctf_field_type *enumeration, uint64_t value, size_t *OUTPUT); | |
ec8c88d7 | 1375 | struct bt_ctf_field_type *bt_ctf_field_type_floating_point_create(void); |
b4b5e4b5 | 1376 | int bt_ctf_field_type_floating_point_get_exponent_digits(struct bt_ctf_field_type *floating_point); |
ec8c88d7 | 1377 | int bt_ctf_field_type_floating_point_set_exponent_digits(struct bt_ctf_field_type *floating_point, unsigned int exponent_digits); |
b4b5e4b5 | 1378 | int bt_ctf_field_type_floating_point_get_mantissa_digits(struct bt_ctf_field_type *floating_point); |
ec8c88d7 JG |
1379 | int bt_ctf_field_type_floating_point_set_mantissa_digits(struct bt_ctf_field_type *floating_point, unsigned int mantissa_digits); |
1380 | struct bt_ctf_field_type *bt_ctf_field_type_structure_create(void); | |
1381 | int bt_ctf_field_type_structure_add_field(struct bt_ctf_field_type *structure, struct bt_ctf_field_type *field_type, const char *field_name); | |
b4b5e4b5 JG |
1382 | int64_t bt_ctf_field_type_structure_get_field_count(struct bt_ctf_field_type *structure); |
1383 | int bt_ctf_field_type_structure_get_field(struct bt_ctf_field_type *structure, const char **OUTPUT, struct bt_ctf_field_type **OUTPUT, size_t index); | |
1384 | struct bt_ctf_field_type *bt_ctf_field_type_structure_get_field_type_by_name(struct bt_ctf_field_type *structure, const char *field_name); | |
ec8c88d7 | 1385 | struct bt_ctf_field_type *bt_ctf_field_type_variant_create(struct bt_ctf_field_type *enum_tag, const char *tag_name); |
b4b5e4b5 JG |
1386 | struct bt_ctf_field_type *bt_ctf_field_type_variant_get_tag_type(struct bt_ctf_field_type *variant); |
1387 | const char *bt_ctf_field_type_variant_get_tag_name(struct bt_ctf_field_type *variant); | |
ec8c88d7 | 1388 | int bt_ctf_field_type_variant_add_field(struct bt_ctf_field_type *variant, struct bt_ctf_field_type *field_type, const char *field_name); |
b4b5e4b5 JG |
1389 | struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_by_name(struct bt_ctf_field_type *variant, const char *field_name); |
1390 | struct bt_ctf_field_type *bt_ctf_field_type_variant_get_field_type_from_tag(struct bt_ctf_field_type *variant, struct bt_ctf_field *tag); | |
1391 | int64_t bt_ctf_field_type_variant_get_field_count(struct bt_ctf_field_type *variant); | |
1392 | int bt_ctf_field_type_variant_get_field(struct bt_ctf_field_type *variant, const char **OUTPUT, struct bt_ctf_field_type **OUTPUT, size_t index); | |
ec8c88d7 | 1393 | struct bt_ctf_field_type *bt_ctf_field_type_array_create(struct bt_ctf_field_type *element_type, unsigned int length); |
b4b5e4b5 JG |
1394 | struct bt_ctf_field_type *bt_ctf_field_type_array_get_element_type(struct bt_ctf_field_type *array); |
1395 | int64_t bt_ctf_field_type_array_get_length(struct bt_ctf_field_type *array); | |
ec8c88d7 | 1396 | struct bt_ctf_field_type *bt_ctf_field_type_sequence_create(struct bt_ctf_field_type *element_type, const char *length_field_name); |
b4b5e4b5 JG |
1397 | struct bt_ctf_field_type *bt_ctf_field_type_sequence_get_element_type(struct bt_ctf_field_type *sequence); |
1398 | const char *bt_ctf_field_type_sequence_get_length_field_name(struct bt_ctf_field_type *sequence); | |
ec8c88d7 | 1399 | struct bt_ctf_field_type *bt_ctf_field_type_string_create(void); |
b4b5e4b5 JG |
1400 | enum ctf_string_encoding bt_ctf_field_type_string_get_encoding(struct bt_ctf_field_type *string_type); |
1401 | int bt_ctf_field_type_string_set_encoding(struct bt_ctf_field_type *string_type, enum ctf_string_encoding encoding); | |
1402 | int bt_ctf_field_type_get_alignment(struct bt_ctf_field_type *type); | |
ec8c88d7 | 1403 | int bt_ctf_field_type_set_alignment(struct bt_ctf_field_type *type, unsigned int alignment); |
b4b5e4b5 | 1404 | enum bt_ctf_byte_order bt_ctf_field_type_get_byte_order(struct bt_ctf_field_type *type); |
ec8c88d7 | 1405 | int bt_ctf_field_type_set_byte_order(struct bt_ctf_field_type *type, enum bt_ctf_byte_order byte_order); |
b4b5e4b5 | 1406 | enum ctf_type_id bt_ctf_field_type_get_type_id(struct bt_ctf_field_type *type); |
ec8c88d7 JG |
1407 | void bt_ctf_field_type_get(struct bt_ctf_field_type *type); |
1408 | void bt_ctf_field_type_put(struct bt_ctf_field_type *type); | |
1409 | ||
1410 | /* ================================================================= | |
1411 | EVENT-FIELDS.H | |
1412 | ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ | |
1413 | */ | |
1414 | %rename("_bt_ctf_field_create") bt_ctf_field_create(struct bt_ctf_field_type *type); | |
1415 | %rename("_bt_ctf_field_structure_get_field") bt_ctf_field_structure_get_field(struct bt_ctf_field *structure, const char *name); | |
1416 | %rename("_bt_ctf_field_array_get_field") bt_ctf_field_array_get_field(struct bt_ctf_field *array, uint64_t index); | |
821ca76c | 1417 | %rename("_bt_ctf_field_sequence_get_length") bt_ctf_field_sequence_get_length(struct bt_ctf_field *sequence); |
ec8c88d7 JG |
1418 | %rename("_bt_ctf_field_sequence_set_length") bt_ctf_field_sequence_set_length(struct bt_ctf_field *sequence, struct bt_ctf_field *length_field); |
1419 | %rename("_bt_ctf_field_sequence_get_field") bt_ctf_field_sequence_get_field(struct bt_ctf_field *sequence, uint64_t index); | |
1420 | %rename("_bt_ctf_field_variant_get_field") bt_ctf_field_variant_get_field(struct bt_ctf_field *variant, struct bt_ctf_field *tag); | |
1421 | %rename("_bt_ctf_field_enumeration_get_container") bt_ctf_field_enumeration_get_container(struct bt_ctf_field *enumeration); | |
821ca76c JG |
1422 | %rename("_bt_ctf_field_enumeration_get_mapping_name") bt_ctf_field_enumeration_get_mapping_name(struct bt_ctf_field *enumeration); |
1423 | %rename("_bt_ctf_field_signed_integer_get_value") bt_ctf_field_signed_integer_get_value(struct bt_ctf_field *integer, int64_t *value); | |
ec8c88d7 | 1424 | %rename("_bt_ctf_field_signed_integer_set_value") bt_ctf_field_signed_integer_set_value(struct bt_ctf_field *integer, int64_t value); |
821ca76c | 1425 | %rename("_bt_ctf_field_unsigned_integer_get_value") bt_ctf_field_unsigned_integer_get_value(struct bt_ctf_field *integer, uint64_t *value); |
ec8c88d7 | 1426 | %rename("_bt_ctf_field_unsigned_integer_set_value") bt_ctf_field_unsigned_integer_set_value(struct bt_ctf_field *integer, uint64_t value); |
821ca76c | 1427 | %rename("_bt_ctf_field_floating_point_get_value") bt_ctf_field_floating_point_get_value(struct bt_ctf_field *floating_point, double *value); |
ec8c88d7 | 1428 | %rename("_bt_ctf_field_floating_point_set_value") bt_ctf_field_floating_point_set_value(struct bt_ctf_field *floating_point, double value); |
b4b5e4b5 JG |
1429 | %rename("_bt_ctf_field_string_get_value") bt_ctf_field_string_get_value(struct bt_ctf_field *string_field); |
1430 | %rename("_bt_ctf_field_string_set_value") bt_ctf_field_string_set_value(struct bt_ctf_field *string_field, const char *value); | |
821ca76c | 1431 | %rename("_bt_ctf_field_get_type") bt_ctf_field_get_type(struct bt_ctf_field *field); |
ec8c88d7 JG |
1432 | %rename("_bt_ctf_field_get") bt_ctf_field_get(struct bt_ctf_field *field); |
1433 | %rename("_bt_ctf_field_put") bt_ctf_field_put(struct bt_ctf_field *field); | |
1434 | ||
1435 | struct bt_ctf_field *bt_ctf_field_create(struct bt_ctf_field_type *type); | |
1436 | struct bt_ctf_field *bt_ctf_field_structure_get_field(struct bt_ctf_field *structure, const char *name); | |
1437 | struct bt_ctf_field *bt_ctf_field_array_get_field(struct bt_ctf_field *array, uint64_t index); | |
821ca76c | 1438 | struct bt_ctf_field * bt_ctf_field_sequence_get_length(struct bt_ctf_field *sequence); |
ec8c88d7 JG |
1439 | int bt_ctf_field_sequence_set_length(struct bt_ctf_field *sequence, struct bt_ctf_field *length_field); |
1440 | struct bt_ctf_field *bt_ctf_field_sequence_get_field(struct bt_ctf_field *sequence, uint64_t index); | |
1441 | struct bt_ctf_field *bt_ctf_field_variant_get_field(struct bt_ctf_field *variant, struct bt_ctf_field *tag); | |
1442 | struct bt_ctf_field *bt_ctf_field_enumeration_get_container(struct bt_ctf_field *enumeration); | |
821ca76c JG |
1443 | const char *bt_ctf_field_enumeration_get_mapping_name(struct bt_ctf_field *enumeration); |
1444 | int bt_ctf_field_signed_integer_get_value(struct bt_ctf_field *integer, int64_t *OUTPUT); | |
ec8c88d7 | 1445 | int bt_ctf_field_signed_integer_set_value(struct bt_ctf_field *integer, int64_t value); |
821ca76c | 1446 | int bt_ctf_field_unsigned_integer_get_value(struct bt_ctf_field *integer, uint64_t *OUTPUT); |
ec8c88d7 | 1447 | int bt_ctf_field_unsigned_integer_set_value(struct bt_ctf_field *integer, uint64_t value); |
821ca76c | 1448 | int bt_ctf_field_floating_point_get_value(struct bt_ctf_field *floating_point, double *OUTPUT); |
ec8c88d7 | 1449 | int bt_ctf_field_floating_point_set_value(struct bt_ctf_field *floating_point, double value); |
b4b5e4b5 JG |
1450 | const char *bt_ctf_field_string_get_value(struct bt_ctf_field *string_field); |
1451 | int bt_ctf_field_string_set_value(struct bt_ctf_field *string_field, const char *value); | |
821ca76c | 1452 | struct bt_ctf_field_type *bt_ctf_field_get_type(struct bt_ctf_field *field); |
ec8c88d7 JG |
1453 | void bt_ctf_field_get(struct bt_ctf_field *field); |
1454 | void bt_ctf_field_put(struct bt_ctf_field *field); | |
1455 | ||
1456 | /* ================================================================= | |
1457 | EVENT.H | |
1458 | ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ | |
1459 | */ | |
1460 | %rename("_bt_ctf_event_class_create") bt_ctf_event_class_create(const char *name); | |
38f28df6 JG |
1461 | %rename("_bt_ctf_event_class_get_name") bt_ctf_event_class_get_name(struct bt_ctf_event_class *event_class); |
1462 | %rename("_bt_ctf_event_class_get_id") bt_ctf_event_class_get_id(struct bt_ctf_event_class *event_class); | |
1463 | %rename("_bt_ctf_event_class_set_id") bt_ctf_event_class_set_id(struct bt_ctf_event_class *event_class, uint32_t id); | |
1464 | %rename("_bt_ctf_event_class_get_stream_class") bt_ctf_event_class_get_stream_class(struct bt_ctf_event_class *event_class); | |
ec8c88d7 | 1465 | %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); |
38f28df6 JG |
1466 | %rename("_bt_ctf_event_class_get_field_count") bt_ctf_event_class_get_field_count(struct bt_ctf_event_class *event_class); |
1467 | %rename("_bt_ctf_event_class_get_field") bt_ctf_event_class_get_field(struct bt_ctf_event_class *event_class, const char **field_name, struct bt_ctf_field_type **field_type, size_t index); | |
1468 | %rename("_bt_ctf_event_class_get_field_by_name") bt_ctf_event_class_get_field_by_name(struct bt_ctf_event_class *event_class, const char *name); | |
ec8c88d7 JG |
1469 | %rename("_bt_ctf_event_class_get") bt_ctf_event_class_get(struct bt_ctf_event_class *event_class); |
1470 | %rename("_bt_ctf_event_class_put") bt_ctf_event_class_put(struct bt_ctf_event_class *event_class); | |
1471 | %rename("_bt_ctf_event_create") bt_ctf_event_create(struct bt_ctf_event_class *event_class); | |
38f28df6 JG |
1472 | %rename("_bt_ctf_event_get_class") bt_ctf_event_get_class(struct bt_ctf_event *event); |
1473 | %rename("_bt_ctf_event_get_clock") bt_ctf_event_get_clock(struct bt_ctf_event *event); | |
ec8c88d7 | 1474 | %rename("_bt_ctf_event_get_payload") bt_ctf_event_get_payload(struct bt_ctf_event *event, const char *name); |
38f28df6 JG |
1475 | %rename("_bt_ctf_event_set_payload") bt_ctf_event_set_payload(struct bt_ctf_event *event, const char *name, struct bt_ctf_field *value); |
1476 | %rename("_bt_ctf_event_get_payload_by_index") bt_ctf_event_get_payload_by_index(struct bt_ctf_event *event, size_t index); | |
ec8c88d7 JG |
1477 | %rename("_bt_ctf_event_get") bt_ctf_event_get(struct bt_ctf_event *event); |
1478 | %rename("_bt_ctf_event_put") bt_ctf_event_put(struct bt_ctf_event *event); | |
1479 | ||
1480 | struct bt_ctf_event_class *bt_ctf_event_class_create(const char *name); | |
38f28df6 JG |
1481 | const char *bt_ctf_event_class_get_name(struct bt_ctf_event_class *event_class); |
1482 | int64_t bt_ctf_event_class_get_id(struct bt_ctf_event_class *event_class); | |
1483 | int bt_ctf_event_class_set_id(struct bt_ctf_event_class *event_class, uint32_t id); | |
1484 | struct bt_ctf_stream_class *bt_ctf_event_class_get_stream_class(struct bt_ctf_event_class *event_class); | |
ec8c88d7 | 1485 | int bt_ctf_event_class_add_field(struct bt_ctf_event_class *event_class, struct bt_ctf_field_type *type, const char *name); |
38f28df6 JG |
1486 | int64_t bt_ctf_event_class_get_field_count(struct bt_ctf_event_class *event_class); |
1487 | int bt_ctf_event_class_get_field(struct bt_ctf_event_class *event_class, const char **field_name, struct bt_ctf_field_type **field_type, size_t index); | |
1488 | struct bt_ctf_field_type *bt_ctf_event_class_get_field_by_name(struct bt_ctf_event_class *event_class, const char *name); | |
ec8c88d7 JG |
1489 | void bt_ctf_event_class_get(struct bt_ctf_event_class *event_class); |
1490 | void bt_ctf_event_class_put(struct bt_ctf_event_class *event_class); | |
1491 | struct bt_ctf_event *bt_ctf_event_create(struct bt_ctf_event_class *event_class); | |
38f28df6 JG |
1492 | struct bt_ctf_event_class *bt_ctf_event_get_class(struct bt_ctf_event *event); |
1493 | struct bt_ctf_clock *bt_ctf_event_get_clock(struct bt_ctf_event *event); | |
ec8c88d7 | 1494 | struct bt_ctf_field *bt_ctf_event_get_payload(struct bt_ctf_event *event, const char *name); |
38f28df6 JG |
1495 | int bt_ctf_event_set_payload(struct bt_ctf_event *event, const char *name, struct bt_ctf_field *value); |
1496 | struct bt_ctf_field *bt_ctf_event_get_payload_by_index(struct bt_ctf_event *event, size_t index); | |
ec8c88d7 JG |
1497 | void bt_ctf_event_get(struct bt_ctf_event *event); |
1498 | void bt_ctf_event_put(struct bt_ctf_event *event); | |
1499 | ||
1500 | /* ================================================================= | |
1501 | STREAM.H | |
1502 | ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ | |
1503 | */ | |
1504 | %rename("_bt_ctf_stream_class_create") bt_ctf_stream_class_create(const char *name); | |
1505 | %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); | |
1506 | %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); | |
1507 | %rename("_bt_ctf_stream_class_get") bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class); | |
1508 | %rename("_bt_ctf_stream_class_put") bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class); | |
1509 | %rename("_bt_ctf_stream_append_discarded_events") bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream, uint64_t event_count); | |
1510 | %rename("_bt_ctf_stream_append_event") bt_ctf_stream_append_event(struct bt_ctf_stream *stream, struct bt_ctf_event *event); | |
1511 | %rename("_bt_ctf_stream_flush") bt_ctf_stream_flush(struct bt_ctf_stream *stream); | |
1512 | %rename("_bt_ctf_stream_get") bt_ctf_stream_get(struct bt_ctf_stream *stream); | |
1513 | %rename("_bt_ctf_stream_put") bt_ctf_stream_put(struct bt_ctf_stream *stream); | |
1514 | ||
1515 | struct bt_ctf_stream_class *bt_ctf_stream_class_create(const char *name); | |
1516 | int bt_ctf_stream_class_set_clock(struct bt_ctf_stream_class *stream_class, struct bt_ctf_clock *clock); | |
1517 | int bt_ctf_stream_class_add_event_class(struct bt_ctf_stream_class *stream_class, struct bt_ctf_event_class *event_class); | |
1518 | void bt_ctf_stream_class_get(struct bt_ctf_stream_class *stream_class); | |
1519 | void bt_ctf_stream_class_put(struct bt_ctf_stream_class *stream_class); | |
1520 | void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream, uint64_t event_count); | |
1521 | int bt_ctf_stream_append_event(struct bt_ctf_stream *stream, struct bt_ctf_event *event); | |
1522 | int bt_ctf_stream_flush(struct bt_ctf_stream *stream); | |
1523 | void bt_ctf_stream_get(struct bt_ctf_stream *stream); | |
1524 | void bt_ctf_stream_put(struct bt_ctf_stream *stream); | |
1525 | ||
1526 | /* ================================================================= | |
1527 | WRITER.H | |
1528 | ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ | |
1529 | */ | |
1530 | %rename("_bt_ctf_writer_create") bt_ctf_writer_create(const char *path); | |
1531 | %rename("_bt_ctf_writer_create_stream") bt_ctf_writer_create_stream(struct bt_ctf_writer *writer, struct bt_ctf_stream_class *stream_class); | |
1532 | %rename("_bt_ctf_writer_add_environment_field") bt_ctf_writer_add_environment_field(struct bt_ctf_writer *writer, const char *name, const char *value); | |
1533 | %rename("_bt_ctf_writer_add_clock") bt_ctf_writer_add_clock(struct bt_ctf_writer *writer, struct bt_ctf_clock *clock); | |
1534 | %newobject bt_ctf_writer_get_metadata_string; | |
1535 | %rename("_bt_ctf_writer_get_metadata_string") bt_ctf_writer_get_metadata_string(struct bt_ctf_writer *writer); | |
1536 | %rename("_bt_ctf_writer_flush_metadata") bt_ctf_writer_flush_metadata(struct bt_ctf_writer *writer); | |
1537 | %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); | |
1538 | %rename("_bt_ctf_writer_get") bt_ctf_writer_get(struct bt_ctf_writer *writer); | |
1539 | %rename("_bt_ctf_writer_put") bt_ctf_writer_put(struct bt_ctf_writer *writer); | |
1540 | ||
1541 | struct bt_ctf_writer *bt_ctf_writer_create(const char *path); | |
1542 | struct bt_ctf_stream *bt_ctf_writer_create_stream(struct bt_ctf_writer *writer, struct bt_ctf_stream_class *stream_class); | |
1543 | int bt_ctf_writer_add_environment_field(struct bt_ctf_writer *writer, const char *name, const char *value); | |
1544 | int bt_ctf_writer_add_clock(struct bt_ctf_writer *writer, struct bt_ctf_clock *clock); | |
1545 | char *bt_ctf_writer_get_metadata_string(struct bt_ctf_writer *writer); | |
1546 | void bt_ctf_writer_flush_metadata(struct bt_ctf_writer *writer); | |
1547 | int bt_ctf_writer_set_byte_order(struct bt_ctf_writer *writer, enum bt_ctf_byte_order byte_order); | |
1548 | void bt_ctf_writer_get(struct bt_ctf_writer *writer); | |
1549 | void bt_ctf_writer_put(struct bt_ctf_writer *writer); | |
1550 | ||
1551 | %pythoncode %{ | |
1552 | ||
1553 | class CTFWriter: | |
b0bb560c JG |
1554 | # Used to compare to -1ULL in error checks |
1555 | _MAX_UINT64 = 0xFFFFFFFFFFFFFFFF | |
ec8c88d7 | 1556 | |
b4b5e4b5 JG |
1557 | """ |
1558 | Enumeration mapping class. start and end values are inclusive. | |
1559 | """ | |
1560 | class EnumerationMapping: | |
1561 | def __init__(self, name, start, end): | |
1562 | self.name = name | |
1563 | self.start = start | |
1564 | self.end = end | |
1565 | ||
ec8c88d7 JG |
1566 | class Clock: |
1567 | def __init__(self, name): | |
1568 | self._c = _bt_ctf_clock_create(name) | |
1569 | if self._c is None: | |
1570 | raise ValueError("Invalid clock name.") | |
1571 | ||
1572 | def __del__(self): | |
1573 | _bt_ctf_clock_put(self._c) | |
1574 | ||
14001277 | 1575 | """ |
b0bb560c JG |
1576 | Get the clock's name. |
1577 | """ | |
1578 | @property | |
1579 | def name(self): | |
1580 | name = _bt_ctf_clock_get_name(self._c) | |
1581 | if name is None: | |
1582 | raise ValueError("Invalid clock instance.") | |
1583 | return name | |
1584 | ||
1585 | """ | |
1586 | Get the clock's description. None if unset. | |
14001277 JG |
1587 | """ |
1588 | @property | |
1589 | def description(self): | |
b0bb560c | 1590 | return _bt_ctf_clock_get_description(self._c) |
14001277 | 1591 | |
ec8c88d7 JG |
1592 | """ |
1593 | Set the clock's description. The description appears in the clock's TSDL | |
1594 | meta-data. | |
1595 | """ | |
14001277 JG |
1596 | @description.setter |
1597 | def description(self, desc): | |
1598 | ret = _bt_ctf_clock_set_description(self._c, str(desc)) | |
ec8c88d7 JG |
1599 | if ret < 0: |
1600 | raise ValueError("Invalid clock description.") | |
1601 | ||
14001277 JG |
1602 | """ |
1603 | Get the clock's frequency (Hz). | |
1604 | """ | |
1605 | @property | |
1606 | def frequency(self): | |
b0bb560c JG |
1607 | freq = _bt_ctf_clock_get_frequency(self._c) |
1608 | if freq == CTFWriter._MAX_UINT64: | |
1609 | raise ValueError("Invalid clock instance") | |
1610 | return freq | |
14001277 | 1611 | |
ec8c88d7 JG |
1612 | """ |
1613 | Set the clock's frequency (Hz). | |
1614 | """ | |
14001277 JG |
1615 | @frequency.setter |
1616 | def frequency(self, freq): | |
ec8c88d7 JG |
1617 | ret = _bt_ctf_clock_set_frequency(self._c, freq) |
1618 | if ret < 0: | |
1619 | raise ValueError("Invalid frequency value.") | |
1620 | ||
14001277 JG |
1621 | """ |
1622 | Get the clock's precision (in clock ticks). | |
1623 | """ | |
1624 | @property | |
1625 | def precision(self): | |
b0bb560c JG |
1626 | precision = _bt_ctf_clock_get_precision(self._c) |
1627 | if precision == CTFWriter._MAX_UINT64: | |
1628 | raise ValueError("Invalid clock instance") | |
1629 | return precision | |
14001277 | 1630 | |
ec8c88d7 JG |
1631 | """ |
1632 | Set the clock's precision (in clock ticks). | |
1633 | """ | |
14001277 JG |
1634 | @precision.setter |
1635 | def precision(self, precision): | |
ec8c88d7 JG |
1636 | ret = _bt_ctf_clock_set_precision(self._c, precision) |
1637 | ||
14001277 JG |
1638 | """ |
1639 | Get the clock's offset in seconds from POSIX.1 Epoch. | |
1640 | """ | |
1641 | @property | |
1642 | def offset_seconds(self): | |
b0bb560c JG |
1643 | offset_s = _bt_ctf_clock_get_offset_s(self._c) |
1644 | if offset_s == CTFWriter._MAX_UINT64: | |
1645 | raise ValueError("Invalid clock instance") | |
1646 | return offset_s | |
14001277 | 1647 | |
ec8c88d7 JG |
1648 | """ |
1649 | Set the clock's offset in seconds from POSIX.1 Epoch. | |
1650 | """ | |
14001277 JG |
1651 | @offset_seconds.setter |
1652 | def offset_seconds(self, offset_s): | |
ec8c88d7 JG |
1653 | ret = _bt_ctf_clock_set_offset_s(self._c, offset_s) |
1654 | if ret < 0: | |
1655 | raise ValueError("Invalid offset value.") | |
1656 | ||
14001277 JG |
1657 | """ |
1658 | Get the clock's offset in ticks from POSIX.1 Epoch + offset in seconds. | |
1659 | """ | |
1660 | @property | |
1661 | def offset(self): | |
b0bb560c JG |
1662 | offset = _bt_ctf_clock_get_offset(self._c) |
1663 | if offset == CTFWriter._MAX_UINT64: | |
1664 | raise ValueError("Invalid clock instance") | |
1665 | return offset | |
14001277 | 1666 | |
ec8c88d7 JG |
1667 | """ |
1668 | Set the clock's offset in ticks from POSIX.1 Epoch + offset in seconds. | |
1669 | """ | |
14001277 JG |
1670 | @offset.setter |
1671 | def offset(self, offset): | |
ec8c88d7 JG |
1672 | ret = _bt_ctf_clock_set_offset(self._c, offset) |
1673 | if ret < 0: | |
1674 | raise ValueError("Invalid offset value.") | |
1675 | ||
14001277 JG |
1676 | """ |
1677 | Get a clock's absolute attribute. A clock is absolute if the clock | |
1678 | is a global reference across the trace's other clocks. | |
1679 | """ | |
1680 | @property | |
1681 | def absolute(self): | |
b0bb560c JG |
1682 | is_absolute = _bt_ctf_clock_get_is_absolute(self._c) |
1683 | if is_absolute == -1: | |
1684 | raise ValueError("Invalid clock instance") | |
1685 | return False if is_absolute == 0 else True | |
14001277 | 1686 | |
ec8c88d7 JG |
1687 | """ |
1688 | Set a clock's absolute attribute. A clock is absolute if the clock | |
1689 | is a global reference across the trace's other clocks. | |
1690 | """ | |
14001277 JG |
1691 | @absolute.setter |
1692 | def absolute(self, is_absolute): | |
1693 | ret = _bt_ctf_clock_set_is_absolute(self._c, int(is_absolute)) | |
ec8c88d7 JG |
1694 | if ret < 0: |
1695 | raise ValueError("Could not set the clock's absolute attribute.") | |
1696 | ||
14001277 JG |
1697 | """ |
1698 | Get the current time in nanoseconds since the clock's origin (offset and | |
1699 | offset_s attributes). | |
1700 | """ | |
1701 | @property | |
1702 | def time(self): | |
b0bb560c JG |
1703 | time = _bt_ctf_clock_get_time(self._c) |
1704 | if time == CTFWriter._MAX_UINT64: | |
1705 | raise ValueError("Invalid clock instance") | |
1706 | return time | |
14001277 | 1707 | |
ec8c88d7 JG |
1708 | """ |
1709 | Set the current time in nanoseconds since the clock's origin (offset and | |
1710 | offset_s attributes). The clock's value will be sampled as events are | |
1711 | appended to a stream. | |
1712 | """ | |
14001277 JG |
1713 | @time.setter |
1714 | def time(self, time): | |
ec8c88d7 JG |
1715 | ret = _bt_ctf_clock_set_time(self._c, time) |
1716 | if ret < 0: | |
1717 | raise ValueError("Invalid time value.") | |
1718 | ||
14001277 | 1719 | class FieldDeclaration: |
ec8c88d7 | 1720 | """ |
b4b5e4b5 | 1721 | FieldDeclaration should not be instantiated directly. Instantiate |
14001277 | 1722 | one of the concrete FieldDeclaration classes. |
ec8c88d7 JG |
1723 | """ |
1724 | class IntegerBase: | |
1725 | # These values are based on the bt_ctf_integer_base enum | |
1726 | # declared in event-types.h. | |
1727 | INTEGER_BASE_UNKNOWN = -1 | |
1728 | INTEGER_BASE_BINARY = 2 | |
1729 | INTEGER_BASE_OCTAL = 8 | |
1730 | INTEGER_BASE_DECIMAL = 10 | |
1731 | INTEGER_BASE_HEXADECIMAL = 16 | |
1732 | ||
1733 | def __init__(self): | |
1734 | if self._ft is None: | |
14001277 | 1735 | raise ValueError("FieldDeclaration creation failed.") |
ec8c88d7 JG |
1736 | |
1737 | def __del__(self): | |
1738 | _bt_ctf_field_type_put(self._ft) | |
1739 | ||
b4b5e4b5 JG |
1740 | @staticmethod |
1741 | def _create_field_declaration_from_native_instance(native_field_declaration): | |
1742 | type_dict = { | |
1743 | CTFTypeId.INTEGER : CTFWriter.IntegerFieldDeclaration, | |
1744 | CTFTypeId.FLOAT : CTFWriter.FloatFieldDeclaration, | |
1745 | CTFTypeId.ENUM : CTFWriter.EnumerationFieldDeclaration, | |
1746 | CTFTypeId.STRING : CTFWriter.StringFieldDeclaration, | |
1747 | CTFTypeId.STRUCT : CTFWriter.StructureFieldDeclaration, | |
1748 | CTFTypeId.VARIANT : CTFWriter.VariantFieldDeclaration, | |
1749 | CTFTypeId.ARRAY : CTFWriter.ArrayFieldDeclaration, | |
1750 | CTFTypeId.SEQUENCE : CTFWriter.SequenceFieldDeclaration | |
1751 | } | |
1752 | ||
1753 | field_type_id = _bt_ctf_field_type_get_type_id(native_field_declaration) | |
1754 | if field_type_id == CTFTypeId.UNKNOWN: | |
1755 | raise TypeError("Invalid field instance") | |
1756 | ||
1757 | declaration = CTFWriter.Field.__new__(CTFWriter.Field) | |
1758 | declaration._ft = native_field_declaration | |
1759 | declaration.__class__ = type_dict[field_type_id] | |
1760 | return declaration | |
1761 | ||
14001277 | 1762 | """ |
b4b5e4b5 | 1763 | Get the field declaration's alignment. Returns -1 on error. |
14001277 JG |
1764 | """ |
1765 | @property | |
1766 | def alignment(self): | |
b4b5e4b5 | 1767 | return _bt_ctf_field_type_get_alignment(self._ft) |
14001277 | 1768 | |
ec8c88d7 | 1769 | """ |
b4b5e4b5 | 1770 | Set the field declaration's alignment. Defaults to 1 (bit-aligned). However, |
ec8c88d7 JG |
1771 | some types, such as structures and string, may impose other alignment |
1772 | constraints. | |
1773 | """ | |
14001277 JG |
1774 | @alignment.setter |
1775 | def alignment(self, alignment): | |
ec8c88d7 JG |
1776 | ret = _bt_ctf_field_type_set_alignment(self._ft, alignment) |
1777 | if ret < 0: | |
1778 | raise ValueError("Invalid alignment value.") | |
1779 | ||
14001277 | 1780 | """ |
b4b5e4b5 | 1781 | Get the field declaration's byte order. One of the ByteOrder's constant. |
14001277 JG |
1782 | """ |
1783 | @property | |
1784 | def byte_order(self): | |
b4b5e4b5 | 1785 | return _bt_ctf_field_type_get_byte_order(self._ft) |
14001277 | 1786 | |
ec8c88d7 | 1787 | """ |
b4b5e4b5 | 1788 | Set the field declaration's byte order. Use constants defined in the ByteOrder |
ec8c88d7 JG |
1789 | class. |
1790 | """ | |
14001277 JG |
1791 | @byte_order.setter |
1792 | def byte_order(self, byte_order): | |
ec8c88d7 JG |
1793 | ret = _bt_ctf_field_type_set_byte_order(self._ft, byte_order) |
1794 | if ret < 0: | |
1795 | raise ValueError("Could not set byte order value.") | |
1796 | ||
14001277 | 1797 | class IntegerFieldDeclaration(FieldDeclaration): |
ec8c88d7 | 1798 | """ |
b4b5e4b5 | 1799 | Create a new integer field declaration of the given size. |
ec8c88d7 JG |
1800 | """ |
1801 | def __init__(self, size): | |
1802 | self._ft = _bt_ctf_field_type_integer_create(size) | |
1803 | super().__init__() | |
1804 | ||
b4b5e4b5 JG |
1805 | """ |
1806 | Get an integer's size. | |
1807 | """ | |
1808 | @property | |
1809 | def size(self): | |
1810 | ret = _bt_ctf_field_type_integer_get_size(self._ft) | |
1811 | if ret < 0: | |
1812 | raise ValueError("Could not get Integer's size attribute.") | |
1813 | else: | |
1814 | return ret | |
1815 | ||
ec8c88d7 | 1816 | """ |
14001277 JG |
1817 | Get an integer's signedness attribute. |
1818 | """ | |
1819 | @property | |
1820 | def signed(self): | |
b4b5e4b5 JG |
1821 | ret = _bt_ctf_field_type_integer_get_signed(self._ft) |
1822 | if ret < 0: | |
1823 | raise ValueError("Could not get Integer's signed attribute.") | |
1824 | elif ret > 0: | |
1825 | return True | |
1826 | else: | |
1827 | return False | |
14001277 JG |
1828 | |
1829 | """ | |
1830 | Set an integer's signedness attribute. | |
ec8c88d7 | 1831 | """ |
14001277 JG |
1832 | @signed.setter |
1833 | def signed(self, signed): | |
ec8c88d7 JG |
1834 | ret = _bt_ctf_field_type_integer_set_signed(self._ft, signed) |
1835 | if ret < 0: | |
b4b5e4b5 | 1836 | raise ValueError("Could not set Integer's signed attribute.") |
ec8c88d7 JG |
1837 | |
1838 | """ | |
14001277 | 1839 | Get the integer's base used to pretty-print the resulting trace. |
b4b5e4b5 | 1840 | Returns a constant from the FieldDeclaration.IntegerBase class. |
14001277 JG |
1841 | """ |
1842 | @property | |
1843 | def base(self): | |
b4b5e4b5 | 1844 | return _bt_ctf_field_type_integer_get_base(self._ft) |
14001277 JG |
1845 | |
1846 | """ | |
1847 | Set the integer's base used to pretty-print the resulting trace. | |
b4b5e4b5 | 1848 | The base must be a constant of the FieldDeclarationIntegerBase class. |
ec8c88d7 | 1849 | """ |
14001277 JG |
1850 | @base.setter |
1851 | def base(self, base): | |
ec8c88d7 JG |
1852 | ret = _bt_ctf_field_type_integer_set_base(self._ft, base) |
1853 | if ret < 0: | |
b4b5e4b5 | 1854 | raise ValueError("Could not set Integer's base.") |
ec8c88d7 | 1855 | |
14001277 JG |
1856 | """ |
1857 | Get the integer's encoding (one of the constants of the | |
1858 | CTFStringEncoding class). | |
b4b5e4b5 | 1859 | Returns a constant from the CTFStringEncoding class. |
14001277 JG |
1860 | """ |
1861 | @property | |
1862 | def encoding(self): | |
b4b5e4b5 | 1863 | return _bt_ctf_field_type_integer_get_encoding(self._ft) |
14001277 | 1864 | |
ec8c88d7 JG |
1865 | """ |
1866 | An integer encoding may be set to signal that the integer must be printed | |
1867 | as a text character. Must be a constant from the CTFStringEncoding class. | |
1868 | """ | |
14001277 JG |
1869 | @encoding.setter |
1870 | def encoding(self, encoding): | |
ec8c88d7 JG |
1871 | ret = _bt_ctf_field_type_integer_set_encoding(self._ft, encoding) |
1872 | if ret < 0: | |
b4b5e4b5 | 1873 | raise ValueError("Could not set Integer's encoding.") |
ec8c88d7 | 1874 | |
14001277 | 1875 | class EnumerationFieldDeclaration(FieldDeclaration): |
ec8c88d7 | 1876 | """ |
b4b5e4b5 | 1877 | Create a new enumeration field declaration with the given underlying container type. |
ec8c88d7 JG |
1878 | """ |
1879 | def __init__(self, integer_type): | |
14001277 | 1880 | if integer_type is None or not isinstance(integer_type, CTFWriter.IntegerFieldDeclaration): |
ec8c88d7 JG |
1881 | raise TypeError("Invalid integer container.") |
1882 | ||
1883 | self._ft = _bt_ctf_field_type_enumeration_create(integer_type._ft) | |
1884 | super().__init__() | |
1885 | ||
b4b5e4b5 JG |
1886 | """ |
1887 | Get the enumeration's underlying container type. | |
1888 | """ | |
1889 | @property | |
1890 | def container(self): | |
1891 | ret = _bt_ctf_field_type_enumeration_get_container_type(self._ft) | |
1892 | if ret is None: | |
1893 | raise TypeError("Invalid enumeration declaration") | |
1894 | return CTFWriter.FieldDeclaration._create_field_declaration_from_native_instance(ret) | |
1895 | ||
ec8c88d7 JG |
1896 | """ |
1897 | Add a mapping to the enumeration. The range's values are inclusive. | |
1898 | """ | |
1899 | def add_mapping(self, name, range_start, range_end): | |
b4b5e4b5 JG |
1900 | if range_start < 0 or range_end < 0: |
1901 | ret = _bt_ctf_field_type_enumeration_add_mapping(self._ft, str(name), range_start, range_end) | |
1902 | else: | |
1903 | ret = _bt_ctf_field_type_enumeration_add_mapping_unsigned(self._ft, str(name), range_start, range_end) | |
1904 | ||
ec8c88d7 | 1905 | if ret < 0: |
b4b5e4b5 JG |
1906 | raise ValueError("Could not add mapping to enumeration declaration.") |
1907 | ||
1908 | """ | |
1909 | Generator returning instances of EnumerationMapping. | |
1910 | """ | |
1911 | @property | |
1912 | def mappings(self): | |
1913 | signed = self.container.signed | |
1914 | ||
1915 | count = _bt_ctf_field_type_enumeration_get_mapping_count(self._ft) | |
1916 | for i in range(count): | |
1917 | if signed: | |
1918 | ret = _bt_python_ctf_field_type_enumeration_get_mapping(self._ft, i) | |
1919 | else: | |
1920 | ret = _bt_python_ctf_field_type_enumeration_get_mapping_unsigned(self._ft, i) | |
1921 | ||
1922 | if len(ret) != 3: | |
1923 | raise TypeError("Could not get Enumeration mapping at index {}".format(i)) | |
1924 | name, range_start, range_end = ret | |
1925 | yield CTFWriter.EnumerationMapping(name, range_start, range_end) | |
1926 | ||
1927 | """ | |
1928 | Get a mapping by name (EnumerationMapping). | |
1929 | """ | |
1930 | def get_mapping_by_name(self, name): | |
1931 | ret, index = _bt_ctf_field_type_enumeration_get_mapping_index_by_name(self._ft, name); | |
1932 | if ret < 0: | |
1933 | return None | |
1934 | ||
1935 | if self.container.signed: | |
1936 | ret = _bt_python_ctf_field_type_enumeration_get_mapping(self._ft, index) | |
1937 | else: | |
1938 | ret = _bt_python_ctf_field_type_enumeration_get_mapping_unsigned(self._ft, index) | |
1939 | ||
1940 | if len(ret) != 3: | |
1941 | raise TypeError("Could not get Enumeration mapping at index {}".format(i)) | |
1942 | name, range_start, range_end = ret | |
1943 | return CTFWriter.EnumerationMapping(name, range_start, range_end) | |
1944 | ||
1945 | """ | |
1946 | Get a mapping by value (EnumerationMapping). | |
1947 | """ | |
1948 | def get_mapping_by_value(self, value): | |
1949 | if value < 0: | |
1950 | ret, index = _bt_ctf_field_type_enumeration_get_mapping_index_by_value(self._ft, value); | |
1951 | else: | |
1952 | ret, index = _bt_ctf_field_type_enumeration_get_mapping_index_by_unsigned_value(self._ft, value); | |
1953 | ||
1954 | if ret < 0: | |
1955 | return None | |
1956 | ||
1957 | if self.container.signed: | |
1958 | ret = _bt_python_ctf_field_type_enumeration_get_mapping(self._ft, index) | |
1959 | else: | |
1960 | ret = _bt_python_ctf_field_type_enumeration_get_mapping_unsigned(self._ft, index) | |
1961 | ||
1962 | if len(ret) != 3: | |
1963 | raise TypeError("Could not get Enumeration mapping at index {}".format(i)) | |
1964 | name, range_start, range_end = ret | |
1965 | return CTFWriter.EnumerationMapping(name, range_start, range_end) | |
ec8c88d7 | 1966 | |
14001277 | 1967 | class FloatFieldDeclaration(FieldDeclaration): |
ec8c88d7 JG |
1968 | FLT_EXP_DIG = 8 |
1969 | DBL_EXP_DIG = 11 | |
1970 | FLT_MANT_DIG = 24 | |
1971 | DBL_MANT_DIG = 53 | |
1972 | ||
1973 | """ | |
b4b5e4b5 | 1974 | Create a new floating point field declaration. |
ec8c88d7 JG |
1975 | """ |
1976 | def __init__(self): | |
1977 | self._ft = _bt_ctf_field_type_floating_point_create() | |
1978 | super().__init__() | |
1979 | ||
1980 | """ | |
b4b5e4b5 | 1981 | Get the number of exponent digits used to store the floating point field. |
14001277 JG |
1982 | """ |
1983 | @property | |
1984 | def exponent_digits(self): | |
b4b5e4b5 JG |
1985 | ret = _bt_ctf_field_type_floating_point_get_exponent_digits(self._ft) |
1986 | if ret < 0: | |
1987 | raise TypeError("Could not get Floating point exponent digit count") | |
1988 | return ret | |
14001277 JG |
1989 | |
1990 | """ | |
1991 | Set the number of exponent digits to use to store the floating point field. | |
ec8c88d7 JG |
1992 | The only values currently supported are FLT_EXP_DIG and DBL_EXP_DIG which |
1993 | are defined as constants of this class. | |
1994 | """ | |
14001277 JG |
1995 | @exponent_digits.setter |
1996 | def exponent_digits(self, exponent_digits): | |
ec8c88d7 JG |
1997 | ret = _bt_ctf_field_type_floating_point_set_exponent_digits(self._ft, exponent_digits) |
1998 | if ret < 0: | |
1999 | raise ValueError("Could not set exponent digit count.") | |
2000 | ||
2001 | """ | |
b4b5e4b5 | 2002 | Get the number of mantissa digits used to store the floating point field. |
14001277 JG |
2003 | """ |
2004 | @property | |
2005 | def mantissa_digits(self): | |
b4b5e4b5 JG |
2006 | ret = _bt_ctf_field_type_floating_point_get_mantissa_digits(self._ft) |
2007 | if ret < 0: | |
2008 | raise TypeError("Could not get Floating point mantissa digit count") | |
2009 | return ret | |
14001277 JG |
2010 | |
2011 | """ | |
2012 | Set the number of mantissa digits to use to store the floating point field. | |
ec8c88d7 JG |
2013 | The only values currently supported are FLT_MANT_DIG and DBL_MANT_DIG which |
2014 | are defined as constants of this class. | |
2015 | """ | |
14001277 JG |
2016 | @mantissa_digits.setter |
2017 | def mantissa_digits(self, mantissa_digits): | |
ec8c88d7 JG |
2018 | ret = _bt_ctf_field_type_floating_point_set_mantissa_digits(self._ft, mantissa_digits) |
2019 | if ret < 0: | |
2020 | raise ValueError("Could not set mantissa digit count.") | |
2021 | ||
14001277 | 2022 | class StructureFieldDeclaration(FieldDeclaration): |
ec8c88d7 | 2023 | """ |
b4b5e4b5 | 2024 | Create a new structure field declaration. |
ec8c88d7 JG |
2025 | """ |
2026 | def __init__(self): | |
2027 | self._ft = _bt_ctf_field_type_structure_create() | |
2028 | super().__init__() | |
2029 | ||
2030 | """ | |
2031 | Add a field of type "field_type" to the structure. | |
2032 | """ | |
2033 | def add_field(self, field_type, field_name): | |
14001277 | 2034 | ret = _bt_ctf_field_type_structure_add_field(self._ft, field_type._ft, str(field_name)) |
ec8c88d7 JG |
2035 | if ret < 0: |
2036 | raise ValueError("Could not add field to structure.") | |
2037 | ||
b4b5e4b5 JG |
2038 | """ |
2039 | Generator returning the structure's field as tuples of (field name, field declaration). | |
2040 | """ | |
2041 | @property | |
2042 | def fields(self): | |
2043 | count = _bt_ctf_field_type_structure_get_field_count(self._ft) | |
2044 | if count < 0: | |
2045 | raise TypeError("Could not get Structure field count") | |
2046 | ||
2047 | for i in range(count): | |
2048 | field_name = _bt_python_ctf_field_type_structure_get_field_name(self._ft, i) | |
2049 | if field_name is None: | |
2050 | raise TypeError("Could not get Structure field name at index {}".format(i)) | |
2051 | ||
2052 | field_type_native = _bt_python_ctf_field_type_structure_get_field_type(self._ft, i) | |
2053 | if field_type_native is None: | |
2054 | raise TypeError("Could not get Structure field type at index {}".format(i)) | |
2055 | ||
2056 | field_type = CTFWriter.FieldDeclaration._create_field_declaration_from_native_instance(field_type_native) | |
2057 | yield (field_name, field_type) | |
2058 | ||
2059 | """ | |
2060 | Get a field declaration by name (FieldDeclaration). | |
2061 | """ | |
2062 | def get_field_by_name(self, name): | |
2063 | field_type_native = _bt_ctf_field_type_structure_get_field_type_by_name(self._ft, name) | |
2064 | if field_type_native is None: | |
2065 | raise TypeError("Could not find Structure field with name {}".format(name)) | |
2066 | ||
2067 | return CTFWriter.FieldDeclaration._create_field_declaration_from_native_instance(field_type_native) | |
2068 | ||
14001277 | 2069 | class VariantFieldDeclaration(FieldDeclaration): |
ec8c88d7 | 2070 | """ |
b4b5e4b5 | 2071 | Create a new variant field declaration. |
ec8c88d7 JG |
2072 | """ |
2073 | def __init__(self, enum_tag, tag_name): | |
14001277 JG |
2074 | if enum_tag is None or not isinstance(enum_tag, CTFWriter.EnumerationFieldDeclaration): |
2075 | raise TypeError("Invalid tag type; must be of type EnumerationFieldDeclaration.") | |
ec8c88d7 | 2076 | |
14001277 | 2077 | self._ft = _bt_ctf_field_type_variant_create(enum_tag._ft, str(tag_name)) |
ec8c88d7 JG |
2078 | super().__init__() |
2079 | ||
b4b5e4b5 JG |
2080 | """ |
2081 | Get the variant's tag name. | |
2082 | """ | |
2083 | @property | |
2084 | def tag_name(self): | |
2085 | ret = _bt_ctf_field_type_variant_get_tag_name(self._ft) | |
2086 | if ret is None: | |
2087 | raise TypeError("Could not get Variant tag name") | |
2088 | return ret | |
2089 | ||
2090 | """ | |
2091 | Get the variant's tag type. | |
2092 | """ | |
2093 | @property | |
2094 | def tag_type(self): | |
2095 | ret = _bt_ctf_field_type_variant_get_tag_type(self._ft) | |
2096 | if ret is None: | |
2097 | raise TypeError("Could not get Variant tag type") | |
2098 | return CTFWriter.FieldDeclaration._create_field_declaration_from_native_instance(ret) | |
2099 | ||
ec8c88d7 JG |
2100 | """ |
2101 | Add a field of type "field_type" to the variant. | |
2102 | """ | |
2103 | def add_field(self, field_type, field_name): | |
14001277 | 2104 | ret = _bt_ctf_field_type_variant_add_field(self._ft, field_type._ft, str(field_name)) |
ec8c88d7 JG |
2105 | if ret < 0: |
2106 | raise ValueError("Could not add field to variant.") | |
2107 | ||
b4b5e4b5 JG |
2108 | """ |
2109 | Generator returning the variant's field as tuples of (field name, field declaration). | |
2110 | """ | |
2111 | @property | |
2112 | def fields(self): | |
2113 | count = _bt_ctf_field_type_variant_get_field_count(self._ft) | |
2114 | if count < 0: | |
2115 | raise TypeError("Could not get Variant field count") | |
2116 | ||
2117 | for i in range(count): | |
2118 | field_name = _bt_python_ctf_field_type_variant_get_field_name(self._ft, i) | |
2119 | if field_name is None: | |
2120 | raise TypeError("Could not get Variant field name at index {}".format(i)) | |
2121 | ||
2122 | field_type_native = _bt_python_ctf_field_type_variant_get_field_type(self._ft, i) | |
2123 | if field_type_native is None: | |
2124 | raise TypeError("Could not get Variant field type at index {}".format(i)) | |
2125 | ||
2126 | field_type = CTFWriter.FieldDeclaration._create_field_declaration_from_native_instance(field_type_native) | |
2127 | yield (field_name, field_type) | |
2128 | ||
2129 | """ | |
2130 | Get a field declaration by name (FieldDeclaration). | |
2131 | """ | |
2132 | def get_field_by_name(self, name): | |
2133 | field_type_native = _bt_ctf_field_type_variant_get_field_type_by_name(self._ft, name) | |
2134 | if field_type_native is None: | |
2135 | raise TypeError("Could not find Variant field with name {}".format(name)) | |
2136 | ||
2137 | return CTFWriter.FieldDeclaration._create_field_declaration_from_native_instance(field_type_native) | |
2138 | ||
2139 | """ | |
2140 | Get a field declaration from tag (EnumerationField). | |
2141 | """ | |
2142 | def get_field_from_tag(self, tag): | |
2143 | field_type_native = _bt_ctf_field_type_variant_get_field_type_from_tag(self._ft, tag._f) | |
2144 | if field_type_native is None: | |
2145 | raise TypeError("Could not find Variant field with tag value {}".format(tag.value)) | |
2146 | ||
2147 | return CTFWriter.FieldDeclaration._create_field_declaration_from_native_instance(field_type_native) | |
2148 | ||
14001277 | 2149 | class ArrayFieldDeclaration(FieldDeclaration): |
ec8c88d7 | 2150 | """ |
b4b5e4b5 | 2151 | Create a new array field declaration. |
ec8c88d7 JG |
2152 | """ |
2153 | def __init__(self, element_type, length): | |
2154 | self._ft = _bt_ctf_field_type_array_create(element_type._ft, length) | |
2155 | super().__init__() | |
2156 | ||
b4b5e4b5 JG |
2157 | """ |
2158 | Get the array's element type. | |
2159 | """ | |
2160 | @property | |
2161 | def element_type(self): | |
2162 | ret = _bt_ctf_field_type_array_get_element_type(self._ft) | |
2163 | if ret is None: | |
2164 | raise TypeError("Could not get Array element type") | |
2165 | return CTFWriter.FieldDeclaration._create_field_declaration_from_native_instance(ret) | |
2166 | ||
2167 | """ | |
2168 | Get the array's length. | |
2169 | """ | |
2170 | @property | |
2171 | def length(self): | |
2172 | ret = _bt_ctf_field_type_array_get_length(self._ft) | |
2173 | if ret < 0: | |
2174 | raise TypeError("Could not get Array length") | |
2175 | return ret | |
2176 | ||
14001277 | 2177 | class SequenceFieldDeclaration(FieldDeclaration): |
ec8c88d7 | 2178 | """ |
b4b5e4b5 | 2179 | Create a new sequence field declaration. |
ec8c88d7 JG |
2180 | """ |
2181 | def __init__(self, element_type, length_field_name): | |
14001277 | 2182 | self._ft = _bt_ctf_field_type_sequence_create(element_type._ft, str(length_field_name)) |
ec8c88d7 JG |
2183 | super().__init__() |
2184 | ||
b4b5e4b5 JG |
2185 | """ |
2186 | Get the sequence's element type. | |
2187 | """ | |
2188 | @property | |
2189 | def element_type(self): | |
2190 | ret = _bt_ctf_field_type_sequence_get_element_type(self._ft) | |
2191 | if ret is None: | |
2192 | raise TypeError("Could not get Sequence element type") | |
2193 | return CTFWriter.FieldDeclaration._create_field_declaration_from_native_instance(ret) | |
2194 | ||
2195 | """ | |
2196 | Get the sequence's length field name. | |
2197 | """ | |
2198 | @property | |
2199 | def length_field_name(self): | |
2200 | ret = _bt_ctf_field_type_sequence_get_length_field_name(self._ft) | |
2201 | if ret is None: | |
2202 | raise TypeError("Could not get Sequence length field name") | |
2203 | return ret | |
2204 | ||
14001277 | 2205 | class StringFieldDeclaration(FieldDeclaration): |
ec8c88d7 | 2206 | """ |
b4b5e4b5 | 2207 | Create a new string field declaration. |
ec8c88d7 JG |
2208 | """ |
2209 | def __init__(self): | |
2210 | self._ft = _bt_ctf_field_type_string_create() | |
2211 | super().__init__() | |
2212 | ||
14001277 | 2213 | """ |
b4b5e4b5 | 2214 | Get a string declaration's encoding (a constant from the CTFStringEncoding class). |
14001277 JG |
2215 | """ |
2216 | @property | |
2217 | def encoding(self): | |
b4b5e4b5 | 2218 | return _bt_ctf_field_type_string_get_encoding(self._ft) |
14001277 | 2219 | |
ec8c88d7 | 2220 | """ |
b4b5e4b5 | 2221 | Set a string declaration's encoding. Must be a constant from the CTFStringEncoding class. |
ec8c88d7 | 2222 | """ |
14001277 JG |
2223 | @encoding.setter |
2224 | def encoding(self, encoding): | |
ec8c88d7 JG |
2225 | ret = _bt_ctf_field_type_string_set_encoding(self._ft, encoding) |
2226 | if ret < 0: | |
2227 | raise ValueError("Could not set string encoding.") | |
2228 | ||
2229 | """ | |
2230 | Create an instance of a field. | |
2231 | """ | |
2232 | @staticmethod | |
b4b5e4b5 | 2233 | def create_field(field_type): |
14001277 JG |
2234 | if field_type is None or not isinstance(field_type, CTFWriter.FieldDeclaration): |
2235 | raise TypeError("Invalid field_type. Type must be a FieldDeclaration-derived class.") | |
2236 | ||
2237 | if isinstance(field_type, CTFWriter.IntegerFieldDeclaration): | |
2238 | return CTFWriter.IntegerField(field_type) | |
2239 | elif isinstance(field_type, CTFWriter.EnumerationFieldDeclaration): | |
2240 | return CTFWriter.EnumerationField(field_type) | |
2241 | elif isinstance(field_type, CTFWriter.FloatFieldDeclaration): | |
2242 | return CTFWriter.FloatFieldingPoint(field_type) | |
2243 | elif isinstance(field_type, CTFWriter.StructureFieldDeclaration): | |
2244 | return CTFWriter.StructureField(field_type) | |
2245 | elif isinstance(field_type, CTFWriter.VariantFieldDeclaration): | |
2246 | return CTFWriter.VariantField(field_type) | |
2247 | elif isinstance(field_type, CTFWriter.ArrayFieldDeclaration): | |
2248 | return CTFWriter.ArrayField(field_type) | |
2249 | elif isinstance(field_type, CTFWriter.SequenceFieldDeclaration): | |
2250 | return CTFWriter.SequenceField(field_type) | |
2251 | elif isinstance(field_type, CTFWriter.StringFieldDeclaration): | |
2252 | return CTFWriter.StringField(field_type) | |
ec8c88d7 JG |
2253 | |
2254 | class Field: | |
2255 | """ | |
2256 | Base class, do not instantiate. | |
2257 | """ | |
2258 | def __init__(self, field_type): | |
14001277 | 2259 | if not isinstance(field_type, CTFWriter.FieldDeclaration): |
ec8c88d7 JG |
2260 | raise TypeError("Invalid field_type argument.") |
2261 | ||
2262 | self._f = _bt_ctf_field_create(field_type._ft) | |
2263 | if self._f is None: | |
2264 | raise ValueError("Field creation failed.") | |
2265 | ||
2266 | def __del__(self): | |
2267 | _bt_ctf_field_put(self._f) | |
2268 | ||
2269 | @staticmethod | |
2270 | def _create_field_from_native_instance(native_field_instance): | |
2271 | type_dict = { | |
14001277 JG |
2272 | CTFTypeId.INTEGER : CTFWriter.IntegerField, |
2273 | CTFTypeId.FLOAT : CTFWriter.FloatFieldingPoint, | |
2274 | CTFTypeId.ENUM : CTFWriter.EnumerationField, | |
2275 | CTFTypeId.STRING : CTFWriter.StringField, | |
2276 | CTFTypeId.STRUCT : CTFWriter.StructureField, | |
2277 | CTFTypeId.VARIANT : CTFWriter.VariantField, | |
2278 | CTFTypeId.ARRAY : CTFWriter.ArrayField, | |
2279 | CTFTypeId.SEQUENCE : CTFWriter.SequenceField | |
ec8c88d7 JG |
2280 | } |
2281 | ||
2282 | field_type = _bt_python_get_field_type(native_field_instance) | |
2283 | if field_type == CTFTypeId.UNKNOWN: | |
2284 | raise TypeError("Invalid field instance") | |
2285 | ||
2286 | field = CTFWriter.Field.__new__(CTFWriter.Field) | |
2287 | field._f = native_field_instance | |
2288 | field.__class__ = type_dict[field_type] | |
2289 | return field | |
2290 | ||
b4b5e4b5 JG |
2291 | @property |
2292 | def declaration(self): | |
2293 | native_field_type = _bt_ctf_field_get_type(self._f) | |
2294 | if native_field_type is None: | |
2295 | raise TypeError("Invalid field instance") | |
2296 | return CTFWriter.FieldDeclaration._create_field_declaration_from_native_instance(native_field_type) | |
2297 | ||
14001277 JG |
2298 | class IntegerField(Field): |
2299 | """ | |
2300 | Get an integer field's value. | |
2301 | """ | |
2302 | @property | |
2303 | def value(self): | |
821ca76c JG |
2304 | signedness = _bt_python_field_integer_get_signedness(self._f) |
2305 | if signedness < 0: | |
2306 | raise TypeError("Invalid integer instance.") | |
2307 | ||
2308 | if signedness == 0: | |
2309 | ret, value = _bt_ctf_field_unsigned_integer_get_value(self._f) | |
2310 | else: | |
2311 | ret, value = _bt_ctf_field_signed_integer_get_value(self._f) | |
2312 | ||
2313 | if ret < 0: | |
2314 | raise ValueError("Could not get integer field value.") | |
2315 | return value | |
14001277 | 2316 | |
ec8c88d7 JG |
2317 | """ |
2318 | Set an integer field's value. | |
2319 | """ | |
14001277 JG |
2320 | @value.setter |
2321 | def value(self, value): | |
821ca76c JG |
2322 | if not isinstance(value, int): |
2323 | raise TypeError("IntegerField's value must be an int") | |
2324 | ||
ec8c88d7 JG |
2325 | signedness = _bt_python_field_integer_get_signedness(self._f) |
2326 | if signedness < 0: | |
2327 | raise TypeError("Invalid integer instance.") | |
2328 | ||
2329 | if signedness == 0: | |
2330 | ret = _bt_ctf_field_unsigned_integer_set_value(self._f, value) | |
2331 | else: | |
2332 | ret = _bt_ctf_field_signed_integer_set_value(self._f, value) | |
2333 | ||
2334 | if ret < 0: | |
2335 | raise ValueError("Could not set integer field value.") | |
2336 | ||
14001277 | 2337 | class EnumerationField(Field): |
ec8c88d7 JG |
2338 | """ |
2339 | Return the enumeration's underlying container field (an integer field). | |
2340 | """ | |
14001277 JG |
2341 | @property |
2342 | def container(self): | |
2343 | container = CTFWriter.IntegerField.__new__(CTFWriter.IntegerField) | |
ec8c88d7 JG |
2344 | container._f = _bt_ctf_field_enumeration_get_container(self._f) |
2345 | if container._f is None: | |
2346 | raise TypeError("Invalid enumeration field type.") | |
2347 | return container | |
2348 | ||
821ca76c JG |
2349 | """ |
2350 | Get the enumeration field's mapping name. | |
2351 | """ | |
2352 | @property | |
2353 | def value(self): | |
2354 | value = _bt_ctf_field_enumeration_get_mapping_name(self._f) | |
2355 | if value is None: | |
2356 | raise ValueError("Could not get enumeration's mapping name.") | |
2357 | return value | |
2358 | ||
2359 | """ | |
2360 | Set the enumeration field's value. Must be an integer as mapping names | |
2361 | may be ambiguous. | |
2362 | """ | |
2363 | @value.setter | |
2364 | def value(self, value): | |
2365 | if not isinstance(value, int): | |
2366 | raise TypeError("EnumerationField value must be an int") | |
2367 | self.container.value = value | |
2368 | ||
14001277 JG |
2369 | class FloatFieldingPoint(Field): |
2370 | """ | |
2371 | Get a floating point field's value. | |
2372 | """ | |
2373 | @property | |
2374 | def value(self): | |
821ca76c JG |
2375 | ret, value = _bt_ctf_field_floating_point_get_value(self._f) |
2376 | if ret < 0: | |
2377 | raise ValueError("Could not get floating point field value.") | |
2378 | return value | |
14001277 | 2379 | |
ec8c88d7 JG |
2380 | """ |
2381 | Set a floating point field's value. | |
2382 | """ | |
14001277 JG |
2383 | @value.setter |
2384 | def value(self, value): | |
821ca76c JG |
2385 | if not isinstance(value, int) and not isinstance(value, float): |
2386 | raise TypeError("Value must be either a float or an int") | |
2387 | ||
14001277 | 2388 | ret = _bt_ctf_field_floating_point_set_value(self._f, float(value)) |
ec8c88d7 JG |
2389 | if ret < 0: |
2390 | raise ValueError("Could not set floating point field value.") | |
2391 | ||
14001277 | 2392 | class StructureField(Field): |
ec8c88d7 JG |
2393 | """ |
2394 | Get the structure's field corresponding to the provided field name. | |
2395 | """ | |
14001277 JG |
2396 | def field(self, field_name): |
2397 | native_instance = _bt_ctf_field_structure_get_field(self._f, str(field_name)) | |
ec8c88d7 JG |
2398 | if native_instance is None: |
2399 | raise ValueError("Invalid field_name provided.") | |
2400 | return CTFWriter.Field._create_field_from_native_instance(native_instance) | |
2401 | ||
14001277 | 2402 | class VariantField(Field): |
ec8c88d7 JG |
2403 | """ |
2404 | Return the variant's selected field. The "tag" field is the selector enum field. | |
2405 | """ | |
14001277 | 2406 | def field(self, tag): |
ec8c88d7 JG |
2407 | native_instance = _bt_ctf_field_variant_get_field(self._f, tag._f) |
2408 | if native_instance is None: | |
2409 | raise ValueError("Invalid tag provided.") | |
2410 | return CTFWriter.Field._create_field_from_native_instance(native_instance) | |
2411 | ||
14001277 | 2412 | class ArrayField(Field): |
ec8c88d7 JG |
2413 | """ |
2414 | Return the array's field at position "index". | |
2415 | """ | |
14001277 | 2416 | def field(self, index): |
ec8c88d7 JG |
2417 | native_instance = _bt_ctf_field_array_get_field(self._f, index) |
2418 | if native_instance is None: | |
2419 | raise IndexError("Invalid index provided.") | |
2420 | return CTFWriter.Field._create_field_from_native_instance(native_instance) | |
2421 | ||
14001277 JG |
2422 | class SequenceField(Field): |
2423 | """ | |
2424 | Get the sequence's length field (IntegerField). | |
2425 | """ | |
2426 | @property | |
2427 | def length(self): | |
821ca76c JG |
2428 | native_instance = _bt_ctf_field_sequence_get_length(self._f) |
2429 | if native_instance is None: | |
2430 | length = -1 | |
2431 | return CTFWriter.Field._create_field_from_native_instance(native_instance) | |
14001277 | 2432 | |
ec8c88d7 JG |
2433 | """ |
2434 | Set the sequence's length field (IntegerField). | |
2435 | """ | |
14001277 JG |
2436 | @length.setter |
2437 | def length(self, length_field): | |
8cea25b5 | 2438 | if not isinstance(length_field, CTFWriter.IntegerField): |
ec8c88d7 | 2439 | raise TypeError("Invalid length field.") |
b4b5e4b5 JG |
2440 | if length_field.declaration.signed: |
2441 | raise TypeError("Sequence field length must be unsigned") | |
8cea25b5 | 2442 | ret = _bt_ctf_field_sequence_set_length(self._f, length_field._f) |
ec8c88d7 JG |
2443 | if ret < 0: |
2444 | raise ValueError("Could not set sequence length.") | |
2445 | ||
2446 | """ | |
2447 | Return the sequence's field at position "index". | |
2448 | """ | |
14001277 | 2449 | def field(self, index): |
ec8c88d7 JG |
2450 | native_instance = _bt_ctf_field_sequence_get_field(self._f, index) |
2451 | if native_instance is None: | |
2452 | raise ValueError("Could not get sequence element at index.") | |
2453 | return CTFWriter.Field._create_field_from_native_instance(native_instance) | |
2454 | ||
14001277 JG |
2455 | class StringField(Field): |
2456 | """ | |
2457 | Get a string field's value. | |
2458 | """ | |
2459 | @property | |
2460 | def value(self): | |
821ca76c | 2461 | return _bt_ctf_field_string_get_value(self._f) |
14001277 | 2462 | |
ec8c88d7 JG |
2463 | """ |
2464 | Set a string field's value. | |
2465 | """ | |
14001277 JG |
2466 | @value.setter |
2467 | def value(self, value): | |
2468 | ret = _bt_ctf_field_string_set_value(self._f, str(value)) | |
ec8c88d7 JG |
2469 | if ret < 0: |
2470 | raise ValueError("Could not set string field value.") | |
2471 | ||
2472 | class EventClass: | |
2473 | """ | |
2474 | Create a new event class of the given name. | |
2475 | """ | |
2476 | def __init__(self, name): | |
2477 | self._ec = _bt_ctf_event_class_create(name) | |
2478 | if self._ec is None: | |
2479 | raise ValueError("Event class creation failed.") | |
2480 | ||
2481 | def __del__(self): | |
2482 | _bt_ctf_event_class_put(self._ec) | |
2483 | ||
2484 | """ | |
2485 | Add a field of type "field_type" to the event class. | |
2486 | """ | |
2487 | def add_field(self, field_type, field_name): | |
14001277 | 2488 | ret = _bt_ctf_event_class_add_field(self._ec, field_type._ft, str(field_name)) |
ec8c88d7 JG |
2489 | if ret < 0: |
2490 | raise ValueError("Could not add field to event class.") | |
2491 | ||
38f28df6 JG |
2492 | """ |
2493 | Get the event class' name. | |
2494 | """ | |
2495 | @property | |
2496 | def name(self): | |
2497 | name = _bt_ctf_event_class_get_name(self._ec) | |
2498 | if name is None: | |
2499 | raise TypeError("Could not get EventClass name") | |
2500 | return name | |
2501 | ||
2502 | """ | |
2503 | Get the event class' id. Returns a negative value if unset. | |
2504 | """ | |
2505 | @property | |
2506 | def id(self): | |
2507 | id = _bt_ctf_event_class_get_id(self._ec) | |
2508 | if id < 0: | |
2509 | raise TypeError("Could not get EventClass name") | |
2510 | return id | |
2511 | ||
2512 | """ | |
2513 | Set the event class' id. Throws a TypeError if the event class | |
2514 | is already registered to a stream class. | |
2515 | """ | |
2516 | @id.setter | |
2517 | def id(self, id): | |
2518 | ret = _bt_ctf_event_class_set_id(self._ec, id) | |
2519 | if ret < 0: | |
2520 | raise TypeError("Can't change an Event Class's id after it has been assigned to a stream class") | |
2521 | ||
2522 | """ | |
2523 | Get the event class' stream class. Returns None if unset. | |
2524 | """ | |
2525 | @property | |
2526 | def stream_class(self): | |
2527 | stream_class_native = _bt_ctf_event_class_get_stream_class(self._ec) | |
2528 | if stream_class_native is None: | |
2529 | return None | |
2530 | stream_class = CTFWriter.StreamClass.__new__(CTFWriter.StreamClass) | |
2531 | stream_class._sc = stream_class_native | |
2532 | return stream_class | |
2533 | ||
2534 | """ | |
2535 | Generator returning the event class' fields as tuples of (field name, field declaration). | |
2536 | """ | |
2537 | @property | |
2538 | def fields(self): | |
2539 | count = _bt_ctf_event_class_get_field_count(self._ec) | |
2540 | if count < 0: | |
2541 | raise TypeError("Could not get EventClass' field count") | |
2542 | ||
2543 | for i in range(count): | |
2544 | field_name = _bt_python_ctf_event_class_get_field_name(self._ec, i) | |
2545 | if field_name is None: | |
2546 | raise TypeError("Could not get EventClass' field name at index {}".format(i)) | |
2547 | ||
2548 | field_type_native = _bt_python_ctf_event_class_get_field_type(self._ec, i) | |
2549 | if field_type_native is None: | |
2550 | raise TypeError("Could not get EventClass' field type at index {}".format(i)) | |
2551 | ||
2552 | field_type = CTFWriter.FieldDeclaration._create_field_declaration_from_native_instance(field_type_native) | |
2553 | yield (field_name, field_type) | |
2554 | ||
2555 | """ | |
2556 | Get a field declaration by name (FieldDeclaration). | |
2557 | """ | |
2558 | def get_field_by_name(self, name): | |
2559 | field_type_native = _bt_ctf_event_class_get_field_by_name(self._ec, name) | |
2560 | if field_type_native is None: | |
2561 | raise TypeError("Could not find EventClass field with name {}".format(name)) | |
2562 | return CTFWriter.FieldDeclaration._create_field_declaration_from_native_instance(field_type_native) | |
2563 | ||
ec8c88d7 JG |
2564 | class Event: |
2565 | """ | |
2566 | Create a new event of the given event class. | |
2567 | """ | |
2568 | def __init__(self, event_class): | |
2569 | if not isinstance(event_class, CTFWriter.EventClass): | |
2570 | raise TypeError("Invalid event_class argument.") | |
2571 | ||
2572 | self._e = _bt_ctf_event_create(event_class._ec) | |
2573 | if self._e is None: | |
2574 | raise ValueError("Event creation failed.") | |
2575 | ||
2576 | def __del__(self): | |
2577 | _bt_ctf_event_put(self._e) | |
2578 | ||
2579 | """ | |
38f28df6 | 2580 | Get the event's class. |
ec8c88d7 | 2581 | """ |
38f28df6 JG |
2582 | @property |
2583 | def event_class(self): | |
2584 | event_class_native = _bt_ctf_event_get_class(self._e) | |
2585 | if event_class_native is None: | |
2586 | return None | |
2587 | event_class = CTFWriter.EventClass.__new__(CTFWriter.EventClass) | |
2588 | event_class._ec = event_class_native | |
2589 | return event_class | |
2590 | ||
2591 | """ | |
2592 | Get a clock from event. Returns None if the event's class | |
2593 | is not registered to a stream class. | |
2594 | """ | |
2595 | def clock(self): | |
2596 | clock_instance = _bt_ctf_event_get_clock(self._e) | |
2597 | if clock_instance is None: | |
2598 | return None | |
2599 | clock = CTFWriter.Clock.__new__(CTFWriter.Clock) | |
2600 | clock._c = clock_instance | |
2601 | return clock | |
ec8c88d7 JG |
2602 | |
2603 | """ | |
14001277 | 2604 | Get a field from event. |
ec8c88d7 | 2605 | """ |
14001277 JG |
2606 | def payload(self, field_name): |
2607 | native_instance = _bt_ctf_event_get_payload(self._e, str(field_name)) | |
ec8c88d7 JG |
2608 | if native_instance is None: |
2609 | raise ValueError("Could not get event payload.") | |
2610 | return CTFWriter.Field._create_field_from_native_instance(native_instance) | |
2611 | ||
38f28df6 JG |
2612 | """ |
2613 | Set a manually created field as an event's payload. | |
2614 | """ | |
2615 | def set_payload(self, field_name, value_field): | |
2616 | if not isinstance(value, CTFWriter.Field): | |
2617 | raise TypeError("Invalid value type.") | |
2618 | ret = _bt_ctf_event_set_payload(self._e, str(field_name), value_field._f) | |
2619 | if ret < 0: | |
2620 | raise ValueError("Could not set event field payload.") | |
2621 | ||
ec8c88d7 JG |
2622 | class StreamClass: |
2623 | """ | |
2624 | Create a new stream class of the given name. | |
2625 | """ | |
2626 | def __init__(self, name): | |
2627 | self._sc = _bt_ctf_stream_class_create(name) | |
2628 | if self._sc is None: | |
2629 | raise ValueError("Stream class creation failed.") | |
2630 | ||
2631 | def __del__(self): | |
2632 | _bt_ctf_stream_class_put(self._sc) | |
2633 | ||
14001277 JG |
2634 | """ |
2635 | Get a stream class' clock. | |
2636 | """ | |
2637 | @property | |
2638 | def clock(self): | |
2639 | raise NotImplementedError("Getter not implemented.") | |
2640 | ||
ec8c88d7 JG |
2641 | """ |
2642 | Assign a clock to a stream class. | |
2643 | """ | |
14001277 JG |
2644 | @clock.setter |
2645 | def clock(self, clock): | |
ec8c88d7 JG |
2646 | if not isinstance(clock, CTFWriter.Clock): |
2647 | raise TypeError("Invalid clock type.") | |
2648 | ||
2649 | ret = _bt_ctf_stream_class_set_clock(self._sc, clock._c) | |
2650 | if ret < 0: | |
2651 | raise ValueError("Could not set stream class clock.") | |
2652 | ||
2653 | """ | |
2654 | Add an event class to a stream class. New events can be added even after a | |
14001277 | 2655 | stream has been instantiated and events have been appended. However, a stream |
ec8c88d7 JG |
2656 | will not accept events of a class that has not been registered beforehand. |
2657 | """ | |
2658 | def add_event_class(self, event_class): | |
2659 | if not isinstance(event_class, CTFWriter.EventClass): | |
2660 | raise TypeError("Invalid event_class type.") | |
2661 | ||
2662 | ret = _bt_ctf_stream_class_add_event_class(self._sc, event_class._ec) | |
2663 | if ret < 0: | |
2664 | raise ValueError("Could not add event class.") | |
2665 | ||
2666 | class Stream: | |
2667 | """ | |
2668 | Create a stream of the given class. | |
2669 | """ | |
2670 | def __init__(self, stream_class): | |
2671 | if not isinstance(stream_class, CTFWriter.StreamClass): | |
2672 | raise TypeError("Invalid stream_class type.") | |
2673 | ||
2674 | self._s = _bt_ctf_stream_create(stream_class._sc) | |
2675 | if self._s is None: | |
2676 | raise ValueError("Stream creation failed.") | |
2677 | ||
2678 | def __del__(self): | |
2679 | _bt_ctf_stream_put(self._s) | |
2680 | ||
2681 | """ | |
2682 | Increase the current packet's discarded event count. | |
2683 | """ | |
2684 | def append_discarded_events(self, event_count): | |
92757c30 | 2685 | _bt_ctf_stream_append_discarded_events(self._s, event_count) |
ec8c88d7 JG |
2686 | |
2687 | """ | |
2688 | Append "event" to the stream's current packet. The stream's associated clock | |
2689 | will be sampled during this call. The event shall not be modified after | |
2690 | being appended to a stream. | |
2691 | """ | |
2692 | def append_event(self, event): | |
2693 | ret = _bt_ctf_stream_append_event(self._s, event._e) | |
2694 | if ret < 0: | |
2695 | raise ValueError("Could not append event to stream.") | |
2696 | ||
2697 | """ | |
2698 | The stream's current packet's events will be flushed to disk. Events | |
2699 | subsequently appended to the stream will be added to a new packet. | |
2700 | """ | |
2701 | def flush(self): | |
2702 | ret = _bt_ctf_stream_flush(self._s) | |
2703 | if ret < 0: | |
2704 | raise ValueError("Could not flush stream.") | |
2705 | ||
2706 | class Writer: | |
2707 | """ | |
2708 | Create a new writer that will produce a trace in the given path. | |
2709 | """ | |
2710 | def __init__(self, path): | |
2711 | self._w = _bt_ctf_writer_create(path) | |
2712 | if self._w is None: | |
2713 | raise ValueError("Writer creation failed.") | |
2714 | ||
2715 | def __del__(self): | |
2716 | _bt_ctf_writer_put(self._w) | |
2717 | ||
2718 | """ | |
2719 | Create a new stream instance and register it to the writer. | |
2720 | """ | |
2721 | def create_stream(self, stream_class): | |
2722 | if not isinstance(stream_class, CTFWriter.StreamClass): | |
2723 | raise TypeError("Invalid stream_class type.") | |
2724 | ||
2725 | stream = CTFWriter.Stream.__new__(CTFWriter.Stream) | |
2726 | stream._s = _bt_ctf_writer_create_stream(self._w, stream_class._sc) | |
2727 | return stream | |
2728 | ||
2729 | """ | |
2730 | Add an environment field to the trace. | |
2731 | """ | |
2732 | def add_environment_field(self, name, value): | |
14001277 | 2733 | ret = _bt_ctf_writer_add_environment_field(self._w, str(name), str(value)) |
ec8c88d7 JG |
2734 | if ret < 0: |
2735 | raise ValueError("Could not add environment field to trace.") | |
2736 | ||
2737 | """ | |
2738 | Add a clock to the trace. Clocks assigned to stream classes must be | |
2739 | registered to the writer. | |
2740 | """ | |
2741 | def add_clock(self, clock): | |
2742 | ret = _bt_ctf_writer_add_clock(self._w, clock._c) | |
2743 | if ret < 0: | |
2744 | raise ValueError("Could not add clock to Writer.") | |
2745 | ||
2746 | """ | |
2747 | Get the trace's TSDL meta-data. | |
2748 | """ | |
14001277 JG |
2749 | @property |
2750 | def metadata(self): | |
ec8c88d7 JG |
2751 | return _bt_ctf_writer_get_metadata_string(self._w) |
2752 | ||
2753 | """ | |
2754 | Flush the trace's metadata to the metadata file. | |
2755 | """ | |
2756 | def flush_metadata(self): | |
2757 | _bt_ctf_writer_flush_metadata(self._w) | |
2758 | ||
14001277 JG |
2759 | """ |
2760 | Get the trace's byte order. Must be a constant from the ByteOrder | |
2761 | class. | |
2762 | """ | |
2763 | @property | |
2764 | def byte_order(self): | |
2765 | raise NotImplementedError("Getter not implemented.") | |
2766 | ||
ec8c88d7 JG |
2767 | """ |
2768 | Set the trace's byte order. Must be a constant from the ByteOrder | |
2769 | class. Defaults to BYTE_ORDER_NATIVE, the host machine's endianness. | |
2770 | """ | |
14001277 JG |
2771 | @byte_order.setter |
2772 | def byte_order(self, byte_order): | |
ec8c88d7 JG |
2773 | ret = _bt_ctf_writer_set_byte_order(self._w, byte_order) |
2774 | if ret < 0: | |
2775 | raise ValueError("Could not set trace's byte order.") | |
2776 | ||
2777 | %} |