CMakeLists.txt 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777
  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_HEADERS_METAL ggml-metal.h)
  145. set(GGML_SOURCES_METAL ggml-metal.m)
  146. add_compile_definitions(GGML_USE_METAL)
  147. if (LLAMA_METAL_NDEBUG)
  148. add_compile_definitions(GGML_METAL_NDEBUG)
  149. endif()
  150. # get full path to the file
  151. #add_compile_definitions(GGML_METAL_DIR_KERNELS="${CMAKE_CURRENT_SOURCE_DIR}/")
  152. # copy ggml-metal.metal to bin directory
  153. configure_file(ggml-metal.metal bin/ggml-metal.metal COPYONLY)
  154. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS}
  155. ${FOUNDATION_LIBRARY}
  156. ${METAL_FRAMEWORK}
  157. ${METALKIT_FRAMEWORK}
  158. )
  159. endif()
  160. if (LLAMA_BLAS)
  161. if (LLAMA_STATIC)
  162. set(BLA_STATIC ON)
  163. endif()
  164. if ($(CMAKE_VERSION) VERSION_GREATER_EQUAL 3.22)
  165. set(BLA_SIZEOF_INTEGER 8)
  166. endif()
  167. set(BLA_VENDOR ${LLAMA_BLAS_VENDOR})
  168. find_package(BLAS)
  169. if (BLAS_FOUND)
  170. message(STATUS "BLAS found, Libraries: ${BLAS_LIBRARIES}")
  171. if ("${BLAS_INCLUDE_DIRS}" STREQUAL "")
  172. # BLAS_INCLUDE_DIRS is missing in FindBLAS.cmake.
  173. # see https://gitlab.kitware.com/cmake/cmake/-/issues/20268
  174. find_package(PkgConfig REQUIRED)
  175. if (${LLAMA_BLAS_VENDOR} MATCHES "Generic")
  176. pkg_check_modules(DepBLAS REQUIRED blas)
  177. elseif (${LLAMA_BLAS_VENDOR} MATCHES "OpenBLAS")
  178. pkg_check_modules(DepBLAS REQUIRED openblas)
  179. elseif (${LLAMA_BLAS_VENDOR} MATCHES "FLAME")
  180. pkg_check_modules(DepBLAS REQUIRED blis)
  181. elseif (${LLAMA_BLAS_VENDOR} MATCHES "ATLAS")
  182. pkg_check_modules(DepBLAS REQUIRED blas-atlas)
  183. elseif (${LLAMA_BLAS_VENDOR} MATCHES "FlexiBLAS")
  184. pkg_check_modules(DepBLAS REQUIRED flexiblas_api)
  185. elseif (${LLAMA_BLAS_VENDOR} MATCHES "Intel")
  186. # all Intel* libraries share the same include path
  187. pkg_check_modules(DepBLAS REQUIRED mkl-sdl)
  188. elseif (${LLAMA_BLAS_VENDOR} MATCHES "NVHPC")
  189. # this doesn't provide pkg-config
  190. # suggest to assign BLAS_INCLUDE_DIRS on your own
  191. if ("${NVHPC_VERSION}" STREQUAL "")
  192. message(WARNING "Better to set NVHPC_VERSION")
  193. else()
  194. set(DepBLAS_FOUND ON)
  195. set(DepBLAS_INCLUDE_DIRS "/opt/nvidia/hpc_sdk/${CMAKE_SYSTEM_NAME}_${CMAKE_SYSTEM_PROCESSOR}/${NVHPC_VERSION}/math_libs/include")
  196. endif()
  197. endif()
  198. if (DepBLAS_FOUND)
  199. set(BLAS_INCLUDE_DIRS ${DepBLAS_INCLUDE_DIRS})
  200. else()
  201. message(WARNING "BLAS_INCLUDE_DIRS neither been provided nor been automatically"
  202. " detected by pkgconfig, trying to find cblas.h from possible paths...")
  203. find_path(BLAS_INCLUDE_DIRS
  204. NAMES cblas.h
  205. HINTS
  206. /usr/include
  207. /usr/local/include
  208. /usr/include/openblas
  209. /opt/homebrew/opt/openblas/include
  210. /usr/local/opt/openblas/include
  211. /usr/include/x86_64-linux-gnu/openblas/include
  212. )
  213. endif()
  214. endif()
  215. message(STATUS "BLAS found, Includes: ${BLAS_INCLUDE_DIRS}")
  216. add_compile_options(${BLAS_LINKER_FLAGS})
  217. add_compile_definitions(GGML_USE_OPENBLAS)
  218. if (${BLAS_INCLUDE_DIRS} MATCHES "mkl" AND (${LLAMA_BLAS_VENDOR} MATCHES "Generic" OR ${LLAMA_BLAS_VENDOR} MATCHES "Intel"))
  219. add_compile_definitions(GGML_BLAS_USE_MKL)
  220. endif()
  221. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${BLAS_LIBRARIES})
  222. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${BLAS_INCLUDE_DIRS})
  223. else()
  224. message(WARNING "BLAS not found, please refer to "
  225. "https://cmake.org/cmake/help/latest/module/FindBLAS.html#blas-lapack-vendors"
  226. " to set correct LLAMA_BLAS_VENDOR")
  227. endif()
  228. endif()
  229. if (LLAMA_K_QUANTS)
  230. set(GGML_HEADERS_EXTRA k_quants.h)
  231. set(GGML_SOURCES_EXTRA k_quants.c)
  232. add_compile_definitions(GGML_USE_K_QUANTS)
  233. if (LLAMA_QKK_64)
  234. add_compile_definitions(GGML_QKK_64)
  235. endif()
  236. endif()
  237. if (LLAMA_CUBLAS)
  238. cmake_minimum_required(VERSION 3.17)
  239. find_package(CUDAToolkit)
  240. if (CUDAToolkit_FOUND)
  241. message(STATUS "cuBLAS found")
  242. enable_language(CUDA)
  243. set(GGML_HEADERS_CUDA ggml-cuda.h)
  244. set(GGML_SOURCES_CUDA ggml-cuda.cu)
  245. add_compile_definitions(GGML_USE_CUBLAS)
  246. # if (LLAMA_CUDA_CUBLAS)
  247. # add_compile_definitions(GGML_CUDA_CUBLAS)
  248. # endif()
  249. if (LLAMA_CUDA_FORCE_DMMV)
  250. add_compile_definitions(GGML_CUDA_FORCE_DMMV)
  251. endif()
  252. add_compile_definitions(GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  253. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  254. if (DEFINED LLAMA_CUDA_DMMV_Y)
  255. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_DMMV_Y}) # for backwards compatibility
  256. endif()
  257. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  258. add_compile_definitions(GGML_CUDA_F16)
  259. endif()
  260. add_compile_definitions(K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  261. if (LLAMA_STATIC)
  262. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart_static CUDA::cublas_static CUDA::cublasLt_static)
  263. else()
  264. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart CUDA::cublas CUDA::cublasLt)
  265. endif()
  266. if (NOT DEFINED CMAKE_CUDA_ARCHITECTURES)
  267. # 52 == lowest CUDA 12 standard
  268. # 60 == f16 CUDA intrinsics
  269. # 61 == integer CUDA intrinsics
  270. # 70 == compute capability at which unrolling a loop in mul_mat_q kernels is faster
  271. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  272. set(CMAKE_CUDA_ARCHITECTURES "60;61;70") # needed for f16 CUDA intrinsics
  273. else()
  274. set(CMAKE_CUDA_ARCHITECTURES "52;61;70") # lowest CUDA 12 standard + lowest for integer intrinsics
  275. endif()
  276. endif()
  277. message(STATUS "Using CUDA architectures: ${CMAKE_CUDA_ARCHITECTURES}")
  278. else()
  279. message(WARNING "cuBLAS not found")
  280. endif()
  281. endif()
  282. if (LLAMA_MPI)
  283. cmake_minimum_required(VERSION 3.10)
  284. find_package(MPI)
  285. if (MPI_C_FOUND)
  286. message(STATUS "MPI found")
  287. set(GGML_HEADERS_MPI ggml-mpi.h)
  288. set(GGML_SOURCES_MPI ggml-mpi.c ggml-mpi.h)
  289. add_compile_definitions(GGML_USE_MPI)
  290. add_compile_definitions(${MPI_C_COMPILE_DEFINITIONS})
  291. set(cxx_flags ${cxx_flags} -Wno-cast-qual)
  292. set(c_flags ${c_flags} -Wno-cast-qual)
  293. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_C_LIBRARIES})
  294. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${MPI_C_INCLUDE_DIRS})
  295. # Even if you're only using the C header, C++ programs may bring in MPI
  296. # C++ functions, so more linkage is needed
  297. if (MPI_CXX_FOUND)
  298. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_CXX_LIBRARIES})
  299. endif()
  300. else()
  301. message(WARNING "MPI not found")
  302. endif()
  303. endif()
  304. if (LLAMA_CLBLAST)
  305. find_package(CLBlast)
  306. if (CLBlast_FOUND)
  307. message(STATUS "CLBlast found")
  308. set(GGML_HEADERS_OPENCL ggml-opencl.h)
  309. set(GGML_SOURCES_OPENCL ggml-opencl.cpp)
  310. add_compile_definitions(GGML_USE_CLBLAST)
  311. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} clblast)
  312. else()
  313. message(WARNING "CLBlast not found")
  314. endif()
  315. endif()
  316. if (LLAMA_HIPBLAS)
  317. list(APPEND CMAKE_PREFIX_PATH /opt/rocm)
  318. if (NOT ${CMAKE_C_COMPILER_ID} MATCHES "Clang")
  319. message(WARNING "Only LLVM is supported for HIP, hint: CC=/opt/rocm/llvm/bin/clang")
  320. endif()
  321. if (NOT ${CMAKE_CXX_COMPILER_ID} MATCHES "Clang")
  322. message(WARNING "Only LLVM is supported for HIP, hint: CXX=/opt/rocm/llvm/bin/clang++")
  323. endif()
  324. find_package(hip)
  325. find_package(hipblas)
  326. find_package(rocblas)
  327. if (${hipblas_FOUND} AND ${hip_FOUND})
  328. message(STATUS "HIP and hipBLAS found")
  329. add_compile_definitions(GGML_USE_HIPBLAS GGML_USE_CUBLAS)
  330. add_library(ggml-rocm OBJECT ggml-cuda.cu ggml-cuda.h)
  331. if (BUILD_SHARED_LIBS)
  332. set_target_properties(ggml-rocm PROPERTIES POSITION_INDEPENDENT_CODE ON)
  333. endif()
  334. if (LLAMA_CUDA_FORCE_DMMV)
  335. target_compile_definitions(ggml-rocm PRIVATE GGML_CUDA_FORCE_DMMV)
  336. endif()
  337. target_compile_definitions(ggml-rocm PRIVATE GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  338. target_compile_definitions(ggml-rocm PRIVATE GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  339. target_compile_definitions(ggml-rocm PRIVATE K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  340. set_source_files_properties(ggml-cuda.cu PROPERTIES LANGUAGE CXX)
  341. target_link_libraries(ggml-rocm PRIVATE hip::device PUBLIC hip::host roc::rocblas roc::hipblas)
  342. if (LLAMA_STATIC)
  343. message(FATAL_ERROR "Static linking not supported for HIP/ROCm")
  344. endif()
  345. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ggml-rocm)
  346. else()
  347. message(WARNING "hipBLAS or HIP not found. Try setting CMAKE_PREFIX_PATH=/opt/rocm")
  348. endif()
  349. endif()
  350. if (LLAMA_ALL_WARNINGS)
  351. if (NOT MSVC)
  352. set(c_flags
  353. -Wall
  354. -Wextra
  355. -Wpedantic
  356. -Wcast-qual
  357. -Wdouble-promotion
  358. -Wshadow
  359. -Wstrict-prototypes
  360. -Wpointer-arith
  361. -Wmissing-prototypes
  362. -Werror=implicit-int
  363. -Wno-unused-function
  364. )
  365. set(cxx_flags
  366. -Wall
  367. -Wextra
  368. -Wpedantic
  369. -Wcast-qual
  370. -Wmissing-declarations
  371. -Wno-unused-function
  372. -Wno-multichar
  373. )
  374. if (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
  375. # g++ only
  376. set(cxx_flags ${cxx_flags} -Wno-format-truncation -Wno-array-bounds)
  377. endif()
  378. else()
  379. # todo : msvc
  380. endif()
  381. add_compile_options(
  382. "$<$<COMPILE_LANGUAGE:C>:${c_flags}>"
  383. "$<$<COMPILE_LANGUAGE:CXX>:${cxx_flags}>"
  384. )
  385. endif()
  386. if (WIN32)
  387. add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
  388. if (BUILD_SHARED_LIBS)
  389. set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
  390. endif()
  391. endif()
  392. if (LLAMA_LTO)
  393. include(CheckIPOSupported)
  394. check_ipo_supported(RESULT result OUTPUT output)
  395. if (result)
  396. set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE)
  397. else()
  398. message(WARNING "IPO is not supported: ${output}")
  399. endif()
  400. endif()
  401. # Architecture specific
  402. # TODO: probably these flags need to be tweaked on some architectures
  403. # feel free to update the Makefile for your architecture and send a pull request or issue
  404. message(STATUS "CMAKE_SYSTEM_PROCESSOR: ${CMAKE_SYSTEM_PROCESSOR}")
  405. if (MSVC)
  406. string(TOLOWER "${CMAKE_GENERATOR_PLATFORM}" CMAKE_GENERATOR_PLATFORM_LWR)
  407. message(STATUS "CMAKE_GENERATOR_PLATFORM: ${CMAKE_GENERATOR_PLATFORM}")
  408. else ()
  409. set(CMAKE_GENERATOR_PLATFORM_LWR "")
  410. endif ()
  411. if (NOT MSVC)
  412. if (LLAMA_STATIC)
  413. add_link_options(-static)
  414. if (MINGW)
  415. add_link_options(-static-libgcc -static-libstdc++)
  416. endif()
  417. endif()
  418. if (LLAMA_GPROF)
  419. add_compile_options(-pg)
  420. endif()
  421. if (LLAMA_NATIVE)
  422. add_compile_options(-march=native)
  423. endif()
  424. endif()
  425. if ((${CMAKE_SYSTEM_PROCESSOR} MATCHES "arm") OR (${CMAKE_SYSTEM_PROCESSOR} MATCHES "aarch64") OR ("${CMAKE_GENERATOR_PLATFORM_LWR}" MATCHES "arm64"))
  426. message(STATUS "ARM detected")
  427. if (MSVC)
  428. add_compile_definitions(__ARM_NEON)
  429. add_compile_definitions(__ARM_FEATURE_FMA)
  430. add_compile_definitions(__ARM_FEATURE_DOTPROD)
  431. # add_compile_definitions(__ARM_FEATURE_FP16_VECTOR_ARITHMETIC) # MSVC doesn't support vdupq_n_f16, vld1q_f16, vst1q_f16
  432. add_compile_definitions(__aarch64__) # MSVC defines _M_ARM64 instead
  433. else()
  434. check_cxx_compiler_flag(-mfp16-format=ieee COMPILER_SUPPORTS_FP16_FORMAT_I3E)
  435. if (NOT "${COMPILER_SUPPORTS_FP16_FORMAT_I3E}" STREQUAL "")
  436. add_compile_options(-mfp16-format=ieee)
  437. endif()
  438. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv6")
  439. # Raspberry Pi 1, Zero
  440. add_compile_options(-mfpu=neon-fp-armv8 -mno-unaligned-access)
  441. endif()
  442. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv7")
  443. # Raspberry Pi 2
  444. add_compile_options(-mfpu=neon-fp-armv8 -mno-unaligned-access -funsafe-math-optimizations)
  445. endif()
  446. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv8")
  447. # Raspberry Pi 3, 4, Zero 2 (32-bit)
  448. add_compile_options(-mno-unaligned-access)
  449. endif()
  450. endif()
  451. elseif (${CMAKE_SYSTEM_PROCESSOR} MATCHES "^(x86_64|i686|AMD64)$" OR "${CMAKE_GENERATOR_PLATFORM_LWR}" MATCHES "^(x86_64|i686|amd64|x64)$" )
  452. message(STATUS "x86 detected")
  453. if (MSVC)
  454. if (LLAMA_AVX512)
  455. add_compile_options($<$<COMPILE_LANGUAGE:C>:/arch:AVX512>)
  456. add_compile_options($<$<COMPILE_LANGUAGE:CXX>:/arch:AVX512>)
  457. # MSVC has no compile-time flags enabling specific
  458. # AVX512 extensions, neither it defines the
  459. # macros corresponding to the extensions.
  460. # Do it manually.
  461. if (LLAMA_AVX512_VBMI)
  462. add_compile_definitions($<$<COMPILE_LANGUAGE:C>:__AVX512VBMI__>)
  463. add_compile_definitions($<$<COMPILE_LANGUAGE:CXX>:__AVX512VBMI__>)
  464. endif()
  465. if (LLAMA_AVX512_VNNI)
  466. add_compile_definitions($<$<COMPILE_LANGUAGE:C>:__AVX512VNNI__>)
  467. add_compile_definitions($<$<COMPILE_LANGUAGE:CXX>:__AVX512VNNI__>)
  468. endif()
  469. elseif (LLAMA_AVX2)
  470. add_compile_options($<$<COMPILE_LANGUAGE:C>:/arch:AVX2>)
  471. add_compile_options($<$<COMPILE_LANGUAGE:CXX>:/arch:AVX2>)
  472. elseif (LLAMA_AVX)
  473. add_compile_options($<$<COMPILE_LANGUAGE:C>:/arch:AVX>)
  474. add_compile_options($<$<COMPILE_LANGUAGE:CXX>:/arch:AVX>)
  475. endif()
  476. else()
  477. if (LLAMA_F16C)
  478. add_compile_options(-mf16c)
  479. endif()
  480. if (LLAMA_FMA)
  481. add_compile_options(-mfma)
  482. endif()
  483. if (LLAMA_AVX)
  484. add_compile_options(-mavx)
  485. endif()
  486. if (LLAMA_AVX2)
  487. add_compile_options(-mavx2)
  488. endif()
  489. if (LLAMA_AVX512)
  490. add_compile_options(-mavx512f)
  491. add_compile_options(-mavx512bw)
  492. endif()
  493. if (LLAMA_AVX512_VBMI)
  494. add_compile_options(-mavx512vbmi)
  495. endif()
  496. if (LLAMA_AVX512_VNNI)
  497. add_compile_options(-mavx512vnni)
  498. endif()
  499. endif()
  500. elseif (${CMAKE_SYSTEM_PROCESSOR} MATCHES "ppc64")
  501. message(STATUS "PowerPC detected")
  502. add_compile_options(-mcpu=native -mtune=native)
  503. #TODO: Add targets for Power8/Power9 (Altivec/VSX) and Power10(MMA) and query for big endian systems (ppc64/le/be)
  504. else()
  505. message(STATUS "Unknown architecture")
  506. endif()
  507. #
  508. # POSIX conformance
  509. #
  510. # clock_gettime came in POSIX.1b (1993)
  511. # CLOCK_MONOTONIC came in POSIX.1-2001 / SUSv3 as optional
  512. # posix_memalign came in POSIX.1-2001 / SUSv3
  513. # M_PI is an XSI extension since POSIX.1-2001 / SUSv3, came in XPG1 (1985)
  514. add_compile_definitions(_XOPEN_SOURCE=600)
  515. # Somehow in OpenBSD whenever POSIX conformance is specified
  516. # some string functions rely on locale_t availability,
  517. # which was introduced in POSIX.1-2008, forcing us to go higher
  518. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  519. remove_definitions(-D_XOPEN_SOURCE=600)
  520. add_compile_definitions(_XOPEN_SOURCE=700)
  521. endif()
  522. # Data types, macros and functions related to controlling CPU affinity and
  523. # some memory allocation are available on Linux through GNU extensions in libc
  524. if (CMAKE_SYSTEM_NAME MATCHES "Linux")
  525. add_compile_definitions(_GNU_SOURCE)
  526. endif()
  527. # RLIMIT_MEMLOCK came in BSD, is not specified in POSIX.1,
  528. # and on macOS its availability depends on enabling Darwin extensions
  529. # similarly on DragonFly, enabling BSD extensions is necessary
  530. if (
  531. CMAKE_SYSTEM_NAME MATCHES "Darwin" OR
  532. CMAKE_SYSTEM_NAME MATCHES "iOS" OR
  533. CMAKE_SYSTEM_NAME MATCHES "tvOS" OR
  534. CMAKE_SYSTEM_NAME MATCHES "DragonFly"
  535. )
  536. add_compile_definitions(_DARWIN_C_SOURCE)
  537. endif()
  538. # alloca is a non-standard interface that is not visible on BSDs when
  539. # POSIX conformance is specified, but not all of them provide a clean way
  540. # to enable it in such cases
  541. if (CMAKE_SYSTEM_NAME MATCHES "FreeBSD")
  542. add_compile_definitions(__BSD_VISIBLE)
  543. endif()
  544. if (CMAKE_SYSTEM_NAME MATCHES "NetBSD")
  545. add_compile_definitions(_NETBSD_SOURCE)
  546. endif()
  547. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  548. add_compile_definitions(_BSD_SOURCE)
  549. endif()
  550. #
  551. # libraries
  552. #
  553. # ggml
  554. if (GGML_USE_CPU_HBM)
  555. add_definitions(-DGGML_USE_CPU_HBM)
  556. find_library(memkind memkind REQUIRED)
  557. endif()
  558. add_library(ggml OBJECT
  559. ggml.c
  560. ggml.h
  561. ggml-alloc.c
  562. ggml-alloc.h
  563. ${GGML_SOURCES_CUDA} ${GGML_HEADERS_CUDA}
  564. ${GGML_SOURCES_OPENCL} ${GGML_HEADERS_OPENCL}
  565. ${GGML_SOURCES_METAL} ${GGML_HEADERS_METAL}
  566. ${GGML_SOURCES_MPI} ${GGML_HEADERS_MPI}
  567. ${GGML_SOURCES_EXTRA} ${GGML_HEADERS_EXTRA}
  568. )
  569. target_include_directories(ggml PUBLIC . ${LLAMA_EXTRA_INCLUDES})
  570. target_compile_features(ggml PUBLIC c_std_11) # don't bump
  571. target_link_libraries(ggml PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  572. if (GGML_USE_CPU_HBM)
  573. target_link_libraries(ggml PUBLIC memkind)
  574. endif()
  575. add_library(ggml_static STATIC $<TARGET_OBJECTS:ggml>)
  576. if (BUILD_SHARED_LIBS)
  577. set_target_properties(ggml PROPERTIES POSITION_INDEPENDENT_CODE ON)
  578. add_library(ggml_shared SHARED $<TARGET_OBJECTS:ggml>)
  579. target_link_libraries(ggml_shared PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  580. install(TARGETS ggml_shared LIBRARY)
  581. endif()
  582. # llama
  583. add_library(llama
  584. llama.cpp
  585. llama.h
  586. )
  587. target_include_directories(llama PUBLIC .)
  588. target_compile_features(llama PUBLIC cxx_std_11) # don't bump
  589. target_link_libraries(llama PRIVATE
  590. ggml
  591. ${LLAMA_EXTRA_LIBS}
  592. )
  593. if (BUILD_SHARED_LIBS)
  594. set_target_properties(llama PROPERTIES POSITION_INDEPENDENT_CODE ON)
  595. target_compile_definitions(llama PRIVATE LLAMA_SHARED LLAMA_BUILD)
  596. if (LLAMA_METAL)
  597. set_target_properties(llama PROPERTIES RESOURCE "${CMAKE_CURRENT_SOURCE_DIR}/ggml-metal.metal")
  598. endif()
  599. endif()
  600. #
  601. # install
  602. #
  603. include(GNUInstallDirs)
  604. include(CMakePackageConfigHelpers)
  605. set(LLAMA_INCLUDE_INSTALL_DIR ${CMAKE_INSTALL_INCLUDEDIR}
  606. CACHE PATH "Location of header files")
  607. set(LLAMA_LIB_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR}
  608. CACHE PATH "Location of library files")
  609. set(LLAMA_BIN_INSTALL_DIR ${CMAKE_INSTALL_BINDIR}
  610. CACHE PATH "Location of binary files")
  611. set(LLAMA_BUILD_NUMBER ${BUILD_NUMBER})
  612. set(LLAMA_BUILD_COMMIT ${BUILD_COMMIT})
  613. set(LLAMA_INSTALL_VERSION 0.0.${BUILD_NUMBER})
  614. configure_package_config_file(
  615. ${CMAKE_CURRENT_SOURCE_DIR}/scripts/LlamaConfig.cmake.in
  616. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfig.cmake
  617. INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Llama
  618. PATH_VARS LLAMA_INCLUDE_INSTALL_DIR
  619. LLAMA_LIB_INSTALL_DIR
  620. LLAMA_BIN_INSTALL_DIR )
  621. write_basic_package_version_file(
  622. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfigVersion.cmake
  623. VERSION ${LLAMA_INSTALL_VERSION}
  624. COMPATIBILITY SameMajorVersion)
  625. install(FILES ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfig.cmake
  626. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfigVersion.cmake
  627. DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Llama)
  628. set(GGML_PUBLIC_HEADERS "ggml.h"
  629. "${GGML_HEADERS_CUDA}" "${GGML_HEADERS_OPENCL}"
  630. "${GGML_HEADERS_METAL}" "${GGML_HEADERS_MPI}" "${GGML_HEADERS_EXTRA}")
  631. set_target_properties(ggml PROPERTIES PUBLIC_HEADER "${GGML_PUBLIC_HEADERS}")
  632. install(TARGETS ggml PUBLIC_HEADER)
  633. set_target_properties(llama PROPERTIES PUBLIC_HEADER ${CMAKE_CURRENT_SOURCE_DIR}/llama.h)
  634. install(TARGETS llama LIBRARY PUBLIC_HEADER)
  635. install(
  636. FILES convert.py
  637. PERMISSIONS
  638. OWNER_READ
  639. OWNER_WRITE
  640. OWNER_EXECUTE
  641. GROUP_READ
  642. GROUP_EXECUTE
  643. WORLD_READ
  644. WORLD_EXECUTE
  645. DESTINATION ${CMAKE_INSTALL_BINDIR})
  646. install(
  647. FILES convert-lora-to-ggml.py
  648. PERMISSIONS
  649. OWNER_READ
  650. OWNER_WRITE
  651. OWNER_EXECUTE
  652. GROUP_READ
  653. GROUP_EXECUTE
  654. WORLD_READ
  655. WORLD_EXECUTE
  656. DESTINATION ${CMAKE_INSTALL_BINDIR})
  657. if (LLAMA_METAL)
  658. install(
  659. FILES ggml-metal.metal
  660. PERMISSIONS
  661. OWNER_READ
  662. OWNER_WRITE
  663. GROUP_READ
  664. WORLD_READ
  665. DESTINATION ${CMAKE_INSTALL_BINDIR})
  666. endif()
  667. #
  668. # programs, examples and tests
  669. #
  670. add_subdirectory(common)
  671. if (LLAMA_BUILD_TESTS AND NOT CMAKE_JS_VERSION)
  672. include(CTest)
  673. add_subdirectory(tests)
  674. endif ()
  675. if (LLAMA_BUILD_EXAMPLES)
  676. add_subdirectory(examples)
  677. add_subdirectory(pocs)
  678. endif()