xref: /petsc/src/sys/logging/plog.c (revision 7de69702b957b5de648b60762d01f4e5276d32ac)
15c6c1daeSBarry Smith 
25c6c1daeSBarry Smith /*
35c6c1daeSBarry Smith       PETSc code to log object creation and destruction and PETSc events.
45c6c1daeSBarry Smith 
55c6c1daeSBarry Smith       This provides the public API used by the rest of PETSc and by users.
65c6c1daeSBarry Smith 
75c6c1daeSBarry Smith       These routines use a private API that is not used elsewhere in PETSc and is not
85c6c1daeSBarry Smith       accessible to users. The private API is defined in logimpl.h and the utils directory.
95c6c1daeSBarry Smith 
105c6c1daeSBarry Smith */
11af0996ceSBarry Smith #include <petsc/private/logimpl.h> /*I    "petscsys.h"   I*/
125c6c1daeSBarry Smith #include <petsctime.h>
13665c2dedSJed Brown #include <petscviewer.h>
148fe3844cSJunchao Zhang #include <petscdevice.h>
158fe3844cSJunchao Zhang #include <petsc/private/deviceimpl.h>
16a0c7f9aaSSamuel Khuvis #if defined(PETSC_HAVE_TAU_PERFSTUBS)
17a0c7f9aaSSamuel Khuvis   #include <../src/sys/perfstubs/timer.h>
18a0c7f9aaSSamuel Khuvis #endif
195c6c1daeSBarry Smith 
205c6c1daeSBarry Smith PetscLogEvent PETSC_LARGEST_EVENT = PETSC_EVENT;
215c6c1daeSBarry Smith 
225c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
235c6c1daeSBarry Smith   #include <petscmachineinfo.h>
245c6c1daeSBarry Smith   #include <petscconfiginfo.h>
255c6c1daeSBarry Smith 
26c708d6e3SStefano Zampini   #if defined(PETSC_HAVE_THREADSAFETY)
27c708d6e3SStefano Zampini 
28c708d6e3SStefano Zampini PetscInt           petsc_log_gid = -1; /* Global threadId counter */
29c708d6e3SStefano Zampini PETSC_TLS PetscInt petsc_log_tid = -1; /* Local threadId */
30c708d6e3SStefano Zampini 
31c708d6e3SStefano Zampini /* shared variables */
32c708d6e3SStefano Zampini PetscSpinlock  PetscLogSpinLock;
33c708d6e3SStefano Zampini PetscHMapEvent eventInfoMap_th = NULL;
34c708d6e3SStefano Zampini 
35c708d6e3SStefano Zampini   #endif
36c708d6e3SStefano Zampini 
375c6c1daeSBarry Smith /* used in the MPI_XXX() count macros in petsclog.h */
385c6c1daeSBarry Smith 
395c6c1daeSBarry Smith /* Action and object logging variables */
400298fd71SBarry Smith Action   *petsc_actions    = NULL;
410298fd71SBarry Smith Object   *petsc_objects    = NULL;
425c6c1daeSBarry Smith PetscBool petsc_logActions = PETSC_FALSE;
435c6c1daeSBarry Smith PetscBool petsc_logObjects = PETSC_FALSE;
445c6c1daeSBarry Smith int       petsc_numActions = 0, petsc_maxActions = 100;
455c6c1daeSBarry Smith int       petsc_numObjects = 0, petsc_maxObjects = 100;
465c6c1daeSBarry Smith int       petsc_numObjectsDestroyed = 0;
475c6c1daeSBarry Smith 
485c6c1daeSBarry Smith /* Global counters */
495c6c1daeSBarry Smith PetscLogDouble petsc_BaseTime        = 0.0;
505c6c1daeSBarry Smith PetscLogDouble petsc_TotalFlops      = 0.0; /* The number of flops */
515c6c1daeSBarry Smith PetscLogDouble petsc_send_ct         = 0.0; /* The number of sends */
525c6c1daeSBarry Smith PetscLogDouble petsc_recv_ct         = 0.0; /* The number of receives */
535c6c1daeSBarry Smith PetscLogDouble petsc_send_len        = 0.0; /* The total length of all sent messages */
545c6c1daeSBarry Smith PetscLogDouble petsc_recv_len        = 0.0; /* The total length of all received messages */
555c6c1daeSBarry Smith PetscLogDouble petsc_isend_ct        = 0.0; /* The number of immediate sends */
565c6c1daeSBarry Smith PetscLogDouble petsc_irecv_ct        = 0.0; /* The number of immediate receives */
575c6c1daeSBarry Smith PetscLogDouble petsc_isend_len       = 0.0; /* The total length of all immediate send messages */
585c6c1daeSBarry Smith PetscLogDouble petsc_irecv_len       = 0.0; /* The total length of all immediate receive messages */
595c6c1daeSBarry Smith PetscLogDouble petsc_wait_ct         = 0.0; /* The number of waits */
605c6c1daeSBarry Smith PetscLogDouble petsc_wait_any_ct     = 0.0; /* The number of anywaits */
615c6c1daeSBarry Smith PetscLogDouble petsc_wait_all_ct     = 0.0; /* The number of waitalls */
625c6c1daeSBarry Smith PetscLogDouble petsc_sum_of_waits_ct = 0.0; /* The total number of waits */
635c6c1daeSBarry Smith PetscLogDouble petsc_allreduce_ct    = 0.0; /* The number of reductions */
645c6c1daeSBarry Smith PetscLogDouble petsc_gather_ct       = 0.0; /* The number of gathers and gathervs */
655c6c1daeSBarry Smith PetscLogDouble petsc_scatter_ct      = 0.0; /* The number of scatters and scattervs */
66c708d6e3SStefano Zampini 
67c708d6e3SStefano Zampini /* Thread Local storage */
68c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_TotalFlops_th      = 0.0;
69c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_send_ct_th         = 0.0;
70c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_recv_ct_th         = 0.0;
71c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_send_len_th        = 0.0;
72c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_recv_len_th        = 0.0;
73c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_isend_ct_th        = 0.0;
74c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_irecv_ct_th        = 0.0;
75c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_isend_len_th       = 0.0;
76c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_irecv_len_th       = 0.0;
77c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_wait_ct_th         = 0.0;
78c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_wait_any_ct_th     = 0.0;
79c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_wait_all_ct_th     = 0.0;
80c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_sum_of_waits_ct_th = 0.0;
81c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_allreduce_ct_th    = 0.0;
82c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_gather_ct_th       = 0.0;
83c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_scatter_ct_th      = 0.0;
84c708d6e3SStefano Zampini 
8520c24465SJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
86bec0b493Shannah_mairs PetscLogDouble petsc_ctog_ct        = 0.0; /* The total number of CPU to GPU copies */
87bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_ct        = 0.0; /* The total number of GPU to CPU copies */
88bec0b493Shannah_mairs PetscLogDouble petsc_ctog_sz        = 0.0; /* The total size of CPU to GPU copies */
89bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_sz        = 0.0; /* The total size of GPU to CPU copies */
9045c4b7c1SBarry Smith PetscLogDouble petsc_ctog_ct_scalar = 0.0; /* The total number of CPU to GPU copies */
9145c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_ct_scalar = 0.0; /* The total number of GPU to CPU copies */
9245c4b7c1SBarry Smith PetscLogDouble petsc_ctog_sz_scalar = 0.0; /* The total size of CPU to GPU copies */
9345c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_sz_scalar = 0.0; /* The total size of GPU to CPU copies */
94958c4211Shannah_mairs PetscLogDouble petsc_gflops         = 0.0; /* The flops done on a GPU */
95958c4211Shannah_mairs PetscLogDouble petsc_gtime          = 0.0; /* The time spent on a GPU */
96c708d6e3SStefano Zampini 
97c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_ctog_ct_th        = 0.0;
98c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_gtoc_ct_th        = 0.0;
99c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_ctog_sz_th        = 0.0;
100c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_gtoc_sz_th        = 0.0;
101c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_ctog_ct_scalar_th = 0.0;
102c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_gtoc_ct_scalar_th = 0.0;
103c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_ctog_sz_scalar_th = 0.0;
104c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_gtoc_sz_scalar_th = 0.0;
105c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_gflops_th         = 0.0;
106c708d6e3SStefano Zampini PETSC_TLS PetscLogDouble petsc_gtime_th          = 0.0;
107c708d6e3SStefano Zampini   #endif
108c708d6e3SStefano Zampini 
109c708d6e3SStefano Zampini   #if defined(PETSC_HAVE_THREADSAFETY)
110c708d6e3SStefano Zampini PetscErrorCode PetscAddLogDouble(PetscLogDouble *tot, PetscLogDouble *tot_th, PetscLogDouble tmp)
111c708d6e3SStefano Zampini {
112c708d6e3SStefano Zampini   *tot_th += tmp;
1133ba16761SJacob Faibussowitsch   PetscCall(PetscSpinlockLock(&PetscLogSpinLock));
114c708d6e3SStefano Zampini   *tot += tmp;
1153ba16761SJacob Faibussowitsch   PetscCall(PetscSpinlockUnlock(&PetscLogSpinLock));
1163ba16761SJacob Faibussowitsch   return PETSC_SUCCESS;
117c708d6e3SStefano Zampini }
118c708d6e3SStefano Zampini 
119c708d6e3SStefano Zampini PetscErrorCode PetscAddLogDoubleCnt(PetscLogDouble *cnt, PetscLogDouble *tot, PetscLogDouble *cnt_th, PetscLogDouble *tot_th, PetscLogDouble tmp)
120c708d6e3SStefano Zampini {
121c708d6e3SStefano Zampini   *cnt_th = *cnt_th + 1;
122c708d6e3SStefano Zampini   *tot_th += tmp;
1233ba16761SJacob Faibussowitsch   PetscCall(PetscSpinlockLock(&PetscLogSpinLock));
124c708d6e3SStefano Zampini   *tot += (PetscLogDouble)(tmp);
125c708d6e3SStefano Zampini   *cnt += *cnt + 1;
1263ba16761SJacob Faibussowitsch   PetscCall(PetscSpinlockUnlock(&PetscLogSpinLock));
1273ba16761SJacob Faibussowitsch   return PETSC_SUCCESS;
128c708d6e3SStefano Zampini }
129c708d6e3SStefano Zampini 
130c708d6e3SStefano Zampini PetscInt PetscLogGetTid(void)
131c708d6e3SStefano Zampini {
132c708d6e3SStefano Zampini   if (petsc_log_tid < 0) {
1333ba16761SJacob Faibussowitsch     PetscCall(PetscSpinlockLock(&PetscLogSpinLock));
134c708d6e3SStefano Zampini     petsc_log_tid = ++petsc_log_gid;
1353ba16761SJacob Faibussowitsch     PetscCall(PetscSpinlockUnlock(&PetscLogSpinLock));
136c708d6e3SStefano Zampini   }
137c708d6e3SStefano Zampini   return petsc_log_tid;
138c708d6e3SStefano Zampini }
139c708d6e3SStefano Zampini 
140bec0b493Shannah_mairs   #endif
1415c6c1daeSBarry Smith 
1425c6c1daeSBarry Smith /* Logging functions */
1430298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject)                                                            = NULL;
1440298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject)                                                            = NULL;
1450298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL;
1460298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL;
1475c6c1daeSBarry Smith 
1485c6c1daeSBarry Smith /* Tracing event logging variables */
1490298fd71SBarry Smith FILE            *petsc_tracefile          = NULL;
1505c6c1daeSBarry Smith int              petsc_tracelevel         = 0;
1515c6c1daeSBarry Smith const char      *petsc_traceblanks        = "                                                                                                    ";
1525c6c1daeSBarry Smith char             petsc_tracespace[128]    = " ";
1535c6c1daeSBarry Smith PetscLogDouble   petsc_tracetime          = 0.0;
154896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE;
1555c6c1daeSBarry Smith 
1567a101e5eSJacob Faibussowitsch static PetscIntStack current_log_event_stack = NULL;
1577a101e5eSJacob Faibussowitsch 
158d71ae5a4SJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogInitialize(void)
159d71ae5a4SJacob Faibussowitsch {
160fa2bb9feSLisandro Dalcin   int       stage;
161fa2bb9feSLisandro Dalcin   PetscBool opt;
1625c6c1daeSBarry Smith 
163fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
1643ba16761SJacob Faibussowitsch   if (PetscLogInitializeCalled) PetscFunctionReturn(PETSC_SUCCESS);
165fa2bb9feSLisandro Dalcin   PetscLogInitializeCalled = PETSC_TRUE;
1665c6c1daeSBarry Smith 
1677a101e5eSJacob Faibussowitsch   PetscCall(PetscIntStackCreate(&current_log_event_stack));
1689566063dSJacob Faibussowitsch   PetscCall(PetscOptionsHasName(NULL, NULL, "-log_exclude_actions", &opt));
169fa2bb9feSLisandro Dalcin   if (opt) petsc_logActions = PETSC_FALSE;
1709566063dSJacob Faibussowitsch   PetscCall(PetscOptionsHasName(NULL, NULL, "-log_exclude_objects", &opt));
171fa2bb9feSLisandro Dalcin   if (opt) petsc_logObjects = PETSC_FALSE;
17248a46eb9SPierre Jolivet   if (petsc_logActions) PetscCall(PetscMalloc1(petsc_maxActions, &petsc_actions));
17348a46eb9SPierre Jolivet   if (petsc_logObjects) PetscCall(PetscMalloc1(petsc_maxObjects, &petsc_objects));
174fa2bb9feSLisandro Dalcin   PetscLogPHC = PetscLogObjCreateDefault;
175fa2bb9feSLisandro Dalcin   PetscLogPHD = PetscLogObjDestroyDefault;
176fa2bb9feSLisandro Dalcin   /* Setup default logging structures */
1779566063dSJacob Faibussowitsch   PetscCall(PetscStageLogCreate(&petsc_stageLog));
1789566063dSJacob Faibussowitsch   PetscCall(PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage));
1795c6c1daeSBarry Smith 
180c708d6e3SStefano Zampini   PetscCall(PetscSpinlockCreate(&PetscLogSpinLock));
181c708d6e3SStefano Zampini   #if defined(PETSC_HAVE_THREADSAFETY)
182c708d6e3SStefano Zampini   petsc_log_tid = 0;
183c708d6e3SStefano Zampini   petsc_log_gid = 0;
184c708d6e3SStefano Zampini   PetscCall(PetscHMapEventCreate(&eventInfoMap_th));
185c708d6e3SStefano Zampini   #endif
186c708d6e3SStefano Zampini 
187fa2bb9feSLisandro Dalcin   /* All processors sync here for more consistent logging */
1889566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Barrier(PETSC_COMM_WORLD));
1893ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&petsc_BaseTime));
1909566063dSJacob Faibussowitsch   PetscCall(PetscLogStagePush(stage));
191a0c7f9aaSSamuel Khuvis   #if defined(PETSC_HAVE_TAU_PERFSTUBS)
192a0c7f9aaSSamuel Khuvis   PetscStackCallExternalVoid("ps_initialize_", ps_initialize_());
193a0c7f9aaSSamuel Khuvis   #endif
1943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
195fa2bb9feSLisandro Dalcin }
1965c6c1daeSBarry Smith 
197d71ae5a4SJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogFinalize(void)
198d71ae5a4SJacob Faibussowitsch {
1995c6c1daeSBarry Smith   PetscStageLog stageLog;
2005c6c1daeSBarry Smith 
2015c6c1daeSBarry Smith   PetscFunctionBegin;
202c708d6e3SStefano Zampini   #if defined(PETSC_HAVE_THREADSAFETY)
203c708d6e3SStefano Zampini   if (eventInfoMap_th) {
204c708d6e3SStefano Zampini     PetscEventPerfInfo **array;
205c708d6e3SStefano Zampini     PetscInt             n, off = 0;
206c708d6e3SStefano Zampini 
207c708d6e3SStefano Zampini     PetscCall(PetscHMapEventGetSize(eventInfoMap_th, &n));
208c708d6e3SStefano Zampini     PetscCall(PetscMalloc1(n, &array));
209c708d6e3SStefano Zampini     PetscCall(PetscHMapEventGetVals(eventInfoMap_th, &off, array));
210c708d6e3SStefano Zampini     for (PetscInt i = 0; i < n; i++) PetscCall(PetscFree(array[i]));
211c708d6e3SStefano Zampini     PetscCall(PetscFree(array));
212c708d6e3SStefano Zampini     PetscCall(PetscHMapEventDestroy(&eventInfoMap_th));
213c708d6e3SStefano Zampini   }
214c708d6e3SStefano Zampini   #endif
2159566063dSJacob Faibussowitsch   PetscCall(PetscFree(petsc_actions));
2169566063dSJacob Faibussowitsch   PetscCall(PetscFree(petsc_objects));
2179566063dSJacob Faibussowitsch   PetscCall(PetscLogNestedEnd());
2189566063dSJacob Faibussowitsch   PetscCall(PetscLogSet(NULL, NULL));
2195c6c1daeSBarry Smith 
2205c6c1daeSBarry Smith   /* Resetting phase */
2219566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
2229566063dSJacob Faibussowitsch   PetscCall(PetscStageLogDestroy(stageLog));
2237a101e5eSJacob Faibussowitsch   PetscCall(PetscIntStackDestroy(current_log_event_stack));
2247a101e5eSJacob Faibussowitsch   current_log_event_stack = NULL;
225a297a907SKarl Rupp 
2265c6c1daeSBarry Smith   petsc_TotalFlops          = 0.0;
2275c6c1daeSBarry Smith   petsc_numActions          = 0;
2285c6c1daeSBarry Smith   petsc_numObjects          = 0;
2295c6c1daeSBarry Smith   petsc_numObjectsDestroyed = 0;
2305c6c1daeSBarry Smith   petsc_maxActions          = 100;
2315c6c1daeSBarry Smith   petsc_maxObjects          = 100;
2320298fd71SBarry Smith   petsc_actions             = NULL;
2330298fd71SBarry Smith   petsc_objects             = NULL;
2345c6c1daeSBarry Smith   petsc_logActions          = PETSC_FALSE;
2355c6c1daeSBarry Smith   petsc_logObjects          = PETSC_FALSE;
2365c6c1daeSBarry Smith   petsc_BaseTime            = 0.0;
2375c6c1daeSBarry Smith   petsc_TotalFlops          = 0.0;
2385c6c1daeSBarry Smith   petsc_send_ct             = 0.0;
2395c6c1daeSBarry Smith   petsc_recv_ct             = 0.0;
2405c6c1daeSBarry Smith   petsc_send_len            = 0.0;
2415c6c1daeSBarry Smith   petsc_recv_len            = 0.0;
2425c6c1daeSBarry Smith   petsc_isend_ct            = 0.0;
2435c6c1daeSBarry Smith   petsc_irecv_ct            = 0.0;
2445c6c1daeSBarry Smith   petsc_isend_len           = 0.0;
2455c6c1daeSBarry Smith   petsc_irecv_len           = 0.0;
2465c6c1daeSBarry Smith   petsc_wait_ct             = 0.0;
2475c6c1daeSBarry Smith   petsc_wait_any_ct         = 0.0;
2485c6c1daeSBarry Smith   petsc_wait_all_ct         = 0.0;
2495c6c1daeSBarry Smith   petsc_sum_of_waits_ct     = 0.0;
2505c6c1daeSBarry Smith   petsc_allreduce_ct        = 0.0;
2515c6c1daeSBarry Smith   petsc_gather_ct           = 0.0;
2525c6c1daeSBarry Smith   petsc_scatter_ct          = 0.0;
253c708d6e3SStefano Zampini   petsc_TotalFlops_th       = 0.0;
254c708d6e3SStefano Zampini   petsc_send_ct_th          = 0.0;
255c708d6e3SStefano Zampini   petsc_recv_ct_th          = 0.0;
256c708d6e3SStefano Zampini   petsc_send_len_th         = 0.0;
257c708d6e3SStefano Zampini   petsc_recv_len_th         = 0.0;
258c708d6e3SStefano Zampini   petsc_isend_ct_th         = 0.0;
259c708d6e3SStefano Zampini   petsc_irecv_ct_th         = 0.0;
260c708d6e3SStefano Zampini   petsc_isend_len_th        = 0.0;
261c708d6e3SStefano Zampini   petsc_irecv_len_th        = 0.0;
262c708d6e3SStefano Zampini   petsc_wait_ct_th          = 0.0;
263c708d6e3SStefano Zampini   petsc_wait_any_ct_th      = 0.0;
264c708d6e3SStefano Zampini   petsc_wait_all_ct_th      = 0.0;
265c708d6e3SStefano Zampini   petsc_sum_of_waits_ct_th  = 0.0;
266c708d6e3SStefano Zampini   petsc_allreduce_ct_th     = 0.0;
267c708d6e3SStefano Zampini   petsc_gather_ct_th        = 0.0;
268c708d6e3SStefano Zampini   petsc_scatter_ct_th       = 0.0;
269c708d6e3SStefano Zampini 
270d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
271bec0b493Shannah_mairs   petsc_ctog_ct    = 0.0;
272bec0b493Shannah_mairs   petsc_gtoc_ct    = 0.0;
273bec0b493Shannah_mairs   petsc_ctog_sz    = 0.0;
274bec0b493Shannah_mairs   petsc_gtoc_sz    = 0.0;
275958c4211Shannah_mairs   petsc_gflops     = 0.0;
276958c4211Shannah_mairs   petsc_gtime      = 0.0;
277c708d6e3SStefano Zampini   petsc_ctog_ct_th = 0.0;
278c708d6e3SStefano Zampini   petsc_gtoc_ct_th = 0.0;
279c708d6e3SStefano Zampini   petsc_ctog_sz_th = 0.0;
280c708d6e3SStefano Zampini   petsc_gtoc_sz_th = 0.0;
281c708d6e3SStefano Zampini   petsc_gflops_th  = 0.0;
282c708d6e3SStefano Zampini   petsc_gtime_th   = 0.0;
283bec0b493Shannah_mairs   #endif
284c708d6e3SStefano Zampini 
2855c6c1daeSBarry Smith   PETSC_LARGEST_EVENT      = PETSC_EVENT;
2860298fd71SBarry Smith   PetscLogPHC              = NULL;
2870298fd71SBarry Smith   PetscLogPHD              = NULL;
2880298fd71SBarry Smith   petsc_tracefile          = NULL;
2895c6c1daeSBarry Smith   petsc_tracelevel         = 0;
2905c6c1daeSBarry Smith   petsc_traceblanks        = "                                                                                                    ";
2919371c9d4SSatish Balay   petsc_tracespace[0]      = ' ';
2929371c9d4SSatish Balay   petsc_tracespace[1]      = 0;
2935c6c1daeSBarry Smith   petsc_tracetime          = 0.0;
2945c6c1daeSBarry Smith   PETSC_LARGEST_CLASSID    = PETSC_SMALLEST_CLASSID;
2955c6c1daeSBarry Smith   PETSC_OBJECT_CLASSID     = 0;
29602c9f0b5SLisandro Dalcin   petsc_stageLog           = NULL;
297896238b9SBarry Smith   PetscLogInitializeCalled = PETSC_FALSE;
2983ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2995c6c1daeSBarry Smith }
3005c6c1daeSBarry Smith 
3015c6c1daeSBarry Smith /*@C
3025c6c1daeSBarry Smith   PetscLogSet - Sets the logging functions called at the beginning and ending of every event.
3035c6c1daeSBarry Smith 
3045c6c1daeSBarry Smith   Not Collective
3055c6c1daeSBarry Smith 
3065c6c1daeSBarry Smith   Input Parameters:
3075c6c1daeSBarry Smith + b - The function called at beginning of event
3085c6c1daeSBarry Smith - e - The function called at end of event
3095c6c1daeSBarry Smith 
3105c6c1daeSBarry Smith   Level: developer
3115c6c1daeSBarry Smith 
312811af0c4SBarry Smith   Developer Note:
313811af0c4SBarry Smith   The default loggers are `PetscLogEventBeginDefault()` and `PetscLogEventEndDefault()`.
314811af0c4SBarry Smith 
315d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogTraceBegin()`, `PetscLogEventBeginDefault()`, `PetscLogEventEndDefault()`
3165c6c1daeSBarry Smith @*/
317d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject))
318d71ae5a4SJacob Faibussowitsch {
3195c6c1daeSBarry Smith   PetscFunctionBegin;
3205c6c1daeSBarry Smith   PetscLogPLB = b;
3215c6c1daeSBarry Smith   PetscLogPLE = e;
3223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3235c6c1daeSBarry Smith }
3245c6c1daeSBarry Smith 
3255c6c1daeSBarry Smith /*@C
3264dd65854SConnor Ward   PetscLogIsActive - Check if logging is currently in progress.
3274dd65854SConnor Ward 
3284dd65854SConnor Ward   Not Collective
3294dd65854SConnor Ward 
3304dd65854SConnor Ward   Output Parameter:
331811af0c4SBarry Smith . isActive - `PETSC_TRUE` if logging is in progress, `PETSC_FALSE` otherwise
3324dd65854SConnor Ward 
3334dd65854SConnor Ward   Level: beginner
3344dd65854SConnor Ward 
335d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogSet()`
3364dd65854SConnor Ward @*/
337d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogIsActive(PetscBool *isActive)
338d71ae5a4SJacob Faibussowitsch {
3394dd65854SConnor Ward   PetscFunctionBegin;
3404dd65854SConnor Ward   *isActive = (PetscLogPLB && PetscLogPLE) ? PETSC_TRUE : PETSC_FALSE;
3413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3424dd65854SConnor Ward }
3434dd65854SConnor Ward 
3444dd65854SConnor Ward /*@C
345811af0c4SBarry Smith   PetscLogDefaultBegin - Turns on logging of objects and events using the default logging functions `PetscLogEventBeginDefault()` and `PetscLogEventEndDefault()`. This logs flop
3465c6c1daeSBarry Smith   rates and object creation and should not slow programs down too much.
3475c6c1daeSBarry Smith   This routine may be called more than once.
3485c6c1daeSBarry Smith 
349811af0c4SBarry Smith   Logically Collective over `PETSC_COMM_WORLD`
3505c6c1daeSBarry Smith 
351811af0c4SBarry Smith   Options Database Key:
352a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the
353a2553e36SBarry Smith                   screen (for code configured with --with-log=1 (which is the default))
3545c6c1daeSBarry Smith 
3555c6c1daeSBarry Smith   Usage:
3565c6c1daeSBarry Smith .vb
3575c6c1daeSBarry Smith       PetscInitialize(...);
358bb1d7374SBarry Smith       PetscLogDefaultBegin();
3595c6c1daeSBarry Smith        ... code ...
3605c6c1daeSBarry Smith       PetscLogView(viewer); or PetscLogDump();
3615c6c1daeSBarry Smith       PetscFinalize();
3625c6c1daeSBarry Smith .ve
3635c6c1daeSBarry Smith 
364d1f92df0SBarry Smith   Level: advanced
365d1f92df0SBarry Smith 
366811af0c4SBarry Smith   Note:
367811af0c4SBarry Smith   `PetscLogView()` or `PetscLogDump()` actually cause the printing of
3685c6c1daeSBarry Smith   the logging information.
3695c6c1daeSBarry Smith 
370d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogView()`, `PetscLogTraceBegin()`
3715c6c1daeSBarry Smith @*/
372d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogDefaultBegin(void)
373d71ae5a4SJacob Faibussowitsch {
3745c6c1daeSBarry Smith   PetscFunctionBegin;
3759566063dSJacob Faibussowitsch   PetscCall(PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault));
3763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3775c6c1daeSBarry Smith }
3785c6c1daeSBarry Smith 
3795c6c1daeSBarry Smith /*@C
3805c6c1daeSBarry Smith   PetscLogAllBegin - Turns on extensive logging of objects and events. Logs
3815c6c1daeSBarry Smith   all events. This creates large log files and slows the program down.
3825c6c1daeSBarry Smith 
383811af0c4SBarry Smith   Logically Collective on `PETSC_COMM_WORLD`
3845c6c1daeSBarry Smith 
385811af0c4SBarry Smith   Options Database Key:
386a2553e36SBarry Smith . -log_all - Prints extensive log information
3875c6c1daeSBarry Smith 
3885c6c1daeSBarry Smith   Usage:
3895c6c1daeSBarry Smith .vb
3905c6c1daeSBarry Smith      PetscInitialize(...);
3915c6c1daeSBarry Smith      PetscLogAllBegin();
3925c6c1daeSBarry Smith      ... code ...
3935c6c1daeSBarry Smith      PetscLogDump(filename);
3945c6c1daeSBarry Smith      PetscFinalize();
3955c6c1daeSBarry Smith .ve
3965c6c1daeSBarry Smith 
397d1f92df0SBarry Smith   Level: advanced
398d1f92df0SBarry Smith 
399811af0c4SBarry Smith   Note:
400811af0c4SBarry Smith   A related routine is `PetscLogDefaultBegin()` (with the options key -log_view), which is
4015c6c1daeSBarry Smith   intended for production runs since it logs only flop rates and object
4025c6c1daeSBarry Smith   creation (and shouldn't significantly slow the programs).
4035c6c1daeSBarry Smith 
404d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogTraceBegin()`
4055c6c1daeSBarry Smith @*/
406d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogAllBegin(void)
407d71ae5a4SJacob Faibussowitsch {
4085c6c1daeSBarry Smith   PetscFunctionBegin;
4099566063dSJacob Faibussowitsch   PetscCall(PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete));
4103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4115c6c1daeSBarry Smith }
4125c6c1daeSBarry Smith 
413956f8c0dSBarry Smith /*@C
4145c6c1daeSBarry Smith   PetscLogTraceBegin - Activates trace logging.  Every time a PETSc event
4155c6c1daeSBarry Smith   begins or ends, the event name is printed.
4165c6c1daeSBarry Smith 
417811af0c4SBarry Smith   Logically Collective on `PETSC_COMM_WORLD`
4185c6c1daeSBarry Smith 
4195c6c1daeSBarry Smith   Input Parameter:
4205c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout)
4215c6c1daeSBarry Smith 
4225c6c1daeSBarry Smith   Options Database Key:
423811af0c4SBarry Smith . -log_trace [filename] - Activates `PetscLogTraceBegin()`
4245c6c1daeSBarry Smith 
425d1f92df0SBarry Smith   Level: intermediate
426d1f92df0SBarry Smith 
4275c6c1daeSBarry Smith   Notes:
428811af0c4SBarry Smith   `PetscLogTraceBegin()` prints the processor number, the execution time (sec),
4295c6c1daeSBarry Smith   then "Event begin:" or "Event end:" followed by the event name.
4305c6c1daeSBarry Smith 
431811af0c4SBarry Smith   `PetscLogTraceBegin()` allows tracing of all PETSc calls, which is useful
4325c6c1daeSBarry Smith   to determine where a program is hanging without running in the
4335c6c1daeSBarry Smith   debugger.  Can be used in conjunction with the -info option.
4345c6c1daeSBarry Smith 
435d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogView()`, `PetscLogDefaultBegin()`
4365c6c1daeSBarry Smith @*/
437d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogTraceBegin(FILE *file)
438d71ae5a4SJacob Faibussowitsch {
4395c6c1daeSBarry Smith   PetscFunctionBegin;
4405c6c1daeSBarry Smith   petsc_tracefile = file;
441a297a907SKarl Rupp 
4429566063dSJacob Faibussowitsch   PetscCall(PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace));
4433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4445c6c1daeSBarry Smith }
4455c6c1daeSBarry Smith 
4465c6c1daeSBarry Smith /*@
4475c6c1daeSBarry Smith   PetscLogActions - Determines whether actions are logged for the graphical viewer.
4485c6c1daeSBarry Smith 
4495c6c1daeSBarry Smith   Not Collective
4505c6c1daeSBarry Smith 
4515c6c1daeSBarry Smith   Input Parameter:
452811af0c4SBarry Smith . flag - `PETSC_TRUE` if actions are to be logged
453811af0c4SBarry Smith 
454811af0c4SBarry Smith   Options Database Key:
455811af0c4SBarry Smith . -log_exclude_actions - Turns off actions logging
4565c6c1daeSBarry Smith 
4575c6c1daeSBarry Smith   Level: intermediate
4585c6c1daeSBarry Smith 
459811af0c4SBarry Smith   Note:
460811af0c4SBarry Smith   Logging of actions continues to consume more memory as the program
4615c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
462d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStagePush()`, `PetscLogStagePop()`
4635c6c1daeSBarry Smith @*/
464d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogActions(PetscBool flag)
465d71ae5a4SJacob Faibussowitsch {
4665c6c1daeSBarry Smith   PetscFunctionBegin;
4675c6c1daeSBarry Smith   petsc_logActions = flag;
4683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4695c6c1daeSBarry Smith }
4705c6c1daeSBarry Smith 
4715c6c1daeSBarry Smith /*@
4725c6c1daeSBarry Smith   PetscLogObjects - Determines whether objects are logged for the graphical viewer.
4735c6c1daeSBarry Smith 
4745c6c1daeSBarry Smith   Not Collective
4755c6c1daeSBarry Smith 
4765c6c1daeSBarry Smith   Input Parameter:
477811af0c4SBarry Smith . flag - `PETSC_TRUE` if objects are to be logged
478811af0c4SBarry Smith 
479811af0c4SBarry Smith   Options Database Key:
480811af0c4SBarry Smith . -log_exclude_objects - Turns off objects logging
4815c6c1daeSBarry Smith 
4825c6c1daeSBarry Smith   Level: intermediate
4835c6c1daeSBarry Smith 
484811af0c4SBarry Smith   Note:
485811af0c4SBarry Smith   Logging of objects continues to consume more memory as the program
4865c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
4875c6c1daeSBarry Smith 
488d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStagePush()`, `PetscLogStagePop()`
4895c6c1daeSBarry Smith @*/
490d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogObjects(PetscBool flag)
491d71ae5a4SJacob Faibussowitsch {
4925c6c1daeSBarry Smith   PetscFunctionBegin;
4935c6c1daeSBarry Smith   petsc_logObjects = flag;
4943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4955c6c1daeSBarry Smith }
4965c6c1daeSBarry Smith 
4975c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/
4985c6c1daeSBarry Smith /*@C
49974c0405dSRichard Tran Mills   PetscLogStageRegister - Attaches a character string name to a logging stage.
5005c6c1daeSBarry Smith 
5015c6c1daeSBarry Smith   Not Collective
5025c6c1daeSBarry Smith 
5035c6c1daeSBarry Smith   Input Parameter:
5045c6c1daeSBarry Smith . sname - The name to associate with that stage
5055c6c1daeSBarry Smith 
5065c6c1daeSBarry Smith   Output Parameter:
5075c6c1daeSBarry Smith . stage - The stage number
5085c6c1daeSBarry Smith 
5095c6c1daeSBarry Smith   Level: intermediate
5105c6c1daeSBarry Smith 
511d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStagePush()`, `PetscLogStagePop()`
5125c6c1daeSBarry Smith @*/
513d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageRegister(const char sname[], PetscLogStage *stage)
514d71ae5a4SJacob Faibussowitsch {
5155c6c1daeSBarry Smith   PetscStageLog stageLog;
5165c6c1daeSBarry Smith   PetscLogEvent event;
5175c6c1daeSBarry Smith 
5185c6c1daeSBarry Smith   PetscFunctionBegin;
5199566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
5209566063dSJacob Faibussowitsch   PetscCall(PetscStageLogRegister(stageLog, sname, stage));
5215c6c1daeSBarry Smith   /* Copy events already changed in the main stage, this sucks */
5229566063dSJacob Faibussowitsch   PetscCall(PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents));
52348a46eb9SPierre Jolivet   for (event = 0; event < stageLog->eventLog->numEvents; event++) PetscCall(PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event], &stageLog->stageInfo[*stage].eventLog->eventInfo[event]));
5249566063dSJacob Faibussowitsch   PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses));
525a0c7f9aaSSamuel Khuvis   #if defined(PETSC_HAVE_TAU_PERFSTUBS)
526a0c7f9aaSSamuel Khuvis   if (perfstubs_initialized == PERFSTUBS_SUCCESS) PetscStackCallExternalVoid("ps_timer_create_", stageLog->stageInfo[*stage].timer = ps_timer_create_(sname));
527a0c7f9aaSSamuel Khuvis   #endif
5283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5295c6c1daeSBarry Smith }
5305c6c1daeSBarry Smith 
5315c6c1daeSBarry Smith /*@C
532811af0c4SBarry Smith   PetscLogStagePush - This function pushes a stage on the logging stack. Events started and stopped until `PetscLogStagePop()` will be associated with the stage
5335c6c1daeSBarry Smith 
5345c6c1daeSBarry Smith   Not Collective
5355c6c1daeSBarry Smith 
5365c6c1daeSBarry Smith   Input Parameter:
5375c6c1daeSBarry Smith . stage - The stage on which to log
5385c6c1daeSBarry Smith 
5395c6c1daeSBarry Smith   Usage:
540811af0c4SBarry Smith   If the option -log_view is used to run the program containing the
5415c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
5425c6c1daeSBarry Smith   PetscFinalize().
5435c6c1daeSBarry Smith .vb
5445c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
5455c6c1daeSBarry Smith       [stage 0 of code]
5465c6c1daeSBarry Smith       PetscLogStagePush(1);
5475c6c1daeSBarry Smith       [stage 1 of code]
5485c6c1daeSBarry Smith       PetscLogStagePop();
5495c6c1daeSBarry Smith       PetscBarrier(...);
5505c6c1daeSBarry Smith       [more stage 0 of code]
5515c6c1daeSBarry Smith       PetscFinalize();
5525c6c1daeSBarry Smith .ve
5535c6c1daeSBarry Smith 
554d1f92df0SBarry Smith   Level: intermediate
555d1f92df0SBarry Smith 
556811af0c4SBarry Smith   Note:
557811af0c4SBarry Smith   Use `PetscLogStageRegister()` to register a stage.
5585c6c1daeSBarry Smith 
559d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStagePop()`, `PetscLogStageRegister()`, `PetscBarrier()`
5605c6c1daeSBarry Smith @*/
561d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStagePush(PetscLogStage stage)
562d71ae5a4SJacob Faibussowitsch {
5635c6c1daeSBarry Smith   PetscStageLog stageLog;
5645c6c1daeSBarry Smith 
5655c6c1daeSBarry Smith   PetscFunctionBegin;
5669566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
5679566063dSJacob Faibussowitsch   PetscCall(PetscStageLogPush(stageLog, stage));
568a0c7f9aaSSamuel Khuvis   #if defined(PETSC_HAVE_TAU_PERFSTUBS)
569a0c7f9aaSSamuel Khuvis   if (perfstubs_initialized == PERFSTUBS_SUCCESS && stageLog->stageInfo[stage].timer != NULL) PetscStackCallExternalVoid("ps_timer_start_", ps_timer_start_(stageLog->stageInfo[stage].timer));
570a0c7f9aaSSamuel Khuvis   #endif
5713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5725c6c1daeSBarry Smith }
5735c6c1daeSBarry Smith 
5745c6c1daeSBarry Smith /*@C
575811af0c4SBarry Smith   PetscLogStagePop - This function pops a stage from the logging stack that was pushed with `PetscLogStagePush()`
5765c6c1daeSBarry Smith 
5775c6c1daeSBarry Smith   Not Collective
5785c6c1daeSBarry Smith 
5795c6c1daeSBarry Smith   Usage:
580811af0c4SBarry Smith   If the option -log_view is used to run the program containing the
5815c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
5825c6c1daeSBarry Smith   PetscFinalize().
5835c6c1daeSBarry Smith .vb
5845c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
5855c6c1daeSBarry Smith       [stage 0 of code]
5865c6c1daeSBarry Smith       PetscLogStagePush(1);
5875c6c1daeSBarry Smith       [stage 1 of code]
5885c6c1daeSBarry Smith       PetscLogStagePop();
5895c6c1daeSBarry Smith       PetscBarrier(...);
5905c6c1daeSBarry Smith       [more stage 0 of code]
5915c6c1daeSBarry Smith       PetscFinalize();
5925c6c1daeSBarry Smith .ve
5935c6c1daeSBarry Smith 
5945c6c1daeSBarry Smith   Level: intermediate
5955c6c1daeSBarry Smith 
596d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStagePush()`, `PetscLogStageRegister()`, `PetscBarrier()`
5975c6c1daeSBarry Smith @*/
598d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStagePop(void)
599d71ae5a4SJacob Faibussowitsch {
6005c6c1daeSBarry Smith   PetscStageLog stageLog;
6015c6c1daeSBarry Smith 
6025c6c1daeSBarry Smith   PetscFunctionBegin;
6039566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
604a0c7f9aaSSamuel Khuvis   #if defined(PETSC_HAVE_TAU_PERFSTUBS)
605a0c7f9aaSSamuel Khuvis   if (perfstubs_initialized == PERFSTUBS_SUCCESS && stageLog->stageInfo[stageLog->curStage].timer != NULL) PetscStackCallExternalVoid("ps_timer_stop_", ps_timer_stop_(stageLog->stageInfo[stageLog->curStage].timer));
606a0c7f9aaSSamuel Khuvis   #endif
6079566063dSJacob Faibussowitsch   PetscCall(PetscStageLogPop(stageLog));
6083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
6095c6c1daeSBarry Smith }
6105c6c1daeSBarry Smith 
6115c6c1daeSBarry Smith /*@
612811af0c4SBarry Smith   PetscLogStageSetActive - Sets if a stage is used for `PetscLogEventBegin()` and `PetscLogEventEnd()`.
6135c6c1daeSBarry Smith 
6145c6c1daeSBarry Smith   Not Collective
6155c6c1daeSBarry Smith 
6165c6c1daeSBarry Smith   Input Parameters:
6175c6c1daeSBarry Smith + stage    - The stage
618811af0c4SBarry Smith - isActive - The activity flag, `PETSC_TRUE` for logging, else `PETSC_FALSE` (defaults to `PETSC_TRUE`)
6195c6c1daeSBarry Smith 
6205c6c1daeSBarry Smith   Level: intermediate
6215c6c1daeSBarry Smith 
622811af0c4SBarry Smith   Note:
623811af0c4SBarry Smith   If this is set to `PETSC_FALSE` the logging acts as if the stage did not exist
624811af0c4SBarry Smith 
625d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()`
6265c6c1daeSBarry Smith @*/
627d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive)
628d71ae5a4SJacob Faibussowitsch {
6295c6c1daeSBarry Smith   PetscStageLog stageLog;
6305c6c1daeSBarry Smith 
6315c6c1daeSBarry Smith   PetscFunctionBegin;
6329566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
6339566063dSJacob Faibussowitsch   PetscCall(PetscStageLogSetActive(stageLog, stage, isActive));
6343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
6355c6c1daeSBarry Smith }
6365c6c1daeSBarry Smith 
6375c6c1daeSBarry Smith /*@
638811af0c4SBarry Smith   PetscLogStageGetActive - Checks if a stage is used for `PetscLogEventBegin()` and `PetscLogEventEnd()`.
6395c6c1daeSBarry Smith 
6405c6c1daeSBarry Smith   Not Collective
6415c6c1daeSBarry Smith 
6425c6c1daeSBarry Smith   Input Parameter:
6435c6c1daeSBarry Smith . stage    - The stage
6445c6c1daeSBarry Smith 
6455c6c1daeSBarry Smith   Output Parameter:
646811af0c4SBarry Smith . isActive - The activity flag, `PETSC_TRUE` for logging, else `PETSC_FALSE` (defaults to `PETSC_TRUE`)
6475c6c1daeSBarry Smith 
6485c6c1daeSBarry Smith   Level: intermediate
6495c6c1daeSBarry Smith 
650d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()`
6515c6c1daeSBarry Smith @*/
652d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageGetActive(PetscLogStage stage, PetscBool *isActive)
653d71ae5a4SJacob Faibussowitsch {
6545c6c1daeSBarry Smith   PetscStageLog stageLog;
6555c6c1daeSBarry Smith 
6565c6c1daeSBarry Smith   PetscFunctionBegin;
6579566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
6589566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetActive(stageLog, stage, isActive));
6593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
6605c6c1daeSBarry Smith }
6615c6c1daeSBarry Smith 
6625c6c1daeSBarry Smith /*@
663811af0c4SBarry Smith   PetscLogStageSetVisible - Determines stage visibility in `PetscLogView()`
6645c6c1daeSBarry Smith 
6655c6c1daeSBarry Smith   Not Collective
6665c6c1daeSBarry Smith 
6675c6c1daeSBarry Smith   Input Parameters:
6685c6c1daeSBarry Smith + stage     - The stage
669811af0c4SBarry Smith - isVisible - The visibility flag, `PETSC_TRUE` to print, else `PETSC_FALSE` (defaults to `PETSC_TRUE`)
6705c6c1daeSBarry Smith 
6715c6c1daeSBarry Smith   Level: intermediate
6725c6c1daeSBarry Smith 
673811af0c4SBarry Smith   Developer Note:
674811af0c4SBarry Smith   What does visible mean, needs to be documented.
675811af0c4SBarry Smith 
676d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogView()`
6775c6c1daeSBarry Smith @*/
678d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible)
679d71ae5a4SJacob Faibussowitsch {
6805c6c1daeSBarry Smith   PetscStageLog stageLog;
6815c6c1daeSBarry Smith 
6825c6c1daeSBarry Smith   PetscFunctionBegin;
6839566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
6849566063dSJacob Faibussowitsch   PetscCall(PetscStageLogSetVisible(stageLog, stage, isVisible));
6853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
6865c6c1daeSBarry Smith }
6875c6c1daeSBarry Smith 
6885c6c1daeSBarry Smith /*@
689811af0c4SBarry Smith   PetscLogStageGetVisible - Returns stage visibility in `PetscLogView()`
6905c6c1daeSBarry Smith 
6915c6c1daeSBarry Smith   Not Collective
6925c6c1daeSBarry Smith 
6935c6c1daeSBarry Smith   Input Parameter:
6945c6c1daeSBarry Smith . stage     - The stage
6955c6c1daeSBarry Smith 
6965c6c1daeSBarry Smith   Output Parameter:
697811af0c4SBarry Smith . isVisible - The visibility flag, `PETSC_TRUE` to print, else `PETSC_FALSE` (defaults to `PETSC_TRUE`)
6985c6c1daeSBarry Smith 
6995c6c1daeSBarry Smith   Level: intermediate
7005c6c1daeSBarry Smith 
701d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogView()`
7025c6c1daeSBarry Smith @*/
703d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageGetVisible(PetscLogStage stage, PetscBool *isVisible)
704d71ae5a4SJacob Faibussowitsch {
7055c6c1daeSBarry Smith   PetscStageLog stageLog;
7065c6c1daeSBarry Smith 
7075c6c1daeSBarry Smith   PetscFunctionBegin;
7089566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
7099566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetVisible(stageLog, stage, isVisible));
7103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
7115c6c1daeSBarry Smith }
7125c6c1daeSBarry Smith 
7135c6c1daeSBarry Smith /*@C
7145c6c1daeSBarry Smith   PetscLogStageGetId - Returns the stage id when given the stage name.
7155c6c1daeSBarry Smith 
7165c6c1daeSBarry Smith   Not Collective
7175c6c1daeSBarry Smith 
7185c6c1daeSBarry Smith   Input Parameter:
7195c6c1daeSBarry Smith . name  - The stage name
7205c6c1daeSBarry Smith 
7215c6c1daeSBarry Smith   Output Parameter:
7225a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists
7235c6c1daeSBarry Smith 
7245c6c1daeSBarry Smith   Level: intermediate
7255c6c1daeSBarry Smith 
726d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()`
7275c6c1daeSBarry Smith @*/
728d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageGetId(const char name[], PetscLogStage *stage)
729d71ae5a4SJacob Faibussowitsch {
7305c6c1daeSBarry Smith   PetscStageLog stageLog;
7315c6c1daeSBarry Smith 
7325c6c1daeSBarry Smith   PetscFunctionBegin;
7339566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
7349566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetStage(stageLog, name, stage));
7353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
7365c6c1daeSBarry Smith }
7375c6c1daeSBarry Smith 
7385c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/
7397a101e5eSJacob Faibussowitsch 
7405c6c1daeSBarry Smith /*@C
741811af0c4SBarry Smith   PetscLogEventRegister - Registers an event name for logging operations
7425c6c1daeSBarry Smith 
7435c6c1daeSBarry Smith   Not Collective
7445c6c1daeSBarry Smith 
745d8d19677SJose E. Roman   Input Parameters:
7465c6c1daeSBarry Smith + name   - The name associated with the event
7475c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with
748811af0c4SBarry Smith            `PetscClassIdRegister()` or use a predefined one such as `KSP_CLASSID`, `SNES_CLASSID`, the predefined ones
7495c6c1daeSBarry Smith            are only available in C code
7505c6c1daeSBarry Smith 
7515c6c1daeSBarry Smith   Output Parameter:
752811af0c4SBarry Smith . event - The event id for use with `PetscLogEventBegin()` and `PetscLogEventEnd()`.
7535c6c1daeSBarry Smith 
7545c6c1daeSBarry Smith   Example of Usage:
7555c6c1daeSBarry Smith .vb
7565c6c1daeSBarry Smith       PetscLogEvent USER_EVENT;
7575c6c1daeSBarry Smith       PetscClassId classid;
7585c6c1daeSBarry Smith       PetscLogDouble user_event_flops;
7595c6c1daeSBarry Smith       PetscClassIdRegister("class name",&classid);
7605c6c1daeSBarry Smith       PetscLogEventRegister("User event name",classid,&USER_EVENT);
7615c6c1daeSBarry Smith       PetscLogEventBegin(USER_EVENT,0,0,0,0);
7625c6c1daeSBarry Smith          [code segment to monitor]
7635c6c1daeSBarry Smith          PetscLogFlops(user_event_flops);
7645c6c1daeSBarry Smith       PetscLogEventEnd(USER_EVENT,0,0,0,0);
7655c6c1daeSBarry Smith .ve
7665c6c1daeSBarry Smith 
767d1f92df0SBarry Smith   Level: intermediate
768d1f92df0SBarry Smith 
7695c6c1daeSBarry Smith   Notes:
7705c6c1daeSBarry Smith   PETSc automatically logs library events if the code has been
771a2553e36SBarry Smith   configured with --with-log (which is the default) and
772811af0c4SBarry Smith   -log_view or -log_all is specified.  `PetscLogEventRegister()` is
7735c6c1daeSBarry Smith   intended for logging user events to supplement this PETSc
7745c6c1daeSBarry Smith   information.
7755c6c1daeSBarry Smith 
776495fc317SBarry Smith   PETSc can gather data for use with the utilities Jumpshot
7775c6c1daeSBarry Smith   (part of the MPICH distribution).  If PETSc has been compiled
7785c6c1daeSBarry Smith   with flag -DPETSC_HAVE_MPE (MPE is an additional utility within
7795c6c1daeSBarry Smith   MPICH), the user can employ another command line option, -log_mpe,
7805c6c1daeSBarry Smith   to create a logfile, "mpe.log", which can be visualized
781495fc317SBarry Smith   Jumpshot.
7825c6c1daeSBarry Smith 
7835c6c1daeSBarry Smith   The classid is associated with each event so that classes of events
7845c6c1daeSBarry Smith   can be disabled simultaneously, such as all matrix events. The user
785811af0c4SBarry Smith   can either use an existing classid, such as `MAT_CLASSID`, or create
7865c6c1daeSBarry Smith   their own as shown in the example.
7875c6c1daeSBarry Smith 
788c5deb1d5SJed Brown   If an existing event with the same name exists, its event handle is
789c5deb1d5SJed Brown   returned instead of creating a new event.
790c5deb1d5SJed Brown 
791d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStageRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogFlops()`,
792db781477SPatrick Sanan           `PetscLogEventActivate()`, `PetscLogEventDeactivate()`, `PetscClassIdRegister()`
7935c6c1daeSBarry Smith @*/
794d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventRegister(const char name[], PetscClassId classid, PetscLogEvent *event)
795d71ae5a4SJacob Faibussowitsch {
7965c6c1daeSBarry Smith   PetscStageLog stageLog;
7975c6c1daeSBarry Smith   int           stage;
7985c6c1daeSBarry Smith 
7995c6c1daeSBarry Smith   PetscFunctionBegin;
8005c6c1daeSBarry Smith   *event = PETSC_DECIDE;
8019566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
8029566063dSJacob Faibussowitsch   PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, event));
8033ba16761SJacob Faibussowitsch   if (*event > 0) PetscFunctionReturn(PETSC_SUCCESS);
8049566063dSJacob Faibussowitsch   PetscCall(PetscEventRegLogRegister(stageLog->eventLog, name, classid, event));
8055c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
8069566063dSJacob Faibussowitsch     PetscCall(PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents));
8079566063dSJacob Faibussowitsch     PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses));
8085c6c1daeSBarry Smith   }
8093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
8105c6c1daeSBarry Smith }
8115c6c1daeSBarry Smith 
8125c6c1daeSBarry Smith /*@
813217044c2SLisandro Dalcin   PetscLogEventSetCollective - Indicates that a particular event is collective.
814217044c2SLisandro Dalcin 
815217044c2SLisandro Dalcin   Not Collective
816217044c2SLisandro Dalcin 
817d8d19677SJose E. Roman   Input Parameters:
818217044c2SLisandro Dalcin + event - The event id
819d5b43468SJose E. Roman - collective - Boolean flag indicating whether a particular event is collective
820217044c2SLisandro Dalcin 
821d1f92df0SBarry Smith   Level: developer
822d1f92df0SBarry Smith 
823811af0c4SBarry Smith   Notes:
824811af0c4SBarry Smith   New events returned from `PetscLogEventRegister()` are collective by default.
825811af0c4SBarry Smith 
826811af0c4SBarry Smith   Collective events are handled specially if the -log_sync is used. In that case the logging saves information about
827811af0c4SBarry Smith   two parts of the event; the time for all the MPI ranks to synchronize and then the time for the actual computation/communication
828811af0c4SBarry Smith   to be performed. This option is useful to debug imbalance within the computations or communications
829217044c2SLisandro Dalcin 
830d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogEventRegister()`
831217044c2SLisandro Dalcin @*/
832d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event, PetscBool collective)
833d71ae5a4SJacob Faibussowitsch {
834217044c2SLisandro Dalcin   PetscStageLog    stageLog;
835217044c2SLisandro Dalcin   PetscEventRegLog eventRegLog;
836217044c2SLisandro Dalcin 
837217044c2SLisandro Dalcin   PetscFunctionBegin;
8389566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
8399566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetEventRegLog(stageLog, &eventRegLog));
840cc73adaaSBarry Smith   PetscCheck(event >= 0 && event <= eventRegLog->numEvents, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Invalid event id");
841217044c2SLisandro Dalcin   eventRegLog->eventInfo[event].collective = collective;
8423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
843217044c2SLisandro Dalcin }
844217044c2SLisandro Dalcin 
845217044c2SLisandro Dalcin /*@
846fa2bb9feSLisandro Dalcin   PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage.
847fa2bb9feSLisandro Dalcin 
848fa2bb9feSLisandro Dalcin   Not Collective
849fa2bb9feSLisandro Dalcin 
850fa2bb9feSLisandro Dalcin   Input Parameter:
851811af0c4SBarry Smith . classid - The object class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc.
852fa2bb9feSLisandro Dalcin 
853fa2bb9feSLisandro Dalcin   Level: developer
854fa2bb9feSLisandro Dalcin 
855d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventActivateClass()`, `PetscLogEventDeactivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()`
856fa2bb9feSLisandro Dalcin @*/
857d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventIncludeClass(PetscClassId classid)
858d71ae5a4SJacob Faibussowitsch {
859fa2bb9feSLisandro Dalcin   PetscStageLog stageLog;
860fa2bb9feSLisandro Dalcin   int           stage;
861fa2bb9feSLisandro Dalcin 
862fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
8639566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
86448a46eb9SPierre Jolivet   for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid));
8653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
866fa2bb9feSLisandro Dalcin }
867fa2bb9feSLisandro Dalcin 
868fa2bb9feSLisandro Dalcin /*@
869fa2bb9feSLisandro Dalcin   PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage.
870fa2bb9feSLisandro Dalcin 
871fa2bb9feSLisandro Dalcin   Not Collective
872fa2bb9feSLisandro Dalcin 
873fa2bb9feSLisandro Dalcin   Input Parameter:
874811af0c4SBarry Smith . classid - The object class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc.
875fa2bb9feSLisandro Dalcin 
876fa2bb9feSLisandro Dalcin   Level: developer
877fa2bb9feSLisandro Dalcin 
878811af0c4SBarry Smith   Note:
879811af0c4SBarry Smith   If a class is excluded then events associated with that class are not logged.
880811af0c4SBarry Smith 
881d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventDeactivateClass()`, `PetscLogEventActivateClass()`, `PetscLogEventDeactivate()`, `PetscLogEventActivate()`
882fa2bb9feSLisandro Dalcin @*/
883d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventExcludeClass(PetscClassId classid)
884d71ae5a4SJacob Faibussowitsch {
885fa2bb9feSLisandro Dalcin   PetscStageLog stageLog;
886fa2bb9feSLisandro Dalcin   int           stage;
887fa2bb9feSLisandro Dalcin 
888fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
8899566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
89048a46eb9SPierre Jolivet   for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid));
8913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
892fa2bb9feSLisandro Dalcin }
893fa2bb9feSLisandro Dalcin 
894fa2bb9feSLisandro Dalcin /*@
8955c6c1daeSBarry Smith   PetscLogEventActivate - Indicates that a particular event should be logged.
8965c6c1daeSBarry Smith 
8975c6c1daeSBarry Smith   Not Collective
8985c6c1daeSBarry Smith 
8995c6c1daeSBarry Smith   Input Parameter:
9005c6c1daeSBarry Smith . event - The event id
9015c6c1daeSBarry Smith 
9025c6c1daeSBarry Smith   Usage:
9035c6c1daeSBarry Smith .vb
9045c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
9055c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
9065c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
9075c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
9085c6c1daeSBarry Smith .ve
9095c6c1daeSBarry Smith 
910d1f92df0SBarry Smith   Level: advanced
911d1f92df0SBarry Smith 
9125c6c1daeSBarry Smith   Note:
9135c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in include/petsclog.h)
914811af0c4SBarry Smith   or an event number obtained with `PetscLogEventRegister()`.
9155c6c1daeSBarry Smith 
916d1f92df0SBarry Smith .seealso: [](ch_profiling), `PlogEventDeactivate()`, `PlogEventDeactivatePush()`, `PetscLogEventDeactivatePop()`
9175c6c1daeSBarry Smith @*/
918d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventActivate(PetscLogEvent event)
919d71ae5a4SJacob Faibussowitsch {
9205c6c1daeSBarry Smith   PetscStageLog stageLog;
9215c6c1daeSBarry Smith   int           stage;
9225c6c1daeSBarry Smith 
9235c6c1daeSBarry Smith   PetscFunctionBegin;
9249566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
9259566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
9269566063dSJacob Faibussowitsch   PetscCall(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event));
9273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
9285c6c1daeSBarry Smith }
9295c6c1daeSBarry Smith 
9305c6c1daeSBarry Smith /*@
9315c6c1daeSBarry Smith   PetscLogEventDeactivate - Indicates that a particular event should not be logged.
9325c6c1daeSBarry Smith 
9335c6c1daeSBarry Smith   Not Collective
9345c6c1daeSBarry Smith 
9355c6c1daeSBarry Smith   Input Parameter:
9365c6c1daeSBarry Smith . event - The event id
9375c6c1daeSBarry Smith 
9385c6c1daeSBarry Smith   Usage:
9395c6c1daeSBarry Smith .vb
9405c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
9415c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
9425c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
9435c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
9445c6c1daeSBarry Smith .ve
9455c6c1daeSBarry Smith 
946d1f92df0SBarry Smith   Level: advanced
947d1f92df0SBarry Smith 
9485c6c1daeSBarry Smith   Note:
9495c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in
950811af0c4SBarry Smith   include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`).
9515c6c1daeSBarry Smith 
952d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventActivate()`, `PetscLogEventDeactivatePush()`, `PetscLogEventDeactivatePop()`
9535c6c1daeSBarry Smith @*/
954d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivate(PetscLogEvent event)
955d71ae5a4SJacob Faibussowitsch {
9565c6c1daeSBarry Smith   PetscStageLog stageLog;
9575c6c1daeSBarry Smith   int           stage;
9585c6c1daeSBarry Smith 
9595c6c1daeSBarry Smith   PetscFunctionBegin;
9609566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
9619566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
9629566063dSJacob Faibussowitsch   PetscCall(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event));
9633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
9645c6c1daeSBarry Smith }
9655c6c1daeSBarry Smith 
9665c6c1daeSBarry Smith /*@
967811af0c4SBarry Smith   PetscLogEventDeactivatePush - Indicates that a particular event should not be logged until `PetscLogEventDeactivatePop()` is called
968c00cb57fSBarry Smith 
969c00cb57fSBarry Smith   Not Collective
970c00cb57fSBarry Smith 
971c00cb57fSBarry Smith   Input Parameter:
972c00cb57fSBarry Smith . event - The event id
973c00cb57fSBarry Smith 
974c00cb57fSBarry Smith   Usage:
975c00cb57fSBarry Smith .vb
976c00cb57fSBarry Smith       PetscLogEventDeactivatePush(VEC_SetValues);
977c00cb57fSBarry Smith         [code where you do not want to log VecSetValues()]
978c00cb57fSBarry Smith       PetscLogEventDeactivatePop(VEC_SetValues);
979c00cb57fSBarry Smith         [code where you do want to log VecSetValues()]
980c00cb57fSBarry Smith .ve
981c00cb57fSBarry Smith 
982d1f92df0SBarry Smith   Level: advanced
983d1f92df0SBarry Smith 
984c00cb57fSBarry Smith   Note:
985c00cb57fSBarry Smith   The event may be either a pre-defined PETSc event (found in
986811af0c4SBarry Smith   include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`).
987c00cb57fSBarry Smith 
988d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventActivate()`, `PetscLogEventDeactivatePop()`, `PetscLogEventDeactivate()`
989c00cb57fSBarry Smith @*/
990d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivatePush(PetscLogEvent event)
991d71ae5a4SJacob Faibussowitsch {
992c00cb57fSBarry Smith   PetscStageLog stageLog;
993c00cb57fSBarry Smith   int           stage;
994c00cb57fSBarry Smith 
995c00cb57fSBarry Smith   PetscFunctionBegin;
9969566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
9979566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
9989566063dSJacob Faibussowitsch   PetscCall(PetscEventPerfLogDeactivatePush(stageLog->stageInfo[stage].eventLog, event));
9993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1000c00cb57fSBarry Smith }
1001c00cb57fSBarry Smith 
1002c00cb57fSBarry Smith /*@
1003811af0c4SBarry Smith   PetscLogEventDeactivatePop - Indicates that a particular event should again be logged after the logging was turned off with `PetscLogEventDeactivatePush()`
1004c00cb57fSBarry Smith 
1005c00cb57fSBarry Smith   Not Collective
1006c00cb57fSBarry Smith 
1007c00cb57fSBarry Smith   Input Parameter:
1008c00cb57fSBarry Smith . event - The event id
1009c00cb57fSBarry Smith 
1010c00cb57fSBarry Smith   Usage:
1011c00cb57fSBarry Smith .vb
1012c00cb57fSBarry Smith       PetscLogEventDeactivatePush(VEC_SetValues);
1013c00cb57fSBarry Smith         [code where you do not want to log VecSetValues()]
1014c00cb57fSBarry Smith       PetscLogEventDeactivatePop(VEC_SetValues);
1015c00cb57fSBarry Smith         [code where you do want to log VecSetValues()]
1016c00cb57fSBarry Smith .ve
1017c00cb57fSBarry Smith 
1018d1f92df0SBarry Smith   Level: advanced
1019d1f92df0SBarry Smith 
1020c00cb57fSBarry Smith   Note:
1021c00cb57fSBarry Smith   The event may be either a pre-defined PETSc event (found in
1022811af0c4SBarry Smith   include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`).
1023c00cb57fSBarry Smith 
1024d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventActivate()`, `PetscLogEventDeactivatePush()`
1025c00cb57fSBarry Smith @*/
1026d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivatePop(PetscLogEvent event)
1027d71ae5a4SJacob Faibussowitsch {
1028c00cb57fSBarry Smith   PetscStageLog stageLog;
1029c00cb57fSBarry Smith   int           stage;
1030c00cb57fSBarry Smith 
1031c00cb57fSBarry Smith   PetscFunctionBegin;
10329566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
10339566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
10349566063dSJacob Faibussowitsch   PetscCall(PetscEventPerfLogDeactivatePop(stageLog->stageInfo[stage].eventLog, event));
10353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1036c00cb57fSBarry Smith }
1037c00cb57fSBarry Smith 
1038c00cb57fSBarry Smith /*@
1039811af0c4SBarry Smith   PetscLogEventSetActiveAll - Turns on logging of all events
10405c6c1daeSBarry Smith 
10415c6c1daeSBarry Smith   Not Collective
10425c6c1daeSBarry Smith 
10435c6c1daeSBarry Smith   Input Parameters:
10445c6c1daeSBarry Smith + event    - The event id
10455c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged
10465c6c1daeSBarry Smith 
10475c6c1daeSBarry Smith   Level: advanced
10485c6c1daeSBarry Smith 
1049d1f92df0SBarry Smith .seealso: [](ch_profiling), `PlogEventActivate()`, `PlogEventDeactivate()`
10505c6c1daeSBarry Smith @*/
1051d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive)
1052d71ae5a4SJacob Faibussowitsch {
10535c6c1daeSBarry Smith   PetscStageLog stageLog;
10545c6c1daeSBarry Smith   int           stage;
10555c6c1daeSBarry Smith 
10565c6c1daeSBarry Smith   PetscFunctionBegin;
10579566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
10585c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
10595c6c1daeSBarry Smith     if (isActive) {
10609566063dSJacob Faibussowitsch       PetscCall(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event));
10615c6c1daeSBarry Smith     } else {
10629566063dSJacob Faibussowitsch       PetscCall(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event));
10635c6c1daeSBarry Smith     }
10645c6c1daeSBarry Smith   }
10653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10665c6c1daeSBarry Smith }
10675c6c1daeSBarry Smith 
10685c6c1daeSBarry Smith /*@
1069811af0c4SBarry Smith   PetscLogEventActivateClass - Activates event logging for a PETSc object class for the current stage
10705c6c1daeSBarry Smith 
10715c6c1daeSBarry Smith   Not Collective
10725c6c1daeSBarry Smith 
10735c6c1daeSBarry Smith   Input Parameter:
1074811af0c4SBarry Smith . classid - The event class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc.
10755c6c1daeSBarry Smith 
10765c6c1daeSBarry Smith   Level: developer
10775c6c1daeSBarry Smith 
1078d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventIncludeClass()`, `PetscLogEventExcludeClass()`, `PetscLogEventDeactivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()`
10795c6c1daeSBarry Smith @*/
1080d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventActivateClass(PetscClassId classid)
1081d71ae5a4SJacob Faibussowitsch {
10825c6c1daeSBarry Smith   PetscStageLog stageLog;
10835c6c1daeSBarry Smith   int           stage;
10845c6c1daeSBarry Smith 
10855c6c1daeSBarry Smith   PetscFunctionBegin;
10869566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
10879566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
10889566063dSJacob Faibussowitsch   PetscCall(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid));
10893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
10905c6c1daeSBarry Smith }
10915c6c1daeSBarry Smith 
10925c6c1daeSBarry Smith /*@
1093811af0c4SBarry Smith   PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class for the current stage
10945c6c1daeSBarry Smith 
10955c6c1daeSBarry Smith   Not Collective
10965c6c1daeSBarry Smith 
10975c6c1daeSBarry Smith   Input Parameter:
1098811af0c4SBarry Smith . classid - The event class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc.
10995c6c1daeSBarry Smith 
11005c6c1daeSBarry Smith   Level: developer
11015c6c1daeSBarry Smith 
1102d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventIncludeClass()`, `PetscLogEventExcludeClass()`, `PetscLogEventActivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()`
11035c6c1daeSBarry Smith @*/
1104d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivateClass(PetscClassId classid)
1105d71ae5a4SJacob Faibussowitsch {
11065c6c1daeSBarry Smith   PetscStageLog stageLog;
11075c6c1daeSBarry Smith   int           stage;
11085c6c1daeSBarry Smith 
11095c6c1daeSBarry Smith   PetscFunctionBegin;
11109566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
11119566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
11129566063dSJacob Faibussowitsch   PetscCall(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid));
11133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11145c6c1daeSBarry Smith }
11155c6c1daeSBarry Smith 
11165c6c1daeSBarry Smith /*MC
111762872c28SLisandro Dalcin    PetscLogEventSync - Synchronizes the beginning of a user event.
111862872c28SLisandro Dalcin 
111962872c28SLisandro Dalcin    Synopsis:
112062872c28SLisandro Dalcin    #include <petsclog.h>
112162872c28SLisandro Dalcin    PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm)
112262872c28SLisandro Dalcin 
112362872c28SLisandro Dalcin    Collective
112462872c28SLisandro Dalcin 
112562872c28SLisandro Dalcin    Input Parameters:
112662872c28SLisandro Dalcin +  e - integer associated with the event obtained from PetscLogEventRegister()
112762872c28SLisandro Dalcin -  comm - an MPI communicator
112862872c28SLisandro Dalcin 
112962872c28SLisandro Dalcin    Usage:
113062872c28SLisandro Dalcin .vb
113162872c28SLisandro Dalcin      PetscLogEvent USER_EVENT;
113262872c28SLisandro Dalcin      PetscLogEventRegister("User event",0,&USER_EVENT);
113362872c28SLisandro Dalcin      PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD);
113462872c28SLisandro Dalcin      PetscLogEventBegin(USER_EVENT,0,0,0,0);
113562872c28SLisandro Dalcin         [code segment to monitor]
113662872c28SLisandro Dalcin      PetscLogEventEnd(USER_EVENT,0,0,0,0);
113762872c28SLisandro Dalcin .ve
113862872c28SLisandro Dalcin 
1139d1f92df0SBarry Smith    Level: developer
1140d1f92df0SBarry Smith 
1141811af0c4SBarry Smith    Note:
114262872c28SLisandro Dalcin    This routine should be called only if there is not a
1143811af0c4SBarry Smith    `PetscObject` available to pass to `PetscLogEventBegin()`.
114462872c28SLisandro Dalcin 
1145d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`
114662872c28SLisandro Dalcin M*/
114762872c28SLisandro Dalcin 
114862872c28SLisandro Dalcin /*MC
11495c6c1daeSBarry Smith    PetscLogEventBegin - Logs the beginning of a user event.
11505c6c1daeSBarry Smith 
11515c6c1daeSBarry Smith    Synopsis:
1152aaa7dc30SBarry Smith    #include <petsclog.h>
1153f2ba6396SBarry Smith    PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
11545c6c1daeSBarry Smith 
11555c6c1daeSBarry Smith    Not Collective
11565c6c1daeSBarry Smith 
11575c6c1daeSBarry Smith    Input Parameters:
11585c6c1daeSBarry Smith +  e - integer associated with the event obtained from PetscLogEventRegister()
11595c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
11605c6c1daeSBarry Smith 
11615c6c1daeSBarry Smith    Fortran Synopsis:
11625c6c1daeSBarry Smith    void PetscLogEventBegin(int e,PetscErrorCode ierr)
11635c6c1daeSBarry Smith 
11645c6c1daeSBarry Smith    Usage:
11655c6c1daeSBarry Smith .vb
11665c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
11675c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
11685c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
11695c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
11705c6c1daeSBarry Smith         [code segment to monitor]
11715c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
11725c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
11735c6c1daeSBarry Smith .ve
11745c6c1daeSBarry Smith 
1175d1f92df0SBarry Smith    Level: intermediate
1176d1f92df0SBarry Smith 
1177811af0c4SBarry Smith    Developer Note:
1178811af0c4SBarry Smith      `PetscLogEventBegin()` and `PetscLogEventBegin()` return error codes instead of explicitly handling the
1179d0609cedSBarry Smith      errors that occur in the macro directly because other packages that use this macros have used them in their
1180d0609cedSBarry Smith      own functions or methods that do not return error codes and it would be disruptive to change the current
1181d0609cedSBarry Smith      behavior.
1182d0609cedSBarry Smith 
1183d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()`, `PetscLogEventEnd()`, `PetscLogFlops()`
11845c6c1daeSBarry Smith M*/
11855c6c1daeSBarry Smith 
11865c6c1daeSBarry Smith /*MC
11875c6c1daeSBarry Smith    PetscLogEventEnd - Log the end of a user event.
11885c6c1daeSBarry Smith 
11895c6c1daeSBarry Smith    Synopsis:
1190aaa7dc30SBarry Smith    #include <petsclog.h>
1191f2ba6396SBarry Smith    PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
11925c6c1daeSBarry Smith 
11935c6c1daeSBarry Smith    Not Collective
11945c6c1daeSBarry Smith 
11955c6c1daeSBarry Smith    Input Parameters:
11965c6c1daeSBarry Smith +  e - integer associated with the event obtained with PetscLogEventRegister()
11975c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
11985c6c1daeSBarry Smith 
11995c6c1daeSBarry Smith    Fortran Synopsis:
12005c6c1daeSBarry Smith    void PetscLogEventEnd(int e,PetscErrorCode ierr)
12015c6c1daeSBarry Smith 
12025c6c1daeSBarry Smith    Usage:
12035c6c1daeSBarry Smith .vb
12045c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
12055c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
12065c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT,);
12075c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
12085c6c1daeSBarry Smith         [code segment to monitor]
12095c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
12105c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
12115c6c1daeSBarry Smith .ve
12125c6c1daeSBarry Smith 
12135c6c1daeSBarry Smith    Level: intermediate
12145c6c1daeSBarry Smith 
1215d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogFlops()`
12165c6c1daeSBarry Smith M*/
12175c6c1daeSBarry Smith 
12185c6c1daeSBarry Smith /*@C
12195c6c1daeSBarry Smith   PetscLogEventGetId - Returns the event id when given the event name.
12205c6c1daeSBarry Smith 
12215c6c1daeSBarry Smith   Not Collective
12225c6c1daeSBarry Smith 
12235c6c1daeSBarry Smith   Input Parameter:
12245c6c1daeSBarry Smith . name  - The event name
12255c6c1daeSBarry Smith 
12265c6c1daeSBarry Smith   Output Parameter:
1227c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists
12285c6c1daeSBarry Smith 
12295c6c1daeSBarry Smith   Level: intermediate
12305c6c1daeSBarry Smith 
1231d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogStageGetId()`
12325c6c1daeSBarry Smith @*/
1233d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventGetId(const char name[], PetscLogEvent *event)
1234d71ae5a4SJacob Faibussowitsch {
12355c6c1daeSBarry Smith   PetscStageLog stageLog;
12365c6c1daeSBarry Smith 
12375c6c1daeSBarry Smith   PetscFunctionBegin;
12389566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
12399566063dSJacob Faibussowitsch   PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, event));
12403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12415c6c1daeSBarry Smith }
12425c6c1daeSBarry Smith 
1243d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogPushCurrentEvent_Internal(PetscLogEvent event)
1244d71ae5a4SJacob Faibussowitsch {
12457a101e5eSJacob Faibussowitsch   PetscFunctionBegin;
1246c708d6e3SStefano Zampini   if (!PetscDefined(HAVE_THREADSAFETY)) PetscCall(PetscIntStackPush(current_log_event_stack, event));
12473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12487a101e5eSJacob Faibussowitsch }
12497a101e5eSJacob Faibussowitsch 
1250d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogPopCurrentEvent_Internal(void)
1251d71ae5a4SJacob Faibussowitsch {
12527a101e5eSJacob Faibussowitsch   PetscFunctionBegin;
1253c708d6e3SStefano Zampini   if (!PetscDefined(HAVE_THREADSAFETY)) PetscCall(PetscIntStackPop(current_log_event_stack, NULL));
12543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12557a101e5eSJacob Faibussowitsch }
12567a101e5eSJacob Faibussowitsch 
1257d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGetCurrentEvent_Internal(PetscLogEvent *event)
1258d71ae5a4SJacob Faibussowitsch {
12597a101e5eSJacob Faibussowitsch   PetscBool empty;
12607a101e5eSJacob Faibussowitsch 
12617a101e5eSJacob Faibussowitsch   PetscFunctionBegin;
12627a101e5eSJacob Faibussowitsch   PetscValidIntPointer(event, 1);
12637a101e5eSJacob Faibussowitsch   *event = PETSC_DECIDE;
12647a101e5eSJacob Faibussowitsch   PetscCall(PetscIntStackEmpty(current_log_event_stack, &empty));
12657a101e5eSJacob Faibussowitsch   if (!empty) PetscCall(PetscIntStackTop(current_log_event_stack, event));
12663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12677a101e5eSJacob Faibussowitsch }
12687a101e5eSJacob Faibussowitsch 
1269d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventPause_Internal(PetscLogEvent event)
1270d71ae5a4SJacob Faibussowitsch {
12717a101e5eSJacob Faibussowitsch   PetscFunctionBegin;
12727a101e5eSJacob Faibussowitsch   if (event != PETSC_DECIDE) PetscCall(PetscLogEventEnd(event, NULL, NULL, NULL, NULL));
12733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12747a101e5eSJacob Faibussowitsch }
12757a101e5eSJacob Faibussowitsch 
1276d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventResume_Internal(PetscLogEvent event)
1277d71ae5a4SJacob Faibussowitsch {
12787a101e5eSJacob Faibussowitsch   PetscStageLog     stageLog;
12797a101e5eSJacob Faibussowitsch   PetscEventPerfLog eventLog;
12807a101e5eSJacob Faibussowitsch   int               stage;
12817a101e5eSJacob Faibussowitsch 
12827a101e5eSJacob Faibussowitsch   PetscFunctionBegin;
12833ba16761SJacob Faibussowitsch   if (event == PETSC_DECIDE) PetscFunctionReturn(PETSC_SUCCESS);
12847a101e5eSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(event, NULL, NULL, NULL, NULL));
12857a101e5eSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
12867a101e5eSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
12877a101e5eSJacob Faibussowitsch   PetscCall(PetscStageLogGetEventPerfLog(stageLog, stage, &eventLog));
12887a101e5eSJacob Faibussowitsch   eventLog->eventInfo[event].count--;
12893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
12907a101e5eSJacob Faibussowitsch }
12917a101e5eSJacob Faibussowitsch 
12925c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/
12935c6c1daeSBarry Smith /*@C
12945c6c1daeSBarry Smith   PetscLogDump - Dumps logs of objects to a file. This file is intended to
12955c6c1daeSBarry Smith   be read by bin/petscview. This program no longer exists.
12965c6c1daeSBarry Smith 
1297811af0c4SBarry Smith   Collective on `PETSC_COMM_WORLD`
12985c6c1daeSBarry Smith 
12995c6c1daeSBarry Smith   Input Parameter:
13005c6c1daeSBarry Smith . name - an optional file name
13015c6c1daeSBarry Smith 
13025c6c1daeSBarry Smith   Usage:
13035c6c1daeSBarry Smith .vb
13045c6c1daeSBarry Smith      PetscInitialize(...);
1305bb1d7374SBarry Smith      PetscLogDefaultBegin(); or PetscLogAllBegin();
13065c6c1daeSBarry Smith      ... code ...
13075c6c1daeSBarry Smith      PetscLogDump(filename);
13085c6c1daeSBarry Smith      PetscFinalize();
13095c6c1daeSBarry Smith .ve
13105c6c1daeSBarry Smith 
1311d1f92df0SBarry Smith   Level: advanced
1312d1f92df0SBarry Smith 
1313811af0c4SBarry Smith   Note:
13145c6c1daeSBarry Smith   The default file name is
13155c6c1daeSBarry Smith $    Log.<rank>
13165c6c1daeSBarry Smith   where <rank> is the processor number. If no name is specified,
13175c6c1daeSBarry Smith   this file will be used.
13185c6c1daeSBarry Smith 
1319d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogView()`
13205c6c1daeSBarry Smith @*/
1321d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogDump(const char sname[])
1322d71ae5a4SJacob Faibussowitsch {
13235c6c1daeSBarry Smith   PetscStageLog       stageLog;
13245c6c1daeSBarry Smith   PetscEventPerfInfo *eventInfo;
13255c6c1daeSBarry Smith   FILE               *fd;
13265c6c1daeSBarry Smith   char                file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN];
13275c6c1daeSBarry Smith   PetscLogDouble      flops, _TotalTime;
13285c6c1daeSBarry Smith   PetscMPIInt         rank;
13295c6c1daeSBarry Smith   int                 action, object, curStage;
13305c6c1daeSBarry Smith   PetscLogEvent       event;
13315c6c1daeSBarry Smith 
13325c6c1daeSBarry Smith   PetscFunctionBegin;
13335c6c1daeSBarry Smith   /* Calculate the total elapsed time */
13343ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&_TotalTime));
13355c6c1daeSBarry Smith   _TotalTime -= petsc_BaseTime;
13365c6c1daeSBarry Smith   /* Open log file */
13379566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank));
1338a364092eSJacob Faibussowitsch   PetscCall(PetscSNPrintf(file, PETSC_STATIC_ARRAY_LENGTH(file), "%s.%d", sname && sname[0] ? sname : "Log", rank));
13399566063dSJacob Faibussowitsch   PetscCall(PetscFixFilename(file, fname));
13409566063dSJacob Faibussowitsch   PetscCall(PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd));
134108401ef6SPierre Jolivet   PetscCheck(!(rank == 0) || !(!fd), PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname);
13425c6c1daeSBarry Smith   /* Output totals */
13439566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime));
13449566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0));
13455c6c1daeSBarry Smith   /* Output actions */
13465c6c1daeSBarry Smith   if (petsc_logActions) {
13479566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions));
13485c6c1daeSBarry Smith     for (action = 0; action < petsc_numActions; action++) {
13499371c9d4SSatish Balay       PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n", petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1,
1350d0609cedSBarry Smith                              petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem));
13515c6c1daeSBarry Smith     }
13525c6c1daeSBarry Smith   }
13535c6c1daeSBarry Smith   /* Output objects */
13545c6c1daeSBarry Smith   if (petsc_logObjects) {
13559566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed));
13565c6c1daeSBarry Smith     for (object = 0; object < petsc_numObjects; object++) {
13579566063dSJacob Faibussowitsch       PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int)petsc_objects[object].mem));
13585c6c1daeSBarry Smith       if (!petsc_objects[object].name[0]) {
13599566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "No Name\n"));
13605c6c1daeSBarry Smith       } else {
13619566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name));
13625c6c1daeSBarry Smith       }
13635c6c1daeSBarry Smith       if (petsc_objects[object].info[0] != 0) {
13649566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n"));
13655c6c1daeSBarry Smith       } else {
13669566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info));
13675c6c1daeSBarry Smith       }
13685c6c1daeSBarry Smith     }
13695c6c1daeSBarry Smith   }
13705c6c1daeSBarry Smith   /* Output events */
13719566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n"));
13729566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
13739566063dSJacob Faibussowitsch   PetscCall(PetscIntStackTop(stageLog->stack, &curStage));
13745c6c1daeSBarry Smith   eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo;
13755c6c1daeSBarry Smith   for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) {
1376a297a907SKarl Rupp     if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops / eventInfo[event].time;
1377a297a907SKarl Rupp     else flops = 0.0;
1378d0609cedSBarry Smith     PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count, eventInfo[event].flops, eventInfo[event].time, flops));
13795c6c1daeSBarry Smith   }
13809566063dSJacob Faibussowitsch   PetscCall(PetscFClose(PETSC_COMM_WORLD, fd));
13813ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
13825c6c1daeSBarry Smith }
13835c6c1daeSBarry Smith 
1384f14045dbSBarry Smith /*
1385f14045dbSBarry Smith   PetscLogView_Detailed - Each process prints the times for its own events
1386f14045dbSBarry Smith 
1387f14045dbSBarry Smith */
1388d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView_Detailed(PetscViewer viewer)
1389d71ae5a4SJacob Faibussowitsch {
13902dff6485SMatthew G. Knepley   PetscStageLog       stageLog;
1391217044c2SLisandro Dalcin   PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL;
1392217044c2SLisandro Dalcin   PetscLogDouble      locTotalTime, numRed, maxMem;
13932dff6485SMatthew G. Knepley   int                 numStages, numEvents, stage, event;
1394217044c2SLisandro Dalcin   MPI_Comm            comm = PetscObjectComm((PetscObject)viewer);
13952dff6485SMatthew G. Knepley   PetscMPIInt         rank, size;
1396f14045dbSBarry Smith 
1397f14045dbSBarry Smith   PetscFunctionBegin;
13989566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
13999566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
14002dff6485SMatthew G. Knepley   /* Must preserve reduction count before we go on */
14012dff6485SMatthew G. Knepley   numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
14022d1ec343SBarry Smith   /* Get the total elapsed time */
14033ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&locTotalTime));
14049371c9d4SSatish Balay   locTotalTime -= petsc_BaseTime;
14059566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "size = %d\n", size));
14069566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "LocalTimes = {}\n"));
14079566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMessages = {}\n"));
14089566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMessageLens = {}\n"));
14099566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "LocalReductions = {}\n"));
14109566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "LocalFlop = {}\n"));
14119566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "LocalObjects = {}\n"));
14129566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMemory = {}\n"));
14139566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
14149566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm));
14159566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "Stages = {}\n"));
14162d1ec343SBarry Smith   for (stage = 0; stage < numStages; stage++) {
14179566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"] = {}\n", stageLog->stageInfo[stage].name));
14189566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"][\"summary\"] = {}\n", stageLog->stageInfo[stage].name));
14199566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm));
142048a46eb9SPierre Jolivet     for (event = 0; event < numEvents; event++) PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"][\"%s\"] = {}\n", stageLog->stageInfo[stage].name, stageLog->eventLog->eventInfo[event].name));
14212d1ec343SBarry Smith   }
14229566063dSJacob Faibussowitsch   PetscCall(PetscMallocGetMaximumUsage(&maxMem));
14239566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPushSynchronized(viewer));
14249566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalTimes[%d] = %g\n", rank, locTotalTime));
14259566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMessages[%d] = %g\n", rank, (petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct)));
14269566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMessageLens[%d] = %g\n", rank, (petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len)));
14279566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalReductions[%d] = %g\n", rank, numRed));
14289566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalFlop[%d] = %g\n", rank, petsc_TotalFlops));
14299566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalObjects[%d] = %d\n", rank, petsc_numObjects));
14309566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMemory[%d] = %g\n", rank, maxMem));
14319566063dSJacob Faibussowitsch   PetscCall(PetscViewerFlush(viewer));
14322d1ec343SBarry Smith   for (stage = 0; stage < numStages; stage++) {
1433217044c2SLisandro Dalcin     stageInfo = &stageLog->stageInfo[stage].perfInfo;
14349371c9d4SSatish Balay     PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n", stageLog->stageInfo[stage].name, rank, stageInfo->time,
14359371c9d4SSatish Balay                                                  stageInfo->numMessages, stageInfo->messageLength, stageInfo->numReductions, stageInfo->flops));
14369566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm));
14372d1ec343SBarry Smith     for (event = 0; event < numEvents; event++) {
1438217044c2SLisandro Dalcin       eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event];
1439d0609cedSBarry Smith       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %d, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g",
14409371c9d4SSatish Balay                                                    stageLog->stageInfo[stage].name, stageLog->eventLog->eventInfo[event].name, rank, eventInfo->count, eventInfo->time, eventInfo->syncTime, eventInfo->numMessages, eventInfo->messageLength, eventInfo->numReductions,
14419371c9d4SSatish Balay                                                    eventInfo->flops));
1442891e75beSMatthew G. Knepley       if (eventInfo->dof[0] >= 0.) {
1443891e75beSMatthew G. Knepley         PetscInt d, e;
14445d68e14cSMatthew G. Knepley 
14459566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : ["));
1446891e75beSMatthew G. Knepley         for (d = 0; d < 8; ++d) {
14479566063dSJacob Faibussowitsch           if (d > 0) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", "));
14489566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d]));
1449891e75beSMatthew G. Knepley         }
14509566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "]"));
14519566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : ["));
14525d68e14cSMatthew G. Knepley         for (e = 0; e < 8; ++e) {
14539566063dSJacob Faibussowitsch           if (e > 0) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", "));
14549566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e]));
14555d68e14cSMatthew G. Knepley         }
14569566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "]"));
14575d68e14cSMatthew G. Knepley       }
14589566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "}\n"));
14592d1ec343SBarry Smith     }
14602d1ec343SBarry Smith   }
14619566063dSJacob Faibussowitsch   PetscCall(PetscViewerFlush(viewer));
14629566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPopSynchronized(viewer));
14633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1464f14045dbSBarry Smith }
1465f14045dbSBarry Smith 
146638144912Sdeepblu2718 /*
146738144912Sdeepblu2718   PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format
146838144912Sdeepblu2718 */
1469d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView_CSV(PetscViewer viewer)
1470d71ae5a4SJacob Faibussowitsch {
147138144912Sdeepblu2718   PetscStageLog       stageLog;
1472669c5be0SSatish Balay   PetscEventPerfInfo *eventInfo = NULL;
147338144912Sdeepblu2718   PetscLogDouble      locTotalTime, maxMem;
147438144912Sdeepblu2718   int                 numStages, numEvents, stage, event;
147538144912Sdeepblu2718   MPI_Comm            comm = PetscObjectComm((PetscObject)viewer);
147638144912Sdeepblu2718   PetscMPIInt         rank, size;
147738144912Sdeepblu2718 
147838144912Sdeepblu2718   PetscFunctionBegin;
14799566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
14809566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
148138144912Sdeepblu2718   /* Must preserve reduction count before we go on */
148238144912Sdeepblu2718   /* Get the total elapsed time */
14833ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&locTotalTime));
14849371c9d4SSatish Balay   locTotalTime -= petsc_BaseTime;
14859566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
14869566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm));
14879566063dSJacob Faibussowitsch   PetscCall(PetscMallocGetMaximumUsage(&maxMem));
14889566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPushSynchronized(viewer));
1489d0609cedSBarry Smith   PetscCall(PetscViewerASCIIPrintf(viewer, "Stage Name,Event Name,Rank,Count,Time,Num Messages,Message Length,Num Reductions,FLOP,dof0,dof1,dof2,dof3,dof4,dof5,dof6,dof7,e0,e1,e2,e3,e4,e5,e6,e7,%d\n", size));
14909566063dSJacob Faibussowitsch   PetscCall(PetscViewerFlush(viewer));
149138144912Sdeepblu2718   for (stage = 0; stage < numStages; stage++) {
14929e29573dSMatthew G. Knepley     PetscEventPerfInfo *stageInfo = &stageLog->stageInfo[stage].perfInfo;
14939e29573dSMatthew G. Knepley 
14949371c9d4SSatish Balay     PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%s,summary,%d,1,%g,%g,%g,%g,%g\n", stageLog->stageInfo[stage].name, rank, stageInfo->time, stageInfo->numMessages, stageInfo->messageLength, stageInfo->numReductions, stageInfo->flops));
14959566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm));
149638144912Sdeepblu2718     for (event = 0; event < numEvents; event++) {
149738144912Sdeepblu2718       eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event];
14989371c9d4SSatish Balay       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%s,%s,%d,%d,%g,%g,%g,%g,%g", stageLog->stageInfo[stage].name, stageLog->eventLog->eventInfo[event].name, rank, eventInfo->count, eventInfo->time, eventInfo->numMessages, eventInfo->messageLength,
14999371c9d4SSatish Balay                                                    eventInfo->numReductions, eventInfo->flops));
150038144912Sdeepblu2718       if (eventInfo->dof[0] >= 0.) {
150138144912Sdeepblu2718         PetscInt d, e;
150238144912Sdeepblu2718 
150348a46eb9SPierre Jolivet         for (d = 0; d < 8; ++d) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d]));
150448a46eb9SPierre Jolivet         for (e = 0; e < 8; ++e) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e]));
150538144912Sdeepblu2718       }
15069566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n"));
150738144912Sdeepblu2718     }
150838144912Sdeepblu2718   }
15099566063dSJacob Faibussowitsch   PetscCall(PetscViewerFlush(viewer));
15109566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPopSynchronized(viewer));
15113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
151238144912Sdeepblu2718 }
151338144912Sdeepblu2718 
1514d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm, FILE *fd)
1515d71ae5a4SJacob Faibussowitsch {
1516217044c2SLisandro Dalcin   PetscFunctionBegin;
15173ba16761SJacob Faibussowitsch   if (!PetscLogSyncOn) PetscFunctionReturn(PETSC_SUCCESS);
15189566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n\n"));
15199566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n"));
15209566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
15219566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n"));
15229566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
15239566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   This program was run with logging synchronization.   #\n"));
15249566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   This option provides more meaningful imbalance       #\n"));
15259566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   figures at the expense of slowing things down and    #\n"));
15269566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   providing a distorted view of the overall runtime.   #\n"));
15279566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
15289566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n\n\n"));
15293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1530217044c2SLisandro Dalcin }
1531217044c2SLisandro Dalcin 
1532d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm, FILE *fd)
1533d71ae5a4SJacob Faibussowitsch {
1534f4091ad2SBarry Smith   PetscFunctionBegin;
153576bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
15369566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "\n\n"));
15379566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n"));
15389566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
15399566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n"));
15409566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
15419566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #   This code was compiled with a debugging option.      #\n"));
15429566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #   To get timing results run ./configure                #\n"));
15439566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #   using --with-debugging=no, the performance will      #\n"));
15449566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #   be generally two or three times faster.              #\n"));
15459566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
15469566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n\n\n"));
154776bd3646SJed Brown   }
15483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1549f4091ad2SBarry Smith }
1550f4091ad2SBarry Smith 
1551d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnNoGpuAwareMpi(MPI_Comm comm, FILE *fd)
1552d71ae5a4SJacob Faibussowitsch {
1553009ab46cSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1554009ab46cSJunchao Zhang   PetscMPIInt size;
15558fe3844cSJunchao Zhang   PetscBool   deviceInitialized = PETSC_FALSE;
1556c2a741eeSJunchao Zhang 
1557c2a741eeSJunchao Zhang   PetscFunctionBegin;
15589566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
15598fe3844cSJunchao Zhang   for (int i = PETSC_DEVICE_HOST + 1; i < PETSC_DEVICE_MAX; ++i) {
15608fe3844cSJunchao Zhang     const PetscDeviceType dtype = PetscDeviceTypeCast(i);
15618fe3844cSJunchao Zhang     if (PetscDeviceInitialized(dtype)) { /* a non-host device was initialized */
15628fe3844cSJunchao Zhang       deviceInitialized = PETSC_TRUE;
15638fe3844cSJunchao Zhang       break;
15648fe3844cSJunchao Zhang     }
15658fe3844cSJunchao Zhang   }
15668fe3844cSJunchao Zhang   /* the last condition says petsc is configured with device but it is a pure CPU run, so don't print misleading warnings */
15673ba16761SJacob Faibussowitsch   if (use_gpu_aware_mpi || size == 1 || !deviceInitialized) PetscFunctionReturn(PETSC_SUCCESS);
15689566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n\n"));
15699566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n"));
15709566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
15719566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n"));
15729566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
15739566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   This code was compiled with GPU support and you've   #\n"));
15749566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   created PETSc/GPU objects, but you intentionally     #\n"));
15759566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   used -use_gpu_aware_mpi 0, requiring PETSc to copy   #\n"));
15769566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   additional data between the GPU and CPU. To obtain   #\n"));
15779566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   meaningful timing results on multi-rank runs, use    #\n"));
15789566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   GPU-aware MPI instead.                               #\n"));
15799566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
15809566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n\n\n"));
15813ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1582c2a741eeSJunchao Zhang   #else
15833ba16761SJacob Faibussowitsch   return PETSC_SUCCESS;
1584c2a741eeSJunchao Zhang   #endif
1585c2a741eeSJunchao Zhang }
1586c2a741eeSJunchao Zhang 
1587d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnGpuTime(MPI_Comm comm, FILE *fd)
1588d71ae5a4SJacob Faibussowitsch {
1589156b51fbSBarry Smith   #if defined(PETSC_HAVE_DEVICE)
1590156b51fbSBarry Smith 
1591156b51fbSBarry Smith   PetscFunctionBegin;
15923ba16761SJacob Faibussowitsch   if (!PetscLogGpuTimeFlag || petsc_gflops == 0) PetscFunctionReturn(PETSC_SUCCESS);
1593156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "\n\n"));
1594156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n"));
1595156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
1596156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n"));
1597156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
1598156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #   This code was run with -log_view_gpu_time            #\n"));
1599156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #   This provides accurate timing within the GPU kernels #\n"));
1600156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #   but can slow down the entire computation by a        #\n"));
1601156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #   measurable amount. For fastest runs we recommend     #\n"));
1602156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #   not using this option.                               #\n"));
1603156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
1604156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n\n\n"));
16053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1606156b51fbSBarry Smith   #else
16073ba16761SJacob Faibussowitsch   return PETSC_SUCCESS;
1608156b51fbSBarry Smith   #endif
1609156b51fbSBarry Smith }
1610156b51fbSBarry Smith 
1611d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView_Default(PetscViewer viewer)
1612d71ae5a4SJacob Faibussowitsch {
16135c6c1daeSBarry Smith   FILE               *fd;
16145c6c1daeSBarry Smith   PetscLogDouble      zero = 0.0;
16155c6c1daeSBarry Smith   PetscStageLog       stageLog;
16160298fd71SBarry Smith   PetscStageInfo     *stageInfo = NULL;
16170298fd71SBarry Smith   PetscEventPerfInfo *eventInfo = NULL;
16185c6c1daeSBarry Smith   PetscClassPerfInfo *classInfo;
16195c6c1daeSBarry Smith   char                arch[128], hostname[128], username[128], pname[PETSC_MAX_PATH_LEN], date[128];
16205c6c1daeSBarry Smith   const char         *name;
16215c6c1daeSBarry Smith   PetscLogDouble      locTotalTime, TotalTime, TotalFlops;
16225c6c1daeSBarry Smith   PetscLogDouble      numMessages, messageLength, avgMessLen, numReductions;
16235c6c1daeSBarry Smith   PetscLogDouble      stageTime, flops, flopr, mem, mess, messLen, red;
16245c6c1daeSBarry Smith   PetscLogDouble      fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed;
16255c6c1daeSBarry Smith   PetscLogDouble      fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed;
16265c6c1daeSBarry Smith   PetscLogDouble      min, max, tot, ratio, avg, x, y;
1627e3ed9ee7SBarry Smith   PetscLogDouble      minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr, mal, malmax, emalmax;
1628d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1629156b51fbSBarry Smith   PetscLogEvent  KSP_Solve, SNES_Solve, TS_Step, TAO_Solve; /* These need to be fixed to be some events registered with certain objects */
1630958c4211Shannah_mairs   PetscLogDouble cct, gct, csz, gsz, gmaxt, gflops, gflopr, fracgflops;
1631bec0b493Shannah_mairs   #endif
1632217044c2SLisandro Dalcin   PetscMPIInt   minC, maxC;
16335c6c1daeSBarry Smith   PetscMPIInt   size, rank;
16345c6c1daeSBarry Smith   PetscBool    *localStageUsed, *stageUsed;
16355c6c1daeSBarry Smith   PetscBool    *localStageVisible, *stageVisible;
16365c6c1daeSBarry Smith   int           numStages, localNumEvents, numEvents;
163737b78d16SBarry Smith   int           stage, oclass;
16385c6c1daeSBarry Smith   PetscLogEvent event;
16395c6c1daeSBarry Smith   char          version[256];
16405c6c1daeSBarry Smith   MPI_Comm      comm;
1641156b51fbSBarry Smith   #if defined(PETSC_HAVE_DEVICE)
1642156b51fbSBarry Smith   PetscLogEvent eventid;
1643156b51fbSBarry Smith   PetscInt64    nas = 0x7FF0000000000002;
1644156b51fbSBarry Smith   #endif
16455c6c1daeSBarry Smith 
16465c6c1daeSBarry Smith   PetscFunctionBegin;
1647156b51fbSBarry Smith   PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF));
16489566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)viewer, &comm));
16499566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIGetPointer(viewer, &fd));
16509566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
16519566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
16525c6c1daeSBarry Smith   /* Get the total elapsed time */
16533ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&locTotalTime));
16549371c9d4SSatish Balay   locTotalTime -= petsc_BaseTime;
16555c6c1daeSBarry Smith 
1656faad7b01SPierre Jolivet   PetscCall(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n"));
16579566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "***                                WIDEN YOUR WINDOW TO 160 CHARACTERS.  Use 'enscript -r -fCourier9' to print this document                                 ***\n"));
16589566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n"));
1659faad7b01SPierre Jolivet   PetscCall(PetscFPrintf(comm, fd, "\n------------------------------------------------------------------ PETSc Performance Summary: ------------------------------------------------------------------\n\n"));
16609566063dSJacob Faibussowitsch   PetscCall(PetscLogViewWarnSync(comm, fd));
16619566063dSJacob Faibussowitsch   PetscCall(PetscLogViewWarnDebugging(comm, fd));
16629566063dSJacob Faibussowitsch   PetscCall(PetscLogViewWarnNoGpuAwareMpi(comm, fd));
1663156b51fbSBarry Smith   PetscCall(PetscLogViewWarnGpuTime(comm, fd));
16649566063dSJacob Faibussowitsch   PetscCall(PetscGetArchType(arch, sizeof(arch)));
16659566063dSJacob Faibussowitsch   PetscCall(PetscGetHostName(hostname, sizeof(hostname)));
16669566063dSJacob Faibussowitsch   PetscCall(PetscGetUserName(username, sizeof(username)));
16679566063dSJacob Faibussowitsch   PetscCall(PetscGetProgramName(pname, sizeof(pname)));
16689566063dSJacob Faibussowitsch   PetscCall(PetscGetDate(date, sizeof(date)));
16699566063dSJacob Faibussowitsch   PetscCall(PetscGetVersion(version, sizeof(version)));
16705c6c1daeSBarry Smith   if (size == 1) {
16719566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "%s on a %s named %s with %d processor, by %s %s\n", pname, arch, hostname, size, username, date));
16725c6c1daeSBarry Smith   } else {
16739566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "%s on a %s named %s with %d processors, by %s %s\n", pname, arch, hostname, size, username, date));
16745c6c1daeSBarry Smith   }
1675f90b075cSBarry Smith   #if defined(PETSC_HAVE_OPENMP)
16769566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Using %" PetscInt_FMT " OpenMP threads\n", PetscNumOMPThreads));
1677f90b075cSBarry Smith   #endif
16789566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Using %s\n", version));
16795c6c1daeSBarry Smith 
16805c6c1daeSBarry Smith   /* Must preserve reduction count before we go on */
16815c6c1daeSBarry Smith   red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
16825c6c1daeSBarry Smith 
16835c6c1daeSBarry Smith   /* Calculate summary information */
16849566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n                         Max       Max/Min     Avg       Total\n"));
16855c6c1daeSBarry Smith   /*   Time */
1686712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
1687712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1688712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1689217044c2SLisandro Dalcin   avg = tot / ((PetscLogDouble)size);
16909371c9d4SSatish Balay   if (min != 0.0) ratio = max / min;
16919371c9d4SSatish Balay   else ratio = 0.0;
16929566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Time (sec):           %5.3e   %7.3f   %5.3e\n", max, ratio, avg));
16935c6c1daeSBarry Smith   TotalTime = tot;
16945c6c1daeSBarry Smith   /*   Objects */
16955c6c1daeSBarry Smith   avg = (PetscLogDouble)petsc_numObjects;
1696712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
1697712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1698712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1699217044c2SLisandro Dalcin   avg = tot / ((PetscLogDouble)size);
17009371c9d4SSatish Balay   if (min != 0.0) ratio = max / min;
17019371c9d4SSatish Balay   else ratio = 0.0;
17029566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Objects:              %5.3e   %7.3f   %5.3e\n", max, ratio, avg));
17035c6c1daeSBarry Smith   /*   Flops */
1704712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
1705712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1706712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&petsc_TotalFlops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1707217044c2SLisandro Dalcin   avg = tot / ((PetscLogDouble)size);
17089371c9d4SSatish Balay   if (min != 0.0) ratio = max / min;
17099371c9d4SSatish Balay   else ratio = 0.0;
17109566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Flops:                %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
17115c6c1daeSBarry Smith   TotalFlops = tot;
17125c6c1daeSBarry Smith   /*   Flops/sec -- Must talk to Barry here */
17139371c9d4SSatish Balay   if (locTotalTime != 0.0) flops = petsc_TotalFlops / locTotalTime;
17149371c9d4SSatish Balay   else flops = 0.0;
1715712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
1716712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1717712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1718217044c2SLisandro Dalcin   avg = tot / ((PetscLogDouble)size);
17199371c9d4SSatish Balay   if (min != 0.0) ratio = max / min;
17209371c9d4SSatish Balay   else ratio = 0.0;
17219566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Flops/sec:            %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
17225c6c1daeSBarry Smith   /*   Memory */
17239566063dSJacob Faibussowitsch   PetscCall(PetscMallocGetMaximumUsage(&mem));
17245c6c1daeSBarry Smith   if (mem > 0.0) {
1725712fec58SPierre Jolivet     PetscCall(MPIU_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
1726712fec58SPierre Jolivet     PetscCall(MPIU_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1727712fec58SPierre Jolivet     PetscCall(MPIU_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1728217044c2SLisandro Dalcin     avg = tot / ((PetscLogDouble)size);
17299371c9d4SSatish Balay     if (min != 0.0) ratio = max / min;
17309371c9d4SSatish Balay     else ratio = 0.0;
17319566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "Memory (bytes):       %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
17325c6c1daeSBarry Smith   }
17335c6c1daeSBarry Smith   /*   Messages */
17345c6c1daeSBarry Smith   mess = 0.5 * (petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct);
1735712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
1736712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1737712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1738217044c2SLisandro Dalcin   avg = tot / ((PetscLogDouble)size);
17399371c9d4SSatish Balay   if (min != 0.0) ratio = max / min;
17409371c9d4SSatish Balay   else ratio = 0.0;
17419566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "MPI Msg Count:        %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
17425c6c1daeSBarry Smith   numMessages = tot;
17435c6c1daeSBarry Smith   /*   Message Lengths */
17445c6c1daeSBarry Smith   mess = 0.5 * (petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len);
1745712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
1746712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1747712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17489371c9d4SSatish Balay   if (numMessages != 0) avg = tot / numMessages;
17499371c9d4SSatish Balay   else avg = 0.0;
17509371c9d4SSatish Balay   if (min != 0.0) ratio = max / min;
17519371c9d4SSatish Balay   else ratio = 0.0;
17529566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "MPI Msg Len (bytes):  %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
17535c6c1daeSBarry Smith   messageLength = tot;
17545c6c1daeSBarry Smith   /*   Reductions */
1755712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
1756712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1757712fec58SPierre Jolivet   PetscCall(MPIU_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17589371c9d4SSatish Balay   if (min != 0.0) ratio = max / min;
17599371c9d4SSatish Balay   else ratio = 0.0;
17609566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "MPI Reductions:       %5.3e   %7.3f\n", max, ratio));
17615c6c1daeSBarry Smith   numReductions = red; /* wrong because uses count from process zero */
17629566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n"));
17639566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "                            e.g., VecAXPY() for real vectors of length N --> 2N flops\n"));
17649566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "                            and VecAXPY() for complex vectors of length N --> 8N flops\n"));
17655c6c1daeSBarry Smith 
17665c6c1daeSBarry Smith   /* Get total number of stages --
17675c6c1daeSBarry Smith        Currently, a single processor can register more stages than another, but stages must all be registered in order.
17685c6c1daeSBarry Smith        We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID.
17695c6c1daeSBarry Smith        This seems best accomplished by assoicating a communicator with each stage.
17705c6c1daeSBarry Smith   */
17719566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
17729566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm));
17739566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(numStages, &localStageUsed));
17749566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(numStages, &stageUsed));
17759566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(numStages, &localStageVisible));
17769566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(numStages, &stageVisible));
17775c6c1daeSBarry Smith   if (numStages > 0) {
17785c6c1daeSBarry Smith     stageInfo = stageLog->stageInfo;
17795c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
17805c6c1daeSBarry Smith       if (stage < stageLog->numStages) {
17815c6c1daeSBarry Smith         localStageUsed[stage]    = stageInfo[stage].used;
17825c6c1daeSBarry Smith         localStageVisible[stage] = stageInfo[stage].perfInfo.visible;
17835c6c1daeSBarry Smith       } else {
17845c6c1daeSBarry Smith         localStageUsed[stage]    = PETSC_FALSE;
17855c6c1daeSBarry Smith         localStageVisible[stage] = PETSC_TRUE;
17865c6c1daeSBarry Smith       }
17875c6c1daeSBarry Smith     }
1788712fec58SPierre Jolivet     PetscCall(MPIU_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm));
1789712fec58SPierre Jolivet     PetscCall(MPIU_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm));
17905c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
17915c6c1daeSBarry Smith       if (stageUsed[stage]) {
17929566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(comm, fd, "\nSummary of Stages:   ----- Time ------  ----- Flop ------  --- Messages ---  -- Message Lengths --  -- Reductions --\n"));
17939566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(comm, fd, "                        Avg     %%Total     Avg     %%Total    Count   %%Total     Avg         %%Total    Count   %%Total\n"));
17945c6c1daeSBarry Smith         break;
17955c6c1daeSBarry Smith       }
17965c6c1daeSBarry Smith     }
17975c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
17985c6c1daeSBarry Smith       if (!stageUsed[stage]) continue;
1799820f2d46SBarry Smith       /* CANNOT use MPI_Allreduce() since it might fail the line number check */
18005c6c1daeSBarry Smith       if (localStageUsed[stage]) {
1801712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1802712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1803712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1804712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1805712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18065c6c1daeSBarry Smith         name = stageInfo[stage].name;
18075c6c1daeSBarry Smith       } else {
1808712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1809712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1810712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1811712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1812712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18135c6c1daeSBarry Smith         name = "";
18145c6c1daeSBarry Smith       }
18159371c9d4SSatish Balay       mess *= 0.5;
18169371c9d4SSatish Balay       messLen *= 0.5;
18179371c9d4SSatish Balay       red /= size;
18189371c9d4SSatish Balay       if (TotalTime != 0.0) fracTime = stageTime / TotalTime;
18199371c9d4SSatish Balay       else fracTime = 0.0;
18209371c9d4SSatish Balay       if (TotalFlops != 0.0) fracFlops = flops / TotalFlops;
18219371c9d4SSatish Balay       else fracFlops = 0.0;
18225c6c1daeSBarry Smith       /* Talk to Barry if (stageTime     != 0.0) flops          = (size*flops)/stageTime; else flops          = 0.0; */
18239371c9d4SSatish Balay       if (numMessages != 0.0) fracMessages = mess / numMessages;
18249371c9d4SSatish Balay       else fracMessages = 0.0;
18259371c9d4SSatish Balay       if (mess != 0.0) avgMessLen = messLen / mess;
18269371c9d4SSatish Balay       else avgMessLen = 0.0;
18279371c9d4SSatish Balay       if (messageLength != 0.0) fracLength = messLen / messageLength;
18289371c9d4SSatish Balay       else fracLength = 0.0;
18299371c9d4SSatish Balay       if (numReductions != 0.0) fracReductions = red / numReductions;
18309371c9d4SSatish Balay       else fracReductions = 0.0;
18319371c9d4SSatish Balay       PetscCall(PetscFPrintf(comm, fd, "%2d: %15s: %6.4e %5.1f%%  %6.4e %5.1f%%  %5.3e %5.1f%%  %5.3e      %5.1f%%  %5.3e %5.1f%%\n", stage, name, stageTime / size, 100.0 * fracTime, flops, 100.0 * fracFlops, mess, 100.0 * fracMessages, avgMessLen, 100.0 * fracLength, red, 100.0 * fracReductions));
18325c6c1daeSBarry Smith     }
18335c6c1daeSBarry Smith   }
18345c6c1daeSBarry Smith 
18359566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n------------------------------------------------------------------------------------------------------------------------\n"));
18369566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n"));
18379566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Phase summary info:\n"));
18389566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   Count: number of times phase was executed\n"));
18399566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   Time and Flop: Max - maximum over all processors\n"));
18409566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "                  Ratio - ratio of maximum to minimum over all processors\n"));
18419566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   Mess: number of messages sent\n"));
18429566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   AvgLen: average message length (bytes)\n"));
18439566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   Reduct: number of global reductions\n"));
18449566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   Global: entire computation\n"));
18459566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n"));
18469566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      %%T - percent time in this phase         %%F - percent flop in this phase\n"));
18479566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      %%M - percent messages in this phase     %%L - percent message lengths in this phase\n"));
18489566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      %%R - percent reductions in this phase\n"));
18499566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n"));
1850e3ed9ee7SBarry Smith   if (PetscLogMemory) {
185154aabf2dSBarry Smith     PetscCall(PetscFPrintf(comm, fd, "   Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event). May be negative\n"));
185254aabf2dSBarry Smith     PetscCall(PetscFPrintf(comm, fd, "   EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events). Never negative\n"));
185354aabf2dSBarry Smith     PetscCall(PetscFPrintf(comm, fd, "   MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event). Never negative\n"));
18549566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "   RMI Mbytes: Increase in resident memory (sum over all calls to event)\n"));
1855e3ed9ee7SBarry Smith   }
1856d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
18579566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   GPU Mflop/s: 10e-6 * (sum of flop on GPU over all processors)/(max GPU time over all processors)\n"));
18589566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   CpuToGpu Count: total number of CPU to GPU copies per processor\n"));
18599566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   CpuToGpu Size (Mbytes): 10e-6 * (total size of CPU to GPU copies per processor)\n"));
18609566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   GpuToCpu Count: total number of GPU to CPU copies per processor\n"));
18619566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   GpuToCpu Size (Mbytes): 10e-6 * (total size of GPU to CPU copies per processor)\n"));
18629566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   GPU %%F: percent flops on GPU in this event\n"));
1863bec0b493Shannah_mairs   #endif
18649566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n"));
18655c6c1daeSBarry Smith 
18669566063dSJacob Faibussowitsch   PetscCall(PetscLogViewWarnDebugging(comm, fd));
18675c6c1daeSBarry Smith 
18685c6c1daeSBarry Smith   /* Report events */
18699566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Event                Count      Time (sec)     Flop                              --- Global ---  --- Stage ----  Total"));
187048a46eb9SPierre Jolivet   if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, "  Malloc EMalloc MMalloc RMI"));
1871d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
18729566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   GPU    - CpuToGpu -   - GpuToCpu - GPU"));
1873bec0b493Shannah_mairs   #endif
18749566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n"));
18759566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "                   Max Ratio  Max     Ratio   Max  Ratio  Mess   AvgLen  Reduct  %%T %%F %%M %%L %%R  %%T %%F %%M %%L %%R Mflop/s"));
187648a46eb9SPierre Jolivet   if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, " Mbytes Mbytes Mbytes Mbytes"));
1877d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
18789566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, " Mflop/s Count   Size   Count   Size  %%F"));
1879bec0b493Shannah_mairs   #endif
18809566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n"));
18819566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------"));
188248a46eb9SPierre Jolivet   if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, "-----------------------------"));
1883d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
18849566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "---------------------------------------"));
18854863603aSSatish Balay   #endif
18869566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n"));
18875c6c1daeSBarry Smith 
1888156b51fbSBarry Smith   #if defined(PETSC_HAVE_DEVICE)
1889156b51fbSBarry Smith   /* this indirect way of accessing these values is needed when PETSc is build with multiple libraries since the symbols are not in libpetscsys */
1890156b51fbSBarry Smith   PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "TAOSolve", &TAO_Solve));
1891156b51fbSBarry Smith   PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "TSStep", &TS_Step));
1892156b51fbSBarry Smith   PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "SNESSolve", &SNES_Solve));
1893156b51fbSBarry Smith   PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "KSPSolve", &KSP_Solve));
1894156b51fbSBarry Smith   #endif
1895156b51fbSBarry Smith 
18965c6c1daeSBarry Smith   /* Problem: The stage name will not show up unless the stage executed on proc 1 */
18975c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
18985c6c1daeSBarry Smith     if (!stageVisible[stage]) continue;
1899820f2d46SBarry Smith     /* CANNOT use MPI_Allreduce() since it might fail the line number check */
19005c6c1daeSBarry Smith     if (localStageUsed[stage]) {
19019566063dSJacob Faibussowitsch       PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name));
1902712fec58SPierre Jolivet       PetscCall(MPIU_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1903712fec58SPierre Jolivet       PetscCall(MPIU_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1904712fec58SPierre Jolivet       PetscCall(MPIU_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1905712fec58SPierre Jolivet       PetscCall(MPIU_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1906712fec58SPierre Jolivet       PetscCall(MPIU_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
19075c6c1daeSBarry Smith     } else {
19089566063dSJacob Faibussowitsch       PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage));
1909712fec58SPierre Jolivet       PetscCall(MPIU_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1910712fec58SPierre Jolivet       PetscCall(MPIU_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1911712fec58SPierre Jolivet       PetscCall(MPIU_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1912712fec58SPierre Jolivet       PetscCall(MPIU_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1913712fec58SPierre Jolivet       PetscCall(MPIU_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
19145c6c1daeSBarry Smith     }
19159371c9d4SSatish Balay     mess *= 0.5;
19169371c9d4SSatish Balay     messLen *= 0.5;
19179371c9d4SSatish Balay     red /= size;
19185c6c1daeSBarry Smith 
19195c6c1daeSBarry Smith     /* Get total number of events in this stage --
19205c6c1daeSBarry Smith        Currently, a single processor can register more events than another, but events must all be registered in order,
19215c6c1daeSBarry Smith        just like stages. We can removed this requirement if necessary by having a global event numbering and indirection
1922217044c2SLisandro Dalcin        on the event ID. This seems best accomplished by associating a communicator with each stage.
19235c6c1daeSBarry Smith 
19245c6c1daeSBarry Smith        Problem: If the event did not happen on proc 1, its name will not be available.
19255c6c1daeSBarry Smith        Problem: Event visibility is not implemented
19265c6c1daeSBarry Smith     */
19275c6c1daeSBarry Smith     if (localStageUsed[stage]) {
19285c6c1daeSBarry Smith       eventInfo      = stageLog->stageInfo[stage].eventLog->eventInfo;
19295c6c1daeSBarry Smith       localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents;
1930a297a907SKarl Rupp     } else localNumEvents = 0;
19319566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm));
19325c6c1daeSBarry Smith     for (event = 0; event < numEvents; event++) {
1933820f2d46SBarry Smith       /* CANNOT use MPI_Allreduce() since it might fail the line number check */
19345c6c1daeSBarry Smith       if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) {
19359371c9d4SSatish Balay         if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops;
19369371c9d4SSatish Balay         else flopr = 0.0;
1937712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
1938712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1939712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1940712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
1941712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1942712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1943712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1944712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1945712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
19469566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].count, &minC, 1, MPI_INT, MPI_MIN, comm));
19479566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].count, &maxC, 1, MPI_INT, MPI_MAX, comm));
1948e3ed9ee7SBarry Smith         if (PetscLogMemory) {
1949712fec58SPierre Jolivet           PetscCall(MPIU_Allreduce(&eventInfo[event].memIncrease, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1950712fec58SPierre Jolivet           PetscCall(MPIU_Allreduce(&eventInfo[event].mallocSpace, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1951712fec58SPierre Jolivet           PetscCall(MPIU_Allreduce(&eventInfo[event].mallocIncrease, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1952712fec58SPierre Jolivet           PetscCall(MPIU_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1953e3ed9ee7SBarry Smith         }
1954d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1955712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&eventInfo[event].CpuToGpuCount, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1956712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&eventInfo[event].GpuToCpuCount, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1957712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&eventInfo[event].CpuToGpuSize, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1958712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&eventInfo[event].GpuToCpuSize, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1959712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&eventInfo[event].GpuFlops, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1960712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&eventInfo[event].GpuTime, &gmaxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1961bec0b493Shannah_mairs   #endif
19625c6c1daeSBarry Smith         name = stageLog->eventLog->eventInfo[event].name;
19635c6c1daeSBarry Smith       } else {
19643ba16761SJacob Faibussowitsch         int ierr = 0;
19653ba16761SJacob Faibussowitsch 
19665c6c1daeSBarry Smith         flopr = 0.0;
1967712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
1968712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1969712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1970712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
1971712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1972712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1973712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1974712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1975712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
19769566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&ierr, &minC, 1, MPI_INT, MPI_MIN, comm));
19779566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&ierr, &maxC, 1, MPI_INT, MPI_MAX, comm));
1978e3ed9ee7SBarry Smith         if (PetscLogMemory) {
1979712fec58SPierre Jolivet           PetscCall(MPIU_Allreduce(&zero, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1980712fec58SPierre Jolivet           PetscCall(MPIU_Allreduce(&zero, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1981712fec58SPierre Jolivet           PetscCall(MPIU_Allreduce(&zero, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1982712fec58SPierre Jolivet           PetscCall(MPIU_Allreduce(&zero, &emalmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1983e3ed9ee7SBarry Smith         }
1984d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1985712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1986712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1987712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1988712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1989712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1990712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(&zero, &gmaxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1991bec0b493Shannah_mairs   #endif
19925c6c1daeSBarry Smith         name = "";
19935c6c1daeSBarry Smith       }
19945c6c1daeSBarry Smith       if (mint < 0.0) {
1995d0609cedSBarry Smith         PetscCall(PetscFPrintf(comm, fd, "WARNING!!! Minimum time %g over all processors for %s is negative! This happens\n on some machines whose times cannot handle too rapid calls.!\n artificially changing minimum to zero.\n", mint, name));
19965c6c1daeSBarry Smith         mint = 0;
19975c6c1daeSBarry Smith       }
199808401ef6SPierre Jolivet       PetscCheck(minf >= 0.0, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Minimum flop %g over all processors for %s is negative! Not possible!", minf, name);
1999156b51fbSBarry Smith   /* Put NaN into the time for all events that may not be time accurately since they may happen asynchronously on the GPU */
2000156b51fbSBarry Smith   #if defined(PETSC_HAVE_DEVICE)
2001156b51fbSBarry Smith       if (!PetscLogGpuTimeFlag && petsc_gflops > 0) {
2002156b51fbSBarry Smith         memcpy(&gmaxt, &nas, sizeof(PetscLogDouble));
2003156b51fbSBarry Smith         PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, &eventid));
2004156b51fbSBarry Smith         if (eventid != SNES_Solve && eventid != KSP_Solve && eventid != TS_Step && eventid != TAO_Solve) {
2005156b51fbSBarry Smith           memcpy(&mint, &nas, sizeof(PetscLogDouble));
2006156b51fbSBarry Smith           memcpy(&maxt, &nas, sizeof(PetscLogDouble));
2007156b51fbSBarry Smith         }
2008156b51fbSBarry Smith       }
2009156b51fbSBarry Smith   #endif
20109371c9d4SSatish Balay       totm *= 0.5;
20119371c9d4SSatish Balay       totml *= 0.5;
20129371c9d4SSatish Balay       totr /= size;
20135c6c1daeSBarry Smith 
2014217044c2SLisandro Dalcin       if (maxC != 0) {
20159371c9d4SSatish Balay         if (minC != 0) ratC = ((PetscLogDouble)maxC) / minC;
20169371c9d4SSatish Balay         else ratC = 0.0;
20179371c9d4SSatish Balay         if (mint != 0.0) ratt = maxt / mint;
20189371c9d4SSatish Balay         else ratt = 0.0;
20199371c9d4SSatish Balay         if (minf != 0.0) ratf = maxf / minf;
20209371c9d4SSatish Balay         else ratf = 0.0;
20219371c9d4SSatish Balay         if (TotalTime != 0.0) fracTime = tott / TotalTime;
20229371c9d4SSatish Balay         else fracTime = 0.0;
20239371c9d4SSatish Balay         if (TotalFlops != 0.0) fracFlops = totf / TotalFlops;
20249371c9d4SSatish Balay         else fracFlops = 0.0;
20259371c9d4SSatish Balay         if (stageTime != 0.0) fracStageTime = tott / stageTime;
20269371c9d4SSatish Balay         else fracStageTime = 0.0;
20279371c9d4SSatish Balay         if (flops != 0.0) fracStageFlops = totf / flops;
20289371c9d4SSatish Balay         else fracStageFlops = 0.0;
20299371c9d4SSatish Balay         if (numMessages != 0.0) fracMess = totm / numMessages;
20309371c9d4SSatish Balay         else fracMess = 0.0;
20319371c9d4SSatish Balay         if (messageLength != 0.0) fracMessLen = totml / messageLength;
20329371c9d4SSatish Balay         else fracMessLen = 0.0;
20339371c9d4SSatish Balay         if (numReductions != 0.0) fracRed = totr / numReductions;
20349371c9d4SSatish Balay         else fracRed = 0.0;
20359371c9d4SSatish Balay         if (mess != 0.0) fracStageMess = totm / mess;
20369371c9d4SSatish Balay         else fracStageMess = 0.0;
20379371c9d4SSatish Balay         if (messLen != 0.0) fracStageMessLen = totml / messLen;
20389371c9d4SSatish Balay         else fracStageMessLen = 0.0;
20399371c9d4SSatish Balay         if (red != 0.0) fracStageRed = totr / red;
20409371c9d4SSatish Balay         else fracStageRed = 0.0;
20419371c9d4SSatish Balay         if (totm != 0.0) totml /= totm;
20429371c9d4SSatish Balay         else totml = 0.0;
20439371c9d4SSatish Balay         if (maxt != 0.0) flopr = totf / maxt;
20449371c9d4SSatish Balay         else flopr = 0.0;
204568a21331SBarry Smith         if (fracStageTime > 1.0 || fracStageFlops > 1.0 || fracStageMess > 1.0 || fracStageMessLen > 1.0 || fracStageRed > 1.0)
2046a76edefcSRicardo Jesus           PetscCall(PetscFPrintf(comm, fd, "%-16s %7d %3.1f %5.4e %3.1f %3.2e %3.1f %2.1e %2.1e %2.1e %2.0f %2.0f %2.0f %2.0f %2.0f Multiple stages %5.0f", name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr, 100.0 * fracTime, 100.0 * fracFlops, 100.0 * fracMess, 100.0 * fracMessLen, 100.0 * fracRed, PetscAbs(flopr) / 1.0e6));
204768a21331SBarry Smith         else
2048a76edefcSRicardo Jesus           PetscCall(PetscFPrintf(comm, fd, "%-16s %7d %3.1f %5.4e %3.1f %3.2e %3.1f %2.1e %2.1e %2.1e %2.0f %2.0f %2.0f %2.0f %2.0f %3.0f %2.0f %2.0f %2.0f %2.0f %5.0f", name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr, 100.0 * fracTime, 100.0 * fracFlops, 100.0 * fracMess, 100.0 * fracMessLen, 100.0 * fracRed, 100.0 * fracStageTime, 100.0 * fracStageFlops, 100.0 * fracStageMess, 100.0 * fracStageMessLen, 100.0 * fracStageRed, PetscAbs(flopr) / 1.0e6));
204948a46eb9SPierre Jolivet         if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, " %5.0f   %5.0f   %5.0f   %5.0f", mal / 1.0e6, emalmax / 1.0e6, malmax / 1.0e6, mem / 1.0e6));
2050d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
20519371c9d4SSatish Balay         if (totf != 0.0) fracgflops = gflops / totf;
20529371c9d4SSatish Balay         else fracgflops = 0.0;
20539371c9d4SSatish Balay         if (gmaxt != 0.0) gflopr = gflops / gmaxt;
20549371c9d4SSatish Balay         else gflopr = 0.0;
2055a76edefcSRicardo Jesus         PetscCall(PetscFPrintf(comm, fd, "   %5.0f   %4.0f %3.2e %4.0f %3.2e % 2.0f", PetscAbs(gflopr) / 1.0e6, cct / size, csz / (1.0e6 * size), gct / size, gsz / (1.0e6 * size), 100.0 * fracgflops));
2056bec0b493Shannah_mairs   #endif
20579566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(comm, fd, "\n"));
20585c6c1daeSBarry Smith       }
20595c6c1daeSBarry Smith     }
20605c6c1daeSBarry Smith   }
20615c6c1daeSBarry Smith 
20625c6c1daeSBarry Smith   /* Memory usage and object creation */
20639566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------"));
206448a46eb9SPierre Jolivet   if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, "-----------------------------"));
2065d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
20669566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "---------------------------------------"));
20674863603aSSatish Balay   #endif
20689566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n"));
20699566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n"));
20705c6c1daeSBarry Smith 
20715c6c1daeSBarry Smith   /* Right now, only stages on the first processor are reported here, meaning only objects associated with
20725c6c1daeSBarry Smith      the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then
20735c6c1daeSBarry Smith      stats for stages local to processor sets.
20745c6c1daeSBarry Smith   */
20755c6c1daeSBarry Smith   /* We should figure out the longest object name here (now 20 characters) */
20764851f57dSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "Object Type          Creations   Destructions. Reports information only for process 0.\n"));
20775c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
20785c6c1daeSBarry Smith     if (localStageUsed[stage]) {
20795c6c1daeSBarry Smith       classInfo = stageLog->stageInfo[stage].classLog->classInfo;
20809566063dSJacob Faibussowitsch       PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name));
20815c6c1daeSBarry Smith       for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) {
20825c6c1daeSBarry Smith         if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) {
20834851f57dSBarry Smith           PetscCall(PetscFPrintf(comm, fd, "%20s %5d          %5d\n", stageLog->classLog->classInfo[oclass].name, classInfo[oclass].creations, classInfo[oclass].destructions));
20845c6c1daeSBarry Smith         }
20855c6c1daeSBarry Smith       }
20865c6c1daeSBarry Smith     } else {
2087cf019ec6SStefano Zampini       if (!localStageVisible[stage]) continue;
20889566063dSJacob Faibussowitsch       PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage));
20895c6c1daeSBarry Smith     }
20905c6c1daeSBarry Smith   }
20915c6c1daeSBarry Smith 
20929566063dSJacob Faibussowitsch   PetscCall(PetscFree(localStageUsed));
20939566063dSJacob Faibussowitsch   PetscCall(PetscFree(stageUsed));
20949566063dSJacob Faibussowitsch   PetscCall(PetscFree(localStageVisible));
20959566063dSJacob Faibussowitsch   PetscCall(PetscFree(stageVisible));
20965c6c1daeSBarry Smith 
20975c6c1daeSBarry Smith   /* Information unrelated to this particular run */
20989566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "========================================================================================================================\n"));
20993ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&y));
21003ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&x));
21013ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&y));
21023ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&y));
21033ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&y));
21043ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&y));
21053ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&y));
21063ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&y));
21073ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&y));
21083ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&y));
21093ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&y));
21103ba16761SJacob Faibussowitsch   PetscCall(PetscTime(&y));
21119566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Average time to get PetscTime(): %g\n", (y - x) / 10.0));
21125c6c1daeSBarry Smith   /* MPI information */
21135c6c1daeSBarry Smith   if (size > 1) {
21145c6c1daeSBarry Smith     MPI_Status  status;
21155c6c1daeSBarry Smith     PetscMPIInt tag;
21165c6c1daeSBarry Smith     MPI_Comm    newcomm;
21175c6c1daeSBarry Smith 
21189566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Barrier(comm));
21193ba16761SJacob Faibussowitsch     PetscCall(PetscTime(&x));
21209566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Barrier(comm));
21219566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Barrier(comm));
21229566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Barrier(comm));
21239566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Barrier(comm));
21249566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Barrier(comm));
21253ba16761SJacob Faibussowitsch     PetscCall(PetscTime(&y));
21269566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y - x) / 5.0));
21279566063dSJacob Faibussowitsch     PetscCall(PetscCommDuplicate(comm, &newcomm, &tag));
21289566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Barrier(comm));
21295c6c1daeSBarry Smith     if (rank) {
21309566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Recv(NULL, 0, MPI_INT, rank - 1, tag, newcomm, &status));
21319566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Send(NULL, 0, MPI_INT, (rank + 1) % size, tag, newcomm));
21325c6c1daeSBarry Smith     } else {
21333ba16761SJacob Faibussowitsch       PetscCall(PetscTime(&x));
21349566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Send(NULL, 0, MPI_INT, 1, tag, newcomm));
21359566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Recv(NULL, 0, MPI_INT, size - 1, tag, newcomm, &status));
21363ba16761SJacob Faibussowitsch       PetscCall(PetscTime(&y));
21379566063dSJacob Faibussowitsch       PetscCall(PetscFPrintf(comm, fd, "Average time for zero size MPI_Send(): %g\n", (y - x) / size));
21385c6c1daeSBarry Smith     }
21399566063dSJacob Faibussowitsch     PetscCall(PetscCommDestroy(&newcomm));
21405c6c1daeSBarry Smith   }
21419566063dSJacob Faibussowitsch   PetscCall(PetscOptionsView(NULL, viewer));
21425c6c1daeSBarry Smith 
21435c6c1daeSBarry Smith   /* Machine and compile information */
21445c6c1daeSBarry Smith   #if defined(PETSC_USE_FORTRAN_KERNELS)
21459566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n"));
21465c6c1daeSBarry Smith   #else
21479566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n"));
21485c6c1daeSBarry Smith   #endif
2149217044c2SLisandro Dalcin   #if defined(PETSC_USE_64BIT_INDICES)
2150*7de69702SBarry Smith   PetscCall(PetscFPrintf(comm, fd, "Compiled with 64-bit PetscInt\n"));
2151217044c2SLisandro Dalcin   #elif defined(PETSC_USE___FLOAT128)
2152*7de69702SBarry Smith   PetscCall(PetscFPrintf(comm, fd, "Compiled with 32-bit PetscInt\n"));
2153217044c2SLisandro Dalcin   #endif
21545c6c1daeSBarry Smith   #if defined(PETSC_USE_REAL_SINGLE)
21559566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n"));
21565f27b2e0SBarry Smith   #elif defined(PETSC_USE___FLOAT128)
21579566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n"));
21585c6c1daeSBarry Smith   #endif
21595c6c1daeSBarry Smith   #if defined(PETSC_USE_REAL_MAT_SINGLE)
21609566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Compiled with single precision matrices\n"));
21615c6c1daeSBarry Smith   #else
21629566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n"));
21635c6c1daeSBarry Smith   #endif
21649371c9d4SSatish Balay   PetscCall(PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n", (int)sizeof(short), (int)sizeof(int), (int)sizeof(long), (int)sizeof(void *), (int)sizeof(PetscScalar), (int)sizeof(PetscInt)));
21655c6c1daeSBarry Smith 
21669566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Configure options: %s", petscconfigureoptions));
21679566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "%s", petscmachineinfo));
21689566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "%s", petsccompilerinfo));
21699566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo));
21709566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "%s", petsclinkerinfo));
21715c6c1daeSBarry Smith 
21725c6c1daeSBarry Smith   /* Cleanup */
21739566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n"));
21749566063dSJacob Faibussowitsch   PetscCall(PetscLogViewWarnNoGpuAwareMpi(comm, fd));
21759566063dSJacob Faibussowitsch   PetscCall(PetscLogViewWarnDebugging(comm, fd));
2176156b51fbSBarry Smith   PetscCall(PetscFPTrapPop());
21773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21785c6c1daeSBarry Smith }
21795c6c1daeSBarry Smith 
21807d6c928cSSatish Balay /*@C
21817d6c928cSSatish Balay   PetscLogView - Prints a summary of the logging.
21825c6c1daeSBarry Smith 
21835c6c1daeSBarry Smith   Collective over MPI_Comm
21845c6c1daeSBarry Smith 
21855c6c1daeSBarry Smith   Input Parameter:
2186f14045dbSBarry Smith .  viewer - an ASCII viewer
21875c6c1daeSBarry Smith 
21885c6c1daeSBarry Smith   Options Database Keys:
2189bb1d7374SBarry Smith +  -log_view [:filename] - Prints summary of log information
2190bb1d7374SBarry Smith .  -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file
2191607d249eSBarry Smith .  -log_view :filename.xml:ascii_xml - Saves a summary of the logging information in a nested format (see below for how to view it)
2192d0a29bd7SConnor Ward .  -log_view :filename.txt:ascii_flamegraph - Saves logging information in a format suitable for visualising as a Flame Graph (see below for how to view it)
2193156b51fbSBarry Smith .  -log_view_memory - Also display memory usage in each event
2194156b51fbSBarry Smith .  -log_view_gpu_time - Also display time in each event for GPU kernels (Note this may slow the computation)
2195811af0c4SBarry Smith .  -log_all - Saves a file Log.rank for each MPI rank with details of each step of the computation
2196bb1d7374SBarry Smith -  -log_trace [filename] - Displays a trace of what each process is doing
21975c6c1daeSBarry Smith 
2198d1f92df0SBarry Smith   Level: beginner
2199d1f92df0SBarry Smith 
22005c6c1daeSBarry Smith   Notes:
2201da81f932SPierre Jolivet   It is possible to control the logging programmatically but we recommend using the options database approach whenever possible
22025c6c1daeSBarry Smith   By default the summary is printed to stdout.
22035c6c1daeSBarry Smith 
2204bb1d7374SBarry Smith   Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin()
2205bb1d7374SBarry Smith 
2206bb1d7374SBarry Smith   If PETSc is configured with --with-logging=0 then this functionality is not available
2207bb1d7374SBarry Smith 
2208607d249eSBarry Smith   To view the nested XML format filename.xml first copy  ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current
2209607d249eSBarry Smith   directory then open filename.xml with your browser. Specific notes for certain browsers
2210607d249eSBarry Smith $    Firefox and Internet explorer - simply open the file
2211607d249eSBarry Smith $    Google Chrome - you must start up Chrome with the option --allow-file-access-from-files
2212a8d69d7bSBarry Smith $    Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access
2213607d249eSBarry Smith   or one can use the package http://xmlsoft.org/XSLT/xsltproc2.html to translate the xml file to html and then open it with
2214607d249eSBarry Smith   your browser.
22152add09c0SLisandro Dalcin   Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser
22162add09c0SLisandro Dalcin   window and render the XML log file contents.
2217607d249eSBarry Smith 
2218bb1d7374SBarry Smith   The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij  MARITIME  RESEARCH  INSTITUTE  NETHERLANDS
2219bb1d7374SBarry Smith 
2220d0a29bd7SConnor Ward   The Flame Graph output can be visualised using either the original Flame Graph script (https://github.com/brendangregg/FlameGraph)
2221d0a29bd7SConnor Ward   or using speedscope (https://www.speedscope.app).
2222d0a29bd7SConnor Ward   Old XML profiles may be converted into this format using the script ${PETSC_DIR}/lib/petsc/bin/xml2flamegraph.py.
2223d0a29bd7SConnor Ward 
2224d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDefaultBegin()`, `PetscLogDump()`
22255c6c1daeSBarry Smith @*/
2226d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView(PetscViewer viewer)
2227d71ae5a4SJacob Faibussowitsch {
2228f14045dbSBarry Smith   PetscBool         isascii;
2229f14045dbSBarry Smith   PetscViewerFormat format;
223037b78d16SBarry Smith   int               stage, lastStage;
223137b78d16SBarry Smith   PetscStageLog     stageLog;
22325c6c1daeSBarry Smith 
22335c6c1daeSBarry Smith   PetscFunctionBegin;
223428b400f6SJacob Faibussowitsch   PetscCheck(PetscLogPLB, PETSC_COMM_SELF, PETSC_ERR_SUP, "Must use -log_view or PetscLogDefaultBegin() before calling this routine");
223537b78d16SBarry Smith   /* Pop off any stages the user forgot to remove */
223637b78d16SBarry Smith   lastStage = 0;
22379566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
22389566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
223937b78d16SBarry Smith   while (stage >= 0) {
224037b78d16SBarry Smith     lastStage = stage;
22419566063dSJacob Faibussowitsch     PetscCall(PetscStageLogPop(stageLog));
22429566063dSJacob Faibussowitsch     PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
224337b78d16SBarry Smith   }
22449566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isascii));
224528b400f6SJacob Faibussowitsch   PetscCheck(isascii, PetscObjectComm((PetscObject)viewer), PETSC_ERR_SUP, "Currently can only view logging to ASCII");
22469566063dSJacob Faibussowitsch   PetscCall(PetscViewerGetFormat(viewer, &format));
2247f14045dbSBarry Smith   if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) {
22489566063dSJacob Faibussowitsch     PetscCall(PetscLogView_Default(viewer));
2249f14045dbSBarry Smith   } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
22509566063dSJacob Faibussowitsch     PetscCall(PetscLogView_Detailed(viewer));
225138144912Sdeepblu2718   } else if (format == PETSC_VIEWER_ASCII_CSV) {
22529566063dSJacob Faibussowitsch     PetscCall(PetscLogView_CSV(viewer));
2253bb1d7374SBarry Smith   } else if (format == PETSC_VIEWER_ASCII_XML) {
22549566063dSJacob Faibussowitsch     PetscCall(PetscLogView_Nested(viewer));
2255d0a29bd7SConnor Ward   } else if (format == PETSC_VIEWER_ASCII_FLAMEGRAPH) {
22569566063dSJacob Faibussowitsch     PetscCall(PetscLogView_Flamegraph(viewer));
22575c6c1daeSBarry Smith   }
22589566063dSJacob Faibussowitsch   PetscCall(PetscStageLogPush(stageLog, lastStage));
22593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22605c6c1daeSBarry Smith }
22615c6c1daeSBarry Smith 
2262f14045dbSBarry Smith /*@C
2263811af0c4SBarry Smith   PetscLogViewFromOptions - Processes command line options to determine if/how a `PetscLog` is to be viewed.
2264f14045dbSBarry Smith 
2265811af0c4SBarry Smith   Collective on `PETSC_COMM_WORLD`
2266f14045dbSBarry Smith 
2267811af0c4SBarry Smith   Level: developer
2268f14045dbSBarry Smith 
2269d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogView()`
2270f14045dbSBarry Smith @*/
2271d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogViewFromOptions(void)
2272d71ae5a4SJacob Faibussowitsch {
2273f14045dbSBarry Smith   PetscViewer       viewer;
2274f14045dbSBarry Smith   PetscBool         flg;
2275f14045dbSBarry Smith   PetscViewerFormat format;
2276f14045dbSBarry Smith 
2277f14045dbSBarry Smith   PetscFunctionBegin;
22789566063dSJacob Faibussowitsch   PetscCall(PetscOptionsGetViewer(PETSC_COMM_WORLD, NULL, NULL, "-log_view", &viewer, &format, &flg));
2279f14045dbSBarry Smith   if (flg) {
22809566063dSJacob Faibussowitsch     PetscCall(PetscViewerPushFormat(viewer, format));
22819566063dSJacob Faibussowitsch     PetscCall(PetscLogView(viewer));
22829566063dSJacob Faibussowitsch     PetscCall(PetscViewerPopFormat(viewer));
22839566063dSJacob Faibussowitsch     PetscCall(PetscViewerDestroy(&viewer));
2284f14045dbSBarry Smith   }
22853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2286f14045dbSBarry Smith }
2287f14045dbSBarry Smith 
22885c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/
22895c6c1daeSBarry Smith /*@C
22905c6c1daeSBarry Smith    PetscGetFlops - Returns the number of flops used on this processor
22915c6c1daeSBarry Smith    since the program began.
22925c6c1daeSBarry Smith 
22935c6c1daeSBarry Smith    Not Collective
22945c6c1daeSBarry Smith 
22955c6c1daeSBarry Smith    Output Parameter:
22965c6c1daeSBarry Smith    flops - number of floating point operations
22975c6c1daeSBarry Smith 
2298d1f92df0SBarry Smith    Level: intermediate
2299d1f92df0SBarry Smith 
23005c6c1daeSBarry Smith    Notes:
23015c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
2302811af0c4SBarry Smith    `PetscLogFlops()` to increment this counter to include flops for the
23035c6c1daeSBarry Smith    application code.
23045c6c1daeSBarry Smith 
2305811af0c4SBarry Smith    A separate counter `PetscLogGPUFlops()` logs the flops that occur on any GPU associated with this MPI rank
2306811af0c4SBarry Smith 
2307d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogGPUFlops()`, `PetscTime()`, `PetscLogFlops()`
23085c6c1daeSBarry Smith @*/
2309d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscGetFlops(PetscLogDouble *flops)
2310d71ae5a4SJacob Faibussowitsch {
23115c6c1daeSBarry Smith   PetscFunctionBegin;
23125c6c1daeSBarry Smith   *flops = petsc_TotalFlops;
23133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23145c6c1daeSBarry Smith }
23155c6c1daeSBarry Smith 
2316d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...)
2317d71ae5a4SJacob Faibussowitsch {
23185c6c1daeSBarry Smith   size_t  fullLength;
23195c6c1daeSBarry Smith   va_list Argp;
23205c6c1daeSBarry Smith 
23215c6c1daeSBarry Smith   PetscFunctionBegin;
23223ba16761SJacob Faibussowitsch   if (!petsc_logObjects) PetscFunctionReturn(PETSC_SUCCESS);
23235c6c1daeSBarry Smith   va_start(Argp, format);
23249566063dSJacob Faibussowitsch   PetscCall(PetscVSNPrintf(petsc_objects[obj->id].info, 64, format, &fullLength, Argp));
23255c6c1daeSBarry Smith   va_end(Argp);
23263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23275c6c1daeSBarry Smith }
23285c6c1daeSBarry Smith 
23295c6c1daeSBarry Smith /*MC
23305c6c1daeSBarry Smith    PetscLogFlops - Adds floating point operations to the global counter.
23315c6c1daeSBarry Smith 
23325c6c1daeSBarry Smith    Synopsis:
2333aaa7dc30SBarry Smith    #include <petsclog.h>
23345c6c1daeSBarry Smith    PetscErrorCode PetscLogFlops(PetscLogDouble f)
23355c6c1daeSBarry Smith 
23365c6c1daeSBarry Smith    Not Collective
23375c6c1daeSBarry Smith 
23385c6c1daeSBarry Smith    Input Parameter:
23395c6c1daeSBarry Smith .  f - flop counter
23405c6c1daeSBarry Smith 
23415c6c1daeSBarry Smith    Usage:
23425c6c1daeSBarry Smith .vb
23435c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
23445c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
23455c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
23465c6c1daeSBarry Smith         [code segment to monitor]
23475c6c1daeSBarry Smith         PetscLogFlops(user_flops)
23485c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
23495c6c1daeSBarry Smith .ve
23505c6c1daeSBarry Smith 
2351d1f92df0SBarry Smith    Level: intermediate
2352d1f92df0SBarry Smith 
2353811af0c4SBarry Smith    Note:
23545c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
23555c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
23565c6c1daeSBarry Smith    application code.
23575c6c1daeSBarry Smith 
2358d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogGPUFlops()`, `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscGetFlops()`
23595c6c1daeSBarry Smith M*/
23605c6c1daeSBarry Smith 
23615c6c1daeSBarry Smith /*MC
23625c6c1daeSBarry Smith    PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice)
23635c6c1daeSBarry Smith     to get accurate timings
23645c6c1daeSBarry Smith 
23655c6c1daeSBarry Smith    Synopsis:
2366aaa7dc30SBarry Smith    #include <petsclog.h>
23675c6c1daeSBarry Smith    void PetscPreLoadBegin(PetscBool  flag,char *name);
23685c6c1daeSBarry Smith 
23695c6c1daeSBarry Smith    Not Collective
23705c6c1daeSBarry Smith 
2371d8d19677SJose E. Roman    Input Parameters:
23722fe279fdSBarry Smith +   flag - `PETSC_TRUE` to run twice, `PETSC_FALSE` to run once, may be overridden
23735c6c1daeSBarry Smith            with command line option -preload true or -preload false
23742fe279fdSBarry Smith -   name - name of first stage (lines of code timed separately with `-log_view`) to
23755c6c1daeSBarry Smith            be preloaded
23765c6c1daeSBarry Smith 
23775c6c1daeSBarry Smith    Usage:
23785c6c1daeSBarry Smith .vb
23795c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
23805c6c1daeSBarry Smith        lines of code
23815c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
23825c6c1daeSBarry Smith        lines of code
23835c6c1daeSBarry Smith      PetscPreLoadEnd();
23845c6c1daeSBarry Smith .ve
23855c6c1daeSBarry Smith 
2386d1f92df0SBarry Smith    Level: intermediate
2387d1f92df0SBarry Smith 
2388811af0c4SBarry Smith    Note:
238995452b02SPatrick Sanan     Only works in C/C++, not Fortran
23905c6c1daeSBarry Smith 
23915c6c1daeSBarry Smith      Flags available within the macro.
23925c6c1daeSBarry Smith +    PetscPreLoadingUsed - true if we are or have done preloading
23935c6c1daeSBarry Smith .    PetscPreLoadingOn - true if it is CURRENTLY doing preload
23945c6c1daeSBarry Smith .    PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second
23955c6c1daeSBarry Smith -    PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on
23962fe279fdSBarry Smith      The first two variables are available throughout the program, the second two only between the `PetscPreLoadBegin()`
23972fe279fdSBarry Smith      and `PetscPreLoadEnd()`
23985c6c1daeSBarry Smith 
2399d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()`
24005c6c1daeSBarry Smith M*/
24015c6c1daeSBarry Smith 
24025c6c1daeSBarry Smith /*MC
24035c6c1daeSBarry Smith    PetscPreLoadEnd - End a segment of code that may be preloaded (run twice)
24045c6c1daeSBarry Smith     to get accurate timings
24055c6c1daeSBarry Smith 
24065c6c1daeSBarry Smith    Synopsis:
2407aaa7dc30SBarry Smith    #include <petsclog.h>
24085c6c1daeSBarry Smith    void PetscPreLoadEnd(void);
24095c6c1daeSBarry Smith 
24105c6c1daeSBarry Smith    Not Collective
24115c6c1daeSBarry Smith 
24125c6c1daeSBarry Smith    Usage:
24135c6c1daeSBarry Smith .vb
24145c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
24155c6c1daeSBarry Smith        lines of code
24165c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
24175c6c1daeSBarry Smith        lines of code
24185c6c1daeSBarry Smith      PetscPreLoadEnd();
24195c6c1daeSBarry Smith .ve
24205c6c1daeSBarry Smith 
2421d1f92df0SBarry Smith    Level: intermediate
2422d1f92df0SBarry Smith 
2423811af0c4SBarry Smith    Note:
2424811af0c4SBarry Smith     Only works in C/C++ not fortran
24255c6c1daeSBarry Smith 
2426d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadStage()`
24275c6c1daeSBarry Smith M*/
24285c6c1daeSBarry Smith 
24295c6c1daeSBarry Smith /*MC
24305c6c1daeSBarry Smith    PetscPreLoadStage - Start a new segment of code to be timed separately.
24315c6c1daeSBarry Smith     to get accurate timings
24325c6c1daeSBarry Smith 
24335c6c1daeSBarry Smith    Synopsis:
2434aaa7dc30SBarry Smith    #include <petsclog.h>
24355c6c1daeSBarry Smith    void PetscPreLoadStage(char *name);
24365c6c1daeSBarry Smith 
24375c6c1daeSBarry Smith    Not Collective
24385c6c1daeSBarry Smith 
24395c6c1daeSBarry Smith    Usage:
24405c6c1daeSBarry Smith .vb
24415c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
24425c6c1daeSBarry Smith        lines of code
24435c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
24445c6c1daeSBarry Smith        lines of code
24455c6c1daeSBarry Smith      PetscPreLoadEnd();
24465c6c1daeSBarry Smith .ve
24475c6c1daeSBarry Smith 
2448d1f92df0SBarry Smith    Level: intermediate
2449d1f92df0SBarry Smith 
2450811af0c4SBarry Smith    Note:
2451811af0c4SBarry Smith     Only works in C/C++ not fortran
24525c6c1daeSBarry Smith 
2453d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`
24545c6c1daeSBarry Smith M*/
24555c6c1daeSBarry Smith 
2456a4af0ceeSJacob Faibussowitsch   #if PetscDefined(HAVE_DEVICE)
2457a4af0ceeSJacob Faibussowitsch     #include <petsc/private/deviceimpl.h>
24589ffd0706SHong Zhang 
2459156b51fbSBarry Smith PetscBool PetscLogGpuTimeFlag = PETSC_FALSE;
2460156b51fbSBarry Smith 
2461156b51fbSBarry Smith /*
2462156b51fbSBarry Smith    This cannot be called by users between PetscInitialize() and PetscFinalize() at any random location in the code
2463156b51fbSBarry Smith    because it will result in timing results that cannot be interpreted.
2464156b51fbSBarry Smith */
2465d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogGpuTime_Off(void)
2466d71ae5a4SJacob Faibussowitsch {
2467156b51fbSBarry Smith   PetscLogGpuTimeFlag = PETSC_FALSE;
24683ba16761SJacob Faibussowitsch   return PETSC_SUCCESS;
2469156b51fbSBarry Smith }
2470156b51fbSBarry Smith 
2471156b51fbSBarry Smith /*@C
2472156b51fbSBarry Smith      PetscLogGpuTime - turn on the logging of GPU time for GPU kernels
2473156b51fbSBarry Smith 
2474811af0c4SBarry Smith   Options Database Key:
2475156b51fbSBarry Smith .   -log_view_gpu_time - provide the GPU times in the -log_view output
2476156b51fbSBarry Smith 
2477d1f92df0SBarry Smith    Level: advanced
2478d1f92df0SBarry Smith 
2479156b51fbSBarry Smith   Notes:
2480811af0c4SBarry Smith     Turning on the timing of the
2481156b51fbSBarry Smith     GPU kernels can slow down the entire computation and should only be used when studying the performance
2482156b51fbSBarry Smith     of operations on GPU such as vector operations and matrix-vector operations.
2483156b51fbSBarry Smith 
2484156b51fbSBarry Smith     This routine should only be called once near the beginning of the program. Once it is started it cannot be turned off.
2485156b51fbSBarry Smith 
2486d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuTimeBegin()`
2487156b51fbSBarry Smith @*/
2488d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGpuTime(void)
2489d71ae5a4SJacob Faibussowitsch {
2490156b51fbSBarry Smith   if (!PetscLogGpuTimeFlag) PetscCall(PetscRegisterFinalize(PetscLogGpuTime_Off));
2491156b51fbSBarry Smith   PetscLogGpuTimeFlag = PETSC_TRUE;
24923ba16761SJacob Faibussowitsch   return PETSC_SUCCESS;
2493156b51fbSBarry Smith }
2494156b51fbSBarry Smith 
24959ffd0706SHong Zhang /*@C
24969ffd0706SHong Zhang   PetscLogGpuTimeBegin - Start timer for device
24979ffd0706SHong Zhang 
2498d1f92df0SBarry Smith   Level: intermediate
2499d1f92df0SBarry Smith 
25009ffd0706SHong Zhang   Notes:
25019ffd0706SHong Zhang     When CUDA or HIP is enabled, the timer is run on the GPU, it is a separate logging of time devoted to GPU computations (excluding kernel launch times).
2502811af0c4SBarry Smith 
25039ffd0706SHong Zhang     When CUDA or HIP is not available, the timer is run on the CPU, it is a separate logging of time devoted to GPU computations (including kernel launch times).
2504811af0c4SBarry Smith 
2505811af0c4SBarry Smith     There is no need to call WaitForCUDA() or WaitForHIP() between `PetscLogGpuTimeBegin()` and `PetscLogGpuTimeEnd()`
2506811af0c4SBarry Smith 
25079ffd0706SHong Zhang     This timer should NOT include times for data transfers between the GPU and CPU, nor setup actions such as allocating space.
2508811af0c4SBarry Smith 
2509da81f932SPierre Jolivet     The regular logging captures the time for data transfers and any CPU activities during the event
2510811af0c4SBarry Smith 
25119ffd0706SHong Zhang     It is used to compute the flop rate on the GPU as it is actively engaged in running a kernel.
25129ffd0706SHong Zhang 
25139ffd0706SHong Zhang   Developer Notes:
2514811af0c4SBarry Smith     The GPU event timer captures the execution time of all the kernels launched in the default stream by the CPU between `PetscLogGpuTimeBegin()` and `PetsLogGpuTimeEnd()`.
2515811af0c4SBarry Smith 
2516811af0c4SBarry Smith     `PetscLogGpuTimeBegin()` and `PetsLogGpuTimeEnd()` insert the begin and end events into the default stream (stream 0). The device will record a time stamp for the
2517811af0c4SBarry Smith     event when it reaches that event in the stream. The function xxxEventSynchronize() is called in `PetsLogGpuTimeEnd()` to block CPU execution,
2518da81f932SPierre Jolivet     but not continued GPU execution, until the timer event is recorded.
25199ffd0706SHong Zhang 
2520d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuTime()`
25219ffd0706SHong Zhang @*/
2522d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGpuTimeBegin(void)
2523d71ae5a4SJacob Faibussowitsch {
25249ffd0706SHong Zhang   PetscFunctionBegin;
25253ba16761SJacob Faibussowitsch   if (!PetscLogPLB || !PetscLogGpuTimeFlag) PetscFunctionReturn(PETSC_SUCCESS);
2526a4af0ceeSJacob Faibussowitsch   if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) {
2527a4af0ceeSJacob Faibussowitsch     PetscDeviceContext dctx;
2528a4af0ceeSJacob Faibussowitsch 
25299566063dSJacob Faibussowitsch     PetscCall(PetscDeviceContextGetCurrentContext(&dctx));
25309566063dSJacob Faibussowitsch     PetscCall(PetscDeviceContextBeginTimer_Internal(dctx));
2531a4af0ceeSJacob Faibussowitsch   } else {
25329566063dSJacob Faibussowitsch     PetscCall(PetscTimeSubtract(&petsc_gtime));
2533a4af0ceeSJacob Faibussowitsch   }
25343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
25359ffd0706SHong Zhang }
25369ffd0706SHong Zhang 
25379ffd0706SHong Zhang /*@C
25389ffd0706SHong Zhang   PetscLogGpuTimeEnd - Stop timer for device
25399ffd0706SHong Zhang 
25409ffd0706SHong Zhang   Level: intermediate
25419ffd0706SHong Zhang 
2542d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeBegin()`
25439ffd0706SHong Zhang @*/
2544d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGpuTimeEnd(void)
2545d71ae5a4SJacob Faibussowitsch {
25469ffd0706SHong Zhang   PetscFunctionBegin;
25473ba16761SJacob Faibussowitsch   if (!PetscLogPLE || !PetscLogGpuTimeFlag) PetscFunctionReturn(PETSC_SUCCESS);
2548a4af0ceeSJacob Faibussowitsch   if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) {
2549a4af0ceeSJacob Faibussowitsch     PetscDeviceContext dctx;
2550a4af0ceeSJacob Faibussowitsch     PetscLogDouble     elapsed;
2551a4af0ceeSJacob Faibussowitsch 
25529566063dSJacob Faibussowitsch     PetscCall(PetscDeviceContextGetCurrentContext(&dctx));
25539566063dSJacob Faibussowitsch     PetscCall(PetscDeviceContextEndTimer_Internal(dctx, &elapsed));
2554a4af0ceeSJacob Faibussowitsch     petsc_gtime += (elapsed / 1000.0);
2555a4af0ceeSJacob Faibussowitsch   } else {
25569566063dSJacob Faibussowitsch     PetscCall(PetscTimeAdd(&petsc_gtime));
2557a4af0ceeSJacob Faibussowitsch   }
25583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
25599ffd0706SHong Zhang }
2560c708d6e3SStefano Zampini 
25619ffd0706SHong Zhang   #endif /* end of PETSC_HAVE_DEVICE */
25629ffd0706SHong Zhang 
25635c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */
25645c6c1daeSBarry Smith 
2565d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...)
2566d71ae5a4SJacob Faibussowitsch {
25675c6c1daeSBarry Smith   PetscFunctionBegin;
25683ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
25695c6c1daeSBarry Smith }
25705c6c1daeSBarry Smith 
25715c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/
25725c6c1daeSBarry Smith 
25735c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID;
25745c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID  = 0;
25755c6c1daeSBarry Smith 
25765c6c1daeSBarry Smith /*@C
25775c6c1daeSBarry Smith   PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code.
25785c6c1daeSBarry Smith 
25795c6c1daeSBarry Smith   Not Collective
25805c6c1daeSBarry Smith 
25815c6c1daeSBarry Smith   Input Parameter:
25825c6c1daeSBarry Smith . name   - The class name
25835c6c1daeSBarry Smith 
25845c6c1daeSBarry Smith   Output Parameter:
25855c6c1daeSBarry Smith . oclass - The class id or classid
25865c6c1daeSBarry Smith 
25875c6c1daeSBarry Smith   Level: developer
25885c6c1daeSBarry Smith 
2589d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()`
25905c6c1daeSBarry Smith @*/
2591d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscClassIdRegister(const char name[], PetscClassId *oclass)
2592d71ae5a4SJacob Faibussowitsch {
25935c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
25945c6c1daeSBarry Smith   PetscStageLog stageLog;
25955c6c1daeSBarry Smith   PetscInt      stage;
25965c6c1daeSBarry Smith #endif
25975c6c1daeSBarry Smith 
25985c6c1daeSBarry Smith   PetscFunctionBegin;
25995c6c1daeSBarry Smith   *oclass = ++PETSC_LARGEST_CLASSID;
26005c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
26019566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
26029566063dSJacob Faibussowitsch   PetscCall(PetscClassRegLogRegister(stageLog->classLog, name, *oclass));
260348a46eb9SPierre Jolivet   for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses));
26045c6c1daeSBarry Smith #endif
26053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
26065c6c1daeSBarry Smith }
2607210b5426SBarry Smith 
2608210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE)
2609210b5426SBarry Smith   #include <mpe.h>
2610210b5426SBarry Smith 
2611210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE;
2612210b5426SBarry Smith 
2613495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject);
2614495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject);
2615495fc317SBarry Smith 
2616210b5426SBarry Smith /*@C
2617210b5426SBarry Smith    PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files
2618210b5426SBarry Smith    and slows the program down.
2619210b5426SBarry Smith 
2620811af0c4SBarry Smith    Collective over `PETSC_COMM_WORLD`
2621210b5426SBarry Smith 
2622811af0c4SBarry Smith    Options Database Key:
2623a2553e36SBarry Smith . -log_mpe - Prints extensive log information
2624210b5426SBarry Smith 
2625d1f92df0SBarry Smith    Level: advanced
2626d1f92df0SBarry Smith 
2627811af0c4SBarry Smith    Note:
2628811af0c4SBarry Smith    A related routine is `PetscLogDefaultBegin()` (with the options key -log_view), which is
2629210b5426SBarry Smith    intended for production runs since it logs only flop rates and object
2630210b5426SBarry Smith    creation (and should not significantly slow the programs).
2631210b5426SBarry Smith 
2632d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogEventActivate()`,
2633db781477SPatrick Sanan           `PetscLogEventDeactivate()`
2634210b5426SBarry Smith @*/
2635d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogMPEBegin(void)
2636d71ae5a4SJacob Faibussowitsch {
2637210b5426SBarry Smith   PetscFunctionBegin;
2638210b5426SBarry Smith   /* Do MPE initialization */
2639210b5426SBarry Smith   if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */
26409566063dSJacob Faibussowitsch     PetscCall(PetscInfo(0, "Initializing MPE.\n"));
26419566063dSJacob Faibussowitsch     PetscCall(MPE_Init_log());
2642210b5426SBarry Smith 
2643210b5426SBarry Smith     PetscBeganMPE = PETSC_TRUE;
2644210b5426SBarry Smith   } else {
26459566063dSJacob Faibussowitsch     PetscCall(PetscInfo(0, "MPE already initialized. Not attempting to reinitialize.\n"));
2646210b5426SBarry Smith   }
26479566063dSJacob Faibussowitsch   PetscCall(PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE));
26483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2649210b5426SBarry Smith }
2650210b5426SBarry Smith 
2651210b5426SBarry Smith /*@C
2652495fc317SBarry Smith    PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot.
2653210b5426SBarry Smith 
2654811af0c4SBarry Smith    Collective over `PETSC_COMM_WORLD`
2655210b5426SBarry Smith 
2656210b5426SBarry Smith    Level: advanced
2657210b5426SBarry Smith 
2658d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogMPEBegin()`
2659210b5426SBarry Smith @*/
2660d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogMPEDump(const char sname[])
2661d71ae5a4SJacob Faibussowitsch {
2662210b5426SBarry Smith   char name[PETSC_MAX_PATH_LEN];
2663210b5426SBarry Smith 
2664210b5426SBarry Smith   PetscFunctionBegin;
2665210b5426SBarry Smith   if (PetscBeganMPE) {
26669566063dSJacob Faibussowitsch     PetscCall(PetscInfo(0, "Finalizing MPE.\n"));
2667210b5426SBarry Smith     if (sname) {
2668c6a7a370SJeremy L Thompson       PetscCall(PetscStrncpy(name, sname, sizeof(name)));
2669210b5426SBarry Smith     } else {
26709566063dSJacob Faibussowitsch       PetscCall(PetscGetProgramName(name, sizeof(name)));
2671210b5426SBarry Smith     }
26729566063dSJacob Faibussowitsch     PetscCall(MPE_Finish_log(name));
2673210b5426SBarry Smith   } else {
26749566063dSJacob Faibussowitsch     PetscCall(PetscInfo(0, "Not finalizing MPE (not started by PETSc).\n"));
2675210b5426SBarry Smith   }
26763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2677210b5426SBarry Smith }
2678210b5426SBarry Smith 
2679210b5426SBarry Smith   #define PETSC_RGB_COLORS_MAX 39
26809371c9d4SSatish Balay static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = {"OliveDrab:      ", "BlueViolet:     ", "CadetBlue:      ", "CornflowerBlue: ", "DarkGoldenrod:  ", "DarkGreen:      ", "DarkKhaki:      ", "DarkOliveGreen: ",
26819371c9d4SSatish Balay                                                                  "DarkOrange:     ", "DarkOrchid:     ", "DarkSeaGreen:   ", "DarkSlateGray:  ", "DarkTurquoise:  ", "DeepPink:       ", "DarkKhaki:      ", "DimGray:        ",
26829371c9d4SSatish Balay                                                                  "DodgerBlue:     ", "GreenYellow:    ", "HotPink:        ", "IndianRed:      ", "LavenderBlush:  ", "LawnGreen:      ", "LemonChiffon:   ", "LightCoral:     ",
26839371c9d4SSatish Balay                                                                  "LightCyan:      ", "LightPink:      ", "LightSalmon:    ", "LightSlateGray: ", "LightYellow:    ", "LimeGreen:      ", "MediumPurple:   ", "MediumSeaGreen: ",
26849371c9d4SSatish Balay                                                                  "MediumSlateBlue:", "MidnightBlue:   ", "MintCream:      ", "MistyRose:      ", "NavajoWhite:    ", "NavyBlue:       ", "OliveDrab:      "};
2685210b5426SBarry Smith 
2686210b5426SBarry Smith /*@C
2687811af0c4SBarry Smith   PetscLogMPEGetRGBColor - This routine returns a rgb color useable with `PetscLogEventRegister()`
2688210b5426SBarry Smith 
2689210b5426SBarry Smith   Not collective. Maybe it should be?
2690210b5426SBarry Smith 
26917a7aea1fSJed Brown   Output Parameter:
2692210b5426SBarry Smith . str - character string representing the color
2693210b5426SBarry Smith 
2694210b5426SBarry Smith   Level: developer
2695210b5426SBarry Smith 
2696d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()`
2697210b5426SBarry Smith @*/
2698d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogMPEGetRGBColor(const char *str[])
2699d71ae5a4SJacob Faibussowitsch {
2700210b5426SBarry Smith   static int idx = 0;
2701210b5426SBarry Smith 
2702210b5426SBarry Smith   PetscFunctionBegin;
2703210b5426SBarry Smith   *str = PetscLogMPERGBColors[idx];
2704210b5426SBarry Smith   idx  = (idx + 1) % PETSC_RGB_COLORS_MAX;
27053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2706210b5426SBarry Smith }
2707210b5426SBarry Smith 
2708210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */
2709