c4cb1ae398a362ae3e5ca91672264dd4ce5246da
[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 /* Look up the cloud log entry for the given ID.  If create is TRUE and the
184  * item does not exist, create a special pending entry that can later be filled
185  * in when the real item is loaded.  The returned item has a reference held.
186  * As a special case, if a null ID is provided then NULL is returned. */
187 BlueSkyCloudLog *bluesky_cloudlog_get(BlueSkyFS *fs, BlueSkyCloudID id)
188 {
189     static BlueSkyCloudID id0 = {{0}};
190
191     if (memcmp(&id, &id0, sizeof(BlueSkyCloudID)) == 0)
192         return NULL;
193
194     g_mutex_lock(fs->lock);
195     BlueSkyCloudLog *item;
196     item = g_hash_table_lookup(fs->locations, &id);
197     if (item == NULL) {
198         item = bluesky_cloudlog_new(fs, &id);
199         g_hash_table_insert(fs->locations, &id, item);
200     } else {
201         bluesky_cloudlog_ref(item);
202     }
203     g_mutex_unlock(fs->lock);
204     return item;
205 }
206
207 /* Ensure that a cloud log item is loaded in memory, and if not read it in.
208  * TODO: Make asynchronous, and make this also fetch from the cloud.  Right now
209  * we only read from the log.  Log item must be locked. */
210 void bluesky_cloudlog_fetch(BlueSkyCloudLog *log)
211 {
212     if (log->data != NULL)
213         return;
214
215     /* There are actually two cases: a full deserialization if we have not ever
216      * read the object before, and a partial deserialization where the metadata
217      * is already in memory and we just need to remap the data.  If the object
218      * type has not yet been set, we'll need to read and parse the metadata.
219      * Once that is done, we can fall through the case of remapping the data
220      * itself. */
221     if (log->type == LOGTYPE_UNKNOWN) {
222         BlueSkyRCStr *raw = NULL;
223         if ((log->location_flags | log->pending_write) & CLOUDLOG_JOURNAL) {
224             raw = bluesky_log_map_object(log->fs, -1, log->log_seq,
225                                          log->log_offset, log->log_size);
226         }
227
228         if (raw == NULL && (log->location_flags & CLOUDLOG_CLOUD)) {
229             log->location_flags &= ~CLOUDLOG_JOURNAL;
230             raw = bluesky_log_map_object(log->fs,
231                                          log->location.directory,
232                                          log->location.sequence,
233                                          log->location.offset,
234                                          log->location.size);
235         }
236
237         g_assert(raw != NULL);
238         bluesky_deserialize_cloudlog(log, raw->data, raw->len);
239         bluesky_string_unref(raw);
240     }
241
242     /* At this point all metadata should be available and we need only remap
243      * the object data. */
244
245     int offset;
246     if ((log->location_flags | log->pending_write) & CLOUDLOG_JOURNAL) {
247         bluesky_cloudlog_stats_update(log, -1);
248         offset = log->log_offset + sizeof(struct log_header);
249         log->data = bluesky_log_map_object(log->fs, -1, log->log_seq,
250                                            offset, log->data_size);
251         bluesky_cloudlog_stats_update(log, 1);
252     }
253
254     if (log->data == NULL && (log->location_flags & CLOUDLOG_CLOUD)) {
255         log->location_flags &= ~CLOUDLOG_JOURNAL;
256         bluesky_cloudlog_stats_update(log, -1);
257         offset = log->location.offset + sizeof(struct cloudlog_header);
258         log->data = bluesky_log_map_object(log->fs, log->location.directory,
259                                            log->location.sequence,
260                                            offset, log->data_size);
261         bluesky_cloudlog_stats_update(log, 1);
262     }
263
264     if (log->data == NULL) {
265         g_error("Unable to fetch cloudlog entry!");
266     }
267
268     g_cond_broadcast(log->cond);
269 }
270
271 BlueSkyCloudPointer bluesky_cloudlog_serialize(BlueSkyCloudLog *log,
272                                                BlueSkyFS *fs)
273 {
274     BlueSkyCloudLogState *state = fs->log_state;
275
276     if ((log->location_flags | log->pending_write) & CLOUDLOG_CLOUD) {
277         return log->location;
278     }
279
280     for (int i = 0; i < log->links->len; i++) {
281         BlueSkyCloudLog *ref = g_array_index(log->links,
282                                              BlueSkyCloudLog *, i);
283         if (ref != NULL)
284             bluesky_cloudlog_serialize(ref, fs);
285     }
286
287     g_mutex_lock(log->lock);
288     bluesky_cloudlog_fetch(log);
289     g_assert(log->data != NULL);
290
291     bluesky_cloudlog_stats_update(log, -1);
292
293     GString *data1 = g_string_new("");
294     GString *data2 = g_string_new("");
295     GString *data3 = g_string_new("");
296     bluesky_serialize_cloudlog(log, data1, data2, data3);
297
298     log->location = state->location;
299     log->location.offset = state->data->len;
300     log->data_size = data1->len;
301
302     struct cloudlog_header header;
303     memcpy(header.magic, CLOUDLOG_MAGIC, 4);
304     memset(header.crypt_auth, sizeof(header.crypt_auth), 0);
305     memset(header.crypt_iv, sizeof(header.crypt_iv), 0);
306     header.type = log->type + '0';
307     header.size1 = GUINT32_TO_LE(data1->len);
308     header.size2 = GUINT32_TO_LE(data2->len);
309     header.size3 = GUINT32_TO_LE(data3->len);
310     header.id = log->id;
311     header.inum = GUINT64_TO_LE(log->inum);
312
313     g_string_append_len(state->data, (const char *)&header, sizeof(header));
314     g_string_append_len(state->data, data1->str, data1->len);
315     g_string_append_len(state->data, data2->str, data2->len);
316     g_string_append_len(state->data, data3->str, data3->len);
317
318     log->location.size = state->data->len - log->location.offset;
319
320     /* If the object we flushed was an inode, update the inode map. */
321     if (log->type == LOGTYPE_INODE) {
322         g_mutex_lock(fs->lock);
323         InodeMapEntry *entry = bluesky_inode_map_lookup(fs->inode_map,
324                                                         log->inum, 1);
325         entry->id = log->id;
326         entry->location = log->location;
327         entry->item = log;
328         bluesky_cloudlog_ref(entry->item);
329         g_mutex_unlock(fs->lock);
330     }
331
332     /* TODO: We should mark the objects as committed on the cloud until the
333      * data is flushed and acknowledged. */
334     log->pending_write |= CLOUDLOG_CLOUD;
335     bluesky_cloudlog_stats_update(log, 1);
336     state->writeback_list = g_slist_prepend(state->writeback_list, log);
337     bluesky_cloudlog_ref(log);
338     g_mutex_unlock(log->lock);
339
340     if (state->data->len > CLOUDLOG_SEGMENT_SIZE)
341         bluesky_cloudlog_flush(fs);
342
343     return log->location;
344 }
345
346 static void cloudlog_flush_complete(BlueSkyStoreAsync *async,
347                                     SerializedRecord *record)
348 {
349     g_print("Write of %s to cloud complete, status = %d\n",
350             async->key, async->result);
351
352     g_mutex_lock(record->lock);
353     if (async->result >= 0) {
354         while (record->items != NULL) {
355             BlueSkyCloudLog *item = (BlueSkyCloudLog *)record->items->data;
356             g_mutex_lock(item->lock);
357             bluesky_cloudlog_stats_update(item, -1);
358             item->pending_write &= ~CLOUDLOG_CLOUD;
359             item->location_flags |= CLOUDLOG_CLOUD;
360             bluesky_cloudlog_stats_update(item, 1);
361             g_mutex_unlock(item->lock);
362             bluesky_cloudlog_unref(item);
363
364             record->items = g_slist_delete_link(record->items, record->items);
365         }
366
367         bluesky_string_unref(record->data);
368         record->data = NULL;
369         g_slist_free(record->items);
370         record->items = NULL;
371         record->complete = TRUE;
372         g_cond_broadcast(record->cond);
373     } else {
374         g_print("Write should be resubmitted...\n");
375
376         BlueSkyStoreAsync *async2 = bluesky_store_async_new(async->store);
377         async2->op = STORE_OP_PUT;
378         async2->key = g_strdup(async->key);
379         async2->data = record->data;
380         bluesky_string_ref(record->data);
381         bluesky_store_async_submit(async2);
382         bluesky_store_async_add_notifier(async2,
383                                          (GFunc)cloudlog_flush_complete,
384                                          record);
385         bluesky_store_async_unref(async2);
386     }
387     g_mutex_unlock(record->lock);
388 }
389
390 /* Finish up a partially-written cloud log segment and flush it to storage. */
391 void bluesky_cloudlog_flush(BlueSkyFS *fs)
392 {
393     BlueSkyCloudLogState *state = fs->log_state;
394     if (state->data == NULL || state->data->len == 0)
395         return;
396
397     /* TODO: Append some type of commit record to the log segment? */
398
399     g_print("Serializing %zd bytes of data to cloud\n", state->data->len);
400     SerializedRecord *record = g_new0(SerializedRecord, 1);
401     record->data = bluesky_string_new_from_gstring(state->data);
402     record->items = state->writeback_list;
403     record->lock = g_mutex_new();
404     record->cond = g_cond_new();
405     state->writeback_list = NULL;
406
407     BlueSkyStoreAsync *async = bluesky_store_async_new(fs->store);
408     async->op = STORE_OP_PUT;
409     async->key = g_strdup_printf("log-%08d-%08d",
410                                  state->location.directory,
411                                  state->location.sequence);
412     async->data = record->data;
413     bluesky_string_ref(record->data);
414     bluesky_store_async_submit(async);
415     bluesky_store_async_add_notifier(async,
416                                      (GFunc)cloudlog_flush_complete,
417                                      record);
418     bluesky_store_async_unref(async);
419
420     state->pending_segments = g_list_prepend(state->pending_segments, record);
421
422     state->location.sequence++;
423     state->location.offset = 0;
424     state->data = g_string_new("");
425 }