Merge pull request #5 from ucb-bar/build-system

ADD: improve build system
ucb-bar · Jul 12, 2024 · 847b836 · 847b836
2 parents 79993ac + e99c71d
commit 847b836
Show file tree

Hide file tree

Showing 27 changed files with 277 additions and 330 deletions.
diff --git a/.github/workflows/run-tests.yaml b/.github/workflows/run-tests.yaml
@@ -0,0 +1,34 @@
+name: Running C tests
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build-x86:
+    # Do not ignore bash profile files. From:
+    defaults:
+      run:
+        shell: bash -l {0}
+
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        submodules: recursive
+    - name: Clean previous builds
+      run: |
+        rm -rf ./build/
+    - name: Configure CMake
+      run: |
+        cmake . -S ./ -B ./build/ -D CMAKE_BUILD_TYPE=Debug
+    - name: Build
+      run: |
+        cmake --build ./build/ --target tests
+        ./build/tests/tests
+    - name: Run binary
+      run: |
+        ./build/tests/tests
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,28 +1,48 @@
+########################################################################################################################
+# file:  CMakeLists.txt
+#
+# usage: 
+#   Edit "VARIABLES"-section to suit project requirements.
+#   Build instructions:
+#     cmake . -D CMAKE_TOOLCHAIN_FILE=./riscv-gcc.cmake -S ./ -B ./build/ -G "Unix Makefiles" -D CMAKE_BUILD_TYPE=Debug -D RVV=ON
+#     cmake --build ./build/ --target all
+#     cmake --build ./build/ --target clean
+########################################################################################################################
+cmake_minimum_required(VERSION 3.10)
+
+project(nn LANGUAGES C)
 
 # Options
 option(BUILD_SHARED_LIBS    "Build using shared libraries"      OFF     )
 option(CMAKE_BUILD_TYPE     "Build type"                        Debug   )
 option(STATIC_LINKING       "Link statically"                   TRUE    )
 
+# architecture options
 option(X86                  "Build for x86"                     OFF     )
 option(RISCV                "Build for RISC-V"                  OFF     )
 
+# accelerator options
+option(AVX                  "Use AVX implementation" OFF)
+option(RVV                  "Use RISCV vector extension implementation" OFF)
 
-add_library(target-riscv INTERFACE)
-target_compile_features(target-riscv INTERFACE c_std_11)
-target_compile_definitions(target-riscv INTERFACE RISCV)
+
+add_compile_options(-O1 -Wall -Wextra)
 
 add_library(target-x86 INTERFACE)
 target_compile_features(target-x86 INTERFACE c_std_11)
 target_compile_definitions(target-x86 INTERFACE X86)
 
-target_link_options(target-x86 INTERFACE -static)
-target_link_options(target-riscv INTERFACE -static)
-
 target_compile_options(target-x86 INTERFACE -march=native)
+# target_compile_options(target-x86 INTERFACE -mavx512fp16)
+target_link_options(target-x86 INTERFACE -static)
 target_link_options(target-x86 INTERFACE -march=native)
+target_link_options(target-x86 INTERFACE -fno-common -fno-builtin-printf)
 
 
+add_library(target-riscv INTERFACE)
+target_compile_features(target-riscv INTERFACE c_std_11)
+target_compile_definitions(target-riscv INTERFACE RISCV)
+
 set(WRAP_SPECS_FILE     "htif_wrap.specs")
 set(SPECS_FILE          "htif_nano.specs")
 set(LIBGLOSS_DIR        "$ENV{RISCV}/riscv64-unknown-elf/lib/")
@@ -31,9 +51,22 @@ set(MARCH               "rv64gcv_zfh_zvfh")
 set(MABI                "lp64d")
 set(MCMODEL             "medany")
 
+if (NOT DEFINED LINKER_SCRIPT)
+  set(LINKER_SCRIPT     ${CMAKE_SOURCE_DIR}/toolchain/htif.ld)
+endif()
+
 target_compile_options(target-riscv INTERFACE -fno-common -fno-builtin-printf)
 target_compile_options(target-riscv INTERFACE -march=${MARCH} -mabi=${MABI} -mcmodel=${MCMODEL})
