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