42ae708399f1fb5506e87f54261e31a97382d588
[bluesky.git] / 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 static void inode_fetch_task(gpointer a, gpointer b);
18
19 /* Core filesystem.  Different proxies, such as the NFSv3 one, interface to
20  * this, but the core actually tracks the data which is stored.  So far we just
21  * implement an in-memory filesystem, but eventually this will be state which
22  * is persisted to the cloud. */
23
24 /* Return the current time, in microseconds since the epoch. */
25 int64_t bluesky_get_current_time()
26 {
27     GTimeVal t;
28     g_get_current_time(&t);
29     return (int64_t)t.tv_sec * 1000000 + t.tv_usec;
30 }
31
32 /* Update an inode to indicate that a modification was made.  This increases
33  * the change counter, updates the ctime to the current time, and optionally
34  * updates the mtime.  This also makes the inode contents subject to writeback
35  * to storage in the future.  inode must already be locked. */
36 void bluesky_inode_update_ctime(BlueSkyInode *inode, gboolean update_mtime)
37 {
38     int64_t now = bluesky_get_current_time();
39     inode->change_count++;
40     inode->ctime = now;
41     if (update_mtime)
42         inode->mtime = now;
43
44     if (inode->change_time == 0)
45         inode->change_time = now;
46
47 #if 0
48     if (bluesky_options.writethrough_cache)
49         bluesky_file_flush(inode, NULL);
50 #endif
51
52     g_mutex_lock(inode->fs->lock);
53     bluesky_list_unlink(&inode->fs->unlogged_list, inode->unlogged_list);
54     inode->unlogged_list = bluesky_list_prepend(&inode->fs->unlogged_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);
58 }
59
60 /* Unfortunately a glib hash table is only guaranteed to be able to store
61  * 32-bit keys if we use the key directly.  If we want 64-bit inode numbers,
62  * we'll have to allocate memory to store the 64-bit inumber, and use a pointer
63  * to it.  Rather than allocate the memory for the key, we'll just include a
64  * pointer to the 64-bit inum stored in the inode itself, so that we don't need
65  * to do any more memory management.  */
66 static guint bluesky_fs_key_hash_func(gconstpointer key)
67 {
68     uint64_t inum = *(const uint64_t *)key;
69     return (guint)inum;
70 }
71
72 static gboolean bluesky_fs_key_equal_func(gconstpointer a, gconstpointer b)
73 {
74     uint64_t i1 = *(const uint64_t *)a;
75     uint64_t i2 = *(const uint64_t *)b;
76     return i1 == i2;
77 }
78
79 /* Filesystem-level operations.  A filesystem is like a directory tree that we
80  * are willing to export. */
81 BlueSkyFS *bluesky_new_fs(gchar *name)
82 {
83     BlueSkyFS *fs = g_new0(BlueSkyFS, 1);
84     fs->lock = g_mutex_new();
85     fs->name = g_strdup(name);
86     fs->inodes = g_hash_table_new(bluesky_fs_key_hash_func,
87                                   bluesky_fs_key_equal_func);
88     fs->next_inum = BLUESKY_ROOT_INUM + 1;
89     fs->store = bluesky_store_new("file");
90     fs->flushd_lock = g_mutex_new();
91     fs->flushd_cond = g_cond_new();
92     fs->locations = g_hash_table_new(bluesky_cloudlog_hash,
93                                      bluesky_cloudlog_equal);
94     fs->inode_map = g_sequence_new(NULL);
95
96     fs->log_state = g_new0(BlueSkyCloudLogState, 1);
97     fs->log_state->data = g_string_new("");
98     fs->log_state->latest_cleaner_seq_seen = -1;
99     fs->log_state->uploads_pending_lock = g_mutex_new();
100     fs->log_state->uploads_pending_cond = g_cond_new();
101
102     bluesky_cloudlog_threads_init(fs);
103     fs->inode_fetch_thread_pool = g_thread_pool_new(inode_fetch_task, NULL,
104                                                     bluesky_max_threads,
105                                                     FALSE, NULL);
106
107     return fs;
108 }
109
110 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store,
111                            const gchar *master_key)
112 {
113     BlueSkyFS *fs = bluesky_new_fs(name);
114     fs->master_key = g_strdup(master_key);
115     fs->keys = g_new(BlueSkyCryptKeys, 1);
116     bluesky_crypt_derive_keys(fs->keys, master_key);
117     fs->store = store;
118     fs->log = bluesky_log_new("journal");
119     fs->log->fs = fs;
120
121     if (bluesky_checkpoint_load(fs)) {
122         g_print("Filesystem checkpoint loaded, starting journal replay...\n");
123         bluesky_replay(fs);
124         g_print("Journal replay complete, filesystem ready.\n");
125     } else {
126         /* Initialize a fresh filesystem */
127         g_print("Initializing new filesystem...\n");
128         BlueSkyInode *root = bluesky_new_inode(BLUESKY_ROOT_INUM, fs,
129                                                BLUESKY_DIRECTORY);
130         root->nlink = 1;
131         root->mode = 0755;
132         bluesky_insert_inode(fs, root);
133         bluesky_inode_update_ctime(root, TRUE);
134         bluesky_inode_do_sync(root);
135     }
136
137     bluesky_cleaner_thread_launch(fs);
138
139     return fs;
140 }
141
142 /* Inode reference counting. */
143 void bluesky_inode_ref(BlueSkyInode *inode)
144 {
145     g_atomic_int_inc(&inode->refcount);
146 }
147
148 /* Free most of the resources used by an inode structure, but do not free the
149  * inode itself.  Can be used if the inode data will be reloaded from
150  * serialized form to clear out old information first. */
151 void bluesky_inode_free_resources(BlueSkyInode *inode)
152 {
153     switch (inode->type) {
154     case BLUESKY_REGULAR:
155         if (inode->blocks != NULL) {
156             for (int i = 0; i < inode->blocks->len; i++) {
157                 BlueSkyBlock *b = &g_array_index(inode->blocks,
158                                                  BlueSkyBlock, i);
159                 if (b->type == BLUESKY_BLOCK_DIRTY) {
160                     g_error("Deleting an inode with dirty file data!");
161                 }
162                 bluesky_cloudlog_unref(b->ref);
163                 bluesky_string_unref(b->dirty);
164             }
165             g_array_unref(inode->blocks);
166             inode->blocks = NULL;
167         }
168         break;
169
170     case BLUESKY_DIRECTORY:
171         if (inode->dirhash != NULL)
172             g_hash_table_destroy(inode->dirhash);
173         inode->dirhash = NULL;
174         if (inode->dirhash_folded != NULL)
175             g_hash_table_destroy(inode->dirhash_folded);
176         inode->dirhash_folded = NULL;
177         if (inode->dirents != NULL)
178             g_sequence_free(inode->dirents);
179         inode->dirents = NULL;
180         break;
181
182     case BLUESKY_SYMLINK:
183         g_free(inode->symlink_contents);
184         inode->symlink_contents = NULL;
185         break;
186
187     default:
188         break;
189     }
190 }
191
192 void bluesky_inode_unref(BlueSkyInode *inode)
193 {
194     if (g_atomic_int_dec_and_test(&inode->refcount)) {
195         if (bluesky_verbose) {
196             g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
197                   "Reference count for inode %"PRIu64" dropped to zero.",
198                   inode->inum);
199         }
200
201         /* Sanity check: Is the inode clean? */
202         if (inode->change_commit < inode->change_count
203                 || inode->accessed_list != NULL
204                 || inode->unlogged_list != NULL
205                 || inode->dirty_list != NULL) {
206             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);
207         }
208
209         /* These shouldn't be needed, but in case the above warning fires and
210          * we delete the inode anyway, we ought to be sure the inode is not on
211          * any LRU list. */
212         g_mutex_lock(inode->fs->lock);
213         bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
214         bluesky_list_unlink(&inode->fs->dirty_list, inode->dirty_list);
215         bluesky_list_unlink(&inode->fs->unlogged_list, inode->unlogged_list);
216         g_mutex_unlock(inode->fs->lock);
217
218         bluesky_inode_free_resources(inode);
219
220         g_mutex_free(inode->lock);
221         g_free(inode);
222     }
223 }
224
225 /* Allocate a fresh inode number which has not been used before within a
226  * filesystem.  fs must already be locked. */
227 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs)
228 {
229     uint64_t inum;
230
231     inum = fs->next_inum;
232     fs->next_inum++;
233
234     return inum;
235 }
236
237 /* Perform type-specification initialization of an inode.  Normally performed
238  * in bluesky_new_inode, but can be separated if an inode is created first,
239  * then deserialized. */
240 void bluesky_init_inode(BlueSkyInode *i, BlueSkyFileType type)
241 {
242     i->type = type;
243
244     switch (type) {
245     case BLUESKY_REGULAR:
246         i->blocks = g_array_new(FALSE, TRUE, sizeof(BlueSkyBlock));
247         break;
248     case BLUESKY_DIRECTORY:
249         i->dirents = g_sequence_new(bluesky_dirent_destroy);
250         i->dirhash = g_hash_table_new(g_str_hash, g_str_equal);
251         i->dirhash_folded = g_hash_table_new(g_str_hash, g_str_equal);
252         break;
253     default:
254         break;
255     }
256 }
257
258 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs,
259                                 BlueSkyFileType type)
260 {
261     BlueSkyInode *i = g_new0(BlueSkyInode, 1);
262
263     i->lock = g_mutex_new();
264     i->refcount = 1;
265     i->fs = fs;
266     i->inum = inum;
267     i->change_count = 1;
268     bluesky_init_inode(i, type);
269
270     return i;
271 }
272
273 /* Issue a prefetch hint for an inode.  This signals that the inode may be
274  * needed soon.  Does not return any useful data. */
275 void bluesky_inode_prefetch(BlueSkyFS *fs, uint64_t inum)
276 {
277     BlueSkyInode *inode = NULL;
278
279     g_mutex_lock(fs->lock);
280     inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
281
282     if (inode != NULL) {
283         /* Inode is already available, no need for any prefetching... */
284         g_mutex_unlock(fs->lock);
285         return;
286     }
287
288     InodeMapEntry *entry = bluesky_inode_map_lookup(fs->inode_map, inum, 0);
289     if (entry != NULL) {
290         bluesky_cloudlog_prefetch(entry->item);
291     }
292
293     g_mutex_unlock(fs->lock);
294     return;
295 }
296
297 /* Retrieve an inode from the filesystem.  Eventually this will be a cache and
298  * so we might need to go fetch the inode from elsewhere; for now all
299  * filesystem state is stored here.  inode is returned with a reference held
300  * but not locked. */
301 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum)
302 {
303     BlueSkyInode *inode = NULL;
304
305     if (inum == 0) {
306         return NULL;
307     }
308
309     g_mutex_lock(fs->lock);
310     inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
311
312     if (inode == NULL) {
313         bluesky_inode_fetch(fs, inum);
314         inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
315     }
316
317     if (inode != NULL) {
318         bluesky_inode_ref(inode);
319
320         /* FIXME: We assume we can atomically update the in-memory access time
321          * without a lock. */
322         inode->access_time = bluesky_get_current_time();
323     }
324
325     g_mutex_unlock(fs->lock);
326
327     return inode;
328 }
329
330 /* Insert an inode into the filesystem inode cache.  fs should be locked. */
331 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode)
332 {
333     g_hash_table_insert(fs->inodes, &inode->inum, inode);
334 }
335
336 /* Start writeback of an inode and all associated data. */
337 void bluesky_inode_start_sync(BlueSkyInode *inode)
338 {
339     GList *log_items = NULL;
340
341     if (inode->type == BLUESKY_REGULAR)
342         bluesky_file_flush(inode, &log_items);
343
344     BlueSkyCloudLog *cloudlog = bluesky_serialize_inode(inode);
345
346     bluesky_cloudlog_unref(inode->committed_item);
347     inode->committed_item = cloudlog;
348
349     bluesky_cloudlog_sync(cloudlog);
350     bluesky_cloudlog_ref(cloudlog);
351     log_items = g_list_prepend(log_items, cloudlog);
352
353     /* Wait for all log items to be committed to disk. */
354     bluesky_log_finish_all(log_items);
355
356     /* Mark the inode as clean */
357     inode->change_commit = inode->change_count;
358     inode->change_time = 0;
359     g_mutex_lock(inode->fs->lock);
360     bluesky_list_unlink(&inode->fs->unlogged_list, inode->unlogged_list);
361     inode->unlogged_list = NULL;
362
363     /* Since a new version of the inode has been written to the log, also
364      * schedule a future flush of the new data to cloud storage. */
365     bluesky_list_unlink(&inode->fs->dirty_list, inode->dirty_list);
366     inode->dirty_list = bluesky_list_prepend(&inode->fs->dirty_list, inode);
367     inode->change_cloud = inode->change_count;
368
369     g_mutex_unlock(inode->fs->lock);
370 }
371
372 /* Write back an inode and all associated data and wait for completion.  Inode
373  * should already be locked. */
374 void bluesky_inode_do_sync(BlueSkyInode *inode)
375 {
376     if (bluesky_verbose) {
377         g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
378             "Synchronous writeback for inode %"PRIu64"...", inode->inum);
379     }
380     bluesky_inode_start_sync(inode);
381     if (bluesky_verbose) {
382         g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
383               "Writeback for inode %"PRIu64" complete", inode->inum);
384     }
385 }
386
387 static void inode_fetch_task(gpointer a, gpointer b)
388 {
389     BlueSkyInode *inode = (BlueSkyInode *)a;
390
391     bluesky_profile_set((BlueSkyProfile *)inode->private_data);
392
393     BlueSkyCloudLog *item = inode->committed_item;
394     inode->committed_item = NULL;
395     g_print("Completing fetch of inode %"PRIu64"...\n", inode->inum);
396
397     g_mutex_lock(item->lock);
398     bluesky_cloudlog_fetch(item);
399     if (!bluesky_deserialize_inode(inode, item))
400         g_print("Error deserializing inode %"PRIu64"\n", inode->inum);
401     g_mutex_unlock(item->lock);
402
403     inode->access_time = bluesky_get_current_time();
404     g_mutex_lock(inode->fs->lock);
405     bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
406     inode->accessed_list = bluesky_list_prepend(&inode->fs->accessed_list, inode);
407     g_mutex_unlock(inode->fs->lock);
408
409     g_mutex_unlock(inode->lock);
410     bluesky_cloudlog_unref(item);
411     bluesky_inode_unref(inode);
412 }
413
414 /* Fetch an inode from stable storage.  The fetch can be performed
415  * asynchronously: the in-memory inode is allocated, but not filled with data
416  * immediately.  It is kept locked until it has been filled in, so any users
417  * should try to acquire the lock on the inode before accessing any data.  The
418  * fs lock must be held. */
419 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum)
420 {
421     InodeMapEntry *entry = bluesky_inode_map_lookup(fs->inode_map, inum, 0);
422     if (entry == NULL)
423         return;
424
425     /* Non-portable behavior: We take the inode lock here, and release it in
426      * the fetching thread.  This works with the default Linux pthreads
427      * implementation but is not guaranteed. */
428
429     BlueSkyInode *inode = bluesky_new_inode(inum, fs, BLUESKY_PENDING);
430     inode->change_count = 0;
431     bluesky_inode_ref(inode);       // Extra ref held by fetching process
432     g_mutex_lock(inode->lock);
433
434     inode->committed_item = entry->item;
435     bluesky_cloudlog_ref(entry->item);
436     bluesky_insert_inode(fs, inode);
437
438     inode->private_data = bluesky_profile_get();
439     g_thread_pool_push(fs->inode_fetch_thread_pool, inode, NULL);
440 }