feat!: Add run and dev libcmt packages

cartesi · May 29, 2024 · 4bbc83c · 4bbc83c
1 parent 2a52a99
commit 4bbc83c
Show file tree

Hide file tree

Showing 8 changed files with 56 additions and 16 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -86,7 +86,7 @@ jobs:
         with:
           path: ${{ env.TOOLS_ROOTFS }}
 
-      - name: Build [${{ env.TOOLS_LIBCMT }}]
+      - name: Build [${{ env.TOOLS_LIBCMT }}, ${{ env.TOOLS_LIBCMT_DEV }}]
         id: docker_build_libcmt
         uses: docker/build-push-action@v4
         with:
@@ -98,23 +98,32 @@ jobs:
           target: libcmt-debian-packager
           build-args: |
             TOOLS_LIBCMT=${{ env.TOOLS_LIBCMT }}
+            TOOLS_LIBCMT_DEV=${{ env.TOOLS_LIBCMT_DEV }}
           cache-from: type=gha,scope=regular,mode=max
           cache-to: type=gha,scope=regular
 
-      - name: Retrieve artifacts
+      - name: Retrieve [${{ env.TOOLS_LIBCMT }}, ${{ env.TOOLS_LIBCMT_DEV }}]
         run: make copy-libcmt
 
       - name: Upload [${{ env.TOOLS_LIBCMT }}]
         uses: actions/upload-artifact@v3
         with:
-          path: ${{ env.TOOLS_LIBCMT }}
+          path:
+            ${{ env.TOOLS_LIBCMT }}
+
+      - name: Upload [${{ env.TOOLS_LIBCMT_DEV }}]
+        uses: actions/upload-artifact@v3
+        with:
+          path:
+            ${{ env.TOOLS_LIBCMT_DEV }}
 
       - 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
+          sha512sum ${{ env.TOOLS_LIBCMT_DEV }} > ${{ env.TOOLS_LIBCMT_DEV }}.sha512
 
       - uses: softprops/action-gh-release@v1
         if: startsWith(github.ref, 'refs/tags/v')
@@ -127,6 +136,8 @@ jobs:
             ${{ env.TOOLS_ROOTFS }}.sha512
             ${{ env.TOOLS_LIBCMT }}
             ${{ env.TOOLS_LIBCMT }}.sha512
+            ${{ env.TOOLS_LIBCMT_DEV }}
+            ${{ env.TOOLS_LIBCMT_DEV }}.sha512
 
   test:
     runs-on: ubuntu-latest-8-cores

diff --git a/Dockerfile b/Dockerfile
@@ -76,19 +76,24 @@ ARG BUILD_BASE=/opt/cartesi
 USER developer
 RUN make -C ${CMT_BASE} -j$(nproc) libcmt
 USER root
-RUN make -C ${BUILD_BASE}/tools/sys-utils/libcmt/ -j$(nproc) install TARGET_PREFIX=/usr/riscv64-linux-gnu
+RUN make -C ${BUILD_BASE}/tools/sys-utils/libcmt/ -j$(nproc) install-dev TARGET_PREFIX=/usr/riscv64-linux-gnu
 USER developer
 RUN make -C ${BUILD_BASE}/tools/sys-utils/ -j$(nproc) all
 
-# build libcmt debian package
+# build libcmt and libcmt-dev debian packages
 # ------------------------------------------------------------------------------
 FROM c-builder as libcmt-debian-packager
 ARG CMT_BASE=${BUILD_BASE}/tools/sys-utils/libcmt
 ARG TOOLS_LIBCMT=libcmt.deb
+ARG TOOLS_LIBCMT_DEV=libcmt-dev.deb
 USER root
-RUN make -C ${CMT_BASE} debian-package \
-    TARGET_DESTDIR=${BUILD_BASE}/_install \
+RUN make -C ${CMT_BASE} install-dev debian-dev-package \
+    TARGET_DESTDIR=${BUILD_BASE}/_install-dev \
     TARGET_PREFIX=/usr/riscv64-linux-gnu \
+    LIBCMT_DEB_FILENAME=${BUILD_BASE}/${TOOLS_LIBCMT_DEV}
+RUN make -C ${CMT_BASE} install debian-package \
+    TARGET_DESTDIR=${BUILD_BASE}/_install-run \
+    TARGET_PREFIX=/usr/ \
     LIBCMT_DEB_FILENAME=${BUILD_BASE}/${TOOLS_LIBCMT}
 
 # build rust tools

diff --git a/Makefile b/Makefile
@@ -20,10 +20,11 @@ PATCH := 0
 LABEL :=
 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
+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).deb
+TOOLS_LIBCMT_DEV := libcmt-v$(VERSION)-dev.deb
 
 IMAGE_KERNEL_VERSION ?= v0.20.0
 LINUX_VERSION ?= 6.5.13-ctsi-1
