Add CBuilder.dynamicallyLinkTo option

dart-lang · Aug 13, 2024 · d059e00 · d059e00
1 parent f50745f
commit d059e00
Show file tree

Hide file tree

Showing 8 changed files with 121 additions and 40 deletions.
diff --git a/.github/workflows/native.yaml b/.github/workflows/native.yaml
@@ -141,7 +141,7 @@ jobs:
 
       - run: dart --enable-experiment=native-assets test
         working-directory: pkgs/${{ matrix.package }}/example/build/native_dynamic_linking/
-        if: ${{ matrix.package == 'native_assets_cli' && matrix.sdk == 'dev' && !matrix.breaking-chang && matrix.os != 'windows' }}
+        if: ${{ matrix.package == 'native_assets_cli' && matrix.sdk == 'dev' && !matrix.breaking-change }}
 
       - run: dart --enable-experiment=native-assets test
         working-directory: pkgs/${{ matrix.package }}/example/build/native_add_app/

diff --git a/pkgs/native_assets_cli/example/build/native_dynamic_linking/hook/build.dart b/pkgs/native_assets_cli/example/build/native_dynamic_linking/hook/build.dart
@@ -26,23 +26,19 @@ void main(List<String> args) async {
         sources: [
           'src/math.c',
         ],
-        // TODO(https://github.com/dart-lang/native/issues/190): Use specific
-        // API for linking once available.
-        flags: config.dynamicLinkingFlags('debug'),
+        dynamicallyLinkTo: ['debug'],
       ),
       CBuilder.library(
         name: 'add',
         assetName: 'add.dart',
         sources: [
           'src/add.c',
         ],
-        // TODO(https://github.com/dart-lang/native/issues/190): Use specific
-        // API for linking once available.
-        flags: config.dynamicLinkingFlags('math'),
+        dynamicallyLinkTo: ['math'],
       )
     ];
 
-    // Note: This builders need to be run sequentially because they depend on
+    // Note: These builders need to be run sequentially because they depend on
     // each others output.
     for (final builder in builders) {
       await builder.run(
@@ -53,20 +49,3 @@ void main(List<String> args) async {
     }
   });
 }
-
-extension on BuildConfig {
-  List<String> dynamicLinkingFlags(String libraryName) => switch (targetOS) {
-        OS.macOS => [
-            '-L${outputDirectory.toFilePath()}',
-            '-l$libraryName',
-          ],
-        OS.linux => [
-            '-Wl,-rpath=\$ORIGIN/.',
-            '-L${outputDirectory.toFilePath()}',
-            '-l$libraryName',
-          ],
-        // TODO(https://github.com/dart-lang/native/issues/1415): Enable support
-        // for Windows once linker flags are supported by CBuilder.
-        _ => throw UnimplementedError('Unsupported OS: $targetOS'),
-      };
-}
diff --git a/pkgs/native_assets_cli/test/example/native_dynamic_linking_test.dart b/pkgs/native_assets_cli/test/example/native_dynamic_linking_test.dart
@@ -6,9 +6,6 @@
   'mac-os': Timeout.factor(2),
   'windows': Timeout.factor(10),
 })
-// TODO(https://github.com/dart-lang/native/issues/1415): Enable support
-// for Windows once linker flags are supported by CBuilder.
-@TestOn('!windows')
 library;
 
 import 'dart:io';

