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

   1 #ifndef BABELTRACE_TRACE_IR_TRACE_CONST_H
   2 #define BABELTRACE_TRACE_IR_TRACE_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;
  41 struct bt_stream;
  42 struct bt_stream_class;
  43 struct bt_field_class;
  44 struct bt_value;
  45
  46 typedef void (* bt_trace_is_static_listener_func)(const struct bt_trace *trace,
  47                 void *data);
  48
  49 typedef void (* bt_trace_listener_removed_func)(const struct bt_trace *trace,
  50                 void *data);
  51
  52 extern bt_bool bt_trace_assigns_automatic_stream_class_id(
  53                 const struct bt_trace *trace);
  54
  55 extern const char *bt_trace_get_name(const struct bt_trace *trace);
  56
  57 extern bt_uuid bt_trace_get_uuid(const struct bt_trace *trace);
  58
  59 extern uint64_t bt_trace_get_environment_entry_count(
  60                 const struct bt_trace *trace);
  61
  62 extern void bt_trace_borrow_environment_entry_by_index_const(
  63                 const struct bt_trace *trace, uint64_t index,
  64                 const char **name, const struct bt_value **value);
  65
  66 extern const struct bt_value *
  67 bt_trace_borrow_environment_entry_value_by_name_const(
  68                 const struct bt_trace *trace, const char *name);
  69
  70 extern const struct bt_field_class *
  71 bt_trace_borrow_packet_header_field_class_const(
  72                 const struct bt_trace *trace);
  73
  74 extern uint64_t bt_trace_get_stream_class_count(const struct bt_trace *trace);
  75
  76 extern const struct bt_stream_class *
  77 bt_trace_borrow_stream_class_by_index_const(const struct bt_trace *trace,
  78                 uint64_t index);
  79
  80 extern const struct bt_stream_class *bt_trace_borrow_stream_class_by_id_const(
  81                 const struct bt_trace *trace, uint64_t id);
  82
  83 extern uint64_t bt_trace_get_stream_count(const struct bt_trace *trace);
  84
  85 extern const struct bt_stream *bt_trace_borrow_stream_by_index_const(
  86                 const struct bt_trace *trace, uint64_t index);
  87
  88 extern const struct bt_stream *bt_trace_borrow_stream_by_id_const(
  89                 const struct bt_trace *trace, uint64_t id);
  90
  91 extern bt_bool bt_trace_is_static(const struct bt_trace *trace);
  92
  93 extern int bt_trace_add_is_static_listener(const struct bt_trace *trace,
  94                 bt_trace_is_static_listener_func listener,
  95                 bt_trace_listener_removed_func listener_removed, void *data,
  96                 uint64_t *listener_id);
  97
  98 extern int bt_trace_remove_is_static_listener(const struct bt_trace *trace,
  99                 uint64_t listener_id);
 100
 101 #ifdef __cplusplus
 102 }
 103 #endif
 104
 105 #endif /* BABELTRACE_TRACE_IR_TRACE_CONST_H */