create-test-plan.py 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815
  1. #!/usr/bin/env python
  2. import argparse
  3. import dataclasses
  4. import fnmatch
  5. from enum import Enum
  6. import json
  7. import logging
  8. import os
  9. import re
  10. from typing import Optional
  11. logger = logging.getLogger(__name__)
  12. class AppleArch(Enum):
  13. Aarch64 = "aarch64"
  14. X86_64 = "x86_64"
  15. class MsvcArch(Enum):
  16. X86 = "x86"
  17. X64 = "x64"
  18. Arm32 = "arm"
  19. Arm64 = "arm64"
  20. class JobOs(Enum):
  21. WindowsLatest = "windows-latest"
  22. UbuntuLatest = "ubuntu-latest"
  23. MacosLatest = "macos-latest"
  24. Ubuntu20_04 = "ubuntu-20.04"
  25. Ubuntu22_04 = "ubuntu-22.04"
  26. Ubuntu24_04 = "ubuntu-24.04"
  27. Macos12 = "macos-12"
  28. class SdlPlatform(Enum):
  29. Android = "android"
  30. Emscripten = "emscripten"
  31. Haiku = "haiku"
  32. LoongArch64 = "loongarch64"
  33. Msys2 = "msys2"
  34. Linux = "linux"
  35. MacOS = "macos"
  36. Ios = "ios"
  37. Tvos = "tvos"
  38. Msvc = "msvc"
  39. N3ds = "n3ds"
  40. PowerPC64 = "powerpc64"
  41. Ps2 = "ps2"
  42. Psp = "psp"
  43. Vita = "vita"
  44. Riscos = "riscos"
  45. FreeBSD = "freebsd"
  46. NetBSD = "netbsd"
  47. class Msys2Platform(Enum):
  48. Mingw32 = "mingw32"
  49. Mingw64 = "mingw64"
  50. Clang32 = "clang32"
  51. Clang64 = "clang64"
  52. Ucrt64 = "ucrt64"
  53. class IntelCompiler(Enum):
  54. Icc = "icc"
  55. Icx = "icx"
  56. class VitaGLES(Enum):
  57. Pib = "pib"
  58. Pvr = "pvr"
  59. @dataclasses.dataclass(slots=True)
  60. class JobSpec:
  61. name: str
  62. os: JobOs
  63. platform: SdlPlatform
  64. artifact: Optional[str]
  65. container: Optional[str] = None
  66. no_cmake: bool = False
  67. xcode: bool = False
  68. android_mk: bool = False
  69. android_gradle: bool = False
  70. lean: bool = False
  71. android_arch: Optional[str] = None
  72. android_abi: Optional[str] = None
  73. android_platform: Optional[int] = None
  74. msys2_platform: Optional[Msys2Platform] = None
  75. intel: Optional[IntelCompiler] = None
  76. apple_framework: Optional[bool] = None
  77. apple_archs: Optional[set[AppleArch]] = None
  78. msvc_project: Optional[str] = None
  79. msvc_arch: Optional[MsvcArch] = None
  80. clang_cl: bool = False
  81. uwp: bool = False
  82. gdk: bool = False
  83. vita_gles: Optional[VitaGLES] = None
  84. JOB_SPECS = {
  85. "msys2-mingw32": JobSpec(name="Windows (msys2, mingw32)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw32", msys2_platform=Msys2Platform.Mingw32, ),
  86. "msys2-mingw64": JobSpec(name="Windows (msys2, mingw64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64", msys2_platform=Msys2Platform.Mingw64, ),
  87. "msys2-clang32": JobSpec(name="Windows (msys2, clang32)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw32-clang", msys2_platform=Msys2Platform.Clang32, ),
  88. "msys2-clang64": JobSpec(name="Windows (msys2, clang64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64-clang", msys2_platform=Msys2Platform.Clang64, ),
  89. "msys2-ucrt64": JobSpec(name="Windows (msys2, ucrt64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msys2, artifact="SDL-mingw64-ucrt", msys2_platform=Msys2Platform.Ucrt64, ),
  90. "msvc-x64": JobSpec(name="Windows (MSVC, x64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-x64", msvc_arch=MsvcArch.X64, msvc_project="VisualC/SDL.sln", ),
  91. "msvc-x86": JobSpec(name="Windows (MSVC, x86)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-x86", msvc_arch=MsvcArch.X86, msvc_project="VisualC/SDL.sln", ),
  92. "msvc-clang-x64": JobSpec(name="Windows (MSVC, clang-cl x64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-clang-cl-x64", msvc_arch=MsvcArch.X64, clang_cl=True, ),
  93. "msvc-clang-x86": JobSpec(name="Windows (MSVC, clang-cl x86)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-clang-cl-x86", msvc_arch=MsvcArch.X86, clang_cl=True, ),
  94. "msvc-arm32": JobSpec(name="Windows (MSVC, ARM)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-arm32", msvc_arch=MsvcArch.Arm32, ),
  95. "msvc-arm64": JobSpec(name="Windows (MSVC, ARM64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-arm64", msvc_arch=MsvcArch.Arm64, ),
  96. "msvc-uwp-x64": JobSpec(name="UWP (MSVC, x64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-UWP", msvc_arch=MsvcArch.X64, msvc_project="VisualC-WinRT/SDL-UWP.sln", uwp=True, ),
  97. "msvc-gdk-x64": JobSpec(name="GDK (MSVC, x64)", os=JobOs.WindowsLatest, platform=SdlPlatform.Msvc, artifact="SDL-VC-GDK", msvc_arch=MsvcArch.X64, msvc_project="VisualC-GDK/SDL.sln", gdk=True, no_cmake=True, ),
  98. "ubuntu-20.04": JobSpec(name="Ubuntu 20.04", os=JobOs.Ubuntu20_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu20.04", ),
  99. "ubuntu-22.04": JobSpec(name="Ubuntu 22.04", os=JobOs.Ubuntu22_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu22.04", ),
  100. "ubuntu-intel-icx": JobSpec(name="Ubuntu 20.04 (Intel oneAPI)", os=JobOs.Ubuntu20_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu20.04-oneapi", intel=IntelCompiler.Icx, ),
  101. "ubuntu-intel-icc": JobSpec(name="Ubuntu 20.04 (Intel Compiler)", os=JobOs.Ubuntu20_04, platform=SdlPlatform.Linux, artifact="SDL-ubuntu20.04-icc", intel=IntelCompiler.Icc, ),
  102. "macos-framework-x64": JobSpec(name="MacOS (Framework) (x64)", os=JobOs.Macos12, platform=SdlPlatform.MacOS, artifact="SDL-macos-framework", apple_framework=True, apple_archs={AppleArch.Aarch64, AppleArch.X86_64, }, xcode=True, ),
  103. "macos-framework-arm64": JobSpec(name="MacOS (Framework) (arm64)", os=JobOs.MacosLatest, platform=SdlPlatform.MacOS, artifact=None, apple_framework=True, apple_archs={AppleArch.Aarch64, AppleArch.X86_64, }, ),
  104. "macos-gnu-arm64": JobSpec(name="MacOS (GNU prefix)", os=JobOs.MacosLatest, platform=SdlPlatform.MacOS, artifact="SDL-macos-arm64-gnu", apple_framework=False, apple_archs={AppleArch.Aarch64, }, ),
  105. "ios": JobSpec(name="iOS (CMake & xcode)", os=JobOs.MacosLatest, platform=SdlPlatform.Ios, artifact="SDL-ios-arm64", xcode=True, ),
  106. "tvos": JobSpec(name="tvOS (CMake & xcode)", os=JobOs.MacosLatest, platform=SdlPlatform.Tvos, artifact="SDL-tvos-arm64", xcode=True, ),
  107. "android-cmake": JobSpec(name="Android (CMake)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact="SDL-android-arm64", android_abi="arm64-v8a", android_arch="aarch64", android_platform=23, ),
  108. "android-cmake-lean": JobSpec(name="Android (CMake, lean)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact="SDL-lean-android-arm64", android_abi="arm64-v8a", android_arch="aarch64", android_platform=23, lean=True, ),
  109. "android-mk": JobSpec(name="Android (Android.mk)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact=None, no_cmake=True, android_mk=True, ),
  110. "android-gradle": JobSpec(name="Android (Gradle)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Android, artifact=None, no_cmake=True, android_gradle=True, ),
  111. "emscripten": JobSpec(name="Emscripten", os=JobOs.UbuntuLatest, platform=SdlPlatform.Emscripten, artifact="SDL-emscripten", ),
  112. "haiku": JobSpec(name="Haiku", os=JobOs.UbuntuLatest, platform=SdlPlatform.Haiku, artifact="SDL-haiku-x64", container="haiku/cross-compiler:x86_64-r1beta4", ),
  113. "loongarch64": JobSpec(name="LoongArch64", os=JobOs.UbuntuLatest, platform=SdlPlatform.LoongArch64, artifact="SDL-loongarch64", ),
  114. "n3ds": JobSpec(name="Nintendo 3DS", os=JobOs.UbuntuLatest, platform=SdlPlatform.N3ds, artifact="SDL-n3ds", container="devkitpro/devkitarm:latest", ),
  115. "ppc64": JobSpec(name="PowerPC64", os=JobOs.UbuntuLatest, platform=SdlPlatform.PowerPC64, artifact="SDL-ppc64le", container="dockcross/linux-ppc64le:latest", ),
  116. "ps2": JobSpec(name="Sony PlayStation 2", os=JobOs.UbuntuLatest, platform=SdlPlatform.Ps2, artifact="SDL-ps2", container="ps2dev/ps2dev:latest", ),
  117. "psp": JobSpec(name="Sony PlayStation Portable", os=JobOs.UbuntuLatest, platform=SdlPlatform.Psp, artifact="SDL-psp", container="pspdev/pspdev:latest", ),
  118. "vita-pib": JobSpec(name="Sony PlayStation Vita (GLES w/ pib)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Vita, artifact="SDL-vita-pib", container="vitasdk/vitasdk:latest", vita_gles=VitaGLES.Pib, ),
  119. "vita-pvr": JobSpec(name="Sony PlayStation Vita (GLES w/ PVR_PSP2)", os=JobOs.UbuntuLatest, platform=SdlPlatform.Vita, artifact="SDL-vita-pvr", container="vitasdk/vitasdk:latest", vita_gles=VitaGLES.Pvr, ),
  120. "riscos": JobSpec(name="RISC OS", os=JobOs.UbuntuLatest, platform=SdlPlatform.Riscos, artifact="SDL-riscos", container="riscosdotinfo/riscos-gccsdk-4.7:latest", ),
  121. "netbsd": JobSpec(name="NetBSD", os=JobOs.UbuntuLatest, platform=SdlPlatform.NetBSD, artifact="SDL-netbsd-x64", ),
  122. "freebsd": JobSpec(name="FreeBSD", os=JobOs.UbuntuLatest, platform=SdlPlatform.FreeBSD, artifact="SDL-freebsd-x64", ),
  123. }
  124. class StaticLibType(Enum):
  125. MSVC = "SDL3-static.lib"
  126. A = "libSDL3.a"
  127. class SharedLibType(Enum):
  128. WIN32 = "SDL3.dll"
  129. SO_0 = "libSDL3.so.0"
  130. SO = "libSDL3.so"
  131. DYLIB = "libSDL3.0.dylib"
  132. FRAMEWORK = "SDL3.framework/Versions/A/SDL3"
  133. @dataclasses.dataclass(slots=True)
  134. class JobDetails:
  135. name: str
  136. os: str
  137. platform: str
  138. artifact: str
  139. no_cmake: bool
  140. build_tests: bool = True
  141. container: str = ""
  142. cmake_build_type: str = "RelWithDebInfo"
  143. shell: str = "sh"
  144. sudo: str = "sudo"
  145. cmake_config_emulator: str = ""
  146. apk_packages: list[str] = dataclasses.field(default_factory=list)
  147. apt_packages: list[str] = dataclasses.field(default_factory=list)
  148. brew_packages: list[str] = dataclasses.field(default_factory=list)
  149. cmake_toolchain_file: str = ""
  150. cmake_arguments: list[str] = dataclasses.field(default_factory=list)
  151. cmake_build_arguments: list[str] = dataclasses.field(default_factory=list)
  152. clang_tidy: bool = True
  153. cppflags: list[str] = dataclasses.field(default_factory=list)
  154. cc: str = ""
  155. cxx: str = ""
  156. cflags: list[str] = dataclasses.field(default_factory=list)
  157. cxxflags: list[str] = dataclasses.field(default_factory=list)
  158. ldflags: list[str] = dataclasses.field(default_factory=list)
  159. pollute_directories: list[str] = dataclasses.field(default_factory=list)
  160. use_cmake: bool = True
  161. shared: bool = True
  162. static: bool = True
  163. shared_lib: Optional[SharedLibType] = None
  164. static_lib: Optional[StaticLibType] = None
  165. run_tests: bool = True
  166. test_pkg_config: bool = True
  167. cc_from_cmake: bool = False
  168. source_cmd: str = ""
  169. pretest_cmd: str = ""
  170. java: bool = False
  171. android_apks: list[str] = dataclasses.field(default_factory=list)
  172. android_ndk: bool = False
  173. android_mk: bool = False
  174. android_gradle: bool = False
  175. minidump: bool = False
  176. intel: bool = False
  177. msys2_msystem: str = ""
  178. msys2_env: str = ""
  179. msys2_no_perl: bool = False
  180. werror: bool = True
  181. msvc_vcvars: str = ""
  182. msvc_project: str = ""
  183. msvc_project_flags: list[str] = dataclasses.field(default_factory=list)
  184. setup_ninja: bool = False
  185. setup_libusb_arch: str = ""
  186. xcode_sdk: str = ""
  187. cpactions: bool = False
  188. setup_gdk_folder: str = ""
  189. cpactions_os: str = ""
  190. cpactions_version: str = ""
  191. cpactions_arch: str = ""
  192. cpactions_setup_cmd: str = ""
  193. cpactions_install_cmd: str = ""
  194. setup_vita_gles_type: str = ""
  195. def to_workflow(self, enable_artifacts: bool) -> dict[str, str|bool]:
  196. data = {
  197. "name": self.name,
  198. "os": self.os,
  199. "container": self.container if self.container else "",
  200. "platform": self.platform,
  201. "artifact": self.artifact,
  202. "enable-artifacts": enable_artifacts,
  203. "shell": self.shell,
  204. "msys2-msystem": self.msys2_msystem,
  205. "msys2-env": self.msys2_env,
  206. "msys2-no-perl": self.msys2_no_perl,
  207. "android-ndk": self.android_ndk,
  208. "java": self.java,
  209. "intel": self.intel,
  210. "apk-packages": my_shlex_join(self.apk_packages),
  211. "apt-packages": my_shlex_join(self.apt_packages),
  212. "test-pkg-config": self.test_pkg_config,
  213. "brew-packages": my_shlex_join(self.brew_packages),
  214. "pollute-directories": my_shlex_join(self.pollute_directories),
  215. "no-cmake": self.no_cmake,
  216. "build-tests": self.build_tests,
  217. "source-cmd": self.source_cmd,
  218. "pretest-cmd": self.pretest_cmd,
  219. "cmake-config-emulator": self.cmake_config_emulator,
  220. "cc": self.cc,
  221. "cxx": self.cxx,
  222. "cflags": my_shlex_join(self.cppflags + self.cflags),
  223. "cxxflags": my_shlex_join(self.cppflags + self.cxxflags),
  224. "ldflags": my_shlex_join(self.ldflags),
  225. "cmake-toolchain-file": self.cmake_toolchain_file,
  226. "clang-tidy": self.clang_tidy,
  227. "cmake-arguments": my_shlex_join(self.cmake_arguments),
  228. "cmake-build-arguments": my_shlex_join(self.cmake_build_arguments),
  229. "shared": self.shared,
  230. "static": self.static,
  231. "shared-lib": self.shared_lib.value if self.shared_lib else None,
  232. "static-lib": self.static_lib.value if self.static_lib else None,
  233. "cmake-build-type": self.cmake_build_type,
  234. "run-tests": self.run_tests,
  235. "android-apks": my_shlex_join(self.android_apks),
  236. "android-gradle": self.android_gradle,
  237. "android-mk": self.android_mk,
  238. "werror": self.werror,
  239. "sudo": self.sudo,
  240. "msvc-vcvars": self.msvc_vcvars,
  241. "msvc-project": self.msvc_project,
  242. "msvc-project-flags": my_shlex_join(self.msvc_project_flags),
  243. "setup-ninja": self.setup_ninja,
  244. "setup-libusb-arch": self.setup_libusb_arch,
  245. "cc-from-cmake": self.cc_from_cmake,
  246. "xcode-sdk": self.xcode_sdk,
  247. "cpactions": self.cpactions,
  248. "cpactions-os": self.cpactions_os,
  249. "cpactions-version": self.cpactions_version,
  250. "cpactions-arch": self.cpactions_arch,
  251. "cpactions-setup-cmd": self.cpactions_setup_cmd,
  252. "cpactions-install-cmd": self.cpactions_install_cmd,
  253. "setup-vita-gles-type": self.setup_vita_gles_type,
  254. "setup-gdk-folder": self.setup_gdk_folder,
  255. }
  256. return {k: v for k, v in data.items() if v != ""}
  257. def my_shlex_join(s):
  258. def escape(s):
  259. if s[:1] == "'" and s[-1:] == "'":
  260. return s
  261. if set(s).intersection(set("; \t")):
  262. return f'"{s}"'
  263. return s
  264. return " ".join(escape(s))
  265. def spec_to_job(spec: JobSpec, trackmem_symbol_names: bool) -> JobDetails:
  266. job = JobDetails(
  267. name=spec.name,
  268. os=spec.os.value,
  269. artifact=spec.artifact or "",
  270. container=spec.container or "",
  271. platform=spec.platform.value,
  272. sudo="sudo",
  273. no_cmake=spec.no_cmake,
  274. )
  275. if job.os.startswith("ubuntu"):
  276. job.apt_packages.extend([
  277. "ninja-build",
  278. "pkg-config",
  279. ])
  280. pretest_cmd = []
  281. if trackmem_symbol_names:
  282. pretest_cmd.append("export SDL_TRACKMEM_SYMBOL_NAMES=1")
  283. else:
  284. pretest_cmd.append("export SDL_TRACKMEM_SYMBOL_NAMES=0")
  285. win32 = spec.platform in (SdlPlatform.Msys2, SdlPlatform.Msvc)
  286. fpic = None
  287. build_parallel = True
  288. if spec.lean:
  289. job.cppflags.append("-DSDL_LEAN_AND_MEAN=1")
  290. if win32:
  291. job.cmake_arguments.append("-DSDLTEST_PROCDUMP=ON")
  292. job.minidump = True
  293. if spec.intel is not None:
  294. match spec.intel:
  295. case IntelCompiler.Icx:
  296. job.cc = "icx"
  297. job.cxx = "icpx"
  298. case IntelCompiler.Icc:
  299. job.cc = "icc"
  300. job.cxx = "icpc"
  301. job.cppflags.append("-diag-disable=10441")
  302. job.clang_tidy = False
  303. case _:
  304. raise ValueError(f"Invalid intel={spec.intel}")
  305. job.source_cmd = f"source /opt/intel/oneapi/setvars.sh;"
  306. job.intel = True
  307. job.shell = "bash"
  308. job.cmake_arguments.extend((
  309. f"-DCMAKE_C_COMPILER={job.cc}",
  310. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  311. "-DCMAKE_SYSTEM_NAME=Linux",
  312. ))
  313. match spec.platform:
  314. case SdlPlatform.Msvc:
  315. job.setup_ninja = not spec.gdk
  316. job.clang_tidy = False # complains about \threadsafety: "unknown command tag name [clang-diagnostic-documentation-unknown-command]"
  317. job.msvc_project = spec.msvc_project if spec.msvc_project else ""
  318. job.msvc_project_flags.append("-p:TreatWarningsAsError=true")
  319. job.test_pkg_config = False
  320. job.shared_lib = SharedLibType.WIN32
  321. job.static_lib = StaticLibType.MSVC
  322. job.cmake_arguments.extend((
  323. "-DCMAKE_MSVC_DEBUG_INFORMATION_FORMAT=ProgramDatabase",
  324. "-DCMAKE_EXE_LINKER_FLAGS=-DEBUG",
  325. "-DCMAKE_SHARED_LINKER_FLAGS=-DEBUG",
  326. ))
  327. if spec.uwp:
  328. job.cmake_arguments.append("'-DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded$<$<CONFIG:Debug>:Debug>DLL'")
  329. else:
  330. job.cmake_arguments.append("'-DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreaded$<$<CONFIG:Debug>:Debug>'")
  331. if spec.clang_cl:
  332. job.cmake_arguments.extend((
  333. "-DCMAKE_C_COMPILER=clang-cl",
  334. "-DCMAKE_CXX_COMPILER=clang-cl",
  335. ))
  336. match spec.msvc_arch:
  337. case MsvcArch.X86:
  338. job.cflags.append("/clang:-m32")
  339. job.ldflags.append("/MACHINE:X86")
  340. case MsvcArch.X64:
  341. job.cflags.append("/clang:-m64")
  342. job.ldflags.append("/MACHINE:X64")
  343. case _:
  344. raise ValueError(f"Unsupported clang-cl architecture (arch={spec.msvc_arch})")
  345. if spec.msvc_project:
  346. match spec.msvc_arch:
  347. case MsvcArch.X86:
  348. msvc_platform = "Win32"
  349. case MsvcArch.X64:
  350. msvc_platform = "x64"
  351. case _:
  352. raise ValueError(f"Unsupported vcxproj architecture (arch={spec.msvc_arch})")
  353. if spec.gdk:
  354. msvc_platform = f"Gaming.Desktop.{msvc_platform}"
  355. job.msvc_project_flags.append(f"-p:Platform={msvc_platform}")
  356. match spec.msvc_arch:
  357. case MsvcArch.X86:
  358. job.msvc_vcvars = "x64_x86"
  359. case MsvcArch.X64:
  360. job.msvc_vcvars = "x64"
  361. case MsvcArch.Arm32:
  362. job.msvc_vcvars = "x64_arm"
  363. job.run_tests = False
  364. case MsvcArch.Arm64:
  365. job.msvc_vcvars = "x64_arm64"
  366. job.run_tests = False
  367. if spec.uwp:
  368. job.build_tests = False
  369. job.cmake_arguments.extend((
  370. "-DCMAKE_SYSTEM_NAME=WindowsStore",
  371. "-DCMAKE_SYSTEM_VERSION=10.0",
  372. ))
  373. job.msvc_project_flags.append("-p:WindowsTargetPlatformVersion=10.0.17763.0")
  374. elif spec.gdk:
  375. job.setup_gdk_folder = "VisualC-GDK"
  376. else:
  377. match spec.msvc_arch:
  378. case MsvcArch.X86:
  379. job.setup_libusb_arch = "x86"
  380. case MsvcArch.X64:
  381. job.setup_libusb_arch = "x64"
  382. case SdlPlatform.Linux:
  383. job.apt_packages.extend((
  384. "gnome-desktop-testing",
  385. "libasound2-dev",
  386. "libpulse-dev",
  387. "libaudio-dev",
  388. "libjack-dev",
  389. "libsndio-dev",
  390. "libusb-1.0-0-dev",
  391. "libx11-dev",
  392. "libxext-dev",
  393. "libxrandr-dev",
  394. "libxcursor-dev",
  395. "libxfixes-dev",
  396. "libxi-dev",
  397. "libxss-dev",
  398. "libwayland-dev",
  399. "libxkbcommon-dev",
  400. "libdrm-dev",
  401. "libgbm-dev",
  402. "libgl1-mesa-dev",
  403. "libgles2-mesa-dev",
  404. "libegl1-mesa-dev",
  405. "libdbus-1-dev",
  406. "libibus-1.0-dev",
  407. "libudev-dev",
  408. "fcitx-libs-dev",
  409. ))
  410. if trackmem_symbol_names:
  411. # older libunwind is slow
  412. job.cmake_arguments.append("-DSDLTEST_TIMEOUT_MULTIPLIER=2")
  413. job.apt_packages.extend((
  414. "libunwind-dev", # For SDL_test memory tracking
  415. ))
  416. job.shared_lib = SharedLibType.SO_0
  417. job.static_lib = StaticLibType.A
  418. fpic = True
  419. assert spec.os.value.startswith("ubuntu-")
  420. ubuntu_year, ubuntu_month = [int(v) for v in spec.os.value.removeprefix("ubuntu-").split(".", 1)]
  421. if ubuntu_year >= 22:
  422. job.apt_packages.extend(("libpipewire-0.3-dev", "libdecor-0-dev"))
  423. case SdlPlatform.Ios | SdlPlatform.Tvos:
  424. job.brew_packages.extend([
  425. "ninja",
  426. "pkg-config",
  427. ])
  428. job.clang_tidy = False
  429. job.run_tests = False
  430. job.test_pkg_config = False
  431. job.shared_lib = SharedLibType.DYLIB
  432. job.static_lib = StaticLibType.A
  433. match spec.platform:
  434. case SdlPlatform.Ios:
  435. if spec.xcode:
  436. job.xcode_sdk = 'iphoneos'
  437. job.cmake_arguments.extend([
  438. "-DCMAKE_SYSTEM_NAME=iOS",
  439. "-DCMAKE_OSX_ARCHITECTURES=\"arm64\"",
  440. ])
  441. case SdlPlatform.Tvos:
  442. if spec.xcode:
  443. job.xcode_sdk = 'appletvos'
  444. job.cmake_arguments.extend([
  445. "-DCMAKE_SYSTEM_NAME=tvOS",
  446. "-DCMAKE_OSX_ARCHITECTURES=\"arm64\"",
  447. ])
  448. case SdlPlatform.MacOS:
  449. if spec.apple_framework:
  450. job.static = False
  451. job.clang_tidy = False
  452. job.test_pkg_config = False
  453. job.cmake_arguments.extend((
  454. "'-DCMAKE_OSX_ARCHITECTURES=x86_64;arm64'",
  455. "-DSDL_FRAMEWORK=ON",
  456. ))
  457. job.shared_lib = SharedLibType.FRAMEWORK
  458. else:
  459. job.clang_tidy = True
  460. job.cmake_arguments.extend((
  461. "-DCMAKE_OSX_ARCHITECTURES=arm64",
  462. "-DCLANG_TIDY_BINARY=$(brew --prefix llvm)/bin/clang-tidy",
  463. ))
  464. job.shared_lib = SharedLibType.DYLIB
  465. job.static_lib = StaticLibType.A
  466. job.apt_packages = []
  467. job.brew_packages.append("ninja")
  468. if job.test_pkg_config:
  469. job.brew_packages.append("pkg-config")
  470. if job.clang_tidy:
  471. job.brew_packages.append("llvm")
  472. if spec.xcode:
  473. job.xcode_sdk = "macosx"
  474. case SdlPlatform.Android:
  475. job.android_gradle = spec.android_gradle
  476. job.android_mk = spec.android_mk
  477. job.run_tests = False
  478. job.shared_lib = SharedLibType.SO
  479. job.static_lib = StaticLibType.A
  480. if spec.android_mk or not spec.no_cmake:
  481. job.android_ndk = True
  482. if spec.android_gradle or not spec.no_cmake:
  483. job.java = True
  484. if spec.android_mk or spec.android_gradle:
  485. job.apt_packages = []
  486. if not spec.no_cmake:
  487. job.cmake_arguments.extend((
  488. f"-DANDROID_PLATFORM={spec.android_platform}",
  489. f"-DANDROID_ABI={spec.android_abi}",
  490. ))
  491. job.cmake_toolchain_file = "${ANDROID_NDK_HOME}/build/cmake/android.toolchain.cmake"
  492. job.cc = f"${{ANDROID_NDK_HOME}}/toolchains/llvm/prebuilt/linux-x86_64/bin/clang --target={spec.android_arch}-none-linux-androideabi{spec.android_platform}"
  493. job.android_apks = [
  494. "testaudiorecording-apk",
  495. "testautomation-apk",
  496. "testcontroller-apk",
  497. "testmultiaudio-apk",
  498. "testsprite-apk",
  499. ]
  500. case SdlPlatform.Emscripten:
  501. job.clang_tidy = False # clang-tidy does not understand -gsource-map
  502. job.shared = False
  503. job.cmake_config_emulator = "emcmake"
  504. job.cmake_build_type = "Debug"
  505. job.test_pkg_config = False
  506. job.apt_packages.append("python3-selenium")
  507. job.cmake_arguments.extend((
  508. "-DSDLTEST_BROWSER=chrome",
  509. "-DSDLTEST_TIMEOUT_MULTIPLIER=4",
  510. "-DSDLTEST_CHROME_BINARY=${CHROME_BINARY}",
  511. ))
  512. job.cflags.extend((
  513. "-gsource-map",
  514. "-ffile-prefix-map=${PWD}=/SDL",
  515. ))
  516. job.ldflags.extend((
  517. "--source-map-base", "/",
  518. ))
  519. pretest_cmd.extend((
  520. "# Start local HTTP server",
  521. "cmake --build build --target serve-sdl-tests --verbose &",
  522. "chrome --version",
  523. "chromedriver --version",
  524. ))
  525. job.static_lib = StaticLibType.A
  526. case SdlPlatform.Ps2:
  527. build_parallel = False
  528. job.shared = False
  529. job.sudo = ""
  530. job.apt_packages = []
  531. job.apk_packages = ["cmake", "gmp", "mpc1", "mpfr4", "ninja", "pkgconf", "git", ]
  532. job.cmake_toolchain_file = "${PS2DEV}/ps2sdk/ps2dev.cmake"
  533. job.clang_tidy = False
  534. job.run_tests = False
  535. job.shared = False
  536. job.cc = "mips64r5900el-ps2-elf-gcc"
  537. job.ldflags = ["-L${PS2DEV}/ps2sdk/ee/lib", "-L${PS2DEV}/gsKit/lib", "-L${PS2DEV}/ps2sdk/ports/lib", ]
  538. job.static_lib = StaticLibType.A
  539. case SdlPlatform.Psp:
  540. build_parallel = False
  541. job.sudo = ""
  542. job.apt_packages = []
  543. job.apk_packages = ["cmake", "gmp", "mpc1", "mpfr4", "ninja", "pkgconf", ]
  544. job.cmake_toolchain_file = "${PSPDEV}/psp/share/pspdev.cmake"
  545. job.clang_tidy = False
  546. job.run_tests = False
  547. job.shared = False
  548. job.cc = "psp-gcc"
  549. job.ldflags = ["-L${PSPDEV}/lib", "-L${PSPDEV}/psp/lib", "-L${PSPDEV}/psp/sdk/lib", ]
  550. job.pollute_directories = ["${PSPDEV}/include", "${PSPDEV}/psp/include", "${PSPDEV}/psp/sdk/include", ]
  551. job.static_lib = StaticLibType.A
  552. case SdlPlatform.Vita:
  553. job.sudo = ""
  554. job.apt_packages = []
  555. job.apk_packages = ["cmake", "ninja", "pkgconf", "bash", "tar"]
  556. job.cmake_toolchain_file = "${VITASDK}/share/vita.toolchain.cmake"
  557. assert spec.vita_gles is not None
  558. job.setup_vita_gles_type = {
  559. VitaGLES.Pib: "pib",
  560. VitaGLES.Pvr: "pvr",
  561. }[spec.vita_gles]
  562. job.cmake_arguments.extend((
  563. f"-DVIDEO_VITA_PIB={ 'true' if spec.vita_gles == VitaGLES.Pib else 'false' }",
  564. f"-DVIDEO_VITA_PVR={ 'true' if spec.vita_gles == VitaGLES.Pvr else 'false' }",
  565. "-DSDL_ARMNEON=ON",
  566. "-DSDL_ARMSIMD=ON",
  567. ))
  568. # Fix vita.toolchain.cmake (https://github.com/vitasdk/vita-toolchain/pull/253)
  569. job.source_cmd = r"""sed -i -E "s#set\\( PKG_CONFIG_EXECUTABLE \"\\$\\{VITASDK}/bin/arm-vita-eabi-pkg-config\" \\)#set\\( PKG_CONFIG_EXECUTABLE \"${VITASDK}/bin/arm-vita-eabi-pkg-config\" CACHE PATH \"Path of pkg-config executable\" \\)#" ${VITASDK}/share/vita.toolchain.cmake"""
  570. job.clang_tidy = False
  571. job.run_tests = False
  572. job.shared = False
  573. job.cc = "arm-vita-eabi-gcc"
  574. job.static_lib = StaticLibType.A
  575. case SdlPlatform.Haiku:
  576. fpic = False
  577. job.run_tests = False
  578. job.cc = "x86_64-unknown-haiku-gcc"
  579. job.cxx = "x86_64-unknown-haiku-g++"
  580. job.sudo = ""
  581. job.cmake_arguments.extend((
  582. f"-DCMAKE_C_COMPILER={job.cc}",
  583. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  584. "-DCMAKE_SYSTEM_NAME=Haiku",
  585. ))
  586. job.shared_lib = SharedLibType.SO_0
  587. job.static_lib = StaticLibType.A
  588. case SdlPlatform.PowerPC64:
  589. # FIXME: Enable SDL_WERROR
  590. job.werror = False
  591. job.clang_tidy = False
  592. job.run_tests = False
  593. job.sudo = ""
  594. job.apt_packages = []
  595. job.shared_lib = SharedLibType.SO_0
  596. job.static_lib = StaticLibType.A
  597. case SdlPlatform.LoongArch64:
  598. job.run_tests = False
  599. job.cc = "${LOONGARCH64_CC}"
  600. job.cxx = "${LOONGARCH64_CXX}"
  601. job.cmake_arguments.extend((
  602. f"-DCMAKE_C_COMPILER={job.cc}",
  603. f"-DCMAKE_CXX_COMPILER={job.cxx}",
  604. "-DCMAKE_SYSTEM_NAME=Linux",
  605. ))
  606. job.shared_lib = SharedLibType.SO_0
  607. job.static_lib = StaticLibType.A
  608. case SdlPlatform.N3ds:
  609. job.shared = False
  610. job.apt_packages = ["ninja-build", "binutils"]
  611. job.clang_tidy = False
  612. job.run_tests = False
  613. job.cc_from_cmake = True
  614. job.cmake_toolchain_file = "${DEVKITPRO}/cmake/3DS.cmake"
  615. job.static_lib = StaticLibType.A
  616. case SdlPlatform.Msys2:
  617. job.shell = "msys2 {0}"
  618. assert spec.msys2_platform
  619. job.msys2_msystem = spec.msys2_platform.value
  620. job.msys2_env = {
  621. "mingw32": "mingw-w64-i686",
  622. "mingw64": "mingw-w64-x86_64",
  623. "clang32": "mingw-w64-clang-i686",
  624. "clang64": "mingw-w64-clang-x86_64",
  625. "ucrt64": "mingw-w64-ucrt-x86_64",
  626. }[spec.msys2_platform.value]
  627. job.msys2_no_perl = spec.msys2_platform in (Msys2Platform.Mingw32, Msys2Platform.Clang32)
  628. job.shared_lib = SharedLibType.WIN32
  629. job.static_lib = StaticLibType.A
  630. case SdlPlatform.Riscos:
  631. # FIXME: Enable SDL_WERROR
  632. job.werror = False
  633. job.apt_packages = ["cmake", "ninja-build"]
  634. job.test_pkg_config = False
  635. job.shared = False
  636. job.run_tests = False
  637. job.sudo = ""
  638. job.cmake_arguments.extend((
  639. "-DRISCOS:BOOL=ON",
  640. "-DCMAKE_DISABLE_PRECOMPILE_HEADERS:BOOL=ON",
  641. "-DSDL_GCC_ATOMICS:BOOL=OFF",
  642. ))
  643. job.cmake_toolchain_file = "/home/riscos/env/toolchain-riscos.cmake"
  644. job.static_lib = StaticLibType.A
  645. case SdlPlatform.FreeBSD | SdlPlatform.NetBSD:
  646. job.cpactions = True
  647. job.no_cmake = True
  648. job.run_tests = False
  649. job.apt_packages = []
  650. job.shared_lib = SharedLibType.SO_0
  651. job.static_lib = StaticLibType.A
  652. match spec.platform:
  653. case SdlPlatform.FreeBSD:
  654. job.cpactions_os = "freebsd"
  655. job.cpactions_version = "13.3"
  656. job.cpactions_arch = "x86-64"
  657. job.cpactions_setup_cmd = "sudo pkg update"
  658. job.cpactions_install_cmd = "sudo pkg install -y cmake ninja pkgconf libXcursor libXext libXinerama libXi libXfixes libXrandr libXScrnSaver libXxf86vm wayland wayland-protocols libxkbcommon mesa-libs libglvnd evdev-proto libinotify alsa-lib jackit pipewire pulseaudio sndio dbus zh-fcitx ibus libudev-devd"
  659. job.cmake_arguments.extend((
  660. "-DSDL_CHECK_REQUIRED_INCLUDES=/usr/local/include",
  661. "-DSDL_CHECK_REQUIRED_LINK_OPTIONS=-L/usr/local/lib",
  662. ))
  663. case SdlPlatform.NetBSD:
  664. job.cpactions_os = "netbsd"
  665. job.cpactions_version = "10.0"
  666. job.cpactions_arch = "x86-64"
  667. job.cpactions_setup_cmd = "export PATH=\"/usr/pkg/sbin:/usr/pkg/bin:/sbin:$PATH\"; export PKG_CONFIG_PATH=\"/usr/pkg/lib/pkgconfig\";export PKG_PATH=\"https://cdn.netBSD.org/pub/pkgsrc/packages/NetBSD/$(uname -p)/$(uname -r|cut -f \"1 2\" -d.)/All/\";echo \"PKG_PATH=$PKG_PATH\";echo \"uname -a -> \"$(uname -a)\"\";sudo -E sysctl -w security.pax.aslr.enabled=0;sudo -E sysctl -w security.pax.aslr.global=0;sudo -E pkgin clean;sudo -E pkgin update"
  668. job.cpactions_install_cmd = "sudo -E pkgin -y install cmake dbus pkgconf ninja-build pulseaudio libxkbcommon wayland wayland-protocols libinotify libusb1"
  669. case _:
  670. raise ValueError(f"Unsupported platform={spec.platform}")
  671. if not build_parallel:
  672. job.cmake_build_arguments.append("-j1")
  673. if job.cflags:
  674. job.cmake_arguments.append(f"-DCMAKE_C_FLAGS=\"{my_shlex_join(job.cflags)}\"")
  675. if job.cxxflags:
  676. job.cmake_arguments.append(f"-DCMAKE_CXX_FLAGS=\"{my_shlex_join(job.cxxflags)}\"")
  677. if job.ldflags:
  678. job.cmake_arguments.append(f"-DCMAKE_SHARED_LINKER_FLAGS=\"{my_shlex_join(job.ldflags)}\"")
  679. job.cmake_arguments.append(f"-DCMAKE_EXE_LINKER_FLAGS=\"{my_shlex_join(job.ldflags)}\"")
  680. job.pretest_cmd = "\n".join(pretest_cmd)
  681. def tf(b):
  682. return "ON" if b else "OFF"
  683. if fpic is not None:
  684. job.cmake_arguments.append(f"-DCMAKE_POSITION_INDEPENDENT_CODE={tf(fpic)}")
  685. if job.no_cmake:
  686. job.cmake_arguments = []
  687. return job
  688. def spec_to_platform(spec: JobSpec, enable_artifacts: bool, trackmem_symbol_names: bool) -> dict[str, str|bool]:
  689. logger.info("spec=%r", spec)
  690. job = spec_to_job(spec, trackmem_symbol_names=trackmem_symbol_names)
  691. logger.info("job=%r", job)
  692. platform = job.to_workflow(enable_artifacts=enable_artifacts)
  693. logger.info("platform=%r", platform)
  694. return platform
  695. def main():
  696. parser = argparse.ArgumentParser(allow_abbrev=False)
  697. parser.add_argument("--github-variable-prefix", default="platforms")
  698. parser.add_argument("--github-ci", action="store_true")
  699. parser.add_argument("--verbose", action="store_true")
  700. parser.add_argument("--commit-message-file")
  701. parser.add_argument("--no-artifact", dest="enable_artifacts", action="store_false")
  702. parser.add_argument("--trackmem-symbol-names", dest="trackmem_symbol_names", action="store_true")
  703. args = parser.parse_args()
  704. logging.basicConfig(level=logging.INFO if args.verbose else logging.WARNING)
  705. remaining_keys = set(JOB_SPECS.keys())
  706. all_level_keys = (
  707. # Level 1
  708. (
  709. "haiku",
  710. ),
  711. )
  712. filters = []
  713. if args.commit_message_file:
  714. with open(args.commit_message_file, "r") as f:
  715. commit_message = f.read()
  716. for m in re.finditer(r"\[sdl-ci-filter (.*)]", commit_message, flags=re.M):
  717. filters.append(m.group(1).strip(" \t\n\r\t'\""))
  718. if re.search(r"\[sdl-ci-artifacts?]", commit_message, flags=re.M):
  719. args.enable_artifacts = True
  720. if re.search(r"\[sdl-ci-(full-)?trackmem(-symbol-names)?]", commit_message, flags=re.M):
  721. args.trackmem_symbol_names = True
  722. if not filters:
  723. filters.append("*")
  724. logger.info("filters: %r", filters)
  725. all_level_platforms = {}
  726. all_platforms = {k: spec_to_platform(spec, enable_artifacts=args.enable_artifacts, trackmem_symbol_names=args.trackmem_symbol_names) for k, spec in JOB_SPECS.items()}
  727. for level_i, level_keys in enumerate(all_level_keys, 1):
  728. level_key = f"level{level_i}"
  729. logger.info("Level %d: keys=%r", level_i, level_keys)
  730. assert all(k in remaining_keys for k in level_keys)
  731. level_platforms = tuple(all_platforms[key] for key in level_keys)
  732. remaining_keys.difference_update(level_keys)
  733. all_level_platforms[level_key] = level_platforms
  734. logger.info("=" * 80)
  735. logger.info("Keys before filter: %r", remaining_keys)
  736. filtered_remaining_keys = set()
  737. for filter in filters:
  738. filtered_remaining_keys.update(fnmatch.filter(remaining_keys, filter))
  739. logger.info("Keys after filter: %r", filtered_remaining_keys)
  740. remaining_keys = filtered_remaining_keys
  741. logger.info("Remaining: %r", remaining_keys)
  742. all_level_platforms["others"] = tuple(all_platforms[key] for key in remaining_keys)
  743. if args.github_ci:
  744. for level, platforms in all_level_platforms.items():
  745. platforms_json = json.dumps(platforms)
  746. txt = f"{args.github_variable_prefix}-{level}={platforms_json}"
  747. logger.info("%s", txt)
  748. if "GITHUB_OUTPUT" in os.environ:
  749. with open(os.environ["GITHUB_OUTPUT"], "a") as f:
  750. f.write(txt)
  751. f.write("\n")
  752. else:
  753. logger.warning("GITHUB_OUTPUT not defined")
  754. return 0
  755. if __name__ == "__main__":
  756. raise SystemExit(main())