Fix: liblttng-ctl comm: lttng_channel is not packed
[lttng-tools.git] / src / lib / lttng-ctl / lttng-ctl.c
index 7debaed6b813d412404db52c277622cbd1be7154..92593cfac878b983a32b8bbc3fce23c4cab570e3 100644 (file)
@@ -3,7 +3,7 @@
  *
  * Linux Trace Toolkit Control Library
  *
- * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
+ * Copyright (C) 2011 EfficiOS Inc.
  * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
  * SPDX-License-Identifier: LGPL-2.1-only
@@ -15,6 +15,7 @@
 #include <grp.h>
 #include <stdio.h>
 #include <stdlib.h>
+#include <stdint.h>
 #include <string.h>
 #include <unistd.h>
 
@@ -292,12 +293,14 @@ end:
        return ret;
 }
 
-static int check_enough_available_memory(size_t num_bytes_requested_per_cpu)
+static enum lttng_error_code check_enough_available_memory(
+               uint64_t num_bytes_requested_per_cpu)
 {
        int ret;
+       enum lttng_error_code ret_code;
        long num_cpu;
-       size_t best_mem_info;
-       size_t num_bytes_requested_total;
+       uint64_t best_mem_info;
+       uint64_t num_bytes_requested_total;
 
        /*
         * Get the number of CPU currently online to compute the amount of
@@ -305,10 +308,18 @@ static int check_enough_available_memory(size_t num_bytes_requested_per_cpu)
         */
        num_cpu = sysconf(_SC_NPROCESSORS_ONLN);
        if (num_cpu == -1) {
-               goto error;
+               ret_code = LTTNG_ERR_FATAL;
+               goto end;
+       }
+
+       if (num_bytes_requested_per_cpu > UINT64_MAX / (uint64_t) num_cpu) {
+               /* Overflow */
+               ret_code = LTTNG_ERR_OVERFLOW;
+               goto end;
        }
 
-       num_bytes_requested_total = num_bytes_requested_per_cpu * num_cpu;
+       num_bytes_requested_total =
+                       num_bytes_requested_per_cpu * (uint64_t) num_cpu;
 
        /*
         * Try to get the `MemAvail` field of `/proc/meminfo`. This is the most
@@ -330,10 +341,18 @@ static int check_enough_available_memory(size_t num_bytes_requested_per_cpu)
                goto success;
        }
 
-error:
-       return -1;
+       /* No valid source of information. */
+       ret_code = LTTNG_ERR_NOMEM;
+       goto end;
+
 success:
-       return best_mem_info >= num_bytes_requested_total;
+       if (best_mem_info >= num_bytes_requested_total) {
+               ret_code = LTTNG_OK;
+       } else {
+               ret_code = LTTNG_ERR_NOMEM;
+       }
+end:
+       return ret_code;
 }
 
 /*
@@ -388,7 +407,7 @@ static int set_session_daemon_path(void)
                in_tgroup = lttng_check_tracing_group();
        }
 
-       if ((uid == 0) || in_tgroup) {
+       if ((uid == 0) || in_tgroup == 1) {
                const int ret = lttng_strncpy(sessiond_sock_path,
                                DEFAULT_GLOBAL_CLIENT_UNIX_SOCK,
                                sizeof(sessiond_sock_path));
@@ -1204,7 +1223,7 @@ int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
        for (i = 0; i < exclusion_count; i++) {
                size_t exclusion_len;
 
-               exclusion_len = lttng_strnlen(*(exclusion_list + i),
+               exclusion_len = lttng_strnlen(exclusion_list[i],
                                LTTNG_SYMBOL_NAME_LEN);
                if (exclusion_len == LTTNG_SYMBOL_NAME_LEN) {
                        /* Exclusion is not NULL-terminated. */
