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 BlueSkyCloudLog *bluesky_serialize_inode(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     // If the object is not yet flushed to cloud storage but is written to a
 196     // journal file locally, a reference to that journal file so that we can
 197     // keep the dirty_refs count updated.  When the object is deleted or
 198     // becomes clean, decrement the dirty_refs counter of the journal file and
 199     // set this pointer to NULL.
 200     BlueSkyCacheFile *dirty_journal;
 201
 202     // A stable identifier for the object (only changes when authenticated data
 203     // is written out, but stays the same when the in-cloud cleaner relocates
 204     // the object).
 205     BlueSkyCloudID id;
 206
 207     // The inode which owns this data, if any, and an offset.
 208     uint64_t inum;
 209     int32_t inum_offset;
 210
 211     // The location of the object in the cloud, if available.
 212     BlueSkyCloudPointer location;
 213
 214     // TODO: Location in journal/cache
 215     int log_seq, log_offset, log_size;
 216
 217     // Pointers to other objects.  Each link counts towards the reference count
 218     // of the pointed-to object.  To avoid memory leaks there should be no
 219     // cycles in the reference graph.
 220     GArray *links;
 221
 222     // Serialized data, if available in memory (otherwise NULL), and a lock
 223     // count which tracks if there are users that require the data to be kept
 224     // around.
 225     BlueSkyRCStr *data;
 226     int data_lock_count;
 227 };
 228
 229 /* Serialize objects into a log segment to be written to the cloud. */
 230 struct _BlueSkyCloudLogState {
 231     GString *data;
 232     BlueSkyCloudPointer location;
 233     GList *inode_list;
 234     GSList *writeback_list;     // Items which are being serialized right now
 235 };
 236
 237 gboolean bluesky_cloudlog_equal(gconstpointer a, gconstpointer b);
 238 guint bluesky_cloudlog_hash(gconstpointer a);
 239 BlueSkyCloudLog *bluesky_cloudlog_new(BlueSkyFS *fs);
 240 gchar *bluesky_cloudlog_id_to_string(BlueSkyCloudID id);
 241 BlueSkyCloudID bluesky_cloudlog_id_from_string(const gchar *idstr);
 242 void bluesky_cloudlog_ref(BlueSkyCloudLog *log);
 243 void bluesky_cloudlog_unref(BlueSkyCloudLog *log);
 244 void bluesky_cloudlog_stats_update(BlueSkyCloudLog *log, int type);
 245 void bluesky_cloudlog_sync(BlueSkyCloudLog *log);
 246 void bluesky_cloudlog_insert(BlueSkyCloudLog *log);
 247 void bluesky_cloudlog_fetch(BlueSkyCloudLog *log);
 248 BlueSkyCloudPointer bluesky_cloudlog_serialize(BlueSkyCloudLog *log,
 249                                                BlueSkyFS *fs);
 250 void bluesky_cloudlog_flush(BlueSkyFS *fs);
 251
 252 /* Logging infrastructure for ensuring operations are persistently recorded to
 253  * disk. */
 254 #define BLUESKY_CRC32C_SEED (~(uint32_t)0)
 255 uint32_t crc32c(uint32_t crc, const char *buf, unsigned int length);
 256 uint32_t crc32c_finalize(uint32_t crc);
 257
 258 struct _BlueSkyLog {
 259     BlueSkyFS *fs;
 260     char *log_directory;
 261     GAsyncQueue *queue;
 262     int fd, dirfd;
 263     int seq_num;
 264     GSList *committed;
 265
 266     /* The currently-open log file. */
 267     BlueSkyCacheFile *current_log;
 268
 269     /* Cache of log segments which have been memory-mapped. */
 270     GMutex *mmap_lock;
 271     GHashTable *mmap_cache;
 272
 273     /* A count of the disk space consumed (in 1024-byte units) by all files
 274      * tracked by mmap_cache (whether mapped or not, actually). */
 275     gint disk_used;
 276 };
 277
 278 /* An object for tracking log files which are stored locally--either the
 279  * journal for filesystem consistency or log segments which have been fetched
 280  * back from cloud storage. */
 281 struct _BlueSkyCacheFile {
 282     GMutex *lock;
 283     GCond *cond;
 284     gint refcount;
 285     int type;                   // Only one of CLOUDLOG_{JOURNAL,CLOUD}
 286     int log_dir;
 287     int log_seq;
 288     char *filename;             // Local filename, relateive to log directory
 289     gint mapcount;              // References to the mmaped data
 290     const char *addr;           // May be null if data is not mapped in memory
 291     size_t len;
 292     BlueSkyFS *fs;
 293     BlueSkyLog *log;
 294     gboolean fetching, ready;   // Cloud data: downloading or ready for use
 295     int64_t atime;              // Access time, for cache management
 296
 297     /* Journal: Count of objects which are not yet committed to cloud storage
 298      * but need to be; a non-zero value prevents the journal file from being
 299      * deleted. */
 300     gint dirty_refs;
 301 };
 302
 303 BlueSkyLog *bluesky_log_new(const char *log_directory);
 304 void bluesky_log_item_submit(BlueSkyCloudLog *item, BlueSkyLog *log);
 305 void bluesky_log_finish_all(GList *log_items);
 306 BlueSkyRCStr *bluesky_log_map_object(BlueSkyFS *fs, int log_dir, int log_seq,
 307                                      int log_offset, int log_size);
 308 void bluesky_mmap_unref(BlueSkyCacheFile *mmap);
 309 void bluesky_cachefile_unref(BlueSkyCacheFile *cachefile);
 310
 311 BlueSkyCacheFile *bluesky_cachefile_lookup(BlueSkyFS *fs,
 312                                            int clouddir, int log_seq);
 313 void bluesky_cachefile_gc(BlueSkyFS *fs);
 314
 315 #ifdef __cplusplus
 316 }
 317 #endif
 318
 319 #endif