bindings/python/bt2/native_btctfwriter.i

   1 /*
   2  * The MIT License (MIT)
   3  *
   4  * Copyright (c) 2016 Philippe Proulx <pproulx@efficios.com>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24
  25 %{
  26 #include <babeltrace/ctf-writer/clock.h>
  27 #include <babeltrace/ctf-writer/stream.h>
  28 #include <babeltrace/ctf-writer/stream-class.h>
  29 #include <babeltrace/ctf-writer/writer.h>
  30 %}
  31
  32 /* Types */
  33 struct bt_ctf_clock;
  34 struct bt_ctf_writer;
  35
  36 /* Clock functions */
  37 struct bt_ctf_clock *bt_ctf_clock_create(const char *name);
  38 const char *bt_ctf_clock_get_name(struct bt_ctf_clock *clock);
  39 const char *bt_ctf_clock_get_description(struct bt_ctf_clock *clock);
  40 int bt_ctf_clock_set_description(struct bt_ctf_clock *clock,
  41                 const char *desc);
  42 uint64_t bt_ctf_clock_get_frequency(struct bt_ctf_clock *clock);
  43 int bt_ctf_clock_set_frequency(struct bt_ctf_clock *clock,
  44                 uint64_t freq);
  45 uint64_t bt_ctf_clock_get_precision(struct bt_ctf_clock *clock);
  46 int bt_ctf_clock_set_precision(struct bt_ctf_clock *clock,
  47                 uint64_t precision);
  48 int bt_ctf_clock_get_offset_s(struct bt_ctf_clock *clock,
  49                 int64_t *OUTPUT);
  50 int bt_ctf_clock_set_offset_s(struct bt_ctf_clock *clock,
  51                 int64_t offset_s);
  52 int bt_ctf_clock_get_offset(struct bt_ctf_clock *clock,
  53                 int64_t *OUTPUT);
  54 int bt_ctf_clock_set_offset(struct bt_ctf_clock *clock,
  55                 int64_t offset);
  56 int bt_ctf_clock_get_is_absolute(struct bt_ctf_clock *clock);
  57 int bt_ctf_clock_set_is_absolute(struct bt_ctf_clock *clock,
  58                 int is_absolute);
  59 BTUUID bt_ctf_clock_get_uuid(struct bt_ctf_clock *clock);
  60 int bt_ctf_clock_set_uuid(struct bt_ctf_clock *clock,
  61                 BTUUID uuid);
  62 int bt_ctf_clock_set_time(struct bt_ctf_clock *clock,
  63                 int64_t time);
  64
  65 /* Stream functions */
  66 int bt_ctf_stream_get_discarded_events_count(
  67                 struct bt_ctf_stream *stream, uint64_t *OUTPUT);
  68 void bt_ctf_stream_append_discarded_events(struct bt_ctf_stream *stream,
  69                 uint64_t event_count);
  70 int bt_ctf_stream_append_event(struct bt_ctf_stream *stream,
  71                 struct bt_ctf_event *event);
  72 struct bt_ctf_field *bt_ctf_stream_get_packet_header(
  73                 struct bt_ctf_stream *stream);
  74 int bt_ctf_stream_set_packet_header(
  75                 struct bt_ctf_stream *stream,
  76                 struct bt_ctf_field *packet_header);
  77 struct bt_ctf_field *bt_ctf_stream_get_packet_context(
  78                 struct bt_ctf_stream *stream);
  79 int bt_ctf_stream_set_packet_context(
  80                 struct bt_ctf_stream *stream,
  81                 struct bt_ctf_field *packet_context);
  82 int bt_ctf_stream_flush(struct bt_ctf_stream *stream);
  83 int bt_ctf_stream_is_writer(struct bt_ctf_stream *stream);
  84
  85 /* Stream class functions */
  86 int bt_ctf_stream_class_set_clock(
  87                 struct bt_ctf_stream_class *stream_class,
  88                 struct bt_ctf_clock *clock);
  89 struct bt_ctf_clock *bt_ctf_stream_class_get_clock(
  90                 struct bt_ctf_stream_class *stream_class);
  91
  92 /* Writer functions */
  93 struct bt_ctf_writer *bt_ctf_writer_create(const char *path);
  94 struct bt_ctf_trace *bt_ctf_writer_get_trace(
  95                 struct bt_ctf_writer *writer);
  96 int bt_ctf_writer_add_clock(struct bt_ctf_writer *writer,
  97                 struct bt_ctf_clock *clock);
  98 char *bt_ctf_writer_get_metadata_string(struct bt_ctf_writer *writer);
  99 void bt_ctf_writer_flush_metadata(struct bt_ctf_writer *writer);