1 /* Blue Sky: File Systems in the Cloud
3 * Copyright (C) 2009 The Regents of the University of California
4 * Written by Michael Vrable <mvrable@cs.ucsd.edu>
20 /* Various options to tweak for performance benchmarking purposes. */
22 /* Perform all get/put operations synchronously. */
23 int synchronous_stores;
25 /* Write data in cache immediately after file is modified. */
26 int writethrough_cache;
28 /* Can inodes be fetched asynchronously? (Inode object is initially
29 * created in a pending state, and not unlocked until the data is actually
31 int sync_inode_fetches;
33 /* Should frontends handle requests serially or allow operations to proceed
37 /* Target size of the disk cache at the proxy, in kilobytes. */
41 extern BlueSkyOptions bluesky_options;
43 /* Maximum number of threads to use in any particular thread pool, or -1 for no
45 extern int bluesky_max_threads;
47 /* A general-purpose counter for gathering run-time statistics. */
48 struct bluesky_stats {
53 struct bluesky_stats *bluesky_stats_new(const char *name);
54 void bluesky_stats_add(struct bluesky_stats *stats, int64_t value);
55 void bluesky_stats_dump_all();
57 /* BlueSky status and error codes. Various frontends should translate these to
58 * the appropriate error code for whatever protocol they implement. */
60 BSTATUS_OK = 0, /* No error */
61 BSTATUS_IOERR, /* I/O error of some form */
62 BSTATUS_NOENT, /* File does not exist */
65 void bluesky_init(void);
67 gchar *bluesky_lowercase(const gchar *s);
69 struct BlueSkyCacheFile;
70 typedef struct BlueSkyCacheFile BlueSkyCacheFile;
74 BlueSkyCacheFile *mmap;
79 BlueSkyRCStr *bluesky_string_new(gpointer data, gsize len);
80 BlueSkyRCStr *bluesky_string_new_from_gstring(GString *s);
81 BlueSkyRCStr *bluesky_string_new_from_mmap(BlueSkyCacheFile *mmap,
82 int offset, gsize len);
83 void bluesky_string_ref(BlueSkyRCStr *string);
84 void bluesky_string_unref(BlueSkyRCStr *string);
85 BlueSkyRCStr *bluesky_string_dup(BlueSkyRCStr *string);
86 void bluesky_string_resize(BlueSkyRCStr *string, gsize len);
88 struct BlueSkyRangeset;
89 typedef struct BlueSkyRangeset BlueSkyRangeset;
91 uint64_t start, length;
93 } BlueSkyRangesetItem;
95 BlueSkyRangeset *bluesky_rangeset_new();
96 void bluesky_rangeset_free(BlueSkyRangeset *rangeset);
97 gboolean bluesky_rangeset_insert(BlueSkyRangeset *rangeset,
98 uint64_t start, uint64_t length,
100 const BlueSkyRangesetItem *bluesky_rangeset_lookup(BlueSkyRangeset *rangeset,
103 /* Storage interface. This presents a key-value store abstraction, and can
104 * have multiple implementations: in-memory, on-disk, in-cloud. */
106 typedef struct BlueSkyStore BlueSkyStore;
109 typedef struct BlueSkyLog BlueSkyLog;
111 struct BlueSkyCloudLogState;
112 typedef struct BlueSkyCloudLogState BlueSkyCloudLogState;
114 struct BlueSkyCloudLog;
115 typedef struct BlueSkyCloudLog BlueSkyCloudLog;
117 void bluesky_store_init();
118 BlueSkyStore *bluesky_store_new(const gchar *type);
119 void bluesky_store_free(BlueSkyStore *store);
120 BlueSkyRCStr *bluesky_store_get(BlueSkyStore *store, const gchar *key);
121 void bluesky_store_put(BlueSkyStore *store,
122 const gchar *key, BlueSkyRCStr *val);
124 /* File types. The numeric values are chosen to match with those used in
128 BLUESKY_DIRECTORY = 2,
130 BLUESKY_CHARACTER = 4,
135 /* Special types used only internally. */
136 BLUESKY_PENDING = 0, /* Inode being loaded; type not yet determined */
137 BLUESKY_INVALID = -1, /* Inode is invalid (failed to load) */
140 /* Filesystem state. Each filesystem which is exported is represented by a
141 * single bluesky_fs structure in memory. */
142 struct BlueSkyCryptKeys;
147 gchar *name; /* Descriptive name for the filesystem */
148 GHashTable *inodes; /* Cached inodes */
149 uint64_t next_inum; /* Next available inode for allocation */
153 BlueSkyCloudLogState *log_state;
155 /* Filesystem crypto keys */
157 struct BlueSkyCryptKeys *keys;
159 /* Accounting for memory used for caches. Space is measured in blocks, not
160 * bytes. Updates to these variables must be made atomically. */
163 /* Like above, but tracking data stored in the cloudlog entries
165 * - cache_log_dirty: data uncommitted to journal and cloud
166 * - cache_log_writeback: data being written to journal
167 * - cache_log_journal: data committed to journal
168 * - cache_log_cloud: data written to cloud as well
169 * Log entries should progress from the top state to the bottom, and are
170 * only ever counted in one category at a time. */
171 gint cache_log_dirty, cache_log_writeback,
172 cache_log_journal, cache_log_cloud;
174 /* Linked list of inodes, sorted by access/modification times for cache
175 * management. Editing these lists is protected by the filesystem lock; to
176 * avoid deadlock do not attempt to take any other locks while the FS lock
177 * is held for list editing purposes. Items at the head of the list are
178 * most recently accessed/modified. */
179 GList unlogged_list; // Changes not yet synced to journal
180 GList dirty_list; // Not yet written to cloud storage
181 GList accessed_list; // All in-memory inodes
183 /* Mutex for the flush daemon, to prevent concurrent execution. */
186 /* Used to wait for the cache daemon to free up space */
189 /* Mapping of object identifiers (blocks, inodes) to physical location (in
190 * the local cache or in the logs in the cloud). */
191 GHashTable *locations;
193 /* The inode map, which maps inode numbers to the location of the most
195 GSequence *inode_map;
197 /* Queue for asynchronous cloudlog unrefs, where needed. */
198 GAsyncQueue *unref_queue;
200 /* Thread pool for asynchronous inode fetches */
201 GThreadPool *inode_fetch_thread_pool;
204 /* Inode number of the root directory. */
205 #define BLUESKY_ROOT_INUM 1
207 /* Timestamp, measured in microseconds since the Unix epoch. */
208 typedef int64_t bluesky_time;
210 /* High-resolution timer, measured in nanoseconds. */
211 typedef int64_t bluesky_time_hires;
212 bluesky_time_hires bluesky_now_hires();
214 /* In-memory representation of an inode within a Blue Sky server. This
215 * corresponds roughly with information that is committed to persistent
216 * storage. Locking/refcounting rules:
217 * - To access or modify any data fields, the lock must be held. This
218 * includes file blocks.
219 * - One reference is held by the BlueSkyFS inode hash table. If that is the
220 * only reference (and the inode is unlocked), the inode is subject to
221 * dropping from the cache.
222 * - Any pending operations should hold extra references to the inode as
223 * appropriate to keep it available until the operation completes.
224 * - Locking dependency order is, when multiple locks are to be acquired, to
225 * acquire locks on parents in the filesystem tree before children.
226 * (TODO: What about rename when we acquire locks in unrelated parts of the
228 * - An inode should not be locked while the filesystem lock is already held,
229 * since some code may do an inode lookup (which acquires the filesystem
230 * lock) while a different inode is locked.
238 BlueSkyFileType type;
243 /* Rather than track an inode number and generation number, we will simply
244 * never re-use a fileid after a file is deleted. 64 bits should be enough
245 * that we don't exhaust the identifier space. */
248 /* change_count is increased with every operation which modifies the inode,
249 * and can be used to determine if cached data is still valid.
250 * change_commit is the value of change_count when the inode was last
251 * committed to stable storage (the log).
252 * change_cloud tracks which version was last commited to cloud storage. */
253 uint64_t change_count, change_commit, change_cloud;
255 /* Timestamp for controlling when modified data is flushed to stable
256 * storage. When an inode is first modified from a clean state, this is
257 * set to the current time. If the inode is clean, it is set to zero. */
260 /* Last access time to this inode, for controlling cache evictions. */
263 /* Version of the object last serialized and committed to storage. */
264 BlueSkyCloudLog *committed_item;
266 /* Pointers to the linked-list elements for this inode in the accessed and
267 * dirty linked lists. We re-use the GList structure, using ->next to
268 * point to the head of the list and ->prev to point to the tail. The data
269 * element is unused. */
270 GList *unlogged_list, *accessed_list, *dirty_list;
272 int64_t atime; /* Microseconds since the Unix epoch */
275 int64_t ntime; /* "new time": time object was created */
277 /* File-specific fields */
281 /* Directory-specific fields */
282 GSequence *dirents; /* List of entries for READDIR */
283 GHashTable *dirhash; /* Hash table by name for LOOKUP */
284 GHashTable *dirhash_folded; /* As above, but case-folded */
285 uint64_t parent_inum; /* inode for ".."; 0 if the root directory */
287 /* Symlink-specific fields */
288 gchar *symlink_contents;
291 /* A directory entry. The name is UTF-8 and is a freshly-allocated string.
292 * Each directory entry is listed in two indices: dirents is indexed by cookie
293 * and dirhash by name. The cookie is a randomly-assigned 32-bit value, unique
294 * within the directory, that remains unchanged until the entry is deleted. It
295 * is used to provide a stable key for restarting a READDIR call. */
298 gchar *name_folded; /* Name, folded for case-insensitive lookup */
303 /* File data is divided into fixed-size blocks (except the last block which may
304 * be short?). These blocks are backed by storage in a key/value store, but
305 * may also be dirty if modifications have been made in-memory that have not
307 #define BLUESKY_BLOCK_SIZE 32768ULL
308 #define BLUESKY_MAX_FILE_SIZE (BLUESKY_BLOCK_SIZE << 24)
310 BLUESKY_BLOCK_ZERO = 0, /* Data is all zeroes, not explicitly stored */
311 BLUESKY_BLOCK_REF = 1, /* Reference to cloud log item, data clean */
312 BLUESKY_BLOCK_DIRTY = 2, /* Data needs to be committed to store */
316 BlueSkyBlockType type;
317 BlueSkyCloudLog *ref; /* if REF: cloud log entry with data */
318 BlueSkyRCStr *dirty; /* if DIRTY: raw data in memory */
321 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store,
322 const gchar *master_key);
324 gboolean bluesky_inode_is_ready(BlueSkyInode *inode);
326 int64_t bluesky_get_current_time();
327 void bluesky_inode_update_ctime(BlueSkyInode *inode, gboolean update_mtime);
328 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs);
329 void bluesky_init_inode(BlueSkyInode *i, BlueSkyFileType type);
330 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs, BlueSkyFileType type);
332 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum);
333 void bluesky_inode_ref(BlueSkyInode *inode);
334 void bluesky_inode_unref(BlueSkyInode *inode);
335 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode);
337 void bluesky_dirent_destroy(gpointer dirent);
338 uint64_t bluesky_directory_lookup(BlueSkyInode *inode, gchar *name);
339 uint64_t bluesky_directory_ilookup(BlueSkyInode *inode, gchar *name);
340 BlueSkyDirent *bluesky_directory_read(BlueSkyInode *dir, uint32_t cookie);
341 gboolean bluesky_directory_insert(BlueSkyInode *dir, const gchar *name,
343 void bluesky_directory_dump(BlueSkyInode *dir);
345 void bluesky_file_truncate(BlueSkyInode *inode, uint64_t size);
346 void bluesky_file_write(BlueSkyInode *inode, uint64_t offset,
347 const char *data, gint len);
348 void bluesky_file_read(BlueSkyInode *inode, uint64_t offset,
349 char *buf, gint len);
351 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum);
353 gint bluesky_dirent_compare(gconstpointer a, gconstpointer b,
356 void bluesky_flushd_invoke(BlueSkyFS *fs);
357 void bluesky_flushd_invoke_conditional(BlueSkyFS *fs);
358 void bluesky_inode_do_sync(BlueSkyInode *inode);
359 void bluesky_flushd_thread_launch(BlueSkyFS *fs);
361 void bluesky_debug_dump(BlueSkyFS *fs);