aboutsummaryrefslogtreecommitdiffstats
path: root/library/cpp/coroutine/engine/stack/ut/stack_guards_ut.cpp
blob: 418ec56096b8001b1787e8134277f0b62119d247 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
#include <library/cpp/coroutine/engine/stack/stack_common.h>
#include <library/cpp/coroutine/engine/stack/stack_guards.h>
#include <library/cpp/coroutine/engine/stack/stack_utils.h>
#include <library/cpp/testing/gtest/gtest.h>


using namespace testing;

namespace NCoro::NStack::Tests {

    template <class TGuard>
    class TGuardFixture : public Test {
    protected:
        TGuardFixture() : Guard_(GetGuard<TGuard>()) {}

        const TGuard& Guard_;
    };

    typedef Types<TCanaryGuard, TPageGuard> Implementations;
    TYPED_TEST_SUITE(TGuardFixture, Implementations);

    TYPED_TEST(TGuardFixture, GuardSize) {
        const auto size = this->Guard_.GetSize();
        EXPECT_GE(size, 64ul);
        EXPECT_FALSE(size & 63ul); // check 64-byte alignment
    }

    TYPED_TEST(TGuardFixture, GuardAlignedSize) {
        const auto size = this->Guard_.GetPageAlignedSize();
        EXPECT_GE(size, PageSize);
        EXPECT_FALSE(size & PageSizeMask); // check page-alignment
    }

    TYPED_TEST(TGuardFixture, StackWorkspace) {
        for (size_t sizeInPages : {2, 5, 12}) {
            char *rawPtr, *alignedPtr = nullptr;
            ASSERT_TRUE(GetAlignedMemory(sizeInPages, rawPtr, alignedPtr));
            auto workspace = this->Guard_.GetWorkspace(alignedPtr, sizeInPages * PageSize);
            EXPECT_EQ(workspace.size(), sizeInPages * PageSize - this->Guard_.GetSize()) << " size in pages " << sizeInPages;

            this->Guard_.Protect(alignedPtr, sizeInPages * PageSize, false);
            workspace = this->Guard_.GetWorkspace(alignedPtr, sizeInPages * PageSize);
            EXPECT_EQ(workspace.size(), sizeInPages * PageSize - this->Guard_.GetSize()) << " size in pages " << sizeInPages;

            this->Guard_.RemoveProtection(alignedPtr, sizeInPages * PageSize);
            workspace = this->Guard_.GetWorkspace(alignedPtr, sizeInPages * PageSize);
            EXPECT_EQ(workspace.size(), sizeInPages * PageSize - this->Guard_.GetSize()) << " size in pages " << sizeInPages;

            free(rawPtr);
        }
    }

    TYPED_TEST(TGuardFixture, SetRemoveProtectionWorks) {
        char *rawPtr, *alignedPtr = nullptr;
        constexpr size_t sizeInPages = 4;
        ASSERT_TRUE(GetAlignedMemory(sizeInPages + 1, rawPtr, alignedPtr));

        this->Guard_.Protect(alignedPtr, PageSize, false); // set previous guard
        alignedPtr += PageSize; // leave first page for previous guard
        this->Guard_.Protect(alignedPtr, sizeInPages * PageSize, true);

        EXPECT_TRUE(this->Guard_.CheckOverflow(alignedPtr));
        EXPECT_TRUE(this->Guard_.CheckOverride(alignedPtr, sizeInPages * PageSize));

        this->Guard_.RemoveProtection(alignedPtr, sizeInPages * PageSize);
        this->Guard_.RemoveProtection(alignedPtr - PageSize, PageSize); // remove previous guard

        free(rawPtr);
    }

    TEST(StackGuardTest, CanaryGuardTestOverflow) {
        const auto& guard = GetGuard<TCanaryGuard>();

        char *rawPtr, *alignedPtr = nullptr;
        constexpr size_t sizeInPages = 4;
        ASSERT_TRUE(GetAlignedMemory(sizeInPages + 1, rawPtr, alignedPtr));
        guard.Protect(alignedPtr, PageSize, false); // set previous guard
        alignedPtr += PageSize; // leave first page for previous guard
        guard.Protect(alignedPtr, sizeInPages * PageSize, true);

        EXPECT_TRUE(guard.CheckOverflow(alignedPtr));
        EXPECT_TRUE(guard.CheckOverride(alignedPtr, sizeInPages * PageSize));

        // Overwrite previous guard
        *(alignedPtr - 1) = 42;

        EXPECT_FALSE(guard.CheckOverflow(alignedPtr));

        free(rawPtr);
    }

    TEST(StackGuardTest, CanaryGuardTestOverride) {
        const auto& guard = GetGuard<TCanaryGuard>();

        char *rawPtr, *alignedPtr = nullptr;
        constexpr size_t sizeInPages = 4;
        ASSERT_TRUE(GetAlignedMemory(sizeInPages + 1, rawPtr, alignedPtr));
        guard.Protect(alignedPtr, PageSize, false); // set previous guard
        alignedPtr += PageSize; // leave first page for previous guard
        guard.Protect(alignedPtr, sizeInPages * PageSize, true);

        EXPECT_TRUE(guard.CheckOverflow(alignedPtr));
        EXPECT_TRUE(guard.CheckOverride(alignedPtr, sizeInPages * PageSize));

        // Overwrite guard
        *(alignedPtr + sizeInPages * PageSize - 1) = 42;

        EXPECT_FALSE(guard.CheckOverride(alignedPtr, sizeInPages * PageSize));

        free(rawPtr);
    }

    TEST(StackGuardDeathTest, PageGuardTestOverflow) {
        ASSERT_DEATH({
            const auto &guard = GetGuard<TPageGuard>();

            char* rawPtr = nullptr;
            char* alignedPtr = nullptr;
            constexpr size_t sizeInPages = 4;
            ASSERT_TRUE(GetAlignedMemory(sizeInPages + 1, rawPtr, alignedPtr));

            guard.Protect(alignedPtr, PageSize, false); // set previous guard
            alignedPtr += PageSize; // leave first page for previous guard
            guard.Protect(alignedPtr, sizeInPages * PageSize, true);

            // Overwrite previous guard, crash is here
            *(alignedPtr - 1) = 42;

            guard.RemoveProtection(alignedPtr, sizeInPages * PageSize);
            guard.RemoveProtection(alignedPtr - PageSize, PageSize); // remove previous guard

            free(rawPtr);
        }, "");
    }

    TEST(StackGuardDeathTest, PageGuardTestOverride) {
        ASSERT_DEATH({
            const auto &guard = GetGuard<TPageGuard>();

            char* rawPtr = nullptr;
            char* alignedPtr = nullptr;
            constexpr size_t sizeInPages = 4;
            ASSERT_TRUE(GetAlignedMemory(sizeInPages + 1, rawPtr, alignedPtr));
            guard.Protect(alignedPtr, PageSize, false); // set previous guard
            alignedPtr += PageSize; // leave first page for previous guard
            guard.Protect(alignedPtr, sizeInPages * PageSize, true);

            // Overwrite guard, crash is here
            *(alignedPtr + sizeInPages * PageSize - 1) = 42;

            guard.RemoveProtection(alignedPtr, sizeInPages * PageSize);
            guard.RemoveProtection(alignedPtr - PageSize, PageSize); // remove previous guard

            free(rawPtr);
        }, "");
    }

}