2 * Copyright (C) 2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
3 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: LGPL-2.1-only
14 #include <urcu/futex.h>
15 #include <urcu/uatomic.h>
18 /* Number of busy-loop attempts before waiting on futex. */
19 constexpr auto wait_attempt_count
= 1000;
22 /* WAITER_WAITING is compared directly (futex compares it). */
24 /* non-zero are used as masks. */
25 WAITER_WOKEN_UP
= (1 << 0),
26 WAITER_RUNNING
= (1 << 1),
27 WAITER_TEARDOWN
= (1 << 2),
31 lttng::synchro::waiter::waiter()
36 void lttng::synchro::waiter::arm() noexcept
38 cds_wfs_node_init(&_wait_queue_node
);
39 uatomic_set(&_state
, WAITER_WAITING
);
44 * User must arm "waiter" before passing its memory to waker thread.
46 void lttng::synchro::waiter::wait()
48 DBG("Beginning of waiter \"wait\" period");
50 /* Load and test condition before read state. */
52 for (unsigned int i
= 0; i
< wait_attempt_count
; i
++) {
53 if (uatomic_read(&_state
) != WAITER_WAITING
) {
60 while (uatomic_read(&_state
) == WAITER_WAITING
) {
61 if (!futex_noasync(&_state
, FUTEX_WAIT
, WAITER_WAITING
, nullptr, nullptr, 0)) {
63 * Prior queued wakeups queued by unrelated code
64 * using the same address can cause futex wait to
65 * return 0 even through the futex value is still
66 * WAITER_WAITING (spurious wakeups). Check
67 * the value again in user-space to validate
68 * whether it really differs from WAITER_WAITING.
75 /* Value already changed. */
78 /* Retry if interrupted by signal. */
79 break; /* Get out of switch. Check again. */
81 /* Unexpected error. */
82 PERROR("futex_noasync");
88 /* Tell waker thread than we are running. */
89 uatomic_or(&_state
, WAITER_RUNNING
);
92 * Wait until waker thread lets us know it's ok to tear down
93 * memory allocated for struct lttng_waiter.
95 for (unsigned int i
= 0; i
< wait_attempt_count
; i
++) {
96 if (uatomic_read(&_state
) & WAITER_TEARDOWN
) {
103 while (!(uatomic_read(&_state
) & WAITER_TEARDOWN
)) {
104 poll(nullptr, 0, 10);
107 LTTNG_ASSERT(uatomic_read(&_state
) & WAITER_TEARDOWN
);
108 DBG("End of waiter \"wait\" period");
111 lttng::synchro::waker
lttng::synchro::waiter::get_waker()
113 return lttng::synchro::waker(_state
);
117 * Note: lttng_waiter_wake needs waiter to stay allocated throughout its
118 * execution. In this scheme, the waiter owns the node memory, and we only allow
119 * it to free this memory when it sees the WAITER_TEARDOWN flag.
121 void lttng::synchro::waker::wake()
125 LTTNG_ASSERT(uatomic_read(&_state
.get()) == WAITER_WAITING
);
127 uatomic_set(&_state
.get(), WAITER_WOKEN_UP
);
128 if (!(uatomic_read(&_state
.get()) & WAITER_RUNNING
)) {
129 if (futex_noasync(&_state
.get(), FUTEX_WAKE
, 1, nullptr, nullptr, 0) < 0) {
130 PERROR("futex_noasync");
135 /* Allow teardown of struct urcu_wait memory. */
136 uatomic_or(&_state
.get(), WAITER_TEARDOWN
);
139 lttng::synchro::wait_queue::wait_queue()
141 cds_wfs_init(&_stack
);
144 void lttng::synchro::wait_queue::add(waiter
& waiter
) noexcept
146 (void) cds_wfs_push(&_stack
, &waiter
._wait_queue_node
);
149 void lttng::synchro::wait_queue::wake_all()
151 /* Move all waiters from the queue to our local stack. */
152 auto *waiters
= __cds_wfs_pop_all(&_stack
);
154 /* Wake all waiters in our stack head. */
155 cds_wfs_node
*iter
, *iter_n
;
156 cds_wfs_for_each_blocking_safe (waiters
, iter
, iter_n
) {
157 auto& waiter
= *lttng::utils::container_of(
158 iter
, <tng::synchro::waiter::_wait_queue_node
);
160 /* Don't wake already running threads. */
161 if (waiter
._state
& WAITER_RUNNING
) {
165 waiter
.get_waker().wake();
This page took 0.031691 seconds and 4 git commands to generate.