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->dirty_list, inode->dirty_list);
54 inode->dirty_list = bluesky_list_prepend(&inode->fs->dirty_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);
59 bluesky_cloudlog_unref(inode->committed_item);
60 inode->committed_item = NULL;
63 /* Unfortunately a glib hash table is only guaranteed to be able to store
64 * 32-bit keys if we use the key directly. If we want 64-bit inode numbers,
65 * we'll have to allocate memory to store the 64-bit inumber, and use a pointer
66 * to it. Rather than allocate the memory for the key, we'll just include a
67 * pointer to the 64-bit inum stored in the inode itself, so that we don't need
68 * to do any more memory management. */
69 static guint bluesky_fs_key_hash_func(gconstpointer key)
71 uint64_t inum = *(const uint64_t *)key;
75 static gboolean bluesky_fs_key_equal_func(gconstpointer a, gconstpointer b)
77 uint64_t i1 = *(const uint64_t *)a;
78 uint64_t i2 = *(const uint64_t *)b;
82 /* Filesystem-level operations. A filesystem is like a directory tree that we
83 * are willing to export. */
84 BlueSkyFS *bluesky_new_fs(gchar *name)
86 BlueSkyFS *fs = g_new0(BlueSkyFS, 1);
87 fs->lock = g_mutex_new();
88 fs->name = g_strdup(name);
89 fs->inodes = g_hash_table_new(bluesky_fs_key_hash_func,
90 bluesky_fs_key_equal_func);
91 fs->next_inum = BLUESKY_ROOT_INUM + 1;
92 fs->store = bluesky_store_new("file");
93 fs->flushd_lock = g_mutex_new();
94 fs->flushd_cond = g_cond_new();
95 fs->locations = g_hash_table_new(bluesky_cloudlog_hash,
96 bluesky_cloudlog_equal);
98 fs->log_state = g_new0(BlueSkyCloudLogState, 1);
99 fs->log_state->data = g_string_new("");
104 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store)
106 BlueSkyRCStr *data = bluesky_store_get(store, "superblock");
108 BlueSkyFS *fs = bluesky_deserialize_superblock(data->data);
111 fs->log = bluesky_log_new("journal");
112 g_print("Loaded filesystem superblock\n");
114 fs->name = g_strdup(name);
117 bluesky_string_unref(data);
120 g_print("Initializing fresh filesystem\n");
121 BlueSkyFS *fs = bluesky_new_fs(name);
123 fs->log = bluesky_log_new("journal");
125 BlueSkyInode *root = bluesky_new_inode(BLUESKY_ROOT_INUM, fs,
129 bluesky_insert_inode(fs, root);
130 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 void bluesky_inode_unref(BlueSkyInode *inode)
146 if (g_atomic_int_dec_and_test(&inode->refcount)) {
147 if (bluesky_verbose) {
148 g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
149 "Reference count for inode %"PRIu64" dropped to zero.",
153 /* Sanity check: Is the inode clean? */
154 if (inode->change_commit < inode->change_count
155 || inode->accessed_list != NULL
156 || inode->unlogged_list != NULL
157 || inode->dirty_list != NULL) {
158 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);
161 /* These shouldn't be needed, but in case the above warning fires and
162 * we delete the inode anyway, we ought to be sure the inode is not on
164 g_mutex_lock(inode->fs->lock);
165 bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
166 bluesky_list_unlink(&inode->fs->dirty_list, inode->dirty_list);
167 bluesky_list_unlink(&inode->fs->unlogged_list, inode->unlogged_list);
168 g_mutex_unlock(inode->fs->lock);
170 /* Free file type specific data. It should be an error for there to be
171 * dirty data to commit when the reference count has reaches zero. */
172 switch (inode->type) {
173 case BLUESKY_REGULAR:
174 for (int i = 0; i < inode->blocks->len; i++) {
175 BlueSkyBlock *b = &g_array_index(inode->blocks,
177 if (b->type == BLUESKY_BLOCK_DIRTY) {
178 g_error("Deleting an inode with dirty file data!");
180 bluesky_cloudlog_unref(b->ref);
181 bluesky_string_unref(b->dirty);
183 g_array_unref(inode->blocks);
186 case BLUESKY_DIRECTORY:
187 g_hash_table_destroy(inode->dirhash);
188 g_hash_table_destroy(inode->dirhash_folded);
189 g_sequence_free(inode->dirents);
192 case BLUESKY_SYMLINK:
193 g_free(inode->symlink_contents);
200 g_mutex_free(inode->lock);
206 /* Allocate a fresh inode number which has not been used before within a
207 * filesystem. fs must already be locked. */
208 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs)
212 inum = fs->next_inum;
215 bluesky_superblock_flush(fs);
220 /* Perform type-specification initialization of an inode. Normally performed
221 * in bluesky_new_inode, but can be separated if an inode is created first,
222 * then deserialized. */
223 void bluesky_init_inode(BlueSkyInode *i, BlueSkyFileType type)
228 case BLUESKY_REGULAR:
229 i->blocks = g_array_new(FALSE, TRUE, sizeof(BlueSkyBlock));
231 case BLUESKY_DIRECTORY:
232 i->dirents = g_sequence_new(bluesky_dirent_destroy);
233 i->dirhash = g_hash_table_new(g_str_hash, g_str_equal);
234 i->dirhash_folded = g_hash_table_new(g_str_hash, g_str_equal);
241 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs,
242 BlueSkyFileType type)
244 BlueSkyInode *i = g_new0(BlueSkyInode, 1);
246 i->lock = g_mutex_new();
251 bluesky_init_inode(i, type);
256 /* Retrieve an inode from the filesystem. Eventually this will be a cache and
257 * so we might need to go fetch the inode from elsewhere; for now all
258 * filesystem state is stored here. inode is returned with a reference held
260 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum)
262 BlueSkyInode *inode = NULL;
268 g_mutex_lock(fs->lock);
269 inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
272 bluesky_inode_fetch(fs, inum);
273 inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
277 bluesky_inode_ref(inode);
279 /* FIXME: We assume we can atomically update the in-memory access time
281 inode->access_time = bluesky_get_current_time();
284 g_mutex_unlock(fs->lock);
289 /* Insert an inode into the filesystem inode cache. fs should be locked. */
290 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode)
292 g_hash_table_insert(fs->inodes, &inode->inum, inode);
295 /* Start writeback of an inode and all associated data. */
296 void bluesky_inode_start_sync(BlueSkyInode *inode)
298 GList *log_items = NULL;
300 if (inode->type == BLUESKY_REGULAR)
301 bluesky_file_flush(inode, &log_items);
303 BlueSkyCloudLog *cloudlog = bluesky_serialize_inode(inode);
305 bluesky_cloudlog_unref(inode->committed_item);
306 inode->committed_item = cloudlog;
308 bluesky_cloudlog_sync(cloudlog);
309 bluesky_cloudlog_ref(cloudlog);
310 log_items = g_list_prepend(log_items, cloudlog);
312 /* Wait for all log items to be committed to disk. */
313 bluesky_log_finish_all(log_items);
315 /* Mark the inode as clean */
316 inode->change_commit = inode->change_count;
317 inode->change_time = 0;
318 g_mutex_lock(inode->fs->lock);
319 bluesky_list_unlink(&inode->fs->unlogged_list, inode->unlogged_list);
320 inode->unlogged_list = NULL;
321 g_mutex_unlock(inode->fs->lock);
324 /* Write back an inode and all associated data and wait for completion. Inode
325 * should already be locked. */
326 void bluesky_inode_do_sync(BlueSkyInode *inode)
328 if (bluesky_verbose) {
329 g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
330 "Synchronous writeback for inode %"PRIu64"...", inode->inum);
332 bluesky_inode_start_sync(inode);
333 if (bluesky_verbose) {
334 g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
335 "Writeback for inode %"PRIu64" complete", inode->inum);
339 static void complete_inode_fetch(BlueSkyStoreAsync *async, BlueSkyInode *inode)
341 if (bluesky_verbose) {
342 g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
343 "Completing fetch of inode %"PRIu64"...", inode->inum);
346 if (async->result != 0
347 || !bluesky_deserialize_inode(inode, async->data->data))
349 if (bluesky_verbose) {
350 g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
351 " failed to load inode, cleaning up");
353 g_mutex_lock(inode->fs->lock);
354 g_hash_table_remove(inode->fs->inodes, &inode->inum);
355 bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
356 inode->accessed_list = NULL;
357 g_mutex_unlock(inode->fs->lock);
358 bluesky_inode_unref(inode);
361 inode->access_time = bluesky_get_current_time();
362 g_mutex_lock(inode->fs->lock);
363 bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
364 inode->accessed_list = bluesky_list_prepend(&inode->fs->accessed_list, inode);
365 g_mutex_unlock(inode->fs->lock);
367 g_mutex_unlock(inode->lock);
368 bluesky_inode_unref(inode);
371 /* Fetch an inode from stable storage. The fetch can be performed
372 * asynchronously: the in-memory inode is allocated, but not filled with data
373 * immediately. It is kept locked until it has been filled in, so any users
374 * should try to acquire the lock on the inode before accessing any data. The
375 * fs lock must be held. */
376 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum)
379 sprintf(key, "inode-%016"PRIx64, inum);
381 BlueSkyInode *inode = bluesky_new_inode(inum, fs, BLUESKY_PENDING);
382 inode->change_count = 0;
383 bluesky_inode_ref(inode); // Extra ref held by fetching process
384 g_mutex_lock(inode->lock);
385 bluesky_insert_inode(fs, inode);
387 BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
388 async->op = STORE_OP_GET;
389 async->key = g_strdup(key);
391 bluesky_store_async_add_notifier(async, (GFunc)complete_inode_fetch, inode);
392 bluesky_store_async_submit(async);
394 if (bluesky_options.sync_inode_fetches) {
395 bluesky_store_async_wait(async);
398 bluesky_store_async_unref(async);
401 /* Synchronize filesystem superblock to stable storage. */
402 void bluesky_superblock_flush(BlueSkyFS *fs)
405 GString *buf = g_string_new("");
406 bluesky_serialize_superblock(buf, fs);
407 BlueSkyRCStr *data = bluesky_string_new_from_gstring(buf);
409 BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
410 async->op = STORE_OP_PUT;
411 async->key = g_strdup("superblock");
413 bluesky_store_async_submit(async);
414 bluesky_store_async_unref(async);
416 //bluesky_store_sync(fs->store);