trigger: use condition and action ref counting to ease internal objects management
[lttng-tools.git] / src / common / trigger.c
index 70b7e29e5d164bd0f29c72268ad4cacf3e00225b..2ccf0073589a64d3f5fb8fc98bb5daea3b5bb848 100644 (file)
@@ -1,24 +1,18 @@
 /*
- * 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>
 
 LTTNG_HIDDEN
@@ -52,44 +46,82 @@ struct lttng_trigger *lttng_trigger_create(
                goto end;
        }
 
+       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)
 {
        return trigger ? trigger->condition : NULL;
 }
 
+LTTNG_HIDDEN
+const struct lttng_condition *lttng_trigger_get_const_condition(
+               const struct lttng_trigger *trigger)
+{
+       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)
 {
        return trigger ? trigger->action : NULL;
 }
 
+LTTNG_HIDDEN
+const struct lttng_action *lttng_trigger_get_const_action(
+               const struct lttng_trigger *trigger)
+{
+       return trigger->action;
+}
+
 void lttng_trigger_destroy(struct lttng_trigger *trigger)
 {
+       struct lttng_action *action = lttng_trigger_get_action(trigger);
+       struct lttng_condition *condition =
+                       lttng_trigger_get_condition(trigger);
+
        if (!trigger) {
                return;
        }
 
+       assert(action);
+       assert(condition);
+
+       /* Release ownership. */
+       lttng_action_put(action);
+       lttng_condition_put(condition);
+
        free(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;
        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;
 
        if (!src_view || !trigger) {
                ret = -1;
@@ -97,23 +129,33 @@ 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;
        offset += sizeof(*trigger_comm);
+       {
+               /* 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);
+       }
 
-       condition_view = lttng_buffer_view_from_view(src_view, offset, -1);
-
-       /* 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;
@@ -131,53 +173,76 @@ ssize_t lttng_trigger_create_from_buffer(
                ret = -1;
                goto error;
        }
+
+       /*
+        * The trigger object owns references to the action and condition
+        * objects.
+        */
+       lttng_condition_put(condition);
+       condition = NULL;
+
+       lttng_action_put(action);
+       action = NULL;
+
        ret = offset;
-end:
-       return ret;
+
 error:
        lttng_condition_destroy(condition);
        lttng_action_destroy(action);
+end:
        return ret;
 }
 
 /*
- * Returns the size of a trigger (header + condition + action).
  * Both elements are stored contiguously, see their "*_comm" structure
  * for the detailed format.
  */
 LTTNG_HIDDEN
-ssize_t lttng_trigger_serialize(struct lttng_trigger *trigger, char *buf)
+int lttng_trigger_serialize(struct lttng_trigger *trigger,
+               struct lttng_payload *payload)
 {
-       struct lttng_trigger_comm trigger_comm = { 0 };
-       ssize_t action_size, condition_size, offset = 0, ret;
-
-       if (!trigger) {
-               ret = -1;
+       int ret;
+       size_t header_offset, size_before_payload;
+       struct lttng_trigger_comm trigger_comm = {};
+       struct lttng_trigger_comm *header;
+
+       header_offset = payload->buffer.size;
+       ret = lttng_dynamic_buffer_append(&payload->buffer, &trigger_comm,
+                       sizeof(trigger_comm));
+       if (ret) {
                goto end;
        }
 
-       offset += sizeof(trigger_comm);
-       condition_size = lttng_condition_serialize(trigger->condition,
-                       buf ? (buf + offset) : NULL);
-       if (condition_size < 0) {
-               ret = -1;
+       size_before_payload = payload->buffer.size;
+       ret = lttng_condition_serialize(trigger->condition, payload);
+       if (ret) {
                goto end;
        }
-       offset += condition_size;
 
-       action_size = lttng_action_serialize(trigger->action,
-                       buf ? (buf + offset) : NULL);
-       if (action_size < 0) {
-               ret = -1;
+       ret = lttng_action_serialize(trigger->action, payload);
+       if (ret) {
                goto end;
        }
-       offset += action_size;
 
-       if (buf) {
-               trigger_comm.length = (uint32_t) (condition_size + action_size);
-               memcpy(buf, &trigger_comm, sizeof(trigger_comm));
-       }
-       ret = offset;
+       /* Update payload size. */
+       header = (typeof(header)) (payload->buffer.data + header_offset);
+       header->length = payload->buffer.size - size_before_payload;
 end:
        return ret;
 }
+
+LTTNG_HIDDEN
+const struct lttng_credentials *lttng_trigger_get_credentials(
+               const struct lttng_trigger *trigger)
+{
+       return LTTNG_OPTIONAL_GET_PTR(trigger->creds);
+}
+
+LTTNG_HIDDEN
+void lttng_trigger_set_credentials(
+               struct lttng_trigger *trigger,
+               const struct lttng_credentials *creds)
+{
+       assert(creds);
+       LTTNG_OPTIONAL_SET(&trigger->creds, *creds);
+}
This page took 0.026974 seconds and 5 git commands to generate.