Fix: split UST per UID/PID default values
[lttng-tools.git] / src / bin / lttng / commands / enable_channels.c
index 039750bcb99dc8c7e95d902e5d26656eb3b8c3ea..caada7deb038efd75a6e953ab730dd1826e47566 100644 (file)
 #include <sys/types.h>
 #include <unistd.h>
 #include <inttypes.h>
+#include <assert.h>
+#include <ctype.h>
 
 #include "../command.h"
+#include "../utils.h"
 
 #include <src/common/sessiond-comm/sessiond-comm.h>
 #include <src/common/utils.h>
@@ -101,30 +104,42 @@ static void usage(FILE *ofp)
        fprintf(ofp, "      --overwrite          Flight recorder mode%s\n",
                DEFAULT_CHANNEL_OVERWRITE ? " (default)" : "");
        fprintf(ofp, "      --subbuf-size SIZE   Subbuffer size in bytes {+k,+M,+G}\n");
-       fprintf(ofp, "                               (default: %zu, kernel default: %zu)\n",
-               default_get_channel_subbuf_size(),
-               default_get_kernel_channel_subbuf_size());
-       fprintf(ofp, "                               Needs to be a power of 2 for\n");
-        fprintf(ofp, "                               kernel and ust tracers\n");
+       fprintf(ofp, "                               (default UST uid: %zu, UST pid: %zu, kernel: %zu, metadata: %zu)\n",
+               default_get_ust_uid_channel_subbuf_size(),
+               default_get_ust_pid_channel_subbuf_size(),
+               default_get_kernel_channel_subbuf_size(),
+               default_get_metadata_subbuf_size());
+       fprintf(ofp, "                               Rounded up to the next power of 2.\n");
        fprintf(ofp, "      --num-subbuf NUM     Number of subbufers\n");
-       fprintf(ofp, "                               (default: %u)\n",
-               DEFAULT_CHANNEL_SUBBUF_NUM);
-       fprintf(ofp, "                               Needs to be a power of 2 for\n");
-        fprintf(ofp, "                               kernel and ust tracers\n");
-       fprintf(ofp, "      --switch-timer USEC  Switch timer interval in usec (default: %u)\n",
-               DEFAULT_CHANNEL_SWITCH_TIMER);
-       fprintf(ofp, "      --read-timer USEC    Read timer interval in usec (UST default: %u, kernel default: %u)\n",
-               DEFAULT_UST_CHANNEL_READ_TIMER, DEFAULT_KERNEL_CHANNEL_READ_TIMER);
+       fprintf(ofp, "                               (default UST uid: %u, UST pid: %u, kernel: %u, metadata: %u)\n",
+               DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM, DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM,
+               DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM, DEFAULT_METADATA_SUBBUF_NUM);
+       fprintf(ofp, "                               Rounded up to the next power of 2.\n");
+       fprintf(ofp, "      --switch-timer USEC  Switch timer interval in usec\n");
+       fprintf(ofp, "                               (default UST uid: %u, UST pid: %u, kernel: %u, metadata: %u)\n",
+               DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER, DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER,
+               DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER, DEFAULT_METADATA_SWITCH_TIMER);
+       fprintf(ofp, "      --read-timer USEC    Read timer interval in usec.\n");
+       fprintf(ofp, "                               (default UST uid: %u, UST pid: %u, kernel: %u, metadata: %u)\n",
+               DEFAULT_UST_UID_CHANNEL_READ_TIMER, DEFAULT_UST_UID_CHANNEL_READ_TIMER,
+               DEFAULT_KERNEL_CHANNEL_READ_TIMER, DEFAULT_METADATA_READ_TIMER);
        fprintf(ofp, "      --output TYPE        Channel output type (Values: %s, %s)\n",
                        output_mmap, output_splice);
+       fprintf(ofp, "                               (default UST uid: %s, UST pid: %s, kernel: %s, metadata: %s)\n",
+                       DEFAULT_UST_UID_CHANNEL_OUTPUT == LTTNG_EVENT_MMAP ? output_mmap : output_splice,
+                       DEFAULT_UST_PID_CHANNEL_OUTPUT == LTTNG_EVENT_MMAP ? output_mmap : output_splice,
+                       DEFAULT_KERNEL_CHANNEL_OUTPUT == LTTNG_EVENT_MMAP ? output_mmap : output_splice,
+                       DEFAULT_METADATA_OUTPUT == LTTNG_EVENT_MMAP ? output_mmap : output_splice);
        fprintf(ofp, "      --buffers-uid        Use per UID buffer (-u only)\n");
        fprintf(ofp, "      --buffers-pid        Use per PID buffer (-u only)\n");
        fprintf(ofp, "      --buffers-global     Use shared buffer for the whole system (-k only)\n");
        fprintf(ofp, "  -C, --tracefile-size SIZE\n");
