bluesky/bluesky-private.h

   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 /* 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. */
  12
  13 #ifndef _BLUESKY_PRIVATE_H
  14 #define _BLUESKY_PRIVATE_H
  15
  16 #include "bluesky.h"
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif
  21
  22 extern int bluesky_verbose;
  23
  24 /* Target cache size levels. */
  25 extern int bluesky_watermark_low_dirty;
  26 extern int bluesky_watermark_medium_dirty;
  27 extern int bluesky_watermark_high_dirty;
  28
  29 extern int bluesky_watermark_low_total;
  30 extern int bluesky_watermark_medium_total;
  31 extern int bluesky_watermark_high_total;
  32
  33 /* TODO: Make this go away entirely. */
  34 BlueSkyFS *bluesky_new_fs(gchar *name);
  35
  36 /* Linked list update functions for LRU lists. */
  37 void bluesky_list_unlink(GList *head, GList *item);
  38 GList *bluesky_list_prepend(GList *head, BlueSkyInode *inode);
  39 GList *bluesky_list_append(GList *head, BlueSkyInode *inode);
  40 BlueSkyInode *bluesky_list_head(GList *head);
  41 BlueSkyInode *bluesky_list_tail(GList *head);
  42
  43 /* Serialization and deserialization of filesystem data for storing to
  44  * persistent storage. */
  45 void bluesky_serialize_superblock(GString *out, BlueSkyFS *fs);
  46 BlueSkyFS *bluesky_deserialize_superblock(const gchar *buf);
  47 void bluesky_serialize_inode(GString *out, BlueSkyInode *inode);
  48 gboolean bluesky_deserialize_inode(BlueSkyInode *inode, const gchar *buf);
  49
  50 /* Storage layer.  Requests can be performed asynchronously, so these objects
  51  * help keep track of operations in progress. */
  52 typedef enum {
  53     STORE_OP_NONE,
  54     STORE_OP_GET,
  55     STORE_OP_PUT,
  56     STORE_OP_DELETE,
  57     STORE_OP_BARRIER,       // Waits for other selected operations to complete
  58 } BlueSkyStoreOp;
  59
  60 typedef enum {
  61     ASYNC_NEW,              // Operation not yet submitted to storage layer
  62     ASYNC_PENDING,          // Submitted to storage layer
  63     ASYNC_RUNNING,          // Operation is in progress
  64     ASYNC_COMPLETE,         // Operation finished, results available
  65 } BlueSkyAsyncStatus;
  66
  67 struct BlueSkyNotifierList;
  68 typedef struct _BlueSkyStoreAsync BlueSkyStoreAsync;
  69 struct _BlueSkyStoreAsync {
  70     BlueSkyStore *store;
  71
  72     GMutex *lock;
  73     GCond *completion_cond;     /* Used to wait for operation to complete. */
  74
  75     gint refcount;              /* Reference count for destruction. */
  76
  77     BlueSkyAsyncStatus status;
  78
  79     BlueSkyStoreOp op;
  80     gchar *key;                 /* Key to read/write */
  81     BlueSkyRCStr *data;         /* Data read/to write */
  82
  83     int result;                 /* Result code; 0 for success. */
  84     struct BlueSkyNotifierList *notifiers;
  85     gint notifier_count;
  86
  87     /* The barrier waiting on this operation.  Support for more than one
  88      * barrier for a single async is not well-supported and should be avoided
  89      * if possible. */
  90     BlueSkyStoreAsync *barrier;
  91
  92     bluesky_time_hires start_time;  /* Time operation was submitted. */
  93     bluesky_time_hires exec_time;   /* Time processing started on operation. */
  94
  95     gpointer store_private;     /* For use by the storage implementation */
  96 };
  97
  98 /* Support for notification lists.  These are lists of one-shot functions which
  99  * can be called when certain events--primarily, competed storage
 100  * events--occur.  Multiple notifiers can be added, but no particular order is
 101  * guaranteed for the notification functions to be called. */
 102 struct BlueSkyNotifierList {
 103     struct BlueSkyNotifierList *next;
 104     GFunc func;
 105     BlueSkyStoreAsync *async;
 106     gpointer user_data;     // Passed to the function when called
 107 };
 108
 109 /* The abstraction layer for storage, allowing multiple implementations. */
 110 typedef struct {
 111     /* Create a new store instance and return a handle to it. */
 112     gpointer (*create)(const gchar *path);
 113
 114     /* Clean up any resources used by this store. */
 115     void (*destroy)(gpointer store);
 116
 117     /* Submit an operation (get/put/delete) to the storage layer to be
 118      * performed asynchronously. */
 119     void (*submit)(gpointer store, BlueSkyStoreAsync *async);
 120
 121     /* Clean up any implementation-private data in a BlueSkyStoreAsync. */
 122     void (*cleanup)(gpointer store, BlueSkyStoreAsync *async);
 123 } BlueSkyStoreImplementation;
 124
 125 void bluesky_store_register(const BlueSkyStoreImplementation *impl,
 126                             const gchar *name);
 127
 128 BlueSkyStoreAsync *bluesky_store_async_new(BlueSkyStore *store);
 129 gpointer bluesky_store_async_get_handle(BlueSkyStoreAsync *async);
 130 void bluesky_store_async_ref(BlueSkyStoreAsync *async);
 131 void bluesky_store_async_unref(BlueSkyStoreAsync *async);
 132 void bluesky_store_async_wait(BlueSkyStoreAsync *async);
 133 void bluesky_store_async_add_notifier(BlueSkyStoreAsync *async,
 134                                       GFunc func, gpointer user_data);
 135 void bluesky_store_async_mark_complete(BlueSkyStoreAsync *async);
 136 void bluesky_store_async_submit(BlueSkyStoreAsync *async);
 137 void bluesky_store_sync(BlueSkyStore *store);
 138
 139 void bluesky_store_add_barrier(BlueSkyStoreAsync *barrier,
 140                                BlueSkyStoreAsync *async);
 141
 142 void bluesky_inode_start_sync(BlueSkyInode *inode);
 143
 144 void bluesky_block_touch(BlueSkyInode *inode, uint64_t i);
 145 void bluesky_block_fetch(BlueSkyInode *inode, BlueSkyBlock *block,
 146                          BlueSkyStoreAsync *barrier);
 147 void bluesky_block_flush(BlueSkyInode *inode, BlueSkyBlock *block,
 148                          GList **log_items);
 149 void bluesky_file_flush(BlueSkyInode *inode, GList **log_items);
 150 void bluesky_file_drop_cached(BlueSkyInode *inode);
 151
 152 /* Writing of data to the cloud in log segments and tracking the location of
 153  * various pieces of data (both where in the cloud and where cached locally).
 154  * */
 155
 156 typedef struct {
 157     char bytes[16];
 158 } BlueSkyCloudID;
 159
 160 typedef struct {
 161     uint32_t directory;
 162     uint32_t sequence;
 163     uint32_t offset;
 164     uint32_t size;
 165 } BlueSkyCloudPointer;
 166
 167 typedef enum {
 168     LOGTYPE_INVALID = -1,
 169     LOGTYPE_UNKNOWN = 0,
 170     LOGTYPE_DATA = 1,
 171     LOGTYPE_INODE = 2,
 172     LOGTYPE_INODE_MAP = 3,
 173     LOGTYPE_CHECKPOINT = 4,
 174     LOGTYPE_CHECKPOINT_PTR = 5,
 175 } BlueSkyCloudLogType;
 176
 177 /* A record which tracks an object which has been written to a local log,
 178  * cached, locally, and/or written to the cloud. */
 179 #define CLOUDLOG_JOURNAL    0x01
 180 #define CLOUDLOG_CLOUD      0x02
 181 #define CLOUDLOG_CACHE      0x04
 182 struct _BlueSkyCloudLog {
 183     gint refcount;
 184     GMutex *lock;
 185     GCond *cond;
 186
 187     BlueSkyFS *fs;
 188
 189     BlueSkyCloudLogType type;
 190
 191     // Bitmask of CLOUDLOG_* flags indicating where the object exists.
 192     int location_flags;
 193     int pending_read, pending_write;
 194
 195     // A stable identifier for the object (only changes when authenticated data
 196     // is written out, but stays the same when the in-cloud cleaner relocates
 197     // the object).
 198     BlueSkyCloudID id;
 199
 200     // The inode which owns this data, if any, and an offset.
 201     uint64_t inum;
 202     int32_t inum_offset;
 203
 204     // The location of the object in the cloud, if available.
 205     BlueSkyCloudPointer location;
 206
 207     // TODO: Location in journal/cache
 208     int log_seq, log_offset, log_size;
 209
 210     // Pointers to other objects
 211     GArray *pointers;
 212
 213     // Serialized data, if available in memory (otherwise NULL), and a lock
 214     // count which tracks if there are users that require the data to be kept
 215     // around.
 216     BlueSkyRCStr *data;
 217     int data_lock_count;
 218 };
 219
 220 /* Serialize objects into a log segment to be written to the cloud. */
 221 struct _BlueSkyCloudLogState {
 222     GString *data;
 223     BlueSkyCloudPointer location;
 224     GList *inode_list;
 225 };
 226
 227 gboolean bluesky_cloudlog_equal(gconstpointer a, gconstpointer b);
 228 guint bluesky_cloudlog_hash(gconstpointer a);
 229 BlueSkyCloudLog *bluesky_cloudlog_new(BlueSkyFS *fs);
 230 gchar *bluesky_cloudlog_id_to_string(BlueSkyCloudID id);
 231 BlueSkyCloudID bluesky_cloudlog_id_from_string(const gchar *idstr);
 232 void bluesky_cloudlog_ref(BlueSkyCloudLog *log);
 233 void bluesky_cloudlog_unref(BlueSkyCloudLog *log);
 234 void bluesky_cloudlog_sync(BlueSkyCloudLog *log);
 235 void bluesky_cloudlog_insert(BlueSkyCloudLog *log);
 236 void bluesky_cloudlog_write_log(BlueSkyFS *fs);
 237 void bluesky_cloudlog_fetch(BlueSkyCloudLog *log);
 238
 239 /* Logging infrastructure for ensuring operations are persistently recorded to
 240  * disk. */
 241 #define BLUESKY_CRC32C_SEED (~(uint32_t)0)
 242 uint32_t crc32c(uint32_t crc, const char *buf, unsigned int length);
 243 uint32_t crc32c_finalize(uint32_t crc);
 244
 245 struct _BlueSkyLog {
 246     char *log_directory;
 247     GAsyncQueue *queue;
 248     int fd, dirfd;
 249     int seq_num;
 250     GSList *committed;
 251
 252     /* Cache of log segments which have been memory-mapped. */
 253     GMutex *mmap_lock;
 254     GHashTable *mmap_cache;
 255 };
 256
 257 /* Reference-counted blocks of memory, used for passing data in and out of
 258  * storage backends and in other places.  This may also refer to read-only
 259  * mmaped data. */
 260 struct _BlueSkyMmap {
 261     gint refcount;
 262     int log_seq;
 263     const char *addr;
 264     size_t len;
 265     BlueSkyLog *log;
 266 };
 267
 268 BlueSkyLog *bluesky_log_new(const char *log_directory);
 269 void bluesky_log_item_submit(BlueSkyCloudLog *item, BlueSkyLog *log);
 270 void bluesky_log_finish_all(GList *log_items);
 271 BlueSkyRCStr *bluesky_log_map_object(BlueSkyLog *log, int log_seq,
 272                                      int log_offset, int log_size);
 273 void bluesky_mmap_unref(BlueSkyMmap *mmap);
 274
 275 #ifdef __cplusplus
 276 }
 277 #endif
 278
 279 #endif