1 // Written by David Megginson, started 2000-12
3 // Copyright (C) 2000 David Megginson, david@megginson.com
5 // This program is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU General Public License as
7 // published by the Free Software Foundation; either version 2 of the
8 // License, or (at your option) any later version.
10 // This program is distributed in the hope that it will be useful, but
11 // WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with this program; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 # include <simgear_config.h>
25 #include <simgear/debug/logstream.hxx>
26 #include <simgear/timing/timestamp.hxx>
28 #include "exception.hxx"
29 #include "subsystem_mgr.hxx"
31 #include <simgear/math/SGMath.hxx>
32 #include "SGSmplstat.hxx"
34 const int SG_MAX_SUBSYSTEM_EXCEPTIONS = 4;
38 ////////////////////////////////////////////////////////////////////////
39 // Implementation of SGSubsystem
40 ////////////////////////////////////////////////////////////////////////
42 SGSubsystemTimingCb SGSubsystem::reportTimingCb = NULL;
43 void* SGSubsystem::reportTimingUserData = NULL;
45 SGSubsystem::SGSubsystem ()
50 SGSubsystem::~SGSubsystem ()
59 SGSubsystem::InitStatus
60 SGSubsystem::incrementalInit ()
67 SGSubsystem::postinit ()
72 SGSubsystem::reinit ()
77 SGSubsystem::shutdown ()
87 SGSubsystem::unbind ()
92 SGSubsystem::suspend ()
98 SGSubsystem::suspend (bool suspended)
100 _suspended = suspended;
104 SGSubsystem::resume ()
110 SGSubsystem::is_suspended () const
115 void SGSubsystem::stamp(const string& name)
117 timingInfo.push_back(TimingInfo(name, SGTimeStamp::now()));
120 ////////////////////////////////////////////////////////////////////////
121 // Implementation of SGSubsystemGroup.
122 ////////////////////////////////////////////////////////////////////////
124 class SGSubsystemGroup::Member
127 Member (const Member &member);
132 virtual void update (double delta_time_sec);
134 void reportTiming(void) { if (reportTimingCb) reportTimingCb(reportTimingUserData, name, &timeStat); }
135 void updateExecutionTime(double time) { timeStat += time;}
137 SampleStatistic timeStat;
139 SGSharedPtr<SGSubsystem> subsystem;
142 bool collectTimeStats;
149 SGSubsystemGroup::SGSubsystemGroup () :
150 _fixedUpdateTime(-1.0),
151 _updateTimeRemainder(0.0),
156 SGSubsystemGroup::~SGSubsystemGroup ()
158 // reverse order to prevent order dependency problems
159 for( size_t i = _members.size(); i > 0; i-- )
161 delete _members[i-1];
166 SGSubsystemGroup::init ()
168 for( size_t i = 0; i < _members.size(); i++ )
169 _members[i]->subsystem->init();
172 SGSubsystem::InitStatus
173 SGSubsystemGroup::incrementalInit()
175 if (_initPosition >= _members.size())
180 InitStatus memberStatus = _members[_initPosition]->subsystem->incrementalInit();
181 _members[_initPosition]->initTime += st.elapsedMSec();
183 if (memberStatus == INIT_DONE)
186 return INIT_CONTINUE;
190 SGSubsystemGroup::postinit ()
192 for( size_t i = 0; i < _members.size(); i++ )
193 _members[i]->subsystem->postinit();
197 SGSubsystemGroup::reinit ()
199 for( size_t i = 0; i < _members.size(); i++ )
200 _members[i]->subsystem->reinit();
204 SGSubsystemGroup::shutdown ()
206 // reverse order to prevent order dependency problems
207 for( size_t i = _members.size(); i > 0; i-- )
208 _members[i-1]->subsystem->shutdown();
213 SGSubsystemGroup::bind ()
215 for( size_t i = 0; i < _members.size(); i++ )
216 _members[i]->subsystem->bind();
220 SGSubsystemGroup::unbind ()
222 // reverse order to prevent order dependency problems
223 for( size_t i = _members.size(); i > 0; i-- )
224 _members[i-1]->subsystem->unbind();
228 SGSubsystemGroup::update (double delta_time_sec)
231 // if dt == 0.0, we are paused, so we need to run one iteration
232 // of our members; if we have a fixed update time, we compute a
233 // loop count, and locally adjust dt
234 if ((delta_time_sec > 0.0) && (_fixedUpdateTime > 0.0)) {
235 double localDelta = delta_time_sec + _updateTimeRemainder;
236 loopCount = SGMiscd::roundToInt(localDelta / _fixedUpdateTime);
237 loopCount = std::max(0, loopCount);
238 _updateTimeRemainder = delta_time_sec - (loopCount * _fixedUpdateTime);
239 delta_time_sec = _fixedUpdateTime;
242 bool recordTime = (reportTimingCb != NULL);
243 SGTimeStamp timeStamp;
244 while (loopCount-- > 0) {
245 for( size_t i = 0; i < _members.size(); i++ )
248 timeStamp = SGTimeStamp::now();
250 _members[i]->update(delta_time_sec); // indirect call
252 if ((recordTime)&&(reportTimingCb))
254 timeStamp = SGTimeStamp::now() - timeStamp;
255 _members[i]->updateExecutionTime(timeStamp.toUSecs());
258 } // of multiple update loop
262 SGSubsystemGroup::reportTiming(void)
264 for( size_t i = _members.size(); i > 0; i-- )
266 _members[i-1]->reportTiming();
271 SGSubsystemGroup::suspend ()
273 for( size_t i = 0; i < _members.size(); i++ )
274 _members[i]->subsystem->suspend();
278 SGSubsystemGroup::resume ()
280 for( size_t i = 0; i < _members.size(); i++ )
281 _members[i]->subsystem->resume();
285 SGSubsystemGroup::member_names() const
288 for( size_t i = 0; i < _members.size(); i++ )
289 result.push_back( _members[i]->name );
295 SGSubsystemGroup::is_suspended () const
301 SGSubsystemGroup::set_subsystem (const string &name, SGSubsystem * subsystem,
304 Member * member = get_member(name, true);
306 member->subsystem = subsystem;
307 member->min_step_sec = min_step_sec;
311 SGSubsystemGroup::get_subsystem (const string &name)
313 Member * member = get_member(name);
315 return member->subsystem;
321 SGSubsystemGroup::remove_subsystem (const string &name)
323 MemberVec::iterator it = _members.begin();
324 for (; it != _members.end(); ++it) {
325 if (name == (*it)->name) {
332 SG_LOG(SG_GENERAL, SG_WARN, "remove_subsystem: missing:" << name);
335 //------------------------------------------------------------------------------
336 void SGSubsystemGroup::clearSubsystems()
338 for( MemberVec::iterator it = _members.begin();
339 it != _members.end();
346 SGSubsystemGroup::set_fixed_update_time(double dt)
348 _fixedUpdateTime = dt;
352 SGSubsystemGroup::has_subsystem (const string &name) const
354 return (((SGSubsystemGroup *)this)->get_member(name) != 0);
357 SGSubsystemGroup::Member *
358 SGSubsystemGroup::get_member (const string &name, bool create)
360 for( size_t i = 0; i < _members.size(); i++ ) {
361 if (_members[i]->name == name)
365 Member * member = new Member;
366 _members.push_back(member);
374 ////////////////////////////////////////////////////////////////////////
375 // Implementation of SGSubsystemGroup::Member
376 ////////////////////////////////////////////////////////////////////////
379 SGSubsystemGroup::Member::Member ()
389 // This shouldn't be called due to subsystem pointer ownership issues.
390 SGSubsystemGroup::Member::Member (const Member &)
394 SGSubsystemGroup::Member::~Member ()
399 SGSubsystemGroup::Member::update (double delta_time_sec)
401 elapsed_sec += delta_time_sec;
402 if (elapsed_sec < min_step_sec) {
406 if (subsystem->is_suspended()) {
411 subsystem->update(elapsed_sec);
413 } catch (sg_exception& e) {
414 SG_LOG(SG_GENERAL, SG_ALERT, "caught exception processing subsystem:" << name
415 << "\nmessage:" << e.getMessage());
417 if (++exceptionCount > SG_MAX_SUBSYSTEM_EXCEPTIONS) {
418 SG_LOG(SG_GENERAL, SG_ALERT, "(exceptionCount=" << exceptionCount <<
420 subsystem->suspend();
426 ////////////////////////////////////////////////////////////////////////
427 // Implementation of SGSubsystemMgr.
428 ////////////////////////////////////////////////////////////////////////
431 SGSubsystemMgr::SGSubsystemMgr () :
435 for (int i = 0; i < MAX_GROUPS; i++)
436 _groups[i].reset(new SGSubsystemGroup);
439 SGSubsystemMgr::~SGSubsystemMgr ()
441 // ensure get_subsystem returns NULL from now onwards,
442 // before the SGSubsystemGroup destructors are run
443 _subsystem_map.clear();
448 SGSubsystemMgr::init ()
450 for (int i = 0; i < MAX_GROUPS; i++)
454 SGSubsystem::InitStatus
455 SGSubsystemMgr::incrementalInit()
457 if (_initPosition >= MAX_GROUPS)
460 InitStatus memberStatus = _groups[_initPosition]->incrementalInit();
461 if (memberStatus == INIT_DONE)
464 return INIT_CONTINUE;
468 SGSubsystemMgr::postinit ()
470 for (int i = 0; i < MAX_GROUPS; i++)
471 _groups[i]->postinit();
475 SGSubsystemMgr::reinit ()
477 for (int i = 0; i < MAX_GROUPS; i++)
478 _groups[i]->reinit();
482 SGSubsystemMgr::shutdown ()
484 // reverse order to prevent order dependency problems
485 for (int i = MAX_GROUPS-1; i >= 0; i--)
486 _groups[i]->shutdown();
493 SGSubsystemMgr::bind ()
495 for (int i = 0; i < MAX_GROUPS; i++)
500 SGSubsystemMgr::unbind ()
502 // reverse order to prevent order dependency problems
503 for (int i = MAX_GROUPS-1; i >= 0; i--)
504 _groups[i]->unbind();
508 SGSubsystemMgr::update (double delta_time_sec)
510 for (int i = 0; i < MAX_GROUPS; i++) {
511 _groups[i]->update(delta_time_sec);
516 SGSubsystemMgr::suspend ()
518 for (int i = 0; i < MAX_GROUPS; i++)
519 _groups[i]->suspend();
523 SGSubsystemMgr::resume ()
525 for (int i = 0; i < MAX_GROUPS; i++)
526 _groups[i]->resume();
530 SGSubsystemMgr::is_suspended () const
536 SGSubsystemMgr::add (const char * name, SGSubsystem * subsystem,
537 GroupType group, double min_time_sec)
539 SG_LOG(SG_GENERAL, SG_DEBUG, "Adding subsystem " << name);
540 get_group(group)->set_subsystem(name, subsystem, min_time_sec);
542 if (_subsystem_map.find(name) != _subsystem_map.end()) {
543 SG_LOG(SG_GENERAL, SG_ALERT, "Adding duplicate subsystem " << name);
544 throw sg_exception("duplicate subsystem:" + std::string(name));
546 _subsystem_map[name] = subsystem;
550 SGSubsystemMgr::remove(const char* name)
552 SubsystemDict::iterator s =_subsystem_map.find(name);
553 if (s == _subsystem_map.end()) {
557 _subsystem_map.erase(s);
559 // tedious part - we don't know which group the subsystem belongs too
560 for (int i = 0; i < MAX_GROUPS; i++) {
561 if (_groups[i]->get_subsystem(name) != NULL) {
562 _groups[i]->remove_subsystem(name);
565 } // of groups iteration
570 SGSubsystemMgr::get_group (GroupType group)
572 return _groups[group];
576 SGSubsystemMgr::get_subsystem (const string &name) const
578 SubsystemDict::const_iterator s =_subsystem_map.find(name);
580 if (s == _subsystem_map.end())
586 /** Trigger the timing callback to report data for all subsystems. */
588 SGSubsystemMgr::reportTiming()
590 for (int i = 0; i < MAX_GROUPS; i++) {
591 _groups[i]->reportTiming();
592 } // of groups iteration
595 // end of subsystem_mgr.cxx