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 async_inode_fetches;
  32 } BlueSkyOptions;
  33
  34 extern BlueSkyOptions bluesky_options;
  35
  36 /* BlueSky status and error codes.  Various frontends should translate these to
  37  * the appropriate error code for whatever protocol they implement. */
  38 typedef enum {
  39     BSTATUS_OK = 0,             /* No error */
  40     BSTATUS_IOERR,              /* I/O error of some form */
  41     BSTATUS_NOENT,              /* File does not exist */
  42 } BlueSkyStatus;
  43
  44 void bluesky_init(void);
  45
  46 gchar *bluesky_lowercase(const gchar *s);
  47
  48 /* Reference-counted blocks of memory, used for passing data in and out of
  49  * storage backends and in other places. */
  50 typedef struct {
  51     gint refcount;
  52     gchar *data;
  53     gsize len;
  54 } BlueSkyRCStr;
  55
  56 BlueSkyRCStr *bluesky_string_new(gpointer data, gsize len);
  57 BlueSkyRCStr *bluesky_string_new_from_gstring(GString *s);
  58 void bluesky_string_ref(BlueSkyRCStr *string);
  59 void bluesky_string_unref(BlueSkyRCStr *string);
  60 BlueSkyRCStr *bluesky_string_dup(BlueSkyRCStr *string);
  61 void bluesky_string_resize(BlueSkyRCStr *string, gsize len);
  62
  63 /* Cryptographic operations. */
  64 #define CRYPTO_BLOCK_SIZE 16        /* 128-bit AES */
  65 #define CRYPTO_KEY_SIZE   16
  66
  67 void bluesky_crypt_init();
  68 void bluesky_crypt_hash_key(const char *keystr, uint8_t *out);
  69 void bluesky_crypt_random_bytes(guchar *buf, gint len);
  70 BlueSkyRCStr *bluesky_crypt_encrypt(BlueSkyRCStr *in, const uint8_t *key);
  71 BlueSkyRCStr *bluesky_crypt_decrypt(BlueSkyRCStr *in, const uint8_t *key);
  72
  73 /* Storage interface.  This presents a key-value store abstraction, and can
  74  * have multiple implementations: in-memory, on-disk, in-cloud. */
  75 struct _BlueSkyStore;
  76 typedef struct _BlueSkyStore BlueSkyStore;
  77
  78 void bluesky_store_init();
  79 BlueSkyStore *bluesky_store_new(const gchar *type);
  80 void bluesky_store_free(BlueSkyStore *store);
  81 BlueSkyRCStr *bluesky_store_get(BlueSkyStore *store, const gchar *key);
  82 void bluesky_store_put(BlueSkyStore *store,
  83                        const gchar *key, BlueSkyRCStr *val);
  84
  85 /* File types.  The numeric values are chosen to match with those used in
  86  * NFSv3. */
  87 typedef enum {
  88     BLUESKY_REGULAR = 1,
  89     BLUESKY_DIRECTORY = 2,
  90     BLUESKY_BLOCK = 3,
  91     BLUESKY_CHARACTER = 4,
  92     BLUESKY_SYMLINK = 5,
  93     BLUESKY_SOCKET = 6,
  94     BLUESKY_FIFO = 7,
  95
  96     /* Special types used only internally. */
  97     BLUESKY_PENDING = 0,    /* Inode being loaded; type not yet determined */
  98     BLUESKY_INVALID = -1,   /* Inode is invalid (failed to load) */
  99 } BlueSkyFileType;
 100
 101 /* Filesystem state.  Each filesystem which is exported is represented by a
 102  * single bluesky_fs structure in memory. */
 103 typedef struct {
 104     GMutex *lock;
 105
 106     gchar *name;                /* Descriptive name for the filesystem */
 107     GHashTable *inodes;         /* Cached inodes */
 108     uint64_t next_inum;         /* Next available inode for allocation */
 109
 110     BlueSkyStore *store;
 111 } BlueSkyFS;
 112
 113 /* Inode number of the root directory. */
 114 #define BLUESKY_ROOT_INUM 1
 115
 116 /* Timestamp, measured in microseconds since the Unix epoch. */
 117 typedef int64_t bluesky_time;
 118
 119 /* High-resolution timer, measured in nanoseconds. */
 120 typedef int64_t bluesky_time_hires;
 121 bluesky_time_hires bluesky_now_hires();
 122
 123 /* In-memory representation of an inode within a Blue Sky server.  This
 124  * corresponds roughly with information that is committed to persistent
 125  * storage.  Locking/refcounting rules:
 126  *   - To access or modify any data fields, the lock must be held.  This
 127  *     includes file blocks.
 128  *   - One reference is held by the BlueSkyFS inode hash table.  If that is the
 129  *     only reference (and the inode is unlocked), the inode is subject to
 130  *     dropping from the cache.
 131  *   - Any pending operations should hold extra references to the inode as
 132  *     appropriate to keep it available until the operation completes.
 133  *   - Locking dependency order is, when multiple locks are to be acquired, to
 134  *     acquire locks on parents in the filesystem tree before children.
 135  *     (TODO: What about rename when we acquire locks in unrelated parts of the
 136  *     filesystem?)
 137  * */
 138 typedef struct {
 139     GMutex *lock;
 140     gint refcount;
 141
 142     BlueSkyFS *fs;
 143
 144     BlueSkyFileType type;
 145     uint32_t mode;
 146     uint32_t uid, gid;
 147     uint32_t nlink;
 148
 149     /* Rather than track an inode number and generation number, we will simply
 150      * never re-use a fileid after a file is deleted.  64 bits should be enough
 151      * that we don't exhaust the identifier space. */
 152     uint64_t inum;
 153
 154     /* change_count is increased with every operation which modifies the inode,
 155      * and can be used to determine if cached data is still valid.
 156      * change_commit is the value of change_count when the inode was last
 157      * committed to stable storage. */
 158     uint64_t change_count, change_commit;
 159
 160     /* Timestamp for controlling when modified data is flushed to stable
 161      * storage.  When an inode is first modified from a clean state, this is
 162      * set to the current time.  If the inode is clean, it is set to zero. */
 163     int64_t change_time;
 164
 165     /* Additional state for tracking cache writeback status. */
 166     uint64_t change_pending;    /* change_count version currently being committed to storage */
 167
 168     int64_t atime;              /* Microseconds since the Unix epoch */
 169     int64_t ctime;
 170     int64_t mtime;
 171     int64_t ntime;              /* "new time": time object was created */
 172
 173     /* File-specific fields */
 174     uint64_t size;
 175     GArray *blocks;
 176
 177     /* Directory-specific fields */
 178     GSequence *dirents;         /* List of entries for READDIR */
 179     GHashTable *dirhash;        /* Hash table by name for LOOKUP */
 180     GHashTable *dirhash_folded; /* As above, but case-folded */
 181     uint64_t parent_inum;       /* inode for ".."; 0 if the root directory */
 182
 183     /* Symlink-specific fields */
 184     gchar *symlink_contents;
 185 } BlueSkyInode;
 186
 187 /* A directory entry.  The name is UTF-8 and is a freshly-allocated string.
 188  * Each directory entry is listed in two indices: dirents is indexed by cookie
 189  * and dirhash by name.  The cookie is a randomly-assigned 32-bit value, unique
 190  * within the directory, that remains unchanged until the entry is deleted.  It
 191  * is used to provide a stable key for restarting a READDIR call. */
 192 typedef struct {
 193     gchar *name;
 194     gchar *name_folded;         /* Name, folded for case-insensitive lookup */
 195     uint32_t cookie;
 196     uint64_t inum;
 197 } BlueSkyDirent;
 198
 199 /* File data is divided into fixed-size blocks (except the last block which may
 200  * be short?).  These blocks are backed by storage in a key/value store, but
 201  * may also be dirty if modifications have been made in-memory that have not
 202  * been committed. */
 203 #define BLUESKY_BLOCK_SIZE 32768ULL
 204 #define BLUESKY_MAX_FILE_SIZE (BLUESKY_BLOCK_SIZE << 24)
 205 typedef enum {
 206     BLUESKY_BLOCK_ZERO = 0,     /* Data is all zeroes, not explicitly stored */
 207     BLUESKY_BLOCK_REF = 1,      /* Reference to key/value store, not cached */
 208     BLUESKY_BLOCK_CACHED = 2,   /* Data is cached in memory, clean */
 209     BLUESKY_BLOCK_DIRTY = 3,    /* Data needs to be committed to store */
 210 } BlueSkyBlockType;
 211
 212 typedef struct {
 213     BlueSkyBlockType type;
 214     gchar *ref;                 /* Name of data block in the backing store */
 215     BlueSkyRCStr *data;         /* Pointer to data in memory if cached */
 216 } BlueSkyBlock;
 217
 218 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store);
 219 void bluesky_superblock_flush(BlueSkyFS *fs);
 220
 221 int64_t bluesky_get_current_time();
 222 void bluesky_inode_update_ctime(BlueSkyInode *inode, gboolean update_mtime);
 223 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs);
 224 void bluesky_init_inode(BlueSkyInode *i, BlueSkyFileType type);
 225 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs, BlueSkyFileType type);
 226
 227 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum);
 228 void bluesky_inode_ref(BlueSkyInode *inode);
 229 void bluesky_inode_unref(BlueSkyInode *inode);
 230 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode);
 231
 232 void bluesky_dirent_destroy(gpointer dirent);
 233 uint64_t bluesky_directory_lookup(BlueSkyInode *inode, gchar *name);
 234 uint64_t bluesky_directory_ilookup(BlueSkyInode *inode, gchar *name);
 235 BlueSkyDirent *bluesky_directory_read(BlueSkyInode *dir, uint32_t cookie);
 236 gboolean bluesky_directory_insert(BlueSkyInode *dir, const gchar *name,
 237                                   uint64_t inum);
 238 void bluesky_directory_dump(BlueSkyInode *dir);
 239
 240 void bluesky_block_touch(BlueSkyInode *inode, uint64_t i);
 241 void bluesky_block_fetch(BlueSkyFS *fs, BlueSkyBlock *block);
 242 void bluesky_file_truncate(BlueSkyInode *inode, uint64_t size);
 243 void bluesky_file_write(BlueSkyInode *inode, uint64_t offset,
 244                         const char *data, gint len);
 245 void bluesky_file_read(BlueSkyInode *inode, uint64_t offset,
 246                        char *buf, gint len);
 247
 248 void bluesky_inode_flush(BlueSkyFS *fs, BlueSkyInode *inode);
 249 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum);
 250
 251 gint bluesky_dirent_compare(gconstpointer a, gconstpointer b,
 252                             gpointer unused);
 253
 254 void bluesky_flushd_invoke(BlueSkyFS *fs);
 255
 256 void bluesky_debug_dump(BlueSkyFS *fs);
 257
 258 #ifdef __cplusplus
 259 }
 260 #endif
 261
 262 #endif