CMakeLists.txt 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862
  1. cmake_minimum_required(VERSION 3.13) # for add_link_options
  2. project("llama.cpp" C CXX)
  3. set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
  4. if (NOT XCODE AND NOT MSVC AND NOT CMAKE_BUILD_TYPE)
  5. set(CMAKE_BUILD_TYPE Release CACHE STRING "Build type" FORCE)
  6. set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
  7. endif()
  8. set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
  9. if (CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
  10. set(LLAMA_STANDALONE ON)
  11. # configure project version
  12. # TODO
  13. else()
  14. set(LLAMA_STANDALONE OFF)
  15. endif()
  16. if (EMSCRIPTEN)
  17. set(BUILD_SHARED_LIBS_DEFAULT OFF)
  18. option(LLAMA_WASM_SINGLE_FILE "llama: embed WASM inside the generated llama.js" ON)
  19. else()
  20. if (MINGW)
  21. set(BUILD_SHARED_LIBS_DEFAULT OFF)
  22. else()
  23. set(BUILD_SHARED_LIBS_DEFAULT ON)
  24. endif()
  25. endif()
  26. #
  27. # Option list
  28. #
  29. if (APPLE)
  30. set(LLAMA_METAL_DEFAULT ON)
  31. else()
  32. set(LLAMA_METAL_DEFAULT OFF)
  33. endif()
  34. # general
  35. option(BUILD_SHARED_LIBS "build shared libraries" OFF)
  36. option(LLAMA_STATIC "llama: static link libraries" OFF)
  37. option(LLAMA_NATIVE "llama: enable -march=native flag" ON)
  38. option(LLAMA_LTO "llama: enable link time optimization" OFF)
  39. # debug
  40. option(LLAMA_ALL_WARNINGS "llama: enable all compiler warnings" ON)
  41. option(LLAMA_ALL_WARNINGS_3RD_PARTY "llama: enable all compiler warnings in 3rd party libs" OFF)
  42. option(LLAMA_GPROF "llama: enable gprof" OFF)
  43. # sanitizers
  44. option(LLAMA_SANITIZE_THREAD "llama: enable thread sanitizer" OFF)
  45. option(LLAMA_SANITIZE_ADDRESS "llama: enable address sanitizer" OFF)
  46. option(LLAMA_SANITIZE_UNDEFINED "llama: enable undefined sanitizer" OFF)
  47. # instruction set specific
  48. if (LLAMA_NATIVE)
  49. set(INS_ENB OFF)
  50. else()
  51. set(INS_ENB ON)
  52. endif()
  53. option(LLAMA_AVX "llama: enable AVX" ${INS_ENB})
  54. option(LLAMA_AVX2 "llama: enable AVX2" ${INS_ENB})
  55. option(LLAMA_AVX512 "llama: enable AVX512" OFF)
  56. option(LLAMA_AVX512_VBMI "llama: enable AVX512-VBMI" OFF)
  57. option(LLAMA_AVX512_VNNI "llama: enable AVX512-VNNI" OFF)
  58. option(LLAMA_FMA "llama: enable FMA" ${INS_ENB})
  59. # in MSVC F16C is implied with AVX2/AVX512
  60. if (NOT MSVC)
  61. option(LLAMA_F16C "llama: enable F16C" ${INS_ENB})
  62. endif()
  63. # 3rd party libs
  64. option(LLAMA_ACCELERATE "llama: enable Accelerate framework" ON)
  65. option(LLAMA_BLAS "llama: use BLAS" OFF)
  66. set(LLAMA_BLAS_VENDOR "Generic" CACHE STRING "llama: BLAS library vendor")
  67. option(LLAMA_CUBLAS "llama: use CUDA" OFF)
  68. #option(LLAMA_CUDA_CUBLAS "llama: use cuBLAS for prompt processing" OFF)
  69. option(LLAMA_CUDA_FORCE_DMMV "llama: use dmmv instead of mmvq CUDA kernels" OFF)
  70. option(LLAMA_CUDA_FORCE_MMQ "llama: use mmq kernels instead of cuBLAS" OFF)
  71. set(LLAMA_CUDA_DMMV_X "32" CACHE STRING "llama: x stride for dmmv CUDA kernels")
  72. set(LLAMA_CUDA_MMV_Y "1" CACHE STRING "llama: y block size for mmv CUDA kernels")
  73. option(LLAMA_CUDA_F16 "llama: use 16 bit floats for some calculations" OFF)
  74. set(LLAMA_CUDA_KQUANTS_ITER "2" CACHE STRING "llama: iters./thread per block for Q2_K/Q6_K")
  75. set(LLAMA_CUDA_PEER_MAX_BATCH_SIZE "128" CACHE STRING
  76. "llama: max. batch size for using peer access")
  77. option(LLAMA_HIPBLAS "llama: use hipBLAS" OFF)
  78. option(LLAMA_HIP_UMA "llama: use HIP unified memory architecture" OFF)
  79. option(LLAMA_CLBLAST "llama: use CLBlast" OFF)
  80. option(LLAMA_METAL "llama: use Metal" ${LLAMA_METAL_DEFAULT})
  81. option(LLAMA_METAL_NDEBUG "llama: disable Metal debugging" OFF)
  82. option(LLAMA_MPI "llama: use MPI" OFF)
  83. option(LLAMA_QKK_64 "llama: use super-block size of 64 for k-quants" OFF)
  84. option(LLAMA_BUILD_TESTS "llama: build tests" ${LLAMA_STANDALONE})
  85. option(LLAMA_BUILD_EXAMPLES "llama: build examples" ${LLAMA_STANDALONE})
  86. option(LLAMA_BUILD_SERVER "llama: build server example" ON)
  87. # Required for relocatable CMake package
  88. include(${CMAKE_CURRENT_SOURCE_DIR}/scripts/build-info.cmake)
  89. #
  90. # Compile flags
  91. #
  92. set(CMAKE_CXX_STANDARD 11)
  93. set(CMAKE_CXX_STANDARD_REQUIRED true)
  94. set(CMAKE_C_STANDARD 11)
  95. set(CMAKE_C_STANDARD_REQUIRED true)
  96. set(THREADS_PREFER_PTHREAD_FLAG ON)
  97. find_package(Threads REQUIRED)
  98. include(CheckCXXCompilerFlag)
  99. # enable libstdc++ assertions for debug builds
  100. if (CMAKE_SYSTEM_NAME MATCHES "Linux")
  101. add_compile_definitions($<$<CONFIG:Debug>:_GLIBCXX_ASSERTIONS>)
  102. endif()
  103. if (NOT MSVC)
  104. if (LLAMA_SANITIZE_THREAD)
  105. add_compile_options(-fsanitize=thread)
  106. link_libraries(-fsanitize=thread)
  107. endif()
  108. if (LLAMA_SANITIZE_ADDRESS)
  109. add_compile_options(-fsanitize=address -fno-omit-frame-pointer)
  110. link_libraries(-fsanitize=address)
  111. endif()
  112. if (LLAMA_SANITIZE_UNDEFINED)
  113. add_compile_options(-fsanitize=undefined)
  114. link_libraries(-fsanitize=undefined)
  115. endif()
  116. endif()
  117. if (APPLE AND LLAMA_ACCELERATE)
  118. find_library(ACCELERATE_FRAMEWORK Accelerate)
  119. if (ACCELERATE_FRAMEWORK)
  120. message(STATUS "Accelerate framework found")
  121. add_compile_definitions(GGML_USE_ACCELERATE)
  122. add_compile_definitions(ACCELERATE_NEW_LAPACK)
  123. add_compile_definitions(ACCELERATE_LAPACK_ILP64)
  124. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${ACCELERATE_FRAMEWORK})
  125. else()
  126. message(WARNING "Accelerate framework not found")
  127. endif()
  128. endif()
  129. if (LLAMA_METAL)
  130. find_library(FOUNDATION_LIBRARY Foundation REQUIRED)
  131. find_library(METAL_FRAMEWORK Metal REQUIRED)
  132. find_library(METALKIT_FRAMEWORK MetalKit REQUIRED)
  133. message(STATUS "Metal framework found")
  134. set(GGML_HEADERS_METAL ggml-metal.h)
  135. set(GGML_SOURCES_METAL ggml-metal.m)
  136. add_compile_definitions(GGML_USE_METAL)
  137. if (LLAMA_METAL_NDEBUG)
  138. add_compile_definitions(GGML_METAL_NDEBUG)
  139. endif()
  140. # get full path to the file
  141. #add_compile_definitions(GGML_METAL_DIR_KERNELS="${CMAKE_CURRENT_SOURCE_DIR}/")
  142. # copy ggml-metal.metal to bin directory
  143. configure_file(ggml-metal.metal ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/ggml-metal.metal COPYONLY)
  144. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS}
  145. ${FOUNDATION_LIBRARY}
  146. ${METAL_FRAMEWORK}
  147. ${METALKIT_FRAMEWORK}
  148. )
  149. endif()
  150. if (LLAMA_BLAS)
  151. if (LLAMA_STATIC)
  152. set(BLA_STATIC ON)
  153. endif()
  154. if ($(CMAKE_VERSION) VERSION_GREATER_EQUAL 3.22)
  155. set(BLA_SIZEOF_INTEGER 8)
  156. endif()
  157. set(BLA_VENDOR ${LLAMA_BLAS_VENDOR})
  158. find_package(BLAS)
  159. if (BLAS_FOUND)
  160. message(STATUS "BLAS found, Libraries: ${BLAS_LIBRARIES}")
  161. if ("${BLAS_INCLUDE_DIRS}" STREQUAL "")
  162. # BLAS_INCLUDE_DIRS is missing in FindBLAS.cmake.
  163. # see https://gitlab.kitware.com/cmake/cmake/-/issues/20268
  164. find_package(PkgConfig REQUIRED)
  165. if (${LLAMA_BLAS_VENDOR} MATCHES "Generic")
  166. pkg_check_modules(DepBLAS REQUIRED blas)
  167. elseif (${LLAMA_BLAS_VENDOR} MATCHES "OpenBLAS")
  168. pkg_check_modules(DepBLAS REQUIRED openblas)
  169. elseif (${LLAMA_BLAS_VENDOR} MATCHES "FLAME")
  170. pkg_check_modules(DepBLAS REQUIRED blis)
  171. elseif (${LLAMA_BLAS_VENDOR} MATCHES "ATLAS")
  172. pkg_check_modules(DepBLAS REQUIRED blas-atlas)
  173. elseif (${LLAMA_BLAS_VENDOR} MATCHES "FlexiBLAS")
  174. pkg_check_modules(DepBLAS REQUIRED flexiblas_api)
  175. elseif (${LLAMA_BLAS_VENDOR} MATCHES "Intel")
  176. # all Intel* libraries share the same include path
  177. pkg_check_modules(DepBLAS REQUIRED mkl-sdl)
  178. elseif (${LLAMA_BLAS_VENDOR} MATCHES "NVHPC")
  179. # this doesn't provide pkg-config
  180. # suggest to assign BLAS_INCLUDE_DIRS on your own
  181. if ("${NVHPC_VERSION}" STREQUAL "")
  182. message(WARNING "Better to set NVHPC_VERSION")
  183. else()
  184. set(DepBLAS_FOUND ON)
  185. set(DepBLAS_INCLUDE_DIRS "/opt/nvidia/hpc_sdk/${CMAKE_SYSTEM_NAME}_${CMAKE_SYSTEM_PROCESSOR}/${NVHPC_VERSION}/math_libs/include")
  186. endif()
  187. endif()
  188. if (DepBLAS_FOUND)
  189. set(BLAS_INCLUDE_DIRS ${DepBLAS_INCLUDE_DIRS})
  190. else()
  191. message(WARNING "BLAS_INCLUDE_DIRS neither been provided nor been automatically"
  192. " detected by pkgconfig, trying to find cblas.h from possible paths...")
  193. find_path(BLAS_INCLUDE_DIRS
  194. NAMES cblas.h
  195. HINTS
  196. /usr/include
  197. /usr/local/include
  198. /usr/include/openblas
  199. /opt/homebrew/opt/openblas/include
  200. /usr/local/opt/openblas/include
  201. /usr/include/x86_64-linux-gnu/openblas/include
  202. )
  203. endif()
  204. endif()
  205. message(STATUS "BLAS found, Includes: ${BLAS_INCLUDE_DIRS}")
  206. add_compile_options(${BLAS_LINKER_FLAGS})
  207. add_compile_definitions(GGML_USE_OPENBLAS)
  208. if (${BLAS_INCLUDE_DIRS} MATCHES "mkl" AND (${LLAMA_BLAS_VENDOR} MATCHES "Generic" OR ${LLAMA_BLAS_VENDOR} MATCHES "Intel"))
  209. add_compile_definitions(GGML_BLAS_USE_MKL)
  210. endif()
  211. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${BLAS_LIBRARIES})
  212. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${BLAS_INCLUDE_DIRS})
  213. else()
  214. message(WARNING "BLAS not found, please refer to "
  215. "https://cmake.org/cmake/help/latest/module/FindBLAS.html#blas-lapack-vendors"
  216. " to set correct LLAMA_BLAS_VENDOR")
  217. endif()
  218. endif()
  219. if (LLAMA_QKK_64)
  220. add_compile_definitions(GGML_QKK_64)
  221. endif()
  222. if (LLAMA_CUBLAS)
  223. cmake_minimum_required(VERSION 3.17)
  224. find_package(CUDAToolkit)
  225. if (CUDAToolkit_FOUND)
  226. message(STATUS "cuBLAS found")
  227. enable_language(CUDA)
  228. set(GGML_HEADERS_CUDA ggml-cuda.h)
  229. set(GGML_SOURCES_CUDA ggml-cuda.cu)
  230. add_compile_definitions(GGML_USE_CUBLAS)
  231. # if (LLAMA_CUDA_CUBLAS)
  232. # add_compile_definitions(GGML_CUDA_CUBLAS)
  233. # endif()
  234. if (LLAMA_CUDA_FORCE_DMMV)
  235. add_compile_definitions(GGML_CUDA_FORCE_DMMV)
  236. endif()
  237. if (LLAMA_CUDA_FORCE_MMQ)
  238. add_compile_definitions(GGML_CUDA_FORCE_MMQ)
  239. endif()
  240. add_compile_definitions(GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  241. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  242. if (DEFINED LLAMA_CUDA_DMMV_Y)
  243. add_compile_definitions(GGML_CUDA_MMV_Y=${LLAMA_CUDA_DMMV_Y}) # for backwards compatibility
  244. endif()
  245. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  246. add_compile_definitions(GGML_CUDA_F16)
  247. endif()
  248. add_compile_definitions(K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  249. add_compile_definitions(GGML_CUDA_PEER_MAX_BATCH_SIZE=${LLAMA_CUDA_PEER_MAX_BATCH_SIZE})
  250. if (LLAMA_STATIC)
  251. if (WIN32)
  252. # As of 12.3.1 CUDA Tookit for Windows does not offer a static cublas library
  253. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart_static CUDA::cublas CUDA::cublasLt)
  254. else ()
  255. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart_static CUDA::cublas_static CUDA::cublasLt_static)
  256. endif()
  257. else()
  258. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} CUDA::cudart CUDA::cublas CUDA::cublasLt)
  259. endif()
  260. if (NOT DEFINED CMAKE_CUDA_ARCHITECTURES)
  261. # 52 == lowest CUDA 12 standard
  262. # 60 == f16 CUDA intrinsics
  263. # 61 == integer CUDA intrinsics
  264. # 70 == compute capability at which unrolling a loop in mul_mat_q kernels is faster
  265. if (LLAMA_CUDA_F16 OR LLAMA_CUDA_DMMV_F16)
  266. set(CMAKE_CUDA_ARCHITECTURES "60;61;70") # needed for f16 CUDA intrinsics
  267. else()
  268. set(CMAKE_CUDA_ARCHITECTURES "52;61;70") # lowest CUDA 12 standard + lowest for integer intrinsics
  269. #set(CMAKE_CUDA_ARCHITECTURES "") # use this to compile much faster, but only F16 models work
  270. endif()
  271. endif()
  272. message(STATUS "Using CUDA architectures: ${CMAKE_CUDA_ARCHITECTURES}")
  273. else()
  274. message(WARNING "cuBLAS not found")
  275. endif()
  276. endif()
  277. if (LLAMA_MPI)
  278. cmake_minimum_required(VERSION 3.10)
  279. find_package(MPI)
  280. if (MPI_C_FOUND)
  281. message(STATUS "MPI found")
  282. set(GGML_HEADERS_MPI ggml-mpi.h)
  283. set(GGML_SOURCES_MPI ggml-mpi.c ggml-mpi.h)
  284. add_compile_definitions(GGML_USE_MPI)
  285. add_compile_definitions(${MPI_C_COMPILE_DEFINITIONS})
  286. if (NOT MSVC)
  287. add_compile_options(-Wno-cast-qual)
  288. endif()
  289. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_C_LIBRARIES})
  290. set(LLAMA_EXTRA_INCLUDES ${LLAMA_EXTRA_INCLUDES} ${MPI_C_INCLUDE_DIRS})
  291. # Even if you're only using the C header, C++ programs may bring in MPI
  292. # C++ functions, so more linkage is needed
  293. if (MPI_CXX_FOUND)
  294. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ${MPI_CXX_LIBRARIES})
  295. endif()
  296. else()
  297. message(WARNING "MPI not found")
  298. endif()
  299. endif()
  300. if (LLAMA_CLBLAST)
  301. find_package(CLBlast)
  302. if (CLBlast_FOUND)
  303. message(STATUS "CLBlast found")
  304. set(GGML_HEADERS_OPENCL ggml-opencl.h)
  305. set(GGML_SOURCES_OPENCL ggml-opencl.cpp)
  306. add_compile_definitions(GGML_USE_CLBLAST)
  307. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} clblast)
  308. else()
  309. message(WARNING "CLBlast not found")
  310. endif()
  311. endif()
  312. if (LLAMA_HIPBLAS)
  313. list(APPEND CMAKE_PREFIX_PATH /opt/rocm)
  314. if (NOT ${CMAKE_C_COMPILER_ID} MATCHES "Clang")
  315. message(WARNING "Only LLVM is supported for HIP, hint: CC=/opt/rocm/llvm/bin/clang")
  316. endif()
  317. if (NOT ${CMAKE_CXX_COMPILER_ID} MATCHES "Clang")
  318. message(WARNING "Only LLVM is supported for HIP, hint: CXX=/opt/rocm/llvm/bin/clang++")
  319. endif()
  320. find_package(hip)
  321. find_package(hipblas)
  322. find_package(rocblas)
  323. if (${hipblas_FOUND} AND ${hip_FOUND})
  324. message(STATUS "HIP and hipBLAS found")
  325. add_compile_definitions(GGML_USE_HIPBLAS GGML_USE_CUBLAS)
  326. if (LLAMA_HIP_UMA)
  327. add_compile_definitions(GGML_HIP_UMA)
  328. endif()
  329. add_library(ggml-rocm OBJECT ggml-cuda.cu ggml-cuda.h)
  330. if (BUILD_SHARED_LIBS)
  331. set_target_properties(ggml-rocm PROPERTIES POSITION_INDEPENDENT_CODE ON)
  332. endif()
  333. if (LLAMA_CUDA_FORCE_DMMV)
  334. target_compile_definitions(ggml-rocm PRIVATE GGML_CUDA_FORCE_DMMV)
  335. endif()
  336. if (LLAMA_CUDA_FORCE_MMQ)
  337. target_compile_definitions(ggml-rocm PRIVATE GGML_CUDA_FORCE_MMQ)
  338. endif()
  339. target_compile_definitions(ggml-rocm PRIVATE GGML_CUDA_DMMV_X=${LLAMA_CUDA_DMMV_X})
  340. target_compile_definitions(ggml-rocm PRIVATE GGML_CUDA_MMV_Y=${LLAMA_CUDA_MMV_Y})
  341. target_compile_definitions(ggml-rocm PRIVATE K_QUANTS_PER_ITERATION=${LLAMA_CUDA_KQUANTS_ITER})
  342. set_source_files_properties(ggml-cuda.cu PROPERTIES LANGUAGE CXX)
  343. target_link_libraries(ggml-rocm PRIVATE hip::device PUBLIC hip::host roc::rocblas roc::hipblas)
  344. if (LLAMA_STATIC)
  345. message(FATAL_ERROR "Static linking not supported for HIP/ROCm")
  346. endif()
  347. set(LLAMA_EXTRA_LIBS ${LLAMA_EXTRA_LIBS} ggml-rocm)
  348. else()
  349. message(WARNING "hipBLAS or HIP not found. Try setting CMAKE_PREFIX_PATH=/opt/rocm")
  350. endif()
  351. endif()
  352. function(get_flags CCID CCVER)
  353. set(C_FLAGS "")
  354. set(CXX_FLAGS "")
  355. if (CCID MATCHES "Clang")
  356. set(C_FLAGS -Wunreachable-code-break -Wunreachable-code-return)
  357. set(CXX_FLAGS -Wunreachable-code-break -Wunreachable-code-return -Wmissing-prototypes -Wextra-semi)
  358. if (
  359. (CCID STREQUAL "Clang" AND CCVER VERSION_GREATER_EQUAL 3.8.0) OR
  360. (CCID STREQUAL "AppleClang" AND CCVER VERSION_GREATER_EQUAL 7.3.0)
  361. )
  362. set(C_FLAGS ${C_FLAGS} -Wdouble-promotion)
  363. endif()
  364. elseif (CCID STREQUAL "GNU")
  365. set(C_FLAGS -Wdouble-promotion)
  366. set(CXX_FLAGS -Wno-array-bounds)
  367. if (CCVER VERSION_GREATER_EQUAL 7.1.0)
  368. set(CXX_FLAGS ${CXX_FLAGS} -Wno-format-truncation)
  369. endif()
  370. if (CCVER VERSION_GREATER_EQUAL 8.1.0)
  371. set(CXX_FLAGS ${CXX_FLAGS} -Wextra-semi)
  372. endif()
  373. endif()
  374. set(GF_C_FLAGS ${C_FLAGS} PARENT_SCOPE)
  375. set(GF_CXX_FLAGS ${CXX_FLAGS} PARENT_SCOPE)
  376. endfunction()
  377. if (LLAMA_ALL_WARNINGS)
  378. if (NOT MSVC)
  379. set(WARNING_FLAGS -Wall -Wextra -Wpedantic -Wcast-qual -Wno-unused-function)
  380. set(C_FLAGS -Wshadow -Wstrict-prototypes -Wpointer-arith -Wmissing-prototypes
  381. -Werror=implicit-int -Werror=implicit-function-declaration)
  382. set(CXX_FLAGS -Wmissing-declarations -Wmissing-noreturn)
  383. set(C_FLAGS ${WARNING_FLAGS} ${C_FLAGS})
  384. set(CXX_FLAGS ${WARNING_FLAGS} ${CXX_FLAGS})
  385. get_flags(${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION})
  386. add_compile_options("$<$<COMPILE_LANGUAGE:C>:${C_FLAGS};${GF_C_FLAGS}>"
  387. "$<$<COMPILE_LANGUAGE:CXX>:${CXX_FLAGS};${GF_CXX_FLAGS}>")
  388. else()
  389. # todo : msvc
  390. set(C_FLAGS "")
  391. set(CXX_FLAGS "")
  392. endif()
  393. endif()
  394. if (LLAMA_CUBLAS)
  395. set(CUDA_FLAGS ${CXX_FLAGS} -use_fast_math)
  396. if (NOT MSVC)
  397. set(CUDA_FLAGS ${CUDA_FLAGS} -Wno-pedantic)
  398. endif()
  399. if (LLAMA_ALL_WARNINGS AND NOT MSVC)
  400. set(NVCC_CMD ${CMAKE_CUDA_COMPILER} .c)
  401. if (NOT CMAKE_CUDA_HOST_COMPILER STREQUAL "")
  402. set(NVCC_CMD ${NVCC_CMD} -ccbin ${CMAKE_CUDA_HOST_COMPILER})
  403. endif()
  404. execute_process(
  405. COMMAND ${NVCC_CMD} -Xcompiler --version
  406. OUTPUT_VARIABLE CUDA_CCFULLVER
  407. ERROR_QUIET
  408. )
  409. if (NOT CUDA_CCFULLVER MATCHES clang)
  410. set(CUDA_CCID "GNU")
  411. execute_process(
  412. COMMAND ${NVCC_CMD} -Xcompiler "-dumpfullversion -dumpversion"
  413. OUTPUT_VARIABLE CUDA_CCVER
  414. ERROR_QUIET
  415. )
  416. else()
  417. if (CUDA_CCFULLVER MATCHES Apple)
  418. set(CUDA_CCID "AppleClang")
  419. else()
  420. set(CUDA_CCID "Clang")
  421. endif()
  422. string(REGEX REPLACE "^.* version ([0-9.]*).*$" "\\1" CUDA_CCVER ${CUDA_CCFULLVER})
  423. endif()
  424. message("-- CUDA host compiler is ${CUDA_CCID} ${CUDA_CCVER}")
  425. get_flags(${CUDA_CCID} ${CUDA_CCVER})
  426. list(JOIN GF_CXX_FLAGS " " CUDA_CXX_FLAGS) # pass host compiler flags as a single argument
  427. if (NOT CUDA_CXX_FLAGS STREQUAL "")
  428. set(CUDA_FLAGS ${CUDA_FLAGS} -Xcompiler ${CUDA_CXX_FLAGS})
  429. endif()
  430. endif()
  431. add_compile_options("$<$<COMPILE_LANGUAGE:CUDA>:${CUDA_FLAGS}>")
  432. endif()
  433. if (WIN32)
  434. add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
  435. if (BUILD_SHARED_LIBS)
  436. set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
  437. endif()
  438. endif()
  439. if (LLAMA_LTO)
  440. include(CheckIPOSupported)
  441. check_ipo_supported(RESULT result OUTPUT output)
  442. if (result)
  443. set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE)
  444. else()
  445. message(WARNING "IPO is not supported: ${output}")
  446. endif()
  447. endif()
  448. # this version of Apple ld64 is buggy
  449. execute_process(
  450. COMMAND ${CMAKE_C_COMPILER} ${CMAKE_EXE_LINKER_FLAGS} -Wl,-v
  451. ERROR_VARIABLE output
  452. OUTPUT_QUIET
  453. )
  454. if (output MATCHES "dyld-1015\.7")
  455. add_compile_definitions(HAVE_BUGGY_APPLE_LINKER)
  456. endif()
  457. # Architecture specific
  458. # TODO: probably these flags need to be tweaked on some architectures
  459. # feel free to update the Makefile for your architecture and send a pull request or issue
  460. message(STATUS "CMAKE_SYSTEM_PROCESSOR: ${CMAKE_SYSTEM_PROCESSOR}")
  461. if (MSVC)
  462. string(TOLOWER "${CMAKE_GENERATOR_PLATFORM}" CMAKE_GENERATOR_PLATFORM_LWR)
  463. message(STATUS "CMAKE_GENERATOR_PLATFORM: ${CMAKE_GENERATOR_PLATFORM}")
  464. else ()
  465. set(CMAKE_GENERATOR_PLATFORM_LWR "")
  466. endif ()
  467. if (NOT MSVC)
  468. if (LLAMA_STATIC)
  469. add_link_options(-static)
  470. if (MINGW)
  471. add_link_options(-static-libgcc -static-libstdc++)
  472. endif()
  473. endif()
  474. if (LLAMA_GPROF)
  475. add_compile_options(-pg)
  476. endif()
  477. endif()
  478. if ((${CMAKE_SYSTEM_PROCESSOR} MATCHES "arm") OR (${CMAKE_SYSTEM_PROCESSOR} MATCHES "aarch64") OR ("${CMAKE_GENERATOR_PLATFORM_LWR}" MATCHES "arm64"))
  479. message(STATUS "ARM detected")
  480. if (MSVC)
  481. add_compile_definitions(__ARM_NEON)
  482. add_compile_definitions(__ARM_FEATURE_FMA)
  483. add_compile_definitions(__ARM_FEATURE_DOTPROD)
  484. # add_compile_definitions(__ARM_FEATURE_FP16_VECTOR_ARITHMETIC) # MSVC doesn't support vdupq_n_f16, vld1q_f16, vst1q_f16
  485. add_compile_definitions(__aarch64__) # MSVC defines _M_ARM64 instead
  486. else()
  487. check_cxx_compiler_flag(-mfp16-format=ieee COMPILER_SUPPORTS_FP16_FORMAT_I3E)
  488. if (NOT "${COMPILER_SUPPORTS_FP16_FORMAT_I3E}" STREQUAL "")
  489. add_compile_options(-mfp16-format=ieee)
  490. endif()
  491. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv6")
  492. # Raspberry Pi 1, Zero
  493. add_compile_options(-mfpu=neon-fp-armv8 -mno-unaligned-access)
  494. endif()
  495. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv7")
  496. # Raspberry Pi 2
  497. add_compile_options(-mfpu=neon-fp-armv8 -mno-unaligned-access -funsafe-math-optimizations)
  498. endif()
  499. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "armv8")
  500. # Raspberry Pi 3, 4, Zero 2 (32-bit)
  501. add_compile_options(-mno-unaligned-access)
  502. endif()
  503. endif()
  504. elseif (${CMAKE_SYSTEM_PROCESSOR} MATCHES "^(x86_64|i686|AMD64)$" OR "${CMAKE_GENERATOR_PLATFORM_LWR}" MATCHES "^(x86_64|i686|amd64|x64)$" )
  505. message(STATUS "x86 detected")
  506. if (MSVC)
  507. # instruction set detection for MSVC only
  508. if (LLAMA_NATIVE)
  509. include(cmake/FindSIMD.cmake)
  510. endif ()
  511. if (LLAMA_AVX512)
  512. add_compile_options($<$<COMPILE_LANGUAGE:C>:/arch:AVX512>)
  513. add_compile_options($<$<COMPILE_LANGUAGE:CXX>:/arch:AVX512>)
  514. # MSVC has no compile-time flags enabling specific
  515. # AVX512 extensions, neither it defines the
  516. # macros corresponding to the extensions.
  517. # Do it manually.
  518. if (LLAMA_AVX512_VBMI)
  519. add_compile_definitions($<$<COMPILE_LANGUAGE:C>:__AVX512VBMI__>)
  520. add_compile_definitions($<$<COMPILE_LANGUAGE:CXX>:__AVX512VBMI__>)
  521. endif()
  522. if (LLAMA_AVX512_VNNI)
  523. add_compile_definitions($<$<COMPILE_LANGUAGE:C>:__AVX512VNNI__>)
  524. add_compile_definitions($<$<COMPILE_LANGUAGE:CXX>:__AVX512VNNI__>)
  525. endif()
  526. elseif (LLAMA_AVX2)
  527. add_compile_options($<$<COMPILE_LANGUAGE:C>:/arch:AVX2>)
  528. add_compile_options($<$<COMPILE_LANGUAGE:CXX>:/arch:AVX2>)
  529. elseif (LLAMA_AVX)
  530. add_compile_options($<$<COMPILE_LANGUAGE:C>:/arch:AVX>)
  531. add_compile_options($<$<COMPILE_LANGUAGE:CXX>:/arch:AVX>)
  532. endif()
  533. else()
  534. if (LLAMA_NATIVE)
  535. add_compile_options(-march=native)
  536. endif()
  537. if (LLAMA_F16C)
  538. add_compile_options(-mf16c)
  539. endif()
  540. if (LLAMA_FMA)
  541. add_compile_options(-mfma)
  542. endif()
  543. if (LLAMA_AVX)
  544. add_compile_options(-mavx)
  545. endif()
  546. if (LLAMA_AVX2)
  547. add_compile_options(-mavx2)
  548. endif()
  549. if (LLAMA_AVX512)
  550. add_compile_options(-mavx512f)
  551. add_compile_options(-mavx512bw)
  552. endif()
  553. if (LLAMA_AVX512_VBMI)
  554. add_compile_options(-mavx512vbmi)
  555. endif()
  556. if (LLAMA_AVX512_VNNI)
  557. add_compile_options(-mavx512vnni)
  558. endif()
  559. endif()
  560. elseif (${CMAKE_SYSTEM_PROCESSOR} MATCHES "ppc64")
  561. message(STATUS "PowerPC detected")
  562. if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "ppc64le")
  563. add_compile_options(-mcpu=powerpc64le)
  564. else()
  565. add_compile_options(-mcpu=native -mtune=native)
  566. #TODO: Add targets for Power8/Power9 (Altivec/VSX) and Power10(MMA) and query for big endian systems (ppc64/le/be)
  567. endif()
  568. else()
  569. message(STATUS "Unknown architecture")
  570. endif()
  571. if (MINGW)
  572. # Target Windows 8 for PrefetchVirtualMemory
  573. add_compile_definitions(_WIN32_WINNT=0x602)
  574. endif()
  575. #
  576. # POSIX conformance
  577. #
  578. # clock_gettime came in POSIX.1b (1993)
  579. # CLOCK_MONOTONIC came in POSIX.1-2001 / SUSv3 as optional
  580. # posix_memalign came in POSIX.1-2001 / SUSv3
  581. # M_PI is an XSI extension since POSIX.1-2001 / SUSv3, came in XPG1 (1985)
  582. add_compile_definitions(_XOPEN_SOURCE=600)
  583. # Somehow in OpenBSD whenever POSIX conformance is specified
  584. # some string functions rely on locale_t availability,
  585. # which was introduced in POSIX.1-2008, forcing us to go higher
  586. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  587. remove_definitions(-D_XOPEN_SOURCE=600)
  588. add_compile_definitions(_XOPEN_SOURCE=700)
  589. endif()
  590. # Data types, macros and functions related to controlling CPU affinity and
  591. # some memory allocation are available on Linux through GNU extensions in libc
  592. if (CMAKE_SYSTEM_NAME MATCHES "Linux")
  593. add_compile_definitions(_GNU_SOURCE)
  594. endif()
  595. # RLIMIT_MEMLOCK came in BSD, is not specified in POSIX.1,
  596. # and on macOS its availability depends on enabling Darwin extensions
  597. # similarly on DragonFly, enabling BSD extensions is necessary
  598. if (
  599. CMAKE_SYSTEM_NAME MATCHES "Darwin" OR
  600. CMAKE_SYSTEM_NAME MATCHES "iOS" OR
  601. CMAKE_SYSTEM_NAME MATCHES "tvOS" OR
  602. CMAKE_SYSTEM_NAME MATCHES "DragonFly"
  603. )
  604. add_compile_definitions(_DARWIN_C_SOURCE)
  605. endif()
  606. # alloca is a non-standard interface that is not visible on BSDs when
  607. # POSIX conformance is specified, but not all of them provide a clean way
  608. # to enable it in such cases
  609. if (CMAKE_SYSTEM_NAME MATCHES "FreeBSD")
  610. add_compile_definitions(__BSD_VISIBLE)
  611. endif()
  612. if (CMAKE_SYSTEM_NAME MATCHES "NetBSD")
  613. add_compile_definitions(_NETBSD_SOURCE)
  614. endif()
  615. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  616. add_compile_definitions(_BSD_SOURCE)
  617. endif()
  618. #
  619. # libraries
  620. #
  621. # ggml
  622. if (GGML_USE_CPU_HBM)
  623. add_definitions(-DGGML_USE_CPU_HBM)
  624. find_library(memkind memkind REQUIRED)
  625. endif()
  626. add_library(ggml OBJECT
  627. ggml.c
  628. ggml.h
  629. ggml-alloc.c
  630. ggml-alloc.h
  631. ggml-backend.c
  632. ggml-backend.h
  633. ggml-quants.c
  634. ggml-quants.h
  635. ${GGML_SOURCES_CUDA} ${GGML_HEADERS_CUDA}
  636. ${GGML_SOURCES_OPENCL} ${GGML_HEADERS_OPENCL}
  637. ${GGML_SOURCES_METAL} ${GGML_HEADERS_METAL}
  638. ${GGML_SOURCES_MPI} ${GGML_HEADERS_MPI}
  639. ${GGML_SOURCES_EXTRA} ${GGML_HEADERS_EXTRA}
  640. )
  641. target_include_directories(ggml PUBLIC . ${LLAMA_EXTRA_INCLUDES})
  642. target_compile_features(ggml PUBLIC c_std_11) # don't bump
  643. target_link_libraries(ggml PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  644. if (GGML_USE_CPU_HBM)
  645. target_link_libraries(ggml PUBLIC memkind)
  646. endif()
  647. add_library(ggml_static STATIC $<TARGET_OBJECTS:ggml>)
  648. if (BUILD_SHARED_LIBS)
  649. set_target_properties(ggml PROPERTIES POSITION_INDEPENDENT_CODE ON)
  650. add_library(ggml_shared SHARED $<TARGET_OBJECTS:ggml>)
  651. target_link_libraries(ggml_shared PUBLIC Threads::Threads ${LLAMA_EXTRA_LIBS})
  652. install(TARGETS ggml_shared LIBRARY)
  653. endif()
  654. # llama
  655. add_library(llama
  656. llama.cpp
  657. llama.h
  658. )
  659. target_include_directories(llama PUBLIC .)
  660. target_compile_features(llama PUBLIC cxx_std_11) # don't bump
  661. target_link_libraries(llama PRIVATE
  662. ggml
  663. ${LLAMA_EXTRA_LIBS}
  664. )
  665. if (BUILD_SHARED_LIBS)
  666. set_target_properties(llama PROPERTIES POSITION_INDEPENDENT_CODE ON)
  667. target_compile_definitions(llama PRIVATE LLAMA_SHARED LLAMA_BUILD)
  668. if (LLAMA_METAL)
  669. set_target_properties(llama PROPERTIES RESOURCE "${CMAKE_CURRENT_SOURCE_DIR}/ggml-metal.metal")
  670. endif()
  671. endif()
  672. #
  673. # install
  674. #
  675. include(GNUInstallDirs)
  676. include(CMakePackageConfigHelpers)
  677. set(LLAMA_INCLUDE_INSTALL_DIR ${CMAKE_INSTALL_INCLUDEDIR}
  678. CACHE PATH "Location of header files")
  679. set(LLAMA_LIB_INSTALL_DIR ${CMAKE_INSTALL_LIBDIR}
  680. CACHE PATH "Location of library files")
  681. set(LLAMA_BIN_INSTALL_DIR ${CMAKE_INSTALL_BINDIR}
  682. CACHE PATH "Location of binary files")
  683. set(LLAMA_BUILD_NUMBER ${BUILD_NUMBER})
  684. set(LLAMA_BUILD_COMMIT ${BUILD_COMMIT})
  685. set(LLAMA_INSTALL_VERSION 0.0.${BUILD_NUMBER})
  686. get_directory_property(LLAMA_TRANSIENT_DEFINES COMPILE_DEFINITIONS)
  687. configure_package_config_file(
  688. ${CMAKE_CURRENT_SOURCE_DIR}/scripts/LlamaConfig.cmake.in
  689. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfig.cmake
  690. INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Llama
  691. PATH_VARS LLAMA_INCLUDE_INSTALL_DIR
  692. LLAMA_LIB_INSTALL_DIR
  693. LLAMA_BIN_INSTALL_DIR )
  694. write_basic_package_version_file(
  695. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfigVersion.cmake
  696. VERSION ${LLAMA_INSTALL_VERSION}
  697. COMPATIBILITY SameMajorVersion)
  698. install(FILES ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfig.cmake
  699. ${CMAKE_CURRENT_BINARY_DIR}/LlamaConfigVersion.cmake
  700. DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/Llama)
  701. set(GGML_PUBLIC_HEADERS "ggml.h"
  702. "${GGML_HEADERS_CUDA}" "${GGML_HEADERS_OPENCL}"
  703. "${GGML_HEADERS_METAL}" "${GGML_HEADERS_MPI}" "${GGML_HEADERS_EXTRA}")
  704. set_target_properties(ggml PROPERTIES PUBLIC_HEADER "${GGML_PUBLIC_HEADERS}")
  705. install(TARGETS ggml PUBLIC_HEADER)
  706. set_target_properties(llama PROPERTIES PUBLIC_HEADER ${CMAKE_CURRENT_SOURCE_DIR}/llama.h)
  707. install(TARGETS llama LIBRARY PUBLIC_HEADER)
  708. install(
  709. FILES convert.py
  710. PERMISSIONS
  711. OWNER_READ
  712. OWNER_WRITE
  713. OWNER_EXECUTE
  714. GROUP_READ
  715. GROUP_EXECUTE
  716. WORLD_READ
  717. WORLD_EXECUTE
  718. DESTINATION ${CMAKE_INSTALL_BINDIR})
  719. install(
  720. FILES convert-lora-to-ggml.py
  721. PERMISSIONS
  722. OWNER_READ
  723. OWNER_WRITE
  724. OWNER_EXECUTE
  725. GROUP_READ
  726. GROUP_EXECUTE
  727. WORLD_READ
  728. WORLD_EXECUTE
  729. DESTINATION ${CMAKE_INSTALL_BINDIR})
  730. if (LLAMA_METAL)
  731. install(
  732. FILES ggml-metal.metal
  733. PERMISSIONS
  734. OWNER_READ
  735. OWNER_WRITE
  736. GROUP_READ
  737. WORLD_READ
  738. DESTINATION ${CMAKE_INSTALL_BINDIR})
  739. endif()
  740. #
  741. # programs, examples and tests
  742. #
  743. add_subdirectory(common)
  744. if (LLAMA_BUILD_TESTS AND NOT CMAKE_JS_VERSION)
  745. include(CTest)
  746. add_subdirectory(tests)
  747. endif ()
  748. if (LLAMA_BUILD_EXAMPLES)
  749. add_subdirectory(examples)
  750. add_subdirectory(pocs)
  751. endif()