bluesky/log.c

   1 /* Blue Sky: File Systems in the Cloud
   2  *
   3  * Copyright (C) 2010  The Regents of the University of California
   4  * Written by Michael Vrable <mvrable@cs.ucsd.edu>
   5  *
   6  * TODO: Licensing
   7  */
   8
   9 #define _GNU_SOURCE
  10 #define _ATFILE_SOURCE
  11
  12 #include <stdio.h>
  13 #include <stdint.h>
  14 #include <stdlib.h>
  15 #include <glib.h>
  16 #include <string.h>
  17 #include <errno.h>
  18 #include <sys/types.h>
  19 #include <sys/stat.h>
  20 #include <fcntl.h>
  21 #include <unistd.h>
  22 #include <sys/mman.h>
  23
  24 #include "bluesky-private.h"
  25
  26 /* The logging layer for BlueSky.  This is used to write filesystem changes
  27  * durably to disk so that they can be recovered in the event of a system
  28  * crash. */
  29
  30 /* The logging layer takes care out writing out a sequence of log records to
  31  * disk.  On disk, each record consists of a header, a data payload, and a
  32  * footer.  The footer contains a checksum of the record, meant to help with
  33  * identifying corrupt log records (we would assume because the log record was
  34  * only incompletely written out before a crash, which should only happen for
  35  * log records that were not considered committed). */
  36
  37 // Rough size limit for a log segment.  This is not a firm limit and there are
  38 // no absolute guarantees on the size of a log segment.
  39 #define LOG_SEGMENT_SIZE (1 << 22)
  40
  41 #define HEADER_MAGIC 0x676f4c0a
  42 #define FOOTER_MAGIC 0x2e435243
  43
  44 static size_t readbuf(int fd, char *buf, size_t len)
  45 {
  46     size_t total_bytes = 0;
  47     while (len > 0) {
  48         ssize_t bytes = read(fd, buf, len);
  49         if (bytes < 0 && errno == EINTR)
  50             continue;
  51         g_assert(bytes >= 0);
  52         if (bytes == 0)
  53             break;
  54         buf += bytes;
  55         len -= bytes;
  56     }
  57     return total_bytes;
  58 }
  59
  60 static void writebuf(int fd, const char *buf, size_t len)
  61 {
  62     while (len > 0) {
  63         ssize_t written;
  64         written = write(fd, buf, len);
  65         if (written < 0 && errno == EINTR)
  66             continue;
  67         g_assert(written >= 0);
  68         buf += written;
  69         len -= written;
  70     }
  71 }
  72
  73 static void log_commit(BlueSkyLog *log)
  74 {
  75     int batchsize = 0;
  76
  77     if (log->fd < 0)
  78         return;
  79
  80     fdatasync(log->fd);
  81
  82     /* Update disk-space usage statistics for the journal file. */
  83     g_atomic_int_add(&log->disk_used, -log->current_log->disk_used);
  84     struct stat statbuf;
  85     if (fstat(log->fd, &statbuf) >= 0) {
  86         /* Convert from 512-byte blocks to 1-kB units */
  87         log->current_log->disk_used = (statbuf.st_blocks + 1) / 2;
  88     }
  89     g_atomic_int_add(&log->disk_used, log->current_log->disk_used);
  90
  91     while (log->committed != NULL) {
  92         BlueSkyCloudLog *item = (BlueSkyCloudLog *)log->committed->data;
  93         g_mutex_lock(item->lock);
  94         bluesky_cloudlog_stats_update(item, -1);
  95         item->pending_write &= ~CLOUDLOG_JOURNAL;
  96         item->location_flags
  97             = (item->location_flags & ~CLOUDLOG_UNCOMMITTED) | CLOUDLOG_JOURNAL;
  98         bluesky_cloudlog_stats_update(item, 1);
  99         g_cond_signal(item->cond);
 100         g_mutex_unlock(item->lock);
 101         log->committed = g_slist_delete_link(log->committed, log->committed);
 102         bluesky_cloudlog_unref(item);
 103         batchsize++;
 104     }
 105
 106     if (bluesky_verbose && batchsize > 1)
 107         g_print("Log batch size: %d\n", batchsize);
 108 }
 109
 110 static gboolean log_open(BlueSkyLog *log)
 111 {
 112     char logname[64];
 113
 114     if (log->fd >= 0) {
 115         log_commit(log);
 116         close(log->fd);
 117         log->seq_num++;
 118         log->fd = -1;
 119     }
 120
 121     if (log->current_log != NULL) {
 122         bluesky_cachefile_unref(log->current_log);
 123         log->current_log = NULL;
 124     }
 125
 126     while (log->fd < 0) {
 127         g_snprintf(logname, sizeof(logname), "journal-%08d", log->seq_num);
 128         log->fd = openat(log->dirfd, logname, O_CREAT|O_WRONLY|O_EXCL, 0600);
 129         if (log->fd < 0 && errno == EEXIST) {
 130             fprintf(stderr, "Log file %s already exists...\n", logname);
 131             log->seq_num++;
 132             continue;
 133         } else if (log->fd < 0) {
 134             fprintf(stderr, "Error opening logfile %s: %m\n", logname);
 135             return FALSE;
 136         }
 137     }
 138
 139     log->current_log = bluesky_cachefile_lookup(log->fs, -1, log->seq_num,
 140                                                 FALSE);
 141     g_assert(log->current_log != NULL);
 142     g_mutex_unlock(log->current_log->lock);
 143
 144     if (ftruncate(log->fd, LOG_SEGMENT_SIZE) < 0) {
 145         fprintf(stderr, "Unable to truncate logfile %s: %m\n", logname);
 146     }
 147     fsync(log->fd);
 148     fsync(log->dirfd);
 149     return TRUE;
 150 }
 151
 152 /* All log writes (at least for a single log) are made by one thread, so we
 153  * don't need to worry about concurrent access to the log file.  Log items to
 154  * write are pulled off a queue (and so may be posted by any thread).
 155  * fdatasync() is used to ensure the log items are stable on disk.
 156  *
 157  * The log is broken up into separate files, roughly of size LOG_SEGMENT_SIZE
 158  * each.  If a log segment is not currently open (log->fd is negative), a new
 159  * one is created.  Log segment filenames are assigned sequentially.
 160  *
 161  * Log replay ought to be implemented later, and ought to set the initial
 162  * sequence number appropriately.
 163  */
 164 static gpointer log_thread(gpointer d)
 165 {
 166     BlueSkyLog *log = (BlueSkyLog *)d;
 167
 168     while (TRUE) {
 169         if (log->fd < 0) {
 170             if (!log_open(log)) {
 171                 return NULL;
 172             }
 173         }
 174
 175         BlueSkyCloudLog *item
 176             = (BlueSkyCloudLog *)g_async_queue_pop(log->queue);
 177         g_mutex_lock(item->lock);
 178         g_assert(item->data != NULL);
 179
 180         /* The item may have already been written to the journal... */
 181         if ((item->location_flags | item->pending_write) & CLOUDLOG_JOURNAL) {
 182             g_mutex_unlock(item->lock);
 183             bluesky_cloudlog_unref(item);
 184             g_atomic_int_add(&item->data_lock_count, -1);
 185             continue;
 186         }
 187
 188         bluesky_cloudlog_stats_update(item, -1);
 189         item->pending_write |= CLOUDLOG_JOURNAL;
 190         bluesky_cloudlog_stats_update(item, 1);
 191
 192         GString *data1 = g_string_new("");
 193         GString *data2 = g_string_new("");
 194         GString *data3 = g_string_new("");
 195         bluesky_serialize_cloudlog(item, data1, data2, data3);
 196
 197         struct log_header header;
 198         struct log_footer footer;
 199         size_t size = sizeof(header) + sizeof(footer);
 200         size += data1->len + data2->len + data3->len;
 201         off_t offset = 0;
 202         if (log->fd >= 0)
 203             offset = lseek(log->fd, 0, SEEK_CUR);
 204
 205         /* Check whether the item would overflow the allocated journal size.
 206          * If so, start a new log segment.  We only allow oversized log
 207          * segments if they contain a single log entry. */
 208         if (offset + size >= LOG_SEGMENT_SIZE && offset > 0) {
 209             log_open(log);
 210             offset = 0;
 211         }
 212
 213         header.magic = GUINT32_TO_LE(HEADER_MAGIC);
 214         header.offset = GUINT32_TO_LE(offset);
 215         header.size1 = GUINT32_TO_LE(data1->len);
 216         header.size2 = GUINT32_TO_LE(data2->len);
 217         header.size3 = GUINT32_TO_LE(data3->len);
 218         header.type = item->type + '0';
 219         header.id = item->id;
 220         header.inum = GUINT64_TO_LE(item->inum);
 221         footer.magic = GUINT32_TO_LE(FOOTER_MAGIC);
 222
 223         uint32_t crc = BLUESKY_CRC32C_SEED;
 224
 225         writebuf(log->fd, (const char *)&header, sizeof(header));
 226         crc = crc32c(crc, (const char *)&header, sizeof(header));
 227
 228         writebuf(log->fd, data1->str, data1->len);
 229         crc = crc32c(crc, data1->str, data1->len);
 230         writebuf(log->fd, data2->str, data2->len);
 231         crc = crc32c(crc, data2->str, data2->len);
 232         writebuf(log->fd, data3->str, data3->len);
 233         crc = crc32c(crc, data3->str, data3->len);
 234
 235         crc = crc32c(crc, (const char *)&footer,
 236                      sizeof(footer) - sizeof(uint32_t));
 237         footer.crc = crc32c_finalize(crc);
 238         writebuf(log->fd, (const char *)&footer, sizeof(footer));
 239
 240         item->log_seq = log->seq_num;
 241         item->log_offset = offset;
 242         item->log_size = size;
 243         item->data_size = item->data->len;
 244
 245         offset += size;
 246
 247         g_string_free(data1, TRUE);
 248         g_string_free(data2, TRUE);
 249         g_string_free(data3, TRUE);
 250
 251         /* Replace the log item's string data with a memory-mapped copy of the
 252          * data, now that it has been written to the log file.  (Even if it
 253          * isn't yet on disk, it should at least be in the page cache and so
 254          * available to memory map.) */
 255         bluesky_string_unref(item->data);
 256         item->data = NULL;
 257         bluesky_cloudlog_fetch(item);
 258
 259         log->committed = g_slist_prepend(log->committed, item);
 260         g_atomic_int_add(&item->data_lock_count, -1);
 261         g_mutex_unlock(item->lock);
 262
 263         /* Force an if there are no other log items currently waiting to be
 264          * written. */
 265         if (g_async_queue_length(log->queue) <= 0)
 266             log_commit(log);
 267     }
 268
 269     return NULL;
 270 }
 271
 272 BlueSkyLog *bluesky_log_new(const char *log_directory)
 273 {
 274     BlueSkyLog *log = g_new0(BlueSkyLog, 1);
 275
 276     log->log_directory = g_strdup(log_directory);
 277     log->fd = -1;
 278     log->seq_num = 0;
 279     log->queue = g_async_queue_new();
 280     log->mmap_lock = g_mutex_new();
 281     log->mmap_cache = g_hash_table_new(g_str_hash, g_str_equal);
 282
 283     /* Determine the highest-numbered log file, so that we can start writing
 284      * out new journal entries at the next sequence number. */
 285     GDir *dir = g_dir_open(log_directory, 0, NULL);
 286     if (dir != NULL) {
 287         const gchar *file;
 288         while ((file = g_dir_read_name(dir)) != NULL) {
 289             if (strncmp(file, "journal-", 8) == 0) {
 290                 log->seq_num = MAX(log->seq_num, atoi(&file[8]) + 1);
 291             }
 292         }
 293         g_dir_close(dir);
 294         g_print("Starting journal at sequence number %d\n", log->seq_num);
 295     }
 296
 297     log->dirfd = open(log->log_directory, O_DIRECTORY);
 298     if (log->dirfd < 0) {
 299         fprintf(stderr, "Unable to open logging directory: %m\n");
 300         return NULL;
 301     }
 302
 303     g_thread_create(log_thread, log, FALSE, NULL);
 304
 305     return log;
 306 }
 307
 308 void bluesky_log_item_submit(BlueSkyCloudLog *item, BlueSkyLog *log)
 309 {
 310     if (!(item->location_flags & CLOUDLOG_JOURNAL)) {
 311         bluesky_cloudlog_ref(item);
 312         item->location_flags |= CLOUDLOG_UNCOMMITTED;
 313         g_atomic_int_add(&item->data_lock_count, 1);
 314         g_async_queue_push(log->queue, item);
 315     }
 316 }
 317
 318 void bluesky_log_finish_all(GList *log_items)
 319 {
 320     while (log_items != NULL) {
 321         BlueSkyCloudLog *item = (BlueSkyCloudLog *)log_items->data;
 322
 323         g_mutex_lock(item->lock);
 324         while ((item->location_flags & CLOUDLOG_UNCOMMITTED))
 325             g_cond_wait(item->cond, item->lock);
 326         g_mutex_unlock(item->lock);
 327         bluesky_cloudlog_unref(item);
 328
 329         log_items = g_list_delete_link(log_items, log_items);
 330     }
 331 }
 332
 333 /* Return a committed cloud log record that can be used as a watermark for how
 334  * much of the journal has been written. */
 335 BlueSkyCloudLog *bluesky_log_get_commit_point(BlueSkyFS *fs)
 336 {
 337     BlueSkyCloudLog *marker = bluesky_cloudlog_new(fs, NULL);
 338     marker->type = LOGTYPE_JOURNAL_MARKER;
 339     marker->data = bluesky_string_new(g_strdup(""), 0);
 340     bluesky_cloudlog_stats_update(marker, 1);
 341     bluesky_cloudlog_sync(marker);
 342
 343     g_mutex_lock(marker->lock);
 344     while ((marker->pending_write & CLOUDLOG_JOURNAL))
 345         g_cond_wait(marker->cond, marker->lock);
 346     g_mutex_unlock(marker->lock);
 347
 348     return marker;
 349 }
 350
 351 void bluesky_log_write_commit_point(BlueSkyFS *fs, BlueSkyCloudLog *marker)
 352 {
 353     BlueSkyCloudLog *commit = bluesky_cloudlog_new(fs, NULL);
 354     commit->type = LOGTYPE_JOURNAL_CHECKPOINT;
 355
 356     uint32_t seq, offset;
 357     seq = GUINT32_TO_LE(marker->log_seq);
 358     offset = GUINT32_TO_LE(marker->log_offset);
 359     GString *loc = g_string_new("");
 360     g_string_append_len(loc, (const gchar *)&seq, sizeof(seq));
 361     g_string_append_len(loc, (const gchar *)&offset, sizeof(offset));
 362     commit->data = bluesky_string_new_from_gstring(loc);
 363     bluesky_cloudlog_stats_update(commit, 1);
 364     bluesky_cloudlog_sync(commit);
 365
 366     g_mutex_lock(commit->lock);
 367     while ((commit->location_flags & CLOUDLOG_UNCOMMITTED))
 368         g_cond_wait(commit->cond, commit->lock);
 369     g_mutex_unlock(commit->lock);
 370
 371     bluesky_cloudlog_unref(marker);
 372     bluesky_cloudlog_unref(commit);
 373 }
 374
 375 /* Memory-map the given log object into memory (read-only) and return a pointer
 376  * to it. */
 377 static int page_size = 0;
 378
 379 void bluesky_cachefile_unref(BlueSkyCacheFile *cachefile)
 380 {
 381     g_atomic_int_add(&cachefile->refcount, -1);
 382 }
 383
 384 static void cloudlog_fetch_start(BlueSkyCacheFile *cachefile);
 385
 386 /* Find the BlueSkyCacheFile object for the given journal or cloud log segment.
 387  * Returns the object in the locked state and with a reference taken. */
 388 BlueSkyCacheFile *bluesky_cachefile_lookup(BlueSkyFS *fs,
 389                                            int clouddir, int log_seq,
 390                                            gboolean start_fetch)
 391 {
 392     if (page_size == 0) {
 393         page_size = getpagesize();
 394     }
 395
 396     BlueSkyLog *log = fs->log;
 397
 398     struct stat statbuf;
 399     char logname[64];
 400     int type;
 401
 402     // A request for a local log file
 403     if (clouddir < 0) {
 404         sprintf(logname, "journal-%08d", log_seq);
 405         type = CLOUDLOG_JOURNAL;
 406     } else {
 407         sprintf(logname, "log-%08d-%08d", clouddir, log_seq);
 408         type = CLOUDLOG_CLOUD;
 409     }
 410
 411     BlueSkyCacheFile *map;
 412     g_mutex_lock(log->mmap_lock);
 413     map = g_hash_table_lookup(log->mmap_cache, logname);
 414
 415     if (map == NULL
 416         && type == CLOUDLOG_JOURNAL
 417         && fstatat(log->dirfd, logname, &statbuf, 0) < 0) {
 418         /* A stale reference to a journal file which doesn't exist any longer
 419          * because it was reclaimed.  Return NULL. */
 420     } else if (map == NULL) {
 421         if (bluesky_verbose)
 422             g_print("Adding cache file %s\n", logname);
 423
 424         map = g_new0(BlueSkyCacheFile, 1);
 425         map->fs = fs;
 426         map->type = type;
 427         map->lock = g_mutex_new();
 428         map->type = type;
 429         g_mutex_lock(map->lock);
 430         map->cond = g_cond_new();
 431         map->filename = g_strdup(logname);
 432         map->log_dir = clouddir;
 433         map->log_seq = log_seq;
 434         map->log = log;
 435         g_atomic_int_set(&map->mapcount, 0);
 436         g_atomic_int_set(&map->refcount, 0);
 437         map->items = bluesky_rangeset_new();
 438
 439         g_hash_table_insert(log->mmap_cache, map->filename, map);
 440
 441         int fd = openat(log->dirfd, logname, O_WRONLY | O_CREAT, 0600);
 442         if (fd >= 0) {
 443             ftruncate(fd, 5 << 20);     // FIXME
 444             close(fd);
 445         }
 446     } else {
 447         g_mutex_lock(map->lock);
 448     }
 449
 450
 451     /* If the log file is stored in the cloud and has not been fully fetched,
 452      * we may need to initiate a fetch now. */
 453     if (clouddir >= 0 && start_fetch && !map->complete && !map->fetching)
 454         cloudlog_fetch_start(map);
 455
 456     g_mutex_unlock(log->mmap_lock);
 457     if (map != NULL)
 458         g_atomic_int_inc(&map->refcount);
 459     return map;
 460 }
 461
 462 static void robust_pwrite(int fd, const char *buf, ssize_t count, off_t offset)
 463 {
 464     while (count > 0) {
 465         ssize_t written = pwrite(fd, buf, count, offset);
 466         if (written < 0) {
 467             if (errno == EINTR)
 468                 continue;
 469             g_warning("pwrite failure: %m");
 470             return;
 471         }
 472         buf += written;
 473         count -= written;
 474         offset += written;
 475     }
 476 }
 477
 478 static void cloudlog_partial_fetch_complete(BlueSkyStoreAsync *async,
 479                                             BlueSkyCacheFile *cachefile);
 480
 481 static void cloudlog_partial_fetch_start(BlueSkyCacheFile *cachefile,
 482                                          size_t offset, size_t length)
 483 {
 484     g_atomic_int_inc(&cachefile->refcount);
 485     g_print("Starting partial fetch of %s from cloud (%zd + %zd)\n",
 486             cachefile->filename, offset, length);
 487     BlueSkyStoreAsync *async = bluesky_store_async_new(cachefile->fs->store);
 488     async->op = STORE_OP_GET;
 489     async->key = g_strdup(cachefile->filename);
 490     async->start = offset;
 491     async->len = length;
 492     async->profile = bluesky_profile_get();
 493     bluesky_store_async_add_notifier(async,
 494                                      (GFunc)cloudlog_partial_fetch_complete,
 495                                      cachefile);
 496     bluesky_store_async_submit(async);
 497     bluesky_store_async_unref(async);
 498 }
 499
 500 static void cloudlog_partial_fetch_complete(BlueSkyStoreAsync *async,
 501                                             BlueSkyCacheFile *cachefile)
 502 {
 503     g_print("Fetch of %s from cloud complete, status = %d\n",
 504             async->key, async->result);
 505
 506     g_mutex_lock(cachefile->lock);
 507     if (async->result >= 0) {
 508         if (async->len == 0) {
 509             g_print("Complete object was fetched.\n");
 510             cachefile->complete = TRUE;
 511         }
 512
 513         /* Descrypt items fetched and write valid items out to the local log,
 514          * but only if they do not overlap existing objects.  This will protect
 515          * against an attack by the cloud provider where one valid object is
 516          * moved to another offset and used to overwrite data that we already
 517          * have fetched. */
 518         BlueSkyRangeset *items = bluesky_rangeset_new();
 519         int fd = openat(cachefile->log->dirfd, cachefile->filename, O_WRONLY);
 520         if (fd >= 0) {
 521             gboolean allow_unauth;
 522             async->data = bluesky_string_dup(async->data);
 523             allow_unauth = cachefile->log_dir == BLUESKY_CLOUD_DIR_CLEANER;
 524             bluesky_cloudlog_decrypt(async->data->data, async->data->len,
 525                                      cachefile->fs->keys, items, allow_unauth);
 526             uint64_t item_offset = 0;
 527             while (TRUE) {
 528                 const BlueSkyRangesetItem *item;
 529                 item = bluesky_rangeset_lookup_next(items, item_offset);
 530                 if (item == NULL)
 531                     break;
 532                 if (bluesky_verbose) {
 533                     g_print("  item offset from range request: %d\n",
 534                             (int)(item->start + async->start));
 535                 }
 536                 if (bluesky_rangeset_insert(cachefile->items,
 537                                             async->start + item->start,
 538                                             item->length, item->data))
 539                 {
 540                     robust_pwrite(fd, async->data->data + item->start,
 541                                   item->length, async->start + item->start);
 542                 } else {
 543                     g_print("    item overlaps existing data!\n");
 544                 }
 545                 item_offset = item->start + 1;
 546             }
 547             /* TODO: Iterate over items and merge into cached file. */
 548             close(fd);
 549         } else {
 550             g_warning("Unable to open and write to cache file %s: %m",
 551                       cachefile->filename);
 552         }
 553     } else {
 554         g_print("Error fetching from cloud, retrying...\n");
 555         cloudlog_partial_fetch_start(cachefile, async->start, async->len);
 556     }
 557
 558     /* Update disk-space usage statistics, since the writes above may have
 559      * consumed more space. */
 560     g_atomic_int_add(&cachefile->log->disk_used, -cachefile->disk_used);
 561     struct stat statbuf;
 562     if (fstatat(cachefile->log->dirfd, cachefile->filename, &statbuf, 0) >= 0) {
 563         /* Convert from 512-byte blocks to 1-kB units */
 564         cachefile->disk_used = (statbuf.st_blocks + 1) / 2;
 565     }
 566     g_atomic_int_add(&cachefile->log->disk_used, cachefile->disk_used);
 567
 568     bluesky_cachefile_unref(cachefile);
 569     g_cond_broadcast(cachefile->cond);
 570     g_mutex_unlock(cachefile->lock);
 571 }
 572
 573 static void cloudlog_fetch_start(BlueSkyCacheFile *cachefile)
 574 {
 575     g_atomic_int_inc(&cachefile->refcount);
 576     cachefile->fetching = TRUE;
 577     g_print("Starting fetch of %s from cloud\n", cachefile->filename);
 578     BlueSkyStoreAsync *async = bluesky_store_async_new(cachefile->fs->store);
 579     async->op = STORE_OP_GET;
 580     async->key = g_strdup(cachefile->filename);
 581     async->profile = bluesky_profile_get();
 582     bluesky_store_async_add_notifier(async,
 583                                      (GFunc)cloudlog_partial_fetch_complete,
 584                                      cachefile);
 585     bluesky_store_async_submit(async);
 586     bluesky_store_async_unref(async);
 587 }
 588
 589 /* Map and return a read-only version of a byte range from a cached file.  The
 590  * CacheFile object must be locked. */
 591 BlueSkyRCStr *bluesky_cachefile_map_raw(BlueSkyCacheFile *cachefile,
 592                                         off_t offset, size_t size)
 593 {
 594     cachefile->atime = bluesky_get_current_time();
 595
 596     /* Easy case: the needed data is already in memory */
 597     if (cachefile->addr != NULL && offset + size <= cachefile->len)
 598         return bluesky_string_new_from_mmap(cachefile, offset, size);
 599
 600     int fd = openat(cachefile->log->dirfd, cachefile->filename, O_RDONLY);
 601     if (fd < 0) {
 602         fprintf(stderr, "Error opening logfile %s: %m\n",
 603                 cachefile->filename);
 604         return NULL;
 605     }
 606
 607     off_t length = lseek(fd, 0, SEEK_END);
 608     if (offset + size > length) {
 609         close(fd);
 610         return NULL;
 611     }
 612
 613     /* File is not mapped in memory.  Map the entire file in, then return a
 614      * pointer to just the required data. */
 615     if (cachefile->addr == NULL) {
 616         cachefile->addr = (const char *)mmap(NULL, length, PROT_READ,
 617                                              MAP_SHARED, fd, 0);
 618         cachefile->len = length;
 619         g_atomic_int_inc(&cachefile->refcount);
 620
 621         close(fd);
 622         return bluesky_string_new_from_mmap(cachefile, offset, size);
 623     }
 624
 625     /* Otherwise, the file was mapped in but doesn't cover the data we need.
 626      * This shouldn't happen much, if at all, but if it does just read the data
 627      * we need directly from the file.  We lose memory-management benefits of
 628      * using mmapped data, but otherwise this works. */
 629     char *buf = g_malloc(size);
 630     size_t actual_size = readbuf(fd, buf, size);
 631     close(fd);
 632     if (actual_size != size) {
 633         g_free(buf);
 634         return NULL;
 635     } else {
 636         return bluesky_string_new(buf, size);
 637     }
 638 }
 639
 640 /* The arguments are mostly straightforward.  log_dir is -1 for access from the
 641  * journal, and non-negative for access to a cloud log segment.  map_data
 642  * should be TRUE for the case that are mapping just the data of an item where
 643  * we have already parsed the item headers; this surpresses the error when the
 644  * access is not to the first bytes of the item. */
 645 BlueSkyRCStr *bluesky_log_map_object(BlueSkyCloudLog *item, gboolean map_data)
 646 {
 647     BlueSkyFS *fs = item->fs;
 648     BlueSkyCacheFile *map = NULL;
 649     BlueSkyRCStr *str = NULL;
 650     int location = 0;
 651     size_t file_offset = 0, file_size = 0;
 652     gboolean range_request = TRUE;
 653
 654     if (page_size == 0) {
 655         page_size = getpagesize();
 656     }
 657
 658     bluesky_cloudlog_stats_update(item, -1);
 659
 660     /* First, check to see if the journal still contains a copy of the item and
 661      * if so use that. */
 662     if ((item->location_flags | item->pending_write) & CLOUDLOG_JOURNAL) {
 663         map = bluesky_cachefile_lookup(fs, -1, item->log_seq, TRUE);
 664         if (map != NULL) {
 665             location = CLOUDLOG_JOURNAL;
 666             file_offset = item->log_offset;
 667             file_size = item->log_size;
 668         }
 669     }
 670
 671     if (location == 0 && (item->location_flags & CLOUDLOG_CLOUD)) {
 672         item->location_flags &= ~CLOUDLOG_JOURNAL;
 673         map = bluesky_cachefile_lookup(fs,
 674                                        item->location.directory,
 675                                        item->location.sequence,
 676                                        !range_request);
 677         if (map == NULL) {
 678             g_warning("Unable to remap cloud log segment!");
 679             goto exit1;
 680         }
 681         location = CLOUDLOG_CLOUD;
 682         file_offset = item->location.offset;
 683         file_size = item->location.size;
 684     }
 685
 686     /* Log segments fetched from the cloud might only be partially-fetched.
 687      * Check whether the object we are interested in is available. */
 688     if (location == CLOUDLOG_CLOUD) {
 689         while (TRUE) {
 690             const BlueSkyRangesetItem *rangeitem;
 691             rangeitem = bluesky_rangeset_lookup(map->items, file_offset);
 692             if (rangeitem != NULL && (rangeitem->start != file_offset
 693                                       || rangeitem->length != file_size)) {
 694                 g_warning("log-%d: Item offset %zd seems to be invalid!",
 695                           (int)item->location.sequence, file_offset);
 696                 goto exit2;
 697             }
 698             if (rangeitem == NULL) {
 699                 if (bluesky_verbose) {
 700                     g_print("Item at offset 0x%zx not available, need to fetch.\n",
 701                             file_offset);
 702                 }
 703                 if (range_request) {
 704                     uint64_t start = file_offset, length = file_size, end;
 705                     if (map->prefetches != NULL)
 706                         bluesky_rangeset_get_extents(map->prefetches,
 707                                                      &start, &length);
 708                     start = MIN(start, file_offset);
 709                     end = MAX(start + length, file_offset + file_size);
 710                     length = end - start;
 711                     cloudlog_partial_fetch_start(map, start, length);
 712                     if (map->prefetches != NULL) {
 713                         bluesky_rangeset_free(map->prefetches);
 714                         map->prefetches = NULL;
 715                     }
 716                 }
 717                 g_cond_wait(map->cond, map->lock);
 718             } else if (rangeitem->start == file_offset
 719                        && rangeitem->length == file_size) {
 720                 if (bluesky_verbose)
 721                     g_print("Item %zd now available.\n", file_offset);
 722                 break;
 723             }
 724         }
 725     }
 726
 727     if (map_data) {
 728         if (location == CLOUDLOG_JOURNAL)
 729             file_offset += sizeof(struct log_header);
 730         else
 731             file_offset += sizeof(struct cloudlog_header);
 732
 733         file_size = item->data_size;
 734     }
 735     str = bluesky_cachefile_map_raw(map, file_offset, file_size);
 736
 737 exit2:
 738     bluesky_cachefile_unref(map);
 739     g_mutex_unlock(map->lock);
 740 exit1:
 741     bluesky_cloudlog_stats_update(item, 1);
 742     return str;
 743 }
 744
 745 void bluesky_mmap_unref(BlueSkyCacheFile *mmap)
 746 {
 747     if (mmap == NULL)
 748         return;
 749
 750     if (g_atomic_int_dec_and_test(&mmap->mapcount)) {
 751         g_mutex_lock(mmap->lock);
 752         if (mmap->addr != NULL) {
 753             if (bluesky_verbose)
 754                 g_print("Unmapped log segment %d...\n", mmap->log_seq);
 755             munmap((void *)mmap->addr, mmap->len);
 756             mmap->addr = NULL;
 757             g_atomic_int_add(&mmap->refcount, -1);
 758         }
 759         g_mutex_unlock(mmap->lock);
 760     }
 761     g_assert(g_atomic_int_get(&mmap->mapcount) >= 0);
 762 }
 763
 764 /******************************* JOURNAL REPLAY *******************************
 765  * The journal replay code is used to recover filesystem state after a
 766  * filesystem restart.  We first look for the most recent commit record in the
 767  * journal, which indicates the point before which all data in the journal has
 768  * also been committed to the cloud.  Then, we read in all data in the log past
 769  * that point.
 770  */
 771 static GList *directory_contents(const char *dirname)
 772 {
 773     GList *contents = NULL;
 774     GDir *dir = g_dir_open(dirname, 0, NULL);
 775     if (dir == NULL) {
 776         g_warning("Unable to open journal directory: %s", dirname);
 777         return NULL;
 778     }
 779
 780     const gchar *file;
 781     while ((file = g_dir_read_name(dir)) != NULL) {
 782         if (strncmp(file, "journal-", 8) == 0)
 783             contents = g_list_prepend(contents, g_strdup(file));
 784     }
 785     g_dir_close(dir);
 786
 787     contents = g_list_sort(contents, (GCompareFunc)strcmp);
 788
 789     return contents;
 790 }
 791
 792 static gboolean validate_journal_item(const char *buf, size_t len, off_t offset)
 793 {
 794     const struct log_header *header;
 795     const struct log_footer *footer;
 796
 797     if (offset + sizeof(struct log_header) + sizeof(struct log_footer) > len)
 798         return FALSE;
 799
 800     header = (const struct log_header *)(buf + offset);
 801     if (GUINT32_FROM_LE(header->magic) != HEADER_MAGIC)
 802         return FALSE;
 803     if (GUINT32_FROM_LE(header->offset) != offset)
 804         return FALSE;
 805     size_t size = GUINT32_FROM_LE(header->size1)
 806                    + GUINT32_FROM_LE(header->size2)
 807                    + GUINT32_FROM_LE(header->size3);
 808
 809     off_t footer_offset = offset + sizeof(struct log_header) + size;
 810     if (footer_offset + sizeof(struct log_footer) > len)
 811         return FALSE;
 812     footer = (const struct log_footer *)(buf + footer_offset);
 813
 814     if (GUINT32_FROM_LE(footer->magic) != FOOTER_MAGIC)
 815         return FALSE;
 816
 817     uint32_t crc = crc32c(BLUESKY_CRC32C_SEED, buf + offset,
 818                           sizeof(struct log_header) + sizeof(struct log_footer)
 819                           + size);
 820     if (crc != BLUESKY_CRC32C_VALIDATOR) {
 821         g_warning("Journal entry failed to validate: CRC %08x != %08x",
 822                   crc, BLUESKY_CRC32C_VALIDATOR);
 823         return FALSE;
 824     }
 825
 826     return TRUE;
 827 }
 828
 829 /* Scan through a journal segment to extract correctly-written items (those
 830  * that pass sanity checks and have a valid checksum). */
 831 static void bluesky_replay_scan_journal(const char *buf, size_t len,
 832                                         uint32_t *seq, uint32_t *start_offset)
 833 {
 834     const struct log_header *header;
 835     off_t offset = 0;
 836
 837     while (validate_journal_item(buf, len, offset)) {
 838         header = (const struct log_header *)(buf + offset);
 839         size_t size = GUINT32_FROM_LE(header->size1)
 840                        + GUINT32_FROM_LE(header->size2)
 841                        + GUINT32_FROM_LE(header->size3);
 842
 843         if (header->type - '0' == LOGTYPE_JOURNAL_CHECKPOINT) {
 844             const uint32_t *data = (const uint32_t *)((const char *)header + sizeof(struct log_header));
 845             *seq = GUINT32_FROM_LE(data[0]);
 846             *start_offset = GUINT32_FROM_LE(data[1]);
 847         }
 848
 849         offset += sizeof(struct log_header) + size + sizeof(struct log_footer);
 850     }
 851 }
 852
 853 static void reload_item(BlueSkyCloudLog *log_item,
 854                         const char *data,
 855                         size_t len1, size_t len2, size_t len3)
 856 {
 857     BlueSkyFS *fs = log_item->fs;
 858     /*const char *data1 = data;*/
 859     const BlueSkyCloudID *data2
 860         = (const BlueSkyCloudID *)(data + len1);
 861     /*const BlueSkyCloudPointer *data3
 862         = (const BlueSkyCloudPointer *)(data + len1 + len2);*/
 863
 864     bluesky_cloudlog_stats_update(log_item, -1);
 865     bluesky_string_unref(log_item->data);
 866     log_item->data = NULL;
 867     log_item->location_flags = CLOUDLOG_JOURNAL;
 868     bluesky_cloudlog_stats_update(log_item, 1);
 869
 870     BlueSkyCloudID id0;
 871     memset(&id0, 0, sizeof(id0));
 872
 873     int link_count = len2 / sizeof(BlueSkyCloudID);
 874     GArray *new_links = g_array_new(FALSE, TRUE, sizeof(BlueSkyCloudLog *));
 875     for (int i = 0; i < link_count; i++) {
 876         BlueSkyCloudID id = data2[i];
 877         BlueSkyCloudLog *ref = NULL;
 878         if (memcmp(&id, &id0, sizeof(BlueSkyCloudID)) != 0) {
 879             g_mutex_lock(fs->lock);
 880             ref = g_hash_table_lookup(fs->locations, &id);
 881             if (ref != NULL) {
 882                 bluesky_cloudlog_ref(ref);
 883             }
 884             g_mutex_unlock(fs->lock);
 885         }
 886         g_array_append_val(new_links, ref);
 887     }
 888
 889     for (int i = 0; i < log_item->links->len; i++) {
 890         BlueSkyCloudLog *c = g_array_index(log_item->links,
 891                                            BlueSkyCloudLog *, i);
 892         bluesky_cloudlog_unref(c);
 893     }
 894     g_array_unref(log_item->links);
 895     log_item->links = new_links;
 896 }
 897
 898 static void bluesky_replay_scan_journal2(BlueSkyFS *fs, GList **objects,
 899                                          int log_seq, int start_offset,
 900                                          const char *buf, size_t len)
 901 {
 902     const struct log_header *header;
 903     off_t offset = start_offset;
 904
 905     while (validate_journal_item(buf, len, offset)) {
 906         header = (const struct log_header *)(buf + offset);
 907         g_print("In replay found valid item at offset %zd\n", offset);
 908         size_t size = GUINT32_FROM_LE(header->size1)
 909                        + GUINT32_FROM_LE(header->size2)
 910                        + GUINT32_FROM_LE(header->size3);
 911
 912         BlueSkyCloudLog *log_item = bluesky_cloudlog_get(fs, header->id);
 913         g_mutex_lock(log_item->lock);
 914         *objects = g_list_prepend(*objects, log_item);
 915
 916         log_item->inum = GUINT64_FROM_LE(header->inum);
 917         reload_item(log_item, buf + offset + sizeof(struct log_header),
 918                     GUINT32_FROM_LE(header->size1),
 919                     GUINT32_FROM_LE(header->size2),
 920                     GUINT32_FROM_LE(header->size3));
 921         log_item->log_seq = log_seq;
 922         log_item->log_offset = offset + sizeof(struct log_header);
 923         log_item->log_size = header->size1;
 924
 925         bluesky_string_unref(log_item->data);
 926         log_item->data = bluesky_string_new(g_memdup(buf + offset + sizeof(struct log_header), GUINT32_FROM_LE(header->size1)), GUINT32_FROM_LE(header->size1));
 927
 928         /* For any inodes which were read from the journal, deserialize the
 929          * inode information, overwriting any old inode data. */
 930         if (header->type - '0' == LOGTYPE_INODE) {
 931             uint64_t inum = GUINT64_FROM_LE(header->inum);
 932             BlueSkyInode *inode;
 933             g_mutex_lock(fs->lock);
 934             inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
 935             if (inode == NULL) {
 936                 inode = bluesky_new_inode(inum, fs, BLUESKY_PENDING);
 937                 inode->change_count = 0;
 938                 bluesky_insert_inode(fs, inode);
 939             }
 940             g_mutex_lock(inode->lock);
 941             bluesky_inode_free_resources(inode);
 942             if (!bluesky_deserialize_inode(inode, log_item))
 943                 g_print("Error deserializing inode %"PRIu64"\n", inum);
 944             fs->next_inum = MAX(fs->next_inum, inum + 1);
 945             bluesky_list_unlink(&fs->accessed_list, inode->accessed_list);
 946             inode->accessed_list = bluesky_list_prepend(&fs->accessed_list, inode);
 947             bluesky_list_unlink(&fs->dirty_list, inode->dirty_list);
 948             inode->dirty_list = bluesky_list_prepend(&fs->dirty_list, inode);
 949             bluesky_list_unlink(&fs->unlogged_list, inode->unlogged_list);
 950             inode->unlogged_list = NULL;
 951             inode->change_cloud = inode->change_commit;
 952             bluesky_cloudlog_ref(log_item);
 953             bluesky_cloudlog_unref(inode->committed_item);
 954             inode->committed_item = log_item;
 955             g_mutex_unlock(inode->lock);
 956             g_mutex_unlock(fs->lock);
 957         }
 958         bluesky_string_unref(log_item->data);
 959         log_item->data = NULL;
 960         g_mutex_unlock(log_item->lock);
 961
 962         offset += sizeof(struct log_header) + size + sizeof(struct log_footer);
 963     }
 964 }
 965
 966 void bluesky_replay(BlueSkyFS *fs)
 967 {
 968     BlueSkyLog *log = fs->log;
 969     GList *logfiles = directory_contents(log->log_directory);
 970
 971     /* Scan through log files in reverse order to find the most recent commit
 972      * record. */
 973     logfiles = g_list_reverse(logfiles);
 974     uint32_t seq_num = 0, start_offset = 0;
 975     while (logfiles != NULL) {
 976         char *filename = g_strdup_printf("%s/%s", log->log_directory,
 977                                          (char *)logfiles->data);
 978         g_print("Scanning file %s\n", filename);
 979         GMappedFile *map = g_mapped_file_new(filename, FALSE, NULL);
 980         if (map == NULL) {
 981             g_warning("Mapping logfile %s failed!\n", filename);
 982         } else {
 983             bluesky_replay_scan_journal(g_mapped_file_get_contents(map),
 984                                         g_mapped_file_get_length(map),
 985                                         &seq_num, &start_offset);
 986             g_mapped_file_unref(map);
 987         }
 988         g_free(filename);
 989
 990         g_free(logfiles->data);
 991         logfiles = g_list_delete_link(logfiles, logfiles);
 992         if (seq_num != 0 || start_offset != 0)
 993             break;
 994     }
 995     g_list_foreach(logfiles, (GFunc)g_free, NULL);
 996     g_list_free(logfiles);
 997
 998     /* Now, scan forward starting from the given point in the log to
 999      * reconstruct all filesystem state.  As we reload objects we hold a
1000      * reference to each loaded object.  At the end we free all these
1001      * references, so that any objects which were not linked into persistent
1002      * filesystem data structures are freed. */
1003     GList *objects = NULL;
1004     while (TRUE) {
1005         char *filename = g_strdup_printf("%s/journal-%08d",
1006                                          log->log_directory, seq_num);
1007         g_print("Replaying file %s from offset %d\n", filename, start_offset);
1008         GMappedFile *map = g_mapped_file_new(filename, FALSE, NULL);
1009         g_free(filename);
1010         if (map == NULL) {
1011             g_warning("Mapping logfile failed, assuming end of journal\n");
1012             break;
1013         }
1014
1015         bluesky_replay_scan_journal2(fs, &objects, seq_num, start_offset,
1016                                      g_mapped_file_get_contents(map),
1017                                      g_mapped_file_get_length(map));
1018         g_mapped_file_unref(map);
1019         seq_num++;
1020         start_offset = 0;
1021     }
1022
1023     while (objects != NULL) {
1024         bluesky_cloudlog_unref((BlueSkyCloudLog *)objects->data);
1025         objects = g_list_delete_link(objects, objects);
1026     }
1027 }