File: stop_requested.pass.cpp

package info (click to toggle)
llvm-toolchain-19 1%3A19.1.7-3~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 1,998,492 kB
  • sloc: cpp: 6,951,680; ansic: 1,486,157; asm: 913,598; python: 232,024; f90: 80,126; objc: 75,281; lisp: 37,276; pascal: 16,990; sh: 10,009; ml: 5,058; perl: 4,724; awk: 3,523; makefile: 3,167; javascript: 2,504; xml: 892; fortran: 664; cs: 573
file content (156 lines) | stat: -rw-r--r-- 3,756 bytes parent folder | download | duplicates (7)
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
//===----------------------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// UNSUPPORTED: no-threads
// UNSUPPORTED: libcpp-has-no-experimental-stop_token
// UNSUPPORTED: c++03, c++11, c++14, c++17
// XFAIL: availability-synchronization_library-missing

// [[nodiscard]] bool stop_requested() const noexcept;
// Returns: true if *this has ownership of a stop state that has received a stop request; otherwise, false.

#include <cassert>
#include <chrono>
#include <concepts>
#include <optional>
#include <stop_token>
#include <type_traits>

#include "make_test_thread.h"
#include "test_macros.h"

template <class T>
concept IsStopRequestedNoexcept = requires(const T& t) {
  { t.stop_requested() } noexcept;
};

static_assert(IsStopRequestedNoexcept<std::stop_token>);

int main(int, char**) {
  // no state
  {
    const std::stop_token st;
    assert(!st.stop_requested());
  }

  // has state
  {
    std::stop_source ss;
    const auto st = ss.get_token();
    assert(!st.stop_requested());

    ss.request_stop();
    assert(st.stop_requested());
  }

  // already requested before constructor
  {
    std::stop_source ss;
    ss.request_stop();
    const auto st = ss.get_token();
    assert(st.stop_requested());
  }

  // stop_token should share the state
  {
    std::optional<std::stop_source> ss{std::in_place};
    ss->request_stop();
    const auto st = ss->get_token();

    ss.reset();
    assert(st.stop_requested());
  }

  // single stop_source, multiple stop_token
  {
    std::stop_source ss;
    const auto st1 = ss.get_token();
    const auto st2 = ss.get_token();
    assert(!st1.stop_requested());
    assert(!st2.stop_requested());

    ss.request_stop();
    assert(st1.stop_requested());
    assert(st2.stop_requested());
  }

  // multiple stop_source, multiple stop_token
  {
    std::stop_source ss1;
    std::stop_source ss2;

    const auto st1 = ss1.get_token();
    const auto st2 = ss2.get_token();
    assert(!st1.stop_requested());
    assert(!st2.stop_requested());

    ss1.request_stop();
    assert(st1.stop_requested());
    assert(!st2.stop_requested());
  }

  // multiple threads
  {
    std::stop_source ss;
    const auto st = ss.get_token();
    assert(!st.stop_requested());

    std::thread t = support::make_test_thread([&]() { ss.request_stop(); });

    t.join();
    assert(st.stop_requested());
  }

  // maybe concurrent calls
  {
    std::stop_source ss;
    const auto st = ss.get_token();
    assert(!st.stop_requested());

    std::thread t = support::make_test_thread([&]() { ss.request_stop(); });

    while (!st.stop_requested()) {
      // should eventually exit the loop
      std::this_thread::yield();
    }

    t.join();
  }

  // [thread.stoptoken.intro] A call to request_stop that returns true
  // synchronizes with a call to stop_requested on an associated stop_token
  // or stop_source object that returns true.
  {
    std::stop_source ss;
    const auto st = ss.get_token();
    assert(!st.stop_requested());

    bool flag = false;

    std::thread t = support::make_test_thread([&]() {
      using namespace std::chrono_literals;
      std::this_thread::sleep_for(1ms);

      // happens-before request_stop
      flag   = true;
      auto b = ss.request_stop();
      assert(b);
    });

    while (!st.stop_requested()) {
      std::this_thread::yield();
    }

    // write should be visible to the current thread
    assert(flag == true);

    t.join();
  }

  return 0;
}