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

   1 #ifndef BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_H
   2 #define BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_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_trace;
  41 struct bt_stream_class;
  42 struct bt_event_class;
  43 struct bt_clock_class;
  44 struct bt_event_header_field;
  45 struct bt_packet_context_field;
  46
  47 extern const struct bt_trace *bt_stream_class_borrow_trace_const(
  48                 const struct bt_stream_class *stream_class);
  49
  50 extern const char *bt_stream_class_get_name(
  51                 const struct bt_stream_class *stream_class);
  52
  53 extern bt_bool bt_stream_class_assigns_automatic_event_class_id(
  54                 const struct bt_stream_class *stream_class);
  55
  56 extern bt_bool bt_stream_class_assigns_automatic_stream_id(
  57                 const struct bt_stream_class *stream_class);
  58
  59 extern uint64_t bt_stream_class_get_id(
  60                 const struct bt_stream_class *stream_class);
  61
  62 extern const struct bt_field_class *
  63 bt_stream_class_borrow_packet_context_field_class_const(
  64                 const struct bt_stream_class *stream_class);
  65
  66 extern const struct bt_field_class *
  67 bt_stream_class_borrow_event_header_field_class_const(
  68                 const struct bt_stream_class *stream_class);
  69
  70 extern const struct bt_field_class *
  71 bt_stream_class_borrow_event_common_context_field_class_const(
  72                 const struct bt_stream_class *stream_class);
  73
  74 extern uint64_t bt_stream_class_get_event_class_count(
  75                 const struct bt_stream_class *stream_class);
  76
  77 extern const struct bt_event_class *
  78 bt_stream_class_borrow_event_class_by_index_const(
  79                 const struct bt_stream_class *stream_class, uint64_t index);
  80
  81 extern const struct bt_event_class *
  82 bt_stream_class_borrow_event_class_by_id_const(
  83                 const struct bt_stream_class *stream_class, uint64_t id);
  84
  85 extern const struct bt_clock_class *
  86 bt_stream_class_borrow_default_clock_class_const(
  87                 const struct bt_stream_class *stream_class);
  88
  89 extern bt_bool bt_stream_class_default_clock_is_always_known(
  90                 const struct bt_stream_class *stream_class);
  91
  92 extern bt_bool bt_stream_class_packets_have_discarded_event_counter_snapshot(
  93                 const struct bt_stream_class *stream_class);
  94
  95 extern bt_bool bt_stream_class_packets_have_packet_counter_snapshot(
  96                 const struct bt_stream_class *stream_class);
  97
  98 extern bt_bool bt_stream_class_packets_have_default_beginning_clock_value(
  99                 const struct bt_stream_class *stream_class);
 100
 101 extern bt_bool bt_stream_class_packets_have_default_end_clock_value(
 102                 const struct bt_stream_class *stream_class);
 103
 104 #ifdef __cplusplus
 105 }
 106 #endif
 107
 108 #endif /* BABELTRACE_TRACE_IR_STREAM_CLASS_CONST_H */