@@ -1213,7 +1232,17 @@ int lttng_enable_event_with_exclusions(struct lttng_handle *handle,
                }
 
                ret = lttng_dynamic_buffer_append(&payload.buffer,
-                               *(exclusion_list + i), LTTNG_SYMBOL_NAME_LEN);
+                               exclusion_list[i], exclusion_len);
+               if (ret) {
+                       goto mem_error;
+               }
+
+               /*
+                * Padding the rest of the entry with zeros. Every exclusion
+                * entries take LTTNG_SYMBOL_NAME_LEN bytes in the buffer.
+                */
+               ret = lttng_dynamic_buffer_set_size(&payload.buffer,
+                               LTTNG_SYMBOL_NAME_LEN * (i + 1));
                if (ret) {
                        goto mem_error;
                }
@@ -1509,10 +1538,9 @@ end:
 struct lttng_channel *lttng_channel_create(struct lttng_domain *domain)
 {
        struct lttng_channel *channel = NULL;
-       struct lttng_channel_extended *extended = NULL;
 
        if (!domain) {
-               goto error;
+               goto end;
        }
 
        /* Validate domain. */
@@ -1523,36 +1551,26 @@ struct lttng_channel *lttng_channel_create(struct lttng_domain *domain)
                case LTTNG_BUFFER_PER_PID:
                        break;
                default:
-                       goto error;
+                       goto end;
                }
                break;
        case LTTNG_DOMAIN_KERNEL:
                if (domain->buf_type != LTTNG_BUFFER_GLOBAL) {
-                       goto error;
+                       goto end;
                }
                break;
        default:
-               goto error;
+               goto end;
        }
 
-       channel = zmalloc(sizeof(*channel));
+       channel = lttng_channel_create_internal();
        if (!channel) {
-               goto error;
-       }
-
-       extended = zmalloc(sizeof(*extended));
-       if (!extended) {
-               goto error;
+               goto end;
        }
 
-       channel->attr.extended.ptr = extended;
-
        lttng_channel_set_default_attr(domain, &channel->attr);
+end:
        return channel;
-error:
-       free(channel);
-       free(extended);
-       return NULL;
 }
 
 void lttng_channel_destroy(struct lttng_channel *channel)
