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