CMakeLists.txt 49 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291
  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_CUDA "llama: use CUDA" OFF)
  75. option(LLAMA_CUBLAS "llama: use CUDA (deprecated, use LLAMA_CUDA)" 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. message(WARNING "LLAMA_CUBLAS is deprecated and will be removed in the future.\nUse LLAMA_CUDA instead")
  309. set(LLAMA_CUDA ON)
  310. endif()
  311. if (LLAMA_CUDA)
  312. cmake_minimum_required(VERSION 3.17)
  313. find_package(CUDAToolkit)
  314. if (CUDAToolkit_FOUND)
  315. message(STATUS "CUDA found")
  316. enable_language(CUDA)
  317. set(GGML_HEADERS_CUDA ggml-cuda.h)
  318. file(GLOB GGML_SOURCES_CUDA "ggml-cuda/*.cu")
  319. list(APPEND GGML_SOURCES_CUDA "ggml-cuda.cu")
  320. add_compile_definitions(GGML_USE_CUDA)
  321. if (LLAMA_CUDA_FORCE_DMMV)
  322. add_compile_definitions(GGML_CUDA_FORCE_DMMV)
  323. endif()
  324. if (LLAMA_CUDA_FORCE_MMQ)
  325. add_compile_definitions(GGML_CUDA_FORCE_MMQ)
  326. endif()
  327. add_compile_definitions(GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  328. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  329. if (DEFINED LLAMA_CUDA_DMMV_Y)
  330. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_DMMV_Y}) # for backwards compatibility
  331. endif()
  332. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  333. add_compile_definitions(GGML_CUDA_F16)
  334. endif()
  335. add_compile_definitions(K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  336. add_compile_definitions(GGML_CUDA_PEER_MAX_BATCH_SIZE=${LLAMA_CUDA_PEER_MAX_BATCH_SIZE})
  337. if (LLAMA_CUDA_NO_PEER_COPY)
  338. add_compile_definitions(GGML_CUDA_NO_PEER_COPY)
  339. endif()
  340. if (LLAMA_STATIC)
  341. if (WIN32)
  342. # As of 12.3.1 CUDA Tookit for Windows does not offer a static cublas library
  343. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart_static CUDA::cublas CUDA::cublasLt)
  344. else ()
  345. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart_static CUDA::cublas_static CUDA::cublasLt_static)
  346. endif()
  347. else()
  348. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart CUDA::cublas CUDA::cublasLt)
  349. endif()
  350. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cuda_driver)
  351. if (NOT DEFINED CMAKE_CUDA_ARCHITECTURES)
  352. # 52 == lowest CUDA 12 standard
  353. # 60 == f16 CUDA intrinsics
  354. # 61 == integer CUDA intrinsics
  355. # 70 == compute capability at which unrolling a loop in mul_mat_q kernels is faster
  356. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  357. set(CMAKE_CUDA_ARCHITECTURES "60;61;70") # needed for f16 CUDA intrinsics
  358. else()
  359. set(CMAKE_CUDA_ARCHITECTURES "52;61;70") # lowest CUDA 12 standard + lowest for integer intrinsics
  360. #set(CMAKE_CUDA_ARCHITECTURES "") # use this to compile much faster, but only F16 models work
  361. endif()
  362. endif()
  363. message(STATUS "Using CUDA architectures: ${CMAKE_CUDA_ARCHITECTURES}")
  364. else()
  365. message(WARNING "CUDA not found")
  366. endif()
  367. endif()
  368. if (LLAMA_MPI)
  369. cmake_minimum_required(VERSION 3.10)
  370. find_package(MPI)
  371. if (MPI_C_FOUND)
  372. message(STATUS "MPI found")
  373. set(GGML_HEADERS_MPI ggml-mpi.h)
  374. set(GGML_SOURCES_MPI ggml-mpi.c)
  375. add_compile_definitions(GGML_USE_MPI)
  376. add_compile_definitions(${MPI_C_COMPILE_DEFINITIONS})
  377. if (NOT MSVC)
  378. add_compile_options(-Wno-cast-qual)
  379. endif()
  380. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_C_LIBRARIES})
  381. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${MPI_C_INCLUDE_DIRS})
  382. # Even if you're only using the C header, C++ programs may bring in MPI
  383. # C++ functions, so more linkage is needed
  384. if (MPI_CXX_FOUND)
  385. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_CXX_LIBRARIES})
  386. endif()
  387. else()
  388. message(WARNING "MPI not found")
  389. endif()
  390. endif()
  391. if (LLAMA_CLBLAST)
  392. find_package(CLBlast)
  393. if (CLBlast_FOUND)
  394. message(STATUS "CLBlast found")
  395. set(GGML_HEADERS_OPENCL ggml-opencl.h)
  396. set(GGML_SOURCES_OPENCL ggml-opencl.cpp)
  397. add_compile_definitions(GGML_USE_CLBLAST)
  398. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} clblast)
  399. else()
  400. message(WARNING "CLBlast not found")
  401. endif()
  402. endif()
  403. if (LLAMA_VULKAN)
  404. find_package(Vulkan)
  405. if (Vulkan_FOUND)
  406. message(STATUS "Vulkan found")
  407. set(GGML_HEADERS_VULKAN ggml-vulkan.h)
  408. set(GGML_SOURCES_VULKAN ggml-vulkan.cpp)
  409. add_compile_definitions(GGML_USE_VULKAN)
  410. if (LLAMA_VULKAN_CHECK_RESULTS)
  411. add_compile_definitions(GGML_VULKAN_CHECK_RESULTS)
  412. endif()
  413. if (LLAMA_VULKAN_DEBUG)
  414. add_compile_definitions(GGML_VULKAN_DEBUG)
  415. endif()
  416. if (LLAMA_VULKAN_VALIDATE)
  417. add_compile_definitions(GGML_VULKAN_VALIDATE)
  418. endif()
  419. if (LLAMA_VULKAN_RUN_TESTS)
  420. add_compile_definitions(GGML_VULKAN_RUN_TESTS)
  421. endif()
  422. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} Vulkan::Vulkan)
  423. else()
  424. message(WARNING "Vulkan not found")
  425. endif()
  426. endif()
  427. if (LLAMA_HIPBLAS)
  428. list(APPEND CMAKE_PREFIX_PATH /opt/rocm)
  429. if (NOT ${CMAKE_C_COMPILER_ID} MATCHES "Clang")
  430. message(WARNING "Only LLVM is supported for HIP, hint: CC=/opt/rocm/llvm/bin/clang")
  431. endif()
  432. if (NOT ${CMAKE_CXX_COMPILER_ID} MATCHES "Clang")
  433. message(WARNING "Only LLVM is supported for HIP, hint: CXX=/opt/rocm/llvm/bin/clang++")
  434. endif()
  435. find_package(hip REQUIRED)
  436. find_package(hipblas REQUIRED)
  437. find_package(rocblas REQUIRED)
  438. message(STATUS "HIP and hipBLAS found")
  439. set(GGML_HEADERS_ROCM ggml-cuda.h)
  440. file(GLOB GGML_SOURCES_ROCM "ggml-cuda/*.cu")
  441. list(APPEND GGML_SOURCES_ROCM "ggml-cuda.cu")
  442. add_compile_definitions(GGML_USE_HIPBLAS GGML_USE_CUDA)
  443. if (LLAMA_HIP_UMA)
  444. add_compile_definitions(GGML_HIP_UMA)
  445. endif()
  446. if (LLAMA_CUDA_FORCE_DMMV)
  447. add_compile_definitions(GGML_CUDA_FORCE_DMMV)
  448. endif()
  449. if (LLAMA_CUDA_FORCE_MMQ)
  450. add_compile_definitions(GGML_CUDA_FORCE_MMQ)
  451. endif()
  452. if (LLAMA_CUDA_NO_PEER_COPY)
  453. add_compile_definitions(GGML_CUDA_NO_PEER_COPY)
  454. endif()
  455. add_compile_definitions(GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  456. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  457. add_compile_definitions(K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  458. set_source_files_properties(${GGML_SOURCES_ROCM} PROPERTIES LANGUAGE CXX)
  459. if (LLAMA_STATIC)
  460. message(FATAL_ERROR "Static linking not supported for HIP/ROCm")
  461. endif()
  462. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} hip::device PUBLIC hip::host roc::rocblas roc::hipblas)
  463. endif()
  464. if (LLAMA_SYCL)
  465. if (NOT LLAMA_SYCL_TARGET MATCHES "^(INTEL|NVIDIA)$")
  466. message(FATAL_ERROR "Invalid backend chosen, supported options are INTEL or NVIDIA")
  467. endif()
  468. if ( NOT DEFINED ENV{ONEAPI_ROOT})
  469. message(FATAL_ERROR "Not detect ENV {ONEAPI_ROOT}, please install oneAPI & source it, like: source /opt/intel/oneapi/setvars.sh")
  470. endif()
  471. #todo: AOT
  472. find_package(IntelSYCL REQUIRED)
  473. message(STATUS "SYCL found")
  474. add_compile_definitions(GGML_USE_SYCL)
  475. if (LLAMA_SYCL_F16)
  476. add_compile_definitions(GGML_SYCL_F16)
  477. endif()
  478. add_compile_options(-I./) #include DPCT
  479. add_compile_options(-I/${SYCL_INCLUDE_DIR})
  480. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-narrowing")
  481. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3")
  482. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsycl -L${MKLROOT}/lib")
  483. if (LLAMA_SYCL_TARGET STREQUAL "NVIDIA")
  484. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsycl-targets=nvptx64-nvidia-cuda")
  485. endif()
  486. set(GGML_HEADERS_SYCL ggml-sycl.h)
  487. set(GGML_SOURCES_SYCL ggml-sycl.cpp)
  488. if (WIN32)
  489. 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)
  490. else()
  491. if (LLAMA_SYCL_TARGET STREQUAL "INTEL")
  492. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} -fsycl OpenCL mkl_core pthread m dl mkl_sycl_blas mkl_intel_ilp64 mkl_tbb_thread)
  493. elseif (LLAMA_SYCL_TARGET STREQUAL "NVIDIA")
  494. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} -fsycl pthread m dl onemkl)
  495. endif()
  496. endif()
  497. endif()
  498. if (LLAMA_KOMPUTE)
  499. add_compile_definitions(VULKAN_HPP_DISPATCH_LOADER_DYNAMIC=1)
  500. find_package(Vulkan COMPONENTS glslc REQUIRED)
  501. find_program(glslc_executable NAMES glslc HINTS Vulkan::glslc)
  502. if (NOT glslc_executable)
  503. message(FATAL_ERROR "glslc not found")
  504. endif()
  505. function(compile_shader)
  506. set(options)
  507. set(oneValueArgs)
  508. set(multiValueArgs SOURCES)
  509. cmake_parse_arguments(compile_shader "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
  510. foreach(source ${compile_shader_SOURCES})
  511. get_filename_component(filename ${source} NAME)
  512. set(spv_file ${filename}.spv)
  513. add_custom_command(
  514. OUTPUT ${spv_file}
  515. DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${source}
  516. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/common.comp
  517. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/op_getrows.comp
  518. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/op_mul_mv_q_n_pre.comp
  519. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/op_mul_mv_q_n.comp
  520. COMMAND ${glslc_executable} --target-env=vulkan1.2 -o ${spv_file} ${CMAKE_CURRENT_SOURCE_DIR}/${source}
  521. COMMENT "Compiling ${source} to ${spv_file}"
  522. )
  523. get_filename_component(RAW_FILE_NAME ${spv_file} NAME)
  524. set(FILE_NAME "shader${RAW_FILE_NAME}")
  525. string(REPLACE ".comp.spv" ".h" HEADER_FILE ${FILE_NAME})
  526. string(TOUPPER ${HEADER_FILE} HEADER_FILE_DEFINE)
  527. string(REPLACE "." "_" HEADER_FILE_DEFINE "${HEADER_FILE_DEFINE}")
  528. set(OUTPUT_HEADER_FILE "${HEADER_FILE}")
  529. message(STATUS "${HEADER_FILE} generating ${HEADER_FILE_DEFINE}")
  530. if(CMAKE_GENERATOR MATCHES "Visual Studio")
  531. add_custom_command(
  532. OUTPUT ${OUTPUT_HEADER_FILE}
  533. COMMAND ${CMAKE_COMMAND} -E echo "/*THIS FILE HAS BEEN AUTOMATICALLY GENERATED - DO NOT EDIT*/" > ${OUTPUT_HEADER_FILE}
  534. COMMAND ${CMAKE_COMMAND} -E echo \"\#ifndef ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  535. COMMAND ${CMAKE_COMMAND} -E echo \"\#define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  536. COMMAND ${CMAKE_COMMAND} -E echo "namespace kp {" >> ${OUTPUT_HEADER_FILE}
  537. COMMAND ${CMAKE_COMMAND} -E echo "namespace shader_data {" >> ${OUTPUT_HEADER_FILE}
  538. COMMAND ${CMAKE_BINARY_DIR}/bin/$<CONFIG>/xxd -i ${RAW_FILE_NAME} >> ${OUTPUT_HEADER_FILE}
  539. COMMAND ${CMAKE_COMMAND} -E echo "}}" >> ${OUTPUT_HEADER_FILE}
  540. COMMAND ${CMAKE_COMMAND} -E echo \"\#endif // define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  541. DEPENDS ${spv_file} xxd
  542. COMMENT "Converting to hpp: ${FILE_NAME} ${CMAKE_BINARY_DIR}/bin/$<CONFIG>/xxd"
  543. )
  544. else()
  545. add_custom_command(
  546. OUTPUT ${OUTPUT_HEADER_FILE}
  547. COMMAND ${CMAKE_COMMAND} -E echo "/*THIS FILE HAS BEEN AUTOMATICALLY GENERATED - DO NOT EDIT*/" > ${OUTPUT_HEADER_FILE}
  548. COMMAND ${CMAKE_COMMAND} -E echo \"\#ifndef ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  549. COMMAND ${CMAKE_COMMAND} -E echo \"\#define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  550. COMMAND ${CMAKE_COMMAND} -E echo "namespace kp {" >> ${OUTPUT_HEADER_FILE}
  551. COMMAND ${CMAKE_COMMAND} -E echo "namespace shader_data {" >> ${OUTPUT_HEADER_FILE}
  552. COMMAND ${CMAKE_BINARY_DIR}/bin/xxd -i ${RAW_FILE_NAME} >> ${OUTPUT_HEADER_FILE}
  553. COMMAND ${CMAKE_COMMAND} -E echo "}}" >> ${OUTPUT_HEADER_FILE}
  554. COMMAND ${CMAKE_COMMAND} -E echo \"\#endif // define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  555. DEPENDS ${spv_file} xxd
  556. COMMENT "Converting to hpp: ${FILE_NAME} ${CMAKE_BINARY_DIR}/bin/xxd"
  557. )
  558. endif()
  559. endforeach()
  560. endfunction()
  561. if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/kompute/CMakeLists.txt")
  562. message(STATUS "Kompute found")
  563. set(KOMPUTE_OPT_LOG_LEVEL Error CACHE STRING "Kompute log level")
  564. add_subdirectory(kompute)
  565. # Compile our shaders
  566. compile_shader(SOURCES
  567. kompute-shaders/op_scale.comp
  568. kompute-shaders/op_scale_8.comp
  569. kompute-shaders/op_add.comp
  570. kompute-shaders/op_addrow.comp
  571. kompute-shaders/op_mul.comp
  572. kompute-shaders/op_silu.comp
  573. kompute-shaders/op_relu.comp
  574. kompute-shaders/op_gelu.comp
  575. kompute-shaders/op_softmax.comp
  576. kompute-shaders/op_norm.comp
  577. kompute-shaders/op_rmsnorm.comp
  578. kompute-shaders/op_diagmask.comp
  579. kompute-shaders/op_mul_mat_mat_f32.comp
  580. kompute-shaders/op_mul_mat_f16.comp
  581. kompute-shaders/op_mul_mat_q8_0.comp
  582. kompute-shaders/op_mul_mat_q4_0.comp
  583. kompute-shaders/op_mul_mat_q4_1.comp
  584. kompute-shaders/op_mul_mat_q6_k.comp
  585. kompute-shaders/op_getrows_f16.comp
  586. kompute-shaders/op_getrows_q4_0.comp
  587. kompute-shaders/op_getrows_q4_1.comp
  588. kompute-shaders/op_getrows_q6_k.comp
  589. kompute-shaders/op_rope_f16.comp
  590. kompute-shaders/op_rope_f32.comp
  591. kompute-shaders/op_cpy_f16_f16.comp
  592. kompute-shaders/op_cpy_f16_f32.comp
  593. kompute-shaders/op_cpy_f32_f16.comp
  594. kompute-shaders/op_cpy_f32_f32.comp
  595. )
  596. # Create a custom target for our generated shaders
  597. add_custom_target(generated_shaders DEPENDS
  598. shaderop_scale.h
  599. shaderop_scale_8.h
  600. shaderop_add.h
  601. shaderop_addrow.h
  602. shaderop_mul.h
  603. shaderop_silu.h
  604. shaderop_relu.h
  605. shaderop_gelu.h
  606. shaderop_softmax.h
  607. shaderop_norm.h
  608. shaderop_rmsnorm.h
  609. shaderop_diagmask.h
  610. shaderop_mul_mat_mat_f32.h
  611. shaderop_mul_mat_f16.h
  612. shaderop_mul_mat_q8_0.h
  613. shaderop_mul_mat_q4_0.h
  614. shaderop_mul_mat_q4_1.h
  615. shaderop_mul_mat_q6_k.h
  616. shaderop_getrows_f16.h
  617. shaderop_getrows_q4_0.h
  618. shaderop_getrows_q4_1.h
  619. shaderop_getrows_q6_k.h
  620. shaderop_rope_f16.h
  621. shaderop_rope_f32.h
  622. shaderop_cpy_f16_f16.h
  623. shaderop_cpy_f16_f32.h
  624. shaderop_cpy_f32_f16.h
  625. shaderop_cpy_f32_f32.h
  626. )
  627. # Create a custom command that depends on the generated_shaders
  628. add_custom_command(
  629. OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp
  630. COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp
  631. DEPENDS generated_shaders
  632. COMMENT "Ensuring shaders are generated before compiling ggml-kompute.cpp"
  633. )
  634. # Add the stamp to the main sources to ensure dependency tracking
  635. set(GGML_SOURCES_KOMPUTE ggml-kompute.cpp ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp)
  636. set(GGML_HEADERS_KOMPUTE ggml-kompute.h ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp)
  637. add_compile_definitions(GGML_USE_KOMPUTE)
  638. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} kompute)
  639. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${CMAKE_BINARY_DIR})
  640. else()
  641. message(WARNING "Kompute not found")
  642. endif()
  643. endif()
  644. if (LLAMA_CPU_HBM)
  645. find_library(memkind memkind REQUIRED)
  646. add_compile_definitions(GGML_USE_CPU_HBM)
  647. target_link_libraries(ggml PUBLIC memkind)
  648. endif()
  649. if (LLAMA_PERF)
  650. add_compile_definitions(GGML_PERF)
  651. endif()
  652. function(get_flags CCID CCVER)
  653. set(C_FLAGS "")
  654. set(CXX_FLAGS "")
  655. if (CCID MATCHES "Clang")
  656. set(C_FLAGS -Wunreachable-code-break -Wunreachable-code-return)
  657. set(CXX_FLAGS -Wunreachable-code-break -Wunreachable-code-return -Wmissing-prototypes -Wextra-semi)
  658. if (
  659. (CCID STREQUAL "Clang" AND CCVER VERSION_GREATER_EQUAL 3.8.0) OR
  660. (CCID STREQUAL "AppleClang" AND CCVER VERSION_GREATER_EQUAL 7.3.0)
  661. )
  662. list(APPEND C_FLAGS -Wdouble-promotion)
  663. endif()
  664. elseif (CCID STREQUAL "GNU")
  665. set(C_FLAGS -Wdouble-promotion)
  666. set(CXX_FLAGS -Wno-array-bounds)
  667. if (CCVER VERSION_GREATER_EQUAL 7.1.0)
  668. list(APPEND CXX_FLAGS -Wno-format-truncation)
  669. endif()
  670. if (CCVER VERSION_GREATER_EQUAL 8.1.0)
  671. list(APPEND CXX_FLAGS -Wextra-semi)
  672. endif()
  673. endif()
  674. set(GF_C_FLAGS ${C_FLAGS} PARENT_SCOPE)
  675. set(GF_CXX_FLAGS ${CXX_FLAGS} PARENT_SCOPE)
  676. endfunction()
  677. if (LLAMA_FATAL_WARNINGS)
  678. if (CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
  679. list(APPEND C_FLAGS -Werror)
  680. list(APPEND CXX_FLAGS -Werror)
  681. elseif (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
  682. add_compile_options(/WX)
  683. endif()
  684. endif()
  685. if (LLAMA_ALL_WARNINGS)
  686. if (NOT MSVC)
  687. list(APPEND WARNING_FLAGS -Wall -Wextra -Wpedantic -Wcast-qual -Wno-unused-function)
  688. list(APPEND C_FLAGS -Wshadow -Wstrict-prototypes -Wpointer-arith -Wmissing-prototypes
  689. -Werror=implicit-int -Werror=implicit-function-declaration)
  690. list(APPEND CXX_FLAGS -Wmissing-declarations -Wmissing-noreturn)
  691. list(APPEND C_FLAGS ${WARNING_FLAGS})
  692. list(APPEND CXX_FLAGS ${WARNING_FLAGS})
  693. get_flags(${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION})
  694. add_compile_options("$<$<COMPILE_LANGUAGE:C>:${C_FLAGS};${GF_C_FLAGS}>"
  695. "$<$<COMPILE_LANGUAGE:CXX>:${CXX_FLAGS};${GF_CXX_FLAGS}>")
  696. else()
  697. # todo : msvc
  698. set(C_FLAGS "")
  699. set(CXX_FLAGS "")
  700. endif()
  701. endif()
  702. set(CUDA_CXX_FLAGS "")
  703. if (LLAMA_CUDA)
  704. set(CUDA_FLAGS -use_fast_math)
  705. if (LLAMA_FATAL_WARNINGS)
  706. list(APPEND CUDA_FLAGS -Werror all-warnings)
  707. endif()
  708. if (LLAMA_ALL_WARNINGS AND NOT MSVC)
  709. set(NVCC_CMD ${CMAKE_CUDA_COMPILER} .c)
  710. if (NOT CMAKE_CUDA_HOST_COMPILER STREQUAL "")
  711. list(APPEND NVCC_CMD -ccbin ${CMAKE_CUDA_HOST_COMPILER})
  712. endif()
  713. execute_process(
  714. COMMAND ${NVCC_CMD} -Xcompiler --version
  715. OUTPUT_VARIABLE CUDA_CCFULLVER
  716. ERROR_QUIET
  717. )
  718. if (NOT CUDA_CCFULLVER MATCHES clang)
  719. set(CUDA_CCID "GNU")
  720. execute_process(
  721. COMMAND ${NVCC_CMD} -Xcompiler "-dumpfullversion -dumpversion"
  722. OUTPUT_VARIABLE CUDA_CCVER
  723. ERROR_QUIET
  724. )
  725. else()
  726. if (CUDA_CCFULLVER MATCHES Apple)
  727. set(CUDA_CCID "AppleClang")
  728. else()
  729. set(CUDA_CCID "Clang")
  730. endif()
  731. string(REGEX REPLACE "^.* version ([0-9.]*).*$" "\\1" CUDA_CCVER ${CUDA_CCFULLVER})
  732. endif()
  733. message("-- CUDA host compiler is ${CUDA_CCID} ${CUDA_CCVER}")
  734. get_flags(${CUDA_CCID} ${CUDA_CCVER})
  735. list(APPEND CUDA_CXX_FLAGS ${CXX_FLAGS} ${GF_CXX_FLAGS}) # This is passed to -Xcompiler later
  736. endif()
  737. if (NOT MSVC)
  738. list(APPEND CUDA_CXX_FLAGS -Wno-pedantic)
  739. endif()
  740. endif()
  741. if (WIN32)
  742. add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
  743. if (BUILD_SHARED_LIBS)
  744. set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
  745. endif()
  746. endif()
  747. if (LLAMA_LTO)
  748. include(CheckIPOSupported)
  749. check_ipo_supported(RESULT result OUTPUT output)
  750. if (result)
  751. set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE)
  752. else()
  753. message(WARNING "IPO is not supported: ${output}")
  754. endif()
  755. endif()
  756. if (LLAMA_CCACHE)
  757. find_program(LLAMA_CCACHE_FOUND ccache)
  758. if (LLAMA_CCACHE_FOUND)
  759. set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE ccache)
  760. set(ENV{CCACHE_SLOPPINESS} time_macros)
  761. message(STATUS "ccache found, compilation results will be cached. Disable with LLAMA_CCACHE=OFF.")
  762. else()
  763. message(STATUS "Warning: ccache not found - consider installing it for faster compilation or disable this warning with LLAMA_CCACHE=OFF")
  764. endif ()
  765. endif()
  766. # this version of Apple ld64 is buggy
  767. execute_process(
  768. COMMAND ${CMAKE_C_COMPILER} ${CMAKE_EXE_LINKER_FLAGS} -Wl,-v
  769. ERROR_VARIABLE output
  770. OUTPUT_QUIET
  771. )
  772. if (output MATCHES "dyld-1015\.7")
  773. add_compile_definitions(HAVE_BUGGY_APPLE_LINKER)
  774. endif()
  775. # Architecture specific
  776. # TODO: probably these flags need to be tweaked on some architectures
  777. # feel free to update the Makefile for your architecture and send a pull request or issue
  778. message(STATUS "CMAKE_SYSTEM_PROCESSOR: ${CMAKE_SYSTEM_PROCESSOR}")
  779. if (MSVC)
  780. string(TOLOWER "${CMAKE_GENERATOR_PLATFORM}" CMAKE_GENERATOR_PLATFORM_LWR)
  781. message(STATUS "CMAKE_GENERATOR_PLATFORM: ${CMAKE_GENERATOR_PLATFORM}")
  782. else ()
  783. set(CMAKE_GENERATOR_PLATFORM_LWR "")
  784. endif ()
  785. if (NOT MSVC)
  786. if (LLAMA_STATIC)
  787. add_link_options(-static)
  788. if (MINGW)
  789. add_link_options(-static-libgcc -static-libstdc++)
  790. endif()
  791. endif()
  792. if (LLAMA_GPROF)
  793. add_compile_options(-pg)
  794. endif()
  795. endif()
  796. set(ARCH_FLAGS "")
  797. if (CMAKE_OSX_ARCHITECTURES STREQUAL "arm64" OR CMAKE_GENERATOR_PLATFORM_LWR STREQUAL "arm64" OR
  798. (NOT CMAKE_OSX_ARCHITECTURES AND NOT CMAKE_GENERATOR_PLATFORM_LWR AND
  799. CMAKE_SYSTEM_PROCESSOR MATCHES "^(aarch64|arm.*|ARM64)$"))
  800. message(STATUS "ARM detected")
  801. if (MSVC)
  802. add_compile_definitions(__aarch64__) # MSVC defines _M_ARM64 instead
  803. add_compile_definitions(__ARM_NEON)
  804. add_compile_definitions(__ARM_FEATURE_FMA)
  805. set(CMAKE_REQUIRED_FLAGS_PREV ${CMAKE_REQUIRED_FLAGS})
  806. string(JOIN " " CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS} "/arch:armv8.2")
  807. 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)
  808. if (GGML_COMPILER_SUPPORT_DOTPROD)
  809. add_compile_definitions(__ARM_FEATURE_DOTPROD)
  810. endif ()
  811. 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)
  812. if (GGML_COMPILER_SUPPORT_FP16_VECTOR_ARITHMETIC)
  813. add_compile_definitions(__ARM_FEATURE_FP16_VECTOR_ARITHMETIC)
  814. endif ()
  815. set(CMAKE_REQUIRED_FLAGS ${CMAKE_REQUIRED_FLAGS_PREV})
  816. else()
  817. check_cxx_compiler_flag(-mfp16-format=ieee COMPILER_SUPPORTS_FP16_FORMAT_I3E)
  818. if (NOT "${COMPILER_SUPPORTS_FP16_FORMAT_I3E}" STREQUAL "")
  819. list(APPEND ARCH_FLAGS -mfp16-format=ieee)
  820. endif()
  821. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv6")
  822. # Raspberry Pi 1, Zero
  823. list(APPEND ARCH_FLAGS -mfpu=neon-fp-armv8 -mno-unaligned-access)
  824. endif()
  825. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv7")
  826. if ("${CMAKE_SYSTEM_NAME}" STREQUAL "Android")
  827. # Android armeabi-v7a
  828. list(APPEND ARCH_FLAGS -mfpu=neon-vfpv4 -mno-unaligned-access -funsafe-math-optimizations)
  829. else()
  830. # Raspberry Pi 2
  831. list(APPEND ARCH_FLAGS -mfpu=neon-fp-armv8 -mno-unaligned-access -funsafe-math-optimizations)
  832. endif()
  833. endif()
  834. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv8")
  835. # Android arm64-v8a
  836. # Raspberry Pi 3, 4, Zero 2 (32-bit)
  837. list(APPEND ARCH_FLAGS -mno-unaligned-access)
  838. endif()
  839. endif()
  840. elseif (CMAKE_OSX_ARCHITECTURES STREQUAL "x86_64" OR CMAKE_GENERATOR_PLATFORM_LWR MATCHES "^(x86_64|i686|amd64|x64|win32)$" OR
  841. (NOT CMAKE_OSX_ARCHITECTURES AND NOT CMAKE_GENERATOR_PLATFORM_LWR AND
  842. CMAKE_SYSTEM_PROCESSOR MATCHES "^(x86_64|i686|AMD64)$"))
  843. message(STATUS "x86 detected")
  844. if (MSVC)
  845. # instruction set detection for MSVC only
  846. if (LLAMA_NATIVE)
  847. include(cmake/FindSIMD.cmake)
  848. endif ()
  849. if (LLAMA_AVX512)
  850. list(APPEND ARCH_FLAGS /arch:AVX512)
  851. # MSVC has no compile-time flags enabling specific
  852. # AVX512 extensions, neither it defines the
  853. # macros corresponding to the extensions.
  854. # Do it manually.
  855. if (LLAMA_AVX512_VBMI)
  856. add_compile_definitions($<$<COMPILE_LANGUAGE:C>:__AVX512VBMI__>)
  857. add_compile_definitions($<$<COMPILE_LANGUAGE:CXX>:__AVX512VBMI__>)
  858. endif()
  859. if (LLAMA_AVX512_VNNI)
  860. add_compile_definitions($<$<COMPILE_LANGUAGE:C>:__AVX512VNNI__>)
  861. add_compile_definitions($<$<COMPILE_LANGUAGE:CXX>:__AVX512VNNI__>)
  862. endif()
  863. elseif (LLAMA_AVX2)
  864. list(APPEND ARCH_FLAGS /arch:AVX2)
  865. elseif (LLAMA_AVX)
  866. list(APPEND ARCH_FLAGS /arch:AVX)
  867. endif()
  868. else()
  869. if (LLAMA_NATIVE)
  870. list(APPEND ARCH_FLAGS -march=native)
  871. endif()
  872. if (LLAMA_F16C)
  873. list(APPEND ARCH_FLAGS -mf16c)
  874. endif()
  875. if (LLAMA_FMA)
  876. list(APPEND ARCH_FLAGS -mfma)
  877. endif()
  878. if (LLAMA_AVX)
  879. list(APPEND ARCH_FLAGS -mavx)
  880. endif()
  881. if (LLAMA_AVX2)
  882. list(APPEND ARCH_FLAGS -mavx2)
  883. endif()
  884. if (LLAMA_AVX512)
  885. list(APPEND ARCH_FLAGS -mavx512f)
  886. list(APPEND ARCH_FLAGS -mavx512bw)
  887. endif()
  888. if (LLAMA_AVX512_VBMI)
  889. list(APPEND ARCH_FLAGS -mavx512vbmi)
  890. endif()
  891. if (LLAMA_AVX512_VNNI)
  892. list(APPEND ARCH_FLAGS -mavx512vnni)
  893. endif()
  894. endif()
  895. elseif (${CMAKE_SYSTEM_PROCESSOR} MATCHES "ppc64")
  896. message(STATUS "PowerPC detected")
  897. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "ppc64le")
  898. list(APPEND ARCH_FLAGS -mcpu=powerpc64le)
  899. else()
  900. list(APPEND ARCH_FLAGS -mcpu=native -mtune=native)
  901. #TODO: Add targets for Power8/Power9 (Altivec/VSX) and Power10(MMA) and query for big endian systems (ppc64/le/be)
  902. endif()
  903. else()
  904. message(STATUS "Unknown architecture")
  905. endif()
  906. add_compile_options("$<$<COMPILE_LANGUAGE:CXX>:${ARCH_FLAGS}>")
  907. add_compile_options("$<$<COMPILE_LANGUAGE:C>:${ARCH_FLAGS}>")
  908. if (LLAMA_CUDA)
  909. list(APPEND CUDA_CXX_FLAGS ${ARCH_FLAGS})
  910. list(JOIN CUDA_CXX_FLAGS " " CUDA_CXX_FLAGS_JOINED) # pass host compiler flags as a single argument
  911. if (NOT CUDA_CXX_FLAGS_JOINED STREQUAL "")
  912. list(APPEND CUDA_FLAGS -Xcompiler ${CUDA_CXX_FLAGS_JOINED})
  913. endif()
  914. add_compile_options("$<$<COMPILE_LANGUAGE:CUDA>:${CUDA_FLAGS}>")
  915. endif()
  916. if (MINGW)
  917. # Target Windows 8 for PrefetchVirtualMemory
  918. add_compile_definitions(_WIN32_WINNT=${LLAMA_WIN_VER})
  919. endif()
  920. #
  921. # POSIX conformance
  922. #
  923. # clock_gettime came in POSIX.1b (1993)
  924. # CLOCK_MONOTONIC came in POSIX.1-2001 / SUSv3 as optional
  925. # posix_memalign came in POSIX.1-2001 / SUSv3
  926. # M_PI is an XSI extension since POSIX.1-2001 / SUSv3, came in XPG1 (1985)
  927. add_compile_definitions(_XOPEN_SOURCE=600)
  928. # Somehow in OpenBSD whenever POSIX conformance is specified
  929. # some string functions rely on locale_t availability,
  930. # which was introduced in POSIX.1-2008, forcing us to go higher
  931. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  932. remove_definitions(-D_XOPEN_SOURCE=600)
  933. add_compile_definitions(_XOPEN_SOURCE=700)
  934. endif()
  935. # Data types, macros and functions related to controlling CPU affinity and
  936. # some memory allocation are available on Linux through GNU extensions in libc
  937. if (CMAKE_SYSTEM_NAME MATCHES "Linux")
  938. add_compile_definitions(_GNU_SOURCE)
  939. endif()
  940. # RLIMIT_MEMLOCK came in BSD, is not specified in POSIX.1,
  941. # and on macOS its availability depends on enabling Darwin extensions
  942. # similarly on DragonFly, enabling BSD extensions is necessary
  943. if (
  944. CMAKE_SYSTEM_NAME MATCHES "Darwin" OR
  945. CMAKE_SYSTEM_NAME MATCHES "iOS" OR
  946. CMAKE_SYSTEM_NAME MATCHES "tvOS" OR
  947. CMAKE_SYSTEM_NAME MATCHES "DragonFly"
  948. )
  949. add_compile_definitions(_DARWIN_C_SOURCE)
  950. endif()
  951. # alloca is a non-standard interface that is not visible on BSDs when
  952. # POSIX conformance is specified, but not all of them provide a clean way
  953. # to enable it in such cases
  954. if (CMAKE_SYSTEM_NAME MATCHES "FreeBSD")
  955. add_compile_definitions(__BSD_VISIBLE)
  956. endif()
  957. if (CMAKE_SYSTEM_NAME MATCHES "NetBSD")
  958. add_compile_definitions(_NETBSD_SOURCE)
  959. endif()
  960. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  961. add_compile_definitions(_BSD_SOURCE)
  962. endif()
  963. #
  964. # libraries
  965. #
  966. # ggml
  967. add_library(ggml OBJECT
  968. ggml.c
  969. ggml.h
  970. ggml-alloc.c
  971. ggml-alloc.h
  972. ggml-backend.c
  973. ggml-backend.h
  974. ggml-quants.c
  975. ggml-quants.h
  976. ${GGML_SOURCES_CUDA} ${GGML_HEADERS_CUDA}
  977. ${GGML_SOURCES_OPENCL} ${GGML_HEADERS_OPENCL}
  978. ${GGML_SOURCES_METAL} ${GGML_HEADERS_METAL}
  979. ${GGML_SOURCES_MPI} ${GGML_HEADERS_MPI}
  980. ${GGML_SOURCES_EXTRA} ${GGML_HEADERS_EXTRA}
  981. ${GGML_SOURCES_SYCL} ${GGML_HEADERS_SYCL}
  982. ${GGML_SOURCES_KOMPUTE} ${GGML_HEADERS_KOMPUTE}
  983. ${GGML_SOURCES_VULKAN} ${GGML_HEADERS_VULKAN}
  984. ${GGML_SOURCES_ROCM} ${GGML_HEADERS_ROCM}
  985. )
  986. target_include_directories(ggml PUBLIC . ${LLAMA_EXTRA_INCLUDES})
  987. target_compile_features (ggml PUBLIC c_std_11) # don't bump
  988. target_link_libraries(ggml PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  989. add_library(ggml_static STATIC $<TARGET_OBJECTS:ggml>)
  990. if (BUILD_SHARED_LIBS)
  991. set_target_properties(ggml PROPERTIES POSITION_INDEPENDENT_CODE ON)
  992. add_library(ggml_shared SHARED $<TARGET_OBJECTS:ggml>)
  993. target_link_libraries(ggml_shared PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  994. install(TARGETS ggml_shared LIBRARY)
  995. endif()
  996. # llama
  997. add_library(llama
  998. llama.cpp
  999. llama.h
  1000. unicode.h
  1001. unicode.cpp
  1002. unicode-data.cpp
  1003. )
  1004. target_include_directories(llama PUBLIC .)
  1005. target_compile_features (llama PUBLIC cxx_std_11) # don't bump
  1006. target_link_libraries(llama PRIVATE
  1007. ggml
  1008. ${LLAMA_EXTRA_LIBS}
  1009. )
  1010. if (BUILD_SHARED_LIBS)
  1011. set_target_properties(llama PROPERTIES POSITION_INDEPENDENT_CODE ON)
  1012. target_compile_definitions(llama PRIVATE LLAMA_SHARED LLAMA_BUILD)
  1013. if (LLAMA_METAL)
  1014. set_target_properties(llama PROPERTIES RESOURCE "${CMAKE_CURRENT_SOURCE_DIR}/ggml-metal.metal")
  1015. endif()
  1016. endif()
  1017. #
  1018. # install
  1019. #
  1020. include(GNUInstallDirs)
  1021. include(CMakePackageConfigHelpers)
  1022. set(LLAMA_INCLUDE_INSTALL_DIR ${CMAKE_INSTALL_INCLUDEDIR}
  1023. CACHE PATH "Location of header files")
  1024. set(LLAMA_LIB_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR}
  1025. CACHE PATH "Location of library files")
  1026. set(LLAMA_BIN_INSTALL_DIR ${CMAKE_INSTALL_BINDIR}
  1027. CACHE PATH "Location of binary files")
  1028. set(LLAMA_BUILD_NUMBER ${BUILD_NUMBER})
  1029. set(LLAMA_BUILD_COMMIT ${BUILD_COMMIT})
  1030. set(LLAMA_INSTALL_VERSION 0.0.${BUILD_NUMBER})
  1031. get_directory_property(LLAMA_TRANSIENT_DEFINES COMPILE_DEFINITIONS)
  1032. configure_package_config_file(
  1033. ${CMAKE_CURRENT_SOURCE_DIR}/scripts/LlamaConfig.cmake.in
  1034. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfig.cmake
  1035. INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Llama
  1036. PATH_VARS LLAMA_INCLUDE_INSTALL_DIR
  1037. LLAMA_LIB_INSTALL_DIR
  1038. LLAMA_BIN_INSTALL_DIR )
  1039. write_basic_package_version_file(
  1040. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfigVersion.cmake
  1041. VERSION ${LLAMA_INSTALL_VERSION}
  1042. COMPATIBILITY SameMajorVersion)
  1043. install(FILES ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfig.cmake
  1044. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfigVersion.cmake
  1045. DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Llama)
  1046. set(GGML_PUBLIC_HEADERS "ggml.h" "ggml-alloc.h" "ggml-backend.h"
  1047. "${GGML_HEADERS_CUDA}" "${GGML_HEADERS_OPENCL}"
  1048. "${GGML_HEADERS_METAL}" "${GGML_HEADERS_MPI}" "${GGML_HEADERS_EXTRA}")
  1049. set_target_properties(ggml PROPERTIES PUBLIC_HEADER "${GGML_PUBLIC_HEADERS}")
  1050. install(TARGETS ggml PUBLIC_HEADER)
  1051. set_target_properties(llama PROPERTIES PUBLIC_HEADER ${CMAKE_CURRENT_SOURCE_DIR}/llama.h)
  1052. install(TARGETS llama LIBRARY PUBLIC_HEADER)
  1053. install(
  1054. FILES convert.py
  1055. PERMISSIONS
  1056. OWNER_READ
  1057. OWNER_WRITE
  1058. OWNER_EXECUTE
  1059. GROUP_READ
  1060. GROUP_EXECUTE
  1061. WORLD_READ
  1062. WORLD_EXECUTE
  1063. DESTINATION ${CMAKE_INSTALL_BINDIR})
  1064. install(
  1065. FILES convert-lora-to-ggml.py
  1066. PERMISSIONS
  1067. OWNER_READ
  1068. OWNER_WRITE
  1069. OWNER_EXECUTE
  1070. GROUP_READ
  1071. GROUP_EXECUTE
  1072. WORLD_READ
  1073. WORLD_EXECUTE
  1074. DESTINATION ${CMAKE_INSTALL_BINDIR})
  1075. if (LLAMA_METAL)
  1076. install(
  1077. FILES ggml-metal.metal
  1078. PERMISSIONS
  1079. OWNER_READ
  1080. OWNER_WRITE
  1081. GROUP_READ
  1082. WORLD_READ
  1083. DESTINATION ${CMAKE_INSTALL_BINDIR})
  1084. if (NOT LLAMA_METAL_EMBED_LIBRARY)
  1085. install(
  1086. FILES ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/default.metallib
  1087. DESTINATION ${CMAKE_INSTALL_BINDIR}
  1088. )
  1089. endif()
  1090. endif()
  1091. #
  1092. # programs, examples and tests
  1093. #
  1094. add_subdirectory(common)
  1095. if (LLAMA_BUILD_TESTS AND NOT CMAKE_JS_VERSION)
  1096. include(CTest)
  1097. add_subdirectory(tests)
  1098. endif ()
  1099. if (LLAMA_BUILD_EXAMPLES)
  1100. add_subdirectory(examples)
  1101. add_subdirectory(pocs)
  1102. endif()