Skip to content

Commit 84e9f2f

Browse files
committed
ENH: Add support for cross-compiling Android with cibuildwheel
1 parent 3205db1 commit 84e9f2f

2 files changed

Lines changed: 76 additions & 0 deletions

File tree

mesonpy/__init__.py

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -744,6 +744,35 @@ def __init__(
744744
self._meson_cross_file.write_text(cross_file_data, encoding='utf-8')
745745
self._meson_args['setup'].extend(('--cross-file', os.fspath(self._meson_cross_file)))
746746

747+
# Android may be native-compiled (e.g. with Termux), cross-compiled with manual
748+
# Meson arguments, or cross-compiled with cibuildwheel, which uses a similar
749+
# approach to crossenv. In the latter case, we synthesize a cross file to make
750+
# that work out of the box.
751+
elif sysconfig.get_platform().startswith('android-') and 'CIBUILDWHEEL' in os.environ:
752+
cpu = platform.machine()
753+
cpu_family = 'arm' if cpu.startswith('arm') else 'x86' if cpu.endswith('86') else cpu
754+
755+
cross_file_data = textwrap.dedent(f'''
756+
[host_machine]
757+
system = 'android'
758+
subsystem = 'android'
759+
kernel = 'linux'
760+
cpu_family = {cpu_family!r}
761+
cpu = {cpu!r}
762+
endian = {sys.byteorder!r}
763+
764+
[properties]
765+
# cibuildwheel monkey-patches platform.system and platform.machine to
766+
# simulate running on Android, when it's actually running on Linux or
767+
# macOS. So the host and build machines will appear to match, but host
768+
# binaries cannot actually be run on the build machine. As described at
769+
# https://mesonbuild.com/Cross-compilation.html, we indicate this by
770+
# setting needs_exe_wrapper = true, but NOT setting exe_wrapper.
771+
needs_exe_wrapper = true
772+
''')
773+
self._meson_cross_file.write_text(cross_file_data, encoding='utf-8')
774+
self._meson_args['setup'].extend(('--cross-file', os.fspath(self._meson_cross_file)))
775+
747776
# Support iOS targets. iOS does not have native build tools and always
748777
# requires cross compilation: synthesize the appropriate cross file.
749778
elif sysconfig.get_platform().startswith('ios-'):

tests/test_project.py

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -378,6 +378,53 @@ def test_archflags_envvar_parsing_invalid(package_purelib_and_platlib, monkeypat
378378
os.environ.pop('_PYTHON_HOST_PLATFORM', None)
379379

380380

381+
@pytest.mark.parametrize(
382+
('cpu', 'cpu_family'),
383+
[
384+
('aarch64', 'aarch64'),
385+
('armv7l', 'arm'),
386+
('armv8l', 'arm'),
387+
('i686', 'x86'),
388+
('x86_64', 'x86_64'),
389+
],
390+
)
391+
@pytest.mark.parametrize('cross', [True, False])
392+
def test_android_project(package_simple, monkeypatch, tmp_path, cpu, cpu_family, cross):
393+
# Mock being on Android
394+
monkeypatch.setattr(sys, 'platform', 'android')
395+
monkeypatch.setattr(sys, 'byteorder', 'little')
396+
monkeypatch.setattr(platform, 'system', Mock(return_value='Android'))
397+
monkeypatch.setattr(platform, 'machine', Mock(return_value=cpu))
398+
monkeypatch.setattr(sysconfig, 'get_platform', Mock(return_value='android-24'))
399+
if cross:
400+
monkeypatch.setenv('CIBUILDWHEEL', '1')
401+
402+
# Meson may require some tools to be configured when fatal warnings are enabled.
403+
# Set the same set of variables as cibuildwheel.
404+
for name in ['ar', 'as', 'cc', 'cxx', 'ld', 'nm', 'ranlib', 'readelf', 'strip']:
405+
monkeypatch.setenv(name.upper(), f'/path/to/{name}')
406+
407+
# Create a project.
408+
project = mesonpy.Project(source_dir=package_simple, build_dir=tmp_path)
409+
410+
# When cross-compiling, a cross file should be generated and used.
411+
setup_args = project._meson_args['setup']
412+
cross_path = tmp_path / 'meson-python-cross-file.ini'
413+
if cross:
414+
assert setup_args[-2:] == ['--cross-file', str(cross_path)]
415+
cross_config = cross_path.read_text().splitlines()
416+
assert "system = 'android'" in cross_config
417+
assert "subsystem = 'android'" in cross_config
418+
assert "kernel = 'linux'" in cross_config
419+
assert f"cpu_family = '{cpu_family}'" in cross_config
420+
assert f"cpu = '{cpu}'" in cross_config
421+
assert "endian = 'little'" in cross_config
422+
assert 'needs_exe_wrapper = true' in cross_config
423+
else:
424+
assert '--cross-file' not in setup_args
425+
assert not cross_path.exists()
426+
427+
381428
@pytest.mark.skipif(sys.version_info < (3, 13), reason='requires Python 3.13 or higher')
382429
@pytest.mark.parametrize('multiarch', [
383430
'arm64-iphoneos',

0 commit comments

Comments
 (0)