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

   1 #ifndef BABELTRACE_TRACE_IR_PRIVATE_STREAM_CLASS_H
   2 #define BABELTRACE_TRACE_IR_PRIVATE_STREAM_CLASS_H
   3
   4 /*
   5  * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   6  *
   7  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  *
  27  * The Common Trace Format (CTF) Specification is available at
  28  * http://www.efficios.com/ctf
  29  */
  30
  31 #include <stdint.h>
  32
  33 /* For bt_bool */
  34 #include <babeltrace/types.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 struct bt_stream_class;
  41 struct bt_private_stream_class;
  42 struct bt_private_trace;
  43 struct bt_private_event_class;
  44 struct bt_private_clock_class;
  45
  46 static inline
  47 struct bt_stream_class *bt_private_stream_class_as_stream_class(
  48                 struct bt_private_stream_class *priv_stream_class)
  49 {
  50         return (void *) priv_stream_class;
  51 }
  52
  53 extern struct bt_private_stream_class *bt_private_stream_class_create(
  54                 struct bt_private_trace *trace);
  55
  56 extern struct bt_private_stream_class *bt_private_stream_class_create_with_id(
  57                 struct bt_private_trace *trace, uint64_t id);
  58
  59 extern struct bt_private_trace *bt_private_stream_class_borrow_trace(
  60                 struct bt_private_stream_class *stream_class);
  61
  62 extern int bt_private_stream_class_set_name(
  63                 struct bt_private_stream_class *stream_class,
  64                 const char *name);
  65
  66 extern void bt_private_stream_class_set_assigns_automatic_event_class_id(
  67                 struct bt_private_stream_class *stream_class, bt_bool value);
  68
  69 extern void bt_private_stream_class_set_assigns_automatic_stream_id(
  70                 struct bt_private_stream_class *stream_class, bt_bool value);
  71
  72 extern struct bt_private_field_class *
  73 bt_private_stream_class_borrow_packet_context_field_class(
  74                 struct bt_private_stream_class *stream_class);
  75
  76 extern int bt_private_stream_class_set_packet_context_field_class(
  77                 struct bt_private_stream_class *stream_class,
  78                 struct bt_private_field_class *field_class);
  79
  80 extern struct bt_private_field_class *
  81 bt_private_stream_class_borrow_event_header_field_class(
  82                 struct bt_private_stream_class *stream_class);
  83
  84 extern int bt_private_stream_class_set_event_header_field_class(
  85                 struct bt_private_stream_class *stream_class,
  86                 struct bt_private_field_class *field_class);
  87
  88 extern struct bt_private_field_class *
  89 bt_private_stream_class_borrow_event_common_context_field_class(
  90                 struct bt_private_stream_class *stream_class);
  91
  92 extern int
  93 bt_private_stream_class_set_event_common_context_field_class(
  94                 struct bt_private_stream_class *stream_class,
  95                 struct bt_private_field_class *field_class);
  96
  97 extern struct bt_private_event_class *
  98 bt_private_stream_class_borrow_event_class_by_index(
  99                 struct bt_private_stream_class *stream_class, uint64_t index);
 100
 101 extern struct bt_private_event_class *
 102 bt_private_stream_class_borrow_event_class_by_id(
 103                 struct bt_private_stream_class *stream_class, uint64_t id);
 104
 105 extern int bt_private_stream_class_set_default_clock_class(
 106                 struct bt_private_stream_class *stream_class,
 107                 struct bt_clock_class *clock_class);
 108
 109 extern bt_bool bt_private_stream_class_default_clock_is_always_known(
 110                 struct bt_private_stream_class *stream_class);
 111
 112 extern void
 113 bt_private_stream_class_set_packets_have_discarded_event_counter_snapshot(
 114                 struct bt_private_stream_class *stream_class, bt_bool value);
 115
 116 extern void
 117 bt_private_stream_class_set_packets_have_packet_counter_snapshot(
 118                 struct bt_private_stream_class *stream_class, bt_bool value);
 119
 120 extern void
 121 bt_private_stream_class_set_packets_have_default_beginning_clock_value(
 122                 struct bt_private_stream_class *stream_class, bt_bool value);
 123
 124 extern void
 125 bt_private_stream_class_set_packets_have_default_end_clock_value(
 126                 struct bt_private_stream_class *stream_class, bt_bool value);
 127
 128 #ifdef __cplusplus
 129 }
 130 #endif
 131
 132 #endif /* BABELTRACE_TRACE_IR_PRIVATE_STREAM_CLASS_H */