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     bluesky_cloudlog_threads_init(fs);
  98
  99     return fs;
 100 }
 101
 102 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store)
 103 {
 104     BlueSkyFS *fs = bluesky_new_fs(name);
 105     fs->store = store;
 106     fs->log = bluesky_log_new("journal");
 107     fs->log->fs = fs;
 108
 109     if (bluesky_checkpoint_load(fs)) {
 110         g_print("Filesystem checkpoint loaded, starting journal replay...\n");
 111         bluesky_replay(fs);
 112         g_print("Journal replay complete, filesystem ready.\n");
 113     } else {
 114         /* Initialize a fresh filesystem */
 115         g_print("Initializing new filesystem...\n");
 116         BlueSkyInode *root = bluesky_new_inode(BLUESKY_ROOT_INUM, fs,
 117                                                BLUESKY_DIRECTORY);
 118         root->nlink = 1;
 119         root->mode = 0755;
 120         bluesky_insert_inode(fs, root);
 121         bluesky_inode_update_ctime(root, TRUE);
 122         bluesky_inode_do_sync(root);
 123     }
 124
 125     return fs;
 126 }
 127
 128 /* Inode reference counting. */
 129 void bluesky_inode_ref(BlueSkyInode *inode)
 130 {
 131     g_atomic_int_inc(&inode->refcount);
 132 }
 133
 134 /* Free most of the resources used by an inode structure, but do not free the
 135  * inode itself.  Can be used if the inode data will be reloaded from
 136  * serialized form to clear out old information first. */
 137 void bluesky_inode_free_resources(BlueSkyInode *inode)
 138 {
 139     switch (inode->type) {
 140     case BLUESKY_REGULAR:
 141         if (inode->blocks != NULL) {
 142             for (int i = 0; i < inode->blocks->len; i++) {
 143                 BlueSkyBlock *b = &g_array_index(inode->blocks,
 144                                                  BlueSkyBlock, i);
 145                 if (b->type == BLUESKY_BLOCK_DIRTY) {
 146                     g_error("Deleting an inode with dirty file data!");
 147                 }
 148                 bluesky_cloudlog_unref(b->ref);
 149                 bluesky_string_unref(b->dirty);
 150             }
 151             g_array_unref(inode->blocks);
 152             inode->blocks = NULL;
 153         }
 154         break;
 155
 156     case BLUESKY_DIRECTORY:
 157         if (inode->dirhash != NULL)
 158             g_hash_table_destroy(inode->dirhash);
 159         inode->dirhash = NULL;
 160         if (inode->dirhash_folded != NULL)
 161             g_hash_table_destroy(inode->dirhash_folded);
 162         inode->dirhash_folded = NULL;
 163         if (inode->dirents != NULL)
 164             g_sequence_free(inode->dirents);
 165         inode->dirents = NULL;
 166         break;
 167
 168     case BLUESKY_SYMLINK:
 169         g_free(inode->symlink_contents);
 170         inode->symlink_contents = NULL;
 171         break;
 172
 173     default:
 174         break;
 175     }
 176 }
 177
 178 void bluesky_inode_unref(BlueSkyInode *inode)
 179 {
 180     if (g_atomic_int_dec_and_test(&inode->refcount)) {
 181         if (bluesky_verbose) {
 182             g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
 183                   "Reference count for inode %"PRIu64" dropped to zero.",
 184                   inode->inum);
 185         }
 186
 187         /* Sanity check: Is the inode clean? */
 188         if (inode->change_commit < inode->change_count
 189                 || inode->accessed_list != NULL
 190                 || inode->unlogged_list != NULL
 191                 || inode->dirty_list != NULL) {
 192             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);
 193         }
 194
 195         /* These shouldn't be needed, but in case the above warning fires and
 196          * we delete the inode anyway, we ought to be sure the inode is not on
 197          * any LRU list. */
 198         g_mutex_lock(inode->fs->lock);
 199         bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
 200         bluesky_list_unlink(&inode->fs->dirty_list, inode->dirty_list);
 201         bluesky_list_unlink(&inode->fs->unlogged_list, inode->unlogged_list);
 202         g_mutex_unlock(inode->fs->lock);
 203
 204         bluesky_inode_free_resources(inode);
 205
 206         g_mutex_free(inode->lock);
 207         g_free(inode);
 208     }
 209 }
 210
 211 /* Allocate a fresh inode number which has not been used before within a
 212  * filesystem.  fs must already be locked. */
 213 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs)
 214 {
 215     uint64_t inum;
 216
 217     inum = fs->next_inum;
 218     fs->next_inum++;
 219
 220     return inum;
 221 }
 222
 223 /* Perform type-specification initialization of an inode.  Normally performed
 224  * in bluesky_new_inode, but can be separated if an inode is created first,
 225  * then deserialized. */
 226 void bluesky_init_inode(BlueSkyInode *i, BlueSkyFileType type)
 227 {
 228     i->type = type;
 229
 230     switch (type) {
 231     case BLUESKY_REGULAR:
 232         i->blocks = g_array_new(FALSE, TRUE, sizeof(BlueSkyBlock));
 233         break;
 234     case BLUESKY_DIRECTORY:
 235         i->dirents = g_sequence_new(bluesky_dirent_destroy);
 236         i->dirhash = g_hash_table_new(g_str_hash, g_str_equal);
 237         i->dirhash_folded = g_hash_table_new(g_str_hash, g_str_equal);
 238         break;
 239     default:
 240         break;
 241     }
 242 }
 243
 244 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs,
 245                                 BlueSkyFileType type)
 246 {
 247     BlueSkyInode *i = g_new0(BlueSkyInode, 1);
 248
 249     i->lock = g_mutex_new();
 250     i->refcount = 1;
 251     i->fs = fs;
 252     i->inum = inum;
 253     i->change_count = 1;
 254     bluesky_init_inode(i, type);
 255
 256     return i;
 257 }
 258
 259 /* Retrieve an inode from the filesystem.  Eventually this will be a cache and
 260  * so we might need to go fetch the inode from elsewhere; for now all
 261  * filesystem state is stored here.  inode is returned with a reference held
 262  * but not locked. */
 263 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum)
 264 {
 265     BlueSkyInode *inode = NULL;
 266
 267     if (inum == 0) {
 268         return NULL;
 269     }
 270
 271     g_mutex_lock(fs->lock);
 272     inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
 273
 274     if (inode == NULL) {
 275         bluesky_inode_fetch(fs, inum);
 276         inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
 277     }
 278
 279     if (inode != NULL) {
 280         bluesky_inode_ref(inode);
 281
 282         /* FIXME: We assume we can atomically update the in-memory access time
 283          * without a lock. */
 284         inode->access_time = bluesky_get_current_time();
 285     }
 286
 287     g_mutex_unlock(fs->lock);
 288
 289     return inode;
 290 }
 291
 292 /* Insert an inode into the filesystem inode cache.  fs should be locked. */
 293 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode)
 294 {
 295     g_hash_table_insert(fs->inodes, &inode->inum, inode);
 296 }
 297
 298 /* Start writeback of an inode and all associated data. */
 299 void bluesky_inode_start_sync(BlueSkyInode *inode)
 300 {
 301     GList *log_items = NULL;
 302
 303     if (inode->type == BLUESKY_REGULAR)
 304         bluesky_file_flush(inode, &log_items);
 305
 306     BlueSkyCloudLog *cloudlog = bluesky_serialize_inode(inode);
 307
 308     bluesky_cloudlog_unref(inode->committed_item);
 309     inode->committed_item = cloudlog;
 310
 311     bluesky_cloudlog_sync(cloudlog);
 312     bluesky_cloudlog_ref(cloudlog);
 313     log_items = g_list_prepend(log_items, cloudlog);
 314
 315     /* Wait for all log items to be committed to disk. */
 316     bluesky_log_finish_all(log_items);
 317
 318     /* Mark the inode as clean */
 319     inode->change_commit = inode->change_count;
 320     inode->change_time = 0;
 321     g_mutex_lock(inode->fs->lock);
 322     bluesky_list_unlink(&inode->fs->unlogged_list, inode->unlogged_list);
 323     inode->unlogged_list = NULL;
 324
 325     /* Since a new version of the inode has been written to the log, also
 326      * schedule a future flush of the new data to cloud storage. */
 327     bluesky_list_unlink(&inode->fs->dirty_list, inode->dirty_list);
 328     inode->dirty_list = bluesky_list_prepend(&inode->fs->dirty_list, inode);
 329     inode->change_cloud = inode->change_count;
 330
 331     g_mutex_unlock(inode->fs->lock);
 332 }
 333
 334 /* Write back an inode and all associated data and wait for completion.  Inode
 335  * should already be locked. */
 336 void bluesky_inode_do_sync(BlueSkyInode *inode)
 337 {
 338     if (bluesky_verbose) {
 339         g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
 340             "Synchronous writeback for inode %"PRIu64"...", inode->inum);
 341     }
 342     bluesky_inode_start_sync(inode);
 343     if (bluesky_verbose) {
 344         g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
 345               "Writeback for inode %"PRIu64" complete", inode->inum);
 346     }
 347 }
 348
 349 static void complete_inode_fetch(BlueSkyInode *inode)
 350 {
 351     BlueSkyCloudLog *item = inode->committed_item;
 352     inode->committed_item = NULL;
 353     g_print("Completing fetch of inode %"PRIu64"...\n", inode->inum);
 354
 355     g_mutex_lock(item->lock);
 356     bluesky_cloudlog_fetch(item);
 357     if (!bluesky_deserialize_inode(inode, item))
 358         g_print("Error deserializing inode %"PRIu64"\n", inode->inum);
 359     g_mutex_unlock(item->lock);
 360
 361     inode->access_time = bluesky_get_current_time();
 362     g_mutex_lock(inode->fs->lock);
 363     bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
 364     inode->accessed_list = bluesky_list_prepend(&inode->fs->accessed_list, inode);
 365     g_mutex_unlock(inode->fs->lock);
 366
 367     g_mutex_unlock(inode->lock);
 368     bluesky_cloudlog_unref(item);
 369     bluesky_inode_unref(inode);
 370 }
 371
 372 /* Fetch an inode from stable storage.  The fetch can be performed
 373  * asynchronously: the in-memory inode is allocated, but not filled with data
 374  * immediately.  It is kept locked until it has been filled in, so any users
 375  * should try to acquire the lock on the inode before accessing any data.  The
 376  * fs lock must be held. */
 377 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum)
 378 {
 379     InodeMapEntry *entry = bluesky_inode_map_lookup(fs->inode_map, inum, 0);
 380     if (entry == NULL)
 381         return;
 382
 383     BlueSkyInode *inode = bluesky_new_inode(inum, fs, BLUESKY_PENDING);
 384     inode->change_count = 0;
 385     bluesky_inode_ref(inode);       // Extra ref held by fetching process
 386     g_mutex_lock(inode->lock);
 387     bluesky_insert_inode(fs, inode);
 388     inode->committed_item = entry->item;
 389     bluesky_cloudlog_ref(entry->item);
 390
 391     /* TODO: Thread pool or other better async method. */
 392     g_thread_create((GThreadFunc)complete_inode_fetch,
 393                     (gpointer)inode, FALSE, NULL);
 394 }