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     bluesky_time_hires latency = bluesky_now_hires() - async->exec_time;
 201
 202     if (async->op != STORE_OP_BARRIER) {
 203         g_mutex_lock(async->store->lock);
 204         async->store->pending--;
 205         if (async->store->pending == 0)
 206             g_cond_broadcast(async->store->cond_idle);
 207         g_mutex_unlock(async->store->lock);
 208     }
 209
 210     async->status = ASYNC_COMPLETE;
 211     g_cond_broadcast(async->completion_cond);
 212
 213     if (async->barrier != NULL && async->notifiers == NULL)
 214         op_complete(async, async->barrier);
 215
 216     while (async->notifiers != NULL) {
 217         struct BlueSkyNotifierList *nl = async->notifiers;
 218         async->notifiers = nl->next;
 219         g_thread_pool_push(notifier_thread_pool, nl, NULL);
 220     }
 221
 222     g_log("bluesky/store", G_LOG_LEVEL_DEBUG,
 223           "[%p] complete: elapsed = %"PRIi64" ns, latency = %"PRIi64" ns",
 224           async, elapsed, latency);
 225 }
 226
 227 void bluesky_store_async_submit(BlueSkyStoreAsync *async)
 228 {
 229     BlueSkyStore *store = async->store;
 230
 231     async->start_time = bluesky_now_hires();
 232
 233     // Backends should fill this in with a better estimate of the actual time
 234     // processing was started, if there could be a delay from submission time.
 235     async->exec_time = bluesky_now_hires();
 236
 237     g_log("bluesky/store", G_LOG_LEVEL_DEBUG, "[%p] submit: %s %s",
 238           async,
 239           async->op == STORE_OP_GET ? "GET"
 240             : async->op == STORE_OP_PUT ? "PUT"
 241             : async->op == STORE_OP_DELETE ? "DELETE"
 242             : async->op == STORE_OP_BARRIER ? "BARRIER" : "???",
 243           async->key);
 244
 245     /* Barriers are handled specially, and not handed down the storage
 246      * implementation layer. */
 247     if (async->op == STORE_OP_BARRIER) {
 248         async->status = ASYNC_RUNNING;
 249         if (GPOINTER_TO_INT(async->store_private) == 0)
 250             bluesky_store_async_mark_complete(async);
 251         return;
 252     }
 253
 254     g_mutex_lock(async->store->lock);
 255     async->store->pending++;
 256     g_mutex_unlock(async->store->lock);
 257
 258     store->impl->submit(store->handle, async);
 259
 260     if (bluesky_options.synchronous_stores)
 261         bluesky_store_async_wait(async);
 262 }
 263
 264 /* Add the given operation to the barrier.  The barrier will not complete until
 265  * all operations added to it have completed. */
 266 void bluesky_store_add_barrier(BlueSkyStoreAsync *barrier,
 267                                BlueSkyStoreAsync *async)
 268 {
 269     g_return_if_fail(barrier->op == STORE_OP_BARRIER);
 270
 271     g_mutex_lock(barrier->lock);
 272     barrier->store_private
 273         = GINT_TO_POINTER(GPOINTER_TO_INT(barrier->store_private) + 1);
 274     g_mutex_unlock(barrier->lock);
 275
 276     g_mutex_lock(async->lock);
 277     if (async->barrier == NULL) {
 278         async->barrier = barrier;
 279     } else {
 280         g_warning("Adding async to more than one barrier!\n");
 281         bluesky_store_async_add_notifier(async, op_complete, barrier);
 282     }
 283     g_mutex_unlock(async->lock);
 284 }
 285
 286 static void notifier_task(gpointer n, gpointer s)
 287 {
 288     struct BlueSkyNotifierList *notifier = (struct BlueSkyNotifierList *)n;
 289
 290     notifier->func(notifier->async, notifier->user_data);
 291     if (g_atomic_int_dec_and_test(&notifier->async->notifier_count)) {
 292         g_mutex_lock(notifier->async->lock);
 293         if (notifier->async->barrier != NULL)
 294             op_complete(notifier->async, notifier->async->barrier);
 295         g_cond_broadcast(notifier->async->completion_cond);
 296         g_mutex_unlock(notifier->async->lock);
 297     }
 298     bluesky_store_async_unref(notifier->async);
 299     g_free(notifier);
 300 }
 301
 302 void bluesky_store_sync(BlueSkyStore *store)
 303 {
 304     g_mutex_lock(store->lock);
 305     g_print("Waiting for pending store operations to complete...\n");
 306     while (store->pending > 0) {
 307         g_cond_wait(store->cond_idle, store->lock);
 308     }
 309     g_mutex_unlock(store->lock);
 310     g_print("Operations are complete.\n");
 311 }
 312
 313 /* Convenience wrappers that perform a single operation synchronously. */
 314 BlueSkyRCStr *bluesky_store_get(BlueSkyStore *store, const gchar *key)
 315 {
 316     BlueSkyStoreAsync *async = bluesky_store_async_new(store);
 317     async->op = STORE_OP_GET;
 318     async->key = g_strdup(key);
 319     bluesky_store_async_submit(async);
 320
 321     bluesky_store_async_wait(async);
 322
 323     BlueSkyRCStr *data = async->data;
 324     bluesky_string_ref(data);
 325     bluesky_store_async_unref(async);
 326     return data;
 327 }
 328
 329 void bluesky_store_put(BlueSkyStore *store,
 330                        const gchar *key, BlueSkyRCStr *val)
 331 {
 332     BlueSkyStoreAsync *async = bluesky_store_async_new(store);
 333     async->op = STORE_OP_PUT;
 334     async->key = g_strdup(key);
 335     bluesky_string_ref(val);
 336     async->data = val;
 337     bluesky_store_async_submit(async);
 338
 339     bluesky_store_async_wait(async);
 340     bluesky_store_async_unref(async);
 341 }
 342
 343 /* Simple in-memory data store for test purposes. */
 344 typedef struct {
 345     GMutex *lock;
 346
 347     /* TODO: A hashtable isn't optimal for list queries... */
 348     GHashTable *store;
 349 } MemStore;
 350
 351 static gpointer memstore_create(const gchar *path)
 352 {
 353     MemStore *store = g_new(MemStore, 1);
 354     store->lock = g_mutex_new();
 355     store->store = g_hash_table_new_full(g_str_hash, g_str_equal,
 356                                          g_free,
 357                                          (GDestroyNotify)bluesky_string_unref);
 358
 359     return (gpointer)store;
 360 }
 361
 362 static void memstore_destroy(gpointer store)
 363 {
 364     /* TODO */
 365 }
 366
 367 static BlueSkyRCStr *memstore_get(gpointer st, const gchar *key)
 368 {
 369     MemStore *store = (MemStore *)st;
 370     BlueSkyRCStr *s = g_hash_table_lookup(store->store, key);
 371     if (s != NULL)
 372         bluesky_string_ref(s);
 373     return s;
 374 }
 375
 376 static void memstore_put(gpointer s, const gchar *key, BlueSkyRCStr *val)
 377 {
 378     MemStore *store = (MemStore *)s;
 379     bluesky_string_ref(val);
 380     g_hash_table_insert(store->store, g_strdup(key), val);
 381 }
 382
 383 static void memstore_submit(gpointer s, BlueSkyStoreAsync *async)
 384 {
 385     g_return_if_fail(async->status == ASYNC_NEW);
 386     g_return_if_fail(async->op != STORE_OP_NONE);
 387
 388     switch (async->op) {
 389     case STORE_OP_GET:
 390         async->data = memstore_get(s, async->key);
 391         break;
 392
 393     case STORE_OP_PUT:
 394         memstore_put(s, async->key, async->data);
 395         break;
 396
 397     default:
 398         g_warning("Uknown operation type for MemStore: %d\n", async->op);
 399         return;
 400     }
 401
 402     bluesky_store_async_mark_complete(async);
 403 }
 404
 405 static void memstore_cleanup(gpointer store, BlueSkyStoreAsync *async)
 406 {
 407 }
 408
 409 static BlueSkyStoreImplementation memstore_impl = {
 410     .create = memstore_create,
 411     .destroy = memstore_destroy,
 412     .submit = memstore_submit,
 413     .cleanup = memstore_cleanup,
 414 };
 415
 416 /* Store implementation which writes data as files to disk. */
 417 static gpointer filestore_create(const gchar *path)
 418 {
 419     return GINT_TO_POINTER(1);
 420 }
 421
 422 static void filestore_destroy()
 423 {
 424 }
 425
 426 static BlueSkyRCStr *filestore_get(const gchar *key)
 427 {
 428     gchar *contents = NULL;
 429     gsize length;
 430     GError *error = NULL;
 431
 432     g_file_get_contents(key, &contents, &length, &error);
 433     if (contents == NULL)
 434         return NULL;
 435
 436     return bluesky_string_new(contents, length);
 437 }
 438
 439 static void filestore_put(const gchar *key, BlueSkyRCStr *val)
 440 {
 441     g_file_set_contents(key, val->data, val->len, NULL);
 442 }
 443
 444 static void filestore_submit(gpointer s, BlueSkyStoreAsync *async)
 445 {
 446     g_return_if_fail(async->status == ASYNC_NEW);
 447     g_return_if_fail(async->op != STORE_OP_NONE);
 448
 449     switch (async->op) {
 450     case STORE_OP_GET:
 451         async->data = filestore_get(async->key);
 452         async->result = 0;
 453         break;
 454
 455     case STORE_OP_PUT:
 456         filestore_put(async->key, async->data);
 457         async->result = 0;
 458         break;
 459
 460     default:
 461         g_warning("Uknown operation type for FileStore: %d\n", async->op);
 462         return;
 463     }
 464
 465     bluesky_store_async_mark_complete(async);
 466 }
 467
 468 static void filestore_cleanup(gpointer store, BlueSkyStoreAsync *async)
 469 {
 470 }
 471
 472 static BlueSkyStoreImplementation filestore_impl = {
 473     .create = filestore_create,
 474     .destroy = filestore_destroy,
 475     .submit = filestore_submit,
 476     .cleanup = filestore_cleanup,
 477 };
 478
 479 void bluesky_store_init()
 480 {
 481     store_implementations = g_hash_table_new(g_str_hash, g_str_equal);
 482     notifier_thread_pool = g_thread_pool_new(notifier_task, NULL,
 483                                              bluesky_max_threads, FALSE, NULL);
 484     bluesky_store_register(&memstore_impl, "mem");
 485     bluesky_store_register(&filestore_impl, "file");
 486 }