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 int allocated_sections = CFG_ALLOC_SECTION_BATCH;
193 int allocated_entries = 0;
194 int curr_section = -1;
196 char buffer[CFG_NAME_LEN + CFG_VALUE_LEN + 4] = {0};
198 struct rte_cfgfile *cfg = NULL;
200 if (rte_cfgfile_check_params(params))
203 FILE *f = fopen(filename, "r");
207 cfg = malloc(sizeof(*cfg) + sizeof(cfg->sections[0]) *
212 memset(cfg->sections, 0, sizeof(cfg->sections[0]) * allocated_sections);
214 if (flags & CFG_FLAG_GLOBAL_SECTION) {
216 allocated_entries = CFG_ALLOC_ENTRY_BATCH;
217 cfg->sections = malloc(
218 sizeof(cfg->sections[0]) +
219 sizeof(cfg->sections[0].entries) *
221 if (cfg->sections == NULL) {
222 printf("Error - no memory for global section\n");
226 snprintf(cfg->sections[curr_section].name,
227 sizeof(cfg->sections[0].name), "GLOBAL");
230 while (fgets(buffer, sizeof(buffer), f) != NULL) {
232 size_t len = strnlen(buffer, sizeof(buffer));
234 if ((len >= sizeof(buffer) - 1) && (buffer[len-1] != '\n')) {
235 printf("Error line %d - no \\n found on string. "
236 "Check if line too long\n", lineno);
239 pos = memchr(buffer, params->comment_character, len);
245 len = _strip(buffer, len);
246 if (buffer[0] != '[' && memchr(buffer, '=', len) == NULL)
249 if (buffer[0] == '[') {
250 /* section heading line */
251 char *end = memchr(buffer, ']', len);
253 printf("Error line %d - no terminating '['"
254 "character found\n", lineno);
258 _strip(&buffer[1], end - &buffer[1]);
260 /* close off old section and add start new one */
261 if (curr_section >= 0)
262 cfg->sections[curr_section].num_entries =
266 /* resize overall struct if we don't have room for more
268 if (curr_section == allocated_sections) {
269 allocated_sections += CFG_ALLOC_SECTION_BATCH;
270 struct rte_cfgfile *n_cfg = realloc(cfg,
271 sizeof(*cfg) + sizeof(cfg->sections[0])
272 * allocated_sections);
275 printf("Error - no more memory\n");
281 /* allocate space for new section */
282 allocated_entries = CFG_ALLOC_ENTRY_BATCH;
284 cfg->sections = malloc(
285 sizeof(cfg->sections[0]) +
286 sizeof(cfg->sections[0].entries) *
288 if (cfg->sections == NULL) {
289 printf("Error - no more memory\n");
293 snprintf(cfg->sections[curr_section].name,
294 sizeof(cfg->sections[0].name),
298 if (curr_section < 0) {
299 printf("Error line %d - value outside of"
300 "section\n", lineno);
304 struct rte_cfgfile_section *sect = cfg->sections;
306 char *split[2] = {NULL};
308 split[1] = memchr(buffer, '=', len);
310 /* when delimeter not found */
311 if (split[1] == NULL) {
312 printf("Error at line %d - cannot "
313 "split string\n", lineno);
316 /* when delimeter found */
320 if (!(flags & CFG_FLAG_EMPTY_VALUES) &&
321 (*split[1] == '\0')) {
322 printf("Error at line %d - cannot "
323 "split string\n", lineno);
329 if (curr_entry == allocated_entries) {
330 allocated_entries += CFG_ALLOC_ENTRY_BATCH;
331 struct rte_cfgfile_section *n_sect = realloc(
332 sect, sizeof(*sect) +
333 sizeof(sect->entries[0]) *
335 if (n_sect == NULL) {
337 printf("Error - no more memory\n");
340 sect = cfg->sections = n_sect;
343 sect->entries = malloc(
344 sizeof(sect->entries[0]));
345 if (sect->entries == NULL) {
346 printf("Error - no more memory\n");
350 struct rte_cfgfile_entry *entry = sect->entries;
351 snprintf(entry->name, sizeof(entry->name), "%s",
353 snprintf(entry->value, sizeof(entry->value), "%s",
354 split[1] ? split[1] : "");
355 _strip(entry->name, strnlen(entry->name,
356 sizeof(entry->name)));
357 _strip(entry->value, strnlen(entry->value,
358 sizeof(entry->value)));
363 cfg->num_sections = curr_section + 1;
364 /* curr_section will still be -1 if we have an empty file */
365 if (curr_section >= 0)
366 cfg->sections[curr_section].num_entries = curr_entry + 1;
370 cfg->num_sections = curr_section + 1;
371 if (curr_section >= 0)
372 cfg->sections[curr_section].num_entries = curr_entry + 1;
373 rte_cfgfile_close(cfg);
380 rte_cfgfile_create(int flags)
383 struct rte_cfgfile *cfg = NULL;
385 cfg = malloc(sizeof(*cfg));
391 cfg->num_sections = 0;
393 /* allocate first batch of sections and entries */
394 cfg->sections = malloc(sizeof(struct rte_cfgfile_section) *
395 CFG_ALLOC_SECTION_BATCH);
397 if (cfg->sections == NULL)
400 cfg->allocated_sections = CFG_ALLOC_SECTION_BATCH;
402 for (i = 0; i < CFG_ALLOC_SECTION_BATCH; i++) {
403 cfg->sections[i].entries = malloc(sizeof(
404 struct rte_cfgfile_entry) * CFG_ALLOC_ENTRY_BATCH);
406 if (cfg->sections[i].entries == NULL)
409 cfg->sections[i].num_entries = 0;
410 cfg->sections[i].allocated_entries = CFG_ALLOC_ENTRY_BATCH;
413 if (flags & CFG_FLAG_GLOBAL_SECTION)
414 rte_cfgfile_add_section(cfg, "GLOBAL");
419 rte_cfgfile_add_section(struct rte_cfgfile *cfg, const char *sectionname)
426 if (sectionname == NULL)
429 /* resize overall struct if we don't have room for more sections */
430 if (cfg->num_sections == cfg->allocated_sections) {
432 struct rte_cfgfile_section *n_sections =
433 realloc(cfg->sections,
434 sizeof(struct rte_cfgfile_section) *
435 ((cfg->allocated_sections) +
436 CFG_ALLOC_SECTION_BATCH));
438 if (n_sections == NULL)
441 for (i = 0; i < CFG_ALLOC_SECTION_BATCH; i++) {
442 n_sections[i + cfg->allocated_sections].num_entries = 0;
444 cfg->allocated_sections].allocated_entries = 0;
445 n_sections[i + cfg->allocated_sections].entries = NULL;
447 cfg->sections = n_sections;
448 cfg->allocated_sections += CFG_ALLOC_SECTION_BATCH;
451 snprintf(cfg->sections[cfg->num_sections].name,
452 sizeof(cfg->sections[0].name), "%s", sectionname);
453 cfg->sections[cfg->num_sections].num_entries = 0;
459 int rte_cfgfile_add_entry(struct rte_cfgfile *cfg,
460 const char *sectionname, const char *entryname,
461 const char *entryvalue)
465 if ((cfg == NULL) || (sectionname == NULL) || (entryname == NULL)
466 || (entryvalue == NULL))
469 if (rte_cfgfile_has_entry(cfg, sectionname, entryname) != 0)
472 /* search for section pointer by sectionname */
473 struct rte_cfgfile_section *curr_section = _get_section(cfg,
475 if (curr_section == NULL)
478 ret = _add_entry(curr_section, entryname, entryvalue);
483 int rte_cfgfile_set_entry(struct rte_cfgfile *cfg, const char *sectionname,
484 const char *entryname, const char *entryvalue)
488 if ((cfg == NULL) || (sectionname == NULL) || (entryname == NULL))
491 /* search for section pointer by sectionname */
492 struct rte_cfgfile_section *curr_section = _get_section(cfg,
494 if (curr_section == NULL)
497 if (entryvalue == NULL)
500 for (i = 0; i < curr_section->num_entries; i++)
501 if (!strcmp(curr_section->entries[i].name, entryname)) {
502 snprintf(curr_section->entries[i].value,
503 sizeof(curr_section->entries[i].value),
507 printf("Error - entry name doesn't exist\n");
511 int rte_cfgfile_save(struct rte_cfgfile *cfg, const char *filename)
515 if ((cfg == NULL) || (filename == NULL))
518 FILE *f = fopen(filename, "w");
523 for (i = 0; i < cfg->num_sections; i++) {
524 fprintf(f, "[%s]\n", cfg->sections[i].name);
526 for (j = 0; j < cfg->sections[i].num_entries; j++) {
527 fprintf(f, "%s=%s\n",
528 cfg->sections[i].entries[j].name,
529 cfg->sections[i].entries[j].value);
535 int rte_cfgfile_close(struct rte_cfgfile *cfg)
542 if (cfg->sections != NULL) {
543 for (i = 0; i < cfg->allocated_sections; i++) {
544 if (cfg->sections[i].entries != NULL) {
545 free(cfg->sections[i].entries);
546 cfg->sections[i].entries = NULL;
550 cfg->sections = NULL;
559 rte_cfgfile_num_sections(struct rte_cfgfile *cfg, const char *sectionname,
563 int num_sections = 0;
564 for (i = 0; i < cfg->num_sections; i++) {
565 if (strncmp(cfg->sections[i].name, sectionname, length) == 0)
572 rte_cfgfile_sections(struct rte_cfgfile *cfg, char *sections[],
577 for (i = 0; i < cfg->num_sections && i < max_sections; i++)
578 snprintf(sections[i], CFG_NAME_LEN, "%s",
579 cfg->sections[i].name);
585 rte_cfgfile_has_section(struct rte_cfgfile *cfg, const char *sectionname)
587 return _get_section(cfg, sectionname) != NULL;
591 rte_cfgfile_section_num_entries(struct rte_cfgfile *cfg,
592 const char *sectionname)
594 const struct rte_cfgfile_section *s = _get_section(cfg, sectionname);
597 return s->num_entries;
601 rte_cfgfile_section_num_entries_by_index(struct rte_cfgfile *cfg,
602 char *sectionname, int index)
604 if (index < 0 || index >= cfg->num_sections)
607 const struct rte_cfgfile_section *sect = &(cfg->sections[index]);
609 snprintf(sectionname, CFG_NAME_LEN, "%s", sect->name);
610 return sect->num_entries;
613 rte_cfgfile_section_entries(struct rte_cfgfile *cfg, const char *sectionname,
614 struct rte_cfgfile_entry *entries, int max_entries)
617 const struct rte_cfgfile_section *sect = _get_section(cfg, sectionname);
620 for (i = 0; i < max_entries && i < sect->num_entries; i++)
621 entries[i] = sect->entries[i];
626 rte_cfgfile_section_entries_by_index(struct rte_cfgfile *cfg, int index,
628 struct rte_cfgfile_entry *entries, int max_entries)
631 const struct rte_cfgfile_section *sect;
633 if (index < 0 || index >= cfg->num_sections)
635 sect = &cfg->sections[index];
636 snprintf(sectionname, CFG_NAME_LEN, "%s", sect->name);
637 for (i = 0; i < max_entries && i < sect->num_entries; i++)
638 entries[i] = sect->entries[i];
643 rte_cfgfile_get_entry(struct rte_cfgfile *cfg, const char *sectionname,
644 const char *entryname)
647 const struct rte_cfgfile_section *sect = _get_section(cfg, sectionname);
650 for (i = 0; i < sect->num_entries; i++)
651 if (strncmp(sect->entries[i].name, entryname, CFG_NAME_LEN)
653 return sect->entries[i].value;
658 rte_cfgfile_has_entry(struct rte_cfgfile *cfg, const char *sectionname,
659 const char *entryname)
661 return rte_cfgfile_get_entry(cfg, sectionname, entryname) != NULL;