beec07577d34a3852f37df0225e73d2b3adf2fad
[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 } BlueSkyOptions;
37
38 extern BlueSkyOptions bluesky_options;
39
40 /* Maximum number of threads to use in any particular thread pool, or -1 for no
41  * limit */
42 extern int bluesky_max_threads;
43
44 /* A general-purpose counter for gathering run-time statistics. */
45 struct bluesky_stats {
46     const char *name;
47     int64_t count;
48     int64_t sum;
49 };
50 struct bluesky_stats *bluesky_stats_new(const char *name);
51 void bluesky_stats_add(struct bluesky_stats *stats, int64_t value);
52 void bluesky_stats_dump_all();
53
54 /* BlueSky status and error codes.  Various frontends should translate these to
55  * the appropriate error code for whatever protocol they implement. */
56 typedef enum {
57     BSTATUS_OK = 0,             /* No error */
58     BSTATUS_IOERR,              /* I/O error of some form */
59     BSTATUS_NOENT,              /* File does not exist */
60 } BlueSkyStatus;
61
62 void bluesky_init(void);
63
64 gchar *bluesky_lowercase(const gchar *s);
65
66 /* Reference-counted blocks of memory, used for passing data in and out of
67  * storage backends and in other places. */
68 typedef struct {
69     gint refcount;
70     gchar *data;
71     gsize len;
72 } BlueSkyRCStr;
73
74 BlueSkyRCStr *bluesky_string_new(gpointer data, gsize len);
75 BlueSkyRCStr *bluesky_string_new_from_gstring(GString *s);
76 void bluesky_string_ref(BlueSkyRCStr *string);
77 void bluesky_string_unref(BlueSkyRCStr *string);
78 BlueSkyRCStr *bluesky_string_dup(BlueSkyRCStr *string);
79 void bluesky_string_resize(BlueSkyRCStr *string, gsize len);
80
81 /* Cryptographic operations. */
82 #define CRYPTO_BLOCK_SIZE 16        /* 128-bit AES */
83 #define CRYPTO_KEY_SIZE   16
84
85 void bluesky_crypt_init();
86 void bluesky_crypt_hash_key(const char *keystr, uint8_t *out);
87 void bluesky_crypt_random_bytes(guchar *buf, gint len);
88 BlueSkyRCStr *bluesky_crypt_encrypt(BlueSkyRCStr *in, const uint8_t *key);
89 BlueSkyRCStr *bluesky_crypt_decrypt(BlueSkyRCStr *in, const uint8_t *key);
90
91 /* Storage interface.  This presents a key-value store abstraction, and can
92  * have multiple implementations: in-memory, on-disk, in-cloud. */
93 struct _BlueSkyStore;
94 typedef struct _BlueSkyStore BlueSkyStore;
95
96 struct _BlueSkyLog;
97 typedef struct _BlueSkyLog BlueSkyLog;
98
99 void bluesky_store_init();
100 BlueSkyStore *bluesky_store_new(const gchar *type);
101 void bluesky_store_free(BlueSkyStore *store);
102 BlueSkyRCStr *bluesky_store_get(BlueSkyStore *store, const gchar *key);
103 void bluesky_store_put(BlueSkyStore *store,
104                        const gchar *key, BlueSkyRCStr *val);
105
106 /* File types.  The numeric values are chosen to match with those used in
107  * NFSv3. */
108 typedef enum {
109     BLUESKY_REGULAR = 1,
110     BLUESKY_DIRECTORY = 2,
111     BLUESKY_BLOCK = 3,
112     BLUESKY_CHARACTER = 4,
113     BLUESKY_SYMLINK = 5,
114     BLUESKY_SOCKET = 6,
115     BLUESKY_FIFO = 7,
116
117     /* Special types used only internally. */
118     BLUESKY_PENDING = 0,    /* Inode being loaded; type not yet determined */
119     BLUESKY_INVALID = -1,   /* Inode is invalid (failed to load) */
120 } BlueSkyFileType;
121
122 /* Filesystem state.  Each filesystem which is exported is represented by a
123  * single bluesky_fs structure in memory. */
124 typedef struct {
125     GMutex *lock;
126
127     gchar *name;                /* Descriptive name for the filesystem */
128     GHashTable *inodes;         /* Cached inodes */
129     uint64_t next_inum;         /* Next available inode for allocation */
130
131     BlueSkyStore *store;
132     BlueSkyLog *log;
133
134     /* Accounting for memory used for caches.  Space is measured in blocks, not
135      * bytes.  We track both total data in the caches and dirty data (total
136      * data includes dirty data).  Updates to these variables must be made
137      * atomically. */
138     gint cache_total, cache_dirty;
139
140     /* Linked list of inodes, sorted by access/modification times for cache
141      * management.  Editing these lists is protected by the filesystem lock; to
142      * avoid deadlock do not attempt to take any other locks while the FS lock
143      * is held for list editing purposes.  Items at the head of the list are
144      * most recently accessed/modified. */
145     GList dirty_list, accessed_list;
146
147     /* Mutex for the flush daemon, to prevent concurrent execution. */
148     GMutex *flushd_lock;
149 } BlueSkyFS;
150
151 /* Inode number of the root directory. */
152 #define BLUESKY_ROOT_INUM 1
153
154 /* Timestamp, measured in microseconds since the Unix epoch. */
155 typedef int64_t bluesky_time;
156
157 /* High-resolution timer, measured in nanoseconds. */
158 typedef int64_t bluesky_time_hires;
159 bluesky_time_hires bluesky_now_hires();
160
161 /* In-memory representation of an inode within a Blue Sky server.  This
162  * corresponds roughly with information that is committed to persistent
163  * storage.  Locking/refcounting rules:
164  *   - To access or modify any data fields, the lock must be held.  This
165  *     includes file blocks.
166  *   - One reference is held by the BlueSkyFS inode hash table.  If that is the
167  *     only reference (and the inode is unlocked), the inode is subject to
168  *     dropping from the cache.
169  *   - Any pending operations should hold extra references to the inode as
170  *     appropriate to keep it available until the operation completes.
171  *   - Locking dependency order is, when multiple locks are to be acquired, to
172  *     acquire locks on parents in the filesystem tree before children.
173  *     (TODO: What about rename when we acquire locks in unrelated parts of the
174  *     filesystem?)
175  *   - An inode should not be locked while the filesystem lock is already held,
176  *     since some code may do an inode lookup (which acquires the filesystem
177  *     lock) while a different inode is locked.
178  * */
179 typedef struct {
180     GMutex *lock;
181     gint refcount;
182
183     BlueSkyFS *fs;
184
185     BlueSkyFileType type;
186     uint32_t mode;
187     uint32_t uid, gid;
188     uint32_t nlink;
189
190     /* Rather than track an inode number and generation number, we will simply
191      * never re-use a fileid after a file is deleted.  64 bits should be enough
192      * that we don't exhaust the identifier space. */
193     uint64_t inum;
194
195     /* change_count is increased with every operation which modifies the inode,
196      * and can be used to determine if cached data is still valid.
197      * change_commit is the value of change_count when the inode was last
198      * committed to stable storage. */
199     uint64_t change_count, change_commit;
200
201     /* Timestamp for controlling when modified data is flushed to stable
202      * storage.  When an inode is first modified from a clean state, this is
203      * set to the current time.  If the inode is clean, it is set to zero. */
204     int64_t change_time;
205
206     /* Last access time to this inode, for controlling cache evictions. */
207     int64_t access_time;
208
209     /* Additional state for tracking cache writeback status. */
210     uint64_t change_pending;    /* change_count version currently being committed to storage */
211
212     /* Pointers to the linked-list elements for this inode in the accessed and
213      * dirty linked lists.  We re-use the GList structure, using ->next to
214      * point to the head of the list and ->prev to point to the tail.  The data
215      * element is unused. */
216     GList *accessed_list, *dirty_list;
217
218     int64_t atime;              /* Microseconds since the Unix epoch */
219     int64_t ctime;
220     int64_t mtime;
221     int64_t ntime;              /* "new time": time object was created */
222
223     /* File-specific fields */
224     uint64_t size;
225     GArray *blocks;
226
227     /* Directory-specific fields */
228     GSequence *dirents;         /* List of entries for READDIR */
229     GHashTable *dirhash;        /* Hash table by name for LOOKUP */
230     GHashTable *dirhash_folded; /* As above, but case-folded */
231     uint64_t parent_inum;       /* inode for ".."; 0 if the root directory */
232
233     /* Symlink-specific fields */
234     gchar *symlink_contents;
235 } BlueSkyInode;
236
237 /* A directory entry.  The name is UTF-8 and is a freshly-allocated string.
238  * Each directory entry is listed in two indices: dirents is indexed by cookie
239  * and dirhash by name.  The cookie is a randomly-assigned 32-bit value, unique
240  * within the directory, that remains unchanged until the entry is deleted.  It
241  * is used to provide a stable key for restarting a READDIR call. */
242 typedef struct {
243     gchar *name;
244     gchar *name_folded;         /* Name, folded for case-insensitive lookup */
245     uint32_t cookie;
246     uint64_t inum;
247 } BlueSkyDirent;
248
249 /* File data is divided into fixed-size blocks (except the last block which may
250  * be short?).  These blocks are backed by storage in a key/value store, but
251  * may also be dirty if modifications have been made in-memory that have not
252  * been committed. */
253 #define BLUESKY_BLOCK_SIZE 32768ULL
254 #define BLUESKY_MAX_FILE_SIZE (BLUESKY_BLOCK_SIZE << 24)
255 typedef enum {
256     BLUESKY_BLOCK_ZERO = 0,     /* Data is all zeroes, not explicitly stored */
257     BLUESKY_BLOCK_REF = 1,      /* Reference to key/value store, not cached */
258     BLUESKY_BLOCK_CACHED = 2,   /* Data is cached in memory, clean */
259     BLUESKY_BLOCK_DIRTY = 3,    /* Data needs to be committed to store */
260 } BlueSkyBlockType;
261
262 typedef struct {
263     BlueSkyBlockType type;
264     gchar *ref;                 /* Name of data block in the backing store */
265     BlueSkyRCStr *data;         /* Pointer to data in memory if cached */
266 } BlueSkyBlock;
267
268 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store);
269 void bluesky_superblock_flush(BlueSkyFS *fs);
270
271 gboolean bluesky_inode_is_ready(BlueSkyInode *inode);
272
273 int64_t bluesky_get_current_time();
274 void bluesky_inode_update_ctime(BlueSkyInode *inode, gboolean update_mtime);
275 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs);
276 void bluesky_init_inode(BlueSkyInode *i, BlueSkyFileType type);
277 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs, BlueSkyFileType type);
278
279 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum);
280 void bluesky_inode_ref(BlueSkyInode *inode);
281 void bluesky_inode_unref(BlueSkyInode *inode);
282 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode);
283
284 void bluesky_dirent_destroy(gpointer dirent);
285 uint64_t bluesky_directory_lookup(BlueSkyInode *inode, gchar *name);
286 uint64_t bluesky_directory_ilookup(BlueSkyInode *inode, gchar *name);
287 BlueSkyDirent *bluesky_directory_read(BlueSkyInode *dir, uint32_t cookie);
288 gboolean bluesky_directory_insert(BlueSkyInode *dir, const gchar *name,
289                                   uint64_t inum);
290 void bluesky_directory_dump(BlueSkyInode *dir);
291
292 void bluesky_file_truncate(BlueSkyInode *inode, uint64_t size);
293 void bluesky_file_write(BlueSkyInode *inode, uint64_t offset,
294                         const char *data, gint len);
295 void bluesky_file_read(BlueSkyInode *inode, uint64_t offset,
296                        char *buf, gint len);
297
298 void bluesky_inode_flush(BlueSkyFS *fs, BlueSkyInode *inode);
299 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum);
300
301 gint bluesky_dirent_compare(gconstpointer a, gconstpointer b,
302                             gpointer unused);
303
304 void bluesky_flushd_invoke(BlueSkyFS *fs);
305 void bluesky_flushd_invoke_conditional(BlueSkyFS *fs);
306 void bluesky_inode_do_sync(BlueSkyInode *inode);
307 void bluesky_flushd_thread_launch(BlueSkyFS *fs);
308
309 void bluesky_debug_dump(BlueSkyFS *fs);
310
311 #ifdef __cplusplus
312 }
313 #endif
314
315 #endif