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
  23 #include "bluesky-private.h"
  24
  25 /* The logging layer for BlueSky.  This is used to write filesystem changes
  26  * durably to disk so that they can be recovered in the event of a system
  27  * crash. */
  28
  29 /* The logging layer takes care out writing out a sequence of log records to
  30  * disk.  On disk, each record consists of a header, a data payload, and a
  31  * footer.  The footer contains a checksum of the record, meant to help with
  32  * identifying corrupt log records (we would assume because the log record was
  33  * only incompletely written out before a crash, which should only happen for
  34  * log records that were not considered committed). */
  35
  36 // Rough size limit for a log segment.  This is not a firm limit and there are
  37 // no absolute guarantees on the size of a log segment.
  38 #define LOG_SEGMENT_SIZE (1 << 23)
  39
  40 static void writebuf(int fd, const char *buf, size_t len)
  41 {
  42     while (len > 0) {
  43         ssize_t written;
  44         written = write(fd, buf, len);
  45         if (written < 0 && errno == EINTR)
  46             continue;
  47         g_assert(written >= 0);
  48         buf += written;
  49         len -= written;
  50     }
  51 }
  52
  53 /* All log writes (at least for a single log) are made by one thread, so we
  54  * don't need to worry about concurrent access to the log file.  Log items to
  55  * write are pulled off a queue (and so may be posted by any thread).
  56  * fdatasync() is used to ensure the log items are stable on disk.
  57  *
  58  * The log is broken up into separate files, roughly of size LOG_SEGMENT_SIZE
  59  * each.  If a log segment is not currently open (log->fd is negative), a new
  60  * one is created.  Log segment filenames are assigned sequentially.
  61  *
  62  * Log replay ought to be implemented later, and ought to set the initial
  63  * sequence number appropriately.
  64  */
  65 static gpointer log_thread(gpointer d)
  66 {
  67     BlueSkyLog *log = (BlueSkyLog *)d;
  68
  69     /* If there are multiple log items to write, we may write more than one
  70      * before calling fsync().  The committed list is used to track all the
  71      * items that should be marked as committed once that final fsync() is
  72      * done. */
  73     GSList *committed = NULL;
  74
  75     int dirfd = open(log->log_directory, O_DIRECTORY);
  76     if (dirfd < 0) {
  77         fprintf(stderr, "Unable to open logging directory: %m\n");
  78         return NULL;
  79     }
  80
  81     while (TRUE) {
  82         if (log->fd < 0) {
  83             char logfile[64];
  84             g_snprintf(logfile, sizeof(logfile), "log-%08d", log->seq_num);
  85             log->fd = openat(dirfd, logfile, O_CREAT|O_WRONLY|O_EXCL, 0600);
  86             if (log->fd < 0 && errno == EEXIST) {
  87                 fprintf(stderr, "Log file %s already exists...\n", logfile);
  88                 log->seq_num++;
  89                 continue;
  90             } else if (log->fd < 0) {
  91                 fprintf(stderr, "Error opening logfile %s: %m\n", logfile);
  92                 return NULL;
  93             }
  94             fsync(log->fd);
  95             fsync(dirfd);
  96         }
  97
  98         BlueSkyLogItem *item = (BlueSkyLogItem *)g_async_queue_pop(log->queue);
  99         g_mutex_lock(item->lock);
 100         writebuf(log->fd, item->key, strlen(item->key));
 101         writebuf(log->fd, item->data->data, item->data->len);
 102         committed  = g_slist_prepend(committed, item);
 103
 104         /* Force an fsync either if we will be closing this log segment and
 105          * opening a new file, or if there are no other log items currently
 106          * waiting to be written. */
 107         off_t logsize = lseek(log->fd, 0, SEEK_CUR);
 108         if (logsize >= LOG_SEGMENT_SIZE
 109             || g_async_queue_length(log->queue) <= 0)
 110         {
 111             int batchsize = 0;
 112             fdatasync(log->fd);
 113             while (committed != NULL) {
 114                 item = (BlueSkyLogItem *)committed->data;
 115                 item->committed = TRUE;
 116                 g_cond_signal(item->cond);
 117                 g_mutex_unlock(item->lock);
 118                 committed = g_slist_delete_link(committed, committed);
 119                 batchsize++;
 120             }
 121             /* if (batchsize > 1)
 122                 g_print("Log batch size: %d\n", batchsize); */
 123         }
 124
 125         if (logsize < 0 || logsize >= LOG_SEGMENT_SIZE) {
 126             close(log->fd);
 127             log->fd = -1;
 128             log->seq_num++;
 129         }
 130     }
 131
 132     return NULL;
 133 }
 134
 135 BlueSkyLog *bluesky_log_new(const char *log_directory)
 136 {
 137     BlueSkyLog *log = g_new0(BlueSkyLog, 1);
 138
 139     log->log_directory = g_strdup(log_directory);
 140     log->fd = -1;
 141     log->seq_num = 0;
 142     log->queue = g_async_queue_new();
 143
 144     g_thread_create(log_thread, log, FALSE, NULL);
 145
 146     return log;
 147 }
 148
 149 BlueSkyLogItem *bluesky_log_item_new()
 150 {
 151     BlueSkyLogItem *item = g_new(BlueSkyLogItem, 1);
 152     item->committed = FALSE;
 153     item->lock = g_mutex_new();
 154     item->cond = g_cond_new();
 155     item->key = NULL;
 156     item->data = NULL;
 157     return item;
 158 }
 159
 160 void bluesky_log_item_submit(BlueSkyLogItem *item, BlueSkyLog *log)
 161 {
 162     g_async_queue_push(log->queue, item);
 163 }
 164
 165 static void bluesky_log_item_free(BlueSkyLogItem *item)
 166 {
 167     g_free(item->key);
 168     bluesky_string_unref(item->data);
 169     g_mutex_free(item->lock);
 170     g_cond_free(item->cond);
 171     g_free(item);
 172 }
 173
 174 void bluesky_log_item_finish(BlueSkyLogItem *item)
 175 {
 176     g_mutex_lock(item->lock);
 177     while (!item->committed)
 178         g_cond_wait(item->cond, item->lock);
 179     g_mutex_unlock(item->lock);
 180     bluesky_log_item_free(item);
 181 }