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
|
# 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.
# Providers that are provided by multiple rules in different extensions.
KernelEnvInfo = provider(
doc = """Describe a generic environment setup with some dependencies and a setup script.
`KernelEnvInfo` is a legacy name; it is not only provided by `kernel_env`, but
other rules like `kernel_config` and `kernel_build`. Hence, the `KernelEnvInfo`
is in its own extension instead of `kernel_env.bzl`.
""",
fields = {
"dependencies": "dependencies required to use this environment setup",
"setup": "setup script to initialize the environment",
},
)
KernelEnvAttrInfo = provider(
doc = "Provide attributes of `kernel_env`.",
fields = {
"kbuild_symtypes": "`KBUILD_SYMTYPES`, after resolving `--kbuild_symtypes` and the static value.",
},
)
KernelBuildInfo = provider(
doc = """Generic information provided by a `kernel_build`.""",
fields = {
"out_dir_kernel_headers_tar": "Archive containing headers in `OUT_DIR`",
"outs": "A list of File object corresponding to the `outs` attribute (excluding `module_outs`, `implicit_outs` and `internal_outs`)",
"base_kernel_files": "[Default outputs](https://docs.bazel.build/versions/main/skylark/rules.html#default-outputs) of the rule specified by `base_kernel`",
"interceptor_output": "`interceptor` log. See [`interceptor`](https://android.googlesource.com/kernel/tools/interceptor/) project.",
"kernel_release": "The file `kernel.release`.",
},
)
KernelBuildExtModuleInfo = provider(
doc = "A provider that specifies the expectations of a `_kernel_module` (an external module) or a `kernel_modules_install` from its `kernel_build` attribute.",
fields = {
"modules_staging_archive": "Archive containing staging kernel modules. " +
"Does not contain the lib/modules/* suffix.",
"module_srcs": "sources for this kernel_build for building external modules",
"modules_prepare_setup": "A command that is equivalent to running `make modules_prepare`. Requires env setup.",
"modules_prepare_deps": "A list of deps to run `modules_prepare_cmd`.",
"collect_unstripped_modules": "Whether an external [`kernel_module`](#kernel_module) building against this [`kernel_build`](#kernel_build) should provide unstripped ones for debugging.",
},
)
KernelBuildUapiInfo = provider(
doc = "A provider that specifies the expecation of a `merged_uapi_headers` rule from its `kernel_build` attribute.",
fields = {
"base_kernel": "the `base_kernel` target, if exists",
"kernel_uapi_headers": "the `*_kernel_uapi_headers` target",
},
)
KernelBuildAbiInfo = provider(
doc = "A provider that specifies the expectations of a [`kernel_abi`](#kernel_abi) on a `kernel_build`.",
fields = {
"trim_nonlisted_kmi": "Value of `trim_nonlisted_kmi` in [`kernel_build()`](#kernel_build).",
"combined_abi_symbollist": "The **combined** `abi_symbollist` file from the `_kmi_symbol_list` rule, consist of the source `kmi_symbol_list` and `additional_kmi_symbol_lists`.",
"module_outs_file": "A file containing `[kernel_build.module_outs]`(#kernel_build-module_outs) and `[kernel_build.module_implicit_outs]`(#kernel_build-module_implicit_outs).",
},
)
KernelBuildInTreeModulesInfo = provider(
doc = """A provider that specifies the expectations of a [`kernel_build`](#kernel_build) on its
[`base_kernel`](#kernel_build-base_kernel) or [`base_kernel_for_module_outs`](#kernel_build-base_kernel_for_module_outs).""",
fields = {
"module_outs_file": "A file containing `[kernel_build.module_outs]`(#kernel_build-module_outs) and `[kernel_build.module_implicit_outs]`(#kernel_build-module_implicit_outs).",
},
)
KernelUnstrippedModulesInfo = provider(
doc = "A provider that provides unstripped modules",
fields = {
"base_kernel": "the `base_kernel` target, if exists",
"directory": """A [`File`](https://bazel.build/rules/lib/File) that
points to a directory containing unstripped modules.
For [`kernel_build()`](#kernel_build), this is a directory containing unstripped in-tree modules.
- This is `None` if and only if `collect_unstripped_modules = False`
- Never `None` if and only if `collect_unstripped_modules = True`
- An empty directory if and only if `collect_unstripped_modules = True` and `module_outs` is empty
For an external [`kernel_module()`](#kernel_module), this is a directory containing unstripped external modules.
- This is `None` if and only if the `kernel_build` argument has `collect_unstripped_modules = False`
- Never `None` if and only if the `kernel_build` argument has `collect_unstripped_modules = True`
""",
},
)
KernelModuleInfo = provider(
doc = "A provider that provides installed external modules.",
fields = {
"kernel_build": "kernel_build attribute of this module",
"modules_staging_dws": "`directory_with_structure` containing staging kernel modules. " +
"Contains the lib/modules/* suffix.",
"kernel_uapi_headers_dws": "`directory_with_structure` containing UAPI headers to use the module.",
"files": "The list of output `*.ko` files.",
},
)
KernelImagesInfo = provider(
doc = "A provider that represents the expectation of [`kernel_images`](#kernel_images) to [`kernel_build`](#kernel_build)",
fields = {
"base_kernel": "the `base_kernel` target, if exists",
},
)
|
