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 ()
60 SGSubsystem::postinit ()
65 SGSubsystem::reinit ()
70 SGSubsystem::shutdown ()
80 SGSubsystem::unbind ()
85 SGSubsystem::suspend ()
91 SGSubsystem::suspend (bool suspended)
93 _suspended = suspended;
97 SGSubsystem::resume ()
103 SGSubsystem::is_suspended () const
108 void SGSubsystem::stamp(const string& name)
110 timingInfo.push_back(TimingInfo(name, SGTimeStamp::now()));
114 ////////////////////////////////////////////////////////////////////////
115 // Implementation of SGSubsystemGroup.
116 ////////////////////////////////////////////////////////////////////////
118 class SGSubsystemGroup::Member
121 Member (const Member &member);
126 virtual void update (double delta_time_sec);
128 void reportTiming(void) { if (reportTimingCb) reportTimingCb(reportTimingUserData, name, &timeStat); }
129 void updateExecutionTime(double time) { timeStat += time;}
131 SampleStatistic timeStat;
133 SGSubsystem * subsystem;
136 bool collectTimeStats;
142 SGSubsystemGroup::SGSubsystemGroup () :
143 _fixedUpdateTime(-1.0),
144 _updateTimeRemainder(0.0)
148 SGSubsystemGroup::~SGSubsystemGroup ()
150 // reverse order to prevent order dependency problems
151 for (unsigned int i = _members.size(); i > 0; i--)
153 delete _members[i-1];
158 SGSubsystemGroup::init ()
160 for (unsigned int i = 0; i < _members.size(); i++)
161 _members[i]->subsystem->init();
165 SGSubsystemGroup::postinit ()
167 for (unsigned int i = 0; i < _members.size(); i++)
168 _members[i]->subsystem->postinit();
172 SGSubsystemGroup::reinit ()
174 for (unsigned int i = 0; i < _members.size(); i++)
175 _members[i]->subsystem->reinit();
179 SGSubsystemGroup::shutdown ()
181 // reverse order to prevent order dependency problems
182 for (unsigned int i = _members.size(); i > 0; i--)
183 _members[i-1]->subsystem->shutdown();
187 SGSubsystemGroup::bind ()
189 for (unsigned int i = 0; i < _members.size(); i++)
190 _members[i]->subsystem->bind();
194 SGSubsystemGroup::unbind ()
196 // reverse order to prevent order dependency problems
197 for (unsigned int i = _members.size(); i > 0; i--)
198 _members[i-1]->subsystem->unbind();
202 SGSubsystemGroup::update (double delta_time_sec)
205 // if dt == 0.0, we are paused, so we need to run one iteration
206 // of our members; if we have a fixed update time, we compute a
207 // loop count, and locally adjust dt
208 if ((delta_time_sec > 0.0) && (_fixedUpdateTime > 0.0)) {
209 double localDelta = delta_time_sec + _updateTimeRemainder;
210 loopCount = SGMiscd::roundToInt(localDelta / _fixedUpdateTime);
211 _updateTimeRemainder = delta_time_sec - (loopCount * _fixedUpdateTime);
212 delta_time_sec = _fixedUpdateTime;
215 bool recordTime = (reportTimingCb != NULL);
216 SGTimeStamp timeStamp;
217 while (loopCount-- > 0) {
218 for (unsigned int i = 0; i < _members.size(); i++)
221 timeStamp = SGTimeStamp::now();
223 _members[i]->update(delta_time_sec); // indirect call
225 if ((recordTime)&&(reportTimingCb))
227 timeStamp = SGTimeStamp::now() - timeStamp;
228 _members[i]->updateExecutionTime(timeStamp.toUSecs());
231 } // of multiple update loop
235 SGSubsystemGroup::reportTiming(void)
237 for (unsigned int i = _members.size(); i > 0; i--)
239 _members[i-1]->reportTiming();
244 SGSubsystemGroup::suspend ()
246 for (unsigned int i = 0; i < _members.size(); i++)
247 _members[i]->subsystem->suspend();
251 SGSubsystemGroup::resume ()
253 for (unsigned int i = 0; i < _members.size(); i++)
254 _members[i]->subsystem->resume();
258 SGSubsystemGroup::is_suspended () const
264 SGSubsystemGroup::set_subsystem (const string &name, SGSubsystem * subsystem,
267 Member * member = get_member(name, true);
268 if (member->subsystem != 0)
269 delete member->subsystem;
271 member->subsystem = subsystem;
272 member->min_step_sec = min_step_sec;
276 SGSubsystemGroup::get_subsystem (const string &name)
278 Member * member = get_member(name);
280 return member->subsystem;
286 SGSubsystemGroup::remove_subsystem (const string &name)
288 for (unsigned int i = 0; i < _members.size(); i++) {
289 if (name == _members[i]->name) {
290 _members.erase(_members.begin() + i);
297 SGSubsystemGroup::set_fixed_update_time(double dt)
299 _fixedUpdateTime = dt;
303 SGSubsystemGroup::has_subsystem (const string &name) const
305 return (((SGSubsystemGroup *)this)->get_member(name) != 0);
308 SGSubsystemGroup::Member *
309 SGSubsystemGroup::get_member (const string &name, bool create)
311 for (unsigned int i = 0; i < _members.size(); i++) {
312 if (_members[i]->name == name)
316 Member * member = new Member;
317 _members.push_back(member);
326 ////////////////////////////////////////////////////////////////////////
327 // Implementation of SGSubsystemGroup::Member
328 ////////////////////////////////////////////////////////////////////////
331 SGSubsystemGroup::Member::Member ()
340 // This shouldn't be called due to subsystem pointer ownership issues.
341 SGSubsystemGroup::Member::Member (const Member &)
345 SGSubsystemGroup::Member::~Member ()
351 SGSubsystemGroup::Member::update (double delta_time_sec)
353 elapsed_sec += delta_time_sec;
354 if (elapsed_sec < min_step_sec) {
358 if (subsystem->is_suspended()) {
363 subsystem->update(elapsed_sec);
365 } catch (sg_exception& e) {
366 SG_LOG(SG_GENERAL, SG_ALERT, "caught exception processing subsystem:" << name
367 << "\nmessage:" << e.getMessage());
369 if (++exceptionCount > SG_MAX_SUBSYSTEM_EXCEPTIONS) {
370 SG_LOG(SG_GENERAL, SG_ALERT, "(exceptionCount=" << exceptionCount <<
372 subsystem->suspend();
378 ////////////////////////////////////////////////////////////////////////
379 // Implementation of SGSubsystemMgr.
380 ////////////////////////////////////////////////////////////////////////
383 SGSubsystemMgr::SGSubsystemMgr ()
385 for (int i = 0; i < MAX_GROUPS; i++) {
386 _groups[i] = new SGSubsystemGroup;
390 SGSubsystemMgr::~SGSubsystemMgr ()
392 // ensure get_subsystem returns NULL from now onwards,
393 // before the SGSubsystemGroup destructors are run
394 _subsystem_map.clear();
396 for (int i = 0; i < MAX_GROUPS; i++) {
402 SGSubsystemMgr::init ()
404 for (int i = 0; i < MAX_GROUPS; i++)
409 SGSubsystemMgr::postinit ()
411 for (int i = 0; i < MAX_GROUPS; i++)
412 _groups[i]->postinit();
416 SGSubsystemMgr::reinit ()
418 for (int i = 0; i < MAX_GROUPS; i++)
419 _groups[i]->reinit();
423 SGSubsystemMgr::shutdown ()
425 // reverse order to prevent order dependency problems
426 for (int i = MAX_GROUPS-1; i >= 0; i--)
427 _groups[i]->shutdown();
432 SGSubsystemMgr::bind ()
434 for (int i = 0; i < MAX_GROUPS; i++)
439 SGSubsystemMgr::unbind ()
441 // reverse order to prevent order dependency problems
442 for (int i = MAX_GROUPS-1; i >= 0; i--)
443 _groups[i]->unbind();
447 SGSubsystemMgr::update (double delta_time_sec)
449 for (int i = 0; i < MAX_GROUPS; i++) {
450 _groups[i]->update(delta_time_sec);
455 SGSubsystemMgr::suspend ()
457 for (int i = 0; i < MAX_GROUPS; i++)
458 _groups[i]->suspend();
462 SGSubsystemMgr::resume ()
464 for (int i = 0; i < MAX_GROUPS; i++)
465 _groups[i]->resume();
469 SGSubsystemMgr::is_suspended () const
475 SGSubsystemMgr::add (const char * name, SGSubsystem * subsystem,
476 GroupType group, double min_time_sec)
478 SG_LOG(SG_GENERAL, SG_INFO, "Adding subsystem " << name);
479 get_group(group)->set_subsystem(name, subsystem, min_time_sec);
481 if (_subsystem_map.find(name) != _subsystem_map.end()) {
482 SG_LOG(SG_GENERAL, SG_ALERT, "Adding duplicate subsystem " << name);
483 throw sg_exception("duplicate subsystem");
485 _subsystem_map[name] = subsystem;
489 SGSubsystemMgr::remove(const char* name)
491 SubsystemDict::iterator s =_subsystem_map.find(name);
492 if (s == _subsystem_map.end()) {
496 SGSubsystem* sub = s->second;
497 _subsystem_map.erase(s);
499 // tedious part - we don't know which group the subsystem belongs too
500 for (int i = 0; i < MAX_GROUPS; i++) {
501 if (_groups[i]->get_subsystem(name) == sub) {
502 _groups[i]->remove_subsystem(name);
505 } // of groups iteration
512 SGSubsystemMgr::get_group (GroupType group)
514 return _groups[group];
518 SGSubsystemMgr::get_subsystem (const string &name) const
520 SubsystemDict::const_iterator s =_subsystem_map.find(name);
522 if (s == _subsystem_map.end())
528 /** Trigger the timing callback to report data for all subsystems. */
530 SGSubsystemMgr::reportTiming()
532 for (int i = 0; i < MAX_GROUPS; i++) {
533 _groups[i]->reportTiming();
534 } // of groups iteration
537 // end of subsystem_mgr.cxx