liblttng-ctl: use lttng_payload for serialize/create_from_buffer
[lttng-tools.git] / src / lib / lttng-ctl / lttng-ctl.c
index 20dca8132186e46531589d9294b31a44dc52e9b3..b74c78749857bbc2a26c5799a9dd08bf06670ea7 100644 (file)
@@ -4,20 +4,10 @@
  * Linux Trace Toolkit Control Library
  *
  * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
- * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2016 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
  */
 
 #define _LGPL_SOURCE
 #include <common/common.h>
 #include <common/compat/string.h>
 #include <common/defaults.h>
+#include <common/dynamic-buffer.h>
+#include <common/sessiond-comm/payload.h>
+#include <common/sessiond-comm/payload-view.h>
 #include <common/sessiond-comm/sessiond-comm.h>
+#include <common/tracker.h>
 #include <common/uri.h>
 #include <common/utils.h>
-#include <common/dynamic-buffer.h>
-#include <lttng/lttng.h>
-#include <lttng/health-internal.h>
-#include <lttng/trigger/trigger-internal.h>
-#include <lttng/endpoint.h>
 #include <lttng/channel-internal.h>
+#include <lttng/destruction-handle.h>
+#include <lttng/endpoint.h>
 #include <lttng/event-internal.h>
-#include <lttng/userspace-probe-internal.h>
-#include <lttng/session-internal.h>
+#include <lttng/health-internal.h>
+#include <lttng/lttng.h>
 #include <lttng/session-descriptor-internal.h>
+#include <lttng/session-internal.h>
+#include <lttng/trigger/trigger-internal.h>
+#include <lttng/userspace-probe-internal.h>
 
 #include "filter/filter-ast.h"
 #include "filter/filter-parser.h"
@@ -66,9 +60,16 @@ do {                                                         \
 } while (0)
 #endif
 
+#define COPY_DOMAIN_PACKED(dst, src)                           \
+do {                                                           \
+       struct lttng_domain _tmp_domain;                        \
+                                                               \
+       lttng_ctl_copy_lttng_domain(&_tmp_domain, &src);        \
+       dst = _tmp_domain;                                      \
+} while (0)
 
 /* Socket to session daemon for communication */
-static int sessiond_socket;
+static int sessiond_socket = -1;
 static char sessiond_sock_path[PATH_MAX];
 
 /* Variables */
@@ -423,17 +424,12 @@ error:
 /*
  * Connect to the LTTng session daemon.
  *
- * On success, return 0. On error, return -1.
+ * On success, return the socket's file descriptor. On error, return -1.
  */
-static int connect_sessiond(void)
+LTTNG_HIDDEN int connect_sessiond(void)
 {
        int ret;
 
-       /* Don't try to connect if already connected. */
-       if (connected) {
-               return 0;
-       }
-
        ret = set_session_daemon_path();
        if (ret < 0) {
                goto error;
@@ -445,15 +441,18 @@ static int connect_sessiond(void)
                goto error;
        }
 
-       sessiond_socket = ret;
-       connected = 1;
-
-       return 0;
+       return ret;
 
 error:
        return -1;
 }
 
+static void reset_global_sessiond_connection_state(void)
+{
+       sessiond_socket = -1;
+       connected = 0;
+}
+
 /*
  *  Clean disconnect from the session daemon.
  *
@@ -465,8 +464,7 @@ static int disconnect_sessiond(void)
 
        if (connected) {
                ret = lttcomm_close_unix_sock(sessiond_socket);
-               sessiond_socket = 0;
-               connected = 0;
+               reset_global_sessiond_connection_state();
        }
 
        return ret;
@@ -541,6 +539,9 @@ int lttng_ctl_ask_sessiond_fds_varlen(struct lttcomm_session_msg *lsm,
        if (ret < 0) {
                ret = -LTTNG_ERR_NO_SESSIOND;
                goto end;
+       } else {
+               sessiond_socket = ret;
+               connected = 1;
        }
 
        /* Send command to session daemon */
