-
Notifications
You must be signed in to change notification settings - Fork 13
/
rules.bzl
300 lines (269 loc) · 10.2 KB
/
rules.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
"Rules for building native binaries using the GraalVM `native-image` tool."
load(
"@bazel_skylib//lib:paths.bzl",
"paths",
)
load(
"@bazel_tools//tools/cpp:toolchain_utils.bzl",
"find_cpp_toolchain",
)
load(
"@bazel_tools//tools/build_defs/cc:action_names.bzl",
"CPP_LINK_DYNAMIC_LIBRARY_ACTION_NAME",
"CPP_LINK_EXECUTABLE_ACTION_NAME",
"CPP_LINK_STATIC_LIBRARY_ACTION_NAME",
"C_COMPILE_ACTION_NAME",
)
_RULES_REPO = "@rules_graalvm"
_DEFAULT_GVM_REPO = "@graalvm"
_GVM_TOOLCHAIN_TYPE = "%s//graalvm/toolchain" % _RULES_REPO
_BAZEL_CPP_TOOLCHAIN_TYPE = "@bazel_tools//tools/cpp:toolchain_type"
_BAZEL_CURRENT_CPP_TOOLCHAIN = "@bazel_tools//tools/cpp:current_cc_toolchain"
_WINDOWS_CONSTRAINT = "@platforms//os:windows"
_PASSTHRU_ENV_VARS = [
"INCLUDE",
"LIB",
"MSVC",
"VSINSTALLDIR",
"SDKROOT",
"DEVELOPER_DIR",
"BAZEL_USE_CPP_ONLY_TOOLCHAIN",
"BAZEL_DO_NOT_DETECT_CPP_TOOLCHAIN",
]
_NATIVE_IMAGE_ATTRS = {
"deps": attr.label_list(
providers = [[JavaInfo]],
mandatory = True,
),
"main_class": attr.string(
mandatory = False,
),
"binary_type": attr.string(
mandatory = False,
default = "executable",
),
"include_resources": attr.string(
mandatory = False,
),
"reflection_configuration": attr.label(
mandatory = False,
allow_single_file = True,
),
"jni_configuration": attr.label(
mandatory = False,
allow_single_file = True,
),
"initialize_at_build_time": attr.string_list(
mandatory = False,
),
"initialize_at_run_time": attr.string_list(
mandatory = False,
),
"native_features": attr.string_list(
mandatory = False,
),
"data": attr.label_list(
allow_files = True,
),
"extra_args": attr.string_list(
mandatory = False,
),
"check_toolchains": attr.bool(
default = True,
),
"c_compiler_option": attr.string_list(
mandatory = False,
),
"enable_default_shell_env": attr.bool(
default = False,
),
"pass_compiler_path": attr.bool(
default = True,
),
"default_executable_name": attr.string(
mandatory = True,
),
"_cc_toolchain": attr.label(
default = Label(_BAZEL_CURRENT_CPP_TOOLCHAIN),
),
"_windows_constraint": attr.label(
default = Label(_WINDOWS_CONSTRAINT),
),
}
def _graal_binary_implementation(ctx):
graal_attr = ctx.attr.native_image_tool
extra_tool_deps = []
gvm_toolchain = None
classpath_depset = depset(transitive = [
dep[JavaInfo].transitive_runtime_jars
for dep in ctx.attr.deps
])
all_deps = depset([], transitive = [classpath_depset])
if graal_attr == None:
# resolve via toolchains
info = ctx.toolchains[_GVM_TOOLCHAIN_TYPE].graalvm
graal_attr = info.native_image_bin
gvm_toolchain = info
extra_tool_deps.append(info.gvm_files)
graal_inputs, _ = ctx.resolve_tools(tools = [
graal_attr,
] + extra_tool_deps)
graal = graal_inputs.to_list()[0]
all_deps = depset(transitive = [
classpath_depset,
gvm_toolchain.gvm_files.files,
])
else:
# otherwise, use the legacy code path
graal_inputs, _, _ = ctx.resolve_command(tools = [
graal_attr,
])
graal = graal_inputs[0]
if graal_attr == None:
# still failed to resolve: cannot resolve via either toolchains or attributes.
fail("""
No `native-image` tool found. Please either define a `native_image_tool` in your target,
or install a GraalVM `native-image` toolchain.
""")
cc_toolchain = find_cpp_toolchain(ctx)
feature_configuration = cc_common.configure_features(
ctx = ctx,
cc_toolchain = cc_toolchain,
requested_features = ctx.features,
unsupported_features = ctx.disabled_features,
)
c_compiler_path = cc_common.get_tool_for_action(
feature_configuration = feature_configuration,
action_name = C_COMPILE_ACTION_NAME,
)
ld_executable_path = cc_common.get_tool_for_action(
feature_configuration = feature_configuration,
action_name = CPP_LINK_EXECUTABLE_ACTION_NAME,
)
ld_static_lib_path = cc_common.get_tool_for_action(
feature_configuration = feature_configuration,
action_name = CPP_LINK_STATIC_LIBRARY_ACTION_NAME,
)
ld_dynamic_lib_path = cc_common.get_tool_for_action(
feature_configuration = feature_configuration,
action_name = CPP_LINK_DYNAMIC_LIBRARY_ACTION_NAME,
)
env = {}
path_set = {}
tool_paths = [c_compiler_path, ld_executable_path, ld_static_lib_path, ld_dynamic_lib_path]
for tool_path in tool_paths:
tool_dir, _, _ = tool_path.rpartition("/")
path_set[tool_dir] = None
paths = sorted(path_set.keys())
unix_like = True
if ctx.configuration.host_path_separator == ":":
# HACK: ":" is a proxy for a UNIX-like host.
# The tools returned above may be bash scripts that reference commands
# in directories we might not otherwise include. For example,
# on macOS, wrapped_ar calls dirname.
unix_like = True
if "/bin" not in path_set:
paths.append("/bin")
if "/usr/bin" not in path_set:
paths.append("/usr/bin")
else:
# non-unix hosts implies windows, where we should splice the full path
unix_like = False
# fix: make sure to include VS install dir on windows, and SDKROOT/DEVELOPER_DIR on macos, but only
# when using the non-legacy rules, and only on Bazel greater than 5. otherwise, it appears to overwrite
# the env injected normally by Bazel to make Xcode and VS compilation work.
if (not ctx.attr._legacy_rule):
for var in _PASSTHRU_ENV_VARS:
if var == "DEVELOPER_DIR" and unix_like:
# allow bazel to override the developer directory on mac
env[var] = apple_common.apple_toolchain().developer_dir()
elif var == "SDKROOT" and unix_like:
# allow bazel to override the apple SDK root
env[var] = apple_common.apple_toolchain().sdk_dir()
elif var in ctx.configuration.default_shell_env:
env[var] = ctx.configuration.default_shell_env[var]
# seal paths with hack above
env["PATH"] = ctx.configuration.host_path_separator.join(paths)
out_bin_name = ctx.attr.default_executable_name.replace("%target%", ctx.attr.name)
binary = ctx.actions.declare_file(out_bin_name)
args = ctx.actions.args()
args.add("--no-fallback")
# TODO: This check really should be on the exec platform, not the target platform, but that
# requires going through a separate rule. Since GraalVM doesn't support cross-compilation, the
# distinction doesn't matter for now.
if ctx.target_platform_has_constraint(ctx.attr._windows_constraint[platform_common.ConstraintValueInfo]):
path_list_separator = ";"
else:
path_list_separator = ":"
args.add("-cp", path_list_separator.join([f.path for f in classpath_depset.to_list()]))
if gvm_toolchain != None and ctx.attr.pass_compiler_path:
args.add("--native-compiler-path=%s" % c_compiler_path)
args.add("-H:Class=%s" % ctx.attr.main_class)
args.add("-H:Name=%s" % binary.basename.replace(".exe", ""))
args.add("-H:Path=%s" % binary.dirname)
args.add("-H:+ReportExceptionStackTraces")
if not ctx.attr.check_toolchains:
args.add("-H:-CheckToolchain")
for arg in ctx.attr.extra_args:
args.add(arg)
args.add_joined(
ctx.attr.c_compiler_option,
join_with = " ",
format_joined = "-H:CCompilerOption=%s",
)
if len(ctx.attr.native_features) > 0:
args.add("-H:Features={entries}".format(entries = ",".join(ctx.attr.native_features)))
if len(ctx.attr.initialize_at_build_time) > 0:
args.add("--initialize-at-build-time={entries}".format(entries = ",".join(ctx.attr.initialize_at_build_time)))
if len(ctx.attr.initialize_at_run_time) > 0:
args.add("--initialize-at-run-time={entries}".format(entries = ",".join(ctx.attr.initialize_at_run_time)))
if ctx.attr.reflection_configuration != None:
args.add("-H:ReflectionConfigurationFiles={path}".format(path = ctx.file.reflection_configuration.path))
all_deps = depset([ctx.file.reflection_configuration], transitive = [all_deps])
if ctx.attr.include_resources != None:
args.add("-H:IncludeResources={path}".format(path = ctx.attr.include_resources))
if ctx.attr.jni_configuration != None:
args.add("-H:JNIConfigurationFiles={path}".format(path = ctx.file.jni_configuration.path))
all_deps = depset([ctx.file.jni_configuration], transitive = [all_deps])
args.add("-H:+JNI")
run_params = {
"outputs": [binary],
"arguments": [args],
"executable": graal,
"mnemonic": "NativeImage",
"env": env,
}
# fix: on bazel4, the `tools` parameter is expected to be a `File or FilesToRunProvider`, whereas
# on later versions it is expected to be a `depset`. there is also no `toolchain` parameter at all.
if not ctx.attr._legacy_rule:
run_params.update(**{
"inputs": all_deps,
"use_default_shell_env": ctx.attr.enable_default_shell_env,
"progress_message": "Compiling native image %{label}",
"toolchain": Label(_GVM_TOOLCHAIN_TYPE),
"tools": [
ctx.attr._cc_toolchain.files,
],
})
else:
run_params["inputs"] = classpath_depset
ctx.actions.run(
**run_params
)
return [DefaultInfo(
executable = binary,
files = depset([binary]),
runfiles = ctx.runfiles(
collect_data = True,
collect_default = True,
files = [],
),
)]
# Exports.
RULES_REPO = _RULES_REPO
DEFAULT_GVM_REPO = _DEFAULT_GVM_REPO
BAZEL_CURRENT_CPP_TOOLCHAIN = _BAZEL_CURRENT_CPP_TOOLCHAIN
BAZEL_CPP_TOOLCHAIN_TYPE = _BAZEL_CPP_TOOLCHAIN_TYPE
NATIVE_IMAGE_ATTRS = _NATIVE_IMAGE_ATTRS
GVM_TOOLCHAIN_TYPE = _GVM_TOOLCHAIN_TYPE
graal_binary_implementation = _graal_binary_implementation