Repository navigation
Expand file tree
/
Copy pathmx_graalpython_graalos.py
More file actions
465 lines (407 loc) · 20.1 KB
/
Copy pathmx_graalpython_graalos.py
File metadata and controls
465 lines (407 loc) · 20.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
# Copyright (c) 2026, Oracle and/or its affiliates. All rights reserved.
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
#
# The Universal Permissive License (UPL), Version 1.0
#
# Subject to the condition set forth below, permission is hereby granted to any
# person obtaining a copy of this software, associated documentation and/or
# data (collectively the "Software"), free of charge and under any and all
# copyright rights in the Software, and any and all patent rights owned or
# freely licensable by each licensor hereunder covering either (i) the
# unmodified Software as contributed to or provided by such licensor, or (ii)
# the Larger Works (as defined below), to deal in both
#
# (a) the Software, and
#
# (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
# one is included with the Software each a "Larger Work" to which the Software
# is contributed by such licensors),
#
# without restriction, including without limitation the rights to copy, create
# derivative works of, display, perform, and distribute the Software and make,
# use, sell, offer for sale, import, export, have made, and have sold the
# Software and the Larger Work(s), and to sublicense the foregoing rights on
# either these or other terms.
#
# This license is subject to the following condition:
#
# The above copyright notice and either this complete permission notice or at a
# minimum a reference to the UPL must be included in all copies or substantial
# portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
from __future__ import annotations
# pylint: disable=cyclic-import
import gzip
import json
import os
import re
import shutil
import sys
import tarfile
import tempfile
import urllib.parse
import urllib.request
from pathlib import Path
import mx
import mx_urlrewrites
SUITE = mx.suite('graalpython')
GRAALOS_VERSIONS_PATH = Path(__file__).parent / "graalos_versions.json"
def run(*args, **kwargs):
from mx_graalpython import run
return run(*args, **kwargs)
def _load_graalos_overlay_urls(ci_overlays_dir: Path):
overlay_path = ci_overlays_dir / "graalpython.jsonnet"
if not overlay_path.is_file():
mx.abort(f"Expected sibling ci-overlays checkout at {overlay_path}")
content = overlay_path.read_text(encoding="utf-8")
urls = {}
for env_name, version_name in (
("GRAALPY_GRAALOS_TOOLCHAIN_URL", "toolchain"),
("GRAALPY_GRAALOS_RUNTIME_URL", "runtime"),
):
match = re.search(rf'{env_name}:\s*"([^"]+)"', content)
if not match:
mx.abort(f"Could not find {env_name} in {overlay_path}")
urls[version_name] = match.group(1)
return urls
def update_graalos_versions():
ci_overlays_dir = Path(SUITE.dir).parent / "ci-overlays"
overlay_urls = _load_graalos_overlay_urls(ci_overlays_dir)
versions = {
name: resolve_latest_graalos_artifact_name(url)
for name, url in overlay_urls.items()
}
content = json.dumps(versions, indent=2, sort_keys=True)
content += "\n"
mx.update_file(GRAALOS_VERSIONS_PATH.as_posix(), content, showDiff=True)
SUITE.vc.git_command(SUITE.dir, ["add", str(GRAALOS_VERSIONS_PATH.relative_to(SUITE.dir))], abortOnError=True)
def resolve_latest_graalos_artifact_name(source, on_fail=mx.abort):
source = mx_urlrewrites.rewriteurl(source)
with urllib.request.urlopen(urllib.request.Request(source, headers={"Accept": "application/json"})) as response:
metadata = json.loads(response.read().decode("utf-8"))
artifact_name = metadata.get("artifactName")
if not artifact_name:
on_fail(f"GraalOS artifact metadata does not contain artifactName: {source}")
return artifact_name
def load_graalos_versions(on_fail=mx.abort):
try:
with open(GRAALOS_VERSIONS_PATH, "r", encoding="utf-8") as fp:
versions = json.load(fp)
except FileNotFoundError:
on_fail(f"GraalOS versions file not found: {GRAALOS_VERSIONS_PATH}")
except json.JSONDecodeError as exc:
on_fail(f"Could not parse GraalOS versions file {GRAALOS_VERSIONS_PATH}: {exc}")
for key in ("toolchain", "runtime"):
value = versions.get(key)
if not isinstance(value, str) or not value:
on_fail(f"GraalOS versions file must contain a non-empty string for {key!r}: {GRAALOS_VERSIONS_PATH}")
return versions
def _download_graalos_standalone_artifact(artifact_name, target: Path, on_fail=mx.abort):
if script := os.environ.get("ARTIFACT_DOWNLOAD_SCRIPT"):
run([sys.executable, script, artifact_name, str(target)])
return
artifact_base_url = os.environ.get("GRAALPY_GRAALOS_ARTIFACT_BASE_URL")
if not artifact_base_url:
on_fail("GRAALPY_GRAALOS_ARTIFACT_BASE_URL must be set to download GraalOS artifacts")
source = urllib.parse.urljoin(mx_urlrewrites.rewriteurl(artifact_base_url), artifact_name)
mx.log(f"Downloading {source} to {target}")
with urllib.request.urlopen(source) as response, open(target, "wb") as fp:
shutil.copyfileobj(response, fp)
def _extract_tarball(tarball: Path, destination: Path, strip_components=0, on_fail=mx.abort):
if destination.is_dir():
shutil.rmtree(destination)
destination.mkdir(parents=True, exist_ok=True)
if strip_components == 0:
mx.Extractor.create(str(tarball)).extract(str(destination))
return
if strip_components < 0:
mx.abort(f"strip_components must not be negative: {strip_components}")
with tarfile.open(str(tarball)) as archive:
for member in archive:
original_name = member.name
stripped_name = "/".join(original_name.split("/")[strip_components:])
if not stripped_name:
continue
if not mx.Extractor._is_sane_name(stripped_name): # pylint: disable=protected-access
on_fail(f"Refusing to extract unsafe archive entry after stripping: {original_name}")
member.name = stripped_name
archive.extract(member, str(destination))
member.name = original_name
os.utime(destination, None)
def _find_graalos_runtime_home(runtime_root: Path, on_fail=mx.abort):
default = runtime_root / "opt" / "graalos"
if default.is_dir():
return default
for root, dirs, _ in os.walk(runtime_root):
root_path = Path(root)
if root_path.name == "opt" and "graalos" in dirs:
return root_path / "graalos"
on_fail(f"Could not find opt/graalos in extracted GraalOS runtime artifact: {runtime_root}")
def _ensure_graalos_runtime_inputs(runtime_home: Path, on_fail=mx.abort):
graalhost_dir = runtime_home / "graalhost"
required = [
graalhost_dir / "graalhost",
graalhost_dir / "libc.so",
]
libbinsweep = graalhost_dir / "libbinsweep.so"
if not libbinsweep.exists():
optional_libbinsweep = graalhost_dir / "optional" / "libbinsweep.so.gz"
if optional_libbinsweep.exists():
with gzip.open(optional_libbinsweep, "rb") as src, open(libbinsweep, "wb") as dst:
shutil.copyfileobj(src, dst)
required.append(libbinsweep)
missing = [path for path in required if not path.exists()]
if missing:
on_fail("Extracted GraalOS runtime artifact is missing required files:\n" + "\n".join([str(p) for p in missing]))
def _prepare_graalos_demo(standalone_home: Path, env):
from mx_graalpython import PYTHON_VERSION_MAJ_MIN
demo_wheels = standalone_home / "demo-wheels"
site_packages = standalone_home / "lib" / f"python{PYTHON_VERSION_MAJ_MIN}" / "site-packages"
demo_wheels.mkdir(parents=True, exist_ok=True)
site_packages.mkdir(parents=True, exist_ok=True)
run([
sys.executable, "-m", "pip", "download",
"--only-binary=:all:",
"--implementation", "py",
"--python-version", PYTHON_VERSION_MAJ_MIN,
"--abi", "none",
"--platform", "any",
"--dest", str(demo_wheels),
"rich",
], env=env)
# Work around GRAALOS-8260 by installing pure-Python demo wheels from the
# host. Remove this once in-sandbox ensurepip/pip subprocesses work there.
run([
sys.executable, "-m", "pip", "install",
"--target", str(site_packages),
"--no-index",
"--find-links", str(demo_wheels),
"--ignore-requires-python",
"--no-compile",
"--upgrade",
"rich",
], env=env)
from mx_graalpython import _python_unittest_root
graalos_tests = Path(_python_unittest_root()) / "graalos"
shutil.copy2(graalos_tests / "test_graalos_sandbox_chat.py", standalone_home / "test_graalos_sandbox_chat.py")
shutil.copy2(graalos_tests / "GRAALOS_DEMO.md", standalone_home / "GRAALOS_DEMO.md")
def _stage_graalos_test_harness(standalone_home: Path):
from mx_graalpython import _python_test_runner, _python_unittest_root
graalos_tests = Path(_python_unittest_root()) / "graalos"
harness_dir = standalone_home / "test-harness"
tests_dir = harness_dir / "tests"
tests_dir.mkdir(parents=True, exist_ok=True)
shutil.copy2(
_python_test_runner(),
harness_dir / "runner.py",
)
shutil.copy2(
graalos_tests / "test_graalos_standalone.py",
tests_dir / "test_graalos_standalone.py",
)
shutil.copy2(
graalos_tests / "test_graalos_sandbox_chat.py",
tests_dir / "test_graalos_sandbox_chat.py",
)
def _set_graalos_standalone_env(standalone_home: Path, key, value, on_fail=mx.abort):
config_path = standalone_home / "config.json"
original_config = config_path.read_text(encoding="utf-8")
_ = json.dumps({key: value}) # Validate that both values can be represented in JSON.
if re.search(rf'^\s*"{re.escape(key)}"\s*:', original_config, flags=re.MULTILINE):
return config_path, original_config
env_match = re.search(r'("env"\s*:\s*\{\n)(.*?)(\n\s*\})', original_config, flags=re.DOTALL)
if not env_match:
on_fail(f"Could not find env object in GraalOS standalone config: {config_path}")
env_body = env_match.group(2)
indent_match = re.search(r'^(\s*)"', env_body, flags=re.MULTILINE)
indent = indent_match.group(1) if indent_match else " "
separator = "," if env_body.strip() else ""
entry = f'{separator}\n{indent}{json.dumps(key)}: {json.dumps(value)}'
config = original_config[:env_match.end(2)] + entry + original_config[env_match.end(2):]
config_path.write_text(config, encoding="utf-8")
return config_path, original_config
def _upload_graalos_standalone_artifact(standalone_home: Path, work_dir: Path):
script = os.environ.get("ARTIFACT_UPLOADER_SCRIPT")
if not script:
mx.log("Skipping GRAALPY_NATIVE_GRAALOS_STANDALONE artifact upload: ARTIFACT_UPLOADER_SCRIPT is not set")
return
revision = str(SUITE.vc.tip(SUITE.dir)).strip()
short_revision = revision[:10]
archive_base = work_dir / f"graalpy-native-graalos-standalone-linux-amd64-dev-g{short_revision}"
archive_path = shutil.make_archive(
str(archive_base),
"gztar",
root_dir=str(standalone_home.parent),
base_dir=standalone_home.name,
)
artifact_name = Path(archive_path).name
upload_cmd = [
sys.executable,
script,
archive_path,
f"graalpy/{artifact_name}",
"graalpy",
"--artifact-type", "graalpy-native-graalos-standalone",
"--version", f"dev-g{short_revision}",
"--revision", revision,
"--edition", "ee",
"--lifecycle", "snapshot",
"--platform", "linux-amd64",
]
if repo_key := os.environ.get("ARTIFACT_REPO_KEY_LOCATION"):
upload_cmd += ["--artifact-repo-key", repo_key]
run(upload_cmd)
def _prepare_graalos_toolchain(work_dir: Path, artifact_name, on_fail=mx.abort):
work_dir.mkdir(parents=True, exist_ok=True)
tarball = work_dir / "graalvm.tar.gz"
graalvm_home = work_dir / "graalvm"
_download_graalos_standalone_artifact(artifact_name, tarball, on_fail=on_fail)
_extract_tarball(tarball, graalvm_home, strip_components=1, on_fail=on_fail)
musl_toolchain = graalvm_home / "lib" / "toolchains" / "musl-swcfi"
if not (graalvm_home / "bin" / mx.exe_suffix("java")).is_file():
on_fail(f"Extracted GraalOS toolchain artifact does not contain bin/java: {graalvm_home}")
if not musl_toolchain.is_dir():
on_fail(f"Extracted GraalOS toolchain artifact does not contain musl-swcfi toolchain: {musl_toolchain}")
return graalvm_home, musl_toolchain
@mx.command('graalpython', 'python-graalos-resources', '<archive-path>')
def graalpy_graalos_resources(args):
"""Build a strict, resource-only Maven input in a separate single-target mx invocation."""
if len(args) != 1:
mx.abort('Usage: mx python-graalos-resources <archive-path>')
if (mx.get_os(), mx.get_arch()) != ('linux', 'amd64'):
mx.abort('GraalOS resources must be built on linux-amd64')
from mx_graalpython import extend_os_env, run_mx
versions = load_graalos_versions()
work_dir = Path(SUITE.dir) / 'mxbuild' / 'graalos-resources-ci'
graalvm_home, musl_toolchain = _prepare_graalos_toolchain(work_dir, versions['toolchain'])
env = extend_os_env(
BOOTSTRAP_GRAALVM=str(graalvm_home),
MUSL_TOOLCHAIN=str(musl_toolchain),
GRAALOS_TOOLCHAIN_PATH=str(musl_toolchain),
)
# Isolation is intentional: substitutions/toolchain registration depend on startup options.
run_mx(['-p', SUITE.dir, '--java-home=lookup:default', '--multitarget=linux-amd64-musl-swcfi',
'python-graalos-resources-build', str(Path(args[0]).resolve())], env=env)
@mx.command('graalpython', 'python-resource-variant-tests', '[--default-only]')
def graalpy_resource_variant_tests(args):
"""Check extraction and ABI metadata in fresh, launcher-less JVMs using the resource JAR."""
if args not in ([], ['--default-only']):
mx.abort('Usage: mx python-resource-variant-tests [--default-only]')
vm_args = mx.get_runtime_jvm_args(['GRAALPYTHON_RESOURCES', 'GRAALPYTHON_INTEGRATION_UNIT_TESTS'], force_cp=True)
main = 'com.oracle.graal.python.test.integration.advanced.ResourceVariantProbe'
env = dict(os.environ)
env.pop('GRAAL_PYTHONHOME', None)
cases = [
('default', None, None),
('default', '', None),
('default', 'default', None),
('default', 'invalid', 'Unsupported org.graalvm.python.resources.variant'),
('musl-swcfi', 'musl-swcfi', 'musl-swcfi' if args else None),
]
for expected, prop, error in cases:
with tempfile.TemporaryDirectory(prefix='graalpy-resource-variant-') as directory:
output = mx.OutputCapture()
options = ['-ea', '-esa', '-Dtruffle.DetailedAssertions=true',
'-Dpolyglot.engine.WarnInterpreterOnly=false', '-Dpolyglot.engine.userResourceCache=' + directory]
if prop is not None:
options.append('-Dorg.graalvm.python.resources.variant=' + prop)
result = mx.run_java(vm_args + options + [main, expected, str(Path(directory) / 'copied')],
env=env, out=output, err=output, nonZeroIsFatal=False)
if (error is None and result != 0) or (error is not None and (result == 0 or error not in output.data)):
mx.abort(f'Resource variant probe failed ({expected=}, {prop=}):\n{output.data}')
mx.log(f'Resource variant probe passed: {expected=}, {prop=}')
@mx.command('graalpython', 'python-graalos-resources-build', '<archive-path>')
def graalpy_graalos_resources_build(args):
"""Build/export with an already configured GraalOS bootstrap toolchain."""
from mx_graalpython import PYTHON_NATIVE_PROJECTS, graalpy_resource_platform
if len(args) != 1 or graalpy_resource_platform() != 'linux/amd64/musl-swcfi':
mx.abort('Expected one archive path and --multitarget=linux-amd64-musl-swcfi')
target = 'linux-amd64-musl-swcfi'
# mx can silently fall back to default toolchains. Never publish such a build as GraalOS.
for name in PYTHON_NATIVE_PROJECTS + ['graalpy-versions', 'graalpy-pyconfig']:
toolchains = mx.project(name).toolchains
if len(toolchains) != 1 or toolchains[0].spec.target.name != target:
mx.abort(f'{name} did not select exactly the {target} toolchain')
distributions = 'GRAALPYTHON_NATIVE_RESOURCES,GRAALPYTHON_VERSIONS_RES'
mx.command_function('build')(['--targets=' + distributions])
mx.command_function('archive-pd-layouts')(['--platform-id=' + target, '--only=' + distributions, args[0]])
def graalpy_graalos_standalone_build_and_test(report=None, on_fail=mx.abort):
artifact_base_url = os.environ.get("GRAALPY_GRAALOS_ARTIFACT_BASE_URL")
if not artifact_base_url:
mx.log("Skipping GRAALPY_NATIVE_GRAALOS_STANDALONE build: GRAALPY_GRAALOS_ARTIFACT_BASE_URL is not configured")
return
versions = load_graalos_versions(on_fail=on_fail)
work_dir = Path(SUITE.dir) / "mxbuild" / "graalos-standalone-ci"
if work_dir.is_dir():
shutil.rmtree(work_dir)
work_dir.mkdir(parents=True, exist_ok=True)
runtime_tarball = work_dir / "graalos-runtime.tar.gz"
runtime_root = work_dir / "runtime"
graalvm_home, musl_toolchain = _prepare_graalos_toolchain(work_dir, versions["toolchain"], on_fail=on_fail)
_download_graalos_standalone_artifact(versions["runtime"], runtime_tarball, on_fail=on_fail)
_extract_tarball(runtime_tarball, runtime_root, on_fail=on_fail)
graalos_runtime_home = _find_graalos_runtime_home(runtime_root, on_fail=on_fail)
assert graalos_runtime_home
_ensure_graalos_runtime_inputs(graalos_runtime_home, on_fail=on_fail)
from mx_graalpython import extend_os_env, run_mx, run_python_unittests, _graalpy_launcher
env = extend_os_env(
JAVA_HOME=str(graalvm_home),
BOOTSTRAP_GRAALVM=str(graalvm_home),
MUSL_TOOLCHAIN=str(musl_toolchain),
GRAALOS_TOOLCHAIN_PATH=str(musl_toolchain),
GRAALOS_RUNTIME_HOME=str(graalos_runtime_home),
NATIVE_IMAGE_EXPERIMENTAL_OPTIONS_ARE_FATAL="false",
)
result = run_mx([
"--multitarget=linux-amd64-musl-swcfi",
"build",
"--target", "GRAALPY_NATIVE_GRAALOS_STANDALONE",
], env=env, nonZeroIsFatal=(on_fail == mx.abort)) # pylint: disable=comparison-with-callable
if result != 0:
on_fail("Building GRAALPY_NATIVE_GRAALOS_STANDALONE failed")
standalone_home = Path(SUITE.dir) / "mxbuild" / "linux-amd64" / "GRAALPY_NATIVE_GRAALOS_STANDALONE"
launcher = standalone_home / "bin" / _graalpy_launcher()
if not launcher.exists():
on_fail(f"GRAALPY_NATIVE_GRAALOS_STANDALONE launcher was not built: {launcher}")
_prepare_graalos_demo(standalone_home, env)
_stage_graalos_test_harness(standalone_home)
config_path, original_config = _set_graalos_standalone_env(
standalone_home,
"GRAALPYTEST_ALLOW_NO_JAVA_ASSERTIONS",
"true",
on_fail=on_fail,
)
reportfile = None
runner_reportfile = None
if report:
report_dir = standalone_home / "tmp"
report_dir.mkdir(parents=True, exist_ok=True)
with tempfile.NamedTemporaryFile(
prefix="test-report-", suffix=".json", dir=report_dir, delete=False
) as report_tmp:
reportfile = report_tmp.name
runner_reportfile = f"/tmp/{os.path.basename(reportfile)}"
try:
run_python_unittests(
str(launcher),
paths=[
"/test-harness/tests/test_graalos_standalone.py",
"/test-harness/tests/test_graalos_sandbox_chat.py",
],
env=env,
report=report,
parallel=0,
test_runner="/test-harness/runner.py",
reportfile=reportfile,
runner_reportfile=runner_reportfile,
)
finally:
config_path.write_text(original_config, encoding="utf-8")
_upload_graalos_standalone_artifact(standalone_home, work_dir)