diff --git a/Dockerfile b/Dockerfile index 75f413847..d5efde90c 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 <= 3.81 - Go >= 1.24.1 @@ -24,9 +24,11 @@ Follow the Cartesi Machine installation instructions [here](https://github.com/c ##### Build +With the Cartesi machine emulator installed, build the rollups-node: + ```sh -# clone a stable branch of the emulator -git clone --branch v2.0.0 https://github.com/cartesi/rollups-node.git +# clone a branch of the rollups-node +git clone --branch next/2.0 https://github.com/cartesi/rollups-node.git cd rollups-node # compile diff --git a/cmd/cartesi-rollups-cli/root/app/register/register.go b/cmd/cartesi-rollups-cli/root/app/register/register.go index a380bfc9f..0fc846fe2 100644 --- a/cmd/cartesi-rollups-cli/root/app/register/register.go +++ b/cmd/cartesi-rollups-cli/root/app/register/register.go @@ -12,7 +12,7 @@ import ( "os" "strings" - "github.com/cartesi/rollups-node/cmd/cartesi-rollups-cli/root/app/util" + "github.com/cartesi/rollups-node/cmd/cartesi-rollups-cli/util" "github.com/cartesi/rollups-node/internal/config" "github.com/cartesi/rollups-node/internal/model" "github.com/cartesi/rollups-node/internal/repository/factory" @@ -143,12 +143,11 @@ func run(cmd *cobra.Command, args []string) { checkEnabled, err := config.GetFeatureMachineHashCheckEnabled() cobra.CheckErr(err) if checkEnabled { - templateHash, err := util.ReadHash(templatePath) + snapshotTemplateHash, err := util.ReadRootHash(templatePath) if err != nil { fmt.Fprintf(os.Stderr, "Read machine template hash failed: %v\n", err) os.Exit(1) } - snapshotTemplateHash := common.HexToHash(templateHash) if parsedTemplateHash != snapshotTemplateHash { fmt.Fprintf(os.Stderr, "Template hash mismatch: contract has %s but machine has %s\n", parsedTemplateHash.Hex(), snapshotTemplateHash.Hex()) diff --git a/cmd/cartesi-rollups-cli/root/app/util/machine.go b/cmd/cartesi-rollups-cli/root/app/util/machine.go deleted file mode 100644 index 2eb30b309..000000000 --- a/cmd/cartesi-rollups-cli/root/app/util/machine.go +++ /dev/null @@ -1,29 +0,0 @@ -// (c) Cartesi and individual authors (see AUTHORS) -// SPDX-License-Identifier: Apache-2.0 (see LICENSE) - -package util - -import ( - "fmt" - "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 ReadHash(machineDir string) (string, error) { - path := path.Join(machineDir, "hash") - hash, err := os.ReadFile(path) - if err != nil { - return "", fmt.Errorf("read hash: %w", err) - } else if len(hash) != common.HashLength { - return "", fmt.Errorf( - "read hash: wrong size; expected %v bytes but read %v", - common.HashLength, - len(hash), - ) - } - return common.Bytes2Hex(hash), nil -} diff --git a/cmd/cartesi-rollups-cli/root/deploy/application.go b/cmd/cartesi-rollups-cli/root/deploy/application.go index 3ee48b233..9fb0bf1c9 100644 --- a/cmd/cartesi-rollups-cli/root/deploy/application.go +++ b/cmd/cartesi-rollups-cli/root/deploy/application.go @@ -8,9 +8,9 @@ import ( "encoding/json" "fmt" "os" - "path" "strings" + "github.com/cartesi/rollups-node/cmd/cartesi-rollups-cli/util" "github.com/cartesi/rollups-node/internal/config" "github.com/cartesi/rollups-node/internal/config/auth" "github.com/cartesi/rollups-node/internal/model" @@ -360,7 +360,7 @@ func buildSelfhostedApplicationDeployment( 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 = util.ReadRootHash(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 = util.ReadRootHash(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 = util.ReadRootHash(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/cmd/cartesi-rollups-cli/util/util.go b/cmd/cartesi-rollups-cli/util/util.go new file mode 100644 index 000000000..e3f74942a --- /dev/null +++ b/cmd/cartesi-rollups-cli/util/util.go @@ -0,0 +1,38 @@ +// (c) Cartesi and individual authors (see AUTHORS) +// SPDX-License-Identifier: Apache-2.0 (see LICENSE) + +package util + +import ( + "io" + "os" + "path" + + "github.com/ethereum/go-ethereum/common" +) + +// Reads the Cartesi Machine hash from machineDir. Returns it as a commonHash +// or an error +func ReadRootHash(machineDir string) (common.Hash, error) { + zero := common.Hash{} + path := path.Join(machineDir, "hash_tree.sht") + f, err := os.Open(path) + if err != nil { + return zero, 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 zero, err + } + + hash := common.Hash{} + _, err = io.ReadFull(f, hash[:]) + if err != nil { + return zero, err + } + return hash, nil +} 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..cc3e634fb 100644 --- a/pkg/emulator/emulator.go +++ b/pkg/emulator/emulator.go @@ -48,8 +48,8 @@ func SpawnServer(address string, timeout time.Duration) (*RemoteMachine, string, return &RemoteMachine{Machine: Machine{ptr: cm}}, C.GoString(boundAddr), uint32(pid), nil } -func CreateMachine(config, runtimeConfig string) (*Machine, error) { +func CreateMachine(config, runtimeConfig, dir string) (*Machine, error) { machine := &Machine{} - err := machine.Create(config, runtimeConfig) + err := machine.Create(config, runtimeConfig, dir) return machine, err } diff --git a/pkg/emulator/machine.go b/pkg/emulator/machine.go index 7fb624d43..d03315c52 100644 --- a/pkg/emulator/machine.go +++ b/pkg/emulator/machine.go @@ -58,11 +58,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 +72,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 +124,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 +131,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 +225,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 +353,56 @@ 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 []byte + + m.callCAPI(func() { + var cResult *C.char + 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, + &cResult)) + result = []byte(C.GoString(cResult)) + }) + if err != nil { + return nil, err + } + + return result, nil +} + +// collect_uarch_cycle_root_hashes +func (m *Machine) CollectUarchCycleRootHashes(mcycleEnd uint64, log2BundleMcycleCount int32) ([]byte, error) { + var err error + var result []byte + + m.callCAPI(func() { + var cResult *C.char + err = newError(C.cm_collect_uarch_cycle_root_hashes( + m.ptr, + C.uint64_t(mcycleEnd), + C.int32_t(log2BundleMcycleCount), + &cResult)) + result = []byte(C.GoString(cResult)) + }) + + if err != nil { + return nil, err + } + return result, nil +} + // send_cmio_response func (m *Machine) SendCmioResponse(reason uint16, data []byte) error { var err error @@ -414,7 +448,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/types.go b/pkg/emulator/types.go index f57fe9d1f..bf8bc22b8 100644 --- a/pkg/emulator/types.go +++ b/pkg/emulator/types.go @@ -82,6 +82,8 @@ const ( BreakReasonYieldedAutomatically BreakReason = C.CM_BREAK_REASON_YIELDED_AUTOMATICALLY BreakReasonYieldedSoftly BreakReason = C.CM_BREAK_REASON_YIELDED_SOFTLY BreakReasonReachedTargetMcycle BreakReason = C.CM_BREAK_REASON_REACHED_TARGET_MCYCLE + BreakReasonConsoleOutput BreakReason = C.CM_BREAK_REASON_CONSOLE_OUTPUT + BreakReasonConsoleInput BreakReason = C.CM_BREAK_REASON_CONSOLE_INPUT ) func (reason BreakReason) String() (s string) { @@ -105,6 +107,15 @@ func (reason BreakReason) String() (s string) { } +// SharingMode +type SharingMode = C.cm_sharing_mode + +const ( + SharingNone SharingMode = C.CM_SHARING_NONE + SharingConfig SharingMode = C.CM_SHARING_CONFIG + SharingAll SharingMode = C.CM_SHARING_ALL +) + type ( CmioYieldCommand uint8 CmioYieldReason uint16 @@ -297,11 +308,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 +346,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..c089e3b3a 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 // value from machine api: CM_AR_SHADOW_REVERT_ROOT_HASH_START const TxBufferAddress uint64 = 0x60800000 const HashLog2Size = 5 // 32 bytes 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 diff --git a/test/tooling/snapshot/snapshot.go b/test/tooling/snapshot/snapshot.go index ae1bf073a..d8cf2cc77 100644 --- a/test/tooling/snapshot/snapshot.go +++ b/test/tooling/snapshot/snapshot.go @@ -98,7 +98,7 @@ func (snapshot *Snapshot) createTempDir() error { } func (snapshot *Snapshot) createRunAndStore(config string, cycles uint64) error { - machine, err := emulator.CreateMachine(config, "") + machine, err := emulator.CreateMachine(config, "", "") if err != nil { return errors.Join(err, snapshot.Close()) }