bf7d22eb384a3526ec306d56f6949db721e1046e
[bluesky.git] / bluesky / cloudlog.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 <glib.h>
12 #include <string.h>
13
14 #include "bluesky-private.h"
15
16 // Rough size limit for a log segment.  This is not a firm limit and there are
17 // no absolute guarantees on the size of a log segment.
18 #define CLOUDLOG_SEGMENT_SIZE (4 << 20)
19
20 BlueSkyCloudID bluesky_cloudlog_new_id()
21 {
22     BlueSkyCloudID id;
23     bluesky_crypt_random_bytes((uint8_t *)&id.bytes, sizeof(id));
24     return id;
25 }
26
27 gchar *bluesky_cloudlog_id_to_string(BlueSkyCloudID id)
28 {
29     char buf[sizeof(BlueSkyCloudID) * 2 + 1];
30     buf[0] = '\0';
31
32     for (int i = 0; i < sizeof(BlueSkyCloudID); i++) {
33         sprintf(&buf[2*i], "%02x", (uint8_t)(id.bytes[i]));
34     }
35
36     return g_strdup(buf);
37 }
38
39 BlueSkyCloudID bluesky_cloudlog_id_from_string(const gchar *idstr)
40 {
41     BlueSkyCloudID id;
42     memset(&id, 0, sizeof(id));
43     for (int i = 0; i < 2*sizeof(BlueSkyCloudID); i++) {
44         char c = idstr[i];
45         if (c == '\0') {
46             g_warning("Short cloud id: %s\n", idstr);
47             break;
48         }
49         int val = 0;
50         if (c >= '0' && c <= '9')
51             val = c - '0';
52         else if (c >= 'a' && c <= 'f')
53             val = c - 'a' + 10;
54         else
55             g_warning("Bad character in cloud id: %s\n", idstr);
56         id.bytes[i / 2] += val << (i % 2 ? 0 : 4);
57     }
58     return id;
59 }
60
61 gboolean bluesky_cloudlog_equal(gconstpointer a, gconstpointer b)
62 {
63     BlueSkyCloudID *id1 = (BlueSkyCloudID *)a, *id2 = (BlueSkyCloudID *)b;
64
65     return memcmp(id1, id2, sizeof(BlueSkyCloudID)) == 0;
66 }
67
68 guint bluesky_cloudlog_hash(gconstpointer a)
69 {
70     BlueSkyCloudID *id = (BlueSkyCloudID *)a;
71
72     // Assume that bits in the ID are randomly chosen so that any subset of the
73     // bits can be used as a hash key.
74     return *(guint *)(&id->bytes);
75 }
76
77 /* Formatting of cloud log segments.  This handles grouping items together
78  * before writing a batch to the cloud, handling indirection through items like
79  * the inode map, etc. */
80
81 BlueSkyCloudLog *bluesky_cloudlog_new(BlueSkyFS *fs, const BlueSkyCloudID *id)
82 {
83     BlueSkyCloudLog *log = g_new0(BlueSkyCloudLog, 1);
84
85     log->lock = g_mutex_new();
86     log->cond = g_cond_new();
87     log->fs = fs;
88     log->type = LOGTYPE_UNKNOWN;
89     if (id != NULL)
90         memcpy(&log->id, id, sizeof(BlueSkyCloudID));
91     else
92         log->id = bluesky_cloudlog_new_id();
93     log->links = g_array_new(FALSE, TRUE, sizeof(BlueSkyCloudLog *));
94     g_atomic_int_set(&log->refcount, 1);
95
96     return log;
97 }
98
99 /* Helper function for updating memory usage statistics for a filesystem (the
100  * cache_log_* variables).  This will increment (type=1) or decrement (type=-1)
101  * the counter associated with the current state of the cloud log item.  The
102  * item should be locked or otherwise protected from concurrent access. */
103 void bluesky_cloudlog_stats_update(BlueSkyCloudLog *log, int type)
104 {
105     BlueSkyFS *fs = log->fs;
106
107     if (log->location_flags & CLOUDLOG_CLOUD) {
108         g_atomic_int_add(&fs->cache_log_cloud, type);
109     } else if (log->location_flags & CLOUDLOG_JOURNAL) {
110         g_atomic_int_add(&fs->cache_log_journal, type);
111     } else if (log->pending_write & CLOUDLOG_JOURNAL) {
112         g_atomic_int_add(&fs->cache_log_journal, type);
113     } else if (log->data != NULL) {
114         g_atomic_int_add(&fs->cache_log_dirty, type);
115     }
116 }
117
118 /* The reference held by the hash table does not count towards the reference
119  * count.  When a new object is created, it initially has a reference count of
120  * 1 for the creator, and similarly fetching an item from the hash table will
121  * also create a reference.  If the reference count drops to zero,
122  * bluesky_cloudlog_unref attempts to remove the object from the hash
123  * table--but there is a potential race since another thread might read the
124  * object from the hash table at the same time.  So an object with a reference
125  * count of zero may still be resurrected, in which case we need to abort the
126  * destruction.  Once the object is gone from the hash table, and if the
127  * reference count is still zero, it can actually be deleted. */
128 void bluesky_cloudlog_ref(BlueSkyCloudLog *log)
129 {
130     if (log == NULL)
131         return;
132
133     g_atomic_int_inc(&log->refcount);
134 }
135
136 void bluesky_cloudlog_unref(BlueSkyCloudLog *log)
137 {
138     if (log == NULL)
139         return;
140
141     if (g_atomic_int_dec_and_test(&log->refcount)) {
142         BlueSkyFS *fs = log->fs;
143
144         g_mutex_lock(fs->lock);
145         if (g_atomic_int_get(&log->refcount) > 0) {
146             g_mutex_unlock(fs->lock);
147             return;
148         }
149
150         g_hash_table_remove(fs->locations, &log->id);
151         g_mutex_unlock(fs->lock);
152
153         bluesky_cloudlog_stats_update(log, -1);
154         log->type = LOGTYPE_INVALID;
155         g_mutex_free(log->lock);
156         g_cond_free(log->cond);
157         for (int i = 0; i < log->links->len; i++) {
158             BlueSkyCloudLog *c = g_array_index(log->links,
159                                                BlueSkyCloudLog *, i);
160             bluesky_cloudlog_unref(c);
161         }
162         g_array_unref(log->links);
163         bluesky_string_unref(log->data);
164         g_free(log);
165     }
166 }
167
168 /* Start a write of the object to the local log. */
169 void bluesky_cloudlog_sync(BlueSkyCloudLog *log)
170 {
171     bluesky_log_item_submit(log, log->fs->log);
172 }
173
174 /* Add the given entry to the global hash table containing cloud log entries.
175  * Takes ownership of the caller's reference. */
176 void bluesky_cloudlog_insert(BlueSkyCloudLog *log)
177 {
178     g_mutex_lock(log->fs->lock);
179     g_hash_table_insert(log->fs->locations, &log->id, log);
180     g_mutex_unlock(log->fs->lock);
181 }
182
183 struct log_header {
184     char magic[4];
185     uint32_t size;
186     BlueSkyCloudID id;
187     uint32_t pointer_count;
188 } __attribute__((packed));
189
190 struct logref {
191     BlueSkyCloudID id;
192     BlueSkyCloudPointer location;
193 } __attribute__((packed));
194
195 struct log_footer {
196     char refmagic[4];
197     struct logref refs[0];
198 };
199
200 /* Ensure that a cloud log item is loaded in memory, and if not read it in.
201  * TODO: Make asynchronous, and make this also fetch from the cloud.  Right now
202  * we only read from the log.  Log item must be locked. */
203 void bluesky_cloudlog_fetch(BlueSkyCloudLog *log)
204 {
205     if (log->data != NULL)
206         return;
207
208     if ((log->location_flags | log->pending_write) & CLOUDLOG_JOURNAL) {
209         bluesky_cloudlog_stats_update(log, -1);
210         log->data = bluesky_log_map_object(log->fs, -1, log->log_seq,
211                                            log->log_offset, log->log_size);
212         bluesky_cloudlog_stats_update(log, 1);
213     }
214
215     if (log->data == NULL && (log->location_flags & CLOUDLOG_CLOUD)) {
216         log->location_flags &= ~CLOUDLOG_JOURNAL;
217         bluesky_cloudlog_stats_update(log, -1);
218         log->data = bluesky_log_map_object(log->fs, log->location.directory,
219                                            log->location.sequence,
220                                            log->location.offset,
221                                            log->location.size);
222         bluesky_cloudlog_stats_update(log, 1);
223     }
224
225     if (log->data == NULL) {
226         g_error("Unable to fetch cloudlog entry!");
227     }
228
229     g_cond_broadcast(log->cond);
230 }
231
232 BlueSkyCloudPointer bluesky_cloudlog_serialize(BlueSkyCloudLog *log,
233                                                BlueSkyFS *fs)
234 {
235     BlueSkyCloudLogState *state = fs->log_state;
236
237     if ((log->location_flags | log->pending_write) & CLOUDLOG_CLOUD) {
238         return log->location;
239     }
240
241     for (int i = 0; i < log->links->len; i++) {
242         BlueSkyCloudLog *ref = g_array_index(log->links,
243                                              BlueSkyCloudLog *, i);
244         if (ref != NULL)
245             bluesky_cloudlog_serialize(ref, fs);
246     }
247
248     g_mutex_lock(log->lock);
249     bluesky_cloudlog_fetch(log);
250     g_assert(log->data != NULL);
251
252     bluesky_cloudlog_stats_update(log, -1);
253
254     /* TODO: Right now offset/size are set to the raw data, but we should add
255      * header parsing to the code which loads objects back in. */
256     log->location = state->location;
257     log->location.offset = state->data->len + sizeof(struct log_header);
258     log->location.size = log->data->len;
259         /* = sizeof(struct log_header) + sizeof(BlueSkyCloudID) * 0
260            + log->data->len; */
261
262     struct log_header header;
263     memcpy(header.magic, "AgI ", 4);
264     header.size = GUINT32_TO_LE(log->location.size);
265     header.id = log->id;
266     header.pointer_count = GUINT32_TO_LE(0);
267
268     g_string_append_len(state->data, (const char *)&header, sizeof(header));
269     g_string_append_len(state->data, log->data->data, log->data->len);
270
271     /* If the object we flushed was an inode, update the inode map. */
272     if (log->type == LOGTYPE_INODE) {
273         g_mutex_lock(fs->lock);
274         InodeMapEntry *entry = bluesky_inode_map_lookup(fs->inode_map,
275                                                         log->inum, 1);
276         entry->id = log->id;
277         entry->location = log->location;
278         g_mutex_unlock(fs->lock);
279     }
280
281     /* TODO: We should mark the objects as committed on the cloud until the
282      * data is flushed and acknowledged. */
283     log->pending_write |= CLOUDLOG_CLOUD;
284     bluesky_cloudlog_stats_update(log, 1);
285     state->writeback_list = g_slist_prepend(state->writeback_list, log);
286     bluesky_cloudlog_ref(log);
287     g_mutex_unlock(log->lock);
288
289     if (state->data->len > CLOUDLOG_SEGMENT_SIZE)
290         bluesky_cloudlog_flush(fs);
291
292     return log->location;
293 }
294
295 static void cloudlog_flush_complete(BlueSkyStoreAsync *async,
296                                     SerializedRecord *record)
297 {
298     g_print("Write of %s to cloud complete, status = %d\n",
299             async->key, async->result);
300
301     g_mutex_lock(record->lock);
302     if (async->result >= 0) {
303         while (record->items != NULL) {
304             BlueSkyCloudLog *item = (BlueSkyCloudLog *)record->items->data;
305             g_mutex_lock(item->lock);
306             bluesky_cloudlog_stats_update(item, -1);
307             item->pending_write &= ~CLOUDLOG_CLOUD;
308             item->location_flags |= CLOUDLOG_CLOUD;
309             bluesky_cloudlog_stats_update(item, 1);
310             g_mutex_unlock(item->lock);
311             bluesky_cloudlog_unref(item);
312
313             record->items = g_slist_delete_link(record->items, record->items);
314         }
315
316         bluesky_string_unref(record->data);
317         record->data = NULL;
318         g_slist_free(record->items);
319         record->items = NULL;
320         record->complete = TRUE;
321         g_cond_broadcast(record->cond);
322     } else {
323         g_print("Write should be resubmitted...\n");
324
325         BlueSkyStoreAsync *async2 = bluesky_store_async_new(async->store);
326         async2->op = STORE_OP_PUT;
327         async2->key = g_strdup(async->key);
328         async2->data = record->data;
329         bluesky_string_ref(record->data);
330         bluesky_store_async_submit(async2);
331         bluesky_store_async_add_notifier(async2,
332                                          (GFunc)cloudlog_flush_complete,
333                                          record);
334         bluesky_store_async_unref(async2);
335     }
336     g_mutex_unlock(record->lock);
337 }
338
339 /* Finish up a partially-written cloud log segment and flush it to storage. */
340 void bluesky_cloudlog_flush(BlueSkyFS *fs)
341 {
342     BlueSkyCloudLogState *state = fs->log_state;
343     if (state->data == NULL || state->data->len == 0)
344         return;
345
346     /* TODO: Append some type of commit record to the log segment? */
347
348     g_print("Serializing %zd bytes of data to cloud\n", state->data->len);
349     SerializedRecord *record = g_new0(SerializedRecord, 1);
350     record->data = bluesky_string_new_from_gstring(state->data);
351     record->items = state->writeback_list;
352     record->lock = g_mutex_new();
353     record->cond = g_cond_new();
354     state->writeback_list = NULL;
355
356     BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
357     async->op = STORE_OP_PUT;
358     async->key = g_strdup_printf("log-%08d-%08d",
359                                  state->location.directory,
360                                  state->location.sequence);
361     async->data = record->data;
362     bluesky_string_ref(record->data);
363     bluesky_store_async_submit(async);
364     bluesky_store_async_add_notifier(async,
365                                      (GFunc)cloudlog_flush_complete,
366                                      record);
367     bluesky_store_async_unref(async);
368
369     state->pending_segments = g_list_prepend(state->pending_segments, record);
370
371     state->location.sequence++;
372     state->location.offset = 0;
373     state->data = g_string_new("");
374 }