Ice Sheet System Model  4.18
Code documentation
Public Member Functions | Data Fields
Profiler Class Reference

#include <Profiler.h>

Inheritance diagram for Profiler:
Object

Public Member Functions

 Profiler ()
 
 ~Profiler ()
 
Object * copy ()
 
void DeepEcho ()
 
void Echo ()
 
int Id ()
 
void Marshall (char **pmarshalled_data, int *pmarshalled_data_size, int marshall_direction)
 
int ObjectEnum ()
 
IssmPDouble TotalFlops (int tag)
 
IssmPDouble TotalTime (int tag)
 
int TotalTimeModHour (int tag)
 
int TotalTimeModMin (int tag)
 
int TotalTimeModSec (int tag)
 
IssmPDouble Memory (int tag)
 
void Start (int tagenum, bool dontmpisync=true)
 
void Stop (int tagenum, bool dontmpisync=true)
 
bool Used (int tagenum)
 
- Public Member Functions inherited from Object
virtual ~Object ()
 

Data Fields

IssmPDouble flops [MAXPROFSIZE]
 
IssmPDouble flops_start [MAXPROFSIZE]
 
IssmPDouble memory [MAXPROFSIZE]
 
IssmPDouble memory_start [MAXPROFSIZE]
 
IssmPDouble time [MAXPROFSIZE]
 
IssmPDouble time_start [MAXPROFSIZE]
 
bool running [MAXPROFSIZE]
 
bool used [MAXPROFSIZE]
 

Detailed Description

Definition at line 33 of file Profiler.h.

Constructor & Destructor Documentation

◆ Profiler()

Profiler::Profiler ( )

Definition at line 16 of file Profiler.cpp.

16  {/*{{{*/
17  for(int i=0;i<MAXPROFSIZE;i++){
18  this->time[i] = 0.;
19  this->time_start[i] = 0.;
20  this->flops[i] = 0.;
21  this->flops_start[i] = 0.;
22  this->memory[i] = 0.;
23  this->memory_start[i] = 0.;
24  this->running[i] = false;
25  this->used[i] = false;
26  }
27 } /*}}}*/

◆ ~Profiler()

Profiler::~Profiler ( )

Definition at line 28 of file Profiler.cpp.

28  {/*{{{*/
29  /*Nothing to delete, everything is statically allocated*/
30 } /*}}}*/

Member Function Documentation

◆ copy()

Object * Profiler::copy ( void  )
virtual

Implements Object.

Definition at line 31 of file Profiler.cpp.

31  {/*{{{*/
32  /*First do simple copy: */
33  Profiler* output=new Profiler();
34 
35  for(int i=0;i<MAXPROFSIZE;i++){
36  output->time[i] =this->time[i];
37  output->flops[i] =this->flops[i];
38  output->memory[i]=this->memory[i];
39  }
40 
41  return (Object*)output;
42 }

◆ DeepEcho()

void Profiler::DeepEcho ( void  )
virtual

Implements Object.

Definition at line 46 of file Profiler.cpp.

46  {/*{{{*/
47  this->Echo();
48 }/*}}}*/

◆ Echo()

void Profiler::Echo ( void  )
virtual

Implements Object.

Definition at line 49 of file Profiler.cpp.

49  {/*{{{*/
50 
51  _printf_("Profiler:\n");
52  for(int i=0;i<MAXPROFSIZE;i++){
53  _printf_(" Tag "<<i<<":\n");
54  _printf_(" flops: "<<this->flops[i]<<"\n");
55  _printf_(" memory: "<<this->memory[i]<<"\n");
56  _printf_(" time: "<<this->time[i]<<"\n");
57  _printf_(" running: "<<this->time[i]<<"\n");
58  }
59 
60 }

◆ Id()

int Profiler::Id ( void  )
virtual

Implements Object.

Definition at line 62 of file Profiler.cpp.

62  { /*{{{*/
63  return -1;
64 }

◆ Marshall()

void Profiler::Marshall ( char **  pmarshalled_data,
int *  pmarshalled_data_size,
int  marshall_direction 
)
virtual

Implements Object.

Definition at line 66 of file Profiler.cpp.

66  { /*{{{*/
67 
68  IssmPDouble* pointer = NULL;
69  bool* bpointer = NULL;
70 
71  MARSHALLING_ENUM(ProfilerEnum);
72  pointer = &this->time[0];
73  MARSHALLING_DYNAMIC(pointer,IssmPDouble,MAXPROFSIZE);
74  pointer = &this->flops[0];
75  MARSHALLING_DYNAMIC(pointer,IssmPDouble,MAXPROFSIZE);
76  pointer = &this->memory[0];
77  MARSHALLING_DYNAMIC(pointer,IssmPDouble,MAXPROFSIZE);
78  bpointer = &this->running[0];
79  MARSHALLING_DYNAMIC(bpointer,bool,MAXPROFSIZE);
80 
81 } /*}}}*/

