src/appconfig.c

   1 #include "common.h"
   2
   3 #define CONFIG_FILE_LINE_MAX ((CONFIG_MAX_NAME + CONFIG_MAX_VALUE + 1024) * 2)
   4
   5 // ----------------------------------------------------------------------------
   6 // definitions
   7
   8 #define CONFIG_VALUE_LOADED  0x01 // has been loaded from the config
   9 #define CONFIG_VALUE_USED    0x02 // has been accessed from the program
  10 #define CONFIG_VALUE_CHANGED 0x04 // has been changed from the loaded value
  11 #define CONFIG_VALUE_CHECKED 0x08 // has been checked if the value is different from the default
  12
  13 struct config_option {
  14     avl avl;                // the index - this has to be first!
  15
  16     uint8_t flags;
  17     uint32_t hash;          // a simple hash to speed up searching
  18                             // we first compare hashes, and only if the hashes are equal we do string comparisons
  19
  20     char *name;
  21     char *value;
  22
  23     struct config_option *next; // config->mutex protects just this
  24 };
  25
  26 struct section {
  27     avl avl;
  28
  29     uint32_t hash;          // a simple hash to speed up searching
  30                             // we first compare hashes, and only if the hashes are equal we do string comparisons
  31
  32     char *name;
  33
  34     struct section *next;    // gloabl config_mutex protects just this
  35
  36     struct config_option *values;
  37     avl_tree_lock values_index;
  38
  39     pthread_mutex_t mutex;  // this locks only the writers, to ensure atomic updates
  40                             // readers are protected using the rwlock in avl_tree_lock
  41 };
  42
  43 static int appconfig_section_compare(void *a, void *b);
  44
  45 struct config netdata_config = {
  46         .sections = NULL,
  47         .mutex = PTHREAD_MUTEX_INITIALIZER,
  48         .index = {
  49             { NULL, appconfig_section_compare },
  50             AVL_LOCK_INITIALIZER
  51         }
  52 };
  53
  54 struct config stream_config = {
  55         .sections = NULL,
  56         .mutex = PTHREAD_MUTEX_INITIALIZER,
  57         .index = {
  58                 { NULL, appconfig_section_compare },
  59                 AVL_LOCK_INITIALIZER
  60         }
  61 };
  62
  63 // ----------------------------------------------------------------------------
  64 // locking
  65
  66 static inline void appconfig_wrlock(struct config *root) {
  67     pthread_mutex_lock(&root->mutex);
  68 }
  69
  70 static inline void appconfig_unlock(struct config *root) {
  71     pthread_mutex_unlock(&root->mutex);
  72 }
  73
  74 static inline void config_section_wrlock(struct section *co) {
  75     pthread_mutex_lock(&co->mutex);
  76 }
  77
  78 static inline void config_section_unlock(struct section *co) {
  79     pthread_mutex_unlock(&co->mutex);
  80 }
  81
  82
  83 // ----------------------------------------------------------------------------
  84 // config name-value index
  85
  86 static int appconfig_option_compare(void *a, void *b) {
  87     if(((struct config_option *)a)->hash < ((struct config_option *)b)->hash) return -1;
  88     else if(((struct config_option *)a)->hash > ((struct config_option *)b)->hash) return 1;
  89     else return strcmp(((struct config_option *)a)->name, ((struct config_option *)b)->name);
  90 }
  91
  92 #define appconfig_option_index_add(co, cv) (struct config_option *)avl_insert_lock(&((co)->values_index), (avl *)(cv))
  93 #define appconfig_option_index_del(co, cv) (struct config_option *)avl_remove_lock(&((co)->values_index), (avl *)(cv))
  94
  95 static struct config_option *appconfig_option_index_find(struct section *co, const char *name, uint32_t hash) {
  96     struct config_option tmp;
  97     tmp.hash = (hash)?hash:simple_hash(name);
  98     tmp.name = (char *)name;
  99
 100     return (struct config_option *)avl_search_lock(&(co->values_index), (avl *) &tmp);
 101 }
 102
 103
 104 // ----------------------------------------------------------------------------
 105 // config sections index
 106
 107 static int appconfig_section_compare(void *a, void *b) {
 108     if(((struct section *)a)->hash < ((struct section *)b)->hash) return -1;
 109     else if(((struct section *)a)->hash > ((struct section *)b)->hash) return 1;
 110     else return strcmp(((struct section *)a)->name, ((struct section *)b)->name);
 111 }
 112
 113 #define appconfig_index_add(root, cfg) (struct section *)avl_insert_lock(&root->index, (avl *)(cfg))
 114 #define appconfig_index_del(root, cfg) (struct section *)avl_remove_lock(&root->index, (avl *)(cfg))
 115
 116 static struct section *appconfig_index_find(struct config *root, const char *name, uint32_t hash) {
 117     struct section tmp;
 118     tmp.hash = (hash)?hash:simple_hash(name);
 119     tmp.name = (char *)name;
 120
 121     return (struct section *)avl_search_lock(&root->index, (avl *) &tmp);
 122 }
 123
 124
 125 // ----------------------------------------------------------------------------
 126 // config section methods
 127
 128 static inline struct section *appconfig_section_find(struct config *root, const char *section) {
 129     return appconfig_index_find(root, section, 0);
 130 }
 131
 132 static inline struct section *appconfig_section_create(struct config *root, const char *section) {
 133     debug(D_CONFIG, "Creating section '%s'.", section);
 134
 135     struct section *co = callocz(1, sizeof(struct section));
 136     co->name = strdupz(section);
 137     co->hash = simple_hash(co->name);
 138
 139     avl_init_lock(&co->values_index, appconfig_option_compare);
 140
 141     if(unlikely(appconfig_index_add(root, co) != co))
 142         error("INTERNAL ERROR: indexing of section '%s', already exists.", co->name);
 143
 144     appconfig_wrlock(root);
 145     struct section *co2 = root->sections;
 146     if(co2) {
 147         while (co2->next) co2 = co2->next;
 148         co2->next = co;
 149     }
 150     else root->sections = co;
 151     appconfig_unlock(root);
 152
 153     return co;
 154 }
 155
 156
 157 // ----------------------------------------------------------------------------
 158 // config name-value methods
 159
 160 static inline struct config_option *appconfig_value_create(struct section *co, const char *name, const char *value)
 161 {
 162     debug(D_CONFIG, "Creating config entry for name '%s', value '%s', in section '%s'.", name, value, co->name);
 163
 164     struct config_option *cv = callocz(1, sizeof(struct config_option));
 165     cv->name = strdupz(name);
 166     cv->hash = simple_hash(cv->name);
 167     cv->value = strdupz(value);
 168
 169     if(unlikely(appconfig_option_index_add(co, cv) != cv))
 170         error("INTERNAL ERROR: indexing of config '%s' in section '%s': already exists.", cv->name, co->name);
 171
 172     config_section_wrlock(co);
 173     struct config_option *cv2 = co->values;
 174     if(cv2) {
 175         while (cv2->next) cv2 = cv2->next;
 176         cv2->next = cv;
 177     }
 178     else co->values = cv;
 179     config_section_unlock(co);
 180
 181     return cv;
 182 }
 183
 184 int appconfig_exists(struct config *root, const char *section, const char *name) {
 185     struct config_option *cv;
 186
 187     debug(D_CONFIG, "request to get config in section '%s', name '%s'", section, name);
 188
 189     struct section *co = appconfig_section_find(root, section);
 190     if(!co) return 0;
 191
 192     cv = appconfig_option_index_find(co, name, 0);
 193     if(!cv) return 0;
 194
 195     return 1;
 196 }
 197
 198 int appconfig_rename(struct config *root, const char *section, const char *old, const char *new) {
 199     struct config_option *cv, *cv2;
 200
 201     debug(D_CONFIG, "request to rename config in section '%s', old name '%s', new name '%s'", section, old, new);
 202
 203     struct section *co = appconfig_section_find(root, section);
 204     if(!co) return -1;
 205
 206     config_section_wrlock(co);
 207
 208     cv = appconfig_option_index_find(co, old, 0);
 209     if(!cv) goto cleanup;
 210
 211     cv2 = appconfig_option_index_find(co, new, 0);
 212     if(cv2) goto cleanup;
 213
 214     if(unlikely(appconfig_option_index_del(co, cv) != cv))
 215         error("INTERNAL ERROR: deletion of config '%s' from section '%s', deleted tge wrong config entry.", cv->name, co->name);
 216
 217     freez(cv->name);
 218     cv->name = strdupz(new);
 219     cv->hash = simple_hash(cv->name);
 220     if(unlikely(appconfig_option_index_add(co, cv) != cv))
 221         error("INTERNAL ERROR: indexing of config '%s' in section '%s', already exists.", cv->name, co->name);
 222
 223     config_section_unlock(co);
 224
 225     return 0;
 226
 227 cleanup:
 228     config_section_unlock(co);
 229     return -1;
 230 }
 231
 232 char *appconfig_get(struct config *root, const char *section, const char *name, const char *default_value)
 233 {
 234     struct config_option *cv;
 235
 236     debug(D_CONFIG, "request to get config in section '%s', name '%s', default_value '%s'", section, name, default_value);
 237
 238     struct section *co = appconfig_section_find(root, section);
 239     if(!co) co = appconfig_section_create(root, section);
 240
 241     cv = appconfig_option_index_find(co, name, 0);
 242     if(!cv) {
 243         cv = appconfig_value_create(co, name, default_value);
 244         if(!cv) return NULL;
 245     }
 246     cv->flags |= CONFIG_VALUE_USED;
 247
 248     if((cv->flags & CONFIG_VALUE_LOADED) || (cv->flags & CONFIG_VALUE_CHANGED)) {
 249         // this is a loaded value from the config file
 250         // if it is different that the default, mark it
 251         if(!(cv->flags & CONFIG_VALUE_CHECKED)) {
 252             if(strcmp(cv->value, default_value) != 0) cv->flags |= CONFIG_VALUE_CHANGED;
 253             cv->flags |= CONFIG_VALUE_CHECKED;
 254         }
 255     }
 256
 257     return(cv->value);
 258 }
 259
 260 long long appconfig_get_number(struct config *root, const char *section, const char *name, long long value)
 261 {
 262     char buffer[100], *s;
 263     sprintf(buffer, "%lld", value);
 264
 265     s = appconfig_get(root, section, name, buffer);
 266     if(!s) return value;
 267
 268     return strtoll(s, NULL, 0);
 269 }
 270
 271 int appconfig_get_boolean(struct config *root, const char *section, const char *name, int value)
 272 {
 273     char *s;
 274     if(value) s = "yes";
 275     else s = "no";
 276
 277     s = appconfig_get(root, section, name, s);
 278     if(!s) return value;
 279
 280     if(!strcmp(s, "yes") || !strcmp(s, "auto") || !strcmp(s, "on demand")) return 1;
 281     return 0;
 282 }
 283
 284 int appconfig_get_boolean_ondemand(struct config *root, const char *section, const char *name, int value)
 285 {
 286     char *s;
 287
 288     if(value == CONFIG_BOOLEAN_AUTO)
 289         s = "auto";
 290
 291     else if(value == CONFIG_BOOLEAN_NO)
 292         s = "no";
 293
 294     else
 295         s = "yes";
 296
 297     s = appconfig_get(root, section, name, s);
 298     if(!s) return value;
 299
 300     if(!strcmp(s, "yes"))
 301         return CONFIG_BOOLEAN_YES;
 302     else if(!strcmp(s, "no"))
 303         return CONFIG_BOOLEAN_NO;
 304     else if(!strcmp(s, "auto") || !strcmp(s, "on demand"))
 305         return CONFIG_BOOLEAN_AUTO;
 306
 307     return value;
 308 }
 309
 310 const char *appconfig_set_default(struct config *root, const char *section, const char *name, const char *value)
 311 {
 312     struct config_option *cv;
 313
 314     debug(D_CONFIG, "request to set config in section '%s', name '%s', value '%s'", section, name, value);
 315
 316     struct section *co = appconfig_section_find(root, section);
 317     if(!co) return appconfig_set(root, section, name, value);
 318
 319     cv = appconfig_option_index_find(co, name, 0);
 320     if(!cv) return appconfig_set(root, section, name, value);
 321
 322     cv->flags |= CONFIG_VALUE_USED;
 323
 324     if(cv->flags & CONFIG_VALUE_LOADED)
 325         return cv->value;
 326
 327     if(strcmp(cv->value, value) != 0) {
 328         cv->flags |= CONFIG_VALUE_CHANGED;
 329
 330         freez(cv->value);
 331         cv->value = strdupz(value);
 332     }
 333
 334     return cv->value;
 335 }
 336
 337 const char *appconfig_set(struct config *root, const char *section, const char *name, const char *value)
 338 {
 339     struct config_option *cv;
 340
 341     debug(D_CONFIG, "request to set config in section '%s', name '%s', value '%s'", section, name, value);
 342
 343     struct section *co = appconfig_section_find(root, section);
 344     if(!co) co = appconfig_section_create(root, section);
 345
 346     cv = appconfig_option_index_find(co, name, 0);
 347     if(!cv) cv = appconfig_value_create(co, name, value);
 348     cv->flags |= CONFIG_VALUE_USED;
 349
 350     if(strcmp(cv->value, value) != 0) {
 351         cv->flags |= CONFIG_VALUE_CHANGED;
 352
 353         freez(cv->value);
 354         cv->value = strdupz(value);
 355     }
 356
 357     return value;
 358 }
 359
 360 long long appconfig_set_number(struct config *root, const char *section, const char *name, long long value)
 361 {
 362     char buffer[100];
 363     sprintf(buffer, "%lld", value);
 364
 365     appconfig_set(root, section, name, buffer);
 366
 367     return value;
 368 }
 369
 370 int appconfig_set_boolean(struct config *root, const char *section, const char *name, int value)
 371 {
 372     char *s;
 373     if(value) s = "yes";
 374     else s = "no";
 375
 376     appconfig_set(root, section, name, s);
 377
 378     return value;
 379 }
 380
 381
 382 // ----------------------------------------------------------------------------
 383 // config load/save
 384
 385 int appconfig_load(struct config *root, char *filename, int overwrite_used)
 386 {
 387     int line = 0;
 388     struct section *co = NULL;
 389
 390     char buffer[CONFIG_FILE_LINE_MAX + 1], *s;
 391
 392     if(!filename) filename = CONFIG_DIR "/" CONFIG_FILENAME;
 393
 394     debug(D_CONFIG, "Opening config file '%s'", filename);
 395
 396     FILE *fp = fopen(filename, "r");
 397     if(!fp) {
 398         error("Cannot open file '%s'", filename);
 399         return 0;
 400     }
 401
 402     while(fgets(buffer, CONFIG_FILE_LINE_MAX, fp) != NULL) {
 403         buffer[CONFIG_FILE_LINE_MAX] = '\0';
 404         line++;
 405
 406         s = trim(buffer);
 407         if(!s) {
 408             debug(D_CONFIG, "Ignoring line %d, it is empty.", line);
 409             continue;
 410         }
 411
 412         int len = (int) strlen(s);
 413         if(*s == '[' && s[len - 1] == ']') {
 414             // new section
 415             s[len - 1] = '\0';
 416             s++;
 417
 418             co = appconfig_section_find(root, s);
 419             if(!co) co = appconfig_section_create(root, s);
 420
 421             continue;
 422         }
 423
 424         if(!co) {
 425             // line outside a section
 426             error("Ignoring line %d ('%s'), it is outside all sections.", line, s);
 427             continue;
 428         }
 429
 430         char *name = s;
 431         char *value = strchr(s, '=');
 432         if(!value) {
 433             error("Ignoring line %d ('%s'), there is no = in it.", line, s);
 434             continue;
 435         }
 436         *value = '\0';
 437         value++;
 438
 439         name = trim(name);
 440         value = trim(value);
 441
 442         if(!name) {
 443             error("Ignoring line %d, name is empty.", line);
 444             continue;
 445         }
 446         if(!value) {
 447             debug(D_CONFIG, "Ignoring line %d, value is empty.", line);
 448             continue;
 449         }
 450
 451         struct config_option *cv = appconfig_option_index_find(co, name, 0);
 452
 453         if(!cv) cv = appconfig_value_create(co, name, value);
 454         else {
 455             if(((cv->flags & CONFIG_VALUE_USED) && overwrite_used) || !(cv->flags & CONFIG_VALUE_USED)) {
 456                 debug(D_CONFIG, "Line %d, overwriting '%s/%s'.", line, co->name, cv->name);
 457                 freez(cv->value);
 458                 cv->value = strdupz(value);
 459             }
 460             else
 461                 debug(D_CONFIG, "Ignoring line %d, '%s/%s' is already present and used.", line, co->name, cv->name);
 462         }
 463         cv->flags |= CONFIG_VALUE_LOADED;
 464     }
 465
 466     fclose(fp);
 467
 468     return 1;
 469 }
 470
 471 void appconfig_generate(struct config *root, BUFFER *wb, int only_changed)
 472 {
 473     int i, pri;
 474     struct section *co;
 475     struct config_option *cv;
 476
 477     for(i = 0; i < 3 ;i++) {
 478         switch(i) {
 479             case 0:
 480                 buffer_strcat(wb,
 481                     "# netdata configuration\n"
 482                     "#\n"
 483                     "# You can download the latest version of this file, using:\n"
 484                     "#\n"
 485                     "#  wget -O /etc/netdata/netdata.conf http://localhost:19999/netdata.conf\n"
 486                     "# or\n"
 487                     "#  curl -o /etc/netdata/netdata.conf http://localhost:19999/netdata.conf\n"
 488                     "#\n"
 489                     "# You can uncomment and change any of the options below.\n"
 490                     "# The value shown in the commented settings, is the default value.\n"
 491                     "#\n"
 492                     "\n# global netdata configuration\n");
 493                 break;
 494
 495             case 1:
 496                 buffer_strcat(wb, "\n\n# per plugin configuration\n");
 497                 break;
 498
 499             case 2:
 500                 buffer_strcat(wb, "\n\n# per chart configuration\n");
 501                 break;
 502         }
 503
 504         appconfig_wrlock(root);
 505         for(co = root->sections; co ; co = co->next) {
 506             if(!strcmp(co->name, "global") ||
 507                     !strcmp(co->name, "plugins")  ||
 508                     !strcmp(co->name, "registry") ||
 509                     !strcmp(co->name, "health")   ||
 510                     !strcmp(co->name, "backend"))
 511                 pri = 0;
 512             else if(!strncmp(co->name, "plugin:", 7)) pri = 1;
 513             else pri = 2;
 514
 515             if(i == pri) {
 516                 int used = 0;
 517                 int changed = 0;
 518                 int count = 0;
 519
 520                 config_section_wrlock(co);
 521                 for(cv = co->values; cv ; cv = cv->next) {
 522                     used += (cv->flags & CONFIG_VALUE_USED)?1:0;
 523                     changed += (cv->flags & CONFIG_VALUE_CHANGED)?1:0;
 524                     count++;
 525                 }
 526                 config_section_unlock(co);
 527
 528                 if(!count) continue;
 529                 if(only_changed && !changed) continue;
 530
 531                 if(!used) {
 532                     buffer_sprintf(wb, "\n# node '%s' is not used.", co->name);
 533                 }
 534
 535                 buffer_sprintf(wb, "\n[%s]\n", co->name);
 536
 537                 config_section_wrlock(co);
 538                 for(cv = co->values; cv ; cv = cv->next) {
 539
 540                     if(used && !(cv->flags & CONFIG_VALUE_USED)) {
 541                         buffer_sprintf(wb, "\n\t# option '%s' is not used.\n", cv->name);
 542                     }
 543                     buffer_sprintf(wb, "\t%s%s = %s\n", ((!(cv->flags & CONFIG_VALUE_CHANGED)) && (cv->flags & CONFIG_VALUE_USED))?"# ":"", cv->name, cv->value);
 544                 }
 545                 config_section_unlock(co);
 546             }
 547         }
 548         appconfig_unlock(root);
 549     }
 550 }