aboutsummaryrefslogtreecommitdiff
path: root/kernel/kapi/interrupts.tests.cpp
blob: e87c6a00c161597538761d248ddc548be5ec1fb2 (plain)
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
#include <kapi/interrupts.hpp>

#include <kapi/tracked_mutex.hpp>

#include <kstd/mutex.hpp>

#include <catch2/catch_test_macros.hpp>

SCENARIO("irq_lock semantics", "[kapi][interrupts]")
{
  GIVEN("a simple irq_lock")
  {
    auto lock = kapi::interrupts::irq_lock{};

    AND_GIVEN("IRQs are currently disabled")
    {
      kapi::interrupts::enabled(false);
      REQUIRE_FALSE(kapi::interrupts::enabled());

      WHEN("locking the irq_lock")
      {
        lock.lock();

        THEN("IRQs are still disabled")
        {
          REQUIRE_FALSE(kapi::interrupts::enabled());

          AND_WHEN("unlocking the irq_lock")
          {
            lock.unlock();

            THEN("IRQs are still disabled")
            {
              REQUIRE_FALSE(kapi::interrupts::enabled());
            }
          }
        }

        THEN("the irq_lock is locked")
        {
          REQUIRE_FALSE(lock.try_lock());
          lock.unlock();
        }
      }

      THEN("the irq_lock can be locked")
      {
        REQUIRE(lock.try_lock());
        lock.unlock();
      }
    }

    AND_GIVEN("IRQs are currently enabled")
    {
      kapi::interrupts::enabled(true);
      REQUIRE(kapi::interrupts::enabled());

      WHEN("locking the irq_lock")
      {
        lock.lock();

        THEN("IRQs are disabled")
        {
          REQUIRE_FALSE(kapi::interrupts::enabled());

          AND_WHEN("unlocking the irq_lock")
          {
            lock.unlock();

            THEN("IRQs are enabled again")
            {
              REQUIRE(kapi::interrupts::enabled());
            }
          }
        }
      }
    }
  }

  GIVEN("a wrapping irq_lock")
  {
    auto mutex = kapi::tracked_mutex{};
    auto lock = kapi::interrupts::irq_lock{mutex};

    AND_GIVEN("IRQs are currently disabled")
    {
      kapi::interrupts::enabled(false);
      REQUIRE_FALSE(kapi::interrupts::enabled());

      WHEN("locking the irq_lock")
      {
        lock.lock();

        THEN("IRQs are still disabled")
        {
          REQUIRE_FALSE(kapi::interrupts::enabled());

          AND_WHEN("unlocking the irq_lock")
          {
            lock.unlock();

            THEN("IRQs are still disabled")
            {
              REQUIRE_FALSE(kapi::interrupts::enabled());
            }

            THEN("the inner mutex is unlocked")
            {
              REQUIRE(mutex.try_lock());
              mutex.unlock();
            }
          }
        }

        THEN("the irq_lock is locked")
        {
          REQUIRE_FALSE(lock.try_lock());
          lock.unlock();
        }

        THEN("the inner mutex is locked")
        {
          REQUIRE_FALSE(mutex.try_lock());
          lock.unlock();
        }
      }

      THEN("the irq_lock can be locked")
      {
        REQUIRE(lock.try_lock());
        lock.unlock();
      }
    }

    AND_GIVEN("IRQs are currently enabled")
    {
      kapi::interrupts::enabled(true);
      REQUIRE(kapi::interrupts::enabled());

      WHEN("locking the irq_lock")
      {
        lock.lock();

        THEN("IRQs are disabled")
        {
          REQUIRE_FALSE(kapi::interrupts::enabled());

          AND_WHEN("unlocking the irq_lock")
          {
            lock.unlock();

            THEN("IRQs are enabled again")
            {
              REQUIRE(kapi::interrupts::enabled());
            }

            THEN("the inner mutex is unlocked")
            {
              REQUIRE(mutex.try_lock());
              mutex.unlock();
            }
          }
        }

        THEN("the irq_lock is locked")
        {
          REQUIRE_FALSE(lock.try_lock());
          lock.unlock();
        }

        THEN("the inner mutex is locked")
        {
          REQUIRE_FALSE(mutex.try_lock());
          lock.unlock();
        }
      }
    }

    AND_GIVEN("the inner mutex is already locked")
    {
      auto guard = kstd::lock_guard{mutex};

      THEN("the irq_lock cannot be locked")
      {
        REQUIRE_FALSE(lock.try_lock());
      }
    }
  }
}