xref: /petsc/src/sys/logging/plog.c (revision d0a29bd77466da32e237a4ee4d6c05447bce64bd)
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 */
908df2f0b1SJunchao Zhang #if defined(PETSC_USE_DEBUG)
918df2f0b1SJunchao Zhang PetscBool petsc_gtime_inuse = PETSC_FALSE;
928df2f0b1SJunchao Zhang #endif
93bec0b493Shannah_mairs #endif
945c6c1daeSBarry Smith 
955c6c1daeSBarry Smith /* Logging functions */
960298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL;
970298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL;
980298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL;
990298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL;
1005c6c1daeSBarry Smith 
1015c6c1daeSBarry Smith /* Tracing event logging variables */
1020298fd71SBarry Smith FILE             *petsc_tracefile            = NULL;
1035c6c1daeSBarry Smith int              petsc_tracelevel            = 0;
1045c6c1daeSBarry Smith const char       *petsc_traceblanks          = "                                                                                                    ";
1055c6c1daeSBarry Smith char             petsc_tracespace[128]       = " ";
1065c6c1daeSBarry Smith PetscLogDouble   petsc_tracetime             = 0.0;
107896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE;
1085c6c1daeSBarry Smith 
10995c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogInitialize(void)
110fa2bb9feSLisandro Dalcin {
111fa2bb9feSLisandro Dalcin   int            stage;
112fa2bb9feSLisandro Dalcin   PetscBool      opt;
113fa2bb9feSLisandro Dalcin   PetscErrorCode ierr;
1145c6c1daeSBarry Smith 
115fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
116fa2bb9feSLisandro Dalcin   if (PetscLogInitializeCalled) PetscFunctionReturn(0);
117fa2bb9feSLisandro Dalcin   PetscLogInitializeCalled = PETSC_TRUE;
1185c6c1daeSBarry Smith 
119fa2bb9feSLisandro Dalcin   ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_actions", &opt);CHKERRQ(ierr);
120fa2bb9feSLisandro Dalcin   if (opt) petsc_logActions = PETSC_FALSE;
121fa2bb9feSLisandro Dalcin   ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_objects", &opt);CHKERRQ(ierr);
122fa2bb9feSLisandro Dalcin   if (opt) petsc_logObjects = PETSC_FALSE;
123fa2bb9feSLisandro Dalcin   if (petsc_logActions) {
124fa2bb9feSLisandro Dalcin     ierr = PetscMalloc1(petsc_maxActions, &petsc_actions);CHKERRQ(ierr);
125fa2bb9feSLisandro Dalcin   }
126fa2bb9feSLisandro Dalcin   if (petsc_logObjects) {
127fa2bb9feSLisandro Dalcin     ierr = PetscMalloc1(petsc_maxObjects, &petsc_objects);CHKERRQ(ierr);
128fa2bb9feSLisandro Dalcin   }
129fa2bb9feSLisandro Dalcin   PetscLogPHC = PetscLogObjCreateDefault;
130fa2bb9feSLisandro Dalcin   PetscLogPHD = PetscLogObjDestroyDefault;
131fa2bb9feSLisandro Dalcin   /* Setup default logging structures */
132fa2bb9feSLisandro Dalcin   ierr = PetscStageLogCreate(&petsc_stageLog);CHKERRQ(ierr);
133fa2bb9feSLisandro Dalcin   ierr = PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage);CHKERRQ(ierr);
1345c6c1daeSBarry Smith 
135fa2bb9feSLisandro Dalcin   /* All processors sync here for more consistent logging */
136ffc4695bSBarry Smith   ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRMPI(ierr);
137fa2bb9feSLisandro Dalcin   PetscTime(&petsc_BaseTime);
138fa2bb9feSLisandro Dalcin   ierr = PetscLogStagePush(stage);CHKERRQ(ierr);
139fa2bb9feSLisandro Dalcin   PetscFunctionReturn(0);
140fa2bb9feSLisandro Dalcin }
1415c6c1daeSBarry Smith 
14295c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogFinalize(void)
1435c6c1daeSBarry Smith {
1445c6c1daeSBarry Smith   PetscStageLog  stageLog;
1455c6c1daeSBarry Smith   PetscErrorCode ierr;
1465c6c1daeSBarry Smith 
1475c6c1daeSBarry Smith   PetscFunctionBegin;
1485c6c1daeSBarry Smith   ierr = PetscFree(petsc_actions);CHKERRQ(ierr);
1495c6c1daeSBarry Smith   ierr = PetscFree(petsc_objects);CHKERRQ(ierr);
150eccbb886SLisandro Dalcin   ierr = PetscLogNestedEnd();CHKERRQ(ierr);
1510298fd71SBarry Smith   ierr = PetscLogSet(NULL, NULL);CHKERRQ(ierr);
1525c6c1daeSBarry Smith 
1535c6c1daeSBarry Smith   /* Resetting phase */
1545c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
1555c6c1daeSBarry Smith   ierr = PetscStageLogDestroy(stageLog);CHKERRQ(ierr);
156a297a907SKarl Rupp 
1575c6c1daeSBarry Smith   petsc_TotalFlops            = 0.0;
1585c6c1daeSBarry Smith   petsc_numActions            = 0;
1595c6c1daeSBarry Smith   petsc_numObjects            = 0;
1605c6c1daeSBarry Smith   petsc_numObjectsDestroyed   = 0;
1615c6c1daeSBarry Smith   petsc_maxActions            = 100;
1625c6c1daeSBarry Smith   petsc_maxObjects            = 100;
1630298fd71SBarry Smith   petsc_actions               = NULL;
1640298fd71SBarry Smith   petsc_objects               = NULL;
1655c6c1daeSBarry Smith   petsc_logActions            = PETSC_FALSE;
1665c6c1daeSBarry Smith   petsc_logObjects            = PETSC_FALSE;
1675c6c1daeSBarry Smith   petsc_BaseTime              = 0.0;
1685c6c1daeSBarry Smith   petsc_TotalFlops            = 0.0;
1695c6c1daeSBarry Smith   petsc_tmp_flops             = 0.0;
1705c6c1daeSBarry Smith   petsc_send_ct               = 0.0;
1715c6c1daeSBarry Smith   petsc_recv_ct               = 0.0;
1725c6c1daeSBarry Smith   petsc_send_len              = 0.0;
1735c6c1daeSBarry Smith   petsc_recv_len              = 0.0;
1745c6c1daeSBarry Smith   petsc_isend_ct              = 0.0;
1755c6c1daeSBarry Smith   petsc_irecv_ct              = 0.0;
1765c6c1daeSBarry Smith   petsc_isend_len             = 0.0;
1775c6c1daeSBarry Smith   petsc_irecv_len             = 0.0;
1785c6c1daeSBarry Smith   petsc_wait_ct               = 0.0;
1795c6c1daeSBarry Smith   petsc_wait_any_ct           = 0.0;
1805c6c1daeSBarry Smith   petsc_wait_all_ct           = 0.0;
1815c6c1daeSBarry Smith   petsc_sum_of_waits_ct       = 0.0;
1825c6c1daeSBarry Smith   petsc_allreduce_ct          = 0.0;
1835c6c1daeSBarry Smith   petsc_gather_ct             = 0.0;
1845c6c1daeSBarry Smith   petsc_scatter_ct            = 0.0;
185d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
186bec0b493Shannah_mairs   petsc_ctog_ct               = 0.0;
187bec0b493Shannah_mairs   petsc_gtoc_ct               = 0.0;
188bec0b493Shannah_mairs   petsc_ctog_sz               = 0.0;
189bec0b493Shannah_mairs   petsc_gtoc_sz               = 0.0;
190958c4211Shannah_mairs   petsc_gflops                = 0.0;
191958c4211Shannah_mairs   petsc_gtime                 = 0.0;
192bec0b493Shannah_mairs   #endif
1935c6c1daeSBarry Smith   PETSC_LARGEST_EVENT         = PETSC_EVENT;
1940298fd71SBarry Smith   PetscLogPHC                 = NULL;
1950298fd71SBarry Smith   PetscLogPHD                 = NULL;
1960298fd71SBarry Smith   petsc_tracefile             = NULL;
1975c6c1daeSBarry Smith   petsc_tracelevel            = 0;
1985c6c1daeSBarry Smith   petsc_traceblanks           = "                                                                                                    ";
1995c6c1daeSBarry Smith   petsc_tracespace[0]         = ' '; petsc_tracespace[1] = 0;
2005c6c1daeSBarry Smith   petsc_tracetime             = 0.0;
2015c6c1daeSBarry Smith   PETSC_LARGEST_CLASSID       = PETSC_SMALLEST_CLASSID;
2025c6c1daeSBarry Smith   PETSC_OBJECT_CLASSID        = 0;
20302c9f0b5SLisandro Dalcin   petsc_stageLog              = NULL;
204896238b9SBarry Smith   PetscLogInitializeCalled    = PETSC_FALSE;
2055c6c1daeSBarry Smith   PetscFunctionReturn(0);
2065c6c1daeSBarry Smith }
2075c6c1daeSBarry Smith 
2085c6c1daeSBarry Smith /*@C
2095c6c1daeSBarry Smith   PetscLogSet - Sets the logging functions called at the beginning and ending of every event.
2105c6c1daeSBarry Smith 
2115c6c1daeSBarry Smith   Not Collective
2125c6c1daeSBarry Smith 
2135c6c1daeSBarry Smith   Input Parameters:
2145c6c1daeSBarry Smith + b - The function called at beginning of event
2155c6c1daeSBarry Smith - e - The function called at end of event
2165c6c1daeSBarry Smith 
2175c6c1daeSBarry Smith   Level: developer
2185c6c1daeSBarry Smith 
219bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogTraceBegin()
2205c6c1daeSBarry Smith @*/
2215c6c1daeSBarry Smith PetscErrorCode  PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject),
2225c6c1daeSBarry Smith                             PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject))
2235c6c1daeSBarry Smith {
2245c6c1daeSBarry Smith   PetscFunctionBegin;
2255c6c1daeSBarry Smith   PetscLogPLB = b;
2265c6c1daeSBarry Smith   PetscLogPLE = e;
2275c6c1daeSBarry Smith   PetscFunctionReturn(0);
2285c6c1daeSBarry Smith }
2295c6c1daeSBarry Smith 
2305c6c1daeSBarry Smith /*@C
231bb1d7374SBarry Smith   PetscLogDefaultBegin - Turns on logging of objects and events. This logs flop
2325c6c1daeSBarry Smith   rates and object creation and should not slow programs down too much.
2335c6c1daeSBarry Smith   This routine may be called more than once.
2345c6c1daeSBarry Smith 
2355c6c1daeSBarry Smith   Logically Collective over PETSC_COMM_WORLD
2365c6c1daeSBarry Smith 
2375c6c1daeSBarry Smith   Options Database Keys:
238a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the
239a2553e36SBarry Smith                   screen (for code configured with --with-log=1 (which is the default))
2405c6c1daeSBarry Smith 
2415c6c1daeSBarry Smith   Usage:
2425c6c1daeSBarry Smith .vb
2435c6c1daeSBarry Smith       PetscInitialize(...);
244bb1d7374SBarry Smith       PetscLogDefaultBegin();
2455c6c1daeSBarry Smith        ... code ...
2465c6c1daeSBarry Smith       PetscLogView(viewer); or PetscLogDump();
2475c6c1daeSBarry Smith       PetscFinalize();
2485c6c1daeSBarry Smith .ve
2495c6c1daeSBarry Smith 
2505c6c1daeSBarry Smith   Notes:
2515c6c1daeSBarry Smith   PetscLogView(viewer) or PetscLogDump() actually cause the printing of
2525c6c1daeSBarry Smith   the logging information.
2535c6c1daeSBarry Smith 
2545c6c1daeSBarry Smith   Level: advanced
2555c6c1daeSBarry Smith 
2565c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogTraceBegin()
2575c6c1daeSBarry Smith @*/
258bb1d7374SBarry Smith PetscErrorCode  PetscLogDefaultBegin(void)
2595c6c1daeSBarry Smith {
2605c6c1daeSBarry Smith   PetscErrorCode ierr;
2615c6c1daeSBarry Smith 
2625c6c1daeSBarry Smith   PetscFunctionBegin;
2635c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault);CHKERRQ(ierr);
2645c6c1daeSBarry Smith   PetscFunctionReturn(0);
2655c6c1daeSBarry Smith }
2665c6c1daeSBarry Smith 
2675c6c1daeSBarry Smith /*@C
2685c6c1daeSBarry Smith   PetscLogAllBegin - Turns on extensive logging of objects and events. Logs
2695c6c1daeSBarry Smith   all events. This creates large log files and slows the program down.
2705c6c1daeSBarry Smith 
2715c6c1daeSBarry Smith   Logically Collective on PETSC_COMM_WORLD
2725c6c1daeSBarry Smith 
2735c6c1daeSBarry Smith   Options Database Keys:
274a2553e36SBarry Smith . -log_all - Prints extensive log information
2755c6c1daeSBarry Smith 
2765c6c1daeSBarry Smith   Usage:
2775c6c1daeSBarry Smith .vb
2785c6c1daeSBarry Smith      PetscInitialize(...);
2795c6c1daeSBarry Smith      PetscLogAllBegin();
2805c6c1daeSBarry Smith      ... code ...
2815c6c1daeSBarry Smith      PetscLogDump(filename);
2825c6c1daeSBarry Smith      PetscFinalize();
2835c6c1daeSBarry Smith .ve
2845c6c1daeSBarry Smith 
2855c6c1daeSBarry Smith   Notes:
286bb1d7374SBarry Smith   A related routine is PetscLogDefaultBegin() (with the options key -log), which is
2875c6c1daeSBarry Smith   intended for production runs since it logs only flop rates and object
2885c6c1daeSBarry Smith   creation (and shouldn't significantly slow the programs).
2895c6c1daeSBarry Smith 
2905c6c1daeSBarry Smith   Level: advanced
2915c6c1daeSBarry Smith 
292bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogTraceBegin()
2935c6c1daeSBarry Smith @*/
2945c6c1daeSBarry Smith PetscErrorCode  PetscLogAllBegin(void)
2955c6c1daeSBarry Smith {
2965c6c1daeSBarry Smith   PetscErrorCode ierr;
2975c6c1daeSBarry Smith 
2985c6c1daeSBarry Smith   PetscFunctionBegin;
2995c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete);CHKERRQ(ierr);
3005c6c1daeSBarry Smith   PetscFunctionReturn(0);
3015c6c1daeSBarry Smith }
3025c6c1daeSBarry Smith 
303956f8c0dSBarry Smith /*@C
3045c6c1daeSBarry Smith   PetscLogTraceBegin - Activates trace logging.  Every time a PETSc event
3055c6c1daeSBarry Smith   begins or ends, the event name is printed.
3065c6c1daeSBarry Smith 
3075c6c1daeSBarry Smith   Logically Collective on PETSC_COMM_WORLD
3085c6c1daeSBarry Smith 
3095c6c1daeSBarry Smith   Input Parameter:
3105c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout)
3115c6c1daeSBarry Smith 
3125c6c1daeSBarry Smith   Options Database Key:
3135c6c1daeSBarry Smith . -log_trace [filename] - Activates PetscLogTraceBegin()
3145c6c1daeSBarry Smith 
3155c6c1daeSBarry Smith   Notes:
3165c6c1daeSBarry Smith   PetscLogTraceBegin() prints the processor number, the execution time (sec),
3175c6c1daeSBarry Smith   then "Event begin:" or "Event end:" followed by the event name.
3185c6c1daeSBarry Smith 
3195c6c1daeSBarry Smith   PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful
3205c6c1daeSBarry Smith   to determine where a program is hanging without running in the
3215c6c1daeSBarry Smith   debugger.  Can be used in conjunction with the -info option.
3225c6c1daeSBarry Smith 
3235c6c1daeSBarry Smith   Level: intermediate
3245c6c1daeSBarry Smith 
325bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogDefaultBegin()
3265c6c1daeSBarry Smith @*/
3275c6c1daeSBarry Smith PetscErrorCode  PetscLogTraceBegin(FILE *file)
3285c6c1daeSBarry Smith {
3295c6c1daeSBarry Smith   PetscErrorCode ierr;
3305c6c1daeSBarry Smith 
3315c6c1daeSBarry Smith   PetscFunctionBegin;
3325c6c1daeSBarry Smith   petsc_tracefile = file;
333a297a907SKarl Rupp 
3345c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace);CHKERRQ(ierr);
3355c6c1daeSBarry Smith   PetscFunctionReturn(0);
3365c6c1daeSBarry Smith }
3375c6c1daeSBarry Smith 
3385c6c1daeSBarry Smith /*@
3395c6c1daeSBarry Smith   PetscLogActions - Determines whether actions are logged for the graphical viewer.
3405c6c1daeSBarry Smith 
3415c6c1daeSBarry Smith   Not Collective
3425c6c1daeSBarry Smith 
3435c6c1daeSBarry Smith   Input Parameter:
3445c6c1daeSBarry Smith . flag - PETSC_TRUE if actions are to be logged
3455c6c1daeSBarry Smith 
3465c6c1daeSBarry Smith   Level: intermediate
3475c6c1daeSBarry Smith 
3485c6c1daeSBarry Smith   Note: Logging of actions continues to consume more memory as the program
3495c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
3505c6c1daeSBarry Smith 
3515c6c1daeSBarry Smith   Options Database Keys:
3525c6c1daeSBarry Smith . -log_exclude_actions - Turns off actions logging
3535c6c1daeSBarry Smith 
3545c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
3555c6c1daeSBarry Smith @*/
3565c6c1daeSBarry Smith PetscErrorCode  PetscLogActions(PetscBool flag)
3575c6c1daeSBarry Smith {
3585c6c1daeSBarry Smith   PetscFunctionBegin;
3595c6c1daeSBarry Smith   petsc_logActions = flag;
3605c6c1daeSBarry Smith   PetscFunctionReturn(0);
3615c6c1daeSBarry Smith }
3625c6c1daeSBarry Smith 
3635c6c1daeSBarry Smith /*@
3645c6c1daeSBarry Smith   PetscLogObjects - Determines whether objects are logged for the graphical viewer.
3655c6c1daeSBarry Smith 
3665c6c1daeSBarry Smith   Not Collective
3675c6c1daeSBarry Smith 
3685c6c1daeSBarry Smith   Input Parameter:
3695c6c1daeSBarry Smith . flag - PETSC_TRUE if objects are to be logged
3705c6c1daeSBarry Smith 
3715c6c1daeSBarry Smith   Level: intermediate
3725c6c1daeSBarry Smith 
3735c6c1daeSBarry Smith   Note: Logging of objects continues to consume more memory as the program
3745c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
3755c6c1daeSBarry Smith 
3765c6c1daeSBarry Smith   Options Database Keys:
3775c6c1daeSBarry Smith . -log_exclude_objects - Turns off objects logging
3785c6c1daeSBarry Smith 
3795c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
3805c6c1daeSBarry Smith @*/
3815c6c1daeSBarry Smith PetscErrorCode  PetscLogObjects(PetscBool flag)
3825c6c1daeSBarry Smith {
3835c6c1daeSBarry Smith   PetscFunctionBegin;
3845c6c1daeSBarry Smith   petsc_logObjects = flag;
3855c6c1daeSBarry Smith   PetscFunctionReturn(0);
3865c6c1daeSBarry Smith }
3875c6c1daeSBarry Smith 
3885c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/
3895c6c1daeSBarry Smith /*@C
39074c0405dSRichard Tran Mills   PetscLogStageRegister - Attaches a character string name to a logging stage.
3915c6c1daeSBarry Smith 
3925c6c1daeSBarry Smith   Not Collective
3935c6c1daeSBarry Smith 
3945c6c1daeSBarry Smith   Input Parameter:
3955c6c1daeSBarry Smith . sname - The name to associate with that stage
3965c6c1daeSBarry Smith 
3975c6c1daeSBarry Smith   Output Parameter:
3985c6c1daeSBarry Smith . stage - The stage number
3995c6c1daeSBarry Smith 
4005c6c1daeSBarry Smith   Level: intermediate
4015c6c1daeSBarry Smith 
4025c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
4035c6c1daeSBarry Smith @*/
4045c6c1daeSBarry Smith PetscErrorCode  PetscLogStageRegister(const char sname[],PetscLogStage *stage)
4055c6c1daeSBarry Smith {
4065c6c1daeSBarry Smith   PetscStageLog  stageLog;
4075c6c1daeSBarry Smith   PetscLogEvent  event;
4085c6c1daeSBarry Smith   PetscErrorCode ierr;
4095c6c1daeSBarry Smith 
4105c6c1daeSBarry Smith   PetscFunctionBegin;
4115c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
4125c6c1daeSBarry Smith   ierr = PetscStageLogRegister(stageLog, sname, stage);CHKERRQ(ierr);
4135c6c1daeSBarry Smith   /* Copy events already changed in the main stage, this sucks */
4143a88037aSBarry Smith   ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr);
4155c6c1daeSBarry Smith   for (event = 0; event < stageLog->eventLog->numEvents; event++) {
4163a88037aSBarry Smith     ierr = PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event],&stageLog->stageInfo[*stage].eventLog->eventInfo[event]);CHKERRQ(ierr);
4175c6c1daeSBarry Smith   }
4183a88037aSBarry Smith   ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
4195c6c1daeSBarry Smith   PetscFunctionReturn(0);
4205c6c1daeSBarry Smith }
4215c6c1daeSBarry Smith 
4225c6c1daeSBarry Smith /*@C
4235c6c1daeSBarry Smith   PetscLogStagePush - This function pushes a stage on the stack.
4245c6c1daeSBarry Smith 
4255c6c1daeSBarry Smith   Not Collective
4265c6c1daeSBarry Smith 
4275c6c1daeSBarry Smith   Input Parameter:
4285c6c1daeSBarry Smith . stage - The stage on which to log
4295c6c1daeSBarry Smith 
4305c6c1daeSBarry Smith   Usage:
4315c6c1daeSBarry Smith   If the option -log_sumary is used to run the program containing the
4325c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
4335c6c1daeSBarry Smith   PetscFinalize().
4345c6c1daeSBarry Smith .vb
4355c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
4365c6c1daeSBarry Smith       [stage 0 of code]
4375c6c1daeSBarry Smith       PetscLogStagePush(1);
4385c6c1daeSBarry Smith       [stage 1 of code]
4395c6c1daeSBarry Smith       PetscLogStagePop();
4405c6c1daeSBarry Smith       PetscBarrier(...);
4415c6c1daeSBarry Smith       [more stage 0 of code]
4425c6c1daeSBarry Smith       PetscFinalize();
4435c6c1daeSBarry Smith .ve
4445c6c1daeSBarry Smith 
4455c6c1daeSBarry Smith   Notes:
4465c6c1daeSBarry Smith   Use PetscLogStageRegister() to register a stage.
4475c6c1daeSBarry Smith 
4485c6c1daeSBarry Smith   Level: intermediate
4495c6c1daeSBarry Smith 
4505c6c1daeSBarry Smith .seealso: PetscLogStagePop(), PetscLogStageRegister(), PetscBarrier()
4515c6c1daeSBarry Smith @*/
4525c6c1daeSBarry Smith PetscErrorCode  PetscLogStagePush(PetscLogStage stage)
4535c6c1daeSBarry Smith {
4545c6c1daeSBarry Smith   PetscStageLog  stageLog;
4555c6c1daeSBarry Smith   PetscErrorCode ierr;
4565c6c1daeSBarry Smith 
4575c6c1daeSBarry Smith   PetscFunctionBegin;
4585c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
4595c6c1daeSBarry Smith   ierr = PetscStageLogPush(stageLog, stage);CHKERRQ(ierr);
4605c6c1daeSBarry Smith   PetscFunctionReturn(0);
4615c6c1daeSBarry Smith }
4625c6c1daeSBarry Smith 
4635c6c1daeSBarry Smith /*@C
4645c6c1daeSBarry Smith   PetscLogStagePop - This function pops a stage from the stack.
4655c6c1daeSBarry Smith 
4665c6c1daeSBarry Smith   Not Collective
4675c6c1daeSBarry Smith 
4685c6c1daeSBarry Smith   Usage:
4695c6c1daeSBarry Smith   If the option -log_sumary is used to run the program containing the
4705c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
4715c6c1daeSBarry Smith   PetscFinalize().
4725c6c1daeSBarry Smith .vb
4735c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
4745c6c1daeSBarry Smith       [stage 0 of code]
4755c6c1daeSBarry Smith       PetscLogStagePush(1);
4765c6c1daeSBarry Smith       [stage 1 of code]
4775c6c1daeSBarry Smith       PetscLogStagePop();
4785c6c1daeSBarry Smith       PetscBarrier(...);
4795c6c1daeSBarry Smith       [more stage 0 of code]
4805c6c1daeSBarry Smith       PetscFinalize();
4815c6c1daeSBarry Smith .ve
4825c6c1daeSBarry Smith 
4835c6c1daeSBarry Smith   Notes:
4845c6c1daeSBarry Smith   Use PetscLogStageRegister() to register a stage.
4855c6c1daeSBarry Smith 
4865c6c1daeSBarry Smith   Level: intermediate
4875c6c1daeSBarry Smith 
4885c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStageRegister(), PetscBarrier()
4895c6c1daeSBarry Smith @*/
4905c6c1daeSBarry Smith PetscErrorCode  PetscLogStagePop(void)
4915c6c1daeSBarry Smith {
4925c6c1daeSBarry Smith   PetscStageLog  stageLog;
4935c6c1daeSBarry Smith   PetscErrorCode ierr;
4945c6c1daeSBarry Smith 
4955c6c1daeSBarry Smith   PetscFunctionBegin;
4965c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
4975c6c1daeSBarry Smith   ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr);
4985c6c1daeSBarry Smith   PetscFunctionReturn(0);
4995c6c1daeSBarry Smith }
5005c6c1daeSBarry Smith 
5015c6c1daeSBarry Smith /*@
5025c6c1daeSBarry Smith   PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd().
5035c6c1daeSBarry Smith 
5045c6c1daeSBarry Smith   Not Collective
5055c6c1daeSBarry Smith 
5065c6c1daeSBarry Smith   Input Parameters:
5075c6c1daeSBarry Smith + stage    - The stage
5085c6c1daeSBarry Smith - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE)
5095c6c1daeSBarry Smith 
5105c6c1daeSBarry Smith   Level: intermediate
5115c6c1daeSBarry Smith 
5125c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
5135c6c1daeSBarry Smith @*/
5145c6c1daeSBarry Smith PetscErrorCode  PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive)
5155c6c1daeSBarry Smith {
5165c6c1daeSBarry Smith   PetscStageLog  stageLog;
5175c6c1daeSBarry Smith   PetscErrorCode ierr;
5185c6c1daeSBarry Smith 
5195c6c1daeSBarry Smith   PetscFunctionBegin;
5205c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5215c6c1daeSBarry Smith   ierr = PetscStageLogSetActive(stageLog, stage, isActive);CHKERRQ(ierr);
5225c6c1daeSBarry Smith   PetscFunctionReturn(0);
5235c6c1daeSBarry Smith }
5245c6c1daeSBarry Smith 
5255c6c1daeSBarry Smith /*@
5265c6c1daeSBarry Smith   PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd().
5275c6c1daeSBarry Smith 
5285c6c1daeSBarry Smith   Not Collective
5295c6c1daeSBarry Smith 
5305c6c1daeSBarry Smith   Input Parameter:
5315c6c1daeSBarry Smith . stage    - The stage
5325c6c1daeSBarry Smith 
5335c6c1daeSBarry Smith   Output Parameter:
5345c6c1daeSBarry Smith . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE)
5355c6c1daeSBarry Smith 
5365c6c1daeSBarry Smith   Level: intermediate
5375c6c1daeSBarry Smith 
5385c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
5395c6c1daeSBarry Smith @*/
5405c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetActive(PetscLogStage stage, PetscBool  *isActive)
5415c6c1daeSBarry Smith {
5425c6c1daeSBarry Smith   PetscStageLog  stageLog;
5435c6c1daeSBarry Smith   PetscErrorCode ierr;
5445c6c1daeSBarry Smith 
5455c6c1daeSBarry Smith   PetscFunctionBegin;
5465c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5475c6c1daeSBarry Smith   ierr = PetscStageLogGetActive(stageLog, stage, isActive);CHKERRQ(ierr);
5485c6c1daeSBarry Smith   PetscFunctionReturn(0);
5495c6c1daeSBarry Smith }
5505c6c1daeSBarry Smith 
5515c6c1daeSBarry Smith /*@
5525c6c1daeSBarry Smith   PetscLogStageSetVisible - Determines stage visibility in PetscLogView()
5535c6c1daeSBarry Smith 
5545c6c1daeSBarry Smith   Not Collective
5555c6c1daeSBarry Smith 
5565c6c1daeSBarry Smith   Input Parameters:
5575c6c1daeSBarry Smith + stage     - The stage
5585c6c1daeSBarry Smith - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE)
5595c6c1daeSBarry Smith 
5605c6c1daeSBarry Smith   Level: intermediate
5615c6c1daeSBarry Smith 
5625c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView()
5635c6c1daeSBarry Smith @*/
5645c6c1daeSBarry Smith PetscErrorCode  PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible)
5655c6c1daeSBarry Smith {
5665c6c1daeSBarry Smith   PetscStageLog  stageLog;
5675c6c1daeSBarry Smith   PetscErrorCode ierr;
5685c6c1daeSBarry Smith 
5695c6c1daeSBarry Smith   PetscFunctionBegin;
5705c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5715c6c1daeSBarry Smith   ierr = PetscStageLogSetVisible(stageLog, stage, isVisible);CHKERRQ(ierr);
5725c6c1daeSBarry Smith   PetscFunctionReturn(0);
5735c6c1daeSBarry Smith }
5745c6c1daeSBarry Smith 
5755c6c1daeSBarry Smith /*@
5765c6c1daeSBarry Smith   PetscLogStageGetVisible - Returns stage visibility in PetscLogView()
5775c6c1daeSBarry Smith 
5785c6c1daeSBarry Smith   Not Collective
5795c6c1daeSBarry Smith 
5805c6c1daeSBarry Smith   Input Parameter:
5815c6c1daeSBarry Smith . stage     - The stage
5825c6c1daeSBarry Smith 
5835c6c1daeSBarry Smith   Output Parameter:
5845c6c1daeSBarry Smith . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE)
5855c6c1daeSBarry Smith 
5865c6c1daeSBarry Smith   Level: intermediate
5875c6c1daeSBarry Smith 
5885c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView()
5895c6c1daeSBarry Smith @*/
5905c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetVisible(PetscLogStage stage, PetscBool  *isVisible)
5915c6c1daeSBarry Smith {
5925c6c1daeSBarry Smith   PetscStageLog  stageLog;
5935c6c1daeSBarry Smith   PetscErrorCode ierr;
5945c6c1daeSBarry Smith 
5955c6c1daeSBarry Smith   PetscFunctionBegin;
5965c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5975c6c1daeSBarry Smith   ierr = PetscStageLogGetVisible(stageLog, stage, isVisible);CHKERRQ(ierr);
5985c6c1daeSBarry Smith   PetscFunctionReturn(0);
5995c6c1daeSBarry Smith }
6005c6c1daeSBarry Smith 
6015c6c1daeSBarry Smith /*@C
6025c6c1daeSBarry Smith   PetscLogStageGetId - Returns the stage id when given the stage name.
6035c6c1daeSBarry Smith 
6045c6c1daeSBarry Smith   Not Collective
6055c6c1daeSBarry Smith 
6065c6c1daeSBarry Smith   Input Parameter:
6075c6c1daeSBarry Smith . name  - The stage name
6085c6c1daeSBarry Smith 
6095c6c1daeSBarry Smith   Output Parameter:
6105a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists
6115c6c1daeSBarry Smith 
6125c6c1daeSBarry Smith   Level: intermediate
6135c6c1daeSBarry Smith 
6145c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
6155c6c1daeSBarry Smith @*/
6165c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetId(const char name[], PetscLogStage *stage)
6175c6c1daeSBarry Smith {
6185c6c1daeSBarry Smith   PetscStageLog  stageLog;
6195c6c1daeSBarry Smith   PetscErrorCode ierr;
6205c6c1daeSBarry Smith 
6215c6c1daeSBarry Smith   PetscFunctionBegin;
6225c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
6235c6c1daeSBarry Smith   ierr = PetscStageLogGetStage(stageLog, name, stage);CHKERRQ(ierr);
6245c6c1daeSBarry Smith   PetscFunctionReturn(0);
6255c6c1daeSBarry Smith }
6265c6c1daeSBarry Smith 
6275c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/
6285c6c1daeSBarry Smith /*@C
6295c6c1daeSBarry Smith   PetscLogEventRegister - Registers an event name for logging operations in an application code.
6305c6c1daeSBarry Smith 
6315c6c1daeSBarry Smith   Not Collective
6325c6c1daeSBarry Smith 
6335c6c1daeSBarry Smith   Input Parameter:
6345c6c1daeSBarry Smith + name   - The name associated with the event
6355c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with
6365c6c1daeSBarry Smith            PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones
6375c6c1daeSBarry Smith            are only available in C code
6385c6c1daeSBarry Smith 
6395c6c1daeSBarry Smith   Output Parameter:
6405c6c1daeSBarry Smith . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd().
6415c6c1daeSBarry Smith 
6425c6c1daeSBarry Smith   Example of Usage:
6435c6c1daeSBarry Smith .vb
6445c6c1daeSBarry Smith       PetscLogEvent USER_EVENT;
6455c6c1daeSBarry Smith       PetscClassId classid;
6465c6c1daeSBarry Smith       PetscLogDouble user_event_flops;
6475c6c1daeSBarry Smith       PetscClassIdRegister("class name",&classid);
6485c6c1daeSBarry Smith       PetscLogEventRegister("User event name",classid,&USER_EVENT);
6495c6c1daeSBarry Smith       PetscLogEventBegin(USER_EVENT,0,0,0,0);
6505c6c1daeSBarry Smith          [code segment to monitor]
6515c6c1daeSBarry Smith          PetscLogFlops(user_event_flops);
6525c6c1daeSBarry Smith       PetscLogEventEnd(USER_EVENT,0,0,0,0);
6535c6c1daeSBarry Smith .ve
6545c6c1daeSBarry Smith 
6555c6c1daeSBarry Smith   Notes:
6565c6c1daeSBarry Smith   PETSc automatically logs library events if the code has been
657a2553e36SBarry Smith   configured with --with-log (which is the default) and
658a2553e36SBarry Smith   -log_view or -log_all is specified.  PetscLogEventRegister() is
6595c6c1daeSBarry Smith   intended for logging user events to supplement this PETSc
6605c6c1daeSBarry Smith   information.
6615c6c1daeSBarry Smith 
662495fc317SBarry Smith   PETSc can gather data for use with the utilities Jumpshot
6635c6c1daeSBarry Smith   (part of the MPICH distribution).  If PETSc has been compiled
6645c6c1daeSBarry Smith   with flag -DPETSC_HAVE_MPE (MPE is an additional utility within
6655c6c1daeSBarry Smith   MPICH), the user can employ another command line option, -log_mpe,
6665c6c1daeSBarry Smith   to create a logfile, "mpe.log", which can be visualized
667495fc317SBarry Smith   Jumpshot.
6685c6c1daeSBarry Smith 
6695c6c1daeSBarry Smith   The classid is associated with each event so that classes of events
6705c6c1daeSBarry Smith   can be disabled simultaneously, such as all matrix events. The user
6715c6c1daeSBarry Smith   can either use an existing classid, such as MAT_CLASSID, or create
6725c6c1daeSBarry Smith   their own as shown in the example.
6735c6c1daeSBarry Smith 
674c5deb1d5SJed Brown   If an existing event with the same name exists, its event handle is
675c5deb1d5SJed Brown   returned instead of creating a new event.
676c5deb1d5SJed Brown 
6775c6c1daeSBarry Smith   Level: intermediate
6785c6c1daeSBarry Smith 
6795c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogFlops(),
6805c6c1daeSBarry Smith           PetscLogEventActivate(), PetscLogEventDeactivate(), PetscClassIdRegister()
6815c6c1daeSBarry Smith @*/
6825c6c1daeSBarry Smith PetscErrorCode  PetscLogEventRegister(const char name[],PetscClassId classid,PetscLogEvent *event)
6835c6c1daeSBarry Smith {
6845c6c1daeSBarry Smith   PetscStageLog  stageLog;
6855c6c1daeSBarry Smith   int            stage;
6865c6c1daeSBarry Smith   PetscErrorCode ierr;
6875c6c1daeSBarry Smith 
6885c6c1daeSBarry Smith   PetscFunctionBegin;
6895c6c1daeSBarry Smith   *event = PETSC_DECIDE;
6905c6c1daeSBarry Smith   ierr   = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
6913a88037aSBarry Smith   ierr   = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr);
692c5deb1d5SJed Brown   if (*event > 0) PetscFunctionReturn(0);
6933a88037aSBarry Smith   ierr   = PetscEventRegLogRegister(stageLog->eventLog, name, classid, event);CHKERRQ(ierr);
6945c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
6953a88037aSBarry Smith     ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr);
6963a88037aSBarry Smith     ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
6975c6c1daeSBarry Smith   }
6985c6c1daeSBarry Smith   PetscFunctionReturn(0);
6995c6c1daeSBarry Smith }
7005c6c1daeSBarry Smith 
7015c6c1daeSBarry Smith /*@
702217044c2SLisandro Dalcin   PetscLogEventSetCollective - Indicates that a particular event is collective.
703217044c2SLisandro Dalcin 
704217044c2SLisandro Dalcin   Not Collective
705217044c2SLisandro Dalcin 
706217044c2SLisandro Dalcin   Input Parameter:
707217044c2SLisandro Dalcin + event - The event id
708217044c2SLisandro Dalcin - collective - Bolean flag indicating whether a particular event is collective
709217044c2SLisandro Dalcin 
710217044c2SLisandro Dalcin   Note:
711217044c2SLisandro Dalcin   New events returned from PetscLogEventRegister() are collective by default.
712217044c2SLisandro Dalcin 
713217044c2SLisandro Dalcin   Level: developer
714217044c2SLisandro Dalcin 
715217044c2SLisandro Dalcin .seealso: PetscLogEventRegister()
716217044c2SLisandro Dalcin @*/
717217044c2SLisandro Dalcin PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event,PetscBool collective)
718217044c2SLisandro Dalcin {
719217044c2SLisandro Dalcin   PetscStageLog    stageLog;
720217044c2SLisandro Dalcin   PetscEventRegLog eventRegLog;
721217044c2SLisandro Dalcin   PetscErrorCode   ierr;
722217044c2SLisandro Dalcin 
723217044c2SLisandro Dalcin   PetscFunctionBegin;
724217044c2SLisandro Dalcin   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
725217044c2SLisandro Dalcin   ierr = PetscStageLogGetEventRegLog(stageLog,&eventRegLog);CHKERRQ(ierr);
726217044c2SLisandro Dalcin   if (event < 0 || event > eventRegLog->numEvents) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Invalid event id");
727217044c2SLisandro Dalcin   eventRegLog->eventInfo[event].collective = collective;
728217044c2SLisandro Dalcin   PetscFunctionReturn(0);
729217044c2SLisandro Dalcin }
730217044c2SLisandro Dalcin 
731217044c2SLisandro Dalcin /*@
732fa2bb9feSLisandro Dalcin   PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage.
733fa2bb9feSLisandro Dalcin 
734fa2bb9feSLisandro Dalcin   Not Collective
735fa2bb9feSLisandro Dalcin 
736fa2bb9feSLisandro Dalcin   Input Parameter:
737fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc.
738fa2bb9feSLisandro Dalcin 
739fa2bb9feSLisandro Dalcin   Level: developer
740fa2bb9feSLisandro Dalcin 
741fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate()
742fa2bb9feSLisandro Dalcin @*/
743fa2bb9feSLisandro Dalcin PetscErrorCode  PetscLogEventIncludeClass(PetscClassId classid)
744fa2bb9feSLisandro Dalcin {
745fa2bb9feSLisandro Dalcin   PetscStageLog  stageLog;
746fa2bb9feSLisandro Dalcin   int            stage;
747fa2bb9feSLisandro Dalcin   PetscErrorCode ierr;
748fa2bb9feSLisandro Dalcin 
749fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
750fa2bb9feSLisandro Dalcin   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
751fa2bb9feSLisandro Dalcin   for (stage = 0; stage < stageLog->numStages; stage++) {
752fa2bb9feSLisandro Dalcin     ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
753fa2bb9feSLisandro Dalcin   }
754fa2bb9feSLisandro Dalcin   PetscFunctionReturn(0);
755fa2bb9feSLisandro Dalcin }
756fa2bb9feSLisandro Dalcin 
757fa2bb9feSLisandro Dalcin /*@
758fa2bb9feSLisandro Dalcin   PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage.
759fa2bb9feSLisandro Dalcin 
760fa2bb9feSLisandro Dalcin   Not Collective
761fa2bb9feSLisandro Dalcin 
762fa2bb9feSLisandro Dalcin   Input Parameter:
763fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc.
764fa2bb9feSLisandro Dalcin 
765fa2bb9feSLisandro Dalcin   Level: developer
766fa2bb9feSLisandro Dalcin 
767fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivateClass(),PetscLogEventDeactivate(),PetscLogEventActivate()
768fa2bb9feSLisandro Dalcin @*/
769fa2bb9feSLisandro Dalcin PetscErrorCode  PetscLogEventExcludeClass(PetscClassId classid)
770fa2bb9feSLisandro Dalcin {
771fa2bb9feSLisandro Dalcin   PetscStageLog  stageLog;
772fa2bb9feSLisandro Dalcin   int            stage;
773fa2bb9feSLisandro Dalcin   PetscErrorCode ierr;
774fa2bb9feSLisandro Dalcin 
775fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
776fa2bb9feSLisandro Dalcin   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
777fa2bb9feSLisandro Dalcin   for (stage = 0; stage < stageLog->numStages; stage++) {
778fa2bb9feSLisandro Dalcin     ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
779fa2bb9feSLisandro Dalcin   }
780fa2bb9feSLisandro Dalcin   PetscFunctionReturn(0);
781fa2bb9feSLisandro Dalcin }
782fa2bb9feSLisandro Dalcin 
783fa2bb9feSLisandro Dalcin /*@
7845c6c1daeSBarry Smith   PetscLogEventActivate - Indicates that a particular event should be logged.
7855c6c1daeSBarry Smith 
7865c6c1daeSBarry Smith   Not Collective
7875c6c1daeSBarry Smith 
7885c6c1daeSBarry Smith   Input Parameter:
7895c6c1daeSBarry Smith . event - The event id
7905c6c1daeSBarry Smith 
7915c6c1daeSBarry Smith   Usage:
7925c6c1daeSBarry Smith .vb
7935c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
7945c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
7955c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
7965c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
7975c6c1daeSBarry Smith .ve
7985c6c1daeSBarry Smith 
7995c6c1daeSBarry Smith   Note:
8005c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in include/petsclog.h)
8015c6c1daeSBarry Smith   or an event number obtained with PetscLogEventRegister().
8025c6c1daeSBarry Smith 
8035c6c1daeSBarry Smith   Level: advanced
8045c6c1daeSBarry Smith 
805c00cb57fSBarry Smith .seealso: PlogEventDeactivate(), PlogEventDeactivatePush(), PetscLogEventDeactivatePop()
8065c6c1daeSBarry Smith @*/
8075c6c1daeSBarry Smith PetscErrorCode  PetscLogEventActivate(PetscLogEvent event)
8085c6c1daeSBarry Smith {
8095c6c1daeSBarry Smith   PetscStageLog  stageLog;
8105c6c1daeSBarry Smith   int            stage;
8115c6c1daeSBarry Smith   PetscErrorCode ierr;
8125c6c1daeSBarry Smith 
8135c6c1daeSBarry Smith   PetscFunctionBegin;
8145c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
8155c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
8163a88037aSBarry Smith   ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
8175c6c1daeSBarry Smith   PetscFunctionReturn(0);
8185c6c1daeSBarry Smith }
8195c6c1daeSBarry Smith 
8205c6c1daeSBarry Smith /*@
8215c6c1daeSBarry Smith   PetscLogEventDeactivate - Indicates that a particular event should not be logged.
8225c6c1daeSBarry Smith 
8235c6c1daeSBarry Smith   Not Collective
8245c6c1daeSBarry Smith 
8255c6c1daeSBarry Smith   Input Parameter:
8265c6c1daeSBarry Smith . event - The event id
8275c6c1daeSBarry Smith 
8285c6c1daeSBarry Smith   Usage:
8295c6c1daeSBarry Smith .vb
8305c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
8315c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
8325c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
8335c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
8345c6c1daeSBarry Smith .ve
8355c6c1daeSBarry Smith 
8365c6c1daeSBarry Smith   Note:
8375c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in
8385c6c1daeSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
8395c6c1daeSBarry Smith 
8405c6c1daeSBarry Smith   Level: advanced
8415c6c1daeSBarry Smith 
842c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePush(), PetscLogEventDeactivatePop()
8435c6c1daeSBarry Smith @*/
8445c6c1daeSBarry Smith PetscErrorCode  PetscLogEventDeactivate(PetscLogEvent event)
8455c6c1daeSBarry Smith {
8465c6c1daeSBarry Smith   PetscStageLog  stageLog;
8475c6c1daeSBarry Smith   int            stage;
8485c6c1daeSBarry Smith   PetscErrorCode ierr;
8495c6c1daeSBarry Smith 
8505c6c1daeSBarry Smith   PetscFunctionBegin;
8515c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
8525c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
8533a88037aSBarry Smith   ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
8545c6c1daeSBarry Smith   PetscFunctionReturn(0);
8555c6c1daeSBarry Smith }
8565c6c1daeSBarry Smith 
8575c6c1daeSBarry Smith /*@
858c00cb57fSBarry Smith   PetscLogEventDeactivatePush - Indicates that a particular event should not be logged.
859c00cb57fSBarry Smith 
860c00cb57fSBarry Smith   Not Collective
861c00cb57fSBarry Smith 
862c00cb57fSBarry Smith   Input Parameter:
863c00cb57fSBarry Smith . event - The event id
864c00cb57fSBarry Smith 
865c00cb57fSBarry Smith   Usage:
866c00cb57fSBarry Smith .vb
867c00cb57fSBarry Smith       PetscLogEventDeactivatePush(VEC_SetValues);
868c00cb57fSBarry Smith         [code where you do not want to log VecSetValues()]
869c00cb57fSBarry Smith       PetscLogEventDeactivatePop(VEC_SetValues);
870c00cb57fSBarry Smith         [code where you do want to log VecSetValues()]
871c00cb57fSBarry Smith .ve
872c00cb57fSBarry Smith 
873c00cb57fSBarry Smith   Note:
874c00cb57fSBarry Smith   The event may be either a pre-defined PETSc event (found in
875c00cb57fSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
876c00cb57fSBarry Smith 
877c00cb57fSBarry Smith   Level: advanced
878c00cb57fSBarry Smith 
879c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePop()
880c00cb57fSBarry Smith @*/
881c00cb57fSBarry Smith PetscErrorCode  PetscLogEventDeactivatePush(PetscLogEvent event)
882c00cb57fSBarry Smith {
883c00cb57fSBarry Smith   PetscStageLog  stageLog;
884c00cb57fSBarry Smith   int            stage;
885c00cb57fSBarry Smith   PetscErrorCode ierr;
886c00cb57fSBarry Smith 
887c00cb57fSBarry Smith   PetscFunctionBegin;
888c00cb57fSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
889c00cb57fSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
890c00cb57fSBarry Smith   ierr = PetscEventPerfLogDeactivatePush(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
891c00cb57fSBarry Smith   PetscFunctionReturn(0);
892c00cb57fSBarry Smith }
893c00cb57fSBarry Smith 
894c00cb57fSBarry Smith /*@
895c00cb57fSBarry Smith   PetscLogEventDeactivatePop - Indicates that a particular event shouldbe logged.
896c00cb57fSBarry Smith 
897c00cb57fSBarry Smith   Not Collective
898c00cb57fSBarry Smith 
899c00cb57fSBarry Smith   Input Parameter:
900c00cb57fSBarry Smith . event - The event id
901c00cb57fSBarry Smith 
902c00cb57fSBarry Smith   Usage:
903c00cb57fSBarry Smith .vb
904c00cb57fSBarry Smith       PetscLogEventDeactivatePush(VEC_SetValues);
905c00cb57fSBarry Smith         [code where you do not want to log VecSetValues()]
906c00cb57fSBarry Smith       PetscLogEventDeactivatePop(VEC_SetValues);
907c00cb57fSBarry Smith         [code where you do want to log VecSetValues()]
908c00cb57fSBarry Smith .ve
909c00cb57fSBarry Smith 
910c00cb57fSBarry Smith   Note:
911c00cb57fSBarry Smith   The event may be either a pre-defined PETSc event (found in
912c00cb57fSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
913c00cb57fSBarry Smith 
914c00cb57fSBarry Smith   Level: advanced
915c00cb57fSBarry Smith 
916c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePush()
917c00cb57fSBarry Smith @*/
918c00cb57fSBarry Smith PetscErrorCode  PetscLogEventDeactivatePop(PetscLogEvent event)
919c00cb57fSBarry Smith {
920c00cb57fSBarry Smith   PetscStageLog  stageLog;
921c00cb57fSBarry Smith   int            stage;
922c00cb57fSBarry Smith   PetscErrorCode ierr;
923c00cb57fSBarry Smith 
924c00cb57fSBarry Smith   PetscFunctionBegin;
925c00cb57fSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
926c00cb57fSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
927c00cb57fSBarry Smith   ierr = PetscEventPerfLogDeactivatePop(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
928c00cb57fSBarry Smith   PetscFunctionReturn(0);
929c00cb57fSBarry Smith }
930c00cb57fSBarry Smith 
931c00cb57fSBarry Smith /*@
9325c6c1daeSBarry Smith   PetscLogEventSetActiveAll - Sets the event activity in every stage.
9335c6c1daeSBarry Smith 
9345c6c1daeSBarry Smith   Not Collective
9355c6c1daeSBarry Smith 
9365c6c1daeSBarry Smith   Input Parameters:
9375c6c1daeSBarry Smith + event    - The event id
9385c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged
9395c6c1daeSBarry Smith 
9405c6c1daeSBarry Smith   Level: advanced
9415c6c1daeSBarry Smith 
942ec303c53SPatrick Sanan .seealso: PlogEventActivate(),PlogEventDeactivate()
9435c6c1daeSBarry Smith @*/
9445c6c1daeSBarry Smith PetscErrorCode  PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive)
9455c6c1daeSBarry Smith {
9465c6c1daeSBarry Smith   PetscStageLog  stageLog;
9475c6c1daeSBarry Smith   int            stage;
9485c6c1daeSBarry Smith   PetscErrorCode ierr;
9495c6c1daeSBarry Smith 
9505c6c1daeSBarry Smith   PetscFunctionBegin;
9515c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
9525c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
9535c6c1daeSBarry Smith     if (isActive) {
9543a88037aSBarry Smith       ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
9555c6c1daeSBarry Smith     } else {
9563a88037aSBarry Smith       ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
9575c6c1daeSBarry Smith     }
9585c6c1daeSBarry Smith   }
9595c6c1daeSBarry Smith   PetscFunctionReturn(0);
9605c6c1daeSBarry Smith }
9615c6c1daeSBarry Smith 
9625c6c1daeSBarry Smith /*@
9635c6c1daeSBarry Smith   PetscLogEventActivateClass - Activates event logging for a PETSc object class.
9645c6c1daeSBarry Smith 
9655c6c1daeSBarry Smith   Not Collective
9665c6c1daeSBarry Smith 
9675c6c1daeSBarry Smith   Input Parameter:
9685c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc.
9695c6c1daeSBarry Smith 
9705c6c1daeSBarry Smith   Level: developer
9715c6c1daeSBarry Smith 
972fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate()
9735c6c1daeSBarry Smith @*/
9745c6c1daeSBarry Smith PetscErrorCode  PetscLogEventActivateClass(PetscClassId classid)
9755c6c1daeSBarry Smith {
9765c6c1daeSBarry Smith   PetscStageLog  stageLog;
9775c6c1daeSBarry Smith   int            stage;
9785c6c1daeSBarry Smith   PetscErrorCode ierr;
9795c6c1daeSBarry Smith 
9805c6c1daeSBarry Smith   PetscFunctionBegin;
9815c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
9825c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
9833a88037aSBarry Smith   ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
9845c6c1daeSBarry Smith   PetscFunctionReturn(0);
9855c6c1daeSBarry Smith }
9865c6c1daeSBarry Smith 
9875c6c1daeSBarry Smith /*@
9885c6c1daeSBarry Smith   PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class.
9895c6c1daeSBarry Smith 
9905c6c1daeSBarry Smith   Not Collective
9915c6c1daeSBarry Smith 
9925c6c1daeSBarry Smith   Input Parameter:
9935c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc.
9945c6c1daeSBarry Smith 
9955c6c1daeSBarry Smith   Level: developer
9965c6c1daeSBarry Smith 
997fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate()
9985c6c1daeSBarry Smith @*/
9995c6c1daeSBarry Smith PetscErrorCode  PetscLogEventDeactivateClass(PetscClassId classid)
10005c6c1daeSBarry Smith {
10015c6c1daeSBarry Smith   PetscStageLog  stageLog;
10025c6c1daeSBarry Smith   int            stage;
10035c6c1daeSBarry Smith   PetscErrorCode ierr;
10045c6c1daeSBarry Smith 
10055c6c1daeSBarry Smith   PetscFunctionBegin;
10065c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
10075c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
10083a88037aSBarry Smith   ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
10095c6c1daeSBarry Smith   PetscFunctionReturn(0);
10105c6c1daeSBarry Smith }
10115c6c1daeSBarry Smith 
10125c6c1daeSBarry Smith /*MC
101362872c28SLisandro Dalcin    PetscLogEventSync - Synchronizes the beginning of a user event.
101462872c28SLisandro Dalcin 
101562872c28SLisandro Dalcin    Synopsis:
101662872c28SLisandro Dalcin    #include <petsclog.h>
101762872c28SLisandro Dalcin    PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm)
101862872c28SLisandro Dalcin 
101962872c28SLisandro Dalcin    Collective
102062872c28SLisandro Dalcin 
102162872c28SLisandro Dalcin    Input Parameters:
102262872c28SLisandro Dalcin +  e - integer associated with the event obtained from PetscLogEventRegister()
102362872c28SLisandro Dalcin -  comm - an MPI communicator
102462872c28SLisandro Dalcin 
102562872c28SLisandro Dalcin    Usage:
102662872c28SLisandro Dalcin .vb
102762872c28SLisandro Dalcin      PetscLogEvent USER_EVENT;
102862872c28SLisandro Dalcin      PetscLogEventRegister("User event",0,&USER_EVENT);
102962872c28SLisandro Dalcin      PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD);
103062872c28SLisandro Dalcin      PetscLogEventBegin(USER_EVENT,0,0,0,0);
103162872c28SLisandro Dalcin         [code segment to monitor]
103262872c28SLisandro Dalcin      PetscLogEventEnd(USER_EVENT,0,0,0,0);
103362872c28SLisandro Dalcin .ve
103462872c28SLisandro Dalcin 
103562872c28SLisandro Dalcin    Notes:
103662872c28SLisandro Dalcin    This routine should be called only if there is not a
103762872c28SLisandro Dalcin    PetscObject available to pass to PetscLogEventBegin().
103862872c28SLisandro Dalcin 
103962872c28SLisandro Dalcin    Level: developer
104062872c28SLisandro Dalcin 
104162872c28SLisandro Dalcin .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd()
104262872c28SLisandro Dalcin 
104362872c28SLisandro Dalcin M*/
104462872c28SLisandro Dalcin 
104562872c28SLisandro Dalcin /*MC
10465c6c1daeSBarry Smith    PetscLogEventBegin - Logs the beginning of a user event.
10475c6c1daeSBarry Smith 
10485c6c1daeSBarry Smith    Synopsis:
1049aaa7dc30SBarry Smith    #include <petsclog.h>
1050f2ba6396SBarry Smith    PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
10515c6c1daeSBarry Smith 
10525c6c1daeSBarry Smith    Not Collective
10535c6c1daeSBarry Smith 
10545c6c1daeSBarry Smith    Input Parameters:
10555c6c1daeSBarry Smith +  e - integer associated with the event obtained from PetscLogEventRegister()
10565c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
10575c6c1daeSBarry Smith 
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 
10975c6c1daeSBarry Smith    Fortran Synopsis:
10985c6c1daeSBarry Smith    void PetscLogEventEnd(int e,PetscErrorCode ierr)
10995c6c1daeSBarry Smith 
11005c6c1daeSBarry Smith    Usage:
11015c6c1daeSBarry Smith .vb
11025c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
11035c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
11045c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT,);
11055c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
11065c6c1daeSBarry Smith         [code segment to monitor]
11075c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
11085c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
11095c6c1daeSBarry Smith .ve
11105c6c1daeSBarry Smith 
11115c6c1daeSBarry Smith    Notes:
11125c6c1daeSBarry Smith    You should also register each additional integer event with the command
1113a2553e36SBarry Smith    PetscLogEventRegister().
11145c6c1daeSBarry Smith 
11155c6c1daeSBarry Smith    Level: intermediate
11165c6c1daeSBarry Smith 
11175c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogFlops()
11185c6c1daeSBarry Smith 
11195c6c1daeSBarry Smith M*/
11205c6c1daeSBarry Smith 
11215c6c1daeSBarry Smith /*@C
11225c6c1daeSBarry Smith   PetscLogEventGetId - Returns the event id when given the event name.
11235c6c1daeSBarry Smith 
11245c6c1daeSBarry Smith   Not Collective
11255c6c1daeSBarry Smith 
11265c6c1daeSBarry Smith   Input Parameter:
11275c6c1daeSBarry Smith . name  - The event name
11285c6c1daeSBarry Smith 
11295c6c1daeSBarry Smith   Output Parameter:
1130c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists
11315c6c1daeSBarry Smith 
11325c6c1daeSBarry Smith   Level: intermediate
11335c6c1daeSBarry Smith 
11345c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStageGetId()
11355c6c1daeSBarry Smith @*/
11365c6c1daeSBarry Smith PetscErrorCode  PetscLogEventGetId(const char name[], PetscLogEvent *event)
11375c6c1daeSBarry Smith {
11385c6c1daeSBarry Smith   PetscStageLog  stageLog;
11395c6c1daeSBarry Smith   PetscErrorCode ierr;
11405c6c1daeSBarry Smith 
11415c6c1daeSBarry Smith   PetscFunctionBegin;
11425c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
11433a88037aSBarry Smith   ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr);
11445c6c1daeSBarry Smith   PetscFunctionReturn(0);
11455c6c1daeSBarry Smith }
11465c6c1daeSBarry Smith 
11475c6c1daeSBarry Smith 
11485c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/
11495c6c1daeSBarry Smith /*@C
11505c6c1daeSBarry Smith   PetscLogDump - Dumps logs of objects to a file. This file is intended to
11515c6c1daeSBarry Smith   be read by bin/petscview. This program no longer exists.
11525c6c1daeSBarry Smith 
11535c6c1daeSBarry Smith   Collective on PETSC_COMM_WORLD
11545c6c1daeSBarry Smith 
11555c6c1daeSBarry Smith   Input Parameter:
11565c6c1daeSBarry Smith . name - an optional file name
11575c6c1daeSBarry Smith 
11585c6c1daeSBarry Smith   Usage:
11595c6c1daeSBarry Smith .vb
11605c6c1daeSBarry Smith      PetscInitialize(...);
1161bb1d7374SBarry Smith      PetscLogDefaultBegin(); or PetscLogAllBegin();
11625c6c1daeSBarry Smith      ... code ...
11635c6c1daeSBarry Smith      PetscLogDump(filename);
11645c6c1daeSBarry Smith      PetscFinalize();
11655c6c1daeSBarry Smith .ve
11665c6c1daeSBarry Smith 
11675c6c1daeSBarry Smith   Notes:
11685c6c1daeSBarry Smith   The default file name is
11695c6c1daeSBarry Smith $    Log.<rank>
11705c6c1daeSBarry Smith   where <rank> is the processor number. If no name is specified,
11715c6c1daeSBarry Smith   this file will be used.
11725c6c1daeSBarry Smith 
11735c6c1daeSBarry Smith   Level: advanced
11745c6c1daeSBarry Smith 
1175bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogView()
11765c6c1daeSBarry Smith @*/
11775c6c1daeSBarry Smith PetscErrorCode  PetscLogDump(const char sname[])
11785c6c1daeSBarry Smith {
11795c6c1daeSBarry Smith   PetscStageLog      stageLog;
11805c6c1daeSBarry Smith   PetscEventPerfInfo *eventInfo;
11815c6c1daeSBarry Smith   FILE               *fd;
11825c6c1daeSBarry Smith   char               file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN];
11835c6c1daeSBarry Smith   PetscLogDouble     flops, _TotalTime;
11845c6c1daeSBarry Smith   PetscMPIInt        rank;
11855c6c1daeSBarry Smith   int                action, object, curStage;
11865c6c1daeSBarry Smith   PetscLogEvent      event;
11875c6c1daeSBarry Smith   PetscErrorCode     ierr;
11885c6c1daeSBarry Smith 
11895c6c1daeSBarry Smith   PetscFunctionBegin;
11905c6c1daeSBarry Smith   /* Calculate the total elapsed time */
11918563dfccSBarry Smith   PetscTime(&_TotalTime);
11925c6c1daeSBarry Smith   _TotalTime -= petsc_BaseTime;
11935c6c1daeSBarry Smith   /* Open log file */
1194ffc4695bSBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank);CHKERRMPI(ierr);
11957ff663adSLisandro Dalcin   if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank);
1196a297a907SKarl Rupp   else sprintf(file, "Log.%d", rank);
11975c6c1daeSBarry Smith   ierr = PetscFixFilename(file, fname);CHKERRQ(ierr);
11985c6c1daeSBarry Smith   ierr = PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd);CHKERRQ(ierr);
11995c6c1daeSBarry Smith   if ((!rank) && (!fd)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname);
12005c6c1daeSBarry Smith   /* Output totals */
1201d4aa7d5fSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime);CHKERRQ(ierr);
1202a2ea699eSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0);CHKERRQ(ierr);
12035c6c1daeSBarry Smith   /* Output actions */
12045c6c1daeSBarry Smith   if (petsc_logActions) {
1205a2ea699eSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions);CHKERRQ(ierr);
12065c6c1daeSBarry Smith     for (action = 0; action < petsc_numActions; action++) {
12075c6c1daeSBarry Smith       ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n",
12085c6c1daeSBarry Smith                           petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1,
1209a2ea699eSBarry Smith                           petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem);CHKERRQ(ierr);
12105c6c1daeSBarry Smith     }
12115c6c1daeSBarry Smith   }
12125c6c1daeSBarry Smith   /* Output objects */
12135c6c1daeSBarry Smith   if (petsc_logObjects) {
1214a2ea699eSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed);CHKERRQ(ierr);
12155c6c1daeSBarry Smith     for (object = 0; object < petsc_numObjects; object++) {
1216a2ea699eSBarry Smith       ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int) petsc_objects[object].mem);CHKERRQ(ierr);
12175c6c1daeSBarry Smith       if (!petsc_objects[object].name[0]) {
1218a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd,"No Name\n");CHKERRQ(ierr);
12195c6c1daeSBarry Smith       } else {
1220a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name);CHKERRQ(ierr);
12215c6c1daeSBarry Smith       }
12225c6c1daeSBarry Smith       if (petsc_objects[object].info[0] != 0) {
1223a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n");CHKERRQ(ierr);
12245c6c1daeSBarry Smith       } else {
1225a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info);CHKERRQ(ierr);
12265c6c1daeSBarry Smith       }
12275c6c1daeSBarry Smith     }
12285c6c1daeSBarry Smith   }
12295c6c1daeSBarry Smith   /* Output events */
1230a2ea699eSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n");CHKERRQ(ierr);
12315c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
12325c6c1daeSBarry Smith   ierr = PetscIntStackTop(stageLog->stack, &curStage);CHKERRQ(ierr);
12335c6c1daeSBarry Smith   eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo;
12345c6c1daeSBarry Smith   for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) {
1235a297a907SKarl Rupp     if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops/eventInfo[event].time;
1236a297a907SKarl Rupp     else flops = 0.0;
12375c6c1daeSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count,
1238a2ea699eSBarry Smith                         eventInfo[event].flops, eventInfo[event].time, flops);CHKERRQ(ierr);
12395c6c1daeSBarry Smith   }
12405c6c1daeSBarry Smith   ierr = PetscFClose(PETSC_COMM_WORLD, fd);CHKERRQ(ierr);
12415c6c1daeSBarry Smith   PetscFunctionReturn(0);
12425c6c1daeSBarry Smith }
12435c6c1daeSBarry Smith 
1244f14045dbSBarry Smith /*
1245f14045dbSBarry Smith   PetscLogView_Detailed - Each process prints the times for its own events
1246f14045dbSBarry Smith 
1247f14045dbSBarry Smith */
1248f14045dbSBarry Smith PetscErrorCode  PetscLogView_Detailed(PetscViewer viewer)
1249f14045dbSBarry Smith {
12502dff6485SMatthew G. Knepley   PetscStageLog      stageLog;
1251217044c2SLisandro Dalcin   PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL;
1252217044c2SLisandro Dalcin   PetscLogDouble     locTotalTime, numRed, maxMem;
12532dff6485SMatthew G. Knepley   int                numStages,numEvents,stage,event;
1254217044c2SLisandro Dalcin   MPI_Comm           comm = PetscObjectComm((PetscObject) viewer);
12552dff6485SMatthew G. Knepley   PetscMPIInt        rank,size;
12562dff6485SMatthew G. Knepley   PetscErrorCode     ierr;
1257f14045dbSBarry Smith 
1258f14045dbSBarry Smith   PetscFunctionBegin;
1259ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
1260ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
12612dff6485SMatthew G. Knepley   /* Must preserve reduction count before we go on */
12622dff6485SMatthew G. Knepley   numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
12632d1ec343SBarry Smith   /* Get the total elapsed time */
12642d1ec343SBarry Smith   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
12659852e123SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"size = %d\n",size);CHKERRQ(ierr);
12662d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"LocalTimes = {}\n");CHKERRQ(ierr);
12672d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"LocalMessages = {}\n");CHKERRQ(ierr);
1268217044c2SLisandro Dalcin   ierr = PetscViewerASCIIPrintf(viewer,"LocalMessageLens = {}\n");CHKERRQ(ierr);
12692d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"LocalReductions = {}\n");CHKERRQ(ierr);
1270217044c2SLisandro Dalcin   ierr = PetscViewerASCIIPrintf(viewer,"LocalFlop = {}\n");CHKERRQ(ierr);
12712dff6485SMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer,"LocalObjects = {}\n");CHKERRQ(ierr);
12722dff6485SMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer,"LocalMemory = {}\n");CHKERRQ(ierr);
12732d1ec343SBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
1274b2566f29SBarry Smith   ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
12752d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"Stages = {}\n");CHKERRQ(ierr);
12762d1ec343SBarry Smith   for (stage=0; stage<numStages; stage++) {
12772d1ec343SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr);
127861917356SPatrick Sanan     ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"summary\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr);
1279b2566f29SBarry Smith     ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
12802d1ec343SBarry Smith     for (event = 0; event < numEvents; event++) {
12812d1ec343SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"%s\"] = {}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name);CHKERRQ(ierr);
12822d1ec343SBarry Smith     }
12832d1ec343SBarry Smith   }
1284217044c2SLisandro Dalcin   ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr);
12851575c14dSBarry Smith   ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
12862d1ec343SBarry Smith   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalTimes[%d] = %g\n",rank,locTotalTime);CHKERRQ(ierr);
12872d1ec343SBarry Smith   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessages[%d] = %g\n",rank,(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct));CHKERRQ(ierr);
1288217044c2SLisandro Dalcin   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessageLens[%d] = %g\n",rank,(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len));CHKERRQ(ierr);
12892dff6485SMatthew G. Knepley   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalReductions[%d] = %g\n",rank,numRed);CHKERRQ(ierr);
1290217044c2SLisandro Dalcin   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalFlop[%d] = %g\n",rank,petsc_TotalFlops);CHKERRQ(ierr);
1291ba67d37fSBarry Smith   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalObjects[%d] = %d\n",rank,petsc_numObjects);CHKERRQ(ierr);
12922dff6485SMatthew G. Knepley   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMemory[%d] = %g\n",rank,maxMem);CHKERRQ(ierr);
12932d1ec343SBarry Smith   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
12942d1ec343SBarry Smith   for (stage=0; stage<numStages; stage++) {
1295217044c2SLisandro Dalcin     stageInfo = &stageLog->stageInfo[stage].perfInfo;
1296d4aa7d5fSBarry Smith     ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n",
12972dff6485SMatthew G. Knepley                                               stageLog->stageInfo[stage].name,rank,
1298217044c2SLisandro Dalcin                                               stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr);
1299b2566f29SBarry Smith     ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
13002d1ec343SBarry Smith     for (event = 0; event < numEvents; event++) {
1301217044c2SLisandro Dalcin       eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event];
1302c15bc2c4SMatthew G. Knepley       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %D, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g",
1303217044c2SLisandro Dalcin                                                 stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name,rank,
1304217044c2SLisandro Dalcin                                                 eventInfo->count,eventInfo->time,eventInfo->syncTime,eventInfo->numMessages,eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr);
1305891e75beSMatthew G. Knepley       if (eventInfo->dof[0] >= 0.) {
1306891e75beSMatthew G. Knepley         PetscInt d, e;
13075d68e14cSMatthew G. Knepley 
1308891e75beSMatthew G. Knepley         ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : [");CHKERRQ(ierr);
1309891e75beSMatthew G. Knepley         for (d = 0; d < 8; ++d) {
1310891e75beSMatthew G. Knepley           if (d > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);}
1311891e75beSMatthew G. Knepley           ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d]);CHKERRQ(ierr);
1312891e75beSMatthew G. Knepley         }
1313891e75beSMatthew G. Knepley         ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr);
13145d68e14cSMatthew G. Knepley         ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : [");CHKERRQ(ierr);
13155d68e14cSMatthew G. Knepley         for (e = 0; e < 8; ++e) {
13165d68e14cSMatthew G. Knepley           if (e > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);}
1317c15bc2c4SMatthew G. Knepley           ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e]);CHKERRQ(ierr);
13185d68e14cSMatthew G. Knepley         }
13195d68e14cSMatthew G. Knepley         ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr);
13205d68e14cSMatthew G. Knepley       }
13215d68e14cSMatthew G. Knepley       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"}\n");CHKERRQ(ierr);
13222d1ec343SBarry Smith     }
13232d1ec343SBarry Smith   }
13242d1ec343SBarry Smith   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
13251575c14dSBarry Smith   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
1326f14045dbSBarry Smith   PetscFunctionReturn(0);
1327f14045dbSBarry Smith }
1328f14045dbSBarry Smith 
132938144912Sdeepblu2718 /*
133038144912Sdeepblu2718   PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format
133138144912Sdeepblu2718 */
133238144912Sdeepblu2718 PetscErrorCode  PetscLogView_CSV(PetscViewer viewer)
133338144912Sdeepblu2718 {
133438144912Sdeepblu2718   PetscStageLog      stageLog;
1335669c5be0SSatish Balay   PetscEventPerfInfo *eventInfo = NULL;
133638144912Sdeepblu2718   PetscLogDouble     locTotalTime, maxMem;
133738144912Sdeepblu2718   int                numStages,numEvents,stage,event;
133838144912Sdeepblu2718   MPI_Comm           comm = PetscObjectComm((PetscObject) viewer);
133938144912Sdeepblu2718   PetscMPIInt        rank,size;
134038144912Sdeepblu2718   PetscErrorCode     ierr;
134138144912Sdeepblu2718 
134238144912Sdeepblu2718   PetscFunctionBegin;
1343ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
1344ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
134538144912Sdeepblu2718   /* Must preserve reduction count before we go on */
134638144912Sdeepblu2718   /* Get the total elapsed time */
134738144912Sdeepblu2718   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
134838144912Sdeepblu2718   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
134938144912Sdeepblu2718   ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
135038144912Sdeepblu2718   ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr);
135138144912Sdeepblu2718   ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
135238144912Sdeepblu2718   ierr = PetscViewerASCIIPrintf(viewer,"Stage Name,Event Name,Rank,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);
135338144912Sdeepblu2718   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
135438144912Sdeepblu2718   for (stage=0; stage<numStages; stage++) {
13559e29573dSMatthew G. Knepley     PetscEventPerfInfo *stageInfo = &stageLog->stageInfo[stage].perfInfo;
13569e29573dSMatthew G. Knepley 
13579e29573dSMatthew G. Knepley     ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,summary,%d,%g,%g,%g,%g,%g\n",
13589e29573dSMatthew G. Knepley                                               stageLog->stageInfo[stage].name,rank,stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr);
135938144912Sdeepblu2718     ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
136038144912Sdeepblu2718     for (event = 0; event < numEvents; event++) {
136138144912Sdeepblu2718       eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event];
136238144912Sdeepblu2718       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,%s,%d,%g,%g,%g,%g,%g",stageLog->stageInfo[stage].name,
136338144912Sdeepblu2718                                                 stageLog->eventLog->eventInfo[event].name,rank,eventInfo->time,eventInfo->numMessages,
136438144912Sdeepblu2718                                                 eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr);
136538144912Sdeepblu2718       if (eventInfo->dof[0] >= 0.) {
136638144912Sdeepblu2718         PetscInt d, e;
136738144912Sdeepblu2718 
136838144912Sdeepblu2718         for (d = 0; d < 8; ++d) {
136938144912Sdeepblu2718           ierr = PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d]);CHKERRQ(ierr);
137038144912Sdeepblu2718         }
137138144912Sdeepblu2718         for (e = 0; e < 8; ++e) {
137238144912Sdeepblu2718           ierr = PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e]);CHKERRQ(ierr);
137338144912Sdeepblu2718         }
137438144912Sdeepblu2718       }
137538144912Sdeepblu2718       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"\n");CHKERRQ(ierr);
137638144912Sdeepblu2718     }
137738144912Sdeepblu2718   }
137838144912Sdeepblu2718   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
137938144912Sdeepblu2718   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
138038144912Sdeepblu2718   PetscFunctionReturn(0);
138138144912Sdeepblu2718 }
138238144912Sdeepblu2718 
1383217044c2SLisandro Dalcin static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm,FILE *fd)
1384217044c2SLisandro Dalcin {
1385217044c2SLisandro Dalcin   PetscErrorCode ierr;
1386217044c2SLisandro Dalcin   PetscFunctionBegin;
1387217044c2SLisandro Dalcin   if (!PetscLogSyncOn) PetscFunctionReturn(0);
1388217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr);
1389217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n");CHKERRQ(ierr);
1390217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1391217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n");CHKERRQ(ierr);
1392217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1393217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #   This program was run with logging synchronization.   #\n");CHKERRQ(ierr);
1394217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #   This option provides more meaningful imbalance       #\n");CHKERRQ(ierr);
1395217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #   figures at the expense of slowing things down and    #\n");CHKERRQ(ierr);
1396217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #   providing a distorted view of the overall runtime.   #\n");CHKERRQ(ierr);
1397217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1398217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n\n\n");CHKERRQ(ierr);
1399217044c2SLisandro Dalcin   PetscFunctionReturn(0);
1400217044c2SLisandro Dalcin }
1401217044c2SLisandro Dalcin 
1402f4091ad2SBarry Smith static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm,FILE *fd)
1403f4091ad2SBarry Smith {
1404f4091ad2SBarry Smith   PetscErrorCode ierr;
1405f4091ad2SBarry Smith 
1406f4091ad2SBarry Smith   PetscFunctionBegin;
140776bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {
1408f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr);
1409f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      ##########################################################\n");CHKERRQ(ierr);
1410f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1411f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n");CHKERRQ(ierr);
1412f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1413217044c2SLisandro Dalcin     ierr = PetscFPrintf(comm, fd, "      #   This code was compiled with a debugging option.      #\n");CHKERRQ(ierr);
1414f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      #   To get timing results run ./configure                #\n");CHKERRQ(ierr);
1415f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      #   using --with-debugging=no, the performance will      #\n");CHKERRQ(ierr);
1416f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      #   be generally two or three times faster.              #\n");CHKERRQ(ierr);
1417f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1418f4091ad2SBarry Smith     ierr = PetscFPrintf(comm, fd, "      ##########################################################\n\n\n");CHKERRQ(ierr);
141976bd3646SJed Brown   }
1420f4091ad2SBarry Smith   PetscFunctionReturn(0);
1421f4091ad2SBarry Smith }
1422f4091ad2SBarry Smith 
1423c2a741eeSJunchao Zhang static PetscErrorCode PetscLogViewWarnNoGpuAwareMpi(MPI_Comm comm,FILE *fd)
1424c2a741eeSJunchao Zhang {
142559af0bd3SScott Kruger #if defined(PETSC_HAVE_CUDA) || defined(PETSC_HAVE_HIP)
1426c2a741eeSJunchao Zhang   PetscErrorCode ierr;
1427c2a741eeSJunchao Zhang 
1428c2a741eeSJunchao Zhang   PetscFunctionBegin;
1429928a6601SJunchao Zhang   if (use_gpu_aware_mpi || !PetscCreatedGpuObjects) PetscFunctionReturn(0);
1430c2a741eeSJunchao Zhang   ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr);
1431c2a741eeSJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n");CHKERRQ(ierr);
1432c2a741eeSJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1433c2a741eeSJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n");CHKERRQ(ierr);
1434c2a741eeSJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1435928a6601SJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      # This code was compiled with GPU support and you've     #\n");CHKERRQ(ierr);
1436928a6601SJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      # created PETSc/GPU objects, but you intentionally used  #\n");CHKERRQ(ierr);
1437928a6601SJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      # -use_gpu_aware_mpi 0, such that PETSc had to copy data #\n");CHKERRQ(ierr);
1438928a6601SJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      # from GPU to CPU for communication. To get meaningfull  #\n");CHKERRQ(ierr);
1439928a6601SJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      # timing results, please use GPU-aware MPI instead.      #\n");CHKERRQ(ierr);
1440c2a741eeSJunchao Zhang   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n\n\n");CHKERRQ(ierr);
1441c2a741eeSJunchao Zhang   PetscFunctionReturn(0);
1442c2a741eeSJunchao Zhang #else
1443c2a741eeSJunchao Zhang   return 0;
1444c2a741eeSJunchao Zhang #endif
1445c2a741eeSJunchao Zhang }
1446c2a741eeSJunchao Zhang 
1447f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP)
1448f90b075cSBarry Smith extern PetscInt PetscNumOMPThreads;
1449f90b075cSBarry Smith #endif
1450f90b075cSBarry Smith 
1451f14045dbSBarry Smith PetscErrorCode  PetscLogView_Default(PetscViewer viewer)
14525c6c1daeSBarry Smith {
14535c6c1daeSBarry Smith   FILE               *fd;
14545c6c1daeSBarry Smith   PetscLogDouble     zero       = 0.0;
14555c6c1daeSBarry Smith   PetscStageLog      stageLog;
14560298fd71SBarry Smith   PetscStageInfo     *stageInfo = NULL;
14570298fd71SBarry Smith   PetscEventPerfInfo *eventInfo = NULL;
14585c6c1daeSBarry Smith   PetscClassPerfInfo *classInfo;
14595c6c1daeSBarry Smith   char               arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128];
14605c6c1daeSBarry Smith   const char         *name;
14615c6c1daeSBarry Smith   PetscLogDouble     locTotalTime, TotalTime, TotalFlops;
14625c6c1daeSBarry Smith   PetscLogDouble     numMessages, messageLength, avgMessLen, numReductions;
14635c6c1daeSBarry Smith   PetscLogDouble     stageTime, flops, flopr, mem, mess, messLen, red;
14645c6c1daeSBarry Smith   PetscLogDouble     fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed;
14655c6c1daeSBarry Smith   PetscLogDouble     fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed;
14665c6c1daeSBarry Smith   PetscLogDouble     min, max, tot, ratio, avg, x, y;
1467e3ed9ee7SBarry Smith   PetscLogDouble     minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr, mal, malmax, emalmax;
1468d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1469958c4211Shannah_mairs   PetscLogDouble     cct, gct, csz, gsz, gmaxt, gflops, gflopr, fracgflops;
1470bec0b493Shannah_mairs   #endif
1471217044c2SLisandro Dalcin   PetscMPIInt        minC, maxC;
14725c6c1daeSBarry Smith   PetscMPIInt        size, rank;
14735c6c1daeSBarry Smith   PetscBool          *localStageUsed,    *stageUsed;
14745c6c1daeSBarry Smith   PetscBool          *localStageVisible, *stageVisible;
14755c6c1daeSBarry Smith   int                numStages, localNumEvents, numEvents;
147637b78d16SBarry Smith   int                stage, oclass;
14775c6c1daeSBarry Smith   PetscLogEvent      event;
14785c6c1daeSBarry Smith   PetscErrorCode     ierr;
14795c6c1daeSBarry Smith   char               version[256];
14805c6c1daeSBarry Smith   MPI_Comm           comm;
14815c6c1daeSBarry Smith 
14825c6c1daeSBarry Smith   PetscFunctionBegin;
14835c6c1daeSBarry Smith   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
14845c6c1daeSBarry Smith   ierr = PetscViewerASCIIGetPointer(viewer,&fd);CHKERRQ(ierr);
1485ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr);
1486ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr);
14875c6c1daeSBarry Smith   /* Get the total elapsed time */
14888563dfccSBarry Smith   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
14895c6c1daeSBarry Smith 
14905c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr);
14915c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "***             WIDEN YOUR WINDOW TO 120 CHARACTERS.  Use 'enscript -r -fCourier9' to print this document            ***\n");CHKERRQ(ierr);
14925c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr);
14935c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n---------------------------------------------- PETSc Performance Summary: ----------------------------------------------\n\n");CHKERRQ(ierr);
1494217044c2SLisandro Dalcin   ierr = PetscLogViewWarnSync(comm,fd);CHKERRQ(ierr);
1495f4091ad2SBarry Smith   ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr);
1496c2a741eeSJunchao Zhang   ierr = PetscLogViewWarnNoGpuAwareMpi(comm,fd);CHKERRQ(ierr);
14975c6c1daeSBarry Smith   ierr = PetscGetArchType(arch,sizeof(arch));CHKERRQ(ierr);
14985c6c1daeSBarry Smith   ierr = PetscGetHostName(hostname,sizeof(hostname));CHKERRQ(ierr);
14995c6c1daeSBarry Smith   ierr = PetscGetUserName(username,sizeof(username));CHKERRQ(ierr);
15005c6c1daeSBarry Smith   ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr);
15015c6c1daeSBarry Smith   ierr = PetscGetDate(date,sizeof(date));CHKERRQ(ierr);
15025c6c1daeSBarry Smith   ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
15035c6c1daeSBarry Smith   if (size == 1) {
15045c6c1daeSBarry 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);
15055c6c1daeSBarry Smith   } else {
15065c6c1daeSBarry 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);
15075c6c1daeSBarry Smith   }
1508f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP)
1509f90b075cSBarry Smith   ierr = PetscFPrintf(comm,fd,"Using %D OpenMP threads\n", PetscNumOMPThreads);CHKERRQ(ierr);
1510f90b075cSBarry Smith #endif
15115c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Using %s\n", version);CHKERRQ(ierr);
15125c6c1daeSBarry Smith 
15135c6c1daeSBarry Smith   /* Must preserve reduction count before we go on */
15145c6c1daeSBarry Smith   red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
15155c6c1daeSBarry Smith 
15165c6c1daeSBarry Smith   /* Calculate summary information */
15175c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n                         Max       Max/Min     Avg       Total\n");CHKERRQ(ierr);
15185c6c1daeSBarry Smith   /*   Time */
1519b2566f29SBarry Smith   ierr = MPIU_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1520b2566f29SBarry Smith   ierr = MPIU_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1521b2566f29SBarry Smith   ierr = MPIU_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1522217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1523217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1524217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Time (sec):           %5.3e   %7.3f   %5.3e\n", max, ratio, avg);CHKERRQ(ierr);
15255c6c1daeSBarry Smith   TotalTime = tot;
15265c6c1daeSBarry Smith   /*   Objects */
15275c6c1daeSBarry Smith   avg  = (PetscLogDouble) petsc_numObjects;
1528b2566f29SBarry Smith   ierr = MPIU_Allreduce(&avg,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1529b2566f29SBarry Smith   ierr = MPIU_Allreduce(&avg,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1530b2566f29SBarry Smith   ierr = MPIU_Allreduce(&avg,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1531217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1532217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1533217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Objects:              %5.3e   %7.3f   %5.3e\n", max, ratio, avg);CHKERRQ(ierr);
15345c6c1daeSBarry Smith   /*   Flops */
1535b2566f29SBarry Smith   ierr = MPIU_Allreduce(&petsc_TotalFlops,  &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1536b2566f29SBarry Smith   ierr = MPIU_Allreduce(&petsc_TotalFlops,  &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1537b2566f29SBarry Smith   ierr = MPIU_Allreduce(&petsc_TotalFlops,  &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1538217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1539217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1540217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Flop:                 %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
15415c6c1daeSBarry Smith   TotalFlops = tot;
15425c6c1daeSBarry Smith   /*   Flops/sec -- Must talk to Barry here */
1543217044c2SLisandro Dalcin   if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime; else flops = 0.0;
1544b2566f29SBarry Smith   ierr = MPIU_Allreduce(&flops,        &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1545b2566f29SBarry Smith   ierr = MPIU_Allreduce(&flops,        &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1546b2566f29SBarry Smith   ierr = MPIU_Allreduce(&flops,        &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1547217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1548217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1549217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Flop/sec:             %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
15505c6c1daeSBarry Smith   /*   Memory */
15515c6c1daeSBarry Smith   ierr = PetscMallocGetMaximumUsage(&mem);CHKERRQ(ierr);
15525c6c1daeSBarry Smith   if (mem > 0.0) {
1553b2566f29SBarry Smith     ierr = MPIU_Allreduce(&mem,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1554217044c2SLisandro Dalcin     ierr = MPIU_Allreduce(&mem,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1555b2566f29SBarry Smith     ierr = MPIU_Allreduce(&mem,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1556217044c2SLisandro Dalcin     avg  = tot/((PetscLogDouble) size);
1557217044c2SLisandro Dalcin     if (min != 0.0) ratio = max/min; else ratio = 0.0;
1558217044c2SLisandro Dalcin     ierr = PetscFPrintf(comm, fd, "Memory:               %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
15595c6c1daeSBarry Smith   }
15605c6c1daeSBarry Smith   /*   Messages */
15615c6c1daeSBarry Smith   mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct);
1562b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1563b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1564b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1565217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1566217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1567217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "MPI Messages:         %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
15685c6c1daeSBarry Smith   numMessages = tot;
15695c6c1daeSBarry Smith   /*   Message Lengths */
15705c6c1daeSBarry Smith   mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len);
1571b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1572b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1573b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1574217044c2SLisandro Dalcin   if (numMessages != 0) avg = tot/numMessages; else avg = 0.0;
1575217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1576217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "MPI Message Lengths:  %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
15775c6c1daeSBarry Smith   messageLength = tot;
15785c6c1daeSBarry Smith   /*   Reductions */
1579b2566f29SBarry Smith   ierr = MPIU_Allreduce(&red,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1580b2566f29SBarry Smith   ierr = MPIU_Allreduce(&red,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1581b2566f29SBarry Smith   ierr = MPIU_Allreduce(&red,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1582217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1583217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "MPI Reductions:       %5.3e   %7.3f\n", max, ratio);CHKERRQ(ierr);
15845c6c1daeSBarry Smith   numReductions = red; /* wrong because uses count from process zero */
15855c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n");CHKERRQ(ierr);
1586d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "                            e.g., VecAXPY() for real vectors of length N --> 2N flop\n");CHKERRQ(ierr);
1587d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "                            and VecAXPY() for complex vectors of length N --> 8N flop\n");CHKERRQ(ierr);
15885c6c1daeSBarry Smith 
15895c6c1daeSBarry Smith   /* Get total number of stages --
15905c6c1daeSBarry Smith        Currently, a single processor can register more stages than another, but stages must all be registered in order.
15915c6c1daeSBarry Smith        We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID.
15925c6c1daeSBarry Smith        This seems best accomplished by assoicating a communicator with each stage.
15935c6c1daeSBarry Smith   */
159437b78d16SBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
1595b2566f29SBarry Smith   ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
1596785e854fSJed Brown   ierr = PetscMalloc1(numStages, &localStageUsed);CHKERRQ(ierr);
1597785e854fSJed Brown   ierr = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr);
1598785e854fSJed Brown   ierr = PetscMalloc1(numStages, &localStageVisible);CHKERRQ(ierr);
1599785e854fSJed Brown   ierr = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr);
16005c6c1daeSBarry Smith   if (numStages > 0) {
16015c6c1daeSBarry Smith     stageInfo = stageLog->stageInfo;
16025c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
16035c6c1daeSBarry Smith       if (stage < stageLog->numStages) {
16045c6c1daeSBarry Smith         localStageUsed[stage]    = stageInfo[stage].used;
16055c6c1daeSBarry Smith         localStageVisible[stage] = stageInfo[stage].perfInfo.visible;
16065c6c1daeSBarry Smith       } else {
16075c6c1daeSBarry Smith         localStageUsed[stage]    = PETSC_FALSE;
16085c6c1daeSBarry Smith         localStageVisible[stage] = PETSC_TRUE;
16095c6c1daeSBarry Smith       }
16105c6c1daeSBarry Smith     }
1611b2566f29SBarry Smith     ierr = MPIU_Allreduce(localStageUsed,    stageUsed,    numStages, MPIU_BOOL, MPI_LOR,  comm);CHKERRQ(ierr);
1612b2566f29SBarry Smith     ierr = MPIU_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr);
16135c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
16145c6c1daeSBarry Smith       if (stageUsed[stage]) {
1615217044c2SLisandro Dalcin         ierr = PetscFPrintf(comm, fd, "\nSummary of Stages:   ----- Time ------  ----- Flop ------  --- Messages ---  -- Message Lengths --  -- Reductions --\n");CHKERRQ(ierr);
1616217044c2SLisandro Dalcin         ierr = PetscFPrintf(comm, fd, "                        Avg     %%Total     Avg     %%Total    Count   %%Total     Avg         %%Total    Count   %%Total\n");CHKERRQ(ierr);
16175c6c1daeSBarry Smith         break;
16185c6c1daeSBarry Smith       }
16195c6c1daeSBarry Smith     }
16205c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
16215c6c1daeSBarry Smith       if (!stageUsed[stage]) continue;
162250a9567dSMatthew G. Knepley       /* CANNOT use MPIU_Allreduce() since it might fail the line number check */
16235c6c1daeSBarry Smith       if (localStageUsed[stage]) {
1624ffc4695bSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1625ffc4695bSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1626ffc4695bSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1627ffc4695bSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1628ffc4695bSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
16295c6c1daeSBarry Smith         name = stageInfo[stage].name;
16305c6c1daeSBarry Smith       } else {
1631ffc4695bSBarry Smith         ierr = MPI_Allreduce(&zero,                           &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1632ffc4695bSBarry Smith         ierr = MPI_Allreduce(&zero,                           &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1633ffc4695bSBarry Smith         ierr = MPI_Allreduce(&zero,                           &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1634ffc4695bSBarry Smith         ierr = MPI_Allreduce(&zero,                           &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1635ffc4695bSBarry Smith         ierr = MPI_Allreduce(&zero,                           &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
16365c6c1daeSBarry Smith         name = "";
16375c6c1daeSBarry Smith       }
16385c6c1daeSBarry Smith       mess *= 0.5; messLen *= 0.5; red /= size;
16395c6c1daeSBarry Smith       if (TotalTime     != 0.0) fracTime       = stageTime/TotalTime;    else fracTime       = 0.0;
16405c6c1daeSBarry Smith       if (TotalFlops    != 0.0) fracFlops      = flops/TotalFlops;       else fracFlops      = 0.0;
16415c6c1daeSBarry Smith       /* Talk to Barry if (stageTime     != 0.0) flops          = (size*flops)/stageTime; else flops          = 0.0; */
16425c6c1daeSBarry Smith       if (numMessages   != 0.0) fracMessages   = mess/numMessages;       else fracMessages   = 0.0;
1643e96a4d02SJunchao Zhang       if (mess          != 0.0) avgMessLen     = messLen/mess;           else avgMessLen     = 0.0;
16445c6c1daeSBarry Smith       if (messageLength != 0.0) fracLength     = messLen/messageLength;  else fracLength     = 0.0;
16455c6c1daeSBarry Smith       if (numReductions != 0.0) fracReductions = red/numReductions;      else fracReductions = 0.0;
16465c6c1daeSBarry 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",
16475c6c1daeSBarry Smith                           stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops,
16485c6c1daeSBarry Smith                           mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr);
16495c6c1daeSBarry Smith     }
16505c6c1daeSBarry Smith   }
16515c6c1daeSBarry Smith 
1652806fa848SBarry Smith   ierr = PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
16535c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n");CHKERRQ(ierr);
16545c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Phase summary info:\n");CHKERRQ(ierr);
16555c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Count: number of times phase was executed\n");CHKERRQ(ierr);
1656d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Time and Flop: Max - maximum over all processors\n");CHKERRQ(ierr);
16575c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "                  Ratio - ratio of maximum to minimum over all processors\n");CHKERRQ(ierr);
16585c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Mess: number of messages sent\n");CHKERRQ(ierr);
1659217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "   AvgLen: average message length (bytes)\n");CHKERRQ(ierr);
16605c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Reduct: number of global reductions\n");CHKERRQ(ierr);
16615c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Global: entire computation\n");CHKERRQ(ierr);
16625c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n");CHKERRQ(ierr);
1663d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%T - percent time in this phase         %%F - percent flop in this phase\n");CHKERRQ(ierr);
16645c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%M - percent messages in this phase     %%L - percent message lengths in this phase\n");CHKERRQ(ierr);
16655c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%R - percent reductions in this phase\n");CHKERRQ(ierr);
1666d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n");CHKERRQ(ierr);
1667e3ed9ee7SBarry Smith   if (PetscLogMemory) {
1668e3ed9ee7SBarry Smith     ierr = PetscFPrintf(comm, fd, "   Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event)\n");CHKERRQ(ierr);
1669e3ed9ee7SBarry Smith     ierr = PetscFPrintf(comm, fd, "   EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events)\n");CHKERRQ(ierr);
1670e3ed9ee7SBarry Smith     ierr = PetscFPrintf(comm, fd, "   MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event)\n");CHKERRQ(ierr);
1671e3ed9ee7SBarry Smith     ierr = PetscFPrintf(comm, fd, "   RMI Mbytes: Increase in resident memory (sum over all calls to event)\n");CHKERRQ(ierr);
1672e3ed9ee7SBarry Smith   }
1673d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1674958c4211Shannah_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);
16754863603aSSatish Balay   ierr = PetscFPrintf(comm, fd, "   CpuToGpu Count: total number of CPU to GPU copies per processor\n");CHKERRQ(ierr);
16764863603aSSatish Balay   ierr = PetscFPrintf(comm, fd, "   CpuToGpu Size (Mbytes): 10e-6 * (total size of CPU to GPU copies per processor)\n");CHKERRQ(ierr);
16774863603aSSatish Balay   ierr = PetscFPrintf(comm, fd, "   GpuToCpu Count: total number of GPU to CPU copies per processor\n");CHKERRQ(ierr);
16784863603aSSatish Balay   ierr = PetscFPrintf(comm, fd, "   GpuToCpu Size (Mbytes): 10e-6 * (total size of GPU to CPU copies per processor)\n");CHKERRQ(ierr);
1679958c4211Shannah_mairs   ierr = PetscFPrintf(comm, fd, "   GPU %%F: percent flops on GPU in this event\n");CHKERRQ(ierr);
1680bec0b493Shannah_mairs   #endif
1681806fa848SBarry Smith   ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
16825c6c1daeSBarry Smith 
1683f4091ad2SBarry Smith   ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr);
16845c6c1daeSBarry Smith 
16855c6c1daeSBarry Smith   /* Report events */
1686e3ed9ee7SBarry Smith   ierr = PetscFPrintf(comm, fd,"Event                Count      Time (sec)     Flop                              --- Global ---  --- Stage ----  Total");CHKERRQ(ierr);
1687e3ed9ee7SBarry Smith   if (PetscLogMemory) {
1688bec0b493Shannah_mairs     ierr = PetscFPrintf(comm, fd,"  Malloc EMalloc MMalloc RMI");CHKERRQ(ierr);
1689e3ed9ee7SBarry Smith   }
1690d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1691958c4211Shannah_mairs   ierr = PetscFPrintf(comm, fd,"   GPU    - CpuToGpu -   - GpuToCpu - GPU");CHKERRQ(ierr);
1692bec0b493Shannah_mairs   #endif
1693bec0b493Shannah_mairs   ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr);
1694e3ed9ee7SBarry 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);
1695e3ed9ee7SBarry Smith   if (PetscLogMemory) {
1696bec0b493Shannah_mairs     ierr = PetscFPrintf(comm, fd," Mbytes Mbytes Mbytes Mbytes");CHKERRQ(ierr);
1697e3ed9ee7SBarry Smith   }
1698d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1699958c4211Shannah_mairs   ierr = PetscFPrintf(comm, fd," Mflop/s Count   Size   Count   Size  %%F");CHKERRQ(ierr);
1700bec0b493Shannah_mairs   #endif
1701bec0b493Shannah_mairs   ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr);
17024863603aSSatish Balay   ierr = PetscFPrintf(comm, fd,"------------------------------------------------------------------------------------------------------------------------");CHKERRQ(ierr);
17034863603aSSatish Balay   if (PetscLogMemory) {
17044863603aSSatish Balay     ierr = PetscFPrintf(comm, fd,"-----------------------------");CHKERRQ(ierr);
17054863603aSSatish Balay   }
1706d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1707958c4211Shannah_mairs   ierr = PetscFPrintf(comm, fd,"---------------------------------------");CHKERRQ(ierr);
17084863603aSSatish Balay   #endif
17094863603aSSatish Balay   ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr);
17105c6c1daeSBarry Smith 
17115c6c1daeSBarry Smith   /* Problem: The stage name will not show up unless the stage executed on proc 1 */
17125c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
17135c6c1daeSBarry Smith     if (!stageVisible[stage]) continue;
171450a9567dSMatthew G. Knepley     /* CANNOT use MPIU_Allreduce() since it might fail the line number check */
17155c6c1daeSBarry Smith     if (localStageUsed[stage]) {
17165c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr);
1717ffc4695bSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1718ffc4695bSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1719ffc4695bSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1720ffc4695bSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1721ffc4695bSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
17225c6c1daeSBarry Smith     } else {
17235c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr);
1724ffc4695bSBarry Smith       ierr = MPI_Allreduce(&zero,                           &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1725ffc4695bSBarry Smith       ierr = MPI_Allreduce(&zero,                           &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1726ffc4695bSBarry Smith       ierr = MPI_Allreduce(&zero,                           &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1727ffc4695bSBarry Smith       ierr = MPI_Allreduce(&zero,                           &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1728ffc4695bSBarry Smith       ierr = MPI_Allreduce(&zero,                           &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
17295c6c1daeSBarry Smith     }
17305c6c1daeSBarry Smith     mess *= 0.5; messLen *= 0.5; red /= size;
17315c6c1daeSBarry Smith 
17325c6c1daeSBarry Smith     /* Get total number of events in this stage --
17335c6c1daeSBarry Smith        Currently, a single processor can register more events than another, but events must all be registered in order,
17345c6c1daeSBarry Smith        just like stages. We can removed this requirement if necessary by having a global event numbering and indirection
1735217044c2SLisandro Dalcin        on the event ID. This seems best accomplished by associating a communicator with each stage.
17365c6c1daeSBarry Smith 
17375c6c1daeSBarry Smith        Problem: If the event did not happen on proc 1, its name will not be available.
17385c6c1daeSBarry Smith        Problem: Event visibility is not implemented
17395c6c1daeSBarry Smith     */
17405c6c1daeSBarry Smith     if (localStageUsed[stage]) {
17415c6c1daeSBarry Smith       eventInfo      = stageLog->stageInfo[stage].eventLog->eventInfo;
17425c6c1daeSBarry Smith       localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents;
1743a297a907SKarl Rupp     } else localNumEvents = 0;
1744b2566f29SBarry Smith     ierr = MPIU_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
17455c6c1daeSBarry Smith     for (event = 0; event < numEvents; event++) {
174650a9567dSMatthew G. Knepley       /* CANNOT use MPIU_Allreduce() since it might fail the line number check */
17475c6c1daeSBarry Smith       if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) {
1748217044c2SLisandro Dalcin         if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; else flopr = 0.0;
1749ffc4695bSBarry Smith         ierr = MPI_Allreduce(&flopr,                          &minf,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
1750ffc4695bSBarry Smith         ierr = MPI_Allreduce(&flopr,                          &maxf,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1751ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].flops,         &totf,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1752ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].time,          &mint,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
1753ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].time,          &maxt,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1754ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].time,          &tott,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1755ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].numMessages,   &totm,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1756ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1757ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].numReductions, &totr,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1758ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].count,         &minC,  1, MPI_INT,             MPI_MIN, comm);CHKERRMPI(ierr);
1759ffc4695bSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].count,         &maxC,  1, MPI_INT,             MPI_MAX, comm);CHKERRMPI(ierr);
1760e3ed9ee7SBarry Smith         if (PetscLogMemory) {
176155b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&eventInfo[event].memIncrease,    &mem,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
176255b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&eventInfo[event].mallocSpace,    &mal,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
176355b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&eventInfo[event].mallocIncrease, &malmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
176455b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1765e3ed9ee7SBarry Smith         }
1766d9c66bfbSJunchao Zhang         #if defined(PETSC_HAVE_DEVICE)
176755b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&eventInfo[event].CpuToGpuCount,    &cct,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
176855b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&eventInfo[event].GpuToCpuCount,    &gct,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
176955b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&eventInfo[event].CpuToGpuSize,     &csz,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
177055b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&eventInfo[event].GpuToCpuSize,     &gsz,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
177155b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&eventInfo[event].GpuFlops,         &gflops,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
177255b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&eventInfo[event].GpuTime,          &gmaxt ,1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1773bec0b493Shannah_mairs         #endif
17745c6c1daeSBarry Smith         name = stageLog->eventLog->eventInfo[event].name;
17755c6c1daeSBarry Smith       } else {
17765c6c1daeSBarry Smith         flopr = 0.0;
177755b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&flopr,                         &minf,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
177855b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&flopr,                         &maxf,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
177955b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &totf,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
178055b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &mint,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr);
178155b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &maxt,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
178255b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &tott,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
178355b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &totm,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
178455b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
178555b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &totr,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
178655b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&ierr,                          &minC,  1, MPI_INT,             MPI_MIN, comm);CHKERRMPI(ierr);
178755b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&ierr,                          &maxC,  1, MPI_INT,             MPI_MAX, comm);CHKERRMPI(ierr);
1788e3ed9ee7SBarry Smith         if (PetscLogMemory) {
178955b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&zero,                        &mem,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
179055b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&zero,                        &mal,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
179155b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&zero,                        &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
179255b25c41SPierre Jolivet           ierr  = MPI_Allreduce(&zero,                        &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
1793e3ed9ee7SBarry Smith         }
1794d9c66bfbSJunchao Zhang         #if defined(PETSC_HAVE_DEVICE)
179555b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &cct,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
179655b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &gct,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
179755b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &csz,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
179855b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &gsz,    1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
179955b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr);
180055b25c41SPierre Jolivet         ierr  = MPI_Allreduce(&zero,                          &gmaxt , 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr);
1801bec0b493Shannah_mairs         #endif
18025c6c1daeSBarry Smith         name  = "";
18035c6c1daeSBarry Smith       }
18045c6c1daeSBarry Smith       if (mint < 0.0) {
18055c6c1daeSBarry 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);
18065c6c1daeSBarry Smith         mint = 0;
18075c6c1daeSBarry Smith       }
1808d4aa7d5fSBarry 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);
18095c6c1daeSBarry Smith       totm *= 0.5; totml *= 0.5; totr /= size;
18105c6c1daeSBarry Smith 
1811217044c2SLisandro Dalcin       if (maxC != 0) {
1812217044c2SLisandro Dalcin         if (minC          != 0)   ratC             = ((PetscLogDouble)maxC)/minC;else ratC             = 0.0;
18135c6c1daeSBarry Smith         if (mint          != 0.0) ratt             = maxt/mint;                  else ratt             = 0.0;
18145c6c1daeSBarry Smith         if (minf          != 0.0) ratf             = maxf/minf;                  else ratf             = 0.0;
18155c6c1daeSBarry Smith         if (TotalTime     != 0.0) fracTime         = tott/TotalTime;             else fracTime         = 0.0;
18165c6c1daeSBarry Smith         if (TotalFlops    != 0.0) fracFlops        = totf/TotalFlops;            else fracFlops        = 0.0;
18175c6c1daeSBarry Smith         if (stageTime     != 0.0) fracStageTime    = tott/stageTime;             else fracStageTime    = 0.0;
18185c6c1daeSBarry Smith         if (flops         != 0.0) fracStageFlops   = totf/flops;                 else fracStageFlops   = 0.0;
18195c6c1daeSBarry Smith         if (numMessages   != 0.0) fracMess         = totm/numMessages;           else fracMess         = 0.0;
18205c6c1daeSBarry Smith         if (messageLength != 0.0) fracMessLen      = totml/messageLength;        else fracMessLen      = 0.0;
18215c6c1daeSBarry Smith         if (numReductions != 0.0) fracRed          = totr/numReductions;         else fracRed          = 0.0;
18225c6c1daeSBarry Smith         if (mess          != 0.0) fracStageMess    = totm/mess;                  else fracStageMess    = 0.0;
18235c6c1daeSBarry Smith         if (messLen       != 0.0) fracStageMessLen = totml/messLen;              else fracStageMessLen = 0.0;
18245c6c1daeSBarry Smith         if (red           != 0.0) fracStageRed     = totr/red;                   else fracStageRed     = 0.0;
18255c6c1daeSBarry Smith         if (totm          != 0.0) totml           /= totm;                       else totml            = 0.0;
18265c6c1daeSBarry Smith         if (maxt          != 0.0) flopr            = totf/maxt;                  else flopr            = 0.0;
1827411f5eb9SRichard 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);
18285c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd,
1829e3ed9ee7SBarry 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",
1830217044c2SLisandro Dalcin                             name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr,
18315c6c1daeSBarry Smith                             100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed,
18325c6c1daeSBarry Smith                             100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed,
1833c068d9bbSLisandro Dalcin                             PetscAbs(flopr)/1.0e6);CHKERRQ(ierr);
1834e3ed9ee7SBarry Smith         if (PetscLogMemory) {
1835bec0b493Shannah_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);
1836e3ed9ee7SBarry Smith         }
1837d9c66bfbSJunchao Zhang         #if defined(PETSC_HAVE_DEVICE)
1838958c4211Shannah_mairs         if (totf  != 0.0) fracgflops = gflops/totf;  else fracgflops = 0.0;
1839958c4211Shannah_mairs         if (gmaxt != 0.0) gflopr     = gflops/gmaxt; else gflopr     = 0.0;
1840958c4211Shannah_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);
1841bec0b493Shannah_mairs         #endif
1842bec0b493Shannah_mairs         ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr);
18435c6c1daeSBarry Smith       }
18445c6c1daeSBarry Smith     }
18455c6c1daeSBarry Smith   }
18465c6c1daeSBarry Smith 
18475c6c1daeSBarry Smith   /* Memory usage and object creation */
18484863603aSSatish Balay   ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------");CHKERRQ(ierr);
18494863603aSSatish Balay   if (PetscLogMemory) {
18504863603aSSatish Balay     ierr = PetscFPrintf(comm, fd, "-----------------------------");CHKERRQ(ierr);
18514863603aSSatish Balay   }
1852d9c66bfbSJunchao Zhang   #if defined(PETSC_HAVE_DEVICE)
1853958c4211Shannah_mairs   ierr = PetscFPrintf(comm, fd, "---------------------------------------");CHKERRQ(ierr);
18544863603aSSatish Balay   #endif
18554863603aSSatish Balay   ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr);
18565c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr);
18575c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n");CHKERRQ(ierr);
18585c6c1daeSBarry Smith 
18595c6c1daeSBarry Smith   /* Right now, only stages on the first processor are reported here, meaning only objects associated with
18605c6c1daeSBarry Smith      the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then
18615c6c1daeSBarry Smith      stats for stages local to processor sets.
18625c6c1daeSBarry Smith   */
18635c6c1daeSBarry Smith   /* We should figure out the longest object name here (now 20 characters) */
18645c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Object Type          Creations   Destructions     Memory  Descendants' Mem.\n");CHKERRQ(ierr);
18655c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Reports information only for process 0.\n");CHKERRQ(ierr);
18665c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
18675c6c1daeSBarry Smith     if (localStageUsed[stage]) {
18685c6c1daeSBarry Smith       classInfo = stageLog->stageInfo[stage].classLog->classInfo;
18695c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr);
18705c6c1daeSBarry Smith       for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) {
18715c6c1daeSBarry Smith         if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) {
18725c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "%20s %5d          %5d  %11.0f     %g\n", stageLog->classLog->classInfo[oclass].name,
18735c6c1daeSBarry Smith                               classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem,
18745c6c1daeSBarry Smith                               classInfo[oclass].descMem);CHKERRQ(ierr);
18755c6c1daeSBarry Smith         }
18765c6c1daeSBarry Smith       }
18775c6c1daeSBarry Smith     } else {
1878cf019ec6SStefano Zampini       if (!localStageVisible[stage]) continue;
18795c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr);
18805c6c1daeSBarry Smith     }
18815c6c1daeSBarry Smith   }
18825c6c1daeSBarry Smith 
18835c6c1daeSBarry Smith   ierr = PetscFree(localStageUsed);CHKERRQ(ierr);
18845c6c1daeSBarry Smith   ierr = PetscFree(stageUsed);CHKERRQ(ierr);
18855c6c1daeSBarry Smith   ierr = PetscFree(localStageVisible);CHKERRQ(ierr);
18865c6c1daeSBarry Smith   ierr = PetscFree(stageVisible);CHKERRQ(ierr);
18875c6c1daeSBarry Smith 
18885c6c1daeSBarry Smith   /* Information unrelated to this particular run */
1889a297a907SKarl Rupp   ierr = PetscFPrintf(comm, fd, "========================================================================================================================\n");CHKERRQ(ierr);
18908563dfccSBarry Smith   PetscTime(&y);
18918563dfccSBarry Smith   PetscTime(&x);
18928563dfccSBarry Smith   PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y);
18938563dfccSBarry Smith   PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y);
18945c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0);CHKERRQ(ierr);
18955c6c1daeSBarry Smith   /* MPI information */
18965c6c1daeSBarry Smith   if (size > 1) {
18975c6c1daeSBarry Smith     MPI_Status  status;
18985c6c1daeSBarry Smith     PetscMPIInt tag;
18995c6c1daeSBarry Smith     MPI_Comm    newcomm;
19005c6c1daeSBarry Smith 
1901ffc4695bSBarry Smith     ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
19028563dfccSBarry Smith     PetscTime(&x);
1903ffc4695bSBarry Smith     ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
1904ffc4695bSBarry Smith     ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
1905ffc4695bSBarry Smith     ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
1906ffc4695bSBarry Smith     ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
1907ffc4695bSBarry Smith     ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
19088563dfccSBarry Smith     PetscTime(&y);
19095c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0);CHKERRQ(ierr);
19105c6c1daeSBarry Smith     ierr = PetscCommDuplicate(comm,&newcomm, &tag);CHKERRQ(ierr);
1911ffc4695bSBarry Smith     ierr = MPI_Barrier(comm);CHKERRMPI(ierr);
19125c6c1daeSBarry Smith     if (rank) {
1913ffc4695bSBarry Smith       ierr = MPI_Recv(NULL, 0, MPI_INT, rank-1,            tag, newcomm, &status);CHKERRMPI(ierr);
1914ffc4695bSBarry Smith       ierr = MPI_Send(NULL, 0, MPI_INT, (rank+1)%size, tag, newcomm);CHKERRMPI(ierr);
19155c6c1daeSBarry Smith     } else {
19168563dfccSBarry Smith       PetscTime(&x);
1917ffc4695bSBarry Smith       ierr = MPI_Send(NULL, 0, MPI_INT, 1,          tag, newcomm);CHKERRMPI(ierr);
1918ffc4695bSBarry Smith       ierr = MPI_Recv(NULL, 0, MPI_INT, size-1, tag, newcomm, &status);CHKERRMPI(ierr);
19198563dfccSBarry Smith       PetscTime(&y);
19205c6c1daeSBarry Smith       ierr = PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size);CHKERRQ(ierr);
19215c6c1daeSBarry Smith     }
19225c6c1daeSBarry Smith     ierr = PetscCommDestroy(&newcomm);CHKERRQ(ierr);
19235c6c1daeSBarry Smith   }
1924c5929fdfSBarry Smith   ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
19255c6c1daeSBarry Smith 
19265c6c1daeSBarry Smith   /* Machine and compile information */
19275c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS)
19285c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n");CHKERRQ(ierr);
19295c6c1daeSBarry Smith #else
19305c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n");CHKERRQ(ierr);
19315c6c1daeSBarry Smith #endif
1932217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES)
1933217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n");CHKERRQ(ierr);
1934217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128)
1935217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n");CHKERRQ(ierr);
1936217044c2SLisandro Dalcin #endif
19375c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
19385c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n");CHKERRQ(ierr);
19395f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128)
19405f27b2e0SBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n");CHKERRQ(ierr);
19415c6c1daeSBarry Smith #endif
19425c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE)
19435c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with single precision matrices\n");CHKERRQ(ierr);
19445c6c1daeSBarry Smith #else
19455c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n");CHKERRQ(ierr);
19465c6c1daeSBarry Smith #endif
19475c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n",
19485c6c1daeSBarry Smith                       (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt));CHKERRQ(ierr);
19495c6c1daeSBarry Smith 
19505c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions);CHKERRQ(ierr);
19515c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petscmachineinfo);CHKERRQ(ierr);
19525c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsccompilerinfo);CHKERRQ(ierr);
19535c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo);CHKERRQ(ierr);
19545c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsclinkerinfo);CHKERRQ(ierr);
19555c6c1daeSBarry Smith 
19565c6c1daeSBarry Smith   /* Cleanup */
19575c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr);
1958c2a741eeSJunchao Zhang   ierr = PetscLogViewWarnNoGpuAwareMpi(comm,fd);CHKERRQ(ierr);
1959f4091ad2SBarry Smith   ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr);
19605c6c1daeSBarry Smith   PetscFunctionReturn(0);
19615c6c1daeSBarry Smith }
19625c6c1daeSBarry Smith 
19637d6c928cSSatish Balay /*@C
19647d6c928cSSatish Balay   PetscLogView - Prints a summary of the logging.
19655c6c1daeSBarry Smith 
19665c6c1daeSBarry Smith   Collective over MPI_Comm
19675c6c1daeSBarry Smith 
19685c6c1daeSBarry Smith   Input Parameter:
1969f14045dbSBarry Smith .  viewer - an ASCII viewer
19705c6c1daeSBarry Smith 
19715c6c1daeSBarry Smith   Options Database Keys:
1972bb1d7374SBarry Smith +  -log_view [:filename] - Prints summary of log information
1973bb1d7374SBarry Smith .  -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file
1974607d249eSBarry 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)
1975*d0a29bd7SConnor 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)
1976bb1d7374SBarry Smith .  -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation
1977bb1d7374SBarry Smith -  -log_trace [filename] - Displays a trace of what each process is doing
19785c6c1daeSBarry Smith 
19795c6c1daeSBarry Smith   Notes:
1980bb1d7374SBarry Smith   It is possible to control the logging programatically but we recommend using the options database approach whenever possible
19815c6c1daeSBarry Smith   By default the summary is printed to stdout.
19825c6c1daeSBarry Smith 
1983bb1d7374SBarry Smith   Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin()
1984bb1d7374SBarry Smith 
1985bb1d7374SBarry Smith   If PETSc is configured with --with-logging=0 then this functionality is not available
1986bb1d7374SBarry Smith 
1987607d249eSBarry Smith   To view the nested XML format filename.xml first copy  ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current
1988607d249eSBarry Smith   directory then open filename.xml with your browser. Specific notes for certain browsers
1989607d249eSBarry Smith $    Firefox and Internet explorer - simply open the file
1990607d249eSBarry Smith $    Google Chrome - you must start up Chrome with the option --allow-file-access-from-files
1991a8d69d7bSBarry Smith $    Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access
1992607d249eSBarry 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
1993607d249eSBarry Smith   your browser.
19942add09c0SLisandro Dalcin   Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser
19952add09c0SLisandro Dalcin   window and render the XML log file contents.
1996607d249eSBarry Smith 
1997bb1d7374SBarry Smith   The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij  MARITIME  RESEARCH  INSTITUTE  NETHERLANDS
1998bb1d7374SBarry Smith 
1999*d0a29bd7SConnor Ward   The Flame Graph output can be visualised using either the original Flame Graph script (https://github.com/brendangregg/FlameGraph)
2000*d0a29bd7SConnor Ward   or using speedscope (https://www.speedscope.app).
2001*d0a29bd7SConnor Ward   Old XML profiles may be converted into this format using the script ${PETSC_DIR}/lib/petsc/bin/xml2flamegraph.py.
2002*d0a29bd7SConnor Ward 
20035c6c1daeSBarry Smith   Level: beginner
20045c6c1daeSBarry Smith 
2005bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogDump()
20065c6c1daeSBarry Smith @*/
2007f14045dbSBarry Smith PetscErrorCode  PetscLogView(PetscViewer viewer)
20085c6c1daeSBarry Smith {
20095c6c1daeSBarry Smith   PetscErrorCode    ierr;
2010f14045dbSBarry Smith   PetscBool         isascii;
2011f14045dbSBarry Smith   PetscViewerFormat format;
201237b78d16SBarry Smith   int               stage, lastStage;
201337b78d16SBarry Smith   PetscStageLog     stageLog;
20145c6c1daeSBarry Smith 
20155c6c1daeSBarry Smith   PetscFunctionBegin;
2016609bdbeeSBarry Smith   if (!PetscLogPLB) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Must use -log_view or PetscLogDefaultBegin() before calling this routine");
201737b78d16SBarry Smith   /* Pop off any stages the user forgot to remove */
201837b78d16SBarry Smith   lastStage = 0;
201937b78d16SBarry Smith   ierr      = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
202037b78d16SBarry Smith   ierr      = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
202137b78d16SBarry Smith   while (stage >= 0) {
202237b78d16SBarry Smith     lastStage = stage;
202337b78d16SBarry Smith     ierr      = PetscStageLogPop(stageLog);CHKERRQ(ierr);
202437b78d16SBarry Smith     ierr      = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
202537b78d16SBarry Smith   }
2026f14045dbSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
2027f14045dbSBarry Smith   if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Currently can only view logging to ASCII");
2028f14045dbSBarry Smith   ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
2029f14045dbSBarry Smith   if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) {
2030f14045dbSBarry Smith     ierr = PetscLogView_Default(viewer);CHKERRQ(ierr);
2031f14045dbSBarry Smith   } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
2032f14045dbSBarry Smith     ierr = PetscLogView_Detailed(viewer);CHKERRQ(ierr);
203338144912Sdeepblu2718   } else if (format == PETSC_VIEWER_ASCII_CSV) {
203438144912Sdeepblu2718     ierr = PetscLogView_CSV(viewer);CHKERRQ(ierr);
2035bb1d7374SBarry Smith   } else if (format == PETSC_VIEWER_ASCII_XML) {
2036bb1d7374SBarry Smith     ierr = PetscLogView_Nested(viewer);CHKERRQ(ierr);
2037*d0a29bd7SConnor Ward   } else if (format == PETSC_VIEWER_ASCII_FLAMEGRAPH) {
2038*d0a29bd7SConnor Ward     ierr = PetscLogView_Flamegraph(viewer);CHKERRQ(ierr);
20395c6c1daeSBarry Smith   }
204037b78d16SBarry Smith   ierr = PetscStageLogPush(stageLog, lastStage);CHKERRQ(ierr);
20415c6c1daeSBarry Smith   PetscFunctionReturn(0);
20425c6c1daeSBarry Smith }
20435c6c1daeSBarry Smith 
2044f14045dbSBarry Smith /*@C
2045f14045dbSBarry Smith   PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed.
2046f14045dbSBarry Smith 
2047f14045dbSBarry Smith   Collective on PETSC_COMM_WORLD
2048f14045dbSBarry Smith 
2049f14045dbSBarry Smith   Not normally called by user
2050f14045dbSBarry Smith 
2051f14045dbSBarry Smith   Level: intermediate
2052f14045dbSBarry Smith 
2053f14045dbSBarry Smith @*/
2054f14045dbSBarry Smith PetscErrorCode PetscLogViewFromOptions(void)
2055f14045dbSBarry Smith {
2056f14045dbSBarry Smith   PetscErrorCode    ierr;
2057f14045dbSBarry Smith   PetscViewer       viewer;
2058f14045dbSBarry Smith   PetscBool         flg;
2059f14045dbSBarry Smith   PetscViewerFormat format;
2060f14045dbSBarry Smith 
2061f14045dbSBarry Smith   PetscFunctionBegin;
206216413a6aSBarry Smith   ierr   = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-log_view",&viewer,&format,&flg);CHKERRQ(ierr);
2063f14045dbSBarry Smith   if (flg) {
2064f14045dbSBarry Smith     ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr);
2065f14045dbSBarry Smith     ierr = PetscLogView(viewer);CHKERRQ(ierr);
2066f14045dbSBarry Smith     ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
2067f14045dbSBarry Smith     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
2068f14045dbSBarry Smith   }
2069f14045dbSBarry Smith   PetscFunctionReturn(0);
2070f14045dbSBarry Smith }
2071f14045dbSBarry Smith 
2072f14045dbSBarry Smith 
2073f14045dbSBarry Smith 
20745c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/
20755c6c1daeSBarry Smith /*@C
20765c6c1daeSBarry Smith    PetscGetFlops - Returns the number of flops used on this processor
20775c6c1daeSBarry Smith    since the program began.
20785c6c1daeSBarry Smith 
20795c6c1daeSBarry Smith    Not Collective
20805c6c1daeSBarry Smith 
20815c6c1daeSBarry Smith    Output Parameter:
20825c6c1daeSBarry Smith    flops - number of floating point operations
20835c6c1daeSBarry Smith 
20845c6c1daeSBarry Smith    Notes:
20855c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
20865c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
20875c6c1daeSBarry Smith    application code.
20885c6c1daeSBarry Smith 
20895c6c1daeSBarry Smith    Level: intermediate
20905c6c1daeSBarry Smith 
20918563dfccSBarry Smith .seealso: PetscTime(), PetscLogFlops()
20925c6c1daeSBarry Smith @*/
20935c6c1daeSBarry Smith PetscErrorCode  PetscGetFlops(PetscLogDouble *flops)
20945c6c1daeSBarry Smith {
20955c6c1daeSBarry Smith   PetscFunctionBegin;
20965c6c1daeSBarry Smith   *flops = petsc_TotalFlops;
20975c6c1daeSBarry Smith   PetscFunctionReturn(0);
20985c6c1daeSBarry Smith }
20995c6c1daeSBarry Smith 
21005c6c1daeSBarry Smith PetscErrorCode  PetscLogObjectState(PetscObject obj, const char format[], ...)
21015c6c1daeSBarry Smith {
21025c6c1daeSBarry Smith   PetscErrorCode ierr;
21035c6c1daeSBarry Smith   size_t         fullLength;
21045c6c1daeSBarry Smith   va_list        Argp;
21055c6c1daeSBarry Smith 
21065c6c1daeSBarry Smith   PetscFunctionBegin;
21075c6c1daeSBarry Smith   if (!petsc_logObjects) PetscFunctionReturn(0);
21085c6c1daeSBarry Smith   va_start(Argp, format);
21095c6c1daeSBarry Smith   ierr = PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp);CHKERRQ(ierr);
21105c6c1daeSBarry Smith   va_end(Argp);
21115c6c1daeSBarry Smith   PetscFunctionReturn(0);
21125c6c1daeSBarry Smith }
21135c6c1daeSBarry Smith 
21145c6c1daeSBarry Smith 
21155c6c1daeSBarry Smith /*MC
21165c6c1daeSBarry Smith    PetscLogFlops - Adds floating point operations to the global counter.
21175c6c1daeSBarry Smith 
21185c6c1daeSBarry Smith    Synopsis:
2119aaa7dc30SBarry Smith    #include <petsclog.h>
21205c6c1daeSBarry Smith    PetscErrorCode PetscLogFlops(PetscLogDouble f)
21215c6c1daeSBarry Smith 
21225c6c1daeSBarry Smith    Not Collective
21235c6c1daeSBarry Smith 
21245c6c1daeSBarry Smith    Input Parameter:
21255c6c1daeSBarry Smith .  f - flop counter
21265c6c1daeSBarry Smith 
21275c6c1daeSBarry Smith 
21285c6c1daeSBarry Smith    Usage:
21295c6c1daeSBarry Smith .vb
21305c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
21315c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
21325c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
21335c6c1daeSBarry Smith         [code segment to monitor]
21345c6c1daeSBarry Smith         PetscLogFlops(user_flops)
21355c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
21365c6c1daeSBarry Smith .ve
21375c6c1daeSBarry Smith 
21385c6c1daeSBarry Smith    Notes:
21395c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
21405c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
21415c6c1daeSBarry Smith    application code.
21425c6c1daeSBarry Smith 
21435c6c1daeSBarry Smith    Level: intermediate
21445c6c1daeSBarry Smith 
21455c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscGetFlops()
21465c6c1daeSBarry Smith 
21475c6c1daeSBarry Smith M*/
21485c6c1daeSBarry Smith 
21495c6c1daeSBarry Smith /*MC
21505c6c1daeSBarry Smith    PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice)
21515c6c1daeSBarry Smith     to get accurate timings
21525c6c1daeSBarry Smith 
21535c6c1daeSBarry Smith    Synopsis:
2154aaa7dc30SBarry Smith    #include <petsclog.h>
21555c6c1daeSBarry Smith    void PetscPreLoadBegin(PetscBool  flag,char *name);
21565c6c1daeSBarry Smith 
21575c6c1daeSBarry Smith    Not Collective
21585c6c1daeSBarry Smith 
21595c6c1daeSBarry Smith    Input Parameter:
21605c6c1daeSBarry Smith +   flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden
21615c6c1daeSBarry Smith            with command line option -preload true or -preload false
2162609bdbeeSBarry Smith -   name - name of first stage (lines of code timed separately with -log_view) to
21635c6c1daeSBarry Smith            be preloaded
21645c6c1daeSBarry Smith 
21655c6c1daeSBarry Smith    Usage:
21665c6c1daeSBarry Smith .vb
21675c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
21685c6c1daeSBarry Smith        lines of code
21695c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
21705c6c1daeSBarry Smith        lines of code
21715c6c1daeSBarry Smith      PetscPreLoadEnd();
21725c6c1daeSBarry Smith .ve
21735c6c1daeSBarry Smith 
217495452b02SPatrick Sanan    Notes:
217595452b02SPatrick Sanan     Only works in C/C++, not Fortran
21765c6c1daeSBarry Smith 
21775c6c1daeSBarry Smith      Flags available within the macro.
21785c6c1daeSBarry Smith +    PetscPreLoadingUsed - true if we are or have done preloading
21795c6c1daeSBarry Smith .    PetscPreLoadingOn - true if it is CURRENTLY doing preload
21805c6c1daeSBarry Smith .    PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second
21815c6c1daeSBarry Smith -    PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on
21825c6c1daeSBarry Smith      The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin()
21835c6c1daeSBarry Smith      and PetscPreLoadEnd()
21845c6c1daeSBarry Smith 
21855c6c1daeSBarry Smith    Level: intermediate
21865c6c1daeSBarry Smith 
21875c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage()
21885c6c1daeSBarry Smith 
21895c6c1daeSBarry Smith 
21905c6c1daeSBarry Smith M*/
21915c6c1daeSBarry Smith 
21925c6c1daeSBarry Smith /*MC
21935c6c1daeSBarry Smith    PetscPreLoadEnd - End a segment of code that may be preloaded (run twice)
21945c6c1daeSBarry Smith     to get accurate timings
21955c6c1daeSBarry Smith 
21965c6c1daeSBarry Smith    Synopsis:
2197aaa7dc30SBarry Smith    #include <petsclog.h>
21985c6c1daeSBarry Smith    void PetscPreLoadEnd(void);
21995c6c1daeSBarry Smith 
22005c6c1daeSBarry Smith    Not Collective
22015c6c1daeSBarry Smith 
22025c6c1daeSBarry Smith    Usage:
22035c6c1daeSBarry Smith .vb
22045c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
22055c6c1daeSBarry Smith        lines of code
22065c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
22075c6c1daeSBarry Smith        lines of code
22085c6c1daeSBarry Smith      PetscPreLoadEnd();
22095c6c1daeSBarry Smith .ve
22105c6c1daeSBarry Smith 
221195452b02SPatrick Sanan    Notes:
221295452b02SPatrick Sanan     only works in C/C++ not fortran
22135c6c1daeSBarry Smith 
22145c6c1daeSBarry Smith    Level: intermediate
22155c6c1daeSBarry Smith 
22165c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadStage()
22175c6c1daeSBarry Smith 
22185c6c1daeSBarry Smith M*/
22195c6c1daeSBarry Smith 
22205c6c1daeSBarry Smith /*MC
22215c6c1daeSBarry Smith    PetscPreLoadStage - Start a new segment of code to be timed separately.
22225c6c1daeSBarry Smith     to get accurate timings
22235c6c1daeSBarry Smith 
22245c6c1daeSBarry Smith    Synopsis:
2225aaa7dc30SBarry Smith    #include <petsclog.h>
22265c6c1daeSBarry Smith    void PetscPreLoadStage(char *name);
22275c6c1daeSBarry Smith 
22285c6c1daeSBarry Smith    Not Collective
22295c6c1daeSBarry Smith 
22305c6c1daeSBarry Smith    Usage:
22315c6c1daeSBarry Smith .vb
22325c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
22335c6c1daeSBarry Smith        lines of code
22345c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
22355c6c1daeSBarry Smith        lines of code
22365c6c1daeSBarry Smith      PetscPreLoadEnd();
22375c6c1daeSBarry Smith .ve
22385c6c1daeSBarry Smith 
223995452b02SPatrick Sanan    Notes:
224095452b02SPatrick Sanan     only works in C/C++ not fortran
22415c6c1daeSBarry Smith 
22425c6c1daeSBarry Smith    Level: intermediate
22435c6c1daeSBarry Smith 
22445c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd()
22455c6c1daeSBarry Smith 
22465c6c1daeSBarry Smith M*/
22475c6c1daeSBarry Smith 
22485c6c1daeSBarry Smith 
22495c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */
22505c6c1daeSBarry Smith 
22515c6c1daeSBarry Smith PetscErrorCode  PetscLogObjectState(PetscObject obj, const char format[], ...)
22525c6c1daeSBarry Smith {
22535c6c1daeSBarry Smith   PetscFunctionBegin;
22545c6c1daeSBarry Smith   PetscFunctionReturn(0);
22555c6c1daeSBarry Smith }
22565c6c1daeSBarry Smith 
22575c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/
22585c6c1daeSBarry Smith 
22595c6c1daeSBarry Smith 
22605c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID;
22615c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID  = 0;
22625c6c1daeSBarry Smith 
22635c6c1daeSBarry Smith /*@C
22645c6c1daeSBarry Smith   PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code.
22655c6c1daeSBarry Smith 
22665c6c1daeSBarry Smith   Not Collective
22675c6c1daeSBarry Smith 
22685c6c1daeSBarry Smith   Input Parameter:
22695c6c1daeSBarry Smith . name   - The class name
22705c6c1daeSBarry Smith 
22715c6c1daeSBarry Smith   Output Parameter:
22725c6c1daeSBarry Smith . oclass - The class id or classid
22735c6c1daeSBarry Smith 
22745c6c1daeSBarry Smith   Level: developer
22755c6c1daeSBarry Smith 
22765c6c1daeSBarry Smith @*/
22775c6c1daeSBarry Smith PetscErrorCode  PetscClassIdRegister(const char name[],PetscClassId *oclass)
22785c6c1daeSBarry Smith {
22795c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
22805c6c1daeSBarry Smith   PetscStageLog  stageLog;
22815c6c1daeSBarry Smith   PetscInt       stage;
22825c6c1daeSBarry Smith   PetscErrorCode ierr;
22835c6c1daeSBarry Smith #endif
22845c6c1daeSBarry Smith 
22855c6c1daeSBarry Smith   PetscFunctionBegin;
22865c6c1daeSBarry Smith   *oclass = ++PETSC_LARGEST_CLASSID;
22875c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
22885c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
22895c6c1daeSBarry Smith   ierr = PetscClassRegLogRegister(stageLog->classLog, name, *oclass);CHKERRQ(ierr);
22905c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
22913a88037aSBarry Smith     ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
22925c6c1daeSBarry Smith   }
22935c6c1daeSBarry Smith #endif
22945c6c1daeSBarry Smith   PetscFunctionReturn(0);
22955c6c1daeSBarry Smith }
2296210b5426SBarry Smith 
2297210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE)
2298210b5426SBarry Smith #include <mpe.h>
2299210b5426SBarry Smith 
2300210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE;
2301210b5426SBarry Smith 
2302495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
2303495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
2304495fc317SBarry Smith 
2305210b5426SBarry Smith /*@C
2306210b5426SBarry Smith    PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files
2307210b5426SBarry Smith    and slows the program down.
2308210b5426SBarry Smith 
2309210b5426SBarry Smith    Collective over PETSC_COMM_WORLD
2310210b5426SBarry Smith 
2311210b5426SBarry Smith    Options Database Keys:
2312a2553e36SBarry Smith . -log_mpe - Prints extensive log information
2313210b5426SBarry Smith 
2314210b5426SBarry Smith    Notes:
2315609bdbeeSBarry Smith    A related routine is PetscLogDefaultBegin() (with the options key -log_view), which is
2316210b5426SBarry Smith    intended for production runs since it logs only flop rates and object
2317210b5426SBarry Smith    creation (and should not significantly slow the programs).
2318210b5426SBarry Smith 
2319210b5426SBarry Smith    Level: advanced
2320210b5426SBarry Smith 
2321210b5426SBarry Smith 
2322bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogEventActivate(),
2323210b5426SBarry Smith           PetscLogEventDeactivate()
2324210b5426SBarry Smith @*/
2325210b5426SBarry Smith PetscErrorCode  PetscLogMPEBegin(void)
2326210b5426SBarry Smith {
2327210b5426SBarry Smith   PetscErrorCode ierr;
2328210b5426SBarry Smith 
2329210b5426SBarry Smith   PetscFunctionBegin;
2330210b5426SBarry Smith   /* Do MPE initialization */
2331210b5426SBarry Smith   if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */
2332210b5426SBarry Smith     ierr = PetscInfo(0,"Initializing MPE.\n");CHKERRQ(ierr);
2333210b5426SBarry Smith     ierr = MPE_Init_log();CHKERRQ(ierr);
2334210b5426SBarry Smith 
2335210b5426SBarry Smith     PetscBeganMPE = PETSC_TRUE;
2336210b5426SBarry Smith   } else {
2337210b5426SBarry Smith     ierr = PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n");CHKERRQ(ierr);
2338210b5426SBarry Smith   }
2339495fc317SBarry Smith   ierr = PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE);CHKERRQ(ierr);
2340210b5426SBarry Smith   PetscFunctionReturn(0);
2341210b5426SBarry Smith }
2342210b5426SBarry Smith 
2343210b5426SBarry Smith /*@C
2344495fc317SBarry Smith    PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot.
2345210b5426SBarry Smith 
2346210b5426SBarry Smith    Collective over PETSC_COMM_WORLD
2347210b5426SBarry Smith 
2348210b5426SBarry Smith    Level: advanced
2349210b5426SBarry Smith 
2350210b5426SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogMPEBegin()
2351210b5426SBarry Smith @*/
2352210b5426SBarry Smith PetscErrorCode  PetscLogMPEDump(const char sname[])
2353210b5426SBarry Smith {
2354210b5426SBarry Smith   char           name[PETSC_MAX_PATH_LEN];
2355210b5426SBarry Smith   PetscErrorCode ierr;
2356210b5426SBarry Smith 
2357210b5426SBarry Smith   PetscFunctionBegin;
2358210b5426SBarry Smith   if (PetscBeganMPE) {
2359210b5426SBarry Smith     ierr = PetscInfo(0,"Finalizing MPE.\n");CHKERRQ(ierr);
2360210b5426SBarry Smith     if (sname) {
2361210b5426SBarry Smith       ierr = PetscStrcpy(name,sname);CHKERRQ(ierr);
2362210b5426SBarry Smith     } else {
2363589a23caSBarry Smith       ierr = PetscGetProgramName(name,sizeof(name));CHKERRQ(ierr);
2364210b5426SBarry Smith     }
2365210b5426SBarry Smith     ierr = MPE_Finish_log(name);CHKERRQ(ierr);
2366210b5426SBarry Smith   } else {
2367210b5426SBarry Smith     ierr = PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n");CHKERRQ(ierr);
2368210b5426SBarry Smith   }
2369210b5426SBarry Smith   PetscFunctionReturn(0);
2370210b5426SBarry Smith }
2371210b5426SBarry Smith 
2372210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39
2373210b5426SBarry Smith static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = {
2374210b5426SBarry Smith   "OliveDrab:      ",
2375210b5426SBarry Smith   "BlueViolet:     ",
2376210b5426SBarry Smith   "CadetBlue:      ",
2377210b5426SBarry Smith   "CornflowerBlue: ",
2378210b5426SBarry Smith   "DarkGoldenrod:  ",
2379210b5426SBarry Smith   "DarkGreen:      ",
2380210b5426SBarry Smith   "DarkKhaki:      ",
2381210b5426SBarry Smith   "DarkOliveGreen: ",
2382210b5426SBarry Smith   "DarkOrange:     ",
2383210b5426SBarry Smith   "DarkOrchid:     ",
2384210b5426SBarry Smith   "DarkSeaGreen:   ",
2385210b5426SBarry Smith   "DarkSlateGray:  ",
2386210b5426SBarry Smith   "DarkTurquoise:  ",
2387210b5426SBarry Smith   "DeepPink:       ",
2388210b5426SBarry Smith   "DarkKhaki:      ",
2389210b5426SBarry Smith   "DimGray:        ",
2390210b5426SBarry Smith   "DodgerBlue:     ",
2391210b5426SBarry Smith   "GreenYellow:    ",
2392210b5426SBarry Smith   "HotPink:        ",
2393210b5426SBarry Smith   "IndianRed:      ",
2394210b5426SBarry Smith   "LavenderBlush:  ",
2395210b5426SBarry Smith   "LawnGreen:      ",
2396210b5426SBarry Smith   "LemonChiffon:   ",
2397210b5426SBarry Smith   "LightCoral:     ",
2398210b5426SBarry Smith   "LightCyan:      ",
2399210b5426SBarry Smith   "LightPink:      ",
2400210b5426SBarry Smith   "LightSalmon:    ",
2401210b5426SBarry Smith   "LightSlateGray: ",
2402210b5426SBarry Smith   "LightYellow:    ",
2403210b5426SBarry Smith   "LimeGreen:      ",
2404210b5426SBarry Smith   "MediumPurple:   ",
2405210b5426SBarry Smith   "MediumSeaGreen: ",
2406210b5426SBarry Smith   "MediumSlateBlue:",
2407210b5426SBarry Smith   "MidnightBlue:   ",
2408210b5426SBarry Smith   "MintCream:      ",
2409210b5426SBarry Smith   "MistyRose:      ",
2410210b5426SBarry Smith   "NavajoWhite:    ",
2411210b5426SBarry Smith   "NavyBlue:       ",
2412210b5426SBarry Smith   "OliveDrab:      "
2413210b5426SBarry Smith };
2414210b5426SBarry Smith 
2415210b5426SBarry Smith /*@C
2416210b5426SBarry Smith   PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister()
2417210b5426SBarry Smith 
2418210b5426SBarry Smith   Not collective. Maybe it should be?
2419210b5426SBarry Smith 
24207a7aea1fSJed Brown   Output Parameter:
2421210b5426SBarry Smith . str - character string representing the color
2422210b5426SBarry Smith 
2423210b5426SBarry Smith   Level: developer
2424210b5426SBarry Smith 
2425210b5426SBarry Smith .seealso: PetscLogEventRegister
2426210b5426SBarry Smith @*/
2427210b5426SBarry Smith PetscErrorCode  PetscLogMPEGetRGBColor(const char *str[])
2428210b5426SBarry Smith {
2429210b5426SBarry Smith   static int idx = 0;
2430210b5426SBarry Smith 
2431210b5426SBarry Smith   PetscFunctionBegin;
2432210b5426SBarry Smith   *str = PetscLogMPERGBColors[idx];
2433210b5426SBarry Smith   idx  = (idx + 1)% PETSC_RGB_COLORS_MAX;
2434210b5426SBarry Smith   PetscFunctionReturn(0);
2435210b5426SBarry Smith }
2436210b5426SBarry Smith 
2437210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */
2438