refactor: remove nntc ppl so

- if cross_toolchians not exist, download it
- if ppl so not exist, compile it

Change-Id: I50e233ba2c7fbfd22331cfb470e62883446e7042

Author: HarmonyHu

.gitignore

@@ -25,6 +25,7 @@ tpulang_test_*/
 bmodel_fbs.py
 .ipynb_checkpoints/
 cross_toolchains/
+third_party/nntoolchain/ppl/
 dist/
 !/python/tools/soc_infer/debugger/bmodel_fbs.py
 

README.md

@@ -83,17 +83,18 @@ Create and enter the container:
 docker run --privileged --name tpu-mlir -v $PWD:/workspace -it sophgo/tpuc_dev:latest
 ```
 
-### 2a. Install the prebuilt wheel (recommended)
+### 2a. Install the prebuilt wheel
 
 > Requires Python ≥ 3.10 on Ubuntu 22.04 (already satisfied inside the Docker image).
 
 ```shell
 pip install tpu_mlir
 ```
 
-### 2b. Build from source
+### 2b. Build from source (recommended)
 
 ```shell
+# git clone with --depth 1
 cd /workspace/tpu-mlir
 pip install -r requirements.txt
 source ./envsetup.sh

README_cn.md

@@ -83,17 +83,18 @@ docker load -i tpuc_dev_v3.4.tar.gz
 docker run --privileged --name tpu-mlir -v $PWD:/workspace -it sophgo/tpuc_dev:latest
 ```
 
-### 2a. 安装预编译 wheel（推荐）
+### 2a. 安装预编译 wheel
 
 > 要求 Python ≥ 3.10，Ubuntu 22.04（推荐直接使用上述 Docker 镜像）。
 
 ```shell
 pip install tpu_mlir
 ```
 
-### 2b. 从源码编译
+### 2b. 从源码编译 （推荐）
 
 ```shell
+# git clone with --depth 1
 cd /workspace/tpu-mlir
 pip install -r requirements.txt
 source ./envsetup.sh

build.sh

@@ -28,11 +28,13 @@ BUILD_TYPE=""
 CXX_FLAGS="-O2"
 USE_CUDA="OFF"
 ENABLE_COVERAGE_FLAG="OFF"
+PPL_BUILD_TYPE="RELEASE"
 
 if [ -n "$1" ]; then
     if [ "$1" = "DEBUG" ]; then
         BUILD_TYPE="Debug"
         CXX_FLAGS="-ggdb"
+        PPL_BUILD_TYPE="DEBUG"
     elif [ "$1" != "RELEASE" ]; then
         echo "Invalid build mode: $1"
         usage
@@ -58,7 +60,6 @@ if [ "${ENABLE_COVERAGE}" = "True" ]; then
 fi
 
 # prepare install/build dir
-rm -rf "${INSTALL_PATH}"
 cmake -G Ninja \
   -B "${BUILD_PATH}" \
   -DCMAKE_C_COMPILER=clang \
@@ -77,9 +78,8 @@ cmake --build "$BUILD_PATH" --target install -j${cpu_num}
 
 cmake --build "$BUILD_PATH" --target passes_json_files builder_python install_passes_files
 
-# build ppl code
-# bash lib/PplBackend/build.sh DEBUG
-bash lib/PplBackend/build.sh
+# build ppl code (after main install so INSTALL_PATH/lib/ is ready)
+bash lib/PplBackend/build.sh ${PPL_BUILD_TYPE}
 
 # Clean up some files for release build
 if [ "$1" != "DEBUG" ]; then

lib/PplBackend/download_toolchain.sh download_toolchains.shlib/PplBackend/download_toolchain.sh renamed to download_toolchains.sh

@@ -40,36 +40,12 @@ function download_loong() {
   download_toolchain $tool_name $tool_addr $tool_file
 }
 
-CROSS_TOOLCHAINS=${1:-$PROJECT_ROOT/../bm_prebuilt_toolchains}
-loongarch_host_toolchain=${2}
-
-CURRENT_DIR=$(cd $(dirname "${BASH_SOURCE[0]}") && pwd)
-
-if [ -z "$CROSS_TOOLCHAINS" ]; then
-  export CROSS_TOOLCHAINS=$CROSS_TOOLCHAINS
-fi
-echo "export CROSS_TOOLCHAINS=$CROSS_TOOLCHAINS"
+CROSS_TOOLCHAINS=${1:-$PROJECT_ROOT/cross_toolchains}
 
 mkdir -p $CROSS_TOOLCHAINS
