| // 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.objc; |
| |
| import static com.google.devtools.build.lib.rules.objc.CompilationSupport.IncludeProcessingType.HEADER_THINNING; |
| import static com.google.devtools.build.lib.rules.objc.CompilationSupport.IncludeProcessingType.INCLUDE_SCANNING; |
| import static com.google.devtools.build.lib.rules.objc.CompilationSupport.IncludeProcessingType.NO_PROCESSING; |
| import static com.google.devtools.build.lib.rules.objc.ObjcProvider.HEADER; |
| |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.Iterables; |
| import com.google.devtools.build.lib.actions.Artifact; |
| import com.google.devtools.build.lib.analysis.RuleContext; |
| import com.google.devtools.build.lib.analysis.config.BuildConfiguration; |
| import com.google.devtools.build.lib.collect.nestedset.NestedSet; |
| import com.google.devtools.build.lib.rules.cpp.CcCompilationContext; |
| import com.google.devtools.build.lib.rules.cpp.CcToolchainFeatures.FeatureConfiguration; |
| import com.google.devtools.build.lib.rules.cpp.CppCompileActionBuilder; |
| import com.google.devtools.build.lib.rules.cpp.CppConfiguration.HeadersCheckingMode; |
| import com.google.devtools.build.lib.rules.cpp.CppFileTypes; |
| import com.google.devtools.build.lib.rules.cpp.CppSemantics; |
| import com.google.devtools.build.lib.rules.cpp.HeaderDiscovery.DotdPruningMode; |
| import com.google.devtools.build.lib.rules.cpp.IncludeProcessing; |
| import com.google.devtools.build.lib.rules.objc.CompilationSupport.IncludeProcessingType; |
| import com.google.devtools.build.lib.util.FileTypeSet; |
| |
| /** |
| * CppSemantics for objc builds. |
| */ |
| public class ObjcCppSemantics implements CppSemantics { |
| |
| private final IncludeProcessingType includeProcessingType; |
| private final IncludeProcessing includeProcessing; |
| private final Iterable<Artifact> extraIncludeScanningInputs; |
| private final ObjcProvider objcProvider; |
| private final ObjcConfiguration config; |
| private final IntermediateArtifacts intermediateArtifacts; |
| private final BuildConfiguration buildConfiguration; |
| |
| /** |
| * Set of {@link com.google.devtools.build.lib.util.FileType} of source artifacts that are |
| * compatible with header thinning. |
| */ |
| private static final FileTypeSet SOURCES_FOR_HEADER_THINNING = |
| FileTypeSet.of( |
| CppFileTypes.OBJC_SOURCE, |
| CppFileTypes.OBJCPP_SOURCE, |
| CppFileTypes.CPP_SOURCE, |
| CppFileTypes.C_SOURCE); |
| |
| /** |
| * Creates an instance of ObjcCppSemantics |
| * |
| * @param objcProvider the provider that should be used in determining objc-specific inputs to |
| * actions |
| * @param includeProcessingType The type of include processing to be run. |
| * @param includeProcessing the closure providing the strategy for processing of includes for |
| * actions |
| * @param extraIncludeScanningInputs additional inputs to include scanning, outside of the headers |
| * provided by ObjProvider. |
| * @param config the ObjcConfiguration for this build |
| * @param intermediateArtifacts used to create headers_list artifacts |
| * @param buildConfiguration the build configuration for this build |
| */ |
| public ObjcCppSemantics( |
| ObjcProvider objcProvider, |
| IncludeProcessingType includeProcessingType, |
| IncludeProcessing includeProcessing, |
| Iterable<Artifact> extraIncludeScanningInputs, |
| ObjcConfiguration config, |
| IntermediateArtifacts intermediateArtifacts, |
| BuildConfiguration buildConfiguration) { |
| this.objcProvider = objcProvider; |
| this.includeProcessingType = includeProcessingType; |
| this.includeProcessing = includeProcessing; |
| this.extraIncludeScanningInputs = extraIncludeScanningInputs; |
| this.config = config; |
| this.intermediateArtifacts = intermediateArtifacts; |
| this.buildConfiguration = buildConfiguration; |
| } |
| |
| @Override |
| public void finalizeCompileActionBuilder( |
| BuildConfiguration configuration, |
| FeatureConfiguration featureConfiguration, |
| CppCompileActionBuilder actionBuilder) { |
| actionBuilder |
| // Without include scanning, we need the entire crosstool filegroup, including header files, |
| // as opposed to just the "compile" filegroup. Even with include scanning, we need the |
| // system framework headers since they are not being scanned right now. |
| // TODO(waltl): do better with include scanning. |
| .addTransitiveMandatoryInputs(actionBuilder.getToolchain().getAllFilesMiddleman()) |
| .setShouldScanIncludes(includeProcessingType == INCLUDE_SCANNING); |
| |
| if (includeProcessingType == HEADER_THINNING) { |
| Artifact sourceFile = actionBuilder.getSourceFile(); |
| if (!sourceFile.isTreeArtifact() |
| && SOURCES_FOR_HEADER_THINNING.matches(sourceFile.getFilename())) { |
| actionBuilder.addMandatoryInputs( |
| ImmutableList.of(intermediateArtifacts.headersListFile(actionBuilder.getOutputFile()))); |
| } |
| } else if (includeProcessingType == NO_PROCESSING) { |
| // Header thinning feature will make all generated files mandatory inputs to the |
| // ObjcHeaderScanning action so this is only required when that is disabled |
| // TODO(b/62060839): Identify the mechanism used to add generated headers in c++, and recycle |
| // it here. |
| actionBuilder.addTransitiveMandatoryInputs(objcProvider.getGeneratedHeaders()); |
| } |
| } |
| |
| @Override |
| public NestedSet<Artifact> getAdditionalPrunableIncludes() { |
| return objcProvider.get(HEADER); |
| } |
| |
| @Override |
| public Iterable<Artifact> getAlternateIncludeScanningDataInputs() { |
| // Include scanning data only cares about generated artifacts. Since the generated headers from |
| // objcProvider is readily available we provide that instead of the full header list. |
| return Iterables.concat(objcProvider.getGeneratedHeaderList(), extraIncludeScanningInputs); |
| } |
| |
| @Override |
| public HeadersCheckingMode determineHeadersCheckingMode(RuleContext ruleContext) { |
| // Currently, objc builds do not enforce strict deps. To begin enforcing strict deps in objc, |
| // switch this flag to STRICT. |
| return HeadersCheckingMode.LOOSE; |
| } |
| |
| @Override |
| public IncludeProcessing getIncludeProcessing() { |
| return includeProcessing; |
| } |
| |
| @Override |
| public boolean needsDotdInputPruning() { |
| return config.getDotdPruningPlan() == DotdPruningMode.USE; |
| } |
| |
| @Override |
| public void validateAttributes(RuleContext ruleContext) { |
| } |
| |
| @Override |
| public boolean needsIncludeValidation() { |
| return false; |
| } |
| |
| /** |
| * Gets the purpose for the {@code CcCompilationContext}. |
| * |
| * @see CcCompilationContext.Builder#setPurpose |
| */ |
| public String getPurpose() { |
| // ProtoSupport creates multiple {@code CcCompilationContext}s for a single rule, |
| // potentially |
| // multiple archives per build configuration. This covers that worst case. |
| return "ObjcCppSemantics_build_arch_" |
| + buildConfiguration.getMnemonic() |
| + "_with_suffix_" |
| + intermediateArtifacts.archiveFileNameSuffix(); |
| } |
| } |