[dpdk-dev] [PATCH v2 3/6] cfgfile: configurable comment character

Allain Legacy allain.legacy at windriver.com
Thu Mar 9 14:10:57 CET 2017


The current cfgfile comment character is hardcoded to ';'.  This commit a
new API to allow the user to specify which comment character to use while
parsing the file.

This is to ease adoption by applications that have an existing
configuration file which may use a different comment character.  For
instance, an application may already have a configuration file that uses
the '#' as the comment character.

The approach of using a new API with an extensible parameters structure was
used rather than simply adding a new argument to the existing API to allow
for additional arguments to be introduced in the future.

Signed-off-by: Allain Legacy <allain.legacy at windriver.com>
---
 lib/librte_cfgfile/rte_cfgfile.c        | 26 ++++++++++++++++++++++---
 lib/librte_cfgfile/rte_cfgfile.h        | 34 +++++++++++++++++++++++++++++++++
 test/test/test_cfgfile.c                | 29 ++++++++++++++++++++++++++++
 test/test/test_cfgfiles/etc/sample2.ini | 12 ++++++++++++
 4 files changed, 98 insertions(+), 3 deletions(-)
 create mode 100644 test/test/test_cfgfiles/etc/sample2.ini

diff --git a/lib/librte_cfgfile/rte_cfgfile.c b/lib/librte_cfgfile/rte_cfgfile.c
index 832fea8..7ecab22 100644
--- a/lib/librte_cfgfile/rte_cfgfile.c
+++ b/lib/librte_cfgfile/rte_cfgfile.c
@@ -85,9 +85,29 @@ struct rte_cfgfile {
 	return newlen;
 }
 
