bluesky/store.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 <stdint.h>
  10 #include <glib.h>
  11 #include <string.h>
  12
  13 #include "bluesky-private.h"
  14
  15 /* Interaction with cloud storage.  We expose very simple GET/PUT style
  16  * interface, which different backends can implement.  Available backends
  17  * (will) include Amazon S3 and a simple local store for testing purposes.
  18  * Operations may be performed asynchronously. */
  19
  20 struct _BlueSkyStore {
  21     const BlueSkyStoreImplementation *impl;
  22     gpointer handle;
  23
  24     GMutex *lock;
  25     GCond *cond_idle;
  26     int pending;                /* Count of operations not yet complete. */
  27 };
  28
  29 GHashTable *store_implementations;
  30
  31 /* Thread pool for calling notifier functions when an operation completes.
  32  * These are called in a separate thread for locking reasons: we want to call
  33  * the notifiers without the lock on the async object held, but completion
  34  * occurs when the lock is held--so we need some way to defer the call.  This
  35  * isn't really optimal from a cache-locality standpoint. */
  36 static GThreadPool *notifier_thread_pool;
  37
  38 void bluesky_store_register(const BlueSkyStoreImplementation *impl,
  39                             const gchar *name)
  40 {
  41     g_hash_table_insert(store_implementations, g_strdup(name), (gpointer)impl);
  42 }
  43
  44 BlueSkyStore *bluesky_store_new(const gchar *type)
  45 {
  46     const BlueSkyStoreImplementation *impl;
  47
  48     gchar *scheme, *path;
  49     scheme = g_strdup(type);
  50     path = strchr(scheme, ':');
  51     if (path != NULL) {
  52         *path = '\0';
  53         path++;
  54     }
  55
  56     impl = g_hash_table_lookup(store_implementations, scheme);
  57     if (impl == NULL) {
  58         g_free(scheme);
  59         return NULL;
  60     }
  61
  62     gpointer handle = impl->create(path);
  63     if (handle == NULL) {
  64         g_free(scheme);
  65         return NULL;
  66     }
  67
  68     BlueSkyStore *store = g_new(BlueSkyStore, 1);
  69     store->impl = impl;
  70     store->handle = handle;
  71     store->lock = g_mutex_new();
  72     store->cond_idle = g_cond_new();
  73     store->pending = 0;
  74     g_free(scheme);
  75     return store;
  76 }
  77
  78 void bluesky_store_free(BlueSkyStore *store)
  79 {
  80     store->impl->destroy(store->handle);
  81     g_free(store);
  82 }
  83
  84 BlueSkyStoreAsync *bluesky_store_async_new(BlueSkyStore *store)
  85 {
  86     BlueSkyStoreAsync *async;
  87
  88     async = g_new(BlueSkyStoreAsync, 1);
  89     async->store = store;
  90     async->lock = g_mutex_new();
  91     async->completion_cond = g_cond_new();
  92     async->refcount = 1;
  93     async->status = ASYNC_NEW;
  94     async->op = STORE_OP_NONE;
  95     async->key = NULL;
  96     async->data = NULL;
  97     async->result = -1;
  98     async->notifiers = NULL;
  99     async->notifier_count = 0;
 100     async->barrier = NULL;
 101     async->store_private = NULL;
 102
 103     return async;
 104 }
 105
 106 gpointer bluesky_store_async_get_handle(BlueSkyStoreAsync *async)
 107 {
 108     return async->store->handle;
 109 }
 110
 111 void bluesky_store_async_ref(BlueSkyStoreAsync *async)
 112 {
 113     if (async == NULL)
 114         return;
 115
 116     g_return_if_fail(g_atomic_int_get(&async->refcount) > 0);
 117
 118     g_atomic_int_inc(&async->refcount);
 119 }
 120
 121 void bluesky_store_async_unref(BlueSkyStoreAsync *async)
 122 {
 123     if (async == NULL)
 124         return;
 125
 126     if (g_atomic_int_dec_and_test(&async->refcount)) {
 127         async->store->impl->cleanup(async->store->handle, async);
 128         g_mutex_free(async->lock);
 129         g_cond_free(async->completion_cond);
 130         g_free(async->key);
 131         bluesky_string_unref(async->data);
 132         g_free(async);
 133     }
 134 }
 135
 136 /* Block until the given operation has completed. */
 137 void bluesky_store_async_wait(BlueSkyStoreAsync *async)
 138 {
 139     g_return_if_fail(async != NULL);
 140     g_mutex_lock(async->lock);
 141
 142     if (async->status == ASYNC_NEW) {
 143         g_error("bluesky_store_async_wait on a new async object!\n");
 144         g_mutex_unlock(async->lock);
 145         return;
 146     }
 147
 148     while (async->status != ASYNC_COMPLETE
 149            || g_atomic_int_get(&async->notifier_count) > 0) {
 150         g_cond_wait(async->completion_cond, async->lock);
 151     }
 152
 153     g_mutex_unlock(async->lock);
 154 }
 155
 156 /* Add a notifier function to be called when the operation completes. */
 157 void bluesky_store_async_add_notifier(BlueSkyStoreAsync *async,
 158                                       GFunc func, gpointer user_data)
 159 {
 160     struct BlueSkyNotifierList *nl = g_new(struct BlueSkyNotifierList, 1);
 161     g_mutex_lock(async->lock);
 162     nl->next = async->notifiers;
 163     nl->func = func;
 164     nl->async = async; bluesky_store_async_ref(async);
 165     nl->user_data = user_data;
 166     g_atomic_int_inc(&async->notifier_count);
 167     if (async->status == ASYNC_COMPLETE) {
 168         g_thread_pool_push(notifier_thread_pool, nl, NULL);
 169     } else {
 170         async->notifiers = nl;
 171     }
 172     g_mutex_unlock(async->lock);
 173 }
 174
 175 static void op_complete(gpointer a, gpointer b)
 176 {
 177     BlueSkyStoreAsync *barrier = (BlueSkyStoreAsync *)b;
 178
 179     bluesky_store_async_ref(barrier);
 180     g_mutex_lock(barrier->lock);
 181     barrier->store_private
 182         = GINT_TO_POINTER(GPOINTER_TO_INT(barrier->store_private) - 1);
 183     if (GPOINTER_TO_INT(barrier->store_private) == 0
 184             && barrier->status != ASYNC_NEW) {
 185         bluesky_store_async_mark_complete(barrier);
 186     }
 187     g_mutex_unlock(barrier->lock);
 188     bluesky_store_async_unref(barrier);
 189 }
 190
 191 /* Mark an asynchronous operation as complete.  This should only be called by
 192  * the store implementations.  The lock should be held when calling this
 193  * function.  Any notifier functions will be called, but in a separate thread
 194  * and without the lock held. */
 195 void bluesky_store_async_mark_complete(BlueSkyStoreAsync *async)
 196 {
 197     g_return_if_fail(async->status != ASYNC_COMPLETE);
 198
 199     bluesky_time_hires elapsed = bluesky_now_hires() - async->start_time;
 200
 201     g_mutex_lock(async->store->lock);
 202     async->store->pending--;
 203     if (async->store->pending == 0)
 204         g_cond_broadcast(async->store->cond_idle);
 205     g_mutex_unlock(async->store->lock);
 206
 207     async->status = ASYNC_COMPLETE;
 208     g_cond_broadcast(async->completion_cond);
 209
 210     if (async->barrier != NULL && async->notifiers == NULL)
 211         op_complete(async, async->barrier);
 212
 213     while (async->notifiers != NULL) {
 214         struct BlueSkyNotifierList *nl = async->notifiers;
 215         async->notifiers = nl->next;
 216         g_thread_pool_push(notifier_thread_pool, nl, NULL);
 217     }
 218
 219     g_log("bluesky/store", G_LOG_LEVEL_DEBUG,
 220           "[%p] complete: elapsed = %"PRIi64" ns",
 221           async, elapsed);
 222 }
 223
 224 void bluesky_store_async_submit(BlueSkyStoreAsync *async)
 225 {
 226     BlueSkyStore *store = async->store;
 227
 228     async->start_time = bluesky_now_hires();
 229
 230     g_log("bluesky/store", G_LOG_LEVEL_DEBUG, "[%p] submit: %s %s",
 231           async,
 232           async->op == STORE_OP_GET ? "GET"
 233             : async->op == STORE_OP_PUT ? "PUT"
 234             : async->op == STORE_OP_DELETE ? "DELETE"
 235             : async->op == STORE_OP_BARRIER ? "BARRIER" : "???",
 236           async->key);
 237
 238     /* Barriers are handled specially, and not handed down the storage
 239      * implementation layer. */
 240     if (async->op == STORE_OP_BARRIER) {
 241         async->status = ASYNC_RUNNING;
 242         if (GPOINTER_TO_INT(async->store_private) == 0)
 243             bluesky_store_async_mark_complete(async);
 244         return;
 245     }
 246
 247     g_mutex_lock(async->store->lock);
 248     async->store->pending++;
 249     g_mutex_unlock(async->store->lock);
 250
 251     store->impl->submit(store->handle, async);
 252
 253     if (bluesky_options.synchronous_stores)
 254         bluesky_store_async_wait(async);
 255 }
 256
 257 /* Add the given operation to the barrier.  The barrier will not complete until
 258  * all operations added to it have completed. */
 259 void bluesky_store_add_barrier(BlueSkyStoreAsync *barrier,
 260                                BlueSkyStoreAsync *async)
 261 {
 262     g_return_if_fail(barrier->op == STORE_OP_BARRIER);
 263
 264     g_mutex_lock(barrier->lock);
 265     barrier->store_private
 266         = GINT_TO_POINTER(GPOINTER_TO_INT(barrier->store_private) + 1);
 267     g_mutex_unlock(barrier->lock);
 268
 269     g_mutex_lock(async->lock);
 270     if (async->barrier == NULL) {
 271         async->barrier = barrier;
 272     } else {
 273         g_warning("Adding async to more than one barrier!\n");
 274         bluesky_store_async_add_notifier(async, op_complete, barrier);
 275     }
 276     g_mutex_unlock(async->lock);
 277 }
 278
 279 static void notifier_task(gpointer n, gpointer s)
 280 {
 281     struct BlueSkyNotifierList *notifier = (struct BlueSkyNotifierList *)n;
 282
 283     notifier->func(notifier->async, notifier->user_data);
 284     if (g_atomic_int_dec_and_test(&notifier->async->notifier_count)) {
 285         g_mutex_lock(notifier->async->lock);
 286         if (notifier->async->barrier != NULL)
 287             op_complete(notifier->async, notifier->async->barrier);
 288         g_cond_broadcast(notifier->async->completion_cond);
 289         g_mutex_unlock(notifier->async->lock);
 290     }
 291     bluesky_store_async_unref(notifier->async);
 292     g_free(notifier);
 293 }
 294
 295 void bluesky_store_sync(BlueSkyStore *store)
 296 {
 297     g_mutex_lock(store->lock);
 298     g_print("Waiting for pending store operations to complete...\n");
 299     while (store->pending > 0) {
 300         g_cond_wait(store->cond_idle, store->lock);
 301     }
 302     g_mutex_unlock(store->lock);
 303     g_print("Operations are complete.\n");
 304 }
 305
 306 /* Convenience wrappers that perform a single operation synchronously. */
 307 BlueSkyRCStr *bluesky_store_get(BlueSkyStore *store, const gchar *key)
 308 {
 309     BlueSkyStoreAsync *async = bluesky_store_async_new(store);
 310     async->op = STORE_OP_GET;
 311     async->key = g_strdup(key);
 312     bluesky_store_async_submit(async);
 313
 314     bluesky_store_async_wait(async);
 315
 316     BlueSkyRCStr *data = async->data;
 317     bluesky_string_ref(data);
 318     bluesky_store_async_unref(async);
 319     return data;
 320 }
 321
 322 void bluesky_store_put(BlueSkyStore *store,
 323                        const gchar *key, BlueSkyRCStr *val)
 324 {
 325     BlueSkyStoreAsync *async = bluesky_store_async_new(store);
 326     async->op = STORE_OP_PUT;
 327     async->key = g_strdup(key);
 328     bluesky_string_ref(val);
 329     async->data = val;
 330     bluesky_store_async_submit(async);
 331
 332     bluesky_store_async_wait(async);
 333     bluesky_store_async_unref(async);
 334 }
 335
 336 /* Simple in-memory data store for test purposes. */
 337 typedef struct {
 338     GMutex *lock;
 339
 340     /* TODO: A hashtable isn't optimal for list queries... */
 341     GHashTable *store;
 342 } MemStore;
 343
 344 static gpointer memstore_create(const gchar *path)
 345 {
 346     MemStore *store = g_new(MemStore, 1);
 347     store->lock = g_mutex_new();
 348     store->store = g_hash_table_new_full(g_str_hash, g_str_equal,
 349                                          g_free,
 350                                          (GDestroyNotify)bluesky_string_unref);
 351
 352     return (gpointer)store;
 353 }
 354
 355 static void memstore_destroy(gpointer store)
 356 {
 357     /* TODO */
 358 }
 359
 360 static BlueSkyRCStr *memstore_get(gpointer st, const gchar *key)
 361 {
 362     MemStore *store = (MemStore *)st;
 363     BlueSkyRCStr *s = g_hash_table_lookup(store->store, key);
 364     if (s != NULL)
 365         bluesky_string_ref(s);
 366     return s;
 367 }
 368
 369 static void memstore_put(gpointer s, const gchar *key, BlueSkyRCStr *val)
 370 {
 371     MemStore *store = (MemStore *)s;
 372     bluesky_string_ref(val);
 373     g_hash_table_insert(store->store, g_strdup(key), val);
 374 }
 375
 376 static void memstore_submit(gpointer s, BlueSkyStoreAsync *async)
 377 {
 378     g_return_if_fail(async->status == ASYNC_NEW);
 379     g_return_if_fail(async->op != STORE_OP_NONE);
 380
 381     switch (async->op) {
 382     case STORE_OP_GET:
 383         async->data = memstore_get(s, async->key);
 384         break;
 385
 386     case STORE_OP_PUT:
 387         memstore_put(s, async->key, async->data);
 388         break;
 389
 390     default:
 391         g_warning("Uknown operation type for MemStore: %d\n", async->op);
 392         return;
 393     }
 394
 395     bluesky_store_async_mark_complete(async);
 396 }
 397
 398 static void memstore_cleanup(gpointer store, BlueSkyStoreAsync *async)
 399 {
 400 }
 401
 402 static BlueSkyStoreImplementation memstore_impl = {
 403     .create = memstore_create,
 404     .destroy = memstore_destroy,
 405     .submit = memstore_submit,
 406     .cleanup = memstore_cleanup,
 407 };
 408
 409 /* Store implementation which writes data as files to disk. */
 410 static gpointer filestore_create(const gchar *path)
 411 {
 412     return GINT_TO_POINTER(1);
 413 }
 414
 415 static void filestore_destroy()
 416 {
 417 }
 418
 419 static BlueSkyRCStr *filestore_get(const gchar *key)
 420 {
 421     gchar *contents = NULL;
 422     gsize length;
 423     GError *error = NULL;
 424
 425     g_file_get_contents(key, &contents, &length, &error);
 426     if (contents == NULL)
 427         return NULL;
 428
 429     return bluesky_string_new(contents, length);
 430 }
 431
 432 static void filestore_put(const gchar *key, BlueSkyRCStr *val)
 433 {
 434     g_file_set_contents(key, val->data, val->len, NULL);
 435 }
 436
 437 static void filestore_submit(gpointer s, BlueSkyStoreAsync *async)
 438 {
 439     g_return_if_fail(async->status == ASYNC_NEW);
 440     g_return_if_fail(async->op != STORE_OP_NONE);
 441
 442     switch (async->op) {
 443     case STORE_OP_GET:
 444         async->data = filestore_get(async->key);
 445         async->result = 0;
 446         break;
 447
 448     case STORE_OP_PUT:
 449         filestore_put(async->key, async->data);
 450         async->result = 0;
 451         break;
 452
 453     default:
 454         g_warning("Uknown operation type for FileStore: %d\n", async->op);
 455         return;
 456     }
 457
 458     bluesky_store_async_mark_complete(async);
 459 }
 460
 461 static void filestore_cleanup(gpointer store, BlueSkyStoreAsync *async)
 462 {
 463 }
 464
 465 static BlueSkyStoreImplementation filestore_impl = {
 466     .create = filestore_create,
 467     .destroy = filestore_destroy,
 468     .submit = filestore_submit,
 469     .cleanup = filestore_cleanup,
 470 };
 471
 472 void bluesky_store_init()
 473 {
 474     store_implementations = g_hash_table_new(g_str_hash, g_str_equal);
 475     notifier_thread_pool = g_thread_pool_new(notifier_task, NULL,
 476                                              bluesky_max_threads, FALSE, NULL);
 477     bluesky_store_register(&memstore_impl, "mem");
 478     bluesky_store_register(&filestore_impl, "file");
 479 }