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