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