CMakeLists.txt 49 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279
  1. cmake_minimum_required(VERSION 3.14) # for add_link_options and implicit target directories.
  2. project("llama.cpp" C CXX)
  3. include(CheckIncludeFileCXX)
  4. set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
  5. if (NOT XCODE AND NOT MSVC AND NOT CMAKE_BUILD_TYPE)
  6. set(CMAKE_BUILD_TYPE Release CACHE STRING "Build type" FORCE)
  7. set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
  8. endif()
  9. set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
  10. if (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
  11. set(LLAMA_STANDALONE ON)
  12. # configure project version
  13. # TODO
  14. else()
  15. set(LLAMA_STANDALONE OFF)
  16. endif()
  17. if (EMSCRIPTEN)
  18. set(BUILD_SHARED_LIBS_DEFAULT OFF)
  19. option(LLAMA_WASM_SINGLE_FILE "llama: embed WASM inside the generated llama.js" ON)
  20. else()
  21. if (MINGW)
  22. set(BUILD_SHARED_LIBS_DEFAULT OFF)
  23. else()
  24. set(BUILD_SHARED_LIBS_DEFAULT ON)
  25. endif()
  26. endif()
  27. #
  28. # Option list
  29. #
  30. if (APPLE)
  31. set(LLAMA_METAL_DEFAULT ON)
  32. else()
  33. set(LLAMA_METAL_DEFAULT OFF)
  34. endif()
  35. # general
  36. option(BUILD_SHARED_LIBS "build shared libraries" OFF)
  37. option(LLAMA_STATIC "llama: static link libraries" OFF)
  38. option(LLAMA_NATIVE "llama: enable -march=native flag" ON)
  39. option(LLAMA_LTO "llama: enable link time optimization" OFF)
  40. option(LLAMA_CCACHE "llama: use ccache if available" ON)
  41. # debug
  42. option(LLAMA_ALL_WARNINGS "llama: enable all compiler warnings" ON)
  43. option(LLAMA_ALL_WARNINGS_3RD_PARTY "llama: enable all compiler warnings in 3rd party libs" OFF)
  44. option(LLAMA_GPROF "llama: enable gprof" OFF)
  45. # build
  46. option(LLAMA_FATAL_WARNINGS "llama: enable -Werror flag" OFF)
  47. # sanitizers
  48. option(LLAMA_SANITIZE_THREAD "llama: enable thread sanitizer" OFF)
  49. option(LLAMA_SANITIZE_ADDRESS "llama: enable address sanitizer" OFF)
  50. option(LLAMA_SANITIZE_UNDEFINED "llama: enable undefined sanitizer" OFF)
  51. # instruction set specific
  52. if (LLAMA_NATIVE)
  53. set(INS_ENB OFF)
  54. else()
  55. set(INS_ENB ON)
  56. endif()
  57. option(LLAMA_AVX "llama: enable AVX" ${INS_ENB})
  58. option(LLAMA_AVX2 "llama: enable AVX2" ${INS_ENB})
  59. option(LLAMA_AVX512 "llama: enable AVX512" OFF)
  60. option(LLAMA_AVX512_VBMI "llama: enable AVX512-VBMI" OFF)
  61. option(LLAMA_AVX512_VNNI "llama: enable AVX512-VNNI" OFF)
  62. option(LLAMA_FMA "llama: enable FMA" ${INS_ENB})
  63. # in MSVC F16C is implied with AVX2/AVX512
  64. if (NOT MSVC)
  65. option(LLAMA_F16C "llama: enable F16C" ${INS_ENB})
  66. endif()
  67. if (WIN32)
  68. set(LLAMA_WIN_VER "0x602" CACHE STRING "llama: Windows Version")
  69. endif()
  70. # 3rd party libs
  71. option(LLAMA_ACCELERATE "llama: enable Accelerate framework" ON)
  72. option(LLAMA_BLAS "llama: use BLAS" OFF)
  73. set(LLAMA_BLAS_VENDOR "Generic" CACHE STRING "llama: BLAS library vendor")
  74. option(LLAMA_CUBLAS "llama: use CUDA" OFF)
  75. #option(LLAMA_CUDA_CUBLAS "llama: use cuBLAS for prompt processing" OFF)
  76. option(LLAMA_CUDA_FORCE_DMMV "llama: use dmmv instead of mmvq CUDA kernels" OFF)
  77. option(LLAMA_CUDA_FORCE_MMQ "llama: use mmq kernels instead of cuBLAS" OFF)
  78. set(LLAMA_CUDA_DMMV_X "32" CACHE STRING "llama: x stride for dmmv CUDA kernels")
  79. set(LLAMA_CUDA_MMV_Y "1" CACHE STRING "llama: y block size for mmv CUDA kernels")
  80. option(LLAMA_CUDA_F16 "llama: use 16 bit floats for some calculations" OFF)
  81. set(LLAMA_CUDA_KQUANTS_ITER "2" CACHE STRING "llama: iters./thread per block for Q2_K/Q6_K")
  82. set(LLAMA_CUDA_PEER_MAX_BATCH_SIZE "128" CACHE STRING
  83. "llama: max. batch size for using peer access")
  84. option(LLAMA_CUDA_NO_PEER_COPY "llama: do not use peer to peer copies" OFF)
  85. option(LLAMA_CURL "llama: use libcurl to download model from an URL" OFF)
  86. option(LLAMA_HIPBLAS "llama: use hipBLAS" OFF)
  87. option(LLAMA_HIP_UMA "llama: use HIP unified memory architecture" OFF)
  88. option(LLAMA_CLBLAST "llama: use CLBlast" OFF)
  89. option(LLAMA_VULKAN "llama: use Vulkan" OFF)
  90. option(LLAMA_VULKAN_CHECK_RESULTS "llama: run Vulkan op checks" OFF)
  91. option(LLAMA_VULKAN_DEBUG "llama: enable Vulkan debug output" OFF)
  92. option(LLAMA_VULKAN_VALIDATE "llama: enable Vulkan validation" OFF)
  93. option(LLAMA_VULKAN_RUN_TESTS "llama: run Vulkan tests" OFF)
  94. option(LLAMA_METAL "llama: use Metal" ${LLAMA_METAL_DEFAULT})
  95. option(LLAMA_METAL_NDEBUG "llama: disable Metal debugging" OFF)
  96. option(LLAMA_METAL_SHADER_DEBUG "llama: compile Metal with -fno-fast-math" OFF)
  97. option(LLAMA_METAL_EMBED_LIBRARY "llama: embed Metal library" OFF)
  98. option(LLAMA_KOMPUTE "llama: use Kompute" OFF)
  99. option(LLAMA_MPI "llama: use MPI" OFF)
  100. option(LLAMA_QKK_64 "llama: use super-block size of 64 for k-quants" OFF)
  101. option(LLAMA_SYCL "llama: use SYCL" OFF)
  102. option(LLAMA_SYCL_F16 "llama: use 16 bit floats for sycl calculations" OFF)
  103. set(LLAMA_SYCL_TARGET "INTEL" CACHE STRING "llama: sycl target device")
  104. option(LLAMA_CPU_HBM "llama: use memkind for CPU HBM" OFF)
  105. set(LLAMA_SCHED_MAX_COPIES "4" CACHE STRING "llama: max input copies for pipeline parallelism")
  106. option(LLAMA_BUILD_TESTS "llama: build tests" ${LLAMA_STANDALONE})
  107. option(LLAMA_BUILD_EXAMPLES "llama: build examples" ${LLAMA_STANDALONE})
  108. option(LLAMA_BUILD_SERVER "llama: build server example" ON)
  109. # add perf arguments
  110. option(LLAMA_PERF "llama: enable perf" OFF)
  111. # Required for relocatable CMake package
  112. include(${CMAKE_CURRENT_SOURCE_DIR}/scripts/build-info.cmake)
  113. #
  114. # Compile flags
  115. #
  116. if (LLAMA_SYCL)
  117. set(CMAKE_CXX_STANDARD 17)
  118. else()
  119. set(CMAKE_CXX_STANDARD 11)
  120. endif()
  121. set(CMAKE_CXX_STANDARD_REQUIRED true)
  122. set(CMAKE_C_STANDARD 11)
  123. set(CMAKE_C_STANDARD_REQUIRED true)
  124. set(THREADS_PREFER_PTHREAD_FLAG ON)
  125. find_package(Threads REQUIRED)
  126. include(CheckCXXCompilerFlag)
  127. add_compile_definitions(GGML_SCHED_MAX_COPIES=${LLAMA_SCHED_MAX_COPIES})
  128. # enable libstdc++ assertions for debug builds
  129. if (CMAKE_SYSTEM_NAME MATCHES "Linux")
  130. add_compile_definitions($<$<CONFIG:Debug>:_GLIBCXX_ASSERTIONS>)
  131. endif()
  132. if (NOT MSVC)
  133. if (LLAMA_SANITIZE_THREAD)
  134. add_compile_options(-fsanitize=thread)
  135. link_libraries (-fsanitize=thread)
  136. endif()
  137. if (LLAMA_SANITIZE_ADDRESS)
  138. add_compile_options(-fsanitize=address -fno-omit-frame-pointer)
  139. link_libraries (-fsanitize=address)
  140. endif()
  141. if (LLAMA_SANITIZE_UNDEFINED)
  142. add_compile_options(-fsanitize=undefined)
  143. link_libraries (-fsanitize=undefined)
  144. endif()
  145. endif()
  146. if (APPLE AND LLAMA_ACCELERATE)
  147. find_library(ACCELERATE_FRAMEWORK Accelerate)
  148. if (ACCELERATE_FRAMEWORK)
  149. message(STATUS "Accelerate framework found")
  150. add_compile_definitions(GGML_USE_ACCELERATE)
  151. add_compile_definitions(ACCELERATE_NEW_LAPACK)
  152. add_compile_definitions(ACCELERATE_LAPACK_ILP64)
  153. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${ACCELERATE_FRAMEWORK})
  154. else()
  155. message(WARNING "Accelerate framework not found")
  156. endif()
  157. endif()
  158. if (LLAMA_METAL)
  159. find_library(FOUNDATION_LIBRARY Foundation REQUIRED)
  160. find_library(METAL_FRAMEWORK Metal REQUIRED)
  161. find_library(METALKIT_FRAMEWORK MetalKit REQUIRED)
  162. message(STATUS "Metal framework found")
  163. set(GGML_HEADERS_METAL ggml-metal.h)
  164. set(GGML_SOURCES_METAL ggml-metal.m)
  165. add_compile_definitions(GGML_USE_METAL)
  166. if (LLAMA_METAL_NDEBUG)
  167. add_compile_definitions(GGML_METAL_NDEBUG)
  168. endif()
  169. # copy ggml-common.h and ggml-metal.metal to bin directory
  170. configure_file(ggml-common.h ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-common.h COPYONLY)
  171. configure_file(ggml-metal.metal ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-metal.metal COPYONLY)
  172. if (LLAMA_METAL_EMBED_LIBRARY)
  173. enable_language(ASM)
  174. add_compile_definitions(GGML_METAL_EMBED_LIBRARY)
  175. set(METALLIB_COMMON "${CMAKE_CURRENT_SOURCE_DIR}/ggml-common.h")
  176. set(METALLIB_SOURCE "${CMAKE_CURRENT_SOURCE_DIR}/ggml-metal.metal")
  177. file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/autogenerated")
  178. # merge ggml-common.h and ggml-metal.metal into a single file
  179. set(METALLIB_EMBED_ASM "${CMAKE_BINARY_DIR}/autogenerated/ggml-metal-embed.s")
  180. set(METALLIB_SOURCE_EMBED "${CMAKE_BINARY_DIR}/autogenerated/ggml-metal-embed.metal")
  181. add_custom_command(
  182. OUTPUT ${METALLIB_EMBED_ASM}
  183. COMMAND echo "Embedding Metal library"
  184. COMMAND sed -e '/\#include \"ggml-common.h\"/r ${METALLIB_COMMON}' -e '/\#include \"ggml-common.h\"/d' < ${METALLIB_SOURCE} > ${METALLIB_SOURCE_EMBED}
  185. COMMAND echo ".section __DATA,__ggml_metallib" > ${METALLIB_EMBED_ASM}
  186. COMMAND echo ".globl _ggml_metallib_start" >> ${METALLIB_EMBED_ASM}
  187. COMMAND echo "_ggml_metallib_start:" >> ${METALLIB_EMBED_ASM}
  188. COMMAND echo ".incbin \\\"${METALLIB_SOURCE_EMBED}\\\"" >> ${METALLIB_EMBED_ASM}
  189. COMMAND echo ".globl _ggml_metallib_end" >> ${METALLIB_EMBED_ASM}
  190. COMMAND echo "_ggml_metallib_end:" >> ${METALLIB_EMBED_ASM}
  191. DEPENDS ggml-metal.metal ggml-common.h
  192. COMMENT "Generate assembly for embedded Metal library"
  193. )
  194. set(GGML_SOURCES_METAL ${GGML_SOURCES_METAL} ${METALLIB_EMBED_ASM})
  195. else()
  196. if (LLAMA_METAL_SHADER_DEBUG)
  197. # custom command to do the following:
  198. # xcrun -sdk macosx metal -fno-fast-math -c ggml-metal.metal -o ggml-metal.air
  199. # xcrun -sdk macosx metallib ggml-metal.air -o default.metallib
  200. #
  201. # note: this is the only way I found to disable fast-math in Metal. it's ugly, but at least it works
  202. # disabling fast math is needed in order to pass tests/test-backend-ops
  203. # note: adding -fno-inline fixes the tests when using MTL_SHADER_VALIDATION=1
  204. # note: unfortunately, we have to call it default.metallib instead of ggml.metallib
  205. # ref: https://github.com/ggerganov/whisper.cpp/issues/1720
  206. set(XC_FLAGS -fno-fast-math -fno-inline -g)
  207. else()
  208. set(XC_FLAGS -O3)
  209. endif()
  210. add_custom_command(
  211. OUTPUT ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/default.metallib
  212. COMMAND xcrun -sdk macosx metal ${XC_FLAGS} -c ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-metal.metal -o ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-metal.air
  213. COMMAND xcrun -sdk macosx metallib ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-metal.air -o ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/default.metallib
  214. COMMAND rm -f ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-metal.air
  215. COMMAND rm -f ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-common.h
  216. COMMAND rm -f ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-metal.metal
  217. DEPENDS ggml-metal.metal ggml-common.h
  218. COMMENT "Compiling Metal kernels"
  219. )
  220. add_custom_target(
  221. ggml-metal ALL
  222. DEPENDS ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/default.metallib
  223. )
  224. endif() # LLAMA_METAL_EMBED_LIBRARY
  225. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS}
  226. ${FOUNDATION_LIBRARY}
  227. ${METAL_FRAMEWORK}
  228. ${METALKIT_FRAMEWORK}
  229. )
  230. endif()
  231. if (LLAMA_BLAS)
  232. if (LLAMA_STATIC)
  233. set(BLA_STATIC ON)
  234. endif()
  235. if ($(CMAKE_VERSION) VERSION_GREATER_EQUAL 3.22)
  236. set(BLA_SIZEOF_INTEGER 8)
  237. endif()
  238. set(BLA_VENDOR ${LLAMA_BLAS_VENDOR})
  239. find_package(BLAS)
  240. if (BLAS_FOUND)
  241. message(STATUS "BLAS found, Libraries: ${BLAS_LIBRARIES}")
  242. if ("${BLAS_INCLUDE_DIRS}" STREQUAL "")
  243. # BLAS_INCLUDE_DIRS is missing in FindBLAS.cmake.
  244. # see https://gitlab.kitware.com/cmake/cmake/-/issues/20268
  245. find_package(PkgConfig REQUIRED)
  246. if (${LLAMA_BLAS_VENDOR} MATCHES "Generic")
  247. pkg_check_modules(DepBLAS REQUIRED blas)
  248. elseif (${LLAMA_BLAS_VENDOR} MATCHES "OpenBLAS")
  249. # As of openblas v0.3.22, the 64-bit is named openblas64.pc
  250. pkg_check_modules(DepBLAS openblas64)
  251. if (NOT DepBLAS_FOUND)
  252. pkg_check_modules(DepBLAS REQUIRED openblas)
  253. endif()
  254. elseif (${LLAMA_BLAS_VENDOR} MATCHES "FLAME")
  255. pkg_check_modules(DepBLAS REQUIRED blis)
  256. elseif (${LLAMA_BLAS_VENDOR} MATCHES "ATLAS")
  257. pkg_check_modules(DepBLAS REQUIRED blas-atlas)
  258. elseif (${LLAMA_BLAS_VENDOR} MATCHES "FlexiBLAS")
  259. pkg_check_modules(DepBLAS REQUIRED flexiblas_api)
  260. elseif (${LLAMA_BLAS_VENDOR} MATCHES "Intel")
  261. # all Intel* libraries share the same include path
  262. pkg_check_modules(DepBLAS REQUIRED mkl-sdl)
  263. elseif (${LLAMA_BLAS_VENDOR} MATCHES "NVHPC")
  264. # this doesn't provide pkg-config
  265. # suggest to assign BLAS_INCLUDE_DIRS on your own
  266. if ("${NVHPC_VERSION}" STREQUAL "")
  267. message(WARNING "Better to set NVHPC_VERSION")
  268. else()
  269. set(DepBLAS_FOUND ON)
  270. set(DepBLAS_INCLUDE_DIRS "/opt/nvidia/hpc_sdk/${CMAKE_SYSTEM_NAME}_${CMAKE_SYSTEM_PROCESSOR}/${NVHPC_VERSION}/math_libs/include")
  271. endif()
  272. endif()
  273. if (DepBLAS_FOUND)
  274. set(BLAS_INCLUDE_DIRS ${DepBLAS_INCLUDE_DIRS})
  275. else()
  276. message(WARNING "BLAS_INCLUDE_DIRS neither been provided nor been automatically"
  277. " detected by pkgconfig, trying to find cblas.h from possible paths...")
  278. find_path(BLAS_INCLUDE_DIRS
  279. NAMES cblas.h
  280. HINTS
  281. /usr/include
  282. /usr/local/include
  283. /usr/include/openblas
  284. /opt/homebrew/opt/openblas/include
  285. /usr/local/opt/openblas/include
  286. /usr/include/x86_64-linux-gnu/openblas/include
  287. )
  288. endif()
  289. endif()
  290. message(STATUS "BLAS found, Includes: ${BLAS_INCLUDE_DIRS}")
  291. add_compile_options(${BLAS_LINKER_FLAGS})
  292. add_compile_definitions(GGML_USE_OPENBLAS)
  293. if (${BLAS_INCLUDE_DIRS} MATCHES "mkl" AND (${LLAMA_BLAS_VENDOR} MATCHES "Generic" OR ${LLAMA_BLAS_VENDOR} MATCHES "Intel"))
  294. add_compile_definitions(GGML_BLAS_USE_MKL)
  295. endif()
  296. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${BLAS_LIBRARIES})
  297. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${BLAS_INCLUDE_DIRS})
  298. else()
  299. message(WARNING "BLAS not found, please refer to "
  300. "https://cmake.org/cmake/help/latest/module/FindBLAS.html#blas-lapack-vendors"
  301. " to set correct LLAMA_BLAS_VENDOR")
  302. endif()
  303. endif()
  304. if (LLAMA_QKK_64)
  305. add_compile_definitions(GGML_QKK_64)
  306. endif()
  307. if (LLAMA_CUBLAS)
  308. cmake_minimum_required(VERSION 3.17)
  309. find_package(CUDAToolkit)
  310. if (CUDAToolkit_FOUND)
  311. message(STATUS "cuBLAS found")
  312. enable_language(CUDA)
  313. set(GGML_HEADERS_CUDA ggml-cuda.h)
  314. file(GLOB GGML_SOURCES_CUDA "ggml-cuda/*.cu")
  315. list(APPEND GGML_SOURCES_CUDA "ggml-cuda.cu")
  316. add_compile_definitions(GGML_USE_CUBLAS)
  317. if (LLAMA_CUDA_FORCE_DMMV)
  318. add_compile_definitions(GGML_CUDA_FORCE_DMMV)
  319. endif()
  320. if (LLAMA_CUDA_FORCE_MMQ)
  321. add_compile_definitions(GGML_CUDA_FORCE_MMQ)
  322. endif()
  323. add_compile_definitions(GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  324. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  325. if (DEFINED LLAMA_CUDA_DMMV_Y)
  326. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_DMMV_Y}) # for backwards compatibility
  327. endif()
  328. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  329. add_compile_definitions(GGML_CUDA_F16)
  330. endif()
  331. add_compile_definitions(K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  332. add_compile_definitions(GGML_CUDA_PEER_MAX_BATCH_SIZE=${LLAMA_CUDA_PEER_MAX_BATCH_SIZE})
  333. if (LLAMA_CUDA_NO_PEER_COPY)
  334. add_compile_definitions(GGML_CUDA_NO_PEER_COPY)
  335. endif()
  336. if (LLAMA_STATIC)
  337. if (WIN32)
  338. # As of 12.3.1 CUDA Tookit for Windows does not offer a static cublas library
  339. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart_static CUDA::cublas CUDA::cublasLt)
  340. else ()
  341. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart_static CUDA::cublas_static CUDA::cublasLt_static)
  342. endif()
  343. else()
  344. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart CUDA::cublas CUDA::cublasLt)
  345. endif()
  346. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cuda_driver)
  347. if (NOT DEFINED CMAKE_CUDA_ARCHITECTURES)
  348. # 52 == lowest CUDA 12 standard
  349. # 60 == f16 CUDA intrinsics
  350. # 61 == integer CUDA intrinsics
  351. # 70 == compute capability at which unrolling a loop in mul_mat_q kernels is faster
  352. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  353. set(CMAKE_CUDA_ARCHITECTURES "60;61;70") # needed for f16 CUDA intrinsics
  354. else()
  355. set(CMAKE_CUDA_ARCHITECTURES "52;61;70") # lowest CUDA 12 standard + lowest for integer intrinsics
  356. #set(CMAKE_CUDA_ARCHITECTURES "") # use this to compile much faster, but only F16 models work
  357. endif()
  358. endif()
  359. message(STATUS "Using CUDA architectures: ${CMAKE_CUDA_ARCHITECTURES}")
  360. else()
  361. message(WARNING "cuBLAS not found")
  362. endif()
  363. endif()
  364. if (LLAMA_MPI)
  365. cmake_minimum_required(VERSION 3.10)
  366. find_package(MPI)
  367. if (MPI_C_FOUND)
  368. message(STATUS "MPI found")
  369. set(GGML_HEADERS_MPI ggml-mpi.h)
  370. set(GGML_SOURCES_MPI ggml-mpi.c)
  371. add_compile_definitions(GGML_USE_MPI)
  372. add_compile_definitions(${MPI_C_COMPILE_DEFINITIONS})
  373. if (NOT MSVC)
  374. add_compile_options(-Wno-cast-qual)
  375. endif()
  376. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_C_LIBRARIES})
  377. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${MPI_C_INCLUDE_DIRS})
  378. # Even if you're only using the C header, C++ programs may bring in MPI
  379. # C++ functions, so more linkage is needed
  380. if (MPI_CXX_FOUND)
  381. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_CXX_LIBRARIES})
  382. endif()
  383. else()
  384. message(WARNING "MPI not found")
  385. endif()
  386. endif()
  387. if (LLAMA_CLBLAST)
  388. find_package(CLBlast)
  389. if (CLBlast_FOUND)
  390. message(STATUS "CLBlast found")
  391. set(GGML_HEADERS_OPENCL ggml-opencl.h)
  392. set(GGML_SOURCES_OPENCL ggml-opencl.cpp)
  393. add_compile_definitions(GGML_USE_CLBLAST)
  394. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} clblast)
  395. else()
  396. message(WARNING "CLBlast not found")
  397. endif()
  398. endif()
  399. if (LLAMA_VULKAN)
  400. find_package(Vulkan)
  401. if (Vulkan_FOUND)
  402. message(STATUS "Vulkan found")
  403. set(GGML_HEADERS_VULKAN ggml-vulkan.h)
  404. set(GGML_SOURCES_VULKAN ggml-vulkan.cpp)
  405. add_compile_definitions(GGML_USE_VULKAN)
  406. if (LLAMA_VULKAN_CHECK_RESULTS)
  407. add_compile_definitions(GGML_VULKAN_CHECK_RESULTS)
  408. endif()
  409. if (LLAMA_VULKAN_DEBUG)
  410. add_compile_definitions(GGML_VULKAN_DEBUG)
  411. endif()
  412. if (LLAMA_VULKAN_VALIDATE)
  413. add_compile_definitions(GGML_VULKAN_VALIDATE)
  414. endif()
  415. if (LLAMA_VULKAN_RUN_TESTS)
  416. add_compile_definitions(GGML_VULKAN_RUN_TESTS)
  417. endif()
  418. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} Vulkan::Vulkan)
  419. else()
  420. message(WARNING "Vulkan not found")
  421. endif()
  422. endif()
  423. if (LLAMA_HIPBLAS)
  424. list(APPEND CMAKE_PREFIX_PATH /opt/rocm)
  425. if (NOT ${CMAKE_C_COMPILER_ID} MATCHES "Clang")
  426. message(WARNING "Only LLVM is supported for HIP, hint: CC=/opt/rocm/llvm/bin/clang")
  427. endif()
  428. if (NOT ${CMAKE_CXX_COMPILER_ID} MATCHES "Clang")
  429. message(WARNING "Only LLVM is supported for HIP, hint: CXX=/opt/rocm/llvm/bin/clang++")
  430. endif()
  431. find_package(hip REQUIRED)
  432. find_package(hipblas REQUIRED)
  433. find_package(rocblas REQUIRED)
  434. message(STATUS "HIP and hipBLAS found")
  435. set(GGML_HEADERS_ROCM ggml-cuda.h)
  436. file(GLOB GGML_SOURCES_ROCM "ggml-cuda/*.cu")
  437. list(APPEND GGML_SOURCES_ROCM "ggml-cuda.cu")
  438. add_compile_definitions(GGML_USE_HIPBLAS GGML_USE_CUBLAS)
  439. if (LLAMA_HIP_UMA)
  440. add_compile_definitions(GGML_HIP_UMA)
  441. endif()
  442. if (LLAMA_CUDA_FORCE_DMMV)
  443. add_compile_definitions(GGML_CUDA_FORCE_DMMV)
  444. endif()
  445. if (LLAMA_CUDA_FORCE_MMQ)
  446. add_compile_definitions(GGML_CUDA_FORCE_MMQ)
  447. endif()
  448. if (LLAMA_CUDA_NO_PEER_COPY)
  449. add_compile_definitions(GGML_CUDA_NO_PEER_COPY)
  450. endif()
  451. add_compile_definitions(GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  452. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  453. add_compile_definitions(K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  454. set_source_files_properties(${GGML_SOURCES_ROCM} PROPERTIES LANGUAGE CXX)
  455. if (LLAMA_STATIC)
  456. message(FATAL_ERROR "Static linking not supported for HIP/ROCm")
  457. endif()
  458. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} hip::device PUBLIC hip::host roc::rocblas roc::hipblas)
  459. endif()
  460. if (LLAMA_SYCL)
  461. if (NOT LLAMA_SYCL_TARGET MATCHES "^(INTEL|NVIDIA)$")
  462. message(FATAL_ERROR "Invalid backend chosen, supported options are INTEL or NVIDIA")
  463. endif()
  464. if ( NOT DEFINED ENV{ONEAPI_ROOT})
  465. message(FATAL_ERROR "Not detect ENV {ONEAPI_ROOT}, please install oneAPI & source it, like: source /opt/intel/oneapi/setvars.sh")
  466. endif()
  467. #todo: AOT
  468. find_package(IntelSYCL REQUIRED)
  469. message(STATUS "SYCL found")
  470. add_compile_definitions(GGML_USE_SYCL)
  471. if (LLAMA_SYCL_F16)
  472. add_compile_definitions(GGML_SYCL_F16)
  473. endif()
  474. add_compile_options(-I./) #include DPCT
  475. add_compile_options(-I/${SYCL_INCLUDE_DIR})
  476. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-narrowing")
  477. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3")
  478. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsycl -L${MKLROOT}/lib")
  479. if (LLAMA_SYCL_TARGET STREQUAL "NVIDIA")
  480. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsycl-targets=nvptx64-nvidia-cuda")
  481. endif()
  482. set(GGML_HEADERS_SYCL ggml-sycl.h)
  483. set(GGML_SOURCES_SYCL ggml-sycl.cpp)
  484. if (WIN32)
  485. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} -fsycl sycl7 OpenCL mkl_sycl_blas_dll.lib mkl_intel_ilp64_dll.lib mkl_sequential_dll.lib mkl_core_dll.lib)
  486. else()
  487. if (LLAMA_SYCL_TARGET STREQUAL "INTEL")
  488. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} -fsycl OpenCL mkl_core pthread m dl mkl_sycl_blas mkl_intel_ilp64 mkl_tbb_thread)
  489. elseif (LLAMA_SYCL_TARGET STREQUAL "NVIDIA")
  490. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} -fsycl pthread m dl onemkl)
  491. endif()
  492. endif()
  493. endif()
  494. if (LLAMA_KOMPUTE)
  495. add_compile_definitions(VULKAN_HPP_DISPATCH_LOADER_DYNAMIC=1)
  496. find_package(Vulkan COMPONENTS glslc REQUIRED)
  497. find_program(glslc_executable NAMES glslc HINTS Vulkan::glslc)
  498. if (NOT glslc_executable)
  499. message(FATAL_ERROR "glslc not found")
  500. endif()
  501. function(compile_shader)
  502. set(options)
  503. set(oneValueArgs)
  504. set(multiValueArgs SOURCES)
  505. cmake_parse_arguments(compile_shader "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
  506. foreach(source ${compile_shader_SOURCES})
  507. get_filename_component(filename ${source} NAME)
  508. set(spv_file ${filename}.spv)
  509. add_custom_command(
  510. OUTPUT ${spv_file}
  511. DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${source}
  512. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/common.comp
  513. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/op_getrows.comp
  514. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/op_mul_mv_q_n_pre.comp
  515. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/op_mul_mv_q_n.comp
  516. COMMAND ${glslc_executable} --target-env=vulkan1.2 -o ${spv_file} ${CMAKE_CURRENT_SOURCE_DIR}/${source}
  517. COMMENT "Compiling ${source} to ${spv_file}"
  518. )
  519. get_filename_component(RAW_FILE_NAME ${spv_file} NAME)
  520. set(FILE_NAME "shader${RAW_FILE_NAME}")
  521. string(REPLACE ".comp.spv" ".h" HEADER_FILE ${FILE_NAME})
  522. string(TOUPPER ${HEADER_FILE} HEADER_FILE_DEFINE)
  523. string(REPLACE "." "_" HEADER_FILE_DEFINE "${HEADER_FILE_DEFINE}")
  524. set(OUTPUT_HEADER_FILE "${HEADER_FILE}")
  525. message(STATUS "${HEADER_FILE} generating ${HEADER_FILE_DEFINE}")
  526. if(CMAKE_GENERATOR MATCHES "Visual Studio")
  527. add_custom_command(
  528. OUTPUT ${OUTPUT_HEADER_FILE}
  529. COMMAND ${CMAKE_COMMAND} -E echo "/*THIS FILE HAS BEEN AUTOMATICALLY GENERATED - DO NOT EDIT*/" > ${OUTPUT_HEADER_FILE}
  530. COMMAND ${CMAKE_COMMAND} -E echo \"\#ifndef ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  531. COMMAND ${CMAKE_COMMAND} -E echo \"\#define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  532. COMMAND ${CMAKE_COMMAND} -E echo "namespace kp {" >> ${OUTPUT_HEADER_FILE}
  533. COMMAND ${CMAKE_COMMAND} -E echo "namespace shader_data {" >> ${OUTPUT_HEADER_FILE}
  534. COMMAND ${CMAKE_BINARY_DIR}/bin/$<CONFIG>/xxd -i ${RAW_FILE_NAME} >> ${OUTPUT_HEADER_FILE}
  535. COMMAND ${CMAKE_COMMAND} -E echo "}}" >> ${OUTPUT_HEADER_FILE}
  536. COMMAND ${CMAKE_COMMAND} -E echo \"\#endif // define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  537. DEPENDS ${spv_file} xxd
  538. COMMENT "Converting to hpp: ${FILE_NAME} ${CMAKE_BINARY_DIR}/bin/$<CONFIG>/xxd"
  539. )
  540. else()
  541. add_custom_command(
  542. OUTPUT ${OUTPUT_HEADER_FILE}
  543. COMMAND ${CMAKE_COMMAND} -E echo "/*THIS FILE HAS BEEN AUTOMATICALLY GENERATED - DO NOT EDIT*/" > ${OUTPUT_HEADER_FILE}
  544. COMMAND ${CMAKE_COMMAND} -E echo \"\#ifndef ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  545. COMMAND ${CMAKE_COMMAND} -E echo \"\#define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  546. COMMAND ${CMAKE_COMMAND} -E echo "namespace kp {" >> ${OUTPUT_HEADER_FILE}
  547. COMMAND ${CMAKE_COMMAND} -E echo "namespace shader_data {" >> ${OUTPUT_HEADER_FILE}
  548. COMMAND ${CMAKE_BINARY_DIR}/bin/xxd -i ${RAW_FILE_NAME} >> ${OUTPUT_HEADER_FILE}
  549. COMMAND ${CMAKE_COMMAND} -E echo "}}" >> ${OUTPUT_HEADER_FILE}
  550. COMMAND ${CMAKE_COMMAND} -E echo \"\#endif // define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  551. DEPENDS ${spv_file} xxd
  552. COMMENT "Converting to hpp: ${FILE_NAME} ${CMAKE_BINARY_DIR}/bin/xxd"
  553. )
  554. endif()
  555. endforeach()
  556. endfunction()
  557. if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/kompute/CMakeLists.txt")
  558. message(STATUS "Kompute found")
  559. set(KOMPUTE_OPT_LOG_LEVEL Error CACHE STRING "Kompute log level")
  560. add_subdirectory(kompute)
  561. # Compile our shaders
  562. compile_shader(SOURCES
  563. kompute-shaders/op_scale.comp
  564. kompute-shaders/op_scale_8.comp
  565. kompute-shaders/op_add.comp
  566. kompute-shaders/op_addrow.comp
  567. kompute-shaders/op_mul.comp
  568. kompute-shaders/op_silu.comp
  569. kompute-shaders/op_relu.comp
  570. kompute-shaders/op_gelu.comp
  571. kompute-shaders/op_softmax.comp
  572. kompute-shaders/op_norm.comp
  573. kompute-shaders/op_rmsnorm.comp
  574. kompute-shaders/op_diagmask.comp
  575. kompute-shaders/op_mul_mat_mat_f32.comp
  576. kompute-shaders/op_mul_mat_f16.comp
  577. kompute-shaders/op_mul_mat_q8_0.comp
  578. kompute-shaders/op_mul_mat_q4_0.comp
  579. kompute-shaders/op_mul_mat_q4_1.comp
  580. kompute-shaders/op_mul_mat_q6_k.comp
  581. kompute-shaders/op_getrows_f16.comp
  582. kompute-shaders/op_getrows_q4_0.comp
  583. kompute-shaders/op_getrows_q4_1.comp
  584. kompute-shaders/op_getrows_q6_k.comp
  585. kompute-shaders/op_rope_f16.comp
  586. kompute-shaders/op_rope_f32.comp
  587. kompute-shaders/op_cpy_f16_f16.comp
  588. kompute-shaders/op_cpy_f16_f32.comp
  589. kompute-shaders/op_cpy_f32_f16.comp
  590. kompute-shaders/op_cpy_f32_f32.comp
  591. )
  592. # Create a custom target for our generated shaders
  593. add_custom_target(generated_shaders DEPENDS
  594. shaderop_scale.h
  595. shaderop_scale_8.h
  596. shaderop_add.h
  597. shaderop_addrow.h
  598. shaderop_mul.h
  599. shaderop_silu.h
  600. shaderop_relu.h
  601. shaderop_gelu.h
  602. shaderop_softmax.h
  603. shaderop_norm.h
  604. shaderop_rmsnorm.h
  605. shaderop_diagmask.h
  606. shaderop_mul_mat_mat_f32.h
  607. shaderop_mul_mat_f16.h
  608. shaderop_mul_mat_q8_0.h
  609. shaderop_mul_mat_q4_0.h
  610. shaderop_mul_mat_q4_1.h
  611. shaderop_mul_mat_q6_k.h
  612. shaderop_getrows_f16.h
  613. shaderop_getrows_q4_0.h
  614. shaderop_getrows_q4_1.h
  615. shaderop_getrows_q6_k.h
  616. shaderop_rope_f16.h
  617. shaderop_rope_f32.h
  618. shaderop_cpy_f16_f16.h
  619. shaderop_cpy_f16_f32.h
  620. shaderop_cpy_f32_f16.h
  621. shaderop_cpy_f32_f32.h
  622. )
  623. # Create a custom command that depends on the generated_shaders
  624. add_custom_command(
  625. OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp
  626. COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp
  627. DEPENDS generated_shaders
  628. COMMENT "Ensuring shaders are generated before compiling ggml-kompute.cpp"
  629. )
  630. # Add the stamp to the main sources to ensure dependency tracking
  631. set(GGML_SOURCES_KOMPUTE ggml-kompute.cpp ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp)
  632. set(GGML_HEADERS_KOMPUTE ggml-kompute.h ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp)
  633. add_compile_definitions(GGML_USE_KOMPUTE)
  634. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} kompute)
  635. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${CMAKE_BINARY_DIR})
  636. else()
  637. message(WARNING "Kompute not found")
  638. endif()
  639. endif()
  640. if (LLAMA_CPU_HBM)
  641. find_library(memkind memkind REQUIRED)
  642. add_compile_definitions(GGML_USE_CPU_HBM)
  643. target_link_libraries(ggml PUBLIC memkind)
  644. endif()
  645. if (LLAMA_PERF)
  646. add_compile_definitions(GGML_PERF)
  647. endif()
  648. function(get_flags CCID CCVER)
  649. set(C_FLAGS "")
  650. set(CXX_FLAGS "")
  651. if (CCID MATCHES "Clang")
  652. set(C_FLAGS -Wunreachable-code-break -Wunreachable-code-return)
  653. set(CXX_FLAGS -Wunreachable-code-break -Wunreachable-code-return -Wmissing-prototypes -Wextra-semi)
  654. if (
  655. (CCID STREQUAL "Clang" AND CCVER VERSION_GREATER_EQUAL 3.8.0) OR
  656. (CCID STREQUAL "AppleClang" AND CCVER VERSION_GREATER_EQUAL 7.3.0)
  657. )
  658. list(APPEND C_FLAGS -Wdouble-promotion)
  659. endif()
  660. elseif (CCID STREQUAL "GNU")
  661. set(C_FLAGS -Wdouble-promotion)
  662. set(CXX_FLAGS -Wno-array-bounds)
  663. if (CCVER VERSION_GREATER_EQUAL 7.1.0)
  664. list(APPEND CXX_FLAGS -Wno-format-truncation)
  665. endif()
  666. if (CCVER VERSION_GREATER_EQUAL 8.1.0)
  667. list(APPEND CXX_FLAGS -Wextra-semi)
  668. endif()
  669. endif()
  670. set(GF_C_FLAGS ${C_FLAGS} PARENT_SCOPE)
  671. set(GF_CXX_FLAGS ${CXX_FLAGS} PARENT_SCOPE)
  672. endfunction()
  673. if (LLAMA_FATAL_WARNINGS)
  674. if (CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
  675. list(APPEND C_FLAGS -Werror)
  676. list(APPEND CXX_FLAGS -Werror)
  677. elseif (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
  678. add_compile_options(/WX)
  679. endif()
  680. endif()
  681. if (LLAMA_ALL_WARNINGS)
  682. if (NOT MSVC)
  683. list(APPEND WARNING_FLAGS -Wall -Wextra -Wpedantic -Wcast-qual -Wno-unused-function)
  684. list(APPEND C_FLAGS -Wshadow -Wstrict-prototypes -Wpointer-arith -Wmissing-prototypes
  685. -Werror=implicit-int -Werror=implicit-function-declaration)
  686. list(APPEND CXX_FLAGS -Wmissing-declarations -Wmissing-noreturn)
  687. list(APPEND C_FLAGS ${WARNING_FLAGS})
  688. list(APPEND CXX_FLAGS ${WARNING_FLAGS})
  689. get_flags(${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION})
  690. add_compile_options("$<$<COMPILE_LANGUAGE:C>:${C_FLAGS};${GF_C_FLAGS}>"
  691. "$<$<COMPILE_LANGUAGE:CXX>:${CXX_FLAGS};${GF_CXX_FLAGS}>")
  692. else()
  693. # todo : msvc
  694. set(C_FLAGS "")
  695. set(CXX_FLAGS "")
  696. endif()
  697. endif()
  698. set(CUDA_CXX_FLAGS "")
  699. if (LLAMA_CUBLAS)
  700. set(CUDA_FLAGS -use_fast_math)
  701. if (LLAMA_FATAL_WARNINGS)
  702. list(APPEND CUDA_FLAGS -Werror all-warnings)
  703. endif()
  704. if (LLAMA_ALL_WARNINGS AND NOT MSVC)
  705. set(NVCC_CMD ${CMAKE_CUDA_COMPILER} .c)
  706. if (NOT CMAKE_CUDA_HOST_COMPILER STREQUAL "")
  707. list(APPEND NVCC_CMD -ccbin ${CMAKE_CUDA_HOST_COMPILER})
  708. endif()
  709. execute_process(
  710. COMMAND ${NVCC_CMD} -Xcompiler --version
  711. OUTPUT_VARIABLE CUDA_CCFULLVER
  712. ERROR_QUIET
  713. )
  714. if (NOT CUDA_CCFULLVER MATCHES clang)
  715. set(CUDA_CCID "GNU")
  716. execute_process(
  717. COMMAND ${NVCC_CMD} -Xcompiler "-dumpfullversion -dumpversion"
  718. OUTPUT_VARIABLE CUDA_CCVER
  719. ERROR_QUIET
  720. )
  721. else()
  722. if (CUDA_CCFULLVER MATCHES Apple)
  723. set(CUDA_CCID "AppleClang")
  724. else()
  725. set(CUDA_CCID "Clang")
  726. endif()
  727. string(REGEX REPLACE "^.* version ([0-9.]*).*$" "\\1" CUDA_CCVER ${CUDA_CCFULLVER})
  728. endif()
  729. message("-- CUDA host compiler is ${CUDA_CCID} ${CUDA_CCVER}")
  730. get_flags(${CUDA_CCID} ${CUDA_CCVER})
  731. list(APPEND CUDA_CXX_FLAGS ${CXX_FLAGS} ${GF_CXX_FLAGS}) # This is passed to -Xcompiler later
  732. endif()
  733. if (NOT MSVC)
  734. list(APPEND CUDA_CXX_FLAGS -Wno-pedantic)
  735. endif()
  736. endif()
  737. if (WIN32)
  738. add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
  739. if (BUILD_SHARED_LIBS)
  740. set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
  741. endif()
  742. endif()
  743. if (LLAMA_LTO)
  744. include(CheckIPOSupported)
  745. check_ipo_supported(RESULT result OUTPUT output)
  746. if (result)
  747. set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE)
  748. else()
  749. message(WARNING "IPO is not supported: ${output}")
  750. endif()
  751. endif()
  752. if (LLAMA_CCACHE)
  753. find_program(LLAMA_CCACHE_FOUND ccache)
  754. if (LLAMA_CCACHE_FOUND)
  755. set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ccache)
  756. set(ENV{CCACHE_SLOPPINESS} time_macros)
  757. message(STATUS "ccache found, compilation results will be cached. Disable with LLAMA_CCACHE=OFF.")
  758. else()
  759. message(STATUS "Warning: ccache not found - consider installing it for faster compilation or disable this warning with LLAMA_CCACHE=OFF")
  760. endif ()
  761. endif()
  762. # this version of Apple ld64 is buggy
  763. execute_process(
  764. COMMAND ${CMAKE_C_COMPILER} ${CMAKE_EXE_LINKER_FLAGS} -Wl,-v
  765. ERROR_VARIABLE output
  766. OUTPUT_QUIET
  767. )
  768. if (output MATCHES "dyld-1015\.7")
  769. add_compile_definitions(HAVE_BUGGY_APPLE_LINKER)
  770. endif()
  771. # Architecture specific
  772. # TODO: probably these flags need to be tweaked on some architectures
  773. # feel free to update the Makefile for your architecture and send a pull request or issue
  774. message(STATUS "CMAKE_SYSTEM_PROCESSOR: ${CMAKE_SYSTEM_PROCESSOR}")
  775. if (MSVC)
  776. string(TOLOWER "${CMAKE_GENERATOR_PLATFORM}" CMAKE_GENERATOR_PLATFORM_LWR)
  777. message(STATUS "CMAKE_GENERATOR_PLATFORM: ${CMAKE_GENERATOR_PLATFORM}")
  778. else ()
  779. set(CMAKE_GENERATOR_PLATFORM_LWR "")
  780. endif ()
  781. if (NOT MSVC)
  782. if (LLAMA_STATIC)
  783. add_link_options(-static)
  784. if (MINGW)
  785. add_link_options(-static-libgcc -static-libstdc++)
  786. endif()
  787. endif()
  788. if (LLAMA_GPROF)
  789. add_compile_options(-pg)
  790. endif()
  791. endif()
  792. set(ARCH_FLAGS "")
  793. if (CMAKE_OSX_ARCHITECTURES STREQUAL "arm64" OR CMAKE_GENERATOR_PLATFORM_LWR STREQUAL "arm64" OR
  794. (NOT CMAKE_OSX_ARCHITECTURES AND NOT CMAKE_GENERATOR_PLATFORM_LWR AND
  795. CMAKE_SYSTEM_PROCESSOR MATCHES "^(aarch64|arm.*|ARM64)$"))
  796. message(STATUS "ARM detected")
  797. if (MSVC)
  798. add_compile_definitions(__aarch64__) # MSVC defines _M_ARM64 instead
  799. add_compile_definitions(__ARM_NEON)
  800. add_compile_definitions(__ARM_FEATURE_FMA)
  801. set(CMAKE_REQUIRED_FLAGS_PREV ${CMAKE_REQUIRED_FLAGS})
  802. string(JOIN " " CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS} "/arch:armv8.2")
  803. check_cxx_source_compiles("#include <arm_neon.h>\nint main() { int8x16_t _a, _b; int32x4_t _s = vdotq_s32(_s, _a, _b); return 0; }" GGML_COMPILER_SUPPORT_DOTPROD)
  804. if (GGML_COMPILER_SUPPORT_DOTPROD)
  805. add_compile_definitions(__ARM_FEATURE_DOTPROD)
  806. endif ()
  807. check_cxx_source_compiles("#include <arm_neon.h>\nint main() { float16_t _a; float16x8_t _s = vdupq_n_f16(_a); return 0; }" GGML_COMPILER_SUPPORT_FP16_VECTOR_ARITHMETIC)
  808. if (GGML_COMPILER_SUPPORT_FP16_VECTOR_ARITHMETIC)
  809. add_compile_definitions(__ARM_FEATURE_FP16_VECTOR_ARITHMETIC)
  810. endif ()
  811. set(CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS_PREV})
  812. else()
  813. check_cxx_compiler_flag(-mfp16-format=ieee COMPILER_SUPPORTS_FP16_FORMAT_I3E)
  814. if (NOT "${COMPILER_SUPPORTS_FP16_FORMAT_I3E}" STREQUAL "")
  815. list(APPEND ARCH_FLAGS -mfp16-format=ieee)
  816. endif()
  817. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv6")
  818. # Raspberry Pi 1, Zero
  819. list(APPEND ARCH_FLAGS -mfpu=neon-fp-armv8 -mno-unaligned-access)
  820. endif()
  821. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv7")
  822. if ("${CMAKE_SYSTEM_NAME}" STREQUAL "Android")
  823. # Android armeabi-v7a
  824. list(APPEND ARCH_FLAGS -mfpu=neon-vfpv4 -mno-unaligned-access -funsafe-math-optimizations)
  825. else()
  826. # Raspberry Pi 2
  827. list(APPEND ARCH_FLAGS -mfpu=neon-fp-armv8 -mno-unaligned-access -funsafe-math-optimizations)
  828. endif()
  829. endif()
  830. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv8")
  831. # Android arm64-v8a
  832. # Raspberry Pi 3, 4, Zero 2 (32-bit)
  833. list(APPEND ARCH_FLAGS -mno-unaligned-access)
  834. endif()
  835. endif()
  836. elseif (CMAKE_OSX_ARCHITECTURES STREQUAL "x86_64" OR CMAKE_GENERATOR_PLATFORM_LWR MATCHES "^(x86_64|i686|amd64|x64|win32)$" OR
  837. (NOT CMAKE_OSX_ARCHITECTURES AND NOT CMAKE_GENERATOR_PLATFORM_LWR AND
  838. CMAKE_SYSTEM_PROCESSOR MATCHES "^(x86_64|i686|AMD64)$"))
  839. message(STATUS "x86 detected")
  840. if (MSVC)
  841. # instruction set detection for MSVC only
  842. if (LLAMA_NATIVE)
  843. include(cmake/FindSIMD.cmake)
  844. endif ()
  845. if (LLAMA_AVX512)
  846. list(APPEND ARCH_FLAGS /arch:AVX512)
  847. # MSVC has no compile-time flags enabling specific
  848. # AVX512 extensions, neither it defines the
  849. # macros corresponding to the extensions.
  850. # Do it manually.
  851. if (LLAMA_AVX512_VBMI)
  852. add_compile_definitions($<$<COMPILE_LANGUAGE:C>:__AVX512VBMI__>)
  853. add_compile_definitions($<$<COMPILE_LANGUAGE:CXX>:__AVX512VBMI__>)
  854. endif()
  855. if (LLAMA_AVX512_VNNI)
  856. add_compile_definitions($<$<COMPILE_LANGUAGE:C>:__AVX512VNNI__>)
  857. add_compile_definitions($<$<COMPILE_LANGUAGE:CXX>:__AVX512VNNI__>)
  858. endif()
  859. elseif (LLAMA_AVX2)
  860. list(APPEND ARCH_FLAGS /arch:AVX2)
  861. elseif (LLAMA_AVX)
  862. list(APPEND ARCH_FLAGS /arch:AVX)
  863. endif()
  864. else()
  865. if (LLAMA_NATIVE)
  866. list(APPEND ARCH_FLAGS -march=native)
  867. endif()
  868. if (LLAMA_F16C)
  869. list(APPEND ARCH_FLAGS -mf16c)
  870. endif()
  871. if (LLAMA_FMA)
  872. list(APPEND ARCH_FLAGS -mfma)
  873. endif()
  874. if (LLAMA_AVX)
  875. list(APPEND ARCH_FLAGS -mavx)
  876. endif()
  877. if (LLAMA_AVX2)
  878. list(APPEND ARCH_FLAGS -mavx2)
  879. endif()
  880. if (LLAMA_AVX512)
  881. list(APPEND ARCH_FLAGS -mavx512f)
  882. list(APPEND ARCH_FLAGS -mavx512bw)
  883. endif()
  884. if (LLAMA_AVX512_VBMI)
  885. list(APPEND ARCH_FLAGS -mavx512vbmi)
  886. endif()
  887. if (LLAMA_AVX512_VNNI)
  888. list(APPEND ARCH_FLAGS -mavx512vnni)
  889. endif()
  890. endif()
  891. elseif (${CMAKE_SYSTEM_PROCESSOR} MATCHES "ppc64")
  892. message(STATUS "PowerPC detected")
  893. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "ppc64le")
  894. list(APPEND ARCH_FLAGS -mcpu=powerpc64le)
  895. else()
  896. list(APPEND ARCH_FLAGS -mcpu=native -mtune=native)
  897. #TODO: Add targets for Power8/Power9 (Altivec/VSX) and Power10(MMA) and query for big endian systems (ppc64/le/be)
  898. endif()
  899. else()
  900. message(STATUS "Unknown architecture")
  901. endif()
  902. add_compile_options("$<$<COMPILE_LANGUAGE:CXX>:${ARCH_FLAGS}>")
  903. add_compile_options("$<$<COMPILE_LANGUAGE:C>:${ARCH_FLAGS}>")
  904. if (LLAMA_CUBLAS)
  905. list(APPEND CUDA_CXX_FLAGS ${ARCH_FLAGS})
  906. list(JOIN CUDA_CXX_FLAGS " " CUDA_CXX_FLAGS_JOINED) # pass host compiler flags as a single argument
  907. if (NOT CUDA_CXX_FLAGS_JOINED STREQUAL "")
  908. list(APPEND CUDA_FLAGS -Xcompiler ${CUDA_CXX_FLAGS_JOINED})
  909. endif()
  910. add_compile_options("$<$<COMPILE_LANGUAGE:CUDA>:${CUDA_FLAGS}>")
  911. endif()
  912. if (MINGW)
  913. # Target Windows 8 for PrefetchVirtualMemory
  914. add_compile_definitions(_WIN32_WINNT=${LLAMA_WIN_VER})
  915. endif()
  916. #
  917. # POSIX conformance
  918. #
  919. # clock_gettime came in POSIX.1b (1993)
  920. # CLOCK_MONOTONIC came in POSIX.1-2001 / SUSv3 as optional
  921. # posix_memalign came in POSIX.1-2001 / SUSv3
  922. # M_PI is an XSI extension since POSIX.1-2001 / SUSv3, came in XPG1 (1985)
  923. add_compile_definitions(_XOPEN_SOURCE=600)
  924. # Somehow in OpenBSD whenever POSIX conformance is specified
  925. # some string functions rely on locale_t availability,
  926. # which was introduced in POSIX.1-2008, forcing us to go higher
  927. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  928. remove_definitions(-D_XOPEN_SOURCE=600)
  929. add_compile_definitions(_XOPEN_SOURCE=700)
  930. endif()
  931. # Data types, macros and functions related to controlling CPU affinity and
  932. # some memory allocation are available on Linux through GNU extensions in libc
  933. if (CMAKE_SYSTEM_NAME MATCHES "Linux")
  934. add_compile_definitions(_GNU_SOURCE)
  935. endif()
  936. # RLIMIT_MEMLOCK came in BSD, is not specified in POSIX.1,
  937. # and on macOS its availability depends on enabling Darwin extensions
  938. # similarly on DragonFly, enabling BSD extensions is necessary
  939. if (
  940. CMAKE_SYSTEM_NAME MATCHES "Darwin" OR
  941. CMAKE_SYSTEM_NAME MATCHES "iOS" OR
  942. CMAKE_SYSTEM_NAME MATCHES "tvOS" OR
  943. CMAKE_SYSTEM_NAME MATCHES "DragonFly"
  944. )
  945. add_compile_definitions(_DARWIN_C_SOURCE)
  946. endif()
  947. # alloca is a non-standard interface that is not visible on BSDs when
  948. # POSIX conformance is specified, but not all of them provide a clean way
  949. # to enable it in such cases
  950. if (CMAKE_SYSTEM_NAME MATCHES "FreeBSD")
  951. add_compile_definitions(__BSD_VISIBLE)
  952. endif()
  953. if (CMAKE_SYSTEM_NAME MATCHES "NetBSD")
  954. add_compile_definitions(_NETBSD_SOURCE)
  955. endif()
  956. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  957. add_compile_definitions(_BSD_SOURCE)
  958. endif()
  959. #
  960. # libraries
  961. #
  962. # ggml
  963. add_library(ggml OBJECT
  964. ggml.c
  965. ggml.h
  966. ggml-alloc.c
  967. ggml-alloc.h
  968. ggml-backend.c
  969. ggml-backend.h
  970. ggml-quants.c
  971. ggml-quants.h
  972. ${GGML_SOURCES_CUDA} ${GGML_HEADERS_CUDA}
  973. ${GGML_SOURCES_OPENCL} ${GGML_HEADERS_OPENCL}
  974. ${GGML_SOURCES_METAL} ${GGML_HEADERS_METAL}
  975. ${GGML_SOURCES_MPI} ${GGML_HEADERS_MPI}
  976. ${GGML_SOURCES_EXTRA} ${GGML_HEADERS_EXTRA}
  977. ${GGML_SOURCES_SYCL} ${GGML_HEADERS_SYCL}
  978. ${GGML_SOURCES_KOMPUTE} ${GGML_HEADERS_KOMPUTE}
  979. ${GGML_SOURCES_VULKAN} ${GGML_HEADERS_VULKAN}
  980. ${GGML_SOURCES_ROCM} ${GGML_HEADERS_ROCM}
  981. )
  982. target_include_directories(ggml PUBLIC . ${LLAMA_EXTRA_INCLUDES})
  983. target_compile_features (ggml PUBLIC c_std_11) # don't bump
  984. target_link_libraries(ggml PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  985. add_library(ggml_static STATIC $<TARGET_OBJECTS:ggml>)
  986. if (BUILD_SHARED_LIBS)
  987. set_target_properties(ggml PROPERTIES POSITION_INDEPENDENT_CODE ON)
  988. add_library(ggml_shared SHARED $<TARGET_OBJECTS:ggml>)
  989. target_link_libraries(ggml_shared PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  990. install(TARGETS ggml_shared LIBRARY)
  991. endif()
  992. # llama
  993. add_library(llama
  994. llama.cpp
  995. llama.h
  996. unicode.h
  997. unicode.cpp
  998. )
  999. target_include_directories(llama PUBLIC .)
  1000. target_compile_features (llama PUBLIC cxx_std_11) # don't bump
  1001. target_link_libraries(llama PRIVATE
  1002. ggml
  1003. ${LLAMA_EXTRA_LIBS}
  1004. )
  1005. if (BUILD_SHARED_LIBS)
  1006. set_target_properties(llama PROPERTIES POSITION_INDEPENDENT_CODE ON)
  1007. target_compile_definitions(llama PRIVATE LLAMA_SHARED LLAMA_BUILD)
  1008. if (LLAMA_METAL)
  1009. set_target_properties(llama PROPERTIES RESOURCE "${CMAKE_CURRENT_SOURCE_DIR}/ggml-metal.metal")
  1010. endif()
  1011. endif()
  1012. #
  1013. # install
  1014. #
  1015. include(GNUInstallDirs)
  1016. include(CMakePackageConfigHelpers)
  1017. set(LLAMA_INCLUDE_INSTALL_DIR ${CMAKE_INSTALL_INCLUDEDIR}
  1018. CACHE PATH "Location of header files")
  1019. set(LLAMA_LIB_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR}
  1020. CACHE PATH "Location of library files")
  1021. set(LLAMA_BIN_INSTALL_DIR ${CMAKE_INSTALL_BINDIR}
  1022. CACHE PATH "Location of binary files")
  1023. set(LLAMA_BUILD_NUMBER ${BUILD_NUMBER})
  1024. set(LLAMA_BUILD_COMMIT ${BUILD_COMMIT})
  1025. set(LLAMA_INSTALL_VERSION 0.0.${BUILD_NUMBER})
  1026. get_directory_property(LLAMA_TRANSIENT_DEFINES COMPILE_DEFINITIONS)
  1027. configure_package_config_file(
  1028. ${CMAKE_CURRENT_SOURCE_DIR}/scripts/LlamaConfig.cmake.in
  1029. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfig.cmake
  1030. INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Llama
  1031. PATH_VARS LLAMA_INCLUDE_INSTALL_DIR
  1032. LLAMA_LIB_INSTALL_DIR
  1033. LLAMA_BIN_INSTALL_DIR )
  1034. write_basic_package_version_file(
  1035. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfigVersion.cmake
  1036. VERSION ${LLAMA_INSTALL_VERSION}
  1037. COMPATIBILITY SameMajorVersion)
  1038. install(FILES ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfig.cmake
  1039. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfigVersion.cmake
  1040. DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Llama)
  1041. set(GGML_PUBLIC_HEADERS "ggml.h" "ggml-alloc.h" "ggml-backend.h"
  1042. "${GGML_HEADERS_CUDA}" "${GGML_HEADERS_OPENCL}"
  1043. "${GGML_HEADERS_METAL}" "${GGML_HEADERS_MPI}" "${GGML_HEADERS_EXTRA}")
  1044. set_target_properties(ggml PROPERTIES PUBLIC_HEADER "${GGML_PUBLIC_HEADERS}")
  1045. install(TARGETS ggml PUBLIC_HEADER)
  1046. set_target_properties(llama PROPERTIES PUBLIC_HEADER ${CMAKE_CURRENT_SOURCE_DIR}/llama.h)
  1047. install(TARGETS llama LIBRARY PUBLIC_HEADER)
  1048. install(
  1049. FILES convert.py
  1050. PERMISSIONS
  1051. OWNER_READ
  1052. OWNER_WRITE
  1053. OWNER_EXECUTE
  1054. GROUP_READ
  1055. GROUP_EXECUTE
  1056. WORLD_READ
  1057. WORLD_EXECUTE
  1058. DESTINATION ${CMAKE_INSTALL_BINDIR})
  1059. install(
  1060. FILES convert-lora-to-ggml.py
  1061. PERMISSIONS
  1062. OWNER_READ
  1063. OWNER_WRITE
  1064. OWNER_EXECUTE
  1065. GROUP_READ
  1066. GROUP_EXECUTE
  1067. WORLD_READ
  1068. WORLD_EXECUTE
  1069. DESTINATION ${CMAKE_INSTALL_BINDIR})
  1070. if (LLAMA_METAL)
  1071. install(
  1072. FILES ggml-metal.metal
  1073. PERMISSIONS
  1074. OWNER_READ
  1075. OWNER_WRITE
  1076. GROUP_READ
  1077. WORLD_READ
  1078. DESTINATION ${CMAKE_INSTALL_BINDIR})
  1079. endif()
  1080. #
  1081. # programs, examples and tests
  1082. #
  1083. add_subdirectory(common)
  1084. if (LLAMA_BUILD_TESTS AND NOT CMAKE_JS_VERSION)
  1085. include(CTest)
  1086. add_subdirectory(tests)
  1087. endif ()
  1088. if (LLAMA_BUILD_EXAMPLES)
  1089. add_subdirectory(examples)
  1090. add_subdirectory(pocs)
  1091. endif()