CMakeLists.txt 46 KB

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