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