SoW-2019-0002: Dynamic Snapshot
[lttng-tools.git] / src / common / actions / action.c
diff --git a/src/common/actions/action.c b/src/common/actions/action.c
new file mode 100644 (file)
index 0000000..cab49ae
--- /dev/null
@@ -0,0 +1,254 @@
+/*
+ * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ *
+ * SPDX-License-Identifier: LGPL-2.1-only
+ *
+ */
+
+#include <assert.h>
+#include <common/error.h>
+#include <lttng/action/action-internal.h>
+#include <lttng/action/group-internal.h>
+#include <lttng/action/notify-internal.h>
+#include <lttng/action/rotate-session-internal.h>
+#include <lttng/action/snapshot-session-internal.h>
+#include <lttng/action/start-session-internal.h>
+#include <lttng/action/stop-session-internal.h>
+
+LTTNG_HIDDEN
+const char *lttng_action_type_string(enum lttng_action_type action_type)
+{
+       switch (action_type) {
+       case LTTNG_ACTION_TYPE_UNKNOWN:
+               return "UNKNOWN";
+
+       case LTTNG_ACTION_TYPE_GROUP:
+               return "GROUP";
+
+       case LTTNG_ACTION_TYPE_NOTIFY:
+               return "NOTIFY";
+
+       case LTTNG_ACTION_TYPE_ROTATE_SESSION:
+               return "ROTATE_SESSION";
+
+       case LTTNG_ACTION_TYPE_SNAPSHOT_SESSION:
+               return "SNAPSHOT_SESSION";
+
+       case LTTNG_ACTION_TYPE_START_SESSION:
+               return "START_SESSION";
+
+       case LTTNG_ACTION_TYPE_STOP_SESSION:
+               return "STOP_SESSION";
+
+       default:
+               return "???";
+       }
+}
+
+enum lttng_action_type lttng_action_get_type(const struct lttng_action *action)
+{
+       return action ? action->type : LTTNG_ACTION_TYPE_UNKNOWN;
+}
+
+LTTNG_HIDDEN
+enum lttng_action_type lttng_action_get_type_const(
+               const struct lttng_action *action)
+{
+       return action->type;
+}
+
+LTTNG_HIDDEN
+void lttng_action_init(
+               struct lttng_action *action,
+               enum lttng_action_type type,
+               action_validate_cb validate,
+               action_serialize_cb serialize,
+               action_equal_cb equal,
+               action_destroy_cb destroy)
+{
+       urcu_ref_init(&action->ref);
+       action->type = type;
+       action->validate = validate;
+       action->serialize = serialize;
+       action->equal = equal;
+       action->destroy = destroy;
+}
+
+static
+void action_destroy_ref(struct urcu_ref *ref)
+{
+       struct lttng_action *action =
+                       container_of(ref, struct lttng_action, ref);
+
+       action->destroy(action);
+}
+
+LTTNG_HIDDEN
+void lttng_action_get(struct lttng_action *action)
+{
+       urcu_ref_get(&action->ref);
+}
+
+LTTNG_HIDDEN
+void lttng_action_put(struct lttng_action *action)
+{
+       if (!action) {
+               return;
+       }
+
+       assert(action->destroy);
+       urcu_ref_put(&action->ref, action_destroy_ref);
+}
+
+void lttng_action_destroy(struct lttng_action *action)
+{
+       lttng_action_put(action);
+}
+
+LTTNG_HIDDEN
+bool lttng_action_validate(struct lttng_action *action)
+{
+       bool valid;
+
+       if (!action) {
+               valid = false;
+               goto end;
+       }
+
+       if (!action->validate) {
+               /* Sub-class guarantees that it can never be invalid. */
+               valid = true;
+               goto end;
+       }
+
+       valid = action->validate(action);
+end:
+       return valid;
+}
+
+LTTNG_HIDDEN
+int lttng_action_serialize(struct lttng_action *action,
+               struct lttng_dynamic_buffer *buf)
+{
+       int ret;
+       struct lttng_action_comm action_comm = {
+               .action_type = (int8_t) action->type,
+       };
+
+       ret = lttng_dynamic_buffer_append(buf, &action_comm,
+                       sizeof(action_comm));
+       if (ret) {
+               goto end;
+       }
+
+       ret = action->serialize(action, buf);
+       if (ret) {
+               goto end;
+       }
+end:
+       return ret;
+}
+
+LTTNG_HIDDEN
+ssize_t lttng_action_create_from_buffer(const struct lttng_buffer_view *view,
+               struct lttng_action **action)
+{
+       ssize_t consumed_len, specific_action_consumed_len;
+       const struct lttng_action_comm *action_comm;
+       action_create_from_buffer_cb create_from_buffer_cb;
+       struct lttng_buffer_view specific_action_view;
+
+       if (!view || !action) {
+               consumed_len = -1;
+               goto end;
+       }
+
+       action_comm = (const struct lttng_action_comm *) view->data;
+
+       DBG("Create action from buffer: action-type=%s",
+                       lttng_action_type_string(action_comm->action_type));
+
+       switch (action_comm->action_type) {
+       case LTTNG_ACTION_TYPE_NOTIFY:
+               create_from_buffer_cb = lttng_action_notify_create_from_buffer;
+               break;
+
+       case LTTNG_ACTION_TYPE_ROTATE_SESSION:
+               create_from_buffer_cb =
+                               lttng_action_rotate_session_create_from_buffer;
+               break;
+
+       case LTTNG_ACTION_TYPE_SNAPSHOT_SESSION:
+               create_from_buffer_cb =
+                               lttng_action_snapshot_session_create_from_buffer;
+               break;
+
+       case LTTNG_ACTION_TYPE_START_SESSION:
+               create_from_buffer_cb =
+                               lttng_action_start_session_create_from_buffer;
+               break;
+
+       case LTTNG_ACTION_TYPE_STOP_SESSION:
+               create_from_buffer_cb =
+                               lttng_action_stop_session_create_from_buffer;
+               break;
+
+       case LTTNG_ACTION_TYPE_GROUP:
+               create_from_buffer_cb = lttng_action_group_create_from_buffer;
+               break;
+
+       default:
+               ERR("Failed to create action from buffer, unhandled action type: action-type=%u (%s)",
+                               action_comm->action_type,
+                               lttng_action_type_string(
+                                               action_comm->action_type));
+               consumed_len = -1;
+               goto end;
+       }
+
+       /* Create buffer view for the action-type-specific data. */
+       specific_action_view = lttng_buffer_view_from_view(view,
+                       sizeof(struct lttng_action_comm),
+                       view->size - sizeof(struct lttng_action_comm));
+
+       specific_action_consumed_len =
+                       create_from_buffer_cb(&specific_action_view, action);
+       if (specific_action_consumed_len < 0) {
+               ERR("Failed to create specific action from buffer.");
+               consumed_len = -1;
+               goto end;
+       }
+
+       assert(*action);
+
+       consumed_len = sizeof(struct lttng_action_comm) +
+                      specific_action_consumed_len;
+
+end:
+       return consumed_len;
+}
+
+LTTNG_HIDDEN
+bool lttng_action_is_equal(const struct lttng_action *a,
+               const struct lttng_action *b)
+{
+       bool is_equal = false;
+
+       if (!a || !b) {
+               goto end;
+       }
+
+       if (a->type != b->type) {
+               goto end;
+       }
+
+       if (a == b) {
+               is_equal = true;
+               goto end;
+       }
+
+       is_equal = a->equal ? a->equal(a, b) : true;
+end:
+       return is_equal;
+}
+
This page took 0.025894 seconds and 5 git commands to generate.