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