include/babeltrace/plugin/plugin-macros.h

   1 #ifndef BABELTRACE_PLUGIN_MACROS_H
   2 #define BABELTRACE_PLUGIN_MACROS_H
   3
   4 /*
   5  * BabelTrace - Babeltrace Plug-in Helper Macros
   6  *
   7  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  * Copyright 2015 Philippe Proulx <pproulx@efficios.com>
   9  *
  10  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining a copy
  13  * of this software and associated documentation files (the "Software"), to deal
  14  * in the Software without restriction, including without limitation the rights
  15  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  16  * copies of the Software, and to permit persons to whom the Software is
  17  * furnished to do so, subject to the following conditions:
  18  *
  19  * The above copyright notice and this permission notice shall be included in
  20  * all copies or substantial portions of the Software.
  21  *
  22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  23  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  25  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  27  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  28  * SOFTWARE.
  29  */
  30
  31 #include <babeltrace/plugin/component-factory.h>
  32 #include <babeltrace/plugin/component.h>
  33 #include <babeltrace/plugin/plugin.h>
  34
  35 #ifndef BT_BUILT_IN_PLUGINS
  36
  37 #define BT_PLUGIN_REGISTER(_x)          bt_plugin_register_func __bt_plugin_register = (_x)
  38 #define BT_PLUGIN_NAME(_x)              const char __bt_plugin_name[] = (_x)
  39 #define BT_PLUGIN_AUTHOR(_x)            const char __bt_plugin_author[] = (_x)
  40 #define BT_PLUGIN_LICENSE(_x)           const char __bt_plugin_license[] = (_x)
  41 #define BT_PLUGIN_DESCRIPTION(_x)       const char __bt_plugin_description[] = (_x)
  42
  43 #else /* BT_BUILT_IN_PLUGINS */
  44
  45 /*
  46  * Statically-linked plug-in symbol types are stored in separate sections and
  47  * which are read using the bt_component_factory interface.
  48  */
  49 #define BT_PLUGIN_REGISTER(_x)          static bt_plugin_register_func __attribute__((section("__plugin_register_funcs"), used)) __plugin_register = (_x)
  50 #define BT_PLUGIN_NAME(_x)              static const char *__plugin_name __attribute__((section("__plugin_names"), used)) = (_x)
  51 #define BT_PLUGIN_AUTHOR(_x)            static const char *__plugin_author __attribute__((section("__plugin_authors"), used)) = (_x)
  52 #define BT_PLUGIN_LICENSE(_x)           static const char *__plugin_license __attribute__((section("__plugin_licenses"), used)) = (_x)
  53 #define BT_PLUGIN_DESCRIPTION(_x)       static const char *__plugin_description __attribute__((section("__plugin_descriptions"), used)) = (_x)
  54
  55 #endif /* BT_BUILT_IN_PLUGINS */
  56
  57 #define BT_PLUGIN_COMPONENT_CLASSES_BEGIN                                       \
  58         static enum bt_component_status __bt_plugin_register_component_classes( \
  59                 struct bt_component_factory *factory)                           \
  60         {
  61
  62 #define BT_PLUGIN_SOURCE_COMPONENT_CLASS_ENTRY(_name, description, _init)       \
  63         bt_component_factory_register_source_component_class(factory,           \
  64                         _name, description, _init);
  65
  66 #define BT_PLUGIN_SINK_COMPONENT_CLASS_ENTRY(_name, _description, _init)        \
  67         bt_component_factory_register_sink_component_class(factory,             \
  68                         _name, _description, _init);
  69
  70 #define BT_PLUGIN_FILTER_COMPONENT_CLASS_ENTRY(_name, _description, _init)      \
  71         bt_component_factory_register_filter_component_class(factory,           \
  72                         _name, _description, _init);
  73
  74 #define BT_PLUGIN_COMPONENT_CLASSES_END                                         \
  75         return BT_COMPONENT_STATUS_OK;                                          \
  76 }                                                                               \
  77                                                                                 \
  78         BT_PLUGIN_REGISTER(__bt_plugin_register_component_classes);             \
  79
  80 #endif /* BABELTRACE_PLUGIN_MACROS_H */