CMakeLists.txt 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275
  1. cmake_minimum_required(VERSION 3.14) # for add_link_options and implicit target directories.
  2. project("llama.cpp" C CXX)
  3. include(CheckIncludeFileCXX)
  4. set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
  5. if (NOT XCODE AND NOT MSVC AND NOT CMAKE_BUILD_TYPE)
  6. set(CMAKE_BUILD_TYPE Release CACHE STRING "Build type" FORCE)
  7. set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
  8. endif()
  9. set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
  10. if (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
  11. set(LLAMA_STANDALONE ON)
  12. # configure project version
  13. # TODO
  14. else()
  15. set(LLAMA_STANDALONE OFF)
  16. endif()
  17. if (EMSCRIPTEN)
  18. set(BUILD_SHARED_LIBS_DEFAULT OFF)
  19. option(LLAMA_WASM_SINGLE_FILE "llama: embed WASM inside the generated llama.js" ON)
  20. else()
  21. if (MINGW)
  22. set(BUILD_SHARED_LIBS_DEFAULT OFF)
  23. else()
  24. set(BUILD_SHARED_LIBS_DEFAULT ON)
  25. endif()
  26. endif()
  27. #
  28. # Option list
  29. #
  30. if (APPLE)
  31. set(LLAMA_METAL_DEFAULT ON)
  32. else()
  33. set(LLAMA_METAL_DEFAULT OFF)
  34. endif()
  35. # general
  36. option(BUILD_SHARED_LIBS "build shared libraries" OFF)
  37. option(LLAMA_STATIC "llama: static link libraries" OFF)
  38. option(LLAMA_NATIVE "llama: enable -march=native flag" ON)
  39. option(LLAMA_LTO "llama: enable link time optimization" OFF)
  40. option(LLAMA_CCACHE "llama: use ccache if available" ON)
  41. # debug
  42. option(LLAMA_ALL_WARNINGS "llama: enable all compiler warnings" ON)
  43. option(LLAMA_ALL_WARNINGS_3RD_PARTY "llama: enable all compiler warnings in 3rd party libs" OFF)
  44. option(LLAMA_GPROF "llama: enable gprof" OFF)
  45. # build
  46. option(LLAMA_FATAL_WARNINGS "llama: enable -Werror flag" OFF)
  47. # sanitizers
  48. option(LLAMA_SANITIZE_THREAD "llama: enable thread sanitizer" OFF)
  49. option(LLAMA_SANITIZE_ADDRESS "llama: enable address sanitizer" OFF)
  50. option(LLAMA_SANITIZE_UNDEFINED "llama: enable undefined sanitizer" OFF)
  51. # instruction set specific
  52. if (LLAMA_NATIVE)
  53. set(INS_ENB OFF)
  54. else()
  55. set(INS_ENB ON)
  56. endif()
  57. option(LLAMA_AVX "llama: enable AVX" ${INS_ENB})
  58. option(LLAMA_AVX2 "llama: enable AVX2" ${INS_ENB})
  59. option(LLAMA_AVX512 "llama: enable AVX512" OFF)
  60. option(LLAMA_AVX512_VBMI "llama: enable AVX512-VBMI" OFF)
  61. option(LLAMA_AVX512_VNNI "llama: enable AVX512-VNNI" OFF)
  62. option(LLAMA_FMA "llama: enable FMA" ${INS_ENB})
  63. # in MSVC F16C is implied with AVX2/AVX512
  64. if (NOT MSVC)
  65. option(LLAMA_F16C "llama: enable F16C" ${INS_ENB})
  66. endif()
  67. if (WIN32)
  68. set(LLAMA_WIN_VER "0x602" CACHE STRING "llama: Windows Version")
  69. endif()
  70. # 3rd party libs
  71. option(LLAMA_ACCELERATE "llama: enable Accelerate framework" ON)
  72. option(LLAMA_BLAS "llama: use BLAS" OFF)
  73. set(LLAMA_BLAS_VENDOR "Generic" CACHE STRING "llama: BLAS library vendor")
  74. option(LLAMA_CUBLAS "llama: use CUDA" OFF)
  75. #option(LLAMA_CUDA_CUBLAS "llama: use cuBLAS for prompt processing" OFF)
  76. option(LLAMA_CUDA_FORCE_DMMV "llama: use dmmv instead of mmvq CUDA kernels" OFF)
  77. option(LLAMA_CUDA_FORCE_MMQ "llama: use mmq kernels instead of cuBLAS" OFF)
  78. set(LLAMA_CUDA_DMMV_X "32" CACHE STRING "llama: x stride for dmmv CUDA kernels")
  79. set(LLAMA_CUDA_MMV_Y "1" CACHE STRING "llama: y block size for mmv CUDA kernels")
  80. option(LLAMA_CUDA_F16 "llama: use 16 bit floats for some calculations" OFF)
  81. set(LLAMA_CUDA_KQUANTS_ITER "2" CACHE STRING "llama: iters./thread per block for Q2_K/Q6_K")
  82. set(LLAMA_CUDA_PEER_MAX_BATCH_SIZE "128" CACHE STRING
  83. "llama: max. batch size for using peer access")
  84. option(LLAMA_CUDA_NO_PEER_COPY "llama: do not use peer to peer copies" OFF)
  85. option(LLAMA_CURL "llama: use libcurl to download model from an URL" OFF)
  86. option(LLAMA_HIPBLAS "llama: use hipBLAS" OFF)
  87. option(LLAMA_HIP_UMA "llama: use HIP unified memory architecture" OFF)
  88. option(LLAMA_CLBLAST "llama: use CLBlast" OFF)
  89. option(LLAMA_VULKAN "llama: use Vulkan" OFF)
  90. option(LLAMA_VULKAN_CHECK_RESULTS "llama: run Vulkan op checks" OFF)
  91. option(LLAMA_VULKAN_DEBUG "llama: enable Vulkan debug output" OFF)
  92. option(LLAMA_VULKAN_VALIDATE "llama: enable Vulkan validation" OFF)
  93. option(LLAMA_VULKAN_RUN_TESTS "llama: run Vulkan tests" OFF)
  94. option(LLAMA_METAL "llama: use Metal" ${LLAMA_METAL_DEFAULT})
  95. option(LLAMA_METAL_NDEBUG "llama: disable Metal debugging" OFF)
  96. option(LLAMA_METAL_SHADER_DEBUG "llama: compile Metal with -fno-fast-math" OFF)
  97. option(LLAMA_METAL_EMBED_LIBRARY "llama: embed Metal library" OFF)
  98. option(LLAMA_KOMPUTE "llama: use Kompute" OFF)
  99. option(LLAMA_MPI "llama: use MPI" OFF)
  100. option(LLAMA_QKK_64 "llama: use super-block size of 64 for k-quants" OFF)
  101. option(LLAMA_SYCL "llama: use SYCL" OFF)
  102. option(LLAMA_SYCL_F16 "llama: use 16 bit floats for sycl calculations" OFF)
  103. set(LLAMA_SYCL_TARGET "INTEL" CACHE STRING "llama: sycl target device")
  104. option(LLAMA_CPU_HBM "llama: use memkind for CPU HBM" OFF)
  105. set(LLAMA_SCHED_MAX_COPIES "4" CACHE STRING "llama: max input copies for pipeline parallelism")
  106. option(LLAMA_BUILD_TESTS "llama: build tests" ${LLAMA_STANDALONE})
  107. option(LLAMA_BUILD_EXAMPLES "llama: build examples" ${LLAMA_STANDALONE})
  108. option(LLAMA_BUILD_SERVER "llama: build server example" ON)
  109. # add perf arguments
  110. option(LLAMA_PERF "llama: enable perf" OFF)
  111. # Required for relocatable CMake package
  112. include(${CMAKE_CURRENT_SOURCE_DIR}/scripts/build-info.cmake)
  113. #
  114. # Compile flags
  115. #
  116. if (LLAMA_SYCL)
  117. set(CMAKE_CXX_STANDARD 17)
  118. else()
  119. set(CMAKE_CXX_STANDARD 11)
  120. endif()
  121. set(CMAKE_CXX_STANDARD_REQUIRED true)
  122. set(CMAKE_C_STANDARD 11)
  123. set(CMAKE_C_STANDARD_REQUIRED true)
  124. set(THREADS_PREFER_PTHREAD_FLAG ON)
  125. find_package(Threads REQUIRED)
  126. include(CheckCXXCompilerFlag)
  127. add_compile_definitions(GGML_SCHED_MAX_COPIES=${LLAMA_SCHED_MAX_COPIES})
  128. # enable libstdc++ assertions for debug builds
  129. if (CMAKE_SYSTEM_NAME MATCHES "Linux")
  130. add_compile_definitions($<$<CONFIG:Debug>:_GLIBCXX_ASSERTIONS>)
  131. endif()
  132. if (NOT MSVC)
  133. if (LLAMA_SANITIZE_THREAD)
  134. add_compile_options(-fsanitize=thread)
  135. link_libraries (-fsanitize=thread)
  136. endif()
  137. if (LLAMA_SANITIZE_ADDRESS)
  138. add_compile_options(-fsanitize=address -fno-omit-frame-pointer)
  139. link_libraries (-fsanitize=address)
  140. endif()
  141. if (LLAMA_SANITIZE_UNDEFINED)
  142. add_compile_options(-fsanitize=undefined)
  143. link_libraries (-fsanitize=undefined)
  144. endif()
  145. endif()
  146. if (APPLE AND LLAMA_ACCELERATE)
  147. find_library(ACCELERATE_FRAMEWORK Accelerate)
  148. if (ACCELERATE_FRAMEWORK)
  149. message(STATUS "Accelerate framework found")
  150. add_compile_definitions(GGML_USE_ACCELERATE)
  151. add_compile_definitions(ACCELERATE_NEW_LAPACK)
  152. add_compile_definitions(ACCELERATE_LAPACK_ILP64)
  153. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${ACCELERATE_FRAMEWORK})
  154. else()
  155. message(WARNING "Accelerate framework not found")
  156. endif()
  157. endif()
  158. if (LLAMA_METAL)
  159. find_library(FOUNDATION_LIBRARY Foundation REQUIRED)
  160. find_library(METAL_FRAMEWORK Metal REQUIRED)
  161. find_library(METALKIT_FRAMEWORK MetalKit REQUIRED)
  162. message(STATUS "Metal framework found")
  163. set(GGML_HEADERS_METAL ggml-metal.h)
  164. set(GGML_SOURCES_METAL ggml-metal.m)
  165. add_compile_definitions(GGML_USE_METAL)
  166. if (LLAMA_METAL_NDEBUG)
  167. add_compile_definitions(GGML_METAL_NDEBUG)
  168. endif()
  169. # copy ggml-common.h and ggml-metal.metal to bin directory
  170. configure_file(ggml-common.h ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-common.h COPYONLY)
  171. configure_file(ggml-metal.metal ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-metal.metal COPYONLY)
  172. if (LLAMA_METAL_EMBED_LIBRARY)
  173. enable_language(ASM)
  174. add_compile_definitions(GGML_METAL_EMBED_LIBRARY)
  175. set(METALLIB_COMMON "${CMAKE_CURRENT_SOURCE_DIR}/ggml-common.h")
  176. set(METALLIB_SOURCE "${CMAKE_CURRENT_SOURCE_DIR}/ggml-metal.metal")
  177. file(MAKE_DIRECTORY "${CMAKE_BINARY_DIR}/autogenerated")
  178. # merge ggml-common.h and ggml-metal.metal into a single file
  179. set(METALLIB_EMBED_ASM "${CMAKE_BINARY_DIR}/autogenerated/ggml-metal-embed.s")
  180. set(METALLIB_SOURCE_EMBED "${CMAKE_BINARY_DIR}/autogenerated/ggml-metal-embed.metal")
  181. add_custom_command(
  182. OUTPUT ${METALLIB_EMBED_ASM}
  183. COMMAND echo "Embedding Metal library"
  184. COMMAND sed -e '/\#include \"ggml-common.h\"/r ${METALLIB_COMMON}' -e '/\#include \"ggml-common.h\"/d' < ${METALLIB_SOURCE} > ${METALLIB_SOURCE_EMBED}
  185. COMMAND echo ".section __DATA,__ggml_metallib" > ${METALLIB_EMBED_ASM}
  186. COMMAND echo ".globl _ggml_metallib_start" >> ${METALLIB_EMBED_ASM}
  187. COMMAND echo "_ggml_metallib_start:" >> ${METALLIB_EMBED_ASM}
  188. COMMAND echo ".incbin \\\"${METALLIB_SOURCE_EMBED}\\\"" >> ${METALLIB_EMBED_ASM}
  189. COMMAND echo ".globl _ggml_metallib_end" >> ${METALLIB_EMBED_ASM}
  190. COMMAND echo "_ggml_metallib_end:" >> ${METALLIB_EMBED_ASM}
  191. DEPENDS ggml-metal.metal ggml-common.h
  192. COMMENT "Generate assembly for embedded Metal library"
  193. )
  194. set(GGML_SOURCES_METAL ${GGML_SOURCES_METAL} ${METALLIB_EMBED_ASM})
  195. else()
  196. if (LLAMA_METAL_SHADER_DEBUG)
  197. # custom command to do the following:
  198. # xcrun -sdk macosx metal -fno-fast-math -c ggml-metal.metal -o ggml-metal.air
  199. # xcrun -sdk macosx metallib ggml-metal.air -o default.metallib
  200. #
  201. # note: this is the only way I found to disable fast-math in Metal. it's ugly, but at least it works
  202. # disabling fast math is needed in order to pass tests/test-backend-ops
  203. # note: adding -fno-inline fixes the tests when using MTL_SHADER_VALIDATION=1
  204. # note: unfortunately, we have to call it default.metallib instead of ggml.metallib
  205. # ref: https://github.com/ggerganov/whisper.cpp/issues/1720
  206. set(XC_FLAGS -fno-fast-math -fno-inline -g)
  207. else()
  208. set(XC_FLAGS -O3)
  209. endif()
  210. add_custom_command(
  211. OUTPUT ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/default.metallib
  212. COMMAND xcrun -sdk macosx metal ${XC_FLAGS} -c ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-metal.metal -o ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-metal.air
  213. COMMAND xcrun -sdk macosx metallib ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-metal.air -o ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/default.metallib
  214. COMMAND rm -f ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-metal.air
  215. COMMAND rm -f ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-common.h
  216. COMMAND rm -f ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-metal.metal
  217. DEPENDS ggml-metal.metal ggml-common.h
  218. COMMENT "Compiling Metal kernels"
  219. )
  220. add_custom_target(
  221. ggml-metal ALL
  222. DEPENDS ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/default.metallib
  223. )
  224. endif() # LLAMA_METAL_EMBED_LIBRARY
  225. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS}
  226. ${FOUNDATION_LIBRARY}
  227. ${METAL_FRAMEWORK}
  228. ${METALKIT_FRAMEWORK}
  229. )
  230. endif()
  231. if (LLAMA_BLAS)
  232. if (LLAMA_STATIC)
  233. set(BLA_STATIC ON)
  234. endif()
  235. if ($(CMAKE_VERSION) VERSION_GREATER_EQUAL 3.22)
  236. set(BLA_SIZEOF_INTEGER 8)
  237. endif()
  238. set(BLA_VENDOR ${LLAMA_BLAS_VENDOR})
  239. find_package(BLAS)
  240. if (BLAS_FOUND)
  241. message(STATUS "BLAS found, Libraries: ${BLAS_LIBRARIES}")
  242. if ("${BLAS_INCLUDE_DIRS}" STREQUAL "")
  243. # BLAS_INCLUDE_DIRS is missing in FindBLAS.cmake.
  244. # see https://gitlab.kitware.com/cmake/cmake/-/issues/20268
  245. find_package(PkgConfig REQUIRED)
  246. if (${LLAMA_BLAS_VENDOR} MATCHES "Generic")
  247. pkg_check_modules(DepBLAS REQUIRED blas)
  248. elseif (${LLAMA_BLAS_VENDOR} MATCHES "OpenBLAS")
  249. # As of openblas v0.3.22, the 64-bit is named openblas64.pc
  250. pkg_check_modules(DepBLAS openblas64)
  251. if (NOT DepBLAS_FOUND)
  252. pkg_check_modules(DepBLAS REQUIRED openblas)
  253. endif()
  254. elseif (${LLAMA_BLAS_VENDOR} MATCHES "FLAME")
  255. pkg_check_modules(DepBLAS REQUIRED blis)
  256. elseif (${LLAMA_BLAS_VENDOR} MATCHES "ATLAS")
  257. pkg_check_modules(DepBLAS REQUIRED blas-atlas)
  258. elseif (${LLAMA_BLAS_VENDOR} MATCHES "FlexiBLAS")
  259. pkg_check_modules(DepBLAS REQUIRED flexiblas_api)
  260. elseif (${LLAMA_BLAS_VENDOR} MATCHES "Intel")
  261. # all Intel* libraries share the same include path
  262. pkg_check_modules(DepBLAS REQUIRED mkl-sdl)
  263. elseif (${LLAMA_BLAS_VENDOR} MATCHES "NVHPC")
  264. # this doesn't provide pkg-config
  265. # suggest to assign BLAS_INCLUDE_DIRS on your own
  266. if ("${NVHPC_VERSION}" STREQUAL "")
  267. message(WARNING "Better to set NVHPC_VERSION")
  268. else()
  269. set(DepBLAS_FOUND ON)
  270. set(DepBLAS_INCLUDE_DIRS "/opt/nvidia/hpc_sdk/${CMAKE_SYSTEM_NAME}_${CMAKE_SYSTEM_PROCESSOR}/${NVHPC_VERSION}/math_libs/include")
  271. endif()
  272. endif()
  273. if (DepBLAS_FOUND)
  274. set(BLAS_INCLUDE_DIRS ${DepBLAS_INCLUDE_DIRS})
  275. else()
  276. message(WARNING "BLAS_INCLUDE_DIRS neither been provided nor been automatically"
  277. " detected by pkgconfig, trying to find cblas.h from possible paths...")
  278. find_path(BLAS_INCLUDE_DIRS
  279. NAMES cblas.h
  280. HINTS
  281. /usr/include
  282. /usr/local/include
  283. /usr/include/openblas
  284. /opt/homebrew/opt/openblas/include
  285. /usr/local/opt/openblas/include
  286. /usr/include/x86_64-linux-gnu/openblas/include
  287. )
  288. endif()
  289. endif()
  290. message(STATUS "BLAS found, Includes: ${BLAS_INCLUDE_DIRS}")
  291. add_compile_options(${BLAS_LINKER_FLAGS})
  292. add_compile_definitions(GGML_USE_OPENBLAS)
  293. if (${BLAS_INCLUDE_DIRS} MATCHES "mkl" AND (${LLAMA_BLAS_VENDOR} MATCHES "Generic" OR ${LLAMA_BLAS_VENDOR} MATCHES "Intel"))
  294. add_compile_definitions(GGML_BLAS_USE_MKL)
  295. endif()
  296. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${BLAS_LIBRARIES})
  297. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${BLAS_INCLUDE_DIRS})
  298. else()
  299. message(WARNING "BLAS not found, please refer to "
  300. "https://cmake.org/cmake/help/latest/module/FindBLAS.html#blas-lapack-vendors"
  301. " to set correct LLAMA_BLAS_VENDOR")
  302. endif()
  303. endif()
  304. if (LLAMA_QKK_64)
  305. add_compile_definitions(GGML_QKK_64)
  306. endif()
  307. if (LLAMA_CUBLAS)
  308. cmake_minimum_required(VERSION 3.17)
  309. find_package(CUDAToolkit)
  310. if (CUDAToolkit_FOUND)
  311. message(STATUS "cuBLAS found")
  312. enable_language(CUDA)
  313. set(GGML_HEADERS_CUDA ggml-cuda.h)
  314. set(GGML_SOURCES_CUDA ggml-cuda.cu)
  315. add_compile_definitions(GGML_USE_CUBLAS)
  316. if (LLAMA_CUDA_FORCE_DMMV)
  317. add_compile_definitions(GGML_CUDA_FORCE_DMMV)
  318. endif()
  319. if (LLAMA_CUDA_FORCE_MMQ)
  320. add_compile_definitions(GGML_CUDA_FORCE_MMQ)
  321. endif()
  322. add_compile_definitions(GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  323. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  324. if (DEFINED LLAMA_CUDA_DMMV_Y)
  325. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_DMMV_Y}) # for backwards compatibility
  326. endif()
  327. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  328. add_compile_definitions(GGML_CUDA_F16)
  329. endif()
  330. add_compile_definitions(K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  331. add_compile_definitions(GGML_CUDA_PEER_MAX_BATCH_SIZE=${LLAMA_CUDA_PEER_MAX_BATCH_SIZE})
  332. if (LLAMA_CUDA_NO_PEER_COPY)
  333. add_compile_definitions(GGML_CUDA_NO_PEER_COPY)
  334. endif()
  335. if (LLAMA_STATIC)
  336. if (WIN32)
  337. # As of 12.3.1 CUDA Tookit for Windows does not offer a static cublas library
  338. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart_static CUDA::cublas CUDA::cublasLt)
  339. else ()
  340. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart_static CUDA::cublas_static CUDA::cublasLt_static)
  341. endif()
  342. else()
  343. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart CUDA::cublas CUDA::cublasLt)
  344. endif()
  345. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cuda_driver)
  346. if (NOT DEFINED CMAKE_CUDA_ARCHITECTURES)
  347. # 52 == lowest CUDA 12 standard
  348. # 60 == f16 CUDA intrinsics
  349. # 61 == integer CUDA intrinsics
  350. # 70 == compute capability at which unrolling a loop in mul_mat_q kernels is faster
  351. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  352. set(CMAKE_CUDA_ARCHITECTURES "60;61;70") # needed for f16 CUDA intrinsics
  353. else()
  354. set(CMAKE_CUDA_ARCHITECTURES "52;61;70") # lowest CUDA 12 standard + lowest for integer intrinsics
  355. #set(CMAKE_CUDA_ARCHITECTURES "") # use this to compile much faster, but only F16 models work
  356. endif()
  357. endif()
  358. message(STATUS "Using CUDA architectures: ${CMAKE_CUDA_ARCHITECTURES}")
  359. else()
  360. message(WARNING "cuBLAS not found")
  361. endif()
  362. endif()
  363. if (LLAMA_MPI)
  364. cmake_minimum_required(VERSION 3.10)
  365. find_package(MPI)
  366. if (MPI_C_FOUND)
  367. message(STATUS "MPI found")
  368. set(GGML_HEADERS_MPI ggml-mpi.h)
  369. set(GGML_SOURCES_MPI ggml-mpi.c)
  370. add_compile_definitions(GGML_USE_MPI)
  371. add_compile_definitions(${MPI_C_COMPILE_DEFINITIONS})
  372. if (NOT MSVC)
  373. add_compile_options(-Wno-cast-qual)
  374. endif()
  375. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_C_LIBRARIES})
  376. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${MPI_C_INCLUDE_DIRS})
  377. # Even if you're only using the C header, C++ programs may bring in MPI
  378. # C++ functions, so more linkage is needed
  379. if (MPI_CXX_FOUND)
  380. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_CXX_LIBRARIES})
  381. endif()
  382. else()
  383. message(WARNING "MPI not found")
  384. endif()
  385. endif()
  386. if (LLAMA_CLBLAST)
  387. find_package(CLBlast)
  388. if (CLBlast_FOUND)
  389. message(STATUS "CLBlast found")
  390. set(GGML_HEADERS_OPENCL ggml-opencl.h)
  391. set(GGML_SOURCES_OPENCL ggml-opencl.cpp)
  392. add_compile_definitions(GGML_USE_CLBLAST)
  393. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} clblast)
  394. else()
  395. message(WARNING "CLBlast not found")
  396. endif()
  397. endif()
  398. if (LLAMA_VULKAN)
  399. find_package(Vulkan)
  400. if (Vulkan_FOUND)
  401. message(STATUS "Vulkan found")
  402. set(GGML_HEADERS_VULKAN ggml-vulkan.h)
  403. set(GGML_SOURCES_VULKAN ggml-vulkan.cpp)
  404. add_compile_definitions(GGML_USE_VULKAN)
  405. if (LLAMA_VULKAN_CHECK_RESULTS)
  406. add_compile_definitions(GGML_VULKAN_CHECK_RESULTS)
  407. endif()
  408. if (LLAMA_VULKAN_DEBUG)
  409. add_compile_definitions(GGML_VULKAN_DEBUG)
  410. endif()
  411. if (LLAMA_VULKAN_VALIDATE)
  412. add_compile_definitions(GGML_VULKAN_VALIDATE)
  413. endif()
  414. if (LLAMA_VULKAN_RUN_TESTS)
  415. add_compile_definitions(GGML_VULKAN_RUN_TESTS)
  416. endif()
  417. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} Vulkan::Vulkan)
  418. else()
  419. message(WARNING "Vulkan not found")
  420. endif()
  421. endif()
  422. if (LLAMA_HIPBLAS)
  423. list(APPEND CMAKE_PREFIX_PATH /opt/rocm)
  424. if (NOT ${CMAKE_C_COMPILER_ID} MATCHES "Clang")
  425. message(WARNING "Only LLVM is supported for HIP, hint: CC=/opt/rocm/llvm/bin/clang")
  426. endif()
  427. if (NOT ${CMAKE_CXX_COMPILER_ID} MATCHES "Clang")
  428. message(WARNING "Only LLVM is supported for HIP, hint: CXX=/opt/rocm/llvm/bin/clang++")
  429. endif()
  430. find_package(hip REQUIRED)
  431. find_package(hipblas REQUIRED)
  432. find_package(rocblas REQUIRED)
  433. message(STATUS "HIP and hipBLAS found")
  434. set(GGML_HEADERS_ROCM ggml-cuda.h)
  435. set(GGML_SOURCES_ROCM ggml-cuda.cu)
  436. add_compile_definitions(GGML_USE_HIPBLAS GGML_USE_CUBLAS)
  437. if (LLAMA_HIP_UMA)
  438. add_compile_definitions(GGML_HIP_UMA)
  439. endif()
  440. if (LLAMA_CUDA_FORCE_DMMV)
  441. add_compile_definitions(GGML_CUDA_FORCE_DMMV)
  442. endif()
  443. if (LLAMA_CUDA_FORCE_MMQ)
  444. add_compile_definitions(GGML_CUDA_FORCE_MMQ)
  445. endif()
  446. if (LLAMA_CUDA_NO_PEER_COPY)
  447. add_compile_definitions(GGML_CUDA_NO_PEER_COPY)
  448. endif()
  449. add_compile_definitions(GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  450. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  451. add_compile_definitions(K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  452. set_source_files_properties(ggml-cuda.cu PROPERTIES LANGUAGE CXX)
  453. if (LLAMA_STATIC)
  454. message(FATAL_ERROR "Static linking not supported for HIP/ROCm")
  455. endif()
  456. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} hip::device PUBLIC hip::host roc::rocblas roc::hipblas)
  457. endif()
  458. if (LLAMA_SYCL)
  459. if (NOT LLAMA_SYCL_TARGET MATCHES "^(INTEL|NVIDIA)$")
  460. message(FATAL_ERROR "Invalid backend chosen, supported options are INTEL or NVIDIA")
  461. endif()
  462. if ( NOT DEFINED ENV{ONEAPI_ROOT})
  463. message(FATAL_ERROR "Not detect ENV {ONEAPI_ROOT}, please install oneAPI & source it, like: source /opt/intel/oneapi/setvars.sh")
  464. endif()
  465. #todo: AOT
  466. find_package(IntelSYCL REQUIRED)
  467. message(STATUS "SYCL found")
  468. add_compile_definitions(GGML_USE_SYCL)
  469. if (LLAMA_SYCL_F16)
  470. add_compile_definitions(GGML_SYCL_F16)
  471. endif()
  472. add_compile_options(-I./) #include DPCT
  473. add_compile_options(-I/${SYCL_INCLUDE_DIR})
  474. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-narrowing")
  475. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3")
  476. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsycl -L${MKLROOT}/lib")
  477. if (LLAMA_SYCL_TARGET STREQUAL "NVIDIA")
  478. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsycl-targets=nvptx64-nvidia-cuda")
  479. endif()
  480. set(GGML_HEADERS_SYCL ggml-sycl.h)
  481. set(GGML_SOURCES_SYCL ggml-sycl.cpp)
  482. if (WIN32)
  483. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} -fsycl sycl7 OpenCL mkl_sycl_blas_dll.lib mkl_intel_ilp64_dll.lib mkl_sequential_dll.lib mkl_core_dll.lib)
  484. else()
  485. if (LLAMA_SYCL_TARGET STREQUAL "INTEL")
  486. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} -fsycl OpenCL mkl_core pthread m dl mkl_sycl_blas mkl_intel_ilp64 mkl_tbb_thread)
  487. elseif (LLAMA_SYCL_TARGET STREQUAL "NVIDIA")
  488. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} -fsycl pthread m dl onemkl)
  489. endif()
  490. endif()
  491. endif()
  492. if (LLAMA_KOMPUTE)
  493. add_compile_definitions(VULKAN_HPP_DISPATCH_LOADER_DYNAMIC=1)
  494. find_package(Vulkan COMPONENTS glslc REQUIRED)
  495. find_program(glslc_executable NAMES glslc HINTS Vulkan::glslc)
  496. if (NOT glslc_executable)
  497. message(FATAL_ERROR "glslc not found")
  498. endif()
  499. function(compile_shader)
  500. set(options)
  501. set(oneValueArgs)
  502. set(multiValueArgs SOURCES)
  503. cmake_parse_arguments(compile_shader "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
  504. foreach(source ${compile_shader_SOURCES})
  505. get_filename_component(filename ${source} NAME)
  506. set(spv_file ${filename}.spv)
  507. add_custom_command(
  508. OUTPUT ${spv_file}
  509. DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${source}
  510. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/common.comp
  511. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/op_getrows.comp
  512. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/op_mul_mv_q_n_pre.comp
  513. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/op_mul_mv_q_n.comp
  514. COMMAND ${glslc_executable} --target-env=vulkan1.2 -o ${spv_file} ${CMAKE_CURRENT_SOURCE_DIR}/${source}
  515. COMMENT "Compiling ${source} to ${spv_file}"
  516. )
  517. get_filename_component(RAW_FILE_NAME ${spv_file} NAME)
  518. set(FILE_NAME "shader${RAW_FILE_NAME}")
  519. string(REPLACE ".comp.spv" ".h" HEADER_FILE ${FILE_NAME})
  520. string(TOUPPER ${HEADER_FILE} HEADER_FILE_DEFINE)
  521. string(REPLACE "." "_" HEADER_FILE_DEFINE "${HEADER_FILE_DEFINE}")
  522. set(OUTPUT_HEADER_FILE "${HEADER_FILE}")
  523. message(STATUS "${HEADER_FILE} generating ${HEADER_FILE_DEFINE}")
  524. if(CMAKE_GENERATOR MATCHES "Visual Studio")
  525. add_custom_command(
  526. OUTPUT ${OUTPUT_HEADER_FILE}
  527. COMMAND ${CMAKE_COMMAND} -E echo "/*THIS FILE HAS BEEN AUTOMATICALLY GENERATED - DO NOT EDIT*/" > ${OUTPUT_HEADER_FILE}
  528. COMMAND ${CMAKE_COMMAND} -E echo \"\#ifndef ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  529. COMMAND ${CMAKE_COMMAND} -E echo \"\#define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  530. COMMAND ${CMAKE_COMMAND} -E echo "namespace kp {" >> ${OUTPUT_HEADER_FILE}
  531. COMMAND ${CMAKE_COMMAND} -E echo "namespace shader_data {" >> ${OUTPUT_HEADER_FILE}
  532. COMMAND ${CMAKE_BINARY_DIR}/bin/$<CONFIG>/xxd -i ${RAW_FILE_NAME} >> ${OUTPUT_HEADER_FILE}
  533. COMMAND ${CMAKE_COMMAND} -E echo "}}" >> ${OUTPUT_HEADER_FILE}
  534. COMMAND ${CMAKE_COMMAND} -E echo \"\#endif // define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  535. DEPENDS ${spv_file} xxd
  536. COMMENT "Converting to hpp: ${FILE_NAME} ${CMAKE_BINARY_DIR}/bin/$<CONFIG>/xxd"
  537. )
  538. else()
  539. add_custom_command(
  540. OUTPUT ${OUTPUT_HEADER_FILE}
  541. COMMAND ${CMAKE_COMMAND} -E echo "/*THIS FILE HAS BEEN AUTOMATICALLY GENERATED - DO NOT EDIT*/" > ${OUTPUT_HEADER_FILE}
  542. COMMAND ${CMAKE_COMMAND} -E echo \"\#ifndef ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  543. COMMAND ${CMAKE_COMMAND} -E echo \"\#define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  544. COMMAND ${CMAKE_COMMAND} -E echo "namespace kp {" >> ${OUTPUT_HEADER_FILE}
  545. COMMAND ${CMAKE_COMMAND} -E echo "namespace shader_data {" >> ${OUTPUT_HEADER_FILE}
  546. COMMAND ${CMAKE_BINARY_DIR}/bin/xxd -i ${RAW_FILE_NAME} >> ${OUTPUT_HEADER_FILE}
  547. COMMAND ${CMAKE_COMMAND} -E echo "}}" >> ${OUTPUT_HEADER_FILE}
  548. COMMAND ${CMAKE_COMMAND} -E echo \"\#endif // define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  549. DEPENDS ${spv_file} xxd
  550. COMMENT "Converting to hpp: ${FILE_NAME} ${CMAKE_BINARY_DIR}/bin/xxd"
  551. )
  552. endif()
  553. endforeach()
  554. endfunction()
  555. if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/kompute/CMakeLists.txt")
  556. message(STATUS "Kompute found")
  557. set(KOMPUTE_OPT_LOG_LEVEL Error CACHE STRING "Kompute log level")
  558. add_subdirectory(kompute)
  559. # Compile our shaders
  560. compile_shader(SOURCES
  561. kompute-shaders/op_scale.comp
  562. kompute-shaders/op_scale_8.comp
  563. kompute-shaders/op_add.comp
  564. kompute-shaders/op_addrow.comp
  565. kompute-shaders/op_mul.comp
  566. kompute-shaders/op_silu.comp
  567. kompute-shaders/op_relu.comp
  568. kompute-shaders/op_gelu.comp
  569. kompute-shaders/op_softmax.comp
  570. kompute-shaders/op_norm.comp
  571. kompute-shaders/op_rmsnorm.comp
  572. kompute-shaders/op_diagmask.comp
  573. kompute-shaders/op_mul_mat_mat_f32.comp
  574. kompute-shaders/op_mul_mat_f16.comp
  575. kompute-shaders/op_mul_mat_q8_0.comp
  576. kompute-shaders/op_mul_mat_q4_0.comp
  577. kompute-shaders/op_mul_mat_q4_1.comp
  578. kompute-shaders/op_mul_mat_q6_k.comp
  579. kompute-shaders/op_getrows_f16.comp
  580. kompute-shaders/op_getrows_q4_0.comp
  581. kompute-shaders/op_getrows_q4_1.comp
  582. kompute-shaders/op_getrows_q6_k.comp
  583. kompute-shaders/op_rope_f16.comp
  584. kompute-shaders/op_rope_f32.comp
  585. kompute-shaders/op_cpy_f16_f16.comp
  586. kompute-shaders/op_cpy_f16_f32.comp
  587. kompute-shaders/op_cpy_f32_f16.comp
  588. kompute-shaders/op_cpy_f32_f32.comp
  589. )
  590. # Create a custom target for our generated shaders
  591. add_custom_target(generated_shaders DEPENDS
  592. shaderop_scale.h
  593. shaderop_scale_8.h
  594. shaderop_add.h
  595. shaderop_addrow.h
  596. shaderop_mul.h
  597. shaderop_silu.h
  598. shaderop_relu.h
  599. shaderop_gelu.h
  600. shaderop_softmax.h
  601. shaderop_norm.h
  602. shaderop_rmsnorm.h
  603. shaderop_diagmask.h
  604. shaderop_mul_mat_mat_f32.h
  605. shaderop_mul_mat_f16.h
  606. shaderop_mul_mat_q8_0.h
  607. shaderop_mul_mat_q4_0.h
  608. shaderop_mul_mat_q4_1.h
  609. shaderop_mul_mat_q6_k.h
  610. shaderop_getrows_f16.h
  611. shaderop_getrows_q4_0.h
  612. shaderop_getrows_q4_1.h
  613. shaderop_getrows_q6_k.h
  614. shaderop_rope_f16.h
  615. shaderop_rope_f32.h
  616. shaderop_cpy_f16_f16.h
  617. shaderop_cpy_f16_f32.h
  618. shaderop_cpy_f32_f16.h
  619. shaderop_cpy_f32_f32.h
  620. )
  621. # Create a custom command that depends on the generated_shaders
  622. add_custom_command(
  623. OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp
  624. COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp
  625. DEPENDS generated_shaders
  626. COMMENT "Ensuring shaders are generated before compiling ggml-kompute.cpp"
  627. )
  628. # Add the stamp to the main sources to ensure dependency tracking
  629. set(GGML_SOURCES_KOMPUTE ggml-kompute.cpp ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp)
  630. set(GGML_HEADERS_KOMPUTE ggml-kompute.h ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp)
  631. add_compile_definitions(GGML_USE_KOMPUTE)
  632. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} kompute)
  633. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${CMAKE_BINARY_DIR})
  634. else()
  635. message(WARNING "Kompute not found")
  636. endif()
  637. endif()
  638. if (LLAMA_CPU_HBM)
  639. find_library(memkind memkind REQUIRED)
  640. add_compile_definitions(GGML_USE_CPU_HBM)
  641. target_link_libraries(ggml PUBLIC memkind)
  642. endif()
  643. if (LLAMA_PERF)
  644. add_compile_definitions(GGML_PERF)
  645. endif()
  646. function(get_flags CCID CCVER)
  647. set(C_FLAGS "")
  648. set(CXX_FLAGS "")
  649. if (CCID MATCHES "Clang")
  650. set(C_FLAGS -Wunreachable-code-break -Wunreachable-code-return)
  651. set(CXX_FLAGS -Wunreachable-code-break -Wunreachable-code-return -Wmissing-prototypes -Wextra-semi)
  652. if (
  653. (CCID STREQUAL "Clang" AND CCVER VERSION_GREATER_EQUAL 3.8.0) OR
  654. (CCID STREQUAL "AppleClang" AND CCVER VERSION_GREATER_EQUAL 7.3.0)
  655. )
  656. list(APPEND C_FLAGS -Wdouble-promotion)
  657. endif()
  658. elseif (CCID STREQUAL "GNU")
  659. set(C_FLAGS -Wdouble-promotion)
  660. set(CXX_FLAGS -Wno-array-bounds)
  661. if (CCVER VERSION_GREATER_EQUAL 7.1.0)
  662. list(APPEND CXX_FLAGS -Wno-format-truncation)
  663. endif()
  664. if (CCVER VERSION_GREATER_EQUAL 8.1.0)
  665. list(APPEND CXX_FLAGS -Wextra-semi)
  666. endif()
  667. endif()
  668. set(GF_C_FLAGS ${C_FLAGS} PARENT_SCOPE)
  669. set(GF_CXX_FLAGS ${CXX_FLAGS} PARENT_SCOPE)
  670. endfunction()
  671. if (LLAMA_FATAL_WARNINGS)
  672. if (CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
  673. list(APPEND C_FLAGS -Werror)
  674. list(APPEND CXX_FLAGS -Werror)
  675. elseif (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
  676. add_compile_options(/WX)
  677. endif()
  678. endif()
  679. if (LLAMA_ALL_WARNINGS)
  680. if (NOT MSVC)
  681. list(APPEND WARNING_FLAGS -Wall -Wextra -Wpedantic -Wcast-qual -Wno-unused-function)
  682. list(APPEND C_FLAGS -Wshadow -Wstrict-prototypes -Wpointer-arith -Wmissing-prototypes
  683. -Werror=implicit-int -Werror=implicit-function-declaration)
  684. list(APPEND CXX_FLAGS -Wmissing-declarations -Wmissing-noreturn)
  685. list(APPEND C_FLAGS ${WARNING_FLAGS})
  686. list(APPEND CXX_FLAGS ${WARNING_FLAGS})
  687. get_flags(${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION})
  688. add_compile_options("$<$<COMPILE_LANGUAGE:C>:${C_FLAGS};${GF_C_FLAGS}>"
  689. "$<$<COMPILE_LANGUAGE:CXX>:${CXX_FLAGS};${GF_CXX_FLAGS}>")
  690. else()
  691. # todo : msvc
  692. set(C_FLAGS "")
  693. set(CXX_FLAGS "")
  694. endif()
  695. endif()
  696. set(CUDA_CXX_FLAGS "")
  697. if (LLAMA_CUBLAS)
  698. set(CUDA_FLAGS -use_fast_math)
  699. if (LLAMA_FATAL_WARNINGS)
  700. list(APPEND CUDA_FLAGS -Werror all-warnings)
  701. endif()
  702. if (LLAMA_ALL_WARNINGS AND NOT MSVC)
  703. set(NVCC_CMD ${CMAKE_CUDA_COMPILER} .c)
  704. if (NOT CMAKE_CUDA_HOST_COMPILER STREQUAL "")
  705. list(APPEND NVCC_CMD -ccbin ${CMAKE_CUDA_HOST_COMPILER})
  706. endif()
  707. execute_process(
  708. COMMAND ${NVCC_CMD} -Xcompiler --version
  709. OUTPUT_VARIABLE CUDA_CCFULLVER
  710. ERROR_QUIET
  711. )
  712. if (NOT CUDA_CCFULLVER MATCHES clang)
  713. set(CUDA_CCID "GNU")
  714. execute_process(
  715. COMMAND ${NVCC_CMD} -Xcompiler "-dumpfullversion -dumpversion"
  716. OUTPUT_VARIABLE CUDA_CCVER
  717. ERROR_QUIET
  718. )
  719. else()
  720. if (CUDA_CCFULLVER MATCHES Apple)
  721. set(CUDA_CCID "AppleClang")
  722. else()
  723. set(CUDA_CCID "Clang")
  724. endif()
  725. string(REGEX REPLACE "^.* version ([0-9.]*).*$" "\\1" CUDA_CCVER ${CUDA_CCFULLVER})
  726. endif()
  727. message("-- CUDA host compiler is ${CUDA_CCID} ${CUDA_CCVER}")
  728. get_flags(${CUDA_CCID} ${CUDA_CCVER})
  729. list(APPEND CUDA_CXX_FLAGS ${CXX_FLAGS} ${GF_CXX_FLAGS}) # This is passed to -Xcompiler later
  730. endif()
  731. if (NOT MSVC)
  732. list(APPEND CUDA_CXX_FLAGS -Wno-pedantic)
  733. endif()
  734. endif()
  735. if (WIN32)
  736. add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
  737. if (BUILD_SHARED_LIBS)
  738. set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
  739. endif()
  740. endif()
  741. if (LLAMA_LTO)
  742. include(CheckIPOSupported)
  743. check_ipo_supported(RESULT result OUTPUT output)
  744. if (result)
  745. set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE)
  746. else()
  747. message(WARNING "IPO is not supported: ${output}")
  748. endif()
  749. endif()
  750. if (LLAMA_CCACHE)
  751. find_program(LLAMA_CCACHE_FOUND ccache)
  752. if (LLAMA_CCACHE_FOUND)
  753. set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ccache)
  754. set(ENV{CCACHE_SLOPPINESS} time_macros)
  755. message(STATUS "ccache found, compilation results will be cached. Disable with LLAMA_CCACHE=OFF.")
  756. else()
  757. message(STATUS "Warning: ccache not found - consider installing it for faster compilation or disable this warning with LLAMA_CCACHE=OFF")
  758. endif ()
  759. endif()
  760. # this version of Apple ld64 is buggy
  761. execute_process(
  762. COMMAND ${CMAKE_C_COMPILER} ${CMAKE_EXE_LINKER_FLAGS} -Wl,-v
  763. ERROR_VARIABLE output
  764. OUTPUT_QUIET
  765. )
  766. if (output MATCHES "dyld-1015\.7")
  767. add_compile_definitions(HAVE_BUGGY_APPLE_LINKER)
  768. endif()
  769. # Architecture specific
  770. # TODO: probably these flags need to be tweaked on some architectures
  771. # feel free to update the Makefile for your architecture and send a pull request or issue
  772. message(STATUS "CMAKE_SYSTEM_PROCESSOR: ${CMAKE_SYSTEM_PROCESSOR}")
  773. if (MSVC)
  774. string(TOLOWER "${CMAKE_GENERATOR_PLATFORM}" CMAKE_GENERATOR_PLATFORM_LWR)
  775. message(STATUS "CMAKE_GENERATOR_PLATFORM: ${CMAKE_GENERATOR_PLATFORM}")
  776. else ()
  777. set(CMAKE_GENERATOR_PLATFORM_LWR "")
  778. endif ()
  779. if (NOT MSVC)
  780. if (LLAMA_STATIC)
  781. add_link_options(-static)
  782. if (MINGW)
  783. add_link_options(-static-libgcc -static-libstdc++)
  784. endif()
  785. endif()
  786. if (LLAMA_GPROF)
  787. add_compile_options(-pg)
  788. endif()
  789. endif()
  790. set(ARCH_FLAGS "")
  791. if (CMAKE_OSX_ARCHITECTURES STREQUAL "arm64" OR CMAKE_GENERATOR_PLATFORM_LWR STREQUAL "arm64" OR
  792. (NOT CMAKE_OSX_ARCHITECTURES AND NOT CMAKE_GENERATOR_PLATFORM_LWR AND
  793. CMAKE_SYSTEM_PROCESSOR MATCHES "^(aarch64|arm.*|ARM64)$"))
  794. message(STATUS "ARM detected")
  795. if (MSVC)
  796. add_compile_definitions(__aarch64__) # MSVC defines _M_ARM64 instead
  797. add_compile_definitions(__ARM_NEON)
  798. add_compile_definitions(__ARM_FEATURE_FMA)
  799. set(CMAKE_REQUIRED_FLAGS_PREV ${CMAKE_REQUIRED_FLAGS})
  800. string(JOIN " " CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS} "/arch:armv8.2")
  801. check_cxx_source_compiles("#include <arm_neon.h>\nint main() { int8x16_t _a, _b; int32x4_t _s = vdotq_s32(_s, _a, _b); return 0; }" GGML_COMPILER_SUPPORT_DOTPROD)
  802. if (GGML_COMPILER_SUPPORT_DOTPROD)
  803. add_compile_definitions(__ARM_FEATURE_DOTPROD)
  804. endif ()
  805. check_cxx_source_compiles("#include <arm_neon.h>\nint main() { float16_t _a; float16x8_t _s = vdupq_n_f16(_a); return 0; }" GGML_COMPILER_SUPPORT_FP16_VECTOR_ARITHMETIC)
  806. if (GGML_COMPILER_SUPPORT_FP16_VECTOR_ARITHMETIC)
  807. add_compile_definitions(__ARM_FEATURE_FP16_VECTOR_ARITHMETIC)
  808. endif ()
  809. set(CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS_PREV})
  810. else()
  811. check_cxx_compiler_flag(-mfp16-format=ieee COMPILER_SUPPORTS_FP16_FORMAT_I3E)
  812. if (NOT "${COMPILER_SUPPORTS_FP16_FORMAT_I3E}" STREQUAL "")
  813. list(APPEND ARCH_FLAGS -mfp16-format=ieee)
  814. endif()
  815. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv6")
  816. # Raspberry Pi 1, Zero
  817. list(APPEND ARCH_FLAGS -mfpu=neon-fp-armv8 -mno-unaligned-access)
  818. endif()
  819. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv7")
  820. if ("${CMAKE_SYSTEM_NAME}" STREQUAL "Android")
  821. # Android armeabi-v7a
  822. list(APPEND ARCH_FLAGS -mfpu=neon-vfpv4 -mno-unaligned-access -funsafe-math-optimizations)
  823. else()
  824. # Raspberry Pi 2
  825. list(APPEND ARCH_FLAGS -mfpu=neon-fp-armv8 -mno-unaligned-access -funsafe-math-optimizations)
  826. endif()
  827. endif()
  828. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv8")
  829. # Android arm64-v8a
  830. # Raspberry Pi 3, 4, Zero 2 (32-bit)
  831. list(APPEND ARCH_FLAGS -mno-unaligned-access)
  832. endif()
  833. endif()
  834. elseif (CMAKE_OSX_ARCHITECTURES STREQUAL "x86_64" OR CMAKE_GENERATOR_PLATFORM_LWR MATCHES "^(x86_64|i686|amd64|x64|win32)$" OR
  835. (NOT CMAKE_OSX_ARCHITECTURES AND NOT CMAKE_GENERATOR_PLATFORM_LWR AND
  836. CMAKE_SYSTEM_PROCESSOR MATCHES "^(x86_64|i686|AMD64)$"))
  837. message(STATUS "x86 detected")
  838. if (MSVC)
  839. # instruction set detection for MSVC only
  840. if (LLAMA_NATIVE)
  841. include(cmake/FindSIMD.cmake)
  842. endif ()
  843. if (LLAMA_AVX512)
  844. list(APPEND ARCH_FLAGS /arch:AVX512)
  845. # MSVC has no compile-time flags enabling specific
  846. # AVX512 extensions, neither it defines the
  847. # macros corresponding to the extensions.
  848. # Do it manually.
  849. if (LLAMA_AVX512_VBMI)
  850. add_compile_definitions($<$<COMPILE_LANGUAGE:C>:__AVX512VBMI__>)
  851. add_compile_definitions($<$<COMPILE_LANGUAGE:CXX>:__AVX512VBMI__>)
  852. endif()
  853. if (LLAMA_AVX512_VNNI)
  854. add_compile_definitions($<$<COMPILE_LANGUAGE:C>:__AVX512VNNI__>)
  855. add_compile_definitions($<$<COMPILE_LANGUAGE:CXX>:__AVX512VNNI__>)
  856. endif()
  857. elseif (LLAMA_AVX2)
  858. list(APPEND ARCH_FLAGS /arch:AVX2)
  859. elseif (LLAMA_AVX)
  860. list(APPEND ARCH_FLAGS /arch:AVX)
  861. endif()
  862. else()
  863. if (LLAMA_NATIVE)
  864. list(APPEND ARCH_FLAGS -march=native)
  865. endif()
  866. if (LLAMA_F16C)
  867. list(APPEND ARCH_FLAGS -mf16c)
  868. endif()
  869. if (LLAMA_FMA)
  870. list(APPEND ARCH_FLAGS -mfma)
  871. endif()
  872. if (LLAMA_AVX)
  873. list(APPEND ARCH_FLAGS -mavx)
  874. endif()
  875. if (LLAMA_AVX2)
  876. list(APPEND ARCH_FLAGS -mavx2)
  877. endif()
  878. if (LLAMA_AVX512)
  879. list(APPEND ARCH_FLAGS -mavx512f)
  880. list(APPEND ARCH_FLAGS -mavx512bw)
  881. endif()
  882. if (LLAMA_AVX512_VBMI)
  883. list(APPEND ARCH_FLAGS -mavx512vbmi)
  884. endif()
  885. if (LLAMA_AVX512_VNNI)
  886. list(APPEND ARCH_FLAGS -mavx512vnni)
  887. endif()
  888. endif()
  889. elseif (${CMAKE_SYSTEM_PROCESSOR} MATCHES "ppc64")
  890. message(STATUS "PowerPC detected")
  891. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "ppc64le")
  892. list(APPEND ARCH_FLAGS -mcpu=powerpc64le)
  893. else()
  894. list(APPEND ARCH_FLAGS -mcpu=native -mtune=native)
  895. #TODO: Add targets for Power8/Power9 (Altivec/VSX) and Power10(MMA) and query for big endian systems (ppc64/le/be)
  896. endif()
  897. else()
  898. message(STATUS "Unknown architecture")
  899. endif()
  900. add_compile_options("$<$<COMPILE_LANGUAGE:CXX>:${ARCH_FLAGS}>")
  901. add_compile_options("$<$<COMPILE_LANGUAGE:C>:${ARCH_FLAGS}>")
  902. if (LLAMA_CUBLAS)
  903. list(APPEND CUDA_CXX_FLAGS ${ARCH_FLAGS})
  904. list(JOIN CUDA_CXX_FLAGS " " CUDA_CXX_FLAGS_JOINED) # pass host compiler flags as a single argument
  905. if (NOT CUDA_CXX_FLAGS_JOINED STREQUAL "")
  906. list(APPEND CUDA_FLAGS -Xcompiler ${CUDA_CXX_FLAGS_JOINED})
  907. endif()
  908. add_compile_options("$<$<COMPILE_LANGUAGE:CUDA>:${CUDA_FLAGS}>")
  909. endif()
  910. if (MINGW)
  911. # Target Windows 8 for PrefetchVirtualMemory
  912. add_compile_definitions(_WIN32_WINNT=${LLAMA_WIN_VER})
  913. endif()
  914. #
  915. # POSIX conformance
  916. #
  917. # clock_gettime came in POSIX.1b (1993)
  918. # CLOCK_MONOTONIC came in POSIX.1-2001 / SUSv3 as optional
  919. # posix_memalign came in POSIX.1-2001 / SUSv3
  920. # M_PI is an XSI extension since POSIX.1-2001 / SUSv3, came in XPG1 (1985)
  921. add_compile_definitions(_XOPEN_SOURCE=600)
  922. # Somehow in OpenBSD whenever POSIX conformance is specified
  923. # some string functions rely on locale_t availability,
  924. # which was introduced in POSIX.1-2008, forcing us to go higher
  925. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  926. remove_definitions(-D_XOPEN_SOURCE=600)
  927. add_compile_definitions(_XOPEN_SOURCE=700)
  928. endif()
  929. # Data types, macros and functions related to controlling CPU affinity and
  930. # some memory allocation are available on Linux through GNU extensions in libc
  931. if (CMAKE_SYSTEM_NAME MATCHES "Linux")
  932. add_compile_definitions(_GNU_SOURCE)
  933. endif()
  934. # RLIMIT_MEMLOCK came in BSD, is not specified in POSIX.1,
  935. # and on macOS its availability depends on enabling Darwin extensions
  936. # similarly on DragonFly, enabling BSD extensions is necessary
  937. if (
  938. CMAKE_SYSTEM_NAME MATCHES "Darwin" OR
  939. CMAKE_SYSTEM_NAME MATCHES "iOS" OR
  940. CMAKE_SYSTEM_NAME MATCHES "tvOS" OR
  941. CMAKE_SYSTEM_NAME MATCHES "DragonFly"
  942. )
  943. add_compile_definitions(_DARWIN_C_SOURCE)
  944. endif()
  945. # alloca is a non-standard interface that is not visible on BSDs when
  946. # POSIX conformance is specified, but not all of them provide a clean way
  947. # to enable it in such cases
  948. if (CMAKE_SYSTEM_NAME MATCHES "FreeBSD")
  949. add_compile_definitions(__BSD_VISIBLE)
  950. endif()
  951. if (CMAKE_SYSTEM_NAME MATCHES "NetBSD")
  952. add_compile_definitions(_NETBSD_SOURCE)
  953. endif()
  954. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  955. add_compile_definitions(_BSD_SOURCE)
  956. endif()
  957. #
  958. # libraries
  959. #
  960. # ggml
  961. add_library(ggml OBJECT
  962. ggml.c
  963. ggml.h
  964. ggml-alloc.c
  965. ggml-alloc.h
  966. ggml-backend.c
  967. ggml-backend.h
  968. ggml-quants.c
  969. ggml-quants.h
  970. ${GGML_SOURCES_CUDA} ${GGML_HEADERS_CUDA}
  971. ${GGML_SOURCES_OPENCL} ${GGML_HEADERS_OPENCL}
  972. ${GGML_SOURCES_METAL} ${GGML_HEADERS_METAL}
  973. ${GGML_SOURCES_MPI} ${GGML_HEADERS_MPI}
  974. ${GGML_SOURCES_EXTRA} ${GGML_HEADERS_EXTRA}
  975. ${GGML_SOURCES_SYCL} ${GGML_HEADERS_SYCL}
  976. ${GGML_SOURCES_KOMPUTE} ${GGML_HEADERS_KOMPUTE}
  977. ${GGML_SOURCES_VULKAN} ${GGML_HEADERS_VULKAN}
  978. ${GGML_SOURCES_ROCM} ${GGML_HEADERS_ROCM}
  979. )
  980. target_include_directories(ggml PUBLIC . ${LLAMA_EXTRA_INCLUDES})
  981. target_compile_features (ggml PUBLIC c_std_11) # don't bump
  982. target_link_libraries(ggml PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  983. add_library(ggml_static STATIC $<TARGET_OBJECTS:ggml>)
  984. if (BUILD_SHARED_LIBS)
  985. set_target_properties(ggml PROPERTIES POSITION_INDEPENDENT_CODE ON)
  986. add_library(ggml_shared SHARED $<TARGET_OBJECTS:ggml>)
  987. target_link_libraries(ggml_shared PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  988. install(TARGETS ggml_shared LIBRARY)
  989. endif()
  990. # llama
  991. add_library(llama
  992. llama.cpp
  993. llama.h
  994. unicode.h
  995. unicode.cpp
  996. )
  997. target_include_directories(llama PUBLIC .)
  998. target_compile_features (llama PUBLIC cxx_std_11) # don't bump
  999. target_link_libraries(llama PRIVATE
  1000. ggml
  1001. ${LLAMA_EXTRA_LIBS}
  1002. )
  1003. if (BUILD_SHARED_LIBS)
  1004. set_target_properties(llama PROPERTIES POSITION_INDEPENDENT_CODE ON)
  1005. target_compile_definitions(llama PRIVATE LLAMA_SHARED LLAMA_BUILD)
  1006. if (LLAMA_METAL)
  1007. set_target_properties(llama PROPERTIES RESOURCE "${CMAKE_CURRENT_SOURCE_DIR}/ggml-metal.metal")
  1008. endif()
  1009. endif()
  1010. #
  1011. # install
  1012. #
  1013. include(GNUInstallDirs)
  1014. include(CMakePackageConfigHelpers)
  1015. set(LLAMA_INCLUDE_INSTALL_DIR ${CMAKE_INSTALL_INCLUDEDIR}
  1016. CACHE PATH "Location of header files")
  1017. set(LLAMA_LIB_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR}
  1018. CACHE PATH "Location of library files")
  1019. set(LLAMA_BIN_INSTALL_DIR ${CMAKE_INSTALL_BINDIR}
  1020. CACHE PATH "Location of binary files")
  1021. set(LLAMA_BUILD_NUMBER ${BUILD_NUMBER})
  1022. set(LLAMA_BUILD_COMMIT ${BUILD_COMMIT})
  1023. set(LLAMA_INSTALL_VERSION 0.0.${BUILD_NUMBER})
  1024. get_directory_property(LLAMA_TRANSIENT_DEFINES COMPILE_DEFINITIONS)
  1025. configure_package_config_file(
  1026. ${CMAKE_CURRENT_SOURCE_DIR}/scripts/LlamaConfig.cmake.in
  1027. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfig.cmake
  1028. INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Llama
  1029. PATH_VARS LLAMA_INCLUDE_INSTALL_DIR
  1030. LLAMA_LIB_INSTALL_DIR
  1031. LLAMA_BIN_INSTALL_DIR )
  1032. write_basic_package_version_file(
  1033. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfigVersion.cmake
  1034. VERSION ${LLAMA_INSTALL_VERSION}
  1035. COMPATIBILITY SameMajorVersion)
  1036. install(FILES ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfig.cmake
  1037. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfigVersion.cmake
  1038. DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Llama)
  1039. set(GGML_PUBLIC_HEADERS "ggml.h" "ggml-alloc.h" "ggml-backend.h"
  1040. "${GGML_HEADERS_CUDA}" "${GGML_HEADERS_OPENCL}"
  1041. "${GGML_HEADERS_METAL}" "${GGML_HEADERS_MPI}" "${GGML_HEADERS_EXTRA}")
  1042. set_target_properties(ggml PROPERTIES PUBLIC_HEADER "${GGML_PUBLIC_HEADERS}")
  1043. install(TARGETS ggml PUBLIC_HEADER)
  1044. set_target_properties(llama PROPERTIES PUBLIC_HEADER ${CMAKE_CURRENT_SOURCE_DIR}/llama.h)
  1045. install(TARGETS llama LIBRARY PUBLIC_HEADER)
  1046. install(
  1047. FILES convert.py
  1048. PERMISSIONS
  1049. OWNER_READ
  1050. OWNER_WRITE
  1051. OWNER_EXECUTE
  1052. GROUP_READ
  1053. GROUP_EXECUTE
  1054. WORLD_READ
  1055. WORLD_EXECUTE
  1056. DESTINATION ${CMAKE_INSTALL_BINDIR})
  1057. install(
  1058. FILES convert-lora-to-ggml.py
  1059. PERMISSIONS
  1060. OWNER_READ
  1061. OWNER_WRITE
  1062. OWNER_EXECUTE
  1063. GROUP_READ
  1064. GROUP_EXECUTE
  1065. WORLD_READ
  1066. WORLD_EXECUTE
  1067. DESTINATION ${CMAKE_INSTALL_BINDIR})
  1068. if (LLAMA_METAL)
  1069. install(
  1070. FILES ggml-metal.metal
  1071. PERMISSIONS
  1072. OWNER_READ
  1073. OWNER_WRITE
  1074. GROUP_READ
  1075. WORLD_READ
  1076. DESTINATION ${CMAKE_INSTALL_BINDIR})
  1077. endif()
  1078. #
  1079. # programs, examples and tests
  1080. #
  1081. add_subdirectory(common)
  1082. if (LLAMA_BUILD_TESTS AND NOT CMAKE_JS_VERSION)
  1083. include(CTest)
  1084. add_subdirectory(tests)
  1085. endif ()
  1086. if (LLAMA_BUILD_EXAMPLES)
  1087. add_subdirectory(examples)
  1088. add_subdirectory(pocs)
  1089. endif()