Warning: That file was not part of the compilation database. It may have many parsing errors.

1//===--- Driver.h - Clang GCC Compatible Driver -----------------*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#ifndef LLVM_CLANG_DRIVER_DRIVER_H
11#define LLVM_CLANG_DRIVER_DRIVER_H
12
13#include "clang/Basic/Diagnostic.h"
14#include "clang/Basic/LLVM.h"
15#include "clang/Driver/Action.h"
16#include "clang/Driver/Phases.h"
17#include "clang/Driver/ToolChain.h"
18#include "clang/Driver/Types.h"
19#include "clang/Driver/Util.h"
20#include "llvm/ADT/StringMap.h"
21#include "llvm/ADT/StringRef.h"
22#include "llvm/Option/ArgList.h"
23#include "llvm/Support/StringSaver.h"
24
25#include <list>
26#include <map>
27#include <string>
28
29namespace llvm {
30class Triple;
31}
32
33namespace clang {
34
35namespace vfs {
36class FileSystem;
37}
38
39namespace driver {
40
41 class Command;
42 class Compilation;
43 class InputInfo;
44 class JobList;
45 class JobAction;
46 class SanitizerArgs;
47 class ToolChain;
48
49/// Describes the kind of LTO mode selected via -f(no-)?lto(=.*)? options.
50enum LTOKind {
51 LTOK_None,
52 LTOK_Full,
53 LTOK_Thin,
54 LTOK_Unknown
55};
56
57/// Driver - Encapsulate logic for constructing compilation processes
58/// from a set of gcc-driver-like command line arguments.
59class Driver {
60 std::unique_ptr<llvm::opt::OptTable> Opts;
61
62 DiagnosticsEngine &Diags;
63
64 IntrusiveRefCntPtr<vfs::FileSystem> VFS;
65
66 enum DriverMode {
67 GCCMode,
68 GXXMode,
69 CPPMode,
70 CLMode
71 } Mode;
72
73 enum SaveTempsMode {
74 SaveTempsNone,
75 SaveTempsCwd,
76 SaveTempsObj
77 } SaveTemps;
78
79 enum BitcodeEmbedMode {
80 EmbedNone,
81 EmbedMarker,
82 EmbedBitcode
83 } BitcodeEmbed;
84
85 /// LTO mode selected via -f(no-)?lto(=.*)? options.
86 LTOKind LTOMode;
87
88public:
89 enum OpenMPRuntimeKind {
90 /// An unknown OpenMP runtime. We can't generate effective OpenMP code
91 /// without knowing what runtime to target.
92 OMPRT_Unknown,
93
94 /// The LLVM OpenMP runtime. When completed and integrated, this will become
95 /// the default for Clang.
96 OMPRT_OMP,
97
98 /// The GNU OpenMP runtime. Clang doesn't support generating OpenMP code for
99 /// this runtime but can swallow the pragmas, and find and link against the
100 /// runtime library itself.
101 OMPRT_GOMP,
102
103 /// The legacy name for the LLVM OpenMP runtime from when it was the Intel
104 /// OpenMP runtime. We support this mode for users with existing
105 /// dependencies on this runtime library name.
106 OMPRT_IOMP5
107 };
108
109 // Diag - Forwarding function for diagnostics.
110 DiagnosticBuilder Diag(unsigned DiagID) const {
111 return Diags.Report(DiagID);
112 }
113
114 // FIXME: Privatize once interface is stable.
115public:
116 /// The name the driver was invoked as.
117 std::string Name;
118
119 /// The path the driver executable was in, as invoked from the
120 /// command line.
121 std::string Dir;
122
123 /// The original path to the clang executable.
124 std::string ClangExecutable;
125
126 /// Target and driver mode components extracted from clang executable name.
127 ParsedClangName ClangNameParts;
128
129 /// The path to the installed clang directory, if any.
130 std::string InstalledDir;
131
132 /// The path to the compiler resource directory.
133 std::string ResourceDir;
134
135 /// System directory for config files.
136 std::string SystemConfigDir;
137
138 /// User directory for config files.
139 std::string UserConfigDir;
140
141 /// A prefix directory used to emulate a limited subset of GCC's '-Bprefix'
142 /// functionality.
143 /// FIXME: This type of customization should be removed in favor of the
144 /// universal driver when it is ready.
145 typedef SmallVector<std::string, 4> prefix_list;
146 prefix_list PrefixDirs;
147
148 /// sysroot, if present
149 std::string SysRoot;
150
151 /// Dynamic loader prefix, if present
152 std::string DyldPrefix;
153
154 /// Driver title to use with help.
155 std::string DriverTitle;
156
157 /// Information about the host which can be overridden by the user.
158 std::string HostBits, HostMachine, HostSystem, HostRelease;
159
160 /// The file to log CC_PRINT_OPTIONS output to, if enabled.
161 const char *CCPrintOptionsFilename;
162
163 /// The file to log CC_PRINT_HEADERS output to, if enabled.
164 const char *CCPrintHeadersFilename;
165
166 /// The file to log CC_LOG_DIAGNOSTICS output to, if enabled.
167 const char *CCLogDiagnosticsFilename;
168
169 /// A list of inputs and their types for the given arguments.
170 typedef SmallVector<std::pair<types::ID, const llvm::opt::Arg *>, 16>
171 InputList;
172
173 /// Whether the driver should follow g++ like behavior.
174 bool CCCIsCXX() const { return Mode == GXXMode; }
175
176 /// Whether the driver is just the preprocessor.
177 bool CCCIsCPP() const { return Mode == CPPMode; }
178
179 /// Whether the driver should follow gcc like behavior.
180 bool CCCIsCC() const { return Mode == GCCMode; }
181
182 /// Whether the driver should follow cl.exe like behavior.
183 bool IsCLMode() const { return Mode == CLMode; }
184
185 /// Only print tool bindings, don't build any jobs.
186 unsigned CCCPrintBindings : 1;
187
188 /// Set CC_PRINT_OPTIONS mode, which is like -v but logs the commands to
189 /// CCPrintOptionsFilename or to stderr.
190 unsigned CCPrintOptions : 1;
191
192 /// Set CC_PRINT_HEADERS mode, which causes the frontend to log header include
193 /// information to CCPrintHeadersFilename or to stderr.
194 unsigned CCPrintHeaders : 1;
195
196 /// Set CC_LOG_DIAGNOSTICS mode, which causes the frontend to log diagnostics
197 /// to CCLogDiagnosticsFilename or to stderr, in a stable machine readable
198 /// format.
199 unsigned CCLogDiagnostics : 1;
200
201 /// Whether the driver is generating diagnostics for debugging purposes.
202 unsigned CCGenDiagnostics : 1;
203
204private:
205 /// Raw target triple.
206 std::string TargetTriple;
207
208 /// Name to use when invoking gcc/g++.
209 std::string CCCGenericGCCName;
210
211 /// Name of configuration file if used.
212 std::string ConfigFile;
213
214 /// Allocator for string saver.
215 llvm::BumpPtrAllocator Alloc;
216
217 /// Object that stores strings read from configuration file.
218 llvm::StringSaver Saver;
219
220 /// Arguments originated from configuration file.
221 std::unique_ptr<llvm::opt::InputArgList> CfgOptions;
222
223 /// Arguments originated from command line.
224 std::unique_ptr<llvm::opt::InputArgList> CLOptions;
225
226 /// Whether to check that input files exist when constructing compilation
227 /// jobs.
228 unsigned CheckInputsExist : 1;
229
230public:
231 /// Use lazy precompiled headers for PCH support.
232 unsigned CCCUsePCH : 1;
233
234 /// Force clang to emit reproducer for driver invocation. This is enabled
235 /// indirectly by setting FORCE_CLANG_DIAGNOSTICS_CRASH environment variable
236 /// or when using the -gen-reproducer driver flag.
237 unsigned GenReproducer : 1;
238
239private:
240 /// Certain options suppress the 'no input files' warning.
241 unsigned SuppressMissingInputWarning : 1;
242
243 std::list<std::string> TempFiles;
244 std::list<std::string> ResultFiles;
245
246 /// Cache of all the ToolChains in use by the driver.
247 ///
248 /// This maps from the string representation of a triple to a ToolChain
249 /// created targeting that triple. The driver owns all the ToolChain objects
250 /// stored in it, and will clean them up when torn down.
251 mutable llvm::StringMap<std::unique_ptr<ToolChain>> ToolChains;
252
253private:
254 /// TranslateInputArgs - Create a new derived argument list from the input
255 /// arguments, after applying the standard argument translations.
256 llvm::opt::DerivedArgList *
257 TranslateInputArgs(const llvm::opt::InputArgList &Args) const;
258
259 // getFinalPhase - Determine which compilation mode we are in and record
260 // which option we used to determine the final phase.
261 phases::ID getFinalPhase(const llvm::opt::DerivedArgList &DAL,
262 llvm::opt::Arg **FinalPhaseArg = nullptr) const;
263
264 // Before executing jobs, sets up response files for commands that need them.
265 void setUpResponseFiles(Compilation &C, Command &Cmd);
266
267 void generatePrefixedToolNames(StringRef Tool, const ToolChain &TC,
268 SmallVectorImpl<std::string> &Names) const;
269
270 /// Find the appropriate .crash diagonostic file for the child crash
271 /// under this driver and copy it out to a temporary destination with the
272 /// other reproducer related files (.sh, .cache, etc). If not found, suggest a
273 /// directory for the user to look at.
274 ///
275 /// \param ReproCrashFilename The file path to copy the .crash to.
276 /// \param CrashDiagDir The suggested directory for the user to look at
277 /// in case the search or copy fails.
278 ///
279 /// \returns If the .crash is found and successfully copied return true,
280 /// otherwise false and return the suggested directory in \p CrashDiagDir.
281 bool getCrashDiagnosticFile(StringRef ReproCrashFilename,
282 SmallString<128> &CrashDiagDir);
283
284public:
285 Driver(StringRef ClangExecutable, StringRef TargetTriple,
286 DiagnosticsEngine &Diags,
287 IntrusiveRefCntPtr<vfs::FileSystem> VFS = nullptr);
288
289 /// @name Accessors
290 /// @{
291
292 /// Name to use when invoking gcc/g++.
293 const std::string &getCCCGenericGCCName() const { return CCCGenericGCCName; }
294
295 const std::string &getConfigFile() const { return ConfigFile; }
296
297 const llvm::opt::OptTable &getOpts() const { return *Opts; }
298
299 const DiagnosticsEngine &getDiags() const { return Diags; }
300
301 vfs::FileSystem &getVFS() const { return *VFS; }
302
303 bool getCheckInputsExist() const { return CheckInputsExist; }
304
305 void setCheckInputsExist(bool Value) { CheckInputsExist = Value; }
306
307 void setTargetAndMode(const ParsedClangName &TM) { ClangNameParts = TM; }
308
309 const std::string &getTitle() { return DriverTitle; }
310 void setTitle(std::string Value) { DriverTitle = std::move(Value); }
311
312 std::string getTargetTriple() const { return TargetTriple; }
313
314 /// Get the path to the main clang executable.
315 const char *getClangProgramPath() const {
316 return ClangExecutable.c_str();
317 }
318
319 /// Get the path to where the clang executable was installed.
320 const char *getInstalledDir() const {
321 if (!InstalledDir.empty())
322 return InstalledDir.c_str();
323 return Dir.c_str();
324 }
325 void setInstalledDir(StringRef Value) {
326 InstalledDir = Value;
327 }
328
329 bool isSaveTempsEnabled() const { return SaveTemps != SaveTempsNone; }
330 bool isSaveTempsObj() const { return SaveTemps == SaveTempsObj; }
331
332 bool embedBitcodeEnabled() const { return BitcodeEmbed != EmbedNone; }
333 bool embedBitcodeInObject() const { return (BitcodeEmbed == EmbedBitcode); }
334 bool embedBitcodeMarkerOnly() const { return (BitcodeEmbed == EmbedMarker); }
335
336 /// Compute the desired OpenMP runtime from the flags provided.
337 OpenMPRuntimeKind getOpenMPRuntime(const llvm::opt::ArgList &Args) const;
338
339 /// @}
340 /// @name Primary Functionality
341 /// @{
342
343 /// CreateOffloadingDeviceToolChains - create all the toolchains required to
344 /// support offloading devices given the programming models specified in the
345 /// current compilation. Also, update the host tool chain kind accordingly.
346 void CreateOffloadingDeviceToolChains(Compilation &C, InputList &Inputs);
347
348 /// BuildCompilation - Construct a compilation object for a command
349 /// line argument vector.
350 ///
351 /// \return A compilation, or 0 if none was built for the given
352 /// argument vector. A null return value does not necessarily
353 /// indicate an error condition, the diagnostics should be queried
354 /// to determine if an error occurred.
355 Compilation *BuildCompilation(ArrayRef<const char *> Args);
356
357 /// @name Driver Steps
358 /// @{
359
360 /// ParseDriverMode - Look for and handle the driver mode option in Args.
361 void ParseDriverMode(StringRef ProgramName, ArrayRef<const char *> Args);
362
363 /// ParseArgStrings - Parse the given list of strings into an
364 /// ArgList.
365 llvm::opt::InputArgList ParseArgStrings(ArrayRef<const char *> Args,
366 bool &ContainsError);
367
368 /// BuildInputs - Construct the list of inputs and their types from
369 /// the given arguments.
370 ///
371 /// \param TC - The default host tool chain.
372 /// \param Args - The input arguments.
373 /// \param Inputs - The list to store the resulting compilation
374 /// inputs onto.
375 void BuildInputs(const ToolChain &TC, llvm::opt::DerivedArgList &Args,
376 InputList &Inputs) const;
377
378 /// BuildActions - Construct the list of actions to perform for the
379 /// given arguments, which are only done for a single architecture.
380 ///
381 /// \param C - The compilation that is being built.
382 /// \param Args - The input arguments.
383 /// \param Actions - The list to store the resulting actions onto.
384 void BuildActions(Compilation &C, llvm::opt::DerivedArgList &Args,
385 const InputList &Inputs, ActionList &Actions) const;
386
387 /// BuildUniversalActions - Construct the list of actions to perform
388 /// for the given arguments, which may require a universal build.
389 ///
390 /// \param C - The compilation that is being built.
391 /// \param TC - The default host tool chain.
392 void BuildUniversalActions(Compilation &C, const ToolChain &TC,
393 const InputList &BAInputs) const;
394
395 /// BuildJobs - Bind actions to concrete tools and translate
396 /// arguments to form the list of jobs to run.
397 ///
398 /// \param C - The compilation that is being built.
399 void BuildJobs(Compilation &C) const;
400
401 /// ExecuteCompilation - Execute the compilation according to the command line
402 /// arguments and return an appropriate exit code.
403 ///
404 /// This routine handles additional processing that must be done in addition
405 /// to just running the subprocesses, for example reporting errors, setting
406 /// up response files, removing temporary files, etc.
407 int ExecuteCompilation(Compilation &C,
408 SmallVectorImpl< std::pair<int, const Command *> > &FailingCommands);
409
410 /// Contains the files in the compilation diagnostic report generated by
411 /// generateCompilationDiagnostics.
412 struct CompilationDiagnosticReport {
413 llvm::SmallVector<std::string, 4> TemporaryFiles;
414 };
415
416 /// generateCompilationDiagnostics - Generate diagnostics information
417 /// including preprocessed source file(s).
418 ///
419 void generateCompilationDiagnostics(
420 Compilation &C, const Command &FailingCommand,
421 StringRef AdditionalInformation = "",
422 CompilationDiagnosticReport *GeneratedReport = nullptr);
423
424 /// @}
425 /// @name Helper Methods
426 /// @{
427
428 /// PrintActions - Print the list of actions.
429 void PrintActions(const Compilation &C) const;
430
431 /// PrintHelp - Print the help text.
432 ///
433 /// \param ShowHidden - Show hidden options.
434 void PrintHelp(bool ShowHidden) const;
435
436 /// PrintVersion - Print the driver version.
437 void PrintVersion(const Compilation &C, raw_ostream &OS) const;
438
439 /// GetFilePath - Lookup \p Name in the list of file search paths.
440 ///
441 /// \param TC - The tool chain for additional information on
442 /// directories to search.
443 //
444 // FIXME: This should be in CompilationInfo.
445 std::string GetFilePath(StringRef Name, const ToolChain &TC) const;
446
447 /// GetProgramPath - Lookup \p Name in the list of program search paths.
448 ///
449 /// \param TC - The provided tool chain for additional information on
450 /// directories to search.
451 //
452 // FIXME: This should be in CompilationInfo.
453 std::string GetProgramPath(StringRef Name, const ToolChain &TC) const;
454
455 /// HandleAutocompletions - Handle --autocomplete by searching and printing
456 /// possible flags, descriptions, and its arguments.
457 void HandleAutocompletions(StringRef PassedFlags) const;
458
459 /// HandleImmediateArgs - Handle any arguments which should be
460 /// treated before building actions or binding tools.
461 ///
462 /// \return Whether any compilation should be built for this
463 /// invocation.
464 bool HandleImmediateArgs(const Compilation &C);
465
466 /// ConstructAction - Construct the appropriate action to do for
467 /// \p Phase on the \p Input, taking in to account arguments
468 /// like -fsyntax-only or --analyze.
469 Action *ConstructPhaseAction(
470 Compilation &C, const llvm::opt::ArgList &Args, phases::ID Phase,
471 Action *Input,
472 Action::OffloadKind TargetDeviceOffloadKind = Action::OFK_None) const;
473
474 /// BuildJobsForAction - Construct the jobs to perform for the action \p A and
475 /// return an InputInfo for the result of running \p A. Will only construct
476 /// jobs for a given (Action, ToolChain, BoundArch, DeviceKind) tuple once.
477 InputInfo
478 BuildJobsForAction(Compilation &C, const Action *A, const ToolChain *TC,
479 StringRef BoundArch, bool AtTopLevel, bool MultipleArchs,
480 const char *LinkingOutput,
481 std::map<std::pair<const Action *, std::string>, InputInfo>
482 &CachedResults,
483 Action::OffloadKind TargetDeviceOffloadKind) const;
484
485 /// Returns the default name for linked images (e.g., "a.out").
486 const char *getDefaultImageName() const;
487
488 /// GetNamedOutputPath - Return the name to use for the output of
489 /// the action \p JA. The result is appended to the compilation's
490 /// list of temporary or result files, as appropriate.
491 ///
492 /// \param C - The compilation.
493 /// \param JA - The action of interest.
494 /// \param BaseInput - The original input file that this action was
495 /// triggered by.
496 /// \param BoundArch - The bound architecture.
497 /// \param AtTopLevel - Whether this is a "top-level" action.
498 /// \param MultipleArchs - Whether multiple -arch options were supplied.
499 /// \param NormalizedTriple - The normalized triple of the relevant target.
500 const char *GetNamedOutputPath(Compilation &C, const JobAction &JA,
501 const char *BaseInput, StringRef BoundArch,
502 bool AtTopLevel, bool MultipleArchs,
503 StringRef NormalizedTriple) const;
504
505 /// GetTemporaryPath - Return the pathname of a temporary file to use
506 /// as part of compilation; the file will have the given prefix and suffix.
507 ///
508 /// GCC goes to extra lengths here to be a bit more robust.
509 std::string GetTemporaryPath(StringRef Prefix, StringRef Suffix) const;
510
511 /// Return the pathname of the pch file in clang-cl mode.
512 std::string GetClPchPath(Compilation &C, StringRef BaseName) const;
513
514 /// ShouldUseClangCompiler - Should the clang compiler be used to
515 /// handle this action.
516 bool ShouldUseClangCompiler(const JobAction &JA) const;
517
518 /// Returns true if we are performing any kind of LTO.
519 bool isUsingLTO() const { return LTOMode != LTOK_None; }
520
521 /// Get the specific kind of LTO being performed.
522 LTOKind getLTOMode() const { return LTOMode; }
523
524private:
525
526 /// Tries to load options from configuration file.
527 ///
528 /// \returns true if error occurred.
529 bool loadConfigFile();
530
531 /// Read options from the specified file.
532 ///
533 /// \param [in] FileName File to read.
534 /// \returns true, if error occurred while reading.
535 bool readConfigFile(StringRef FileName);
536
537 /// Set the driver mode (cl, gcc, etc) from an option string of the form
538 /// --driver-mode=<mode>.
539 void setDriverModeFromOption(StringRef Opt);
540
541 /// Parse the \p Args list for LTO options and record the type of LTO
542 /// compilation based on which -f(no-)?lto(=.*)? option occurs last.
543 void setLTOMode(const llvm::opt::ArgList &Args);
544
545 /// Retrieves a ToolChain for a particular \p Target triple.
546 ///
547 /// Will cache ToolChains for the life of the driver object, and create them
548 /// on-demand.
549 const ToolChain &getToolChain(const llvm::opt::ArgList &Args,
550 const llvm::Triple &Target) const;
551
552 /// @}
553
554 /// Get bitmasks for which option flags to include and exclude based on
555 /// the driver mode.
556 std::pair<unsigned, unsigned> getIncludeExcludeOptionFlagMasks() const;
557
558 /// Helper used in BuildJobsForAction. Doesn't use the cache when building
559 /// jobs specifically for the given action, but will use the cache when
560 /// building jobs for the Action's inputs.
561 InputInfo BuildJobsForActionNoCache(
562 Compilation &C, const Action *A, const ToolChain *TC, StringRef BoundArch,
563 bool AtTopLevel, bool MultipleArchs, const char *LinkingOutput,
564 std::map<std::pair<const Action *, std::string>, InputInfo>
565 &CachedResults,
566 Action::OffloadKind TargetDeviceOffloadKind) const;
567
568public:
569 /// GetReleaseVersion - Parse (([0-9]+)(.([0-9]+)(.([0-9]+)?))?)? and
570 /// return the grouped values as integers. Numbers which are not
571 /// provided are set to 0.
572 ///
573 /// \return True if the entire string was parsed (9.2), or all
574 /// groups were parsed (10.3.5extrastuff). HadExtra is true if all
575 /// groups were parsed but extra characters remain at the end.
576 static bool GetReleaseVersion(StringRef Str, unsigned &Major, unsigned &Minor,
577 unsigned &Micro, bool &HadExtra);
578
579 /// Parse digits from a string \p Str and fulfill \p Digits with
580 /// the parsed numbers. This method assumes that the max number of
581 /// digits to look for is equal to Digits.size().
582 ///
583 /// \return True if the entire string was parsed and there are
584 /// no extra characters remaining at the end.
585 static bool GetReleaseVersion(StringRef Str,
586 MutableArrayRef<unsigned> Digits);
587 /// Compute the default -fmodule-cache-path.
588 static void getDefaultModuleCachePath(SmallVectorImpl<char> &Result);
589};
590
591/// \return True if the last defined optimization level is -Ofast.
592/// And False otherwise.
593bool isOptimizationLevelFast(const llvm::opt::ArgList &Args);
594
595} // end namespace driver
596} // end namespace clang
597
598#endif
599

Warning: That file was not part of the compilation database. It may have many parsing errors.