-
Notifications
You must be signed in to change notification settings - Fork 637
/
sdk.bzl
557 lines (500 loc) · 18.9 KB
/
sdk.bzl
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
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# Copyright 2014 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
load(
"//go/private:common.bzl",
"executable_path",
)
load(
"//go/private:nogo.bzl",
"go_register_nogo",
)
load(
"//go/private:platforms.bzl",
"generate_toolchain_names",
)
MIN_SUPPORTED_VERSION = (1, 14, 0)
def _go_host_sdk_impl(ctx):
goroot = _detect_host_sdk(ctx)
platform = _detect_sdk_platform(ctx, goroot)
version = _detect_sdk_version(ctx, goroot)
_sdk_build_file(ctx, platform, version)
_local_sdk(ctx, goroot)
_go_host_sdk = repository_rule(
implementation = _go_host_sdk_impl,
environ = ["GOROOT"],
attrs = {
"version": attr.string(),
},
)
def go_host_sdk(name, register_toolchains = True, **kwargs):
_go_host_sdk(name = name, **kwargs)
_go_toolchains(
name = name + "_toolchains",
sdk_repo = name,
sdk_type = "host",
sdk_version = kwargs.get("version"),
goos = kwargs.get("goos"),
goarch = kwargs.get("goarch"),
)
if register_toolchains:
_register_toolchains(name)
def _go_download_sdk_impl(ctx):
if not ctx.attr.goos and not ctx.attr.goarch:
goos, goarch = _detect_host_platform(ctx)
else:
if not ctx.attr.goos:
fail("goarch set but goos not set")
if not ctx.attr.goarch:
fail("goos set but goarch not set")
goos, goarch = ctx.attr.goos, ctx.attr.goarch
platform = goos + "_" + goarch
version = ctx.attr.version
sdks = ctx.attr.sdks
if not sdks:
# If sdks was unspecified, download a full list of files.
# If version was unspecified, pick the latest version.
# Even if version was specified, we need to download the file list
# to find the SHA-256 sum. If we don't have it, Bazel won't cache
# the downloaded archive.
if not version:
ctx.report_progress("Finding latest Go version")
else:
ctx.report_progress("Finding Go SHA-256 sums")
ctx.download(
url = [
"https://go.dev/dl/?mode=json&include=all",
"https://golang.google.cn/dl/?mode=json&include=all",
],
output = "versions.json",
)
data = ctx.read("versions.json")
sdks_by_version = _parse_versions_json(data)
if not version:
highest_version = None
for v in sdks_by_version.keys():
pv = _parse_version(v)
if not pv or _version_is_prerelease(pv):
# skip parse errors and pre-release versions
continue
if not highest_version or _version_less(highest_version, pv):
highest_version = pv
if not highest_version:
fail("did not find any Go versions in https://go.dev/dl/?mode=json")
version = _version_string(highest_version)
if version not in sdks_by_version:
fail("did not find version {} in https://go.dev/dl/?mode=json".format(version))
sdks = sdks_by_version[version]
if platform not in sdks:
fail("unsupported platform {}".format(platform))
filename, sha256 = sdks[platform]
_remote_sdk(ctx, [url.format(filename) for url in ctx.attr.urls], ctx.attr.strip_prefix, sha256)
detected_version = _detect_sdk_version(ctx, ".")
_sdk_build_file(ctx, platform, detected_version)
if not ctx.attr.sdks and not ctx.attr.version:
# Returning this makes Bazel print a message that 'version' must be
# specified for a reproducible build.
return {
"name": ctx.attr.name,
"goos": ctx.attr.goos,
"goarch": ctx.attr.goarch,
"sdks": ctx.attr.sdks,
"urls": ctx.attr.urls,
"version": version,
"strip_prefix": ctx.attr.strip_prefix,
}
return None
_go_download_sdk = repository_rule(
implementation = _go_download_sdk_impl,
attrs = {
"goos": attr.string(),
"goarch": attr.string(),
"sdks": attr.string_list_dict(),
"urls": attr.string_list(default = ["https://dl.google.com/go/{}"]),
"version": attr.string(),
"strip_prefix": attr.string(default = "go"),
},
)
def _define_version_constants(version):
pv = _parse_version(version)
if pv == None or len(pv) < 3:
fail("error parsing sdk version: " + version)
major, minor, patch = pv[0], pv[1], pv[2]
prerelease = pv[3] if len(pv) > 3 else ""
return """
MAJOR_VERSION = "{major}"
MINOR_VERSION = "{minor}"
PATCH_VERSION = "{patch}"
PRERELEASE_SUFFIX = "{prerelease}"
""".format(
major = major,
minor = minor,
patch = patch,
prerelease = prerelease,
)
def _go_toolchains_impl(ctx):
if not ctx.attr.goos and not ctx.attr.goarch:
goos, goarch = _detect_host_platform(ctx)
else:
if not ctx.attr.goos:
fail("goarch set but goos not set")
if not ctx.attr.goarch:
fail("goos set but goarch not set")
goos, goarch = ctx.attr.goos, ctx.attr.goarch
sdk_repo = ctx.attr.sdk_repo
sdk_type = ctx.attr.sdk_type
# If a sdk_version attribute is provided, use that version. This avoids
# eagerly fetching the SDK repository. But if it's not provided, we have
# no choice and must load version constants from the version.bzl file that
# _sdk_build_file creates. This will trigger an eager fetch.
version = ctx.attr.sdk_version
if version:
version_constants = _define_version_constants(version)
else:
version_constants = 'load("@{}//:version.bzl", "MAJOR_VERSION", "MINOR_VERSION", "PATCH_VERSION", "PRERELEASE_SUFFIX")'.format(sdk_repo)
ctx.template(
"BUILD.bazel",
Label("//go/private:BUILD.toolchains.bazel"),
executable = False,
substitutions = {
"{goos}": goos,
"{goarch}": goarch,
"{sdk_repo}": sdk_repo,
"{sdk_type}": sdk_type,
"{rules_go_repo_name}": "io_bazel_rules_go",
"{version_constants}": version_constants,
},
)
_go_toolchains = repository_rule(
implementation = _go_toolchains_impl,
attrs = {
"sdk_repo": attr.string(mandatory = True),
"sdk_type": attr.string(mandatory = True),
"sdk_version": attr.string(),
"goos": attr.string(),
"goarch": attr.string(),
},
)
def go_download_sdk(name, register_toolchains = True, **kwargs):
_go_download_sdk(name = name, **kwargs)
_go_toolchains(
name = name + "_toolchains",
sdk_repo = name,
sdk_type = "remote",
sdk_version = kwargs.get("version"),
goos = kwargs.get("goos"),
goarch = kwargs.get("goarch"),
)
if register_toolchains:
_register_toolchains(name)
def _go_local_sdk_impl(ctx):
goroot = ctx.attr.path
platform = _detect_sdk_platform(ctx, goroot)
version = _detect_sdk_version(ctx, goroot)
_sdk_build_file(ctx, platform, version)
_local_sdk(ctx, goroot)
_go_local_sdk = repository_rule(
implementation = _go_local_sdk_impl,
attrs = {
"path": attr.string(),
"version": attr.string(),
},
)
def go_local_sdk(name, register_toolchains = True, **kwargs):
_go_local_sdk(name = name, **kwargs)
_go_toolchains(
name = name + "_toolchains",
sdk_repo = name,
sdk_type = "remote",
sdk_version = kwargs.get("version"),
goos = kwargs.get("goos"),
goarch = kwargs.get("goarch"),
)
if register_toolchains:
_register_toolchains(name)
def _go_wrap_sdk_impl(ctx):
if not ctx.attr.root_file and not ctx.attr.root_files:
fail("either root_file or root_files must be provided")
if ctx.attr.root_file and ctx.attr.root_files:
fail("root_file and root_files cannot be both provided")
if ctx.attr.root_file:
root_file = ctx.attr.root_file
else:
goos, goarch = _detect_host_platform(ctx)
platform = goos + "_" + goarch
if platform not in ctx.attr.root_files:
fail("unsupported platform {}".format(platform))
root_file = Label(ctx.attr.root_files[platform])
goroot = str(ctx.path(root_file).dirname)
platform = _detect_sdk_platform(ctx, goroot)
version = _detect_sdk_version(ctx, goroot)
_sdk_build_file(ctx, platform, version)
_local_sdk(ctx, goroot)
_go_wrap_sdk = repository_rule(
implementation = _go_wrap_sdk_impl,
attrs = {
"root_file": attr.label(
mandatory = False,
doc = "A file in the SDK root direcotry. Used to determine GOROOT.",
),
"root_files": attr.string_dict(
mandatory = False,
doc = "A set of mappings from the host platform to a file in the SDK's root directory",
),
"version": attr.string(),
},
)
def go_wrap_sdk(name, register_toolchains = True, **kwargs):
_go_wrap_sdk(name = name, **kwargs)
_go_toolchains(
name = name + "_toolchains",
sdk_repo = name,
sdk_type = "remote",
sdk_version = kwargs.get("version"),
goos = kwargs.get("goos"),
goarch = kwargs.get("goarch"),
)
if register_toolchains:
_register_toolchains(name)
def _register_toolchains(repo):
labels = [
"@{}_toolchains//:{}".format(repo, name)
for name in generate_toolchain_names()
]
native.register_toolchains(*labels)
def _remote_sdk(ctx, urls, strip_prefix, sha256):
if len(urls) == 0:
fail("no urls specified")
ctx.report_progress("Downloading and extracting Go toolchain")
if urls[0].endswith(".tar.gz"):
# BUG(#2771): Use a system tool to extract the archive instead of
# Bazel's implementation. With some configurations (macOS + Docker +
# some particular file system binding), Bazel's implementation rejects
# files with invalid unicode names. Go has at least one test case with a
# file like this, but we haven't been able to reproduce the failure, so
# instead, we use this workaround.
if strip_prefix != "go":
fail("strip_prefix not supported")
ctx.download(
url = urls,
sha256 = sha256,
output = "go_sdk.tar.gz",
)
res = ctx.execute(["tar", "-xf", "go_sdk.tar.gz", "--strip-components=1"])
if res.return_code:
fail("error extracting Go SDK:\n" + res.stdout + res.stderr)
ctx.delete("go_sdk.tar.gz")
else:
ctx.download_and_extract(
url = urls,
stripPrefix = strip_prefix,
sha256 = sha256,
)
def _local_sdk(ctx, path):
for entry in ["src", "pkg", "bin", "lib", "misc"]:
ctx.symlink(path + "/" + entry, entry)
def _sdk_build_file(ctx, platform, version):
ctx.file("ROOT")
goos, _, goarch = platform.partition("_")
ctx.template(
"BUILD.bazel",
Label("//go/private:BUILD.sdk.bazel"),
executable = False,
substitutions = {
"{goos}": goos,
"{goarch}": goarch,
"{exe}": ".exe" if goos == "windows" else "",
"{rules_go_repo_name}": "io_bazel_rules_go",
},
)
ctx.file(
"version.bzl",
executable = False,
content = _define_version_constants(version),
)
def _detect_host_platform(ctx):
goos = ctx.os.name
if goos == "mac os x":
goos = "darwin"
elif goos.startswith("windows"):
goos = "windows"
goarch = ctx.os.arch
if goarch == "aarch64":
goarch = "arm64"
elif goarch == "x86_64":
goarch = "amd64"
return goos, goarch
def _detect_host_sdk(ctx):
root = "@invalid@"
if "GOROOT" in ctx.os.environ:
return ctx.os.environ["GOROOT"]
res = ctx.execute([executable_path(ctx, "go"), "env", "GOROOT"])
if res.return_code:
fail("Could not detect host go version")
root = res.stdout.strip()
if not root:
fail("host go version failed to report it's GOROOT")
return root
def _detect_sdk_platform(ctx, goroot):
path = goroot + "/pkg/tool"
res = ctx.execute(["ls", path])
if res.return_code != 0:
fail("Could not detect SDK platform: unable to list %s: %s" % (path, res.stderr))
platforms = []
for f in res.stdout.strip().split("\n"):
if f.find("_") >= 0:
platforms.append(f)
if len(platforms) == 0:
fail("Could not detect SDK platform: found no platforms in %s" % path)
if len(platforms) > 1:
fail("Could not detect SDK platform: found multiple platforms %s in %s" % (platforms, path))
return platforms[0]
def _detect_sdk_version(ctx, goroot):
version_file_path = goroot + "/VERSION"
if ctx.path(version_file_path).exists:
# VERSION file has version prefixed by go, eg. go1.18.3
version = ctx.read(version_file_path)[2:]
if ctx.attr.version and ctx.attr.version != version:
fail("SDK is version %s, but version %s was expected" % (version, ctx.attr.version))
return version
# The top-level VERSION file does not exist in all Go SDK distributions, e.g. those shipped by Debian or Fedora.
# Falling back to running "go version"
go_binary_path = goroot + "/bin/go"
result = ctx.execute([go_binary_path, "version"])
if result.return_code != 0:
fail("Could not detect SDK version: '%s version' exited with exit code %d" % (go_binary_path, result.return_code))
# go version output is of the form "go version go1.18.3 linux/amd64" or "go
# version devel go1.19-fd1b5904ae Tue Mar 22 21:38:10 2022 +0000
# linux/amd64". See the following links for how this output is generated:
# - https://github.com/golang/go/blob/2bdb5c57f1efcbddab536028d053798e35de6226/src/cmd/go/internal/version/version.go#L75
# - https://github.com/golang/go/blob/2bdb5c57f1efcbddab536028d053798e35de6226/src/cmd/dist/build.go#L333
#
# Read the third word, or the fourth word if the third word is "devel", to
# find the version number.
output_parts = result.stdout.split(" ")
if len(output_parts) > 2 and output_parts[2].startswith("go"):
version = output_parts[2][len("go"):]
if len(output_parts) > 3 and output_parts[2] == "devel" and output_parts[3].startswith("go"):
version = output_parts[3][len("go"):]
else:
fail("Could not parse SDK version from '%s version' output: %s" % (go_binary_path, result.stdout))
if _parse_version(version) == None:
fail("Could not parse SDK version from '%s version' output: %s" % (go_binary_path, result.stdout))
if ctx.attr.version and ctx.attr.version != version:
fail("SDK is version %s, but version %s was expected" % (version, ctx.attr.version))
return version
def _parse_versions_json(data):
"""Parses version metadata returned by go.dev.
Args:
data: the contents of the file downloaded from
https://go.dev/dl/?mode=json. We assume the file is valid
JSON, is spaced and indented, and is in a particular format.
Return:
A dict mapping version strings (like "1.15.5") to dicts mapping
platform names (like "linux_amd64") to pairs of filenames
(like "go1.15.5.linux-amd64.tar.gz") and hex-encoded SHA-256 sums.
"""
sdks = json.decode(data)
return {
sdk["version"][len("go"):]: {
"%s_%s" % (file["os"], file["arch"]): (
file["filename"],
file["sha256"],
)
for file in sdk["files"]
if file["kind"] == "archive"
}
for sdk in sdks
}
def _parse_version(version):
"""Parses a version string like "1.15.5" and returns a tuple of numbers or None"""
l, r = 0, 0
parsed = []
for c in version.elems():
if c == ".":
if l == r:
# empty component
return None
parsed.append(int(version[l:r]))
r += 1
l = r
continue
if c.isdigit():
r += 1
continue
# pre-release suffix
break
if l == r:
# empty component
return None
parsed.append(int(version[l:r]))
if len(parsed) == 2:
# first minor version, like (1, 15)
parsed.append(0)
if len(parsed) != 3:
# too many or too few components
return None
if r < len(version):
# pre-release suffix
parsed.append(version[r:])
return tuple(parsed)
def _version_is_prerelease(v):
return len(v) > 3
def _version_less(a, b):
if a[:3] < b[:3]:
return True
if a[:3] > b[:3]:
return False
if len(a) > len(b):
return True
if len(a) < len(b) or len(a) == 3:
return False
return a[3:] < b[3:]
def _version_string(v):
suffix = v[3] if _version_is_prerelease(v) else ""
if v[-1] == 0:
v = v[:-1]
return ".".join([str(n) for n in v]) + suffix
def go_register_toolchains(version = None, nogo = None, go_version = None):
"""See /go/toolchains.rst#go-register-toolchains for full documentation."""
if not version:
version = go_version # old name
sdk_kinds = ("_go_download_sdk", "_go_host_sdk", "_go_local_sdk", "_go_wrap_sdk")
existing_rules = native.existing_rules()
sdk_rules = [r for r in existing_rules.values() if r["kind"] in sdk_kinds]
if len(sdk_rules) == 0 and "go_sdk" in existing_rules:
# may be local_repository in bazel_tests.
sdk_rules.append(existing_rules["go_sdk"])
if version and len(sdk_rules) > 0:
fail("go_register_toolchains: version set after go sdk rule declared ({})".format(", ".join([r["name"] for r in sdk_rules])))
if len(sdk_rules) == 0:
if not version:
fail('go_register_toolchains: version must be a string like "1.15.5" or "host"')
elif version == "host":
go_host_sdk(name = "go_sdk")
else:
pv = _parse_version(version)
if not pv:
fail('go_register_toolchains: version must be a string like "1.15.5" or "host"')
if _version_less(pv, MIN_SUPPORTED_VERSION):
print("DEPRECATED: Go versions before {} are not supported and may not work".format(_version_string(MIN_SUPPORTED_VERSION)))
go_download_sdk(
name = "go_sdk",
version = version,
)
if nogo:
# Override default definition in go_rules_dependencies().
go_register_nogo(
name = "io_bazel_rules_nogo",
nogo = nogo,
)