@@ -63,10 +64,11 @@ $(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:
+$(TOOLS_LIBCMT) $(TOOLS_LIBCMT_DEV) libcmt:
 	@docker buildx build --load \
 		--target libcmt-debian-packager \
 		--build-arg TOOLS_LIBCMT=$(TOOLS_LIBCMT) \
+		--build-arg TOOLS_LIBCMT_DEV=$(TOOLS_LIBCMT_DEV) \
 		-t $(TOOLS_IMAGE)-libcmt \
 		-f Dockerfile \
 		.
@@ -75,13 +77,15 @@ $(TOOLS_LIBCMT) libcmt:
 copy-libcmt:
 	@ID=`docker create $(TOOLS_IMAGE)-libcmt` && \
 	   docker cp $$ID:/opt/cartesi/$(TOOLS_LIBCMT) . && \
+	   docker cp $$ID:/opt/cartesi/$(TOOLS_LIBCMT_DEV) . && \
 	   docker rm $$ID
 
 env:
 	@echo TOOLS_DEB=$(TOOLS_DEB)
 	@echo TOOLS_ROOTFS=$(TOOLS_ROOTFS)
 	@echo TOOLS_IMAGE=$(TOOLS_IMAGE)
 	@echo TOOLS_LIBCMT=$(TOOLS_LIBCMT)
+	@echo TOOLS_LIBCMT_DEV=$(TOOLS_LIBCMT_DEV)
 	@echo IMAGE_KERNEL_VERSION=$(IMAGE_KERNEL_VERSION)
 	@echo LINUX_VERSION=$(LINUX_VERSION)
 	@echo LINUX_HEADERS_URLPATH=$(LINUX_HEADERS_URLPATH)

diff --git a/sys-utils/libcmt/Makefile b/sys-utils/libcmt/Makefile
@@ -81,16 +81,24 @@ $(libcmt_SO): $(libcmt_OBJ)
 	$(TARGET_CC) -shared -o $@ $^
 
 libcmt: $(libcmt_LIB) $(libcmt_SO)
-install: $(libcmt_LIB) $(libcmt_SO) build/ffi.h
+install: $(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
+
+debian-package:
+	mkdir -p $(TARGET_DESTDIR)/DEBIAN
+	sed 's|ARG_VERSION|$(LIBCMT_VERSION)|g;' tools/template/control.template > $(TARGET_DESTDIR)/DEBIAN/control
+	dpkg-deb -Zxz --root-owner-group --build $(TARGET_DESTDIR) $(LIBCMT_DEB_FILENAME)
+
+install-dev: install $(libcmt_LIB) $(libcmt_SO) build/ffi.h
+	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
+debian-dev-package:
 	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)

diff --git a/sys-utils/libcmt/doc/examples/abi_decode_001.c b/sys-utils/libcmt/doc/examples/abi_decode_001.c
@@ -1,7 +1,7 @@
 #include "libcmt/abi.h"
 #include "libcmt/buf.h"
 
-int decode_address(cmt_buf_t *rx, uint32_t expected_funsel, cmt_abi_address_t *address, cmt_abi_u256_t *value) {
+int decode(cmt_buf_t *rx, uint32_t expected_funsel, cmt_abi_address_t *address, cmt_abi_u256_t *value) {
     cmt_buf_t rd = *rx;
     return cmt_abi_check_funsel(&rd, expected_funsel)
     ||     cmt_abi_get_address(&rd, address)

diff --git a/sys-utils/libcmt/doc/examples/abi_decode_002.c b/sys-utils/libcmt/doc/examples/abi_decode_002.c
@@ -5,10 +5,13 @@ int decode(cmt_buf_t *rx, uint32_t expected_funsel, cmt_abi_address_t *address,
     cmt_buf_t rd = *rx;
     cmt_buf_t frame;
     cmt_buf_t offset;
+
+    /* static section */
     return cmt_abi_check_funsel(&rd, expected_funsel)
     ||     cmt_abi_mark_frame(&rd, &frame)
     ||     cmt_abi_get_address(&rd, address)
     ||     cmt_abi_get_bytes_s(&rd, &offset)
+    /* dynamic section */
     ||     cmt_abi_get_bytes_d(&rd, &offset, &payload->length, &payload->data)
     ;
 }

diff --git a/sys-utils/libcmt/doc/examples/abi_encode_000.c b/sys-utils/libcmt/doc/examples/abi_encode_000.c
@@ -3,6 +3,7 @@
 
 int encode_address(cmt_buf_t *tx, uint32_t funsel, cmt_abi_address_t *address) {
     cmt_buf_t wr = *tx;
+    /* static section */
     return cmt_abi_put_funsel(&wr, funsel)
     ||     cmt_abi_put_address(&wr, address);
 }
diff --git a/sys-utils/libcmt/tools/template/control.template b/sys-utils/libcmt/tools/template/control.template
@@ -0,0 +1,8 @@
+Package: libcmt
+Version: ARG_VERSION
+Architecture: riscv64
+Priority: optional
+Section: devel
+Maintainer: Machine Reference Unit <https://discord.com/channels/600597137524391947/1107965671976992878>
+Provides: libcmt
+Description: Libcmt Library and Headers