secindex_proto/UsageTimer.hh at master · kelseymh/secindex_proto · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
#ifndef USAGE_TIMER_HH
#define USAGE_TIMER_HH 1
// $Id$
// UsageTimer.hh -- Utility to wrap getrusage() for collecting data within
// a program.
//
// 20151023  Michael Kelsey
// 20151026  Add access to memory usage (multiply by ticks)
// 20151114  Replace clock_t with timeval to get wall-clock duration

#include <time.h>
#include <sys/time.h>
#include <sys/resource.h>
#include <iosfwd>

// Global operators to do timeval arithmetic, used by UsageTimer

struct timeval operator+(const struct timeval& tva, const struct timeval& tvb);
struct timeval operator-(const struct timeval& tva, const struct timeval& tvb);
struct timeval& operator+=(struct timeval& tva, const struct timeval& tvb);
struct timeval& operator-=(struct timeval& tva, const struct timeval& tvb);

// Global operators to do rusage arithmetic, used by UsageTimer

struct rusage operator+(const struct rusage& rua, const struct rusage& rub);
struct rusage operator-(const struct rusage& rua, const struct rusage& rub);
struct rusage& operator+=(struct rusage& rua, const struct rusage& rub);
struct rusage& operator-=(struct rusage& rua, const struct rusage& rub);

// Class to do incremental timing

class UsageTimer {
public:
  UsageTimer() { zero(); }
  ~UsageTimer() {;}

  void zero(); 			// Reset total count
  void start();			// Begin recording
  void end();			// Finish recording
  void report(std::ostream& os) const; 		// Print results, like |time|

  double elapsed() const { return tTotal.tv_sec+tTotal.tv_usec/1e6; }
  double userTime() const { return uTotal.ru_utime.tv_sec+uTotal.ru_utime.tv_usec/1e6; }
  double sysTime() const { return uTotal.ru_stime.tv_sec+uTotal.ru_stime.tv_usec/1e6; }
  double cpuTime() const { return userTime()+sysTime(); }
  double cpuEff() const { return cpuTime()/elapsed(); }
  long maxMemory() const { return uTotal.ru_maxrss; }
  double memoryText() const { return (double)uTotal.ru_ixrss/elapsed(); }
  double memoryData() const { return (double)uTotal.ru_idrss/elapsed(); }
  double memoryStack() const { return (double)uTotal.ru_isrss/elapsed(); }
  long pageFaults() const { return uTotal.ru_majflt; }
  long swaps() const { return uTotal.ru_nswap; }
  long ioInput() const { return uTotal.ru_inblock; }
  long ioOutput() const { return uTotal.ru_oublock; }

private:
  struct rusage uStart;		// Collects usage information for report
  struct rusage uEnd;
  struct rusage uTotal;

  struct timeval tStart;	// Collects simple elapsed time, for report
  struct timeval tEnd;
  struct timeval tTotal;

  static const struct rusage uZero;
  static const struct timeval tZero;

};


// Allow direct output of "report()" format

inline std::ostream& operator<<(std::ostream& os, const UsageTimer& usage) {
  usage.report(os);
  return os;
}


#endif	/* USAGE_TIMER_HH */