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 /* BlueSky status and error codes.  Various frontends should translate these to
  21  * the appropriate error code for whatever protocol they implement. */
  22 typedef enum {
  23     BSTATUS_OK = 0,             /* No error */
  24     BSTATUS_IOERR,              /* I/O error of some form */
  25     BSTATUS_NOENT,              /* File does not exist */
  26 } BlueSkyStatus;
  27
  28 void bluesky_init(void);
  29
  30 gchar *bluesky_lowercase(const gchar *s);
  31
  32 /* Reference-counted blocks of memory, used for passing data in and out of
  33  * storage backends and in other places. */
  34 typedef struct {
  35     gint refcount;
  36     gchar *data;
  37     gsize len;
  38 } BlueSkyRCStr;
  39
  40 BlueSkyRCStr *bluesky_string_new(gpointer data, gsize len);
  41 void bluesky_string_ref(BlueSkyRCStr *string);
  42 void bluesky_string_unref(BlueSkyRCStr *string);
  43 BlueSkyRCStr *bluesky_string_dup(BlueSkyRCStr *string);
  44 void bluesky_string_resize(BlueSkyRCStr *string, gsize len);
  45
  46 /* Cryptographic operations. */
  47 #define CRYPTO_BLOCK_SIZE 16        /* 128-bit AES */
  48 #define CRYPTO_KEY_SIZE   16
  49
  50 void bluesky_crypt_init();
  51 void bluesky_crypt_hash_key(const char *keystr, uint8_t *out);
  52 void bluesky_crypt_random_bytes(guchar *buf, gint len);
  53 BlueSkyRCStr *bluesky_crypt_encrypt(BlueSkyRCStr *in, const uint8_t *key);
  54 BlueSkyRCStr *bluesky_crypt_decrypt(BlueSkyRCStr *in, const uint8_t *key);
  55
  56 /* Storage interface.  This presents a key-value store abstraction, and can
  57  * have multiple implementations: in-memory, on-disk, in-cloud. */
  58 typedef struct {
  59     /* Create a new store instance and return a handle to it. */
  60     gpointer (*create)();
  61
  62     /* Clean up any resources used by this store. */
  63     void (*destroy)(gpointer store);
  64
  65     /* Fetch an item with the given name, or return NULL if not found. */
  66     BlueSkyRCStr * (*get)(gpointer store, const gchar *key);
  67
  68     /* Store an item to the given key name. */
  69     void (*put)(gpointer store, const gchar *key, BlueSkyRCStr *val);
  70 } BlueSkyStoreImplementation;
  71
  72 void bluesky_store_register(const BlueSkyStoreImplementation *impl,
  73                             const gchar *name);
  74
  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 } BlueSkyFileType;
  96
  97 /* Filesystem state.  Each filesystem which is exported is represented by a
  98  * single bluesky_fs structure in memory. */
  99 typedef struct {
 100     GMutex *lock;
 101
 102     gchar *name;                /* Descriptive name for the filesystem */
 103     GHashTable *inodes;         /* Cached inodes */
 104     uint64_t next_inum;         /* Next available inode for allocation */
 105
 106     BlueSkyStore *store;
 107 } BlueSkyFS;
 108
 109 /* Inode number of the root directory. */
 110 #define BLUESKY_ROOT_INUM 1
 111
 112 /* Timestamp, measured in microseconds since the Unix epoch. */
 113 typedef int64_t bluesky_time;
 114
 115 /* High-resolution timer, measured in nanoseconds. */
 116 typedef int64_t bluesky_time_hires;
 117 bluesky_time_hires bluesky_now_hires();
 118
 119 /* In-memory representation of an inode within a Blue Sky server.  This
 120  * corresponds roughly with information that is committed to persistent
 121  * storage.  Locking/refcounting rules:
 122  *   - To access or modify any data fields, the lock must be held.  This
 123  *     includes file blocks.
 124  *   - One reference is held by the BlueSkyFS inode hash table.  If that is the
 125  *     only reference (and the inode is unlocked), the inode is subject to
 126  *     dropping from the cache.
 127  *   - Any pending operations should hold extra references to the inode as
 128  *     appropriate to keep it available until the operation completes.
 129  * */
 130 typedef struct {
 131     GMutex *lock;
 132     gint refcount;
 133
 134     BlueSkyFS *fs;
 135
 136     BlueSkyFileType type;
 137     uint32_t mode;
 138     uint32_t uid, gid;
 139     uint32_t nlink;
 140
 141     /* Rather than track an inode number and generation number, we will simply
 142      * never re-use a fileid after a file is deleted.  64 bits should be enough
 143      * that we don't exhaust the identifier space. */
 144     uint64_t inum;
 145
 146     /* change_count is increased with every operation which modifies the inode,
 147      * and can be used to determine if cached data is still valid.
 148      * change_commit is the value of change_count when the inode was last
 149      * committed to stable storage. */
 150     uint64_t change_count, change_commit;
 151
 152     int64_t atime;              /* Microseconds since the Unix epoch */
 153     int64_t ctime;
 154     int64_t mtime;
 155     int64_t ntime;              /* "new time": time object was created */
 156
 157     /* File-specific fields */
 158     uint64_t size;
 159     GArray *blocks;
 160
 161     /* Directory-specific fields */
 162     GSequence *dirents;         /* List of entries for READDIR */
 163     GHashTable *dirhash;        /* Hash table by name for LOOKUP */
 164     GHashTable *dirhash_folded; /* As above, but case-folded */
 165     uint64_t parent_inum;       /* inode for ".."; 0 if the root directory */
 166 } BlueSkyInode;
 167
 168 /* A directory entry.  The name is UTF-8 and is a freshly-allocated string.
 169  * Each directory entry is listed in two indices: dirents is indexed by cookie
 170  * and dirhash by name.  The cookie is a randomly-assigned 32-bit value, unique
 171  * within the directory, that remains unchanged until the entry is deleted.  It
 172  * is used to provide a stable key for restarting a READDIR call. */
 173 typedef struct {
 174     gchar *name;
 175     gchar *name_folded;         /* Name, folded for case-insensitive lookup */
 176     uint32_t cookie;
 177     uint64_t inum;
 178 } BlueSkyDirent;
 179
 180 /* File data is divided into fixed-size blocks (except the last block which may
 181  * be short?).  These blocks are backed by storage in a key/value store, but
 182  * may also be dirty if modifications have been made in-memory that have not
 183  * been committed. */
 184 #define BLUESKY_BLOCK_SIZE 32768ULL
 185 #define BLUESKY_MAX_FILE_SIZE (BLUESKY_BLOCK_SIZE << 24)
 186 typedef enum {
 187     BLUESKY_BLOCK_ZERO = 0,     /* Data is all zeroes, not explicitly stored */
 188     BLUESKY_BLOCK_REF = 1,      /* Reference to key/value store, not cached */
 189     BLUESKY_BLOCK_CACHED = 2,   /* Data is cached in memory, clean */
 190     BLUESKY_BLOCK_DIRTY = 3,    /* Data needs to be committed to store */
 191 } BlueSkyBlockType;
 192
 193 typedef struct {
 194     BlueSkyBlockType type;
 195     gchar *ref;                 /* Name of data block in the backing store */
 196     BlueSkyRCStr *data;         /* Pointer to data in memory if cached */
 197 } BlueSkyBlock;
 198
 199 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store);
 200 void bluesky_superblock_flush(BlueSkyFS *fs);
 201
 202 int64_t bluesky_get_current_time();
 203 void bluesky_inode_update_ctime(BlueSkyInode *inode, gboolean update_mtime);
 204 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs);
 205 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs, BlueSkyFileType type);
 206
 207 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum);
 208 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode);
 209
 210 void bluesky_dirent_destroy(gpointer dirent);
 211 uint64_t bluesky_directory_lookup(BlueSkyInode *inode, gchar *name);
 212 uint64_t bluesky_directory_ilookup(BlueSkyInode *inode, gchar *name);
 213 BlueSkyDirent *bluesky_directory_read(BlueSkyInode *dir, uint32_t cookie);
 214 gboolean bluesky_directory_insert(BlueSkyInode *dir, const gchar *name,
 215                                   uint64_t inum);
 216 void bluesky_directory_dump(BlueSkyInode *dir);
 217
 218 void bluesky_block_touch(BlueSkyInode *inode, uint64_t i);
 219 void bluesky_block_fetch(BlueSkyFS *fs, BlueSkyBlock *block);
 220 void bluesky_block_flush(BlueSkyFS *fs, BlueSkyBlock *block);
 221 void bluesky_file_truncate(BlueSkyInode *inode, uint64_t size);
 222 void bluesky_file_write(BlueSkyInode *inode, uint64_t offset,
 223                         const char *data, gint len);
 224 void bluesky_file_read(BlueSkyInode *inode, uint64_t offset,
 225                        char *buf, gint len);
 226
 227 void bluesky_inode_flush(BlueSkyFS *fs, BlueSkyInode *inode);
 228 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum);
 229
 230 gint bluesky_dirent_compare(gconstpointer a, gconstpointer b,
 231                             gpointer unused);
 232
 233 #ifdef __cplusplus
 234 }
 235 #endif
 236
 237 #endif