CMakeLists.txt 46 KB

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