Add support for NDK discovery and add --prefer-shared-library option (#12788)
* Add support for NDK discovery and add --prefer-shared-library option
We would like to be able to use native tools (e.g. simpleperf, gdb) with
precompiled flutter apps. The native tools work much better with *.so
files instead of the custom formats the Dart VM uses by default.
The reason for using blobs / instruction snapshots is that we do not
want to force flutter users to install the Android NDK.
This CL adds a `--prefer-shared-library` flag to e.g. `flutter build
apk` which will use the NDK compiler (if available) to turn the
precompiled app assembly file to an `*.so` file. If the NDK compiler is
not available it will default to the default behavior.
* Rebase, add test for NDK detection, augment flutter.gradle with @Input for flag
* Use InMemoryFileSystem for test
* Remove unused import
* Address some analyzer warnings
diff --git a/packages/flutter_tools/lib/src/android/android_sdk.dart b/packages/flutter_tools/lib/src/android/android_sdk.dart
index fb88234..a3946d5 100644
--- a/packages/flutter_tools/lib/src/android/android_sdk.dart
+++ b/packages/flutter_tools/lib/src/android/android_sdk.dart
@@ -57,63 +57,131 @@
}
class AndroidSdk {
- AndroidSdk(this.directory) {
+ AndroidSdk(this.directory, [this.ndkDirectory, this.ndkCompiler,
+ this.ndkCompilerArgs]) {
_init();
}
+ /// The path to the Android SDK.
final String directory;
+ /// The path to the NDK (can be `null`).
+ final String ndkDirectory;
+
+ /// The path to the NDK compiler (can be `null`).
+ final String ndkCompiler;
+
+ /// The mandatory arguments to the NDK compiler (can be `null`).
+ final List<String> ndkCompilerArgs;
+
List<AndroidSdkVersion> _sdkVersions;
AndroidSdkVersion _latestVersion;
static AndroidSdk locateAndroidSdk() {
- String androidHomeDir;
+ String findAndroidHomeDir() {
+ String androidHomeDir;
+ if (config.containsKey('android-sdk')) {
+ androidHomeDir = config.getValue('android-sdk');
+ } else if (platform.environment.containsKey(kAndroidHome)) {
+ androidHomeDir = platform.environment[kAndroidHome];
+ } else if (platform.isLinux) {
+ if (homeDirPath != null)
+ androidHomeDir = fs.path.join(homeDirPath, 'Android', 'Sdk');
+ } else if (platform.isMacOS) {
+ if (homeDirPath != null)
+ androidHomeDir = fs.path.join(homeDirPath, 'Library', 'Android', 'sdk');
+ } else if (platform.isWindows) {
+ if (homeDirPath != null)
+ androidHomeDir = fs.path.join(homeDirPath, 'AppData', 'Local', 'Android', 'sdk');
+ }
- if (config.containsKey('android-sdk')) {
- androidHomeDir = config.getValue('android-sdk');
- } else if (platform.environment.containsKey(kAndroidHome)) {
- androidHomeDir = platform.environment[kAndroidHome];
- } else if (platform.isLinux) {
- if (homeDirPath != null)
- androidHomeDir = fs.path.join(homeDirPath, 'Android', 'Sdk');
- } else if (platform.isMacOS) {
- if (homeDirPath != null)
- androidHomeDir = fs.path.join(homeDirPath, 'Library', 'Android', 'sdk');
- } else if (platform.isWindows) {
- if (homeDirPath != null)
- androidHomeDir = fs.path.join(homeDirPath, 'AppData', 'Local', 'Android', 'sdk');
+ if (androidHomeDir != null) {
+ if (validSdkDirectory(androidHomeDir))
+ return androidHomeDir;
+ if (validSdkDirectory(fs.path.join(androidHomeDir, 'sdk')))
+ return fs.path.join(androidHomeDir, 'sdk');
+ }
+
+ // in build-tools/$version/aapt
+ final List<File> aaptBins = os.whichAll('aapt');
+ for (File aaptBin in aaptBins) {
+ // Make sure we're using the aapt from the SDK.
+ aaptBin = fs.file(aaptBin.resolveSymbolicLinksSync());
+ final String dir = aaptBin.parent.parent.parent.path;
+ if (validSdkDirectory(dir))
+ return dir;
+ }
+
+ // in platform-tools/adb
+ final List<File> adbBins = os.whichAll('adb');
+ for (File adbBin in adbBins) {
+ // Make sure we're using the adb from the SDK.
+ adbBin = fs.file(adbBin.resolveSymbolicLinksSync());
+ final String dir = adbBin.parent.parent.path;
+ if (validSdkDirectory(dir))
+ return dir;
+ }
+
+ return null;
}
- if (androidHomeDir != null) {
- if (validSdkDirectory(androidHomeDir))
- return new AndroidSdk(androidHomeDir);
- if (validSdkDirectory(fs.path.join(androidHomeDir, 'sdk')))
- return new AndroidSdk(fs.path.join(androidHomeDir, 'sdk'));
+ String findNdk(String androidHomeDir) {
+ final String ndkDirectory = fs.path.join(androidHomeDir, 'ndk-bundle');
+ if (fs.isDirectorySync(ndkDirectory)) {
+ return ndkDirectory;
+ }
+ return null;
}
- // in build-tools/$version/aapt
- final List<File> aaptBins = os.whichAll('aapt');
- for (File aaptBin in aaptBins) {
- // Make sure we're using the aapt from the SDK.
- aaptBin = fs.file(aaptBin.resolveSymbolicLinksSync());
- final String dir = aaptBin.parent.parent.parent.path;
- if (validSdkDirectory(dir))
- return new AndroidSdk(dir);
+ String findNdkCompiler(String ndkDirectory) {
+ String directory;
+ if (platform.isLinux) {
+ directory = 'linux-x86_64';
+ } else if (platform.isMacOS) {
+ directory = 'darwin-x86_64';
+ }
+ if (directory != null) {
+ final String ndkCompiler = fs.path.join(ndkDirectory,
+ 'toolchains', 'arm-linux-androideabi-4.9', 'prebuilt', directory,
+ 'bin', 'arm-linux-androideabi-gcc');
+ if (fs.isFileSync(ndkCompiler)) {
+ return ndkCompiler;
+ }
+ }
+ return null;
}
- // in platform-tools/adb
- final List<File> adbBins = os.whichAll('adb');
- for (File adbBin in adbBins) {
- // Make sure we're using the adb from the SDK.
- adbBin = fs.file(adbBin.resolveSymbolicLinksSync());
- final String dir = adbBin.parent.parent.path;
- if (validSdkDirectory(dir))
- return new AndroidSdk(dir);
+ List<String> computeNdkCompilerArgs(String ndkDirectory) {
+ final String armPlatform = fs.path.join(ndkDirectory, 'platforms',
+ 'android-9', 'arch-arm');
+ if (fs.isDirectorySync(armPlatform)) {
+ return <String>['--sysroot', armPlatform];
+ }
+ return null;
}
- // No dice.
- printTrace('Unable to locate an Android SDK.');
- return null;
+ final String androidHomeDir = findAndroidHomeDir();
+ if (androidHomeDir == null) {
+ // No dice.
+ printTrace('Unable to locate an Android SDK.');
+ return null;
+ }
+
+ // Try to find the NDK compiler. If we can't find it, it's also ok.
+ final String ndkDir = findNdk(androidHomeDir);
+ String ndkCompiler;
+ List<String> ndkCompilerArgs;
+ if (ndkDir != null) {
+ ndkCompiler = findNdkCompiler(ndkDir);
+ if (ndkCompiler != null) {
+ ndkCompilerArgs = computeNdkCompilerArgs(ndkDir);
+ if (ndkCompilerArgs == null) {
+ ndkCompiler = null;
+ }
+ }
+ }
+
+ return new AndroidSdk(androidHomeDir, ndkDir, ndkCompiler, ndkCompilerArgs);
}
static bool validSdkDirectory(String dir) {
diff --git a/packages/flutter_tools/lib/src/android/android_workflow.dart b/packages/flutter_tools/lib/src/android/android_workflow.dart
index 1fc76ae..99d1f6f 100644
--- a/packages/flutter_tools/lib/src/android/android_workflow.dart
+++ b/packages/flutter_tools/lib/src/android/android_workflow.dart
@@ -119,6 +119,14 @@
messages.add(new ValidationMessage('Android SDK at ${androidSdk.directory}'));
+ messages.add(new ValidationMessage(androidSdk.ndkDirectory == null
+ ? 'Unable to locate Android NDK.\n'
+ : 'Android NDK at ${androidSdk.ndkDirectory}'));
+
+ messages.add(new ValidationMessage(androidSdk.ndkCompiler == null
+ ? 'Unable to locate compiler in Android NDK.\n'
+ : 'Compiler in Android NDK at ${androidSdk.ndkCompiler}'));
+
String sdkVersionText;
if (androidSdk.latestVersion != null) {
sdkVersionText = 'Android SDK ${androidSdk.latestVersion.buildToolsVersionName}';
diff --git a/packages/flutter_tools/lib/src/android/gradle.dart b/packages/flutter_tools/lib/src/android/gradle.dart
index bb930af..b3b5b74 100644
--- a/packages/flutter_tools/lib/src/android/gradle.dart
+++ b/packages/flutter_tools/lib/src/android/gradle.dart
@@ -4,6 +4,7 @@
import 'dart:async';
+import '../android/android_sdk.dart';
import '../artifacts.dart';
import '../base/common.dart';
import '../base/file_system.dart';
@@ -289,12 +290,17 @@
if (target != null) {
command.add('-Ptarget=$target');
}
- if (buildInfo.previewDart2)
+ if (buildInfo.previewDart2) {
command.add('-Ppreview-dart-2=true');
if (buildInfo.extraFrontEndOptions != null)
command.add('-Pextra-front-end-options=${buildInfo.extraFrontEndOptions}');
if (buildInfo.extraGenSnapshotOptions != null)
command.add('-Pextra-gen-snapshot-options=${buildInfo.extraGenSnapshotOptions}');
+ }
+ if (buildInfo.preferSharedLibrary && androidSdk.ndkCompiler != null) {
+ command.add('-Pprefer-shared-library=true');
+ }
+
command.add(assembleTask);
final int exitCode = await runCommandAndStreamOutput(
command,
diff --git a/packages/flutter_tools/lib/src/build_info.dart b/packages/flutter_tools/lib/src/build_info.dart
index 3454552..154a2ec 100644
--- a/packages/flutter_tools/lib/src/build_info.dart
+++ b/packages/flutter_tools/lib/src/build_info.dart
@@ -13,7 +13,8 @@
const BuildInfo(this.mode, this.flavor,
{this.previewDart2,
this.extraFrontEndOptions,
- this.extraGenSnapshotOptions});
+ this.extraGenSnapshotOptions,
+ this.preferSharedLibrary});
final BuildMode mode;
/// Represents a custom Android product flavor or an Xcode scheme, null for
@@ -33,6 +34,9 @@
/// Extra command-line options for gen_snapshot.
final String extraGenSnapshotOptions;
+ // Whether to prefer AOT compiling to a *so file.
+ final bool preferSharedLibrary;
+
static const BuildInfo debug = const BuildInfo(BuildMode.debug, null);
static const BuildInfo profile = const BuildInfo(BuildMode.profile, null);
static const BuildInfo release = const BuildInfo(BuildMode.release, null);
diff --git a/packages/flutter_tools/lib/src/commands/build_aot.dart b/packages/flutter_tools/lib/src/commands/build_aot.dart
index d2b1510..4339f52 100644
--- a/packages/flutter_tools/lib/src/commands/build_aot.dart
+++ b/packages/flutter_tools/lib/src/commands/build_aot.dart
@@ -4,6 +4,7 @@
import 'dart:async';
+import '../android/android_sdk.dart';
import '../artifacts.dart';
import '../base/build.dart';
import '../base/common.dart';
@@ -48,7 +49,9 @@
allowMultiple: true,
splitCommas: true,
hide: true,
- );
+ )
+ ..addFlag('prefer-shared-library', negatable: false,
+ help: 'Whether to prefer compiling to a *.so file (android only).');
}
@override
@@ -80,6 +83,7 @@
previewDart2: argResults['preview-dart-2'],
extraFrontEndOptions: argResults[FlutterOptions.kExtraFrontEndOptions],
extraGenSnapshotOptions: argResults[FlutterOptions.kExtraGenSnapshotOptions],
+ preferSharedLibrary: argResults['prefer-shared-library'],
);
status?.stop();
@@ -110,6 +114,7 @@
bool previewDart2: false,
List<String> extraFrontEndOptions,
List<String> extraGenSnapshotOptions,
+ bool preferSharedLibrary: false,
}) async {
outputPath ??= getAotBuildDirectory();
try {
@@ -122,6 +127,7 @@
previewDart2: previewDart2,
extraFrontEndOptions: extraFrontEndOptions,
extraGenSnapshotOptions: extraGenSnapshotOptions,
+ preferSharedLibrary: preferSharedLibrary,
);
} on String catch (error) {
// Catch the String exceptions thrown from the `runCheckedSync` methods below.
@@ -140,6 +146,7 @@
bool previewDart2: false,
List<String> extraFrontEndOptions,
List<String> extraGenSnapshotOptions,
+ bool preferSharedLibrary: false,
}) async {
outputPath ??= getAotBuildDirectory();
if (!isAotBuildMode(buildMode) && !interpreter) {
@@ -161,6 +168,16 @@
final String isolateSnapshotData = fs.path.join(outputDir.path, 'isolate_snapshot_data');
final String isolateSnapshotInstructions = fs.path.join(outputDir.path, 'isolate_snapshot_instr');
final String dependencies = fs.path.join(outputDir.path, 'snapshot.d');
+ final String assembly = fs.path.join(outputDir.path, 'snapshot_assembly.S');
+ final String assemblyO = fs.path.join(outputDir.path, 'snapshot_assembly.o');
+ final String assemblySo = fs.path.join(outputDir.path, 'app.so');
+ final bool compileToSharedLibrary =
+ preferSharedLibrary && androidSdk.ndkCompiler != null;
+
+ if (preferSharedLibrary && !compileToSharedLibrary) {
+ printStatus(
+ 'Could not find NDK compiler. Not building in shared library mode');
+ }
final String vmEntryPoints = artifacts.getArtifactPath(
Artifact.dartVmEntryPointsTxt,
@@ -192,20 +209,22 @@
// These paths are used only on iOS.
String snapshotDartIOS;
- String assembly;
switch (platform) {
case TargetPlatform.android_arm:
case TargetPlatform.android_x64:
case TargetPlatform.android_x86:
- outputPaths.addAll(<String>[
- vmSnapshotData,
- isolateSnapshotData,
- ]);
+ if (compileToSharedLibrary) {
+ outputPaths.add(assemblySo);
+ } else {
+ outputPaths.addAll(<String>[
+ vmSnapshotData,
+ isolateSnapshotData,
+ ]);
+ }
break;
case TargetPlatform.ios:
snapshotDartIOS = artifacts.getArtifactPath(Artifact.snapshotDart, platform, buildMode);
- assembly = fs.path.join(outputDir.path, 'snapshot_assembly.S');
inputPaths.add(snapshotDartIOS);
break;
case TargetPlatform.darwin_x64:
@@ -260,16 +279,23 @@
final String kIsolateSnapshotDataC = fs.path.join(outputDir.path, '$kIsolateSnapshotData.c');
final String kVmSnapshotDataO = fs.path.join(outputDir.path, '$kVmSnapshotData.o');
final String kIsolateSnapshotDataO = fs.path.join(outputDir.path, '$kIsolateSnapshotData.o');
- final String assemblyO = fs.path.join(outputDir.path, 'snapshot_assembly.o');
switch (platform) {
case TargetPlatform.android_arm:
case TargetPlatform.android_x64:
case TargetPlatform.android_x86:
+ if (compileToSharedLibrary) {
+ genSnapshotCmd.add('--snapshot_kind=app-aot-assembly');
+ genSnapshotCmd.add('--assembly=$assembly');
+ outputPaths.add(assemblySo);
+ } else {
+ genSnapshotCmd.addAll(<String>[
+ '--snapshot_kind=app-aot-blobs',
+ '--vm_snapshot_instructions=$vmSnapshotInstructions',
+ '--isolate_snapshot_instructions=$isolateSnapshotInstructions',
+ ]);
+ }
genSnapshotCmd.addAll(<String>[
- '--snapshot_kind=app-aot-blobs',
- '--vm_snapshot_instructions=$vmSnapshotInstructions',
- '--isolate_snapshot_instructions=$isolateSnapshotInstructions',
'--no-sim-use-hardfp', // Android uses the softfloat ABI.
'--no-use-integer-division', // Not supported by the Pixel in 32-bit mode.
]);
@@ -396,6 +422,19 @@
linkCommand.add(assemblyO);
}
await runCheckedAsync(linkCommand);
+ } else {
+ if (compileToSharedLibrary) {
+ // A word of warning: Instead of compiling via two steps, to a .o file and
+ // then to a .so file we use only one command. When using two commands
+ // gcc will end up putting a .eh_frame and a .debug_frame into the shared
+ // library. Without stripping .debug_frame afterwards, unwinding tools
+ // based upon libunwind use just one and ignore the contents of the other
+ // (which causes it to not look into the other section and therefore not
+ // find the correct unwinding information).
+ await runCheckedAsync(<String>[androidSdk.ndkCompiler]
+ ..addAll(androidSdk.ndkCompilerArgs)
+ ..addAll(<String>[ '-shared', '-nostdlib', '-o', assemblySo, assembly ]));
+ }
}
// Compute and record build fingerprint.
diff --git a/packages/flutter_tools/lib/src/commands/build_apk.dart b/packages/flutter_tools/lib/src/commands/build_apk.dart
index fc9d97f..ff53ab7 100644
--- a/packages/flutter_tools/lib/src/commands/build_apk.dart
+++ b/packages/flutter_tools/lib/src/commands/build_apk.dart
@@ -11,9 +11,13 @@
BuildApkCommand() {
usesTargetOption();
addBuildModeFlags();
- argParser.addFlag('preview-dart-2', negatable: false);
usesFlavorOption();
usesPubOption();
+
+ argParser
+ ..addFlag('preview-dart-2', negatable: false)
+ ..addFlag('prefer-shared-library', negatable: false,
+ help: 'Whether to prefer compiling to a *.so file (android only).');
}
@override
diff --git a/packages/flutter_tools/lib/src/runner/flutter_command.dart b/packages/flutter_tools/lib/src/runner/flutter_command.dart
index a61beed..ca37fd7 100644
--- a/packages/flutter_tools/lib/src/runner/flutter_command.dart
+++ b/packages/flutter_tools/lib/src/runner/flutter_command.dart
@@ -161,7 +161,10 @@
: null,
extraGenSnapshotOptions: argParser.options.containsKey(FlutterOptions.kExtraGenSnapshotOptions)
? argResults[FlutterOptions.kExtraGenSnapshotOptions]
- : null);
+ : null,
+ preferSharedLibrary: argParser.options.containsKey('prefer-shared-library')
+ ? argResults['prefer-shared-library']
+ : false);
}
void setupApplicationPackages() {