◆ ObjectEnum()

int Profiler::ObjectEnum ( void  )
virtual

Implements Object.

Definition at line 82 of file Profiler.cpp.

82  {/*{{{*/
83  return ProfilerEnum;
84 }/*}}}*/

◆ TotalFlops()

IssmPDouble Profiler::TotalFlops ( int  tag)

Definition at line 87 of file Profiler.cpp.

87  {/*{{{*/
88 
89  /*Get tag*/
90  _assert_(tag>=0);
91  _assert_(tag<MAXPROFSIZE);
92  if(this->running[tag]) _error_("Tag "<<tag<<" has not been stopped");
93 
94  return this->flops[tag];
95 }/*}}}*/

◆ TotalTime()

IssmPDouble Profiler::TotalTime ( int  tag)

Definition at line 96 of file Profiler.cpp.

96  {/*{{{*/
97 
98  /*Get tag*/
99  _assert_(tag>=0);
100  _assert_(tag<MAXPROFSIZE);
101  if(this->running[tag]) _error_("Tag "<<tag<<" has not been stopped");
102 
103  #ifdef _HAVE_MPI_
104  return this->time[tag];
105  #else
106  return this->time[tag]/CLOCKS_PER_SEC;
107  #endif
108 }

◆ TotalTimeModHour()

int Profiler::TotalTimeModHour ( int  tag)

Definition at line 110 of file Profiler.cpp.

110  {/*{{{*/
111 
112  IssmPDouble delta = this->TotalTime(tag);
113  return int((reCast<int,IssmPDouble>(delta))/3600);
114 
115 }

◆ TotalTimeModMin()

int Profiler::TotalTimeModMin ( int  tag)

Definition at line 117 of file Profiler.cpp.

117  {/*{{{*/
118 
119  IssmPDouble delta = this->TotalTime(tag);
120  return int(int(reCast<int,IssmPDouble>(delta))%3600/60);
121 }

◆ TotalTimeModSec()

int Profiler::TotalTimeModSec ( int  tag)

Definition at line 123 of file Profiler.cpp.

123  {/*{{{*/
124 
125  IssmPDouble delta = this->TotalTime(tag);
126  return int(reCast<int,IssmPDouble>(delta)%60);
127 }

◆ Memory()

IssmPDouble Profiler::Memory ( int  tag)

Definition at line 129 of file Profiler.cpp.

129  {/*{{{*/
130 
131  /*Get initial flops*/
132  _assert_(tag>=0);
133  _assert_(tag<MAXPROFSIZE);
134  if(this->running[tag]) _error_("Tag "<<tag<<" has not been stopped");
135 
136  return this->memory[tag];
137 }

◆ Start()

void Profiler::Start ( int  tagenum,
bool  dontmpisync = true 
)

Definition at line 139 of file Profiler.cpp.

139  {/*{{{*/
140 
141  /*Check tag*/
142  _assert_(tag>=0);
143  _assert_(tag<MAXPROFSIZE);
144  if(this->running[tag]) _error_("Tag "<<tag<<" is already running");
145 
146  /*If mpisync requested, make sure all the cpus are at the same point in the execution: */
147  if(!dontmpisync){
148  ISSM_MPI_Barrier(IssmComm::GetComm());
149  }
150 
151  /*Capture time: */
152  #ifdef _HAVE_MPI_
153  IssmPDouble t=ISSM_MPI_Wtime();
154  #else
155  IssmPDouble t=(IssmPDouble)clock();
156  #endif
157 
158  /*Capture flops: */
159  IssmPDouble f = 0.;
160  IssmPDouble m = 0.;
161  #ifdef _HAVE_PETSC_
162  PetscGetFlops(&f);
163  PetscMemoryGetCurrentUsage(&m);
164  #else
165  /*do nothing for now:*/
166  #endif
167 
168  /*Plug into this->time: */
169  _assert_(tag>=0);
170  _assert_(tag<MAXPROFSIZE);
171  this->time_start[tag] = t;
172  this->flops_start[tag] = f;
173  this->memory_start[tag] = m;
174 
175  /*turn on running*/
176  this->running[tag] = true;
177  this->used[tag] = true;
178 }/*}}}*/

◆ Stop()

void Profiler::Stop ( int  tagenum,
bool  dontmpisync = true 
)

Definition at line 179 of file Profiler.cpp.

