CMakeLists.txt 47 KB

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