xref: /petsc/src/sys/logging/plog.c (revision 48a46eb9bd028bec07ec0f396b1a3abb43f14558)
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>
145c6c1daeSBarry Smith 
154851f57dSBarry Smith /* this is not consistently used and is difficult to keep correct if done manually, possibly it should be removed */
169371c9d4SSatish Balay PetscErrorCode PetscLogObjectParent(PetscObject p, PetscObject c) {
1727b6d19dSBarry Smith   if (!c || !p) return 0;
183bb1ff40SBarry Smith   c->parent   = p;
193bb1ff40SBarry Smith   c->parentid = p->id;
203bb1ff40SBarry Smith   return 0;
213bb1ff40SBarry Smith }
223bb1ff40SBarry Smith 
23bb72fc59SBarry Smith /*@C
24bb72fc59SBarry Smith    PetscLogObjectMemory - Adds to an object a count of additional amount of memory that is used by the object.
25bb72fc59SBarry Smith 
26bb72fc59SBarry Smith    Not collective.
27bb72fc59SBarry Smith 
28bb72fc59SBarry Smith    Input Parameters:
29bb72fc59SBarry Smith +  obj  - the PETSc object
30bb72fc59SBarry Smith -  mem  - the amount of memory that is being added to the object
31bb72fc59SBarry Smith 
32bb72fc59SBarry Smith    Level: developer
33bb72fc59SBarry Smith 
3495452b02SPatrick Sanan    Developer Notes:
354851f57dSBarry Smith    This is not used consistently. It is very difficult to manually track the memory usage per object so this should
364851f57dSBarry Smith    likely be removed and replaced with an automated system.
37bb72fc59SBarry Smith 
38db781477SPatrick Sanan .seealso: `PetscFinalize()`, `PetscInitializeFortran()`, `PetscGetArgs()`, `PetscInitializeNoArguments()`
39bb72fc59SBarry Smith 
40bb72fc59SBarry Smith @*/
419371c9d4SSatish Balay PetscErrorCode PetscLogObjectMemory(PetscObject p, PetscLogDouble m) {
42d12f57a0SLisandro Dalcin   if (!p) return 0;
4327b6d19dSBarry Smith   p->mem += m;
443bb1ff40SBarry Smith   return 0;
453bb1ff40SBarry Smith }
463bb1ff40SBarry Smith 
475c6c1daeSBarry Smith PetscLogEvent PETSC_LARGEST_EVENT = PETSC_EVENT;
485c6c1daeSBarry Smith 
495c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
505c6c1daeSBarry Smith #include <petscmachineinfo.h>
515c6c1daeSBarry Smith #include <petscconfiginfo.h>
525c6c1daeSBarry Smith 
535c6c1daeSBarry Smith /* used in the MPI_XXX() count macros in petsclog.h */
545c6c1daeSBarry Smith 
555c6c1daeSBarry Smith /* Action and object logging variables */
560298fd71SBarry Smith Action   *petsc_actions    = NULL;
570298fd71SBarry Smith Object   *petsc_objects    = NULL;
585c6c1daeSBarry Smith PetscBool petsc_logActions = PETSC_FALSE;
595c6c1daeSBarry Smith PetscBool petsc_logObjects = PETSC_FALSE;
605c6c1daeSBarry Smith int       petsc_numActions = 0, petsc_maxActions = 100;
615c6c1daeSBarry Smith int       petsc_numObjects = 0, petsc_maxObjects = 100;
625c6c1daeSBarry Smith int       petsc_numObjectsDestroyed = 0;
635c6c1daeSBarry Smith 
645c6c1daeSBarry Smith /* Global counters */
655c6c1daeSBarry Smith PetscLogDouble petsc_BaseTime        = 0.0;
665c6c1daeSBarry Smith PetscLogDouble petsc_TotalFlops      = 0.0; /* The number of flops */
675c6c1daeSBarry Smith PetscLogDouble petsc_tmp_flops       = 0.0; /* The incremental number of flops */
685c6c1daeSBarry Smith PetscLogDouble petsc_send_ct         = 0.0; /* The number of sends */
695c6c1daeSBarry Smith PetscLogDouble petsc_recv_ct         = 0.0; /* The number of receives */
705c6c1daeSBarry Smith PetscLogDouble petsc_send_len        = 0.0; /* The total length of all sent messages */
715c6c1daeSBarry Smith PetscLogDouble petsc_recv_len        = 0.0; /* The total length of all received messages */
725c6c1daeSBarry Smith PetscLogDouble petsc_isend_ct        = 0.0; /* The number of immediate sends */
735c6c1daeSBarry Smith PetscLogDouble petsc_irecv_ct        = 0.0; /* The number of immediate receives */
745c6c1daeSBarry Smith PetscLogDouble petsc_isend_len       = 0.0; /* The total length of all immediate send messages */
755c6c1daeSBarry Smith PetscLogDouble petsc_irecv_len       = 0.0; /* The total length of all immediate receive messages */
765c6c1daeSBarry Smith PetscLogDouble petsc_wait_ct         = 0.0; /* The number of waits */
775c6c1daeSBarry Smith PetscLogDouble petsc_wait_any_ct     = 0.0; /* The number of anywaits */
785c6c1daeSBarry Smith PetscLogDouble petsc_wait_all_ct     = 0.0; /* The number of waitalls */
795c6c1daeSBarry Smith PetscLogDouble petsc_sum_of_waits_ct = 0.0; /* The total number of waits */
805c6c1daeSBarry Smith PetscLogDouble petsc_allreduce_ct    = 0.0; /* The number of reductions */
815c6c1daeSBarry Smith PetscLogDouble petsc_gather_ct       = 0.0; /* The number of gathers and gathervs */
825c6c1daeSBarry Smith PetscLogDouble petsc_scatter_ct      = 0.0; /* The number of scatters and scattervs */
8320c24465SJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
84bec0b493Shannah_mairs PetscLogDouble petsc_ctog_ct        = 0.0; /* The total number of CPU to GPU copies */
85bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_ct        = 0.0; /* The total number of GPU to CPU copies */
86bec0b493Shannah_mairs PetscLogDouble petsc_ctog_sz        = 0.0; /* The total size of CPU to GPU copies */
87bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_sz        = 0.0; /* The total size of GPU to CPU copies */
8845c4b7c1SBarry Smith PetscLogDouble petsc_ctog_ct_scalar = 0.0; /* The total number of CPU to GPU copies */
8945c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_ct_scalar = 0.0; /* The total number of GPU to CPU copies */
9045c4b7c1SBarry Smith PetscLogDouble petsc_ctog_sz_scalar = 0.0; /* The total size of CPU to GPU copies */
9145c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_sz_scalar = 0.0; /* The total size of GPU to CPU copies */
92958c4211Shannah_mairs PetscLogDouble petsc_gflops         = 0.0; /* The flops done on a GPU */
93958c4211Shannah_mairs PetscLogDouble petsc_gtime          = 0.0; /* The time spent on a GPU */
94bec0b493Shannah_mairs #endif
955c6c1daeSBarry Smith 
965c6c1daeSBarry Smith /* Logging functions */
970298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject)                                                            = NULL;
980298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject)                                                            = NULL;
990298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL;
1000298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL;
1015c6c1daeSBarry Smith 
1025c6c1daeSBarry Smith /* Tracing event logging variables */
1030298fd71SBarry Smith FILE            *petsc_tracefile          = NULL;
1045c6c1daeSBarry Smith int              petsc_tracelevel         = 0;
1055c6c1daeSBarry Smith const char      *petsc_traceblanks        = "                                                                                                    ";
1065c6c1daeSBarry Smith char             petsc_tracespace[128]    = " ";
1075c6c1daeSBarry Smith PetscLogDouble   petsc_tracetime          = 0.0;
108896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE;
1095c6c1daeSBarry Smith 
1107a101e5eSJacob Faibussowitsch static PetscIntStack current_log_event_stack = NULL;
1117a101e5eSJacob Faibussowitsch 
1129371c9d4SSatish Balay PETSC_INTERN PetscErrorCode PetscLogInitialize(void) {
113fa2bb9feSLisandro Dalcin   int       stage;
114fa2bb9feSLisandro Dalcin   PetscBool opt;
1155c6c1daeSBarry Smith 
116fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
117fa2bb9feSLisandro Dalcin   if (PetscLogInitializeCalled) PetscFunctionReturn(0);
118fa2bb9feSLisandro Dalcin   PetscLogInitializeCalled = PETSC_TRUE;
1195c6c1daeSBarry Smith 
1207a101e5eSJacob Faibussowitsch   PetscCall(PetscIntStackCreate(&current_log_event_stack));
1219566063dSJacob Faibussowitsch   PetscCall(PetscOptionsHasName(NULL, NULL, "-log_exclude_actions", &opt));
122fa2bb9feSLisandro Dalcin   if (opt) petsc_logActions = PETSC_FALSE;
1239566063dSJacob Faibussowitsch   PetscCall(PetscOptionsHasName(NULL, NULL, "-log_exclude_objects", &opt));
124fa2bb9feSLisandro Dalcin   if (opt) petsc_logObjects = PETSC_FALSE;
125*48a46eb9SPierre Jolivet   if (petsc_logActions) PetscCall(PetscMalloc1(petsc_maxActions, &petsc_actions));
126*48a46eb9SPierre Jolivet   if (petsc_logObjects) PetscCall(PetscMalloc1(petsc_maxObjects, &petsc_objects));
127fa2bb9feSLisandro Dalcin   PetscLogPHC = PetscLogObjCreateDefault;
128fa2bb9feSLisandro Dalcin   PetscLogPHD = PetscLogObjDestroyDefault;
129fa2bb9feSLisandro Dalcin   /* Setup default logging structures */
1309566063dSJacob Faibussowitsch   PetscCall(PetscStageLogCreate(&petsc_stageLog));
1319566063dSJacob Faibussowitsch   PetscCall(PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage));
1325c6c1daeSBarry Smith 
133fa2bb9feSLisandro Dalcin   /* All processors sync here for more consistent logging */
1349566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Barrier(PETSC_COMM_WORLD));
135fa2bb9feSLisandro Dalcin   PetscTime(&petsc_BaseTime);
1369566063dSJacob Faibussowitsch   PetscCall(PetscLogStagePush(stage));
137fa2bb9feSLisandro Dalcin   PetscFunctionReturn(0);
138fa2bb9feSLisandro Dalcin }
1395c6c1daeSBarry Smith 
1409371c9d4SSatish Balay PETSC_INTERN PetscErrorCode PetscLogFinalize(void) {
1415c6c1daeSBarry Smith   PetscStageLog stageLog;
1425c6c1daeSBarry Smith 
1435c6c1daeSBarry Smith   PetscFunctionBegin;
1449566063dSJacob Faibussowitsch   PetscCall(PetscFree(petsc_actions));
1459566063dSJacob Faibussowitsch   PetscCall(PetscFree(petsc_objects));
1469566063dSJacob Faibussowitsch   PetscCall(PetscLogNestedEnd());
1479566063dSJacob Faibussowitsch   PetscCall(PetscLogSet(NULL, NULL));
1485c6c1daeSBarry Smith 
1495c6c1daeSBarry Smith   /* Resetting phase */
1509566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
1519566063dSJacob Faibussowitsch   PetscCall(PetscStageLogDestroy(stageLog));
1527a101e5eSJacob Faibussowitsch   PetscCall(PetscIntStackDestroy(current_log_event_stack));
1537a101e5eSJacob Faibussowitsch   current_log_event_stack = NULL;
154a297a907SKarl Rupp 
1555c6c1daeSBarry Smith   petsc_TotalFlops          = 0.0;
1565c6c1daeSBarry Smith   petsc_numActions          = 0;
1575c6c1daeSBarry Smith   petsc_numObjects          = 0;
1585c6c1daeSBarry Smith   petsc_numObjectsDestroyed = 0;
1595c6c1daeSBarry Smith   petsc_maxActions          = 100;
1605c6c1daeSBarry Smith   petsc_maxObjects          = 100;
1610298fd71SBarry Smith   petsc_actions             = NULL;
1620298fd71SBarry Smith   petsc_objects             = NULL;
1635c6c1daeSBarry Smith   petsc_logActions          = PETSC_FALSE;
1645c6c1daeSBarry Smith   petsc_logObjects          = PETSC_FALSE;
1655c6c1daeSBarry Smith   petsc_BaseTime            = 0.0;
1665c6c1daeSBarry Smith   petsc_TotalFlops          = 0.0;
1675c6c1daeSBarry Smith   petsc_tmp_flops           = 0.0;
1685c6c1daeSBarry Smith   petsc_send_ct             = 0.0;
1695c6c1daeSBarry Smith   petsc_recv_ct             = 0.0;
1705c6c1daeSBarry Smith   petsc_send_len            = 0.0;
1715c6c1daeSBarry Smith   petsc_recv_len            = 0.0;
1725c6c1daeSBarry Smith   petsc_isend_ct            = 0.0;
1735c6c1daeSBarry Smith   petsc_irecv_ct            = 0.0;
1745c6c1daeSBarry Smith   petsc_isend_len           = 0.0;
1755c6c1daeSBarry Smith   petsc_irecv_len           = 0.0;
1765c6c1daeSBarry Smith   petsc_wait_ct             = 0.0;
1775c6c1daeSBarry Smith   petsc_wait_any_ct         = 0.0;
1785c6c1daeSBarry Smith   petsc_wait_all_ct         = 0.0;
1795c6c1daeSBarry Smith   petsc_sum_of_waits_ct     = 0.0;
1805c6c1daeSBarry Smith   petsc_allreduce_ct        = 0.0;
1815c6c1daeSBarry Smith   petsc_gather_ct           = 0.0;
1825c6c1daeSBarry Smith   petsc_scatter_ct          = 0.0;
183d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
184bec0b493Shannah_mairs   petsc_ctog_ct = 0.0;
185bec0b493Shannah_mairs   petsc_gtoc_ct = 0.0;
186bec0b493Shannah_mairs   petsc_ctog_sz = 0.0;
187bec0b493Shannah_mairs   petsc_gtoc_sz = 0.0;
188958c4211Shannah_mairs   petsc_gflops  = 0.0;
189958c4211Shannah_mairs   petsc_gtime   = 0.0;
190bec0b493Shannah_mairs #endif
1915c6c1daeSBarry Smith   PETSC_LARGEST_EVENT      = PETSC_EVENT;
1920298fd71SBarry Smith   PetscLogPHC              = NULL;
1930298fd71SBarry Smith   PetscLogPHD              = NULL;
1940298fd71SBarry Smith   petsc_tracefile          = NULL;
1955c6c1daeSBarry Smith   petsc_tracelevel         = 0;
1965c6c1daeSBarry Smith   petsc_traceblanks        = "                                                                                                    ";
1979371c9d4SSatish Balay   petsc_tracespace[0]      = ' ';
1989371c9d4SSatish Balay   petsc_tracespace[1]      = 0;
1995c6c1daeSBarry Smith   petsc_tracetime          = 0.0;
2005c6c1daeSBarry Smith   PETSC_LARGEST_CLASSID    = PETSC_SMALLEST_CLASSID;
2015c6c1daeSBarry Smith   PETSC_OBJECT_CLASSID     = 0;
20202c9f0b5SLisandro Dalcin   petsc_stageLog           = NULL;
203896238b9SBarry Smith   PetscLogInitializeCalled = PETSC_FALSE;
2045c6c1daeSBarry Smith   PetscFunctionReturn(0);
2055c6c1daeSBarry Smith }
2065c6c1daeSBarry Smith 
2075c6c1daeSBarry Smith /*@C
2085c6c1daeSBarry Smith   PetscLogSet - Sets the logging functions called at the beginning and ending of every event.
2095c6c1daeSBarry Smith 
2105c6c1daeSBarry Smith   Not Collective
2115c6c1daeSBarry Smith 
2125c6c1daeSBarry Smith   Input Parameters:
2135c6c1daeSBarry Smith + b - The function called at beginning of event
2145c6c1daeSBarry Smith - e - The function called at end of event
2155c6c1daeSBarry Smith 
2165c6c1daeSBarry Smith   Level: developer
2175c6c1daeSBarry Smith 
218db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogTraceBegin()`
2195c6c1daeSBarry Smith @*/
2209371c9d4SSatish Balay PetscErrorCode PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject)) {
2215c6c1daeSBarry Smith   PetscFunctionBegin;
2225c6c1daeSBarry Smith   PetscLogPLB = b;
2235c6c1daeSBarry Smith   PetscLogPLE = e;
2245c6c1daeSBarry Smith   PetscFunctionReturn(0);
2255c6c1daeSBarry Smith }
2265c6c1daeSBarry Smith 
2275c6c1daeSBarry Smith /*@C
2284dd65854SConnor Ward   PetscLogIsActive - Check if logging is currently in progress.
2294dd65854SConnor Ward 
2304dd65854SConnor Ward   Not Collective
2314dd65854SConnor Ward 
2324dd65854SConnor Ward   Output Parameter:
2334dd65854SConnor Ward . isActive - PETSC_TRUE if logging is in progress, PETSC_FALSE otherwise
2344dd65854SConnor Ward 
2354dd65854SConnor Ward   Level: beginner
2364dd65854SConnor Ward 
237db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogSet()`
2384dd65854SConnor Ward @*/
2399371c9d4SSatish Balay PetscErrorCode PetscLogIsActive(PetscBool *isActive) {
2404dd65854SConnor Ward   PetscFunctionBegin;
2414dd65854SConnor Ward   *isActive = (PetscLogPLB && PetscLogPLE) ? PETSC_TRUE : PETSC_FALSE;
2424dd65854SConnor Ward   PetscFunctionReturn(0);
2434dd65854SConnor Ward }
2444dd65854SConnor Ward 
2454dd65854SConnor Ward /*@C
246bb1d7374SBarry Smith   PetscLogDefaultBegin - Turns on logging of objects and events. This logs flop
2475c6c1daeSBarry Smith   rates and object creation and should not slow programs down too much.
2485c6c1daeSBarry Smith   This routine may be called more than once.
2495c6c1daeSBarry Smith 
2505c6c1daeSBarry Smith   Logically Collective over PETSC_COMM_WORLD
2515c6c1daeSBarry Smith 
2525c6c1daeSBarry Smith   Options Database Keys:
253a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the
254a2553e36SBarry Smith                   screen (for code configured with --with-log=1 (which is the default))
2555c6c1daeSBarry Smith 
2565c6c1daeSBarry Smith   Usage:
2575c6c1daeSBarry Smith .vb
2585c6c1daeSBarry Smith       PetscInitialize(...);
259bb1d7374SBarry Smith       PetscLogDefaultBegin();
2605c6c1daeSBarry Smith        ... code ...
2615c6c1daeSBarry Smith       PetscLogView(viewer); or PetscLogDump();
2625c6c1daeSBarry Smith       PetscFinalize();
2635c6c1daeSBarry Smith .ve
2645c6c1daeSBarry Smith 
2655c6c1daeSBarry Smith   Notes:
2665c6c1daeSBarry Smith   PetscLogView(viewer) or PetscLogDump() actually cause the printing of
2675c6c1daeSBarry Smith   the logging information.
2685c6c1daeSBarry Smith 
2695c6c1daeSBarry Smith   Level: advanced
2705c6c1daeSBarry Smith 
271db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogView()`, `PetscLogTraceBegin()`
2725c6c1daeSBarry Smith @*/
2739371c9d4SSatish Balay PetscErrorCode PetscLogDefaultBegin(void) {
2745c6c1daeSBarry Smith   PetscFunctionBegin;
2759566063dSJacob Faibussowitsch   PetscCall(PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault));
2765c6c1daeSBarry Smith   PetscFunctionReturn(0);
2775c6c1daeSBarry Smith }
2785c6c1daeSBarry Smith 
2795c6c1daeSBarry Smith /*@C
2805c6c1daeSBarry Smith   PetscLogAllBegin - Turns on extensive logging of objects and events. Logs
2815c6c1daeSBarry Smith   all events. This creates large log files and slows the program down.
2825c6c1daeSBarry Smith 
2835c6c1daeSBarry Smith   Logically Collective on PETSC_COMM_WORLD
2845c6c1daeSBarry Smith 
2855c6c1daeSBarry Smith   Options Database Keys:
286a2553e36SBarry Smith . -log_all - Prints extensive log information
2875c6c1daeSBarry Smith 
2885c6c1daeSBarry Smith   Usage:
2895c6c1daeSBarry Smith .vb
2905c6c1daeSBarry Smith      PetscInitialize(...);
2915c6c1daeSBarry Smith      PetscLogAllBegin();
2925c6c1daeSBarry Smith      ... code ...
2935c6c1daeSBarry Smith      PetscLogDump(filename);
2945c6c1daeSBarry Smith      PetscFinalize();
2955c6c1daeSBarry Smith .ve
2965c6c1daeSBarry Smith 
2975c6c1daeSBarry Smith   Notes:
298bb1d7374SBarry Smith   A related routine is PetscLogDefaultBegin() (with the options key -log), which is
2995c6c1daeSBarry Smith   intended for production runs since it logs only flop rates and object
3005c6c1daeSBarry Smith   creation (and shouldn't significantly slow the programs).
3015c6c1daeSBarry Smith 
3025c6c1daeSBarry Smith   Level: advanced
3035c6c1daeSBarry Smith 
304db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogTraceBegin()`
3055c6c1daeSBarry Smith @*/
3069371c9d4SSatish Balay PetscErrorCode PetscLogAllBegin(void) {
3075c6c1daeSBarry Smith   PetscFunctionBegin;
3089566063dSJacob Faibussowitsch   PetscCall(PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete));
3095c6c1daeSBarry Smith   PetscFunctionReturn(0);
3105c6c1daeSBarry Smith }
3115c6c1daeSBarry Smith 
312956f8c0dSBarry Smith /*@C
3135c6c1daeSBarry Smith   PetscLogTraceBegin - Activates trace logging.  Every time a PETSc event
3145c6c1daeSBarry Smith   begins or ends, the event name is printed.
3155c6c1daeSBarry Smith 
3165c6c1daeSBarry Smith   Logically Collective on PETSC_COMM_WORLD
3175c6c1daeSBarry Smith 
3185c6c1daeSBarry Smith   Input Parameter:
3195c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout)
3205c6c1daeSBarry Smith 
3215c6c1daeSBarry Smith   Options Database Key:
3225c6c1daeSBarry Smith . -log_trace [filename] - Activates PetscLogTraceBegin()
3235c6c1daeSBarry Smith 
3245c6c1daeSBarry Smith   Notes:
3255c6c1daeSBarry Smith   PetscLogTraceBegin() prints the processor number, the execution time (sec),
3265c6c1daeSBarry Smith   then "Event begin:" or "Event end:" followed by the event name.
3275c6c1daeSBarry Smith 
3285c6c1daeSBarry Smith   PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful
3295c6c1daeSBarry Smith   to determine where a program is hanging without running in the
3305c6c1daeSBarry Smith   debugger.  Can be used in conjunction with the -info option.
3315c6c1daeSBarry Smith 
3325c6c1daeSBarry Smith   Level: intermediate
3335c6c1daeSBarry Smith 
334db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogView()`, `PetscLogDefaultBegin()`
3355c6c1daeSBarry Smith @*/
3369371c9d4SSatish Balay PetscErrorCode PetscLogTraceBegin(FILE *file) {
3375c6c1daeSBarry Smith   PetscFunctionBegin;
3385c6c1daeSBarry Smith   petsc_tracefile = file;
339a297a907SKarl Rupp 
3409566063dSJacob Faibussowitsch   PetscCall(PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace));
3415c6c1daeSBarry Smith   PetscFunctionReturn(0);
3425c6c1daeSBarry Smith }
3435c6c1daeSBarry Smith 
3445c6c1daeSBarry Smith /*@
3455c6c1daeSBarry Smith   PetscLogActions - Determines whether actions are logged for the graphical viewer.
3465c6c1daeSBarry Smith 
3475c6c1daeSBarry Smith   Not Collective
3485c6c1daeSBarry Smith 
3495c6c1daeSBarry Smith   Input Parameter:
3505c6c1daeSBarry Smith . flag - PETSC_TRUE if actions are to be logged
3515c6c1daeSBarry Smith 
3525c6c1daeSBarry Smith   Level: intermediate
3535c6c1daeSBarry Smith 
3545c6c1daeSBarry Smith   Note: Logging of actions continues to consume more memory as the program
3555c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
3565c6c1daeSBarry Smith 
3575c6c1daeSBarry Smith   Options Database Keys:
3585c6c1daeSBarry Smith . -log_exclude_actions - Turns off actions logging
3595c6c1daeSBarry Smith 
360db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()`
3615c6c1daeSBarry Smith @*/
3629371c9d4SSatish Balay PetscErrorCode PetscLogActions(PetscBool flag) {
3635c6c1daeSBarry Smith   PetscFunctionBegin;
3645c6c1daeSBarry Smith   petsc_logActions = flag;
3655c6c1daeSBarry Smith   PetscFunctionReturn(0);
3665c6c1daeSBarry Smith }
3675c6c1daeSBarry Smith 
3685c6c1daeSBarry Smith /*@
3695c6c1daeSBarry Smith   PetscLogObjects - Determines whether objects are logged for the graphical viewer.
3705c6c1daeSBarry Smith 
3715c6c1daeSBarry Smith   Not Collective
3725c6c1daeSBarry Smith 
3735c6c1daeSBarry Smith   Input Parameter:
3745c6c1daeSBarry Smith . flag - PETSC_TRUE if objects are to be logged
3755c6c1daeSBarry Smith 
3765c6c1daeSBarry Smith   Level: intermediate
3775c6c1daeSBarry Smith 
3785c6c1daeSBarry Smith   Note: Logging of objects continues to consume more memory as the program
3795c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
3805c6c1daeSBarry Smith 
3815c6c1daeSBarry Smith   Options Database Keys:
3825c6c1daeSBarry Smith . -log_exclude_objects - Turns off objects logging
3835c6c1daeSBarry Smith 
384db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()`
3855c6c1daeSBarry Smith @*/
3869371c9d4SSatish Balay PetscErrorCode PetscLogObjects(PetscBool flag) {
3875c6c1daeSBarry Smith   PetscFunctionBegin;
3885c6c1daeSBarry Smith   petsc_logObjects = flag;
3895c6c1daeSBarry Smith   PetscFunctionReturn(0);
3905c6c1daeSBarry Smith }
3915c6c1daeSBarry Smith 
3925c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/
3935c6c1daeSBarry Smith /*@C
39474c0405dSRichard Tran Mills   PetscLogStageRegister - Attaches a character string name to a logging stage.
3955c6c1daeSBarry Smith 
3965c6c1daeSBarry Smith   Not Collective
3975c6c1daeSBarry Smith 
3985c6c1daeSBarry Smith   Input Parameter:
3995c6c1daeSBarry Smith . sname - The name to associate with that stage
4005c6c1daeSBarry Smith 
4015c6c1daeSBarry Smith   Output Parameter:
4025c6c1daeSBarry Smith . stage - The stage number
4035c6c1daeSBarry Smith 
4045c6c1daeSBarry Smith   Level: intermediate
4055c6c1daeSBarry Smith 
406db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()`
4075c6c1daeSBarry Smith @*/
4089371c9d4SSatish Balay PetscErrorCode PetscLogStageRegister(const char sname[], PetscLogStage *stage) {
4095c6c1daeSBarry Smith   PetscStageLog stageLog;
4105c6c1daeSBarry Smith   PetscLogEvent event;
4115c6c1daeSBarry Smith 
4125c6c1daeSBarry Smith   PetscFunctionBegin;
4139566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
4149566063dSJacob Faibussowitsch   PetscCall(PetscStageLogRegister(stageLog, sname, stage));
4155c6c1daeSBarry Smith   /* Copy events already changed in the main stage, this sucks */
4169566063dSJacob Faibussowitsch   PetscCall(PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents));
417*48a46eb9SPierre Jolivet   for (event = 0; event < stageLog->eventLog->numEvents; event++) PetscCall(PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event], &stageLog->stageInfo[*stage].eventLog->eventInfo[event]));
4189566063dSJacob Faibussowitsch   PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses));
4195c6c1daeSBarry Smith   PetscFunctionReturn(0);
4205c6c1daeSBarry Smith }
4215c6c1daeSBarry Smith 
4225c6c1daeSBarry Smith /*@C
4235c6c1daeSBarry Smith   PetscLogStagePush - This function pushes a stage on the stack.
4245c6c1daeSBarry Smith 
4255c6c1daeSBarry Smith   Not Collective
4265c6c1daeSBarry Smith 
4275c6c1daeSBarry Smith   Input Parameter:
4285c6c1daeSBarry Smith . stage - The stage on which to log
4295c6c1daeSBarry Smith 
4305c6c1daeSBarry Smith   Usage:
4315c6c1daeSBarry Smith   If the option -log_sumary is used to run the program containing the
4325c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
4335c6c1daeSBarry Smith   PetscFinalize().
4345c6c1daeSBarry Smith .vb
4355c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
4365c6c1daeSBarry Smith       [stage 0 of code]
4375c6c1daeSBarry Smith       PetscLogStagePush(1);
4385c6c1daeSBarry Smith       [stage 1 of code]
4395c6c1daeSBarry Smith       PetscLogStagePop();
4405c6c1daeSBarry Smith       PetscBarrier(...);
4415c6c1daeSBarry Smith       [more stage 0 of code]
4425c6c1daeSBarry Smith       PetscFinalize();
4435c6c1daeSBarry Smith .ve
4445c6c1daeSBarry Smith 
4455c6c1daeSBarry Smith   Notes:
4465c6c1daeSBarry Smith   Use PetscLogStageRegister() to register a stage.
4475c6c1daeSBarry Smith 
4485c6c1daeSBarry Smith   Level: intermediate
4495c6c1daeSBarry Smith 
450db781477SPatrick Sanan .seealso: `PetscLogStagePop()`, `PetscLogStageRegister()`, `PetscBarrier()`
4515c6c1daeSBarry Smith @*/
4529371c9d4SSatish Balay PetscErrorCode PetscLogStagePush(PetscLogStage stage) {
4535c6c1daeSBarry Smith   PetscStageLog stageLog;
4545c6c1daeSBarry Smith 
4555c6c1daeSBarry Smith   PetscFunctionBegin;
4569566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
4579566063dSJacob Faibussowitsch   PetscCall(PetscStageLogPush(stageLog, stage));
4585c6c1daeSBarry Smith   PetscFunctionReturn(0);
4595c6c1daeSBarry Smith }
4605c6c1daeSBarry Smith 
4615c6c1daeSBarry Smith /*@C
4625c6c1daeSBarry Smith   PetscLogStagePop - This function pops a stage from the stack.
4635c6c1daeSBarry Smith 
4645c6c1daeSBarry Smith   Not Collective
4655c6c1daeSBarry Smith 
4665c6c1daeSBarry Smith   Usage:
4675c6c1daeSBarry Smith   If the option -log_sumary is used to run the program containing the
4685c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
4695c6c1daeSBarry Smith   PetscFinalize().
4705c6c1daeSBarry Smith .vb
4715c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
4725c6c1daeSBarry Smith       [stage 0 of code]
4735c6c1daeSBarry Smith       PetscLogStagePush(1);
4745c6c1daeSBarry Smith       [stage 1 of code]
4755c6c1daeSBarry Smith       PetscLogStagePop();
4765c6c1daeSBarry Smith       PetscBarrier(...);
4775c6c1daeSBarry Smith       [more stage 0 of code]
4785c6c1daeSBarry Smith       PetscFinalize();
4795c6c1daeSBarry Smith .ve
4805c6c1daeSBarry Smith 
4815c6c1daeSBarry Smith   Notes:
4825c6c1daeSBarry Smith   Use PetscLogStageRegister() to register a stage.
4835c6c1daeSBarry Smith 
4845c6c1daeSBarry Smith   Level: intermediate
4855c6c1daeSBarry Smith 
486db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStageRegister()`, `PetscBarrier()`
4875c6c1daeSBarry Smith @*/
4889371c9d4SSatish Balay PetscErrorCode PetscLogStagePop(void) {
4895c6c1daeSBarry Smith   PetscStageLog stageLog;
4905c6c1daeSBarry Smith 
4915c6c1daeSBarry Smith   PetscFunctionBegin;
4929566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
4939566063dSJacob Faibussowitsch   PetscCall(PetscStageLogPop(stageLog));
4945c6c1daeSBarry Smith   PetscFunctionReturn(0);
4955c6c1daeSBarry Smith }
4965c6c1daeSBarry Smith 
4975c6c1daeSBarry Smith /*@
4985c6c1daeSBarry Smith   PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd().
4995c6c1daeSBarry Smith 
5005c6c1daeSBarry Smith   Not Collective
5015c6c1daeSBarry Smith 
5025c6c1daeSBarry Smith   Input Parameters:
5035c6c1daeSBarry Smith + stage    - The stage
5045c6c1daeSBarry Smith - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE)
5055c6c1daeSBarry Smith 
5065c6c1daeSBarry Smith   Level: intermediate
5075c6c1daeSBarry Smith 
508db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()`
5095c6c1daeSBarry Smith @*/
5109371c9d4SSatish Balay PetscErrorCode PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive) {
5115c6c1daeSBarry Smith   PetscStageLog stageLog;
5125c6c1daeSBarry Smith 
5135c6c1daeSBarry Smith   PetscFunctionBegin;
5149566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
5159566063dSJacob Faibussowitsch   PetscCall(PetscStageLogSetActive(stageLog, stage, isActive));
5165c6c1daeSBarry Smith   PetscFunctionReturn(0);
5175c6c1daeSBarry Smith }
5185c6c1daeSBarry Smith 
5195c6c1daeSBarry Smith /*@
5205c6c1daeSBarry Smith   PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd().
5215c6c1daeSBarry Smith 
5225c6c1daeSBarry Smith   Not Collective
5235c6c1daeSBarry Smith 
5245c6c1daeSBarry Smith   Input Parameter:
5255c6c1daeSBarry Smith . stage    - The stage
5265c6c1daeSBarry Smith 
5275c6c1daeSBarry Smith   Output Parameter:
5285c6c1daeSBarry Smith . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE)
5295c6c1daeSBarry Smith 
5305c6c1daeSBarry Smith   Level: intermediate
5315c6c1daeSBarry Smith 
532db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()`
5335c6c1daeSBarry Smith @*/
5349371c9d4SSatish Balay PetscErrorCode PetscLogStageGetActive(PetscLogStage stage, PetscBool *isActive) {
5355c6c1daeSBarry Smith   PetscStageLog stageLog;
5365c6c1daeSBarry Smith 
5375c6c1daeSBarry Smith   PetscFunctionBegin;
5389566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
5399566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetActive(stageLog, stage, isActive));
5405c6c1daeSBarry Smith   PetscFunctionReturn(0);
5415c6c1daeSBarry Smith }
5425c6c1daeSBarry Smith 
5435c6c1daeSBarry Smith /*@
5445c6c1daeSBarry Smith   PetscLogStageSetVisible - Determines stage visibility in PetscLogView()
5455c6c1daeSBarry Smith 
5465c6c1daeSBarry Smith   Not Collective
5475c6c1daeSBarry Smith 
5485c6c1daeSBarry Smith   Input Parameters:
5495c6c1daeSBarry Smith + stage     - The stage
5505c6c1daeSBarry Smith - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE)
5515c6c1daeSBarry Smith 
5525c6c1daeSBarry Smith   Level: intermediate
5535c6c1daeSBarry Smith 
554db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogView()`
5555c6c1daeSBarry Smith @*/
5569371c9d4SSatish Balay PetscErrorCode PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible) {
5575c6c1daeSBarry Smith   PetscStageLog stageLog;
5585c6c1daeSBarry Smith 
5595c6c1daeSBarry Smith   PetscFunctionBegin;
5609566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
5619566063dSJacob Faibussowitsch   PetscCall(PetscStageLogSetVisible(stageLog, stage, isVisible));
5625c6c1daeSBarry Smith   PetscFunctionReturn(0);
5635c6c1daeSBarry Smith }
5645c6c1daeSBarry Smith 
5655c6c1daeSBarry Smith /*@
5665c6c1daeSBarry Smith   PetscLogStageGetVisible - Returns stage visibility in PetscLogView()
5675c6c1daeSBarry Smith 
5685c6c1daeSBarry Smith   Not Collective
5695c6c1daeSBarry Smith 
5705c6c1daeSBarry Smith   Input Parameter:
5715c6c1daeSBarry Smith . stage     - The stage
5725c6c1daeSBarry Smith 
5735c6c1daeSBarry Smith   Output Parameter:
5745c6c1daeSBarry Smith . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE)
5755c6c1daeSBarry Smith 
5765c6c1daeSBarry Smith   Level: intermediate
5775c6c1daeSBarry Smith 
578db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogView()`
5795c6c1daeSBarry Smith @*/
5809371c9d4SSatish Balay PetscErrorCode PetscLogStageGetVisible(PetscLogStage stage, PetscBool *isVisible) {
5815c6c1daeSBarry Smith   PetscStageLog stageLog;
5825c6c1daeSBarry Smith 
5835c6c1daeSBarry Smith   PetscFunctionBegin;
5849566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
5859566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetVisible(stageLog, stage, isVisible));
5865c6c1daeSBarry Smith   PetscFunctionReturn(0);
5875c6c1daeSBarry Smith }
5885c6c1daeSBarry Smith 
5895c6c1daeSBarry Smith /*@C
5905c6c1daeSBarry Smith   PetscLogStageGetId - Returns the stage id when given the stage name.
5915c6c1daeSBarry Smith 
5925c6c1daeSBarry Smith   Not Collective
5935c6c1daeSBarry Smith 
5945c6c1daeSBarry Smith   Input Parameter:
5955c6c1daeSBarry Smith . name  - The stage name
5965c6c1daeSBarry Smith 
5975c6c1daeSBarry Smith   Output Parameter:
5985a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists
5995c6c1daeSBarry Smith 
6005c6c1daeSBarry Smith   Level: intermediate
6015c6c1daeSBarry Smith 
602db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()`
6035c6c1daeSBarry Smith @*/
6049371c9d4SSatish Balay PetscErrorCode PetscLogStageGetId(const char name[], PetscLogStage *stage) {
6055c6c1daeSBarry Smith   PetscStageLog stageLog;
6065c6c1daeSBarry Smith 
6075c6c1daeSBarry Smith   PetscFunctionBegin;
6089566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
6099566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetStage(stageLog, name, stage));
6105c6c1daeSBarry Smith   PetscFunctionReturn(0);
6115c6c1daeSBarry Smith }
6125c6c1daeSBarry Smith 
6135c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/
6147a101e5eSJacob Faibussowitsch 
6155c6c1daeSBarry Smith /*@C
6165c6c1daeSBarry Smith   PetscLogEventRegister - Registers an event name for logging operations in an application code.
6175c6c1daeSBarry Smith 
6185c6c1daeSBarry Smith   Not Collective
6195c6c1daeSBarry Smith 
620d8d19677SJose E. Roman   Input Parameters:
6215c6c1daeSBarry Smith + name   - The name associated with the event
6225c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with
6235c6c1daeSBarry Smith            PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones
6245c6c1daeSBarry Smith            are only available in C code
6255c6c1daeSBarry Smith 
6265c6c1daeSBarry Smith   Output Parameter:
6275c6c1daeSBarry Smith . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd().
6285c6c1daeSBarry Smith 
6295c6c1daeSBarry Smith   Example of Usage:
6305c6c1daeSBarry Smith .vb
6315c6c1daeSBarry Smith       PetscLogEvent USER_EVENT;
6325c6c1daeSBarry Smith       PetscClassId classid;
6335c6c1daeSBarry Smith       PetscLogDouble user_event_flops;
6345c6c1daeSBarry Smith       PetscClassIdRegister("class name",&classid);
6355c6c1daeSBarry Smith       PetscLogEventRegister("User event name",classid,&USER_EVENT);
6365c6c1daeSBarry Smith       PetscLogEventBegin(USER_EVENT,0,0,0,0);
6375c6c1daeSBarry Smith          [code segment to monitor]
6385c6c1daeSBarry Smith          PetscLogFlops(user_event_flops);
6395c6c1daeSBarry Smith       PetscLogEventEnd(USER_EVENT,0,0,0,0);
6405c6c1daeSBarry Smith .ve
6415c6c1daeSBarry Smith 
6425c6c1daeSBarry Smith   Notes:
6435c6c1daeSBarry Smith   PETSc automatically logs library events if the code has been
644a2553e36SBarry Smith   configured with --with-log (which is the default) and
645a2553e36SBarry Smith   -log_view or -log_all is specified.  PetscLogEventRegister() is
6465c6c1daeSBarry Smith   intended for logging user events to supplement this PETSc
6475c6c1daeSBarry Smith   information.
6485c6c1daeSBarry Smith 
649495fc317SBarry Smith   PETSc can gather data for use with the utilities Jumpshot
6505c6c1daeSBarry Smith   (part of the MPICH distribution).  If PETSc has been compiled
6515c6c1daeSBarry Smith   with flag -DPETSC_HAVE_MPE (MPE is an additional utility within
6525c6c1daeSBarry Smith   MPICH), the user can employ another command line option, -log_mpe,
6535c6c1daeSBarry Smith   to create a logfile, "mpe.log", which can be visualized
654495fc317SBarry Smith   Jumpshot.
6555c6c1daeSBarry Smith 
6565c6c1daeSBarry Smith   The classid is associated with each event so that classes of events
6575c6c1daeSBarry Smith   can be disabled simultaneously, such as all matrix events. The user
6585c6c1daeSBarry Smith   can either use an existing classid, such as MAT_CLASSID, or create
6595c6c1daeSBarry Smith   their own as shown in the example.
6605c6c1daeSBarry Smith 
661c5deb1d5SJed Brown   If an existing event with the same name exists, its event handle is
662c5deb1d5SJed Brown   returned instead of creating a new event.
663c5deb1d5SJed Brown 
6645c6c1daeSBarry Smith   Level: intermediate
6655c6c1daeSBarry Smith 
666db781477SPatrick Sanan .seealso: `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogFlops()`,
667db781477SPatrick Sanan           `PetscLogEventActivate()`, `PetscLogEventDeactivate()`, `PetscClassIdRegister()`
6685c6c1daeSBarry Smith @*/
6699371c9d4SSatish Balay PetscErrorCode PetscLogEventRegister(const char name[], PetscClassId classid, PetscLogEvent *event) {
6705c6c1daeSBarry Smith   PetscStageLog stageLog;
6715c6c1daeSBarry Smith   int           stage;
6725c6c1daeSBarry Smith 
6735c6c1daeSBarry Smith   PetscFunctionBegin;
6745c6c1daeSBarry Smith   *event = PETSC_DECIDE;
6759566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
6769566063dSJacob Faibussowitsch   PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, event));
677c5deb1d5SJed Brown   if (*event > 0) PetscFunctionReturn(0);
6789566063dSJacob Faibussowitsch   PetscCall(PetscEventRegLogRegister(stageLog->eventLog, name, classid, event));
6795c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
6809566063dSJacob Faibussowitsch     PetscCall(PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents));
6819566063dSJacob Faibussowitsch     PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses));
6825c6c1daeSBarry Smith   }
6835c6c1daeSBarry Smith   PetscFunctionReturn(0);
6845c6c1daeSBarry Smith }
6855c6c1daeSBarry Smith 
6865c6c1daeSBarry Smith /*@
687217044c2SLisandro Dalcin   PetscLogEventSetCollective - Indicates that a particular event is collective.
688217044c2SLisandro Dalcin 
689217044c2SLisandro Dalcin   Not Collective
690217044c2SLisandro Dalcin 
691d8d19677SJose E. Roman   Input Parameters:
692217044c2SLisandro Dalcin + event - The event id
693217044c2SLisandro Dalcin - collective - Bolean flag indicating whether a particular event is collective
694217044c2SLisandro Dalcin 
695217044c2SLisandro Dalcin   Note:
696217044c2SLisandro Dalcin   New events returned from PetscLogEventRegister() are collective by default.
697217044c2SLisandro Dalcin 
698217044c2SLisandro Dalcin   Level: developer
699217044c2SLisandro Dalcin 
700db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`
701217044c2SLisandro Dalcin @*/
7029371c9d4SSatish Balay PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event, PetscBool collective) {
703217044c2SLisandro Dalcin   PetscStageLog    stageLog;
704217044c2SLisandro Dalcin   PetscEventRegLog eventRegLog;
705217044c2SLisandro Dalcin 
706217044c2SLisandro Dalcin   PetscFunctionBegin;
7079566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
7089566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetEventRegLog(stageLog, &eventRegLog));
709cc73adaaSBarry Smith   PetscCheck(event >= 0 && event <= eventRegLog->numEvents, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Invalid event id");
710217044c2SLisandro Dalcin   eventRegLog->eventInfo[event].collective = collective;
711217044c2SLisandro Dalcin   PetscFunctionReturn(0);
712217044c2SLisandro Dalcin }
713217044c2SLisandro Dalcin 
714217044c2SLisandro Dalcin /*@
715fa2bb9feSLisandro Dalcin   PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage.
716fa2bb9feSLisandro Dalcin 
717fa2bb9feSLisandro Dalcin   Not Collective
718fa2bb9feSLisandro Dalcin 
719fa2bb9feSLisandro Dalcin   Input Parameter:
720fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc.
721fa2bb9feSLisandro Dalcin 
722fa2bb9feSLisandro Dalcin   Level: developer
723fa2bb9feSLisandro Dalcin 
724c2e3fba1SPatrick Sanan .seealso: `PetscLogEventActivateClass()`, `PetscLogEventDeactivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()`
725fa2bb9feSLisandro Dalcin @*/
7269371c9d4SSatish Balay PetscErrorCode PetscLogEventIncludeClass(PetscClassId classid) {
727fa2bb9feSLisandro Dalcin   PetscStageLog stageLog;
728fa2bb9feSLisandro Dalcin   int           stage;
729fa2bb9feSLisandro Dalcin 
730fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
7319566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
732*48a46eb9SPierre Jolivet   for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid));
733fa2bb9feSLisandro Dalcin   PetscFunctionReturn(0);
734fa2bb9feSLisandro Dalcin }
735fa2bb9feSLisandro Dalcin 
736fa2bb9feSLisandro Dalcin /*@
737fa2bb9feSLisandro Dalcin   PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage.
738fa2bb9feSLisandro Dalcin 
739fa2bb9feSLisandro Dalcin   Not Collective
740fa2bb9feSLisandro Dalcin 
741fa2bb9feSLisandro Dalcin   Input Parameter:
742fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc.
743fa2bb9feSLisandro Dalcin 
744fa2bb9feSLisandro Dalcin   Level: developer
745fa2bb9feSLisandro Dalcin 
746c2e3fba1SPatrick Sanan .seealso: `PetscLogEventDeactivateClass()`, `PetscLogEventActivateClass()`, `PetscLogEventDeactivate()`, `PetscLogEventActivate()`
747fa2bb9feSLisandro Dalcin @*/
7489371c9d4SSatish Balay PetscErrorCode PetscLogEventExcludeClass(PetscClassId classid) {
749fa2bb9feSLisandro Dalcin   PetscStageLog stageLog;
750fa2bb9feSLisandro Dalcin   int           stage;
751fa2bb9feSLisandro Dalcin 
752fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
7539566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
754*48a46eb9SPierre Jolivet   for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid));
755fa2bb9feSLisandro Dalcin   PetscFunctionReturn(0);
756fa2bb9feSLisandro Dalcin }
757fa2bb9feSLisandro Dalcin 
758fa2bb9feSLisandro Dalcin /*@
7595c6c1daeSBarry Smith   PetscLogEventActivate - Indicates that a particular event should be logged.
7605c6c1daeSBarry Smith 
7615c6c1daeSBarry Smith   Not Collective
7625c6c1daeSBarry Smith 
7635c6c1daeSBarry Smith   Input Parameter:
7645c6c1daeSBarry Smith . event - The event id
7655c6c1daeSBarry Smith 
7665c6c1daeSBarry Smith   Usage:
7675c6c1daeSBarry Smith .vb
7685c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
7695c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
7705c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
7715c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
7725c6c1daeSBarry Smith .ve
7735c6c1daeSBarry Smith 
7745c6c1daeSBarry Smith   Note:
7755c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in include/petsclog.h)
7765c6c1daeSBarry Smith   or an event number obtained with PetscLogEventRegister().
7775c6c1daeSBarry Smith 
7785c6c1daeSBarry Smith   Level: advanced
7795c6c1daeSBarry Smith 
780db781477SPatrick Sanan .seealso: `PlogEventDeactivate()`, `PlogEventDeactivatePush()`, `PetscLogEventDeactivatePop()`
7815c6c1daeSBarry Smith @*/
7829371c9d4SSatish Balay PetscErrorCode PetscLogEventActivate(PetscLogEvent event) {
7835c6c1daeSBarry Smith   PetscStageLog stageLog;
7845c6c1daeSBarry Smith   int           stage;
7855c6c1daeSBarry Smith 
7865c6c1daeSBarry Smith   PetscFunctionBegin;
7879566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
7889566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
7899566063dSJacob Faibussowitsch   PetscCall(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event));
7905c6c1daeSBarry Smith   PetscFunctionReturn(0);
7915c6c1daeSBarry Smith }
7925c6c1daeSBarry Smith 
7935c6c1daeSBarry Smith /*@
7945c6c1daeSBarry Smith   PetscLogEventDeactivate - Indicates that a particular event should not be logged.
7955c6c1daeSBarry Smith 
7965c6c1daeSBarry Smith   Not Collective
7975c6c1daeSBarry Smith 
7985c6c1daeSBarry Smith   Input Parameter:
7995c6c1daeSBarry Smith . event - The event id
8005c6c1daeSBarry Smith 
8015c6c1daeSBarry Smith   Usage:
8025c6c1daeSBarry Smith .vb
8035c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
8045c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
8055c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
8065c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
8075c6c1daeSBarry Smith .ve
8085c6c1daeSBarry Smith 
8095c6c1daeSBarry Smith   Note:
8105c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in
8115c6c1daeSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
8125c6c1daeSBarry Smith 
8135c6c1daeSBarry Smith   Level: advanced
8145c6c1daeSBarry Smith 
815db781477SPatrick Sanan .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePush()`, `PetscLogEventDeactivatePop()`
8165c6c1daeSBarry Smith @*/
8179371c9d4SSatish Balay PetscErrorCode PetscLogEventDeactivate(PetscLogEvent event) {
8185c6c1daeSBarry Smith   PetscStageLog stageLog;
8195c6c1daeSBarry Smith   int           stage;
8205c6c1daeSBarry Smith 
8215c6c1daeSBarry Smith   PetscFunctionBegin;
8229566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
8239566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
8249566063dSJacob Faibussowitsch   PetscCall(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event));
8255c6c1daeSBarry Smith   PetscFunctionReturn(0);
8265c6c1daeSBarry Smith }
8275c6c1daeSBarry Smith 
8285c6c1daeSBarry Smith /*@
829c00cb57fSBarry Smith   PetscLogEventDeactivatePush - Indicates that a particular event should not be logged.
830c00cb57fSBarry Smith 
831c00cb57fSBarry Smith   Not Collective
832c00cb57fSBarry Smith 
833c00cb57fSBarry Smith   Input Parameter:
834c00cb57fSBarry Smith . event - The event id
835c00cb57fSBarry Smith 
836c00cb57fSBarry Smith   Usage:
837c00cb57fSBarry Smith .vb
838c00cb57fSBarry Smith       PetscLogEventDeactivatePush(VEC_SetValues);
839c00cb57fSBarry Smith         [code where you do not want to log VecSetValues()]
840c00cb57fSBarry Smith       PetscLogEventDeactivatePop(VEC_SetValues);
841c00cb57fSBarry Smith         [code where you do want to log VecSetValues()]
842c00cb57fSBarry Smith .ve
843c00cb57fSBarry Smith 
844c00cb57fSBarry Smith   Note:
845c00cb57fSBarry Smith   The event may be either a pre-defined PETSc event (found in
846c00cb57fSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
847c00cb57fSBarry Smith 
848c00cb57fSBarry Smith   Level: advanced
849c00cb57fSBarry Smith 
850db781477SPatrick Sanan .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePop()`
851c00cb57fSBarry Smith @*/
8529371c9d4SSatish Balay PetscErrorCode PetscLogEventDeactivatePush(PetscLogEvent event) {
853c00cb57fSBarry Smith   PetscStageLog stageLog;
854c00cb57fSBarry Smith   int           stage;
855c00cb57fSBarry Smith 
856c00cb57fSBarry Smith   PetscFunctionBegin;
8579566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
8589566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
8599566063dSJacob Faibussowitsch   PetscCall(PetscEventPerfLogDeactivatePush(stageLog->stageInfo[stage].eventLog, event));
860c00cb57fSBarry Smith   PetscFunctionReturn(0);
861c00cb57fSBarry Smith }
862c00cb57fSBarry Smith 
863c00cb57fSBarry Smith /*@
864c00cb57fSBarry Smith   PetscLogEventDeactivatePop - Indicates that a particular event should be logged.
865c00cb57fSBarry Smith 
866c00cb57fSBarry Smith   Not Collective
867c00cb57fSBarry Smith 
868c00cb57fSBarry Smith   Input Parameter:
869c00cb57fSBarry Smith . event - The event id
870c00cb57fSBarry Smith 
871c00cb57fSBarry Smith   Usage:
872c00cb57fSBarry Smith .vb
873c00cb57fSBarry Smith       PetscLogEventDeactivatePush(VEC_SetValues);
874c00cb57fSBarry Smith         [code where you do not want to log VecSetValues()]
875c00cb57fSBarry Smith       PetscLogEventDeactivatePop(VEC_SetValues);
876c00cb57fSBarry Smith         [code where you do want to log VecSetValues()]
877c00cb57fSBarry Smith .ve
878c00cb57fSBarry Smith 
879c00cb57fSBarry Smith   Note:
880c00cb57fSBarry Smith   The event may be either a pre-defined PETSc event (found in
881c00cb57fSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
882c00cb57fSBarry Smith 
883c00cb57fSBarry Smith   Level: advanced
884c00cb57fSBarry Smith 
885db781477SPatrick Sanan .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePush()`
886c00cb57fSBarry Smith @*/
8879371c9d4SSatish Balay PetscErrorCode PetscLogEventDeactivatePop(PetscLogEvent event) {
888c00cb57fSBarry Smith   PetscStageLog stageLog;
889c00cb57fSBarry Smith   int           stage;
890c00cb57fSBarry Smith 
891c00cb57fSBarry Smith   PetscFunctionBegin;
8929566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
8939566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
8949566063dSJacob Faibussowitsch   PetscCall(PetscEventPerfLogDeactivatePop(stageLog->stageInfo[stage].eventLog, event));
895c00cb57fSBarry Smith   PetscFunctionReturn(0);
896c00cb57fSBarry Smith }
897c00cb57fSBarry Smith 
898c00cb57fSBarry Smith /*@
8995c6c1daeSBarry Smith   PetscLogEventSetActiveAll - Sets the event activity in every stage.
9005c6c1daeSBarry Smith 
9015c6c1daeSBarry Smith   Not Collective
9025c6c1daeSBarry Smith 
9035c6c1daeSBarry Smith   Input Parameters:
9045c6c1daeSBarry Smith + event    - The event id
9055c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged
9065c6c1daeSBarry Smith 
9075c6c1daeSBarry Smith   Level: advanced
9085c6c1daeSBarry Smith 
909c2e3fba1SPatrick Sanan .seealso: `PlogEventActivate()`, `PlogEventDeactivate()`
9105c6c1daeSBarry Smith @*/
9119371c9d4SSatish Balay PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive) {
9125c6c1daeSBarry Smith   PetscStageLog stageLog;
9135c6c1daeSBarry Smith   int           stage;
9145c6c1daeSBarry Smith 
9155c6c1daeSBarry Smith   PetscFunctionBegin;
9169566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
9175c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
9185c6c1daeSBarry Smith     if (isActive) {
9199566063dSJacob Faibussowitsch       PetscCall(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event));
9205c6c1daeSBarry Smith     } else {
9219566063dSJacob Faibussowitsch       PetscCall(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event));
9225c6c1daeSBarry Smith     }
9235c6c1daeSBarry Smith   }
9245c6c1daeSBarry Smith   PetscFunctionReturn(0);
9255c6c1daeSBarry Smith }
9265c6c1daeSBarry Smith 
9275c6c1daeSBarry Smith /*@
9285c6c1daeSBarry Smith   PetscLogEventActivateClass - Activates event logging for a PETSc object class.
9295c6c1daeSBarry Smith 
9305c6c1daeSBarry Smith   Not Collective
9315c6c1daeSBarry Smith 
9325c6c1daeSBarry Smith   Input Parameter:
9335c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc.
9345c6c1daeSBarry Smith 
9355c6c1daeSBarry Smith   Level: developer
9365c6c1daeSBarry Smith 
937c2e3fba1SPatrick Sanan .seealso: `PetscLogEventDeactivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()`
9385c6c1daeSBarry Smith @*/
9399371c9d4SSatish Balay PetscErrorCode PetscLogEventActivateClass(PetscClassId classid) {
9405c6c1daeSBarry Smith   PetscStageLog stageLog;
9415c6c1daeSBarry Smith   int           stage;
9425c6c1daeSBarry Smith 
9435c6c1daeSBarry Smith   PetscFunctionBegin;
9449566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
9459566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
9469566063dSJacob Faibussowitsch   PetscCall(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid));
9475c6c1daeSBarry Smith   PetscFunctionReturn(0);
9485c6c1daeSBarry Smith }
9495c6c1daeSBarry Smith 
9505c6c1daeSBarry Smith /*@
9515c6c1daeSBarry Smith   PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class.
9525c6c1daeSBarry Smith 
9535c6c1daeSBarry Smith   Not Collective
9545c6c1daeSBarry Smith 
9555c6c1daeSBarry Smith   Input Parameter:
9565c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc.
9575c6c1daeSBarry Smith 
9585c6c1daeSBarry Smith   Level: developer
9595c6c1daeSBarry Smith 
960c2e3fba1SPatrick Sanan .seealso: `PetscLogEventActivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()`
9615c6c1daeSBarry Smith @*/
9629371c9d4SSatish Balay PetscErrorCode PetscLogEventDeactivateClass(PetscClassId classid) {
9635c6c1daeSBarry Smith   PetscStageLog stageLog;
9645c6c1daeSBarry Smith   int           stage;
9655c6c1daeSBarry Smith 
9665c6c1daeSBarry Smith   PetscFunctionBegin;
9679566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
9689566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
9699566063dSJacob Faibussowitsch   PetscCall(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid));
9705c6c1daeSBarry Smith   PetscFunctionReturn(0);
9715c6c1daeSBarry Smith }
9725c6c1daeSBarry Smith 
9735c6c1daeSBarry Smith /*MC
97462872c28SLisandro Dalcin    PetscLogEventSync - Synchronizes the beginning of a user event.
97562872c28SLisandro Dalcin 
97662872c28SLisandro Dalcin    Synopsis:
97762872c28SLisandro Dalcin    #include <petsclog.h>
97862872c28SLisandro Dalcin    PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm)
97962872c28SLisandro Dalcin 
98062872c28SLisandro Dalcin    Collective
98162872c28SLisandro Dalcin 
98262872c28SLisandro Dalcin    Input Parameters:
98362872c28SLisandro Dalcin +  e - integer associated with the event obtained from PetscLogEventRegister()
98462872c28SLisandro Dalcin -  comm - an MPI communicator
98562872c28SLisandro Dalcin 
98662872c28SLisandro Dalcin    Usage:
98762872c28SLisandro Dalcin .vb
98862872c28SLisandro Dalcin      PetscLogEvent USER_EVENT;
98962872c28SLisandro Dalcin      PetscLogEventRegister("User event",0,&USER_EVENT);
99062872c28SLisandro Dalcin      PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD);
99162872c28SLisandro Dalcin      PetscLogEventBegin(USER_EVENT,0,0,0,0);
99262872c28SLisandro Dalcin         [code segment to monitor]
99362872c28SLisandro Dalcin      PetscLogEventEnd(USER_EVENT,0,0,0,0);
99462872c28SLisandro Dalcin .ve
99562872c28SLisandro Dalcin 
99662872c28SLisandro Dalcin    Notes:
99762872c28SLisandro Dalcin    This routine should be called only if there is not a
99862872c28SLisandro Dalcin    PetscObject available to pass to PetscLogEventBegin().
99962872c28SLisandro Dalcin 
100062872c28SLisandro Dalcin    Level: developer
100162872c28SLisandro Dalcin 
1002db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`
100362872c28SLisandro Dalcin 
100462872c28SLisandro Dalcin M*/
100562872c28SLisandro Dalcin 
100662872c28SLisandro Dalcin /*MC
10075c6c1daeSBarry Smith    PetscLogEventBegin - Logs the beginning of a user event.
10085c6c1daeSBarry Smith 
10095c6c1daeSBarry Smith    Synopsis:
1010aaa7dc30SBarry Smith    #include <petsclog.h>
1011f2ba6396SBarry Smith    PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
10125c6c1daeSBarry Smith 
10135c6c1daeSBarry Smith    Not Collective
10145c6c1daeSBarry Smith 
10155c6c1daeSBarry Smith    Input Parameters:
10165c6c1daeSBarry Smith +  e - integer associated with the event obtained from PetscLogEventRegister()
10175c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
10185c6c1daeSBarry Smith 
10195c6c1daeSBarry Smith    Fortran Synopsis:
10205c6c1daeSBarry Smith    void PetscLogEventBegin(int e,PetscErrorCode ierr)
10215c6c1daeSBarry Smith 
10225c6c1daeSBarry Smith    Usage:
10235c6c1daeSBarry Smith .vb
10245c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
10255c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
10265c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
10275c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
10285c6c1daeSBarry Smith         [code segment to monitor]
10295c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
10305c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
10315c6c1daeSBarry Smith .ve
10325c6c1daeSBarry Smith 
10335c6c1daeSBarry Smith    Notes:
10345c6c1daeSBarry Smith    You need to register each integer event with the command
1035a2553e36SBarry Smith    PetscLogEventRegister().
10365c6c1daeSBarry Smith 
1037d0609cedSBarry Smith    Developer Notes:
1038d0609cedSBarry Smith      PetscLogEventBegin() and PetscLogEventBegin() return error codes instead of explicitly handling the
1039d0609cedSBarry Smith      errors that occur in the macro directly because other packages that use this macros have used them in their
1040d0609cedSBarry Smith      own functions or methods that do not return error codes and it would be disruptive to change the current
1041d0609cedSBarry Smith      behavior.
1042d0609cedSBarry Smith 
10435c6c1daeSBarry Smith    Level: intermediate
10445c6c1daeSBarry Smith 
1045db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventEnd()`, `PetscLogFlops()`
10465c6c1daeSBarry Smith 
10475c6c1daeSBarry Smith M*/
10485c6c1daeSBarry Smith 
10495c6c1daeSBarry Smith /*MC
10505c6c1daeSBarry Smith    PetscLogEventEnd - Log the end of a user event.
10515c6c1daeSBarry Smith 
10525c6c1daeSBarry Smith    Synopsis:
1053aaa7dc30SBarry Smith    #include <petsclog.h>
1054f2ba6396SBarry Smith    PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
10555c6c1daeSBarry Smith 
10565c6c1daeSBarry Smith    Not Collective
10575c6c1daeSBarry Smith 
10585c6c1daeSBarry Smith    Input Parameters:
10595c6c1daeSBarry Smith +  e - integer associated with the event obtained with PetscLogEventRegister()
10605c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
10615c6c1daeSBarry Smith 
10625c6c1daeSBarry Smith    Fortran Synopsis:
10635c6c1daeSBarry Smith    void PetscLogEventEnd(int e,PetscErrorCode ierr)
10645c6c1daeSBarry Smith 
10655c6c1daeSBarry Smith    Usage:
10665c6c1daeSBarry Smith .vb
10675c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
10685c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
10695c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT,);
10705c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
10715c6c1daeSBarry Smith         [code segment to monitor]
10725c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
10735c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
10745c6c1daeSBarry Smith .ve
10755c6c1daeSBarry Smith 
10765c6c1daeSBarry Smith    Notes:
10775c6c1daeSBarry Smith    You should also register each additional integer event with the command
1078a2553e36SBarry Smith    PetscLogEventRegister().
10795c6c1daeSBarry Smith 
10805c6c1daeSBarry Smith    Level: intermediate
10815c6c1daeSBarry Smith 
1082db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogFlops()`
10835c6c1daeSBarry Smith 
10845c6c1daeSBarry Smith M*/
10855c6c1daeSBarry Smith 
10865c6c1daeSBarry Smith /*@C
10875c6c1daeSBarry Smith   PetscLogEventGetId - Returns the event id when given the event name.
10885c6c1daeSBarry Smith 
10895c6c1daeSBarry Smith   Not Collective
10905c6c1daeSBarry Smith 
10915c6c1daeSBarry Smith   Input Parameter:
10925c6c1daeSBarry Smith . name  - The event name
10935c6c1daeSBarry Smith 
10945c6c1daeSBarry Smith   Output Parameter:
1095c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists
10965c6c1daeSBarry Smith 
10975c6c1daeSBarry Smith   Level: intermediate
10985c6c1daeSBarry Smith 
1099db781477SPatrick Sanan .seealso: `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogStageGetId()`
11005c6c1daeSBarry Smith @*/
11019371c9d4SSatish Balay PetscErrorCode PetscLogEventGetId(const char name[], PetscLogEvent *event) {
11025c6c1daeSBarry Smith   PetscStageLog stageLog;
11035c6c1daeSBarry Smith 
11045c6c1daeSBarry Smith   PetscFunctionBegin;
11059566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
11069566063dSJacob Faibussowitsch   PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, event));
11075c6c1daeSBarry Smith   PetscFunctionReturn(0);
11085c6c1daeSBarry Smith }
11095c6c1daeSBarry Smith 
11109371c9d4SSatish Balay PetscErrorCode PetscLogPushCurrentEvent_Internal(PetscLogEvent event) {
11117a101e5eSJacob Faibussowitsch   PetscFunctionBegin;
11127a101e5eSJacob Faibussowitsch   PetscCall(PetscIntStackPush(current_log_event_stack, event));
11137a101e5eSJacob Faibussowitsch   PetscFunctionReturn(0);
11147a101e5eSJacob Faibussowitsch }
11157a101e5eSJacob Faibussowitsch 
11169371c9d4SSatish Balay PetscErrorCode PetscLogPopCurrentEvent_Internal(void) {
11177a101e5eSJacob Faibussowitsch   PetscFunctionBegin;
11187a101e5eSJacob Faibussowitsch   PetscCall(PetscIntStackPop(current_log_event_stack, NULL));
11197a101e5eSJacob Faibussowitsch   PetscFunctionReturn(0);
11207a101e5eSJacob Faibussowitsch }
11217a101e5eSJacob Faibussowitsch 
11229371c9d4SSatish Balay PetscErrorCode PetscLogGetCurrentEvent_Internal(PetscLogEvent *event) {
11237a101e5eSJacob Faibussowitsch   PetscBool empty;
11247a101e5eSJacob Faibussowitsch 
11257a101e5eSJacob Faibussowitsch   PetscFunctionBegin;
11267a101e5eSJacob Faibussowitsch   PetscValidIntPointer(event, 1);
11277a101e5eSJacob Faibussowitsch   *event = PETSC_DECIDE;
11287a101e5eSJacob Faibussowitsch   PetscCall(PetscIntStackEmpty(current_log_event_stack, &empty));
11297a101e5eSJacob Faibussowitsch   if (!empty) PetscCall(PetscIntStackTop(current_log_event_stack, event));
11307a101e5eSJacob Faibussowitsch   PetscFunctionReturn(0);
11317a101e5eSJacob Faibussowitsch }
11327a101e5eSJacob Faibussowitsch 
11339371c9d4SSatish Balay PetscErrorCode PetscLogEventPause_Internal(PetscLogEvent event) {
11347a101e5eSJacob Faibussowitsch   PetscFunctionBegin;
11357a101e5eSJacob Faibussowitsch   if (event != PETSC_DECIDE) PetscCall(PetscLogEventEnd(event, NULL, NULL, NULL, NULL));
11367a101e5eSJacob Faibussowitsch   PetscFunctionReturn(0);
11377a101e5eSJacob Faibussowitsch }
11387a101e5eSJacob Faibussowitsch 
11399371c9d4SSatish Balay PetscErrorCode PetscLogEventResume_Internal(PetscLogEvent event) {
11407a101e5eSJacob Faibussowitsch   PetscStageLog     stageLog;
11417a101e5eSJacob Faibussowitsch   PetscEventPerfLog eventLog;
11427a101e5eSJacob Faibussowitsch   int               stage;
11437a101e5eSJacob Faibussowitsch 
11447a101e5eSJacob Faibussowitsch   PetscFunctionBegin;
11457a101e5eSJacob Faibussowitsch   if (event == PETSC_DECIDE) PetscFunctionReturn(0);
11467a101e5eSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(event, NULL, NULL, NULL, NULL));
11477a101e5eSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
11487a101e5eSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
11497a101e5eSJacob Faibussowitsch   PetscCall(PetscStageLogGetEventPerfLog(stageLog, stage, &eventLog));
11507a101e5eSJacob Faibussowitsch   eventLog->eventInfo[event].count--;
11517a101e5eSJacob Faibussowitsch   PetscFunctionReturn(0);
11527a101e5eSJacob Faibussowitsch }
11537a101e5eSJacob Faibussowitsch 
11545c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/
11555c6c1daeSBarry Smith /*@C
11565c6c1daeSBarry Smith   PetscLogDump - Dumps logs of objects to a file. This file is intended to
11575c6c1daeSBarry Smith   be read by bin/petscview. This program no longer exists.
11585c6c1daeSBarry Smith 
11595c6c1daeSBarry Smith   Collective on PETSC_COMM_WORLD
11605c6c1daeSBarry Smith 
11615c6c1daeSBarry Smith   Input Parameter:
11625c6c1daeSBarry Smith . name - an optional file name
11635c6c1daeSBarry Smith 
11645c6c1daeSBarry Smith   Usage:
11655c6c1daeSBarry Smith .vb
11665c6c1daeSBarry Smith      PetscInitialize(...);
1167bb1d7374SBarry Smith      PetscLogDefaultBegin(); or PetscLogAllBegin();
11685c6c1daeSBarry Smith      ... code ...
11695c6c1daeSBarry Smith      PetscLogDump(filename);
11705c6c1daeSBarry Smith      PetscFinalize();
11715c6c1daeSBarry Smith .ve
11725c6c1daeSBarry Smith 
11735c6c1daeSBarry Smith   Notes:
11745c6c1daeSBarry Smith   The default file name is
11755c6c1daeSBarry Smith $    Log.<rank>
11765c6c1daeSBarry Smith   where <rank> is the processor number. If no name is specified,
11775c6c1daeSBarry Smith   this file will be used.
11785c6c1daeSBarry Smith 
11795c6c1daeSBarry Smith   Level: advanced
11805c6c1daeSBarry Smith 
1181db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogView()`
11825c6c1daeSBarry Smith @*/
11839371c9d4SSatish Balay PetscErrorCode PetscLogDump(const char sname[]) {
11845c6c1daeSBarry Smith   PetscStageLog       stageLog;
11855c6c1daeSBarry Smith   PetscEventPerfInfo *eventInfo;
11865c6c1daeSBarry Smith   FILE               *fd;
11875c6c1daeSBarry Smith   char                file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN];
11885c6c1daeSBarry Smith   PetscLogDouble      flops, _TotalTime;
11895c6c1daeSBarry Smith   PetscMPIInt         rank;
11905c6c1daeSBarry Smith   int                 action, object, curStage;
11915c6c1daeSBarry Smith   PetscLogEvent       event;
11925c6c1daeSBarry Smith 
11935c6c1daeSBarry Smith   PetscFunctionBegin;
11945c6c1daeSBarry Smith   /* Calculate the total elapsed time */
11958563dfccSBarry Smith   PetscTime(&_TotalTime);
11965c6c1daeSBarry Smith   _TotalTime -= petsc_BaseTime;
11975c6c1daeSBarry Smith   /* Open log file */
11989566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank));
11997ff663adSLisandro Dalcin   if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank);
1200a297a907SKarl Rupp   else sprintf(file, "Log.%d", rank);
12019566063dSJacob Faibussowitsch   PetscCall(PetscFixFilename(file, fname));
12029566063dSJacob Faibussowitsch   PetscCall(PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd));
120308401ef6SPierre Jolivet   PetscCheck(!(rank == 0) || !(!fd), PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname);
12045c6c1daeSBarry Smith   /* Output totals */
12059566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime));
12069566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0));
12075c6c1daeSBarry Smith   /* Output actions */
12085c6c1daeSBarry Smith   if (petsc_logActions) {
12099566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions));
12105c6c1daeSBarry Smith     for (action = 0; action < petsc_numActions; action++) {
12119371c9d4SSatish 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,
1212d0609cedSBarry Smith                              petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem));
12135c6c1daeSBarry Smith     }
12145c6c1daeSBarry Smith   }
12155c6c1daeSBarry Smith   /* Output objects */
12165c6c1daeSBarry Smith   if (petsc_logObjects) {
12179566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed));
12185c6c1daeSBarry Smith     for (object = 0; object < petsc_numObjects; object++) {
12199566063dSJacob Faibussowitsch       PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int)petsc_objects[object].mem));
12205c6c1daeSBarry Smith       if (!petsc_objects[object].name[0]) {
12219566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "No Name\n"));
12225c6c1daeSBarry Smith       } else {
12239566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name));
12245c6c1daeSBarry Smith       }
12255c6c1daeSBarry Smith       if (petsc_objects[object].info[0] != 0) {
12269566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n"));
12275c6c1daeSBarry Smith       } else {
12289566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info));
12295c6c1daeSBarry Smith       }
12305c6c1daeSBarry Smith     }
12315c6c1daeSBarry Smith   }
12325c6c1daeSBarry Smith   /* Output events */
12339566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n"));
12349566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
12359566063dSJacob Faibussowitsch   PetscCall(PetscIntStackTop(stageLog->stack, &curStage));
12365c6c1daeSBarry Smith   eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo;
12375c6c1daeSBarry Smith   for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) {
1238a297a907SKarl Rupp     if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops / eventInfo[event].time;
1239a297a907SKarl Rupp     else flops = 0.0;
1240d0609cedSBarry Smith     PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count, eventInfo[event].flops, eventInfo[event].time, flops));
12415c6c1daeSBarry Smith   }
12429566063dSJacob Faibussowitsch   PetscCall(PetscFClose(PETSC_COMM_WORLD, fd));
12435c6c1daeSBarry Smith   PetscFunctionReturn(0);
12445c6c1daeSBarry Smith }
12455c6c1daeSBarry Smith 
1246f14045dbSBarry Smith /*
1247f14045dbSBarry Smith   PetscLogView_Detailed - Each process prints the times for its own events
1248f14045dbSBarry Smith 
1249f14045dbSBarry Smith */
12509371c9d4SSatish Balay PetscErrorCode PetscLogView_Detailed(PetscViewer viewer) {
12512dff6485SMatthew G. Knepley   PetscStageLog       stageLog;
1252217044c2SLisandro Dalcin   PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL;
1253217044c2SLisandro Dalcin   PetscLogDouble      locTotalTime, numRed, maxMem;
12542dff6485SMatthew G. Knepley   int                 numStages, numEvents, stage, event;
1255217044c2SLisandro Dalcin   MPI_Comm            comm = PetscObjectComm((PetscObject)viewer);
12562dff6485SMatthew G. Knepley   PetscMPIInt         rank, size;
1257f14045dbSBarry Smith 
1258f14045dbSBarry Smith   PetscFunctionBegin;
12599566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
12609566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
12612dff6485SMatthew G. Knepley   /* Must preserve reduction count before we go on */
12622dff6485SMatthew G. Knepley   numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
12632d1ec343SBarry Smith   /* Get the total elapsed time */
12649371c9d4SSatish Balay   PetscTime(&locTotalTime);
12659371c9d4SSatish Balay   locTotalTime -= petsc_BaseTime;
12669566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "size = %d\n", size));
12679566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "LocalTimes = {}\n"));
12689566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMessages = {}\n"));
12699566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMessageLens = {}\n"));
12709566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "LocalReductions = {}\n"));
12719566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "LocalFlop = {}\n"));
12729566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "LocalObjects = {}\n"));
12739566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMemory = {}\n"));
12749566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
12759566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm));
12769566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPrintf(viewer, "Stages = {}\n"));
12772d1ec343SBarry Smith   for (stage = 0; stage < numStages; stage++) {
12789566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"] = {}\n", stageLog->stageInfo[stage].name));
12799566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"][\"summary\"] = {}\n", stageLog->stageInfo[stage].name));
12809566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm));
1281*48a46eb9SPierre Jolivet     for (event = 0; event < numEvents; event++) PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"][\"%s\"] = {}\n", stageLog->stageInfo[stage].name, stageLog->eventLog->eventInfo[event].name));
12822d1ec343SBarry Smith   }
12839566063dSJacob Faibussowitsch   PetscCall(PetscMallocGetMaximumUsage(&maxMem));
12849566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPushSynchronized(viewer));
12859566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalTimes[%d] = %g\n", rank, locTotalTime));
12869566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMessages[%d] = %g\n", rank, (petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct)));
12879566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMessageLens[%d] = %g\n", rank, (petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len)));
12889566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalReductions[%d] = %g\n", rank, numRed));
12899566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalFlop[%d] = %g\n", rank, petsc_TotalFlops));
12909566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalObjects[%d] = %d\n", rank, petsc_numObjects));
12919566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMemory[%d] = %g\n", rank, maxMem));
12929566063dSJacob Faibussowitsch   PetscCall(PetscViewerFlush(viewer));
12932d1ec343SBarry Smith   for (stage = 0; stage < numStages; stage++) {
1294217044c2SLisandro Dalcin     stageInfo = &stageLog->stageInfo[stage].perfInfo;
12959371c9d4SSatish 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,
12969371c9d4SSatish Balay                                                  stageInfo->numMessages, stageInfo->messageLength, stageInfo->numReductions, stageInfo->flops));
12979566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm));
12982d1ec343SBarry Smith     for (event = 0; event < numEvents; event++) {
1299217044c2SLisandro Dalcin       eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event];
1300d0609cedSBarry Smith       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %d, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g",
13019371c9d4SSatish Balay                                                    stageLog->stageInfo[stage].name, stageLog->eventLog->eventInfo[event].name, rank, eventInfo->count, eventInfo->time, eventInfo->syncTime, eventInfo->numMessages, eventInfo->messageLength, eventInfo->numReductions,
13029371c9d4SSatish Balay                                                    eventInfo->flops));
1303891e75beSMatthew G. Knepley       if (eventInfo->dof[0] >= 0.) {
1304891e75beSMatthew G. Knepley         PetscInt d, e;
13055d68e14cSMatthew G. Knepley 
13069566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : ["));
1307891e75beSMatthew G. Knepley         for (d = 0; d < 8; ++d) {
13089566063dSJacob Faibussowitsch           if (d > 0) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", "));
13099566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d]));
1310891e75beSMatthew G. Knepley         }
13119566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "]"));
13129566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : ["));
13135d68e14cSMatthew G. Knepley         for (e = 0; e < 8; ++e) {
13149566063dSJacob Faibussowitsch           if (e > 0) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", "));
13159566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e]));
13165d68e14cSMatthew G. Knepley         }
13179566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "]"));
13185d68e14cSMatthew G. Knepley       }
13199566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "}\n"));
13202d1ec343SBarry Smith     }
13212d1ec343SBarry Smith   }
13229566063dSJacob Faibussowitsch   PetscCall(PetscViewerFlush(viewer));
13239566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPopSynchronized(viewer));
1324f14045dbSBarry Smith   PetscFunctionReturn(0);
1325f14045dbSBarry Smith }
1326f14045dbSBarry Smith 
132738144912Sdeepblu2718 /*
132838144912Sdeepblu2718   PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format
132938144912Sdeepblu2718 */
13309371c9d4SSatish Balay PetscErrorCode PetscLogView_CSV(PetscViewer viewer) {
133138144912Sdeepblu2718   PetscStageLog       stageLog;
1332669c5be0SSatish Balay   PetscEventPerfInfo *eventInfo = NULL;
133338144912Sdeepblu2718   PetscLogDouble      locTotalTime, maxMem;
133438144912Sdeepblu2718   int                 numStages, numEvents, stage, event;
133538144912Sdeepblu2718   MPI_Comm            comm = PetscObjectComm((PetscObject)viewer);
133638144912Sdeepblu2718   PetscMPIInt         rank, size;
133738144912Sdeepblu2718 
133838144912Sdeepblu2718   PetscFunctionBegin;
13399566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
13409566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
134138144912Sdeepblu2718   /* Must preserve reduction count before we go on */
134238144912Sdeepblu2718   /* Get the total elapsed time */
13439371c9d4SSatish Balay   PetscTime(&locTotalTime);
13449371c9d4SSatish Balay   locTotalTime -= petsc_BaseTime;
13459566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
13469566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm));
13479566063dSJacob Faibussowitsch   PetscCall(PetscMallocGetMaximumUsage(&maxMem));
13489566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPushSynchronized(viewer));
1349d0609cedSBarry 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));
13509566063dSJacob Faibussowitsch   PetscCall(PetscViewerFlush(viewer));
135138144912Sdeepblu2718   for (stage = 0; stage < numStages; stage++) {
13529e29573dSMatthew G. Knepley     PetscEventPerfInfo *stageInfo = &stageLog->stageInfo[stage].perfInfo;
13539e29573dSMatthew G. Knepley 
13549371c9d4SSatish 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));
13559566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm));
135638144912Sdeepblu2718     for (event = 0; event < numEvents; event++) {
135738144912Sdeepblu2718       eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event];
13589371c9d4SSatish 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,
13599371c9d4SSatish Balay                                                    eventInfo->numReductions, eventInfo->flops));
136038144912Sdeepblu2718       if (eventInfo->dof[0] >= 0.) {
136138144912Sdeepblu2718         PetscInt d, e;
136238144912Sdeepblu2718 
1363*48a46eb9SPierre Jolivet         for (d = 0; d < 8; ++d) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d]));
1364*48a46eb9SPierre Jolivet         for (e = 0; e < 8; ++e) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e]));
136538144912Sdeepblu2718       }
13669566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n"));
136738144912Sdeepblu2718     }
136838144912Sdeepblu2718   }
13699566063dSJacob Faibussowitsch   PetscCall(PetscViewerFlush(viewer));
13709566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPopSynchronized(viewer));
137138144912Sdeepblu2718   PetscFunctionReturn(0);
137238144912Sdeepblu2718 }
137338144912Sdeepblu2718 
13749371c9d4SSatish Balay static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm, FILE *fd) {
1375217044c2SLisandro Dalcin   PetscFunctionBegin;
1376217044c2SLisandro Dalcin   if (!PetscLogSyncOn) PetscFunctionReturn(0);
13779566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n\n"));
13789566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n"));
13799566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
13809566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n"));
13819566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
13829566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   This program was run with logging synchronization.   #\n"));
13839566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   This option provides more meaningful imbalance       #\n"));
13849566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   figures at the expense of slowing things down and    #\n"));
13859566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   providing a distorted view of the overall runtime.   #\n"));
13869566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
13879566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n\n\n"));
1388217044c2SLisandro Dalcin   PetscFunctionReturn(0);
1389217044c2SLisandro Dalcin }
1390217044c2SLisandro Dalcin 
13919371c9d4SSatish Balay static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm, FILE *fd) {
1392f4091ad2SBarry Smith   PetscFunctionBegin;
139376bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
13949566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "\n\n"));
13959566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n"));
13969566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
13979566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n"));
13989566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
13999566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #   This code was compiled with a debugging option.      #\n"));
14009566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #   To get timing results run ./configure                #\n"));
14019566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #   using --with-debugging=no, the performance will      #\n"));
14029566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #   be generally two or three times faster.              #\n"));
14039566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
14049566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n\n\n"));
140576bd3646SJed Brown   }
1406f4091ad2SBarry Smith   PetscFunctionReturn(0);
1407f4091ad2SBarry Smith }
1408f4091ad2SBarry Smith 
14099371c9d4SSatish Balay static PetscErrorCode PetscLogViewWarnNoGpuAwareMpi(MPI_Comm comm, FILE *fd) {
1410009ab46cSJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
1411009ab46cSJunchao Zhang   PetscMPIInt size;
1412c2a741eeSJunchao Zhang 
1413c2a741eeSJunchao Zhang   PetscFunctionBegin;
14149566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
1415340fe3cdSSatish Balay   if (use_gpu_aware_mpi || size == 1) PetscFunctionReturn(0);
14169566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n\n"));
14179566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n"));
14189566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
14199566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n"));
14209566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
14219566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   This code was compiled with GPU support and you've   #\n"));
14229566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   created PETSc/GPU objects, but you intentionally     #\n"));
14239566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   used -use_gpu_aware_mpi 0, requiring PETSc to copy   #\n"));
14249566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   additional data between the GPU and CPU. To obtain   #\n"));
14259566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   meaningful timing results on multi-rank runs, use    #\n"));
14269566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #   GPU-aware MPI instead.                               #\n"));
14279566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
14289566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n\n\n"));
1429c2a741eeSJunchao Zhang   PetscFunctionReturn(0);
1430c2a741eeSJunchao Zhang #else
1431c2a741eeSJunchao Zhang   return 0;
1432c2a741eeSJunchao Zhang #endif
1433c2a741eeSJunchao Zhang }
1434c2a741eeSJunchao Zhang 
14359371c9d4SSatish Balay static PetscErrorCode PetscLogViewWarnGpuTime(MPI_Comm comm, FILE *fd) {
1436156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE)
1437156b51fbSBarry Smith 
1438156b51fbSBarry Smith   PetscFunctionBegin;
1439156b51fbSBarry Smith   if (!PetscLogGpuTimeFlag || petsc_gflops == 0) PetscFunctionReturn(0);
1440156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "\n\n"));
1441156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n"));
1442156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
1443156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n"));
1444156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
1445156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #   This code was run with -log_view_gpu_time            #\n"));
1446156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #   This provides accurate timing within the GPU kernels #\n"));
1447156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #   but can slow down the entire computation by a        #\n"));
1448156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #   measurable amount. For fastest runs we recommend     #\n"));
1449156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #   not using this option.                               #\n"));
1450156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      #                                                        #\n"));
1451156b51fbSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "      ##########################################################\n\n\n"));
1452156b51fbSBarry Smith   PetscFunctionReturn(0);
1453156b51fbSBarry Smith #else
1454156b51fbSBarry Smith   return 0;
1455156b51fbSBarry Smith #endif
1456156b51fbSBarry Smith }
1457156b51fbSBarry Smith 
14589371c9d4SSatish Balay PetscErrorCode PetscLogView_Default(PetscViewer viewer) {
14595c6c1daeSBarry Smith   FILE               *fd;
14605c6c1daeSBarry Smith   PetscLogDouble      zero = 0.0;
14615c6c1daeSBarry Smith   PetscStageLog       stageLog;
14620298fd71SBarry Smith   PetscStageInfo     *stageInfo = NULL;
14630298fd71SBarry Smith   PetscEventPerfInfo *eventInfo = NULL;
14645c6c1daeSBarry Smith   PetscClassPerfInfo *classInfo;
14655c6c1daeSBarry Smith   char                arch[128], hostname[128], username[128], pname[PETSC_MAX_PATH_LEN], date[128];
14665c6c1daeSBarry Smith   const char         *name;
14675c6c1daeSBarry Smith   PetscLogDouble      locTotalTime, TotalTime, TotalFlops;
14685c6c1daeSBarry Smith   PetscLogDouble      numMessages, messageLength, avgMessLen, numReductions;
14695c6c1daeSBarry Smith   PetscLogDouble      stageTime, flops, flopr, mem, mess, messLen, red;
14705c6c1daeSBarry Smith   PetscLogDouble      fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed;
14715c6c1daeSBarry Smith   PetscLogDouble      fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed;
14725c6c1daeSBarry Smith   PetscLogDouble      min, max, tot, ratio, avg, x, y;
1473e3ed9ee7SBarry Smith   PetscLogDouble      minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr, mal, malmax, emalmax;
1474d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
1475156b51fbSBarry Smith   PetscLogEvent  KSP_Solve, SNES_Solve, TS_Step, TAO_Solve; /* These need to be fixed to be some events registered with certain objects */
1476958c4211Shannah_mairs   PetscLogDouble cct, gct, csz, gsz, gmaxt, gflops, gflopr, fracgflops;
1477bec0b493Shannah_mairs #endif
1478217044c2SLisandro Dalcin   PetscMPIInt    minC, maxC;
14795c6c1daeSBarry Smith   PetscMPIInt    size, rank;
14805c6c1daeSBarry Smith   PetscBool     *localStageUsed, *stageUsed;
14815c6c1daeSBarry Smith   PetscBool     *localStageVisible, *stageVisible;
14825c6c1daeSBarry Smith   int            numStages, localNumEvents, numEvents;
148337b78d16SBarry Smith   int            stage, oclass;
14845c6c1daeSBarry Smith   PetscLogEvent  event;
1485d0609cedSBarry Smith   PetscErrorCode ierr = 0;
14865c6c1daeSBarry Smith   char           version[256];
14875c6c1daeSBarry Smith   MPI_Comm       comm;
1488156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE)
1489156b51fbSBarry Smith   PetscLogEvent eventid;
1490156b51fbSBarry Smith   PetscInt64    nas = 0x7FF0000000000002;
1491156b51fbSBarry Smith #endif
14925c6c1daeSBarry Smith 
14935c6c1daeSBarry Smith   PetscFunctionBegin;
1494156b51fbSBarry Smith   PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF));
14959566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetComm((PetscObject)viewer, &comm));
14969566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIGetPointer(viewer, &fd));
14979566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(comm, &size));
14989566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(comm, &rank));
14995c6c1daeSBarry Smith   /* Get the total elapsed time */
15009371c9d4SSatish Balay   PetscTime(&locTotalTime);
15019371c9d4SSatish Balay   locTotalTime -= petsc_BaseTime;
15025c6c1daeSBarry Smith 
1503faad7b01SPierre Jolivet   PetscCall(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n"));
15049566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "***                                WIDEN YOUR WINDOW TO 160 CHARACTERS.  Use 'enscript -r -fCourier9' to print this document                                 ***\n"));
15059566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n"));
1506faad7b01SPierre Jolivet   PetscCall(PetscFPrintf(comm, fd, "\n------------------------------------------------------------------ PETSc Performance Summary: ------------------------------------------------------------------\n\n"));
15079566063dSJacob Faibussowitsch   PetscCall(PetscLogViewWarnSync(comm, fd));
15089566063dSJacob Faibussowitsch   PetscCall(PetscLogViewWarnDebugging(comm, fd));
15099566063dSJacob Faibussowitsch   PetscCall(PetscLogViewWarnNoGpuAwareMpi(comm, fd));
1510156b51fbSBarry Smith   PetscCall(PetscLogViewWarnGpuTime(comm, fd));
15119566063dSJacob Faibussowitsch   PetscCall(PetscGetArchType(arch, sizeof(arch)));
15129566063dSJacob Faibussowitsch   PetscCall(PetscGetHostName(hostname, sizeof(hostname)));
15139566063dSJacob Faibussowitsch   PetscCall(PetscGetUserName(username, sizeof(username)));
15149566063dSJacob Faibussowitsch   PetscCall(PetscGetProgramName(pname, sizeof(pname)));
15159566063dSJacob Faibussowitsch   PetscCall(PetscGetDate(date, sizeof(date)));
15169566063dSJacob Faibussowitsch   PetscCall(PetscGetVersion(version, sizeof(version)));
15175c6c1daeSBarry Smith   if (size == 1) {
15189566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "%s on a %s named %s with %d processor, by %s %s\n", pname, arch, hostname, size, username, date));
15195c6c1daeSBarry Smith   } else {
15209566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "%s on a %s named %s with %d processors, by %s %s\n", pname, arch, hostname, size, username, date));
15215c6c1daeSBarry Smith   }
1522f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP)
15239566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Using %" PetscInt_FMT " OpenMP threads\n", PetscNumOMPThreads));
1524f90b075cSBarry Smith #endif
15259566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Using %s\n", version));
15265c6c1daeSBarry Smith 
15275c6c1daeSBarry Smith   /* Must preserve reduction count before we go on */
15285c6c1daeSBarry Smith   red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
15295c6c1daeSBarry Smith 
15305c6c1daeSBarry Smith   /* Calculate summary information */
15319566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n                         Max       Max/Min     Avg       Total\n"));
15325c6c1daeSBarry Smith   /*   Time */
15339566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15349566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15359566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1536217044c2SLisandro Dalcin   avg = tot / ((PetscLogDouble)size);
15379371c9d4SSatish Balay   if (min != 0.0) ratio = max / min;
15389371c9d4SSatish Balay   else ratio = 0.0;
15399566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Time (sec):           %5.3e   %7.3f   %5.3e\n", max, ratio, avg));
15405c6c1daeSBarry Smith   TotalTime = tot;
15415c6c1daeSBarry Smith   /*   Objects */
15425c6c1daeSBarry Smith   avg       = (PetscLogDouble)petsc_numObjects;
15439566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15449566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15459566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1546217044c2SLisandro Dalcin   avg = tot / ((PetscLogDouble)size);
15479371c9d4SSatish Balay   if (min != 0.0) ratio = max / min;
15489371c9d4SSatish Balay   else ratio = 0.0;
15499566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Objects:              %5.3e   %7.3f   %5.3e\n", max, ratio, avg));
15505c6c1daeSBarry Smith   /*   Flops */
15519566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15529566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15539566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1554217044c2SLisandro Dalcin   avg = tot / ((PetscLogDouble)size);
15559371c9d4SSatish Balay   if (min != 0.0) ratio = max / min;
15569371c9d4SSatish Balay   else ratio = 0.0;
15579566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Flops:                %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
15585c6c1daeSBarry Smith   TotalFlops = tot;
15595c6c1daeSBarry Smith   /*   Flops/sec -- Must talk to Barry here */
15609371c9d4SSatish Balay   if (locTotalTime != 0.0) flops = petsc_TotalFlops / locTotalTime;
15619371c9d4SSatish Balay   else flops = 0.0;
15629566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15639566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15649566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1565217044c2SLisandro Dalcin   avg = tot / ((PetscLogDouble)size);
15669371c9d4SSatish Balay   if (min != 0.0) ratio = max / min;
15679371c9d4SSatish Balay   else ratio = 0.0;
15689566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Flops/sec:            %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
15695c6c1daeSBarry Smith   /*   Memory */
15709566063dSJacob Faibussowitsch   PetscCall(PetscMallocGetMaximumUsage(&mem));
15715c6c1daeSBarry Smith   if (mem > 0.0) {
15729566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15739566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15749566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1575217044c2SLisandro Dalcin     avg = tot / ((PetscLogDouble)size);
15769371c9d4SSatish Balay     if (min != 0.0) ratio = max / min;
15779371c9d4SSatish Balay     else ratio = 0.0;
15789566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "Memory (bytes):       %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
15795c6c1daeSBarry Smith   }
15805c6c1daeSBarry Smith   /*   Messages */
15815c6c1daeSBarry Smith   mess = 0.5 * (petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct);
15829566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15839566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15849566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1585217044c2SLisandro Dalcin   avg = tot / ((PetscLogDouble)size);
15869371c9d4SSatish Balay   if (min != 0.0) ratio = max / min;
15879371c9d4SSatish Balay   else ratio = 0.0;
15889566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "MPI Msg Count:        %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
15895c6c1daeSBarry Smith   numMessages = tot;
15905c6c1daeSBarry Smith   /*   Message Lengths */
15915c6c1daeSBarry Smith   mess        = 0.5 * (petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len);
15929566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15939566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15949566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
15959371c9d4SSatish Balay   if (numMessages != 0) avg = tot / numMessages;
15969371c9d4SSatish Balay   else avg = 0.0;
15979371c9d4SSatish Balay   if (min != 0.0) ratio = max / min;
15989371c9d4SSatish Balay   else ratio = 0.0;
15999566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "MPI Msg Len (bytes):  %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
16005c6c1daeSBarry Smith   messageLength = tot;
16015c6c1daeSBarry Smith   /*   Reductions */
16029566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
16039566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
16049566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16059371c9d4SSatish Balay   if (min != 0.0) ratio = max / min;
16069371c9d4SSatish Balay   else ratio = 0.0;
16079566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "MPI Reductions:       %5.3e   %7.3f\n", max, ratio));
16085c6c1daeSBarry Smith   numReductions = red; /* wrong because uses count from process zero */
16099566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n"));
16109566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "                            e.g., VecAXPY() for real vectors of length N --> 2N flops\n"));
16119566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "                            and VecAXPY() for complex vectors of length N --> 8N flops\n"));
16125c6c1daeSBarry Smith 
16135c6c1daeSBarry Smith   /* Get total number of stages --
16145c6c1daeSBarry Smith        Currently, a single processor can register more stages than another, but stages must all be registered in order.
16155c6c1daeSBarry Smith        We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID.
16165c6c1daeSBarry Smith        This seems best accomplished by assoicating a communicator with each stage.
16175c6c1daeSBarry Smith   */
16189566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
16199566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm));
16209566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(numStages, &localStageUsed));
16219566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(numStages, &stageUsed));
16229566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(numStages, &localStageVisible));
16239566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(numStages, &stageVisible));
16245c6c1daeSBarry Smith   if (numStages > 0) {
16255c6c1daeSBarry Smith     stageInfo = stageLog->stageInfo;
16265c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
16275c6c1daeSBarry Smith       if (stage < stageLog->numStages) {
16285c6c1daeSBarry Smith         localStageUsed[stage]    = stageInfo[stage].used;
16295c6c1daeSBarry Smith         localStageVisible[stage] = stageInfo[stage].perfInfo.visible;
16305c6c1daeSBarry Smith       } else {
16315c6c1daeSBarry Smith         localStageUsed[stage]    = PETSC_FALSE;
16325c6c1daeSBarry Smith         localStageVisible[stage] = PETSC_TRUE;
16335c6c1daeSBarry Smith       }
16345c6c1daeSBarry Smith     }
16359566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm));
16369566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm));
16375c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
16385c6c1daeSBarry Smith       if (stageUsed[stage]) {
16399566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(comm, fd, "\nSummary of Stages:   ----- Time ------  ----- Flop ------  --- Messages ---  -- Message Lengths --  -- Reductions --\n"));
16409566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(comm, fd, "                        Avg     %%Total     Avg     %%Total    Count   %%Total     Avg         %%Total    Count   %%Total\n"));
16415c6c1daeSBarry Smith         break;
16425c6c1daeSBarry Smith       }
16435c6c1daeSBarry Smith     }
16445c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
16455c6c1daeSBarry Smith       if (!stageUsed[stage]) continue;
1646820f2d46SBarry Smith       /* CANNOT use MPI_Allreduce() since it might fail the line number check */
16475c6c1daeSBarry Smith       if (localStageUsed[stage]) {
16489566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16499566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16509566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16519566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16529566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16535c6c1daeSBarry Smith         name = stageInfo[stage].name;
16545c6c1daeSBarry Smith       } else {
16559566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16569566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16579566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16589566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16599566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16605c6c1daeSBarry Smith         name = "";
16615c6c1daeSBarry Smith       }
16629371c9d4SSatish Balay       mess *= 0.5;
16639371c9d4SSatish Balay       messLen *= 0.5;
16649371c9d4SSatish Balay       red /= size;
16659371c9d4SSatish Balay       if (TotalTime != 0.0) fracTime = stageTime / TotalTime;
16669371c9d4SSatish Balay       else fracTime = 0.0;
16679371c9d4SSatish Balay       if (TotalFlops != 0.0) fracFlops = flops / TotalFlops;
16689371c9d4SSatish Balay       else fracFlops = 0.0;
16695c6c1daeSBarry Smith       /* Talk to Barry if (stageTime     != 0.0) flops          = (size*flops)/stageTime; else flops          = 0.0; */
16709371c9d4SSatish Balay       if (numMessages != 0.0) fracMessages = mess / numMessages;
16719371c9d4SSatish Balay       else fracMessages = 0.0;
16729371c9d4SSatish Balay       if (mess != 0.0) avgMessLen = messLen / mess;
16739371c9d4SSatish Balay       else avgMessLen = 0.0;
16749371c9d4SSatish Balay       if (messageLength != 0.0) fracLength = messLen / messageLength;
16759371c9d4SSatish Balay       else fracLength = 0.0;
16769371c9d4SSatish Balay       if (numReductions != 0.0) fracReductions = red / numReductions;
16779371c9d4SSatish Balay       else fracReductions = 0.0;
16789371c9d4SSatish 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));
16795c6c1daeSBarry Smith     }
16805c6c1daeSBarry Smith   }
16815c6c1daeSBarry Smith 
16829566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n------------------------------------------------------------------------------------------------------------------------\n"));
16839566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n"));
16849566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Phase summary info:\n"));
16859566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   Count: number of times phase was executed\n"));
16869566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   Time and Flop: Max - maximum over all processors\n"));
16879566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "                  Ratio - ratio of maximum to minimum over all processors\n"));
16889566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   Mess: number of messages sent\n"));
16899566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   AvgLen: average message length (bytes)\n"));
16909566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   Reduct: number of global reductions\n"));
16919566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   Global: entire computation\n"));
16929566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n"));
16939566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      %%T - percent time in this phase         %%F - percent flop in this phase\n"));
16949566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      %%M - percent messages in this phase     %%L - percent message lengths in this phase\n"));
16959566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "      %%R - percent reductions in this phase\n"));
16969566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n"));
1697e3ed9ee7SBarry Smith   if (PetscLogMemory) {
169854aabf2dSBarry Smith     PetscCall(PetscFPrintf(comm, fd, "   Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event). May be negative\n"));
169954aabf2dSBarry Smith     PetscCall(PetscFPrintf(comm, fd, "   EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events). Never negative\n"));
170054aabf2dSBarry Smith     PetscCall(PetscFPrintf(comm, fd, "   MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event). Never negative\n"));
17019566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "   RMI Mbytes: Increase in resident memory (sum over all calls to event)\n"));
1702e3ed9ee7SBarry Smith   }
1703d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
17049566063dSJacob 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"));
17059566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   CpuToGpu Count: total number of CPU to GPU copies per processor\n"));
17069566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   CpuToGpu Size (Mbytes): 10e-6 * (total size of CPU to GPU copies per processor)\n"));
17079566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   GpuToCpu Count: total number of GPU to CPU copies per processor\n"));
17089566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   GpuToCpu Size (Mbytes): 10e-6 * (total size of GPU to CPU copies per processor)\n"));
17099566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   GPU %%F: percent flops on GPU in this event\n"));
1710bec0b493Shannah_mairs #endif
17119566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n"));
17125c6c1daeSBarry Smith 
17139566063dSJacob Faibussowitsch   PetscCall(PetscLogViewWarnDebugging(comm, fd));
17145c6c1daeSBarry Smith 
17155c6c1daeSBarry Smith   /* Report events */
17169566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Event                Count      Time (sec)     Flop                              --- Global ---  --- Stage ----  Total"));
1717*48a46eb9SPierre Jolivet   if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, "  Malloc EMalloc MMalloc RMI"));
1718d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
17199566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "   GPU    - CpuToGpu -   - GpuToCpu - GPU"));
1720bec0b493Shannah_mairs #endif
17219566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n"));
17229566063dSJacob 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"));
1723*48a46eb9SPierre Jolivet   if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, " Mbytes Mbytes Mbytes Mbytes"));
1724d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
17259566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, " Mflop/s Count   Size   Count   Size  %%F"));
1726bec0b493Shannah_mairs #endif
17279566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n"));
17289566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------"));
1729*48a46eb9SPierre Jolivet   if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, "-----------------------------"));
1730d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
17319566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "---------------------------------------"));
17324863603aSSatish Balay #endif
17339566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n"));
17345c6c1daeSBarry Smith 
1735156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE)
1736156b51fbSBarry Smith   /* this indirect way of accessing these values is needed when PETSc is build with multiple libraries since the symbols are not in libpetscsys */
1737156b51fbSBarry Smith   PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "TAOSolve", &TAO_Solve));
1738156b51fbSBarry Smith   PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "TSStep", &TS_Step));
1739156b51fbSBarry Smith   PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "SNESSolve", &SNES_Solve));
1740156b51fbSBarry Smith   PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "KSPSolve", &KSP_Solve));
1741156b51fbSBarry Smith #endif
1742156b51fbSBarry Smith 
17435c6c1daeSBarry Smith   /* Problem: The stage name will not show up unless the stage executed on proc 1 */
17445c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
17455c6c1daeSBarry Smith     if (!stageVisible[stage]) continue;
1746820f2d46SBarry Smith     /* CANNOT use MPI_Allreduce() since it might fail the line number check */
17475c6c1daeSBarry Smith     if (localStageUsed[stage]) {
17489566063dSJacob Faibussowitsch       PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name));
17499566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17509566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17519566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17529566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17539566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17545c6c1daeSBarry Smith     } else {
17559566063dSJacob Faibussowitsch       PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage));
17569566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17579566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17589566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17599566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17609566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17615c6c1daeSBarry Smith     }
17629371c9d4SSatish Balay     mess *= 0.5;
17639371c9d4SSatish Balay     messLen *= 0.5;
17649371c9d4SSatish Balay     red /= size;
17655c6c1daeSBarry Smith 
17665c6c1daeSBarry Smith     /* Get total number of events in this stage --
17675c6c1daeSBarry Smith        Currently, a single processor can register more events than another, but events must all be registered in order,
17685c6c1daeSBarry Smith        just like stages. We can removed this requirement if necessary by having a global event numbering and indirection
1769217044c2SLisandro Dalcin        on the event ID. This seems best accomplished by associating a communicator with each stage.
17705c6c1daeSBarry Smith 
17715c6c1daeSBarry Smith        Problem: If the event did not happen on proc 1, its name will not be available.
17725c6c1daeSBarry Smith        Problem: Event visibility is not implemented
17735c6c1daeSBarry Smith     */
17745c6c1daeSBarry Smith     if (localStageUsed[stage]) {
17755c6c1daeSBarry Smith       eventInfo      = stageLog->stageInfo[stage].eventLog->eventInfo;
17765c6c1daeSBarry Smith       localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents;
1777a297a907SKarl Rupp     } else localNumEvents = 0;
17789566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm));
17795c6c1daeSBarry Smith     for (event = 0; event < numEvents; event++) {
1780820f2d46SBarry Smith       /* CANNOT use MPI_Allreduce() since it might fail the line number check */
17815c6c1daeSBarry Smith       if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) {
17829371c9d4SSatish Balay         if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops;
17839371c9d4SSatish Balay         else flopr = 0.0;
17849566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
17859566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
17869566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17879566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
17889566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
17899566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17909566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17919566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17929566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17939566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].count, &minC, 1, MPI_INT, MPI_MIN, comm));
17949566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].count, &maxC, 1, MPI_INT, MPI_MAX, comm));
1795e3ed9ee7SBarry Smith         if (PetscLogMemory) {
17969566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Allreduce(&eventInfo[event].memIncrease, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17979566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocSpace, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17989566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocIncrease, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17999566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1800e3ed9ee7SBarry Smith         }
1801d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
18029566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].CpuToGpuCount, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18039566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuToCpuCount, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18049566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].CpuToGpuSize, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18059566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuToCpuSize, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18069566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuFlops, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18079566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuTime, &gmaxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1808bec0b493Shannah_mairs #endif
18095c6c1daeSBarry Smith         name = stageLog->eventLog->eventInfo[event].name;
18105c6c1daeSBarry Smith       } else {
18115c6c1daeSBarry Smith         flopr = 0.0;
18129566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
18139566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
18149566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18159566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
18169566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
18179566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18189566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18199566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18209566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18219566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&ierr, &minC, 1, MPI_INT, MPI_MIN, comm));
18229566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&ierr, &maxC, 1, MPI_INT, MPI_MAX, comm));
1823e3ed9ee7SBarry Smith         if (PetscLogMemory) {
18249566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Allreduce(&zero, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18259566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Allreduce(&zero, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18269566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Allreduce(&zero, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18279566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Allreduce(&zero, &emalmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1828e3ed9ee7SBarry Smith         }
1829d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
18309566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18319566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18329566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18339566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18349566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
18359566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Allreduce(&zero, &gmaxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1836bec0b493Shannah_mairs #endif
18375c6c1daeSBarry Smith         name = "";
18385c6c1daeSBarry Smith       }
18395c6c1daeSBarry Smith       if (mint < 0.0) {
1840d0609cedSBarry 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));
18415c6c1daeSBarry Smith         mint = 0;
18425c6c1daeSBarry Smith       }
184308401ef6SPierre 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);
1844156b51fbSBarry Smith /* Put NaN into the time for all events that may not be time accurately since they may happen asynchronously on the GPU */
1845156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE)
1846156b51fbSBarry Smith       if (!PetscLogGpuTimeFlag && petsc_gflops > 0) {
1847156b51fbSBarry Smith         memcpy(&gmaxt, &nas, sizeof(PetscLogDouble));
1848156b51fbSBarry Smith         PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, &eventid));
1849156b51fbSBarry Smith         if (eventid != SNES_Solve && eventid != KSP_Solve && eventid != TS_Step && eventid != TAO_Solve) {
1850156b51fbSBarry Smith           memcpy(&mint, &nas, sizeof(PetscLogDouble));
1851156b51fbSBarry Smith           memcpy(&maxt, &nas, sizeof(PetscLogDouble));
1852156b51fbSBarry Smith         }
1853156b51fbSBarry Smith       }
1854156b51fbSBarry Smith #endif
18559371c9d4SSatish Balay       totm *= 0.5;
18569371c9d4SSatish Balay       totml *= 0.5;
18579371c9d4SSatish Balay       totr /= size;
18585c6c1daeSBarry Smith 
1859217044c2SLisandro Dalcin       if (maxC != 0) {
18609371c9d4SSatish Balay         if (minC != 0) ratC = ((PetscLogDouble)maxC) / minC;
18619371c9d4SSatish Balay         else ratC = 0.0;
18629371c9d4SSatish Balay         if (mint != 0.0) ratt = maxt / mint;
18639371c9d4SSatish Balay         else ratt = 0.0;
18649371c9d4SSatish Balay         if (minf != 0.0) ratf = maxf / minf;
18659371c9d4SSatish Balay         else ratf = 0.0;
18669371c9d4SSatish Balay         if (TotalTime != 0.0) fracTime = tott / TotalTime;
18679371c9d4SSatish Balay         else fracTime = 0.0;
18689371c9d4SSatish Balay         if (TotalFlops != 0.0) fracFlops = totf / TotalFlops;
18699371c9d4SSatish Balay         else fracFlops = 0.0;
18709371c9d4SSatish Balay         if (stageTime != 0.0) fracStageTime = tott / stageTime;
18719371c9d4SSatish Balay         else fracStageTime = 0.0;
18729371c9d4SSatish Balay         if (flops != 0.0) fracStageFlops = totf / flops;
18739371c9d4SSatish Balay         else fracStageFlops = 0.0;
18749371c9d4SSatish Balay         if (numMessages != 0.0) fracMess = totm / numMessages;
18759371c9d4SSatish Balay         else fracMess = 0.0;
18769371c9d4SSatish Balay         if (messageLength != 0.0) fracMessLen = totml / messageLength;
18779371c9d4SSatish Balay         else fracMessLen = 0.0;
18789371c9d4SSatish Balay         if (numReductions != 0.0) fracRed = totr / numReductions;
18799371c9d4SSatish Balay         else fracRed = 0.0;
18809371c9d4SSatish Balay         if (mess != 0.0) fracStageMess = totm / mess;
18819371c9d4SSatish Balay         else fracStageMess = 0.0;
18829371c9d4SSatish Balay         if (messLen != 0.0) fracStageMessLen = totml / messLen;
18839371c9d4SSatish Balay         else fracStageMessLen = 0.0;
18849371c9d4SSatish Balay         if (red != 0.0) fracStageRed = totr / red;
18859371c9d4SSatish Balay         else fracStageRed = 0.0;
18869371c9d4SSatish Balay         if (totm != 0.0) totml /= totm;
18879371c9d4SSatish Balay         else totml = 0.0;
18889371c9d4SSatish Balay         if (maxt != 0.0) flopr = totf / maxt;
18899371c9d4SSatish Balay         else flopr = 0.0;
18909566063dSJacob Faibussowitsch         if (fracStageTime > 1.00) PetscCall(PetscFPrintf(comm, fd, "Warning -- total time of event greater than time of entire stage -- something is wrong with the timer\n"));
18919371c9d4SSatish Balay         PetscCall(PetscFPrintf(comm, fd, "%-16s %7d%4.1f %5.4e%4.1f %3.2e%4.1f %2.1e %2.1e %2.1e%3.0f%3.0f%3.0f%3.0f%3.0f %3.0f%3.0f%3.0f%3.0f%3.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));
1892*48a46eb9SPierre 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));
1893d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
18949371c9d4SSatish Balay         if (totf != 0.0) fracgflops = gflops / totf;
18959371c9d4SSatish Balay         else fracgflops = 0.0;
18969371c9d4SSatish Balay         if (gmaxt != 0.0) gflopr = gflops / gmaxt;
18979371c9d4SSatish Balay         else gflopr = 0.0;
18989566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(comm, fd, "   %5.0f   %4.0f %3.2e %4.0f %3.2e% 3.0f", PetscAbs(gflopr) / 1.0e6, cct / size, csz / (1.0e6 * size), gct / size, gsz / (1.0e6 * size), 100.0 * fracgflops));
1899bec0b493Shannah_mairs #endif
19009566063dSJacob Faibussowitsch         PetscCall(PetscFPrintf(comm, fd, "\n"));
19015c6c1daeSBarry Smith       }
19025c6c1daeSBarry Smith     }
19035c6c1daeSBarry Smith   }
19045c6c1daeSBarry Smith 
19055c6c1daeSBarry Smith   /* Memory usage and object creation */
19069566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------"));
1907*48a46eb9SPierre Jolivet   if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, "-----------------------------"));
1908d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
19099566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "---------------------------------------"));
19104863603aSSatish Balay #endif
19119566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n"));
19129566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n"));
19135c6c1daeSBarry Smith 
19145c6c1daeSBarry Smith   /* Right now, only stages on the first processor are reported here, meaning only objects associated with
19155c6c1daeSBarry Smith      the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then
19165c6c1daeSBarry Smith      stats for stages local to processor sets.
19175c6c1daeSBarry Smith   */
19185c6c1daeSBarry Smith   /* We should figure out the longest object name here (now 20 characters) */
19194851f57dSBarry Smith   PetscCall(PetscFPrintf(comm, fd, "Object Type          Creations   Destructions. Reports information only for process 0.\n"));
19205c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
19215c6c1daeSBarry Smith     if (localStageUsed[stage]) {
19225c6c1daeSBarry Smith       classInfo = stageLog->stageInfo[stage].classLog->classInfo;
19239566063dSJacob Faibussowitsch       PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name));
19245c6c1daeSBarry Smith       for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) {
19255c6c1daeSBarry Smith         if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) {
19264851f57dSBarry Smith           PetscCall(PetscFPrintf(comm, fd, "%20s %5d          %5d\n", stageLog->classLog->classInfo[oclass].name, classInfo[oclass].creations, classInfo[oclass].destructions));
19275c6c1daeSBarry Smith         }
19285c6c1daeSBarry Smith       }
19295c6c1daeSBarry Smith     } else {
1930cf019ec6SStefano Zampini       if (!localStageVisible[stage]) continue;
19319566063dSJacob Faibussowitsch       PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage));
19325c6c1daeSBarry Smith     }
19335c6c1daeSBarry Smith   }
19345c6c1daeSBarry Smith 
19359566063dSJacob Faibussowitsch   PetscCall(PetscFree(localStageUsed));
19369566063dSJacob Faibussowitsch   PetscCall(PetscFree(stageUsed));
19379566063dSJacob Faibussowitsch   PetscCall(PetscFree(localStageVisible));
19389566063dSJacob Faibussowitsch   PetscCall(PetscFree(stageVisible));
19395c6c1daeSBarry Smith 
19405c6c1daeSBarry Smith   /* Information unrelated to this particular run */
19419566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "========================================================================================================================\n"));
19428563dfccSBarry Smith   PetscTime(&y);
19438563dfccSBarry Smith   PetscTime(&x);
19449371c9d4SSatish Balay   PetscTime(&y);
19459371c9d4SSatish Balay   PetscTime(&y);
19469371c9d4SSatish Balay   PetscTime(&y);
19479371c9d4SSatish Balay   PetscTime(&y);
19489371c9d4SSatish Balay   PetscTime(&y);
19499371c9d4SSatish Balay   PetscTime(&y);
19509371c9d4SSatish Balay   PetscTime(&y);
19519371c9d4SSatish Balay   PetscTime(&y);
19529371c9d4SSatish Balay   PetscTime(&y);
19539371c9d4SSatish Balay   PetscTime(&y);
19549566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Average time to get PetscTime(): %g\n", (y - x) / 10.0));
19555c6c1daeSBarry Smith   /* MPI information */
19565c6c1daeSBarry Smith   if (size > 1) {
19575c6c1daeSBarry Smith     MPI_Status  status;
19585c6c1daeSBarry Smith     PetscMPIInt tag;
19595c6c1daeSBarry Smith     MPI_Comm    newcomm;
19605c6c1daeSBarry Smith 
19619566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Barrier(comm));
19628563dfccSBarry Smith     PetscTime(&x);
19639566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Barrier(comm));
19649566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Barrier(comm));
19659566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Barrier(comm));
19669566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Barrier(comm));
19679566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Barrier(comm));
19688563dfccSBarry Smith     PetscTime(&y);
19699566063dSJacob Faibussowitsch     PetscCall(PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y - x) / 5.0));
19709566063dSJacob Faibussowitsch     PetscCall(PetscCommDuplicate(comm, &newcomm, &tag));
19719566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Barrier(comm));
19725c6c1daeSBarry Smith     if (rank) {
19739566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Recv(NULL, 0, MPI_INT, rank - 1, tag, newcomm, &status));
19749566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Send(NULL, 0, MPI_INT, (rank + 1) % size, tag, newcomm));
19755c6c1daeSBarry Smith     } else {
19768563dfccSBarry Smith       PetscTime(&x);
19779566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Send(NULL, 0, MPI_INT, 1, tag, newcomm));
19789566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Recv(NULL, 0, MPI_INT, size - 1, tag, newcomm, &status));
19798563dfccSBarry Smith       PetscTime(&y);
19809566063dSJacob Faibussowitsch       PetscCall(PetscFPrintf(comm, fd, "Average time for zero size MPI_Send(): %g\n", (y - x) / size));
19815c6c1daeSBarry Smith     }
19829566063dSJacob Faibussowitsch     PetscCall(PetscCommDestroy(&newcomm));
19835c6c1daeSBarry Smith   }
19849566063dSJacob Faibussowitsch   PetscCall(PetscOptionsView(NULL, viewer));
19855c6c1daeSBarry Smith 
19865c6c1daeSBarry Smith   /* Machine and compile information */
19875c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS)
19889566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n"));
19895c6c1daeSBarry Smith #else
19909566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n"));
19915c6c1daeSBarry Smith #endif
1992217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES)
19939566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n"));
1994217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128)
19959566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n"));
1996217044c2SLisandro Dalcin #endif
19975c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
19989566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n"));
19995f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128)
20009566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n"));
20015c6c1daeSBarry Smith #endif
20025c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE)
20039566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Compiled with single precision matrices\n"));
20045c6c1daeSBarry Smith #else
20059566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n"));
20065c6c1daeSBarry Smith #endif
20079371c9d4SSatish 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)));
20085c6c1daeSBarry Smith 
20099566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "Configure options: %s", petscconfigureoptions));
20109566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "%s", petscmachineinfo));
20119566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "%s", petsccompilerinfo));
20129566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo));
20139566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "%s", petsclinkerinfo));
20145c6c1daeSBarry Smith 
20155c6c1daeSBarry Smith   /* Cleanup */
20169566063dSJacob Faibussowitsch   PetscCall(PetscFPrintf(comm, fd, "\n"));
20179566063dSJacob Faibussowitsch   PetscCall(PetscLogViewWarnNoGpuAwareMpi(comm, fd));
20189566063dSJacob Faibussowitsch   PetscCall(PetscLogViewWarnDebugging(comm, fd));
2019156b51fbSBarry Smith   PetscCall(PetscFPTrapPop());
20205c6c1daeSBarry Smith   PetscFunctionReturn(0);
20215c6c1daeSBarry Smith }
20225c6c1daeSBarry Smith 
20237d6c928cSSatish Balay /*@C
20247d6c928cSSatish Balay   PetscLogView - Prints a summary of the logging.
20255c6c1daeSBarry Smith 
20265c6c1daeSBarry Smith   Collective over MPI_Comm
20275c6c1daeSBarry Smith 
20285c6c1daeSBarry Smith   Input Parameter:
2029f14045dbSBarry Smith .  viewer - an ASCII viewer
20305c6c1daeSBarry Smith 
20315c6c1daeSBarry Smith   Options Database Keys:
2032bb1d7374SBarry Smith +  -log_view [:filename] - Prints summary of log information
2033bb1d7374SBarry Smith .  -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file
2034607d249eSBarry 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)
2035d0a29bd7SConnor 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)
2036156b51fbSBarry Smith .  -log_view_memory - Also display memory usage in each event
2037156b51fbSBarry Smith .  -log_view_gpu_time - Also display time in each event for GPU kernels (Note this may slow the computation)
2038bb1d7374SBarry Smith .  -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation
2039bb1d7374SBarry Smith -  -log_trace [filename] - Displays a trace of what each process is doing
20405c6c1daeSBarry Smith 
20415c6c1daeSBarry Smith   Notes:
2042bb1d7374SBarry Smith   It is possible to control the logging programatically but we recommend using the options database approach whenever possible
20435c6c1daeSBarry Smith   By default the summary is printed to stdout.
20445c6c1daeSBarry Smith 
2045bb1d7374SBarry Smith   Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin()
2046bb1d7374SBarry Smith 
2047bb1d7374SBarry Smith   If PETSc is configured with --with-logging=0 then this functionality is not available
2048bb1d7374SBarry Smith 
2049607d249eSBarry Smith   To view the nested XML format filename.xml first copy  ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current
2050607d249eSBarry Smith   directory then open filename.xml with your browser. Specific notes for certain browsers
2051607d249eSBarry Smith $    Firefox and Internet explorer - simply open the file
2052607d249eSBarry Smith $    Google Chrome - you must start up Chrome with the option --allow-file-access-from-files
2053a8d69d7bSBarry Smith $    Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access
2054607d249eSBarry 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
2055607d249eSBarry Smith   your browser.
20562add09c0SLisandro Dalcin   Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser
20572add09c0SLisandro Dalcin   window and render the XML log file contents.
2058607d249eSBarry Smith 
2059bb1d7374SBarry Smith   The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij  MARITIME  RESEARCH  INSTITUTE  NETHERLANDS
2060bb1d7374SBarry Smith 
2061d0a29bd7SConnor Ward   The Flame Graph output can be visualised using either the original Flame Graph script (https://github.com/brendangregg/FlameGraph)
2062d0a29bd7SConnor Ward   or using speedscope (https://www.speedscope.app).
2063d0a29bd7SConnor Ward   Old XML profiles may be converted into this format using the script ${PETSC_DIR}/lib/petsc/bin/xml2flamegraph.py.
2064d0a29bd7SConnor Ward 
20655c6c1daeSBarry Smith   Level: beginner
20665c6c1daeSBarry Smith 
2067db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogDump()`
20685c6c1daeSBarry Smith @*/
20699371c9d4SSatish Balay PetscErrorCode PetscLogView(PetscViewer viewer) {
2070f14045dbSBarry Smith   PetscBool         isascii;
2071f14045dbSBarry Smith   PetscViewerFormat format;
207237b78d16SBarry Smith   int               stage, lastStage;
207337b78d16SBarry Smith   PetscStageLog     stageLog;
20745c6c1daeSBarry Smith 
20755c6c1daeSBarry Smith   PetscFunctionBegin;
207628b400f6SJacob Faibussowitsch   PetscCheck(PetscLogPLB, PETSC_COMM_SELF, PETSC_ERR_SUP, "Must use -log_view or PetscLogDefaultBegin() before calling this routine");
207737b78d16SBarry Smith   /* Pop off any stages the user forgot to remove */
207837b78d16SBarry Smith   lastStage = 0;
20799566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
20809566063dSJacob Faibussowitsch   PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
208137b78d16SBarry Smith   while (stage >= 0) {
208237b78d16SBarry Smith     lastStage = stage;
20839566063dSJacob Faibussowitsch     PetscCall(PetscStageLogPop(stageLog));
20849566063dSJacob Faibussowitsch     PetscCall(PetscStageLogGetCurrent(stageLog, &stage));
208537b78d16SBarry Smith   }
20869566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isascii));
208728b400f6SJacob Faibussowitsch   PetscCheck(isascii, PetscObjectComm((PetscObject)viewer), PETSC_ERR_SUP, "Currently can only view logging to ASCII");
20889566063dSJacob Faibussowitsch   PetscCall(PetscViewerGetFormat(viewer, &format));
2089f14045dbSBarry Smith   if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) {
20909566063dSJacob Faibussowitsch     PetscCall(PetscLogView_Default(viewer));
2091f14045dbSBarry Smith   } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
20929566063dSJacob Faibussowitsch     PetscCall(PetscLogView_Detailed(viewer));
209338144912Sdeepblu2718   } else if (format == PETSC_VIEWER_ASCII_CSV) {
20949566063dSJacob Faibussowitsch     PetscCall(PetscLogView_CSV(viewer));
2095bb1d7374SBarry Smith   } else if (format == PETSC_VIEWER_ASCII_XML) {
20969566063dSJacob Faibussowitsch     PetscCall(PetscLogView_Nested(viewer));
2097d0a29bd7SConnor Ward   } else if (format == PETSC_VIEWER_ASCII_FLAMEGRAPH) {
20989566063dSJacob Faibussowitsch     PetscCall(PetscLogView_Flamegraph(viewer));
20995c6c1daeSBarry Smith   }
21009566063dSJacob Faibussowitsch   PetscCall(PetscStageLogPush(stageLog, lastStage));
21015c6c1daeSBarry Smith   PetscFunctionReturn(0);
21025c6c1daeSBarry Smith }
21035c6c1daeSBarry Smith 
2104f14045dbSBarry Smith /*@C
2105f14045dbSBarry Smith   PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed.
2106f14045dbSBarry Smith 
2107f14045dbSBarry Smith   Collective on PETSC_COMM_WORLD
2108f14045dbSBarry Smith 
2109f14045dbSBarry Smith   Not normally called by user
2110f14045dbSBarry Smith 
2111f14045dbSBarry Smith   Level: intermediate
2112f14045dbSBarry Smith 
2113f14045dbSBarry Smith @*/
21149371c9d4SSatish Balay PetscErrorCode PetscLogViewFromOptions(void) {
2115f14045dbSBarry Smith   PetscViewer       viewer;
2116f14045dbSBarry Smith   PetscBool         flg;
2117f14045dbSBarry Smith   PetscViewerFormat format;
2118f14045dbSBarry Smith 
2119f14045dbSBarry Smith   PetscFunctionBegin;
21209566063dSJacob Faibussowitsch   PetscCall(PetscOptionsGetViewer(PETSC_COMM_WORLD, NULL, NULL, "-log_view", &viewer, &format, &flg));
2121f14045dbSBarry Smith   if (flg) {
21229566063dSJacob Faibussowitsch     PetscCall(PetscViewerPushFormat(viewer, format));
21239566063dSJacob Faibussowitsch     PetscCall(PetscLogView(viewer));
21249566063dSJacob Faibussowitsch     PetscCall(PetscViewerPopFormat(viewer));
21259566063dSJacob Faibussowitsch     PetscCall(PetscViewerDestroy(&viewer));
2126f14045dbSBarry Smith   }
2127f14045dbSBarry Smith   PetscFunctionReturn(0);
2128f14045dbSBarry Smith }
2129f14045dbSBarry Smith 
21305c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/
21315c6c1daeSBarry Smith /*@C
21325c6c1daeSBarry Smith    PetscGetFlops - Returns the number of flops used on this processor
21335c6c1daeSBarry Smith    since the program began.
21345c6c1daeSBarry Smith 
21355c6c1daeSBarry Smith    Not Collective
21365c6c1daeSBarry Smith 
21375c6c1daeSBarry Smith    Output Parameter:
21385c6c1daeSBarry Smith    flops - number of floating point operations
21395c6c1daeSBarry Smith 
21405c6c1daeSBarry Smith    Notes:
21415c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
21425c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
21435c6c1daeSBarry Smith    application code.
21445c6c1daeSBarry Smith 
21455c6c1daeSBarry Smith    Level: intermediate
21465c6c1daeSBarry Smith 
2147db781477SPatrick Sanan .seealso: `PetscTime()`, `PetscLogFlops()`
21485c6c1daeSBarry Smith @*/
21499371c9d4SSatish Balay PetscErrorCode PetscGetFlops(PetscLogDouble *flops) {
21505c6c1daeSBarry Smith   PetscFunctionBegin;
21515c6c1daeSBarry Smith   *flops = petsc_TotalFlops;
21525c6c1daeSBarry Smith   PetscFunctionReturn(0);
21535c6c1daeSBarry Smith }
21545c6c1daeSBarry Smith 
21559371c9d4SSatish Balay PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) {
21565c6c1daeSBarry Smith   size_t  fullLength;
21575c6c1daeSBarry Smith   va_list Argp;
21585c6c1daeSBarry Smith 
21595c6c1daeSBarry Smith   PetscFunctionBegin;
21605c6c1daeSBarry Smith   if (!petsc_logObjects) PetscFunctionReturn(0);
21615c6c1daeSBarry Smith   va_start(Argp, format);
21629566063dSJacob Faibussowitsch   PetscCall(PetscVSNPrintf(petsc_objects[obj->id].info, 64, format, &fullLength, Argp));
21635c6c1daeSBarry Smith   va_end(Argp);
21645c6c1daeSBarry Smith   PetscFunctionReturn(0);
21655c6c1daeSBarry Smith }
21665c6c1daeSBarry Smith 
21675c6c1daeSBarry Smith /*MC
21685c6c1daeSBarry Smith    PetscLogFlops - Adds floating point operations to the global counter.
21695c6c1daeSBarry Smith 
21705c6c1daeSBarry Smith    Synopsis:
2171aaa7dc30SBarry Smith    #include <petsclog.h>
21725c6c1daeSBarry Smith    PetscErrorCode PetscLogFlops(PetscLogDouble f)
21735c6c1daeSBarry Smith 
21745c6c1daeSBarry Smith    Not Collective
21755c6c1daeSBarry Smith 
21765c6c1daeSBarry Smith    Input Parameter:
21775c6c1daeSBarry Smith .  f - flop counter
21785c6c1daeSBarry Smith 
21795c6c1daeSBarry Smith    Usage:
21805c6c1daeSBarry Smith .vb
21815c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
21825c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
21835c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
21845c6c1daeSBarry Smith         [code segment to monitor]
21855c6c1daeSBarry Smith         PetscLogFlops(user_flops)
21865c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
21875c6c1daeSBarry Smith .ve
21885c6c1daeSBarry Smith 
21895c6c1daeSBarry Smith    Notes:
21905c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
21915c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
21925c6c1daeSBarry Smith    application code.
21935c6c1daeSBarry Smith 
21945c6c1daeSBarry Smith    Level: intermediate
21955c6c1daeSBarry Smith 
2196db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscGetFlops()`
21975c6c1daeSBarry Smith 
21985c6c1daeSBarry Smith M*/
21995c6c1daeSBarry Smith 
22005c6c1daeSBarry Smith /*MC
22015c6c1daeSBarry Smith    PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice)
22025c6c1daeSBarry Smith     to get accurate timings
22035c6c1daeSBarry Smith 
22045c6c1daeSBarry Smith    Synopsis:
2205aaa7dc30SBarry Smith    #include <petsclog.h>
22065c6c1daeSBarry Smith    void PetscPreLoadBegin(PetscBool  flag,char *name);
22075c6c1daeSBarry Smith 
22085c6c1daeSBarry Smith    Not Collective
22095c6c1daeSBarry Smith 
2210d8d19677SJose E. Roman    Input Parameters:
22115c6c1daeSBarry Smith +   flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden
22125c6c1daeSBarry Smith            with command line option -preload true or -preload false
2213609bdbeeSBarry Smith -   name - name of first stage (lines of code timed separately with -log_view) to
22145c6c1daeSBarry Smith            be preloaded
22155c6c1daeSBarry Smith 
22165c6c1daeSBarry Smith    Usage:
22175c6c1daeSBarry Smith .vb
22185c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
22195c6c1daeSBarry Smith        lines of code
22205c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
22215c6c1daeSBarry Smith        lines of code
22225c6c1daeSBarry Smith      PetscPreLoadEnd();
22235c6c1daeSBarry Smith .ve
22245c6c1daeSBarry Smith 
222595452b02SPatrick Sanan    Notes:
222695452b02SPatrick Sanan     Only works in C/C++, not Fortran
22275c6c1daeSBarry Smith 
22285c6c1daeSBarry Smith      Flags available within the macro.
22295c6c1daeSBarry Smith +    PetscPreLoadingUsed - true if we are or have done preloading
22305c6c1daeSBarry Smith .    PetscPreLoadingOn - true if it is CURRENTLY doing preload
22315c6c1daeSBarry Smith .    PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second
22325c6c1daeSBarry Smith -    PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on
22335c6c1daeSBarry Smith      The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin()
22345c6c1daeSBarry Smith      and PetscPreLoadEnd()
22355c6c1daeSBarry Smith 
22365c6c1daeSBarry Smith    Level: intermediate
22375c6c1daeSBarry Smith 
2238db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()`
22395c6c1daeSBarry Smith 
22405c6c1daeSBarry Smith M*/
22415c6c1daeSBarry Smith 
22425c6c1daeSBarry Smith /*MC
22435c6c1daeSBarry Smith    PetscPreLoadEnd - End a segment of code that may be preloaded (run twice)
22445c6c1daeSBarry Smith     to get accurate timings
22455c6c1daeSBarry Smith 
22465c6c1daeSBarry Smith    Synopsis:
2247aaa7dc30SBarry Smith    #include <petsclog.h>
22485c6c1daeSBarry Smith    void PetscPreLoadEnd(void);
22495c6c1daeSBarry Smith 
22505c6c1daeSBarry Smith    Not Collective
22515c6c1daeSBarry Smith 
22525c6c1daeSBarry Smith    Usage:
22535c6c1daeSBarry Smith .vb
22545c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
22555c6c1daeSBarry Smith        lines of code
22565c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
22575c6c1daeSBarry Smith        lines of code
22585c6c1daeSBarry Smith      PetscPreLoadEnd();
22595c6c1daeSBarry Smith .ve
22605c6c1daeSBarry Smith 
226195452b02SPatrick Sanan    Notes:
226295452b02SPatrick Sanan     only works in C/C++ not fortran
22635c6c1daeSBarry Smith 
22645c6c1daeSBarry Smith    Level: intermediate
22655c6c1daeSBarry Smith 
2266db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadStage()`
22675c6c1daeSBarry Smith 
22685c6c1daeSBarry Smith M*/
22695c6c1daeSBarry Smith 
22705c6c1daeSBarry Smith /*MC
22715c6c1daeSBarry Smith    PetscPreLoadStage - Start a new segment of code to be timed separately.
22725c6c1daeSBarry Smith     to get accurate timings
22735c6c1daeSBarry Smith 
22745c6c1daeSBarry Smith    Synopsis:
2275aaa7dc30SBarry Smith    #include <petsclog.h>
22765c6c1daeSBarry Smith    void PetscPreLoadStage(char *name);
22775c6c1daeSBarry Smith 
22785c6c1daeSBarry Smith    Not Collective
22795c6c1daeSBarry Smith 
22805c6c1daeSBarry Smith    Usage:
22815c6c1daeSBarry Smith .vb
22825c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
22835c6c1daeSBarry Smith        lines of code
22845c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
22855c6c1daeSBarry Smith        lines of code
22865c6c1daeSBarry Smith      PetscPreLoadEnd();
22875c6c1daeSBarry Smith .ve
22885c6c1daeSBarry Smith 
228995452b02SPatrick Sanan    Notes:
229095452b02SPatrick Sanan     only works in C/C++ not fortran
22915c6c1daeSBarry Smith 
22925c6c1daeSBarry Smith    Level: intermediate
22935c6c1daeSBarry Smith 
2294db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`
22955c6c1daeSBarry Smith 
22965c6c1daeSBarry Smith M*/
22975c6c1daeSBarry Smith 
2298a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_DEVICE)
2299a4af0ceeSJacob Faibussowitsch #include <petsc/private/deviceimpl.h>
23009ffd0706SHong Zhang 
2301156b51fbSBarry Smith PetscBool PetscLogGpuTimeFlag = PETSC_FALSE;
2302156b51fbSBarry Smith 
2303156b51fbSBarry Smith /*
2304156b51fbSBarry Smith    This cannot be called by users between PetscInitialize() and PetscFinalize() at any random location in the code
2305156b51fbSBarry Smith    because it will result in timing results that cannot be interpreted.
2306156b51fbSBarry Smith */
23079371c9d4SSatish Balay static PetscErrorCode PetscLogGpuTime_Off(void) {
2308156b51fbSBarry Smith   PetscLogGpuTimeFlag = PETSC_FALSE;
2309156b51fbSBarry Smith   return 0;
2310156b51fbSBarry Smith }
2311156b51fbSBarry Smith 
2312156b51fbSBarry Smith /*@C
2313156b51fbSBarry Smith      PetscLogGpuTime - turn on the logging of GPU time for GPU kernels
2314156b51fbSBarry Smith 
2315156b51fbSBarry Smith   Options Database:
2316156b51fbSBarry Smith .   -log_view_gpu_time - provide the GPU times in the -log_view output
2317156b51fbSBarry Smith 
2318156b51fbSBarry Smith   Notes:
2319156b51fbSBarry Smith     Because the logging of GPU time requires blocking the CPU execution for each kernel, turning on the timing of the
2320156b51fbSBarry Smith     GPU kernels can slow down the entire computation and should only be used when studying the performance
2321156b51fbSBarry Smith     of operations on GPU such as vector operations and matrix-vector operations.
2322156b51fbSBarry Smith 
2323156b51fbSBarry Smith     This routine should only be called once near the beginning of the program. Once it is started it cannot be turned off.
2324156b51fbSBarry Smith 
23250f8f8846SPatrick Sanan    Level: advanced
23260f8f8846SPatrick Sanan 
2327db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuTimeBegin()`
2328156b51fbSBarry Smith @*/
23299371c9d4SSatish Balay PetscErrorCode PetscLogGpuTime(void) {
2330156b51fbSBarry Smith   if (!PetscLogGpuTimeFlag) PetscCall(PetscRegisterFinalize(PetscLogGpuTime_Off));
2331156b51fbSBarry Smith   PetscLogGpuTimeFlag = PETSC_TRUE;
2332156b51fbSBarry Smith   return 0;
2333156b51fbSBarry Smith }
2334156b51fbSBarry Smith 
23359ffd0706SHong Zhang /*@C
23369ffd0706SHong Zhang   PetscLogGpuTimeBegin - Start timer for device
23379ffd0706SHong Zhang 
23389ffd0706SHong Zhang   Notes:
23399ffd0706SHong 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).
23409ffd0706SHong 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).
23419ffd0706SHong Zhang     There is no need to call WaitForCUDA() or WaitForHIP() between PetscLogGpuTimeBegin and PetscLogGpuTimeEnd
23429ffd0706SHong Zhang     This timer should NOT include times for data transfers between the GPU and CPU, nor setup actions such as allocating space.
23439ffd0706SHong Zhang     The regular logging captures the time for data transfers and any CPU activites during the event
23449ffd0706SHong Zhang     It is used to compute the flop rate on the GPU as it is actively engaged in running a kernel.
23459ffd0706SHong Zhang 
23469ffd0706SHong Zhang   Developer Notes:
23479ffd0706SHong Zhang     The GPU event timer captures the execution time of all the kernels launched in the default stream by the CPU between PetscLogGpuTimeBegin() and PetsLogGpuTimeEnd().
23489ffd0706SHong Zhang     PetscLogGpuTimeBegin() and PetsLogGpuTimeEnd() insert the begin and end events into the default stream (stream 0). The device will record a time stamp for the event when it reaches that event in the stream. The function xxxEventSynchronize() is called in PetsLogGpuTimeEnd() to block CPU execution, but not continued GPU excution, until the timer event is recorded.
23499ffd0706SHong Zhang 
23509ffd0706SHong Zhang   Level: intermediate
23519ffd0706SHong Zhang 
2352db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuTime()`
23539ffd0706SHong Zhang @*/
23549371c9d4SSatish Balay PetscErrorCode PetscLogGpuTimeBegin(void) {
23559ffd0706SHong Zhang   PetscFunctionBegin;
2356156b51fbSBarry Smith   if (!PetscLogPLB || !PetscLogGpuTimeFlag) PetscFunctionReturn(0);
2357a4af0ceeSJacob Faibussowitsch   if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) {
2358a4af0ceeSJacob Faibussowitsch     PetscDeviceContext dctx;
2359a4af0ceeSJacob Faibussowitsch 
23609566063dSJacob Faibussowitsch     PetscCall(PetscDeviceContextGetCurrentContext(&dctx));
23619566063dSJacob Faibussowitsch     PetscCall(PetscDeviceContextBeginTimer_Internal(dctx));
2362a4af0ceeSJacob Faibussowitsch   } else {
23639566063dSJacob Faibussowitsch     PetscCall(PetscTimeSubtract(&petsc_gtime));
2364a4af0ceeSJacob Faibussowitsch   }
23659ffd0706SHong Zhang   PetscFunctionReturn(0);
23669ffd0706SHong Zhang }
23679ffd0706SHong Zhang 
23689ffd0706SHong Zhang /*@C
23699ffd0706SHong Zhang   PetscLogGpuTimeEnd - Stop timer for device
23709ffd0706SHong Zhang 
23719ffd0706SHong Zhang   Level: intermediate
23729ffd0706SHong Zhang 
2373db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeBegin()`
23749ffd0706SHong Zhang @*/
23759371c9d4SSatish Balay PetscErrorCode PetscLogGpuTimeEnd(void) {
23769ffd0706SHong Zhang   PetscFunctionBegin;
2377156b51fbSBarry Smith   if (!PetscLogPLE || !PetscLogGpuTimeFlag) PetscFunctionReturn(0);
2378a4af0ceeSJacob Faibussowitsch   if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) {
2379a4af0ceeSJacob Faibussowitsch     PetscDeviceContext dctx;
2380a4af0ceeSJacob Faibussowitsch     PetscLogDouble     elapsed;
2381a4af0ceeSJacob Faibussowitsch 
23829566063dSJacob Faibussowitsch     PetscCall(PetscDeviceContextGetCurrentContext(&dctx));
23839566063dSJacob Faibussowitsch     PetscCall(PetscDeviceContextEndTimer_Internal(dctx, &elapsed));
2384a4af0ceeSJacob Faibussowitsch     petsc_gtime += (elapsed / 1000.0);
2385a4af0ceeSJacob Faibussowitsch   } else {
23869566063dSJacob Faibussowitsch     PetscCall(PetscTimeAdd(&petsc_gtime));
2387a4af0ceeSJacob Faibussowitsch   }
23889ffd0706SHong Zhang   PetscFunctionReturn(0);
23899ffd0706SHong Zhang }
23909ffd0706SHong Zhang #endif /* end of PETSC_HAVE_DEVICE */
23919ffd0706SHong Zhang 
23925c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */
23935c6c1daeSBarry Smith 
23949371c9d4SSatish Balay PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) {
23955c6c1daeSBarry Smith   PetscFunctionBegin;
23965c6c1daeSBarry Smith   PetscFunctionReturn(0);
23975c6c1daeSBarry Smith }
23985c6c1daeSBarry Smith 
23995c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/
24005c6c1daeSBarry Smith 
24015c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID;
24025c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID  = 0;
24035c6c1daeSBarry Smith 
24045c6c1daeSBarry Smith /*@C
24055c6c1daeSBarry Smith   PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code.
24065c6c1daeSBarry Smith 
24075c6c1daeSBarry Smith   Not Collective
24085c6c1daeSBarry Smith 
24095c6c1daeSBarry Smith   Input Parameter:
24105c6c1daeSBarry Smith . name   - The class name
24115c6c1daeSBarry Smith 
24125c6c1daeSBarry Smith   Output Parameter:
24135c6c1daeSBarry Smith . oclass - The class id or classid
24145c6c1daeSBarry Smith 
24155c6c1daeSBarry Smith   Level: developer
24165c6c1daeSBarry Smith 
24175c6c1daeSBarry Smith @*/
24189371c9d4SSatish Balay PetscErrorCode PetscClassIdRegister(const char name[], PetscClassId *oclass) {
24195c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
24205c6c1daeSBarry Smith   PetscStageLog stageLog;
24215c6c1daeSBarry Smith   PetscInt      stage;
24225c6c1daeSBarry Smith #endif
24235c6c1daeSBarry Smith 
24245c6c1daeSBarry Smith   PetscFunctionBegin;
24255c6c1daeSBarry Smith   *oclass = ++PETSC_LARGEST_CLASSID;
24265c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
24279566063dSJacob Faibussowitsch   PetscCall(PetscLogGetStageLog(&stageLog));
24289566063dSJacob Faibussowitsch   PetscCall(PetscClassRegLogRegister(stageLog->classLog, name, *oclass));
2429*48a46eb9SPierre Jolivet   for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses));
24305c6c1daeSBarry Smith #endif
24315c6c1daeSBarry Smith   PetscFunctionReturn(0);
24325c6c1daeSBarry Smith }
2433210b5426SBarry Smith 
2434210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE)
2435210b5426SBarry Smith #include <mpe.h>
2436210b5426SBarry Smith 
2437210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE;
2438210b5426SBarry Smith 
2439495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject);
2440495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject);
2441495fc317SBarry Smith 
2442210b5426SBarry Smith /*@C
2443210b5426SBarry Smith    PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files
2444210b5426SBarry Smith    and slows the program down.
2445210b5426SBarry Smith 
2446210b5426SBarry Smith    Collective over PETSC_COMM_WORLD
2447210b5426SBarry Smith 
2448210b5426SBarry Smith    Options Database Keys:
2449a2553e36SBarry Smith . -log_mpe - Prints extensive log information
2450210b5426SBarry Smith 
2451210b5426SBarry Smith    Notes:
2452609bdbeeSBarry Smith    A related routine is PetscLogDefaultBegin() (with the options key -log_view), which is
2453210b5426SBarry Smith    intended for production runs since it logs only flop rates and object
2454210b5426SBarry Smith    creation (and should not significantly slow the programs).
2455210b5426SBarry Smith 
2456210b5426SBarry Smith    Level: advanced
2457210b5426SBarry Smith 
2458db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogEventActivate()`,
2459db781477SPatrick Sanan           `PetscLogEventDeactivate()`
2460210b5426SBarry Smith @*/
24619371c9d4SSatish Balay PetscErrorCode PetscLogMPEBegin(void) {
2462210b5426SBarry Smith   PetscFunctionBegin;
2463210b5426SBarry Smith   /* Do MPE initialization */
2464210b5426SBarry Smith   if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */
24659566063dSJacob Faibussowitsch     PetscCall(PetscInfo(0, "Initializing MPE.\n"));
24669566063dSJacob Faibussowitsch     PetscCall(MPE_Init_log());
2467210b5426SBarry Smith 
2468210b5426SBarry Smith     PetscBeganMPE = PETSC_TRUE;
2469210b5426SBarry Smith   } else {
24709566063dSJacob Faibussowitsch     PetscCall(PetscInfo(0, "MPE already initialized. Not attempting to reinitialize.\n"));
2471210b5426SBarry Smith   }
24729566063dSJacob Faibussowitsch   PetscCall(PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE));
2473210b5426SBarry Smith   PetscFunctionReturn(0);
2474210b5426SBarry Smith }
2475210b5426SBarry Smith 
2476210b5426SBarry Smith /*@C
2477495fc317SBarry Smith    PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot.
2478210b5426SBarry Smith 
2479210b5426SBarry Smith    Collective over PETSC_COMM_WORLD
2480210b5426SBarry Smith 
2481210b5426SBarry Smith    Level: advanced
2482210b5426SBarry Smith 
2483db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogMPEBegin()`
2484210b5426SBarry Smith @*/
24859371c9d4SSatish Balay PetscErrorCode PetscLogMPEDump(const char sname[]) {
2486210b5426SBarry Smith   char name[PETSC_MAX_PATH_LEN];
2487210b5426SBarry Smith 
2488210b5426SBarry Smith   PetscFunctionBegin;
2489210b5426SBarry Smith   if (PetscBeganMPE) {
24909566063dSJacob Faibussowitsch     PetscCall(PetscInfo(0, "Finalizing MPE.\n"));
2491210b5426SBarry Smith     if (sname) {
24929566063dSJacob Faibussowitsch       PetscCall(PetscStrcpy(name, sname));
2493210b5426SBarry Smith     } else {
24949566063dSJacob Faibussowitsch       PetscCall(PetscGetProgramName(name, sizeof(name)));
2495210b5426SBarry Smith     }
24969566063dSJacob Faibussowitsch     PetscCall(MPE_Finish_log(name));
2497210b5426SBarry Smith   } else {
24989566063dSJacob Faibussowitsch     PetscCall(PetscInfo(0, "Not finalizing MPE (not started by PETSc).\n"));
2499210b5426SBarry Smith   }
2500210b5426SBarry Smith   PetscFunctionReturn(0);
2501210b5426SBarry Smith }
2502210b5426SBarry Smith 
2503210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39
25049371c9d4SSatish Balay static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = {"OliveDrab:      ", "BlueViolet:     ", "CadetBlue:      ", "CornflowerBlue: ", "DarkGoldenrod:  ", "DarkGreen:      ", "DarkKhaki:      ", "DarkOliveGreen: ",
25059371c9d4SSatish Balay                                                                  "DarkOrange:     ", "DarkOrchid:     ", "DarkSeaGreen:   ", "DarkSlateGray:  ", "DarkTurquoise:  ", "DeepPink:       ", "DarkKhaki:      ", "DimGray:        ",
25069371c9d4SSatish Balay                                                                  "DodgerBlue:     ", "GreenYellow:    ", "HotPink:        ", "IndianRed:      ", "LavenderBlush:  ", "LawnGreen:      ", "LemonChiffon:   ", "LightCoral:     ",
25079371c9d4SSatish Balay                                                                  "LightCyan:      ", "LightPink:      ", "LightSalmon:    ", "LightSlateGray: ", "LightYellow:    ", "LimeGreen:      ", "MediumPurple:   ", "MediumSeaGreen: ",
25089371c9d4SSatish Balay                                                                  "MediumSlateBlue:", "MidnightBlue:   ", "MintCream:      ", "MistyRose:      ", "NavajoWhite:    ", "NavyBlue:       ", "OliveDrab:      "};
2509210b5426SBarry Smith 
2510210b5426SBarry Smith /*@C
2511210b5426SBarry Smith   PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister()
2512210b5426SBarry Smith 
2513210b5426SBarry Smith   Not collective. Maybe it should be?
2514210b5426SBarry Smith 
25157a7aea1fSJed Brown   Output Parameter:
2516210b5426SBarry Smith . str - character string representing the color
2517210b5426SBarry Smith 
2518210b5426SBarry Smith   Level: developer
2519210b5426SBarry Smith 
2520db781477SPatrick Sanan .seealso: `PetscLogEventRegister`
2521210b5426SBarry Smith @*/
25229371c9d4SSatish Balay PetscErrorCode PetscLogMPEGetRGBColor(const char *str[]) {
2523210b5426SBarry Smith   static int idx = 0;
2524210b5426SBarry Smith 
2525210b5426SBarry Smith   PetscFunctionBegin;
2526210b5426SBarry Smith   *str = PetscLogMPERGBColors[idx];
2527210b5426SBarry Smith   idx  = (idx + 1) % PETSC_RGB_COLORS_MAX;
2528210b5426SBarry Smith   PetscFunctionReturn(0);
2529210b5426SBarry Smith }
2530210b5426SBarry Smith 
2531210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */
2532