X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fcommon%2Ftrigger.c;h=132fda138912ef8ac264f6452f274614c1b19eca;hp=af0c5fa348166b833c61331f19f2cc2dba69567d;hb=91c96f622ad9eadbf44a63b55289f673be9cf90e;hpb=242388e491e4219f967ee424d7bf02035a313e6f

diff --git a/src/common/trigger.c b/src/common/trigger.c
index af0c5fa34..132fda138 100644
--- a/src/common/trigger.c
+++ b/src/common/trigger.c
@@ -7,11 +7,16 @@
 
 #include <lttng/trigger/trigger-internal.h>
 #include <lttng/condition/condition-internal.h>
+#include <lttng/condition/event-rule.h>
+#include <lttng/condition/buffer-usage.h>
+#include <lttng/event-rule/event-rule-internal.h>
 #include <lttng/action/action-internal.h>
 #include <common/credentials.h>
 #include <common/payload.h>
 #include <common/payload-view.h>
+#include <lttng/domain.h>
 #include <common/error.h>
+#include <common/dynamic-array.h>
 #include <common/optional.h>
 #include <assert.h>
 #include <inttypes.h>
@@ -54,6 +59,9 @@ struct lttng_trigger *lttng_trigger_create(
 
 	urcu_ref_init(&trigger->ref);
 
+	trigger->firing_policy.type = LTTNG_TRIGGER_FIRING_POLICY_EVERY_N;
+	trigger->firing_policy.threshold = 1;
+
 	lttng_condition_get(condition);
 	trigger->condition = condition;
 
@@ -125,28 +133,57 @@ void lttng_trigger_destroy(struct lttng_trigger *trigger)
 	lttng_trigger_put(trigger);
 }
 
