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
|
# Copyright (C) 2022 The Android Open Source Project
#
# 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("//build/kernel/kleaf:hermetic_tools.bzl", "HermeticToolsInfo")
load(
":common_providers.bzl",
"KernelBuildAbiInfo",
"KernelBuildExtModuleInfo",
"KernelBuildInTreeModulesInfo",
"KernelBuildUapiInfo",
"KernelImagesInfo",
"KernelUnstrippedModulesInfo",
)
load(
":constants.bzl",
"MODULES_STAGING_ARCHIVE",
)
load(":debug.bzl", "debug")
load(
":utils.bzl",
"kernel_utils",
"utils",
)
def _kernel_filegroup_impl(ctx):
all_deps = ctx.files.srcs + ctx.files.deps
# TODO(b/219112010): implement KernelEnvInfo for the modules_prepare target
modules_prepare_out_dir_tar_gz = utils.find_file("modules_prepare_outdir.tar.gz", all_deps, what = ctx.label)
modules_prepare_setup = """
# Restore modules_prepare outputs. Assumes env setup.
[ -z ${{OUT_DIR}} ] && echo "ERROR: modules_prepare setup run without OUT_DIR set!" >&2 && exit 1
tar xf {outdir_tar_gz} -C ${{OUT_DIR}}
""".format(outdir_tar_gz = modules_prepare_out_dir_tar_gz)
modules_prepare_deps = [modules_prepare_out_dir_tar_gz]
kernel_module_dev_info = KernelBuildExtModuleInfo(
modules_staging_archive = utils.find_file(MODULES_STAGING_ARCHIVE, all_deps, what = ctx.label),
modules_prepare_setup = modules_prepare_setup,
modules_prepare_deps = modules_prepare_deps,
# TODO(b/211515836): module_srcs might also be downloaded
module_srcs = kernel_utils.filter_module_srcs(ctx.files.kernel_srcs),
collect_unstripped_modules = ctx.attr.collect_unstripped_modules,
)
uapi_info = KernelBuildUapiInfo(
kernel_uapi_headers = ctx.attr.kernel_uapi_headers,
)
unstripped_modules_info = None
for target in ctx.attr.srcs:
if KernelUnstrippedModulesInfo in target:
unstripped_modules_info = target[KernelUnstrippedModulesInfo]
break
if unstripped_modules_info == None:
# Reverse of kernel_unstripped_modules_archive
unstripped_modules_archive = utils.find_file("unstripped_modules.tar.gz", all_deps, what = ctx.label, required = True)
unstripped_dir = ctx.actions.declare_directory("{}/unstripped".format(ctx.label.name))
command = ctx.attr._hermetic_tools[HermeticToolsInfo].setup + """
tar xf {unstripped_modules_archive} -C $(dirname {unstripped_dir}) $(basename {unstripped_dir})
"""
debug.print_scripts(ctx, command, what = "unstripped_modules_archive")
ctx.actions.run_shell(
command = command,
inputs = ctx.attr._hermetic_tools[HermeticToolsInfo].deps + [
unstripped_modules_archive,
],
outputs = [unstripped_dir],
progress_message = "Extracting unstripped_modules_archive {}".format(ctx.label),
mnemonic = "KernelFilegroupUnstrippedModulesArchive",
)
unstripped_modules_info = KernelUnstrippedModulesInfo(
directories = depset([unstripped_dir], order = "postorder"),
)
abi_info = KernelBuildAbiInfo(module_outs_file = ctx.file.module_outs_file)
in_tree_modules_info = KernelBuildInTreeModulesInfo(module_outs_file = ctx.file.module_outs_file)
images_info = KernelImagesInfo(base_kernel = None)
return [
DefaultInfo(files = depset(ctx.files.srcs)),
kernel_module_dev_info,
# TODO(b/219112010): implement KernelEnvInfo for kernel_filegroup
uapi_info,
unstripped_modules_info,
abi_info,
in_tree_modules_info,
images_info,
]
kernel_filegroup = rule(
implementation = _kernel_filegroup_impl,
doc = """Specify a list of kernel prebuilts.
This is similar to [`filegroup`](https://docs.bazel.build/versions/main/be/general.html#filegroup)
that gives a convenient name to a collection of targets, which can be referenced from other rules.
It can be used in the `base_kernel` attribute of a [`kernel_build`](#kernel_build).
""",
attrs = {
"srcs": attr.label_list(
allow_files = True,
doc = """The list of labels that are members of this file group.
This usually contains a list of prebuilts, e.g. `vmlinux`, `Image.lz4`, `kernel-headers.tar.gz`,
etc.
Not to be confused with [`kernel_srcs`](#kernel_filegroup-kernel_srcs).""",
),
"deps": attr.label_list(
allow_files = True,
doc = """A list of additional labels that participates in implementing the providers.
This usually contains a list of prebuilts.
Unlike srcs, these labels are NOT added to the [`DefaultInfo`](https://docs.bazel.build/versions/main/skylark/lib/DefaultInfo.html)""",
),
"kernel_srcs": attr.label_list(
allow_files = True,
doc = """A list of files that would have been listed as `srcs` if this rule were a [`kernel_build`](#kernel_build).
This is usually a `glob()` of source files.
Not to be confused with [`srcs`](#kernel_filegroup-srcs).
""",
),
"kernel_uapi_headers": attr.label(
allow_files = True,
doc = """The label pointing to `kernel-uapi-headers.tar.gz`.
This attribute should be set to the `kernel-uapi-headers.tar.gz` artifact built by the
[`kernel_build`](#kernel_build) macro if the `kernel_filegroup` rule were a `kernel_build`.
Setting this attribute allows [`merged_kernel_uapi_headers`](#merged_kernel_uapi_headers) to
work properly when this `kernel_filegroup` is set to the `base_kernel`.
For example:
```
kernel_filegroup(
name = "kernel_aarch64_prebuilts",
srcs = [
"vmlinux",
# ...
],
kernel_uapi_headers = "kernel-uapi-headers.tar.gz",
)
kernel_build(
name = "tuna",
base_kernel = ":kernel_aarch64_prebuilts",
# ...
)
merged_kernel_uapi_headers(
name = "tuna_merged_kernel_uapi_headers",
kernel_build = "tuna",
# ...
)
```
""",
),
"collect_unstripped_modules": attr.bool(
default = True,
doc = """See [`kernel_build.collect_unstripped_modules`](#kernel_build-collect_unstripped_modules).
Unlike `kernel_build`, this has default value `True` because
[`kernel_build_abi`](#kernel_build_abi) sets
[`define_abi_targets`](#kernel_build_abi-define_abi_targets) to `True` by
default, which in turn sets `collect_unstripped_modules` to `True` by default.
""",
),
"module_outs_file": attr.label(
allow_single_file = True,
doc = """A file containing `module_outs` of the original [`kernel_build`](#kernel_build) target.""",
),
"images": attr.label(
allow_files = True,
doc = """A label providing files similar to a [`kernel_images`](#kernel_images) target.""",
),
"_debug_print_scripts": attr.label(default = "//build/kernel/kleaf:debug_print_scripts"),
"_hermetic_tools": attr.label(default = "//build/kernel:hermetic-tools", providers = [HermeticToolsInfo]),
},
)
|
