c27fb6c3bca09c685d50c19c66b324457f85dd82
[bluesky.git] / bluesky / bluesky.h
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 #ifndef _BLUESKY_H
10 #define _BLUESKY_H
11
12 #include <stdint.h>
13 #include <inttypes.h>
14 #include <glib.h>
15
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19
20 /* Various options to tweak for performance benchmarking purposes. */
21 typedef struct {
22     /* Perform all get/put operations synchronously. */
23     int synchronous_stores;
24
25     /* Write data in cache immediately after file is modified. */
26     int writethrough_cache;
27
28     /* Can inodes be fetched asynchronously?  (Inode object is initially
29      * created in a pending state, and not unlocked until the data is actually
30      * available.) */
31     int sync_inode_fetches;
32
33     /* Should frontends handle requests serially or allow operations to proceed
34      * in parallel? */
35     int sync_frontends;
36
37     /* Target size of the disk cache at the proxy, in kilobytes. */
38     int cache_size;
39 } BlueSkyOptions;
40
41 extern BlueSkyOptions bluesky_options;
42
43 /* Maximum number of threads to use in any particular thread pool, or -1 for no
44  * limit */
45 extern int bluesky_max_threads;
46
47 /* A general-purpose counter for gathering run-time statistics. */
48 struct bluesky_stats {
49     const char *name;
50     int64_t count;
51     int64_t sum;
52 };
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();
56
57 /* BlueSky status and error codes.  Various frontends should translate these to
58  * the appropriate error code for whatever protocol they implement. */
59 typedef enum {
60     BSTATUS_OK = 0,             /* No error */
61     BSTATUS_IOERR,              /* I/O error of some form */
62     BSTATUS_NOENT,              /* File does not exist */
63 } BlueSkyStatus;
64
65 void bluesky_init(void);
66
67 gchar *bluesky_lowercase(const gchar *s);
68
69 struct BlueSkyCacheFile;
70 typedef struct BlueSkyCacheFile BlueSkyCacheFile;
71
72 typedef struct {
73     gint refcount;
74     BlueSkyCacheFile *mmap;
75     gchar *data;
76     gsize len;
77 } BlueSkyRCStr;
78
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);
87
88 struct BlueSkyRangeset;
89 typedef struct BlueSkyRangeset BlueSkyRangeset;
90 typedef struct {
91     uint64_t start, length;
92     gpointer data;
93 } BlueSkyRangesetItem;
94
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,
99                                  gpointer data);
100 const BlueSkyRangesetItem *bluesky_rangeset_lookup(BlueSkyRangeset *rangeset,
101                                                    uint64_t offset);
102 const BlueSkyRangesetItem *bluesky_rangeset_lookup_next(BlueSkyRangeset *rangeset, uint64_t offset);
103
104 /* Storage interface.  This presents a key-value store abstraction, and can
105  * have multiple implementations: in-memory, on-disk, in-cloud. */
106 struct BlueSkyStore;
107 typedef struct BlueSkyStore BlueSkyStore;
108
109 struct BlueSkyLog;
110 typedef struct BlueSkyLog BlueSkyLog;
111
112 struct BlueSkyCloudLogState;
113 typedef struct BlueSkyCloudLogState BlueSkyCloudLogState;
114
115 struct BlueSkyCloudLog;
116 typedef struct BlueSkyCloudLog BlueSkyCloudLog;
117
118 void bluesky_store_init();
119 BlueSkyStore *bluesky_store_new(const gchar *type);
120 void bluesky_store_free(BlueSkyStore *store);
121 BlueSkyRCStr *bluesky_store_get(BlueSkyStore *store, const gchar *key);
122 void bluesky_store_put(BlueSkyStore *store,
123                        const gchar *key, BlueSkyRCStr *val);
124
125 /* File types.  The numeric values are chosen to match with those used in
126  * NFSv3. */
127 typedef enum {
128     BLUESKY_REGULAR = 1,
129     BLUESKY_DIRECTORY = 2,
130     BLUESKY_BLOCK = 3,
131     BLUESKY_CHARACTER = 4,
132     BLUESKY_SYMLINK = 5,
133     BLUESKY_SOCKET = 6,
134     BLUESKY_FIFO = 7,
135
136     /* Special types used only internally. */
137     BLUESKY_PENDING = 0,    /* Inode being loaded; type not yet determined */
138     BLUESKY_INVALID = -1,   /* Inode is invalid (failed to load) */
139 } BlueSkyFileType;
140
141 /* Filesystem state.  Each filesystem which is exported is represented by a
142  * single bluesky_fs structure in memory. */
143 struct BlueSkyCryptKeys;
144
145 typedef struct {
146     GMutex *lock;
147
148     gchar *name;                /* Descriptive name for the filesystem */
149     GHashTable *inodes;         /* Cached inodes */
150     uint64_t next_inum;         /* Next available inode for allocation */
151
152     BlueSkyStore *store;
153     BlueSkyLog *log;
154     BlueSkyCloudLogState *log_state;
155
156     /* Filesystem crypto keys */
157     char *master_key;
158     struct BlueSkyCryptKeys *keys;
159
160     /* Accounting for memory used for caches.  Space is measured in blocks, not
161      * bytes.  Updates to these variables must be made atomically. */
162     gint cache_dirty;
163
164     /* Like above, but tracking data stored in the cloudlog entries
165      * specifically:
166      *  - cache_log_dirty: data uncommitted to journal and cloud
167      *  - cache_log_writeback: data being written to journal
168      *  - cache_log_journal: data committed to journal
169      *  - cache_log_cloud: data written to cloud as well
170      * Log entries should progress from the top state to the bottom, and are
171      * only ever counted in one category at a time. */
172     gint cache_log_dirty, cache_log_writeback,
173          cache_log_journal, cache_log_cloud;
174
175     /* Linked list of inodes, sorted by access/modification times for cache
176      * management.  Editing these lists is protected by the filesystem lock; to
177      * avoid deadlock do not attempt to take any other locks while the FS lock
178      * is held for list editing purposes.  Items at the head of the list are
179      * most recently accessed/modified. */
180     GList unlogged_list;        // Changes not yet synced to journal
181     GList dirty_list;           // Not yet written to cloud storage
182     GList accessed_list;        // All in-memory inodes
183
184     /* Mutex for the flush daemon, to prevent concurrent execution. */
185     GMutex *flushd_lock;
186
187     /* Used to wait for the cache daemon to free up space */
188     GCond *flushd_cond;
189
190     /* Mapping of object identifiers (blocks, inodes) to physical location (in
191      * the local cache or in the logs in the cloud). */
192     GHashTable *locations;
193
194     /* The inode map, which maps inode numbers to the location of the most
195      * recent version. */
196     GSequence *inode_map;
197
198     /* Queue for asynchronous cloudlog unrefs, where needed. */
199     GAsyncQueue *unref_queue;
200
201     /* Thread pool for asynchronous inode fetches */
202     GThreadPool *inode_fetch_thread_pool;
203 } BlueSkyFS;
204
205 /* Inode number of the root directory. */
206 #define BLUESKY_ROOT_INUM 1
207
208 /* Timestamp, measured in microseconds since the Unix epoch. */
209 typedef int64_t bluesky_time;
210
211 /* High-resolution timer, measured in nanoseconds. */
212 typedef int64_t bluesky_time_hires;
213 bluesky_time_hires bluesky_now_hires();
214
215 /* In-memory representation of an inode within a Blue Sky server.  This
216  * corresponds roughly with information that is committed to persistent
217  * storage.  Locking/refcounting rules:
218  *   - To access or modify any data fields, the lock must be held.  This
219  *     includes file blocks.
220  *   - One reference is held by the BlueSkyFS inode hash table.  If that is the
221  *     only reference (and the inode is unlocked), the inode is subject to
222  *     dropping from the cache.
223  *   - Any pending operations should hold extra references to the inode as
224  *     appropriate to keep it available until the operation completes.
225  *   - Locking dependency order is, when multiple locks are to be acquired, to
226  *     acquire locks on parents in the filesystem tree before children.
227  *     (TODO: What about rename when we acquire locks in unrelated parts of the
228  *     filesystem?)
229  *   - An inode should not be locked while the filesystem lock is already held,
230  *     since some code may do an inode lookup (which acquires the filesystem
231  *     lock) while a different inode is locked.
232  * */
233 typedef struct {
234     GMutex *lock;
235     gint refcount;
236
237     BlueSkyFS *fs;
238
239     BlueSkyFileType type;
240     uint32_t mode;
241     uint32_t uid, gid;
242     uint32_t nlink;
243
244     /* Rather than track an inode number and generation number, we will simply
245      * never re-use a fileid after a file is deleted.  64 bits should be enough
246      * that we don't exhaust the identifier space. */
247     uint64_t inum;
248
249     /* change_count is increased with every operation which modifies the inode,
250      * and can be used to determine if cached data is still valid.
251      * change_commit is the value of change_count when the inode was last
252      * committed to stable storage (the log).
253      * change_cloud tracks which version was last commited to cloud storage. */
254     uint64_t change_count, change_commit, change_cloud;
255
256     /* Timestamp for controlling when modified data is flushed to stable
257      * storage.  When an inode is first modified from a clean state, this is
258      * set to the current time.  If the inode is clean, it is set to zero. */
259     int64_t change_time;
260
261     /* Last access time to this inode, for controlling cache evictions. */
262     int64_t access_time;
263
264     /* Version of the object last serialized and committed to storage. */
265     BlueSkyCloudLog *committed_item;
266
267     /* Pointers to the linked-list elements for this inode in the accessed and
268      * dirty linked lists.  We re-use the GList structure, using ->next to
269      * point to the head of the list and ->prev to point to the tail.  The data
270      * element is unused. */
271     GList *unlogged_list, *accessed_list, *dirty_list;
272
273     int64_t atime;              /* Microseconds since the Unix epoch */
274     int64_t ctime;
275     int64_t mtime;
276     int64_t ntime;              /* "new time": time object was created */
277
278     /* File-specific fields */
279     uint64_t size;
280     GArray *blocks;
281
282     /* Directory-specific fields */
283     GSequence *dirents;         /* List of entries for READDIR */
284     GHashTable *dirhash;        /* Hash table by name for LOOKUP */
285     GHashTable *dirhash_folded; /* As above, but case-folded */
286     uint64_t parent_inum;       /* inode for ".."; 0 if the root directory */
287
288     /* Symlink-specific fields */
289     gchar *symlink_contents;
290 } BlueSkyInode;
291
292 /* A directory entry.  The name is UTF-8 and is a freshly-allocated string.
293  * Each directory entry is listed in two indices: dirents is indexed by cookie
294  * and dirhash by name.  The cookie is a randomly-assigned 32-bit value, unique
295  * within the directory, that remains unchanged until the entry is deleted.  It
296  * is used to provide a stable key for restarting a READDIR call. */
297 typedef struct {
298     gchar *name;
299     gchar *name_folded;         /* Name, folded for case-insensitive lookup */
300     uint32_t cookie;
301     uint64_t inum;
302 } BlueSkyDirent;
303
304 /* File data is divided into fixed-size blocks (except the last block which may
305  * be short?).  These blocks are backed by storage in a key/value store, but
306  * may also be dirty if modifications have been made in-memory that have not
307  * been committed. */
308 #define BLUESKY_BLOCK_SIZE 32768ULL
309 #define BLUESKY_MAX_FILE_SIZE (BLUESKY_BLOCK_SIZE << 24)
310 typedef enum {
311     BLUESKY_BLOCK_ZERO = 0,     /* Data is all zeroes, not explicitly stored */
312     BLUESKY_BLOCK_REF = 1,      /* Reference to cloud log item, data clean */
313     BLUESKY_BLOCK_DIRTY = 2,    /* Data needs to be committed to store */
314 } BlueSkyBlockType;
315
316 typedef struct {
317     BlueSkyBlockType type;
318     BlueSkyCloudLog *ref;       /* if REF: cloud log entry with data */
319     BlueSkyRCStr *dirty;        /* if DIRTY: raw data in memory */
320 } BlueSkyBlock;
321
322 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store,
323                            const gchar *master_key);
324
325 gboolean bluesky_inode_is_ready(BlueSkyInode *inode);
326
327 int64_t bluesky_get_current_time();
328 void bluesky_inode_update_ctime(BlueSkyInode *inode, gboolean update_mtime);
329 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs);
330 void bluesky_init_inode(BlueSkyInode *i, BlueSkyFileType type);
331 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs, BlueSkyFileType type);
332
333 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum);
334 void bluesky_inode_ref(BlueSkyInode *inode);
335 void bluesky_inode_unref(BlueSkyInode *inode);
336 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode);
337
338 void bluesky_dirent_destroy(gpointer dirent);
339 uint64_t bluesky_directory_lookup(BlueSkyInode *inode, gchar *name);
340 uint64_t bluesky_directory_ilookup(BlueSkyInode *inode, gchar *name);
341 BlueSkyDirent *bluesky_directory_read(BlueSkyInode *dir, uint32_t cookie);
342 gboolean bluesky_directory_insert(BlueSkyInode *dir, const gchar *name,
343                                   uint64_t inum);
344 void bluesky_directory_dump(BlueSkyInode *dir);
345
346 void bluesky_file_truncate(BlueSkyInode *inode, uint64_t size);
347 void bluesky_file_write(BlueSkyInode *inode, uint64_t offset,
348                         const char *data, gint len);
349 void bluesky_file_read(BlueSkyInode *inode, uint64_t offset,
350                        char *buf, gint len);
351
352 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum);
353
354 gint bluesky_dirent_compare(gconstpointer a, gconstpointer b,
355                             gpointer unused);
356
357 void bluesky_flushd_invoke(BlueSkyFS *fs);
358 void bluesky_flushd_invoke_conditional(BlueSkyFS *fs);
359 void bluesky_inode_do_sync(BlueSkyInode *inode);
360 void bluesky_flushd_thread_launch(BlueSkyFS *fs);
361
362 void bluesky_debug_dump(BlueSkyFS *fs);
363
364 #ifdef __cplusplus
365 }
366 #endif
367
368 #endif