detect.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
  1. import os
  2. import platform
  3. import sys
  4. from methods import get_compiler_version, using_gcc
  5. def is_active():
  6. return True
  7. def get_name():
  8. return "LinuxBSD"
  9. def can_build():
  10. if os.name != "posix" or sys.platform == "darwin":
  11. return False
  12. pkgconf_error = os.system("pkg-config --version > /dev/null")
  13. if pkgconf_error:
  14. print("Error: pkg-config not found. Aborting.")
  15. return False
  16. return True
  17. def get_opts():
  18. from SCons.Variables import BoolVariable, EnumVariable
  19. return [
  20. EnumVariable("linker", "Linker program", "default", ("default", "bfd", "gold", "lld", "mold")),
  21. BoolVariable("use_llvm", "Use the LLVM compiler", False),
  22. BoolVariable("use_thinlto", "Use ThinLTO (LLVM only, requires linker=lld, implies use_lto=yes)", False),
  23. BoolVariable("use_static_cpp", "Link libgcc and libstdc++ statically for better portability", True),
  24. BoolVariable("use_coverage", "Test Godot coverage", False),
  25. BoolVariable("use_ubsan", "Use LLVM/GCC compiler undefined behavior sanitizer (UBSAN)", False),
  26. BoolVariable("use_asan", "Use LLVM/GCC compiler address sanitizer (ASAN)", False),
  27. BoolVariable("use_lsan", "Use LLVM/GCC compiler leak sanitizer (LSAN)", False),
  28. BoolVariable("use_tsan", "Use LLVM/GCC compiler thread sanitizer (TSAN)", False),
  29. BoolVariable("use_msan", "Use LLVM compiler memory sanitizer (MSAN)", False),
  30. BoolVariable("pulseaudio", "Detect and use PulseAudio", True),
  31. BoolVariable("dbus", "Detect and use D-Bus to handle screensaver", True),
  32. BoolVariable("speechd", "Detect and use Speech Dispatcher for Text-to-Speech support", True),
  33. BoolVariable("udev", "Use udev for gamepad connection callbacks", True),
  34. BoolVariable("x11", "Enable X11 display", True),
  35. BoolVariable("debug_symbols", "Add debugging symbols to release/release_debug builds", True),
  36. BoolVariable("separate_debug_symbols", "Create a separate file containing debugging symbols", False),
  37. BoolVariable("touch", "Enable touch events", True),
  38. BoolVariable("execinfo", "Use libexecinfo on systems where glibc is not available", False),
  39. ]
  40. def get_flags():
  41. return []
  42. def configure(env):
  43. ## Build type
  44. if env["target"] == "release":
  45. if env["optimize"] == "speed": # optimize for speed (default)
  46. env.Prepend(CCFLAGS=["-O3"])
  47. elif env["optimize"] == "size": # optimize for size
  48. env.Prepend(CCFLAGS=["-Os"])
  49. if env["debug_symbols"]:
  50. env.Prepend(CCFLAGS=["-g2"])
  51. elif env["target"] == "release_debug":
  52. if env["optimize"] == "speed": # optimize for speed (default)
  53. env.Prepend(CCFLAGS=["-O2"])
  54. elif env["optimize"] == "size": # optimize for size
  55. env.Prepend(CCFLAGS=["-Os"])
  56. if env["debug_symbols"]:
  57. env.Prepend(CCFLAGS=["-g2"])
  58. elif env["target"] == "debug":
  59. env.Prepend(CCFLAGS=["-g3"])
  60. env.Append(LINKFLAGS=["-rdynamic"])
  61. ## Architecture
  62. is64 = sys.maxsize > 2**32
  63. if env["bits"] == "default":
  64. env["bits"] = "64" if is64 else "32"
  65. machines = {
  66. "riscv64": "rv64",
  67. "ppc64le": "ppc64",
  68. "ppc64": "ppc64",
  69. "ppcle": "ppc",
  70. "ppc": "ppc",
  71. }
  72. if env["arch"] == "" and platform.machine() in machines:
  73. env["arch"] = machines[platform.machine()]
  74. if env["arch"] == "rv64":
  75. # G = General-purpose extensions, C = Compression extension (very common).
  76. env.Append(CCFLAGS=["-march=rv64gc"])
  77. ## Compiler configuration
  78. if "CXX" in env and "clang" in os.path.basename(env["CXX"]):
  79. # Convenience check to enforce the use_llvm overrides when CXX is clang(++)
  80. env["use_llvm"] = True
  81. if env["use_llvm"]:
  82. if "clang++" not in os.path.basename(env["CXX"]):
  83. env["CC"] = "clang"
  84. env["CXX"] = "clang++"
  85. env.extra_suffix = ".llvm" + env.extra_suffix
  86. if env["linker"] != "default":
  87. print("Using linker program: " + env["linker"])
  88. if env["linker"] == "mold" and using_gcc(env): # GCC < 12.1 doesn't support -fuse-ld=mold.
  89. cc_version = get_compiler_version(env)
  90. cc_semver = (int(cc_version["major"]), int(cc_version["minor"]))
  91. if cc_semver < (12, 1):
  92. found_wrapper = False
  93. for path in ["/usr/libexec", "/usr/local/libexec", "/usr/lib", "/usr/local/lib"]:
  94. if os.path.isfile(path + "/mold/ld"):
  95. env.Append(LINKFLAGS=["-B" + path + "/mold"])
  96. found_wrapper = True
  97. break
  98. if not found_wrapper:
  99. print("Couldn't locate mold installation path. Make sure it's installed in /usr or /usr/local.")
  100. sys.exit(255)
  101. else:
  102. env.Append(LINKFLAGS=["-fuse-ld=mold"])
  103. else:
  104. env.Append(LINKFLAGS=["-fuse-ld=%s" % env["linker"]])
  105. if env["use_thinlto"]:
  106. if not env["use_llvm"] or env["linker"] != "lld":
  107. print("ThinLTO is only compatible with LLVM and the LLD linker, use `use_llvm=yes linker=lld`.")
  108. sys.exit(255)
  109. else:
  110. env["use_lto"] = True # ThinLTO implies LTO
  111. if env["use_coverage"]:
  112. env.Append(CCFLAGS=["-ftest-coverage", "-fprofile-arcs"])
  113. env.Append(LINKFLAGS=["-ftest-coverage", "-fprofile-arcs"])
  114. if env["use_ubsan"] or env["use_asan"] or env["use_lsan"] or env["use_tsan"] or env["use_msan"]:
  115. env.extra_suffix += ".san"
  116. env.Append(CCFLAGS=["-DSANITIZERS_ENABLED"])
  117. if env["use_ubsan"]:
  118. env.Append(
  119. CCFLAGS=[
  120. "-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"
  121. ]
  122. )
  123. env.Append(LINKFLAGS=["-fsanitize=undefined"])
  124. if env["use_llvm"]:
  125. env.Append(
  126. CCFLAGS=[
  127. "-fsanitize=nullability-return,nullability-arg,function,nullability-assign,implicit-integer-sign-change"
  128. ]
  129. )
  130. else:
  131. env.Append(CCFLAGS=["-fsanitize=bounds-strict"])
  132. if env["use_asan"]:
  133. env.Append(CCFLAGS=["-fsanitize=address,pointer-subtract,pointer-compare"])
  134. env.Append(LINKFLAGS=["-fsanitize=address"])
  135. if env["use_lsan"]:
  136. env.Append(CCFLAGS=["-fsanitize=leak"])
  137. env.Append(LINKFLAGS=["-fsanitize=leak"])
  138. if env["use_tsan"]:
  139. env.Append(CCFLAGS=["-fsanitize=thread"])
  140. env.Append(LINKFLAGS=["-fsanitize=thread"])
  141. if env["use_msan"] and env["use_llvm"]:
  142. env.Append(CCFLAGS=["-fsanitize=memory"])
  143. env.Append(CCFLAGS=["-fsanitize-memory-track-origins"])
  144. env.Append(CCFLAGS=["-fsanitize-recover=memory"])
  145. env.Append(LINKFLAGS=["-fsanitize=memory"])
  146. if env["use_lto"]:
  147. if env["use_thinlto"]:
  148. env.Append(CCFLAGS=["-flto=thin"])
  149. env.Append(LINKFLAGS=["-flto=thin"])
  150. elif not env["use_llvm"] and env.GetOption("num_jobs") > 1:
  151. env.Append(CCFLAGS=["-flto"])
  152. env.Append(LINKFLAGS=["-flto=" + str(env.GetOption("num_jobs"))])
  153. else:
  154. env.Append(CCFLAGS=["-flto"])
  155. env.Append(LINKFLAGS=["-flto"])
  156. if not env["use_llvm"]:
  157. env["RANLIB"] = "gcc-ranlib"
  158. env["AR"] = "gcc-ar"
  159. env.Append(CCFLAGS=["-pipe"])
  160. ## Dependencies
  161. if env["x11"]:
  162. env.ParseConfig("pkg-config x11 --cflags --libs")
  163. env.ParseConfig("pkg-config xcursor --cflags --libs")
  164. env.ParseConfig("pkg-config xinerama --cflags --libs")
  165. env.ParseConfig("pkg-config xext --cflags --libs")
  166. env.ParseConfig("pkg-config xrandr --cflags --libs")
  167. env.ParseConfig("pkg-config xrender --cflags --libs")
  168. env.ParseConfig("pkg-config xi --cflags --libs")
  169. if env["touch"]:
  170. env.Append(CPPDEFINES=["TOUCH_ENABLED"])
  171. # FIXME: Check for existence of the libs before parsing their flags with pkg-config
  172. # freetype depends on libpng and zlib, so bundling one of them while keeping others
  173. # as shared libraries leads to weird issues
  174. if (
  175. env["builtin_freetype"]
  176. or env["builtin_libpng"]
  177. or env["builtin_zlib"]
  178. or env["builtin_graphite"]
  179. or env["builtin_harfbuzz"]
  180. ):
  181. env["builtin_freetype"] = True
  182. env["builtin_libpng"] = True
  183. env["builtin_zlib"] = True
  184. env["builtin_graphite"] = True
  185. env["builtin_harfbuzz"] = True
  186. if not env["builtin_freetype"]:
  187. env.ParseConfig("pkg-config freetype2 --cflags --libs")
  188. if not env["builtin_graphite"]:
  189. env.ParseConfig("pkg-config graphite2 --cflags --libs")
  190. if not env["builtin_icu"]:
  191. env.ParseConfig("pkg-config icu-uc --cflags --libs")
  192. if not env["builtin_harfbuzz"]:
  193. env.ParseConfig("pkg-config harfbuzz harfbuzz-icu --cflags --libs")
  194. if not env["builtin_libpng"]:
  195. env.ParseConfig("pkg-config libpng16 --cflags --libs")
  196. if not env["builtin_enet"]:
  197. env.ParseConfig("pkg-config libenet --cflags --libs")
  198. if not env["builtin_squish"]:
  199. env.ParseConfig("pkg-config libsquish --cflags --libs")
  200. if not env["builtin_zstd"]:
  201. env.ParseConfig("pkg-config libzstd --cflags --libs")
  202. # Sound and video libraries
  203. # Keep the order as it triggers chained dependencies (ogg needed by others, etc.)
  204. if not env["builtin_libtheora"]:
  205. env["builtin_libogg"] = False # Needed to link against system libtheora
  206. env["builtin_libvorbis"] = False # Needed to link against system libtheora
  207. env.ParseConfig("pkg-config theora theoradec --cflags --libs")
  208. else:
  209. list_of_x86 = ["x86_64", "x86", "i386", "i586"]
  210. if any(platform.machine() in s for s in list_of_x86):
  211. env["x86_libtheora_opt_gcc"] = True
  212. if not env["builtin_libvorbis"]:
  213. env["builtin_libogg"] = False # Needed to link against system libvorbis
  214. env.ParseConfig("pkg-config vorbis vorbisfile --cflags --libs")
  215. if not env["builtin_libogg"]:
  216. env.ParseConfig("pkg-config ogg --cflags --libs")
  217. if not env["builtin_libwebp"]:
  218. env.ParseConfig("pkg-config libwebp --cflags --libs")
  219. if not env["builtin_mbedtls"]:
  220. # mbedTLS does not provide a pkgconfig config yet. See https://github.com/ARMmbed/mbedtls/issues/228
  221. env.Append(LIBS=["mbedtls", "mbedcrypto", "mbedx509"])
  222. if not env["builtin_wslay"]:
  223. env.ParseConfig("pkg-config libwslay --cflags --libs")
  224. if not env["builtin_miniupnpc"]:
  225. # No pkgconfig file so far, hardcode default paths.
  226. env.Prepend(CPPPATH=["/usr/include/miniupnpc"])
  227. env.Append(LIBS=["miniupnpc"])
  228. # On Linux wchar_t should be 32-bits
  229. # 16-bit library shouldn't be required due to compiler optimisations
  230. if not env["builtin_pcre2"]:
  231. env.ParseConfig("pkg-config libpcre2-32 --cflags --libs")
  232. if not env["builtin_embree"]:
  233. # No pkgconfig file so far, hardcode expected lib name.
  234. env.Append(LIBS=["embree3"])
  235. ## Flags
  236. if os.system("pkg-config --exists fontconfig") == 0: # 0 means found
  237. env.Append(CPPDEFINES=["FONTCONFIG_ENABLED"])
  238. env.ParseConfig("pkg-config fontconfig --cflags --libs")
  239. else:
  240. print("Warning: fontconfig libraries not found. Disabling the system fonts support.")
  241. if os.system("pkg-config --exists alsa") == 0: # 0 means found
  242. env["alsa"] = True
  243. env.Append(CPPDEFINES=["ALSA_ENABLED", "ALSAMIDI_ENABLED"])
  244. env.ParseConfig("pkg-config alsa --cflags") # Only cflags, we dlopen the library.
  245. else:
  246. print("Warning: ALSA libraries not found. Disabling the ALSA audio driver.")
  247. if env["pulseaudio"]:
  248. if os.system("pkg-config --exists libpulse") == 0: # 0 means found
  249. env.Append(CPPDEFINES=["PULSEAUDIO_ENABLED"])
  250. env.ParseConfig("pkg-config libpulse --cflags") # Only cflags, we dlopen the library.
  251. else:
  252. env["pulseaudio"] = False
  253. print("Warning: PulseAudio development libraries not found. Disabling the PulseAudio audio driver.")
  254. if env["dbus"]:
  255. if os.system("pkg-config --exists dbus-1") == 0: # 0 means found
  256. env.Append(CPPDEFINES=["DBUS_ENABLED"])
  257. env.ParseConfig("pkg-config dbus-1 --cflags --libs")
  258. else:
  259. print("Warning: D-Bus development libraries not found. Disabling screensaver prevention.")
  260. if env["speechd"]:
  261. if os.system("pkg-config --exists speech-dispatcher") == 0: # 0 means found
  262. env.Append(CPPDEFINES=["SPEECHD_ENABLED"])
  263. env.ParseConfig("pkg-config speech-dispatcher --cflags") # Only cflags, we dlopen the library.
  264. else:
  265. env["speechd"] = False
  266. print("Warning: Speech Dispatcher development libraries not found. Disabling Text-to-Speech support.")
  267. if platform.system() == "Linux":
  268. env.Append(CPPDEFINES=["JOYDEV_ENABLED"])
  269. if env["udev"]:
  270. if os.system("pkg-config --exists libudev") == 0: # 0 means found
  271. env.Append(CPPDEFINES=["UDEV_ENABLED"])
  272. env.ParseConfig("pkg-config libudev --cflags") # Only cflags, we dlopen the library.
  273. else:
  274. env["udev"] = False
  275. print("Warning: libudev development libraries not found. Disabling controller hotplugging support.")
  276. else:
  277. env["udev"] = False # Linux specific
  278. # Linkflags below this line should typically stay the last ones
  279. if not env["builtin_zlib"]:
  280. env.ParseConfig("pkg-config zlib --cflags --libs")
  281. env.Prepend(CPPPATH=["#platform/linuxbsd"])
  282. if env["x11"]:
  283. if not env["vulkan"]:
  284. print("Error: X11 support requires vulkan=yes")
  285. env.Exit(255)
  286. env.Append(CPPDEFINES=["X11_ENABLED"])
  287. env.Append(CPPDEFINES=["UNIX_ENABLED"])
  288. env.Append(CPPDEFINES=[("_FILE_OFFSET_BITS", 64)])
  289. if env["vulkan"]:
  290. env.Append(CPPDEFINES=["VULKAN_ENABLED"])
  291. if not env["use_volk"]:
  292. env.ParseConfig("pkg-config vulkan --cflags --libs")
  293. if not env["builtin_glslang"]:
  294. # No pkgconfig file so far, hardcode expected lib name.
  295. env.Append(LIBS=["glslang", "SPIRV"])
  296. if env["opengl3"]:
  297. env.Append(CPPDEFINES=["GLES3_ENABLED"])
  298. env.ParseConfig("pkg-config gl --cflags --libs")
  299. env.Append(LIBS=["pthread"])
  300. if platform.system() == "Linux":
  301. env.Append(LIBS=["dl"])
  302. if platform.system().find("BSD") >= 0:
  303. env["execinfo"] = True
  304. if env["execinfo"]:
  305. env.Append(LIBS=["execinfo"])
  306. if not env["tools"]:
  307. import subprocess
  308. import re
  309. linker_version_str = subprocess.check_output([env.subst(env["LINK"]), "-Wl,--version"]).decode("utf-8")
  310. gnu_ld_version = re.search("^GNU ld [^$]*(\d+\.\d+)$", linker_version_str, re.MULTILINE)
  311. if not gnu_ld_version:
  312. print(
  313. "Warning: Creating template binaries enabled for PCK embedding is currently only supported with GNU ld, not gold or LLD."
  314. )
  315. else:
  316. if float(gnu_ld_version.group(1)) >= 2.30:
  317. env.Append(LINKFLAGS=["-T", "platform/linuxbsd/pck_embed.ld"])
  318. else:
  319. env.Append(LINKFLAGS=["-T", "platform/linuxbsd/pck_embed.legacy.ld"])
  320. ## Cross-compilation
  321. if is64 and env["bits"] == "32":
  322. env.Append(CCFLAGS=["-m32"])
  323. env.Append(LINKFLAGS=["-m32", "-L/usr/lib/i386-linux-gnu"])
  324. elif not is64 and env["bits"] == "64":
  325. env.Append(CCFLAGS=["-m64"])
  326. env.Append(LINKFLAGS=["-m64", "-L/usr/lib/i686-linux-gnu"])
  327. # Link those statically for portability
  328. if env["use_static_cpp"]:
  329. env.Append(LINKFLAGS=["-static-libgcc", "-static-libstdc++"])
  330. if env["use_llvm"]:
  331. env["LINKCOM"] = env["LINKCOM"] + " -l:libatomic.a"
  332. else:
  333. if env["use_llvm"]:
  334. env.Append(LIBS=["atomic"])