Utils/Console: Add short help to 'ls' output
[senf.git] / Scheduler / Scheduler.cc
1 // $Id$
2 //
3 // Copyright (C) 2006
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 //     Stefan Bund <g0dil@berlios.de>
7 //
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
12 //
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 // GNU General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22
23 /** \file
24     \brief Scheduler non-inline non-template implementation
25
26     \idea Multithreading support: To support multithreading, the
27     static member Scheduler::instance() must return a thread-local
28     value (that is Scheduler::instance() must allocate one Scheduler
29     instance per thread). Another possibility would be to distribute
30     the async load unto several threads (one scheduler for multiple
31     threads)
32  */
33
34 #include "Scheduler.hh"
35 //#include "Scheduler.ih"
36
37 // Custom includes
38
39 #define prefix_
40 ///////////////////////////////cc.p////////////////////////////////////////
41
42 namespace {
43     bool terminate_ (false);
44     bool running_ (false);
45 }
46
47 prefix_ void senf::scheduler::terminate()
48 {
49     terminate_ = true;
50 }
51
52 prefix_ void senf::scheduler::yield()
53 {
54     senf::scheduler::detail::FIFORunner::instance().yield();
55 }
56
57 prefix_ bool senf::scheduler::running()
58 {
59     return running_;
60 }
61
62 prefix_ senf::ClockService::clock_type senf::scheduler::now()
63 {
64     return running() ? eventTime() : ClockService::now();
65 }
66
67 namespace {
68     
69     // We don't want try { } catch(...) { ... throw; } since that will make debugging more
70     // difficult: the stack backtrace for an unexpected exception would always end here.
71     struct SchedulerScopedInit
72     {
73         SchedulerScopedInit() 
74             {
75                 senf::scheduler::detail::FIFORunner::instance().startWatchdog();
76                 senf::scheduler::detail::SignalDispatcher::instance().unblockSignals();
77                 senf::scheduler::detail::TimerDispatcher::instance().enable();
78                 running_ = true;
79             }
80
81         ~SchedulerScopedInit()
82             {
83                 senf::scheduler::detail::TimerDispatcher::instance().disable();
84                 senf::scheduler::detail::SignalDispatcher::instance().blockSignals();
85                 senf::scheduler::detail::FIFORunner::instance().stopWatchdog();
86                 running_ = false;
87             }
88     };
89 }
90
91 prefix_ void senf::scheduler::process()
92 {
93     SchedulerScopedInit initScheduler;
94     terminate_ = false;
95     running_ = true;
96     detail::TimerDispatcher::instance().reschedule();
97     while(! terminate_ && ! (detail::FdDispatcher::instance().empty() &&
98                              detail::TimerDispatcher::instance().empty() &&
99                              detail::FileDispatcher::instance().empty())) {
100         detail::FdManager::instance().processOnce();
101         detail::FileDispatcher::instance().prepareRun();
102         detail::EventHookDispatcher::instance().prepareRun();
103         detail::TimerDispatcher::instance().prepareRun();
104         detail::FIFORunner::instance().run();
105         detail::TimerDispatcher::instance().reschedule();
106     }
107 }
108
109 prefix_ void senf::scheduler::restart()
110 {
111     detail::FdManager*            fdm (&detail::FdManager::instance());
112     detail::FIFORunner*           ffr (&detail::FIFORunner::instance());
113     detail::FdDispatcher*         fdd (&detail::FdDispatcher::instance());
114     detail::TimerDispatcher*      tdd (&detail::TimerDispatcher::instance());
115     detail::SignalDispatcher*     sdd (&detail::SignalDispatcher::instance());
116     detail::FileDispatcher*       fld (&detail::FileDispatcher::instance());
117     detail::EventHookDispatcher*  eed (&detail::EventHookDispatcher::instance());
118
119     eed->~EventHookDispatcher();
120     fld->~FileDispatcher();
121     sdd->~SignalDispatcher();
122     tdd->~TimerDispatcher();
123     fdd->~FdDispatcher();
124     ffr->~FIFORunner();
125     fdm->~FdManager();
126     
127     new (fdm) detail::FdManager();
128     new (ffr) detail::FIFORunner();
129     new (fdd) detail::FdDispatcher();
130     new (tdd) detail::TimerDispatcher();
131     new (sdd) detail::SignalDispatcher();
132     new (fld) detail::FileDispatcher();
133     new (eed) detail::EventHookDispatcher();
134 }
135
136 prefix_ bool senf::scheduler::empty()
137 {
138     return detail::FdDispatcher::instance().empty() 
139         && detail::TimerDispatcher::instance().empty()
140         && detail::FileDispatcher::instance().empty()
141         && detail::SignalDispatcher::instance().empty()
142         && detail::EventHookDispatcher::instance().empty();
143 }
144
145 prefix_ void senf::scheduler::hiresTimers()
146 {
147 #ifdef HAVE_TIMERFD
148     if (haveScalableHiresTimers())
149         detail::TimerDispatcher::instance().timerSource(
150             std::auto_ptr<detail::TimerSource>(new detail::TimerFDTimerSource()));
151     else
152 #endif
153         detail::TimerDispatcher::instance().timerSource(
154             std::auto_ptr<detail::TimerSource>(new detail::POSIXTimerSource()));
155 }
156
157 ///////////////////////////////////////////////////////////////////////////
158 // senf::schedulerLogTimeSource
159
160 prefix_ senf::log::time_type senf::scheduler::LogTimeSource::operator()()
161     const
162 {
163     return eventTime();
164 }
165
166 ///////////////////////////////////////////////////////////////////////////
167 // senf::scheduler::BlockSignals
168
169 prefix_ senf::scheduler::BlockSignals::BlockSignals(bool initiallyBlocked)
170     : blocked_ (false)
171 {
172     ::sigfillset(&allSigs_);
173     if (initiallyBlocked)
174         block();
175 }
176
177 prefix_ void senf::scheduler::BlockSignals::block()
178 {
179     if (blocked_)
180         return;
181     ::sigprocmask(SIG_BLOCK, &allSigs_, &savedSigs_);
182     blocked_ = true;
183 }
184
185 prefix_ void senf::scheduler::BlockSignals::unblock()
186 {
187     if (!blocked_)
188         return;
189     ::sigprocmask(SIG_SETMASK, &savedSigs_, 0);
190     blocked_ = false;
191 }
192
193 ///////////////////////////////cc.e////////////////////////////////////////
194 #undef prefix_
195
196 \f
197 // Local Variables:
198 // mode: c++
199 // fill-column: 100
200 // c-file-style: "senf"
201 // indent-tabs-mode: nil
202 // ispell-local-dictionary: "american"
203 // compile-command: "scons -u test"
204 // comment-column: 40
205 // End: