src/stats.c

   1 /*
   2  *
   3  *  Connection Manager
   4  *
   5  *  Copyright (C) 2010  BMW Car IT GmbH. All rights reserved.
   6  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include <config.h>
  24 #endif
  25
  26 #define _GNU_SOURCE
  27 #include <sys/mman.h>
  28 #include <sys/types.h>
  29 #include <sys/stat.h>
  30 #include <sys/time.h>
  31 #include <fcntl.h>
  32 #include <unistd.h>
  33 #include <string.h>
  34 #include <limits.h>
  35
  36 #include "connman.h"
  37
  38 #ifdef TEMP_FAILURE_RETRY
  39 #define TFR TEMP_FAILURE_RETRY
  40 #else
  41 #define TFR
  42 #endif
  43
  44 #define MAGIC 0xFA00B916
  45
  46 /*
  47  * Statistics counters are stored into a ring buffer which is stored
  48  * into a file
  49  *
  50  * File properties:
  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
  57  *
  58  * Entries properties:
  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)
  62  *
  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
  76  *
  77  * History file:
  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
  81  */
  82
  83
  84 struct stats_file_header {
  85         unsigned int magic;
  86         unsigned int begin;
  87         unsigned int end;
  88         unsigned int home;
  89         unsigned int roaming;
  90 };
  91
  92 struct stats_record {
  93         time_t ts;
  94         unsigned int roaming;
  95         struct connman_stats_data data;
  96 };
  97
  98 struct stats_file {
  99         int fd;
 100         char *name;
 101         char *addr;
 102         size_t len;
 103         size_t max_len;
 104
 105         /* cached values */
 106         struct stats_record *first;
 107         struct stats_record *last;
 108         struct stats_record *home;
 109         struct stats_record *roaming;
 110
 111         /* history */
 112         char *history_name;
 113         int account_period_offset;
 114 };
 115
 116 struct stats_iter {
 117         struct stats_file *file;
 118         struct stats_record *begin;
 119         struct stats_record *end;
 120         struct stats_record *it;
 121 };
 122
 123 GHashTable *stats_hash = NULL;
 124
 125 static struct stats_file_header *get_hdr(struct stats_file *file)
 126 {
 127         return (struct stats_file_header *)file->addr;
 128 }
 129
 130 static struct stats_record *get_begin(struct stats_file *file)
 131 {
 132         unsigned int off = get_hdr(file)->begin;
 133
 134         return (struct stats_record *)(file->addr + off);
 135 }
 136
 137 static struct stats_record *get_end(struct stats_file *file)
 138 {
 139         unsigned int off = get_hdr(file)->end;
 140
 141         return (struct stats_record *)(file->addr + off);
 142 }
 143
 144 static struct stats_record *get_home(struct stats_file *file)
 145 {
 146         struct stats_file_header *hdr;
 147
 148         hdr = get_hdr(file);
 149
 150         if (hdr->home == UINT_MAX)
 151                 return NULL;
 152
 153         return (struct stats_record *)(file->addr + hdr->home);
 154 }
 155
 156 static struct stats_record *get_roaming(struct stats_file *file)
 157 {
 158         struct stats_file_header *hdr;
 159
 160         hdr = get_hdr(file);
 161
 162         if (hdr->roaming == UINT_MAX)
 163                 return NULL;
 164
 165         return (struct stats_record *)(file->addr + hdr->roaming);
 166 }
 167
 168 static void set_end(struct stats_file *file, struct stats_record *end)
 169 {
 170         struct stats_file_header *hdr;
 171
 172         hdr = get_hdr(file);
 173         hdr->end = (char *)end - file->addr;
 174 }
 175
 176 static void set_home(struct stats_file *file, struct stats_record *home)
 177 {
 178         struct stats_file_header *hdr;
 179
 180         hdr = get_hdr(file);
 181         hdr->home = (char *)home - file->addr;
 182 }
 183
 184 static void set_roaming(struct stats_file *file, struct stats_record *roaming)
 185 {
 186         struct stats_file_header *hdr;
 187
 188         hdr = get_hdr(file);
 189         hdr->roaming = (char *)roaming - file->addr;
 190 }
 191
 192 static struct stats_record *get_next(struct stats_file *file,
 193                                         struct stats_record *cur)
 194 {
 195         cur++;
 196
 197         if (cur > file->last)
 198                 cur = file->first;
 199
 200         return cur;
 201 }
 202
 203 static struct stats_record *get_iterator_begin(struct stats_file *file)
 204 {
 205         return get_next(file, get_begin(file));
 206 }
 207
 208 static struct stats_record *get_iterator_end(struct stats_file *file)
 209 {
 210         return get_next(file, get_end(file));
 211 }
 212
 213 static void stats_free(gpointer user_data)
 214 {
 215         struct stats_file *file = user_data;
 216
 217         msync(file->addr, file->len, MS_SYNC);
 218
 219         munmap(file->addr, file->len);
 220         file->addr = NULL;
 221
 222         TFR(close(file->fd));
 223         file->fd = -1;
 224
 225         if (file->history_name != NULL) {
 226                 g_free(file->history_name);
 227                 file->history_name = NULL;
 228         }
 229
 230         if (file->name != NULL) {
 231                 g_free(file->name);
 232                 file->name = NULL;
 233         }
 234
 235         if (file != NULL)
 236                 g_free(file);
 237 }
 238
 239 static void update_first(struct stats_file *file)
 240 {
 241         file->first = (struct stats_record *)
 242                         (file->addr + sizeof(struct stats_file_header));
 243 }
 244
 245 static void update_last(struct stats_file *file)
 246 {
 247         unsigned int max_entries;
 248
 249         max_entries = (file->len - sizeof(struct stats_file_header)) /
 250                         sizeof(struct stats_record);
 251         file->last = file->first + max_entries - 1;
 252 }
 253
 254 static void update_home(struct stats_file *file)
 255 {
 256         file->home = get_home(file);
 257 }
 258
 259 static void update_roaming(struct stats_file *file)
 260 {
 261         file->roaming = get_roaming(file);
 262 }
 263
 264 static void stats_file_update_cache(struct stats_file *file)
 265 {
 266         update_first(file);
 267         update_last(file);
 268         update_home(file);
 269         update_roaming(file);
 270 }
 271
 272 static int stats_file_remap(struct stats_file *file, size_t size)
 273 {
 274         size_t page_size, new_size;
 275         void *addr;
 276         int err;
 277
 278         page_size = sysconf(_SC_PAGESIZE);
 279         new_size = (size + page_size - 1) & ~(page_size - 1);
 280
 281         err = ftruncate(file->fd, new_size);
 282         if (err < 0) {
 283                 connman_error("ftrunctate error %s for %s",
 284                                 strerror(errno), file->name);
 285                 return -errno;
 286         }
 287
 288         if (file->addr == NULL) {
 289                 addr = mmap(NULL, new_size, PROT_READ | PROT_WRITE,
 290                                 MAP_SHARED, file->fd, 0);
 291         } else {
 292                 addr = mremap(file->addr, file->len, new_size, MREMAP_MAYMOVE);
 293         }
 294
 295         if (addr == MAP_FAILED) {
 296                 connman_error("mmap error %s for %s",
 297                                 strerror(errno), file->name);
 298                 return -errno;
 299         }
 300
 301         file->addr = addr;
 302         file->len = new_size;
 303
 304         stats_file_update_cache(file);
 305
 306         return 0;
 307 }
 308
 309 static int stats_open(struct stats_file *file,
 310                         const char *name)
 311 {
 312         file->name = g_strdup(name);
 313
 314         file->fd = TFR(open(file->name, O_RDWR | O_CREAT, 0644));
 315         if (file->fd < 0) {
 316                 connman_error("open error %s for %s",
 317                                 strerror(errno), file->name);
 318                 g_free(file->name);
 319                 return -errno;
 320         }
 321
 322         return 0;
 323 }
 324
 325 static int stats_open_temp(struct stats_file *file)
 326 {
 327         file->name = g_strdup_printf("%s/stats/stats.XXXXXX.tmp",
 328                                         STORAGEDIR);
 329         file->fd = g_mkstemp_full(file->name, O_RDWR | O_CREAT, 0644);
 330         if (file->fd < 0) {
 331                 connman_error("create tempory file error %s for %s",
 332                                 strerror(errno), file->name);
 333                 g_free(file->name);
 334                 return -errno;
 335         }
 336
 337         return 0;
 338 }
 339
 340 static int stats_file_setup(struct stats_file *file)
 341 {
 342         struct stats_file_header *hdr;
 343         struct stat st;
 344         size_t size = 0;
 345         int err;
 346
 347         err = fstat(file->fd, &st);
 348         if (err < 0) {
 349                 connman_error("fstat error %s for %s\n",
 350                         strerror(errno), file->name);
 351
 352                 TFR(close(file->fd));
 353                 g_free(file->name);
 354
 355                 return -errno;
 356         }
 357
 358         size = (size_t)st.st_size;
 359         file->max_len = STATS_MAX_FILE_SIZE;
 360
 361         if (size < (size_t)sysconf(_SC_PAGESIZE))
 362                 size = sysconf(_SC_PAGESIZE);
 363
 364         err = stats_file_remap(file, size);
 365         if (err < 0) {
 366                 TFR(close(file->fd));
 367                 g_free(file->name);
 368
 369                 return err;
 370         }
 371
 372         hdr = get_hdr(file);
 373
 374         if (hdr->magic != MAGIC ||
 375                         hdr->begin < sizeof(struct stats_file_header) ||
 376                         hdr->end < sizeof(struct stats_file_header) ||
 377                         hdr->home < sizeof(struct stats_file_header) ||
 378                         hdr->roaming < sizeof(struct stats_file_header) ||
 379                         hdr->begin > file->len ||
 380                         hdr->end > file->len) {
 381                 hdr->magic = MAGIC;
 382                 hdr->begin = sizeof(struct stats_file_header);
 383                 hdr->end = sizeof(struct stats_file_header);
 384                 hdr->home = UINT_MAX;
 385                 hdr->roaming = UINT_MAX;
 386
 387                 stats_file_update_cache(file);
 388         }
 389
 390         return 0;
 391 }
 392
 393
 394 static struct stats_record *get_next_record(struct stats_iter *iter)
 395 {
 396         if (iter->it != iter->end) {
 397                 struct stats_record *tmp;
 398
 399                 tmp = iter->it;
 400                 iter->it = get_next(iter->file, iter->it);
 401
 402                 return tmp;
 403         }
 404
 405         return NULL;
 406 }
 407
 408 static int append_record(struct stats_file *file,
 409                                 struct stats_record *rec)
 410 {
 411         struct stats_record *cur, *next;
 412         int err;
 413
 414         if (file->last == get_end(file)) {
 415                 err = stats_file_remap(file, file->len +
 416                                         sysconf(_SC_PAGESIZE));
 417                 if (err < 0)
 418                         return err;
 419
 420                 stats_file_update_cache(file);
 421         }
 422
 423         cur = get_end(file);
 424         next = get_next(file, cur);
 425
 426         memcpy(next, rec, sizeof(struct stats_record));
 427
 428         set_end(file, next);
 429
 430         return 0;
 431 }
 432
 433 static struct stats_record *process_file(struct stats_iter *iter,
 434                                         struct stats_file *temp_file,
 435                                         struct stats_record *cur,
 436                                         GDate *date_change_step_size,
 437                                         int account_period_offset)
 438 {
 439         struct stats_record *home, *roaming;
 440         struct stats_record *next;
 441
 442         home = NULL;
 443         roaming = NULL;
 444
 445         if (cur == NULL)
 446                 cur = get_next_record(iter);
 447         next = get_next_record(iter);
 448
 449         while (next != NULL) {
 450                 GDate date_cur;
 451                 GDate date_next;
 452                 int append;
 453
 454                 append = FALSE;
 455
 456                 if (cur->roaming == TRUE)
 457                         roaming = cur;
 458                 else
 459                         home = cur;
 460
 461                 g_date_set_time_t(&date_cur, cur->ts);
 462                 g_date_set_time_t(&date_next, next->ts);
 463
 464                 if (g_date_compare(&date_cur, date_change_step_size) < 0) {
 465                         /* month period size */
 466                         GDateDay day_cur, day_next;
 467                         GDateMonth month_cur, month_next;
 468
 469                         month_cur = g_date_get_month(&date_cur);
 470                         month_next = g_date_get_month(&date_next);
 471
 472                         day_cur = g_date_get_day(&date_cur);
 473                         day_next = g_date_get_day(&date_next);
 474
 475                         if (day_cur == day_next && month_cur != month_next) {
 476                                 append = TRUE;
 477                         } else if (day_cur < account_period_offset &&
 478                                         day_next >= account_period_offset) {
 479                                 append = TRUE;
 480                         }
 481                 } else {
 482                         /* day period size */
 483                         if (g_date_days_between(&date_cur, &date_next) > 0)
 484                                 append = TRUE;
 485                 }
 486
 487                 if (append == TRUE) {
 488                         if (home != NULL) {
 489                                 append_record(temp_file, home);
 490                                 home = NULL;
 491                         }
 492
 493                         if (roaming != NULL) {
 494                                 append_record(temp_file, roaming);
 495                                 roaming = NULL;
 496                         }
 497                 }
 498
 499                 cur = next;
 500                 next = get_next_record(iter);
 501         }
 502
 503         return cur;
 504 }
 505
 506 static int summarize(struct stats_file *data_file,
 507                         struct stats_file *history_file,
 508                         struct stats_file *temp_file)
 509 {
 510         struct stats_iter data_iter;
 511         struct stats_iter history_iter;
 512         struct stats_record *cur, *next;
 513
 514         GDate today, date_change_step_size;
 515
 516         /*
 517          * First calculate the date when switch from monthly
 518          * accounting period size to daily size
 519          */
 520         g_date_set_time_t(&today, time(NULL));
 521
 522         date_change_step_size = today;
 523         if (g_date_get_day(&today) - data_file->account_period_offset >= 0)
 524                 g_date_subtract_months(&date_change_step_size, 2);
 525         else
 526                 g_date_subtract_months(&date_change_step_size, 3);
 527
 528         g_date_set_day(&date_change_step_size,
 529                         data_file->account_period_offset);
 530
 531
 532         /* Now process history file */
 533         cur = NULL;
 534
 535         if (history_file != NULL) {
 536                 history_iter.file = history_file;
 537                 history_iter.begin = get_iterator_begin(history_iter.file);
 538                 history_iter.end = get_iterator_end(history_iter.file);
 539                 history_iter.it = history_iter.begin;
 540
 541                 cur = process_file(&history_iter, temp_file, NULL,
 542                                         &date_change_step_size,
 543                                         data_file->account_period_offset);
 544         }
 545
 546         data_iter.file = data_file;
 547         data_iter.begin = get_iterator_begin(data_iter.file);
 548         data_iter.end = get_iterator_end(data_iter.file);
 549         data_iter.it = data_iter.begin;
 550
 551         /*
 552          * Ensure date_file records are newer than the history_file
 553          * record
 554          */
 555         if (cur != NULL) {
 556                 next = get_next_record(&data_iter);
 557                 while (next != NULL && cur->ts > next->ts)
 558                         next = get_next_record(&data_iter);
 559         }
 560
 561         /* And finally process the new data records */
 562         cur = process_file(&data_iter, temp_file, cur,
 563                                 &date_change_step_size,
 564                                 data_file->account_period_offset);
 565
 566         if (cur != NULL)
 567                 append_record(temp_file, cur);
 568
 569         return 0;
 570 }
 571
 572 static void stats_file_unmap(struct stats_file *file)
 573 {
 574         msync(file->addr, file->len, MS_SYNC);
 575         munmap(file->addr, file->len);
 576         file->addr = NULL;
 577 }
 578
 579 static void stats_file_cleanup(struct stats_file *file)
 580 {
 581         file->fd = -1;
 582         g_free(file->name);
 583 }
 584
 585 static int stats_file_close_swap(struct stats_file *history_file,
 586                                         struct stats_file *temp_file)
 587 {
 588         int err;
 589
 590         stats_file_unmap(history_file);
 591         stats_file_unmap(temp_file);
 592
 593         TFR(close(temp_file->fd));
 594
 595         unlink(history_file->name);
 596
 597         err = link(temp_file->name, history_file->name);
 598
 599         unlink(temp_file->name);
 600
 601         TFR(close(history_file->fd));
 602
 603         stats_file_cleanup(history_file);
 604         stats_file_cleanup(temp_file);
 605
 606         return err;
 607 }
 608
 609 static int stats_file_history_update(struct stats_file *data_file)
 610 {
 611         struct stats_file _history_file, *history_file;
 612         struct stats_file _temp_file, *temp_file;
 613         int err;
 614
 615         history_file = &_history_file;
 616         temp_file = &_temp_file;
 617
 618         bzero(history_file, sizeof(struct stats_file));
 619         bzero(temp_file, sizeof(struct stats_file));
 620
 621         err = stats_open(history_file, data_file->history_name);
 622         if (err < 0)
 623                 return err;
 624         stats_file_setup(history_file);
 625
 626         err = stats_open_temp(temp_file);
 627         if (err < 0) {
 628                 stats_free(history_file);
 629                 return err;
 630         }
 631         stats_file_setup(temp_file);
 632
 633         summarize(data_file, history_file, temp_file);
 634
 635         err = stats_file_close_swap(history_file, temp_file);
 636
 637         return err;
 638 }
 639
 640 int __connman_stats_service_register(struct connman_service *service)
 641 {
 642         struct stats_file *file;
 643         char *name;
 644         int err;
 645
 646         DBG("service %p", service);
 647
 648         file = g_hash_table_lookup(stats_hash, service);
 649         if (file == NULL) {
 650                 file = g_try_new0(struct stats_file, 1);
 651                 if (file == NULL)
 652                         return -ENOMEM;
 653
 654                 g_hash_table_insert(stats_hash, service, file);
 655         } else {
 656                 return -EALREADY;
 657         }
 658
 659         name = g_strdup_printf("%s/stats/%s.data", STORAGEDIR,
 660                                 __connman_service_get_ident(service));
 661         file->history_name = g_strdup_printf("%s/stats/%s.history", STORAGEDIR,
 662                                 __connman_service_get_ident(service));
 663
 664         /* TODO: Use a global config file instead of hard coded value. */
 665         file->account_period_offset = 1;
 666
 667         err = stats_open(file, name);
 668         g_free(name);
 669         if (err < 0)
 670                 goto err;
 671
 672         err = stats_file_setup(file);
 673         if (err < 0)
 674                 goto err;
 675
 676         return 0;
 677
 678 err:
 679         g_hash_table_remove(stats_hash, service);
 680
 681         return err;
 682 }
 683
 684 void __connman_stats_service_unregister(struct connman_service *service)
 685 {
 686         DBG("service %p", service);
 687
 688         g_hash_table_remove(stats_hash, service);
 689 }
 690
 691 int  __connman_stats_update(struct connman_service *service,
 692                                 connman_bool_t roaming,
 693                                 struct connman_stats_data *data)
 694 {
 695         struct stats_file *file;
 696         struct stats_record *next;
 697         int err;
 698
 699         file = g_hash_table_lookup(stats_hash, service);
 700         if (file == NULL)
 701                 return -EEXIST;
 702
 703         if (file->len < file->max_len &&
 704                         file->last == get_end(file)) {
 705                 DBG("grow file %s", file->name);
 706
 707                 err = stats_file_remap(file, file->len + sysconf(_SC_PAGESIZE));
 708                 if (err < 0)
 709                         return err;
 710         }
 711
 712         next = get_next(file, get_end(file));
 713
 714         if (next == get_begin(file)) {
 715                 DBG("ring buffer is full, update history file");
 716
 717                 if (stats_file_history_update(file) < 0) {
 718                         connman_warn("history file update failed %s",
 719                                         file->history_name);
 720                 }
 721         }
 722
 723         next->ts = time(NULL);
 724         next->roaming = roaming;
 725         memcpy(&next->data, data, sizeof(struct connman_stats_data));
 726
 727         if (roaming != TRUE)
 728                 set_home(file, next);
 729         else
 730                 set_roaming(file, next);
 731
 732         set_end(file, next);
 733
 734         return 0;
 735 }
 736
 737 int __connman_stats_get(struct connman_service *service,
 738                                 connman_bool_t roaming,
 739                                 struct connman_stats_data *data)
 740 {
 741         struct stats_file *file;
 742         struct stats_record *rec;
 743
 744         file = g_hash_table_lookup(stats_hash, service);
 745         if (file == NULL)
 746                 return -EEXIST;
 747
 748         if (roaming != TRUE)
 749                 rec = file->home;
 750         else
 751                 rec = file->roaming;
 752
 753         if (rec != NULL) {
 754                 memcpy(data, &rec->data,
 755                         sizeof(struct connman_stats_data));
 756         }
 757
 758         return 0;
 759 }
 760
 761 int __connman_stats_init(void)
 762 {
 763         DBG("");
 764
 765         stats_hash = g_hash_table_new_full(g_direct_hash, g_direct_equal,
 766                                                         NULL, stats_free);
 767
 768         return 0;
 769 }
 770
 771 void __connman_stats_cleanup(void)
 772 {
 773         DBG("");
 774
 775         g_hash_table_destroy(stats_hash);
 776         stats_hash = NULL;
 777 }