1 //===- SubtargetFeature.cpp - CPU characteristics Implementation ----------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements the SubtargetFeature interface.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "llvm/MC/SubtargetFeature.h"
15 #include "llvm/ADT/StringExtras.h"
16 #include "llvm/Support/Debug.h"
17 #include "llvm/Support/Format.h"
18 #include "llvm/Support/raw_ostream.h"
19 #include <algorithm>
20 #include <cassert>
21 #include <cctype>
22 #include <cstdlib>
23 using namespace llvm;
24 
25 //===----------------------------------------------------------------------===//
26 //                          Static Helper Functions
27 //===----------------------------------------------------------------------===//
28 
29 /// hasFlag - Determine if a feature has a flag; '+' or '-'
30 ///
hasFlag(StringRef Feature)31 static inline bool hasFlag(StringRef Feature) {
32   assert(!Feature.empty() && "Empty string");
33   // Get first character
34   char Ch = Feature[0];
35   // Check if first character is '+' or '-' flag
36   return Ch == '+' || Ch =='-';
37 }
38 
39 /// StripFlag - Return string stripped of flag.
40 ///
StripFlag(StringRef Feature)41 static inline std::string StripFlag(StringRef Feature) {
42   return hasFlag(Feature) ? Feature.substr(1) : Feature;
43 }
44 
45 /// isEnabled - Return true if enable flag; '+'.
46 ///
isEnabled(StringRef Feature)47 static inline bool isEnabled(StringRef Feature) {
48   assert(!Feature.empty() && "Empty string");
49   // Get first character
50   char Ch = Feature[0];
51   // Check if first character is '+' for enabled
52   return Ch == '+';
53 }
54 
55 /// Split - Splits a string of comma separated items in to a vector of strings.
56 ///
Split(std::vector<std::string> & V,StringRef S)57 static void Split(std::vector<std::string> &V, StringRef S) {
58   SmallVector<StringRef, 3> Tmp;
59   S.split(Tmp, ',', -1, false /* KeepEmpty */);
60   V.assign(Tmp.begin(), Tmp.end());
61 }
62 
63 /// Adding features.
AddFeature(StringRef String,bool Enable)64 void SubtargetFeatures::AddFeature(StringRef String, bool Enable) {
65   // Don't add empty features.
66   if (!String.empty())
67     // Convert to lowercase, prepend flag if we don't already have a flag.
68     Features.push_back(hasFlag(String) ? String.lower()
69                                        : (Enable ? "+" : "-") + String.lower());
70 }
71 
72 /// Find KV in array using binary search.
Find(StringRef S,ArrayRef<SubtargetFeatureKV> A)73 static const SubtargetFeatureKV *Find(StringRef S,
74                                       ArrayRef<SubtargetFeatureKV> A) {
75   // Binary search the array
76   auto F = std::lower_bound(A.begin(), A.end(), S);
77   // If not found then return NULL
78   if (F == A.end() || StringRef(F->Key) != S) return nullptr;
79   // Return the found array item
80   return F;
81 }
82 
83 /// getLongestEntryLength - Return the length of the longest entry in the table.
84 ///
getLongestEntryLength(ArrayRef<SubtargetFeatureKV> Table)85 static size_t getLongestEntryLength(ArrayRef<SubtargetFeatureKV> Table) {
86   size_t MaxLen = 0;
87   for (auto &I : Table)
88     MaxLen = std::max(MaxLen, std::strlen(I.Key));
89   return MaxLen;
90 }
91 
92 /// Display help for feature choices.
93 ///
Help(ArrayRef<SubtargetFeatureKV> CPUTable,ArrayRef<SubtargetFeatureKV> FeatTable)94 static void Help(ArrayRef<SubtargetFeatureKV> CPUTable,
95                  ArrayRef<SubtargetFeatureKV> FeatTable) {
96   // Determine the length of the longest CPU and Feature entries.
97   unsigned MaxCPULen  = getLongestEntryLength(CPUTable);
98   unsigned MaxFeatLen = getLongestEntryLength(FeatTable);
99 
100   // Print the CPU table.
101   errs() << "Available CPUs for this target:\n\n";
102   for (auto &CPU : CPUTable)
103     errs() << format("  %-*s - %s.\n", MaxCPULen, CPU.Key, CPU.Desc);
104   errs() << '\n';
105 
106   // Print the Feature table.
107   errs() << "Available features for this target:\n\n";
108   for (auto &Feature : FeatTable)
109     errs() << format("  %-*s - %s.\n", MaxFeatLen, Feature.Key, Feature.Desc);
110   errs() << '\n';
111 
112   errs() << "Use +feature to enable a feature, or -feature to disable it.\n"
113             "For example, llc -mcpu=mycpu -mattr=+feature1,-feature2\n";
114 }
115 
116 //===----------------------------------------------------------------------===//
117 //                    SubtargetFeatures Implementation
118 //===----------------------------------------------------------------------===//
119 
SubtargetFeatures(StringRef Initial)120 SubtargetFeatures::SubtargetFeatures(StringRef Initial) {
121   // Break up string into separate features
122   Split(Features, Initial);
123 }
124 
125 
getString() const126 std::string SubtargetFeatures::getString() const {
127   return join(Features.begin(), Features.end(), ",");
128 }
129 
130 /// SetImpliedBits - For each feature that is (transitively) implied by this
131 /// feature, set it.
132 ///
133 static
SetImpliedBits(FeatureBitset & Bits,const SubtargetFeatureKV * FeatureEntry,ArrayRef<SubtargetFeatureKV> FeatureTable)134 void SetImpliedBits(FeatureBitset &Bits, const SubtargetFeatureKV *FeatureEntry,
135                     ArrayRef<SubtargetFeatureKV> FeatureTable) {
136   for (auto &FE : FeatureTable) {
137     if (FeatureEntry->Value == FE.Value) continue;
138 
139     if ((FeatureEntry->Implies & FE.Value).any()) {
140       Bits |= FE.Value;
141       SetImpliedBits(Bits, &FE, FeatureTable);
142     }
143   }
144 }
145 
146 /// ClearImpliedBits - For each feature that (transitively) implies this
147 /// feature, clear it.
148 ///
149 static
ClearImpliedBits(FeatureBitset & Bits,const SubtargetFeatureKV * FeatureEntry,ArrayRef<SubtargetFeatureKV> FeatureTable)150 void ClearImpliedBits(FeatureBitset &Bits,
151                       const SubtargetFeatureKV *FeatureEntry,
152                       ArrayRef<SubtargetFeatureKV> FeatureTable) {
153   for (auto &FE : FeatureTable) {
154     if (FeatureEntry->Value == FE.Value) continue;
155 
156     if ((FE.Implies & FeatureEntry->Value).any()) {
157       Bits &= ~FE.Value;
158       ClearImpliedBits(Bits, &FE, FeatureTable);
159     }
160   }
161 }
162 
163 /// ToggleFeature - Toggle a feature and returns the newly updated feature
164 /// bits.
165 FeatureBitset
ToggleFeature(FeatureBitset Bits,StringRef Feature,ArrayRef<SubtargetFeatureKV> FeatureTable)166 SubtargetFeatures::ToggleFeature(FeatureBitset Bits, StringRef Feature,
167                                  ArrayRef<SubtargetFeatureKV> FeatureTable) {
168 
169   // Find feature in table.
170   const SubtargetFeatureKV *FeatureEntry =
171       Find(StripFlag(Feature), FeatureTable);
172   // If there is a match
173   if (FeatureEntry) {
174     if ((Bits & FeatureEntry->Value) == FeatureEntry->Value) {
175       Bits &= ~FeatureEntry->Value;
176       // For each feature that implies this, clear it.
177       ClearImpliedBits(Bits, FeatureEntry, FeatureTable);
178     } else {
179       Bits |=  FeatureEntry->Value;
180 
181       // For each feature that this implies, set it.
182       SetImpliedBits(Bits, FeatureEntry, FeatureTable);
183     }
184   } else {
185     // Bug: 20140355
186     // Silence this warning for now
187     if (false) {
188       errs() << "'" << Feature
189              << "' is not a recognized feature for this target"
190              << " (ignoring feature)\n";
191     }
192   }
193 
194   return Bits;
195 }
196 
197 FeatureBitset
ApplyFeatureFlag(FeatureBitset Bits,StringRef Feature,ArrayRef<SubtargetFeatureKV> FeatureTable)198 SubtargetFeatures::ApplyFeatureFlag(FeatureBitset Bits, StringRef Feature,
199                                     ArrayRef<SubtargetFeatureKV> FeatureTable) {
200 
201   assert(hasFlag(Feature));
202 
203   // Find feature in table.
204   const SubtargetFeatureKV *FeatureEntry =
205       Find(StripFlag(Feature), FeatureTable);
206   // If there is a match
207   if (FeatureEntry) {
208     // Enable/disable feature in bits
209     if (isEnabled(Feature)) {
210       Bits |=  FeatureEntry->Value;
211 
212       // For each feature that this implies, set it.
213       SetImpliedBits(Bits, FeatureEntry, FeatureTable);
214     } else {
215       Bits &= ~FeatureEntry->Value;
216 
217       // For each feature that implies this, clear it.
218       ClearImpliedBits(Bits, FeatureEntry, FeatureTable);
219     }
220   } else {
221     errs() << "'" << Feature
222            << "' is not a recognized feature for this target"
223            << " (ignoring feature)\n";
224   }
225 
226   return Bits;
227 }
228 
229 
230 /// getFeatureBits - Get feature bits a CPU.
231 ///
232 FeatureBitset
getFeatureBits(StringRef CPU,ArrayRef<SubtargetFeatureKV> CPUTable,ArrayRef<SubtargetFeatureKV> FeatureTable)233 SubtargetFeatures::getFeatureBits(StringRef CPU,
234                                   ArrayRef<SubtargetFeatureKV> CPUTable,
235                                   ArrayRef<SubtargetFeatureKV> FeatureTable) {
236 
237   if (CPUTable.empty() || FeatureTable.empty())
238     return FeatureBitset();
239 
240 #ifndef NDEBUG
241   for (size_t i = 1, e = CPUTable.size(); i != e; ++i) {
242     assert(strcmp(CPUTable[i - 1].Key, CPUTable[i].Key) < 0 &&
243            "CPU table is not sorted");
244   }
245   for (size_t i = 1, e = FeatureTable.size(); i != e; ++i) {
246     assert(strcmp(FeatureTable[i - 1].Key, FeatureTable[i].Key) < 0 &&
247           "CPU features table is not sorted");
248   }
249 #endif
250   // Resulting bits
251   FeatureBitset Bits;
252 
253   // Check if help is needed
254   if (CPU == "help")
255     Help(CPUTable, FeatureTable);
256 
257   // Find CPU entry if CPU name is specified.
258   else if (!CPU.empty()) {
259     const SubtargetFeatureKV *CPUEntry = Find(CPU, CPUTable);
260 
261     // If there is a match
262     if (CPUEntry) {
263       // Set base feature bits
264       Bits = CPUEntry->Value;
265 
266       // Set the feature implied by this CPU feature, if any.
267       for (auto &FE : FeatureTable) {
268         if ((CPUEntry->Value & FE.Value).any())
269           SetImpliedBits(Bits, &FE, FeatureTable);
270       }
271     } else {
272       errs() << "'" << CPU
273              << "' is not a recognized processor for this target"
274              << " (ignoring processor)\n";
275     }
276   }
277 
278   // Iterate through each feature
279   for (auto &Feature : Features) {
280     // Check for help
281     if (Feature == "+help")
282       Help(CPUTable, FeatureTable);
283 
284     Bits = ApplyFeatureFlag(Bits, Feature, FeatureTable);
285   }
286 
287   return Bits;
288 }
289 
290 /// print - Print feature string.
291 ///
print(raw_ostream & OS) const292 void SubtargetFeatures::print(raw_ostream &OS) const {
293   for (auto &F : Features)
294     OS << F << " ";
295   OS << "\n";
296 }
297 
298 #if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
299 /// dump - Dump feature info.
300 ///
dump() const301 void SubtargetFeatures::dump() const {
302   print(dbgs());
303 }
304 #endif
305 
306 /// Adds the default features for the specified target triple.
307 ///
308 /// FIXME: This is an inelegant way of specifying the features of a
309 /// subtarget. It would be better if we could encode this information
310 /// into the IR. See <rdar://5972456>.
311 ///
getDefaultSubtargetFeatures(const Triple & Triple)312 void SubtargetFeatures::getDefaultSubtargetFeatures(const Triple& Triple) {
313   if (Triple.getVendor() == Triple::Apple) {
314     if (Triple.getArch() == Triple::ppc) {
315       // powerpc-apple-*
316       AddFeature("altivec");
317     } else if (Triple.getArch() == Triple::ppc64) {
318       // powerpc64-apple-*
319       AddFeature("64bit");
320       AddFeature("altivec");
321     }
322   }
323 }
324