bluesky/inode.c

   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 #include <stdio.h>
  10 #include <stdint.h>
  11 #include <inttypes.h>
  12 #include <glib.h>
  13 #include <string.h>
  14
  15 #include "bluesky-private.h"
  16
  17 /* Core filesystem.  Different proxies, such as the NFSv3 one, interface to
  18  * this, but the core actually tracks the data which is stored.  So far we just
  19  * implement an in-memory filesystem, but eventually this will be state which
  20  * is persisted to the cloud. */
  21
  22 /* Return the current time, in microseconds since the epoch. */
  23 int64_t bluesky_get_current_time()
  24 {
  25     GTimeVal t;
  26     g_get_current_time(&t);
  27     return (int64_t)t.tv_sec * 1000000 + t.tv_usec;
  28 }
  29
  30 /* Update an inode to indicate that a modification was made.  This increases
  31  * the change counter, updates the ctime to the current time, and optionally
  32  * updates the mtime.  This also makes the inode contents subject to writeback
  33  * to storage in the future.  inode must already be locked. */
  34 void bluesky_inode_update_ctime(BlueSkyInode *inode, gboolean update_mtime)
  35 {
  36     int64_t now = bluesky_get_current_time();
  37     inode->change_count++;
  38     inode->ctime = now;
  39     if (update_mtime)
  40         inode->mtime = now;
  41
  42     if (inode->change_time == 0)
  43         inode->change_time = now;
  44
  45     if (bluesky_options.writethrough_cache)
  46         bluesky_file_flush(inode, NULL);
  47
  48     g_mutex_lock(inode->fs->lock);
  49     bluesky_list_unlink(&inode->fs->dirty_list, inode->dirty_list);
  50     inode->dirty_list = bluesky_list_prepend(&inode->fs->dirty_list, inode);
  51     bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
  52     inode->accessed_list = bluesky_list_prepend(&inode->fs->accessed_list, inode);
  53     g_mutex_unlock(inode->fs->lock);
  54 }
  55
  56 /* Unfortunately a glib hash table is only guaranteed to be able to store
  57  * 32-bit keys if we use the key directly.  If we want 64-bit inode numbers,
  58  * we'll have to allocate memory to store the 64-bit inumber, and use a pointer
  59  * to it.  Rather than allocate the memory for the key, we'll just include a
  60  * pointer to the 64-bit inum stored in the inode itself, so that we don't need
  61  * to do any more memory management.  */
  62 static guint bluesky_fs_key_hash_func(gconstpointer key)
  63 {
  64     uint64_t inum = *(const uint64_t *)key;
  65     return (guint)inum;
  66 }
  67
  68 static gboolean bluesky_fs_key_equal_func(gconstpointer a, gconstpointer b)
  69 {
  70     uint64_t i1 = *(const uint64_t *)a;
  71     uint64_t i2 = *(const uint64_t *)b;
  72     return i1 == i2;
  73 }
  74
  75 /* Filesystem-level operations.  A filesystem is like a directory tree that we
  76  * are willing to export. */
  77 BlueSkyFS *bluesky_new_fs(gchar *name)
  78 {
  79     BlueSkyFS *fs = g_new0(BlueSkyFS, 1);
  80     fs->lock = g_mutex_new();
  81     fs->name = g_strdup(name);
  82     fs->inodes = g_hash_table_new(bluesky_fs_key_hash_func,
  83                                   bluesky_fs_key_equal_func);
  84     fs->next_inum = BLUESKY_ROOT_INUM + 1;
  85     fs->store = bluesky_store_new("file");
  86
  87     return fs;
  88 }
  89
  90 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store)
  91 {
  92     BlueSkyRCStr *data = bluesky_store_get(store, "superblock");
  93     if (data != NULL) {
  94         BlueSkyFS *fs = bluesky_deserialize_superblock(data->data);
  95         if (fs != NULL) {
  96             fs->store = store;
  97             g_print("Loaded filesystem superblock\n");
  98             g_free(fs->name);
  99             fs->name = g_strdup(name);
 100             return fs;
 101         }
 102         bluesky_string_unref(data);
 103     }
 104
 105     g_print("Initializing fresh filesystem\n");
 106     BlueSkyFS *fs = bluesky_new_fs(name);
 107     fs->store = store;
 108
 109     BlueSkyInode *root = bluesky_new_inode(BLUESKY_ROOT_INUM, fs,
 110                                            BLUESKY_DIRECTORY);
 111     root->nlink = 1;
 112     root->mode = 0755;
 113     bluesky_insert_inode(fs, root);
 114     bluesky_inode_update_ctime(root, TRUE);
 115
 116     bluesky_inode_flush(fs, root);
 117     bluesky_superblock_flush(fs);
 118
 119     return fs;
 120 }
 121
 122 /* Inode reference counting. */
 123 void bluesky_inode_ref(BlueSkyInode *inode)
 124 {
 125     g_atomic_int_inc(&inode->refcount);
 126 }
 127
 128 void bluesky_inode_unref(BlueSkyInode *inode)
 129 {
 130     if (g_atomic_int_dec_and_test(&inode->refcount)) {
 131         g_print("Reference count for inode %"PRIu64" dropped to zero.\n",
 132                 inode->inum);
 133
 134         /* Sanity check: Is the inode clean? */
 135         if (inode->change_commit < inode->change_count
 136                 || inode->accessed_list != NULL
 137                 || inode->dirty_list != NULL) {
 138             g_warning("Dropping inode which is not clean (commit %"PRIi64" < change %"PRIi64"; accessed_list = %p; dirty_list = %p)\n", inode->change_commit, inode->change_count, inode->accessed_list, inode->dirty_list);
 139         }
 140
 141         /* These shouldn't be needed, but in case the above warning fires and
 142          * we delete the inode anyway, we ought to be sure the inode is not on
 143          * any LRU list. */
 144         g_mutex_lock(inode->fs->lock);
 145         bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
 146         bluesky_list_unlink(&inode->fs->dirty_list, inode->dirty_list);
 147         g_mutex_unlock(inode->fs->lock);
 148
 149         /* Free file type specific data.  It should be an error for there to be
 150          * dirty data to commit when the reference count has reaches zero. */
 151         switch (inode->type) {
 152         case BLUESKY_REGULAR:
 153             for (int i = 0; i < inode->blocks->len; i++) {
 154                 BlueSkyBlock *b = &g_array_index(inode->blocks,
 155                                                  BlueSkyBlock, i);
 156                 if (b->type == BLUESKY_BLOCK_DIRTY) {
 157                     g_error("Deleting an inode with dirty file data!");
 158                 }
 159                 g_free(b->ref);
 160                 bluesky_string_unref(b->data);
 161             }
 162             g_array_unref(inode->blocks);
 163             break;
 164
 165         case BLUESKY_DIRECTORY:
 166             g_hash_table_destroy(inode->dirhash);
 167             g_hash_table_destroy(inode->dirhash_folded);
 168             g_sequence_free(inode->dirents);
 169             break;
 170
 171         case BLUESKY_SYMLINK:
 172             g_free(inode->symlink_contents);
 173             break;
 174
 175         default:
 176             break;
 177         }
 178
 179         g_mutex_free(inode->lock);
 180
 181         g_free(inode);
 182     }
 183 }
 184
 185 /* Allocate a fresh inode number which has not been used before within a
 186  * filesystem.  fs must already be locked. */
 187 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs)
 188 {
 189     uint64_t inum;
 190
 191     inum = fs->next_inum;
 192     fs->next_inum++;
 193
 194     bluesky_superblock_flush(fs);
 195
 196     return inum;
 197 }
 198
 199 /* Perform type-specification initialization of an inode.  Normally performed
 200  * in bluesky_new_inode, but can be separated if an inode is created first,
 201  * then deserialized. */
 202 void bluesky_init_inode(BlueSkyInode *i, BlueSkyFileType type)
 203 {
 204     i->type = type;
 205
 206     switch (type) {
 207     case BLUESKY_REGULAR:
 208         i->blocks = g_array_new(FALSE, TRUE, sizeof(BlueSkyBlock));
 209         break;
 210     case BLUESKY_DIRECTORY:
 211         i->dirents = g_sequence_new(bluesky_dirent_destroy);
 212         i->dirhash = g_hash_table_new(g_str_hash, g_str_equal);
 213         i->dirhash_folded = g_hash_table_new(g_str_hash, g_str_equal);
 214         break;
 215     default:
 216         break;
 217     }
 218 }
 219
 220 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs,
 221                                 BlueSkyFileType type)
 222 {
 223     BlueSkyInode *i = g_new0(BlueSkyInode, 1);
 224
 225     i->lock = g_mutex_new();
 226     i->refcount = 1;
 227     i->fs = fs;
 228     i->inum = inum;
 229     i->change_count = 1;
 230     bluesky_init_inode(i, type);
 231
 232     return i;
 233 }
 234
 235 /* Retrieve an inode from the filesystem.  Eventually this will be a cache and
 236  * so we might need to go fetch the inode from elsewhere; for now all
 237  * filesystem state is stored here.  inode is returned with a reference held
 238  * but not locked. */
 239 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum)
 240 {
 241     BlueSkyInode *inode = NULL;
 242
 243     if (inum == 0) {
 244         return NULL;
 245     }
 246
 247     g_mutex_lock(fs->lock);
 248     inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
 249
 250     if (inode == NULL) {
 251         bluesky_inode_fetch(fs, inum);
 252         inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
 253     }
 254
 255     if (inode != NULL) {
 256         bluesky_inode_ref(inode);
 257
 258         /* FIXME: We assume we can atomically update the in-memory access time
 259          * without a lock. */
 260         inode->access_time = bluesky_get_current_time();
 261     }
 262
 263     g_mutex_unlock(fs->lock);
 264
 265     return inode;
 266 }
 267
 268 /* Insert an inode into the filesystem inode cache.  fs should be locked. */
 269 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode)
 270 {
 271     g_hash_table_insert(fs->inodes, &inode->inum, inode);
 272 }
 273
 274 /* Deprecated: Synchronize an inode to stable storage. */
 275 void bluesky_inode_flush(BlueSkyFS *fs, BlueSkyInode *inode)
 276 {
 277     GString *buf = g_string_new("");
 278     bluesky_serialize_inode(buf, inode);
 279     BlueSkyRCStr *data = bluesky_string_new_from_gstring(buf);
 280
 281     char key[64];
 282     sprintf(key, "inode-%016"PRIx64, inode->inum);
 283
 284     BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
 285     async->op = STORE_OP_PUT;
 286     async->key = g_strdup(key);
 287     async->data = data;
 288     bluesky_store_async_submit(async);
 289     bluesky_store_async_unref(async);
 290 }
 291
 292 /* Start writeback of an inode and all associated data. */
 293 void bluesky_inode_start_sync(BlueSkyInode *inode, BlueSkyStoreAsync *barrier)
 294 {
 295     BlueSkyFS *fs = inode->fs;
 296
 297     if (inode->type == BLUESKY_REGULAR)
 298         bluesky_file_flush(inode, barrier);
 299
 300     GString *buf = g_string_new("");
 301     bluesky_serialize_inode(buf, inode);
 302     BlueSkyRCStr *data = bluesky_string_new_from_gstring(buf);
 303
 304     char key[64];
 305     sprintf(key, "inode-%016"PRIx64, inode->inum);
 306
 307     BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
 308     async->op = STORE_OP_PUT;
 309     async->key = g_strdup(key);
 310     async->data = data;
 311     bluesky_store_async_submit(async);
 312     if (barrier != NULL)
 313         bluesky_store_add_barrier(barrier, async);
 314     bluesky_store_async_unref(async);
 315 }
 316
 317 /* Write back an inode and all associated data and wait for completion.  Inode
 318  * should already be locked. */
 319 void bluesky_inode_do_sync(BlueSkyInode *inode)
 320 {
 321     BlueSkyStoreAsync *barrier = bluesky_store_async_new(inode->fs->store);
 322     barrier->op = STORE_OP_BARRIER;
 323
 324     g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
 325           "Synchronous writeback for inode %"PRIu64"...", inode->inum);
 326     bluesky_inode_start_sync(inode, barrier);
 327     bluesky_store_async_submit(barrier);
 328     bluesky_store_async_wait(barrier);
 329     bluesky_store_async_unref(barrier);
 330     g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
 331           "Writeback for inode %"PRIu64" complete", inode->inum);
 332 }
 333
 334 static void complete_inode_fetch(BlueSkyStoreAsync *async, BlueSkyInode *inode)
 335 {
 336     g_print("Completing fetch of inode %"PRIu64"...\n", inode->inum);
 337
 338     if (async->result != 0
 339         || !bluesky_deserialize_inode(inode, async->data->data))
 340     {
 341         g_print("    failed to load inode, cleaning up\n");
 342         g_mutex_lock(inode->fs->lock);
 343         g_hash_table_remove(inode->fs->inodes, &inode->inum);
 344         g_mutex_unlock(inode->fs->lock);
 345         bluesky_inode_unref(inode);
 346     }
 347
 348     inode->access_time = bluesky_get_current_time();
 349     g_mutex_lock(inode->fs->lock);
 350     inode->accessed_list = bluesky_list_prepend(&inode->fs->accessed_list, inode);
 351     g_mutex_unlock(inode->fs->lock);
 352
 353     g_mutex_unlock(inode->lock);
 354     bluesky_inode_unref(inode);
 355 }
 356
 357 /* Fetch an inode from stable storage.  The fetch can be performed
 358  * asynchronously: the in-memory inode is allocated, but not filled with data
 359  * immediately.  It is kept locked until it has been filled in, so any users
 360  * should try to acquire the lock on the inode before accessing any data.  The
 361  * fs lock must be held. */
 362 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum)
 363 {
 364     char key[64];
 365     sprintf(key, "inode-%016"PRIx64, inum);
 366
 367     BlueSkyInode *inode = bluesky_new_inode(inum, fs, BLUESKY_PENDING);
 368     bluesky_inode_ref(inode);       // Extra ref held by fetching process
 369     g_mutex_lock(inode->lock);
 370     bluesky_insert_inode(fs, inode);
 371
 372     BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
 373     async->op = STORE_OP_GET;
 374     async->key = g_strdup(key);
 375
 376     bluesky_store_async_add_notifier(async, (GFunc)complete_inode_fetch, inode);
 377     bluesky_store_async_submit(async);
 378
 379     if (bluesky_options.sync_inode_fetches) {
 380         bluesky_store_async_wait(async);
 381     }
 382
 383     bluesky_store_async_unref(async);
 384 }
 385
 386 /* Synchronize filesystem superblock to stable storage. */
 387 void bluesky_superblock_flush(BlueSkyFS *fs)
 388 {
 389     GString *buf = g_string_new("");
 390     bluesky_serialize_superblock(buf, fs);
 391     BlueSkyRCStr *data = bluesky_string_new_from_gstring(buf);
 392
 393     BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
 394     async->op = STORE_OP_PUT;
 395     async->key = g_strdup("superblock");
 396     async->data = data;
 397     bluesky_store_async_submit(async);
 398     bluesky_store_async_unref(async);
 399
 400     bluesky_store_sync(fs->store);
 401 }