include/babeltrace2/trace-ir/trace.h

   1 #ifndef BABELTRACE2_TRACE_IR_TRACE_H
   2 #define BABELTRACE2_TRACE_IR_TRACE_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 #ifndef __BT_IN_BABELTRACE_H
  31 # error "Please include <babeltrace2/babeltrace.h> instead."
  32 #endif
  33
  34 #include <stdint.h>
  35
  36 /* For bt_bool, bt_uuid, bt_trace, bt_trace_class, bt_stream */
  37 #include <babeltrace2/types.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 extern bt_trace_class *bt_trace_borrow_class(bt_trace *trace);
  44
  45 extern bt_trace *bt_trace_create(bt_trace_class *trace_class);
  46
  47 typedef enum bt_trace_set_name_status {
  48         BT_TRACE_SET_NAME_STATUS_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
  49         BT_TRACE_SET_NAME_STATUS_OK             = __BT_FUNC_STATUS_OK,
  50 } bt_trace_set_name_status;
  51
  52 extern bt_trace_set_name_status bt_trace_set_name(bt_trace *trace,
  53                 const char *name);
  54
  55 extern void bt_trace_set_uuid(bt_trace *trace, bt_uuid uuid);
  56
  57 typedef enum bt_trace_set_environment_entry_status {
  58         BT_TRACE_SET_ENVIRONMENT_ENTRY_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
  59         BT_TRACE_SET_ENVIRONMENT_ENTRY_STATUS_OK                = __BT_FUNC_STATUS_OK,
  60 } bt_trace_set_environment_entry_status;
  61
  62 extern bt_trace_set_environment_entry_status
  63 bt_trace_set_environment_entry_integer(bt_trace *trace, const char *name,
  64                 int64_t value);
  65
  66 extern bt_trace_set_environment_entry_status
  67 bt_trace_set_environment_entry_string(bt_trace *trace, const char *name,
  68                 const char *value);
  69
  70 extern bt_stream *bt_trace_borrow_stream_by_index(bt_trace *trace,
  71                 uint64_t index);
  72
  73 extern bt_stream *bt_trace_borrow_stream_by_id(bt_trace *trace,
  74                 uint64_t id);
  75
  76 #ifdef __cplusplus
  77 }
  78 #endif
  79
  80 #endif /* BABELTRACE2_TRACE_IR_TRACE_H */