xref: /llvm-project/llvm/unittests/Transforms/Utils/ASanStackFrameLayoutTest.cpp (revision f9fd63ad39936968e5b81a5ad5d269ffa761604c)
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 static void TestLayout(SmallVector<ASanStackVariableDescription, 10> Vars,
34                        size_t Granularity, size_t MinHeaderSize,
35                        const std::string &ExpectedDescr,
36                        const std::string &ExpectedShadow) {
37   ASanStackFrameLayout L;
38   ComputeASanStackFrameLayout(Vars, Granularity, MinHeaderSize, &L);
39   EXPECT_EQ(ExpectedDescr, L.DescriptionString);
40   EXPECT_EQ(ExpectedShadow, ShadowBytesToString(L.ShadowBytes));
41 }
42 
43 TEST(ASanStackFrameLayout, Test) {
44 #define VEC1(a) SmallVector<ASanStackVariableDescription, 10>(1, a)
45 #define VEC(a)                                                                 \
46   SmallVector<ASanStackVariableDescription, 10>(a, a + sizeof(a) / sizeof(a[0]))
47 
48 #define VAR(name, size, lifetime, alignment)                                   \
49   ASanStackVariableDescription name##size##_##alignment = {                    \
50     #name #size "_" #alignment,                                                \
51     size,                                                                      \
52     lifetime,                                                                  \
53     alignment,                                                                 \
54     0,                                                                         \
55     0                                                                          \
56   }
57 
58   VAR(a, 1, 0, 1);
59   VAR(p, 1, 0, 32);
60   VAR(p, 1, 0, 256);
61   VAR(a, 2, 0, 1);
62   VAR(a, 3, 0, 1);
63   VAR(a, 4, 0, 1);
64   VAR(a, 7, 0, 1);
65   VAR(a, 8, 8, 1);
66   VAR(a, 9, 0, 1);
67   VAR(a, 16, 0, 1);
68   VAR(a, 41, 9, 1);
69   VAR(a, 105, 103, 1);
70 
71   TestLayout(VEC1(a1_1), 8, 16, "1 16 1 4 a1_1", "LL1R");
72   TestLayout(VEC1(a1_1), 64, 64, "1 64 1 4 a1_1", "L1");
73   TestLayout(VEC1(p1_32), 8, 32, "1 32 1 5 p1_32", "LLLL1RRR");
74   TestLayout(VEC1(p1_32), 8, 64, "1 64 1 5 p1_32", "LLLLLLLL1RRRRRRR");
75 
76   TestLayout(VEC1(a1_1), 8, 32, "1 32 1 4 a1_1", "LLLL1RRR");
77   TestLayout(VEC1(a2_1), 8, 32, "1 32 2 4 a2_1", "LLLL2RRR");
78   TestLayout(VEC1(a3_1), 8, 32, "1 32 3 4 a3_1", "LLLL3RRR");
79   TestLayout(VEC1(a4_1), 8, 32, "1 32 4 4 a4_1", "LLLL4RRR");
80   TestLayout(VEC1(a7_1), 8, 32, "1 32 7 4 a7_1", "LLLL7RRR");
81   TestLayout(VEC1(a8_1), 8, 32, "1 32 8 4 a8_1", "LLLLSRRR");
82   TestLayout(VEC1(a9_1), 8, 32, "1 32 9 4 a9_1", "LLLL01RR");
83   TestLayout(VEC1(a16_1), 8, 32, "1 32 16 5 a16_1", "LLLL00RR");
84   TestLayout(VEC1(p1_256), 8, 32, "1 256 1 6 p1_256",
85              "LLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLL1RRR");
86   TestLayout(VEC1(a41_1), 8, 32, "1 32 41 5 a41_1", "LLLLSS0001RRRRRR");
87   TestLayout(VEC1(a105_1), 8, 32, "1 32 105 6 a105_1",
88              "LLLLSSSSSSSSSSSSS1RRRRRR");
89 
90   {
91     ASanStackVariableDescription t[] = {a1_1, p1_256};
92     TestLayout(VEC(t), 8, 32, "2 256 1 6 p1_256 272 1 4 a1_1",
93                "LLLLLLLLLLLLLLLLLLLLLLLLLLLLLLLL1M1R");
94   }
95 
96   {
97     ASanStackVariableDescription t[] = {a1_1, a16_1, a41_1};
98     TestLayout(VEC(t), 8, 32, "3 32 1 4 a1_1 48 16 5 a16_1 80 41 5 a41_1",
99                "LLLL1M00MMSS0001RRRR");
100   }
101 #undef VEC1
102 #undef VEC
103 #undef VAR
104 }
105