Merge #174

174: CI improvements (cache, random layout, #jobs) r=Bromeon a=Bromeon

bors r+

Co-authored-by: Jan Haller <[email protected]>

Author: bors[bot]

.github/composite/godot-itest/action.yml

@@ -29,6 +29,11 @@ inputs:
     default: ''
     description: "Extra command line arguments for 'cargo build', e.g. features"
 
+  rust-env-rustflags:
+    required: false
+    default: ''
+    description: "Extra values for the RUSTFLAGS env var"
+
   with-llvm:
     required: false
     default: ''
@@ -88,6 +93,8 @@ runs:
       run: |
         cargo build -p itest ${{ inputs.rust-extra-args }}
       shell: bash
+      env:
+        RUSTFLAGS: ${{ inputs.rust-env-rustflags }}
 
     - name: "Run Godot integration tests"
       # Aborts immediately if Godot outputs certain keywords (would otherwise stall until CI runner times out).

.github/composite/rust/action.yml

@@ -32,6 +32,7 @@ runs:
     - name: "Configure"
       id: configure
       run: |
+        echo "Rust cache shared-key: '${{ runner.os }}-${{ inputs.rust }}${{ inputs.cache-key }}'"
         echo "components=$( for c in ${cs//,/ }; do echo -n ' --component' $c; done )" >> $GITHUB_OUTPUT
       env:
         cs: ${{ inputs.components }}
@@ -46,7 +47,18 @@ runs:
     - name: "Reuse cached dependencies"
       uses: Swatinem/rust-cache@v2
       with:
-        shared-key: ${{ inputs.cache-key }}
+        # A cache key that is used instead of the automatic `job`-based key, and is stable over multiple jobs.
+        # default: empty
+        shared-key: "${{ runner.os }}-${{ inputs.rust }}${{ inputs.cache-key }}"
+
+        # An additional cache key that is added alongside the automatic `job`-based
+        # cache key and can be used to further differentiate jobs.
+        # default: empty
+        key: ${{ inputs.cache-key }}
+
+        # Determines if the cache should be saved even when the workflow has failed.
+        # default: "false"
+        cache-on-failure: true
 
     - name: "Install LLVM"
       uses: ./.github/composite/llvm

.github/workflows/full-ci.yml

@@ -18,6 +18,12 @@ env:
 #  GDEXT_FEATURES: '--features crate/feature'
 #  GDEXT_CRATE_ARGS: '-p godot-codegen -p godot-ffi -p godot-core -p godot-macros -p godot'
 
+  # LSan options: https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer
+  # * report_objects: list individual leaked objects when running LeakSanitizer
+  LSAN_OPTIONS: report_objects=1
+
+  # ASan options: https://github.com/google/sanitizers/wiki/AddressSanitizerFlags
+
 defaults:
   run:
     shell: bash
@@ -96,22 +102,11 @@ jobs:
             godot-binary: godot.macos.editor.dev.x86_64
             with-llvm: true
 
-          - name: macos-double
-            os: macos-11
-            rust-toolchain: stable
-            godot-binary: godot.macos.editor.dev.double.x86_64
-            with-llvm: true
-
           - name: windows
             os: windows-latest
             rust-toolchain: stable-x86_64-pc-windows-msvc
             godot-binary: godot.windows.editor.dev.x86_64.exe
 
-          - name: windows-double
-            os: windows-latest
-            rust-toolchain: stable-x86_64-pc-windows-msvc
-            godot-binary: godot.windows.editor.dev.double.x86_64.exe
-
           # Don't use latest Ubuntu (22.04) as it breaks lots of ecosystem compatibility.
           # If ever moving to ubuntu-latest, need to manually install libtinfo5 for LLVM.
           - name: linux
@@ -125,20 +120,14 @@ jobs:
             rust-special: -minimal-deps
             godot-binary: godot.linuxbsd.editor.dev.x86_64
 
-          - name: linux-double
-            os: ubuntu-20.04
-            rust-toolchain: stable
-            godot-binary: godot.linuxbsd.editor.dev.double.x86_64
-            rust-extra-args: --features double-precision
-
     steps:
       - uses: actions/checkout@v3
 
       - name: "Install Rust"
         uses: ./.github/composite/rust
         with:
           rust: stable
-          cache-key: ${{ matrix.rust-special }} # 'minimal-deps' or empty/not defined
+          cache-key: ${{ matrix.rust-special }} # '-minimal-deps' or empty/not defined
           with-llvm: ${{ matrix.with-llvm }}
 
       - name: "Install Rust nightly (minimal deps)"
@@ -210,6 +199,12 @@ jobs:
             rust-toolchain: stable
             godot-binary: godot.linuxbsd.editor.dev.x86_64
 
+          - name: linux-double
+            os: ubuntu-20.04
+            rust-toolchain: stable
+            godot-binary: godot.linuxbsd.editor.dev.double.x86_64
+            rust-extra-args: --features double-precision
+
           # Special Godot binaries compiled with AddressSanitizer/LeakSanitizer to detect UB/leaks.
           # Additionally, the Godot source is patched to make dlclose() a no-op, as unloading dynamic libraries loses stacktrace and
           # cause false positives like println!. See https://github.com/google/sanitizers/issues/89.
@@ -218,21 +213,17 @@ jobs:
           # --disallow-focus: fail if #[itest(focus)] is encountered, to prevent running only a few tests for full CI
           - name: linux-memcheck-gcc
             os: ubuntu-20.04
-            rust-toolchain: stable
             godot-binary: godot.linuxbsd.editor.dev.x86_64.san
             godot-args: -- --disallow-focus
+            rust-toolchain: nightly
+            rust-env-rustflags: -Zrandomize-layout
 
           - name: linux-memcheck-clang
             os: ubuntu-20.04
-            rust-toolchain: stable
             godot-binary: godot.linuxbsd.editor.dev.x86_64.llvm.san
             godot-args: -- --disallow-focus
-
-          - name: linux-double
-            os: ubuntu-20.04
-            rust-toolchain: stable
-            godot-binary: godot.linuxbsd.editor.dev.double.x86_64
-            rust-extra-args: --features double-precision
+            rust-toolchain: nightly
+            rust-env-rustflags: -Zrandomize-layout
 
     steps:
       - uses: actions/checkout@v3
@@ -243,8 +234,10 @@ jobs:
           artifact-name: godot-${{ matrix.name }}
           godot-binary: ${{ matrix.godot-binary }}
           godot-args: ${{ matrix.godot-args }}
-          with-llvm: ${{ matrix.with-llvm }}
           rust-extra-args: ${{ matrix.rust-extra-args }}
+          rust-toolchain: ${{ matrix.rust-toolchain }}
+          rust-env-rustflags: ${{ matrix.rust-env-rustflags }}
+          with-llvm: ${{ matrix.with-llvm }}
 
 
   license-guard:

godot-ffi/src/global_registry.rs

@@ -19,7 +19,6 @@
 )]
 pub(crate) mod gen;
 
