-
Notifications
You must be signed in to change notification settings - Fork 412
/
toolchain.bzl
479 lines (436 loc) · 18.5 KB
/
toolchain.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
"""The rust_toolchain rule definition and implementation."""
load("@bazel_skylib//rules:common_settings.bzl", "BuildSettingInfo")
load("//rust/private:common.bzl", "rust_common")
load("//rust/private:utils.bzl", "dedent", "find_cc_toolchain", "make_static_lib_symlink")
def _rust_stdlib_filegroup_impl(ctx):
rust_std = ctx.files.srcs
dot_a_files = []
between_alloc_and_core_files = []
core_files = []
between_core_and_std_files = []
std_files = []
alloc_files = []
self_contained_files = [
file
for file in rust_std
if file.basename.endswith(".o") and "self-contained" in file.path
]
std_rlibs = [f for f in rust_std if f.basename.endswith(".rlib")]
if std_rlibs:
# std depends on everything
#
# core only depends on alloc, but we poke adler in there
# because that needs to be before miniz_oxide
#
# alloc depends on the allocator_library if it's configured, but we
# do that later.
dot_a_files = [make_static_lib_symlink(ctx.actions, f) for f in std_rlibs]
alloc_files = [f for f in dot_a_files if "alloc" in f.basename and "std" not in f.basename]
between_alloc_and_core_files = [f for f in dot_a_files if "compiler_builtins" in f.basename]
core_files = [f for f in dot_a_files if ("core" in f.basename or "adler" in f.basename) and "std" not in f.basename]
between_core_and_std_files = [
f
for f in dot_a_files
if "alloc" not in f.basename and "compiler_builtins" not in f.basename and "core" not in f.basename and "adler" not in f.basename and "std" not in f.basename
]
std_files = [f for f in dot_a_files if "std" in f.basename]
partitioned_files_len = len(alloc_files) + len(between_alloc_and_core_files) + len(core_files) + len(between_core_and_std_files) + len(std_files)
if partitioned_files_len != len(dot_a_files):
partitioned = alloc_files + between_alloc_and_core_files + core_files + between_core_and_std_files + std_files
for f in sorted(partitioned):
# buildifier: disable=print
print("File partitioned: {}".format(f.basename))
fail("rust_toolchain couldn't properly partition rlibs in rust_std. Partitioned {} out of {} files. This is probably a bug in the rule implementation.".format(partitioned_files_len, len(dot_a_files)))
return [
DefaultInfo(
files = depset(ctx.files.srcs),
),
rust_common.stdlib_info(
std_rlibs = std_rlibs,
dot_a_files = dot_a_files,
between_alloc_and_core_files = between_alloc_and_core_files,
core_files = core_files,
between_core_and_std_files = between_core_and_std_files,
std_files = std_files,
alloc_files = alloc_files,
self_contained_files = self_contained_files,
srcs = ctx.attr.srcs,
),
]
rust_stdlib_filegroup = rule(
doc = "A dedicated filegroup-like rule for Rust stdlib artifacts.",
implementation = _rust_stdlib_filegroup_impl,
attrs = {
"srcs": attr.label_list(
allow_files = True,
doc = "The list of targets/files that are components of the rust-stdlib file group",
mandatory = True,
),
},
)
def _ltl(library, ctx, cc_toolchain, feature_configuration):
"""A helper to generate `LibraryToLink` objects
Args:
library (File): A rust library file to link.
ctx (ctx): The rule's context object.
cc_toolchain (CcToolchainInfo): A cc toolchain provider to be used.
feature_configuration (feature_configuration): feature_configuration to be queried.
Returns:
LibraryToLink: A provider containing information about libraries to link.
"""
return cc_common.create_library_to_link(
actions = ctx.actions,
feature_configuration = feature_configuration,
cc_toolchain = cc_toolchain,
static_library = library,
pic_static_library = library,
)
def _make_libstd_and_allocator_ccinfo(ctx, rust_std, allocator_library):
"""Make the CcInfo (if possible) for libstd and allocator libraries.
Args:
ctx (ctx): The rule's context object.
rust_std: The Rust standard library.
allocator_library: The target to use for providing allocator functions.
Returns:
A CcInfo object for the required libraries, or None if no such libraries are available.
"""
cc_toolchain, feature_configuration = find_cc_toolchain(ctx)
cc_infos = []
if not rust_common.stdlib_info in rust_std:
fail(dedent("""\
{} --
The `rust_lib` ({}) must be a target providing `rust_common.stdlib_info`
(typically `rust_stdlib_filegroup` rule from @rules_rust//rust:defs.bzl).
See https://github.com/bazelbuild/rules_rust/pull/802 for more information.
""").format(ctx.label, rust_std))
rust_stdlib_info = rust_std[rust_common.stdlib_info]
if rust_stdlib_info.self_contained_files:
compilation_outputs = cc_common.create_compilation_outputs(
objects = depset(rust_stdlib_info.self_contained_files),
)
linking_context, _linking_outputs = cc_common.create_linking_context_from_compilation_outputs(
name = ctx.label.name,
actions = ctx.actions,
feature_configuration = feature_configuration,
cc_toolchain = cc_toolchain,
compilation_outputs = compilation_outputs,
)
cc_infos.append(CcInfo(
linking_context = linking_context,
))
if rust_stdlib_info.std_rlibs:
alloc_inputs = depset(
[_ltl(f, ctx, cc_toolchain, feature_configuration) for f in rust_stdlib_info.alloc_files],
)
between_alloc_and_core_inputs = depset(
[_ltl(f, ctx, cc_toolchain, feature_configuration) for f in rust_stdlib_info.between_alloc_and_core_files],
transitive = [alloc_inputs],
order = "topological",
)
core_inputs = depset(
[_ltl(f, ctx, cc_toolchain, feature_configuration) for f in rust_stdlib_info.core_files],
transitive = [between_alloc_and_core_inputs],
order = "topological",
)
# The libraries panic_abort and panic_unwind are alternatives.
# The std by default requires panic_unwind.
# Exclude panic_abort if panic_unwind is present.
# TODO: Provide a setting to choose between panic_abort and panic_unwind.
filtered_between_core_and_std_files = rust_stdlib_info.between_core_and_std_files
has_panic_unwind = [
f
for f in filtered_between_core_and_std_files
if "panic_unwind" in f.basename
]
if has_panic_unwind:
filtered_between_core_and_std_files = [
f
for f in filtered_between_core_and_std_files
if "panic_abort" not in f.basename
]
between_core_and_std_inputs = depset(
[
_ltl(f, ctx, cc_toolchain, feature_configuration)
for f in filtered_between_core_and_std_files
],
transitive = [core_inputs],
order = "topological",
)
std_inputs = depset(
[
_ltl(f, ctx, cc_toolchain, feature_configuration)
for f in rust_stdlib_info.std_files
],
transitive = [between_core_and_std_inputs],
order = "topological",
)
link_inputs = cc_common.create_linker_input(
owner = rust_std.label,
libraries = std_inputs,
)
allocator_inputs = None
if allocator_library:
allocator_inputs = [allocator_library[CcInfo].linking_context.linker_inputs]
cc_infos.append(CcInfo(
linking_context = cc_common.create_linking_context(
linker_inputs = depset(
[link_inputs],
transitive = allocator_inputs,
order = "topological",
),
),
))
if cc_infos:
return cc_common.merge_cc_infos(
direct_cc_infos = cc_infos,
)
return None
def _rust_toolchain_impl(ctx):
"""The rust_toolchain implementation
Args:
ctx (ctx): The rule's context object
Returns:
list: A list containing the target's toolchain Provider info
"""
compilation_mode_opts = {}
for k, v in ctx.attr.opt_level.items():
if not k in ctx.attr.debug_info:
fail("Compilation mode {} is not defined in debug_info but is defined opt_level".format(k))
compilation_mode_opts[k] = struct(debug_info = ctx.attr.debug_info[k], opt_level = v)
for k, v in ctx.attr.debug_info.items():
if not k in ctx.attr.opt_level:
fail("Compilation mode {} is not defined in opt_level but is defined debug_info".format(k))
if ctx.attr.target_triple and ctx.file.target_json:
fail("Do not specify both target_triple and target_json, either use a builtin triple or provide a custom specification file.")
rename_first_party_crates = ctx.attr._rename_first_party_crates[BuildSettingInfo].value
third_party_dir = ctx.attr._third_party_dir[BuildSettingInfo].value
if ctx.attr.rust_lib:
# buildifier: disable=print
print("`rust_toolchain.rust_lib` is deprecated. Please update {} to use `rust_toolchain.rust_std`".format(
ctx.label,
))
rust_std = ctx.attr.rust_lib
else:
rust_std = ctx.attr.rust_std
expanded_stdlib_linkflags = []
for flag in ctx.attr.stdlib_linkflags:
expanded_stdlib_linkflags.append(
ctx.expand_location(
flag,
targets = rust_std[rust_common.stdlib_info].srcs,
),
)
linking_context = cc_common.create_linking_context(
linker_inputs = depset([
cc_common.create_linker_input(
owner = ctx.label,
user_link_flags = depset(expanded_stdlib_linkflags),
),
]),
)
stdlib_linkflags_cc_info = CcInfo(
compilation_context = cc_common.create_compilation_context(),
linking_context = linking_context,
)
# In cases where the toolchain uses the Rust standard library, calculate sysroot path
sysroot_path = None
if rust_std:
# Calculate the rustc sysroot path by using a file from the rust-std bundle
rust_std_files_list = rust_std.files.to_list()
if not rust_std_files_list:
fail("The `rust_std` cannot be represented by an empty list")
sysroot_path = rust_std_files_list[0].dirname
toolchain = platform_common.ToolchainInfo(
rustc = ctx.file.rustc,
rust_doc = ctx.file.rust_doc,
rustfmt = ctx.file.rustfmt,
cargo = ctx.file.cargo,
clippy_driver = ctx.file.clippy_driver,
target_json = ctx.file.target_json,
target_flag_value = ctx.file.target_json.path if ctx.file.target_json else ctx.attr.target_triple,
rustc_lib = depset(ctx.files.rustc_lib),
rustc_srcs = ctx.attr.rustc_srcs,
rust_std = rust_std.files,
rust_std_paths = depset([file.dirname for file in rust_std_files_list]),
rust_lib = rust_std.files, # `rust_lib` is deprecated and only exists for legacy support.
sysroot = sysroot_path,
binary_ext = ctx.attr.binary_ext,
staticlib_ext = ctx.attr.staticlib_ext,
dylib_ext = ctx.attr.dylib_ext,
# Contains linker flags needed to link Rust standard library.
# These need to be added to linker command lines when the linker is not rustc
# (rustc does this automatically). Linker flags wrapped in an otherwise empty
# `CcInfo` to provide the flags in a way that doesn't duplicate them per target
# providing a `CcInfo`.
stdlib_linkflags = stdlib_linkflags_cc_info,
target_triple = ctx.attr.target_triple,
exec_triple = ctx.attr.exec_triple,
os = ctx.attr.os,
target_arch = ctx.attr.target_triple.split("-")[0],
default_edition = ctx.attr.default_edition,
compilation_mode_opts = compilation_mode_opts,
crosstool_files = ctx.files._cc_toolchain,
libstd_and_allocator_ccinfo = _make_libstd_and_allocator_ccinfo(ctx, rust_std, ctx.attr.allocator_library),
_rename_first_party_crates = rename_first_party_crates,
_third_party_dir = third_party_dir,
)
return [toolchain]
rust_toolchain = rule(
implementation = _rust_toolchain_impl,
fragments = ["cpp"],
attrs = {
"allocator_library": attr.label(
doc = "Target that provides allocator functions when rust_library targets are embedded in a cc_binary.",
),
"binary_ext": attr.string(
doc = "The extension for binaries created from rustc.",
mandatory = True,
),
"cargo": attr.label(
doc = "The location of the `cargo` binary. Can be a direct source or a filegroup containing one item.",
allow_single_file = True,
cfg = "exec",
),
"clippy_driver": attr.label(
doc = "The location of the `clippy-driver` binary. Can be a direct source or a filegroup containing one item.",
allow_single_file = True,
cfg = "exec",
),
"debug_info": attr.string_dict(
doc = "Rustc debug info levels per opt level",
default = {
"dbg": "2",
"fastbuild": "0",
"opt": "0",
},
),
"default_edition": attr.string(
doc = "The edition to use for rust_* rules that don't specify an edition.",
default = rust_common.default_edition,
),
"dylib_ext": attr.string(
doc = "The extension for dynamic libraries created from rustc.",
mandatory = True,
),
"exec_triple": attr.string(
doc = (
"The platform triple for the toolchains execution environment. " +
"For more details see: https://docs.bazel.build/versions/master/skylark/rules.html#configurations"
),
mandatory = True,
),
"opt_level": attr.string_dict(
doc = "Rustc optimization levels.",
default = {
"dbg": "0",
"fastbuild": "0",
"opt": "3",
},
),
"os": attr.string(
doc = "The operating system for the current toolchain",
mandatory = True,
),
"rust_doc": attr.label(
doc = "The location of the `rustdoc` binary. Can be a direct source or a filegroup containing one item.",
allow_single_file = True,
cfg = "exec",
mandatory = True,
),
"rust_lib": attr.label(
doc = "**Deprecated**: Use `rust_std`",
),
"rust_std": attr.label(
doc = "The Rust standard library.",
),
"rustc": attr.label(
doc = "The location of the `rustc` binary. Can be a direct source or a filegroup containing one item.",
allow_single_file = True,
cfg = "exec",
mandatory = True,
),
"rustc_lib": attr.label(
doc = "The libraries used by rustc during compilation.",
cfg = "exec",
),
"rustc_srcs": attr.label(
doc = "The source code of rustc.",
),
"rustfmt": attr.label(
doc = "The location of the `rustfmt` binary. Can be a direct source or a filegroup containing one item.",
allow_single_file = True,
cfg = "exec",
),
"staticlib_ext": attr.string(
doc = "The extension for static libraries created from rustc.",
mandatory = True,
),
"stdlib_linkflags": attr.string_list(
doc = (
"Additional linker flags to use when Rust standard library is linked by a C++ linker " +
"(rustc will deal with these automatically). Subject to location expansion with respect " +
"to the srcs of the `rust_std` attribute."
),
mandatory = True,
),
"target_json": attr.label(
doc = ("Override the target_triple with a custom target specification. " +
"For more details see: https://doc.rust-lang.org/rustc/targets/custom.html"),
allow_single_file = True,
),
"target_triple": attr.string(
doc = (
"The platform triple for the toolchains target environment. " +
"For more details see: https://docs.bazel.build/versions/master/skylark/rules.html#configurations"
),
),
"_cc_toolchain": attr.label(
default = "@bazel_tools//tools/cpp:current_cc_toolchain",
),
"_rename_first_party_crates": attr.label(
default = "@rules_rust//rust/settings:rename_first_party_crates",
),
"_third_party_dir": attr.label(
default = "@rules_rust//rust/settings:third_party_dir",
),
},
toolchains = [
"@bazel_tools//tools/cpp:toolchain_type",
],
incompatible_use_toolchain_transition = True,
doc = """Declares a Rust toolchain for use.
This is for declaring a custom toolchain, eg. for configuring a particular version of rust or supporting a new platform.
Example:
Suppose the core rust team has ported the compiler to a new target CPU, called `cpuX`. This \
support can be used in Bazel by defining a new toolchain definition and declaration:
```python
load('@rules_rust//rust:toolchain.bzl', 'rust_toolchain')
rust_toolchain(
name = "rust_cpuX_impl",
rustc = "@rust_cpuX//:rustc",
rustc_lib = "@rust_cpuX//:rustc_lib",
rust_std = "@rust_cpuX//:rust_std",
rust_doc = "@rust_cpuX//:rustdoc",
binary_ext = "",
staticlib_ext = ".a",
dylib_ext = ".so",
stdlib_linkflags = ["-lpthread", "-ldl"],
os = "linux",
)
toolchain(
name = "rust_cpuX",
exec_compatible_with = [
"@platforms//cpu:cpuX",
],
target_compatible_with = [
"@platforms//cpu:cpuX",
],
toolchain = ":rust_cpuX_impl",
)
```
Then, either add the label of the toolchain rule to `register_toolchains` in the WORKSPACE, or pass \
it to the `"--extra_toolchains"` flag for Bazel, and it will be used.
See @rules_rust//rust:repositories.bzl for examples of defining the @rust_cpuX repository \
with the actual binaries and libraries.
""",
)