2055532 - Build and package Metal ANGLE libraries on macOS

Status: RESOLVED FIXED

(Core :: Graphics, task)

Description

[Jamie Nicol [:jnicol]]

Vendor ANGLE's Metal backend sources in to tree, build libEGL.dylib and libGLESv2.dylib, and package them.

Comment 1

[Jamie Nicol [:jnicol]]

Attachment: Bug 2055532 - Update ANGLE's GN config to enable Metal backend on macOS. r?#gfx-reviewers

Selects libEGL as the target, rather than the translator. This
automatically also pulls in both libGLESv2 and the translator.

Add -Wno-unguarded-availability to mozilla_flags, allowing ANGLE's
Metal backend to compile despite using APIs too recent for Firefox's
minimum macOS version without guards.

Note that this does not set the flag for all ANGLE targets, only those
whose definition in ANGLE's GN build scripts include the flag, which
in practice is only angle_metal_backend. This is important, as it
means we can be confident that the translator, which we use on all
macOS versions, is safe to use. libEGL/libGLESv2 on the other hand,
must not be used on older macOS versions. We already ensure this is
the case by blocklisting Metal ANGLE on these macOS versions.

Comment 2

[Jamie Nicol [:jnicol]]

Attachment: Bug 2055532 - Add ANGLE patches required for ANGLE's Metal backend. r?#gfx-reviewers

This contains:

• A patch to allow building ANGLE's Metal backend for a minimum
  macOS version of 10.15. Note that it currently will only work at
  runtime on macOS 12 onwards, so Firefox must ensure it does not
  attempt to use ANGLE's Metal backend on older macOS versions.

• A simple copy-paste error bug fix. This has been submitted upstream,
  but at time of writing has not yet been merged.

• A patch to disable compiling ANGLE's internal shaders at build-time,
  which cannot currently be supported by our build system. They will
  instead be compiled at runtime.

Comment 3

[Jamie Nicol [:jnicol]]

Attachment: Bug 2055532 - Re-vendor ANGLE with Metal backend. r?#gfx-reviewers

Stay on the same base revision, but additionally pull in the required
files for the Metal backend.

Comment 4

[Jamie Nicol [:jnicol]]

Attachment: Bug 2055532 - Package ANGLE libraries on macOS. r?#gfx-reviewers

Ensure ANGLE's libEGL and libGLESv2 are packaged on macOS as well as
Windows.

Additionally update some stale comments: we've long since used ANGLE
for webrender in addition to WebGL, and as of this change it's no
longer only the D3D backend that is used.

Comment 5

[Jamie Nicol [:jnicol]]

Attachment: Bug 2055532 - Unblock WebGL on Metal ANGLE. r?#gfx-reviewers

Now that Metal ANGLE is built and packaged on macOS, we can unblock
it. Note that it is still disabled by default, but can be enabled by
setting the pref webgl.disable-angle to false.

It remains blocked for macOS versions prior to 12 and on devices with
multiple GPUs for the time being.

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/915a07dcf199
https://hg.mozilla.org/integration/autoland/rev/3f47ad29cce0
Update ANGLE's GN config to enable Metal backend on macOS. r=gfx-reviewers,bradwerth
https://github.com/mozilla-firefox/firefox/commit/e52f264a31db
https://hg.mozilla.org/integration/autoland/rev/35972fcc9014
Add ANGLE patches required for ANGLE's Metal backend. r=gfx-reviewers,bradwerth
https://github.com/mozilla-firefox/firefox/commit/b1a87124fba1
https://hg.mozilla.org/integration/autoland/rev/abb88660cb76
Re-vendor ANGLE with Metal backend. r=gfx-reviewers,bradwerth
https://github.com/mozilla-firefox/firefox/commit/cdbe8f0f2cfc
https://hg.mozilla.org/integration/autoland/rev/4d665bd90409
Package ANGLE libraries on macOS. r=gfx-reviewers,bradwerth
https://github.com/mozilla-firefox/firefox/commit/97d1a75f65f4
https://hg.mozilla.org/integration/autoland/rev/fc0640479d25
Unblock WebGL on Metal ANGLE. r=gfx-reviewers,bradwerth

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/291a4bd0ecbf
https://hg.mozilla.org/integration/autoland/rev/295564107ffe
Revert "Bug 2055532 - Unblock WebGL on Metal ANGLE. r=gfx-reviewers,bradwerth" for causing bustages in SystemInfo_macos.mm.

Comment 8

[Atila Butkovits]

Backed out for causing bustages in SystemInfo_macos.mm.

Backout link: https://hg.mozilla.org/integration/autoland/rev/295564107ffe

Push with failures: https://treeherder.mozilla.org/jobs?repo=autoland&resultStatus=testfailed%2Cbusted%2Cexception%2Cretry%2Cusercancel&revision=fc0640479d257516292163cc24526cc4e5e780d7&searchStr=build

Failure log: https://treeherder.mozilla.org/logviewer?job_id=579165184&repo=autoland&task=PI7j9ZNwQ2uluDs6TI1BZw.0&lineNumber=61667

Comment 9

[Jamie Nicol [:jnicol]]

Ah, gn_processor.py doesn't distinguish between macOS and iOS builds - it generates a macOS configuration then emits the moz.build files using the CONFIG["OS_TARGET"] == "Darwin" condition, which includes iOS. This means we were attempting to build the libEGL and libGLESv2 targets for iOS, but using a configuration intended for macOS, which led to attempting to include macOS-specific headers, which caused the iOS build to fail.

I had previously filed bug 2047963 about this limitation. I have worked around this for now with a bit of a kludge - replacing the CONFIG["OS_TARGET"] == "Darwin" conditions in the top-level generated moz.build file with CONFIG["MOZ_WIDGET_TOOLKIT"] == "cocoa" (which is macOS specific). Since the top-level moz.build file simply adds the required targets to DIRS, this ensures we don't pull in the libEGL and libGLESv2 specific targets on iOS, and instead only build the translator targets as before.

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://github.com/mozilla-firefox/firefox/commit/840f89767ff3
https://hg.mozilla.org/integration/autoland/rev/f939663fcb45
Update ANGLE's GN config to enable Metal backend on macOS. r=gfx-reviewers,bradwerth
https://github.com/mozilla-firefox/firefox/commit/9674b022da52
https://hg.mozilla.org/integration/autoland/rev/3ecd1bc3802f
Add ANGLE patches required for ANGLE's Metal backend. r=gfx-reviewers,bradwerth
https://github.com/mozilla-firefox/firefox/commit/cfb1a61e762c
https://hg.mozilla.org/integration/autoland/rev/8745a7ce5821
Re-vendor ANGLE with Metal backend. r=gfx-reviewers,bradwerth
https://github.com/mozilla-firefox/firefox/commit/f3a33f555fe8
https://hg.mozilla.org/integration/autoland/rev/3869c5c274fe
Package ANGLE libraries on macOS. r=gfx-reviewers,bradwerth
https://github.com/mozilla-firefox/firefox/commit/c188454c6b98
https://hg.mozilla.org/integration/autoland/rev/22ee779d7a7e
Unblock WebGL on Metal ANGLE. r=gfx-reviewers,bradwerth

Comment 11

[amarc]

https://hg.mozilla.org/mozilla-central/rev/f939663fcb45
https://hg.mozilla.org/mozilla-central/rev/3ecd1bc3802f
https://hg.mozilla.org/mozilla-central/rev/8745a7ce5821
https://hg.mozilla.org/mozilla-central/rev/3869c5c274fe
https://hg.mozilla.org/mozilla-central/rev/22ee779d7a7e