1 /* Blue Sky: File Systems in the Cloud
3 * Copyright (C) 2009 The Regents of the University of California
4 * Written by Michael Vrable <mvrable@cs.ucsd.edu>
15 #include "bluesky-private.h"
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. */
22 /* Return the current time, in microseconds since the epoch. */
23 int64_t bluesky_get_current_time()
26 g_get_current_time(&t);
27 return (int64_t)t.tv_sec * 1000000 + t.tv_usec;
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)
36 int64_t now = bluesky_get_current_time();
37 inode->change_count++;
42 if (inode->change_time == 0)
43 inode->change_time = now;
46 if (bluesky_options.writethrough_cache)
47 bluesky_file_flush(inode, NULL);
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);
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)
66 uint64_t inum = *(const uint64_t *)key;
70 static gboolean bluesky_fs_key_equal_func(gconstpointer a, gconstpointer b)
72 uint64_t i1 = *(const uint64_t *)a;
73 uint64_t i2 = *(const uint64_t *)b;
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)
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 fs->inode_map = g_sequence_new(NULL);
94 fs->log_state = g_new0(BlueSkyCloudLogState, 1);
95 fs->log_state->data = g_string_new("");
100 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store)
102 BlueSkyRCStr *data = bluesky_store_get(store, "superblock");
104 BlueSkyFS *fs = bluesky_deserialize_superblock(data->data);
107 fs->log = bluesky_log_new("journal");
109 g_print("Loaded filesystem superblock\n");
111 fs->name = g_strdup(name);
114 bluesky_string_unref(data);
117 g_print("Initializing fresh filesystem\n");
118 BlueSkyFS *fs = bluesky_new_fs(name);
120 fs->log = bluesky_log_new("journal");
123 BlueSkyInode *root = bluesky_new_inode(BLUESKY_ROOT_INUM, fs,
127 bluesky_insert_inode(fs, root);
128 bluesky_inode_update_ctime(root, TRUE);
132 bluesky_inode_do_sync(root);
133 bluesky_superblock_flush(fs);
138 /* Inode reference counting. */
139 void bluesky_inode_ref(BlueSkyInode *inode)
141 g_atomic_int_inc(&inode->refcount);
144 /* Free most of the resources used by an inode structure, but do not free the
145 * inode itself. Can be used if the inode data will be reloaded from
146 * serialized form to clear out old information first. */
147 void bluesky_inode_free_resources(BlueSkyInode *inode)
149 switch (inode->type) {
150 case BLUESKY_REGULAR:
151 if (inode->blocks != NULL) {
152 for (int i = 0; i < inode->blocks->len; i++) {
153 BlueSkyBlock *b = &g_array_index(inode->blocks,
155 if (b->type == BLUESKY_BLOCK_DIRTY) {
156 g_error("Deleting an inode with dirty file data!");
158 bluesky_cloudlog_unref(b->ref);
159 bluesky_string_unref(b->dirty);
161 g_array_unref(inode->blocks);
162 inode->blocks = NULL;
166 case BLUESKY_DIRECTORY:
167 if (inode->dirhash != NULL)
168 g_hash_table_destroy(inode->dirhash);
169 inode->dirhash = NULL;
170 if (inode->dirhash_folded != NULL)
171 g_hash_table_destroy(inode->dirhash_folded);
172 inode->dirhash_folded = NULL;
173 if (inode->dirents != NULL)
174 g_sequence_free(inode->dirents);
175 inode->dirents = NULL;
178 case BLUESKY_SYMLINK:
179 g_free(inode->symlink_contents);
180 inode->symlink_contents = NULL;
188 void bluesky_inode_unref(BlueSkyInode *inode)
190 if (g_atomic_int_dec_and_test(&inode->refcount)) {
191 if (bluesky_verbose) {
192 g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
193 "Reference count for inode %"PRIu64" dropped to zero.",
197 /* Sanity check: Is the inode clean? */
198 if (inode->change_commit < inode->change_count
199 || inode->accessed_list != NULL
200 || inode->unlogged_list != NULL
201 || inode->dirty_list != NULL) {
202 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);
205 /* These shouldn't be needed, but in case the above warning fires and
206 * we delete the inode anyway, we ought to be sure the inode is not on
208 g_mutex_lock(inode->fs->lock);
209 bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
210 bluesky_list_unlink(&inode->fs->dirty_list, inode->dirty_list);
211 bluesky_list_unlink(&inode->fs->unlogged_list, inode->unlogged_list);
212 g_mutex_unlock(inode->fs->lock);
214 bluesky_inode_free_resources(inode);
216 g_mutex_free(inode->lock);
221 /* Allocate a fresh inode number which has not been used before within a
222 * filesystem. fs must already be locked. */
223 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs)
227 inum = fs->next_inum;
230 bluesky_superblock_flush(fs);
235 /* Perform type-specification initialization of an inode. Normally performed
236 * in bluesky_new_inode, but can be separated if an inode is created first,
237 * then deserialized. */
238 void bluesky_init_inode(BlueSkyInode *i, BlueSkyFileType type)
243 case BLUESKY_REGULAR:
244 i->blocks = g_array_new(FALSE, TRUE, sizeof(BlueSkyBlock));
246 case BLUESKY_DIRECTORY:
247 i->dirents = g_sequence_new(bluesky_dirent_destroy);
248 i->dirhash = g_hash_table_new(g_str_hash, g_str_equal);
249 i->dirhash_folded = g_hash_table_new(g_str_hash, g_str_equal);
256 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs,
257 BlueSkyFileType type)
259 BlueSkyInode *i = g_new0(BlueSkyInode, 1);
261 i->lock = g_mutex_new();
266 bluesky_init_inode(i, type);
271 /* Retrieve an inode from the filesystem. Eventually this will be a cache and
272 * so we might need to go fetch the inode from elsewhere; for now all
273 * filesystem state is stored here. inode is returned with a reference held
275 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum)
277 BlueSkyInode *inode = NULL;
283 g_mutex_lock(fs->lock);
284 inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
287 bluesky_inode_fetch(fs, inum);
288 inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
292 bluesky_inode_ref(inode);
294 /* FIXME: We assume we can atomically update the in-memory access time
296 inode->access_time = bluesky_get_current_time();
299 g_mutex_unlock(fs->lock);
304 /* Insert an inode into the filesystem inode cache. fs should be locked. */
305 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode)
307 g_hash_table_insert(fs->inodes, &inode->inum, inode);
310 /* Start writeback of an inode and all associated data. */
311 void bluesky_inode_start_sync(BlueSkyInode *inode)
313 GList *log_items = NULL;
315 if (inode->type == BLUESKY_REGULAR)
316 bluesky_file_flush(inode, &log_items);
318 BlueSkyCloudLog *cloudlog = bluesky_serialize_inode(inode);
320 bluesky_cloudlog_unref(inode->committed_item);
321 inode->committed_item = cloudlog;
323 bluesky_cloudlog_sync(cloudlog);
324 bluesky_cloudlog_ref(cloudlog);
325 log_items = g_list_prepend(log_items, cloudlog);
327 /* Wait for all log items to be committed to disk. */
328 bluesky_log_finish_all(log_items);
330 /* Mark the inode as clean */
331 inode->change_commit = inode->change_count;
332 inode->change_time = 0;
333 g_mutex_lock(inode->fs->lock);
334 bluesky_list_unlink(&inode->fs->unlogged_list, inode->unlogged_list);
335 inode->unlogged_list = NULL;
337 /* Since a new version of the inode has been written to the log, also
338 * schedule a future flush of the new data to cloud storage. */
339 bluesky_list_unlink(&inode->fs->dirty_list, inode->dirty_list);
340 inode->dirty_list = bluesky_list_prepend(&inode->fs->dirty_list, inode);
341 inode->change_cloud = inode->change_count;
343 g_mutex_unlock(inode->fs->lock);
346 /* Write back an inode and all associated data and wait for completion. Inode
347 * should already be locked. */
348 void bluesky_inode_do_sync(BlueSkyInode *inode)
350 if (bluesky_verbose) {
351 g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
352 "Synchronous writeback for inode %"PRIu64"...", inode->inum);
354 bluesky_inode_start_sync(inode);
355 if (bluesky_verbose) {
356 g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
357 "Writeback for inode %"PRIu64" complete", inode->inum);
361 static void complete_inode_fetch(BlueSkyStoreAsync *async, BlueSkyInode *inode)
363 if (bluesky_verbose) {
364 g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
365 "Completing fetch of inode %"PRIu64"...", inode->inum);
368 if (async->result != 0 || FALSE)
370 if (bluesky_verbose) {
371 g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
372 " failed to load inode, cleaning up");
374 g_mutex_lock(inode->fs->lock);
375 g_hash_table_remove(inode->fs->inodes, &inode->inum);
376 bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
377 inode->accessed_list = NULL;
378 g_mutex_unlock(inode->fs->lock);
379 bluesky_inode_unref(inode);
382 inode->access_time = bluesky_get_current_time();
383 g_mutex_lock(inode->fs->lock);
384 bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
385 inode->accessed_list = bluesky_list_prepend(&inode->fs->accessed_list, inode);
386 g_mutex_unlock(inode->fs->lock);
388 g_mutex_unlock(inode->lock);
389 bluesky_inode_unref(inode);
392 /* Fetch an inode from stable storage. The fetch can be performed
393 * asynchronously: the in-memory inode is allocated, but not filled with data
394 * immediately. It is kept locked until it has been filled in, so any users
395 * should try to acquire the lock on the inode before accessing any data. The
396 * fs lock must be held. */
397 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum)
400 sprintf(key, "inode-%016"PRIx64, inum);
402 BlueSkyInode *inode = bluesky_new_inode(inum, fs, BLUESKY_PENDING);
403 inode->change_count = 0;
404 bluesky_inode_ref(inode); // Extra ref held by fetching process
405 g_mutex_lock(inode->lock);
406 bluesky_insert_inode(fs, inode);
408 BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
409 async->op = STORE_OP_GET;
410 async->key = g_strdup(key);
412 bluesky_store_async_add_notifier(async, (GFunc)complete_inode_fetch, inode);
413 bluesky_store_async_submit(async);
415 if (bluesky_options.sync_inode_fetches) {
416 bluesky_store_async_wait(async);
419 bluesky_store_async_unref(async);
422 /* Synchronize filesystem superblock to stable storage. */
423 void bluesky_superblock_flush(BlueSkyFS *fs)
426 GString *buf = g_string_new("");
427 bluesky_serialize_superblock(buf, fs);
428 BlueSkyRCStr *data = bluesky_string_new_from_gstring(buf);
430 BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
431 async->op = STORE_OP_PUT;
432 async->key = g_strdup("superblock");
434 bluesky_store_async_submit(async);
435 bluesky_store_async_unref(async);
437 //bluesky_store_sync(fs->store);