+static bool is_firing_policy_valid(enum lttng_trigger_firing_policy policy)
+{
+	bool valid = false;
+
+	switch (policy) {
+	case LTTNG_TRIGGER_FIRING_POLICY_EVERY_N:
+	case LTTNG_TRIGGER_FIRING_POLICY_ONCE_AFTER_N:
+		valid = true;
+		break;
+	default:
+		valid = false;
+		break;
+	}
+
+	return valid;
+}
+
 LTTNG_HIDDEN
 ssize_t lttng_trigger_create_from_payload(
 		struct lttng_payload_view *src_view,
-		struct lttng_trigger **trigger)
+		struct lttng_trigger **_trigger)
 {
 	ssize_t ret, offset = 0, condition_size, action_size, name_size = 0;
 	struct lttng_condition *condition = NULL;
 	struct lttng_action *action = NULL;
 	const struct lttng_trigger_comm *trigger_comm;
 	const char *name = NULL;
+	uint64_t firing_policy_threshold;
+	enum lttng_trigger_firing_policy firing_policy;
 	struct lttng_credentials creds = {
 		.uid = LTTNG_OPTIONAL_INIT_UNSET,
 		.gid = LTTNG_OPTIONAL_INIT_UNSET,
 	};
+	struct lttng_trigger *trigger = NULL;
+	const struct lttng_payload_view trigger_comm_view =
+			lttng_payload_view_from_view(
+					src_view, 0, sizeof(*trigger_comm));
 
-	if (!src_view || !trigger) {
+	if (!src_view || !_trigger) {
+		ret = -1;
+		goto end;
+	}
+
+	if (!lttng_payload_view_is_valid(&trigger_comm_view)) {
+		/* Payload not large enough to contain the header. */
 		ret = -1;
 		goto end;
 	}
 
 	/* lttng_trigger_comm header */
-	trigger_comm = (typeof(trigger_comm)) src_view->buffer.data;
+	trigger_comm = (typeof(trigger_comm)) trigger_comm_view.buffer.data;
 
 	/* Set the trigger's creds. */
 	if (trigger_comm->uid > (uint64_t) ((uid_t) -1)) {
@@ -159,11 +196,24 @@ ssize_t lttng_trigger_create_from_payload(
 
 	offset += sizeof(*trigger_comm);
 
+	firing_policy = trigger_comm->firing_policy_type;
+	if (!is_firing_policy_valid(firing_policy)) {
+		ret =-1;
+		goto end;
+	}
+
+	firing_policy_threshold = trigger_comm->firing_policy_threshold;
 	if (trigger_comm->name_length != 0) {
 		/* Name. */
 		const struct lttng_payload_view name_view =
 				lttng_payload_view_from_view(
-						src_view, offset, trigger_comm->name_length);
+						src_view, offset,
+						trigger_comm->name_length);
+
+		if (!lttng_payload_view_is_valid(&name_view)) {
+			ret = -1;
+			goto end;
+		}
 
 		name = name_view.buffer.data;
 		if (!lttng_buffer_view_contains_string(&name_view.buffer, name,
@@ -213,13 +263,13 @@ ssize_t lttng_trigger_create_from_payload(
 		goto error;
 	}
 
-	*trigger = lttng_trigger_create(condition, action);
-	if (!*trigger) {
+	trigger = lttng_trigger_create(condition, action);
+	if (!trigger) {
 		ret = -1;
 		goto error;
 	}
 
-	lttng_trigger_set_credentials(*trigger, &creds);
+	lttng_trigger_set_credentials(trigger, &creds);
 
 	/*
 	 * The trigger object owns references to the action and condition
@@ -233,7 +283,20 @@ ssize_t lttng_trigger_create_from_payload(
 
 	if (name) {
 		const enum lttng_trigger_status status =
-				lttng_trigger_set_name(*trigger, name);
+				lttng_trigger_set_name(trigger, name);
+
+		if (status != LTTNG_TRIGGER_STATUS_OK) {
+			ret = -1;
+			goto end;
+		}
+	}
+
+	/* Set the policy. */
+	{
+		const enum lttng_trigger_status status =
+				lttng_trigger_set_firing_policy(trigger,
+						firing_policy,
+						firing_policy_threshold);
 
 		if (status != LTTNG_TRIGGER_STATUS_OK) {
 			ret = -1;
@@ -244,9 +307,15 @@ ssize_t lttng_trigger_create_from_payload(
 	ret = offset;
 
 error:
-	lttng_condition_destroy(condition);
-	lttng_action_destroy(action);
+	lttng_condition_put(condition);
+	lttng_action_put(action);
 end:
+	if (ret >= 0) {
+		*_trigger = trigger;
+	} else {
+		lttng_trigger_put(trigger);
+	}
+
 	return ret;
 }
 
@@ -255,7 +324,7 @@ end:
  * for the detailed format.
  */
 LTTNG_HIDDEN
-int lttng_trigger_serialize(struct lttng_trigger *trigger,
+int lttng_trigger_serialize(const struct lttng_trigger *trigger,
 		struct lttng_payload *payload)
 {
 	int ret;
@@ -276,6 +345,8 @@ int lttng_trigger_serialize(struct lttng_trigger *trigger,
 	}
 
 	trigger_comm.name_length = size_name;
+	trigger_comm.firing_policy_type = (uint8_t) trigger->firing_policy.type;
+	trigger_comm.firing_policy_threshold = (uint64_t) trigger->firing_policy.threshold;
 
 	header_offset = payload->buffer.size;
 	ret = lttng_dynamic_buffer_append(&payload->buffer, &trigger_comm,
@@ -314,6 +385,14 @@ LTTNG_HIDDEN
 bool lttng_trigger_is_equal(
 		const struct lttng_trigger *a, const struct lttng_trigger *b)
 {
+	if (a->firing_policy.type != b->firing_policy.type) {
+		return false;
+	}
+
+	if (a->firing_policy.threshold != b->firing_policy.threshold) {
+		return false;
+	}
+
 	/*
 	 * Name is not taken into account since it is cosmetic only.
 	 */
@@ -395,6 +474,22 @@ end:
 	return ret;
 }
 
+LTTNG_HIDDEN
+void lttng_trigger_set_tracer_token(struct lttng_trigger *trigger,
+		uint64_t token)
+{
+	assert(trigger);
+	LTTNG_OPTIONAL_SET(&trigger->tracer_token, token);
+}
+
+LTTNG_HIDDEN
+uint64_t lttng_trigger_get_tracer_token(const struct lttng_trigger *trigger)
+{
+	assert(trigger);
+
+	return LTTNG_OPTIONAL_GET(trigger->tracer_token);
+}
+
 LTTNG_HIDDEN
 int lttng_trigger_generate_name(struct lttng_trigger *trigger,
 		uint64_t unique_id)
@@ -432,6 +527,210 @@ void lttng_trigger_put(struct lttng_trigger *trigger)
 	urcu_ref_put(&trigger->ref , trigger_destroy_ref);
 }
 
+static void delete_trigger_array_element(void *ptr)
+{
+	struct lttng_trigger *trigger = ptr;
+
+	lttng_trigger_put(trigger);
+}
+
+LTTNG_HIDDEN
+struct lttng_triggers *lttng_triggers_create(void)
+{
+	struct lttng_triggers *triggers = NULL;
+
+	triggers = zmalloc(sizeof(*triggers));
+	if (!triggers) {
+		goto end;
+	}
+
+	lttng_dynamic_pointer_array_init(&triggers->array, delete_trigger_array_element);
+
+end:
+	return triggers;
+}
+
+LTTNG_HIDDEN
+struct lttng_trigger *lttng_triggers_borrow_mutable_at_index(
+		const struct lttng_triggers *triggers, unsigned int index)
+{
+	struct lttng_trigger *trigger = NULL;
+
+	assert(triggers);
+	if (index >= lttng_dynamic_pointer_array_get_count(&triggers->array)) {
+		goto end;
+	}
+
+	trigger = (struct lttng_trigger *)
+			lttng_dynamic_pointer_array_get_pointer(
+					&triggers->array, index);
+end:
+	return trigger;
+}
+
+LTTNG_HIDDEN
+int lttng_triggers_add(
+		struct lttng_triggers *triggers, struct lttng_trigger *trigger)
+{
+	int ret;
+
+	assert(triggers);
+	assert(trigger);
+
+	lttng_trigger_get(trigger);
+
+	ret = lttng_dynamic_pointer_array_add_pointer(&triggers->array, trigger);
+	if (ret) {
+		lttng_trigger_put(trigger);
+	}
+
+	return ret;
+}
+
+const struct lttng_trigger *lttng_triggers_get_at_index(
+		const struct lttng_triggers *triggers, unsigned int index)
+{
+	return lttng_triggers_borrow_mutable_at_index(triggers, index);
+}
+
+enum lttng_trigger_status lttng_triggers_get_count(const struct lttng_triggers *triggers, unsigned int *count)
+{
+	enum lttng_trigger_status status = LTTNG_TRIGGER_STATUS_OK;
+
+	if (!triggers || !count) {
+		status = LTTNG_TRIGGER_STATUS_INVALID;
+		goto end;
+	}
+
+	*count = lttng_dynamic_pointer_array_get_count(&triggers->array);
+end:
+	return status;
+}
+
+void lttng_triggers_destroy(struct lttng_triggers *triggers)
+{
+	if (!triggers) {
+		return;
+	}
+
+	lttng_dynamic_pointer_array_reset(&triggers->array);
+	free(triggers);
+}
+
+int lttng_triggers_serialize(const struct lttng_triggers *triggers,
+		struct lttng_payload *payload)
+{
+	int ret;
+	unsigned int i, count;
+	size_t size_before_payload;
+	struct lttng_triggers_comm triggers_comm = {};
+	struct lttng_triggers_comm *header;
+	enum lttng_trigger_status status;
+	const size_t header_offset = payload->buffer.size;
+
+	status = lttng_triggers_get_count(triggers, &count);
+	if (status != LTTNG_TRIGGER_STATUS_OK) {
+		ret = LTTNG_ERR_INVALID;
+		goto end;
+	}
+
+	triggers_comm.count = count;
+
+	/* Placeholder header; updated at the end. */
+	ret = lttng_dynamic_buffer_append(&payload->buffer, &triggers_comm,
+			sizeof(triggers_comm));
+	if (ret) {
+		goto end;
+	}
+
+	size_before_payload = payload->buffer.size;
+
+	for (i = 0; i < count; i++) {
+		const struct lttng_trigger *trigger =
+				lttng_triggers_get_at_index(triggers, i);
+
+		assert(trigger);
+
+		ret = lttng_trigger_serialize(trigger, payload);
+		if (ret) {
+			goto end;
+		}
+	}
+
+	/* Update payload size. */
+	header = (struct lttng_triggers_comm *) ((char *) payload->buffer.data + header_offset);
+	header->length = payload->buffer.size - size_before_payload;
+end:
+	return ret;
+}
+
+LTTNG_HIDDEN
+ssize_t lttng_triggers_create_from_payload(
+		struct lttng_payload_view *src_view,
+		struct lttng_triggers **triggers)
+{
+	ssize_t ret, offset = 0, triggers_size = 0;
+	unsigned int i;
+	const struct lttng_triggers_comm *triggers_comm;
+	struct lttng_triggers *local_triggers = NULL;
+
+	if (!src_view || !triggers) {
+		ret = -1;
+		goto error;
+	}
+
+	/* lttng_trigger_comms header */
+	triggers_comm = (const struct lttng_triggers_comm *) src_view->buffer.data;
+	offset += sizeof(*triggers_comm);
+
+	local_triggers = lttng_triggers_create();
+	if (!local_triggers) {
+		ret = -1;
+		goto error;
+	}
+
+	for (i = 0; i < triggers_comm->count; i++) {
+		struct lttng_trigger *trigger = NULL;
+		struct lttng_payload_view trigger_view =
+				lttng_payload_view_from_view(src_view, offset, -1);
+		ssize_t trigger_size;
+
+		trigger_size = lttng_trigger_create_from_payload(
+				&trigger_view, &trigger);
+		if (trigger_size < 0) {
+			ret = trigger_size;
+			goto error;
+		}
+
+		/* Transfer ownership of the trigger to the collection. */
+		ret = lttng_triggers_add(local_triggers, trigger);
+		lttng_trigger_put(trigger);
+		if (ret < 0) {
+			ret = -1;
+			goto error;
+		}
+
+		offset += trigger_size;
+		triggers_size += trigger_size;
+	}
+
+	/* Unexpected size of inner-elements; the buffer is corrupted. */
+	if ((ssize_t) triggers_comm->length != triggers_size) {
+		ret = -1;
+		goto error;
+	}
+
+	/* Pass ownership to caller. */
+	*triggers = local_triggers;
+	local_triggers = NULL;
+
+	ret = offset;
+error:
+
+	lttng_triggers_destroy(local_triggers);
+	return ret;
+}
+
 LTTNG_HIDDEN
 const struct lttng_credentials *lttng_trigger_get_credentials(
 		const struct lttng_trigger *trigger)
@@ -495,3 +794,137 @@ enum lttng_trigger_status lttng_trigger_get_owner_uid(
 end:
 	return ret;
 }
+
+enum lttng_trigger_status lttng_trigger_set_firing_policy(
+		struct lttng_trigger *trigger,
+		enum lttng_trigger_firing_policy policy_type,
+		uint64_t threshold)
+{
+	enum lttng_trigger_status ret = LTTNG_TRIGGER_STATUS_OK;
+	assert(trigger);
+
+	if (threshold < 1) {
+		ret = LTTNG_TRIGGER_STATUS_INVALID;
+		goto end;
+	}
+
+	trigger->firing_policy.type = policy_type;
+	trigger->firing_policy.threshold = threshold;
+
+end:
+	return ret;
+}
+
+enum lttng_trigger_status lttng_trigger_get_firing_policy(
+		const struct lttng_trigger *trigger,
+		enum lttng_trigger_firing_policy *policy_type,
+		uint64_t *threshold)
+{
+	enum lttng_trigger_status status = LTTNG_TRIGGER_STATUS_OK;
+
+	if (!trigger || !policy_type || !threshold) {
+		status = LTTNG_TRIGGER_STATUS_INVALID;
+		goto end;
+	}
+
+	*policy_type = trigger->firing_policy.type;
+	*threshold = trigger->firing_policy.threshold;
+
+end:
+	return status;
+}
+
+LTTNG_HIDDEN
+bool lttng_trigger_should_fire(const struct lttng_trigger *trigger)
+{
+	bool ready_to_fire = false;
+
+	assert(trigger);
+
+	switch (trigger->firing_policy.type) {
+	case LTTNG_TRIGGER_FIRING_POLICY_EVERY_N:
+		if (trigger->firing_policy.current_count < trigger->firing_policy.threshold) {
+			ready_to_fire = true;
+		}
+		break;
+	case LTTNG_TRIGGER_FIRING_POLICY_ONCE_AFTER_N:
+		if (trigger->firing_policy.current_count < trigger->firing_policy.threshold) {
+			ready_to_fire = true;
+		}
+		break;
+	default:
+		abort();
+	};
+
+	return ready_to_fire;
+}
+
+LTTNG_HIDDEN
+void lttng_trigger_fire(struct lttng_trigger *trigger)
+{
+	assert(trigger);
+
+	trigger->firing_policy.current_count++;
+
+	switch (trigger->firing_policy.type) {
+	case LTTNG_TRIGGER_FIRING_POLICY_EVERY_N:
+		if (trigger->firing_policy.current_count == trigger->firing_policy.threshold) {
+			trigger->firing_policy.current_count = 0;
+		}
+
+		break;
+	case LTTNG_TRIGGER_FIRING_POLICY_ONCE_AFTER_N:
+		/*
+		 * TODO:
+		 * As an optimisation, deactivate the trigger condition and
+		 * remove any checks in the traced application or kernel since
+		 * the trigger will never fire again.
+		 */
+		break;
+	default:
+		abort();
+	};
+}
+
+LTTNG_HIDDEN
+enum lttng_domain_type lttng_trigger_get_underlying_domain_type_restriction(
+		const struct lttng_trigger *trigger)
+{
+	enum lttng_domain_type type = LTTNG_DOMAIN_NONE;
+	const struct lttng_event_rule *event_rule;
+	enum lttng_condition_status c_status;
+	enum lttng_condition_type c_type;
+
+	assert(trigger);
+	assert(trigger->condition);
+
+	c_type = lttng_condition_get_type(trigger->condition);
+	assert (c_type != LTTNG_CONDITION_TYPE_UNKNOWN);
+
+	switch (c_type) {
+	case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE:
+	case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING:
+	case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED:
+		/* Apply to any domain. */
+		type = LTTNG_DOMAIN_NONE;
+		break;
+	case LTTNG_CONDITION_TYPE_EVENT_RULE_HIT:
+		/* Return the domain of the event rule. */
+		c_status = lttng_condition_event_rule_get_rule(
+				trigger->condition, &event_rule);
+		assert(c_status == LTTNG_CONDITION_STATUS_OK);
+		type = lttng_event_rule_get_domain_type(event_rule);
+		break;
+	case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
+	case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
+		/* Return the domain of the channel being monitored. */
+		c_status = lttng_condition_buffer_usage_get_domain_type(
+				trigger->condition, &type);
+		assert(c_status == LTTNG_CONDITION_STATUS_OK);
+		break;
+	default:
+		abort();
+	}
+
+	return type;
+}