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

   1 #ifndef BABELTRACE2_TRACE_IR_STREAM_CLASS_H
   2 #define BABELTRACE2_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 #ifndef __BT_IN_BABELTRACE_H
  31 # error "Please include <babeltrace2/babeltrace.h> instead."
  32 #endif
  33
  34 #include <stdint.h>
  35
  36 #include <babeltrace2/types.h>
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 extern bt_stream_class *bt_stream_class_create(
  43                 bt_trace_class *trace_class);
  44
  45 extern bt_stream_class *bt_stream_class_create_with_id(
  46                 bt_trace_class *trace_class, uint64_t id);
  47
  48 extern bt_trace_class *bt_stream_class_borrow_trace_class(
  49                 bt_stream_class *stream_class);
  50
  51 typedef enum bt_stream_class_set_name_status {
  52         BT_STREAM_CLASS_SET_NAME_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
  53         BT_STREAM_CLASS_SET_NAME_STATUS_OK              = __BT_FUNC_STATUS_OK,
  54 } bt_stream_class_set_name_status;
  55
  56 extern bt_stream_class_set_name_status bt_stream_class_set_name(
  57                 bt_stream_class *stream_class, const char *name);
  58
  59 extern void bt_stream_class_set_assigns_automatic_event_class_id(
  60                 bt_stream_class *stream_class, bt_bool value);
  61
  62 extern void bt_stream_class_set_assigns_automatic_stream_id(
  63                 bt_stream_class *stream_class, bt_bool value);
  64
  65 extern void bt_stream_class_set_supports_discarded_events(
  66                 bt_stream_class *stream_class,
  67                 bt_bool supports_discarded_events,
  68                 bt_bool with_default_clock_snapshots);
  69
  70 extern void bt_stream_class_set_supports_discarded_packets(
  71                 bt_stream_class *stream_class,
  72                 bt_bool supports_discarded_packets,
  73                 bt_bool with_default_clock_snapshots);
  74
  75 typedef enum bt_stream_class_set_field_class_status {
  76         BT_STREAM_CLASS_SET_FIELD_CLASS_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
  77         BT_STREAM_CLASS_SET_FIELD_CLASS_STATUS_OK               = __BT_FUNC_STATUS_OK,
  78 } bt_stream_class_set_field_class_status;
  79
  80 extern void bt_stream_class_set_supports_packets(
  81                 bt_stream_class *stream_class, bt_bool supports_packets,
  82                 bt_bool with_beginning_default_clock_snapshot,
  83                 bt_bool with_end_default_clock_snapshot);
  84
  85 extern bt_stream_class_set_field_class_status
  86 bt_stream_class_set_packet_context_field_class(
  87                 bt_stream_class *stream_class,
  88                 bt_field_class *field_class);
  89
  90 extern bt_field_class *
  91 bt_stream_class_borrow_packet_context_field_class(
  92                 bt_stream_class *stream_class);
  93
  94 extern bt_stream_class_set_field_class_status
  95 bt_stream_class_set_event_common_context_field_class(
  96                 bt_stream_class *stream_class,
  97                 bt_field_class *field_class);
  98
  99 extern bt_field_class *
 100 bt_stream_class_borrow_event_common_context_field_class(
 101                 bt_stream_class *stream_class);
 102
 103 extern bt_event_class *
 104 bt_stream_class_borrow_event_class_by_index(
 105                 bt_stream_class *stream_class, uint64_t index);
 106
 107 extern bt_event_class *
 108 bt_stream_class_borrow_event_class_by_id(
 109                 bt_stream_class *stream_class, uint64_t id);
 110
 111 extern bt_clock_class *bt_stream_class_borrow_default_clock_class(
 112                 bt_stream_class *stream_class);
 113
 114 typedef enum bt_stream_class_set_default_clock_class_status {
 115         BT_STREAM_CLASS_SET_DEFAULT_CLOCK_CLASS_STATUS_OK       = __BT_FUNC_STATUS_OK,
 116 } bt_stream_class_set_default_clock_class_status;
 117
 118 extern bt_stream_class_set_default_clock_class_status
 119 bt_stream_class_set_default_clock_class(
 120                 bt_stream_class *stream_class,
 121                 bt_clock_class *clock_class);
 122
 123 #ifdef __cplusplus
 124 }
 125 #endif
 126
 127 #endif /* BABELTRACE2_TRACE_IR_STREAM_CLASS_H */