CMakeLists.txt 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809
  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. 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. # 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_QKK_64)
  239. add_compile_definitions(GGML_QKK_64)
  240. endif()
  241. if (LLAMA_CUBLAS)
  242. cmake_minimum_required(VERSION 3.17)
  243. find_package(CUDAToolkit)
  244. if (CUDAToolkit_FOUND)
  245. message(STATUS "cuBLAS found")
  246. enable_language(CUDA)
  247. set(GGML_HEADERS_CUDA ggml-cuda.h)
  248. set(GGML_SOURCES_CUDA ggml-cuda.cu)
  249. add_compile_definitions(GGML_USE_CUBLAS)
  250. # if (LLAMA_CUDA_CUBLAS)
  251. # add_compile_definitions(GGML_CUDA_CUBLAS)
  252. # endif()
  253. if (LLAMA_CUDA_FORCE_DMMV)
  254. add_compile_definitions(GGML_CUDA_FORCE_DMMV)
  255. endif()
  256. if (LLAMA_CUDA_FORCE_MMQ)
  257. add_compile_definitions(GGML_CUDA_FORCE_MMQ)
  258. endif()
  259. add_compile_definitions(GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  260. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  261. if (DEFINED LLAMA_CUDA_DMMV_Y)
  262. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_DMMV_Y}) # for backwards compatibility
  263. endif()
  264. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  265. add_compile_definitions(GGML_CUDA_F16)
  266. endif()
  267. add_compile_definitions(K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  268. add_compile_definitions(GGML_CUDA_PEER_MAX_BATCH_SIZE=${LLAMA_CUDA_PEER_MAX_BATCH_SIZE})
  269. if (LLAMA_STATIC)
  270. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart_static CUDA::cublas_static CUDA::cublasLt_static)
  271. else()
  272. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart CUDA::cublas CUDA::cublasLt)
  273. endif()
  274. if (NOT DEFINED CMAKE_CUDA_ARCHITECTURES)
  275. # 52 == lowest CUDA 12 standard
  276. # 60 == f16 CUDA intrinsics
  277. # 61 == integer CUDA intrinsics
  278. # 70 == compute capability at which unrolling a loop in mul_mat_q kernels is faster
  279. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  280. set(CMAKE_CUDA_ARCHITECTURES "60;61;70") # needed for f16 CUDA intrinsics
  281. else()
  282. set(CMAKE_CUDA_ARCHITECTURES "52;61;70") # lowest CUDA 12 standard + lowest for integer intrinsics
  283. #set(CMAKE_CUDA_ARCHITECTURES "") # use this to compile much faster, but only F16 models work
  284. endif()
  285. endif()
  286. message(STATUS "Using CUDA architectures: ${CMAKE_CUDA_ARCHITECTURES}")
  287. else()
  288. message(WARNING "cuBLAS not found")
  289. endif()
  290. endif()
  291. if (LLAMA_MPI)
  292. cmake_minimum_required(VERSION 3.10)
  293. find_package(MPI)
  294. if (MPI_C_FOUND)
  295. message(STATUS "MPI found")
  296. set(GGML_HEADERS_MPI ggml-mpi.h)
  297. set(GGML_SOURCES_MPI ggml-mpi.c ggml-mpi.h)
  298. add_compile_definitions(GGML_USE_MPI)
  299. add_compile_definitions(${MPI_C_COMPILE_DEFINITIONS})
  300. if (NOT MSVC)
  301. add_compile_options(-Wno-cast-qual)
  302. endif()
  303. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_C_LIBRARIES})
  304. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${MPI_C_INCLUDE_DIRS})
  305. # Even if you're only using the C header, C++ programs may bring in MPI
  306. # C++ functions, so more linkage is needed
  307. if (MPI_CXX_FOUND)
  308. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_CXX_LIBRARIES})
  309. endif()
  310. else()
  311. message(WARNING "MPI not found")
  312. endif()
  313. endif()
  314. if (LLAMA_CLBLAST)
  315. find_package(CLBlast)
  316. if (CLBlast_FOUND)
  317. message(STATUS "CLBlast found")
  318. set(GGML_HEADERS_OPENCL ggml-opencl.h)
  319. set(GGML_SOURCES_OPENCL ggml-opencl.cpp)
  320. add_compile_definitions(GGML_USE_CLBLAST)
  321. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} clblast)
  322. else()
  323. message(WARNING "CLBlast not found")
  324. endif()
  325. endif()
  326. if (LLAMA_HIPBLAS)
  327. list(APPEND CMAKE_PREFIX_PATH /opt/rocm)
  328. if (NOT ${CMAKE_C_COMPILER_ID} MATCHES "Clang")
  329. message(WARNING "Only LLVM is supported for HIP, hint: CC=/opt/rocm/llvm/bin/clang")
  330. endif()
  331. if (NOT ${CMAKE_CXX_COMPILER_ID} MATCHES "Clang")
  332. message(WARNING "Only LLVM is supported for HIP, hint: CXX=/opt/rocm/llvm/bin/clang++")
  333. endif()
  334. find_package(hip)
  335. find_package(hipblas)
  336. find_package(rocblas)
  337. if (${hipblas_FOUND} AND ${hip_FOUND})
  338. message(STATUS "HIP and hipBLAS found")
  339. add_compile_definitions(GGML_USE_HIPBLAS GGML_USE_CUBLAS)
  340. add_library(ggml-rocm OBJECT ggml-cuda.cu ggml-cuda.h)
  341. if (BUILD_SHARED_LIBS)
  342. set_target_properties(ggml-rocm PROPERTIES POSITION_INDEPENDENT_CODE ON)
  343. endif()
  344. if (LLAMA_CUDA_FORCE_DMMV)
  345. target_compile_definitions(ggml-rocm PRIVATE GGML_CUDA_FORCE_DMMV)
  346. endif()
  347. if (LLAMA_CUDA_FORCE_MMQ)
  348. target_compile_definitions(ggml-rocm PRIVATE GGML_CUDA_FORCE_MMQ)
  349. endif()
  350. target_compile_definitions(ggml-rocm PRIVATE GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  351. target_compile_definitions(ggml-rocm PRIVATE GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  352. target_compile_definitions(ggml-rocm PRIVATE K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  353. set_source_files_properties(ggml-cuda.cu PROPERTIES LANGUAGE CXX)
  354. target_link_libraries(ggml-rocm PRIVATE hip::device PUBLIC hip::host roc::rocblas roc::hipblas)
  355. if (LLAMA_STATIC)
  356. message(FATAL_ERROR "Static linking not supported for HIP/ROCm")
  357. endif()
  358. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ggml-rocm)
  359. else()
  360. message(WARNING "hipBLAS or HIP not found. Try setting CMAKE_PREFIX_PATH=/opt/rocm")
  361. endif()
  362. endif()
  363. if (LLAMA_ALL_WARNINGS)
  364. if (NOT MSVC)
  365. set(warning_flags -Wall -Wextra -Wpedantic -Wcast-qual -Wno-unused-function)
  366. set(c_flags -Wshadow -Wstrict-prototypes -Wpointer-arith -Wmissing-prototypes -Werror=implicit-int -Werror=implicit-function-declaration)
  367. set(cxx_flags -Wmissing-declarations -Wmissing-noreturn)
  368. set(host_cxx_flags "")
  369. if (CMAKE_C_COMPILER_ID MATCHES "Clang")
  370. set(warning_flags ${warning_flags} -Wunreachable-code-break -Wunreachable-code-return)
  371. set(host_cxx_flags ${host_cxx_flags} -Wmissing-prototypes -Wextra-semi)
  372. if (
  373. (CMAKE_C_COMPILER_ID STREQUAL "Clang" AND CMAKE_C_COMPILER_VERSION VERSION_GREATER_EQUAL 3.8.0) OR
  374. (CMAKE_C_COMPILER_ID STREQUAL "AppleClang" AND CMAKE_C_COMPILER_VERSION VERSION_GREATER_EQUAL 7.3.0)
  375. )
  376. set(c_flags ${c_flags} -Wdouble-promotion)
  377. endif()
  378. elseif (CMAKE_C_COMPILER_ID STREQUAL "GNU")
  379. set(c_flags ${c_flags} -Wdouble-promotion)
  380. set(host_cxx_flags ${host_cxx_flags} -Wno-array-bounds)
  381. if (CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 7.1.0)
  382. set(host_cxx_flags ${host_cxx_flags} -Wno-format-truncation)
  383. endif()
  384. if (CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 8.1.0)
  385. set(host_cxx_flags ${host_cxx_flags} -Wextra-semi)
  386. endif()
  387. endif()
  388. else()
  389. # todo : msvc
  390. endif()
  391. set(c_flags ${c_flags} ${warning_flags})
  392. set(cxx_flags ${cxx_flags} ${warning_flags})
  393. add_compile_options("$<$<COMPILE_LANGUAGE:C>:${c_flags}>"
  394. "$<$<COMPILE_LANGUAGE:CXX>:${cxx_flags}>"
  395. "$<$<COMPILE_LANGUAGE:CXX>:${host_cxx_flags}>")
  396. endif()
  397. if (NOT MSVC)
  398. set(cuda_flags -Wno-pedantic)
  399. endif()
  400. set(cuda_flags ${cxx_flags} -use_fast_math ${cuda_flags})
  401. list(JOIN host_cxx_flags " " cuda_host_flags) # pass host compiler flags as a single argument
  402. if (NOT cuda_host_flags STREQUAL "")
  403. set(cuda_flags ${cuda_flags} -Xcompiler ${cuda_host_flags})
  404. endif()
  405. add_compile_options("$<$<COMPILE_LANGUAGE:CUDA>:${cuda_flags}>")
  406. if (WIN32)
  407. add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
  408. if (BUILD_SHARED_LIBS)
  409. set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
  410. endif()
  411. endif()
  412. if (LLAMA_LTO)
  413. include(CheckIPOSupported)
  414. check_ipo_supported(RESULT result OUTPUT output)
  415. if (result)
  416. set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE)
  417. else()
  418. message(WARNING "IPO is not supported: ${output}")
  419. endif()
  420. endif()
  421. # Architecture specific
  422. # TODO: probably these flags need to be tweaked on some architectures
  423. # feel free to update the Makefile for your architecture and send a pull request or issue
  424. message(STATUS "CMAKE_SYSTEM_PROCESSOR: ${CMAKE_SYSTEM_PROCESSOR}")
  425. if (MSVC)
  426. string(TOLOWER "${CMAKE_GENERATOR_PLATFORM}" CMAKE_GENERATOR_PLATFORM_LWR)
  427. message(STATUS "CMAKE_GENERATOR_PLATFORM: ${CMAKE_GENERATOR_PLATFORM}")
  428. else ()
  429. set(CMAKE_GENERATOR_PLATFORM_LWR "")
  430. endif ()
  431. if (NOT MSVC)
  432. if (LLAMA_STATIC)
  433. add_link_options(-static)
  434. if (MINGW)
  435. add_link_options(-static-libgcc -static-libstdc++)
  436. endif()
  437. endif()
  438. if (LLAMA_GPROF)
  439. add_compile_options(-pg)
  440. endif()
  441. endif()
  442. if ((${CMAKE_SYSTEM_PROCESSOR} MATCHES "arm") OR (${CMAKE_SYSTEM_PROCESSOR} MATCHES "aarch64") OR ("${CMAKE_GENERATOR_PLATFORM_LWR}" MATCHES "arm64"))
  443. message(STATUS "ARM detected")
  444. if (MSVC)
  445. add_compile_definitions(__ARM_NEON)
  446. add_compile_definitions(__ARM_FEATURE_FMA)
  447. add_compile_definitions(__ARM_FEATURE_DOTPROD)
  448. # add_compile_definitions(__ARM_FEATURE_FP16_VECTOR_ARITHMETIC) # MSVC doesn't support vdupq_n_f16, vld1q_f16, vst1q_f16
  449. add_compile_definitions(__aarch64__) # MSVC defines _M_ARM64 instead
  450. else()
  451. check_cxx_compiler_flag(-mfp16-format=ieee COMPILER_SUPPORTS_FP16_FORMAT_I3E)
  452. if (NOT "${COMPILER_SUPPORTS_FP16_FORMAT_I3E}" STREQUAL "")
  453. add_compile_options(-mfp16-format=ieee)
  454. endif()
  455. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv6")
  456. # Raspberry Pi 1, Zero
  457. add_compile_options(-mfpu=neon-fp-armv8 -mno-unaligned-access)
  458. endif()
  459. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv7")
  460. # Raspberry Pi 2
  461. add_compile_options(-mfpu=neon-fp-armv8 -mno-unaligned-access -funsafe-math-optimizations)
  462. endif()
  463. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv8")
  464. # Raspberry Pi 3, 4, Zero 2 (32-bit)
  465. add_compile_options(-mno-unaligned-access)
  466. endif()
  467. endif()
  468. elseif (${CMAKE_SYSTEM_PROCESSOR} MATCHES "^(x86_64|i686|AMD64)$" OR "${CMAKE_GENERATOR_PLATFORM_LWR}" MATCHES "^(x86_64|i686|amd64|x64)$" )
  469. message(STATUS "x86 detected")
  470. if (MSVC)
  471. if (LLAMA_AVX512)
  472. add_compile_options($<$<COMPILE_LANGUAGE:C>:/arch:AVX512>)
  473. add_compile_options($<$<COMPILE_LANGUAGE:CXX>:/arch:AVX512>)
  474. # MSVC has no compile-time flags enabling specific
  475. # AVX512 extensions, neither it defines the
  476. # macros corresponding to the extensions.
  477. # Do it manually.
  478. if (LLAMA_AVX512_VBMI)
  479. add_compile_definitions($<$<COMPILE_LANGUAGE:C>:__AVX512VBMI__>)
  480. add_compile_definitions($<$<COMPILE_LANGUAGE:CXX>:__AVX512VBMI__>)
  481. endif()
  482. if (LLAMA_AVX512_VNNI)
  483. add_compile_definitions($<$<COMPILE_LANGUAGE:C>:__AVX512VNNI__>)
  484. add_compile_definitions($<$<COMPILE_LANGUAGE:CXX>:__AVX512VNNI__>)
  485. endif()
  486. elseif (LLAMA_AVX2)
  487. add_compile_options($<$<COMPILE_LANGUAGE:C>:/arch:AVX2>)
  488. add_compile_options($<$<COMPILE_LANGUAGE:CXX>:/arch:AVX2>)
  489. elseif (LLAMA_AVX)
  490. add_compile_options($<$<COMPILE_LANGUAGE:C>:/arch:AVX>)
  491. add_compile_options($<$<COMPILE_LANGUAGE:CXX>:/arch:AVX>)
  492. endif()
  493. else()
  494. if (LLAMA_NATIVE)
  495. add_compile_options(-march=native)
  496. endif()
  497. if (LLAMA_F16C)
  498. add_compile_options(-mf16c)
  499. endif()
  500. if (LLAMA_FMA)
  501. add_compile_options(-mfma)
  502. endif()
  503. if (LLAMA_AVX)
  504. add_compile_options(-mavx)
  505. endif()
  506. if (LLAMA_AVX2)
  507. add_compile_options(-mavx2)
  508. endif()
  509. if (LLAMA_AVX512)
  510. add_compile_options(-mavx512f)
  511. add_compile_options(-mavx512bw)
  512. endif()
  513. if (LLAMA_AVX512_VBMI)
  514. add_compile_options(-mavx512vbmi)
  515. endif()
  516. if (LLAMA_AVX512_VNNI)
  517. add_compile_options(-mavx512vnni)
  518. endif()
  519. endif()
  520. elseif (${CMAKE_SYSTEM_PROCESSOR} MATCHES "ppc64")
  521. message(STATUS "PowerPC detected")
  522. add_compile_options(-mcpu=native -mtune=native)
  523. #TODO: Add targets for Power8/Power9 (Altivec/VSX) and Power10(MMA) and query for big endian systems (ppc64/le/be)
  524. else()
  525. message(STATUS "Unknown architecture")
  526. endif()
  527. #
  528. # POSIX conformance
  529. #
  530. # clock_gettime came in POSIX.1b (1993)
  531. # CLOCK_MONOTONIC came in POSIX.1-2001 / SUSv3 as optional
  532. # posix_memalign came in POSIX.1-2001 / SUSv3
  533. # M_PI is an XSI extension since POSIX.1-2001 / SUSv3, came in XPG1 (1985)
  534. add_compile_definitions(_XOPEN_SOURCE=600)
  535. # Somehow in OpenBSD whenever POSIX conformance is specified
  536. # some string functions rely on locale_t availability,
  537. # which was introduced in POSIX.1-2008, forcing us to go higher
  538. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  539. remove_definitions(-D_XOPEN_SOURCE=600)
  540. add_compile_definitions(_XOPEN_SOURCE=700)
  541. endif()
  542. # Data types, macros and functions related to controlling CPU affinity and
  543. # some memory allocation are available on Linux through GNU extensions in libc
  544. if (CMAKE_SYSTEM_NAME MATCHES "Linux")
  545. add_compile_definitions(_GNU_SOURCE)
  546. endif()
  547. # RLIMIT_MEMLOCK came in BSD, is not specified in POSIX.1,
  548. # and on macOS its availability depends on enabling Darwin extensions
  549. # similarly on DragonFly, enabling BSD extensions is necessary
  550. if (
  551. CMAKE_SYSTEM_NAME MATCHES "Darwin" OR
  552. CMAKE_SYSTEM_NAME MATCHES "iOS" OR
  553. CMAKE_SYSTEM_NAME MATCHES "tvOS" OR
  554. CMAKE_SYSTEM_NAME MATCHES "DragonFly"
  555. )
  556. add_compile_definitions(_DARWIN_C_SOURCE)
  557. endif()
  558. # alloca is a non-standard interface that is not visible on BSDs when
  559. # POSIX conformance is specified, but not all of them provide a clean way
  560. # to enable it in such cases
  561. if (CMAKE_SYSTEM_NAME MATCHES "FreeBSD")
  562. add_compile_definitions(__BSD_VISIBLE)
  563. endif()
  564. if (CMAKE_SYSTEM_NAME MATCHES "NetBSD")
  565. add_compile_definitions(_NETBSD_SOURCE)
  566. endif()
  567. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  568. add_compile_definitions(_BSD_SOURCE)
  569. endif()
  570. #
  571. # libraries
  572. #
  573. # ggml
  574. if (GGML_USE_CPU_HBM)
  575. add_definitions(-DGGML_USE_CPU_HBM)
  576. find_library(memkind memkind REQUIRED)
  577. endif()
  578. add_library(ggml OBJECT
  579. ggml.c
  580. ggml.h
  581. ggml-alloc.c
  582. ggml-alloc.h
  583. ggml-backend.c
  584. ggml-backend.h
  585. ggml-quants.c
  586. ggml-quants.h
  587. ${GGML_SOURCES_CUDA} ${GGML_HEADERS_CUDA}
  588. ${GGML_SOURCES_OPENCL} ${GGML_HEADERS_OPENCL}
  589. ${GGML_SOURCES_METAL} ${GGML_HEADERS_METAL}
  590. ${GGML_SOURCES_MPI} ${GGML_HEADERS_MPI}
  591. ${GGML_SOURCES_EXTRA} ${GGML_HEADERS_EXTRA}
  592. )
  593. target_include_directories(ggml PUBLIC . ${LLAMA_EXTRA_INCLUDES})
  594. target_compile_features(ggml PUBLIC c_std_11) # don't bump
  595. target_link_libraries(ggml PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  596. if (GGML_USE_CPU_HBM)
  597. target_link_libraries(ggml PUBLIC memkind)
  598. endif()
  599. add_library(ggml_static STATIC $<TARGET_OBJECTS:ggml>)
  600. if (BUILD_SHARED_LIBS)
  601. set_target_properties(ggml PROPERTIES POSITION_INDEPENDENT_CODE ON)
  602. add_library(ggml_shared SHARED $<TARGET_OBJECTS:ggml>)
  603. target_link_libraries(ggml_shared PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  604. install(TARGETS ggml_shared LIBRARY)
  605. endif()
  606. # llama
  607. add_library(llama
  608. llama.cpp
  609. llama.h
  610. )
  611. target_include_directories(llama PUBLIC .)
  612. target_compile_features(llama PUBLIC cxx_std_11) # don't bump
  613. target_link_libraries(llama PRIVATE
  614. ggml
  615. ${LLAMA_EXTRA_LIBS}
  616. )
  617. if (BUILD_SHARED_LIBS)
  618. set_target_properties(llama PROPERTIES POSITION_INDEPENDENT_CODE ON)
  619. target_compile_definitions(llama PRIVATE LLAMA_SHARED LLAMA_BUILD)
  620. if (LLAMA_METAL)
  621. set_target_properties(llama PROPERTIES RESOURCE "${CMAKE_CURRENT_SOURCE_DIR}/ggml-metal.metal")
  622. endif()
  623. endif()
  624. #
  625. # install
  626. #
  627. include(GNUInstallDirs)
  628. include(CMakePackageConfigHelpers)
  629. set(LLAMA_INCLUDE_INSTALL_DIR ${CMAKE_INSTALL_INCLUDEDIR}
  630. CACHE PATH "Location of header files")
  631. set(LLAMA_LIB_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR}
  632. CACHE PATH "Location of library files")
  633. set(LLAMA_BIN_INSTALL_DIR ${CMAKE_INSTALL_BINDIR}
  634. CACHE PATH "Location of binary files")
  635. set(LLAMA_BUILD_NUMBER ${BUILD_NUMBER})
  636. set(LLAMA_BUILD_COMMIT ${BUILD_COMMIT})
  637. set(LLAMA_INSTALL_VERSION 0.0.${BUILD_NUMBER})
  638. get_directory_property(LLAMA_TRANSIENT_DEFINES COMPILE_DEFINITIONS)
  639. configure_package_config_file(
  640. ${CMAKE_CURRENT_SOURCE_DIR}/scripts/LlamaConfig.cmake.in
  641. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfig.cmake
  642. INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Llama
  643. PATH_VARS LLAMA_INCLUDE_INSTALL_DIR
  644. LLAMA_LIB_INSTALL_DIR
  645. LLAMA_BIN_INSTALL_DIR )
  646. write_basic_package_version_file(
  647. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfigVersion.cmake
  648. VERSION ${LLAMA_INSTALL_VERSION}
  649. COMPATIBILITY SameMajorVersion)
  650. install(FILES ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfig.cmake
  651. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfigVersion.cmake
  652. DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Llama)
  653. set(GGML_PUBLIC_HEADERS "ggml.h"
  654. "${GGML_HEADERS_CUDA}" "${GGML_HEADERS_OPENCL}"
  655. "${GGML_HEADERS_METAL}" "${GGML_HEADERS_MPI}" "${GGML_HEADERS_EXTRA}")
  656. set_target_properties(ggml PROPERTIES PUBLIC_HEADER "${GGML_PUBLIC_HEADERS}")
  657. install(TARGETS ggml PUBLIC_HEADER)
  658. set_target_properties(llama PROPERTIES PUBLIC_HEADER ${CMAKE_CURRENT_SOURCE_DIR}/llama.h)
  659. install(TARGETS llama LIBRARY PUBLIC_HEADER)
  660. install(
  661. FILES convert.py
  662. PERMISSIONS
  663. OWNER_READ
  664. OWNER_WRITE
  665. OWNER_EXECUTE
  666. GROUP_READ
  667. GROUP_EXECUTE
  668. WORLD_READ
  669. WORLD_EXECUTE
  670. DESTINATION ${CMAKE_INSTALL_BINDIR})
  671. install(
  672. FILES convert-lora-to-ggml.py
  673. PERMISSIONS
  674. OWNER_READ
  675. OWNER_WRITE
  676. OWNER_EXECUTE
  677. GROUP_READ
  678. GROUP_EXECUTE
  679. WORLD_READ
  680. WORLD_EXECUTE
  681. DESTINATION ${CMAKE_INSTALL_BINDIR})
  682. if (LLAMA_METAL)
  683. install(
  684. FILES ggml-metal.metal
  685. PERMISSIONS
  686. OWNER_READ
  687. OWNER_WRITE
  688. GROUP_READ
  689. WORLD_READ
  690. DESTINATION ${CMAKE_INSTALL_BINDIR})
  691. endif()
  692. #
  693. # programs, examples and tests
  694. #
  695. add_subdirectory(common)
  696. if (LLAMA_BUILD_TESTS AND NOT CMAKE_JS_VERSION)
  697. include(CTest)
  698. add_subdirectory(tests)
  699. endif ()
  700. if (LLAMA_BUILD_EXAMPLES)
  701. add_subdirectory(examples)
  702. add_subdirectory(pocs)
  703. endif()