#include <babeltrace2/types.h>
#include "plugins/common/muxing/muxing.h"
+#include "plugins/common/param-validation/param-validation.h"
#include "data-stream.h"
#include "metadata.h"
#define MAX_QUERY_SIZE (256*1024)
#define URL_PARAM "url"
+#define INPUTS_PARAM "inputs"
#define SESS_NOT_FOUND_ACTION_PARAM "session-not-found-action"
#define SESS_NOT_FOUND_ACTION_CONTINUE_STR "continue"
#define SESS_NOT_FOUND_ACTION_FAIL_STR "fail"
}
BT_HIDDEN
-bt_component_class_message_iterator_init_method_status lttng_live_msg_iter_init(
+bt_component_class_message_iterator_initialize_method_status lttng_live_msg_iter_init(
bt_self_message_iterator *self_msg_it,
+ bt_self_message_iterator_configuration *config,
bt_self_component_source *self_comp_src,
bt_self_component_port_output *self_port)
{
- bt_component_class_message_iterator_init_method_status ret =
- BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_OK;
+ bt_component_class_message_iterator_initialize_method_status ret =
+ BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_OK;
bt_self_component *self_comp =
bt_self_component_source_as_self_component(self_comp_src);
struct lttng_live_component *lttng_live;
lttng_live_msg_iter = g_new0(struct lttng_live_msg_iter, 1);
if (!lttng_live_msg_iter) {
- ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR;
+ ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR;
goto end;
}
SESS_NOT_FOUND_ACTION_END_STR,
lttng_live->params.url->str);
break;
- case SESSION_NOT_FOUND_ACTION_UNKNOWN:
default:
- /* Fallthrough */
- BT_COMP_LOGE("Unknown action for session not found"
- "error. Fail the message iterator"
- "initialization because of %s=\"%s\" "
- "component parameter: url =\"%s\"",
- SESS_NOT_FOUND_ACTION_PARAM,
- SESS_NOT_FOUND_ACTION_FAIL_STR,
- lttng_live->params.url->str);
- break;
+ abort();
}
}
goto end;
error:
- ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INIT_METHOD_STATUS_ERROR;
+ ret = BT_COMPONENT_CLASS_MESSAGE_ITERATOR_INITIALIZE_METHOD_STATUS_ERROR;
lttng_live_msg_iter_destroy(lttng_live_msg_iter);
end:
return ret;
}
+static struct bt_param_validation_map_value_entry_descr list_sessions_params[] = {
+ { URL_PARAM, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY, { .type = BT_VALUE_TYPE_STRING } },
+ BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
+};
+
static
bt_component_class_query_method_status lttng_live_query_list_sessions(
const bt_value *params, const bt_value **result,
+ bt_self_component_class *self_comp_class,
bt_logging_level log_level)
{
- bt_component_class_query_method_status status =
- BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
+ bt_component_class_query_method_status status;
const bt_value *url_value = NULL;
const char *url;
struct live_viewer_connection *viewer_connection = NULL;
- bt_self_component *self_comp = NULL;
+ enum bt_param_validation_status validation_status;
+ gchar *validate_error = NULL;
- url_value = bt_value_map_borrow_entry_value_const(params, URL_PARAM);
- if (!url_value) {
- BT_COMP_LOGE("Mandatory `%s` parameter missing", URL_PARAM);
- status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
+ validation_status = bt_param_validation_validate(params,
+ list_sessions_params, &validate_error);
+ if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
+ status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
goto error;
- }
-
- if (!bt_value_is_string(url_value)) {
- BT_COMP_LOGE("`%s` parameter is required to be a string value",
- URL_PARAM);
+ } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
+ BT_COMP_CLASS_LOGE_APPEND_CAUSE(self_comp_class, "%s", validate_error);
goto error;
}
+ url_value = bt_value_map_borrow_entry_value_const(params, URL_PARAM);
url = bt_value_string_get(url_value);
viewer_connection = live_viewer_connection_create(url, true, NULL,
log_level);
if (!viewer_connection) {
+ status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
goto error;
}
status = live_viewer_connection_list_sessions(viewer_connection,
- result);
+ result);
if (status != BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK) {
goto error;
}
if (viewer_connection) {
live_viewer_connection_destroy(viewer_connection);
}
+
+ g_free(validate_error);
+
+ return status;
+}
+
+static
+bt_component_class_query_method_status lttng_live_query_support_info(
+ const bt_value *params, const bt_value **result,
+ bt_logging_level log_level)
+{
+ bt_component_class_query_method_status status =
+ BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
+ const bt_value *input_type_value;
+ const bt_value *input_value;
+ double weight = 0;
+ struct bt_common_lttng_live_url_parts parts = { 0 };
+
+ /* Used by the logging macros */
+ __attribute__((unused)) bt_self_component *self_comp = NULL;
+
+ *result = NULL;
+ input_type_value = bt_value_map_borrow_entry_value_const(params,
+ "type");
+ if (!input_type_value) {
+ BT_COMP_LOGE("Missing expected `type` parameter.");
+ goto error;
+ }
+
+ if (!bt_value_is_string(input_type_value)) {
+ BT_COMP_LOGE("`type` parameter is not a string value.");
+ goto error;
+ }
+
+ if (strcmp(bt_value_string_get(input_type_value), "string") != 0) {
+ /* We don't handle file system paths */
+ goto create_result;
+ }
+
+ input_value = bt_value_map_borrow_entry_value_const(params, "input");
+ if (!input_value) {
+ BT_COMP_LOGE("Missing expected `input` parameter.");
+ goto error;
+ }
+
+ if (!bt_value_is_string(input_value)) {
+ BT_COMP_LOGE("`input` parameter is not a string value.");
+ goto error;
+ }
+
+ parts = bt_common_parse_lttng_live_url(bt_value_string_get(input_value),
+ NULL, 0);
+ if (parts.session_name) {
+ /*
+ * Looks pretty much like an LTTng live URL: we got the
+ * session name part, which forms a complete URL.
+ */
+ weight = .75;
+ }
+
+create_result:
+ *result = bt_value_real_create_init(weight);
+ if (!*result) {
+ status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_MEMORY_ERROR;
+ goto error;
+ }
+
+ goto end;
+
+error:
+ if (status >= 0) {
+ status = BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_ERROR;
+ }
+
+ BT_ASSERT(!*result);
+
+end:
+ bt_common_destroy_lttng_live_url_parts(&parts);
return status;
}
bt_component_class_query_method_status status =
BT_COMPONENT_CLASS_QUERY_METHOD_STATUS_OK;
bt_self_component *self_comp = NULL;
+ bt_self_component_class *self_comp_class =
+ bt_self_component_class_source_as_self_component_class(comp_class);
bt_logging_level log_level = bt_query_executor_get_logging_level(
bt_private_query_executor_as_query_executor_const(
priv_query_exec));
if (strcmp(object, "sessions") == 0) {
status = lttng_live_query_list_sessions(params, result,
+ self_comp_class, log_level);
+ } else if (strcmp(object, "babeltrace.support-info") == 0) {
+ status = lttng_live_query_support_info(params, result,
log_level);
} else {
BT_COMP_LOGI("Unknown query object `%s`", object);
const bt_value *no_session_param)
{
enum session_not_found_action action;
- const char *no_session_act_str;
- no_session_act_str = bt_value_string_get(no_session_param);
+ const char *no_session_act_str = bt_value_string_get(no_session_param);
+
if (strcmp(no_session_act_str, SESS_NOT_FOUND_ACTION_CONTINUE_STR) == 0) {
action = SESSION_NOT_FOUND_ACTION_CONTINUE;
} else if (strcmp(no_session_act_str, SESS_NOT_FOUND_ACTION_FAIL_STR) == 0) {
action = SESSION_NOT_FOUND_ACTION_FAIL;
- } else if (strcmp(no_session_act_str, SESS_NOT_FOUND_ACTION_END_STR) == 0) {
- action = SESSION_NOT_FOUND_ACTION_END;
} else {
- action = SESSION_NOT_FOUND_ACTION_UNKNOWN;
+ BT_ASSERT(strcmp(no_session_act_str, SESS_NOT_FOUND_ACTION_END_STR) == 0);
+ action = SESSION_NOT_FOUND_ACTION_END;
}
return action;
}
-struct lttng_live_component *lttng_live_component_create(const bt_value *params,
- bt_logging_level log_level, bt_self_component *self_comp)
+static struct bt_param_validation_value_descr inputs_elem_descr = {
+ .type = BT_VALUE_TYPE_STRING,
+};
+
+static const char *sess_not_found_action_choices[] = {
+ SESS_NOT_FOUND_ACTION_CONTINUE_STR,
+ SESS_NOT_FOUND_ACTION_FAIL_STR,
+ SESS_NOT_FOUND_ACTION_END_STR,
+};
+
+static struct bt_param_validation_map_value_entry_descr params_descr[] = {
+ { INPUTS_PARAM, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_MANDATORY, { BT_VALUE_TYPE_ARRAY, .array = {
+ .min_length = 1,
+ .max_length = 1,
+ .element_type = &inputs_elem_descr,
+ } } },
+ { SESS_NOT_FOUND_ACTION_PARAM, BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_OPTIONAL, { BT_VALUE_TYPE_STRING, .string = {
+ .choices = sess_not_found_action_choices,
+ } } },
+ BT_PARAM_VALIDATION_MAP_VALUE_ENTRY_END
+};
+
+static
+bt_component_class_initialize_method_status lttng_live_component_create(
+ const bt_value *params,
+ bt_logging_level log_level,
+ bt_self_component *self_comp,
+ struct lttng_live_component **component)
{
- struct lttng_live_component *lttng_live;
- const bt_value *value = NULL;
+ struct lttng_live_component *lttng_live = NULL;
+ const bt_value *inputs_value;
+ const bt_value *url_value;
+ const bt_value *value;
const char *url;
+ enum bt_param_validation_status validation_status;
+ gchar *validation_error = NULL;
+ bt_component_class_initialize_method_status status;
+
+ validation_status = bt_param_validation_validate(params, params_descr,
+ &validation_error);
+ if (validation_status == BT_PARAM_VALIDATION_STATUS_MEMORY_ERROR) {
+ status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
+ goto error;
+ } else if (validation_status == BT_PARAM_VALIDATION_STATUS_VALIDATION_ERROR) {
+ BT_COMP_LOGE_APPEND_CAUSE(self_comp, "%s", validation_error);
+ status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_ERROR;
+ goto error;
+ }
lttng_live = g_new0(struct lttng_live_component, 1);
if (!lttng_live) {
+ status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
goto end;
}
lttng_live->log_level = log_level;
lttng_live->max_query_size = MAX_QUERY_SIZE;
lttng_live->has_msg_iter = false;
- value = bt_value_map_borrow_entry_value_const(params, URL_PARAM);
- if (!value || !bt_value_is_string(value)) {
- BT_COMP_LOGW("Mandatory `%s` parameter missing or not a string",
- URL_PARAM);
- goto error;
- }
- url = bt_value_string_get(value);
+ inputs_value =
+ bt_value_map_borrow_entry_value_const(params, INPUTS_PARAM);
+ url_value =
+ bt_value_array_borrow_element_by_index_const(inputs_value, 0);
+ url = bt_value_string_get(url_value);
+
lttng_live->params.url = g_string_new(url);
if (!lttng_live->params.url) {
+ status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_MEMORY_ERROR;
goto error;
}
value = bt_value_map_borrow_entry_value_const(params,
SESS_NOT_FOUND_ACTION_PARAM);
-
- if (value && bt_value_is_string(value)) {
+ if (value) {
lttng_live->params.sess_not_found_act =
parse_session_not_found_action_param(value);
- if (lttng_live->params.sess_not_found_act == SESSION_NOT_FOUND_ACTION_UNKNOWN) {
- BT_COMP_LOGE("Unexpected value for `%s` parameter: "
- "value=\"%s\"", SESS_NOT_FOUND_ACTION_PARAM,
- bt_value_string_get(value));
- goto error;
- }
} else {
- BT_COMP_LOGW("Optional `%s` parameter is missing or "
- "not a string value. Defaulting to %s=\"%s\".",
- SESS_NOT_FOUND_ACTION_PARAM,
+ BT_COMP_LOGI("Optional `%s` parameter is missing: "
+ "defaulting to `%s`.",
SESS_NOT_FOUND_ACTION_PARAM,
SESS_NOT_FOUND_ACTION_CONTINUE_STR);
lttng_live->params.sess_not_found_act =
SESSION_NOT_FOUND_ACTION_CONTINUE;
}
+ status = BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK;
goto end;
error:
lttng_live_component_destroy_data(lttng_live);
lttng_live = NULL;
end:
- return lttng_live;
+ g_free(validation_error);
+
+ *component = lttng_live;
+ return status;
}
BT_HIDDEN
-bt_component_class_init_method_status lttng_live_component_init(
+bt_component_class_initialize_method_status lttng_live_component_init(
bt_self_component_source *self_comp_src,
- const bt_value *params, __attribute__((unused)) void *init_method_data)
+ bt_self_component_source_configuration *config,
+ const bt_value *params,
+ __attribute__((unused)) void *init_method_data)
{
struct lttng_live_component *lttng_live;
- bt_component_class_init_method_status ret =
- BT_COMPONENT_CLASS_INIT_METHOD_STATUS_OK;
+ bt_component_class_initialize_method_status ret;
bt_self_component *self_comp =
bt_self_component_source_as_self_component(self_comp_src);
bt_logging_level log_level = bt_component_get_logging_level(
bt_self_component_as_component(self_comp));
bt_self_component_add_port_status add_port_status;
- lttng_live = lttng_live_component_create(params, log_level, self_comp);
- if (!lttng_live) {
- ret = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR;
+ ret = lttng_live_component_create(params, log_level, self_comp, <tng_live);
+ if (ret != BT_COMPONENT_CLASS_INITIALIZE_METHOD_STATUS_OK) {
goto error;
}
add_port_status = bt_self_component_source_add_output_port(
self_comp_src, "out", NULL, NULL);
- switch (add_port_status) {
- case BT_SELF_COMPONENT_ADD_PORT_STATUS_ERROR:
- ret = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_ERROR;
- goto error;
- case BT_SELF_COMPONENT_ADD_PORT_STATUS_MEMORY_ERROR:
- ret = BT_COMPONENT_CLASS_INIT_METHOD_STATUS_MEMORY_ERROR;
- goto error;
- default:
- break;
+ if (add_port_status != BT_SELF_COMPONENT_ADD_PORT_STATUS_OK) {
+ ret = (int) add_port_status;
+ goto end;
}
bt_self_component_set_data(self_comp, lttng_live);
projects / babeltrace.git / blobdiff