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>
34 const int SG_MAX_SUBSYSTEM_EXCEPTIONS = 4;
\f
35 ////////////////////////////////////////////////////////////////////////
36 // Implementation of SGSubsystem
37 ////////////////////////////////////////////////////////////////////////
40 SGSubsystem::SGSubsystem ()
45 SGSubsystem::~SGSubsystem ()
55 SGSubsystem::postinit ()
60 SGSubsystem::reinit ()
65 SGSubsystem::shutdown ()
75 SGSubsystem::unbind ()
80 SGSubsystem::suspend ()
86 SGSubsystem::suspend (bool suspended)
88 _suspended = suspended;
92 SGSubsystem::resume ()
98 SGSubsystem::is_suspended () const
105 SGSubsystem::printTimingInformation ()
107 SGTimeStamp startTime;
108 for ( eventTimeVecIterator i = timingInfo.begin();
109 i != timingInfo.end();
111 if (i == timingInfo.begin()) {
112 startTime = i->getTime();
114 SGTimeStamp endTime = i->getTime();
115 SG_LOG(SG_GENERAL, SG_ALERT, "- Getting to timestamp : "
116 << i->getName() << " takes " << endTime - startTime
125 void SGSubsystem::stamp(const string& name)
127 timingInfo.push_back(TimingInfo(name, SGTimeStamp::now()));
131 ////////////////////////////////////////////////////////////////////////
132 // Implementation of SGSubsystemGroup.
133 ////////////////////////////////////////////////////////////////////////
135 SGSubsystemGroup::SGSubsystemGroup () :
136 _fixedUpdateTime(-1.0),
137 _updateTimeRemainder(0.0)
141 SGSubsystemGroup::~SGSubsystemGroup ()
143 printTimingStatistics();
145 // reverse order to prevent order dependency problems
146 for (unsigned int i = _members.size(); i > 0; i--)
148 delete _members[i-1];
153 SGSubsystemGroup::init ()
155 for (unsigned int i = 0; i < _members.size(); i++)
156 _members[i]->subsystem->init();
160 SGSubsystemGroup::postinit ()
162 for (unsigned int i = 0; i < _members.size(); i++)
163 _members[i]->subsystem->postinit();
167 SGSubsystemGroup::reinit ()
169 for (unsigned int i = 0; i < _members.size(); i++)
170 _members[i]->subsystem->reinit();
174 SGSubsystemGroup::shutdown ()
176 // reverse order to prevent order dependency problems
177 for (unsigned int i = _members.size(); i > 0; i--)
178 _members[i-1]->subsystem->shutdown();
182 SGSubsystemGroup::bind ()
184 for (unsigned int i = 0; i < _members.size(); i++)
185 _members[i]->subsystem->bind();
189 SGSubsystemGroup::unbind ()
191 // reverse order to prevent order dependency problems
192 for (unsigned int i = _members.size(); i > 0; i--)
193 _members[i-1]->subsystem->unbind();
197 SGSubsystemGroup::update (double delta_time_sec)
200 // if dt == 0.0, we are paused, so we need to run one iteration
201 // of our members; if we have a fixed update time, we compute a
202 // loop count, and locally adjust dt
203 if ((delta_time_sec > 0.0) && (_fixedUpdateTime > 0.0)) {
204 double localDelta = delta_time_sec + _updateTimeRemainder;
205 loopCount = SGMiscd::roundToInt(localDelta / _fixedUpdateTime);
206 _updateTimeRemainder = delta_time_sec - (loopCount * _fixedUpdateTime);
207 delta_time_sec = _fixedUpdateTime;
210 while (loopCount-- > 0) {
211 for (unsigned int i = 0; i < _members.size(); i++)
213 SGTimeStamp timeStamp = SGTimeStamp::now();
214 _members[i]->update(delta_time_sec); // indirect call
215 timeStamp = SGTimeStamp::now() - timeStamp;
216 double b = timeStamp.toUSecs();
217 _members[i]->updateExecutionTime(b);
218 double threshold = _members[i]->getTimeWarningThreshold();
219 if (( b > threshold ) && (b > 10000)) {
220 _members[i]->printTimingInformation(b);
223 } // of multiple update loop
227 SGSubsystemGroup::collectDebugTiming(bool collect)
229 for (unsigned int i = 0; i < _members.size(); i++)
231 _members[i]->collectDebugTiming(collect);
236 SGSubsystemGroup::printTimingStatistics(double minMaxTime,double minJitter)
238 for (unsigned int i = _members.size(); i > 0; i--)
240 _members[i-1]->printTimingStatistics(minMaxTime, minJitter);
241 _members[i-1]->timeStat.reset();
246 SGSubsystemGroup::suspend ()
248 for (unsigned int i = 0; i < _members.size(); i++)
249 _members[i]->subsystem->suspend();
253 SGSubsystemGroup::resume ()
255 for (unsigned int i = 0; i < _members.size(); i++)
256 _members[i]->subsystem->resume();
260 SGSubsystemGroup::is_suspended () const
266 SGSubsystemGroup::set_subsystem (const string &name, SGSubsystem * subsystem,
269 Member * member = get_member(name, true);
270 if (member->subsystem != 0)
271 delete member->subsystem;
273 member->subsystem = subsystem;
274 member->min_step_sec = min_step_sec;
278 SGSubsystemGroup::get_subsystem (const string &name)
280 Member * member = get_member(name);
282 return member->subsystem;
288 SGSubsystemGroup::remove_subsystem (const string &name)
290 for (unsigned int i = 0; i < _members.size(); i++) {
291 if (name == _members[i]->name) {
292 _members.erase(_members.begin() + i);
299 SGSubsystemGroup::set_fixed_update_time(double dt)
301 _fixedUpdateTime = dt;
305 * Print timing statistics.
306 * Only show data if jitter exceeds minJitter or
307 * maximum time exceeds minMaxTime.
310 SGSubsystemGroup::Member::printTimingStatistics(double minMaxTime,double minJitter)
312 if (collectTimeStats) {
313 double minTime = timeStat.min() / 1000;
314 double maxTime = timeStat.max() / 1000;
315 double meanTime = timeStat.mean() / 1000;
316 double stddev = timeStat.stdDev() / 1000;
318 if ((maxTime - minTime >= minJitter)||
319 (maxTime >= minMaxTime))
322 snprintf(buffer, 256, "Timing summary for %20s.\n"
323 "- mean time: %04.2f ms.\n"
324 "- min time : %04.2f ms.\n"
325 "- max time : %04.2f ms.\n"
326 "- stddev : %04.2f ms.\n", name.c_str(), meanTime, minTime, maxTime, stddev);
327 SG_LOG(SG_GENERAL, SG_ALERT, buffer);
334 SGSubsystemGroup::has_subsystem (const string &name) const
336 return (((SGSubsystemGroup *)this)->get_member(name) != 0);
339 SGSubsystemGroup::Member *
340 SGSubsystemGroup::get_member (const string &name, bool create)
342 for (unsigned int i = 0; i < _members.size(); i++) {
343 if (_members[i]->name == name)
347 Member * member = new Member;
348 _members.push_back(member);
357 ////////////////////////////////////////////////////////////////////////
358 // Implementation of SGSubsystemGroup::Member
359 ////////////////////////////////////////////////////////////////////////
362 SGSubsystemGroup::Member::Member ()
367 collectTimeStats(false),
372 // This shouldn't be called due to subsystem pointer ownership issues.
373 SGSubsystemGroup::Member::Member (const Member &)
377 SGSubsystemGroup::Member::~Member ()
383 SGSubsystemGroup::Member::update (double delta_time_sec)
385 elapsed_sec += delta_time_sec;
386 if (elapsed_sec < min_step_sec) {
390 if (subsystem->is_suspended()) {
395 subsystem->update(elapsed_sec);
397 } catch (sg_exception& e) {
398 SG_LOG(SG_GENERAL, SG_ALERT, "caught exception processing subsystem:" << name
399 << "\nmessage:" << e.getMessage());
401 if (++exceptionCount > SG_MAX_SUBSYSTEM_EXCEPTIONS) {
402 SG_LOG(SG_GENERAL, SG_ALERT, "(exceptionCount=" << exceptionCount <<
404 subsystem->suspend();
411 SGSubsystemGroup::Member::printTimingInformation(double time)
413 if (collectTimeStats) {
414 SG_LOG(SG_GENERAL, SG_ALERT, "Subsystem Timing Alert, subsystem \"" << name << "\": " << time/1000.0 << "ms");
415 subsystem->printTimingInformation();
419 double SGSubsystemGroup::Member::getTimeWarningThreshold()
421 return (timeStat.mean() + 3 * timeStat.stdDev());
424 void SGSubsystemGroup::Member::updateExecutionTime(double time)
426 if (collectTimeStats) {
435 ////////////////////////////////////////////////////////////////////////
436 // Implementation of SGSubsystemMgr.
437 ////////////////////////////////////////////////////////////////////////
440 SGSubsystemMgr::SGSubsystemMgr ()
442 for (int i = 0; i < MAX_GROUPS; i++) {
443 _groups[i] = new SGSubsystemGroup;
447 SGSubsystemMgr::~SGSubsystemMgr ()
449 // ensure get_subsystem returns NULL from now onwards,
450 // before the SGSubsystemGroup destructors are run
451 _subsystem_map.clear();
453 for (int i = 0; i < MAX_GROUPS; i++) {
459 SGSubsystemMgr::init ()
461 for (int i = 0; i < MAX_GROUPS; i++)
466 SGSubsystemMgr::postinit ()
468 for (int i = 0; i < MAX_GROUPS; i++)
469 _groups[i]->postinit();
473 SGSubsystemMgr::reinit ()
475 for (int i = 0; i < MAX_GROUPS; i++)
476 _groups[i]->reinit();
480 SGSubsystemMgr::shutdown ()
482 // reverse order to prevent order dependency problems
483 for (int i = MAX_GROUPS-1; i >= 0; i--)
484 _groups[i]->shutdown();
489 SGSubsystemMgr::bind ()
491 for (int i = 0; i < MAX_GROUPS; i++)
496 SGSubsystemMgr::unbind ()
498 // reverse order to prevent order dependency problems
499 for (int i = MAX_GROUPS-1; i >= 0; i--)
500 _groups[i]->unbind();
504 SGSubsystemMgr::update (double delta_time_sec)
506 for (int i = 0; i < MAX_GROUPS; i++) {
507 _groups[i]->update(delta_time_sec);
512 SGSubsystemMgr::collectDebugTiming(bool collect)
514 for (int i = 0; i < MAX_GROUPS; i++) {
515 _groups[i]->collectDebugTiming(collect);
520 SGSubsystemMgr::suspend ()
522 for (int i = 0; i < MAX_GROUPS; i++)
523 _groups[i]->suspend();
527 SGSubsystemMgr::resume ()
529 for (int i = 0; i < MAX_GROUPS; i++)
530 _groups[i]->resume();
534 SGSubsystemMgr::is_suspended () const
540 SGSubsystemMgr::add (const char * name, SGSubsystem * subsystem,
541 GroupType group, double min_time_sec)
543 SG_LOG(SG_GENERAL, SG_INFO, "Adding subsystem " << name);
544 get_group(group)->set_subsystem(name, subsystem, min_time_sec);
546 if (_subsystem_map.find(name) != _subsystem_map.end()) {
547 SG_LOG(SG_GENERAL, SG_ALERT, "Adding duplicate subsystem " << name);
548 throw sg_exception("duplicate subsystem");
550 _subsystem_map[name] = subsystem;
554 SGSubsystemMgr::remove(const char* name)
556 SubsystemDict::iterator s =_subsystem_map.find(name);
557 if (s == _subsystem_map.end()) {
561 SGSubsystem* sub = s->second;
562 _subsystem_map.erase(s);
564 // tedious part - we don't know which group the subsystem belongs too
565 for (int i = 0; i < MAX_GROUPS; i++) {
566 if (_groups[i]->get_subsystem(name) == sub) {
567 _groups[i]->remove_subsystem(name);
570 } // of groups iteration
577 SGSubsystemMgr::get_group (GroupType group)
579 return _groups[group];
583 SGSubsystemMgr::get_subsystem (const string &name) const
585 SubsystemDict::const_iterator s =_subsystem_map.find(name);
587 if (s == _subsystem_map.end())
594 SGSubsystemMgr::printTimingStatistics(double minMaxTime,double minJitter)
596 for (int i = 0; i < MAX_GROUPS; i++) {
597 _groups[i]->printTimingStatistics(minMaxTime, minJitter);
598 } // of groups iteration
601 // end of subsystem_mgr.cxx