Skip to content

Commit

Permalink
Add implementation to removed methods to address #8226
Browse files Browse the repository at this point in the history
  • Loading branch information
@dkelmer
dkelmer committed May 6, 2019
1 parent f44bc47 commit d428e2c
Show file tree
Hide file tree
Showing 5 changed files with 408 additions and 426 deletions.
1 change: 1 addition & 0 deletions src/main/java/com/google/devtools/build/lib/BUILD
View file
Original file line number Diff line number Diff line change
Expand Up @@ -748,6 +748,7 @@ java_library(
":python-rules",
":testing-support-rules",
":util",
"//src/main/java/com/google/devtools/build/lib:skylarkinterface",
"//src/main/java/com/google/devtools/build/lib/actions",
"//src/main/java/com/google/devtools/build/lib/buildeventstream",
"//src/main/java/com/google/devtools/build/lib/buildeventstream/proto:build_event_stream_java_proto",
Expand Down
269 changes: 225 additions & 44 deletions src/main/java/com/google/devtools/build/lib/bazel/rules/cpp/BazelCcModule.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,54 @@

package com.google.devtools.build.lib.bazel.rules.cpp;

import com.google.common.base.Joiner;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.RuleContext;
import com.google.devtools.build.lib.analysis.actions.ActionConstructionContext;
import com.google.devtools.build.lib.analysis.configuredtargets.RuleConfiguredTarget.Mode;
import com.google.devtools.build.lib.analysis.skylark.BazelStarlarkContext;
import com.google.devtools.build.lib.analysis.skylark.SkylarkActionFactory;
import com.google.devtools.build.lib.analysis.skylark.SkylarkRuleContext;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.cmdline.LabelSyntaxException;
import com.google.devtools.build.lib.collect.nestedset.NestedSet;
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.Location;
import com.google.devtools.build.lib.packages.RuleClass.ConfiguredTargetFactory.RuleErrorException;
import com.google.devtools.build.lib.rules.cpp.CcCommon;
import com.google.devtools.build.lib.rules.cpp.CcCompilationContext;
import com.google.devtools.build.lib.rules.cpp.CcCompilationHelper;
import com.google.devtools.build.lib.rules.cpp.CcCompilationHelper.CompilationInfo;
import com.google.devtools.build.lib.rules.cpp.CcCompilationOutputs;
import com.google.devtools.build.lib.rules.cpp.CcLinkingHelper;
import com.google.devtools.build.lib.rules.cpp.CcLinkingHelper.LinkingInfo;
import com.google.devtools.build.lib.rules.cpp.CcLinkingOutputs;
import com.google.devtools.build.lib.rules.cpp.CcModule;
import com.google.devtools.build.lib.rules.cpp.CcToolchainConfigInfo;
import com.google.devtools.build.lib.rules.cpp.CcToolchainFeatures.FeatureConfiguration;
import com.google.devtools.build.lib.rules.cpp.CcToolchainProvider;
import com.google.devtools.build.lib.rules.cpp.CcToolchainVariables;
import com.google.devtools.build.lib.rules.cpp.CppConfiguration;
import com.google.devtools.build.lib.rules.cpp.CppFileTypes;
import com.google.devtools.build.lib.rules.cpp.FdoContext;
import com.google.devtools.build.lib.rules.cpp.FeatureConfigurationForStarlark;
import com.google.devtools.build.lib.rules.cpp.LibraryToLink;
import com.google.devtools.build.lib.rules.cpp.LibraryToLink.CcLinkingContext;
import com.google.devtools.build.lib.skylarkbuildapi.cpp.BazelCcModuleApi;
import com.google.devtools.build.lib.skylarkinterface.StarlarkContext;
import com.google.devtools.build.lib.syntax.Environment;
import com.google.devtools.build.lib.syntax.EvalException;
import com.google.devtools.build.lib.syntax.Runtime;
import com.google.devtools.build.lib.syntax.SkylarkList;
import com.google.devtools.build.lib.syntax.SkylarkList.Tuple;
import com.google.devtools.build.lib.syntax.SkylarkNestedSet;
import com.google.devtools.build.lib.util.FileTypeSet;
import com.google.devtools.build.lib.util.Pair;
import com.google.devtools.build.lib.vfs.PathFragment;
import java.util.ArrayList;
import java.util.List;

/**
* A module that contains Skylark utilities for C++ support.
Expand All @@ -40,70 +71,220 @@
*/
public class BazelCcModule extends CcModule
implements BazelCcModuleApi<
SkylarkActionFactory,
Artifact,
SkylarkRuleContext,
CcToolchainProvider,
FeatureConfigurationForStarlark,
CcCompilationContext,
CcCompilationOutputs,
CcLinkingOutputs,
CcLinkingContext,
LibraryToLink,
CcToolchainVariables,
CcToolchainConfigInfo> {
Artifact,
SkylarkRuleContext,
SkylarkActionFactory,
CcToolchainProvider,
FeatureConfigurationForStarlark,
CcCompilationContext,
CcCompilationOutputs,
CcLinkingContext,
LibraryToLink,
CcToolchainVariables,
CcToolchainConfigInfo> {
public static final FileTypeSet ALL_C_CLASS_SOURCE =
FileTypeSet.of(
CppFileTypes.CPP_SOURCE,
CppFileTypes.C_SOURCE,
CppFileTypes.OBJCPP_SOURCE,
CppFileTypes.OBJC_SOURCE);

@Override
public Tuple<Object> compile(
SkylarkActionFactory skylarkActionFactoryApi,
SkylarkActionFactory actions,
FeatureConfigurationForStarlark skylarkFeatureConfiguration,
CcToolchainProvider skylarkCcToolchainProvider,
SkylarkList<Artifact> sources,
SkylarkList<Artifact> publicHeaders,
SkylarkList<Artifact> privateHeaders,
SkylarkList<String> includes,
SkylarkList<String> quoteIncludes,
SkylarkList<String> systemIncludes,
SkylarkList<String> userCompileFlags,
SkylarkList<String> skylarkIncludes,
SkylarkList<String> skylarkUserCompileFlags,
SkylarkList<CcCompilationContext> ccCompilationContexts,
String name,
boolean disallowPicOutputs,
boolean disallowNopicOutputs)
Location location)
throws EvalException, InterruptedException {
return null;
CcToolchainProvider ccToolchainProvider = convertFromNoneable(skylarkCcToolchainProvider, null);
FeatureConfigurationForStarlark featureConfiguration =
convertFromNoneable(skylarkFeatureConfiguration, null);
Pair<List<Artifact>, List<Artifact>> separatedHeadersAndSources =
separateSourcesFromHeaders(sources);
FdoContext fdoContext = ccToolchainProvider.getFdoContext();
// TODO(plf): Need to flatten the nested set to convert the Strings to PathFragment. This could
// be avoided if path fragments are ever added to Skylark or in the C++ code we take Strings
// instead of PathFragments.
List<String> includeDirs = convertSkylarkListOrNestedSetToList(skylarkIncludes, String.class);

validateExtensions(
location,
"srcs",
sources,
ALL_C_CLASS_SOURCE,
FileTypeSet.of(CppFileTypes.CPP_SOURCE, CppFileTypes.C_SOURCE));
validateExtensions(
location,
"public_hdrs",
publicHeaders,
FileTypeSet.of(CppFileTypes.CPP_HEADER),
FileTypeSet.of(CppFileTypes.CPP_HEADER));
validateExtensions(
location,
"private_hdrs",
privateHeaders,
FileTypeSet.of(CppFileTypes.CPP_HEADER),
FileTypeSet.of(CppFileTypes.CPP_HEADER));

Label label = getCallerLabel(location, actions, name);
CcCompilationHelper helper =
new CcCompilationHelper(
actions.asActionRegistry(location, actions),
actions.getActionConstructionContext(),
label,
/* grepIncludes= */ null,
BazelCppSemantics.INSTANCE,
featureConfiguration.getFeatureConfiguration(),
ccToolchainProvider,
fdoContext)
.addPublicHeaders(publicHeaders)
.addIncludeDirs(
includeDirs.stream()
.map(PathFragment::create)
.collect(ImmutableList.toImmutableList()))
.addPrivateHeaders(separatedHeadersAndSources.first)
.addSources(separatedHeadersAndSources.second)
.addCcCompilationContexts(ccCompilationContexts)
.setCopts(skylarkUserCompileFlags);

try {
CompilationInfo compilationInfo = helper.compile();
return Tuple.of(
compilationInfo.getCcCompilationContext(), compilationInfo.getCcCompilationOutputs());
} catch (RuleErrorException e) {
throw new EvalException(location, e);
}
}

@Override
public CcLinkingContext createLinkingContextFromCompilationOutputs(
SkylarkActionFactory skylarkActionFactoryApi,
public Tuple<Object> createLinkingContextFromCompilationOutputs(
SkylarkActionFactory actions,
FeatureConfigurationForStarlark skylarkFeatureConfiguration,
CcToolchainProvider skylarkCcToolchainProvider,
CcCompilationOutputs compilationOutputs,
SkylarkList userLinkFlags,
SkylarkList<String> skylarkUserLinkFlags,
SkylarkList<CcLinkingContext> linkingContexts,
String name,
String language,
boolean alwayslink,
SkylarkList nonCodeInputs,
boolean disallowStaticLibraries,
boolean disallowDynamicLibraries)
Location location,
StarlarkContext starlarkContext)
throws InterruptedException, EvalException {
return null;
CcToolchainProvider ccToolchainProvider = convertFromNoneable(skylarkCcToolchainProvider, null);
FeatureConfigurationForStarlark featureConfiguration =
convertFromNoneable(skylarkFeatureConfiguration, null);
Label label = getCallerLabel(location, actions, name);
FdoContext fdoContext = ccToolchainProvider.getFdoContext();
CcLinkingHelper helper =
new CcLinkingHelper(
actions.getActionConstructionContext().getRuleErrorConsumer(),
label,
actions.asActionRegistry(location, actions),
actions.getActionConstructionContext(),
BazelCppSemantics.INSTANCE,
featureConfiguration.getFeatureConfiguration(),
ccToolchainProvider,
fdoContext,
actions.getActionConstructionContext().getConfiguration(),
actions
.getActionConstructionContext()
.getConfiguration()
.getFragment(CppConfiguration.class),
((BazelStarlarkContext) starlarkContext).getSymbolGenerator())
.addLinkopts(skylarkUserLinkFlags)
.addCcLinkingContexts(linkingContexts);
try {
CcLinkingOutputs ccLinkingOutputs = CcLinkingOutputs.EMPTY;
ImmutableList<LibraryToLink> libraryToLink = ImmutableList.of();
if (!compilationOutputs.isEmpty()) {
ccLinkingOutputs = helper.link(compilationOutputs);
if (!ccLinkingOutputs.isEmpty()) {
libraryToLink =
ImmutableList.of(ccLinkingOutputs.getLibraryToLink());
}
}
CcLinkingContext linkingContext =
helper.buildCcLinkingContextFromLibrariesToLink(
libraryToLink, CcCompilationContext.EMPTY);
return Tuple.of(
CcLinkingContext.merge(
ImmutableList.<CcLinkingContext>builder()
.add(linkingContext)
.addAll(linkingContexts)
.build()),
ccLinkingOutputs);
} catch (RuleErrorException e) {
throw new EvalException(location, e);
}
}

@Override
public CcLinkingOutputs link(
SkylarkActionFactory skylarkActionFactoryApi,
FeatureConfigurationForStarlark skylarkFeatureConfiguration,
CcToolchainProvider skylarkCcToolchainProvider,
Object compilationOutputs,
SkylarkList userLinkFlags,
SkylarkList linkingContexts,
String name,
String language,
String outputType,
boolean linkDepsStatically,
SkylarkList nonCodeInputs)
throws InterruptedException, EvalException {
return null;
@SuppressWarnings("unchecked")
protected static <T> List<T> convertSkylarkListOrNestedSetToList(Object o, Class<T> type) {
return o instanceof SkylarkNestedSet
? ((SkylarkNestedSet) o).getSet(type).toList()
: ((SkylarkList) o).getImmutableList();
}

private static Pair<List<Artifact>, List<Artifact>> separateSourcesFromHeaders(
Iterable<Artifact> artifacts) {
List<Artifact> headers = new ArrayList<>();
List<Artifact> sources = new ArrayList<>();
for (Artifact artifact : artifacts) {
if (CppFileTypes.CPP_HEADER.matches(artifact.getExecPath())) {
headers.add(artifact);
} else {
sources.add(artifact);
}
}
return Pair.of(headers, sources);
}


@SuppressWarnings("unchecked")
protected static <T> NestedSet<T> convertSkylarkListOrNestedSetToNestedSet(
Object o, Class<T> type) {
return o instanceof SkylarkNestedSet
? ((SkylarkNestedSet) o).getSet(type)
: NestedSetBuilder.wrap(Order.COMPILE_ORDER, (SkylarkList<T>) o);
}

private void validateExtensions(
Location location,
String paramName,
List<Artifact> files,
FileTypeSet validFileTypeSet,
FileTypeSet fileTypeForErrorMessage)
throws EvalException {
for (Artifact file : files) {
if (!validFileTypeSet.matches(file.getFilename())) {
throw new EvalException(
location,
String.format(
"'%s' has wrong extension. The list of possible extensions for '"
+ paramName
+ "' are: %s",
file.getExecPathString(),
Joiner.on(",").join(fileTypeForErrorMessage.getExtensions())));
}
}
}

protected Label getCallerLabel(Location location, SkylarkActionFactory actions, String name)
throws EvalException {
Label label;
try {
label =
Label.create(
actions.getActionConstructionContext().getActionOwner().getLabel().getPackageName(),
name);
} catch (LabelSyntaxException e) {
throw new EvalException(location, e);
}
return label;
}
}
Loading

0 comments on commit d428e2c

Please sign in to comment.