1 //===--- Driver.h - Clang GCC Compatible Driver -----------------*- C++ -*-===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 #ifndef LLVM_CLANG_DRIVER_DRIVER_H
10 #define LLVM_CLANG_DRIVER_DRIVER_H
12 #include "clang/Basic/Diagnostic.h"
13 #include "clang/Basic/LLVM.h"
14 #include "clang/Driver/Action.h"
15 #include "clang/Driver/Phases.h"
16 #include "clang/Driver/ToolChain.h"
17 #include "clang/Driver/Types.h"
18 #include "clang/Driver/Util.h"
19 #include "llvm/ADT/StringMap.h"
20 #include "llvm/ADT/StringRef.h"
21 #include "llvm/Option/ArgList.h"
22 #include "llvm/Support/StringSaver.h"
47 /// Describes the kind of LTO mode selected via -f(no-)?lto(=.*)? options.
55 /// Driver - Encapsulate logic for constructing compilation processes
56 /// from a set of gcc-driver-like command line arguments.
58 std::unique_ptr<llvm::opt::OptTable> Opts;
60 DiagnosticsEngine &Diags;
62 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS;
77 enum BitcodeEmbedMode {
83 /// LTO mode selected via -f(no-)?lto(=.*)? options.
87 enum OpenMPRuntimeKind {
88 /// An unknown OpenMP runtime. We can't generate effective OpenMP code
89 /// without knowing what runtime to target.
92 /// The LLVM OpenMP runtime. When completed and integrated, this will become
93 /// the default for Clang.
96 /// The GNU OpenMP runtime. Clang doesn't support generating OpenMP code for
97 /// this runtime but can swallow the pragmas, and find and link against the
98 /// runtime library itself.
101 /// The legacy name for the LLVM OpenMP runtime from when it was the Intel
102 /// OpenMP runtime. We support this mode for users with existing
103 /// dependencies on this runtime library name.
107 // Diag - Forwarding function for diagnostics.
108 DiagnosticBuilder Diag(unsigned DiagID) const {
109 return Diags.Report(DiagID);
112 // FIXME: Privatize once interface is stable.
114 /// The name the driver was invoked as.
117 /// The path the driver executable was in, as invoked from the
121 /// The original path to the clang executable.
122 std::string ClangExecutable;
124 /// Target and driver mode components extracted from clang executable name.
125 ParsedClangName ClangNameParts;
127 /// The path to the installed clang directory, if any.
128 std::string InstalledDir;
130 /// The path to the compiler resource directory.
131 std::string ResourceDir;
133 /// System directory for config files.
134 std::string SystemConfigDir;
136 /// User directory for config files.
137 std::string UserConfigDir;
139 /// A prefix directory used to emulate a limited subset of GCC's '-Bprefix'
141 /// FIXME: This type of customization should be removed in favor of the
142 /// universal driver when it is ready.
143 typedef SmallVector<std::string, 4> prefix_list;
144 prefix_list PrefixDirs;
146 /// sysroot, if present
149 /// Dynamic loader prefix, if present
150 std::string DyldPrefix;
152 /// Driver title to use with help.
153 std::string DriverTitle;
155 /// Information about the host which can be overridden by the user.
156 std::string HostBits, HostMachine, HostSystem, HostRelease;
158 /// The file to log CC_PRINT_OPTIONS output to, if enabled.
159 const char *CCPrintOptionsFilename;
161 /// The file to log CC_PRINT_HEADERS output to, if enabled.
162 const char *CCPrintHeadersFilename;
164 /// The file to log CC_LOG_DIAGNOSTICS output to, if enabled.
165 const char *CCLogDiagnosticsFilename;
167 /// A list of inputs and their types for the given arguments.
168 typedef SmallVector<std::pair<types::ID, const llvm::opt::Arg *>, 16>
171 /// Whether the driver should follow g++ like behavior.
172 bool CCCIsCXX() const { return Mode == GXXMode; }
174 /// Whether the driver is just the preprocessor.
175 bool CCCIsCPP() const { return Mode == CPPMode; }
177 /// Whether the driver should follow gcc like behavior.
178 bool CCCIsCC() const { return Mode == GCCMode; }
180 /// Whether the driver should follow cl.exe like behavior.
181 bool IsCLMode() const { return Mode == CLMode; }
183 /// Only print tool bindings, don't build any jobs.
184 unsigned CCCPrintBindings : 1;
186 /// Set CC_PRINT_OPTIONS mode, which is like -v but logs the commands to
187 /// CCPrintOptionsFilename or to stderr.
188 unsigned CCPrintOptions : 1;
190 /// Set CC_PRINT_HEADERS mode, which causes the frontend to log header include
191 /// information to CCPrintHeadersFilename or to stderr.
192 unsigned CCPrintHeaders : 1;
194 /// Set CC_LOG_DIAGNOSTICS mode, which causes the frontend to log diagnostics
195 /// to CCLogDiagnosticsFilename or to stderr, in a stable machine readable
197 unsigned CCLogDiagnostics : 1;
199 /// Whether the driver is generating diagnostics for debugging purposes.
200 unsigned CCGenDiagnostics : 1;
203 /// Raw target triple.
204 std::string TargetTriple;
206 /// Name to use when invoking gcc/g++.
207 std::string CCCGenericGCCName;
209 /// Name of configuration file if used.
210 std::string ConfigFile;
212 /// Allocator for string saver.
213 llvm::BumpPtrAllocator Alloc;
215 /// Object that stores strings read from configuration file.
216 llvm::StringSaver Saver;
218 /// Arguments originated from configuration file.
219 std::unique_ptr<llvm::opt::InputArgList> CfgOptions;
221 /// Arguments originated from command line.
222 std::unique_ptr<llvm::opt::InputArgList> CLOptions;
224 /// Whether to check that input files exist when constructing compilation
226 unsigned CheckInputsExist : 1;
229 /// Force clang to emit reproducer for driver invocation. This is enabled
230 /// indirectly by setting FORCE_CLANG_DIAGNOSTICS_CRASH environment variable
231 /// or when using the -gen-reproducer driver flag.
232 unsigned GenReproducer : 1;
235 /// Certain options suppress the 'no input files' warning.
236 unsigned SuppressMissingInputWarning : 1;
238 /// Cache of all the ToolChains in use by the driver.
240 /// This maps from the string representation of a triple to a ToolChain
241 /// created targeting that triple. The driver owns all the ToolChain objects
242 /// stored in it, and will clean them up when torn down.
243 mutable llvm::StringMap<std::unique_ptr<ToolChain>> ToolChains;
246 /// TranslateInputArgs - Create a new derived argument list from the input
247 /// arguments, after applying the standard argument translations.
248 llvm::opt::DerivedArgList *
249 TranslateInputArgs(const llvm::opt::InputArgList &Args) const;
251 // getFinalPhase - Determine which compilation mode we are in and record
252 // which option we used to determine the final phase.
253 phases::ID getFinalPhase(const llvm::opt::DerivedArgList &DAL,
254 llvm::opt::Arg **FinalPhaseArg = nullptr) const;
256 // Before executing jobs, sets up response files for commands that need them.
257 void setUpResponseFiles(Compilation &C, Command &Cmd);
259 void generatePrefixedToolNames(StringRef Tool, const ToolChain &TC,
260 SmallVectorImpl<std::string> &Names) const;
262 /// Find the appropriate .crash diagonostic file for the child crash
263 /// under this driver and copy it out to a temporary destination with the
264 /// other reproducer related files (.sh, .cache, etc). If not found, suggest a
265 /// directory for the user to look at.
267 /// \param ReproCrashFilename The file path to copy the .crash to.
268 /// \param CrashDiagDir The suggested directory for the user to look at
269 /// in case the search or copy fails.
271 /// \returns If the .crash is found and successfully copied return true,
272 /// otherwise false and return the suggested directory in \p CrashDiagDir.
273 bool getCrashDiagnosticFile(StringRef ReproCrashFilename,
274 SmallString<128> &CrashDiagDir);
278 /// Takes the path to a binary that's either in bin/ or lib/ and returns
279 /// the path to clang's resource directory.
280 static std::string GetResourcesPath(StringRef BinaryPath,
281 StringRef CustomResourceDir = "");
283 Driver(StringRef ClangExecutable, StringRef TargetTriple,
284 DiagnosticsEngine &Diags,
285 IntrusiveRefCntPtr<llvm::vfs::FileSystem> VFS = nullptr);
290 /// Name to use when invoking gcc/g++.
291 const std::string &getCCCGenericGCCName() const { return CCCGenericGCCName; }
293 const std::string &getConfigFile() const { return ConfigFile; }
295 const llvm::opt::OptTable &getOpts() const { return *Opts; }
297 const DiagnosticsEngine &getDiags() const { return Diags; }
299 llvm::vfs::FileSystem &getVFS() const { return *VFS; }
301 bool getCheckInputsExist() const { return CheckInputsExist; }
303 void setCheckInputsExist(bool Value) { CheckInputsExist = Value; }
305 void setTargetAndMode(const ParsedClangName &TM) { ClangNameParts = TM; }
307 const std::string &getTitle() { return DriverTitle; }
308 void setTitle(std::string Value) { DriverTitle = std::move(Value); }
310 std::string getTargetTriple() const { return TargetTriple; }
312 /// Get the path to the main clang executable.
313 const char *getClangProgramPath() const {
314 return ClangExecutable.c_str();
317 /// Get the path to where the clang executable was installed.
318 const char *getInstalledDir() const {
319 if (!InstalledDir.empty())
320 return InstalledDir.c_str();
323 void setInstalledDir(StringRef Value) {
324 InstalledDir = Value;
327 bool isSaveTempsEnabled() const { return SaveTemps != SaveTempsNone; }
328 bool isSaveTempsObj() const { return SaveTemps == SaveTempsObj; }
330 bool embedBitcodeEnabled() const { return BitcodeEmbed != EmbedNone; }
331 bool embedBitcodeInObject() const { return (BitcodeEmbed == EmbedBitcode); }
332 bool embedBitcodeMarkerOnly() const { return (BitcodeEmbed == EmbedMarker); }
334 /// Compute the desired OpenMP runtime from the flags provided.
335 OpenMPRuntimeKind getOpenMPRuntime(const llvm::opt::ArgList &Args) const;
338 /// @name Primary Functionality
341 /// CreateOffloadingDeviceToolChains - create all the toolchains required to
342 /// support offloading devices given the programming models specified in the
343 /// current compilation. Also, update the host tool chain kind accordingly.
344 void CreateOffloadingDeviceToolChains(Compilation &C, InputList &Inputs);
346 /// BuildCompilation - Construct a compilation object for a command
347 /// line argument vector.
349 /// \return A compilation, or 0 if none was built for the given
350 /// argument vector. A null return value does not necessarily
351 /// indicate an error condition, the diagnostics should be queried
352 /// to determine if an error occurred.
353 Compilation *BuildCompilation(ArrayRef<const char *> Args);
355 /// @name Driver Steps
358 /// ParseDriverMode - Look for and handle the driver mode option in Args.
359 void ParseDriverMode(StringRef ProgramName, ArrayRef<const char *> Args);
361 /// ParseArgStrings - Parse the given list of strings into an
363 llvm::opt::InputArgList ParseArgStrings(ArrayRef<const char *> Args,
365 bool &ContainsError);
367 /// BuildInputs - Construct the list of inputs and their types from
368 /// the given arguments.
370 /// \param TC - The default host tool chain.
371 /// \param Args - The input arguments.
372 /// \param Inputs - The list to store the resulting compilation
374 void BuildInputs(const ToolChain &TC, llvm::opt::DerivedArgList &Args,
375 InputList &Inputs) const;
377 /// BuildActions - Construct the list of actions to perform for the
378 /// given arguments, which are only done for a single architecture.
380 /// \param C - The compilation that is being built.
381 /// \param Args - The input arguments.
382 /// \param Actions - The list to store the resulting actions onto.
383 void BuildActions(Compilation &C, llvm::opt::DerivedArgList &Args,
384 const InputList &Inputs, ActionList &Actions) const;
386 /// BuildUniversalActions - Construct the list of actions to perform
387 /// for the given arguments, which may require a universal build.
389 /// \param C - The compilation that is being built.
390 /// \param TC - The default host tool chain.
391 void BuildUniversalActions(Compilation &C, const ToolChain &TC,
392 const InputList &BAInputs) const;
394 /// Check that the file referenced by Value exists. If it doesn't,
395 /// issue a diagnostic and return false.
396 /// If TypoCorrect is true and the file does not exist, see if it looks
397 /// like a likely typo for a flag and if so print a "did you mean" blurb.
398 bool DiagnoseInputExistence(const llvm::opt::DerivedArgList &Args,
399 StringRef Value, types::ID Ty,
400 bool TypoCorrect) const;
402 /// BuildJobs - Bind actions to concrete tools and translate
403 /// arguments to form the list of jobs to run.
405 /// \param C - The compilation that is being built.
406 void BuildJobs(Compilation &C) const;
408 /// ExecuteCompilation - Execute the compilation according to the command line
409 /// arguments and return an appropriate exit code.
411 /// This routine handles additional processing that must be done in addition
412 /// to just running the subprocesses, for example reporting errors, setting
413 /// up response files, removing temporary files, etc.
414 int ExecuteCompilation(Compilation &C,
415 SmallVectorImpl< std::pair<int, const Command *> > &FailingCommands);
417 /// Contains the files in the compilation diagnostic report generated by
418 /// generateCompilationDiagnostics.
419 struct CompilationDiagnosticReport {
420 llvm::SmallVector<std::string, 4> TemporaryFiles;
423 /// generateCompilationDiagnostics - Generate diagnostics information
424 /// including preprocessed source file(s).
426 void generateCompilationDiagnostics(
427 Compilation &C, const Command &FailingCommand,
428 StringRef AdditionalInformation = "",
429 CompilationDiagnosticReport *GeneratedReport = nullptr);
432 /// @name Helper Methods
435 /// PrintActions - Print the list of actions.
436 void PrintActions(const Compilation &C) const;
438 /// PrintHelp - Print the help text.
440 /// \param ShowHidden - Show hidden options.
441 void PrintHelp(bool ShowHidden) const;
443 /// PrintVersion - Print the driver version.
444 void PrintVersion(const Compilation &C, raw_ostream &OS) const;
446 /// GetFilePath - Lookup \p Name in the list of file search paths.
448 /// \param TC - The tool chain for additional information on
449 /// directories to search.
451 // FIXME: This should be in CompilationInfo.
452 std::string GetFilePath(StringRef Name, const ToolChain &TC) const;
454 /// GetProgramPath - Lookup \p Name in the list of program search paths.
456 /// \param TC - The provided tool chain for additional information on
457 /// directories to search.
459 // FIXME: This should be in CompilationInfo.
460 std::string GetProgramPath(StringRef Name, const ToolChain &TC) const;
462 /// HandleAutocompletions - Handle --autocomplete by searching and printing
463 /// possible flags, descriptions, and its arguments.
464 void HandleAutocompletions(StringRef PassedFlags) const;
466 /// HandleImmediateArgs - Handle any arguments which should be
467 /// treated before building actions or binding tools.
469 /// \return Whether any compilation should be built for this
471 bool HandleImmediateArgs(const Compilation &C);
473 /// ConstructAction - Construct the appropriate action to do for
474 /// \p Phase on the \p Input, taking in to account arguments
475 /// like -fsyntax-only or --analyze.
476 Action *ConstructPhaseAction(
477 Compilation &C, const llvm::opt::ArgList &Args, phases::ID Phase,
479 Action::OffloadKind TargetDeviceOffloadKind = Action::OFK_None) const;
481 /// BuildJobsForAction - Construct the jobs to perform for the action \p A and
482 /// return an InputInfo for the result of running \p A. Will only construct
483 /// jobs for a given (Action, ToolChain, BoundArch, DeviceKind) tuple once.
485 BuildJobsForAction(Compilation &C, const Action *A, const ToolChain *TC,
486 StringRef BoundArch, bool AtTopLevel, bool MultipleArchs,
487 const char *LinkingOutput,
488 std::map<std::pair<const Action *, std::string>, InputInfo>
490 Action::OffloadKind TargetDeviceOffloadKind) const;
492 /// Returns the default name for linked images (e.g., "a.out").
493 const char *getDefaultImageName() const;
495 /// GetNamedOutputPath - Return the name to use for the output of
496 /// the action \p JA. The result is appended to the compilation's
497 /// list of temporary or result files, as appropriate.
499 /// \param C - The compilation.
500 /// \param JA - The action of interest.
501 /// \param BaseInput - The original input file that this action was
503 /// \param BoundArch - The bound architecture.
504 /// \param AtTopLevel - Whether this is a "top-level" action.
505 /// \param MultipleArchs - Whether multiple -arch options were supplied.
506 /// \param NormalizedTriple - The normalized triple of the relevant target.
507 const char *GetNamedOutputPath(Compilation &C, const JobAction &JA,
508 const char *BaseInput, StringRef BoundArch,
509 bool AtTopLevel, bool MultipleArchs,
510 StringRef NormalizedTriple) const;
512 /// GetTemporaryPath - Return the pathname of a temporary file to use
513 /// as part of compilation; the file will have the given prefix and suffix.
515 /// GCC goes to extra lengths here to be a bit more robust.
516 std::string GetTemporaryPath(StringRef Prefix, StringRef Suffix) const;
518 /// GetTemporaryDirectory - Return the pathname of a temporary directory to
519 /// use as part of compilation; the directory will have the given prefix.
520 std::string GetTemporaryDirectory(StringRef Prefix) const;
522 /// Return the pathname of the pch file in clang-cl mode.
523 std::string GetClPchPath(Compilation &C, StringRef BaseName) const;
525 /// ShouldUseClangCompiler - Should the clang compiler be used to
526 /// handle this action.
527 bool ShouldUseClangCompiler(const JobAction &JA) const;
529 /// Returns true if we are performing any kind of LTO.
530 bool isUsingLTO() const { return LTOMode != LTOK_None; }
532 /// Get the specific kind of LTO being performed.
533 LTOKind getLTOMode() const { return LTOMode; }
537 /// Tries to load options from configuration file.
539 /// \returns true if error occurred.
540 bool loadConfigFile();
542 /// Read options from the specified file.
544 /// \param [in] FileName File to read.
545 /// \returns true, if error occurred while reading.
546 bool readConfigFile(StringRef FileName);
548 /// Set the driver mode (cl, gcc, etc) from an option string of the form
549 /// --driver-mode=<mode>.
550 void setDriverModeFromOption(StringRef Opt);
552 /// Parse the \p Args list for LTO options and record the type of LTO
553 /// compilation based on which -f(no-)?lto(=.*)? option occurs last.
554 void setLTOMode(const llvm::opt::ArgList &Args);
556 /// Retrieves a ToolChain for a particular \p Target triple.
558 /// Will cache ToolChains for the life of the driver object, and create them
560 const ToolChain &getToolChain(const llvm::opt::ArgList &Args,
561 const llvm::Triple &Target) const;
565 /// Get bitmasks for which option flags to include and exclude based on
567 std::pair<unsigned, unsigned> getIncludeExcludeOptionFlagMasks(bool IsClCompatMode) const;
569 /// Helper used in BuildJobsForAction. Doesn't use the cache when building
570 /// jobs specifically for the given action, but will use the cache when
571 /// building jobs for the Action's inputs.
572 InputInfo BuildJobsForActionNoCache(
573 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
574 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
575 std::map<std::pair<const Action *, std::string>, InputInfo>
577 Action::OffloadKind TargetDeviceOffloadKind) const;
580 /// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and
581 /// return the grouped values as integers. Numbers which are not
582 /// provided are set to 0.
584 /// \return True if the entire string was parsed (9.2), or all
585 /// groups were parsed (10.3.5extrastuff). HadExtra is true if all
586 /// groups were parsed but extra characters remain at the end.
587 static bool GetReleaseVersion(StringRef Str, unsigned &Major, unsigned &Minor,
588 unsigned &Micro, bool &HadExtra);
590 /// Parse digits from a string \p Str and fulfill \p Digits with
591 /// the parsed numbers. This method assumes that the max number of
592 /// digits to look for is equal to Digits.size().
594 /// \return True if the entire string was parsed and there are
595 /// no extra characters remaining at the end.
596 static bool GetReleaseVersion(StringRef Str,
597 MutableArrayRef<unsigned> Digits);
598 /// Compute the default -fmodule-cache-path.
599 static void getDefaultModuleCachePath(SmallVectorImpl<char> &Result);
602 /// \return True if the last defined optimization level is -Ofast.
603 /// And False otherwise.
604 bool isOptimizationLevelFast(const llvm::opt::ArgList &Args);
606 } // end namespace driver
607 } // end namespace clang