-target_compile_options(target-riscv INTERFACE -Wl,-Map=output.map -specs=${SPECS_FILE} -specs=${WRAP_SPECS_FILE} -T ${CMAKE_SOURCE_DIR}/htif.ld)
-target_link_options(target-x86 INTERFACE -fno-common -fno-builtin-printf)
+target_compile_options(target-riscv INTERFACE -Wl,-Map=output.map -specs=${SPECS_FILE} -specs=${WRAP_SPECS_FILE})
+target_compile_options(target-riscv INTERFACE -T ${LINKER_SCRIPT})
+
+target_link_options(target-riscv INTERFACE -static)
 target_link_options(target-riscv INTERFACE -march=${MARCH} -mabi=${MABI} -mcmodel=${MCMODEL})
-target_link_options(target-riscv INTERFACE -Wl,-Map=output.map -specs=${SPECS_FILE} -specs=${WRAP_SPECS_FILE} -T ${CMAKE_SOURCE_DIR}/htif.ld)
+target_link_options(target-riscv INTERFACE -Wl,-Map=output.map -specs=${SPECS_FILE} -specs=${WRAP_SPECS_FILE})
+target_link_options(target-riscv INTERFACE -T ${LINKER_SCRIPT})
+
+
+add_subdirectory(nn)
+add_subdirectory(tests)
+add_subdirectory(examples)
+
diff --git a/README.md b/README.md
@@ -10,29 +10,81 @@ Baremetal-NN is a tool for converting PyTorch models into raw C codes that can b
 
 ## Run Test
 
+### Building for x86
+
+first, we clean any previous builds
+
+```bash
+rm -rf ./build/
+```
+
+```bash
+cmake . -S ./ -B ./build/ -D CMAKE_BUILD_TYPE=Debug
+cmake --build ./build/ --target tests
+./build/tests/tests
+```
+
+### Building for RISC-V
+
+first, we clean any previous builds
+
+```bash
+rm -rf ./build/
+```
+
+```bash
+# make sure $RISCV is set
+cmake . -D CMAKE_TOOLCHAIN_FILE=./riscv-gcc.cmake -S ./ -B ./build/ -G "Unix Makefiles" -D CMAKE_BUILD_TYPE=Debug
+cmake --build ./build/ --target all
+spike ./build/tests/tests 
+```
+
+### Building for RISC-V with Vector Support
+
+first, we clean any previous builds
+
+```bash
+rm -rf ./build/
+```
+
 ```bash
-cd test/
-mkdir build/
-cd build/
-cmake .. -DRISCV=ON
+# make sure $RISCV is set
+cmake . -D CMAKE_TOOLCHAIN_FILE=./riscv-gcc.cmake -S ./ -B ./build/ -G "Unix Makefiles" -D CMAKE_BUILD_TYPE=Debug -D RVV=ON
+cmake --build ./build/ --target all
+spike --isa=rv64gcv_zicntr --varch=vlen:512,elen:32 ./build/tests/tests
 ```
 
-Running with RVV
+Running with FP16 support
 
 ```bash
-cmake .. -DRISCV=ON -DRVV=ON
-make
-spike --isa=rv64gcv_zicntr --varch=vlen:512,elen:32 ./example 
+spike --isa=rv64gcv_zicntr_zvfh --varch=vlen:512,elen:32 ./build/tests/tests
 ```
 
-Running with Gemmini
+### Building for RISC-V with Gemmini
+
+first, we clean any previous builds
+
+```bash
+rm -rf ./build/
+```
 
 ```bash
-cmake .. -DRISCV=ON -DGEMMINI=ON
-make
+cmake . -D CMAKE_TOOLCHAIN_FILE=./riscv-gcc.cmake -S ./ -B ./build/ -G "Unix Makefiles" -D CMAKE_BUILD_TYPE=Debug -D GEMMINI=ON
+cmake --build ./build/ --target all
 spike --extension=gemmini ./example
 ```
 
+### Cleaning build files
+
+```
+cmake --build ./build/ --target clean
+```
+
+### Cleaning CMake files
+
+```
+rm -rf ./build/
+```
 
 
 ## Convert the model

