parking_lot.h 2.15 KB
Newer Older
1
// bthread - A M:N threading library to make applications more concurrent.
gejun's avatar
gejun committed
2
// Copyright (c) 2017 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.
15 16 17 18 19 20 21

// Author: chenzhangyi01@baidu.com, gejun@baidu.com
// Date: 2017/07/27 23:07:06

#ifndef  PUBLIC_BTHREAD_PARKING_LOT_H
#define  PUBLIC_BTHREAD_PARKING_LOT_H

22
#include "butil/atomicops.h"
23 24 25 26 27 28 29
#include "bthread/sys_futex.h"

namespace bthread {

// Park idle workers.
class BAIDU_CACHELINE_ALIGNMENT ParkingLot {
public:
30 31 32
    class State {
    public:
        State(): val(0) {}
33
        bool stopped() const { return val & 1; }
34 35 36
    private:
    friend class ParkingLot;
        State(int val) : val(val) {}
37 38 39 40 41 42 43 44
        int val;
    };

    ParkingLot() : _pending_signal(0) {}

    // Wake up at most `num_task' workers.
    // Returns #workers woken up.
    int signal(int num_task) {
45
        _pending_signal.fetch_add((num_task << 1), butil::memory_order_release);
46 47 48 49 50
        return futex_wake_private(&_pending_signal, num_task);
    }

    // Get a state for later wait().
    State get_state() {
51
        return _pending_signal.load(butil::memory_order_acquire);
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
    }

    // Wait for tasks.
    // If the `expected_state' does not match, wait() may finish directly.
    void wait(const State& expected_state) {
        futex_wait_private(&_pending_signal, expected_state.val, NULL);
    }

    // Wakeup suspended wait() and make them unwaitable ever. 
    void stop() {
        _pending_signal.fetch_or(1);
        futex_wake_private(&_pending_signal, 10000);
    }
private:
    // higher 31 bits for signalling, MLB for stopping.
67
    butil::atomic<int> _pending_signal;
68 69 70 71 72
};

}  // namespace bthread

#endif  //PUBLIC_BTHREAD_PARKING_LOT_H