3 // ----------------------------------------------------------------------------
6 // 1. the default tracking cookie expires in 1 year, but the persons are not
7 // removed from the db - this means the database only grows - ideally the
8 // database should be cleaned in registry_save() for both on-disk and
12 // i. Find all the PERSONs that have expired cookie
13 // ii. For each of their PERSON_URLs:
14 // - decrement the linked MACHINE links
15 // - if the linked MACHINE has no other links, remove the linked MACHINE too
16 // - remove the PERSON_URL
18 // 2. add protection to prevent abusing the registry by flooding it with
19 // requests to fill the memory and crash it.
21 // Possible protections:
22 // - limit the number of URLs per person
23 // - limit the number of URLs per machine
24 // - limit the number of persons
25 // - limit the number of machines
26 // - [DONE] limit the size of URLs
27 // - [DONE] limit the size of PERSON_URL names
28 // - limit the number of requests that add data to the registry,
29 // per client IP per hour
31 // 3. lower memory requirements
33 // - embed avl structures directly into registry objects, instead of DICTIONARY
34 // - store GUIDs in memory as UUID instead of char *
35 // - do not track persons using the demo machines only
36 // (i.e. start tracking them only when they access a non-demo machine)
37 // - [DONE] do not track custom dashboards by default
39 #define REGISTRY_URL_FLAGS_DEFAULT 0x00
40 #define REGISTRY_URL_FLAGS_EXPIRED 0x01
42 #define DICTIONARY_FLAGS DICTIONARY_FLAG_VALUE_LINK_DONT_CLONE | DICTIONARY_FLAG_NAME_LINK_DONT_CLONE
46 // ----------------------------------------------------------------------------
52 char machine_guid[GUID_LEN + 1];
54 // entries counters / statistics
55 unsigned long long persons_count;
56 unsigned long long machines_count;
57 unsigned long long usages_count;
58 unsigned long long urls_count;
59 unsigned long long persons_urls_count;
60 unsigned long long machines_urls_count;
61 unsigned long long log_count;
63 // memory counters / statistics
64 unsigned long long persons_memory;
65 unsigned long long machines_memory;
66 unsigned long long urls_memory;
67 unsigned long long persons_urls_memory;
68 unsigned long long machines_urls_memory;
71 unsigned long long save_registry_every_entries;
72 char *registry_domain;
74 char *registry_to_announce;
75 time_t persons_expiration; // seconds to expire idle persons
76 int verify_cookies_redirects;
78 size_t max_url_length;
79 size_t max_name_length;
85 char *machine_guid_filename;
91 DICTIONARY *persons; // dictionary of PERSON *, with key the PERSON.guid
92 DICTIONARY *machines; // dictionary of MACHINE *, with key the MACHINE.guid
93 DICTIONARY *urls; // dictionary of URL *, with key the URL.url
95 // concurrency locking
96 // we keep different locks for different things
97 // so that many tasks can be completed in parallel
98 pthread_mutex_t persons_lock;
99 pthread_mutex_t machines_lock;
100 pthread_mutex_t urls_lock;
101 pthread_mutex_t person_urls_lock;
102 pthread_mutex_t machine_urls_lock;
103 pthread_mutex_t log_lock;
107 // ----------------------------------------------------------------------------
109 // Save memory by de-duplicating URLs
110 // so instead of storing URLs all over the place
111 // we store them here and we keep pointers elsewhere
113 struct registry_url {
114 uint32_t links; // the number of links to this URL - when none is left, we free it
115 uint16_t len; // the length of the URL in bytes
116 char url[1]; // the URL - dynamically allocated to more size
118 typedef struct registry_url REGISTRY_URL;
121 // ----------------------------------------------------------------------------
122 // MACHINE structures
124 // For each MACHINE-URL pair we keep this
125 struct registry_machine_url {
126 REGISTRY_URL *url; // de-duplicated URL
130 uint32_t first_t; // the first time we saw this
131 uint32_t last_t; // the last time we saw this
132 uint32_t usages; // how many times this has been accessed
134 typedef struct registry_machine_url REGISTRY_MACHINE_URL;
137 struct registry_machine {
138 char guid[GUID_LEN + 1]; // the GUID
140 uint32_t links; // the number of REGISTRY_PERSON_URL linked to this machine
142 DICTIONARY *machine_urls; // MACHINE_URL *
144 uint32_t first_t; // the first time we saw this
145 uint32_t last_t; // the last time we saw this
146 uint32_t usages; // how many times this has been accessed
148 typedef struct registry_machine REGISTRY_MACHINE;
151 // ----------------------------------------------------------------------------
154 // for each PERSON-URL pair we keep this
155 struct registry_person_url {
156 REGISTRY_URL *url; // de-duplicated URL
157 REGISTRY_MACHINE *machine; // link the MACHINE of this URL
161 uint32_t first_t; // the first time we saw this
162 uint32_t last_t; // the last time we saw this
163 uint32_t usages; // how many times this has been accessed
165 char machine_name[1]; // the name of the machine, as known by the user
166 // dynamically allocated to fit properly
168 typedef struct registry_person_url REGISTRY_PERSON_URL;
171 struct registry_person {
172 char guid[GUID_LEN + 1]; // the person GUID
174 DICTIONARY *person_urls; // dictionary of PERSON_URL *
176 uint32_t first_t; // the first time we saw this
177 uint32_t last_t; // the last time we saw this
178 uint32_t usages; // how many times this has been accessed
180 typedef struct registry_person REGISTRY_PERSON;
183 // ----------------------------------------------------------------------------
184 // REGISTRY concurrency locking
186 static inline void registry_persons_lock(void) {
187 pthread_mutex_lock(®istry.persons_lock);
190 static inline void registry_persons_unlock(void) {
191 pthread_mutex_unlock(®istry.persons_lock);
194 static inline void registry_machines_lock(void) {
195 pthread_mutex_lock(®istry.machines_lock);
198 static inline void registry_machines_unlock(void) {
199 pthread_mutex_unlock(®istry.machines_lock);
202 static inline void registry_urls_lock(void) {
203 pthread_mutex_lock(®istry.urls_lock);
206 static inline void registry_urls_unlock(void) {
207 pthread_mutex_unlock(®istry.urls_lock);
210 // ideally, we should not lock the whole registry for
211 // updating a person's urls.
212 // however, to save the memory required for keeping a
213 // mutex (40 bytes) per person, we do...
214 static inline void registry_person_urls_lock(REGISTRY_PERSON *p) {
216 pthread_mutex_lock(®istry.person_urls_lock);
219 static inline void registry_person_urls_unlock(REGISTRY_PERSON *p) {
221 pthread_mutex_unlock(®istry.person_urls_lock);
224 // ideally, we should not lock the whole registry for
225 // updating a machine's urls.
226 // however, to save the memory required for keeping a
227 // mutex (40 bytes) per machine, we do...
228 static inline void registry_machine_urls_lock(REGISTRY_MACHINE *m) {
230 pthread_mutex_lock(®istry.machine_urls_lock);
233 static inline void registry_machine_urls_unlock(REGISTRY_MACHINE *m) {
235 pthread_mutex_unlock(®istry.machine_urls_lock);
238 static inline void registry_log_lock(void) {
239 pthread_mutex_lock(®istry.log_lock);
242 static inline void registry_log_unlock(void) {
243 pthread_mutex_unlock(®istry.log_lock);
247 // ----------------------------------------------------------------------------
250 // parse a GUID and re-generated to be always lower case
251 // this is used as a protection against the variations of GUIDs
252 static inline int registry_regenerate_guid(const char *guid, char *result) {
254 if(unlikely(uuid_parse(guid, uuid) == -1)) {
255 info("Registry: GUID '%s' is not a valid GUID.", guid);
259 uuid_unparse_lower(uuid, result);
261 #ifdef NETDATA_INTERNAL_CHECKS
262 if(strcmp(guid, result))
263 info("Registry: source GUID '%s' and re-generated GUID '%s' differ!", guid, result);
264 #endif /* NETDATA_INTERNAL_CHECKS */
270 // make sure the names of the machines / URLs do not contain any tabs
271 // (which are used as our separator in the database files)
272 // and are properly trimmed (before and after)
273 static inline char *registry_fix_machine_name(char *name, size_t *len) {
274 char *s = name?name:"";
276 // skip leading spaces
277 while(*s && isspace(*s)) s++;
279 // make sure all spaces are a SPACE
282 if(unlikely(isspace(*t)))
288 // remove trailing spaces
303 static inline char *registry_fix_url(char *url, size_t *len) {
304 return registry_fix_machine_name(url, len);
308 // ----------------------------------------------------------------------------
309 // forward definition of functions
311 extern REGISTRY_PERSON *registry_request_access(char *person_guid, char *machine_guid, char *url, char *name, time_t when);
312 extern REGISTRY_PERSON *registry_request_delete(char *person_guid, char *machine_guid, char *url, char *delete_url, time_t when);
315 // ----------------------------------------------------------------------------
318 static inline REGISTRY_URL *registry_url_allocate_nolock(const char *url, size_t urllen) {
319 // protection from too big URLs
320 if(urllen > registry.max_url_length)
321 urllen = registry.max_url_length;
323 debug(D_REGISTRY, "Registry: registry_url_allocate_nolock('%s'): allocating %zu bytes", url, sizeof(REGISTRY_URL) + urllen);
324 REGISTRY_URL *u = mallocz(sizeof(REGISTRY_URL) + urllen);
326 // a simple strcpy() should do the job
327 // but I prefer to be safe, since the caller specified urllen
328 u->len = (uint16_t)urllen;
329 strncpyz(u->url, url, u->len);
332 registry.urls_memory += sizeof(REGISTRY_URL) + urllen;
334 debug(D_REGISTRY, "Registry: registry_url_allocate_nolock('%s'): indexing it", url);
335 dictionary_set(registry.urls, u->url, u, sizeof(REGISTRY_URL));
340 static inline REGISTRY_URL *registry_url_get_nolock(const char *url, size_t urllen) {
341 debug(D_REGISTRY, "Registry: registry_url_get_nolock('%s')", url);
343 REGISTRY_URL *u = dictionary_get(registry.urls, url);
345 u = registry_url_allocate_nolock(url, urllen);
346 registry.urls_count++;
352 static inline REGISTRY_URL *registry_url_get(const char *url, size_t urllen) {
353 debug(D_REGISTRY, "Registry: registry_url_get('%s')", url);
355 registry_urls_lock();
357 REGISTRY_URL *u = registry_url_get_nolock(url, urllen);
359 registry_urls_unlock();
364 static inline void registry_url_link_nolock(REGISTRY_URL *u) {
366 debug(D_REGISTRY, "Registry: registry_url_link_nolock('%s'): URL has now %u links", u->url, u->links);
369 static inline void registry_url_unlink_nolock(REGISTRY_URL *u) {
372 debug(D_REGISTRY, "Registry: registry_url_unlink_nolock('%s'): No more links for this URL", u->url);
373 dictionary_del(registry.urls, u->url);
377 debug(D_REGISTRY, "Registry: registry_url_unlink_nolock('%s'): URL has %u links left", u->url, u->links);
381 // ----------------------------------------------------------------------------
384 static inline REGISTRY_MACHINE *registry_machine_find(const char *machine_guid) {
385 debug(D_REGISTRY, "Registry: registry_machine_find('%s')", machine_guid);
386 return dictionary_get(registry.machines, machine_guid);
389 static inline REGISTRY_MACHINE_URL *registry_machine_url_allocate(REGISTRY_MACHINE *m, REGISTRY_URL *u, time_t when) {
390 debug(D_REGISTRY, "registry_machine_link_to_url('%s', '%s'): allocating %zu bytes", m->guid, u->url, sizeof(REGISTRY_MACHINE_URL));
392 REGISTRY_MACHINE_URL *mu = mallocz(sizeof(REGISTRY_MACHINE_URL));
394 // mu->persons = dictionary_create(DICTIONARY_FLAGS);
395 // dictionary_set(mu->persons, p->guid, p, sizeof(PERSON));
397 mu->first_t = mu->last_t = (uint32_t)when;
400 mu->flags = REGISTRY_URL_FLAGS_DEFAULT;
402 registry.machines_urls_memory += sizeof(REGISTRY_MACHINE_URL);
404 debug(D_REGISTRY, "registry_machine_link_to_url('%s', '%s'): indexing URL in machine", m->guid, u->url);
405 dictionary_set(m->machine_urls, u->url, mu, sizeof(REGISTRY_MACHINE_URL));
406 registry_url_link_nolock(u);
411 static inline REGISTRY_MACHINE *registry_machine_allocate(const char *machine_guid, time_t when) {
412 debug(D_REGISTRY, "Registry: registry_machine_allocate('%s'): creating new machine, sizeof(MACHINE)=%zu", machine_guid, sizeof(REGISTRY_MACHINE));
414 REGISTRY_MACHINE *m = mallocz(sizeof(REGISTRY_MACHINE));
416 strncpyz(m->guid, machine_guid, GUID_LEN);
418 debug(D_REGISTRY, "Registry: registry_machine_allocate('%s'): creating dictionary of urls", machine_guid);
419 m->machine_urls = dictionary_create(DICTIONARY_FLAGS);
421 m->first_t = m->last_t = (uint32_t)when;
424 registry.machines_memory += sizeof(REGISTRY_MACHINE);
426 registry.machines_count++;
427 dictionary_set(registry.machines, m->guid, m, sizeof(REGISTRY_MACHINE));
432 // 1. validate machine GUID
433 // 2. if it is valid, find it or create it and return it
434 // 3. if it is not valid, return NULL
435 static inline REGISTRY_MACHINE *registry_machine_get(const char *machine_guid, time_t when) {
436 REGISTRY_MACHINE *m = NULL;
438 registry_machines_lock();
440 if(likely(machine_guid && *machine_guid)) {
441 // validate it is a GUID
442 char buf[GUID_LEN + 1];
443 if(unlikely(registry_regenerate_guid(machine_guid, buf) == -1))
444 info("Registry: machine guid '%s' is not a valid guid. Ignoring it.", machine_guid);
447 m = registry_machine_find(machine_guid);
448 if(!m) m = registry_machine_allocate(machine_guid, when);
452 registry_machines_unlock();
458 // ----------------------------------------------------------------------------
461 static inline REGISTRY_PERSON *registry_person_find(const char *person_guid) {
462 debug(D_REGISTRY, "Registry: registry_person_find('%s')", person_guid);
463 return dictionary_get(registry.persons, person_guid);
466 static inline REGISTRY_PERSON_URL *registry_person_url_allocate(REGISTRY_PERSON *p, REGISTRY_MACHINE *m, REGISTRY_URL *u, char *name, size_t namelen, time_t when) {
467 // protection from too big names
468 if(namelen > registry.max_name_length)
469 namelen = registry.max_name_length;
471 debug(D_REGISTRY, "registry_person_url_allocate('%s', '%s', '%s'): allocating %zu bytes", p->guid, m->guid, u->url,
472 sizeof(REGISTRY_PERSON_URL) + namelen);
474 REGISTRY_PERSON_URL *pu = mallocz(sizeof(REGISTRY_PERSON_URL) + namelen);
476 // a simple strcpy() should do the job
477 // but I prefer to be safe, since the caller specified urllen
478 strncpyz(pu->machine_name, name, namelen);
481 pu->first_t = pu->last_t = when;
484 pu->flags = REGISTRY_URL_FLAGS_DEFAULT;
487 registry.persons_urls_memory += sizeof(REGISTRY_PERSON_URL) + namelen;
489 debug(D_REGISTRY, "registry_person_url_allocate('%s', '%s', '%s'): indexing URL in person", p->guid, m->guid, u->url);
490 dictionary_set(p->person_urls, u->url, pu, sizeof(REGISTRY_PERSON_URL));
491 registry_url_link_nolock(u);
496 static inline REGISTRY_PERSON_URL *registry_person_url_reallocate(REGISTRY_PERSON *p, REGISTRY_MACHINE *m, REGISTRY_URL *u, char *name, size_t namelen, time_t when, REGISTRY_PERSON_URL *pu) {
497 // this function is needed to change the name of a PERSON_URL
499 debug(D_REGISTRY, "registry_person_url_reallocate('%s', '%s', '%s'): allocating %zu bytes", p->guid, m->guid, u->url,
500 sizeof(REGISTRY_PERSON_URL) + namelen);
502 REGISTRY_PERSON_URL *tpu = registry_person_url_allocate(p, m, u, name, namelen, when);
503 tpu->first_t = pu->first_t;
504 tpu->last_t = pu->last_t;
505 tpu->usages = pu->usages;
507 // ok, these are a hack - since the registry_person_url_allocate() is
508 // adding these, we have to subtract them
509 tpu->machine->links--;
510 registry.persons_urls_memory -= sizeof(REGISTRY_PERSON_URL) + strlen(pu->machine_name);
511 registry_url_unlink_nolock(u);
518 static inline REGISTRY_PERSON *registry_person_allocate(const char *person_guid, time_t when) {
519 REGISTRY_PERSON *p = NULL;
521 debug(D_REGISTRY, "Registry: registry_person_allocate('%s'): allocating new person, sizeof(PERSON)=%zu", (person_guid)?person_guid:"", sizeof(REGISTRY_PERSON));
523 p = mallocz(sizeof(REGISTRY_PERSON));
529 uuid_unparse_lower(uuid, p->guid);
531 debug(D_REGISTRY, "Registry: Checking if the generated person guid '%s' is unique", p->guid);
532 if (!dictionary_get(registry.persons, p->guid)) {
533 debug(D_REGISTRY, "Registry: generated person guid '%s' is unique", p->guid);
537 info("Registry: generated person guid '%s' found in the registry. Retrying...", p->guid);
541 strncpyz(p->guid, person_guid, GUID_LEN);
543 debug(D_REGISTRY, "Registry: registry_person_allocate('%s'): creating dictionary of urls", p->guid);
544 p->person_urls = dictionary_create(DICTIONARY_FLAGS);
546 p->first_t = p->last_t = when;
549 registry.persons_memory += sizeof(REGISTRY_PERSON);
551 registry.persons_count++;
552 dictionary_set(registry.persons, p->guid, p, sizeof(REGISTRY_PERSON));
558 // 1. validate person GUID
559 // 2. if it is valid, find it
560 // 3. if it is not valid, create a new one
562 static inline REGISTRY_PERSON *registry_person_get(const char *person_guid, time_t when) {
563 REGISTRY_PERSON *p = NULL;
565 registry_persons_lock();
567 if(person_guid && *person_guid) {
568 char buf[GUID_LEN + 1];
569 // validate it is a GUID
570 if(unlikely(registry_regenerate_guid(person_guid, buf) == -1))
571 info("Registry: person guid '%s' is not a valid guid. Ignoring it.", person_guid);
574 p = registry_person_find(person_guid);
578 if(!p) p = registry_person_allocate(NULL, when);
580 registry_persons_unlock();
585 // ----------------------------------------------------------------------------
586 // LINKING OF OBJECTS
588 static inline REGISTRY_PERSON_URL *registry_person_link_to_url(REGISTRY_PERSON *p, REGISTRY_MACHINE *m, REGISTRY_URL *u, char *name, size_t namelen, time_t when) {
589 debug(D_REGISTRY, "registry_person_link_to_url('%s', '%s', '%s'): searching for URL in person", p->guid, m->guid, u->url);
591 registry_person_urls_lock(p);
593 REGISTRY_PERSON_URL *pu = dictionary_get(p->person_urls, u->url);
595 debug(D_REGISTRY, "registry_person_link_to_url('%s', '%s', '%s'): not found", p->guid, m->guid, u->url);
596 pu = registry_person_url_allocate(p, m, u, name, namelen, when);
597 registry.persons_urls_count++;
600 debug(D_REGISTRY, "registry_person_link_to_url('%s', '%s', '%s'): found", p->guid, m->guid, u->url);
602 if(likely(pu->last_t < (uint32_t)when)) pu->last_t = when;
604 if(pu->machine != m) {
605 REGISTRY_MACHINE_URL *mu = dictionary_get(pu->machine->machine_urls, u->url);
607 info("registry_person_link_to_url('%s', '%s', '%s'): URL switched machines (old was '%s') - expiring it from previous machine.",
608 p->guid, m->guid, u->url, pu->machine->guid);
609 mu->flags |= REGISTRY_URL_FLAGS_EXPIRED;
612 info("registry_person_link_to_url('%s', '%s', '%s'): URL switched machines (old was '%s') - but the URL is not linked to the old machine.",
613 p->guid, m->guid, u->url, pu->machine->guid);
616 pu->machine->links--;
620 if(strcmp(pu->machine_name, name)) {
621 // the name of the PERSON_URL has changed !
622 pu = registry_person_url_reallocate(p, m, u, name, namelen, when, pu);
627 if(likely(p->last_t < (uint32_t)when)) p->last_t = when;
629 if(pu->flags & REGISTRY_URL_FLAGS_EXPIRED) {
630 info("registry_person_link_to_url('%s', '%s', '%s'): accessing an expired URL. Re-enabling URL.", p->guid, m->guid, u->url);
631 pu->flags &= ~REGISTRY_URL_FLAGS_EXPIRED;
634 registry_person_urls_unlock(p);
639 static inline REGISTRY_MACHINE_URL *registry_machine_link_to_url(REGISTRY_PERSON *p, REGISTRY_MACHINE *m, REGISTRY_URL *u, time_t when) {
640 debug(D_REGISTRY, "registry_machine_link_to_url('%s', '%s', '%s'): searching for URL in machine", p->guid, m->guid, u->url);
642 registry_machine_urls_lock(m);
644 REGISTRY_MACHINE_URL *mu = dictionary_get(m->machine_urls, u->url);
646 debug(D_REGISTRY, "registry_machine_link_to_url('%s', '%s', '%s'): not found", p->guid, m->guid, u->url);
647 mu = registry_machine_url_allocate(m, u, when);
648 registry.machines_urls_count++;
651 debug(D_REGISTRY, "registry_machine_link_to_url('%s', '%s', '%s'): found", p->guid, m->guid, u->url);
653 if(likely(mu->last_t < (uint32_t)when)) mu->last_t = when;
656 //debug(D_REGISTRY, "registry_machine_link_to_url('%s', '%s', '%s'): indexing person in machine", p->guid, m->guid, u->url);
657 //dictionary_set(mu->persons, p->guid, p, sizeof(PERSON));
660 if(likely(m->last_t < (uint32_t)when)) m->last_t = when;
662 if(mu->flags & REGISTRY_URL_FLAGS_EXPIRED) {
663 info("registry_machine_link_to_url('%s', '%s', '%s'): accessing an expired URL.", p->guid, m->guid, u->url);
664 mu->flags &= ~REGISTRY_URL_FLAGS_EXPIRED;
667 registry_machine_urls_unlock(m);
672 // ----------------------------------------------------------------------------
673 // REGISTRY LOG LOAD/SAVE
675 static inline int registry_should_save_db(void) {
676 debug(D_REGISTRY, "log entries %llu, max %llu", registry.log_count, registry.save_registry_every_entries);
677 return registry.log_count > registry.save_registry_every_entries;
680 static inline void registry_log(const char action, REGISTRY_PERSON *p, REGISTRY_MACHINE *m, REGISTRY_URL *u, char *name) {
681 if(likely(registry.log_fp)) {
682 // we lock only if the file is open
683 // to allow replaying the log at registry_log_load()
686 if(unlikely(fprintf(registry.log_fp, "%c\t%08x\t%s\t%s\t%s\t%s\n",
693 error("Registry: failed to save log. Registry data may be lost in case of abnormal restart.");
695 // we increase the counter even on failures
696 // so that the registry will be saved periodically
697 registry.log_count++;
699 registry_log_unlock();
701 // this must be outside the log_lock(), or a deadlock will happen.
702 // registry_save() checks the same inside the log_lock, so only
703 // one thread will save the db
704 if(unlikely(registry_should_save_db()))
709 static inline int registry_log_open_nolock(void) {
711 fclose(registry.log_fp);
713 registry.log_fp = fopen(registry.log_filename, "a");
715 if(registry.log_fp) {
716 if (setvbuf(registry.log_fp, NULL, _IOLBF, 0) != 0)
717 error("Cannot set line buffering on registry log file.");
721 error("Cannot open registry log file '%s'. Registry data will be lost in case of netdata or server crash.", registry.log_filename);
725 static inline void registry_log_close_nolock(void) {
726 if(registry.log_fp) {
727 fclose(registry.log_fp);
728 registry.log_fp = NULL;
732 static inline void registry_log_recreate_nolock(void) {
733 if(registry.log_fp != NULL) {
734 registry_log_close_nolock();
736 // open it with truncate
737 registry.log_fp = fopen(registry.log_filename, "w");
738 if(registry.log_fp) fclose(registry.log_fp);
739 else error("Cannot truncate registry log '%s'", registry.log_filename);
741 registry.log_fp = NULL;
743 registry_log_open_nolock();
747 int registry_log_load(void) {
750 // closing the log is required here
751 // otherwise we will append to it the values we read
752 registry_log_close_nolock();
754 debug(D_REGISTRY, "Registry: loading active db from: %s", registry.log_filename);
755 FILE *fp = fopen(registry.log_filename, "r");
757 error("Registry: cannot open registry file: %s", registry.log_filename);
759 char *s, buf[4096 + 1];
763 while ((s = fgets_trim_len(buf, 4096, fp, &len))) {
767 case 'A': // accesses
770 // verify it is valid
771 if (unlikely(len < 85 || s[1] != '\t' || s[10] != '\t' || s[47] != '\t' || s[84] != '\t')) {
772 error("Registry: log line %zd is wrong (len = %zu).", line, len);
775 s[1] = s[10] = s[47] = s[84] = '\0';
778 time_t when = strtoul(&s[2], NULL, 16);
779 char *person_guid = &s[11];
780 char *machine_guid = &s[48];
783 // skip the name to find the url
785 while(*url && *url != '\t') url++;
787 error("Registry: log line %zd does not have a url.", line);
792 // make sure the person exists
793 // without this, a new person guid will be created
794 REGISTRY_PERSON *p = registry_person_find(person_guid);
795 if(!p) p = registry_person_allocate(person_guid, when);
798 registry_request_access(p->guid, machine_guid, url, name, when);
800 registry_request_delete(p->guid, machine_guid, url, name, when);
802 registry.log_count++;
806 error("Registry: ignoring line %zd of filename '%s': %s.", line, registry.log_filename, s);
814 // open the log again
815 registry_log_open_nolock();
821 // ----------------------------------------------------------------------------
824 REGISTRY_PERSON *registry_request_access(char *person_guid, char *machine_guid, char *url, char *name, time_t when) {
825 debug(D_REGISTRY, "registry_request_access('%s', '%s', '%s'): NEW REQUEST", (person_guid)?person_guid:"", machine_guid, url);
827 REGISTRY_MACHINE *m = registry_machine_get(machine_guid, when);
830 // make sure the name is valid
832 name = registry_fix_machine_name(name, &namelen);
835 url = registry_fix_url(url, &urllen);
837 REGISTRY_URL *u = registry_url_get(url, urllen);
838 REGISTRY_PERSON *p = registry_person_get(person_guid, when);
840 registry_person_link_to_url(p, m, u, name, namelen, when);
841 registry_machine_link_to_url(p, m, u, when);
843 registry_log('A', p, m, u, name);
845 registry.usages_count++;
849 // verify the person, the machine and the URL exist in our DB
850 REGISTRY_PERSON_URL *registry_verify_request(char *person_guid, char *machine_guid, char *url, REGISTRY_PERSON **pp, REGISTRY_MACHINE **mm) {
851 char pbuf[GUID_LEN + 1], mbuf[GUID_LEN + 1];
853 if(!person_guid || !*person_guid || !machine_guid || !*machine_guid || !url || !*url) {
854 info("Registry Request Verification: invalid request! person: '%s', machine '%s', url '%s'", person_guid?person_guid:"UNSET", machine_guid?machine_guid:"UNSET", url?url:"UNSET");
859 url = registry_fix_url(url, NULL);
861 // make sure the person GUID is valid
862 if(registry_regenerate_guid(person_guid, pbuf) == -1) {
863 info("Registry Request Verification: invalid person GUID, person: '%s', machine '%s', url '%s'", person_guid, machine_guid, url);
868 // make sure the machine GUID is valid
869 if(registry_regenerate_guid(machine_guid, mbuf) == -1) {
870 info("Registry Request Verification: invalid machine GUID, person: '%s', machine '%s', url '%s'", person_guid, machine_guid, url);
875 // make sure the machine exists
876 REGISTRY_MACHINE *m = registry_machine_find(machine_guid);
878 info("Registry Request Verification: machine not found, person: '%s', machine '%s', url '%s'", person_guid, machine_guid, url);
883 // make sure the person exist
884 REGISTRY_PERSON *p = registry_person_find(person_guid);
886 info("Registry Request Verification: person not found, person: '%s', machine '%s', url '%s'", person_guid, machine_guid, url);
891 REGISTRY_PERSON_URL *pu = dictionary_get(p->person_urls, url);
893 info("Registry Request Verification: URL not found for person, person: '%s', machine '%s', url '%s'", person_guid, machine_guid, url);
899 REGISTRY_PERSON *registry_request_delete(char *person_guid, char *machine_guid, char *url, char *delete_url, time_t when) {
902 REGISTRY_PERSON *p = NULL;
903 REGISTRY_MACHINE *m = NULL;
904 REGISTRY_PERSON_URL *pu = registry_verify_request(person_guid, machine_guid, url, &p, &m);
905 if(!pu || !p || !m) return NULL;
908 delete_url = registry_fix_url(delete_url, NULL);
910 // make sure the user is not deleting the url it uses
911 if(!strcmp(delete_url, pu->url->url)) {
912 info("Registry Delete Request: delete URL is the one currently accessed, person: '%s', machine '%s', url '%s', delete url '%s'", p->guid, m->guid, pu->url->url, delete_url);
916 registry_person_urls_lock(p);
918 REGISTRY_PERSON_URL *dpu = dictionary_get(p->person_urls, delete_url);
920 info("Registry Delete Request: URL not found for person: '%s', machine '%s', url '%s', delete url '%s'", p->guid, m->guid, pu->url->url, delete_url);
921 registry_person_urls_unlock(p);
925 registry_log('D', p, m, pu->url, dpu->url->url);
927 dictionary_del(p->person_urls, dpu->url->url);
928 registry_url_unlink_nolock(dpu->url);
931 registry_person_urls_unlock(p);
936 // a structure to pass to the dictionary_get_all() callback handler
937 struct machine_request_callback_data {
938 REGISTRY_MACHINE *find_this_machine;
939 REGISTRY_PERSON_URL *result;
942 // the callback function
943 // this will be run for every PERSON_URL of this PERSON
944 int machine_request_callback(void *entry, void *data) {
945 REGISTRY_PERSON_URL *mypu = (REGISTRY_PERSON_URL *)entry;
946 struct machine_request_callback_data *myrdata = (struct machine_request_callback_data *)data;
948 if(mypu->machine == myrdata->find_this_machine) {
949 myrdata->result = mypu;
950 return -1; // this will also stop the walk through
953 return 0; // continue
956 REGISTRY_MACHINE *registry_request_machine(char *person_guid, char *machine_guid, char *url, char *request_machine, time_t when) {
959 char mbuf[GUID_LEN + 1];
961 REGISTRY_PERSON *p = NULL;
962 REGISTRY_MACHINE *m = NULL;
963 REGISTRY_PERSON_URL *pu = registry_verify_request(person_guid, machine_guid, url, &p, &m);
964 if(!pu || !p || !m) return NULL;
966 // make sure the machine GUID is valid
967 if(registry_regenerate_guid(request_machine, mbuf) == -1) {
968 info("Registry Machine URLs request: invalid machine GUID, person: '%s', machine '%s', url '%s', request machine '%s'", p->guid, m->guid, pu->url->url, request_machine);
971 request_machine = mbuf;
973 // make sure the machine exists
974 m = registry_machine_find(request_machine);
976 info("Registry Machine URLs request: machine not found, person: '%s', machine '%s', url '%s', request machine '%s'", p->guid, machine_guid, pu->url->url, request_machine);
980 // Verify the user has in the past accessed this machine
981 // We will walk through the PERSON_URLs to find the machine
982 // linking to our machine
984 // a structure to pass to the dictionary_get_all() callback handler
985 struct machine_request_callback_data rdata = { m, NULL };
987 // request a walk through on the dictionary
988 // no need for locking here, the underlying dictionary has its own
989 dictionary_get_all(p->person_urls, machine_request_callback, &rdata);
998 // ----------------------------------------------------------------------------
999 // REGISTRY JSON generation
1001 #define REGISTRY_STATUS_OK "ok"
1002 #define REGISTRY_STATUS_FAILED "failed"
1003 #define REGISTRY_STATUS_DISABLED "disabled"
1005 int registry_verify_cookies_redirects(void) {
1006 return registry.verify_cookies_redirects;
1009 const char *registry_to_announce(void) {
1010 return registry.registry_to_announce;
1013 void registry_set_cookie(struct web_client *w, const char *guid) {
1015 time_t et = now_realtime_sec() + registry.persons_expiration;
1016 struct tm etmbuf, *etm = gmtime_r(&et, &etmbuf);
1017 strftime(edate, sizeof(edate), "%a, %d %b %Y %H:%M:%S %Z", etm);
1019 snprintfz(w->cookie1, COOKIE_MAX, NETDATA_REGISTRY_COOKIE_NAME "=%s; Expires=%s", guid, edate);
1021 if(registry.registry_domain && registry.registry_domain[0])
1022 snprintfz(w->cookie2, COOKIE_MAX, NETDATA_REGISTRY_COOKIE_NAME "=%s; Domain=%s; Expires=%s", guid, registry.registry_domain, edate);
1025 static inline void registry_set_person_cookie(struct web_client *w, REGISTRY_PERSON *p) {
1026 registry_set_cookie(w, p->guid);
1029 static inline void registry_json_header(struct web_client *w, const char *action, const char *status) {
1030 buffer_flush(w->response.data);
1031 w->response.data->contenttype = CT_APPLICATION_JSON;
1032 buffer_sprintf(w->response.data, "{\n\t\"action\": \"%s\",\n\t\"status\": \"%s\",\n\t\"hostname\": \"%s\",\n\t\"machine_guid\": \"%s\"",
1033 action, status, registry.hostname, registry.machine_guid);
1036 static inline void registry_json_footer(struct web_client *w) {
1037 buffer_strcat(w->response.data, "\n}\n");
1040 int registry_request_hello_json(struct web_client *w) {
1041 registry_json_header(w, "hello", REGISTRY_STATUS_OK);
1043 buffer_sprintf(w->response.data, ",\n\t\"registry\": \"%s\"",
1044 registry.registry_to_announce);
1046 registry_json_footer(w);
1050 static inline int registry_json_disabled(struct web_client *w, const char *action) {
1051 registry_json_header(w, action, REGISTRY_STATUS_DISABLED);
1053 buffer_sprintf(w->response.data, ",\n\t\"registry\": \"%s\"",
1054 registry.registry_to_announce);
1056 registry_json_footer(w);
1060 // structure used be the callbacks below
1061 struct registry_json_walk_person_urls_callback {
1063 REGISTRY_MACHINE *m;
1064 struct web_client *w;
1068 // callback for rendering PERSON_URLs
1069 static inline int registry_json_person_url_callback(void *entry, void *data) {
1070 REGISTRY_PERSON_URL *pu = (REGISTRY_PERSON_URL *)entry;
1071 struct registry_json_walk_person_urls_callback *c = (struct registry_json_walk_person_urls_callback *)data;
1072 struct web_client *w = c->w;
1074 if(unlikely(c->count++))
1075 buffer_strcat(w->response.data, ",");
1077 buffer_sprintf(w->response.data, "\n\t\t[ \"%s\", \"%s\", %u000, %u, \"%s\" ]",
1078 pu->machine->guid, pu->url->url, pu->last_t, pu->usages, pu->machine_name);
1083 // callback for rendering MACHINE_URLs
1084 static inline int registry_json_machine_url_callback(void *entry, void *data) {
1085 REGISTRY_MACHINE_URL *mu = (REGISTRY_MACHINE_URL *)entry;
1086 struct registry_json_walk_person_urls_callback *c = (struct registry_json_walk_person_urls_callback *)data;
1087 struct web_client *w = c->w;
1088 REGISTRY_MACHINE *m = c->m;
1090 if(unlikely(c->count++))
1091 buffer_strcat(w->response.data, ",");
1093 buffer_sprintf(w->response.data, "\n\t\t[ \"%s\", \"%s\", %u000, %u ]",
1094 m->guid, mu->url->url, mu->last_t, mu->usages);
1100 // the main method for registering an access
1101 int registry_request_access_json(struct web_client *w, char *person_guid, char *machine_guid, char *url, char *name, time_t when) {
1102 if(!registry.enabled)
1103 return registry_json_disabled(w, "access");
1105 REGISTRY_PERSON *p = registry_request_access(person_guid, machine_guid, url, name, when);
1107 registry_json_header(w, "access", REGISTRY_STATUS_FAILED);
1108 registry_json_footer(w);
1113 registry_set_person_cookie(w, p);
1115 // generate the response
1116 registry_json_header(w, "access", REGISTRY_STATUS_OK);
1118 buffer_sprintf(w->response.data, ",\n\t\"person_guid\": \"%s\",\n\t\"urls\": [", p->guid);
1119 struct registry_json_walk_person_urls_callback c = { p, NULL, w, 0 };
1120 dictionary_get_all(p->person_urls, registry_json_person_url_callback, &c);
1121 buffer_strcat(w->response.data, "\n\t]\n");
1123 registry_json_footer(w);
1127 // the main method for deleting a URL from a person
1128 int registry_request_delete_json(struct web_client *w, char *person_guid, char *machine_guid, char *url, char *delete_url, time_t when) {
1129 if(!registry.enabled)
1130 return registry_json_disabled(w, "delete");
1132 REGISTRY_PERSON *p = registry_request_delete(person_guid, machine_guid, url, delete_url, when);
1134 registry_json_header(w, "delete", REGISTRY_STATUS_FAILED);
1135 registry_json_footer(w);
1139 // generate the response
1140 registry_json_header(w, "delete", REGISTRY_STATUS_OK);
1141 registry_json_footer(w);
1145 // the main method for searching the URLs of a netdata
1146 int registry_request_search_json(struct web_client *w, char *person_guid, char *machine_guid, char *url, char *request_machine, time_t when) {
1147 if(!registry.enabled)
1148 return registry_json_disabled(w, "search");
1150 REGISTRY_MACHINE *m = registry_request_machine(person_guid, machine_guid, url, request_machine, when);
1152 registry_json_header(w, "search", REGISTRY_STATUS_FAILED);
1153 registry_json_footer(w);
1157 registry_json_header(w, "search", REGISTRY_STATUS_OK);
1159 buffer_strcat(w->response.data, ",\n\t\"urls\": [");
1160 struct registry_json_walk_person_urls_callback c = { NULL, m, w, 0 };
1161 dictionary_get_all(m->machine_urls, registry_json_machine_url_callback, &c);
1162 buffer_strcat(w->response.data, "\n\t]\n");
1164 registry_json_footer(w);
1168 // structure used be the callbacks below
1169 struct registry_person_url_callback_verify_machine_exists_data {
1170 REGISTRY_MACHINE *m;
1174 int registry_person_url_callback_verify_machine_exists(void *entry, void *data) {
1175 struct registry_person_url_callback_verify_machine_exists_data *d = (struct registry_person_url_callback_verify_machine_exists_data *)data;
1176 REGISTRY_PERSON_URL *pu = (REGISTRY_PERSON_URL *)entry;
1177 REGISTRY_MACHINE *m = d->m;
1179 if(pu->machine == m)
1185 // the main method for switching user identity
1186 int registry_request_switch_json(struct web_client *w, char *person_guid, char *machine_guid, char *url, char *new_person_guid, time_t when) {
1190 if(!registry.enabled)
1191 return registry_json_disabled(w, "switch");
1193 REGISTRY_PERSON *op = registry_person_find(person_guid);
1195 registry_json_header(w, "switch", REGISTRY_STATUS_FAILED);
1196 registry_json_footer(w);
1200 REGISTRY_PERSON *np = registry_person_find(new_person_guid);
1202 registry_json_header(w, "switch", REGISTRY_STATUS_FAILED);
1203 registry_json_footer(w);
1207 REGISTRY_MACHINE *m = registry_machine_find(machine_guid);
1209 registry_json_header(w, "switch", REGISTRY_STATUS_FAILED);
1210 registry_json_footer(w);
1214 struct registry_person_url_callback_verify_machine_exists_data data = { m, 0 };
1216 // verify the old person has access to this machine
1217 dictionary_get_all(op->person_urls, registry_person_url_callback_verify_machine_exists, &data);
1219 registry_json_header(w, "switch", REGISTRY_STATUS_FAILED);
1220 registry_json_footer(w);
1224 // verify the new person has access to this machine
1226 dictionary_get_all(np->person_urls, registry_person_url_callback_verify_machine_exists, &data);
1228 registry_json_header(w, "switch", REGISTRY_STATUS_FAILED);
1229 registry_json_footer(w);
1233 // set the cookie of the new person
1234 // the user just switched identity
1235 registry_set_person_cookie(w, np);
1237 // generate the response
1238 registry_json_header(w, "switch", REGISTRY_STATUS_OK);
1239 buffer_sprintf(w->response.data, ",\n\t\"person_guid\": \"%s\"", np->guid);
1240 registry_json_footer(w);
1245 // ----------------------------------------------------------------------------
1246 // REGISTRY THIS MACHINE UNIQUE ID
1248 static inline int is_machine_guid_blacklisted(const char *guid) {
1249 // these are machine GUIDs that have been included in distribution packages.
1250 // we blacklist them here, so that the next version of netdata will generate
1253 if(!strcmp(guid, "8a795b0c-2311-11e6-8563-000c295076a6")
1254 || !strcmp(guid, "4aed1458-1c3e-11e6-a53f-000c290fc8f5")
1256 error("Blacklisted machine GUID '%s' found.", guid);
1263 char *registry_get_this_machine_guid(void) {
1264 if(likely(registry.machine_guid[0]))
1265 return registry.machine_guid;
1267 // read it from disk
1268 int fd = open(registry.machine_guid_filename, O_RDONLY);
1270 char buf[GUID_LEN + 1];
1271 if(read(fd, buf, GUID_LEN) != GUID_LEN)
1272 error("Failed to read machine GUID from '%s'", registry.machine_guid_filename);
1274 buf[GUID_LEN] = '\0';
1275 if(registry_regenerate_guid(buf, registry.machine_guid) == -1) {
1276 error("Failed to validate machine GUID '%s' from '%s'. Ignoring it - this might mean this netdata will appear as duplicate in the registry.",
1277 buf, registry.machine_guid_filename);
1279 registry.machine_guid[0] = '\0';
1281 else if(is_machine_guid_blacklisted(registry.machine_guid))
1282 registry.machine_guid[0] = '\0';
1287 // generate a new one?
1288 if(!registry.machine_guid[0]) {
1291 uuid_generate_time(uuid);
1292 uuid_unparse_lower(uuid, registry.machine_guid);
1293 registry.machine_guid[GUID_LEN] = '\0';
1296 fd = open(registry.machine_guid_filename, O_WRONLY|O_CREAT|O_TRUNC, 444);
1298 fatal("Cannot create unique machine id file '%s'. Please fix this.", registry.machine_guid_filename);
1300 if(write(fd, registry.machine_guid, GUID_LEN) != GUID_LEN)
1301 fatal("Cannot write the unique machine id file '%s'. Please fix this.", registry.machine_guid_filename);
1306 setenv("NETDATA_REGISTRY_UNIQUE_ID", registry.machine_guid, 1);
1308 return registry.machine_guid;
1312 // ----------------------------------------------------------------------------
1313 // REGISTRY LOAD/SAVE
1315 int registry_machine_save_url(void *entry, void *file) {
1316 REGISTRY_MACHINE_URL *mu = entry;
1319 debug(D_REGISTRY, "Registry: registry_machine_save_url('%s')", mu->url->url);
1321 int ret = fprintf(fp, "V\t%08x\t%08x\t%08x\t%02x\t%s\n",
1329 // error handling is done at registry_save()
1334 int registry_machine_save(void *entry, void *file) {
1335 REGISTRY_MACHINE *m = entry;
1338 debug(D_REGISTRY, "Registry: registry_machine_save('%s')", m->guid);
1340 int ret = fprintf(fp, "M\t%08x\t%08x\t%08x\t%s\n",
1348 int ret2 = dictionary_get_all(m->machine_urls, registry_machine_save_url, fp);
1349 if(ret2 < 0) return ret2;
1353 // error handling is done at registry_save()
1358 static inline int registry_person_save_url(void *entry, void *file) {
1359 REGISTRY_PERSON_URL *pu = entry;
1362 debug(D_REGISTRY, "Registry: registry_person_save_url('%s')", pu->url->url);
1364 int ret = fprintf(fp, "U\t%08x\t%08x\t%08x\t%02x\t%s\t%s\t%s\n",
1374 // error handling is done at registry_save()
1379 static inline int registry_person_save(void *entry, void *file) {
1380 REGISTRY_PERSON *p = entry;
1383 debug(D_REGISTRY, "Registry: registry_person_save('%s')", p->guid);
1385 int ret = fprintf(fp, "P\t%08x\t%08x\t%08x\t%s\n",
1393 int ret2 = dictionary_get_all(p->person_urls, registry_person_save_url, fp);
1394 if (ret2 < 0) return ret2;
1398 // error handling is done at registry_save()
1403 int registry_save(void) {
1404 if(!registry.enabled) return -1;
1406 // make sure the log is not updated
1407 registry_log_lock();
1409 if(unlikely(!registry_should_save_db())) {
1410 registry_log_unlock();
1414 error_log_limit_unlimited();
1416 char tmp_filename[FILENAME_MAX + 1];
1417 char old_filename[FILENAME_MAX + 1];
1419 snprintfz(old_filename, FILENAME_MAX, "%s.old", registry.db_filename);
1420 snprintfz(tmp_filename, FILENAME_MAX, "%s.tmp", registry.db_filename);
1422 debug(D_REGISTRY, "Registry: Creating file '%s'", tmp_filename);
1423 FILE *fp = fopen(tmp_filename, "w");
1425 error("Registry: Cannot create file: %s", tmp_filename);
1426 registry_log_unlock();
1427 error_log_limit_reset();
1431 // dictionary_get_all() has its own locking, so this is safe to do
1433 debug(D_REGISTRY, "Saving all machines");
1434 int bytes1 = dictionary_get_all(registry.machines, registry_machine_save, fp);
1436 error("Registry: Cannot save registry machines - return value %d", bytes1);
1438 registry_log_unlock();
1439 error_log_limit_reset();
1442 debug(D_REGISTRY, "Registry: saving machines took %d bytes", bytes1);
1444 debug(D_REGISTRY, "Saving all persons");
1445 int bytes2 = dictionary_get_all(registry.persons, registry_person_save, fp);
1447 error("Registry: Cannot save registry persons - return value %d", bytes2);
1449 registry_log_unlock();
1450 error_log_limit_reset();
1453 debug(D_REGISTRY, "Registry: saving persons took %d bytes", bytes2);
1456 fprintf(fp, "T\t%016llx\t%016llx\t%016llx\t%016llx\t%016llx\t%016llx\n",
1457 registry.persons_count,
1458 registry.machines_count,
1459 registry.usages_count + 1, // this is required - it is lost on db rotation
1460 registry.urls_count,
1461 registry.persons_urls_count,
1462 registry.machines_urls_count
1469 // remove the .old db
1470 debug(D_REGISTRY, "Registry: Removing old db '%s'", old_filename);
1471 if(unlink(old_filename) == -1 && errno != ENOENT)
1472 error("Registry: cannot remove old registry file '%s'", old_filename);
1474 // rename the db to .old
1475 debug(D_REGISTRY, "Registry: Link current db '%s' to .old: '%s'", registry.db_filename, old_filename);
1476 if(link(registry.db_filename, old_filename) == -1 && errno != ENOENT)
1477 error("Registry: cannot move file '%s' to '%s'. Saving registry DB failed!", registry.db_filename, old_filename);
1480 // remove the database (it is saved in .old)
1481 debug(D_REGISTRY, "Registry: removing db '%s'", registry.db_filename);
1482 if (unlink(registry.db_filename) == -1 && errno != ENOENT)
1483 error("Registry: cannot remove old registry file '%s'", registry.db_filename);
1485 // move the .tmp to make it active
1486 debug(D_REGISTRY, "Registry: linking tmp db '%s' to active db '%s'", tmp_filename, registry.db_filename);
1487 if (link(tmp_filename, registry.db_filename) == -1) {
1488 error("Registry: cannot move file '%s' to '%s'. Saving registry DB failed!", tmp_filename,
1489 registry.db_filename);
1491 // move the .old back
1492 debug(D_REGISTRY, "Registry: linking old db '%s' to active db '%s'", old_filename, registry.db_filename);
1493 if(link(old_filename, registry.db_filename) == -1)
1494 error("Registry: cannot move file '%s' to '%s'. Recovering the old registry DB failed!", old_filename, registry.db_filename);
1497 debug(D_REGISTRY, "Registry: removing tmp db '%s'", tmp_filename);
1498 if(unlink(tmp_filename) == -1)
1499 error("Registry: cannot remove tmp registry file '%s'", tmp_filename);
1501 // it has been moved successfully
1502 // discard the current registry log
1503 registry_log_recreate_nolock();
1504 registry.log_count = 0;
1508 // continue operations
1509 registry_log_unlock();
1510 error_log_limit_reset();
1515 static inline size_t registry_load(void) {
1516 char *s, buf[4096 + 1];
1517 REGISTRY_PERSON *p = NULL;
1518 REGISTRY_MACHINE *m = NULL;
1519 REGISTRY_URL *u = NULL;
1522 debug(D_REGISTRY, "Registry: loading active db from: '%s'", registry.db_filename);
1523 FILE *fp = fopen(registry.db_filename, "r");
1525 error("Registry: cannot open registry file: '%s'", registry.db_filename);
1531 while((s = fgets_trim_len(buf, 4096, fp, &len))) {
1534 debug(D_REGISTRY, "Registry: read line %zu to length %zu: %s", line, len, s);
1537 if(unlikely(len != 103 || s[1] != '\t' || s[18] != '\t' || s[35] != '\t' || s[52] != '\t' || s[69] != '\t' || s[86] != '\t' || s[103] != '\0')) {
1538 error("Registry totals line %zu is wrong (len = %zu).", line, len);
1541 registry.persons_count = strtoull(&s[2], NULL, 16);
1542 registry.machines_count = strtoull(&s[19], NULL, 16);
1543 registry.usages_count = strtoull(&s[36], NULL, 16);
1544 registry.urls_count = strtoull(&s[53], NULL, 16);
1545 registry.persons_urls_count = strtoull(&s[70], NULL, 16);
1546 registry.machines_urls_count = strtoull(&s[87], NULL, 16);
1551 // verify it is valid
1552 if(unlikely(len != 65 || s[1] != '\t' || s[10] != '\t' || s[19] != '\t' || s[28] != '\t' || s[65] != '\0')) {
1553 error("Registry person line %zu is wrong (len = %zu).", line, len);
1557 s[1] = s[10] = s[19] = s[28] = '\0';
1558 p = registry_person_allocate(&s[29], strtoul(&s[2], NULL, 16));
1559 p->last_t = strtoul(&s[11], NULL, 16);
1560 p->usages = strtoul(&s[20], NULL, 16);
1561 debug(D_REGISTRY, "Registry loaded person '%s', first: %u, last: %u, usages: %u", p->guid, p->first_t, p->last_t, p->usages);
1564 case 'M': // machine
1566 // verify it is valid
1567 if(unlikely(len != 65 || s[1] != '\t' || s[10] != '\t' || s[19] != '\t' || s[28] != '\t' || s[65] != '\0')) {
1568 error("Registry person line %zu is wrong (len = %zu).", line, len);
1572 s[1] = s[10] = s[19] = s[28] = '\0';
1573 m = registry_machine_allocate(&s[29], strtoul(&s[2], NULL, 16));
1574 m->last_t = strtoul(&s[11], NULL, 16);
1575 m->usages = strtoul(&s[20], NULL, 16);
1576 debug(D_REGISTRY, "Registry loaded machine '%s', first: %u, last: %u, usages: %u", m->guid, m->first_t, m->last_t, m->usages);
1579 case 'U': // person URL
1581 error("Registry: ignoring line %zu, no person loaded: %s", line, s);
1585 // verify it is valid
1586 if(len < 69 || s[1] != '\t' || s[10] != '\t' || s[19] != '\t' || s[28] != '\t' || s[31] != '\t' || s[68] != '\t') {
1587 error("Registry person URL line %zu is wrong (len = %zu).", line, len);
1591 s[1] = s[10] = s[19] = s[28] = s[31] = s[68] = '\0';
1593 // skip the name to find the url
1595 while(*url && *url != '\t') url++;
1597 error("Registry person URL line %zu does not have a url.", line);
1602 // u = registry_url_allocate_nolock(url, strlen(url));
1603 u = registry_url_get_nolock(url, strlen(url));
1605 time_t first_t = strtoul(&s[2], NULL, 16);
1607 m = registry_machine_find(&s[32]);
1608 if(!m) m = registry_machine_allocate(&s[32], first_t);
1610 REGISTRY_PERSON_URL *pu = registry_person_url_allocate(p, m, u, &s[69], strlen(&s[69]), first_t);
1611 pu->last_t = strtoul(&s[11], NULL, 16);
1612 pu->usages = strtoul(&s[20], NULL, 16);
1613 pu->flags = strtoul(&s[29], NULL, 16);
1614 debug(D_REGISTRY, "Registry loaded person URL '%s' with name '%s' of machine '%s', first: %u, last: %u, usages: %u, flags: %02x", u->url, pu->machine_name, m->guid, pu->first_t, pu->last_t, pu->usages, pu->flags);
1617 case 'V': // machine URL
1619 error("Registry: ignoring line %zu, no machine loaded: %s", line, s);
1623 // verify it is valid
1624 if(len < 32 || s[1] != '\t' || s[10] != '\t' || s[19] != '\t' || s[28] != '\t' || s[31] != '\t') {
1625 error("Registry person URL line %zu is wrong (len = %zu).", line, len);
1629 s[1] = s[10] = s[19] = s[28] = s[31] = '\0';
1630 // u = registry_url_allocate_nolock(&s[32], strlen(&s[32]));
1631 u = registry_url_get_nolock(&s[32], strlen(&s[32]));
1633 REGISTRY_MACHINE_URL *mu = registry_machine_url_allocate(m, u, strtoul(&s[2], NULL, 16));
1634 mu->last_t = strtoul(&s[11], NULL, 16);
1635 mu->usages = strtoul(&s[20], NULL, 16);
1636 mu->flags = strtoul(&s[29], NULL, 16);
1637 debug(D_REGISTRY, "Registry loaded machine URL '%s', machine '%s', first: %u, last: %u, usages: %u, flags: %02x", u->url, m->guid, mu->first_t, mu->last_t, mu->usages, mu->flags);
1641 error("Registry: ignoring line %zu of filename '%s': %s.", line, registry.db_filename, s);
1650 // ----------------------------------------------------------------------------
1653 int registry_init(void) {
1654 char filename[FILENAME_MAX + 1];
1656 // registry enabled?
1657 registry.enabled = config_get_boolean("registry", "enabled", 0);
1660 registry.pathname = config_get("registry", "registry db directory", VARLIB_DIR "/registry");
1661 if(mkdir(registry.pathname, 0770) == -1 && errno != EEXIST)
1662 fatal("Cannot create directory '%s'.", registry.pathname);
1665 snprintfz(filename, FILENAME_MAX, "%s/netdata.public.unique.id", registry.pathname);
1666 registry.machine_guid_filename = config_get("registry", "netdata unique id file", filename);
1667 registry_get_this_machine_guid();
1669 snprintfz(filename, FILENAME_MAX, "%s/registry.db", registry.pathname);
1670 registry.db_filename = config_get("registry", "registry db file", filename);
1672 snprintfz(filename, FILENAME_MAX, "%s/registry-log.db", registry.pathname);
1673 registry.log_filename = config_get("registry", "registry log file", filename);
1675 // configuration options
1676 registry.save_registry_every_entries = config_get_number("registry", "registry save db every new entries", 1000000);
1677 registry.persons_expiration = config_get_number("registry", "registry expire idle persons days", 365) * 86400;
1678 registry.registry_domain = config_get("registry", "registry domain", "");
1679 registry.registry_to_announce = config_get("registry", "registry to announce", "https://registry.my-netdata.io");
1680 registry.hostname = config_get("registry", "registry hostname", config_get("global", "hostname", localhost.hostname));
1681 registry.verify_cookies_redirects = config_get_boolean("registry", "verify browser cookies support", 1);
1683 setenv("NETDATA_REGISTRY_HOSTNAME", registry.hostname, 1);
1684 setenv("NETDATA_REGISTRY_URL", registry.registry_to_announce, 1);
1686 registry.max_url_length = config_get_number("registry", "max URL length", 1024);
1687 if(registry.max_url_length < 10) {
1688 registry.max_url_length = 10;
1689 config_set_number("registry", "max URL length", registry.max_url_length);
1692 registry.max_name_length = config_get_number("registry", "max URL name length", 50);
1693 if(registry.max_name_length < 10) {
1694 registry.max_name_length = 10;
1695 config_set_number("registry", "max URL name length", registry.max_name_length);
1698 // initialize entries counters
1699 registry.persons_count = 0;
1700 registry.machines_count = 0;
1701 registry.usages_count = 0;
1702 registry.urls_count = 0;
1703 registry.persons_urls_count = 0;
1704 registry.machines_urls_count = 0;
1706 // initialize memory counters
1707 registry.persons_memory = 0;
1708 registry.machines_memory = 0;
1709 registry.urls_memory = 0;
1710 registry.persons_urls_memory = 0;
1711 registry.machines_urls_memory = 0;
1714 pthread_mutex_init(®istry.persons_lock, NULL);
1715 pthread_mutex_init(®istry.machines_lock, NULL);
1716 pthread_mutex_init(®istry.urls_lock, NULL);
1717 pthread_mutex_init(®istry.person_urls_lock, NULL);
1718 pthread_mutex_init(®istry.machine_urls_lock, NULL);
1720 // create dictionaries
1721 registry.persons = dictionary_create(DICTIONARY_FLAGS);
1722 registry.machines = dictionary_create(DICTIONARY_FLAGS);
1723 registry.urls = dictionary_create(DICTIONARY_FLAGS);
1725 // load the registry database
1726 if(registry.enabled) {
1727 registry_log_open_nolock();
1729 registry_log_load();
1731 if(unlikely(registry_should_save_db()))
1738 void registry_free(void) {
1739 if(!registry.enabled) return;
1741 // we need to destroy the dictionaries ourselves
1742 // since the dictionaries use memory we allocated
1744 while(registry.persons->values_index.root) {
1745 REGISTRY_PERSON *p = ((NAME_VALUE *)registry.persons->values_index.root)->value;
1747 // fprintf(stderr, "\nPERSON: '%s', first: %u, last: %u, usages: %u\n", p->guid, p->first_t, p->last_t, p->usages);
1749 while(p->person_urls->values_index.root) {
1750 REGISTRY_PERSON_URL *pu = ((NAME_VALUE *)p->person_urls->values_index.root)->value;
1752 // fprintf(stderr, "\tURL: '%s', first: %u, last: %u, usages: %u, flags: 0x%02x\n", pu->url->url, pu->first_t, pu->last_t, pu->usages, pu->flags);
1754 debug(D_REGISTRY, "Registry: deleting url '%s' from person '%s'", pu->url->url, p->guid);
1755 dictionary_del(p->person_urls, pu->url->url);
1757 debug(D_REGISTRY, "Registry: unlinking url '%s' from person", pu->url->url);
1758 registry_url_unlink_nolock(pu->url);
1760 debug(D_REGISTRY, "Registry: freeing person url");
1764 debug(D_REGISTRY, "Registry: deleting person '%s' from persons registry", p->guid);
1765 dictionary_del(registry.persons, p->guid);
1767 debug(D_REGISTRY, "Registry: destroying URL dictionary of person '%s'", p->guid);
1768 dictionary_destroy(p->person_urls);
1770 debug(D_REGISTRY, "Registry: freeing person '%s'", p->guid);
1774 while(registry.machines->values_index.root) {
1775 REGISTRY_MACHINE *m = ((NAME_VALUE *)registry.machines->values_index.root)->value;
1777 // fprintf(stderr, "\nMACHINE: '%s', first: %u, last: %u, usages: %u\n", m->guid, m->first_t, m->last_t, m->usages);
1779 while(m->machine_urls->values_index.root) {
1780 REGISTRY_MACHINE_URL *mu = ((NAME_VALUE *)m->machine_urls->values_index.root)->value;
1782 // fprintf(stderr, "\tURL: '%s', first: %u, last: %u, usages: %u, flags: 0x%02x\n", mu->url->url, mu->first_t, mu->last_t, mu->usages, mu->flags);
1784 //debug(D_REGISTRY, "Registry: destroying persons dictionary from url '%s'", mu->url->url);
1785 //dictionary_destroy(mu->persons);
1787 debug(D_REGISTRY, "Registry: deleting url '%s' from person '%s'", mu->url->url, m->guid);
1788 dictionary_del(m->machine_urls, mu->url->url);
1790 debug(D_REGISTRY, "Registry: unlinking url '%s' from machine", mu->url->url);
1791 registry_url_unlink_nolock(mu->url);
1793 debug(D_REGISTRY, "Registry: freeing machine url");
1797 debug(D_REGISTRY, "Registry: deleting machine '%s' from machines registry", m->guid);
1798 dictionary_del(registry.machines, m->guid);
1800 debug(D_REGISTRY, "Registry: destroying URL dictionary of machine '%s'", m->guid);
1801 dictionary_destroy(m->machine_urls);
1803 debug(D_REGISTRY, "Registry: freeing machine '%s'", m->guid);
1807 // and free the memory of remaining dictionary structures
1809 debug(D_REGISTRY, "Registry: destroying persons dictionary");
1810 dictionary_destroy(registry.persons);
1812 debug(D_REGISTRY, "Registry: destroying machines dictionary");
1813 dictionary_destroy(registry.machines);
1815 debug(D_REGISTRY, "Registry: destroying urls dictionary");
1816 dictionary_destroy(registry.urls);
1819 // ----------------------------------------------------------------------------
1822 void registry_statistics(void) {
1823 if(!registry.enabled) return;
1825 static RRDSET *sts = NULL, *stc = NULL, *stm = NULL;
1827 if(!sts) sts = rrdset_find("netdata.registry_sessions");
1829 sts = rrdset_create("netdata", "registry_sessions", NULL, "registry", NULL, "NetData Registry Sessions", "session", 131000, rrd_update_every, RRDSET_TYPE_LINE);
1831 rrddim_add(sts, "sessions", NULL, 1, 1, RRDDIM_ABSOLUTE);
1833 else rrdset_next(sts);
1835 rrddim_set(sts, "sessions", registry.usages_count);
1838 // ------------------------------------------------------------------------
1840 if(!stc) stc = rrdset_find("netdata.registry_entries");
1842 stc = rrdset_create("netdata", "registry_entries", NULL, "registry", NULL, "NetData Registry Entries", "entries", 131100, rrd_update_every, RRDSET_TYPE_LINE);
1844 rrddim_add(stc, "persons", NULL, 1, 1, RRDDIM_ABSOLUTE);
1845 rrddim_add(stc, "machines", NULL, 1, 1, RRDDIM_ABSOLUTE);
1846 rrddim_add(stc, "urls", NULL, 1, 1, RRDDIM_ABSOLUTE);
1847 rrddim_add(stc, "persons_urls", NULL, 1, 1, RRDDIM_ABSOLUTE);
1848 rrddim_add(stc, "machines_urls", NULL, 1, 1, RRDDIM_ABSOLUTE);
1850 else rrdset_next(stc);
1852 rrddim_set(stc, "persons", registry.persons_count);
1853 rrddim_set(stc, "machines", registry.machines_count);
1854 rrddim_set(stc, "urls", registry.urls_count);
1855 rrddim_set(stc, "persons_urls", registry.persons_urls_count);
1856 rrddim_set(stc, "machines_urls", registry.machines_urls_count);
1859 // ------------------------------------------------------------------------
1861 if(!stm) stm = rrdset_find("netdata.registry_mem");
1863 stm = rrdset_create("netdata", "registry_mem", NULL, "registry", NULL, "NetData Registry Memory", "KB", 131300, rrd_update_every, RRDSET_TYPE_STACKED);
1865 rrddim_add(stm, "persons", NULL, 1, 1024, RRDDIM_ABSOLUTE);
1866 rrddim_add(stm, "machines", NULL, 1, 1024, RRDDIM_ABSOLUTE);
1867 rrddim_add(stm, "urls", NULL, 1, 1024, RRDDIM_ABSOLUTE);
1868 rrddim_add(stm, "persons_urls", NULL, 1, 1024, RRDDIM_ABSOLUTE);
1869 rrddim_add(stm, "machines_urls", NULL, 1, 1024, RRDDIM_ABSOLUTE);
1871 else rrdset_next(stm);
1873 rrddim_set(stm, "persons", registry.persons_memory + registry.persons_count * sizeof(NAME_VALUE) + sizeof(DICTIONARY));
1874 rrddim_set(stm, "machines", registry.machines_memory + registry.machines_count * sizeof(NAME_VALUE) + sizeof(DICTIONARY));
1875 rrddim_set(stm, "urls", registry.urls_memory + registry.urls_count * sizeof(NAME_VALUE) + sizeof(DICTIONARY));
1876 rrddim_set(stm, "persons_urls", registry.persons_urls_memory + registry.persons_count * sizeof(DICTIONARY) + registry.persons_urls_count * sizeof(NAME_VALUE));
1877 rrddim_set(stm, "machines_urls", registry.machines_urls_memory + registry.machines_count * sizeof(DICTIONARY) + registry.machines_urls_count * sizeof(NAME_VALUE));