feat!: Add run and dev libcmt packages

.github/workflows/main.yml

@@ -76,7 +76,7 @@ jobs:
       - name: Build rootfs
         run: make fs
 
-      - name: Build [${{ env.TOOLS_LIBCMT }}]
+      - name: Build libcmt
         id: docker_build_libcmt
         uses: docker/build-push-action@v5
         with:
@@ -85,9 +85,9 @@ jobs:
           tags: ${{ env.TOOLS_IMAGE }}-libcmt
           push: false
           load: true
-          target: libcmt-debian-packager
           build-args: |
-            TOOLS_LIBCMT=${{ env.TOOLS_LIBCMT }}
+            VERSION=${{ env.VERSION }}
+          target: libcmt-debian-packager
           cache-from: type=gha,scope=regular,mode=max
           cache-to: type=gha,scope=regular
 
@@ -101,14 +101,14 @@ jobs:
           path: |
             ${{ env.TOOLS_DEB }}
             ${{ env.TOOLS_ROOTFS }}
-            ${{ env.TOOLS_LIBCMT }}
+            libcmt/deb/*
 
       - name: Checksum artifacts
         if: startsWith(github.ref, 'refs/tags/v')
         run: |
           sha512sum ${{ env.TOOLS_DEB }} > ${{ env.TOOLS_DEB }}.sha512
           sha512sum ${{ env.TOOLS_ROOTFS }} > ${{ env.TOOLS_ROOTFS }}.sha512
-          sha512sum ${{ env.TOOLS_LIBCMT }} > ${{ env.TOOLS_LIBCMT }}.sha512
+          for f in libcmt/deb/*; sha512sum $f > libcmt/$f.sha512; done
 
       - uses: softprops/action-gh-release@v1
         if: startsWith(github.ref, 'refs/tags/v')
@@ -119,8 +119,8 @@ jobs:
             ${{ env.TOOLS_DEB }}.sha512
             ${{ env.TOOLS_ROOTFS }}
             ${{ env.TOOLS_ROOTFS }}.sha512
-            ${{ env.TOOLS_LIBCMT }}
-            ${{ env.TOOLS_LIBCMT }}.sha512
+            libcmt/deb/*
+            libcmt/deb/*.sha512
 
   test:
     runs-on: ubuntu-latest-8-cores

Dockerfile

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-FROM ubuntu:22.04 as tools-env
+FROM ubuntu:22.04 AS tools-env
 ARG IMAGE_KERNEL_VERSION=v0.20.0
 ARG LINUX_VERSION=6.5.13-ctsi-1
 ARG 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
@@ -64,12 +64,12 @@ ENV RISCV_ABI="lp64d"
 ENV CFLAGS="-march=$RISCV_ARCH -mabi=$RISCV_ABI"
 ENV TOOLCHAIN_PREFIX="riscv64-linux-gnu-"
 
-FROM tools-env as builder
+FROM tools-env AS builder
 COPY --chown=developer:developer sys-utils/ ${BUILD_BASE}/tools/sys-utils/
 
 # build C/C++ tools
 # ------------------------------------------------------------------------------
-FROM builder as c-builder
+FROM builder AS c-builder
 ARG CMT_BASE=${BUILD_BASE}/tools/sys-utils/libcmt
 ARG BUILD_BASE=/opt/cartesi
 
@@ -82,18 +82,32 @@ RUN make -C ${BUILD_BASE}/tools/sys-utils/ -j$(nproc) all
 
 # build libcmt debian package
 # ------------------------------------------------------------------------------
-FROM c-builder as libcmt-debian-packager
+FROM c-builder AS libcmt-debian-packager
 ARG CMT_BASE=${BUILD_BASE}/tools/sys-utils/libcmt
-ARG TOOLS_LIBCMT=libcmt.deb
+ARG VERSION=0.0.0
 USER root
-RUN make -C ${CMT_BASE} debian-package \
-    TARGET_DESTDIR=${BUILD_BASE}/_install \
-    TARGET_PREFIX=/usr/riscv64-linux-gnu \
-    LIBCMT_DEB_FILENAME=${BUILD_BASE}/${TOOLS_LIBCMT}
+
+RUN make -C ${CMT_BASE} \
+        ARG_VERSION=${VERSION} \
+        TARGET_PREFIX=/usr \
+        TARGET_DESTDIR=${BUILD_BASE}/install/run \
+        install-run libcmt-v${VERSION}.deb
+
+RUN make -C ${CMT_BASE} \
+        ARG_VERSION=${VERSION} \
+        TARGET_PREFIX=/usr \
+        TARGET_DESTDIR=${BUILD_BASE}/install/dev \
+        install libcmt-dev-v${VERSION}.deb
+
+RUN make -C ${CMT_BASE} \
+        ARG_VERSION=${VERSION} \
+        TARGET_PREFIX=/usr/riscv64-linux-gnu \
+        TARGET_DESTDIR=${BUILD_BASE}/install/cross \
+        install libcmt-dev-riscv64-cross-v${VERSION}.deb
 
 # build rust tools
 # ------------------------------------------------------------------------------
-FROM c-builder as rust-env
+FROM c-builder AS rust-env
 ENV PATH="/home/developer/.cargo/bin:${PATH}"
 ENV PKG_CONFIG_PATH_riscv64gc_unknown_linux_gnu="/usr/riscv64-linux-gnu/lib/pkgconfig"
 ENV PKG_CONFIG_riscv64gc_unknown_linux_gnu="/usr/bin/pkg-config"
@@ -111,13 +125,13 @@ RUN cd  && \
         --target riscv64gc-unknown-linux-gnu && \
     rm -rf rustup-1.27.0 1.27.0.tar.gz
 
-FROM rust-env as rust-builder
+FROM rust-env AS rust-builder
 COPY --chown=developer:developer rollup-http/rollup-init ${BUILD_BASE}/tools/rollup-http/rollup-init
 COPY --chown=developer:developer rollup-http/rollup-http-client ${BUILD_BASE}/tools/rollup-http/rollup-http-client
 COPY --chown=developer:developer rollup-http/.cargo ${BUILD_BASE}/tools/rollup-http/.cargo
 
 # build rollup-http-server dependencies
-FROM rust-builder as http-server-dep-builder
+FROM rust-builder AS http-server-dep-builder
 COPY --chown=developer:developer rollup-http/rollup-http-server/Cargo.toml rollup-http/rollup-http-server/Cargo.lock ${BUILD_BASE}/tools/rollup-http/rollup-http-server/
 RUN cd ${BUILD_BASE}/tools/rollup-http/rollup-http-server && \
     mkdir src/ && \
@@ -126,28 +140,28 @@ RUN cd ${BUILD_BASE}/tools/rollup-http/rollup-http-server && \
     cargo build --target riscv64gc-unknown-linux-gnu --release
 
 # build rollup-http-server
-FROM http-server-dep-builder as http-server-builder
+FROM http-server-dep-builder AS http-server-builder
 COPY --chown=developer:developer rollup-http/rollup-http-server/build.rs ${BUILD_BASE}/tools/rollup-http/rollup-http-server/
 COPY --chown=developer:developer rollup-http/rollup-http-server/src ${BUILD_BASE}/tools/rollup-http/rollup-http-server/src
 RUN cd ${BUILD_BASE}/tools/rollup-http/rollup-http-server && touch build.rs src/* && \
     cargo build --target riscv64gc-unknown-linux-gnu --release
 
 # build echo-dapp dependencies
-FROM rust-builder as echo-dapp-dep-builder
+FROM rust-builder AS echo-dapp-dep-builder
 COPY --chown=developer:developer rollup-http/echo-dapp/Cargo.toml rollup-http/echo-dapp/Cargo.lock ${BUILD_BASE}/tools/rollup-http/echo-dapp/
 RUN cd ${BUILD_BASE}/tools/rollup-http/echo-dapp && \
     mkdir src/ && echo "fn main() {}" > src/main.rs && \
     cargo build --target riscv64gc-unknown-linux-gnu --release
 
 # build echo-dapp
-FROM echo-dapp-dep-builder as echo-dapp-builder
+FROM echo-dapp-dep-builder AS echo-dapp-builder
 COPY --chown=developer:developer rollup-http/echo-dapp/src ${BUILD_BASE}/tools/rollup-http/echo-dapp/src
 RUN cd ${BUILD_BASE}/tools/rollup-http/echo-dapp && touch src/* && \
     cargo build --target riscv64gc-unknown-linux-gnu --release
 
 # pack tools (deb)
 # ------------------------------------------------------------------------------
-FROM tools-env as packer
+FROM tools-env AS packer
 ARG TOOLS_DEB=machine-emulator-tools.deb
 ARG STAGING_BASE=${BUILD_BASE}/_install
 ARG STAGING_DEBIAN=${STAGING_BASE}/DEBIAN

Makefile

@@ -23,7 +23,6 @@ VERSION := $(MAJOR).$(MINOR).$(PATCH)$(LABEL)
 TOOLS_DEB    := machine-emulator-tools-v$(VERSION).deb
 TOOLS_IMAGE  := cartesi/machine-emulator-tools:$(VERSION)
 TOOLS_ROOTFS := rootfs-tools-v$(VERSION).ext2
-TOOLS_LIBCMT := libcmt-v$(VERSION)-dev.deb
 
 IMAGE_KERNEL_VERSION ?= v0.20.0
 LINUX_VERSION ?= 6.5.13-ctsi-1
@@ -63,25 +62,28 @@ $(TOOLS_ROOTFS) fs: $(TOOLS_DEB)
 	xgenext2fs -fzB 4096 -b 25600 -i 4096 -a rootfs.tar -L rootfs $(TOOLS_ROOTFS) && \
 	rm -f rootfs.tar
 
-$(TOOLS_LIBCMT) libcmt:
+libcmt:
+	@mkdir $@
+
+build-libcmt:
 	@docker buildx build --load \
 		--target libcmt-debian-packager \
-		--build-arg TOOLS_LIBCMT=$(TOOLS_LIBCMT) \
+		--build-arg VERSION=$(VERSION) \
 		-t $(TOOLS_IMAGE)-libcmt \
 		-f Dockerfile \
 		.
 	$(MAKE) copy-libcmt
 
-copy-libcmt:
+copy-libcmt: libcmt
 	@ID=`docker create $(TOOLS_IMAGE)-libcmt` && \
-	   docker cp $$ID:/opt/cartesi/$(TOOLS_LIBCMT) . && \
+	   docker cp $$ID:/opt/cartesi/tools/sys-utils/libcmt/build/deb/ libcmt && \
 	   docker rm $$ID
 
 env:
+	@echo VERSION=$(VERSION)
 	@echo TOOLS_DEB=$(TOOLS_DEB)
 	@echo TOOLS_ROOTFS=$(TOOLS_ROOTFS)
 	@echo TOOLS_IMAGE=$(TOOLS_IMAGE)
-	@echo TOOLS_LIBCMT=$(TOOLS_LIBCMT)
 	@echo IMAGE_KERNEL_VERSION=$(IMAGE_KERNEL_VERSION)
 	@echo LINUX_VERSION=$(LINUX_VERSION)
 	@echo LINUX_HEADERS_URLPATH=$(LINUX_HEADERS_URLPATH)
@@ -128,7 +130,7 @@ clean-image:
 	@(docker rmi $(TOOLS_IMAGE) > /dev/null 2>&1 || true)
 
 clean:
-	@rm -f $(TOOLS_DEB) control rootfs* libcmt-*
+	@rm -f $(TOOLS_DEB) control rootfs* libcmt*
 	@$(MAKE) -C sys-utils clean
 
 distclean: clean clean-image
@@ -146,4 +148,4 @@ help:
 	@echo '  env             - print useful Makefile variables as a KEY=VALUE list'
 	@echo '  clean           - remove the generated artifacts'
 
-.PHONY: build fs deb env setup setup-required help distclean
+.PHONY: build fs deb build-libcmt env setup setup-required help distclean

fs/Dockerfile

@@ -1,4 +1,4 @@
-FROM --platform=$BUILDPLATFORM ubuntu:22.04 as cross-builder
+FROM --platform=$BUILDPLATFORM ubuntu:22.04 AS cross-builder
 ENV BUILD_BASE=/tmp/build-extra
 
 # Install dependencies

sys-utils/libcmt/Makefile

@@ -13,13 +13,6 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
-LIBCMT_VERSION ?=0.0.0
-
-INSTALL_FILE= install -m0644
-INSTALL_EXEC= install -m0755
-
-# paths
 PREFIX = /usr
 TARGET_PREFIX ?= $(PREFIX)
 
@@ -65,7 +58,7 @@ libcmt_SRC := \
 	src/util.c \
 	src/io.c
 
-libcmt_OBJDIR    := build/lib
+libcmt_OBJDIR    := build/riscv64
 libcmt_OBJ       := $(patsubst %.c,$(libcmt_OBJDIR)/%.o,$(libcmt_SRC))
 libcmt_LIB       := $(libcmt_OBJDIR)/libcmt.a
 libcmt_SO        := $(libcmt_OBJDIR)/libcmt.so
@@ -81,19 +74,62 @@ $(libcmt_SO): $(libcmt_OBJ)
 	$(TARGET_CC) -shared -o $@ $^
 
 libcmt: $(libcmt_LIB) $(libcmt_SO)
-install: $(libcmt_LIB) $(libcmt_SO) build/ffi.h
+install-run: $(libcmt_SO)
 	mkdir -p $(TARGET_DESTDIR)$(TARGET_PREFIX)/lib
-	cp -f $(libcmt_LIB) $(libcmt_SO) $(TARGET_DESTDIR)$(TARGET_PREFIX)/lib
+	cp -f $(libcmt_SO) $(TARGET_DESTDIR)$(TARGET_PREFIX)/lib
+
+install: $(libcmt_LIB) build/ffi.h
+	mkdir -p $(TARGET_DESTDIR)$(TARGET_PREFIX)/lib
+	cp -f $(libcmt_LIB) $(TARGET_DESTDIR)$(TARGET_PREFIX)/lib
 	mkdir -p $(TARGET_DESTDIR)$(TARGET_PREFIX)/include/libcmt/
 	cp -f include/libcmt/*.h $(TARGET_DESTDIR)$(TARGET_PREFIX)/include/libcmt/
 	cp -f build/ffi.h $(TARGET_DESTDIR)$(TARGET_PREFIX)/include/libcmt/
 	mkdir -p $(TARGET_DESTDIR)$(TARGET_PREFIX)/lib/pkgconfig
-	sed -e 's|@ARG_PREFIX@|$(TARGET_PREFIX)|g' src/libcmt.pc > $(TARGET_DESTDIR)$(TARGET_PREFIX)/lib/pkgconfig/libcmt.pc
-
-debian-package: install
-	mkdir -p $(TARGET_DESTDIR)/DEBIAN
-	sed 's|ARG_VERSION|$(LIBCMT_VERSION)|g;' tools/template/cross-control.template > $(TARGET_DESTDIR)/DEBIAN/control
-	dpkg-deb -Zxz --root-owner-group --build $(TARGET_DESTDIR) $(LIBCMT_DEB_FILENAME)
+	sed -e 's|@PREFIX@|$(TARGET_PREFIX)|g' \
+	    tools/libcmt.pc.in > $(TARGET_DESTDIR)$(TARGET_PREFIX)/lib/pkgconfig/libcmt.pc
+
+# requires either install-run or install
+debian-package:
+	mkdir -p $(dir $(DEB_FILENAME))
+	dpkg-deb -Zxz --root-owner-group --build $(TARGET_DESTDIR) $(DEB_FILENAME)
+
+$(TARGET_DESTDIR)/DEBIAN/control: tools/control.in
+	mkdir -p $(@D)
+	sed -e 's|@PACKAGE@|$(ARG_PACKAGE)|' \
+	    -e 's|@VERSION@|$(ARG_VERSION)|' \
+	    -e 's|@ARCHITECTURE@|$(ARG_ARCHITECTURE)|' \
+	    -e 's|@SECTION@|$(ARG_SECTION)|' \
+	    -e 's|@PROVIDES@|$(ARG_PROVIDES)|' \
+	    -e 's|@DESCRIPTION@|$(ARG_DESCRIPTION)|' \
+	    $< > $@
+
+# debian package variants
+libcmt-v$(ARG_VERSION).deb:
+	$(MAKE) $(TARGET_DESTDIR)/DEBIAN/control \
+	        ARG_PACKAGE=libcmt \
+	        ARG_ARCHITECTURE=riscv64 \
+	        ARG_PROVIDES=libcmt \
+	        ARG_SECTION=libs \
+	        ARG_DESCRIPTION="Cartesi Machine Tools"
+	$(MAKE) debian-package DEB_FILENAME=build/deb/$@
+
+libcmt-dev-v$(ARG_VERSION).deb:
+	$(MAKE) $(TARGET_DESTDIR)/DEBIAN/control \
+	        ARG_PACKAGE=libcmt-dev \
+	        ARG_ARCHITECTURE=riscv64 \
+	        ARG_PROVIDES=libcmt-dev \
+	        ARG_SECTION=devel \
+	        ARG_DESCRIPTION="Cartesi Machine Tools - (development files)"
+	$(MAKE) debian-package DEB_FILENAME=build/deb/$@
+
+libcmt-dev-riscv64-cross-v$(ARG_VERSION).deb:
+	$(MAKE) $(TARGET_DESTDIR)/DEBIAN/control \
+	        ARG_PACKAGE=libcmt-riscv64-cross \
+	        ARG_ARCHITECTURE=all \
+	        ARG_PROVIDES=libcmt-dev-riscv64-cross \
+	        ARG_SECTION=devel \
+	        ARG_DESCRIPTION="Cartesi Machine Tools - (development files) (riscv64)"
+	$(MAKE) debian-package DEB_FILENAME=build/deb/$@
 
 #-------------------------------------------------------------------------------
 mock_SRC := \
@@ -259,4 +295,5 @@ distclean: clean
 
 OBJ := $(mock_OBJ) $(libcmt_OBJ) $(examples_OBJ) $(tools_OBJ)
 
+.PHONY: install
 -include $(OBJ:%.o=%.d)