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

diff --git a/src/common/trigger.c b/src/common/trigger.c
index a4130ec31..af0c5fa34 100644
--- a/src/common/trigger.c
+++ b/src/common/trigger.c
@@ -1,25 +1,20 @@
 /*
- * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * This library is free software; you can redistribute it and/or modify it
- * under the terms of the GNU Lesser General Public License, version 2.1 only,
- * as published by the Free Software Foundation.
+ * SPDX-License-Identifier: LGPL-2.1-only
  *
- * This library is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
- * for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this library; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
 #include <lttng/trigger/trigger-internal.h>
 #include <lttng/condition/condition-internal.h>
 #include <lttng/action/action-internal.h>
+#include <common/credentials.h>
+#include <common/payload.h>
+#include <common/payload-view.h>
 #include <common/error.h>
+#include <common/optional.h>
 #include <assert.h>
+#include <inttypes.h>
 
 LTTNG_HIDDEN
 bool lttng_trigger_validate(struct lttng_trigger *trigger)
@@ -31,6 +26,11 @@ bool lttng_trigger_validate(struct lttng_trigger *trigger)
 		goto end;
 	}
 
+	if (!trigger->creds.uid.is_set) {
+		valid = false;
+		goto end;
+	}
+
 	valid = lttng_condition_validate(trigger->condition) &&
 			lttng_action_validate(trigger->action);
 end:
@@ -52,12 +52,23 @@ struct lttng_trigger *lttng_trigger_create(
 		goto end;
 	}
 
+	urcu_ref_init(&trigger->ref);
+
+	lttng_condition_get(condition);
 	trigger->condition = condition;
+
+	lttng_action_get(action);
 	trigger->action = action;
+
 end:
 	return trigger;
 }
 
+/*
+ * Note: the lack of reference counting 'get' on the condition object is normal.
+ * This API was exposed as such in 2.11. The client is not expected to call
+ * lttng_condition_destroy on the returned object.
+ */
 struct lttng_condition *lttng_trigger_get_condition(
 		struct lttng_trigger *trigger)
 {
@@ -71,6 +82,12 @@ const struct lttng_condition *lttng_trigger_get_const_condition(
 	return trigger->condition;
 }
 
+
+/*
+ * Note: the lack of reference counting 'get' on the action object is normal.
+ * This API was exposed as such in 2.11. The client is not expected to call
+ * lttng_action_destroy on the returned object.
+ */
 struct lttng_action *lttng_trigger_get_action(
 		struct lttng_trigger *trigger)
 {
@@ -84,26 +101,44 @@ const struct lttng_action *lttng_trigger_get_const_action(
 	return trigger->action;
 }
 
-void lttng_trigger_destroy(struct lttng_trigger *trigger)
+static void trigger_destroy_ref(struct urcu_ref *ref)
 {
-	if (!trigger) {
-		return;
-	}
+	struct lttng_trigger *trigger =
+			container_of(ref, struct lttng_trigger, ref);
+	struct lttng_action *action = lttng_trigger_get_action(trigger);
+	struct lttng_condition *condition =
+			lttng_trigger_get_condition(trigger);
+
+	assert(action);
+	assert(condition);
 
+	/* Release ownership. */
+	lttng_action_put(action);
+	lttng_condition_put(condition);
+
+	free(trigger->name);
 	free(trigger);
 }
 
+void lttng_trigger_destroy(struct lttng_trigger *trigger)
+{
+	lttng_trigger_put(trigger);
+}
+
 LTTNG_HIDDEN
-ssize_t lttng_trigger_create_from_buffer(
-		const struct lttng_buffer_view *src_view,
+ssize_t lttng_trigger_create_from_payload(
+		struct lttng_payload_view *src_view,
 		struct lttng_trigger **trigger)
 {
-	ssize_t ret, offset = 0, condition_size, action_size;
+	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;
-	struct lttng_buffer_view condition_view;
-	struct lttng_buffer_view action_view;
+	const char *name = NULL;
+	struct lttng_credentials creds = {
+		.uid = LTTNG_OPTIONAL_INIT_UNSET,
+		.gid = LTTNG_OPTIONAL_INIT_UNSET,
+	};
 
 	if (!src_view || !trigger) {
 		ret = -1;
@@ -111,23 +146,61 @@ ssize_t lttng_trigger_create_from_buffer(
 	}
 
 	/* lttng_trigger_comm header */
-	trigger_comm = (const struct lttng_trigger_comm *) src_view->data;
+	trigger_comm = (typeof(trigger_comm)) src_view->buffer.data;
+
+	/* Set the trigger's creds. */
+	if (trigger_comm->uid > (uint64_t) ((uid_t) -1)) {
+		/* UID out of range for this platform. */
+		ret = -1;
+		goto end;
+	}
+
+	LTTNG_OPTIONAL_SET(&creds.uid, trigger_comm->uid);
+
 	offset += sizeof(*trigger_comm);
 
-	condition_view = lttng_buffer_view_from_view(src_view, offset, -1);
+	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);
+
+		name = name_view.buffer.data;
+		if (!lttng_buffer_view_contains_string(&name_view.buffer, name,
+				    trigger_comm->name_length)) {
+			ret = -1;
+			goto end;
+		}
+
+		offset += trigger_comm->name_length;
+		name_size = trigger_comm->name_length;
+	}
+
+	{
+		/* struct lttng_condition */
+		struct lttng_payload_view condition_view =
+				lttng_payload_view_from_view(
+						src_view, offset, -1);
+
+		condition_size = lttng_condition_create_from_payload(&condition_view,
+				&condition);
+	}
 
-	/* struct lttng_condition */
-	condition_size = lttng_condition_create_from_buffer(&condition_view,
-			&condition);
 	if (condition_size < 0) {
 		ret = condition_size;
 		goto end;
 	}
+
 	offset += condition_size;
+	{
+		/* struct lttng_action */
+		struct lttng_payload_view action_view =
+				lttng_payload_view_from_view(
+					src_view, offset, -1);
+
+		action_size = lttng_action_create_from_payload(&action_view, &action);
+	}
 
-	/* struct lttng_action */
-	action_view = lttng_buffer_view_from_view(src_view, offset, -1);
-	action_size = lttng_action_create_from_buffer(&action_view, &action);
 	if (action_size < 0) {
 		ret = action_size;
 		goto end;
@@ -135,7 +208,7 @@ ssize_t lttng_trigger_create_from_buffer(
 	offset += action_size;
 
 	/* Unexpected size of inner-elements; the buffer is corrupted. */
-	if ((ssize_t) trigger_comm->length != condition_size + action_size) {
+	if ((ssize_t) trigger_comm->length != condition_size + action_size + name_size) {
 		ret = -1;
 		goto error;
 	}
@@ -145,12 +218,35 @@ ssize_t lttng_trigger_create_from_buffer(
 		ret = -1;
 		goto error;
 	}
+
+	lttng_trigger_set_credentials(*trigger, &creds);
+
+	/*
+	 * The trigger object owns references to the action and condition
+	 * objects.
+	 */
+	lttng_condition_put(condition);
+	condition = NULL;
+
+	lttng_action_put(action);
+	action = NULL;
+
+	if (name) {
+		const enum lttng_trigger_status status =
+				lttng_trigger_set_name(*trigger, name);
+
+		if (status != LTTNG_TRIGGER_STATUS_OK) {
+			ret = -1;
+			goto end;
+		}
+	}
+
 	ret = offset;
-end:
-	return ret;
+
 error:
 	lttng_condition_destroy(condition);
 	lttng_action_destroy(action);
+end:
 	return ret;
 }
 
@@ -160,34 +256,242 @@ error:
  */
 LTTNG_HIDDEN
 int lttng_trigger_serialize(struct lttng_trigger *trigger,
-		struct lttng_dynamic_buffer *buf)
+		struct lttng_payload *payload)
 {
 	int ret;
-	size_t header_offset, size_before_payload;
-	struct lttng_trigger_comm trigger_comm = { 0 };
+	size_t header_offset, size_before_payload, size_name;
+	struct lttng_trigger_comm trigger_comm = {};
 	struct lttng_trigger_comm *header;
+	const struct lttng_credentials *creds = NULL;
+
+	creds = lttng_trigger_get_credentials(trigger);
+	assert(creds);
 
-	header_offset = buf->size;
-	ret = lttng_dynamic_buffer_append(buf, &trigger_comm,
+	trigger_comm.uid = LTTNG_OPTIONAL_GET(creds->uid);
+
+	if (trigger->name != NULL) {
+		size_name = strlen(trigger->name) + 1;
+	} else {
+		size_name = 0;
+	}
+
+	trigger_comm.name_length = size_name;
+
+	header_offset = payload->buffer.size;
+	ret = lttng_dynamic_buffer_append(&payload->buffer, &trigger_comm,
 			sizeof(trigger_comm));
 	if (ret) {
 		goto end;
 	}
 
-	size_before_payload = buf->size;
-	ret = lttng_condition_serialize(trigger->condition, buf);
+	size_before_payload = payload->buffer.size;
+
+	/* Trigger name. */
+	ret = lttng_dynamic_buffer_append(
+			&payload->buffer, trigger->name, size_name);
+	if (ret) {
+		goto end;
+	}
+
+	ret = lttng_condition_serialize(trigger->condition, payload);
 	if (ret) {
 		goto end;
 	}
 
-	ret = lttng_action_serialize(trigger->action, buf);
+	ret = lttng_action_serialize(trigger->action, payload);
 	if (ret) {
 		goto end;
 	}
 
 	/* Update payload size. */
-	header = (struct lttng_trigger_comm *) ((char *) buf->data + header_offset);
-	header->length = buf->size - size_before_payload;
+	header = (typeof(header)) (payload->buffer.data + header_offset);
+	header->length = payload->buffer.size - size_before_payload;
+end:
+	return ret;
+}
+
+LTTNG_HIDDEN
+bool lttng_trigger_is_equal(
+		const struct lttng_trigger *a, const struct lttng_trigger *b)
+{
+	/*
+	 * Name is not taken into account since it is cosmetic only.
+	 */
+	if (!lttng_condition_is_equal(a->condition, b->condition)) {
+		return false;
+	}
+
+	if (!lttng_action_is_equal(a->action, b->action)) {
+		return false;
+	}
+
+	if (!lttng_credentials_is_equal(lttng_trigger_get_credentials(a),
+			lttng_trigger_get_credentials(b))) {
+		return false;
+	}
+
+	return true;
+}
+
+enum lttng_trigger_status lttng_trigger_set_name(struct lttng_trigger *trigger,
+		const char* name)
+{
+	char *name_copy = NULL;
+	enum lttng_trigger_status status = LTTNG_TRIGGER_STATUS_OK;
+
+	if (!trigger || !name ||
+			strlen(name) == 0) {
+		status = LTTNG_TRIGGER_STATUS_INVALID;
+		goto end;
+	}
+
+	name_copy = strdup(name);
+	if (!name_copy) {
+		status = LTTNG_TRIGGER_STATUS_ERROR;
+		goto end;
+	}
+
+	free(trigger->name);
+
+	trigger->name = name_copy;
+	name_copy = NULL;
+end:
+	return status;
+}
+
+enum lttng_trigger_status lttng_trigger_get_name(
+		const struct lttng_trigger *trigger, const char **name)
+{
+	enum lttng_trigger_status status = LTTNG_TRIGGER_STATUS_OK;
+
+	if (!trigger || !name) {
+		status = LTTNG_TRIGGER_STATUS_INVALID;
+		goto end;
+	}
+
+	if (!trigger->name) {
+		status = LTTNG_TRIGGER_STATUS_UNSET;
+	}
+
+	*name = trigger->name;
+end:
+	return status;
+}
+
+LTTNG_HIDDEN
+int lttng_trigger_assign_name(struct lttng_trigger *dst,
+		const struct lttng_trigger *src)
+{
+	int ret = 0;
+	enum lttng_trigger_status status;
+
+	status = lttng_trigger_set_name(dst, src->name);
+	if (status != LTTNG_TRIGGER_STATUS_OK) {
+		ret = -1;
+		ERR("Failed to set name for trigger");
+		goto end;
+	}
+end:
+	return ret;
+}
+
+LTTNG_HIDDEN
+int lttng_trigger_generate_name(struct lttng_trigger *trigger,
+		uint64_t unique_id)
+{
+	int ret = 0;
+	char *generated_name = NULL;
+
+	ret = asprintf(&generated_name, "T%" PRIu64 "", unique_id);
+	if (ret < 0) {
+		ERR("Failed to generate trigger name");
+		ret = -1;
+		goto end;
+	}
+
+	ret = 0;
+	free(trigger->name);
+	trigger->name = generated_name;
+end:
+	return ret;
+}
+
+LTTNG_HIDDEN
+void lttng_trigger_get(struct lttng_trigger *trigger)
+{
+	urcu_ref_get(&trigger->ref);
+}
+
+LTTNG_HIDDEN
+void lttng_trigger_put(struct lttng_trigger *trigger)
+{
+	if (!trigger) {
+		return;
+	}
+
+	urcu_ref_put(&trigger->ref , trigger_destroy_ref);
+}
+
+LTTNG_HIDDEN
+const struct lttng_credentials *lttng_trigger_get_credentials(
+		const struct lttng_trigger *trigger)
+{
+	return &trigger->creds;
+}
+
+LTTNG_HIDDEN
+void lttng_trigger_set_credentials(struct lttng_trigger *trigger,
+		const struct lttng_credentials *creds)
+{
+	assert(creds);
+	trigger->creds = *creds;
+}
+
+enum lttng_trigger_status lttng_trigger_set_owner_uid(
+		struct lttng_trigger *trigger, uid_t uid)
+{
+	enum lttng_trigger_status ret = LTTNG_TRIGGER_STATUS_OK;
+	const struct lttng_credentials creds = {
+		.uid = LTTNG_OPTIONAL_INIT_VALUE(uid),
+		.gid = LTTNG_OPTIONAL_INIT_UNSET,
+	};
+
+	if (!trigger) {
+		ret = LTTNG_TRIGGER_STATUS_INVALID;
+		goto end;
+	}
+
+	/* Client-side validation only to report a clearer error. */
+	if (geteuid() != 0) {
+		ret = LTTNG_TRIGGER_STATUS_PERMISSION_DENIED;
+		goto end;
+	}
+
+	lttng_trigger_set_credentials(trigger, &creds);
+
+end:
+	return ret;
+}
+
+enum lttng_trigger_status lttng_trigger_get_owner_uid(
+		const struct lttng_trigger *trigger, uid_t *uid)
+{
+	enum lttng_trigger_status ret = LTTNG_TRIGGER_STATUS_OK;
+	const struct lttng_credentials *creds = NULL;
+
+	if (!trigger || !uid ) {
+		ret = LTTNG_TRIGGER_STATUS_INVALID;
+		goto end;
+	}
+
+	if (!trigger->creds.uid.is_set ) {
+		ret = LTTNG_TRIGGER_STATUS_UNSET;
+		goto end;
+	}
+
+	creds = lttng_trigger_get_credentials(trigger);
+	*uid = lttng_credentials_get_uid(creds);
+
 end:
 	return ret;
 }