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