CMakeLists.txt 31 KB

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