4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
6 // Stefan Bund <stefan.bund@fokus.fraunhofer.de>
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.
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.
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.
24 \brief Scheduler public header
28 #define HH_Scheduler_ 1
35 #include <boost/function.hpp>
36 #include <boost/utility.hpp>
37 #include <boost/call_traits.hpp>
38 #include <boost/integer.hpp>
39 #include "ClockService.hh"
40 #include "../Utils/Logger/Target.hh"
42 //#include "scheduler.mpp"
43 ///////////////////////////////hh.p////////////////////////////////////////
45 /** \brief SENF Project namespace */
48 /** \brief Singleton class to manage the event loop
50 The Scheduler singleton manages the central event loop. It manages and dispatches all types
51 of events managed by the scheduler library:
52 \li File descriptor notifications
56 The scheduler is entered by calling it's process() member. This call will continue to run as
57 long as there is something to do, or until one of the handlers calls terminate(). The
58 Scheduler has 'something to do' as long as there is any file descriptor or timeout active.
60 The Scheduler only provides low level primitive scheduling capability. Additional helpers
61 are defined on top of this functionality (e.g. ReadHelper or WriteHelper or the interval
65 \section sched_handlers Specifying handlers
67 All handlers are passed as generic <a
68 href="http://www.boost.org/doc/html/function.html">Boost.Function</a> objects. This allows
69 to pass any callable as a handler. Depending on the type of handler, some additional
70 arguments may be passed to the handler by the scheduler.
72 If you need to pass additional information to your handler, use <a
73 href="http://www.boost.org/libs/bind/bind.html">Boost.Bind</a>:
75 // Pass 'handle' as additional first argument to callback()
76 Scheduler::instance().add(handle, boost::bind(&callback, handle, _1))
77 // Call timeout() handler with argument 'n'
78 Scheduler::instance().timeout(boost::bind(&timeout, n))
81 To use member-functions as callbacks, use either <a
82 href="http://www.boost.org/libs/bind/bind.html">Boost.Bind</a> or senf::membind()
84 // e.g. in Foo::Foo() constructor:
85 Scheduler::instance().add(handle_, senf::membind(&Foo::callback, this))
89 \section sched_fd Registering file descriptors
91 File descriptors are managed using add() or remove()
93 Scheduler::instance().add(handle, &callback);
94 Scheduler::instance().remove(handle);
97 The callback will be called with one additional argument. This argument is the event mask of
98 type EventId. This mask will tell, which of the registered events are signaled. The
99 additional flags EV_HUP or EV_ERR (on hangup or error condition) may be set additionally.
101 Only a single handler may be registered for any combination of file descriptor and event
102 (registering multiple callbacks for a single fd and event does not make sense).
104 The scheduler will accept any object as \a handle argument as long as retrieve_filehandle()
105 may be called on that object
107 int fd = retrieve_filehandle(handle);
109 to fetch the file handle given some abstract handle type. retrieve_filehandle() will be
110 found using ADL depending on the argument namespace. A default implementation is provided
111 for \c int arguments (file descriptors)
114 \section sched_timers Registering timers
116 The Scheduler has very simple timer support. There is only one type of timer: A single-shot
117 deadline timer. More complex timers are built based on this. Timers are managed using
118 timeout() and cancelTimeout()
120 int id = Scheduler::instance().timeout(Scheduler::instance().eventTime() + ClockService::milliseconds(100),
122 Scheduler::instance().cancelTimeout(id);
124 Timing is based on the ClockService, which provides a high resolution and strictly
125 monotonous time source. Registering a timeout will fire the callback when the target time is
126 reached. The timer may be canceled by passing the returned \a id to cancelTimeout().
128 There are two parameters which adjust the exact: \a timeoutEarly and \a timeoutAdjust. \a
129 timeoutEarly is the time, a callback may be called before the deadline time is
130 reached. Setting this value below the scheduling granularity of the kernel will have the
131 scheduler go into a <em>busy wait</em> (that is, an endless loop consuming 100% of CPU
132 recources) until the deadline time is reached! This is seldom desired. The default setting
133 of 11ms is adequate in most cases (it's slightly above the lowest linux scheduling
136 The other timeout scheduling parameter is \a timeoutAdjust. This value will be added to the
137 timeout value before calculating the next delay value thereby compensating for \a
138 timeoutEarly. By default, this value is set to 0 but may be changed if needed.
141 \section sched_signals Registering POSIX/UNIX signals
143 The Scheduler also incorporates standard POSIX/UNIX signals. Signals registered with the
144 scheduler will be handled \e synchronously within the event loop.
146 Scheduler::instance().registerSignal(SIGUSR1, &callback);
147 Scheduler::instance().unregisterSignal(SIGUSR1);
149 When registering a signal with the scheduler, that signal will automatically be blocked so
150 it can be handled within the scheduler.
152 A registered signal does \e not count as 'something to do'. It is therefore not possible to
153 wait for signals \e only.
155 \todo Fix EventId parameter (probably to int) to allow |-ing without casting ...
161 ///////////////////////////////////////////////////////////////////////////
164 /** \brief Types of file descriptor events */
165 enum EventId { EV_NONE=0,
166 EV_READ=1, EV_PRIO=2, EV_WRITE=4,
168 EV_HUP=8, EV_ERR=16 };
170 /** \brief Template typedef for Callback type
172 This is a template typedef (which does not exist in C++) that is, a template class whose
173 sole member is a typedef symbol defining the callback type given the handle type.
175 The Callback is any callable object taking a \c Handle and an \c EventId as argument.
176 template <class Handle>
177 struct GenericCallback {
178 typedef boost::function<void (typename boost::call_traits<Handle>::param_type,
183 typedef boost::function<void (EventId)> FdCallback;
185 /** \brief Callback type for timer events */
186 typedef boost::function<void ()> SimpleCallback;
188 ///////////////////////////////////////////////////////////////////////////
189 ///\name Structors and default members
192 // private default constructor
193 // no copy constructor
194 // no copy assignment
195 // default destructor
196 // no conversion constructors
198 /** \brief Return Scheduler instance
200 This static member is used to access the singleton instance. This member is save to
201 return a correctly initialized Scheduler instance even if called at global construction
204 \implementation This static member just defines the Scheduler as a static method
205 variable. The C++ standard then provides above guarantee. The instance will be
206 initialized the first time, the code flow passes the variable declaration found in
209 static Scheduler & instance();
212 ///////////////////////////////////////////////////////////////////////////
214 ///\name File Descriptors
217 template <class Handle>
218 void add(Handle const & handle, FdCallback const & cb,
219 int eventMask = EV_ALL); ///< Add file handle event callback
220 /**< add() will add a callback to the Scheduler. The
221 callback will be called for the given type of event on
222 the given arbitrary file-descriptor or
223 handle-like object. If there already is a Callback
224 registered for one of the events requested, the new
225 handler will replace the old one.
226 \param[in] handle file descriptor or handle providing
227 the Handle interface defined above.
228 \param[in] cb callback
229 \param[in] eventMask arbitrary combination via '|'
230 operator of EventId designators. */
231 template <class Handle>
232 void remove(Handle const & handle, int eventMask = EV_ALL); ///< Remove event callback
233 /**< remove() will remove any callback registered for any of
234 the given events on the given file descriptor or handle
236 \param[in] handle file descriptor or handle providing
237 the Handle interface defined above.
238 \param[in] eventMask arbitrary combination via '|'
239 operator of EventId designators. */
246 unsigned timeout(ClockService::clock_type timeout, SimpleCallback const & cb);
247 ///< Add timeout event
248 /**< \param[in] timeout timeout in nanoseconds
249 \param[in] cb callback to call after \a timeout
252 void cancelTimeout(unsigned id); ///< Cancel timeout \a id
254 ClockService::clock_type timeoutEarly() const;
255 ///< Fetch the \a timeoutEarly parameter
256 void timeoutEarly(ClockService::clock_type v);
257 ///< Set the \a timeoutEarly parameter
259 ClockService::clock_type timeoutAdjust() const;\
260 ///< Fetch the \a timeoutAdjust parameter
261 void timeoutAdjust(ClockService::clock_type v);
262 ///< Set the \a timeoutAdjust parameter
266 ///\name Signal handlers
269 void registerSignal(unsigned signal, SimpleCallback const & cb);
270 ///< Add signal handler
271 /**< \param[in] signal signal number to register handler for
272 \param[in] cb callback to call whenever \a signal is
275 void unregisterSignal(unsigned signal);
276 ///< Remove signal handler for \a signal
278 struct InvalidSignalNumberException : public std::exception
279 { virtual char const * what() const throw()
280 { return "senf::Scheduler::InvalidSignalNumberException"; } };
285 void process(); ///< Event handler main loop
286 /**< This member must be called at some time to enter the
287 event handler main loop. Only while this function is
288 running any events are handled. The call will return
289 only, if any callback calls terminate(). */
291 void terminate(); ///< Called by callbacks to terminate the main loop
292 /**< This member may be called by any callback to tell the
293 main loop to terminate. The main loop will return to
294 it's caller after the currently running callback
297 ClockService::clock_type eventTime() const; ///< Return date/time of last event
304 void do_add(int fd, FdCallback const & cb, int eventMask = EV_ALL);
305 void do_remove(int fd, int eventMask = EV_ALL);
307 void registerSigHandlers();
308 static void sigHandler(int signal, ::siginfo_t * siginfo, void *);
312 /** \brief Descriptor event specification
320 int epollMask() const;
323 /** \brief Timer event specification
327 TimerSpec() : timeout(), cb() {}
328 TimerSpec(ClockService::clock_type timeout_, SimpleCallback cb_, unsigned id_)
329 : timeout(timeout_), cb(cb_), id(id_), canceled(false) {}
331 bool operator< (TimerSpec const & other) const
332 { return timeout > other.timeout; }
334 ClockService::clock_type timeout;
342 typedef std::map<int,EventSpec> FdTable;
343 typedef std::map<unsigned,TimerSpec> TimerMap; // sorted by id
347 struct TimerSpecCompare
349 typedef TimerMap::iterator first_argument_type;
350 typedef TimerMap::iterator second_argument_type;
351 typedef bool result_type;
353 result_type operator()(first_argument_type a, second_argument_type b);
358 typedef std::priority_queue<TimerMap::iterator, std::vector<TimerMap::iterator>,
359 TimerSpecCompare> TimerQueue; // sorted by time
361 typedef std::vector<SimpleCallback> SigHandlers;
365 unsigned timerIdCounter_;
366 TimerQueue timerQueue_;
369 SigHandlers sigHandlers_;
375 ClockService::clock_type eventTime_;
376 ClockService::clock_type eventEarly_;
377 ClockService::clock_type eventAdjust_;
380 /** \brief Default file descriptor accessor
382 retrieve_filehandle() provides the Scheduler with support for explicit file descriptors as
383 file handle argument.
387 int retrieve_filehandle(int fd);
389 /** \brief Scheduler specific time source for Utils/Logger framework
391 This time source may be used to provide timing information for log messages within the
392 Utils/Logger framework. This time source will use Scheduler::eventTime() to provide timing
395 struct SchedulerLogTimeSource : public senf::log::TimeSource
397 boost::posix_time::ptime operator()() const;
402 ///////////////////////////////hh.e////////////////////////////////////////
403 #include "Scheduler.cci"
404 //#include "Scheduler.ct"
405 #include "Scheduler.cti"
412 // c-file-style: "senf"
413 // indent-tabs-mode: nil
414 // ispell-local-dictionary: "american"
415 // compile-command: "scons -u test"
416 // comment-column: 40