Yellow paper configuration

.devcontainer/Dockerfile

@@ -0,0 +1,24 @@
+FROM nvidia/cuda:12.0.0-devel-ubuntu22.04
+
+# LABEL about the custom image
+LABEL maintainer="[email protected]"
+LABEL version="0.1"
+LABEL description="This is a custom Docker Image for CuEVM project"
+
+# Disable Prompt During Packages Installation
+ARG DEBIAN_FRONTEND=noninteractive
+# display
+ENV DISPLAY=host.docker.internal:0.0
+# timezone
+ENV TZ=Asia/Singapore
+# Update Ubuntu Software repository
+# necasry tools curl zip unzip git wget
+# gmp libgmp-dev
+# cjson libcjson1 libcjson-dev
+# clang
+# valgrind
+RUN apt-get update && apt-get upgrade -y && apt-get install -y locales && locale-gen "en_US.UTF-8" && dpkg-reconfigure locales && apt-get install -y curl zip unzip git wget libgmp-dev libcjson1 libcjson-dev libclang-dev valgrind clang-format
+# install rustup for REVMI
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs -o sh.rustup.rs && sh sh.rustup.rs -y && rm sh.rustup.rs
+# install tools for documentation
+RUN apt-get update && apt-get install -y doxygen sphinx cmake python3-pip && pip3 install breathe exhale sphinx_rtd_theme sphinx_book_theme

.devcontainer/devcontainer.json

@@ -0,0 +1,24 @@
+{
+	"name": "QLE dev container",
+	"build": { "dockerfile": "Dockerfile" },
+	"runArgs": [
+		"--rm", "--gpus=all"
+	],
+	//"remoteEnv": {
+	//	"ENV_VAR": "ENV_VAL"
+	//},
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"GitHub.vscode-pull-request-github",
+				"GitHub.copilot",
+				"ms-vscode.makefile-tools",
+				"NVIDIA.nsight-vscode-edition",
+				"ms-vscode.cpptools-extension-pack",
+				"ccimage.jsonviewer",
+				"xaver.clang-format"
+			]
+		}
+	}//,
+	//"postStartCommand": ""
+}

.github/workflows/docs.yml

@@ -0,0 +1,77 @@
+name: Docs
+
+on:
+  #push:
+  #  branches-ignore:
+  #    - '**'  
+  push:
+    branches: [ yellow_paper ]
+  pull_request:
+    branches: [ master ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    container:
+      image: nvidia/cuda:12.0.0-devel-ubuntu22.04
+      credentials:
+        username: ${{ secrets.DOCKER_USER }}
+        password: ${{ secrets.DOCKER_TOKEN }}
+    env:
+      DEBIAN_FRONTEND: "noninteractive"
+      TZ: "Asia/Singapore"
+
+    steps:
+    - name: Checkout
+      uses: actions/[email protected]
+    - name: Apt Requirements
+      run: DEBIAN_FRONTEND=noninteractive apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y doxygen sphinx cmake python3-pip libgmp-dev libcjson1 libcjson-dev git
+    - name: Pip3 Requirements
+      run: pip3 install -r docs/requirements.txt
+    - name: Configure CMake
+      run: cmake -S . -B build -G "Unix Makefiles" -DWITH_DOCS=ON
+    - name: Build docs
+      run:  cmake --build build --target docs
+    - name: Upload page artficat
+      uses: actions/upload-artifact@v4
+      with:
+        name: cuevm-docs-artifact
+        path: build/docs/docs/sphinx/
+
+  deploy:
+    runs-on: ubuntu-22.04
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+    - name: Download artficat
+      uses: actions/download-artifact@v4
+      with:
+        name: cuevm-docs-artifact
+    - name: Setup Pages
+      uses: actions/configure-pages@v4
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        # Upload entire repository
+        path: '.'
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

.gitignore

@@ -4,5 +4,17 @@
 *.ptx
 *.cubin
 *.fatbin
+
+# binaries
+/out
+/input
+/output
+
+
+build/
+_build/
+_static/
+_templates/
+docs/api/
 *.o
 cuEVM

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "CGBN"]
+	path = CGBN
+	url = https://github.com/NVlabs/CGBN.git
+[submodule "REVMI"]
+	path = REVMI
+	url = https://github.com/cassc/evm_interpreter.git

