refactor!: make proofs mandatory in access logs

cartesi · Oct 4, 2024 · 7b3e35a · 7b3e35a
1 parent 9c3216a
commit 7b3e35a
Show file tree

Hide file tree

Showing 29 changed files with 353 additions and 819 deletions.
diff --git a/src/access-log.h b/src/access-log.h
@@ -224,31 +224,23 @@ class access_log {
 public:
     /// \brief Type of access log
     class type {
-        bool m_proofs;      ///< Includes proofs
         bool m_annotations; ///< Includes annotations
         bool m_large_data;  ///< Includes data bigger than 8 bytes
     public:
         /// \brief Default constructor
-        /// \param proofs Include proofs
         /// \param annotations Include annotations (default false)
-        explicit type(bool proofs, bool annotations = false, bool large_data = false) :
-            m_proofs(proofs),
+        /// \param large_data Include large data (default false)
+        explicit type(bool annotations = false, bool large_data = false) :
             m_annotations(annotations),
             m_large_data(large_data) {
             ;
         }
         explicit type(int log_type) :
-            m_proofs(static_cast<bool>(log_type & CM_ACCESS_LOG_TYPE_PROOFS)),
             m_annotations(static_cast<bool>(log_type & CM_ACCESS_LOG_TYPE_ANNOTATIONS)),
             m_large_data(static_cast<bool>(log_type & CM_ACCESS_LOG_TYPE_LARGE_DATA)) {
             ;
         }
 
-        /// \brief Returns whether log includes proofs
-        bool has_proofs(void) const {
-            return m_proofs;
-        }
-
         /// \brief Returns whether log includes annotations
         bool has_annotations(void) const {
             return m_annotations;

diff --git a/src/cartesi-machine.lua b/src/cartesi-machine.lua
@@ -2150,17 +2150,11 @@ if gdb_stub then gdb_stub:close() end
 if log_step_uarch then
     assert(config.processor.iunrep == 0, "micro step proof is meaningless in unreproducible mode")
     stderr("Gathering micro step log: please wait\n")
-    util.dump_log(
-        machine:log_step_uarch(cartesi.ACCESS_LOG_TYPE_PROOFS | cartesi.ACCESS_LOG_TYPE_ANNOTATIONS),
-        io.stderr
-    )
+    util.dump_log(machine:log_step_uarch(cartesi.ACCESS_LOG_TYPE_ANNOTATIONS), io.stderr)
 end
 if log_reset_uarch then
     stderr("Resetting microarchitecture state: please wait\n")
-    util.dump_log(
-        machine:log_reset_uarch(cartesi.ACCESS_LOG_TYPE_PROOFS | cartesi.ACCESS_LOG_TYPE_ANNOTATIONS),
-        io.stderr
-    )
+    util.dump_log(machine:log_reset_uarch(cartesi.ACCESS_LOG_TYPE_ANNOTATIONS), io.stderr)
 end
 if dump_memory_ranges then dump_pmas(machine) end
 if final_hash then

diff --git a/src/clua-cartesi.cpp b/src/clua-cartesi.cpp
@@ -182,7 +182,6 @@ CM_API int luaopen_cartesi(lua_State *L) {
     clua_setintegerfield(L, CM_BREAK_REASON_REACHED_TARGET_MCYCLE, "BREAK_REASON_REACHED_TARGET_MCYCLE", -1);
     clua_setintegerfield(L, CM_UARCH_BREAK_REASON_REACHED_TARGET_CYCLE, "UARCH_BREAK_REASON_REACHED_TARGET_CYCLE", -1);
     clua_setintegerfield(L, CM_UARCH_BREAK_REASON_UARCH_HALTED, "UARCH_BREAK_REASON_UARCH_HALTED", -1);
-    clua_setintegerfield(L, CM_ACCESS_LOG_TYPE_PROOFS, "ACCESS_LOG_TYPE_PROOFS", -1);
     clua_setintegerfield(L, CM_ACCESS_LOG_TYPE_ANNOTATIONS, "ACCESS_LOG_TYPE_ANNOTATIONS", -1);
     clua_setintegerfield(L, CM_ACCESS_LOG_TYPE_LARGE_DATA, "ACCESS_LOG_TYPE_LARGE_DATA", -1);
     clua_setintegerfield(L, CM_CMIO_YIELD_COMMAND_AUTOMATIC, "CMIO_YIELD_COMMAND_AUTOMATIC", -1);

diff --git a/src/clua-jsonrpc-machine.cpp b/src/clua-jsonrpc-machine.cpp
@@ -62,18 +62,12 @@ static int jsonrpc_machine_class_verify_step_uarch(lua_State *L) {
     lua_settop(L, 5);
     auto &managed_jsonrpc_mgr = clua_check<clua_managed_cm_ptr<cm_jsonrpc_mgr>>(L, stubidx, ctxidx);
     const char *log = clua_check_schemed_json_string(L, 2, "AccessLog", ctxidx);
-    if (!lua_isnil(L, 1) || !lua_isnil(L, 3)) {
-        cm_hash root_hash{};
-        clua_check_cm_hash(L, 1, &root_hash);
-        cm_hash target_hash{};
-        clua_check_cm_hash(L, 3, &target_hash);
-        if (cm_jsonrpc_verify_step_uarch(managed_jsonrpc_mgr.get(), &root_hash, log, &target_hash) != 0) {
-            return luaL_error(L, "%s", cm_get_last_error_message());
-        }
-    } else {
-        if (cm_jsonrpc_verify_step_uarch(managed_jsonrpc_mgr.get(), nullptr, log, nullptr) != 0) {
-            return luaL_error(L, "%s", cm_get_last_error_message());
-        }
+    cm_hash root_hash{};
+    clua_check_cm_hash(L, 1, &root_hash);
+    cm_hash target_hash{};
+    clua_check_cm_hash(L, 3, &target_hash);
+    if (cm_jsonrpc_verify_step_uarch(managed_jsonrpc_mgr.get(), &root_hash, log, &target_hash) != 0) {
+        return luaL_error(L, "%s", cm_get_last_error_message());
     }
     return 0;
 }
@@ -86,18 +80,12 @@ static int jsonrpc_machine_class_verify_reset_uarch(lua_State *L) {
     lua_settop(L, 5);
     auto &managed_jsonrpc_mgr = clua_check<clua_managed_cm_ptr<cm_jsonrpc_mgr>>(L, stubidx, ctxidx);
     const char *log = clua_check_schemed_json_string(L, 2, "AccessLog", ctxidx);
-    if (!lua_isnil(L, 1) || !lua_isnil(L, 3)) {
-        cm_hash root_hash{};
-        clua_check_cm_hash(L, 1, &root_hash);
-        cm_hash target_hash{};
-        clua_check_cm_hash(L, 3, &target_hash);
-        if (cm_jsonrpc_verify_reset_uarch(managed_jsonrpc_mgr.get(), &root_hash, log, &target_hash) != 0) {
-            return luaL_error(L, "%s", cm_get_last_error_message());
-        }
-    } else {
-        if (cm_jsonrpc_verify_reset_uarch(managed_jsonrpc_mgr.get(), nullptr, log, nullptr) != 0) {
-            return luaL_error(L, "%s", cm_get_last_error_message());
-        }
+    cm_hash root_hash{};
+    clua_check_cm_hash(L, 1, &root_hash);
+    cm_hash target_hash{};
+    clua_check_cm_hash(L, 3, &target_hash);
+    if (cm_jsonrpc_verify_reset_uarch(managed_jsonrpc_mgr.get(), &root_hash, log, &target_hash) != 0) {
+        return luaL_error(L, "%s", cm_get_last_error_message());
     }
     return 0;
 }
@@ -114,20 +102,13 @@ static int jsonrpc_machine_class_verify_send_cmio_response(lua_State *L) {
     // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
     const auto *data = reinterpret_cast<const unsigned char *>(luaL_checklstring(L, 2, &length));
     const char *log = clua_check_schemed_json_string(L, 4, "AccessLog", ctxidx);
-    if (!lua_isnil(L, 3) || !lua_isnil(L, 5)) {
-        cm_hash root_hash{};
-        clua_check_cm_hash(L, 3, &root_hash);
-        cm_hash target_hash{};
-        clua_check_cm_hash(L, 5, &target_hash);
-        if (cm_jsonrpc_verify_send_cmio_response(managed_jsonrpc_mgr.get(), reason, data, length, &root_hash, log,
-                &target_hash) != 0) {
-            return luaL_error(L, "%s", cm_get_last_error_message());
-        }
-    } else {
-        if (cm_jsonrpc_verify_send_cmio_response(managed_jsonrpc_mgr.get(), reason, data, length, nullptr, log,
-                nullptr) != 0) {
-            return luaL_error(L, "%s", cm_get_last_error_message());
-        }
+    cm_hash root_hash{};
+    clua_check_cm_hash(L, 3, &root_hash);
+    cm_hash target_hash{};
+    clua_check_cm_hash(L, 5, &target_hash);
+    if (cm_jsonrpc_verify_send_cmio_response(managed_jsonrpc_mgr.get(), reason, data, length, &root_hash, log,
+            &target_hash) != 0) {
+        return luaL_error(L, "%s", cm_get_last_error_message());
     }
     return 0;
 }

diff --git a/src/clua-machine.cpp b/src/clua-machine.cpp
@@ -43,18 +43,12 @@ static int machine_class_index_get_reg_address(lua_State *L) {
 static int machine_class_index_verify_step_uarch(lua_State *L) {
     lua_settop(L, 4);
     const char *log = clua_check_schemed_json_string(L, 2, "AccessLog");
-    if (!lua_isnil(L, 1) || !lua_isnil(L, 3)) {
-        cm_hash root_hash{};
-        clua_check_cm_hash(L, 1, &root_hash);
-        cm_hash target_hash{};
-        clua_check_cm_hash(L, 3, &target_hash);
-        if (cm_verify_step_uarch(&root_hash, log, &target_hash) != 0) {
-            return luaL_error(L, "%s", cm_get_last_error_message());
-        }
-    } else {
-        if (cm_verify_step_uarch(nullptr, log, nullptr) != 0) {
-            return luaL_error(L, "%s", cm_get_last_error_message());
-        }
+    cm_hash root_hash{};
+    clua_check_cm_hash(L, 1, &root_hash);
+    cm_hash target_hash{};
+    clua_check_cm_hash(L, 3, &target_hash);
+    if (cm_verify_step_uarch(&root_hash, log, &target_hash) != 0) {
+        return luaL_error(L, "%s", cm_get_last_error_message());
     }
     return 0;
 }
@@ -63,18 +57,12 @@ static int machine_class_index_verify_step_uarch(lua_State *L) {
 static int machine_class_index_verify_reset_uarch(lua_State *L) {
     lua_settop(L, 4);
     const char *log = clua_check_schemed_json_string(L, 2, "AccessLog");
-    if (!lua_isnil(L, 1) || !lua_isnil(L, 3)) {
-        cm_hash root_hash{};
-        clua_check_cm_hash(L, 1, &root_hash);
-        cm_hash target_hash{};
-        clua_check_cm_hash(L, 3, &target_hash);
-        if (cm_verify_reset_uarch(&root_hash, log, &target_hash) != 0) {
-            return luaL_error(L, "%s", cm_get_last_error_message());
-        }
-    } else {
-        if (cm_verify_reset_uarch(nullptr, log, nullptr) != 0) {
-            return luaL_error(L, "%s", cm_get_last_error_message());
-        }
+    cm_hash root_hash{};
+    clua_check_cm_hash(L, 1, &root_hash);
+    cm_hash target_hash{};
+    clua_check_cm_hash(L, 3, &target_hash);
+    if (cm_verify_reset_uarch(&root_hash, log, &target_hash) != 0) {
+        return luaL_error(L, "%s", cm_get_last_error_message());
     }
     return 0;
 }
@@ -87,18 +75,12 @@ static int machine_class_index_verify_send_cmio_response(lua_State *L) {
     // NOLINTNEXTLINE(cppcoreguidelines-pro-type-reinterpret-cast)
     const auto *data = reinterpret_cast<const unsigned char *>(luaL_checklstring(L, 2, &length));
     const char *log = clua_check_schemed_json_string(L, 4, "AccessLog");
-    if (!lua_isnil(L, 3) || !lua_isnil(L, 5)) {
-        cm_hash root_hash{};
-        clua_check_cm_hash(L, 3, &root_hash);
-        cm_hash target_hash{};
-        clua_check_cm_hash(L, 5, &target_hash);
-        if (cm_verify_send_cmio_response(reason, data, length, &root_hash, log, &target_hash) != 0) {
-            return luaL_error(L, "%s", cm_get_last_error_message());
-        }
-    } else {
-        if (cm_verify_send_cmio_response(reason, data, length, nullptr, log, nullptr) != 0) {
-            return luaL_error(L, "%s", cm_get_last_error_message());
-        }
+    cm_hash root_hash{};
+    clua_check_cm_hash(L, 3, &root_hash);
+    cm_hash target_hash{};
+    clua_check_cm_hash(L, 5, &target_hash);
+    if (cm_verify_send_cmio_response(reason, data, length, &root_hash, log, &target_hash) != 0) {
+        return luaL_error(L, "%s", cm_get_last_error_message());
     }
     return 0;
 }

diff --git a/src/json-util.cpp b/src/json-util.cpp
@@ -1082,13 +1082,11 @@ void ju_get_opt_field(const nlohmann::json &j, const K &key, not_default_constru
     }
     const auto &jk = j[key];
     const auto new_path = path + to_string(key) + "/";
-    bool has_proofs = false;
-    ju_get_field(jk, "has_proofs"s, has_proofs, new_path);
     bool has_annotations = false;
     ju_get_field(jk, "has_annotations"s, has_annotations, new_path);
     bool has_large_data = false;
     ju_get_field(jk, "has_large_data"s, has_large_data, new_path);
-    optional.emplace(has_proofs, has_annotations, has_large_data);
+    optional.emplace(has_annotations, has_large_data);
 }
 
 template void ju_get_opt_field<uint64_t>(const nlohmann::json &j, const uint64_t &key,
@@ -1113,12 +1111,10 @@ void ju_get_opt_field(const nlohmann::json &j, const K &key, not_default_constru
     }
     std::vector<access> accesses;
     ju_get_vector_like_field(jk, "accesses"s, accesses, new_path);
-    if (log_type.value().has_proofs()) {
-        for (unsigned i = 0; i < accesses.size(); ++i) {
-            if (!accesses[i].get_sibling_hashes().has_value()) {
-                throw std::invalid_argument(
-                    "field \""s + new_path + "accesses/" + to_string(i) + "\" missing sibling hashes");
-            }
+    for (unsigned i = 0; i < accesses.size(); ++i) {
+        if (!accesses[i].get_sibling_hashes().has_value()) {
+            throw std::invalid_argument(
+                "field \""s + new_path + "accesses/" + to_string(i) + "\" missing sibling hashes");
         }
     }
     std::vector<bracket_note> brackets;
@@ -1745,8 +1741,7 @@ void to_json(nlohmann::json &j, const std::vector<access> &as) {
 }
 
 void to_json(nlohmann::json &j, const access_log::type &log_type) {
-    j = nlohmann::json{{"has_proofs", log_type.has_proofs()}, {"has_annotations", log_type.has_annotations()},
-        {"has_large_data", log_type.has_large_data()}};
+    j = nlohmann::json{{"has_annotations", log_type.has_annotations()}, {"has_large_data", log_type.has_large_data()}};
 }
 
 void to_json(nlohmann::json &j, const access_log &log) {

diff --git a/src/jsonrpc-discover.json b/src/jsonrpc-discover.json
@@ -235,29 +235,8 @@
     },
 
     {
-      "name": "machine.verify_step_uarch_log",
-      "summary": "Verifies an access log",
-      "params": [ {
-          "name":"log",
-          "description": "Access log to verify",
-          "required": true,
-          "schema": {
-            "$ref": "#/components/schemas/AccessLog"
-          }
-        }
-      ],
-      "result": {
-        "name": "status",
-        "description": "True when operation succeeded",
-        "schema": {
-          "type": "boolean"
-        }
-      }
-    },
-
-    {
-      "name": "machine.verify_step_uarch_state_transition",
-      "summary": "Verifies a state transition",
+      "name": "machine.verify_step_uarch",
+      "summary": "Verifies a state transition caused by log_step_uarch",
       "params": [ {
           "name":"root_hash_before",
           "description": "State hash before transition described by access log",
@@ -291,28 +270,7 @@
     },
 
     {
-      "name": "machine.verify_reset_uarch_log",
-      "summary": "Verifies an access log produced by a log_reset_uarch",
-      "params": [ {
-          "name":"log",
-          "description": "Access log to verify",
-          "required": true,
-          "schema": {
-            "$ref": "#/components/schemas/AccessLog"
-          }
-        }
-      ],
-      "result": {
-        "name": "status",
-        "description": "True when operation succeeded",
-        "schema": {
-          "type": "boolean"
-        }
-      }
-    },
-
-    {
-      "name": "machine.verify_reset_uarch_state_transition",
+      "name": "machine.verify_reset_uarch",
       "summary": "Verifies a state transition caused by log_reset_uarch",
       "params": [ {
           "name":"root_hash_before",
@@ -795,43 +753,8 @@
     },
 
     {
-      "name": "machine.verify_send_cmio_response_log",
-      "summary": "Checks the internal consistency of an access log produced by send_cmio_response",
-      "params": [ {
-        "name":"reason",
-        "description": "Reason for sending response",
-        "required": true,
-        "schema": {
-          "$ref": "#/components/schemas/UnsignedInteger"
-        }
-      }, {
-          "name":"data",
-          "description": "Response data sent when the log was generated.",
-          "required": true,
-          "schema": {
-            "$ref": "#/components/schemas/Base64String"
-          }
-        }, {
-          "name":"log",
-          "description": "Access log to verify",
-          "required": true,
-          "schema": {
-            "$ref": "#/components/schemas/AccessLog"
-          }
-        }
-      ],
-      "result": {
-        "name": "status",
-        "description": "True when operation succeeded",
-        "schema": {
-          "type": "boolean"
-        }
-      }
-    },
-
-    {
-      "name": "machine.verify_send_cmio_response_state_transition",
-      "summary": "Checks the validity of state transitions caused by send_cmio_response",
+      "name": "machine.verify_send_cmio_response",
+      "summary": "Verifies a state transition caused by log_send_cmio_response",
       "params": [ {
         "name":"reason",
         "description": "Reason for sending response",
@@ -1541,9 +1464,6 @@
         "title": "AccessLogType",
         "type": "object",
         "properties": {
-          "has_proofs": {
-            "type": "boolean"
-          },
           "has_annotations": {
             "type": "boolean"
           },
@@ -1552,7 +1472,6 @@
           }
         },
         "required": [
-          "has_proofs",
           "has_annotations",
           "has_large_data"
         ]