include/babeltrace2/graph/component-const.h

   1 #ifndef BABELTRACE2_GRAPH_COMPONENT_CONST_H
   2 #define BABELTRACE2_GRAPH_COMPONENT_CONST_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2015 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
  27 #ifndef __BT_IN_BABELTRACE_H
  28 # error "Please include <babeltrace2/babeltrace.h> instead."
  29 #endif
  30
  31 #include <babeltrace2/graph/component-class-const.h>
  32 #include <babeltrace2/types.h>
  33 #include <babeltrace2/logging.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 /**
  40  * Get component's name.
  41  *
  42  * @param component     Component instance of which to get the name
  43  * @returns             Returns a pointer to the component's name
  44  */
  45 extern const char *bt_component_get_name(const bt_component *component);
  46
  47 extern bt_logging_level bt_component_get_logging_level(
  48                 const bt_component *component);
  49
  50 /**
  51  * Get component's class.
  52  *
  53  * @param component     Component instance of which to get the class
  54  * @returns             The component's class
  55  */
  56 extern const bt_component_class *bt_component_borrow_class_const(
  57                 const bt_component *component);
  58
  59 extern bt_component_class_type bt_component_get_class_type(
  60                 const bt_component *component);
  61
  62 static inline
  63 bt_bool bt_component_is_source(const bt_component *component)
  64 {
  65         return bt_component_get_class_type(component) ==
  66                 BT_COMPONENT_CLASS_TYPE_SOURCE;
  67 }
  68
  69 static inline
  70 bt_bool bt_component_is_filter(const bt_component *component)
  71 {
  72         return bt_component_get_class_type(component) ==
  73                 BT_COMPONENT_CLASS_TYPE_FILTER;
  74 }
  75
  76 static inline
  77 bt_bool bt_component_is_sink(const bt_component *component)
  78 {
  79         return bt_component_get_class_type(component) ==
  80                 BT_COMPONENT_CLASS_TYPE_SINK;
  81 }
  82
  83 extern bt_bool bt_component_graph_is_canceled(
  84                 const bt_component *component);
  85
  86 extern void bt_component_get_ref(const bt_component *component);
  87
  88 extern void bt_component_put_ref(const bt_component *component);
  89
  90 #define BT_COMPONENT_PUT_REF_AND_RESET(_var)            \
  91         do {                                            \
  92                 bt_component_put_ref(_var);             \
  93                 (_var) = NULL;                          \
  94         } while (0)
  95
  96 #define BT_COMPONENT_MOVE_REF(_var_dst, _var_src)       \
  97         do {                                            \
  98                 bt_component_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_GRAPH_COMPONENT_CONST_H */