CMakeLists.txt 44 KB

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