Commit a basic but functional online cleaner implementation.
[bluesky.git] / bluesky / bluesky.h
index ca3d130..ae751fd 100644 (file)
@@ -10,6 +10,7 @@
 #define _BLUESKY_H
 
 #include <stdint.h>
+#include <stdio.h>
 #include <inttypes.h>
 #include <glib.h>
 
@@ -66,8 +67,8 @@ void bluesky_init(void);
 
 gchar *bluesky_lowercase(const gchar *s);
 
-struct _BlueSkyCacheFile;
-typedef struct _BlueSkyCacheFile BlueSkyCacheFile;
+struct BlueSkyCacheFile;
+typedef struct BlueSkyCacheFile BlueSkyCacheFile;
 
 typedef struct {
     gint refcount;
@@ -85,29 +86,37 @@ void bluesky_string_unref(BlueSkyRCStr *string);
 BlueSkyRCStr *bluesky_string_dup(BlueSkyRCStr *string);
 void bluesky_string_resize(BlueSkyRCStr *string, gsize len);
 
-/* Cryptographic operations. */
-#define CRYPTO_BLOCK_SIZE 16        /* 128-bit AES */
-#define CRYPTO_KEY_SIZE   16
-
-void bluesky_crypt_init();
-void bluesky_crypt_hash_key(const char *keystr, uint8_t *out);
-void bluesky_crypt_random_bytes(guchar *buf, gint len);
-BlueSkyRCStr *bluesky_crypt_encrypt(BlueSkyRCStr *in, const uint8_t *key);
-BlueSkyRCStr *bluesky_crypt_decrypt(BlueSkyRCStr *in, const uint8_t *key);
+struct BlueSkyRangeset;
+typedef struct BlueSkyRangeset BlueSkyRangeset;
+typedef struct {
+    uint64_t start, length;
+    gpointer data;
+} BlueSkyRangesetItem;
+
+BlueSkyRangeset *bluesky_rangeset_new();
+void bluesky_rangeset_free(BlueSkyRangeset *rangeset);
+gboolean bluesky_rangeset_insert(BlueSkyRangeset *rangeset,
+                                 uint64_t start, uint64_t length,
+                                 gpointer data);
+const BlueSkyRangesetItem *bluesky_rangeset_lookup(BlueSkyRangeset *rangeset,
+                                                   uint64_t offset);
+const BlueSkyRangesetItem *bluesky_rangeset_lookup_next(BlueSkyRangeset *rangeset, uint64_t offset);
+void bluesky_rangeset_get_extents(BlueSkyRangeset *rangeset,
+                                  uint64_t *start, uint64_t *length);
 
 /* Storage interface.  This presents a key-value store abstraction, and can
  * have multiple implementations: in-memory, on-disk, in-cloud. */
-struct _BlueSkyStore;
-typedef struct _BlueSkyStore BlueSkyStore;
+struct BlueSkyStore;
+typedef struct BlueSkyStore BlueSkyStore;
 
-struct _BlueSkyLog;
-typedef struct _BlueSkyLog BlueSkyLog;
+struct BlueSkyLog;
+typedef struct BlueSkyLog BlueSkyLog;
 
-struct _BlueSkyCloudLogState;
-typedef struct _BlueSkyCloudLogState BlueSkyCloudLogState;
+struct BlueSkyCloudLogState;
+typedef struct BlueSkyCloudLogState BlueSkyCloudLogState;
 
-struct _BlueSkyCloudLog;
-typedef struct _BlueSkyCloudLog BlueSkyCloudLog;
+struct BlueSkyCloudLog;
+typedef struct BlueSkyCloudLog BlueSkyCloudLog;
 
 void bluesky_store_init();
 BlueSkyStore *bluesky_store_new(const gchar *type);
@@ -134,6 +143,8 @@ typedef enum {
 
 /* Filesystem state.  Each filesystem which is exported is represented by a
  * single bluesky_fs structure in memory. */
+struct BlueSkyCryptKeys;
+
 typedef struct {
     GMutex *lock;
 
@@ -145,6 +156,10 @@ typedef struct {
     BlueSkyLog *log;
     BlueSkyCloudLogState *log_state;
 
+    /* Filesystem crypto keys */
+    char *master_key;
+    struct BlueSkyCryptKeys *keys;
+
     /* Accounting for memory used for caches.  Space is measured in blocks, not
      * bytes.  Updates to these variables must be made atomically. */
     gint cache_dirty;
@@ -178,6 +193,16 @@ typedef struct {
     /* Mapping of object identifiers (blocks, inodes) to physical location (in
      * the local cache or in the logs in the cloud). */
     GHashTable *locations;
+
+    /* The inode map, which maps inode numbers to the location of the most
+     * recent version. */
+    GSequence *inode_map;
+
+    /* Queue for asynchronous cloudlog unrefs, where needed. */
+    GAsyncQueue *unref_queue;
+
+    /* Thread pool for asynchronous inode fetches */
+    GThreadPool *inode_fetch_thread_pool;
 } BlueSkyFS;
 
 /* Inode number of the root directory. */
@@ -265,6 +290,9 @@ typedef struct {
 
     /* Symlink-specific fields */
     gchar *symlink_contents;
+
+    /* A field for short-term use internally while the lock is held. */
+    gpointer private_data;
 } BlueSkyInode;
 
 /* A directory entry.  The name is UTF-8 and is a freshly-allocated string.
@@ -297,8 +325,8 @@ typedef struct {
     BlueSkyRCStr *dirty;        /* if DIRTY: raw data in memory */
 } BlueSkyBlock;
 
-BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store);
-void bluesky_superblock_flush(BlueSkyFS *fs);
+BlueSkyFS *bluesky_init_fs(gchar *name, BlueSkyStore *store,
+                           const gchar *master_key);
 
 gboolean bluesky_inode_is_ready(BlueSkyInode *inode);
 
@@ -339,6 +367,22 @@ void bluesky_flushd_thread_launch(BlueSkyFS *fs);
 
 void bluesky_debug_dump(BlueSkyFS *fs);
 
+/* Request response time tracking. */
+typedef struct BlueSkyProfile {
+    int magic;
+    GMutex *lock;
+    char *description;
+    GList *events;
+} BlueSkyProfile;
+
+BlueSkyProfile *bluesky_profile_new();
+void bluesky_profile_free(BlueSkyProfile *profile);
+void bluesky_profile_add_event(BlueSkyProfile *profile, char *message);
+void bluesky_profile_print(BlueSkyProfile *profile);
+BlueSkyProfile *bluesky_profile_get();
+void bluesky_profile_set(BlueSkyProfile *profile);
+void bluesky_profile_set_output(FILE *stream);
+
 #ifdef __cplusplus
 }
 #endif