Coverage Report

Created: 2019-01-21 03:01

/Users/buildslave/jenkins/workspace/clang-stage2-coverage-R/llvm/tools/lld/ELF/DriverUtils.cpp
Line
Count
Source (jump to first uncovered line)
1
//===- DriverUtils.cpp ----------------------------------------------------===//
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
// This file contains utility functions for the driver. Because there
10
// are so many small functions, we created this separate file to make
11
// Driver.cpp less cluttered.
12
//
13
//===----------------------------------------------------------------------===//
14
15
#include "Driver.h"
16
#include "lld/Common/ErrorHandler.h"
17
#include "lld/Common/Memory.h"
18
#include "lld/Common/Reproduce.h"
19
#include "lld/Common/Version.h"
20
#include "llvm/ADT/Optional.h"
21
#include "llvm/ADT/STLExtras.h"
22
#include "llvm/ADT/Triple.h"
23
#include "llvm/Option/Option.h"
24
#include "llvm/Support/CommandLine.h"
25
#include "llvm/Support/FileSystem.h"
26
#include "llvm/Support/Path.h"
27
#include "llvm/Support/Process.h"
28
29
using namespace llvm;
30
using namespace llvm::sys;
31
using namespace llvm::opt;
32
33
using namespace lld;
34
using namespace lld::elf;
35
36
// Create OptTable
37
38
// Create prefix string literals used in Options.td
39
#define PREFIX(NAME, VALUE) const char *const NAME[] = VALUE;
40
#include "Options.inc"
41
#undef PREFIX
42
43
// Create table mapping all options defined in Options.td
44
static const opt::OptTable::Info OptInfo[] = {
45
#define OPTION(X1, X2, ID, KIND, GROUP, ALIAS, X7, X8, X9, X10, X11, X12)      \
46
  {X1, X2, X10,         X11,         OPT_##ID, opt::Option::KIND##Class,       \
47
   X9, X8, OPT_##GROUP, OPT_##ALIAS, X7,       X12},
48
#include "Options.inc"
49
#undef OPTION
50
};
51
52
2.67k
ELFOptTable::ELFOptTable() : OptTable(OptInfo) {}
53
54
// Set color diagnostics according to -color-diagnostics={auto,always,never}
55
// or -no-color-diagnostics flags.
56
2.67k
static void handleColorDiagnostics(opt::InputArgList &Args) {
57
2.67k
  auto *Arg = Args.getLastArg(OPT_color_diagnostics, OPT_color_diagnostics_eq,
58
2.67k
                              OPT_no_color_diagnostics);
59
2.67k
  if (!Arg)
60
2.66k
    return;
61
5
  if (Arg->getOption().getID() == OPT_color_diagnostics) {
62
1
    errorHandler().ColorDiagnostics = true;
63
4
  } else if (Arg->getOption().getID() == OPT_no_color_diagnostics) {
64
1
    errorHandler().ColorDiagnostics = false;
65
3
  } else {
66
3
    StringRef S = Arg->getValue();
67
3
    if (S == "always")
68
1
      errorHandler().ColorDiagnostics = true;
69
2
    else if (S == "never")
70
1
      errorHandler().ColorDiagnostics = false;
71
1
    else if (S != "auto")
72
1
      error("unknown option: --color-diagnostics=" + S);
73
3
  }
74
5
}
75
76
2.67k
static cl::TokenizerCallback getQuotingStyle(opt::InputArgList &Args) {
77
2.67k
  if (auto *Arg = Args.getLastArg(OPT_rsp_quoting)) {
78
3
    StringRef S = Arg->getValue();
79
3
    if (S != "windows" && 
S != "posix"2
)
80
1
      error("invalid response file quoting: " + S);
81
3
    if (S == "windows")
82
1
      return cl::TokenizeWindowsCommandLine;
83
2
    return cl::TokenizeGNUCommandLine;
84
2
  }
85
2.66k
  if (Triple(sys::getProcessTriple()).getOS() == Triple::Win32)
86
0
    return cl::TokenizeWindowsCommandLine;
87
2.66k
  return cl::TokenizeGNUCommandLine;
88
2.66k
}
89
90
// Gold LTO plugin takes a `--plugin-opt foo=bar` option as an alias for
91
// `--plugin-opt=foo=bar`. We want to handle `--plugin-opt=foo=` as an
92
// option name and `bar` as a value. Unfortunately, OptParser cannot
93
// handle an option with a space in it.
94
//
95
// In this function, we concatenate command line arguments so that
96
// `--plugin-opt <foo>` is converted to `--plugin-opt=<foo>`. This is a
97
// bit hacky, but looks like it is still better than handling --plugin-opt
98
// options by hand.
99
2.67k
static void concatLTOPluginOptions(SmallVectorImpl<const char *> &Args) {
100
2.67k
  SmallVector<const char *, 256> V;
101
16.1k
  for (size_t I = 0, E = Args.size(); I != E; 
++I13.5k
) {
102
13.5k
    StringRef S = Args[I];
103
13.5k
    if ((S == "-plugin-opt" || S == "--plugin-opt") && 
I + 1 != E1
) {
104
1
      V.push_back(Saver.save(S + "=" + Args[I + 1]).data());
105
1
      ++I;
106
13.5k
    } else {
107
13.5k
      V.push_back(Args[I]);
108
13.5k
    }
109
13.5k
  }
110
2.67k
  Args = std::move(V);
111
2.67k
}
112
113
// Parses a given list of options.
114
2.67k
opt::InputArgList ELFOptTable::parse(ArrayRef<const char *> Argv) {
115
2.67k
  // Make InputArgList from string vectors.
116
2.67k
  unsigned MissingIndex;
117
2.67k
  unsigned MissingCount;
118
2.67k
  SmallVector<const char *, 256> Vec(Argv.data(), Argv.data() + Argv.size());
119
2.67k
120
2.67k
  // We need to get the quoting style for response files before parsing all
121
2.67k
  // options so we parse here before and ignore all the options but
122
2.67k
  // --rsp-quoting.
123
2.67k
  opt::InputArgList Args = this->ParseArgs(Vec, MissingIndex, MissingCount);
124
2.67k
125
2.67k
  // Expand response files (arguments in the form of @<filename>)
126
2.67k
  // and then parse the argument again.
127
2.67k
  cl::ExpandResponseFiles(Saver, getQuotingStyle(Args), Vec);
128
2.67k
  concatLTOPluginOptions(Vec);
129
2.67k
  Args = this->ParseArgs(Vec, MissingIndex, MissingCount);
130
2.67k
131
2.67k
  handleColorDiagnostics(Args);
132
2.67k
  if (MissingCount)
133
2
    error(Twine(Args.getArgString(MissingIndex)) + ": missing argument");
134
2.67k
135
2.67k
  for (auto *Arg : Args.filtered(OPT_UNKNOWN))
136
6
    error("unknown argument: " + Arg->getSpelling());
137
2.67k
  return Args;
138
2.67k
}
139
140
2
void elf::printHelp() {
141
2
  ELFOptTable().PrintHelp(
142
2
      outs(), (Config->ProgName + " [options] file...").str().c_str(), "lld",
143
2
      false /*ShowHidden*/, true /*ShowAllAliases*/);
144
2
  outs() << "\n";
145
2
146
2
  // Scripts generated by Libtool versions up to at least 2.4.6 (the most
147
2
  // recent version as of March 2017) expect /: supported targets:.* elf/
148
2
  // in a message for the -help option. If it doesn't match, the scripts
149
2
  // assume that the linker doesn't support very basic features such as
150
2
  // shared libraries. Therefore, we need to print out at least "elf".
151
2
  outs() << Config->ProgName << ": supported targets: elf\n";
152
2
}
153
154
// Reconstructs command line arguments so that so that you can re-run
155
// the same command with the same inputs. This is for --reproduce.
156
10
std::string elf::createResponseFile(const opt::InputArgList &Args) {
157
10
  SmallString<0> Data;
158
10
  raw_svector_ostream OS(Data);
159
10
  OS << "--chroot .\n";
160
10
161
10
  // Copy the command line to the output while rewriting paths.
162
50
  for (auto *Arg : Args) {
163
50
    switch (Arg->getOption().getUnaliasedOption().getID()) {
164
50
    case OPT_reproduce:
165
9
      break;
166
50
    case OPT_INPUT:
167
10
      OS << quote(rewritePath(Arg->getValue())) << "\n";
168
10
      break;
169
50
    case OPT_o:
170
8
      // If -o path contains directories, "lld @response.txt" will likely
171
8
      // fail because the archive we are creating doesn't contain empty
172
8
      // directories for the output path (-o doesn't create directories).
173
8
      // Strip directories to prevent the issue.
174
8
      OS << "-o " << quote(sys::path::filename(Arg->getValue())) << "\n";
175
8
      break;
176
50
    case OPT_dynamic_list:
177
10
    case OPT_library_path:
178
10
    case OPT_rpath:
179
10
    case OPT_script:
180
10
    case OPT_symbol_ordering_file:
181
10
    case OPT_sysroot:
182
10
    case OPT_version_script:
183
10
      OS << Arg->getSpelling() << " " << quote(rewritePath(Arg->getValue()))
184
10
         << "\n";
185
10
      break;
186
13
    default:
187
13
      OS << toString(*Arg) << "\n";
188
50
    }
189
50
  }
190
10
  return Data.str();
191
10
}
192
193
// Find a file by concatenating given paths. If a resulting path
194
// starts with "=", the character is replaced with a --sysroot value.
195
45
static Optional<std::string> findFile(StringRef Path1, const Twine &Path2) {
196
45
  SmallString<128> S;
197
45
  if (Path1.startswith("="))
198
5
    path::append(S, Config->Sysroot, Path1.substr(1), Path2);
199
40
  else
200
40
    path::append(S, Path1, Path2);
201
45
202
45
  if (fs::exists(S))
203
37
    return S.str().str();
204
8
  return None;
205
8
}
206
207
26
Optional<std::string> elf::findFromSearchPaths(StringRef Path) {
208
26
  for (StringRef Dir : Config->SearchPaths)
209
20
    if (Optional<std::string> S = findFile(Dir, Path))
210
17
      return S;
211
26
  
return None9
;
212
26
}
213
214
// This is for -lfoo. We'll look for libfoo.so or libfoo.a from
215
// search paths.
216
36
Optional<std::string> elf::searchLibrary(StringRef Name) {
217
36
  if (Name.startswith(":"))
218
10
    return findFromSearchPaths(Name.substr(1));
219
26
220
26
  for (StringRef Dir : Config->SearchPaths) {
221
22
    if (!Config->Static)
222
15
      if (Optional<std::string> S = findFile(Dir, "lib" + Name + ".so"))
223
12
        return S;
224
10
    if (Optional<std::string> S = findFile(Dir, "lib" + Name + ".a"))
225
8
      return S;
226
10
  }
227
26
  
return None6
;
228
26
}
229
230
// If a linker/version script doesn't exist in the current directory, we also
231
// look for the script in the '-L' search paths. This matches the behaviour of
232
// '-T', --version-script=, and linker script INPUT() command in ld.bfd.
233
625
Optional<std::string> elf::searchScript(StringRef Name) {
234
625
  if (fs::exists(Name))
235
613
    return Name.str();
236
12
  return findFromSearchPaths(Name);
237
12
}