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