-mod global_registry;
 mod godot_ffi;
 mod opaque;
 mod plugins;
@@ -33,16 +32,12 @@ pub use crate::godot_ffi::{GodotFfi, GodotFuncMarshal};
 pub use gen::central::*;
 pub use gen::gdextension_interface::*;
 
-use crate::global_registry::GlobalRegistry; // needs `crate::`
-
 // ----------------------------------------------------------------------------------------------------------------------------------------------
-// Real implementation, when Godot engine is running
 
 struct GodotBinding {
     interface: GDExtensionInterface,
     library: GDExtensionClassLibraryPtr,
     method_table: GlobalMethodTable,
-    registry: GlobalRegistry,
 }
 
 /// Late-init globals
@@ -69,7 +64,6 @@ pub unsafe fn initialize(
     BINDING = Some(GodotBinding {
         interface: *interface,
         method_table: GlobalMethodTable::new(&*interface),
-        registry: GlobalRegistry::default(),
         library,
     });
 }
@@ -98,17 +92,6 @@ pub unsafe fn method_table() -> &'static GlobalMethodTable {
     &unwrap_ref_unchecked(&BINDING).method_table
 }
 
-/// # Safety
-///
-/// The interface must have been initialised with [`initialize`] before calling this function.
-///
-/// Calling this while another place holds a reference (threads, re-entrancy, iteration, etc) is immediate undefined behavior.
-// note: could potentially avoid &mut aliasing, using UnsafeCell/RefCell
-#[inline(always)]
-pub unsafe fn get_registry() -> &'static mut GlobalRegistry {
-    &mut unwrap_ref_unchecked_mut(&mut BINDING).registry
-}
-
 /// Makes sure that Godot is running, or panics. Debug mode only!
 macro_rules! debug_assert_godot {
     ($expr:expr) => {
@@ -130,15 +113,6 @@ unsafe fn unwrap_ref_unchecked<T>(opt: &Option<T>) -> &T {
     }
 }
 
-unsafe fn unwrap_ref_unchecked_mut<T>(opt: &mut Option<T>) -> &mut T {
-    debug_assert_godot!(opt.is_some());
-
-    match opt {
-        Some(ref mut val) => val,
-        None => std::hint::unreachable_unchecked(),
-    }
-}
-
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 
 #[macro_export]