CMakeLists.txt 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731
  1. cmake_minimum_required(VERSION 3.12) # Don't bump this version for no reason
  2. project("llama.cpp" C CXX)
  3. set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
  4. if (NOT XCODE AND NOT MSVC AND NOT CMAKE_BUILD_TYPE)
  5. set(CMAKE_BUILD_TYPE Release CACHE STRING "Build type" FORCE)
  6. set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
  7. endif()
  8. set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
  9. if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
  10. set(LLAMA_STANDALONE ON)
  11. # configure project version
  12. # TODO
  13. else()
  14. set(LLAMA_STANDALONE OFF)
  15. endif()
  16. if (EMSCRIPTEN)
  17. set(BUILD_SHARED_LIBS_DEFAULT OFF)
  18. option(LLAMA_WASM_SINGLE_FILE "llama: embed WASM inside the generated llama.js" ON)
  19. else()
  20. if (MINGW)
  21. set(BUILD_SHARED_LIBS_DEFAULT OFF)
  22. else()
  23. set(BUILD_SHARED_LIBS_DEFAULT ON)
  24. endif()
  25. endif()
  26. #
  27. # Option list
  28. #
  29. if (APPLE)
  30. set(LLAMA_METAL_DEFAULT ON)
  31. else()
  32. set(LLAMA_METAL_DEFAULT OFF)
  33. endif()
  34. # general
  35. option(LLAMA_STATIC "llama: static link libraries" OFF)
  36. option(LLAMA_NATIVE "llama: enable -march=native flag" OFF)
  37. option(LLAMA_LTO "llama: enable link time optimization" OFF)
  38. # debug
  39. option(LLAMA_ALL_WARNINGS "llama: enable all compiler warnings" ON)
  40. option(LLAMA_ALL_WARNINGS_3RD_PARTY "llama: enable all compiler warnings in 3rd party libs" OFF)
  41. option(LLAMA_GPROF "llama: enable gprof" OFF)
  42. # sanitizers
  43. option(LLAMA_SANITIZE_THREAD "llama: enable thread sanitizer" OFF)
  44. option(LLAMA_SANITIZE_ADDRESS "llama: enable address sanitizer" OFF)
  45. option(LLAMA_SANITIZE_UNDEFINED "llama: enable undefined sanitizer" OFF)
  46. # instruction set specific
  47. option(LLAMA_AVX "llama: enable AVX" ON)
  48. option(LLAMA_AVX2 "llama: enable AVX2" ON)
  49. option(LLAMA_AVX512 "llama: enable AVX512" OFF)
  50. option(LLAMA_AVX512_VBMI "llama: enable AVX512-VBMI" OFF)
  51. option(LLAMA_AVX512_VNNI "llama: enable AVX512-VNNI" OFF)
  52. option(LLAMA_FMA "llama: enable FMA" ON)
  53. # in MSVC F16C is implied with AVX2/AVX512
  54. if (NOT MSVC)
  55. option(LLAMA_F16C "llama: enable F16C" ON)
  56. endif()
  57. # 3rd party libs
  58. option(LLAMA_ACCELERATE "llama: enable Accelerate framework" ON)
  59. option(LLAMA_BLAS "llama: use BLAS" OFF)
  60. set(LLAMA_BLAS_VENDOR "Generic" CACHE STRING "llama: BLAS library vendor")
  61. option(LLAMA_CUBLAS "llama: use CUDA" OFF)
  62. #option(LLAMA_CUDA_CUBLAS "llama: use cuBLAS for prompt processing" OFF)
  63. option(LLAMA_CUDA_FORCE_DMMV "llama: use dmmv instead of mmvq CUDA kernels" OFF)
  64. set(LLAMA_CUDA_DMMV_X "32" CACHE STRING "llama: x stride for dmmv CUDA kernels")
  65. set(LLAMA_CUDA_MMV_Y "1" CACHE STRING "llama: y block size for mmv CUDA kernels")
  66. option(LLAMA_CUDA_F16 "llama: use 16 bit floats for some calculations" OFF)
  67. set(LLAMA_CUDA_KQUANTS_ITER "2" CACHE STRING "llama: iters./thread per block for Q2_K/Q6_K")
  68. option(LLAMA_HIPBLAS "llama: use hipBLAS" OFF)
  69. option(LLAMA_CLBLAST "llama: use CLBlast" OFF)
  70. option(LLAMA_METAL "llama: use Metal" ${LLAMA_METAL_DEFAULT})
  71. option(LLAMA_METAL_NDEBUG "llama: disable Metal debugging" OFF)
  72. option(LLAMA_MPI "llama: use MPI" OFF)
  73. option(LLAMA_K_QUANTS "llama: use k-quants" ON)
  74. option(LLAMA_QKK_64 "llama: use super-block size of 64 for k-quants" OFF)
  75. option(LLAMA_BUILD_TESTS "llama: build tests" ${LLAMA_STANDALONE})
  76. option(LLAMA_BUILD_EXAMPLES "llama: build examples" ${LLAMA_STANDALONE})
  77. option(LLAMA_BUILD_SERVER "llama: build server example" ON)
  78. #
  79. # Build info header
  80. #
  81. # Generate initial build-info.h
  82. include(${CMAKE_CURRENT_SOURCE_DIR}/scripts/build-info.cmake)
  83. if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/.git")
  84. set(GIT_DIR "${CMAKE_CURRENT_SOURCE_DIR}/.git")
  85. # Is git submodule
  86. if(NOT IS_DIRECTORY "${GIT_DIR}")
  87. file(READ ${GIT_DIR} REAL_GIT_DIR_LINK)
  88. string(REGEX REPLACE "gitdir: (.*)\n$" "\\1" REAL_GIT_DIR ${REAL_GIT_DIR_LINK})
  89. set(GIT_DIR "${CMAKE_CURRENT_SOURCE_DIR}/${REAL_GIT_DIR}")
  90. endif()
  91. # Add a custom target for build-info.h
  92. add_custom_target(BUILD_INFO ALL DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/build-info.h")
  93. # Add a custom command to rebuild build-info.h when .git/index changes
  94. add_custom_command(
  95. OUTPUT "${CMAKE_CURRENT_SOURCE_DIR}/build-info.h"
  96. COMMENT "Generating build details from Git"
  97. COMMAND ${CMAKE_COMMAND} -P "${CMAKE_CURRENT_SOURCE_DIR}/scripts/build-info.cmake"
  98. WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
  99. DEPENDS "${GIT_DIR}/index"
  100. VERBATIM
  101. )
  102. else()
  103. message(WARNING "Git repository not found; to enable automatic generation of build info, make sure Git is installed and the project is a Git repository.")
  104. endif()
  105. #
  106. # Compile flags
  107. #
  108. set(CMAKE_CXX_STANDARD 11)
  109. set(CMAKE_CXX_STANDARD_REQUIRED true)
  110. set(CMAKE_C_STANDARD 11)
  111. set(CMAKE_C_STANDARD_REQUIRED true)
  112. set(THREADS_PREFER_PTHREAD_FLAG ON)
  113. find_package(Threads REQUIRED)
  114. include(CheckCXXCompilerFlag)
  115. if (NOT MSVC)
  116. if (LLAMA_SANITIZE_THREAD)
  117. add_compile_options(-fsanitize=thread)
  118. link_libraries(-fsanitize=thread)
  119. endif()
  120. if (LLAMA_SANITIZE_ADDRESS)
  121. add_compile_options(-fsanitize=address -fno-omit-frame-pointer)
  122. link_libraries(-fsanitize=address)
  123. endif()
  124. if (LLAMA_SANITIZE_UNDEFINED)
  125. add_compile_options(-fsanitize=undefined)
  126. link_libraries(-fsanitize=undefined)
  127. endif()
  128. endif()
  129. if (APPLE AND LLAMA_ACCELERATE)
  130. find_library(ACCELERATE_FRAMEWORK Accelerate)
  131. if (ACCELERATE_FRAMEWORK)
  132. message(STATUS "Accelerate framework found")
  133. add_compile_definitions(GGML_USE_ACCELERATE)
  134. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${ACCELERATE_FRAMEWORK})
  135. else()
  136. message(WARNING "Accelerate framework not found")
  137. endif()
  138. endif()
  139. if (LLAMA_METAL)
  140. find_library(FOUNDATION_LIBRARY Foundation REQUIRED)
  141. find_library(METAL_FRAMEWORK Metal REQUIRED)
  142. find_library(METALKIT_FRAMEWORK MetalKit REQUIRED)
  143. message(STATUS "Metal framework found")
  144. set(GGML_SOURCES_METAL ggml-metal.m ggml-metal.h)
  145. add_compile_definitions(GGML_USE_METAL)
  146. if (LLAMA_METAL_NDEBUG)
  147. add_compile_definitions(GGML_METAL_NDEBUG)
  148. endif()
  149. # get full path to the file
  150. #add_compile_definitions(GGML_METAL_DIR_KERNELS="${CMAKE_CURRENT_SOURCE_DIR}/")
  151. # copy ggml-metal.metal to bin directory
  152. configure_file(ggml-metal.metal bin/ggml-metal.metal COPYONLY)
  153. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS}
  154. ${FOUNDATION_LIBRARY}
  155. ${METAL_FRAMEWORK}
  156. ${METALKIT_FRAMEWORK}
  157. )
  158. endif()
  159. if (LLAMA_BLAS)
  160. if (LLAMA_STATIC)
  161. set(BLA_STATIC ON)
  162. endif()
  163. if ($(CMAKE_VERSION) VERSION_GREATER_EQUAL 3.22)
  164. set(BLA_SIZEOF_INTEGER 8)
  165. endif()
  166. set(BLA_VENDOR ${LLAMA_BLAS_VENDOR})
  167. find_package(BLAS)
  168. if (BLAS_FOUND)
  169. message(STATUS "BLAS found, Libraries: ${BLAS_LIBRARIES}")
  170. if ("${BLAS_INCLUDE_DIRS}" STREQUAL "")
  171. # BLAS_INCLUDE_DIRS is missing in FindBLAS.cmake.
  172. # see https://gitlab.kitware.com/cmake/cmake/-/issues/20268
  173. find_package(PkgConfig REQUIRED)
  174. if (${LLAMA_BLAS_VENDOR} MATCHES "Generic")
  175. pkg_check_modules(DepBLAS REQUIRED blas)
  176. elseif (${LLAMA_BLAS_VENDOR} MATCHES "OpenBLAS")
  177. pkg_check_modules(DepBLAS REQUIRED openblas)
  178. elseif (${LLAMA_BLAS_VENDOR} MATCHES "FLAME")
  179. pkg_check_modules(DepBLAS REQUIRED blis)
  180. elseif (${LLAMA_BLAS_VENDOR} MATCHES "ATLAS")
  181. pkg_check_modules(DepBLAS REQUIRED blas-atlas)
  182. elseif (${LLAMA_BLAS_VENDOR} MATCHES "FlexiBLAS")
  183. pkg_check_modules(DepBLAS REQUIRED flexiblas_api)
  184. elseif (${LLAMA_BLAS_VENDOR} MATCHES "Intel")
  185. # all Intel* libraries share the same include path
  186. pkg_check_modules(DepBLAS REQUIRED mkl-sdl)
  187. elseif (${LLAMA_BLAS_VENDOR} MATCHES "NVHPC")
  188. # this doesn't provide pkg-config
  189. # suggest to assign BLAS_INCLUDE_DIRS on your own
  190. if ("${NVHPC_VERSION}" STREQUAL "")
  191. message(WARNING "Better to set NVHPC_VERSION")
  192. else()
  193. set(DepBLAS_FOUND ON)
  194. set(DepBLAS_INCLUDE_DIRS "/opt/nvidia/hpc_sdk/${CMAKE_SYSTEM_NAME}_${CMAKE_SYSTEM_PROCESSOR}/${NVHPC_VERSION}/math_libs/include")
  195. endif()
  196. endif()
  197. if (DepBLAS_FOUND)
  198. set(BLAS_INCLUDE_DIRS ${DepBLAS_INCLUDE_DIRS})
  199. else()
  200. message(WARNING "BLAS_INCLUDE_DIRS neither been provided nor been automatically"
  201. " detected by pkgconfig, trying to find cblas.h from possible paths...")
  202. find_path(BLAS_INCLUDE_DIRS
  203. NAMES cblas.h
  204. HINTS
  205. /usr/include
  206. /usr/local/include
  207. /usr/include/openblas
  208. /opt/homebrew/opt/openblas/include
  209. /usr/local/opt/openblas/include
  210. /usr/include/x86_64-linux-gnu/openblas/include
  211. )
  212. endif()
  213. endif()
  214. message(STATUS "BLAS found, Includes: ${BLAS_INCLUDE_DIRS}")
  215. add_compile_options(${BLAS_LINKER_FLAGS})
  216. add_compile_definitions(GGML_USE_OPENBLAS)
  217. if (${BLAS_INCLUDE_DIRS} MATCHES "mkl" AND (${LLAMA_BLAS_VENDOR} MATCHES "Generic" OR ${LLAMA_BLAS_VENDOR} MATCHES "Intel"))
  218. add_compile_definitions(GGML_BLAS_USE_MKL)
  219. endif()
  220. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${BLAS_LIBRARIES})
  221. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${BLAS_INCLUDE_DIRS})
  222. else()
  223. message(WARNING "BLAS not found, please refer to "
  224. "https://cmake.org/cmake/help/latest/module/FindBLAS.html#blas-lapack-vendors"
  225. " to set correct LLAMA_BLAS_VENDOR")
  226. endif()
  227. endif()
  228. if (LLAMA_K_QUANTS)
  229. set(GGML_SOURCES_EXTRA ${GGML_SOURCES_EXTRA} k_quants.c k_quants.h)
  230. add_compile_definitions(GGML_USE_K_QUANTS)
  231. if (LLAMA_QKK_64)
  232. add_compile_definitions(GGML_QKK_64)
  233. endif()
  234. endif()
  235. if (LLAMA_CUBLAS)
  236. cmake_minimum_required(VERSION 3.17)
  237. find_package(CUDAToolkit)
  238. if (CUDAToolkit_FOUND)
  239. message(STATUS "cuBLAS found")
  240. enable_language(CUDA)
  241. set(GGML_SOURCES_CUDA ggml-cuda.cu ggml-cuda.h)
  242. add_compile_definitions(GGML_USE_CUBLAS)
  243. # if (LLAMA_CUDA_CUBLAS)
  244. # add_compile_definitions(GGML_CUDA_CUBLAS)
  245. # endif()
  246. if (LLAMA_CUDA_FORCE_DMMV)
  247. add_compile_definitions(GGML_CUDA_FORCE_DMMV)
  248. endif()
  249. add_compile_definitions(GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  250. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  251. if (DEFINED LLAMA_CUDA_DMMV_Y)
  252. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_DMMV_Y}) # for backwards compatibility
  253. endif()
  254. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  255. add_compile_definitions(GGML_CUDA_F16)
  256. endif()
  257. add_compile_definitions(K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  258. if (LLAMA_STATIC)
  259. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart_static CUDA::cublas_static CUDA::cublasLt_static)
  260. else()
  261. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart CUDA::cublas CUDA::cublasLt)
  262. endif()
  263. if (NOT DEFINED CMAKE_CUDA_ARCHITECTURES)
  264. # 52 == lowest CUDA 12 standard
  265. # 60 == f16 CUDA intrinsics
  266. # 61 == integer CUDA intrinsics
  267. # 70 == compute capability at which unrolling a loop in mul_mat_q kernels is faster
  268. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  269. set(CMAKE_CUDA_ARCHITECTURES "60;61;70") # needed for f16 CUDA intrinsics
  270. else()
  271. set(CMAKE_CUDA_ARCHITECTURES "52;61;70") # lowest CUDA 12 standard + lowest for integer intrinsics
  272. endif()
  273. endif()
  274. message(STATUS "Using CUDA architectures: ${CMAKE_CUDA_ARCHITECTURES}")
  275. else()
  276. message(WARNING "cuBLAS not found")
  277. endif()
  278. endif()
  279. if (LLAMA_MPI)
  280. cmake_minimum_required(VERSION 3.10)
  281. find_package(MPI)
  282. if (MPI_C_FOUND)
  283. message(STATUS "MPI found")
  284. set(GGML_SOURCES_MPI ggml-mpi.c ggml-mpi.h)
  285. add_compile_definitions(GGML_USE_MPI)
  286. add_compile_definitions(${MPI_C_COMPILE_DEFINITIONS})
  287. set(cxx_flags ${cxx_flags} -Wno-cast-qual)
  288. set(c_flags ${c_flags} -Wno-cast-qual)
  289. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_C_LIBRARIES})
  290. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${MPI_C_INCLUDE_DIRS})
  291. # Even if you're only using the C header, C++ programs may bring in MPI
  292. # C++ functions, so more linkage is needed
  293. if (MPI_CXX_FOUND)
  294. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_CXX_LIBRARIES})
  295. endif()
  296. else()
  297. message(WARNING "MPI not found")
  298. endif()
  299. endif()
  300. if (LLAMA_CLBLAST)
  301. find_package(CLBlast)
  302. if (CLBlast_FOUND)
  303. message(STATUS "CLBlast found")
  304. set(GGML_SOURCES_OPENCL ggml-opencl.cpp ggml-opencl.h)
  305. add_compile_definitions(GGML_USE_CLBLAST)
  306. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} clblast)
  307. else()
  308. message(WARNING "CLBlast not found")
  309. endif()
  310. endif()
  311. if (LLAMA_HIPBLAS)
  312. list(APPEND CMAKE_PREFIX_PATH /opt/rocm)
  313. if (NOT ${CMAKE_C_COMPILER_ID} MATCHES "Clang")
  314. message(WARNING "Only LLVM is supported for HIP, hint: CC=/opt/rocm/llvm/bin/clang")
  315. endif()
  316. if (NOT ${CMAKE_CXX_COMPILER_ID} MATCHES "Clang")
  317. message(WARNING "Only LLVM is supported for HIP, hint: CXX=/opt/rocm/llvm/bin/clang++")
  318. endif()
  319. find_package(hip)
  320. find_package(hipblas)
  321. find_package(rocblas)
  322. if (${hipblas_FOUND} AND ${hip_FOUND})
  323. message(STATUS "HIP and hipBLAS found")
  324. add_compile_definitions(GGML_USE_HIPBLAS GGML_USE_CUBLAS)
  325. add_library(ggml-rocm OBJECT ggml-cuda.cu ggml-cuda.h)
  326. if (LLAMA_CUDA_FORCE_DMMV)
  327. target_compile_definitions(ggml-rocm PRIVATE GGML_CUDA_FORCE_DMMV)
  328. endif()
  329. target_compile_definitions(ggml-rocm PRIVATE GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  330. target_compile_definitions(ggml-rocm PRIVATE GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  331. target_compile_definitions(ggml-rocm PRIVATE K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  332. set_source_files_properties(ggml-cuda.cu PROPERTIES LANGUAGE CXX)
  333. target_link_libraries(ggml-rocm PRIVATE hip::device PUBLIC hip::host roc::rocblas roc::hipblas)
  334. if (LLAMA_STATIC)
  335. message(FATAL_ERROR "Static linking not supported for HIP/ROCm")
  336. endif()
  337. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ggml-rocm)
  338. else()
  339. message(WARNING "hipBLAS or HIP not found. Try setting CMAKE_PREFIX_PATH=/opt/rocm")
  340. endif()
  341. endif()
  342. if (LLAMA_ALL_WARNINGS)
  343. if (NOT MSVC)
  344. set(c_flags
  345. -Wall
  346. -Wextra
  347. -Wpedantic
  348. -Wcast-qual
  349. -Wdouble-promotion
  350. -Wshadow
  351. -Wstrict-prototypes
  352. -Wpointer-arith
  353. -Wmissing-prototypes
  354. -Werror=implicit-int
  355. -Wno-unused-function
  356. )
  357. set(cxx_flags
  358. -Wall
  359. -Wextra
  360. -Wpedantic
  361. -Wcast-qual
  362. -Wno-unused-function
  363. -Wno-multichar
  364. )
  365. if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
  366. # g++ only
  367. set(cxx_flags ${cxx_flags} -Wno-format-truncation -Wno-array-bounds)
  368. endif()
  369. else()
  370. # todo : msvc
  371. endif()
  372. add_compile_options(
  373. "$<$<COMPILE_LANGUAGE:C>:${c_flags}>"
  374. "$<$<COMPILE_LANGUAGE:CXX>:${cxx_flags}>"
  375. )
  376. endif()
  377. if (MSVC)
  378. add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
  379. if (BUILD_SHARED_LIBS)
  380. set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
  381. endif()
  382. endif()
  383. if (LLAMA_LTO)
  384. include(CheckIPOSupported)
  385. check_ipo_supported(RESULT result OUTPUT output)
  386. if (result)
  387. set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE)
  388. else()
  389. message(WARNING "IPO is not supported: ${output}")
  390. endif()
  391. endif()
  392. # Architecture specific
  393. # TODO: probably these flags need to be tweaked on some architectures
  394. # feel free to update the Makefile for your architecture and send a pull request or issue
  395. message(STATUS "CMAKE_SYSTEM_PROCESSOR: ${CMAKE_SYSTEM_PROCESSOR}")
  396. if (MSVC)
  397. string(TOLOWER "${CMAKE_GENERATOR_PLATFORM}" CMAKE_GENERATOR_PLATFORM_LWR)
  398. message(STATUS "CMAKE_GENERATOR_PLATFORM: ${CMAKE_GENERATOR_PLATFORM}")
  399. else ()
  400. set(CMAKE_GENERATOR_PLATFORM_LWR "")
  401. endif ()
  402. if (NOT MSVC)
  403. if (LLAMA_STATIC)
  404. add_link_options(-static)
  405. if (MINGW)
  406. add_link_options(-static-libgcc -static-libstdc++)
  407. endif()
  408. endif()
  409. if (LLAMA_GPROF)
  410. add_compile_options(-pg)
  411. endif()
  412. if (LLAMA_NATIVE)
  413. add_compile_options(-march=native)
  414. endif()
  415. endif()
  416. if ((${CMAKE_SYSTEM_PROCESSOR} MATCHES "arm") OR (${CMAKE_SYSTEM_PROCESSOR} MATCHES "aarch64") OR ("${CMAKE_GENERATOR_PLATFORM_LWR}" MATCHES "arm64"))
  417. message(STATUS "ARM detected")
  418. if (MSVC)
  419. add_compile_definitions(__ARM_NEON)
  420. add_compile_definitions(__ARM_FEATURE_FMA)
  421. add_compile_definitions(__ARM_FEATURE_DOTPROD)
  422. # add_compile_definitions(__ARM_FEATURE_FP16_VECTOR_ARITHMETIC) # MSVC doesn't support vdupq_n_f16, vld1q_f16, vst1q_f16
  423. add_compile_definitions(__aarch64__) # MSVC defines _M_ARM64 instead
  424. else()
  425. check_cxx_compiler_flag(-mfp16-format=ieee COMPILER_SUPPORTS_FP16_FORMAT_I3E)
  426. if (NOT "${COMPILER_SUPPORTS_FP16_FORMAT_I3E}" STREQUAL "")
  427. add_compile_options(-mfp16-format=ieee)
  428. endif()
  429. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv6")
  430. # Raspberry Pi 1, Zero
  431. add_compile_options(-mfpu=neon-fp-armv8 -mno-unaligned-access)
  432. endif()
  433. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv7")
  434. # Raspberry Pi 2
  435. add_compile_options(-mfpu=neon-fp-armv8 -mno-unaligned-access -funsafe-math-optimizations)
  436. endif()
  437. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv8")
  438. # Raspberry Pi 3, 4, Zero 2 (32-bit)
  439. add_compile_options(-mno-unaligned-access)
  440. endif()
  441. endif()
  442. elseif (${CMAKE_SYSTEM_PROCESSOR} MATCHES "^(x86_64|i686|AMD64)$" OR "${CMAKE_GENERATOR_PLATFORM_LWR}" MATCHES "^(x86_64|i686|amd64|x64)$" )
  443. message(STATUS "x86 detected")
  444. if (MSVC)
  445. if (LLAMA_AVX512)
  446. add_compile_options($<$<COMPILE_LANGUAGE:C>:/arch:AVX512>)
  447. add_compile_options($<$<COMPILE_LANGUAGE:CXX>:/arch:AVX512>)
  448. # MSVC has no compile-time flags enabling specific
  449. # AVX512 extensions, neither it defines the
  450. # macros corresponding to the extensions.
  451. # Do it manually.
  452. if (LLAMA_AVX512_VBMI)
  453. add_compile_definitions($<$<COMPILE_LANGUAGE:C>:__AVX512VBMI__>)
  454. add_compile_definitions($<$<COMPILE_LANGUAGE:CXX>:__AVX512VBMI__>)
  455. endif()
  456. if (LLAMA_AVX512_VNNI)
  457. add_compile_definitions($<$<COMPILE_LANGUAGE:C>:__AVX512VNNI__>)
  458. add_compile_definitions($<$<COMPILE_LANGUAGE:CXX>:__AVX512VNNI__>)
  459. endif()
  460. elseif (LLAMA_AVX2)
  461. add_compile_options($<$<COMPILE_LANGUAGE:C>:/arch:AVX2>)
  462. add_compile_options($<$<COMPILE_LANGUAGE:CXX>:/arch:AVX2>)
  463. elseif (LLAMA_AVX)
  464. add_compile_options($<$<COMPILE_LANGUAGE:C>:/arch:AVX>)
  465. add_compile_options($<$<COMPILE_LANGUAGE:CXX>:/arch:AVX>)
  466. endif()
  467. else()
  468. if (LLAMA_F16C)
  469. add_compile_options(-mf16c)
  470. endif()
  471. if (LLAMA_FMA)
  472. add_compile_options(-mfma)
  473. endif()
  474. if (LLAMA_AVX)
  475. add_compile_options(-mavx)
  476. endif()
  477. if (LLAMA_AVX2)
  478. add_compile_options(-mavx2)
  479. endif()
  480. if (LLAMA_AVX512)
  481. add_compile_options(-mavx512f)
  482. add_compile_options(-mavx512bw)
  483. endif()
  484. if (LLAMA_AVX512_VBMI)
  485. add_compile_options(-mavx512vbmi)
  486. endif()
  487. if (LLAMA_AVX512_VNNI)
  488. add_compile_options(-mavx512vnni)
  489. endif()
  490. endif()
  491. elseif (${CMAKE_SYSTEM_PROCESSOR} MATCHES "ppc64")
  492. message(STATUS "PowerPC detected")
  493. add_compile_options(-mcpu=native -mtune=native)
  494. #TODO: Add targets for Power8/Power9 (Altivec/VSX) and Power10(MMA) and query for big endian systems (ppc64/le/be)
  495. else()
  496. message(STATUS "Unknown architecture")
  497. endif()
  498. #
  499. # POSIX conformance
  500. #
  501. # clock_gettime came in POSIX.1b (1993)
  502. # CLOCK_MONOTONIC came in POSIX.1-2001 / SUSv3 as optional
  503. # posix_memalign came in POSIX.1-2001 / SUSv3
  504. # M_PI is an XSI extension since POSIX.1-2001 / SUSv3, came in XPG1 (1985)
  505. add_compile_definitions(_XOPEN_SOURCE=600)
  506. # Somehow in OpenBSD whenever POSIX conformance is specified
  507. # some string functions rely on locale_t availability,
  508. # which was introduced in POSIX.1-2008, forcing us to go higher
  509. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  510. remove_definitions(-D_XOPEN_SOURCE=600)
  511. add_compile_definitions(_XOPEN_SOURCE=700)
  512. endif()
  513. # Data types, macros and functions related to controlling CPU affinity and
  514. # some memory allocation are available on Linux through GNU extensions in libc
  515. if (CMAKE_SYSTEM_NAME MATCHES "Linux")
  516. add_compile_definitions(_GNU_SOURCE)
  517. endif()
  518. # RLIMIT_MEMLOCK came in BSD, is not specified in POSIX.1,
  519. # and on macOS its availability depends on enabling Darwin extensions
  520. # similarly on DragonFly, enabling BSD extensions is necessary
  521. if (
  522. CMAKE_SYSTEM_NAME MATCHES "Darwin" OR
  523. CMAKE_SYSTEM_NAME MATCHES "iOS" OR
  524. CMAKE_SYSTEM_NAME MATCHES "tvOS" OR
  525. CMAKE_SYSTEM_NAME MATCHES "DragonFly"
  526. )
  527. add_compile_definitions(_DARWIN_C_SOURCE)
  528. endif()
  529. # alloca is a non-standard interface that is not visible on BSDs when
  530. # POSIX conformance is specified, but not all of them provide a clean way
  531. # to enable it in such cases
  532. if (CMAKE_SYSTEM_NAME MATCHES "FreeBSD")
  533. add_compile_definitions(__BSD_VISIBLE)
  534. endif()
  535. if (CMAKE_SYSTEM_NAME MATCHES "NetBSD")
  536. add_compile_definitions(_NETBSD_SOURCE)
  537. endif()
  538. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  539. add_compile_definitions(_BSD_SOURCE)
  540. endif()
  541. #
  542. # libraries
  543. #
  544. # ggml
  545. if (GGML_USE_CPU_HBM)
  546. add_definitions(-DGGML_USE_CPU_HBM)
  547. find_library(memkind memkind REQUIRED)
  548. endif()
  549. add_library(ggml OBJECT
  550. ggml.c
  551. ggml.h
  552. ggml-alloc.c
  553. ggml-alloc.h
  554. ${GGML_SOURCES_CUDA}
  555. ${GGML_SOURCES_OPENCL}
  556. ${GGML_SOURCES_METAL}
  557. ${GGML_SOURCES_MPI}
  558. ${GGML_SOURCES_EXTRA}
  559. )
  560. target_include_directories(ggml PUBLIC . ${LLAMA_EXTRA_INCLUDES})
  561. target_compile_features(ggml PUBLIC c_std_11) # don't bump
  562. target_link_libraries(ggml PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  563. if (GGML_USE_CPU_HBM)
  564. target_link_libraries(ggml PUBLIC memkind)
  565. endif()
  566. add_library(ggml_static STATIC $<TARGET_OBJECTS:ggml>)
  567. if (BUILD_SHARED_LIBS)
  568. set_target_properties(ggml PROPERTIES POSITION_INDEPENDENT_CODE ON)
  569. add_library(ggml_shared SHARED $<TARGET_OBJECTS:ggml>)
  570. target_link_libraries(ggml_shared PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  571. install(TARGETS ggml_shared LIBRARY)
  572. endif()
  573. # llama
  574. add_library(llama
  575. llama.cpp
  576. llama.h
  577. )
  578. target_include_directories(llama PUBLIC .)
  579. target_compile_features(llama PUBLIC cxx_std_11) # don't bump
  580. target_link_libraries(llama PRIVATE
  581. ggml
  582. ${LLAMA_EXTRA_LIBS}
  583. )
  584. if (BUILD_SHARED_LIBS)
  585. set_target_properties(llama PROPERTIES POSITION_INDEPENDENT_CODE ON)
  586. target_compile_definitions(llama PRIVATE LLAMA_SHARED LLAMA_BUILD)
  587. if (LLAMA_METAL)
  588. set_target_properties(llama PROPERTIES RESOURCE "${CMAKE_CURRENT_SOURCE_DIR}/ggml-metal.metal")
  589. endif()
  590. install(TARGETS llama LIBRARY)
  591. endif()
  592. #
  593. # install
  594. #
  595. include(GNUInstallDirs)
  596. install(
  597. FILES convert.py
  598. PERMISSIONS
  599. OWNER_READ
  600. OWNER_WRITE
  601. OWNER_EXECUTE
  602. GROUP_READ
  603. GROUP_EXECUTE
  604. WORLD_READ
  605. WORLD_EXECUTE
  606. DESTINATION ${CMAKE_INSTALL_BINDIR})
  607. install(
  608. FILES convert-lora-to-ggml.py
  609. PERMISSIONS
  610. OWNER_READ
  611. OWNER_WRITE
  612. OWNER_EXECUTE
  613. GROUP_READ
  614. GROUP_EXECUTE
  615. WORLD_READ
  616. WORLD_EXECUTE
  617. DESTINATION ${CMAKE_INSTALL_BINDIR})
  618. if (LLAMA_METAL)
  619. install(
  620. FILES ggml-metal.metal
  621. PERMISSIONS
  622. OWNER_READ
  623. OWNER_WRITE
  624. GROUP_READ
  625. WORLD_READ
  626. DESTINATION ${CMAKE_INSTALL_BINDIR})
  627. endif()
  628. #
  629. # programs, examples and tests
  630. #
  631. add_subdirectory(common)
  632. if (LLAMA_BUILD_TESTS AND NOT CMAKE_JS_VERSION)
  633. include(CTest)
  634. add_subdirectory(tests)
  635. endif ()
  636. if (LLAMA_BUILD_EXAMPLES)
  637. add_subdirectory(examples)
  638. add_subdirectory(pocs)
  639. endif()