dbb69bbc5152f4f167d2579dac22cde0470a9b9d
[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 void bluesky_init(void);
21
22 gchar *bluesky_lowercase(const gchar *s);
23
24 /* Reference-counted blocks of memory, used for passing data in and out of
25  * storage backends and in other places. */
26 typedef struct {
27     gint refcount;
28     gchar *data;
29     gsize len;
30 } BlueSkyRCStr;
31
32 BlueSkyRCStr *bluesky_string_new(gpointer data, gsize len);
33 void bluesky_string_ref(BlueSkyRCStr *string);
34 void bluesky_string_unref(BlueSkyRCStr *string);
35 BlueSkyRCStr *bluesky_string_dup(BlueSkyRCStr *string);
36 void bluesky_string_resize(BlueSkyRCStr *string, gsize len);
37
38 /* Cryptographic operations. */
39 #define CRYPTO_BLOCK_SIZE 16        /* 128-bit AES */
40 #define CRYPTO_KEY_SIZE   16
41
42 void bluesky_crypt_init();
43 void bluesky_crypt_hash_key(const char *keystr, uint8_t *out);
44 void bluesky_crypt_random_bytes(guchar *buf, gint len);
45 BlueSkyRCStr *bluesky_crypt_encrypt(BlueSkyRCStr *in, const uint8_t *key);
46 BlueSkyRCStr *bluesky_crypt_decrypt(BlueSkyRCStr *in, const uint8_t *key);
47
48 /* Storage interface.  This presents a key-value store abstraction, and can
49  * have multiple implementations: in-memory, on-disk, in-cloud. */
50 typedef struct {
51     /* Create a new store instance and return a handle to it. */
52     gpointer (*create)();
53
54     /* Clean up any resources used by this store. */
55     void (*destroy)(gpointer store);
56
57     /* Fetch an item with the given name, or return NULL if not found. */
58     BlueSkyRCStr * (*get)(gpointer store, const gchar *key);
59
60     /* Store an item to the given key name. */
61     void (*put)(gpointer store, const gchar *key, BlueSkyRCStr *val);
62 } BlueSkyStoreImplementation;
63
64 void bluesky_store_register(const BlueSkyStoreImplementation *impl,
65                             const gchar *name);
66
67 struct _BlueSkyStore;
68 typedef struct _BlueSkyStore BlueSkyStore;
69
70 void bluesky_store_init();
71 BlueSkyStore *bluesky_store_new(const gchar *type);
72 void bluesky_store_free(BlueSkyStore *store);
73 BlueSkyRCStr *bluesky_store_get(BlueSkyStore *store, const gchar *key);
74 void bluesky_store_put(BlueSkyStore *store,
75                        const gchar *key, BlueSkyRCStr *val);
76
77 /* File types.  The numeric values are chosen to match with those used in
78  * NFSv3. */
79 typedef enum {
80     BLUESKY_REGULAR = 1,
81     BLUESKY_DIRECTORY = 2,
82     BLUESKY_BLOCK = 3,
83     BLUESKY_CHARACTER = 4,
84     BLUESKY_SYMLINK = 5,
85     BLUESKY_SOCKET = 6,
86     BLUESKY_FIFO = 7,
87 } BlueSkyFileType;
88
89 /* Filesystem state.  Each filesystem which is exported is represented by a
90  * single bluesky_fs structure in memory. */
91 typedef struct {
92     GMutex *lock;
93
94     gchar *name;                /* Descriptive name for the filesystem */
95     GHashTable *inodes;         /* Cached inodes */
96     uint64_t next_inum;         /* Next available inode for allocation */
97
98     BlueSkyStore *store;
99 } BlueSkyFS;
100
101 /* Inode number of the root directory. */
102 #define BLUESKY_ROOT_INUM 1
103
104 /* Timestamp, measured in microseconds since the Unix epoch. */
105 typedef int64_t bluesky_time;
106
107 /* High-resolution timer, measured in nanoseconds. */
108 typedef int64_t bluesky_time_hires;
109 bluesky_time_hires bluesky_now_hires();
110
111 /* In-memory representation of an inode within a Blue Sky server.  This
112  * corresponds roughly with information that is committed to persistent
113  * storage.  Locking/refcounting rules:
114  *   - To access or modify any data fields, the lock must be held.  This
115  *     includes file blocks.
116  *   - One reference is held by the BlueSkyFS inode hash table.  If that is the
117  *     only reference (and the inode is unlocked), the inode is subject to
118  *     dropping from the cache.
119  *   - Any pending operations should hold extra references to the inode as
120  *     appropriate to keep it available until the operation completes.
121  * */
122 typedef struct {
123     GMutex *lock;
124     gint refcount;
125
126     BlueSkyFS *fs;
127
128     BlueSkyFileType type;
129     uint32_t mode;
130     uint32_t uid, gid;
131     uint32_t nlink;
132
133     /* Rather than track an inode number and generation number, we will simply
134      * never re-use a fileid after a file is deleted.  64 bits should be enough
135      * that we don't exhaust the identifier space. */
136     uint64_t inum;
137
138     /* change_count is increased with every operation which modifies the inode,
139      * and can be used to determine if cached data is still valid.
140      * change_commit is the value of change_count when the inode was last
141      * committed to stable storage. */
142     uint64_t change_count, change_commit;
143
144     int64_t atime;              /* Microseconds since the Unix epoch */
145     int64_t ctime;
146     int64_t mtime;
147     int64_t ntime;              /* "new time": time object was created */
148
149     /* File-specific fields */
150     uint64_t size;
151     GArray *blocks;
152
153     /* Directory-specific fields */
154     GSequence *dirents;         /* List of entries for READDIR */
155     GHashTable *dirhash;        /* Hash table by name for LOOKUP */
156     GHashTable *dirhash_folded; /* As above, but case-folded */
157     uint64_t parent_inum;       /* inode for ".."; 0 if the root directory */
158 } BlueSkyInode;
159
160 /* A directory entry.  The name is UTF-8 and is a freshly-allocated string.
161  * Each directory entry is listed in two indices: dirents is indexed by cookie
162  * and dirhash by name.  The cookie is a randomly-assigned 32-bit value, unique
163  * within the directory, that remains unchanged until the entry is deleted.  It
164  * is used to provide a stable key for restarting a READDIR call. */
165 typedef struct {
166     gchar *name;
167     gchar *name_folded;         /* Name, folded for case-insensitive lookup */
168     uint32_t cookie;
169     uint64_t inum;
170 } BlueSkyDirent;
171
172 /* File data is divided into fixed-size blocks (except the last block which may
173  * be short?).  These blocks are backed by storage in a key/value store, but
174  * may also be dirty if modifications have been made in-memory that have not
175  * been committed. */
176 #define BLUESKY_BLOCK_SIZE 32768ULL
177 #define BLUESKY_MAX_FILE_SIZE (BLUESKY_BLOCK_SIZE << 24)
178 typedef enum {
179     BLUESKY_BLOCK_ZERO = 0,     /* Data is all zeroes, not explicitly stored */
180     BLUESKY_BLOCK_REF = 1,      /* Reference to key/value store, not cached */
181     BLUESKY_BLOCK_CACHED = 2,   /* Data is cached in memory, clean */
182     BLUESKY_BLOCK_DIRTY = 3,    /* Data needs to be committed to store */
183 } BlueSkyBlockType;
184
185 typedef struct {
186     BlueSkyBlockType type;
187     gchar *ref;                 /* Name of data block in the backing store */
188     BlueSkyRCStr *data;         /* Pointer to data in memory if cached */
189 } BlueSkyBlock;
190
191 BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store);
192 void bluesky_superblock_flush(BlueSkyFS *fs);
193
194 int64_t bluesky_get_current_time();
195 void bluesky_inode_update_ctime(BlueSkyInode *inode, gboolean update_mtime);
196 uint64_t bluesky_fs_alloc_inode(BlueSkyFS *fs);
197 BlueSkyInode *bluesky_new_inode(uint64_t inum, BlueSkyFS *fs, BlueSkyFileType type);
198
199 BlueSkyInode *bluesky_get_inode(BlueSkyFS *fs, uint64_t inum);
200 void bluesky_insert_inode(BlueSkyFS *fs, BlueSkyInode *inode);
201
202 void bluesky_dirent_destroy(gpointer dirent);
203 uint64_t bluesky_directory_lookup(BlueSkyInode *inode, gchar *name);
204 uint64_t bluesky_directory_ilookup(BlueSkyInode *inode, gchar *name);
205 gboolean bluesky_directory_insert(BlueSkyInode *dir, const gchar *name,
206                                   uint64_t inum);
207 void bluesky_directory_dump(BlueSkyInode *dir);
208
209 void bluesky_block_touch(BlueSkyInode *inode, uint64_t i);
210 void bluesky_block_fetch(BlueSkyFS *fs, BlueSkyBlock *block);
211 void bluesky_block_flush(BlueSkyFS *fs, BlueSkyBlock *block);
212 void bluesky_file_truncate(BlueSkyInode *inode, uint64_t size);
213 void bluesky_file_write(BlueSkyInode *inode, uint64_t offset,
214                         const char *data, gint len);
215 void bluesky_file_read(BlueSkyInode *inode, uint64_t offset,
216                        char *buf, gint len);
217
218 void bluesky_inode_flush(BlueSkyFS *fs, BlueSkyInode *inode);
219 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum);
220
221 gint bluesky_dirent_compare(gconstpointer a, gconstpointer b,
222                             gpointer unused);
223
224 #ifdef __cplusplus
225 }
226 #endif
227
228 #endif