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