feat: resolve PR comments

cartesi · Oct 28, 2024 · c6543dc · c6543dc
1 parent 274aba0
commit c6543dc
Show file tree

Hide file tree

Showing 8 changed files with 46 additions and 19 deletions.
diff --git a/helper_scripts/generate_EmulatorConstants.lua b/helper_scripts/generate_EmulatorConstants.lua
@@ -16,7 +16,8 @@ end
 local out = io.stdout
 
 out:write('    uint64 constant UARCH_CYCLE_ADDRESS = 0x' .. hex(cartesi.machine.get_csr_address("uarch_cycle")) .. ';\n')
-out:write('    uint64 constant UARCH_HALT_FLAG_ADDRESS = 0x' .. hex(cartesi.machine.get_csr_address("uarch_halt_flag")) .. ';\n')
+out:write('    uint64 constant UARCH_HALT_FLAG_ADDRESS = 0x' ..
+    hex(cartesi.machine.get_csr_address("uarch_halt_flag")) .. ';\n')
 out:write('    uint64 constant UARCH_PC_ADDRESS = 0x' .. hex(cartesi.machine.get_csr_address("uarch_pc")) .. ';\n')
 out:write('    uint64 constant UARCH_X0_ADDRESS = 0x' .. hex(cartesi.machine.get_uarch_x_address(0)) .. ';\n')
 out:write('    uint64 constant UARCH_SHADOW_START_ADDRESS = 0x' .. hex(cartesi.UARCH_SHADOW_START_ADDRESS) .. ';\n')
