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