1 // event.cxx -- Flight Gear periodic event scheduler
3 // Written by Curtis Olson, started December 1997.
5 // Copyright (C) 1997 Curtis L. Olson - curt@infoplane.com
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 // (Log is kept at end of this file)
36 #if defined( HAVE_WINDOWS_H ) && defined(__MWERKS__)
37 # include <windows.h> // For Metrowerks environment
38 # include <winbase.h> // There is no ANSI/MSL time function that
39 // contains milliseconds
42 #if defined( linux ) || defined( __FreeBSD__ )
43 # define _G_NO_EXTERN_TEMPLATES
46 #include "Include/fg_stl_config.h"
47 #include STL_ALGORITHM
48 #include STL_FUNCTIONAL
50 #include <Debug/logstream.hxx>
55 fgEVENT_MGR global_events;
58 fgEVENT::fgEVENT( const string& desc,
73 fgEVENT::fgEVENT( const fgEVENT& evt )
74 : description(evt.description),
75 #ifdef _FG_NEED_AUTO_PTR
76 // Ugly - cast away const until proper auto_ptr implementation.
77 event_cb((auto_ptr<fgCallback>&)(evt.event_cb)),
79 event_cb(evt.event_cb),
82 interval(evt.interval),
83 last_run(evt.last_run),
85 next_run(evt.next_run),
86 cum_time(evt.cum_time),
87 min_time(evt.min_time),
88 max_time(evt.max_time),
95 // cout << "fgEVENT::~fgEVENT" << endl;
101 FG_LOG(FG_EVENT, FG_INFO, "Running " << description );
103 // record starting time
104 timestamp( &last_run );
107 event_cb->call( (void**)NULL );
109 // increment the counter for this event
112 // update the event status
113 status = FG_EVENT_READY;
115 // calculate duration and stats
116 timestamp( ¤t );
117 long duration = timediff( &last_run, ¤t );
119 cum_time += duration;
121 if ( duration < min_time ) {
125 if ( duration > max_time ) {
129 // determine the next absolute run time
130 timesum( &next_run, &last_run, interval );
134 // Dump scheduling stats
136 fgEVENT::PrintStats() const
138 FG_LOG( FG_EVENT, FG_INFO,
140 << " int=" << interval / 1000.0
141 << " cum=" << cum_time
142 << " min=" << min_time
143 << " max=" << max_time
144 << " count=" << count
145 << " ave=" << cum_time / (double)count );
150 fgEVENT_MGR::fgEVENT_MGR( void ) {
154 // Initialize the scheduling subsystem
155 void fgEVENT_MGR::Init( void ) {
156 FG_LOG(FG_EVENT, FG_INFO, "Initializing event manager" );
158 run_queue.erase( run_queue.begin(), run_queue.end() );
159 event_table.erase( event_table.begin(), event_table.end() );
163 // Register an event with the scheduler.
165 fgEVENT_MGR::Register( const string& desc,
166 const fgCallback& cb,
167 fgEVENT::EventState status,
170 fgEVENT e( desc, cb, status, interval );
172 FG_LOG( FG_EVENT, FG_INFO, "Registering event: " << desc );
174 // Actually run the event
177 // Now add to event_table
178 event_table.push_back(e);
182 // Update the scheduling parameters for an event
183 void fgEVENT_MGR::Update( void ) {
187 // Delete a scheduled event
188 void fgEVENT_MGR::Delete( void ) {
192 // Temporarily suspend scheduling of an event
193 void fgEVENT_MGR::Suspend( void ) {
197 // Resume scheduling and event
198 void fgEVENT_MGR::Resume( void ) {
201 // Dump scheduling stats
203 fgEVENT_MGR::PrintStats()
205 FG_LOG( FG_EVENT, FG_INFO, "" );
206 FG_LOG( FG_EVENT, FG_INFO, "Event Stats" );
207 FG_LOG( FG_EVENT, FG_INFO, "-----------" );
209 for_each( event_table.begin(),
211 mem_fun_ref( &fgEVENT::PrintStats ));
213 FG_LOG( FG_EVENT, FG_INFO, "");
217 // Add pending jobs to the run queue and run the job at the front of
219 void fgEVENT_MGR::Process( void ) {
221 fg_timestamp cur_time;
222 unsigned int i, size;
224 FG_LOG( FG_EVENT, FG_DEBUG, "Processing events" );
226 // get the current time
227 timestamp(&cur_time);
229 FG_LOG( FG_EVENT, FG_DEBUG,
230 " Current timestamp = " << cur_time.seconds );
232 // printf("Checking if anything is ready to move to the run queue\n");
234 // see if anything else is ready to be placed on the run queue
235 size = event_table.size();
236 // while ( current != last ) {
237 for ( i = 0; i < size; i++ ) {
239 e_ptr = &event_table[i];
240 if ( e_ptr->status == fgEVENT::FG_EVENT_READY ) {
241 FG_LOG( FG_EVENT, FG_DEBUG,
242 " Item " << i << " current " << cur_time.seconds
243 << " next run @ " << e_ptr->next_run.seconds );
244 if ( timediff(&cur_time, &(e_ptr->next_run)) <= 0) {
245 run_queue.push_back(e_ptr);
246 e_ptr->status = fgEVENT::FG_EVENT_QUEUED;
251 // Checking to see if there is anything on the run queue
252 // printf("Checking to see if there is anything on the run queue\n");
253 if ( run_queue.size() ) {
254 // printf("Yep, running it\n");
255 e_ptr = run_queue.front();
256 run_queue.pop_front();
263 fgEVENT_MGR::~fgEVENT_MGR( void ) {
268 // Revision 1.12 1998/11/23 21:49:07 curt
269 // Borland portability tweaks.
271 // Revision 1.11 1998/11/09 23:41:51 curt
272 // Log message clean ups.
274 // Revision 1.10 1998/11/07 19:07:13 curt
275 // Enable release builds using the --without-logging option to the configure
276 // script. Also a couple log message cleanups, plus some C to C++ comment
279 // Revision 1.9 1998/11/06 21:18:24 curt
280 // Converted to new logstream debugging facility. This allows release
281 // builds with no messages at all (and no performance impact) by using
282 // the -DFG_NDEBUG flag.
284 // Revision 1.8 1998/09/15 02:09:29 curt
285 // Include/fg_callback.hxx
286 // Moved code inline to stop g++ 2.7 from complaining.
288 // Simulator/Time/event.[ch]xx
289 // Changed return type of fgEVENT::printStat(). void caused g++ 2.7 to
290 // complain bitterly.
292 // Minor bugfix and changes.
294 // Simulator/Main/GLUTmain.cxx
295 // Added missing type to idle_state definition - eliminates a warning.
297 // Simulator/Main/fg_init.cxx
298 // Changes to airport lookup.
300 // Simulator/Main/options.cxx
301 // Uses fg_gzifstream when loading config file.
303 // Revision 1.7 1998/08/29 13:11:31 curt
304 // Bernie Bright writes:
305 // I've created some new classes to enable pointers-to-functions and
306 // pointers-to-class-methods to be treated like objects. These objects
307 // can be registered with fgEVENT_MGR.
309 // File "Include/fg_callback.hxx" contains the callback class defns.
311 // Modified fgEVENT and fgEVENT_MGR to use the callback classes. Also
312 // some minor tweaks to STL usage.
314 // Added file "Include/fg_stl_config.h" to deal with STL portability
315 // issues. I've added an initial config for egcs (and probably gcc-2.8.x).
316 // I don't have access to Visual C++ so I've left that for someone else.
317 // This file is influenced by the stl_config.h file delivered with egcs.
319 // Added "Include/auto_ptr.hxx" which contains an implementation of the
320 // STL auto_ptr class which is not provided in all STL implementations
321 // and is needed to use the callback classes.
323 // Deleted fgLightUpdate() which was just a wrapper to call
324 // fgLIGHT::Update().
326 // Modified fg_init.cxx to register two method callbacks in place of the
327 // old wrapper functions.
329 // Revision 1.6 1998/08/20 15:12:26 curt
332 // Revision 1.5 1998/06/12 00:59:52 curt
333 // Build only static libraries.
334 // Declare memmove/memset for Sloaris.
335 // Rewrote fg_time.c routine to get LST start seconds to better handle
336 // Solaris, and be easier to port, and understand the GMT vs. local
339 // Revision 1.4 1998/06/05 18:18:12 curt
340 // Incorporated some automake conditionals to try to support mktime() correctly
341 // on a wider variety of platforms.
342 // Added the declaration of memmove needed by the stl which apparently
343 // solaris only defines for cc compilations and not for c++ (__STDC__)
345 // Revision 1.3 1998/05/22 21:14:53 curt
346 // Rewrote event.cxx in C++ as a class using STL for the internal event list
347 // and run queue this removes the arbitrary list sizes and makes things much
348 // more dynamic. Because this is C++-classified we can now have multiple
349 // event_tables if we'd ever want them.
351 // Revision 1.2 1998/04/25 22:06:33 curt
352 // Edited cvs log messages in source files ... bad bad bad!
354 // Revision 1.1 1998/04/24 00:52:26 curt
355 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
357 // Separated out lighting calcs into their own file.
359 // Revision 1.13 1998/04/18 04:14:08 curt
360 // Moved fg_debug.c to it's own library.
362 // Revision 1.12 1998/04/09 18:40:13 curt
363 // We had unified some of the platform disparate time handling code, and
364 // there was a bug in timesum() which calculated a new time stamp based on
365 // the current time stamp + offset. This hosed the periodic event processing
366 // logic because you'd never arrive at the time the event was scheduled for.
367 // Sky updates and lighting changes are handled via this event mechanism so
368 // they never changed ... it is fixed now.
370 // Revision 1.11 1998/04/03 22:12:55 curt
371 // Converting to Gnu autoconf system.
372 // Centralized time handling differences.
374 // Revision 1.10 1998/03/14 00:28:34 curt
375 // replaced a printf() with an fgPrintf().
377 // Revision 1.9 1998/01/31 00:43:44 curt
378 // Added MetroWorks patches from Carmen Volpe.
380 // Revision 1.8 1998/01/27 00:48:05 curt
381 // Incorporated Paul Bleisch's <pbleisch@acm.org> new debug message
382 // system and commandline/config file processing code.
384 // Revision 1.7 1998/01/19 19:27:19 curt
385 // Merged in make system changes from Bob Kuehne <rpk@sgi.com>
386 // This should simplify things tremendously.
388 // Revision 1.6 1998/01/19 18:40:39 curt
389 // Tons of little changes to clean up the code and to remove fatal errors
390 // when building with the c++ compiler.
392 // Revision 1.5 1998/01/06 01:20:27 curt
393 // Tweaks to help building with MSVC++
395 // Revision 1.4 1997/12/31 17:46:50 curt
396 // Tweaked fg_time.c to be able to use ftime() instead of gettimeofday()
398 // Revision 1.3 1997/12/30 22:22:42 curt
399 // Further integration of event manager.
401 // Revision 1.2 1997/12/30 20:47:58 curt
402 // Integrated new event manager with subsystem initializations.
404 // Revision 1.1 1997/12/30 04:19:22 curt