include/babeltrace2/graph/component-const.h

   1 #ifndef BABELTRACE_GRAPH_COMPONENT_CONST_H
   2 #define BABELTRACE_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 /* For bt_component_class_type */
  28 #include <babeltrace2/graph/component-class-const.h>
  29
  30 /*
  31  * For bt_bool, bt_component_class, bt_component_graph, bt_component,
  32  * bt_value, bt_port
  33  */
  34 #include <babeltrace2/types.h>
  35
  36 /* For bt_logging_level */
  37 #include <babeltrace2/logging.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 /**
  44  * Get component's name.
  45  *
  46  * @param component     Component instance of which to get the name
  47  * @returns             Returns a pointer to the component's name
  48  */
  49 extern const char *bt_component_get_name(const bt_component *component);
  50
  51 extern bt_logging_level bt_component_get_logging_level(
  52                 const bt_component *component);
  53
  54 /**
  55  * Get component's class.
  56  *
  57  * @param component     Component instance of which to get the class
  58  * @returns             The component's class
  59  */
  60 extern const bt_component_class *bt_component_borrow_class_const(
  61                 const bt_component *component);
  62
  63 extern bt_component_class_type bt_component_get_class_type(
  64                 const bt_component *component);
  65
  66 static inline
  67 bt_bool bt_component_is_source(const bt_component *component)
  68 {
  69         return bt_component_get_class_type(component) ==
  70                 BT_COMPONENT_CLASS_TYPE_SOURCE;
  71 }
  72
  73 static inline
  74 bt_bool bt_component_is_filter(const bt_component *component)
  75 {
  76         return bt_component_get_class_type(component) ==
  77                 BT_COMPONENT_CLASS_TYPE_FILTER;
  78 }
  79
  80 static inline
  81 bt_bool bt_component_is_sink(const bt_component *component)
  82 {
  83         return bt_component_get_class_type(component) ==
  84                 BT_COMPONENT_CLASS_TYPE_SINK;
  85 }
  86
  87 extern bt_bool bt_component_graph_is_canceled(
  88                 const bt_component *component);
  89
  90 extern void bt_component_get_ref(const bt_component *component);
  91
  92 extern void bt_component_put_ref(const bt_component *component);
  93
  94 #define BT_COMPONENT_PUT_REF_AND_RESET(_var)            \
  95         do {                                            \
  96                 bt_component_put_ref(_var);             \
  97                 (_var) = NULL;                          \
  98         } while (0)
  99
 100 #define BT_COMPONENT_MOVE_REF(_var_dst, _var_src)       \
 101         do {                                            \
 102                 bt_component_put_ref(_var_dst);         \
 103                 (_var_dst) = (_var_src);                \
 104                 (_var_src) = NULL;                      \
 105         } while (0)
 106
 107 #ifdef __cplusplus
 108 }
 109 #endif
 110
 111 #endif /* BABELTRACE_GRAPH_COMPONENT_CONST_H */