.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "CUDA C++: Launch",
+            "type": "cuda-gdb",
+            "request": "launch",
+            "program": "${workspaceFolder}/out/interpreter",
+            "args": "--input ${workspaceFolder}/input/evm_test.json --output ${workspaceFolder}/output/evm_test.json",
+        },
+        {
+            "name": "CUDA C++: Attach",
+            "type": "cuda-gdb",
+            "request": "attach"
+        }
+    ]
+}

.vscode/settings.json

@@ -2,6 +2,26 @@
     "files.associations": {
         "*.ejs": "html",
         "iostream": "cpp",
-        "string_view": "cpp"
+        "string_view": "cpp",
+        "random": "cpp",
+        "chrono": "cpp",
+        "algorithm": "cpp",
+        "*.tcc": "cpp",
+        "string": "cpp",
+        "functional": "cpp",
+        "ratio": "cpp",
+        "system_error": "cpp",
+        "array": "cpp",
+        "tuple": "cpp",
+        "type_traits": "cpp",
+        "utility": "cpp",
+        "limits": "cpp",
+        "initializer_list": "cpp",
+        "memory": "cpp",
+        "stdlib.h": "c",
+        "typeinfo": "cpp",
+        "cstdint": "cpp",
+        "vector": "cpp",
+        "atomic": "cpp"
     }
 }

CMakeLists.txt

@@ -0,0 +1,19 @@
+cmake_minimum_required(VERSION 3.18 FATAL_ERROR)
+option(WITH_COMPILE "Doing the nvcc compilation" OFF)
+option(WITH_DOCS "Geenrating the documentation for the code" OFF)
+
+project(cuevm
+        VERSION 0.1.0
+        DESCRIPTION "A CUDA EVM implementation"
+        LANGUAGES CUDA CXX)
+
+set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
+
+include_directories("${PROJECT_SOURCE_DIR}/CGBN/include")
+
+if(WITH_DOCS)
+        add_subdirectory("${PROJECT_SOURCE_DIR}/docs")
+endif()
+if(WITH_COMPILE)
+        add_subdirectory("${PROJECT_SOURCE_DIR}/src")
+endif()

Makefile

@@ -1,17 +1,39 @@
-# Object files
-objects = cuevm.o cuevm_test.o stack.o uint256.o
-
 # Compiler
 NVCC = nvcc
+NVCC_FLAGS = -I./CGBN/include -lstdc++ -lm -lgmp -lcjson -rdc=true --std c++20 -lcudadevrt -lineinfo
+GCC = gcc
+GCC_FLAGS = -lm -lgmp -lcjson
+GPP = g++
+GPP_FLAGS = -I./CGBN/include -lm -lgmp -lcjson 
+OUT_DIRECTORY = ./out
+
+
+test_gmp: src/test/test_gmp.c
+	$(GCC) -o $(OUT_DIRECTORY)/test_gmp src/test/test_gmp.c $(GCC_FLAGS) 
+
+test_cjson: src/test/test_cjson.c
+	$(GCC) -o $(OUT_DIRECTORY)/test_cjson src/test/test_cjson.c $(GCC_FLAGS) 
+
+test_cjson_evm: src/test/test_cjson_evm.c
+	$(GCC) -o $(OUT_DIRECTORY)/test_cjson_evm src/test/test_cjson_evm.c $(GCC_FLAGS)
+
+test_cgbn: src/test/test_cgbn.cu
+	$(NVCC) $(NVCC_FLAGS) -o $(OUT_DIRECTORY)/test_cgbn src/test/test_cgbn.cu
+
+interpreter: src/interpreter.cu
+	$(NVCC) -D TRACER $(NVCC_FLAGS) -o $(OUT_DIRECTORY)/$@ $<
+
+debug_interpreter: src/interpreter.cu
+	$(NVCC) -D TRACER $(NVCC_FLAGS) -g -G -o $(OUT_DIRECTORY)/$@ $<
 
