xref: /petsc/src/sys/logging/plog.c (revision a2fddd78f770fa4fc19a8af67e65be331f27d92b)
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 */
88958c4211Shannah_mairs PetscLogDouble petsc_gflops          = 0.0;  /* The flops done on a GPU */
89958c4211Shannah_mairs PetscLogDouble petsc_gtime           = 0.0;  /* The time spent on a GPU */
909ffd0706SHong Zhang 
918df2f0b1SJunchao Zhang #if defined(PETSC_USE_DEBUG)
928df2f0b1SJunchao Zhang PetscBool petsc_gtime_inuse = PETSC_FALSE;
938df2f0b1SJunchao Zhang #endif
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;
114fa2bb9feSLisandro Dalcin   PetscErrorCode ierr;
1155c6c1daeSBarry Smith 
116fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
117fa2bb9feSLisandro Dalcin   if (PetscLogInitializeCalled) PetscFunctionReturn(0);
118fa2bb9feSLisandro Dalcin   PetscLogInitializeCalled = PETSC_TRUE;
1195c6c1daeSBarry Smith 
120fa2bb9feSLisandro Dalcin   ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_actions", &opt);CHKERRQ(ierr);
121fa2bb9feSLisandro Dalcin   if (opt) petsc_logActions = PETSC_FALSE;
122fa2bb9feSLisandro Dalcin   ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_objects", &opt);CHKERRQ(ierr);
123fa2bb9feSLisandro Dalcin   if (opt) petsc_logObjects = PETSC_FALSE;
124fa2bb9feSLisandro Dalcin   if (petsc_logActions) {
125fa2bb9feSLisandro Dalcin     ierr = PetscMalloc1(petsc_maxActions, &petsc_actions);CHKERRQ(ierr);
126fa2bb9feSLisandro Dalcin   }
127fa2bb9feSLisandro Dalcin   if (petsc_logObjects) {
128fa2bb9feSLisandro Dalcin     ierr = PetscMalloc1(petsc_maxObjects, &petsc_objects);CHKERRQ(ierr);
129fa2bb9feSLisandro Dalcin   }
130fa2bb9feSLisandro Dalcin   PetscLogPHC = PetscLogObjCreateDefault;
131fa2bb9feSLisandro Dalcin   PetscLogPHD = PetscLogObjDestroyDefault;
132fa2bb9feSLisandro Dalcin   /* Setup default logging structures */
133fa2bb9feSLisandro Dalcin   ierr = PetscStageLogCreate(&petsc_stageLog);CHKERRQ(ierr);
134fa2bb9feSLisandro Dalcin   ierr = PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage);CHKERRQ(ierr);
1355c6c1daeSBarry Smith 
136fa2bb9feSLisandro Dalcin   /* All processors sync here for more consistent logging */
137ffc4695bSBarry Smith   ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRMPI(ierr);
138fa2bb9feSLisandro Dalcin   PetscTime(&petsc_BaseTime);
139fa2bb9feSLisandro Dalcin   ierr = PetscLogStagePush(stage);CHKERRQ(ierr);
140fa2bb9feSLisandro Dalcin   PetscFunctionReturn(0);
141fa2bb9feSLisandro Dalcin }
1425c6c1daeSBarry Smith 
14395c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogFinalize(void)
1445c6c1daeSBarry Smith {
1455c6c1daeSBarry Smith   PetscStageLog  stageLog;
1465c6c1daeSBarry Smith   PetscErrorCode ierr;
1475c6c1daeSBarry Smith 
1485c6c1daeSBarry Smith   PetscFunctionBegin;
1495c6c1daeSBarry Smith   ierr = PetscFree(petsc_actions);CHKERRQ(ierr);
1505c6c1daeSBarry Smith   ierr = PetscFree(petsc_objects);CHKERRQ(ierr);
151eccbb886SLisandro Dalcin   ierr = PetscLogNestedEnd();CHKERRQ(ierr);
1520298fd71SBarry Smith   ierr = PetscLogSet(NULL, NULL);CHKERRQ(ierr);
1535c6c1daeSBarry Smith 
1545c6c1daeSBarry Smith   /* Resetting phase */
1555c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
1565c6c1daeSBarry Smith   ierr = PetscStageLogDestroy(stageLog);CHKERRQ(ierr);
157a297a907SKarl Rupp 
1585c6c1daeSBarry Smith   petsc_TotalFlops            = 0.0;
1595c6c1daeSBarry Smith   petsc_numActions            = 0;
1605c6c1daeSBarry Smith   petsc_numObjects            = 0;
1615c6c1daeSBarry Smith   petsc_numObjectsDestroyed   = 0;
1625c6c1daeSBarry Smith   petsc_maxActions            = 100;
1635c6c1daeSBarry Smith   petsc_maxObjects            = 100;
1640298fd71SBarry Smith   petsc_actions               = NULL;
1650298fd71SBarry Smith   petsc_objects               = NULL;
1665c6c1daeSBarry Smith   petsc_logActions            = PETSC_FALSE;
1675c6c1daeSBarry Smith   petsc_logObjects            = PETSC_FALSE;
1685c6c1daeSBarry Smith   petsc_BaseTime              = 0.0;
1695c6c1daeSBarry Smith   petsc_TotalFlops            = 0.0;
1705c6c1daeSBarry Smith   petsc_tmp_flops             = 0.0;
1715c6c1daeSBarry Smith   petsc_send_ct               = 0.0;
1725c6c1daeSBarry Smith   petsc_recv_ct               = 0.0;
1735c6c1daeSBarry Smith   petsc_send_len              = 0.0;
1745c6c1daeSBarry Smith   petsc_recv_len              = 0.0;
1755c6c1daeSBarry Smith   petsc_isend_ct              = 0.0;
1765c6c1daeSBarry Smith   petsc_irecv_ct              = 0.0;
1775c6c1daeSBarry Smith   petsc_isend_len             = 0.0;
1785c6c1daeSBarry Smith   petsc_irecv_len             = 0.0;
1795c6c1daeSBarry Smith   petsc_wait_ct               = 0.0;
1805c6c1daeSBarry Smith   petsc_wait_any_ct           = 0.0;
1815c6c1daeSBarry Smith   petsc_wait_all_ct           = 0.0;
1825c6c1daeSBarry Smith   petsc_sum_of_waits_ct       = 0.0;
1835c6c1daeSBarry Smith   petsc_allreduce_ct          = 0.0;
1845c6c1daeSBarry Smith   petsc_gather_ct             = 0.0;
1855c6c1daeSBarry Smith   petsc_scatter_ct            = 0.0;
186d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
187bec0b493Shannah_mairs   petsc_ctog_ct               = 0.0;
188bec0b493Shannah_mairs   petsc_gtoc_ct               = 0.0;
189bec0b493Shannah_mairs   petsc_ctog_sz               = 0.0;
190bec0b493Shannah_mairs   petsc_gtoc_sz               = 0.0;
191958c4211Shannah_mairs   petsc_gflops                = 0.0;
192958c4211Shannah_mairs   petsc_gtime                 = 0.0;
193bec0b493Shannah_mairs   #endif
1945c6c1daeSBarry Smith   PETSC_LARGEST_EVENT         = PETSC_EVENT;
1950298fd71SBarry Smith   PetscLogPHC                 = NULL;
1960298fd71SBarry Smith   PetscLogPHD                 = NULL;
1970298fd71SBarry Smith   petsc_tracefile             = NULL;
1985c6c1daeSBarry Smith   petsc_tracelevel            = 0;
1995c6c1daeSBarry Smith   petsc_traceblanks           = "                                                                                                    ";
2005c6c1daeSBarry Smith   petsc_tracespace[0]         = ' '; petsc_tracespace[1] = 0;
2015c6c1daeSBarry Smith   petsc_tracetime             = 0.0;
2025c6c1daeSBarry Smith   PETSC_LARGEST_CLASSID       = PETSC_SMALLEST_CLASSID;
2035c6c1daeSBarry Smith   PETSC_OBJECT_CLASSID        = 0;
20402c9f0b5SLisandro Dalcin   petsc_stageLog              = NULL;
205896238b9SBarry Smith   PetscLogInitializeCalled    = PETSC_FALSE;
2065c6c1daeSBarry Smith   PetscFunctionReturn(0);
2075c6c1daeSBarry Smith }
2085c6c1daeSBarry Smith 
2095c6c1daeSBarry Smith /*@C
2105c6c1daeSBarry Smith   PetscLogSet - Sets the logging functions called at the beginning and ending of every event.
2115c6c1daeSBarry Smith 
2125c6c1daeSBarry Smith   Not Collective
2135c6c1daeSBarry Smith 
2145c6c1daeSBarry Smith   Input Parameters:
2155c6c1daeSBarry Smith + b - The function called at beginning of event
2165c6c1daeSBarry Smith - e - The function called at end of event
2175c6c1daeSBarry Smith 
2185c6c1daeSBarry Smith   Level: developer
2195c6c1daeSBarry Smith 
220bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogTraceBegin()
2215c6c1daeSBarry Smith @*/
2225c6c1daeSBarry Smith PetscErrorCode  PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject),
2235c6c1daeSBarry Smith                             PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject))
2245c6c1daeSBarry Smith {
2255c6c1daeSBarry Smith   PetscFunctionBegin;
2265c6c1daeSBarry Smith   PetscLogPLB = b;
2275c6c1daeSBarry Smith   PetscLogPLE = e;
2285c6c1daeSBarry Smith   PetscFunctionReturn(0);
2295c6c1daeSBarry Smith }
2305c6c1daeSBarry Smith 
2315c6c1daeSBarry Smith /*@C
232bb1d7374SBarry Smith   PetscLogDefaultBegin - Turns on logging of objects and events. This logs flop
2335c6c1daeSBarry Smith   rates and object creation and should not slow programs down too much.
2345c6c1daeSBarry Smith   This routine may be called more than once.
2355c6c1daeSBarry Smith 
2365c6c1daeSBarry Smith   Logically Collective over PETSC_COMM_WORLD
2375c6c1daeSBarry Smith 
2385c6c1daeSBarry Smith   Options Database Keys:
239a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the
240a2553e36SBarry Smith                   screen (for code configured with --with-log=1 (which is the default))
2415c6c1daeSBarry Smith 
2425c6c1daeSBarry Smith   Usage:
2435c6c1daeSBarry Smith .vb
2445c6c1daeSBarry Smith       PetscInitialize(...);
245bb1d7374SBarry Smith       PetscLogDefaultBegin();
2465c6c1daeSBarry Smith        ... code ...
2475c6c1daeSBarry Smith       PetscLogView(viewer); or PetscLogDump();
2485c6c1daeSBarry Smith       PetscFinalize();
2495c6c1daeSBarry Smith .ve
2505c6c1daeSBarry Smith 
2515c6c1daeSBarry Smith   Notes:
2525c6c1daeSBarry Smith   PetscLogView(viewer) or PetscLogDump() actually cause the printing of
2535c6c1daeSBarry Smith   the logging information.
2545c6c1daeSBarry Smith 
2555c6c1daeSBarry Smith   Level: advanced
2565c6c1daeSBarry Smith 
2575c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogTraceBegin()
2585c6c1daeSBarry Smith @*/
259bb1d7374SBarry Smith PetscErrorCode  PetscLogDefaultBegin(void)
2605c6c1daeSBarry Smith {
2615c6c1daeSBarry Smith   PetscErrorCode ierr;
2625c6c1daeSBarry Smith 
2635c6c1daeSBarry Smith   PetscFunctionBegin;
2645c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault);CHKERRQ(ierr);
2655c6c1daeSBarry Smith   PetscFunctionReturn(0);
2665c6c1daeSBarry Smith }
2675c6c1daeSBarry Smith 
2685c6c1daeSBarry Smith /*@C
2695c6c1daeSBarry Smith   PetscLogAllBegin - Turns on extensive logging of objects and events. Logs
2705c6c1daeSBarry Smith   all events. This creates large log files and slows the program down.
2715c6c1daeSBarry Smith 
2725c6c1daeSBarry Smith   Logically Collective on PETSC_COMM_WORLD
2735c6c1daeSBarry Smith 
2745c6c1daeSBarry Smith   Options Database Keys:
275a2553e36SBarry Smith . -log_all - Prints extensive log information
2765c6c1daeSBarry Smith 
2775c6c1daeSBarry Smith   Usage:
2785c6c1daeSBarry Smith .vb
2795c6c1daeSBarry Smith      PetscInitialize(...);
2805c6c1daeSBarry Smith      PetscLogAllBegin();
2815c6c1daeSBarry Smith      ... code ...
2825c6c1daeSBarry Smith      PetscLogDump(filename);
2835c6c1daeSBarry Smith      PetscFinalize();
2845c6c1daeSBarry Smith .ve
2855c6c1daeSBarry Smith 
2865c6c1daeSBarry Smith   Notes:
287bb1d7374SBarry Smith   A related routine is PetscLogDefaultBegin() (with the options key -log), which is
2885c6c1daeSBarry Smith   intended for production runs since it logs only flop rates and object
2895c6c1daeSBarry Smith   creation (and shouldn't significantly slow the programs).
2905c6c1daeSBarry Smith 
2915c6c1daeSBarry Smith   Level: advanced
2925c6c1daeSBarry Smith 
293bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogTraceBegin()
2945c6c1daeSBarry Smith @*/
2955c6c1daeSBarry Smith PetscErrorCode  PetscLogAllBegin(void)
2965c6c1daeSBarry Smith {
2975c6c1daeSBarry Smith   PetscErrorCode ierr;
2985c6c1daeSBarry Smith 
2995c6c1daeSBarry Smith   PetscFunctionBegin;
3005c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete);CHKERRQ(ierr);
3015c6c1daeSBarry Smith   PetscFunctionReturn(0);
3025c6c1daeSBarry Smith }
3035c6c1daeSBarry Smith 
304956f8c0dSBarry Smith /*@C
3055c6c1daeSBarry Smith   PetscLogTraceBegin - Activates trace logging.  Every time a PETSc event
3065c6c1daeSBarry Smith   begins or ends, the event name is printed.
3075c6c1daeSBarry Smith 
3085c6c1daeSBarry Smith   Logically Collective on PETSC_COMM_WORLD
3095c6c1daeSBarry Smith 
3105c6c1daeSBarry Smith   Input Parameter:
3115c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout)
3125c6c1daeSBarry Smith 
3135c6c1daeSBarry Smith   Options Database Key:
3145c6c1daeSBarry Smith . -log_trace [filename] - Activates PetscLogTraceBegin()
3155c6c1daeSBarry Smith 
3165c6c1daeSBarry Smith   Notes:
3175c6c1daeSBarry Smith   PetscLogTraceBegin() prints the processor number, the execution time (sec),
3185c6c1daeSBarry Smith   then "Event begin:" or "Event end:" followed by the event name.
3195c6c1daeSBarry Smith 
3205c6c1daeSBarry Smith   PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful
3215c6c1daeSBarry Smith   to determine where a program is hanging without running in the
3225c6c1daeSBarry Smith   debugger.  Can be used in conjunction with the -info option.
3235c6c1daeSBarry Smith 
3245c6c1daeSBarry Smith   Level: intermediate
3255c6c1daeSBarry Smith 
326bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogDefaultBegin()
3275c6c1daeSBarry Smith @*/
3285c6c1daeSBarry Smith PetscErrorCode  PetscLogTraceBegin(FILE *file)
3295c6c1daeSBarry Smith {
3305c6c1daeSBarry Smith   PetscErrorCode ierr;
3315c6c1daeSBarry Smith 
3325c6c1daeSBarry Smith   PetscFunctionBegin;
3335c6c1daeSBarry Smith   petsc_tracefile = file;
334a297a907SKarl Rupp 
3355c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace);CHKERRQ(ierr);
3365c6c1daeSBarry Smith   PetscFunctionReturn(0);
3375c6c1daeSBarry Smith }
3385c6c1daeSBarry Smith 
3395c6c1daeSBarry Smith /*@
3405c6c1daeSBarry Smith   PetscLogActions - Determines whether actions are logged for the graphical viewer.
3415c6c1daeSBarry Smith 
3425c6c1daeSBarry Smith   Not Collective
3435c6c1daeSBarry Smith 
3445c6c1daeSBarry Smith   Input Parameter:
3455c6c1daeSBarry Smith . flag - PETSC_TRUE if actions are to be logged
3465c6c1daeSBarry Smith 
3475c6c1daeSBarry Smith   Level: intermediate
3485c6c1daeSBarry Smith 
3495c6c1daeSBarry Smith   Note: Logging of actions continues to consume more memory as the program
3505c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
3515c6c1daeSBarry Smith 
3525c6c1daeSBarry Smith   Options Database Keys:
3535c6c1daeSBarry Smith . -log_exclude_actions - Turns off actions logging
3545c6c1daeSBarry Smith 
3555c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
3565c6c1daeSBarry Smith @*/
3575c6c1daeSBarry Smith PetscErrorCode  PetscLogActions(PetscBool flag)
3585c6c1daeSBarry Smith {
3595c6c1daeSBarry Smith   PetscFunctionBegin;
3605c6c1daeSBarry Smith   petsc_logActions = flag;
3615c6c1daeSBarry Smith   PetscFunctionReturn(0);
3625c6c1daeSBarry Smith }
3635c6c1daeSBarry Smith 
3645c6c1daeSBarry Smith /*@
3655c6c1daeSBarry Smith   PetscLogObjects - Determines whether objects are logged for the graphical viewer.
3665c6c1daeSBarry Smith 
3675c6c1daeSBarry Smith   Not Collective
3685c6c1daeSBarry Smith 
3695c6c1daeSBarry Smith   Input Parameter:
3705c6c1daeSBarry Smith . flag - PETSC_TRUE if objects are to be logged
3715c6c1daeSBarry Smith 
3725c6c1daeSBarry Smith   Level: intermediate
3735c6c1daeSBarry Smith 
3745c6c1daeSBarry Smith   Note: Logging of objects continues to consume more memory as the program
3755c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
3765c6c1daeSBarry Smith 
3775c6c1daeSBarry Smith   Options Database Keys:
3785c6c1daeSBarry Smith . -log_exclude_objects - Turns off objects logging
3795c6c1daeSBarry Smith 
3805c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
3815c6c1daeSBarry Smith @*/
3825c6c1daeSBarry Smith PetscErrorCode  PetscLogObjects(PetscBool flag)
3835c6c1daeSBarry Smith {
3845c6c1daeSBarry Smith   PetscFunctionBegin;
3855c6c1daeSBarry Smith   petsc_logObjects = flag;
3865c6c1daeSBarry Smith   PetscFunctionReturn(0);
3875c6c1daeSBarry Smith }
3885c6c1daeSBarry Smith 
3895c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/
3905c6c1daeSBarry Smith /*@C
39174c0405dSRichard Tran Mills   PetscLogStageRegister - Attaches a character string name to a logging stage.
3925c6c1daeSBarry Smith 
3935c6c1daeSBarry Smith   Not Collective
3945c6c1daeSBarry Smith 
3955c6c1daeSBarry Smith   Input Parameter:
3965c6c1daeSBarry Smith . sname - The name to associate with that stage
3975c6c1daeSBarry Smith 
3985c6c1daeSBarry Smith   Output Parameter:
3995c6c1daeSBarry Smith . stage - The stage number
4005c6c1daeSBarry Smith 
4015c6c1daeSBarry Smith   Level: intermediate
4025c6c1daeSBarry Smith 
4035c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
4045c6c1daeSBarry Smith @*/
4055c6c1daeSBarry Smith PetscErrorCode  PetscLogStageRegister(const char sname[],PetscLogStage *stage)
4065c6c1daeSBarry Smith {
4075c6c1daeSBarry Smith   PetscStageLog  stageLog;
4085c6c1daeSBarry Smith   PetscLogEvent  event;
4095c6c1daeSBarry Smith   PetscErrorCode ierr;
4105c6c1daeSBarry Smith 
4115c6c1daeSBarry Smith   PetscFunctionBegin;
4125c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
4135c6c1daeSBarry Smith   ierr = PetscStageLogRegister(stageLog, sname, stage);CHKERRQ(ierr);
4145c6c1daeSBarry Smith   /* Copy events already changed in the main stage, this sucks */
4153a88037aSBarry Smith   ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr);
4165c6c1daeSBarry Smith   for (event = 0; event < stageLog->eventLog->numEvents; event++) {
4173a88037aSBarry Smith     ierr = PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event],&stageLog->stageInfo[*stage].eventLog->eventInfo[event]);CHKERRQ(ierr);
4185c6c1daeSBarry Smith   }
4193a88037aSBarry Smith   ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
4205c6c1daeSBarry Smith   PetscFunctionReturn(0);
4215c6c1daeSBarry Smith }
4225c6c1daeSBarry Smith 
4235c6c1daeSBarry Smith /*@C
4245c6c1daeSBarry Smith   PetscLogStagePush - This function pushes a stage on the stack.
4255c6c1daeSBarry Smith 
4265c6c1daeSBarry Smith   Not Collective
4275c6c1daeSBarry Smith 
4285c6c1daeSBarry Smith   Input Parameter:
4295c6c1daeSBarry Smith . stage - The stage on which to log
4305c6c1daeSBarry Smith 
4315c6c1daeSBarry Smith   Usage:
4325c6c1daeSBarry Smith   If the option -log_sumary is used to run the program containing the
4335c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
4345c6c1daeSBarry Smith   PetscFinalize().
4355c6c1daeSBarry Smith .vb
4365c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
4375c6c1daeSBarry Smith       [stage 0 of code]
4385c6c1daeSBarry Smith       PetscLogStagePush(1);
4395c6c1daeSBarry Smith       [stage 1 of code]
4405c6c1daeSBarry Smith       PetscLogStagePop();
4415c6c1daeSBarry Smith       PetscBarrier(...);
4425c6c1daeSBarry Smith       [more stage 0 of code]
4435c6c1daeSBarry Smith       PetscFinalize();
4445c6c1daeSBarry Smith .ve
4455c6c1daeSBarry Smith 
4465c6c1daeSBarry Smith   Notes:
4475c6c1daeSBarry Smith   Use PetscLogStageRegister() to register a stage.
4485c6c1daeSBarry Smith 
4495c6c1daeSBarry Smith   Level: intermediate
4505c6c1daeSBarry Smith 
4515c6c1daeSBarry Smith .seealso: PetscLogStagePop(), PetscLogStageRegister(), PetscBarrier()
4525c6c1daeSBarry Smith @*/
4535c6c1daeSBarry Smith PetscErrorCode  PetscLogStagePush(PetscLogStage stage)
4545c6c1daeSBarry Smith {
4555c6c1daeSBarry Smith   PetscStageLog  stageLog;
4565c6c1daeSBarry Smith   PetscErrorCode ierr;
4575c6c1daeSBarry Smith 
4585c6c1daeSBarry Smith   PetscFunctionBegin;
4595c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
4605c6c1daeSBarry Smith   ierr = PetscStageLogPush(stageLog, stage);CHKERRQ(ierr);
4615c6c1daeSBarry Smith   PetscFunctionReturn(0);
4625c6c1daeSBarry Smith }
4635c6c1daeSBarry Smith 
4645c6c1daeSBarry Smith /*@C
4655c6c1daeSBarry Smith   PetscLogStagePop - This function pops a stage from the stack.
4665c6c1daeSBarry Smith 
4675c6c1daeSBarry Smith   Not Collective
4685c6c1daeSBarry Smith 
4695c6c1daeSBarry Smith   Usage:
4705c6c1daeSBarry Smith   If the option -log_sumary is used to run the program containing the
4715c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
4725c6c1daeSBarry Smith   PetscFinalize().
4735c6c1daeSBarry Smith .vb
4745c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
4755c6c1daeSBarry Smith       [stage 0 of code]
4765c6c1daeSBarry Smith       PetscLogStagePush(1);
4775c6c1daeSBarry Smith       [stage 1 of code]
4785c6c1daeSBarry Smith       PetscLogStagePop();
4795c6c1daeSBarry Smith       PetscBarrier(...);
4805c6c1daeSBarry Smith       [more stage 0 of code]
4815c6c1daeSBarry Smith       PetscFinalize();
4825c6c1daeSBarry Smith .ve
4835c6c1daeSBarry Smith 
4845c6c1daeSBarry Smith   Notes:
4855c6c1daeSBarry Smith   Use PetscLogStageRegister() to register a stage.
4865c6c1daeSBarry Smith 
4875c6c1daeSBarry Smith   Level: intermediate
4885c6c1daeSBarry Smith 
4895c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStageRegister(), PetscBarrier()
4905c6c1daeSBarry Smith @*/
4915c6c1daeSBarry Smith PetscErrorCode  PetscLogStagePop(void)
4925c6c1daeSBarry Smith {
4935c6c1daeSBarry Smith   PetscStageLog  stageLog;
4945c6c1daeSBarry Smith   PetscErrorCode ierr;
4955c6c1daeSBarry Smith 
4965c6c1daeSBarry Smith   PetscFunctionBegin;
4975c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
4985c6c1daeSBarry Smith   ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr);
4995c6c1daeSBarry Smith   PetscFunctionReturn(0);
5005c6c1daeSBarry Smith }
5015c6c1daeSBarry Smith 
5025c6c1daeSBarry Smith /*@
5035c6c1daeSBarry Smith   PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd().
5045c6c1daeSBarry Smith 
5055c6c1daeSBarry Smith   Not Collective
5065c6c1daeSBarry Smith 
5075c6c1daeSBarry Smith   Input Parameters:
5085c6c1daeSBarry Smith + stage    - The stage
5095c6c1daeSBarry Smith - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE)
5105c6c1daeSBarry Smith 
5115c6c1daeSBarry Smith   Level: intermediate
5125c6c1daeSBarry Smith 
5135c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
5145c6c1daeSBarry Smith @*/
5155c6c1daeSBarry Smith PetscErrorCode  PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive)
5165c6c1daeSBarry Smith {
5175c6c1daeSBarry Smith   PetscStageLog  stageLog;
5185c6c1daeSBarry Smith   PetscErrorCode ierr;
5195c6c1daeSBarry Smith 
5205c6c1daeSBarry Smith   PetscFunctionBegin;
5215c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5225c6c1daeSBarry Smith   ierr = PetscStageLogSetActive(stageLog, stage, isActive);CHKERRQ(ierr);
5235c6c1daeSBarry Smith   PetscFunctionReturn(0);
5245c6c1daeSBarry Smith }
5255c6c1daeSBarry Smith 
5265c6c1daeSBarry Smith /*@
5275c6c1daeSBarry Smith   PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd().
5285c6c1daeSBarry Smith 
5295c6c1daeSBarry Smith   Not Collective
5305c6c1daeSBarry Smith 
5315c6c1daeSBarry Smith   Input Parameter:
5325c6c1daeSBarry Smith . stage    - The stage
5335c6c1daeSBarry Smith 
5345c6c1daeSBarry Smith   Output Parameter:
5355c6c1daeSBarry Smith . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE)
5365c6c1daeSBarry Smith 
5375c6c1daeSBarry Smith   Level: intermediate
5385c6c1daeSBarry Smith 
5395c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
5405c6c1daeSBarry Smith @*/
5415c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetActive(PetscLogStage stage, PetscBool  *isActive)
5425c6c1daeSBarry Smith {
5435c6c1daeSBarry Smith   PetscStageLog  stageLog;
5445c6c1daeSBarry Smith   PetscErrorCode ierr;
5455c6c1daeSBarry Smith 
5465c6c1daeSBarry Smith   PetscFunctionBegin;
5475c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5485c6c1daeSBarry Smith   ierr = PetscStageLogGetActive(stageLog, stage, isActive);CHKERRQ(ierr);
5495c6c1daeSBarry Smith   PetscFunctionReturn(0);
5505c6c1daeSBarry Smith }
5515c6c1daeSBarry Smith 
5525c6c1daeSBarry Smith /*@
5535c6c1daeSBarry Smith   PetscLogStageSetVisible - Determines stage visibility in PetscLogView()
5545c6c1daeSBarry Smith 
5555c6c1daeSBarry Smith   Not Collective
5565c6c1daeSBarry Smith 
5575c6c1daeSBarry Smith   Input Parameters:
5585c6c1daeSBarry Smith + stage     - The stage
5595c6c1daeSBarry Smith - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE)
5605c6c1daeSBarry Smith 
5615c6c1daeSBarry Smith   Level: intermediate
5625c6c1daeSBarry Smith 
5635c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView()
5645c6c1daeSBarry Smith @*/
5655c6c1daeSBarry Smith PetscErrorCode  PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible)
5665c6c1daeSBarry Smith {
5675c6c1daeSBarry Smith   PetscStageLog  stageLog;
5685c6c1daeSBarry Smith   PetscErrorCode ierr;
5695c6c1daeSBarry Smith 
5705c6c1daeSBarry Smith   PetscFunctionBegin;
5715c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5725c6c1daeSBarry Smith   ierr = PetscStageLogSetVisible(stageLog, stage, isVisible);CHKERRQ(ierr);
5735c6c1daeSBarry Smith   PetscFunctionReturn(0);
5745c6c1daeSBarry Smith }
5755c6c1daeSBarry Smith 
5765c6c1daeSBarry Smith /*@
5775c6c1daeSBarry Smith   PetscLogStageGetVisible - Returns stage visibility in PetscLogView()
5785c6c1daeSBarry Smith 
5795c6c1daeSBarry Smith   Not Collective
5805c6c1daeSBarry Smith 
5815c6c1daeSBarry Smith   Input Parameter:
5825c6c1daeSBarry Smith . stage     - The stage
5835c6c1daeSBarry Smith 
5845c6c1daeSBarry Smith   Output Parameter:
5855c6c1daeSBarry Smith . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE)
5865c6c1daeSBarry Smith 
5875c6c1daeSBarry Smith   Level: intermediate
5885c6c1daeSBarry Smith 
5895c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView()
5905c6c1daeSBarry Smith @*/
5915c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetVisible(PetscLogStage stage, PetscBool  *isVisible)
5925c6c1daeSBarry Smith {
5935c6c1daeSBarry Smith   PetscStageLog  stageLog;
5945c6c1daeSBarry Smith   PetscErrorCode ierr;
5955c6c1daeSBarry Smith 
5965c6c1daeSBarry Smith   PetscFunctionBegin;
5975c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5985c6c1daeSBarry Smith   ierr = PetscStageLogGetVisible(stageLog, stage, isVisible);CHKERRQ(ierr);
5995c6c1daeSBarry Smith   PetscFunctionReturn(0);
6005c6c1daeSBarry Smith }
6015c6c1daeSBarry Smith 
6025c6c1daeSBarry Smith /*@C
6035c6c1daeSBarry Smith   PetscLogStageGetId - Returns the stage id when given the stage name.
6045c6c1daeSBarry Smith 
6055c6c1daeSBarry Smith   Not Collective
6065c6c1daeSBarry Smith 
6075c6c1daeSBarry Smith   Input Parameter:
6085c6c1daeSBarry Smith . name  - The stage name
6095c6c1daeSBarry Smith 
6105c6c1daeSBarry Smith   Output Parameter:
6115a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists
6125c6c1daeSBarry Smith 
6135c6c1daeSBarry Smith   Level: intermediate
6145c6c1daeSBarry Smith 
6155c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
6165c6c1daeSBarry Smith @*/
6175c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetId(const char name[], PetscLogStage *stage)
6185c6c1daeSBarry Smith {
6195c6c1daeSBarry Smith   PetscStageLog  stageLog;
6205c6c1daeSBarry Smith   PetscErrorCode ierr;
6215c6c1daeSBarry Smith 
6225c6c1daeSBarry Smith   PetscFunctionBegin;
6235c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
6245c6c1daeSBarry Smith   ierr = PetscStageLogGetStage(stageLog, name, stage);CHKERRQ(ierr);
6255c6c1daeSBarry Smith   PetscFunctionReturn(0);
6265c6c1daeSBarry Smith }
6275c6c1daeSBarry Smith 
6285c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/
6295c6c1daeSBarry Smith /*@C
6305c6c1daeSBarry Smith   PetscLogEventRegister - Registers an event name for logging operations in an application code.
6315c6c1daeSBarry Smith 
6325c6c1daeSBarry Smith   Not Collective
6335c6c1daeSBarry Smith 
6345c6c1daeSBarry Smith   Input Parameter:
6355c6c1daeSBarry Smith + name   - The name associated with the event
6365c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with
6375c6c1daeSBarry Smith            PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones
6385c6c1daeSBarry Smith            are only available in C code
6395c6c1daeSBarry Smith 
6405c6c1daeSBarry Smith   Output Parameter:
6415c6c1daeSBarry Smith . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd().
6425c6c1daeSBarry Smith 
6435c6c1daeSBarry Smith   Example of Usage:
6445c6c1daeSBarry Smith .vb
6455c6c1daeSBarry Smith       PetscLogEvent USER_EVENT;
6465c6c1daeSBarry Smith       PetscClassId classid;
6475c6c1daeSBarry Smith       PetscLogDouble user_event_flops;
6485c6c1daeSBarry Smith       PetscClassIdRegister("class name",&classid);
6495c6c1daeSBarry Smith       PetscLogEventRegister("User event name",classid,&USER_EVENT);
6505c6c1daeSBarry Smith       PetscLogEventBegin(USER_EVENT,0,0,0,0);
6515c6c1daeSBarry Smith          [code segment to monitor]
6525c6c1daeSBarry Smith          PetscLogFlops(user_event_flops);
6535c6c1daeSBarry Smith       PetscLogEventEnd(USER_EVENT,0,0,0,0);
6545c6c1daeSBarry Smith .ve
6555c6c1daeSBarry Smith 
6565c6c1daeSBarry Smith   Notes:
6575c6c1daeSBarry Smith   PETSc automatically logs library events if the code has been
658a2553e36SBarry Smith   configured with --with-log (which is the default) and
659a2553e36SBarry Smith   -log_view or -log_all is specified.  PetscLogEventRegister() is
6605c6c1daeSBarry Smith   intended for logging user events to supplement this PETSc
6615c6c1daeSBarry Smith   information.
6625c6c1daeSBarry Smith 
663495fc317SBarry Smith   PETSc can gather data for use with the utilities Jumpshot
6645c6c1daeSBarry Smith   (part of the MPICH distribution).  If PETSc has been compiled
6655c6c1daeSBarry Smith   with flag -DPETSC_HAVE_MPE (MPE is an additional utility within
6665c6c1daeSBarry Smith   MPICH), the user can employ another command line option, -log_mpe,
6675c6c1daeSBarry Smith   to create a logfile, "mpe.log", which can be visualized
668495fc317SBarry Smith   Jumpshot.
6695c6c1daeSBarry Smith 
6705c6c1daeSBarry Smith   The classid is associated with each event so that classes of events
6715c6c1daeSBarry Smith   can be disabled simultaneously, such as all matrix events. The user
6725c6c1daeSBarry Smith   can either use an existing classid, such as MAT_CLASSID, or create
6735c6c1daeSBarry Smith   their own as shown in the example.
6745c6c1daeSBarry Smith 
675c5deb1d5SJed Brown   If an existing event with the same name exists, its event handle is
676c5deb1d5SJed Brown   returned instead of creating a new event.
677c5deb1d5SJed Brown 
6785c6c1daeSBarry Smith   Level: intermediate
6795c6c1daeSBarry Smith 
6805c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogFlops(),
6815c6c1daeSBarry Smith           PetscLogEventActivate(), PetscLogEventDeactivate(), PetscClassIdRegister()
6825c6c1daeSBarry Smith @*/
6835c6c1daeSBarry Smith PetscErrorCode  PetscLogEventRegister(const char name[],PetscClassId classid,PetscLogEvent *event)
6845c6c1daeSBarry Smith {
6855c6c1daeSBarry Smith   PetscStageLog  stageLog;
6865c6c1daeSBarry Smith   int            stage;
6875c6c1daeSBarry Smith   PetscErrorCode ierr;
6885c6c1daeSBarry Smith 
6895c6c1daeSBarry Smith   PetscFunctionBegin;
6905c6c1daeSBarry Smith   *event = PETSC_DECIDE;
6915c6c1daeSBarry Smith   ierr   = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
6923a88037aSBarry Smith   ierr   = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr);
693c5deb1d5SJed Brown   if (*event > 0) PetscFunctionReturn(0);
6943a88037aSBarry Smith   ierr   = PetscEventRegLogRegister(stageLog->eventLog, name, classid, event);CHKERRQ(ierr);
6955c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
6963a88037aSBarry Smith     ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr);
6973a88037aSBarry Smith     ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
6985c6c1daeSBarry Smith   }
6995c6c1daeSBarry Smith   PetscFunctionReturn(0);
7005c6c1daeSBarry Smith }
7015c6c1daeSBarry Smith 
7025c6c1daeSBarry Smith /*@
703217044c2SLisandro Dalcin   PetscLogEventSetCollective - Indicates that a particular event is collective.
704217044c2SLisandro Dalcin 
705217044c2SLisandro Dalcin   Not Collective
706217044c2SLisandro Dalcin 
707217044c2SLisandro Dalcin   Input Parameter:
708217044c2SLisandro Dalcin + event - The event id
709217044c2SLisandro Dalcin - collective - Bolean flag indicating whether a particular event is collective
710217044c2SLisandro Dalcin 
711217044c2SLisandro Dalcin   Note:
712217044c2SLisandro Dalcin   New events returned from PetscLogEventRegister() are collective by default.
713217044c2SLisandro Dalcin 
714217044c2SLisandro Dalcin   Level: developer
715217044c2SLisandro Dalcin 
716217044c2SLisandro Dalcin .seealso: PetscLogEventRegister()
717217044c2SLisandro Dalcin @*/
718217044c2SLisandro Dalcin PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event,PetscBool collective)
719217044c2SLisandro Dalcin {
720217044c2SLisandro Dalcin   PetscStageLog    stageLog;
721217044c2SLisandro Dalcin   PetscEventRegLog eventRegLog;
722217044c2SLisandro Dalcin   PetscErrorCode   ierr;
723217044c2SLisandro Dalcin 
724217044c2SLisandro Dalcin   PetscFunctionBegin;
725217044c2SLisandro Dalcin   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
726217044c2SLisandro Dalcin   ierr = PetscStageLogGetEventRegLog(stageLog,&eventRegLog);CHKERRQ(ierr);
727217044c2SLisandro Dalcin   if (event < 0 || event > eventRegLog->numEvents) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Invalid event id");
728217044c2SLisandro Dalcin   eventRegLog->eventInfo[event].collective = collective;
729217044c2SLisandro Dalcin   PetscFunctionReturn(0);
730217044c2SLisandro Dalcin }
731217044c2SLisandro Dalcin 
732217044c2SLisandro Dalcin /*@
733fa2bb9feSLisandro Dalcin   PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage.
734fa2bb9feSLisandro Dalcin 
735fa2bb9feSLisandro Dalcin   Not Collective
736fa2bb9feSLisandro Dalcin 
737fa2bb9feSLisandro Dalcin   Input Parameter:
738fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc.
739fa2bb9feSLisandro Dalcin 
740fa2bb9feSLisandro Dalcin   Level: developer
741fa2bb9feSLisandro Dalcin 
742fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate()
743fa2bb9feSLisandro Dalcin @*/
744fa2bb9feSLisandro Dalcin PetscErrorCode  PetscLogEventIncludeClass(PetscClassId classid)
745fa2bb9feSLisandro Dalcin {
746fa2bb9feSLisandro Dalcin   PetscStageLog  stageLog;
747fa2bb9feSLisandro Dalcin   int            stage;
748fa2bb9feSLisandro Dalcin   PetscErrorCode ierr;
749fa2bb9feSLisandro Dalcin 
750fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
751fa2bb9feSLisandro Dalcin   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
752fa2bb9feSLisandro Dalcin   for (stage = 0; stage < stageLog->numStages; stage++) {
753fa2bb9feSLisandro Dalcin     ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
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   PetscErrorCode ierr;
775fa2bb9feSLisandro Dalcin 
776fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
777fa2bb9feSLisandro Dalcin   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
778fa2bb9feSLisandro Dalcin   for (stage = 0; stage < stageLog->numStages; stage++) {
779fa2bb9feSLisandro Dalcin     ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
780fa2bb9feSLisandro Dalcin   }
781fa2bb9feSLisandro Dalcin   PetscFunctionReturn(0);
782fa2bb9feSLisandro Dalcin }
783fa2bb9feSLisandro Dalcin 
784fa2bb9feSLisandro Dalcin /*@
7855c6c1daeSBarry Smith   PetscLogEventActivate - Indicates that a particular event should be logged.
7865c6c1daeSBarry Smith 
7875c6c1daeSBarry Smith   Not Collective
7885c6c1daeSBarry Smith 
7895c6c1daeSBarry Smith   Input Parameter:
7905c6c1daeSBarry Smith . event - The event id
7915c6c1daeSBarry Smith 
7925c6c1daeSBarry Smith   Usage:
7935c6c1daeSBarry Smith .vb
7945c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
7955c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
7965c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
7975c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
7985c6c1daeSBarry Smith .ve
7995c6c1daeSBarry Smith 
8005c6c1daeSBarry Smith   Note:
8015c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in include/petsclog.h)
8025c6c1daeSBarry Smith   or an event number obtained with PetscLogEventRegister().
8035c6c1daeSBarry Smith 
8045c6c1daeSBarry Smith   Level: advanced
8055c6c1daeSBarry Smith 
806c00cb57fSBarry Smith .seealso: PlogEventDeactivate(), PlogEventDeactivatePush(), PetscLogEventDeactivatePop()
8075c6c1daeSBarry Smith @*/
8085c6c1daeSBarry Smith PetscErrorCode  PetscLogEventActivate(PetscLogEvent event)
8095c6c1daeSBarry Smith {
8105c6c1daeSBarry Smith   PetscStageLog  stageLog;
8115c6c1daeSBarry Smith   int            stage;
8125c6c1daeSBarry Smith   PetscErrorCode ierr;
8135c6c1daeSBarry Smith 
8145c6c1daeSBarry Smith   PetscFunctionBegin;
8155c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
8165c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
8173a88037aSBarry Smith   ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
8185c6c1daeSBarry Smith   PetscFunctionReturn(0);
8195c6c1daeSBarry Smith }
8205c6c1daeSBarry Smith 
8215c6c1daeSBarry Smith /*@
8225c6c1daeSBarry Smith   PetscLogEventDeactivate - Indicates that a particular event should not be logged.
8235c6c1daeSBarry Smith 
8245c6c1daeSBarry Smith   Not Collective
8255c6c1daeSBarry Smith 
8265c6c1daeSBarry Smith   Input Parameter:
8275c6c1daeSBarry Smith . event - The event id
8285c6c1daeSBarry Smith 
8295c6c1daeSBarry Smith   Usage:
8305c6c1daeSBarry Smith .vb
8315c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
8325c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
8335c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
8345c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
8355c6c1daeSBarry Smith .ve
8365c6c1daeSBarry Smith 
8375c6c1daeSBarry Smith   Note:
8385c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in
8395c6c1daeSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
8405c6c1daeSBarry Smith 
8415c6c1daeSBarry Smith   Level: advanced
8425c6c1daeSBarry Smith 
843c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePush(), PetscLogEventDeactivatePop()
8445c6c1daeSBarry Smith @*/
8455c6c1daeSBarry Smith PetscErrorCode  PetscLogEventDeactivate(PetscLogEvent event)
8465c6c1daeSBarry Smith {
8475c6c1daeSBarry Smith   PetscStageLog  stageLog;
8485c6c1daeSBarry Smith   int            stage;
8495c6c1daeSBarry Smith   PetscErrorCode ierr;
8505c6c1daeSBarry Smith 
8515c6c1daeSBarry Smith   PetscFunctionBegin;
8525c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
8535c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
8543a88037aSBarry Smith   ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
8555c6c1daeSBarry Smith   PetscFunctionReturn(0);
8565c6c1daeSBarry Smith }
8575c6c1daeSBarry Smith 
8585c6c1daeSBarry Smith /*@
859c00cb57fSBarry Smith   PetscLogEventDeactivatePush - Indicates that a particular event should not be logged.
860c00cb57fSBarry Smith 
861c00cb57fSBarry Smith   Not Collective
862c00cb57fSBarry Smith 
863c00cb57fSBarry Smith   Input Parameter:
864c00cb57fSBarry Smith . event - The event id
865c00cb57fSBarry Smith 
866c00cb57fSBarry Smith   Usage:
867c00cb57fSBarry Smith .vb
868c00cb57fSBarry Smith       PetscLogEventDeactivatePush(VEC_SetValues);
869c00cb57fSBarry Smith         [code where you do not want to log VecSetValues()]
870c00cb57fSBarry Smith       PetscLogEventDeactivatePop(VEC_SetValues);
871c00cb57fSBarry Smith         [code where you do want to log VecSetValues()]
872c00cb57fSBarry Smith .ve
873c00cb57fSBarry Smith 
874c00cb57fSBarry Smith   Note:
875c00cb57fSBarry Smith   The event may be either a pre-defined PETSc event (found in
876c00cb57fSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
877c00cb57fSBarry Smith 
878c00cb57fSBarry Smith   Level: advanced
879c00cb57fSBarry Smith 
880c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePop()
881c00cb57fSBarry Smith @*/
882c00cb57fSBarry Smith PetscErrorCode  PetscLogEventDeactivatePush(PetscLogEvent event)
883c00cb57fSBarry Smith {
884c00cb57fSBarry Smith   PetscStageLog  stageLog;
885c00cb57fSBarry Smith   int            stage;
886c00cb57fSBarry Smith   PetscErrorCode ierr;
887c00cb57fSBarry Smith 
888c00cb57fSBarry Smith   PetscFunctionBegin;
889c00cb57fSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
890c00cb57fSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
891c00cb57fSBarry Smith   ierr = PetscEventPerfLogDeactivatePush(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
892c00cb57fSBarry Smith   PetscFunctionReturn(0);
893c00cb57fSBarry Smith }
894c00cb57fSBarry Smith 
895c00cb57fSBarry Smith /*@
896c00cb57fSBarry Smith   PetscLogEventDeactivatePop - Indicates that a particular event shouldbe logged.
897c00cb57fSBarry Smith 
898c00cb57fSBarry Smith   Not Collective
899c00cb57fSBarry Smith 
900c00cb57fSBarry Smith   Input Parameter:
901c00cb57fSBarry Smith . event - The event id
902c00cb57fSBarry Smith 
903c00cb57fSBarry Smith   Usage:
904c00cb57fSBarry Smith .vb
905c00cb57fSBarry Smith       PetscLogEventDeactivatePush(VEC_SetValues);
906c00cb57fSBarry Smith         [code where you do not want to log VecSetValues()]
907c00cb57fSBarry Smith       PetscLogEventDeactivatePop(VEC_SetValues);
908c00cb57fSBarry Smith         [code where you do want to log VecSetValues()]
909c00cb57fSBarry Smith .ve
910c00cb57fSBarry Smith 
911c00cb57fSBarry Smith   Note:
912c00cb57fSBarry Smith   The event may be either a pre-defined PETSc event (found in
913c00cb57fSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
914c00cb57fSBarry Smith 
915c00cb57fSBarry Smith   Level: advanced
916c00cb57fSBarry Smith 
917c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePush()
918c00cb57fSBarry Smith @*/
919c00cb57fSBarry Smith PetscErrorCode  PetscLogEventDeactivatePop(PetscLogEvent event)
920c00cb57fSBarry Smith {
921c00cb57fSBarry Smith   PetscStageLog  stageLog;
922c00cb57fSBarry Smith   int            stage;
923c00cb57fSBarry Smith   PetscErrorCode ierr;
924c00cb57fSBarry Smith 
925c00cb57fSBarry Smith   PetscFunctionBegin;
926c00cb57fSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
927c00cb57fSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
928c00cb57fSBarry Smith   ierr = PetscEventPerfLogDeactivatePop(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
929c00cb57fSBarry Smith   PetscFunctionReturn(0);
930c00cb57fSBarry Smith }
931c00cb57fSBarry Smith 
932c00cb57fSBarry Smith /*@
9335c6c1daeSBarry Smith   PetscLogEventSetActiveAll - Sets the event activity in every stage.
9345c6c1daeSBarry Smith 
9355c6c1daeSBarry Smith   Not Collective
9365c6c1daeSBarry Smith 
9375c6c1daeSBarry Smith   Input Parameters:
9385c6c1daeSBarry Smith + event    - The event id
9395c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged
9405c6c1daeSBarry Smith 
9415c6c1daeSBarry Smith   Level: advanced
9425c6c1daeSBarry Smith 
943ec303c53SPatrick Sanan .seealso: PlogEventActivate(),PlogEventDeactivate()
9445c6c1daeSBarry Smith @*/
9455c6c1daeSBarry Smith PetscErrorCode  PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive)
9465c6c1daeSBarry Smith {
9475c6c1daeSBarry Smith   PetscStageLog  stageLog;
9485c6c1daeSBarry Smith   int            stage;
9495c6c1daeSBarry Smith   PetscErrorCode ierr;
9505c6c1daeSBarry Smith 
9515c6c1daeSBarry Smith   PetscFunctionBegin;
9525c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
9535c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
9545c6c1daeSBarry Smith     if (isActive) {
9553a88037aSBarry Smith       ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
9565c6c1daeSBarry Smith     } else {
9573a88037aSBarry Smith       ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
9585c6c1daeSBarry Smith     }
9595c6c1daeSBarry Smith   }
9605c6c1daeSBarry Smith   PetscFunctionReturn(0);
9615c6c1daeSBarry Smith }
9625c6c1daeSBarry Smith 
9635c6c1daeSBarry Smith /*@
9645c6c1daeSBarry Smith   PetscLogEventActivateClass - Activates event logging for a PETSc object class.
9655c6c1daeSBarry Smith 
9665c6c1daeSBarry Smith   Not Collective
9675c6c1daeSBarry Smith 
9685c6c1daeSBarry Smith   Input Parameter:
9695c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc.
9705c6c1daeSBarry Smith 
9715c6c1daeSBarry Smith   Level: developer
9725c6c1daeSBarry Smith 
973fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate()
9745c6c1daeSBarry Smith @*/
9755c6c1daeSBarry Smith PetscErrorCode  PetscLogEventActivateClass(PetscClassId classid)
9765c6c1daeSBarry Smith {
9775c6c1daeSBarry Smith   PetscStageLog  stageLog;
9785c6c1daeSBarry Smith   int            stage;
9795c6c1daeSBarry Smith   PetscErrorCode ierr;
9805c6c1daeSBarry Smith 
9815c6c1daeSBarry Smith   PetscFunctionBegin;
9825c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
9835c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
9843a88037aSBarry Smith   ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
9855c6c1daeSBarry Smith   PetscFunctionReturn(0);
9865c6c1daeSBarry Smith }
9875c6c1daeSBarry Smith 
9885c6c1daeSBarry Smith /*@
9895c6c1daeSBarry Smith   PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class.
9905c6c1daeSBarry Smith 
9915c6c1daeSBarry Smith   Not Collective
9925c6c1daeSBarry Smith 
9935c6c1daeSBarry Smith   Input Parameter:
9945c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc.
9955c6c1daeSBarry Smith 
9965c6c1daeSBarry Smith   Level: developer
9975c6c1daeSBarry Smith 
998fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate()
9995c6c1daeSBarry Smith @*/
10005c6c1daeSBarry Smith PetscErrorCode  PetscLogEventDeactivateClass(PetscClassId classid)
10015c6c1daeSBarry Smith {
10025c6c1daeSBarry Smith   PetscStageLog  stageLog;
10035c6c1daeSBarry Smith   int            stage;
10045c6c1daeSBarry Smith   PetscErrorCode ierr;
10055c6c1daeSBarry Smith 
10065c6c1daeSBarry Smith   PetscFunctionBegin;
10075c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
10085c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
10093a88037aSBarry Smith   ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
10105c6c1daeSBarry Smith   PetscFunctionReturn(0);
10115c6c1daeSBarry Smith }
10125c6c1daeSBarry Smith 
10135c6c1daeSBarry Smith /*MC
101462872c28SLisandro Dalcin    PetscLogEventSync - Synchronizes the beginning of a user event.
101562872c28SLisandro Dalcin 
101662872c28SLisandro Dalcin    Synopsis:
101762872c28SLisandro Dalcin    #include <petsclog.h>
101862872c28SLisandro Dalcin    PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm)
101962872c28SLisandro Dalcin 
102062872c28SLisandro Dalcin    Collective
102162872c28SLisandro Dalcin 
102262872c28SLisandro Dalcin    Input Parameters:
102362872c28SLisandro Dalcin +  e - integer associated with the event obtained from PetscLogEventRegister()
102462872c28SLisandro Dalcin -  comm - an MPI communicator
102562872c28SLisandro Dalcin 
102662872c28SLisandro Dalcin    Usage:
102762872c28SLisandro Dalcin .vb
102862872c28SLisandro Dalcin      PetscLogEvent USER_EVENT;
102962872c28SLisandro Dalcin      PetscLogEventRegister("User event",0,&USER_EVENT);
103062872c28SLisandro Dalcin      PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD);
103162872c28SLisandro Dalcin      PetscLogEventBegin(USER_EVENT,0,0,0,0);
103262872c28SLisandro Dalcin         [code segment to monitor]
103362872c28SLisandro Dalcin      PetscLogEventEnd(USER_EVENT,0,0,0,0);
103462872c28SLisandro Dalcin .ve
103562872c28SLisandro Dalcin 
103662872c28SLisandro Dalcin    Notes:
103762872c28SLisandro Dalcin    This routine should be called only if there is not a
103862872c28SLisandro Dalcin    PetscObject available to pass to PetscLogEventBegin().
103962872c28SLisandro Dalcin 
104062872c28SLisandro Dalcin    Level: developer
104162872c28SLisandro Dalcin 
104262872c28SLisandro Dalcin .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd()
104362872c28SLisandro Dalcin 
104462872c28SLisandro Dalcin M*/
104562872c28SLisandro Dalcin 
104662872c28SLisandro Dalcin /*MC
10475c6c1daeSBarry Smith    PetscLogEventBegin - Logs the beginning of a user event.
10485c6c1daeSBarry Smith 
10495c6c1daeSBarry Smith    Synopsis:
1050aaa7dc30SBarry Smith    #include <petsclog.h>
1051f2ba6396SBarry Smith    PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
10525c6c1daeSBarry Smith 
10535c6c1daeSBarry Smith    Not Collective
10545c6c1daeSBarry Smith 
10555c6c1daeSBarry Smith    Input Parameters:
10565c6c1daeSBarry Smith +  e - integer associated with the event obtained from PetscLogEventRegister()
10575c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
10585c6c1daeSBarry Smith 
10595c6c1daeSBarry Smith    Fortran Synopsis:
10605c6c1daeSBarry Smith    void PetscLogEventBegin(int e,PetscErrorCode ierr)
10615c6c1daeSBarry Smith 
10625c6c1daeSBarry Smith    Usage:
10635c6c1daeSBarry Smith .vb
10645c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
10655c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
10665c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
10675c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
10685c6c1daeSBarry Smith         [code segment to monitor]
10695c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
10705c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
10715c6c1daeSBarry Smith .ve
10725c6c1daeSBarry Smith 
10735c6c1daeSBarry Smith    Notes:
10745c6c1daeSBarry Smith    You need to register each integer event with the command
1075a2553e36SBarry Smith    PetscLogEventRegister().
10765c6c1daeSBarry Smith 
10775c6c1daeSBarry Smith    Level: intermediate
10785c6c1daeSBarry Smith 
10795c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops()
10805c6c1daeSBarry Smith 
10815c6c1daeSBarry Smith M*/
10825c6c1daeSBarry Smith 
10835c6c1daeSBarry Smith /*MC
10845c6c1daeSBarry Smith    PetscLogEventEnd - Log the end of a user event.
10855c6c1daeSBarry Smith 
10865c6c1daeSBarry Smith    Synopsis:
1087aaa7dc30SBarry Smith    #include <petsclog.h>
1088f2ba6396SBarry Smith    PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
10895c6c1daeSBarry Smith 
10905c6c1daeSBarry Smith    Not Collective
10915c6c1daeSBarry Smith 
10925c6c1daeSBarry Smith    Input Parameters:
10935c6c1daeSBarry Smith +  e - integer associated with the event obtained with PetscLogEventRegister()
10945c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
10955c6c1daeSBarry Smith 
10965c6c1daeSBarry Smith    Fortran Synopsis:
10975c6c1daeSBarry Smith    void PetscLogEventEnd(int e,PetscErrorCode ierr)
10985c6c1daeSBarry Smith 
10995c6c1daeSBarry Smith    Usage:
11005c6c1daeSBarry Smith .vb
11015c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
11025c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
11035c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT,);
11045c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
11055c6c1daeSBarry Smith         [code segment to monitor]
11065c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
11075c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
11085c6c1daeSBarry Smith .ve
11095c6c1daeSBarry Smith 
11105c6c1daeSBarry Smith    Notes:
11115c6c1daeSBarry Smith    You should also register each additional integer event with the command
1112a2553e36SBarry Smith    PetscLogEventRegister().
11135c6c1daeSBarry Smith 
11145c6c1daeSBarry Smith    Level: intermediate
11155c6c1daeSBarry Smith 
11165c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogFlops()
11175c6c1daeSBarry Smith 
11185c6c1daeSBarry Smith M*/
11195c6c1daeSBarry Smith 
11205c6c1daeSBarry Smith /*@C
11215c6c1daeSBarry Smith   PetscLogEventGetId - Returns the event id when given the event name.
11225c6c1daeSBarry Smith 
11235c6c1daeSBarry Smith   Not Collective
11245c6c1daeSBarry Smith 
11255c6c1daeSBarry Smith   Input Parameter:
11265c6c1daeSBarry Smith . name  - The event name
11275c6c1daeSBarry Smith 
11285c6c1daeSBarry Smith   Output Parameter:
1129c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists
11305c6c1daeSBarry Smith 
11315c6c1daeSBarry Smith   Level: intermediate
11325c6c1daeSBarry Smith 
11335c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStageGetId()
11345c6c1daeSBarry Smith @*/
11355c6c1daeSBarry Smith PetscErrorCode  PetscLogEventGetId(const char name[], PetscLogEvent *event)
11365c6c1daeSBarry Smith {
11375c6c1daeSBarry Smith   PetscStageLog  stageLog;
11385c6c1daeSBarry Smith   PetscErrorCode ierr;
11395c6c1daeSBarry Smith 
11405c6c1daeSBarry Smith   PetscFunctionBegin;
11415c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
11423a88037aSBarry Smith   ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr);
11435c6c1daeSBarry Smith   PetscFunctionReturn(0);
11445c6c1daeSBarry Smith }
11455c6c1daeSBarry Smith 
11465c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/
11475c6c1daeSBarry Smith /*@C
11485c6c1daeSBarry Smith   PetscLogDump - Dumps logs of objects to a file. This file is intended to
11495c6c1daeSBarry Smith   be read by bin/petscview. This program no longer exists.
11505c6c1daeSBarry Smith 
11515c6c1daeSBarry Smith   Collective on PETSC_COMM_WORLD
11525c6c1daeSBarry Smith 
11535c6c1daeSBarry Smith   Input Parameter:
11545c6c1daeSBarry Smith . name - an optional file name
11555c6c1daeSBarry Smith 
11565c6c1daeSBarry Smith   Usage:
11575c6c1daeSBarry Smith .vb
11585c6c1daeSBarry Smith      PetscInitialize(...);
1159bb1d7374SBarry Smith      PetscLogDefaultBegin(); or PetscLogAllBegin();
11605c6c1daeSBarry Smith      ... code ...
11615c6c1daeSBarry Smith      PetscLogDump(filename);
11625c6c1daeSBarry Smith      PetscFinalize();
11635c6c1daeSBarry Smith .ve
11645c6c1daeSBarry Smith 
11655c6c1daeSBarry Smith   Notes:
11665c6c1daeSBarry Smith   The default file name is
11675c6c1daeSBarry Smith $    Log.<rank>
11685c6c1daeSBarry Smith   where <rank> is the processor number. If no name is specified,
11695c6c1daeSBarry Smith   this file will be used.
11705c6c1daeSBarry Smith 
11715c6c1daeSBarry Smith   Level: advanced
11725c6c1daeSBarry Smith 
1173bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogView()
11745c6c1daeSBarry Smith @*/
11755c6c1daeSBarry Smith PetscErrorCode  PetscLogDump(const char sname[])
11765c6c1daeSBarry Smith {
11775c6c1daeSBarry Smith   PetscStageLog      stageLog;
11785c6c1daeSBarry Smith   PetscEventPerfInfo *eventInfo;
11795c6c1daeSBarry Smith   FILE               *fd;
11805c6c1daeSBarry Smith   char               file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN];
11815c6c1daeSBarry Smith   PetscLogDouble     flops, _TotalTime;
11825c6c1daeSBarry Smith   PetscMPIInt        rank;
11835c6c1daeSBarry Smith   int                action, object, curStage;
11845c6c1daeSBarry Smith   PetscLogEvent      event;
11855c6c1daeSBarry Smith   PetscErrorCode     ierr;
11865c6c1daeSBarry Smith 
11875c6c1daeSBarry Smith   PetscFunctionBegin;
11885c6c1daeSBarry Smith   /* Calculate the total elapsed time */
11898563dfccSBarry Smith   PetscTime(&_TotalTime);
11905c6c1daeSBarry Smith   _TotalTime -= petsc_BaseTime;
11915c6c1daeSBarry Smith   /* Open log file */
1192ffc4695bSBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank);CHKERRMPI(ierr);
11937ff663adSLisandro Dalcin   if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank);
1194a297a907SKarl Rupp   else sprintf(file, "Log.%d", rank);
11955c6c1daeSBarry Smith   ierr = PetscFixFilename(file, fname);CHKERRQ(ierr);
11965c6c1daeSBarry Smith   ierr = PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd);CHKERRQ(ierr);
11975c6c1daeSBarry Smith   if ((!rank) && (!fd)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname);
11985c6c1daeSBarry Smith   /* Output totals */
1199d4aa7d5fSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime);CHKERRQ(ierr);
1200a2ea699eSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0);CHKERRQ(ierr);
12015c6c1daeSBarry Smith   /* Output actions */
12025c6c1daeSBarry Smith   if (petsc_logActions) {
1203a2ea699eSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions);CHKERRQ(ierr);
12045c6c1daeSBarry Smith     for (action = 0; action < petsc_numActions; action++) {
12055c6c1daeSBarry Smith       ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n",
12065c6c1daeSBarry Smith                           petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1,
1207a2ea699eSBarry Smith                           petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem);CHKERRQ(ierr);
12085c6c1daeSBarry Smith     }
12095c6c1daeSBarry Smith   }
12105c6c1daeSBarry Smith   /* Output objects */
12115c6c1daeSBarry Smith   if (petsc_logObjects) {
1212a2ea699eSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed);CHKERRQ(ierr);
12135c6c1daeSBarry Smith     for (object = 0; object < petsc_numObjects; object++) {
1214a2ea699eSBarry Smith       ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int) petsc_objects[object].mem);CHKERRQ(ierr);
12155c6c1daeSBarry Smith       if (!petsc_objects[object].name[0]) {
1216a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd,"No Name\n");CHKERRQ(ierr);
12175c6c1daeSBarry Smith       } else {
1218a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name);CHKERRQ(ierr);
12195c6c1daeSBarry Smith       }
12205c6c1daeSBarry Smith       if (petsc_objects[object].info[0] != 0) {
1221a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n");CHKERRQ(ierr);
12225c6c1daeSBarry Smith       } else {
1223a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info);CHKERRQ(ierr);
12245c6c1daeSBarry Smith       }
12255c6c1daeSBarry Smith     }
12265c6c1daeSBarry Smith   }
12275c6c1daeSBarry Smith   /* Output events */
1228a2ea699eSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n");CHKERRQ(ierr);
12295c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
12305c6c1daeSBarry Smith   ierr = PetscIntStackTop(stageLog->stack, &curStage);CHKERRQ(ierr);
12315c6c1daeSBarry Smith   eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo;
12325c6c1daeSBarry Smith   for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) {
1233a297a907SKarl Rupp     if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops/eventInfo[event].time;
1234a297a907SKarl Rupp     else flops = 0.0;
12355c6c1daeSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count,
1236a2ea699eSBarry Smith                         eventInfo[event].flops, eventInfo[event].time, flops);CHKERRQ(ierr);
12375c6c1daeSBarry Smith   }
12385c6c1daeSBarry Smith   ierr = PetscFClose(PETSC_COMM_WORLD, fd);CHKERRQ(ierr);
12395c6c1daeSBarry Smith   PetscFunctionReturn(0);
12405c6c1daeSBarry Smith }
12415c6c1daeSBarry Smith 
1242f14045dbSBarry Smith /*
1243f14045dbSBarry Smith   PetscLogView_Detailed - Each process prints the times for its own events
1244f14045dbSBarry Smith 
1245f14045dbSBarry Smith */
1246f14045dbSBarry Smith PetscErrorCode  PetscLogView_Detailed(PetscViewer viewer)
1247f14045dbSBarry Smith {
12482dff6485SMatthew G. Knepley   PetscStageLog      stageLog;
1249217044c2SLisandro Dalcin   PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL;
1250217044c2SLisandro Dalcin   PetscLogDouble     locTotalTime, numRed, maxMem;
12512dff6485SMatthew G. Knepley   int                numStages,numEvents,stage,event;
1252217044c2SLisandro Dalcin   MPI_Comm           comm = PetscObjectComm((PetscObject) viewer);
12532dff6485SMatthew G. Knepley   PetscMPIInt        rank,size;
12542dff6485SMatthew G. Knepley   PetscErrorCode     ierr;
1255f14045dbSBarry Smith 
1256f14045dbSBarry Smith   PetscFunctionBegin;
1257ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
1258ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
12592dff6485SMatthew G. Knepley   /* Must preserve reduction count before we go on */
12602dff6485SMatthew G. Knepley   numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
12612d1ec343SBarry Smith   /* Get the total elapsed time */
12622d1ec343SBarry Smith   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
12639852e123SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"size = %d\n",size);CHKERRQ(ierr);
12642d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"LocalTimes = {}\n");CHKERRQ(ierr);
12652d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"LocalMessages = {}\n");CHKERRQ(ierr);
1266217044c2SLisandro Dalcin   ierr = PetscViewerASCIIPrintf(viewer,"LocalMessageLens = {}\n");CHKERRQ(ierr);
12672d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"LocalReductions = {}\n");CHKERRQ(ierr);
1268217044c2SLisandro Dalcin   ierr = PetscViewerASCIIPrintf(viewer,"LocalFlop = {}\n");CHKERRQ(ierr);
12692dff6485SMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer,"LocalObjects = {}\n");CHKERRQ(ierr);
12702dff6485SMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer,"LocalMemory = {}\n");CHKERRQ(ierr);
12712d1ec343SBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
1272820f2d46SBarry Smith   ierr = MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr);
12732d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"Stages = {}\n");CHKERRQ(ierr);
12742d1ec343SBarry Smith   for (stage=0; stage<numStages; stage++) {
12752d1ec343SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr);
127661917356SPatrick Sanan     ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"summary\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr);
1277820f2d46SBarry Smith     ierr = MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr);
12782d1ec343SBarry Smith     for (event = 0; event < numEvents; event++) {
12792d1ec343SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"%s\"] = {}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name);CHKERRQ(ierr);
12802d1ec343SBarry Smith     }
12812d1ec343SBarry Smith   }
1282217044c2SLisandro Dalcin   ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr);
12831575c14dSBarry Smith   ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
12842d1ec343SBarry Smith   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalTimes[%d] = %g\n",rank,locTotalTime);CHKERRQ(ierr);
12852d1ec343SBarry Smith   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessages[%d] = %g\n",rank,(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct));CHKERRQ(ierr);
1286217044c2SLisandro Dalcin   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessageLens[%d] = %g\n",rank,(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len));CHKERRQ(ierr);
12872dff6485SMatthew G. Knepley   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalReductions[%d] = %g\n",rank,numRed);CHKERRQ(ierr);
1288217044c2SLisandro Dalcin   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalFlop[%d] = %g\n",rank,petsc_TotalFlops);CHKERRQ(ierr);
1289ba67d37fSBarry Smith   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalObjects[%d] = %d\n",rank,petsc_numObjects);CHKERRQ(ierr);
12902dff6485SMatthew G. Knepley   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMemory[%d] = %g\n",rank,maxMem);CHKERRQ(ierr);
12912d1ec343SBarry Smith   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
12922d1ec343SBarry Smith   for (stage=0; stage<numStages; stage++) {
1293217044c2SLisandro Dalcin     stageInfo = &stageLog->stageInfo[stage].perfInfo;
1294d4aa7d5fSBarry Smith     ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n",
12952dff6485SMatthew G. Knepley                                               stageLog->stageInfo[stage].name,rank,
1296217044c2SLisandro Dalcin                                               stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr);
1297820f2d46SBarry Smith     ierr = MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr);
12982d1ec343SBarry Smith     for (event = 0; event < numEvents; event++) {
1299217044c2SLisandro Dalcin       eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event];
1300c15bc2c4SMatthew G. Knepley       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %D, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g",
1301217044c2SLisandro Dalcin                                                 stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name,rank,
1302217044c2SLisandro Dalcin                                                 eventInfo->count,eventInfo->time,eventInfo->syncTime,eventInfo->numMessages,eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr);
1303891e75beSMatthew G. Knepley       if (eventInfo->dof[0] >= 0.) {
1304891e75beSMatthew G. Knepley         PetscInt d, e;
13055d68e14cSMatthew G. Knepley 
1306891e75beSMatthew G. Knepley         ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : [");CHKERRQ(ierr);
1307891e75beSMatthew G. Knepley         for (d = 0; d < 8; ++d) {
1308891e75beSMatthew G. Knepley           if (d > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);}
1309891e75beSMatthew G. Knepley           ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d]);CHKERRQ(ierr);
1310891e75beSMatthew G. Knepley         }
1311891e75beSMatthew G. Knepley         ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr);
13125d68e14cSMatthew G. Knepley         ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : [");CHKERRQ(ierr);
13135d68e14cSMatthew G. Knepley         for (e = 0; e < 8; ++e) {
13145d68e14cSMatthew G. Knepley           if (e > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);}
1315c15bc2c4SMatthew G. Knepley           ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e]);CHKERRQ(ierr);
13165d68e14cSMatthew G. Knepley         }
13175d68e14cSMatthew G. Knepley         ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr);
13185d68e14cSMatthew G. Knepley       }
13195d68e14cSMatthew G. Knepley       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"}\n");CHKERRQ(ierr);
13202d1ec343SBarry Smith     }
13212d1ec343SBarry Smith   }
13222d1ec343SBarry Smith   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
13231575c14dSBarry Smith   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
1324f14045dbSBarry Smith   PetscFunctionReturn(0);
1325f14045dbSBarry Smith }
1326f14045dbSBarry Smith 
132738144912Sdeepblu2718 /*
132838144912Sdeepblu2718   PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format
132938144912Sdeepblu2718 */
133038144912Sdeepblu2718 PetscErrorCode  PetscLogView_CSV(PetscViewer viewer)
133138144912Sdeepblu2718 {
133238144912Sdeepblu2718   PetscStageLog      stageLog;
1333669c5be0SSatish Balay   PetscEventPerfInfo *eventInfo = NULL;
133438144912Sdeepblu2718   PetscLogDouble     locTotalTime, maxMem;
133538144912Sdeepblu2718   int                numStages,numEvents,stage,event;
133638144912Sdeepblu2718   MPI_Comm           comm = PetscObjectComm((PetscObject) viewer);
133738144912Sdeepblu2718   PetscMPIInt        rank,size;
133838144912Sdeepblu2718   PetscErrorCode     ierr;
133938144912Sdeepblu2718 
134038144912Sdeepblu2718   PetscFunctionBegin;
1341ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
1342ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
134338144912Sdeepblu2718   /* Must preserve reduction count before we go on */
134438144912Sdeepblu2718   /* Get the total elapsed time */
134538144912Sdeepblu2718   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
134638144912Sdeepblu2718   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
1347820f2d46SBarry Smith   ierr = MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr);
134838144912Sdeepblu2718   ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr);
134938144912Sdeepblu2718   ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
1350*a2fddd78SAlbert 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);
135138144912Sdeepblu2718   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
135238144912Sdeepblu2718   for (stage=0; stage<numStages; stage++) {
13539e29573dSMatthew G. Knepley     PetscEventPerfInfo *stageInfo = &stageLog->stageInfo[stage].perfInfo;
13549e29573dSMatthew G. Knepley 
1355*a2fddd78SAlbert Cowie     ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,summary,%d,1,%g,%g,%g,%g,%g\n",
13569e29573dSMatthew G. Knepley                                               stageLog->stageInfo[stage].name,rank,stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr);
1357820f2d46SBarry Smith     ierr = MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr);
135838144912Sdeepblu2718     for (event = 0; event < numEvents; event++) {
135938144912Sdeepblu2718       eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event];
1360*a2fddd78SAlbert Cowie       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,%s,%d,%D,%g,%g,%g,%g,%g",stageLog->stageInfo[stage].name,
1361*a2fddd78SAlbert Cowie                                                 stageLog->eventLog->eventInfo[event].name,rank,eventInfo->count,eventInfo->time,eventInfo->numMessages,
136238144912Sdeepblu2718                                                 eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr);
136338144912Sdeepblu2718       if (eventInfo->dof[0] >= 0.) {
136438144912Sdeepblu2718         PetscInt d, e;
136538144912Sdeepblu2718 
136638144912Sdeepblu2718         for (d = 0; d < 8; ++d) {
136738144912Sdeepblu2718           ierr = PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d]);CHKERRQ(ierr);
136838144912Sdeepblu2718         }
136938144912Sdeepblu2718         for (e = 0; e < 8; ++e) {
137038144912Sdeepblu2718           ierr = PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e]);CHKERRQ(ierr);
137138144912Sdeepblu2718         }
137238144912Sdeepblu2718       }
137338144912Sdeepblu2718       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"\n");CHKERRQ(ierr);
137438144912Sdeepblu2718     }
137538144912Sdeepblu2718   }
137638144912Sdeepblu2718   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
137738144912Sdeepblu2718   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
137838144912Sdeepblu2718   PetscFunctionReturn(0);
137938144912Sdeepblu2718 }
138038144912Sdeepblu2718 
1381217044c2SLisandro Dalcin static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm,FILE *fd)
1382217044c2SLisandro Dalcin {
1383217044c2SLisandro Dalcin   PetscErrorCode ierr;
1384217044c2SLisandro Dalcin   PetscFunctionBegin;
1385217044c2SLisandro Dalcin   if (!PetscLogSyncOn) PetscFunctionReturn(0);
1386217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr);
1387217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n");CHKERRQ(ierr);
1388217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1389217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n");CHKERRQ(ierr);
1390217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1391217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #   This program was run with logging synchronization.   #\n");CHKERRQ(ierr);
1392217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #   This option provides more meaningful imbalance       #\n");CHKERRQ(ierr);
1393217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #   figures at the expense of slowing things down and    #\n");CHKERRQ(ierr);
1394217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #   providing a distorted view of the overall runtime.   #\n");CHKERRQ(ierr);
1395217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1396217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n\n\n");CHKERRQ(ierr);
1397217044c2SLisandro Dalcin   PetscFunctionReturn(0);
1398217044c2SLisandro Dalcin }
1399217044c2SLisandro Dalcin 
1400f4091ad2SBarry Smith static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm,FILE *fd)
1401f4091ad2SBarry Smith {
1402f4091ad2SBarry Smith   PetscErrorCode ierr;
1403f4091ad2SBarry Smith 
1404f4091ad2SBarry Smith   PetscFunctionBegin;
140576bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1406f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr);
1407f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      ##########################################################\n");CHKERRQ(ierr);
1408f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1409f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n");CHKERRQ(ierr);
1410f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1411217044c2SLisandro Dalcin     ierr = PetscFPrintf(comm, fd, "      #   This code was compiled with a debugging option.      #\n");CHKERRQ(ierr);
1412f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      #   To get timing results run ./configure                #\n");CHKERRQ(ierr);
1413f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      #   using --with-debugging=no, the performance will      #\n");CHKERRQ(ierr);
1414f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      #   be generally two or three times faster.              #\n");CHKERRQ(ierr);
1415f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1416f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      ##########################################################\n\n\n");CHKERRQ(ierr);
141776bd3646SJed Brown   }
1418f4091ad2SBarry Smith   PetscFunctionReturn(0);
1419f4091ad2SBarry Smith }
1420f4091ad2SBarry Smith 
1421c2a741eeSJunchao Zhang static PetscErrorCode PetscLogViewWarnNoGpuAwareMpi(MPI_Comm comm,FILE *fd)
1422c2a741eeSJunchao Zhang {
142359af0bd3SScott Kruger #if defined(PETSC_HAVE_CUDA) || defined(PETSC_HAVE_HIP)
1424c2a741eeSJunchao Zhang   PetscErrorCode ierr;
1425c2a741eeSJunchao Zhang 
1426c2a741eeSJunchao Zhang   PetscFunctionBegin;
1427928a6601SJunchao Zhang   if (use_gpu_aware_mpi || !PetscCreatedGpuObjects) PetscFunctionReturn(0);
1428c2a741eeSJunchao Zhang   ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr);
1429c2a741eeSJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n");CHKERRQ(ierr);
1430c2a741eeSJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1431c2a741eeSJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n");CHKERRQ(ierr);
1432c2a741eeSJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1433928a6601SJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      # This code was compiled with GPU support and you've     #\n");CHKERRQ(ierr);
1434928a6601SJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      # created PETSc/GPU objects, but you intentionally used  #\n");CHKERRQ(ierr);
1435928a6601SJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      # -use_gpu_aware_mpi 0, such that PETSc had to copy data #\n");CHKERRQ(ierr);
1436928a6601SJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      # from GPU to CPU for communication. To get meaningfull  #\n");CHKERRQ(ierr);
1437928a6601SJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      # timing results, please use GPU-aware MPI instead.      #\n");CHKERRQ(ierr);
1438c2a741eeSJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n\n\n");CHKERRQ(ierr);
1439c2a741eeSJunchao Zhang   PetscFunctionReturn(0);
1440c2a741eeSJunchao Zhang #else
1441c2a741eeSJunchao Zhang   return 0;
1442c2a741eeSJunchao Zhang #endif
1443c2a741eeSJunchao Zhang }
1444c2a741eeSJunchao Zhang 
1445f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP)
1446f90b075cSBarry Smith extern PetscInt PetscNumOMPThreads;
1447f90b075cSBarry Smith #endif
1448f90b075cSBarry Smith 
1449f14045dbSBarry Smith PetscErrorCode  PetscLogView_Default(PetscViewer viewer)
14505c6c1daeSBarry Smith {
14515c6c1daeSBarry Smith   FILE               *fd;
14525c6c1daeSBarry Smith   PetscLogDouble     zero       = 0.0;
14535c6c1daeSBarry Smith   PetscStageLog      stageLog;
14540298fd71SBarry Smith   PetscStageInfo     *stageInfo = NULL;
14550298fd71SBarry Smith   PetscEventPerfInfo *eventInfo = NULL;
14565c6c1daeSBarry Smith   PetscClassPerfInfo *classInfo;
14575c6c1daeSBarry Smith   char               arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128];
14585c6c1daeSBarry Smith   const char         *name;
14595c6c1daeSBarry Smith   PetscLogDouble     locTotalTime, TotalTime, TotalFlops;
14605c6c1daeSBarry Smith   PetscLogDouble     numMessages, messageLength, avgMessLen, numReductions;
14615c6c1daeSBarry Smith   PetscLogDouble     stageTime, flops, flopr, mem, mess, messLen, red;
14625c6c1daeSBarry Smith   PetscLogDouble     fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed;
14635c6c1daeSBarry Smith   PetscLogDouble     fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed;
14645c6c1daeSBarry Smith   PetscLogDouble     min, max, tot, ratio, avg, x, y;
1465e3ed9ee7SBarry Smith   PetscLogDouble     minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr, mal, malmax, emalmax;
1466d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1467958c4211Shannah_mairs   PetscLogDouble     cct, gct, csz, gsz, gmaxt, gflops, gflopr, fracgflops;
1468bec0b493Shannah_mairs   #endif
1469217044c2SLisandro Dalcin   PetscMPIInt        minC, maxC;
14705c6c1daeSBarry Smith   PetscMPIInt        size, rank;
14715c6c1daeSBarry Smith   PetscBool          *localStageUsed,    *stageUsed;
14725c6c1daeSBarry Smith   PetscBool          *localStageVisible, *stageVisible;
14735c6c1daeSBarry Smith   int                numStages, localNumEvents, numEvents;
147437b78d16SBarry Smith   int                stage, oclass;
14755c6c1daeSBarry Smith   PetscLogEvent      event;
14765c6c1daeSBarry Smith   PetscErrorCode     ierr;
14775c6c1daeSBarry Smith   char               version[256];
14785c6c1daeSBarry Smith   MPI_Comm           comm;
14795c6c1daeSBarry Smith 
14805c6c1daeSBarry Smith   PetscFunctionBegin;
14815c6c1daeSBarry Smith   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
14825c6c1daeSBarry Smith   ierr = PetscViewerASCIIGetPointer(viewer,&fd);CHKERRQ(ierr);
1483ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
1484ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
14855c6c1daeSBarry Smith   /* Get the total elapsed time */
14868563dfccSBarry Smith   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
14875c6c1daeSBarry Smith 
14885c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr);
14895c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "***             WIDEN YOUR WINDOW TO 120 CHARACTERS.  Use 'enscript -r -fCourier9' to print this document            ***\n");CHKERRQ(ierr);
14905c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr);
14915c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n---------------------------------------------- PETSc Performance Summary: ----------------------------------------------\n\n");CHKERRQ(ierr);
1492217044c2SLisandro Dalcin   ierr = PetscLogViewWarnSync(comm,fd);CHKERRQ(ierr);
1493f4091ad2SBarry Smith   ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr);
1494c2a741eeSJunchao Zhang   ierr = PetscLogViewWarnNoGpuAwareMpi(comm,fd);CHKERRQ(ierr);
14955c6c1daeSBarry Smith   ierr = PetscGetArchType(arch,sizeof(arch));CHKERRQ(ierr);
14965c6c1daeSBarry Smith   ierr = PetscGetHostName(hostname,sizeof(hostname));CHKERRQ(ierr);
14975c6c1daeSBarry Smith   ierr = PetscGetUserName(username,sizeof(username));CHKERRQ(ierr);
14985c6c1daeSBarry Smith   ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr);
14995c6c1daeSBarry Smith   ierr = PetscGetDate(date,sizeof(date));CHKERRQ(ierr);
15005c6c1daeSBarry Smith   ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
15015c6c1daeSBarry Smith   if (size == 1) {
15025c6c1daeSBarry Smith     ierr = PetscFPrintf(comm,fd,"%s on a %s named %s with %d processor, by %s %s\n", pname, arch, hostname, size, username, date);CHKERRQ(ierr);
15035c6c1daeSBarry Smith   } else {
15045c6c1daeSBarry Smith     ierr = PetscFPrintf(comm,fd,"%s on a %s named %s with %d processors, by %s %s\n", pname, arch, hostname, size, username, date);CHKERRQ(ierr);
15055c6c1daeSBarry Smith   }
1506f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP)
1507f90b075cSBarry Smith   ierr = PetscFPrintf(comm,fd,"Using %D OpenMP threads\n", PetscNumOMPThreads);CHKERRQ(ierr);
1508f90b075cSBarry Smith #endif
15095c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Using %s\n", version);CHKERRQ(ierr);
15105c6c1daeSBarry Smith 
15115c6c1daeSBarry Smith   /* Must preserve reduction count before we go on */
15125c6c1daeSBarry Smith   red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
15135c6c1daeSBarry Smith 
15145c6c1daeSBarry Smith   /* Calculate summary information */
15155c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n                         Max       Max/Min     Avg       Total\n");CHKERRQ(ierr);
15165c6c1daeSBarry Smith   /*   Time */
1517820f2d46SBarry Smith   ierr = MPI_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
1518820f2d46SBarry Smith   ierr = MPI_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1519820f2d46SBarry Smith   ierr = MPI_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1520217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1521217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1522217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Time (sec):           %5.3e   %7.3f   %5.3e\n", max, ratio, avg);CHKERRQ(ierr);
15235c6c1daeSBarry Smith   TotalTime = tot;
15245c6c1daeSBarry Smith   /*   Objects */
15255c6c1daeSBarry Smith   avg  = (PetscLogDouble) petsc_numObjects;
1526820f2d46SBarry Smith   ierr = MPI_Allreduce(&avg,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
1527820f2d46SBarry Smith   ierr = MPI_Allreduce(&avg,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1528820f2d46SBarry Smith   ierr = MPI_Allreduce(&avg,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1529217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1530217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1531217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Objects:              %5.3e   %7.3f   %5.3e\n", max, ratio, avg);CHKERRQ(ierr);
15325c6c1daeSBarry Smith   /*   Flops */
1533820f2d46SBarry Smith   ierr = MPI_Allreduce(&petsc_TotalFlops,  &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
1534820f2d46SBarry Smith   ierr = MPI_Allreduce(&petsc_TotalFlops,  &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1535820f2d46SBarry Smith   ierr = MPI_Allreduce(&petsc_TotalFlops,  &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1536217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1537217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1538217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Flop:                 %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
15395c6c1daeSBarry Smith   TotalFlops = tot;
15405c6c1daeSBarry Smith   /*   Flops/sec -- Must talk to Barry here */
1541217044c2SLisandro Dalcin   if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime; else flops = 0.0;
1542820f2d46SBarry Smith   ierr = MPI_Allreduce(&flops,        &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
1543820f2d46SBarry Smith   ierr = MPI_Allreduce(&flops,        &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1544820f2d46SBarry Smith   ierr = MPI_Allreduce(&flops,        &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1545217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1546217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1547217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Flop/sec:             %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
15485c6c1daeSBarry Smith   /*   Memory */
15495c6c1daeSBarry Smith   ierr = PetscMallocGetMaximumUsage(&mem);CHKERRQ(ierr);
15505c6c1daeSBarry Smith   if (mem > 0.0) {
1551820f2d46SBarry Smith     ierr = MPI_Allreduce(&mem,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
1552820f2d46SBarry Smith     ierr = MPI_Allreduce(&mem,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1553820f2d46SBarry Smith     ierr = MPI_Allreduce(&mem,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1554217044c2SLisandro Dalcin     avg  = tot/((PetscLogDouble) size);
1555217044c2SLisandro Dalcin     if (min != 0.0) ratio = max/min; else ratio = 0.0;
1556217044c2SLisandro Dalcin     ierr = PetscFPrintf(comm, fd, "Memory:               %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
15575c6c1daeSBarry Smith   }
15585c6c1daeSBarry Smith   /*   Messages */
15595c6c1daeSBarry Smith   mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct);
1560820f2d46SBarry Smith   ierr = MPI_Allreduce(&mess,         &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
1561820f2d46SBarry Smith   ierr = MPI_Allreduce(&mess,         &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1562820f2d46SBarry Smith   ierr = MPI_Allreduce(&mess,         &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1563217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1564217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1565217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "MPI Messages:         %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
15665c6c1daeSBarry Smith   numMessages = tot;
15675c6c1daeSBarry Smith   /*   Message Lengths */
15685c6c1daeSBarry Smith   mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len);
1569820f2d46SBarry Smith   ierr = MPI_Allreduce(&mess,         &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
1570820f2d46SBarry Smith   ierr = MPI_Allreduce(&mess,         &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1571820f2d46SBarry Smith   ierr = MPI_Allreduce(&mess,         &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1572217044c2SLisandro Dalcin   if (numMessages != 0) avg = tot/numMessages; else avg = 0.0;
1573217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1574217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "MPI Message Lengths:  %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
15755c6c1daeSBarry Smith   messageLength = tot;
15765c6c1daeSBarry Smith   /*   Reductions */
1577820f2d46SBarry Smith   ierr = MPI_Allreduce(&red,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
1578820f2d46SBarry Smith   ierr = MPI_Allreduce(&red,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1579820f2d46SBarry Smith   ierr = MPI_Allreduce(&red,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1580217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1581217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "MPI Reductions:       %5.3e   %7.3f\n", max, ratio);CHKERRQ(ierr);
15825c6c1daeSBarry Smith   numReductions = red; /* wrong because uses count from process zero */
15835c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n");CHKERRQ(ierr);
1584d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "                            e.g., VecAXPY() for real vectors of length N --> 2N flop\n");CHKERRQ(ierr);
1585d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "                            and VecAXPY() for complex vectors of length N --> 8N flop\n");CHKERRQ(ierr);
15865c6c1daeSBarry Smith 
15875c6c1daeSBarry Smith   /* Get total number of stages --
15885c6c1daeSBarry Smith        Currently, a single processor can register more stages than another, but stages must all be registered in order.
15895c6c1daeSBarry Smith        We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID.
15905c6c1daeSBarry Smith        This seems best accomplished by assoicating a communicator with each stage.
15915c6c1daeSBarry Smith   */
159237b78d16SBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
1593820f2d46SBarry Smith   ierr = MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr);
1594785e854fSJed Brown   ierr = PetscMalloc1(numStages, &localStageUsed);CHKERRQ(ierr);
1595785e854fSJed Brown   ierr = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr);
1596785e854fSJed Brown   ierr = PetscMalloc1(numStages, &localStageVisible);CHKERRQ(ierr);
1597785e854fSJed Brown   ierr = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr);
15985c6c1daeSBarry Smith   if (numStages > 0) {
15995c6c1daeSBarry Smith     stageInfo = stageLog->stageInfo;
16005c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
16015c6c1daeSBarry Smith       if (stage < stageLog->numStages) {
16025c6c1daeSBarry Smith         localStageUsed[stage]    = stageInfo[stage].used;
16035c6c1daeSBarry Smith         localStageVisible[stage] = stageInfo[stage].perfInfo.visible;
16045c6c1daeSBarry Smith       } else {
16055c6c1daeSBarry Smith         localStageUsed[stage]    = PETSC_FALSE;
16065c6c1daeSBarry Smith         localStageVisible[stage] = PETSC_TRUE;
16075c6c1daeSBarry Smith       }
16085c6c1daeSBarry Smith     }
1609820f2d46SBarry Smith     ierr = MPI_Allreduce(localStageUsed,    stageUsed,    numStages, MPIU_BOOL, MPI_LOR,  comm);CHKERRMPI(ierr);
1610820f2d46SBarry Smith     ierr = MPI_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr);
16115c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
16125c6c1daeSBarry Smith       if (stageUsed[stage]) {
1613217044c2SLisandro Dalcin         ierr = PetscFPrintf(comm, fd, "\nSummary of Stages:   ----- Time ------  ----- Flop ------  --- Messages ---  -- Message Lengths --  -- Reductions --\n");CHKERRQ(ierr);
1614217044c2SLisandro Dalcin         ierr = PetscFPrintf(comm, fd, "                        Avg     %%Total     Avg     %%Total    Count   %%Total     Avg         %%Total    Count   %%Total\n");CHKERRQ(ierr);
16155c6c1daeSBarry Smith         break;
16165c6c1daeSBarry Smith       }
16175c6c1daeSBarry Smith     }
16185c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
16195c6c1daeSBarry Smith       if (!stageUsed[stage]) continue;
1620820f2d46SBarry Smith       /* CANNOT use MPI_Allreduce() since it might fail the line number check */
16215c6c1daeSBarry Smith       if (localStageUsed[stage]) {
1622ffc4695bSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1623ffc4695bSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1624ffc4695bSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1625ffc4695bSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1626ffc4695bSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
16275c6c1daeSBarry Smith         name = stageInfo[stage].name;
16285c6c1daeSBarry Smith       } else {
1629ffc4695bSBarry Smith         ierr = MPI_Allreduce(&zero,                           &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1630ffc4695bSBarry Smith         ierr = MPI_Allreduce(&zero,                           &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1631ffc4695bSBarry Smith         ierr = MPI_Allreduce(&zero,                           &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1632ffc4695bSBarry Smith         ierr = MPI_Allreduce(&zero,                           &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1633ffc4695bSBarry Smith         ierr = MPI_Allreduce(&zero,                           &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
16345c6c1daeSBarry Smith         name = "";
16355c6c1daeSBarry Smith       }
16365c6c1daeSBarry Smith       mess *= 0.5; messLen *= 0.5; red /= size;
16375c6c1daeSBarry Smith       if (TotalTime     != 0.0) fracTime       = stageTime/TotalTime;    else fracTime       = 0.0;
16385c6c1daeSBarry Smith       if (TotalFlops    != 0.0) fracFlops      = flops/TotalFlops;       else fracFlops      = 0.0;
16395c6c1daeSBarry Smith       /* Talk to Barry if (stageTime     != 0.0) flops          = (size*flops)/stageTime; else flops          = 0.0; */
16405c6c1daeSBarry Smith       if (numMessages   != 0.0) fracMessages   = mess/numMessages;       else fracMessages   = 0.0;
1641e96a4d02SJunchao Zhang       if (mess          != 0.0) avgMessLen     = messLen/mess;           else avgMessLen     = 0.0;
16425c6c1daeSBarry Smith       if (messageLength != 0.0) fracLength     = messLen/messageLength;  else fracLength     = 0.0;
16435c6c1daeSBarry Smith       if (numReductions != 0.0) fracReductions = red/numReductions;      else fracReductions = 0.0;
16445c6c1daeSBarry 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",
16455c6c1daeSBarry Smith                           stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops,
16465c6c1daeSBarry Smith                           mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr);
16475c6c1daeSBarry Smith     }
16485c6c1daeSBarry Smith   }
16495c6c1daeSBarry Smith 
1650806fa848SBarry Smith   ierr = PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
16515c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n");CHKERRQ(ierr);
16525c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Phase summary info:\n");CHKERRQ(ierr);
16535c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Count: number of times phase was executed\n");CHKERRQ(ierr);
1654d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Time and Flop: Max - maximum over all processors\n");CHKERRQ(ierr);
16555c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "                  Ratio - ratio of maximum to minimum over all processors\n");CHKERRQ(ierr);
16565c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Mess: number of messages sent\n");CHKERRQ(ierr);
1657217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "   AvgLen: average message length (bytes)\n");CHKERRQ(ierr);
16585c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Reduct: number of global reductions\n");CHKERRQ(ierr);
16595c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Global: entire computation\n");CHKERRQ(ierr);
16605c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n");CHKERRQ(ierr);
1661d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%T - percent time in this phase         %%F - percent flop in this phase\n");CHKERRQ(ierr);
16625c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%M - percent messages in this phase     %%L - percent message lengths in this phase\n");CHKERRQ(ierr);
16635c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%R - percent reductions in this phase\n");CHKERRQ(ierr);
1664d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n");CHKERRQ(ierr);
1665e3ed9ee7SBarry Smith   if (PetscLogMemory) {
1666e3ed9ee7SBarry Smith     ierr = PetscFPrintf(comm, fd, "   Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event)\n");CHKERRQ(ierr);
1667e3ed9ee7SBarry Smith     ierr = PetscFPrintf(comm, fd, "   EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events)\n");CHKERRQ(ierr);
1668e3ed9ee7SBarry Smith     ierr = PetscFPrintf(comm, fd, "   MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event)\n");CHKERRQ(ierr);
1669e3ed9ee7SBarry Smith     ierr = PetscFPrintf(comm, fd, "   RMI Mbytes: Increase in resident memory (sum over all calls to event)\n");CHKERRQ(ierr);
1670e3ed9ee7SBarry Smith   }
1671d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1672958c4211Shannah_mairs   ierr = PetscFPrintf(comm, fd, "   GPU Mflop/s: 10e-6 * (sum of flop on GPU over all processors)/(max GPU time over all processors)\n");CHKERRQ(ierr);
16734863603aSSatish Balay   ierr = PetscFPrintf(comm, fd, "   CpuToGpu Count: total number of CPU to GPU copies per processor\n");CHKERRQ(ierr);
16744863603aSSatish Balay   ierr = PetscFPrintf(comm, fd, "   CpuToGpu Size (Mbytes): 10e-6 * (total size of CPU to GPU copies per processor)\n");CHKERRQ(ierr);
16754863603aSSatish Balay   ierr = PetscFPrintf(comm, fd, "   GpuToCpu Count: total number of GPU to CPU copies per processor\n");CHKERRQ(ierr);
16764863603aSSatish Balay   ierr = PetscFPrintf(comm, fd, "   GpuToCpu Size (Mbytes): 10e-6 * (total size of GPU to CPU copies per processor)\n");CHKERRQ(ierr);
1677958c4211Shannah_mairs   ierr = PetscFPrintf(comm, fd, "   GPU %%F: percent flops on GPU in this event\n");CHKERRQ(ierr);
1678bec0b493Shannah_mairs   #endif
1679806fa848SBarry Smith   ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
16805c6c1daeSBarry Smith 
1681f4091ad2SBarry Smith   ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr);
16825c6c1daeSBarry Smith 
16835c6c1daeSBarry Smith   /* Report events */
1684e3ed9ee7SBarry Smith   ierr = PetscFPrintf(comm, fd,"Event                Count      Time (sec)     Flop                              --- Global ---  --- Stage ----  Total");CHKERRQ(ierr);
1685e3ed9ee7SBarry Smith   if (PetscLogMemory) {
1686bec0b493Shannah_mairs     ierr = PetscFPrintf(comm, fd,"  Malloc EMalloc MMalloc RMI");CHKERRQ(ierr);
1687e3ed9ee7SBarry Smith   }
1688d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1689958c4211Shannah_mairs   ierr = PetscFPrintf(comm, fd,"   GPU    - CpuToGpu -   - GpuToCpu - GPU");CHKERRQ(ierr);
1690bec0b493Shannah_mairs   #endif
1691bec0b493Shannah_mairs   ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr);
1692e3ed9ee7SBarry Smith   ierr = PetscFPrintf(comm, fd,"                   Max Ratio  Max     Ratio   Max  Ratio  Mess   AvgLen  Reduct  %%T %%F %%M %%L %%R  %%T %%F %%M %%L %%R Mflop/s");CHKERRQ(ierr);
1693e3ed9ee7SBarry Smith   if (PetscLogMemory) {
1694bec0b493Shannah_mairs     ierr = PetscFPrintf(comm, fd," Mbytes Mbytes Mbytes Mbytes");CHKERRQ(ierr);
1695e3ed9ee7SBarry Smith   }
1696d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1697958c4211Shannah_mairs   ierr = PetscFPrintf(comm, fd," Mflop/s Count   Size   Count   Size  %%F");CHKERRQ(ierr);
1698bec0b493Shannah_mairs   #endif
1699bec0b493Shannah_mairs   ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr);
17004863603aSSatish Balay   ierr = PetscFPrintf(comm, fd,"------------------------------------------------------------------------------------------------------------------------");CHKERRQ(ierr);
17014863603aSSatish Balay   if (PetscLogMemory) {
17024863603aSSatish Balay     ierr = PetscFPrintf(comm, fd,"-----------------------------");CHKERRQ(ierr);
17034863603aSSatish Balay   }
1704d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1705958c4211Shannah_mairs   ierr = PetscFPrintf(comm, fd,"---------------------------------------");CHKERRQ(ierr);
17064863603aSSatish Balay   #endif
17074863603aSSatish Balay   ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr);
17085c6c1daeSBarry Smith 
17095c6c1daeSBarry Smith   /* Problem: The stage name will not show up unless the stage executed on proc 1 */
17105c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
17115c6c1daeSBarry Smith     if (!stageVisible[stage]) continue;
1712820f2d46SBarry Smith     /* CANNOT use MPI_Allreduce() since it might fail the line number check */
17135c6c1daeSBarry Smith     if (localStageUsed[stage]) {
17145c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr);
1715ffc4695bSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1716ffc4695bSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1717ffc4695bSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1718ffc4695bSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1719ffc4695bSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
17205c6c1daeSBarry Smith     } else {
17215c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr);
1722ffc4695bSBarry Smith       ierr = MPI_Allreduce(&zero,                           &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1723ffc4695bSBarry Smith       ierr = MPI_Allreduce(&zero,                           &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1724ffc4695bSBarry Smith       ierr = MPI_Allreduce(&zero,                           &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1725ffc4695bSBarry Smith       ierr = MPI_Allreduce(&zero,                           &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1726ffc4695bSBarry Smith       ierr = MPI_Allreduce(&zero,                           &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
17275c6c1daeSBarry Smith     }
17285c6c1daeSBarry Smith     mess *= 0.5; messLen *= 0.5; red /= size;
17295c6c1daeSBarry Smith 
17305c6c1daeSBarry Smith     /* Get total number of events in this stage --
17315c6c1daeSBarry Smith        Currently, a single processor can register more events than another, but events must all be registered in order,
17325c6c1daeSBarry Smith        just like stages. We can removed this requirement if necessary by having a global event numbering and indirection
1733217044c2SLisandro Dalcin        on the event ID. This seems best accomplished by associating a communicator with each stage.
17345c6c1daeSBarry Smith 
17355c6c1daeSBarry Smith        Problem: If the event did not happen on proc 1, its name will not be available.
17365c6c1daeSBarry Smith        Problem: Event visibility is not implemented
17375c6c1daeSBarry Smith     */
17385c6c1daeSBarry Smith     if (localStageUsed[stage]) {
17395c6c1daeSBarry Smith       eventInfo      = stageLog->stageInfo[stage].eventLog->eventInfo;
17405c6c1daeSBarry Smith       localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents;
1741a297a907SKarl Rupp     } else localNumEvents = 0;
1742820f2d46SBarry Smith     ierr = MPI_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr);
17435c6c1daeSBarry Smith     for (event = 0; event < numEvents; event++) {
1744820f2d46SBarry Smith       /* CANNOT use MPI_Allreduce() since it might fail the line number check */
17455c6c1daeSBarry Smith       if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) {
1746217044c2SLisandro Dalcin         if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; else flopr = 0.0;
1747ffc4695bSBarry Smith         ierr = MPI_Allreduce(&flopr,                          &minf,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
1748ffc4695bSBarry Smith         ierr = MPI_Allreduce(&flopr,                          &maxf,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1749ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].flops,         &totf,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1750ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].time,          &mint,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
1751ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].time,          &maxt,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1752ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].time,          &tott,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1753ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].numMessages,   &totm,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1754ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1755ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].numReductions, &totr,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1756ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].count,         &minC,  1, MPI_INT,             MPI_MIN, comm);CHKERRMPI(ierr);
1757ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].count,         &maxC,  1, MPI_INT,             MPI_MAX, comm);CHKERRMPI(ierr);
1758e3ed9ee7SBarry Smith         if (PetscLogMemory) {
175955b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&eventInfo[event].memIncrease,    &mem,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
176055b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&eventInfo[event].mallocSpace,    &mal,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
176155b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&eventInfo[event].mallocIncrease, &malmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
176255b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1763e3ed9ee7SBarry Smith         }
1764d9c66bfbSJunchao Zhang         #if defined(PETSC_HAVE_DEVICE)
176555b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&eventInfo[event].CpuToGpuCount,    &cct,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
176655b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&eventInfo[event].GpuToCpuCount,    &gct,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
176755b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&eventInfo[event].CpuToGpuSize,     &csz,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
176855b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&eventInfo[event].GpuToCpuSize,     &gsz,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
176955b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&eventInfo[event].GpuFlops,         &gflops,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
177055b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&eventInfo[event].GpuTime,          &gmaxt ,1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1771bec0b493Shannah_mairs         #endif
17725c6c1daeSBarry Smith         name = stageLog->eventLog->eventInfo[event].name;
17735c6c1daeSBarry Smith       } else {
17745c6c1daeSBarry Smith         flopr = 0.0;
177555b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&flopr,                         &minf,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
177655b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&flopr,                         &maxf,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
177755b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &totf,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
177855b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &mint,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
177955b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &maxt,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
178055b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &tott,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
178155b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &totm,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
178255b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
178355b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &totr,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
178455b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&ierr,                          &minC,  1, MPI_INT,             MPI_MIN, comm);CHKERRMPI(ierr);
178555b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&ierr,                          &maxC,  1, MPI_INT,             MPI_MAX, comm);CHKERRMPI(ierr);
1786e3ed9ee7SBarry Smith         if (PetscLogMemory) {
178755b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&zero,                        &mem,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
178855b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&zero,                        &mal,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
178955b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&zero,                        &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
179055b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&zero,                        &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1791e3ed9ee7SBarry Smith         }
1792d9c66bfbSJunchao Zhang         #if defined(PETSC_HAVE_DEVICE)
179355b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &cct,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
179455b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &gct,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
179555b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &csz,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
179655b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &gsz,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
179755b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
179855b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &gmaxt , 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1799bec0b493Shannah_mairs         #endif
18005c6c1daeSBarry Smith         name  = "";
18015c6c1daeSBarry Smith       }
18025c6c1daeSBarry Smith       if (mint < 0.0) {
18035c6c1daeSBarry 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);
18045c6c1daeSBarry Smith         mint = 0;
18055c6c1daeSBarry Smith       }
1806d4aa7d5fSBarry Smith       if (minf < 0.0) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Minimum flop %g over all processors for %s is negative! Not possible!",minf,name);
18075c6c1daeSBarry Smith       totm *= 0.5; totml *= 0.5; totr /= size;
18085c6c1daeSBarry Smith 
1809217044c2SLisandro Dalcin       if (maxC != 0) {
1810217044c2SLisandro Dalcin         if (minC          != 0)   ratC             = ((PetscLogDouble)maxC)/minC;else ratC             = 0.0;
18115c6c1daeSBarry Smith         if (mint          != 0.0) ratt             = maxt/mint;                  else ratt             = 0.0;
18125c6c1daeSBarry Smith         if (minf          != 0.0) ratf             = maxf/minf;                  else ratf             = 0.0;
18135c6c1daeSBarry Smith         if (TotalTime     != 0.0) fracTime         = tott/TotalTime;             else fracTime         = 0.0;
18145c6c1daeSBarry Smith         if (TotalFlops    != 0.0) fracFlops        = totf/TotalFlops;            else fracFlops        = 0.0;
18155c6c1daeSBarry Smith         if (stageTime     != 0.0) fracStageTime    = tott/stageTime;             else fracStageTime    = 0.0;
18165c6c1daeSBarry Smith         if (flops         != 0.0) fracStageFlops   = totf/flops;                 else fracStageFlops   = 0.0;
18175c6c1daeSBarry Smith         if (numMessages   != 0.0) fracMess         = totm/numMessages;           else fracMess         = 0.0;
18185c6c1daeSBarry Smith         if (messageLength != 0.0) fracMessLen      = totml/messageLength;        else fracMessLen      = 0.0;
18195c6c1daeSBarry Smith         if (numReductions != 0.0) fracRed          = totr/numReductions;         else fracRed          = 0.0;
18205c6c1daeSBarry Smith         if (mess          != 0.0) fracStageMess    = totm/mess;                  else fracStageMess    = 0.0;
18215c6c1daeSBarry Smith         if (messLen       != 0.0) fracStageMessLen = totml/messLen;              else fracStageMessLen = 0.0;
18225c6c1daeSBarry Smith         if (red           != 0.0) fracStageRed     = totr/red;                   else fracStageRed     = 0.0;
18235c6c1daeSBarry Smith         if (totm          != 0.0) totml           /= totm;                       else totml            = 0.0;
18245c6c1daeSBarry Smith         if (maxt          != 0.0) flopr            = totf/maxt;                  else flopr            = 0.0;
1825411f5eb9SRichard Tran Mills         if (fracStageTime > 1.00)  ierr = PetscFPrintf(comm, fd,"Warning -- total time of event greater than time of entire stage -- something is wrong with the timer\n");CHKERRQ(ierr);
18265c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd,
1827e3ed9ee7SBarry 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",
1828217044c2SLisandro Dalcin                             name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr,
18295c6c1daeSBarry Smith                             100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed,
18305c6c1daeSBarry Smith                             100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed,
1831c068d9bbSLisandro Dalcin                             PetscAbs(flopr)/1.0e6);CHKERRQ(ierr);
1832e3ed9ee7SBarry Smith         if (PetscLogMemory) {
1833bec0b493Shannah_mairs           ierr = PetscFPrintf(comm, fd," %5.0f   %5.0f   %5.0f   %5.0f",mal/1.0e6,emalmax/1.0e6,malmax/1.0e6,mem/1.0e6);CHKERRQ(ierr);
1834e3ed9ee7SBarry Smith         }
1835d9c66bfbSJunchao Zhang         #if defined(PETSC_HAVE_DEVICE)
1836958c4211Shannah_mairs         if (totf  != 0.0) fracgflops = gflops/totf;  else fracgflops = 0.0;
1837958c4211Shannah_mairs         if (gmaxt != 0.0) gflopr     = gflops/gmaxt; else gflopr     = 0.0;
1838958c4211Shannah_mairs         ierr = 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);CHKERRQ(ierr);
1839bec0b493Shannah_mairs         #endif
1840bec0b493Shannah_mairs         ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr);
18415c6c1daeSBarry Smith       }
18425c6c1daeSBarry Smith     }
18435c6c1daeSBarry Smith   }
18445c6c1daeSBarry Smith 
18455c6c1daeSBarry Smith   /* Memory usage and object creation */
18464863603aSSatish Balay   ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------");CHKERRQ(ierr);
18474863603aSSatish Balay   if (PetscLogMemory) {
18484863603aSSatish Balay     ierr = PetscFPrintf(comm, fd, "-----------------------------");CHKERRQ(ierr);
18494863603aSSatish Balay   }
1850d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1851958c4211Shannah_mairs   ierr = PetscFPrintf(comm, fd, "---------------------------------------");CHKERRQ(ierr);
18524863603aSSatish Balay   #endif
18534863603aSSatish Balay   ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr);
18545c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr);
18555c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n");CHKERRQ(ierr);
18565c6c1daeSBarry Smith 
18575c6c1daeSBarry Smith   /* Right now, only stages on the first processor are reported here, meaning only objects associated with
18585c6c1daeSBarry Smith      the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then
18595c6c1daeSBarry Smith      stats for stages local to processor sets.
18605c6c1daeSBarry Smith   */
18615c6c1daeSBarry Smith   /* We should figure out the longest object name here (now 20 characters) */
18625c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Object Type          Creations   Destructions     Memory  Descendants' Mem.\n");CHKERRQ(ierr);
18635c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Reports information only for process 0.\n");CHKERRQ(ierr);
18645c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
18655c6c1daeSBarry Smith     if (localStageUsed[stage]) {
18665c6c1daeSBarry Smith       classInfo = stageLog->stageInfo[stage].classLog->classInfo;
18675c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr);
18685c6c1daeSBarry Smith       for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) {
18695c6c1daeSBarry Smith         if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) {
18705c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "%20s %5d          %5d  %11.0f     %g\n", stageLog->classLog->classInfo[oclass].name,
18715c6c1daeSBarry Smith                               classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem,
18725c6c1daeSBarry Smith                               classInfo[oclass].descMem);CHKERRQ(ierr);
18735c6c1daeSBarry Smith         }
18745c6c1daeSBarry Smith       }
18755c6c1daeSBarry Smith     } else {
1876cf019ec6SStefano Zampini       if (!localStageVisible[stage]) continue;
18775c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr);
18785c6c1daeSBarry Smith     }
18795c6c1daeSBarry Smith   }
18805c6c1daeSBarry Smith 
18815c6c1daeSBarry Smith   ierr = PetscFree(localStageUsed);CHKERRQ(ierr);
18825c6c1daeSBarry Smith   ierr = PetscFree(stageUsed);CHKERRQ(ierr);
18835c6c1daeSBarry Smith   ierr = PetscFree(localStageVisible);CHKERRQ(ierr);
18845c6c1daeSBarry Smith   ierr = PetscFree(stageVisible);CHKERRQ(ierr);
18855c6c1daeSBarry Smith 
18865c6c1daeSBarry Smith   /* Information unrelated to this particular run */
1887a297a907SKarl Rupp   ierr = PetscFPrintf(comm, fd, "========================================================================================================================\n");CHKERRQ(ierr);
18888563dfccSBarry Smith   PetscTime(&y);
18898563dfccSBarry Smith   PetscTime(&x);
18908563dfccSBarry Smith   PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y);
18918563dfccSBarry Smith   PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y);
18925c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0);CHKERRQ(ierr);
18935c6c1daeSBarry Smith   /* MPI information */
18945c6c1daeSBarry Smith   if (size > 1) {
18955c6c1daeSBarry Smith     MPI_Status  status;
18965c6c1daeSBarry Smith     PetscMPIInt tag;
18975c6c1daeSBarry Smith     MPI_Comm    newcomm;
18985c6c1daeSBarry Smith 
1899ffc4695bSBarry Smith     ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
19008563dfccSBarry Smith     PetscTime(&x);
1901ffc4695bSBarry Smith     ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
1902ffc4695bSBarry Smith     ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
1903ffc4695bSBarry Smith     ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
1904ffc4695bSBarry Smith     ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
1905ffc4695bSBarry Smith     ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
19068563dfccSBarry Smith     PetscTime(&y);
19075c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0);CHKERRQ(ierr);
19085c6c1daeSBarry Smith     ierr = PetscCommDuplicate(comm,&newcomm, &tag);CHKERRQ(ierr);
1909ffc4695bSBarry Smith     ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
19105c6c1daeSBarry Smith     if (rank) {
1911ffc4695bSBarry Smith       ierr = MPI_Recv(NULL, 0, MPI_INT, rank-1,            tag, newcomm, &status);CHKERRMPI(ierr);
1912ffc4695bSBarry Smith       ierr = MPI_Send(NULL, 0, MPI_INT, (rank+1)%size, tag, newcomm);CHKERRMPI(ierr);
19135c6c1daeSBarry Smith     } else {
19148563dfccSBarry Smith       PetscTime(&x);
1915ffc4695bSBarry Smith       ierr = MPI_Send(NULL, 0, MPI_INT, 1,          tag, newcomm);CHKERRMPI(ierr);
1916ffc4695bSBarry Smith       ierr = MPI_Recv(NULL, 0, MPI_INT, size-1, tag, newcomm, &status);CHKERRMPI(ierr);
19178563dfccSBarry Smith       PetscTime(&y);
19185c6c1daeSBarry Smith       ierr = PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size);CHKERRQ(ierr);
19195c6c1daeSBarry Smith     }
19205c6c1daeSBarry Smith     ierr = PetscCommDestroy(&newcomm);CHKERRQ(ierr);
19215c6c1daeSBarry Smith   }
1922c5929fdfSBarry Smith   ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
19235c6c1daeSBarry Smith 
19245c6c1daeSBarry Smith   /* Machine and compile information */
19255c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS)
19265c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n");CHKERRQ(ierr);
19275c6c1daeSBarry Smith #else
19285c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n");CHKERRQ(ierr);
19295c6c1daeSBarry Smith #endif
1930217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES)
1931217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n");CHKERRQ(ierr);
1932217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128)
1933217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n");CHKERRQ(ierr);
1934217044c2SLisandro Dalcin #endif
19355c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
19365c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n");CHKERRQ(ierr);
19375f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128)
19385f27b2e0SBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n");CHKERRQ(ierr);
19395c6c1daeSBarry Smith #endif
19405c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE)
19415c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with single precision matrices\n");CHKERRQ(ierr);
19425c6c1daeSBarry Smith #else
19435c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n");CHKERRQ(ierr);
19445c6c1daeSBarry Smith #endif
19455c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n",
19465c6c1daeSBarry Smith                       (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt));CHKERRQ(ierr);
19475c6c1daeSBarry Smith 
19485c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions);CHKERRQ(ierr);
19495c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petscmachineinfo);CHKERRQ(ierr);
19505c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsccompilerinfo);CHKERRQ(ierr);
19515c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo);CHKERRQ(ierr);
19525c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsclinkerinfo);CHKERRQ(ierr);
19535c6c1daeSBarry Smith 
19545c6c1daeSBarry Smith   /* Cleanup */
19555c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr);
1956c2a741eeSJunchao Zhang   ierr = PetscLogViewWarnNoGpuAwareMpi(comm,fd);CHKERRQ(ierr);
1957f4091ad2SBarry Smith   ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr);
19585c6c1daeSBarry Smith   PetscFunctionReturn(0);
19595c6c1daeSBarry Smith }
19605c6c1daeSBarry Smith 
19617d6c928cSSatish Balay /*@C
19627d6c928cSSatish Balay   PetscLogView - Prints a summary of the logging.
19635c6c1daeSBarry Smith 
19645c6c1daeSBarry Smith   Collective over MPI_Comm
19655c6c1daeSBarry Smith 
19665c6c1daeSBarry Smith   Input Parameter:
1967f14045dbSBarry Smith .  viewer - an ASCII viewer
19685c6c1daeSBarry Smith 
19695c6c1daeSBarry Smith   Options Database Keys:
1970bb1d7374SBarry Smith +  -log_view [:filename] - Prints summary of log information
1971bb1d7374SBarry Smith .  -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file
1972607d249eSBarry 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)
1973d0a29bd7SConnor 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)
1974bb1d7374SBarry Smith .  -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation
1975bb1d7374SBarry Smith -  -log_trace [filename] - Displays a trace of what each process is doing
19765c6c1daeSBarry Smith 
19775c6c1daeSBarry Smith   Notes:
1978bb1d7374SBarry Smith   It is possible to control the logging programatically but we recommend using the options database approach whenever possible
19795c6c1daeSBarry Smith   By default the summary is printed to stdout.
19805c6c1daeSBarry Smith 
1981bb1d7374SBarry Smith   Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin()
1982bb1d7374SBarry Smith 
1983bb1d7374SBarry Smith   If PETSc is configured with --with-logging=0 then this functionality is not available
1984bb1d7374SBarry Smith 
1985607d249eSBarry Smith   To view the nested XML format filename.xml first copy  ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current
1986607d249eSBarry Smith   directory then open filename.xml with your browser. Specific notes for certain browsers
1987607d249eSBarry Smith $    Firefox and Internet explorer - simply open the file
1988607d249eSBarry Smith $    Google Chrome - you must start up Chrome with the option --allow-file-access-from-files
1989a8d69d7bSBarry Smith $    Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access
1990607d249eSBarry 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
1991607d249eSBarry Smith   your browser.
19922add09c0SLisandro Dalcin   Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser
19932add09c0SLisandro Dalcin   window and render the XML log file contents.
1994607d249eSBarry Smith 
1995bb1d7374SBarry Smith   The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij  MARITIME  RESEARCH  INSTITUTE  NETHERLANDS
1996bb1d7374SBarry Smith 
1997d0a29bd7SConnor Ward   The Flame Graph output can be visualised using either the original Flame Graph script (https://github.com/brendangregg/FlameGraph)
1998d0a29bd7SConnor Ward   or using speedscope (https://www.speedscope.app).
1999d0a29bd7SConnor Ward   Old XML profiles may be converted into this format using the script ${PETSC_DIR}/lib/petsc/bin/xml2flamegraph.py.
2000d0a29bd7SConnor Ward 
20015c6c1daeSBarry Smith   Level: beginner
20025c6c1daeSBarry Smith 
2003bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogDump()
20045c6c1daeSBarry Smith @*/
2005f14045dbSBarry Smith PetscErrorCode  PetscLogView(PetscViewer viewer)
20065c6c1daeSBarry Smith {
20075c6c1daeSBarry Smith   PetscErrorCode    ierr;
2008f14045dbSBarry Smith   PetscBool         isascii;
2009f14045dbSBarry Smith   PetscViewerFormat format;
201037b78d16SBarry Smith   int               stage, lastStage;
201137b78d16SBarry Smith   PetscStageLog     stageLog;
20125c6c1daeSBarry Smith 
20135c6c1daeSBarry Smith   PetscFunctionBegin;
2014609bdbeeSBarry Smith   if (!PetscLogPLB) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Must use -log_view or PetscLogDefaultBegin() before calling this routine");
201537b78d16SBarry Smith   /* Pop off any stages the user forgot to remove */
201637b78d16SBarry Smith   lastStage = 0;
201737b78d16SBarry Smith   ierr      = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
201837b78d16SBarry Smith   ierr      = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
201937b78d16SBarry Smith   while (stage >= 0) {
202037b78d16SBarry Smith     lastStage = stage;
202137b78d16SBarry Smith     ierr      = PetscStageLogPop(stageLog);CHKERRQ(ierr);
202237b78d16SBarry Smith     ierr      = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
202337b78d16SBarry Smith   }
2024f14045dbSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
2025f14045dbSBarry Smith   if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Currently can only view logging to ASCII");
2026f14045dbSBarry Smith   ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
2027f14045dbSBarry Smith   if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) {
2028f14045dbSBarry Smith     ierr = PetscLogView_Default(viewer);CHKERRQ(ierr);
2029f14045dbSBarry Smith   } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
2030f14045dbSBarry Smith     ierr = PetscLogView_Detailed(viewer);CHKERRQ(ierr);
203138144912Sdeepblu2718   } else if (format == PETSC_VIEWER_ASCII_CSV) {
203238144912Sdeepblu2718     ierr = PetscLogView_CSV(viewer);CHKERRQ(ierr);
2033bb1d7374SBarry Smith   } else if (format == PETSC_VIEWER_ASCII_XML) {
2034bb1d7374SBarry Smith     ierr = PetscLogView_Nested(viewer);CHKERRQ(ierr);
2035d0a29bd7SConnor Ward   } else if (format == PETSC_VIEWER_ASCII_FLAMEGRAPH) {
2036d0a29bd7SConnor Ward     ierr = PetscLogView_Flamegraph(viewer);CHKERRQ(ierr);
20375c6c1daeSBarry Smith   }
203837b78d16SBarry Smith   ierr = PetscStageLogPush(stageLog, lastStage);CHKERRQ(ierr);
20395c6c1daeSBarry Smith   PetscFunctionReturn(0);
20405c6c1daeSBarry Smith }
20415c6c1daeSBarry Smith 
2042f14045dbSBarry Smith /*@C
2043f14045dbSBarry Smith   PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed.
2044f14045dbSBarry Smith 
2045f14045dbSBarry Smith   Collective on PETSC_COMM_WORLD
2046f14045dbSBarry Smith 
2047f14045dbSBarry Smith   Not normally called by user
2048f14045dbSBarry Smith 
2049f14045dbSBarry Smith   Level: intermediate
2050f14045dbSBarry Smith 
2051f14045dbSBarry Smith @*/
2052f14045dbSBarry Smith PetscErrorCode PetscLogViewFromOptions(void)
2053f14045dbSBarry Smith {
2054f14045dbSBarry Smith   PetscErrorCode    ierr;
2055f14045dbSBarry Smith   PetscViewer       viewer;
2056f14045dbSBarry Smith   PetscBool         flg;
2057f14045dbSBarry Smith   PetscViewerFormat format;
2058f14045dbSBarry Smith 
2059f14045dbSBarry Smith   PetscFunctionBegin;
206016413a6aSBarry Smith   ierr   = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-log_view",&viewer,&format,&flg);CHKERRQ(ierr);
2061f14045dbSBarry Smith   if (flg) {
2062f14045dbSBarry Smith     ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr);
2063f14045dbSBarry Smith     ierr = PetscLogView(viewer);CHKERRQ(ierr);
2064f14045dbSBarry Smith     ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
2065f14045dbSBarry Smith     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
2066f14045dbSBarry Smith   }
2067f14045dbSBarry Smith   PetscFunctionReturn(0);
2068f14045dbSBarry Smith }
2069f14045dbSBarry Smith 
20705c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/
20715c6c1daeSBarry Smith /*@C
20725c6c1daeSBarry Smith    PetscGetFlops - Returns the number of flops used on this processor
20735c6c1daeSBarry Smith    since the program began.
20745c6c1daeSBarry Smith 
20755c6c1daeSBarry Smith    Not Collective
20765c6c1daeSBarry Smith 
20775c6c1daeSBarry Smith    Output Parameter:
20785c6c1daeSBarry Smith    flops - number of floating point operations
20795c6c1daeSBarry Smith 
20805c6c1daeSBarry Smith    Notes:
20815c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
20825c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
20835c6c1daeSBarry Smith    application code.
20845c6c1daeSBarry Smith 
20855c6c1daeSBarry Smith    Level: intermediate
20865c6c1daeSBarry Smith 
20878563dfccSBarry Smith .seealso: PetscTime(), PetscLogFlops()
20885c6c1daeSBarry Smith @*/
20895c6c1daeSBarry Smith PetscErrorCode  PetscGetFlops(PetscLogDouble *flops)
20905c6c1daeSBarry Smith {
20915c6c1daeSBarry Smith   PetscFunctionBegin;
20925c6c1daeSBarry Smith   *flops = petsc_TotalFlops;
20935c6c1daeSBarry Smith   PetscFunctionReturn(0);
20945c6c1daeSBarry Smith }
20955c6c1daeSBarry Smith 
20965c6c1daeSBarry Smith PetscErrorCode  PetscLogObjectState(PetscObject obj, const char format[], ...)
20975c6c1daeSBarry Smith {
20985c6c1daeSBarry Smith   PetscErrorCode ierr;
20995c6c1daeSBarry Smith   size_t         fullLength;
21005c6c1daeSBarry Smith   va_list        Argp;
21015c6c1daeSBarry Smith 
21025c6c1daeSBarry Smith   PetscFunctionBegin;
21035c6c1daeSBarry Smith   if (!petsc_logObjects) PetscFunctionReturn(0);
21045c6c1daeSBarry Smith   va_start(Argp, format);
21055c6c1daeSBarry Smith   ierr = PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp);CHKERRQ(ierr);
21065c6c1daeSBarry Smith   va_end(Argp);
21075c6c1daeSBarry Smith   PetscFunctionReturn(0);
21085c6c1daeSBarry Smith }
21095c6c1daeSBarry Smith 
21105c6c1daeSBarry Smith /*MC
21115c6c1daeSBarry Smith    PetscLogFlops - Adds floating point operations to the global counter.
21125c6c1daeSBarry Smith 
21135c6c1daeSBarry Smith    Synopsis:
2114aaa7dc30SBarry Smith    #include <petsclog.h>
21155c6c1daeSBarry Smith    PetscErrorCode PetscLogFlops(PetscLogDouble f)
21165c6c1daeSBarry Smith 
21175c6c1daeSBarry Smith    Not Collective
21185c6c1daeSBarry Smith 
21195c6c1daeSBarry Smith    Input Parameter:
21205c6c1daeSBarry Smith .  f - flop counter
21215c6c1daeSBarry Smith 
21225c6c1daeSBarry Smith    Usage:
21235c6c1daeSBarry Smith .vb
21245c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
21255c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
21265c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
21275c6c1daeSBarry Smith         [code segment to monitor]
21285c6c1daeSBarry Smith         PetscLogFlops(user_flops)
21295c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
21305c6c1daeSBarry Smith .ve
21315c6c1daeSBarry Smith 
21325c6c1daeSBarry Smith    Notes:
21335c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
21345c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
21355c6c1daeSBarry Smith    application code.
21365c6c1daeSBarry Smith 
21375c6c1daeSBarry Smith    Level: intermediate
21385c6c1daeSBarry Smith 
21395c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscGetFlops()
21405c6c1daeSBarry Smith 
21415c6c1daeSBarry Smith M*/
21425c6c1daeSBarry Smith 
21435c6c1daeSBarry Smith /*MC
21445c6c1daeSBarry Smith    PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice)
21455c6c1daeSBarry Smith     to get accurate timings
21465c6c1daeSBarry Smith 
21475c6c1daeSBarry Smith    Synopsis:
2148aaa7dc30SBarry Smith    #include <petsclog.h>
21495c6c1daeSBarry Smith    void PetscPreLoadBegin(PetscBool  flag,char *name);
21505c6c1daeSBarry Smith 
21515c6c1daeSBarry Smith    Not Collective
21525c6c1daeSBarry Smith 
21535c6c1daeSBarry Smith    Input Parameter:
21545c6c1daeSBarry Smith +   flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden
21555c6c1daeSBarry Smith            with command line option -preload true or -preload false
2156609bdbeeSBarry Smith -   name - name of first stage (lines of code timed separately with -log_view) to
21575c6c1daeSBarry Smith            be preloaded
21585c6c1daeSBarry Smith 
21595c6c1daeSBarry Smith    Usage:
21605c6c1daeSBarry Smith .vb
21615c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
21625c6c1daeSBarry Smith        lines of code
21635c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
21645c6c1daeSBarry Smith        lines of code
21655c6c1daeSBarry Smith      PetscPreLoadEnd();
21665c6c1daeSBarry Smith .ve
21675c6c1daeSBarry Smith 
216895452b02SPatrick Sanan    Notes:
216995452b02SPatrick Sanan     Only works in C/C++, not Fortran
21705c6c1daeSBarry Smith 
21715c6c1daeSBarry Smith      Flags available within the macro.
21725c6c1daeSBarry Smith +    PetscPreLoadingUsed - true if we are or have done preloading
21735c6c1daeSBarry Smith .    PetscPreLoadingOn - true if it is CURRENTLY doing preload
21745c6c1daeSBarry Smith .    PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second
21755c6c1daeSBarry Smith -    PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on
21765c6c1daeSBarry Smith      The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin()
21775c6c1daeSBarry Smith      and PetscPreLoadEnd()
21785c6c1daeSBarry Smith 
21795c6c1daeSBarry Smith    Level: intermediate
21805c6c1daeSBarry Smith 
21815c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage()
21825c6c1daeSBarry Smith 
21835c6c1daeSBarry Smith M*/
21845c6c1daeSBarry Smith 
21855c6c1daeSBarry Smith /*MC
21865c6c1daeSBarry Smith    PetscPreLoadEnd - End a segment of code that may be preloaded (run twice)
21875c6c1daeSBarry Smith     to get accurate timings
21885c6c1daeSBarry Smith 
21895c6c1daeSBarry Smith    Synopsis:
2190aaa7dc30SBarry Smith    #include <petsclog.h>
21915c6c1daeSBarry Smith    void PetscPreLoadEnd(void);
21925c6c1daeSBarry Smith 
21935c6c1daeSBarry Smith    Not Collective
21945c6c1daeSBarry Smith 
21955c6c1daeSBarry Smith    Usage:
21965c6c1daeSBarry Smith .vb
21975c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
21985c6c1daeSBarry Smith        lines of code
21995c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
22005c6c1daeSBarry Smith        lines of code
22015c6c1daeSBarry Smith      PetscPreLoadEnd();
22025c6c1daeSBarry Smith .ve
22035c6c1daeSBarry Smith 
220495452b02SPatrick Sanan    Notes:
220595452b02SPatrick Sanan     only works in C/C++ not fortran
22065c6c1daeSBarry Smith 
22075c6c1daeSBarry Smith    Level: intermediate
22085c6c1daeSBarry Smith 
22095c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadStage()
22105c6c1daeSBarry Smith 
22115c6c1daeSBarry Smith M*/
22125c6c1daeSBarry Smith 
22135c6c1daeSBarry Smith /*MC
22145c6c1daeSBarry Smith    PetscPreLoadStage - Start a new segment of code to be timed separately.
22155c6c1daeSBarry Smith     to get accurate timings
22165c6c1daeSBarry Smith 
22175c6c1daeSBarry Smith    Synopsis:
2218aaa7dc30SBarry Smith    #include <petsclog.h>
22195c6c1daeSBarry Smith    void PetscPreLoadStage(char *name);
22205c6c1daeSBarry Smith 
22215c6c1daeSBarry Smith    Not Collective
22225c6c1daeSBarry Smith 
22235c6c1daeSBarry Smith    Usage:
22245c6c1daeSBarry Smith .vb
22255c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
22265c6c1daeSBarry Smith        lines of code
22275c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
22285c6c1daeSBarry Smith        lines of code
22295c6c1daeSBarry Smith      PetscPreLoadEnd();
22305c6c1daeSBarry Smith .ve
22315c6c1daeSBarry Smith 
223295452b02SPatrick Sanan    Notes:
223395452b02SPatrick Sanan     only works in C/C++ not fortran
22345c6c1daeSBarry Smith 
22355c6c1daeSBarry Smith    Level: intermediate
22365c6c1daeSBarry Smith 
22375c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd()
22385c6c1daeSBarry Smith 
22395c6c1daeSBarry Smith M*/
22405c6c1daeSBarry Smith 
22419ffd0706SHong Zhang #if defined(PETSC_HAVE_DEVICE)
22429ffd0706SHong Zhang 
22439ffd0706SHong Zhang #if defined(PETSC_HAVE_CUDA)
22449ffd0706SHong Zhang #include <cuda_runtime.h>
22459ffd0706SHong Zhang #include <petsccublas.h>
22469ffd0706SHong Zhang PETSC_EXTERN cudaEvent_t petsc_gputimer_begin;
22479ffd0706SHong Zhang PETSC_EXTERN cudaEvent_t petsc_gputimer_end;
22489ffd0706SHong Zhang #endif
22499ffd0706SHong Zhang 
22509ffd0706SHong Zhang #if defined(PETSC_HAVE_HIP)
22519ffd0706SHong Zhang #include <hip/hip_runtime.h>
22529ffd0706SHong Zhang #include <petschipblas.h>
22539ffd0706SHong Zhang PETSC_EXTERN hipEvent_t petsc_gputimer_begin;
22549ffd0706SHong Zhang PETSC_EXTERN hipEvent_t petsc_gputimer_end;
22559ffd0706SHong Zhang #endif
22569ffd0706SHong Zhang 
22579ffd0706SHong Zhang /*-------------------------------------------- GPU event Functions ----------------------------------------------*/
22589ffd0706SHong Zhang /*@C
22599ffd0706SHong Zhang   PetscLogGpuTimeBegin - Start timer for device
22609ffd0706SHong Zhang 
22619ffd0706SHong Zhang   Notes:
22629ffd0706SHong 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).
22639ffd0706SHong 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).
22649ffd0706SHong Zhang     There is no need to call WaitForCUDA() or WaitForHIP() between PetscLogGpuTimeBegin and PetscLogGpuTimeEnd
22659ffd0706SHong Zhang     This timer should NOT include times for data transfers between the GPU and CPU, nor setup actions such as allocating space.
22669ffd0706SHong Zhang     The regular logging captures the time for data transfers and any CPU activites during the event
22679ffd0706SHong Zhang     It is used to compute the flop rate on the GPU as it is actively engaged in running a kernel.
22689ffd0706SHong Zhang 
22699ffd0706SHong Zhang   Developer Notes:
22709ffd0706SHong 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().
22719ffd0706SHong 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.
22729ffd0706SHong Zhang 
22739ffd0706SHong Zhang   Level: intermediate
22749ffd0706SHong Zhang 
22759ffd0706SHong Zhang .seealso:  PetscLogView(), PetscLogGpuFlops(), PetscLogGpuTimeEnd()
22769ffd0706SHong Zhang @*/
22779ffd0706SHong Zhang PetscErrorCode PetscLogGpuTimeBegin(void)
22789ffd0706SHong Zhang {
22799ffd0706SHong Zhang #if defined(PETSC_HAVE_CUDA)
22809ffd0706SHong Zhang   cudaError_t    cerr;
22819ffd0706SHong Zhang #elif defined(PETSC_HAVE_HIP)
22829ffd0706SHong Zhang   hipError_t     cerr;
22839ffd0706SHong Zhang #else
22849ffd0706SHong Zhang   PetscErrorCode ierr;
22859ffd0706SHong Zhang #endif
22869ffd0706SHong Zhang   PetscFunctionBegin;
22879ffd0706SHong Zhang #if defined(PETSC_USE_DEBUG)
22889ffd0706SHong Zhang   if (petsc_gtime_inuse) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Forgot to call PetscLogGpuTimeEnd()?");
22899ffd0706SHong Zhang   petsc_gtime_inuse = PETSC_TRUE;
22909ffd0706SHong Zhang #endif
22919ffd0706SHong Zhang #if defined(PETSC_HAVE_CUDA)
22929ffd0706SHong Zhang   cerr = cudaEventRecord(petsc_gputimer_begin,PetscDefaultCudaStream);CHKERRCUDA(cerr);
22939ffd0706SHong Zhang #elif defined(PETSC_HAVE_HIP)
22949ffd0706SHong Zhang   cerr = hipEventRecord(petsc_gputimer_begin,PetscDefaultHipStream);CHKERRHIP(cerr);
22959ffd0706SHong Zhang #else
22969ffd0706SHong Zhang   ierr = PetscTimeSubtract(&petsc_gtime);CHKERRQ(ierr);
22979ffd0706SHong Zhang #endif
22989ffd0706SHong Zhang   PetscFunctionReturn(0);
22999ffd0706SHong Zhang }
23009ffd0706SHong Zhang 
23019ffd0706SHong Zhang /*@C
23029ffd0706SHong Zhang   PetscLogGpuTimeEnd - Stop timer for device
23039ffd0706SHong Zhang 
23049ffd0706SHong Zhang   Level: intermediate
23059ffd0706SHong Zhang 
23069ffd0706SHong Zhang .seealso:  PetscLogView(), PetscLogGpuFlops(), PetscLogGpuTimeBegin()
23079ffd0706SHong Zhang @*/
23089ffd0706SHong Zhang PetscErrorCode PetscLogGpuTimeEnd(void)
23099ffd0706SHong Zhang {
23109ffd0706SHong Zhang #if defined(PETSC_HAVE_CUDA)
23119ffd0706SHong Zhang   float          gtime;
23129ffd0706SHong Zhang   cudaError_t    cerr;
23139ffd0706SHong Zhang #elif defined(PETSC_HAVE_HIP)
23149ffd0706SHong Zhang   float          gtime;
23159ffd0706SHong Zhang   hipError_t     cerr;
23169ffd0706SHong Zhang #else
23179ffd0706SHong Zhang   PetscErrorCode ierr;
23189ffd0706SHong Zhang #endif
23199ffd0706SHong Zhang   PetscFunctionBegin;
23209ffd0706SHong Zhang #if defined(PETSC_USE_DEBUG)
23219ffd0706SHong Zhang   if (!petsc_gtime_inuse) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Forgot to call PetscLogGpuTimeBegin()?");
23229ffd0706SHong Zhang   petsc_gtime_inuse = PETSC_FALSE;
23239ffd0706SHong Zhang #endif
23249ffd0706SHong Zhang #if defined(PETSC_HAVE_CUDA)
23259ffd0706SHong Zhang   cerr = cudaEventRecord(petsc_gputimer_end,PetscDefaultCudaStream);CHKERRCUDA(cerr);
23269ffd0706SHong Zhang   cerr = cudaEventSynchronize(petsc_gputimer_end);CHKERRCUDA(cerr);
23279ffd0706SHong Zhang   cerr = cudaEventElapsedTime(&gtime,petsc_gputimer_begin,petsc_gputimer_end);CHKERRCUDA(cerr);
23289ffd0706SHong Zhang   petsc_gtime += (PetscLogDouble)gtime/1000.0; /* convert milliseconds to seconds */
23299ffd0706SHong Zhang #elif defined(PETSC_HAVE_HIP)
23309ffd0706SHong Zhang   cerr = hipEventRecord(petsc_gputimer_end,PetscDefaultHipStream);CHKERRHIP(cerr);
23319ffd0706SHong Zhang   cerr = hipEventSynchronize(petsc_gputimer_end);CHKERRHIP(cerr);
23329ffd0706SHong Zhang   cerr = hipEventElapsedTime(&gtime,petsc_gputimer_begin,petsc_gputimer_end);CHKERRHIP(cerr);
23339ffd0706SHong Zhang   petsc_gtime += (PetscLogDouble)gtime/1000.0; /* convert milliseconds to seconds */
23349ffd0706SHong Zhang #else
23359ffd0706SHong Zhang   ierr = PetscTimeAdd(&petsc_gtime);CHKERRQ(ierr);
23369ffd0706SHong Zhang #endif
23379ffd0706SHong Zhang   PetscFunctionReturn(0);
23389ffd0706SHong Zhang }
23399ffd0706SHong Zhang #endif /* end of PETSC_HAVE_DEVICE */
23409ffd0706SHong Zhang 
23415c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */
23425c6c1daeSBarry Smith 
23435c6c1daeSBarry Smith PetscErrorCode  PetscLogObjectState(PetscObject obj, const char format[], ...)
23445c6c1daeSBarry Smith {
23455c6c1daeSBarry Smith   PetscFunctionBegin;
23465c6c1daeSBarry Smith   PetscFunctionReturn(0);
23475c6c1daeSBarry Smith }
23485c6c1daeSBarry Smith 
23495c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/
23505c6c1daeSBarry Smith 
23515c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID;
23525c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID  = 0;
23535c6c1daeSBarry Smith 
23545c6c1daeSBarry Smith /*@C
23555c6c1daeSBarry Smith   PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code.
23565c6c1daeSBarry Smith 
23575c6c1daeSBarry Smith   Not Collective
23585c6c1daeSBarry Smith 
23595c6c1daeSBarry Smith   Input Parameter:
23605c6c1daeSBarry Smith . name   - The class name
23615c6c1daeSBarry Smith 
23625c6c1daeSBarry Smith   Output Parameter:
23635c6c1daeSBarry Smith . oclass - The class id or classid
23645c6c1daeSBarry Smith 
23655c6c1daeSBarry Smith   Level: developer
23665c6c1daeSBarry Smith 
23675c6c1daeSBarry Smith @*/
23685c6c1daeSBarry Smith PetscErrorCode  PetscClassIdRegister(const char name[],PetscClassId *oclass)
23695c6c1daeSBarry Smith {
23705c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
23715c6c1daeSBarry Smith   PetscStageLog  stageLog;
23725c6c1daeSBarry Smith   PetscInt       stage;
23735c6c1daeSBarry Smith   PetscErrorCode ierr;
23745c6c1daeSBarry Smith #endif
23755c6c1daeSBarry Smith 
23765c6c1daeSBarry Smith   PetscFunctionBegin;
23775c6c1daeSBarry Smith   *oclass = ++PETSC_LARGEST_CLASSID;
23785c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
23795c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
23805c6c1daeSBarry Smith   ierr = PetscClassRegLogRegister(stageLog->classLog, name, *oclass);CHKERRQ(ierr);
23815c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
23823a88037aSBarry Smith     ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
23835c6c1daeSBarry Smith   }
23845c6c1daeSBarry Smith #endif
23855c6c1daeSBarry Smith   PetscFunctionReturn(0);
23865c6c1daeSBarry Smith }
2387210b5426SBarry Smith 
2388210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE)
2389210b5426SBarry Smith #include <mpe.h>
2390210b5426SBarry Smith 
2391210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE;
2392210b5426SBarry Smith 
2393495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
2394495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
2395495fc317SBarry Smith 
2396210b5426SBarry Smith /*@C
2397210b5426SBarry Smith    PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files
2398210b5426SBarry Smith    and slows the program down.
2399210b5426SBarry Smith 
2400210b5426SBarry Smith    Collective over PETSC_COMM_WORLD
2401210b5426SBarry Smith 
2402210b5426SBarry Smith    Options Database Keys:
2403a2553e36SBarry Smith . -log_mpe - Prints extensive log information
2404210b5426SBarry Smith 
2405210b5426SBarry Smith    Notes:
2406609bdbeeSBarry Smith    A related routine is PetscLogDefaultBegin() (with the options key -log_view), which is
2407210b5426SBarry Smith    intended for production runs since it logs only flop rates and object
2408210b5426SBarry Smith    creation (and should not significantly slow the programs).
2409210b5426SBarry Smith 
2410210b5426SBarry Smith    Level: advanced
2411210b5426SBarry Smith 
2412bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogEventActivate(),
2413210b5426SBarry Smith           PetscLogEventDeactivate()
2414210b5426SBarry Smith @*/
2415210b5426SBarry Smith PetscErrorCode  PetscLogMPEBegin(void)
2416210b5426SBarry Smith {
2417210b5426SBarry Smith   PetscErrorCode ierr;
2418210b5426SBarry Smith 
2419210b5426SBarry Smith   PetscFunctionBegin;
2420210b5426SBarry Smith   /* Do MPE initialization */
2421210b5426SBarry Smith   if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */
2422210b5426SBarry Smith     ierr = PetscInfo(0,"Initializing MPE.\n");CHKERRQ(ierr);
2423210b5426SBarry Smith     ierr = MPE_Init_log();CHKERRQ(ierr);
2424210b5426SBarry Smith 
2425210b5426SBarry Smith     PetscBeganMPE = PETSC_TRUE;
2426210b5426SBarry Smith   } else {
2427210b5426SBarry Smith     ierr = PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n");CHKERRQ(ierr);
2428210b5426SBarry Smith   }
2429495fc317SBarry Smith   ierr = PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE);CHKERRQ(ierr);
2430210b5426SBarry Smith   PetscFunctionReturn(0);
2431210b5426SBarry Smith }
2432210b5426SBarry Smith 
2433210b5426SBarry Smith /*@C
2434495fc317SBarry Smith    PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot.
2435210b5426SBarry Smith 
2436210b5426SBarry Smith    Collective over PETSC_COMM_WORLD
2437210b5426SBarry Smith 
2438210b5426SBarry Smith    Level: advanced
2439210b5426SBarry Smith 
2440210b5426SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogMPEBegin()
2441210b5426SBarry Smith @*/
2442210b5426SBarry Smith PetscErrorCode  PetscLogMPEDump(const char sname[])
2443210b5426SBarry Smith {
2444210b5426SBarry Smith   char           name[PETSC_MAX_PATH_LEN];
2445210b5426SBarry Smith   PetscErrorCode ierr;
2446210b5426SBarry Smith 
2447210b5426SBarry Smith   PetscFunctionBegin;
2448210b5426SBarry Smith   if (PetscBeganMPE) {
2449210b5426SBarry Smith     ierr = PetscInfo(0,"Finalizing MPE.\n");CHKERRQ(ierr);
2450210b5426SBarry Smith     if (sname) {
2451210b5426SBarry Smith       ierr = PetscStrcpy(name,sname);CHKERRQ(ierr);
2452210b5426SBarry Smith     } else {
2453589a23caSBarry Smith       ierr = PetscGetProgramName(name,sizeof(name));CHKERRQ(ierr);
2454210b5426SBarry Smith     }
2455210b5426SBarry Smith     ierr = MPE_Finish_log(name);CHKERRQ(ierr);
2456210b5426SBarry Smith   } else {
2457210b5426SBarry Smith     ierr = PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n");CHKERRQ(ierr);
2458210b5426SBarry Smith   }
2459210b5426SBarry Smith   PetscFunctionReturn(0);
2460210b5426SBarry Smith }
2461210b5426SBarry Smith 
2462210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39
2463210b5426SBarry Smith static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = {
2464210b5426SBarry Smith   "OliveDrab:      ",
2465210b5426SBarry Smith   "BlueViolet:     ",
2466210b5426SBarry Smith   "CadetBlue:      ",
2467210b5426SBarry Smith   "CornflowerBlue: ",
2468210b5426SBarry Smith   "DarkGoldenrod:  ",
2469210b5426SBarry Smith   "DarkGreen:      ",
2470210b5426SBarry Smith   "DarkKhaki:      ",
2471210b5426SBarry Smith   "DarkOliveGreen: ",
2472210b5426SBarry Smith   "DarkOrange:     ",
2473210b5426SBarry Smith   "DarkOrchid:     ",
2474210b5426SBarry Smith   "DarkSeaGreen:   ",
2475210b5426SBarry Smith   "DarkSlateGray:  ",
2476210b5426SBarry Smith   "DarkTurquoise:  ",
2477210b5426SBarry Smith   "DeepPink:       ",
2478210b5426SBarry Smith   "DarkKhaki:      ",
2479210b5426SBarry Smith   "DimGray:        ",
2480210b5426SBarry Smith   "DodgerBlue:     ",
2481210b5426SBarry Smith   "GreenYellow:    ",
2482210b5426SBarry Smith   "HotPink:        ",
2483210b5426SBarry Smith   "IndianRed:      ",
2484210b5426SBarry Smith   "LavenderBlush:  ",
2485210b5426SBarry Smith   "LawnGreen:      ",
2486210b5426SBarry Smith   "LemonChiffon:   ",
2487210b5426SBarry Smith   "LightCoral:     ",
2488210b5426SBarry Smith   "LightCyan:      ",
2489210b5426SBarry Smith   "LightPink:      ",
2490210b5426SBarry Smith   "LightSalmon:    ",
2491210b5426SBarry Smith   "LightSlateGray: ",
2492210b5426SBarry Smith   "LightYellow:    ",
2493210b5426SBarry Smith   "LimeGreen:      ",
2494210b5426SBarry Smith   "MediumPurple:   ",
2495210b5426SBarry Smith   "MediumSeaGreen: ",
2496210b5426SBarry Smith   "MediumSlateBlue:",
2497210b5426SBarry Smith   "MidnightBlue:   ",
2498210b5426SBarry Smith   "MintCream:      ",
2499210b5426SBarry Smith   "MistyRose:      ",
2500210b5426SBarry Smith   "NavajoWhite:    ",
2501210b5426SBarry Smith   "NavyBlue:       ",
2502210b5426SBarry Smith   "OliveDrab:      "
2503210b5426SBarry Smith };
2504210b5426SBarry Smith 
2505210b5426SBarry Smith /*@C
2506210b5426SBarry Smith   PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister()
2507210b5426SBarry Smith 
2508210b5426SBarry Smith   Not collective. Maybe it should be?
2509210b5426SBarry Smith 
25107a7aea1fSJed Brown   Output Parameter:
2511210b5426SBarry Smith . str - character string representing the color
2512210b5426SBarry Smith 
2513210b5426SBarry Smith   Level: developer
2514210b5426SBarry Smith 
2515210b5426SBarry Smith .seealso: PetscLogEventRegister
2516210b5426SBarry Smith @*/
2517210b5426SBarry Smith PetscErrorCode  PetscLogMPEGetRGBColor(const char *str[])
2518210b5426SBarry Smith {
2519210b5426SBarry Smith   static int idx = 0;
2520210b5426SBarry Smith 
2521210b5426SBarry Smith   PetscFunctionBegin;
2522210b5426SBarry Smith   *str = PetscLogMPERGBColors[idx];
2523210b5426SBarry Smith   idx  = (idx + 1)% PETSC_RGB_COLORS_MAX;
2524210b5426SBarry Smith   PetscFunctionReturn(0);
2525210b5426SBarry Smith }
2526210b5426SBarry Smith 
2527210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */
2528