lib/librte_cfgfile/rte_cfgfile.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  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
  16  *       distribution.
  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.
  20  *
  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.
  32  */
  33
  34 #include <stdio.h>
  35 #include <stdlib.h>
  36 #include <string.h>
  37 #include <ctype.h>
  38 #include <errno.h>
  39 #include <rte_common.h>
  40
  41 #include "rte_cfgfile.h"
  42
  43 struct rte_cfgfile_section {
  44         char name[CFG_NAME_LEN];
  45         int num_entries;
  46         int allocated_entries;
  47         struct rte_cfgfile_entry *entries;
  48 };
  49
  50 struct rte_cfgfile {
  51         int flags;
  52         int num_sections;
  53         int allocated_sections;
  54         struct rte_cfgfile_section *sections;
  55 };
  56
  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
  63
  64 /**
  65  * Default cfgfile load parameters.
  66  */
  67 static const struct rte_cfgfile_parameters default_cfgfile_params = {
  68         .comment_character = CFG_DEFAULT_COMMENT_CHARACTER,
  69 };
  70
  71 /**
  72  * Defines the list of acceptable comment characters supported by this
  73  * library.
  74  */
  75 static const char valid_comment_chars[] = {
  76         '!',
  77         '#',
  78         '%',
  79         ';',
  80         '@'
  81 };
  82
  83 static unsigned
  84 _strip(char *str, unsigned len)
  85 {
  86         int newlen = len;
  87         if (len == 0)
  88                 return 0;
  89
  90         if (isspace(str[len-1])) {
  91                 /* strip trailing whitespace */
  92                 while (newlen > 0 && isspace(str[newlen - 1]))
  93                         str[--newlen] = '\0';
  94         }
  95
  96         if (isspace(str[0])) {
  97                 /* strip leading whitespace */
  98                 int i, start = 1;
  99                 while (isspace(str[start]) && start < newlen)
 100                         start++
 101                         ; /* do nothing */
 102                 newlen -= start;
 103                 for (i = 0; i < newlen; i++)
 104                         str[i] = str[i+start];
 105                 str[i] = '\0';
 106         }
 107         return newlen;
 108 }
 109
 110 static struct rte_cfgfile_section *
 111 _get_section(struct rte_cfgfile *cfg, const char *sectionname)
 112 {
 113         int i;
 114
 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];
 119         }
 120         return NULL;
 121 }
 122
 123 static int
 124 _add_entry(struct rte_cfgfile_section *section, const char *entryname,
 125                 const char *entryvalue)
 126 {
 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(
 130                                 section->entries,
 131                                 sizeof(struct rte_cfgfile_entry) *
 132                                 ((section->allocated_entries) +
 133                                                 CFG_ALLOC_ENTRY_BATCH));
 134
 135                 if (n_entries == NULL)
 136                         return -ENOMEM;
 137
 138                 section->entries = n_entries;
 139                 section->allocated_entries += CFG_ALLOC_ENTRY_BATCH;
 140         }
 141         /* fill up entry fields with key name and value */
 142         struct rte_cfgfile_entry *curr_entry =
 143                                         &section->entries[section->num_entries];
 144
 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++;
 149
 150         return 0;
 151 }
 152
 153 static int
 154 rte_cfgfile_check_params(const struct rte_cfgfile_parameters *params)
 155 {
 156         unsigned int valid_comment;
 157         unsigned int i;
 158
 159         if (!params) {
 160                 printf("Error - missing cfgfile parameters\n");
 161                 return -EINVAL;
 162         }
 163
 164         valid_comment = 0;
 165         for (i = 0; i < RTE_DIM(valid_comment_chars); i++) {
 166                 if (params->comment_character == valid_comment_chars[i]) {
 167                         valid_comment = 1;
 168                         break;
 169                 }
 170         }
 171
 172         if (valid_comment == 0) {
 173                 printf("Error - invalid comment characters %c\n",
 174                        params->comment_character);
 175                 return -ENOTSUP;
 176         }
 177
 178         return 0;
 179 }
 180
 181 struct rte_cfgfile *
 182 rte_cfgfile_load(const char *filename, int flags)
 183 {
 184         return rte_cfgfile_load_with_params(filename, flags,
 185                                             &default_cfgfile_params);
 186 }
 187
 188 struct rte_cfgfile *
 189 rte_cfgfile_load_with_params(const char *filename, int flags,
 190                              const struct rte_cfgfile_parameters *params)
 191 {
 192         char buffer[CFG_NAME_LEN + CFG_VALUE_LEN + 4] = {0};
 193         int lineno = 0;
 194         struct rte_cfgfile *cfg = NULL;
 195
 196         if (rte_cfgfile_check_params(params))
 197                 return NULL;
 198
 199         FILE *f = fopen(filename, "r");
 200         if (f == NULL)
 201                 return NULL;
 202
 203         cfg = rte_cfgfile_create(flags);
 204
 205         while (fgets(buffer, sizeof(buffer), f) != NULL) {
 206                 char *pos = NULL;
 207                 size_t len = strnlen(buffer, sizeof(buffer));
 208                 lineno++;
 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);
 212                         goto error1;
 213                 }
 214                 /* skip parsing if comment character found */
 215                 pos = memchr(buffer, params->comment_character, len);
 216                 if (pos != NULL && (*(pos-1) != '\\')) {
 217                         *pos = '\0';
 218                         len = pos -  buffer;
 219                 }
 220
 221                 len = _strip(buffer, len);
 222                 /* skip lines without useful content */
 223                 if (buffer[0] != '[' && memchr(buffer, '=', len) == NULL)
 224                         continue;
 225
 226                 if (buffer[0] == '[') {
 227                         /* section heading line */
 228                         char *end = memchr(buffer, ']', len);
 229                         if (end == NULL) {
 230                                 printf("Error line %d - no terminating ']'"
 231                                         "character found\n", lineno);
 232                                 goto error1;
 233                         }
 234                         *end = '\0';
 235                         _strip(&buffer[1], end - &buffer[1]);
 236
 237                         rte_cfgfile_add_section(cfg, &buffer[1]);
 238                 } else {
 239                         /* key and value line */
 240                         char *split[2] = {NULL};
 241
 242                         split[0] = buffer;
 243                         split[1] = memchr(buffer, '=', len);
 244                         *split[1] = '\0';
 245                         split[1]++;
 246
 247                         _strip(split[0], strlen(split[0]));
 248                         _strip(split[1], strlen(split[1]));
 249                         char *end = memchr(split[1], '\\', strlen(split[1]));
 250
 251                         while (end != NULL) {
 252                                 if (*(end+1) == params->comment_character) {
 253                                         *end = '\0';
 254                                         strcat(split[1], end+1);
 255                                 } else
 256                                         end++;
 257                                 end = memchr(end, '\\', strlen(end));
 258                         }
 259
 260                         if (!(flags & CFG_FLAG_EMPTY_VALUES) &&
 261                                         (*split[1] == '\0')) {
 262                                 printf("Error at line %d - cannot use empty "
 263                                                         "values\n", lineno);
 264                                 goto error1;
 265                         }
 266
 267                         if (cfg->num_sections == 0)
 268                                 goto error1;
 269
 270                         _add_entry(&cfg->sections[cfg->num_sections - 1],
 271                                         split[0], (split[1] ? split[1] : ""));
 272                 }
 273         }
 274         fclose(f);
 275         return cfg;
 276 error1:
 277         rte_cfgfile_close(cfg);
 278         fclose(f);
 279         return NULL;
 280 }
 281
 282 struct rte_cfgfile *
 283 rte_cfgfile_create(int flags)
 284 {
 285         int i;
 286         struct rte_cfgfile *cfg = NULL;
 287
 288         cfg = malloc(sizeof(*cfg));
 289
 290         if (cfg == NULL)
 291                 return NULL;
 292
 293         cfg->flags = flags;
 294         cfg->num_sections = 0;
 295
 296         /* allocate first batch of sections and entries */
 297         cfg->sections = malloc(sizeof(struct rte_cfgfile_section) *
 298                         CFG_ALLOC_SECTION_BATCH);
 299
 300         if (cfg->sections == NULL)
 301                 return NULL;
 302
 303         cfg->allocated_sections = CFG_ALLOC_SECTION_BATCH;
 304
 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);
 308
 309                 if (cfg->sections[i].entries == NULL)
 310                         return NULL;
 311
 312                 cfg->sections[i].num_entries = 0;
 313                 cfg->sections[i].allocated_entries = CFG_ALLOC_ENTRY_BATCH;
 314         }
 315
 316         if (flags & CFG_FLAG_GLOBAL_SECTION)
 317                 rte_cfgfile_add_section(cfg, "GLOBAL");
 318         return cfg;
 319 }
 320
 321 int
 322 rte_cfgfile_add_section(struct rte_cfgfile *cfg, const char *sectionname)
 323 {
 324         int i;
 325
 326         if (cfg == NULL)
 327                 return -EINVAL;
 328
 329         if (sectionname == NULL)
 330                 return -EINVAL;
 331
 332         /* resize overall struct if we don't have room for more sections */
 333         if (cfg->num_sections == cfg->allocated_sections) {
 334
 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));
 340
 341                 if (n_sections == NULL)
 342                         return -ENOMEM;
 343
 344                 for (i = 0; i < CFG_ALLOC_SECTION_BATCH; i++) {
 345                         n_sections[i + cfg->allocated_sections].num_entries = 0;
 346                         n_sections[i +
 347                                  cfg->allocated_sections].allocated_entries = 0;
 348                         n_sections[i + cfg->allocated_sections].entries = NULL;
 349                 }
 350                 cfg->sections = n_sections;
 351                 cfg->allocated_sections += CFG_ALLOC_SECTION_BATCH;
 352         }
 353
 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;
 357         cfg->num_sections++;
 358
 359         return 0;
 360 }
 361
 362 int rte_cfgfile_add_entry(struct rte_cfgfile *cfg,
 363                 const char *sectionname, const char *entryname,
 364                 const char *entryvalue)
 365 {
 366         int ret;
 367
 368         if ((cfg == NULL) || (sectionname == NULL) || (entryname == NULL)
 369                         || (entryvalue == NULL))
 370                 return -EINVAL;
 371
 372         if (rte_cfgfile_has_entry(cfg, sectionname, entryname) != 0)
 373                 return -EEXIST;
 374
 375         /* search for section pointer by sectionname */
 376         struct rte_cfgfile_section *curr_section = _get_section(cfg,
 377                                                                 sectionname);
 378         if (curr_section == NULL)
 379                 return -EINVAL;
 380
 381         ret = _add_entry(curr_section, entryname, entryvalue);
 382
 383         return ret;
 384 }
 385
 386 int rte_cfgfile_set_entry(struct rte_cfgfile *cfg, const char *sectionname,
 387                 const char *entryname, const char *entryvalue)
 388 {
 389         int i;
 390
 391         if ((cfg == NULL) || (sectionname == NULL) || (entryname == NULL))
 392                 return -EINVAL;
 393
 394         /* search for section pointer by sectionname */
 395         struct rte_cfgfile_section *curr_section = _get_section(cfg,
 396                                                                 sectionname);
 397         if (curr_section == NULL)
 398                 return -EINVAL;
 399
 400         if (entryvalue == NULL)
 401                 entryvalue = "";
 402
 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),
 407                                                         "%s", entryvalue);
 408                         return 0;
 409                 }
 410         printf("Error - entry name doesn't exist\n");
 411         return -EINVAL;
 412 }
 413
 414 int rte_cfgfile_save(struct rte_cfgfile *cfg, const char *filename)
 415 {
 416         int i, j;
 417
 418         if ((cfg == NULL) || (filename == NULL))
 419                 return -EINVAL;
 420
 421         FILE *f = fopen(filename, "w");
 422
 423         if (f == NULL)
 424                 return -EINVAL;
 425
 426         for (i = 0; i < cfg->num_sections; i++) {
 427                 fprintf(f, "[%s]\n", cfg->sections[i].name);
 428
 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);
 433                 }
 434         }
 435         return fclose(f);
 436 }
 437
 438 int rte_cfgfile_close(struct rte_cfgfile *cfg)
 439 {
 440         int i;
 441
 442         if (cfg == NULL)
 443                 return -1;
 444
 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;
 450                         }
 451                 }
 452                 free(cfg->sections);
 453                 cfg->sections = NULL;
 454         }
 455         free(cfg);
 456         cfg = NULL;
 457
 458         return 0;
 459 }
 460
 461 int
 462 rte_cfgfile_num_sections(struct rte_cfgfile *cfg, const char *sectionname,
 463 size_t length)
 464 {
 465         int i;
 466         int num_sections = 0;
 467         for (i = 0; i < cfg->num_sections; i++) {
 468                 if (strncmp(cfg->sections[i].name, sectionname, length) == 0)
 469                         num_sections++;
 470         }
 471         return num_sections;
 472 }
 473
 474 int
 475 rte_cfgfile_sections(struct rte_cfgfile *cfg, char *sections[],
 476         int max_sections)
 477 {
 478         int i;
 479
 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);
 483
 484         return i;
 485 }
 486
 487 int
 488 rte_cfgfile_has_section(struct rte_cfgfile *cfg, const char *sectionname)
 489 {
 490         return _get_section(cfg, sectionname) != NULL;
 491 }
 492
 493 int
 494 rte_cfgfile_section_num_entries(struct rte_cfgfile *cfg,
 495         const char *sectionname)
 496 {
 497         const struct rte_cfgfile_section *s = _get_section(cfg, sectionname);
 498         if (s == NULL)
 499                 return -1;
 500         return s->num_entries;
 501 }
 502
 503 int
 504 rte_cfgfile_section_num_entries_by_index(struct rte_cfgfile *cfg,
 505         char *sectionname, int index)
 506 {
 507         if (index < 0 || index >= cfg->num_sections)
 508                 return -1;
 509
 510         const struct rte_cfgfile_section *sect = &(cfg->sections[index]);
 511
 512         snprintf(sectionname, CFG_NAME_LEN, "%s", sect->name);
 513         return sect->num_entries;
 514 }
 515 int
 516 rte_cfgfile_section_entries(struct rte_cfgfile *cfg, const char *sectionname,
 517                 struct rte_cfgfile_entry *entries, int max_entries)
 518 {
 519         int i;
 520         const struct rte_cfgfile_section *sect = _get_section(cfg, sectionname);
 521         if (sect == NULL)
 522                 return -1;
 523         for (i = 0; i < max_entries && i < sect->num_entries; i++)
 524                 entries[i] = sect->entries[i];
 525         return i;
 526 }
 527
 528 int
 529 rte_cfgfile_section_entries_by_index(struct rte_cfgfile *cfg, int index,
 530                 char *sectionname,
 531                 struct rte_cfgfile_entry *entries, int max_entries)
 532 {
 533         int i;
 534         const struct rte_cfgfile_section *sect;
 535
 536         if (index < 0 || index >= cfg->num_sections)
 537                 return -1;
 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];
 542         return i;
 543 }
 544
 545 const char *
 546 rte_cfgfile_get_entry(struct rte_cfgfile *cfg, const char *sectionname,
 547                 const char *entryname)
 548 {
 549         int i;
 550         const struct rte_cfgfile_section *sect = _get_section(cfg, sectionname);
 551         if (sect == NULL)
 552                 return NULL;
 553         for (i = 0; i < sect->num_entries; i++)
 554                 if (strncmp(sect->entries[i].name, entryname, CFG_NAME_LEN)
 555                                                                         == 0)
 556                         return sect->entries[i].value;
 557         return NULL;
 558 }
 559
 560 int
 561 rte_cfgfile_has_entry(struct rte_cfgfile *cfg, const char *sectionname,
 562                 const char *entryname)
 563 {
 564         return rte_cfgfile_get_entry(cfg, sectionname, entryname) != NULL;
 565 }