| CARVIEW |
Select Language
HTTP/2 200
date: Mon, 29 Dec 2025 16:30:56 GMT
content-type: text/html; charset=utf-8
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
x-robots-tag: none
etag: W/"d0742f6f161b6fc6571c53ebae8d3b00"
cache-control: max-age=0, private, must-revalidate
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: no-referrer-when-downgrade
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com github.githubassets.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com wss://alive-staging.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com marketplace-screenshots.githubusercontent.com/ copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com github.githubassets.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=qR9y3WOB8OWVOHV7UCa7YTSbt95RImJvyM1OmeVcAqr%2BKs6UkkjAR%2FZVsxUU3Fqfs5za6V1XfX6FU3X1S500WSLIcyPiMcCx%2FHmae7OAyYoit9%2FxQeZx9FwvTlyj4hB%2BWV%2FuCZ8w9MSu%2FL4JwtaprcfN1NZ7ckWwtxf%2FiWX6brAvIaIMc%2BUjFKeTlN%2FwVRrY42Ast1o41Xi%2BiKA8rj6Wvj54VPJR0St1CfIFXMEz8obbFzi6DT2ExEU09sxaGDL90aarimOwemKIy6mYRnDSyg%3D%3D--NgcK%2BQDr9Gb%2BuZIv--uYwt1FsQXPuKJVQsADt35g%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.358462053.1767025856; Path=/; Domain=github.com; Expires=Tue, 29 Dec 2026 16:30:56 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Tue, 29 Dec 2026 16:30:56 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: 8336:3FD896:644F25D:7826B71:6952ACC0
Using the Lua API · cartesi/machine-emulator Wiki · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 42
Using the Lua API
Eduardo Bart edited this page Jan 23, 2025
·
3 revisions
Before trying this example first make sure:
- You have Cartesi Machine installed globally in your system.
- You have
linux.binandrootfs.ext2images available locally (you could copy them from your installation). - You have a Lua 5.4 installed.
- The
LUA_CPATH_5_4is able to findcartesi.so(default for global installations). - You are using Cartesi Machine 0.20+ (contains the new C API, it's not released yet).
The following example boots a machine and prints a hello message:
local cartesi = require 'cartesi'
-- Set machine configuration
local config = {
dtb = {
entrypoint = [[echo Hello from inside!]]
},
flash_drive = {
{image_filename = "rootfs.ext2"},
},
ram = {
image_filename = "linux.bin",
length = 0x8000000,
},
}
-- Create a new machine
local machine <close> = cartesi.machine(config)
-- Run the machine
local break_reason = machine:run()
-- Print reason for run interruption
print(({
[cartesi.BREAK_REASON_HALTED] = 'Halted',
[cartesi.BREAK_REASON_YIELDED_MANUALLY] = 'Yielded manually\n',
[cartesi.BREAK_REASON_YIELDED_AUTOMATICALLY] = 'Yielded automatically\n',
[cartesi.BREAK_REASON_YIELDED_SOFTLY] = 'Yielded softly\n',
[cartesi.BREAK_REASON_REACHED_TARGET_MCYCLE] = 'Reached target machine cycle\n',
[cartesi.BREAK_REASON_FAILED] = 'Interpreter failed\n',
})[break_reason])
-- Read and print machine cycles
print('Cycles: '..machine:read_reg('mcycle'))Compile and run with:
lua5.4 example.luaYou should get the following output:
Hello from inside!
Halted
Cycles: 48985837
To perform input/output operations from inside a machine to the outside you can use the CMIO (Cartesi Machine IO) with its GIO (generic IO) interface, the following example demonstrates this:
local cartesi = require 'cartesi'
-- Set machine configuration
local config = {
dtb = {
entrypoint = [[echo '{"domain":16,"id":"'$(echo -n Hello from inside! | hex --encode)'"}' | rollup gio | grep -Eo '0x[0-9a-f]+' | tr -d '\n' | hex --decode; echo]]
},
flash_drive = {
{image_filename = "rootfs.ext2"},
},
ram = {
image_filename = "linux.bin",
length = 0x8000000,
},
}
-- Create a new machine
local machine <close> = cartesi.machine(config)
-- Run the machine
machine:run()
-- Receive GIO request
local cmd, domain, data = machine:receive_cmio_request()
assert(cmd == cartesi.CMIO_YIELD_COMMAND_MANUAL and domain == 16, 'unexpected CMIO request')
print(data)
-- Send GIO response
machine:send_cmio_response(domain, 'Hello from outside!')
-- Resume the machine
local break_reason = machine:run()
-- Print reason for run interruption
print(({
[cartesi.BREAK_REASON_HALTED] = 'Halted',
[cartesi.BREAK_REASON_YIELDED_MANUALLY] = 'Yielded manually\n',
[cartesi.BREAK_REASON_YIELDED_AUTOMATICALLY] = 'Yielded automatically\n',
[cartesi.BREAK_REASON_YIELDED_SOFTLY] = 'Yielded softly\n',
[cartesi.BREAK_REASON_REACHED_TARGET_MCYCLE] = 'Reached target machine cycle\n',
[cartesi.BREAK_REASON_FAILED] = 'Interpreter failed\n',
})[break_reason])
-- Read and print machine cycles
print('Cycles: '..machine:read_reg('mcycle'))Compile and run with:
lua5.4 example-gio.luaYou should get the following output:
Hello from inside!
Hello from outside!
Halted
Cycles: 61800308
For more information on how to use API please read the C API header, every function there is documented.
Clone this wiki locally
You can’t perform that action at this time.