Refactor C API

.clang-format

@@ -16,4 +16,4 @@ ConstructorInitializerAllOnOneLineOrOnePerLine: true
 IndentCaseLabels: true
 IndentWidth: 4
 SpaceAfterCStyleCast: true
-Standard: c++17
+Standard: c++20

.clang-tidy

@@ -1,51 +1,51 @@
 Checks: >-
   boost*,
   bugprone*,
-  -bugprone-branch-clone,
   -bugprone-easily-swappable-parameters,
   cert*,
   clang-analyzer*,
+  -clang-analyzer-optin.cplusplus.VirtualCall,
   cppcoreguidelines*,
   -cppcoreguidelines-avoid-magic-numbers,
-  -cppcoreguidelines-non-private-member-variables-in-classes,
   -cppcoreguidelines-owning-memory,
-  -cppcoreguidelines-pro-bounds*,
+  -cppcoreguidelines-pro-bounds-array-to-pointer-decay,
+  -cppcoreguidelines-pro-bounds-constant-array-index,
+  -cppcoreguidelines-pro-bounds-pointer-arithmetic,
   -cppcoreguidelines-pro-type-vararg,
   -cppcoreguidelines-avoid-c-arrays,
-  google-readability-*,
+  google*,
+  -google-build-using-namespace,
+  hicpp*,
+  -hicpp-avoid-c-arrays,
+  -hicpp-no-array-decay,
+  -hicpp-signed-bitwise,
+  -hicpp-vararg,
   misc*,
   -misc-no-recursion,
   -misc-non-private-member-variables-in-classes,
   -misc-use-anonymous-namespace,
+  -misc-include-cleaner,
   modernize*,
-  -modernize-redundant-void-arg,
-  -modernize-use-default-member-init,
   -modernize-use-nodiscard,
   -modernize-use-trailing-return-type,
   -modernize-avoid-c-arrays,
-  -modernize-use-auto,
   performance*,
+  -performance-enum-size,
   portability*,
   readability*,
-  -readability-else-after-return,
   -readability-function-cognitive-complexity,
-  -readability-implicit-bool-conversion,
   -readability-identifier-length,
   -readability-magic-numbers,
-  -readability-named-parameter,
-  -readability-redundant-member-init
 WarningsAsErrors: >-
   boost*,
   bugprone*,
   cert*,
   clang-analyzer*,
   cppcoreguidelines*,
   google*,
+  hicpp*,
   misc*,
   modernize*,
   performance*,
   portability*,
-  readability*
-CheckOptions:
-  - key: performance-move-const-arg.CheckTriviallyCopyableMove
-    value: 'false'
+  readability*,

Dockerfile

@@ -6,20 +6,26 @@ ARG SANITIZE=no
 
 RUN apt-get update && \
     DEBIAN_FRONTEND="noninteractive" apt-get install --no-install-recommends -y \
-    build-essential vim wget git clang-tidy-16 clang-format-16 lcov \
+    build-essential vim wget git lcov \
     libboost1.81-dev libssl-dev libslirp-dev \
     ca-certificates pkg-config lua5.4 liblua5.4-dev \
     luarocks xxd procps && \
