refactor: move log out of record state access

Author: diegonehab

src/machine.cpp

@@ -2376,7 +2376,8 @@ access_log machine::log_reset_uarch(const access_log::type &log_type) {
     hash_type root_hash_before;
     get_root_hash(root_hash_before);
     // Call uarch_reset_state with a uarch_record_state_access object
-    uarch_record_state_access a(*this, log_type);
+    access_log log(log_type);
+    uarch_record_state_access a(*this, log);
     {
         [[maybe_unused]] auto note = a.make_scoped_note("reset_uarch_state");
         uarch_reset_state(a);
@@ -2385,8 +2386,8 @@ access_log machine::log_reset_uarch(const access_log::type &log_type) {
     hash_type root_hash_after;
     update_merkle_tree();
     get_root_hash(root_hash_after);
-    verify_reset_uarch(root_hash_before, *a.get_log(), root_hash_after);
-    return std::move(*a.get_log());
+    verify_reset_uarch(root_hash_before, log, root_hash_after);
+    return log;
 }
 
 void machine::verify_reset_uarch(const hash_type &root_hash_before, const access_log &log,
@@ -2412,17 +2413,18 @@ access_log machine::log_step_uarch(const access_log::type &log_type) {
     }
     hash_type root_hash_before;
     get_root_hash(root_hash_before);
+    access_log log(log_type);
     // Call interpret with a logged state access object
-    uarch_record_state_access a(*this, log_type);
+    uarch_record_state_access a(*this, log);
     {
         [[maybe_unused]] auto note = a.make_scoped_note("step");
         uarch_step(a);
     }
     // Verify access log before returning
     hash_type root_hash_after;
     get_root_hash(root_hash_after);
-    verify_step_uarch(root_hash_before, *a.get_log(), root_hash_after);
-    return std::move(*a.get_log());
+    verify_step_uarch(root_hash_before, log, root_hash_after);
+    return log;
 }
 
 // Declaration of explicit instantiation in module uarch-step.cpp

src/scoped-note.h

@@ -23,15 +23,15 @@ namespace cartesi {
 template <typename STATE_ACCESS>
 class scoped_note {
 
-    STATE_ACCESS &m_a;
+    STATE_ACCESS m_a;
     const char *const m_text; ///< String with the text for the annotation
 
 public:
     /// \brief Constructor adds the "begin" bracketing note
     /// \param a State access receiving annotations
     /// \param text Pointer to annotation text (must be valid until destruction)
     /// \details A note is added at the moment of construction and destruction
-    scoped_note(STATE_ACCESS &a, const char *text) : m_a{a}, m_text(text) {
+    scoped_note(STATE_ACCESS a, const char *text) : m_a{a}, m_text(text) {
         m_a.push_begin_bracket(m_text);
     }
 

src/uarch-record-state-access.h

@@ -22,7 +22,6 @@
 #include <cassert>
 #include <cstdint>
 #include <cstring>
-#include <memory>
 #include <stdexcept>
 #include <string>
 #include <utility>
@@ -61,8 +60,8 @@ class uarch_record_state_access :
 
     // NOLINTBEGIN(cppcoreguidelines-avoid-const-or-ref-data-members)
     machine &m_m; ///< Macro machine
+    access_log &m_log; ///< Access log
     // NOLINTEND(cppcoreguidelines-avoid-const-or-ref-data-members)
-    std::shared_ptr<access_log> m_log; ///< Pointer to access log
 
     static auto get_hash(hasher_type &hasher, const access_data &data) {
         hash_type hash{};
@@ -72,35 +71,14 @@ class uarch_record_state_access :
 
 public:
     /// \brief Constructor from machine and uarch states.
-    /// \param um Reference to uarch state.
     /// \param m Reference to machine state.
-    explicit uarch_record_state_access(machine &m, access_log::type log_type) :
+    /// \param log Reference to log.
+    explicit uarch_record_state_access(machine &m, access_log &log) :
         m_m(m),
-        m_log(std::make_shared<access_log>(log_type)) {
+        m_log(log) {
         ;
     }
 
-    /// \brief No copy constructor
-    uarch_record_state_access(const uarch_record_state_access &) = delete;
-    /// \brief No copy assignment
-    uarch_record_state_access &operator=(const uarch_record_state_access &) = delete;
-    /// \brief No move constructor
-    uarch_record_state_access(uarch_record_state_access &&) = delete;
-    /// \brief No move assignment
-    uarch_record_state_access &operator=(uarch_record_state_access &&) = delete;
-    /// \brief Default destructor
-    ~uarch_record_state_access() = default;
-
-    /// \brief Returns const pointer to access log.
-    std::shared_ptr<const access_log> get_log() const {
-        return m_log;
-    }
-
-    /// \brief Returns pointer to access log.
-    std::shared_ptr<access_log> get_log() {
-        return m_log;
-    }
-
 private:
     static std::pair<uint64_t, int> adjust_access(uint64_t paddr, int log2_size) {
         static_assert(cartesi::log2_size_v<uint64_t> <= machine_merkle_tree::get_log2_word_size(),
@@ -115,7 +93,7 @@ class uarch_record_state_access :
     }
 
     void log_access(access &&a, const char *text) const {
-        m_log->push_access(std::move(a), text);
+        m_log.push_access(std::move(a), text);
     }
 
     static void log_access_type(access &a, access_type type) {
@@ -150,7 +128,7 @@ class uarch_record_state_access :
     }
 
     void log_read_data_if_requested(access &a, uint64_t paddr, int log2_size) const {
-        if (m_log->get_log_type().has_large_data()) {
+        if (m_log.get_log_type().has_large_data()) {
             std::ignore = log_read_data(a, paddr, log2_size);
         }
     }
@@ -165,7 +143,7 @@ class uarch_record_state_access :
     }
 
     void log_written_data_if_requested(access &a, uint64_t paddr, int log2_size) const {
-        if (m_log->get_log_type().has_large_data()) {
+        if (m_log.get_log_type().has_large_data()) {
             log_written_data(a, paddr, log2_size);
         }
     }
@@ -320,11 +298,11 @@ class uarch_record_state_access :
     friend i_accept_scoped_note<uarch_record_state_access>;
 
     void do_push_begin_bracket(const char *text) {
-        m_log->push_begin_bracket(text);
+        m_log.push_begin_bracket(text);
     }
 
     void do_push_end_bracket(const char *text) {
-        m_log->push_end_bracket(text);
+        m_log.push_end_bracket(text);
     }
 
     auto do_make_scoped_note(const char *text) {