Determine-Compiler-NDK.cmake 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259
  1. # Distributed under the OSI-approved BSD 3-Clause License. See accompanying
  2. # file Copyright.txt or https://cmake.org/licensing for details.
  3. # In Android NDK releases there is build system toolchain selection logic in
  4. # these files:
  5. #
  6. # * <ndk>/build/core/init.mk
  7. # * <ndk>/build/core/setup-toolchain.mk
  8. # * <ndk>/[build/core/]toolchains/<toolchain>/{config.mk,setup.mk}
  9. #
  10. # We parse information out of the ``config.mk`` and ``setup.mk`` files below.
  11. #
  12. # There is also a "toolchains" directory with the prebuilt toolchains themselves:
  13. #
  14. # * <triple-or-arch>-<gcc-version>/prebuilt/<host>/bin/<triple>-gcc(.exe)?
  15. # The gcc compiler to be invoked.
  16. #
  17. # * llvm*/prebuilt/<host>/bin/clang
  18. # The clang compiler to be invoked with flags:
  19. # -target <triple>
  20. # -gcc-toolchain <ndk>/toolchains/<triple-or-arch>-<gcc-version>
  21. # Glob available toolchains in the NDK, restricted by any version request.
  22. if(CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION STREQUAL "clang")
  23. set(_ANDROID_TOOL_PATTERNS "*-clang" "*-clang[0-9].[0-9]")
  24. elseif(CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION)
  25. if(NOT CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION MATCHES "^(clang)?[0-9]\\.[0-9]$")
  26. message(FATAL_ERROR
  27. "Android: The CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION value '${CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION}' "
  28. "is not one of the allowed forms:\n"
  29. " <major>.<minor> = GCC of specified version\n"
  30. " clang<major>.<minor> = Clang of specified version\n"
  31. " clang = Clang of most recent available version\n"
  32. )
  33. endif()
  34. set(_ANDROID_TOOL_PATTERNS "*-${CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION}")
  35. else()
  36. set(_ANDROID_TOOL_PATTERNS "*-[0-9].[0-9]")
  37. endif()
  38. set(_ANDROID_CONFIG_MK_PATTERNS)
  39. foreach(base "build/core/toolchains" "toolchains")
  40. foreach(pattern IN LISTS _ANDROID_TOOL_PATTERNS)
  41. list(APPEND _ANDROID_CONFIG_MK_PATTERNS
  42. "${CMAKE_ANDROID_NDK}/${base}/${pattern}/config.mk"
  43. )
  44. endforeach()
  45. endforeach()
  46. unset(_ANDROID_TOOL_PATTERNS)
  47. file(GLOB _ANDROID_CONFIG_MKS ${_ANDROID_CONFIG_MK_PATTERNS})
  48. unset(_ANDROID_CONFIG_MK_PATTERNS)
  49. # Find the newest toolchain version matching the ABI.
  50. set(_ANDROID_TOOL_NAME "")
  51. set(_ANDROID_TOOL_VERS 0)
  52. set(_ANDROID_TOOL_VERS_NDK "")
  53. set(_ANDROID_TOOL_SETUP_MK "")
  54. foreach(config_mk IN LISTS _ANDROID_CONFIG_MKS)
  55. # Check that the toolchain matches the ABI.
  56. file(STRINGS "${config_mk}" _ANDROID_TOOL_ABIS REGEX "^TOOLCHAIN_ABIS :=.* ${CMAKE_ANDROID_ARCH_ABI}( |$)")
  57. if(NOT _ANDROID_TOOL_ABIS)
  58. continue()
  59. endif()
  60. unset(_ANDROID_TOOL_ABIS)
  61. # Check the version.
  62. if("${config_mk}" MATCHES [[/([^/]+-((clang)?([0-9]\.[0-9]|)))/config.mk$]])
  63. set(_ANDROID_CUR_NAME "${CMAKE_MATCH_1}")
  64. set(_ANDROID_CUR_VERS "${CMAKE_MATCH_4}")
  65. set(_ANDROID_CUR_VERS_NDK "${CMAKE_MATCH_2}")
  66. if(_ANDROID_TOOL_VERS STREQUAL "")
  67. # already the latest possible
  68. elseif(_ANDROID_CUR_VERS STREQUAL "" OR _ANDROID_CUR_VERS VERSION_GREATER _ANDROID_TOOL_VERS)
  69. set(_ANDROID_TOOL_NAME "${_ANDROID_CUR_NAME}")
  70. set(_ANDROID_TOOL_VERS "${_ANDROID_CUR_VERS}")
  71. set(_ANDROID_TOOL_VERS_NDK "${_ANDROID_CUR_VERS_NDK}")
  72. string(REPLACE "/config.mk" "/setup.mk" _ANDROID_TOOL_SETUP_MK "${config_mk}")
  73. endif()
  74. unset(_ANDROID_CUR_TOOL)
  75. unset(_ANDROID_CUR_VERS)
  76. unset(_ANDROID_CUR_VERS_NDK)
  77. endif()
  78. endforeach()
  79. # Verify that we have a suitable toolchain.
  80. if(NOT _ANDROID_TOOL_NAME)
  81. if(_ANDROID_CONFIG_MKS)
  82. string(REPLACE ";" "\n " _ANDROID_TOOLS_MSG "after considering:;${_ANDROID_CONFIG_MKS}")
  83. else()
  84. set(_ANDROID_TOOLS_MSG "")
  85. endif()
  86. if(CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION)
  87. string(CONCAT _ANDROID_TOOLS_MSG
  88. "of the version specified by CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION:\n"
  89. " ${CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION}\n"
  90. "${_ANDROID_TOOLS_MSG}")
  91. endif()
  92. message(FATAL_ERROR
  93. "Android: No toolchain for ABI '${CMAKE_ANDROID_ARCH_ABI}' found in the NDK:\n"
  94. " ${CMAKE_ANDROID_NDK}\n"
  95. "${_ANDROID_TOOLS_MSG}"
  96. )
  97. endif()
  98. unset(_ANDROID_CONFIG_MKS)
  99. # For clang toolchains we still need to find a gcc toolchain.
  100. if(_ANDROID_TOOL_NAME MATCHES "-clang")
  101. set(_ANDROID_TOOL_CLANG_NAME "${_ANDROID_TOOL_NAME}")
  102. set(_ANDROID_TOOL_CLANG_VERS "${_ANDROID_TOOL_VERS}")
  103. set(_ANDROID_TOOL_NAME "")
  104. set(_ANDROID_TOOL_VERS "")
  105. else()
  106. set(_ANDROID_TOOL_CLANG_NAME "")
  107. set(_ANDROID_TOOL_CLANG_VERS "")
  108. endif()
  109. # Parse the toolchain setup.mk file to extract information we need.
  110. # Their content is not standardized across toolchains or NDK versions,
  111. # so we match known cases. Note that the parsing is stateful across
  112. # lines because we need to substitute for some Make variable references.
  113. if(CMAKE_ANDROID_NDK_TOOLCHAIN_DEBUG)
  114. message(STATUS "loading: ${_ANDROID_TOOL_SETUP_MK}")
  115. endif()
  116. file(STRINGS "${_ANDROID_TOOL_SETUP_MK}" _ANDROID_TOOL_SETUP REGEX "^(LLVM|TOOLCHAIN)_[A-Z_]+ +:= +.*$")
  117. unset(_ANDROID_TOOL_SETUP_MK)
  118. set(_ANDROID_TOOL_PREFIX "")
  119. set(_ANDROID_TOOL_NAME_ONLY "")
  120. set(_ANDROID_TOOL_LLVM_NAME "llvm")
  121. set(_ANDROID_TOOL_LLVM_VERS "")
  122. foreach(line IN LISTS _ANDROID_TOOL_SETUP)
  123. if(CMAKE_ANDROID_NDK_TOOLCHAIN_DEBUG)
  124. message(STATUS "setup.mk: ${line}")
  125. endif()
  126. if(line MATCHES [[^TOOLCHAIN_PREFIX +:= +.*/bin/([^$/ ]*) *$]])
  127. # We just matched the toolchain prefix with no Make variable references.
  128. set(_ANDROID_TOOL_PREFIX "${CMAKE_MATCH_1}")
  129. elseif(_ANDROID_TOOL_CLANG_NAME)
  130. # For clang toolchains we need to find more information.
  131. if(line MATCHES [[^TOOLCHAIN_VERSION +:= +([0-9.]+) *$]])
  132. # We just matched the gcc toolchain version number. Save it for later.
  133. set(_ANDROID_TOOL_VERS "${CMAKE_MATCH_1}")
  134. elseif(line MATCHES [[^TOOLCHAIN_NAME +:= +(.*\$\(TOOLCHAIN_VERSION\)) *$]])
  135. # We just matched the gcc toolchain name with a version number placeholder, so substitute it.
  136. # The gcc toolchain version number will have already been extracted from a TOOLCHAIN_VERSION line.
  137. string(REPLACE "$(TOOLCHAIN_VERSION)" "${_ANDROID_TOOL_VERS}" _ANDROID_TOOL_NAME "${CMAKE_MATCH_1}")
  138. elseif(line MATCHES [[^TOOLCHAIN_NAME +:= +([^$/ ]+) *$]])
  139. # We just matched the gcc toolchain name without version number. Save it for later.
  140. set(_ANDROID_TOOL_NAME_ONLY "${CMAKE_MATCH_1}")
  141. elseif(line MATCHES [[^TOOLCHAIN_PREFIX +:= +.*/bin/(\$\(TOOLCHAIN_NAME\)-) *$]])
  142. # We just matched the toolchain prefix with a name placholder, so substitute it.
  143. # The gcc toolchain name will have already been extracted without version number from a TOOLCHAIN_NAME line.
  144. string(REPLACE "$(TOOLCHAIN_NAME)" "${_ANDROID_TOOL_NAME_ONLY}" _ANDROID_TOOL_PREFIX "${CMAKE_MATCH_1}")
  145. elseif(line MATCHES [[^LLVM_VERSION +:= +([0-9.]+)$]])
  146. # We just matched the llvm prebuilt binary toolchain version number. Save it for later.
  147. set(_ANDROID_TOOL_LLVM_VERS "${CMAKE_MATCH_1}")
  148. elseif(line MATCHES [[^LLVM_NAME +:= +(llvm-\$\(LLVM_VERSION\)) *$]])
  149. # We just matched the llvm prebuilt binary toolchain directory name with a version number placeholder,
  150. # so substitute it. The llvm prebuilt binary toolchain version number will have already been extracted
  151. # from a LLVM_VERSION line.
  152. string(REPLACE "$(LLVM_VERSION)" "${_ANDROID_TOOL_LLVM_VERS}" _ANDROID_TOOL_LLVM_NAME "${CMAKE_MATCH_1}")
  153. elseif(line MATCHES [[^LLVM_TOOLCHAIN_PREBUILT_ROOT +:= +\$\(call get-toolchain-root.*,([^$ ]+)\) *$]])
  154. # We just matched the llvm prebuilt binary toolchain directory name.
  155. set(_ANDROID_TOOL_LLVM_NAME "${CMAKE_MATCH_1}")
  156. elseif(line MATCHES [[^TOOLCHAIN_ROOT +:= +\$\(call get-toolchain-root.*,(\$\(TOOLCHAIN_NAME\)-[0-9.]+)\) *$]])
  157. # We just matched a placeholder for the name followed by a version number.
  158. # The gcc toolchain name will have already been extracted without version number from a TOOLCHAIN_NAME line.
  159. # Substitute for the placeholder to get the full gcc toolchain name.
  160. string(REPLACE "$(TOOLCHAIN_NAME)" "${_ANDROID_TOOL_NAME_ONLY}" _ANDROID_TOOL_NAME "${CMAKE_MATCH_1}")
  161. elseif(line MATCHES [[^TOOLCHAIN_ROOT +:= +\$\(call get-toolchain-root.*,([^$ ]+)\) *$]])
  162. # We just matched the full gcc toolchain name without placeholder.
  163. set(_ANDROID_TOOL_NAME "${CMAKE_MATCH_1}")
  164. endif()
  165. endif()
  166. endforeach()
  167. unset(_ANDROID_TOOL_NAME_ONLY)
  168. unset(_ANDROID_TOOL_LLVM_VERS)
  169. unset(_ANDROID_TOOL_SETUP)
  170. # Fall back to parsing the version and prefix from the tool name.
  171. if(NOT _ANDROID_TOOL_VERS AND "${_ANDROID_TOOL_NAME}" MATCHES "-([0-9.]+)$")
  172. set(_ANDROID_TOOL_VERS "${CMAKE_MATCH_1}")
  173. endif()
  174. if(NOT _ANDROID_TOOL_PREFIX AND "${_ANDROID_TOOL_NAME}" MATCHES "^(.*-)[0-9.]+$")
  175. set(_ANDROID_TOOL_PREFIX "${CMAKE_MATCH_1}")
  176. endif()
  177. # Identify the host platform.
  178. if(CMAKE_HOST_SYSTEM_NAME STREQUAL "Darwin")
  179. if(CMAKE_HOST_SYSTEM_PROCESSOR STREQUAL "x86_64")
  180. set(_ANDROID_HOST_DIR "darwin-x86_64")
  181. else()
  182. set(_ANDROID_HOST_DIR "darwin-x86")
  183. endif()
  184. elseif(CMAKE_HOST_SYSTEM_NAME STREQUAL "Linux")
  185. if(CMAKE_HOST_SYSTEM_PROCESSOR STREQUAL "x86_64")
  186. set(_ANDROID_HOST_DIR "linux-x86_64")
  187. else()
  188. set(_ANDROID_HOST_DIR "linux-x86")
  189. endif()
  190. elseif(CMAKE_HOST_SYSTEM_NAME STREQUAL "Windows")
  191. if(CMAKE_HOST_SYSTEM_PROCESSOR STREQUAL "AMD64")
  192. set(_ANDROID_HOST_DIR "windows-x86_64")
  193. else()
  194. set(_ANDROID_HOST_DIR "windows")
  195. endif()
  196. else()
  197. message(FATAL_ERROR "Android: Builds hosted on '${CMAKE_HOST_SYSTEM_NAME}' not supported.")
  198. endif()
  199. # Help CMakeFindBinUtils locate things.
  200. set(_CMAKE_TOOLCHAIN_PREFIX "${_ANDROID_TOOL_PREFIX}")
  201. set(_ANDROID_TOOL_NDK_TOOLCHAIN_HOST_TAG "${_ANDROID_HOST_DIR}")
  202. set(_ANDROID_TOOL_NDK_TOOLCHAIN_VERSION "${_ANDROID_TOOL_VERS_NDK}")
  203. # _ANDROID_TOOL_PREFIX should now match `gcc -dumpmachine`.
  204. string(REGEX REPLACE "-$" "" _ANDROID_TOOL_C_TOOLCHAIN_MACHINE "${_ANDROID_TOOL_PREFIX}")
  205. set(_ANDROID_TOOL_C_TOOLCHAIN_VERSION "${_ANDROID_TOOL_VERS}")
  206. set(_ANDROID_TOOL_C_TOOLCHAIN_PREFIX "${CMAKE_ANDROID_NDK}/toolchains/${_ANDROID_TOOL_NAME}/prebuilt/${_ANDROID_HOST_DIR}/bin/${_ANDROID_TOOL_PREFIX}")
  207. set(_ANDROID_TOOL_C_TOOLCHAIN_SUFFIX "${_ANDROID_HOST_EXT}")
  208. set(_ANDROID_TOOL_CXX_TOOLCHAIN_MACHINE "${_ANDROID_TOOL_C_TOOLCHAIN_MACHINE}")
  209. set(_ANDROID_TOOL_CXX_TOOLCHAIN_VERSION "${_ANDROID_TOOL_C_TOOLCHAIN_VERSION}")
  210. set(_ANDROID_TOOL_CXX_TOOLCHAIN_PREFIX "${_ANDROID_TOOL_C_TOOLCHAIN_PREFIX}")
  211. set(_ANDROID_TOOL_CXX_TOOLCHAIN_SUFFIX "${_ANDROID_TOOL_C_TOOLCHAIN_SUFFIX}")
  212. if(_ANDROID_TOOL_CLANG_NAME)
  213. message(STATUS "Android: Selected Clang toolchain '${_ANDROID_TOOL_CLANG_NAME}' with GCC toolchain '${_ANDROID_TOOL_NAME}'")
  214. set(_ANDROID_TOOL_C_COMPILER "${CMAKE_ANDROID_NDK}/toolchains/${_ANDROID_TOOL_LLVM_NAME}/prebuilt/${_ANDROID_HOST_DIR}/bin/clang${_ANDROID_HOST_EXT}")
  215. set(_ANDROID_TOOL_C_COMPILER_EXTERNAL_TOOLCHAIN ${CMAKE_ANDROID_NDK}/toolchains/${_ANDROID_TOOL_NAME}/prebuilt/${_ANDROID_HOST_DIR})
  216. set(_ANDROID_TOOL_CXX_COMPILER "${CMAKE_ANDROID_NDK}/toolchains/${_ANDROID_TOOL_LLVM_NAME}/prebuilt/${_ANDROID_HOST_DIR}/bin/clang++${_ANDROID_HOST_EXT}")
  217. set(_ANDROID_TOOL_CXX_COMPILER_EXTERNAL_TOOLCHAIN "${_ANDROID_TOOL_C_COMPILER_EXTERNAL_TOOLCHAIN}")
  218. else()
  219. message(STATUS "Android: Selected GCC toolchain '${_ANDROID_TOOL_NAME}'")
  220. set(_ANDROID_TOOL_C_COMPILER "${_ANDROID_TOOL_C_TOOLCHAIN_PREFIX}gcc${_ANDROID_TOOL_C_TOOLCHAIN_SUFFIX}")
  221. set(_ANDROID_TOOL_C_COMPILER_EXTERNAL_TOOLCHAIN "")
  222. set(_ANDROID_TOOL_CXX_COMPILER "${_ANDROID_TOOL_CXX_TOOLCHAIN_PREFIX}g++${_ANDROID_TOOL_CXX_TOOLCHAIN_SUFFIX}")
  223. set(_ANDROID_TOOL_CXX_COMPILER_EXTERNAL_TOOLCHAIN "")
  224. endif()
  225. if(CMAKE_ANDROID_NDK_TOOLCHAIN_DEBUG)
  226. message(STATUS "_ANDROID_TOOL_NAME=${_ANDROID_TOOL_NAME}")
  227. message(STATUS "_ANDROID_TOOL_VERS=${_ANDROID_TOOL_VERS}")
  228. message(STATUS "_ANDROID_TOOL_VERS_NDK=${_ANDROID_TOOL_VERS_NDK}")
  229. message(STATUS "_ANDROID_TOOL_PREFIX=${_ANDROID_TOOL_PREFIX}")
  230. message(STATUS "_ANDROID_TOOL_CLANG_NAME=${_ANDROID_TOOL_CLANG_NAME}")
  231. message(STATUS "_ANDROID_TOOL_CLANG_VERS=${_ANDROID_TOOL_CLANG_VERS}")
  232. message(STATUS "_ANDROID_TOOL_LLVM_NAME=${_ANDROID_TOOL_LLVM_NAME}")
  233. endif()
  234. unset(_ANDROID_TOOL_NAME)
  235. unset(_ANDROID_TOOL_VERS)
  236. unset(_ANDROID_TOOL_VERS_NDK)
  237. unset(_ANDROID_TOOL_PREFIX)
  238. unset(_ANDROID_TOOL_CLANG_NAME)
  239. unset(_ANDROID_TOOL_CLANG_VERS)
  240. unset(_ANDROID_TOOL_LLVM_NAME)
  241. unset(_ANDROID_HOST_DIR)