1 //===- llvm/unittest/IR/ConstantsTest.cpp - Constants unit tests ----------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "llvm/AsmParser/Parser.h"
11 #include "llvm/IR/Constants.h"
12 #include "llvm/IR/DerivedTypes.h"
13 #include "llvm/IR/InstrTypes.h"
14 #include "llvm/IR/Instruction.h"
15 #include "llvm/IR/LLVMContext.h"
16 #include "llvm/IR/Module.h"
17 #include "llvm/Support/SourceMgr.h"
18 #include "gtest/gtest.h"
19 
20 namespace llvm {
21 namespace {
22 
TEST(ConstantsTest,Integer_i1)23 TEST(ConstantsTest, Integer_i1) {
24   IntegerType* Int1 = IntegerType::get(getGlobalContext(), 1);
25   Constant* One = ConstantInt::get(Int1, 1, true);
26   Constant* Zero = ConstantInt::get(Int1, 0);
27   Constant* NegOne = ConstantInt::get(Int1, static_cast<uint64_t>(-1), true);
28   EXPECT_EQ(NegOne, ConstantInt::getSigned(Int1, -1));
29   Constant* Undef = UndefValue::get(Int1);
30 
31   // Input:  @b = constant i1 add(i1 1 , i1 1)
32   // Output: @b = constant i1 false
33   EXPECT_EQ(Zero, ConstantExpr::getAdd(One, One));
34 
35   // @c = constant i1 add(i1 -1, i1 1)
36   // @c = constant i1 false
37   EXPECT_EQ(Zero, ConstantExpr::getAdd(NegOne, One));
38 
39   // @d = constant i1 add(i1 -1, i1 -1)
40   // @d = constant i1 false
41   EXPECT_EQ(Zero, ConstantExpr::getAdd(NegOne, NegOne));
42 
43   // @e = constant i1 sub(i1 -1, i1 1)
44   // @e = constant i1 false
45   EXPECT_EQ(Zero, ConstantExpr::getSub(NegOne, One));
46 
47   // @f = constant i1 sub(i1 1 , i1 -1)
48   // @f = constant i1 false
49   EXPECT_EQ(Zero, ConstantExpr::getSub(One, NegOne));
50 
51   // @g = constant i1 sub(i1 1 , i1 1)
52   // @g = constant i1 false
53   EXPECT_EQ(Zero, ConstantExpr::getSub(One, One));
54 
55   // @h = constant i1 shl(i1 1 , i1 1)  ; undefined
56   // @h = constant i1 undef
57   EXPECT_EQ(Undef, ConstantExpr::getShl(One, One));
58 
59   // @i = constant i1 shl(i1 1 , i1 0)
60   // @i = constant i1 true
61   EXPECT_EQ(One, ConstantExpr::getShl(One, Zero));
62 
63   // @j = constant i1 lshr(i1 1, i1 1)  ; undefined
64   // @j = constant i1 undef
65   EXPECT_EQ(Undef, ConstantExpr::getLShr(One, One));
66 
67   // @m = constant i1 ashr(i1 1, i1 1)  ; undefined
68   // @m = constant i1 undef
69   EXPECT_EQ(Undef, ConstantExpr::getAShr(One, One));
70 
71   // @n = constant i1 mul(i1 -1, i1 1)
72   // @n = constant i1 true
73   EXPECT_EQ(One, ConstantExpr::getMul(NegOne, One));
74 
75   // @o = constant i1 sdiv(i1 -1, i1 1) ; overflow
76   // @o = constant i1 true
77   EXPECT_EQ(One, ConstantExpr::getSDiv(NegOne, One));
78 
79   // @p = constant i1 sdiv(i1 1 , i1 -1); overflow
80   // @p = constant i1 true
81   EXPECT_EQ(One, ConstantExpr::getSDiv(One, NegOne));
82 
83   // @q = constant i1 udiv(i1 -1, i1 1)
84   // @q = constant i1 true
85   EXPECT_EQ(One, ConstantExpr::getUDiv(NegOne, One));
86 
87   // @r = constant i1 udiv(i1 1, i1 -1)
88   // @r = constant i1 true
89   EXPECT_EQ(One, ConstantExpr::getUDiv(One, NegOne));
90 
91   // @s = constant i1 srem(i1 -1, i1 1) ; overflow
92   // @s = constant i1 false
93   EXPECT_EQ(Zero, ConstantExpr::getSRem(NegOne, One));
94 
95   // @t = constant i1 urem(i1 -1, i1 1)
96   // @t = constant i1 false
97   EXPECT_EQ(Zero, ConstantExpr::getURem(NegOne, One));
98 
99   // @u = constant i1 srem(i1  1, i1 -1) ; overflow
100   // @u = constant i1 false
101   EXPECT_EQ(Zero, ConstantExpr::getSRem(One, NegOne));
102 }
103 
TEST(ConstantsTest,IntSigns)104 TEST(ConstantsTest, IntSigns) {
105   IntegerType* Int8Ty = Type::getInt8Ty(getGlobalContext());
106   EXPECT_EQ(100, ConstantInt::get(Int8Ty, 100, false)->getSExtValue());
107   EXPECT_EQ(100, ConstantInt::get(Int8Ty, 100, true)->getSExtValue());
108   EXPECT_EQ(100, ConstantInt::getSigned(Int8Ty, 100)->getSExtValue());
109   EXPECT_EQ(-50, ConstantInt::get(Int8Ty, 206)->getSExtValue());
110   EXPECT_EQ(-50, ConstantInt::getSigned(Int8Ty, -50)->getSExtValue());
111   EXPECT_EQ(206U, ConstantInt::getSigned(Int8Ty, -50)->getZExtValue());
112 
113   // Overflow is handled by truncation.
114   EXPECT_EQ(0x3b, ConstantInt::get(Int8Ty, 0x13b)->getSExtValue());
115 }
116 
TEST(ConstantsTest,FP128Test)117 TEST(ConstantsTest, FP128Test) {
118   Type *FP128Ty = Type::getFP128Ty(getGlobalContext());
119 
120   IntegerType *Int128Ty = Type::getIntNTy(getGlobalContext(), 128);
121   Constant *Zero128 = Constant::getNullValue(Int128Ty);
122   Constant *X = ConstantExpr::getUIToFP(Zero128, FP128Ty);
123   EXPECT_TRUE(isa<ConstantFP>(X));
124 }
125 
TEST(ConstantsTest,PointerCast)126 TEST(ConstantsTest, PointerCast) {
127   LLVMContext &C(getGlobalContext());
128   Type *Int8PtrTy = Type::getInt8PtrTy(C);
129   Type *Int32PtrTy = Type::getInt32PtrTy(C);
130   Type *Int64Ty = Type::getInt64Ty(C);
131   VectorType *Int8PtrVecTy = VectorType::get(Int8PtrTy, 4);
132   VectorType *Int32PtrVecTy = VectorType::get(Int32PtrTy, 4);
133   VectorType *Int64VecTy = VectorType::get(Int64Ty, 4);
134 
135   // ptrtoint i8* to i64
136   EXPECT_EQ(Constant::getNullValue(Int64Ty),
137             ConstantExpr::getPointerCast(
138               Constant::getNullValue(Int8PtrTy), Int64Ty));
139 
140   // bitcast i8* to i32*
141   EXPECT_EQ(Constant::getNullValue(Int32PtrTy),
142             ConstantExpr::getPointerCast(
143               Constant::getNullValue(Int8PtrTy), Int32PtrTy));
144 
145   // ptrtoint <4 x i8*> to <4 x i64>
146   EXPECT_EQ(Constant::getNullValue(Int64VecTy),
147             ConstantExpr::getPointerCast(
148               Constant::getNullValue(Int8PtrVecTy), Int64VecTy));
149 
150   // bitcast <4 x i8*> to <4 x i32*>
151   EXPECT_EQ(Constant::getNullValue(Int32PtrVecTy),
152             ConstantExpr::getPointerCast(
153               Constant::getNullValue(Int8PtrVecTy), Int32PtrVecTy));
154 }
155 
156 #define CHECK(x, y) {                                         		\
157     std::string __s;                                            	\
158     raw_string_ostream __o(__s);                                	\
159     Instruction *__I = cast<ConstantExpr>(x)->getAsInstruction();	\
160     __I->print(__o);      						\
161     delete __I; 							\
162     __o.flush();                                                	\
163     EXPECT_EQ(std::string("  <badref> = " y), __s);             	\
164   }
165 
TEST(ConstantsTest,AsInstructionsTest)166 TEST(ConstantsTest, AsInstructionsTest) {
167   std::unique_ptr<Module> M(new Module("MyModule", getGlobalContext()));
168 
169   Type *Int64Ty = Type::getInt64Ty(getGlobalContext());
170   Type *Int32Ty = Type::getInt32Ty(getGlobalContext());
171   Type *Int16Ty = Type::getInt16Ty(getGlobalContext());
172   Type *Int1Ty = Type::getInt1Ty(getGlobalContext());
173   Type *FloatTy = Type::getFloatTy(getGlobalContext());
174   Type *DoubleTy = Type::getDoubleTy(getGlobalContext());
175 
176   Constant *Global = M->getOrInsertGlobal("dummy",
177                                          PointerType::getUnqual(Int32Ty));
178   Constant *Global2 = M->getOrInsertGlobal("dummy2",
179                                          PointerType::getUnqual(Int32Ty));
180 
181   Constant *P0 = ConstantExpr::getPtrToInt(Global, Int32Ty);
182   Constant *P1 = ConstantExpr::getUIToFP(P0, FloatTy);
183   Constant *P2 = ConstantExpr::getUIToFP(P0, DoubleTy);
184   Constant *P3 = ConstantExpr::getTrunc(P0, Int1Ty);
185   Constant *P4 = ConstantExpr::getPtrToInt(Global2, Int32Ty);
186   Constant *P5 = ConstantExpr::getUIToFP(P4, FloatTy);
187   Constant *P6 = ConstantExpr::getBitCast(P4, VectorType::get(Int16Ty, 2));
188 
189   Constant *One = ConstantInt::get(Int32Ty, 1);
190 
191   #define P0STR "ptrtoint (i32** @dummy to i32)"
192   #define P1STR "uitofp (i32 ptrtoint (i32** @dummy to i32) to float)"
193   #define P2STR "uitofp (i32 ptrtoint (i32** @dummy to i32) to double)"
194   #define P3STR "ptrtoint (i32** @dummy to i1)"
195   #define P4STR "ptrtoint (i32** @dummy2 to i32)"
196   #define P5STR "uitofp (i32 ptrtoint (i32** @dummy2 to i32) to float)"
197   #define P6STR "bitcast (i32 ptrtoint (i32** @dummy2 to i32) to <2 x i16>)"
198 
199   CHECK(ConstantExpr::getNeg(P0), "sub i32 0, " P0STR);
200   CHECK(ConstantExpr::getFNeg(P1), "fsub float -0.000000e+00, " P1STR);
201   CHECK(ConstantExpr::getNot(P0), "xor i32 " P0STR ", -1");
202   CHECK(ConstantExpr::getAdd(P0, P0), "add i32 " P0STR ", " P0STR);
203   CHECK(ConstantExpr::getAdd(P0, P0, false, true), "add nsw i32 " P0STR ", "
204         P0STR);
205   CHECK(ConstantExpr::getAdd(P0, P0, true, true), "add nuw nsw i32 " P0STR ", "
206         P0STR);
207   CHECK(ConstantExpr::getFAdd(P1, P1), "fadd float " P1STR ", " P1STR);
208   CHECK(ConstantExpr::getSub(P0, P0), "sub i32 " P0STR ", " P0STR);
209   CHECK(ConstantExpr::getFSub(P1, P1), "fsub float " P1STR ", " P1STR);
210   CHECK(ConstantExpr::getMul(P0, P0), "mul i32 " P0STR ", " P0STR);
211   CHECK(ConstantExpr::getFMul(P1, P1), "fmul float " P1STR ", " P1STR);
212   CHECK(ConstantExpr::getUDiv(P0, P0), "udiv i32 " P0STR ", " P0STR);
213   CHECK(ConstantExpr::getSDiv(P0, P0), "sdiv i32 " P0STR ", " P0STR);
214   CHECK(ConstantExpr::getFDiv(P1, P1), "fdiv float " P1STR ", " P1STR);
215   CHECK(ConstantExpr::getURem(P0, P0), "urem i32 " P0STR ", " P0STR);
216   CHECK(ConstantExpr::getSRem(P0, P0), "srem i32 " P0STR ", " P0STR);
217   CHECK(ConstantExpr::getFRem(P1, P1), "frem float " P1STR ", " P1STR);
218   CHECK(ConstantExpr::getAnd(P0, P0), "and i32 " P0STR ", " P0STR);
219   CHECK(ConstantExpr::getOr(P0, P0), "or i32 " P0STR ", " P0STR);
220   CHECK(ConstantExpr::getXor(P0, P0), "xor i32 " P0STR ", " P0STR);
221   CHECK(ConstantExpr::getShl(P0, P0), "shl i32 " P0STR ", " P0STR);
222   CHECK(ConstantExpr::getShl(P0, P0, true), "shl nuw i32 " P0STR ", " P0STR);
223   CHECK(ConstantExpr::getShl(P0, P0, false, true), "shl nsw i32 " P0STR ", "
224         P0STR);
225   CHECK(ConstantExpr::getLShr(P0, P0, false), "lshr i32 " P0STR ", " P0STR);
226   CHECK(ConstantExpr::getLShr(P0, P0, true), "lshr exact i32 " P0STR ", " P0STR);
227   CHECK(ConstantExpr::getAShr(P0, P0, false), "ashr i32 " P0STR ", " P0STR);
228   CHECK(ConstantExpr::getAShr(P0, P0, true), "ashr exact i32 " P0STR ", " P0STR);
229 
230   CHECK(ConstantExpr::getSExt(P0, Int64Ty), "sext i32 " P0STR " to i64");
231   CHECK(ConstantExpr::getZExt(P0, Int64Ty), "zext i32 " P0STR " to i64");
232   CHECK(ConstantExpr::getFPTrunc(P2, FloatTy), "fptrunc double " P2STR
233         " to float");
234   CHECK(ConstantExpr::getFPExtend(P1, DoubleTy), "fpext float " P1STR
235         " to double");
236 
237   CHECK(ConstantExpr::getExactUDiv(P0, P0), "udiv exact i32 " P0STR ", " P0STR);
238 
239   CHECK(ConstantExpr::getSelect(P3, P0, P4), "select i1 " P3STR ", i32 " P0STR
240         ", i32 " P4STR);
241   CHECK(ConstantExpr::getICmp(CmpInst::ICMP_EQ, P0, P4), "icmp eq i32 " P0STR
242         ", " P4STR);
243   CHECK(ConstantExpr::getFCmp(CmpInst::FCMP_ULT, P1, P5), "fcmp ult float "
244         P1STR ", " P5STR);
245 
246   std::vector<Constant*> V;
247   V.push_back(One);
248   // FIXME: getGetElementPtr() actually creates an inbounds ConstantGEP,
249   //        not a normal one!
250   //CHECK(ConstantExpr::getGetElementPtr(Global, V, false),
251   //      "getelementptr i32*, i32** @dummy, i32 1");
252   CHECK(ConstantExpr::getInBoundsGetElementPtr(PointerType::getUnqual(Int32Ty),
253                                                Global, V),
254         "getelementptr inbounds i32*, i32** @dummy, i32 1");
255 
256   CHECK(ConstantExpr::getExtractElement(P6, One), "extractelement <2 x i16> "
257         P6STR ", i32 1");
258 }
259 
260 #ifdef GTEST_HAS_DEATH_TEST
261 #ifndef NDEBUG
TEST(ConstantsTest,ReplaceWithConstantTest)262 TEST(ConstantsTest, ReplaceWithConstantTest) {
263   std::unique_ptr<Module> M(new Module("MyModule", getGlobalContext()));
264 
265   Type *Int32Ty = Type::getInt32Ty(getGlobalContext());
266   Constant *One = ConstantInt::get(Int32Ty, 1);
267 
268   Constant *Global =
269       M->getOrInsertGlobal("dummy", PointerType::getUnqual(Int32Ty));
270   Constant *GEP = ConstantExpr::getGetElementPtr(
271       PointerType::getUnqual(Int32Ty), Global, One);
272   EXPECT_DEATH(Global->replaceAllUsesWith(GEP),
273                "this->replaceAllUsesWith\\(expr\\(this\\)\\) is NOT valid!");
274 }
275 
276 #endif
277 #endif
278 
279 #undef CHECK
280 
TEST(ConstantsTest,ConstantArrayReplaceWithConstant)281 TEST(ConstantsTest, ConstantArrayReplaceWithConstant) {
282   LLVMContext Context;
283   std::unique_ptr<Module> M(new Module("MyModule", Context));
284 
285   Type *IntTy = Type::getInt8Ty(Context);
286   ArrayType *ArrayTy = ArrayType::get(IntTy, 2);
287   Constant *A01Vals[2] = {ConstantInt::get(IntTy, 0),
288                           ConstantInt::get(IntTy, 1)};
289   Constant *A01 = ConstantArray::get(ArrayTy, A01Vals);
290 
291   Constant *Global = new GlobalVariable(*M, IntTy, false,
292                                         GlobalValue::ExternalLinkage, nullptr);
293   Constant *GlobalInt = ConstantExpr::getPtrToInt(Global, IntTy);
294   Constant *A0GVals[2] = {ConstantInt::get(IntTy, 0), GlobalInt};
295   Constant *A0G = ConstantArray::get(ArrayTy, A0GVals);
296   ASSERT_NE(A01, A0G);
297 
298   GlobalVariable *RefArray =
299       new GlobalVariable(*M, ArrayTy, false, GlobalValue::ExternalLinkage, A0G);
300   ASSERT_EQ(A0G, RefArray->getInitializer());
301 
302   GlobalInt->replaceAllUsesWith(ConstantInt::get(IntTy, 1));
303   ASSERT_EQ(A01, RefArray->getInitializer());
304 }
305 
TEST(ConstantsTest,ConstantExprReplaceWithConstant)306 TEST(ConstantsTest, ConstantExprReplaceWithConstant) {
307   LLVMContext Context;
308   std::unique_ptr<Module> M(new Module("MyModule", Context));
309 
310   Type *IntTy = Type::getInt8Ty(Context);
311   Constant *G1 = new GlobalVariable(*M, IntTy, false,
312                                     GlobalValue::ExternalLinkage, nullptr);
313   Constant *G2 = new GlobalVariable(*M, IntTy, false,
314                                     GlobalValue::ExternalLinkage, nullptr);
315   ASSERT_NE(G1, G2);
316 
317   Constant *Int1 = ConstantExpr::getPtrToInt(G1, IntTy);
318   Constant *Int2 = ConstantExpr::getPtrToInt(G2, IntTy);
319   ASSERT_NE(Int1, Int2);
320 
321   GlobalVariable *Ref =
322       new GlobalVariable(*M, IntTy, false, GlobalValue::ExternalLinkage, Int1);
323   ASSERT_EQ(Int1, Ref->getInitializer());
324 
325   G1->replaceAllUsesWith(G2);
326   ASSERT_EQ(Int2, Ref->getInitializer());
327 }
328 
TEST(ConstantsTest,GEPReplaceWithConstant)329 TEST(ConstantsTest, GEPReplaceWithConstant) {
330   LLVMContext Context;
331   std::unique_ptr<Module> M(new Module("MyModule", Context));
332 
333   Type *IntTy = Type::getInt32Ty(Context);
334   Type *PtrTy = PointerType::get(IntTy, 0);
335   auto *C1 = ConstantInt::get(IntTy, 1);
336   auto *Placeholder = new GlobalVariable(
337       *M, IntTy, false, GlobalValue::ExternalWeakLinkage, nullptr);
338   auto *GEP = ConstantExpr::getGetElementPtr(IntTy, Placeholder, C1);
339   ASSERT_EQ(GEP->getOperand(0), Placeholder);
340 
341   auto *Ref =
342       new GlobalVariable(*M, PtrTy, false, GlobalValue::ExternalLinkage, GEP);
343   ASSERT_EQ(GEP, Ref->getInitializer());
344 
345   auto *Global = new GlobalVariable(*M, PtrTy, false,
346                                     GlobalValue::ExternalLinkage, nullptr);
347   auto *Alias = GlobalAlias::create(IntTy, 0, GlobalValue::ExternalLinkage,
348                                     "alias", Global, M.get());
349   Placeholder->replaceAllUsesWith(Alias);
350   ASSERT_EQ(GEP, Ref->getInitializer());
351   ASSERT_EQ(GEP->getOperand(0), Alias);
352 }
353 
TEST(ConstantsTest,AliasCAPI)354 TEST(ConstantsTest, AliasCAPI) {
355   LLVMContext Context;
356   SMDiagnostic Error;
357   std::unique_ptr<Module> M =
358       parseAssemblyString("@g = global i32 42", Error, Context);
359   GlobalVariable *G = M->getGlobalVariable("g");
360   Type *I16Ty = Type::getInt16Ty(Context);
361   Type *I16PTy = PointerType::get(I16Ty, 0);
362   Constant *Aliasee = ConstantExpr::getBitCast(G, I16PTy);
363   LLVMValueRef AliasRef =
364       LLVMAddAlias(wrap(M.get()), wrap(I16PTy), wrap(Aliasee), "a");
365   ASSERT_EQ(unwrap<GlobalAlias>(AliasRef)->getAliasee(), Aliasee);
366 }
367 
368 }  // end anonymous namespace
369 }  // end namespace llvm
370