xref: /freebsd/contrib/llvm-project/clang/lib/Driver/ToolChains/Clang.h (revision 38a52bd3b5cac3da6f7f6eef3dd050e6aa08ebb3)
1 //===--- Clang.h - Clang Tool and ToolChain Implementations ====-*- C++ -*-===//
2 //
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
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_CLANG_H
10 #define LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_CLANG_H
11 
12 #include "MSVC.h"
13 #include "clang/Basic/DebugInfoOptions.h"
14 #include "clang/Driver/Driver.h"
15 #include "clang/Driver/Tool.h"
16 #include "clang/Driver/Types.h"
17 #include "llvm/ADT/Triple.h"
18 #include "llvm/Option/Option.h"
19 #include "llvm/Support/raw_ostream.h"
20 
21 namespace clang {
22 class ObjCRuntime;
23 namespace driver {
24 
25 namespace tools {
26 
27 /// Clang compiler tool.
28 class LLVM_LIBRARY_VISIBILITY Clang : public Tool {
29   // Indicates whether this instance has integrated backend using
30   // internal LLVM infrastructure.
31   bool HasBackend;
32 
33 public:
34   static const char *getBaseInputName(const llvm::opt::ArgList &Args,
35                                       const InputInfo &Input);
36   static const char *getBaseInputStem(const llvm::opt::ArgList &Args,
37                                       const InputInfoList &Inputs);
38   static const char *getDependencyFileName(const llvm::opt::ArgList &Args,
39                                            const InputInfoList &Inputs);
40 
41 private:
42   void AddPreprocessingOptions(Compilation &C, const JobAction &JA,
43                                const Driver &D, const llvm::opt::ArgList &Args,
44                                llvm::opt::ArgStringList &CmdArgs,
45                                const InputInfo &Output,
46                                const InputInfoList &Inputs) const;
47 
48   void RenderTargetOptions(const llvm::Triple &EffectiveTriple,
49                            const llvm::opt::ArgList &Args, bool KernelOrKext,
50                            llvm::opt::ArgStringList &CmdArgs) const;
51 
52   void AddAArch64TargetArgs(const llvm::opt::ArgList &Args,
53                             llvm::opt::ArgStringList &CmdArgs) const;
54   void AddARMTargetArgs(const llvm::Triple &Triple,
55                         const llvm::opt::ArgList &Args,
56                         llvm::opt::ArgStringList &CmdArgs,
57                         bool KernelOrKext) const;
58   void AddARM64TargetArgs(const llvm::opt::ArgList &Args,
59                           llvm::opt::ArgStringList &CmdArgs) const;
60   void AddMIPSTargetArgs(const llvm::opt::ArgList &Args,
61                          llvm::opt::ArgStringList &CmdArgs) const;
62   void AddPPCTargetArgs(const llvm::opt::ArgList &Args,
63                         llvm::opt::ArgStringList &CmdArgs) const;
64   void AddR600TargetArgs(const llvm::opt::ArgList &Args,
65                          llvm::opt::ArgStringList &CmdArgs) const;
66   void AddRISCVTargetArgs(const llvm::opt::ArgList &Args,
67                           llvm::opt::ArgStringList &CmdArgs) const;
68   void AddSparcTargetArgs(const llvm::opt::ArgList &Args,
69                           llvm::opt::ArgStringList &CmdArgs) const;
70   void AddSystemZTargetArgs(const llvm::opt::ArgList &Args,
71                             llvm::opt::ArgStringList &CmdArgs) const;
72   void AddX86TargetArgs(const llvm::opt::ArgList &Args,
73                         llvm::opt::ArgStringList &CmdArgs) const;
74   void AddHexagonTargetArgs(const llvm::opt::ArgList &Args,
75                             llvm::opt::ArgStringList &CmdArgs) const;
76   void AddLanaiTargetArgs(const llvm::opt::ArgList &Args,
77                           llvm::opt::ArgStringList &CmdArgs) const;
78   void AddWebAssemblyTargetArgs(const llvm::opt::ArgList &Args,
79                                 llvm::opt::ArgStringList &CmdArgs) const;
80   void AddVETargetArgs(const llvm::opt::ArgList &Args,
81                        llvm::opt::ArgStringList &CmdArgs) const;
82 
83   enum RewriteKind { RK_None, RK_Fragile, RK_NonFragile };
84 
85   ObjCRuntime AddObjCRuntimeArgs(const llvm::opt::ArgList &args,
86                                  const InputInfoList &inputs,
87                                  llvm::opt::ArgStringList &cmdArgs,
88                                  RewriteKind rewrite) const;
89 
90   void AddClangCLArgs(const llvm::opt::ArgList &Args, types::ID InputType,
91                       llvm::opt::ArgStringList &CmdArgs,
92                       codegenoptions::DebugInfoKind *DebugInfoKind,
93                       bool *EmitCodeView) const;
94 
95   mutable std::unique_ptr<llvm::raw_fd_ostream> CompilationDatabase = nullptr;
96   void DumpCompilationDatabase(Compilation &C, StringRef Filename,
97                                StringRef Target,
98                                const InputInfo &Output, const InputInfo &Input,
99                                const llvm::opt::ArgList &Args) const;
100 
101   void DumpCompilationDatabaseFragmentToDir(
102       StringRef Dir, Compilation &C, StringRef Target, const InputInfo &Output,
103       const InputInfo &Input, const llvm::opt::ArgList &Args) const;
104 
105 public:
106   Clang(const ToolChain &TC, bool HasIntegratedBackend = true);
107   ~Clang() override;
108 
109   bool hasGoodDiagnostics() const override { return true; }
110   bool hasIntegratedAssembler() const override { return true; }
111   bool hasIntegratedBackend() const override { return HasBackend; }
112   bool hasIntegratedCPP() const override { return true; }
113   bool canEmitIR() const override { return true; }
114 
115   void ConstructJob(Compilation &C, const JobAction &JA,
116                     const InputInfo &Output, const InputInfoList &Inputs,
117                     const llvm::opt::ArgList &TCArgs,
118                     const char *LinkingOutput) const override;
119 };
120 
121 /// Clang integrated assembler tool.
122 class LLVM_LIBRARY_VISIBILITY ClangAs : public Tool {
123 public:
124   ClangAs(const ToolChain &TC)
125       : Tool("clang::as", "clang integrated assembler", TC) {}
126   void AddMIPSTargetArgs(const llvm::opt::ArgList &Args,
127                          llvm::opt::ArgStringList &CmdArgs) const;
128   void AddX86TargetArgs(const llvm::opt::ArgList &Args,
129                         llvm::opt::ArgStringList &CmdArgs) const;
130   void AddRISCVTargetArgs(const llvm::opt::ArgList &Args,
131                           llvm::opt::ArgStringList &CmdArgs) const;
132   bool hasGoodDiagnostics() const override { return true; }
133   bool hasIntegratedAssembler() const override { return false; }
134   bool hasIntegratedCPP() const override { return false; }
135 
136   void ConstructJob(Compilation &C, const JobAction &JA,
137                     const InputInfo &Output, const InputInfoList &Inputs,
138                     const llvm::opt::ArgList &TCArgs,
139                     const char *LinkingOutput) const override;
140 };
141 
142 /// Offload bundler tool.
143 class LLVM_LIBRARY_VISIBILITY OffloadBundler final : public Tool {
144 public:
145   OffloadBundler(const ToolChain &TC)
146       : Tool("offload bundler", "clang-offload-bundler", TC) {}
147 
148   bool hasIntegratedCPP() const override { return false; }
149   void ConstructJob(Compilation &C, const JobAction &JA,
150                     const InputInfo &Output, const InputInfoList &Inputs,
151                     const llvm::opt::ArgList &TCArgs,
152                     const char *LinkingOutput) const override;
153   void ConstructJobMultipleOutputs(Compilation &C, const JobAction &JA,
154                                    const InputInfoList &Outputs,
155                                    const InputInfoList &Inputs,
156                                    const llvm::opt::ArgList &TCArgs,
157                                    const char *LinkingOutput) const override;
158 };
159 
160 /// Offload wrapper tool.
161 class LLVM_LIBRARY_VISIBILITY OffloadWrapper final : public Tool {
162 public:
163   OffloadWrapper(const ToolChain &TC)
164       : Tool("offload wrapper", "clang-offload-wrapper", TC) {}
165 
166   bool hasIntegratedCPP() const override { return false; }
167   void ConstructJob(Compilation &C, const JobAction &JA,
168                     const InputInfo &Output, const InputInfoList &Inputs,
169                     const llvm::opt::ArgList &TCArgs,
170                     const char *LinkingOutput) const override;
171 };
172 
173 /// Linker wrapper tool.
174 class LLVM_LIBRARY_VISIBILITY LinkerWrapper final : public Tool {
175   const Tool *Linker;
176 
177 public:
178   LinkerWrapper(const ToolChain &TC, const Tool *Linker)
179       : Tool("Offload::Linker", "linker", TC), Linker(Linker) {}
180 
181   bool hasIntegratedCPP() const override { return false; }
182   void ConstructJob(Compilation &C, const JobAction &JA,
183                     const InputInfo &Output, const InputInfoList &Inputs,
184                     const llvm::opt::ArgList &TCArgs,
185                     const char *LinkingOutput) const override;
186 };
187 
188 } // end namespace tools
189 
190 } // end namespace driver
191 } // end namespace clang
192 
193 #endif // LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_CLANG_H
194