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