Make captured field values available to event rule cond. evaluation

[lttng-tools.git] / include / lttng / condition / event-rule.h

diff --git a/include/lttng/condition/event-rule.h b/include/lttng/condition/event-rule.h
index 91fce32d63a22a91858866d8342bb0c599f051b9..02e7a20e78a5ee99ffa5ab7a86af85bfb1436a9c 100644 (file)
--- a/include/lttng/condition/event-rule.h
+++ b/include/lttng/condition/event-rule.h
@@ -17,6 +17,7 @@ extern "C" {
 #endif
 
 struct lttng_event_expr;
+struct lttng_event_field_value;
 
 /**
  * Event rule conditions allows an action to be taken whenever an event matching
@@ -74,6 +75,30 @@ lttng_evaluation_event_rule_get_trigger_name(
                const struct lttng_evaluation *evaluation,
                const char **name);
 
+/*
+ * Sets `*field_val` to the array event field value of the event rule
+ * condition evaluation `evaluation` which contains its captured values.
+ *
+ * Returns:
+ *
+ * `LTTNG_EVALUATION_STATUS_OK`:
+ *     Success.
+ *
+ *     `*field_val` is an array event field value with a length of at
+ *     least one.
+ *
+ * `LTTNG_EVALUATION_STATUS_INVALID`:
+ *     * `evaluation` is `NULL`.
+ *     * The type of the condition of `evaluation` is not
+ *       `LTTNG_CONDITION_TYPE_EVENT_RULE_HIT`.
+ *     * The condition of `evaluation` has no capture descriptors.
+ *     * `field_val` is `NULL`.
+ */
+extern enum lttng_evaluation_status
+lttng_evaluation_event_rule_get_captured_values(
+               const struct lttng_evaluation *evaluation,
+               const struct lttng_event_field_value **field_val);
+
 /*
  * Appends (transfering the ownership) the capture descriptor `expr` to
  * the event rule condition `condition`.