1 | |
2 | |
3 | |
4 | |
5 | |
6 | |
7 | |
8 | |
9 | #ifndef LLVM_CLANG_DRIVER_TOOLCHAIN_H |
10 | #define LLVM_CLANG_DRIVER_TOOLCHAIN_H |
11 | |
12 | #include "clang/Basic/DebugInfoOptions.h" |
13 | #include "clang/Basic/LLVM.h" |
14 | #include "clang/Basic/LangOptions.h" |
15 | #include "clang/Basic/Sanitizers.h" |
16 | #include "clang/Driver/Action.h" |
17 | #include "clang/Driver/Multilib.h" |
18 | #include "clang/Driver/Types.h" |
19 | #include "llvm/ADT/ArrayRef.h" |
20 | #include "llvm/ADT/SmallVector.h" |
21 | #include "llvm/ADT/StringRef.h" |
22 | #include "llvm/ADT/Triple.h" |
23 | #include "llvm/MC/MCTargetOptions.h" |
24 | #include "llvm/Option/Option.h" |
25 | #include "llvm/Support/VersionTuple.h" |
26 | #include "llvm/Target/TargetOptions.h" |
27 | #include <cassert> |
28 | #include <memory> |
29 | #include <string> |
30 | #include <utility> |
31 | |
32 | namespace llvm { |
33 | namespace opt { |
34 | |
35 | class Arg; |
36 | class ArgList; |
37 | class DerivedArgList; |
38 | |
39 | } |
40 | namespace vfs { |
41 | |
42 | class FileSystem; |
43 | |
44 | } |
45 | } |
46 | |
47 | namespace clang { |
48 | |
49 | class ObjCRuntime; |
50 | |
51 | namespace driver { |
52 | |
53 | class Driver; |
54 | class InputInfo; |
55 | class SanitizerArgs; |
56 | class Tool; |
57 | class XRayArgs; |
58 | |
59 | |
60 | |
61 | struct ParsedClangName { |
62 | |
63 | std::string TargetPrefix; |
64 | |
65 | |
66 | std::string ModeSuffix; |
67 | |
68 | |
69 | const char *DriverMode = nullptr; |
70 | |
71 | |
72 | bool TargetIsValid = false; |
73 | |
74 | ParsedClangName() = default; |
75 | ParsedClangName(std::string Suffix, const char *Mode) |
76 | : ModeSuffix(Suffix), DriverMode(Mode) {} |
77 | ParsedClangName(std::string Target, std::string Suffix, const char *Mode, |
78 | bool IsRegistered) |
79 | : TargetPrefix(Target), ModeSuffix(Suffix), DriverMode(Mode), |
80 | TargetIsValid(IsRegistered) {} |
81 | |
82 | bool isEmpty() const { |
83 | return TargetPrefix.empty() && ModeSuffix.empty() && DriverMode == nullptr; |
84 | } |
85 | }; |
86 | |
87 | |
88 | class ToolChain { |
89 | public: |
90 | using path_list = SmallVector<std::string, 16>; |
91 | |
92 | enum CXXStdlibType { |
93 | CST_Libcxx, |
94 | CST_Libstdcxx |
95 | }; |
96 | |
97 | enum RuntimeLibType { |
98 | RLT_CompilerRT, |
99 | RLT_Libgcc |
100 | }; |
101 | |
102 | enum UnwindLibType { |
103 | UNW_None, |
104 | UNW_CompilerRT, |
105 | UNW_Libgcc |
106 | }; |
107 | |
108 | enum RTTIMode { |
109 | RM_Enabled, |
110 | RM_Disabled, |
111 | }; |
112 | |
113 | enum FileType { FT_Object, FT_Static, FT_Shared }; |
114 | |
115 | private: |
116 | friend class RegisterEffectiveTriple; |
117 | |
118 | const Driver &D; |
119 | llvm::Triple Triple; |
120 | const llvm::opt::ArgList &Args; |
121 | |
122 | |
123 | const llvm::opt::Arg *const CachedRTTIArg; |
124 | |
125 | const RTTIMode CachedRTTIMode; |
126 | |
127 | |
128 | path_list LibraryPaths; |
129 | |
130 | |
131 | path_list FilePaths; |
132 | |
133 | |
134 | path_list ProgramPaths; |
135 | |
136 | mutable std::unique_ptr<Tool> Clang; |
137 | mutable std::unique_ptr<Tool> Assemble; |
138 | mutable std::unique_ptr<Tool> Link; |
139 | mutable std::unique_ptr<Tool> OffloadBundler; |
140 | |
141 | Tool *getClang() const; |
142 | Tool *getAssemble() const; |
143 | Tool *getLink() const; |
144 | Tool *getClangAs() const; |
145 | Tool *getOffloadBundler() const; |
146 | |
147 | mutable std::unique_ptr<SanitizerArgs> SanitizerArguments; |
148 | mutable std::unique_ptr<XRayArgs> XRayArguments; |
149 | |
150 | |
151 | mutable llvm::Triple EffectiveTriple; |
152 | |
153 | |
154 | void setEffectiveTriple(llvm::Triple ET) const { |
155 | EffectiveTriple = std::move(ET); |
156 | } |
157 | |
158 | protected: |
159 | MultilibSet Multilibs; |
160 | Multilib SelectedMultilib; |
161 | |
162 | ToolChain(const Driver &D, const llvm::Triple &T, |
163 | const llvm::opt::ArgList &Args); |
164 | |
165 | void setTripleEnvironment(llvm::Triple::EnvironmentType Env); |
166 | |
167 | virtual Tool *buildAssembler() const; |
168 | virtual Tool *buildLinker() const; |
169 | virtual Tool *getTool(Action::ActionClass AC) const; |
170 | |
171 | |
172 | |
173 | static void addSystemInclude(const llvm::opt::ArgList &DriverArgs, |
174 | llvm::opt::ArgStringList &CC1Args, |
175 | const Twine &Path); |
176 | static void addExternCSystemInclude(const llvm::opt::ArgList &DriverArgs, |
177 | llvm::opt::ArgStringList &CC1Args, |
178 | const Twine &Path); |
179 | static void |
180 | addExternCSystemIncludeIfExists(const llvm::opt::ArgList &DriverArgs, |
181 | llvm::opt::ArgStringList &CC1Args, |
182 | const Twine &Path); |
183 | static void addSystemIncludes(const llvm::opt::ArgList &DriverArgs, |
184 | llvm::opt::ArgStringList &CC1Args, |
185 | ArrayRef<StringRef> Paths); |
186 | |
187 | |
188 | public: |
189 | virtual ~ToolChain(); |
190 | |
191 | |
192 | |
193 | const Driver &getDriver() const { return D; } |
194 | llvm::vfs::FileSystem &getVFS() const; |
195 | const llvm::Triple &getTriple() const { return Triple; } |
196 | |
197 | |
198 | |
199 | |
200 | |
201 | |
202 | virtual const llvm::Triple *getAuxTriple() const { return nullptr; } |
203 | |
204 | |
205 | |
206 | |
207 | virtual std::string getInputFilename(const InputInfo &Input) const; |
208 | |
209 | llvm::Triple::ArchType getArch() const { return Triple.getArch(); } |
210 | StringRef getArchName() const { return Triple.getArchName(); } |
211 | StringRef getPlatform() const { return Triple.getVendorName(); } |
212 | StringRef getOS() const { return Triple.getOSName(); } |
213 | |
214 | |
215 | |
216 | StringRef getDefaultUniversalArchName() const; |
217 | |
218 | std::string getTripleString() const { |
219 | return Triple.getTriple(); |
220 | } |
221 | |
222 | |
223 | const llvm::Triple &getEffectiveTriple() const { |
224 | (0) . __assert_fail ("!EffectiveTriple.getTriple().empty() && \"No effective triple\"", "/home/seafit/code_projects/clang_source/clang/include/clang/Driver/ToolChain.h", 224, __PRETTY_FUNCTION__))" file_link="../../../../include/assert.h.html#88" macro="true">assert(!EffectiveTriple.getTriple().empty() && "No effective triple"); |
225 | return EffectiveTriple; |
226 | } |
227 | |
228 | path_list &getLibraryPaths() { return LibraryPaths; } |
229 | const path_list &getLibraryPaths() const { return LibraryPaths; } |
230 | |
231 | path_list &getFilePaths() { return FilePaths; } |
232 | const path_list &getFilePaths() const { return FilePaths; } |
233 | |
234 | path_list &getProgramPaths() { return ProgramPaths; } |
235 | const path_list &getProgramPaths() const { return ProgramPaths; } |
236 | |
237 | const MultilibSet &getMultilibs() const { return Multilibs; } |
238 | |
239 | const Multilib &getMultilib() const { return SelectedMultilib; } |
240 | |
241 | const SanitizerArgs& getSanitizerArgs() const; |
242 | |
243 | const XRayArgs& getXRayArgs() const; |
244 | |
245 | |
246 | const llvm::opt::Arg *getRTTIArg() const { return CachedRTTIArg; } |
247 | |
248 | |
249 | RTTIMode getRTTIMode() const { return CachedRTTIMode; } |
250 | |
251 | |
252 | |
253 | |
254 | |
255 | |
256 | |
257 | |
258 | |
259 | |
260 | |
261 | |
262 | |
263 | |
264 | |
265 | static ParsedClangName getTargetAndModeFromProgramName(StringRef ProgName); |
266 | |
267 | |
268 | |
269 | |
270 | |
271 | |
272 | |
273 | |
274 | |
275 | |
276 | |
277 | virtual llvm::opt::DerivedArgList * |
278 | TranslateArgs(const llvm::opt::DerivedArgList &Args, StringRef BoundArch, |
279 | Action::OffloadKind DeviceOffloadKind) const { |
280 | return nullptr; |
281 | } |
282 | |
283 | |
284 | |
285 | |
286 | virtual llvm::opt::DerivedArgList *TranslateOpenMPTargetArgs( |
287 | const llvm::opt::DerivedArgList &Args, bool SameTripleAsHost, |
288 | SmallVectorImpl<llvm::opt::Arg *> &AllocatedArgs) const; |
289 | |
290 | |
291 | |
292 | |
293 | |
294 | virtual Tool *SelectTool(const JobAction &JA) const; |
295 | |
296 | |
297 | |
298 | std::string GetFilePath(const char *Name) const; |
299 | std::string GetProgramPath(const char *Name) const; |
300 | |
301 | |
302 | |
303 | std::string GetLinkerPath() const; |
304 | |
305 | |
306 | |
307 | |
308 | |
309 | |
310 | virtual void printVerboseInfo(raw_ostream &OS) const {} |
311 | |
312 | |
313 | |
314 | |
315 | |
316 | virtual bool isCrossCompiling() const; |
317 | |
318 | |
319 | |
320 | virtual bool HasNativeLLVMSupport() const; |
321 | |
322 | |
323 | |
324 | virtual types::ID LookupTypeForExtension(StringRef Ext) const; |
325 | |
326 | |
327 | virtual bool IsBlocksDefault() const { return false; } |
328 | |
329 | |
330 | |
331 | virtual bool IsIntegratedAssemblerDefault() const { return false; } |
332 | |
333 | |
334 | virtual bool useIntegratedAs() const; |
335 | |
336 | |
337 | virtual bool IsMathErrnoDefault() const { return true; } |
338 | |
339 | |
340 | |
341 | virtual bool IsEncodeExtendedBlockSignatureDefault() const { return false; } |
342 | |
343 | |
344 | |
345 | virtual bool IsObjCNonFragileABIDefault() const { return false; } |
346 | |
347 | |
348 | |
349 | virtual bool UseObjCMixedDispatch() const { return false; } |
350 | |
351 | |
352 | virtual bool useRelaxRelocations() const; |
353 | |
354 | |
355 | |
356 | virtual unsigned GetDefaultStackProtectorLevel(bool KernelOrKext) const { |
357 | return 0; |
358 | } |
359 | |
360 | |
361 | virtual LangOptions::TrivialAutoVarInitKind |
362 | GetDefaultTrivialAutoVarInit() const { |
363 | return LangOptions::TrivialAutoVarInitKind::Uninitialized; |
364 | } |
365 | |
366 | |
367 | virtual const char *getDefaultLinker() const { return "ld"; } |
368 | |
369 | |
370 | virtual RuntimeLibType GetDefaultRuntimeLibType() const { |
371 | return ToolChain::RLT_Libgcc; |
372 | } |
373 | |
374 | virtual CXXStdlibType GetDefaultCXXStdlibType() const { |
375 | return ToolChain::CST_Libstdcxx; |
376 | } |
377 | |
378 | virtual UnwindLibType GetDefaultUnwindLibType() const { |
379 | return ToolChain::UNW_None; |
380 | } |
381 | |
382 | virtual std::string getCompilerRTPath() const; |
383 | |
384 | virtual std::string getCompilerRT(const llvm::opt::ArgList &Args, |
385 | StringRef Component, |
386 | FileType Type = ToolChain::FT_Static) const; |
387 | |
388 | const char * |
389 | getCompilerRTArgString(const llvm::opt::ArgList &Args, StringRef Component, |
390 | FileType Type = ToolChain::FT_Static) const; |
391 | |
392 | |
393 | |
394 | std::string getArchSpecificLibPath() const; |
395 | |
396 | |
397 | StringRef getOSLibName() const; |
398 | |
399 | |
400 | static bool needsProfileRT(const llvm::opt::ArgList &Args); |
401 | |
402 | |
403 | static bool needsGCovInstrumentation(const llvm::opt::ArgList &Args); |
404 | |
405 | |
406 | |
407 | virtual bool IsUnwindTablesDefault(const llvm::opt::ArgList &Args) const; |
408 | |
409 | |
410 | virtual bool isPICDefault() const = 0; |
411 | |
412 | |
413 | virtual bool isPIEDefault() const = 0; |
414 | |
415 | |
416 | virtual bool isNoExecStackDefault() const; |
417 | |
418 | |
419 | |
420 | |
421 | |
422 | virtual bool isPICDefaultForced() const = 0; |
423 | |
424 | |
425 | virtual bool SupportsProfiling() const { return true; } |
426 | |
427 | |
428 | virtual void CheckObjCARC() const {} |
429 | |
430 | |
431 | virtual codegenoptions::DebugInfoFormat getDefaultDebugFormat() const { |
432 | return codegenoptions::DIF_DWARF; |
433 | } |
434 | |
435 | |
436 | |
437 | virtual bool UseDwarfDebugFlags() const { return false; } |
438 | |
439 | |
440 | |
441 | virtual unsigned GetDefaultDwarfVersion() const { return 4; } |
442 | |
443 | |
444 | |
445 | |
446 | |
447 | virtual bool GetDefaultStandaloneDebug() const { return false; } |
448 | |
449 | |
450 | virtual llvm::DebuggerKind getDefaultDebuggerTuning() const { |
451 | return llvm::DebuggerKind::GDB; |
452 | } |
453 | |
454 | |
455 | virtual bool supportsDebugInfoOption(const llvm::opt::Arg *) const { |
456 | return true; |
457 | } |
458 | |
459 | |
460 | virtual void adjustDebugInfoKind(codegenoptions::DebugInfoKind &DebugInfoKind, |
461 | const llvm::opt::ArgList &Args) const {} |
462 | |
463 | |
464 | virtual llvm::ExceptionHandling |
465 | GetExceptionModel(const llvm::opt::ArgList &Args) const; |
466 | |
467 | |
468 | virtual bool SupportsEmbeddedBitcode() const { return false; } |
469 | |
470 | |
471 | virtual std::string getThreadModel() const { return "posix"; } |
472 | |
473 | |
474 | virtual bool isThreadModelSupported(const StringRef Model) const; |
475 | |
476 | |
477 | |
478 | virtual std::string |
479 | ComputeLLVMTriple(const llvm::opt::ArgList &Args, |
480 | types::ID InputType = types::TY_INVALID) const; |
481 | |
482 | |
483 | |
484 | |
485 | |
486 | |
487 | virtual std::string ComputeEffectiveClangTriple( |
488 | const llvm::opt::ArgList &Args, |
489 | types::ID InputType = types::TY_INVALID) const; |
490 | |
491 | |
492 | |
493 | |
494 | |
495 | virtual ObjCRuntime getDefaultObjCRuntime(bool isNonFragile) const; |
496 | |
497 | |
498 | |
499 | |
500 | |
501 | |
502 | virtual bool hasBlocksRuntime() const { return true; } |
503 | |
504 | |
505 | |
506 | |
507 | |
508 | virtual void |
509 | AddClangSystemIncludeArgs(const llvm::opt::ArgList &DriverArgs, |
510 | llvm::opt::ArgStringList &CC1Args) const; |
511 | |
512 | |
513 | virtual void addClangTargetOptions(const llvm::opt::ArgList &DriverArgs, |
514 | llvm::opt::ArgStringList &CC1Args, |
515 | Action::OffloadKind DeviceOffloadKind) const; |
516 | |
517 | |
518 | virtual void addClangWarningOptions(llvm::opt::ArgStringList &CC1Args) const; |
519 | |
520 | |
521 | |
522 | virtual RuntimeLibType |
523 | GetRuntimeLibType(const llvm::opt::ArgList &Args) const; |
524 | |
525 | |
526 | |
527 | virtual CXXStdlibType GetCXXStdlibType(const llvm::opt::ArgList &Args) const; |
528 | |
529 | |
530 | |
531 | virtual UnwindLibType GetUnwindLibType(const llvm::opt::ArgList &Args) const; |
532 | |
533 | |
534 | |
535 | virtual void |
536 | AddClangCXXStdlibIncludeArgs(const llvm::opt::ArgList &DriverArgs, |
537 | llvm::opt::ArgStringList &CC1Args) const; |
538 | |
539 | |
540 | |
541 | bool ShouldLinkCXXStdlib(const llvm::opt::ArgList &Args) const; |
542 | |
543 | |
544 | |
545 | virtual void AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args, |
546 | llvm::opt::ArgStringList &CmdArgs) const; |
547 | |
548 | |
549 | void AddFilePathLibArgs(const llvm::opt::ArgList &Args, |
550 | llvm::opt::ArgStringList &CmdArgs) const; |
551 | |
552 | |
553 | |
554 | virtual void AddCCKextLibArgs(const llvm::opt::ArgList &Args, |
555 | llvm::opt::ArgStringList &CmdArgs) const; |
556 | |
557 | |
558 | |
559 | |
560 | |
561 | virtual bool AddFastMathRuntimeIfAvailable( |
562 | const llvm::opt::ArgList &Args, llvm::opt::ArgStringList &CmdArgs) const; |
563 | |
564 | |
565 | |
566 | virtual void addProfileRTLibs(const llvm::opt::ArgList &Args, |
567 | llvm::opt::ArgStringList &CmdArgs) const; |
568 | |
569 | |
570 | virtual void AddCudaIncludeArgs(const llvm::opt::ArgList &DriverArgs, |
571 | llvm::opt::ArgStringList &CC1Args) const; |
572 | |
573 | |
574 | virtual void AddIAMCUIncludeArgs(const llvm::opt::ArgList &DriverArgs, |
575 | llvm::opt::ArgStringList &CC1Args) const; |
576 | |
577 | |
578 | virtual VersionTuple computeMSVCVersion(const Driver *D, |
579 | const llvm::opt::ArgList &Args) const; |
580 | |
581 | |
582 | virtual SanitizerMask getSupportedSanitizers() const; |
583 | |
584 | |
585 | virtual SanitizerMask getDefaultSanitizers() const { |
586 | return SanitizerMask(); |
587 | } |
588 | }; |
589 | |
590 | |
591 | |
592 | class RegisterEffectiveTriple { |
593 | const ToolChain &TC; |
594 | |
595 | public: |
596 | RegisterEffectiveTriple(const ToolChain &TC, llvm::Triple T) : TC(TC) { |
597 | TC.setEffectiveTriple(std::move(T)); |
598 | } |
599 | |
600 | ~RegisterEffectiveTriple() { TC.setEffectiveTriple(llvm::Triple()); } |
601 | }; |
602 | |
603 | } |
604 | |
605 | } |
606 | |
607 | #endif |
608 | |