plugins/plugin.c

   1 /*
   2  * plugin.c
   3  *
   4  * Babeltrace Plugin
   5  *
   6  * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29 const char *bt_plugin_get_name(struct bt_plugin *plugin)
  30 {
  31         const char *ret = NULL;
  32
  33         if (!plugin) {
  34                 goto end;
  35         }
  36
  37         ret = plugin->name->str;
  38 end:
  39         return ret;
  40 }
  41
  42 enum bt_plugin_status bt_plugin_set_name(struct bt_plugin *plugin,
  43                 const char *name)
  44 {
  45         enum bt_plugin_status ret = BT_PLUGIN_STATUS_OK;
  46
  47         if (!plugin || !name || name[0] == '\0') {
  48                 ret = BT_PLUGIN_STATUS_INVAL;
  49                 goto end;
  50         }
  51
  52         g_string_assign(plugin->name, name);
  53 end:
  54         return ret;
  55 }
  56
  57 enum bt_plugin_type bt_plugin_get_type(struct bt_plugin *plugin)
  58 {
  59         enum bt_plugin_type type = BT_PLUGIN_TYPE_UNKNOWN;
  60
  61         if (!plugin) {
  62                 goto end;
  63         }
  64
  65         type = plugin->type;
  66 end:
  67         return type;
  68 }
  69
  70 enum bt_plugin_status bt_plugin_set_error_stream(
  71                 struct bt_plugin *plugin, FILE *stream)
  72 {
  73         enum bt_plugin_status ret = BT_PLUGIN_STATUS_OK;
  74
  75         if (!plugin) {
  76                 ret = BT_PLUGIN_STATUS_INVAL;
  77                 goto end;
  78         }
  79
  80         plugin->error_stream = stream;
  81 end:
  82         return ret;
  83 }
  84
  85 void bt_plugin_get(struct bt_plugin *plugin)
  86 {
  87         if (!plugin) {
  88                 return;
  89         }
  90
  91         bt_ctf_ref_get(&plugin->ref_count);
  92 }
  93
  94 void bt_plugin_put(struct bt_plugin *plugin)
  95 {
  96         if (!plugin) {
  97                 return;
  98         }
  99
 100         bt_ctf_ref_put(&plugin->ref_count, bt_plugin_destroy);
 101 }
 102
 103 BT_HIDDEN
 104 enum bt_plugin_status bt_plugin_init(struct bt_plugin *plugin, const char *name,
 105                 void *user_data, bt_plugin_destroy_func user_destroy_func,
 106                 enum bt_plugin_type plugin_type,
 107                 bt_plugin_destroy_func plugin_destroy)
 108 {
 109         enum bt_plugin_status ret = BT_PLUGIN_STATUS_OK;
 110
 111         if (!plugin || !name || name[0] == '\0' ||
 112                 !destroy_func || !private_data) {
 113                 ret = BT_PLUGIN_STATUS_INVAL;
 114                 goto end;
 115         }
 116
 117         bt_ctf_ref_init(&plugin->ref_count);
 118         plugin->type = plugin_type;
 119         plugin->user_data = user_data;
 120         plugin->user_data_destroy = user_destroy_func;
 121         plugin->destroy = plugin_destroy;
 122
 123         plugin->name = g_string_new(name);
 124         if (!plugin->name) {
 125                 ret = BT_PLUGIN_STATUS_NOMEM;
 126                 goto end;
 127         }
 128 end:
 129         return ret;
 130 }
 131
 132 static
 133 void bt_plugin_destroy(struct bt_ctf_ref *ref)
 134 {
 135         struct bt_ctf_plugin *plugin = NULL;
 136
 137         if (!ref) {
 138                 return;
 139         }
 140
 141         plugin = container_of(ref, struct bt_plugin, parent);
 142
 143         /**
 144          * Destroy user data, base and source/filter/sink last since
 145          * it will deallocate the plugin.
 146          */
 147         assert(plugin->user_destroy_func);
 148         plugin->user_destroy_func(plugin->user_data);
 149
 150         g_string_free(plugin->name, TRUE);
 151
 152         assert(plugin->destroy);
 153         plugin->destroy(plugin);
 154 }