Skip to content

Commit

Permalink
Starlarkify CcToolchainAttributesProvider and delete it.
Browse files Browse the repository at this point in the history 
After `incompatible_enable_cc_toolchain_resolution` has been made no-op - this provider served no purpose other than being a simple placeholder.
This should be the final cl from the series of preparing `CcToolchainProvider` for Starlarkification. After this I think all blockers are gone and I will try to switch `CcToolchainInfo` to Starlark version.

PiperOrigin-RevId: 593108847
Change-Id: I3b66288df7b123fbcdb9ed699e04ba54ddb1b275
  • Loading branch information
@buildbreaker2021 @copybara-github
buildbreaker2021 authored and copybara-github committed Dec 22, 2023
1 parent 00d84af commit 92cba04
Show file tree
Hide file tree
Showing 5 changed files with 317 additions and 812 deletions.
229 changes: 152 additions & 77 deletions src/main/java/com/google/devtools/build/lib/rules/cpp/CcStarlarkInternal.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,15 @@
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.docgen.annot.DocCategory;
import com.google.devtools.build.lib.actions.Actions;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.CommandLineExpansionException;
import com.google.devtools.build.lib.analysis.LicensesProvider;
import com.google.devtools.build.lib.analysis.LicensesProvider.TargetLicense;
import com.google.devtools.build.lib.analysis.LicensesProviderImpl;
import com.google.devtools.build.lib.analysis.OutputGroupInfo;
import com.google.devtools.build.lib.analysis.PackageSpecificationProvider;
import com.google.devtools.build.lib.analysis.RuleContext;
import com.google.devtools.build.lib.analysis.actions.ActionConstructionContext;
import com.google.devtools.build.lib.analysis.config.BuildConfigurationValue;
import com.google.devtools.build.lib.analysis.starlark.StarlarkActionFactory;
Expand All @@ -30,8 +37,11 @@
import com.google.devtools.build.lib.collect.nestedset.Depset;
import com.google.devtools.build.lib.collect.nestedset.Depset.TypeException;
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.packages.Attribute.ComputedDefault;
import com.google.devtools.build.lib.packages.AttributeMap;
import com.google.devtools.build.lib.packages.License;
import com.google.devtools.build.lib.packages.RuleClass.ConfiguredTargetFactory.RuleErrorException;
import com.google.devtools.build.lib.packages.StarlarkProvider;
import com.google.devtools.build.lib.packages.Type;
Expand Down Expand Up @@ -83,18 +93,6 @@ private ImmutableMap<String, PathFragment> castDict(Dict<?, ?> d) throws EvalExc
.collect(toImmutableMap(Pair::getFirst, Pair::getSecond));
}

@StarlarkMethod(
name = "construct_cc_toolchain_attributes_info",
documented = false,
parameters = {
@Param(name = "ctx", positional = false, named = true),
@Param(name = "is_apple", positional = false, named = true),
})
public CcToolchainAttributesProvider constructCcToolchainAttributesInfo(
StarlarkRuleContext ruleContext, boolean isApple) throws EvalException {
return new CcToolchainAttributesProvider(ruleContext.getRuleContext(), isApple);
}

