Implement new scheme for retaining needed journal segments.
[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 static void flushd_cloud(BlueSkyFS *fs)
112 {
113     g_mutex_lock(fs->lock);
114
115     /* TODO: Locking?  Since we're reading a single variable this is probably
116      * atomic but a lock could be safer. */
117     int journal_seq_start = fs->log->seq_num;
118
119     while (1) {
120         BlueSkyInode *inode;
121         if (fs->dirty_list.prev == NULL)
122             break;
123         inode = fs->dirty_list.prev->data;
124
125         if (bluesky_verbose) {
126             g_log("bluesky/flushd", G_LOG_LEVEL_DEBUG,
127                   "Flushing inode %"PRIu64" to cloud", inode->inum);
128         }
129
130         bluesky_inode_ref(inode);
131
132         g_mutex_unlock(fs->lock);
133
134         g_mutex_lock(inode->lock);
135         flushd_dirty_inode(inode);
136         g_mutex_lock(fs->lock);
137         bluesky_list_unlink(&fs->dirty_list, inode->dirty_list);
138         inode->dirty_list = NULL;
139         g_mutex_unlock(fs->lock);
140
141         BlueSkyCloudLog *log = inode->committed_item;
142         bluesky_cloudlog_ref(log);
143         g_mutex_unlock(inode->lock);
144
145         if (log != NULL)
146             bluesky_cloudlog_serialize(log, fs);
147         bluesky_inode_unref(inode);
148         bluesky_cloudlog_unref(log);
149
150         g_mutex_lock(fs->lock);
151     }
152
153     g_mutex_unlock(fs->lock);
154     bluesky_cloudlog_flush(fs);
155
156     /* Wait until all segments have been written to the cloud, so that it
157      * becomes safe to free up journal segments. */
158     while (fs->log_state->pending_segments != NULL) {
159         SerializedRecord *segment
160             = (SerializedRecord *)fs->log_state->pending_segments->data;
161         g_mutex_lock(segment->lock);
162         while (!segment->complete)
163             g_cond_wait(segment->cond, segment->lock);
164         g_mutex_unlock(segment->lock);
165
166         g_mutex_free(segment->lock);
167         g_cond_free(segment->cond);
168         g_free(segment);
169
170         fs->log_state->pending_segments
171             = g_list_delete_link(fs->log_state->pending_segments,
172                                  fs->log_state->pending_segments);
173     }
174
175     g_print("All segments have been flushed, journal < %d is clean\n",
176             journal_seq_start);
177
178     fs->log->journal_watermark = journal_seq_start;
179 }
180
181 /* Drop cached data for a given inode, if it is clean.  inode must be locked. */
182 static void drop_caches(BlueSkyInode *inode)
183 {
184     if (inode->type == BLUESKY_REGULAR)
185         bluesky_file_drop_cached(inode);
186
187     BlueSkyCloudLog *log = inode->committed_item;
188     if (log != NULL) {
189         g_mutex_lock(log->lock);
190         if (log->data != NULL
191             && g_atomic_int_get(&log->data_lock_count) == 0
192             && (log->location_flags != 0))
193         {
194             bluesky_cloudlog_stats_update(log, -1);
195             bluesky_string_unref(log->data);
196             log->data = NULL;
197             bluesky_cloudlog_stats_update(log, 1);
198         }
199         if (log->location_flags & CLOUDLOG_CLOUD) {
200             log->location_flags &= ~CLOUDLOG_JOURNAL;
201         }
202         g_mutex_unlock(log->lock);
203     }
204 }
205
206 /* Drop clean data from the cache if needed.  Clean data should generally be
207  * memory-mapped from log file or similar, so the kernel can drop this clean
208  * data from memory for us and hence memory management isn't too important.
209  * Mainly, we'll want to drop references to data that hasn't been accessed in a
210  * while so that it is possible to reclaim log segments on disk. */
211 static void flushd_clean(BlueSkyFS *fs)
212 {
213     g_mutex_lock(fs->lock);
214
215     size_t inode_count = g_hash_table_size(fs->inodes);
216     if (!inode_count)
217         inode_count = 1;
218
219     while (inode_count-- > 0) {
220         BlueSkyInode *inode;
221         if (fs->accessed_list.prev == NULL)
222             break;
223         inode = fs->accessed_list.prev->data;
224
225         uint64_t elapsed = bluesky_get_current_time() - inode->access_time;
226         if (elapsed < CACHE_DROP_DELAY)
227             break;
228
229         if (bluesky_verbose) {
230             g_log("bluesky/flushd", G_LOG_LEVEL_DEBUG,
231                   "Considering dropping cached data for inode %"PRIu64,
232                   inode->inum);
233         }
234
235         bluesky_inode_ref(inode);
236
237         g_mutex_unlock(fs->lock);
238
239         g_mutex_lock(inode->lock);
240
241         g_mutex_lock(fs->lock);
242         bluesky_list_unlink(&fs->accessed_list, inode->accessed_list);
243         inode->accessed_list = bluesky_list_prepend(&fs->accessed_list, inode);
244         g_mutex_unlock(fs->lock);
245
246         drop_caches(inode);
247
248         g_mutex_unlock(inode->lock);
249         bluesky_inode_unref(inode);
250
251         g_mutex_lock(fs->lock);
252     }
253
254     g_mutex_unlock(fs->lock);
255 }
256
257 /* Run the flush daemon for a single iteration, though if it is already
258  * executing returns immediately. */
259 static gpointer flushd_task(BlueSkyFS *fs)
260 {
261     if (!g_mutex_trylock(fs->flushd_lock))
262         return NULL;
263     flushd_dirty(fs);
264     flushd_cloud(fs);
265     flushd_clean(fs);
266     bluesky_cachefile_gc(fs);
267     g_mutex_unlock(fs->flushd_lock);
268
269     return NULL;
270 }
271
272 void bluesky_flushd_invoke(BlueSkyFS *fs)
273 {
274     g_thread_create((GThreadFunc)flushd_task, fs, FALSE, NULL);
275 }
276
277 void bluesky_flushd_invoke_conditional(BlueSkyFS *fs)
278 {
279     if (g_atomic_int_get(&fs->cache_dirty) < bluesky_watermark_medium_dirty)
280         return;
281
282     if (bluesky_verbose) {
283         g_log("bluesky/flushd", G_LOG_LEVEL_DEBUG,
284               "Too much data; invoking flushd: dirty=%d",
285               g_atomic_int_get(&fs->cache_dirty));
286     }
287
288     bluesky_flushd_invoke(fs);
289
290     /* If the system is under heavy memory pressure, actually delay execution
291      * so the flush daemon can catch up. */
292     while (g_atomic_int_get(&fs->cache_dirty)
293                 + g_atomic_int_get(&fs->cache_log_dirty)
294            > bluesky_watermark_high_dirty) {
295         g_log("bluesky/flushd", G_LOG_LEVEL_DEBUG,
296               "Waiting due to memory pressure, dirty=%d + %d",
297               g_atomic_int_get(&fs->cache_dirty),
298               g_atomic_int_get(&fs->cache_log_dirty));
299         g_mutex_lock(fs->lock);
300         g_cond_wait(fs->flushd_cond, fs->lock);
301         g_mutex_unlock(fs->lock);
302     }
303 }
304
305 /* Start a perpetually-running thread that flushes the cache occasionally. */
306 static gpointer flushd_thread(BlueSkyFS *fs)
307 {
308     while (TRUE) {
309         bluesky_flushd_invoke(fs);
310         struct timespec delay;
311         delay.tv_sec = 2;
312         delay.tv_nsec = 0;
313         nanosleep(&delay, NULL);
314     }
315
316     return NULL;
317 }
318
319 void bluesky_flushd_thread_launch(BlueSkyFS *fs)
320 {
321     g_thread_create((GThreadFunc)flushd_thread, fs, FALSE, NULL);
322 }