179  {/*{{{*/
180 
181  /*Check tag*/
182  _assert_(tag>=0);
183  _assert_(tag<MAXPROFSIZE);
184  if(!this->running[tag]) _error_("Tag "<<tag<<" is not running");
185 
186  /*If mpisync requested, make sure all the cpus are at the same point in the execution: */
187  if(!dontmpisync){
188  ISSM_MPI_Barrier(IssmComm::GetComm());
189  }
190 
191  /*Capture time: */
192  #ifdef _HAVE_MPI_
193  IssmPDouble t=ISSM_MPI_Wtime();
194  #else
195  IssmPDouble t=(IssmPDouble)clock();
196  #endif
197 
198  /*Capture flops: */
199  IssmPDouble f = 0.;
200  IssmPDouble m = 0.;
201  #ifdef _HAVE_PETSC_
202  PetscGetFlops(&f);
203  PetscMemoryGetCurrentUsage(&m);
204  #else
205  /*do nothing for now:*/
206  #endif
207 
208  /*Plug into this->time: */
209  _assert_(tag>=0);
210  _assert_(tag<MAXPROFSIZE);
211  this->time[tag] += t - this->time_start[tag];
212  this->flops[tag] += f - this->flops_start[tag];
213  this->memory[tag] += m - this->memory_start[tag];
214 
215  /*turn off running*/
216  this->running[tag] = false;
217 }/*}}}*/

◆ Used()

bool Profiler::Used ( int  tagenum)

Definition at line 218 of file Profiler.cpp.

218  {/*{{{*/
219 
220  /*Check tag*/
221  _assert_(tag>=0);
222  _assert_(tag<MAXPROFSIZE);
223  return this->used[tag];
224 }/*}}}*/

Field Documentation

◆ flops

IssmPDouble Profiler::flops[MAXPROFSIZE]

Definition at line 36 of file Profiler.h.

◆ flops_start

IssmPDouble Profiler::flops_start[MAXPROFSIZE]

Definition at line 37 of file Profiler.h.

◆ memory

IssmPDouble Profiler::memory[MAXPROFSIZE]

Definition at line 38 of file Profiler.h.

◆ memory_start

IssmPDouble Profiler::memory_start[MAXPROFSIZE]

Definition at line 39 of file Profiler.h.

◆ time

IssmPDouble Profiler::time[MAXPROFSIZE]

Definition at line 40 of file Profiler.h.

◆ time_start

IssmPDouble Profiler::time_start[MAXPROFSIZE]

Definition at line 41 of file Profiler.h.

◆ running

bool Profiler::running[MAXPROFSIZE]

Definition at line 42 of file Profiler.h.

◆ used

bool Profiler::used[MAXPROFSIZE]

Definition at line 43 of file Profiler.h.

The documentation for this class was generated from the following files:
Profiler::memory_start
IssmPDouble memory_start[MAXPROFSIZE]
Definition: Profiler.h:39
_assert_
#define _assert_(ignore)
Definition: exceptions.h:37
ProfilerEnum
@ ProfilerEnum
Definition: EnumDefinitions.h:1233
_printf_
#define _printf_(StreamArgs)
Definition: Print.h:22
MARSHALLING_ENUM
#define MARSHALLING_ENUM(EN)
Definition: Marshalling.h:14
IssmComm::GetComm
static ISSM_MPI_Comm GetComm(void)
Definition: IssmComm.cpp:30
Profiler::time_start
IssmPDouble time_start[MAXPROFSIZE]
Definition: Profiler.h:41
Profiler::memory
IssmPDouble memory[MAXPROFSIZE]
Definition: Profiler.h:38
MARSHALLING_DYNAMIC
#define MARSHALLING_DYNAMIC(FIELD, TYPE, SIZE)
Definition: Marshalling.h:61
Profiler::time
IssmPDouble time[MAXPROFSIZE]
Definition: Profiler.h:40
Object
Definition: Object.h:13
Profiler
Definition: Profiler.h:33
MAXPROFSIZE
#define MAXPROFSIZE
Definition: Profiler.h:30
Profiler::flops
IssmPDouble flops[MAXPROFSIZE]
Definition: Profiler.h:36
Profiler::used
bool used[MAXPROFSIZE]
Definition: Profiler.h:43
Profiler::Profiler
Profiler()
Definition: Profiler.cpp:16
_error_
#define _error_(StreamArgs)
Definition: exceptions.h:49
Profiler::flops_start
IssmPDouble flops_start[MAXPROFSIZE]
Definition: Profiler.h:37
ISSM_MPI_Wtime
double ISSM_MPI_Wtime(void)
Definition: issmmpi.cpp:511
Profiler::running
bool running[MAXPROFSIZE]
Definition: Profiler.h:42
ISSM_MPI_Barrier
int ISSM_MPI_Barrier(ISSM_MPI_Comm comm)
Definition: issmmpi.cpp:148
Profiler::Echo
void Echo()
Definition: Profiler.cpp:49
IssmPDouble
IssmDouble IssmPDouble
Definition: types.h:38
Profiler::TotalTime
IssmPDouble TotalTime(int tag)
Definition: Profiler.cpp:96
Generated on Thu Jul 2 2020 08:09:30 for Ice Sheet System Model by   doxygen 1.8.19