[906] | 1 | /* -*- C++ -*- |
---|
[1435] | 2 | * lemon/time_measure.h - Part of LEMON, a generic C++ optimization library |
---|
[906] | 3 | * |
---|
[1164] | 4 | * Copyright (C) 2005 Egervary Jeno Kombinatorikus Optimalizalasi Kutatocsoport |
---|
[1359] | 5 | * (Egervary Research Group on Combinatorial Optimization, EGRES). |
---|
[906] | 6 | * |
---|
| 7 | * Permission to use, modify and distribute this software is granted |
---|
| 8 | * provided that this copyright notice appears in all copies. For |
---|
| 9 | * precise terms see the accompanying LICENSE file. |
---|
| 10 | * |
---|
| 11 | * This software is provided "AS IS" with no warranty of any kind, |
---|
| 12 | * express or implied, and with no claim as to its suitability for any |
---|
| 13 | * purpose. |
---|
| 14 | * |
---|
| 15 | */ |
---|
| 16 | |
---|
[921] | 17 | #ifndef LEMON_TIME_MEASURE_H |
---|
| 18 | #define LEMON_TIME_MEASURE_H |
---|
[428] | 19 | |
---|
[1847] | 20 | ///\ingroup timecount |
---|
[428] | 21 | ///\file |
---|
| 22 | ///\brief Tools for measuring cpu usage |
---|
| 23 | |
---|
| 24 | #include <sys/time.h> |
---|
| 25 | #include <sys/times.h> |
---|
| 26 | #include <fstream> |
---|
| 27 | #include <iostream> |
---|
| 28 | #include <unistd.h> |
---|
| 29 | |
---|
[921] | 30 | namespace lemon { |
---|
[428] | 31 | |
---|
[1847] | 32 | /// \addtogroup timecount |
---|
[428] | 33 | /// @{ |
---|
| 34 | |
---|
| 35 | /// A class to store (cpu)time instances. |
---|
| 36 | |
---|
| 37 | /// This class stores five time values. |
---|
| 38 | /// - a real time |
---|
| 39 | /// - a user cpu time |
---|
| 40 | /// - a system cpu time |
---|
| 41 | /// - a user cpu time of children |
---|
| 42 | /// - a system cpu time of children |
---|
| 43 | /// |
---|
| 44 | /// TimeStamp's can be added to or substracted from each other and |
---|
| 45 | /// they can be pushed to a stream. |
---|
[458] | 46 | /// |
---|
| 47 | /// In most cases, perhaps \ref Timer class is what you want to use instead. |
---|
| 48 | /// |
---|
| 49 | ///\author Alpar Juttner |
---|
[428] | 50 | |
---|
| 51 | class TimeStamp |
---|
| 52 | { |
---|
[1689] | 53 | struct rtms |
---|
| 54 | { |
---|
| 55 | double tms_utime; |
---|
| 56 | double tms_stime; |
---|
| 57 | double tms_cutime; |
---|
| 58 | double tms_cstime; |
---|
| 59 | rtms() {} |
---|
| 60 | rtms(tms ts) : tms_utime(ts.tms_utime), tms_stime(ts.tms_stime), |
---|
| 61 | tms_cutime(ts.tms_cutime), tms_cstime(ts.tms_cstime) {} |
---|
| 62 | }; |
---|
| 63 | rtms ts; |
---|
[428] | 64 | double real_time; |
---|
| 65 | |
---|
[1689] | 66 | rtms &getTms() {return ts;} |
---|
| 67 | const rtms &getTms() const {return ts;} |
---|
| 68 | |
---|
[1780] | 69 | void _reset() |
---|
| 70 | { ts.tms_utime=ts.tms_stime=ts.tms_cutime=ts.tms_cstime=0; real_time=0;} |
---|
| 71 | |
---|
[428] | 72 | public: |
---|
| 73 | |
---|
| 74 | ///Read the current time values of the process |
---|
| 75 | void stamp() |
---|
| 76 | { |
---|
| 77 | timeval tv; |
---|
[1689] | 78 | tms _ts; |
---|
| 79 | times(&_ts); |
---|
[428] | 80 | gettimeofday(&tv, 0);real_time=tv.tv_sec+double(tv.tv_usec)/1e6; |
---|
[1689] | 81 | ts=_ts; |
---|
[428] | 82 | } |
---|
| 83 | |
---|
| 84 | /// Constructor initializing with zero |
---|
| 85 | TimeStamp() |
---|
[1780] | 86 | { _reset(); } |
---|
[428] | 87 | ///Constructor initializing with the current time values of the process |
---|
| 88 | TimeStamp(void *) { stamp();} |
---|
| 89 | |
---|
[1780] | 90 | ///Set every time value to zero |
---|
| 91 | TimeStamp &reset() {_reset();return *this;} |
---|
| 92 | |
---|
[1005] | 93 | ///\e |
---|
[428] | 94 | TimeStamp &operator+=(const TimeStamp &b) |
---|
| 95 | { |
---|
| 96 | ts.tms_utime+=b.ts.tms_utime; |
---|
| 97 | ts.tms_stime+=b.ts.tms_stime; |
---|
| 98 | ts.tms_cutime+=b.ts.tms_cutime; |
---|
| 99 | ts.tms_cstime+=b.ts.tms_cstime; |
---|
| 100 | real_time+=b.real_time; |
---|
| 101 | return *this; |
---|
| 102 | } |
---|
[1005] | 103 | ///\e |
---|
[428] | 104 | TimeStamp operator+(const TimeStamp &b) const |
---|
| 105 | { |
---|
| 106 | TimeStamp t(*this); |
---|
| 107 | return t+=b; |
---|
| 108 | } |
---|
[1005] | 109 | ///\e |
---|
[428] | 110 | TimeStamp &operator-=(const TimeStamp &b) |
---|
| 111 | { |
---|
| 112 | ts.tms_utime-=b.ts.tms_utime; |
---|
| 113 | ts.tms_stime-=b.ts.tms_stime; |
---|
| 114 | ts.tms_cutime-=b.ts.tms_cutime; |
---|
| 115 | ts.tms_cstime-=b.ts.tms_cstime; |
---|
| 116 | real_time-=b.real_time; |
---|
| 117 | return *this; |
---|
| 118 | } |
---|
[1005] | 119 | ///\e |
---|
[428] | 120 | TimeStamp operator-(const TimeStamp &b) const |
---|
| 121 | { |
---|
| 122 | TimeStamp t(*this); |
---|
| 123 | return t-=b; |
---|
| 124 | } |
---|
[1689] | 125 | ///\e |
---|
| 126 | TimeStamp &operator*=(double b) |
---|
| 127 | { |
---|
| 128 | ts.tms_utime*=b; |
---|
| 129 | ts.tms_stime*=b; |
---|
| 130 | ts.tms_cutime*=b; |
---|
| 131 | ts.tms_cstime*=b; |
---|
| 132 | real_time*=b; |
---|
| 133 | return *this; |
---|
| 134 | } |
---|
| 135 | ///\e |
---|
| 136 | TimeStamp operator*(double b) const |
---|
| 137 | { |
---|
| 138 | TimeStamp t(*this); |
---|
| 139 | return t*=b; |
---|
| 140 | } |
---|
| 141 | friend TimeStamp operator*(double b,const TimeStamp &t); |
---|
| 142 | ///\e |
---|
| 143 | TimeStamp &operator/=(double b) |
---|
| 144 | { |
---|
| 145 | ts.tms_utime/=b; |
---|
| 146 | ts.tms_stime/=b; |
---|
| 147 | ts.tms_cutime/=b; |
---|
| 148 | ts.tms_cstime/=b; |
---|
| 149 | real_time/=b; |
---|
| 150 | return *this; |
---|
| 151 | } |
---|
| 152 | ///\e |
---|
| 153 | TimeStamp operator/(double b) const |
---|
| 154 | { |
---|
| 155 | TimeStamp t(*this); |
---|
| 156 | return t/=b; |
---|
| 157 | } |
---|
[428] | 158 | ///The time ellapsed since the last call of stamp() |
---|
| 159 | TimeStamp ellapsed() const |
---|
| 160 | { |
---|
| 161 | TimeStamp t(NULL); |
---|
| 162 | return t-*this; |
---|
| 163 | } |
---|
| 164 | |
---|
| 165 | friend std::ostream& operator<<(std::ostream& os,const TimeStamp &t); |
---|
| 166 | |
---|
| 167 | ///Gives back the user time of the process |
---|
[1689] | 168 | double userTime() const |
---|
[428] | 169 | { |
---|
| 170 | return double(ts.tms_utime)/sysconf(_SC_CLK_TCK); |
---|
| 171 | } |
---|
| 172 | ///Gives back the system time of the process |
---|
[1689] | 173 | double systemTime() const |
---|
[428] | 174 | { |
---|
| 175 | return double(ts.tms_stime)/sysconf(_SC_CLK_TCK); |
---|
| 176 | } |
---|
| 177 | ///Gives back the user time of the process' children |
---|
[1689] | 178 | double cUserTime() const |
---|
[428] | 179 | { |
---|
| 180 | return double(ts.tms_cutime)/sysconf(_SC_CLK_TCK); |
---|
| 181 | } |
---|
| 182 | ///Gives back the user time of the process' children |
---|
[1689] | 183 | double cSystemTime() const |
---|
[428] | 184 | { |
---|
| 185 | return double(ts.tms_cstime)/sysconf(_SC_CLK_TCK); |
---|
| 186 | } |
---|
[1780] | 187 | ///Gives back the real time |
---|
[1689] | 188 | double realTime() const {return real_time;} |
---|
[428] | 189 | }; |
---|
| 190 | |
---|
[1689] | 191 | TimeStamp operator*(double b,const TimeStamp &t) |
---|
| 192 | { |
---|
| 193 | return t*b; |
---|
| 194 | } |
---|
| 195 | |
---|
[1780] | 196 | ///Class for measuring the cpu time and real time usage of the process |
---|
[458] | 197 | |
---|
[1780] | 198 | ///Class for measuring the cpu time and real time usage of the process. |
---|
[458] | 199 | ///It is quite easy-to-use, here is a short example. |
---|
| 200 | ///\code |
---|
[921] | 201 | ///#include<lemon/time_measure.h> |
---|
[696] | 202 | ///#include<iostream> |
---|
[814] | 203 | /// |
---|
[458] | 204 | ///int main() |
---|
| 205 | ///{ |
---|
| 206 | /// |
---|
| 207 | /// ... |
---|
| 208 | /// |
---|
[696] | 209 | /// Timer T; |
---|
[458] | 210 | /// doSomething(); |
---|
[696] | 211 | /// std::cout << T << '\n'; |
---|
[1847] | 212 | /// T.restart(); |
---|
[458] | 213 | /// doSomethingElse(); |
---|
[696] | 214 | /// std::cout << T << '\n'; |
---|
[458] | 215 | /// |
---|
| 216 | /// ... |
---|
| 217 | /// |
---|
| 218 | ///} |
---|
| 219 | ///\endcode |
---|
| 220 | /// |
---|
[1780] | 221 | ///The \ref Timer can also be \ref stop() "stopped" and |
---|
[1806] | 222 | ///\ref start() "started" again, so it is possible to compute collected |
---|
[1780] | 223 | ///running times. |
---|
| 224 | /// |
---|
| 225 | ///\warning Depending on the operation system and its actual configuration |
---|
[1847] | 226 | ///the time counters have a certain (10ms on a typical Linux system) |
---|
| 227 | ///granularity. |
---|
[1780] | 228 | ///Therefore this tool is not appropriate to measure very short times. |
---|
| 229 | ///Also, if you start and stop the timer very frequently, it could lead |
---|
| 230 | ///distorted results. |
---|
| 231 | /// |
---|
| 232 | ///The \ref Timer also counts the number of \ref start() |
---|
| 233 | ///executions, and is stops only after the same amount (or more) |
---|
| 234 | ///\ref stop() "stop()"s. This can be useful e.g. to compute the running time |
---|
| 235 | ///of recursive functions. |
---|
| 236 | /// |
---|
[458] | 237 | ///\todo This shouldn't be Unix (Linux) specific. |
---|
| 238 | /// |
---|
| 239 | ///\author Alpar Juttner |
---|
[428] | 240 | class Timer |
---|
| 241 | { |
---|
[1847] | 242 | int _running; //Timer is running iff _running>0; (_running>=0 always holds) |
---|
[1780] | 243 | TimeStamp start_time; //This is the relativ start-time if the timer |
---|
[1847] | 244 | //is _running, the collected _running time otherwise. |
---|
[1780] | 245 | |
---|
[1847] | 246 | void _reset() {if(_running) start_time.stamp(); else start_time.reset();} |
---|
[428] | 247 | |
---|
| 248 | public: |
---|
[1780] | 249 | ///Constructor. |
---|
| 250 | |
---|
| 251 | ///\param _running indicates whether or not the timer starts immediately. |
---|
| 252 | /// |
---|
[1847] | 253 | Timer(bool run=true) :_running(run) {_reset();} |
---|
[428] | 254 | |
---|
| 255 | ///Computes the ellapsed time |
---|
| 256 | |
---|
| 257 | ///This conversion computes the ellapsed time |
---|
[1780] | 258 | /// |
---|
[1005] | 259 | operator TimeStamp () const |
---|
[428] | 260 | { |
---|
| 261 | TimeStamp t; |
---|
| 262 | t.stamp(); |
---|
[1847] | 263 | return _running?t-start_time:start_time; |
---|
[428] | 264 | } |
---|
| 265 | |
---|
[1847] | 266 | ///Reset and stop the time counters |
---|
[1069] | 267 | |
---|
[1847] | 268 | ///This function resets and stops the time counters |
---|
| 269 | ///\sa restart() |
---|
[1069] | 270 | void reset() |
---|
[428] | 271 | { |
---|
[1847] | 272 | _running=0; |
---|
[428] | 273 | _reset(); |
---|
| 274 | } |
---|
[1005] | 275 | |
---|
[1780] | 276 | ///Start the time counters |
---|
| 277 | |
---|
| 278 | ///This function starts the time counters. |
---|
| 279 | /// |
---|
| 280 | ///If the timer is started more than ones, it will remain running |
---|
| 281 | ///until the same amount of \ref stop() is called. |
---|
| 282 | ///\sa stop() |
---|
| 283 | void start() |
---|
| 284 | { |
---|
[1847] | 285 | if(_running) _running++; |
---|
[1780] | 286 | else { |
---|
[1850] | 287 | _running=1; |
---|
[1780] | 288 | TimeStamp t; |
---|
| 289 | t.stamp(); |
---|
| 290 | start_time=t-start_time; |
---|
| 291 | } |
---|
| 292 | } |
---|
[1847] | 293 | |
---|
[1780] | 294 | |
---|
| 295 | ///Stop the time counters |
---|
[1005] | 296 | |
---|
[1847] | 297 | ///This function stops the time counters. If start() was executed more than |
---|
| 298 | ///once, then the same number of stop() execution is necessary the really |
---|
| 299 | ///stop the timer. |
---|
| 300 | /// |
---|
| 301 | ///\sa halt() |
---|
| 302 | ///\sa start() |
---|
| 303 | ///\sa restart() |
---|
| 304 | ///\sa reset() |
---|
| 305 | |
---|
[1780] | 306 | void stop() |
---|
| 307 | { |
---|
[1847] | 308 | if(_running && !--_running) { |
---|
[1780] | 309 | TimeStamp t; |
---|
| 310 | t.stamp(); |
---|
| 311 | start_time=t-start_time; |
---|
| 312 | } |
---|
| 313 | } |
---|
[1847] | 314 | |
---|
| 315 | ///Halt (i.e stop immediately) the time counters |
---|
| 316 | |
---|
| 317 | ///This function stops immediately the time counters. |
---|
| 318 | /// |
---|
| 319 | ///\sa stop() |
---|
| 320 | ///\sa restart() |
---|
| 321 | ///\sa reset() |
---|
| 322 | |
---|
| 323 | void halt() |
---|
| 324 | { |
---|
| 325 | if(_running) { |
---|
| 326 | _running=0; |
---|
| 327 | TimeStamp t; |
---|
| 328 | t.stamp(); |
---|
| 329 | start_time=t-start_time; |
---|
| 330 | } |
---|
| 331 | } |
---|
| 332 | |
---|
| 333 | ///Returns the running state of the timer |
---|
| 334 | |
---|
| 335 | ///This function returns the number of stop() exections that is |
---|
| 336 | ///necessary to really stop the timer. |
---|
| 337 | ///For example the timer |
---|
| 338 | ///is running if and only if the return value is \c true |
---|
| 339 | ///(i.e. greater than |
---|
| 340 | ///zero). |
---|
| 341 | int running() { return _running; } |
---|
| 342 | |
---|
| 343 | |
---|
| 344 | ///Restart the time counters |
---|
| 345 | |
---|
| 346 | ///This function is a shorthand for |
---|
| 347 | ///a reset() and a start() calls. |
---|
| 348 | /// |
---|
| 349 | void restart() |
---|
| 350 | { |
---|
| 351 | reset(); |
---|
| 352 | start(); |
---|
| 353 | } |
---|
[1780] | 354 | |
---|
[1005] | 355 | ///Gives back the ellapsed user time of the process |
---|
[1689] | 356 | double userTime() const |
---|
[1005] | 357 | { |
---|
[1689] | 358 | return operator TimeStamp().userTime(); |
---|
[1005] | 359 | } |
---|
| 360 | ///Gives back the ellapsed system time of the process |
---|
[1689] | 361 | double systemTime() const |
---|
[1005] | 362 | { |
---|
[1689] | 363 | return operator TimeStamp().systemTime(); |
---|
[1005] | 364 | } |
---|
| 365 | ///Gives back the ellapsed user time of the process' children |
---|
[1689] | 366 | double cUserTime() const |
---|
[1005] | 367 | { |
---|
[1689] | 368 | return operator TimeStamp().cUserTime(); |
---|
[1005] | 369 | } |
---|
| 370 | ///Gives back the ellapsed user time of the process' children |
---|
[1689] | 371 | double cSystemTime() const |
---|
[1005] | 372 | { |
---|
[1689] | 373 | return operator TimeStamp().cSystemTime(); |
---|
[1005] | 374 | } |
---|
[1780] | 375 | ///Gives back the ellapsed real time |
---|
[1689] | 376 | double realTime() const |
---|
[1005] | 377 | { |
---|
[1689] | 378 | return operator TimeStamp().realTime(); |
---|
[1005] | 379 | } |
---|
| 380 | |
---|
[428] | 381 | }; |
---|
| 382 | |
---|
[1847] | 383 | ///Same as \ref Timer but prints a report on destruction. |
---|
| 384 | |
---|
| 385 | ///Same as \ref Timer but prints a report on destruction. |
---|
| 386 | ///\todo Untested |
---|
| 387 | class TimeReport : public Timer |
---|
| 388 | { |
---|
| 389 | std::string _title; |
---|
| 390 | std::ostream &_os; |
---|
| 391 | public: |
---|
| 392 | ///\e |
---|
| 393 | |
---|
| 394 | TimeReport(std::string title,std::ostream &os,bool run) |
---|
| 395 | : Timer(run), _title(title), _os(os){} |
---|
| 396 | ~TimeReport() |
---|
| 397 | { |
---|
| 398 | _os << _title << this << std::endl; |
---|
| 399 | } |
---|
| 400 | }; |
---|
| 401 | |
---|
[428] | 402 | ///Prints the time counters |
---|
| 403 | |
---|
[492] | 404 | ///Prints the time counters in the following form: |
---|
[428] | 405 | /// |
---|
[440] | 406 | /// <tt>u: XX.XXs s: XX.XXs cu: XX.XXs cs: XX.XXs real: XX.XXs</tt> |
---|
[428] | 407 | /// |
---|
| 408 | /// where the values are the |
---|
[440] | 409 | /// \li \c u: user cpu time, |
---|
| 410 | /// \li \c s: system cpu time, |
---|
| 411 | /// \li \c cu: user cpu time of children, |
---|
| 412 | /// \li \c cs: system cpu time of children, |
---|
| 413 | /// \li \c real: real time. |
---|
[814] | 414 | /// \relates TimeStamp |
---|
[428] | 415 | inline std::ostream& operator<<(std::ostream& os,const TimeStamp &t) |
---|
| 416 | { |
---|
| 417 | long cls = sysconf(_SC_CLK_TCK); |
---|
| 418 | os << "u: " << double(t.getTms().tms_utime)/cls << |
---|
| 419 | "s, s: " << double(t.getTms().tms_stime)/cls << |
---|
| 420 | "s, cu: " << double(t.getTms().tms_cutime)/cls << |
---|
| 421 | "s, cs: " << double(t.getTms().tms_cstime)/cls << |
---|
[1689] | 422 | "s, real: " << t.realTime() << "s"; |
---|
[428] | 423 | return os; |
---|
| 424 | } |
---|
| 425 | |
---|
[1689] | 426 | |
---|
| 427 | ///Tool to measure the running time more exactly. |
---|
| 428 | |
---|
| 429 | ///This function calls \c f several times and returns the average |
---|
| 430 | ///running time. The number of the executions will be choosen in such a way |
---|
[1780] | 431 | ///that the full real running time will be roughly between \c min_time |
---|
[1689] | 432 | ///and <tt>2*min_time</tt>. |
---|
| 433 | ///\param f the function object to be measured. |
---|
| 434 | ///\param min_time the minimum total running time. |
---|
| 435 | ///\retval num if it is not \c NULL, then *num will contain the actual |
---|
| 436 | /// number of execution of \c f. |
---|
| 437 | ///\retval full_time if it is not \c NULL, then *full_time |
---|
| 438 | /// will contain the actual |
---|
| 439 | /// total running time. |
---|
| 440 | ///\return The average running time of \c f. |
---|
| 441 | |
---|
| 442 | template<class F> |
---|
[1839] | 443 | TimeStamp runningTimeTest(F f,double min_time=10,int *num = NULL, |
---|
[1689] | 444 | TimeStamp *full_time=NULL) |
---|
| 445 | { |
---|
| 446 | Timer t; |
---|
| 447 | TimeStamp full; |
---|
| 448 | int total=0; |
---|
| 449 | for(int tn=1;tn < 1<<24; tn*=2) { |
---|
[1811] | 450 | for(;total<tn;total++) f(); |
---|
[1689] | 451 | full=t; |
---|
| 452 | if(full.realTime()>min_time) { |
---|
| 453 | if(num) *num=total; |
---|
| 454 | if(full_time) *full_time=full; |
---|
| 455 | return full/total; |
---|
| 456 | } |
---|
| 457 | } |
---|
| 458 | return TimeStamp(); |
---|
| 459 | } |
---|
| 460 | |
---|
[428] | 461 | /// @} |
---|
| 462 | |
---|
[1689] | 463 | |
---|
[921] | 464 | } //namespace lemon |
---|
[428] | 465 | |
---|
[921] | 466 | #endif //LEMON_TIME_MEASURE_H |
---|