include/babeltrace/plugin/plugin-system.h

   1 #ifndef BABELTRACE_PLUGIN_SYSTEM_H
   2 #define BABELTRACE_PLUGIN_SYSTEM_H
   3
   4 /*
   5  * BabelTrace - Babeltrace Plug-in System Interface
   6  *
   7  * This interface is provided for plug-ins to use the Babeltrace
   8  * plug-in system facilities.
   9  *
  10  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  11  *
  12  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  13  *
  14  * Permission is hereby granted, free of charge, to any person obtaining a copy
  15  * of this software and associated documentation files (the "Software"), to deal
  16  * in the Software without restriction, including without limitation the rights
  17  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  18  * copies of the Software, and to permit persons to whom the Software is
  19  * furnished to do so, subject to the following conditions:
  20  *
  21  * The above copyright notice and this permission notice shall be included in
  22  * all copies or substantial portions of the Software.
  23  *
  24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  25  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  26  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  27  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  28  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  29  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30  * SOFTWARE.
  31  */
  32
  33 #include <babeltrace/objects.h>
  34 #include <babeltrace/plugin/notification/iterator.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 struct bt_notification;
  41
  42 /**
  43  * Plug-in private data deallocation function type.
  44  *
  45  * @param plugin        Plug-in instance
  46  */
  47 typedef void (*bt_plugin_destroy_cb)(struct bt_plugin *plugin);
  48
  49 /**
  50  * Iterator creation function type.
  51  *
  52  * @param plugin        Plug-in instance
  53  */
  54 typedef struct bt_notification_iterator *(
  55                 *bt_plugin_source_iterator_create_cb)(
  56                 struct bt_plugin *plugin);
  57
  58 /**
  59  * Notification handling function type.
  60  *
  61  * @param plugin        Plug-in instance
  62  * @param notificattion Notification to handle
  63  * @returns             One of #bt_plugin_status values
  64  */
  65 typedef enum bt_plugin_status (*bt_plugin_sink_handle_notification_cb)(
  66                 struct bt_plugin *, struct bt_notification *);
  67
  68 typedef struct bt_notification *(bt_notification_iterator_get_notification_cb)(
  69                 struct bt_notification_iterator *);
  70
  71 typedef enum bt_notification_iterator_status (bt_notification_iterator_next_cb)(
  72                 struct bt_notification_iterator *);
  73
  74 /**
  75  * Get a plug-in's private (implementation) data.
  76  *
  77  * @param plugin        Plug-in of which to get the private data
  78  * @returns             Plug-in private data
  79  */
  80 extern void *bt_plugin_get_private_data(struct bt_plugin *plugin);
  81
  82
  83 /** Plug-in initialization functions */
  84 /**
  85  * Allocate a source plug-in.
  86  *
  87  * @param name                  Plug-in instance name (will be copied)
  88  * @param private_data          Private plug-in implementation data
  89  * @param destroy_cb            Plug-in private data clean-up callback
  90  * @param iterator_create_cb    Iterator creation callback
  91  * @returns                     A source plug-in instance
  92  */
  93 extern struct bt_plugin *bt_plugin_source_create(const char *name,
  94                 void *private_data, bt_plugin_destroy_cb destroy_func,
  95                 bt_plugin_source_iterator_create_cb iterator_create_cb);
  96
  97 /**
  98  * Allocate a sink plug-in.
  99  *
 100  * @param name                  Plug-in instance name (will be copied)
 101  * @param private_data          Private plug-in implementation data
 102  * @param destroy_cb            Plug-in private data clean-up callback
 103  * @param notification_cb       Notification handling callback
 104  * @returns                     A sink plug-in instance
 105  */
 106 extern struct bt_plugin *bt_plugin_sink_create(const char *name,
 107                 void *private_data, bt_plugin_destroy_cb destroy_func,
 108                 bt_plugin_sink_handle_notification_cb notification_cb);
 109
 110
 111 /** Notification iterator functions */
 112 /**
 113  * Allocate a notification iterator.
 114  *
 115  * @param plugin                Plug-in instance
 116  * @param next_cb               Callback advancing to the next notification
 117  * @param notification_cb       Callback providing the current notification
 118  * @returns                     A notification iterator instance
 119  */
 120 extern struct bt_notification_iterator *bt_notification_iterator_create(
 121                 struct bt_plugin *plugin,
 122                 bt_notification_iterator_next_cb next_cb,
 123                 bt_notification_iterator_get_notification_cb notification_cb);
 124
 125 #ifdef __cplusplus
 126 }
 127 #endif
 128
 129 #endif /* BABELTRACE_PLUGIN_SYSTEM_H */