Adds script to run malioc locally (flutter#185371)

gaaclarke · web-flow · commit 3dfc2cb52dbf · 2026-04-22T22:38:00.000Z
adds script to help running malioc locally ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [AI contribution guidelines] and understand my responsibilities, or I am not using AI tools. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. If this change needs to override an active code freeze, provide a comment explaining why. The code freeze workflow can be overridden by code reviewers. See pinned issues for any active code freezes with guidance. **Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.  [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [AI contribution guidelines]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#ai-contribution-guidelines [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
diff --git a/engine/src/flutter/impeller/tools/malioc_download_and_diff.dart b/engine/src/flutter/impeller/tools/malioc_download_and_diff.dart
@@ -0,0 +1,238 @@
+#!/usr/bin/env dart
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// This script automates the process of downloading the `malioc` (Mali Offline Compiler)
+// tools, running the GN and Ninja builds to generate shader performance statistics,
+// and diffing the results against the golden file (`malioc.json`).
+//
+// By default, it extracts the version of `malioc` specified in
+// `ci/builders/linux_unopt.json`, downloads it to a temporary directory, and
+// automatically cleans it up when finished.
+//
+// Usage:
+//   dart flutter/impeller/tools/malioc_download_and_diff.dart [options]
+//
+// Options:
+//   --config=<config>      The build configuration (default: android_debug_unopt).
+//   --target=<target>      The Ninja target to build (default: impeller).
+//   --malioc-path=<path>   Use a local `malioc` binary instead of downloading.
+//   --update               Update the golden file with the new results.
+
+// ignore_for_file: avoid_print
+
+import 'dart:convert';
+import 'dart:io';
+
+class Options {
+  Options(this.config, this.target, this.update, this.maliocPath);
+  final String config;
+  final String target;
+  final bool update;
+  final String? maliocPath;
+}
+
+void main(List<String> arguments) async {
+  if (!Platform.isLinux) {
+    print('Error: This script is only supported on Linux.');
+    exit(1);
+  }
+  final Options options = parseArgs(arguments);
+
+  final scriptFile = File(Platform.script.toFilePath());
+  final Directory toolsDir = scriptFile.parent;
+  final Directory impellerDir = toolsDir.parent;
+  final Directory flutterDir = impellerDir.parent;
+  final Directory srcRoot = flutterDir.parent;
+
+  Directory? tempDir;
+  String? maliocPath = options.maliocPath;
+
+  try {
+    if (maliocPath == null) {
+      tempDir = Directory.systemTemp.createTempSync('malioc_tools_');
+      final String armToolsVersion = await getArmToolsVersion(flutterDir);
+      print('Using arm_tools version: $armToolsVersion');
+      await downloadMalioc(tempDir, armToolsVersion);
+      maliocPath = await findMalioc(tempDir);
+    }
+    print('Using malioc at: $maliocPath');
+
+    await runGN(flutterDir, srcRoot, options.config, maliocPath);
+    await runNinja(srcRoot, options.config, options.target);
+    await runDiff(flutterDir, srcRoot, options.config, options.update);
+  } finally {
+    if (tempDir != null && tempDir.existsSync()) {
+      print('Cleaning up temporary directory: ${tempDir.path}');
+      await tempDir.delete(recursive: true);
+    }
+  }
+}
+
+Options parseArgs(List<String> arguments) {
+  var config = 'android_debug_unopt';
+  var target = 'impeller';
+  var update = false;
+  String? maliocPath;
+
+  for (var i = 0; i < arguments.length; i++) {
+    final String arg = arguments[i];
+    if (arg == '--config' && i + 1 < arguments.length) {
+      config = arguments[++i];
+    } else if (arg.startsWith('--config=')) {
+      config = arg.substring('--config='.length);
+    } else if (arg == '--target' && i + 1 < arguments.length) {
+      target = arguments[++i];
+    } else if (arg.startsWith('--target=')) {
+      target = arg.substring('--target='.length);
+    } else if (arg == '--malioc-path' && i + 1 < arguments.length) {
+      maliocPath = arguments[++i];
+    } else if (arg.startsWith('--malioc-path=')) {
+      maliocPath = arg.substring('--malioc-path='.length);
+    } else if (arg == '--update') {
+      update = true;
+    } else if (arg == '--help' || arg == '-h') {
+      print(
+        'Usage: dart malioc_download_and_diff.dart [--config=<config>] [--target=<target>] [--malioc-path=<path>] [--update]',
+      );
+      exit(0);
+    }
+  }
+  return Options(config, target, update, maliocPath);
+}
+
+Future<String> getArmToolsVersion(Directory flutterDir) async {
+  final jsonFile = File('${flutterDir.path}/ci/builders/linux_unopt.json');
+  if (!jsonFile.existsSync()) {
+    return 'last_updated:2023-02-03T15:32:01-0800';
+  }
+  try {
+    final String content = await jsonFile.readAsString();
+    final json = jsonDecode(content) as Map<String, dynamic>;
+    final builds = json['builds'] as List<dynamic>;
+    for (final build in builds) {
+      if (build is Map<String, dynamic> && build['name'] == 'ci/android_debug_unopt') {
+        final deps = build['dependencies'] as List<dynamic>?;
+        if (deps != null) {
+          for (final Object? dep in deps) {
+            if (dep is Map<String, dynamic> && dep['dependency'] == 'arm_tools') {
+              return dep['version'] as String;
+            }
+          }
+        }
+      }
+    }
+  } catch (e) {
+    print('Error parsing ${jsonFile.path}: $e');
+  }
+  return 'last_updated:2023-02-03T15:32:01-0800';
+}
+
+Future<void> downloadMalioc(Directory armToolsDir, String version) async {
+  if (!armToolsDir.existsSync()) {
+    await armToolsDir.create(recursive: true);
+  }
+
+  print('Initializing CIPD in ${armToolsDir.path}...');
+  final Process cipdInitProcess = await Process.start(
+    'cipd',
+    ['init'],
+    workingDirectory: armToolsDir.path,
+    mode: ProcessStartMode.inheritStdio,
+  );
+  final int initExitCode = await cipdInitProcess.exitCode;
+  if (initExitCode != 0) {
+    throw Exception('Error running cipd init: $initExitCode');
+  }
+
+  print('Downloading malioc tools to ${armToolsDir.path}...');
+  final Process cipdProcess = await Process.start('cipd', [
+    'install',
+    'flutter_internal/tools/arm-tools',
+    version,
+    '-root',
+    armToolsDir.path,
+  ], mode: ProcessStartMode.inheritStdio);
+  final int exitCode = await cipdProcess.exitCode;
+  if (exitCode != 0) {
+    throw Exception('Error running cipd install: $exitCode');
+  }
+}
+
+Future<String> findMalioc(Directory armToolsDir) async {
+  if (armToolsDir.existsSync()) {
+    await for (final FileSystemEntity entity in armToolsDir.list(recursive: true)) {
+      if (entity is File && entity.path.endsWith('/malioc')) {
+        return entity.path;
+      }
+    }
+  }
+  throw Exception('Could not find malioc executable in downloaded tools.');
+}
+
+Future<void> runGN(
+  Directory flutterDir,
+  Directory srcRoot,
+  String config,
+  String maliocPath,
+) async {
+  print('Running GN...');
+  final gnArgs = ['--malioc-path', maliocPath];
+  if (config == 'android_debug_unopt') {
+    gnArgs.addAll(['--android', '--unoptimized']);
+  } else if (config == 'host_debug_unopt') {
+    gnArgs.add('--unoptimized');
+  }
+
+  final Process process = await Process.start(
+    '${flutterDir.path}/tools/gn',
+    gnArgs,
+    workingDirectory: srcRoot.path,
+    mode: ProcessStartMode.inheritStdio,
+  );
+  final int exitCode = await process.exitCode;
+  if (exitCode != 0) {
+    throw Exception('Error running GN: $exitCode');
+  }
+}
+
+Future<void> runNinja(Directory srcRoot, String config, String target) async {
+  print("Building target '$target' in $config...");
+  final Process process = await Process.start(
+    'ninja',
+    ['-C', '${srcRoot.path}/out/$config', target],
+    workingDirectory: srcRoot.path,
+    mode: ProcessStartMode.inheritStdio,
+  );
+  final int exitCode = await process.exitCode;
+  if (exitCode != 0) {
+    throw Exception('Error running Ninja: $exitCode');
+  }
+}
+
+Future<void> runDiff(Directory flutterDir, Directory srcRoot, String config, bool update) async {
+  print('Generating diff...');
+  final diffArgs = [
+    '${flutterDir.path}/impeller/tools/malioc_diff.py',
+    '--before',
+    '${flutterDir.path}/impeller/tools/malioc.json',
+    '--after',
+    '${srcRoot.path}/out/$config/gen/malioc',
+    '--print-diff',
+  ];
+  if (update) {
+    diffArgs.add('--update');
+  }
+
+  final Process process = await Process.start(
+    'python3',
+    diffArgs,
+    workingDirectory: srcRoot.path,
+    mode: ProcessStartMode.inheritStdio,
+  );
+  final int exitCode = await process.exitCode;
+  if (exitCode != 0) {
+    throw Exception('Error running diff: $exitCode');
+  }
+}
