1 //===--- Tools.h - Tool Implementations -------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef CLANG_LIB_DRIVER_TOOLS_H_
11 #define CLANG_LIB_DRIVER_TOOLS_H_
13 #include "clang/Driver/Tool.h"
14 #include "clang/Driver/Types.h"
15 #include "clang/Driver/Util.h"
16 #include "llvm/ADT/Triple.h"
17 #include "llvm/Support/Compiler.h"
25 namespace toolchains {
31 /// \brief Clang compiler tool.
32 class LLVM_LIBRARY_VISIBILITY Clang : public Tool {
34 static const char *getBaseInputName(const ArgList &Args,
35 const InputInfoList &Inputs);
36 static const char *getBaseInputStem(const ArgList &Args,
37 const InputInfoList &Inputs);
38 static const char *getDependencyFileName(const ArgList &Args,
39 const InputInfoList &Inputs);
42 void AddPreprocessingOptions(Compilation &C,
46 ArgStringList &CmdArgs,
47 const InputInfo &Output,
48 const InputInfoList &Inputs) const;
50 void AddARMTargetArgs(const ArgList &Args, ArgStringList &CmdArgs,
51 bool KernelOrKext) const;
52 void AddMIPSTargetArgs(const ArgList &Args, ArgStringList &CmdArgs) const;
53 void AddPPCTargetArgs(const ArgList &Args, ArgStringList &CmdArgs) const;
54 void AddSparcTargetArgs(const ArgList &Args, ArgStringList &CmdArgs) const;
55 void AddX86TargetArgs(const ArgList &Args, ArgStringList &CmdArgs) const;
56 void AddHexagonTargetArgs (const ArgList &Args, ArgStringList &CmdArgs) const;
58 enum RewriteKind { RK_None, RK_Fragile, RK_NonFragile };
60 ObjCRuntime AddObjCRuntimeArgs(const ArgList &args, ArgStringList &cmdArgs,
61 RewriteKind rewrite) const;
64 Clang(const ToolChain &TC) : Tool("clang", "clang frontend", TC) {}
66 virtual bool hasGoodDiagnostics() const { return true; }
67 virtual bool hasIntegratedAssembler() const { return true; }
68 virtual bool hasIntegratedCPP() const { return true; }
70 virtual void ConstructJob(Compilation &C, const JobAction &JA,
71 const InputInfo &Output,
72 const InputInfoList &Inputs,
73 const ArgList &TCArgs,
74 const char *LinkingOutput) const;
77 /// \brief Clang integrated assembler tool.
78 class LLVM_LIBRARY_VISIBILITY ClangAs : public Tool {
79 void AddARMTargetArgs(const ArgList &Args, ArgStringList &CmdArgs) const;
80 void AddX86TargetArgs(const ArgList &Args, ArgStringList &CmdArgs) const;
82 ClangAs(const ToolChain &TC) : Tool("clang::as",
83 "clang integrated assembler", TC) {}
85 virtual bool hasGoodDiagnostics() const { return true; }
86 virtual bool hasIntegratedAssembler() const { return false; }
87 virtual bool hasIntegratedCPP() const { return false; }
89 virtual void ConstructJob(Compilation &C, const JobAction &JA,
90 const InputInfo &Output,
91 const InputInfoList &Inputs,
92 const ArgList &TCArgs,
93 const char *LinkingOutput) const;
96 /// gcc - Generic GCC tool implementations.
98 class LLVM_LIBRARY_VISIBILITY Common : public Tool {
100 Common(const char *Name, const char *ShortName,
101 const ToolChain &TC) : Tool(Name, ShortName, TC) {}
103 virtual void ConstructJob(Compilation &C, const JobAction &JA,
104 const InputInfo &Output,
105 const InputInfoList &Inputs,
106 const ArgList &TCArgs,
107 const char *LinkingOutput) const;
109 /// RenderExtraToolArgs - Render any arguments necessary to force
110 /// the particular tool mode.
111 virtual void RenderExtraToolArgs(const JobAction &JA,
112 ArgStringList &CmdArgs) const = 0;
116 class LLVM_LIBRARY_VISIBILITY Preprocess : public Common {
118 Preprocess(const ToolChain &TC) : Common("gcc::Preprocess",
119 "gcc preprocessor", TC) {}
121 virtual bool hasGoodDiagnostics() const { return true; }
122 virtual bool hasIntegratedCPP() const { return false; }
124 virtual void RenderExtraToolArgs(const JobAction &JA,
125 ArgStringList &CmdArgs) const;
128 class LLVM_LIBRARY_VISIBILITY Precompile : public Common {
130 Precompile(const ToolChain &TC) : Common("gcc::Precompile",
131 "gcc precompile", TC) {}
133 virtual bool hasGoodDiagnostics() const { return true; }
134 virtual bool hasIntegratedCPP() const { return true; }
136 virtual void RenderExtraToolArgs(const JobAction &JA,
137 ArgStringList &CmdArgs) const;
140 class LLVM_LIBRARY_VISIBILITY Compile : public Common {
142 Compile(const ToolChain &TC) : Common("gcc::Compile",
143 "gcc frontend", TC) {}
145 virtual bool hasGoodDiagnostics() const { return true; }
146 virtual bool hasIntegratedCPP() const { return true; }
148 virtual void RenderExtraToolArgs(const JobAction &JA,
149 ArgStringList &CmdArgs) const;
152 class LLVM_LIBRARY_VISIBILITY Assemble : public Common {
154 Assemble(const ToolChain &TC) : Common("gcc::Assemble",
155 "assembler (via gcc)", TC) {}
157 virtual bool hasIntegratedCPP() const { return false; }
159 virtual void RenderExtraToolArgs(const JobAction &JA,
160 ArgStringList &CmdArgs) const;
163 class LLVM_LIBRARY_VISIBILITY Link : public Common {
165 Link(const ToolChain &TC) : Common("gcc::Link",
166 "linker (via gcc)", TC) {}
168 virtual bool hasIntegratedCPP() const { return false; }
169 virtual bool isLinkJob() const { return true; }
171 virtual void RenderExtraToolArgs(const JobAction &JA,
172 ArgStringList &CmdArgs) const;
174 } // end namespace gcc
177 // For Hexagon, we do not need to instantiate tools for PreProcess, PreCompile and Compile.
178 // We simply use "clang -cc1" for those actions.
179 class LLVM_LIBRARY_VISIBILITY Assemble : public Tool {
181 Assemble(const ToolChain &TC) : Tool("hexagon::Assemble",
184 virtual bool hasIntegratedCPP() const { return false; }
186 virtual void RenderExtraToolArgs(const JobAction &JA,
187 ArgStringList &CmdArgs) const;
188 virtual void ConstructJob(Compilation &C, const JobAction &JA,
189 const InputInfo &Output,
190 const InputInfoList &Inputs,
191 const ArgList &TCArgs,
192 const char *LinkingOutput) const;
195 class LLVM_LIBRARY_VISIBILITY Link : public Tool {
197 Link(const ToolChain &TC) : Tool("hexagon::Link",
200 virtual bool hasIntegratedCPP() const { return false; }
201 virtual bool isLinkJob() const { return true; }
203 virtual void RenderExtraToolArgs(const JobAction &JA,
204 ArgStringList &CmdArgs) const;
205 virtual void ConstructJob(Compilation &C, const JobAction &JA,
206 const InputInfo &Output,
207 const InputInfoList &Inputs,
208 const ArgList &TCArgs,
209 const char *LinkingOutput) const;
211 } // end namespace hexagon.
215 llvm::Triple::ArchType getArchTypeForDarwinArchName(StringRef Str);
217 class LLVM_LIBRARY_VISIBILITY DarwinTool : public Tool {
218 virtual void anchor();
220 void AddDarwinArch(const ArgList &Args, ArgStringList &CmdArgs) const;
222 const toolchains::Darwin &getDarwinToolChain() const {
223 return reinterpret_cast<const toolchains::Darwin&>(getToolChain());
227 DarwinTool(const char *Name, const char *ShortName,
228 const ToolChain &TC) : Tool(Name, ShortName, TC) {}
231 class LLVM_LIBRARY_VISIBILITY Assemble : public DarwinTool {
233 Assemble(const ToolChain &TC) : DarwinTool("darwin::Assemble",
236 virtual bool hasIntegratedCPP() const { return false; }
238 virtual void ConstructJob(Compilation &C, const JobAction &JA,
239 const InputInfo &Output,
240 const InputInfoList &Inputs,
241 const ArgList &TCArgs,
242 const char *LinkingOutput) const;
245 class LLVM_LIBRARY_VISIBILITY Link : public DarwinTool {
246 bool NeedsTempPath(const InputInfoList &Inputs) const;
247 void AddLinkArgs(Compilation &C, const ArgList &Args,
248 ArgStringList &CmdArgs, const InputInfoList &Inputs) const;
251 Link(const ToolChain &TC) : DarwinTool("darwin::Link", "linker", TC) {}
253 virtual bool hasIntegratedCPP() const { return false; }
254 virtual bool isLinkJob() const { return true; }
256 virtual void ConstructJob(Compilation &C, const JobAction &JA,
257 const InputInfo &Output,
258 const InputInfoList &Inputs,
259 const ArgList &TCArgs,
260 const char *LinkingOutput) const;
263 class LLVM_LIBRARY_VISIBILITY Lipo : public DarwinTool {
265 Lipo(const ToolChain &TC) : DarwinTool("darwin::Lipo", "lipo", TC) {}
267 virtual bool hasIntegratedCPP() const { return false; }
269 virtual void ConstructJob(Compilation &C, const JobAction &JA,
270 const InputInfo &Output,
271 const InputInfoList &Inputs,
272 const ArgList &TCArgs,
273 const char *LinkingOutput) const;
276 class LLVM_LIBRARY_VISIBILITY Dsymutil : public DarwinTool {
278 Dsymutil(const ToolChain &TC) : DarwinTool("darwin::Dsymutil",
281 virtual bool hasIntegratedCPP() const { return false; }
282 virtual bool isDsymutilJob() const { return true; }
284 virtual void ConstructJob(Compilation &C, const JobAction &JA,
285 const InputInfo &Output,
286 const InputInfoList &Inputs,
287 const ArgList &TCArgs,
288 const char *LinkingOutput) const;
291 class LLVM_LIBRARY_VISIBILITY VerifyDebug : public DarwinTool {
293 VerifyDebug(const ToolChain &TC) : DarwinTool("darwin::VerifyDebug",
296 virtual bool hasIntegratedCPP() const { return false; }
298 virtual void ConstructJob(Compilation &C, const JobAction &JA,
299 const InputInfo &Output,
300 const InputInfoList &Inputs,
301 const ArgList &TCArgs,
302 const char *LinkingOutput) const;
307 /// openbsd -- Directly call GNU Binutils assembler and linker
309 class LLVM_LIBRARY_VISIBILITY Assemble : public Tool {
311 Assemble(const ToolChain &TC) : Tool("openbsd::Assemble", "assembler",
314 virtual bool hasIntegratedCPP() const { return false; }
316 virtual void ConstructJob(Compilation &C, const JobAction &JA,
317 const InputInfo &Output,
318 const InputInfoList &Inputs,
319 const ArgList &TCArgs,
320 const char *LinkingOutput) const;
322 class LLVM_LIBRARY_VISIBILITY Link : public Tool {
324 Link(const ToolChain &TC) : Tool("openbsd::Link", "linker", TC) {}
326 virtual bool hasIntegratedCPP() const { return false; }
327 virtual bool isLinkJob() const { return true; }
329 virtual void ConstructJob(Compilation &C, const JobAction &JA,
330 const InputInfo &Output,
331 const InputInfoList &Inputs,
332 const ArgList &TCArgs,
333 const char *LinkingOutput) const;
335 } // end namespace openbsd
337 /// bitrig -- Directly call GNU Binutils assembler and linker
339 class LLVM_LIBRARY_VISIBILITY Assemble : public Tool {
341 Assemble(const ToolChain &TC) : Tool("bitrig::Assemble", "assembler",
344 virtual bool hasIntegratedCPP() const { return false; }
346 virtual void ConstructJob(Compilation &C, const JobAction &JA,
347 const InputInfo &Output,
348 const InputInfoList &Inputs,
349 const ArgList &TCArgs,
350 const char *LinkingOutput) const;
352 class LLVM_LIBRARY_VISIBILITY Link : public Tool {
354 Link(const ToolChain &TC) : Tool("bitrig::Link", "linker", TC) {}
356 virtual bool hasIntegratedCPP() const { return false; }
357 virtual bool isLinkJob() const { return true; }
359 virtual void ConstructJob(Compilation &C, const JobAction &JA,
360 const InputInfo &Output,
361 const InputInfoList &Inputs,
362 const ArgList &TCArgs,
363 const char *LinkingOutput) const;
365 } // end namespace bitrig
367 /// freebsd -- Directly call GNU Binutils assembler and linker
369 class LLVM_LIBRARY_VISIBILITY Assemble : public Tool {
371 Assemble(const ToolChain &TC) : Tool("freebsd::Assemble", "assembler",
374 virtual bool hasIntegratedCPP() const { return false; }
376 virtual void ConstructJob(Compilation &C, const JobAction &JA,
377 const InputInfo &Output,
378 const InputInfoList &Inputs,
379 const ArgList &TCArgs,
380 const char *LinkingOutput) const;
382 class LLVM_LIBRARY_VISIBILITY Link : public Tool {
384 Link(const ToolChain &TC) : Tool("freebsd::Link", "linker", TC) {}
386 virtual bool hasIntegratedCPP() const { return false; }
387 virtual bool isLinkJob() const { return true; }
389 virtual void ConstructJob(Compilation &C, const JobAction &JA,
390 const InputInfo &Output,
391 const InputInfoList &Inputs,
392 const ArgList &TCArgs,
393 const char *LinkingOutput) const;
395 } // end namespace freebsd
397 /// netbsd -- Directly call GNU Binutils assembler and linker
399 class LLVM_LIBRARY_VISIBILITY Assemble : public Tool {
402 Assemble(const ToolChain &TC)
403 : Tool("netbsd::Assemble", "assembler", TC) {}
405 virtual bool hasIntegratedCPP() const { return false; }
407 virtual void ConstructJob(Compilation &C, const JobAction &JA,
408 const InputInfo &Output,
409 const InputInfoList &Inputs,
410 const ArgList &TCArgs,
411 const char *LinkingOutput) const;
413 class LLVM_LIBRARY_VISIBILITY Link : public Tool {
416 Link(const ToolChain &TC)
417 : Tool("netbsd::Link", "linker", TC) {}
419 virtual bool hasIntegratedCPP() const { return false; }
420 virtual bool isLinkJob() const { return true; }
422 virtual void ConstructJob(Compilation &C, const JobAction &JA,
423 const InputInfo &Output,
424 const InputInfoList &Inputs,
425 const ArgList &TCArgs,
426 const char *LinkingOutput) const;
428 } // end namespace netbsd
430 /// Directly call GNU Binutils' assembler and linker.
432 class LLVM_LIBRARY_VISIBILITY Assemble : public Tool {
434 Assemble(const ToolChain &TC) : Tool("GNU::Assemble", "assembler", TC) {}
436 virtual bool hasIntegratedCPP() const { return false; }
438 virtual void ConstructJob(Compilation &C, const JobAction &JA,
439 const InputInfo &Output,
440 const InputInfoList &Inputs,
441 const ArgList &TCArgs,
442 const char *LinkingOutput) const;
444 class LLVM_LIBRARY_VISIBILITY Link : public Tool {
446 Link(const ToolChain &TC) : Tool("GNU::Link", "linker", TC) {}
448 virtual bool hasIntegratedCPP() const { return false; }
449 virtual bool isLinkJob() const { return true; }
451 virtual void ConstructJob(Compilation &C, const JobAction &JA,
452 const InputInfo &Output,
453 const InputInfoList &Inputs,
454 const ArgList &TCArgs,
455 const char *LinkingOutput) const;
458 /// minix -- Directly call GNU Binutils assembler and linker
460 class LLVM_LIBRARY_VISIBILITY Assemble : public Tool {
462 Assemble(const ToolChain &TC) : Tool("minix::Assemble", "assembler",
465 virtual bool hasIntegratedCPP() const { return false; }
467 virtual void ConstructJob(Compilation &C, const JobAction &JA,
468 const InputInfo &Output,
469 const InputInfoList &Inputs,
470 const ArgList &TCArgs,
471 const char *LinkingOutput) const;
473 class LLVM_LIBRARY_VISIBILITY Link : public Tool {
475 Link(const ToolChain &TC) : Tool("minix::Link", "linker", TC) {}
477 virtual bool hasIntegratedCPP() const { return false; }
478 virtual bool isLinkJob() const { return true; }
480 virtual void ConstructJob(Compilation &C, const JobAction &JA,
481 const InputInfo &Output,
482 const InputInfoList &Inputs,
483 const ArgList &TCArgs,
484 const char *LinkingOutput) const;
486 } // end namespace minix
488 /// solaris -- Directly call Solaris assembler and linker
490 class LLVM_LIBRARY_VISIBILITY Assemble : public Tool {
492 Assemble(const ToolChain &TC) : Tool("solaris::Assemble", "assembler",
495 virtual bool hasIntegratedCPP() const { return false; }
497 virtual void ConstructJob(Compilation &C, const JobAction &JA,
498 const InputInfo &Output,
499 const InputInfoList &Inputs,
500 const ArgList &TCArgs,
501 const char *LinkingOutput) const;
503 class LLVM_LIBRARY_VISIBILITY Link : public Tool {
505 Link(const ToolChain &TC) : Tool("solaris::Link", "linker", TC) {}
507 virtual bool hasIntegratedCPP() const { return false; }
508 virtual bool isLinkJob() const { return true; }
510 virtual void ConstructJob(Compilation &C, const JobAction &JA,
511 const InputInfo &Output,
512 const InputInfoList &Inputs,
513 const ArgList &TCArgs,
514 const char *LinkingOutput) const;
516 } // end namespace solaris
518 /// auroraux -- Directly call GNU Binutils assembler and linker
520 class LLVM_LIBRARY_VISIBILITY Assemble : public Tool {
522 Assemble(const ToolChain &TC) : Tool("auroraux::Assemble", "assembler",
525 virtual bool hasIntegratedCPP() const { return false; }
527 virtual void ConstructJob(Compilation &C, const JobAction &JA,
528 const InputInfo &Output,
529 const InputInfoList &Inputs,
530 const ArgList &TCArgs,
531 const char *LinkingOutput) const;
533 class LLVM_LIBRARY_VISIBILITY Link : public Tool {
535 Link(const ToolChain &TC) : Tool("auroraux::Link", "linker", TC) {}
537 virtual bool hasIntegratedCPP() const { return false; }
538 virtual bool isLinkJob() const { return true; }
540 virtual void ConstructJob(Compilation &C, const JobAction &JA,
541 const InputInfo &Output,
542 const InputInfoList &Inputs,
543 const ArgList &TCArgs,
544 const char *LinkingOutput) const;
546 } // end namespace auroraux
548 /// dragonfly -- Directly call GNU Binutils assembler and linker
549 namespace dragonfly {
550 class LLVM_LIBRARY_VISIBILITY Assemble : public Tool {
552 Assemble(const ToolChain &TC) : Tool("dragonfly::Assemble", "assembler",
555 virtual bool hasIntegratedCPP() const { return false; }
557 virtual void ConstructJob(Compilation &C, const JobAction &JA,
558 const InputInfo &Output,
559 const InputInfoList &Inputs,
560 const ArgList &TCArgs,
561 const char *LinkingOutput) const;
563 class LLVM_LIBRARY_VISIBILITY Link : public Tool {
565 Link(const ToolChain &TC) : Tool("dragonfly::Link", "linker", TC) {}
567 virtual bool hasIntegratedCPP() const { return false; }
568 virtual bool isLinkJob() const { return true; }
570 virtual void ConstructJob(Compilation &C, const JobAction &JA,
571 const InputInfo &Output,
572 const InputInfoList &Inputs,
573 const ArgList &TCArgs,
574 const char *LinkingOutput) const;
576 } // end namespace dragonfly
578 /// Visual studio tools.
579 namespace visualstudio {
580 class LLVM_LIBRARY_VISIBILITY Link : public Tool {
582 Link(const ToolChain &TC) : Tool("visualstudio::Link", "linker", TC) {}
584 virtual bool hasIntegratedCPP() const { return false; }
585 virtual bool isLinkJob() const { return true; }
587 virtual void ConstructJob(Compilation &C, const JobAction &JA,
588 const InputInfo &Output,
589 const InputInfoList &Inputs,
590 const ArgList &TCArgs,
591 const char *LinkingOutput) const;
593 } // end namespace visualstudio
595 } // end namespace toolchains
596 } // end namespace driver
597 } // end namespace clang
599 #endif // CLANG_LIB_DRIVER_TOOLS_H_