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