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
  93     fs->log_state = g_new0(BlueSkyCloudLogState, 1);
  94     fs->log_state->data = g_string_new("");
  95
  96     return fs;
  97 }
  98
  99 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store)
 100 {
 101     BlueSkyRCStr *data = bluesky_store_get(store, "superblock");
 102     if (data != NULL) {
 103         BlueSkyFS *fs = bluesky_deserialize_superblock(data->data);
 104         if (fs != NULL) {
 105             fs->store = store;
 106             fs->log = bluesky_log_new("journal");
 107             fs->log->fs = fs;
 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     fs->log->fs = fs;
 121
 122     BlueSkyInode *root = bluesky_new_inode(BLUESKY_ROOT_INUM, fs,
 123                                            BLUESKY_DIRECTORY);
 124     root->nlink = 1;
 125     root->mode = 0755;
 126     bluesky_insert_inode(fs, root);
 127     bluesky_inode_update_ctime(root, TRUE);
 128
 129     bluesky_inode_do_sync(root);
 130     bluesky_superblock_flush(fs);
 131
 132     return fs;
 133 }
 134
 135 /* Inode reference counting. */
 136 void bluesky_inode_ref(BlueSkyInode *inode)
 137 {
 138     g_atomic_int_inc(&inode->refcount);
 139 }
 140
 141 void bluesky_inode_unref(BlueSkyInode *inode)
 142 {
 143     if (g_atomic_int_dec_and_test(&inode->refcount)) {
 144         if (bluesky_verbose) {
 145             g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
 146                   "Reference count for inode %"PRIu64" dropped to zero.",
 147                   inode->inum);
 148         }
 149
 150         /* Sanity check: Is the inode clean? */
 151         if (inode->change_commit < inode->change_count
 152                 || inode->accessed_list != NULL
 153                 || inode->unlogged_list != NULL
 154                 || inode->dirty_list != NULL) {
 155             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);
 156         }
 157
 158         /* These shouldn't be needed, but in case the above warning fires and
 159          * we delete the inode anyway, we ought to be sure the inode is not on
 160          * any LRU list. */
 161         g_mutex_lock(inode->fs->lock);
 162         bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
 163         bluesky_list_unlink(&inode->fs->dirty_list, inode->dirty_list);
 164         bluesky_list_unlink(&inode->fs->unlogged_list, inode->unlogged_list);
 165         g_mutex_unlock(inode->fs->lock);
 166
 167         /* Free file type specific data.  It should be an error for there to be
 168          * dirty data to commit when the reference count has reaches zero. */
 169         switch (inode->type) {
 170         case BLUESKY_REGULAR:
 171             for (int i = 0; i < inode->blocks->len; i++) {
 172                 BlueSkyBlock *b = &g_array_index(inode->blocks,
 173                                                  BlueSkyBlock, i);
 174                 if (b->type == BLUESKY_BLOCK_DIRTY) {
 175                     g_error("Deleting an inode with dirty file data!");
 176                 }
 177                 bluesky_cloudlog_unref(b->ref);
 178                 bluesky_string_unref(b->dirty);
 179             }
 180             g_array_unref(inode->blocks);
 181             break;
 182
 183         case BLUESKY_DIRECTORY:
 184             g_hash_table_destroy(inode->dirhash);
 185             g_hash_table_destroy(inode->dirhash_folded);
 186             g_sequence_free(inode->dirents);
 187             break;
 188
 189         case BLUESKY_SYMLINK:
 190             g_free(inode->symlink_contents);
 191             break;
 192
 193         default:
 194             break;
 195         }
 196
 197         g_mutex_free(inode->lock);
 198
 199         g_free(inode);
 200     }
 201 }
 202
 203 /* Allocate a fresh inode number which has not been used before within a
 204  * filesystem.  fs must already be locked. */
 205 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs)
 206 {
 207     uint64_t inum;
 208
 209     inum = fs->next_inum;
 210     fs->next_inum++;
 211
 212     bluesky_superblock_flush(fs);
 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
 351         || !bluesky_deserialize_inode(inode, async->data->data))
 352     {
 353         if (bluesky_verbose) {
 354             g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
 355                   "    failed to load inode, cleaning up");
 356         }
 357         g_mutex_lock(inode->fs->lock);
 358         g_hash_table_remove(inode->fs->inodes, &inode->inum);
 359         bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
 360         inode->accessed_list = NULL;
 361         g_mutex_unlock(inode->fs->lock);
 362         bluesky_inode_unref(inode);
 363     }
 364
 365     inode->access_time = bluesky_get_current_time();
 366     g_mutex_lock(inode->fs->lock);
 367     bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
 368     inode->accessed_list = bluesky_list_prepend(&inode->fs->accessed_list, inode);
 369     g_mutex_unlock(inode->fs->lock);
 370
 371     g_mutex_unlock(inode->lock);
 372     bluesky_inode_unref(inode);
 373 }
 374
 375 /* Fetch an inode from stable storage.  The fetch can be performed
 376  * asynchronously: the in-memory inode is allocated, but not filled with data
 377  * immediately.  It is kept locked until it has been filled in, so any users
 378  * should try to acquire the lock on the inode before accessing any data.  The
 379  * fs lock must be held. */
 380 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum)
 381 {
 382     char key[64];
 383     sprintf(key, "inode-%016"PRIx64, inum);
 384
 385     BlueSkyInode *inode = bluesky_new_inode(inum, fs, BLUESKY_PENDING);
 386     inode->change_count = 0;
 387     bluesky_inode_ref(inode);       // Extra ref held by fetching process
 388     g_mutex_lock(inode->lock);
 389     bluesky_insert_inode(fs, inode);
 390
 391     BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
 392     async->op = STORE_OP_GET;
 393     async->key = g_strdup(key);
 394
 395     bluesky_store_async_add_notifier(async, (GFunc)complete_inode_fetch, inode);
 396     bluesky_store_async_submit(async);
 397
 398     if (bluesky_options.sync_inode_fetches) {
 399         bluesky_store_async_wait(async);
 400     }
 401
 402     bluesky_store_async_unref(async);
 403 }
 404
 405 /* Synchronize filesystem superblock to stable storage. */
 406 void bluesky_superblock_flush(BlueSkyFS *fs)
 407 {
 408 #if 0
 409     GString *buf = g_string_new("");
 410     bluesky_serialize_superblock(buf, fs);
 411     BlueSkyRCStr *data = bluesky_string_new_from_gstring(buf);
 412
 413     BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
 414     async->op = STORE_OP_PUT;
 415     async->key = g_strdup("superblock");
 416     async->data = data;
 417     bluesky_store_async_submit(async);
 418     bluesky_store_async_unref(async);
 419
 420     //bluesky_store_sync(fs->store);
 421 #endif
 422 }