diff --git a/docs/Tensor-Creation.md b/docs/Tensor-Creation.md
@@ -0,0 +1,30 @@
+# Tensor Creation
+
+A set of factory functions are available for creating a tensor object. These factory functions configure the shape, data type, device and other properties of the new tensor, and optionally populate them according to specific algorithms.
+
+## Factory Functions
+
+A *factory function* is a function that produces a new tensor. There are many factory functions available, which differ in the way they initialize a new tensor before returning it. All factory functions adhere to the following general “schema”:
+
+```c
+Tensor *NN_<function-name>(<ndim>, <shape>, <datatype>, <tensor-options>)
+```
+
+### Available Factory Functions
+
+The following factory functions are available at the time of this writing:
+
+**tensor**: Returns a tensor with uninitialized values or preallocated buffer.
+
+**zeros**: Returns a tensor filled with all zeros.
+
+**ones**: Returns a tensor filled with all ones.
+
+**full**: Returns a tensor filled with a single value.
+
+**rand**: Returns a tensor filled with values drawn from a uniform distribution on [0, 1).
+
+**randint**: Returns a tensor with integers randomly drawn from an interval.
+
+**arange**: Returns a tensor with a sequence of integers.
+
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
@@ -0,0 +1,3 @@
+add_subdirectory(fast-depth)
+add_subdirectory(llama2)
+add_subdirectory(stereo-block-matching)
diff --git a/examples/fast-depth/CMakeLists.txt b/examples/fast-depth/CMakeLists.txt
@@ -2,44 +2,22 @@ cmake_minimum_required(VERSION 3.10)
 
 project(fast-depth LANGUAGES C)
 
-
 add_executable(fast-depth main.c)
-target_include_directories(fast-depth PUBLIC inc ../utility)
+
+target_include_directories(fast-depth PUBLIC ./)
+target_include_directories(fast-depth PUBLIC ../utility)
+
 
 target_compile_features(fast-depth INTERFACE c_std_11)
 
 if (X86)
-    message("fast-depth: building for x86")
-    target_link_libraries(fast-depth PUBLIC target-x86)
-
+  message(STATUS "fast-depth: Building for x86")
+  target_link_libraries(fast-depth PUBLIC target-x86)
 elseif (RISCV)
-    message("fast-depth: building for RISC-V")
-    # CMake toolchain definition for RISC-V GCC toolchain
-    set(CMAKE_SYSTEM_NAME "Generic" CACHE STRING "")
-    set(CMAKE_SYSTEM_PROCESSOR "riscv" CACHE STRING "")
-
-    set(TOOLCHAIN_PREFIX    "riscv64-unknown-elf-")
-
-    set(CMAKE_C_COMPILER    "${TOOLCHAIN_PREFIX}gcc")
-    set(CMAKE_ASM_COMPILER  "${TOOLCHAIN_PREFIX}gcc")
-    set(CMAKE_CXX_COMPILER  "${TOOLCHAIN_PREFIX}g++")
-    set(CMAKE_AR            "${TOOLCHAIN_PREFIX}ar")
-    set(CMAKE_LINKER        "{TOOLCHAIN_PREFIX}ld")
-    set(CMAKE_OBJCOPY       "${TOOLCHAIN_PREFIX}objcopy")
-    set(CMAKE_SIZE          "${TOOLCHAIN_PREFIX}size")
-    set(CMAKE_STRIP         "${TOOLCHAIN_PREFIX}ld")
-
-    target_link_libraries(fast-depth PUBLIC target-riscv)
+  message(STATUS "fast-depth: Building for RISC-V")
+  target_link_libraries(fast-depth PUBLIC target-riscv)
 endif ()
 
-add_compile_options(-O3 -Wall -Wextra)
+target_compile_options(fast-depth PRIVATE -O3 -Wall -Wextra)
 
-target_compile_options(fast-depth PRIVATE -u _printf_float)
-
-add_subdirectory(../../ ./build/)
-
-add_subdirectory(../../nn/ ./build/nn)
 target_link_libraries(fast-depth PUBLIC nn)
-
-target_link_libraries(fast-depth PUBLIC m)
-
diff --git a/examples/fast-depth/htif.ld b/examples/fast-depth/htif.ld
@@ -2,7 +2,7 @@ OUTPUT_ARCH ("riscv")
 ENTRY (_start)
 
 PROVIDE (__origin = 0x80000000);
