Cartesi Machine Image Linux Kernel

The Cartesi Image Linux Kernel is the repository that provides the Docker configuration files to build the Linux kernel linux.bin image. This is used to run a Linux environment on the Cartesi Machine Emulator reference implementation. The current image is based on the cartesi/toolchain that uses Ubuntu 22.04. The linux.bin is built from the Linux 5.5.x source, targeting the RISC-V RV64IMA with ABI LP64 architecture.

Getting Started

Requirements

• Docker 18.x
• GNU Make >= 3.81

Build

$ make build

If you want to tag the image with custom name you can do the following:

$ make build TAG=mytag

To remove the generated images from your system, please refer to the Docker documentation.

Development

There is a separate build.mk Makefile that can be used for kernel for development.

$ make -f build.mk clone
$ make -f build.mk run
$ make -f build.mk

There is also a run-selftest target to run the kernel tests. To use it, start a remote-cartesi-machine process from the emulator repository, then run:

$ make -f build.mk run-selftest

Makefile targets

The following options are available as make targets:

• build: builds the docker image-kernel image
• copy: builds the imgae-kernel image and copy it's artifact to the host
• run: runs the generated image with current user UID and GID
• run-as-root: runs the generated image as root
• push: pushes the image to the registry repository

Makefile container options

You can pass the following variables to the make target if you wish to use different docker image tags.

• TAG: image-roofs image tag
• TOOLCHAIN_TAG: toolchain image tag

$ make build TAG=mytag
$ make build TOOLCHAIN_TAG=mytag

It's also useful if you want to use pre-built images:

$ make run TAG=latest

Usage

The purpose of this image is to build the linux.bin artifact so it can be used with the emulator. For instructions on how to do that, please see the emulator documentation.

If you want to play around on the environment you can also do:

$ make run

Contributing

Thank you for your interest in Cartesi! Head over to our Contributing Guidelines for instructions on how to sign our Contributors Agreement and get started with Cartesi!

Please note we have a Code of Conduct, please follow it in all your interactions with the project.

Authors

• Diego Nehab
• Victor Fusco

License

The image-kernel repository and all contributions are licensed under APACHE 2.0. Please review our LICENSE file.