| // Copyright 2014 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 com.google.common.base.Splitter; |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.ImmutableMap; |
| import com.google.common.collect.ImmutableSet; |
| import com.google.devtools.build.lib.analysis.config.BuildConfiguration.EmptyToNullLabelConverter; |
| import com.google.devtools.build.lib.analysis.config.BuildConfiguration.LabelConverter; |
| import com.google.devtools.build.lib.analysis.config.CompilationMode; |
| import com.google.devtools.build.lib.analysis.config.FragmentOptions; |
| import com.google.devtools.build.lib.analysis.config.PerLabelOptions; |
| import com.google.devtools.build.lib.cmdline.Label; |
| import com.google.devtools.build.lib.cmdline.LabelSyntaxException; |
| import com.google.devtools.build.lib.rules.cpp.CppConfiguration.DynamicMode; |
| import com.google.devtools.build.lib.rules.cpp.CppConfiguration.StripMode; |
| import com.google.devtools.build.lib.util.OS; |
| import com.google.devtools.common.options.Converter; |
| import com.google.devtools.common.options.EnumConverter; |
| import com.google.devtools.common.options.Option; |
| import com.google.devtools.common.options.OptionDocumentationCategory; |
| import com.google.devtools.common.options.OptionEffectTag; |
| import com.google.devtools.common.options.OptionMetadataTag; |
| import com.google.devtools.common.options.OptionsParsingException; |
| import java.util.LinkedHashSet; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Set; |
| |
| /** Command-line options for C++. */ |
| public class CppOptions extends FragmentOptions { |
| /** |
| * Converts a comma-separated list of compilation mode settings to a properly typed List. |
| */ |
| public static class FissionOptionConverter implements Converter<List<CompilationMode>> { |
| @Override |
| public List<CompilationMode> convert(String input) throws OptionsParsingException { |
| ImmutableSet.Builder<CompilationMode> modes = ImmutableSet.builder(); |
| if (input.equals("yes")) { // Special case: enable all modes. |
| modes.add(CompilationMode.values()); |
| } else if (!input.equals("no")) { // "no" is another special case that disables all modes. |
| CompilationMode.Converter modeConverter = new CompilationMode.Converter(); |
| for (String mode : Splitter.on(',').split(input)) { |
| modes.add(modeConverter.convert(mode)); |
| } |
| } |
| return modes.build().asList(); |
| } |
| |
| @Override |
| public String getTypeDescription() { |
| return "a set of compilation modes"; |
| } |
| } |
| |
| /** |
| * Converter for {@link DynamicMode} |
| */ |
| public static class DynamicModeConverter extends EnumConverter<DynamicMode> { |
| public DynamicModeConverter() { |
| super(DynamicMode.class, "dynamic mode"); |
| } |
| } |
| |
| /** |
| * Converter for the --strip option. |
| */ |
| public static class StripModeConverter extends EnumConverter<StripMode> { |
| public StripModeConverter() { |
| super(StripMode.class, "strip mode"); |
| } |
| } |
| |
| private static final String LIBC_RELATIVE_LABEL = ":everything"; |
| |
| /** |
| * Converts a String, which is a package label into a label that can be used for a LibcTop object. |
| */ |
| public static class LibcTopLabelConverter implements Converter<Label> { |
| @Override |
| public Label convert(String input) throws OptionsParsingException { |
| if (input.equals("default")) { |
| // This is needed for defining config_setting() values, the syntactic form |
| // of which must be a String, to match absence of a --grte_top option. |
| // "--grte_top=default" works on the command-line too, |
| // but that's an inconsequential side-effect, not the intended purpose. |
| return null; |
| } |
| if (!input.startsWith("//")) { |
| throw new OptionsParsingException("Not a label"); |
| } |
| try { |
| return Label.parseAbsolute(input, ImmutableMap.of()) |
| .getRelativeWithRemapping(LIBC_RELATIVE_LABEL, ImmutableMap.of()); |
| } catch (LabelSyntaxException e) { |
| throw new OptionsParsingException(e.getMessage()); |
| } |
| } |
| |
| @Override |
| public String getTypeDescription() { |
| return "a label"; |
| } |
| } |
| |
| @Option( |
| name = "crosstool_top", |
| defaultValue = "@bazel_tools//tools/cpp:toolchain", |
| converter = LabelConverter.class, |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = { |
| OptionEffectTag.LOADING_AND_ANALYSIS, |
| OptionEffectTag.CHANGES_INPUTS, |
| OptionEffectTag.AFFECTS_OUTPUTS |
| }, |
| help = "The label of the crosstool package to be used for compiling C++ code." |
| ) |
| public Label crosstoolTop; |
| |
| @Option( |
| name = "compiler", |
| defaultValue = "null", |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.EXECUTION}, |
| help = "The C++ compiler to use for compiling the target." |
| ) |
| public String cppCompiler; |
| |
| @Option( |
| name = "host_compiler", |
| defaultValue = "null", |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.EXECUTION}, |
| help = |
| "The C++ compiler to use for host compilation. It is ignored if --host_crosstool_top " |
| + "is not set.") |
| public String hostCppCompiler; |
| |
| // This is different from --platform_suffix in that that one is designed to facilitate the |
| // migration to toolchains and this one is designed to eliminate the C++ toolchain identifier |
| // from the output directory path. |
| @Option( |
| name = "cc_output_directory_tag", |
| defaultValue = "", |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Specifies a suffix to be added to the configuration directory." |
| ) |
| public String outputDirectoryTag; |
| |
| @Option( |
| name = "minimum_os_version", |
| defaultValue = "null", |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "The minimum OS version which your compilation targets.") |
| public String minimumOsVersion; |
| |
| // O intrepid reaper of unused options: Be warned that the [no]start_end_lib |
| // option, however tempting to remove, has a use case. Look in our telemetry data. |
| @Option( |
| name = "start_end_lib", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = { |
| OptionEffectTag.LOADING_AND_ANALYSIS, |
| OptionEffectTag.CHANGES_INPUTS, |
| OptionEffectTag.AFFECTS_OUTPUTS |
| }, |
| metadataTags = {OptionMetadataTag.HIDDEN}, |
| help = "Use the --start-lib/--end-lib ld options if supported by the toolchain." |
| ) |
| public boolean useStartEndLib; |
| |
| @Option( |
| name = "interface_shared_objects", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = { |
| OptionEffectTag.LOADING_AND_ANALYSIS, |
| OptionEffectTag.AFFECTS_OUTPUTS, |
| OptionEffectTag.AFFECTS_OUTPUTS |
| }, |
| help = |
| "Use interface shared objects if supported by the toolchain. " |
| + "All ELF toolchains currently support this setting." |
| ) |
| public boolean useInterfaceSharedObjects; |
| |
| @Option( |
| name = "fission", |
| defaultValue = "no", |
| converter = FissionOptionConverter.class, |
| documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, |
| effectTags = { |
| OptionEffectTag.LOADING_AND_ANALYSIS, |
| OptionEffectTag.ACTION_COMMAND_LINES, |
| OptionEffectTag.AFFECTS_OUTPUTS |
| }, |
| help = |
| "Specifies which compilation modes use fission for C++ compilations and links. " |
| + " May be any combination of {'fastbuild', 'dbg', 'opt'} or the special values 'yes' " |
| + " to enable all modes and 'no' to disable all modes." |
| ) |
| public List<CompilationMode> fissionModes; |
| |
| @Option( |
| name = "build_test_dwp", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "If enabled, when building C++ tests statically and with fission the .dwp file " |
| + " for the test binary will be automatically built as well." |
| ) |
| public boolean buildTestDwp; |
| |
| @Option( |
| name = "dynamic_mode", |
| defaultValue = "default", |
| converter = DynamicModeConverter.class, |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "Determines whether C++ binaries will be linked dynamically. 'default' means " |
| + "Bazel will choose whether to link dynamically. 'fully' means all libraries " |
| + "will be linked dynamically. 'off' means that all libraries will be linked " |
| + "in mostly static mode." |
| ) |
| public DynamicMode dynamicMode; |
| |
| @Option( |
| name = "experimental_link_compile_output_separately", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.AFFECTS_OUTPUTS}, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = |
| "This flag is experimental and may go away at any time. " |
| + "If true, dynamically linked binary targets will build and link their own srcs as " |
| + "a dynamic library instead of directly linking it in." |
| ) |
| public boolean linkCompileOutputSeparately; |
| |
| @Option( |
| name = "force_pic", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "If enabled, all C++ compilations produce position-independent code (\"-fPIC\")," |
| + " links prefer PIC pre-built libraries over non-PIC libraries, and links produce" |
| + " position-independent executables (\"-pie\")." |
| ) |
| public boolean forcePic; |
| |
| @Option( |
| name = "process_headers_in_dependencies", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.BUILD_TIME_OPTIMIZATION, |
| effectTags = {OptionEffectTag.EXECUTION}, |
| help = |
| "When building a target //a:a, process headers in all targets that //a:a depends " |
| + "on (if header processing is enabled for the toolchain)." |
| ) |
| public boolean processHeadersInDependencies; |
| |
| @Option( |
| name = "copt", |
| allowMultiple = true, |
| defaultValue = "", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Additional options to pass to gcc." |
| ) |
| public List<String> coptList; |
| |
| @Option( |
| name = "cxxopt", |
| defaultValue = "", |
| allowMultiple = true, |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Additional option to pass to gcc when compiling C++ source files." |
| ) |
| public List<String> cxxoptList; |
| |
| @Option( |
| name = "conlyopt", |
| allowMultiple = true, |
| defaultValue = "", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Additional option to pass to gcc when compiling C source files." |
| ) |
| public List<String> conlyoptList; |
| |
| @Option( |
| name = "linkopt", |
| defaultValue = "", |
| allowMultiple = true, |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Additional option to pass to gcc when linking." |
| ) |
| public List<String> linkoptList; |
| |
| @Option( |
| name = "ltoindexopt", |
| defaultValue = "", |
| allowMultiple = true, |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Additional option to pass to the LTO indexing step (under --features=thin_lto)." |
| ) |
| public List<String> ltoindexoptList; |
| |
| @Option( |
| name = "ltobackendopt", |
| defaultValue = "", |
| allowMultiple = true, |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Additional option to pass to the LTO backend step (under --features=thin_lto)." |
| ) |
| public List<String> ltobackendoptList; |
| |
| @Option( |
| name = "stripopt", |
| allowMultiple = true, |
| defaultValue = "", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Additional options to pass to strip when generating a '<name>.stripped' binary." |
| ) |
| public List<String> stripoptList; |
| |
| @Option( |
| name = "custom_malloc", |
| defaultValue = "null", |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = {OptionEffectTag.CHANGES_INPUTS, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "Specifies a custom malloc implementation. This setting overrides malloc " |
| + "attributes in build rules.", |
| converter = LabelConverter.class |
| ) |
| public Label customMalloc; |
| |
| @Option( |
| name = "legacy_whole_archive", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "When on, use --whole-archive for cc_binary rules that have " |
| + "linkshared=1 and either linkstatic=1 or '-static' in linkopts. " |
| + "This is for backwards compatibility only. " |
| + "A better alternative is to use alwayslink=1 where required." |
| ) |
| public boolean legacyWholeArchive; |
| |
| @Option( |
| name = "strip", |
| defaultValue = "sometimes", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "Specifies whether to strip binaries and shared libraries " |
| + " (using \"-Wl,--strip-debug\"). The default value of 'sometimes'" |
| + " means strip iff --compilation_mode=fastbuild.", |
| converter = StripModeConverter.class |
| ) |
| public StripMode stripBinaries; |
| |
| @Option( |
| name = "fdo_instrument", |
| defaultValue = "null", |
| implicitRequirements = {"--copt=-Wno-error"}, |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "Generate binaries with FDO instrumentation. With Clang/LLVM compiler, it also accepts the " |
| + "directory name under which the raw profile file(s) will be dumped at runtime." |
| ) |
| public String fdoInstrumentForBuild; |
| |
| @Option( |
| name = "fdo_optimize", |
| defaultValue = "null", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "Use FDO profile information to optimize compilation. Specify the name " |
| + "of the zip file containing the .gcda file tree, or an afdo file containing " |
| + "an auto profile. This flag also accepts files specified as labels, for " |
| + "example //foo/bar:file.afdo. Such labels must refer to input files; you may " |
| + "need to add an exports_files directive to the corresponding package to make " |
| + "the file visible to Bazel. It also accepts a raw or an indexed LLVM profile file. " |
| + "This flag will be superseded by fdo_profile rule.") |
| public String fdoOptimizeForBuild; |
| |
| /** |
| * Returns the --fdo_optimize value if FDO is specified and active for this configuration, the |
| * default value otherwise. |
| */ |
| public String getFdoOptimize() { |
| return fdoOptimizeForBuild; |
| } |
| |
| @Option( |
| name = "xbinary_fdo", |
| defaultValue = "null", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| converter = EmptyToNullLabelConverter.class, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "Use XbinaryFDO profile information to optimize compilation. Specify the name " |
| + "of default cross binary profile. When the option is used together with " |
| + "--fdo_instrument/--fdo_optimize/--fdo_profile, those options will always " |
| + "prevail as if xbinary_fdo is never specified. ") |
| public Label xfdoProfileLabel; |
| |
| @Option( |
| name = "fdo_prefetch_hints", |
| defaultValue = "null", |
| converter = LabelConverter.class, |
| category = "flags", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Use cache prefetch hints." |
| ) |
| public Label fdoPrefetchHintsLabel; |
| |
| /** |
| * Returns the --fdo_prefetch_hints value. |
| */ |
| public Label getFdoPrefetchHintsLabel() { |
| return fdoPrefetchHintsLabel; |
| } |
| |
| @Option( |
| name = "fdo_profile", |
| defaultValue = "null", |
| category = "flags", |
| converter = LabelConverter.class, |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "The fdo_profile representing the profile to be used for optimization." |
| ) |
| public Label fdoProfileLabel; |
| |
| @Option( |
| name = "enable_fdo_profile_absolute_path", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "If set, use of fdo_absolute_profile_path will raise an error.") |
| public boolean enableFdoProfileAbsolutePath; |
| |
| @Option( |
| name = "save_temps", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, |
| effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "If set, temporary outputs from gcc will be saved. " |
| + "These include .s files (assembler code), .i files (preprocessed C) and " |
| + ".ii files (preprocessed C++)." |
| ) |
| public boolean saveTemps; |
| |
| @Option( |
| name = "per_file_copt", |
| allowMultiple = true, |
| converter = PerLabelOptions.PerLabelOptionsConverter.class, |
| defaultValue = "", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "Additional options to selectively pass to gcc when compiling certain files. " |
| + "This option can be passed multiple times. " |
| + "Syntax: regex_filter@option_1,option_2,...,option_n. Where regex_filter stands " |
| + "for a list of include and exclude regular expression patterns (Also see " |
| + "--instrumentation_filter). option_1 to option_n stand for " |
| + "arbitrary command line options. If an option contains a comma it has to be " |
| + "quoted with a backslash. Options can contain @. Only the first @ is used to " |
| + "split the string. Example: " |
| + "--per_file_copt=//foo/.*\\.cc,-//foo/bar\\.cc@-O0 adds the -O0 " |
| + "command line option to the gcc command line of all cc files in //foo/ " |
| + "except bar.cc." |
| ) |
| public List<PerLabelOptions> perFileCopts; |
| |
| @Option( |
| name = "per_file_ltobackendopt", |
| allowMultiple = true, |
| converter = PerLabelOptions.PerLabelOptionsConverter.class, |
| defaultValue = "", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "Additional options to selectively pass to LTO backend (under --features=thin_lto) when " |
| + "compiling certain backend objects. This option can be passed multiple times. " |
| + "Syntax: regex_filter@option_1,option_2,...,option_n. Where regex_filter stands " |
| + "for a list of include and exclude regular expression patterns. " |
| + "option_1 to option_n stand for arbitrary command line options. " |
| + "If an option contains a comma it has to be quoted with a backslash. " |
| + "Options can contain @. Only the first @ is used to split the string. Example: " |
| + "--per_file_ltobackendopt=//foo/.*\\.o,-//foo/bar\\.o@-O0 adds the -O0 " |
| + "command line option to the LTO backend command line of all o files in //foo/ " |
| + "except bar.o." |
| ) |
| public List<PerLabelOptions> perFileLtoBackendOpts; |
| |
| @Option( |
| name = "host_crosstool_top", |
| defaultValue = "null", |
| converter = LabelConverter.class, |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = { |
| OptionEffectTag.LOADING_AND_ANALYSIS, |
| OptionEffectTag.CHANGES_INPUTS, |
| OptionEffectTag.AFFECTS_OUTPUTS |
| }, |
| help = |
| "By default, the --crosstool_top and --compiler options are also used " |
| + "for the host configuration. If this flag is provided, Bazel uses the default libc " |
| + "and compiler for the given crosstool_top." |
| ) |
| public Label hostCrosstoolTop; |
| |
| @Option( |
| name = "host_copt", |
| allowMultiple = true, |
| defaultValue = "", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Additional options to pass to gcc for host tools." |
| ) |
| public List<String> hostCoptList; |
| |
| @Option( |
| name = "host_cxxopt", |
| allowMultiple = true, |
| defaultValue = "", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Additional options to pass to gcc for host tools." |
| ) |
| public List<String> hostCxxoptList; |
| |
| @Option( |
| name = "host_conlyopt", |
| allowMultiple = true, |
| defaultValue = "", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Additional option to pass to gcc when compiling C source files for host tools." |
| ) |
| public List<String> hostConlyoptList; |
| |
| @Option( |
| name = "host_linkopt", |
| defaultValue = "", |
| allowMultiple = true, |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = "Additional option to pass to gcc when linking host tools." |
| ) |
| public List<String> hostLinkoptList; |
| |
| @Option( |
| name = "grte_top", |
| defaultValue = "null", // The default value is chosen by the toolchain. |
| converter = LibcTopLabelConverter.class, |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "A label to a checked-in libc library. The default value is selected by the crosstool " |
| + "toolchain, and you almost never need to override it." |
| ) |
| public Label libcTopLabel; |
| |
| @Option( |
| name = "host_grte_top", |
| defaultValue = "null", // The default value is chosen by the toolchain. |
| converter = LibcTopLabelConverter.class, |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "If specified, this setting overrides the libc top-level directory (--grte_top) " |
| + "for the host configuration." |
| ) |
| public Label hostLibcTopLabel; |
| |
| @Option( |
| name = "experimental_inmemory_dotd_files", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.BUILD_TIME_OPTIMIZATION, |
| effectTags = { |
| OptionEffectTag.LOADING_AND_ANALYSIS, |
| OptionEffectTag.EXECUTION, |
| OptionEffectTag.AFFECTS_OUTPUTS |
| }, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = |
| "If enabled, C++ .d files will be passed through in memory directly from the remote " |
| + "build nodes instead of being written to disk." |
| ) |
| public boolean inmemoryDotdFiles; |
| |
| @Option( |
| name = "parse_headers_verifies_modules", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.BUILD_TIME_OPTIMIZATION, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.CHANGES_INPUTS}, |
| help = |
| "If enabled, the parse_headers feature verifies that a header module can be built for the " |
| + "target in question instead of doing a separate compile of the header." |
| ) |
| public boolean parseHeadersVerifiesModules; |
| |
| @Option( |
| name = "experimental_omitfp", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.ACTION_COMMAND_LINES, OptionEffectTag.AFFECTS_OUTPUTS}, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = |
| "If true, use libunwind for stack unwinding, and compile with " |
| + "-fomit-frame-pointer and -fasynchronous-unwind-tables." |
| ) |
| public boolean experimentalOmitfp; |
| |
| @Option( |
| name = "share_native_deps", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.AFFECTS_OUTPUTS}, |
| help = |
| "If true, native libraries that contain identical functionality " |
| + "will be shared among different targets" |
| ) |
| public boolean shareNativeDeps; |
| |
| @Option( |
| name = "strict_system_includes", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.INPUT_STRICTNESS, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS, OptionEffectTag.EAGERNESS_TO_EXIT}, |
| help = |
| "If true, headers found through system include paths (-isystem) are also required to be " |
| + "declared." |
| ) |
| public boolean strictSystemIncludes; |
| |
| @Option( |
| name = "experimental_use_llvm_covmap", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, |
| effectTags = { |
| OptionEffectTag.CHANGES_INPUTS, |
| OptionEffectTag.AFFECTS_OUTPUTS, |
| OptionEffectTag.LOADING_AND_ANALYSIS |
| }, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = |
| "If specified, Bazel will generate llvm-cov coverage map information rather than " |
| + "gcov when collect_code_coverage is enabled." |
| ) |
| public boolean useLLVMCoverageMapFormat; |
| |
| @Option( |
| name = "incompatible_dont_enable_host_nonhost_crosstool_features", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If true, Bazel will not enable 'host' and 'nonhost' features in the c++ toolchain " |
| + "(see https://github.com/bazelbuild/bazel/issues/7407 for more information).") |
| public boolean dontEnableHostNonhost; |
| |
| @Option( |
| name = "incompatible_disable_legacy_crosstool_fields", |
| oldName = "experimental_disable_legacy_crosstool_fields", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If true, Bazel will not read crosstool flags from legacy crosstool fields " |
| + "(see https://github.com/bazelbuild/bazel/issues/6861 for migration instructions).") |
| public boolean disableLegacyCrosstoolFields; |
| |
| @Option( |
| name = "incompatible_remove_cpu_and_compiler_attributes_from_cc_toolchain", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If true, Bazel will complain when cc_toolchain.cpu and cc_toolchain.compiler attribtues " |
| + "are set " |
| + "(see https://github.com/bazelbuild/bazel/issues/7075 for migration instructions).") |
| public boolean removeCpuCompilerCcToolchainAttributes; |
| |
| @Option( |
| name = "incompatible_disable_expand_if_all_available_in_flag_set", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If true, Bazel will not allow specifying expand_if_all_available in flag_sets" |
| + "(see https://github.com/bazelbuild/bazel/issues/7008 for migration instructions).") |
| public boolean disableExpandIfAllAvailableInFlagSet; |
| |
| @Option( |
| name = "incompatible_disable_crosstool_file", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.TOOLCHAIN, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = { |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES, |
| OptionMetadataTag.INCOMPATIBLE_CHANGE |
| }, |
| help = |
| "If true, Bazel will not allow using the CROSSTOOL file for cc toolchain" |
| + " configuration. Instead, cc_toolchain should have a toolchain_config attribute" |
| + " that points to a rule written in Starlark that provides a CcToolchainConfigInfo" |
| + " provider. See https://github.com/bazelbuild/bazel/issues/7320 for more info.") |
| public boolean disableCrosstool; |
| |
| @Option( |
| name = "experimental_includes_attribute_subpackage_traversal", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.EXECUTION}, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = |
| "If a cc target has loose headers checking, disabled layering check and an " |
| + "includes attribute set, it is allowed to include anything under its folder, even " |
| + "across subpackage boundaries.") |
| public boolean experimentalIncludesAttributeSubpackageTraversal; |
| |
| @Option( |
| name = "incompatible_disable_depset_in_cc_user_flags", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If true, C++ toolchain Starlark API will not accept depset in `user_compile_flags` " |
| + "param of `create_compile_variables`, and in `user_link_flags` of " |
| + "`create_link_variables`. Use list instead.") |
| public boolean disableDepsetInUserFlags; |
| |
| @Option( |
| name = "experimental_do_not_use_cpu_transformer", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.EXECUTION}, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = "If enabled, cpu transformer is not used for CppConfiguration") |
| public boolean doNotUseCpuTransformer; |
| |
| @Option( |
| name = "incompatible_disable_genrule_cc_toolchain_dependency", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If true, genrule will no longer automatically depend on the cc toolchain. Specifically, " |
| + "this means that the CC_FLAGS Make variable will not be available without using " |
| + "the new cc_flags_supplier rule.") |
| public boolean disableGenruleCcToolchainDependency; |
| |
| @Option( |
| name = "incompatible_disable_legacy_cc_provider", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = "If true, the legacy provider accessible by 'dep.cc.' is removed. See #7036.") |
| // TODO(b/122328491): Document migration steps. See #7036. |
| public boolean disableLegacyCcProvider; |
| |
| @Option( |
| name = "incompatible_enable_cc_toolchain_resolution", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = "If true, cc rules use toolchain resolution to find the cc_toolchain.") |
| public boolean enableCcToolchainResolution; |
| |
| @Override |
| public FragmentOptions getHost() { |
| CppOptions host = (CppOptions) getDefault(); |
| |
| // The crosstool options are partially copied from the target configuration. |
| if (hostCrosstoolTop == null) { |
| host.cppCompiler = cppCompiler; |
| host.crosstoolTop = crosstoolTop; |
| } else { |
| host.crosstoolTop = hostCrosstoolTop; |
| host.cppCompiler = hostCppCompiler; |
| } |
| |
| // hostLibcTop doesn't default to the target's libcTop. |
| // Only an explicit command-line option will change it. |
| // The default is whatever the host's crosstool (which might have been specified |
| // by --host_crosstool_top, or --crosstool_top as a fallback) says it should be. |
| host.libcTopLabel = hostLibcTopLabel; |
| |
| // -g0 is the default, but allowMultiple options cannot have default values so we just pass |
| // -g0 first and let the user options override it. |
| ImmutableList.Builder<String> coptListBuilder = ImmutableList.builder(); |
| ImmutableList.Builder<String> cxxoptListBuilder = ImmutableList.builder(); |
| // Don't add -g0 if the host platform is Windows. |
| // Note that host platform is not necessarily the platform bazel is running on (foundry) |
| if (OS.getCurrent() != OS.WINDOWS) { |
| coptListBuilder.add("-g0"); |
| cxxoptListBuilder.add("-g0"); |
| } |
| host.coptList = coptListBuilder.addAll(hostCoptList).build(); |
| host.cxxoptList = cxxoptListBuilder.addAll(hostCxxoptList).build(); |
| host.conlyoptList = ImmutableList.copyOf(hostConlyoptList); |
| host.linkoptList = ImmutableList.copyOf(hostLinkoptList); |
| |
| host.useStartEndLib = useStartEndLib; |
| host.stripBinaries = StripMode.ALWAYS; |
| host.fdoOptimizeForBuild = null; |
| host.fdoProfileLabel = null; |
| host.xfdoProfileLabel = null; |
| host.inmemoryDotdFiles = inmemoryDotdFiles; |
| |
| host.doNotUseCpuTransformer = doNotUseCpuTransformer; |
| host.disableGenruleCcToolchainDependency = disableGenruleCcToolchainDependency; |
| host.disableDepsetInUserFlags = disableDepsetInUserFlags; |
| host.disableExpandIfAllAvailableInFlagSet = disableExpandIfAllAvailableInFlagSet; |
| host.disableLegacyCcProvider = disableLegacyCcProvider; |
| host.removeCpuCompilerCcToolchainAttributes = removeCpuCompilerCcToolchainAttributes; |
| host.disableLegacyCrosstoolFields = disableLegacyCrosstoolFields; |
| host.disableCrosstool = disableCrosstool; |
| host.enableCcToolchainResolution = enableCcToolchainResolution; |
| host.dontEnableHostNonhost = dontEnableHostNonhost; |
| return host; |
| } |
| |
| @Override |
| public Map<String, Set<Label>> getDefaultsLabels() { |
| Set<Label> crosstoolLabels = new LinkedHashSet<>(); |
| crosstoolLabels.add(crosstoolTop); |
| if (hostCrosstoolTop != null) { |
| crosstoolLabels.add(hostCrosstoolTop); |
| } |
| |
| if (libcTopLabel != null) { |
| Label libcLabel = libcTopLabel; |
| if (libcLabel != null) { |
| crosstoolLabels.add(libcLabel); |
| } |
| } |
| |
| return ImmutableMap.of("CROSSTOOL", crosstoolLabels); |
| } |
| |
| /** |
| * Returns true if targets under this configuration should apply FDO. |
| */ |
| public boolean isFdo() { |
| return getFdoOptimize() != null || fdoInstrumentForBuild != null || fdoProfileLabel != null; |
| } |
| } |
