Coverage Report

Created: 2021-03-06 07:03

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/lib/Driver/ToolChains/WebAssembly.cpp
Line
Count
Source (jump to first uncovered line)
1
//===--- WebAssembly.cpp - WebAssembly ToolChain Implementation -*- 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
#include "WebAssembly.h"
10
#include "CommonArgs.h"
11
#include "clang/Basic/Version.h"
12
#include "clang/Config/config.h"
13
#include "clang/Driver/Compilation.h"
14
#include "clang/Driver/Driver.h"
15
#include "clang/Driver/DriverDiagnostic.h"
16
#include "clang/Driver/Options.h"
17
#include "llvm/Support/FileSystem.h"
18
#include "llvm/Support/Path.h"
19
#include "llvm/Option/ArgList.h"
20
21
using namespace clang::driver;
22
using namespace clang::driver::tools;
23
using namespace clang::driver::toolchains;
24
using namespace clang;
25
using namespace llvm::opt;
26
27
/// Following the conventions in https://wiki.debian.org/Multiarch/Tuples,
28
/// we remove the vendor field to form the multiarch triple.
29
static std::string getMultiarchTriple(const Driver &D,
30
                                      const llvm::Triple &TargetTriple,
31
19
                                      StringRef SysRoot) {
32
19
    return (TargetTriple.getArchName() + "-" +
33
19
            TargetTriple.getOSAndEnvironmentName()).str();
34
19
}
35
36
29
std::string wasm::Linker::getLinkerPath(const ArgList &Args) const {
37
29
  const ToolChain &ToolChain = getToolChain();
38
29
  if (const Arg* A = Args.getLastArg(options::OPT_fuse_ld_EQ)) {
39
1
    StringRef UseLinker = A->getValue();
40
1
    if (!UseLinker.empty()) {
41
1
      if (llvm::sys::path::is_absolute(UseLinker) &&
42
0
          llvm::sys::fs::can_execute(UseLinker))
43
0
        return std::string(UseLinker);
44
45
      // Accept 'lld', and 'ld' as aliases for the default linker
46
1
      if (UseLinker != "lld" && UseLinker != "ld")
47
1
        ToolChain.getDriver().Diag(diag::err_drv_invalid_linker_name)
48
1
            << A->getAsString(Args);
49
1
    }
50
1
  }
51
52
29
  return ToolChain.GetProgramPath(ToolChain.getDefaultLinker());
53
29
}
54
55
void wasm::Linker::ConstructJob(Compilation &C, const JobAction &JA,
56
                                const InputInfo &Output,
57
                                const InputInfoList &Inputs,
58
                                const ArgList &Args,
59
29
                                const char *LinkingOutput) const {
60
61
29
  const ToolChain &ToolChain = getToolChain();
62
29
  const char *Linker = Args.MakeArgString(getLinkerPath(Args));
63
29
  ArgStringList CmdArgs;
64
65
29
  CmdArgs.push_back("-m");
66
29
  if (getToolChain().getTriple().isArch64Bit())
67
0
    CmdArgs.push_back("wasm64");
68
29
  else
69
29
    CmdArgs.push_back("wasm32");
70
71
29
  if (Args.hasArg(options::OPT_s))
72
0
    CmdArgs.push_back("--strip-all");
73
74
29
  Args.AddAllArgs(CmdArgs, options::OPT_L);
75
29
  Args.AddAllArgs(CmdArgs, options::OPT_u);
76
29
  ToolChain.AddFilePathLibArgs(Args, CmdArgs);
77
78
29
  const char *Crt1 = "crt1.o";
79
29
  const char *Entry = NULL;
80
81
  // If crt1-command.o exists, it supports new-style commands, so use it.
82
  // Otherwise, use the old crt1.o. This is a temporary transition measure.
83
  // Once WASI libc no longer needs to support LLVM versions which lack
84
  // support for new-style command, it can make crt1.o the same as
85
  // crt1-command.o. And once LLVM no longer needs to support WASI libc
86
  // versions before that, it can switch to using crt1-command.o.
87
29
  if (ToolChain.GetFilePath("crt1-command.o") != "crt1-command.o")
88
0
    Crt1 = "crt1-command.o";
89
90
29
  if (const Arg *A = Args.getLastArg(options::OPT_mexec_model_EQ)) {
91
2
    StringRef CM = A->getValue();
92
2
    if (CM == "command") {
93
      // Use default values.
94
1
    } else if (CM == "reactor") {
95
1
      Crt1 = "crt1-reactor.o";
96
1
      Entry = "_initialize";
97
0
    } else {
98
0
      ToolChain.getDriver().Diag(diag::err_drv_invalid_argument_to_option)
99
0
          << CM << A->getOption().getName();
100
0
    }
101
2
  }
102
29
  if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nostartfiles))
