ggml-hexagon: release ggml-hexagon v0.98

Author: zhouwg

CMakeLists.txt

@@ -129,7 +129,7 @@ llama_option_depr(WARNING     LLAMA_RPC                 GGML_RPC)
 llama_option_depr(WARNING     LLAMA_SYCL                GGML_SYCL)
 llama_option_depr(WARNING     LLAMA_SYCL_F16            GGML_SYCL_F16)
 llama_option_depr(WARNING     LLAMA_CANN                GGML_CANN)
-llama_option_depr(WARNING     LLAMA_QNN                 GGML_QNN)
+llama_option_depr(WARNING     LLAMA_HEXAGON             GGML_HEXAGON)
 
 if (NOT MSVC)
     if (LLAMA_SANITIZE_THREAD)

ggml/CMakeLists.txt

@@ -204,7 +204,7 @@ option(GGML_OPENCL_EMBED_KERNELS            "ggml: embed kernels"
 option(GGML_OPENCL_USE_ADRENO_KERNELS       "ggml: use optimized kernels for Adreno"          ON)
 set   (GGML_OPENCL_TARGET_VERSION "300" CACHE STRING
                                             "gmml: OpenCL API version to target")
-option(GGML_QNN                             "ggml: use QNN"                                   OFF)
+option(GGML_HEXAGON                         "ggml: use HEXAGON"                               OFF)
 
 # toolchain for vulkan-shaders-gen
 set   (GGML_VULKAN_SHADERS_GEN_TOOLCHAIN "" CACHE FILEPATH "ggml: toolchain file for vulkan-shaders-gen")
@@ -270,7 +270,7 @@ set(GGML_PUBLIC_HEADERS
     include/ggml-rpc.h
     include/ggml-sycl.h
     include/ggml-vulkan.h
-    include/ggml-qnn.h
+    include/ggml-hexagon.h
     include/gguf.h)
 
 set_target_properties(ggml PROPERTIES PUBLIC_HEADER "${GGML_PUBLIC_HEADERS}")

ggml/include/ggml-qnn.h renamed to ggml/include/ggml-hexagon.h

@@ -28,25 +28,26 @@
 extern "C" {
 #endif
 
-#define GGML_QNN_MAX_DEVICES    3
-#define GGML_QNN_BACKEND_NAME   "hexagon"
-
-enum QNNBackend {
-    QNN_BACKEND_CPU,
-    QNN_BACKEND_GPU,
-    QNN_BACKEND_NPU,
-    QNN_BACKEND_GGML, //"fake" QNN backend for compare performance between QNN backend and cpu backend
+#define GGML_HEXAGON_MAX_DEVICES    3
+#define GGML_HEXAGON_BACKEND_NAME   "hexagon"
+
+enum HEXAGONBackend {
+    HEXAGON_BACKEND_QNNCPU  = 0,
+    HEXAGON_BACKEND_QNNGPU  = 1,
+    HEXAGON_BACKEND_QNNNPU  = 2,
+    HEXAGON_BACKEND_CDSP    = 2,
+    HEXAGON_BACKEND_GGML    = 3, //"fake" QNN backend for compare performance between HEXAGON backend and ggml backend
 };
 
-GGML_BACKEND_API ggml_backend_t ggml_backend_qnn_init(size_t dev_num, const char * qnn_lib_path);
+GGML_BACKEND_API ggml_backend_t ggml_backend_hexagon_init(size_t dev_num, const char * qnn_lib_path);
 
-GGML_BACKEND_API bool           ggml_backend_is_qnn(ggml_backend_t backend);
+GGML_BACKEND_API bool           ggml_backend_is_hexagon(ggml_backend_t backend);
 
-GGML_BACKEND_API int            ggml_backend_qnn_get_device_count(void);
+GGML_BACKEND_API int            ggml_backend_hexagon_get_device_count(void);
 
-GGML_BACKEND_API ggml_backend_reg_t ggml_backend_qnn_reg(void);
+GGML_BACKEND_API ggml_backend_reg_t ggml_backend_hexagon_reg(void);
 
-const char * ggml_backend_qnn_get_devname(size_t dev_num);
+const char * ggml_backend_hexagon_get_devname(size_t dev_num);
 
 #ifdef __cplusplus
 }

ggml/src/CMakeLists.txt

@@ -310,7 +310,7 @@ ggml_add_backend(RPC)
 ggml_add_backend(SYCL)
 ggml_add_backend(Vulkan)
 ggml_add_backend(OpenCL)
-ggml_add_backend(QNN)
+ggml_add_backend(HEXAGON)
 
 foreach (target ggml-base ggml)
     target_include_directories(${target} PUBLIC    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/../include> $<INSTALL_INTERFACE:include>)

ggml/src/ggml-backend-reg.cpp

@@ -65,8 +65,8 @@
 #include "ggml-kompute.h"
 #endif
 
-#ifdef GGML_USE_QNN
-#include "ggml-qnn.h"
+#ifdef GGML_USE_HEXAGON
+#include "ggml-hexagon.h"
 #endif
 
 // disable C++17 deprecation warning for std::codecvt_utf8
@@ -191,8 +191,8 @@ struct ggml_backend_registry {
 #ifdef GGML_USE_KOMPUTE
         register_backend(ggml_backend_kompute_reg());
 #endif
-#ifdef GGML_USE_QNN
-        register_backend(ggml_backend_qnn_reg());
+#ifdef GGML_USE_HEXAGON
+        register_backend(ggml_backend_hexagon_reg());
 #endif
 #ifdef GGML_USE_CPU
         register_backend(ggml_backend_cpu_reg());
@@ -584,7 +584,7 @@ void ggml_backend_load_all_from_path(const char * dir_path) {
     ggml_backend_load_best("vulkan", silent, dir_path);
     ggml_backend_load_best("opencl", silent, dir_path);
     ggml_backend_load_best("musa", silent, dir_path);
-    ggml_backend_load_best("qnn", silent, dir_path);
+    ggml_backend_load_best("hexagon", silent, dir_path);
     ggml_backend_load_best("cpu", silent, dir_path);
     // check the environment variable GGML_BACKEND_PATH to load an out-of-tree backend
     const char * backend_path = std::getenv("GGML_BACKEND_PATH");

ggml/src/ggml-qnn/CMakeLists.txt renamed to ggml/src/ggml-hexagon/CMakeLists.txt

@@ -1,4 +1,4 @@
-project(ggml-qnn)
+project(ggml-hexagon)
 message(STATUS "Using HEXAGON backend")
 message("CMAKE_SYSTEM_NAME : ${CMAKE_SYSTEM_NAME}")
 
@@ -37,8 +37,8 @@ if(CMAKE_SYSTEM_NAME STREQUAL "Android")
     include_directories(${HEXAGON_SDK_PATH}/ipc/fastrpc/rtld/ship/android_aarch64)
     include_directories(${HEXAGON_SDK_PATH}/libs/atomic/inc)
     include_directories(${HEXAGON_SDK_PATH}/libs/atomic/android_Debug_aarch64/ship)
-    include_directories(${CMAKE_SOURCE_DIR}/ggml/src/ggml-qnn/)
-    include_directories(${CMAKE_SOURCE_DIR}/ggml/src/ggml-qnn/kernels/)
+    include_directories(${CMAKE_SOURCE_DIR}/ggml/src/ggml-hexagon/)
+    include_directories(${CMAKE_SOURCE_DIR}/ggml/src/ggml-hexagon/kernels/)
 elseif(CMAKE_SYSTEM_NAME STREQUAL "Windows")
     set(QNN_DEFAULT_LIB_SEARCH_PATH "C:\\" CACHE STRING "customized library search path for QNN backend")
 else()
@@ -49,13 +49,13 @@ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DGGML_USE_QNN")
 set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -O3")
 
 file(GLOB QNN_SOURCES "${CMAKE_CURRENT_LIST_DIR}/*.cpp" "${CMAKE_CURRENT_LIST_DIR}/kernels/ggmlop_ap_skel.c")
-ggml_add_backend_library(ggml-qnn ${QNN_SOURCES})
+ggml_add_backend_library(ggml-hexagon ${QNN_SOURCES})
 
-target_include_directories(ggml-qnn PRIVATE ${QNN_SDK_PATH}/include/QNN ${HEXAGON_SDK_PATH} ${CMAKE_CURRENT_LIST_DIR})
-target_link_libraries(ggml-qnn PRIVATE ${QNN_LINK_LIBRARIES})
+target_include_directories(ggml-hexagon PRIVATE ${QNN_SDK_PATH}/include/QNN ${HEXAGON_SDK_PATH} ${CMAKE_CURRENT_LIST_DIR})
+target_link_libraries(ggml-hexagon PRIVATE ${QNN_LINK_LIBRARIES})
 
 string(REGEX REPLACE "/$" "" QNN_DEFAULT_LIB_SEARCH_PATH "${QNN_DEFAULT_LIB_SEARCH_PATH}")
-target_compile_definitions(ggml-qnn PRIVATE QNN_DEFAULT_LIB_SEARCH_PATH="${QNN_DEFAULT_LIB_SEARCH_PATH}/")
+target_compile_definitions(ggml-hexagon PRIVATE QNN_DEFAULT_LIB_SEARCH_PATH="${QNN_DEFAULT_LIB_SEARCH_PATH}/")
 
 function(ggml_hexagon_build_kernel KNAME)
     message(STATUS "ggml_hexagon: build kernel ${KNAME}")