src/cli/babeltrace2-cfg.h

   1 /*
   2  * SPDX-License-Identifier: MIT
   3  *
   4  * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com>
   5  *
   6  * Babeltrace trace converter - CLI tool's configuration
   7  */
   8
   9 #ifndef CLI_BABELTRACE_CFG_H
  10 #define CLI_BABELTRACE_CFG_H
  11
  12 #include <stdlib.h>
  13 #include <stdint.h>
  14 #include <stdbool.h>
  15 #include <babeltrace2/value.h>
  16 #include "lib/object.h"
  17 #include "compat/compiler.h"
  18 #include <babeltrace2/graph/component-class.h>
  19 #include <glib.h>
  20
  21 enum bt_config_command {
  22         BT_CONFIG_COMMAND_RUN,
  23         BT_CONFIG_COMMAND_PRINT_CTF_METADATA,
  24         BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS,
  25         BT_CONFIG_COMMAND_LIST_PLUGINS,
  26         BT_CONFIG_COMMAND_HELP,
  27         BT_CONFIG_COMMAND_QUERY,
  28 };
  29
  30 struct bt_config_component {
  31         bt_object base;
  32         bt_component_class_type type;
  33         GString *plugin_name;
  34         GString *comp_cls_name;
  35         bt_value *params;
  36         GString *instance_name;
  37         int log_level;
  38 };
  39
  40 struct bt_config_connection {
  41         GString *upstream_comp_name;
  42         GString *downstream_comp_name;
  43         GString *upstream_port_glob;
  44         GString *downstream_port_glob;
  45         GString *arg;
  46 };
  47
  48 struct bt_config {
  49         bt_object base;
  50         bt_value *plugin_paths;
  51         bool omit_system_plugin_path;
  52         bool omit_home_plugin_path;
  53         bool command_needs_plugins;
  54         const char *command_name;
  55         int log_level;
  56         enum bt_config_command command;
  57         union {
  58                 /* BT_CONFIG_COMMAND_RUN */
  59                 struct {
  60                         /* Array of pointers to struct bt_config_component */
  61                         GPtrArray *sources;
  62
  63                         /* Array of pointers to struct bt_config_component */
  64                         GPtrArray *filters;
  65
  66                         /* Array of pointers to struct bt_config_component */
  67                         GPtrArray *sinks;
  68
  69                         /* Array of pointers to struct bt_config_connection */
  70                         GPtrArray *connections;
  71
  72                         /*
  73                          * Number of microseconds to sleep when we need
  74                          * to retry to run the graph.
  75                          */
  76                         uint64_t retry_duration_us;
  77
  78                         /*
  79                          * Whether or not to trim the source trace to the
  80                          * intersection of its streams.
  81                          */
  82                         bool stream_intersection_mode;
  83                 } run;
  84
  85                 /* BT_CONFIG_COMMAND_HELP */
  86                 struct {
  87                         struct bt_config_component *cfg_component;
  88                 } help;
  89
  90                 /* BT_CONFIG_COMMAND_QUERY */
  91                 struct {
  92                         GString *object;
  93                         struct bt_config_component *cfg_component;
  94                 } query;
  95
  96                 /* BT_CONFIG_COMMAND_PRINT_CTF_METADATA */
  97                 struct {
  98                         GString *path;
  99                         GString *output_path;
 100                 } print_ctf_metadata;
 101
 102                 /* BT_CONFIG_COMMAND_PRINT_LTTNG_LIVE_SESSIONS */
 103                 struct {
 104                         GString *url;
 105                         GString *output_path;
 106                 } print_lttng_live_sessions;
 107         } cmd_data;
 108 };
 109
 110 static inline
 111 struct bt_config_component *bt_config_get_component(GPtrArray *array,
 112                 size_t index)
 113 {
 114         struct bt_config_component *comp = g_ptr_array_index(array, index);
 115
 116         bt_object_get_ref(comp);
 117         return comp;
 118 }
 119
 120 int bt_config_append_plugin_paths(bt_value *plugin_paths,
 121                 const char *arg);
 122
 123 void bt_config_connection_destroy(struct bt_config_connection *connection);
 124
 125 #endif /* CLI_BABELTRACE_CFG_H */