+void
+rte_cfgfile_init_parameters(struct rte_cfgfile_parameters *params)
+{
+	memset(params, 0, sizeof(*params));
+	params->comment_character = CFG_DEFAULT_COMMENT_CHARACTER;
+}
+
 struct rte_cfgfile *
 rte_cfgfile_load(const char *filename, int flags)
 {
+	struct rte_cfgfile_parameters params;
+
+	/* setup default parameter are add specified flags */
+	rte_cfgfile_init_parameters(&params);
+	params.flags |= flags;
+
+	return rte_cfgfile_load_with_params(filename, &params);
+}
+
+struct rte_cfgfile *
+rte_cfgfile_load_with_params(const char *filename,
+			     const struct rte_cfgfile_parameters *params)
+{
 	int allocated_sections = CFG_ALLOC_SECTION_BATCH;
 	int allocated_entries = 0;
 	int curr_section = -1;
@@ -107,7 +127,7 @@ struct rte_cfgfile *
 
 	memset(cfg->sections, 0, sizeof(cfg->sections[0]) * allocated_sections);
 
-	if (flags & CFG_FLAG_GLOBAL_SECTION) {
+	if (params->flags & CFG_FLAG_GLOBAL_SECTION) {
 		curr_section = 0;
 		allocated_entries = CFG_ALLOC_ENTRY_BATCH;
 		cfg->sections[curr_section] = malloc(
@@ -132,7 +152,7 @@ struct rte_cfgfile *
 					"Check if line too long\n", lineno);
 			goto error1;
 		}
-		pos = memchr(buffer, ';', sizeof(buffer));
+		pos = memchr(buffer, params->comment_character, sizeof(buffer));
 		if (pos != NULL) {
 			*pos = '\0';
 			len = pos -  buffer;
@@ -242,7 +262,7 @@ struct rte_cfgfile *
 		}
 	}
 	fclose(f);
-	cfg->flags = flags;
+	cfg->flags = params->flags;
 	cfg->num_sections = curr_section + 1;
 	/* curr_section will still be -1 if we have an empty file */
 	if (curr_section >= 0)
diff --git a/lib/librte_cfgfile/rte_cfgfile.h b/lib/librte_cfgfile/rte_cfgfile.h
index 0e805c2..069bbd4 100644
--- a/lib/librte_cfgfile/rte_cfgfile.h
+++ b/lib/librte_cfgfile/rte_cfgfile.h
@@ -66,6 +66,12 @@ struct rte_cfgfile_entry {
 	char value[CFG_VALUE_LEN]; /**< Value */
 };
 
+/** Configuration file operation optional arguments */
+struct rte_cfgfile_parameters {
+	int flags; /**< Config file flags */
+	char comment_character; /**< Config file comment character */
+};
+
 /**@{ cfgfile load operation flags */
 /**
  * Indicates that the file supports key value entries before the first defined
@@ -74,6 +80,17 @@ struct rte_cfgfile_entry {
 #define CFG_FLAG_GLOBAL_SECTION (1 << 0)
 /**@} */
 
+/** Defines the default comment character used for parsing config files. */
+#define CFG_DEFAULT_COMMENT_CHARACTER ';'
+
+/**
+ * Initialize config file optional parameters to default values.
+ *
+ * @param params
+ *   parameters to be initialized
+ */
+void rte_cfgfile_init_parameters(struct rte_cfgfile_parameters *params);
+
 /**
 * Open config file
 *
@@ -87,6 +104,23 @@ struct rte_cfgfile_entry {
 struct rte_cfgfile *rte_cfgfile_load(const char *filename, int flags);
 
 /**
+ * Open config file with specified optional parameters.  Use @see
+ * rte_cfgfile_init_parameters to setup the default parameters.
+ *
+ * @param filename
+ *   Config file name
+ * @param params
+ *   Config file flags
+ * @return
+ *   Handle to configuration file on success, NULL otherwise
+ * @param
+ *
+ */
+struct rte_cfgfile *rte_cfgfile_load_with_params(const char *filename,
+	const struct rte_cfgfile_parameters *params);
+
+
+/**
 * Get number of sections in config file
 *
 * @param cfg
diff --git a/test/test/test_cfgfile.c b/test/test/test_cfgfile.c
index dd7afae..eab8ccc 100644
--- a/test/test/test_cfgfile.c
+++ b/test/test/test_cfgfile.c
@@ -130,6 +130,32 @@
 }
 
 static int
+test_cfgfile_sample2(void)
+{
+	struct rte_cfgfile_parameters params;
+	struct rte_cfgfile *cfgfile;
+	int ret;
+
+	/* setup default */
+	rte_cfgfile_init_parameters(&params);
+
+	/* override comment character */
+	params.comment_character = '#';
+
+	cfgfile = rte_cfgfile_load_with_params(CFG_FILES_ETC "/sample2.ini",
+					       &params);
+	TEST_ASSERT_NOT_NULL(cfgfile, "Failed to parse sample2.ini");
+
+	ret = _test_cfgfile_sample(cfgfile);
+	TEST_ASSERT_SUCCESS(ret, "Failed to validate sample file: %d", ret);
+
+	ret = rte_cfgfile_close(cfgfile);
+	TEST_ASSERT_SUCCESS(ret, "Failed to close cfgfile");
+
+	return 0;
+}
+
+static int
 test_cfgfile_invalid_section_header(void)
 {
 	struct rte_cfgfile *cfgfile;
@@ -219,6 +245,9 @@
 	if (test_cfgfile_sample1())
 		return -1;
 
+	if (test_cfgfile_sample2())
+		return -1;
+
 	if (test_cfgfile_invalid_section_header())
 		return -1;
 
diff --git a/test/test/test_cfgfiles/etc/sample2.ini b/test/test/test_cfgfiles/etc/sample2.ini
new file mode 100644
index 0000000..21075e9
--- /dev/null
+++ b/test/test/test_cfgfiles/etc/sample2.ini
@@ -0,0 +1,12 @@
+# this is a global comment
+
+[section1]
+# this is section 1
+key1=value1
+
+[section2]
+# this is section 2
+#key1=value1
+key2=value2
+key3=value3 # this is key3
+ignore-missing-separator
-- 
1.8.3.1



More information about the dev mailing list