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