cc/object.go - SHIFTPHONES/android_build_soong - Gitiles

 // Copyright 2016 Google Inc. All rights reserved.
 //
 // 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.

 package cc

 import (
 	"fmt"

 	"android/soong/android"
 	"android/soong/bazel"
 )

 //
 // Objects (for crt*.o)
 //

 func init() {
 	android.RegisterModuleType("cc_object", ObjectFactory)
 	android.RegisterSdkMemberType(ccObjectSdkMemberType)

 	android.RegisterBp2BuildMutator("cc_object", ObjectBp2Build)
 }

 var ccObjectSdkMemberType = &librarySdkMemberType{
 	SdkMemberTypeBase: android.SdkMemberTypeBase{
 		PropertyName: "native_objects",
 		SupportsSdk:  true,
 	},
 	prebuiltModuleType: "cc_prebuilt_object",
 	linkTypes:          nil,
 }

 type objectLinker struct {
 	*baseLinker
 	Properties ObjectLinkerProperties
 }

 type objectBazelHandler struct {
 	bazelHandler

 	module *Module
 }

 func (handler *objectBazelHandler) generateBazelBuildActions(ctx android.ModuleContext, label string) bool {
 	bazelCtx := ctx.Config().BazelContext
 	objPaths, ok := bazelCtx.GetOutputFiles(label, ctx.Arch().ArchType)
 	if ok {
 		if len(objPaths) != 1 {
 			ctx.ModuleErrorf("expected exactly one object file for '%s', but got %s", label, objPaths)
 			return false
 		}

 		handler.module.outputFile = android.OptionalPathForPath(android.PathForBazelOut(ctx, objPaths[0]))
 	}
 	return ok
 }

 type ObjectLinkerProperties struct {
 	// list of modules that should only provide headers for this module.
 	Header_libs []string `android:"arch_variant,variant_prepend"`

 	// names of other cc_object modules to link into this module using partial linking
 	Objs []string `android:"arch_variant"`

 	// if set, add an extra objcopy --prefix-symbols= step
 	Prefix_symbols *string

 	// if set, the path to a linker script to pass to ld -r when combining multiple object files.
 	Linker_script *string `android:"path,arch_variant"`

 	// Indicates that this module is a CRT object. CRT objects will be split
 	// into a variant per-API level between min_sdk_version and current.
 	Crt *bool
 }

 func newObject() *Module {
 	module := newBaseModule(android.HostAndDeviceSupported, android.MultilibBoth)
 	module.sanitize = &sanitize{}
 	module.stl = &stl{}
 	return module
 }

 // cc_object runs the compiler without running the linker. It is rarely
 // necessary, but sometimes used to generate .s files from .c files to use as
 // input to a cc_genrule module.
 func ObjectFactory() android.Module {
 	module := newObject()
 	module.linker = &objectLinker{
 		baseLinker: NewBaseLinker(module.sanitize),
 	}
 	module.compiler = NewBaseCompiler()
 	module.bazelHandler = &objectBazelHandler{module: module}

 	// Clang's address-significance tables are incompatible with ld -r.
 	module.compiler.appendCflags([]string{"-fno-addrsig"})

 	module.sdkMemberTypes = []android.SdkMemberType{ccObjectSdkMemberType}

 	return module.Init()
 }

 // For bp2build conversion.
 type bazelObjectAttributes struct {
 	Srcs               bazel.LabelListAttribute
 	Hdrs               bazel.LabelListAttribute
 	Deps               bazel.LabelListAttribute
 	Copts              bazel.StringListAttribute
 	Asflags            []string
 	Local_include_dirs []string
 }

 type bazelObject struct {
 	android.BazelTargetModuleBase
 	bazelObjectAttributes
 }

 func (m *bazelObject) Name() string {
 	return m.BaseModuleName()
 }

 func (m *bazelObject) GenerateAndroidBuildActions(ctx android.ModuleContext) {}

 func BazelObjectFactory() android.Module {
 	module := &bazelObject{}
 	module.AddProperties(&module.bazelObjectAttributes)
 	android.InitBazelTargetModule(module)
 	return module
 }

 // ObjectBp2Build is the bp2build converter from cc_object modules to the
 // Bazel equivalent target, plus any necessary include deps for the cc_object.
 func ObjectBp2Build(ctx android.TopDownMutatorContext) {
 	m, ok := ctx.Module().(*Module)
 	if !ok || !m.ConvertWithBp2build(ctx) {
 		return
 	}

 	// a Module can be something other than a cc_object.
 	if ctx.ModuleType() != "cc_object" {
 		return
 	}

 	if m.compiler == nil {
 		// a cc_object must have access to the compiler decorator for its props.
 		ctx.ModuleErrorf("compiler must not be nil for a cc_object module")
 	}

 	// Set arch-specific configurable attributes
 	compilerAttrs := bp2BuildParseCompilerProps(ctx, m)
 	var localIncludeDirs []string
 	var asFlags []string
 	for _, props := range m.compiler.compilerProps() {
 		if baseCompilerProps, ok := props.(*BaseCompilerProperties); ok {
 			localIncludeDirs = baseCompilerProps.Local_include_dirs
 			break
 		}
 	}

 	if c, ok := m.compiler.(*baseCompiler); ok && c.includeBuildDirectory() {
 		localIncludeDirs = append(localIncludeDirs, ".")
 	}

 	var deps bazel.LabelListAttribute
 	for _, props := range m.linker.linkerProps() {
 		if objectLinkerProps, ok := props.(*ObjectLinkerProperties); ok {
 			deps = bazel.MakeLabelListAttribute(
 				android.BazelLabelForModuleDeps(ctx, objectLinkerProps.Objs))
 		}
 	}

 	productVariableProps := android.ProductVariableProperties(ctx)
 	if props, exists := productVariableProps["Asflags"]; exists {
 		// TODO(b/183595873): consider deduplicating handling of product variable properties
 		for _, prop := range props {
 			flags, ok := prop.Property.([]string)
 			if !ok {
 				ctx.ModuleErrorf("Could not convert product variable asflag property")
 				return
 			}
 			// TODO(b/183595873) handle other product variable usages -- as selects?
 			if newFlags, subbed := bazel.TryVariableSubstitutions(flags, prop.ProductConfigVariable); subbed {
 				asFlags = append(asFlags, newFlags...)
 			}
 		}
 	}
 	// TODO(b/183595872) warn/error if we're not handling product variables

 	attrs := &bazelObjectAttributes{
 		Srcs:               compilerAttrs.srcs,
 		Hdrs:               compilerAttrs.hdrs,
 		Deps:               deps,
 		Copts:              compilerAttrs.copts,
 		Asflags:            asFlags,
 		Local_include_dirs: localIncludeDirs,
 	}

 	props := bazel.BazelTargetModuleProperties{
 		Rule_class:        "cc_object",
 		Bzl_load_location: "//build/bazel/rules:cc_object.bzl",
 	}

 	ctx.CreateBazelTargetModule(BazelObjectFactory, m.Name(), props, attrs)
 }

 func (object *objectLinker) appendLdflags(flags []string) {
 	panic(fmt.Errorf("appendLdflags on objectLinker not supported"))
 }

 func (object *objectLinker) linkerProps() []interface{} {
 	return []interface{}{&object.Properties}
 }

 func (*objectLinker) linkerInit(ctx BaseModuleContext) {}

 func (object *objectLinker) linkerDeps(ctx DepsContext, deps Deps) Deps {
 	deps.HeaderLibs = append(deps.HeaderLibs, object.Properties.Header_libs...)
 	deps.ObjFiles = append(deps.ObjFiles, object.Properties.Objs...)
 	return deps
 }

 func (object *objectLinker) linkerFlags(ctx ModuleContext, flags Flags) Flags {
 	flags.Global.LdFlags = append(flags.Global.LdFlags, ctx.toolchain().ToolchainClangLdflags())

 	if lds := android.OptionalPathForModuleSrc(ctx, object.Properties.Linker_script); lds.Valid() {
 		flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-T,"+lds.String())
 		flags.LdFlagsDeps = append(flags.LdFlagsDeps, lds.Path())
 	}
 	return flags
 }

 func (object *objectLinker) link(ctx ModuleContext,
 	flags Flags, deps PathDeps, objs Objects) android.Path {

 	objs = objs.Append(deps.Objs)

 	var outputFile android.Path
 	builderFlags := flagsToBuilderFlags(flags)

 	if len(objs.objFiles) == 1 && String(object.Properties.Linker_script) == "" {
 		outputFile = objs.objFiles[0]

 		if String(object.Properties.Prefix_symbols) != "" {
 			output := android.PathForModuleOut(ctx, ctx.ModuleName()+objectExtension)
 			transformBinaryPrefixSymbols(ctx, String(object.Properties.Prefix_symbols), outputFile,
 				builderFlags, output)
 			outputFile = output
 		}
 	} else {
 		output := android.PathForModuleOut(ctx, ctx.ModuleName()+objectExtension)
 		outputFile = output

 		if String(object.Properties.Prefix_symbols) != "" {
 			input := android.PathForModuleOut(ctx, "unprefixed", ctx.ModuleName()+objectExtension)
 			transformBinaryPrefixSymbols(ctx, String(object.Properties.Prefix_symbols), input,
 				builderFlags, output)
 			output = input
 		}

 		transformObjsToObj(ctx, objs.objFiles, builderFlags, output, flags.LdFlagsDeps)
 	}

 	ctx.CheckbuildFile(outputFile)
 	return outputFile
 }

 func (object *objectLinker) unstrippedOutputFilePath() android.Path {
 	return nil
 }

 func (object *objectLinker) nativeCoverage() bool {
 	return true
 }

 func (object *objectLinker) coverageOutputFilePath() android.OptionalPath {
 	return android.OptionalPath{}
 }

 func (object *objectLinker) object() bool {
 	return true
 }

 func (object *objectLinker) isCrt() bool {
 	return Bool(object.Properties.Crt)
 }
	// Copyright 2016 Google Inc. All rights reserved.
	//
	// 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.

	package cc

	import (
	"fmt"

	"android/soong/android"
	"android/soong/bazel"
	)

	//
	// Objects (for crt*.o)
	//

	func init() {
	android.RegisterModuleType("cc_object", ObjectFactory)
	android.RegisterSdkMemberType(ccObjectSdkMemberType)

	android.RegisterBp2BuildMutator("cc_object", ObjectBp2Build)
	}

	var ccObjectSdkMemberType = &librarySdkMemberType{
	SdkMemberTypeBase: android.SdkMemberTypeBase{
	PropertyName: "native_objects",
	SupportsSdk: true,
	},
	prebuiltModuleType: "cc_prebuilt_object",
	linkTypes: nil,
	}

	type objectLinker struct {
	*baseLinker
	Properties ObjectLinkerProperties
	}

	type objectBazelHandler struct {
	bazelHandler

	module *Module
	}

	func (handler *objectBazelHandler) generateBazelBuildActions(ctx android.ModuleContext, label string) bool {
	bazelCtx := ctx.Config().BazelContext
	objPaths, ok := bazelCtx.GetOutputFiles(label, ctx.Arch().ArchType)
	if ok {
	if len(objPaths) != 1 {
	ctx.ModuleErrorf("expected exactly one object file for '%s', but got %s", label, objPaths)
	return false
	}

	handler.module.outputFile = android.OptionalPathForPath(android.PathForBazelOut(ctx, objPaths[0]))
	}
	return ok
	}

	type ObjectLinkerProperties struct {
	// list of modules that should only provide headers for this module.
	Header_libs []string `android:"arch_variant,variant_prepend"`

	// names of other cc_object modules to link into this module using partial linking
	Objs []string `android:"arch_variant"`

	// if set, add an extra objcopy --prefix-symbols= step
	Prefix_symbols *string

	// if set, the path to a linker script to pass to ld -r when combining multiple object files.
	Linker_script *string `android:"path,arch_variant"`

	// Indicates that this module is a CRT object. CRT objects will be split
	// into a variant per-API level between min_sdk_version and current.
	Crt *bool
	}

	func newObject() *Module {
	module := newBaseModule(android.HostAndDeviceSupported, android.MultilibBoth)
	module.sanitize = &sanitize{}
	module.stl = &stl{}
	return module
	}

	// cc_object runs the compiler without running the linker. It is rarely
	// necessary, but sometimes used to generate .s files from .c files to use as
	// input to a cc_genrule module.
	func ObjectFactory() android.Module {
	module := newObject()
	module.linker = &objectLinker{
	baseLinker: NewBaseLinker(module.sanitize),
	}
	module.compiler = NewBaseCompiler()
	module.bazelHandler = &objectBazelHandler{module: module}

	// Clang's address-significance tables are incompatible with ld -r.
	module.compiler.appendCflags([]string{"-fno-addrsig"})

	module.sdkMemberTypes = []android.SdkMemberType{ccObjectSdkMemberType}

	return module.Init()
	}

	// For bp2build conversion.
	type bazelObjectAttributes struct {
	Srcs bazel.LabelListAttribute
	Hdrs bazel.LabelListAttribute
	Deps bazel.LabelListAttribute
	Copts bazel.StringListAttribute
	Asflags []string
	Local_include_dirs []string
	}

	type bazelObject struct {
	android.BazelTargetModuleBase
	bazelObjectAttributes
	}

	func (m *bazelObject) Name() string {
	return m.BaseModuleName()
	}

	func (m *bazelObject) GenerateAndroidBuildActions(ctx android.ModuleContext) {}

	func BazelObjectFactory() android.Module {
	module := &bazelObject{}
	module.AddProperties(&module.bazelObjectAttributes)
	android.InitBazelTargetModule(module)
	return module
	}

	// ObjectBp2Build is the bp2build converter from cc_object modules to the
	// Bazel equivalent target, plus any necessary include deps for the cc_object.
	func ObjectBp2Build(ctx android.TopDownMutatorContext) {
	m, ok := ctx.Module().(*Module)
	if !ok \|\| !m.ConvertWithBp2build(ctx) {
	return
	}

	// a Module can be something other than a cc_object.
	if ctx.ModuleType() != "cc_object" {
	return
	}

	if m.compiler == nil {
	// a cc_object must have access to the compiler decorator for its props.
	ctx.ModuleErrorf("compiler must not be nil for a cc_object module")
	}

	// Set arch-specific configurable attributes
	compilerAttrs := bp2BuildParseCompilerProps(ctx, m)
	var localIncludeDirs []string
	var asFlags []string
	for _, props := range m.compiler.compilerProps() {
	if baseCompilerProps, ok := props.(*BaseCompilerProperties); ok {
	localIncludeDirs = baseCompilerProps.Local_include_dirs
	break
	}
	}

	if c, ok := m.compiler.(*baseCompiler); ok && c.includeBuildDirectory() {
	localIncludeDirs = append(localIncludeDirs, ".")
	}

	var deps bazel.LabelListAttribute
	for _, props := range m.linker.linkerProps() {
	if objectLinkerProps, ok := props.(*ObjectLinkerProperties); ok {
	deps = bazel.MakeLabelListAttribute(
	android.BazelLabelForModuleDeps(ctx, objectLinkerProps.Objs))
	}
	}

	productVariableProps := android.ProductVariableProperties(ctx)
	if props, exists := productVariableProps["Asflags"]; exists {
	// TODO(b/183595873): consider deduplicating handling of product variable properties
	for _, prop := range props {
	flags, ok := prop.Property.([]string)
	if !ok {
	ctx.ModuleErrorf("Could not convert product variable asflag property")
	return
	}
	// TODO(b/183595873) handle other product variable usages -- as selects?
	if newFlags, subbed := bazel.TryVariableSubstitutions(flags, prop.ProductConfigVariable); subbed {
	asFlags = append(asFlags, newFlags...)
	}
	}
	}
	// TODO(b/183595872) warn/error if we're not handling product variables

	attrs := &bazelObjectAttributes{
	Srcs: compilerAttrs.srcs,
	Hdrs: compilerAttrs.hdrs,
	Deps: deps,
	Copts: compilerAttrs.copts,
	Asflags: asFlags,
	Local_include_dirs: localIncludeDirs,
	}

	props := bazel.BazelTargetModuleProperties{
	Rule_class: "cc_object",
	Bzl_load_location: "//build/bazel/rules:cc_object.bzl",
	}

	ctx.CreateBazelTargetModule(BazelObjectFactory, m.Name(), props, attrs)
	}

	func (object *objectLinker) appendLdflags(flags []string) {
	panic(fmt.Errorf("appendLdflags on objectLinker not supported"))
	}

	func (object *objectLinker) linkerProps() []interface{} {
	return []interface{}{&object.Properties}
	}

	func (*objectLinker) linkerInit(ctx BaseModuleContext) {}

	func (object *objectLinker) linkerDeps(ctx DepsContext, deps Deps) Deps {
	deps.HeaderLibs = append(deps.HeaderLibs, object.Properties.Header_libs...)
	deps.ObjFiles = append(deps.ObjFiles, object.Properties.Objs...)
	return deps
	}

	func (object *objectLinker) linkerFlags(ctx ModuleContext, flags Flags) Flags {
	flags.Global.LdFlags = append(flags.Global.LdFlags, ctx.toolchain().ToolchainClangLdflags())

	if lds := android.OptionalPathForModuleSrc(ctx, object.Properties.Linker_script); lds.Valid() {
	flags.Local.LdFlags = append(flags.Local.LdFlags, "-Wl,-T,"+lds.String())
	flags.LdFlagsDeps = append(flags.LdFlagsDeps, lds.Path())
	}
	return flags
	}

	func (object *objectLinker) link(ctx ModuleContext,
	flags Flags, deps PathDeps, objs Objects) android.Path {

	objs = objs.Append(deps.Objs)

	var outputFile android.Path
	builderFlags := flagsToBuilderFlags(flags)

	if len(objs.objFiles) == 1 && String(object.Properties.Linker_script) == "" {
	outputFile = objs.objFiles[0]

	if String(object.Properties.Prefix_symbols) != "" {
	output := android.PathForModuleOut(ctx, ctx.ModuleName()+objectExtension)
	transformBinaryPrefixSymbols(ctx, String(object.Properties.Prefix_symbols), outputFile,
	builderFlags, output)
	outputFile = output
	}
	} else {
	output := android.PathForModuleOut(ctx, ctx.ModuleName()+objectExtension)
	outputFile = output

	if String(object.Properties.Prefix_symbols) != "" {
	input := android.PathForModuleOut(ctx, "unprefixed", ctx.ModuleName()+objectExtension)
	transformBinaryPrefixSymbols(ctx, String(object.Properties.Prefix_symbols), input,
	builderFlags, output)
	output = input
	}

	transformObjsToObj(ctx, objs.objFiles, builderFlags, output, flags.LdFlagsDeps)
	}

	ctx.CheckbuildFile(outputFile)
	return outputFile
	}

	func (object *objectLinker) unstrippedOutputFilePath() android.Path {
	return nil
	}

	func (object *objectLinker) nativeCoverage() bool {
	return true
	}

	func (object *objectLinker) coverageOutputFilePath() android.OptionalPath {
	return android.OptionalPath{}
	}

	func (object *objectLinker) object() bool {
	return true
	}

	func (object *objectLinker) isCrt() bool {
	return Bool(object.Properties.Crt)
	}