wip: sanitizers

rmacnak-google · rmacnak-google · commit c10e70a247d4 · 2025-12-08T15:12:29.000-08:00
diff --git a/.github/workflows/dart.yml b/.github/workflows/dart.yml
diff --git a/integration_tests/sanitize/analysis_options.yaml b/integration_tests/sanitize/analysis_options.yaml
diff --git a/integration_tests/sanitize/lib/libc.dart b/integration_tests/sanitize/lib/libc.dart
@@ -0,0 +1,20 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import "dart:ffi";
+
+@Native<Pointer Function(IntPtr)>(symbol: 'malloc')
+external Pointer malloc(int size);
+@Native<Void Function(Pointer)>(symbol: 'free')
+external void free(Pointer ptr);
+@Native<Void Function(Pointer, Int, Size)>(symbol: 'memset')
+external void memset(Pointer ptr, int char, int size);
+@Native<Void Function(Pointer, Int, Size)>(symbol: 'memset', isLeaf: true)
+external void memset_leaf(Pointer ptr, int char, int size);
+@Native<Void Function(Pointer, Pointer, Size)>(symbol: 'memcmp')
+external void memcmp(Pointer a, Pointer b, int size);
+@Native<Void Function(IntPtr)>(symbol: 'usleep', isLeaf: true)
+external void usleep_leaf(int useconds);
+@Native<Void Function()>(symbol: 'abort')
+external void abort();
diff --git a/integration_tests/sanitize/mono_pkg.yaml b/integration_tests/sanitize/mono_pkg.yaml
@@ -0,0 +1,16 @@
+# See https://pub.dev/packages/mono_repo
+
+sdk:
+- dev
+- pubspec
+
+os:
+- linux
+
+stages:
+- analyze_and_format:
+  - group:
+    - format
+    - analyze: --fatal-infos
+- unit_test:
+  - test
diff --git a/integration_tests/sanitize/pubspec.yaml b/integration_tests/sanitize/pubspec.yaml
@@ -0,0 +1,9 @@
+name: sanitize
+publish_to: none
+environment:
+  #sdk: ^3.10.0
+  sdk: ^3.7.0
+resolution: workspace
+dependencies:
+  test: any
+
diff --git a/integration_tests/sanitize/test/asan_environment_test.dart b/integration_tests/sanitize/test/asan_environment_test.dart
@@ -0,0 +1,26 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+@TestOn('vm-asan')
+library asan_environment_test;
+
+import 'package:test/test.dart';
+
+void main() {
+  test('const', () {
+    // I.e., correct during kernel compilation.
+    expect(const bool.fromEnvironment("dart.vm.asan"), equals(true));
+
+    expect(const bool.fromEnvironment("dart.vm.msan"), equals(false));
+    expect(const bool.fromEnvironment("dart.vm.tsan"), equals(false));
+  });
+
+  test('new', () {
+    // I.e., correct during VM lookup.
+    expect(new bool.fromEnvironment("dart.vm.asan"), equals(true));
+
+    expect(new bool.fromEnvironment("dart.vm.msan"), equals(false));
+    expect(new bool.fromEnvironment("dart.vm.tsan"), equals(false));
+  });
+}
diff --git a/integration_tests/sanitize/test/asan_test.dart b/integration_tests/sanitize/test/asan_test.dart
@@ -0,0 +1,18 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+@TestOn('vm-asan')
+library asan_test;
+
+import 'package:test/test.dart';
+import 'package:sanitize/libc.dart';
+import 'dart:ffi';
+
+void main() {
+  test('use-after-free', () {
+    var p = malloc(sizeOf<Long>()).cast<Long>();
+    free(p);
+    memset(p, 42, sizeOf<Long>());
+  });
+}
diff --git a/integration_tests/sanitize/test/environment_test.dart b/integration_tests/sanitize/test/environment_test.dart
@@ -0,0 +1,24 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+@TestOn('vm && !vm-asan && !vm-msan && !vm-tsan')
+library environment_test;
+
+import 'package:test/test.dart';
+
+void main() {
+  test('const', () {
+    // I.e., correct during kernel compilation.
+    expect(const bool.fromEnvironment("dart.vm.asan"), equals(false));
+    expect(const bool.fromEnvironment("dart.vm.msan"), equals(false));
+    expect(const bool.fromEnvironment("dart.vm.tsan"), equals(false));
+  });
+
+  test('new', () {
+    // I.e., correct during VM lookup.
+    expect(new bool.fromEnvironment("dart.vm.asan"), equals(false));
+    expect(new bool.fromEnvironment("dart.vm.msan"), equals(false));
+    expect(new bool.fromEnvironment("dart.vm.tsan"), equals(false));
+  });
+}
diff --git a/integration_tests/sanitize/test/msan_environment_test.dart b/integration_tests/sanitize/test/msan_environment_test.dart
@@ -0,0 +1,26 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+@TestOn('vm-msan')
+library msan_environment_test;
+
+import 'package:test/test.dart';
+
+void main() {
+  test('const', () {
+    // I.e., correct during kernel compilation.
+    expect(const bool.fromEnvironment("dart.vm.msan"), equals(true));
+
+    expect(const bool.fromEnvironment("dart.vm.asan"), equals(false));
+    expect(const bool.fromEnvironment("dart.vm.tsan"), equals(false));
+  });
+
+  test('new', () {
+    // I.e., correct during VM lookup.
+    expect(new bool.fromEnvironment("dart.vm.msan"), equals(true));
+
+    expect(new bool.fromEnvironment("dart.vm.asan"), equals(false));
+    expect(new bool.fromEnvironment("dart.vm.tsan"), equals(false));
+  });
+}
diff --git a/integration_tests/sanitize/test/msan_test.dart b/integration_tests/sanitize/test/msan_test.dart
@@ -0,0 +1,20 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+@TestOn('vm-msan')
+library msan_test;
+
+import 'package:sanitize/libc.dart';
+import 'package:test/test.dart';
+import 'dart:ffi';
+
+void main() {
+  test('uninitialized', () {
+    var a = malloc(8);
+    var b = malloc(8);
+    memcmp(a, b, 8);
+    free(b);
+    free(a);
+  });
+}
diff --git a/integration_tests/sanitize/test/tsan_environment_test.dart b/integration_tests/sanitize/test/tsan_environment_test.dart
@@ -0,0 +1,26 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+@TestOn('vm-tsan')
+library tsan_environment_test;
+
+import 'package:test/test.dart';
+
+void main() {
+  test('const', () {
+    // I.e., correct during kernel compilation.
+    expect(const bool.fromEnvironment("dart.vm.tsan"), equals(true));
+
+    expect(const bool.fromEnvironment("dart.vm.asan"), equals(false));
+    expect(const bool.fromEnvironment("dart.vm.msan"), equals(false));
+  });
+
+  test('new', () {
+    // I.e., correct during VM lookup.
+    expect(new bool.fromEnvironment("dart.vm.tsan"), equals(true));
+
+    expect(new bool.fromEnvironment("dart.vm.asan"), equals(false));
+    expect(new bool.fromEnvironment("dart.vm.msan"), equals(false));
+  });
+}
diff --git a/integration_tests/sanitize/test/tsan_test.dart b/integration_tests/sanitize/test/tsan_test.dart
@@ -0,0 +1,34 @@
+// Copyright (c) 2025, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+@TestOn('vm-tsan')
+library tsan_test;
+
+import 'package:sanitize/libc.dart';
+import 'package:test/test.dart';
+import 'dart:ffi';
+import 'dart:isolate';
+
+child(addr) {
+  var p = Pointer<IntPtr>.fromAddress(addr);
+  for (var i = 0; i < 50000; i++) {
+    memset(p, 42, sizeOf<IntPtr>()); // C racing.
+    usleep_leaf(100);
+  }
+}
+
+void main() {
+  test('data race', () async {
+    var p = malloc(sizeOf<IntPtr>()).cast<IntPtr>();
+    var f = Isolate.run(() => child(p.address));
+
+    for (var i = 0; i < 50000; i++) {
+      p[0] = p[0] + 1;  // Dart racing.
+      usleep_leaf(100);
+    }
+
+    await f;
+    free(p);
+  });
+}
diff --git a/pkgs/test_api/lib/src/backend/runtime.dart b/pkgs/test_api/lib/src/backend/runtime.dart
@@ -15,6 +15,27 @@ final class Runtime {
     Compiler.source,
     Compiler.exe,
   ], isDartVM: true);