-    update-alternatives --install /usr/bin/clang-format clang-format /usr/bin/clang-format-16 120 && \
-    update-alternatives --install /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-16 120 && \
-    rm -rf /var/lib/apt/lists/*
+    rm -rf /var/lib/apt/lists/* /var/cache/apt/*
 
+RUN apt-get update && \
+    DEBIAN_FRONTEND="noninteractive" apt-get install --no-install-recommends -y wget software-properties-common gnupg && \
+    wget -qO- https://apt.llvm.org/llvm-snapshot.gpg.key | tee /etc/apt/trusted.gpg.d/apt.llvm.org.asc && \
+    add-apt-repository -y 'deb http://apt.llvm.org/bookworm/  llvm-toolchain-bookworm-18 main' && \
+    add-apt-repository -y 'deb http://apt.llvm.org/bookworm/  llvm-toolchain-bookworm-18 main' && \
+    apt-get update && \
+    apt-get install --no-install-recommends -y clang-tidy-18 clang-format-18 && \
+    update-alternatives --install /usr/bin/clang-format clang-format /usr/bin/clang-format-18 120 && \
+    update-alternatives --install /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-18 120 && \
+    rm -rf /var/lib/apt/lists/* /var/cache/apt/*
 
 RUN luarocks install --lua-version=5.4 luasocket && \
     luarocks install --lua-version=5.4 luasec && \
     luarocks install --lua-version=5.4 luaposix && \
-    luarocks install --lua-version=5.4 lpeg && \
-    luarocks install --lua-version=5.4 dkjson && \
     luarocks install --lua-version=5.4 luacheck && \
     cargo install [email protected] --features lua54
 

Makefile

@@ -84,8 +84,7 @@ EMU_LUA_TO_BIN= src/cartesi-machine.lua src/cartesi-machine-stored-hash.lua
 EMU_TO_LUA_PATH= src/cartesi/util.lua src/cartesi/proof.lua src/cartesi/gdbstub.lua
 EMU_TO_LUA_CPATH= src/cartesi.so
 EMU_TO_LUA_CARTESI_CPATH= src/cartesi/jsonrpc.so
-EMU_TO_INC= $(addprefix src/,jsonrpc-machine-c-api.h machine-c-api.h \
-	    machine-c-defines.h machine-c-version.h pma-defines.h rtc-defines.h htif-defines.h uarch-defines.h)
+EMU_TO_INC= $(addprefix src/,jsonrpc-machine-c-api.h machine-c-api.h machine-c-version.h)
 UARCH_TO_SHARE= uarch-ram.bin
 
 TESTS_TO_BIN= tests/build/misc/test-merkle-tree-hash tests/build/misc/test-machine-c-api

README.md

@@ -38,7 +38,7 @@ Cleaning targets:
 
 ### Requirements
 
-- C++ Compiler with support for C++17 (tested with GCC >= 8+ and Clang >= 8.x).
+- C++ Compiler with support for C++20 (tested with GCC >= 8+ and Clang >= 8.x).
 - GNU Make >= 3.81
 - Lua >= 5.4.4
 - Libslirp >= 4.6.0
@@ -54,8 +54,6 @@ sudo apt-get install build-essential wget git clang-tidy-16 clang-format-16 \
         ca-certificates pkg-config lua5.4 liblua5.4-dev \
         luarocks
 
-sudo luarocks install --lua-version=5.4 lpeg
-sudo luarocks install --lua-version=5.4 dkjson
 sudo luarocks install --lua-version=5.4 luasocket
 sudo luarocks install --lua-version=5.4 luasec
 sudo luarocks install --lua-version=5.4 luaposix
@@ -70,8 +68,6 @@ For more information, see the [Configuring Lua 5.4](#configuring-lua-54) section
 ```bash
 sudo port install clang-16 boost181 wget pkgconfig lua54 lua-luarocks libslirp
 
-sudo luarocks install --lua-version=5.4 lpeg
-sudo luarocks install --lua-version=5.4 dkjson
 sudo luarocks install --lua-version=5.4 luasocket
 sudo luarocks install --lua-version=5.4 luasec
 sudo luarocks install --lua-version=5.4 luaposix
@@ -84,8 +80,6 @@ For more information, see the [Configuring Lua 5.4](#configuring-lua-54) section
 ```bash
 brew install llvm@16 boost wget pkg-config openssl lua luarocks libslirp
 
-luarocks --lua-dir=$(brew --prefix)/opt/lua install lpeg
-luarocks --lua-dir=$(brew --prefix)/opt/lua install dkjson
 luarocks --lua-dir=$(brew --prefix)/opt/lua install luasocket
 luarocks --lua-dir=$(brew --prefix)/opt/lua install luasec
 luarocks --lua-dir=$(brew --prefix)/opt/lua install luaposix

src/.gitignore

@@ -1,5 +1,3 @@
-*.pb.h
-*.pb.cc
 *.ext2
 *.bin
 *.gcno

src/Makefile

@@ -132,7 +132,9 @@ LIBCARTESI_JSONRPC=libcartesi_jsonrpc-$(EMULATOR_VERSION_MAJOR).$(EMULATOR_VERSI
 ifeq ($(slirp),yes)
 # Workaround for building with macports lua-luarocks installation
 machine.o: INCS+=$(SLIRP_INC)
+machine.clang-tidy: INCS+=$(SLIRP_INC)
 virtio-net-carrier-slirp.o: INCS+=$(SLIRP_INC)
+virtio-net-carrier-slirp.clang-tidy: INCS+=$(SLIRP_INC)
 #INCS+=$(SLIRP_INC)
 LIBCARTESI_COMMON_LIBS+=$(SLIRP_LIB)
 else
@@ -149,7 +151,7 @@ HASH_LIBS=
 
 #DEFS+= -DMT_ALL_DIRTY
 
-WARNS=-Wall -Wpedantic
+WARNS=-Wall -Wextra -Wpedantic
 
 # Place our include directories before the system's
 INCS+= \
@@ -162,6 +164,12 @@ INCS+= \
 # Use 64-bit offsets for file operations in POSIX APIs
 DEFS+=-D_FILE_OFFSET_BITS=64
 
+# Disable json filesystem to support more compilers
+DEFS+=-DJSON_HAS_FILESYSTEM=0
+
+# Disable ASIO threads and use asio select() backend to avoid potential issues fork()
+DEFS+=-DBOOST_ASIO_DISABLE_THREADS -DBOOST_ASIO_DISABLE_EPOLL -DBOOST_ASIO_DISABLE_EVENTFD
+
 ifeq ($(dump),yes)
 #DEFS+=-DDUMP_ILLEGAL_INSN_EXCEPTIONS
 #DEFS+=-DDUMP_EXCEPTIONS
@@ -187,10 +195,13 @@ INTERPRET_CXXFLAGS+=-DNDEBUG # disable asserts only for interpret.cpp
 else ifeq ($(release),yes)
 OPTFLAGS+=-O2
 DEFS+=-DNDEBUG # disable all asserts
+DEFS+=-DBOOST_ASIO_DISABLE_ERROR_LOCATION # remove line/function location from error messages
 else ifeq ($(debug),yes)
-OPTFLAGS+=-Og -g
+OPTFLAGS+=-Og -g -fno-omit-frame-pointer
+OPTFLAGS+=-D_FORTIFY_SOURCE=3 -D_GLIBCXX_ASSERTIONS -fstack-clash-protection -fstack-protector-strong
 else ifeq ($(sanitize),yes)
-OPTFLAGS+=-O1 -g
+OPTFLAGS+=-O1 -g -fno-omit-frame-pointer
+OPTFLAGS+=-D_FORTIFY_SOURCE=3 -D_GLIBCXX_ASSERTIONS -fstack-clash-protection -fstack-protector-strong
 endif
 
 # Git commit hash (for releases)
@@ -281,7 +292,7 @@ else
 DEFS+=-DNO_THREADS
 endif
 
-CXXFLAGS+=$(OPTFLAGS) -std=gnu++17 -fvisibility=hidden -MMD $(PICCFLAGS) $(CC_MARCH) $(INCS) $(GCFLAGS) $(UBFLAGS) $(DEFS) $(WARNS)
+CXXFLAGS+=$(OPTFLAGS) -std=gnu++20 -fvisibility=hidden -MMD $(PICCFLAGS) $(CC_MARCH) $(INCS) $(GCFLAGS) $(UBFLAGS) $(DEFS) $(WARNS)
 CFLAGS+=$(OPTFLAGS) -std=gnu99 -fvisibility=hidden -MMD $(PICCFLAGS) $(CC_MARCH) $(INCS) $(GCFLAGS) $(UBFLAGS) $(DEFS) $(WARNS)
 LDFLAGS+=$(UBFLAGS)
 
@@ -368,15 +379,12 @@ LIBCARTESI_OBJS:= \
 CARTESI_CLUA_OBJS:= \
 	clua.o \
 	clua-i-virtual-machine.o \
-	clua-htif.o \
-	clua-machine-util.o \
 	uarch-pristine-ram.o \
 	uarch-pristine-state-hash.o \
 	uarch-pristine-hash.o
 
 LUACARTESI_OBJS:= \
 	clua-cartesi.o \
-	clua-machine.o \
 	$(CARTESI_CLUA_OBJS)
 
 LIBCARTESI_MERKLE_TREE_OBJS:= \
@@ -392,14 +400,14 @@ MERKLE_TREE_HASH_OBJS:= \
 
 LIBCARTESI_JSONRPC_OBJS:= \
 	jsonrpc-virtual-machine.o \
+	os.o \
 	jsonrpc-machine-c-api.o \
 	uarch-pristine-ram.o \
 	uarch-pristine-state-hash.o \
 	uarch-pristine-hash.o
 
 LUACARTESI_JSONRPC_OBJS:= \
 	clua-cartesi-jsonrpc.o \
-	clua-jsonrpc-machine.o \
 	$(CARTESI_CLUA_OBJS)
 
 JSONRPC_REMOTE_CARTESI_MACHINE_OBJS:= \
@@ -533,12 +541,12 @@ jsonrpc-discover.cpp: jsonrpc-discover.json
 	echo '} // namespace cartesi' >> jsonrpc-discover.cpp
 
 %.clang-tidy: %.cpp machine-c-version.h
-	@$(CLANG_TIDY) --header-filter='$(CLANG_TIDY_HEADER_FILTER)' $< -- $(CXXFLAGS) $(LUA_INC) 2>/dev/null
+	@$(CLANG_TIDY) --header-filter='$(CLANG_TIDY_HEADER_FILTER)' $(CLANG_TIDY_FLAGS) $< -- $(CXXFLAGS) $(LUA_INC) 2>/dev/null
 	@$(CXX) $(CXXFLAGS) $(LUA_INC) $< -MM -MT $@ -MF [email protected] > /dev/null 2>&1
 	@touch $@
 
 %.clang-tidy: %.c
-	@$(CLANG_TIDY) --header-filter='$(CLANG_TIDY_HEADER_FILTER)' $< -- $(CFLAGS) 2>/dev/null
+	@$(CLANG_TIDY) --header-filter='$(CLANG_TIDY_HEADER_FILTER)' $(CLANG_TIDY_FLAGS) $< -- $(CFLAGS) 2>/dev/null
 	@$(CC) $(CFLAGS) $< -MM -MT $@ -MF [email protected] > /dev/null 2>&1
 	@touch $@