5 * Copyright (C) 2010 BMW Car IT GmbH. All rights reserved.
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
28 #include <sys/types.h>
38 #ifdef TEMP_FAILURE_RETRY
39 #define TFR TEMP_FAILURE_RETRY
44 #define MAGIC 0xFA00B916
47 * Statistics counters are stored into a ring buffer which is stored
51 * The ring buffer is mmap to a file
52 * Initialy only the smallest possible amount of disk space is allocated
53 * The files grow to the configured maximal size
54 * The grows by _SC_PAGESIZE step size
55 * For each service a file is created
56 * Each file has a header where the indexes are stored
59 * Each entry has a timestamp
60 * A flag to mark if the entry is either home (0) or roaming (1) entry
61 * The entries are fixed sized (stats_record)
63 * Ring buffer properties:
64 * There are to indexes 'begin', 'end', 'home' and 'roaming'
65 * 'begin' points to the oldest entry
66 * 'end' points to the newest/current entry
67 * 'home' points to the current home entry
68 * 'roaming' points to the current roaming entry
69 * If 'begin' == 'end' then the buffer is empty
70 * If 'end' + 1 == 'begin then it's full
71 * The ring buffer is valid in the range (begin, end]
72 * If 'home' has the value UINT_MAX', 'home' is invalid
73 * if 'roaming' has the value UINT_MAX', 'roaming' is invalid
74 * 'first' points to the first entry in the ring buffer
75 * 'last' points to the last entry in the ring buffer
78 * Same format as the ring buffer file
79 * For a period of at least 2 months dayly records are keept
80 * If older, then only a monthly record is keept
84 struct stats_file_header {
95 struct connman_stats_data data;
106 struct stats_record *first;
107 struct stats_record *last;
108 struct stats_record *home;
109 struct stats_record *roaming;
113 int account_period_offset;
117 struct stats_file *file;
118 struct stats_record *begin;
119 struct stats_record *end;
120 struct stats_record *it;
123 GHashTable *stats_hash = NULL;
125 static struct stats_file_header *get_hdr(struct stats_file *file)
127 return (struct stats_file_header *)file->addr;
130 static struct stats_record *get_begin(struct stats_file *file)
132 unsigned int off = get_hdr(file)->begin;
134 return (struct stats_record *)(file->addr + off);
137 static struct stats_record *get_end(struct stats_file *file)
139 unsigned int off = get_hdr(file)->end;
141 return (struct stats_record *)(file->addr + off);
144 static struct stats_record *get_home(struct stats_file *file)
146 struct stats_file_header *hdr;
150 if (hdr->home == UINT_MAX)
153 return (struct stats_record *)(file->addr + hdr->home);
156 static struct stats_record *get_roaming(struct stats_file *file)
158 struct stats_file_header *hdr;
162 if (hdr->roaming == UINT_MAX)
165 return (struct stats_record *)(file->addr + hdr->roaming);
168 static void set_end(struct stats_file *file, struct stats_record *end)
170 struct stats_file_header *hdr;
173 hdr->end = (char *)end - file->addr;
176 static void set_home(struct stats_file *file, struct stats_record *home)
178 struct stats_file_header *hdr;
181 hdr->home = (char *)home - file->addr;
184 static void set_roaming(struct stats_file *file, struct stats_record *roaming)
186 struct stats_file_header *hdr;
189 hdr->roaming = (char *)roaming - file->addr;
192 static struct stats_record *get_next(struct stats_file *file,
193 struct stats_record *cur)
197 if (cur > file->last)
203 static struct stats_record *get_iterator_begin(struct stats_file *file)
205 return get_next(file, get_begin(file));
208 static struct stats_record *get_iterator_end(struct stats_file *file)
210 return get_next(file, get_end(file));
213 static void stats_free(gpointer user_data)
215 struct stats_file *file = user_data;
220 msync(file->addr, file->len, MS_SYNC);
222 munmap(file->addr, file->len);
225 TFR(close(file->fd));
228 if (file->history_name != NULL) {
229 g_free(file->history_name);
230 file->history_name = NULL;
233 if (file->name != NULL) {
241 static void update_first(struct stats_file *file)
243 file->first = (struct stats_record *)
244 (file->addr + sizeof(struct stats_file_header));
247 static void update_last(struct stats_file *file)
249 unsigned int max_entries;
251 max_entries = (file->len - sizeof(struct stats_file_header)) /
252 sizeof(struct stats_record);
253 file->last = file->first + max_entries - 1;
256 static void update_home(struct stats_file *file)
258 file->home = get_home(file);
261 static void update_roaming(struct stats_file *file)
263 file->roaming = get_roaming(file);
266 static void stats_file_update_cache(struct stats_file *file)
271 update_roaming(file);
274 static int stats_file_remap(struct stats_file *file, size_t size)
276 size_t page_size, new_size;
280 DBG("file %p size %u addr %p len %u", file, size, file->addr,
283 page_size = sysconf(_SC_PAGESIZE);
284 new_size = (size + page_size - 1) & ~(page_size - 1);
286 err = ftruncate(file->fd, new_size);
288 connman_error("ftrunctate error %s for %s",
289 strerror(errno), file->name);
293 if (file->addr == NULL) {
295 * Though the buffer is not shared between processes, we still
296 * have to take MAP_SHARED because MAP_PRIVATE does not guarantee
297 * that writes will hit the file eventually. For more details
298 * please read the mmap man pages.
300 addr = mmap(NULL, new_size, PROT_READ | PROT_WRITE,
301 MAP_SHARED, file->fd, 0);
303 addr = mremap(file->addr, file->len, new_size, MREMAP_MAYMOVE);
306 if (addr == MAP_FAILED) {
307 connman_error("mmap error %s for %s",
308 strerror(errno), file->name);
313 file->len = new_size;
315 stats_file_update_cache(file);
320 static int stats_open(struct stats_file *file,
323 DBG("file %p name %s", file, name);
325 file->name = g_strdup(name);
327 file->fd = TFR(open(file->name, O_RDWR | O_CREAT, 0644));
329 connman_error("open error %s for %s",
330 strerror(errno), file->name);
339 static int stats_open_temp(struct stats_file *file)
341 file->name = g_strdup_printf("%s/stats/stats.XXXXXX.tmp",
343 file->fd = g_mkstemp_full(file->name, O_RDWR | O_CREAT, 0644);
345 connman_error("create tempory file error %s for %s",
346 strerror(errno), file->name);
355 static int stats_file_setup(struct stats_file *file)
357 struct stats_file_header *hdr;
362 DBG("file %p fd %d name %s", file, file->fd, file->name);
364 err = fstat(file->fd, &st);
366 connman_error("fstat error %s for %s\n",
367 strerror(errno), file->name);
369 TFR(close(file->fd));
376 size = (size_t)st.st_size;
377 file->max_len = STATS_MAX_FILE_SIZE;
379 if (size < (size_t)sysconf(_SC_PAGESIZE))
380 size = sysconf(_SC_PAGESIZE);
382 err = stats_file_remap(file, size);
384 TFR(close(file->fd));
393 if (hdr->magic != MAGIC ||
394 hdr->begin < sizeof(struct stats_file_header) ||
395 hdr->end < sizeof(struct stats_file_header) ||
396 hdr->home < sizeof(struct stats_file_header) ||
397 hdr->roaming < sizeof(struct stats_file_header) ||
398 hdr->begin > file->len ||
399 hdr->end > file->len) {
401 hdr->begin = sizeof(struct stats_file_header);
402 hdr->end = sizeof(struct stats_file_header);
403 hdr->home = UINT_MAX;
404 hdr->roaming = UINT_MAX;
406 stats_file_update_cache(file);
413 static struct stats_record *get_next_record(struct stats_iter *iter)
415 if (iter->it != iter->end) {
416 struct stats_record *tmp;
419 iter->it = get_next(iter->file, iter->it);
427 static int append_record(struct stats_file *file,
428 struct stats_record *rec)
430 struct stats_record *cur, *next;
433 if (file->last == get_end(file)) {
434 err = stats_file_remap(file, file->len +
435 sysconf(_SC_PAGESIZE));
439 stats_file_update_cache(file);
443 next = get_next(file, cur);
445 memcpy(next, rec, sizeof(struct stats_record));
452 static struct stats_record *process_file(struct stats_iter *iter,
453 struct stats_file *temp_file,
454 struct stats_record *cur,
455 GDate *date_change_step_size,
456 int account_period_offset)
458 struct stats_record *home, *roaming;
459 struct stats_record *next;
465 cur = get_next_record(iter);
466 next = get_next_record(iter);
468 while (next != NULL) {
475 if (cur->roaming == TRUE)
480 g_date_set_time_t(&date_cur, cur->ts);
481 g_date_set_time_t(&date_next, next->ts);
483 if (g_date_compare(&date_cur, date_change_step_size) < 0) {
484 /* month period size */
485 GDateDay day_cur, day_next;
486 GDateMonth month_cur, month_next;
488 month_cur = g_date_get_month(&date_cur);
489 month_next = g_date_get_month(&date_next);
491 day_cur = g_date_get_day(&date_cur);
492 day_next = g_date_get_day(&date_next);
494 if (day_cur == day_next && month_cur != month_next) {
496 } else if (day_cur < account_period_offset &&
497 day_next >= account_period_offset) {
501 /* day period size */
502 if (g_date_days_between(&date_cur, &date_next) > 0)
506 if (append == TRUE) {
508 append_record(temp_file, home);
512 if (roaming != NULL) {
513 append_record(temp_file, roaming);
519 next = get_next_record(iter);
525 static int summarize(struct stats_file *data_file,
526 struct stats_file *history_file,
527 struct stats_file *temp_file)
529 struct stats_iter data_iter;
530 struct stats_iter history_iter;
531 struct stats_record *cur, *next;
533 GDate today, date_change_step_size;
536 * First calculate the date when switch from monthly
537 * accounting period size to daily size
539 g_date_set_time_t(&today, time(NULL));
541 date_change_step_size = today;
542 if (g_date_get_day(&today) - data_file->account_period_offset >= 0)
543 g_date_subtract_months(&date_change_step_size, 2);
545 g_date_subtract_months(&date_change_step_size, 3);
547 g_date_set_day(&date_change_step_size,
548 data_file->account_period_offset);
551 /* Now process history file */
554 if (history_file != NULL) {
555 history_iter.file = history_file;
556 history_iter.begin = get_iterator_begin(history_iter.file);
557 history_iter.end = get_iterator_end(history_iter.file);
558 history_iter.it = history_iter.begin;
560 cur = process_file(&history_iter, temp_file, NULL,
561 &date_change_step_size,
562 data_file->account_period_offset);
565 data_iter.file = data_file;
566 data_iter.begin = get_iterator_begin(data_iter.file);
567 data_iter.end = get_iterator_end(data_iter.file);
568 data_iter.it = data_iter.begin;
571 * Ensure date_file records are newer than the history_file
575 next = get_next_record(&data_iter);
576 while (next != NULL && cur->ts > next->ts)
577 next = get_next_record(&data_iter);
580 /* And finally process the new data records */
581 cur = process_file(&data_iter, temp_file, cur,
582 &date_change_step_size,
583 data_file->account_period_offset);
586 append_record(temp_file, cur);
591 static void stats_file_unmap(struct stats_file *file)
593 msync(file->addr, file->len, MS_SYNC);
594 munmap(file->addr, file->len);
598 static void stats_file_cleanup(struct stats_file *file)
605 static int stats_file_close_swap(struct stats_file *history_file,
606 struct stats_file *temp_file)
610 stats_file_unmap(history_file);
611 stats_file_unmap(temp_file);
613 TFR(close(temp_file->fd));
615 unlink(history_file->name);
617 err = link(temp_file->name, history_file->name);
619 unlink(temp_file->name);
621 TFR(close(history_file->fd));
623 stats_file_cleanup(history_file);
624 stats_file_cleanup(temp_file);
629 static int stats_file_history_update(struct stats_file *data_file)
631 struct stats_file _history_file, *history_file;
632 struct stats_file _temp_file, *temp_file;
635 history_file = &_history_file;
636 temp_file = &_temp_file;
638 bzero(history_file, sizeof(struct stats_file));
639 bzero(temp_file, sizeof(struct stats_file));
641 err = stats_open(history_file, data_file->history_name);
644 stats_file_setup(history_file);
646 err = stats_open_temp(temp_file);
648 stats_free(history_file);
651 stats_file_setup(temp_file);
653 summarize(data_file, history_file, temp_file);
655 err = stats_file_close_swap(history_file, temp_file);
660 int __connman_stats_service_register(struct connman_service *service)
662 struct stats_file *file;
666 DBG("service %p", service);
668 file = g_hash_table_lookup(stats_hash, service);
670 file = g_try_new0(struct stats_file, 1);
674 g_hash_table_insert(stats_hash, service, file);
679 name = g_strdup_printf("%s/stats/%s.data", STORAGEDIR,
680 __connman_service_get_ident(service));
681 file->history_name = g_strdup_printf("%s/stats/%s.history", STORAGEDIR,
682 __connman_service_get_ident(service));
684 /* TODO: Use a global config file instead of hard coded value. */
685 file->account_period_offset = 1;
687 err = stats_open(file, name);
692 err = stats_file_setup(file);
699 g_hash_table_remove(stats_hash, service);
704 void __connman_stats_service_unregister(struct connman_service *service)
706 DBG("service %p", service);
708 g_hash_table_remove(stats_hash, service);
711 int __connman_stats_update(struct connman_service *service,
712 connman_bool_t roaming,
713 struct connman_stats_data *data)
715 struct stats_file *file;
716 struct stats_record *next;
719 file = g_hash_table_lookup(stats_hash, service);
723 if (file->len < file->max_len &&
724 file->last == get_end(file)) {
725 DBG("grow file %s", file->name);
727 err = stats_file_remap(file, file->len + sysconf(_SC_PAGESIZE));
732 next = get_next(file, get_end(file));
734 if (next == get_begin(file)) {
735 DBG("ring buffer is full, update history file");
737 if (stats_file_history_update(file) < 0) {
738 connman_warn("history file update failed %s",
743 next->ts = time(NULL);
744 next->roaming = roaming;
745 memcpy(&next->data, data, sizeof(struct connman_stats_data));
748 set_home(file, next);
750 set_roaming(file, next);
757 int __connman_stats_get(struct connman_service *service,
758 connman_bool_t roaming,
759 struct connman_stats_data *data)
761 struct stats_file *file;
762 struct stats_record *rec;
764 file = g_hash_table_lookup(stats_hash, service);
774 memcpy(data, &rec->data,
775 sizeof(struct connman_stats_data));
781 int __connman_stats_init(void)
785 stats_hash = g_hash_table_new_full(g_direct_hash, g_direct_equal,
791 void __connman_stats_cleanup(void)
795 g_hash_table_destroy(stats_hash);