blob: 533ec62589db50f698aa666cacbcf92075466a4d [file] [log] [blame]
Kiyoung Kim62abd122020-10-06 17:16:44 +09001// Copyright (C) 2020 The Android Open Source Project
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package linkerconfig
16
17import (
Jiyong Parkfa616132021-04-20 11:36:40 +090018 "sort"
19 "strings"
Kiyoung Kim62abd122020-10-06 17:16:44 +090020
21 "github.com/google/blueprint/proptools"
Jiyong Parkfa616132021-04-20 11:36:40 +090022
23 "android/soong/android"
24 "android/soong/cc"
25 "android/soong/etc"
Kiyoung Kim62abd122020-10-06 17:16:44 +090026)
27
28var (
29 pctx = android.NewPackageContext("android/soong/linkerconfig")
30)
31
32func init() {
33 pctx.HostBinToolVariable("conv_linker_config", "conv_linker_config")
Paul Duffin2a2fb662021-03-29 01:14:55 +010034 registerLinkerConfigBuildComponent(android.InitRegistrationContext)
35}
36
37func registerLinkerConfigBuildComponent(ctx android.RegistrationContext) {
Liz Kammer45faf8f2022-06-02 16:00:54 -040038 ctx.RegisterModuleType("linker_config", LinkerConfigFactory)
Kiyoung Kim62abd122020-10-06 17:16:44 +090039}
40
41type linkerConfigProperties struct {
42 // source linker configuration property file
43 Src *string `android:"path"`
44
45 // If set to true, allow module to be installed to one of the partitions.
46 // Default value is true.
47 // Installable should be marked as false for APEX configuration to avoid
48 // conflicts of configuration on /system/etc directory.
49 Installable *bool
50}
51
52type linkerConfig struct {
53 android.ModuleBase
54 properties linkerConfigProperties
55
56 outputFilePath android.OutputPath
57 installDirPath android.InstallPath
58}
59
60// Implement PrebuiltEtcModule interface to fit in APEX prebuilt list.
61var _ etc.PrebuiltEtcModule = (*linkerConfig)(nil)
62
63func (l *linkerConfig) BaseDir() string {
64 return "etc"
65}
66
67func (l *linkerConfig) SubDir() string {
68 return ""
69}
70
71func (l *linkerConfig) OutputFile() android.OutputPath {
72 return l.outputFilePath
73}
74
75func (l *linkerConfig) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jiyong Parkfa616132021-04-20 11:36:40 +090076 input := android.PathForModuleSrc(ctx, android.String(l.properties.Src))
77 output := android.PathForModuleOut(ctx, "linker.config.pb").OutputPath
Kiyoung Kim62abd122020-10-06 17:16:44 +090078
Jiyong Parkfa616132021-04-20 11:36:40 +090079 builder := android.NewRuleBuilder(pctx, ctx)
Kiyoung Kimee599d62024-03-22 18:00:40 +090080 BuildLinkerConfig(ctx, builder, input, nil, nil, output)
Jiyong Parkfa616132021-04-20 11:36:40 +090081 builder.Build("conv_linker_config", "Generate linker config protobuf "+output.String())
82
83 l.outputFilePath = output
84 l.installDirPath = android.PathForModuleInstall(ctx, "etc")
Jooyung Hanc6a91ec2021-04-15 04:41:13 +090085 if !proptools.BoolDefault(l.properties.Installable, true) {
86 l.SkipInstall()
Kiyoung Kim62abd122020-10-06 17:16:44 +090087 }
Jooyung Hanc6a91ec2021-04-15 04:41:13 +090088 ctx.InstallFile(l.installDirPath, l.outputFilePath.Base(), l.outputFilePath)
mrziwange2346b82024-06-10 15:09:45 -070089
90 ctx.SetOutputFiles(android.Paths{l.outputFilePath}, "")
Kiyoung Kim62abd122020-10-06 17:16:44 +090091}
92
Jiyong Parkfa616132021-04-20 11:36:40 +090093func BuildLinkerConfig(ctx android.ModuleContext, builder *android.RuleBuilder,
Kiyoung Kimee599d62024-03-22 18:00:40 +090094 input android.Path, provideModules []android.Module, requireModules []android.Module, output android.OutputPath) {
Jiyong Parkfa616132021-04-20 11:36:40 +090095
96 // First, convert the input json to protobuf format
97 interimOutput := android.PathForModuleOut(ctx, "temp.pb")
98 builder.Command().
99 BuiltTool("conv_linker_config").
100 Flag("proto").
101 FlagWithInput("-s ", input).
102 FlagWithOutput("-o ", interimOutput)
103
Kiyoung Kimee599d62024-03-22 18:00:40 +0900104 // Secondly, if there's provideLibs gathered from provideModules, append them
Jiyong Parkfa616132021-04-20 11:36:40 +0900105 var provideLibs []string
Kiyoung Kimee599d62024-03-22 18:00:40 +0900106 for _, m := range provideModules {
Kiyoung Kime8d8a472024-07-05 14:00:34 +0900107 if c, ok := m.(*cc.Module); ok && (cc.IsStubTarget(c) || c.HasLlndkStubs()) {
Yu Liud46e5ae2024-08-15 18:46:17 +0000108 for _, ps := range android.OtherModuleProviderOrDefault(
109 ctx, c, android.InstallFilesProvider).PackagingSpecs {
Jiyong Parkfa616132021-04-20 11:36:40 +0900110 provideLibs = append(provideLibs, ps.FileName())
111 }
112 }
113 }
114 provideLibs = android.FirstUniqueStrings(provideLibs)
115 sort.Strings(provideLibs)
Kiyoung Kimee599d62024-03-22 18:00:40 +0900116
117 var requireLibs []string
118 for _, m := range requireModules {
119 if c, ok := m.(*cc.Module); ok && c.HasStubsVariants() && !c.Host() {
120 requireLibs = append(requireLibs, c.ImplementationModuleName(ctx)+".so")
121 }
122 }
123
124 requireLibs = android.FirstUniqueStrings(requireLibs)
125 sort.Strings(requireLibs)
126
Jiyong Parkfa616132021-04-20 11:36:40 +0900127 if len(provideLibs) > 0 {
Kiyoung Kimee599d62024-03-22 18:00:40 +0900128 prevOutput := interimOutput
129 interimOutput = android.PathForModuleOut(ctx, "temp_provideLibs.pb")
Jiyong Parkfa616132021-04-20 11:36:40 +0900130 builder.Command().
131 BuiltTool("conv_linker_config").
132 Flag("append").
Kiyoung Kimee599d62024-03-22 18:00:40 +0900133 FlagWithInput("-s ", prevOutput).
134 FlagWithOutput("-o ", interimOutput).
Jiyong Parkfa616132021-04-20 11:36:40 +0900135 FlagWithArg("--key ", "provideLibs").
136 FlagWithArg("--value ", proptools.ShellEscapeIncludingSpaces(strings.Join(provideLibs, " ")))
Kiyoung Kimee599d62024-03-22 18:00:40 +0900137 builder.Temporary(prevOutput)
Jiyong Parkfa616132021-04-20 11:36:40 +0900138 }
Kiyoung Kimee599d62024-03-22 18:00:40 +0900139 if len(requireLibs) > 0 {
140 prevOutput := interimOutput
141 interimOutput = android.PathForModuleOut(ctx, "temp_requireLibs.pb")
142 builder.Command().
143 BuiltTool("conv_linker_config").
144 Flag("append").
145 FlagWithInput("-s ", prevOutput).
146 FlagWithOutput("-o ", interimOutput).
147 FlagWithArg("--key ", "requireLibs").
148 FlagWithArg("--value ", proptools.ShellEscapeIncludingSpaces(strings.Join(requireLibs, " ")))
149 builder.Temporary(prevOutput)
150 }
151
152 // cp to the final output
153 builder.Command().Text("cp").Input(interimOutput).Output(output)
154
Jiyong Parkfa616132021-04-20 11:36:40 +0900155 builder.Temporary(interimOutput)
156 builder.DeleteTemporaryFiles()
157}
158
Kiyoung Kim62abd122020-10-06 17:16:44 +0900159// linker_config generates protobuf file from json file. This protobuf file will be used from
160// linkerconfig while generating ld.config.txt. Format of this file can be found from
Elliott Hughes10363162024-01-09 22:02:03 +0000161// https://android.googlesource.com/platform/system/linkerconfig/+/main/README.md
Liz Kammer45faf8f2022-06-02 16:00:54 -0400162func LinkerConfigFactory() android.Module {
Kiyoung Kim62abd122020-10-06 17:16:44 +0900163 m := &linkerConfig{}
164 m.AddProperties(&m.properties)
165 android.InitAndroidArchModule(m, android.HostAndDeviceSupported, android.MultilibFirst)
166 return m
167}
168
169func (l *linkerConfig) AndroidMkEntries() []android.AndroidMkEntries {
170 installable := proptools.BoolDefault(l.properties.Installable, true)
171 return []android.AndroidMkEntries{android.AndroidMkEntries{
172 Class: "ETC",
173 OutputFile: android.OptionalPathForPath(l.outputFilePath),
174 ExtraEntries: []android.AndroidMkExtraEntriesFunc{
Colin Crossaa255532020-07-03 13:18:24 -0700175 func(ctx android.AndroidMkExtraEntriesContext, entries *android.AndroidMkEntries) {
Colin Crossc68db4b2021-11-11 18:59:15 -0800176 entries.SetString("LOCAL_MODULE_PATH", l.installDirPath.String())
Kiyoung Kim62abd122020-10-06 17:16:44 +0900177 entries.SetString("LOCAL_INSTALLED_MODULE_STEM", l.outputFilePath.Base())
178 entries.SetBoolIfTrue("LOCAL_UNINSTALLABLE_MODULE", !installable)
Kiyoung Kim62abd122020-10-06 17:16:44 +0900179 },
180 },
181 }}
182}