CMakeLists.txt 29 KB

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