CMakeLists.txt 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212
  1. cmake_minimum_required(VERSION 3.14) # for add_link_options and implicit target directories.
  2. project("llama.cpp" C CXX)
  3. include(CheckIncludeFileCXX)
  4. set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
  5. if (NOT XCODE AND NOT MSVC AND NOT CMAKE_BUILD_TYPE)
  6. set(CMAKE_BUILD_TYPE Release CACHE STRING "Build type" FORCE)
  7. set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
  8. endif()
  9. set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
  10. if (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
  11. set(LLAMA_STANDALONE ON)
  12. # configure project version
  13. # TODO
  14. else()
  15. set(LLAMA_STANDALONE OFF)
  16. endif()
  17. if (EMSCRIPTEN)
  18. set(BUILD_SHARED_LIBS_DEFAULT OFF)
  19. option(LLAMA_WASM_SINGLE_FILE "llama: embed WASM inside the generated llama.js" ON)
  20. else()
  21. if (MINGW)
  22. set(BUILD_SHARED_LIBS_DEFAULT OFF)
  23. else()
  24. set(BUILD_SHARED_LIBS_DEFAULT ON)
  25. endif()
  26. endif()
  27. #
  28. # Option list
  29. #
  30. if (APPLE)
  31. set(LLAMA_METAL_DEFAULT ON)
  32. else()
  33. set(LLAMA_METAL_DEFAULT OFF)
  34. endif()
  35. # general
  36. option(BUILD_SHARED_LIBS "build shared libraries" OFF)
  37. option(LLAMA_STATIC "llama: static link libraries" OFF)
  38. option(LLAMA_NATIVE "llama: enable -march=native flag" ON)
  39. option(LLAMA_LTO "llama: enable link time optimization" OFF)
  40. option(LLAMA_CCACHE "llama: use ccache if available" ON)
  41. # debug
  42. option(LLAMA_ALL_WARNINGS "llama: enable all compiler warnings" ON)
  43. option(LLAMA_ALL_WARNINGS_3RD_PARTY "llama: enable all compiler warnings in 3rd party libs" OFF)
  44. option(LLAMA_GPROF "llama: enable gprof" OFF)
  45. # build
  46. option(LLAMA_FATAL_WARNINGS "llama: enable -Werror flag" OFF)
  47. # sanitizers
  48. option(LLAMA_SANITIZE_THREAD "llama: enable thread sanitizer" OFF)
  49. option(LLAMA_SANITIZE_ADDRESS "llama: enable address sanitizer" OFF)
  50. option(LLAMA_SANITIZE_UNDEFINED "llama: enable undefined sanitizer" OFF)
  51. # instruction set specific
  52. if (LLAMA_NATIVE)
  53. set(INS_ENB OFF)
  54. else()
  55. set(INS_ENB ON)
  56. endif()
  57. option(LLAMA_AVX "llama: enable AVX" ${INS_ENB})
  58. option(LLAMA_AVX2 "llama: enable AVX2" ${INS_ENB})
  59. option(LLAMA_AVX512 "llama: enable AVX512" OFF)
  60. option(LLAMA_AVX512_VBMI "llama: enable AVX512-VBMI" OFF)
  61. option(LLAMA_AVX512_VNNI "llama: enable AVX512-VNNI" OFF)
  62. option(LLAMA_FMA "llama: enable FMA" ${INS_ENB})
  63. # in MSVC F16C is implied with AVX2/AVX512
  64. if (NOT MSVC)
  65. option(LLAMA_F16C "llama: enable F16C" ${INS_ENB})
  66. endif()
  67. if (WIN32)
  68. set(LLAMA_WIN_VER "0x602" CACHE STRING "llama: Windows Version")
  69. endif()
  70. # 3rd party libs
  71. option(LLAMA_ACCELERATE "llama: enable Accelerate framework" ON)
  72. option(LLAMA_BLAS "llama: use BLAS" OFF)
  73. set(LLAMA_BLAS_VENDOR "Generic" CACHE STRING "llama: BLAS library vendor")
  74. option(LLAMA_CUBLAS "llama: use CUDA" OFF)
  75. #option(LLAMA_CUDA_CUBLAS "llama: use cuBLAS for prompt processing" OFF)
  76. option(LLAMA_CUDA_FORCE_DMMV "llama: use dmmv instead of mmvq CUDA kernels" OFF)
  77. option(LLAMA_CUDA_FORCE_MMQ "llama: use mmq kernels instead of cuBLAS" OFF)
  78. set(LLAMA_CUDA_DMMV_X "32" CACHE STRING "llama: x stride for dmmv CUDA kernels")
  79. set(LLAMA_CUDA_MMV_Y "1" CACHE STRING "llama: y block size for mmv CUDA kernels")
  80. option(LLAMA_CUDA_F16 "llama: use 16 bit floats for some calculations" OFF)
  81. set(LLAMA_CUDA_KQUANTS_ITER "2" CACHE STRING "llama: iters./thread per block for Q2_K/Q6_K")
  82. set(LLAMA_CUDA_PEER_MAX_BATCH_SIZE "128" CACHE STRING
  83. "llama: max. batch size for using peer access")
  84. option(LLAMA_HIPBLAS "llama: use hipBLAS" OFF)
  85. option(LLAMA_HIP_UMA "llama: use HIP unified memory architecture" OFF)
  86. option(LLAMA_CLBLAST "llama: use CLBlast" OFF)
  87. option(LLAMA_VULKAN "llama: use Vulkan" OFF)
  88. option(LLAMA_VULKAN_CHECK_RESULTS "llama: run Vulkan op checks" OFF)
  89. option(LLAMA_VULKAN_DEBUG "llama: enable Vulkan debug output" OFF)
  90. option(LLAMA_VULKAN_VALIDATE "llama: enable Vulkan validation" OFF)
  91. option(LLAMA_VULKAN_RUN_TESTS "llama: run Vulkan tests" OFF)
  92. option(LLAMA_METAL "llama: use Metal" ${LLAMA_METAL_DEFAULT})
  93. option(LLAMA_METAL_NDEBUG "llama: disable Metal debugging" OFF)
  94. option(LLAMA_METAL_SHADER_DEBUG "llama: compile Metal with -fno-fast-math" OFF)
  95. option(LLAMA_KOMPUTE "llama: use Kompute" OFF)
  96. option(LLAMA_MPI "llama: use MPI" OFF)
  97. option(LLAMA_QKK_64 "llama: use super-block size of 64 for k-quants" OFF)
  98. option(LLAMA_SYCL "llama: use SYCL" OFF)
  99. option(LLAMA_SYCL_F16 "llama: use 16 bit floats for sycl calculations" OFF)
  100. option(LLAMA_CPU_HBM "llama: use memkind for CPU HBM" OFF)
  101. option(LLAMA_BUILD_TESTS "llama: build tests" ${LLAMA_STANDALONE})
  102. option(LLAMA_BUILD_EXAMPLES "llama: build examples" ${LLAMA_STANDALONE})
  103. option(LLAMA_BUILD_SERVER "llama: build server example" ON)
  104. # add perf arguments
  105. option(LLAMA_PERF "llama: enable perf" OFF)
  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_FORCE_DMMV)
  285. add_compile_definitions(GGML_CUDA_FORCE_DMMV)
  286. endif()
  287. if (LLAMA_CUDA_FORCE_MMQ)
  288. add_compile_definitions(GGML_CUDA_FORCE_MMQ)
  289. endif()
  290. add_compile_definitions(GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  291. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  292. if (DEFINED LLAMA_CUDA_DMMV_Y)
  293. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_DMMV_Y}) # for backwards compatibility
  294. endif()
  295. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  296. add_compile_definitions(GGML_CUDA_F16)
  297. endif()
  298. add_compile_definitions(K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  299. add_compile_definitions(GGML_CUDA_PEER_MAX_BATCH_SIZE=${LLAMA_CUDA_PEER_MAX_BATCH_SIZE})
  300. if (LLAMA_STATIC)
  301. if (WIN32)
  302. # As of 12.3.1 CUDA Tookit for Windows does not offer a static cublas library
  303. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart_static CUDA::cublas CUDA::cublasLt)
  304. else ()
  305. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart_static CUDA::cublas_static CUDA::cublasLt_static)
  306. endif()
  307. else()
  308. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart CUDA::cublas CUDA::cublasLt)
  309. endif()
  310. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cuda_driver)
  311. if (NOT DEFINED CMAKE_CUDA_ARCHITECTURES)
  312. # 52 == lowest CUDA 12 standard
  313. # 60 == f16 CUDA intrinsics
  314. # 61 == integer CUDA intrinsics
  315. # 70 == compute capability at which unrolling a loop in mul_mat_q kernels is faster
  316. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  317. set(CMAKE_CUDA_ARCHITECTURES "60;61;70") # needed for f16 CUDA intrinsics
  318. else()
  319. set(CMAKE_CUDA_ARCHITECTURES "52;61;70") # lowest CUDA 12 standard + lowest for integer intrinsics
  320. #set(CMAKE_CUDA_ARCHITECTURES "") # use this to compile much faster, but only F16 models work
  321. endif()
  322. endif()
  323. message(STATUS "Using CUDA architectures: ${CMAKE_CUDA_ARCHITECTURES}")
  324. else()
  325. message(WARNING "cuBLAS not found")
  326. endif()
  327. endif()
  328. if (LLAMA_MPI)
  329. cmake_minimum_required(VERSION 3.10)
  330. find_package(MPI)
  331. if (MPI_C_FOUND)
  332. message(STATUS "MPI found")
  333. set(GGML_HEADERS_MPI ggml-mpi.h)
  334. set(GGML_SOURCES_MPI ggml-mpi.c)
  335. add_compile_definitions(GGML_USE_MPI)
  336. add_compile_definitions(${MPI_C_COMPILE_DEFINITIONS})
  337. if (NOT MSVC)
  338. add_compile_options(-Wno-cast-qual)
  339. endif()
  340. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_C_LIBRARIES})
  341. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${MPI_C_INCLUDE_DIRS})
  342. # Even if you're only using the C header, C++ programs may bring in MPI
  343. # C++ functions, so more linkage is needed
  344. if (MPI_CXX_FOUND)
  345. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_CXX_LIBRARIES})
  346. endif()
  347. else()
  348. message(WARNING "MPI not found")
  349. endif()
  350. endif()
  351. if (LLAMA_CLBLAST)
  352. find_package(CLBlast)
  353. if (CLBlast_FOUND)
  354. message(STATUS "CLBlast found")
  355. set(GGML_HEADERS_OPENCL ggml-opencl.h)
  356. set(GGML_SOURCES_OPENCL ggml-opencl.cpp)
  357. add_compile_definitions(GGML_USE_CLBLAST)
  358. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} clblast)
  359. else()
  360. message(WARNING "CLBlast not found")
  361. endif()
  362. endif()
  363. if (LLAMA_VULKAN)
  364. find_package(Vulkan)
  365. if (Vulkan_FOUND)
  366. message(STATUS "Vulkan found")
  367. set(GGML_HEADERS_VULKAN ggml-vulkan.h)
  368. set(GGML_SOURCES_VULKAN ggml-vulkan.cpp)
  369. add_compile_definitions(GGML_USE_VULKAN)
  370. if (LLAMA_VULKAN_CHECK_RESULTS)
  371. add_compile_definitions(GGML_VULKAN_CHECK_RESULTS)
  372. endif()
  373. if (LLAMA_VULKAN_DEBUG)
  374. add_compile_definitions(GGML_VULKAN_DEBUG)
  375. endif()
  376. if (LLAMA_VULKAN_VALIDATE)
  377. add_compile_definitions(GGML_VULKAN_VALIDATE)
  378. endif()
  379. if (LLAMA_VULKAN_RUN_TESTS)
  380. add_compile_definitions(GGML_VULKAN_RUN_TESTS)
  381. endif()
  382. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} Vulkan::Vulkan)
  383. else()
  384. message(WARNING "Vulkan not found")
  385. endif()
  386. endif()
  387. if (LLAMA_HIPBLAS)
  388. list(APPEND CMAKE_PREFIX_PATH /opt/rocm)
  389. if (NOT ${CMAKE_C_COMPILER_ID} MATCHES "Clang")
  390. message(WARNING "Only LLVM is supported for HIP, hint: CC=/opt/rocm/llvm/bin/clang")
  391. endif()
  392. if (NOT ${CMAKE_CXX_COMPILER_ID} MATCHES "Clang")
  393. message(WARNING "Only LLVM is supported for HIP, hint: CXX=/opt/rocm/llvm/bin/clang++")
  394. endif()
  395. find_package(hip REQUIRED)
  396. find_package(hipblas REQUIRED)
  397. find_package(rocblas REQUIRED)
  398. message(STATUS "HIP and hipBLAS found")
  399. set(GGML_HEADERS_ROCM ggml-cuda.h)
  400. set(GGML_SOURCES_ROCM ggml-cuda.cu)
  401. add_compile_definitions(GGML_USE_HIPBLAS GGML_USE_CUBLAS)
  402. if (LLAMA_HIP_UMA)
  403. add_compile_definitions(GGML_HIP_UMA)
  404. endif()
  405. if (LLAMA_CUDA_FORCE_DMMV)
  406. add_compile_definitions(GGML_CUDA_FORCE_DMMV)
  407. endif()
  408. if (LLAMA_CUDA_FORCE_MMQ)
  409. add_compile_definitions(GGML_CUDA_FORCE_MMQ)
  410. endif()
  411. add_compile_definitions(GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  412. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  413. add_compile_definitions(K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  414. set_source_files_properties(ggml-cuda.cu PROPERTIES LANGUAGE CXX)
  415. if (LLAMA_STATIC)
  416. message(FATAL_ERROR "Static linking not supported for HIP/ROCm")
  417. endif()
  418. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} hip::device PUBLIC hip::host roc::rocblas roc::hipblas)
  419. endif()
  420. if (LLAMA_SYCL)
  421. if ( NOT DEFINED ENV{ONEAPI_ROOT})
  422. message(FATAL_ERROR "Not detect ENV {ONEAPI_ROOT}, please install oneAPI & source it, like: source /opt/intel/oneapi/setvars.sh")
  423. endif()
  424. #todo: AOT
  425. find_package(IntelSYCL REQUIRED)
  426. message(STATUS "SYCL found")
  427. add_compile_definitions(GGML_USE_SYCL)
  428. if (LLAMA_SYCL_F16)
  429. add_compile_definitions(GGML_SYCL_F16)
  430. endif()
  431. add_compile_options(-I./) #include DPCT
  432. add_compile_options(-I/${SYCL_INCLUDE_DIR})
  433. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-narrowing")
  434. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O3")
  435. set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fsycl -L${MKLROOT}/lib")
  436. set(GGML_HEADERS_SYCL ggml-sycl.h)
  437. set(GGML_SOURCES_SYCL ggml-sycl.cpp)
  438. if (WIN32)
  439. 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)
  440. else()
  441. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} -fsycl OpenCL mkl_core pthread m dl mkl_sycl_blas mkl_intel_ilp64 mkl_tbb_thread)
  442. endif()
  443. endif()
  444. if (LLAMA_KOMPUTE)
  445. add_compile_definitions(VULKAN_HPP_DISPATCH_LOADER_DYNAMIC=1)
  446. find_package(Vulkan COMPONENTS glslc REQUIRED)
  447. find_program(glslc_executable NAMES glslc HINTS Vulkan::glslc)
  448. if (NOT glslc_executable)
  449. message(FATAL_ERROR "glslc not found")
  450. endif()
  451. function(compile_shader)
  452. set(options)
  453. set(oneValueArgs)
  454. set(multiValueArgs SOURCES)
  455. cmake_parse_arguments(compile_shader "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
  456. foreach(source ${compile_shader_SOURCES})
  457. get_filename_component(filename ${source} NAME)
  458. set(spv_file ${filename}.spv)
  459. add_custom_command(
  460. OUTPUT ${spv_file}
  461. DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/${source}
  462. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/common.comp
  463. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/op_getrows.comp
  464. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/op_mul_mv_q_n_pre.comp
  465. ${CMAKE_CURRENT_SOURCE_DIR}/kompute-shaders/op_mul_mv_q_n.comp
  466. COMMAND ${glslc_executable} --target-env=vulkan1.2 -o ${spv_file} ${CMAKE_CURRENT_SOURCE_DIR}/${source}
  467. COMMENT "Compiling ${source} to ${spv_file}"
  468. )
  469. get_filename_component(RAW_FILE_NAME ${spv_file} NAME)
  470. set(FILE_NAME "shader${RAW_FILE_NAME}")
  471. string(REPLACE ".comp.spv" ".h" HEADER_FILE ${FILE_NAME})
  472. string(TOUPPER ${HEADER_FILE} HEADER_FILE_DEFINE)
  473. string(REPLACE "." "_" HEADER_FILE_DEFINE "${HEADER_FILE_DEFINE}")
  474. set(OUTPUT_HEADER_FILE "${HEADER_FILE}")
  475. message(STATUS "${HEADER_FILE} generating ${HEADER_FILE_DEFINE}")
  476. if(CMAKE_GENERATOR MATCHES "Visual Studio")
  477. add_custom_command(
  478. OUTPUT ${OUTPUT_HEADER_FILE}
  479. COMMAND ${CMAKE_COMMAND} -E echo "/*THIS FILE HAS BEEN AUTOMATICALLY GENERATED - DO NOT EDIT*/" > ${OUTPUT_HEADER_FILE}
  480. COMMAND ${CMAKE_COMMAND} -E echo \"\#ifndef ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  481. COMMAND ${CMAKE_COMMAND} -E echo \"\#define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  482. COMMAND ${CMAKE_COMMAND} -E echo "namespace kp {" >> ${OUTPUT_HEADER_FILE}
  483. COMMAND ${CMAKE_COMMAND} -E echo "namespace shader_data {" >> ${OUTPUT_HEADER_FILE}
  484. COMMAND ${CMAKE_BINARY_DIR}/bin/$<CONFIG>/xxd -i ${RAW_FILE_NAME} >> ${OUTPUT_HEADER_FILE}
  485. COMMAND ${CMAKE_COMMAND} -E echo "}}" >> ${OUTPUT_HEADER_FILE}
  486. COMMAND ${CMAKE_COMMAND} -E echo \"\#endif // define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  487. DEPENDS ${spv_file} xxd
  488. COMMENT "Converting to hpp: ${FILE_NAME} ${CMAKE_BINARY_DIR}/bin/$<CONFIG>/xxd"
  489. )
  490. else()
  491. add_custom_command(
  492. OUTPUT ${OUTPUT_HEADER_FILE}
  493. COMMAND ${CMAKE_COMMAND} -E echo "/*THIS FILE HAS BEEN AUTOMATICALLY GENERATED - DO NOT EDIT*/" > ${OUTPUT_HEADER_FILE}
  494. COMMAND ${CMAKE_COMMAND} -E echo \"\#ifndef ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  495. COMMAND ${CMAKE_COMMAND} -E echo \"\#define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  496. COMMAND ${CMAKE_COMMAND} -E echo "namespace kp {" >> ${OUTPUT_HEADER_FILE}
  497. COMMAND ${CMAKE_COMMAND} -E echo "namespace shader_data {" >> ${OUTPUT_HEADER_FILE}
  498. COMMAND ${CMAKE_BINARY_DIR}/bin/xxd -i ${RAW_FILE_NAME} >> ${OUTPUT_HEADER_FILE}
  499. COMMAND ${CMAKE_COMMAND} -E echo "}}" >> ${OUTPUT_HEADER_FILE}
  500. COMMAND ${CMAKE_COMMAND} -E echo \"\#endif // define ${HEADER_FILE_DEFINE}\" >> ${OUTPUT_HEADER_FILE}
  501. DEPENDS ${spv_file} xxd
  502. COMMENT "Converting to hpp: ${FILE_NAME} ${CMAKE_BINARY_DIR}/bin/xxd"
  503. )
  504. endif()
  505. endforeach()
  506. endfunction()
  507. if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/kompute/CMakeLists.txt")
  508. message(STATUS "Kompute found")
  509. set(KOMPUTE_OPT_LOG_LEVEL Error CACHE STRING "Kompute log level")
  510. add_subdirectory(kompute)
  511. # Compile our shaders
  512. compile_shader(SOURCES
  513. kompute-shaders/op_scale.comp
  514. kompute-shaders/op_scale_8.comp
  515. kompute-shaders/op_add.comp
  516. kompute-shaders/op_addrow.comp
  517. kompute-shaders/op_mul.comp
  518. kompute-shaders/op_silu.comp
  519. kompute-shaders/op_relu.comp
  520. kompute-shaders/op_gelu.comp
  521. kompute-shaders/op_softmax.comp
  522. kompute-shaders/op_norm.comp
  523. kompute-shaders/op_rmsnorm.comp
  524. kompute-shaders/op_diagmask.comp
  525. kompute-shaders/op_mul_mat_mat_f32.comp
  526. kompute-shaders/op_mul_mat_f16.comp
  527. kompute-shaders/op_mul_mat_q8_0.comp
  528. kompute-shaders/op_mul_mat_q4_0.comp
  529. kompute-shaders/op_mul_mat_q4_1.comp
  530. kompute-shaders/op_mul_mat_q6_k.comp
  531. kompute-shaders/op_getrows_f16.comp
  532. kompute-shaders/op_getrows_q4_0.comp
  533. kompute-shaders/op_getrows_q4_1.comp
  534. kompute-shaders/op_getrows_q6_k.comp
  535. kompute-shaders/op_rope_f16.comp
  536. kompute-shaders/op_rope_f32.comp
  537. kompute-shaders/op_cpy_f16_f16.comp
  538. kompute-shaders/op_cpy_f16_f32.comp
  539. kompute-shaders/op_cpy_f32_f16.comp
  540. kompute-shaders/op_cpy_f32_f32.comp
  541. )
  542. # Create a custom target for our generated shaders
  543. add_custom_target(generated_shaders DEPENDS
  544. shaderop_scale.h
  545. shaderop_scale_8.h
  546. shaderop_add.h
  547. shaderop_addrow.h
  548. shaderop_mul.h
  549. shaderop_silu.h
  550. shaderop_relu.h
  551. shaderop_gelu.h
  552. shaderop_softmax.h
  553. shaderop_norm.h
  554. shaderop_rmsnorm.h
  555. shaderop_diagmask.h
  556. shaderop_mul_mat_mat_f32.h
  557. shaderop_mul_mat_f16.h
  558. shaderop_mul_mat_q8_0.h
  559. shaderop_mul_mat_q4_0.h
  560. shaderop_mul_mat_q4_1.h
  561. shaderop_mul_mat_q6_k.h
  562. shaderop_getrows_f16.h
  563. shaderop_getrows_q4_0.h
  564. shaderop_getrows_q4_1.h
  565. shaderop_getrows_q6_k.h
  566. shaderop_rope_f16.h
  567. shaderop_rope_f32.h
  568. shaderop_cpy_f16_f16.h
  569. shaderop_cpy_f16_f32.h
  570. shaderop_cpy_f32_f16.h
  571. shaderop_cpy_f32_f32.h
  572. )
  573. # Create a custom command that depends on the generated_shaders
  574. add_custom_command(
  575. OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp
  576. COMMAND ${CMAKE_COMMAND} -E touch ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp
  577. DEPENDS generated_shaders
  578. COMMENT "Ensuring shaders are generated before compiling ggml-kompute.cpp"
  579. )
  580. # Add the stamp to the main sources to ensure dependency tracking
  581. set(GGML_SOURCES_KOMPUTE ggml-kompute.cpp ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp)
  582. set(GGML_HEADERS_KOMPUTE ggml-kompute.h ${CMAKE_CURRENT_BINARY_DIR}/ggml-kompute.stamp)
  583. add_compile_definitions(GGML_USE_KOMPUTE)
  584. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} kompute)
  585. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${CMAKE_BINARY_DIR})
  586. else()
  587. message(WARNING "Kompute not found")
  588. endif()
  589. endif()
  590. if (LLAMA_CPU_HBM)
  591. find_library(memkind memkind REQUIRED)
  592. add_compile_definitions(GGML_USE_CPU_HBM)
  593. target_link_libraries(ggml PUBLIC memkind)
  594. endif()
  595. if (LLAMA_PERF)
  596. add_compile_definitions(GGML_PERF)
  597. endif()
  598. function(get_flags CCID CCVER)
  599. set(C_FLAGS "")
  600. set(CXX_FLAGS "")
  601. if (CCID MATCHES "Clang")
  602. set(C_FLAGS -Wunreachable-code-break -Wunreachable-code-return)
  603. set(CXX_FLAGS -Wunreachable-code-break -Wunreachable-code-return -Wmissing-prototypes -Wextra-semi)
  604. if (
  605. (CCID STREQUAL "Clang" AND CCVER VERSION_GREATER_EQUAL 3.8.0) OR
  606. (CCID STREQUAL "AppleClang" AND CCVER VERSION_GREATER_EQUAL 7.3.0)
  607. )
  608. list(APPEND C_FLAGS -Wdouble-promotion)
  609. endif()
  610. elseif (CCID STREQUAL "GNU")
  611. set(C_FLAGS -Wdouble-promotion)
  612. set(CXX_FLAGS -Wno-array-bounds)
  613. if (CCVER VERSION_GREATER_EQUAL 7.1.0)
  614. list(APPEND CXX_FLAGS -Wno-format-truncation)
  615. endif()
  616. if (CCVER VERSION_GREATER_EQUAL 8.1.0)
  617. list(APPEND CXX_FLAGS -Wextra-semi)
  618. endif()
  619. endif()
  620. set(GF_C_FLAGS ${C_FLAGS} PARENT_SCOPE)
  621. set(GF_CXX_FLAGS ${CXX_FLAGS} PARENT_SCOPE)
  622. endfunction()
  623. if (LLAMA_FATAL_WARNINGS)
  624. if (CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
  625. list(APPEND C_FLAGS -Werror)
  626. list(APPEND CXX_FLAGS -Werror)
  627. elseif (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
  628. add_compile_options(/WX)
  629. endif()
  630. endif()
  631. if (LLAMA_ALL_WARNINGS)
  632. if (NOT MSVC)
  633. list(APPEND WARNING_FLAGS -Wall -Wextra -Wpedantic -Wcast-qual -Wno-unused-function)
  634. list(APPEND C_FLAGS -Wshadow -Wstrict-prototypes -Wpointer-arith -Wmissing-prototypes
  635. -Werror=implicit-int -Werror=implicit-function-declaration)
  636. list(APPEND CXX_FLAGS -Wmissing-declarations -Wmissing-noreturn)
  637. list(APPEND C_FLAGS ${WARNING_FLAGS})
  638. list(APPEND CXX_FLAGS ${WARNING_FLAGS})
  639. get_flags(${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION})
  640. add_compile_options("$<$<COMPILE_LANGUAGE:C>:${C_FLAGS};${GF_C_FLAGS}>"
  641. "$<$<COMPILE_LANGUAGE:CXX>:${CXX_FLAGS};${GF_CXX_FLAGS}>")
  642. else()
  643. # todo : msvc
  644. set(C_FLAGS "")
  645. set(CXX_FLAGS "")
  646. endif()
  647. endif()
  648. set(CUDA_CXX_FLAGS "")
  649. if (LLAMA_CUBLAS)
  650. set(CUDA_FLAGS -use_fast_math)
  651. if (LLAMA_FATAL_WARNINGS)
  652. list(APPEND CUDA_FLAGS -Werror all-warnings)
  653. endif()
  654. if (LLAMA_ALL_WARNINGS AND NOT MSVC)
  655. set(NVCC_CMD ${CMAKE_CUDA_COMPILER} .c)
  656. if (NOT CMAKE_CUDA_HOST_COMPILER STREQUAL "")
  657. list(APPEND NVCC_CMD -ccbin ${CMAKE_CUDA_HOST_COMPILER})
  658. endif()
  659. execute_process(
  660. COMMAND ${NVCC_CMD} -Xcompiler --version
  661. OUTPUT_VARIABLE CUDA_CCFULLVER
  662. ERROR_QUIET
  663. )
  664. if (NOT CUDA_CCFULLVER MATCHES clang)
  665. set(CUDA_CCID "GNU")
  666. execute_process(
  667. COMMAND ${NVCC_CMD} -Xcompiler "-dumpfullversion -dumpversion"
  668. OUTPUT_VARIABLE CUDA_CCVER
  669. ERROR_QUIET
  670. )
  671. else()
  672. if (CUDA_CCFULLVER MATCHES Apple)
  673. set(CUDA_CCID "AppleClang")
  674. else()
  675. set(CUDA_CCID "Clang")
  676. endif()
  677. string(REGEX REPLACE "^.* version ([0-9.]*).*$" "\\1" CUDA_CCVER ${CUDA_CCFULLVER})
  678. endif()
  679. message("-- CUDA host compiler is ${CUDA_CCID} ${CUDA_CCVER}")
  680. get_flags(${CUDA_CCID} ${CUDA_CCVER})
  681. list(APPEND CUDA_CXX_FLAGS ${CXX_FLAGS} ${GF_CXX_FLAGS}) # This is passed to -Xcompiler later
  682. endif()
  683. if (NOT MSVC)
  684. list(APPEND CUDA_CXX_FLAGS -Wno-pedantic)
  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. add_library(ggml OBJECT
  908. ggml.c
  909. ggml.h
  910. ggml-alloc.c
  911. ggml-alloc.h
  912. ggml-backend.c
  913. ggml-backend.h
  914. ggml-quants.c
  915. ggml-quants.h
  916. ${GGML_SOURCES_CUDA} ${GGML_HEADERS_CUDA}
  917. ${GGML_SOURCES_OPENCL} ${GGML_HEADERS_OPENCL}
  918. ${GGML_SOURCES_METAL} ${GGML_HEADERS_METAL}
  919. ${GGML_SOURCES_MPI} ${GGML_HEADERS_MPI}
  920. ${GGML_SOURCES_EXTRA} ${GGML_HEADERS_EXTRA}
  921. ${GGML_SOURCES_SYCL} ${GGML_HEADERS_SYCL}
  922. ${GGML_SOURCES_KOMPUTE} ${GGML_HEADERS_KOMPUTE}
  923. ${GGML_SOURCES_VULKAN} ${GGML_HEADERS_VULKAN}
  924. ${GGML_SOURCES_ROCM} ${GGML_HEADERS_ROCM}
  925. )
  926. target_include_directories(ggml PUBLIC . ${LLAMA_EXTRA_INCLUDES})
  927. target_compile_features (ggml PUBLIC c_std_11) # don't bump
  928. target_link_libraries(ggml PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  929. add_library(ggml_static STATIC $<TARGET_OBJECTS:ggml>)
  930. if (BUILD_SHARED_LIBS)
  931. set_target_properties(ggml PROPERTIES POSITION_INDEPENDENT_CODE ON)
  932. add_library(ggml_shared SHARED $<TARGET_OBJECTS:ggml>)
  933. target_link_libraries(ggml_shared PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  934. install(TARGETS ggml_shared LIBRARY)
  935. endif()
  936. # llama
  937. add_library(llama
  938. llama.cpp
  939. llama.h
  940. )
  941. target_include_directories(llama PUBLIC .)
  942. target_compile_features (llama PUBLIC cxx_std_11) # don't bump
  943. target_link_libraries(llama PRIVATE
  944. ggml
  945. ${LLAMA_EXTRA_LIBS}
  946. )
  947. if (BUILD_SHARED_LIBS)
  948. set_target_properties(llama PROPERTIES POSITION_INDEPENDENT_CODE ON)
  949. target_compile_definitions(llama PRIVATE LLAMA_SHARED LLAMA_BUILD)
  950. if (LLAMA_METAL)
  951. set_target_properties(llama PROPERTIES RESOURCE "${CMAKE_CURRENT_SOURCE_DIR}/ggml-metal.metal")
  952. endif()
  953. endif()
  954. #
  955. # install
  956. #
  957. include(GNUInstallDirs)
  958. include(CMakePackageConfigHelpers)
  959. set(LLAMA_INCLUDE_INSTALL_DIR ${CMAKE_INSTALL_INCLUDEDIR}
  960. CACHE PATH "Location of header files")
  961. set(LLAMA_LIB_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR}
  962. CACHE PATH "Location of library files")
  963. set(LLAMA_BIN_INSTALL_DIR ${CMAKE_INSTALL_BINDIR}
  964. CACHE PATH "Location of binary files")
  965. set(LLAMA_BUILD_NUMBER ${BUILD_NUMBER})
  966. set(LLAMA_BUILD_COMMIT ${BUILD_COMMIT})
  967. set(LLAMA_INSTALL_VERSION 0.0.${BUILD_NUMBER})
  968. get_directory_property(LLAMA_TRANSIENT_DEFINES COMPILE_DEFINITIONS)
  969. configure_package_config_file(
  970. ${CMAKE_CURRENT_SOURCE_DIR}/scripts/LlamaConfig.cmake.in
  971. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfig.cmake
  972. INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Llama
  973. PATH_VARS LLAMA_INCLUDE_INSTALL_DIR
  974. LLAMA_LIB_INSTALL_DIR
  975. LLAMA_BIN_INSTALL_DIR )
  976. write_basic_package_version_file(
  977. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfigVersion.cmake
  978. VERSION ${LLAMA_INSTALL_VERSION}
  979. COMPATIBILITY SameMajorVersion)
  980. install(FILES ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfig.cmake
  981. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfigVersion.cmake
  982. DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Llama)
  983. set(GGML_PUBLIC_HEADERS "ggml.h" "ggml-alloc.h" "ggml-backend.h"
  984. "${GGML_HEADERS_CUDA}" "${GGML_HEADERS_OPENCL}"
  985. "${GGML_HEADERS_METAL}" "${GGML_HEADERS_MPI}" "${GGML_HEADERS_EXTRA}")
  986. set_target_properties(ggml PROPERTIES PUBLIC_HEADER "${GGML_PUBLIC_HEADERS}")
  987. install(TARGETS ggml PUBLIC_HEADER)
  988. set_target_properties(llama PROPERTIES PUBLIC_HEADER ${CMAKE_CURRENT_SOURCE_DIR}/llama.h)
  989. install(TARGETS llama LIBRARY PUBLIC_HEADER)
  990. install(
  991. FILES convert.py
  992. PERMISSIONS
  993. OWNER_READ
  994. OWNER_WRITE
  995. OWNER_EXECUTE
  996. GROUP_READ
  997. GROUP_EXECUTE
  998. WORLD_READ
  999. WORLD_EXECUTE
  1000. DESTINATION ${CMAKE_INSTALL_BINDIR})
  1001. install(
  1002. FILES convert-lora-to-ggml.py
  1003. PERMISSIONS
  1004. OWNER_READ
  1005. OWNER_WRITE
  1006. OWNER_EXECUTE
  1007. GROUP_READ
  1008. GROUP_EXECUTE
  1009. WORLD_READ
  1010. WORLD_EXECUTE
  1011. DESTINATION ${CMAKE_INSTALL_BINDIR})
  1012. if (LLAMA_METAL)
  1013. install(
  1014. FILES ggml-metal.metal
  1015. PERMISSIONS
  1016. OWNER_READ
  1017. OWNER_WRITE
  1018. GROUP_READ
  1019. WORLD_READ
  1020. DESTINATION ${CMAKE_INSTALL_BINDIR})
  1021. endif()
  1022. #
  1023. # programs, examples and tests
  1024. #
  1025. add_subdirectory(common)
  1026. if (LLAMA_BUILD_TESTS AND NOT CMAKE_JS_VERSION)
  1027. include(CTest)
  1028. add_subdirectory(tests)
  1029. endif ()
  1030. if (LLAMA_BUILD_EXAMPLES)
  1031. add_subdirectory(examples)
  1032. add_subdirectory(pocs)
  1033. endif()