-       fprintf(ofp, "                           Maximum size of each tracefile within a stream (in bytes).\n");
+       fprintf(ofp, "                           Maximum size of each tracefile within a stream (in bytes). 0 means unlimited.\n");
+       fprintf(ofp, "                               (default: %u)\n", DEFAULT_CHANNEL_TRACEFILE_SIZE);
        fprintf(ofp, "  -W, --tracefile-count COUNT\n");
        fprintf(ofp, "                           Used in conjunction with -C option, this will limit the number\n");
-       fprintf(ofp, "                           of files created to the specified count.\n");
+       fprintf(ofp, "                           of files created to the specified count. 0 means unlimited.\n");
+       fprintf(ofp, "                               (default: %u)\n", DEFAULT_CHANNEL_TRACEFILE_COUNT);
        fprintf(ofp, "\n");
 }
 
@@ -207,11 +222,9 @@ static int enable_channel(char *session_name)
 
        if ((chan.attr.tracefile_size > 0) &&
                        (chan.attr.tracefile_size < chan.attr.subbuf_size)) {
-               ERR("Tracefile_size must be greater than or equal to subbuf_size "
-                               "(%" PRIu64 " < %" PRIu64 ")",
+               WARN("Tracefile size rounded up from (%" PRIu64 ") to subbuffer size (%" PRIu64 ")",
                                chan.attr.tracefile_size, chan.attr.subbuf_size);
-               ret = CMD_ERROR;
-               goto error;
+               chan.attr.tracefile_size = chan.attr.subbuf_size;
        }
 
        /* Setting channel output */
@@ -321,52 +334,139 @@ int cmd_enable_channels(int argc, const char **argv)
                        DBG("Channel set to overwrite");
                        break;
                case OPT_SUBBUF_SIZE:
+               {
+                       uint64_t rounded_size;
+                       int order;
+
                        /* Parse the size */
                        opt_arg = poptGetOptArg(pc);
-                       if (utils_parse_size_suffix(opt_arg, &chan.attr.subbuf_size) < 0) {
-                               ERR("Wrong value the --subbuf-size parameter: %s", opt_arg);
+                       if (utils_parse_size_suffix(opt_arg, &chan.attr.subbuf_size) < 0 || !chan.attr.subbuf_size) {
+                               ERR("Wrong value in --subbuf-size parameter: %s", opt_arg);
                                ret = CMD_ERROR;
                                goto end;
                        }
 
-                       /* Check if power of 2 */
-                       if ((chan.attr.subbuf_size - 1) & chan.attr.subbuf_size) {
-                               ERR("The subbuf size is not a power of 2: %" PRIu64 " (%s)",
-                                               chan.attr.subbuf_size, opt_arg);
-                               ret = CMD_ERROR;
-                               goto end;
+                       order = get_count_order_u64(chan.attr.subbuf_size);
+                       assert(order >= 0);
+                       rounded_size = 1ULL << order;
+                       if (rounded_size != chan.attr.subbuf_size) {
+                               WARN("The subbuf size (%" PRIu64 ") is rounded to the next power of 2 (%" PRIu64 ")",
+                                               chan.attr.subbuf_size, rounded_size);
+                               chan.attr.subbuf_size = rounded_size;
                        }
 
+                       /* Should now be power of 2 */
+                       assert(!((chan.attr.subbuf_size - 1) & chan.attr.subbuf_size));
+
                        DBG("Channel subbuf size set to %" PRIu64, chan.attr.subbuf_size);
                        break;
+               }
                case OPT_NUM_SUBBUF:
-                       /* TODO Replace atoi with strtol and check for errors */
-                       chan.attr.num_subbuf = atoi(poptGetOptArg(pc));
+               {
+                       uint64_t rounded_size;
+                       int order;
+
+                       errno = 0;
+                       opt_arg = poptGetOptArg(pc);
+                       chan.attr.num_subbuf = strtoull(opt_arg, NULL, 0);
+                       if (errno != 0 || !chan.attr.num_subbuf || !isdigit(opt_arg[0])) {
+                               ERR("Wrong value in --num-subbuf parameter: %s", opt_arg);
+                               ret = CMD_ERROR;
+                               goto end;
+                       }
+
+                       order = get_count_order_u64(chan.attr.num_subbuf);
+                       assert(order >= 0);
+                       rounded_size = 1ULL << order;
+                       if (rounded_size != chan.attr.num_subbuf) {
+                               WARN("The number of subbuffers (%" PRIu64 ") is rounded to the next power of 2 (%" PRIu64 ")",
+                                               chan.attr.num_subbuf, rounded_size);
+                               chan.attr.num_subbuf = rounded_size;
+                       }
+
+                       /* Should now be power of 2 */
+                       assert(!((chan.attr.num_subbuf - 1) & chan.attr.num_subbuf));
+
                        DBG("Channel subbuf num set to %" PRIu64, chan.attr.num_subbuf);
                        break;
+               }
                case OPT_SWITCH_TIMER:
-                       /* TODO Replace atoi with strtol and check for errors */
-                       chan.attr.switch_timer_interval = atoi(poptGetOptArg(pc));
+               {
+                       unsigned long v;
+
+                       errno = 0;
+                       opt_arg = poptGetOptArg(pc);
+                       v = strtoul(opt_arg, NULL, 0);
+                       if (errno != 0 || !isdigit(opt_arg[0])) {
+                               ERR("Wrong value in --switch-timer parameter: %s", opt_arg);
+                               ret = CMD_ERROR;
+                               goto end;
+                       }
+                       if (v != (uint32_t) v) {
+                               ERR("32-bit overflow in --switch-timer parameter: %s", opt_arg);
+                               ret = CMD_ERROR;
+                               goto end;
+                       }
+                       chan.attr.switch_timer_interval = (uint32_t) v;
                        DBG("Channel switch timer interval set to %d", chan.attr.switch_timer_interval);
                        break;
+               }
                case OPT_READ_TIMER:
-                       /* TODO Replace atoi with strtol and check for errors */
-                       chan.attr.read_timer_interval = atoi(poptGetOptArg(pc));
+               {
+                       unsigned long v;
+
+                       errno = 0;
+                       opt_arg = poptGetOptArg(pc);
+                       v = strtoul(opt_arg, NULL, 0);
+                       if (errno != 0 || !isdigit(opt_arg[0])) {
+                               ERR("Wrong value in --read-timer parameter: %s", opt_arg);
+                               ret = CMD_ERROR;
+                               goto end;
+                       }
+                       if (v != (uint32_t) v) {
+                               ERR("32-bit overflow in --read-timer parameter: %s", opt_arg);
+                               ret = CMD_ERROR;
+                               goto end;
+                       }
+                       chan.attr.read_timer_interval = (uint32_t) v;
                        DBG("Channel read timer interval set to %d", chan.attr.read_timer_interval);
                        break;
+               }
                case OPT_USERSPACE:
                        opt_userspace = 1;
                        break;
                case OPT_TRACEFILE_SIZE:
-                       chan.attr.tracefile_size = atoll(poptGetOptArg(pc));
+                       opt_arg = poptGetOptArg(pc);
+                       if (utils_parse_size_suffix(opt_arg, &chan.attr.tracefile_size) < 0) {
+                               ERR("Wrong value in --tracefile-size parameter: %s", opt_arg);
+                               ret = CMD_ERROR;
+                               goto end;
+                       }
                        DBG("Maximum tracefile size set to %" PRIu64,
                                        chan.attr.tracefile_size);
                        break;
                case OPT_TRACEFILE_COUNT:
-                       chan.attr.tracefile_count = atoll(poptGetOptArg(pc));
+               {
+                       unsigned long v;
+
+                       errno = 0;
+                       opt_arg = poptGetOptArg(pc);
+                       v = strtoul(opt_arg, NULL, 0);
+                       if (errno != 0 || !isdigit(opt_arg[0])) {
+                               ERR("Wrong value in --tracefile-count parameter: %s", opt_arg);
+                               ret = CMD_ERROR;
+                               goto end;
+                       }
+                       if (v != (uint32_t) v) {
+                               ERR("32-bit overflow in --tracefile-count parameter: %s", opt_arg);
+                               ret = CMD_ERROR;
+                               goto end;
+                       }
+                       chan.attr.tracefile_count = (uint32_t) v;
                        DBG("Maximum tracefile count set to %" PRIu64,
                                        chan.attr.tracefile_count);
                        break;
+               }
                case OPT_LIST_OPTIONS:
                        list_cmd_options(stdout, long_options);
                        goto end;
This page took 0.026444 seconds and 4 git commands to generate.