Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

[macOS] Generate universal gen_snapshots #52885

Merged
merged 4 commits into from
May 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions build/archives/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -287,8 +287,8 @@ if (is_mac) {
output = "$full_platform_name$suffix/gen_snapshot.zip"
files = [
{
source = "$root_out_dir/gen_snapshot_$target_cpu"
destination = "gen_snapshot_$target_cpu"
source = "${root_out_dir}/gen_snapshot_${target_cpu}"
destination = "gen_snapshot_${target_cpu}"
},
]
}
Expand Down
1 change: 1 addition & 0 deletions ci/licenses_golden/excluded_files
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,7 @@
../../../flutter/sky/tools/create_embedder_framework.py
../../../flutter/sky/tools/create_full_ios_framework.py
../../../flutter/sky/tools/create_ios_framework.py
../../../flutter/sky/tools/create_macos_binary.py
../../../flutter/sky/tools/create_macos_framework.py
../../../flutter/sky/tools/create_macos_gen_snapshots.py
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DBC

What's the difference between create_macos_binary.py and create_macos_gen_snapshots.py? Do we need both of them?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh interesting -- create_macos_gen_snapshots is old and was used for iOS (and is hardcoded full of armv7 stuff); I guess we never cleaned it up?

I'll send out a patch to kill it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

create_macos_gen_snapshots is used in the generator which processes the output of the builds

"script": "flutter/sky/tools/create_macos_gen_snapshots.py"

To avoid the timeout and because an hour is really quite long to wait for the builds to clear, maybe the snapshots should be created in different builds, and then processed with the generator at the end?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, there should be examples of using global generators already in the ios/macos build json files, and I think that can work here if we know how to split the different targets across different builders.

../../../flutter/sky/tools/create_xcframework.py
Expand Down
54 changes: 46 additions & 8 deletions lib/snapshot/BUILD.gn
Original file line number Diff line number Diff line change
Expand Up @@ -186,16 +186,54 @@ if (host_os == "mac" && target_os != "mac" &&
#
# This target is used for builds targeting macOS.
if (host_os == "mac" && target_os == "mac") {
copy("create_macos_gen_snapshots") {
# The toolchain-specific output directory. For cross-compiles, this is a
# clang-x64 or clang-arm64 subdirectory of the top-level build directory.
host_output_dir =
get_label_info("$dart_src/runtime/bin:gen_snapshot($host_toolchain)",
"root_out_dir")
template("build_mac_gen_snapshot") {
assert(defined(invoker.host_arch))
host_cpu = invoker.host_arch

sources = [ "${host_output_dir}/gen_snapshot" ]
build_toolchain = "//build/toolchain/mac:clang_$host_cpu"
if (host_cpu == target_cpu) {
gen_snapshot_target_name = "gen_snapshot_host_targeting_host"
} else {
gen_snapshot_target_name = "gen_snapshot"
}
gen_snapshot_target =
"$dart_src/runtime/bin:$gen_snapshot_target_name($build_toolchain)"

copy(target_name) {
# The toolchain-specific output directory. For cross-compiles, this is a
# clang-x64 or clang-arm64 subdirectory of the top-level build directory.
output_dir = get_label_info(gen_snapshot_target, "root_out_dir")

sources = [ "${output_dir}/${gen_snapshot_target_name}" ]
outputs =
[ "${root_out_dir}/artifacts_$host_cpu/gen_snapshot_${target_cpu}" ]
deps = [ gen_snapshot_target ]
}
}

build_mac_gen_snapshot("create_macos_gen_snapshot_arm64_${target_cpu}") {
host_arch = "arm64"
}

build_mac_gen_snapshot("create_macos_gen_snapshot_x64_${target_cpu}") {
host_arch = "x64"
}

action("create_macos_gen_snapshots") {
script = "//flutter/sky/tools/create_macos_binary.py"
outputs = [ "${root_out_dir}/gen_snapshot_${target_cpu}" ]
deps = [ "$dart_src/runtime/bin:gen_snapshot($host_toolchain)" ]
args = [
"--in-arm64",
rebase_path("${root_out_dir}/artifacts_arm64/gen_snapshot_${target_cpu}"),
"--in-x64",
rebase_path("${root_out_dir}/artifacts_x64/gen_snapshot_${target_cpu}"),
"--out",
rebase_path("${root_out_dir}/gen_snapshot_${target_cpu}"),
]
deps = [
":create_macos_gen_snapshot_arm64_${target_cpu}",
":create_macos_gen_snapshot_x64_${target_cpu}",
]
}
}

Expand Down
54 changes: 54 additions & 0 deletions sky/tools/create_macos_binary.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
#!/usr/bin/env python3
#
# 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.

import argparse
import os
import subprocess
import sys


def canonical_path(path):
"""Returns the canonical path for the input path.
If the input path is not absolute, it is treated as relative to the engine
source tree's buildroot directory."""
if os.path.isabs(path):
return path
buildroot_dir = os.path.abspath(os.path.join(os.path.realpath(__file__), '..', '..', '..', '..'))
return os.path.join(buildroot_dir, path)


def assert_file_exists(binary_path, arch):
if not os.path.isfile(binary_path):
print('Cannot find macOS %s binary at %s' % (arch, binary_path))
sys.exit(1)


def create_universal_binary(in_arm64, in_x64, out):
subprocess.check_call(['lipo', in_arm64, in_x64, '-create', '-output', out])


def main():
parser = argparse.ArgumentParser(
description='Creates a universal binary from input arm64, x64 binaries'
)
parser.add_argument('--in-arm64', type=str, required=True)
parser.add_argument('--in-x64', type=str, required=True)
parser.add_argument('--out', type=str, required=True)
args = parser.parse_args()

in_arm64 = canonical_path(args.in_arm64)
in_x64 = canonical_path(args.in_x64)
out = canonical_path(args.out)

assert_file_exists(in_arm64, 'arm64')
assert_file_exists(in_x64, 'x64')
create_universal_binary(in_arm64, in_x64, out)

return 0


if __name__ == '__main__':
sys.exit(main())