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