@@ -29,11 +30,14 @@ out:write('    bytes32 constant UARCH_PRISTINE_STATE_HASH = 0x' .. hexstring(car
 out:write('    uint64 constant UARCH_ECALL_FN_HALT = ' .. cartesi.UARCH_ECALL_FN_HALT .. ';\n')
 out:write('    uint64 constant UARCH_ECALL_FN_PUTCHAR = ' .. cartesi.UARCH_ECALL_FN_PUTCHAR .. ';\n')
 out:write('    uint64 constant IFLAGS_ADDRESS = 0x' .. hex(cartesi.machine.get_csr_address("iflags")) .. ';\n')
-out:write('    uint64 constant HTIF_FROMHOST_ADDRESS = 0x' .. hex(cartesi.machine.get_csr_address("htif_fromhost")) .. ';\n')
+out:write('    uint64 constant HTIF_FROMHOST_ADDRESS = 0x' ..
+    hex(cartesi.machine.get_csr_address("htif_fromhost")) .. ';\n')
+out:write('    uint8 constant HTIF_YIELD_REASON_ADVANCE_STATE = 0x' ..
+    hex(cartesi.machine.HTIF_YIELD_REASON_ADVANCE_STATE) .. ';\n')
 out:write('    uint32 constant TREE_LOG2_WORD_SIZE = 0x' .. hex(cartesi.TREE_LOG2_WORD_SIZE) .. ';\n')
 out:write('    uint32 constant TREE_WORD_SIZE = uint32(1) << TREE_LOG2_WORD_SIZE;\n')
-out:write('    uint64 constant PMA_CMIO_RX_BUFFER_START = 0x'.. hex(cartesi.PMA_CMIO_RX_BUFFER_START) .. ';\n')
-out:write('    uint8 constant PMA_CMIO_RX_BUFFER_LOG2_SIZE = 0x'.. hex(cartesi.PMA_CMIO_RX_BUFFER_LOG2_SIZE) .. ';\n')
+out:write('    uint64 constant PMA_CMIO_RX_BUFFER_START = 0x' .. hex(cartesi.PMA_CMIO_RX_BUFFER_START) .. ';\n')
+out:write('    uint8 constant PMA_CMIO_RX_BUFFER_LOG2_SIZE = 0x' .. hex(cartesi.PMA_CMIO_RX_BUFFER_LOG2_SIZE) .. ';\n')
 out:close()
 
 out:close()
diff --git a/helper_scripts/generate_SendCmioResponse.sh b/helper_scripts/generate_SendCmioResponse.sh
@@ -42,7 +42,6 @@ cpp_src=`echo "${BASH_REMATCH[1]}" \
         | $SED "s/writeMemoryWithPadding(a, PMA_CMIO_RX_BUFFER_START, data, dataLength, writeLengthLog2Size);/a.writeRegion(Memory.regionFromPhysicalAddress(PMA_CMIO_RX_BUFFER_START.toPhysicalAddress(),Memory.alignedSizeFromLog2(uint8(writeLengthLog2Size - TREE_LOG2_WORD_SIZE))),dataHash);"/g \
         | $SED -E "s/($CONSTANTS)([^a-zA-Z])/EmulatorConstants.\1\2/g" \
         | $SED "s/void send_cmio_response(STATE_ACCESS &a, uint16 reason, bytes data, uint32 dataLength) {/function sendCmioResponse(AccessLogs.Context memory a, uint16 reason, bytes32 dataHash, uint32 dataLength) internal pure {/" \
-        | $SED "s/writeMemoryWithPadding(a, PMA_CMIO_RX_BUFFER_START, data, dataLength, writeLengthLog2Size);/a.writeRegion(Memory.regionFromPhysicalAddress(PMA_CMIO_RX_BUFFER_START.toPhysicalAddress(),Memory.alignedSizeFromLog2(writeLengthLog2Size)),dataHash);"/g \
         | $SED "s/const uint64/uint64/g" \
         | $SED "s/const uint32/uint32/g" \
         | $SED "/^$/N;/^\n$/D"

diff --git a/src/Buffer.sol b/src/Buffer.sol
@@ -90,8 +90,9 @@ library Buffer {
         uint8 nodesCount = Memory.LOG2_MAX_SIZE - logOfSize;
 
         for (uint64 i = 0; i < nodesCount; i++) {
-            Buffer.Context memory siblings =
-                Buffer.Context(buffer.data, buffer.offset + (i << 5));
+            Buffer.Context memory siblings = Buffer.Context(
+                buffer.data, buffer.offset + (i << Memory.LOG2_LEAF)
+            );
 
             if (isEven(stride >> i)) {
                 drive =
@@ -111,7 +112,7 @@ library Buffer {
         bytes32 drive
     ) internal pure returns (bytes32) {
         (bytes32 root, uint8 nodesCount) = buffer.peekRoot(region, drive);
-        buffer.offset += uint128(nodesCount) << 5;
+        buffer.offset += uint128(nodesCount) << Memory.LOG2_LEAF;
 
         return root;
     }

diff --git a/src/EmulatorCompat.sol b/src/EmulatorCompat.sol
@@ -154,6 +154,8 @@ library EmulatorCompat {
         );
     }
 
+    // Conversions and arithmetic functions
+
     function int8ToUint64(int8 val) internal pure returns (uint64) {
         return uint64(int64(val));
     }
@@ -285,11 +287,31 @@ library EmulatorCompat {
 
     function uint32Log2(uint32 value) external pure returns (uint32) {
         require(value > 0, "EmulatorCompat: log2(0) is undefined");
-        uint32 result = 0;
-        while (value > 1) {
-            value >>= 1;
-            result++;
+        return 31 - clz(value);
+    }
+
+    function clz(uint32 x) internal pure returns (uint32) {
+        uint32 n = 0;
+        if (x & 0xFFFF0000 == 0) {
+            n = n + 16;
+            x = x << 16;
+        }
+        if (x & 0xFF000000 == 0) {
+            n = n + 8;
+            x = x << 8;
         }
-        return result;
+        if (x & 0xF0000000 == 0) {
+            n = n + 4;
+            x = x << 4;
+        }
+        if (x & 0xC0000000 == 0) {
+            n = n + 2;
+            x = x << 2;
+        }
+        if (x & 0x80000000 == 0) {
+            n = n + 1;
+        }
+
+        return n;
     }
 }
diff --git a/src/EmulatorConstants.sol b/src/EmulatorConstants.sol
@@ -15,7 +15,7 @@
 //
 
 /// @title EmulatorConstants
-/// @notice Contains constants for micro-architecture
+/// @notice Contains constants from the Cartesi Machine emulator
 //:#include macro.pp
 /// DEV_COMMENT(templates/EmulatorConstants.sol.template)
 
@@ -40,6 +40,7 @@ library EmulatorConstants {
     uint64 constant UARCH_ECALL_FN_PUTCHAR = 2;
     uint64 constant IFLAGS_ADDRESS = 0x2e8;
     uint64 constant HTIF_FROMHOST_ADDRESS = 0x318;
+    uint8 constant HTIF_YIELD_REASON_ADVANCE_STATE = 0x0;
     uint32 constant TREE_LOG2_WORD_SIZE = 0x5;
     uint32 constant TREE_WORD_SIZE = uint32(1) << TREE_LOG2_WORD_SIZE;
     uint64 constant PMA_CMIO_RX_BUFFER_START = 0x60000000;

diff --git a/src/SendCmioResponse.sol b/src/SendCmioResponse.sol
@@ -15,9 +15,9 @@
 //
 
 /// @title SendCmioResponse
-/// @notice Reset microarchitecture to pristine state
+/// @notice Send CMIO response
 //:#include macro.pp
-/// DEV_COMMENT(templates/UArchReset.sol.template)
+/// DEV_COMMENT(templates/SendCmioResponse.sol.template)
 
 pragma solidity ^0.8.0;
 

diff --git a/templates/EmulatorConstants.sol.template b/templates/EmulatorConstants.sol.template
@@ -15,7 +15,7 @@
 //
 
 /// @title EmulatorConstants
-/// @notice Contains constants for micro-architecture
+/// @notice Contains constants from the Cartesi Machine emulator
 //:#include macro.pp
 /// DEV_COMMENT(templates/EmulatorConstants.sol.template)
 

diff --git a/templates/SendCmioResponse.sol.template b/templates/SendCmioResponse.sol.template
@@ -15,9 +15,9 @@
 //
 
 /// @title SendCmioResponse
-/// @notice Reset microarchitecture to pristine state
+/// @notice Send CMIO response
 //:#include macro.pp
-/// DEV_COMMENT(templates/UArchReset.sol.template)
+/// DEV_COMMENT(templates/SendCmioResponse.sol.template)
 
 pragma solidity ^0.8.0;