-pushd $CROSS_TOOLCHAINS >>/dev/null
-
-if [ x${CHIP} == "xbm1688" ]; then
-  download_riscv_xuantie900
-  if [ x${DEV_MODE} == "xsoc" ]; then
-    download_gcc_arm
-  fi
-elif [ x${CHIP} == "xbm1684x" ]; then
-  if [ "x${loongarch_host_toolchain}" == "xloongarch64" ]; then
-    download_loong
-  else
-    download_gcc_arm
-  fi
-  if [ x${DEV_MODE} == "xsoc" ]; then
-    download_gcc_linaro
-  fi
-elif [ x${CHIP} == "xbm1690" ]; then
-    download_riscv_xuantie900
-else
-  return 1
-fi
-popd >>/dev/null
+pushd $CROSS_TOOLCHAINS
+download_loong
+download_gcc_arm
+download_gcc_linaro
+download_riscv_xuantie900
+popd

envsetup.sh

@@ -32,7 +32,7 @@ export PATH=$PROJECT_ROOT/third_party/customlayer/python:$PATH
 export PATH=$PROJECT_ROOT/python/tools/train/test:$PATH
 
 # ppl compiler path
-export PPL_PROJECT_ROOT=$INSTALL_PATH/ppl
+export PPL_PROJECT_ROOT=$PROJECT_ROOT/third_party/ppl
 export PPL_BUILD_PATH=$PPL_PROJECT_ROOT/build
 export PPL_INSTALL_PATH=$PPL_PROJECT_ROOT/install
 export PPL_RUNTIME_PATH=$PPL_PROJECT_ROOT/deps
@@ -91,8 +91,17 @@ function use_chip_cmodel() {
 }
 
 # only used to build libatomic_exec_aarch64.so for soc_infer
-export CROSS_TOOLCHAINS=$PROJECT_ROOT/../bm_prebuilt_toolchains
+# fallback to local cross_toolchains if bm_prebuilt_toolchains is not available
+if [ -d "$PROJECT_ROOT/../bm_prebuilt_toolchains" ]; then
+  export CROSS_TOOLCHAINS=$PROJECT_ROOT/../bm_prebuilt_toolchains
+elif [ -d "$PROJECT_ROOT/cross_toolchains" ]; then
+  export CROSS_TOOLCHAINS=$PROJECT_ROOT/cross_toolchains
+else
+  export CROSS_TOOLCHAINS=$PROJECT_ROOT/cross_toolchains
+  $PROJECT_ROOT/download_toolchains.sh $CROSS_TOOLCHAINS
+fi
 export LIBSOPHON_ROOT=$PROJECT_ROOT/../libsophon
