bluesky/cloudlog.c

   1 /* Blue Sky: File Systems in the Cloud
   2  *
   3  * Copyright (C) 2009  The Regents of the University of California
   4  * Written by Michael Vrable <mvrable@cs.ucsd.edu>
   5  *
   6  * TODO: Licensing
   7  */
   8
   9 #include <stdio.h>
  10 #include <stdint.h>
  11 #include <glib.h>
  12 #include <string.h>
  13
  14 #include "bluesky-private.h"
  15
  16 // Rough size limit for a log segment.  This is not a firm limit and there are
  17 // no absolute guarantees on the size of a log segment.
  18 #define CLOUDLOG_SEGMENT_SIZE (4 << 20)
  19
  20 BlueSkyCloudID bluesky_cloudlog_new_id()
  21 {
  22     BlueSkyCloudID id;
  23     bluesky_crypt_random_bytes((uint8_t *)&id.bytes, sizeof(id));
  24     return id;
  25 }
  26
  27 gchar *bluesky_cloudlog_id_to_string(BlueSkyCloudID id)
  28 {
  29     char buf[sizeof(BlueSkyCloudID) * 2 + 1];
  30     buf[0] = '\0';
  31
  32     for (int i = 0; i < sizeof(BlueSkyCloudID); i++) {
  33         sprintf(&buf[2*i], "%02x", (uint8_t)(id.bytes[i]));
  34     }
  35
  36     return g_strdup(buf);
  37 }
  38
  39 BlueSkyCloudID bluesky_cloudlog_id_from_string(const gchar *idstr)
  40 {
  41     BlueSkyCloudID id;
  42     memset(&id, 0, sizeof(id));
  43     for (int i = 0; i < 2*sizeof(BlueSkyCloudID); i++) {
  44         char c = idstr[i];
  45         if (c == '\0') {
  46             g_warning("Short cloud id: %s\n", idstr);
  47             break;
  48         }
  49         int val = 0;
  50         if (c >= '0' && c <= '9')
  51             val = c - '0';
  52         else if (c >= 'a' && c <= 'f')
  53             val = c - 'a' + 10;
  54         else
  55             g_warning("Bad character in cloud id: %s\n", idstr);
  56         id.bytes[i / 2] += val << (i % 2 ? 0 : 4);
  57     }
  58     return id;
  59 }
  60
  61 gboolean bluesky_cloudlog_equal(gconstpointer a, gconstpointer b)
  62 {
  63     BlueSkyCloudID *id1 = (BlueSkyCloudID *)a, *id2 = (BlueSkyCloudID *)b;
  64
  65     return memcmp(id1, id2, sizeof(BlueSkyCloudID)) == 0;
  66 }
  67
  68 guint bluesky_cloudlog_hash(gconstpointer a)
  69 {
  70     BlueSkyCloudID *id = (BlueSkyCloudID *)a;
  71
  72     // Assume that bits in the ID are randomly chosen so that any subset of the
  73     // bits can be used as a hash key.
  74     return *(guint *)(&id->bytes);
  75 }
  76
  77 /* Formatting of cloud log segments.  This handles grouping items together
  78  * before writing a batch to the cloud, handling indirection through items like
  79  * the inode map, etc. */
  80
  81 BlueSkyCloudLog *bluesky_cloudlog_new(BlueSkyFS *fs, const BlueSkyCloudID *id)
  82 {
  83     BlueSkyCloudLog *log = g_new0(BlueSkyCloudLog, 1);
  84
  85     log->lock = g_mutex_new();
  86     log->cond = g_cond_new();
  87     log->fs = fs;
  88     log->type = LOGTYPE_UNKNOWN;
  89     if (id != NULL)
  90         memcpy(&log->id, id, sizeof(BlueSkyCloudID));
  91     else
  92         log->id = bluesky_cloudlog_new_id();
  93     log->links = g_array_new(FALSE, TRUE, sizeof(BlueSkyCloudLog *));
  94     g_atomic_int_set(&log->refcount, 1);
  95
  96     return log;
  97 }
  98
  99 /* Helper function for updating memory usage statistics for a filesystem (the
 100  * cache_log_* variables).  This will increment (type=1) or decrement (type=-1)
 101  * the counter associated with the current state of the cloud log item.  The
 102  * item should be locked or otherwise protected from concurrent access. */
 103 void bluesky_cloudlog_stats_update(BlueSkyCloudLog *log, int type)
 104 {
 105     BlueSkyFS *fs = log->fs;
 106
 107     if (log->location_flags & CLOUDLOG_CLOUD) {
 108         g_atomic_int_add(&fs->cache_log_cloud, type);
 109     } else if (log->location_flags & CLOUDLOG_JOURNAL) {
 110         g_atomic_int_add(&fs->cache_log_journal, type);
 111     } else if (log->pending_write & CLOUDLOG_JOURNAL) {
 112         g_atomic_int_add(&fs->cache_log_journal, type);
 113     } else if (log->data != NULL) {
 114         g_atomic_int_add(&fs->cache_log_dirty, type);
 115     }
 116 }
 117
 118 /* The reference held by the hash table does not count towards the reference
 119  * count.  When a new object is created, it initially has a reference count of
 120  * 1 for the creator, and similarly fetching an item from the hash table will
 121  * also create a reference.  If the reference count drops to zero,
 122  * bluesky_cloudlog_unref attempts to remove the object from the hash
 123  * table--but there is a potential race since another thread might read the
 124  * object from the hash table at the same time.  So an object with a reference
 125  * count of zero may still be resurrected, in which case we need to abort the
 126  * destruction.  Once the object is gone from the hash table, and if the
 127  * reference count is still zero, it can actually be deleted. */
 128 void bluesky_cloudlog_ref(BlueSkyCloudLog *log)
 129 {
 130     if (log == NULL)
 131         return;
 132
 133     g_atomic_int_inc(&log->refcount);
 134 }
 135
 136 void bluesky_cloudlog_unref(BlueSkyCloudLog *log)
 137 {
 138     if (log == NULL)
 139         return;
 140
 141     if (g_atomic_int_dec_and_test(&log->refcount)) {
 142         BlueSkyFS *fs = log->fs;
 143
 144         g_mutex_lock(fs->lock);
 145         if (g_atomic_int_get(&log->refcount) > 0) {
 146             g_mutex_unlock(fs->lock);
 147             return;
 148         }
 149
 150         if (!g_hash_table_remove(fs->locations, &log->id)) {
 151             if (bluesky_verbose)
 152                 g_warning("Could not find and remove cloud log item from hash table!");
 153         }
 154         g_mutex_unlock(fs->lock);
 155
 156         bluesky_cloudlog_stats_update(log, -1);
 157         log->type = LOGTYPE_INVALID;
 158         g_mutex_free(log->lock);
 159         g_cond_free(log->cond);
 160         for (int i = 0; i < log->links->len; i++) {
 161             BlueSkyCloudLog *c = g_array_index(log->links,
 162                                                BlueSkyCloudLog *, i);
 163             bluesky_cloudlog_unref(c);
 164         }
 165         g_array_unref(log->links);
 166         bluesky_string_unref(log->data);
 167         g_free(log);
 168     }
 169 }
 170
 171 /* For locking reasons cloudlog unrefs may sometimes need to be performed in
 172  * the future.  We launch a thread for handling these delayed unreference
 173  * requests. */
 174 static gpointer cloudlog_unref_thread(gpointer q)
 175 {
 176     GAsyncQueue *queue = (GAsyncQueue *)q;
 177
 178     while (TRUE) {
 179         BlueSkyCloudLog *item = (BlueSkyCloudLog *)g_async_queue_pop(queue);
 180         bluesky_cloudlog_unref(item);
 181     }
 182
 183     return NULL;
 184 }
 185
 186 void bluesky_cloudlog_unref_delayed(BlueSkyCloudLog *log)
 187 {
 188     if (log != NULL)
 189         g_async_queue_push(log->fs->unref_queue, log);
 190 }
 191
 192 void bluesky_cloudlog_threads_init(BlueSkyFS *fs)
 193 {
 194     fs->unref_queue = g_async_queue_new();
 195     g_thread_create(cloudlog_unref_thread, fs->unref_queue, FALSE, NULL);
 196 }
 197
 198 /* Erase the information contained within the in-memory cloud log
 199  * representation.  This does not free up the item itself, but frees the data
 200  * and references to other log items and resets the type back to unknown.  If
 201  * the object was written out to persistent storage, all state about it can be
 202  * recovered by loading the object back in.  The object must be locked before
 203  * calling this function. */
 204 void bluesky_cloudlog_erase(BlueSkyCloudLog *log)
 205 {
 206     g_assert(log->data_lock_count == 0);
 207
 208     if (log->type == LOGTYPE_UNKNOWN)
 209         return;
 210
 211     log->type = LOGTYPE_UNKNOWN;
 212     log->data_size = 0;
 213     bluesky_string_unref(log->data);
 214     log->data = NULL;
 215     log->data_lock_count = 0;
 216
 217     for (int i = 0; i < log->links->len; i++) {
 218         BlueSkyCloudLog *c = g_array_index(log->links,
 219                                            BlueSkyCloudLog *, i);
 220         bluesky_cloudlog_unref(c);
 221     }
 222     g_array_unref(log->links);
 223     log->links = g_array_new(FALSE, TRUE, sizeof(BlueSkyCloudLog *));
 224 }
 225
 226 /* Start a write of the object to the local log. */
 227 void bluesky_cloudlog_sync(BlueSkyCloudLog *log)
 228 {
 229     bluesky_log_item_submit(log, log->fs->log);
 230 }
 231
 232 /* Add the given entry to the global hash table containing cloud log entries.
 233  * Takes ownership of the caller's reference. */
 234 void bluesky_cloudlog_insert_locked(BlueSkyCloudLog *log)
 235 {
 236     g_hash_table_insert(log->fs->locations, &log->id, log);
 237 }
 238
 239 void bluesky_cloudlog_insert(BlueSkyCloudLog *log)
 240 {
 241     g_mutex_lock(log->fs->lock);
 242     bluesky_cloudlog_insert_locked(log);
 243     g_mutex_unlock(log->fs->lock);
 244 }
 245
 246 /* Look up the cloud log entry for the given ID.  If create is TRUE and the
 247  * item does not exist, create a special pending entry that can later be filled
 248  * in when the real item is loaded.  The returned item has a reference held.
 249  * As a special case, if a null ID is provided then NULL is returned. */
 250 BlueSkyCloudLog *bluesky_cloudlog_get(BlueSkyFS *fs, BlueSkyCloudID id)
 251 {
 252     static BlueSkyCloudID id0 = {{0}};
 253
 254     if (memcmp(&id, &id0, sizeof(BlueSkyCloudID)) == 0)
 255         return NULL;
 256
 257     g_mutex_lock(fs->lock);
 258     BlueSkyCloudLog *item;
 259     item = g_hash_table_lookup(fs->locations, &id);
 260     if (item == NULL) {
 261         item = bluesky_cloudlog_new(fs, &id);
 262         bluesky_cloudlog_stats_update(item, 1);
 263         bluesky_cloudlog_insert_locked(item);
 264     } else {
 265         bluesky_cloudlog_ref(item);
 266     }
 267     g_mutex_unlock(fs->lock);
 268     return item;
 269 }
 270
 271 /* Ensure that a cloud log item is loaded in memory, and if not read it in.
 272  * TODO: Make asynchronous, and make this also fetch from the cloud.  Right now
 273  * we only read from the log.  Log item must be locked. */
 274 void bluesky_cloudlog_fetch(BlueSkyCloudLog *log)
 275 {
 276     if (log->data != NULL)
 277         return;
 278
 279     /* There are actually two cases: a full deserialization if we have not ever
 280      * read the object before, and a partial deserialization where the metadata
 281      * is already in memory and we just need to remap the data.  If the object
 282      * type has not yet been set, we'll need to read and parse the metadata.
 283      * Once that is done, we can fall through the case of remapping the data
 284      * itself. */
 285     if (log->type == LOGTYPE_UNKNOWN) {
 286         bluesky_cloudlog_stats_update(log, -1);
 287         BlueSkyRCStr *raw = NULL;
 288         if ((log->location_flags | log->pending_write) & CLOUDLOG_JOURNAL) {
 289             raw = bluesky_log_map_object(log->fs, -1, log->log_seq,
 290                                          log->log_offset, log->log_size);
 291         }
 292
 293         if (raw == NULL && (log->location_flags & CLOUDLOG_CLOUD)) {
 294             log->location_flags &= ~CLOUDLOG_JOURNAL;
 295             raw = bluesky_log_map_object(log->fs,
 296                                          log->location.directory,
 297                                          log->location.sequence,
 298                                          log->location.offset,
 299                                          log->location.size);
 300         }
 301
 302         g_assert(raw != NULL);
 303         bluesky_deserialize_cloudlog(log, raw->data, raw->len);
 304         bluesky_string_unref(raw);
 305         bluesky_cloudlog_stats_update(log, 1);
 306     }
 307
 308     /* At this point all metadata should be available and we need only remap
 309      * the object data. */
 310
 311     int offset;
 312     if ((log->location_flags | log->pending_write) & CLOUDLOG_JOURNAL) {
 313         bluesky_cloudlog_stats_update(log, -1);
 314         offset = log->log_offset + sizeof(struct log_header);
 315         log->data = bluesky_log_map_object(log->fs, -1, log->log_seq,
 316                                            offset, log->data_size);
 317         bluesky_cloudlog_stats_update(log, 1);
 318     }
 319
 320     if (log->data == NULL && (log->location_flags & CLOUDLOG_CLOUD)) {
 321         log->location_flags &= ~CLOUDLOG_JOURNAL;
 322         bluesky_cloudlog_stats_update(log, -1);
 323         offset = log->location.offset + sizeof(struct cloudlog_header);
 324         log->data = bluesky_log_map_object(log->fs, log->location.directory,
 325                                            log->location.sequence,
 326                                            offset, log->data_size);
 327         bluesky_cloudlog_stats_update(log, 1);
 328     }
 329
 330     if (log->data == NULL) {
 331         g_error("Unable to fetch cloudlog entry!");
 332     }
 333
 334     g_cond_broadcast(log->cond);
 335 }
 336
 337 BlueSkyCloudPointer bluesky_cloudlog_serialize(BlueSkyCloudLog *log,
 338                                                BlueSkyFS *fs)
 339 {
 340     BlueSkyCloudLogState *state = fs->log_state;
 341
 342     if ((log->location_flags | log->pending_write) & CLOUDLOG_CLOUD) {
 343         return log->location;
 344     }
 345
 346     for (int i = 0; i < log->links->len; i++) {
 347         BlueSkyCloudLog *ref = g_array_index(log->links,
 348                                              BlueSkyCloudLog *, i);
 349         if (ref != NULL)
 350             bluesky_cloudlog_serialize(ref, fs);
 351     }
 352
 353     g_mutex_lock(log->lock);
 354     bluesky_cloudlog_fetch(log);
 355     g_assert(log->data != NULL);
 356
 357     bluesky_cloudlog_stats_update(log, -1);
 358
 359     GString *data1 = g_string_new("");
 360     GString *data2 = g_string_new("");
 361     GString *data3 = g_string_new("");
 362     bluesky_serialize_cloudlog(log, data1, data2, data3);
 363
 364     log->location = state->location;
 365     log->location.offset = state->data->len;
 366     log->data_size = data1->len;
 367
 368     struct cloudlog_header header;
 369     memcpy(header.magic, CLOUDLOG_MAGIC, 4);
 370     memset(header.crypt_auth, sizeof(header.crypt_auth), 0);
 371     memset(header.crypt_iv, sizeof(header.crypt_iv), 0);
 372     header.type = log->type + '0';
 373     header.size1 = GUINT32_TO_LE(data1->len);
 374     header.size2 = GUINT32_TO_LE(data2->len);
 375     header.size3 = GUINT32_TO_LE(data3->len);
 376     header.id = log->id;
 377     header.inum = GUINT64_TO_LE(log->inum);
 378
 379     g_string_append_len(state->data, (const char *)&header, sizeof(header));
 380     g_string_append_len(state->data, data1->str, data1->len);
 381     g_string_append_len(state->data, data2->str, data2->len);
 382     g_string_append_len(state->data, data3->str, data3->len);
 383
 384     log->location.size = state->data->len - log->location.offset;
 385
 386     g_string_free(data1, TRUE);
 387     g_string_free(data2, TRUE);
 388     g_string_free(data3, TRUE);
 389
 390     /* If the object we flushed was an inode, update the inode map. */
 391     if (log->type == LOGTYPE_INODE) {
 392         g_mutex_lock(fs->lock);
 393         InodeMapEntry *entry = bluesky_inode_map_lookup(fs->inode_map,
 394                                                         log->inum, 1);
 395         bluesky_cloudlog_unref_delayed(entry->item);
 396         entry->item = log;
 397         bluesky_cloudlog_ref(entry->item);
 398         g_mutex_unlock(fs->lock);
 399     }
 400
 401     /* TODO: We should mark the objects as committed on the cloud until the
 402      * data is flushed and acknowledged. */
 403     log->pending_write |= CLOUDLOG_CLOUD;
 404     bluesky_cloudlog_stats_update(log, 1);
 405     state->writeback_list = g_slist_prepend(state->writeback_list, log);
 406     bluesky_cloudlog_ref(log);
 407     g_mutex_unlock(log->lock);
 408
 409     if (state->data->len > CLOUDLOG_SEGMENT_SIZE)
 410         bluesky_cloudlog_flush(fs);
 411
 412     return log->location;
 413 }
 414
 415 static void cloudlog_flush_complete(BlueSkyStoreAsync *async,
 416                                     SerializedRecord *record)
 417 {
 418     g_print("Write of %s to cloud complete, status = %d\n",
 419             async->key, async->result);
 420
 421     g_mutex_lock(record->lock);
 422     if (async->result >= 0) {
 423         while (record->items != NULL) {
 424             BlueSkyCloudLog *item = (BlueSkyCloudLog *)record->items->data;
 425             g_mutex_lock(item->lock);
 426             bluesky_cloudlog_stats_update(item, -1);
 427             item->pending_write &= ~CLOUDLOG_CLOUD;
 428             item->location_flags |= CLOUDLOG_CLOUD;
 429             bluesky_cloudlog_stats_update(item, 1);
 430             g_mutex_unlock(item->lock);
 431             bluesky_cloudlog_unref(item);
 432
 433             record->items = g_slist_delete_link(record->items, record->items);
 434         }
 435
 436         bluesky_string_unref(record->data);
 437         record->data = NULL;
 438         g_slist_free(record->items);
 439         record->items = NULL;
 440         record->complete = TRUE;
 441         g_cond_broadcast(record->cond);
 442     } else {
 443         g_print("Write should be resubmitted...\n");
 444
 445         BlueSkyStoreAsync *async2 = bluesky_store_async_new(async->store);
 446         async2->op = STORE_OP_PUT;
 447         async2->key = g_strdup(async->key);
 448         async2->data = record->data;
 449         bluesky_string_ref(record->data);
 450         bluesky_store_async_submit(async2);
 451         bluesky_store_async_add_notifier(async2,
 452                                          (GFunc)cloudlog_flush_complete,
 453                                          record);
 454         bluesky_store_async_unref(async2);
 455     }
 456     g_mutex_unlock(record->lock);
 457 }
 458
 459 /* Finish up a partially-written cloud log segment and flush it to storage. */
 460 void bluesky_cloudlog_flush(BlueSkyFS *fs)
 461 {
 462     BlueSkyCloudLogState *state = fs->log_state;
 463     if (state->data == NULL || state->data->len == 0)
 464         return;
 465
 466     /* TODO: Append some type of commit record to the log segment? */
 467
 468     g_print("Serializing %zd bytes of data to cloud\n", state->data->len);
 469     SerializedRecord *record = g_new0(SerializedRecord, 1);
 470     bluesky_cloudlog_encrypt(state->data, fs->keys);
 471     record->data = bluesky_string_new_from_gstring(state->data);
 472     record->items = state->writeback_list;
 473     record->lock = g_mutex_new();
 474     record->cond = g_cond_new();
 475     state->writeback_list = NULL;
 476
 477     BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
 478     async->op = STORE_OP_PUT;
 479     async->key = g_strdup_printf("log-%08d-%08d",
 480                                  state->location.directory,
 481                                  state->location.sequence);
 482     async->data = record->data;
 483     bluesky_string_ref(record->data);
 484     bluesky_store_async_submit(async);
 485     bluesky_store_async_add_notifier(async,
 486                                      (GFunc)cloudlog_flush_complete,
 487                                      record);
 488     bluesky_store_async_unref(async);
 489
 490     state->pending_segments = g_list_prepend(state->pending_segments, record);
 491
 492     state->location.sequence++;
 493     state->location.offset = 0;
 494     state->data = g_string_new("");
 495 }
 496
 497 /* Make an encryption pass over a cloud log segment to encrypt private data in
 498  * it. */
 499 void bluesky_cloudlog_encrypt(GString *segment, BlueSkyCryptKeys *keys)
 500 {
 501     char *data = segment->str;
 502     size_t remaining_size = segment->len;
 503
 504     while (remaining_size >= sizeof(struct cloudlog_header)) {
 505         struct cloudlog_header *header = (struct cloudlog_header *)data;
 506         size_t item_size = sizeof(struct cloudlog_header)
 507                            + GUINT32_FROM_LE(header->size1)
 508                            + GUINT32_FROM_LE(header->size2)
 509                            + GUINT32_FROM_LE(header->size3);
 510         if (item_size > remaining_size)
 511             break;
 512         bluesky_crypt_block_encrypt(data, item_size, keys);
 513
 514         data += item_size;
 515         remaining_size -= item_size;
 516     }
 517 }
 518
 519 /* Make an decryption pass over a cloud log segment to decrypt items which were
 520  * encrypted.  TODO: Also computes a list of all offsets which at which valid
 521  * cloud log items are found. */
 522 void bluesky_cloudlog_decrypt(char *segment, size_t len, BlueSkyCryptKeys *keys)
 523 {
 524     char *data = segment;
 525     size_t remaining_size = len;
 526
 527     while (remaining_size >= sizeof(struct cloudlog_header)) {
 528         struct cloudlog_header *header = (struct cloudlog_header *)data;
 529         size_t item_size = sizeof(struct cloudlog_header)
 530                            + GUINT32_FROM_LE(header->size1)
 531                            + GUINT32_FROM_LE(header->size2)
 532                            + GUINT32_FROM_LE(header->size3);
 533         if (item_size > remaining_size)
 534             break;
 535         if (bluesky_crypt_block_decrypt(data, item_size, keys)) {
 536             g_print("Decrypted valid cloud log item at offset %zd\n",
 537                     data - segment);
 538         }
 539
 540         data += item_size;
 541         remaining_size -= item_size;
 542     }
 543 }