CMakeLists.txt 45 KB

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