1 //===--- Multilib.cpp - Multilib Implementation ---------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "clang/Driver/Multilib.h"
12 #include "clang/Driver/Options.h"
13 #include "llvm/ADT/StringMap.h"
14 #include "llvm/ADT/StringRef.h"
15 #include "llvm/ADT/StringSet.h"
16 #include "llvm/Option/Arg.h"
17 #include "llvm/Option/ArgList.h"
18 #include "llvm/Option/OptTable.h"
19 #include "llvm/Option/Option.h"
20 #include "llvm/Support/Path.h"
21 #include "llvm/Support/Regex.h"
22 #include "llvm/Support/YAMLParser.h"
23 #include "llvm/Support/YAMLTraits.h"
24 #include "llvm/Support/raw_ostream.h"
27 using namespace clang::driver;
28 using namespace clang;
29 using namespace llvm::opt;
30 using namespace llvm::sys;
32 /// normalize Segment to "/foo/bar" or "".
33 static void normalizePathSegment(std::string &Segment) {
34 StringRef seg = Segment;
36 // Prune trailing "/" or "./"
38 StringRef last = path::filename(seg);
41 seg = path::parent_path(seg);
44 if (seg.empty() || seg == "/") {
50 if (seg.front() != '/') {
51 Segment = "/" + seg.str();
57 Multilib::Multilib(StringRef GCCSuffix, StringRef OSSuffix,
58 StringRef IncludeSuffix)
59 : GCCSuffix(GCCSuffix), OSSuffix(OSSuffix), IncludeSuffix(IncludeSuffix) {
60 normalizePathSegment(this->GCCSuffix);
61 normalizePathSegment(this->OSSuffix);
62 normalizePathSegment(this->IncludeSuffix);
65 Multilib &Multilib::gccSuffix(StringRef S) {
67 normalizePathSegment(GCCSuffix);
71 Multilib &Multilib::osSuffix(StringRef S) {
73 normalizePathSegment(OSSuffix);
77 Multilib &Multilib::includeSuffix(StringRef S) {
79 normalizePathSegment(IncludeSuffix);
83 void Multilib::print(raw_ostream &OS) const {
84 assert(GCCSuffix.empty() || (StringRef(GCCSuffix).front() == '/'));
85 if (GCCSuffix.empty())
88 OS << StringRef(GCCSuffix).drop_front();
91 for (StringRef Flag : Flags) {
92 if (Flag.front() == '+')
93 OS << "@" << Flag.substr(1);
97 bool Multilib::isValid() const {
98 llvm::StringMap<int> FlagSet;
99 for (unsigned I = 0, N = Flags.size(); I != N; ++I) {
100 StringRef Flag(Flags[I]);
101 llvm::StringMap<int>::iterator SI = FlagSet.find(Flag.substr(1));
103 assert(StringRef(Flag).front() == '+' || StringRef(Flag).front() == '-');
105 if (SI == FlagSet.end())
106 FlagSet[Flag.substr(1)] = I;
107 else if (Flags[I] != Flags[SI->getValue()])
113 bool Multilib::operator==(const Multilib &Other) const {
114 // Check whether the flags sets match
115 // allowing for the match to be order invariant
116 llvm::StringSet<> MyFlags;
117 for (const auto &Flag : Flags)
118 MyFlags.insert(Flag);
120 for (const auto &Flag : Other.Flags)
121 if (MyFlags.find(Flag) == MyFlags.end())
124 if (osSuffix() != Other.osSuffix())
127 if (gccSuffix() != Other.gccSuffix())
130 if (includeSuffix() != Other.includeSuffix())
136 raw_ostream &clang::driver::operator<<(raw_ostream &OS, const Multilib &M) {
141 MultilibSet &MultilibSet::Maybe(const Multilib &M) {
143 // Negate any '+' flags
144 for (StringRef Flag : M.flags()) {
145 if (Flag.front() == '+')
146 Opposite.flags().push_back(("-" + Flag.substr(1)).str());
148 return Either(M, Opposite);
151 MultilibSet &MultilibSet::Either(const Multilib &M1, const Multilib &M2) {
152 return Either({M1, M2});
155 MultilibSet &MultilibSet::Either(const Multilib &M1, const Multilib &M2,
156 const Multilib &M3) {
157 return Either({M1, M2, M3});
160 MultilibSet &MultilibSet::Either(const Multilib &M1, const Multilib &M2,
161 const Multilib &M3, const Multilib &M4) {
162 return Either({M1, M2, M3, M4});
165 MultilibSet &MultilibSet::Either(const Multilib &M1, const Multilib &M2,
166 const Multilib &M3, const Multilib &M4,
167 const Multilib &M5) {
168 return Either({M1, M2, M3, M4, M5});
171 static Multilib compose(const Multilib &Base, const Multilib &New) {
172 SmallString<128> GCCSuffix;
173 llvm::sys::path::append(GCCSuffix, "/", Base.gccSuffix(), New.gccSuffix());
174 SmallString<128> OSSuffix;
175 llvm::sys::path::append(OSSuffix, "/", Base.osSuffix(), New.osSuffix());
176 SmallString<128> IncludeSuffix;
177 llvm::sys::path::append(IncludeSuffix, "/", Base.includeSuffix(),
178 New.includeSuffix());
180 Multilib Composed(GCCSuffix, OSSuffix, IncludeSuffix);
182 Multilib::flags_list &Flags = Composed.flags();
184 Flags.insert(Flags.end(), Base.flags().begin(), Base.flags().end());
185 Flags.insert(Flags.end(), New.flags().begin(), New.flags().end());
190 MultilibSet &MultilibSet::Either(ArrayRef<Multilib> MultilibSegments) {
191 multilib_list Composed;
193 if (Multilibs.empty())
194 Multilibs.insert(Multilibs.end(), MultilibSegments.begin(),
195 MultilibSegments.end());
197 for (const Multilib &New : MultilibSegments) {
198 for (const Multilib &Base : *this) {
199 Multilib MO = compose(Base, New);
201 Composed.push_back(MO);
205 Multilibs = Composed;
211 MultilibSet &MultilibSet::FilterOut(FilterCallback F) {
212 filterInPlace(F, Multilibs);
216 MultilibSet &MultilibSet::FilterOut(const char *Regex) {
217 llvm::Regex R(Regex);
220 if (!R.isValid(Error)) {
221 llvm::errs() << Error;
222 llvm_unreachable("Invalid regex!");
226 filterInPlace([&R](const Multilib &M) { return R.match(M.gccSuffix()); },
231 void MultilibSet::push_back(const Multilib &M) { Multilibs.push_back(M); }
233 void MultilibSet::combineWith(const MultilibSet &Other) {
234 Multilibs.insert(Multilibs.end(), Other.begin(), Other.end());
237 static bool isFlagEnabled(StringRef Flag) {
238 char Indicator = Flag.front();
239 assert(Indicator == '+' || Indicator == '-');
240 return Indicator == '+';
243 bool MultilibSet::select(const Multilib::flags_list &Flags, Multilib &M) const {
244 llvm::StringMap<bool> FlagSet;
246 // Stuff all of the flags into the FlagSet such that a true mappend indicates
247 // the flag was enabled, and a false mappend indicates the flag was disabled.
248 for (StringRef Flag : Flags)
249 FlagSet[Flag.substr(1)] = isFlagEnabled(Flag);
251 multilib_list Filtered = filterCopy([&FlagSet](const Multilib &M) {
252 for (StringRef Flag : M.flags()) {
253 llvm::StringMap<bool>::const_iterator SI = FlagSet.find(Flag.substr(1));
254 if (SI != FlagSet.end())
255 if (SI->getValue() != isFlagEnabled(Flag))
261 if (Filtered.size() == 0)
263 if (Filtered.size() == 1) {
268 // TODO: pick the "best" multlib when more than one is suitable
273 void MultilibSet::print(raw_ostream &OS) const {
274 for (const Multilib &M : *this)
278 MultilibSet::multilib_list MultilibSet::filterCopy(FilterCallback F,
279 const multilib_list &Ms) {
280 multilib_list Copy(Ms);
281 filterInPlace(F, Copy);
285 void MultilibSet::filterInPlace(FilterCallback F, multilib_list &Ms) {
286 Ms.erase(std::remove_if(Ms.begin(), Ms.end(), F), Ms.end());
289 raw_ostream &clang::driver::operator<<(raw_ostream &OS, const MultilibSet &MS) {