feat: add bob_import_cc_binary

Generate bob_import_cc_binary modules from the Bazel import aspect and allow the imported binaries to be exposed as Bob host binaries.

Change-Id: I0568c14d93e9d59d841caaf6c53cb2dd9d6b1377
Signed-off-by: Jordan Bonser <jordan.bonser@arm.com>

Author: jordan-bonser

Blueprints

@@ -60,7 +60,8 @@ bootstrap_go_package {
         "core/generated_props.go",
         "core/glob.go",
         "core/graphviz.go",
-        "core/import_cc.go",
+        "core/import_cc_binary.go",
+        "core/import_cc_library.go",
         "core/install.go",
         "core/kernel_module.go",
         "core/late_template.go",

core/BUILD.bazel

@@ -31,7 +31,8 @@ go_library(
         "generated_props.go",
         "glob.go",
         "graphviz.go",
-        "import_cc.go",
+        "import_cc_binary.go",
+        "import_cc_library.go",
         "install.go",
         "kernel_module.go",
         "late_template.go",

core/build_structs.go

@@ -90,6 +90,7 @@ type generatorBackend interface {
 	strictBinaryActions(*ModuleStrictBinary, blueprint.ModuleContext)
 	strictLibraryActions(*ModuleStrictLibrary, blueprint.ModuleContext)
 	importCCLibraryActions(*ModuleImportCCLibrary, blueprint.ModuleContext)
+	importCCBinaryActions(*ModuleImportCCBinary, blueprint.ModuleContext)
 	executableTestActions(*ModuleTest, blueprint.ModuleContext)
 }
 
@@ -659,4 +660,5 @@ func RegisterModuleTypes(register func(string, FactoryWithConfig)) {
 	register("bob_test", executableTestFactory)
 
 	register("bob_import_cc_library", importCCLibraryFactory)
+	register("bob_import_cc_binary", importCCBinaryFactory)
 }

core/generated.go

@@ -183,8 +183,11 @@ func hostBinOuts(hostBin *string, ctx blueprint.ModuleContext) (string, []string
 				hostBinTarget = b.getTarget()
 			} else if gb, ok := child.(*generateBinary); ok {
 				outputs = file.GetOutputs(gb)
+			} else if ib, ok := child.(*ModuleImportCCBinary); ok {
+				outputs = file.GetOutputs(ib)
+				hostBinTarget = ib.getTarget()
 			} else {
-				ctx.PropertyErrorf("host_bin", "%s is not a `bob_binary` nor `bob_generate_binary`", parent.Name())
+				ctx.PropertyErrorf("host_bin", "%s is not a `bob_binary`, `bob_generate_binary`, nor `bob_import_cc_binary`", child.Name())
 				return false
 			}
 

core/generated_common.go

@@ -208,10 +208,11 @@ func (m *ModuleGenerateCommon) hostBinName(ctx blueprint.ModuleContext) (name st
 		func(module blueprint.Module) {
 			_, bin_ok := module.(*ModuleBinary)
 			_, genbin_ok := module.(*generateBinary)
-			if bin_ok || genbin_ok {
+			_, importbin_ok := module.(*ModuleImportCCBinary)
+			if bin_ok || genbin_ok || importbin_ok {
 				name = module.Name()
 			} else {
-				ctx.PropertyErrorf("host_bin", "%s is not a `bob_binary` nor `bob_generate_binary`", module.Name())
+				ctx.PropertyErrorf("host_bin", "%s is not a `bob_binary`, `bob_generate_binary`, nor `bob_import_cc_binary`", module.Name())
 			}
 		})
 

core/import_cc_binary.go

@@ -0,0 +1,98 @@
+package core
+
+import (
+	"path/filepath"
+
+	"github.com/ARM-software/bob-build/core/file"
+	"github.com/ARM-software/bob-build/core/module"
+	"github.com/ARM-software/bob-build/core/toolchain"
+	"github.com/google/blueprint"
+)
+
+type ImportCCBinaryProps struct {
+	Src    string
+	Target toolchain.TgtType
+}
+
+type ModuleImportCCBinary struct {
+	module.ModuleBase
+	Properties struct {
+		SplittableProps
+		ImportCCBinaryProps
+	}
+}
+
+var _ splittable = (*ModuleImportCCBinary)(nil)
+var _ file.Provider = (*ModuleImportCCBinary)(nil)
+
+func importCCBinaryFactory(config *BobConfig) (blueprint.Module, []interface{}) {
+	module := &ModuleImportCCBinary{}
+
+	return module, []interface{}{&module.Properties, &module.SimpleName.Properties}
+}
+
+func (g *linuxGenerator) importCCBinaryActions(m *ModuleImportCCBinary, ctx blueprint.ModuleContext) {
+	addPhony(m, ctx, file.GetOutputs(m), false)
+}
+
+func (g *androidNinjaGenerator) importCCBinaryActions(m *ModuleImportCCBinary, ctx blueprint.ModuleContext) {
+
+}
+
+func (g *androidBpGenerator) importCCBinaryActions(m *ModuleImportCCBinary, ctx blueprint.ModuleContext) {
+
+}
+
+func (m *ModuleImportCCBinary) GenerateBuildActions(ctx blueprint.ModuleContext) {
+	getGenerator(ctx).importCCBinaryActions(m, ctx)
+}
+
+func (m *ModuleImportCCBinary) outputFileName() string {
+	return m.Name()
+}
+
+func (m *ModuleImportCCBinary) shortName() string {
+	return m.Name()
+}
+
+func (m *ModuleImportCCBinary) processPaths(ctx blueprint.BaseModuleContext) {
+	m.Properties.Src = filepath.Join(projectModuleDir(ctx), m.Properties.Src)
+}
+
+func (m *ModuleImportCCBinary) OutFiles() file.Paths {
+	return file.Paths{
+		file.NewPath(
+			m.Properties.Src,
+			file.FileNoNameSpace,
+			file.TypeSrc|file.TypeInstallable,
+		),
+	}
+}
+
+func (m *ModuleImportCCBinary) OutFileTargets() (tgts []string) {
+	return
+}
+
+// Support Splittable properties
+func (m *ModuleImportCCBinary) supportedVariants() []toolchain.TgtType {
+	return []toolchain.TgtType{m.Properties.Target}
+}
+
+func (m *ModuleImportCCBinary) setVariant(variant toolchain.TgtType) {
+	// No need to actually track this, as a single target is always supported
+}
+
+func (m *ModuleImportCCBinary) disable() {
+	// This should never actually be called, as we will always support one target
+	panic("disable() called on ModuleImportCCBinary")
+}
+
+func (m *ModuleImportCCBinary) getSplittableProps() *SplittableProps {
+	return &m.Properties.SplittableProps
+}
+
+func (m *ModuleImportCCBinary) getTarget() toolchain.TgtType {
+	return m.Properties.Target
+}
+
+// End Support Splittable properties

core/import_cc.go core/import_cc_library.gocore/import_cc.go renamed to core/import_cc_library.go

@@ -0,0 +1,19 @@
+# Module: bob_import_cc_binary
+
+> Warning, this target is experimental and the attributes/interface are likely to keep changing.
+
+```bp
+bob_import_cc_binary {
+    name, src, target
+}
+```
+
+This target makes an externally built executable available in the Bob build graph. It does not expose headers, defines, or linker flags; it only provides the binary artifact to other rules.
+
+## Properties
+
+|                                                |                                                                                       |
+| ---------------------------------------------- | ------------------------------------------------------------------------------------- |
+| [`name`](properties/common_properties.md#name) | String; required                                                                      |
+| `src`                                          | Path of the built executable.                                                         |
+| `target`                                       | One of either `host` or `target`. Whether the executable is built for host or target. |

docs/module_types/bob_import_cc_binary.md

@@ -0,0 +1 @@
+build.bp