include/babeltrace2/graph/component-const.h

   1 #ifndef BABELTRACE2_GRAPH_COMPONENT_CONST_H
   2 #define BABELTRACE2_GRAPH_COMPONENT_CONST_H
   3
   4 /*
   5  * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #ifndef __BT_IN_BABELTRACE_H
  27 # error "Please include <babeltrace2/babeltrace.h> instead."
  28 #endif
  29
  30 #include <babeltrace2/graph/component-class-const.h>
  31 #include <babeltrace2/types.h>
  32 #include <babeltrace2/logging.h>
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /**
  39  * Get component's name.
  40  *
  41  * @param component     Component instance of which to get the name
  42  * @returns             Returns a pointer to the component's name
  43  */
  44 extern const char *bt_component_get_name(const bt_component *component);
  45
  46 extern bt_logging_level bt_component_get_logging_level(
  47                 const bt_component *component);
  48
  49 /**
  50  * Get component's class.
  51  *
  52  * @param component     Component instance of which to get the class
  53  * @returns             The component's class
  54  */
  55 extern const bt_component_class *bt_component_borrow_class_const(
  56                 const bt_component *component);
  57
  58 extern bt_component_class_type bt_component_get_class_type(
  59                 const bt_component *component);
  60
  61 static inline
  62 bt_bool bt_component_is_source(const bt_component *component)
  63 {
  64         return bt_component_get_class_type(component) ==
  65                 BT_COMPONENT_CLASS_TYPE_SOURCE;
  66 }
  67
  68 static inline
  69 bt_bool bt_component_is_filter(const bt_component *component)
  70 {
  71         return bt_component_get_class_type(component) ==
  72                 BT_COMPONENT_CLASS_TYPE_FILTER;
  73 }
  74
  75 static inline
  76 bt_bool bt_component_is_sink(const bt_component *component)
  77 {
  78         return bt_component_get_class_type(component) ==
  79                 BT_COMPONENT_CLASS_TYPE_SINK;
  80 }
  81
  82 extern void bt_component_get_ref(const bt_component *component);
  83
  84 extern void bt_component_put_ref(const bt_component *component);
  85
  86 #define BT_COMPONENT_PUT_REF_AND_RESET(_var)            \
  87         do {                                            \
  88                 bt_component_put_ref(_var);             \
  89                 (_var) = NULL;                          \
  90         } while (0)
  91
  92 #define BT_COMPONENT_MOVE_REF(_var_dst, _var_src)       \
  93         do {                                            \
  94                 bt_component_put_ref(_var_dst);         \
  95                 (_var_dst) = (_var_src);                \
  96                 (_var_src) = NULL;                      \
  97         } while (0)
  98
  99 #ifdef __cplusplus
 100 }
 101 #endif
 102
 103 #endif /* BABELTRACE2_GRAPH_COMPONENT_CONST_H */