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

   1 #ifndef BABELTRACE_TRACE_IR_TRACE_CLASS_CONST_H
   2 #define BABELTRACE_TRACE_IR_TRACE_CLASS_CONST_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 /* For bt_bool, bt_uuid */
  31 #include <babeltrace/types.h>
  32
  33 #include <stdint.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 struct bt_trace_class;
  40 struct bt_stream_class;
  41 struct bt_field_class;
  42 struct bt_value;
  43
  44 extern bt_bool bt_trace_class_assigns_automatic_stream_class_id(
  45                 const struct bt_trace_class *trace_class);
  46
  47 extern const char *bt_trace_class_get_name(
  48                 const struct bt_trace_class *trace_class);
  49
  50 extern bt_uuid bt_trace_class_get_uuid(
  51                 const struct bt_trace_class *trace_class);
  52
  53 extern uint64_t bt_trace_class_get_environment_entry_count(
  54                 const struct bt_trace_class *trace_class);
  55
  56 extern void bt_trace_class_borrow_environment_entry_by_index_const(
  57                 const struct bt_trace_class *trace_class, uint64_t index,
  58                 const char **name, const struct bt_value **value);
  59
  60 extern const struct bt_value *
  61 bt_trace_class_borrow_environment_entry_value_by_name_const(
  62                 const struct bt_trace_class *trace_class, const char *name);
  63
  64 extern const struct bt_field_class *
  65 bt_trace_class_borrow_packet_header_field_class_const(
  66                 const struct bt_trace_class *trace_class);
  67
  68 extern uint64_t bt_trace_class_get_stream_class_count(
  69                 const struct bt_trace_class *trace_class);
  70
  71 extern const struct bt_stream_class *
  72 bt_trace_class_borrow_stream_class_by_index_const(
  73                 const struct bt_trace_class *trace_class, uint64_t index);
  74
  75 extern const struct bt_stream_class *bt_trace_class_borrow_stream_class_by_id_const(
  76                 const struct bt_trace_class *trace_class, uint64_t id);
  77
  78 #ifdef __cplusplus
  79 }
  80 #endif
  81
  82 #endif /* BABELTRACE_TRACE_IR_TRACE_CLASS_CONST_H */