Do not hold references to all inode data in inode map.
[bluesky.git] / bluesky / cache.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 <stdint.h>
10 #include <glib.h>
11 #include <string.h>
12 #include <inttypes.h>
13
14 #include "bluesky-private.h"
15
16 #define WRITEBACK_DELAY (20 * 1000000)
17 #define CACHE_DROP_DELAY (20 * 1000000)
18
19 /* Filesystem caching and cache coherency.  There are actually a couple of
20  * different tasks that are performed here:
21  *   - Forcing data to the log if needed to reclaim memory or simply if the
22  *     data has been dirty in memory long enough.
23  *   - Writing batches of data to the cloud.
24  */
25
26 static void flushd_dirty_inode(BlueSkyInode *inode)
27 {
28     BlueSkyFS *fs = inode->fs;
29
30     g_mutex_lock(fs->lock);
31     bluesky_list_unlink(&fs->unlogged_list, inode->unlogged_list);
32     inode->unlogged_list = NULL;
33     g_mutex_unlock(fs->lock);
34
35     /* Inode is clean; nothing to do. */
36     if (inode->change_count == inode->change_commit)
37         return;
38
39     if (bluesky_verbose) {
40         g_log("bluesky/flushd", G_LOG_LEVEL_DEBUG,
41             "Starting flush of inode %"PRIu64, inode->inum);
42     }
43
44     bluesky_inode_start_sync(inode);
45 }
46
47 /* Check whether memory usage may have dropped below critical thresholds for
48  * waking up waiting threads. */
49 void flushd_check_wakeup(BlueSkyFS *fs)
50 {
51     int dirty = g_atomic_int_get(&fs->cache_dirty);
52     dirty += g_atomic_int_get(&fs->cache_log_dirty);
53
54     if (dirty <= bluesky_watermark_high_dirty)
55         g_cond_broadcast(fs->flushd_cond);
56 }
57
58 /* Try to flush dirty data to disk, either due to memory pressure or due to
59  * timeouts. */
60 static void flushd_dirty(BlueSkyFS *fs)
61 {
62     int64_t start_time = bluesky_get_current_time();
63     g_mutex_lock(fs->lock);
64
65     while (1) {
66         BlueSkyInode *inode;
67         if (fs->unlogged_list.prev == NULL)
68             break;
69         inode = fs->unlogged_list.prev->data;
70
71         if (bluesky_verbose) {
72             g_log("bluesky/flushd", G_LOG_LEVEL_DEBUG,
73                   "Considering flushing inode %"PRIu64, inode->inum);
74         }
75
76         /* Stop processing dirty inodes if we both have enough memory available
77          * and the oldest inode is sufficiently new that it need not be flushed
78          * out. */
79         uint64_t elapsed = bluesky_get_current_time() - inode->change_time;
80         if (g_atomic_int_get(&fs->cache_dirty) < bluesky_watermark_low_dirty
81                 && elapsed < WRITEBACK_DELAY)
82             break;
83         if (inode->change_time > start_time)
84             break;
85
86         bluesky_inode_ref(inode);
87
88         g_mutex_unlock(fs->lock);
89
90         g_mutex_lock(inode->lock);
91         flushd_dirty_inode(inode);
92         g_mutex_unlock(inode->lock);
93         bluesky_inode_unref(inode);
94
95         g_mutex_lock(fs->lock);
96         flushd_check_wakeup(fs);
97     }
98
99     g_cond_broadcast(fs->flushd_cond);
100
101     g_mutex_unlock(fs->lock);
102 }
103
104 /* Try to flush dirty data to the cloud.  This will take a snapshot of the
105  * entire filesystem (though only point-in-time consistent for isolated inodes
106  * and not the filesystem as a whole) and ensure all data is written to the
107  * cloud.  When the write completes, we will allow old journal segments (those
108  * that were fully written _before_ the snapshot process started) to be garbage
109  * collected.  Newer journal segments can't be collected yet since they may
110  * still contain data which has not been written persistently to the cloud.
111  *
112  * Note that some of this code relies on the fact that only this thread of
113  * control (running flushd_cloud) is manipulating the inode map, and so
114  * concurrent updates to the inode map are prevented even without the
115  * filesystem lock held.  Take great care if allowing multi-threaded access to
116  * the inode map... */
117 static void flushd_cloud(BlueSkyFS *fs)
118 {
119     g_mutex_lock(fs->lock);
120
121     /* TODO: Locking?  Since we're reading a single variable this is probably
122      * atomic but a lock could be safer. */
123     BlueSkyCloudLog *marker = bluesky_log_get_commit_point(fs);
124     int journal_seq_start = fs->log->seq_num;
125
126     while (1) {
127         BlueSkyInode *inode;
128         if (fs->dirty_list.prev == NULL)
129             break;
130         inode = fs->dirty_list.prev->data;
131
132         if (bluesky_verbose) {
133             g_log("bluesky/flushd", G_LOG_LEVEL_DEBUG,
134                   "Flushing inode %"PRIu64" to cloud", inode->inum);
135         }
136
137         bluesky_inode_ref(inode);
138
139         g_mutex_unlock(fs->lock);
140
141         g_mutex_lock(inode->lock);
142         g_assert(inode->change_cloud == inode->change_commit);
143         g_mutex_lock(fs->lock);
144         bluesky_list_unlink(&fs->dirty_list, inode->dirty_list);
145         inode->dirty_list = NULL;
146         g_mutex_unlock(fs->lock);
147
148         BlueSkyCloudLog *log = inode->committed_item;
149         inode->committed_item = NULL;
150         g_mutex_unlock(inode->lock);
151
152         if (log != NULL)
153             bluesky_cloudlog_serialize(log, fs);
154         bluesky_inode_unref(inode);
155         bluesky_cloudlog_unref(log);
156
157         g_mutex_lock(fs->lock);
158     }
159     g_mutex_unlock(fs->lock);
160
161     /* Write out any updated inode map entries, so that all inodes just written
162      * can be located, and then a final commit record. */
163     BlueSkyCloudLog *commit_record = bluesky_inode_map_serialize(fs);
164     if (commit_record != NULL) {
165         bluesky_cloudlog_serialize(commit_record, fs);
166     } else {
167         g_print("No need for a checkpoint record...\n");
168     }
169
170     bluesky_cloudlog_flush(fs);
171
172     /* Wait until all segments have been written to the cloud, so that it
173      * becomes safe to free up journal segments. */
174     while (fs->log_state->pending_segments != NULL) {
175         SerializedRecord *segment
176             = (SerializedRecord *)fs->log_state->pending_segments->data;
177         g_mutex_lock(segment->lock);
178         while (!segment->complete)
179             g_cond_wait(segment->cond, segment->lock);
180         g_mutex_unlock(segment->lock);
181
182         g_mutex_free(segment->lock);
183         g_cond_free(segment->cond);
184         g_free(segment);
185
186         fs->log_state->pending_segments
187             = g_list_delete_link(fs->log_state->pending_segments,
188                                  fs->log_state->pending_segments);
189     }
190
191     bluesky_log_write_commit_point(fs, marker);
192     bluesky_cloudlog_unref(commit_record);
193
194     g_print("All segments have been flushed, journal < %d is clean\n",
195             journal_seq_start);
196
197     fs->log->journal_watermark = journal_seq_start;
198 }
199
200 /* Drop cached data for a given inode, if it is clean.  inode must be locked. */
201 static void drop_caches(BlueSkyInode *inode)
202 {
203     if (inode->type == BLUESKY_REGULAR)
204         bluesky_file_drop_cached(inode);
205
206     BlueSkyCloudLog *log = inode->committed_item;
207     if (log != NULL) {
208         g_mutex_lock(log->lock);
209         if (log->data != NULL
210             && g_atomic_int_get(&log->data_lock_count) == 0
211             && (log->location_flags != 0))
212         {
213             bluesky_cloudlog_stats_update(log, -1);
214             bluesky_string_unref(log->data);
215             log->data = NULL;
216             bluesky_cloudlog_stats_update(log, 1);
217         }
218         if (log->location_flags & CLOUDLOG_CLOUD) {
219             log->location_flags &= ~CLOUDLOG_JOURNAL;
220         }
221         g_mutex_unlock(log->lock);
222     }
223 }
224
225 /* Drop clean data from the cache if needed.  Clean data should generally be
226  * memory-mapped from log file or similar, so the kernel can drop this clean
227  * data from memory for us and hence memory management isn't too important.
228  * Mainly, we'll want to drop references to data that hasn't been accessed in a
229  * while so that it is possible to reclaim log segments on disk. */
230 static void flushd_clean(BlueSkyFS *fs)
231 {
232     g_mutex_lock(fs->lock);
233
234     size_t inode_count = g_hash_table_size(fs->inodes);
235     if (!inode_count)
236         inode_count = 1;
237
238     while (inode_count-- > 0) {
239         BlueSkyInode *inode;
240         if (fs->accessed_list.prev == NULL)
241             break;
242         inode = fs->accessed_list.prev->data;
243
244         uint64_t elapsed = bluesky_get_current_time() - inode->access_time;
245         if (elapsed < CACHE_DROP_DELAY)
246             break;
247
248         if (bluesky_verbose) {
249             g_log("bluesky/flushd", G_LOG_LEVEL_DEBUG,
250                   "Considering dropping cached data for inode %"PRIu64,
251                   inode->inum);
252         }
253
254         bluesky_inode_ref(inode);
255
256         g_mutex_unlock(fs->lock);
257
258         g_mutex_lock(inode->lock);
259
260         g_mutex_lock(fs->lock);
261         bluesky_list_unlink(&fs->accessed_list, inode->accessed_list);
262         inode->accessed_list = bluesky_list_prepend(&fs->accessed_list, inode);
263         g_mutex_unlock(fs->lock);
264
265         drop_caches(inode);
266
267         g_mutex_unlock(inode->lock);
268         bluesky_inode_unref(inode);
269
270         g_mutex_lock(fs->lock);
271     }
272
273     g_mutex_unlock(fs->lock);
274 }
275
276 /* Run the flush daemon for a single iteration, though if it is already
277  * executing returns immediately. */
278 static gpointer flushd_task(BlueSkyFS *fs)
279 {
280     if (!g_mutex_trylock(fs->flushd_lock))
281         return NULL;
282     flushd_dirty(fs);
283     flushd_cloud(fs);
284     flushd_clean(fs);
285     bluesky_cachefile_gc(fs);
286     g_mutex_unlock(fs->flushd_lock);
287
288     return NULL;
289 }
290
291 void bluesky_flushd_invoke(BlueSkyFS *fs)
292 {
293     g_thread_create((GThreadFunc)flushd_task, fs, FALSE, NULL);
294 }
295
296 void bluesky_flushd_invoke_conditional(BlueSkyFS *fs)
297 {
298     if (g_atomic_int_get(&fs->cache_dirty) < bluesky_watermark_medium_dirty)
299         return;
300
301     if (bluesky_verbose) {
302         g_log("bluesky/flushd", G_LOG_LEVEL_DEBUG,
303               "Too much data; invoking flushd: dirty=%d",
304               g_atomic_int_get(&fs->cache_dirty));
305     }
306
307     bluesky_flushd_invoke(fs);
308
309     /* If the system is under heavy memory pressure, actually delay execution
310      * so the flush daemon can catch up. */
311     while (g_atomic_int_get(&fs->cache_dirty)
312                 + g_atomic_int_get(&fs->cache_log_dirty)
313            > bluesky_watermark_high_dirty) {
314         g_log("bluesky/flushd", G_LOG_LEVEL_DEBUG,
315               "Waiting due to memory pressure, dirty=%d + %d",
316               g_atomic_int_get(&fs->cache_dirty),
317               g_atomic_int_get(&fs->cache_log_dirty));
318         g_mutex_lock(fs->lock);
319         g_cond_wait(fs->flushd_cond, fs->lock);
320         g_mutex_unlock(fs->lock);
321     }
322 }
323
324 /* Start a perpetually-running thread that flushes the cache occasionally. */
325 static gpointer flushd_thread(BlueSkyFS *fs)
326 {
327     while (TRUE) {
328         bluesky_flushd_invoke(fs);
329         struct timespec delay;
330         delay.tv_sec = 2;
331         delay.tv_nsec = 0;
332         nanosleep(&delay, NULL);
333     }
334
335     return NULL;
336 }
337
338 void bluesky_flushd_thread_launch(BlueSkyFS *fs)
339 {
340     g_thread_create((GThreadFunc)flushd_thread, fs, FALSE, NULL);
341 }