-# Compiler Flags
-NVCC_FLAGS = -I./include -lstdc++ -dc
+cpu_interpreter: src/interpreter.cu
+	$(NVCC) -D TRACER -D ONLY_CPU -D GAS $(NVCC_FLAGS) -g -G -o $(OUT_DIRECTORY)/$@ $<
 
-all: $(objects)
-	$(NVCC) $(objects) -o cuEVM
+cpu_debug_interpreter: src/interpreter.cu
+	$(NVCC) -D TRACER -D COMPLEX_TRACER -D ONLY_CPU -D GAS $(NVCC_FLAGS) -g -G -o $(OUT_DIRECTORY)/$@ $<
 
-%.o: src/%.cu
-	$(NVCC) $(NVCC_FLAGS) $< -o $@
+% :: src/test/%.cu
+	$(NVCC) $(NVCC_FLAGS) -g -G -o $(OUT_DIRECTORY)/$@ $<
 
 clean:
-	rm -f *.o cuEVM
+	rm -f $(OUT_DIRECTORY)/*

README.md

@@ -8,13 +8,18 @@ Cuda implementation of EVM bytecode executor
 - A C++ compiler compatible with the CUDA Toolkit
 
 ## Compile
-* `make`
-Or with custom nvcc path
-* `make NVCC=/usr/local/cuda-10.0/bin/nvcc`
+* `make interpreter`
+Or for running with cpu
+* `make cpu_interpreter`
 
 ## Usage
 
-* `./cuEVM --bytecode [hex string of byte code] --input [hex string of input]`
+* `clear && compute-sanitizer --tool memcheck --leak-check=full ./out/interpreter --input [inpot_json_file] --output [output_json_file]`
+* `clear && valgrind --leak-check=full --show-leak-kinds=all ./out/*`
+Or for running with cpu
+* `./out/cpu_interpreter --input [inpot_json_file] --output [output_json_file]`
+Easy test:
+* `./out/cpu_interpreter --input ./input/evm_arith.json --output ./output/evm_test.json`
 
 Sample testing bytecode :
 
@@ -75,3 +80,7 @@ TODO: change options, configs, and how we use the tool in the future.
 
 ## Code structure
 TODO
+
+## Documentation
+TODO
+docygen+sphinx+breathe+exhale

cmake/FindGMP.cmake

@@ -0,0 +1,24 @@
+set(GMP_PREFIX "" CACHE PATH "path ")
+
+
+find_path(GMP_INCLUDE_DIR gmp.h gmpxx.h 
+    PATHS ${GMP_PREFIX}/include /usr/include /usr/local/include )
+
+find_library(GMP_LIBRARY NAMES gmp libgmp 
+    PATHS ${GMP_PREFIX}/lib /usr/lib /usr/local/lib)
+
+
+if(GMP_INCLUDE_DIR AND GMP_LIBRARY)
+    get_filename_component(GMP_LIBRARY_DIR ${GMP_LIBRARY} PATH)
+    set(GMP_FOUND TRUE)
+endif()
+
+if(GMP_FOUND)
+   if(NOT GMP_FIND_QUIETLY)
+      MESSAGE(STATUS "Found GMP: ${GMP_LIBRARY}")
+   endif()
+elseif(GMP_FOUND)
+   if(GMP_FIND_REQUIRED)
+      message(FATAL_ERROR "Could not find GMP")
+   endif()
+endif()

cmake/FindSphinx.cmake

@@ -0,0 +1,11 @@
+#Look for an executable called sphinx-build
+find_program(SPHINX_EXECUTABLE
+             NAMES sphinx-build
+             DOC "Path to sphinx-build executable")
+
+include(FindPackageHandleStandardArgs)
+
+#Handle standard arguments to find_package like REQUIRED and QUIET
+find_package_handle_standard_args(Sphinx
+                                  "Failed to find sphinx-build executable"
+                                  SPHINX_EXECUTABLE)