Commit | Line | Data |
---|---|---|
743138a3 SM |
1 | /* |
2 | * Babeltrace trace converter - CLI tool's configuration | |
3 | * | |
4 | * Copyright 2016-2019 EfficiOS Inc. | |
5 | * | |
6 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
7 | * of this software and associated documentation files (the "Software"), to deal | |
8 | * in the Software without restriction, including without limitation the rights | |
9 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
10 | * copies of the Software, and to permit persons to whom the Software is | |
11 | * furnished to do so, subject to the following conditions: | |
12 | * | |
13 | * The above copyright notice and this permission notice shall be included in | |
14 | * all copies or substantial portions of the Software. | |
15 | * | |
16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
22 | * SOFTWARE. | |
23 | */ | |
24 | ||
25 | #define BT_LOG_TAG "CLI" | |
26 | #include "logging.h" | |
27 | ||
28 | #include "babeltrace2-plugins.h" | |
29 | ||
30 | #include <babeltrace2/babeltrace.h> | |
31 | ||
32 | /* Array of bt_plugin * */ | |
33 | static GPtrArray *loaded_plugins; | |
34 | ||
35 | void init_loaded_plugins(void) | |
36 | { | |
37 | loaded_plugins = g_ptr_array_new_with_free_func( | |
38 | (GDestroyNotify) bt_plugin_put_ref); | |
39 | } | |
40 | ||
41 | void fini_loaded_plugins(void) | |
42 | { | |
43 | g_ptr_array_free(loaded_plugins, TRUE); | |
44 | } | |
45 | ||
46 | const bt_plugin *find_loaded_plugin(const char *name) | |
47 | { | |
48 | int i; | |
49 | const bt_plugin *plugin = NULL; | |
50 | ||
51 | BT_ASSERT(name); | |
52 | BT_LOGI("Finding plugin: name=\"%s\"", name); | |
53 | ||
54 | for (i = 0; i < loaded_plugins->len; i++) { | |
55 | plugin = g_ptr_array_index(loaded_plugins, i); | |
56 | ||
57 | if (strcmp(name, bt_plugin_get_name(plugin)) == 0) { | |
58 | break; | |
59 | } | |
60 | ||
61 | plugin = NULL; | |
62 | } | |
63 | ||
64 | if (plugin) { | |
65 | BT_LOGI("Found plugin: name=\"%s\", plugin-addr=%p", | |
66 | name, plugin); | |
67 | } else { | |
68 | BT_LOGI("Cannot find plugin: name=\"%s\"", name); | |
69 | } | |
70 | ||
71 | bt_plugin_get_ref(plugin); | |
72 | return plugin; | |
73 | } | |
74 | ||
75 | size_t get_loaded_plugins_count(void) | |
76 | { | |
77 | return loaded_plugins->len; | |
78 | } | |
79 | ||
80 | const bt_plugin *borrow_loaded_plugin(size_t index) | |
81 | { | |
82 | BT_ASSERT(index < loaded_plugins->len); | |
83 | return g_ptr_array_index(loaded_plugins, index); | |
84 | } | |
85 | ||
86 | static | |
87 | void add_to_loaded_plugins(const bt_plugin_set *plugin_set) | |
88 | { | |
89 | int64_t i; | |
90 | int64_t count; | |
91 | ||
92 | count = bt_plugin_set_get_plugin_count(plugin_set); | |
93 | BT_ASSERT(count >= 0); | |
94 | ||
95 | for (i = 0; i < count; i++) { | |
96 | const bt_plugin *plugin = | |
97 | bt_plugin_set_borrow_plugin_by_index_const(plugin_set, i); | |
98 | const bt_plugin *loaded_plugin = | |
99 | find_loaded_plugin(bt_plugin_get_name(plugin)); | |
100 | ||
101 | BT_ASSERT(plugin); | |
102 | ||
103 | if (loaded_plugin) { | |
104 | BT_LOGI("Not using plugin: another one already exists with the same name: " | |
105 | "plugin-name=\"%s\", plugin-path=\"%s\", " | |
106 | "existing-plugin-path=\"%s\"", | |
107 | bt_plugin_get_name(plugin), | |
108 | bt_plugin_get_path(plugin), | |
109 | bt_plugin_get_path(loaded_plugin)); | |
110 | bt_plugin_put_ref(loaded_plugin); | |
111 | } else { | |
112 | /* Add to global array. */ | |
113 | BT_LOGD("Adding plugin to loaded plugins: plugin-path=\"%s\"", | |
114 | bt_plugin_get_name(plugin)); | |
115 | bt_plugin_get_ref(plugin); | |
116 | g_ptr_array_add(loaded_plugins, (void *) plugin); | |
117 | } | |
118 | } | |
119 | } | |
120 | ||
121 | static | |
122 | int load_dynamic_plugins(const bt_value *plugin_paths) | |
123 | { | |
124 | int nr_paths, i, ret = 0; | |
125 | ||
126 | nr_paths = bt_value_array_get_size(plugin_paths); | |
127 | if (nr_paths < 0) { | |
128 | BT_CLI_LOGE_APPEND_CAUSE( | |
129 | "Cannot load dynamic plugins: no plugin path."); | |
130 | ret = -1; | |
131 | goto end; | |
132 | } | |
133 | ||
134 | BT_LOGI_STR("Loading dynamic plugins."); | |
135 | ||
136 | for (i = 0; i < nr_paths; i++) { | |
137 | const bt_value *plugin_path_value = NULL; | |
138 | const char *plugin_path; | |
139 | const bt_plugin_set *plugin_set = NULL; | |
140 | bt_plugin_find_all_from_dir_status status; | |
141 | ||
142 | plugin_path_value = | |
143 | bt_value_array_borrow_element_by_index_const( | |
144 | plugin_paths, i); | |
145 | plugin_path = bt_value_string_get(plugin_path_value); | |
146 | ||
147 | /* | |
148 | * Skip this if the directory does not exist because | |
149 | * bt_plugin_find_all_from_dir() expects an existing | |
150 | * directory. | |
151 | */ | |
152 | if (!g_file_test(plugin_path, G_FILE_TEST_IS_DIR)) { | |
153 | BT_LOGI("Skipping nonexistent directory path: " | |
154 | "path=\"%s\"", plugin_path); | |
155 | continue; | |
156 | } | |
157 | ||
158 | status = bt_plugin_find_all_from_dir(plugin_path, BT_FALSE, | |
159 | BT_FALSE, &plugin_set); | |
160 | if (status < 0) { | |
161 | BT_LOGE("Unable to load dynamic plugins from directory: " | |
162 | "path=\"%s\"", plugin_path); | |
163 | continue; | |
164 | } else if (status == | |
165 | BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_NOT_FOUND) { | |
166 | BT_LOGI("No plugins found in directory: path=\"%s\"", | |
167 | plugin_path); | |
168 | continue; | |
169 | } | |
170 | ||
171 | BT_ASSERT(status == BT_PLUGIN_FIND_ALL_FROM_DIR_STATUS_OK); | |
172 | BT_ASSERT(plugin_set); | |
173 | add_to_loaded_plugins(plugin_set); | |
174 | bt_plugin_set_put_ref(plugin_set); | |
175 | } | |
176 | end: | |
177 | return ret; | |
178 | } | |
179 | ||
180 | static | |
181 | int load_static_plugins(void) | |
182 | { | |
183 | int ret = 0; | |
184 | const bt_plugin_set *plugin_set; | |
185 | bt_plugin_find_all_from_static_status status; | |
186 | ||
187 | BT_LOGI("Loading static plugins."); | |
188 | status = bt_plugin_find_all_from_static(BT_FALSE, &plugin_set); | |
189 | if (status < 0) { | |
190 | BT_LOGE("Unable to load static plugins."); | |
191 | ret = -1; | |
192 | goto end; | |
193 | } else if (status == | |
194 | BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_NOT_FOUND) { | |
195 | BT_LOGI("No static plugins found."); | |
196 | goto end; | |
197 | } | |
198 | ||
199 | BT_ASSERT(status == BT_PLUGIN_FIND_ALL_FROM_STATIC_STATUS_OK); | |
200 | BT_ASSERT(plugin_set); | |
201 | add_to_loaded_plugins(plugin_set); | |
202 | bt_plugin_set_put_ref(plugin_set); | |
203 | ||
204 | end: | |
205 | return ret; | |
206 | } | |
207 | ||
73760435 | 208 | int require_loaded_plugins(const bt_value *plugin_paths) |
743138a3 SM |
209 | { |
210 | static bool loaded = false; | |
211 | static int ret = 0; | |
212 | ||
213 | if (loaded) { | |
214 | goto end; | |
215 | } | |
216 | ||
217 | loaded = true; | |
218 | ||
219 | if (load_dynamic_plugins(plugin_paths)) { | |
220 | ret = -1; | |
221 | goto end; | |
222 | } | |
223 | ||
224 | if (load_static_plugins()) { | |
225 | ret = -1; | |
226 | goto end; | |
227 | } | |
228 | ||
229 | BT_LOGI("Loaded all plugins: count=%u", loaded_plugins->len); | |
230 | ||
231 | end: | |
232 | return ret; | |
233 | } |