ToolChain.cpp revision 266715 
1//===--- ToolChain.cpp - Collections of tools for one platform ------------===//
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#include "Tools.h"
11#include "clang/Basic/ObjCRuntime.h"
12#include "clang/Driver/Action.h"
13#include "clang/Driver/Driver.h"
14#include "clang/Driver/DriverDiagnostic.h"
15#include "clang/Driver/Options.h"
16#include "clang/Driver/SanitizerArgs.h"
17#include "clang/Driver/ToolChain.h"
18#include "llvm/ADT/StringSwitch.h"
19#include "llvm/Option/Arg.h"
20#include "llvm/Option/ArgList.h"
21#include "llvm/Option/Option.h"
22#include "llvm/Support/ErrorHandling.h"
23#include "llvm/Support/FileSystem.h"
24using namespace clang::driver;
25using namespace clang;
26using namespace llvm::opt;
27
28ToolChain::ToolChain(const Driver &D, const llvm::Triple &T,
29                     const ArgList &A)
30  : D(D), Triple(T), Args(A) {
31}
32
33ToolChain::~ToolChain() {
34}
35
36const Driver &ToolChain::getDriver() const {
37 return D;
38}
39
40bool ToolChain::useIntegratedAs() const {
41  return Args.hasFlag(options::OPT_integrated_as,
42                      options::OPT_no_integrated_as,
43                      IsIntegratedAssemblerDefault());
44}
45
46const SanitizerArgs& ToolChain::getSanitizerArgs() const {
47  if (!SanitizerArguments.get())
48    SanitizerArguments.reset(new SanitizerArgs(*this, Args));
49  return *SanitizerArguments.get();
50}
51
52std::string ToolChain::getDefaultUniversalArchName() const {
53  // In universal driver terms, the arch name accepted by -arch isn't exactly
54  // the same as the ones that appear in the triple. Roughly speaking, this is
55  // an inverse of the darwin::getArchTypeForDarwinArchName() function, but the
56  // only interesting special case is powerpc.
57  switch (Triple.getArch()) {
58  case llvm::Triple::ppc:
59    return "ppc";
60  case llvm::Triple::ppc64:
61    return "ppc64";
62  case llvm::Triple::ppc64le:
63    return "ppc64le";
64  default:
65    return Triple.getArchName();
66  }
67}
68
69bool ToolChain::IsUnwindTablesDefault() const {
70  return false;
71}
72
73Tool *ToolChain::getClang() const {
74  if (!Clang)
75    Clang.reset(new tools::Clang(*this));
76  return Clang.get();
77}
78
79Tool *ToolChain::buildAssembler() const {
80  return new tools::ClangAs(*this);
81}
82
83Tool *ToolChain::buildLinker() const {
84  llvm_unreachable("Linking is not supported by this toolchain");
85}
86
87Tool *ToolChain::getAssemble() const {
88  if (!Assemble)
89    Assemble.reset(buildAssembler());
90  return Assemble.get();
91}
92
93Tool *ToolChain::getClangAs() const {
94  if (!Assemble)
95    Assemble.reset(new tools::ClangAs(*this));
96  return Assemble.get();
97}
98
99Tool *ToolChain::getLink() const {
100  if (!Link)
101    Link.reset(buildLinker());
102  return Link.get();
103}
104
105Tool *ToolChain::getTool(Action::ActionClass AC) const {
106  switch (AC) {
107  case Action::AssembleJobClass:
108    return getAssemble();
109
110  case Action::LinkJobClass:
111    return getLink();
112
113  case Action::InputClass:
114  case Action::BindArchClass:
115  case Action::LipoJobClass:
116  case Action::DsymutilJobClass:
117  case Action::VerifyJobClass:
118    llvm_unreachable("Invalid tool kind.");
119
120  case Action::CompileJobClass:
121  case Action::PrecompileJobClass:
122  case Action::PreprocessJobClass:
123  case Action::AnalyzeJobClass:
124  case Action::MigrateJobClass:
125    return getClang();
126  }
127
128  llvm_unreachable("Invalid tool kind.");
129}
130
131Tool *ToolChain::SelectTool(const JobAction &JA) const {
132  if (getDriver().ShouldUseClangCompiler(JA))
133    return getClang();
134  Action::ActionClass AC = JA.getKind();
135  if (AC == Action::AssembleJobClass && useIntegratedAs())
136    return getClangAs();
137  return getTool(AC);
138}
139
140std::string ToolChain::GetFilePath(const char *Name) const {
141  return D.GetFilePath(Name, *this);
142
143}
144
145std::string ToolChain::GetProgramPath(const char *Name) const {
146  return D.GetProgramPath(Name, *this);
147}
148
149types::ID ToolChain::LookupTypeForExtension(const char *Ext) const {
150  return types::lookupTypeForExtension(Ext);
151}
152
153bool ToolChain::HasNativeLLVMSupport() const {
154  return false;
155}
156
157ObjCRuntime ToolChain::getDefaultObjCRuntime(bool isNonFragile) const {
158  return ObjCRuntime(isNonFragile ? ObjCRuntime::GNUstep : ObjCRuntime::GCC,
159                     VersionTuple());
160}
161
162/// getARMTargetCPU - Get the (LLVM) name of the ARM cpu we are targeting.
163//
164// FIXME: tblgen this.
165static const char *getARMTargetCPU(const ArgList &Args,
166                                   const llvm::Triple &Triple) {
167  // For Darwin targets, the -arch option (which is translated to a
168  // corresponding -march option) should determine the architecture
169  // (and the Mach-O slice) regardless of any -mcpu options.
170  if (!Triple.isOSDarwin()) {
171    // FIXME: Warn on inconsistent use of -mcpu and -march.
172    // If we have -mcpu=, use that.
173    if (Arg *A = Args.getLastArg(options::OPT_mcpu_EQ))
174      return A->getValue();
175  }
176
177  StringRef MArch;
178  if (Arg *A = Args.getLastArg(options::OPT_march_EQ)) {
179    // Otherwise, if we have -march= choose the base CPU for that arch.
180    MArch = A->getValue();
181  } else {
182    // Otherwise, use the Arch from the triple.
183    MArch = Triple.getArchName();
184  }
185
186  if (Triple.getOS() == llvm::Triple::NetBSD) {
187    if (MArch == "armv6")
188      return "arm1176jzf-s";
189  }
190
191  const char *result = llvm::StringSwitch<const char *>(MArch)
192    .Cases("armv2", "armv2a","arm2")
193    .Case("armv3", "arm6")
194    .Case("armv3m", "arm7m")
195    .Case("armv4", "strongarm")
196    .Case("armv4t", "arm7tdmi")
197    .Cases("armv5", "armv5t", "arm10tdmi")
198    .Cases("armv5e", "armv5te", "arm1026ejs")
199    .Case("armv5tej", "arm926ej-s")
200    .Cases("armv6", "armv6k", "arm1136jf-s")
201    .Case("armv6j", "arm1136j-s")
202    .Cases("armv6z", "armv6zk", "arm1176jzf-s")
203    .Case("armv6t2", "arm1156t2-s")
204    .Cases("armv6m", "armv6-m", "cortex-m0")
205    .Cases("armv7", "armv7a", "armv7-a", "cortex-a8")
206    .Cases("armv7l", "armv7-l", "cortex-a8")
207    .Cases("armv7f", "armv7-f", "cortex-a9-mp")
208    .Cases("armv7s", "armv7-s", "swift")
209    .Cases("armv7r", "armv7-r", "cortex-r4")
210    .Cases("armv7m", "armv7-m", "cortex-m3")
211    .Cases("armv7em", "armv7e-m", "cortex-m4")
212    .Cases("armv8", "armv8a", "armv8-a", "cortex-a53")
213    .Case("ep9312", "ep9312")
214    .Case("iwmmxt", "iwmmxt")
215    .Case("xscale", "xscale")
216    // If all else failed, return the most base CPU with thumb interworking
217    // supported by LLVM.
218    .Default(0);
219
220  if (result)
221    return result;
222
223  return
224    Triple.getEnvironment() == llvm::Triple::GNUEABIHF
225      ? "arm1176jzf-s"
226      : "arm7tdmi";
227}
228
229/// getLLVMArchSuffixForARM - Get the LLVM arch name to use for a particular
230/// CPU.
231//
232// FIXME: This is redundant with -mcpu, why does LLVM use this.
233// FIXME: tblgen this, or kill it!
234static const char *getLLVMArchSuffixForARM(StringRef CPU) {
235  return llvm::StringSwitch<const char *>(CPU)
236    .Case("strongarm", "v4")
237    .Cases("arm7tdmi", "arm7tdmi-s", "arm710t", "v4t")
238    .Cases("arm720t", "arm9", "arm9tdmi", "v4t")
239    .Cases("arm920", "arm920t", "arm922t", "v4t")
240    .Cases("arm940t", "ep9312","v4t")
241    .Cases("arm10tdmi",  "arm1020t", "v5")
242    .Cases("arm9e",  "arm926ej-s",  "arm946e-s", "v5e")
243    .Cases("arm966e-s",  "arm968e-s",  "arm10e", "v5e")
244    .Cases("arm1020e",  "arm1022e",  "xscale", "iwmmxt", "v5e")
245    .Cases("arm1136j-s",  "arm1136jf-s",  "arm1176jz-s", "v6")
246    .Cases("arm1176jzf-s",  "mpcorenovfp",  "mpcore", "v6")
247    .Cases("arm1156t2-s",  "arm1156t2f-s", "v6t2")
248    .Cases("cortex-a5", "cortex-a7", "cortex-a8", "v7")
249    .Cases("cortex-a9", "cortex-a12", "cortex-a15", "v7")
250    .Cases("cortex-r4", "cortex-r5", "v7r")
251    .Case("cortex-m0", "v6m")
252    .Case("cortex-m3", "v7m")
253    .Case("cortex-m4", "v7em")
254    .Case("cortex-a9-mp", "v7f")
255    .Case("swift", "v7s")
256    .Cases("cortex-a53", "cortex-a57", "v8")
257    .Default("");
258}
259
260std::string ToolChain::ComputeLLVMTriple(const ArgList &Args,
261                                         types::ID InputType) const {
262  switch (getTriple().getArch()) {
263  default:
264    return getTripleString();
265
266  case llvm::Triple::x86_64: {
267    llvm::Triple Triple = getTriple();
268    if (!Triple.isOSDarwin())
269      return getTripleString();
270
271    if (Arg *A = Args.getLastArg(options::OPT_march_EQ)) {
272      // x86_64h goes in the triple. Other -march options just use the
273      // vanilla triple we already have.
274      StringRef MArch = A->getValue();
275      if (MArch == "x86_64h")
276        Triple.setArchName(MArch);
277    }
278    return Triple.getTriple();
279  }
280  case llvm::Triple::arm:
281  case llvm::Triple::thumb: {
282    // FIXME: Factor into subclasses.
283    llvm::Triple Triple = getTriple();
284
285    // Thumb2 is the default for V7 on Darwin.
286    //
287    // FIXME: Thumb should just be another -target-feaure, not in the triple.
288    StringRef Suffix =
289      getLLVMArchSuffixForARM(getARMTargetCPU(Args, Triple));
290    bool ThumbDefault = Suffix.startswith("v6m") ||
291      (Suffix.startswith("v7") && getTriple().isOSDarwin());
292    std::string ArchName = "arm";
293
294    // Assembly files should start in ARM mode.
295    if (InputType != types::TY_PP_Asm &&
296        Args.hasFlag(options::OPT_mthumb, options::OPT_mno_thumb, ThumbDefault))
297      ArchName = "thumb";
298    Triple.setArchName(ArchName + Suffix.str());
299
300    return Triple.getTriple();
301  }
302  }
303}
304
305std::string ToolChain::ComputeEffectiveClangTriple(const ArgList &Args,
306                                                   types::ID InputType) const {
307  // Diagnose use of Darwin OS deployment target arguments on non-Darwin.
308  if (Arg *A = Args.getLastArg(options::OPT_mmacosx_version_min_EQ,
309                               options::OPT_miphoneos_version_min_EQ,
310                               options::OPT_mios_simulator_version_min_EQ))
311    getDriver().Diag(diag::err_drv_clang_unsupported)
312      << A->getAsString(Args);
313
314  return ComputeLLVMTriple(Args, InputType);
315}
316
317void ToolChain::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
318                                          ArgStringList &CC1Args) const {
319  // Each toolchain should provide the appropriate include flags.
320}
321
322void ToolChain::addClangTargetOptions(const ArgList &DriverArgs,
323                                      ArgStringList &CC1Args) const {
324}
325
326ToolChain::RuntimeLibType ToolChain::GetRuntimeLibType(
327  const ArgList &Args) const
328{
329  if (Arg *A = Args.getLastArg(options::OPT_rtlib_EQ)) {
330    StringRef Value = A->getValue();
331    if (Value == "compiler-rt")
332      return ToolChain::RLT_CompilerRT;
333    if (Value == "libgcc")
334      return ToolChain::RLT_Libgcc;
335    getDriver().Diag(diag::err_drv_invalid_rtlib_name)
336      << A->getAsString(Args);
337  }
338
339  return GetDefaultRuntimeLibType();
340}
341
342ToolChain::CXXStdlibType ToolChain::GetCXXStdlibType(const ArgList &Args) const{
343  if (Arg *A = Args.getLastArg(options::OPT_stdlib_EQ)) {
344    StringRef Value = A->getValue();
345    if (Value == "libc++")
346      return ToolChain::CST_Libcxx;
347    if (Value == "libstdc++")
348      return ToolChain::CST_Libstdcxx;
349    getDriver().Diag(diag::err_drv_invalid_stdlib_name)
350      << A->getAsString(Args);
351  }
352
353  return ToolChain::CST_Libstdcxx;
354}
355
356/// \brief Utility function to add a system include directory to CC1 arguments.
357/*static*/ void ToolChain::addSystemInclude(const ArgList &DriverArgs,
358                                            ArgStringList &CC1Args,
359                                            const Twine &Path) {
360  CC1Args.push_back("-internal-isystem");
361  CC1Args.push_back(DriverArgs.MakeArgString(Path));
362}
363
364/// \brief Utility function to add a system include directory with extern "C"
365/// semantics to CC1 arguments.
366///
367/// Note that this should be used rarely, and only for directories that
368/// historically and for legacy reasons are treated as having implicit extern
369/// "C" semantics. These semantics are *ignored* by and large today, but its
370/// important to preserve the preprocessor changes resulting from the
371/// classification.
372/*static*/ void ToolChain::addExternCSystemInclude(const ArgList &DriverArgs,
373                                                   ArgStringList &CC1Args,
374                                                   const Twine &Path) {
375  CC1Args.push_back("-internal-externc-isystem");
376  CC1Args.push_back(DriverArgs.MakeArgString(Path));
377}
378
379void ToolChain::addExternCSystemIncludeIfExists(const ArgList &DriverArgs,
380                                                ArgStringList &CC1Args,
381                                                const Twine &Path) {
382  if (llvm::sys::fs::exists(Path))
383    addExternCSystemInclude(DriverArgs, CC1Args, Path);
384}
385
386/// \brief Utility function to add a list of system include directories to CC1.
387/*static*/ void ToolChain::addSystemIncludes(const ArgList &DriverArgs,
388                                             ArgStringList &CC1Args,
389                                             ArrayRef<StringRef> Paths) {
390  for (ArrayRef<StringRef>::iterator I = Paths.begin(), E = Paths.end();
391       I != E; ++I) {
392    CC1Args.push_back("-internal-isystem");
393    CC1Args.push_back(DriverArgs.MakeArgString(*I));
394  }
395}
396
397void ToolChain::AddClangCXXStdlibIncludeArgs(const ArgList &DriverArgs,
398                                             ArgStringList &CC1Args) const {
399  // Header search paths should be handled by each of the subclasses.
400  // Historically, they have not been, and instead have been handled inside of
401  // the CC1-layer frontend. As the logic is hoisted out, this generic function
402  // will slowly stop being called.
403  //
404  // While it is being called, replicate a bit of a hack to propagate the
405  // '-stdlib=' flag down to CC1 so that it can in turn customize the C++
406  // header search paths with it. Once all systems are overriding this
407  // function, the CC1 flag and this line can be removed.
408  DriverArgs.AddAllArgs(CC1Args, options::OPT_stdlib_EQ);
409}
410
411void ToolChain::AddCXXStdlibLibArgs(const ArgList &Args,
412                                    ArgStringList &CmdArgs) const {
413  CXXStdlibType Type = GetCXXStdlibType(Args);
414
415  switch (Type) {
416  case ToolChain::CST_Libcxx:
417    CmdArgs.push_back("-lc++");
418    break;
419
420  case ToolChain::CST_Libstdcxx:
421    CmdArgs.push_back("-lstdc++");
422    break;
423  }
424}
425
426void ToolChain::AddCCKextLibArgs(const ArgList &Args,
427                                 ArgStringList &CmdArgs) const {
428  CmdArgs.push_back("-lcc_kext");
429}
430
431bool ToolChain::AddFastMathRuntimeIfAvailable(const ArgList &Args,
432                                              ArgStringList &CmdArgs) const {
433  // Do not check for -fno-fast-math or -fno-unsafe-math when -Ofast passed
434  // (to keep the linker options consistent with gcc and clang itself).
435  if (!isOptimizationLevelFast(Args)) {
436    // Check if -ffast-math or -funsafe-math.
437    Arg *A =
438        Args.getLastArg(options::OPT_ffast_math, options::OPT_fno_fast_math,
439                        options::OPT_funsafe_math_optimizations,
440                        options::OPT_fno_unsafe_math_optimizations);
441
442    if (!A || A->getOption().getID() == options::OPT_fno_fast_math ||
443        A->getOption().getID() == options::OPT_fno_unsafe_math_optimizations)
444      return false;
445  }
446  // If crtfastmath.o exists add it to the arguments.
447  std::string Path = GetFilePath("crtfastmath.o");
448  if (Path == "crtfastmath.o") // Not found.
449    return false;
450
451  CmdArgs.push_back(Args.MakeArgString(Path));
452  return true;
453}
454