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