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 << 24)
  40
  41 #define HEADER_MAGIC 0x676f4c0a
  42 #define FOOTER_MAGIC 0x2e435243
  43
  44 struct log_header {
  45     uint32_t magic;             // HEADER_MAGIC
  46     uint64_t offset;            // Starting byte offset of the log header
  47     uint32_t size;              // Size of the data item (bytes)
  48     BlueSkyCloudID id;          // Object identifier
  49 } __attribute__((packed));
  50
  51 struct log_footer {
  52     uint32_t magic;             // FOOTER_MAGIC
  53     uint32_t crc;               // Computed from log_header to log_footer.magic
  54 } __attribute__((packed));
  55
  56 static void writebuf(int fd, const char *buf, size_t len)
  57 {
  58     while (len > 0) {
  59         ssize_t written;
  60         written = write(fd, buf, len);
  61         if (written < 0 && errno == EINTR)
  62             continue;
  63         g_assert(written >= 0);
  64         buf += written;
  65         len -= written;
  66     }
  67 }
  68
  69 static void log_commit(BlueSkyLog *log)
  70 {
  71     int batchsize = 0;
  72
  73     if (log->fd < 0)
  74         return;
  75
  76     fdatasync(log->fd);
  77     while (log->committed != NULL) {
  78         BlueSkyCloudLog *item = (BlueSkyCloudLog *)log->committed->data;
  79         g_mutex_lock(item->lock);
  80         bluesky_cloudlog_stats_update(item, -1);
  81         item->pending_write &= ~CLOUDLOG_JOURNAL;
  82         item->location_flags |= CLOUDLOG_JOURNAL;
  83         bluesky_cloudlog_stats_update(item, 1);
  84         g_cond_signal(item->cond);
  85         g_mutex_unlock(item->lock);
  86         log->committed = g_slist_delete_link(log->committed, log->committed);
  87         bluesky_cloudlog_unref(item);
  88         batchsize++;
  89     }
  90
  91     if (bluesky_verbose && batchsize > 1)
  92         g_print("Log batch size: %d\n", batchsize);
  93 }
  94
  95 static gboolean log_open(BlueSkyLog *log)
  96 {
  97     char logname[64];
  98
  99     if (log->fd >= 0) {
 100         log_commit(log);
 101         close(log->fd);
 102         log->seq_num++;
 103         log->fd = -1;
 104     }
 105
 106     while (log->fd < 0) {
 107         g_snprintf(logname, sizeof(logname), "log-%08d", log->seq_num);
 108         log->fd = openat(log->dirfd, logname, O_CREAT|O_WRONLY|O_EXCL, 0600);
 109         if (log->fd < 0 && errno == EEXIST) {
 110             fprintf(stderr, "Log file %s already exists...\n", logname);
 111             log->seq_num++;
 112             continue;
 113         } else if (log->fd < 0) {
 114             fprintf(stderr, "Error opening logfile %s: %m\n", logname);
 115             return FALSE;
 116         }
 117     }
 118
 119     if (ftruncate(log->fd, LOG_SEGMENT_SIZE) < 0) {
 120         fprintf(stderr, "Unable to truncate logfile %s: %m\n", logname);
 121     }
 122     fsync(log->fd);
 123     fsync(log->dirfd);
 124     return TRUE;
 125 }
 126
 127 /* All log writes (at least for a single log) are made by one thread, so we
 128  * don't need to worry about concurrent access to the log file.  Log items to
 129  * write are pulled off a queue (and so may be posted by any thread).
 130  * fdatasync() is used to ensure the log items are stable on disk.
 131  *
 132  * The log is broken up into separate files, roughly of size LOG_SEGMENT_SIZE
 133  * each.  If a log segment is not currently open (log->fd is negative), a new
 134  * one is created.  Log segment filenames are assigned sequentially.
 135  *
 136  * Log replay ought to be implemented later, and ought to set the initial
 137  * sequence number appropriately.
 138  */
 139 static gpointer log_thread(gpointer d)
 140 {
 141     BlueSkyLog *log = (BlueSkyLog *)d;
 142
 143     while (TRUE) {
 144         if (log->fd < 0) {
 145             if (!log_open(log)) {
 146                 return NULL;
 147             }
 148         }
 149
 150         BlueSkyCloudLog *item
 151             = (BlueSkyCloudLog *)g_async_queue_pop(log->queue);
 152         g_mutex_lock(item->lock);
 153         g_assert(item->data != NULL);
 154
 155         /* The item may have already been written to the journal... */
 156         if ((item->location_flags | item->pending_write) & CLOUDLOG_JOURNAL) {
 157             g_mutex_unlock(item->lock);
 158             bluesky_cloudlog_unref(item);
 159             g_atomic_int_add(&item->data_lock_count, -1);
 160             continue;
 161         }
 162
 163         bluesky_cloudlog_stats_update(item, -1);
 164         item->pending_write |= CLOUDLOG_JOURNAL;
 165         bluesky_cloudlog_stats_update(item, 1);
 166
 167         struct log_header header;
 168         struct log_footer footer;
 169         size_t size = sizeof(header) + sizeof(footer) + item->data->len;
 170         off_t offset = 0;
 171         if (log->fd >= 0)
 172             offset = lseek(log->fd, 0, SEEK_CUR);
 173
 174         /* Check whether the item would overflow the allocated journal size.
 175          * If so, start a new log segment.  We only allow oversized log
 176          * segments if they contain a single log entry. */
 177         if (offset + size >= LOG_SEGMENT_SIZE && offset > 0) {
 178             log_open(log);
 179             offset = 0;
 180         }
 181
 182         header.magic = GUINT32_TO_LE(HEADER_MAGIC);
 183         header.offset = GUINT64_TO_LE(offset);
 184         header.size = GUINT32_TO_LE(item->data->len);
 185         header.id = item->id;
 186         footer.magic = GUINT32_TO_LE(FOOTER_MAGIC);
 187
 188         uint32_t crc = BLUESKY_CRC32C_SEED;
 189
 190         writebuf(log->fd, (const char *)&header, sizeof(header));
 191         crc = crc32c(crc, (const char *)&header, sizeof(header));
 192
 193         writebuf(log->fd, item->data->data, item->data->len);
 194         crc = crc32c(crc, item->data->data, item->data->len);
 195
 196         crc = crc32c(crc, (const char *)&footer,
 197                      sizeof(footer) - sizeof(uint32_t));
 198         footer.crc = crc32c_finalize(crc);
 199         writebuf(log->fd, (const char *)&footer, sizeof(footer));
 200
 201         item->log_seq = log->seq_num;
 202         item->log_offset = offset + sizeof(header);
 203         item->log_size = item->data->len;
 204
 205         offset += sizeof(header) + sizeof(footer) + item->data->len;
 206
 207         /* Replace the log item's string data with a memory-mapped copy of the
 208          * data, now that it has been written to the log file.  (Even if it
 209          * isn't yet on disk, it should at least be in the page cache and so
 210          * available to memory map.) */
 211         bluesky_string_unref(item->data);
 212         item->data = NULL;
 213         bluesky_cloudlog_fetch(item);
 214
 215         log->committed  = g_slist_prepend(log->committed, item);
 216         g_atomic_int_add(&item->data_lock_count, -1);
 217         g_mutex_unlock(item->lock);
 218
 219         /* Force an if there are no other log items currently waiting to be
 220          * written. */
 221         if (g_async_queue_length(log->queue) <= 0)
 222             log_commit(log);
 223     }
 224
 225     return NULL;
 226 }
 227
 228 BlueSkyLog *bluesky_log_new(const char *log_directory)
 229 {
 230     BlueSkyLog *log = g_new0(BlueSkyLog, 1);
 231
 232     log->log_directory = g_strdup(log_directory);
 233     log->fd = -1;
 234     log->seq_num = 0;
 235     log->queue = g_async_queue_new();
 236     log->mmap_lock = g_mutex_new();
 237     log->mmap_cache = g_hash_table_new(NULL, NULL);
 238
 239     log->dirfd = open(log->log_directory, O_DIRECTORY);
 240     if (log->dirfd < 0) {
 241         fprintf(stderr, "Unable to open logging directory: %m\n");
 242         return NULL;
 243     }
 244
 245     g_thread_create(log_thread, log, FALSE, NULL);
 246
 247     return log;
 248 }
 249
 250 void bluesky_log_item_submit(BlueSkyCloudLog *item, BlueSkyLog *log)
 251 {
 252     bluesky_cloudlog_ref(item);
 253     g_atomic_int_add(&item->data_lock_count, 1);
 254     g_async_queue_push(log->queue, item);
 255 }
 256
 257 void bluesky_log_finish_all(GList *log_items)
 258 {
 259     while (log_items != NULL) {
 260         BlueSkyCloudLog *item = (BlueSkyCloudLog *)log_items->data;
 261
 262         g_mutex_lock(item->lock);
 263         while ((item->pending_write & CLOUDLOG_JOURNAL))
 264             g_cond_wait(item->cond, item->lock);
 265         g_mutex_unlock(item->lock);
 266         bluesky_cloudlog_unref(item);
 267
 268         log_items = g_list_delete_link(log_items, log_items);
 269     }
 270 }
 271
 272 /* Memory-map the given log object into memory (read-only) and return a pointer
 273  * to it. */
 274 static int page_size = 0;
 275
 276 BlueSkyRCStr *bluesky_log_map_object(BlueSkyLog *log,
 277                                      int log_seq, int log_offset, int log_size)
 278 {
 279     if (page_size == 0) {
 280         page_size = getpagesize();
 281     }
 282
 283     BlueSkyMmap *map;
 284     g_mutex_lock(log->mmap_lock);
 285     map = g_hash_table_lookup(log->mmap_cache, GINT_TO_POINTER(log_seq));
 286
 287     if (map == NULL) {
 288         char logname[64];
 289         g_snprintf(logname, sizeof(logname), "log-%08d", log_seq);
 290         int fd = openat(log->dirfd, logname, O_RDONLY);
 291
 292         if (fd < 0) {
 293             fprintf(stderr, "Error opening logfile %s: %m\n", logname);
 294             g_mutex_unlock(log->mmap_lock);
 295             return NULL;
 296         }
 297
 298         map = g_new0(BlueSkyMmap, 1);
 299
 300         off_t length = lseek(fd, 0, SEEK_END);
 301         map->log_seq = log_seq;
 302         map->addr = (const char *)mmap(NULL, length, PROT_READ, MAP_SHARED,
 303                                        fd, 0);
 304         map->len = length;
 305         map->log = log;
 306         g_atomic_int_set(&map->refcount, 0);
 307
 308         g_hash_table_insert(log->mmap_cache, GINT_TO_POINTER(log_seq), map);
 309
 310         g_print("Mapped log segment %d...\n", log_seq);
 311
 312         close(fd);
 313     }
 314
 315     g_mutex_unlock(log->mmap_lock);
 316
 317     return bluesky_string_new_from_mmap(map, log_offset, log_size);
 318 }
 319
 320 void bluesky_mmap_unref(BlueSkyMmap *mmap)
 321 {
 322     if (mmap == NULL)
 323         return;
 324
 325     if (g_atomic_int_dec_and_test(&mmap->refcount)) {
 326         /* There is a potential race condition here: the BlueSkyLog contains a
 327          * hash table of currently-existing BlueSkyMmap objects, which does not
 328          * hold a reference.  Some other thread might grab a new reference to
 329          * this object after reading it from the hash table.  So, before
 330          * destruction we need to grab the lock for the hash table, then check
 331          * the reference count again.  If it is still zero, we can proceed with
 332          * object destruction. */
 333         BlueSkyLog *log = mmap->log;
 334         g_mutex_lock(log->mmap_lock);
 335         if (g_atomic_int_get(&mmap->refcount) > 0) {
 336             g_mutex_unlock(log->mmap_lock);
 337             return;
 338         }
 339
 340         g_hash_table_remove(log->mmap_cache, GINT_TO_POINTER(mmap->log_seq));
 341         munmap((void *)mmap->addr, mmap->len);
 342         g_free(mmap);
 343         g_mutex_unlock(log->mmap_lock);
 344     }
 345 }
 346