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