1 //===- TargetLoweringBase.cpp - Implement the TargetLoweringBase class ----===//
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 implements the TargetLoweringBase class.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "llvm/ADT/BitVector.h"
14 #include "llvm/ADT/STLExtras.h"
15 #include "llvm/ADT/SmallVector.h"
16 #include "llvm/ADT/StringExtras.h"
17 #include "llvm/ADT/StringRef.h"
18 #include "llvm/ADT/Triple.h"
19 #include "llvm/ADT/Twine.h"
20 #include "llvm/Analysis/Loads.h"
21 #include "llvm/Analysis/TargetTransformInfo.h"
22 #include "llvm/CodeGen/Analysis.h"
23 #include "llvm/CodeGen/ISDOpcodes.h"
24 #include "llvm/CodeGen/MachineBasicBlock.h"
25 #include "llvm/CodeGen/MachineFrameInfo.h"
26 #include "llvm/CodeGen/MachineFunction.h"
27 #include "llvm/CodeGen/MachineInstr.h"
28 #include "llvm/CodeGen/MachineInstrBuilder.h"
29 #include "llvm/CodeGen/MachineMemOperand.h"
30 #include "llvm/CodeGen/MachineOperand.h"
31 #include "llvm/CodeGen/MachineRegisterInfo.h"
32 #include "llvm/CodeGen/RuntimeLibcalls.h"
33 #include "llvm/CodeGen/StackMaps.h"
34 #include "llvm/CodeGen/TargetLowering.h"
35 #include "llvm/CodeGen/TargetOpcodes.h"
36 #include "llvm/CodeGen/TargetRegisterInfo.h"
37 #include "llvm/CodeGen/ValueTypes.h"
38 #include "llvm/IR/Attributes.h"
39 #include "llvm/IR/CallingConv.h"
40 #include "llvm/IR/DataLayout.h"
41 #include "llvm/IR/DerivedTypes.h"
42 #include "llvm/IR/Function.h"
43 #include "llvm/IR/GlobalValue.h"
44 #include "llvm/IR/GlobalVariable.h"
45 #include "llvm/IR/IRBuilder.h"
46 #include "llvm/IR/Module.h"
47 #include "llvm/IR/Type.h"
48 #include "llvm/Support/BranchProbability.h"
49 #include "llvm/Support/Casting.h"
50 #include "llvm/Support/CommandLine.h"
51 #include "llvm/Support/Compiler.h"
52 #include "llvm/Support/ErrorHandling.h"
53 #include "llvm/Support/MachineValueType.h"
54 #include "llvm/Support/MathExtras.h"
55 #include "llvm/Target/TargetMachine.h"
56 #include "llvm/Transforms/Utils/SizeOpts.h"
57 #include <algorithm>
58 #include <cassert>
59 #include <cstddef>
60 #include <cstdint>
61 #include <cstring>
62 #include <iterator>
63 #include <string>
64 #include <tuple>
65 #include <utility>
66 
67 using namespace llvm;
68 
69 static cl::opt<bool> JumpIsExpensiveOverride(
70     "jump-is-expensive", cl::init(false),
71     cl::desc("Do not create extra branches to split comparison logic."),
72     cl::Hidden);
73 
74 static cl::opt<unsigned> MinimumJumpTableEntries
75   ("min-jump-table-entries", cl::init(4), cl::Hidden,
76    cl::desc("Set minimum number of entries to use a jump table."));
77 
78 static cl::opt<unsigned> MaximumJumpTableSize
79   ("max-jump-table-size", cl::init(UINT_MAX), cl::Hidden,
80    cl::desc("Set maximum size of jump tables."));
81 
82 /// Minimum jump table density for normal functions.
83 static cl::opt<unsigned>
84     JumpTableDensity("jump-table-density", cl::init(10), cl::Hidden,
85                      cl::desc("Minimum density for building a jump table in "
86                               "a normal function"));
87 
88 /// Minimum jump table density for -Os or -Oz functions.
89 static cl::opt<unsigned> OptsizeJumpTableDensity(
90     "optsize-jump-table-density", cl::init(40), cl::Hidden,
91     cl::desc("Minimum density for building a jump table in "
92              "an optsize function"));
93 
94 // FIXME: This option is only to test if the strict fp operation processed
95 // correctly by preventing mutating strict fp operation to normal fp operation
96 // during development. When the backend supports strict float operation, this
97 // option will be meaningless.
98 static cl::opt<bool> DisableStrictNodeMutation("disable-strictnode-mutation",
99        cl::desc("Don't mutate strict-float node to a legalize node"),
100        cl::init(false), cl::Hidden);
101 
102 static bool darwinHasSinCos(const Triple &TT) {
103   assert(TT.isOSDarwin() && "should be called with darwin triple");
104   // Don't bother with 32 bit x86.
105   if (TT.getArch() == Triple::x86)
106     return false;
107   // Macos < 10.9 has no sincos_stret.
108   if (TT.isMacOSX())
109     return !TT.isMacOSXVersionLT(10, 9) && TT.isArch64Bit();
110   // iOS < 7.0 has no sincos_stret.
111   if (TT.isiOS())
112     return !TT.isOSVersionLT(7, 0);
113   // Any other darwin such as WatchOS/TvOS is new enough.
114   return true;
115 }
116 
117 // Although this default value is arbitrary, it is not random. It is assumed
118 // that a condition that evaluates the same way by a higher percentage than this
119 // is best represented as control flow. Therefore, the default value N should be
120 // set such that the win from N% correct executions is greater than the loss
121 // from (100 - N)% mispredicted executions for the majority of intended targets.
122 static cl::opt<int> MinPercentageForPredictableBranch(
123     "min-predictable-branch", cl::init(99),
124     cl::desc("Minimum percentage (0-100) that a condition must be either true "
125              "or false to assume that the condition is predictable"),
126     cl::Hidden);
127 
128 void TargetLoweringBase::InitLibcalls(const Triple &TT) {
129 #define HANDLE_LIBCALL(code, name) \
130   setLibcallName(RTLIB::code, name);
131 #include "llvm/IR/RuntimeLibcalls.def"
132 #undef HANDLE_LIBCALL
133   // Initialize calling conventions to their default.
134   for (int LC = 0; LC < RTLIB::UNKNOWN_LIBCALL; ++LC)
135     setLibcallCallingConv((RTLIB::Libcall)LC, CallingConv::C);
136 
137   // For IEEE quad-precision libcall names, PPC uses "kf" instead of "tf".
138   if (TT.getArch() == Triple::ppc || TT.isPPC64()) {
139     setLibcallName(RTLIB::ADD_F128, "__addkf3");
140     setLibcallName(RTLIB::SUB_F128, "__subkf3");
141     setLibcallName(RTLIB::MUL_F128, "__mulkf3");
142     setLibcallName(RTLIB::DIV_F128, "__divkf3");
143     setLibcallName(RTLIB::FPEXT_F32_F128, "__extendsfkf2");
144     setLibcallName(RTLIB::FPEXT_F64_F128, "__extenddfkf2");
145     setLibcallName(RTLIB::FPROUND_F128_F32, "__trunckfsf2");
146     setLibcallName(RTLIB::FPROUND_F128_F64, "__trunckfdf2");
147     setLibcallName(RTLIB::FPTOSINT_F128_I32, "__fixkfsi");
148     setLibcallName(RTLIB::FPTOSINT_F128_I64, "__fixkfdi");
149     setLibcallName(RTLIB::FPTOUINT_F128_I32, "__fixunskfsi");
150     setLibcallName(RTLIB::FPTOUINT_F128_I64, "__fixunskfdi");
151     setLibcallName(RTLIB::SINTTOFP_I32_F128, "__floatsikf");
152     setLibcallName(RTLIB::SINTTOFP_I64_F128, "__floatdikf");
153     setLibcallName(RTLIB::UINTTOFP_I32_F128, "__floatunsikf");
154     setLibcallName(RTLIB::UINTTOFP_I64_F128, "__floatundikf");
155     setLibcallName(RTLIB::OEQ_F128, "__eqkf2");
156     setLibcallName(RTLIB::UNE_F128, "__nekf2");
157     setLibcallName(RTLIB::OGE_F128, "__gekf2");
158     setLibcallName(RTLIB::OLT_F128, "__ltkf2");
159     setLibcallName(RTLIB::OLE_F128, "__lekf2");
160     setLibcallName(RTLIB::OGT_F128, "__gtkf2");
161     setLibcallName(RTLIB::UO_F128, "__unordkf2");
162   }
163 
164   // A few names are different on particular architectures or environments.
165   if (TT.isOSDarwin()) {
166     // For f16/f32 conversions, Darwin uses the standard naming scheme, instead
167     // of the gnueabi-style __gnu_*_ieee.
168     // FIXME: What about other targets?
169     setLibcallName(RTLIB::FPEXT_F16_F32, "__extendhfsf2");
170     setLibcallName(RTLIB::FPROUND_F32_F16, "__truncsfhf2");
171 
172     // Some darwins have an optimized __bzero/bzero function.
173     switch (TT.getArch()) {
174     case Triple::x86:
175     case Triple::x86_64:
176       if (TT.isMacOSX() && !TT.isMacOSXVersionLT(10, 6))
177         setLibcallName(RTLIB::BZERO, "__bzero");
178       break;
179     case Triple::aarch64:
180     case Triple::aarch64_32:
181       setLibcallName(RTLIB::BZERO, "bzero");
182       break;
183     default:
184       break;
185     }
186 
187     if (darwinHasSinCos(TT)) {
188       setLibcallName(RTLIB::SINCOS_STRET_F32, "__sincosf_stret");
189       setLibcallName(RTLIB::SINCOS_STRET_F64, "__sincos_stret");
190       if (TT.isWatchABI()) {
191         setLibcallCallingConv(RTLIB::SINCOS_STRET_F32,
192                               CallingConv::ARM_AAPCS_VFP);
193         setLibcallCallingConv(RTLIB::SINCOS_STRET_F64,
194                               CallingConv::ARM_AAPCS_VFP);
195       }
196     }
197   } else {
198     setLibcallName(RTLIB::FPEXT_F16_F32, "__gnu_h2f_ieee");
199     setLibcallName(RTLIB::FPROUND_F32_F16, "__gnu_f2h_ieee");
200   }
201 
202   if (TT.isGNUEnvironment() || TT.isOSFuchsia() ||
203       (TT.isAndroid() && !TT.isAndroidVersionLT(9))) {
204     setLibcallName(RTLIB::SINCOS_F32, "sincosf");
205     setLibcallName(RTLIB::SINCOS_F64, "sincos");
206     setLibcallName(RTLIB::SINCOS_F80, "sincosl");
207     setLibcallName(RTLIB::SINCOS_F128, "sincosl");
208     setLibcallName(RTLIB::SINCOS_PPCF128, "sincosl");
209   }
210 
211   if (TT.isPS4CPU()) {
212     setLibcallName(RTLIB::SINCOS_F32, "sincosf");
213     setLibcallName(RTLIB::SINCOS_F64, "sincos");
214   }
215 
216   if (TT.isOSOpenBSD()) {
217     setLibcallName(RTLIB::STACKPROTECTOR_CHECK_FAIL, nullptr);
218   }
219 }
220 
221 /// getFPEXT - Return the FPEXT_*_* value for the given types, or
222 /// UNKNOWN_LIBCALL if there is none.
223 RTLIB::Libcall RTLIB::getFPEXT(EVT OpVT, EVT RetVT) {
224   if (OpVT == MVT::f16) {
225     if (RetVT == MVT::f32)
226       return FPEXT_F16_F32;
227   } else if (OpVT == MVT::f32) {
228     if (RetVT == MVT::f64)
229       return FPEXT_F32_F64;
230     if (RetVT == MVT::f128)
231       return FPEXT_F32_F128;
232     if (RetVT == MVT::ppcf128)
233       return FPEXT_F32_PPCF128;
234   } else if (OpVT == MVT::f64) {
235     if (RetVT == MVT::f128)
236       return FPEXT_F64_F128;
237     else if (RetVT == MVT::ppcf128)
238       return FPEXT_F64_PPCF128;
239   } else if (OpVT == MVT::f80) {
240     if (RetVT == MVT::f128)
241       return FPEXT_F80_F128;
242   }
243 
244   return UNKNOWN_LIBCALL;
245 }
246 
247 /// getFPROUND - Return the FPROUND_*_* value for the given types, or
248 /// UNKNOWN_LIBCALL if there is none.
249 RTLIB::Libcall RTLIB::getFPROUND(EVT OpVT, EVT RetVT) {
250   if (RetVT == MVT::f16) {
251     if (OpVT == MVT::f32)
252       return FPROUND_F32_F16;
253     if (OpVT == MVT::f64)
254       return FPROUND_F64_F16;
255     if (OpVT == MVT::f80)
256       return FPROUND_F80_F16;
257     if (OpVT == MVT::f128)
258       return FPROUND_F128_F16;
259     if (OpVT == MVT::ppcf128)
260       return FPROUND_PPCF128_F16;
261   } else if (RetVT == MVT::f32) {
262     if (OpVT == MVT::f64)
263       return FPROUND_F64_F32;
264     if (OpVT == MVT::f80)
265       return FPROUND_F80_F32;
266     if (OpVT == MVT::f128)
267       return FPROUND_F128_F32;
268     if (OpVT == MVT::ppcf128)
269       return FPROUND_PPCF128_F32;
270   } else if (RetVT == MVT::f64) {
271     if (OpVT == MVT::f80)
272       return FPROUND_F80_F64;
273     if (OpVT == MVT::f128)
274       return FPROUND_F128_F64;
275     if (OpVT == MVT::ppcf128)
276       return FPROUND_PPCF128_F64;
277   } else if (RetVT == MVT::f80) {
278     if (OpVT == MVT::f128)
279       return FPROUND_F128_F80;
280   }
281 
282   return UNKNOWN_LIBCALL;
283 }
284 
285 /// getFPTOSINT - Return the FPTOSINT_*_* value for the given types, or
286 /// UNKNOWN_LIBCALL if there is none.
287 RTLIB::Libcall RTLIB::getFPTOSINT(EVT OpVT, EVT RetVT) {
288   if (OpVT == MVT::f32) {
289     if (RetVT == MVT::i32)
290       return FPTOSINT_F32_I32;
291     if (RetVT == MVT::i64)
292       return FPTOSINT_F32_I64;
293     if (RetVT == MVT::i128)
294       return FPTOSINT_F32_I128;
295   } else if (OpVT == MVT::f64) {
296     if (RetVT == MVT::i32)
297       return FPTOSINT_F64_I32;
298     if (RetVT == MVT::i64)
299       return FPTOSINT_F64_I64;
300     if (RetVT == MVT::i128)
301       return FPTOSINT_F64_I128;
302   } else if (OpVT == MVT::f80) {
303     if (RetVT == MVT::i32)
304       return FPTOSINT_F80_I32;
305     if (RetVT == MVT::i64)
306       return FPTOSINT_F80_I64;
307     if (RetVT == MVT::i128)
308       return FPTOSINT_F80_I128;
309   } else if (OpVT == MVT::f128) {
310     if (RetVT == MVT::i32)
311       return FPTOSINT_F128_I32;
312     if (RetVT == MVT::i64)
313       return FPTOSINT_F128_I64;
314     if (RetVT == MVT::i128)
315       return FPTOSINT_F128_I128;
316   } else if (OpVT == MVT::ppcf128) {
317     if (RetVT == MVT::i32)
318       return FPTOSINT_PPCF128_I32;
319     if (RetVT == MVT::i64)
320       return FPTOSINT_PPCF128_I64;
321     if (RetVT == MVT::i128)
322       return FPTOSINT_PPCF128_I128;
323   }
324   return UNKNOWN_LIBCALL;
325 }
326 
327 /// getFPTOUINT - Return the FPTOUINT_*_* value for the given types, or
328 /// UNKNOWN_LIBCALL if there is none.
329 RTLIB::Libcall RTLIB::getFPTOUINT(EVT OpVT, EVT RetVT) {
330   if (OpVT == MVT::f32) {
331     if (RetVT == MVT::i32)
332       return FPTOUINT_F32_I32;
333     if (RetVT == MVT::i64)
334       return FPTOUINT_F32_I64;
335     if (RetVT == MVT::i128)
336       return FPTOUINT_F32_I128;
337   } else if (OpVT == MVT::f64) {
338     if (RetVT == MVT::i32)
339       return FPTOUINT_F64_I32;
340     if (RetVT == MVT::i64)
341       return FPTOUINT_F64_I64;
342     if (RetVT == MVT::i128)
343       return FPTOUINT_F64_I128;
344   } else if (OpVT == MVT::f80) {
345     if (RetVT == MVT::i32)
346       return FPTOUINT_F80_I32;
347     if (RetVT == MVT::i64)
348       return FPTOUINT_F80_I64;
349     if (RetVT == MVT::i128)
350       return FPTOUINT_F80_I128;
351   } else if (OpVT == MVT::f128) {
352     if (RetVT == MVT::i32)
353       return FPTOUINT_F128_I32;
354     if (RetVT == MVT::i64)
355       return FPTOUINT_F128_I64;
356     if (RetVT == MVT::i128)
357       return FPTOUINT_F128_I128;
358   } else if (OpVT == MVT::ppcf128) {
359     if (RetVT == MVT::i32)
360       return FPTOUINT_PPCF128_I32;
361     if (RetVT == MVT::i64)
362       return FPTOUINT_PPCF128_I64;
363     if (RetVT == MVT::i128)
364       return FPTOUINT_PPCF128_I128;
365   }
366   return UNKNOWN_LIBCALL;
367 }
368 
369 /// getSINTTOFP - Return the SINTTOFP_*_* value for the given types, or
370 /// UNKNOWN_LIBCALL if there is none.
371 RTLIB::Libcall RTLIB::getSINTTOFP(EVT OpVT, EVT RetVT) {
372   if (OpVT == MVT::i32) {
373     if (RetVT == MVT::f32)
374       return SINTTOFP_I32_F32;
375     if (RetVT == MVT::f64)
376       return SINTTOFP_I32_F64;
377     if (RetVT == MVT::f80)
378       return SINTTOFP_I32_F80;
379     if (RetVT == MVT::f128)
380       return SINTTOFP_I32_F128;
381     if (RetVT == MVT::ppcf128)
382       return SINTTOFP_I32_PPCF128;
383   } else if (OpVT == MVT::i64) {
384     if (RetVT == MVT::f32)
385       return SINTTOFP_I64_F32;
386     if (RetVT == MVT::f64)
387       return SINTTOFP_I64_F64;
388     if (RetVT == MVT::f80)
389       return SINTTOFP_I64_F80;
390     if (RetVT == MVT::f128)
391       return SINTTOFP_I64_F128;
392     if (RetVT == MVT::ppcf128)
393       return SINTTOFP_I64_PPCF128;
394   } else if (OpVT == MVT::i128) {
395     if (RetVT == MVT::f32)
396       return SINTTOFP_I128_F32;
397     if (RetVT == MVT::f64)
398       return SINTTOFP_I128_F64;
399     if (RetVT == MVT::f80)
400       return SINTTOFP_I128_F80;
401     if (RetVT == MVT::f128)
402       return SINTTOFP_I128_F128;
403     if (RetVT == MVT::ppcf128)
404       return SINTTOFP_I128_PPCF128;
405   }
406   return UNKNOWN_LIBCALL;
407 }
408 
409 /// getUINTTOFP - Return the UINTTOFP_*_* value for the given types, or
410 /// UNKNOWN_LIBCALL if there is none.
411 RTLIB::Libcall RTLIB::getUINTTOFP(EVT OpVT, EVT RetVT) {
412   if (OpVT == MVT::i32) {
413     if (RetVT == MVT::f32)
414       return UINTTOFP_I32_F32;
415     if (RetVT == MVT::f64)
416       return UINTTOFP_I32_F64;
417     if (RetVT == MVT::f80)
418       return UINTTOFP_I32_F80;
419     if (RetVT == MVT::f128)
420       return UINTTOFP_I32_F128;
421     if (RetVT == MVT::ppcf128)
422       return UINTTOFP_I32_PPCF128;
423   } else if (OpVT == MVT::i64) {
424     if (RetVT == MVT::f32)
425       return UINTTOFP_I64_F32;
426     if (RetVT == MVT::f64)
427       return UINTTOFP_I64_F64;
428     if (RetVT == MVT::f80)
429       return UINTTOFP_I64_F80;
430     if (RetVT == MVT::f128)
431       return UINTTOFP_I64_F128;
432     if (RetVT == MVT::ppcf128)
433       return UINTTOFP_I64_PPCF128;
434   } else if (OpVT == MVT::i128) {
435     if (RetVT == MVT::f32)
436       return UINTTOFP_I128_F32;
437     if (RetVT == MVT::f64)
438       return UINTTOFP_I128_F64;
439     if (RetVT == MVT::f80)
440       return UINTTOFP_I128_F80;
441     if (RetVT == MVT::f128)
442       return UINTTOFP_I128_F128;
443     if (RetVT == MVT::ppcf128)
444       return UINTTOFP_I128_PPCF128;
445   }
446   return UNKNOWN_LIBCALL;
447 }
448 
449 RTLIB::Libcall RTLIB::getSYNC(unsigned Opc, MVT VT) {
450 #define OP_TO_LIBCALL(Name, Enum)                                              \
451   case Name:                                                                   \
452     switch (VT.SimpleTy) {                                                     \
453     default:                                                                   \
454       return UNKNOWN_LIBCALL;                                                  \
455     case MVT::i8:                                                              \
456       return Enum##_1;                                                         \
457     case MVT::i16:                                                             \
458       return Enum##_2;                                                         \
459     case MVT::i32:                                                             \
460       return Enum##_4;                                                         \
461     case MVT::i64:                                                             \
462       return Enum##_8;                                                         \
463     case MVT::i128:                                                            \
464       return Enum##_16;                                                        \
465     }
466 
467   switch (Opc) {
468     OP_TO_LIBCALL(ISD::ATOMIC_SWAP, SYNC_LOCK_TEST_AND_SET)
469     OP_TO_LIBCALL(ISD::ATOMIC_CMP_SWAP, SYNC_VAL_COMPARE_AND_SWAP)
470     OP_TO_LIBCALL(ISD::ATOMIC_LOAD_ADD, SYNC_FETCH_AND_ADD)
471     OP_TO_LIBCALL(ISD::ATOMIC_LOAD_SUB, SYNC_FETCH_AND_SUB)
472     OP_TO_LIBCALL(ISD::ATOMIC_LOAD_AND, SYNC_FETCH_AND_AND)
473     OP_TO_LIBCALL(ISD::ATOMIC_LOAD_OR, SYNC_FETCH_AND_OR)
474     OP_TO_LIBCALL(ISD::ATOMIC_LOAD_XOR, SYNC_FETCH_AND_XOR)
475     OP_TO_LIBCALL(ISD::ATOMIC_LOAD_NAND, SYNC_FETCH_AND_NAND)
476     OP_TO_LIBCALL(ISD::ATOMIC_LOAD_MAX, SYNC_FETCH_AND_MAX)
477     OP_TO_LIBCALL(ISD::ATOMIC_LOAD_UMAX, SYNC_FETCH_AND_UMAX)
478     OP_TO_LIBCALL(ISD::ATOMIC_LOAD_MIN, SYNC_FETCH_AND_MIN)
479     OP_TO_LIBCALL(ISD::ATOMIC_LOAD_UMIN, SYNC_FETCH_AND_UMIN)
480   }
481 
482 #undef OP_TO_LIBCALL
483 
484   return UNKNOWN_LIBCALL;
485 }
486 
487 RTLIB::Libcall RTLIB::getMEMCPY_ELEMENT_UNORDERED_ATOMIC(uint64_t ElementSize) {
488   switch (ElementSize) {
489   case 1:
490     return MEMCPY_ELEMENT_UNORDERED_ATOMIC_1;
491   case 2:
492     return MEMCPY_ELEMENT_UNORDERED_ATOMIC_2;
493   case 4:
494     return MEMCPY_ELEMENT_UNORDERED_ATOMIC_4;
495   case 8:
496     return MEMCPY_ELEMENT_UNORDERED_ATOMIC_8;
497   case 16:
498     return MEMCPY_ELEMENT_UNORDERED_ATOMIC_16;
499   default:
500     return UNKNOWN_LIBCALL;
501   }
502 }
503 
504 RTLIB::Libcall RTLIB::getMEMMOVE_ELEMENT_UNORDERED_ATOMIC(uint64_t ElementSize) {
505   switch (ElementSize) {
506   case 1:
507     return MEMMOVE_ELEMENT_UNORDERED_ATOMIC_1;
508   case 2:
509     return MEMMOVE_ELEMENT_UNORDERED_ATOMIC_2;
510   case 4:
511     return MEMMOVE_ELEMENT_UNORDERED_ATOMIC_4;
512   case 8:
513     return MEMMOVE_ELEMENT_UNORDERED_ATOMIC_8;
514   case 16:
515     return MEMMOVE_ELEMENT_UNORDERED_ATOMIC_16;
516   default:
517     return UNKNOWN_LIBCALL;
518   }
519 }
520 
521 RTLIB::Libcall RTLIB::getMEMSET_ELEMENT_UNORDERED_ATOMIC(uint64_t ElementSize) {
522   switch (ElementSize) {
523   case 1:
524     return MEMSET_ELEMENT_UNORDERED_ATOMIC_1;
525   case 2:
526     return MEMSET_ELEMENT_UNORDERED_ATOMIC_2;
527   case 4:
528     return MEMSET_ELEMENT_UNORDERED_ATOMIC_4;
529   case 8:
530     return MEMSET_ELEMENT_UNORDERED_ATOMIC_8;
531   case 16:
532     return MEMSET_ELEMENT_UNORDERED_ATOMIC_16;
533   default:
534     return UNKNOWN_LIBCALL;
535   }
536 }
537 
538 /// InitCmpLibcallCCs - Set default comparison libcall CC.
539 static void InitCmpLibcallCCs(ISD::CondCode *CCs) {
540   memset(CCs, ISD::SETCC_INVALID, sizeof(ISD::CondCode)*RTLIB::UNKNOWN_LIBCALL);
541   CCs[RTLIB::OEQ_F32] = ISD::SETEQ;
542   CCs[RTLIB::OEQ_F64] = ISD::SETEQ;
543   CCs[RTLIB::OEQ_F128] = ISD::SETEQ;
544   CCs[RTLIB::OEQ_PPCF128] = ISD::SETEQ;
545   CCs[RTLIB::UNE_F32] = ISD::SETNE;
546   CCs[RTLIB::UNE_F64] = ISD::SETNE;
547   CCs[RTLIB::UNE_F128] = ISD::SETNE;
548   CCs[RTLIB::UNE_PPCF128] = ISD::SETNE;
549   CCs[RTLIB::OGE_F32] = ISD::SETGE;
550   CCs[RTLIB::OGE_F64] = ISD::SETGE;
551   CCs[RTLIB::OGE_F128] = ISD::SETGE;
552   CCs[RTLIB::OGE_PPCF128] = ISD::SETGE;
553   CCs[RTLIB::OLT_F32] = ISD::SETLT;
554   CCs[RTLIB::OLT_F64] = ISD::SETLT;
555   CCs[RTLIB::OLT_F128] = ISD::SETLT;
556   CCs[RTLIB::OLT_PPCF128] = ISD::SETLT;
557   CCs[RTLIB::OLE_F32] = ISD::SETLE;
558   CCs[RTLIB::OLE_F64] = ISD::SETLE;
559   CCs[RTLIB::OLE_F128] = ISD::SETLE;
560   CCs[RTLIB::OLE_PPCF128] = ISD::SETLE;
561   CCs[RTLIB::OGT_F32] = ISD::SETGT;
562   CCs[RTLIB::OGT_F64] = ISD::SETGT;
563   CCs[RTLIB::OGT_F128] = ISD::SETGT;
564   CCs[RTLIB::OGT_PPCF128] = ISD::SETGT;
565   CCs[RTLIB::UO_F32] = ISD::SETNE;
566   CCs[RTLIB::UO_F64] = ISD::SETNE;
567   CCs[RTLIB::UO_F128] = ISD::SETNE;
568   CCs[RTLIB::UO_PPCF128] = ISD::SETNE;
569 }
570 
571 /// NOTE: The TargetMachine owns TLOF.
572 TargetLoweringBase::TargetLoweringBase(const TargetMachine &tm) : TM(tm) {
573   initActions();
574 
575   // Perform these initializations only once.
576   MaxStoresPerMemset = MaxStoresPerMemcpy = MaxStoresPerMemmove =
577       MaxLoadsPerMemcmp = 8;
578   MaxGluedStoresPerMemcpy = 0;
579   MaxStoresPerMemsetOptSize = MaxStoresPerMemcpyOptSize =
580       MaxStoresPerMemmoveOptSize = MaxLoadsPerMemcmpOptSize = 4;
581   HasMultipleConditionRegisters = false;
582   HasExtractBitsInsn = false;
583   JumpIsExpensive = JumpIsExpensiveOverride;
584   PredictableSelectIsExpensive = false;
585   EnableExtLdPromotion = false;
586   StackPointerRegisterToSaveRestore = 0;
587   BooleanContents = UndefinedBooleanContent;
588   BooleanFloatContents = UndefinedBooleanContent;
589   BooleanVectorContents = UndefinedBooleanContent;
590   SchedPreferenceInfo = Sched::ILP;
591   GatherAllAliasesMaxDepth = 18;
592   IsStrictFPEnabled = DisableStrictNodeMutation;
593   // TODO: the default will be switched to 0 in the next commit, along
594   // with the Target-specific changes necessary.
595   MaxAtomicSizeInBitsSupported = 1024;
596 
597   MinCmpXchgSizeInBits = 0;
598   SupportsUnalignedAtomics = false;
599 
600   std::fill(std::begin(LibcallRoutineNames), std::end(LibcallRoutineNames), nullptr);
601 
602   InitLibcalls(TM.getTargetTriple());
603   InitCmpLibcallCCs(CmpLibcallCCs);
604 }
605 
606 void TargetLoweringBase::initActions() {
607   // All operations default to being supported.
608   memset(OpActions, 0, sizeof(OpActions));
609   memset(LoadExtActions, 0, sizeof(LoadExtActions));
610   memset(TruncStoreActions, 0, sizeof(TruncStoreActions));
611   memset(IndexedModeActions, 0, sizeof(IndexedModeActions));
612   memset(CondCodeActions, 0, sizeof(CondCodeActions));
613   std::fill(std::begin(RegClassForVT), std::end(RegClassForVT), nullptr);
614   std::fill(std::begin(TargetDAGCombineArray),
615             std::end(TargetDAGCombineArray), 0);
616 
617   for (MVT VT : MVT::fp_valuetypes()) {
618     MVT IntVT = MVT::getIntegerVT(VT.getSizeInBits().getFixedSize());
619     if (IntVT.isValid()) {
620       setOperationAction(ISD::ATOMIC_SWAP, VT, Promote);
621       AddPromotedToType(ISD::ATOMIC_SWAP, VT, IntVT);
622     }
623   }
624 
625   // Set default actions for various operations.
626   for (MVT VT : MVT::all_valuetypes()) {
627     // Default all indexed load / store to expand.
628     for (unsigned IM = (unsigned)ISD::PRE_INC;
629          IM != (unsigned)ISD::LAST_INDEXED_MODE; ++IM) {
630       setIndexedLoadAction(IM, VT, Expand);
631       setIndexedStoreAction(IM, VT, Expand);
632       setIndexedMaskedLoadAction(IM, VT, Expand);
633       setIndexedMaskedStoreAction(IM, VT, Expand);
634     }
635 
636     // Most backends expect to see the node which just returns the value loaded.
637     setOperationAction(ISD::ATOMIC_CMP_SWAP_WITH_SUCCESS, VT, Expand);
638 
639     // These operations default to expand.
640     setOperationAction(ISD::FGETSIGN, VT, Expand);
641     setOperationAction(ISD::CONCAT_VECTORS, VT, Expand);
642     setOperationAction(ISD::FMINNUM, VT, Expand);
643     setOperationAction(ISD::FMAXNUM, VT, Expand);
644     setOperationAction(ISD::FMINNUM_IEEE, VT, Expand);
645     setOperationAction(ISD::FMAXNUM_IEEE, VT, Expand);
646     setOperationAction(ISD::FMINIMUM, VT, Expand);
647     setOperationAction(ISD::FMAXIMUM, VT, Expand);
648     setOperationAction(ISD::FMAD, VT, Expand);
649     setOperationAction(ISD::SMIN, VT, Expand);
650     setOperationAction(ISD::SMAX, VT, Expand);
651     setOperationAction(ISD::UMIN, VT, Expand);
652     setOperationAction(ISD::UMAX, VT, Expand);
653     setOperationAction(ISD::ABS, VT, Expand);
654     setOperationAction(ISD::FSHL, VT, Expand);
655     setOperationAction(ISD::FSHR, VT, Expand);
656     setOperationAction(ISD::SADDSAT, VT, Expand);
657     setOperationAction(ISD::UADDSAT, VT, Expand);
658     setOperationAction(ISD::SSUBSAT, VT, Expand);
659     setOperationAction(ISD::USUBSAT, VT, Expand);
660     setOperationAction(ISD::SMULFIX, VT, Expand);
661     setOperationAction(ISD::SMULFIXSAT, VT, Expand);
662     setOperationAction(ISD::UMULFIX, VT, Expand);
663     setOperationAction(ISD::UMULFIXSAT, VT, Expand);
664     setOperationAction(ISD::SDIVFIX, VT, Expand);
665     setOperationAction(ISD::SDIVFIXSAT, VT, Expand);
666     setOperationAction(ISD::UDIVFIX, VT, Expand);
667     setOperationAction(ISD::UDIVFIXSAT, VT, Expand);
668 
669     // Overflow operations default to expand
670     setOperationAction(ISD::SADDO, VT, Expand);
671     setOperationAction(ISD::SSUBO, VT, Expand);
672     setOperationAction(ISD::UADDO, VT, Expand);
673     setOperationAction(ISD::USUBO, VT, Expand);
674     setOperationAction(ISD::SMULO, VT, Expand);
675     setOperationAction(ISD::UMULO, VT, Expand);
676 
677     // ADDCARRY operations default to expand
678     setOperationAction(ISD::ADDCARRY, VT, Expand);
679     setOperationAction(ISD::SUBCARRY, VT, Expand);
680     setOperationAction(ISD::SETCCCARRY, VT, Expand);
681 
682     // ADDC/ADDE/SUBC/SUBE default to expand.
683     setOperationAction(ISD::ADDC, VT, Expand);
684     setOperationAction(ISD::ADDE, VT, Expand);
685     setOperationAction(ISD::SUBC, VT, Expand);
686     setOperationAction(ISD::SUBE, VT, Expand);
687 
688     // These default to Expand so they will be expanded to CTLZ/CTTZ by default.
689     setOperationAction(ISD::CTLZ_ZERO_UNDEF, VT, Expand);
690     setOperationAction(ISD::CTTZ_ZERO_UNDEF, VT, Expand);
691 
692     setOperationAction(ISD::BITREVERSE, VT, Expand);
693 
694     // These library functions default to expand.
695     setOperationAction(ISD::FROUND, VT, Expand);
696     setOperationAction(ISD::FROUNDEVEN, VT, Expand);
697     setOperationAction(ISD::FPOWI, VT, Expand);
698 
699     // These operations default to expand for vector types.
700     if (VT.isVector()) {
701       setOperationAction(ISD::FCOPYSIGN, VT, Expand);
702       setOperationAction(ISD::SIGN_EXTEND_INREG, VT, Expand);
703       setOperationAction(ISD::ANY_EXTEND_VECTOR_INREG, VT, Expand);
704       setOperationAction(ISD::SIGN_EXTEND_VECTOR_INREG, VT, Expand);
705       setOperationAction(ISD::ZERO_EXTEND_VECTOR_INREG, VT, Expand);
706       setOperationAction(ISD::SPLAT_VECTOR, VT, Expand);
707     }
708 
709     // Constrained floating-point operations default to expand.
710 #define DAG_INSTRUCTION(NAME, NARG, ROUND_MODE, INTRINSIC, DAGN)               \
711     setOperationAction(ISD::STRICT_##DAGN, VT, Expand);
712 #include "llvm/IR/ConstrainedOps.def"
713 
714     // For most targets @llvm.get.dynamic.area.offset just returns 0.
715     setOperationAction(ISD::GET_DYNAMIC_AREA_OFFSET, VT, Expand);
716 
717     // Vector reduction default to expand.
718     setOperationAction(ISD::VECREDUCE_FADD, VT, Expand);
719     setOperationAction(ISD::VECREDUCE_FMUL, VT, Expand);
720     setOperationAction(ISD::VECREDUCE_ADD, VT, Expand);
721     setOperationAction(ISD::VECREDUCE_MUL, VT, Expand);
722     setOperationAction(ISD::VECREDUCE_AND, VT, Expand);
723     setOperationAction(ISD::VECREDUCE_OR, VT, Expand);
724     setOperationAction(ISD::VECREDUCE_XOR, VT, Expand);
725     setOperationAction(ISD::VECREDUCE_SMAX, VT, Expand);
726     setOperationAction(ISD::VECREDUCE_SMIN, VT, Expand);
727     setOperationAction(ISD::VECREDUCE_UMAX, VT, Expand);
728     setOperationAction(ISD::VECREDUCE_UMIN, VT, Expand);
729     setOperationAction(ISD::VECREDUCE_FMAX, VT, Expand);
730     setOperationAction(ISD::VECREDUCE_FMIN, VT, Expand);
731   }
732 
733   // Most targets ignore the @llvm.prefetch intrinsic.
734   setOperationAction(ISD::PREFETCH, MVT::Other, Expand);
735 
736   // Most targets also ignore the @llvm.readcyclecounter intrinsic.
737   setOperationAction(ISD::READCYCLECOUNTER, MVT::i64, Expand);
738 
739   // ConstantFP nodes default to expand.  Targets can either change this to
740   // Legal, in which case all fp constants are legal, or use isFPImmLegal()
741   // to optimize expansions for certain constants.
742   setOperationAction(ISD::ConstantFP, MVT::f16, Expand);
743   setOperationAction(ISD::ConstantFP, MVT::f32, Expand);
744   setOperationAction(ISD::ConstantFP, MVT::f64, Expand);
745   setOperationAction(ISD::ConstantFP, MVT::f80, Expand);
746   setOperationAction(ISD::ConstantFP, MVT::f128, Expand);
747 
748   // These library functions default to expand.
749   for (MVT VT : {MVT::f32, MVT::f64, MVT::f128}) {
750     setOperationAction(ISD::FCBRT,      VT, Expand);
751     setOperationAction(ISD::FLOG ,      VT, Expand);
752     setOperationAction(ISD::FLOG2,      VT, Expand);
753     setOperationAction(ISD::FLOG10,     VT, Expand);
754     setOperationAction(ISD::FEXP ,      VT, Expand);
755     setOperationAction(ISD::FEXP2,      VT, Expand);
756     setOperationAction(ISD::FFLOOR,     VT, Expand);
757     setOperationAction(ISD::FNEARBYINT, VT, Expand);
758     setOperationAction(ISD::FCEIL,      VT, Expand);
759     setOperationAction(ISD::FRINT,      VT, Expand);
760     setOperationAction(ISD::FTRUNC,     VT, Expand);
761     setOperationAction(ISD::FROUND,     VT, Expand);
762     setOperationAction(ISD::FROUNDEVEN, VT, Expand);
763     setOperationAction(ISD::LROUND,     VT, Expand);
764     setOperationAction(ISD::LLROUND,    VT, Expand);
765     setOperationAction(ISD::LRINT,      VT, Expand);
766     setOperationAction(ISD::LLRINT,     VT, Expand);
767   }
768 
769   // Default ISD::TRAP to expand (which turns it into abort).
770   setOperationAction(ISD::TRAP, MVT::Other, Expand);
771 
772   // On most systems, DEBUGTRAP and TRAP have no difference. The "Expand"
773   // here is to inform DAG Legalizer to replace DEBUGTRAP with TRAP.
774   setOperationAction(ISD::DEBUGTRAP, MVT::Other, Expand);
775 }
776 
777 MVT TargetLoweringBase::getScalarShiftAmountTy(const DataLayout &DL,
778                                                EVT) const {
779   return MVT::getIntegerVT(DL.getPointerSizeInBits(0));
780 }
781 
782 EVT TargetLoweringBase::getShiftAmountTy(EVT LHSTy, const DataLayout &DL,
783                                          bool LegalTypes) const {
784   assert(LHSTy.isInteger() && "Shift amount is not an integer type!");
785   if (LHSTy.isVector())
786     return LHSTy;
787   return LegalTypes ? getScalarShiftAmountTy(DL, LHSTy)
788                     : getPointerTy(DL);
789 }
790 
791 bool TargetLoweringBase::canOpTrap(unsigned Op, EVT VT) const {
792   assert(isTypeLegal(VT));
793   switch (Op) {
794   default:
795     return false;
796   case ISD::SDIV:
797   case ISD::UDIV:
798   case ISD::SREM:
799   case ISD::UREM:
800     return true;
801   }
802 }
803 
804 void TargetLoweringBase::setJumpIsExpensive(bool isExpensive) {
805   // If the command-line option was specified, ignore this request.
806   if (!JumpIsExpensiveOverride.getNumOccurrences())
807     JumpIsExpensive = isExpensive;
808 }
809 
810 TargetLoweringBase::LegalizeKind
811 TargetLoweringBase::getTypeConversion(LLVMContext &Context, EVT VT) const {
812   // If this is a simple type, use the ComputeRegisterProp mechanism.
813   if (VT.isSimple()) {
814     MVT SVT = VT.getSimpleVT();
815     assert((unsigned)SVT.SimpleTy < array_lengthof(TransformToType));
816     MVT NVT = TransformToType[SVT.SimpleTy];
817     LegalizeTypeAction LA = ValueTypeActions.getTypeAction(SVT);
818 
819     assert((LA == TypeLegal || LA == TypeSoftenFloat ||
820             LA == TypeSoftPromoteHalf ||
821             (NVT.isVector() ||
822              ValueTypeActions.getTypeAction(NVT) != TypePromoteInteger)) &&
823            "Promote may not follow Expand or Promote");
824 
825     if (LA == TypeSplitVector)
826       return LegalizeKind(LA,
827                           EVT::getVectorVT(Context, SVT.getVectorElementType(),
828                                            SVT.getVectorNumElements() / 2));
829     if (LA == TypeScalarizeVector)
830       return LegalizeKind(LA, SVT.getVectorElementType());
831     return LegalizeKind(LA, NVT);
832   }
833 
834   // Handle Extended Scalar Types.
835   if (!VT.isVector()) {
836     assert(VT.isInteger() && "Float types must be simple");
837     unsigned BitSize = VT.getSizeInBits();
838     // First promote to a power-of-two size, then expand if necessary.
839     if (BitSize < 8 || !isPowerOf2_32(BitSize)) {
840       EVT NVT = VT.getRoundIntegerType(Context);
841       assert(NVT != VT && "Unable to round integer VT");
842       LegalizeKind NextStep = getTypeConversion(Context, NVT);
843       // Avoid multi-step promotion.
844       if (NextStep.first == TypePromoteInteger)
845         return NextStep;
846       // Return rounded integer type.
847       return LegalizeKind(TypePromoteInteger, NVT);
848     }
849 
850     return LegalizeKind(TypeExpandInteger,
851                         EVT::getIntegerVT(Context, VT.getSizeInBits() / 2));
852   }
853 
854   // Handle vector types.
855   unsigned NumElts = VT.getVectorNumElements();
856   EVT EltVT = VT.getVectorElementType();
857 
858   // Vectors with only one element are always scalarized.
859   if (NumElts == 1)
860     return LegalizeKind(TypeScalarizeVector, EltVT);
861 
862   // Try to widen vector elements until the element type is a power of two and
863   // promote it to a legal type later on, for example:
864   // <3 x i8> -> <4 x i8> -> <4 x i32>
865   if (EltVT.isInteger()) {
866     // Vectors with a number of elements that is not a power of two are always
867     // widened, for example <3 x i8> -> <4 x i8>.
868     if (!VT.isPow2VectorType()) {
869       NumElts = (unsigned)NextPowerOf2(NumElts);
870       EVT NVT = EVT::getVectorVT(Context, EltVT, NumElts);
871       return LegalizeKind(TypeWidenVector, NVT);
872     }
873 
874     // Examine the element type.
875     LegalizeKind LK = getTypeConversion(Context, EltVT);
876 
877     // If type is to be expanded, split the vector.
878     //  <4 x i140> -> <2 x i140>
879     if (LK.first == TypeExpandInteger)
880       return LegalizeKind(TypeSplitVector,
881                           EVT::getVectorVT(Context, EltVT, NumElts / 2));
882 
883     // Promote the integer element types until a legal vector type is found
884     // or until the element integer type is too big. If a legal type was not
885     // found, fallback to the usual mechanism of widening/splitting the
886     // vector.
887     EVT OldEltVT = EltVT;
888     while (true) {
889       // Increase the bitwidth of the element to the next pow-of-two
890       // (which is greater than 8 bits).
891       EltVT = EVT::getIntegerVT(Context, 1 + EltVT.getSizeInBits())
892                   .getRoundIntegerType(Context);
893 
894       // Stop trying when getting a non-simple element type.
895       // Note that vector elements may be greater than legal vector element
896       // types. Example: X86 XMM registers hold 64bit element on 32bit
897       // systems.
898       if (!EltVT.isSimple())
899         break;
900 
901       // Build a new vector type and check if it is legal.
902       MVT NVT = MVT::getVectorVT(EltVT.getSimpleVT(), NumElts);
903       // Found a legal promoted vector type.
904       if (NVT != MVT() && ValueTypeActions.getTypeAction(NVT) == TypeLegal)
905         return LegalizeKind(TypePromoteInteger,
906                             EVT::getVectorVT(Context, EltVT, NumElts));
907     }
908 
909     // Reset the type to the unexpanded type if we did not find a legal vector
910     // type with a promoted vector element type.
911     EltVT = OldEltVT;
912   }
913 
914   // Try to widen the vector until a legal type is found.
915   // If there is no wider legal type, split the vector.
916   while (true) {
917     // Round up to the next power of 2.
918     NumElts = (unsigned)NextPowerOf2(NumElts);
919 
920     // If there is no simple vector type with this many elements then there
921     // cannot be a larger legal vector type.  Note that this assumes that
922     // there are no skipped intermediate vector types in the simple types.
923     if (!EltVT.isSimple())
924       break;
925     MVT LargerVector = MVT::getVectorVT(EltVT.getSimpleVT(), NumElts);
926     if (LargerVector == MVT())
927       break;
928 
929     // If this type is legal then widen the vector.
930     if (ValueTypeActions.getTypeAction(LargerVector) == TypeLegal)
931       return LegalizeKind(TypeWidenVector, LargerVector);
932   }
933 
934   // Widen odd vectors to next power of two.
935   if (!VT.isPow2VectorType()) {
936     EVT NVT = VT.getPow2VectorType(Context);
937     return LegalizeKind(TypeWidenVector, NVT);
938   }
939 
940   // Vectors with illegal element types are expanded.
941   EVT NVT = EVT::getVectorVT(Context, EltVT, VT.getVectorNumElements() / 2);
942   return LegalizeKind(TypeSplitVector, NVT);
943 }
944 
945 static unsigned getVectorTypeBreakdownMVT(MVT VT, MVT &IntermediateVT,
946                                           unsigned &NumIntermediates,
947                                           MVT &RegisterVT,
948                                           TargetLoweringBase *TLI) {
949   // Figure out the right, legal destination reg to copy into.
950   ElementCount EC = VT.getVectorElementCount();
951   MVT EltTy = VT.getVectorElementType();
952 
953   unsigned NumVectorRegs = 1;
954 
955   // FIXME: We don't support non-power-of-2-sized vectors for now.
956   // Ideally we could break down into LHS/RHS like LegalizeDAG does.
957   if (!isPowerOf2_32(EC.Min)) {
958     // Split EC to unit size (scalable property is preserved).
959     NumVectorRegs = EC.Min;
960     EC = EC / NumVectorRegs;
961   }
962 
963   // Divide the input until we get to a supported size. This will
964   // always end up with an EC that represent a scalar or a scalable
965   // scalar.
966   while (EC.Min > 1 && !TLI->isTypeLegal(MVT::getVectorVT(EltTy, EC))) {
967     EC.Min >>= 1;
968     NumVectorRegs <<= 1;
969   }
970 
971   NumIntermediates = NumVectorRegs;
972 
973   MVT NewVT = MVT::getVectorVT(EltTy, EC);
974   if (!TLI->isTypeLegal(NewVT))
975     NewVT = EltTy;
976   IntermediateVT = NewVT;
977 
978   unsigned LaneSizeInBits = NewVT.getScalarSizeInBits().getFixedSize();
979 
980   // Convert sizes such as i33 to i64.
981   if (!isPowerOf2_32(LaneSizeInBits))
982     LaneSizeInBits = NextPowerOf2(LaneSizeInBits);
983 
984   MVT DestVT = TLI->getRegisterType(NewVT);
985   RegisterVT = DestVT;
986   if (EVT(DestVT).bitsLT(NewVT))    // Value is expanded, e.g. i64 -> i16.
987     return NumVectorRegs *
988            (LaneSizeInBits / DestVT.getScalarSizeInBits().getFixedSize());
989 
990   // Otherwise, promotion or legal types use the same number of registers as
991   // the vector decimated to the appropriate level.
992   return NumVectorRegs;
993 }
994 
995 /// isLegalRC - Return true if the value types that can be represented by the
996 /// specified register class are all legal.
997 bool TargetLoweringBase::isLegalRC(const TargetRegisterInfo &TRI,
998                                    const TargetRegisterClass &RC) const {
999   for (auto I = TRI.legalclasstypes_begin(RC); *I != MVT::Other; ++I)
1000     if (isTypeLegal(*I))
1001       return true;
1002   return false;
1003 }
1004 
1005 /// Replace/modify any TargetFrameIndex operands with a targte-dependent
1006 /// sequence of memory operands that is recognized by PrologEpilogInserter.
1007 MachineBasicBlock *
1008 TargetLoweringBase::emitPatchPoint(MachineInstr &InitialMI,
1009                                    MachineBasicBlock *MBB) const {
1010   MachineInstr *MI = &InitialMI;
1011   MachineFunction &MF = *MI->getMF();
1012   MachineFrameInfo &MFI = MF.getFrameInfo();
1013 
1014   // We're handling multiple types of operands here:
1015   // PATCHPOINT MetaArgs - live-in, read only, direct
1016   // STATEPOINT Deopt Spill - live-through, read only, indirect
1017   // STATEPOINT Deopt Alloca - live-through, read only, direct
1018   // (We're currently conservative and mark the deopt slots read/write in
1019   // practice.)
1020   // STATEPOINT GC Spill - live-through, read/write, indirect
1021   // STATEPOINT GC Alloca - live-through, read/write, direct
1022   // The live-in vs live-through is handled already (the live through ones are
1023   // all stack slots), but we need to handle the different type of stackmap
1024   // operands and memory effects here.
1025 
1026   if (!llvm::any_of(MI->operands(),
1027                     [](MachineOperand &Operand) { return Operand.isFI(); }))
1028     return MBB;
1029 
1030   MachineInstrBuilder MIB = BuildMI(MF, MI->getDebugLoc(), MI->getDesc());
1031 
1032   // Inherit previous memory operands.
1033   MIB.cloneMemRefs(*MI);
1034 
1035   for (auto &MO : MI->operands()) {
1036     if (!MO.isFI()) {
1037       MIB.add(MO);
1038       continue;
1039     }
1040 
1041     // foldMemoryOperand builds a new MI after replacing a single FI operand
1042     // with the canonical set of five x86 addressing-mode operands.
1043     int FI = MO.getIndex();
1044 
1045     // Add frame index operands recognized by stackmaps.cpp
1046     if (MFI.isStatepointSpillSlotObjectIndex(FI)) {
1047       // indirect-mem-ref tag, size, #FI, offset.
1048       // Used for spills inserted by StatepointLowering.  This codepath is not
1049       // used for patchpoints/stackmaps at all, for these spilling is done via
1050       // foldMemoryOperand callback only.
1051       assert(MI->getOpcode() == TargetOpcode::STATEPOINT && "sanity");
1052       MIB.addImm(StackMaps::IndirectMemRefOp);
1053       MIB.addImm(MFI.getObjectSize(FI));
1054       MIB.add(MO);
1055       MIB.addImm(0);
1056     } else {
1057       // direct-mem-ref tag, #FI, offset.
1058       // Used by patchpoint, and direct alloca arguments to statepoints
1059       MIB.addImm(StackMaps::DirectMemRefOp);
1060       MIB.add(MO);
1061       MIB.addImm(0);
1062     }
1063 
1064     assert(MIB->mayLoad() && "Folded a stackmap use to a non-load!");
1065 
1066     // Add a new memory operand for this FI.
1067     assert(MFI.getObjectOffset(FI) != -1);
1068 
1069     // Note: STATEPOINT MMOs are added during SelectionDAG.  STACKMAP, and
1070     // PATCHPOINT should be updated to do the same. (TODO)
1071     if (MI->getOpcode() != TargetOpcode::STATEPOINT) {
1072       auto Flags = MachineMemOperand::MOLoad;
1073       MachineMemOperand *MMO = MF.getMachineMemOperand(
1074           MachinePointerInfo::getFixedStack(MF, FI), Flags,
1075           MF.getDataLayout().getPointerSize(), MFI.getObjectAlign(FI));
1076       MIB->addMemOperand(MF, MMO);
1077     }
1078   }
1079   MBB->insert(MachineBasicBlock::iterator(MI), MIB);
1080   MI->eraseFromParent();
1081   return MBB;
1082 }
1083 
1084 MachineBasicBlock *
1085 TargetLoweringBase::emitXRayCustomEvent(MachineInstr &MI,
1086                                         MachineBasicBlock *MBB) const {
1087   assert(MI.getOpcode() == TargetOpcode::PATCHABLE_EVENT_CALL &&
1088          "Called emitXRayCustomEvent on the wrong MI!");
1089   auto &MF = *MI.getMF();
1090   auto MIB = BuildMI(MF, MI.getDebugLoc(), MI.getDesc());
1091   for (unsigned OpIdx = 0; OpIdx != MI.getNumOperands(); ++OpIdx)
1092     MIB.add(MI.getOperand(OpIdx));
1093 
1094   MBB->insert(MachineBasicBlock::iterator(MI), MIB);
1095   MI.eraseFromParent();
1096   return MBB;
1097 }
1098 
1099 MachineBasicBlock *
1100 TargetLoweringBase::emitXRayTypedEvent(MachineInstr &MI,
1101                                        MachineBasicBlock *MBB) const {
1102   assert(MI.getOpcode() == TargetOpcode::PATCHABLE_TYPED_EVENT_CALL &&
1103          "Called emitXRayTypedEvent on the wrong MI!");
1104   auto &MF = *MI.getMF();
1105   auto MIB = BuildMI(MF, MI.getDebugLoc(), MI.getDesc());
1106   for (unsigned OpIdx = 0; OpIdx != MI.getNumOperands(); ++OpIdx)
1107     MIB.add(MI.getOperand(OpIdx));
1108 
1109   MBB->insert(MachineBasicBlock::iterator(MI), MIB);
1110   MI.eraseFromParent();
1111   return MBB;
1112 }
1113 
1114 /// findRepresentativeClass - Return the largest legal super-reg register class
1115 /// of the register class for the specified type and its associated "cost".
1116 // This function is in TargetLowering because it uses RegClassForVT which would
1117 // need to be moved to TargetRegisterInfo and would necessitate moving
1118 // isTypeLegal over as well - a massive change that would just require
1119 // TargetLowering having a TargetRegisterInfo class member that it would use.
1120 std::pair<const TargetRegisterClass *, uint8_t>
1121 TargetLoweringBase::findRepresentativeClass(const TargetRegisterInfo *TRI,
1122                                             MVT VT) const {
1123   const TargetRegisterClass *RC = RegClassForVT[VT.SimpleTy];
1124   if (!RC)
1125     return std::make_pair(RC, 0);
1126 
1127   // Compute the set of all super-register classes.
1128   BitVector SuperRegRC(TRI->getNumRegClasses());
1129   for (SuperRegClassIterator RCI(RC, TRI); RCI.isValid(); ++RCI)
1130     SuperRegRC.setBitsInMask(RCI.getMask());
1131 
1132   // Find the first legal register class with the largest spill size.
1133   const TargetRegisterClass *BestRC = RC;
1134   for (unsigned i : SuperRegRC.set_bits()) {
1135     const TargetRegisterClass *SuperRC = TRI->getRegClass(i);
1136     // We want the largest possible spill size.
1137     if (TRI->getSpillSize(*SuperRC) <= TRI->getSpillSize(*BestRC))
1138       continue;
1139     if (!isLegalRC(*TRI, *SuperRC))
1140       continue;
1141     BestRC = SuperRC;
1142   }
1143   return std::make_pair(BestRC, 1);
1144 }
1145 
1146 /// computeRegisterProperties - Once all of the register classes are added,
1147 /// this allows us to compute derived properties we expose.
1148 void TargetLoweringBase::computeRegisterProperties(
1149     const TargetRegisterInfo *TRI) {
1150   static_assert(MVT::LAST_VALUETYPE <= MVT::MAX_ALLOWED_VALUETYPE,
1151                 "Too many value types for ValueTypeActions to hold!");
1152 
1153   // Everything defaults to needing one register.
1154   for (unsigned i = 0; i != MVT::LAST_VALUETYPE; ++i) {
1155     NumRegistersForVT[i] = 1;
1156     RegisterTypeForVT[i] = TransformToType[i] = (MVT::SimpleValueType)i;
1157   }
1158   // ...except isVoid, which doesn't need any registers.
1159   NumRegistersForVT[MVT::isVoid] = 0;
1160 
1161   // Find the largest integer register class.
1162   unsigned LargestIntReg = MVT::LAST_INTEGER_VALUETYPE;
1163   for (; RegClassForVT[LargestIntReg] == nullptr; --LargestIntReg)
1164     assert(LargestIntReg != MVT::i1 && "No integer registers defined!");
1165 
1166   // Every integer value type larger than this largest register takes twice as
1167   // many registers to represent as the previous ValueType.
1168   for (unsigned ExpandedReg = LargestIntReg + 1;
1169        ExpandedReg <= MVT::LAST_INTEGER_VALUETYPE; ++ExpandedReg) {
1170     NumRegistersForVT[ExpandedReg] = 2*NumRegistersForVT[ExpandedReg-1];
1171     RegisterTypeForVT[ExpandedReg] = (MVT::SimpleValueType)LargestIntReg;
1172     TransformToType[ExpandedReg] = (MVT::SimpleValueType)(ExpandedReg - 1);
1173     ValueTypeActions.setTypeAction((MVT::SimpleValueType)ExpandedReg,
1174                                    TypeExpandInteger);
1175   }
1176 
1177   // Inspect all of the ValueType's smaller than the largest integer
1178   // register to see which ones need promotion.
1179   unsigned LegalIntReg = LargestIntReg;
1180   for (unsigned IntReg = LargestIntReg - 1;
1181        IntReg >= (unsigned)MVT::i1; --IntReg) {
1182     MVT IVT = (MVT::SimpleValueType)IntReg;
1183     if (isTypeLegal(IVT)) {
1184       LegalIntReg = IntReg;
1185     } else {
1186       RegisterTypeForVT[IntReg] = TransformToType[IntReg] =
1187         (MVT::SimpleValueType)LegalIntReg;
1188       ValueTypeActions.setTypeAction(IVT, TypePromoteInteger);
1189     }
1190   }
1191 
1192   // ppcf128 type is really two f64's.
1193   if (!isTypeLegal(MVT::ppcf128)) {
1194     if (isTypeLegal(MVT::f64)) {
1195       NumRegistersForVT[MVT::ppcf128] = 2*NumRegistersForVT[MVT::f64];
1196       RegisterTypeForVT[MVT::ppcf128] = MVT::f64;
1197       TransformToType[MVT::ppcf128] = MVT::f64;
1198       ValueTypeActions.setTypeAction(MVT::ppcf128, TypeExpandFloat);
1199     } else {
1200       NumRegistersForVT[MVT::ppcf128] = NumRegistersForVT[MVT::i128];
1201       RegisterTypeForVT[MVT::ppcf128] = RegisterTypeForVT[MVT::i128];
1202       TransformToType[MVT::ppcf128] = MVT::i128;
1203       ValueTypeActions.setTypeAction(MVT::ppcf128, TypeSoftenFloat);
1204     }
1205   }
1206 
1207   // Decide how to handle f128. If the target does not have native f128 support,
1208   // expand it to i128 and we will be generating soft float library calls.
1209   if (!isTypeLegal(MVT::f128)) {
1210     NumRegistersForVT[MVT::f128] = NumRegistersForVT[MVT::i128];
1211     RegisterTypeForVT[MVT::f128] = RegisterTypeForVT[MVT::i128];
1212     TransformToType[MVT::f128] = MVT::i128;
1213     ValueTypeActions.setTypeAction(MVT::f128, TypeSoftenFloat);
1214   }
1215 
1216   // Decide how to handle f64. If the target does not have native f64 support,
1217   // expand it to i64 and we will be generating soft float library calls.
1218   if (!isTypeLegal(MVT::f64)) {
1219     NumRegistersForVT[MVT::f64] = NumRegistersForVT[MVT::i64];
1220     RegisterTypeForVT[MVT::f64] = RegisterTypeForVT[MVT::i64];
1221     TransformToType[MVT::f64] = MVT::i64;
1222     ValueTypeActions.setTypeAction(MVT::f64, TypeSoftenFloat);
1223   }
1224 
1225   // Decide how to handle f32. If the target does not have native f32 support,
1226   // expand it to i32 and we will be generating soft float library calls.
1227   if (!isTypeLegal(MVT::f32)) {
1228     NumRegistersForVT[MVT::f32] = NumRegistersForVT[MVT::i32];
1229     RegisterTypeForVT[MVT::f32] = RegisterTypeForVT[MVT::i32];
1230     TransformToType[MVT::f32] = MVT::i32;
1231     ValueTypeActions.setTypeAction(MVT::f32, TypeSoftenFloat);
1232   }
1233 
1234   // Decide how to handle f16. If the target does not have native f16 support,
1235   // promote it to f32, because there are no f16 library calls (except for
1236   // conversions).
1237   if (!isTypeLegal(MVT::f16)) {
1238     // Allow targets to control how we legalize half.
1239     if (softPromoteHalfType()) {
1240       NumRegistersForVT[MVT::f16] = NumRegistersForVT[MVT::i16];
1241       RegisterTypeForVT[MVT::f16] = RegisterTypeForVT[MVT::i16];
1242       TransformToType[MVT::f16] = MVT::f32;
1243       ValueTypeActions.setTypeAction(MVT::f16, TypeSoftPromoteHalf);
1244     } else {
1245       NumRegistersForVT[MVT::f16] = NumRegistersForVT[MVT::f32];
1246       RegisterTypeForVT[MVT::f16] = RegisterTypeForVT[MVT::f32];
1247       TransformToType[MVT::f16] = MVT::f32;
1248       ValueTypeActions.setTypeAction(MVT::f16, TypePromoteFloat);
1249     }
1250   }
1251 
1252   // Loop over all of the vector value types to see which need transformations.
1253   for (unsigned i = MVT::FIRST_VECTOR_VALUETYPE;
1254        i <= (unsigned)MVT::LAST_VECTOR_VALUETYPE; ++i) {
1255     MVT VT = (MVT::SimpleValueType) i;
1256     if (isTypeLegal(VT))
1257       continue;
1258 
1259     MVT EltVT = VT.getVectorElementType();
1260     unsigned NElts = VT.getVectorNumElements();
1261     bool IsLegalWiderType = false;
1262     bool IsScalable = VT.isScalableVector();
1263     LegalizeTypeAction PreferredAction = getPreferredVectorAction(VT);
1264     switch (PreferredAction) {
1265     case TypePromoteInteger: {
1266       MVT::SimpleValueType EndVT = IsScalable ?
1267                                    MVT::LAST_INTEGER_SCALABLE_VECTOR_VALUETYPE :
1268                                    MVT::LAST_INTEGER_FIXEDLEN_VECTOR_VALUETYPE;
1269       // Try to promote the elements of integer vectors. If no legal
1270       // promotion was found, fall through to the widen-vector method.
1271       for (unsigned nVT = i + 1;
1272            (MVT::SimpleValueType)nVT <= EndVT; ++nVT) {
1273         MVT SVT = (MVT::SimpleValueType) nVT;
1274         // Promote vectors of integers to vectors with the same number
1275         // of elements, with a wider element type.
1276         if (SVT.getScalarSizeInBits() > EltVT.getSizeInBits() &&
1277             SVT.getVectorNumElements() == NElts &&
1278             SVT.isScalableVector() == IsScalable && isTypeLegal(SVT)) {
1279           TransformToType[i] = SVT;
1280           RegisterTypeForVT[i] = SVT;
1281           NumRegistersForVT[i] = 1;
1282           ValueTypeActions.setTypeAction(VT, TypePromoteInteger);
1283           IsLegalWiderType = true;
1284           break;
1285         }
1286       }
1287       if (IsLegalWiderType)
1288         break;
1289       LLVM_FALLTHROUGH;
1290     }
1291 
1292     case TypeWidenVector:
1293       if (isPowerOf2_32(NElts)) {
1294         // Try to widen the vector.
1295         for (unsigned nVT = i + 1; nVT <= MVT::LAST_VECTOR_VALUETYPE; ++nVT) {
1296           MVT SVT = (MVT::SimpleValueType) nVT;
1297           if (SVT.getVectorElementType() == EltVT
1298               && SVT.getVectorNumElements() > NElts
1299               && SVT.isScalableVector() == IsScalable && isTypeLegal(SVT)) {
1300             TransformToType[i] = SVT;
1301             RegisterTypeForVT[i] = SVT;
1302             NumRegistersForVT[i] = 1;
1303             ValueTypeActions.setTypeAction(VT, TypeWidenVector);
1304             IsLegalWiderType = true;
1305             break;
1306           }
1307         }
1308         if (IsLegalWiderType)
1309           break;
1310       } else {
1311         // Only widen to the next power of 2 to keep consistency with EVT.
1312         MVT NVT = VT.getPow2VectorType();
1313         if (isTypeLegal(NVT)) {
1314           TransformToType[i] = NVT;
1315           ValueTypeActions.setTypeAction(VT, TypeWidenVector);
1316           RegisterTypeForVT[i] = NVT;
1317           NumRegistersForVT[i] = 1;
1318           break;
1319         }
1320       }
1321       LLVM_FALLTHROUGH;
1322 
1323     case TypeSplitVector:
1324     case TypeScalarizeVector: {
1325       MVT IntermediateVT;
1326       MVT RegisterVT;
1327       unsigned NumIntermediates;
1328       unsigned NumRegisters = getVectorTypeBreakdownMVT(VT, IntermediateVT,
1329           NumIntermediates, RegisterVT, this);
1330       NumRegistersForVT[i] = NumRegisters;
1331       assert(NumRegistersForVT[i] == NumRegisters &&
1332              "NumRegistersForVT size cannot represent NumRegisters!");
1333       RegisterTypeForVT[i] = RegisterVT;
1334 
1335       MVT NVT = VT.getPow2VectorType();
1336       if (NVT == VT) {
1337         // Type is already a power of 2.  The default action is to split.
1338         TransformToType[i] = MVT::Other;
1339         if (PreferredAction == TypeScalarizeVector)
1340           ValueTypeActions.setTypeAction(VT, TypeScalarizeVector);
1341         else if (PreferredAction == TypeSplitVector)
1342           ValueTypeActions.setTypeAction(VT, TypeSplitVector);
1343         else
1344           // Set type action according to the number of elements.
1345           ValueTypeActions.setTypeAction(VT, NElts == 1 ? TypeScalarizeVector
1346                                                         : TypeSplitVector);
1347       } else {
1348         TransformToType[i] = NVT;
1349         ValueTypeActions.setTypeAction(VT, TypeWidenVector);
1350       }
1351       break;
1352     }
1353     default:
1354       llvm_unreachable("Unknown vector legalization action!");
1355     }
1356   }
1357 
1358   // Determine the 'representative' register class for each value type.
1359   // An representative register class is the largest (meaning one which is
1360   // not a sub-register class / subreg register class) legal register class for
1361   // a group of value types. For example, on i386, i8, i16, and i32
1362   // representative would be GR32; while on x86_64 it's GR64.
1363   for (unsigned i = 0; i != MVT::LAST_VALUETYPE; ++i) {
1364     const TargetRegisterClass* RRC;
1365     uint8_t Cost;
1366     std::tie(RRC, Cost) = findRepresentativeClass(TRI, (MVT::SimpleValueType)i);
1367     RepRegClassForVT[i] = RRC;
1368     RepRegClassCostForVT[i] = Cost;
1369   }
1370 }
1371 
1372 EVT TargetLoweringBase::getSetCCResultType(const DataLayout &DL, LLVMContext &,
1373                                            EVT VT) const {
1374   assert(!VT.isVector() && "No default SetCC type for vectors!");
1375   return getPointerTy(DL).SimpleTy;
1376 }
1377 
1378 MVT::SimpleValueType TargetLoweringBase::getCmpLibcallReturnType() const {
1379   return MVT::i32; // return the default value
1380 }
1381 
1382 /// getVectorTypeBreakdown - Vector types are broken down into some number of
1383 /// legal first class types.  For example, MVT::v8f32 maps to 2 MVT::v4f32
1384 /// with Altivec or SSE1, or 8 promoted MVT::f64 values with the X86 FP stack.
1385 /// Similarly, MVT::v2i64 turns into 4 MVT::i32 values with both PPC and X86.
1386 ///
1387 /// This method returns the number of registers needed, and the VT for each
1388 /// register.  It also returns the VT and quantity of the intermediate values
1389 /// before they are promoted/expanded.
1390 unsigned TargetLoweringBase::getVectorTypeBreakdown(LLVMContext &Context, EVT VT,
1391                                                 EVT &IntermediateVT,
1392                                                 unsigned &NumIntermediates,
1393                                                 MVT &RegisterVT) const {
1394   ElementCount EltCnt = VT.getVectorElementCount();
1395 
1396   // If there is a wider vector type with the same element type as this one,
1397   // or a promoted vector type that has the same number of elements which
1398   // are wider, then we should convert to that legal vector type.
1399   // This handles things like <2 x float> -> <4 x float> and
1400   // <4 x i1> -> <4 x i32>.
1401   LegalizeTypeAction TA = getTypeAction(Context, VT);
1402   if (EltCnt.Min != 1 && (TA == TypeWidenVector || TA == TypePromoteInteger)) {
1403     EVT RegisterEVT = getTypeToTransformTo(Context, VT);
1404     if (isTypeLegal(RegisterEVT)) {
1405       IntermediateVT = RegisterEVT;
1406       RegisterVT = RegisterEVT.getSimpleVT();
1407       NumIntermediates = 1;
1408       return 1;
1409     }
1410   }
1411 
1412   // Figure out the right, legal destination reg to copy into.
1413   EVT EltTy = VT.getVectorElementType();
1414 
1415   unsigned NumVectorRegs = 1;
1416 
1417   // FIXME: We don't support non-power-of-2-sized vectors for now.  Ideally we
1418   // could break down into LHS/RHS like LegalizeDAG does.
1419   if (!isPowerOf2_32(EltCnt.Min)) {
1420     NumVectorRegs = EltCnt.Min;
1421     EltCnt.Min = 1;
1422   }
1423 
1424   // Divide the input until we get to a supported size.  This will always
1425   // end with a scalar if the target doesn't support vectors.
1426   while (EltCnt.Min > 1 &&
1427          !isTypeLegal(EVT::getVectorVT(Context, EltTy, EltCnt))) {
1428     EltCnt.Min >>= 1;
1429     NumVectorRegs <<= 1;
1430   }
1431 
1432   NumIntermediates = NumVectorRegs;
1433 
1434   EVT NewVT = EVT::getVectorVT(Context, EltTy, EltCnt);
1435   if (!isTypeLegal(NewVT))
1436     NewVT = EltTy;
1437   IntermediateVT = NewVT;
1438 
1439   MVT DestVT = getRegisterType(Context, NewVT);
1440   RegisterVT = DestVT;
1441   unsigned NewVTSize = NewVT.getSizeInBits();
1442 
1443   // Convert sizes such as i33 to i64.
1444   if (!isPowerOf2_32(NewVTSize))
1445     NewVTSize = NextPowerOf2(NewVTSize);
1446 
1447   if (EVT(DestVT).bitsLT(NewVT))   // Value is expanded, e.g. i64 -> i16.
1448     return NumVectorRegs*(NewVTSize/DestVT.getSizeInBits());
1449 
1450   // Otherwise, promotion or legal types use the same number of registers as
1451   // the vector decimated to the appropriate level.
1452   return NumVectorRegs;
1453 }
1454 
1455 bool TargetLoweringBase::isSuitableForJumpTable(const SwitchInst *SI,
1456                                                 uint64_t NumCases,
1457                                                 uint64_t Range,
1458                                                 ProfileSummaryInfo *PSI,
1459                                                 BlockFrequencyInfo *BFI) const {
1460   // FIXME: This function check the maximum table size and density, but the
1461   // minimum size is not checked. It would be nice if the minimum size is
1462   // also combined within this function. Currently, the minimum size check is
1463   // performed in findJumpTable() in SelectionDAGBuiler and
1464   // getEstimatedNumberOfCaseClusters() in BasicTTIImpl.
1465   const bool OptForSize =
1466       SI->getParent()->getParent()->hasOptSize() ||
1467       llvm::shouldOptimizeForSize(SI->getParent(), PSI, BFI);
1468   const unsigned MinDensity = getMinimumJumpTableDensity(OptForSize);
1469   const unsigned MaxJumpTableSize = getMaximumJumpTableSize();
1470 
1471   // Check whether the number of cases is small enough and
1472   // the range is dense enough for a jump table.
1473   return (OptForSize || Range <= MaxJumpTableSize) &&
1474          (NumCases * 100 >= Range * MinDensity);
1475 }
1476 
1477 /// Get the EVTs and ArgFlags collections that represent the legalized return
1478 /// type of the given function.  This does not require a DAG or a return value,
1479 /// and is suitable for use before any DAGs for the function are constructed.
1480 /// TODO: Move this out of TargetLowering.cpp.
1481 void llvm::GetReturnInfo(CallingConv::ID CC, Type *ReturnType,
1482                          AttributeList attr,
1483                          SmallVectorImpl<ISD::OutputArg> &Outs,
1484                          const TargetLowering &TLI, const DataLayout &DL) {
1485   SmallVector<EVT, 4> ValueVTs;
1486   ComputeValueVTs(TLI, DL, ReturnType, ValueVTs);
1487   unsigned NumValues = ValueVTs.size();
1488   if (NumValues == 0) return;
1489 
1490   for (unsigned j = 0, f = NumValues; j != f; ++j) {
1491     EVT VT = ValueVTs[j];
1492     ISD::NodeType ExtendKind = ISD::ANY_EXTEND;
1493 
1494     if (attr.hasAttribute(AttributeList::ReturnIndex, Attribute::SExt))
1495       ExtendKind = ISD::SIGN_EXTEND;
1496     else if (attr.hasAttribute(AttributeList::ReturnIndex, Attribute::ZExt))
1497       ExtendKind = ISD::ZERO_EXTEND;
1498 
1499     // FIXME: C calling convention requires the return type to be promoted to
1500     // at least 32-bit. But this is not necessary for non-C calling
1501     // conventions. The frontend should mark functions whose return values
1502     // require promoting with signext or zeroext attributes.
1503     if (ExtendKind != ISD::ANY_EXTEND && VT.isInteger()) {
1504       MVT MinVT = TLI.getRegisterType(ReturnType->getContext(), MVT::i32);
1505       if (VT.bitsLT(MinVT))
1506         VT = MinVT;
1507     }
1508 
1509     unsigned NumParts =
1510         TLI.getNumRegistersForCallingConv(ReturnType->getContext(), CC, VT);
1511     MVT PartVT =
1512         TLI.getRegisterTypeForCallingConv(ReturnType->getContext(), CC, VT);
1513 
1514     // 'inreg' on function refers to return value
1515     ISD::ArgFlagsTy Flags = ISD::ArgFlagsTy();
1516     if (attr.hasAttribute(AttributeList::ReturnIndex, Attribute::InReg))
1517       Flags.setInReg();
1518 
1519     // Propagate extension type if any
1520     if (attr.hasAttribute(AttributeList::ReturnIndex, Attribute::SExt))
1521       Flags.setSExt();
1522     else if (attr.hasAttribute(AttributeList::ReturnIndex, Attribute::ZExt))
1523       Flags.setZExt();
1524 
1525     for (unsigned i = 0; i < NumParts; ++i)
1526       Outs.push_back(ISD::OutputArg(Flags, PartVT, VT, /*isfixed=*/true, 0, 0));
1527   }
1528 }
1529 
1530 /// getByValTypeAlignment - Return the desired alignment for ByVal aggregate
1531 /// function arguments in the caller parameter area.  This is the actual
1532 /// alignment, not its logarithm.
1533 unsigned TargetLoweringBase::getByValTypeAlignment(Type *Ty,
1534                                                    const DataLayout &DL) const {
1535   return DL.getABITypeAlign(Ty).value();
1536 }
1537 
1538 bool TargetLoweringBase::allowsMemoryAccessForAlignment(
1539     LLVMContext &Context, const DataLayout &DL, EVT VT, unsigned AddrSpace,
1540     unsigned Alignment, MachineMemOperand::Flags Flags, bool *Fast) const {
1541   // Check if the specified alignment is sufficient based on the data layout.
1542   // TODO: While using the data layout works in practice, a better solution
1543   // would be to implement this check directly (make this a virtual function).
1544   // For example, the ABI alignment may change based on software platform while
1545   // this function should only be affected by hardware implementation.
1546   Type *Ty = VT.getTypeForEVT(Context);
1547   if (Alignment >= DL.getABITypeAlign(Ty).value()) {
1548     // Assume that an access that meets the ABI-specified alignment is fast.
1549     if (Fast != nullptr)
1550       *Fast = true;
1551     return true;
1552   }
1553 
1554   // This is a misaligned access.
1555   return allowsMisalignedMemoryAccesses(VT, AddrSpace, Alignment, Flags, Fast);
1556 }
1557 
1558 bool TargetLoweringBase::allowsMemoryAccessForAlignment(
1559     LLVMContext &Context, const DataLayout &DL, EVT VT,
1560     const MachineMemOperand &MMO, bool *Fast) const {
1561   return allowsMemoryAccessForAlignment(Context, DL, VT, MMO.getAddrSpace(),
1562                                         MMO.getAlign().value(), MMO.getFlags(),
1563                                         Fast);
1564 }
1565 
1566 bool TargetLoweringBase::allowsMemoryAccess(
1567     LLVMContext &Context, const DataLayout &DL, EVT VT, unsigned AddrSpace,
1568     unsigned Alignment, MachineMemOperand::Flags Flags, bool *Fast) const {
1569   return allowsMemoryAccessForAlignment(Context, DL, VT, AddrSpace, Alignment,
1570                                         Flags, Fast);
1571 }
1572 
1573 bool TargetLoweringBase::allowsMemoryAccess(LLVMContext &Context,
1574                                             const DataLayout &DL, EVT VT,
1575                                             const MachineMemOperand &MMO,
1576                                             bool *Fast) const {
1577   return allowsMemoryAccess(Context, DL, VT, MMO.getAddrSpace(),
1578                             MMO.getAlign().value(), MMO.getFlags(), Fast);
1579 }
1580 
1581 BranchProbability TargetLoweringBase::getPredictableBranchThreshold() const {
1582   return BranchProbability(MinPercentageForPredictableBranch, 100);
1583 }
1584 
1585 //===----------------------------------------------------------------------===//
1586 //  TargetTransformInfo Helpers
1587 //===----------------------------------------------------------------------===//
1588 
1589 int TargetLoweringBase::InstructionOpcodeToISD(unsigned Opcode) const {
1590   enum InstructionOpcodes {
1591 #define HANDLE_INST(NUM, OPCODE, CLASS) OPCODE = NUM,
1592 #define LAST_OTHER_INST(NUM) InstructionOpcodesCount = NUM
1593 #include "llvm/IR/Instruction.def"
1594   };
1595   switch (static_cast<InstructionOpcodes>(Opcode)) {
1596   case Ret:            return 0;
1597   case Br:             return 0;
1598   case Switch:         return 0;
1599   case IndirectBr:     return 0;
1600   case Invoke:         return 0;
1601   case CallBr:         return 0;
1602   case Resume:         return 0;
1603   case Unreachable:    return 0;
1604   case CleanupRet:     return 0;
1605   case CatchRet:       return 0;
1606   case CatchPad:       return 0;
1607   case CatchSwitch:    return 0;
1608   case CleanupPad:     return 0;
1609   case FNeg:           return ISD::FNEG;
1610   case Add:            return ISD::ADD;
1611   case FAdd:           return ISD::FADD;
1612   case Sub:            return ISD::SUB;
1613   case FSub:           return ISD::FSUB;
1614   case Mul:            return ISD::MUL;
1615   case FMul:           return ISD::FMUL;
1616   case UDiv:           return ISD::UDIV;
1617   case SDiv:           return ISD::SDIV;
1618   case FDiv:           return ISD::FDIV;
1619   case URem:           return ISD::UREM;
1620   case SRem:           return ISD::SREM;
1621   case FRem:           return ISD::FREM;
1622   case Shl:            return ISD::SHL;
1623   case LShr:           return ISD::SRL;
1624   case AShr:           return ISD::SRA;
1625   case And:            return ISD::AND;
1626   case Or:             return ISD::OR;
1627   case Xor:            return ISD::XOR;
1628   case Alloca:         return 0;
1629   case Load:           return ISD::LOAD;
1630   case Store:          return ISD::STORE;
1631   case GetElementPtr:  return 0;
1632   case Fence:          return 0;
1633   case AtomicCmpXchg:  return 0;
1634   case AtomicRMW:      return 0;
1635   case Trunc:          return ISD::TRUNCATE;
1636   case ZExt:           return ISD::ZERO_EXTEND;
1637   case SExt:           return ISD::SIGN_EXTEND;
1638   case FPToUI:         return ISD::FP_TO_UINT;
1639   case FPToSI:         return ISD::FP_TO_SINT;
1640   case UIToFP:         return ISD::UINT_TO_FP;
1641   case SIToFP:         return ISD::SINT_TO_FP;
1642   case FPTrunc:        return ISD::FP_ROUND;
1643   case FPExt:          return ISD::FP_EXTEND;
1644   case PtrToInt:       return ISD::BITCAST;
1645   case IntToPtr:       return ISD::BITCAST;
1646   case BitCast:        return ISD::BITCAST;
1647   case AddrSpaceCast:  return ISD::ADDRSPACECAST;
1648   case ICmp:           return ISD::SETCC;
1649   case FCmp:           return ISD::SETCC;
1650   case PHI:            return 0;
1651   case Call:           return 0;
1652   case Select:         return ISD::SELECT;
1653   case UserOp1:        return 0;
1654   case UserOp2:        return 0;
1655   case VAArg:          return 0;
1656   case ExtractElement: return ISD::EXTRACT_VECTOR_ELT;
1657   case InsertElement:  return ISD::INSERT_VECTOR_ELT;
1658   case ShuffleVector:  return ISD::VECTOR_SHUFFLE;
1659   case ExtractValue:   return ISD::MERGE_VALUES;
1660   case InsertValue:    return ISD::MERGE_VALUES;
1661   case LandingPad:     return 0;
1662   case Freeze:         return ISD::FREEZE;
1663   }
1664 
1665   llvm_unreachable("Unknown instruction type encountered!");
1666 }
1667 
1668 std::pair<int, MVT>
1669 TargetLoweringBase::getTypeLegalizationCost(const DataLayout &DL,
1670                                             Type *Ty) const {
1671   LLVMContext &C = Ty->getContext();
1672   EVT MTy = getValueType(DL, Ty);
1673 
1674   int Cost = 1;
1675   // We keep legalizing the type until we find a legal kind. We assume that
1676   // the only operation that costs anything is the split. After splitting
1677   // we need to handle two types.
1678   while (true) {
1679     LegalizeKind LK = getTypeConversion(C, MTy);
1680 
1681     if (LK.first == TypeLegal)
1682       return std::make_pair(Cost, MTy.getSimpleVT());
1683 
1684     if (LK.first == TypeSplitVector || LK.first == TypeExpandInteger)
1685       Cost *= 2;
1686 
1687     // Do not loop with f128 type.
1688     if (MTy == LK.second)
1689       return std::make_pair(Cost, MTy.getSimpleVT());
1690 
1691     // Keep legalizing the type.
1692     MTy = LK.second;
1693   }
1694 }
1695 
1696 Value *TargetLoweringBase::getDefaultSafeStackPointerLocation(IRBuilder<> &IRB,
1697                                                               bool UseTLS) const {
1698   // compiler-rt provides a variable with a magic name.  Targets that do not
1699   // link with compiler-rt may also provide such a variable.
1700   Module *M = IRB.GetInsertBlock()->getParent()->getParent();
1701   const char *UnsafeStackPtrVar = "__safestack_unsafe_stack_ptr";
1702   auto UnsafeStackPtr =
1703       dyn_cast_or_null<GlobalVariable>(M->getNamedValue(UnsafeStackPtrVar));
1704 
1705   Type *StackPtrTy = Type::getInt8PtrTy(M->getContext());
1706 
1707   if (!UnsafeStackPtr) {
1708     auto TLSModel = UseTLS ?
1709         GlobalValue::InitialExecTLSModel :
1710         GlobalValue::NotThreadLocal;
1711     // The global variable is not defined yet, define it ourselves.
1712     // We use the initial-exec TLS model because we do not support the
1713     // variable living anywhere other than in the main executable.
1714     UnsafeStackPtr = new GlobalVariable(
1715         *M, StackPtrTy, false, GlobalValue::ExternalLinkage, nullptr,
1716         UnsafeStackPtrVar, nullptr, TLSModel);
1717   } else {
1718     // The variable exists, check its type and attributes.
1719     if (UnsafeStackPtr->getValueType() != StackPtrTy)
1720       report_fatal_error(Twine(UnsafeStackPtrVar) + " must have void* type");
1721     if (UseTLS != UnsafeStackPtr->isThreadLocal())
1722       report_fatal_error(Twine(UnsafeStackPtrVar) + " must " +
1723                          (UseTLS ? "" : "not ") + "be thread-local");
1724   }
1725   return UnsafeStackPtr;
1726 }
1727 
1728 Value *TargetLoweringBase::getSafeStackPointerLocation(IRBuilder<> &IRB) const {
1729   if (!TM.getTargetTriple().isAndroid())
1730     return getDefaultSafeStackPointerLocation(IRB, true);
1731 
1732   // Android provides a libc function to retrieve the address of the current
1733   // thread's unsafe stack pointer.
1734   Module *M = IRB.GetInsertBlock()->getParent()->getParent();
1735   Type *StackPtrTy = Type::getInt8PtrTy(M->getContext());
1736   FunctionCallee Fn = M->getOrInsertFunction("__safestack_pointer_address",
1737                                              StackPtrTy->getPointerTo(0));
1738   return IRB.CreateCall(Fn);
1739 }
1740 
1741 //===----------------------------------------------------------------------===//
1742 //  Loop Strength Reduction hooks
1743 //===----------------------------------------------------------------------===//
1744 
1745 /// isLegalAddressingMode - Return true if the addressing mode represented
1746 /// by AM is legal for this target, for a load/store of the specified type.
1747 bool TargetLoweringBase::isLegalAddressingMode(const DataLayout &DL,
1748                                                const AddrMode &AM, Type *Ty,
1749                                                unsigned AS, Instruction *I) const {
1750   // The default implementation of this implements a conservative RISCy, r+r and
1751   // r+i addr mode.
1752 
1753   // Allows a sign-extended 16-bit immediate field.
1754   if (AM.BaseOffs <= -(1LL << 16) || AM.BaseOffs >= (1LL << 16)-1)
1755     return false;
1756 
1757   // No global is ever allowed as a base.
1758   if (AM.BaseGV)
1759     return false;
1760 
1761   // Only support r+r,
1762   switch (AM.Scale) {
1763   case 0:  // "r+i" or just "i", depending on HasBaseReg.
1764     break;
1765   case 1:
1766     if (AM.HasBaseReg && AM.BaseOffs)  // "r+r+i" is not allowed.
1767       return false;
1768     // Otherwise we have r+r or r+i.
1769     break;
1770   case 2:
1771     if (AM.HasBaseReg || AM.BaseOffs)  // 2*r+r  or  2*r+i is not allowed.
1772       return false;
1773     // Allow 2*r as r+r.
1774     break;
1775   default: // Don't allow n * r
1776     return false;
1777   }
1778 
1779   return true;
1780 }
1781 
1782 //===----------------------------------------------------------------------===//
1783 //  Stack Protector
1784 //===----------------------------------------------------------------------===//
1785 
1786 // For OpenBSD return its special guard variable. Otherwise return nullptr,
1787 // so that SelectionDAG handle SSP.
1788 Value *TargetLoweringBase::getIRStackGuard(IRBuilder<> &IRB) const {
1789   if (getTargetMachine().getTargetTriple().isOSOpenBSD()) {
1790     Module &M = *IRB.GetInsertBlock()->getParent()->getParent();
1791     PointerType *PtrTy = Type::getInt8PtrTy(M.getContext());
1792     return M.getOrInsertGlobal("__guard_local", PtrTy);
1793   }
1794   return nullptr;
1795 }
1796 
1797 // Currently only support "standard" __stack_chk_guard.
1798 // TODO: add LOAD_STACK_GUARD support.
1799 void TargetLoweringBase::insertSSPDeclarations(Module &M) const {
1800   if (!M.getNamedValue("__stack_chk_guard"))
1801     new GlobalVariable(M, Type::getInt8PtrTy(M.getContext()), false,
1802                        GlobalVariable::ExternalLinkage,
1803                        nullptr, "__stack_chk_guard");
1804 }
1805 
1806 // Currently only support "standard" __stack_chk_guard.
1807 // TODO: add LOAD_STACK_GUARD support.
1808 Value *TargetLoweringBase::getSDagStackGuard(const Module &M) const {
1809   return M.getNamedValue("__stack_chk_guard");
1810 }
1811 
1812 Function *TargetLoweringBase::getSSPStackGuardCheck(const Module &M) const {
1813   return nullptr;
1814 }
1815 
1816 unsigned TargetLoweringBase::getMinimumJumpTableEntries() const {
1817   return MinimumJumpTableEntries;
1818 }
1819 
1820 void TargetLoweringBase::setMinimumJumpTableEntries(unsigned Val) {
1821   MinimumJumpTableEntries = Val;
1822 }
1823 
1824 unsigned TargetLoweringBase::getMinimumJumpTableDensity(bool OptForSize) const {
1825   return OptForSize ? OptsizeJumpTableDensity : JumpTableDensity;
1826 }
1827 
1828 unsigned TargetLoweringBase::getMaximumJumpTableSize() const {
1829   return MaximumJumpTableSize;
1830 }
1831 
1832 void TargetLoweringBase::setMaximumJumpTableSize(unsigned Val) {
1833   MaximumJumpTableSize = Val;
1834 }
1835 
1836 bool TargetLoweringBase::isJumpTableRelative() const {
1837   return getTargetMachine().isPositionIndependent();
1838 }
1839 
1840 //===----------------------------------------------------------------------===//
1841 //  Reciprocal Estimates
1842 //===----------------------------------------------------------------------===//
1843 
1844 /// Get the reciprocal estimate attribute string for a function that will
1845 /// override the target defaults.
1846 static StringRef getRecipEstimateForFunc(MachineFunction &MF) {
1847   const Function &F = MF.getFunction();
1848   return F.getFnAttribute("reciprocal-estimates").getValueAsString();
1849 }
1850 
1851 /// Construct a string for the given reciprocal operation of the given type.
1852 /// This string should match the corresponding option to the front-end's
1853 /// "-mrecip" flag assuming those strings have been passed through in an
1854 /// attribute string. For example, "vec-divf" for a division of a vXf32.
1855 static std::string getReciprocalOpName(bool IsSqrt, EVT VT) {
1856   std::string Name = VT.isVector() ? "vec-" : "";
1857 
1858   Name += IsSqrt ? "sqrt" : "div";
1859 
1860   // TODO: Handle "half" or other float types?
1861   if (VT.getScalarType() == MVT::f64) {
1862     Name += "d";
1863   } else {
1864     assert(VT.getScalarType() == MVT::f32 &&
1865            "Unexpected FP type for reciprocal estimate");
1866     Name += "f";
1867   }
1868 
1869   return Name;
1870 }
1871 
1872 /// Return the character position and value (a single numeric character) of a
1873 /// customized refinement operation in the input string if it exists. Return
1874 /// false if there is no customized refinement step count.
1875 static bool parseRefinementStep(StringRef In, size_t &Position,
1876                                 uint8_t &Value) {
1877   const char RefStepToken = ':';
1878   Position = In.find(RefStepToken);
1879   if (Position == StringRef::npos)
1880     return false;
1881 
1882   StringRef RefStepString = In.substr(Position + 1);
1883   // Allow exactly one numeric character for the additional refinement
1884   // step parameter.
1885   if (RefStepString.size() == 1) {
1886     char RefStepChar = RefStepString[0];
1887     if (RefStepChar >= '0' && RefStepChar <= '9') {
1888       Value = RefStepChar - '0';
1889       return true;
1890     }
1891   }
1892   report_fatal_error("Invalid refinement step for -recip.");
1893 }
1894 
1895 /// For the input attribute string, return one of the ReciprocalEstimate enum
1896 /// status values (enabled, disabled, or not specified) for this operation on
1897 /// the specified data type.
1898 static int getOpEnabled(bool IsSqrt, EVT VT, StringRef Override) {
1899   if (Override.empty())
1900     return TargetLoweringBase::ReciprocalEstimate::Unspecified;
1901 
1902   SmallVector<StringRef, 4> OverrideVector;
1903   Override.split(OverrideVector, ',');
1904   unsigned NumArgs = OverrideVector.size();
1905 
1906   // Check if "all", "none", or "default" was specified.
1907   if (NumArgs == 1) {
1908     // Look for an optional setting of the number of refinement steps needed
1909     // for this type of reciprocal operation.
1910     size_t RefPos;
1911     uint8_t RefSteps;
1912     if (parseRefinementStep(Override, RefPos, RefSteps)) {
1913       // Split the string for further processing.
1914       Override = Override.substr(0, RefPos);
1915     }
1916 
1917     // All reciprocal types are enabled.
1918     if (Override == "all")
1919       return TargetLoweringBase::ReciprocalEstimate::Enabled;
1920 
1921     // All reciprocal types are disabled.
1922     if (Override == "none")
1923       return TargetLoweringBase::ReciprocalEstimate::Disabled;
1924 
1925     // Target defaults for enablement are used.
1926     if (Override == "default")
1927       return TargetLoweringBase::ReciprocalEstimate::Unspecified;
1928   }
1929 
1930   // The attribute string may omit the size suffix ('f'/'d').
1931   std::string VTName = getReciprocalOpName(IsSqrt, VT);
1932   std::string VTNameNoSize = VTName;
1933   VTNameNoSize.pop_back();
1934   static const char DisabledPrefix = '!';
1935 
1936   for (StringRef RecipType : OverrideVector) {
1937     size_t RefPos;
1938     uint8_t RefSteps;
1939     if (parseRefinementStep(RecipType, RefPos, RefSteps))
1940       RecipType = RecipType.substr(0, RefPos);
1941 
1942     // Ignore the disablement token for string matching.
1943     bool IsDisabled = RecipType[0] == DisabledPrefix;
1944     if (IsDisabled)
1945       RecipType = RecipType.substr(1);
1946 
1947     if (RecipType.equals(VTName) || RecipType.equals(VTNameNoSize))
1948       return IsDisabled ? TargetLoweringBase::ReciprocalEstimate::Disabled
1949                         : TargetLoweringBase::ReciprocalEstimate::Enabled;
1950   }
1951 
1952   return TargetLoweringBase::ReciprocalEstimate::Unspecified;
1953 }
1954 
1955 /// For the input attribute string, return the customized refinement step count
1956 /// for this operation on the specified data type. If the step count does not
1957 /// exist, return the ReciprocalEstimate enum value for unspecified.
1958 static int getOpRefinementSteps(bool IsSqrt, EVT VT, StringRef Override) {
1959   if (Override.empty())
1960     return TargetLoweringBase::ReciprocalEstimate::Unspecified;
1961 
1962   SmallVector<StringRef, 4> OverrideVector;
1963   Override.split(OverrideVector, ',');
1964   unsigned NumArgs = OverrideVector.size();
1965 
1966   // Check if "all", "default", or "none" was specified.
1967   if (NumArgs == 1) {
1968     // Look for an optional setting of the number of refinement steps needed
1969     // for this type of reciprocal operation.
1970     size_t RefPos;
1971     uint8_t RefSteps;
1972     if (!parseRefinementStep(Override, RefPos, RefSteps))
1973       return TargetLoweringBase::ReciprocalEstimate::Unspecified;
1974 
1975     // Split the string for further processing.
1976     Override = Override.substr(0, RefPos);
1977     assert(Override != "none" &&
1978            "Disabled reciprocals, but specifed refinement steps?");
1979 
1980     // If this is a general override, return the specified number of steps.
1981     if (Override == "all" || Override == "default")
1982       return RefSteps;
1983   }
1984 
1985   // The attribute string may omit the size suffix ('f'/'d').
1986   std::string VTName = getReciprocalOpName(IsSqrt, VT);
1987   std::string VTNameNoSize = VTName;
1988   VTNameNoSize.pop_back();
1989 
1990   for (StringRef RecipType : OverrideVector) {
1991     size_t RefPos;
1992     uint8_t RefSteps;
1993     if (!parseRefinementStep(RecipType, RefPos, RefSteps))
1994       continue;
1995 
1996     RecipType = RecipType.substr(0, RefPos);
1997     if (RecipType.equals(VTName) || RecipType.equals(VTNameNoSize))
1998       return RefSteps;
1999   }
2000 
2001   return TargetLoweringBase::ReciprocalEstimate::Unspecified;
2002 }
2003 
2004 int TargetLoweringBase::getRecipEstimateSqrtEnabled(EVT VT,
2005                                                     MachineFunction &MF) const {
2006   return getOpEnabled(true, VT, getRecipEstimateForFunc(MF));
2007 }
2008 
2009 int TargetLoweringBase::getRecipEstimateDivEnabled(EVT VT,
2010                                                    MachineFunction &MF) const {
2011   return getOpEnabled(false, VT, getRecipEstimateForFunc(MF));
2012 }
2013 
2014 int TargetLoweringBase::getSqrtRefinementSteps(EVT VT,
2015                                                MachineFunction &MF) const {
2016   return getOpRefinementSteps(true, VT, getRecipEstimateForFunc(MF));
2017 }
2018 
2019 int TargetLoweringBase::getDivRefinementSteps(EVT VT,
2020                                               MachineFunction &MF) const {
2021   return getOpRefinementSteps(false, VT, getRecipEstimateForFunc(MF));
2022 }
2023 
2024 void TargetLoweringBase::finalizeLowering(MachineFunction &MF) const {
2025   MF.getRegInfo().freezeReservedRegs(MF);
2026 }
2027 
2028 MachineMemOperand::Flags
2029 TargetLoweringBase::getLoadMemOperandFlags(const LoadInst &LI,
2030                                            const DataLayout &DL) const {
2031   MachineMemOperand::Flags Flags = MachineMemOperand::MOLoad;
2032   if (LI.isVolatile())
2033     Flags |= MachineMemOperand::MOVolatile;
2034 
2035   if (LI.hasMetadata(LLVMContext::MD_nontemporal))
2036     Flags |= MachineMemOperand::MONonTemporal;
2037 
2038   if (LI.hasMetadata(LLVMContext::MD_invariant_load))
2039     Flags |= MachineMemOperand::MOInvariant;
2040 
2041   if (isDereferenceablePointer(LI.getPointerOperand(), LI.getType(), DL))
2042     Flags |= MachineMemOperand::MODereferenceable;
2043 
2044   Flags |= getTargetMMOFlags(LI);
2045   return Flags;
2046 }
2047 
2048 MachineMemOperand::Flags
2049 TargetLoweringBase::getStoreMemOperandFlags(const StoreInst &SI,
2050                                             const DataLayout &DL) const {
2051   MachineMemOperand::Flags Flags = MachineMemOperand::MOStore;
2052 
2053   if (SI.isVolatile())
2054     Flags |= MachineMemOperand::MOVolatile;
2055 
2056   if (SI.hasMetadata(LLVMContext::MD_nontemporal))
2057     Flags |= MachineMemOperand::MONonTemporal;
2058 
2059   // FIXME: Not preserving dereferenceable
2060   Flags |= getTargetMMOFlags(SI);
2061   return Flags;
2062 }
2063 
2064 MachineMemOperand::Flags
2065 TargetLoweringBase::getAtomicMemOperandFlags(const Instruction &AI,
2066                                              const DataLayout &DL) const {
2067   auto Flags = MachineMemOperand::MOLoad | MachineMemOperand::MOStore;
2068 
2069   if (const AtomicRMWInst *RMW = dyn_cast<AtomicRMWInst>(&AI)) {
2070     if (RMW->isVolatile())
2071       Flags |= MachineMemOperand::MOVolatile;
2072   } else if (const AtomicCmpXchgInst *CmpX = dyn_cast<AtomicCmpXchgInst>(&AI)) {
2073     if (CmpX->isVolatile())
2074       Flags |= MachineMemOperand::MOVolatile;
2075   } else
2076     llvm_unreachable("not an atomic instruction");
2077 
2078   // FIXME: Not preserving dereferenceable
2079   Flags |= getTargetMMOFlags(AI);
2080   return Flags;
2081 }
2082 
2083 //===----------------------------------------------------------------------===//
2084 //  GlobalISel Hooks
2085 //===----------------------------------------------------------------------===//
2086 
2087 bool TargetLoweringBase::shouldLocalize(const MachineInstr &MI,
2088                                         const TargetTransformInfo *TTI) const {
2089   auto &MF = *MI.getMF();
2090   auto &MRI = MF.getRegInfo();
2091   // Assuming a spill and reload of a value has a cost of 1 instruction each,
2092   // this helper function computes the maximum number of uses we should consider
2093   // for remat. E.g. on arm64 global addresses take 2 insts to materialize. We
2094   // break even in terms of code size when the original MI has 2 users vs
2095   // choosing to potentially spill. Any more than 2 users we we have a net code
2096   // size increase. This doesn't take into account register pressure though.
2097   auto maxUses = [](unsigned RematCost) {
2098     // A cost of 1 means remats are basically free.
2099     if (RematCost == 1)
2100       return UINT_MAX;
2101     if (RematCost == 2)
2102       return 2U;
2103 
2104     // Remat is too expensive, only sink if there's one user.
2105     if (RematCost > 2)
2106       return 1U;
2107     llvm_unreachable("Unexpected remat cost");
2108   };
2109 
2110   // Helper to walk through uses and terminate if we've reached a limit. Saves
2111   // us spending time traversing uses if all we want to know is if it's >= min.
2112   auto isUsesAtMost = [&](unsigned Reg, unsigned MaxUses) {
2113     unsigned NumUses = 0;
2114     auto UI = MRI.use_instr_nodbg_begin(Reg), UE = MRI.use_instr_nodbg_end();
2115     for (; UI != UE && NumUses < MaxUses; ++UI) {
2116       NumUses++;
2117     }
2118     // If we haven't reached the end yet then there are more than MaxUses users.
2119     return UI == UE;
2120   };
2121 
2122   switch (MI.getOpcode()) {
2123   default:
2124     return false;
2125   // Constants-like instructions should be close to their users.
2126   // We don't want long live-ranges for them.
2127   case TargetOpcode::G_CONSTANT:
2128   case TargetOpcode::G_FCONSTANT:
2129   case TargetOpcode::G_FRAME_INDEX:
2130   case TargetOpcode::G_INTTOPTR:
2131     return true;
2132   case TargetOpcode::G_GLOBAL_VALUE: {
2133     unsigned RematCost = TTI->getGISelRematGlobalCost();
2134     Register Reg = MI.getOperand(0).getReg();
2135     unsigned MaxUses = maxUses(RematCost);
2136     if (MaxUses == UINT_MAX)
2137       return true; // Remats are "free" so always localize.
2138     bool B = isUsesAtMost(Reg, MaxUses);
2139     return B;
2140   }
2141   }
2142 }
2143