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 /* Cryptographic operations. */
89 #define CRYPTO_BLOCK_SIZE 16 /* 128-bit AES */
90 #define CRYPTO_KEY_SIZE 16
92 void bluesky_crypt_init();
93 void bluesky_crypt_hash_key(const char *keystr, uint8_t *out);
94 void bluesky_crypt_random_bytes(guchar *buf, gint len);
95 BlueSkyRCStr *bluesky_crypt_encrypt(BlueSkyRCStr *in, const uint8_t *key);
96 BlueSkyRCStr *bluesky_crypt_decrypt(BlueSkyRCStr *in, const uint8_t *key);
98 /* Storage interface. This presents a key-value store abstraction, and can
99 * have multiple implementations: in-memory, on-disk, in-cloud. */
100 struct _BlueSkyStore;
101 typedef struct _BlueSkyStore BlueSkyStore;
104 typedef struct _BlueSkyLog BlueSkyLog;
106 struct _BlueSkyCloudLogState;
107 typedef struct _BlueSkyCloudLogState BlueSkyCloudLogState;
109 struct _BlueSkyCloudLog;
110 typedef struct _BlueSkyCloudLog BlueSkyCloudLog;
112 void bluesky_store_init();
113 BlueSkyStore *bluesky_store_new(const gchar *type);
114 void bluesky_store_free(BlueSkyStore *store);
115 BlueSkyRCStr *bluesky_store_get(BlueSkyStore *store, const gchar *key);
116 void bluesky_store_put(BlueSkyStore *store,
117 const gchar *key, BlueSkyRCStr *val);
119 /* File types. The numeric values are chosen to match with those used in
123 BLUESKY_DIRECTORY = 2,
125 BLUESKY_CHARACTER = 4,
130 /* Special types used only internally. */
131 BLUESKY_PENDING = 0, /* Inode being loaded; type not yet determined */
132 BLUESKY_INVALID = -1, /* Inode is invalid (failed to load) */
135 /* Filesystem state. Each filesystem which is exported is represented by a
136 * single bluesky_fs structure in memory. */
140 gchar *name; /* Descriptive name for the filesystem */
141 GHashTable *inodes; /* Cached inodes */
142 uint64_t next_inum; /* Next available inode for allocation */
146 BlueSkyCloudLogState *log_state;
148 /* Accounting for memory used for caches. Space is measured in blocks, not
149 * bytes. Updates to these variables must be made atomically. */
152 /* Like above, but tracking data stored in the cloudlog entries
154 * - cache_log_dirty: data uncommitted to journal and cloud
155 * - cache_log_writeback: data being written to journal
156 * - cache_log_journal: data committed to journal
157 * - cache_log_cloud: data written to cloud as well
158 * Log entries should progress from the top state to the bottom, and are
159 * only ever counted in one category at a time. */
160 gint cache_log_dirty, cache_log_writeback,
161 cache_log_journal, cache_log_cloud;
163 /* Linked list of inodes, sorted by access/modification times for cache
164 * management. Editing these lists is protected by the filesystem lock; to
165 * avoid deadlock do not attempt to take any other locks while the FS lock
166 * is held for list editing purposes. Items at the head of the list are
167 * most recently accessed/modified. */
168 GList unlogged_list; // Changes not yet synced to journal
169 GList dirty_list; // Not yet written to cloud storage
170 GList accessed_list; // All in-memory inodes
172 /* Mutex for the flush daemon, to prevent concurrent execution. */
175 /* Used to wait for the cache daemon to free up space */
178 /* Mapping of object identifiers (blocks, inodes) to physical location (in
179 * the local cache or in the logs in the cloud). */
180 GHashTable *locations;
182 /* The inode map, which maps inode numbers to the location of the most
184 GSequence *inode_map;
187 /* Inode number of the root directory. */
188 #define BLUESKY_ROOT_INUM 1
190 /* Timestamp, measured in microseconds since the Unix epoch. */
191 typedef int64_t bluesky_time;
193 /* High-resolution timer, measured in nanoseconds. */
194 typedef int64_t bluesky_time_hires;
195 bluesky_time_hires bluesky_now_hires();
197 /* In-memory representation of an inode within a Blue Sky server. This
198 * corresponds roughly with information that is committed to persistent
199 * storage. Locking/refcounting rules:
200 * - To access or modify any data fields, the lock must be held. This
201 * includes file blocks.
202 * - One reference is held by the BlueSkyFS inode hash table. If that is the
203 * only reference (and the inode is unlocked), the inode is subject to
204 * dropping from the cache.
205 * - Any pending operations should hold extra references to the inode as
206 * appropriate to keep it available until the operation completes.
207 * - Locking dependency order is, when multiple locks are to be acquired, to
208 * acquire locks on parents in the filesystem tree before children.
209 * (TODO: What about rename when we acquire locks in unrelated parts of the
211 * - An inode should not be locked while the filesystem lock is already held,
212 * since some code may do an inode lookup (which acquires the filesystem
213 * lock) while a different inode is locked.
221 BlueSkyFileType type;
226 /* Rather than track an inode number and generation number, we will simply
227 * never re-use a fileid after a file is deleted. 64 bits should be enough
228 * that we don't exhaust the identifier space. */
231 /* change_count is increased with every operation which modifies the inode,
232 * and can be used to determine if cached data is still valid.
233 * change_commit is the value of change_count when the inode was last
234 * committed to stable storage (the log).
235 * change_cloud tracks which version was last commited to cloud storage. */
236 uint64_t change_count, change_commit, change_cloud;
238 /* Timestamp for controlling when modified data is flushed to stable
239 * storage. When an inode is first modified from a clean state, this is
240 * set to the current time. If the inode is clean, it is set to zero. */
243 /* Last access time to this inode, for controlling cache evictions. */
246 /* Version of the object last serialized and committed to storage. */
247 BlueSkyCloudLog *committed_item;
249 /* Pointers to the linked-list elements for this inode in the accessed and
250 * dirty linked lists. We re-use the GList structure, using ->next to
251 * point to the head of the list and ->prev to point to the tail. The data
252 * element is unused. */
253 GList *unlogged_list, *accessed_list, *dirty_list;
255 int64_t atime; /* Microseconds since the Unix epoch */
258 int64_t ntime; /* "new time": time object was created */
260 /* File-specific fields */
264 /* Directory-specific fields */
265 GSequence *dirents; /* List of entries for READDIR */
266 GHashTable *dirhash; /* Hash table by name for LOOKUP */
267 GHashTable *dirhash_folded; /* As above, but case-folded */
268 uint64_t parent_inum; /* inode for ".."; 0 if the root directory */
270 /* Symlink-specific fields */
271 gchar *symlink_contents;
274 /* A directory entry. The name is UTF-8 and is a freshly-allocated string.
275 * Each directory entry is listed in two indices: dirents is indexed by cookie
276 * and dirhash by name. The cookie is a randomly-assigned 32-bit value, unique
277 * within the directory, that remains unchanged until the entry is deleted. It
278 * is used to provide a stable key for restarting a READDIR call. */
281 gchar *name_folded; /* Name, folded for case-insensitive lookup */
286 /* File data is divided into fixed-size blocks (except the last block which may
287 * be short?). These blocks are backed by storage in a key/value store, but
288 * may also be dirty if modifications have been made in-memory that have not
290 #define BLUESKY_BLOCK_SIZE 32768ULL
291 #define BLUESKY_MAX_FILE_SIZE (BLUESKY_BLOCK_SIZE << 24)
293 BLUESKY_BLOCK_ZERO = 0, /* Data is all zeroes, not explicitly stored */
294 BLUESKY_BLOCK_REF = 1, /* Reference to cloud log item, data clean */
295 BLUESKY_BLOCK_DIRTY = 2, /* Data needs to be committed to store */
299 BlueSkyBlockType type;
300 BlueSkyCloudLog *ref; /* if REF: cloud log entry with data */
301 BlueSkyRCStr *dirty; /* if DIRTY: raw data in memory */
304 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store);
305 void bluesky_superblock_flush(BlueSkyFS *fs);
307 gboolean bluesky_inode_is_ready(BlueSkyInode *inode);
309 int64_t bluesky_get_current_time();
310 void bluesky_inode_update_ctime(BlueSkyInode *inode, gboolean update_mtime);
311 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs);
312 void bluesky_init_inode(BlueSkyInode *i, BlueSkyFileType type);
313 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs, BlueSkyFileType type);
315 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum);
316 void bluesky_inode_ref(BlueSkyInode *inode);
317 void bluesky_inode_unref(BlueSkyInode *inode);
318 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode);
320 void bluesky_dirent_destroy(gpointer dirent);
321 uint64_t bluesky_directory_lookup(BlueSkyInode *inode, gchar *name);
322 uint64_t bluesky_directory_ilookup(BlueSkyInode *inode, gchar *name);
323 BlueSkyDirent *bluesky_directory_read(BlueSkyInode *dir, uint32_t cookie);
324 gboolean bluesky_directory_insert(BlueSkyInode *dir, const gchar *name,
326 void bluesky_directory_dump(BlueSkyInode *dir);
328 void bluesky_file_truncate(BlueSkyInode *inode, uint64_t size);
329 void bluesky_file_write(BlueSkyInode *inode, uint64_t offset,
330 const char *data, gint len);
331 void bluesky_file_read(BlueSkyInode *inode, uint64_t offset,
332 char *buf, gint len);
334 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum);
336 gint bluesky_dirent_compare(gconstpointer a, gconstpointer b,
339 void bluesky_flushd_invoke(BlueSkyFS *fs);
340 void bluesky_flushd_invoke_conditional(BlueSkyFS *fs);
341 void bluesky_inode_do_sync(BlueSkyInode *inode);
342 void bluesky_flushd_thread_launch(BlueSkyFS *fs);
344 void bluesky_debug_dump(BlueSkyFS *fs);