Add an option to disable aggregating reads in the proxy
[bluesky.git] / bluesky / bluesky.h
index 8846488..69f215a 100644 (file)
@@ -10,6 +10,7 @@
 #define _BLUESKY_H
 
 #include <stdint.h>
+#include <stdio.h>
 #include <inttypes.h>
 #include <glib.h>
 
@@ -19,10 +20,10 @@ extern "C" {
 
 /* Various options to tweak for performance benchmarking purposes. */
 typedef struct {
-    /* Perform all get/put operations synchronously. */
+    /* OBSOLETE: Perform all get/put operations synchronously. */
     int synchronous_stores;
 
-    /* Write data in cache immediately after file is modified. */
+    /* OBSOLETE: Write data in cache immediately after file is modified. */
     int writethrough_cache;
 
     /* Can inodes be fetched asynchronously?  (Inode object is initially
@@ -33,6 +34,23 @@ typedef struct {
     /* Should frontends handle requests serially or allow operations to proceed
      * in parallel? */
     int sync_frontends;
+
+    /* Target size of the disk cache at the proxy, in kilobytes. */
+    int cache_size;
+
+    /* Full segment fetches (1) or use range requests (0) for fetching segments
+     * from cloud? */
+    int full_segment_fetches;
+
+    /* Disable aggregating of data into log segments.  Each object will be
+     * stored in a separate segment. */
+    int disable_aggregation;
+
+    /* Disable cryptography.  This is for benchmarking purposes. */
+    int disable_crypto;
+
+    /* Disable aggregation of read requests.  Fetch items individually. */
+    int disable_read_aggregation;
 } BlueSkyOptions;
 
 extern BlueSkyOptions bluesky_options;
@@ -50,6 +68,7 @@ struct bluesky_stats {
 struct bluesky_stats *bluesky_stats_new(const char *name);
 void bluesky_stats_add(struct bluesky_stats *stats, int64_t value);
 void bluesky_stats_dump_all();
+void bluesky_stats_run_periodic_dump(FILE *f);
 
 /* BlueSky status and error codes.  Various frontends should translate these to
  * the appropriate error code for whatever protocol they implement. */
@@ -63,48 +82,56 @@ void bluesky_init(void);
 
 gchar *bluesky_lowercase(const gchar *s);
 
-struct _BlueSkyMmap;
-typedef struct _BlueSkyMmap BlueSkyMmap;
+struct BlueSkyCacheFile;
+typedef struct BlueSkyCacheFile BlueSkyCacheFile;
 
 typedef struct {
     gint refcount;
-    BlueSkyMmap *mmap;
+    BlueSkyCacheFile *mmap;
     gchar *data;
     gsize len;
 } BlueSkyRCStr;
 
 BlueSkyRCStr *bluesky_string_new(gpointer data, gsize len);
 BlueSkyRCStr *bluesky_string_new_from_gstring(GString *s);
-BlueSkyRCStr *bluesky_string_new_from_mmap(BlueSkyMmap *mmap,
+BlueSkyRCStr *bluesky_string_new_from_mmap(BlueSkyCacheFile *mmap,
                                            int offset, gsize len);
 void bluesky_string_ref(BlueSkyRCStr *string);
 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);
@@ -131,6 +158,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;
 
@@ -142,11 +171,24 @@ 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.  We track both total data in the caches and dirty data (total
-     * data includes dirty data).  Updates to these variables must be made
-     * atomically. */
-    gint cache_total, cache_dirty;
+     * bytes.  Updates to these variables must be made atomically. */
+    gint cache_dirty;
+
+    /* Like above, but tracking data stored in the cloudlog entries
+     * specifically:
+     *  - cache_log_dirty: data uncommitted to journal and cloud
+     *  - cache_log_writeback: data being written to journal
+     *  - cache_log_journal: data committed to journal
+     *  - cache_log_cloud: data written to cloud as well
+     * Log entries should progress from the top state to the bottom, and are
+     * only ever counted in one category at a time. */
+    gint cache_log_dirty, cache_log_writeback,
+         cache_log_journal, cache_log_cloud;
 
     /* Linked list of inodes, sorted by access/modification times for cache
      * management.  Editing these lists is protected by the filesystem lock; to
@@ -160,9 +202,22 @@ typedef struct {
     /* Mutex for the flush daemon, to prevent concurrent execution. */
     GMutex *flushd_lock;
 
+    /* Used to wait for the cache daemon to free up space */
+    GCond *flushd_cond;
+
     /* 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. */
@@ -250,6 +305,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.
@@ -272,19 +330,18 @@ typedef struct {
 #define BLUESKY_MAX_FILE_SIZE (BLUESKY_BLOCK_SIZE << 24)
 typedef enum {
     BLUESKY_BLOCK_ZERO = 0,     /* Data is all zeroes, not explicitly stored */
-    BLUESKY_BLOCK_REF = 1,      /* Reference to key/value store, not cached */
-    BLUESKY_BLOCK_CACHED = 2,   /* Data is cached in memory, clean */
-    BLUESKY_BLOCK_DIRTY = 3,    /* Data needs to be committed to store */
+    BLUESKY_BLOCK_REF = 1,      /* Reference to cloud log item, data clean */
+    BLUESKY_BLOCK_DIRTY = 2,    /* Data needs to be committed to store */
 } BlueSkyBlockType;
 
 typedef struct {
     BlueSkyBlockType type;
-    BlueSkyRCStr *data;         /* Pointer to data in memory if cached */
-    BlueSkyCloudLog *cloudref;  /* Reference to cloud log entry with data */
+    BlueSkyCloudLog *ref;       /* if REF: cloud log entry with data */
+    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);
 
@@ -314,6 +371,7 @@ void bluesky_file_read(BlueSkyInode *inode, uint64_t offset,
                        char *buf, gint len);
 
 void bluesky_inode_fetch(BlueSkyFS *fs, uint64_t inum);
+void bluesky_inode_prefetch(BlueSkyFS *fs, uint64_t inum);
 
 gint bluesky_dirent_compare(gconstpointer a, gconstpointer b,
                             gpointer unused);
@@ -325,6 +383,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