Add code in the proxy cleaner component to iterate over new inodes.
[bluesky.git] / 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
447         // If the log file is stored in the cloud, we may need to fetch it
448         if (clouddir >= 0 && start_fetch)
449             cloudlog_fetch_start(map);
450     } else {
451         g_mutex_lock(map->lock);
452     }
453
454     g_mutex_unlock(log->mmap_lock);
455     if (map != NULL)
456         g_atomic_int_inc(&map->refcount);
457     return map;
458 }
459
460 static void robust_pwrite(int fd, const char *buf, ssize_t count, off_t offset)
461 {
462     while (count > 0) {
463         ssize_t written = pwrite(fd, buf, count, offset);
464         if (written < 0) {
465             if (errno == EINTR)
466                 continue;
467             g_warning("pwrite failure: %m");
468             return;
469         }
470         buf += written;
471         count -= written;
472         offset += written;
473     }
474 }
475
476 static void cloudlog_partial_fetch_complete(BlueSkyStoreAsync *async,
477                                             BlueSkyCacheFile *cachefile);
478
479 static void cloudlog_partial_fetch_start(BlueSkyCacheFile *cachefile,
480                                          size_t offset, size_t length)
481 {
482     g_atomic_int_inc(&cachefile->refcount);
483     g_print("Starting fetch of %s from cloud\n", cachefile->filename);
484     BlueSkyStoreAsync *async = bluesky_store_async_new(cachefile->fs->store);
485     async->op = STORE_OP_GET;
486     async->key = g_strdup(cachefile->filename);
487     async->start = offset;
488     async->len = length;
489     async->profile = bluesky_profile_get();
490     bluesky_store_async_add_notifier(async,
491                                      (GFunc)cloudlog_partial_fetch_complete,
492                                      cachefile);
493     bluesky_store_async_submit(async);
494     bluesky_store_async_unref(async);
495 }
496
497 static void cloudlog_partial_fetch_complete(BlueSkyStoreAsync *async,
498                                             BlueSkyCacheFile *cachefile)
499 {
500     g_print("Fetch of %s from cloud complete, status = %d\n",
501             async->key, async->result);
502
503     g_mutex_lock(cachefile->lock);
504     if (async->result >= 0) {
505         if (async->len == 0) {
506             g_print("Complete object was fetched.\n");
507             cachefile->complete = TRUE;
508         }
509
510         /* Descrypt items fetched and write valid items out to the local log,
511          * but only if they do not overlap existing objects.  This will protect
512          * against an attack by the cloud provider where one valid object is
513          * moved to another offset and used to overwrite data that we already
514          * have fetched. */
515         BlueSkyRangeset *items = bluesky_rangeset_new();
516         int fd = openat(cachefile->log->dirfd, cachefile->filename, O_WRONLY);
517         if (fd >= 0) {
518             gboolean allow_unauth;
519             async->data = bluesky_string_dup(async->data);
520             allow_unauth = cachefile->log_dir == BLUESKY_CLOUD_DIR_CLEANER;
521             bluesky_cloudlog_decrypt(async->data->data, async->data->len,
522                                      cachefile->fs->keys, items, allow_unauth);
523             uint64_t item_offset = 0;
524             while (TRUE) {
525                 const BlueSkyRangesetItem *item;
526                 item = bluesky_rangeset_lookup_next(items, item_offset);
527                 if (item == NULL)
528                     break;
529                 if (bluesky_verbose) {
530                     g_print("  item offset from range request: %d\n",
531                             (int)(item->start + async->start));
532                 }
533                 if (bluesky_rangeset_insert(cachefile->items,
534                                             async->start + item->start,
535                                             item->length, item->data))
536                 {
537                     robust_pwrite(fd, async->data->data + item->start,
538                                   item->length, async->start + item->start);
539                 } else {
540                     g_print("    item overlaps existing data!\n");
541                 }
542                 item_offset = item->start + 1;
543             }
544             /* TODO: Iterate over items and merge into cached file. */
545             close(fd);
546         } else {
547             g_warning("Unable to open and write to cache file %s: %m",
548                       cachefile->filename);
549         }
550     } else {
551         g_print("Error fetching from cloud, retrying...\n");
552         cloudlog_partial_fetch_start(cachefile, async->start, async->len);
553     }
554
555     /* Update disk-space usage statistics, since the writes above may have
556      * consumed more space. */
557     g_atomic_int_add(&cachefile->log->disk_used, -cachefile->disk_used);
558     struct stat statbuf;
559     if (fstatat(cachefile->log->dirfd, cachefile->filename, &statbuf, 0) >= 0) {
560         /* Convert from 512-byte blocks to 1-kB units */
561         cachefile->disk_used = (statbuf.st_blocks + 1) / 2;
562     }
563     g_atomic_int_add(&cachefile->log->disk_used, cachefile->disk_used);
564
565     bluesky_cachefile_unref(cachefile);
566     g_cond_broadcast(cachefile->cond);
567     g_mutex_unlock(cachefile->lock);
568 }
569
570 static void cloudlog_fetch_start(BlueSkyCacheFile *cachefile)
571 {
572     g_atomic_int_inc(&cachefile->refcount);
573     cachefile->fetching = TRUE;
574     g_print("Starting fetch of %s from cloud\n", cachefile->filename);
575     BlueSkyStoreAsync *async = bluesky_store_async_new(cachefile->fs->store);
576     async->op = STORE_OP_GET;
577     async->key = g_strdup(cachefile->filename);
578     async->profile = bluesky_profile_get();
579     bluesky_store_async_add_notifier(async,
580                                      (GFunc)cloudlog_partial_fetch_complete,
581                                      cachefile);
582     bluesky_store_async_submit(async);
583     bluesky_store_async_unref(async);
584 }
585
586 /* Map and return a read-only version of a byte range from a cached file.  The
587  * CacheFile object must be locked. */
588 BlueSkyRCStr *bluesky_cachefile_map_raw(BlueSkyCacheFile *cachefile,
589                                         off_t offset, size_t size)
590 {
591     cachefile->atime = bluesky_get_current_time();
592
593     /* Easy case: the needed data is already in memory */
594     if (cachefile->addr != NULL && offset + size <= cachefile->len)
595         return bluesky_string_new_from_mmap(cachefile, offset, size);
596
597     int fd = openat(cachefile->log->dirfd, cachefile->filename, O_RDONLY);
598     if (fd < 0) {
599         fprintf(stderr, "Error opening logfile %s: %m\n",
600                 cachefile->filename);
601         return NULL;
602     }
603
604     off_t length = lseek(fd, 0, SEEK_END);
605     if (offset + size > length) {
606         close(fd);
607         return NULL;
608     }
609
610     /* File is not mapped in memory.  Map the entire file in, then return a
611      * pointer to just the required data. */
612     if (cachefile->addr == NULL) {
613         cachefile->addr = (const char *)mmap(NULL, length, PROT_READ,
614                                              MAP_SHARED, fd, 0);
615         cachefile->len = length;
616         g_atomic_int_inc(&cachefile->refcount);
617
618         close(fd);
619         return bluesky_string_new_from_mmap(cachefile, offset, size);
620     }
621
622     /* Otherwise, the file was mapped in but doesn't cover the data we need.
623      * This shouldn't happen much, if at all, but if it does just read the data
624      * we need directly from the file.  We lose memory-management benefits of
625      * using mmapped data, but otherwise this works. */
626     char *buf = g_malloc(size);
627     size_t actual_size = readbuf(fd, buf, size);
628     close(fd);
629     if (actual_size != size) {
630         g_free(buf);
631         return NULL;
632     } else {
633         return bluesky_string_new(buf, size);
634     }
635 }
636
637 /* The arguments are mostly straightforward.  log_dir is -1 for access from the
638  * journal, and non-negative for access to a cloud log segment.  map_data
639  * should be TRUE for the case that are mapping just the data of an item where
640  * we have already parsed the item headers; this surpresses the error when the
641  * access is not to the first bytes of the item. */
642 BlueSkyRCStr *bluesky_log_map_object(BlueSkyCloudLog *item, gboolean map_data)
643 {
644     BlueSkyFS *fs = item->fs;
645     BlueSkyCacheFile *map = NULL;
646     BlueSkyRCStr *str = NULL;
647     int location = 0;
648     size_t file_offset = 0, file_size = 0;
649     gboolean range_request = TRUE;
650
651     if (page_size == 0) {
652         page_size = getpagesize();
653     }
654
655     bluesky_cloudlog_stats_update(item, -1);
656
657     /* First, check to see if the journal still contains a copy of the item and
658      * if so use that. */
659     if ((item->location_flags | item->pending_write) & CLOUDLOG_JOURNAL) {
660         map = bluesky_cachefile_lookup(fs, -1, item->log_seq, TRUE);
661         if (map != NULL) {
662             location = CLOUDLOG_JOURNAL;
663             file_offset = item->log_offset;
664             file_size = item->log_size;
665         }
666     }
667
668     if (location == 0 && (item->location_flags & CLOUDLOG_CLOUD)) {
669         item->location_flags &= ~CLOUDLOG_JOURNAL;
670         map = bluesky_cachefile_lookup(fs,
671                                        item->location.directory,
672                                        item->location.sequence,
673                                        !range_request);
674         if (map == NULL) {
675             g_warning("Unable to remap cloud log segment!");
676             goto exit1;
677         }
678         location = CLOUDLOG_CLOUD;
679         file_offset = item->location.offset;
680         file_size = item->location.size;
681     }
682
683     /* Log segments fetched from the cloud might only be partially-fetched.
684      * Check whether the object we are interested in is available. */
685     if (location == CLOUDLOG_CLOUD) {
686         while (TRUE) {
687             const BlueSkyRangesetItem *rangeitem;
688             rangeitem = bluesky_rangeset_lookup(map->items, file_offset);
689             if (rangeitem != NULL && (rangeitem->start != file_offset
690                                       || rangeitem->length != file_size)) {
691                 g_warning("log-%d: Item offset %zd seems to be invalid!",
692                           (int)item->location.sequence, file_offset);
693                 goto exit2;
694             }
695             if (rangeitem == NULL) {
696                 if (bluesky_verbose) {
697                     g_print("Item at offset 0x%zx not available, need to fetch.\n",
698                             file_offset);
699                 }
700                 if (range_request) {
701                     uint64_t start = 0, length = 0, end;
702                     if (map->prefetches != NULL)
703                         bluesky_rangeset_get_extents(map->prefetches,
704                                                      &start, &length);
705                     start = MIN(start, file_offset);
706                     end = MAX(start + length, file_offset + file_size);
707                     length = end - start;
708                     cloudlog_partial_fetch_start(map, start, length);
709                     if (map->prefetches != NULL) {
710                         bluesky_rangeset_free(map->prefetches);
711                         map->prefetches = NULL;
712                     }
713                 }
714                 g_cond_wait(map->cond, map->lock);
715             } else if (rangeitem->start == file_offset
716                        && rangeitem->length == file_size) {
717                 if (bluesky_verbose)
718                     g_print("Item now available.\n");
719                 break;
720             }
721         }
722     }
723
724     if (map_data) {
725         if (location == CLOUDLOG_JOURNAL)
726             file_offset += sizeof(struct log_header);
727         else
728             file_offset += sizeof(struct cloudlog_header);
729
730         file_size = item->data_size;
731     }
732     str = bluesky_cachefile_map_raw(map, file_offset, file_size);
733
734 exit2:
735     bluesky_cachefile_unref(map);
736     g_mutex_unlock(map->lock);
737 exit1:
738     bluesky_cloudlog_stats_update(item, 1);
739     return str;
740 }
741
742 void bluesky_mmap_unref(BlueSkyCacheFile *mmap)
743 {
744     if (mmap == NULL)
745         return;
746
747     if (g_atomic_int_dec_and_test(&mmap->mapcount)) {
748         g_mutex_lock(mmap->lock);
749         if (g_atomic_int_get(&mmap->mapcount) == 0) {
750             if (bluesky_verbose)
751                 g_print("Unmapped log segment %d...\n", mmap->log_seq);
752             munmap((void *)mmap->addr, mmap->len);
753             mmap->addr = NULL;
754             g_atomic_int_add(&mmap->refcount, -1);
755         }
756         g_mutex_unlock(mmap->lock);
757     }
758 }
759
760 /******************************* JOURNAL REPLAY *******************************
761  * The journal replay code is used to recover filesystem state after a
762  * filesystem restart.  We first look for the most recent commit record in the
763  * journal, which indicates the point before which all data in the journal has
764  * also been committed to the cloud.  Then, we read in all data in the log past
765  * that point.
766  */
767 static GList *directory_contents(const char *dirname)
768 {
769     GList *contents = NULL;
770     GDir *dir = g_dir_open(dirname, 0, NULL);
771     if (dir == NULL) {
772         g_warning("Unable to open journal directory: %s", dirname);
773         return NULL;
774     }
775
776     const gchar *file;
777     while ((file = g_dir_read_name(dir)) != NULL) {
778         if (strncmp(file, "journal-", 8) == 0)
779             contents = g_list_prepend(contents, g_strdup(file));
780     }
781     g_dir_close(dir);
782
783     contents = g_list_sort(contents, (GCompareFunc)strcmp);
784
785     return contents;
786 }
787
788 static gboolean validate_journal_item(const char *buf, size_t len, off_t offset)
789 {
790     const struct log_header *header;
791     const struct log_footer *footer;
792
793     if (offset + sizeof(struct log_header) + sizeof(struct log_footer) > len)
794         return FALSE;
795
796     header = (const struct log_header *)(buf + offset);
797     if (GUINT32_FROM_LE(header->magic) != HEADER_MAGIC)
798         return FALSE;
799     if (GUINT32_FROM_LE(header->offset) != offset)
800         return FALSE;
801     size_t size = GUINT32_FROM_LE(header->size1)
802                    + GUINT32_FROM_LE(header->size2)
803                    + GUINT32_FROM_LE(header->size3);
804
805     off_t footer_offset = offset + sizeof(struct log_header) + size;
806     if (footer_offset + sizeof(struct log_footer) > len)
807         return FALSE;
808     footer = (const struct log_footer *)(buf + footer_offset);
809
810     if (GUINT32_FROM_LE(footer->magic) != FOOTER_MAGIC)
811         return FALSE;
812
813     uint32_t crc = crc32c(BLUESKY_CRC32C_SEED, buf + offset,
814                           sizeof(struct log_header) + sizeof(struct log_footer)
815                           + size);
816     if (crc != BLUESKY_CRC32C_VALIDATOR) {
817         g_warning("Journal entry failed to validate: CRC %08x != %08x",
818                   crc, BLUESKY_CRC32C_VALIDATOR);
819         return FALSE;
820     }
821
822     return TRUE;
823 }
824
825 /* Scan through a journal segment to extract correctly-written items (those
826  * that pass sanity checks and have a valid checksum). */
827 static void bluesky_replay_scan_journal(const char *buf, size_t len,
828                                         uint32_t *seq, uint32_t *start_offset)
829 {
830     const struct log_header *header;
831     off_t offset = 0;
832
833     while (validate_journal_item(buf, len, offset)) {
834         header = (const struct log_header *)(buf + offset);
835         size_t size = GUINT32_FROM_LE(header->size1)
836                        + GUINT32_FROM_LE(header->size2)
837                        + GUINT32_FROM_LE(header->size3);
838
839         if (header->type - '0' == LOGTYPE_JOURNAL_CHECKPOINT) {
840             const uint32_t *data = (const uint32_t *)((const char *)header + sizeof(struct log_header));
841             *seq = GUINT32_FROM_LE(data[0]);
842             *start_offset = GUINT32_FROM_LE(data[1]);
843         }
844
845         offset += sizeof(struct log_header) + size + sizeof(struct log_footer);
846     }
847 }
848
849 static void reload_item(BlueSkyCloudLog *log_item,
850                         const char *data,
851                         size_t len1, size_t len2, size_t len3)
852 {
853     BlueSkyFS *fs = log_item->fs;
854     /*const char *data1 = data;*/
855     const BlueSkyCloudID *data2
856         = (const BlueSkyCloudID *)(data + len1);
857     /*const BlueSkyCloudPointer *data3
858         = (const BlueSkyCloudPointer *)(data + len1 + len2);*/
859
860     bluesky_cloudlog_stats_update(log_item, -1);
861     bluesky_string_unref(log_item->data);
862     log_item->data = NULL;
863     log_item->location_flags = CLOUDLOG_JOURNAL;
864     bluesky_cloudlog_stats_update(log_item, 1);
865
866     BlueSkyCloudID id0;
867     memset(&id0, 0, sizeof(id0));
868
869     int link_count = len2 / sizeof(BlueSkyCloudID);
870     GArray *new_links = g_array_new(FALSE, TRUE, sizeof(BlueSkyCloudLog *));
871     for (int i = 0; i < link_count; i++) {
872         BlueSkyCloudID id = data2[i];
873         BlueSkyCloudLog *ref = NULL;
874         if (memcmp(&id, &id0, sizeof(BlueSkyCloudID)) != 0) {
875             g_mutex_lock(fs->lock);
876             ref = g_hash_table_lookup(fs->locations, &id);
877             if (ref != NULL) {
878                 bluesky_cloudlog_ref(ref);
879             }
880             g_mutex_unlock(fs->lock);
881         }
882         g_array_append_val(new_links, ref);
883     }
884
885     for (int i = 0; i < log_item->links->len; i++) {
886         BlueSkyCloudLog *c = g_array_index(log_item->links,
887                                            BlueSkyCloudLog *, i);
888         bluesky_cloudlog_unref(c);
889     }
890     g_array_unref(log_item->links);
891     log_item->links = new_links;
892 }
893
894 static void bluesky_replay_scan_journal2(BlueSkyFS *fs, GList **objects,
895                                          int log_seq, int start_offset,
896                                          const char *buf, size_t len)
897 {
898     const struct log_header *header;
899     off_t offset = start_offset;
900
901     while (validate_journal_item(buf, len, offset)) {
902         header = (const struct log_header *)(buf + offset);
903         g_print("In replay found valid item at offset %zd\n", offset);
904         size_t size = GUINT32_FROM_LE(header->size1)
905                        + GUINT32_FROM_LE(header->size2)
906                        + GUINT32_FROM_LE(header->size3);
907
908         BlueSkyCloudLog *log_item = bluesky_cloudlog_get(fs, header->id);
909         g_mutex_lock(log_item->lock);
910         *objects = g_list_prepend(*objects, log_item);
911
912         log_item->inum = GUINT64_FROM_LE(header->inum);
913         reload_item(log_item, buf + offset + sizeof(struct log_header),
914                     GUINT32_FROM_LE(header->size1),
915                     GUINT32_FROM_LE(header->size2),
916                     GUINT32_FROM_LE(header->size3));
917         log_item->log_seq = log_seq;
918         log_item->log_offset = offset + sizeof(struct log_header);
919         log_item->log_size = header->size1;
920
921         bluesky_string_unref(log_item->data);
922         log_item->data = bluesky_string_new(g_memdup(buf + offset + sizeof(struct log_header), GUINT32_FROM_LE(header->size1)), GUINT32_FROM_LE(header->size1));
923
924         /* For any inodes which were read from the journal, deserialize the
925          * inode information, overwriting any old inode data. */
926         if (header->type - '0' == LOGTYPE_INODE) {
927             uint64_t inum = GUINT64_FROM_LE(header->inum);
928             BlueSkyInode *inode;
929             g_mutex_lock(fs->lock);
930             inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
931             if (inode == NULL) {
932                 inode = bluesky_new_inode(inum, fs, BLUESKY_PENDING);
933                 inode->change_count = 0;
934                 bluesky_insert_inode(fs, inode);
935             }
936             g_mutex_lock(inode->lock);
937             bluesky_inode_free_resources(inode);
938             if (!bluesky_deserialize_inode(inode, log_item))
939                 g_print("Error deserializing inode %"PRIu64"\n", inum);
940             fs->next_inum = MAX(fs->next_inum, inum + 1);
941             bluesky_list_unlink(&fs->accessed_list, inode->accessed_list);
942             inode->accessed_list = bluesky_list_prepend(&fs->accessed_list, inode);
943             bluesky_list_unlink(&fs->dirty_list, inode->dirty_list);
944             inode->dirty_list = bluesky_list_prepend(&fs->dirty_list, inode);
945             bluesky_list_unlink(&fs->unlogged_list, inode->unlogged_list);
946             inode->unlogged_list = NULL;
947             inode->change_cloud = inode->change_commit;
948             bluesky_cloudlog_ref(log_item);
949             bluesky_cloudlog_unref(inode->committed_item);
950             inode->committed_item = log_item;
951             g_mutex_unlock(inode->lock);
952             g_mutex_unlock(fs->lock);
953         }
954         bluesky_string_unref(log_item->data);
955         log_item->data = NULL;
956         g_mutex_unlock(log_item->lock);
957
958         offset += sizeof(struct log_header) + size + sizeof(struct log_footer);
959     }
960 }
961
962 void bluesky_replay(BlueSkyFS *fs)
963 {
964     BlueSkyLog *log = fs->log;
965     GList *logfiles = directory_contents(log->log_directory);
966
967     /* Scan through log files in reverse order to find the most recent commit
968      * record. */
969     logfiles = g_list_reverse(logfiles);
970     uint32_t seq_num = 0, start_offset = 0;
971     while (logfiles != NULL) {
972         char *filename = g_strdup_printf("%s/%s", log->log_directory,
973                                          (char *)logfiles->data);
974         g_print("Scanning file %s\n", filename);
975         GMappedFile *map = g_mapped_file_new(filename, FALSE, NULL);
976         if (map == NULL) {
977             g_warning("Mapping logfile %s failed!\n", filename);
978         } else {
979             bluesky_replay_scan_journal(g_mapped_file_get_contents(map),
980                                         g_mapped_file_get_length(map),
981                                         &seq_num, &start_offset);
982             g_mapped_file_unref(map);
983         }
984         g_free(filename);
985
986         g_free(logfiles->data);
987         logfiles = g_list_delete_link(logfiles, logfiles);
988         if (seq_num != 0 || start_offset != 0)
989             break;
990     }
991     g_list_foreach(logfiles, (GFunc)g_free, NULL);
992     g_list_free(logfiles);
993
994     /* Now, scan forward starting from the given point in the log to
995      * reconstruct all filesystem state.  As we reload objects we hold a
996      * reference to each loaded object.  At the end we free all these
997      * references, so that any objects which were not linked into persistent
998      * filesystem data structures are freed. */
999     GList *objects = NULL;
1000     while (TRUE) {
1001         char *filename = g_strdup_printf("%s/journal-%08d",
1002                                          log->log_directory, seq_num);
1003         g_print("Replaying file %s from offset %d\n", filename, start_offset);
1004         GMappedFile *map = g_mapped_file_new(filename, FALSE, NULL);
1005         g_free(filename);
1006         if (map == NULL) {
1007             g_warning("Mapping logfile failed, assuming end of journal\n");
1008             break;
1009         }
1010
1011         bluesky_replay_scan_journal2(fs, &objects, seq_num, start_offset,
1012                                      g_mapped_file_get_contents(map),
1013                                      g_mapped_file_get_length(map));
1014         g_mapped_file_unref(map);
1015         seq_num++;
1016         start_offset = 0;
1017     }
1018
1019     while (objects != NULL) {
1020         bluesky_cloudlog_unref((BlueSkyCloudLog *)objects->data);
1021         objects = g_list_delete_link(objects, objects);
1022     }
1023 }