include/babeltrace2/trace-ir/event-class-const.h

   1 #ifndef BABELTRACE2_TRACE_IR_EVENT_CLASS_CONST_H
   2 #define BABELTRACE2_TRACE_IR_EVENT_CLASS_CONST_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2013, 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 /* For bt_property_availability */
  35 #include <babeltrace2/property.h>
  36
  37 /* For bt_event_class, bt_field_class, bt_stream_class */
  38 #include <babeltrace2/types.h>
  39
  40 #include <stdint.h>
  41 #include <stddef.h>
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 typedef enum bt_event_class_log_level {
  48         BT_EVENT_CLASS_LOG_LEVEL_EMERGENCY,
  49         BT_EVENT_CLASS_LOG_LEVEL_ALERT,
  50         BT_EVENT_CLASS_LOG_LEVEL_CRITICAL,
  51         BT_EVENT_CLASS_LOG_LEVEL_ERROR,
  52         BT_EVENT_CLASS_LOG_LEVEL_WARNING,
  53         BT_EVENT_CLASS_LOG_LEVEL_NOTICE,
  54         BT_EVENT_CLASS_LOG_LEVEL_INFO,
  55         BT_EVENT_CLASS_LOG_LEVEL_DEBUG_SYSTEM,
  56         BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROGRAM,
  57         BT_EVENT_CLASS_LOG_LEVEL_DEBUG_PROCESS,
  58         BT_EVENT_CLASS_LOG_LEVEL_DEBUG_MODULE,
  59         BT_EVENT_CLASS_LOG_LEVEL_DEBUG_UNIT,
  60         BT_EVENT_CLASS_LOG_LEVEL_DEBUG_FUNCTION,
  61         BT_EVENT_CLASS_LOG_LEVEL_DEBUG_LINE,
  62         BT_EVENT_CLASS_LOG_LEVEL_DEBUG,
  63 } bt_event_class_log_level;
  64
  65 extern const bt_stream_class *bt_event_class_borrow_stream_class_const(
  66                 const bt_event_class *event_class);
  67
  68 extern const char *bt_event_class_get_name(const bt_event_class *event_class);
  69
  70 extern uint64_t bt_event_class_get_id(const bt_event_class *event_class);
  71
  72 extern bt_property_availability bt_event_class_get_log_level(
  73                 const bt_event_class *event_class,
  74                 bt_event_class_log_level *log_level);
  75
  76 extern const char *bt_event_class_get_emf_uri(
  77                 const bt_event_class *event_class);
  78
  79 extern const bt_field_class *
  80 bt_event_class_borrow_specific_context_field_class_const(
  81                 const bt_event_class *event_class);
  82
  83 extern const bt_field_class *bt_event_class_borrow_payload_field_class_const(
  84                 const bt_event_class *event_class);
  85
  86 extern void bt_event_class_get_ref(const bt_event_class *event_class);
  87
  88 extern void bt_event_class_put_ref(const bt_event_class *event_class);
  89
  90 #define BT_EVENT_CLASS_PUT_REF_AND_RESET(_var)          \
  91         do {                                            \
  92                 bt_event_class_put_ref(_var);           \
  93                 (_var) = NULL;                          \
  94         } while (0)
  95
  96 #define BT_EVENT_CLASS_MOVE_REF(_var_dst, _var_src)     \
  97         do {                                            \
  98                 bt_event_class_put_ref(_var_dst);       \
  99                 (_var_dst) = (_var_src);                \
 100                 (_var_src) = NULL;                      \
 101         } while (0)
 102
 103 #ifdef __cplusplus
 104 }
 105 #endif
 106
 107 #endif /* BABELTRACE2_TRACE_IR_EVENT_CLASS_CONST_H */