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