CMakeLists.txt 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345
  1. include(CheckCXXCompilerFlag)
  2. include("../cmake/common.cmake")
  3. add_compile_definitions(GGML_SCHED_MAX_COPIES=${GGML_SCHED_MAX_COPIES})
  4. # enable libstdc++ assertions for debug builds
  5. if (CMAKE_SYSTEM_NAME MATCHES "Linux")
  6. add_compile_definitions($<$<CONFIG:Debug>:_GLIBCXX_ASSERTIONS>)
  7. endif()
  8. if (NOT MSVC)
  9. if (GGML_SANITIZE_THREAD)
  10. add_compile_options(-fsanitize=thread)
  11. link_libraries (-fsanitize=thread)
  12. endif()
  13. if (GGML_SANITIZE_ADDRESS)
  14. add_compile_options(-fsanitize=address -fno-omit-frame-pointer)
  15. link_libraries (-fsanitize=address)
  16. endif()
  17. if (GGML_SANITIZE_UNDEFINED)
  18. add_compile_options(-fsanitize=undefined)
  19. link_libraries (-fsanitize=undefined)
  20. endif()
  21. endif()
  22. if (GGML_FATAL_WARNINGS)
  23. if (CMAKE_CXX_COMPILER_ID MATCHES "GNU" OR CMAKE_CXX_COMPILER_ID MATCHES "Clang")
  24. list(APPEND C_FLAGS -Werror)
  25. list(APPEND CXX_FLAGS -Werror)
  26. elseif (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
  27. add_compile_options(/WX)
  28. endif()
  29. endif()
  30. if (GGML_ALL_WARNINGS)
  31. if (NOT MSVC)
  32. list(APPEND WARNING_FLAGS -Wall -Wextra -Wpedantic -Wcast-qual -Wno-unused-function)
  33. list(APPEND C_FLAGS -Wshadow -Wstrict-prototypes -Wpointer-arith -Wmissing-prototypes
  34. -Werror=implicit-int -Werror=implicit-function-declaration)
  35. list(APPEND CXX_FLAGS -Wmissing-declarations -Wmissing-noreturn)
  36. list(APPEND C_FLAGS ${WARNING_FLAGS})
  37. list(APPEND CXX_FLAGS ${WARNING_FLAGS})
  38. ggml_get_flags(${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION})
  39. add_compile_options("$<$<COMPILE_LANGUAGE:C>:${C_FLAGS};${GF_C_FLAGS}>"
  40. "$<$<COMPILE_LANGUAGE:CXX>:${CXX_FLAGS};${GF_CXX_FLAGS}>")
  41. else()
  42. # todo : msvc
  43. set(C_FLAGS "")
  44. set(CXX_FLAGS "")
  45. endif()
  46. endif()
  47. if (GGML_LTO)
  48. include(CheckIPOSupported)
  49. check_ipo_supported(RESULT result OUTPUT output)
  50. if (result)
  51. set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE)
  52. else()
  53. message(WARNING "IPO is not supported: ${output}")
  54. endif()
  55. endif()
  56. if (GGML_CCACHE AND NOT CMAKE_C_COMPILER_LAUNCHER AND NOT CMAKE_CXX_COMPILER_LAUNCHER)
  57. find_program(GGML_CCACHE_FOUND ccache)
  58. find_program(GGML_SCCACHE_FOUND sccache)
  59. if (GGML_CCACHE_FOUND OR GGML_SCCACHE_FOUND)
  60. if(GGML_CCACHE_FOUND)
  61. set(GGML_CCACHE_VARIANT ccache)
  62. else()
  63. set(GGML_CCACHE_VARIANT sccache)
  64. endif()
  65. # TODO: should not be set globally
  66. if (GGML_SYCL AND GGML_CCACHE_FOUND AND WIN32)
  67. set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE "ccache compiler_type=icl")
  68. else ()
  69. set_property(GLOBAL PROPERTY RULE_LAUNCH_COMPILE "${GGML_CCACHE_VARIANT}")
  70. endif ()
  71. set(ENV{CCACHE_SLOPPINESS} time_macros)
  72. message(STATUS "${GGML_CCACHE_VARIANT} found, compilation results will be cached. Disable with GGML_CCACHE=OFF.")
  73. else()
  74. message(STATUS "Warning: ccache not found - consider installing it for faster compilation or disable this warning with GGML_CCACHE=OFF")
  75. endif ()
  76. endif()
  77. # this version of Apple ld64 is buggy
  78. execute_process(
  79. COMMAND ${CMAKE_C_COMPILER} ${CMAKE_EXE_LINKER_FLAGS} -Wl,-v
  80. ERROR_VARIABLE output
  81. OUTPUT_QUIET
  82. )
  83. if (output MATCHES "dyld-1015\.7")
  84. add_compile_definitions(HAVE_BUGGY_APPLE_LINKER)
  85. endif()
  86. # architecture specific
  87. # TODO: probably these flags need to be tweaked on some architectures
  88. # feel free to update the Makefile for your architecture and send a pull request or issue
  89. message(STATUS "CMAKE_SYSTEM_PROCESSOR: ${CMAKE_SYSTEM_PROCESSOR}")
  90. if (MSVC)
  91. string(TOLOWER "${CMAKE_GENERATOR_PLATFORM}" CMAKE_GENERATOR_PLATFORM_LWR)
  92. message(STATUS "CMAKE_GENERATOR_PLATFORM: ${CMAKE_GENERATOR_PLATFORM}")
  93. else ()
  94. set(CMAKE_GENERATOR_PLATFORM_LWR "")
  95. endif ()
  96. if (NOT MSVC)
  97. if (GGML_STATIC)
  98. add_link_options(-static)
  99. if (MINGW)
  100. add_link_options(-static-libgcc -static-libstdc++)
  101. endif()
  102. endif()
  103. if (GGML_GPROF)
  104. add_compile_options(-pg)
  105. endif()
  106. endif()
  107. if (MINGW)
  108. # Target Windows 8 for PrefetchVirtualMemory
  109. add_compile_definitions(_WIN32_WINNT=${GGML_WIN_VER})
  110. endif()
  111. #
  112. # POSIX conformance
  113. #
  114. # clock_gettime came in POSIX.1b (1993)
  115. # CLOCK_MONOTONIC came in POSIX.1-2001 / SUSv3 as optional
  116. # posix_memalign came in POSIX.1-2001 / SUSv3
  117. # M_PI is an XSI extension since POSIX.1-2001 / SUSv3, came in XPG1 (1985)
  118. # Somehow in OpenBSD whenever POSIX conformance is specified
  119. # some string functions rely on locale_t availability,
  120. # which was introduced in POSIX.1-2008, forcing us to go higher
  121. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  122. add_compile_definitions(_XOPEN_SOURCE=700)
  123. else()
  124. add_compile_definitions(_XOPEN_SOURCE=600)
  125. endif()
  126. # Data types, macros and functions related to controlling CPU affinity and
  127. # some memory allocation are available on Linux through GNU extensions in libc
  128. if (CMAKE_SYSTEM_NAME MATCHES "Linux" OR CMAKE_SYSTEM_NAME MATCHES "Android")
  129. add_compile_definitions(_GNU_SOURCE)
  130. endif()
  131. # RLIMIT_MEMLOCK came in BSD, is not specified in POSIX.1,
  132. # and on macOS its availability depends on enabling Darwin extensions
  133. # similarly on DragonFly, enabling BSD extensions is necessary
  134. if (
  135. CMAKE_SYSTEM_NAME MATCHES "Darwin" OR
  136. CMAKE_SYSTEM_NAME MATCHES "iOS" OR
  137. CMAKE_SYSTEM_NAME MATCHES "tvOS" OR
  138. CMAKE_SYSTEM_NAME MATCHES "DragonFly"
  139. )
  140. add_compile_definitions(_DARWIN_C_SOURCE)
  141. endif()
  142. # alloca is a non-standard interface that is not visible on BSDs when
  143. # POSIX conformance is specified, but not all of them provide a clean way
  144. # to enable it in such cases
  145. if (CMAKE_SYSTEM_NAME MATCHES "FreeBSD")
  146. add_compile_definitions(__BSD_VISIBLE)
  147. endif()
  148. if (CMAKE_SYSTEM_NAME MATCHES "NetBSD")
  149. add_compile_definitions(_NETBSD_SOURCE)
  150. endif()
  151. if (CMAKE_SYSTEM_NAME MATCHES "OpenBSD")
  152. add_compile_definitions(_BSD_SOURCE)
  153. endif()
  154. if (WIN32)
  155. add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
  156. endif()
  157. # ggml
  158. if (GGML_BACKEND_DL AND NOT BUILD_SHARED_LIBS)
  159. message(FATAL_ERROR "GGML_BACKEND_DL requires BUILD_SHARED_LIBS")
  160. endif()
  161. add_library(ggml-base
  162. ../include/ggml.h
  163. ../include/ggml-alloc.h
  164. ../include/ggml-backend.h
  165. ../include/ggml-cpp.h
  166. ../include/ggml-opt.h
  167. ../include/gguf.h
  168. ggml.c
  169. ggml-alloc.c
  170. ggml-backend.cpp
  171. ggml-opt.cpp
  172. ggml-threading.cpp
  173. ggml-threading.h
  174. ggml-quants.c
  175. ggml-quants.h
  176. gguf.cpp)
  177. target_include_directories(ggml-base PRIVATE .)
  178. if (GGML_BACKEND_DL)
  179. target_compile_definitions(ggml-base PUBLIC GGML_BACKEND_DL)
  180. endif()
  181. add_library(ggml
  182. ggml-backend-reg.cpp)
  183. target_link_libraries(ggml PUBLIC ggml-base)
  184. if (CMAKE_SYSTEM_NAME MATCHES "Linux")
  185. target_link_libraries(ggml PRIVATE dl)
  186. endif()
  187. function(ggml_add_backend_library backend)
  188. if (GGML_BACKEND_DL)
  189. add_library(${backend} MODULE ${ARGN})
  190. # write the shared library to the output directory
  191. set_target_properties(${backend} PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${CMAKE_RUNTIME_OUTPUT_DIRECTORY})
  192. target_compile_definitions(${backend} PRIVATE GGML_BACKEND_DL)
  193. add_dependencies(ggml ${backend})
  194. else()
  195. add_library(${backend} ${ARGN})
  196. target_link_libraries(ggml PUBLIC ${backend})
  197. install(TARGETS ${backend} LIBRARY)
  198. endif()
  199. target_link_libraries(${backend} PRIVATE ggml-base)
  200. target_include_directories(${backend} PRIVATE ..)
  201. if (${BUILD_SHARED_LIBS})
  202. target_compile_definitions(${backend} PRIVATE GGML_BACKEND_BUILD)
  203. target_compile_definitions(${backend} PUBLIC GGML_BACKEND_SHARED)
  204. endif()
  205. if(NOT GGML_AVAILABLE_BACKENDS)
  206. set(GGML_AVAILABLE_BACKENDS "${backend}"
  207. CACHE INTERNAL "List of backends for cmake package")
  208. else()
  209. list(FIND GGML_AVAILABLE_BACKENDS "${backend}" has_backend)
  210. if(has_backend EQUAL -1)
  211. set(GGML_AVAILABLE_BACKENDS "${GGML_AVAILABLE_BACKENDS};${backend}"
  212. CACHE INTERNAL "List of backends for cmake package")
  213. endif()
  214. endif()
  215. endfunction()
  216. function(ggml_add_backend backend)
  217. string(TOUPPER "GGML_${backend}" backend_id)
  218. if (${backend_id})
  219. string(TOLOWER "ggml-${backend}" backend_target)
  220. add_subdirectory(${backend_target})
  221. message(STATUS "Including ${backend} backend")
  222. if (NOT GGML_BACKEND_DL)
  223. string(TOUPPER "GGML_USE_${backend}" backend_use)
  224. target_compile_definitions(ggml PUBLIC ${backend_use})
  225. endif()
  226. endif()
  227. endfunction()
  228. function(ggml_add_cpu_backend_variant tag_name)
  229. set(GGML_CPU_TAG_NAME ${tag_name})
  230. # other: OPENMP LLAMAFILE CPU_HBM
  231. foreach (feat NATIVE
  232. SSE42
  233. AVX AVX2 BMI2 AVX_VNNI FMA F16C
  234. AVX512 AVX512_VBMI AVX512_VNNI AVX512_BF16
  235. AMX_TILE AMX_INT8 AMX_BF16)
  236. set(GGML_${feat} OFF)
  237. endforeach()
  238. foreach (feat ${ARGN})
  239. set(GGML_${feat} ON)
  240. endforeach()
  241. ggml_add_cpu_backend_variant_impl(${tag_name})
  242. endfunction()
  243. ggml_add_backend(CPU)
  244. if (GGML_CPU_ALL_VARIANTS)
  245. if (NOT GGML_BACKEND_DL)
  246. message(FATAL_ERROR "GGML_CPU_ALL_VARIANTS requires GGML_BACKEND_DL")
  247. endif()
  248. ggml_add_cpu_backend_variant(x64)
  249. ggml_add_cpu_backend_variant(sse42 SSE42)
  250. ggml_add_cpu_backend_variant(sandybridge SSE42 AVX)
  251. ggml_add_cpu_backend_variant(haswell SSE42 AVX F16C AVX2 BMI2 FMA)
  252. ggml_add_cpu_backend_variant(skylakex SSE42 AVX F16C AVX2 BMI2 FMA AVX512)
  253. ggml_add_cpu_backend_variant(icelake SSE42 AVX F16C AVX2 BMI2 FMA AVX512 AVX512_VBMI AVX512_VNNI)
  254. ggml_add_cpu_backend_variant(alderlake SSE42 AVX F16C AVX2 BMI2 FMA AVX_VNNI)
  255. if (NOT MSVC)
  256. # MSVC doesn't support AMX
  257. ggml_add_cpu_backend_variant(sapphirerapids SSE42 AVX F16C AVX2 BMI2 FMA AVX512 AVX512_VBMI AVX512_VNNI AVX512_BF16 AMX_TILE AMX_INT8)
  258. endif()
  259. elseif (GGML_CPU)
  260. ggml_add_cpu_backend_variant_impl("")
  261. endif()
  262. ggml_add_backend(BLAS)
  263. ggml_add_backend(CANN)
  264. ggml_add_backend(CUDA)
  265. ggml_add_backend(HIP)
  266. ggml_add_backend(Kompute)
  267. ggml_add_backend(METAL)
  268. ggml_add_backend(MUSA)
  269. ggml_add_backend(RPC)
  270. ggml_add_backend(SYCL)
  271. ggml_add_backend(Vulkan)
  272. ggml_add_backend(OpenCL)
  273. foreach (target ggml-base ggml)
  274. target_include_directories(${target} PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/../include> $<INSTALL_INTERFACE:include>)
  275. target_compile_features (${target} PRIVATE c_std_11 cxx_std_17) # don't bump
  276. endforeach()
  277. target_link_libraries(ggml-base PRIVATE Threads::Threads)
  278. find_library(MATH_LIBRARY m)
  279. if (MATH_LIBRARY)
  280. if (NOT WIN32 OR NOT DEFINED ENV{ONEAPI_ROOT})
  281. target_link_libraries(ggml-base PRIVATE m)
  282. endif()
  283. endif()
  284. if (CMAKE_SYSTEM_NAME MATCHES "Android")
  285. target_link_libraries(ggml-base PRIVATE dl)
  286. endif()
  287. if(CMAKE_SYSTEM_NAME MATCHES "visionOS")
  288. target_compile_definitions(ggml-base PUBLIC _DARWIN_C_SOURCE)
  289. endif()
  290. if (BUILD_SHARED_LIBS)
  291. foreach (target ggml-base ggml)
  292. set_target_properties(${target} PROPERTIES POSITION_INDEPENDENT_CODE ON)
  293. target_compile_definitions(${target} PRIVATE GGML_BUILD)
  294. target_compile_definitions(${target} PUBLIC GGML_SHARED)
  295. endforeach()
  296. endif()