Make kvstore backend in BlueSky asynchronous.

[bluesky.git] / bluesky / bluesky-private.h

diff --git a/bluesky/bluesky-private.h b/bluesky/bluesky-private.h
index a450085..320886c 100644 (file)
--- a/bluesky/bluesky-private.h
+++ b/bluesky/bluesky-private.h
@@ -27,7 +27,98 @@ BlueSkyFS *bluesky_new_fs(gchar *name);
 void bluesky_serialize_superblock(GString *out, BlueSkyFS *fs);
 BlueSkyFS *bluesky_deserialize_superblock(const gchar *buf);
 void bluesky_serialize_inode(GString *out, BlueSkyInode *inode);
-BlueSkyInode *bluesky_deserialize_inode(BlueSkyFS *fs, const gchar *buf);
+gboolean bluesky_deserialize_inode(BlueSkyInode *inode, const gchar *buf);
+
+/* Storage layer.  Requests can be performed asynchronously, so these objects
+ * help keep track of operations in progress. */
+typedef enum {
+    STORE_OP_NONE,
+    STORE_OP_GET,
+    STORE_OP_PUT,
+    STORE_OP_DELETE,
+    STORE_OP_BARRIER,       // Waits for other selected operations to complete
+} BlueSkyStoreOp;
+
+typedef enum {
+    ASYNC_NEW,              // Operation not yet submitted to storage layer
+    ASYNC_PENDING,          // Submitted to storage layer
+    ASYNC_RUNNING,          // Operation is in progress
+    ASYNC_COMPLETE,         // Operation finished, results available
+} BlueSkyAsyncStatus;
+
+struct BlueSkyNotifierList;
+typedef struct {
+    BlueSkyStore *store;
+
+    GMutex *lock;
+    GCond *completion_cond;     /* Used to wait for operation to complete. */
+
+    gint refcount;              /* Reference count for destruction. */
+
+    BlueSkyAsyncStatus status;
+
+    BlueSkyStoreOp op;
+    gchar *key;                 /* Key to read/write */
+    BlueSkyRCStr *data;         /* Data read/to write */
+
+    int result;                 /* Result code; 0 for success. */
+    struct BlueSkyNotifierList *notifiers;
+
+    bluesky_time_hires start_time;  /* Time operation was submitted. */
+
+    gpointer store_private;     /* For use by the storage implementation */
+} BlueSkyStoreAsync;
+
+/* Support for notification lists.  These are lists of one-shot functions which
+ * can be called when certain events--primarily, competed storage
+ * events--occur.  Multiple notifiers can be added, but no particular order is
+ * guaranteed for the notification functions to be called. */
+struct BlueSkyNotifierList {
+    struct BlueSkyNotifierList *next;
+    GFunc func;
+    BlueSkyStoreAsync *async;
+    gpointer user_data;     // Passed to the function when called
+};
+
+/* The abstraction layer for storage, allowing multiple implementations. */
+typedef struct {
+    /* Create a new store instance and return a handle to it. */
+    gpointer (*create)();
+
+    /* Clean up any resources used by this store. */
+    void (*destroy)(gpointer store);
+
+    /* Submit an operation (get/put/delete) to the storage layer to be
+     * performed asynchronously. */
+    void (*submit)(gpointer store, BlueSkyStoreAsync *async);
+
+    /* Clean up any implementation-private data in a BlueSkyStoreAsync. */
+    void (*cleanup)(gpointer store, BlueSkyStoreAsync *async);
+} BlueSkyStoreImplementation;
+
+void bluesky_store_register(const BlueSkyStoreImplementation *impl,
+                            const gchar *name);
+
+BlueSkyStoreAsync *bluesky_store_async_new(BlueSkyStore *store);
+gpointer bluesky_store_async_get_handle(BlueSkyStoreAsync *async);
+void bluesky_store_async_ref(BlueSkyStoreAsync *async);
+void bluesky_store_async_unref(BlueSkyStoreAsync *async);
+void bluesky_store_async_wait(BlueSkyStoreAsync *async);
+void bluesky_store_async_add_notifier(BlueSkyStoreAsync *async,
+                                      GFunc func, gpointer user_data);
+void bluesky_store_async_mark_complete(BlueSkyStoreAsync *async);
+void bluesky_store_async_submit(BlueSkyStoreAsync *async);
+void bluesky_store_sync(BlueSkyStore *store);
+
+void bluesky_store_add_barrier(BlueSkyStoreAsync *barrier,
+                               BlueSkyStoreAsync *async);
+
+void bluesky_inode_start_sync(BlueSkyInode *inode, BlueSkyStoreAsync *barrier);
+
+void bluesky_block_flush(BlueSkyFS *fs, BlueSkyBlock *block,
+                         BlueSkyStoreAsync *barrier);
+void bluesky_file_flush(BlueSkyInode *inode, BlueSkyStoreAsync *barrier);
+void bluesky_file_drop_cached(BlueSkyInode *inode);
 
 #ifdef __cplusplus
 }