include/babeltrace/ctf-writer/trace.h

   1 #ifndef BABELTRACE_CTF_WRITER_TRACE_H
   2 #define BABELTRACE_CTF_WRITER_TRACE_H
   3
   4 /*
   5  * Copyright 2014 EfficiOS Inc.
   6  *
   7  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  *
  27  * The Common Trace Format (CTF) Specification is available at
  28  * http://www.efficios.com/ctf
  29  */
  30
  31 #ifdef __cplusplus
  32 extern "C" {
  33 #endif
  34
  35 struct bt_ctf_trace;
  36 struct bt_ctf_stream_class;
  37 struct bt_ctf_stream;
  38
  39 extern enum bt_ctf_byte_order bt_ctf_trace_get_native_byte_order(
  40                 struct bt_ctf_trace *trace);
  41
  42 extern int bt_ctf_trace_set_native_byte_order(struct bt_ctf_trace *trace,
  43                 enum bt_ctf_byte_order native_byte_order);
  44
  45 extern const unsigned char *bt_ctf_trace_get_uuid(
  46                 struct bt_ctf_trace *trace);
  47
  48 extern int bt_ctf_trace_set_uuid(struct bt_ctf_trace *trace,
  49                 const unsigned char *uuid);
  50
  51 extern int64_t bt_ctf_trace_get_environment_field_count(
  52                 struct bt_ctf_trace *trace);
  53
  54 extern const char *
  55 bt_ctf_trace_get_environment_field_name_by_index(
  56                 struct bt_ctf_trace *trace, uint64_t index);
  57
  58 extern struct bt_value *
  59 bt_ctf_trace_get_environment_field_value_by_index(struct bt_ctf_trace *trace,
  60                 uint64_t index);
  61
  62 extern struct bt_value *
  63 bt_ctf_trace_get_environment_field_value_by_name(
  64                 struct bt_ctf_trace *trace, const char *name);
  65
  66 extern int bt_ctf_trace_set_environment_field_integer(
  67                 struct bt_ctf_trace *trace, const char *name,
  68                 int64_t value);
  69
  70 extern int bt_ctf_trace_set_environment_field_string(
  71                 struct bt_ctf_trace *trace, const char *name,
  72                 const char *value);
  73
  74 extern struct bt_ctf_field_type *bt_ctf_trace_get_packet_header_field_type(
  75                 struct bt_ctf_trace *trace);
  76
  77 extern int bt_ctf_trace_set_packet_header_field_type(struct bt_ctf_trace *trace,
  78                 struct bt_ctf_field_type *packet_header_type);
  79
  80 extern int64_t bt_ctf_trace_get_stream_class_count(
  81                 struct bt_ctf_trace *trace);
  82
  83 extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_index(
  84                 struct bt_ctf_trace *trace, uint64_t index);
  85
  86 extern struct bt_ctf_stream_class *bt_ctf_trace_get_stream_class_by_id(
  87                 struct bt_ctf_trace *trace, uint64_t id);
  88
  89 extern int bt_ctf_trace_add_stream_class(struct bt_ctf_trace *trace,
  90                 struct bt_ctf_stream_class *stream_class);
  91
  92 extern int64_t bt_ctf_trace_get_stream_count(struct bt_ctf_trace *trace);
  93
  94 extern struct bt_ctf_stream *bt_ctf_trace_get_stream_by_index(
  95                 struct bt_ctf_trace *trace, uint64_t index);
  96
  97 extern const char *bt_ctf_trace_get_name(struct bt_ctf_trace *trace);
  98
  99 #ifdef __cplusplus
 100 }
 101 #endif
 102
 103 #endif /* BABELTRACE_CTF_WRITER_TRACE_H */