src/plugins/utils/plugin.c

   1 /*
   2  * Copyright 2017 Philippe Proulx <pproulx@efficios.com>
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20  * SOFTWARE.
  21  */
  22
  23 #include <babeltrace2/babeltrace.h>
  24 #include "dummy/dummy.h"
  25 #include "counter/counter.h"
  26 #include "muxer/muxer.h"
  27 #include "trimmer/trimmer.h"
  28
  29 #ifndef BT_BUILT_IN_PLUGINS
  30 BT_PLUGIN_MODULE();
  31 #endif
  32
  33 BT_PLUGIN(utils);
  34 BT_PLUGIN_DESCRIPTION("Common graph utilities");
  35 BT_PLUGIN_AUTHOR("EfficiOS <https://www.efficios.com/>");
  36 BT_PLUGIN_LICENSE("MIT");
  37
  38 /* sink.utils.dummy */
  39 BT_PLUGIN_SINK_COMPONENT_CLASS(dummy, dummy_consume);
  40 BT_PLUGIN_SINK_COMPONENT_CLASS_INITIALIZE_METHOD(dummy, dummy_init);
  41 BT_PLUGIN_SINK_COMPONENT_CLASS_FINALIZE_METHOD(dummy, dummy_finalize);
  42 BT_PLUGIN_SINK_COMPONENT_CLASS_GRAPH_IS_CONFIGURED_METHOD(dummy,
  43         dummy_graph_is_configured);
  44 BT_PLUGIN_SINK_COMPONENT_CLASS_DESCRIPTION(dummy,
  45         "Consume messages and discard them.");
  46 BT_PLUGIN_SINK_COMPONENT_CLASS_HELP(dummy,
  47         "See the babeltrace2-sink.utils.dummy(7) manual page.");
  48
  49 /* sink.utils.counter */
  50 BT_PLUGIN_SINK_COMPONENT_CLASS(counter, counter_consume);
  51 BT_PLUGIN_SINK_COMPONENT_CLASS_INITIALIZE_METHOD(counter, counter_init);
  52 BT_PLUGIN_SINK_COMPONENT_CLASS_FINALIZE_METHOD(counter, counter_finalize);
  53 BT_PLUGIN_SINK_COMPONENT_CLASS_GRAPH_IS_CONFIGURED_METHOD(counter,
  54         counter_graph_is_configured);
  55 BT_PLUGIN_SINK_COMPONENT_CLASS_DESCRIPTION(counter,
  56         "Count messages and print the statistics.");
  57 BT_PLUGIN_SINK_COMPONENT_CLASS_HELP(counter,
  58         "See the babeltrace2-sink.utils.counter(7) manual page.");
  59
  60 /* flt.utils.trimmer */
  61 BT_PLUGIN_FILTER_COMPONENT_CLASS(trimmer, trimmer_msg_iter_next);
  62 BT_PLUGIN_FILTER_COMPONENT_CLASS_DESCRIPTION(trimmer,
  63         "Discard messages that occur outside a specific time range.");
  64 BT_PLUGIN_FILTER_COMPONENT_CLASS_HELP(trimmer,
  65         "See the babeltrace2-filter.utils.trimmer(7) manual page.");
  66 BT_PLUGIN_FILTER_COMPONENT_CLASS_INITIALIZE_METHOD(trimmer, trimmer_init);
  67 BT_PLUGIN_FILTER_COMPONENT_CLASS_FINALIZE_METHOD(trimmer, trimmer_finalize);
  68 BT_PLUGIN_FILTER_COMPONENT_CLASS_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD(trimmer,
  69         trimmer_msg_iter_init);
  70 BT_PLUGIN_FILTER_COMPONENT_CLASS_MESSAGE_ITERATOR_CLASS_FINALIZE_METHOD(trimmer,
  71         trimmer_msg_iter_finalize);
  72
  73 /* flt.utils.muxer */
  74 BT_PLUGIN_FILTER_COMPONENT_CLASS(muxer, muxer_msg_iter_next);
  75 BT_PLUGIN_FILTER_COMPONENT_CLASS_DESCRIPTION(muxer,
  76         "Sort messages from multiple input ports to a single output port by time.");
  77 BT_PLUGIN_FILTER_COMPONENT_CLASS_HELP(muxer,
  78         "See the babeltrace2-filter.utils.muxer(7) manual page.");
  79 BT_PLUGIN_FILTER_COMPONENT_CLASS_INITIALIZE_METHOD(muxer, muxer_init);
  80 BT_PLUGIN_FILTER_COMPONENT_CLASS_FINALIZE_METHOD(muxer, muxer_finalize);
  81 BT_PLUGIN_FILTER_COMPONENT_CLASS_INPUT_PORT_CONNECTED_METHOD(muxer,
  82         muxer_input_port_connected);
  83 BT_PLUGIN_FILTER_COMPONENT_CLASS_MESSAGE_ITERATOR_CLASS_INITIALIZE_METHOD(muxer,
  84         muxer_msg_iter_init);
  85 BT_PLUGIN_FILTER_COMPONENT_CLASS_MESSAGE_ITERATOR_CLASS_FINALIZE_METHOD(muxer,
  86         muxer_msg_iter_finalize);
  87 BT_PLUGIN_FILTER_COMPONENT_CLASS_MESSAGE_ITERATOR_CLASS_SEEK_BEGINNING_METHODS(muxer,
  88         muxer_msg_iter_seek_beginning, muxer_msg_iter_can_seek_beginning);