refactor: change collect APIs to use mcycle_end instead of mcycle_count

Author: edubart

src/clua-i-machine.cpp

@@ -991,13 +991,15 @@ static int machine_obj_index_create(lua_State *L) {
 /// \brief This is the machine:collect_mcycle_root_hashes() method implementation.
 /// \param L Lua state.
 static int machine_obj_index_collect_mcycle_root_hashes(lua_State *L) {
-    lua_settop(L, 4);
+    lua_settop(L, 5);
     auto &m = clua_check<clua_managed_cm_ptr<cm_machine>>(L, 1);
-    const uint64_t mcycle_phase = luaL_checkinteger(L, 2);
+    const uint64_t mcycle_end = luaL_checkinteger(L, 2);
     const uint64_t mcycle_period = luaL_checkinteger(L, 3);
-    const uint64_t period_count = luaL_checkinteger(L, 4);
+    const uint64_t mcycle_phase = luaL_optinteger(L, 4, 0);
+    const auto log2_bundle_uarch_cycle_count = static_cast<uint32_t>(luaL_optinteger(L, 5, 0));
     const char *result = nullptr;
-    if (cm_collect_mcycle_root_hashes(m.get(), mcycle_phase, mcycle_period, period_count, &result) != 0) {
+    if (cm_collect_mcycle_root_hashes(m.get(), mcycle_end, mcycle_period, mcycle_phase, log2_bundle_uarch_cycle_count,
+            &result) != 0) {
         return luaL_error(L, "%s", cm_get_last_error_message());
     }
     clua_push_schemed_json_table(L, result, "McycleRootHashes");
@@ -1007,11 +1009,12 @@ static int machine_obj_index_collect_mcycle_root_hashes(lua_State *L) {
 /// \brief This is the machine:collect_uarch_cycle_root_hashes() method implementation.
 /// \param L Lua state.
 static int machine_obj_index_collect_uarch_cycle_root_hashes(lua_State *L) {
-    lua_settop(L, 2);
+    lua_settop(L, 3);
     auto &m = clua_check<clua_managed_cm_ptr<cm_machine>>(L, 1);
-    const uint64_t mcycle_count = luaL_checkinteger(L, 2);
+    const uint64_t mcycle_end = luaL_checkinteger(L, 2);
+    const auto log2_bundle_uarch_cycle_count = static_cast<uint32_t>(luaL_optinteger(L, 3, 0));
     const char *result = nullptr;
-    if (cm_collect_uarch_cycle_root_hashes(m.get(), mcycle_count, &result) != 0) {
+    if (cm_collect_uarch_cycle_root_hashes(m.get(), mcycle_end, log2_bundle_uarch_cycle_count, &result) != 0) {
         return luaL_error(L, "%s", cm_get_last_error_message());
     }
     clua_push_schemed_json_table(L, result, "UarchCycleRootHashes");

src/i-machine.h

@@ -87,11 +87,11 @@ class i_machine {
         return do_run(mcycle_end);
     }
 
-    /// \brief Collects the root hashes after every \p mcycle_period machine cycles, for \p period_count periods.
-    /// Returns when done, or if the machine halts or yields.
-    void collect_mcycle_root_hashes(uint64_t mcycle_phase, uint64_t mcycle_period, uint64_t period_count,
-        mcycle_root_hashes &result) {
-        do_collect_mcycle_root_hashes(mcycle_phase, mcycle_period, period_count, result);
+    /// \brief Collects the root hashes after every \p mcycle_period machine cycles until mcycle reaches \p mcycle_end,
+    /// or if the machine halts or yields.
+    void collect_mcycle_root_hashes(uint64_t mcycle_end, uint64_t mcycle_period, uint64_t mcycle_phase,
+        uint32_t log2_bundle_mcycle_count, mcycle_root_hashes &result) {
+        do_collect_mcycle_root_hashes(mcycle_end, mcycle_period, mcycle_phase, log2_bundle_mcycle_count, result);
     }
 
     /// \brief Serialize entire state to directory
@@ -227,10 +227,11 @@ class i_machine {
         return do_run_uarch(uarch_cycle_end);
     }
 
-    /// \brief Collects the root hashes after every \p uarch_cycle, for \p mcycle_count machine cycles, implicitly
+    /// \brief Collects the root hashes after every \p uarch_cycle until \p mcycle_end machine cycle, implicitly
     /// resetting the uarch between mcycles.
-    void collect_uarch_cycle_root_hashes(uint64_t mcycle_count, uarch_cycle_root_hashes &result) {
-        do_collect_uarch_cycle_root_hashes(mcycle_count, result);
+    void collect_uarch_cycle_root_hashes(uint64_t mcycle_end, uint32_t log2_bundle_uarch_cycle_count,
+        uarch_cycle_root_hashes &result) {
+        do_collect_uarch_cycle_root_hashes(mcycle_end, log2_bundle_uarch_cycle_count, result);
     }
 
     /// \brief Returns a list of descriptions for all PMA entries registered in the machine, sorted by start
@@ -295,8 +296,8 @@ class i_machine {
         const std::string &dir) = 0;
     virtual void do_load(const std::string &directory, const machine_runtime_config &runtime, sharing_mode sharing) = 0;
     virtual interpreter_break_reason do_run(uint64_t mcycle_end) = 0;
-    virtual void do_collect_mcycle_root_hashes(uint64_t mcycle_phase, uint64_t mcycle_period, uint64_t period_count,
-        mcycle_root_hashes &result) = 0;
+    virtual void do_collect_mcycle_root_hashes(uint64_t mcycle_end, uint64_t mcycle_period, uint64_t mcycle_phase,
+        uint32_t log2_bundle_mcycle_count, mcycle_root_hashes &result) = 0;
     virtual void do_store(const std::string &dir, sharing_mode sharing) const = 0;
     virtual void do_clone_stored(const std::string &from_dir, const std::string &to_dir) const = 0;
     virtual interpreter_break_reason do_log_step(uint64_t mcycle_count, const std::string &filename) = 0;
@@ -322,7 +323,8 @@ class i_machine {
     virtual void do_reset_uarch() = 0;
     virtual access_log do_log_reset_uarch(const access_log::type &log_type) = 0;
     virtual uarch_interpreter_break_reason do_run_uarch(uint64_t uarch_cycle_end) = 0;
-    virtual void do_collect_uarch_cycle_root_hashes(uint64_t mcycle_count, uarch_cycle_root_hashes &result) = 0;
+    virtual void do_collect_uarch_cycle_root_hashes(uint64_t mcycle_end, uint32_t log2_bundle_uarch_cycle_count,
+        uarch_cycle_root_hashes &result) = 0;
     virtual address_range_descriptions do_get_address_ranges() const = 0;
     virtual void do_send_cmio_response(uint16_t reason, const unsigned char *data, uint64_t length) = 0;
     virtual access_log do_log_send_cmio_response(uint16_t reason, const unsigned char *data, uint64_t length,

src/jsonrpc-discover.json

@@ -280,8 +280,8 @@
       "summary": "Collect root hashes periodically while running the emulator",
       "params": [
         {
-          "name": "mcycle_phase",
-          "description": "Number of machine cycles elapsed since last root hash collected",
+          "name": "mcycle_end",
+          "description": "End machine cycle value",
           "required": true,
           "schema": {
             "$ref": "#/components/schemas/UnsignedInteger"
@@ -296,8 +296,16 @@
           }
         },
         {
-          "name": "period_count",
-          "description": "Number of hashes to collect",
+          "name": "mcycle_phase",
+          "description": "Number of machine cycles elapsed since last root hash collected",
+          "required": true,
+          "schema": {
+            "$ref": "#/components/schemas/UnsignedInteger"
+          }
+        },
+        {
+          "name": "log2_bundle_mcycle_count",
+          "description": "Log base 2 of the amount of mcycle root hashes to bundle",
           "required": true,
           "schema": {
             "$ref": "#/components/schemas/UnsignedInteger"
@@ -338,8 +346,16 @@
       "summary": "Collect root hashes while running the emulator's uarch",
       "params": [
         {
-          "name": "mcycle_count",
-          "description": "Number of machine cycles to execute, uarch cycle by uarch cycle",
+          "name": "mcycle_end",
+          "description": "End machine cycle value to execute, uarch cycle by uarch cycle",
+          "required": true,
+          "schema": {
+            "$ref": "#/components/schemas/UnsignedInteger"
+          }
+        },
+        {
+          "name": "log2_bundle_uarch_cycle_count",
+          "description": "Log base 2 of the amount of uarch cycle root hashes to bundle",
           "required": true,
           "schema": {
             "$ref": "#/components/schemas/UnsignedInteger"

src/jsonrpc-machine.cpp

@@ -645,9 +645,10 @@ interpreter_break_reason jsonrpc_machine::do_run(uint64_t mcycle_end) {
     return result;
 }
 
-void jsonrpc_machine::do_collect_mcycle_root_hashes(uint64_t mcycle_phase, uint64_t mcycle_period,
-    uint64_t period_count, mcycle_root_hashes &result) {
-    request("machine.collect_mcycle_root_hashes", std::tie(mcycle_phase, mcycle_period, period_count), result);
+void jsonrpc_machine::do_collect_mcycle_root_hashes(uint64_t mcycle_end, uint64_t mcycle_period, uint64_t mcycle_phase,
+    uint32_t log2_bundle_mcycle_count, mcycle_root_hashes &result) {
+    request("machine.collect_mcycle_root_hashes",
+        std::tie(mcycle_end, mcycle_period, mcycle_phase, log2_bundle_mcycle_count), result);
 }
 
 interpreter_break_reason jsonrpc_machine::do_log_step(uint64_t mcycle_count, const std::string &filename) {
@@ -816,8 +817,9 @@ uarch_interpreter_break_reason jsonrpc_machine::do_run_uarch(uint64_t uarch_cycl
     return result;
 }
 
-void jsonrpc_machine::do_collect_uarch_cycle_root_hashes(uint64_t mcycle_count, uarch_cycle_root_hashes &result) {
-    request("machine.collect_uarch_cycle_root_hashes", std::tie(mcycle_count), result);
+void jsonrpc_machine::do_collect_uarch_cycle_root_hashes(uint64_t mcycle_end, uint32_t log2_bundle_uarch_cycle_count,
+    uarch_cycle_root_hashes &result) {
+    request("machine.collect_uarch_cycle_root_hashes", std::tie(mcycle_end, log2_bundle_uarch_cycle_count), result);
 }
 
 address_range_descriptions jsonrpc_machine::do_get_address_ranges() const {

src/jsonrpc-machine.h

@@ -108,8 +108,8 @@ class jsonrpc_machine final : public i_machine {
         const std::string &dir) override;
     void do_load(const std::string &directory, const machine_runtime_config &runtime, sharing_mode sharing) override;
     interpreter_break_reason do_run(uint64_t mcycle_end) override;
-    void do_collect_mcycle_root_hashes(uint64_t mcycle_phase, uint64_t mcycle_period, uint64_t period_count,
-        mcycle_root_hashes &result) override;
+    void do_collect_mcycle_root_hashes(uint64_t mcycle_end, uint64_t mcycle_period, uint64_t mcycle_phase,
+        uint32_t log2_bundle_mcycle_count, mcycle_root_hashes &result) override;
     interpreter_break_reason do_log_step(uint64_t mcycle_count, const std::string &filename) override;
     void do_store(const std::string &dir, sharing_mode sharing) const override;
     void do_clone_stored(const std::string &from_dir, const std::string &to_dir) const override;
@@ -136,7 +136,8 @@ class jsonrpc_machine final : public i_machine {
     hash_tree_stats do_get_hash_tree_stats(bool clear) override;
     bool do_verify_hash_tree() const override;
     uarch_interpreter_break_reason do_run_uarch(uint64_t uarch_cycle_end) override;
-    void do_collect_uarch_cycle_root_hashes(uint64_t mcycle_count, uarch_cycle_root_hashes &result) override;
+    void do_collect_uarch_cycle_root_hashes(uint64_t mcycle_end, uint32_t log2_bundle_uarch_cycle_count,
+        uarch_cycle_root_hashes &result) override;
     address_range_descriptions do_get_address_ranges() const override;
     void do_send_cmio_response(uint16_t reason, const unsigned char *data, uint64_t length) override;
     access_log do_log_send_cmio_response(uint16_t reason, const unsigned char *data, uint64_t length,

src/jsonrpc-remote-machine.cpp

@@ -909,13 +909,15 @@ static json jsonrpc_machine_collect_mcycle_root_hashes(const json &j, const std:
     if (!session->handler->machine) {
         return jsonrpc_response_invalid_request(j, "no machine");
     }
-    static const char *param_name[] = {"mcycle_phase", "mcycle_period", "period_count"};
-    auto args = parse_args<uint64_t, uint64_t, uint64_t>(j, param_name);
-    auto mcycle_phase = std::get<0>(args);
+    static const char *param_name[] = {"mcycle_end", "mcycle_period", "mcycle_phase", "log2_bundle_mcycle_count"};
+    auto args = parse_args<uint64_t, uint64_t, uint64_t, uint64_t>(j, param_name);
+    auto mcycle_end = std::get<0>(args);
     auto mcycle_period = std::get<1>(args);
-    auto period_count = std::get<2>(args);
+    auto mcycle_phase = std::get<2>(args);
+    auto log2_bundle_mcycle_count = std::get<3>(args);
     cartesi::mcycle_root_hashes result;
-    session->handler->machine->collect_mcycle_root_hashes(mcycle_phase, mcycle_period, period_count, result);
+    session->handler->machine->collect_mcycle_root_hashes(mcycle_end, mcycle_period, mcycle_phase,
+        log2_bundle_mcycle_count, result);
     return jsonrpc_response_ok(j, result);
 }
 
@@ -928,11 +930,12 @@ static json jsonrpc_machine_collect_uarch_cycle_root_hashes(const json &j,
     if (!session->handler->machine) {
         return jsonrpc_response_invalid_request(j, "no machine");
     }
-    static const char *param_name[] = {"mcycle_count"};
-    auto args = parse_args<uint64_t>(j, param_name);
-    auto mcycle_count = std::get<0>(args);
+    static const char *param_name[] = {"mcycle_end", "log2_bundle_uarch_cycle_count"};
+    auto args = parse_args<uint64_t, uint64_t>(j, param_name);
+    auto mcycle_end = std::get<0>(args);
+    auto log2_bundle_uarch_cycle_count = std::get<1>(args);
     cartesi::uarch_cycle_root_hashes result;
-    session->handler->machine->collect_uarch_cycle_root_hashes(mcycle_count, result);
+    session->handler->machine->collect_uarch_cycle_root_hashes(mcycle_end, log2_bundle_uarch_cycle_count, result);
     return jsonrpc_response_ok(j, result);
 }
 

src/local-machine.cpp

@@ -78,9 +78,10 @@ interpreter_break_reason local_machine::do_run(uint64_t mcycle_end) {
     return get_machine()->run(mcycle_end);
 }
 
-void local_machine::do_collect_mcycle_root_hashes(uint64_t mcycle_phase, uint64_t mcycle_period, uint64_t period_count,
-    mcycle_root_hashes &result) {
-    get_machine()->collect_mcycle_root_hashes(mcycle_phase, mcycle_period, period_count, result);
+void local_machine::do_collect_mcycle_root_hashes(uint64_t mcycle_end, uint64_t mcycle_period, uint64_t mcycle_phase,
+    uint32_t log2_bundle_mcycle_count, mcycle_root_hashes &result) {
+    get_machine()->collect_mcycle_root_hashes(mcycle_end, mcycle_period, mcycle_phase, log2_bundle_mcycle_count,
+        result);
 }
 
 interpreter_break_reason local_machine::do_log_step(uint64_t mcycle_count, const std::string &filename) {
@@ -180,8 +181,9 @@ uarch_interpreter_break_reason local_machine::do_run_uarch(uint64_t uarch_cycle_
     return get_machine()->run_uarch(uarch_cycle_end);
 }
 
-void local_machine::do_collect_uarch_cycle_root_hashes(uint64_t mcycle_count, uarch_cycle_root_hashes &result) {
-    get_machine()->collect_uarch_cycle_root_hashes(mcycle_count, result);
+void local_machine::do_collect_uarch_cycle_root_hashes(uint64_t mcycle_end, uint32_t log2_bundle_uarch_cycle_count,
+    uarch_cycle_root_hashes &result) {
+    get_machine()->collect_uarch_cycle_root_hashes(mcycle_end, log2_bundle_uarch_cycle_count, result);
 }
 
 address_range_descriptions local_machine::do_get_address_ranges() const {

src/local-machine.h

@@ -50,8 +50,8 @@ class local_machine : public i_machine {
         const std::string &dir) override;
     void do_load(const std::string &directory, const machine_runtime_config &runtime, sharing_mode sharing) override;
     interpreter_break_reason do_run(uint64_t mcycle_end) override;
-    void do_collect_mcycle_root_hashes(uint64_t mcycle_phase, uint64_t mcycle_period, uint64_t period_count,
-        mcycle_root_hashes &result) override;
+    void do_collect_mcycle_root_hashes(uint64_t mcycle_end, uint64_t mcycle_period, uint64_t mcycle_phase,
+        uint32_t log2_bundle_mcycle_count, mcycle_root_hashes &result) override;
     interpreter_break_reason do_log_step(uint64_t mcycle_count, const std::string &filename) override;
     void do_store(const std::string &directory, sharing_mode sharing) const override;
     void do_clone_stored(const std::string &from_dir, const std::string &to_dir) const override;
@@ -78,7 +78,8 @@ class local_machine : public i_machine {
     void do_reset_uarch() override;
     access_log do_log_reset_uarch(const access_log::type &log_type) override;
     uarch_interpreter_break_reason do_run_uarch(uint64_t uarch_cycle_end) override;
-    void do_collect_uarch_cycle_root_hashes(uint64_t mcycle_count, uarch_cycle_root_hashes &result) override;
+    void do_collect_uarch_cycle_root_hashes(uint64_t mcycle_end, uint32_t log2_bundle_uarch_cycle_count,
+        uarch_cycle_root_hashes &result) override;
     address_range_descriptions do_get_address_ranges() const override;
     void do_send_cmio_response(uint16_t reason, const unsigned char *data, uint64_t length) override;
     access_log do_log_send_cmio_response(uint16_t reason, const unsigned char *data, uint64_t length,

src/machine-c-api.cpp

@@ -645,14 +645,14 @@ cm_error cm_run(cm_machine *m, uint64_t mcycle_end, cm_break_reason *break_reaso
     return cm_result_failure();
 }
 
-cm_error cm_collect_mcycle_root_hashes(cm_machine *m, uint64_t mcycle_phase, uint64_t mcycle_period,
-    uint64_t period_count, const char **result) try {
+cm_error cm_collect_mcycle_root_hashes(cm_machine *m, uint64_t mcycle_end, uint64_t mcycle_period,
+    uint64_t mcycle_phase, uint32_t log2_bundle_mcycle_count, const char **result) try {
     if (result == nullptr) {
         throw std::invalid_argument("invalid result output");
     }
     auto *cpp_m = convert_from_c(m);
     cartesi::mcycle_root_hashes cpp_res;
-    cpp_m->collect_mcycle_root_hashes(mcycle_phase, mcycle_period, period_count, cpp_res);
+    cpp_m->collect_mcycle_root_hashes(mcycle_end, mcycle_period, mcycle_phase, log2_bundle_mcycle_count, cpp_res);
     *result = cm_set_temp_string(cartesi::to_json(cpp_res).dump());
     return cm_result_success();
 } catch (...) {
@@ -662,13 +662,14 @@ cm_error cm_collect_mcycle_root_hashes(cm_machine *m, uint64_t mcycle_phase, uin
     return cm_result_failure();
 }
 
-cm_error cm_collect_uarch_cycle_root_hashes(cm_machine *m, uint64_t mcycle_count, const char **result) try {
+cm_error cm_collect_uarch_cycle_root_hashes(cm_machine *m, uint64_t mcycle_end, uint32_t log2_bundle_uarch_cycle_count,
+    const char **result) try {
     if (result == nullptr) {
         throw std::invalid_argument("invalid result output");
     }
     auto *cpp_m = convert_from_c(m);
     cartesi::uarch_cycle_root_hashes cpp_res;
-    cpp_m->collect_uarch_cycle_root_hashes(mcycle_count, cpp_res);
+    cpp_m->collect_uarch_cycle_root_hashes(mcycle_end, log2_bundle_uarch_cycle_count, cpp_res);
     *result = cm_set_temp_string(cartesi::to_json(cpp_res).dump());
     return cm_result_success();
 } catch (...) {