+
 function rebuild_atomic_exec_alone() {
     export ATOMIC_EXEC_ALONE=1
     if [ -z "$USE_CROSS_TOOLCHAINS" ]; then

lib/PplBackend/.md5

@@ -1,6 +1,5 @@
-__BUILD_MODE__ RELEASE
-CMakeLists.txt 514d48f2ba804cde1313adda0a7ccfe9
-Dynkernel.cmake c873cf00c2a1603bff54415dbf294dbb
+CMakeLists.txt c2a811021063e1a2a85c965127e56535
+Dynkernel.cmake e06b63a6111d1848334e3f63dc95e33e
 include/helper.h cad814a6c86baa99b65e622ffbe306b8
 include/local_base.h 61192f8ca0ab0f5bd7f71d69e481dd15
 include/ppl_dyn_fw.h 2924e996c92f4bb25ca3b016d9c2697a

lib/PplBackend/CMakeLists.txt

@@ -11,7 +11,6 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wl,--no-undefined")
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wl,--no-undefined")
-set(NNTOOLCHAIN_DIRECTORY $ENV{PROJECT_ROOT}/third_party/nntoolchain)
 
 if(NOT DEFINED ENV{PPL_PROJECT_ROOT})
   message(FATAL_ERROR "Please set environ PPL_PROJECT_ROOT to ppl release path")
@@ -35,6 +34,7 @@ set(HOST_TOP ${PPL_TOP}/deps/common/host)
 
 include_directories(${KERNEL_TOP})
 include_directories(${HOST_TOP}/include)
+include_directories($ENV{PROJECT_ROOT}/include)
 include_directories($ENV{TPUC_ROOT}/include)
 include_directories(include)
 include_directories(${CMAKE_CURRENT_SOURCE_DIR}/${BUILD_DIR}/include)
@@ -49,9 +49,6 @@ if(BUILD_STATIC)
   add_library(ppl_host SHARED ${TILING_SRC} ${PL_SRC} ${ADDITIONAL_SRC})
 
   install(TARGETS ppl_host DESTINATION lib)
-  if(NOT DEBUG)
-    install(FILES  $<TARGET_FILE:ppl_host> DESTINATION ${NNTOOLCHAIN_DIRECTORY}/ppl)
-  endif()
 else()
   if(DEFINED DEV_MODE)
     message(NOTICE "DEV_MODE: ${DEV_MODE}")
@@ -70,8 +67,5 @@ else()
     set(ADDITIONAL_SRC ${HOST_TOP}/src/host_utils.cpp)
     add_library(${DYN_HOST_NAME} SHARED ${TILING_SRC} ${PL_SRC} ${ADDITIONAL_SRC})
     install(TARGETS ${DYN_HOST_NAME} DESTINATION lib)
-    if(NOT DEBUG)
-      install(FILES  $<TARGET_FILE:${DYN_HOST_NAME}> DESTINATION ${NNTOOLCHAIN_DIRECTORY}/ppl)
-    endif()
   endif()
 endif()

lib/PplBackend/Dynkernel.cmake

@@ -33,17 +33,7 @@ else()  # soc pcie
   set(NAME_SUFFIX _${CHIP})
   # try download cross toolchain
   if(NOT DEFINED ENV{CROSS_TOOLCHAINS})
-      message("CROSS_TOOLCHAINS was not defined, try source download_toolchain.sh")
-      execute_process(
-          COMMAND bash -c "CHIP=${CHIP} DEV_MODE=${DEV_MODE} source  ${CMAKE_CURRENT_LIST_DIR}/download_toolchain.sh && env"
-          RESULT_VARIABLE result
-          OUTPUT_VARIABLE output
-      )
-      if(NOT result EQUAL "0")
-          message(FATAL_ERROR "Not able to source download_toolchain.sh: ${output}")
-      endif()
-      string(REGEX MATCH "CROSS_TOOLCHAINS=([^\n]*)" _ ${output})
-      set(ENV{CROSS_TOOLCHAINS} "${CMAKE_MATCH_1}")
+      message(FATAL_ERROR "CROSS_TOOLCHAINS is not set. Source envsetup.sh first, or set the env var manually.")
   endif()
   set(RISCV_FAMLIY bm1688 bm1690 bm1690e sg2260e sg2260erv bm1684x2)
   if(${CHIP} IN_LIST RISCV_FAMLIY)
@@ -54,17 +44,7 @@ else()  # soc pcie
     set(CMAKE_STRIP $ENV{CROSS_TOOLCHAINS}/gcc-arm-10.3-2021.07-x86_64-aarch64-none-linux-gnu/bin/aarch64-none-linux-gnu-strip)
   endif()
   if(NOT EXISTS ${CMAKE_C_COMPILER})
-    message("CROSS_TOOLCHAINS was not defined, try source download_toolchain.sh")
-    execute_process(
-        COMMAND bash -c "CHIP=${CHIP} DEV_MODE=${DEV_MODE} source  ${CMAKE_CURRENT_LIST_DIR}/download_toolchain.sh && env"
-        RESULT_VARIABLE result
-        OUTPUT_VARIABLE output
-    )
-    if(NOT result EQUAL "0")
-        message(FATAL_ERROR "Not able to source download_toolchain.sh: ${output}")
-    endif()
-    string(REGEX MATCH "CROSS_TOOLCHAINS=([^\n]*)" _ ${output})
-    set(ENV{CROSS_TOOLCHAINS} "${CMAKE_MATCH_1}")
+    message(FATAL_ERROR "Cross compiler not found at ${CMAKE_C_COMPILER}. Source envsetup.sh to download toolchains, or set CROSS_TOOLCHAINS manually.")
   endif()
 endif()
 
@@ -183,4 +163,3 @@ if(NOT DEBUG)
     COMMENT "Stripping symbols from $<TARGET_FILE:${SHARED_LIBRARY_OUTPUT_FILE}>"
   )
 endif()
