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

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