butex.cpp 25.2 KB
Newer Older
gejun's avatar
gejun committed
1
// bthread - A M:N threading library to make applications more concurrent.
gejun's avatar
gejun committed
2
// Copyright (c) 2014 Baidu, Inc.
gejun's avatar
gejun committed
3 4 5 6 7 8 9 10 11 12 13 14
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
//     http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
gejun's avatar
gejun committed
15 16 17 18

// Author: Ge,Jun (gejun@baidu.com)
// Date: Tue Jul 22 17:30:12 CST 2014

19 20 21 22
#include "butil/atomicops.h"                // butil::atomic
#include "butil/scoped_lock.h"              // BAIDU_SCOPED_LOCK
#include "butil/macros.h"
#include "butil/containers/linked_list.h"   // LinkNode
23
#ifdef SHOW_BTHREAD_BUTEX_WAITER_COUNT_IN_VARS
24
#include "butil/memory/singleton_on_pthread_once.h"
25
#endif
26 27
#include "butil/logging.h"
#include "butil/object_pool.h"
gejun's avatar
gejun committed
28 29 30 31 32 33 34
#include "bthread/errno.h"                 // EWOULDBLOCK, ESTOP
#include "bthread/sys_futex.h"             // futex_*
#include "bthread/processor.h"             // cpu_relax
#include "bthread/task_control.h"          // TaskControl
#include "bthread/task_group.h"            // TaskGroup
#include "bthread/timer_thread.h"
#include "bthread/butex.h"
35
#include "bthread/mutex.h"
gejun's avatar
gejun committed
36 37

// This file implements butex.h
38 39
// Provides futex-like semantics which is sequenced wait and wake operations
// and guaranteed visibilities.
gejun's avatar
gejun committed
40 41
//
// If wait is sequenced before wake:
42
//    [thread1]             [thread2]
gejun's avatar
gejun committed
43 44 45 46 47
//    wait()                value = new_value
//                          wake()
// wait() sees unmatched value(fail to wait), or wake() sees the waiter.
//
// If wait is sequenced after wake:
48
//    [thread1]             [thread2]
gejun's avatar
gejun committed
49 50 51
//                          value = new_value
//                          wake()
//    wait()
52
// wake() must provide some sort of memory fence to prevent assignment
gejun's avatar
gejun committed
53 54 55 56 57
// of value to be reordered after it. Thus the value is visible to wait()
// as well.