@@ -652,7 +653,7 @@ int lttng_register_consumer(struct lttng_handle *handle,
        lsm.cmd_type = LTTNG_REGISTER_CONSUMER;
        lttng_ctl_copy_string(lsm.session.name, handle->session_name,
                        sizeof(lsm.session.name));
-       lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
+       COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
 
        lttng_ctl_copy_string(lsm.u.reg.path, socket_path,
                        sizeof(lsm.u.reg.path));
@@ -723,7 +724,7 @@ static int _lttng_stop_tracing(const char *session_name, int wait)
                 * call returned value indicates availability.
                 */
                if (data_ret) {
-                       usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME);
+                       usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US);
                }
        } while (data_ret != 0);
 
@@ -783,7 +784,7 @@ int lttng_add_context(struct lttng_handle *handle,
                                sizeof(lsm.u.context.channel_name));
        }
 
-       lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
+       COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
        lttng_ctl_copy_string(lsm.session.name, handle->session_name,
                        sizeof(lsm.session.name));
 
@@ -897,7 +898,7 @@ static char *set_agent_filter(const char *filter, struct lttng_event *ev)
 
        /* Add loglevel filtering if any for the JUL domain. */
        if (ev->loglevel_type != LTTNG_EVENT_LOGLEVEL_ALL) {
-               char *op;
+               const char *op;
 
                if (ev->loglevel_type == LTTNG_EVENT_LOGLEVEL_RANGE) {
                        op = ">=";
@@ -1123,8 +1124,7 @@ int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
                lttng_ctl_copy_string(ev->name, "*", sizeof(ev->name));
        }
 
-       lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
-       /* FIXME: copying non-packed struct to packed struct. */
+       COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
        memcpy(&lsm.u.enable.event, ev, sizeof(lsm.u.enable.event));
 
        lttng_ctl_copy_string(lsm.session.name, handle->session_name,
@@ -1317,8 +1317,7 @@ int lttng_disable_event_ext(struct lttng_handle *handle,
 
        lsm.cmd_type = LTTNG_DISABLE_EVENT;
 
-       lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
-       /* FIXME: copying non-packed struct to packed struct. */
+       COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
        memcpy(&lsm.u.disable.event, ev, sizeof(lsm.u.disable.event));
 
        lttng_ctl_copy_string(lsm.session.name, handle->session_name,
@@ -1564,7 +1563,7 @@ int lttng_enable_channel(struct lttng_handle *handle,
        }
 
        lsm.cmd_type = LTTNG_ENABLE_CHANNEL;
-       lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
+       COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
 
        lttng_ctl_copy_string(lsm.session.name, handle->session_name,
                        sizeof(lsm.session.name));
@@ -1592,59 +1591,7 @@ int lttng_disable_channel(struct lttng_handle *handle, const char *name)
        lttng_ctl_copy_string(lsm.u.disable.channel_name, name,
                        sizeof(lsm.u.disable.channel_name));
 
-       lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
-
-       lttng_ctl_copy_string(lsm.session.name, handle->session_name,
-                       sizeof(lsm.session.name));
-
-       return lttng_ctl_ask_sessiond(&lsm, NULL);
-}
-
-/*
- * Add PID to session tracker.
- * Return 0 on success else a negative LTTng error code.
- */
-int lttng_track_pid(struct lttng_handle *handle, int pid)
-{
-       struct lttcomm_session_msg lsm;
-
-       /* NULL arguments are forbidden. No default values. */
-       if (handle == NULL) {
-               return -LTTNG_ERR_INVALID;
-       }
-
-       memset(&lsm, 0, sizeof(lsm));
-
-       lsm.cmd_type = LTTNG_TRACK_PID;
-       lsm.u.pid_tracker.pid = pid;
-
-       lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
-
-       lttng_ctl_copy_string(lsm.session.name, handle->session_name,
-                       sizeof(lsm.session.name));
-
-       return lttng_ctl_ask_sessiond(&lsm, NULL);
-}
-
-/*
- * Remove PID from session tracker.
- * Return 0 on success else a negative LTTng error code.
- */
-int lttng_untrack_pid(struct lttng_handle *handle, int pid)
-{
-       struct lttcomm_session_msg lsm;
-
-       /* NULL arguments are forbidden. No default values. */
-       if (handle == NULL) {
-               return -LTTNG_ERR_INVALID;
-       }
-
-       memset(&lsm, 0, sizeof(lsm));
-
-       lsm.cmd_type = LTTNG_UNTRACK_PID;
-       lsm.u.pid_tracker.pid = pid;
-
-       lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
+       COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
 
        lttng_ctl_copy_string(lsm.session.name, handle->session_name,
                        sizeof(lsm.session.name));
@@ -1670,7 +1617,7 @@ int lttng_list_tracepoints(struct lttng_handle *handle,
 
        memset(&lsm, 0, sizeof(lsm));
        lsm.cmd_type = LTTNG_LIST_TRACEPOINTS;
-       lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
+       COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
 
        ret = lttng_ctl_ask_sessiond(&lsm, (void **) events);
        if (ret < 0) {
@@ -1698,7 +1645,7 @@ int lttng_list_tracepoint_fields(struct lttng_handle *handle,
 
        memset(&lsm, 0, sizeof(lsm));
        lsm.cmd_type = LTTNG_LIST_TRACEPOINT_FIELDS;
-       lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
+       COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
 
        ret = lttng_ctl_ask_sessiond(&lsm, (void **) fields);
        if (ret < 0) {
@@ -1830,7 +1777,7 @@ end:
 /*
  * Create a new session using name and url for destination.
  *
- * Returns LTTNG_OK on success or a negative error code.
+ * Return 0 on success else a negative LTTng error code.
  */
 int lttng_create_session(const char *name, const char *url)
 {
@@ -1885,7 +1832,7 @@ end:
 /*
  * Create a session exclusively used for snapshot.
  *
- * Returns LTTNG_OK on success or a negative error code.
+ * Return 0 on success else a negative LTTng error code.
  */
 int lttng_create_session_snapshot(const char *name, const char *snapshot_url)
 {
@@ -1961,7 +1908,7 @@ end:
 /*
  * Create a session exclusively used for live.
  *
- * Returns LTTNG_OK on success or a negative error code.
+ * Return 0 on success else a negative LTTng error code.
  */
 int lttng_create_session_live(const char *name, const char *url,
                unsigned int timer_interval)
@@ -1993,45 +1940,49 @@ end:
        return ret;
 }
 
-/*
- * Destroy session using name.
- * Returns size of returned session payload data or a negative error code.
- */
-static
-int _lttng_destroy_session(const char *session_name)
-{
-       struct lttcomm_session_msg lsm;
-
-       if (session_name == NULL) {
-               return -LTTNG_ERR_INVALID;
-       }
-
-       memset(&lsm, 0, sizeof(lsm));
-       lsm.cmd_type = LTTNG_DESTROY_SESSION;
-
-       lttng_ctl_copy_string(lsm.session.name, session_name,
-                       sizeof(lsm.session.name));
-
-       return lttng_ctl_ask_sessiond(&lsm, NULL);
-}
-
 /*
  * Stop the session and wait for the data before destroying it
+ *
+ * Return 0 on success else a negative LTTng error code.
  */
 int lttng_destroy_session(const char *session_name)
 {
        int ret;
+       enum lttng_error_code ret_code;
+       enum lttng_destruction_handle_status status;
+       struct lttng_destruction_handle *handle = NULL;
 
        /*
-        * Stop the tracing and wait for the data.
+        * Stop the tracing and wait for the data to be
+        * consumed.
         */
        ret = _lttng_stop_tracing(session_name, 1);
        if (ret && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) {
                goto end;
        }
 
-       ret = _lttng_destroy_session(session_name);
+       ret_code = lttng_destroy_session_ext(session_name, &handle);
+       if (ret_code != LTTNG_OK) {
+               ret = (int) -ret_code;
+               goto end;
+       }
+       assert(handle);
+
+       /* Block until the completion of the destruction of the session. */
+       status = lttng_destruction_handle_wait_for_completion(handle, -1);
+       if (status != LTTNG_DESTRUCTION_HANDLE_STATUS_COMPLETED) {
+               ret = -LTTNG_ERR_UNK;
+               goto end;
+       }
+
+       status = lttng_destruction_handle_get_result(handle, &ret_code);
+       if (status != LTTNG_DESTRUCTION_HANDLE_STATUS_OK) {
+               ret = -LTTNG_ERR_UNK;
+               goto end;
+       }
+       ret = ret_code == LTTNG_OK ? 0 : -ret_code;
 end:
+       lttng_destruction_handle_destroy(handle);
        return ret;
 }
 
@@ -2040,21 +1991,10 @@ end:
  */
 int lttng_destroy_session_no_wait(const char *session_name)
 {
-       int ret;
-
-       /*
-        * Stop the tracing without waiting for the data.
-        * The session might already have been stopped, so just
-        * skip this error.
-        */
-       ret = _lttng_stop_tracing(session_name, 0);
-       if (ret && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) {
-               goto end;
-       }
+       enum lttng_error_code ret_code;
 
-       ret = _lttng_destroy_session(session_name);
-end:
-       return ret;
+       ret_code = lttng_destroy_session_ext(session_name, NULL);
+       return ret_code == LTTNG_OK ? ret_code : -ret_code;
 }
 
 /*
@@ -2207,7 +2147,7 @@ int lttng_list_channels(struct lttng_handle *handle,
        lttng_ctl_copy_string(lsm.session.name, handle->session_name,
                        sizeof(lsm.session.name));
 
-       lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
+       COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
 
        ret = lttng_ctl_ask_sessiond(&lsm, (void**) channels);
        if (ret < 0) {
@@ -2267,7 +2207,7 @@ int lttng_list_events(struct lttng_handle *handle,
                        sizeof(lsm.session.name));
        lttng_ctl_copy_string(lsm.u.list.channel_name, channel_name,
                        sizeof(lsm.u.list.channel_name));
-       lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
+       COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
 
        ret = lttng_ctl_ask_sessiond_fds_varlen(&lsm, NULL, 0, NULL, 0,
                (void **) &reception_buffer, (void **) &cmd_header,
@@ -2284,7 +2224,7 @@ int lttng_list_events(struct lttng_handle *handle,
        /* Set number of events and free command header */
        nb_events = cmd_header->nb_events;
        if (nb_events > INT_MAX) {
-               ret = -EOVERFLOW;
+               ret = -LTTNG_ERR_OVERFLOW;
                goto end;
        }
        free(cmd_header);
@@ -2794,7 +2734,7 @@ int lttng_set_consumer_url(struct lttng_handle *handle,
 
        lttng_ctl_copy_string(lsm.session.name, handle->session_name,
                        sizeof(lsm.session.name));
-       lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
+       COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
 
        size = uri_parse_str_urls(control_url, data_url, &uris);
        if (size < 0) {
@@ -2813,6 +2753,7 @@ int lttng_set_consumer_url(struct lttng_handle *handle,
 /*
  * [OBSOLETE]
  */
+int lttng_enable_consumer(struct lttng_handle *handle);
 int lttng_enable_consumer(struct lttng_handle *handle)
 {
        return -ENOSYS;
@@ -2821,6 +2762,7 @@ int lttng_enable_consumer(struct lttng_handle *handle)
 /*
  * [OBSOLETE]
  */
+int lttng_disable_consumer(struct lttng_handle *handle);
 int lttng_disable_consumer(struct lttng_handle *handle)
 {
        return -ENOSYS;
@@ -2829,6 +2771,8 @@ int lttng_disable_consumer(struct lttng_handle *handle)
 /*
  * [OBSOLETE]
  */
+int _lttng_create_session_ext(const char *name, const char *url,
+               const char *datetime);
 int _lttng_create_session_ext(const char *name, const char *url,
                const char *datetime)
 {
@@ -2863,6 +2807,10 @@ int lttng_data_pending(const char *session_name)
                /* Unexpected payload size */
                ret = -LTTNG_ERR_INVALID;
                goto end;
+       } else if (!pending) {
+               /* Internal error. */
+               ret = -LTTNG_ERR_UNK;
+               goto end;
        }
 
        ret = (int) *pending;
@@ -2871,55 +2819,6 @@ end:
        return ret;
 }
 
-/*
- * List PIDs in the tracker.
- *
- * enabled is set to whether the PID tracker is enabled.
- * pids is set to an allocated array of PIDs currently tracked. On
- * success, pids must be freed by the caller.
- * nr_pids is set to the number of entries contained by the pids array.
- *
- * Returns 0 on success, else a negative LTTng error code.
- */
-int lttng_list_tracker_pids(struct lttng_handle *handle,
-               int *_enabled, int32_t **_pids, size_t *_nr_pids)
-{
-       int ret;
-       int enabled = 1;
-       struct lttcomm_session_msg lsm;
-       size_t nr_pids;
-       int32_t *pids = NULL;
-
-       if (handle == NULL) {
-               return -LTTNG_ERR_INVALID;
-       }
-
-       memset(&lsm, 0, sizeof(lsm));
-       lsm.cmd_type = LTTNG_LIST_TRACKER_PIDS;
-       lttng_ctl_copy_string(lsm.session.name, handle->session_name,
-                       sizeof(lsm.session.name));
-       lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain);
-
-       ret = lttng_ctl_ask_sessiond(&lsm, (void **) &pids);
-       if (ret < 0) {
-               return ret;
-       }
-       nr_pids = ret / sizeof(int32_t);
-       if (nr_pids > 0 && !pids) {
-               return -LTTNG_ERR_UNK;
-       }
-       if (nr_pids == 1 && pids[0] == -1) {
-               free(pids);
-               pids = NULL;
-               enabled = 0;
-               nr_pids = 0;
-       }
-       *_enabled = enabled;
-       *_pids = pids;
-       *_nr_pids = nr_pids;
-       return 0;
-}
-
 /*
  * Regenerate the metadata for a session.
  * Return 0 on success, a negative error code on error.
@@ -2992,9 +2891,9 @@ int lttng_register_trigger(struct lttng_trigger *trigger)
 {
        int ret;
        struct lttcomm_session_msg lsm;
-       struct lttng_dynamic_buffer buffer;
+       struct lttng_payload payload;
 
-       lttng_dynamic_buffer_init(&buffer);
+       lttng_payload_init(&payload);
        if (!trigger) {
                ret = -LTTNG_ERR_INVALID;
                goto end;
@@ -3005,7 +2904,7 @@ int lttng_register_trigger(struct lttng_trigger *trigger)
                goto end;
        }
 
-       ret = lttng_trigger_serialize(trigger, &buffer);
+       ret = lttng_trigger_serialize(trigger, &payload);
        if (ret < 0) {
                ret = -LTTNG_ERR_UNK;
                goto end;
@@ -3013,11 +2912,11 @@ int lttng_register_trigger(struct lttng_trigger *trigger)
 
        memset(&lsm, 0, sizeof(lsm));
        lsm.cmd_type = LTTNG_REGISTER_TRIGGER;
-       lsm.u.trigger.length = (uint32_t) buffer.size;
-       ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, buffer.data,
-                       buffer.size, NULL);
+       lsm.u.trigger.length = (uint32_t) payload.buffer.size;
+       ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(
+                       &lsm, payload.buffer.data, payload.buffer.size, NULL);
 end:
-       lttng_dynamic_buffer_reset(&buffer);
+       lttng_payload_reset(&payload);
        return ret;
 }
 
@@ -3025,9 +2924,9 @@ int lttng_unregister_trigger(struct lttng_trigger *trigger)
 {
        int ret;
        struct lttcomm_session_msg lsm;
-       struct lttng_dynamic_buffer buffer;
+       struct lttng_payload payload;
 
-       lttng_dynamic_buffer_init(&buffer);
+       lttng_payload_init(&payload);
        if (!trigger) {
                ret = -LTTNG_ERR_INVALID;
                goto end;
@@ -3038,7 +2937,7 @@ int lttng_unregister_trigger(struct lttng_trigger *trigger)
                goto end;
        }
 
-       ret = lttng_trigger_serialize(trigger, &buffer);
+       ret = lttng_trigger_serialize(trigger, &payload);
        if (ret < 0) {
                ret = -LTTNG_ERR_UNK;
                goto end;
@@ -3046,11 +2945,11 @@ int lttng_unregister_trigger(struct lttng_trigger *trigger)
 
        memset(&lsm, 0, sizeof(lsm));
        lsm.cmd_type = LTTNG_UNREGISTER_TRIGGER;
-       lsm.u.trigger.length = (uint32_t) buffer.size;
-       ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, buffer.data,
-                       buffer.size, NULL);
+       lsm.u.trigger.length = (uint32_t) payload.buffer.size;
+       ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(
+                       &lsm, payload.buffer.data, payload.buffer.size, NULL);
 end:
-       lttng_dynamic_buffer_reset(&buffer);
+       lttng_payload_reset(&payload);
        return ret;
 }
 
This page took 0.031126 seconds and 4 git commands to generate.