-install(FILES  $<TARGET_FILE:${SHARED_LIBRARY_OUTPUT_FILE}> DESTINATION ${NNTOOLCHAIN_DIRECTORY}/ppl)

lib/PplBackend/build.sh

@@ -37,6 +37,9 @@ clean_up() {
   mkdir -p "$build_dir"
 }
 
+# Ensure the target lib directory exists
+mkdir -p "${INSTALL_PATH}/lib"
+
 # Parallel ppl-compile over all *.pl files in ../src
 # Args: chip [extra ppl-compile flags...]
 ppl_compile_all() {
@@ -76,17 +79,13 @@ file_changed=false
 # headers, the CMake build description, and the build script itself.
 mapfile -t md5_list < <(generate_md5_list \
   src src_dyn include CMakeLists.txt Dynkernel.cmake)
-# RELEASE vs DEBUG produces different artifacts, so treat the build mode as
-# an input by embedding it as a sentinel line in the md5 list.
-md5_list=("__BUILD_MODE__ $BUILD_MODE" "${md5_list[@]}")
 if [ ! -f "$MD5FILE" ] || has_md5_changes "$MD5FILE" "${md5_list[@]}"; then
   file_changed=true
 fi
 # get latest nntoolchain version
 lib_changed=false
 NNTC_LIB_PATH=${PROJECT_ROOT}/third_party/nntoolchain/lib
 PPL_VER_PATH=${PROJECT_ROOT}/third_party/ppl/version
-VER_FILE=${PROJECT_ROOT}/third_party/nntoolchain/ppl/version
 LIBS=("libcmodel_bm1684x.a"  "libbm1684x_kernel_module.a"
       "libcmodel_bm1688.a"   "libbmtpulv60_kernel_module.a"
       "libcmodel_bm1690.a"   "libbm1690_kernel_module.a"
@@ -101,13 +100,17 @@ mapfile -t libs_md5_list < <(
   done
 )
 # check whether the third_party/nntoolchain/lib or ppl is updated
-if [ ! -f "$VER_FILE" ] || has_md5_changes "$VER_FILE" "${libs_md5_list[@]}" || ! grep -Fxq -f "$PPL_VER_PATH" "$VER_FILE"; then
+# use a version file under the install path for cache tracking
+VER_DIR="${INSTALL_PATH}/share/ppl"
+mkdir -p "$VER_DIR"
+VER_FILE="${VER_DIR}/.version"
+if [ ! -f "$VER_FILE" ] || [ "$(head -n1 "$VER_FILE")" != "$BUILD_MODE" ] || has_md5_changes "$VER_FILE" "${libs_md5_list[@]}" || ! grep -Fxq -f "$PPL_VER_PATH" "$VER_FILE"; then
   lib_changed=true
 fi
 if [ "$lib_changed" = false ] && [ "$file_changed" = false ]; then
   exit 0
 fi
-# build third_party/nntoolchain/ppl lib
+# build ppl libs and install directly to INSTALL_PATH
 echo "rebuilding ppl..."
 pushd "$DIR"
 # wipe ppl compile cache ONCE for the whole rebuild (not per-chip)
@@ -176,8 +179,8 @@ fi
 if [ "$file_changed" = true ]; then
   printf '%s\n' "${md5_list[@]}" > "$MD5FILE"
 fi
-# VER_FILE records the nntoolchain/ppl versions that the installed RELEASE
-# artifacts were built against, so only update it on RELEASE builds.
+# VER_FILE records the nntoolchain lib versions that the installed artifacts
+# were built against, so only update it on RELEASE builds.
 if [ "$lib_changed" = true ]; then
   printf '%s\n' "$BUILD_MODE" > "$VER_FILE"
   cat "$PPL_VER_PATH" >> "$VER_FILE"