Add a new option to make caching writethrough instead of writeback.
[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 /* 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
49 /* Unfortunately a glib hash table is only guaranteed to be able to store
50  * 32-bit keys if we use the key directly.  If we want 64-bit inode numbers,
51  * we'll have to allocate memory to store the 64-bit inumber, and use a pointer
52  * to it.  Rather than allocate the memory for the key, we'll just include a
53  * pointer to the 64-bit inum stored in the inode itself, so that we don't need
54  * to do any more memory management.  */
55 static guint bluesky_fs_key_hash_func(gconstpointer key)
56 {
57     uint64_t inum = *(const uint64_t *)key;
58     return (guint)inum;
59 }
60
61 static gboolean bluesky_fs_key_equal_func(gconstpointer a, gconstpointer b)
62 {
63     uint64_t i1 = *(const uint64_t *)a;
64     uint64_t i2 = *(const uint64_t *)b;
65     return i1 == i2;
66 }
67
68 /* Filesystem-level operations.  A filesystem is like a directory tree that we
69  * are willing to export. */
70 BlueSkyFS *bluesky_new_fs(gchar *name)
71 {
72     BlueSkyFS *fs = g_new0(BlueSkyFS, 1);
73     fs->lock = g_mutex_new();
74     fs->name = g_strdup(name);
75     fs->inodes = g_hash_table_new(bluesky_fs_key_hash_func,
76                                   bluesky_fs_key_equal_func);
77     fs->next_inum = BLUESKY_ROOT_INUM + 1;
78     fs->store = bluesky_store_new("file");
79
80     return fs;
81 }
82
83 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store)
84 {
85     BlueSkyRCStr *data = bluesky_store_get(store, "superblock");
86     if (data != NULL) {
87         BlueSkyFS *fs = bluesky_deserialize_superblock(data->data);
88         if (fs != NULL) {
89             fs->store = store;
90             g_print("Loaded filesystem superblock\n");
91             g_free(fs->name);
92             fs->name = g_strdup(name);
93             return fs;
94         }
95     }
96
97     g_print("Initializing fresh filesystem\n");
98     BlueSkyFS *fs = bluesky_new_fs(name);
99     fs->store = store;
100
101     BlueSkyInode *root = bluesky_new_inode(BLUESKY_ROOT_INUM, fs,
102                                            BLUESKY_DIRECTORY);
103     root->nlink = 1;
104     root->mode = 0755;
105     bluesky_insert_inode(fs, root);
106
107     bluesky_inode_flush(fs, root);
108     bluesky_superblock_flush(fs);
109
110     return fs;
111 }
112
113 /* Inode reference counting. */
114 void bluesky_inode_ref(BlueSkyInode *inode)
115 {
116     g_atomic_int_inc(&inode->refcount);
117 }
118
119 void bluesky_inode_unref(BlueSkyInode *inode)
120 {
121     if (g_atomic_int_dec_and_test(&inode->refcount)) {
122         g_error("Reference count for inode %"PRIu64" dropped to zero!\n",
123                 inode->inum);
124     }
125 }
126
127 /* Allocate a fresh inode number which has not been used before within a
128  * filesystem.  fs must already be locked. */
129 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs)
130 {
131     uint64_t inum;
132
133     inum = fs->next_inum;
134     fs->next_inum++;
135
136     bluesky_superblock_flush(fs);
137
138     return inum;
139 }
140
141 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs,
142                                 BlueSkyFileType type)
143 {
144     BlueSkyInode *i = g_new0(BlueSkyInode, 1);
145
146     i->lock = g_mutex_new();
147     i->refcount = 1;
148     i->type = type;
149     i->fs = fs;
150     i->inum = inum;
151
152     switch (type) {
153     case BLUESKY_REGULAR:
154         i->blocks = g_array_new(FALSE, TRUE, sizeof(BlueSkyBlock));
155         break;
156     case BLUESKY_DIRECTORY:
157         i->dirents = g_sequence_new(bluesky_dirent_destroy);
158         i->dirhash = g_hash_table_new(g_str_hash, g_str_equal);
159         i->dirhash_folded = g_hash_table_new(g_str_hash, g_str_equal);
160         break;
161     case BLUESKY_BLOCK:
162     case BLUESKY_CHARACTER:
163     case BLUESKY_SYMLINK:
164     case BLUESKY_SOCKET:
165     case BLUESKY_FIFO:
166         break;
167     }
168
169     return i;
170 }
171
172 /* Retrieve an inode from the filesystem.  Eventually this will be a cache and
173  * so we might need to go fetch the inode from elsewhere; for now all
174  * filesystem state is stored here.  inode is returned locked with a reference
175  * held. */
176 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum)
177 {
178     BlueSkyInode *inode = NULL;
179
180     if (inum == 0) {
181         return NULL;
182     }
183
184     g_mutex_lock(fs->lock);
185     inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
186
187     if (inode == NULL) {
188         bluesky_inode_fetch(fs, inum);
189         inode = (BlueSkyInode *)g_hash_table_lookup(fs->inodes, &inum);
190     }
191
192     if (inode != NULL) {
193         bluesky_inode_ref(inode);
194     }
195
196     g_mutex_unlock(fs->lock);
197
198     return inode;
199 }
200
201 /* Insert an inode into the filesystem inode cache.  fs should be locked. */
202 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode)
203 {
204     g_hash_table_insert(fs->inodes, &inode->inum, inode);
205 }
206
207 /* Deprecated: Synchronize an inode to stable storage. */
208 void bluesky_inode_flush(BlueSkyFS *fs, BlueSkyInode *inode)
209 {
210     GString *buf = g_string_new("");
211     bluesky_serialize_inode(buf, inode);
212     BlueSkyRCStr *data = bluesky_string_new_from_gstring(buf);
213
214     char key[64];
215     sprintf(key, "inode-%016"PRIx64, inode->inum);
216
217     BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
218     async->op = STORE_OP_PUT;
219     async->key = g_strdup(key);
220     async->data = data;
221     bluesky_store_async_submit(async);
222     bluesky_store_async_unref(async);
223 }
224
225 /* Start writeback of an inode and all associated data. */
226 void bluesky_inode_start_sync(BlueSkyInode *inode, BlueSkyStoreAsync *barrier)
227 {
228     BlueSkyFS *fs = inode->fs;
229
230     GString *buf = g_string_new("");
231     bluesky_serialize_inode(buf, inode);
232     BlueSkyRCStr *data = bluesky_string_new_from_gstring(buf);
233
234     if (inode->type == BLUESKY_REGULAR)
235         bluesky_file_flush(inode, barrier);
236
237     char key[64];
238     sprintf(key, "inode-%016"PRIx64, inode->inum);
239
240     BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
241     async->op = STORE_OP_PUT;
242     async->key = g_strdup(key);
243     async->data = data;
244     bluesky_store_async_submit(async);
245     if (barrier != NULL)
246         bluesky_store_add_barrier(barrier, async);
247     bluesky_store_async_unref(async);
248 }
249
250 /* Fetch an inode from stable storage. */
251 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum)
252 {
253     char key[64];
254     sprintf(key, "inode-%016"PRIx64, inum);
255     BlueSkyRCStr *data = bluesky_store_get(fs->store, key);
256     if (data == NULL)
257         return;
258
259     BlueSkyInode *inode = bluesky_deserialize_inode(fs, data->data);
260     if (inode != NULL) {
261         bluesky_insert_inode(fs, inode);
262     }
263 }
264
265 /* Synchronize filesystem superblock to stable storage. */
266 void bluesky_superblock_flush(BlueSkyFS *fs)
267 {
268     GString *buf = g_string_new("");
269     bluesky_serialize_superblock(buf, fs);
270     BlueSkyRCStr *data = bluesky_string_new_from_gstring(buf);
271
272     BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
273     async->op = STORE_OP_PUT;
274     async->key = g_strdup("superblock");
275     async->data = data;
276     bluesky_store_async_submit(async);
277     bluesky_store_async_unref(async);
278
279     bluesky_store_sync(fs->store);
280 }