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;
36 ////////////////////////////////////////////////////////////////////////
37 // Implementation of SGSubsystem
38 ////////////////////////////////////////////////////////////////////////
40 SGSubsystemTimingCb SGSubsystem::reportTimingCb = NULL;
41 void* SGSubsystem::reportTimingUserData = NULL;
43 SGSubsystem::SGSubsystem ()
48 SGSubsystem::~SGSubsystem ()
58 SGSubsystem::postinit ()
63 SGSubsystem::reinit ()
68 SGSubsystem::shutdown ()
78 SGSubsystem::unbind ()
83 SGSubsystem::suspend ()
89 SGSubsystem::suspend (bool suspended)
91 _suspended = suspended;
95 SGSubsystem::resume ()
101 SGSubsystem::is_suspended () const
106 void SGSubsystem::stamp(const string& name)
108 timingInfo.push_back(TimingInfo(name, SGTimeStamp::now()));
112 ////////////////////////////////////////////////////////////////////////
113 // Implementation of SGSubsystemGroup.
114 ////////////////////////////////////////////////////////////////////////
116 class SGSubsystemGroup::Member
119 Member (const Member &member);
124 virtual void update (double delta_time_sec);
126 void reportTiming(void) { if (reportTimingCb) reportTimingCb(reportTimingUserData, name, &timeStat); }
127 void updateExecutionTime(double time) { timeStat += time;}
129 SampleStatistic timeStat;
131 SGSubsystem * subsystem;
134 bool collectTimeStats;
140 SGSubsystemGroup::SGSubsystemGroup () :
141 _fixedUpdateTime(-1.0),
142 _updateTimeRemainder(0.0)
146 SGSubsystemGroup::~SGSubsystemGroup ()
148 // reverse order to prevent order dependency problems
149 for (unsigned int i = _members.size(); i > 0; i--)
151 delete _members[i-1];
156 SGSubsystemGroup::init ()
158 for (unsigned int i = 0; i < _members.size(); i++)
159 _members[i]->subsystem->init();
163 SGSubsystemGroup::postinit ()
165 for (unsigned int i = 0; i < _members.size(); i++)
166 _members[i]->subsystem->postinit();
170 SGSubsystemGroup::reinit ()
172 for (unsigned int i = 0; i < _members.size(); i++)
173 _members[i]->subsystem->reinit();
177 SGSubsystemGroup::shutdown ()
179 // reverse order to prevent order dependency problems
180 for (unsigned int i = _members.size(); i > 0; i--)
181 _members[i-1]->subsystem->shutdown();
185 SGSubsystemGroup::bind ()
187 for (unsigned int i = 0; i < _members.size(); i++)
188 _members[i]->subsystem->bind();
192 SGSubsystemGroup::unbind ()
194 // reverse order to prevent order dependency problems
195 for (unsigned int i = _members.size(); i > 0; i--)
196 _members[i-1]->subsystem->unbind();
200 SGSubsystemGroup::update (double delta_time_sec)
203 // if dt == 0.0, we are paused, so we need to run one iteration
204 // of our members; if we have a fixed update time, we compute a
205 // loop count, and locally adjust dt
206 if ((delta_time_sec > 0.0) && (_fixedUpdateTime > 0.0)) {
207 double localDelta = delta_time_sec + _updateTimeRemainder;
208 loopCount = SGMiscd::roundToInt(localDelta / _fixedUpdateTime);
209 _updateTimeRemainder = delta_time_sec - (loopCount * _fixedUpdateTime);
210 delta_time_sec = _fixedUpdateTime;
213 bool recordTime = (reportTimingCb != NULL);
214 SGTimeStamp timeStamp;
215 while (loopCount-- > 0) {
216 for (unsigned int i = 0; i < _members.size(); i++)
219 timeStamp = SGTimeStamp::now();
221 _members[i]->update(delta_time_sec); // indirect call
223 if ((recordTime)&&(reportTimingCb))
225 timeStamp = SGTimeStamp::now() - timeStamp;
226 _members[i]->updateExecutionTime(timeStamp.toUSecs());
229 } // of multiple update loop
233 SGSubsystemGroup::reportTiming(void)
235 for (unsigned int i = _members.size(); i > 0; i--)
237 _members[i-1]->reportTiming();
242 SGSubsystemGroup::suspend ()
244 for (unsigned int i = 0; i < _members.size(); i++)
245 _members[i]->subsystem->suspend();
249 SGSubsystemGroup::resume ()
251 for (unsigned int i = 0; i < _members.size(); i++)
252 _members[i]->subsystem->resume();
256 SGSubsystemGroup::is_suspended () const
262 SGSubsystemGroup::set_subsystem (const string &name, SGSubsystem * subsystem,
265 Member * member = get_member(name, true);
266 if (member->subsystem != 0)
267 delete member->subsystem;
269 member->subsystem = subsystem;
270 member->min_step_sec = min_step_sec;
274 SGSubsystemGroup::get_subsystem (const string &name)
276 Member * member = get_member(name);
278 return member->subsystem;
284 SGSubsystemGroup::remove_subsystem (const string &name)
286 for (unsigned int i = 0; i < _members.size(); i++) {
287 if (name == _members[i]->name) {
288 _members.erase(_members.begin() + i);
295 SGSubsystemGroup::set_fixed_update_time(double dt)
297 _fixedUpdateTime = dt;
301 SGSubsystemGroup::has_subsystem (const string &name) const
303 return (((SGSubsystemGroup *)this)->get_member(name) != 0);
306 SGSubsystemGroup::Member *
307 SGSubsystemGroup::get_member (const string &name, bool create)
309 for (unsigned int i = 0; i < _members.size(); i++) {
310 if (_members[i]->name == name)
314 Member * member = new Member;
315 _members.push_back(member);
324 ////////////////////////////////////////////////////////////////////////
325 // Implementation of SGSubsystemGroup::Member
326 ////////////////////////////////////////////////////////////////////////
329 SGSubsystemGroup::Member::Member ()
338 // This shouldn't be called due to subsystem pointer ownership issues.
339 SGSubsystemGroup::Member::Member (const Member &)
343 SGSubsystemGroup::Member::~Member ()
349 SGSubsystemGroup::Member::update (double delta_time_sec)
351 elapsed_sec += delta_time_sec;
352 if (elapsed_sec < min_step_sec) {
356 if (subsystem->is_suspended()) {
361 subsystem->update(elapsed_sec);
363 } catch (sg_exception& e) {
364 SG_LOG(SG_GENERAL, SG_ALERT, "caught exception processing subsystem:" << name
365 << "\nmessage:" << e.getMessage());
367 if (++exceptionCount > SG_MAX_SUBSYSTEM_EXCEPTIONS) {
368 SG_LOG(SG_GENERAL, SG_ALERT, "(exceptionCount=" << exceptionCount <<
370 subsystem->suspend();
376 ////////////////////////////////////////////////////////////////////////
377 // Implementation of SGSubsystemMgr.
378 ////////////////////////////////////////////////////////////////////////
381 SGSubsystemMgr::SGSubsystemMgr ()
383 for (int i = 0; i < MAX_GROUPS; i++) {
384 _groups[i] = new SGSubsystemGroup;
388 SGSubsystemMgr::~SGSubsystemMgr ()
390 // ensure get_subsystem returns NULL from now onwards,
391 // before the SGSubsystemGroup destructors are run
392 _subsystem_map.clear();
394 for (int i = 0; i < MAX_GROUPS; i++) {
400 SGSubsystemMgr::init ()
402 for (int i = 0; i < MAX_GROUPS; i++)
407 SGSubsystemMgr::postinit ()
409 for (int i = 0; i < MAX_GROUPS; i++)
410 _groups[i]->postinit();
414 SGSubsystemMgr::reinit ()
416 for (int i = 0; i < MAX_GROUPS; i++)
417 _groups[i]->reinit();
421 SGSubsystemMgr::shutdown ()
423 // reverse order to prevent order dependency problems
424 for (int i = MAX_GROUPS-1; i >= 0; i--)
425 _groups[i]->shutdown();
430 SGSubsystemMgr::bind ()
432 for (int i = 0; i < MAX_GROUPS; i++)
437 SGSubsystemMgr::unbind ()
439 // reverse order to prevent order dependency problems
440 for (int i = MAX_GROUPS-1; i >= 0; i--)
441 _groups[i]->unbind();
445 SGSubsystemMgr::update (double delta_time_sec)
447 for (int i = 0; i < MAX_GROUPS; i++) {
448 _groups[i]->update(delta_time_sec);
453 SGSubsystemMgr::suspend ()
455 for (int i = 0; i < MAX_GROUPS; i++)
456 _groups[i]->suspend();
460 SGSubsystemMgr::resume ()
462 for (int i = 0; i < MAX_GROUPS; i++)
463 _groups[i]->resume();
467 SGSubsystemMgr::is_suspended () const
473 SGSubsystemMgr::add (const char * name, SGSubsystem * subsystem,
474 GroupType group, double min_time_sec)
476 SG_LOG(SG_GENERAL, SG_INFO, "Adding subsystem " << name);
477 get_group(group)->set_subsystem(name, subsystem, min_time_sec);
479 if (_subsystem_map.find(name) != _subsystem_map.end()) {
480 SG_LOG(SG_GENERAL, SG_ALERT, "Adding duplicate subsystem " << name);
481 throw sg_exception("duplicate subsystem");
483 _subsystem_map[name] = subsystem;
487 SGSubsystemMgr::remove(const char* name)
489 SubsystemDict::iterator s =_subsystem_map.find(name);
490 if (s == _subsystem_map.end()) {
494 SGSubsystem* sub = s->second;
495 _subsystem_map.erase(s);
497 // tedious part - we don't know which group the subsystem belongs too
498 for (int i = 0; i < MAX_GROUPS; i++) {
499 if (_groups[i]->get_subsystem(name) == sub) {
500 _groups[i]->remove_subsystem(name);
503 } // of groups iteration
510 SGSubsystemMgr::get_group (GroupType group)
512 return _groups[group];
516 SGSubsystemMgr::get_subsystem (const string &name) const
518 SubsystemDict::const_iterator s =_subsystem_map.find(name);
520 if (s == _subsystem_map.end())
526 /** Trigger the timing callback to report data for all subsystems. */
528 SGSubsystemMgr::reportTiming()
530 for (int i = 0; i < MAX_GROUPS; i++) {
531 _groups[i]->reportTiming();
532 } // of groups iteration
535 // end of subsystem_mgr.cxx