103
29
    CmdArgs.push_back(Args.MakeArgString(ToolChain.GetFilePath(Crt1)));
104
29
  if (Entry) {
105
1
    CmdArgs.push_back(Args.MakeArgString("--entry"));
106
1
    CmdArgs.push_back(Args.MakeArgString(Entry));
107
1
  }
108
109
29
  AddLinkerInputs(ToolChain, Inputs, Args, CmdArgs, JA);
110
111
29
  if (!Args.hasArg(options::OPT_nostdlib, options::OPT_nodefaultlibs)) {
112
29
    if (ToolChain.ShouldLinkCXXStdlib(Args))
113
7
      ToolChain.AddCXXStdlibLibArgs(Args, CmdArgs);
114
115
29
    if (Args.hasArg(options::OPT_pthread)) {
116
5
      CmdArgs.push_back("-lpthread");
117
5
      CmdArgs.push_back("--shared-memory");
118
5
    }
119
120
29
    CmdArgs.push_back("-lc");
121
29
    AddRunTimeLibs(ToolChain, ToolChain.getDriver(), CmdArgs, Args);
122
29
  }
123
124
29
  CmdArgs.push_back("-o");
125
29
  CmdArgs.push_back(Output.getFilename());
126
127
29
  C.addCommand(std::make_unique<Command>(JA, *this,
128
29
                                         ResponseFileSupport::AtFileCurCP(),
129
29
                                         Linker, CmdArgs, Inputs, Output));
130
131
  // When optimizing, if wasm-opt is available, run it.
132
29
  if (Arg *A = Args.getLastArg(options::OPT_O_Group)) {
133
5
    auto WasmOptPath = getToolChain().GetProgramPath("wasm-opt");
134
5
    if (WasmOptPath != "wasm-opt") {
135
0
      StringRef OOpt = "s";
136
0
      if (A->getOption().matches(options::OPT_O4) ||
137
0
          A->getOption().matches(options::OPT_Ofast))
138
0
        OOpt = "4";
139
0
      else if (A->getOption().matches(options::OPT_O0))
140
0
        OOpt = "0";
141
0
      else if (A->getOption().matches(options::OPT_O))
142
0
        OOpt = A->getValue();
143
144
0
      if (OOpt != "0") {
145
0
        const char *WasmOpt = Args.MakeArgString(WasmOptPath);
146
0
        ArgStringList CmdArgs;
147
0
        CmdArgs.push_back(Output.getFilename());
148
0
        CmdArgs.push_back(Args.MakeArgString(llvm::Twine("-O") + OOpt));
149
0
        CmdArgs.push_back("-o");
150
0
        CmdArgs.push_back(Output.getFilename());
151
0
        C.addCommand(std::make_unique<Command>(
152
0
            JA, *this, ResponseFileSupport::AtFileCurCP(), WasmOpt, CmdArgs,
153
0
            Inputs, Output));
154
0
      }
155
0
    }
156
5
  }
157
29
}
158
159
/// Given a base library directory, append path components to form the
160
/// LTO directory.
161
1
static std::string AppendLTOLibDir(const std::string &Dir) {
162
    // The version allows the path to be keyed to the specific version of
163
    // LLVM in used, as the bitcode format is not stable.
164
1
    return Dir + "/llvm-lto/" LLVM_VERSION_STRING;
165
1
}
166
167
WebAssembly::WebAssembly(const Driver &D, const llvm::Triple &Triple,
168
                         const llvm::opt::ArgList &Args)
