bluesky/bluesky.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 #ifndef _BLUESKY_H
  10 #define _BLUESKY_H
  11
  12 #include <stdint.h>
  13 #include <stdio.h>
  14 #include <inttypes.h>
  15 #include <glib.h>
  16
  17 #ifdef __cplusplus
  18 extern "C" {
  19 #endif
  20
  21 /* Various options to tweak for performance benchmarking purposes. */
  22 typedef struct {
  23     /* Perform all get/put operations synchronously. */
  24     int synchronous_stores;
  25
  26     /* Write data in cache immediately after file is modified. */
  27     int writethrough_cache;
  28
  29     /* Can inodes be fetched asynchronously?  (Inode object is initially
  30      * created in a pending state, and not unlocked until the data is actually
  31      * available.) */
  32     int sync_inode_fetches;
  33
  34     /* Should frontends handle requests serially or allow operations to proceed
  35      * in parallel? */
  36     int sync_frontends;
  37
  38     /* Target size of the disk cache at the proxy, in kilobytes. */
  39     int cache_size;
  40 } BlueSkyOptions;
  41
  42 extern BlueSkyOptions bluesky_options;
  43
  44 /* Maximum number of threads to use in any particular thread pool, or -1 for no
  45  * limit */
  46 extern int bluesky_max_threads;
  47
  48 /* A general-purpose counter for gathering run-time statistics. */
  49 struct bluesky_stats {
  50     const char *name;
  51     int64_t count;
  52     int64_t sum;
  53 };
  54 struct bluesky_stats *bluesky_stats_new(const char *name);
  55 void bluesky_stats_add(struct bluesky_stats *stats, int64_t value);
  56 void bluesky_stats_dump_all();
  57
  58 /* BlueSky status and error codes.  Various frontends should translate these to
  59  * the appropriate error code for whatever protocol they implement. */
  60 typedef enum {
  61     BSTATUS_OK = 0,             /* No error */
  62     BSTATUS_IOERR,              /* I/O error of some form */
  63     BSTATUS_NOENT,              /* File does not exist */
  64 } BlueSkyStatus;
  65
  66 void bluesky_init(void);
  67
  68 gchar *bluesky_lowercase(const gchar *s);
  69
  70 struct BlueSkyCacheFile;
  71 typedef struct BlueSkyCacheFile BlueSkyCacheFile;
  72
  73 typedef struct {
  74     gint refcount;
  75     BlueSkyCacheFile *mmap;
  76     gchar *data;
  77     gsize len;
  78 } BlueSkyRCStr;
  79
  80 BlueSkyRCStr *bluesky_string_new(gpointer data, gsize len);
  81 BlueSkyRCStr *bluesky_string_new_from_gstring(GString *s);
  82 BlueSkyRCStr *bluesky_string_new_from_mmap(BlueSkyCacheFile *mmap,
  83                                            int offset, gsize len);
  84 void bluesky_string_ref(BlueSkyRCStr *string);
  85 void bluesky_string_unref(BlueSkyRCStr *string);
  86 BlueSkyRCStr *bluesky_string_dup(BlueSkyRCStr *string);
  87 void bluesky_string_resize(BlueSkyRCStr *string, gsize len);
  88
  89 struct BlueSkyRangeset;
  90 typedef struct BlueSkyRangeset BlueSkyRangeset;
  91 typedef struct {
  92     uint64_t start, length;
  93     gpointer data;
  94 } BlueSkyRangesetItem;
  95
  96 BlueSkyRangeset *bluesky_rangeset_new();
  97 void bluesky_rangeset_free(BlueSkyRangeset *rangeset);
  98 gboolean bluesky_rangeset_insert(BlueSkyRangeset *rangeset,
  99                                  uint64_t start, uint64_t length,
 100                                  gpointer data);
 101 const BlueSkyRangesetItem *bluesky_rangeset_lookup(BlueSkyRangeset *rangeset,
 102                                                    uint64_t offset);
 103 const BlueSkyRangesetItem *bluesky_rangeset_lookup_next(BlueSkyRangeset *rangeset, uint64_t offset);
 104 void bluesky_rangeset_get_extents(BlueSkyRangeset *rangeset,
 105                                   uint64_t *start, uint64_t *length);
 106
 107 /* Storage interface.  This presents a key-value store abstraction, and can
 108  * have multiple implementations: in-memory, on-disk, in-cloud. */
 109 struct BlueSkyStore;
 110 typedef struct BlueSkyStore BlueSkyStore;
 111
 112 struct BlueSkyLog;
 113 typedef struct BlueSkyLog BlueSkyLog;
 114
 115 struct BlueSkyCloudLogState;
 116 typedef struct BlueSkyCloudLogState BlueSkyCloudLogState;
 117
 118 struct BlueSkyCloudLog;
 119 typedef struct BlueSkyCloudLog BlueSkyCloudLog;
 120
 121 void bluesky_store_init();
 122 BlueSkyStore *bluesky_store_new(const gchar *type);
 123 void bluesky_store_free(BlueSkyStore *store);
 124 BlueSkyRCStr *bluesky_store_get(BlueSkyStore *store, const gchar *key);
 125 void bluesky_store_put(BlueSkyStore *store,
 126                        const gchar *key, BlueSkyRCStr *val);
 127
 128 /* File types.  The numeric values are chosen to match with those used in
 129  * NFSv3. */
 130 typedef enum {
 131     BLUESKY_REGULAR = 1,
 132     BLUESKY_DIRECTORY = 2,
 133     BLUESKY_BLOCK = 3,
 134     BLUESKY_CHARACTER = 4,
 135     BLUESKY_SYMLINK = 5,
 136     BLUESKY_SOCKET = 6,
 137     BLUESKY_FIFO = 7,
 138
 139     /* Special types used only internally. */
 140     BLUESKY_PENDING = 0,    /* Inode being loaded; type not yet determined */
 141     BLUESKY_INVALID = -1,   /* Inode is invalid (failed to load) */
 142 } BlueSkyFileType;
 143
 144 /* Filesystem state.  Each filesystem which is exported is represented by a
 145  * single bluesky_fs structure in memory. */
 146 struct BlueSkyCryptKeys;
 147
 148 typedef struct {
 149     GMutex *lock;
 150
 151     gchar *name;                /* Descriptive name for the filesystem */
 152     GHashTable *inodes;         /* Cached inodes */
 153     uint64_t next_inum;         /* Next available inode for allocation */
 154
 155     BlueSkyStore *store;
 156     BlueSkyLog *log;
 157     BlueSkyCloudLogState *log_state;
 158
 159     /* Filesystem crypto keys */
 160     char *master_key;
 161     struct BlueSkyCryptKeys *keys;
 162
 163     /* Accounting for memory used for caches.  Space is measured in blocks, not
 164      * bytes.  Updates to these variables must be made atomically. */
 165     gint cache_dirty;
 166
 167     /* Like above, but tracking data stored in the cloudlog entries
 168      * specifically:
 169      *  - cache_log_dirty: data uncommitted to journal and cloud
 170      *  - cache_log_writeback: data being written to journal
 171      *  - cache_log_journal: data committed to journal
 172      *  - cache_log_cloud: data written to cloud as well
 173      * Log entries should progress from the top state to the bottom, and are
 174      * only ever counted in one category at a time. */
 175     gint cache_log_dirty, cache_log_writeback,
 176          cache_log_journal, cache_log_cloud;
 177
 178     /* Linked list of inodes, sorted by access/modification times for cache
 179      * management.  Editing these lists is protected by the filesystem lock; to
 180      * avoid deadlock do not attempt to take any other locks while the FS lock
 181      * is held for list editing purposes.  Items at the head of the list are
 182      * most recently accessed/modified. */
 183     GList unlogged_list;        // Changes not yet synced to journal
 184     GList dirty_list;           // Not yet written to cloud storage
 185     GList accessed_list;        // All in-memory inodes
 186
 187     /* Mutex for the flush daemon, to prevent concurrent execution. */
 188     GMutex *flushd_lock;
 189
 190     /* Used to wait for the cache daemon to free up space */
 191     GCond *flushd_cond;
 192
 193     /* Mapping of object identifiers (blocks, inodes) to physical location (in
 194      * the local cache or in the logs in the cloud). */
 195     GHashTable *locations;
 196
 197     /* The inode map, which maps inode numbers to the location of the most
 198      * recent version. */
 199     GSequence *inode_map;
 200
 201     /* Queue for asynchronous cloudlog unrefs, where needed. */
 202     GAsyncQueue *unref_queue;
 203
 204     /* Thread pool for asynchronous inode fetches */
 205     GThreadPool *inode_fetch_thread_pool;
 206 } BlueSkyFS;
 207
 208 /* Inode number of the root directory. */
 209 #define BLUESKY_ROOT_INUM 1
 210
 211 /* Timestamp, measured in microseconds since the Unix epoch. */
 212 typedef int64_t bluesky_time;
 213
 214 /* High-resolution timer, measured in nanoseconds. */
 215 typedef int64_t bluesky_time_hires;
 216 bluesky_time_hires bluesky_now_hires();
 217
 218 /* In-memory representation of an inode within a Blue Sky server.  This
 219  * corresponds roughly with information that is committed to persistent
 220  * storage.  Locking/refcounting rules:
 221  *   - To access or modify any data fields, the lock must be held.  This
 222  *     includes file blocks.
 223  *   - One reference is held by the BlueSkyFS inode hash table.  If that is the
 224  *     only reference (and the inode is unlocked), the inode is subject to
 225  *     dropping from the cache.
 226  *   - Any pending operations should hold extra references to the inode as
 227  *     appropriate to keep it available until the operation completes.
 228  *   - Locking dependency order is, when multiple locks are to be acquired, to
 229  *     acquire locks on parents in the filesystem tree before children.
 230  *     (TODO: What about rename when we acquire locks in unrelated parts of the
 231  *     filesystem?)
 232  *   - An inode should not be locked while the filesystem lock is already held,
 233  *     since some code may do an inode lookup (which acquires the filesystem
 234  *     lock) while a different inode is locked.
 235  * */
 236 typedef struct {
 237     GMutex *lock;
 238     gint refcount;
 239
 240     BlueSkyFS *fs;
 241
 242     BlueSkyFileType type;
 243     uint32_t mode;
 244     uint32_t uid, gid;
 245     uint32_t nlink;
 246
 247     /* Rather than track an inode number and generation number, we will simply
 248      * never re-use a fileid after a file is deleted.  64 bits should be enough
 249      * that we don't exhaust the identifier space. */
 250     uint64_t inum;
 251
 252     /* change_count is increased with every operation which modifies the inode,
 253      * and can be used to determine if cached data is still valid.
 254      * change_commit is the value of change_count when the inode was last
 255      * committed to stable storage (the log).
 256      * change_cloud tracks which version was last commited to cloud storage. */
 257     uint64_t change_count, change_commit, change_cloud;
 258
 259     /* Timestamp for controlling when modified data is flushed to stable
 260      * storage.  When an inode is first modified from a clean state, this is
 261      * set to the current time.  If the inode is clean, it is set to zero. */
 262     int64_t change_time;
 263
 264     /* Last access time to this inode, for controlling cache evictions. */
 265     int64_t access_time;
 266
 267     /* Version of the object last serialized and committed to storage. */
 268     BlueSkyCloudLog *committed_item;
 269
 270     /* Pointers to the linked-list elements for this inode in the accessed and
 271      * dirty linked lists.  We re-use the GList structure, using ->next to
 272      * point to the head of the list and ->prev to point to the tail.  The data
 273      * element is unused. */
 274     GList *unlogged_list, *accessed_list, *dirty_list;
 275
 276     int64_t atime;              /* Microseconds since the Unix epoch */
 277     int64_t ctime;
 278     int64_t mtime;
 279     int64_t ntime;              /* "new time": time object was created */
 280
 281     /* File-specific fields */
 282     uint64_t size;
 283     GArray *blocks;
 284
 285     /* Directory-specific fields */
 286     GSequence *dirents;         /* List of entries for READDIR */
 287     GHashTable *dirhash;        /* Hash table by name for LOOKUP */
 288     GHashTable *dirhash_folded; /* As above, but case-folded */
 289     uint64_t parent_inum;       /* inode for ".."; 0 if the root directory */
 290
 291     /* Symlink-specific fields */
 292     gchar *symlink_contents;
 293
 294     /* A field for short-term use internally while the lock is held. */
 295     gpointer private_data;
 296 } BlueSkyInode;
 297
 298 /* A directory entry.  The name is UTF-8 and is a freshly-allocated string.
 299  * Each directory entry is listed in two indices: dirents is indexed by cookie
 300  * and dirhash by name.  The cookie is a randomly-assigned 32-bit value, unique
 301  * within the directory, that remains unchanged until the entry is deleted.  It
 302  * is used to provide a stable key for restarting a READDIR call. */
 303 typedef struct {
 304     gchar *name;
 305     gchar *name_folded;         /* Name, folded for case-insensitive lookup */
 306     uint32_t cookie;
 307     uint64_t inum;
 308 } BlueSkyDirent;
 309
 310 /* File data is divided into fixed-size blocks (except the last block which may
 311  * be short?).  These blocks are backed by storage in a key/value store, but
 312  * may also be dirty if modifications have been made in-memory that have not
 313  * been committed. */
 314 #define BLUESKY_BLOCK_SIZE 32768ULL
 315 #define BLUESKY_MAX_FILE_SIZE (BLUESKY_BLOCK_SIZE << 24)
 316 typedef enum {
 317     BLUESKY_BLOCK_ZERO = 0,     /* Data is all zeroes, not explicitly stored */
 318     BLUESKY_BLOCK_REF = 1,      /* Reference to cloud log item, data clean */
 319     BLUESKY_BLOCK_DIRTY = 2,    /* Data needs to be committed to store */
 320 } BlueSkyBlockType;
 321
 322 typedef struct {
 323     BlueSkyBlockType type;
 324     BlueSkyCloudLog *ref;       /* if REF: cloud log entry with data */
 325     BlueSkyRCStr *dirty;        /* if DIRTY: raw data in memory */
 326 } BlueSkyBlock;
 327
 328 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store,
 329                            const gchar *master_key);
 330
 331 gboolean bluesky_inode_is_ready(BlueSkyInode *inode);
 332
 333 int64_t bluesky_get_current_time();
 334 void bluesky_inode_update_ctime(BlueSkyInode *inode, gboolean update_mtime);
 335 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs);
 336 void bluesky_init_inode(BlueSkyInode *i, BlueSkyFileType type);
 337 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs, BlueSkyFileType type);
 338
 339 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum);
 340 void bluesky_inode_ref(BlueSkyInode *inode);
 341 void bluesky_inode_unref(BlueSkyInode *inode);
 342 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode);
 343
 344 void bluesky_dirent_destroy(gpointer dirent);
 345 uint64_t bluesky_directory_lookup(BlueSkyInode *inode, gchar *name);
 346 uint64_t bluesky_directory_ilookup(BlueSkyInode *inode, gchar *name);
 347 BlueSkyDirent *bluesky_directory_read(BlueSkyInode *dir, uint32_t cookie);
 348 gboolean bluesky_directory_insert(BlueSkyInode *dir, const gchar *name,
 349                                   uint64_t inum);
 350 void bluesky_directory_dump(BlueSkyInode *dir);
 351
 352 void bluesky_file_truncate(BlueSkyInode *inode, uint64_t size);
 353 void bluesky_file_write(BlueSkyInode *inode, uint64_t offset,
 354                         const char *data, gint len);
 355 void bluesky_file_read(BlueSkyInode *inode, uint64_t offset,
 356                        char *buf, gint len);
 357
 358 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum);
 359
 360 gint bluesky_dirent_compare(gconstpointer a, gconstpointer b,
 361                             gpointer unused);
 362
 363 void bluesky_flushd_invoke(BlueSkyFS *fs);
 364 void bluesky_flushd_invoke_conditional(BlueSkyFS *fs);
 365 void bluesky_inode_do_sync(BlueSkyInode *inode);
 366 void bluesky_flushd_thread_launch(BlueSkyFS *fs);
 367
 368 void bluesky_debug_dump(BlueSkyFS *fs);
 369
 370 /* Request response time tracking. */
 371 typedef struct BlueSkyProfile {
 372     int magic;
 373     GMutex *lock;
 374     char *description;
 375     GList *events;
 376 } BlueSkyProfile;
 377
 378 BlueSkyProfile *bluesky_profile_new();
 379 void bluesky_profile_free(BlueSkyProfile *profile);
 380 void bluesky_profile_add_event(BlueSkyProfile *profile, char *message);
 381 void bluesky_profile_print(BlueSkyProfile *profile);
 382 BlueSkyProfile *bluesky_profile_get();
 383 void bluesky_profile_set(BlueSkyProfile *profile);
 384 void bluesky_profile_set_output(FILE *stream);
 385
 386 #ifdef __cplusplus
 387 }
 388 #endif
 389
 390 #endif