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

   1 #ifndef BABELTRACE_TRACE_IR_STREAM_CLASS_H
   2 #define BABELTRACE_TRACE_IR_STREAM_CLASS_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Permission is hereby granted, free of charge, to any person obtaining a copy
   9  * of this software and associated documentation files (the "Software"), to deal
  10  * in the Software without restriction, including without limitation the rights
  11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12  * copies of the Software, and to permit persons to whom the Software is
  13  * furnished to do so, subject to the following conditions:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  24  * SOFTWARE.
  25  *
  26  * The Common Trace Format (CTF) Specification is available at
  27  * http://www.efficios.com/ctf
  28  */
  29
  30 #include <stdint.h>
  31
  32 /* For bt_bool */
  33 #include <babeltrace/types.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 struct bt_trace_class;
  40 struct bt_stream_class;
  41 struct bt_event_class;
  42 struct bt_clock_class;
  43
  44 extern struct bt_stream_class *bt_stream_class_create(
  45                 struct bt_trace_class *trace_class);
  46
  47 extern struct bt_stream_class *bt_stream_class_create_with_id(
  48                 struct bt_trace_class *trace_class, uint64_t id);
  49
  50 extern struct bt_trace_class *bt_stream_class_borrow_trace_class(
  51                 struct bt_stream_class *stream_class);
  52
  53 extern int bt_stream_class_set_name(struct bt_stream_class *stream_class,
  54                 const char *name);
  55
  56 extern void bt_stream_class_set_assigns_automatic_event_class_id(
  57                 struct bt_stream_class *stream_class, bt_bool value);
  58
  59 extern void bt_stream_class_set_assigns_automatic_stream_id(
  60                 struct bt_stream_class *stream_class, bt_bool value);
  61
  62 extern int bt_stream_class_set_packet_context_field_class(
  63                 struct bt_stream_class *stream_class,
  64                 struct bt_field_class *field_class);
  65
  66 extern int bt_stream_class_set_event_header_field_class(
  67                 struct bt_stream_class *stream_class,
  68                 struct bt_field_class *field_class);
  69
  70 extern int
  71 bt_stream_class_set_event_common_context_field_class(
  72                 struct bt_stream_class *stream_class,
  73                 struct bt_field_class *field_class);
  74
  75 extern struct bt_event_class *
  76 bt_stream_class_borrow_event_class_by_index(
  77                 struct bt_stream_class *stream_class, uint64_t index);
  78
  79 extern struct bt_event_class *
  80 bt_stream_class_borrow_event_class_by_id(
  81                 struct bt_stream_class *stream_class, uint64_t id);
  82
  83 extern struct bt_clock_class *bt_stream_class_borrow_default_clock_class(
  84                 struct bt_stream_class *stream_class);
  85
  86 extern int bt_stream_class_set_default_clock_class(
  87                 struct bt_stream_class *stream_class,
  88                 struct bt_clock_class *clock_class);
  89
  90 extern void
  91 bt_stream_class_set_packets_have_discarded_event_counter_snapshot(
  92                 struct bt_stream_class *stream_class, bt_bool value);
  93
  94 extern void
  95 bt_stream_class_set_packets_have_packet_counter_snapshot(
  96                 struct bt_stream_class *stream_class, bt_bool value);
  97
  98 extern void
  99 bt_stream_class_set_packets_have_default_beginning_clock_value(
 100                 struct bt_stream_class *stream_class, bt_bool value);
 101
 102 extern void
 103 bt_stream_class_set_packets_have_default_end_clock_value(
 104                 struct bt_stream_class *stream_class, bt_bool value);
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif
 109
 110 #endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_H */