Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 03f6f4ea authored by Treehugger Robot's avatar Treehugger Robot Committed by Gerrit Code Review
Browse files

Merge "Introduce soong_filesystem_creator module type" into main

parents 76e6a927 98047cfd

filesystem/filesystem.go

+3 −3
Original line number Diff line number Diff line
@@ -37,7 +37,7 @@ func init() { 
func registerBuildComponents(ctx android.RegistrationContext) {

	ctx.RegisterModuleType("android_filesystem", filesystemFactory)

	ctx.RegisterModuleType("android_filesystem_defaults", filesystemDefaultsFactory)

	ctx.RegisterModuleType("android_system_image", systemImageFactory)

	ctx.RegisterModuleType("android_system_image", SystemImageFactory)

	ctx.RegisterModuleType("avb_add_hash_footer", avbAddHashFooterFactory)

	ctx.RegisterModuleType("avb_add_hash_footer_defaults", avbAddHashFooterDefaultsFactory)

	ctx.RegisterModuleType("avb_gen_vbmeta_image", avbGenVbmetaImageFactory)
@@ -49,7 +49,7 @@ type filesystem struct { 
	android.PackagingBase

	android.DefaultableModuleBase



	properties filesystemProperties

	properties FilesystemProperties



	// Function that builds extra files under the root directory and returns the files

	buildExtraFiles func(ctx android.ModuleContext, root android.OutputPath) android.OutputPaths
@@ -71,7 +71,7 @@ type symlinkDefinition struct { 
	Name   *string

}



type filesystemProperties struct {

type FilesystemProperties struct {

	// When set to true, sign the image with avbtool. Default is false.

	Use_avb *bool

filesystem/system_image.go

+5 −1
Original line number Diff line number Diff line
@@ -33,7 +33,7 @@ type systemImageProperties struct { 
// android_system_image is a specialization of android_filesystem for the 'system' partition.

// Currently, the only difference is the inclusion of linker.config.pb file which specifies

// the provided and the required libraries to and from APEXes.

func systemImageFactory() android.Module {

func SystemImageFactory() android.Module {

	module := &systemImage{}

	module.AddProperties(&module.properties)

	module.filesystem.buildExtraFiles = module.buildExtraFiles
@@ -42,6 +42,10 @@ func systemImageFactory() android.Module { 
	return module

}



func (s systemImage) FsProps() FilesystemProperties {

	return s.filesystem.properties

}



func (s *systemImage) buildExtraFiles(ctx android.ModuleContext, root android.OutputPath) android.OutputPaths {

	if s.filesystem.properties.Partition_type != nil {

		ctx.PropertyErrorf("partition_type", "partition_type must be unset on an android_system_image module. It is assumed to be 'system'.")

fsgen/Android.bp

0 → 100644
+21 −0
Original line number Diff line number Diff line 
package {

    default_applicable_licenses: ["Android-Apache-2.0"],

}



bootstrap_go_package {

    name: "soong-fsgen",

    pkgPath: "android/soong/fsgen",

    deps: [

        "blueprint",

        "soong",

        "soong-android",

        "soong-filesystem",

    ],

    srcs: [

        "filesystem_creator.go",

    ],

    testSrcs: [

        "filesystem_creator_test.go",

    ],

    pluginFor: ["soong_build"],

}

fsgen/filesystem_creator.go

0 → 100644
+111 −0
Original line number Diff line number Diff line 
// Copyright (C) 2024 The Android Open Source Project

//

// 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 fsgen



import (

	"android/soong/android"

	"android/soong/filesystem"

	"fmt"

	"strconv"



	"github.com/google/blueprint/proptools"

)



func init() {

	registerBuildComponents(android.InitRegistrationContext)

}



func registerBuildComponents(ctx android.RegistrationContext) {

	ctx.RegisterModuleType("soong_filesystem_creator", filesystemCreatorFactory)

}



type filesystemCreator struct {

	android.ModuleBase

}



func filesystemCreatorFactory() android.Module {

	module := &filesystemCreator{}



	android.InitAndroidModule(module)

	android.AddLoadHook(module, func(ctx android.LoadHookContext) {

		module.createInternalModules(ctx)

	})



	return module

}



func (f *filesystemCreator) createInternalModules(ctx android.LoadHookContext) {

	f.createSystemImage(ctx)

}



func (f *filesystemCreator) createSystemImage(ctx android.LoadHookContext) {

	baseProps := &struct {

		Name *string

	}{

		Name: proptools.StringPtr(fmt.Sprintf("%s_generated_system_image", ctx.Config().DeviceProduct())),

	}



	fsProps := &(filesystem.FilesystemProperties{})

	partitionVars := ctx.Config().ProductVariables().PartitionVarsForSoongMigrationOnlyDoNotUse

	systemPartitionVars := partitionVars.PartitionQualifiedVariables["system"]



	// BOARD_AVB_ENABLE

	fsProps.Use_avb = proptools.BoolPtr(partitionVars.BoardAvbEnable)

	// BOARD_AVB_KEY_PATH

	fsProps.Avb_private_key = proptools.StringPtr(systemPartitionVars.BoardAvbKeyPath)

	// BOARD_AVB_ALGORITHM

	fsProps.Avb_algorithm = proptools.StringPtr(systemPartitionVars.BoardAvbAlgorithm)

	// BOARD_AVB_SYSTEM_ROLLBACK_INDEX

	if rollbackIndex, err := strconv.ParseInt(systemPartitionVars.BoardAvbRollbackIndex, 10, 64); err == nil {

		fsProps.Rollback_index = proptools.Int64Ptr(rollbackIndex)

	}



	fsProps.Partition_name = proptools.StringPtr("system")

	// BOARD_SYSTEMIMAGE_FILE_SYSTEM_TYPE

	fsProps.Type = proptools.StringPtr(systemPartitionVars.BoardFileSystemType)



	fsProps.Base_dir = proptools.StringPtr("system")



	fsProps.Gen_aconfig_flags_pb = proptools.BoolPtr(true)



	// Identical to that of the generic_system_image

	fsProps.Fsverity.Inputs = []string{

		"etc/boot-image.prof",

		"etc/dirty-image-objects",

		"etc/preloaded-classes",

		"etc/classpaths/*.pb",

		"framework/*",

		"framework/*/*",     // framework/{arch}

		"framework/oat/*/*", // framework/oat/{arch}

	}



	// system_image properties that are not set:

	// - filesystemProperties.Avb_hash_algorithm

	// - filesystemProperties.File_contexts

	// - filesystemProperties.Dirs

	// - filesystemProperties.Symlinks

	// - filesystemProperties.Fake_timestamp

	// - filesystemProperties.Uuid

	// - filesystemProperties.Mount_point

	// - filesystemProperties.Include_make_built_files

	// - filesystemProperties.Build_logtags

	// - filesystemProperties.Fsverity.Libs

	// - systemImageProperties.Linker_config_src

	ctx.CreateModule(filesystem.SystemImageFactory, baseProps, fsProps)

}



func (f *filesystemCreator) GenerateAndroidBuildActions(ctx android.ModuleContext) {



}

fsgen/filesystem_creator_test.go

0 → 100644
+87 −0
Original line number Diff line number Diff line 
// Copyright 2024 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 fsgen



import (

	"android/soong/android"

	"android/soong/filesystem"

	"testing"



	"github.com/google/blueprint/proptools"

)



var prepareForTestWithFsgenBuildComponents = android.FixtureRegisterWithContext(registerBuildComponents)



func TestFileSystemCreatorSystemImageProps(t *testing.T) {

	result := android.GroupFixturePreparers(

		android.PrepareForIntegrationTestWithAndroid,

		android.PrepareForTestWithAndroidBuildComponents,

		filesystem.PrepareForTestWithFilesystemBuildComponents,

		prepareForTestWithFsgenBuildComponents,

		android.FixtureModifyConfig(func(config android.Config) {

			config.TestProductVariables.PartitionVarsForSoongMigrationOnlyDoNotUse.BoardAvbEnable = true

			config.TestProductVariables.PartitionVarsForSoongMigrationOnlyDoNotUse.PartitionQualifiedVariables =

				map[string]android.PartitionQualifiedVariablesType{

					"system": {

						BoardAvbKeyPath:       "external/avb/test/data/testkey_rsa4096.pem",

						BoardAvbAlgorithm:     "SHA256_RSA4096",

						BoardAvbRollbackIndex: "0",

						BoardFileSystemType:   "ext4",

					},

				}

		}),

		android.FixtureMergeMockFs(android.MockFS{

			"external/avb/test/data/testkey_rsa4096.pem": nil,

		}),

	).RunTestWithBp(t, `

	soong_filesystem_creator {

		name: "foo",

	}

	`)



	fooSystem := result.ModuleForTests("test_product_generated_system_image", "android_common").Module().(interface {

		FsProps() filesystem.FilesystemProperties

	})

	android.AssertBoolEquals(

		t,

		"Property expected to match the product variable 'BOARD_AVB_ENABLE'",

		true,

		proptools.Bool(fooSystem.FsProps().Use_avb),

	)

	android.AssertStringEquals(

		t,

		"Property expected to match the product variable 'BOARD_AVB_KEY_PATH'",

		"external/avb/test/data/testkey_rsa4096.pem",

		proptools.String(fooSystem.FsProps().Avb_private_key),

	)

	android.AssertStringEquals(

		t,

		"Property expected to match the product variable 'BOARD_AVB_ALGORITHM'",

		"SHA256_RSA4096",

		proptools.String(fooSystem.FsProps().Avb_algorithm),

	)

	android.AssertIntEquals(

		t,

		"Property expected to match the product variable 'BOARD_AVB_SYSTEM_ROLLBACK_INDEX'",

		0,

		proptools.Int(fooSystem.FsProps().Rollback_index),

	)

	android.AssertStringEquals(

		t,

		"Property expected to match the product variable 'BOARD_SYSTEMIMAGE_FILE_SYSTEM_TYPE'",

		"ext4",

		proptools.String(fooSystem.FsProps().Type),

	)

}