4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 #include <rte_common.h>
41 #include "rte_cfgfile.h"
43 struct rte_cfgfile_section {
44 char name[CFG_NAME_LEN];
46 int allocated_entries;
47 struct rte_cfgfile_entry *entries;
53 int allocated_sections;
54 struct rte_cfgfile_section *sections;
57 /** when we resize a file structure, how many extra entries
58 * for new sections do we add in */
59 #define CFG_ALLOC_SECTION_BATCH 8
60 /** when we resize a section structure, how many extra entries
61 * for new entries do we add in */
62 #define CFG_ALLOC_ENTRY_BATCH 16
65 * Default cfgfile load parameters.
67 static const struct rte_cfgfile_parameters default_cfgfile_params = {
68 .comment_character = CFG_DEFAULT_COMMENT_CHARACTER,
72 * Defines the list of acceptable comment characters supported by this
75 static const char valid_comment_chars[] = {
84 _strip(char *str, unsigned len)
90 if (isspace(str[len-1])) {
91 /* strip trailing whitespace */
92 while (newlen > 0 && isspace(str[newlen - 1]))
96 if (isspace(str[0])) {
97 /* strip leading whitespace */
99 while (isspace(str[start]) && start < newlen)
103 for (i = 0; i < newlen; i++)
104 str[i] = str[i+start];
110 static struct rte_cfgfile_section *
111 _get_section(struct rte_cfgfile *cfg, const char *sectionname)
115 for (i = 0; i < cfg->num_sections; i++) {
116 if (strncmp(cfg->sections[i].name, sectionname,
117 sizeof(cfg->sections[0].name)) == 0)
118 return &cfg->sections[i];
124 _add_entry(struct rte_cfgfile_section *section, const char *entryname,
125 const char *entryvalue)
127 /* resize entry structure if we don't have room for more entries */
128 if (section->num_entries == section->allocated_entries) {
129 struct rte_cfgfile_entry *n_entries = realloc(
131 sizeof(struct rte_cfgfile_entry) *
132 ((section->allocated_entries) +
133 CFG_ALLOC_ENTRY_BATCH));
135 if (n_entries == NULL)
138 section->entries = n_entries;
139 section->allocated_entries += CFG_ALLOC_ENTRY_BATCH;
141 /* fill up entry fields with key name and value */
142 struct rte_cfgfile_entry *curr_entry =
143 §ion->entries[section->num_entries];
145 snprintf(curr_entry->name, sizeof(curr_entry->name), "%s", entryname);
146 snprintf(curr_entry->value,
147 sizeof(curr_entry->value), "%s", entryvalue);
148 section->num_entries++;
154 rte_cfgfile_check_params(const struct rte_cfgfile_parameters *params)
156 unsigned int valid_comment;
160 printf("Error - missing cfgfile parameters\n");
165 for (i = 0; i < RTE_DIM(valid_comment_chars); i++) {
166 if (params->comment_character == valid_comment_chars[i]) {
172 if (valid_comment == 0) {
173 printf("Error - invalid comment characters %c\n",
174 params->comment_character);
182 rte_cfgfile_load(const char *filename, int flags)
184 return rte_cfgfile_load_with_params(filename, flags,
185 &default_cfgfile_params);
189 rte_cfgfile_load_with_params(const char *filename, int flags,
190 const struct rte_cfgfile_parameters *params)
192 char buffer[CFG_NAME_LEN + CFG_VALUE_LEN + 4] = {0};
194 struct rte_cfgfile *cfg = NULL;
196 if (rte_cfgfile_check_params(params))
199 FILE *f = fopen(filename, "r");
203 cfg = rte_cfgfile_create(flags);
205 while (fgets(buffer, sizeof(buffer), f) != NULL) {
207 size_t len = strnlen(buffer, sizeof(buffer));
209 if ((len >= sizeof(buffer) - 1) && (buffer[len-1] != '\n')) {
210 printf("Error line %d - no \\n found on string. "
211 "Check if line too long\n", lineno);
214 /* skip parsing if comment character found */
215 pos = memchr(buffer, params->comment_character, len);
216 if (pos != NULL && (*(pos-1) != '\\')) {
221 len = _strip(buffer, len);
222 /* skip lines without useful content */
223 if (buffer[0] != '[' && memchr(buffer, '=', len) == NULL)
226 if (buffer[0] == '[') {
227 /* section heading line */
228 char *end = memchr(buffer, ']', len);
230 printf("Error line %d - no terminating ']'"
231 "character found\n", lineno);
235 _strip(&buffer[1], end - &buffer[1]);
237 rte_cfgfile_add_section(cfg, &buffer[1]);
239 /* key and value line */
240 char *split[2] = {NULL};
243 split[1] = memchr(buffer, '=', len);
247 _strip(split[0], strlen(split[0]));
248 _strip(split[1], strlen(split[1]));
249 char *end = memchr(split[1], '\\', strlen(split[1]));
251 while (end != NULL) {
252 if (*(end+1) == params->comment_character) {
254 strcat(split[1], end+1);
257 end = memchr(end, '\\', strlen(end));
260 if (!(flags & CFG_FLAG_EMPTY_VALUES) &&
261 (*split[1] == '\0')) {
262 printf("Error at line %d - cannot use empty "
267 if (cfg->num_sections == 0)
270 _add_entry(&cfg->sections[cfg->num_sections - 1],
271 split[0], (split[1] ? split[1] : ""));
277 rte_cfgfile_close(cfg);
283 rte_cfgfile_create(int flags)
286 struct rte_cfgfile *cfg = NULL;
288 cfg = malloc(sizeof(*cfg));
294 cfg->num_sections = 0;
296 /* allocate first batch of sections and entries */
297 cfg->sections = malloc(sizeof(struct rte_cfgfile_section) *
298 CFG_ALLOC_SECTION_BATCH);
300 if (cfg->sections == NULL)
303 cfg->allocated_sections = CFG_ALLOC_SECTION_BATCH;
305 for (i = 0; i < CFG_ALLOC_SECTION_BATCH; i++) {
306 cfg->sections[i].entries = malloc(sizeof(
307 struct rte_cfgfile_entry) * CFG_ALLOC_ENTRY_BATCH);
309 if (cfg->sections[i].entries == NULL)
312 cfg->sections[i].num_entries = 0;
313 cfg->sections[i].allocated_entries = CFG_ALLOC_ENTRY_BATCH;
316 if (flags & CFG_FLAG_GLOBAL_SECTION)
317 rte_cfgfile_add_section(cfg, "GLOBAL");
322 rte_cfgfile_add_section(struct rte_cfgfile *cfg, const char *sectionname)
329 if (sectionname == NULL)
332 /* resize overall struct if we don't have room for more sections */
333 if (cfg->num_sections == cfg->allocated_sections) {
335 struct rte_cfgfile_section *n_sections =
336 realloc(cfg->sections,
337 sizeof(struct rte_cfgfile_section) *
338 ((cfg->allocated_sections) +
339 CFG_ALLOC_SECTION_BATCH));
341 if (n_sections == NULL)
344 for (i = 0; i < CFG_ALLOC_SECTION_BATCH; i++) {
345 n_sections[i + cfg->allocated_sections].num_entries = 0;
347 cfg->allocated_sections].allocated_entries = 0;
348 n_sections[i + cfg->allocated_sections].entries = NULL;
350 cfg->sections = n_sections;
351 cfg->allocated_sections += CFG_ALLOC_SECTION_BATCH;
354 snprintf(cfg->sections[cfg->num_sections].name,
355 sizeof(cfg->sections[0].name), "%s", sectionname);
356 cfg->sections[cfg->num_sections].num_entries = 0;
362 int rte_cfgfile_add_entry(struct rte_cfgfile *cfg,
363 const char *sectionname, const char *entryname,
364 const char *entryvalue)
368 if ((cfg == NULL) || (sectionname == NULL) || (entryname == NULL)
369 || (entryvalue == NULL))
372 if (rte_cfgfile_has_entry(cfg, sectionname, entryname) != 0)
375 /* search for section pointer by sectionname */
376 struct rte_cfgfile_section *curr_section = _get_section(cfg,
378 if (curr_section == NULL)
381 ret = _add_entry(curr_section, entryname, entryvalue);
386 int rte_cfgfile_set_entry(struct rte_cfgfile *cfg, const char *sectionname,
387 const char *entryname, const char *entryvalue)
391 if ((cfg == NULL) || (sectionname == NULL) || (entryname == NULL))
394 /* search for section pointer by sectionname */
395 struct rte_cfgfile_section *curr_section = _get_section(cfg,
397 if (curr_section == NULL)
400 if (entryvalue == NULL)
403 for (i = 0; i < curr_section->num_entries; i++)
404 if (!strcmp(curr_section->entries[i].name, entryname)) {
405 snprintf(curr_section->entries[i].value,
406 sizeof(curr_section->entries[i].value),
410 printf("Error - entry name doesn't exist\n");
414 int rte_cfgfile_save(struct rte_cfgfile *cfg, const char *filename)
418 if ((cfg == NULL) || (filename == NULL))
421 FILE *f = fopen(filename, "w");
426 for (i = 0; i < cfg->num_sections; i++) {
427 fprintf(f, "[%s]\n", cfg->sections[i].name);
429 for (j = 0; j < cfg->sections[i].num_entries; j++) {
430 fprintf(f, "%s=%s\n",
431 cfg->sections[i].entries[j].name,
432 cfg->sections[i].entries[j].value);
438 int rte_cfgfile_close(struct rte_cfgfile *cfg)
445 if (cfg->sections != NULL) {
446 for (i = 0; i < cfg->allocated_sections; i++) {
447 if (cfg->sections[i].entries != NULL) {
448 free(cfg->sections[i].entries);
449 cfg->sections[i].entries = NULL;
453 cfg->sections = NULL;
462 rte_cfgfile_num_sections(struct rte_cfgfile *cfg, const char *sectionname,
466 int num_sections = 0;
467 for (i = 0; i < cfg->num_sections; i++) {
468 if (strncmp(cfg->sections[i].name, sectionname, length) == 0)
475 rte_cfgfile_sections(struct rte_cfgfile *cfg, char *sections[],
480 for (i = 0; i < cfg->num_sections && i < max_sections; i++)
481 snprintf(sections[i], CFG_NAME_LEN, "%s",
482 cfg->sections[i].name);
488 rte_cfgfile_has_section(struct rte_cfgfile *cfg, const char *sectionname)
490 return _get_section(cfg, sectionname) != NULL;
494 rte_cfgfile_section_num_entries(struct rte_cfgfile *cfg,
495 const char *sectionname)
497 const struct rte_cfgfile_section *s = _get_section(cfg, sectionname);
500 return s->num_entries;
504 rte_cfgfile_section_num_entries_by_index(struct rte_cfgfile *cfg,
505 char *sectionname, int index)
507 if (index < 0 || index >= cfg->num_sections)
510 const struct rte_cfgfile_section *sect = &(cfg->sections[index]);
512 snprintf(sectionname, CFG_NAME_LEN, "%s", sect->name);
513 return sect->num_entries;
516 rte_cfgfile_section_entries(struct rte_cfgfile *cfg, const char *sectionname,
517 struct rte_cfgfile_entry *entries, int max_entries)
520 const struct rte_cfgfile_section *sect = _get_section(cfg, sectionname);
523 for (i = 0; i < max_entries && i < sect->num_entries; i++)
524 entries[i] = sect->entries[i];
529 rte_cfgfile_section_entries_by_index(struct rte_cfgfile *cfg, int index,
531 struct rte_cfgfile_entry *entries, int max_entries)
534 const struct rte_cfgfile_section *sect;
536 if (index < 0 || index >= cfg->num_sections)
538 sect = &cfg->sections[index];
539 snprintf(sectionname, CFG_NAME_LEN, "%s", sect->name);
540 for (i = 0; i < max_entries && i < sect->num_entries; i++)
541 entries[i] = sect->entries[i];
546 rte_cfgfile_get_entry(struct rte_cfgfile *cfg, const char *sectionname,
547 const char *entryname)
550 const struct rte_cfgfile_section *sect = _get_section(cfg, sectionname);
553 for (i = 0; i < sect->num_entries; i++)
554 if (strncmp(sect->entries[i].name, entryname, CFG_NAME_LEN)
556 return sect->entries[i].value;
561 rte_cfgfile_has_entry(struct rte_cfgfile *cfg, const char *sectionname,
562 const char *entryname)
564 return rte_cfgfile_get_entry(cfg, sectionname, entryname) != NULL;