Merge "Add preprocessed_ndk_headers." (9383f824) · Commits · e / os / android_build_soong

cc/ndk_headers.go

+165 −27

Original line number	Diff line number	Diff line
		@@ -15,6 +15,8 @@
		package cc

		import (
		"fmt"
		"os"
		"path/filepath"

		"github.com/google/blueprint"
		@@ -22,6 +24,20 @@ import (
		"android/soong/android"
		)

		var (
		preprocessBionicHeaders = pctx.AndroidStaticRule("preprocessBionicHeaders",
		blueprint.RuleParams{
		Command: "$versionerCmd $srcDir $depsPath -o $out",
		CommandDeps: []string{"$versionerCmd"},
		Description: "versioner preprocess $in",
		},
		"depsPath", "srcDir")
		)

		func init() {
		pctx.HostBinToolVariable("versionerCmd", "versioner")
		}

		// Returns the NDK base include path for use with sdk_version current. Usable with -I.
		func getCurrentIncludePath(ctx android.ModuleContext) android.OutputPath {
		return getNdkSysrootBase(ctx).Join(ctx, "usr/include")
		@@ -63,15 +79,8 @@ type headerModule struct {
		func (m *headerModule) DepsMutator(ctx android.BottomUpMutatorContext) {
		}

		func (m *headerModule) GenerateAndroidBuildActions(ctx android.ModuleContext) {
		if m.properties.License == "" {
		ctx.PropertyErrorf("license", "field is required")
		}

		m.licensePath = android.PathForModuleSrc(ctx, m.properties.License)

		srcFiles := ctx.ExpandSources(m.properties.Srcs, nil)
		for _, header := range srcFiles {
		func getHeaderInstallDir(ctx android.ModuleContext, header android.Path, from string,
		to string) android.OutputPath {
		// Output path is the sysroot base + "usr/include" + to directory + directory component
		// of the file without the leading from directory stripped.
		//
		@@ -83,7 +92,7 @@ func (m *headerModule) GenerateAndroidBuildActions(ctx android.ModuleContext) {
		// output path = "ndk/sysroot/usr/include/bar/woodly/doodly.h"

		// full/platform/path/to/include/foo
		fullFromPath := android.PathForModuleSrc(ctx, m.properties.From)
		fullFromPath := android.PathForModuleSrc(ctx, from)

		// full/platform/path/to/include/foo/woodly
		headerDir := filepath.Dir(header.String())
		@@ -96,10 +105,29 @@ func (m *headerModule) GenerateAndroidBuildActions(ctx android.ModuleContext) {
		}

		// full/platform/path/to/sysroot/usr/include/bar/woodly
		installDir := getCurrentIncludePath(ctx).Join(ctx, m.properties.To, strippedHeaderDir)
		installDir := getCurrentIncludePath(ctx).Join(ctx, to, strippedHeaderDir)

		// full/platform/path/to/sysroot/usr/include/bar/woodly/doodly.h
		installPath := ctx.InstallFile(installDir, header)
		return installDir
		}

		func (m *headerModule) GenerateAndroidBuildActions(ctx android.ModuleContext) {
		if m.properties.License == "" {
		ctx.PropertyErrorf("license", "field is required")
		}

		m.licensePath = android.PathForModuleSrc(ctx, m.properties.License)

		srcFiles := ctx.ExpandSources(m.properties.Srcs, nil)
		for _, header := range srcFiles {
		installDir := getHeaderInstallDir(ctx, header, m.properties.From, m.properties.To)
		installedPath := ctx.InstallFile(installDir, header)
		installPath := installDir.Join(ctx, header.Base())
		if installPath != installedPath {
		panic(fmt.Sprintf(
		"expected header install path (%q) not equal to actual install path %q",
		installPath, installedPath))
		}
		m.installPaths = append(m.installPaths, installPath.String())
		}

		@@ -117,3 +145,113 @@ func ndkHeadersFactory() (blueprint.Module, []interface{}) {
		return android.InitAndroidArchModule(module, android.HostSupportedNoCross,
		android.MultilibFirst, &module.properties)
		}

		type preprocessedHeaderProperies struct {
		// Base directory of the headers being installed. As an example:
		//
		// preprocessed_ndk_headers {
		// name: "foo",
		// from: "include",
		// to: "",
		// }
		//
		// Will install $SYSROOT/usr/include/foo/bar/baz.h. If `from` were instead
		// "include/foo", it would have installed $SYSROOT/usr/include/bar/baz.h.
		From string

		// Install path within the sysroot. This is relative to usr/include.
		To string

		// Path to the NOTICE file associated with the headers.
		License string
		}

		// Like ndk_headers, but preprocesses the headers with the bionic versioner:
		// https://android.googlesource.com/platform/bionic/+/master/tools/versioner/README.md.
		//
		// Unlike ndk_headers, we don't operate on a list of sources but rather a whole directory, the
		// module does not have the srcs property, and operates on a full directory (the `from` property).
		//
		// Note that this is really only built to handle bionic/libc/include.
		type preprocessedHeaderModule struct {
		android.ModuleBase

		properties preprocessedHeaderProperies

		installPaths []string
		licensePath android.ModuleSrcPath
		}

		func (m *preprocessedHeaderModule) DepsMutator(ctx android.BottomUpMutatorContext) {
		}

		func (m *preprocessedHeaderModule) GenerateAndroidBuildActions(ctx android.ModuleContext) {
		if m.properties.License == "" {
		ctx.PropertyErrorf("license", "field is required")
		}

		m.licensePath = android.PathForModuleSrc(ctx, m.properties.License)

		fromSrcPath := android.PathForModuleSrc(ctx, m.properties.From)
		toOutputPath := getCurrentIncludePath(ctx).Join(ctx, m.properties.To)
		srcFiles := ctx.Glob(filepath.Join(fromSrcPath.String(), "*/.h"), nil)
		var installPaths []android.WritablePath
		for _, header := range srcFiles {
		installDir := getHeaderInstallDir(ctx, header, m.properties.From, m.properties.To)
		installPath := installDir.Join(ctx, header.Base())
		installPaths = append(installPaths, installPath)
		m.installPaths = append(m.installPaths, installPath.String())
		}

		if len(m.installPaths) == 0 {
		ctx.ModuleErrorf("glob %q matched zero files", m.properties.From)
		}

		// The versioner depends on a dependencies directory to simplify determining include paths
		// when parsing headers. This directory contains architecture specific directories as well
		// as a common directory, each of which contains symlinks to the actually directories to
		// be included.
		//
		// ctx.Glob doesn't follow symlinks, so we need to do this ourselves so we correctly
		// depend on these headers.
		// TODO(http://b/35673191): Update the versioner to use a --sysroot.
		depsPath := android.PathForSource(ctx, "bionic/libc/versioner-dependencies")
		depsGlob := ctx.Glob(filepath.Join(depsPath.String(), "*/"), nil)
		for i, path := range depsGlob {
		fileInfo, err := os.Lstat(path.String())
		if err != nil {
		ctx.ModuleErrorf("os.Lstat(%q) failed: %s", path.String, err)
		}
		if fileInfo.Mode()&os.ModeSymlink == os.ModeSymlink {
		dest, err := os.Readlink(path.String())
		if err != nil {
		ctx.ModuleErrorf("os.Readlink(%q) failed: %s",
		path.String, err)
		}
		// Additional .. to account for the symlink itself.
		depsGlob[i] = android.PathForSource(
		ctx, filepath.Clean(filepath.Join(path.String(), "..", dest)))
		}
		}

		ctx.ModuleBuild(pctx, android.ModuleBuildParams{
		Rule: preprocessBionicHeaders,
		Output: toOutputPath,
		Implicits: append(srcFiles, depsGlob...),
		ImplicitOutputs: installPaths,
		Args: map[string]string{
		"depsPath": depsPath.String(),
		"srcDir": fromSrcPath.String(),
		},
		})
		}

		func preprocessedNdkHeadersFactory() (blueprint.Module, []interface{}) {
		module := &preprocessedHeaderModule{}
		// Host module rather than device module because device module install steps
		// do not get run when embedded in make. We're not any of the existing
		// module types that can be exposed via the Android.mk exporter, so just use
		// a host module.
		return android.InitAndroidArchModule(module, android.HostSupportedNoCross,
		android.MultilibFirst, &module.properties)
		}

cc/ndk_sysroot.go

+6 −2

Original line number	Diff line number	Diff line
		@@ -61,6 +61,7 @@ import (
		func init() {
		android.RegisterModuleType("ndk_headers", ndkHeadersFactory)
		android.RegisterModuleType("ndk_library", ndkLibraryFactory)
		android.RegisterModuleType("preprocessed_ndk_headers", preprocessedNdkHeadersFactory)
		android.RegisterSingletonType("ndk", NdkSingleton)

		pctx.Import("android/soong/common")
		@@ -93,9 +94,12 @@ func (n *ndkSingleton) GenerateBuildActions(ctx blueprint.SingletonContext) {
		installPaths = append(installPaths, m.installPaths...)
		licensePaths = append(licensePaths, m.licensePath.String())
		}
		})

		ctx.VisitAllModules(func(module blueprint.Module) {
		if m, ok := module.(*preprocessedHeaderModule); ok {
		installPaths = append(installPaths, m.installPaths...)
		licensePaths = append(licensePaths, m.licensePath.String())
		}

		if m, ok := module.(*Module); ok {
		if installer, ok := m.installer.(*stubDecorator); ok {
		installPaths = append(installPaths, installer.installPath)