xref: /petsc/src/sys/logging/plog.c (revision 28b400f66ebc7ae0049166a2294dfcd3df27e64b)
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 
153bb1ff40SBarry Smith PetscErrorCode PetscLogObjectParent(PetscObject p,PetscObject c)
163bb1ff40SBarry Smith {
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:
3595452b02SPatrick Sanan     Currently we do not always do a good job of associating all memory allocations with an object.
36bb72fc59SBarry Smith 
37bb72fc59SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
38bb72fc59SBarry Smith 
39bb72fc59SBarry Smith @*/
403bb1ff40SBarry Smith PetscErrorCode PetscLogObjectMemory(PetscObject p,PetscLogDouble m)
413bb1ff40SBarry Smith {
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 
11095c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogInitialize(void)
111fa2bb9feSLisandro Dalcin {
112fa2bb9feSLisandro Dalcin   int            stage;
113fa2bb9feSLisandro Dalcin   PetscBool      opt;
1145c6c1daeSBarry Smith 
115fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
116fa2bb9feSLisandro Dalcin   if (PetscLogInitializeCalled) PetscFunctionReturn(0);
117fa2bb9feSLisandro Dalcin   PetscLogInitializeCalled = PETSC_TRUE;
1185c6c1daeSBarry Smith 
1195f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsHasName(NULL,NULL, "-log_exclude_actions", &opt));
120fa2bb9feSLisandro Dalcin   if (opt) petsc_logActions = PETSC_FALSE;
1215f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsHasName(NULL,NULL, "-log_exclude_objects", &opt));
122fa2bb9feSLisandro Dalcin   if (opt) petsc_logObjects = PETSC_FALSE;
123fa2bb9feSLisandro Dalcin   if (petsc_logActions) {
1245f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscMalloc1(petsc_maxActions, &petsc_actions));
125fa2bb9feSLisandro Dalcin   }
126fa2bb9feSLisandro Dalcin   if (petsc_logObjects) {
1275f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscMalloc1(petsc_maxObjects, &petsc_objects));
128fa2bb9feSLisandro Dalcin   }
129fa2bb9feSLisandro Dalcin   PetscLogPHC = PetscLogObjCreateDefault;
130fa2bb9feSLisandro Dalcin   PetscLogPHD = PetscLogObjDestroyDefault;
131fa2bb9feSLisandro Dalcin   /* Setup default logging structures */
1325f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogCreate(&petsc_stageLog));
1335f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage));
1345c6c1daeSBarry Smith 
135fa2bb9feSLisandro Dalcin   /* All processors sync here for more consistent logging */
1365f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Barrier(PETSC_COMM_WORLD));
137fa2bb9feSLisandro Dalcin   PetscTime(&petsc_BaseTime);
1385f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogStagePush(stage));
139fa2bb9feSLisandro Dalcin   PetscFunctionReturn(0);
140fa2bb9feSLisandro Dalcin }
1415c6c1daeSBarry Smith 
14295c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogFinalize(void)
1435c6c1daeSBarry Smith {
1445c6c1daeSBarry Smith   PetscStageLog  stageLog;
1455c6c1daeSBarry Smith 
1465c6c1daeSBarry Smith   PetscFunctionBegin;
1475f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFree(petsc_actions));
1485f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFree(petsc_objects));
1495f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogNestedEnd());
1505f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogSet(NULL, NULL));
1515c6c1daeSBarry Smith 
1525c6c1daeSBarry Smith   /* Resetting phase */
1535f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
1545f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogDestroy(stageLog));
155a297a907SKarl Rupp 
1565c6c1daeSBarry Smith   petsc_TotalFlops            = 0.0;
1575c6c1daeSBarry Smith   petsc_numActions            = 0;
1585c6c1daeSBarry Smith   petsc_numObjects            = 0;
1595c6c1daeSBarry Smith   petsc_numObjectsDestroyed   = 0;
1605c6c1daeSBarry Smith   petsc_maxActions            = 100;
1615c6c1daeSBarry Smith   petsc_maxObjects            = 100;
1620298fd71SBarry Smith   petsc_actions               = NULL;
1630298fd71SBarry Smith   petsc_objects               = NULL;
1645c6c1daeSBarry Smith   petsc_logActions            = PETSC_FALSE;
1655c6c1daeSBarry Smith   petsc_logObjects            = PETSC_FALSE;
1665c6c1daeSBarry Smith   petsc_BaseTime              = 0.0;
1675c6c1daeSBarry Smith   petsc_TotalFlops            = 0.0;
1685c6c1daeSBarry Smith   petsc_tmp_flops             = 0.0;
1695c6c1daeSBarry Smith   petsc_send_ct               = 0.0;
1705c6c1daeSBarry Smith   petsc_recv_ct               = 0.0;
1715c6c1daeSBarry Smith   petsc_send_len              = 0.0;
1725c6c1daeSBarry Smith   petsc_recv_len              = 0.0;
1735c6c1daeSBarry Smith   petsc_isend_ct              = 0.0;
1745c6c1daeSBarry Smith   petsc_irecv_ct              = 0.0;
1755c6c1daeSBarry Smith   petsc_isend_len             = 0.0;
1765c6c1daeSBarry Smith   petsc_irecv_len             = 0.0;
1775c6c1daeSBarry Smith   petsc_wait_ct               = 0.0;
1785c6c1daeSBarry Smith   petsc_wait_any_ct           = 0.0;
1795c6c1daeSBarry Smith   petsc_wait_all_ct           = 0.0;
1805c6c1daeSBarry Smith   petsc_sum_of_waits_ct       = 0.0;
1815c6c1daeSBarry Smith   petsc_allreduce_ct          = 0.0;
1825c6c1daeSBarry Smith   petsc_gather_ct             = 0.0;
1835c6c1daeSBarry Smith   petsc_scatter_ct            = 0.0;
184d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
185bec0b493Shannah_mairs   petsc_ctog_ct               = 0.0;
186bec0b493Shannah_mairs   petsc_gtoc_ct               = 0.0;
187bec0b493Shannah_mairs   petsc_ctog_sz               = 0.0;
188bec0b493Shannah_mairs   petsc_gtoc_sz               = 0.0;
189958c4211Shannah_mairs   petsc_gflops                = 0.0;
190958c4211Shannah_mairs   petsc_gtime                 = 0.0;
191bec0b493Shannah_mairs   #endif
1925c6c1daeSBarry Smith   PETSC_LARGEST_EVENT         = PETSC_EVENT;
1930298fd71SBarry Smith   PetscLogPHC                 = NULL;
1940298fd71SBarry Smith   PetscLogPHD                 = NULL;
1950298fd71SBarry Smith   petsc_tracefile             = NULL;
1965c6c1daeSBarry Smith   petsc_tracelevel            = 0;
1975c6c1daeSBarry Smith   petsc_traceblanks           = "                                                                                                    ";
1985c6c1daeSBarry Smith   petsc_tracespace[0]         = ' '; 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 
218bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogTraceBegin()
2195c6c1daeSBarry Smith @*/
2205c6c1daeSBarry Smith PetscErrorCode  PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject),
2215c6c1daeSBarry Smith                             PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject))
2225c6c1daeSBarry Smith {
2235c6c1daeSBarry Smith   PetscFunctionBegin;
2245c6c1daeSBarry Smith   PetscLogPLB = b;
2255c6c1daeSBarry Smith   PetscLogPLE = e;
2265c6c1daeSBarry Smith   PetscFunctionReturn(0);
2275c6c1daeSBarry Smith }
2285c6c1daeSBarry Smith 
2295c6c1daeSBarry Smith /*@C
2304dd65854SConnor Ward   PetscLogIsActive - Check if logging is currently in progress.
2314dd65854SConnor Ward 
2324dd65854SConnor Ward   Not Collective
2334dd65854SConnor Ward 
2344dd65854SConnor Ward   Output Parameter:
2354dd65854SConnor Ward . isActive - PETSC_TRUE if logging is in progress, PETSC_FALSE otherwise
2364dd65854SConnor Ward 
2374dd65854SConnor Ward   Level: beginner
2384dd65854SConnor Ward 
2394dd65854SConnor Ward .seealso: PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogSet()
2404dd65854SConnor Ward @*/
2414dd65854SConnor Ward PetscErrorCode PetscLogIsActive(PetscBool *isActive)
2424dd65854SConnor Ward {
2434dd65854SConnor Ward   PetscFunctionBegin;
2444dd65854SConnor Ward   *isActive = (PetscLogPLB && PetscLogPLE) ? PETSC_TRUE : PETSC_FALSE;
2454dd65854SConnor Ward   PetscFunctionReturn(0);
2464dd65854SConnor Ward }
2474dd65854SConnor Ward 
2484dd65854SConnor Ward /*@C
249bb1d7374SBarry Smith   PetscLogDefaultBegin - Turns on logging of objects and events. This logs flop
2505c6c1daeSBarry Smith   rates and object creation and should not slow programs down too much.
2515c6c1daeSBarry Smith   This routine may be called more than once.
2525c6c1daeSBarry Smith 
2535c6c1daeSBarry Smith   Logically Collective over PETSC_COMM_WORLD
2545c6c1daeSBarry Smith 
2555c6c1daeSBarry Smith   Options Database Keys:
256a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the
257a2553e36SBarry Smith                   screen (for code configured with --with-log=1 (which is the default))
2585c6c1daeSBarry Smith 
2595c6c1daeSBarry Smith   Usage:
2605c6c1daeSBarry Smith .vb
2615c6c1daeSBarry Smith       PetscInitialize(...);
262bb1d7374SBarry Smith       PetscLogDefaultBegin();
2635c6c1daeSBarry Smith        ... code ...
2645c6c1daeSBarry Smith       PetscLogView(viewer); or PetscLogDump();
2655c6c1daeSBarry Smith       PetscFinalize();
2665c6c1daeSBarry Smith .ve
2675c6c1daeSBarry Smith 
2685c6c1daeSBarry Smith   Notes:
2695c6c1daeSBarry Smith   PetscLogView(viewer) or PetscLogDump() actually cause the printing of
2705c6c1daeSBarry Smith   the logging information.
2715c6c1daeSBarry Smith 
2725c6c1daeSBarry Smith   Level: advanced
2735c6c1daeSBarry Smith 
2745c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogTraceBegin()
2755c6c1daeSBarry Smith @*/
276bb1d7374SBarry Smith PetscErrorCode  PetscLogDefaultBegin(void)
2775c6c1daeSBarry Smith {
2785c6c1daeSBarry Smith   PetscFunctionBegin;
2795f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault));
2805c6c1daeSBarry Smith   PetscFunctionReturn(0);
2815c6c1daeSBarry Smith }
2825c6c1daeSBarry Smith 
2835c6c1daeSBarry Smith /*@C
2845c6c1daeSBarry Smith   PetscLogAllBegin - Turns on extensive logging of objects and events. Logs
2855c6c1daeSBarry Smith   all events. This creates large log files and slows the program down.
2865c6c1daeSBarry Smith 
2875c6c1daeSBarry Smith   Logically Collective on PETSC_COMM_WORLD
2885c6c1daeSBarry Smith 
2895c6c1daeSBarry Smith   Options Database Keys:
290a2553e36SBarry Smith . -log_all - Prints extensive log information
2915c6c1daeSBarry Smith 
2925c6c1daeSBarry Smith   Usage:
2935c6c1daeSBarry Smith .vb
2945c6c1daeSBarry Smith      PetscInitialize(...);
2955c6c1daeSBarry Smith      PetscLogAllBegin();
2965c6c1daeSBarry Smith      ... code ...
2975c6c1daeSBarry Smith      PetscLogDump(filename);
2985c6c1daeSBarry Smith      PetscFinalize();
2995c6c1daeSBarry Smith .ve
3005c6c1daeSBarry Smith 
3015c6c1daeSBarry Smith   Notes:
302bb1d7374SBarry Smith   A related routine is PetscLogDefaultBegin() (with the options key -log), which is
3035c6c1daeSBarry Smith   intended for production runs since it logs only flop rates and object
3045c6c1daeSBarry Smith   creation (and shouldn't significantly slow the programs).
3055c6c1daeSBarry Smith 
3065c6c1daeSBarry Smith   Level: advanced
3075c6c1daeSBarry Smith 
308bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogTraceBegin()
3095c6c1daeSBarry Smith @*/
3105c6c1daeSBarry Smith PetscErrorCode  PetscLogAllBegin(void)
3115c6c1daeSBarry Smith {
3125c6c1daeSBarry Smith   PetscFunctionBegin;
3135f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete));
3145c6c1daeSBarry Smith   PetscFunctionReturn(0);
3155c6c1daeSBarry Smith }
3165c6c1daeSBarry Smith 
317956f8c0dSBarry Smith /*@C
3185c6c1daeSBarry Smith   PetscLogTraceBegin - Activates trace logging.  Every time a PETSc event
3195c6c1daeSBarry Smith   begins or ends, the event name is printed.
3205c6c1daeSBarry Smith 
3215c6c1daeSBarry Smith   Logically Collective on PETSC_COMM_WORLD
3225c6c1daeSBarry Smith 
3235c6c1daeSBarry Smith   Input Parameter:
3245c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout)
3255c6c1daeSBarry Smith 
3265c6c1daeSBarry Smith   Options Database Key:
3275c6c1daeSBarry Smith . -log_trace [filename] - Activates PetscLogTraceBegin()
3285c6c1daeSBarry Smith 
3295c6c1daeSBarry Smith   Notes:
3305c6c1daeSBarry Smith   PetscLogTraceBegin() prints the processor number, the execution time (sec),
3315c6c1daeSBarry Smith   then "Event begin:" or "Event end:" followed by the event name.
3325c6c1daeSBarry Smith 
3335c6c1daeSBarry Smith   PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful
3345c6c1daeSBarry Smith   to determine where a program is hanging without running in the
3355c6c1daeSBarry Smith   debugger.  Can be used in conjunction with the -info option.
3365c6c1daeSBarry Smith 
3375c6c1daeSBarry Smith   Level: intermediate
3385c6c1daeSBarry Smith 
339bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogDefaultBegin()
3405c6c1daeSBarry Smith @*/
3415c6c1daeSBarry Smith PetscErrorCode  PetscLogTraceBegin(FILE *file)
3425c6c1daeSBarry Smith {
3435c6c1daeSBarry Smith   PetscFunctionBegin;
3445c6c1daeSBarry Smith   petsc_tracefile = file;
345a297a907SKarl Rupp 
3465f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace));
3475c6c1daeSBarry Smith   PetscFunctionReturn(0);
3485c6c1daeSBarry Smith }
3495c6c1daeSBarry Smith 
3505c6c1daeSBarry Smith /*@
3515c6c1daeSBarry Smith   PetscLogActions - Determines whether actions are logged for the graphical viewer.
3525c6c1daeSBarry Smith 
3535c6c1daeSBarry Smith   Not Collective
3545c6c1daeSBarry Smith 
3555c6c1daeSBarry Smith   Input Parameter:
3565c6c1daeSBarry Smith . flag - PETSC_TRUE if actions are to be logged
3575c6c1daeSBarry Smith 
3585c6c1daeSBarry Smith   Level: intermediate
3595c6c1daeSBarry Smith 
3605c6c1daeSBarry Smith   Note: Logging of actions continues to consume more memory as the program
3615c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
3625c6c1daeSBarry Smith 
3635c6c1daeSBarry Smith   Options Database Keys:
3645c6c1daeSBarry Smith . -log_exclude_actions - Turns off actions logging
3655c6c1daeSBarry Smith 
3665c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
3675c6c1daeSBarry Smith @*/
3685c6c1daeSBarry Smith PetscErrorCode  PetscLogActions(PetscBool flag)
3695c6c1daeSBarry Smith {
3705c6c1daeSBarry Smith   PetscFunctionBegin;
3715c6c1daeSBarry Smith   petsc_logActions = flag;
3725c6c1daeSBarry Smith   PetscFunctionReturn(0);
3735c6c1daeSBarry Smith }
3745c6c1daeSBarry Smith 
3755c6c1daeSBarry Smith /*@
3765c6c1daeSBarry Smith   PetscLogObjects - Determines whether objects are logged for the graphical viewer.
3775c6c1daeSBarry Smith 
3785c6c1daeSBarry Smith   Not Collective
3795c6c1daeSBarry Smith 
3805c6c1daeSBarry Smith   Input Parameter:
3815c6c1daeSBarry Smith . flag - PETSC_TRUE if objects are to be logged
3825c6c1daeSBarry Smith 
3835c6c1daeSBarry Smith   Level: intermediate
3845c6c1daeSBarry Smith 
3855c6c1daeSBarry Smith   Note: Logging of objects continues to consume more memory as the program
3865c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
3875c6c1daeSBarry Smith 
3885c6c1daeSBarry Smith   Options Database Keys:
3895c6c1daeSBarry Smith . -log_exclude_objects - Turns off objects logging
3905c6c1daeSBarry Smith 
3915c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
3925c6c1daeSBarry Smith @*/
3935c6c1daeSBarry Smith PetscErrorCode  PetscLogObjects(PetscBool flag)
3945c6c1daeSBarry Smith {
3955c6c1daeSBarry Smith   PetscFunctionBegin;
3965c6c1daeSBarry Smith   petsc_logObjects = flag;
3975c6c1daeSBarry Smith   PetscFunctionReturn(0);
3985c6c1daeSBarry Smith }
3995c6c1daeSBarry Smith 
4005c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/
4015c6c1daeSBarry Smith /*@C
40274c0405dSRichard Tran Mills   PetscLogStageRegister - Attaches a character string name to a logging stage.
4035c6c1daeSBarry Smith 
4045c6c1daeSBarry Smith   Not Collective
4055c6c1daeSBarry Smith 
4065c6c1daeSBarry Smith   Input Parameter:
4075c6c1daeSBarry Smith . sname - The name to associate with that stage
4085c6c1daeSBarry Smith 
4095c6c1daeSBarry Smith   Output Parameter:
4105c6c1daeSBarry Smith . stage - The stage number
4115c6c1daeSBarry Smith 
4125c6c1daeSBarry Smith   Level: intermediate
4135c6c1daeSBarry Smith 
4145c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
4155c6c1daeSBarry Smith @*/
4165c6c1daeSBarry Smith PetscErrorCode  PetscLogStageRegister(const char sname[],PetscLogStage *stage)
4175c6c1daeSBarry Smith {
4185c6c1daeSBarry Smith   PetscStageLog  stageLog;
4195c6c1daeSBarry Smith   PetscLogEvent  event;
4205c6c1daeSBarry Smith 
4215c6c1daeSBarry Smith   PetscFunctionBegin;
4225f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
4235f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogRegister(stageLog, sname, stage));
4245c6c1daeSBarry Smith   /* Copy events already changed in the main stage, this sucks */
4255f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents));
4265c6c1daeSBarry Smith   for (event = 0; event < stageLog->eventLog->numEvents; event++) {
4275f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event],&stageLog->stageInfo[*stage].eventLog->eventInfo[event]));
4285c6c1daeSBarry Smith   }
4295f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses));
4305c6c1daeSBarry Smith   PetscFunctionReturn(0);
4315c6c1daeSBarry Smith }
4325c6c1daeSBarry Smith 
4335c6c1daeSBarry Smith /*@C
4345c6c1daeSBarry Smith   PetscLogStagePush - This function pushes a stage on the stack.
4355c6c1daeSBarry Smith 
4365c6c1daeSBarry Smith   Not Collective
4375c6c1daeSBarry Smith 
4385c6c1daeSBarry Smith   Input Parameter:
4395c6c1daeSBarry Smith . stage - The stage on which to log
4405c6c1daeSBarry Smith 
4415c6c1daeSBarry Smith   Usage:
4425c6c1daeSBarry Smith   If the option -log_sumary is used to run the program containing the
4435c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
4445c6c1daeSBarry Smith   PetscFinalize().
4455c6c1daeSBarry Smith .vb
4465c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
4475c6c1daeSBarry Smith       [stage 0 of code]
4485c6c1daeSBarry Smith       PetscLogStagePush(1);
4495c6c1daeSBarry Smith       [stage 1 of code]
4505c6c1daeSBarry Smith       PetscLogStagePop();
4515c6c1daeSBarry Smith       PetscBarrier(...);
4525c6c1daeSBarry Smith       [more stage 0 of code]
4535c6c1daeSBarry Smith       PetscFinalize();
4545c6c1daeSBarry Smith .ve
4555c6c1daeSBarry Smith 
4565c6c1daeSBarry Smith   Notes:
4575c6c1daeSBarry Smith   Use PetscLogStageRegister() to register a stage.
4585c6c1daeSBarry Smith 
4595c6c1daeSBarry Smith   Level: intermediate
4605c6c1daeSBarry Smith 
4615c6c1daeSBarry Smith .seealso: PetscLogStagePop(), PetscLogStageRegister(), PetscBarrier()
4625c6c1daeSBarry Smith @*/
4635c6c1daeSBarry Smith PetscErrorCode  PetscLogStagePush(PetscLogStage stage)
4645c6c1daeSBarry Smith {
4655c6c1daeSBarry Smith   PetscStageLog  stageLog;
4665c6c1daeSBarry Smith 
4675c6c1daeSBarry Smith   PetscFunctionBegin;
4685f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
4695f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogPush(stageLog, stage));
4705c6c1daeSBarry Smith   PetscFunctionReturn(0);
4715c6c1daeSBarry Smith }
4725c6c1daeSBarry Smith 
4735c6c1daeSBarry Smith /*@C
4745c6c1daeSBarry Smith   PetscLogStagePop - This function pops a stage from the stack.
4755c6c1daeSBarry Smith 
4765c6c1daeSBarry Smith   Not Collective
4775c6c1daeSBarry Smith 
4785c6c1daeSBarry Smith   Usage:
4795c6c1daeSBarry Smith   If the option -log_sumary is used to run the program containing the
4805c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
4815c6c1daeSBarry Smith   PetscFinalize().
4825c6c1daeSBarry Smith .vb
4835c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
4845c6c1daeSBarry Smith       [stage 0 of code]
4855c6c1daeSBarry Smith       PetscLogStagePush(1);
4865c6c1daeSBarry Smith       [stage 1 of code]
4875c6c1daeSBarry Smith       PetscLogStagePop();
4885c6c1daeSBarry Smith       PetscBarrier(...);
4895c6c1daeSBarry Smith       [more stage 0 of code]
4905c6c1daeSBarry Smith       PetscFinalize();
4915c6c1daeSBarry Smith .ve
4925c6c1daeSBarry Smith 
4935c6c1daeSBarry Smith   Notes:
4945c6c1daeSBarry Smith   Use PetscLogStageRegister() to register a stage.
4955c6c1daeSBarry Smith 
4965c6c1daeSBarry Smith   Level: intermediate
4975c6c1daeSBarry Smith 
4985c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStageRegister(), PetscBarrier()
4995c6c1daeSBarry Smith @*/
5005c6c1daeSBarry Smith PetscErrorCode  PetscLogStagePop(void)
5015c6c1daeSBarry Smith {
5025c6c1daeSBarry Smith   PetscStageLog  stageLog;
5035c6c1daeSBarry Smith 
5045c6c1daeSBarry Smith   PetscFunctionBegin;
5055f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
5065f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogPop(stageLog));
5075c6c1daeSBarry Smith   PetscFunctionReturn(0);
5085c6c1daeSBarry Smith }
5095c6c1daeSBarry Smith 
5105c6c1daeSBarry Smith /*@
5115c6c1daeSBarry Smith   PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd().
5125c6c1daeSBarry Smith 
5135c6c1daeSBarry Smith   Not Collective
5145c6c1daeSBarry Smith 
5155c6c1daeSBarry Smith   Input Parameters:
5165c6c1daeSBarry Smith + stage    - The stage
5175c6c1daeSBarry Smith - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE)
5185c6c1daeSBarry Smith 
5195c6c1daeSBarry Smith   Level: intermediate
5205c6c1daeSBarry Smith 
5215c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
5225c6c1daeSBarry Smith @*/
5235c6c1daeSBarry Smith PetscErrorCode  PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive)
5245c6c1daeSBarry Smith {
5255c6c1daeSBarry Smith   PetscStageLog  stageLog;
5265c6c1daeSBarry Smith 
5275c6c1daeSBarry Smith   PetscFunctionBegin;
5285f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
5295f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogSetActive(stageLog, stage, isActive));
5305c6c1daeSBarry Smith   PetscFunctionReturn(0);
5315c6c1daeSBarry Smith }
5325c6c1daeSBarry Smith 
5335c6c1daeSBarry Smith /*@
5345c6c1daeSBarry Smith   PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd().
5355c6c1daeSBarry Smith 
5365c6c1daeSBarry Smith   Not Collective
5375c6c1daeSBarry Smith 
5385c6c1daeSBarry Smith   Input Parameter:
5395c6c1daeSBarry Smith . stage    - The stage
5405c6c1daeSBarry Smith 
5415c6c1daeSBarry Smith   Output Parameter:
5425c6c1daeSBarry Smith . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE)
5435c6c1daeSBarry Smith 
5445c6c1daeSBarry Smith   Level: intermediate
5455c6c1daeSBarry Smith 
5465c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
5475c6c1daeSBarry Smith @*/
5485c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetActive(PetscLogStage stage, PetscBool  *isActive)
5495c6c1daeSBarry Smith {
5505c6c1daeSBarry Smith   PetscStageLog  stageLog;
5515c6c1daeSBarry Smith 
5525c6c1daeSBarry Smith   PetscFunctionBegin;
5535f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
5545f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogGetActive(stageLog, stage, isActive));
5555c6c1daeSBarry Smith   PetscFunctionReturn(0);
5565c6c1daeSBarry Smith }
5575c6c1daeSBarry Smith 
5585c6c1daeSBarry Smith /*@
5595c6c1daeSBarry Smith   PetscLogStageSetVisible - Determines stage visibility in PetscLogView()
5605c6c1daeSBarry Smith 
5615c6c1daeSBarry Smith   Not Collective
5625c6c1daeSBarry Smith 
5635c6c1daeSBarry Smith   Input Parameters:
5645c6c1daeSBarry Smith + stage     - The stage
5655c6c1daeSBarry Smith - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE)
5665c6c1daeSBarry Smith 
5675c6c1daeSBarry Smith   Level: intermediate
5685c6c1daeSBarry Smith 
5695c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView()
5705c6c1daeSBarry Smith @*/
5715c6c1daeSBarry Smith PetscErrorCode  PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible)
5725c6c1daeSBarry Smith {
5735c6c1daeSBarry Smith   PetscStageLog  stageLog;
5745c6c1daeSBarry Smith 
5755c6c1daeSBarry Smith   PetscFunctionBegin;
5765f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
5775f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogSetVisible(stageLog, stage, isVisible));
5785c6c1daeSBarry Smith   PetscFunctionReturn(0);
5795c6c1daeSBarry Smith }
5805c6c1daeSBarry Smith 
5815c6c1daeSBarry Smith /*@
5825c6c1daeSBarry Smith   PetscLogStageGetVisible - Returns stage visibility in PetscLogView()
5835c6c1daeSBarry Smith 
5845c6c1daeSBarry Smith   Not Collective
5855c6c1daeSBarry Smith 
5865c6c1daeSBarry Smith   Input Parameter:
5875c6c1daeSBarry Smith . stage     - The stage
5885c6c1daeSBarry Smith 
5895c6c1daeSBarry Smith   Output Parameter:
5905c6c1daeSBarry Smith . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE)
5915c6c1daeSBarry Smith 
5925c6c1daeSBarry Smith   Level: intermediate
5935c6c1daeSBarry Smith 
5945c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView()
5955c6c1daeSBarry Smith @*/
5965c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetVisible(PetscLogStage stage, PetscBool  *isVisible)
5975c6c1daeSBarry Smith {
5985c6c1daeSBarry Smith   PetscStageLog  stageLog;
5995c6c1daeSBarry Smith 
6005c6c1daeSBarry Smith   PetscFunctionBegin;
6015f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
6025f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogGetVisible(stageLog, stage, isVisible));
6035c6c1daeSBarry Smith   PetscFunctionReturn(0);
6045c6c1daeSBarry Smith }
6055c6c1daeSBarry Smith 
6065c6c1daeSBarry Smith /*@C
6075c6c1daeSBarry Smith   PetscLogStageGetId - Returns the stage id when given the stage name.
6085c6c1daeSBarry Smith 
6095c6c1daeSBarry Smith   Not Collective
6105c6c1daeSBarry Smith 
6115c6c1daeSBarry Smith   Input Parameter:
6125c6c1daeSBarry Smith . name  - The stage name
6135c6c1daeSBarry Smith 
6145c6c1daeSBarry Smith   Output Parameter:
6155a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists
6165c6c1daeSBarry Smith 
6175c6c1daeSBarry Smith   Level: intermediate
6185c6c1daeSBarry Smith 
6195c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
6205c6c1daeSBarry Smith @*/
6215c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetId(const char name[], PetscLogStage *stage)
6225c6c1daeSBarry Smith {
6235c6c1daeSBarry Smith   PetscStageLog  stageLog;
6245c6c1daeSBarry Smith 
6255c6c1daeSBarry Smith   PetscFunctionBegin;
6265f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
6275f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogGetStage(stageLog, name, stage));
6285c6c1daeSBarry Smith   PetscFunctionReturn(0);
6295c6c1daeSBarry Smith }
6305c6c1daeSBarry Smith 
6315c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/
6325c6c1daeSBarry Smith /*@C
6335c6c1daeSBarry Smith   PetscLogEventRegister - Registers an event name for logging operations in an application code.
6345c6c1daeSBarry Smith 
6355c6c1daeSBarry Smith   Not Collective
6365c6c1daeSBarry Smith 
637d8d19677SJose E. Roman   Input Parameters:
6385c6c1daeSBarry Smith + name   - The name associated with the event
6395c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with
6405c6c1daeSBarry Smith            PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones
6415c6c1daeSBarry Smith            are only available in C code
6425c6c1daeSBarry Smith 
6435c6c1daeSBarry Smith   Output Parameter:
6445c6c1daeSBarry Smith . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd().
6455c6c1daeSBarry Smith 
6465c6c1daeSBarry Smith   Example of Usage:
6475c6c1daeSBarry Smith .vb
6485c6c1daeSBarry Smith       PetscLogEvent USER_EVENT;
6495c6c1daeSBarry Smith       PetscClassId classid;
6505c6c1daeSBarry Smith       PetscLogDouble user_event_flops;
6515c6c1daeSBarry Smith       PetscClassIdRegister("class name",&classid);
6525c6c1daeSBarry Smith       PetscLogEventRegister("User event name",classid,&USER_EVENT);
6535c6c1daeSBarry Smith       PetscLogEventBegin(USER_EVENT,0,0,0,0);
6545c6c1daeSBarry Smith          [code segment to monitor]
6555c6c1daeSBarry Smith          PetscLogFlops(user_event_flops);
6565c6c1daeSBarry Smith       PetscLogEventEnd(USER_EVENT,0,0,0,0);
6575c6c1daeSBarry Smith .ve
6585c6c1daeSBarry Smith 
6595c6c1daeSBarry Smith   Notes:
6605c6c1daeSBarry Smith   PETSc automatically logs library events if the code has been
661a2553e36SBarry Smith   configured with --with-log (which is the default) and
662a2553e36SBarry Smith   -log_view or -log_all is specified.  PetscLogEventRegister() is
6635c6c1daeSBarry Smith   intended for logging user events to supplement this PETSc
6645c6c1daeSBarry Smith   information.
6655c6c1daeSBarry Smith 
666495fc317SBarry Smith   PETSc can gather data for use with the utilities Jumpshot
6675c6c1daeSBarry Smith   (part of the MPICH distribution).  If PETSc has been compiled
6685c6c1daeSBarry Smith   with flag -DPETSC_HAVE_MPE (MPE is an additional utility within
6695c6c1daeSBarry Smith   MPICH), the user can employ another command line option, -log_mpe,
6705c6c1daeSBarry Smith   to create a logfile, "mpe.log", which can be visualized
671495fc317SBarry Smith   Jumpshot.
6725c6c1daeSBarry Smith 
6735c6c1daeSBarry Smith   The classid is associated with each event so that classes of events
6745c6c1daeSBarry Smith   can be disabled simultaneously, such as all matrix events. The user
6755c6c1daeSBarry Smith   can either use an existing classid, such as MAT_CLASSID, or create
6765c6c1daeSBarry Smith   their own as shown in the example.
6775c6c1daeSBarry Smith 
678c5deb1d5SJed Brown   If an existing event with the same name exists, its event handle is
679c5deb1d5SJed Brown   returned instead of creating a new event.
680c5deb1d5SJed Brown 
6815c6c1daeSBarry Smith   Level: intermediate
6825c6c1daeSBarry Smith 
6835c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogFlops(),
6845c6c1daeSBarry Smith           PetscLogEventActivate(), PetscLogEventDeactivate(), PetscClassIdRegister()
6855c6c1daeSBarry Smith @*/
6865c6c1daeSBarry Smith PetscErrorCode  PetscLogEventRegister(const char name[],PetscClassId classid,PetscLogEvent *event)
6875c6c1daeSBarry Smith {
6885c6c1daeSBarry Smith   PetscStageLog  stageLog;
6895c6c1daeSBarry Smith   int            stage;
6905c6c1daeSBarry Smith 
6915c6c1daeSBarry Smith   PetscFunctionBegin;
6925c6c1daeSBarry Smith   *event = PETSC_DECIDE;
6935f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
6945f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscEventRegLogGetEvent(stageLog->eventLog, name, event));
695c5deb1d5SJed Brown   if (*event > 0) PetscFunctionReturn(0);
6965f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscEventRegLogRegister(stageLog->eventLog, name, classid, event));
6975c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
6985f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents));
6995f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses));
7005c6c1daeSBarry Smith   }
7015c6c1daeSBarry Smith   PetscFunctionReturn(0);
7025c6c1daeSBarry Smith }
7035c6c1daeSBarry Smith 
7045c6c1daeSBarry Smith /*@
705217044c2SLisandro Dalcin   PetscLogEventSetCollective - Indicates that a particular event is collective.
706217044c2SLisandro Dalcin 
707217044c2SLisandro Dalcin   Not Collective
708217044c2SLisandro Dalcin 
709d8d19677SJose E. Roman   Input Parameters:
710217044c2SLisandro Dalcin + event - The event id
711217044c2SLisandro Dalcin - collective - Bolean flag indicating whether a particular event is collective
712217044c2SLisandro Dalcin 
713217044c2SLisandro Dalcin   Note:
714217044c2SLisandro Dalcin   New events returned from PetscLogEventRegister() are collective by default.
715217044c2SLisandro Dalcin 
716217044c2SLisandro Dalcin   Level: developer
717217044c2SLisandro Dalcin 
718217044c2SLisandro Dalcin .seealso: PetscLogEventRegister()
719217044c2SLisandro Dalcin @*/
720217044c2SLisandro Dalcin PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event,PetscBool collective)
721217044c2SLisandro Dalcin {
722217044c2SLisandro Dalcin   PetscStageLog    stageLog;
723217044c2SLisandro Dalcin   PetscEventRegLog eventRegLog;
724217044c2SLisandro Dalcin 
725217044c2SLisandro Dalcin   PetscFunctionBegin;
7265f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
7275f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogGetEventRegLog(stageLog,&eventRegLog));
7282c71b3e2SJacob Faibussowitsch   PetscCheckFalse(event < 0 || event > eventRegLog->numEvents,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Invalid event id");
729217044c2SLisandro Dalcin   eventRegLog->eventInfo[event].collective = collective;
730217044c2SLisandro Dalcin   PetscFunctionReturn(0);
731217044c2SLisandro Dalcin }
732217044c2SLisandro Dalcin 
733217044c2SLisandro Dalcin /*@
734fa2bb9feSLisandro Dalcin   PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage.
735fa2bb9feSLisandro Dalcin 
736fa2bb9feSLisandro Dalcin   Not Collective
737fa2bb9feSLisandro Dalcin 
738fa2bb9feSLisandro Dalcin   Input Parameter:
739fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc.
740fa2bb9feSLisandro Dalcin 
741fa2bb9feSLisandro Dalcin   Level: developer
742fa2bb9feSLisandro Dalcin 
743fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate()
744fa2bb9feSLisandro Dalcin @*/
745fa2bb9feSLisandro Dalcin PetscErrorCode  PetscLogEventIncludeClass(PetscClassId classid)
746fa2bb9feSLisandro Dalcin {
747fa2bb9feSLisandro Dalcin   PetscStageLog  stageLog;
748fa2bb9feSLisandro Dalcin   int            stage;
749fa2bb9feSLisandro Dalcin 
750fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
7515f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
752fa2bb9feSLisandro Dalcin   for (stage = 0; stage < stageLog->numStages; stage++) {
7535f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid));
754fa2bb9feSLisandro Dalcin   }
755fa2bb9feSLisandro Dalcin   PetscFunctionReturn(0);
756fa2bb9feSLisandro Dalcin }
757fa2bb9feSLisandro Dalcin 
758fa2bb9feSLisandro Dalcin /*@
759fa2bb9feSLisandro Dalcin   PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage.
760fa2bb9feSLisandro Dalcin 
761fa2bb9feSLisandro Dalcin   Not Collective
762fa2bb9feSLisandro Dalcin 
763fa2bb9feSLisandro Dalcin   Input Parameter:
764fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc.
765fa2bb9feSLisandro Dalcin 
766fa2bb9feSLisandro Dalcin   Level: developer
767fa2bb9feSLisandro Dalcin 
768fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivateClass(),PetscLogEventDeactivate(),PetscLogEventActivate()
769fa2bb9feSLisandro Dalcin @*/
770fa2bb9feSLisandro Dalcin PetscErrorCode  PetscLogEventExcludeClass(PetscClassId classid)
771fa2bb9feSLisandro Dalcin {
772fa2bb9feSLisandro Dalcin   PetscStageLog  stageLog;
773fa2bb9feSLisandro Dalcin   int            stage;
774fa2bb9feSLisandro Dalcin 
775fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
7765f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
777fa2bb9feSLisandro Dalcin   for (stage = 0; stage < stageLog->numStages; stage++) {
7785f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid));
779fa2bb9feSLisandro Dalcin   }
780fa2bb9feSLisandro Dalcin   PetscFunctionReturn(0);
781fa2bb9feSLisandro Dalcin }
782fa2bb9feSLisandro Dalcin 
783fa2bb9feSLisandro Dalcin /*@
7845c6c1daeSBarry Smith   PetscLogEventActivate - Indicates that a particular event should be logged.
7855c6c1daeSBarry Smith 
7865c6c1daeSBarry Smith   Not Collective
7875c6c1daeSBarry Smith 
7885c6c1daeSBarry Smith   Input Parameter:
7895c6c1daeSBarry Smith . event - The event id
7905c6c1daeSBarry Smith 
7915c6c1daeSBarry Smith   Usage:
7925c6c1daeSBarry Smith .vb
7935c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
7945c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
7955c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
7965c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
7975c6c1daeSBarry Smith .ve
7985c6c1daeSBarry Smith 
7995c6c1daeSBarry Smith   Note:
8005c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in include/petsclog.h)
8015c6c1daeSBarry Smith   or an event number obtained with PetscLogEventRegister().
8025c6c1daeSBarry Smith 
8035c6c1daeSBarry Smith   Level: advanced
8045c6c1daeSBarry Smith 
805c00cb57fSBarry Smith .seealso: PlogEventDeactivate(), PlogEventDeactivatePush(), PetscLogEventDeactivatePop()
8065c6c1daeSBarry Smith @*/
8075c6c1daeSBarry Smith PetscErrorCode  PetscLogEventActivate(PetscLogEvent event)
8085c6c1daeSBarry Smith {
8095c6c1daeSBarry Smith   PetscStageLog  stageLog;
8105c6c1daeSBarry Smith   int            stage;
8115c6c1daeSBarry Smith 
8125c6c1daeSBarry Smith   PetscFunctionBegin;
8135f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
8145f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogGetCurrent(stageLog, &stage));
8155f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event));
8165c6c1daeSBarry Smith   PetscFunctionReturn(0);
8175c6c1daeSBarry Smith }
8185c6c1daeSBarry Smith 
8195c6c1daeSBarry Smith /*@
8205c6c1daeSBarry Smith   PetscLogEventDeactivate - Indicates that a particular event should not be logged.
8215c6c1daeSBarry Smith 
8225c6c1daeSBarry Smith   Not Collective
8235c6c1daeSBarry Smith 
8245c6c1daeSBarry Smith   Input Parameter:
8255c6c1daeSBarry Smith . event - The event id
8265c6c1daeSBarry Smith 
8275c6c1daeSBarry Smith   Usage:
8285c6c1daeSBarry Smith .vb
8295c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
8305c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
8315c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
8325c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
8335c6c1daeSBarry Smith .ve
8345c6c1daeSBarry Smith 
8355c6c1daeSBarry Smith   Note:
8365c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in
8375c6c1daeSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
8385c6c1daeSBarry Smith 
8395c6c1daeSBarry Smith   Level: advanced
8405c6c1daeSBarry Smith 
841c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePush(), PetscLogEventDeactivatePop()
8425c6c1daeSBarry Smith @*/
8435c6c1daeSBarry Smith PetscErrorCode  PetscLogEventDeactivate(PetscLogEvent event)
8445c6c1daeSBarry Smith {
8455c6c1daeSBarry Smith   PetscStageLog  stageLog;
8465c6c1daeSBarry Smith   int            stage;
8475c6c1daeSBarry Smith 
8485c6c1daeSBarry Smith   PetscFunctionBegin;
8495f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
8505f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogGetCurrent(stageLog, &stage));
8515f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event));
8525c6c1daeSBarry Smith   PetscFunctionReturn(0);
8535c6c1daeSBarry Smith }
8545c6c1daeSBarry Smith 
8555c6c1daeSBarry Smith /*@
856c00cb57fSBarry Smith   PetscLogEventDeactivatePush - Indicates that a particular event should not be logged.
857c00cb57fSBarry Smith 
858c00cb57fSBarry Smith   Not Collective
859c00cb57fSBarry Smith 
860c00cb57fSBarry Smith   Input Parameter:
861c00cb57fSBarry Smith . event - The event id
862c00cb57fSBarry Smith 
863c00cb57fSBarry Smith   Usage:
864c00cb57fSBarry Smith .vb
865c00cb57fSBarry Smith       PetscLogEventDeactivatePush(VEC_SetValues);
866c00cb57fSBarry Smith         [code where you do not want to log VecSetValues()]
867c00cb57fSBarry Smith       PetscLogEventDeactivatePop(VEC_SetValues);
868c00cb57fSBarry Smith         [code where you do want to log VecSetValues()]
869c00cb57fSBarry Smith .ve
870c00cb57fSBarry Smith 
871c00cb57fSBarry Smith   Note:
872c00cb57fSBarry Smith   The event may be either a pre-defined PETSc event (found in
873c00cb57fSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
874c00cb57fSBarry Smith 
875c00cb57fSBarry Smith   Level: advanced
876c00cb57fSBarry Smith 
877c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePop()
878c00cb57fSBarry Smith @*/
879c00cb57fSBarry Smith PetscErrorCode  PetscLogEventDeactivatePush(PetscLogEvent event)
880c00cb57fSBarry Smith {
881c00cb57fSBarry Smith   PetscStageLog  stageLog;
882c00cb57fSBarry Smith   int            stage;
883c00cb57fSBarry Smith 
884c00cb57fSBarry Smith   PetscFunctionBegin;
8855f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
8865f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogGetCurrent(stageLog, &stage));
8875f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscEventPerfLogDeactivatePush(stageLog->stageInfo[stage].eventLog, event));
888c00cb57fSBarry Smith   PetscFunctionReturn(0);
889c00cb57fSBarry Smith }
890c00cb57fSBarry Smith 
891c00cb57fSBarry Smith /*@
892c00cb57fSBarry Smith   PetscLogEventDeactivatePop - Indicates that a particular event shouldbe logged.
893c00cb57fSBarry Smith 
894c00cb57fSBarry Smith   Not Collective
895c00cb57fSBarry Smith 
896c00cb57fSBarry Smith   Input Parameter:
897c00cb57fSBarry Smith . event - The event id
898c00cb57fSBarry Smith 
899c00cb57fSBarry Smith   Usage:
900c00cb57fSBarry Smith .vb
901c00cb57fSBarry Smith       PetscLogEventDeactivatePush(VEC_SetValues);
902c00cb57fSBarry Smith         [code where you do not want to log VecSetValues()]
903c00cb57fSBarry Smith       PetscLogEventDeactivatePop(VEC_SetValues);
904c00cb57fSBarry Smith         [code where you do want to log VecSetValues()]
905c00cb57fSBarry Smith .ve
906c00cb57fSBarry Smith 
907c00cb57fSBarry Smith   Note:
908c00cb57fSBarry Smith   The event may be either a pre-defined PETSc event (found in
909c00cb57fSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
910c00cb57fSBarry Smith 
911c00cb57fSBarry Smith   Level: advanced
912c00cb57fSBarry Smith 
913c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePush()
914c00cb57fSBarry Smith @*/
915c00cb57fSBarry Smith PetscErrorCode  PetscLogEventDeactivatePop(PetscLogEvent event)
916c00cb57fSBarry Smith {
917c00cb57fSBarry Smith   PetscStageLog  stageLog;
918c00cb57fSBarry Smith   int            stage;
919c00cb57fSBarry Smith 
920c00cb57fSBarry Smith   PetscFunctionBegin;
9215f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
9225f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogGetCurrent(stageLog, &stage));
9235f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscEventPerfLogDeactivatePop(stageLog->stageInfo[stage].eventLog, event));
924c00cb57fSBarry Smith   PetscFunctionReturn(0);
925c00cb57fSBarry Smith }
926c00cb57fSBarry Smith 
927c00cb57fSBarry Smith /*@
9285c6c1daeSBarry Smith   PetscLogEventSetActiveAll - Sets the event activity in every stage.
9295c6c1daeSBarry Smith 
9305c6c1daeSBarry Smith   Not Collective
9315c6c1daeSBarry Smith 
9325c6c1daeSBarry Smith   Input Parameters:
9335c6c1daeSBarry Smith + event    - The event id
9345c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged
9355c6c1daeSBarry Smith 
9365c6c1daeSBarry Smith   Level: advanced
9375c6c1daeSBarry Smith 
938ec303c53SPatrick Sanan .seealso: PlogEventActivate(),PlogEventDeactivate()
9395c6c1daeSBarry Smith @*/
9405c6c1daeSBarry Smith PetscErrorCode  PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive)
9415c6c1daeSBarry Smith {
9425c6c1daeSBarry Smith   PetscStageLog  stageLog;
9435c6c1daeSBarry Smith   int            stage;
9445c6c1daeSBarry Smith 
9455c6c1daeSBarry Smith   PetscFunctionBegin;
9465f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
9475c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
9485c6c1daeSBarry Smith     if (isActive) {
9495f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event));
9505c6c1daeSBarry Smith     } else {
9515f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event));
9525c6c1daeSBarry Smith     }
9535c6c1daeSBarry Smith   }
9545c6c1daeSBarry Smith   PetscFunctionReturn(0);
9555c6c1daeSBarry Smith }
9565c6c1daeSBarry Smith 
9575c6c1daeSBarry Smith /*@
9585c6c1daeSBarry Smith   PetscLogEventActivateClass - Activates event logging for a PETSc object class.
9595c6c1daeSBarry Smith 
9605c6c1daeSBarry Smith   Not Collective
9615c6c1daeSBarry Smith 
9625c6c1daeSBarry Smith   Input Parameter:
9635c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc.
9645c6c1daeSBarry Smith 
9655c6c1daeSBarry Smith   Level: developer
9665c6c1daeSBarry Smith 
967fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate()
9685c6c1daeSBarry Smith @*/
9695c6c1daeSBarry Smith PetscErrorCode  PetscLogEventActivateClass(PetscClassId classid)
9705c6c1daeSBarry Smith {
9715c6c1daeSBarry Smith   PetscStageLog  stageLog;
9725c6c1daeSBarry Smith   int            stage;
9735c6c1daeSBarry Smith 
9745c6c1daeSBarry Smith   PetscFunctionBegin;
9755f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
9765f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogGetCurrent(stageLog, &stage));
9775f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid));
9785c6c1daeSBarry Smith   PetscFunctionReturn(0);
9795c6c1daeSBarry Smith }
9805c6c1daeSBarry Smith 
9815c6c1daeSBarry Smith /*@
9825c6c1daeSBarry Smith   PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class.
9835c6c1daeSBarry Smith 
9845c6c1daeSBarry Smith   Not Collective
9855c6c1daeSBarry Smith 
9865c6c1daeSBarry Smith   Input Parameter:
9875c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc.
9885c6c1daeSBarry Smith 
9895c6c1daeSBarry Smith   Level: developer
9905c6c1daeSBarry Smith 
991fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate()
9925c6c1daeSBarry Smith @*/
9935c6c1daeSBarry Smith PetscErrorCode  PetscLogEventDeactivateClass(PetscClassId classid)
9945c6c1daeSBarry Smith {
9955c6c1daeSBarry Smith   PetscStageLog  stageLog;
9965c6c1daeSBarry Smith   int            stage;
9975c6c1daeSBarry Smith 
9985c6c1daeSBarry Smith   PetscFunctionBegin;
9995f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
10005f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogGetCurrent(stageLog, &stage));
10015f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid));
10025c6c1daeSBarry Smith   PetscFunctionReturn(0);
10035c6c1daeSBarry Smith }
10045c6c1daeSBarry Smith 
10055c6c1daeSBarry Smith /*MC
100662872c28SLisandro Dalcin    PetscLogEventSync - Synchronizes the beginning of a user event.
100762872c28SLisandro Dalcin 
100862872c28SLisandro Dalcin    Synopsis:
100962872c28SLisandro Dalcin    #include <petsclog.h>
101062872c28SLisandro Dalcin    PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm)
101162872c28SLisandro Dalcin 
101262872c28SLisandro Dalcin    Collective
101362872c28SLisandro Dalcin 
101462872c28SLisandro Dalcin    Input Parameters:
101562872c28SLisandro Dalcin +  e - integer associated with the event obtained from PetscLogEventRegister()
101662872c28SLisandro Dalcin -  comm - an MPI communicator
101762872c28SLisandro Dalcin 
101862872c28SLisandro Dalcin    Usage:
101962872c28SLisandro Dalcin .vb
102062872c28SLisandro Dalcin      PetscLogEvent USER_EVENT;
102162872c28SLisandro Dalcin      PetscLogEventRegister("User event",0,&USER_EVENT);
102262872c28SLisandro Dalcin      PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD);
102362872c28SLisandro Dalcin      PetscLogEventBegin(USER_EVENT,0,0,0,0);
102462872c28SLisandro Dalcin         [code segment to monitor]
102562872c28SLisandro Dalcin      PetscLogEventEnd(USER_EVENT,0,0,0,0);
102662872c28SLisandro Dalcin .ve
102762872c28SLisandro Dalcin 
102862872c28SLisandro Dalcin    Notes:
102962872c28SLisandro Dalcin    This routine should be called only if there is not a
103062872c28SLisandro Dalcin    PetscObject available to pass to PetscLogEventBegin().
103162872c28SLisandro Dalcin 
103262872c28SLisandro Dalcin    Level: developer
103362872c28SLisandro Dalcin 
103462872c28SLisandro Dalcin .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd()
103562872c28SLisandro Dalcin 
103662872c28SLisandro Dalcin M*/
103762872c28SLisandro Dalcin 
103862872c28SLisandro Dalcin /*MC
10395c6c1daeSBarry Smith    PetscLogEventBegin - Logs the beginning of a user event.
10405c6c1daeSBarry Smith 
10415c6c1daeSBarry Smith    Synopsis:
1042aaa7dc30SBarry Smith    #include <petsclog.h>
1043f2ba6396SBarry Smith    PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
10445c6c1daeSBarry Smith 
10455c6c1daeSBarry Smith    Not Collective
10465c6c1daeSBarry Smith 
10475c6c1daeSBarry Smith    Input Parameters:
10485c6c1daeSBarry Smith +  e - integer associated with the event obtained from PetscLogEventRegister()
10495c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
10505c6c1daeSBarry Smith 
10515c6c1daeSBarry Smith    Fortran Synopsis:
10525c6c1daeSBarry Smith    void PetscLogEventBegin(int e,PetscErrorCode ierr)
10535c6c1daeSBarry Smith 
10545c6c1daeSBarry Smith    Usage:
10555c6c1daeSBarry Smith .vb
10565c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
10575c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
10585c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
10595c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
10605c6c1daeSBarry Smith         [code segment to monitor]
10615c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
10625c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
10635c6c1daeSBarry Smith .ve
10645c6c1daeSBarry Smith 
10655c6c1daeSBarry Smith    Notes:
10665c6c1daeSBarry Smith    You need to register each integer event with the command
1067a2553e36SBarry Smith    PetscLogEventRegister().
10685c6c1daeSBarry Smith 
10695c6c1daeSBarry Smith    Level: intermediate
10705c6c1daeSBarry Smith 
10715c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops()
10725c6c1daeSBarry Smith 
10735c6c1daeSBarry Smith M*/
10745c6c1daeSBarry Smith 
10755c6c1daeSBarry Smith /*MC
10765c6c1daeSBarry Smith    PetscLogEventEnd - Log the end of a user event.
10775c6c1daeSBarry Smith 
10785c6c1daeSBarry Smith    Synopsis:
1079aaa7dc30SBarry Smith    #include <petsclog.h>
1080f2ba6396SBarry Smith    PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
10815c6c1daeSBarry Smith 
10825c6c1daeSBarry Smith    Not Collective
10835c6c1daeSBarry Smith 
10845c6c1daeSBarry Smith    Input Parameters:
10855c6c1daeSBarry Smith +  e - integer associated with the event obtained with PetscLogEventRegister()
10865c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
10875c6c1daeSBarry Smith 
10885c6c1daeSBarry Smith    Fortran Synopsis:
10895c6c1daeSBarry Smith    void PetscLogEventEnd(int e,PetscErrorCode ierr)
10905c6c1daeSBarry Smith 
10915c6c1daeSBarry Smith    Usage:
10925c6c1daeSBarry Smith .vb
10935c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
10945c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
10955c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT,);
10965c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
10975c6c1daeSBarry Smith         [code segment to monitor]
10985c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
10995c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
11005c6c1daeSBarry Smith .ve
11015c6c1daeSBarry Smith 
11025c6c1daeSBarry Smith    Notes:
11035c6c1daeSBarry Smith    You should also register each additional integer event with the command
1104a2553e36SBarry Smith    PetscLogEventRegister().
11055c6c1daeSBarry Smith 
11065c6c1daeSBarry Smith    Level: intermediate
11075c6c1daeSBarry Smith 
11085c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogFlops()
11095c6c1daeSBarry Smith 
11105c6c1daeSBarry Smith M*/
11115c6c1daeSBarry Smith 
11125c6c1daeSBarry Smith /*@C
11135c6c1daeSBarry Smith   PetscLogEventGetId - Returns the event id when given the event name.
11145c6c1daeSBarry Smith 
11155c6c1daeSBarry Smith   Not Collective
11165c6c1daeSBarry Smith 
11175c6c1daeSBarry Smith   Input Parameter:
11185c6c1daeSBarry Smith . name  - The event name
11195c6c1daeSBarry Smith 
11205c6c1daeSBarry Smith   Output Parameter:
1121c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists
11225c6c1daeSBarry Smith 
11235c6c1daeSBarry Smith   Level: intermediate
11245c6c1daeSBarry Smith 
11255c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStageGetId()
11265c6c1daeSBarry Smith @*/
11275c6c1daeSBarry Smith PetscErrorCode  PetscLogEventGetId(const char name[], PetscLogEvent *event)
11285c6c1daeSBarry Smith {
11295c6c1daeSBarry Smith   PetscStageLog  stageLog;
11305c6c1daeSBarry Smith 
11315c6c1daeSBarry Smith   PetscFunctionBegin;
11325f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
11335f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscEventRegLogGetEvent(stageLog->eventLog, name, event));
11345c6c1daeSBarry Smith   PetscFunctionReturn(0);
11355c6c1daeSBarry Smith }
11365c6c1daeSBarry Smith 
11375c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/
11385c6c1daeSBarry Smith /*@C
11395c6c1daeSBarry Smith   PetscLogDump - Dumps logs of objects to a file. This file is intended to
11405c6c1daeSBarry Smith   be read by bin/petscview. This program no longer exists.
11415c6c1daeSBarry Smith 
11425c6c1daeSBarry Smith   Collective on PETSC_COMM_WORLD
11435c6c1daeSBarry Smith 
11445c6c1daeSBarry Smith   Input Parameter:
11455c6c1daeSBarry Smith . name - an optional file name
11465c6c1daeSBarry Smith 
11475c6c1daeSBarry Smith   Usage:
11485c6c1daeSBarry Smith .vb
11495c6c1daeSBarry Smith      PetscInitialize(...);
1150bb1d7374SBarry Smith      PetscLogDefaultBegin(); or PetscLogAllBegin();
11515c6c1daeSBarry Smith      ... code ...
11525c6c1daeSBarry Smith      PetscLogDump(filename);
11535c6c1daeSBarry Smith      PetscFinalize();
11545c6c1daeSBarry Smith .ve
11555c6c1daeSBarry Smith 
11565c6c1daeSBarry Smith   Notes:
11575c6c1daeSBarry Smith   The default file name is
11585c6c1daeSBarry Smith $    Log.<rank>
11595c6c1daeSBarry Smith   where <rank> is the processor number. If no name is specified,
11605c6c1daeSBarry Smith   this file will be used.
11615c6c1daeSBarry Smith 
11625c6c1daeSBarry Smith   Level: advanced
11635c6c1daeSBarry Smith 
1164bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogView()
11655c6c1daeSBarry Smith @*/
11665c6c1daeSBarry Smith PetscErrorCode  PetscLogDump(const char sname[])
11675c6c1daeSBarry Smith {
11685c6c1daeSBarry Smith   PetscStageLog      stageLog;
11695c6c1daeSBarry Smith   PetscEventPerfInfo *eventInfo;
11705c6c1daeSBarry Smith   FILE               *fd;
11715c6c1daeSBarry Smith   char               file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN];
11725c6c1daeSBarry Smith   PetscLogDouble     flops, _TotalTime;
11735c6c1daeSBarry Smith   PetscMPIInt        rank;
11745c6c1daeSBarry Smith   int                action, object, curStage;
11755c6c1daeSBarry Smith   PetscLogEvent      event;
11765c6c1daeSBarry Smith   PetscErrorCode     ierr;
11775c6c1daeSBarry Smith 
11785c6c1daeSBarry Smith   PetscFunctionBegin;
11795c6c1daeSBarry Smith   /* Calculate the total elapsed time */
11808563dfccSBarry Smith   PetscTime(&_TotalTime);
11815c6c1daeSBarry Smith   _TotalTime -= petsc_BaseTime;
11825c6c1daeSBarry Smith   /* Open log file */
11835f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank));
11847ff663adSLisandro Dalcin   if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank);
1185a297a907SKarl Rupp   else sprintf(file, "Log.%d", rank);
11865f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFixFilename(file, fname));
11875f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd));
11882c71b3e2SJacob Faibussowitsch   PetscCheckFalse((rank == 0) && (!fd),PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname);
11895c6c1daeSBarry Smith   /* Output totals */
11905f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime));
11915f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0));
11925c6c1daeSBarry Smith   /* Output actions */
11935c6c1daeSBarry Smith   if (petsc_logActions) {
11945f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions));
11955c6c1daeSBarry Smith     for (action = 0; action < petsc_numActions; action++) {
11965c6c1daeSBarry Smith       ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n",
11975c6c1daeSBarry Smith                           petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1,
1198a2ea699eSBarry Smith                           petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem);CHKERRQ(ierr);
11995c6c1daeSBarry Smith     }
12005c6c1daeSBarry Smith   }
12015c6c1daeSBarry Smith   /* Output objects */
12025c6c1daeSBarry Smith   if (petsc_logObjects) {
12035f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed));
12045c6c1daeSBarry Smith     for (object = 0; object < petsc_numObjects; object++) {
12055f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int) petsc_objects[object].mem));
12065c6c1daeSBarry Smith       if (!petsc_objects[object].name[0]) {
12075f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscFPrintf(PETSC_COMM_WORLD, fd,"No Name\n"));
12085c6c1daeSBarry Smith       } else {
12095f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name));
12105c6c1daeSBarry Smith       }
12115c6c1daeSBarry Smith       if (petsc_objects[object].info[0] != 0) {
12125f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n"));
12135c6c1daeSBarry Smith       } else {
12145f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info));
12155c6c1daeSBarry Smith       }
12165c6c1daeSBarry Smith     }
12175c6c1daeSBarry Smith   }
12185c6c1daeSBarry Smith   /* Output events */
12195f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n"));
12205f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
12215f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscIntStackTop(stageLog->stack, &curStage));
12225c6c1daeSBarry Smith   eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo;
12235c6c1daeSBarry Smith   for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) {
1224a297a907SKarl Rupp     if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops/eventInfo[event].time;
1225a297a907SKarl Rupp     else flops = 0.0;
12265c6c1daeSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count,
1227a2ea699eSBarry Smith                         eventInfo[event].flops, eventInfo[event].time, flops);CHKERRQ(ierr);
12285c6c1daeSBarry Smith   }
12295f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFClose(PETSC_COMM_WORLD, fd));
12305c6c1daeSBarry Smith   PetscFunctionReturn(0);
12315c6c1daeSBarry Smith }
12325c6c1daeSBarry Smith 
1233f14045dbSBarry Smith /*
1234f14045dbSBarry Smith   PetscLogView_Detailed - Each process prints the times for its own events
1235f14045dbSBarry Smith 
1236f14045dbSBarry Smith */
1237f14045dbSBarry Smith PetscErrorCode  PetscLogView_Detailed(PetscViewer viewer)
1238f14045dbSBarry Smith {
12392dff6485SMatthew G. Knepley   PetscStageLog      stageLog;
1240217044c2SLisandro Dalcin   PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL;
1241217044c2SLisandro Dalcin   PetscLogDouble     locTotalTime, numRed, maxMem;
12422dff6485SMatthew G. Knepley   int                numStages,numEvents,stage,event;
1243217044c2SLisandro Dalcin   MPI_Comm           comm = PetscObjectComm((PetscObject) viewer);
12442dff6485SMatthew G. Knepley   PetscMPIInt        rank,size;
12452dff6485SMatthew G. Knepley   PetscErrorCode     ierr;
1246f14045dbSBarry Smith 
1247f14045dbSBarry Smith   PetscFunctionBegin;
12485f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_size(comm, &size));
12495f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_rank(comm, &rank));
12502dff6485SMatthew G. Knepley   /* Must preserve reduction count before we go on */
12512dff6485SMatthew G. Knepley   numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
12522d1ec343SBarry Smith   /* Get the total elapsed time */
12532d1ec343SBarry Smith   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
12545f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPrintf(viewer,"size = %d\n",size));
12555f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPrintf(viewer,"LocalTimes = {}\n"));
12565f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPrintf(viewer,"LocalMessages = {}\n"));
12575f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPrintf(viewer,"LocalMessageLens = {}\n"));
12585f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPrintf(viewer,"LocalReductions = {}\n"));
12595f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPrintf(viewer,"LocalFlop = {}\n"));
12605f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPrintf(viewer,"LocalObjects = {}\n"));
12615f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPrintf(viewer,"LocalMemory = {}\n"));
12625f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
12635f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm));
12645f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPrintf(viewer,"Stages = {}\n"));
12652d1ec343SBarry Smith   for (stage=0; stage<numStages; stage++) {
12665f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"] = {}\n",stageLog->stageInfo[stage].name));
12675f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"summary\"] = {}\n",stageLog->stageInfo[stage].name));
12685f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm));
12692d1ec343SBarry Smith     for (event = 0; event < numEvents; event++) {
12705f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"%s\"] = {}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name));
12712d1ec343SBarry Smith     }
12722d1ec343SBarry Smith   }
12735f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMallocGetMaximumUsage(&maxMem));
12745f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPushSynchronized(viewer));
12755f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer,"LocalTimes[%d] = %g\n",rank,locTotalTime));
12765f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessages[%d] = %g\n",rank,(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct)));
12775f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessageLens[%d] = %g\n",rank,(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len)));
12785f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer,"LocalReductions[%d] = %g\n",rank,numRed));
12795f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer,"LocalFlop[%d] = %g\n",rank,petsc_TotalFlops));
12805f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer,"LocalObjects[%d] = %d\n",rank,petsc_numObjects));
12815f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer,"LocalMemory[%d] = %g\n",rank,maxMem));
12825f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerFlush(viewer));
12832d1ec343SBarry Smith   for (stage=0; stage<numStages; stage++) {
1284217044c2SLisandro Dalcin     stageInfo = &stageLog->stageInfo[stage].perfInfo;
1285d4aa7d5fSBarry Smith     ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n",
12862dff6485SMatthew G. Knepley                                               stageLog->stageInfo[stage].name,rank,
1287217044c2SLisandro Dalcin                                               stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr);
12885f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm));
12892d1ec343SBarry Smith     for (event = 0; event < numEvents; event++) {
1290217044c2SLisandro Dalcin       eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event];
12913ca90d2dSJacob Faibussowitsch       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %d, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g",
1292217044c2SLisandro Dalcin                                                 stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name,rank,
1293217044c2SLisandro Dalcin                                                 eventInfo->count,eventInfo->time,eventInfo->syncTime,eventInfo->numMessages,eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr);
1294891e75beSMatthew G. Knepley       if (eventInfo->dof[0] >= 0.) {
1295891e75beSMatthew G. Knepley         PetscInt d, e;
12965d68e14cSMatthew G. Knepley 
12975f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : ["));
1298891e75beSMatthew G. Knepley         for (d = 0; d < 8; ++d) {
12995f80ce2aSJacob Faibussowitsch           if (d > 0) CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer, ", "));
13005f80ce2aSJacob Faibussowitsch           CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d]));
1301891e75beSMatthew G. Knepley         }
13025f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer, "]"));
13035f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : ["));
13045d68e14cSMatthew G. Knepley         for (e = 0; e < 8; ++e) {
13055f80ce2aSJacob Faibussowitsch           if (e > 0) CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer, ", "));
13065f80ce2aSJacob Faibussowitsch           CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e]));
13075d68e14cSMatthew G. Knepley         }
13085f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer, "]"));
13095d68e14cSMatthew G. Knepley       }
13105f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer,"}\n"));
13112d1ec343SBarry Smith     }
13122d1ec343SBarry Smith   }
13135f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerFlush(viewer));
13145f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPopSynchronized(viewer));
1315f14045dbSBarry Smith   PetscFunctionReturn(0);
1316f14045dbSBarry Smith }
1317f14045dbSBarry Smith 
131838144912Sdeepblu2718 /*
131938144912Sdeepblu2718   PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format
132038144912Sdeepblu2718 */
132138144912Sdeepblu2718 PetscErrorCode  PetscLogView_CSV(PetscViewer viewer)
132238144912Sdeepblu2718 {
132338144912Sdeepblu2718   PetscStageLog      stageLog;
1324669c5be0SSatish Balay   PetscEventPerfInfo *eventInfo = NULL;
132538144912Sdeepblu2718   PetscLogDouble     locTotalTime, maxMem;
132638144912Sdeepblu2718   int                numStages,numEvents,stage,event;
132738144912Sdeepblu2718   MPI_Comm           comm = PetscObjectComm((PetscObject) viewer);
132838144912Sdeepblu2718   PetscMPIInt        rank,size;
132938144912Sdeepblu2718   PetscErrorCode     ierr;
133038144912Sdeepblu2718 
133138144912Sdeepblu2718   PetscFunctionBegin;
13325f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_size(comm, &size));
13335f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_rank(comm, &rank));
133438144912Sdeepblu2718   /* Must preserve reduction count before we go on */
133538144912Sdeepblu2718   /* Get the total elapsed time */
133638144912Sdeepblu2718   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
13375f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
13385f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm));
13395f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMallocGetMaximumUsage(&maxMem));
13405f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPushSynchronized(viewer));
1341a2fddd78SAlbert Cowie   ierr = 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);
13425f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerFlush(viewer));
134338144912Sdeepblu2718   for (stage=0; stage<numStages; stage++) {
13449e29573dSMatthew G. Knepley     PetscEventPerfInfo *stageInfo = &stageLog->stageInfo[stage].perfInfo;
13459e29573dSMatthew G. Knepley 
1346a2fddd78SAlbert Cowie     ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,summary,%d,1,%g,%g,%g,%g,%g\n",
13479e29573dSMatthew G. Knepley                                               stageLog->stageInfo[stage].name,rank,stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr);
13485f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm));
134938144912Sdeepblu2718     for (event = 0; event < numEvents; event++) {
135038144912Sdeepblu2718       eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event];
13513ca90d2dSJacob Faibussowitsch       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,%s,%d,%d,%g,%g,%g,%g,%g",stageLog->stageInfo[stage].name,
1352a2fddd78SAlbert Cowie                                                 stageLog->eventLog->eventInfo[event].name,rank,eventInfo->count,eventInfo->time,eventInfo->numMessages,
135338144912Sdeepblu2718                                                 eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr);
135438144912Sdeepblu2718       if (eventInfo->dof[0] >= 0.) {
135538144912Sdeepblu2718         PetscInt d, e;
135638144912Sdeepblu2718 
135738144912Sdeepblu2718         for (d = 0; d < 8; ++d) {
13585f80ce2aSJacob Faibussowitsch           CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d]));
135938144912Sdeepblu2718         }
136038144912Sdeepblu2718         for (e = 0; e < 8; ++e) {
13615f80ce2aSJacob Faibussowitsch           CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e]));
136238144912Sdeepblu2718         }
136338144912Sdeepblu2718       }
13645f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscViewerASCIISynchronizedPrintf(viewer,"\n"));
136538144912Sdeepblu2718     }
136638144912Sdeepblu2718   }
13675f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerFlush(viewer));
13685f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIPopSynchronized(viewer));
136938144912Sdeepblu2718   PetscFunctionReturn(0);
137038144912Sdeepblu2718 }
137138144912Sdeepblu2718 
1372217044c2SLisandro Dalcin static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm,FILE *fd)
1373217044c2SLisandro Dalcin {
1374217044c2SLisandro Dalcin   PetscFunctionBegin;
1375217044c2SLisandro Dalcin   if (!PetscLogSyncOn) PetscFunctionReturn(0);
13765f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "\n\n"));
13775f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      ##########################################################\n"));
13785f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #                                                        #\n"));
13795f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n"));
13805f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #                                                        #\n"));
13815f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #   This program was run with logging synchronization.   #\n"));
13825f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #   This option provides more meaningful imbalance       #\n"));
13835f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #   figures at the expense of slowing things down and    #\n"));
13845f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #   providing a distorted view of the overall runtime.   #\n"));
13855f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #                                                        #\n"));
13865f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      ##########################################################\n\n\n"));
1387217044c2SLisandro Dalcin   PetscFunctionReturn(0);
1388217044c2SLisandro Dalcin }
1389217044c2SLisandro Dalcin 
1390f4091ad2SBarry Smith static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm,FILE *fd)
1391f4091ad2SBarry Smith {
1392f4091ad2SBarry Smith   PetscFunctionBegin;
139376bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
13945f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "\n\n"));
13955f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "      ##########################################################\n"));
13965f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "      #                                                        #\n"));
13975f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n"));
13985f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "      #                                                        #\n"));
13995f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "      #   This code was compiled with a debugging option.      #\n"));
14005f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "      #   To get timing results run ./configure                #\n"));
14015f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "      #   using --with-debugging=no, the performance will      #\n"));
14025f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "      #   be generally two or three times faster.              #\n"));
14035f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "      #                                                        #\n"));
14045f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "      ##########################################################\n\n\n"));
140576bd3646SJed Brown   }
1406f4091ad2SBarry Smith   PetscFunctionReturn(0);
1407f4091ad2SBarry Smith }
1408f4091ad2SBarry Smith 
1409c2a741eeSJunchao Zhang static PetscErrorCode PetscLogViewWarnNoGpuAwareMpi(MPI_Comm comm,FILE *fd)
1410c2a741eeSJunchao Zhang {
1411009ab46cSJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
1412009ab46cSJunchao Zhang   PetscMPIInt    size;
1413c2a741eeSJunchao Zhang 
1414c2a741eeSJunchao Zhang   PetscFunctionBegin;
14155f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_size(comm, &size));
1416340fe3cdSSatish Balay   if (use_gpu_aware_mpi || size == 1) PetscFunctionReturn(0);
14175f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "\n\n"));
14185f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      ##########################################################\n"));
14195f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #                                                        #\n"));
14205f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n"));
14215f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #                                                        #\n"));
14225f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #   This code was compiled with GPU support and you've   #\n"));
14235f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #   created PETSc/GPU objects, but you intentionally     #\n"));
14245f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #   used -use_gpu_aware_mpi 0, requiring PETSc to copy   #\n"));
14255f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #   additional data between the GPU and CPU. To obtain   #\n"));
14265f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #   meaningful timing results on multi-rank runs, use    #\n"));
14275f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #   GPU-aware MPI instead.                               #\n"));
14285f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      #                                                        #\n"));
14295f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      ##########################################################\n\n\n"));
1430c2a741eeSJunchao Zhang   PetscFunctionReturn(0);
1431c2a741eeSJunchao Zhang #else
1432c2a741eeSJunchao Zhang   return 0;
1433c2a741eeSJunchao Zhang #endif
1434c2a741eeSJunchao Zhang }
1435c2a741eeSJunchao Zhang 
1436f14045dbSBarry Smith PetscErrorCode  PetscLogView_Default(PetscViewer viewer)
14375c6c1daeSBarry Smith {
14385c6c1daeSBarry Smith   FILE               *fd;
14395c6c1daeSBarry Smith   PetscLogDouble     zero       = 0.0;
14405c6c1daeSBarry Smith   PetscStageLog      stageLog;
14410298fd71SBarry Smith   PetscStageInfo     *stageInfo = NULL;
14420298fd71SBarry Smith   PetscEventPerfInfo *eventInfo = NULL;
14435c6c1daeSBarry Smith   PetscClassPerfInfo *classInfo;
14445c6c1daeSBarry Smith   char               arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128];
14455c6c1daeSBarry Smith   const char         *name;
14465c6c1daeSBarry Smith   PetscLogDouble     locTotalTime, TotalTime, TotalFlops;
14475c6c1daeSBarry Smith   PetscLogDouble     numMessages, messageLength, avgMessLen, numReductions;
14485c6c1daeSBarry Smith   PetscLogDouble     stageTime, flops, flopr, mem, mess, messLen, red;
14495c6c1daeSBarry Smith   PetscLogDouble     fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed;
14505c6c1daeSBarry Smith   PetscLogDouble     fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed;
14515c6c1daeSBarry Smith   PetscLogDouble     min, max, tot, ratio, avg, x, y;
1452e3ed9ee7SBarry Smith   PetscLogDouble     minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr, mal, malmax, emalmax;
1453d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1454958c4211Shannah_mairs   PetscLogDouble     cct, gct, csz, gsz, gmaxt, gflops, gflopr, fracgflops;
1455bec0b493Shannah_mairs   #endif
1456217044c2SLisandro Dalcin   PetscMPIInt        minC, maxC;
14575c6c1daeSBarry Smith   PetscMPIInt        size, rank;
14585c6c1daeSBarry Smith   PetscBool          *localStageUsed,    *stageUsed;
14595c6c1daeSBarry Smith   PetscBool          *localStageVisible, *stageVisible;
14605c6c1daeSBarry Smith   int                numStages, localNumEvents, numEvents;
146137b78d16SBarry Smith   int                stage, oclass;
14625c6c1daeSBarry Smith   PetscLogEvent      event;
14635c6c1daeSBarry Smith   PetscErrorCode     ierr;
14645c6c1daeSBarry Smith   char               version[256];
14655c6c1daeSBarry Smith   MPI_Comm           comm;
14665c6c1daeSBarry Smith 
14675c6c1daeSBarry Smith   PetscFunctionBegin;
14685f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectGetComm((PetscObject)viewer,&comm));
14695f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerASCIIGetPointer(viewer,&fd));
14705f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_size(comm, &size));
14715f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Comm_rank(comm, &rank));
14725c6c1daeSBarry Smith   /* Get the total elapsed time */
14738563dfccSBarry Smith   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
14745c6c1daeSBarry Smith 
14755f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "**************************************** ***********************************************************************************************************************\n"));
14765f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "***                                WIDEN YOUR WINDOW TO 160 CHARACTERS.  Use 'enscript -r -fCourier9' to print this document                                 ***\n"));
14775f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n"));
14785f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "\n------------------------------------------------------------------ PETSc Performance Summary: -------------------------------------------------------------------\n\n"));
14795f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogViewWarnSync(comm,fd));
14805f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogViewWarnDebugging(comm,fd));
14815f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogViewWarnNoGpuAwareMpi(comm,fd));
14825f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscGetArchType(arch,sizeof(arch)));
14835f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscGetHostName(hostname,sizeof(hostname)));
14845f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscGetUserName(username,sizeof(username)));
14855f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscGetProgramName(pname,sizeof(pname)));
14865f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscGetDate(date,sizeof(date)));
14875f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscGetVersion(version,sizeof(version)));
14885c6c1daeSBarry Smith   if (size == 1) {
14895f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm,fd,"%s on a %s named %s with %d processor, by %s %s\n", pname, arch, hostname, size, username, date));
14905c6c1daeSBarry Smith   } else {
14915f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm,fd,"%s on a %s named %s with %d processors, by %s %s\n", pname, arch, hostname, size, username, date));
14925c6c1daeSBarry Smith   }
1493f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP)
14945f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm,fd,"Using %" PetscInt_FMT " OpenMP threads\n", PetscNumOMPThreads));
1495f90b075cSBarry Smith #endif
14965f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Using %s\n", version));
14975c6c1daeSBarry Smith 
14985c6c1daeSBarry Smith   /* Must preserve reduction count before we go on */
14995c6c1daeSBarry Smith   red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
15005c6c1daeSBarry Smith 
15015c6c1daeSBarry Smith   /* Calculate summary information */
15025f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "\n                         Max       Max/Min     Avg       Total\n"));
15035c6c1daeSBarry Smith   /*   Time */
15045f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15055f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15065f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1507217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1508217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
15095f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Time (sec):           %5.3e   %7.3f   %5.3e\n", max, ratio, avg));
15105c6c1daeSBarry Smith   TotalTime = tot;
15115c6c1daeSBarry Smith   /*   Objects */
15125c6c1daeSBarry Smith   avg  = (PetscLogDouble) petsc_numObjects;
15135f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&avg,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15145f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&avg,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15155f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&avg,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1516217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1517217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
15185f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Objects:              %5.3e   %7.3f   %5.3e\n", max, ratio, avg));
15195c6c1daeSBarry Smith   /*   Flops */
15205f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&petsc_TotalFlops,  &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15215f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&petsc_TotalFlops,  &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15225f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&petsc_TotalFlops,  &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1523217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1524217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
15255f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Flops:                %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
15265c6c1daeSBarry Smith   TotalFlops = tot;
15275c6c1daeSBarry Smith   /*   Flops/sec -- Must talk to Barry here */
1528217044c2SLisandro Dalcin   if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime; else flops = 0.0;
15295f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&flops,        &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15305f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&flops,        &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15315f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&flops,        &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1532217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1533217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
15345f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Flops/sec:            %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
15355c6c1daeSBarry Smith   /*   Memory */
15365f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMallocGetMaximumUsage(&mem));
15375c6c1daeSBarry Smith   if (mem > 0.0) {
15385f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Allreduce(&mem,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15395f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Allreduce(&mem,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15405f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Allreduce(&mem,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1541217044c2SLisandro Dalcin     avg  = tot/((PetscLogDouble) size);
1542217044c2SLisandro Dalcin     if (min != 0.0) ratio = max/min; else ratio = 0.0;
15435f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "Memory (bytes):       %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
15445c6c1daeSBarry Smith   }
15455c6c1daeSBarry Smith   /*   Messages */
15465c6c1daeSBarry Smith   mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct);
15475f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&mess,         &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15485f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&mess,         &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15495f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&mess,         &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1550217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1551217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
15525f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "MPI Msg Count:        %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
15535c6c1daeSBarry Smith   numMessages = tot;
15545c6c1daeSBarry Smith   /*   Message Lengths */
15555c6c1daeSBarry Smith   mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len);
15565f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&mess,         &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15575f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&mess,         &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15585f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&mess,         &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1559217044c2SLisandro Dalcin   if (numMessages != 0) avg = tot/numMessages; else avg = 0.0;
1560217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
15615f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "MPI Msg Len (bytes):  %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot));
15625c6c1daeSBarry Smith   messageLength = tot;
15635c6c1daeSBarry Smith   /*   Reductions */
15645f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&red,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
15655f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&red,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
15665f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&red,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1567217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
15685f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "MPI Reductions:       %5.3e   %7.3f\n", max, ratio));
15695c6c1daeSBarry Smith   numReductions = red; /* wrong because uses count from process zero */
15705f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n"));
15715f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "                            e.g., VecAXPY() for real vectors of length N --> 2N flops\n"));
15725f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "                            and VecAXPY() for complex vectors of length N --> 8N flops\n"));
15735c6c1daeSBarry Smith 
15745c6c1daeSBarry Smith   /* Get total number of stages --
15755c6c1daeSBarry Smith        Currently, a single processor can register more stages than another, but stages must all be registered in order.
15765c6c1daeSBarry Smith        We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID.
15775c6c1daeSBarry Smith        This seems best accomplished by assoicating a communicator with each stage.
15785c6c1daeSBarry Smith   */
15795f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
15805f80ce2aSJacob Faibussowitsch   CHKERRMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm));
15815f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMalloc1(numStages, &localStageUsed));
15825f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMalloc1(numStages, &stageUsed));
15835f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMalloc1(numStages, &localStageVisible));
15845f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscMalloc1(numStages, &stageVisible));
15855c6c1daeSBarry Smith   if (numStages > 0) {
15865c6c1daeSBarry Smith     stageInfo = stageLog->stageInfo;
15875c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
15885c6c1daeSBarry Smith       if (stage < stageLog->numStages) {
15895c6c1daeSBarry Smith         localStageUsed[stage]    = stageInfo[stage].used;
15905c6c1daeSBarry Smith         localStageVisible[stage] = stageInfo[stage].perfInfo.visible;
15915c6c1daeSBarry Smith       } else {
15925c6c1daeSBarry Smith         localStageUsed[stage]    = PETSC_FALSE;
15935c6c1daeSBarry Smith         localStageVisible[stage] = PETSC_TRUE;
15945c6c1daeSBarry Smith       }
15955c6c1daeSBarry Smith     }
15965f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Allreduce(localStageUsed,    stageUsed,    numStages, MPIU_BOOL, MPI_LOR,  comm));
15975f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm));
15985c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
15995c6c1daeSBarry Smith       if (stageUsed[stage]) {
16005f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscFPrintf(comm, fd, "\nSummary of Stages:   ----- Time ------  ----- Flop ------  --- Messages ---  -- Message Lengths --  -- Reductions --\n"));
16015f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscFPrintf(comm, fd, "                        Avg     %%Total     Avg     %%Total    Count   %%Total     Avg         %%Total    Count   %%Total\n"));
16025c6c1daeSBarry Smith         break;
16035c6c1daeSBarry Smith       }
16045c6c1daeSBarry Smith     }
16055c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
16065c6c1daeSBarry Smith       if (!stageUsed[stage]) continue;
1607820f2d46SBarry Smith       /* CANNOT use MPI_Allreduce() since it might fail the line number check */
16085c6c1daeSBarry Smith       if (localStageUsed[stage]) {
16095f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16105f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16115f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16125f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16135f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16145c6c1daeSBarry Smith         name = stageInfo[stage].name;
16155c6c1daeSBarry Smith       } else {
16165f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                           &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16175f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                           &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16185f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                           &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16195f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                           &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16205f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                           &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
16215c6c1daeSBarry Smith         name = "";
16225c6c1daeSBarry Smith       }
16235c6c1daeSBarry Smith       mess *= 0.5; messLen *= 0.5; red /= size;
16245c6c1daeSBarry Smith       if (TotalTime     != 0.0) fracTime       = stageTime/TotalTime;    else fracTime       = 0.0;
16255c6c1daeSBarry Smith       if (TotalFlops    != 0.0) fracFlops      = flops/TotalFlops;       else fracFlops      = 0.0;
16265c6c1daeSBarry Smith       /* Talk to Barry if (stageTime     != 0.0) flops          = (size*flops)/stageTime; else flops          = 0.0; */
16275c6c1daeSBarry Smith       if (numMessages   != 0.0) fracMessages   = mess/numMessages;       else fracMessages   = 0.0;
1628e96a4d02SJunchao Zhang       if (mess          != 0.0) avgMessLen     = messLen/mess;           else avgMessLen     = 0.0;
16295c6c1daeSBarry Smith       if (messageLength != 0.0) fracLength     = messLen/messageLength;  else fracLength     = 0.0;
16305c6c1daeSBarry Smith       if (numReductions != 0.0) fracReductions = red/numReductions;      else fracReductions = 0.0;
16315c6c1daeSBarry Smith       ierr = 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",
16325c6c1daeSBarry Smith                           stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops,
16335c6c1daeSBarry Smith                           mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr);
16345c6c1daeSBarry Smith     }
16355c6c1daeSBarry Smith   }
16365c6c1daeSBarry Smith 
16375f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n"));
16385f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n"));
16395f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Phase summary info:\n"));
16405f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "   Count: number of times phase was executed\n"));
16415f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "   Time and Flop: Max - maximum over all processors\n"));
16425f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "                  Ratio - ratio of maximum to minimum over all processors\n"));
16435f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "   Mess: number of messages sent\n"));
16445f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "   AvgLen: average message length (bytes)\n"));
16455f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "   Reduct: number of global reductions\n"));
16465f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "   Global: entire computation\n"));
16475f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "   Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n"));
16485f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      %%T - percent time in this phase         %%F - percent flop in this phase\n"));
16495f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      %%M - percent messages in this phase     %%L - percent message lengths in this phase\n"));
16505f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "      %%R - percent reductions in this phase\n"));
16515f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "   Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n"));
1652e3ed9ee7SBarry Smith   if (PetscLogMemory) {
16535f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "   Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event)\n"));
16545f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "   EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events)\n"));
16555f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "   MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event)\n"));
16565f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "   RMI Mbytes: Increase in resident memory (sum over all calls to event)\n"));
1657e3ed9ee7SBarry Smith   }
1658d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
16595f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "   GPU Mflop/s: 10e-6 * (sum of flop on GPU over all processors)/(max GPU time over all processors)\n"));
16605f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "   CpuToGpu Count: total number of CPU to GPU copies per processor\n"));
16615f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "   CpuToGpu Size (Mbytes): 10e-6 * (total size of CPU to GPU copies per processor)\n"));
16625f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "   GpuToCpu Count: total number of GPU to CPU copies per processor\n"));
16635f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "   GpuToCpu Size (Mbytes): 10e-6 * (total size of GPU to CPU copies per processor)\n"));
16645f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "   GPU %%F: percent flops on GPU in this event\n"));
1665bec0b493Shannah_mairs   #endif
16665f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n"));
16675c6c1daeSBarry Smith 
16685f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogViewWarnDebugging(comm,fd));
16695c6c1daeSBarry Smith 
16705c6c1daeSBarry Smith   /* Report events */
16715f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd,"Event                Count      Time (sec)     Flop                              --- Global ---  --- Stage ----  Total"));
1672e3ed9ee7SBarry Smith   if (PetscLogMemory) {
16735f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd,"  Malloc EMalloc MMalloc RMI"));
1674e3ed9ee7SBarry Smith   }
1675d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
16765f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd,"   GPU    - CpuToGpu -   - GpuToCpu - GPU"));
1677bec0b493Shannah_mairs   #endif
16785f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd,"\n"));
16795f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd,"                   Max Ratio  Max     Ratio   Max  Ratio  Mess   AvgLen  Reduct  %%T %%F %%M %%L %%R  %%T %%F %%M %%L %%R Mflop/s"));
1680e3ed9ee7SBarry Smith   if (PetscLogMemory) {
16815f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd," Mbytes Mbytes Mbytes Mbytes"));
1682e3ed9ee7SBarry Smith   }
1683d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
16845f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd," Mflop/s Count   Size   Count   Size  %%F"));
1685bec0b493Shannah_mairs   #endif
16865f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd,"\n"));
16875f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd,"------------------------------------------------------------------------------------------------------------------------"));
16884863603aSSatish Balay   if (PetscLogMemory) {
16895f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd,"-----------------------------"));
16904863603aSSatish Balay   }
1691d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
16925f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd,"---------------------------------------"));
16934863603aSSatish Balay   #endif
16945f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd,"\n"));
16955c6c1daeSBarry Smith 
16965c6c1daeSBarry Smith   /* Problem: The stage name will not show up unless the stage executed on proc 1 */
16975c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
16985c6c1daeSBarry Smith     if (!stageVisible[stage]) continue;
1699820f2d46SBarry Smith     /* CANNOT use MPI_Allreduce() since it might fail the line number check */
17005c6c1daeSBarry Smith     if (localStageUsed[stage]) {
17015f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name));
17025f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17035f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17045f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17055f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17065f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17075c6c1daeSBarry Smith     } else {
17085f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage));
17095f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Allreduce(&zero,                           &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17105f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Allreduce(&zero,                           &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17115f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Allreduce(&zero,                           &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17125f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Allreduce(&zero,                           &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17135f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Allreduce(&zero,                           &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17145c6c1daeSBarry Smith     }
17155c6c1daeSBarry Smith     mess *= 0.5; messLen *= 0.5; red /= size;
17165c6c1daeSBarry Smith 
17175c6c1daeSBarry Smith     /* Get total number of events in this stage --
17185c6c1daeSBarry Smith        Currently, a single processor can register more events than another, but events must all be registered in order,
17195c6c1daeSBarry Smith        just like stages. We can removed this requirement if necessary by having a global event numbering and indirection
1720217044c2SLisandro Dalcin        on the event ID. This seems best accomplished by associating a communicator with each stage.
17215c6c1daeSBarry Smith 
17225c6c1daeSBarry Smith        Problem: If the event did not happen on proc 1, its name will not be available.
17235c6c1daeSBarry Smith        Problem: Event visibility is not implemented
17245c6c1daeSBarry Smith     */
17255c6c1daeSBarry Smith     if (localStageUsed[stage]) {
17265c6c1daeSBarry Smith       eventInfo      = stageLog->stageInfo[stage].eventLog->eventInfo;
17275c6c1daeSBarry Smith       localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents;
1728a297a907SKarl Rupp     } else localNumEvents = 0;
17295f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm));
17305c6c1daeSBarry Smith     for (event = 0; event < numEvents; event++) {
1731820f2d46SBarry Smith       /* CANNOT use MPI_Allreduce() since it might fail the line number check */
17325c6c1daeSBarry Smith       if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) {
1733217044c2SLisandro Dalcin         if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; else flopr = 0.0;
17345f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&flopr,                          &minf,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
17355f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&flopr,                          &maxf,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
17365f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].flops,         &totf,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17375f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].time,          &mint,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
17385f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].time,          &maxt,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
17395f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].time,          &tott,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17405f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].numMessages,   &totm,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17415f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17425f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].numReductions, &totr,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17435f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].count,         &minC,  1, MPI_INT,             MPI_MIN, comm));
17445f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].count,         &maxC,  1, MPI_INT,             MPI_MAX, comm));
1745e3ed9ee7SBarry Smith         if (PetscLogMemory) {
17465f80ce2aSJacob Faibussowitsch           CHKERRMPI(MPI_Allreduce(&eventInfo[event].memIncrease,    &mem,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17475f80ce2aSJacob Faibussowitsch           CHKERRMPI(MPI_Allreduce(&eventInfo[event].mallocSpace,    &mal,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17485f80ce2aSJacob Faibussowitsch           CHKERRMPI(MPI_Allreduce(&eventInfo[event].mallocIncrease, &malmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17495f80ce2aSJacob Faibussowitsch           CHKERRMPI(MPI_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1750e3ed9ee7SBarry Smith         }
1751d9c66bfbSJunchao Zhang         #if defined(PETSC_HAVE_DEVICE)
17525f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].CpuToGpuCount,    &cct,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17535f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].GpuToCpuCount,    &gct,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17545f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].CpuToGpuSize,     &csz,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17555f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].GpuToCpuSize,     &gsz,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17565f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].GpuFlops,         &gflops,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17575f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&eventInfo[event].GpuTime,          &gmaxt ,1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1758bec0b493Shannah_mairs         #endif
17595c6c1daeSBarry Smith         name = stageLog->eventLog->eventInfo[event].name;
17605c6c1daeSBarry Smith       } else {
17615c6c1daeSBarry Smith         flopr = 0.0;
17625f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&flopr,                         &minf,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
17635f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&flopr,                         &maxf,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
17645f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                          &totf,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17655f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                          &mint,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm));
17665f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                          &maxt,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
17675f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                          &tott,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17685f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                          &totm,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17695f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                          &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17705f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                          &totr,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17715f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&ierr,                          &minC,  1, MPI_INT,             MPI_MIN, comm));
17725f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&ierr,                          &maxC,  1, MPI_INT,             MPI_MAX, comm));
1773e3ed9ee7SBarry Smith         if (PetscLogMemory) {
17745f80ce2aSJacob Faibussowitsch           CHKERRMPI(MPI_Allreduce(&zero,                        &mem,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17755f80ce2aSJacob Faibussowitsch           CHKERRMPI(MPI_Allreduce(&zero,                        &mal,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17765f80ce2aSJacob Faibussowitsch           CHKERRMPI(MPI_Allreduce(&zero,                        &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17775f80ce2aSJacob Faibussowitsch           CHKERRMPI(MPI_Allreduce(&zero,                        &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
1778e3ed9ee7SBarry Smith         }
1779d9c66bfbSJunchao Zhang         #if defined(PETSC_HAVE_DEVICE)
17805f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                          &cct,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17815f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                          &gct,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17825f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                          &csz,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17835f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                          &gsz,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17845f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                          &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm));
17855f80ce2aSJacob Faibussowitsch         CHKERRMPI(MPI_Allreduce(&zero,                          &gmaxt , 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm));
1786bec0b493Shannah_mairs         #endif
17875c6c1daeSBarry Smith         name  = "";
17885c6c1daeSBarry Smith       }
17895c6c1daeSBarry Smith       if (mint < 0.0) {
17905c6c1daeSBarry Smith         ierr = 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);
17915c6c1daeSBarry Smith         mint = 0;
17925c6c1daeSBarry Smith       }
17932c71b3e2SJacob Faibussowitsch       PetscCheckFalse(minf < 0.0,PETSC_COMM_SELF,PETSC_ERR_PLIB,"Minimum flop %g over all processors for %s is negative! Not possible!",minf,name);
17945c6c1daeSBarry Smith       totm *= 0.5; totml *= 0.5; totr /= size;
17955c6c1daeSBarry Smith 
1796217044c2SLisandro Dalcin       if (maxC != 0) {
1797217044c2SLisandro Dalcin         if (minC          != 0)   ratC             = ((PetscLogDouble)maxC)/minC;else ratC             = 0.0;
17985c6c1daeSBarry Smith         if (mint          != 0.0) ratt             = maxt/mint;                  else ratt             = 0.0;
17995c6c1daeSBarry Smith         if (minf          != 0.0) ratf             = maxf/minf;                  else ratf             = 0.0;
18005c6c1daeSBarry Smith         if (TotalTime     != 0.0) fracTime         = tott/TotalTime;             else fracTime         = 0.0;
18015c6c1daeSBarry Smith         if (TotalFlops    != 0.0) fracFlops        = totf/TotalFlops;            else fracFlops        = 0.0;
18025c6c1daeSBarry Smith         if (stageTime     != 0.0) fracStageTime    = tott/stageTime;             else fracStageTime    = 0.0;
18035c6c1daeSBarry Smith         if (flops         != 0.0) fracStageFlops   = totf/flops;                 else fracStageFlops   = 0.0;
18045c6c1daeSBarry Smith         if (numMessages   != 0.0) fracMess         = totm/numMessages;           else fracMess         = 0.0;
18055c6c1daeSBarry Smith         if (messageLength != 0.0) fracMessLen      = totml/messageLength;        else fracMessLen      = 0.0;
18065c6c1daeSBarry Smith         if (numReductions != 0.0) fracRed          = totr/numReductions;         else fracRed          = 0.0;
18075c6c1daeSBarry Smith         if (mess          != 0.0) fracStageMess    = totm/mess;                  else fracStageMess    = 0.0;
18085c6c1daeSBarry Smith         if (messLen       != 0.0) fracStageMessLen = totml/messLen;              else fracStageMessLen = 0.0;
18095c6c1daeSBarry Smith         if (red           != 0.0) fracStageRed     = totr/red;                   else fracStageRed     = 0.0;
18105c6c1daeSBarry Smith         if (totm          != 0.0) totml           /= totm;                       else totml            = 0.0;
18115c6c1daeSBarry Smith         if (maxt          != 0.0) flopr            = totf/maxt;                  else flopr            = 0.0;
18125f80ce2aSJacob Faibussowitsch         if (fracStageTime > 1.00) CHKERRQ(PetscFPrintf(comm, fd,"Warning -- total time of event greater than time of entire stage -- something is wrong with the timer\n"));
18135c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd,
1814e3ed9ee7SBarry Smith                             "%-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",
1815217044c2SLisandro Dalcin                             name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr,
18165c6c1daeSBarry Smith                             100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed,
18175c6c1daeSBarry Smith                             100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed,
1818c068d9bbSLisandro Dalcin                             PetscAbs(flopr)/1.0e6);CHKERRQ(ierr);
1819e3ed9ee7SBarry Smith         if (PetscLogMemory) {
18205f80ce2aSJacob Faibussowitsch           CHKERRQ(PetscFPrintf(comm, fd," %5.0f   %5.0f   %5.0f   %5.0f",mal/1.0e6,emalmax/1.0e6,malmax/1.0e6,mem/1.0e6));
1821e3ed9ee7SBarry Smith         }
1822d9c66bfbSJunchao Zhang         #if defined(PETSC_HAVE_DEVICE)
1823958c4211Shannah_mairs         if (totf  != 0.0) fracgflops = gflops/totf;  else fracgflops = 0.0;
1824958c4211Shannah_mairs         if (gmaxt != 0.0) gflopr     = gflops/gmaxt; else gflopr     = 0.0;
18255f80ce2aSJacob Faibussowitsch         CHKERRQ(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));
1826bec0b493Shannah_mairs         #endif
18275f80ce2aSJacob Faibussowitsch         CHKERRQ(PetscFPrintf(comm, fd,"\n"));
18285c6c1daeSBarry Smith       }
18295c6c1daeSBarry Smith     }
18305c6c1daeSBarry Smith   }
18315c6c1daeSBarry Smith 
18325c6c1daeSBarry Smith   /* Memory usage and object creation */
18335f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------"));
18344863603aSSatish Balay   if (PetscLogMemory) {
18355f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "-----------------------------"));
18364863603aSSatish Balay   }
1837d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
18385f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "---------------------------------------"));
18394863603aSSatish Balay   #endif
18405f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "\n"));
18415f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "\n"));
18425f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n"));
18435c6c1daeSBarry Smith 
18445c6c1daeSBarry Smith   /* Right now, only stages on the first processor are reported here, meaning only objects associated with
18455c6c1daeSBarry Smith      the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then
18465c6c1daeSBarry Smith      stats for stages local to processor sets.
18475c6c1daeSBarry Smith   */
18485c6c1daeSBarry Smith   /* We should figure out the longest object name here (now 20 characters) */
18495f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Object Type          Creations   Destructions     Memory  Descendants' Mem.\n"));
18505f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Reports information only for process 0.\n"));
18515c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
18525c6c1daeSBarry Smith     if (localStageUsed[stage]) {
18535c6c1daeSBarry Smith       classInfo = stageLog->stageInfo[stage].classLog->classInfo;
18545f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name));
18555c6c1daeSBarry Smith       for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) {
18565c6c1daeSBarry Smith         if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) {
18575c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "%20s %5d          %5d  %11.0f     %g\n", stageLog->classLog->classInfo[oclass].name,
18585c6c1daeSBarry Smith                               classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem,
18595c6c1daeSBarry Smith                               classInfo[oclass].descMem);CHKERRQ(ierr);
18605c6c1daeSBarry Smith         }
18615c6c1daeSBarry Smith       }
18625c6c1daeSBarry Smith     } else {
1863cf019ec6SStefano Zampini       if (!localStageVisible[stage]) continue;
18645f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage));
18655c6c1daeSBarry Smith     }
18665c6c1daeSBarry Smith   }
18675c6c1daeSBarry Smith 
18685f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFree(localStageUsed));
18695f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFree(stageUsed));
18705f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFree(localStageVisible));
18715f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFree(stageVisible));
18725c6c1daeSBarry Smith 
18735c6c1daeSBarry Smith   /* Information unrelated to this particular run */
18745f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "========================================================================================================================\n"));
18758563dfccSBarry Smith   PetscTime(&y);
18768563dfccSBarry Smith   PetscTime(&x);
18778563dfccSBarry Smith   PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y);
18788563dfccSBarry Smith   PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y);
18795f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0));
18805c6c1daeSBarry Smith   /* MPI information */
18815c6c1daeSBarry Smith   if (size > 1) {
18825c6c1daeSBarry Smith     MPI_Status  status;
18835c6c1daeSBarry Smith     PetscMPIInt tag;
18845c6c1daeSBarry Smith     MPI_Comm    newcomm;
18855c6c1daeSBarry Smith 
18865f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Barrier(comm));
18878563dfccSBarry Smith     PetscTime(&x);
18885f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Barrier(comm));
18895f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Barrier(comm));
18905f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Barrier(comm));
18915f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Barrier(comm));
18925f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Barrier(comm));
18938563dfccSBarry Smith     PetscTime(&y);
18945f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0));
18955f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscCommDuplicate(comm,&newcomm, &tag));
18965f80ce2aSJacob Faibussowitsch     CHKERRMPI(MPI_Barrier(comm));
18975c6c1daeSBarry Smith     if (rank) {
18985f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Recv(NULL, 0, MPI_INT, rank-1,            tag, newcomm, &status));
18995f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Send(NULL, 0, MPI_INT, (rank+1)%size, tag, newcomm));
19005c6c1daeSBarry Smith     } else {
19018563dfccSBarry Smith       PetscTime(&x);
19025f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Send(NULL, 0, MPI_INT, 1,          tag, newcomm));
19035f80ce2aSJacob Faibussowitsch       CHKERRMPI(MPI_Recv(NULL, 0, MPI_INT, size-1, tag, newcomm, &status));
19048563dfccSBarry Smith       PetscTime(&y);
19055f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size));
19065c6c1daeSBarry Smith     }
19075f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscCommDestroy(&newcomm));
19085c6c1daeSBarry Smith   }
19095f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsView(NULL,viewer));
19105c6c1daeSBarry Smith 
19115c6c1daeSBarry Smith   /* Machine and compile information */
19125c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS)
19135f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n"));
19145c6c1daeSBarry Smith #else
19155f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n"));
19165c6c1daeSBarry Smith #endif
1917217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES)
19185f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n"));
1919217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128)
19205f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n"));
1921217044c2SLisandro Dalcin #endif
19225c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
19235f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n"));
19245f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128)
19255f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n"));
19265c6c1daeSBarry Smith #endif
19275c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE)
19285f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Compiled with single precision matrices\n"));
19295c6c1daeSBarry Smith #else
19305f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n"));
19315c6c1daeSBarry Smith #endif
19325c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n",
19335c6c1daeSBarry Smith                       (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt));CHKERRQ(ierr);
19345c6c1daeSBarry Smith 
19355f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions));
19365f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "%s", petscmachineinfo));
19375f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "%s", petsccompilerinfo));
19385f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo));
19395f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "%s", petsclinkerinfo));
19405c6c1daeSBarry Smith 
19415c6c1daeSBarry Smith   /* Cleanup */
19425f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscFPrintf(comm, fd, "\n"));
19435f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogViewWarnNoGpuAwareMpi(comm,fd));
19445f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogViewWarnDebugging(comm,fd));
19455c6c1daeSBarry Smith   PetscFunctionReturn(0);
19465c6c1daeSBarry Smith }
19475c6c1daeSBarry Smith 
19487d6c928cSSatish Balay /*@C
19497d6c928cSSatish Balay   PetscLogView - Prints a summary of the logging.
19505c6c1daeSBarry Smith 
19515c6c1daeSBarry Smith   Collective over MPI_Comm
19525c6c1daeSBarry Smith 
19535c6c1daeSBarry Smith   Input Parameter:
1954f14045dbSBarry Smith .  viewer - an ASCII viewer
19555c6c1daeSBarry Smith 
19565c6c1daeSBarry Smith   Options Database Keys:
1957bb1d7374SBarry Smith +  -log_view [:filename] - Prints summary of log information
1958bb1d7374SBarry Smith .  -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file
1959607d249eSBarry 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)
1960d0a29bd7SConnor 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)
1961bb1d7374SBarry Smith .  -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation
1962bb1d7374SBarry Smith -  -log_trace [filename] - Displays a trace of what each process is doing
19635c6c1daeSBarry Smith 
19645c6c1daeSBarry Smith   Notes:
1965bb1d7374SBarry Smith   It is possible to control the logging programatically but we recommend using the options database approach whenever possible
19665c6c1daeSBarry Smith   By default the summary is printed to stdout.
19675c6c1daeSBarry Smith 
1968bb1d7374SBarry Smith   Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin()
1969bb1d7374SBarry Smith 
1970bb1d7374SBarry Smith   If PETSc is configured with --with-logging=0 then this functionality is not available
1971bb1d7374SBarry Smith 
1972607d249eSBarry Smith   To view the nested XML format filename.xml first copy  ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current
1973607d249eSBarry Smith   directory then open filename.xml with your browser. Specific notes for certain browsers
1974607d249eSBarry Smith $    Firefox and Internet explorer - simply open the file
1975607d249eSBarry Smith $    Google Chrome - you must start up Chrome with the option --allow-file-access-from-files
1976a8d69d7bSBarry Smith $    Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access
1977607d249eSBarry 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
1978607d249eSBarry Smith   your browser.
19792add09c0SLisandro Dalcin   Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser
19802add09c0SLisandro Dalcin   window and render the XML log file contents.
1981607d249eSBarry Smith 
1982bb1d7374SBarry Smith   The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij  MARITIME  RESEARCH  INSTITUTE  NETHERLANDS
1983bb1d7374SBarry Smith 
1984d0a29bd7SConnor Ward   The Flame Graph output can be visualised using either the original Flame Graph script (https://github.com/brendangregg/FlameGraph)
1985d0a29bd7SConnor Ward   or using speedscope (https://www.speedscope.app).
1986d0a29bd7SConnor Ward   Old XML profiles may be converted into this format using the script ${PETSC_DIR}/lib/petsc/bin/xml2flamegraph.py.
1987d0a29bd7SConnor Ward 
19885c6c1daeSBarry Smith   Level: beginner
19895c6c1daeSBarry Smith 
1990bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogDump()
19915c6c1daeSBarry Smith @*/
1992f14045dbSBarry Smith PetscErrorCode  PetscLogView(PetscViewer viewer)
19935c6c1daeSBarry Smith {
1994f14045dbSBarry Smith   PetscBool         isascii;
1995f14045dbSBarry Smith   PetscViewerFormat format;
199637b78d16SBarry Smith   int               stage, lastStage;
199737b78d16SBarry Smith   PetscStageLog     stageLog;
19985c6c1daeSBarry Smith 
19995c6c1daeSBarry Smith   PetscFunctionBegin;
2000*28b400f6SJacob Faibussowitsch   PetscCheck(PetscLogPLB,PETSC_COMM_SELF,PETSC_ERR_SUP,"Must use -log_view or PetscLogDefaultBegin() before calling this routine");
200137b78d16SBarry Smith   /* Pop off any stages the user forgot to remove */
200237b78d16SBarry Smith   lastStage = 0;
20035f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
20045f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogGetCurrent(stageLog, &stage));
200537b78d16SBarry Smith   while (stage >= 0) {
200637b78d16SBarry Smith     lastStage = stage;
20075f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscStageLogPop(stageLog));
20085f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscStageLogGetCurrent(stageLog, &stage));
200937b78d16SBarry Smith   }
20105f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii));
2011*28b400f6SJacob Faibussowitsch   PetscCheck(isascii,PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Currently can only view logging to ASCII");
20125f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscViewerGetFormat(viewer,&format));
2013f14045dbSBarry Smith   if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) {
20145f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscLogView_Default(viewer));
2015f14045dbSBarry Smith   } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
20165f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscLogView_Detailed(viewer));
201738144912Sdeepblu2718   } else if (format == PETSC_VIEWER_ASCII_CSV) {
20185f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscLogView_CSV(viewer));
2019bb1d7374SBarry Smith   } else if (format == PETSC_VIEWER_ASCII_XML) {
20205f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscLogView_Nested(viewer));
2021d0a29bd7SConnor Ward   } else if (format == PETSC_VIEWER_ASCII_FLAMEGRAPH) {
20225f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscLogView_Flamegraph(viewer));
20235c6c1daeSBarry Smith   }
20245f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscStageLogPush(stageLog, lastStage));
20255c6c1daeSBarry Smith   PetscFunctionReturn(0);
20265c6c1daeSBarry Smith }
20275c6c1daeSBarry Smith 
2028f14045dbSBarry Smith /*@C
2029f14045dbSBarry Smith   PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed.
2030f14045dbSBarry Smith 
2031f14045dbSBarry Smith   Collective on PETSC_COMM_WORLD
2032f14045dbSBarry Smith 
2033f14045dbSBarry Smith   Not normally called by user
2034f14045dbSBarry Smith 
2035f14045dbSBarry Smith   Level: intermediate
2036f14045dbSBarry Smith 
2037f14045dbSBarry Smith @*/
2038f14045dbSBarry Smith PetscErrorCode PetscLogViewFromOptions(void)
2039f14045dbSBarry Smith {
2040f14045dbSBarry Smith   PetscViewer       viewer;
2041f14045dbSBarry Smith   PetscBool         flg;
2042f14045dbSBarry Smith   PetscViewerFormat format;
2043f14045dbSBarry Smith 
2044f14045dbSBarry Smith   PetscFunctionBegin;
20455f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-log_view",&viewer,&format,&flg));
2046f14045dbSBarry Smith   if (flg) {
20475f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerPushFormat(viewer,format));
20485f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscLogView(viewer));
20495f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerPopFormat(viewer));
20505f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscViewerDestroy(&viewer));
2051f14045dbSBarry Smith   }
2052f14045dbSBarry Smith   PetscFunctionReturn(0);
2053f14045dbSBarry Smith }
2054f14045dbSBarry Smith 
20555c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/
20565c6c1daeSBarry Smith /*@C
20575c6c1daeSBarry Smith    PetscGetFlops - Returns the number of flops used on this processor
20585c6c1daeSBarry Smith    since the program began.
20595c6c1daeSBarry Smith 
20605c6c1daeSBarry Smith    Not Collective
20615c6c1daeSBarry Smith 
20625c6c1daeSBarry Smith    Output Parameter:
20635c6c1daeSBarry Smith    flops - number of floating point operations
20645c6c1daeSBarry Smith 
20655c6c1daeSBarry Smith    Notes:
20665c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
20675c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
20685c6c1daeSBarry Smith    application code.
20695c6c1daeSBarry Smith 
20705c6c1daeSBarry Smith    Level: intermediate
20715c6c1daeSBarry Smith 
20728563dfccSBarry Smith .seealso: PetscTime(), PetscLogFlops()
20735c6c1daeSBarry Smith @*/
20745c6c1daeSBarry Smith PetscErrorCode  PetscGetFlops(PetscLogDouble *flops)
20755c6c1daeSBarry Smith {
20765c6c1daeSBarry Smith   PetscFunctionBegin;
20775c6c1daeSBarry Smith   *flops = petsc_TotalFlops;
20785c6c1daeSBarry Smith   PetscFunctionReturn(0);
20795c6c1daeSBarry Smith }
20805c6c1daeSBarry Smith 
20815c6c1daeSBarry Smith PetscErrorCode  PetscLogObjectState(PetscObject obj, const char format[], ...)
20825c6c1daeSBarry Smith {
20835c6c1daeSBarry Smith   size_t         fullLength;
20845c6c1daeSBarry Smith   va_list        Argp;
20855c6c1daeSBarry Smith 
20865c6c1daeSBarry Smith   PetscFunctionBegin;
20875c6c1daeSBarry Smith   if (!petsc_logObjects) PetscFunctionReturn(0);
20885c6c1daeSBarry Smith   va_start(Argp, format);
20895f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp));
20905c6c1daeSBarry Smith   va_end(Argp);
20915c6c1daeSBarry Smith   PetscFunctionReturn(0);
20925c6c1daeSBarry Smith }
20935c6c1daeSBarry Smith 
20945c6c1daeSBarry Smith /*MC
20955c6c1daeSBarry Smith    PetscLogFlops - Adds floating point operations to the global counter.
20965c6c1daeSBarry Smith 
20975c6c1daeSBarry Smith    Synopsis:
2098aaa7dc30SBarry Smith    #include <petsclog.h>
20995c6c1daeSBarry Smith    PetscErrorCode PetscLogFlops(PetscLogDouble f)
21005c6c1daeSBarry Smith 
21015c6c1daeSBarry Smith    Not Collective
21025c6c1daeSBarry Smith 
21035c6c1daeSBarry Smith    Input Parameter:
21045c6c1daeSBarry Smith .  f - flop counter
21055c6c1daeSBarry Smith 
21065c6c1daeSBarry Smith    Usage:
21075c6c1daeSBarry Smith .vb
21085c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
21095c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
21105c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
21115c6c1daeSBarry Smith         [code segment to monitor]
21125c6c1daeSBarry Smith         PetscLogFlops(user_flops)
21135c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
21145c6c1daeSBarry Smith .ve
21155c6c1daeSBarry Smith 
21165c6c1daeSBarry Smith    Notes:
21175c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
21185c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
21195c6c1daeSBarry Smith    application code.
21205c6c1daeSBarry Smith 
21215c6c1daeSBarry Smith    Level: intermediate
21225c6c1daeSBarry Smith 
21235c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscGetFlops()
21245c6c1daeSBarry Smith 
21255c6c1daeSBarry Smith M*/
21265c6c1daeSBarry Smith 
21275c6c1daeSBarry Smith /*MC
21285c6c1daeSBarry Smith    PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice)
21295c6c1daeSBarry Smith     to get accurate timings
21305c6c1daeSBarry Smith 
21315c6c1daeSBarry Smith    Synopsis:
2132aaa7dc30SBarry Smith    #include <petsclog.h>
21335c6c1daeSBarry Smith    void PetscPreLoadBegin(PetscBool  flag,char *name);
21345c6c1daeSBarry Smith 
21355c6c1daeSBarry Smith    Not Collective
21365c6c1daeSBarry Smith 
2137d8d19677SJose E. Roman    Input Parameters:
21385c6c1daeSBarry Smith +   flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden
21395c6c1daeSBarry Smith            with command line option -preload true or -preload false
2140609bdbeeSBarry Smith -   name - name of first stage (lines of code timed separately with -log_view) to
21415c6c1daeSBarry Smith            be preloaded
21425c6c1daeSBarry Smith 
21435c6c1daeSBarry Smith    Usage:
21445c6c1daeSBarry Smith .vb
21455c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
21465c6c1daeSBarry Smith        lines of code
21475c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
21485c6c1daeSBarry Smith        lines of code
21495c6c1daeSBarry Smith      PetscPreLoadEnd();
21505c6c1daeSBarry Smith .ve
21515c6c1daeSBarry Smith 
215295452b02SPatrick Sanan    Notes:
215395452b02SPatrick Sanan     Only works in C/C++, not Fortran
21545c6c1daeSBarry Smith 
21555c6c1daeSBarry Smith      Flags available within the macro.
21565c6c1daeSBarry Smith +    PetscPreLoadingUsed - true if we are or have done preloading
21575c6c1daeSBarry Smith .    PetscPreLoadingOn - true if it is CURRENTLY doing preload
21585c6c1daeSBarry Smith .    PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second
21595c6c1daeSBarry Smith -    PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on
21605c6c1daeSBarry Smith      The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin()
21615c6c1daeSBarry Smith      and PetscPreLoadEnd()
21625c6c1daeSBarry Smith 
21635c6c1daeSBarry Smith    Level: intermediate
21645c6c1daeSBarry Smith 
21655c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage()
21665c6c1daeSBarry Smith 
21675c6c1daeSBarry Smith M*/
21685c6c1daeSBarry Smith 
21695c6c1daeSBarry Smith /*MC
21705c6c1daeSBarry Smith    PetscPreLoadEnd - End a segment of code that may be preloaded (run twice)
21715c6c1daeSBarry Smith     to get accurate timings
21725c6c1daeSBarry Smith 
21735c6c1daeSBarry Smith    Synopsis:
2174aaa7dc30SBarry Smith    #include <petsclog.h>
21755c6c1daeSBarry Smith    void PetscPreLoadEnd(void);
21765c6c1daeSBarry Smith 
21775c6c1daeSBarry Smith    Not Collective
21785c6c1daeSBarry Smith 
21795c6c1daeSBarry Smith    Usage:
21805c6c1daeSBarry Smith .vb
21815c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
21825c6c1daeSBarry Smith        lines of code
21835c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
21845c6c1daeSBarry Smith        lines of code
21855c6c1daeSBarry Smith      PetscPreLoadEnd();
21865c6c1daeSBarry Smith .ve
21875c6c1daeSBarry Smith 
218895452b02SPatrick Sanan    Notes:
218995452b02SPatrick Sanan     only works in C/C++ not fortran
21905c6c1daeSBarry Smith 
21915c6c1daeSBarry Smith    Level: intermediate
21925c6c1daeSBarry Smith 
21935c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadStage()
21945c6c1daeSBarry Smith 
21955c6c1daeSBarry Smith M*/
21965c6c1daeSBarry Smith 
21975c6c1daeSBarry Smith /*MC
21985c6c1daeSBarry Smith    PetscPreLoadStage - Start a new segment of code to be timed separately.
21995c6c1daeSBarry Smith     to get accurate timings
22005c6c1daeSBarry Smith 
22015c6c1daeSBarry Smith    Synopsis:
2202aaa7dc30SBarry Smith    #include <petsclog.h>
22035c6c1daeSBarry Smith    void PetscPreLoadStage(char *name);
22045c6c1daeSBarry Smith 
22055c6c1daeSBarry Smith    Not Collective
22065c6c1daeSBarry Smith 
22075c6c1daeSBarry Smith    Usage:
22085c6c1daeSBarry Smith .vb
22095c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
22105c6c1daeSBarry Smith        lines of code
22115c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
22125c6c1daeSBarry Smith        lines of code
22135c6c1daeSBarry Smith      PetscPreLoadEnd();
22145c6c1daeSBarry Smith .ve
22155c6c1daeSBarry Smith 
221695452b02SPatrick Sanan    Notes:
221795452b02SPatrick Sanan     only works in C/C++ not fortran
22185c6c1daeSBarry Smith 
22195c6c1daeSBarry Smith    Level: intermediate
22205c6c1daeSBarry Smith 
22215c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd()
22225c6c1daeSBarry Smith 
22235c6c1daeSBarry Smith M*/
22245c6c1daeSBarry Smith 
2225a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_DEVICE)
2226a4af0ceeSJacob Faibussowitsch #include <petsc/private/deviceimpl.h>
22279ffd0706SHong Zhang 
22289ffd0706SHong Zhang /*-------------------------------------------- GPU event Functions ----------------------------------------------*/
22299ffd0706SHong Zhang /*@C
22309ffd0706SHong Zhang   PetscLogGpuTimeBegin - Start timer for device
22319ffd0706SHong Zhang 
22329ffd0706SHong Zhang   Notes:
22339ffd0706SHong 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).
22349ffd0706SHong 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).
22359ffd0706SHong Zhang     There is no need to call WaitForCUDA() or WaitForHIP() between PetscLogGpuTimeBegin and PetscLogGpuTimeEnd
22369ffd0706SHong Zhang     This timer should NOT include times for data transfers between the GPU and CPU, nor setup actions such as allocating space.
22379ffd0706SHong Zhang     The regular logging captures the time for data transfers and any CPU activites during the event
22389ffd0706SHong Zhang     It is used to compute the flop rate on the GPU as it is actively engaged in running a kernel.
22399ffd0706SHong Zhang 
22409ffd0706SHong Zhang   Developer Notes:
22419ffd0706SHong 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().
22429ffd0706SHong 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.
22439ffd0706SHong Zhang 
22449ffd0706SHong Zhang   Level: intermediate
22459ffd0706SHong Zhang 
22469ffd0706SHong Zhang .seealso:  PetscLogView(), PetscLogGpuFlops(), PetscLogGpuTimeEnd()
22479ffd0706SHong Zhang @*/
22489ffd0706SHong Zhang PetscErrorCode PetscLogGpuTimeBegin(void)
22499ffd0706SHong Zhang {
22509ffd0706SHong Zhang   PetscFunctionBegin;
22511e8be873SJed Brown   if (!PetscLogPLB) PetscFunctionReturn(0);
2252a4af0ceeSJacob Faibussowitsch   if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) {
2253a4af0ceeSJacob Faibussowitsch     PetscDeviceContext dctx;
2254a4af0ceeSJacob Faibussowitsch 
22555f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscDeviceContextGetCurrentContext(&dctx));
22565f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscDeviceContextBeginTimer_Internal(dctx));
2257a4af0ceeSJacob Faibussowitsch   } else {
22585f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscTimeSubtract(&petsc_gtime));
2259a4af0ceeSJacob Faibussowitsch   }
22609ffd0706SHong Zhang   PetscFunctionReturn(0);
22619ffd0706SHong Zhang }
22629ffd0706SHong Zhang 
22639ffd0706SHong Zhang /*@C
22649ffd0706SHong Zhang   PetscLogGpuTimeEnd - Stop timer for device
22659ffd0706SHong Zhang 
22669ffd0706SHong Zhang   Level: intermediate
22679ffd0706SHong Zhang 
22689ffd0706SHong Zhang .seealso:  PetscLogView(), PetscLogGpuFlops(), PetscLogGpuTimeBegin()
22699ffd0706SHong Zhang @*/
22709ffd0706SHong Zhang PetscErrorCode PetscLogGpuTimeEnd(void)
22719ffd0706SHong Zhang {
22729ffd0706SHong Zhang   PetscFunctionBegin;
22731e8be873SJed Brown   if (!PetscLogPLE) PetscFunctionReturn(0);
2274a4af0ceeSJacob Faibussowitsch   if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) {
2275a4af0ceeSJacob Faibussowitsch     PetscDeviceContext dctx;
2276a4af0ceeSJacob Faibussowitsch     PetscLogDouble     elapsed;
2277a4af0ceeSJacob Faibussowitsch 
22785f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscDeviceContextGetCurrentContext(&dctx));
22795f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscDeviceContextEndTimer_Internal(dctx,&elapsed));
2280a4af0ceeSJacob Faibussowitsch     petsc_gtime += (elapsed/1000.0);
2281a4af0ceeSJacob Faibussowitsch   } else {
22825f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscTimeAdd(&petsc_gtime));
2283a4af0ceeSJacob Faibussowitsch   }
22849ffd0706SHong Zhang   PetscFunctionReturn(0);
22859ffd0706SHong Zhang }
22869ffd0706SHong Zhang #endif /* end of PETSC_HAVE_DEVICE */
22879ffd0706SHong Zhang 
22885c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */
22895c6c1daeSBarry Smith 
22905c6c1daeSBarry Smith PetscErrorCode  PetscLogObjectState(PetscObject obj, const char format[], ...)
22915c6c1daeSBarry Smith {
22925c6c1daeSBarry Smith   PetscFunctionBegin;
22935c6c1daeSBarry Smith   PetscFunctionReturn(0);
22945c6c1daeSBarry Smith }
22955c6c1daeSBarry Smith 
22965c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/
22975c6c1daeSBarry Smith 
22985c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID;
22995c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID  = 0;
23005c6c1daeSBarry Smith 
23015c6c1daeSBarry Smith /*@C
23025c6c1daeSBarry Smith   PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code.
23035c6c1daeSBarry Smith 
23045c6c1daeSBarry Smith   Not Collective
23055c6c1daeSBarry Smith 
23065c6c1daeSBarry Smith   Input Parameter:
23075c6c1daeSBarry Smith . name   - The class name
23085c6c1daeSBarry Smith 
23095c6c1daeSBarry Smith   Output Parameter:
23105c6c1daeSBarry Smith . oclass - The class id or classid
23115c6c1daeSBarry Smith 
23125c6c1daeSBarry Smith   Level: developer
23135c6c1daeSBarry Smith 
23145c6c1daeSBarry Smith @*/
23155c6c1daeSBarry Smith PetscErrorCode  PetscClassIdRegister(const char name[],PetscClassId *oclass)
23165c6c1daeSBarry Smith {
23175c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
23185c6c1daeSBarry Smith   PetscStageLog  stageLog;
23195c6c1daeSBarry Smith   PetscInt       stage;
23205c6c1daeSBarry Smith #endif
23215c6c1daeSBarry Smith 
23225c6c1daeSBarry Smith   PetscFunctionBegin;
23235c6c1daeSBarry Smith   *oclass = ++PETSC_LARGEST_CLASSID;
23245c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
23255f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogGetStageLog(&stageLog));
23265f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscClassRegLogRegister(stageLog->classLog, name, *oclass));
23275c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
23285f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses));
23295c6c1daeSBarry Smith   }
23305c6c1daeSBarry Smith #endif
23315c6c1daeSBarry Smith   PetscFunctionReturn(0);
23325c6c1daeSBarry Smith }
2333210b5426SBarry Smith 
2334210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE)
2335210b5426SBarry Smith #include <mpe.h>
2336210b5426SBarry Smith 
2337210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE;
2338210b5426SBarry Smith 
2339495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
2340495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
2341495fc317SBarry Smith 
2342210b5426SBarry Smith /*@C
2343210b5426SBarry Smith    PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files
2344210b5426SBarry Smith    and slows the program down.
2345210b5426SBarry Smith 
2346210b5426SBarry Smith    Collective over PETSC_COMM_WORLD
2347210b5426SBarry Smith 
2348210b5426SBarry Smith    Options Database Keys:
2349a2553e36SBarry Smith . -log_mpe - Prints extensive log information
2350210b5426SBarry Smith 
2351210b5426SBarry Smith    Notes:
2352609bdbeeSBarry Smith    A related routine is PetscLogDefaultBegin() (with the options key -log_view), which is
2353210b5426SBarry Smith    intended for production runs since it logs only flop rates and object
2354210b5426SBarry Smith    creation (and should not significantly slow the programs).
2355210b5426SBarry Smith 
2356210b5426SBarry Smith    Level: advanced
2357210b5426SBarry Smith 
2358bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogEventActivate(),
2359210b5426SBarry Smith           PetscLogEventDeactivate()
2360210b5426SBarry Smith @*/
2361210b5426SBarry Smith PetscErrorCode  PetscLogMPEBegin(void)
2362210b5426SBarry Smith {
2363210b5426SBarry Smith   PetscErrorCode ierr;
2364210b5426SBarry Smith 
2365210b5426SBarry Smith   PetscFunctionBegin;
2366210b5426SBarry Smith   /* Do MPE initialization */
2367210b5426SBarry Smith   if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */
23685f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscInfo(0,"Initializing MPE.\n"));
23695f80ce2aSJacob Faibussowitsch     CHKERRQ(MPE_Init_log());
2370210b5426SBarry Smith 
2371210b5426SBarry Smith     PetscBeganMPE = PETSC_TRUE;
2372210b5426SBarry Smith   } else {
23735f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n"));
2374210b5426SBarry Smith   }
23755f80ce2aSJacob Faibussowitsch   CHKERRQ(PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE));
2376210b5426SBarry Smith   PetscFunctionReturn(0);
2377210b5426SBarry Smith }
2378210b5426SBarry Smith 
2379210b5426SBarry Smith /*@C
2380495fc317SBarry Smith    PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot.
2381210b5426SBarry Smith 
2382210b5426SBarry Smith    Collective over PETSC_COMM_WORLD
2383210b5426SBarry Smith 
2384210b5426SBarry Smith    Level: advanced
2385210b5426SBarry Smith 
2386210b5426SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogMPEBegin()
2387210b5426SBarry Smith @*/
2388210b5426SBarry Smith PetscErrorCode  PetscLogMPEDump(const char sname[])
2389210b5426SBarry Smith {
2390210b5426SBarry Smith   char           name[PETSC_MAX_PATH_LEN];
2391210b5426SBarry Smith   PetscErrorCode ierr;
2392210b5426SBarry Smith 
2393210b5426SBarry Smith   PetscFunctionBegin;
2394210b5426SBarry Smith   if (PetscBeganMPE) {
23955f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscInfo(0,"Finalizing MPE.\n"));
2396210b5426SBarry Smith     if (sname) {
23975f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscStrcpy(name,sname));
2398210b5426SBarry Smith     } else {
23995f80ce2aSJacob Faibussowitsch       CHKERRQ(PetscGetProgramName(name,sizeof(name)));
2400210b5426SBarry Smith     }
24015f80ce2aSJacob Faibussowitsch     CHKERRQ(MPE_Finish_log(name));
2402210b5426SBarry Smith   } else {
24035f80ce2aSJacob Faibussowitsch     CHKERRQ(PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n"));
2404210b5426SBarry Smith   }
2405210b5426SBarry Smith   PetscFunctionReturn(0);
2406210b5426SBarry Smith }
2407210b5426SBarry Smith 
2408210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39
2409210b5426SBarry Smith static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = {
2410210b5426SBarry Smith   "OliveDrab:      ",
2411210b5426SBarry Smith   "BlueViolet:     ",
2412210b5426SBarry Smith   "CadetBlue:      ",
2413210b5426SBarry Smith   "CornflowerBlue: ",
2414210b5426SBarry Smith   "DarkGoldenrod:  ",
2415210b5426SBarry Smith   "DarkGreen:      ",
2416210b5426SBarry Smith   "DarkKhaki:      ",
2417210b5426SBarry Smith   "DarkOliveGreen: ",
2418210b5426SBarry Smith   "DarkOrange:     ",
2419210b5426SBarry Smith   "DarkOrchid:     ",
2420210b5426SBarry Smith   "DarkSeaGreen:   ",
2421210b5426SBarry Smith   "DarkSlateGray:  ",
2422210b5426SBarry Smith   "DarkTurquoise:  ",
2423210b5426SBarry Smith   "DeepPink:       ",
2424210b5426SBarry Smith   "DarkKhaki:      ",
2425210b5426SBarry Smith   "DimGray:        ",
2426210b5426SBarry Smith   "DodgerBlue:     ",
2427210b5426SBarry Smith   "GreenYellow:    ",
2428210b5426SBarry Smith   "HotPink:        ",
2429210b5426SBarry Smith   "IndianRed:      ",
2430210b5426SBarry Smith   "LavenderBlush:  ",
2431210b5426SBarry Smith   "LawnGreen:      ",
2432210b5426SBarry Smith   "LemonChiffon:   ",
2433210b5426SBarry Smith   "LightCoral:     ",
2434210b5426SBarry Smith   "LightCyan:      ",
2435210b5426SBarry Smith   "LightPink:      ",
2436210b5426SBarry Smith   "LightSalmon:    ",
2437210b5426SBarry Smith   "LightSlateGray: ",
2438210b5426SBarry Smith   "LightYellow:    ",
2439210b5426SBarry Smith   "LimeGreen:      ",
2440210b5426SBarry Smith   "MediumPurple:   ",
2441210b5426SBarry Smith   "MediumSeaGreen: ",
2442210b5426SBarry Smith   "MediumSlateBlue:",
2443210b5426SBarry Smith   "MidnightBlue:   ",
2444210b5426SBarry Smith   "MintCream:      ",
2445210b5426SBarry Smith   "MistyRose:      ",
2446210b5426SBarry Smith   "NavajoWhite:    ",
2447210b5426SBarry Smith   "NavyBlue:       ",
2448210b5426SBarry Smith   "OliveDrab:      "
2449210b5426SBarry Smith };
2450210b5426SBarry Smith 
2451210b5426SBarry Smith /*@C
2452210b5426SBarry Smith   PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister()
2453210b5426SBarry Smith 
2454210b5426SBarry Smith   Not collective. Maybe it should be?
2455210b5426SBarry Smith 
24567a7aea1fSJed Brown   Output Parameter:
2457210b5426SBarry Smith . str - character string representing the color
2458210b5426SBarry Smith 
2459210b5426SBarry Smith   Level: developer
2460210b5426SBarry Smith 
2461210b5426SBarry Smith .seealso: PetscLogEventRegister
2462210b5426SBarry Smith @*/
2463210b5426SBarry Smith PetscErrorCode  PetscLogMPEGetRGBColor(const char *str[])
2464210b5426SBarry Smith {
2465210b5426SBarry Smith   static int idx = 0;
2466210b5426SBarry Smith 
2467210b5426SBarry Smith   PetscFunctionBegin;
2468210b5426SBarry Smith   *str = PetscLogMPERGBColors[idx];
2469210b5426SBarry Smith   idx  = (idx + 1)% PETSC_RGB_COLORS_MAX;
2470210b5426SBarry Smith   PetscFunctionReturn(0);
2471210b5426SBarry Smith }
2472210b5426SBarry Smith 
2473210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */
2474