From 32ec195fb0085788fdf2c582d694408bf3c55bcd Mon Sep 17 00:00:00 2001 From: Marcelo Politzer <251334+mpolitzer@users.noreply.github.com> Date: Tue, 6 Jan 2026 16:29:33 -0300 Subject: [PATCH] feat: bump emulator to v0.20.0 --- Dockerfile | 18 ++-- Makefile | 4 +- .../root/app/register/register.go | 5 +- .../root/app/util/machine.go | 29 ------ .../root/deploy/application.go | 25 +---- control.template | 2 +- pkg/emulator/emulator.go | 2 +- pkg/emulator/machine.go | 91 +++++++++++++------ pkg/emulator/read_hash.go | 56 ++++++++++++ pkg/emulator/types.go | 12 ++- pkg/machine/implementation.go | 2 +- pkg/machine/libcartesi.go | 79 ++++++++++++++++ pkg/machine/libcartesi_test.go | 9 +- test/dependencies | 2 +- test/dependencies.sha256 | 2 +- 15 files changed, 237 insertions(+), 101 deletions(-) delete mode 100644 cmd/cartesi-rollups-cli/root/app/util/machine.go create mode 100644 pkg/emulator/read_hash.go diff --git a/Dockerfile b/Dockerfile index 75f413847..e8d954354 100644 --- a/Dockerfile +++ b/Dockerfile @@ -3,12 +3,12 @@ # syntax=docker.io/docker/dockerfile:1 -ARG EMULATOR_VERSION=0.19.0 +ARG EMULATOR_VERSION=0.20.0 # Build directories. ARG GO_BUILD_PATH=/build/cartesi/go -FROM debian:bookworm-20250407 AS common-env +FROM debian:trixie-20250811 AS common-env USER root @@ -22,13 +22,13 @@ RUN <= 2 { // args[1] is mandatory if `template-hash` was absent - request.TemplateHash, err = readHash(args[1]) + request.TemplateHash, err = emulator.ReadHash(args[1]) } else { err = fmt.Errorf("missing argument. One of `template-path` or `template-hash` is required") } @@ -435,7 +435,7 @@ func buildApplicationOnlyDeployment( if !cmd.Flags().Changed("template-hash") { if len(args) >= 2 { // args[1] is mandatory if `template-hash` was absent - request.TemplateHash, err = readHash(args[1]) + request.TemplateHash, err = emulator.ReadHash(args[1]) } else { err = fmt.Errorf("missing argument. One of `template-path` or `template-hash` is required") } @@ -515,7 +515,7 @@ func buildPrtApplicationDeployment( if !cmd.Flags().Changed("template-hash") { if len(args) >= 2 { // args[1] is mandatory if `template-hash` was absent - request.TemplateHash, err = readHash(args[1]) + request.TemplateHash, err = emulator.ReadHash(args[1]) } else { err = fmt.Errorf("missing argument. One of `template-path` or `template-hash` is required") } @@ -535,23 +535,6 @@ func buildPrtApplicationDeployment( return request, nil } -// read the hash value from the cartesi machine hash file -func readHash(machineDir string) (common.Hash, error) { - zero := common.Hash{} - path := path.Join(machineDir, "hash") - hash, err := os.ReadFile(path) - if err != nil { - return zero, fmt.Errorf("read hash: %w", err) - } else if len(hash) != common.HashLength { - return zero, fmt.Errorf( - "read hash: wrong size; expected %v bytes but read %v", - common.HashLength, - len(hash), - ) - } - return common.BytesToHash(hash), nil -} - func parseHexHash(hash string) (common.Hash, error) { out := common.Hash{} return out, out.UnmarshalText([]byte(hash)) diff --git a/control.template b/control.template index 820590886..7834fe080 100644 --- a/control.template +++ b/control.template @@ -5,7 +5,7 @@ Homepage: https://docs.cartesi.io/cartesi-rollups/ Architecture: ARG_ARCH Maintainer: Node Reference Unit Provides: cartesi-rollups-node -Depends: cartesi-machine-emulator (>= 0.19.0), cartesi-machine-emulator (<< 0.20.0) +Depends: cartesi-machine-emulator (>= 0.20.0), cartesi-machine-emulator (<< 0.21.0) Section: net Priority: optional Multi-Arch: no diff --git a/pkg/emulator/emulator.go b/pkg/emulator/emulator.go index 82893b3dc..9845edfe1 100644 --- a/pkg/emulator/emulator.go +++ b/pkg/emulator/emulator.go @@ -50,6 +50,6 @@ func SpawnServer(address string, timeout time.Duration) (*RemoteMachine, string, func CreateMachine(config, runtimeConfig string) (*Machine, error) { machine := &Machine{} - err := machine.Create(config, runtimeConfig) + err := machine.Create(config, runtimeConfig, "") return machine, err } diff --git a/pkg/emulator/machine.go b/pkg/emulator/machine.go index 7fb624d43..08bbb4d71 100644 --- a/pkg/emulator/machine.go +++ b/pkg/emulator/machine.go @@ -19,6 +19,14 @@ import ( const HashSize = C.sizeof_cm_hash +type SharingMode = C.cm_sharing_mode + +const ( + SharingNone SharingMode = iota + SharingConfig + SharingAll +) + // Common type aliases type Hash = [HashSize]byte @@ -58,11 +66,12 @@ func (m *Machine) Delete() { } // create -func (m *Machine) Create(config, runtimeConfig string) error { +func (m *Machine) Create(config, runtimeConfig, dir string) error { var err error m.callCAPI(func() { var cConfig *C.char var cRuntime *C.char + var cDir *C.char if config != "" { cConfig = C.CString(config) defer C.free(unsafe.Pointer(cConfig)) @@ -71,7 +80,11 @@ func (m *Machine) Create(config, runtimeConfig string) error { cRuntime = C.CString(runtimeConfig) defer C.free(unsafe.Pointer(cRuntime)) } - err = newError(C.cm_create_new(cConfig, cRuntime, &m.ptr)) + if dir != "" { + cDir = C.CString(dir) + defer C.free(unsafe.Pointer(cDir)) + } + err = newError(C.cm_create_new(cConfig, cRuntime, cDir, &m.ptr)) }) return err } @@ -119,27 +132,6 @@ func (m *Machine) GetInitialConfig() (string, error) { return res, nil } -// get_memory_ranges -func (m *Machine) GetMemoryRanges() (string, error) { - var ranges *C.char - var err error - var res string - - m.callCAPI(func() { - err = newError(C.cm_get_memory_ranges(m.ptr, &ranges)) - if err != nil || ranges == nil { - return - } - res = C.GoString(ranges) - // no need to free 'ranges' here, as it is a static string - }) - - if err != nil { - return "", err - } - return res, nil -} - // get_proof func (m *Machine) GetProof(address uint64, log2size int32) (string, error) { var proof *C.char @@ -147,7 +139,7 @@ func (m *Machine) GetProof(address uint64, log2size int32) (string, error) { var res string m.callCAPI(func() { - err = newError(C.cm_get_proof(m.ptr, C.uint64_t(address), C.int32_t(log2size), &proof)) + err = newError(C.cm_get_proof(m.ptr, C.uint64_t(address), C.int32_t(log2size), C.int32_t(HashTreeLog2RootSize), &proof)) if err != nil || proof == nil { return } @@ -241,7 +233,7 @@ func (m *Machine) Load(dir string, runtimeConfig string) error { cRuntime = C.CString(runtimeConfig) defer C.free(unsafe.Pointer(cRuntime)) } - err = newError(C.cm_load(m.ptr, cDir, cRuntime)) + err = newError(C.cm_load(m.ptr, cDir, cRuntime, SharingNone)) }) return err @@ -369,6 +361,53 @@ func (m *Machine) Run(mcycleEnd uint64) (BreakReason, error) { return BreakReason(br), nil } +// collect_mcycle_root_hashes +func (m *Machine) CollectMCycleRootHashes(mcycleEnd, mcyclePeriod, mcyclePhase uint64, log2BundleMcycleCount int32, previousBackTree string) ([]byte, error) { + var err error + var result *C.char + + m.callCAPI(func() { + var previousBackTreeC *C.char + if previousBackTree != "" { + previousBackTreeC = C.CString(previousBackTree) + defer C.free(unsafe.Pointer(previousBackTreeC)) + } + err = newError(C.cm_collect_mcycle_root_hashes( + m.ptr, + C.uint64_t(mcycleEnd), + C.uint64_t(mcyclePeriod), + C.uint64_t(mcyclePhase), + C.int32_t(log2BundleMcycleCount), + previousBackTreeC, + &result)) + }) + + if err != nil { + return []byte{}, err + } + return []byte(C.GoString(result)), nil +} + +// collect_uarch_cycle_root_hashes +func (m *Machine) CollectUarchCycleRootHashes(mcycleEnd uint64, log2BundleMcycleCount int32) ([]byte, error) { + var err error + var result *C.char + + m.callCAPI(func() { + err = newError(C.cm_collect_uarch_cycle_root_hashes( + m.ptr, + C.uint64_t(mcycleEnd), + C.int32_t(log2BundleMcycleCount), + &result)) + }) + + if err != nil { + return []byte{}, err + } + return []byte(C.GoString(result)), nil +} + + // send_cmio_response func (m *Machine) SendCmioResponse(reason uint16, data []byte) error { var err error @@ -414,7 +453,7 @@ func (m *Machine) Store(directory string) error { m.callCAPI(func() { cDir := C.CString(directory) defer C.free(unsafe.Pointer(cDir)) - err = newError(C.cm_store(m.ptr, cDir)) + err = newError(C.cm_store(m.ptr, cDir, SharingAll)) }) return err diff --git a/pkg/emulator/read_hash.go b/pkg/emulator/read_hash.go new file mode 100644 index 000000000..6ed66af59 --- /dev/null +++ b/pkg/emulator/read_hash.go @@ -0,0 +1,56 @@ +// (c) Cartesi and individual authors (see AUTHORS) +// SPDX-License-Identifier: Apache-2.0 (see LICENSE) + +package emulator + +import ( + "fmt" + "io" + "os" + "path" + + "github.com/ethereum/go-ethereum/common" +) + +// Reads the Cartesi Machine hash from machineDir. Returns it as a hex string or +// an error +func ReadHashHex(machineDir string) (string, error) { + path := path.Join(machineDir, "hash_tree.sht") + f, err := os.Open(path) + if err != nil { + return "", err + } + defer f.Close() + + // root hash is located at this offset (0x60). Double check its value + // with the cartesi-machine-stored-hash tool. + _, err = f.Seek(0x60, io.SeekStart) + if err != nil { + return "", err + } + + // read only 0x20 bytes from it, there are more hash values after it + rawHash := make([]byte, 0x20) + n, err := f.Read(rawHash) + if err != nil { + return "", err + } + if n != common.HashLength { + return "", fmt.Errorf( + "read hash: wrong size; expected %v bytes but read %v", + common.HashLength, + n, + ) + } + return common.Bytes2Hex(rawHash), nil +} + +// Reads the Cartesi Machine hash from machineDir. Returns it as a commonHash +// or an error +func ReadHash(machineDir string) (common.Hash, error) { + s, err := ReadHashHex(machineDir) + if err != nil { + return common.Hash{}, err + } + return common.HexToHash(s), nil +} diff --git a/pkg/emulator/types.go b/pkg/emulator/types.go index f57fe9d1f..31623cd89 100644 --- a/pkg/emulator/types.go +++ b/pkg/emulator/types.go @@ -297,11 +297,11 @@ const ( ) const ( - CmioRxBufferStart uint64 = C.CM_PMA_CMIO_RX_BUFFER_START - CmioRxBufferLog2Size uint64 = C.CM_PMA_CMIO_RX_BUFFER_LOG2_SIZE + CmioRxBufferStart uint64 = C.CM_AR_CMIO_RX_BUFFER_START + CmioRxBufferLog2Size uint64 = C.CM_AR_CMIO_RX_BUFFER_LOG2_SIZE - CmioTxBufferStart uint64 = C.CM_PMA_CMIO_TX_BUFFER_START - CmioTxBufferLog2Size uint64 = C.CM_PMA_CMIO_TX_BUFFER_LOG2_SIZE + CmioTxBufferStart uint64 = C.CM_AR_CMIO_TX_BUFFER_START + CmioTxBufferLog2Size uint64 = C.CM_AR_CMIO_TX_BUFFER_LOG2_SIZE ) type MachineRuntimeConfig struct { @@ -335,3 +335,7 @@ func NewMachineRuntimeConfig() *MachineRuntimeConfig { SoftYield: false, } } + +const ( + HashTreeLog2RootSize uint32 = C.CM_HASH_TREE_LOG2_ROOT_SIZE +) diff --git a/pkg/machine/implementation.go b/pkg/machine/implementation.go index 7e4748db6..4ae372402 100644 --- a/pkg/machine/implementation.go +++ b/pkg/machine/implementation.go @@ -50,7 +50,7 @@ const ( const maxOutputs = 65536 // 2^16 const maxReports = 65536 // 2^16 -const CheckpointAddress uint64 = 0x7ffff000 +const CheckpointAddress uint64 = 0xfe0 // TODO: use emulator constant: CM_AR_SHADOW_REVERT_ROOT_HASH_START const TxBufferAddress uint64 = 0x60800000 const HashLog2Size = 5 // 32 bytes diff --git a/pkg/machine/libcartesi.go b/pkg/machine/libcartesi.go index 7d396f1de..c7967e691 100644 --- a/pkg/machine/libcartesi.go +++ b/pkg/machine/libcartesi.go @@ -11,6 +11,9 @@ import ( "time" "github.com/cartesi/rollups-node/pkg/emulator" + "github.com/davecgh/go-spew/spew" + "github.com/ethereum/go-ethereum/common" + //"github.com/ethereum/go-ethereum/common" ) // RemoteMachineInterface defines the interface that LibCartesiBackend needs from a remote machine @@ -18,6 +21,7 @@ type RemoteMachineInterface interface { SetTimeout(timeoutMs int64) error Load(dir string, runtimeConfig string) error Run(mcycleEnd uint64) (emulator.BreakReason, error) + CollectMCycleRootHashes(mcycleEnd, mcyclePeriod, mcyclePhase uint64, log2BundleMcycleCount int32, previousBackTree string) ([]byte, error) GetRootHash() (emulator.Hash, error) GetProof(address uint64, log2size int32) (string, error) ReadReg(reg emulator.RegID) (uint64, error) @@ -39,6 +43,16 @@ type proofJson struct { TargetHash Hash `json:"target_hash"` } +// Struct for the decoded `result` field of cm_collect_mcycle_root_hashes (originally returned as json). +// The value comes back as a json string, that needs to be decoded to this struct below. +// BackTree may or may not be present, check cm_collect_mcycle_root_hashes documentation for details. +type CollectMCycleRootHashesState struct { + RootHashes [][]byte `json:"hashes"` + MCyclePhase uint64 `json:"mcycle_phase"` + BreakReason string `json:"break_reason"` + BackTree json.RawMessage `json:"back_tree,omitempty"` +} + func decodeB64To32(dst *Hash, s string) error { // accepts Std (with '=') and Raw (without '=') n, err := base64.StdEncoding.Decode(dst[:], []byte(s)) @@ -234,6 +248,71 @@ func (e *LibCartesiBackend) RunAndCollectRootHashes( mcycleEnd uint64, state *HashCollectorState, timeout time.Duration, +) (reason BreakReason, err error) { + spew.Dump("++", state) + result, err := e.RunAndCollectRootHashesNew(mcycleEnd, state, timeout) + spew.Dump("--", state) + + return result, err +} + +func (e *LibCartesiBackend) RunAndCollectRootHashesNew( + mcycleEnd uint64, + state *HashCollectorState, + timeout time.Duration, +) (reason BreakReason, err error) { + if err := e.inner.SetTimeout(timeout.Milliseconds()); err != nil { + return 0, fmt.Errorf("failed to set operation timeout: %w", err) + } + result, err := e.inner.CollectMCycleRootHashes(mcycleEnd, state.Period, state.Phase, state.BundleLog2, string(state.BackTree)) + if err != nil { + return Failed, err + } + + var hs CollectMCycleRootHashesState + err = json.Unmarshal(result, &hs) + if err != nil { + return Failed, err + } + + var br BreakReason + switch hs.BreakReason { + case "failed": + br = Failed + case "halted": + br = Halted + case "reached_target_mcycle": + br = ReachedTargetMcycle + case "yielded_automatically": + br = YieldedAutomatically + case "yielded_softly": + br = YieldedSoftly + case "yielded_manually": + br = YieldedManually + default: + return Failed, fmt.Errorf("unimplemented break reason on RunAndCollectRootHashesNew") + } + + // NOTE: drop the fixed-point hash that the C API collects. + if br == YieldedManually || br == Halted { + for i := range len(hs.RootHashes)-1 { + hash := hs.RootHashes[i] + state.Hashes = append(state.Hashes, common.BytesToHash(hash)) + } + } else { + for _, hash := range hs.RootHashes { + state.Hashes = append(state.Hashes, common.BytesToHash(hash)) + } + } + state.Phase = hs.MCyclePhase + state.BackTree = hs.BackTree + return br, nil +} + +func (e *LibCartesiBackend) RunAndCollectRootHashesOld( + mcycleEnd uint64, + state *HashCollectorState, + timeout time.Duration, ) (reason BreakReason, err error) { if state == nil { return Failed, errors.New("nil state") diff --git a/pkg/machine/libcartesi_test.go b/pkg/machine/libcartesi_test.go index 4f78d08b1..f2b5b7d8a 100644 --- a/pkg/machine/libcartesi_test.go +++ b/pkg/machine/libcartesi_test.go @@ -288,7 +288,7 @@ func (s *LibCartesiSuite) TestStore() { // Test successful store s.mockRemoteMachine.On("SetTimeout", int64(5000)).Return(nil) - s.mockRemoteMachine.On("Store", "/test/dir").Return(nil) + s.mockRemoteMachine.On("Store", "/test/dir", mock.Anything).Return(nil) err := s.backend.Store("/test/dir", 5*time.Second) require.NoError(err) @@ -308,7 +308,7 @@ func (s *LibCartesiSuite) TestStore() { s.mockRemoteMachine = new(MockRemoteMachine) s.backend = &LibCartesiBackend{inner: s.mockRemoteMachine} s.mockRemoteMachine.On("SetTimeout", int64(5000)).Return(nil) - s.mockRemoteMachine.On("Store", "/test/dir").Return(errors.New("store error")) + s.mockRemoteMachine.On("Store", "/test/dir", mock.Anything).Return(errors.New("store error")) err = s.backend.Store("/test/dir", 5*time.Second) require.Error(err) @@ -434,6 +434,11 @@ func (m *MockRemoteMachine) Run(mcycleEnd uint64) (emulator.BreakReason, error) return args.Get(0).(emulator.BreakReason), args.Error(1) } +func (m *MockRemoteMachine) CollectMCycleRootHashes(mcycleEnd, mcyclePeriod, mcyclePhase uint64, log2BundleMcycleCount int32, previousBackTree string) ([]byte, error) { + args := m.Called(mcycleEnd, mcyclePeriod, mcyclePhase, log2BundleMcycleCount, previousBackTree) + return args.Get(0).([]byte), args.Error(1) +} + func (m *MockRemoteMachine) GetRootHash() (emulator.Hash, error) { args := m.Called() return args.Get(0).(Hash), args.Error(1) diff --git a/test/dependencies b/test/dependencies index 557d9b45d..092280d4b 100644 --- a/test/dependencies +++ b/test/dependencies @@ -1,2 +1,2 @@ https://github.com/cartesi/image-kernel/releases/download/v0.20.0/linux-6.5.13-ctsi-1-v0.20.0.bin -https://github.com/cartesi/machine-guest-tools/releases/download/v0.17.0/rootfs-tools.ext2 +https://github.com/cartesi/machine-guest-tools/releases/download/v0.17.2/rootfs-tools.ext2 diff --git a/test/dependencies.sha256 b/test/dependencies.sha256 index 5674cb2ce..92e988b1e 100644 --- a/test/dependencies.sha256 +++ b/test/dependencies.sha256 @@ -1,2 +1,2 @@ 65dd100ff6204346ac2f50f772721358b5c1451450ceb39a154542ee27b4c947 test/downloads/linux-6.5.13-ctsi-1-v0.20.0.bin -8eb9d03b2653fc6090caf4ae3fb49b44fe1ccd57d9903dd696c0a3024ea1a031 test/downloads/rootfs-tools.ext2 +675a49e3c9bada29f25d5b559707b34553b94280c03f44ccb8203c2cf453b541 test/downloads/rootfs-tools.ext2