1
0

CMakeLists.txt 30 KB

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