namespace bthread {

gejun's avatar
gejun committed
58
#ifdef SHOW_BTHREAD_BUTEX_WAITER_COUNT_IN_VARS
gejun's avatar
gejun committed
59 60 61 62
struct ButexWaiterCount : public bvar::Adder<int64_t> {
    ButexWaiterCount() : bvar::Adder<int64_t>("bthread_butex_waiter_count") {}
};
inline bvar::Adder<int64_t>& butex_waiter_count() {
63
    return *butil::get_leaky_singleton<ButexWaiterCount>();
gejun's avatar
gejun committed
64
}
gejun's avatar
gejun committed
65
#endif
gejun's avatar
gejun committed
66 67 68 69 70 71 72

// Implemented in task_group.cpp
int stop_and_consume_butex_waiter(bthread_t tid, ButexWaiter** pw);
int set_butex_waiter(bthread_t tid, ButexWaiter* w);

// If a thread would suspend for less than so many microseconds, return
// ETIMEDOUT directly.
73 74
// Use 1: sleeping for less than 2 microsecond is inefficient and useless.
static const int64_t MIN_SLEEP_US = 2; 
gejun's avatar
gejun committed
75 76 77 78 79 80 81 82 83 84

enum WaiterState {
    WAITER_STATE_NONE,
    WAITER_STATE_TIMED,
    WAITER_STATE_CANCELLED,
    WAITER_STATE_TIMEDOUT
};

struct Butex;

85
struct ButexWaiter : public butil::LinkNode<ButexWaiter> {
gejun's avatar
gejun committed
86 87 88
    // tids of pthreads are 0
    bthread_t tid;

89 90
    // Erasing node from middle of LinkedList is thread-unsafe, we need
    // to hold its container's lock.
91
    butil::atomic<Butex*> container;
gejun's avatar
gejun committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
};

// non_pthread_task allocates this structure on stack and queue it in
// Butex::waiters.
struct ButexBthreadWaiter : public ButexWaiter {
    TaskMeta* task_meta;
    TimerThread::TaskId sleep_id;
    WaiterState waiter_state;
    int expected_value;
    Butex* initial_butex;
    TaskControl* control;
};

// pthread_task or main_task allocates this structure on stack and queue it
// in Butex::waiters.
struct ButexPthreadWaiter : public ButexWaiter {
108
    butil::atomic<int> sig;
gejun's avatar
gejun committed
109 110
};

111
typedef butil::LinkedList<ButexWaiter> ButexWaiterList;
gejun's avatar
gejun committed
112 113 114 115 116 117 118

enum BUTEX_PTHREAD_SIGNAL {
    NOT_SIGNALLED = 0,
    SIGNALLED = 1,
    SAFE_TO_DESTROY
};

gejun's avatar
gejun committed
119 120
struct BAIDU_CACHELINE_ALIGNMENT Butex {
    Butex() {}
gejun's avatar
gejun committed
121 122
    ~Butex() {}

123
    butil::atomic<int> value;
gejun's avatar
gejun committed
124
    ButexWaiterList waiters;
125
    internal::FastPthreadMutex waiter_lock;
gejun's avatar
gejun committed
126 127 128
};

BAIDU_CASSERT(offsetof(Butex, value) == 0, offsetof_value_must_0);
gejun's avatar
gejun committed
129
BAIDU_CASSERT(sizeof(Butex) == BAIDU_CACHELINE_SIZE, butex_fits_in_one_cacheline);
gejun's avatar
gejun committed
130 131

void wakeup_pthread(ButexPthreadWaiter* pw) {
132
    // release fence makes wait_pthread see other changes when it sees new sig
133
    pw->sig.store(SAFE_TO_DESTROY, butil::memory_order_release);
gejun's avatar
gejun committed
134 135
    // At this point, *pw is possibly destroyed if wait_pthread has woken up and
    // seen the new sig. As the futex_wake_private just check the accessibility
136
    // of the memory and returnes EFAULT in this case, it's just fine.
gejun's avatar
gejun committed
137 138 139 140 141 142 143 144 145 146 147
    // If crash happens in the future, we can make pw as tls and never
    // destroyed to resolve this issue.
    futex_wake_private(&pw->sig, 1);
}

bool erase_from_butex(ButexWaiter*, bool);

int wait_pthread(ButexPthreadWaiter& pw, timespec* ptimeout) {
    int expected_value = NOT_SIGNALLED;
    while (true) {
        const int rc = futex_wait_private(&pw.sig, expected_value, ptimeout);
148 149
        // Accquire fence makes this thread sees other changes when it sees
        // the new |sig|
150
        if (expected_value != pw.sig.load(butil::memory_order_acquire)) {
151 152
            // After this routine returns, |pw| will be destroyed while the wake
            // thread possibly still uses it. See the comments in wakeup_pthread
gejun's avatar
gejun committed
153 154 155 156 157 158 159 160
            return rc;
        }
        if (rc != 0 && errno == ETIMEDOUT) {
            // Remove pw from waiters to make sure no one would wakeup pw after
            // this function returnes.
            if (!erase_from_butex(&pw, false)) {
                // Another thread holds pw, attemping to signal it, spin until
                // it's safe to destroy pw
161 162
                // Make sure this thread sees the lastest changes when sig is
                // set to SAFE_TO_DESTROY
163
                BT_LOOP_WHEN(pw.sig.load(butil::memory_order_acquire) 
gejun's avatar
gejun committed
164 165 166 167 168 169 170 171 172 173 174 175 176
                                    != SAFE_TO_DESTROY,
                             30/*nops before sched_yield*/);

            }
            return rc;
        }
    }
}

extern BAIDU_THREAD_LOCAL TaskGroup* tls_task_group;

// Returns 0 when no need to unschedule or successfully unscheduled,
// -1 otherwise.
177 178
inline int unsleep_if_necessary(ButexBthreadWaiter* w,
                                TimerThread* timer_thread) {
gejun's avatar
gejun committed
179 180 181 182 183 184 185 186 187 188 189
    if (!w->sleep_id) {
        return 0;
    }
    if (timer_thread->unschedule(w->sleep_id) > 0) {
        // the callback is running.
        return -1;
    }
    w->sleep_id = 0;
    return 0;
}

gejun's avatar
gejun committed
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
// Using ObjectPool(which never frees memory) to solve the race between
// butex_wake() and butex_destroy(). The race is as follows:
//
//   class Event {
//   public:
//     void wait() {
//       _mutex.lock();
//       if (!_done) {
//         _cond.wait(&_mutex);
//       }
//       _mutex.unlock();
//     }
//     void signal() {
//       _mutex.lock();
//       if (!_done) {
//         _done = true;
//         _cond.signal();
//       }
//       _mutex.unlock();  /*1*/
//     }
//   private:
//     bool _done = false;
//     Mutex _mutex;
//     Condition _cond;
//   };
//
//   [Thread1]                         [Thread2]
//   foo() {
//     Event event;
//     pass_to_thread2(&event);  --->  event.signal();
//     event.wait();
//   } <-- event destroyed
//   
// Summary: Thread1 passes a stateful condition to thread2 and wait until
// the the condition is signalled, which basically means the associated
// job is done and Thread1 can release related resources including the mutex
// and condition. The scenario is fine and code is correct.
// The race needs a closer look. If we look into the unlock at /*1*/, it
// may have different implementations, but the last step is probably an
// atomic store and butex_wake(), like this:
//
//   locked->store(0);
//   butex_wake(locked);
//
// `locked' represents the locking status of the mutex. The issue is that
// just after the store(), the mutex is already unlocked, the code in
// Event.wait() may successfully grab the lock and go through everything
// left and leave foo() function, destroying the mutex and butex, thus the
// butex_wake(locked) may crash.
// To solve this issue, one method is to add reference before store and
// release the reference after butex_wake. However this kind of
// reference-counting needs to be added in nearly every user scenario of
// butex_wake(), which is very error-prone. Another method is never freeing
// butex, the side effect is that butex_wake() may wake up an unrelated
// butex(the one reuses the memory) and cause spurious wakeups. According
// to our observations, the race is infrequent, even rare. The extra spurious
// wakeup should be acceptable.
gejun's avatar
gejun committed
247 248

void* butex_create() {
249
    Butex* b = butil::get_object<Butex>();
gejun's avatar
gejun committed
250
    if (b) {
gejun's avatar
gejun committed
251 252 253 254 255 256
        return &b->value;
    }
    return NULL;
}

void butex_destroy(void* butex) {
gejun's avatar
gejun committed
257 258
    if (!butex) {
        return;
gejun's avatar
gejun committed
259
    }
gejun's avatar
gejun committed
260
    Butex* b = static_cast<Butex*>(
261 262
        container_of(static_cast<butil::atomic<int>*>(butex), Butex, value));
    butil::return_object(b);
gejun's avatar
gejun committed
263 264 265 266 267 268 269 270
}

inline TaskGroup* get_task_group(TaskControl* c) {
    TaskGroup* g = tls_task_group;
    return g ? g : c->choose_one_group();
}

int butex_wake(void* arg) {
271
    Butex* b = container_of(static_cast<butil::atomic<int>*>(arg), Butex, value);
gejun's avatar
gejun committed
272 273 274 275 276 277 278 279
    ButexWaiter* front = NULL;
    {
        BAIDU_SCOPED_LOCK(b->waiter_lock);
        if (b->waiters.empty()) {
            return 0;
        }
        front = b->waiters.head()->value();
        front->RemoveFromList();
280
        front->container.store(NULL, butil::memory_order_relaxed);
gejun's avatar
gejun committed
281 282 283 284 285 286 287 288 289 290 291
    }
    if (front->tid == 0) {
        wakeup_pthread(static_cast<ButexPthreadWaiter*>(front));
        return 1;
    }
    ButexBthreadWaiter* bbw = static_cast<ButexBthreadWaiter*>(front);
    unsleep_if_necessary(bbw, get_global_timer_thread());
    TaskGroup* g = tls_task_group;
    if (g) {
        TaskGroup::exchange(&g, bbw->tid);
    } else {
292
        bbw->control->choose_one_group()->ready_to_run_remote(bbw->tid);
gejun's avatar
gejun committed
293 294 295 296
    }
    return 1;
}

gejun's avatar
gejun committed
297
int butex_wake_all(void* arg) {
298
    Butex* b = container_of(static_cast<butil::atomic<int>*>(arg), Butex, value);
gejun's avatar
gejun committed
299 300 301 302 303 304 305 306

    ButexWaiterList bthread_waiters;
    ButexWaiterList pthread_waiters;
    {
        BAIDU_SCOPED_LOCK(b->waiter_lock);
        while (!b->waiters.empty()) {
            ButexWaiter* bw = b->waiters.head()->value();
            bw->RemoveFromList();
307
            bw->container.store(NULL, butil::memory_order_relaxed);
gejun's avatar
gejun committed
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
            if (bw->tid) {
                bthread_waiters.Append(bw);
            } else {
                pthread_waiters.Append(bw);
            }
        }
    }

    int nwakeup = 0;
    while (!pthread_waiters.empty()) {
        ButexPthreadWaiter* bw = static_cast<ButexPthreadWaiter*>(
            pthread_waiters.head()->value());
        bw->RemoveFromList();
        wakeup_pthread(bw);
        ++nwakeup;
    }
    if (bthread_waiters.empty()) {
        return nwakeup;
    }
    // We will exchange with first waiter in the end.
    ButexBthreadWaiter* next = static_cast<ButexBthreadWaiter*>(
        bthread_waiters.head()->value());
    next->RemoveFromList();
    unsleep_if_necessary(next, get_global_timer_thread());
    ++nwakeup;
    TaskGroup* g = get_task_group(next->control);
    const int saved_nwakeup = nwakeup;
    while (!bthread_waiters.empty()) {
        // pop reversely
        ButexBthreadWaiter* w = static_cast<ButexBthreadWaiter*>(
            bthread_waiters.tail()->value());
        w->RemoveFromList();
        unsleep_if_necessary(w, get_global_timer_thread());
341
        g->ready_to_run_general(w->tid, true);
gejun's avatar
gejun committed
342 343 344
        ++nwakeup;
    }
    if (saved_nwakeup != nwakeup) {
345
        g->flush_nosignal_tasks_general();
gejun's avatar
gejun committed
346 347 348 349
    }
    if (g == tls_task_group) {
        TaskGroup::exchange(&g, next->tid);
    } else {
350
        g->ready_to_run_remote(next->tid);
gejun's avatar
gejun committed
351 352 353 354 355
    }
    return nwakeup;
}

int butex_wake_except(void* arg, bthread_t excluded_bthread) {
356
    Butex* b = container_of(static_cast<butil::atomic<int>*>(arg), Butex, value);
gejun's avatar
gejun committed
357 358 359 360 361 362 363 364 365 366 367 368 369

    ButexWaiterList bthread_waiters;
    ButexWaiterList pthread_waiters;
    {
        ButexWaiter* excluded_waiter = NULL;
        BAIDU_SCOPED_LOCK(b->waiter_lock);
        while (!b->waiters.empty()) {
            ButexWaiter* bw = b->waiters.head()->value();
            bw->RemoveFromList();

            if (bw->tid) {
                if (bw->tid != excluded_bthread) {
                    bthread_waiters.Append(bw);
370
                    bw->container.store(NULL, butil::memory_order_relaxed);
gejun's avatar
gejun committed
371 372 373 374
                } else {
                    excluded_waiter = bw;
                }
            } else {
375
                bw->container.store(NULL, butil::memory_order_relaxed);
gejun's avatar
gejun committed
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
                pthread_waiters.Append(bw);
            }
        }

        if (excluded_waiter) {
            b->waiters.Append(excluded_waiter);
        }
    }

    int nwakeup = 0;
    while (!pthread_waiters.empty()) {
        ButexPthreadWaiter* bw = static_cast<ButexPthreadWaiter*>(
            pthread_waiters.head()->value());
        bw->RemoveFromList();
        wakeup_pthread(bw);
        ++nwakeup;
    }

    if (bthread_waiters.empty()) {
        return nwakeup;
    }
    ButexBthreadWaiter* front = static_cast<ButexBthreadWaiter*>(
                bthread_waiters.head()->value());

    TaskGroup* g = get_task_group(front->control);
    const int saved_nwakeup = nwakeup;
    do {
        // pop reversely
        ButexBthreadWaiter* w = static_cast<ButexBthreadWaiter*>(
            bthread_waiters.tail()->value());
        w->RemoveFromList();
        unsleep_if_necessary(w, get_global_timer_thread());
408
        g->ready_to_run_general(w->tid, true);
gejun's avatar
gejun committed
409 410 411
        ++nwakeup;
    } while (!bthread_waiters.empty());
    if (saved_nwakeup != nwakeup) {
412
        g->flush_nosignal_tasks_general();
gejun's avatar
gejun committed
413 414 415 416 417
    }
    return nwakeup;
}

int butex_requeue(void* arg, void* arg2) {
418 419
    Butex* b = container_of(static_cast<butil::atomic<int>*>(arg), Butex, value);
    Butex* m = container_of(static_cast<butil::atomic<int>*>(arg2), Butex, value);
gejun's avatar
gejun committed
420 421 422

    ButexWaiter* front = NULL;
    {
423 424
        std::unique_lock<internal::FastPthreadMutex> lck1(b->waiter_lock, std::defer_lock);
        std::unique_lock<internal::FastPthreadMutex> lck2(m->waiter_lock, std::defer_lock);
425
        butil::double_lock(lck1, lck2);
gejun's avatar
gejun committed
426 427 428 429 430 431
        if (b->waiters.empty()) {
            return 0;
        }

        front = b->waiters.head()->value();
        front->RemoveFromList();
432
        front->container.store(NULL, butil::memory_order_relaxed);
gejun's avatar
gejun committed
433 434 435 436 437

        while (!b->waiters.empty()) {
            ButexWaiter* bw = b->waiters.head()->value();
            bw->RemoveFromList();
            m->waiters.Append(bw);
438
            bw->container.store(m, butil::memory_order_relaxed);
gejun's avatar
gejun committed
439 440 441 442 443 444 445 446 447 448 449 450 451
        }
    }

    if (front->tid == 0) {  // which is a pthread
        wakeup_pthread(static_cast<ButexPthreadWaiter*>(front));
        return 1;
    }
    ButexBthreadWaiter* bbw = static_cast<ButexBthreadWaiter*>(front);
    unsleep_if_necessary(bbw, get_global_timer_thread());
    TaskGroup* g = tls_task_group;
    if (g) {
        TaskGroup::exchange(&g, front->tid);
    } else {
452
        bbw->control->choose_one_group()->ready_to_run_remote(front->tid);
gejun's avatar
gejun committed
453 454 455 456 457 458 459 460 461 462 463
    }
    return 1;
}

// Callable from multiple threads, at most one thread may wake up the waiter.
static void erase_from_butex_and_wakeup(void* arg) {
    erase_from_butex(static_cast<ButexWaiter*>(arg), true);
}

inline bool erase_from_butex(ButexWaiter* bw, bool wakeup) {
    // `bw' is guaranteed to be valid inside this function because waiter
464
    // will wait until this function being cancelled or finished.
gejun's avatar
gejun committed
465 466 467 468
    // NOTE: This function must be no-op when bw->container is NULL.
    bool erased = false;
    Butex* b;
    int saved_errno = errno;
469
    while ((b = bw->container.load(butil::memory_order_acquire))) {
gejun's avatar
gejun committed
470 471
        // b can be NULL when the waiter is scheduled but queued.
        BAIDU_SCOPED_LOCK(b->waiter_lock);
472
        if (b == bw->container.load(butil::memory_order_relaxed)) {
gejun's avatar
gejun committed
473
            bw->RemoveFromList();
474
            bw->container.store(NULL, butil::memory_order_relaxed);
gejun's avatar
gejun committed
475 476 477 478 479 480 481 482 483 484
            if (bw->tid) {
                static_cast<ButexBthreadWaiter*>(bw)->waiter_state = WAITER_STATE_TIMEDOUT;
            }
            erased = true;
            break;
        }
    }
    if (erased && wakeup) {
        if (bw->tid) {
            ButexBthreadWaiter* bbw = static_cast<ButexBthreadWaiter*>(bw);
485
            get_task_group(bbw->control)->ready_to_run_general(bw->tid);
gejun's avatar
gejun committed
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
        } else {
            ButexPthreadWaiter* pw = static_cast<ButexPthreadWaiter*>(bw);
            wakeup_pthread(pw);
        }
    }
    errno = saved_errno;
    return erased;
}

static void wait_for_butex(void* arg) {
    ButexBthreadWaiter* const bw = static_cast<ButexBthreadWaiter*>(arg);
    Butex* const b = bw->initial_butex;
    // 1: waiter with timeout should have waiter_state == WAITER_STATE_TIMED
    //    before they're are queued, otherwise the waiter is already timedout
    //    and removed by TimerThread, in which case we should stop queueing.
    //
    // Visibility of waiter_state:
503
    //    [bthread]                         [TimerThread]
gejun's avatar
gejun committed
504 505 506 507 508 509 510 511 512 513
    //    waiter_state = TIMED
    //    tt_lock { add task }
    //                                      tt_lock { get task }
    //                                      waiter_lock { waiter_state=TIMEDOUT }
    //    waiter_lock { use waiter_state }
    // tt_lock represents TimerThread::_mutex. Obviously visibility of
    // waiter_state are sequenced by two locks, both threads are guaranteed to
    // see the correct value.
    {
        BAIDU_SCOPED_LOCK(b->waiter_lock);
514
        if (b->value.load(butil::memory_order_relaxed) == bw->expected_value &&
gejun's avatar
gejun committed
515 516 517
            bw->waiter_state != WAITER_STATE_TIMEDOUT/*1*/ &&
            (!bw->task_meta->stop || !bw->task_meta->interruptible)) {
            b->waiters.Append(bw);
518
            bw->container.store(b, butil::memory_order_relaxed);
gejun's avatar
gejun committed
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
            return;
        }
    }
    
    // b->container is NULL which makes erase_from_butex_and_wakeup() and
    // stop_butex_wait() no-op, there's no race between following code and
    // the two functions. The on-stack ButexBthreadWaiter is safe to use and
    // bw->waiter_state will not change again.
    unsleep_if_necessary(bw, get_global_timer_thread());
    if (bw->waiter_state != WAITER_STATE_TIMEDOUT) {
        bw->waiter_state = WAITER_STATE_CANCELLED;
    }
    tls_task_group->ready_to_run(bw->tid);
    // FIXME: jump back to original thread is buggy.
    
    // // Value unmatched or waiter is already woken up by TimerThread, jump
    // // back to original bthread.
    // TaskGroup* g = tls_task_group;
537 538
    // ReadyToRunArgs args = { g->current_tid(), false };
    // g->set_remained(TaskGroup::ready_to_run_in_worker, &args);
gejun's avatar
gejun committed
539 540 541 542 543 544 545 546 547 548 549 550
    // // 2: Don't run remained because we're already in a remained function
    // //    otherwise stack may overflow.
    // TaskGroup::sched_to(&g, bw->tid, false/*2*/);
}

static int butex_wait_from_pthread(TaskGroup* g, Butex* b, int expected_value,
                                   const timespec* abstime) {
    // sys futex needs relative timeout.
    // Compute diff between abstime and now.
    timespec* ptimeout = NULL;
    timespec timeout;
    if (abstime != NULL) {
551 552
        const int64_t timeout_us = butil::timespec_to_microseconds(*abstime) -
            butil::gettimeofday_us();
553
        if (timeout_us < MIN_SLEEP_US) {
gejun's avatar
gejun committed
554 555 556
            errno = ETIMEDOUT;
            return -1;
        }
557
        timeout = butil::microseconds_to_timespec(timeout_us);
gejun's avatar
gejun committed
558 559 560 561 562 563 564
        ptimeout = &timeout;
    }

    TaskMeta* task = NULL;
    bool set_waiter = false;
    ButexPthreadWaiter pw;
    pw.tid = 0;
565
    pw.sig.store(NOT_SIGNALLED, butil::memory_order_relaxed);
gejun's avatar
gejun committed
566 567 568 569 570 571 572 573 574 575
    int rc = 0;
    
    if (g) {
        task = g->current_task();
        if (task->interruptible) {
            if (task->stop) {
                errno = ESTOP;
                return -1;
            }
            set_waiter = true;
576
            task->current_waiter.store(&pw, butil::memory_order_release);
gejun's avatar
gejun committed
577 578
        }
    }
gejun's avatar
gejun committed
579
    b->waiter_lock.lock();
580
    if (b->value.load(butil::memory_order_relaxed) == expected_value) {
gejun's avatar
gejun committed
581
        b->waiters.Append(&pw);
582
        pw.container.store(b, butil::memory_order_relaxed);
gejun's avatar
gejun committed
583 584 585 586 587 588 589 590 591 592 593 594 595 596
        b->waiter_lock.unlock();

#ifdef SHOW_BTHREAD_BUTEX_WAITER_COUNT_IN_VARS
        bvar::Adder<int64_t>& num_waiters = butex_waiter_count();
        num_waiters << 1;
#endif
        rc = wait_pthread(pw, ptimeout);
#ifdef SHOW_BTHREAD_BUTEX_WAITER_COUNT_IN_VARS
        num_waiters << -1;
#endif
    } else {
        b->waiter_lock.unlock();
        errno = EWOULDBLOCK;
        rc = -1;
gejun's avatar
gejun committed
597 598 599 600 601 602
    }
    if (task) {
        if (set_waiter) {
            // If current_waiter is NULL, stop_butex_wait() is running and
            // using pw, spin until current_waiter != NULL.
            BT_LOOP_WHEN(task->current_waiter.exchange(
603
                             NULL, butil::memory_order_acquire) == NULL,
gejun's avatar
gejun committed
604 605 606 607 608 609 610 611 612 613 614
                         30/*nops before sched_yield*/);
        }
        if (task->stop) {
            errno = ESTOP;
            return -1;
        }
    }
    return rc;
}

int butex_wait(void* arg, int expected_value, const timespec* abstime) {
615 616
    Butex* b = container_of(static_cast<butil::atomic<int>*>(arg), Butex, value);
    if (b->value.load(butil::memory_order_relaxed) != expected_value) {
gejun's avatar
gejun committed
617 618 619
        errno = EWOULDBLOCK;
        // Sometimes we may take actions immediately after unmatched butex,
        // this fence makes sure that we see changes before changing butex.
620
        butil::atomic_thread_fence(butil::memory_order_acquire);
gejun's avatar
gejun committed
621 622 623 624 625 626 627 628 629
        return -1;
    }
    TaskGroup* g = tls_task_group;
    if (NULL == g || g->is_current_pthread_task()) {
        return butex_wait_from_pthread(g, b, expected_value, abstime);
    }
    ButexBthreadWaiter bbw;
    // tid is 0 iff the thread is non-bthread
    bbw.tid = g->current_tid();
630
    bbw.container.store(NULL, butil::memory_order_relaxed);
gejun's avatar
gejun committed
631 632 633 634 635 636 637 638 639 640 641 642
    bbw.task_meta = g->current_task();
    bbw.sleep_id = 0;
    bbw.waiter_state = WAITER_STATE_NONE;
    bbw.expected_value = expected_value;
    bbw.initial_butex = b;
    bbw.control = g->control();

    if (abstime != NULL) {
        // Schedule timer before queueing. If the timer is triggered before
        // queueing, cancel queueing. This is a kind of optimistic locking.
        bbw.waiter_state = WAITER_STATE_TIMED;
        // Already timed out.
643 644
        if (butil::timespec_to_microseconds(*abstime) <
            (butil::gettimeofday_us() + MIN_SLEEP_US)) {
gejun's avatar
gejun committed
645 646 647 648 649 650 651 652 653 654
            errno = ETIMEDOUT;
            return -1;
        }
        bbw.sleep_id = get_global_timer_thread()->schedule(
            erase_from_butex_and_wakeup, &bbw, *abstime);
        if (!bbw.sleep_id) {  // TimerThread stopped.
            errno = ESTOP;
            return -1;
        }
    }
gejun's avatar
gejun committed
655
#ifdef SHOW_BTHREAD_BUTEX_WAITER_COUNT_IN_VARS
656
    bvar::Adder<int64_t>& num_waiters = butex_waiter_count();
gejun's avatar
gejun committed
657
    num_waiters << 1;
gejun's avatar
gejun committed
658 659
#endif

gejun's avatar
gejun committed
660 661
    // release fence matches with acquire fence in stop_and_consume_butex_waiter
    // in task_group.cpp to guarantee visibility of `interruptible'.
662
    bbw.task_meta->current_waiter.store(&bbw, butil::memory_order_release);
gejun's avatar
gejun committed
663 664 665 666 667 668 669 670 671 672 673
    g->set_remained(wait_for_butex, &bbw);
    TaskGroup::sched(&g);

    // erase_from_butex_and_wakeup (called by TimerThread) is possibly still
    // running and using bbw. The chance is small, just spin until it's done.
    BT_LOOP_WHEN(unsleep_if_necessary(&bbw, get_global_timer_thread()) < 0,
                 30/*nops before sched_yield*/);
    
    // If current_waiter is NULL, stop_butex_wait() is running and using bbw.
    // Spin until current_waiter != NULL.
    BT_LOOP_WHEN(bbw.task_meta->current_waiter.exchange(
674
                     NULL, butil::memory_order_acquire) == NULL,
gejun's avatar
gejun committed
675
                 30/*nops before sched_yield*/);
gejun's avatar
gejun committed
676
#ifdef SHOW_BTHREAD_BUTEX_WAITER_COUNT_IN_VARS
gejun's avatar
gejun committed
677
    num_waiters << -1;
gejun's avatar
gejun committed
678
#endif
gejun's avatar
gejun committed
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730

    // ESTOP has highest priority.
    if (bbw.task_meta->stop) {
        errno = ESTOP;
        return -1;
    }
    // If timed out as well as value unmatched, return ETIMEDOUT.
    if (WAITER_STATE_TIMEDOUT == bbw.waiter_state) {
        errno = ETIMEDOUT;
        return -1;
    } else if (WAITER_STATE_CANCELLED == bbw.waiter_state) {
        errno = EWOULDBLOCK;
        return -1;
    }
    return 0;
}

int butex_wait_uninterruptible(void* arg, int expected_value, const timespec* abstime) {
    TaskGroup* g = tls_task_group;
    TaskMeta* caller = NULL;
    bool saved_interruptible = true;
    if (NULL != g) {
        caller = g->current_task();
        saved_interruptible = caller->interruptible;
        caller->interruptible = false;
    }
    const int rc = butex_wait(arg, expected_value, abstime);
    if (caller) {
        caller->interruptible = saved_interruptible;
    }
    return rc;
}

int stop_butex_wait(bthread_t tid) {
    // Consume current_waiter in the TaskMeta, wake it up then set it back.
    ButexWaiter* w = NULL;
    if (stop_and_consume_butex_waiter(tid, &w) < 0) {
        return -1;
    }
    if (w != NULL) {
        erase_from_butex(w, true);
        // If butex_wait() already wakes up before we set current_waiter back,
        // the function will spin until current_waiter becomes non-NULL.
        if (__builtin_expect(set_butex_waiter(tid, w) < 0, 0)) {
            LOG(FATAL) << "butex_wait should spin until setting back waiter";
            return -1;
        }
    }
    return 0;
}

}  // namespace bthread
gejun's avatar
gejun committed
731

732
namespace butil {
gejun's avatar
gejun committed
733 734 735 736
template <> struct ObjectPoolBlockMaxItem<bthread::Butex> {
    static const size_t value = 128;
};
}