Scheduler/Scheduler.hh

   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 public header
  25  */
  26
  27 #ifndef HH_Scheduler_
  28 #define HH_Scheduler_ 1
  29
  30 // Custom includes
  31 #include <signal.h>
  32 #include <setjmp.h>
  33 #include <map>
  34 #include <queue>
  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/SenfLog.hh"
  41
  42 //#include "scheduler.mpp"
  43 ///////////////////////////////hh.p////////////////////////////////////////
  44
  45 /** \brief SENF Project namespace */
  46 namespace senf {
  47
  48     /** \brief Singleton class to manage the event loop
  49
  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
  53         \li Timeouts
  54         \li UNIX Signals
  55
  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.
  59
  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
  62         timers of the PPI).
  63
  64
  65         \section sched_handlers Specifying handlers
  66
  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.
  71
  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>:
  74         \code
  75         // Handle callback function
  76         void callback(UDPv4ClientSocketHandle handle, senf::Scheduler::EventId event) {..}
  77         // Pass 'handle' as additional first argument to callback()
  78         Scheduler::instance().add(handle, boost::bind(&callback, handle, _1), EV_READ)
  79          // Timeout function
  80         void timeout( int n) {..}
  81         // Call timeout() handler with argument 'n'
  82         Scheduler::instance().timeout(boost::bind(&timeout, n))
  83         \endcode
  84
  85         To use member-functions as callbacks, use either <a
  86         href="http://www.boost.org/libs/bind/bind.html">Boost.Bind</a> or senf::membind()
  87         \code
  88         // e.g. in Foo::Foo() constructor:
  89         Scheduler::instance().add(handle_, senf::membind(&Foo::callback, this)), EV_READ)
  90         \endcode
  91
  92
  93         \section sched_fd Registering file descriptors
  94
  95         File descriptors are managed using add() or remove()
  96         \code
  97         Scheduler::instance().add(handle, &callback, EV_ALL);
  98         Scheduler::instance().remove(handle);
  99         \endcode
 100
 101         The callback will be called with one additional argument. This argument is the event mask of
 102         type EventId. This mask will tell, which of the registered events are signaled. The
 103         additional flags EV_HUP or EV_ERR (on hangup or error condition) may be set additionally.
 104
 105         Only a single handler may be registered for any combination of file descriptor and event
 106         (registering multiple callbacks for a single fd and event does not make sense).
 107
 108         The %scheduler will accept any object as \a handle argument as long as retrieve_filehandle()
 109         may be called on that object
 110         \code
 111         int fd = retrieve_filehandle(handle);
 112         \endcode
 113         to fetch the file handle given some abstract handle type. retrieve_filehandle() will be
 114         found using ADL depending on the argument namespace. A default implementation is provided
 115         for \c int arguments (file descriptors)
 116
 117
 118         \section sched_timers Registering timers
 119
 120         The %scheduler has very simple timer support. There is only one type of timer: A single-shot
 121         deadline timer. More complex timers are built based on this. Timers are managed using
 122         timeout() and cancelTimeout()
 123         \code
 124         int id = Scheduler::instance().timeout(Scheduler::instance().eventTime() + ClockService::milliseconds(100),
 125                                                &callback);
 126         Scheduler::instance().cancelTimeout(id);
 127         \endcode
 128         Timing is based on the ClockService, which provides a high resolution and strictly
 129         monotonous time source. Registering a timeout will fire the callback when the target time is
 130         reached. The timer may be canceled by passing the returned \a id to cancelTimeout().
 131
 132         There are two parameters which adjust the exact: \a timeoutEarly and \a timeoutAdjust. \a
 133         timeoutEarly is the time, a callback may be called before the deadline time is
 134         reached. Setting this value below the scheduling granularity of the kernel will have the
 135         %scheduler go into a <em>busy wait</em> (that is, an endless loop consuming 100% of CPU
 136         recources) until the deadline time is reached! This is seldom desired. The default setting
 137         of 11ms is adequate in most cases (it's slightly above the lowest linux scheduling
 138         granularity).
 139
 140         The other timeout scheduling parameter is \a timeoutAdjust. This value will be added to the
 141         timeout value before calculating the next delay value thereby compensating for \a
 142         timeoutEarly. By default, this value is set to 0 but may be changed if needed.
 143
 144
 145         \section sched_signals Registering POSIX/UNIX signals
 146
 147         The %scheduler also incorporates standard POSIX/UNIX signals. Signals registered with the
 148         %scheduler will be handled \e synchronously within the event loop.
 149         \code
 150         Scheduler::instance().registerSignal(SIGUSR1, &callback);
 151         Scheduler::instance().unregisterSignal(SIGUSR1);
 152         \endcode
 153         When registering a signal with the %scheduler, that signal will automatically be blocked so
 154         it can be handled within the %scheduler.
 155
 156         A registered signal does \e not count as 'something to do'. It is therefore not possible to
 157         wait for signals \e only.
 158
 159         \todo Fix EventId parameter (probably to int) to allow |-ing without casting ...
 160
 161         \todo Fix the file support to use threads (?) fork (?) and a pipe so it works reliably even
 162             over e.g. NFS.
 163       */
 164     class Scheduler
 165         : boost::noncopyable
 166     {
 167     public:
 168
 169         SENF_LOG_CLASS_AREA();
 170
 171         ///////////////////////////////////////////////////////////////////////////
 172         // Types
 173
 174         /** \brief Types of file descriptor events
 175
 176             These events are grouped into to classes:
 177             \li Ordinary file descriptor events for which handlers may be registered. These are
 178                 EV_READ, EV_PRIO and EV_WRITE. EV_ALL is a combination of these three.
 179             \li Error flags. These additional flags may be passed to a handler to pass an error
 180                 condition to the handler.
 181          */
 182         enum EventId {
 183             EV_NONE  =  0   /**< No event */
 184           , EV_READ  =  1   /**< File descriptor is readable */
 185           , EV_PRIO  =  2   /**< File descriptor has OOB data */
 186           , EV_WRITE =  4   /**< File descriptor is writable */
 187           , EV_ALL   =  7   /**< Used to register all events at once (read/prio/write) */
 188           , EV_HUP   =  8   /**< Hangup condition on file handle */
 189           , EV_ERR   = 16   /**< Error condition on file handle */
 190         };
 191
 192         /** \brief Template typedef for Callback type
 193
 194             This is a template typedef (which does not exist in C++) that is, a template class whose
 195             sole member is a typedef symbol defining the callback type given the handle type.
 196
 197             The Callback is any callable object taking a \c Handle and an \c EventId as argument.
 198             \code
 199             template <class Handle>
 200             struct GenericCallback {
 201                 typedef boost::function<void (typename boost::call_traits<Handle>::param_type,
 202                                               EventId) > Callback;
 203             };
 204             \endcode
 205          */
 206         typedef boost::function<void (EventId)> FdCallback;
 207
 208         /** \brief Callback type for timer events */
 209         typedef boost::function<void ()> SimpleCallback;
 210
 211         ///////////////////////////////////////////////////////////////////////////
 212         ///\name Structors and default members
 213         ///@{
 214
 215         // private default constructor
 216         // no copy constructor
 217         // no copy assignment
 218         // default destructor
 219         // no conversion constructors
 220
 221         /** \brief Return %scheduler instance
 222
 223             This static member is used to access the singleton instance. This member is save to
 224             return a correctly initialized %scheduler instance even if called at global construction
 225             time
 226
 227             \implementation This static member just defines the %scheduler as a static method
 228                 variable. The C++ standard then provides above guarantee. The instance will be
 229                 initialized the first time, the code flow passes the variable declaration found in
 230                 the instance() body.
 231          */
 232         static Scheduler & instance();
 233
 234         ///@}
 235         ///////////////////////////////////////////////////////////////////////////
 236
 237         ///\name File Descriptors
 238         ///\{
 239
 240         template <class Handle>
 241         void add(Handle const & handle, FdCallback const & cb,
 242                  int eventMask = EV_ALL); ///< Add file handle event callback
 243                                         /**< add() will add a callback to the %scheduler. The
 244                                              callback will be called for the given type of event on
 245                                              the given  arbitrary file-descriptor or
 246                                              handle-like object. If there already is a Callback
 247                                              registered for one of the events requested, the new
 248                                              handler will replace the old one.
 249                                              \param[in] handle file descriptor or handle providing
 250                                                  the Handle interface defined above.
 251                                              \param[in] cb callback
 252                                              \param[in] eventMask arbitrary combination via '|'
 253                                                  operator of \ref senf::Scheduler::EventId "EventId"
 254                                                  designators. */
 255         template <class Handle>
 256         void remove(Handle const & handle, int eventMask = EV_ALL); ///< Remove event callback
 257                                         /**< remove() will remove any callback registered for any of
 258                                              the given events on the given file descriptor or handle
 259                                              like object.
 260                                              \param[in] handle file descriptor or handle providing
 261                                                  the Handle interface defined above.
 262                                              \param[in] eventMask arbitrary combination via '|'
 263                                                  operator of \ref senf::Scheduler::EventId "EventId"
 264                                                  designators. */
 265         ///\}
 266
 267         ///\name Timeouts
 268         ///\{
 269
 270         unsigned timeout(ClockService::clock_type timeout, SimpleCallback const & cb);
 271                                         ///< Add timeout event
 272                                         /**< \param[in] timeout timeout in nanoseconds
 273                                              \param[in] cb callback to call after \a timeout
 274                                                  milliseconds */
 275
 276         void cancelTimeout(unsigned id); ///< Cancel timeout \a id
 277
 278         ClockService::clock_type timeoutEarly() const;
 279                                         ///< Fetch the \a timeoutEarly parameter
 280         void timeoutEarly(ClockService::clock_type v);
 281                                         ///< Set the \a timeoutEarly parameter
 282
 283         ClockService::clock_type timeoutAdjust() const;\
 284                                         ///< Fetch the \a timeoutAdjust parameter
 285         void timeoutAdjust(ClockService::clock_type v);
 286                                         ///< Set the \a timeoutAdjust parameter
 287
 288         ///\}
 289
 290         ///\name Signal handlers
 291         ///\{
 292
 293         void registerSignal(unsigned signal, SimpleCallback const & cb);
 294                                         ///< Add signal handler
 295                                         /**< \param[in] signal signal number to register handler for
 296                                              \param[in] cb callback to call whenever \a signal is
 297                                                  delivered. */
 298
 299         void unregisterSignal(unsigned signal);
 300                                         ///< Remove signal handler for \a signal
 301
 302         /// The signal number passed to registerSignal or unregisterSignal is invalid
 303         struct InvalidSignalNumberException : public senf::Exception
 304         { InvalidSignalNumberException()
 305               : senf::Exception("senf::Scheduler::InvalidSignalNumberException"){} };
 306
 307
 308         ///\}
 309
 310         void process();                 ///< Event handler main loop
 311                                         /**< This member must be called at some time to enter the
 312                                              event handler main loop. Only while this function is
 313                                              running any events are handled. The call will return
 314                                              only, if any callback calls terminate(). */
 315
 316         void terminate();               ///< Called by callbacks to terminate the main loop
 317                                         /**< This member may be called by any callback to tell the
 318                                              main loop to terminate. The main loop will return to
 319                                              it's caller after the currently running callback
 320                                              returns. */
 321
 322         ClockService::clock_type eventTime() const; ///< Return date/time of last event
 323
 324     protected:
 325
 326     private:
 327         Scheduler();
 328
 329         void do_add(int fd, FdCallback const & cb, int eventMask = EV_ALL);
 330         void do_remove(int fd, int eventMask = EV_ALL);
 331
 332         void registerSigHandlers();
 333         static void sigHandler(int signal, ::siginfo_t * siginfo, void *);
 334
 335 #       ifndef DOXYGEN
 336
 337         /** \brief Descriptor event specification
 338             \internal */
 339         struct EventSpec
 340         {
 341             FdCallback cb_read;
 342             FdCallback cb_prio;
 343             FdCallback cb_write;
 344
 345             EventSpec() : file(false) {}
 346
 347             int epollMask() const;
 348
 349             bool file;
 350         };
 351
 352         /** \brief Timer event specification
 353             \internal */
 354         struct TimerSpec
 355         {
 356             TimerSpec() : timeout(), cb() {}
 357             TimerSpec(ClockService::clock_type timeout_, SimpleCallback cb_, unsigned id_)
 358                 : timeout(timeout_), cb(cb_), id(id_), canceled(false) {}
 359
 360             bool operator< (TimerSpec const & other) const
 361                 { return timeout > other.timeout; }
 362
 363             ClockService::clock_type timeout;
 364             SimpleCallback cb;
 365             unsigned id;
 366             bool canceled;
 367         };
 368
 369 #       endif
 370
 371         typedef std::map<int,EventSpec> FdTable;
 372         typedef std::map<unsigned,TimerSpec> TimerMap; // sorted by id
 373         typedef std::vector<unsigned> FdEraseList;
 374
 375 #       ifndef DOXYGEN
 376
 377         struct TimerSpecCompare
 378         {
 379             typedef TimerMap::iterator first_argument_type;
 380             typedef TimerMap::iterator second_argument_type;
 381             typedef bool result_type;
 382
 383             result_type operator()(first_argument_type a, second_argument_type b);
 384         };
 385
 386 #       endif
 387
 388         typedef std::priority_queue<TimerMap::iterator, std::vector<TimerMap::iterator>,
 389                                     TimerSpecCompare> TimerQueue; // sorted by time
 390
 391         typedef std::vector<SimpleCallback> SigHandlers;
 392
 393         FdTable fdTable_;
 394         FdEraseList fdErase_;
 395         unsigned files_;
 396
 397         unsigned timerIdCounter_;
 398         TimerQueue timerQueue_;
 399         TimerMap timerMap_;
 400
 401         SigHandlers sigHandlers_;
 402         ::sigset_t sigset_;
 403         int sigpipe_[2];
 404
 405         int epollFd_;
 406         bool terminate_;
 407         ClockService::clock_type eventTime_;
 408         ClockService::clock_type eventEarly_;
 409         ClockService::clock_type eventAdjust_;
 410     };
 411
 412     /** \brief Default file descriptor accessor
 413
 414         retrieve_filehandle() provides the %scheduler with support for explicit file descriptors as
 415         file handle argument.
 416
 417         \relates Scheduler
 418      */
 419     int retrieve_filehandle(int fd);
 420
 421     /** \brief %scheduler specific time source for Utils/Logger framework
 422
 423         This time source may be used to provide timing information for log messages within the
 424         Utils/Logger framework. This time source will use Scheduler::eventTime() to provide timing
 425         information.
 426      */
 427     struct SchedulerLogTimeSource : public senf::log::TimeSource
 428     {
 429         boost::posix_time::ptime operator()() const;
 430     };
 431
 432 }
 433
 434 ///////////////////////////////hh.e////////////////////////////////////////
 435 #include "Scheduler.cci"
 436 //#include "Scheduler.ct"
 437 #include "Scheduler.cti"
 438 #endif
 439
 440 \f
 441 // Local Variables:
 442 // mode: c++
 443 // fill-column: 100
 444 // c-file-style: "senf"
 445 // indent-tabs-mode: nil
 446 // ispell-local-dictionary: "american"
 447 // compile-command: "scons -u test"
 448 // comment-column: 40
 449 // End: