*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
*/
-#define _XOPEN_SOURCE 700
-#include <config.h>
-#include <babeltrace/babeltrace-internal.h>
-#include <babeltrace/format.h>
-#include <popt.h>
-#include <errno.h>
+#include <babeltrace/babeltrace.h>
+#include <babeltrace/plugin/component-factory.h>
+#include <babeltrace/plugin/plugin.h>
+#include <babeltrace/plugin/component-class.h>
+#include <babeltrace/ref.h>
+#include <babeltrace/values.h>
#include <stdlib.h>
-#include <ctype.h>
-#include <sys/stat.h>
-#include <sys/types.h>
-#include <fcntl.h>
-#include <ftw.h>
-#include <dirent.h>
-#include <unistd.h>
-
-#define DEFAULT_FILE_ARRAY_SIZE 1
-static char *opt_input_format;
-static char *opt_output_format;
-
-static const char *opt_input_path;
-static const char *opt_output_path;
+#include <babeltrace/ctf-ir/metadata.h> /* for clocks */
+#include <popt.h>
+#include <string.h>
+#include <stdio.h>
-static struct trace_collection trace_collection_read;
-static struct format *fmt_read;
-void strlower(char *str)
-{
- while (*str) {
- *str = tolower(*str);
- str++;
- }
-}
+static char *opt_plugin_path;
enum {
OPT_NONE = 0,
- OPT_HELP,
- OPT_LIST,
+ OPT_PLUGIN_PATH,
OPT_VERBOSE,
OPT_DEBUG,
- OPT_NAMES,
+ OPT_HELP,
};
+/*
+ * We are _not_ using POPT_ARG_STRING's ability to store directly into
+ * variables, because we want to cast the return to non-const, which is
+ * not possible without using poptGetOptArg explicitly. This helps us
+ * controlling memory allocation correctly without making assumptions
+ * about undocumented behaviors. poptGetOptArg is documented as
+ * requiring the returned const char * to be freed by the caller.
+ */
static struct poptOption long_options[] = {
/* longName, shortName, argInfo, argPtr, value, descrip, argDesc */
- { "input-format", 'i', POPT_ARG_STRING, &opt_input_format, OPT_NONE, NULL, NULL },
- { "output-format", 'o', POPT_ARG_STRING, &opt_output_format, OPT_NONE, NULL, NULL },
- { "help", 'h', POPT_ARG_NONE, NULL, OPT_HELP, NULL, NULL },
- { "list", 'l', POPT_ARG_NONE, NULL, OPT_LIST, NULL, NULL },
+ { "plugin-path", 0, POPT_ARG_STRING, NULL, OPT_PLUGIN_PATH, NULL, NULL },
{ "verbose", 'v', POPT_ARG_NONE, NULL, OPT_VERBOSE, NULL, NULL },
{ "debug", 'd', POPT_ARG_NONE, NULL, OPT_DEBUG, NULL, NULL },
- { "names", 'n', POPT_ARG_STRING, NULL, OPT_NAMES, NULL, NULL },
{ NULL, 0, 0, NULL, 0, NULL, NULL },
};
-static void list_formats(FILE *fp)
-{
- fprintf(fp, "\n");
- bt_fprintf_format_list(fp);
-}
-
-static void usage(FILE *fp)
-{
- fprintf(fp, "BabelTrace Trace Converter %s\n\n", VERSION);
- fprintf(fp, "usage : babeltrace [OPTIONS] INPUT <OUTPUT>\n");
- fprintf(fp, "\n");
- fprintf(fp, " INPUT Input trace path\n");
- fprintf(fp, " OUTPUT Output trace path (default: stdout)\n");
- fprintf(fp, "\n");
- fprintf(fp, " -i, --input-format FORMAT Input trace format (default: ctf)\n");
- fprintf(fp, " -o, --output-format FORMAT Output trace format (default: text)\n");
- fprintf(fp, "\n");
- fprintf(fp, " -h, --help This help message\n");
- fprintf(fp, " -l, --list List available formats\n");
- fprintf(fp, " -v, --verbose Verbose mode\n");
- fprintf(fp, " (or set BABELTRACE_VERBOSE environment variable)\n");
- fprintf(fp, " -d, --debug Debug mode\n");
- fprintf(fp, " (or set BABELTRACE_DEBUG environment variable)\n");
- fprintf(fp, " -n, --names name1<,name2,...> Print field names.\n");
- fprintf(fp, " Available field names:\n");
- fprintf(fp, " (payload OR args OR arg)\n");
- fprintf(fp, " all, scope, header, (context OR ctx)\n");
- fprintf(fp, " trace, trace:domain, trace:procname, trace:vpid\n");
- fprintf(fp, " (payload active by default)\n");
- list_formats(fp);
- fprintf(fp, "\n");
-}
-
-static int get_names_args(poptContext *pc)
-{
- char *str, *strlist, *strctx;
-
- opt_payload_field_names = 0;
- strlist = (char *) poptGetOptArg(*pc);
- if (!strlist) {
- return -EINVAL;
- }
- str = strtok_r(strlist, ",", &strctx);
- do {
- if (!strcmp(str, "all"))
- opt_all_field_names = 1;
- else if (!strcmp(str, "scope"))
- opt_scope_field_names = 1;
- else if (!strcmp(str, "context") || !strcmp(str, "ctx"))
- opt_context_field_names = 1;
- else if (!strcmp(str, "header"))
- opt_header_field_names = 1;
- else if (!strcmp(str, "payload") || !strcmp(str, "args") || !strcmp(str, "arg"))
- opt_payload_field_names = 1;
- else if (!strcmp(str, "trace"))
- opt_trace_name = 1;
- else if (!strcmp(str, "trace:domain"))
- opt_trace_domain = 1;
- else if (!strcmp(str, "trace:procname"))
- opt_trace_procname = 1;
- else if (!strcmp(str, "trace:vpid"))
- opt_trace_vpid = 1;
- else {
- fprintf(stdout, "[error] unknown field name type %s\n", str);
- return -EINVAL;
- }
- } while ((str = strtok_r(NULL, ",", &strctx)));
- return 0;
-}
-
/*
* Return 0 if caller should continue, < 0 if caller should return
* error, > 0 if caller should exit without reporting error.
int opt, ret = 0;
if (argc == 1) {
- usage(stdout);
return 1; /* exit cleanly */
}
poptReadDefaultConfig(pc, 0);
/* set default */
+ opt_context_field_names = 1;
opt_payload_field_names = 1;
while ((opt = poptGetNextOpt(pc)) != -1) {
switch (opt) {
case OPT_HELP:
- usage(stdout);
ret = 1; /* exit cleanly */
goto end;
- case OPT_LIST:
- list_formats(stdout);
- ret = 1;
- goto end;
- case OPT_VERBOSE:
- babeltrace_verbose = 1;
- break;
- case OPT_NAMES:
- if (get_names_args(&pc)) {
+ case OPT_PLUGIN_PATH:
+ opt_plugin_path = (char *) poptGetOptArg(pc);
+ if (!opt_plugin_path) {
ret = -EINVAL;
goto end;
- }
+ } ;
+ break;
+ case OPT_VERBOSE:
+ babeltrace_verbose = 1;
break;
case OPT_DEBUG:
babeltrace_debug = 1;
}
}
- opt_input_path = poptGetArg(pc);
- if (!opt_input_path) {
- ret = -EINVAL;
- goto end;
- }
- opt_output_path = poptGetArg(pc);
-
end:
if (pc) {
poptFreeContext(pc);
return ret;
}
-static void init_trace_collection(struct trace_collection *tc)
+static
+const char *component_type_str(enum bt_component_type type)
{
- tc->array = g_ptr_array_sized_new(DEFAULT_FILE_ARRAY_SIZE);
+ switch (type) {
+ case BT_COMPONENT_TYPE_SOURCE:
+ return "source";
+ case BT_COMPONENT_TYPE_SINK:
+ return "sink";
+ case BT_COMPONENT_TYPE_FILTER:
+ return "filter";
+ case BT_COMPONENT_TYPE_UNKNOWN:
+ default:
+ return "unknown";
+ }
}
-/*
- * finalize_trace_collection() closes the opened traces for read
- * and free the memory allocated for trace collection
- */
-static void finalize_trace_collection(struct trace_collection *tc)
+static
+void print_detected_component_classes(struct bt_component_factory *factory)
{
- int i;
+ int count, i;
- for (i = 0; i < tc->array->len; i++) {
- struct trace_descriptor *temp =
- g_ptr_array_index(tc->array, i);
- fmt_read->close_trace(temp);
+ if (!babeltrace_verbose) {
+ return;
}
- g_ptr_array_free(tc->array, TRUE);
-}
-static void trace_collection_add(struct trace_collection *tc,
- struct trace_descriptor *td)
-{
- g_ptr_array_add(tc->array, td);
+ count = bt_component_factory_get_component_class_count(factory);
+ if (count <= 0) {
+ fprintf(stderr, "No component classes found. Please make sure your plug-in search path is set correctly.");
+ return;
+ }
+
+ printf_verbose("Found %d component classes.\n", count);
+ for (i = 0; i < count; i++) {
+ struct bt_component_class *component_class =
+ bt_component_factory_get_component_class_index(
+ factory, i);
+ struct bt_plugin *plugin = bt_component_class_get_plugin(
+ component_class);
+ const char *plugin_name = bt_plugin_get_name(plugin);
+ const char *component_name = bt_component_class_get_name(
+ component_class);
+ const char *path = bt_plugin_get_path(plugin);
+ const char *author = bt_plugin_get_author(plugin);
+ const char *license = bt_plugin_get_license(plugin);
+ const char *plugin_description = bt_plugin_get_description(
+ plugin);
+ const char *component_description =
+ bt_component_class_get_description(
+ component_class);
+ enum bt_component_type type = bt_component_class_get_type(
+ component_class);
+
+ printf_verbose("[%s - %s (%s)]\n", plugin_name, component_name,
+ component_type_str(type));
+ printf_verbose("\tpath: %s\n", path);
+ printf_verbose("\tauthor: %s\n", author);
+ printf_verbose("\tlicense: %s\n", license);
+ printf_verbose("\tplugin description: %s\n",
+ plugin_description ? plugin_description : "None");
+ printf_verbose("\tcomponent description: %s\n",
+ component_description ? component_description : "None");
+
+ bt_put(plugin);
+ bt_put(component_class);
+ }
}
-/*
- * traverse_dir() is the callback functiion for File Tree Walk (nftw).
- * it receives the path of the current entry (file, dir, link..etc) with
- * a flag to indicate the type of the entry.
- * if the entry being visited is a directory and contains a metadata file,
- * then open it for reading and save a trace_descriptor to that directory
- * in the read trace collection.
- */
-static int traverse_dir(const char *fpath, const struct stat *sb,
- int tflag, struct FTW *ftwbuf)
+static
+void test_sink_notifications(struct bt_component *sink)
{
- int dirfd;
- int fd;
- struct trace_descriptor *td_read;
-
- if (tflag != FTW_D)
- return 0;
- dirfd = open(fpath, 0);
- if (dirfd < 0) {
- fprintf(stdout, "[error] unable to open trace "
- "directory file descriptor.\n");
- return -1;
- }
- fd = openat(dirfd, "metadata", O_RDONLY);
- if (fd < 0) {
- close(dirfd);
- } else {
- close(fd);
- close(dirfd);
- td_read = fmt_read->open_trace(opt_input_path,
- fpath, O_RDONLY, ctf_move_pos_slow,
- NULL);
- if (!td_read) {
- fprintf(stdout, "Error opening trace \"%s\" "
- "for reading.\n\n", fpath);
- return -1; /* error */
- }
- trace_collection_add(&trace_collection_read, td_read);
- }
- return 0; /* success */
+ return;
}
int main(int argc, char **argv)
{
int ret;
- struct format *fmt_write;
- struct trace_descriptor *td_write;
+ struct bt_component_factory *component_factory = NULL;
+ struct bt_component_class *source_class = NULL;
+ struct bt_component_class *sink_class = NULL;
+ struct bt_component *source = NULL, *sink = NULL;
+ struct bt_value *source_params = NULL, *sink_params = NULL;
ret = parse_options(argc, argv);
if (ret < 0) {
- fprintf(stdout, "Error parsing options.\n\n");
- usage(stdout);
+ fprintf(stderr, "Error parsing options.\n\n");
exit(EXIT_FAILURE);
} else if (ret > 0) {
exit(EXIT_SUCCESS);
}
+
printf_verbose("Verbose mode active.\n");
printf_debug("Debug mode active.\n");
- if (opt_input_format)
- strlower(opt_input_format);
- if (opt_output_format)
- strlower(opt_output_format);
-
- printf_verbose("Converting from directory: %s\n", opt_input_path);
- printf_verbose("Converting from format: %s\n",
- opt_input_format ? : "ctf <default>");
- printf_verbose("Converting to directory: %s\n",
- opt_output_path ? : "<stdout>");
- printf_verbose("Converting to format: %s\n",
- opt_output_format ? : "text <default>");
-
- if (!opt_input_format)
- opt_input_format = "ctf";
- if (!opt_output_format)
- opt_output_format = "text";
- fmt_read = bt_lookup_format(g_quark_from_static_string(opt_input_format));
- if (!fmt_read) {
- fprintf(stdout, "[error] Format \"%s\" is not supported.\n\n",
- opt_input_format);
- exit(EXIT_FAILURE);
+ if (!opt_plugin_path) {
+ fprintf(stderr, "No plugin path specified, aborting...\n");
+ ret = -1;
+ goto end;
}
- fmt_write = bt_lookup_format(g_quark_from_static_string(opt_output_format));
- if (!fmt_write) {
- fprintf(stdout, "[error] format \"%s\" is not supported.\n\n",
- opt_output_format);
- exit(EXIT_FAILURE);
+ printf_verbose("Looking-up plugins at %s\n",
+ opt_plugin_path ? opt_plugin_path : "Invalid");
+ component_factory = bt_component_factory_create();
+ if (!component_factory) {
+ fprintf(stderr, "Failed to create component factory.\n");
+ ret = -1;
+ goto end;
}
- /*
- * pass the input path to nftw() .
- * specify traverse_dir() as the callback function.
- * depth = 10 which is the max number of file descriptors
- * that nftw() can open at a given time.
- * flags = 0 check nftw documentation for more info .
- */
- init_trace_collection(&trace_collection_read);
- ret = nftw(opt_input_path, traverse_dir, 10, 0);
- if (ret != 0) {
- fprintf(stdout, "[error] opening trace \"%s\" for reading.\n\n",
- opt_input_path);
- goto error_td_read;
- }
- if (trace_collection_read.array->len == 0) {
- fprintf(stdout, "[warning] no metadata file was found."
- " no output was generated\n");
- return 0;
+ ret = bt_component_factory_load_recursive(component_factory, opt_plugin_path);
+ if (ret) {
+ fprintf(stderr, "Failed to load plugins.\n");
+ goto end;
}
- td_write = fmt_write->open_trace(NULL, opt_output_path, O_RDWR, NULL, NULL);
- if (!td_write) {
- fprintf(stdout, "Error opening trace \"%s\" for writing.\n\n",
- opt_output_path ? : "<none>");
- goto error_td_write;
+ print_detected_component_classes(component_factory);
+
+ sink_class = bt_component_factory_get_component_class(component_factory,
+ NULL, BT_COMPONENT_TYPE_SINK, "text");
+ if (!sink_class) {
+ fprintf(stderr, "Could not find text output component class. Aborting...\n");
+ ret = -1;
+ goto end;
}
- ret = convert_trace(td_write, &trace_collection_read);
- if (ret) {
- fprintf(stdout, "Error printing trace.\n\n");
- goto error_copy_trace;
+ sink = bt_component_create(sink_class, "bt_text_output", sink_params);
+ if (!sink) {
+ fprintf(stderr, "Failed to instanciate text output. Aborting...\n");
+ ret = -1;
+ goto end;
}
- fmt_write->close_trace(td_write);
- finalize_trace_collection(&trace_collection_read);
- printf_verbose("finished converting. Output written to:\n%s\n",
- opt_output_path ? : "<stdout>");
- exit(EXIT_SUCCESS);
+ test_sink_notifications(sink);
- /* Error handling */
-error_copy_trace:
- fmt_write->close_trace(td_write);
-error_td_write:
- finalize_trace_collection(&trace_collection_read);
-error_td_read:
- exit(EXIT_FAILURE);
+ /* teardown and exit */
+end:
+ BT_PUT(component_factory);
+ BT_PUT(sink_class);
+ BT_PUT(source_class);
+ BT_PUT(source);
+ BT_PUT(sink);
+ BT_PUT(source_params);
+ BT_PUT(sink_params);
+ return ret ? 1 : 0;
}
projects / babeltrace.git / blobdiff