CMakeLists.txt 49 KB

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