Check in some SPECsfs runs for CIFS.
[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
100     bluesky_cloudlog_threads_init(fs);
101     fs->inode_fetch_thread_pool = g_thread_pool_new(inode_fetch_task, NULL,
102                                                     bluesky_max_threads,
103                                                     FALSE, NULL);
104
105     return fs;
106 }
107
108 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store,
109                            const gchar *master_key)
110 {
111     BlueSkyFS *fs = bluesky_new_fs(name);
112     fs->master_key = g_strdup(master_key);
113     fs->keys = g_new(BlueSkyCryptKeys, 1);
114     bluesky_crypt_derive_keys(fs->keys, master_key);
115     fs->store = store;
116     fs->log = bluesky_log_new("journal");
117     fs->log->fs = fs;
118
119     if (bluesky_checkpoint_load(fs)) {
120         g_print("Filesystem checkpoint loaded, starting journal replay...\n");
121         bluesky_replay(fs);
122         g_print("Journal replay complete, filesystem ready.\n");
123     } else {
124         /* Initialize a fresh filesystem */
125         g_print("Initializing new filesystem...\n");
126         BlueSkyInode *root = bluesky_new_inode(BLUESKY_ROOT_INUM, fs,
127                                                BLUESKY_DIRECTORY);
128         root->nlink = 1;
129         root->mode = 0755;
130         bluesky_insert_inode(fs, root);
131         bluesky_inode_update_ctime(root, TRUE);
132         bluesky_inode_do_sync(root);
133     }
134
135     bluesky_cleaner_thread_launch(fs);
136
137     return fs;
138 }
139
140 /* Inode reference counting. */
141 void bluesky_inode_ref(BlueSkyInode *inode)
142 {
143     g_atomic_int_inc(&inode->refcount);
144 }
145
146 /* Free most of the resources used by an inode structure, but do not free the
147  * inode itself.  Can be used if the inode data will be reloaded from
148  * serialized form to clear out old information first. */
149 void bluesky_inode_free_resources(BlueSkyInode *inode)
150 {
151     switch (inode->type) {
152     case BLUESKY_REGULAR:
153         if (inode->blocks != NULL) {
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                 bluesky_cloudlog_unref(b->ref);
161                 bluesky_string_unref(b->dirty);
162             }
163             g_array_unref(inode->blocks);
164             inode->blocks = NULL;
165         }
166         break;
167
168     case BLUESKY_DIRECTORY:
169         if (inode->dirhash != NULL)
170             g_hash_table_destroy(inode->dirhash);
171         inode->dirhash = NULL;
172         if (inode->dirhash_folded != NULL)
173             g_hash_table_destroy(inode->dirhash_folded);
174         inode->dirhash_folded = NULL;
175         if (inode->dirents != NULL)
176             g_sequence_free(inode->dirents);
177         inode->dirents = NULL;
178         break;
179
180     case BLUESKY_SYMLINK:
181         g_free(inode->symlink_contents);
182         inode->symlink_contents = NULL;
183         break;
184
185     default:
186         break;
187     }
188 }
189
190 void bluesky_inode_unref(BlueSkyInode *inode)
191 {
192     if (g_atomic_int_dec_and_test(&inode->refcount)) {
193         if (bluesky_verbose) {
194             g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
195                   "Reference count for inode %"PRIu64" dropped to zero.",
196                   inode->inum);
197         }
198
199         /* Sanity check: Is the inode clean? */
200         if (inode->change_commit < inode->change_count
201                 || inode->accessed_list != NULL
202                 || inode->unlogged_list != NULL
203                 || inode->dirty_list != NULL) {
204             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         }
206
207         /* These shouldn't be needed, but in case the above warning fires and
208          * we delete the inode anyway, we ought to be sure the inode is not on
209          * any LRU list. */
210         g_mutex_lock(inode->fs->lock);
211         bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
212         bluesky_list_unlink(&inode->fs->dirty_list, inode->dirty_list);
213         bluesky_list_unlink(&inode->fs->unlogged_list, inode->unlogged_list);
214         g_mutex_unlock(inode->fs->lock);
215
216         bluesky_inode_free_resources(inode);
217
218         g_mutex_free(inode->lock);
219         g_free(inode);
220     }
221 }
222
223 /* Allocate a fresh inode number which has not been used before within a
224  * filesystem.  fs must already be locked. */
225 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs)
226 {
227     uint64_t inum;
228
229     inum = fs->next_inum;
230     fs->next_inum++;
231
232     return inum;
233 }
234
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)
239 {
240     i->type = type;
241
242     switch (type) {
243     case BLUESKY_REGULAR:
244         i->blocks = g_array_new(FALSE, TRUE, sizeof(BlueSkyBlock));
245         break;
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);
250         break;
251     default:
252         break;
253     }
254 }
255
256 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs,
257                                 BlueSkyFileType type)
258 {
259     BlueSkyInode *i = g_new0(BlueSkyInode, 1);
260
261     i->lock = g_mutex_new();
262     i->refcount = 1;
263     i->fs = fs;
264     i->inum = inum;
265     i->change_count = 1;
266     bluesky_init_inode(i, type);
267
268     return i;
269 }
270
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
274  * but not locked. */
275 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum)
276 {
277     BlueSkyInode *inode = NULL;
278
279     if (inum == 0) {
280         return NULL;
281     }
282
283     g_mutex_lock(fs->lock);
284     inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
285
286     if (inode == NULL) {
287         bluesky_inode_fetch(fs, inum);
288         inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
289     }
290
291     if (inode != NULL) {
292         bluesky_inode_ref(inode);
293
294         /* FIXME: We assume we can atomically update the in-memory access time
295          * without a lock. */
296         inode->access_time = bluesky_get_current_time();
297     }
298
299     g_mutex_unlock(fs->lock);
300
301     return inode;
302 }
303
304 /* Insert an inode into the filesystem inode cache.  fs should be locked. */
305 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode)
306 {
307     g_hash_table_insert(fs->inodes, &inode->inum, inode);
308 }
309
310 /* Start writeback of an inode and all associated data. */
311 void bluesky_inode_start_sync(BlueSkyInode *inode)
312 {
313     GList *log_items = NULL;
314
315     if (inode->type == BLUESKY_REGULAR)
316         bluesky_file_flush(inode, &log_items);
317
318     BlueSkyCloudLog *cloudlog = bluesky_serialize_inode(inode);
319
320     bluesky_cloudlog_unref(inode->committed_item);
321     inode->committed_item = cloudlog;
322
323     bluesky_cloudlog_sync(cloudlog);
324     bluesky_cloudlog_ref(cloudlog);
325     log_items = g_list_prepend(log_items, cloudlog);
326
327     /* Wait for all log items to be committed to disk. */
328     bluesky_log_finish_all(log_items);
329
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;
336
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;
342
343     g_mutex_unlock(inode->fs->lock);
344 }
345
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)
349 {
350     if (bluesky_verbose) {
351         g_log("bluesky/inode", G_LOG_LEVEL_DEBUG,
352             "Synchronous writeback for inode %"PRIu64"...", inode->inum);
353     }
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);
358     }
359 }
360
361 static void inode_fetch_task(gpointer a, gpointer b)
362 {
363     BlueSkyInode *inode = (BlueSkyInode *)a;
364
365     bluesky_profile_set((BlueSkyProfile *)inode->private_data);
366
367     BlueSkyCloudLog *item = inode->committed_item;
368     inode->committed_item = NULL;
369     g_print("Completing fetch of inode %"PRIu64"...\n", inode->inum);
370
371     g_mutex_lock(item->lock);
372     bluesky_cloudlog_fetch(item);
373     if (!bluesky_deserialize_inode(inode, item))
374         g_print("Error deserializing inode %"PRIu64"\n", inode->inum);
375     g_mutex_unlock(item->lock);
376
377     inode->access_time = bluesky_get_current_time();
378     g_mutex_lock(inode->fs->lock);
379     bluesky_list_unlink(&inode->fs->accessed_list, inode->accessed_list);
380     inode->accessed_list = bluesky_list_prepend(&inode->fs->accessed_list, inode);
381     g_mutex_unlock(inode->fs->lock);
382
383     g_mutex_unlock(inode->lock);
384     bluesky_cloudlog_unref(item);
385     bluesky_inode_unref(inode);
386 }
387
388 /* Fetch an inode from stable storage.  The fetch can be performed
389  * asynchronously: the in-memory inode is allocated, but not filled with data
390  * immediately.  It is kept locked until it has been filled in, so any users
391  * should try to acquire the lock on the inode before accessing any data.  The
392  * fs lock must be held. */
393 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum)
394 {
395     InodeMapEntry *entry = bluesky_inode_map_lookup(fs->inode_map, inum, 0);
396     if (entry == NULL)
397         return;
398
399     /* Non-portable behavior: We take the inode lock here, and release it in
400      * the fetching thread.  This works with the default Linux pthreads
401      * implementation but is not guaranteed. */
402
403     BlueSkyInode *inode = bluesky_new_inode(inum, fs, BLUESKY_PENDING);
404     inode->change_count = 0;
405     bluesky_inode_ref(inode);       // Extra ref held by fetching process
406     g_mutex_lock(inode->lock);
407
408     inode->committed_item = entry->item;
409     bluesky_cloudlog_ref(entry->item);
410     bluesky_insert_inode(fs, inode);
411
412     inode->private_data = bluesky_profile_get();
413     g_thread_pool_push(fs->inode_fetch_thread_pool, inode, NULL);
414 }