annotate clang/lib/Driver/Multilib.cpp @ 176:de4ac79aef9d

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 17:13:11 +0900
parents 1d019706d866
children c4bab56944e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===- Multilib.cpp - Multilib Implementation -----------------------------===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
anatofuz
parents:
diff changeset
4 // See https://llvm.org/LICENSE.txt for license information.
anatofuz
parents:
diff changeset
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
anatofuz
parents:
diff changeset
6 //
anatofuz
parents:
diff changeset
7 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
8
anatofuz
parents:
diff changeset
9 #include "clang/Driver/Multilib.h"
anatofuz
parents:
diff changeset
10 #include "clang/Basic/LLVM.h"
anatofuz
parents:
diff changeset
11 #include "llvm/ADT/SmallString.h"
anatofuz
parents:
diff changeset
12 #include "llvm/ADT/StringMap.h"
anatofuz
parents:
diff changeset
13 #include "llvm/ADT/StringRef.h"
anatofuz
parents:
diff changeset
14 #include "llvm/ADT/StringSet.h"
anatofuz
parents:
diff changeset
15 #include "llvm/Support/Compiler.h"
anatofuz
parents:
diff changeset
16 #include "llvm/Support/ErrorHandling.h"
anatofuz
parents:
diff changeset
17 #include "llvm/Support/Path.h"
anatofuz
parents:
diff changeset
18 #include "llvm/Support/Regex.h"
anatofuz
parents:
diff changeset
19 #include "llvm/Support/raw_ostream.h"
anatofuz
parents:
diff changeset
20 #include <algorithm>
anatofuz
parents:
diff changeset
21 #include <cassert>
anatofuz
parents:
diff changeset
22 #include <string>
anatofuz
parents:
diff changeset
23
anatofuz
parents:
diff changeset
24 using namespace clang;
anatofuz
parents:
diff changeset
25 using namespace driver;
anatofuz
parents:
diff changeset
26 using namespace llvm::sys;
anatofuz
parents:
diff changeset
27
anatofuz
parents:
diff changeset
28 /// normalize Segment to "/foo/bar" or "".
anatofuz
parents:
diff changeset
29 static void normalizePathSegment(std::string &Segment) {
anatofuz
parents:
diff changeset
30 StringRef seg = Segment;
anatofuz
parents:
diff changeset
31
anatofuz
parents:
diff changeset
32 // Prune trailing "/" or "./"
anatofuz
parents:
diff changeset
33 while (true) {
anatofuz
parents:
diff changeset
34 StringRef last = path::filename(seg);
anatofuz
parents:
diff changeset
35 if (last != ".")
anatofuz
parents:
diff changeset
36 break;
anatofuz
parents:
diff changeset
37 seg = path::parent_path(seg);
anatofuz
parents:
diff changeset
38 }
anatofuz
parents:
diff changeset
39
anatofuz
parents:
diff changeset
40 if (seg.empty() || seg == "/") {
anatofuz
parents:
diff changeset
41 Segment.clear();
anatofuz
parents:
diff changeset
42 return;
anatofuz
parents:
diff changeset
43 }
anatofuz
parents:
diff changeset
44
anatofuz
parents:
diff changeset
45 // Add leading '/'
anatofuz
parents:
diff changeset
46 if (seg.front() != '/') {
anatofuz
parents:
diff changeset
47 Segment = "/" + seg.str();
anatofuz
parents:
diff changeset
48 } else {
anatofuz
parents:
diff changeset
49 Segment = std::string(seg);
anatofuz
parents:
diff changeset
50 }
anatofuz
parents:
diff changeset
51 }
anatofuz
parents:
diff changeset
52
anatofuz
parents:
diff changeset
53 Multilib::Multilib(StringRef GCCSuffix, StringRef OSSuffix,
anatofuz
parents:
diff changeset
54 StringRef IncludeSuffix, int Priority)
anatofuz
parents:
diff changeset
55 : GCCSuffix(GCCSuffix), OSSuffix(OSSuffix), IncludeSuffix(IncludeSuffix),
anatofuz
parents:
diff changeset
56 Priority(Priority) {
anatofuz
parents:
diff changeset
57 normalizePathSegment(this->GCCSuffix);
anatofuz
parents:
diff changeset
58 normalizePathSegment(this->OSSuffix);
anatofuz
parents:
diff changeset
59 normalizePathSegment(this->IncludeSuffix);
anatofuz
parents:
diff changeset
60 }
anatofuz
parents:
diff changeset
61
anatofuz
parents:
diff changeset
62 Multilib &Multilib::gccSuffix(StringRef S) {
anatofuz
parents:
diff changeset
63 GCCSuffix = std::string(S);
anatofuz
parents:
diff changeset
64 normalizePathSegment(GCCSuffix);
anatofuz
parents:
diff changeset
65 return *this;
anatofuz
parents:
diff changeset
66 }
anatofuz
parents:
diff changeset
67
anatofuz
parents:
diff changeset
68 Multilib &Multilib::osSuffix(StringRef S) {
anatofuz
parents:
diff changeset
69 OSSuffix = std::string(S);
anatofuz
parents:
diff changeset
70 normalizePathSegment(OSSuffix);
anatofuz
parents:
diff changeset
71 return *this;
anatofuz
parents:
diff changeset
72 }
anatofuz
parents:
diff changeset
73
anatofuz
parents:
diff changeset
74 Multilib &Multilib::includeSuffix(StringRef S) {
anatofuz
parents:
diff changeset
75 IncludeSuffix = std::string(S);
anatofuz
parents:
diff changeset
76 normalizePathSegment(IncludeSuffix);
anatofuz
parents:
diff changeset
77 return *this;
anatofuz
parents:
diff changeset
78 }
anatofuz
parents:
diff changeset
79
anatofuz
parents:
diff changeset
80 LLVM_DUMP_METHOD void Multilib::dump() const {
anatofuz
parents:
diff changeset
81 print(llvm::errs());
anatofuz
parents:
diff changeset
82 }
anatofuz
parents:
diff changeset
83
anatofuz
parents:
diff changeset
84 void Multilib::print(raw_ostream &OS) const {
anatofuz
parents:
diff changeset
85 assert(GCCSuffix.empty() || (StringRef(GCCSuffix).front() == '/'));
anatofuz
parents:
diff changeset
86 if (GCCSuffix.empty())
anatofuz
parents:
diff changeset
87 OS << ".";
anatofuz
parents:
diff changeset
88 else {
anatofuz
parents:
diff changeset
89 OS << StringRef(GCCSuffix).drop_front();
anatofuz
parents:
diff changeset
90 }
anatofuz
parents:
diff changeset
91 OS << ";";
anatofuz
parents:
diff changeset
92 for (StringRef Flag : Flags) {
anatofuz
parents:
diff changeset
93 if (Flag.front() == '+')
anatofuz
parents:
diff changeset
94 OS << "@" << Flag.substr(1);
anatofuz
parents:
diff changeset
95 }
anatofuz
parents:
diff changeset
96 }
anatofuz
parents:
diff changeset
97
anatofuz
parents:
diff changeset
98 bool Multilib::isValid() const {
anatofuz
parents:
diff changeset
99 llvm::StringMap<int> FlagSet;
anatofuz
parents:
diff changeset
100 for (unsigned I = 0, N = Flags.size(); I != N; ++I) {
anatofuz
parents:
diff changeset
101 StringRef Flag(Flags[I]);
anatofuz
parents:
diff changeset
102 llvm::StringMap<int>::iterator SI = FlagSet.find(Flag.substr(1));
anatofuz
parents:
diff changeset
103
anatofuz
parents:
diff changeset
104 assert(StringRef(Flag).front() == '+' || StringRef(Flag).front() == '-');
anatofuz
parents:
diff changeset
105
anatofuz
parents:
diff changeset
106 if (SI == FlagSet.end())
anatofuz
parents:
diff changeset
107 FlagSet[Flag.substr(1)] = I;
anatofuz
parents:
diff changeset
108 else if (Flags[I] != Flags[SI->getValue()])
anatofuz
parents:
diff changeset
109 return false;
anatofuz
parents:
diff changeset
110 }
anatofuz
parents:
diff changeset
111 return true;
anatofuz
parents:
diff changeset
112 }
anatofuz
parents:
diff changeset
113
anatofuz
parents:
diff changeset
114 bool Multilib::operator==(const Multilib &Other) const {
anatofuz
parents:
diff changeset
115 // Check whether the flags sets match
anatofuz
parents:
diff changeset
116 // allowing for the match to be order invariant
anatofuz
parents:
diff changeset
117 llvm::StringSet<> MyFlags;
anatofuz
parents:
diff changeset
118 for (const auto &Flag : Flags)
anatofuz
parents:
diff changeset
119 MyFlags.insert(Flag);
anatofuz
parents:
diff changeset
120
anatofuz
parents:
diff changeset
121 for (const auto &Flag : Other.Flags)
anatofuz
parents:
diff changeset
122 if (MyFlags.find(Flag) == MyFlags.end())
anatofuz
parents:
diff changeset
123 return false;
anatofuz
parents:
diff changeset
124
anatofuz
parents:
diff changeset
125 if (osSuffix() != Other.osSuffix())
anatofuz
parents:
diff changeset
126 return false;
anatofuz
parents:
diff changeset
127
anatofuz
parents:
diff changeset
128 if (gccSuffix() != Other.gccSuffix())
anatofuz
parents:
diff changeset
129 return false;
anatofuz
parents:
diff changeset
130
anatofuz
parents:
diff changeset
131 if (includeSuffix() != Other.includeSuffix())
anatofuz
parents:
diff changeset
132 return false;
anatofuz
parents:
diff changeset
133
anatofuz
parents:
diff changeset
134 return true;
anatofuz
parents:
diff changeset
135 }
anatofuz
parents:
diff changeset
136
anatofuz
parents:
diff changeset
137 raw_ostream &clang::driver::operator<<(raw_ostream &OS, const Multilib &M) {
anatofuz
parents:
diff changeset
138 M.print(OS);
anatofuz
parents:
diff changeset
139 return OS;
anatofuz
parents:
diff changeset
140 }
anatofuz
parents:
diff changeset
141
anatofuz
parents:
diff changeset
142 MultilibSet &MultilibSet::Maybe(const Multilib &M) {
anatofuz
parents:
diff changeset
143 Multilib Opposite;
anatofuz
parents:
diff changeset
144 // Negate any '+' flags
anatofuz
parents:
diff changeset
145 for (StringRef Flag : M.flags()) {
anatofuz
parents:
diff changeset
146 if (Flag.front() == '+')
anatofuz
parents:
diff changeset
147 Opposite.flags().push_back(("-" + Flag.substr(1)).str());
anatofuz
parents:
diff changeset
148 }
anatofuz
parents:
diff changeset
149 return Either(M, Opposite);
anatofuz
parents:
diff changeset
150 }
anatofuz
parents:
diff changeset
151
anatofuz
parents:
diff changeset
152 MultilibSet &MultilibSet::Either(const Multilib &M1, const Multilib &M2) {
anatofuz
parents:
diff changeset
153 return Either({M1, M2});
anatofuz
parents:
diff changeset
154 }
anatofuz
parents:
diff changeset
155
anatofuz
parents:
diff changeset
156 MultilibSet &MultilibSet::Either(const Multilib &M1, const Multilib &M2,
anatofuz
parents:
diff changeset
157 const Multilib &M3) {
anatofuz
parents:
diff changeset
158 return Either({M1, M2, M3});
anatofuz
parents:
diff changeset
159 }
anatofuz
parents:
diff changeset
160
anatofuz
parents:
diff changeset
161 MultilibSet &MultilibSet::Either(const Multilib &M1, const Multilib &M2,
anatofuz
parents:
diff changeset
162 const Multilib &M3, const Multilib &M4) {
anatofuz
parents:
diff changeset
163 return Either({M1, M2, M3, M4});
anatofuz
parents:
diff changeset
164 }
anatofuz
parents:
diff changeset
165
anatofuz
parents:
diff changeset
166 MultilibSet &MultilibSet::Either(const Multilib &M1, const Multilib &M2,
anatofuz
parents:
diff changeset
167 const Multilib &M3, const Multilib &M4,
anatofuz
parents:
diff changeset
168 const Multilib &M5) {
anatofuz
parents:
diff changeset
169 return Either({M1, M2, M3, M4, M5});
anatofuz
parents:
diff changeset
170 }
anatofuz
parents:
diff changeset
171
anatofuz
parents:
diff changeset
172 static Multilib compose(const Multilib &Base, const Multilib &New) {
anatofuz
parents:
diff changeset
173 SmallString<128> GCCSuffix;
anatofuz
parents:
diff changeset
174 llvm::sys::path::append(GCCSuffix, "/", Base.gccSuffix(), New.gccSuffix());
anatofuz
parents:
diff changeset
175 SmallString<128> OSSuffix;
anatofuz
parents:
diff changeset
176 llvm::sys::path::append(OSSuffix, "/", Base.osSuffix(), New.osSuffix());
anatofuz
parents:
diff changeset
177 SmallString<128> IncludeSuffix;
anatofuz
parents:
diff changeset
178 llvm::sys::path::append(IncludeSuffix, "/", Base.includeSuffix(),
anatofuz
parents:
diff changeset
179 New.includeSuffix());
anatofuz
parents:
diff changeset
180
anatofuz
parents:
diff changeset
181 Multilib Composed(GCCSuffix, OSSuffix, IncludeSuffix);
anatofuz
parents:
diff changeset
182
anatofuz
parents:
diff changeset
183 Multilib::flags_list &Flags = Composed.flags();
anatofuz
parents:
diff changeset
184
anatofuz
parents:
diff changeset
185 Flags.insert(Flags.end(), Base.flags().begin(), Base.flags().end());
anatofuz
parents:
diff changeset
186 Flags.insert(Flags.end(), New.flags().begin(), New.flags().end());
anatofuz
parents:
diff changeset
187
anatofuz
parents:
diff changeset
188 return Composed;
anatofuz
parents:
diff changeset
189 }
anatofuz
parents:
diff changeset
190
anatofuz
parents:
diff changeset
191 MultilibSet &MultilibSet::Either(ArrayRef<Multilib> MultilibSegments) {
anatofuz
parents:
diff changeset
192 multilib_list Composed;
anatofuz
parents:
diff changeset
193
anatofuz
parents:
diff changeset
194 if (Multilibs.empty())
anatofuz
parents:
diff changeset
195 Multilibs.insert(Multilibs.end(), MultilibSegments.begin(),
anatofuz
parents:
diff changeset
196 MultilibSegments.end());
anatofuz
parents:
diff changeset
197 else {
anatofuz
parents:
diff changeset
198 for (const auto &New : MultilibSegments) {
anatofuz
parents:
diff changeset
199 for (const auto &Base : *this) {
anatofuz
parents:
diff changeset
200 Multilib MO = compose(Base, New);
anatofuz
parents:
diff changeset
201 if (MO.isValid())
anatofuz
parents:
diff changeset
202 Composed.push_back(MO);
anatofuz
parents:
diff changeset
203 }
anatofuz
parents:
diff changeset
204 }
anatofuz
parents:
diff changeset
205
anatofuz
parents:
diff changeset
206 Multilibs = Composed;
anatofuz
parents:
diff changeset
207 }
anatofuz
parents:
diff changeset
208
anatofuz
parents:
diff changeset
209 return *this;
anatofuz
parents:
diff changeset
210 }
anatofuz
parents:
diff changeset
211
anatofuz
parents:
diff changeset
212 MultilibSet &MultilibSet::FilterOut(FilterCallback F) {
anatofuz
parents:
diff changeset
213 filterInPlace(F, Multilibs);
anatofuz
parents:
diff changeset
214 return *this;
anatofuz
parents:
diff changeset
215 }
anatofuz
parents:
diff changeset
216
anatofuz
parents:
diff changeset
217 MultilibSet &MultilibSet::FilterOut(const char *Regex) {
anatofuz
parents:
diff changeset
218 llvm::Regex R(Regex);
anatofuz
parents:
diff changeset
219 #ifndef NDEBUG
anatofuz
parents:
diff changeset
220 std::string Error;
anatofuz
parents:
diff changeset
221 if (!R.isValid(Error)) {
anatofuz
parents:
diff changeset
222 llvm::errs() << Error;
anatofuz
parents:
diff changeset
223 llvm_unreachable("Invalid regex!");
anatofuz
parents:
diff changeset
224 }
anatofuz
parents:
diff changeset
225 #endif
anatofuz
parents:
diff changeset
226
anatofuz
parents:
diff changeset
227 filterInPlace([&R](const Multilib &M) { return R.match(M.gccSuffix()); },
anatofuz
parents:
diff changeset
228 Multilibs);
anatofuz
parents:
diff changeset
229 return *this;
anatofuz
parents:
diff changeset
230 }
anatofuz
parents:
diff changeset
231
anatofuz
parents:
diff changeset
232 void MultilibSet::push_back(const Multilib &M) { Multilibs.push_back(M); }
anatofuz
parents:
diff changeset
233
anatofuz
parents:
diff changeset
234 void MultilibSet::combineWith(const MultilibSet &Other) {
anatofuz
parents:
diff changeset
235 Multilibs.insert(Multilibs.end(), Other.begin(), Other.end());
anatofuz
parents:
diff changeset
236 }
anatofuz
parents:
diff changeset
237
anatofuz
parents:
diff changeset
238 static bool isFlagEnabled(StringRef Flag) {
anatofuz
parents:
diff changeset
239 char Indicator = Flag.front();
anatofuz
parents:
diff changeset
240 assert(Indicator == '+' || Indicator == '-');
anatofuz
parents:
diff changeset
241 return Indicator == '+';
anatofuz
parents:
diff changeset
242 }
anatofuz
parents:
diff changeset
243
anatofuz
parents:
diff changeset
244 bool MultilibSet::select(const Multilib::flags_list &Flags, Multilib &M) const {
anatofuz
parents:
diff changeset
245 llvm::StringMap<bool> FlagSet;
anatofuz
parents:
diff changeset
246
anatofuz
parents:
diff changeset
247 // Stuff all of the flags into the FlagSet such that a true mappend indicates
anatofuz
parents:
diff changeset
248 // the flag was enabled, and a false mappend indicates the flag was disabled.
anatofuz
parents:
diff changeset
249 for (StringRef Flag : Flags)
anatofuz
parents:
diff changeset
250 FlagSet[Flag.substr(1)] = isFlagEnabled(Flag);
anatofuz
parents:
diff changeset
251
anatofuz
parents:
diff changeset
252 multilib_list Filtered = filterCopy([&FlagSet](const Multilib &M) {
anatofuz
parents:
diff changeset
253 for (StringRef Flag : M.flags()) {
anatofuz
parents:
diff changeset
254 llvm::StringMap<bool>::const_iterator SI = FlagSet.find(Flag.substr(1));
anatofuz
parents:
diff changeset
255 if (SI != FlagSet.end())
anatofuz
parents:
diff changeset
256 if (SI->getValue() != isFlagEnabled(Flag))
anatofuz
parents:
diff changeset
257 return true;
anatofuz
parents:
diff changeset
258 }
anatofuz
parents:
diff changeset
259 return false;
anatofuz
parents:
diff changeset
260 }, Multilibs);
anatofuz
parents:
diff changeset
261
anatofuz
parents:
diff changeset
262 if (Filtered.empty())
anatofuz
parents:
diff changeset
263 return false;
anatofuz
parents:
diff changeset
264 if (Filtered.size() == 1) {
anatofuz
parents:
diff changeset
265 M = Filtered[0];
anatofuz
parents:
diff changeset
266 return true;
anatofuz
parents:
diff changeset
267 }
anatofuz
parents:
diff changeset
268
anatofuz
parents:
diff changeset
269 // Sort multilibs by priority and select the one with the highest priority.
anatofuz
parents:
diff changeset
270 llvm::sort(Filtered.begin(), Filtered.end(),
anatofuz
parents:
diff changeset
271 [](const Multilib &a, const Multilib &b) -> bool {
anatofuz
parents:
diff changeset
272 return a.priority() > b.priority();
anatofuz
parents:
diff changeset
273 });
anatofuz
parents:
diff changeset
274
anatofuz
parents:
diff changeset
275 if (Filtered[0].priority() > Filtered[1].priority()) {
anatofuz
parents:
diff changeset
276 M = Filtered[0];
anatofuz
parents:
diff changeset
277 return true;
anatofuz
parents:
diff changeset
278 }
anatofuz
parents:
diff changeset
279
anatofuz
parents:
diff changeset
280 // TODO: We should consider returning llvm::Error rather than aborting.
anatofuz
parents:
diff changeset
281 assert(false && "More than one multilib with the same priority");
anatofuz
parents:
diff changeset
282 return false;
anatofuz
parents:
diff changeset
283 }
anatofuz
parents:
diff changeset
284
anatofuz
parents:
diff changeset
285 LLVM_DUMP_METHOD void MultilibSet::dump() const {
anatofuz
parents:
diff changeset
286 print(llvm::errs());
anatofuz
parents:
diff changeset
287 }
anatofuz
parents:
diff changeset
288
anatofuz
parents:
diff changeset
289 void MultilibSet::print(raw_ostream &OS) const {
anatofuz
parents:
diff changeset
290 for (const auto &M : *this)
anatofuz
parents:
diff changeset
291 OS << M << "\n";
anatofuz
parents:
diff changeset
292 }
anatofuz
parents:
diff changeset
293
anatofuz
parents:
diff changeset
294 MultilibSet::multilib_list MultilibSet::filterCopy(FilterCallback F,
anatofuz
parents:
diff changeset
295 const multilib_list &Ms) {
anatofuz
parents:
diff changeset
296 multilib_list Copy(Ms);
anatofuz
parents:
diff changeset
297 filterInPlace(F, Copy);
anatofuz
parents:
diff changeset
298 return Copy;
anatofuz
parents:
diff changeset
299 }
anatofuz
parents:
diff changeset
300
anatofuz
parents:
diff changeset
301 void MultilibSet::filterInPlace(FilterCallback F, multilib_list &Ms) {
anatofuz
parents:
diff changeset
302 Ms.erase(std::remove_if(Ms.begin(), Ms.end(), F), Ms.end());
anatofuz
parents:
diff changeset
303 }
anatofuz
parents:
diff changeset
304
anatofuz
parents:
diff changeset
305 raw_ostream &clang::driver::operator<<(raw_ostream &OS, const MultilibSet &MS) {
anatofuz
parents:
diff changeset
306 MS.print(OS);
anatofuz
parents:
diff changeset
307 return OS;
anatofuz
parents:
diff changeset
308 }