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()));
121 ////////////////////////////////////////////////////////////////////////
122 // Implementation of SGSubsystemGroup.
123 ////////////////////////////////////////////////////////////////////////
125 class SGSubsystemGroup::Member
128 Member (const Member &member);
133 virtual void update (double delta_time_sec);
135 void reportTiming(void) { if (reportTimingCb) reportTimingCb(reportTimingUserData, name, &timeStat); }
136 void updateExecutionTime(double time) { timeStat += time;}
138 SampleStatistic timeStat;
140 SGSubsystem * subsystem;
143 bool collectTimeStats;
150 SGSubsystemGroup::SGSubsystemGroup () :
151 _fixedUpdateTime(-1.0),
152 _updateTimeRemainder(0.0),
157 SGSubsystemGroup::~SGSubsystemGroup ()
159 // reverse order to prevent order dependency problems
160 for (unsigned int i = _members.size(); i > 0; i--)
162 delete _members[i-1];
167 SGSubsystemGroup::init ()
169 for (unsigned int i = 0; i < _members.size(); i++)
170 _members[i]->subsystem->init();
173 SGSubsystem::InitStatus
174 SGSubsystemGroup::incrementalInit()
176 if (_initPosition < 0)
179 if (_initPosition >= _members.size())
184 InitStatus memberStatus = _members[_initPosition]->subsystem->incrementalInit();
185 _members[_initPosition]->initTime += st.elapsedMSec();
187 if (memberStatus == INIT_DONE)
190 return INIT_CONTINUE;
194 SGSubsystemGroup::postinit ()
196 for (unsigned int i = 0; i < _members.size(); i++)
197 _members[i]->subsystem->postinit();
201 SGSubsystemGroup::reinit ()
203 for (unsigned int i = 0; i < _members.size(); i++)
204 _members[i]->subsystem->reinit();
208 SGSubsystemGroup::shutdown ()
210 // reverse order to prevent order dependency problems
211 for (unsigned int i = _members.size(); i > 0; i--)
212 _members[i-1]->subsystem->shutdown();
217 SGSubsystemGroup::bind ()
219 for (unsigned int i = 0; i < _members.size(); i++)
220 _members[i]->subsystem->bind();
224 SGSubsystemGroup::unbind ()
226 // reverse order to prevent order dependency problems
227 for (unsigned int i = _members.size(); i > 0; i--)
228 _members[i-1]->subsystem->unbind();
232 SGSubsystemGroup::update (double delta_time_sec)
235 // if dt == 0.0, we are paused, so we need to run one iteration
236 // of our members; if we have a fixed update time, we compute a
237 // loop count, and locally adjust dt
238 if ((delta_time_sec > 0.0) && (_fixedUpdateTime > 0.0)) {
239 double localDelta = delta_time_sec + _updateTimeRemainder;
240 loopCount = SGMiscd::roundToInt(localDelta / _fixedUpdateTime);
241 _updateTimeRemainder = delta_time_sec - (loopCount * _fixedUpdateTime);
242 delta_time_sec = _fixedUpdateTime;
245 bool recordTime = (reportTimingCb != NULL);
246 SGTimeStamp timeStamp;
247 while (loopCount-- > 0) {
248 for (unsigned int i = 0; i < _members.size(); i++)
251 timeStamp = SGTimeStamp::now();
253 _members[i]->update(delta_time_sec); // indirect call
255 if ((recordTime)&&(reportTimingCb))
257 timeStamp = SGTimeStamp::now() - timeStamp;
258 _members[i]->updateExecutionTime(timeStamp.toUSecs());
261 } // of multiple update loop
265 SGSubsystemGroup::reportTiming(void)
267 for (unsigned int i = _members.size(); i > 0; i--)
269 _members[i-1]->reportTiming();
274 SGSubsystemGroup::suspend ()
276 for (unsigned int i = 0; i < _members.size(); i++)
277 _members[i]->subsystem->suspend();
281 SGSubsystemGroup::resume ()
283 for (unsigned int i = 0; i < _members.size(); i++)
284 _members[i]->subsystem->resume();
288 SGSubsystemGroup::is_suspended () const
294 SGSubsystemGroup::set_subsystem (const string &name, SGSubsystem * subsystem,
297 Member * member = get_member(name, true);
298 if (member->subsystem != 0)
299 delete member->subsystem;
301 member->subsystem = subsystem;
302 member->min_step_sec = min_step_sec;
306 SGSubsystemGroup::get_subsystem (const string &name)
308 Member * member = get_member(name);
310 return member->subsystem;
316 SGSubsystemGroup::remove_subsystem (const string &name)
318 for (unsigned int i = 0; i < _members.size(); i++) {
319 if (name == _members[i]->name) {
320 _members.erase(_members.begin() + i);
327 SGSubsystemGroup::set_fixed_update_time(double dt)
329 _fixedUpdateTime = dt;
333 SGSubsystemGroup::has_subsystem (const string &name) const
335 return (((SGSubsystemGroup *)this)->get_member(name) != 0);
338 SGSubsystemGroup::Member *
339 SGSubsystemGroup::get_member (const string &name, bool create)
341 for (unsigned int i = 0; i < _members.size(); i++) {
342 if (_members[i]->name == name)
346 Member * member = new Member;
347 _members.push_back(member);
356 ////////////////////////////////////////////////////////////////////////
357 // Implementation of SGSubsystemGroup::Member
358 ////////////////////////////////////////////////////////////////////////
361 SGSubsystemGroup::Member::Member ()
371 // This shouldn't be called due to subsystem pointer ownership issues.
372 SGSubsystemGroup::Member::Member (const Member &)
376 SGSubsystemGroup::Member::~Member ()
382 SGSubsystemGroup::Member::update (double delta_time_sec)
384 elapsed_sec += delta_time_sec;
385 if (elapsed_sec < min_step_sec) {
389 if (subsystem->is_suspended()) {
394 subsystem->update(elapsed_sec);
396 } catch (sg_exception& e) {
397 SG_LOG(SG_GENERAL, SG_ALERT, "caught exception processing subsystem:" << name
398 << "\nmessage:" << e.getMessage());
400 if (++exceptionCount > SG_MAX_SUBSYSTEM_EXCEPTIONS) {
401 SG_LOG(SG_GENERAL, SG_ALERT, "(exceptionCount=" << exceptionCount <<
403 subsystem->suspend();
409 ////////////////////////////////////////////////////////////////////////
410 // Implementation of SGSubsystemMgr.
411 ////////////////////////////////////////////////////////////////////////
414 SGSubsystemMgr::SGSubsystemMgr () :
417 for (int i = 0; i < MAX_GROUPS; i++) {
418 _groups[i] = new SGSubsystemGroup;
422 SGSubsystemMgr::~SGSubsystemMgr ()
424 // ensure get_subsystem returns NULL from now onwards,
425 // before the SGSubsystemGroup destructors are run
426 _subsystem_map.clear();
428 for (int i = 0; i < MAX_GROUPS; i++) {
434 SGSubsystemMgr::init ()
436 for (int i = 0; i < MAX_GROUPS; i++)
440 SGSubsystem::InitStatus
441 SGSubsystemMgr::incrementalInit()
443 if (_initPosition < 0)
446 if (_initPosition >= MAX_GROUPS)
449 InitStatus memberStatus = _groups[_initPosition]->incrementalInit();
450 if (memberStatus == INIT_DONE)
453 return INIT_CONTINUE;
457 SGSubsystemMgr::postinit ()
459 for (int i = 0; i < MAX_GROUPS; i++)
460 _groups[i]->postinit();
464 SGSubsystemMgr::reinit ()
466 for (int i = 0; i < MAX_GROUPS; i++)
467 _groups[i]->reinit();
471 SGSubsystemMgr::shutdown ()
473 // reverse order to prevent order dependency problems
474 for (int i = MAX_GROUPS-1; i >= 0; i--)
475 _groups[i]->shutdown();
482 SGSubsystemMgr::bind ()
484 for (int i = 0; i < MAX_GROUPS; i++)
489 SGSubsystemMgr::unbind ()
491 // reverse order to prevent order dependency problems
492 for (int i = MAX_GROUPS-1; i >= 0; i--)
493 _groups[i]->unbind();
497 SGSubsystemMgr::update (double delta_time_sec)
499 for (int i = 0; i < MAX_GROUPS; i++) {
500 _groups[i]->update(delta_time_sec);
505 SGSubsystemMgr::suspend ()
507 for (int i = 0; i < MAX_GROUPS; i++)
508 _groups[i]->suspend();
512 SGSubsystemMgr::resume ()
514 for (int i = 0; i < MAX_GROUPS; i++)
515 _groups[i]->resume();
519 SGSubsystemMgr::is_suspended () const
525 SGSubsystemMgr::add (const char * name, SGSubsystem * subsystem,
526 GroupType group, double min_time_sec)
528 SG_LOG(SG_GENERAL, SG_INFO, "Adding subsystem " << name);
529 get_group(group)->set_subsystem(name, subsystem, min_time_sec);
531 if (_subsystem_map.find(name) != _subsystem_map.end()) {
532 SG_LOG(SG_GENERAL, SG_ALERT, "Adding duplicate subsystem " << name);
533 throw sg_exception("duplicate subsystem");
535 _subsystem_map[name] = subsystem;
539 SGSubsystemMgr::remove(const char* name)
541 SubsystemDict::iterator s =_subsystem_map.find(name);
542 if (s == _subsystem_map.end()) {
546 SGSubsystem* sub = s->second;
547 _subsystem_map.erase(s);
549 // tedious part - we don't know which group the subsystem belongs too
550 for (int i = 0; i < MAX_GROUPS; i++) {
551 if (_groups[i]->get_subsystem(name) == sub) {
552 _groups[i]->remove_subsystem(name);
555 } // of groups iteration
562 SGSubsystemMgr::get_group (GroupType group)
564 return _groups[group];
568 SGSubsystemMgr::get_subsystem (const string &name) const
570 SubsystemDict::const_iterator s =_subsystem_map.find(name);
572 if (s == _subsystem_map.end())
578 /** Trigger the timing callback to report data for all subsystems. */
580 SGSubsystemMgr::reportTiming()
582 for (int i = 0; i < MAX_GROUPS; i++) {
583 _groups[i]->reportTiming();
584 } // of groups iteration
587 // end of subsystem_mgr.cxx