From 7f146b6a8c927ea0a0fa0a3a7e25b74ee095a8ac Mon Sep 17 00:00:00 2001
From: Sergej Schumilo <sergej@schumilo.de>
Date: Sun, 23 Jul 2023 14:52:13 +0200
Subject: [PATCH] add yaml serializer for snapshot meta data

---
 nyx/fast_vm_reload_sync.c  |  2 +
 nyx/state/snapshot_state.c | 83 ++++++++++++++++++++++++++++++++++++++
 nyx/state/snapshot_state.h |  2 +
 3 files changed, 87 insertions(+)

diff --git a/nyx/fast_vm_reload_sync.c b/nyx/fast_vm_reload_sync.c
index 165c417132..8db2dc0ace 100644
--- a/nyx/fast_vm_reload_sync.c
+++ b/nyx/fast_vm_reload_sync.c
@@ -131,6 +131,8 @@ static inline void create_root_snapshot(void)
             fast_reload_create_in_memory(get_fast_reload_snapshot());
             fast_reload_serialize_to_file(get_fast_reload_snapshot(),
                                           GET_GLOBAL_STATE()->fast_reload_path, false);
+
+            serialize_root_snapshot_meta_data(GET_GLOBAL_STATE()->fast_reload_path);
         }
     } else {
         nyx_debug("===> GET_GLOBAL_STATE()->fast_reload_enabled: FALSE\n");
diff --git a/nyx/state/snapshot_state.c b/nyx/state/snapshot_state.c
index b7b62d2933..a10ec84227 100644
--- a/nyx/state/snapshot_state.c
+++ b/nyx/state/snapshot_state.c
@@ -152,3 +152,86 @@ void deserialize_state(const char *filename_prefix)
 
     free(tmp);
 }
+
+static bool yaml_write_bool(FILE *fp, const char *key, bool value)
+{
+    return fprintf(fp, "    %s: %s\n", key, value ? "true" : "false") != -1;
+}
+
+static bool yaml_write_uint64(FILE *fp, const char *key, uint64_t value)
+{
+    return fprintf(fp, "    %s: 0x%" PRIx64 "\n", key, value) != -1;
+}
+
+static bool yaml_write_uint64_range(FILE *fp, const char *key, uint64_t value_a, uint64_t value_b)
+{
+    return fprintf(fp, "    %s: [0x%" PRIx64 ", 0x%" PRIx64 "]\n", key, value_a, value_b) != -1;
+}
+
+/* Helper function to serialize the meta data of a snapshot to yaml.
+ * This function is only called in case a root snapshot is created.
+ * The data written to the yaml file is not used later on, but can be used
+ * by the frontend to get specific information about the snapshot.
+ */
+void serialize_root_snapshot_meta_data(const char *snapshot_dir){
+    nyx_trace();
+
+    char *tmp;
+
+    assert(asprintf(&tmp, "%s/state.yaml", snapshot_dir) != -1);
+
+    FILE *fp = fopen(tmp, "wb");
+    if (fp == NULL) {
+        nyx_error("[%s] Could not open file %s.\n", __func__, tmp);
+        assert(false);
+    }
+
+    qemu_nyx_state_t *nyx_global_state = GET_GLOBAL_STATE();
+
+    assert(fprintf(fp, "---\n") != -1);
+
+    assert(fprintf(fp, "process_trace:\n") != 1);
+    for (uint8_t i = 0; i < 4; i++) {
+        char* key = NULL;
+        assert(asprintf(&key, "pt_ip_filter_configured_%d", i) != -1);
+        assert(yaml_write_bool(fp, key, nyx_global_state->pt_ip_filter_configured[i]));
+        free(key);
+    }
+
+    for (uint8_t i = 0; i < 4; i++) {
+        char* key = NULL;
+        assert(asprintf(&key, "pt_ip_filter_%d", i) != -1);
+        assert(yaml_write_uint64_range(fp, key, nyx_global_state->pt_ip_filter_a[i], nyx_global_state->pt_ip_filter_b[i]));
+        free(key);
+    }
+
+    assert(yaml_write_uint64(fp, "parent_cr3", nyx_global_state->parent_cr3));
+    assert(yaml_write_uint64(fp, "disassembler_word_width", nyx_global_state->disassembler_word_width));
+    //assert(yaml_write_uint64(fp, "fast_reload_pre_image", nyx_global_state->fast_reload_pre_image));
+    assert(yaml_write_uint64(fp, "mem_mode", nyx_global_state->mem_mode)); /* improve? */
+    assert(yaml_write_bool(fp, "pt_trace_mode", nyx_global_state->pt_trace_mode));
+    assert(fprintf(fp, "\n") != -1);
+
+
+    assert(fprintf(fp, "input_buffer:\n") != -1);
+    assert(yaml_write_uint64(fp, "input_buffer_vaddr", nyx_global_state->payload_buffer));
+    assert(yaml_write_bool(fp, "protect_input_buffer", nyx_global_state->protect_payload_buffer));
+    assert(yaml_write_uint64(fp, "input_buffer_size", nyx_global_state->input_buffer_size));
+    assert(fprintf(fp, "\n") != -1);
+
+
+    assert(fprintf(fp, "capabilites:\n") != -1);
+    assert(yaml_write_bool(fp, "cap_timeout_detection", nyx_global_state->cap_timeout_detection));
+    assert(yaml_write_bool(fp, "cap_only_reload_mode", nyx_global_state->cap_only_reload_mode));
+    assert(yaml_write_bool(fp, "cap_compile_time_tracing", nyx_global_state->cap_compile_time_tracing));
+    assert(yaml_write_bool(fp, "cap_ijon_tracing", nyx_global_state->cap_ijon_tracing));
+    assert(yaml_write_bool(fp, "cap_cr3", nyx_global_state->cap_cr3));
+    assert(yaml_write_uint64(fp, "cap_compile_time_tracing_buffer_vaddr", nyx_global_state->cap_compile_time_tracing_buffer_vaddr));
+    assert(yaml_write_uint64(fp, "cap_ijon_tracing_buffer_vaddr", nyx_global_state->cap_ijon_tracing_buffer_vaddr));
+    assert(yaml_write_uint64(fp, "cap_coverage_bitmap_size", nyx_global_state->cap_coverage_bitmap_size));
+    assert(fprintf(fp, "\n") != -1);
+
+    assert(fprintf(fp, "...\n") != -1);
+    fclose(fp);
+    free(tmp);
+}
\ No newline at end of file
diff --git a/nyx/state/snapshot_state.h b/nyx/state/snapshot_state.h
index fa9491795f..c7920709d5 100644
--- a/nyx/state/snapshot_state.h
+++ b/nyx/state/snapshot_state.h
@@ -44,3 +44,5 @@ typedef struct serialized_state_root_snapshot_s {
 
 void serialize_state(const char *filename_prefix, bool is_pre_snapshot);
 void deserialize_state(const char *filename_prefix);
+
+void serialize_root_snapshot_meta_data(const char *snapshot_dir);
\ No newline at end of file