CMakeLists.txt 30 KB

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