detect.py 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291
  1. import os
  2. import sys
  3. from methods import detect_darwin_sdk_path, get_compiler_version, is_vanilla_clang
  4. from platform_methods import detect_arch
  5. from typing import TYPE_CHECKING
  6. if TYPE_CHECKING:
  7. from SCons import Environment
  8. def get_name():
  9. return "macOS"
  10. def can_build():
  11. if sys.platform == "darwin" or ("OSXCROSS_ROOT" in os.environ):
  12. return True
  13. return False
  14. def get_opts():
  15. from SCons.Variables import BoolVariable, EnumVariable
  16. return [
  17. ("osxcross_sdk", "OSXCross SDK version", "darwin16"),
  18. ("MACOS_SDK_PATH", "Path to the macOS SDK", ""),
  19. ("vulkan_sdk_path", "Path to the Vulkan SDK", ""),
  20. EnumVariable("macports_clang", "Build using Clang from MacPorts", "no", ("no", "5.0", "devel")),
  21. BoolVariable("use_ubsan", "Use LLVM/GCC compiler undefined behavior sanitizer (UBSAN)", False),
  22. BoolVariable("use_asan", "Use LLVM/GCC compiler address sanitizer (ASAN)", False),
  23. BoolVariable("use_tsan", "Use LLVM/GCC compiler thread sanitizer (TSAN)", False),
  24. BoolVariable("use_coverage", "Use instrumentation codes in the binary (e.g. for code coverage)", False),
  25. ("angle_libs", "Path to the ANGLE static libraries", ""),
  26. ]
  27. def get_doc_classes():
  28. return [
  29. "EditorExportPlatformMacOS",
  30. ]
  31. def get_doc_path():
  32. return "doc_classes"
  33. def get_flags():
  34. return [
  35. ("arch", detect_arch()),
  36. ("use_volk", False),
  37. ("supported", ["mono"]),
  38. ]
  39. def get_mvk_sdk_path():
  40. def int_or_zero(i):
  41. try:
  42. return int(i)
  43. except:
  44. return 0
  45. def ver_parse(a):
  46. return [int_or_zero(i) for i in a.split(".")]
  47. dirname = os.path.expanduser("~/VulkanSDK")
  48. if not os.path.exists(dirname):
  49. return ""
  50. ver_file = "0.0.0.0"
  51. ver_num = ver_parse(ver_file)
  52. files = os.listdir(dirname)
  53. for file in files:
  54. if os.path.isdir(os.path.join(dirname, file)):
  55. ver_comp = ver_parse(file)
  56. lib_name = os.path.join(
  57. os.path.join(dirname, file), "MoltenVK/MoltenVK.xcframework/macos-arm64_x86_64/libMoltenVK.a"
  58. )
  59. if os.path.isfile(lib_name) and ver_comp > ver_num:
  60. ver_num = ver_comp
  61. ver_file = file
  62. return os.path.join(os.path.join(dirname, ver_file), "MoltenVK/MoltenVK.xcframework/macos-arm64_x86_64/")
  63. def configure(env: "Environment"):
  64. # Validate arch.
  65. supported_arches = ["x86_64", "arm64"]
  66. if env["arch"] not in supported_arches:
  67. print(
  68. 'Unsupported CPU architecture "%s" for macOS. Supported architectures are: %s.'
  69. % (env["arch"], ", ".join(supported_arches))
  70. )
  71. sys.exit()
  72. ## Build type
  73. if env["target"] == "template_release":
  74. if env["arch"] != "arm64":
  75. env.Prepend(CCFLAGS=["-msse2"])
  76. elif env.dev_build:
  77. env.Prepend(LINKFLAGS=["-Xlinker", "-no_deduplicate"])
  78. ## Compiler configuration
  79. # Save this in environment for use by other modules
  80. if "OSXCROSS_ROOT" in os.environ:
  81. env["osxcross"] = True
  82. # CPU architecture.
  83. if env["arch"] == "arm64":
  84. print("Building for macOS 11.0+.")
  85. env.Append(ASFLAGS=["-arch", "arm64", "-mmacosx-version-min=11.0"])
  86. env.Append(CCFLAGS=["-arch", "arm64", "-mmacosx-version-min=11.0"])
  87. env.Append(LINKFLAGS=["-arch", "arm64", "-mmacosx-version-min=11.0"])
  88. elif env["arch"] == "x86_64":
  89. print("Building for macOS 10.13+.")
  90. env.Append(ASFLAGS=["-arch", "x86_64", "-mmacosx-version-min=10.13"])
  91. env.Append(CCFLAGS=["-arch", "x86_64", "-mmacosx-version-min=10.13"])
  92. env.Append(LINKFLAGS=["-arch", "x86_64", "-mmacosx-version-min=10.13"])
  93. cc_version = get_compiler_version(env)
  94. cc_version_major = cc_version["major"]
  95. cc_version_minor = cc_version["minor"]
  96. vanilla = is_vanilla_clang(env)
  97. # Workaround for Xcode 15 linker bug.
  98. if not vanilla and cc_version_major == 15 and cc_version_minor == 0:
  99. env.Prepend(LINKFLAGS=["-ld_classic"])
  100. env.Append(CCFLAGS=["-fobjc-arc"])
  101. if not "osxcross" in env: # regular native build
  102. if env["macports_clang"] != "no":
  103. mpprefix = os.environ.get("MACPORTS_PREFIX", "/opt/local")
  104. mpclangver = env["macports_clang"]
  105. env["CC"] = mpprefix + "/libexec/llvm-" + mpclangver + "/bin/clang"
  106. env["CXX"] = mpprefix + "/libexec/llvm-" + mpclangver + "/bin/clang++"
  107. env["AR"] = mpprefix + "/libexec/llvm-" + mpclangver + "/bin/llvm-ar"
  108. env["RANLIB"] = mpprefix + "/libexec/llvm-" + mpclangver + "/bin/llvm-ranlib"
  109. env["AS"] = mpprefix + "/libexec/llvm-" + mpclangver + "/bin/llvm-as"
  110. else:
  111. env["CC"] = "clang"
  112. env["CXX"] = "clang++"
  113. detect_darwin_sdk_path("macos", env)
  114. env.Append(CCFLAGS=["-isysroot", "$MACOS_SDK_PATH"])
  115. env.Append(LINKFLAGS=["-isysroot", "$MACOS_SDK_PATH"])
  116. else: # osxcross build
  117. root = os.environ.get("OSXCROSS_ROOT", "")
  118. if env["arch"] == "arm64":
  119. basecmd = root + "/target/bin/arm64-apple-" + env["osxcross_sdk"] + "-"
  120. else:
  121. basecmd = root + "/target/bin/x86_64-apple-" + env["osxcross_sdk"] + "-"
  122. ccache_path = os.environ.get("CCACHE")
  123. if ccache_path is None:
  124. env["CC"] = basecmd + "cc"
  125. env["CXX"] = basecmd + "c++"
  126. else:
  127. # there aren't any ccache wrappers available for macOS cross-compile,
  128. # to enable caching we need to prepend the path to the ccache binary
  129. env["CC"] = ccache_path + " " + basecmd + "cc"
  130. env["CXX"] = ccache_path + " " + basecmd + "c++"
  131. env["AR"] = basecmd + "ar"
  132. env["RANLIB"] = basecmd + "ranlib"
  133. env["AS"] = basecmd + "as"
  134. # LTO
  135. if env["lto"] == "auto": # LTO benefits for macOS (size, performance) haven't been clearly established yet.
  136. env["lto"] = "none"
  137. if env["lto"] != "none":
  138. if env["lto"] == "thin":
  139. env.Append(CCFLAGS=["-flto=thin"])
  140. env.Append(LINKFLAGS=["-flto=thin"])
  141. else:
  142. env.Append(CCFLAGS=["-flto"])
  143. env.Append(LINKFLAGS=["-flto"])
  144. # Sanitizers
  145. if env["use_ubsan"] or env["use_asan"] or env["use_tsan"]:
  146. env.extra_suffix += ".san"
  147. env.Append(CCFLAGS=["-DSANITIZERS_ENABLED"])
  148. if env["use_ubsan"]:
  149. env.Append(
  150. CCFLAGS=[
  151. "-fsanitize=undefined,shift,shift-exponent,integer-divide-by-zero,unreachable,vla-bound,null,return,signed-integer-overflow,bounds,float-divide-by-zero,float-cast-overflow,nonnull-attribute,returns-nonnull-attribute,bool,enum,vptr,pointer-overflow,builtin"
  152. ]
  153. )
  154. env.Append(LINKFLAGS=["-fsanitize=undefined"])
  155. env.Append(CCFLAGS=["-fsanitize=nullability-return,nullability-arg,function,nullability-assign"])
  156. if env["use_asan"]:
  157. env.Append(CCFLAGS=["-fsanitize=address,pointer-subtract,pointer-compare"])
  158. env.Append(LINKFLAGS=["-fsanitize=address"])
  159. if env["use_tsan"]:
  160. env.Append(CCFLAGS=["-fsanitize=thread"])
  161. env.Append(LINKFLAGS=["-fsanitize=thread"])
  162. if env["use_coverage"]:
  163. env.Append(CCFLAGS=["-ftest-coverage", "-fprofile-arcs"])
  164. env.Append(LINKFLAGS=["-ftest-coverage", "-fprofile-arcs"])
  165. ## Dependencies
  166. if env["builtin_libtheora"] and env["arch"] == "x86_64":
  167. env["x86_libtheora_opt_gcc"] = True
  168. ## Flags
  169. env.Prepend(CPPPATH=["#platform/macos"])
  170. env.Append(CPPDEFINES=["MACOS_ENABLED", "UNIX_ENABLED", "COREAUDIO_ENABLED", "COREMIDI_ENABLED"])
  171. env.Append(
  172. LINKFLAGS=[
  173. "-framework",
  174. "Cocoa",
  175. "-framework",
  176. "Carbon",
  177. "-framework",
  178. "AudioUnit",
  179. "-framework",
  180. "CoreAudio",
  181. "-framework",
  182. "CoreMIDI",
  183. "-framework",
  184. "IOKit",
  185. "-framework",
  186. "ForceFeedback",
  187. "-framework",
  188. "CoreVideo",
  189. "-framework",
  190. "AVFoundation",
  191. "-framework",
  192. "CoreMedia",
  193. "-framework",
  194. "QuartzCore",
  195. "-framework",
  196. "Security",
  197. ]
  198. )
  199. env.Append(LIBS=["pthread", "z"])
  200. if env["opengl3"]:
  201. env.Append(CPPDEFINES=["GLES3_ENABLED"])
  202. if env["angle_libs"] != "":
  203. env.AppendUnique(CPPDEFINES=["EGL_STATIC"])
  204. env.Append(LINKFLAGS=["-L" + env["angle_libs"]])
  205. env.Append(LINKFLAGS=["-lANGLE.macos." + env["arch"]])
  206. env.Append(LINKFLAGS=["-lEGL.macos." + env["arch"]])
  207. env.Append(LINKFLAGS=["-lGLES.macos." + env["arch"]])
  208. env.Prepend(CPPPATH=["#thirdparty/angle/include"])
  209. env.Append(LINKFLAGS=["-rpath", "@executable_path/../Frameworks", "-rpath", "@executable_path"])
  210. if env["vulkan"]:
  211. env.Append(CPPDEFINES=["VULKAN_ENABLED"])
  212. env.Append(LINKFLAGS=["-framework", "Metal", "-framework", "IOSurface"])
  213. if not env["use_volk"]:
  214. env.Append(LINKFLAGS=["-lMoltenVK"])
  215. mvk_found = False
  216. mvk_list = [get_mvk_sdk_path(), "/opt/homebrew/lib", "/usr/local/homebrew/lib", "/opt/local/lib"]
  217. if env["vulkan_sdk_path"] != "":
  218. mvk_list.insert(0, os.path.expanduser(env["vulkan_sdk_path"]))
  219. mvk_list.insert(
  220. 0,
  221. os.path.join(
  222. os.path.expanduser(env["vulkan_sdk_path"]), "MoltenVK/MoltenVK.xcframework/macos-arm64_x86_64/"
  223. ),
  224. )
  225. for mvk_path in mvk_list:
  226. if mvk_path and os.path.isfile(os.path.join(mvk_path, "libMoltenVK.a")):
  227. mvk_found = True
  228. print("MoltenVK found at: " + mvk_path)
  229. env.Append(LINKFLAGS=["-L" + mvk_path])
  230. break
  231. if not mvk_found:
  232. print(
  233. "MoltenVK SDK installation directory not found, use 'vulkan_sdk_path' SCons parameter to specify SDK path."
  234. )
  235. sys.exit(255)