169
68
    : ToolChain(D, Triple, Args) {
170
171
68
  assert(Triple.isArch32Bit() != Triple.isArch64Bit());
172
173
0
  getProgramPaths().push_back(getDriver().getInstalledDir());
174
175
68
  auto SysRoot = getDriver().SysRoot;
176
68
  if (getTriple().getOS() == llvm::Triple::UnknownOS) {
177
    // Theoretically an "unknown" OS should mean no standard libraries, however
178
    // it could also mean that a custom set of libraries is in use, so just add
179
    // /lib to the search path. Disable multiarch in this case, to discourage
180
    // paths containing "unknown" from acquiring meanings.
181
60
    getFilePaths().push_back(SysRoot + "/lib");
182
8
  } else {
183
8
    const std::string MultiarchTriple =
184
8
        getMultiarchTriple(getDriver(), Triple, SysRoot);
185
8
    if (D.isUsingLTO()) {
186
      // For LTO, enable use of lto-enabled sysroot libraries too, if available.
187
      // Note that the directory is keyed to the LLVM revision, as LLVM's
188
      // bitcode format is not stable.
189
1
      auto Dir = AppendLTOLibDir(SysRoot + "/lib/" + MultiarchTriple);
190
1
      getFilePaths().push_back(Dir);
191
1
    }
192
8
    getFilePaths().push_back(SysRoot + "/lib/" + MultiarchTriple);
193
8
  }
194
68
}
195
196
71
bool WebAssembly::IsMathErrnoDefault() const { return false; }
197
198
69
bool WebAssembly::IsObjCNonFragileABIDefault() const { return true; }
199
200
0
bool WebAssembly::UseObjCMixedDispatch() const { return true; }
201
202
138
bool WebAssembly::isPICDefault() const { return false; }
203
204
138
bool WebAssembly::isPIEDefault() const { return false; }
205
206
138
bool WebAssembly::isPICDefaultForced() const { return false; }
207
208
348
bool WebAssembly::IsIntegratedAssemblerDefault() const { return true; }
209
210
0
bool WebAssembly::hasBlocksRuntime() const { return false; }
211
212
// TODO: Support profiling.
213
69
bool WebAssembly::SupportsProfiling() const { return false; }
214
215
30
bool WebAssembly::HasNativeLLVMSupport() const { return true; }
216
217
void WebAssembly::addClangTargetOptions(const ArgList &DriverArgs,
218
                                        ArgStringList &CC1Args,
219
71
                                        Action::OffloadKind) const {
220
71
  if (!DriverArgs.hasFlag(clang::driver::options::OPT_fuse_init_array,
221
71
                          options::OPT_fno_use_init_array, true))
222
0
    CC1Args.push_back("-fno-use-init-array");
223
224
  // '-pthread' implies atomics, bulk-memory, mutable-globals, and sign-ext
225
71
  if (DriverArgs.hasFlag(options::OPT_pthread, options::OPT_no_pthread,
226
11
                         false)) {
227
11
    if (DriverArgs.hasFlag(options::OPT_mno_atomics, options::OPT_matomics,
228
11
                           false))
229
1
      getDriver().Diag(diag::err_drv_argument_not_allowed_with)
230
1
          << "-pthread"
231
1
          << "-mno-atomics";
232
11
    if (DriverArgs.hasFlag(options::OPT_mno_bulk_memory,
233
11
                           options::OPT_mbulk_memory, false))
234
1
      getDriver().Diag(diag::err_drv_argument_not_allowed_with)
235
1
          << "-pthread"
236
1
          << "-mno-bulk-memory";
237
11
    if (DriverArgs.hasFlag(options::OPT_mno_mutable_globals,
238
11
                           options::OPT_mmutable_globals, false))
239
1
      getDriver().Diag(diag::err_drv_argument_not_allowed_with)
240
1
          << "-pthread"
241
1
          << "-mno-mutable-globals";
242
11
    if (DriverArgs.hasFlag(options::OPT_mno_sign_ext, options::OPT_msign_ext,
243
11
                           false))
244
1
      getDriver().Diag(diag::err_drv_argument_not_allowed_with)
245
1
          << "-pthread"
246
1
          << "-mno-sign-ext";
247
11
    CC1Args.push_back("-target-feature");
248
11
    CC1Args.push_back("+atomics");
249
11
    CC1Args.push_back("-target-feature");
250
11
    CC1Args.push_back("+bulk-memory");
251
11
    CC1Args.push_back("-target-feature");
252
11
    CC1Args.push_back("+mutable-globals");
253
11
    CC1Args.push_back("-target-feature");
254
11
    CC1Args.push_back("+sign-ext");
255
11
  }
256
257
71
  if (!DriverArgs.hasFlag(options::OPT_mmutable_globals,
258
69
                          options::OPT_mno_mutable_globals, false)) {
259
    // -fPIC implies +mutable-globals because the PIC ABI used by the linker
260
    // depends on importing and exporting mutable globals.
261
69
    llvm::Reloc::Model RelocationModel;
262
69
    unsigned PICLevel;
263
69
    bool IsPIE;
264
69
    std::tie(RelocationModel, PICLevel, IsPIE) =
265
69
        ParsePICArgs(*this, DriverArgs);
266
69
    if (RelocationModel == llvm::Reloc::PIC_) {
267
3
      if (DriverArgs.hasFlag(options::OPT_mno_mutable_globals,
268
2
                             options::OPT_mmutable_globals, false)) {
269
2
        getDriver().Diag(diag::err_drv_argument_not_allowed_with)
270
2
            << "-fPIC"
271
2
            << "-mno-mutable-globals";
272
2
      }
273
3
      CC1Args.push_back("-target-feature");
274
3
      CC1Args.push_back("+mutable-globals");
275
3
    }
276
69
  }
277
278
71
  if (DriverArgs.getLastArg(options::OPT_fwasm_exceptions)) {
279
    // '-fwasm-exceptions' is not compatible with '-mno-exception-handling'
280
3
    if (DriverArgs.hasFlag(options::OPT_mno_exception_handing,
281
3
                           options::OPT_mexception_handing, false))
282
1
      getDriver().Diag(diag::err_drv_argument_not_allowed_with)
283
1
          << "-fwasm-exceptions"
284
1
          << "-mno-exception-handling";
285
    // '-fwasm-exceptions' is not compatible with
286
    // '-mllvm -enable-emscripten-cxx-exceptions'
287
1
    for (const Arg *A : DriverArgs.filtered(options::OPT_mllvm)) {
288
1
      if (StringRef(A->getValue(0)) == "-enable-emscripten-cxx-exceptions")
289
1
        getDriver().Diag(diag::err_drv_argument_not_allowed_with)
290
1
            << "-fwasm-exceptions"
291
1
            << "-mllvm -enable-emscripten-cxx-exceptions";
292
1
    }
293
    // '-fwasm-exceptions' implies exception-handling feature
294
3
    CC1Args.push_back("-target-feature");
295
3
    CC1Args.push_back("+exception-handling");
296
3
  }
297
71
}
298
299
29
ToolChain::RuntimeLibType WebAssembly::GetDefaultRuntimeLibType() const {
300
29
  return ToolChain::RLT_CompilerRT;
301
29
}
302
303
ToolChain::CXXStdlibType
304
7
WebAssembly::GetCXXStdlibType(const ArgList &Args) const {
305
7
  if (Arg *A = Args.getLastArg(options::OPT_stdlib_EQ)) {
306
5
    StringRef Value = A->getValue();
307
5
    if (Value != "libc++")
308
5
      getDriver().Diag(diag::err_drv_invalid_stdlib_name)
309
5
          << A->getAsString(Args);
310
5
  }
311
7
  return ToolChain::CST_Libcxx;
312
7
}
313
314
void WebAssembly::AddClangSystemIncludeArgs(const ArgList &DriverArgs,
315
69
                                            ArgStringList &CC1Args) const {
316
69
  if (DriverArgs.hasArg(clang::driver::options::OPT_nostdinc))
317
0
    return;
318
319
69
  const Driver &D = getDriver();
320
321
69
  if (!DriverArgs.hasArg(options::OPT_nobuiltininc)) {
322
69
    SmallString<128> P(D.ResourceDir);
323
69
    llvm::sys::path::append(P, "include");
324
69
    addSystemInclude(DriverArgs, CC1Args, P);
325
69
  }
326
327
69
  if (DriverArgs.hasArg(options::OPT_nostdlibinc))
328
0
    return;
329
330
  // Check for configure-time C include directories.
331
69
  StringRef CIncludeDirs(C_INCLUDE_DIRS);
332
69
  if (CIncludeDirs != "") {
333
0
    SmallVector<StringRef, 5> dirs;
334
0
    CIncludeDirs.split(dirs, ":");
335
0
    for (StringRef dir : dirs) {
336
0
      StringRef Prefix =
337
0
          llvm::sys::path::is_absolute(dir) ? "" : StringRef(D.SysRoot);
338
0
      addExternCSystemInclude(DriverArgs, CC1Args, Prefix + dir);
339
0
    }
340
0
    return;
341
0
  }
342
343
69
  if (getTriple().getOS() != llvm::Triple::UnknownOS) {
344
8
    const std::string MultiarchTriple =
345
8
        getMultiarchTriple(D, getTriple(), D.SysRoot);
346
8
    addSystemInclude(DriverArgs, CC1Args, D.SysRoot + "/include/" + MultiarchTriple);
347
8
  }
348
69
  addSystemInclude(DriverArgs, CC1Args, D.SysRoot + "/include");
349
69
}
350
351
void WebAssembly::AddClangCXXStdlibIncludeArgs(const ArgList &DriverArgs,
352
13
                                               ArgStringList &CC1Args) const {
353
13
  if (!DriverArgs.hasArg(options::OPT_nostdlibinc) &&
354
13
      !DriverArgs.hasArg(options::OPT_nostdincxx)) {
355
13
    if (getTriple().getOS() != llvm::Triple::UnknownOS) {
356
3
      const std::string MultiarchTriple =
357
3
          getMultiarchTriple(getDriver(), getTriple(), getDriver().SysRoot);
358
3
      addSystemInclude(DriverArgs, CC1Args,
359
3
                       getDriver().SysRoot + "/include/" + MultiarchTriple +
360
3
                           "/c++/v1");
361
3
    }
362
13
    addSystemInclude(DriverArgs, CC1Args,
363
13
                     getDriver().SysRoot + "/include/c++/v1");
364
13
  }
365
13
}
366
367
void WebAssembly::AddCXXStdlibLibArgs(const llvm::opt::ArgList &Args,
368
7
                                      llvm::opt::ArgStringList &CmdArgs) const {
369
370
7
  switch (GetCXXStdlibType(Args)) {
371
7
  case ToolChain::CST_Libcxx:
372
7
    CmdArgs.push_back("-lc++");
373
7
    CmdArgs.push_back("-lc++abi");
374
7
    break;
375
0
  case ToolChain::CST_Libstdcxx:
376
0
    llvm_unreachable("invalid stdlib name");
377
7
  }
378
7
}
379
380
68
SanitizerMask WebAssembly::getSupportedSanitizers() const {
381
68
  SanitizerMask Res = ToolChain::getSupportedSanitizers();
382
68
  if (getTriple().isOSEmscripten()) {
383
1
    Res |= SanitizerKind::Vptr | SanitizerKind::Leak | SanitizerKind::Address;
384
1
  }
385
68
  return Res;
386
68
}
387
388
29
Tool *WebAssembly::buildLinker() const {
389
29
  return new tools::wasm::Linker(*this);
390
29
}