clang  14.0.0git
Multilib.h
Go to the documentation of this file.
1 //===- Multilib.h -----------------------------------------------*- 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 #ifndef LLVM_CLANG_DRIVER_MULTILIB_H
10 #define LLVM_CLANG_DRIVER_MULTILIB_H
11 
12 #include "clang/Basic/LLVM.h"
13 #include "llvm/ADT/ArrayRef.h"
14 #include "llvm/ADT/STLExtras.h"
15 #include "llvm/ADT/StringRef.h"
16 #include "llvm/Support/Compiler.h"
17 #include <cassert>
18 #include <functional>
19 #include <string>
20 #include <utility>
21 #include <vector>
22 
23 namespace clang {
24 namespace driver {
25 
26 /// This corresponds to a single GCC Multilib, or a segment of one controlled
27 /// by a command line flag
28 class Multilib {
29 public:
30  using flags_list = std::vector<std::string>;
31 
32 private:
33  std::string GCCSuffix;
34  std::string OSSuffix;
35  std::string IncludeSuffix;
36  flags_list Flags;
37  int Priority;
38 
39 public:
40  Multilib(StringRef GCCSuffix = {}, StringRef OSSuffix = {},
41  StringRef IncludeSuffix = {}, int Priority = 0);
42 
43  /// Get the detected GCC installation path suffix for the multi-arch
44  /// target variant. Always starts with a '/', unless empty
45  const std::string &gccSuffix() const {
46  assert(GCCSuffix.empty() ||
47  (StringRef(GCCSuffix).front() == '/' && GCCSuffix.size() > 1));
48  return GCCSuffix;
49  }
50 
51  /// Set the GCC installation path suffix.
52  Multilib &gccSuffix(StringRef S);
53 
54  /// Get the detected os path suffix for the multi-arch
55  /// target variant. Always starts with a '/', unless empty
56  const std::string &osSuffix() const {
57  assert(OSSuffix.empty() ||
58  (StringRef(OSSuffix).front() == '/' && OSSuffix.size() > 1));
59  return OSSuffix;
60  }
61 
62  /// Set the os path suffix.
63  Multilib &osSuffix(StringRef S);
64 
65  /// Get the include directory suffix. Always starts with a '/', unless
66  /// empty
67  const std::string &includeSuffix() const {
68  assert(IncludeSuffix.empty() ||
69  (StringRef(IncludeSuffix).front() == '/' && IncludeSuffix.size() > 1));
70  return IncludeSuffix;
71  }
72 
73  /// Set the include directory suffix
74  Multilib &includeSuffix(StringRef S);
75 
76  /// Get the flags that indicate or contraindicate this multilib's use
77  /// All elements begin with either '+' or '-'
78  const flags_list &flags() const { return Flags; }
79  flags_list &flags() { return Flags; }
80 
81  /// Returns the multilib priority. When more than one multilib matches flags,
82  /// the one with the highest priority is selected, with 0 being the default.
83  int priority() const { return Priority; }
84 
85  /// Add a flag to the flags list
86  /// \p Flag must be a flag accepted by the driver with its leading '-' removed,
87  /// and replaced with either:
88  /// '-' which contraindicates using this multilib with that flag
89  /// or:
90  /// '+' which promotes using this multilib in the presence of that flag
91  /// otherwise '-print-multi-lib' will not emit them correctly.
92  Multilib &flag(StringRef F) {
93  assert(F.front() == '+' || F.front() == '-');
94  Flags.push_back(std::string(F));
95  return *this;
96  }
97 
98  LLVM_DUMP_METHOD void dump() const;
99  /// print summary of the Multilib
100  void print(raw_ostream &OS) const;
101 
102  /// Check whether any of the 'against' flags contradict the 'for' flags.
103  bool isValid() const;
104 
105  /// Check whether the default is selected
106  bool isDefault() const
107  { return GCCSuffix.empty() && OSSuffix.empty() && IncludeSuffix.empty(); }
108 
109  bool operator==(const Multilib &Other) const;
110 };
111 
112 raw_ostream &operator<<(raw_ostream &OS, const Multilib &M);
113 
114 class MultilibSet {
115 public:
116  using multilib_list = std::vector<Multilib>;
117  using iterator = multilib_list::iterator;
118  using const_iterator = multilib_list::const_iterator;
119  using IncludeDirsFunc =
120  std::function<std::vector<std::string>(const Multilib &M)>;
121  using FilterCallback = llvm::function_ref<bool(const Multilib &)>;
122 
123 private:
124  multilib_list Multilibs;
125  IncludeDirsFunc IncludeCallback;
126  IncludeDirsFunc FilePathsCallback;
127 
128 public:
129  MultilibSet() = default;
130 
131  /// Add an optional Multilib segment
132  MultilibSet &Maybe(const Multilib &M);
133 
134  /// Add a set of mutually incompatible Multilib segments
135  MultilibSet &Either(const Multilib &M1, const Multilib &M2);
136  MultilibSet &Either(const Multilib &M1, const Multilib &M2,
137  const Multilib &M3);
138  MultilibSet &Either(const Multilib &M1, const Multilib &M2,
139  const Multilib &M3, const Multilib &M4);
140  MultilibSet &Either(const Multilib &M1, const Multilib &M2,
141  const Multilib &M3, const Multilib &M4,
142  const Multilib &M5);
144 
145  /// Filter out some subset of the Multilibs using a user defined callback
147 
148  /// Filter out those Multilibs whose gccSuffix matches the given expression
149  MultilibSet &FilterOut(const char *Regex);
150 
151  /// Add a completed Multilib to the set
152  void push_back(const Multilib &M);
153 
154  /// Union this set of multilibs with another
155  void combineWith(const MultilibSet &MS);
156 
157  /// Remove all of the multilibs from the set
158  void clear() { Multilibs.clear(); }
159 
160  iterator begin() { return Multilibs.begin(); }
161  const_iterator begin() const { return Multilibs.begin(); }
162 
163  iterator end() { return Multilibs.end(); }
164  const_iterator end() const { return Multilibs.end(); }
165 
166  /// Pick the best multilib in the set, \returns false if none are compatible
167  bool select(const Multilib::flags_list &Flags, Multilib &M) const;
168 
169  unsigned size() const { return Multilibs.size(); }
170 
171  LLVM_DUMP_METHOD void dump() const;
172  void print(raw_ostream &OS) const;
173 
175  IncludeCallback = std::move(F);
176  return *this;
177  }
178 
179  const IncludeDirsFunc &includeDirsCallback() const { return IncludeCallback; }
180 
182  FilePathsCallback = std::move(F);
183  return *this;
184  }
185 
186  const IncludeDirsFunc &filePathsCallback() const { return FilePathsCallback; }
187 
188 private:
189  /// Apply the filter to Multilibs and return the subset that remains
190  static multilib_list filterCopy(FilterCallback F, const multilib_list &Ms);
191 
192  /// Apply the filter to the multilib_list, removing those that don't match
193  static void filterInPlace(FilterCallback F, multilib_list &Ms);
194 };
195 
196 raw_ostream &operator<<(raw_ostream &OS, const MultilibSet &MS);
197 
198 } // namespace driver
199 } // namespace clang
200 
201 #endif // LLVM_CLANG_DRIVER_MULTILIB_H
clang::driver::MultilibSet::print
void print(raw_ostream &OS) const
Definition: Multilib.cpp:289
clang::driver::Multilib::flags_list
std::vector< std::string > flags_list
Definition: Multilib.h:30
clang::driver::Multilib::isDefault
bool isDefault() const
Check whether the default is selected.
Definition: Multilib.h:106
clang::driver::MultilibSet::Either
MultilibSet & Either(const Multilib &M1, const Multilib &M2)
Add a set of mutually incompatible Multilib segments.
Definition: Multilib.cpp:152
string
string(SUBSTRING ${CMAKE_CURRENT_BINARY_DIR} 0 ${PATH_LIB_START} PATH_HEAD) string(SUBSTRING $
Definition: CMakeLists.txt:22
clang::driver::MultilibSet
Definition: Multilib.h:114
clang::driver::MultilibSet::clear
void clear()
Remove all of the multilibs from the set.
Definition: Multilib.h:158
clang::driver::MultilibSet::size
unsigned size() const
Definition: Multilib.h:169
clang::driver::MultilibSet::begin
iterator begin()
Definition: Multilib.h:160
clang::driver::MultilibSet::FilterOut
MultilibSet & FilterOut(FilterCallback F)
Filter out some subset of the Multilibs using a user defined callback.
Definition: Multilib.cpp:212
clang::driver::MultilibSet::IncludeDirsFunc
std::function< std::vector< std::string >(const Multilib &M)> IncludeDirsFunc
Definition: Multilib.h:120
clang::driver::MultilibSet::setFilePathsCallback
MultilibSet & setFilePathsCallback(IncludeDirsFunc F)
Definition: Multilib.h:181
clang::driver::Multilib::print
void print(raw_ostream &OS) const
print summary of the Multilib
Definition: Multilib.cpp:84
clang::driver::Multilib::dump
LLVM_DUMP_METHOD void dump() const
Definition: Multilib.cpp:80
clang::driver::Multilib::gccSuffix
const std::string & gccSuffix() const
Get the detected GCC installation path suffix for the multi-arch target variant.
Definition: Multilib.h:45
clang::driver::Multilib::osSuffix
const std::string & osSuffix() const
Get the detected os path suffix for the multi-arch target variant.
Definition: Multilib.h:56
clang::driver::operator<<
raw_ostream & operator<<(raw_ostream &OS, const Multilib &M)
Definition: Multilib.cpp:137
clang::driver::MultilibSet::begin
const_iterator begin() const
Definition: Multilib.h:161
clang::driver::MultilibSet::includeDirsCallback
const IncludeDirsFunc & includeDirsCallback() const
Definition: Multilib.h:179
clang::driver::MultilibSet::push_back
void push_back(const Multilib &M)
Add a completed Multilib to the set.
Definition: Multilib.cpp:232
bool
#define bool
Definition: stdbool.h:15
clang::driver::Multilib::Multilib
Multilib(StringRef GCCSuffix={}, StringRef OSSuffix={}, StringRef IncludeSuffix={}, int Priority=0)
Definition: Multilib.cpp:53
clang::driver::Multilib
This corresponds to a single GCC Multilib, or a segment of one controlled by a command line flag.
Definition: Multilib.h:28
clang::driver::MultilibSet::dump
LLVM_DUMP_METHOD void dump() const
Definition: Multilib.cpp:285
clang::driver::MultilibSet::filePathsCallback
const IncludeDirsFunc & filePathsCallback() const
Definition: Multilib.h:186
clang::driver::MultilibSet::end
const_iterator end() const
Definition: Multilib.h:164
clang::driver::Multilib::priority
int priority() const
Returns the multilib priority.
Definition: Multilib.h:83
clang::driver::Multilib::operator==
bool operator==(const Multilib &Other) const
Definition: Multilib.cpp:114
clang::driver::MultilibSet::multilib_list
std::vector< Multilib > multilib_list
Definition: Multilib.h:116
clang::driver::Multilib::isValid
bool isValid() const
Check whether any of the 'against' flags contradict the 'for' flags.
Definition: Multilib.cpp:98
clang::driver::MultilibSet::MultilibSet
MultilibSet()=default
llvm::ArrayRef
Definition: LLVM.h:34
LLVM.h
clang::driver::Multilib::flag
Multilib & flag(StringRef F)
Add a flag to the flags list Flag must be a flag accepted by the driver with its leading '-' removed,...
Definition: Multilib.h:92
Priority
int Priority
Definition: Format.cpp:2337
clang::driver::MultilibSet::iterator
multilib_list::iterator iterator
Definition: Multilib.h:117
clang
Definition: CalledOnceCheck.h:17
clang::driver::MultilibSet::FilterCallback
llvm::function_ref< bool(const Multilib &)> FilterCallback
Definition: Multilib.h:121
clang::driver::MultilibSet::combineWith
void combineWith(const MultilibSet &MS)
Union this set of multilibs with another.
Definition: Multilib.cpp:234
clang::driver::Multilib::includeSuffix
const std::string & includeSuffix() const
Get the include directory suffix.
Definition: Multilib.h:67
clang::driver::MultilibSet::end
iterator end()
Definition: Multilib.h:163
clang::driver::MultilibSet::const_iterator
multilib_list::const_iterator const_iterator
Definition: Multilib.h:118
clang::driver::MultilibSet::Maybe
MultilibSet & Maybe(const Multilib &M)
Add an optional Multilib segment.
Definition: Multilib.cpp:142
clang::driver::Multilib::flags
const flags_list & flags() const
Get the flags that indicate or contraindicate this multilib's use All elements begin with either '+' ...
Definition: Multilib.h:78
clang::driver::MultilibSet::select
bool select(const Multilib::flags_list &Flags, Multilib &M) const
Pick the best multilib in the set,.
Definition: Multilib.cpp:244
clang::driver::Multilib::flags
flags_list & flags()
Definition: Multilib.h:79
clang::driver::MultilibSet::setIncludeDirsCallback
MultilibSet & setIncludeDirsCallback(IncludeDirsFunc F)
Definition: Multilib.h:174