Acked-by: Mathieu Desnoyers <[email protected]> David, can you merge it ?
Thanks, Mathieu * Simon Marchi ([email protected]) wrote: > --subbuf-size accepts sizes such as: > > - 123 -> 123 > - 123k -> 123 * 1024 > - 123M -> 123 * 1024^2 > - 123G -> 123 * 1024^3 > > It uses the new parse_size_suffix function, which could probably be used > at other places, such as tracefile size. > > Unit tests are included. > > Signed-off-by: Simon Marchi <[email protected]> > --- > New in v5: > - parse_size_suffix -> utils_parse_size_suffix > - Use base 0 with strtoull, which means we can also pass sizes in octal > and hexadecimal > - New tests case for octal and hex > - Minor rework in valid test cases structure > - Formatting/coding style > > src/bin/lttng/commands/enable_channels.c | 21 ++++- > src/common/utils.c | 128 > +++++++++++++++++++++++++++++ > src/common/utils.h | 9 ++ > tests/unit/Makefile.am | 15 +++- > tests/unit/test_utils_parse_size_suffix.c | 87 +++++++++++++++++++ > 5 files changed, 254 insertions(+), 6 deletions(-) > create mode 100644 tests/unit/test_utils_parse_size_suffix.c > > diff --git a/src/bin/lttng/commands/enable_channels.c > b/src/bin/lttng/commands/enable_channels.c > index d026af4..093954f 100644 > --- a/src/bin/lttng/commands/enable_channels.c > +++ b/src/bin/lttng/commands/enable_channels.c > @@ -66,7 +66,7 @@ static struct poptOption long_options[] = { > {"userspace", 'u', POPT_ARG_NONE, 0, OPT_USERSPACE, 0, 0}, > {"discard", 0, POPT_ARG_NONE, 0, OPT_DISCARD, 0, 0}, > {"overwrite", 0, POPT_ARG_NONE, 0, OPT_OVERWRITE, 0, 0}, > - {"subbuf-size", 0, POPT_ARG_DOUBLE, 0, OPT_SUBBUF_SIZE, 0, 0}, > + {"subbuf-size", 0, POPT_ARG_STRING, 0, OPT_SUBBUF_SIZE, 0, 0}, > {"num-subbuf", 0, POPT_ARG_INT, 0, OPT_NUM_SUBBUF, 0, 0}, > {"switch-timer", 0, POPT_ARG_INT, 0, OPT_SWITCH_TIMER, 0, 0}, > {"read-timer", 0, POPT_ARG_INT, 0, OPT_READ_TIMER, 0, 0}, > @@ -289,6 +289,7 @@ int cmd_enable_channels(int argc, const char **argv) > int opt, ret = CMD_SUCCESS; > static poptContext pc; > char *session_name = NULL; > + char *opt_arg = NULL; > > init_channel_config(); > > @@ -309,8 +310,22 @@ int cmd_enable_channels(int argc, const char **argv) > DBG("Channel set to overwrite"); > break; > case OPT_SUBBUF_SIZE: > - /* TODO Replace atol with strtol and check for errors */ > - chan.attr.subbuf_size = atol(poptGetOptArg(pc)); > + /* 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); > + 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; > + } > + > DBG("Channel subbuf size set to %" PRIu64, > chan.attr.subbuf_size); > break; > case OPT_NUM_SUBBUF: > diff --git a/src/common/utils.c b/src/common/utils.c > index b16cdc9..a7cec6b 100644 > --- a/src/common/utils.c > +++ b/src/common/utils.c > @@ -26,6 +26,7 @@ > #include <sys/stat.h> > #include <unistd.h> > #include <inttypes.h> > +#include <regex.h> > > #include <common/common.h> > #include <common/runas.h> > @@ -386,3 +387,130 @@ int utils_rotate_stream_file(char *path_name, char > *file_name, uint64_t size, > error: > return ret; > } > + > +/** > + * Prints the error message corresponding to a regex error code. > + * > + * @param errcode The error code. > + * @param regex The regex object that produced the error code. > + */ > +static void regex_print_error(int errcode, regex_t *regex) > +{ > + /* Get length of error message and allocate accordingly */ > + size_t length; > + char *buffer; > + > + assert(regex != NULL); > + > + length = regerror(errcode, regex, NULL, 0); > + if (length == 0) { > + ERR("regerror returned a length of 0"); > + return; > + } > + > + buffer = zmalloc(length); > + if (!buffer) { > + ERR("regex_print_error: zmalloc failed"); > + return; > + } > + > + /* Get and print error message */ > + regerror(errcode, regex, buffer, length); > + ERR("regex error: %s\n", buffer); > + free(buffer); > + > +} > + > +/** > + * Parse a string that represents a size in human readable format. It > + * supports decimal integers suffixed by 'k', 'M' or 'G'. > + * > + * The suffix multiply the integer by: > + * 'k': 1024 > + * 'M': 1024^2 > + * 'G': 1024^3 > + * > + * @param str The string to parse. > + * @param size Pointer to a size_t that will be filled with the > + * resulting size. > + * > + * @return 0 on success, -1 on failure. > + */ > +int utils_parse_size_suffix(char *str, uint64_t *size) > +{ > + regex_t regex; > + int ret; > + const int nmatch = 3; > + regmatch_t suffix_match, matches[nmatch]; > + unsigned long long base_size; > + long shift = 0; > + > + if (!str) { > + return 0; > + } > + > + /* Compile regex */ > + ret = regcomp(®ex, > "^\\(0x\\)\\{0,1\\}[0-9][0-9]*\\([kKMG]\\{0,1\\}\\)$", 0); > + > + /* Check for regex error */ > + if (ret != 0) { > + regex_print_error(ret, ®ex); > + ret = -1; > + goto end; > + } > + > + /* Match regex */ > + ret = regexec(®ex, str, nmatch, matches, 0); > + if (ret != 0) { > + /* There is no match (or error) */ > + ret = -1; > + goto free; > + } > + > + /* There is a match ! */ > + errno = 0; > + base_size = strtoull(str, NULL, 0); > + /* Check result of conversion */ > + if (errno != 0) { > + PERROR("strtoull"); > + ret = -1; > + goto free; > + } > + > + /* Check if there is a suffix */ > + suffix_match = matches[2]; > + if (suffix_match.rm_eo - suffix_match.rm_so == 1) { > + switch (*(str + suffix_match.rm_so)) { > + case 'K': > + case 'k': > + shift = KIBI_LOG2; > + break; > + case 'M': > + shift = MEBI_LOG2; > + break; > + case 'G': > + shift = GIBI_LOG2; > + break; > + default: > + ERR("parse_human_size: invalid suffix"); > + ret = -1; > + goto free; > + } > + } > + > + *size = base_size << shift; > + > + /* Check for overflow */ > + if ((*size >> shift) != base_size) { > + ERR("parse_size_suffix: oops, overflow detected."); > + ret = -1; > + goto free; > + } > + > + ret = 0; > + > +free: > + regfree(®ex); > +end: > + return ret; > +} > diff --git a/src/common/utils.h b/src/common/utils.h > index 2d39cef..d8a5321 100644 > --- a/src/common/utils.h > +++ b/src/common/utils.h > @@ -18,6 +18,14 @@ > #ifndef _COMMON_UTILS_H > #define _COMMON_UTILS_H > > +#include <sys/types.h> > +#include <unistd.h> > +#include <stdint.h> > + > +#define KIBI_LOG2 10 > +#define MEBI_LOG2 20 > +#define GIBI_LOG2 30 > + > char *utils_expand_path(const char *path); > int utils_create_pipe(int *dst); > int utils_create_pipe_cloexec(int *dst); > @@ -30,5 +38,6 @@ int utils_create_stream_file(char *path_name, char > *file_name, uint64_t size, > uint64_t count, int uid, int gid); > int utils_rotate_stream_file(char *path_name, char *file_name, uint64_t size, > uint64_t count, int uid, int gid, int out_fd, uint64_t > *new_count); > +int utils_parse_size_suffix(char *str, uint64_t *size); > > #endif /* _COMMON_UTILS_H */ > diff --git a/tests/unit/Makefile.am b/tests/unit/Makefile.am > index 67e7fe4..e8a6429 100644 > --- a/tests/unit/Makefile.am > +++ b/tests/unit/Makefile.am > @@ -14,10 +14,11 @@ LIBCOMMON=$(top_builddir)/src/common/libcommon.la > LIBSESSIOND_COMM=$(top_builddir)/src/common/sessiond-comm/libsessiond-comm.la > LIBHASHTABLE=$(top_builddir)/src/common/hashtable/libhashtable.la > > +# Define test programs > +noinst_PROGRAMS = test_uri test_session test_kernel_data > test_utils_parse_size_suffix > + > if HAVE_LIBLTTNG_UST_CTL > -noinst_PROGRAMS = test_uri test_session test_ust_data test_kernel_data > -else > -noinst_PROGRAMS = test_uri test_session test_kernel_data > +noinst_PROGRAMS += test_ust_data > endif > > # URI unit tests > @@ -69,3 +70,11 @@ test_kernel_data_SOURCES = test_kernel_data.c > test_kernel_data_LDADD = $(LIBTAP) $(LIBCOMMON) $(LIBSESSIOND_COMM) > $(LIBHASHTABLE) \ > -lrt > test_kernel_data_LDADD += $(KERN_DATA_TRACE) > + > +# parse_size_suffix unit test > +UTILS_PARSE_SIZE_SUFFIX=$(top_srcdir)/src/common/utils.o \ > + $(top_srcdir)/src/common/runas.o > + > +test_utils_parse_size_suffix_SOURCES = test_utils_parse_size_suffix.c > +test_utils_parse_size_suffix_LDADD = $(LIBTAP) $(LIBHASHTABLE) $(LIBCOMMON) > +test_utils_parse_size_suffix_LDADD += $(UTILS_PARSE_SIZE_SUFFIX) > diff --git a/tests/unit/test_utils_parse_size_suffix.c > b/tests/unit/test_utils_parse_size_suffix.c > new file mode 100644 > index 0000000..3b9c68c > --- /dev/null > +++ b/tests/unit/test_utils_parse_size_suffix.c > @@ -0,0 +1,87 @@ > +/* > + * Copyright (C) - 2013 Simon Marchi <[email protected]> > + * > + * This program is free software; you can redistribute it and/or modify it > + * under the terms of the GNU General Public License as published by as > + * published by the Free Software Foundation; only version 2 of the License. > + * > + * This program 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 General Public License for > + * more details. > + * > + * You should have received a copy of the GNU General Public License along > with > + * this program; if not, write to the Free Software Foundation, Inc., 51 > + * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. > + */ > + > +#include <assert.h> > +#include <string.h> > +#include <stdio.h> > + > +#include <tap/tap.h> > + > +#include <src/common/utils.h> > + > +/* For lttngerr.h */ > +int lttng_opt_quiet = 1; > +int lttng_opt_verbose = 3; > + > +struct valid_test_input { > + char *input; > + uint64_t expected_result; > +}; > + > +/* Valid test cases */ > +static struct valid_test_input valid_tests_inputs[] = { > + { "0", 0 }, > + { "1234", 1234 }, > + { "0x400", 1024 }, > + { "0300", 192 }, > + { "16k", 16384 }, > + { "128K", 131072 }, > + { "0x1234k", 4771840 }, > + { "32M", 33554432 }, > + { "1024G", 1099511627776 }, > +}; > +static const int num_valid_tests = sizeof(valid_tests_inputs) / > sizeof(valid_tests_inputs[0]); > + > +/* Invalid test cases */ > +static char *invalid_tests_inputs[] = { "", "-1", "k", > "4611686018427387904G" }; > +static const int num_invalid_tests = sizeof(invalid_tests_inputs) / > sizeof(invalid_tests_inputs[0]); > + > +static void test_utils_parse_size_suffix(void) > +{ > + uint64_t result; > + int ret; > + int i; > + > + /* Test valid cases */ > + for (i = 0; i < num_valid_tests; i++) { > + char name[100]; > + sprintf(name, "valid test case: %s", > valid_tests_inputs[i].input); > + > + ret = utils_parse_size_suffix(valid_tests_inputs[i].input, > &result); > + ok(ret == 0 && result == valid_tests_inputs[i].expected_result, > name); > + } > + > + /* Test invalid cases */ > + for (i = 0; i < num_invalid_tests; i++) { > + char name[100]; > + sprintf(name, "invalid test case: %s", invalid_tests_inputs[i]); > + > + ret = utils_parse_size_suffix(invalid_tests_inputs[i], &result); > + ok(ret != 0, name); > + } > +} > + > +int main(int argc, char **argv) > +{ > + plan_tests(num_valid_tests + num_invalid_tests); > + > + diag("utils_parse_size_suffix tests"); > + > + test_utils_parse_size_suffix(); > + > + return exit_status(); > +} > -- > 1.7.1 > > > _______________________________________________ > lttng-dev mailing list > [email protected] > http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev -- Mathieu Desnoyers EfficiOS Inc. http://www.efficios.com _______________________________________________ lttng-dev mailing list [email protected] http://lists.lttng.org/cgi-bin/mailman/listinfo/lttng-dev