@StarlarkMethod(
name = "construct_toolchain_provider",
documented = false,
Expand All @@ -103,7 +101,6 @@ public CcToolchainAttributesProvider constructCcToolchainAttributesInfo(
@Param(name = "cpp_config", positional = false, named = true),
@Param(name = "toolchain_features", positional = false, named = true),
@Param(name = "tools_directory", positional = false, named = true),
@Param(name = "attributes", positional = false, named = true),
@Param(
name = "static_runtime_link_inputs",
positional = false,
Expand Down Expand Up @@ -145,13 +142,31 @@ public CcToolchainAttributesProvider constructCcToolchainAttributesInfo(
@Param(name = "gcov", positional = false, named = true),
@Param(name = "vars", positional = false, named = true),
@Param(name = "xcode_config_info", positional = false, named = true),
@Param(name = "all_files", positional = false, named = true),
@Param(name = "all_files_including_libc", positional = false, named = true),
@Param(name = "compiler_files", positional = false, named = true),
@Param(name = "compiler_files_without_includes", positional = false, named = true),
@Param(name = "strip_files", positional = false, named = true),
@Param(name = "objcopy_files", positional = false, named = true),
@Param(name = "as_files", positional = false, named = true),
@Param(name = "ar_files", positional = false, named = true),
@Param(name = "linker_files", positional = false, named = true),
@Param(name = "if_so_builder", positional = false, named = true),
@Param(name = "dwp_files", positional = false, named = true),
@Param(name = "coverage_files", positional = false, named = true),
@Param(name = "supports_param_files", positional = false, named = true),
@Param(name = "supports_header_parsing", positional = false, named = true),
@Param(name = "link_dynamic_library_tool", positional = false, named = true),
@Param(name = "grep_includes", positional = false, named = true),
@Param(name = "licenses_provider", positional = false, named = true),
@Param(name = "allowlist_for_layering_check", positional = false, named = true),
@Param(name = "build_info_files", positional = false, named = true),
})
public CcToolchainProvider getCcToolchainProvider(
StarlarkRuleContext ruleContext,
Object cppConfigurationObject,
CcToolchainFeatures toolchainFeatures,
String toolsDirectoryStr,
CcToolchainAttributesProvider attributes,
Object staticRuntimeLinkInputsObject,
Object dynamicRuntimeLinkInputsObject,
String dynamicRuntimeSolibDirStr,
Expand All @@ -178,7 +193,26 @@ public CcToolchainProvider getCcToolchainProvider(
String ldExecutable,
String gcovExecutable,
Object vars,
Object xcodeConfigInfoObject)
Object xcodeConfigInfoObject,
Depset allFiles,
Depset allFilesIncludingLibc,
Depset compilerFiles,
Depset compilerFilesWithoutIncludes,
Depset stripFiles,
Depset objcopyFiles,
Depset asFiles,
Depset arFiles,
Depset fullInputsForLink,
Artifact ifsoBuilder,
Depset dwpFiles,
Depset coverageFiles,
Boolean supportsParamFiles,
Boolean supportsHeaderParsing,
Artifact linkDynamicLibraryTool,
Object grepIncludesObject,
Object licensesProviderObject,
PackageSpecificationProvider allowlistForLayeringCheck,
OutputGroupInfo buildInfoFiles)
throws EvalException, InterruptedException {
CppConfiguration cppConfiguration = CcModule.convertFromNoneable(cppConfigurationObject, null);
PathFragment toolsDirectory = PathFragment.create(toolsDirectoryStr);
Expand Down Expand Up @@ -219,68 +253,76 @@ public CcToolchainProvider getCcToolchainProvider(
if (xcodeConfigInfoObject != Starlark.NONE) {
xcodeConfigInfo = (XcodeConfigInfo) xcodeConfigInfoObject;
}
return new CcToolchainProvider(
/* cppConfiguration= */ cppConfiguration,
/* toolchainFeatures= */ toolchainFeatures,
/* crosstoolTopPathFragment= */ toolsDirectory,
/* allFiles= */ attributes.getAllFiles(),
/* allFilesIncludingLibc= */ attributes.getFullInputsForCrosstool(),
/* compilerFiles= */ attributes.getCompilerFiles(),
/* compilerFilesWithoutIncludes= */ attributes.getCompilerFilesWithoutIncludes(),
/* stripFiles= */ attributes.getStripFiles(),
/* objcopyFiles= */ attributes.getObjcopyFiles(),
/* asFiles= */ attributes.getAsFiles(),
/* arFiles= */ attributes.getArFiles(),
/* linkerFiles= */ attributes.getFullInputsForLink(),
/* interfaceSoBuilder= */ attributes.getIfsoBuilder(),
/* dwpFiles= */ attributes.getDwpFiles(),
/* coverageFiles= */ attributes.getCoverage(),
/* staticRuntimeLinkInputs= */ staticRuntimeLinkInputsSet,
/* dynamicRuntimeLinkInputs= */ dynamicRuntimeLinkInputsSet,
/* dynamicRuntimeSolibDir= */ dynamicRuntimeSolibDir,
/* ccCompilationContext= */ ccCompilationContext,
/* supportsParamFiles= */ attributes.isSupportsParamFiles(),
/* supportsHeaderParsing= */ attributes.isSupportsHeaderParsing(),
/* buildVariables= */ (CcToolchainVariables) vars,
/* builtinIncludeFiles= */ Sequence.cast(
builtinIncludeFiles, Artifact.class, "builtin_include_files")
.getImmutableList(),
/* linkDynamicLibraryTool= */ attributes.getLinkDynamicLibraryTool(),
/* grepIncludes= */ attributes.getGrepIncludes(),
/* builtInIncludeDirectories= */ builtInIncludeDirectories,
/* sysroot= */ sysroot,
/* fdoContext= */ fdoContext,
/* isToolConfiguration= */ isToolConfiguration,
/* licensesProvider= */ attributes.getLicensesProvider(),
/* toolPaths= */ ImmutableMap.copyOf(
Dict.cast(toolPathsDict, String.class, String.class, "tool_paths")),
/* toolchainIdentifier= */ toolchainConfigInfo.getToolchainIdentifier(),
/* compiler= */ toolchainConfigInfo.getCompiler(),
/* abiGlibcVersion= */ toolchainConfigInfo.getAbiLibcVersion(),
/* targetCpu= */ toolchainConfigInfo.getTargetCpu(),
/* targetOS= */ toolchainConfigInfo.getCcTargetOs(),
/* defaultSysroot= */ defaultSysroot,
/* runtimeSysroot= */ runtimeSysroot,
/* targetLibc= */ toolchainConfigInfo.getTargetLibc(),
/* ccToolchainLabel= */ ruleContext.getRuleContext().getLabel(),
/* solibDirectory= */ solibDirectory,
/* abi= */ toolchainConfigInfo.getAbiVersion(),
/* targetSystemName= */ toolchainConfigInfo.getTargetSystemName(),
/* additionalMakeVariables= */ ImmutableMap.copyOf(additionalMakeVariables),
/* legacyCcFlagsMakeVariable= */ legacyCcFlagsMakeVariable,
/* allowlistForLayeringCheck= */ attributes.getAllowlistForLayeringCheck(),
/* objcopyExecutable= */ objcopyExecutable,
/* compilerExecutable= */ compilerExecutable,
/* preprocessorExecutable= */ preprocessorExecutable,
/* nmExecutable= */ nmExecutable,
/* objdumpExecutable= */ objdumpExecutable,
/* arExecutable= */ arExecutable,
/* stripExecutable= */ stripExecutable,
/* ldExecutable= */ ldExecutable,
/* gcovExecutable= */ gcovExecutable,
/* ccToolchainVariablesBuilderFunc */ buildFunc,
/* xcodeConfigInfo */ xcodeConfigInfo,
/* ccBuildInfoTranslator */ attributes.getCcBuildInfoTranslator());
try {
return new CcToolchainProvider(
/* cppConfiguration= */ cppConfiguration,
/* toolchainFeatures= */ toolchainFeatures,
/* crosstoolTopPathFragment= */ toolsDirectory,
/* allFiles= */ allFiles.getSet(Artifact.class),
/* allFilesIncludingLibc= */ allFilesIncludingLibc.getSet(Artifact.class),
/* compilerFiles= */ compilerFiles.getSet(Artifact.class),
/* compilerFilesWithoutIncludes= */ compilerFilesWithoutIncludes.getSet(Artifact.class),
/* stripFiles= */ stripFiles.getSet(Artifact.class),
/* objcopyFiles= */ objcopyFiles.getSet(Artifact.class),
/* asFiles= */ asFiles.getSet(Artifact.class),
/* arFiles= */ arFiles.getSet(Artifact.class),
/* linkerFiles= */ fullInputsForLink.getSet(Artifact.class),
/* interfaceSoBuilder= */ ifsoBuilder,
/* dwpFiles= */ dwpFiles.getSet(Artifact.class),
/* coverageFiles= */ coverageFiles.getSet(Artifact.class),
/* staticRuntimeLinkInputs= */ staticRuntimeLinkInputsSet,
/* dynamicRuntimeLinkInputs= */ dynamicRuntimeLinkInputsSet,
/* dynamicRuntimeSolibDir= */ dynamicRuntimeSolibDir,
/* ccCompilationContext= */ ccCompilationContext,
/* supportsParamFiles= */ supportsParamFiles,
/* supportsHeaderParsing= */ supportsHeaderParsing,
/* buildVariables= */ (CcToolchainVariables) vars,
/* builtinIncludeFiles= */ Sequence.cast(
builtinIncludeFiles, Artifact.class, "builtin_include_files")
.getImmutableList(),
/* linkDynamicLibraryTool= */ linkDynamicLibraryTool,
/* grepIncludes= */ grepIncludesObject == Starlark.NONE
? null
: (Artifact) grepIncludesObject,
/* builtInIncludeDirectories= */ builtInIncludeDirectories,
/* sysroot= */ sysroot,
/* fdoContext= */ fdoContext,
/* isToolConfiguration= */ isToolConfiguration,
/* licensesProvider= */ licensesProviderObject == Starlark.NONE
? null
: (LicensesProvider) licensesProviderObject,
/* toolPaths= */ ImmutableMap.copyOf(
Dict.cast(toolPathsDict, String.class, String.class, "tool_paths")),
/* toolchainIdentifier= */ toolchainConfigInfo.getToolchainIdentifier(),
/* compiler= */ toolchainConfigInfo.getCompiler(),
/* abiGlibcVersion= */ toolchainConfigInfo.getAbiLibcVersion(),
/* targetCpu= */ toolchainConfigInfo.getTargetCpu(),
/* targetOS= */ toolchainConfigInfo.getCcTargetOs(),
/* defaultSysroot= */ defaultSysroot,
/* runtimeSysroot= */ runtimeSysroot,
/* targetLibc= */ toolchainConfigInfo.getTargetLibc(),
/* ccToolchainLabel= */ ruleContext.getRuleContext().getLabel(),
/* solibDirectory= */ solibDirectory,
/* abi= */ toolchainConfigInfo.getAbiVersion(),
/* targetSystemName= */ toolchainConfigInfo.getTargetSystemName(),
/* additionalMakeVariables= */ ImmutableMap.copyOf(additionalMakeVariables),
/* legacyCcFlagsMakeVariable= */ legacyCcFlagsMakeVariable,
/* allowlistForLayeringCheck= */ allowlistForLayeringCheck,
/* objcopyExecutable= */ objcopyExecutable,
/* compilerExecutable= */ compilerExecutable,
/* preprocessorExecutable= */ preprocessorExecutable,
/* nmExecutable= */ nmExecutable,
/* objdumpExecutable= */ objdumpExecutable,
/* arExecutable= */ arExecutable,
/* stripExecutable= */ stripExecutable,
/* ldExecutable= */ ldExecutable,
/* gcovExecutable= */ gcovExecutable,
/* ccToolchainVariablesBuilderFunc= */ buildFunc,
/* xcodeConfigInfo= */ xcodeConfigInfo,
/* ccBuildInfoTranslator= */ buildInfoFiles);
} catch (TypeException e) {
throw new EvalException(e);
}
}

@StarlarkMethod(
Expand Down Expand Up @@ -702,4 +744,37 @@ public AppleConfiguration getAppleConfigIfAvailable(StarlarkRuleContext ruleCont
public StarlarkProvider buildSettingInfo() throws EvalException {
return buildSettingInfo;
}

@StarlarkMethod(
name = "escape_label",
documented = false,
parameters = {
@Param(name = "label", positional = false, named = true),
})
public String escapeLabel(Label label) {
return Actions.escapeLabel(label);
}

@StarlarkMethod(
name = "licenses",
documented = false,
parameters = {
@Param(name = "ctx", positional = false, named = true),
},
allowReturnNones = true)
@Nullable
public LicensesProvider getLicenses(StarlarkRuleContext starlarkRuleContext) {
RuleContext ruleContext = starlarkRuleContext.getRuleContext();
final License outputLicense =
ruleContext.getRule().getToolOutputLicense(ruleContext.attributes());
if (outputLicense != null && !outputLicense.equals(License.NO_LICENSE)) {
final NestedSet<TargetLicense> license =
NestedSetBuilder.create(
Order.STABLE_ORDER, new TargetLicense(ruleContext.getLabel(), outputLicense));
return new LicensesProviderImpl(
license, new TargetLicense(ruleContext.getLabel(), outputLicense));
} else {
return null;
}
}
}
Loading

0 comments on commit 92cba04

Please sign in to comment.