@@ -1574,53 +1592,65 @@ void lttng_channel_destroy(struct lttng_channel *channel)
 int lttng_enable_channel(struct lttng_handle *handle,
                struct lttng_channel *in_chan)
 {
+       enum lttng_error_code ret_code;
        int ret;
+       struct lttng_dynamic_buffer buffer;
        struct lttcomm_session_msg lsm;
-       size_t total_buffer_size_needed_per_cpu = 0;
+       uint64_t total_buffer_size_needed_per_cpu = 0;
+       struct lttng_channel *channel = NULL;
+
+       lttng_dynamic_buffer_init(&buffer);
 
        /* NULL arguments are forbidden. No default values. */
        if (handle == NULL || in_chan == NULL) {
-               return -LTTNG_ERR_INVALID;
+               ret = -LTTNG_ERR_INVALID;
+               goto end;
        }
 
-       memset(&lsm, 0, sizeof(lsm));
-       memcpy(&lsm.u.channel.chan, in_chan, sizeof(lsm.u.channel.chan));
-       lsm.u.channel.chan.attr.extended.ptr = NULL;
+       /*
+        * Verify that the amount of memory required to create the requested
+        * buffer is available on the system at the moment.
+        */
+       if (in_chan->attr.num_subbuf >
+                       UINT64_MAX / in_chan->attr.subbuf_size) {
+               /* Overflow */
+               ret = -LTTNG_ERR_OVERFLOW;
+               goto end;
+       }
 
-       if (!in_chan->attr.extended.ptr) {
-               struct lttng_channel *channel;
-               struct lttng_channel_extended *extended;
+       total_buffer_size_needed_per_cpu =
+                       in_chan->attr.num_subbuf * in_chan->attr.subbuf_size;
+       ret_code = check_enough_available_memory(
+                       total_buffer_size_needed_per_cpu);
+       if (ret_code != LTTNG_OK) {
+               ret = -ret_code;
+               goto end;
+       }
 
-               channel = lttng_channel_create(&handle->domain);
-               if (!channel) {
-                       return -LTTNG_ERR_NOMEM;
-               }
+       /* Copy the channel for easier manipulation. */
+       channel = lttng_channel_copy(in_chan);
+       if (!channel) {
+               ret = -LTTNG_ERR_NOMEM;
+               goto end;
+       }
 
-               /*
-                * Create a new channel in order to use default extended
-                * attribute values.
-                */
-               extended = (struct lttng_channel_extended *)
-                               channel->attr.extended.ptr;
-               memcpy(&lsm.u.channel.extended, extended, sizeof(*extended));
-               lttng_channel_destroy(channel);
-       } else {
-               struct lttng_channel_extended *extended;
+       /* Populate the channel extended attribute if necessary. */
+       if (!channel->attr.extended.ptr) {
+               struct lttng_channel_extended *extended =
+                               (struct lttng_channel_extended *) zmalloc(
+                                               sizeof(*extended));
 
-               extended = (struct lttng_channel_extended *)
-                               in_chan->attr.extended.ptr;
-               memcpy(&lsm.u.channel.extended, extended, sizeof(*extended));
+               if (!extended) {
+                       ret = -LTTNG_ERR_NOMEM;
+                       goto end;
+               }
+               lttng_channel_set_default_extended_attr(
+                               &handle->domain, extended);
+               channel->attr.extended.ptr = extended;
        }
 
-       /*
-        * Verify that the amount of memory required to create the requested
-        * buffer is available on the system at the moment.
-        */
-       total_buffer_size_needed_per_cpu = lsm.u.channel.chan.attr.num_subbuf *
-               lsm.u.channel.chan.attr.subbuf_size;
-       if (!check_enough_available_memory(total_buffer_size_needed_per_cpu)) {
-               return -LTTNG_ERR_NOMEM;
-       }
+       /* Prepare the payload */
+       memset(&lsm, 0, sizeof(lsm));
 
        lsm.cmd_type = LTTNG_ENABLE_CHANNEL;
        COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
@@ -1632,8 +1662,19 @@ int lttng_enable_channel(struct lttng_handle *handle,
                goto end;
        }
 
-       ret = lttng_ctl_ask_sessiond(&lsm, NULL);
+       ret = lttng_channel_serialize(channel, &buffer);
+       if (ret) {
+               ret = -LTTNG_ERR_FATAL;
+               goto end;
+       }
+
+       lsm.u.channel.length = buffer.size;
+
+       ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(
+                       &lsm, buffer.data, buffer.size, NULL);
 end:
+       lttng_channel_destroy(channel);
+       lttng_dynamic_buffer_reset(&buffer);
        return ret;
 }
 
@@ -2092,6 +2133,12 @@ int lttng_list_sessions(struct lttng_session **out_sessions)
 
        memset(&lsm, 0, sizeof(lsm));
        lsm.cmd_type = LTTNG_LIST_SESSIONS;
+       /*
+        * Initialize out_sessions to NULL so it is initialized when
+        * lttng_list_sessions returns 0, thus allowing *out_sessions to
+        * be subsequently freed.
+        */
+       *out_sessions = NULL;
        ret = lttng_ctl_ask_sessiond(&lsm, (void**) &sessions);
        if (ret <= 0) {
                goto end;
@@ -2104,7 +2151,6 @@ int lttng_list_sessions(struct lttng_session **out_sessions)
        if (ret % session_size) {
                ret = -LTTNG_ERR_UNK;
                free(sessions);
-               *out_sessions = NULL;
                goto end;
        }
        session_count = (size_t) ret / session_size;
@@ -2226,12 +2272,14 @@ error:
 int lttng_list_channels(struct lttng_handle *handle,
                struct lttng_channel **channels)
 {
-       int ret;
-       size_t channel_count, i;
-       const size_t channel_size = sizeof(struct lttng_channel) +
-                       sizeof(struct lttng_channel_extended);
+       int ret, total_payload_received;
        struct lttcomm_session_msg lsm;
-       void *extended_at;
+       char *reception_buffer = NULL;
+       size_t cmd_header_len = 0;
+       struct lttcomm_list_command_header *cmd_header = NULL;
+       struct lttng_dynamic_buffer tmp_buffer;
+
+       lttng_dynamic_buffer_init(&tmp_buffer);
 
        if (handle == NULL) {
                ret = -LTTNG_ERR_INVALID;
@@ -2249,31 +2297,48 @@ int lttng_list_channels(struct lttng_handle *handle,
 
        COPY_DOMAIN_PACKED(lsm.domain, handle->domain);
 
-       ret = lttng_ctl_ask_sessiond(&lsm, (void**) channels);
+       ret = lttng_ctl_ask_sessiond_fds_varlen(&lsm, NULL, 0, NULL, 0,
+                       (void **) &reception_buffer, (void **) &cmd_header,
+                       &cmd_header_len);
        if (ret < 0) {
                goto end;
        }
 
-       if (ret % channel_size) {
-               ret = -LTTNG_ERR_UNK;
-               free(*channels);
-               *channels = NULL;
+       total_payload_received = ret;
+
+       if (cmd_header_len != sizeof(*cmd_header)) {
+               ret = -LTTNG_ERR_FATAL;
                goto end;
        }
-       channel_count = (size_t) ret / channel_size;
 
-       /* Set extended info pointers */
-       extended_at = ((void *) *channels) +
-                       channel_count * sizeof(struct lttng_channel);
-       for (i = 0; i < channel_count; i++) {
-               struct lttng_channel *chan = &(*channels)[i];
+       if (!cmd_header) {
+               ret = LTTNG_ERR_UNK;
+               goto end;
+       }
+
+       if (cmd_header->count > INT_MAX) {
+               ret = -LTTNG_ERR_OVERFLOW;
+               goto end;
+       }
 
-               chan->attr.extended.ptr = extended_at;
-               extended_at += sizeof(struct lttng_channel_extended);
+       {
+               enum lttng_error_code ret_code;
+               const struct lttng_buffer_view events_view =
+                               lttng_buffer_view_init(reception_buffer, 0,
+                                               total_payload_received);
+
+               ret_code = lttng_channels_create_and_flatten_from_buffer(
+                               &events_view, cmd_header->count, channels);
+               if (ret_code != LTTNG_OK) {
+                       ret = -ret_code;
+                       goto end;
+               }
        }
 
-       ret = (int) channel_count;
+       ret = (int) cmd_header->count;
 end:
+       free(cmd_header);
+       free(reception_buffer);
        return ret;
 }
 
@@ -2608,14 +2673,19 @@ end:
  */
 int lttng_set_tracing_group(const char *name)
 {
+       char *new_group;
        if (name == NULL) {
                return -LTTNG_ERR_INVALID;
        }
 
-       if (asprintf(&tracing_group, "%s", name) < 0) {
+       if (asprintf(&new_group, "%s", name) < 0) {
                return -LTTNG_ERR_FATAL;
        }
 
+       free(tracing_group);
+       tracing_group = new_group;
+       new_group = NULL;
+
        return 0;
 }
 
@@ -2642,6 +2712,7 @@ void lttng_channel_set_default_attr(struct lttng_domain *domain,
                return;
        }
 
+       /* Save the pointer for later use */
        extended = (struct lttng_channel_extended *) attr->extended.ptr;
        memset(attr, 0, sizeof(struct lttng_channel_attr));
 
@@ -2658,12 +2729,6 @@ void lttng_channel_set_default_attr(struct lttng_domain *domain,
                attr->subbuf_size = default_get_kernel_channel_subbuf_size();
                attr->num_subbuf = DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM;
                attr->output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
-               if (extended) {
-                       extended->monitor_timer_interval =
-                                       DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER;
-                       extended->blocking_timeout =
-                                       DEFAULT_KERNEL_CHANNEL_BLOCKING_TIMEOUT;
-               }
                break;
        case LTTNG_DOMAIN_UST:
                switch (domain->buf_type) {
@@ -2675,12 +2740,6 @@ void lttng_channel_set_default_attr(struct lttng_domain *domain,
                                        DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER;
                        attr->read_timer_interval =
                                        DEFAULT_UST_UID_CHANNEL_READ_TIMER;
-                       if (extended) {
-                               extended->monitor_timer_interval =
-                                               DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER;
-                               extended->blocking_timeout =
-                                               DEFAULT_UST_UID_CHANNEL_BLOCKING_TIMEOUT;
-                       }
                        break;
                case LTTNG_BUFFER_PER_PID:
                default:
@@ -2691,12 +2750,6 @@ void lttng_channel_set_default_attr(struct lttng_domain *domain,
                                        DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER;
                        attr->read_timer_interval =
                                        DEFAULT_UST_PID_CHANNEL_READ_TIMER;
-                       if (extended) {
-                               extended->monitor_timer_interval =
-                                               DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER;
-                               extended->blocking_timeout =
-                                               DEFAULT_UST_PID_CHANNEL_BLOCKING_TIMEOUT;
-                       }
                        break;
                }
        default:
@@ -2704,6 +2757,11 @@ void lttng_channel_set_default_attr(struct lttng_domain *domain,
                break;
        }
 
+       if (extended) {
+               lttng_channel_set_default_extended_attr(domain, extended);
+       }
+
+       /* Reassign the extended pointer. */
        attr->extended.ptr = extended;
 }
 
@@ -3082,11 +3140,14 @@ end:
        return ret;
 }
 
-int lttng_register_trigger(struct lttng_trigger *trigger)
+static
+int _lttng_register_trigger(struct lttng_trigger *trigger, const char *name,
+               bool generate_name)
 {
        int ret;
        struct lttcomm_session_msg lsm = {
                .cmd_type = LTTNG_REGISTER_TRIGGER,
+               .u.trigger.is_trigger_anonymous = !name && !generate_name,
        };
        struct lttcomm_session_msg *message_lsm;
        struct lttng_payload message;
@@ -3097,6 +3158,8 @@ int lttng_register_trigger(struct lttng_trigger *trigger)
                .uid = LTTNG_OPTIONAL_INIT_VALUE(geteuid()),
                .gid = LTTNG_OPTIONAL_INIT_UNSET,
        };
+       const char *unused_trigger_name = NULL;
+       enum lttng_trigger_status trigger_status;
 
        lttng_payload_init(&message);
        lttng_payload_init(&reply);
@@ -3106,6 +3169,21 @@ int lttng_register_trigger(struct lttng_trigger *trigger)
                goto end;
        }
 
+       trigger_status = lttng_trigger_get_name(trigger, &unused_trigger_name);
+       if (trigger_status != LTTNG_TRIGGER_STATUS_UNSET) {
+               /* Re-using already registered trigger. */
+               ret = -LTTNG_ERR_INVALID;
+               goto end;
+       }
+
+       if (name) {
+               trigger_status = lttng_trigger_set_name(trigger, name);
+               if (trigger_status != LTTNG_TRIGGER_STATUS_OK) {
+                       ret = -LTTNG_ERR_NOMEM;
+                       goto end;
+               }
+       }
+
        if (!trigger->creds.uid.is_set) {
                /* Use the client's credentials as the trigger credentials. */
                lttng_trigger_set_credentials(trigger, &user_creds);
@@ -3126,14 +3204,14 @@ int lttng_register_trigger(struct lttng_trigger *trigger)
                if (!lttng_credentials_is_equal_uid(trigger_creds, &user_creds)) {
                        if (lttng_credentials_get_uid(&user_creds) != 0) {
                                ret = -LTTNG_ERR_EPERM;
-                               goto end;
+                               goto end_unset_name;
                        }
                }
        }
 
        if (!lttng_trigger_validate(trigger)) {
                ret = -LTTNG_ERR_INVALID_TRIGGER;
-               goto end;
+               goto end_unset_name;
        }
 
        domain_type = lttng_trigger_get_underlying_domain_type_restriction(
@@ -3144,13 +3222,13 @@ int lttng_register_trigger(struct lttng_trigger *trigger)
        ret = lttng_dynamic_buffer_append(&message.buffer, &lsm, sizeof(lsm));
        if (ret) {
                ret = -LTTNG_ERR_NOMEM;
-               goto end;
+               goto end_unset_name;
        }
 
        ret = lttng_trigger_serialize(trigger, &message);
        if (ret < 0) {
                ret = -LTTNG_ERR_UNK;
-               goto end;
+               goto end_unset_name;
        }
 
        /*
@@ -3170,7 +3248,7 @@ int lttng_register_trigger(struct lttng_trigger *trigger)
                                &message_view);
                ret = lttng_ctl_ask_sessiond_payload(&message_view, &reply);
                if (ret < 0) {
-                       goto end;
+                       goto end_unset_name;
                }
        }
 
@@ -3182,18 +3260,27 @@ int lttng_register_trigger(struct lttng_trigger *trigger)
                ret = lttng_trigger_create_from_payload(
                                &reply_view, &reply_trigger);
                if (ret < 0) {
-                       ret = -LTTNG_ERR_FATAL;
-                       goto end;
+                       ret = -LTTNG_ERR_INVALID_PROTOCOL;
+                       goto end_unset_name;
                }
        }
 
-       ret = lttng_trigger_assign_name(trigger, reply_trigger);
-       if (ret < 0) {
-               ret = -LTTNG_ERR_FATAL;
-               goto end;
+       if (name || generate_name) {
+               ret = lttng_trigger_assign_name(trigger, reply_trigger);
+               if (ret < 0) {
+                       ret = -LTTNG_ERR_NOMEM;
+                       goto end;
+               }
        }
 
        ret = 0;
+       goto end;
+
+end_unset_name:
+       trigger_status = lttng_trigger_set_name(trigger, NULL);
+       if (trigger_status != LTTNG_TRIGGER_STATUS_OK) {
+               ret = -LTTNG_ERR_UNK;
+       }
 end:
        lttng_payload_reset(&message);
        lttng_payload_reset(&reply);
@@ -3201,6 +3288,28 @@ end:
        return ret;
 }
 
+int lttng_register_trigger(struct lttng_trigger *trigger)
+{
+       /* Register an anonymous trigger. */
+       return _lttng_register_trigger(trigger, NULL, false);
+}
+
+enum lttng_error_code lttng_register_trigger_with_name(
+               struct lttng_trigger *trigger, const char *name)
+{
+       const int ret = _lttng_register_trigger(trigger, name, false);
+
+       return ret == 0 ? LTTNG_OK : (enum lttng_error_code) -ret;
+}
+
+enum lttng_error_code lttng_register_trigger_with_automatic_name(
+               struct lttng_trigger *trigger)
+{
+       const int ret =  _lttng_register_trigger(trigger, false, true);
+
+       return ret == 0 ? LTTNG_OK : (enum lttng_error_code) -ret;
+}
+
 enum lttng_error_code lttng_error_query_execute(
                const struct lttng_error_query *query,
                const struct lttng_endpoint *endpoint,
@@ -3344,18 +3453,18 @@ int lttng_unregister_trigger(const struct lttng_trigger *trigger)
                goto end;
        }
 
-       /*
-        * This is needed to populate the trigger object size for the command
-        * header and number of fds sent.
-       */
-       message_lsm = (struct lttcomm_session_msg *) message.buffer.data;
-
        ret = lttng_trigger_serialize(copy, &message);
        if (ret < 0) {
                ret = -LTTNG_ERR_UNK;
                goto end;
        }
 
+       /*
+        * This is needed to populate the trigger object size for the command
+        * header and number of fds sent.
+       */
+       message_lsm = (struct lttcomm_session_msg *) message.buffer.data;
+
        message_lsm->u.trigger.length = (uint32_t) message.buffer.size - sizeof(lsm);
 
        {
This page took 0.031784 seconds and 4 git commands to generate.