Tests: add session auto-loading test cases
[lttng-tools.git] / src / common / config / session-config.c
index 4d12870e8d9bdd469cca73cf5cea127ec9f317f6..518fde70b5e63d1d244369ca634d0a647bb75f21 100644 (file)
@@ -32,6 +32,7 @@
 #include <common/error.h>
 #include <common/macros.h>
 #include <common/utils.h>
+#include <common/dynamic-buffer.h>
 #include <common/compat/getenv.h>
 #include <lttng/lttng-error.h>
 #include <libxml/parser.h>
@@ -677,13 +678,12 @@ char *get_session_config_xsd_path()
                goto end;
        }
 
-       strncpy(xsd_path, base_path, max_path_len);
+       strcpy(xsd_path, base_path);
        if (xsd_path[base_path_len - 1] != '/') {
                xsd_path[base_path_len++] = '/';
        }
 
-       strncpy(xsd_path + base_path_len, DEFAULT_SESSION_CONFIG_XSD_FILENAME,
-               max_path_len - base_path_len);
+       strcpy(xsd_path + base_path_len, DEFAULT_SESSION_CONFIG_XSD_FILENAME);
 end:
        return xsd_path;
 }
@@ -1496,7 +1496,6 @@ int process_probe_attribute_node(xmlNodePtr probe_attribute_node,
        } else if (!strcmp((const char *) probe_attribute_node->name,
                config_element_symbol_name)) {
                xmlChar *content;
-               size_t name_len;
 
                /* symbol_name */
                content = xmlNodeGetContent(probe_attribute_node);
@@ -1505,15 +1504,18 @@ int process_probe_attribute_node(xmlNodePtr probe_attribute_node,
                        goto end;
                }
 
-               name_len = strlen((char *) content);
-               if (name_len >= LTTNG_SYMBOL_NAME_LEN) {
-                       WARN("symbol_name too long.");
+               ret = lttng_strncpy(attr->symbol_name,
+                               (const char *) content,
+                               LTTNG_SYMBOL_NAME_LEN);
+               if (ret == -1) {
+                       ERR("symbol name \"%s\"'s length (%zu) exceeds the maximal permitted length (%d) in session configuration",
+                                       (const char *) content,
+                                       strlen((const char *) content),
+                                       LTTNG_SYMBOL_NAME_LEN);
                        ret = -LTTNG_ERR_LOAD_INVALID_CONFIG;
                        free(content);
                        goto end;
                }
-
-               strncpy(attr->symbol_name, (const char *) content, name_len);
                free(content);
        }
        ret = 0;
@@ -1562,7 +1564,6 @@ int process_event_node(xmlNodePtr event_node, struct lttng_handle *handle,
                node = xmlNextElementSibling(node)) {
                if (!strcmp((const char *) node->name, config_element_name)) {
                        xmlChar *content;
-                       size_t name_len;
 
                        /* name */
                        content = xmlNodeGetContent(node);
@@ -1571,15 +1572,18 @@ int process_event_node(xmlNodePtr event_node, struct lttng_handle *handle,
                                goto end;
                        }
 
-                       name_len = strlen((char *) content);
-                       if (name_len >= LTTNG_SYMBOL_NAME_LEN) {
-                               WARN("Channel name too long.");
+                       ret = lttng_strncpy(event.name,
+                                       (const char *) content,
+                                       LTTNG_SYMBOL_NAME_LEN);
+                       if (ret == -1) {
+                               WARN("Event \"%s\"'s name length (%zu) exceeds the maximal permitted length (%d) in session configuration",
+                                               (const char *) content,
+                                               strlen((const char *) content),
+                                               LTTNG_SYMBOL_NAME_LEN);
                                ret = -LTTNG_ERR_LOAD_INVALID_CONFIG;
                                free(content);
                                goto end;
                        }
-
-                       strncpy(event.name, (const char *) content, name_len);
                        free(content);
                } else if (!strcmp((const char *) node->name,
                        config_element_enabled)) {
@@ -1770,8 +1774,14 @@ int process_event_node(xmlNodePtr event_node, struct lttng_handle *handle,
                                        goto end;
                                }
 
-                               strncpy(event.attr.ftrace.symbol_name, (char *) content,
-                                               sym_len);
+                               ret = lttng_strncpy(
+                                               event.attr.ftrace.symbol_name,
+                                               (char *) content, sym_len);
+                               if (ret == -1) {
+                                       ret = -LTTNG_ERR_LOAD_INVALID_CONFIG;
+                                       free(content);
+                                       goto end;
+                               }
                                free(content);
                        }
                }
@@ -1786,6 +1796,7 @@ int process_event_node(xmlNodePtr event_node, struct lttng_handle *handle,
                        goto end;
                }
        }
+       ret = 0;
 end:
        for (i = 0; i < exclusion_count; i++) {
                free(exclusions[i]);
@@ -1855,7 +1866,6 @@ int process_channel_attr_node(xmlNodePtr attr_node,
 
        if (!strcmp((const char *) attr_node->name, config_element_name)) {
                xmlChar *content;
-               size_t name_len;
 
                /* name */
                content = xmlNodeGetContent(attr_node);
@@ -1864,15 +1874,18 @@ int process_channel_attr_node(xmlNodePtr attr_node,
                        goto end;
                }
 
-               name_len = strlen((char *) content);
-               if (name_len >= LTTNG_SYMBOL_NAME_LEN) {
-                       WARN("Channel name too long.");
+               ret = lttng_strncpy(channel->name,
+                               (const char *) content,
+                               LTTNG_SYMBOL_NAME_LEN);
+               if (ret == -1) {
+                       WARN("Channel \"%s\"'s name length (%zu) exceeds the maximal permitted length (%d) in session configuration",
+                                       (const char *) content,
+                                       strlen((const char *) content),
+                                       LTTNG_SYMBOL_NAME_LEN);
                        ret = -LTTNG_ERR_LOAD_INVALID_CONFIG;
                        free(content);
                        goto end;
                }
-
-               strncpy(channel->name, (const char *) content, name_len);
                free(content);
        } else if (!strcmp((const char *) attr_node->name,
                        config_element_enabled)) {
@@ -2240,7 +2253,6 @@ int process_context_node(xmlNodePtr context_node,
                        } else if (!strcmp((const char *) perf_attr_node->name,
                                config_element_name)) {
                                xmlChar *content;
-                               size_t name_len;
 
                                /* name */
                                content = xmlNodeGetContent(perf_attr_node);
@@ -2249,16 +2261,18 @@ int process_context_node(xmlNodePtr context_node,
                                        goto end;
                                }
 
-                               name_len = strlen((char *) content);
-                               if (name_len >= LTTNG_SYMBOL_NAME_LEN) {
-                                       WARN("perf context name too long.");
+                               ret = lttng_strncpy(context.u.perf_counter.name,
+                                               (const char *) content,
+                                               LTTNG_SYMBOL_NAME_LEN);
+                               if (ret == -1) {
+                                       WARN("Perf counter \"%s\"'s name length (%zu) exceeds the maximal permitted length (%d) in session configuration",
+                                                       (const char *) content,
+                                                       strlen((const char *) content),
+                                                       LTTNG_SYMBOL_NAME_LEN);
                                        ret = -LTTNG_ERR_LOAD_INVALID_CONFIG;
                                        free(content);
                                        goto end;
                                }
-
-                               strncpy(context.u.perf_counter.name, (const char *) content,
-                                               name_len);
                                free(content);
                        }
                }
@@ -2939,23 +2953,6 @@ end:
        return ret;
 }
 
-/* Allocate dirent as recommended by READDIR(3), NOTES on readdir_r */
-static
-struct dirent *alloc_dirent(const char *path)
-{
-       size_t len;
-       long name_max;
-       struct dirent *entry;
-
-       name_max = pathconf(path, _PC_NAME_MAX);
-       if (name_max == -1) {
-               name_max = PATH_MAX;
-       }
-       len = offsetof(struct dirent, d_name) + name_max + 1;
-       entry = zmalloc(len);
-       return entry;
-}
-
 static
 int load_session_from_path(const char *path, const char *session_name,
        struct session_config_validation_ctx *validation_ctx, int overwrite,
@@ -2963,9 +2960,19 @@ int load_session_from_path(const char *path, const char *session_name,
 {
        int ret, session_found = !session_name;
        DIR *directory = NULL;
+       struct lttng_dynamic_buffer file_path;
+       size_t path_len;
 
        assert(path);
        assert(validation_ctx);
+       path_len = strlen(path);
+       lttng_dynamic_buffer_init(&file_path);
+       if (path_len >= LTTNG_PATH_MAX) {
+               ERR("Session configuration load path \"%s\" length (%zu) exceeds the maximal length allowed (%d)",
+                               path, path_len, LTTNG_PATH_MAX);
+               ret = -LTTNG_ERR_INVALID;
+               goto end;
+       }
 
        directory = opendir(path);
        if (!directory) {
@@ -2982,67 +2989,107 @@ int load_session_from_path(const char *path, const char *session_name,
                }
        }
        if (directory) {
-               struct dirent *entry;
-               struct dirent *result;
-               char *file_path = NULL;
-               size_t path_len = strlen(path);
-
-               if (path_len >= PATH_MAX) {
-                       ret = -LTTNG_ERR_INVALID;
-                       goto end;
-               }
+               size_t file_path_root_len;
 
-               entry = alloc_dirent(path);
-               if (!entry) {
+               ret = lttng_dynamic_buffer_set_capacity(&file_path,
+                               LTTNG_PATH_MAX);
+               if (ret) {
                        ret = -LTTNG_ERR_NOMEM;
                        goto end;
                }
 
-               file_path = zmalloc(PATH_MAX);
-               if (!file_path) {
+               ret = lttng_dynamic_buffer_append(&file_path, path, path_len);
+               if (ret) {
                        ret = -LTTNG_ERR_NOMEM;
-                       free(entry);
                        goto end;
                }
 
-               strncpy(file_path, path, path_len);
-               if (file_path[path_len - 1] != '/') {
-                       file_path[path_len++] = '/';
+               if (file_path.data[file_path.size - 1] != '/') {
+                       ret = lttng_dynamic_buffer_append(&file_path, "/", 1);
+                       if (ret) {
+                               ret = -LTTNG_ERR_NOMEM;
+                               goto end;
+                       }
                }
+               file_path_root_len = file_path.size;
 
-               ret = 0;
                /* Search for *.lttng files */
-               while (!readdir_r(directory, entry, &result) && result) {
-                       size_t file_name_len = strlen(result->d_name);
+               for (;;) {
+                       size_t file_name_len;
+                       struct dirent *result;
+
+                       /*
+                        * When the end of the directory stream is reached, NULL
+                        * is returned and errno is kept unchanged. When an
+                        * error occurs, NULL is returned and errno is set
+                        * accordingly. To distinguish between the two, set
+                        * errno to zero before calling readdir().
+                        *
+                        * On success, readdir() returns a pointer to a dirent
+                        * structure. This structure may be statically
+                        * allocated, do not attempt to free(3) it.
+                        */
+                       errno = 0;
+                       result = readdir(directory);
+
+                       /* Reached end of dir stream or error out. */
+                       if (!result) {
+                               if (errno) {
+                                       PERROR("Failed to enumerate the contents of path \"%s\" while loading session, readdir returned", path);
+                                       ret = -LTTNG_ERR_LOAD_IO_FAIL;
+                                       goto end;
+                               }
+                               break;
+                       }
+
+                       file_name_len = strlen(result->d_name);
 
                        if (file_name_len <=
                                sizeof(DEFAULT_SESSION_CONFIG_FILE_EXTENSION)) {
                                continue;
                        }
 
-                       if (path_len + file_name_len >= PATH_MAX) {
+                       if (file_path.size + file_name_len >= LTTNG_PATH_MAX) {
+                               WARN("Ignoring file \"%s\" since the path's length (%zu) would exceed the maximal permitted size (%d)",
+                                               result->d_name,
+                                               /* +1 to account for NULL terminator. */
+                                               file_path.size + file_name_len + 1,
+                                               LTTNG_PATH_MAX);
                                continue;
                        }
 
+                       /* Does the file end with .lttng? */
                        if (strcmp(DEFAULT_SESSION_CONFIG_FILE_EXTENSION,
-                               result->d_name + file_name_len - sizeof(
-                               DEFAULT_SESSION_CONFIG_FILE_EXTENSION) + 1)) {
+                                       result->d_name + file_name_len - sizeof(
+                                       DEFAULT_SESSION_CONFIG_FILE_EXTENSION) + 1)) {
                                continue;
                        }
 
-                       strncpy(file_path + path_len, result->d_name, file_name_len);
-                       file_path[path_len + file_name_len] = '\0';
+                       ret = lttng_dynamic_buffer_append(&file_path, result->d_name,
+                                       file_name_len + 1);
+                       if (ret) {
+                               ret = -LTTNG_ERR_NOMEM;
+                               goto end;
+                       }
 
-                       ret = load_session_from_file(file_path, session_name,
+                       ret = load_session_from_file(file_path.data, session_name,
                                validation_ctx, overwrite, overrides);
                        if (session_name && !ret) {
                                session_found = 1;
                                break;
                        }
+                       /*
+                        * Reset the buffer's size to the location of the
+                        * path's trailing '/'.
+                        */
+                       ret = lttng_dynamic_buffer_set_size(&file_path,
+                                       file_path_root_len);
+                       if (ret) {
+                               ret = -LTTNG_ERR_UNK;
+                               goto end;
+                       }
                }
 
-               free(entry);
-               free(file_path);
        } else {
                ret = load_session_from_file(path, session_name,
                        validation_ctx, overwrite, overrides);
@@ -3059,11 +3106,10 @@ end:
                        PERROR("closedir");
                }
        }
-
        if (session_found && !ret) {
                ret = 0;
        }
-
+       lttng_dynamic_buffer_reset(&file_path);
        return ret;
 }
 
This page took 0.027572 seconds and 4 git commands to generate.