cfgfile: constrain string search

[dpdk.git] / lib / librte_cfgfile / rte_cfgfile.c

diff --git a/lib/librte_cfgfile/rte_cfgfile.c b/lib/librte_cfgfile/rte_cfgfile.c
index a677dad..e4a3885 100644 (file)
--- a/lib/librte_cfgfile/rte_cfgfile.c
+++ b/lib/librte_cfgfile/rte_cfgfile.c
@@ -35,6 +35,7 @@
 #include <stdlib.h>
 #include <string.h>
 #include <ctype.h>
+#include <rte_common.h>
 #include <rte_string_fns.h>
 
 #include "rte_cfgfile.h"
@@ -58,6 +59,25 @@ struct rte_cfgfile {
  * for new entries do we add in */
 #define CFG_ALLOC_ENTRY_BATCH 16
 
+/**
+ * Default cfgfile load parameters.
+ */
+static const struct rte_cfgfile_parameters default_cfgfile_params = {
+       .comment_character = CFG_DEFAULT_COMMENT_CHARACTER,
+};
+
+/**
+ * Defines the list of acceptable comment characters supported by this
+ * library.
+ */
+static const char valid_comment_chars[] = {
+       '!',
+       '#',
+       '%',
+       ';',
+       '@'
+};
+
 static unsigned
 _strip(char *str, unsigned len)
 {
@@ -85,8 +105,44 @@ _strip(char *str, unsigned len)
        return newlen;
 }
 
+static int
+rte_cfgfile_check_params(const struct rte_cfgfile_parameters *params)
+{
+       unsigned int valid_comment;
+       unsigned int i;
+
+       if (!params) {
+               printf("Error - missing cfgfile parameters\n");
+               return -EINVAL;
+       }
+
+       valid_comment = 0;
+       for (i = 0; i < RTE_DIM(valid_comment_chars); i++) {
+               if (params->comment_character == valid_comment_chars[i]) {
+                       valid_comment = 1;
+                       break;
+               }
+       }
+
+       if (valid_comment == 0) {
+               printf("Error - invalid comment characters %c\n",
+                      params->comment_character);
+               return -ENOTSUP;
+       }
+
+       return 0;
+}
+
 struct rte_cfgfile *
 rte_cfgfile_load(const char *filename, int flags)
+{
+       return rte_cfgfile_load_with_params(filename, flags,
+                                           &default_cfgfile_params);
+}
+
+struct rte_cfgfile *
+rte_cfgfile_load_with_params(const char *filename, int flags,
+                            const struct rte_cfgfile_parameters *params)
 {
        int allocated_sections = CFG_ALLOC_SECTION_BATCH;
        int allocated_entries = 0;
@@ -96,6 +152,9 @@ rte_cfgfile_load(const char *filename, int flags)
        int lineno = 0;
        struct rte_cfgfile *cfg = NULL;
 
+       if (rte_cfgfile_check_params(params))
+               return NULL;
+
        FILE *f = fopen(filename, "r");
        if (f == NULL)
                return NULL;
@@ -107,6 +166,22 @@ rte_cfgfile_load(const char *filename, int flags)
 
        memset(cfg->sections, 0, sizeof(cfg->sections[0]) * allocated_sections);
 
+       if (flags & CFG_FLAG_GLOBAL_SECTION) {
+               curr_section = 0;
+               allocated_entries = CFG_ALLOC_ENTRY_BATCH;
+               cfg->sections[curr_section] = malloc(
+                       sizeof(*cfg->sections[0]) +
+                       sizeof(cfg->sections[0]->entries[0]) *
+                       allocated_entries);
+               if (cfg->sections[curr_section] == NULL) {
+                       printf("Error - no memory for global section\n");
+                       goto error1;
+               }
+
+               snprintf(cfg->sections[curr_section]->name,
+                                sizeof(cfg->sections[0]->name), "GLOBAL");
+       }
+
        while (fgets(buffer, sizeof(buffer), f) != NULL) {
                char *pos = NULL;
                size_t len = strnlen(buffer, sizeof(buffer));
@@ -116,7 +191,7 @@ rte_cfgfile_load(const char *filename, int flags)
                                        "Check if line too long\n", lineno);
                        goto error1;
                }
-               pos = memchr(buffer, ';', sizeof(buffer));
+               pos = memchr(buffer, params->comment_character, len);
                if (pos != NULL) {
                        *pos = '\0';
                        len = pos -  buffer;
@@ -151,6 +226,7 @@ rte_cfgfile_load(const char *filename, int flags)
                                        sizeof(*cfg) + sizeof(cfg->sections[0])
                                        * allocated_sections);
                                if (n_cfg == NULL) {
+                                       curr_section--;
                                        printf("Error - no more memory\n");
                                        goto error1;
                                }
@@ -198,6 +274,7 @@ rte_cfgfile_load(const char *filename, int flags)
                                        sizeof(sect->entries[0]) *
                                        allocated_entries);
                                if (n_sect == NULL) {
+                                       curr_entry--;
                                        printf("Error - no more memory\n");
                                        goto error1;
                                }
@@ -232,6 +309,9 @@ rte_cfgfile_load(const char *filename, int flags)
        return cfg;
 
 error1:
+       cfg->num_sections = curr_section + 1;
+       if (curr_section >= 0)
+               cfg->sections[curr_section]->num_entries = curr_entry + 1;
        rte_cfgfile_close(cfg);
 error2:
        fclose(f);
@@ -306,7 +386,7 @@ _get_section(struct rte_cfgfile *cfg, const char *sectionname)
 int
 rte_cfgfile_has_section(struct rte_cfgfile *cfg, const char *sectionname)
 {
-       return (_get_section(cfg, sectionname) != NULL);
+       return _get_section(cfg, sectionname) != NULL;
 }
 
 int
@@ -333,6 +413,24 @@ rte_cfgfile_section_entries(struct rte_cfgfile *cfg, const char *sectionname,
        return i;
 }
 
+int
+rte_cfgfile_section_entries_by_index(struct rte_cfgfile *cfg, int index,
+               char *sectionname,
+               struct rte_cfgfile_entry *entries, int max_entries)
+{
+       int i;
+       const struct rte_cfgfile_section *sect;
+
+       if (index < 0 || index >= cfg->num_sections)
+               return -1;
+
+       sect = cfg->sections[index];
+       snprintf(sectionname, CFG_NAME_LEN, "%s", sect->name);
+       for (i = 0; i < max_entries && i < sect->num_entries; i++)
+               entries[i] = *sect->entries[i];
+       return i;
+}
+
 const char *
 rte_cfgfile_get_entry(struct rte_cfgfile *cfg, const char *sectionname,
                const char *entryname)
@@ -352,5 +450,5 @@ int
 rte_cfgfile_has_entry(struct rte_cfgfile *cfg, const char *sectionname,
                const char *entryname)
 {
-       return (rte_cfgfile_get_entry(cfg, sectionname, entryname) != NULL);
+       return rte_cfgfile_get_entry(cfg, sectionname, entryname) != NULL;
 }