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