diff --git a/pkgs/native_toolchain_c/lib/src/cbuilder/cbuilder.dart b/pkgs/native_toolchain_c/lib/src/cbuilder/cbuilder.dart
@@ -46,6 +46,15 @@ class CBuilder extends CTool implements Builder {
   /// Defaults to `true`.
   final bool ndebugDefine;
 
+  /// Libraries to dynamically link to.
+  ///
+  /// The libraries are expected to be at the root of the output directory of
+  /// the build hook invocation.
+  ///
+  /// When using this option ensure that the builders producing the libraries
+  /// to link to are run before this builder.
+  final List<String> dynamicallyLinkTo;
+
   CBuilder.library({
     required super.name,
     super.assetName,
@@ -62,6 +71,7 @@ class CBuilder extends CTool implements Builder {
     super.defines = const {},
     this.buildModeDefine = true,
     this.ndebugDefine = true,
+    this.dynamicallyLinkTo = const [],
     super.pic = true,
     super.std,
     super.language = Language.c,
@@ -83,6 +93,7 @@ class CBuilder extends CTool implements Builder {
     super.defines = const {},
     this.buildModeDefine = true,
     this.ndebugDefine = true,
+    this.dynamicallyLinkTo = const [],
     bool? pie = false,
     super.std,
     super.language = Language.c,
@@ -146,7 +157,10 @@ class CBuilder extends CTool implements Builder {
         executable: type == OutputType.executable ? exeUri : null,
         // ignore: invalid_use_of_visible_for_testing_member
         installName: installName,
-        flags: flags,
+        flags: [
+          ...flags,
+          ...config.dynamicLinkingFlags(dynamicallyLinkTo),
+        ],
         defines: {
           ...defines,
           if (buildModeDefine) config.buildMode.name.toUpperCase(): null,
@@ -195,3 +209,23 @@ class CBuilder extends CTool implements Builder {
     }
   }
 }
+
+extension on BuildConfig {
+  List<String> dynamicLinkingFlags(List<String> libraries) =>
+      switch (targetOS) {
+        OS.macOS || OS.iOS => [
+            '-L${outputDirectory.toFilePath()}',
+            for (final library in libraries) '-l$library',
+          ],
+        OS.linux || OS.android => [
+            '-Wl,-rpath=\$ORIGIN/.',
+            '-L${outputDirectory.toFilePath()}',
+            for (final library in libraries) '-l$library',
+          ],
+        OS.windows => [
+            for (final library in libraries)
+              outputDirectory.resolve('$library.lib').toFilePath(),
+          ],
+        _ => throw UnimplementedError('Unsupported OS: $targetOS'),
+      };
+}
diff --git a/pkgs/native_toolchain_c/test/cbuilder/cbuilder_test.dart b/pkgs/native_toolchain_c/test/cbuilder/cbuilder_test.dart
@@ -502,6 +502,69 @@ void main() {
       expect(compilerInvocation, contains('-l stdc++'));
     }
   });
+
+  test('CBuilder dynamicallyLinkTo', () async {
+    final tempUri = await tempDirForTest();
+    final dynamicallyLinkedCUri = packageUri.resolve(
+        'test/cbuilder/testfiles/dynamically_linked/src/dynamically_linked.c');
+    final addSrcUri = packageUri.resolve('test/cbuilder/testfiles/add/src/');
+    final addCUri = addSrcUri.resolve('add.c');
+
+    if (!await File.fromUri(dynamicallyLinkedCUri).exists()) {
+      throw Exception('Run the test from the root directory.');
+    }
+    const name = 'dynamically_linked';
+
+    final logMessages = <String>[];
+    final logger = createCapturingLogger(logMessages);
+
+    final buildConfig = BuildConfig.build(
+      outputDirectory: tempUri,
+      packageName: name,
+      packageRoot: tempUri,
+      targetArchitecture: Architecture.current,
+      targetOS: OS.current,
+      buildMode: BuildMode.release,
+      // Ignored by executables.
+      linkModePreference: LinkModePreference.dynamic,
+      cCompiler: CCompilerConfig(
+        compiler: cc,
+        envScript: envScript,
+        envScriptArgs: envScriptArgs,
+      ),
+      linkingEnabled: false,
+    );
+    final buildOutput = BuildOutput();
+
+    final builders = [
+      CBuilder.library(
+        name: 'add',
+        assetName: 'add',
+        sources: [addCUri.toFilePath()],
+      ),
+      CBuilder.executable(
+        name: name,
+        includes: [addSrcUri.toFilePath()],
+        sources: [dynamicallyLinkedCUri.toFilePath()],
+        dynamicallyLinkTo: ['add'],
+      )
+    ];
+    for (final builder in builders) {
+      await builder.run(
+        config: buildConfig,
+        output: buildOutput,
+        logger: logger,
+      );
+    }
+
+    final executableUri = tempUri.resolve(OS.current.executableFileName(name));
+    expect(await File.fromUri(executableUri).exists(), true);
+    final result = await runProcess(
+      executable: executableUri,
+      logger: logger,
+    );
+    expect(result.exitCode, 3);
+  });
 }
 
 Future<void> testDefines({

diff --git a/pkgs/native_toolchain_c/test/cbuilder/testfiles/add/src/add.c b/pkgs/native_toolchain_c/test/cbuilder/testfiles/add/src/add.c
@@ -2,17 +2,7 @@
 // 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.
 
-#include <stdint.h>
-
-#ifdef DEBUG
-#include <stdio.h>
-#endif
-
-#if _WIN32
-#define FFI_EXPORT __declspec(dllexport)
-#else
-#define FFI_EXPORT
-#endif
+#include "add.h"
 
 FFI_EXPORT int32_t add(int32_t a, int32_t b) {
 #ifdef DEBUG

diff --git a/pkgs/native_toolchain_c/test/cbuilder/testfiles/add/src/add.h b/pkgs/native_toolchain_c/test/cbuilder/testfiles/add/src/add.h
@@ -0,0 +1,13 @@
+// Copyright (c) 2024, 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.
+
+#include <stdint.h>
+
+#if _WIN32
+#define FFI_EXPORT __declspec(dllexport)
+#else
+#define FFI_EXPORT
+#endif
+
+FFI_EXPORT int32_t add(int32_t a, int32_t b);
diff --git a/pkgs/native_toolchain_c/test/cbuilder/testfiles/dynamically_linked/src/dynamically_linked.c b/pkgs/native_toolchain_c/test/cbuilder/testfiles/dynamically_linked/src/dynamically_linked.c
@@ -0,0 +1,5 @@
+#include "add.h"
+
+int main() {
+  return add(1, 2);
+}