CMakeLists.txt 33 KB

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