CMakeLists.txt 33 KB

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