include/babeltrace/ctf-ir/stream-class.h

   1 #ifndef BABELTRACE_CTF_IR_STREAM_CLASS_H
   2 #define BABELTRACE_CTF_IR_STREAM_CLASS_H
   3
   4 /*
   5  * BabelTrace - CTF IR: Stream Class
   6  *
   7  * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  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  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The Common Trace Format (CTF) Specification is available at
  30  * http://www.efficios.com/ctf
  31  */
  32
  33 #include <stdint.h>
  34
  35 /* For bt_bool */
  36 #include <babeltrace/types.h>
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 struct bt_trace;
  43 struct bt_stream_class;
  44 struct bt_event_class;
  45 struct bt_clock_class;
  46 struct bt_event_header_field;
  47 struct bt_packet_context_field;
  48
  49 extern struct bt_stream_class *bt_stream_class_create(struct bt_trace *trace);
  50
  51 extern struct bt_stream_class *bt_stream_class_create_with_id(
  52                 struct bt_trace *trace, uint64_t id);
  53
  54 extern struct bt_trace *bt_stream_class_borrow_trace(
  55                 struct bt_stream_class *stream_class);
  56
  57 extern const char *bt_stream_class_get_name(
  58                 struct bt_stream_class *stream_class);
  59
  60 extern int bt_stream_class_set_name(struct bt_stream_class *stream_class,
  61                 const char *name);
  62
  63 extern bt_bool bt_stream_class_assigns_automatic_event_class_id(
  64                 struct bt_stream_class *stream_class);
  65
  66 extern int bt_stream_class_set_assigns_automatic_event_class_id(
  67                 struct bt_stream_class *stream_class, bt_bool value);
  68
  69 extern bt_bool bt_stream_class_assigns_automatic_stream_id(
  70                 struct bt_stream_class *stream_class);
  71
  72 extern int bt_stream_class_set_assigns_automatic_stream_id(
  73                 struct bt_stream_class *stream_class, bt_bool value);
  74
  75 extern uint64_t bt_stream_class_get_id(struct bt_stream_class *stream_class);
  76
  77 extern struct bt_field_type *bt_stream_class_borrow_packet_context_field_type(
  78                 struct bt_stream_class *stream_class);
  79
  80 extern int bt_stream_class_set_packet_context_field_type(
  81                 struct bt_stream_class *stream_class,
  82                 struct bt_field_type *field_type);
  83
  84 extern struct bt_field_type *
  85 bt_stream_class_borrow_event_header_field_type(
  86                 struct bt_stream_class *stream_class);
  87
  88 extern int bt_stream_class_set_event_header_field_type(
  89                 struct bt_stream_class *stream_class,
  90                 struct bt_field_type *field_type);
  91
  92 extern struct bt_field_type *
  93 bt_stream_class_borrow_event_common_context_field_type(
  94                 struct bt_stream_class *stream_class);
  95
  96 extern int bt_stream_class_set_event_common_context_field_type(
  97                 struct bt_stream_class *stream_class,
  98                 struct bt_field_type *field_type);
  99
 100 extern uint64_t bt_stream_class_get_event_class_count(
 101                 struct bt_stream_class *stream_class);
 102
 103 extern struct bt_event_class *bt_stream_class_borrow_event_class_by_index(
 104                 struct bt_stream_class *stream_class, uint64_t index);
 105
 106 extern struct bt_event_class *bt_stream_class_borrow_event_class_by_id(
 107                 struct bt_stream_class *stream_class, uint64_t id);
 108
 109 extern int bt_stream_class_set_default_clock_class(
 110                 struct bt_stream_class *stream_class,
 111                 struct bt_clock_class *clock_class);
 112
 113 extern struct bt_clock_class *bt_stream_class_borrow_default_clock_class(
 114                 struct bt_stream_class *stream_class);
 115
 116 extern bt_bool bt_stream_class_default_clock_is_always_known(
 117                 struct bt_stream_class *stream_class);
 118
 119 extern bt_bool bt_stream_class_packets_have_discarded_event_counter_snapshot(
 120                 struct bt_stream_class *stream_class);
 121
 122 extern int bt_stream_class_set_packets_have_discarded_event_counter_snapshot(
 123                 struct bt_stream_class *stream_class, bt_bool value);
 124
 125 extern bt_bool bt_stream_class_packets_have_packet_counter_snapshot(
 126                 struct bt_stream_class *stream_class);
 127
 128 extern int bt_stream_class_set_packets_have_packet_counter_snapshot(
 129                 struct bt_stream_class *stream_class, bt_bool value);
 130
 131 extern bt_bool bt_stream_class_packets_have_default_beginning_clock_value(
 132                 struct bt_stream_class *stream_class);
 133
 134 extern int bt_stream_class_set_packets_have_default_beginning_clock_value(
 135                 struct bt_stream_class *stream_class, bt_bool value);
 136
 137 extern bt_bool bt_stream_class_packets_have_default_end_clock_value(
 138                 struct bt_stream_class *stream_class);
 139
 140 extern int bt_stream_class_set_packets_have_default_end_clock_value(
 141                 struct bt_stream_class *stream_class, bt_bool value);
 142
 143 #ifdef __cplusplus
 144 }
 145 #endif
 146
 147 #endif /* BABELTRACE_CTF_IR_STREAM_CLASS_H */