CMakeLists.txt 33 KB

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