+  static const Runtime vmAsan = Runtime(
+    'VM with Address Sanitizer',
+    'vm-asan',
+    Compiler.exe,
+    [Compiler.exe],
+    isDartVM: true,
+  );
+  static const Runtime vmMsan = Runtime(
+    'VM with Memory Sanitizer',
+    'vm-msan',
+    Compiler.exe,
+    [Compiler.exe],
+    isDartVM: true,
+  );
+  static const Runtime vmTsan = Runtime(
+    'VM with Thread Sanitizer',
+    'vm-tsan',
+    Compiler.exe,
+    [Compiler.exe],
+    isDartVM: true,
+  );
 
   /// Google Chrome.
   static const Runtime chrome = Runtime(
@@ -69,6 +90,9 @@ final class Runtime {
   /// The platforms that are supported by the test runner by default.
   static const List<Runtime> builtIn = [
     Runtime.vm,
+    Runtime.vmAsan,
+    Runtime.vmMsan,
+    Runtime.vmTsan,
     Runtime.chrome,
     Runtime.firefox,
     Runtime.safari,
diff --git a/pkgs/test_core/lib/src/runner/loader.dart b/pkgs/test_core/lib/src/runner/loader.dart
@@ -4,6 +4,7 @@
 
 import 'dart:async';
 import 'dart:io';
+import 'dart:ffi';
 
 import 'package:async/async.dart';
 import 'package:path/path.dart' as p;
@@ -65,7 +66,14 @@ class Loader {
   /// Creates a new loader that loads tests on platforms defined in
   /// [Configuration.current].
   Loader() {
-    _registerPlatformPlugin([Runtime.vm], VMPlatform.new);
+    _registerPlatformPlugin([
+      Runtime.vm,
+      if (Abi.current() == Abi.linuxX64 || Abi.current() == Abi.linuxArm64) ...[
+        Runtime.vmAsan,
+        Runtime.vmMsan,
+        Runtime.vmTsan,
+      ],
+    ], VMPlatform.new);
 
     platformCallbacks.forEach((runtime, plugin) {
       _registerPlatformPlugin([runtime], plugin);
diff --git a/pkgs/test_core/lib/src/runner/vm/platform.dart b/pkgs/test_core/lib/src/runner/vm/platform.dart
@@ -62,6 +62,7 @@ class VMPlatform extends PlatformPlugin {
       Process process;
       try {
         process = await _spawnExecutable(
+          platform,
           path,
           suiteConfig.metadata,
           serverSocket,
@@ -70,8 +71,12 @@ class VMPlatform extends PlatformPlugin {
         unawaited(serverSocket.close());
         rethrow;
       }
-      process.stdout.listen(stdout.add);
-      process.stderr.listen(stderr.add);
+      process.exitCode.then((exitCode) async {
+        if (exitCode != 0) {
+          // At least don't hang.
+          exit(exitCode);
+        }
+      });
       var socket = await serverSocket.first;
       outerChannel = MultiChannel<Object?>(jsonSocketStreamChannel(socket));
       cleanupCallbacks
@@ -186,11 +191,32 @@ class VMPlatform extends PlatformPlugin {
     () => Future.wait([_compiler.dispose(), _tempDir.deleteWithRetry()]),
   );
 
+  String _aotRuntimeFor(SuitePlatform platform) {
+    var sanSuffix = "";
+    switch (platform.runtime) {
+      case Runtime.vmAsan:
+        sanSuffix = "_asan";
+        break;
+      case Runtime.vmMsan:
+        sanSuffix = "_msan";
+        break;
+      case Runtime.vmTsan:
+        sanSuffix = "_tsan";
+        break;
+    }
+    var exeSuffix = Platform.isWindows ? ".exe" : "";
+    return p.join(
+      p.dirname(Platform.resolvedExecutable),
+      "dartaotruntime${sanSuffix}${exeSuffix}",
+    );
+  }
+
   /// Compiles [path] to a native executable and spawns it as a process.
   ///
   /// Sets up a communication channel as well by passing command line arguments
   /// for the host and port of [socket].
   Future<Process> _spawnExecutable(
+    SuitePlatform platform,
     String path,
     Metadata suiteMetadata,
     ServerSocket socket,
@@ -200,29 +226,41 @@ class VMPlatform extends PlatformPlugin {
         'Precompiled native executable tests are not supported at this time',
       );
     }
-    var executable = await _compileToNative(path, suiteMetadata);
-    return await Process.start(executable, [
+
+    var sharedLibrary = await _compileToNative(platform, path, suiteMetadata);
+    return await Process.start(_aotRuntimeFor(platform), [
+      sharedLibrary,
       socket.address.host,
       socket.port.toString(),
-    ]);
+      ], mode: ProcessStartMode.inheritStdio);
   }
 
-  /// Compiles [path] to a native executable using `dart compile exe`.
-  Future<String> _compileToNative(String path, Metadata suiteMetadata) async {
+  /// Compiles [path] to a native shared library using `dart compile aot-snapshot`.
+  Future<String> _compileToNative(
+    SuitePlatform platform,
+    String path,
+    Metadata suiteMetadata,
+  ) async {
     var bootstrapPath = await _bootstrapNativeTestFile(
       path,
       suiteMetadata.languageVersionComment ??
           await rootPackageLanguageVersionComment,
     );
-    var output = File(p.setExtension(bootstrapPath, '.exe'));
+    var output = File(p.setExtension(bootstrapPath, '.so'));
     var processResult = await Process.run(Platform.resolvedExecutable, [
       'compile',
-      'exe',
+      'aot-snapshot',
       bootstrapPath,
       '--output',
       output.path,
       '--packages',
       (await packageConfigUri).toFilePath(),
+      if (platform.runtime == Runtime.vmAsan)
+        '--target-sanitizer=asan',
+      if (platform.runtime == Runtime.vmMsan)
+        '--target-sanitizer=msan',
+      if (platform.runtime == Runtime.vmTsan)
+        '--target-sanitizer=tsan',
     ]);
     if (processResult.exitCode != 0 || !(await output.exists())) {
       throw LoadException(path, '''
diff --git a/pubspec.yaml b/pubspec.yaml
