CMakeLists.txt 48 KB

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