Support multilib properties in bp2build (c424b76f) · Commits · e / os / android_build_soong

android/arch.go

+146 −70

Original line number	Diff line number	Diff line
		@@ -1673,65 +1673,37 @@ func decodeMultilibTargets(multilib string, targets []Target, prefer32 bool) ([]
		return buildTargets, nil
		}

		// GetArchProperties returns a map of architectures to the values of the
		// properties of the 'dst' struct that are specific to that architecture.
		//
		// For example, passing a struct { Foo bool, Bar string } will return an
		// interface{} that can be type asserted back into the same struct, containing
		// the arch specific property value specified by the module if defined.
		func (m *ModuleBase) GetArchProperties(dst interface{}) map[ArchType]interface{} {
		// Return value of the arch types to the prop values for that arch.
		archToProp := map[ArchType]interface{}{}

		// Nothing to do for non-arch-specific modules.
		if !m.ArchSpecific() {
		return archToProp
		}

		// archProperties has the type of [][]interface{}. Looks complicated, so let's
		// explain this step by step.
		//
		// Loop over the outer index, which determines the property struct that
		// contains a matching set of properties in dst that we're interested in.
		// For example, BaseCompilerProperties or BaseLinkerProperties.
		func (m *ModuleBase) getArchPropertySet(propertySet interface{}, archType ArchType) interface{} {
		archString := archType.Field
		for i := range m.archProperties {
		if m.archProperties[i] == nil {
		// Skip over nil arch props
		// Skip over nil properties
		continue
		}

		// Non-nil arch prop, let's see if the props match up.
		for _, arch := range ArchTypeList() {
		// e.g X86, Arm
		field := arch.Field

		// If it's not nil, loop over the inner index, which determines the arch variant
		// of the prop type. In an Android.bp file, this is like looping over:
		//
		// arch: { arm: { key: value, ... }, x86: { key: value, ... } }
		for _, archProperties := range m.archProperties[i] {
		archPropValues := reflect.ValueOf(archProperties).Elem()
		// Not archProperties are usable; this function looks for properties of a very specific
		// form, and ignores the rest.
		for _, archProperty := range m.archProperties[i] {
		// archPropValue is a property struct, we are looking for the form:
		// `arch: { arm: { key: value, ... }}`
		archPropValue := reflect.ValueOf(archProperty).Elem()

		// This is the archPropRoot struct. Traverse into the Arch nested struct.
		src := archPropValues.FieldByName("Arch").Elem()
		// Unwrap src so that it should looks like a pointer to `arm: { key: value, ... }`
		src := archPropValue.FieldByName("Arch").Elem()

		// Step into non-nil pointers to structs in the src value.
		if src.Kind() == reflect.Ptr {
		if src.IsNil() {
		// Ignore nil pointers.
		continue
		}
		src = src.Elem()
		}

		// Find the requested field (e.g. x86, x86_64) in the src struct.
		src = src.FieldByName(field)
		if !src.IsValid() {
		continue
		}
		// Find the requested field (e.g. arm, x86) in the src struct.
		src = src.FieldByName(archString)

		// We only care about structs. These are not the droids you are looking for.
		if src.Kind() != reflect.Struct {
		// We only care about structs.
		if !src.IsValid() \|\| src.Kind() != reflect.Struct {
		continue
		}

		@@ -1747,22 +1719,126 @@ func (m *ModuleBase) GetArchProperties(dst interface{}) map[ArchType]interface{}
		src = src.FieldByName("BlueprintEmbed")

		// Clone the destination prop, since we want a unique prop struct per arch.
		dstClone := reflect.New(reflect.ValueOf(dst).Elem().Type()).Interface()
		propertySetClone := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()

		// Copy the located property struct into the cloned destination property struct.
		err := proptools.ExtendMatchingProperties([]interface{}{dstClone}, src.Interface(), nil, proptools.OrderReplace)
		err := proptools.ExtendMatchingProperties([]interface{}{propertySetClone}, src.Interface(), nil, proptools.OrderReplace)
		if err != nil {
		// This is fine, it just means the src struct doesn't match the type of propertySet.
		continue
		}

		return propertySetClone
		}
		}
		// No property set was found specific to the given arch, so return an empty
		// property set.
		return reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
		}

		// getMultilibPropertySet returns a property set struct matching the type of
		// `propertySet`, containing multilib-specific module properties for the given architecture.
		// If no multilib-specific properties exist for the given architecture, returns an empty property
		// set matching `propertySet`'s type.
		func (m *ModuleBase) getMultilibPropertySet(propertySet interface{}, archType ArchType) interface{} {
		// archType.Multilib is lowercase (for example, lib32) but property struct field is
		// capitalized, such as Lib32, so use strings.Title to capitalize it.
		multiLibString := strings.Title(archType.Multilib)

		for i := range m.archProperties {
		if m.archProperties[i] == nil {
		// Skip over nil properties
		continue
		}

		// Not archProperties are usable; this function looks for properties of a very specific
		// form, and ignores the rest.
		for _, archProperties := range m.archProperties[i] {
		// archPropValue is a property struct, we are looking for the form:
		// `multilib: { lib32: { key: value, ... }}`
		archPropValue := reflect.ValueOf(archProperties).Elem()

		// Unwrap src so that it should looks like a pointer to `lib32: { key: value, ... }`
		src := archPropValue.FieldByName("Multilib").Elem()

		// Step into non-nil pointers to structs in the src value.
		if src.Kind() == reflect.Ptr {
		if src.IsNil() {
		// Ignore nil pointers.
		continue
		}
		src = src.Elem()
		}

		// Find the requested field (e.g. lib32) in the src struct.
		src = src.FieldByName(multiLibString)

		// We only care about valid struct pointers.
		if !src.IsValid() \|\| src.Kind() != reflect.Ptr \|\| src.Elem().Kind() != reflect.Struct {
		continue
		}

		// Get the zero value for the requested property set.
		propertySetClone := reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()

		// Copy the located property struct into the "zero" property set struct.
		err := proptools.ExtendMatchingProperties([]interface{}{propertySetClone}, src.Interface(), nil, proptools.OrderReplace)

		if err != nil {
		// This is fine, it just means the src struct doesn't match.
		continue
		}

		// Found the prop for the arch, you have.
		archToProp[arch] = dstClone
		return propertySetClone
		}
		}

		// Go to the next prop.
		break
		// There were no multilib properties specifically matching the given archtype.
		// Return zeroed value.
		return reflect.New(reflect.ValueOf(propertySet).Elem().Type()).Interface()
		}

		// GetArchProperties returns a map of architectures to the values of the
		// properties of the 'propertySet' struct that are specific to that architecture.
		//
		// For example, passing a struct { Foo bool, Bar string } will return an
		// interface{} that can be type asserted back into the same struct, containing
		// the arch specific property value specified by the module if defined.
		//
		// Arch-specific properties may come from an arch stanza or a multilib stanza; properties
		// in these stanzas are combined.
		// For example: `arch: { x86: { Foo: ["bar"] } }, multilib: { lib32: {` Foo: ["baz"] } }`
		// will result in `Foo: ["bar", "baz"]` being returned for architecture x86, if the given
		// propertyset contains `Foo []string`.
		func (m *ModuleBase) GetArchProperties(propertySet interface{}) map[ArchType]interface{} {
		// Return value of the arch types to the prop values for that arch.
		archToProp := map[ArchType]interface{}{}

		// Nothing to do for non-arch-specific modules.
		if !m.ArchSpecific() {
		return archToProp
		}

		// For each arch (x86, arm64, etc.),
		for _, arch := range ArchTypeList() {
		// Find arch-specific properties matching that property set type. For example, any
		// matching properties under `arch { x86 { ... } }`.
		archPropertySet := m.getArchPropertySet(propertySet, arch)

		// Find multilib-specific properties matching that property set type. For example, any
		// matching properties under `multilib { lib32 { ... } }` for x86, as x86 is 32-bit.
		multilibPropertySet := m.getMultilibPropertySet(propertySet, arch)

		// Append the multilibPropertySet to archPropertySet. This combines the
		// arch and multilib properties into a single property struct.
		err := proptools.ExtendMatchingProperties([]interface{}{archPropertySet}, multilibPropertySet, nil, proptools.OrderAppend)
		if err != nil {
		// archPropertySet and multilibPropertySet must be of the same type, or
		// something horrible went wrong.
		panic(err)
		}

		archToProp[arch] = archPropertySet
		}
		return archToProp
		}

android/bazel.go

+0 −1

Original line number	Diff line number	Diff line
		@@ -272,7 +272,6 @@ var (
		// Per-module denylist to opt modules out of mixed builds. Such modules will
		// still be generated via bp2build.
		mixedBuildsDisabledList = []string{
		"libc_gdtoa", // ruperts@, cc_library_static, OK for bp2build but undefined symbol: __strtorQ for mixed builds
		"libc_netbsd", // lberki@, cc_library_static, version script assignment of 'LIBC_PRIVATE' to symbol 'SHA1Final' failed: symbol not defined
		"libc_openbsd", // ruperts@, cc_library_static, OK for bp2build but error: duplicate symbol: strcpy for mixed builds
		"libsystemproperties", // cparsons@, cc_library_static, wrong include paths

bp2build/cc_library_static_conversion_test.go

+166 −0

Original line number	Diff line number	Diff line
		@@ -744,6 +744,172 @@ cc_library_static {
		name = "static_dep",
		copts = ["-I."],
		linkstatic = True,
		)`},
		},
		{
		description: "cc_library_static 1 multilib srcs and exclude_srcs",
		moduleTypeUnderTest: "cc_library_static",
		moduleTypeUnderTestFactory: cc.LibraryStaticFactory,
		moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryStaticBp2Build,
		depsMutators: []android.RegisterMutatorFunc{cc.RegisterDepsBp2Build},
		filesystem: map[string]string{
		"common.c": "",
		"for-lib32.c": "",
		"not-for-lib32.c": "",
		},
		bp: soongCcLibraryStaticPreamble + `
		cc_library_static {
		name: "foo_static",
		srcs: ["common.c", "not-for-*.c"],
		multilib: {
		lib32: { srcs: ["for-lib32.c"], exclude_srcs: ["not-for-lib32.c"] },
		},
		} `,
		expectedBazelTargets: []string{`cc_library_static(
		name = "foo_static",
		copts = ["-I."],
		linkstatic = True,
		srcs = ["common.c"] + select({
		"//build/bazel/platforms/arch:arm": ["for-lib32.c"],
		"//build/bazel/platforms/arch:x86": ["for-lib32.c"],
		"//conditions:default": ["not-for-lib32.c"],
		}),
		)`},
		},
		{
		description: "cc_library_static 2 multilib srcs and exclude_srcs",
		moduleTypeUnderTest: "cc_library_static",
		moduleTypeUnderTestFactory: cc.LibraryStaticFactory,
		moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryStaticBp2Build,
		depsMutators: []android.RegisterMutatorFunc{cc.RegisterDepsBp2Build},
		filesystem: map[string]string{
		"common.c": "",
		"for-lib32.c": "",
		"for-lib64.c": "",
		"not-for-lib32.c": "",
		"not-for-lib64.c": "",
		},
		bp: soongCcLibraryStaticPreamble + `
		cc_library_static {
		name: "foo_static2",
		srcs: ["common.c", "not-for-*.c"],
		multilib: {
		lib32: { srcs: ["for-lib32.c"], exclude_srcs: ["not-for-lib32.c"] },
		lib64: { srcs: ["for-lib64.c"], exclude_srcs: ["not-for-lib64.c"] },
		},
		} `,
		expectedBazelTargets: []string{`cc_library_static(
		name = "foo_static2",
		copts = ["-I."],
		linkstatic = True,
		srcs = ["common.c"] + select({
		"//build/bazel/platforms/arch:arm": [
		"for-lib32.c",
		"not-for-lib64.c",
		],
		"//build/bazel/platforms/arch:arm64": [
		"for-lib64.c",
		"not-for-lib32.c",
		],
		"//build/bazel/platforms/arch:x86": [
		"for-lib32.c",
		"not-for-lib64.c",
		],
		"//build/bazel/platforms/arch:x86_64": [
		"for-lib64.c",
		"not-for-lib32.c",
		],
		"//conditions:default": [
		"not-for-lib32.c",
		"not-for-lib64.c",
		],
		}),
		)`},
		},
		{
		description: "cc_library_static arch and multilib srcs and exclude_srcs",
		moduleTypeUnderTest: "cc_library_static",
		moduleTypeUnderTestFactory: cc.LibraryStaticFactory,
		moduleTypeUnderTestBp2BuildMutator: cc.CcLibraryStaticBp2Build,
		depsMutators: []android.RegisterMutatorFunc{cc.RegisterDepsBp2Build},
		filesystem: map[string]string{
		"common.c": "",
		"for-arm.c": "",
		"for-arm64.c": "",
		"for-x86.c": "",
		"for-x86_64.c": "",
		"for-lib32.c": "",
		"for-lib64.c": "",
		"not-for-arm.c": "",
		"not-for-arm64.c": "",
		"not-for-x86.c": "",
		"not-for-x86_64.c": "",
		"not-for-lib32.c": "",
		"not-for-lib64.c": "",
		"not-for-everything.c": "",
		},
		bp: soongCcLibraryStaticPreamble + `
		cc_library_static {
		name: "foo_static3",
		srcs: ["common.c", "not-for-*.c"],
		exclude_srcs: ["not-for-everything.c"],
		arch: {
		arm: { srcs: ["for-arm.c"], exclude_srcs: ["not-for-arm.c"] },
		arm64: { srcs: ["for-arm64.c"], exclude_srcs: ["not-for-arm64.c"] },
		x86: { srcs: ["for-x86.c"], exclude_srcs: ["not-for-x86.c"] },
		x86_64: { srcs: ["for-x86_64.c"], exclude_srcs: ["not-for-x86_64.c"] },
		},
		multilib: {
		lib32: { srcs: ["for-lib32.c"], exclude_srcs: ["not-for-lib32.c"] },
		lib64: { srcs: ["for-lib64.c"], exclude_srcs: ["not-for-lib64.c"] },
		},
		}`,
		expectedBazelTargets: []string{`cc_library_static(
		name = "foo_static3",
		copts = ["-I."],
		linkstatic = True,
		srcs = ["common.c"] + select({
		"//build/bazel/platforms/arch:arm": [
		"for-arm.c",
		"for-lib32.c",
		"not-for-arm64.c",
		"not-for-lib64.c",
		"not-for-x86.c",
		"not-for-x86_64.c",
		],
		"//build/bazel/platforms/arch:arm64": [
		"for-arm64.c",
		"for-lib64.c",
		"not-for-arm.c",
		"not-for-lib32.c",
		"not-for-x86.c",
		"not-for-x86_64.c",
		],
		"//build/bazel/platforms/arch:x86": [
		"for-lib32.c",
		"for-x86.c",
		"not-for-arm.c",
		"not-for-arm64.c",
		"not-for-lib64.c",
		"not-for-x86_64.c",
		],
		"//build/bazel/platforms/arch:x86_64": [
		"for-lib64.c",
		"for-x86_64.c",
		"not-for-arm.c",
		"not-for-arm64.c",
		"not-for-lib32.c",
		"not-for-x86.c",
		],
		"//conditions:default": [
		"not-for-arm.c",
		"not-for-arm64.c",
		"not-for-lib32.c",
		"not-for-lib64.c",
		"not-for-x86.c",
		"not-for-x86_64.c",
		],
		}),
		)`},
		},
		}