| 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 | #include <babeltrace/plugin/plugin-internal.h> |
| 30 | #include <babeltrace/babeltrace-internal.h> |
| 31 | #include <babeltrace/compiler.h> |
| 32 | |
| 33 | static void bt_plugin_destroy(struct bt_ctf_ref *ref); |
| 34 | |
| 35 | const char *bt_plugin_get_name(struct bt_plugin *plugin) |
| 36 | { |
| 37 | const char *ret = NULL; |
| 38 | |
| 39 | if (!plugin) { |
| 40 | goto end; |
| 41 | } |
| 42 | |
| 43 | ret = plugin->name->str; |
| 44 | end: |
| 45 | return ret; |
| 46 | } |
| 47 | |
| 48 | enum bt_plugin_status bt_plugin_set_name(struct bt_plugin *plugin, |
| 49 | const char *name) |
| 50 | { |
| 51 | enum bt_plugin_status ret = BT_PLUGIN_STATUS_OK; |
| 52 | |
| 53 | if (!plugin || !name || name[0] == '\0') { |
| 54 | ret = BT_PLUGIN_STATUS_INVAL; |
| 55 | goto end; |
| 56 | } |
| 57 | |
| 58 | g_string_assign(plugin->name, name); |
| 59 | end: |
| 60 | return ret; |
| 61 | } |
| 62 | |
| 63 | enum bt_plugin_type bt_plugin_get_type(struct bt_plugin *plugin) |
| 64 | { |
| 65 | enum bt_plugin_type type = BT_PLUGIN_TYPE_UNKNOWN; |
| 66 | |
| 67 | if (!plugin) { |
| 68 | goto end; |
| 69 | } |
| 70 | |
| 71 | type = plugin->type; |
| 72 | end: |
| 73 | return type; |
| 74 | } |
| 75 | |
| 76 | enum bt_plugin_status bt_plugin_set_error_stream( |
| 77 | struct bt_plugin *plugin, FILE *stream) |
| 78 | { |
| 79 | enum bt_plugin_status ret = BT_PLUGIN_STATUS_OK; |
| 80 | |
| 81 | if (!plugin) { |
| 82 | ret = BT_PLUGIN_STATUS_INVAL; |
| 83 | goto end; |
| 84 | } |
| 85 | |
| 86 | plugin->error_stream = stream; |
| 87 | end: |
| 88 | return ret; |
| 89 | } |
| 90 | |
| 91 | void bt_plugin_get(struct bt_plugin *plugin) |
| 92 | { |
| 93 | if (!plugin) { |
| 94 | return; |
| 95 | } |
| 96 | |
| 97 | bt_ctf_ref_get(&plugin->ref_count); |
| 98 | } |
| 99 | |
| 100 | void bt_plugin_put(struct bt_plugin *plugin) |
| 101 | { |
| 102 | if (!plugin) { |
| 103 | return; |
| 104 | } |
| 105 | |
| 106 | bt_ctf_ref_put(&plugin->ref_count, bt_plugin_destroy); |
| 107 | } |
| 108 | |
| 109 | BT_HIDDEN |
| 110 | enum bt_plugin_status bt_plugin_init(struct bt_plugin *plugin, const char *name, |
| 111 | void *user_data, bt_plugin_destroy_cb user_destroy_func, |
| 112 | enum bt_plugin_type plugin_type, |
| 113 | bt_plugin_destroy_cb plugin_destroy) |
| 114 | { |
| 115 | enum bt_plugin_status ret = BT_PLUGIN_STATUS_OK; |
| 116 | |
| 117 | if (!plugin || !name || name[0] == '\0' || |
| 118 | !user_destroy_func || !user_data || !plugin_destroy) { |
| 119 | ret = BT_PLUGIN_STATUS_INVAL; |
| 120 | goto end; |
| 121 | } |
| 122 | |
| 123 | bt_ctf_ref_init(&plugin->ref_count); |
| 124 | plugin->type = plugin_type; |
| 125 | plugin->user_data = user_data; |
| 126 | plugin->user_data_destroy = user_destroy_func; |
| 127 | plugin->destroy = plugin_destroy; |
| 128 | |
| 129 | plugin->name = g_string_new(name); |
| 130 | if (!plugin->name) { |
| 131 | ret = BT_PLUGIN_STATUS_NOMEM; |
| 132 | goto end; |
| 133 | } |
| 134 | end: |
| 135 | return ret; |
| 136 | } |
| 137 | |
| 138 | void *bt_plugin_get_private_data(struct bt_plugin *plugin) |
| 139 | { |
| 140 | void *ret = NULL; |
| 141 | |
| 142 | if (!plugin) { |
| 143 | goto end; |
| 144 | } |
| 145 | |
| 146 | ret = plugin->user_data; |
| 147 | end: |
| 148 | return ret; |
| 149 | } |
| 150 | |
| 151 | static |
| 152 | void bt_plugin_destroy(struct bt_ctf_ref *ref) |
| 153 | { |
| 154 | struct bt_plugin *plugin = NULL; |
| 155 | |
| 156 | if (!ref) { |
| 157 | return; |
| 158 | } |
| 159 | |
| 160 | plugin = container_of(ref, struct bt_plugin, ref_count); |
| 161 | |
| 162 | /** |
| 163 | * Destroy user data, base and source/filter/sink last since |
| 164 | * it will deallocate the plugin. |
| 165 | */ |
| 166 | assert(plugin->user_data_destroy); |
| 167 | plugin->user_data_destroy(plugin->user_data); |
| 168 | |
| 169 | g_string_free(plugin->name, TRUE); |
| 170 | |
| 171 | assert(plugin->destroy); |
| 172 | plugin->destroy(plugin); |
| 173 | } |