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