CMakeLists.txt 28 KB

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