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 #include "Include/fg_stl_config.h"
43 #include STL_ALGORITHM
44 #include STL_FUNCTIONAL
46 #include <Debug/logstream.hxx>
51 fgEVENT_MGR global_events;
54 fgEVENT::fgEVENT( const string& desc,
69 fgEVENT::fgEVENT( const fgEVENT& evt )
70 : description(evt.description),
71 #ifdef _FG_NEED_AUTO_PTR
72 // Ugly - cast away const until proper auto_ptr implementation.
73 event_cb((auto_ptr<fgCallback>&)(evt.event_cb)),
75 event_cb(evt.event_cb),
78 interval(evt.interval),
79 last_run(evt.last_run),
81 next_run(evt.next_run),
82 cum_time(evt.cum_time),
83 min_time(evt.min_time),
84 max_time(evt.max_time),
91 // cout << "fgEVENT::~fgEVENT" << endl;
97 FG_LOG(FG_TIME, FG_INFO, "Running " << description );
99 // record starting time
100 timestamp( &last_run );
103 event_cb->call( (void**)NULL );
105 // increment the counter for this event
108 // update the event status
109 status = FG_EVENT_READY;
111 // calculate duration and stats
112 timestamp( ¤t );
113 long duration = timediff( &last_run, ¤t );
115 cum_time += duration;
117 if ( duration < min_time ) {
121 if ( duration > max_time ) {
125 // determine the next absolute run time
126 timesum( &next_run, &last_run, interval );
130 // Dump scheduling stats
132 fgEVENT::PrintStats() const
134 FG_LOG( FG_TIME, FG_INFO,
136 << " int=" << interval / 1000.0
137 << " cum=" << cum_time
138 << " min=" << min_time
139 << " max=" << max_time
140 << " count=" << count
141 << " ave=" << cum_time / (double)count );
146 fgEVENT_MGR::fgEVENT_MGR( void ) {
150 // Initialize the scheduling subsystem
151 void fgEVENT_MGR::Init( void ) {
152 FG_LOG(FG_TIME, FG_INFO, "Initializing event manager" );
154 run_queue.erase( run_queue.begin(), run_queue.end() );
155 event_table.erase( event_table.begin(), event_table.end() );
159 // Register an event with the scheduler.
161 fgEVENT_MGR::Register( const string& desc,
162 const fgCallback& cb,
163 fgEVENT::EventState status,
166 fgEVENT e( desc, cb, status, interval );
168 FG_LOG( FG_TIME, FG_INFO, "Registering event: " << desc );
170 // Actually run the event
173 // Now add to event_table
174 event_table.push_back(e);
178 // Update the scheduling parameters for an event
179 void fgEVENT_MGR::Update( void ) {
183 // Delete a scheduled event
184 void fgEVENT_MGR::Delete( void ) {
188 // Temporarily suspend scheduling of an event
189 void fgEVENT_MGR::Suspend( void ) {
193 // Resume scheduling and event
194 void fgEVENT_MGR::Resume( void ) {
197 // Dump scheduling stats
199 fgEVENT_MGR::PrintStats()
201 FG_LOG( FG_TIME, FG_INFO, "" );
202 FG_LOG( FG_TIME, FG_INFO, "Event Stats" );
203 FG_LOG( FG_TIME, FG_INFO, "-----------" );
205 for_each( event_table.begin(),
207 mem_fun_ref( &fgEVENT::PrintStats ));
209 FG_LOG( FG_TIME, FG_INFO, "");
213 // Add pending jobs to the run queue and run the job at the front of
215 void fgEVENT_MGR::Process( void ) {
217 fg_timestamp cur_time;
218 unsigned int i, size;
220 FG_LOG( FG_EVENT, FG_DEBUG, "Processing events" );
222 // get the current time
223 timestamp(&cur_time);
225 FG_LOG( FG_EVENT, FG_DEBUG,
226 " Current timestamp = " << cur_time.seconds );
228 // printf("Checking if anything is ready to move to the run queue\n");
230 // see if anything else is ready to be placed on the run queue
231 size = event_table.size();
232 // while ( current != last ) {
233 for ( i = 0; i < size; i++ ) {
235 e_ptr = &event_table[i];
236 if ( e_ptr->status == fgEVENT::FG_EVENT_READY ) {
237 FG_LOG( FG_EVENT, FG_DEBUG,
238 " Item " << i << " current " << cur_time.seconds
239 << " next run @ " << e_ptr->next_run.seconds );
240 if ( timediff(&cur_time, &(e_ptr->next_run)) <= 0) {
241 run_queue.push_back(e_ptr);
242 e_ptr->status = fgEVENT::FG_EVENT_QUEUED;
247 // Checking to see if there is anything on the run queue
248 // printf("Checking to see if there is anything on the run queue\n");
249 if ( run_queue.size() ) {
250 // printf("Yep, running it\n");
251 e_ptr = run_queue.front();
252 run_queue.pop_front();
259 fgEVENT_MGR::~fgEVENT_MGR( void ) {
264 // Revision 1.10 1998/11/07 19:07:13 curt
265 // Enable release builds using the --without-logging option to the configure
266 // script. Also a couple log message cleanups, plus some C to C++ comment
269 // Revision 1.9 1998/11/06 21:18:24 curt
270 // Converted to new logstream debugging facility. This allows release
271 // builds with no messages at all (and no performance impact) by using
272 // the -DFG_NDEBUG flag.
274 // Revision 1.8 1998/09/15 02:09:29 curt
275 // Include/fg_callback.hxx
276 // Moved code inline to stop g++ 2.7 from complaining.
278 // Simulator/Time/event.[ch]xx
279 // Changed return type of fgEVENT::printStat(). void caused g++ 2.7 to
280 // complain bitterly.
282 // Minor bugfix and changes.
284 // Simulator/Main/GLUTmain.cxx
285 // Added missing type to idle_state definition - eliminates a warning.
287 // Simulator/Main/fg_init.cxx
288 // Changes to airport lookup.
290 // Simulator/Main/options.cxx
291 // Uses fg_gzifstream when loading config file.
293 // Revision 1.7 1998/08/29 13:11:31 curt
294 // Bernie Bright writes:
295 // I've created some new classes to enable pointers-to-functions and
296 // pointers-to-class-methods to be treated like objects. These objects
297 // can be registered with fgEVENT_MGR.
299 // File "Include/fg_callback.hxx" contains the callback class defns.
301 // Modified fgEVENT and fgEVENT_MGR to use the callback classes. Also
302 // some minor tweaks to STL usage.
304 // Added file "Include/fg_stl_config.h" to deal with STL portability
305 // issues. I've added an initial config for egcs (and probably gcc-2.8.x).
306 // I don't have access to Visual C++ so I've left that for someone else.
307 // This file is influenced by the stl_config.h file delivered with egcs.
309 // Added "Include/auto_ptr.hxx" which contains an implementation of the
310 // STL auto_ptr class which is not provided in all STL implementations
311 // and is needed to use the callback classes.
313 // Deleted fgLightUpdate() which was just a wrapper to call
314 // fgLIGHT::Update().
316 // Modified fg_init.cxx to register two method callbacks in place of the
317 // old wrapper functions.
319 // Revision 1.6 1998/08/20 15:12:26 curt
322 // Revision 1.5 1998/06/12 00:59:52 curt
323 // Build only static libraries.
324 // Declare memmove/memset for Sloaris.
325 // Rewrote fg_time.c routine to get LST start seconds to better handle
326 // Solaris, and be easier to port, and understand the GMT vs. local
329 // Revision 1.4 1998/06/05 18:18:12 curt
330 // Incorporated some automake conditionals to try to support mktime() correctly
331 // on a wider variety of platforms.
332 // Added the declaration of memmove needed by the stl which apparently
333 // solaris only defines for cc compilations and not for c++ (__STDC__)
335 // Revision 1.3 1998/05/22 21:14:53 curt
336 // Rewrote event.cxx in C++ as a class using STL for the internal event list
337 // and run queue this removes the arbitrary list sizes and makes things much
338 // more dynamic. Because this is C++-classified we can now have multiple
339 // event_tables if we'd ever want them.
341 // Revision 1.2 1998/04/25 22:06:33 curt
342 // Edited cvs log messages in source files ... bad bad bad!
344 // Revision 1.1 1998/04/24 00:52:26 curt
345 // Wrapped "#include <config.h>" in "#ifdef HAVE_CONFIG_H"
347 // Separated out lighting calcs into their own file.
349 // Revision 1.13 1998/04/18 04:14:08 curt
350 // Moved fg_debug.c to it's own library.
352 // Revision 1.12 1998/04/09 18:40:13 curt
353 // We had unified some of the platform disparate time handling code, and
354 // there was a bug in timesum() which calculated a new time stamp based on
355 // the current time stamp + offset. This hosed the periodic event processing
356 // logic because you'd never arrive at the time the event was scheduled for.
357 // Sky updates and lighting changes are handled via this event mechanism so
358 // they never changed ... it is fixed now.
360 // Revision 1.11 1998/04/03 22:12:55 curt
361 // Converting to Gnu autoconf system.
362 // Centralized time handling differences.
364 // Revision 1.10 1998/03/14 00:28:34 curt
365 // replaced a printf() with an fgPrintf().
367 // Revision 1.9 1998/01/31 00:43:44 curt
368 // Added MetroWorks patches from Carmen Volpe.
370 // Revision 1.8 1998/01/27 00:48:05 curt
371 // Incorporated Paul Bleisch's <pbleisch@acm.org> new debug message
372 // system and commandline/config file processing code.
374 // Revision 1.7 1998/01/19 19:27:19 curt
375 // Merged in make system changes from Bob Kuehne <rpk@sgi.com>
376 // This should simplify things tremendously.
378 // Revision 1.6 1998/01/19 18:40:39 curt
379 // Tons of little changes to clean up the code and to remove fatal errors
380 // when building with the c++ compiler.
382 // Revision 1.5 1998/01/06 01:20:27 curt
383 // Tweaks to help building with MSVC++
385 // Revision 1.4 1997/12/31 17:46:50 curt
386 // Tweaked fg_time.c to be able to use ftime() instead of gettimeofday()
388 // Revision 1.3 1997/12/30 22:22:42 curt
389 // Further integration of event manager.
391 // Revision 1.2 1997/12/30 20:47:58 curt
392 // Integrated new event manager with subsystem initializations.
394 // Revision 1.1 1997/12/30 04:19:22 curt