1 /* Blue Sky: File Systems in the Cloud
3 * Copyright (C) 2009 The Regents of the University of California
4 * Written by Michael Vrable <mvrable@cs.ucsd.edu>
9 /* Declarations internal to the BlueSky library. This header file should not
10 * be included by any users of the library (such as any filesystem
11 * proxy)--external users should only include bluesky.h. */
13 #ifndef _BLUESKY_PRIVATE_H
14 #define _BLUESKY_PRIVATE_H
22 /* TODO: Make this go away entirely. */
23 BlueSkyFS *bluesky_new_fs(gchar *name);
25 /* Serialization and deserialization of filesystem data for storing to
26 * persistent storage. */
27 void bluesky_serialize_superblock(GString *out, BlueSkyFS *fs);
28 BlueSkyFS *bluesky_deserialize_superblock(const gchar *buf);
29 void bluesky_serialize_inode(GString *out, BlueSkyInode *inode);
30 gboolean bluesky_deserialize_inode(BlueSkyInode *inode, const gchar *buf);
32 /* Storage layer. Requests can be performed asynchronously, so these objects
33 * help keep track of operations in progress. */
39 STORE_OP_BARRIER, // Waits for other selected operations to complete
43 ASYNC_NEW, // Operation not yet submitted to storage layer
44 ASYNC_PENDING, // Submitted to storage layer
45 ASYNC_RUNNING, // Operation is in progress
46 ASYNC_COMPLETE, // Operation finished, results available
49 struct BlueSkyNotifierList;
54 GCond *completion_cond; /* Used to wait for operation to complete. */
56 gint refcount; /* Reference count for destruction. */
58 BlueSkyAsyncStatus status;
61 gchar *key; /* Key to read/write */
62 BlueSkyRCStr *data; /* Data read/to write */
64 int result; /* Result code; 0 for success. */
65 struct BlueSkyNotifierList *notifiers;
67 bluesky_time_hires start_time; /* Time operation was submitted. */
69 gpointer store_private; /* For use by the storage implementation */
72 /* Support for notification lists. These are lists of one-shot functions which
73 * can be called when certain events--primarily, competed storage
74 * events--occur. Multiple notifiers can be added, but no particular order is
75 * guaranteed for the notification functions to be called. */
76 struct BlueSkyNotifierList {
77 struct BlueSkyNotifierList *next;
79 BlueSkyStoreAsync *async;
80 gpointer user_data; // Passed to the function when called
83 /* The abstraction layer for storage, allowing multiple implementations. */
85 /* Create a new store instance and return a handle to it. */
88 /* Clean up any resources used by this store. */
89 void (*destroy)(gpointer store);
91 /* Submit an operation (get/put/delete) to the storage layer to be
92 * performed asynchronously. */
93 void (*submit)(gpointer store, BlueSkyStoreAsync *async);
95 /* Clean up any implementation-private data in a BlueSkyStoreAsync. */
96 void (*cleanup)(gpointer store, BlueSkyStoreAsync *async);
97 } BlueSkyStoreImplementation;
99 void bluesky_store_register(const BlueSkyStoreImplementation *impl,
102 BlueSkyStoreAsync *bluesky_store_async_new(BlueSkyStore *store);
103 void bluesky_store_async_ref(BlueSkyStoreAsync *async);
104 void bluesky_store_async_unref(BlueSkyStoreAsync *async);
105 void bluesky_store_async_wait(BlueSkyStoreAsync *async);
106 void bluesky_store_async_add_notifier(BlueSkyStoreAsync *async,
107 GFunc func, gpointer user_data);
108 void bluesky_store_async_mark_complete(BlueSkyStoreAsync *async);
109 void bluesky_store_async_submit(BlueSkyStoreAsync *async);
110 void bluesky_store_sync(BlueSkyStore *store);
112 void bluesky_store_add_barrier(BlueSkyStoreAsync *barrier,
113 BlueSkyStoreAsync *async);
115 void bluesky_inode_start_sync(BlueSkyInode *inode, BlueSkyStoreAsync *barrier);
117 void bluesky_block_flush(BlueSkyFS *fs, BlueSkyBlock *block,
118 BlueSkyStoreAsync *barrier);
119 void bluesky_file_flush(BlueSkyInode *inode, BlueSkyStoreAsync *barrier);