1// Copyright 2016 Google Inc. All rights reserved. 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 cc 16 17import ( 18 "fmt" 19 "strings" 20 21 "android/soong/android" 22 "android/soong/bazel" 23 "android/soong/bazel/cquery" 24) 25 26// 27// Objects (for crt*.o) 28// 29 30func init() { 31 android.RegisterModuleType("cc_object", ObjectFactory) 32 android.RegisterSdkMemberType(ccObjectSdkMemberType) 33 34} 35 36var ccObjectSdkMemberType = &librarySdkMemberType{ 37 SdkMemberTypeBase: android.SdkMemberTypeBase{ 38 PropertyName: "native_objects", 39 SupportsSdk: true, 40 }, 41 prebuiltModuleType: "cc_prebuilt_object", 42} 43 44type objectLinker struct { 45 *baseLinker 46 Properties ObjectLinkerProperties 47 48 // Location of the object in the sysroot. Empty if the object is not 49 // included in the NDK. 50 ndkSysrootPath android.Path 51} 52 53type objectBazelHandler struct { 54 module *Module 55} 56 57var _ BazelHandler = (*objectBazelHandler)(nil) 58 59func (handler *objectBazelHandler) QueueBazelCall(ctx android.BaseModuleContext, label string) { 60 bazelCtx := ctx.Config().BazelContext 61 bazelCtx.QueueBazelRequest(label, cquery.GetOutputFiles, android.GetConfigKeyApexVariant(ctx, GetApexConfigKey(ctx))) 62} 63 64func (handler *objectBazelHandler) ProcessBazelQueryResponse(ctx android.ModuleContext, label string) { 65 bazelCtx := ctx.Config().BazelContext 66 objPaths, err := bazelCtx.GetOutputFiles(label, android.GetConfigKeyApexVariant(ctx, GetApexConfigKey(ctx))) 67 if err != nil { 68 ctx.ModuleErrorf(err.Error()) 69 return 70 } 71 72 if len(objPaths) != 1 { 73 ctx.ModuleErrorf("expected exactly one object file for '%s', but got %s", label, objPaths) 74 return 75 } 76 77 handler.module.outputFile = android.OptionalPathForPath(android.PathForBazelOut(ctx, objPaths[0])) 78} 79 80type ObjectLinkerProperties struct { 81 // list of static library modules that should only provide headers for this module. 82 Static_libs []string `android:"arch_variant,variant_prepend"` 83 84 // list of shared library modules should only provide headers for this module. 85 Shared_libs []string `android:"arch_variant,variant_prepend"` 86 87 // list of modules that should only provide headers for this module. 88 Header_libs []string `android:"arch_variant,variant_prepend"` 89 90 // list of default libraries that will provide headers for this module. If unset, generally 91 // defaults to libc, libm, and libdl. Set to [] to prevent using headers from the defaults. 92 System_shared_libs []string `android:"arch_variant"` 93 94 // names of other cc_object modules to link into this module using partial linking 95 Objs []string `android:"arch_variant"` 96 97 // if set, add an extra objcopy --prefix-symbols= step 98 Prefix_symbols *string 99 100 // if set, the path to a linker script to pass to ld -r when combining multiple object files. 101 Linker_script *string `android:"path,arch_variant"` 102 103 // Indicates that this module is a CRT object. CRT objects will be split 104 // into a variant per-API level between min_sdk_version and current. 105 Crt *bool 106 107 // Indicates that this module should not be included in the NDK sysroot. 108 // Only applies to CRT objects. Defaults to false. 109 Exclude_from_ndk_sysroot *bool 110} 111 112func newObject(hod android.HostOrDeviceSupported) *Module { 113 module := newBaseModule(hod, android.MultilibBoth) 114 module.sanitize = &sanitize{} 115 module.stl = &stl{} 116 return module 117} 118 119// cc_object runs the compiler without running the linker. It is rarely 120// necessary, but sometimes used to generate .s files from .c files to use as 121// input to a cc_genrule module. 122func ObjectFactory() android.Module { 123 module := newObject(android.HostAndDeviceSupported) 124 module.linker = &objectLinker{ 125 baseLinker: NewBaseLinker(module.sanitize), 126 } 127 module.compiler = NewBaseCompiler() 128 module.bazelHandler = &objectBazelHandler{module: module} 129 130 // Clang's address-significance tables are incompatible with ld -r. 131 module.compiler.appendCflags([]string{"-fno-addrsig"}) 132 133 module.sdkMemberTypes = []android.SdkMemberType{ccObjectSdkMemberType} 134 135 module.bazelable = true 136 return module.Init() 137} 138 139// For bp2build conversion. 140type bazelObjectAttributes struct { 141 Srcs bazel.LabelListAttribute 142 Srcs_as bazel.LabelListAttribute 143 Hdrs bazel.LabelListAttribute 144 Objs bazel.LabelListAttribute 145 Deps bazel.LabelListAttribute 146 System_dynamic_deps bazel.LabelListAttribute 147 Copts bazel.StringListAttribute 148 Asflags bazel.StringListAttribute 149 Local_includes bazel.StringListAttribute 150 Absolute_includes bazel.StringListAttribute 151 Stl *string 152 Linker_script bazel.LabelAttribute 153 Crt *bool 154 sdkAttributes 155} 156 157// objectBp2Build is the bp2build converter from cc_object modules to the 158// Bazel equivalent target, plus any necessary include deps for the cc_object. 159func objectBp2Build(ctx android.TopDownMutatorContext, m *Module) { 160 if m.compiler == nil { 161 // a cc_object must have access to the compiler decorator for its props. 162 ctx.ModuleErrorf("compiler must not be nil for a cc_object module") 163 } 164 165 // Set arch-specific configurable attributes 166 baseAttributes := bp2BuildParseBaseProps(ctx, m) 167 compilerAttrs := baseAttributes.compilerAttributes 168 var objs bazel.LabelListAttribute 169 var deps bazel.LabelListAttribute 170 systemDynamicDeps := bazel.LabelListAttribute{ForceSpecifyEmptyList: true} 171 172 var linkerScript bazel.LabelAttribute 173 174 for axis, configToProps := range m.GetArchVariantProperties(ctx, &ObjectLinkerProperties{}) { 175 for config, props := range configToProps { 176 if objectLinkerProps, ok := props.(*ObjectLinkerProperties); ok { 177 if objectLinkerProps.Linker_script != nil { 178 label := android.BazelLabelForModuleSrcSingle(ctx, *objectLinkerProps.Linker_script) 179 linkerScript.SetSelectValue(axis, config, label) 180 } 181 objs.SetSelectValue(axis, config, android.BazelLabelForModuleDeps(ctx, objectLinkerProps.Objs)) 182 systemSharedLibs := objectLinkerProps.System_shared_libs 183 if len(systemSharedLibs) > 0 { 184 systemSharedLibs = android.FirstUniqueStrings(systemSharedLibs) 185 } 186 systemDynamicDeps.SetSelectValue(axis, config, bazelLabelForSharedDeps(ctx, systemSharedLibs)) 187 deps.SetSelectValue(axis, config, android.BazelLabelForModuleDeps(ctx, objectLinkerProps.Static_libs)) 188 deps.SetSelectValue(axis, config, android.BazelLabelForModuleDeps(ctx, objectLinkerProps.Shared_libs)) 189 deps.SetSelectValue(axis, config, android.BazelLabelForModuleDeps(ctx, objectLinkerProps.Header_libs)) 190 // static_libs, shared_libs, and header_libs have variant_prepend tag 191 deps.Prepend = true 192 } 193 } 194 } 195 objs.ResolveExcludes() 196 197 // Don't split cc_object srcs across languages. Doing so would add complexity, 198 // and this isn't typically done for cc_object. 199 srcs := compilerAttrs.srcs 200 srcs.Append(compilerAttrs.cSrcs) 201 202 asFlags := compilerAttrs.asFlags 203 if compilerAttrs.asSrcs.IsEmpty() { 204 // Skip asflags for BUILD file simplicity if there are no assembly sources. 205 asFlags = bazel.MakeStringListAttribute(nil) 206 } 207 208 attrs := &bazelObjectAttributes{ 209 Srcs: srcs, 210 Srcs_as: compilerAttrs.asSrcs, 211 Objs: objs, 212 Deps: deps, 213 System_dynamic_deps: systemDynamicDeps, 214 Copts: compilerAttrs.copts, 215 Asflags: asFlags, 216 Local_includes: compilerAttrs.localIncludes, 217 Absolute_includes: compilerAttrs.absoluteIncludes, 218 Stl: compilerAttrs.stl, 219 Linker_script: linkerScript, 220 Crt: m.linker.(*objectLinker).Properties.Crt, 221 sdkAttributes: bp2BuildParseSdkAttributes(m), 222 } 223 224 props := bazel.BazelTargetModuleProperties{ 225 Rule_class: "cc_object", 226 Bzl_load_location: "//build/bazel/rules/cc:cc_object.bzl", 227 } 228 229 tags := android.ApexAvailableTags(m) 230 231 ctx.CreateBazelTargetModule(props, android.CommonAttributes{ 232 Name: m.Name(), 233 Tags: tags, 234 }, attrs) 235} 236 237func (object *objectLinker) appendLdflags(flags []string) { 238 panic(fmt.Errorf("appendLdflags on objectLinker not supported")) 239} 240 241func (object *objectLinker) linkerProps() []interface{} { 242 return []interface{}{&object.Properties} 243} 244 245func (*objectLinker) linkerInit(ctx BaseModuleContext) {} 246 247func (object *objectLinker) linkerDeps(ctx DepsContext, deps Deps) Deps { 248 deps.HeaderLibs = append(deps.HeaderLibs, object.Properties.Header_libs...) 249 deps.SharedLibs = append(deps.SharedLibs, object.Properties.Shared_libs...) 250 deps.StaticLibs = append(deps.StaticLibs, object.Properties.Static_libs...) 251 deps.ObjFiles = append(deps.ObjFiles, object.Properties.Objs...) 252 253 deps.SystemSharedLibs = object.Properties.System_shared_libs 254 if deps.SystemSharedLibs == nil { 255 // Provide a default set of shared libraries if system_shared_libs is unspecified. 256 // Note: If an empty list [] is specified, it implies that the module declines the 257 // default shared libraries. 258 deps.SystemSharedLibs = append(deps.SystemSharedLibs, ctx.toolchain().DefaultSharedLibraries()...) 259 } 260 deps.LateSharedLibs = append(deps.LateSharedLibs, deps.SystemSharedLibs...) 261 return deps 262} 263 264func (object *objectLinker) linkerFlags(ctx ModuleContext, flags Flags) Flags { 265 flags.Global.LdFlags = append(flags.Global.LdFlags, ctx.toolchain().ToolchainLdflags()) 266 267 if lds := android.OptionalPathForModuleSrc(ctx, object.Properties.Linker_script); lds.Valid() { 268 flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-T,"+lds.String()) 269 flags.LdFlagsDeps = append(flags.LdFlagsDeps, lds.Path()) 270 } 271 return flags 272} 273 274func (object *objectLinker) link(ctx ModuleContext, 275 flags Flags, deps PathDeps, objs Objects) android.Path { 276 277 objs = objs.Append(deps.Objs) 278 279 var output android.WritablePath 280 builderFlags := flagsToBuilderFlags(flags) 281 outputName := ctx.ModuleName() 282 if !strings.HasSuffix(outputName, objectExtension) { 283 outputName += objectExtension 284 } 285 286 // isForPlatform is terribly named and actually means isNotApex. 287 if Bool(object.Properties.Crt) && 288 !Bool(object.Properties.Exclude_from_ndk_sysroot) && ctx.useSdk() && 289 ctx.isSdkVariant() && ctx.isForPlatform() { 290 291 output = getVersionedLibraryInstallPath(ctx, 292 nativeApiLevelOrPanic(ctx, ctx.sdkVersion())).Join(ctx, outputName) 293 object.ndkSysrootPath = output 294 } else { 295 output = android.PathForModuleOut(ctx, outputName) 296 } 297 298 outputFile := output 299 300 if len(objs.objFiles) == 1 && String(object.Properties.Linker_script) == "" { 301 if String(object.Properties.Prefix_symbols) != "" { 302 transformBinaryPrefixSymbols(ctx, String(object.Properties.Prefix_symbols), objs.objFiles[0], 303 builderFlags, output) 304 } else { 305 ctx.Build(pctx, android.BuildParams{ 306 Rule: android.Cp, 307 Input: objs.objFiles[0], 308 Output: output, 309 }) 310 } 311 } else { 312 if String(object.Properties.Prefix_symbols) != "" { 313 input := android.PathForModuleOut(ctx, "unprefixed", outputName) 314 transformBinaryPrefixSymbols(ctx, String(object.Properties.Prefix_symbols), input, 315 builderFlags, output) 316 output = input 317 } 318 319 transformObjsToObj(ctx, objs.objFiles, builderFlags, output, flags.LdFlagsDeps) 320 } 321 322 ctx.CheckbuildFile(outputFile) 323 return outputFile 324} 325 326func (object *objectLinker) linkerSpecifiedDeps(specifiedDeps specifiedDeps) specifiedDeps { 327 specifiedDeps.sharedLibs = append(specifiedDeps.sharedLibs, object.Properties.Shared_libs...) 328 329 // Must distinguish nil and [] in system_shared_libs - ensure that [] in 330 // either input list doesn't come out as nil. 331 if specifiedDeps.systemSharedLibs == nil { 332 specifiedDeps.systemSharedLibs = object.Properties.System_shared_libs 333 } else { 334 specifiedDeps.systemSharedLibs = append(specifiedDeps.systemSharedLibs, object.Properties.System_shared_libs...) 335 } 336 337 return specifiedDeps 338} 339 340func (object *objectLinker) unstrippedOutputFilePath() android.Path { 341 return nil 342} 343 344func (object *objectLinker) nativeCoverage() bool { 345 return true 346} 347 348func (object *objectLinker) coverageOutputFilePath() android.OptionalPath { 349 return android.OptionalPath{} 350} 351 352func (object *objectLinker) object() bool { 353 return true 354} 355 356func (object *objectLinker) isCrt() bool { 357 return Bool(object.Properties.Crt) 358} 359