Move cc.imageMutator into the android package (7228ecd5) · Commits · e / os / android_build_soong

Android.bp

+1 −0

Original line number	Diff line number	Diff line
		@@ -51,6 +51,7 @@ bootstrap_go_package {
		"android/expand.go",
		"android/filegroup.go",
		"android/hooks.go",
		"android/image.go",
		"android/makevars.go",
		"android/module.go",
		"android/mutator.go",

android/image.go

0 → 100644

+83 −0

Original line number	Diff line number	Diff line
		// Copyright 2019 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 android

		// ImageInterface is implemented by modules that need to be split by the ImageMutator.
		type ImageInterface interface {
		// ImageMutatorBegin is called before any other method in the ImageInterface.
		ImageMutatorBegin(ctx BaseModuleContext)

		// CoreVariantNeeded should return true if the module needs a core variant (installed on the system image).
		CoreVariantNeeded(ctx BaseModuleContext) bool

		// RecoveryVariantNeeded should return true if the module needs a recovery variant (installed on the
		// recovery partition).
		RecoveryVariantNeeded(ctx BaseModuleContext) bool

		// ExtraImageVariations should return a list of the additional variations needed for the module. After the
		// variants are created the SetImageVariation method will be called on each newly created variant with the
		// its variation.
		ExtraImageVariations(ctx BaseModuleContext) []string

		// SetImageVariation will be passed a newly created recovery variant of the module. ModuleBase implements
		// SetImageVariation, most module types will not need to override it, and those that do must call the
		// overridden method. Implementors of SetImageVariation must be careful to modify the module argument
		// and not the receiver.
		SetImageVariation(ctx BaseModuleContext, variation string, module Module)
		}

		const (
		// CoreVariation is the variant used for framework-private libraries, or
		// SDK libraries. (which framework-private libraries can use), which
		// will be installed to the system image.
		CoreVariation string = "core"

		// RecoveryVariation means a module to be installed to recovery image.
		RecoveryVariation string = "recovery"
		)

		// ImageMutator creates variants for modules that implement the ImageInterface that
		// allow them to build differently for each partition (recovery, core, vendor, etc.).
		func ImageMutator(ctx BottomUpMutatorContext) {
		if ctx.Os() != Android {
		return
		}

		if m, ok := ctx.Module().(ImageInterface); ok {
		m.ImageMutatorBegin(ctx)

		var variations []string

		if m.CoreVariantNeeded(ctx) {
		variations = append(variations, CoreVariation)
		}
		if m.RecoveryVariantNeeded(ctx) {
		variations = append(variations, RecoveryVariation)
		}

		extraVariations := m.ExtraImageVariations(ctx)
		variations = append(variations, extraVariations...)

		if len(variations) == 0 {
		return
		}

		mod := ctx.CreateVariations(variations...)
		for i, v := range variations {
		mod[i].base().setImageVariation(v)
		m.SetImageVariation(ctx, v, mod[i])
		}
		}
		}

android/module.go

+18 −0

Original line number	Diff line number	Diff line
		@@ -431,6 +431,9 @@ type commonProperties struct {
		DebugName string `blueprint:"mutated"`
		DebugMutators []string `blueprint:"mutated"`
		DebugVariations []string `blueprint:"mutated"`

		// set by ImageMutator
		ImageVariation string `blueprint:"mutated"`
		}

		type hostAndDeviceProperties struct {
		@@ -865,6 +868,21 @@ func (m *ModuleBase) NoticeFile() OptionalPath {
		return m.noticeFile
		}

		func (m *ModuleBase) setImageVariation(variant string) {
		m.commonProperties.ImageVariation = variant
		}

		func (m *ModuleBase) ImageVariation() blueprint.Variation {
		return blueprint.Variation{
		Mutator: "image",
		Variation: m.base().commonProperties.ImageVariation,
		}
		}

		func (m *ModuleBase) InRecovery() bool {
		return m.base().commonProperties.ImageVariation == RecoveryVariation
		}

		func (m *ModuleBase) generateModuleTarget(ctx ModuleContext) {
		allInstalledFiles := Paths{}
		allCheckbuildFiles := Paths{}

android/prebuilt_etc.go

+20 −50

Original line number	Diff line number	Diff line
		@@ -25,10 +25,6 @@ func init() {
		RegisterModuleType("prebuilt_usr_share_host", PrebuiltUserShareHostFactory)
		RegisterModuleType("prebuilt_font", PrebuiltFontFactory)
		RegisterModuleType("prebuilt_firmware", PrebuiltFirmwareFactory)

		PreDepsMutators(func(ctx RegisterMutatorsContext) {
		ctx.BottomUp("prebuilt_etc", prebuiltEtcMutator).Parallel()
		})
		}

		type prebuiltEtcProperties struct {
		@@ -48,8 +44,6 @@ type prebuiltEtcProperties struct {
		// Make this module available when building for recovery.
		Recovery_available *bool

		InRecovery bool `blueprint:"mutated"`

		// Whether this module is directly installable to one of the partitions. Default: true.
		Installable *bool
		}
		@@ -76,7 +70,7 @@ type PrebuiltEtc struct {
		}

		func (p *PrebuiltEtc) inRecovery() bool {
		return p.properties.InRecovery \|\| p.ModuleBase.InstallInRecovery()
		return p.ModuleBase.InRecovery() \|\| p.ModuleBase.InstallInRecovery()
		}

		func (p *PrebuiltEtc) onlyInRecovery() bool {
		@@ -87,6 +81,25 @@ func (p *PrebuiltEtc) InstallInRecovery() bool {
		return p.inRecovery()
		}

		var _ ImageInterface = (*PrebuiltEtc)(nil)

		func (p *PrebuiltEtc) ImageMutatorBegin(ctx BaseModuleContext) {}

		func (p *PrebuiltEtc) CoreVariantNeeded(ctx BaseModuleContext) bool {
		return !p.ModuleBase.InstallInRecovery()
		}

		func (p *PrebuiltEtc) RecoveryVariantNeeded(ctx BaseModuleContext) bool {
		return Bool(p.properties.Recovery_available) \|\| p.ModuleBase.InstallInRecovery()
		}

		func (p *PrebuiltEtc) ExtraImageVariations(ctx BaseModuleContext) []string {
		return nil
		}

		func (p *PrebuiltEtc) SetImageVariation(ctx BaseModuleContext, variation string, module Module) {
		}

		func (p *PrebuiltEtc) DepsMutator(ctx BottomUpMutatorContext) {
		if p.properties.Src == nil {
		ctx.PropertyErrorf("src", "missing prebuilt source file")
		@@ -222,49 +235,6 @@ func PrebuiltUserShareHostFactory() Module {
		return module
		}

		const (
		// coreMode is the variant for modules to be installed to system.
		coreMode = "core"

		// recoveryMode means a module to be installed to recovery image.
		recoveryMode = "recovery"
		)

		// prebuiltEtcMutator creates the needed variants to install the module to
		// system or recovery.
		func prebuiltEtcMutator(mctx BottomUpMutatorContext) {
		m, ok := mctx.Module().(*PrebuiltEtc)
		if !ok \|\| m.Host() {
		return
		}

		var coreVariantNeeded bool = true
		var recoveryVariantNeeded bool = false
		if Bool(m.properties.Recovery_available) {
		recoveryVariantNeeded = true
		}

		if m.ModuleBase.InstallInRecovery() {
		recoveryVariantNeeded = true
		coreVariantNeeded = false
		}

		var variants []string
		if coreVariantNeeded {
		variants = append(variants, coreMode)
		}
		if recoveryVariantNeeded {
		variants = append(variants, recoveryMode)
		}
		mod := mctx.CreateVariations(variants...)
		for i, v := range variants {
		if v == recoveryMode {
		m := mod[i].(*PrebuiltEtc)
		m.properties.InRecovery = true
		}
		}
		}

		// prebuilt_font installs a font in <partition>/fonts directory.
		func PrebuiltFontFactory() Module {
		module := &PrebuiltEtc{}

android/prebuilt_etc_test.go

+1 −1

Original line number	Diff line number	Diff line
		@@ -30,7 +30,7 @@ func testPrebuiltEtc(t testing.T, bp string) (TestContext, Config) {
		ctx.RegisterModuleType("prebuilt_font", ModuleFactoryAdaptor(PrebuiltFontFactory))
		ctx.RegisterModuleType("prebuilt_firmware", ModuleFactoryAdaptor(PrebuiltFirmwareFactory))
		ctx.PreDepsMutators(func(ctx RegisterMutatorsContext) {
		ctx.BottomUp("prebuilt_etc", prebuiltEtcMutator).Parallel()
		ctx.BottomUp("prebuilt_etc", ImageMutator).Parallel()
		})
		ctx.Register()
		mockFiles := map[string][]byte{