sched_event.hh revision 13063:c9905ead0041 
1/*
2 * Copyright 2018 Google, Inc.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met: redistributions of source code must retain the above copyright
7 * notice, this list of conditions and the following disclaimer;
8 * redistributions in binary form must reproduce the above copyright
9 * notice, this list of conditions and the following disclaimer in the
10 * documentation and/or other materials provided with the distribution;
11 * neither the name of the copyright holders nor the names of its
12 * contributors may be used to endorse or promote products derived from
13 * this software without specific prior written permission.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 *
27 * Authors: Gabe Black
28 */
29
30#ifndef __SYSTEMC_CORE_SCHED_EVENT_HH__
31#define __SYSTEMC_CORE_SCHED_EVENT_HH__
32
33#include <functional>
34
35#include "base/types.hh"
36
37namespace sc_gem5
38{
39
40class ScEvent
41{
42  private:
43    std::function<void()> work;
44    Tick _when;
45    bool _scheduled;
46
47    friend class Scheduler;
48
49    void
50    schedule(Tick w)
51    {
52        when(w);
53        _scheduled = true;
54    }
55
56    void deschedule() { _scheduled = false; }
57  public:
58    ScEvent(std::function<void()> work) :
59        work(work), _when(MaxTick), _scheduled(false)
60    {}
61
62    bool scheduled() { return _scheduled; }
63
64    void when(Tick w) { _when = w; }
65    Tick when() { return _when; }
66
67    void run() { deschedule(); work(); }
68};
69
70} // namespace sc_gem5
71
72#endif // __SYSTEMC_CORE_SCHED_EVENT_HH__
73