xref: /llvm-project/llvm/unittests/Transforms/Utils/ASanStackFrameLayoutTest.cpp (revision db331d8be7f85cd976d4f63176cccd7d30aceacf)
1 //===- ASanStackFrameLayoutTest.cpp - Tests for ComputeASanStackFrameLayout===//
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 #include "llvm/Transforms/Utils/ASanStackFrameLayout.h"
10 #include "llvm/ADT/ArrayRef.h"
11 #include "gtest/gtest.h"
12 #include <sstream>
13 
14 using namespace llvm;
15 
16 static std::string
17 ShadowBytesToString(ArrayRef<uint8_t> ShadowBytes) {
18   std::ostringstream os;
19   for (size_t i = 0, n = ShadowBytes.size(); i < n; i++) {
20     switch (ShadowBytes[i]) {
21       case kAsanStackLeftRedzoneMagic:    os << "L"; break;
22       case kAsanStackRightRedzoneMagic:   os << "R"; break;
23       case kAsanStackMidRedzoneMagic:     os << "M"; break;
24       case kAsanStackUseAfterScopeMagic:
25         os << "S";
26         break;
27       default:                            os << (unsigned)ShadowBytes[i];
28     }
29   }
30   return os.str();
31 }
32 
33 // Use macro to preserve line information in EXPECT_EQ output.
34 #define TEST_LAYOUT(V, Granularity, MinHeaderSize, ExpectedDescr,              \
35                     ExpectedShadow, ExpectedShadowAfterScope)                  \
36   {                                                                            \
37     SmallVector<ASanStackVariableDescription, 10> Vars = V;                    \
38     ASanStackFrameLayout L =                                                   \
39         ComputeASanStackFrameLayout(Vars, Granularity, MinHeaderSize);         \
40     EXPECT_EQ(ExpectedDescr, L.DescriptionString);                             \
41     EXPECT_EQ(ExpectedShadow, ShadowBytesToString(GetShadowBytes(Vars, L)));   \
42     EXPECT_EQ(ExpectedShadowAfterScope,                                        \
43               ShadowBytesToString(GetShadowBytesAfterScope(Vars, L)));         \
44   }
45 
46 TEST(ASanStackFrameLayout, Test) {
47 #define VAR(name, size, lifetime, alignment)                                   \
48   ASanStackVariableDescription name##size##_##alignment = {                    \
49     #name #size "_" #alignment,                                                \
50     size,                                                                      \
51     lifetime,                                                                  \
52     alignment,                                                                 \
53     0,                                                                         \
54     0                                                                          \
55   }
56 
57   VAR(a, 1, 0, 1);
58   VAR(p, 1, 0, 32);
59   VAR(p, 1, 0, 256);
60   VAR(a, 2, 0, 1);
61   VAR(a, 3, 0, 1);
62   VAR(a, 4, 0, 1);
63   VAR(a, 7, 0, 1);
64   VAR(a, 8, 8, 1);
65   VAR(a, 9, 0, 1);
66   VAR(a, 16, 16, 1);
67   VAR(a, 41, 9, 1);
68   VAR(a, 105, 103, 1);
69 
70   TEST_LAYOUT({a1_1}, 8, 16, "1 16 1 4 a1_1", "LL1R", "LL1R");
71   TEST_LAYOUT({a1_1}, 64, 64, "1 64 1 4 a1_1", "L1", "L1");
72   TEST_LAYOUT({p1_32}, 8, 32, "1 32 1 5 p1_32", "LLLL1RRR", "LLLL1RRR");
73   TEST_LAYOUT({p1_32}, 8, 64, "1 64 1 5 p1_32", "LLLLLLLL1RRRRRRR",
74               "LLLLLLLL1RRRRRRR");
75 
76   TEST_LAYOUT({a1_1}, 8, 32, "1 32 1 4 a1_1", "LLLL1RRR", "LLLL1RRR");
77   TEST_LAYOUT({a2_1}, 8, 32, "1 32 2 4 a2_1", "LLLL2RRR", "LLLL2RRR");
78   TEST_LAYOUT({a3_1}, 8, 32, "1 32 3 4 a3_1", "LLLL3RRR", "LLLL3RRR");
79   TEST_LAYOUT({a4_1}, 8, 32, "1 32 4 4 a4_1", "LLLL4RRR", "LLLL4RRR");
80   TEST_LAYOUT({a7_1}, 8, 32, "1 32 7 4 a7_1", "LLLL7RRR", "LLLL7RRR");
81   TEST_LAYOUT({a8_1}, 8, 32, "1 32 8 4 a8_1", "LLLL0RRR", "LLLLSRRR");
82   TEST_LAYOUT({a9_1}, 8, 32, "1 32 9 4 a9_1", "LLLL01RR", "LLLL01RR");
83   TEST_LAYOUT({a16_1}, 8, 32, "1 32 16 5 a16_1", "LLLL00RR", "LLLLSSRR");
84   TEST_LAYOUT({p1_256}, 8, 32, "1 256 1 6 p1_256",
85               "LLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLL1RRR",
86               "LLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLL1RRR");
87   TEST_LAYOUT({a41_1}, 8, 32, "1 32 41 5 a41_1", "LLLL000001RRRRRR",
88               "LLLLSS0001RRRRRR");
89   TEST_LAYOUT({a105_1}, 8, 32, "1 32 105 6 a105_1", "LLLL00000000000001RRRRRR",
90               "LLLLSSSSSSSSSSSSS1RRRRRR");
91 
92   {
93     SmallVector<ASanStackVariableDescription, 10> t = {a1_1, p1_256};
94     TEST_LAYOUT(t, 8, 32, "2 256 1 6 p1_256 272 1 4 a1_1",
95                 "LLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLL1M1R",
96                 "LLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLL1M1R");
97   }
98 
99   {
100     SmallVector<ASanStackVariableDescription, 10> t = {a1_1, a16_1, a41_1};
101     TEST_LAYOUT(t, 8, 32, "3 32 1 4 a1_1 48 16 5 a16_1 80 41 5 a41_1",
102                 "LLLL1M00MM000001RRRR", "LLLL1MSSMMSS0001RRRR");
103   }
104 #undef VAR
105 #undef TEST_LAYOUT
106 }
107