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

   1 #ifndef BABELTRACE_TRACE_IR_PRIVATE_TRACE_H
   2 #define BABELTRACE_TRACE_IR_PRIVATE_TRACE_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_private_trace;
  42 struct bt_private_stream;
  43 struct bt_private_stream_class;
  44 struct bt_private_field_class;
  45 struct bt_value;
  46 struct bt_private_packet_header_field;
  47
  48 typedef void (* bt_private_trace_is_static_listener)(
  49         struct bt_private_trace *trace, void *data);
  50
  51 typedef void (* bt_private_trace_listener_removed)(
  52         struct bt_private_trace *trace, void *data);
  53
  54 static inline
  55 struct bt_trace *bt_private_trace_as_trace(
  56                 struct bt_private_trace *priv_trace)
  57 {
  58         return (void *) priv_trace;
  59 }
  60
  61 extern struct bt_private_trace *bt_private_trace_create(void);
  62
  63 extern void bt_private_trace_set_assigns_automatic_stream_class_id(
  64                 struct bt_private_trace *trace, bt_bool value);
  65
  66 extern int bt_private_trace_set_name(struct bt_private_trace *trace,
  67                 const char *name);
  68
  69 extern void bt_private_trace_set_uuid(struct bt_private_trace *trace,
  70                 bt_uuid uuid);
  71
  72 extern void bt_private_trace_borrow_environment_entry_by_index(
  73                 struct bt_private_trace *trace, uint64_t index,
  74                 const char **name, const struct bt_value **value);
  75
  76 extern const struct bt_value *
  77 bt_private_trace_borrow_environment_entry_value_by_name(
  78                 struct bt_private_trace *trace, const char *name);
  79
  80 extern int bt_private_trace_set_environment_entry_integer(
  81                 struct bt_private_trace *trace, const char *name,
  82                 int64_t value);
  83
  84 extern int bt_private_trace_set_environment_entry_string(
  85                 struct bt_private_trace *trace, const char *name,
  86                 const char *value);
  87
  88 extern struct bt_private_field_class *
  89 bt_private_trace_borrow_packet_header_field_class(
  90                 struct bt_private_trace *trace);
  91
  92 extern int bt_private_trace_set_packet_header_field_class(
  93                 struct bt_private_trace *trace,
  94                 struct bt_private_field_class *packet_header_field_class);
  95
  96 extern struct bt_private_stream_class *
  97 bt_private_trace_borrow_stream_class_by_index(
  98                 struct bt_private_trace *trace, uint64_t index);
  99
 100 extern struct bt_private_stream_class *
 101 bt_private_trace_borrow_stream_class_by_id(
 102                 struct bt_private_trace *trace, uint64_t id);
 103
 104 extern struct bt_private_stream *
 105 bt_private_trace_borrow_stream_by_index(
 106                 struct bt_private_trace *trace, uint64_t index);
 107
 108 extern struct bt_private_stream *bt_private_trace_borrow_stream_by_id(
 109                 struct bt_private_trace *trace, uint64_t id);
 110
 111 extern int bt_private_trace_make_static(struct bt_private_trace *trace);
 112
 113 extern int bt_private_trace_add_is_static_listener(
 114                 struct bt_private_trace *trace,
 115                 bt_private_trace_is_static_listener listener,
 116                 bt_private_trace_listener_removed listener_removed, void *data,
 117                 uint64_t *listener_id);
 118
 119 extern int bt_private_trace_remove_is_static_listener(
 120                 struct bt_private_trace *trace, uint64_t listener_id);
 121
 122 #ifdef __cplusplus
 123 }
 124 #endif
 125
 126 #endif /* BABELTRACE_TRACE_IR_PRIVATE_TRACE_H */