// Copyright 2016 The Bazel Authors. 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 com.google.devtools.build.lib.rules.cpp; import static com.google.common.truth.Truth.assertThat; import static org.junit.Assert.assertThrows; import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSet; import com.google.devtools.build.lib.actions.AbstractAction; import com.google.devtools.build.lib.actions.Action; import com.google.devtools.build.lib.actions.ActionExecutionContext; import com.google.devtools.build.lib.actions.ActionExecutionContext.LostInputsCheck; import com.google.devtools.build.lib.actions.ActionExecutionException; import com.google.devtools.build.lib.actions.ActionInputPrefetcher; import com.google.devtools.build.lib.actions.Artifact; import com.google.devtools.build.lib.actions.DiscoveredModulesPruner; import com.google.devtools.build.lib.actions.Executor; import com.google.devtools.build.lib.actions.ThreadStateReceiver; import com.google.devtools.build.lib.actions.util.ActionsTestUtil; import com.google.devtools.build.lib.analysis.Runfiles; import com.google.devtools.build.lib.analysis.SingleRunfilesSupplier; import com.google.devtools.build.lib.analysis.actions.SpawnAction; import com.google.devtools.build.lib.analysis.config.BuildConfigurationValue.RunfileSymlinksMode; import com.google.devtools.build.lib.analysis.util.ActionTester; import com.google.devtools.build.lib.analysis.util.ActionTester.ActionCombinationFactory; import com.google.devtools.build.lib.analysis.util.AnalysisTestUtil; import com.google.devtools.build.lib.analysis.util.BuildViewTestCase; import com.google.devtools.build.lib.collect.nestedset.NestedSetBuilder; import com.google.devtools.build.lib.collect.nestedset.Order; import com.google.devtools.build.lib.events.StoredEventHandler; import com.google.devtools.build.lib.exec.BinTools; import com.google.devtools.build.lib.exec.util.TestExecutorBuilder; import com.google.devtools.build.lib.util.io.FileOutErr; import com.google.devtools.build.lib.vfs.FileSystemUtils; import com.google.devtools.build.lib.vfs.PathFragment; import com.google.devtools.build.lib.vfs.SyscallCache; import java.util.HashMap; import java.util.Map; import org.junit.Before; import org.junit.Test; import org.junit.runner.RunWith; import org.junit.runners.JUnit4; /** Tests {@link com.google.devtools.build.lib.rules.cpp.LtoBackendAction}. */ @RunWith(JUnit4.class) public class LtoBackendActionTest extends BuildViewTestCase { private Artifact bitcode1Artifact; private Artifact bitcode2Artifact; private Artifact index1Artifact; private Artifact index2Artifact; private Artifact imports1Artifact; private Artifact imports2Artifact; private Artifact destinationArtifact; private BitcodeFiles allBitcodeFiles; private AnalysisTestUtil.CollectingAnalysisEnvironment collectingAnalysisEnvironment; private ActionExecutionContext context; @Before public final void createArtifacts() throws Exception { collectingAnalysisEnvironment = new AnalysisTestUtil.CollectingAnalysisEnvironment(getTestAnalysisEnvironment()); bitcode1Artifact = getSourceArtifact("bitcode1.o"); bitcode2Artifact = getSourceArtifact("bitcode2.o"); index1Artifact = getSourceArtifact("bitcode1.thinlto.bc"); index2Artifact = getSourceArtifact("bitcode2.thinlto.bc"); scratch.file("bitcode1.imports"); scratch.file("bitcode2.imports", "bitcode1.o"); imports1Artifact = getSourceArtifact("bitcode1.imports"); imports2Artifact = getSourceArtifact("bitcode2.imports"); destinationArtifact = getBinArtifactWithNoOwner("output"); allBitcodeFiles = new BitcodeFiles( NestedSetBuilder.create(Order.STABLE_ORDER, bitcode1Artifact, bitcode2Artifact)); } @Before public final void createExecutorAndContext() throws Exception { BinTools binTools = BinTools.forUnitTesting(directories, analysisMock.getEmbeddedTools()); Executor executor = new TestExecutorBuilder(fileSystem, directories, binTools).build(); context = new ActionExecutionContext( executor, /* inputMetadataProvider= */ null, ActionInputPrefetcher.NONE, actionKeyContext, /* outputMetadataStore= */ null, /* rewindingEnabled= */ false, LostInputsCheck.NONE, new FileOutErr(), new StoredEventHandler(), /* clientEnv= */ ImmutableMap.of(), /* topLevelFilesets= */ ImmutableMap.of(), /* artifactExpander= */ null, /* actionFileSystem= */ null, /* skyframeDepsResult= */ null, DiscoveredModulesPruner.DEFAULT, SyscallCache.NO_CACHE, ThreadStateReceiver.NULL_INSTANCE); } @Test public void testEmptyImports() throws Exception { LtoBackendAction action = (LtoBackendAction) new LtoBackendAction.Builder() .addImportsInfo(allBitcodeFiles, imports1Artifact) .addInput(bitcode1Artifact) .addInput(index1Artifact) .addOutput(destinationArtifact) .setExecutable(scratch.file("/bin/clang").asFragment()) .setProgressMessage("Test") .build(ActionsTestUtil.NULL_ACTION_OWNER, targetConfig); collectingAnalysisEnvironment.registerAction(action); assertThat(action.getOwner().getLabel()) .isEqualTo(ActionsTestUtil.NULL_ACTION_OWNER.getLabel()); assertThat(action.getInputs().toList()).containsExactly(bitcode1Artifact, index1Artifact); assertThat(action.getOutputs()).containsExactly(destinationArtifact); assertThat(action.getSpawn().getLocalResources()) .isEqualTo(AbstractAction.DEFAULT_RESOURCE_SET); assertThat(action.getArguments()).containsExactly("/bin/clang"); assertThat(action.getProgressMessage()).isEqualTo("Test"); assertThat(action.inputsKnown()).isFalse(); // Discover inputs, which should not add any inputs since bitcode1.imports is empty. action.discoverInputs(context); assertThat(action.inputsKnown()).isTrue(); assertThat(action.getInputs().toList()).containsExactly(bitcode1Artifact, index1Artifact); } @Test public void testNonEmptyImports() throws Exception { LtoBackendAction action = (LtoBackendAction) new LtoBackendAction.Builder() .addImportsInfo(allBitcodeFiles, imports2Artifact) .addInput(bitcode2Artifact) .addInput(index2Artifact) .addOutput(destinationArtifact) .setExecutable(scratch.file("/bin/clang").asFragment()) .setProgressMessage("Test") .build(ActionsTestUtil.NULL_ACTION_OWNER, targetConfig); collectingAnalysisEnvironment.registerAction(action); assertThat(action.getOwner().getLabel()) .isEqualTo(ActionsTestUtil.NULL_ACTION_OWNER.getLabel()); assertThat(action.getInputs().toList()).containsExactly(bitcode2Artifact, index2Artifact); assertThat(action.getOutputs()).containsExactly(destinationArtifact); assertThat(action.getSpawn().getLocalResources()) .isEqualTo(AbstractAction.DEFAULT_RESOURCE_SET); assertThat(action.getArguments()).containsExactly("/bin/clang"); assertThat(action.getProgressMessage()).isEqualTo("Test"); assertThat(action.inputsKnown()).isFalse(); // Discover inputs, which should add bitcode1.o which is listed in bitcode2.imports. action.discoverInputs(context); assertThat(action.inputsKnown()).isTrue(); assertThat(action.getInputs().toList()) .containsExactly(bitcode1Artifact, bitcode2Artifact, index2Artifact); } private enum KeyAttributes { EXECUTABLE, IMPORTS_INFO, MNEMONIC, RUNFILES_SUPPLIER, INPUT, FIXED_ENVIRONMENT } @Test public void testComputeKey() throws Exception { final Artifact artifactA = getSourceArtifact("a"); final Artifact artifactB = getSourceArtifact("b"); final Artifact artifactAimports = getSourceArtifact("a.imports"); final Artifact artifactBimports = getSourceArtifact("b.imports"); ActionTester.runTest( KeyAttributes.class, new ActionCombinationFactory() { @Override public Action generate(ImmutableSet attributesToFlip) { LtoBackendAction.Builder builder = new LtoBackendAction.Builder(); builder.addOutput(destinationArtifact); PathFragment executable = attributesToFlip.contains(KeyAttributes.EXECUTABLE) ? artifactA.getExecPath() : artifactB.getExecPath(); builder.setExecutable(executable); if (attributesToFlip.contains(KeyAttributes.IMPORTS_INFO)) { builder.addImportsInfo( new BitcodeFiles(NestedSetBuilder.emptySet(Order.STABLE_ORDER)), artifactAimports); } else { builder.addImportsInfo( new BitcodeFiles(NestedSetBuilder.emptySet(Order.STABLE_ORDER)), artifactBimports); } builder.setMnemonic(attributesToFlip.contains(KeyAttributes.MNEMONIC) ? "a" : "b"); if (attributesToFlip.contains(KeyAttributes.RUNFILES_SUPPLIER)) { builder.addRunfilesSupplier( new SingleRunfilesSupplier( PathFragment.create("a"), Runfiles.EMPTY, artifactA, /* repoMappingManifest= */ null, RunfileSymlinksMode.SKIP, /* buildRunfileLinks= */ false)); } else { builder.addRunfilesSupplier( new SingleRunfilesSupplier( PathFragment.create("a"), Runfiles.EMPTY, artifactB, /* repoMappingManifest= */ null, RunfileSymlinksMode.SKIP, /* buildRunfileLinks= */ false)); } if (attributesToFlip.contains(KeyAttributes.INPUT)) { builder.addInput(artifactA); } else { builder.addInput(artifactB); } Map env = new HashMap<>(); if (attributesToFlip.contains(KeyAttributes.FIXED_ENVIRONMENT)) { env.put("foo", "bar"); } builder.setEnvironment(env); SpawnAction action = builder.build(ActionsTestUtil.NULL_ACTION_OWNER, targetConfig); collectingAnalysisEnvironment.registerAction(action); return action; } }, actionKeyContext); } @Test public void discoverInputs_missingInputErrorMessage() throws Exception { FileSystemUtils.writeIsoLatin1(imports1Artifact.getPath(), "file1.o", "file2.o", "file3.o"); SpawnAction action = new LtoBackendAction.Builder() .addImportsInfo( new BitcodeFiles( new NestedSetBuilder(Order.STABLE_ORDER) .add(getSourceArtifact("file2.o")) .build()), imports1Artifact) .setExecutable(scratch.file("/bin/clang").asFragment()) .addOutput(destinationArtifact) .build(ActionsTestUtil.NULL_ACTION_OWNER, targetConfig); ActionExecutionException e = assertThrows(ActionExecutionException.class, () -> action.discoverInputs(context)); assertThat(e).hasMessageThat().endsWith("(first 10): file1.o, file3.o"); } }