-PROVIDE (__length = 16M);
+PROVIDE (__length = 128M);
 
 MEMORY
 {
@@ -15,7 +15,7 @@ SECTIONS
     . = __origin;
 
     /* Keep under a power of 2 to reserve space for TCB */
-    PROVIDE (__stack_size_min = 1024K);
+    PROVIDE (__stack_size_min = 2M);
 
     .text : {
         *(.text.init)
@@ -127,7 +127,7 @@ SECTIONS
     PROVIDE (_end = .);
 
     /* Reserve heap space */
-    PROVIDE(__heap_size = 128M);
+    PROVIDE(__heap_size = 4M);
     . += __heap_size;
     . = ALIGN (4K);
     PROVIDE (__heap_end = .);

diff --git a/examples/fast-depth/main.c b/examples/fast-depth/main.c
@@ -16,7 +16,7 @@
 #include "termimg.h"
 
 // load the weight data block from the model.bin file
-INCLUDE_FILE(".rodata", "../input.bin", model_input);
+INCLUDE_FILE(".rodata", "./input.bin", model_input);
 extern uint8_t model_input_data[];
 extern size_t model_input_start[];
 extern size_t model_input_end[];

diff --git a/examples/fast-depth/model.h b/examples/fast-depth/model.h
@@ -6,7 +6,7 @@
 
 
 // load the weight data block from the model.bin file
-INCLUDE_FILE(".rodata", "../model.bin", model_weight);
+INCLUDE_FILE(".rodata", "./model.bin", model_weight);
 extern uint8_t model_weight_data[];
 extern size_t model_weight_start[];
 extern size_t model_weight_end[];

diff --git a/examples/llama2/CMakeLists.txt b/examples/llama2/CMakeLists.txt
@@ -2,44 +2,21 @@ cmake_minimum_required(VERSION 3.10)
 
 project(llama2 LANGUAGES C)
 
-
 add_executable(llama2 main.c)
-target_include_directories(llama2 PUBLIC inc)
+
+target_include_directories(llama2 PUBLIC ./)
+
 
 target_compile_features(llama2 INTERFACE c_std_11)
 
 if (X86)
-    message("llama2: building for x86")
-    target_link_libraries(llama2 PUBLIC target-x86)
-
+  message(STATUS "llama2: Building for x86")
 elseif (RISCV)
-    message("llama2: building for RISC-V")
-    # CMake toolchain definition for RISC-V GCC toolchain
-    set(CMAKE_SYSTEM_NAME "Generic" CACHE STRING "")
-    set(CMAKE_SYSTEM_PROCESSOR "riscv" CACHE STRING "")
-
-    set(TOOLCHAIN_PREFIX    "riscv64-unknown-elf-")
-
-    set(CMAKE_C_COMPILER    "${TOOLCHAIN_PREFIX}gcc")
-    set(CMAKE_ASM_COMPILER  "${TOOLCHAIN_PREFIX}gcc")
-    set(CMAKE_CXX_COMPILER  "${TOOLCHAIN_PREFIX}g++")
-    set(CMAKE_AR            "${TOOLCHAIN_PREFIX}ar")
-    set(CMAKE_LINKER        "{TOOLCHAIN_PREFIX}ld")
-    set(CMAKE_OBJCOPY       "${TOOLCHAIN_PREFIX}objcopy")
-    set(CMAKE_SIZE          "${TOOLCHAIN_PREFIX}size")
-    set(CMAKE_STRIP         "${TOOLCHAIN_PREFIX}ld")
-
-    target_link_libraries(llama2 PUBLIC target-riscv)
+  message(STATUS "llama2: Building for RISC-V")
+  target_link_libraries(llama2 PUBLIC target-riscv)
 endif ()
 
-add_compile_options(-O3 -Wall -Wextra)
+target_compile_options(llama2 PRIVATE -O3 -Wall -Wextra)
 
-target_compile_options(llama2 PRIVATE -u _printf_float)
-
-add_subdirectory(../../ ./build/)
-
-add_subdirectory(../../nn/ ./build/nn)
 target_link_libraries(llama2 PUBLIC nn)
 
-target_link_libraries(llama2 PUBLIC m)
-