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