From b471d5783743af8bac7ca8899f78f8d4e1a1bf0a Mon Sep 17 00:00:00 2001 From: Eduardo Bart Date: Thu, 16 Jan 2025 10:40:49 -0300 Subject: [PATCH] refactor!: rename repository to machine-guest-tools --- .dockerignore | 2 +- .gitignore | 2 +- CHANGELOG.md | 42 ++++++++++++------------ Dockerfile | 2 +- Makefile | 14 ++++---- README.md | 8 ++--- fs/Dockerfile | 2 +- package.json.in | 2 +- rollup-http/echo-dapp/README.md | 4 +-- rollup-http/rollup-http-server/README.md | 4 +-- sys-utils/libcmt/README.md | 2 +- 11 files changed, 42 insertions(+), 42 deletions(-) diff --git a/.dockerignore b/.dockerignore index 35bcebd..3119d1b 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,4 +1,4 @@ -machine-emulator-tools-*.ext2 +machine-guest-tools-*.ext2 rootfs* .clang-format .github diff --git a/.gitignore b/.gitignore index 77ea73c..3a2a84f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ *.ext2 -machine-emulator-tools-*.tar.gz +machine-guest-tools-*.tar.gz rootfs.* package.json *.bin diff --git a/CHANGELOG.md b/CHANGELOG.md index 5bfa86a..e27c0db 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -178,24 +178,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - [0.2.0] - [0.1.0] -[Unreleased]: https://github.com/cartesi/machine-emulator-tools/compare/v0.16.1...HEAD -[0.16.1]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.16.1 -[0.16.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.16.0 -[0.15.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.15.0 -[0.14.1]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.14.1 -[0.14.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.14.0 -[0.13.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.13.0 -[0.12.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.12.0 -[0.11.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.11.0 -[0.10.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.10.0 -[0.9.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.9.0 -[0.8.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.8.0 -[0.7.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.7.0 -[0.6.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.6.0 -[0.5.1]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.5.1 -[0.5.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.5.0 -[0.4.1]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.4.1 -[0.4.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.4.0 -[0.3.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.3.0 -[0.2.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.2.0 -[0.1.0]: https://github.com/cartesi/machine-emulator-tools/releases/tag/v0.1.0 +[Unreleased]: https://github.com/cartesi/machine-guest-tools/compare/v0.16.1...HEAD +[0.16.1]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.16.1 +[0.16.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.16.0 +[0.15.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.15.0 +[0.14.1]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.14.1 +[0.14.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.14.0 +[0.13.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.13.0 +[0.12.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.12.0 +[0.11.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.11.0 +[0.10.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.10.0 +[0.9.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.9.0 +[0.8.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.8.0 +[0.7.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.7.0 +[0.6.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.6.0 +[0.5.1]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.5.1 +[0.5.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.5.0 +[0.4.1]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.4.1 +[0.4.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.4.0 +[0.3.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.3.0 +[0.2.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.2.0 +[0.1.0]: https://github.com/cartesi/machine-guest-tools/releases/tag/v0.1.0 diff --git a/Dockerfile b/Dockerfile index 36a442a..a47483f 100644 --- a/Dockerfile +++ b/Dockerfile @@ -62,5 +62,5 @@ RUN make -j$(nproc) libcmt RUN make -j$(nproc) sys-utils RUN make -j$(nproc) rollup-http RUN make install DESTDIR=$(pwd)/_install PREFIX=/usr -ARG TOOLS_TARGZ=machine-emulator-tools.tar.gz +ARG TOOLS_TARGZ=machine-guest-tools.tar.gz RUN cd _install && tar -czf /work/${TOOLS_TARGZ} * diff --git a/Makefile b/Makefile index 99a94b3..d8e62a2 100644 --- a/Makefile +++ b/Makefile @@ -20,14 +20,14 @@ PATCH := 2 LABEL := -test2 VERSION := $(MAJOR).$(MINOR).$(PATCH)$(LABEL) -TOOLS_TARGZ := machine-emulator-tools-v$(VERSION).tar.gz -TOOLS_IMAGE := cartesi/machine-emulator-tools:$(VERSION) +TOOLS_TARGZ := machine-guest-tools-v$(VERSION).tar.gz +TOOLS_IMAGE := cartesi/machine-guest-tools:$(VERSION) TOOLS_ROOTFS := rootfs-tools-v$(VERSION).ext2 TOOLS_ROOTFS_IMAGE := cartesi/rootfs-tools:$(VERSION) -IMAGE_KERNEL_VERSION ?= v0.20.0 +LINUX_IMAGE_VERSION ?= v0.20.0 LINUX_VERSION ?= 6.5.13-ctsi-1 -LINUX_HEADERS_URLPATH := https://github.com/cartesi/image-kernel/releases/download/${IMAGE_KERNEL_VERSION}/linux-libc-dev-riscv64-cross-${LINUX_VERSION}-${IMAGE_KERNEL_VERSION}.deb +LINUX_HEADERS_URLPATH := https://github.com/cartesi/machine-linux-image/releases/download/${LINUX_IMAGE_VERSION}/linux-libc-dev-riscv64-cross-${LINUX_VERSION}-${LINUX_IMAGE_VERSION}.deb LINUX_HEADERS_SHA256 := 2723435e8b45d8fb7a79e9344f6dc517b3dbc08e03ac17baab311300ec475c08 PREFIX ?= /usr @@ -88,7 +88,7 @@ env: ## Print useful Makefile information @echo TOOLS_ROOTFS=$(TOOLS_ROOTFS) @echo TOOLS_IMAGE=$(TOOLS_IMAGE) @echo TOOLS_ROOTFS_IMAGE=$(TOOLS_ROOTFS_IMAGE) - @echo IMAGE_KERNEL_VERSION=$(IMAGE_KERNEL_VERSION) + @echo LINUX_IMAGE_VERSION=$(LINUX_IMAGE_VERSION) @echo LINUX_VERSION=$(LINUX_VERSION) @echo LINUX_HEADERS_URLPATH=$(LINUX_HEADERS_URLPATH) @echo LINUX_HEADERS_SHA256=$(LINUX_HEADERS_SHA256) @@ -117,8 +117,8 @@ shell: ## Spawn a cross compilation shell with tools Docker image -e UID=$$(id -u) \ -e GID=$$(id -g) \ -u $$(id -u):$$(id -g) \ - -v `pwd`:/work/machine-emulator-tools \ - -w /work/machine-emulator-tools \ + -v `pwd`:/work/machine-guest-tools \ + -w /work/machine-guest-tools \ $(TOOLS_IMAGE)-tools-env /bin/bash libcmt: ## Compile libcmt diff --git a/README.md b/README.md index 8efdd75..3494d75 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Cartesi Machine Emulator Tools +# Cartesi Machine Guest Tools -The Cartesi Machine Emulator Tools is a repository that contains a set of tools developed for the RISC-V Linux OS. It provides a RISC-V Debian package and a root filesystem for Ubuntu 24.04. +The Cartesi Machine Guest Tools is a repository that contains a set of tools developed for the RISC-V Linux OS. It provides a RISC-V Debian package and a root filesystem for Ubuntu 24.04. ## Getting Started @@ -37,7 +37,7 @@ In case you need to patch and develop tools, you can cross compile using Docker make build ``` -This creates the `machine-emulator-tools-$VERSION.tar.gz` archive and the `rootfs-tools-$VERSION.ext2` root filesystem artifacts. +This creates the `machine-guest-tools-$VERSION.tar.gz` archive and the `rootfs-tools-$VERSION.ext2` root filesystem artifacts. Both should only be use for testing and development purposes, not directly in dapps. #### Makefile targets @@ -53,5 +53,5 @@ Please note we have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it in ## License -The machine-emulator-tools repository and all contributions are licensed under +The machine-guest-tools repository and all contributions are licensed under [APACHE 2.0](https://www.apache.org/licenses/LICENSE-2.0). Please review our [LICENSE](LICENSE) file. diff --git a/fs/Dockerfile b/fs/Dockerfile index d889790..488ffa8 100644 --- a/fs/Dockerfile +++ b/fs/Dockerfile @@ -1,6 +1,6 @@ # Final image FROM --platform=linux/riscv64 ubuntu:24.04 -ARG TOOLS_TARGZ=machine-emulator-tools.tar.gz +ARG TOOLS_TARGZ=machine-guest-tools.tar.gz ADD ${TOOLS_TARGZ} / RUN apt-get update && \ apt-get upgrade -y --no-install-recommends && \ diff --git a/package.json.in b/package.json.in index f5188c6..755bea6 100644 --- a/package.json.in +++ b/package.json.in @@ -1,4 +1,4 @@ { - "name": "machine-emulator-tools", + "name": "cartesi-machine-guest-tools", "version": "ARG_VERSION" } diff --git a/rollup-http/echo-dapp/README.md b/rollup-http/echo-dapp/README.md index eef1297..81e2883 100644 --- a/rollup-http/echo-dapp/README.md +++ b/rollup-http/echo-dapp/README.md @@ -18,13 +18,13 @@ To install Rust follow the instructions [here](https://www.rust-lang.org/tools/i This DApp is built during the docker build process: ```shell -$ cd machine-emulator-tools +$ cd machine-guest-tools $ make ``` ## Execution -Utility script `rollup-init` is used to start simultaneously DApp application and Rollup HTTP server (available in `linux/utils` folder of the root `machine-emulator-tools` project). +Utility script `rollup-init` is used to start simultaneously DApp application and Rollup HTTP server (available in `linux/utils` folder of the root `machine-guest-tools` project). After build copy Dapp and http dispatcher application to the new directory. Create ext2 filesystem image from that directory. diff --git a/rollup-http/rollup-http-server/README.md b/rollup-http/rollup-http-server/README.md index 6881763..75a7567 100644 --- a/rollup-http/rollup-http-server/README.md +++ b/rollup-http/rollup-http-server/README.md @@ -13,7 +13,7 @@ To install Rust follow the instructions [here](https://www.rust-lang.org/tools/i This service is built within the docker build step when building all other tools: ```shell -cd machine-emulator-tools +cd machine-guest-tools make ``` @@ -21,7 +21,7 @@ make First build libcmt mock on host: ```shell -cd machine-emulator-tools/sys-utils/libcmt/ +cd machine-guest-tools/sys-utils/libcmt/ make host ``` diff --git a/sys-utils/libcmt/README.md b/sys-utils/libcmt/README.md index f5d86f2..aa374b2 100644 --- a/sys-utils/libcmt/README.md +++ b/sys-utils/libcmt/README.md @@ -14,7 +14,7 @@ And finally, a couple of utility modules used by the high level API are also exp - @ref libcmt\_merkle is a sparse merkle tree implementation on top of keccak. - @ref libcmt\_keccak is the hashing function used extensively by Ethereum. -The header files and a compiled RISC-V version of this library can be found [here](https://github.com/cartesi/machine-emulator-tools/). +The header files and a compiled RISC-V version of this library can be found [here](https://github.com/cartesi/machine-guest-tools/). We also provide `.pc` (pkg-config) files to facilitate linking. # mock and testing