CMakeLists.txt 47 KB

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