src/rrd_open.c

   1 /*****************************************************************************
   2  * RRDtool 1.4.3  Copyright by Tobi Oetiker, 1997-2010
   3  *****************************************************************************
   4  * rrd_open.c  Open an RRD File
   5  *****************************************************************************
   6  * $Id$
   7  *****************************************************************************/
   8
   9 #include "rrd_tool.h"
  10 #include "unused.h"
  11
  12 #ifdef WIN32
  13 #include <stdlib.h>
  14 #include <fcntl.h>
  15 #include <sys/stat.h>
  16 #endif
  17
  18
  19 #ifdef HAVE_BROKEN_MS_ASYNC
  20 #include <sys/types.h>
  21 #include <utime.h>
  22 #endif
  23
  24 #define MEMBLK 8192
  25
  26 #ifdef WIN32
  27 #define _LK_UNLCK       0       /* Unlock */
  28 #define _LK_LOCK        1       /* Lock */
  29 #define _LK_NBLCK       2       /* Non-blocking lock */
  30 #define _LK_RLCK        3       /* Lock for read only */
  31 #define _LK_NBRLCK      4       /* Non-blocking lock for read only */
  32
  33
  34 #define LK_UNLCK        _LK_UNLCK
  35 #define LK_LOCK         _LK_LOCK
  36 #define LK_NBLCK        _LK_NBLCK
  37 #define LK_RLCK         _LK_RLCK
  38 #define LK_NBRLCK       _LK_NBRLCK
  39 #endif
  40
  41 /* DEBUG 2 prints information obtained via mincore(2) */
  42 #define DEBUG 1
  43 /* do not calculate exact madvise hints but assume 1 page for headers and
  44  * set DONTNEED for the rest, which is assumed to be data */
  45 /* Avoid calling madvise on areas that were already hinted. May be benefical if
  46  * your syscalls are very slow */
  47
  48 #ifdef HAVE_MMAP
  49 /* the cast to void* is there to avoid this warning seen on ia64 with certain
  50    versions of gcc: 'cast increases required alignment of target type'
  51 */
  52 #define __rrd_read(dst, dst_t, cnt) { \
  53         size_t wanted = sizeof(dst_t)*(cnt); \
  54         if (offset + wanted > rrd_file->file_len) { \
  55                 rrd_set_error("reached EOF while loading header " #dst); \
  56                 goto out_nullify_head; \
  57         } \
  58         (dst) = (dst_t*)(void*) (data + offset); \
  59         offset += wanted; \
  60     }
  61 #else
  62 #define __rrd_read(dst, dst_t, cnt) { \
  63         size_t wanted = sizeof(dst_t)*(cnt); \
  64         size_t got; \
  65         if ((dst = (dst_t*)malloc(wanted)) == NULL) { \
  66                 rrd_set_error(#dst " malloc"); \
  67                 goto out_nullify_head; \
  68         } \
  69         got = read (rrd_simple_file->fd, dst, wanted); \
  70         if (got != wanted) { \
  71                 rrd_set_error("short read while reading header " #dst); \
  72                 goto out_nullify_head; \
  73         } \
  74         offset += got; \
  75     }
  76 #endif
  77
  78 /* get the address of the start of this page */
  79 #if defined USE_MADVISE || defined HAVE_POSIX_FADVISE
  80 #ifndef PAGE_START
  81 #define PAGE_START(addr) ((addr)&(~(_page_size-1)))
  82 #endif
  83 #endif
  84
  85 /* Open a database file, return its header and an open filehandle,
  86  * positioned to the first cdp in the first rra.
  87  * In the error path of rrd_open, only rrd_free(&rrd) has to be called
  88  * before returning an error. Do not call rrd_close upon failure of rrd_open.
  89  * If creating a new file, the parameter rrd must be initialised with
  90  * details of the file content.
  91  * If opening an existing file, then use rrd must be initialised by
  92  * rrd_init(rrd) prior to invoking rrd_open
  93  */
  94
  95 rrd_file_t *rrd_open(
  96     const char *const file_name,
  97     rrd_t *rrd,
  98     unsigned rdwr)
  99 {
 100     unsigned long ui;
 101     int       flags = 0;
 102     int       version;
 103
 104 #ifdef HAVE_MMAP
 105     ssize_t   _page_size = sysconf(_SC_PAGESIZE);
 106     char     *data = MAP_FAILED;
 107 #endif
 108     off_t     offset = 0;
 109     struct stat statb;
 110     rrd_file_t *rrd_file = NULL;
 111     rrd_simple_file_t *rrd_simple_file = NULL;
 112     size_t     newfile_size = 0;
 113     size_t header_len, value_cnt, data_len;
 114
 115     /* Are we creating a new file? */
 116     if((rdwr & RRD_CREAT) && (rrd->stat_head != NULL))
 117     {
 118         header_len = rrd_get_header_size(rrd);
 119
 120         value_cnt = 0;
 121         for (ui = 0; ui < rrd->stat_head->rra_cnt; ui++)
 122             value_cnt += rrd->stat_head->ds_cnt * rrd->rra_def[ui].row_cnt;
 123
 124         data_len = sizeof(rrd_value_t) * value_cnt;
 125
 126         newfile_size = header_len + data_len;
 127     }
 128
 129     rrd_file = (rrd_file_t*)malloc(sizeof(rrd_file_t));
 130     if (rrd_file == NULL) {
 131         rrd_set_error("allocating rrd_file descriptor for '%s'", file_name);
 132         return NULL;
 133     }
 134     memset(rrd_file, 0, sizeof(rrd_file_t));
 135
 136     rrd_file->pvt = malloc(sizeof(rrd_simple_file_t));
 137     if(rrd_file->pvt == NULL) {
 138         rrd_set_error("allocating rrd_simple_file for '%s'", file_name);
 139         return NULL;
 140     }
 141     memset(rrd_file->pvt, 0, sizeof(rrd_simple_file_t));
 142     rrd_simple_file = (rrd_simple_file_t *)rrd_file->pvt;
 143
 144 #ifdef DEBUG
 145     if ((rdwr & (RRD_READONLY | RRD_READWRITE)) ==
 146         (RRD_READONLY | RRD_READWRITE)) {
 147         /* Both READONLY and READWRITE were given, which is invalid.  */
 148         rrd_set_error("in read/write request mask");
 149         exit(-1);
 150     }
 151 #endif
 152
 153 #ifdef HAVE_MMAP
 154     rrd_simple_file->mm_prot = PROT_READ;
 155     rrd_simple_file->mm_flags = 0;
 156 #endif
 157
 158     if (rdwr & RRD_READONLY) {
 159         flags |= O_RDONLY;
 160 #ifdef HAVE_MMAP
 161         rrd_simple_file->mm_flags = MAP_PRIVATE;
 162 # ifdef MAP_NORESERVE
 163         rrd_simple_file->mm_flags |= MAP_NORESERVE;  /* readonly, so no swap backing needed */
 164 # endif
 165 #endif
 166     } else {
 167         if (rdwr & RRD_READWRITE) {
 168             flags |= O_RDWR;
 169 #ifdef HAVE_MMAP
 170             rrd_simple_file->mm_flags = MAP_SHARED;
 171             rrd_simple_file->mm_prot |= PROT_WRITE;
 172 #endif
 173         }
 174         if (rdwr & RRD_CREAT) {
 175             flags |= (O_CREAT | O_TRUNC);
 176         }
 177         if (rdwr & RRD_EXCL) {
 178             flags |= O_EXCL;
 179         }
 180     }
 181     if (rdwr & RRD_READAHEAD) {
 182 #ifdef MAP_POPULATE
 183         rrd_simple_file->mm_flags |= MAP_POPULATE;   /* populate ptes and data */
 184 #endif
 185 #if defined MAP_NONBLOCK
 186         rrd_simple_file->mm_flags |= MAP_NONBLOCK;   /* just populate ptes */
 187 #endif
 188     }
 189 #if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__CYGWIN32__)
 190     flags |= O_BINARY;
 191 #endif
 192
 193     if ((rrd_simple_file->fd = open(file_name, flags, 0666)) < 0) {
 194         rrd_set_error("opening '%s': %s", file_name, rrd_strerror(errno));
 195         goto out_free;
 196     }
 197
 198 #ifdef HAVE_MMAP
 199 #ifdef HAVE_BROKEN_MS_ASYNC
 200     if (rdwr & RRD_READWRITE) {
 201         /* some unices, the files mtime does not get update
 202            on msync MS_ASYNC, in order to help them,
 203            we update the the timestamp at this point.
 204            The thing happens pretty 'close' to the open
 205            call so the chances of a race should be minimal.
 206
 207            Maybe ask your vendor to fix your OS ... */
 208            utime(file_name,NULL);
 209     }
 210 #endif
 211 #endif
 212
 213     /* Better try to avoid seeks as much as possible. stat may be heavy but
 214      * many concurrent seeks are even worse.  */
 215     if (newfile_size == 0 && ((fstat(rrd_simple_file->fd, &statb)) < 0)) {
 216         rrd_set_error("fstat '%s': %s", file_name, rrd_strerror(errno));
 217         goto out_close;
 218     }
 219     if (newfile_size == 0) {
 220         rrd_file->file_len = statb.st_size;
 221     } else {
 222         rrd_file->file_len = newfile_size;
 223         lseek(rrd_simple_file->fd, newfile_size - 1, SEEK_SET);
 224         if ( write(rrd_simple_file->fd, "\0", 1) == -1){    /* poke */
 225             rrd_set_error("write '%s': %s", file_name, rrd_strerror(errno));
 226             goto out_close;
 227         }
 228         lseek(rrd_simple_file->fd, 0, SEEK_SET);
 229     }
 230 #ifdef HAVE_POSIX_FADVISE
 231     /* In general we need no read-ahead when dealing with rrd_files.
 232        When we stop reading, it is highly unlikely that we start up again.
 233        In this manner we actually save time and diskaccess (and buffer cache).
 234        Thanks to Dave Plonka for the Idea of using POSIX_FADV_RANDOM here. */
 235     posix_fadvise(rrd_simple_file->fd, 0, 0, POSIX_FADV_RANDOM);
 236 #endif
 237
 238 /*
 239         if (rdwr & RRD_READWRITE)
 240         {
 241            if (setvbuf((rrd_simple_file->fd),NULL,_IONBF,2)) {
 242                   rrd_set_error("failed to disable the stream buffer\n");
 243                   return (-1);
 244            }
 245         }
 246 */
 247
 248 #ifdef HAVE_MMAP
 249     data = mmap(0, rrd_file->file_len,
 250         rrd_simple_file->mm_prot, rrd_simple_file->mm_flags,
 251         rrd_simple_file->fd, offset);
 252
 253     /* lets see if the first read worked */
 254     if (data == MAP_FAILED) {
 255         rrd_set_error("mmaping file '%s': %s", file_name,
 256                       rrd_strerror(errno));
 257         goto out_close;
 258     }
 259     rrd_simple_file->file_start = data;
 260     if (rdwr & RRD_CREAT) {
 261         memset(data, DNAN, newfile_size - 1);
 262         goto out_done;
 263     }
 264 #endif
 265     if (rdwr & RRD_CREAT)
 266         goto out_done;
 267 #ifdef USE_MADVISE
 268     if (rdwr & RRD_COPY) {
 269         /* We will read everything in a moment (copying) */
 270         madvise(data, rrd_file->file_len, MADV_WILLNEED );
 271         madvise(data, rrd_file->file_len, MADV_SEQUENTIAL );
 272     } else {
 273         /* We do not need to read anything in for the moment */
 274         madvise(data, rrd_file->file_len, MADV_RANDOM);
 275         /* the stat_head will be needed soonish, so hint accordingly */
 276         madvise(data, sizeof(stat_head_t), MADV_WILLNEED);
 277         madvise(data, sizeof(stat_head_t), MADV_RANDOM);
 278     }
 279 #endif
 280
 281     __rrd_read(rrd->stat_head, stat_head_t,
 282                1);
 283
 284     /* lets do some test if we are on track ... */
 285     if (memcmp(rrd->stat_head->cookie, RRD_COOKIE, sizeof(RRD_COOKIE)) != 0) {
 286         rrd_set_error("'%s' is not an RRD file", file_name);
 287         goto out_nullify_head;
 288     }
 289
 290     if (rrd->stat_head->float_cookie != FLOAT_COOKIE) {
 291         rrd_set_error("This RRD was created on another architecture");
 292         goto out_nullify_head;
 293     }
 294
 295     version = atoi(rrd->stat_head->version);
 296
 297     if (version > atoi(RRD_VERSION)) {
 298         rrd_set_error("can't handle RRD file version %s",
 299                       rrd->stat_head->version);
 300         goto out_nullify_head;
 301     }
 302 #if defined USE_MADVISE
 303     /* the ds_def will be needed soonish, so hint accordingly */
 304     madvise(data + PAGE_START(offset),
 305             sizeof(ds_def_t) * rrd->stat_head->ds_cnt, MADV_WILLNEED);
 306 #endif
 307     __rrd_read(rrd->ds_def, ds_def_t,
 308                rrd->stat_head->ds_cnt);
 309
 310 #if defined USE_MADVISE
 311     /* the rra_def will be needed soonish, so hint accordingly */
 312     madvise(data + PAGE_START(offset),
 313             sizeof(rra_def_t) * rrd->stat_head->rra_cnt, MADV_WILLNEED);
 314 #endif
 315     __rrd_read(rrd->rra_def, rra_def_t,
 316                rrd->stat_head->rra_cnt);
 317
 318     /* handle different format for the live_head */
 319     if (version < 3) {
 320         rrd->live_head = (live_head_t *) malloc(sizeof(live_head_t));
 321         if (rrd->live_head == NULL) {
 322             rrd_set_error("live_head_t malloc");
 323             goto out_close;
 324         }
 325 #if defined USE_MADVISE
 326         /* the live_head will be needed soonish, so hint accordingly */
 327         madvise(data + PAGE_START(offset), sizeof(time_t), MADV_WILLNEED);
 328 #endif
 329         __rrd_read(rrd->legacy_last_up, time_t,
 330                    1);
 331
 332         rrd->live_head->last_up = *rrd->legacy_last_up;
 333         rrd->live_head->last_up_usec = 0;
 334     } else {
 335 #if defined USE_MADVISE
 336         /* the live_head will be needed soonish, so hint accordingly */
 337         madvise(data + PAGE_START(offset),
 338                 sizeof(live_head_t), MADV_WILLNEED);
 339 #endif
 340         __rrd_read(rrd->live_head, live_head_t,
 341                    1);
 342     }
 343     __rrd_read(rrd->pdp_prep, pdp_prep_t,
 344                rrd->stat_head->ds_cnt);
 345     __rrd_read(rrd->cdp_prep, cdp_prep_t,
 346                rrd->stat_head->rra_cnt * rrd->stat_head->ds_cnt);
 347     __rrd_read(rrd->rra_ptr, rra_ptr_t,
 348                rrd->stat_head->rra_cnt);
 349
 350     rrd_file->header_len = offset;
 351     rrd_file->pos = offset;
 352
 353     {
 354       unsigned long row_cnt = 0;
 355
 356       for (ui=0; ui<rrd->stat_head->rra_cnt; ui++)
 357         row_cnt += rrd->rra_def[ui].row_cnt;
 358
 359       size_t  correct_len = rrd_file->header_len +
 360         sizeof(rrd_value_t) * row_cnt * rrd->stat_head->ds_cnt;
 361
 362       if (correct_len > rrd_file->file_len)
 363       {
 364         rrd_set_error("'%s' is too small (should be %ld bytes)",
 365                       file_name, (long long) correct_len);
 366         goto out_nullify_head;
 367       }
 368     }
 369
 370   out_done:
 371     return (rrd_file);
 372   out_nullify_head:
 373     rrd->stat_head = NULL;
 374   out_close:
 375 #ifdef HAVE_MMAP
 376     if (data != MAP_FAILED)
 377       munmap(data, rrd_file->file_len);
 378 #endif
 379
 380     close(rrd_simple_file->fd);
 381   out_free:
 382     free(rrd_file->pvt);
 383     free(rrd_file);
 384     return NULL;
 385 }
 386
 387
 388 #if defined DEBUG && DEBUG > 1
 389 /* Print list of in-core pages of a the current rrd_file.  */
 390 static
 391 void mincore_print(
 392     rrd_file_t *rrd_file,
 393     char *mark)
 394 {
 395     rrd_simple_file_t *rrd_simple_file;
 396     rrd_simple_file = (rrd_simple_file_t *)rrd_file->pvt;
 397 #ifdef HAVE_MMAP
 398     /* pretty print blocks in core */
 399     size_t     off;
 400     unsigned char *vec;
 401     ssize_t   _page_size = sysconf(_SC_PAGESIZE);
 402
 403     off = rrd_file->file_len +
 404         ((rrd_file->file_len + _page_size - 1) / _page_size);
 405     vec = malloc(off);
 406     if (vec != NULL) {
 407         memset(vec, 0, off);
 408         if (mincore(rrd_simple_file->file_start, rrd_file->file_len, vec) == 0) {
 409             int       prev;
 410             unsigned  is_in = 0, was_in = 0;
 411
 412             for (off = 0, prev = 0; off < rrd_file->file_len; ++off) {
 413                 is_in = vec[off] & 1;   /* if lsb set then is core resident */
 414                 if (off == 0)
 415                     was_in = is_in;
 416                 if (was_in != is_in) {
 417                     fprintf(stderr, "%s: %sin core: %p len %ld\n", mark,
 418                             was_in ? "" : "not ", vec + prev, off - prev);
 419                     was_in = is_in;
 420                     prev = off;
 421                 }
 422             }
 423             fprintf(stderr,
 424                     "%s: %sin core: %p len %ld\n", mark,
 425                     was_in ? "" : "not ", vec + prev, off - prev);
 426         } else
 427             fprintf(stderr, "mincore: %s", rrd_strerror(errno));
 428     }
 429 #else
 430     fprintf(stderr, "sorry mincore only works with mmap");
 431 #endif
 432 }
 433 #endif                          /* defined DEBUG && DEBUG > 1 */
 434
 435 /*
 436  * get exclusive lock to whole file.
 437  * lock gets removed when we close the file
 438  *
 439  * returns 0 on success
 440  */
 441 int rrd_lock(
 442     rrd_file_t *rrd_file)
 443 {
 444     int       rcstat;
 445     rrd_simple_file_t *rrd_simple_file;
 446     rrd_simple_file = (rrd_simple_file_t *)rrd_file->pvt;
 447
 448     {
 449 #if defined(_WIN32) && !defined(__CYGWIN__) && !defined(__CYGWIN32__)
 450         struct _stat st;
 451
 452         if (_fstat(rrd_simple_file->fd, &st) == 0) {
 453             rcstat = _locking(rrd_simple_file->fd, _LK_NBLCK, st.st_size);
 454         } else {
 455             rcstat = -1;
 456         }
 457 #else
 458         struct flock lock;
 459
 460         lock.l_type = F_WRLCK;  /* exclusive write lock */
 461         lock.l_len = 0; /* whole file */
 462         lock.l_start = 0;   /* start of file */
 463         lock.l_whence = SEEK_SET;   /* end of file */
 464
 465         rcstat = fcntl(rrd_simple_file->fd, F_SETLK, &lock);
 466 #endif
 467     }
 468
 469     return (rcstat);
 470 }
 471
 472
 473 /* drop cache except for the header and the active pages */
 474 void rrd_dontneed(
 475     rrd_file_t *rrd_file,
 476     rrd_t *rrd)
 477 {
 478     rrd_simple_file_t *rrd_simple_file = (rrd_simple_file_t *)rrd_file->pvt;
 479 #if defined USE_MADVISE || defined HAVE_POSIX_FADVISE
 480     size_t dontneed_start;
 481     size_t rra_start;
 482     size_t active_block;
 483     size_t i;
 484     ssize_t   _page_size = sysconf(_SC_PAGESIZE);
 485
 486     if (rrd_file == NULL) {
 487 #if defined DEBUG && DEBUG
 488             fprintf (stderr, "rrd_dontneed: Argument 'rrd_file' is NULL.\n");
 489 #endif
 490             return;
 491     }
 492
 493 #if defined DEBUG && DEBUG > 1
 494     mincore_print(rrd_file, "before");
 495 #endif
 496
 497     /* ignoring errors from RRDs that are smaller then the file_len+rounding */
 498     rra_start = rrd_file->header_len;
 499     dontneed_start = PAGE_START(rra_start) + _page_size;
 500     for (i = 0; i < rrd->stat_head->rra_cnt; ++i) {
 501         active_block =
 502             PAGE_START(rra_start
 503                        + rrd->rra_ptr[i].cur_row
 504                        * rrd->stat_head->ds_cnt * sizeof(rrd_value_t));
 505         if (active_block > dontneed_start) {
 506 #ifdef USE_MADVISE
 507             madvise(rrd_simple_file->file_start + dontneed_start,
 508                     active_block - dontneed_start - 1, MADV_DONTNEED);
 509 #endif
 510 /* in linux at least only fadvise DONTNEED seems to purge pages from cache */
 511 #ifdef HAVE_POSIX_FADVISE
 512             posix_fadvise(rrd_simple_file->fd, dontneed_start,
 513                           active_block - dontneed_start - 1,
 514                           POSIX_FADV_DONTNEED);
 515 #endif
 516         }
 517         dontneed_start = active_block;
 518         /* do not release 'hot' block if update for this RAA will occur
 519          * within 10 minutes */
 520         if (rrd->stat_head->pdp_step * rrd->rra_def[i].pdp_cnt -
 521             rrd->live_head->last_up % (rrd->stat_head->pdp_step *
 522                                        rrd->rra_def[i].pdp_cnt) < 10 * 60) {
 523             dontneed_start += _page_size;
 524         }
 525         rra_start +=
 526             rrd->rra_def[i].row_cnt * rrd->stat_head->ds_cnt *
 527             sizeof(rrd_value_t);
 528     }
 529
 530     if (dontneed_start < rrd_file->file_len) {
 531 #ifdef USE_MADVISE
 532             madvise(rrd_simple_file->file_start + dontneed_start,
 533                     rrd_file->file_len - dontneed_start, MADV_DONTNEED);
 534 #endif
 535 #ifdef HAVE_POSIX_FADVISE
 536             posix_fadvise(rrd_simple_file->fd, dontneed_start,
 537                           rrd_file->file_len - dontneed_start,
 538                           POSIX_FADV_DONTNEED);
 539 #endif
 540     }
 541
 542 #if defined DEBUG && DEBUG > 1
 543     mincore_print(rrd_file, "after");
 544 #endif
 545 #endif                          /* without madvise and posix_fadvise it does not make much sense todo anything */
 546 }
 547
 548
 549
 550
 551
 552 int rrd_close(
 553     rrd_file_t *rrd_file)
 554 {
 555     rrd_simple_file_t *rrd_simple_file;
 556     rrd_simple_file = (rrd_simple_file_t *)rrd_file->pvt;
 557     int       ret;
 558
 559 #ifdef HAVE_MMAP
 560     ret = msync(rrd_simple_file->file_start, rrd_file->file_len, MS_ASYNC);
 561     if (ret != 0)
 562         rrd_set_error("msync rrd_file: %s", rrd_strerror(errno));
 563     ret = munmap(rrd_simple_file->file_start, rrd_file->file_len);
 564     if (ret != 0)
 565         rrd_set_error("munmap rrd_file: %s", rrd_strerror(errno));
 566 #endif
 567     ret = close(rrd_simple_file->fd);
 568     if (ret != 0)
 569         rrd_set_error("closing file: %s", rrd_strerror(errno));
 570     free(rrd_file->pvt);
 571     free(rrd_file);
 572     rrd_file = NULL;
 573     return ret;
 574 }
 575
 576
 577 /* Set position of rrd_file.  */
 578
 579 off_t rrd_seek(
 580     rrd_file_t *rrd_file,
 581     off_t off,
 582     int whence)
 583 {
 584     off_t     ret = 0;
 585     rrd_simple_file_t *rrd_simple_file;
 586     rrd_simple_file = (rrd_simple_file_t *)rrd_file->pvt;
 587
 588 #ifdef HAVE_MMAP
 589     if (whence == SEEK_SET)
 590         rrd_file->pos = off;
 591     else if (whence == SEEK_CUR)
 592         rrd_file->pos += off;
 593     else if (whence == SEEK_END)
 594         rrd_file->pos = rrd_file->file_len + off;
 595 #else
 596     ret = lseek(rrd_simple_file->fd, off, whence);
 597     if (ret < 0)
 598         rrd_set_error("lseek: %s", rrd_strerror(errno));
 599     rrd_file->pos = ret;
 600 #endif
 601     /* mimic fseek, which returns 0 upon success */
 602     return ret < 0;     /*XXX: or just ret to mimic lseek */
 603 }
 604
 605
 606 /* Get current position in rrd_file.  */
 607
 608 off_t rrd_tell(
 609     rrd_file_t *rrd_file)
 610 {
 611     return rrd_file->pos;
 612 }
 613
 614
 615 /* Read count bytes into buffer buf, starting at rrd_file->pos.
 616  * Returns the number of bytes read or <0 on error.  */
 617
 618 ssize_t rrd_read(
 619     rrd_file_t *rrd_file,
 620     void *buf,
 621     size_t count)
 622 {
 623     rrd_simple_file_t *rrd_simple_file = (rrd_simple_file_t *)rrd_file->pvt;
 624 #ifdef HAVE_MMAP
 625     size_t    _cnt = count;
 626     ssize_t   _surplus;
 627
 628     if (rrd_file->pos > rrd_file->file_len || _cnt == 0)    /* EOF */
 629         return 0;
 630     if (buf == NULL)
 631         return -1;      /* EINVAL */
 632     _surplus = rrd_file->pos + _cnt - rrd_file->file_len;
 633     if (_surplus > 0) { /* short read */
 634         _cnt -= _surplus;
 635     }
 636     if (_cnt == 0)
 637         return 0;       /* EOF */
 638     buf = memcpy(buf, rrd_simple_file->file_start + rrd_file->pos, _cnt);
 639
 640     rrd_file->pos += _cnt;  /* mimmic read() semantics */
 641     return _cnt;
 642 #else
 643     ssize_t   ret;
 644
 645     ret = read(rrd_simple_file->fd, buf, count);
 646     if (ret > 0)
 647         rrd_file->pos += ret;   /* mimmic read() semantics */
 648     return ret;
 649 #endif
 650 }
 651
 652
 653 /* Write count bytes from buffer buf to the current position
 654  * rrd_file->pos of rrd_simple_file->fd.
 655  * Returns the number of bytes written or <0 on error.  */
 656
 657 ssize_t rrd_write(
 658     rrd_file_t *rrd_file,
 659     const void *buf,
 660     size_t count)
 661 {
 662     rrd_simple_file_t *rrd_simple_file = (rrd_simple_file_t *)rrd_file->pvt;
 663 #ifdef HAVE_MMAP
 664     size_t old_size = rrd_file->file_len;
 665     if (count == 0)
 666         return 0;
 667     if (buf == NULL)
 668         return -1;      /* EINVAL */
 669
 670     if((rrd_file->pos + count) > old_size)
 671     {
 672         rrd_set_error("attempting to write beyond end of file");
 673         return -1;
 674     }
 675     memcpy(rrd_simple_file->file_start + rrd_file->pos, buf, count);
 676     rrd_file->pos += count;
 677     return count;       /* mimmic write() semantics */
 678 #else
 679     ssize_t   _sz = write(rrd_simple_file->fd, buf, count);
 680
 681     if (_sz > 0)
 682         rrd_file->pos += _sz;
 683     return _sz;
 684 #endif
 685 }
 686
 687
 688 /* this is a leftover from the old days, it serves no purpose
 689    and is therefore turned into a no-op */
 690 void rrd_flush(
 691     rrd_file_t UNUSED(*rrd_file))
 692 {
 693 }
 694
 695 /* Initialize RRD header.  */
 696
 697 void rrd_init(
 698     rrd_t *rrd)
 699 {
 700     rrd->stat_head = NULL;
 701     rrd->ds_def = NULL;
 702     rrd->rra_def = NULL;
 703     rrd->live_head = NULL;
 704     rrd->legacy_last_up = NULL;
 705     rrd->rra_ptr = NULL;
 706     rrd->pdp_prep = NULL;
 707     rrd->cdp_prep = NULL;
 708     rrd->rrd_value = NULL;
 709 }
 710
 711
 712 /* free RRD header data.  */
 713
 714 #ifdef HAVE_MMAP
 715 void rrd_free(
 716     rrd_t *rrd)
 717 {
 718     if (rrd->legacy_last_up) {  /* this gets set for version < 3 only */
 719         free(rrd->live_head);
 720     }
 721 }
 722 #else
 723 void rrd_free(
 724     rrd_t *rrd)
 725 {
 726     free(rrd->live_head);
 727     free(rrd->stat_head);
 728     free(rrd->ds_def);
 729     free(rrd->rra_def);
 730     free(rrd->rra_ptr);
 731     free(rrd->pdp_prep);
 732     free(rrd->cdp_prep);
 733     free(rrd->rrd_value);
 734 }
 735 #endif
 736
 737
 738 /* routine used by external libraries to free memory allocated by
 739  * rrd library */
 740
 741 void rrd_freemem(
 742     void *mem)
 743 {
 744     free(mem);
 745 }
 746
 747 /*
 748  * rra_update informs us about the RRAs being updated
 749  * The low level storage API may use this information for
 750  * aligning RRAs within stripes, or other performance enhancements
 751  */
 752 void rrd_notify_row(
 753     rrd_file_t UNUSED(*rrd_file),
 754     int UNUSED(rra_idx),
 755     unsigned long UNUSED(rra_row),
 756     time_t UNUSED(rra_time))
 757 {
 758 }
 759
 760 /*
 761  * This function is called when creating a new RRD
 762  * The storage implementation can use this opportunity to select
 763  * a sensible starting row within the file.
 764  * The default implementation is random, to ensure that all RRAs
 765  * don't change to a new disk block at the same time
 766  */
 767 unsigned long rrd_select_initial_row(
 768     rrd_file_t UNUSED(*rrd_file),
 769     int UNUSED(rra_idx),
 770     rra_def_t *rra
 771     )
 772 {
 773     return rrd_random() % rra->row_cnt;
 774 }