xref: /petsc/src/sys/logging/plog.c (revision c15bc2c4e28c0c71b84e49a4bd7131bc0529bce0)
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 */
835c6c1daeSBarry Smith 
845c6c1daeSBarry Smith /* Logging functions */
850298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL;
860298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL;
870298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL;
880298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL;
895c6c1daeSBarry Smith 
905c6c1daeSBarry Smith /* Tracing event logging variables */
910298fd71SBarry Smith FILE             *petsc_tracefile            = NULL;
925c6c1daeSBarry Smith int              petsc_tracelevel            = 0;
935c6c1daeSBarry Smith const char       *petsc_traceblanks          = "                                                                                                    ";
945c6c1daeSBarry Smith char             petsc_tracespace[128]       = " ";
955c6c1daeSBarry Smith PetscLogDouble   petsc_tracetime             = 0.0;
96896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE;
975c6c1daeSBarry Smith 
9895c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogInitialize(void)
99fa2bb9feSLisandro Dalcin {
100fa2bb9feSLisandro Dalcin   int            stage;
101fa2bb9feSLisandro Dalcin   PetscBool      opt;
102fa2bb9feSLisandro Dalcin   PetscErrorCode ierr;
1035c6c1daeSBarry Smith 
104fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
105fa2bb9feSLisandro Dalcin   if (PetscLogInitializeCalled) PetscFunctionReturn(0);
106fa2bb9feSLisandro Dalcin   PetscLogInitializeCalled = PETSC_TRUE;
1075c6c1daeSBarry Smith 
108fa2bb9feSLisandro Dalcin   ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_actions", &opt);CHKERRQ(ierr);
109fa2bb9feSLisandro Dalcin   if (opt) petsc_logActions = PETSC_FALSE;
110fa2bb9feSLisandro Dalcin   ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_objects", &opt);CHKERRQ(ierr);
111fa2bb9feSLisandro Dalcin   if (opt) petsc_logObjects = PETSC_FALSE;
112fa2bb9feSLisandro Dalcin   if (petsc_logActions) {
113fa2bb9feSLisandro Dalcin     ierr = PetscMalloc1(petsc_maxActions, &petsc_actions);CHKERRQ(ierr);
114fa2bb9feSLisandro Dalcin   }
115fa2bb9feSLisandro Dalcin   if (petsc_logObjects) {
116fa2bb9feSLisandro Dalcin     ierr = PetscMalloc1(petsc_maxObjects, &petsc_objects);CHKERRQ(ierr);
117fa2bb9feSLisandro Dalcin   }
118fa2bb9feSLisandro Dalcin   PetscLogPHC = PetscLogObjCreateDefault;
119fa2bb9feSLisandro Dalcin   PetscLogPHD = PetscLogObjDestroyDefault;
120fa2bb9feSLisandro Dalcin   /* Setup default logging structures */
121fa2bb9feSLisandro Dalcin   ierr = PetscStageLogCreate(&petsc_stageLog);CHKERRQ(ierr);
122fa2bb9feSLisandro Dalcin   ierr = PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage);CHKERRQ(ierr);
1235c6c1daeSBarry Smith 
124fa2bb9feSLisandro Dalcin   /* All processors sync here for more consistent logging */
125fa2bb9feSLisandro Dalcin   ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
126fa2bb9feSLisandro Dalcin   PetscTime(&petsc_BaseTime);
127fa2bb9feSLisandro Dalcin   ierr = PetscLogStagePush(stage);CHKERRQ(ierr);
128fa2bb9feSLisandro Dalcin   PetscFunctionReturn(0);
129fa2bb9feSLisandro Dalcin }
1305c6c1daeSBarry Smith 
13195c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogFinalize(void)
1325c6c1daeSBarry Smith {
1335c6c1daeSBarry Smith   PetscStageLog  stageLog;
1345c6c1daeSBarry Smith   PetscErrorCode ierr;
1355c6c1daeSBarry Smith 
1365c6c1daeSBarry Smith   PetscFunctionBegin;
1375c6c1daeSBarry Smith   ierr = PetscFree(petsc_actions);CHKERRQ(ierr);
1385c6c1daeSBarry Smith   ierr = PetscFree(petsc_objects);CHKERRQ(ierr);
139eccbb886SLisandro Dalcin   ierr = PetscLogNestedEnd();CHKERRQ(ierr);
1400298fd71SBarry Smith   ierr = PetscLogSet(NULL, NULL);CHKERRQ(ierr);
1415c6c1daeSBarry Smith 
1425c6c1daeSBarry Smith   /* Resetting phase */
1435c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
1445c6c1daeSBarry Smith   ierr = PetscStageLogDestroy(stageLog);CHKERRQ(ierr);
145a297a907SKarl Rupp 
1465c6c1daeSBarry Smith   petsc_TotalFlops            = 0.0;
1475c6c1daeSBarry Smith   petsc_numActions            = 0;
1485c6c1daeSBarry Smith   petsc_numObjects            = 0;
1495c6c1daeSBarry Smith   petsc_numObjectsDestroyed   = 0;
1505c6c1daeSBarry Smith   petsc_maxActions            = 100;
1515c6c1daeSBarry Smith   petsc_maxObjects            = 100;
1520298fd71SBarry Smith   petsc_actions               = NULL;
1530298fd71SBarry Smith   petsc_objects               = NULL;
1545c6c1daeSBarry Smith   petsc_logActions            = PETSC_FALSE;
1555c6c1daeSBarry Smith   petsc_logObjects            = PETSC_FALSE;
1565c6c1daeSBarry Smith   petsc_BaseTime              = 0.0;
1575c6c1daeSBarry Smith   petsc_TotalFlops            = 0.0;
1585c6c1daeSBarry Smith   petsc_tmp_flops             = 0.0;
1595c6c1daeSBarry Smith   petsc_send_ct               = 0.0;
1605c6c1daeSBarry Smith   petsc_recv_ct               = 0.0;
1615c6c1daeSBarry Smith   petsc_send_len              = 0.0;
1625c6c1daeSBarry Smith   petsc_recv_len              = 0.0;
1635c6c1daeSBarry Smith   petsc_isend_ct              = 0.0;
1645c6c1daeSBarry Smith   petsc_irecv_ct              = 0.0;
1655c6c1daeSBarry Smith   petsc_isend_len             = 0.0;
1665c6c1daeSBarry Smith   petsc_irecv_len             = 0.0;
1675c6c1daeSBarry Smith   petsc_wait_ct               = 0.0;
1685c6c1daeSBarry Smith   petsc_wait_any_ct           = 0.0;
1695c6c1daeSBarry Smith   petsc_wait_all_ct           = 0.0;
1705c6c1daeSBarry Smith   petsc_sum_of_waits_ct       = 0.0;
1715c6c1daeSBarry Smith   petsc_allreduce_ct          = 0.0;
1725c6c1daeSBarry Smith   petsc_gather_ct             = 0.0;
1735c6c1daeSBarry Smith   petsc_scatter_ct            = 0.0;
1745c6c1daeSBarry Smith   PETSC_LARGEST_EVENT         = PETSC_EVENT;
1750298fd71SBarry Smith   PetscLogPHC                 = NULL;
1760298fd71SBarry Smith   PetscLogPHD                 = NULL;
1770298fd71SBarry Smith   petsc_tracefile             = NULL;
1785c6c1daeSBarry Smith   petsc_tracelevel            = 0;
1795c6c1daeSBarry Smith   petsc_traceblanks           = "                                                                                                    ";
1805c6c1daeSBarry Smith   petsc_tracespace[0]         = ' '; petsc_tracespace[1] = 0;
1815c6c1daeSBarry Smith   petsc_tracetime             = 0.0;
1825c6c1daeSBarry Smith   PETSC_LARGEST_CLASSID       = PETSC_SMALLEST_CLASSID;
1835c6c1daeSBarry Smith   PETSC_OBJECT_CLASSID        = 0;
1845c6c1daeSBarry Smith   petsc_stageLog              = 0;
185896238b9SBarry Smith   PetscLogInitializeCalled    = PETSC_FALSE;
1865c6c1daeSBarry Smith   PetscFunctionReturn(0);
1875c6c1daeSBarry Smith }
1885c6c1daeSBarry Smith 
1895c6c1daeSBarry Smith /*@C
1905c6c1daeSBarry Smith   PetscLogSet - Sets the logging functions called at the beginning and ending of every event.
1915c6c1daeSBarry Smith 
1925c6c1daeSBarry Smith   Not Collective
1935c6c1daeSBarry Smith 
1945c6c1daeSBarry Smith   Input Parameters:
1955c6c1daeSBarry Smith + b - The function called at beginning of event
1965c6c1daeSBarry Smith - e - The function called at end of event
1975c6c1daeSBarry Smith 
1985c6c1daeSBarry Smith   Level: developer
1995c6c1daeSBarry Smith 
200bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogTraceBegin()
2015c6c1daeSBarry Smith @*/
2025c6c1daeSBarry Smith PetscErrorCode  PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject),
2035c6c1daeSBarry Smith                             PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject))
2045c6c1daeSBarry Smith {
2055c6c1daeSBarry Smith   PetscFunctionBegin;
2065c6c1daeSBarry Smith   PetscLogPLB = b;
2075c6c1daeSBarry Smith   PetscLogPLE = e;
2085c6c1daeSBarry Smith   PetscFunctionReturn(0);
2095c6c1daeSBarry Smith }
2105c6c1daeSBarry Smith 
2115c6c1daeSBarry Smith /*@C
212bb1d7374SBarry Smith   PetscLogDefaultBegin - Turns on logging of objects and events. This logs flop
2135c6c1daeSBarry Smith   rates and object creation and should not slow programs down too much.
2145c6c1daeSBarry Smith   This routine may be called more than once.
2155c6c1daeSBarry Smith 
2165c6c1daeSBarry Smith   Logically Collective over PETSC_COMM_WORLD
2175c6c1daeSBarry Smith 
2185c6c1daeSBarry Smith   Options Database Keys:
219a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the
220a2553e36SBarry Smith                   screen (for code configured with --with-log=1 (which is the default))
2215c6c1daeSBarry Smith 
2225c6c1daeSBarry Smith   Usage:
2235c6c1daeSBarry Smith .vb
2245c6c1daeSBarry Smith       PetscInitialize(...);
225bb1d7374SBarry Smith       PetscLogDefaultBegin();
2265c6c1daeSBarry Smith        ... code ...
2275c6c1daeSBarry Smith       PetscLogView(viewer); or PetscLogDump();
2285c6c1daeSBarry Smith       PetscFinalize();
2295c6c1daeSBarry Smith .ve
2305c6c1daeSBarry Smith 
2315c6c1daeSBarry Smith   Notes:
2325c6c1daeSBarry Smith   PetscLogView(viewer) or PetscLogDump() actually cause the printing of
2335c6c1daeSBarry Smith   the logging information.
2345c6c1daeSBarry Smith 
2355c6c1daeSBarry Smith   Level: advanced
2365c6c1daeSBarry Smith 
2375c6c1daeSBarry Smith .keywords: log, begin
2385c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogTraceBegin()
2395c6c1daeSBarry Smith @*/
240bb1d7374SBarry Smith PetscErrorCode  PetscLogDefaultBegin(void)
2415c6c1daeSBarry Smith {
2425c6c1daeSBarry Smith   PetscErrorCode ierr;
2435c6c1daeSBarry Smith 
2445c6c1daeSBarry Smith   PetscFunctionBegin;
2455c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault);CHKERRQ(ierr);
2465c6c1daeSBarry Smith   PetscFunctionReturn(0);
2475c6c1daeSBarry Smith }
2485c6c1daeSBarry Smith 
2495c6c1daeSBarry Smith /*@C
2505c6c1daeSBarry Smith   PetscLogAllBegin - Turns on extensive logging of objects and events. Logs
2515c6c1daeSBarry Smith   all events. This creates large log files and slows the program down.
2525c6c1daeSBarry Smith 
2535c6c1daeSBarry Smith   Logically Collective on PETSC_COMM_WORLD
2545c6c1daeSBarry Smith 
2555c6c1daeSBarry Smith   Options Database Keys:
256a2553e36SBarry Smith . -log_all - Prints extensive log information
2575c6c1daeSBarry Smith 
2585c6c1daeSBarry Smith   Usage:
2595c6c1daeSBarry Smith .vb
2605c6c1daeSBarry Smith      PetscInitialize(...);
2615c6c1daeSBarry Smith      PetscLogAllBegin();
2625c6c1daeSBarry Smith      ... code ...
2635c6c1daeSBarry Smith      PetscLogDump(filename);
2645c6c1daeSBarry Smith      PetscFinalize();
2655c6c1daeSBarry Smith .ve
2665c6c1daeSBarry Smith 
2675c6c1daeSBarry Smith   Notes:
268bb1d7374SBarry Smith   A related routine is PetscLogDefaultBegin() (with the options key -log), which is
2695c6c1daeSBarry Smith   intended for production runs since it logs only flop rates and object
2705c6c1daeSBarry Smith   creation (and shouldn't significantly slow the programs).
2715c6c1daeSBarry Smith 
2725c6c1daeSBarry Smith   Level: advanced
2735c6c1daeSBarry Smith 
2745c6c1daeSBarry Smith .keywords: log, all, begin
275bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogTraceBegin()
2765c6c1daeSBarry Smith @*/
2775c6c1daeSBarry Smith PetscErrorCode  PetscLogAllBegin(void)
2785c6c1daeSBarry Smith {
2795c6c1daeSBarry Smith   PetscErrorCode ierr;
2805c6c1daeSBarry Smith 
2815c6c1daeSBarry Smith   PetscFunctionBegin;
2825c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete);CHKERRQ(ierr);
2835c6c1daeSBarry Smith   PetscFunctionReturn(0);
2845c6c1daeSBarry Smith }
2855c6c1daeSBarry Smith 
2865c6c1daeSBarry Smith /*@
2875c6c1daeSBarry Smith   PetscLogTraceBegin - Activates trace logging.  Every time a PETSc event
2885c6c1daeSBarry Smith   begins or ends, the event name is printed.
2895c6c1daeSBarry Smith 
2905c6c1daeSBarry Smith   Logically Collective on PETSC_COMM_WORLD
2915c6c1daeSBarry Smith 
2925c6c1daeSBarry Smith   Input Parameter:
2935c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout)
2945c6c1daeSBarry Smith 
2955c6c1daeSBarry Smith   Options Database Key:
2965c6c1daeSBarry Smith . -log_trace [filename] - Activates PetscLogTraceBegin()
2975c6c1daeSBarry Smith 
2985c6c1daeSBarry Smith   Notes:
2995c6c1daeSBarry Smith   PetscLogTraceBegin() prints the processor number, the execution time (sec),
3005c6c1daeSBarry Smith   then "Event begin:" or "Event end:" followed by the event name.
3015c6c1daeSBarry Smith 
3025c6c1daeSBarry Smith   PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful
3035c6c1daeSBarry Smith   to determine where a program is hanging without running in the
3045c6c1daeSBarry Smith   debugger.  Can be used in conjunction with the -info option.
3055c6c1daeSBarry Smith 
3065c6c1daeSBarry Smith   Level: intermediate
3075c6c1daeSBarry Smith 
308bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogDefaultBegin()
3095c6c1daeSBarry Smith @*/
3105c6c1daeSBarry Smith PetscErrorCode  PetscLogTraceBegin(FILE *file)
3115c6c1daeSBarry Smith {
3125c6c1daeSBarry Smith   PetscErrorCode ierr;
3135c6c1daeSBarry Smith 
3145c6c1daeSBarry Smith   PetscFunctionBegin;
3155c6c1daeSBarry Smith   petsc_tracefile = file;
316a297a907SKarl Rupp 
3175c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace);CHKERRQ(ierr);
3185c6c1daeSBarry Smith   PetscFunctionReturn(0);
3195c6c1daeSBarry Smith }
3205c6c1daeSBarry Smith 
3215c6c1daeSBarry Smith /*@
3225c6c1daeSBarry Smith   PetscLogActions - Determines whether actions are logged for the graphical viewer.
3235c6c1daeSBarry Smith 
3245c6c1daeSBarry Smith   Not Collective
3255c6c1daeSBarry Smith 
3265c6c1daeSBarry Smith   Input Parameter:
3275c6c1daeSBarry Smith . flag - PETSC_TRUE if actions are to be logged
3285c6c1daeSBarry Smith 
3295c6c1daeSBarry Smith   Level: intermediate
3305c6c1daeSBarry Smith 
3315c6c1daeSBarry Smith   Note: Logging of actions continues to consume more memory as the program
3325c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
3335c6c1daeSBarry Smith 
3345c6c1daeSBarry Smith   Options Database Keys:
3355c6c1daeSBarry Smith . -log_exclude_actions - Turns off actions logging
3365c6c1daeSBarry Smith 
3375c6c1daeSBarry Smith .keywords: log, stage, register
3385c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
3395c6c1daeSBarry Smith @*/
3405c6c1daeSBarry Smith PetscErrorCode  PetscLogActions(PetscBool flag)
3415c6c1daeSBarry Smith {
3425c6c1daeSBarry Smith   PetscFunctionBegin;
3435c6c1daeSBarry Smith   petsc_logActions = flag;
3445c6c1daeSBarry Smith   PetscFunctionReturn(0);
3455c6c1daeSBarry Smith }
3465c6c1daeSBarry Smith 
3475c6c1daeSBarry Smith /*@
3485c6c1daeSBarry Smith   PetscLogObjects - Determines whether objects are logged for the graphical viewer.
3495c6c1daeSBarry Smith 
3505c6c1daeSBarry Smith   Not Collective
3515c6c1daeSBarry Smith 
3525c6c1daeSBarry Smith   Input Parameter:
3535c6c1daeSBarry Smith . flag - PETSC_TRUE if objects are to be logged
3545c6c1daeSBarry Smith 
3555c6c1daeSBarry Smith   Level: intermediate
3565c6c1daeSBarry Smith 
3575c6c1daeSBarry Smith   Note: Logging of objects continues to consume more memory as the program
3585c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
3595c6c1daeSBarry Smith 
3605c6c1daeSBarry Smith   Options Database Keys:
3615c6c1daeSBarry Smith . -log_exclude_objects - Turns off objects logging
3625c6c1daeSBarry Smith 
3635c6c1daeSBarry Smith .keywords: log, stage, register
3645c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
3655c6c1daeSBarry Smith @*/
3665c6c1daeSBarry Smith PetscErrorCode  PetscLogObjects(PetscBool flag)
3675c6c1daeSBarry Smith {
3685c6c1daeSBarry Smith   PetscFunctionBegin;
3695c6c1daeSBarry Smith   petsc_logObjects = flag;
3705c6c1daeSBarry Smith   PetscFunctionReturn(0);
3715c6c1daeSBarry Smith }
3725c6c1daeSBarry Smith 
3735c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/
3745c6c1daeSBarry Smith /*@C
37574c0405dSRichard Tran Mills   PetscLogStageRegister - Attaches a character string name to a logging stage.
3765c6c1daeSBarry Smith 
3775c6c1daeSBarry Smith   Not Collective
3785c6c1daeSBarry Smith 
3795c6c1daeSBarry Smith   Input Parameter:
3805c6c1daeSBarry Smith . sname - The name to associate with that stage
3815c6c1daeSBarry Smith 
3825c6c1daeSBarry Smith   Output Parameter:
3835c6c1daeSBarry Smith . stage - The stage number
3845c6c1daeSBarry Smith 
3855c6c1daeSBarry Smith   Level: intermediate
3865c6c1daeSBarry Smith 
3875c6c1daeSBarry Smith .keywords: log, stage, register
3885c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
3895c6c1daeSBarry Smith @*/
3905c6c1daeSBarry Smith PetscErrorCode  PetscLogStageRegister(const char sname[],PetscLogStage *stage)
3915c6c1daeSBarry Smith {
3925c6c1daeSBarry Smith   PetscStageLog  stageLog;
3935c6c1daeSBarry Smith   PetscLogEvent  event;
3945c6c1daeSBarry Smith   PetscErrorCode ierr;
3955c6c1daeSBarry Smith 
3965c6c1daeSBarry Smith   PetscFunctionBegin;
3975c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
3985c6c1daeSBarry Smith   ierr = PetscStageLogRegister(stageLog, sname, stage);CHKERRQ(ierr);
3995c6c1daeSBarry Smith   /* Copy events already changed in the main stage, this sucks */
4003a88037aSBarry Smith   ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr);
4015c6c1daeSBarry Smith   for (event = 0; event < stageLog->eventLog->numEvents; event++) {
4023a88037aSBarry Smith     ierr = PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event],&stageLog->stageInfo[*stage].eventLog->eventInfo[event]);CHKERRQ(ierr);
4035c6c1daeSBarry Smith   }
4043a88037aSBarry Smith   ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
4055c6c1daeSBarry Smith   PetscFunctionReturn(0);
4065c6c1daeSBarry Smith }
4075c6c1daeSBarry Smith 
4085c6c1daeSBarry Smith /*@C
4095c6c1daeSBarry Smith   PetscLogStagePush - This function pushes a stage on the stack.
4105c6c1daeSBarry Smith 
4115c6c1daeSBarry Smith   Not Collective
4125c6c1daeSBarry Smith 
4135c6c1daeSBarry Smith   Input Parameter:
4145c6c1daeSBarry Smith . stage - The stage on which to log
4155c6c1daeSBarry Smith 
4165c6c1daeSBarry Smith   Usage:
4175c6c1daeSBarry Smith   If the option -log_sumary is used to run the program containing the
4185c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
4195c6c1daeSBarry Smith   PetscFinalize().
4205c6c1daeSBarry Smith .vb
4215c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
4225c6c1daeSBarry Smith       [stage 0 of code]
4235c6c1daeSBarry Smith       PetscLogStagePush(1);
4245c6c1daeSBarry Smith       [stage 1 of code]
4255c6c1daeSBarry Smith       PetscLogStagePop();
4265c6c1daeSBarry Smith       PetscBarrier(...);
4275c6c1daeSBarry Smith       [more stage 0 of code]
4285c6c1daeSBarry Smith       PetscFinalize();
4295c6c1daeSBarry Smith .ve
4305c6c1daeSBarry Smith 
4315c6c1daeSBarry Smith   Notes:
4325c6c1daeSBarry Smith   Use PetscLogStageRegister() to register a stage.
4335c6c1daeSBarry Smith 
4345c6c1daeSBarry Smith   Level: intermediate
4355c6c1daeSBarry Smith 
4365c6c1daeSBarry Smith .keywords: log, push, stage
4375c6c1daeSBarry Smith .seealso: PetscLogStagePop(), PetscLogStageRegister(), PetscBarrier()
4385c6c1daeSBarry Smith @*/
4395c6c1daeSBarry Smith PetscErrorCode  PetscLogStagePush(PetscLogStage stage)
4405c6c1daeSBarry Smith {
4415c6c1daeSBarry Smith   PetscStageLog  stageLog;
4425c6c1daeSBarry Smith   PetscErrorCode ierr;
4435c6c1daeSBarry Smith 
4445c6c1daeSBarry Smith   PetscFunctionBegin;
4455c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
4465c6c1daeSBarry Smith   ierr = PetscStageLogPush(stageLog, stage);CHKERRQ(ierr);
4475c6c1daeSBarry Smith   PetscFunctionReturn(0);
4485c6c1daeSBarry Smith }
4495c6c1daeSBarry Smith 
4505c6c1daeSBarry Smith /*@C
4515c6c1daeSBarry Smith   PetscLogStagePop - This function pops a stage from the stack.
4525c6c1daeSBarry Smith 
4535c6c1daeSBarry Smith   Not Collective
4545c6c1daeSBarry Smith 
4555c6c1daeSBarry Smith   Usage:
4565c6c1daeSBarry Smith   If the option -log_sumary is used to run the program containing the
4575c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
4585c6c1daeSBarry Smith   PetscFinalize().
4595c6c1daeSBarry Smith .vb
4605c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
4615c6c1daeSBarry Smith       [stage 0 of code]
4625c6c1daeSBarry Smith       PetscLogStagePush(1);
4635c6c1daeSBarry Smith       [stage 1 of code]
4645c6c1daeSBarry Smith       PetscLogStagePop();
4655c6c1daeSBarry Smith       PetscBarrier(...);
4665c6c1daeSBarry Smith       [more stage 0 of code]
4675c6c1daeSBarry Smith       PetscFinalize();
4685c6c1daeSBarry Smith .ve
4695c6c1daeSBarry Smith 
4705c6c1daeSBarry Smith   Notes:
4715c6c1daeSBarry Smith   Use PetscLogStageRegister() to register a stage.
4725c6c1daeSBarry Smith 
4735c6c1daeSBarry Smith   Level: intermediate
4745c6c1daeSBarry Smith 
4755c6c1daeSBarry Smith .keywords: log, pop, stage
4765c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStageRegister(), PetscBarrier()
4775c6c1daeSBarry Smith @*/
4785c6c1daeSBarry Smith PetscErrorCode  PetscLogStagePop(void)
4795c6c1daeSBarry Smith {
4805c6c1daeSBarry Smith   PetscStageLog  stageLog;
4815c6c1daeSBarry Smith   PetscErrorCode ierr;
4825c6c1daeSBarry Smith 
4835c6c1daeSBarry Smith   PetscFunctionBegin;
4845c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
4855c6c1daeSBarry Smith   ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr);
4865c6c1daeSBarry Smith   PetscFunctionReturn(0);
4875c6c1daeSBarry Smith }
4885c6c1daeSBarry Smith 
4895c6c1daeSBarry Smith /*@
4905c6c1daeSBarry Smith   PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd().
4915c6c1daeSBarry Smith 
4925c6c1daeSBarry Smith   Not Collective
4935c6c1daeSBarry Smith 
4945c6c1daeSBarry Smith   Input Parameters:
4955c6c1daeSBarry Smith + stage    - The stage
4965c6c1daeSBarry Smith - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE)
4975c6c1daeSBarry Smith 
4985c6c1daeSBarry Smith   Level: intermediate
4995c6c1daeSBarry Smith 
5005c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
5015c6c1daeSBarry Smith @*/
5025c6c1daeSBarry Smith PetscErrorCode  PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive)
5035c6c1daeSBarry Smith {
5045c6c1daeSBarry Smith   PetscStageLog  stageLog;
5055c6c1daeSBarry Smith   PetscErrorCode ierr;
5065c6c1daeSBarry Smith 
5075c6c1daeSBarry Smith   PetscFunctionBegin;
5085c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5095c6c1daeSBarry Smith   ierr = PetscStageLogSetActive(stageLog, stage, isActive);CHKERRQ(ierr);
5105c6c1daeSBarry Smith   PetscFunctionReturn(0);
5115c6c1daeSBarry Smith }
5125c6c1daeSBarry Smith 
5135c6c1daeSBarry Smith /*@
5145c6c1daeSBarry Smith   PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd().
5155c6c1daeSBarry Smith 
5165c6c1daeSBarry Smith   Not Collective
5175c6c1daeSBarry Smith 
5185c6c1daeSBarry Smith   Input Parameter:
5195c6c1daeSBarry Smith . stage    - The stage
5205c6c1daeSBarry Smith 
5215c6c1daeSBarry Smith   Output Parameter:
5225c6c1daeSBarry Smith . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE)
5235c6c1daeSBarry Smith 
5245c6c1daeSBarry Smith   Level: intermediate
5255c6c1daeSBarry Smith 
5265c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
5275c6c1daeSBarry Smith @*/
5285c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetActive(PetscLogStage stage, PetscBool  *isActive)
5295c6c1daeSBarry Smith {
5305c6c1daeSBarry Smith   PetscStageLog  stageLog;
5315c6c1daeSBarry Smith   PetscErrorCode ierr;
5325c6c1daeSBarry Smith 
5335c6c1daeSBarry Smith   PetscFunctionBegin;
5345c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5355c6c1daeSBarry Smith   ierr = PetscStageLogGetActive(stageLog, stage, isActive);CHKERRQ(ierr);
5365c6c1daeSBarry Smith   PetscFunctionReturn(0);
5375c6c1daeSBarry Smith }
5385c6c1daeSBarry Smith 
5395c6c1daeSBarry Smith /*@
5405c6c1daeSBarry Smith   PetscLogStageSetVisible - Determines stage visibility in PetscLogView()
5415c6c1daeSBarry Smith 
5425c6c1daeSBarry Smith   Not Collective
5435c6c1daeSBarry Smith 
5445c6c1daeSBarry Smith   Input Parameters:
5455c6c1daeSBarry Smith + stage     - The stage
5465c6c1daeSBarry Smith - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE)
5475c6c1daeSBarry Smith 
5485c6c1daeSBarry Smith   Level: intermediate
5495c6c1daeSBarry Smith 
5505c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView()
5515c6c1daeSBarry Smith @*/
5525c6c1daeSBarry Smith PetscErrorCode  PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible)
5535c6c1daeSBarry Smith {
5545c6c1daeSBarry Smith   PetscStageLog  stageLog;
5555c6c1daeSBarry Smith   PetscErrorCode ierr;
5565c6c1daeSBarry Smith 
5575c6c1daeSBarry Smith   PetscFunctionBegin;
5585c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5595c6c1daeSBarry Smith   ierr = PetscStageLogSetVisible(stageLog, stage, isVisible);CHKERRQ(ierr);
5605c6c1daeSBarry Smith   PetscFunctionReturn(0);
5615c6c1daeSBarry Smith }
5625c6c1daeSBarry Smith 
5635c6c1daeSBarry Smith /*@
5645c6c1daeSBarry Smith   PetscLogStageGetVisible - Returns stage visibility in PetscLogView()
5655c6c1daeSBarry Smith 
5665c6c1daeSBarry Smith   Not Collective
5675c6c1daeSBarry Smith 
5685c6c1daeSBarry Smith   Input Parameter:
5695c6c1daeSBarry Smith . stage     - The stage
5705c6c1daeSBarry Smith 
5715c6c1daeSBarry Smith   Output Parameter:
5725c6c1daeSBarry Smith . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE)
5735c6c1daeSBarry Smith 
5745c6c1daeSBarry Smith   Level: intermediate
5755c6c1daeSBarry Smith 
5765c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView()
5775c6c1daeSBarry Smith @*/
5785c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetVisible(PetscLogStage stage, PetscBool  *isVisible)
5795c6c1daeSBarry Smith {
5805c6c1daeSBarry Smith   PetscStageLog  stageLog;
5815c6c1daeSBarry Smith   PetscErrorCode ierr;
5825c6c1daeSBarry Smith 
5835c6c1daeSBarry Smith   PetscFunctionBegin;
5845c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5855c6c1daeSBarry Smith   ierr = PetscStageLogGetVisible(stageLog, stage, isVisible);CHKERRQ(ierr);
5865c6c1daeSBarry Smith   PetscFunctionReturn(0);
5875c6c1daeSBarry Smith }
5885c6c1daeSBarry Smith 
5895c6c1daeSBarry Smith /*@C
5905c6c1daeSBarry Smith   PetscLogStageGetId - Returns the stage id when given the stage name.
5915c6c1daeSBarry Smith 
5925c6c1daeSBarry Smith   Not Collective
5935c6c1daeSBarry Smith 
5945c6c1daeSBarry Smith   Input Parameter:
5955c6c1daeSBarry Smith . name  - The stage name
5965c6c1daeSBarry Smith 
5975c6c1daeSBarry Smith   Output Parameter:
5985a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists
5995c6c1daeSBarry Smith 
6005c6c1daeSBarry Smith   Level: intermediate
6015c6c1daeSBarry Smith 
6025c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
6035c6c1daeSBarry Smith @*/
6045c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetId(const char name[], PetscLogStage *stage)
6055c6c1daeSBarry Smith {
6065c6c1daeSBarry Smith   PetscStageLog  stageLog;
6075c6c1daeSBarry Smith   PetscErrorCode ierr;
6085c6c1daeSBarry Smith 
6095c6c1daeSBarry Smith   PetscFunctionBegin;
6105c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
6115c6c1daeSBarry Smith   ierr = PetscStageLogGetStage(stageLog, name, stage);CHKERRQ(ierr);
6125c6c1daeSBarry Smith   PetscFunctionReturn(0);
6135c6c1daeSBarry Smith }
6145c6c1daeSBarry Smith 
6155c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/
6165c6c1daeSBarry Smith /*@C
6175c6c1daeSBarry Smith   PetscLogEventRegister - Registers an event name for logging operations in an application code.
6185c6c1daeSBarry Smith 
6195c6c1daeSBarry Smith   Not Collective
6205c6c1daeSBarry Smith 
6215c6c1daeSBarry Smith   Input Parameter:
6225c6c1daeSBarry Smith + name   - The name associated with the event
6235c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with
6245c6c1daeSBarry Smith            PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones
6255c6c1daeSBarry Smith            are only available in C code
6265c6c1daeSBarry Smith 
6275c6c1daeSBarry Smith   Output Parameter:
6285c6c1daeSBarry Smith . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd().
6295c6c1daeSBarry Smith 
6305c6c1daeSBarry Smith   Example of Usage:
6315c6c1daeSBarry Smith .vb
6325c6c1daeSBarry Smith       PetscLogEvent USER_EVENT;
6335c6c1daeSBarry Smith       PetscClassId classid;
6345c6c1daeSBarry Smith       PetscLogDouble user_event_flops;
6355c6c1daeSBarry Smith       PetscClassIdRegister("class name",&classid);
6365c6c1daeSBarry Smith       PetscLogEventRegister("User event name",classid,&USER_EVENT);
6375c6c1daeSBarry Smith       PetscLogEventBegin(USER_EVENT,0,0,0,0);
6385c6c1daeSBarry Smith          [code segment to monitor]
6395c6c1daeSBarry Smith          PetscLogFlops(user_event_flops);
6405c6c1daeSBarry Smith       PetscLogEventEnd(USER_EVENT,0,0,0,0);
6415c6c1daeSBarry Smith .ve
6425c6c1daeSBarry Smith 
6435c6c1daeSBarry Smith   Notes:
6445c6c1daeSBarry Smith   PETSc automatically logs library events if the code has been
645a2553e36SBarry Smith   configured with --with-log (which is the default) and
646a2553e36SBarry Smith   -log_view or -log_all is specified.  PetscLogEventRegister() is
6475c6c1daeSBarry Smith   intended for logging user events to supplement this PETSc
6485c6c1daeSBarry Smith   information.
6495c6c1daeSBarry Smith 
650495fc317SBarry Smith   PETSc can gather data for use with the utilities Jumpshot
6515c6c1daeSBarry Smith   (part of the MPICH distribution).  If PETSc has been compiled
6525c6c1daeSBarry Smith   with flag -DPETSC_HAVE_MPE (MPE is an additional utility within
6535c6c1daeSBarry Smith   MPICH), the user can employ another command line option, -log_mpe,
6545c6c1daeSBarry Smith   to create a logfile, "mpe.log", which can be visualized
655495fc317SBarry Smith   Jumpshot.
6565c6c1daeSBarry Smith 
6575c6c1daeSBarry Smith   The classid is associated with each event so that classes of events
6585c6c1daeSBarry Smith   can be disabled simultaneously, such as all matrix events. The user
6595c6c1daeSBarry Smith   can either use an existing classid, such as MAT_CLASSID, or create
6605c6c1daeSBarry Smith   their own as shown in the example.
6615c6c1daeSBarry Smith 
662c5deb1d5SJed Brown   If an existing event with the same name exists, its event handle is
663c5deb1d5SJed Brown   returned instead of creating a new event.
664c5deb1d5SJed Brown 
6655c6c1daeSBarry Smith   Level: intermediate
6665c6c1daeSBarry Smith 
6675c6c1daeSBarry Smith .keywords: log, event, register
6685c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogFlops(),
6695c6c1daeSBarry Smith           PetscLogEventActivate(), PetscLogEventDeactivate(), PetscClassIdRegister()
6705c6c1daeSBarry Smith @*/
6715c6c1daeSBarry Smith PetscErrorCode  PetscLogEventRegister(const char name[],PetscClassId classid,PetscLogEvent *event)
6725c6c1daeSBarry Smith {
6735c6c1daeSBarry Smith   PetscStageLog  stageLog;
6745c6c1daeSBarry Smith   int            stage;
6755c6c1daeSBarry Smith   PetscErrorCode ierr;
6765c6c1daeSBarry Smith 
6775c6c1daeSBarry Smith   PetscFunctionBegin;
6785c6c1daeSBarry Smith   *event = PETSC_DECIDE;
6795c6c1daeSBarry Smith   ierr   = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
6803a88037aSBarry Smith   ierr   = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr);
681c5deb1d5SJed Brown   if (*event > 0) PetscFunctionReturn(0);
6823a88037aSBarry Smith   ierr   = PetscEventRegLogRegister(stageLog->eventLog, name, classid, event);CHKERRQ(ierr);
6835c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
6843a88037aSBarry Smith     ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr);
6853a88037aSBarry Smith     ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
6865c6c1daeSBarry Smith   }
6875c6c1daeSBarry Smith   PetscFunctionReturn(0);
6885c6c1daeSBarry Smith }
6895c6c1daeSBarry Smith 
6905c6c1daeSBarry Smith /*@
691217044c2SLisandro Dalcin   PetscLogEventSetCollective - Indicates that a particular event is collective.
692217044c2SLisandro Dalcin 
693217044c2SLisandro Dalcin   Not Collective
694217044c2SLisandro Dalcin 
695217044c2SLisandro Dalcin   Input Parameter:
696217044c2SLisandro Dalcin + event - The event id
697217044c2SLisandro Dalcin - collective - Bolean flag indicating whether a particular event is collective
698217044c2SLisandro Dalcin 
699217044c2SLisandro Dalcin   Note:
700217044c2SLisandro Dalcin   New events returned from PetscLogEventRegister() are collective by default.
701217044c2SLisandro Dalcin 
702217044c2SLisandro Dalcin   Level: developer
703217044c2SLisandro Dalcin 
704217044c2SLisandro Dalcin .keywords: log, event, collective
705217044c2SLisandro Dalcin .seealso: PetscLogEventRegister()
706217044c2SLisandro Dalcin @*/
707217044c2SLisandro Dalcin PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event,PetscBool collective)
708217044c2SLisandro Dalcin {
709217044c2SLisandro Dalcin   PetscStageLog    stageLog;
710217044c2SLisandro Dalcin   PetscEventRegLog eventRegLog;
711217044c2SLisandro Dalcin   PetscErrorCode   ierr;
712217044c2SLisandro Dalcin 
713217044c2SLisandro Dalcin   PetscFunctionBegin;
714217044c2SLisandro Dalcin   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
715217044c2SLisandro Dalcin   ierr = PetscStageLogGetEventRegLog(stageLog,&eventRegLog);CHKERRQ(ierr);
716217044c2SLisandro Dalcin   if (event < 0 || event > eventRegLog->numEvents) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Invalid event id");
717217044c2SLisandro Dalcin   eventRegLog->eventInfo[event].collective = collective;
718217044c2SLisandro Dalcin   PetscFunctionReturn(0);
719217044c2SLisandro Dalcin }
720217044c2SLisandro Dalcin 
721217044c2SLisandro Dalcin /*@
722fa2bb9feSLisandro Dalcin   PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage.
723fa2bb9feSLisandro Dalcin 
724fa2bb9feSLisandro Dalcin   Not Collective
725fa2bb9feSLisandro Dalcin 
726fa2bb9feSLisandro Dalcin   Input Parameter:
727fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc.
728fa2bb9feSLisandro Dalcin 
729fa2bb9feSLisandro Dalcin   Level: developer
730fa2bb9feSLisandro Dalcin 
731fa2bb9feSLisandro Dalcin .keywords: log, event, include, class
732fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate()
733fa2bb9feSLisandro Dalcin @*/
734fa2bb9feSLisandro Dalcin PetscErrorCode  PetscLogEventIncludeClass(PetscClassId classid)
735fa2bb9feSLisandro Dalcin {
736fa2bb9feSLisandro Dalcin   PetscStageLog  stageLog;
737fa2bb9feSLisandro Dalcin   int            stage;
738fa2bb9feSLisandro Dalcin   PetscErrorCode ierr;
739fa2bb9feSLisandro Dalcin 
740fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
741fa2bb9feSLisandro Dalcin   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
742fa2bb9feSLisandro Dalcin   for (stage = 0; stage < stageLog->numStages; stage++) {
743fa2bb9feSLisandro Dalcin     ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
744fa2bb9feSLisandro Dalcin   }
745fa2bb9feSLisandro Dalcin   PetscFunctionReturn(0);
746fa2bb9feSLisandro Dalcin }
747fa2bb9feSLisandro Dalcin 
748fa2bb9feSLisandro Dalcin /*@
749fa2bb9feSLisandro Dalcin   PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage.
750fa2bb9feSLisandro Dalcin 
751fa2bb9feSLisandro Dalcin   Not Collective
752fa2bb9feSLisandro Dalcin 
753fa2bb9feSLisandro Dalcin   Input Parameter:
754fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc.
755fa2bb9feSLisandro Dalcin 
756fa2bb9feSLisandro Dalcin   Level: developer
757fa2bb9feSLisandro Dalcin 
758fa2bb9feSLisandro Dalcin .keywords: log, event, exclude, class
759fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivateClass(),PetscLogEventDeactivate(),PetscLogEventActivate()
760fa2bb9feSLisandro Dalcin @*/
761fa2bb9feSLisandro Dalcin PetscErrorCode  PetscLogEventExcludeClass(PetscClassId classid)
762fa2bb9feSLisandro Dalcin {
763fa2bb9feSLisandro Dalcin   PetscStageLog  stageLog;
764fa2bb9feSLisandro Dalcin   int            stage;
765fa2bb9feSLisandro Dalcin   PetscErrorCode ierr;
766fa2bb9feSLisandro Dalcin 
767fa2bb9feSLisandro Dalcin   PetscFunctionBegin;
768fa2bb9feSLisandro Dalcin   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
769fa2bb9feSLisandro Dalcin   for (stage = 0; stage < stageLog->numStages; stage++) {
770fa2bb9feSLisandro Dalcin     ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
771fa2bb9feSLisandro Dalcin   }
772fa2bb9feSLisandro Dalcin   PetscFunctionReturn(0);
773fa2bb9feSLisandro Dalcin }
774fa2bb9feSLisandro Dalcin 
775fa2bb9feSLisandro Dalcin /*@
7765c6c1daeSBarry Smith   PetscLogEventActivate - Indicates that a particular event should be logged.
7775c6c1daeSBarry Smith 
7785c6c1daeSBarry Smith   Not Collective
7795c6c1daeSBarry Smith 
7805c6c1daeSBarry Smith   Input Parameter:
7815c6c1daeSBarry Smith . event - The event id
7825c6c1daeSBarry Smith 
7835c6c1daeSBarry Smith   Usage:
7845c6c1daeSBarry Smith .vb
7855c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
7865c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
7875c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
7885c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
7895c6c1daeSBarry Smith .ve
7905c6c1daeSBarry Smith 
7915c6c1daeSBarry Smith   Note:
7925c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in include/petsclog.h)
7935c6c1daeSBarry Smith   or an event number obtained with PetscLogEventRegister().
7945c6c1daeSBarry Smith 
7955c6c1daeSBarry Smith   Level: advanced
7965c6c1daeSBarry Smith 
7975c6c1daeSBarry Smith .keywords: log, event, activate
798ec303c53SPatrick Sanan .seealso: PlogEventDeactivate()
7995c6c1daeSBarry Smith @*/
8005c6c1daeSBarry Smith PetscErrorCode  PetscLogEventActivate(PetscLogEvent event)
8015c6c1daeSBarry Smith {
8025c6c1daeSBarry Smith   PetscStageLog  stageLog;
8035c6c1daeSBarry Smith   int            stage;
8045c6c1daeSBarry Smith   PetscErrorCode ierr;
8055c6c1daeSBarry Smith 
8065c6c1daeSBarry Smith   PetscFunctionBegin;
8075c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
8085c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
8093a88037aSBarry Smith   ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
8105c6c1daeSBarry Smith   PetscFunctionReturn(0);
8115c6c1daeSBarry Smith }
8125c6c1daeSBarry Smith 
8135c6c1daeSBarry Smith /*@
8145c6c1daeSBarry Smith   PetscLogEventDeactivate - Indicates that a particular event should not be logged.
8155c6c1daeSBarry Smith 
8165c6c1daeSBarry Smith   Not Collective
8175c6c1daeSBarry Smith 
8185c6c1daeSBarry Smith   Input Parameter:
8195c6c1daeSBarry Smith . event - The event id
8205c6c1daeSBarry Smith 
8215c6c1daeSBarry Smith   Usage:
8225c6c1daeSBarry Smith .vb
8235c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
8245c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
8255c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
8265c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
8275c6c1daeSBarry Smith .ve
8285c6c1daeSBarry Smith 
8295c6c1daeSBarry Smith   Note:
8305c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in
8315c6c1daeSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
8325c6c1daeSBarry Smith 
8335c6c1daeSBarry Smith   Level: advanced
8345c6c1daeSBarry Smith 
8355c6c1daeSBarry Smith .keywords: log, event, deactivate
836ec303c53SPatrick Sanan .seealso: PlogEventActivate()
8375c6c1daeSBarry Smith @*/
8385c6c1daeSBarry Smith PetscErrorCode  PetscLogEventDeactivate(PetscLogEvent event)
8395c6c1daeSBarry Smith {
8405c6c1daeSBarry Smith   PetscStageLog  stageLog;
8415c6c1daeSBarry Smith   int            stage;
8425c6c1daeSBarry Smith   PetscErrorCode ierr;
8435c6c1daeSBarry Smith 
8445c6c1daeSBarry Smith   PetscFunctionBegin;
8455c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
8465c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
8473a88037aSBarry Smith   ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
8485c6c1daeSBarry Smith   PetscFunctionReturn(0);
8495c6c1daeSBarry Smith }
8505c6c1daeSBarry Smith 
8515c6c1daeSBarry Smith /*@
8525c6c1daeSBarry Smith   PetscLogEventSetActiveAll - Sets the event activity in every stage.
8535c6c1daeSBarry Smith 
8545c6c1daeSBarry Smith   Not Collective
8555c6c1daeSBarry Smith 
8565c6c1daeSBarry Smith   Input Parameters:
8575c6c1daeSBarry Smith + event    - The event id
8585c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged
8595c6c1daeSBarry Smith 
8605c6c1daeSBarry Smith   Level: advanced
8615c6c1daeSBarry Smith 
8625c6c1daeSBarry Smith .keywords: log, event, activate
863ec303c53SPatrick Sanan .seealso: PlogEventActivate(),PlogEventDeactivate()
8645c6c1daeSBarry Smith @*/
8655c6c1daeSBarry Smith PetscErrorCode  PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive)
8665c6c1daeSBarry Smith {
8675c6c1daeSBarry Smith   PetscStageLog  stageLog;
8685c6c1daeSBarry Smith   int            stage;
8695c6c1daeSBarry Smith   PetscErrorCode ierr;
8705c6c1daeSBarry Smith 
8715c6c1daeSBarry Smith   PetscFunctionBegin;
8725c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
8735c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
8745c6c1daeSBarry Smith     if (isActive) {
8753a88037aSBarry Smith       ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
8765c6c1daeSBarry Smith     } else {
8773a88037aSBarry Smith       ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
8785c6c1daeSBarry Smith     }
8795c6c1daeSBarry Smith   }
8805c6c1daeSBarry Smith   PetscFunctionReturn(0);
8815c6c1daeSBarry Smith }
8825c6c1daeSBarry Smith 
8835c6c1daeSBarry Smith /*@
8845c6c1daeSBarry Smith   PetscLogEventActivateClass - Activates event logging for a PETSc object class.
8855c6c1daeSBarry Smith 
8865c6c1daeSBarry Smith   Not Collective
8875c6c1daeSBarry Smith 
8885c6c1daeSBarry Smith   Input Parameter:
8895c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc.
8905c6c1daeSBarry Smith 
8915c6c1daeSBarry Smith   Level: developer
8925c6c1daeSBarry Smith 
8935c6c1daeSBarry Smith .keywords: log, event, activate, class
894fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate()
8955c6c1daeSBarry Smith @*/
8965c6c1daeSBarry Smith PetscErrorCode  PetscLogEventActivateClass(PetscClassId classid)
8975c6c1daeSBarry Smith {
8985c6c1daeSBarry Smith   PetscStageLog  stageLog;
8995c6c1daeSBarry Smith   int            stage;
9005c6c1daeSBarry Smith   PetscErrorCode ierr;
9015c6c1daeSBarry Smith 
9025c6c1daeSBarry Smith   PetscFunctionBegin;
9035c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
9045c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
9053a88037aSBarry Smith   ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
9065c6c1daeSBarry Smith   PetscFunctionReturn(0);
9075c6c1daeSBarry Smith }
9085c6c1daeSBarry Smith 
9095c6c1daeSBarry Smith /*@
9105c6c1daeSBarry Smith   PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class.
9115c6c1daeSBarry Smith 
9125c6c1daeSBarry Smith   Not Collective
9135c6c1daeSBarry Smith 
9145c6c1daeSBarry Smith   Input Parameter:
9155c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc.
9165c6c1daeSBarry Smith 
9175c6c1daeSBarry Smith   Level: developer
9185c6c1daeSBarry Smith 
9195c6c1daeSBarry Smith .keywords: log, event, deactivate, class
920fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate()
9215c6c1daeSBarry Smith @*/
9225c6c1daeSBarry Smith PetscErrorCode  PetscLogEventDeactivateClass(PetscClassId classid)
9235c6c1daeSBarry Smith {
9245c6c1daeSBarry Smith   PetscStageLog  stageLog;
9255c6c1daeSBarry Smith   int            stage;
9265c6c1daeSBarry Smith   PetscErrorCode ierr;
9275c6c1daeSBarry Smith 
9285c6c1daeSBarry Smith   PetscFunctionBegin;
9295c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
9305c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
9313a88037aSBarry Smith   ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
9325c6c1daeSBarry Smith   PetscFunctionReturn(0);
9335c6c1daeSBarry Smith }
9345c6c1daeSBarry Smith 
9355c6c1daeSBarry Smith /*MC
9365c6c1daeSBarry Smith    PetscLogEventBegin - Logs the beginning of a user event.
9375c6c1daeSBarry Smith 
9385c6c1daeSBarry Smith    Synopsis:
939aaa7dc30SBarry Smith    #include <petsclog.h>
940f2ba6396SBarry Smith    PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
9415c6c1daeSBarry Smith 
9425c6c1daeSBarry Smith    Not Collective
9435c6c1daeSBarry Smith 
9445c6c1daeSBarry Smith    Input Parameters:
9455c6c1daeSBarry Smith +  e - integer associated with the event obtained from PetscLogEventRegister()
9465c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
9475c6c1daeSBarry Smith 
9485c6c1daeSBarry Smith 
9495c6c1daeSBarry Smith    Fortran Synopsis:
9505c6c1daeSBarry Smith    void PetscLogEventBegin(int e,PetscErrorCode ierr)
9515c6c1daeSBarry Smith 
9525c6c1daeSBarry Smith    Usage:
9535c6c1daeSBarry Smith .vb
9545c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
9555c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
9565c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
9575c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
9585c6c1daeSBarry Smith         [code segment to monitor]
9595c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
9605c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
9615c6c1daeSBarry Smith .ve
9625c6c1daeSBarry Smith 
9635c6c1daeSBarry Smith    Notes:
9645c6c1daeSBarry Smith    You need to register each integer event with the command
965a2553e36SBarry Smith    PetscLogEventRegister().
9665c6c1daeSBarry Smith 
9675c6c1daeSBarry Smith    Level: intermediate
9685c6c1daeSBarry Smith 
9695c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops()
9705c6c1daeSBarry Smith 
9715c6c1daeSBarry Smith .keywords: log, event, begin
9725c6c1daeSBarry Smith M*/
9735c6c1daeSBarry Smith 
9745c6c1daeSBarry Smith /*MC
9755c6c1daeSBarry Smith    PetscLogEventEnd - Log the end of a user event.
9765c6c1daeSBarry Smith 
9775c6c1daeSBarry Smith    Synopsis:
978aaa7dc30SBarry Smith    #include <petsclog.h>
979f2ba6396SBarry Smith    PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
9805c6c1daeSBarry Smith 
9815c6c1daeSBarry Smith    Not Collective
9825c6c1daeSBarry Smith 
9835c6c1daeSBarry Smith    Input Parameters:
9845c6c1daeSBarry Smith +  e - integer associated with the event obtained with PetscLogEventRegister()
9855c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
9865c6c1daeSBarry Smith 
9875c6c1daeSBarry Smith 
9885c6c1daeSBarry Smith    Fortran Synopsis:
9895c6c1daeSBarry Smith    void PetscLogEventEnd(int e,PetscErrorCode ierr)
9905c6c1daeSBarry Smith 
9915c6c1daeSBarry Smith    Usage:
9925c6c1daeSBarry Smith .vb
9935c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
9945c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
9955c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT,);
9965c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
9975c6c1daeSBarry Smith         [code segment to monitor]
9985c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
9995c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
10005c6c1daeSBarry Smith .ve
10015c6c1daeSBarry Smith 
10025c6c1daeSBarry Smith    Notes:
10035c6c1daeSBarry Smith    You should also register each additional integer event with the command
1004a2553e36SBarry Smith    PetscLogEventRegister().
10055c6c1daeSBarry Smith 
10065c6c1daeSBarry Smith    Level: intermediate
10075c6c1daeSBarry Smith 
10085c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogFlops()
10095c6c1daeSBarry Smith 
10105c6c1daeSBarry Smith .keywords: log, event, end
10115c6c1daeSBarry Smith M*/
10125c6c1daeSBarry Smith 
10135c6c1daeSBarry Smith /*@C
10145c6c1daeSBarry Smith   PetscLogEventGetId - Returns the event id when given the event name.
10155c6c1daeSBarry Smith 
10165c6c1daeSBarry Smith   Not Collective
10175c6c1daeSBarry Smith 
10185c6c1daeSBarry Smith   Input Parameter:
10195c6c1daeSBarry Smith . name  - The event name
10205c6c1daeSBarry Smith 
10215c6c1daeSBarry Smith   Output Parameter:
1022c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists
10235c6c1daeSBarry Smith 
10245c6c1daeSBarry Smith   Level: intermediate
10255c6c1daeSBarry Smith 
10265c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStageGetId()
10275c6c1daeSBarry Smith @*/
10285c6c1daeSBarry Smith PetscErrorCode  PetscLogEventGetId(const char name[], PetscLogEvent *event)
10295c6c1daeSBarry Smith {
10305c6c1daeSBarry Smith   PetscStageLog  stageLog;
10315c6c1daeSBarry Smith   PetscErrorCode ierr;
10325c6c1daeSBarry Smith 
10335c6c1daeSBarry Smith   PetscFunctionBegin;
10345c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
10353a88037aSBarry Smith   ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr);
10365c6c1daeSBarry Smith   PetscFunctionReturn(0);
10375c6c1daeSBarry Smith }
10385c6c1daeSBarry Smith 
10395c6c1daeSBarry Smith 
10405c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/
10415c6c1daeSBarry Smith /*@C
10425c6c1daeSBarry Smith   PetscLogDump - Dumps logs of objects to a file. This file is intended to
10435c6c1daeSBarry Smith   be read by bin/petscview. This program no longer exists.
10445c6c1daeSBarry Smith 
10455c6c1daeSBarry Smith   Collective on PETSC_COMM_WORLD
10465c6c1daeSBarry Smith 
10475c6c1daeSBarry Smith   Input Parameter:
10485c6c1daeSBarry Smith . name - an optional file name
10495c6c1daeSBarry Smith 
10505c6c1daeSBarry Smith   Usage:
10515c6c1daeSBarry Smith .vb
10525c6c1daeSBarry Smith      PetscInitialize(...);
1053bb1d7374SBarry Smith      PetscLogDefaultBegin(); or PetscLogAllBegin();
10545c6c1daeSBarry Smith      ... code ...
10555c6c1daeSBarry Smith      PetscLogDump(filename);
10565c6c1daeSBarry Smith      PetscFinalize();
10575c6c1daeSBarry Smith .ve
10585c6c1daeSBarry Smith 
10595c6c1daeSBarry Smith   Notes:
10605c6c1daeSBarry Smith   The default file name is
10615c6c1daeSBarry Smith $    Log.<rank>
10625c6c1daeSBarry Smith   where <rank> is the processor number. If no name is specified,
10635c6c1daeSBarry Smith   this file will be used.
10645c6c1daeSBarry Smith 
10655c6c1daeSBarry Smith   Level: advanced
10665c6c1daeSBarry Smith 
10675c6c1daeSBarry Smith .keywords: log, dump
1068bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogView()
10695c6c1daeSBarry Smith @*/
10705c6c1daeSBarry Smith PetscErrorCode  PetscLogDump(const char sname[])
10715c6c1daeSBarry Smith {
10725c6c1daeSBarry Smith   PetscStageLog      stageLog;
10735c6c1daeSBarry Smith   PetscEventPerfInfo *eventInfo;
10745c6c1daeSBarry Smith   FILE               *fd;
10755c6c1daeSBarry Smith   char               file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN];
10765c6c1daeSBarry Smith   PetscLogDouble     flops, _TotalTime;
10775c6c1daeSBarry Smith   PetscMPIInt        rank;
10785c6c1daeSBarry Smith   int                action, object, curStage;
10795c6c1daeSBarry Smith   PetscLogEvent      event;
10805c6c1daeSBarry Smith   PetscErrorCode     ierr;
10815c6c1daeSBarry Smith 
10825c6c1daeSBarry Smith   PetscFunctionBegin;
10835c6c1daeSBarry Smith   /* Calculate the total elapsed time */
10848563dfccSBarry Smith   PetscTime(&_TotalTime);
10855c6c1daeSBarry Smith   _TotalTime -= petsc_BaseTime;
10865c6c1daeSBarry Smith   /* Open log file */
10875c6c1daeSBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank);CHKERRQ(ierr);
10887ff663adSLisandro Dalcin   if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank);
1089a297a907SKarl Rupp   else sprintf(file, "Log.%d", rank);
10905c6c1daeSBarry Smith   ierr = PetscFixFilename(file, fname);CHKERRQ(ierr);
10915c6c1daeSBarry Smith   ierr = PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd);CHKERRQ(ierr);
10925c6c1daeSBarry Smith   if ((!rank) && (!fd)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname);
10935c6c1daeSBarry Smith   /* Output totals */
1094d4aa7d5fSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime);CHKERRQ(ierr);
1095a2ea699eSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0);CHKERRQ(ierr);
10965c6c1daeSBarry Smith   /* Output actions */
10975c6c1daeSBarry Smith   if (petsc_logActions) {
1098a2ea699eSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions);CHKERRQ(ierr);
10995c6c1daeSBarry Smith     for (action = 0; action < petsc_numActions; action++) {
11005c6c1daeSBarry Smith       ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n",
11015c6c1daeSBarry Smith                           petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1,
1102a2ea699eSBarry Smith                           petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem);CHKERRQ(ierr);
11035c6c1daeSBarry Smith     }
11045c6c1daeSBarry Smith   }
11055c6c1daeSBarry Smith   /* Output objects */
11065c6c1daeSBarry Smith   if (petsc_logObjects) {
1107a2ea699eSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed);CHKERRQ(ierr);
11085c6c1daeSBarry Smith     for (object = 0; object < petsc_numObjects; object++) {
1109a2ea699eSBarry Smith       ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int) petsc_objects[object].mem);CHKERRQ(ierr);
11105c6c1daeSBarry Smith       if (!petsc_objects[object].name[0]) {
1111a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd,"No Name\n");CHKERRQ(ierr);
11125c6c1daeSBarry Smith       } else {
1113a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name);CHKERRQ(ierr);
11145c6c1daeSBarry Smith       }
11155c6c1daeSBarry Smith       if (petsc_objects[object].info[0] != 0) {
1116a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n");CHKERRQ(ierr);
11175c6c1daeSBarry Smith       } else {
1118a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info);CHKERRQ(ierr);
11195c6c1daeSBarry Smith       }
11205c6c1daeSBarry Smith     }
11215c6c1daeSBarry Smith   }
11225c6c1daeSBarry Smith   /* Output events */
1123a2ea699eSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n");CHKERRQ(ierr);
11245c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
11255c6c1daeSBarry Smith   ierr = PetscIntStackTop(stageLog->stack, &curStage);CHKERRQ(ierr);
11265c6c1daeSBarry Smith   eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo;
11275c6c1daeSBarry Smith   for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) {
1128a297a907SKarl Rupp     if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops/eventInfo[event].time;
1129a297a907SKarl Rupp     else flops = 0.0;
11305c6c1daeSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count,
1131a2ea699eSBarry Smith                         eventInfo[event].flops, eventInfo[event].time, flops);CHKERRQ(ierr);
11325c6c1daeSBarry Smith   }
11335c6c1daeSBarry Smith   ierr = PetscFClose(PETSC_COMM_WORLD, fd);CHKERRQ(ierr);
11345c6c1daeSBarry Smith   PetscFunctionReturn(0);
11355c6c1daeSBarry Smith }
11365c6c1daeSBarry Smith 
1137f14045dbSBarry Smith /*
1138f14045dbSBarry Smith   PetscLogView_Detailed - Each process prints the times for its own events
1139f14045dbSBarry Smith 
1140f14045dbSBarry Smith */
1141f14045dbSBarry Smith PetscErrorCode  PetscLogView_Detailed(PetscViewer viewer)
1142f14045dbSBarry Smith {
11432dff6485SMatthew G. Knepley   PetscStageLog      stageLog;
1144217044c2SLisandro Dalcin   PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL;
1145217044c2SLisandro Dalcin   PetscLogDouble     locTotalTime, numRed, maxMem;
11462dff6485SMatthew G. Knepley   int                numStages,numEvents,stage,event;
1147217044c2SLisandro Dalcin   MPI_Comm           comm = PetscObjectComm((PetscObject) viewer);
11482dff6485SMatthew G. Knepley   PetscMPIInt        rank,size;
11492dff6485SMatthew G. Knepley   PetscErrorCode     ierr;
1150f14045dbSBarry Smith 
1151f14045dbSBarry Smith   PetscFunctionBegin;
11522d1ec343SBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
11532d1ec343SBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
11542dff6485SMatthew G. Knepley   /* Must preserve reduction count before we go on */
11552dff6485SMatthew G. Knepley   numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
11562d1ec343SBarry Smith   /* Get the total elapsed time */
11572d1ec343SBarry Smith   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
11589852e123SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"size = %d\n",size);CHKERRQ(ierr);
11592d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"LocalTimes = {}\n");CHKERRQ(ierr);
11602d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"LocalMessages = {}\n");CHKERRQ(ierr);
1161217044c2SLisandro Dalcin   ierr = PetscViewerASCIIPrintf(viewer,"LocalMessageLens = {}\n");CHKERRQ(ierr);
11622d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"LocalReductions = {}\n");CHKERRQ(ierr);
1163217044c2SLisandro Dalcin   ierr = PetscViewerASCIIPrintf(viewer,"LocalFlop = {}\n");CHKERRQ(ierr);
11642dff6485SMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer,"LocalObjects = {}\n");CHKERRQ(ierr);
11652dff6485SMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer,"LocalMemory = {}\n");CHKERRQ(ierr);
11662d1ec343SBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
1167b2566f29SBarry Smith   ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
11682d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"Stages = {}\n");CHKERRQ(ierr);
11692d1ec343SBarry Smith   for (stage=0; stage<numStages; stage++) {
11702d1ec343SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr);
117161917356SPatrick Sanan     ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"summary\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr);
1172b2566f29SBarry Smith     ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
11732d1ec343SBarry Smith     for (event = 0; event < numEvents; event++) {
11742d1ec343SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"%s\"] = {}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name);CHKERRQ(ierr);
11752d1ec343SBarry Smith     }
11762d1ec343SBarry Smith   }
1177217044c2SLisandro Dalcin   ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr);
11781575c14dSBarry Smith   ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
11792d1ec343SBarry Smith   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalTimes[%d] = %g\n",rank,locTotalTime);CHKERRQ(ierr);
11802d1ec343SBarry Smith   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessages[%d] = %g\n",rank,(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct));CHKERRQ(ierr);
1181217044c2SLisandro Dalcin   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessageLens[%d] = %g\n",rank,(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len));CHKERRQ(ierr);
11822dff6485SMatthew G. Knepley   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalReductions[%d] = %g\n",rank,numRed);CHKERRQ(ierr);
1183217044c2SLisandro Dalcin   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalFlop[%d] = %g\n",rank,petsc_TotalFlops);CHKERRQ(ierr);
1184ba67d37fSBarry Smith   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalObjects[%d] = %d\n",rank,petsc_numObjects);CHKERRQ(ierr);
11852dff6485SMatthew G. Knepley   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMemory[%d] = %g\n",rank,maxMem);CHKERRQ(ierr);
11862d1ec343SBarry Smith   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
11872d1ec343SBarry Smith   for (stage=0; stage<numStages; stage++) {
1188217044c2SLisandro Dalcin     stageInfo = &stageLog->stageInfo[stage].perfInfo;
1189d4aa7d5fSBarry Smith     ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n",
11902dff6485SMatthew G. Knepley                                               stageLog->stageInfo[stage].name,rank,
1191217044c2SLisandro Dalcin                                               stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr);
1192b2566f29SBarry Smith     ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
11932d1ec343SBarry Smith     for (event = 0; event < numEvents; event++) {
1194217044c2SLisandro Dalcin       eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event];
1195*c15bc2c4SMatthew G. Knepley       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %D, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g",
1196217044c2SLisandro Dalcin                                                 stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name,rank,
1197217044c2SLisandro Dalcin                                                 eventInfo->count,eventInfo->time,eventInfo->syncTime,eventInfo->numMessages,eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr);
1198*c15bc2c4SMatthew G. Knepley       if (eventInfo->dof >= 0.) {
11995d68e14cSMatthew G. Knepley         PetscInt e;
12005d68e14cSMatthew G. Knepley 
1201*c15bc2c4SMatthew G. Knepley         ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : %.0g", eventInfo->dof);CHKERRQ(ierr);
12025d68e14cSMatthew G. Knepley         ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : [");CHKERRQ(ierr);
12035d68e14cSMatthew G. Knepley         for (e = 0; e < 8; ++e) {
12045d68e14cSMatthew G. Knepley           if (e > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);}
1205*c15bc2c4SMatthew G. Knepley           ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e]);CHKERRQ(ierr);
12065d68e14cSMatthew G. Knepley         }
12075d68e14cSMatthew G. Knepley         ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr);
12085d68e14cSMatthew G. Knepley       }
12095d68e14cSMatthew G. Knepley       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"}\n");CHKERRQ(ierr);
12102d1ec343SBarry Smith     }
12112d1ec343SBarry Smith   }
12122d1ec343SBarry Smith   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
12131575c14dSBarry Smith   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
1214f14045dbSBarry Smith   PetscFunctionReturn(0);
1215f14045dbSBarry Smith }
1216f14045dbSBarry Smith 
1217217044c2SLisandro Dalcin static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm,FILE *fd)
1218217044c2SLisandro Dalcin {
1219217044c2SLisandro Dalcin   PetscErrorCode ierr;
1220217044c2SLisandro Dalcin   PetscFunctionBegin;
1221217044c2SLisandro Dalcin   if (!PetscLogSyncOn) PetscFunctionReturn(0);
1222217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr);
1223217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n");CHKERRQ(ierr);
1224217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1225217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n");CHKERRQ(ierr);
1226217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1227217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #   This program was run with logging synchronization.   #\n");CHKERRQ(ierr);
1228217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #   This option provides more meaningful imbalance       #\n");CHKERRQ(ierr);
1229217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #   figures at the expense of slowing things down and    #\n");CHKERRQ(ierr);
1230217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #   providing a distorted view of the overall runtime.   #\n");CHKERRQ(ierr);
1231217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1232217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n\n\n");CHKERRQ(ierr);
1233217044c2SLisandro Dalcin   PetscFunctionReturn(0);
1234217044c2SLisandro Dalcin   PetscFunctionReturn(0);
1235217044c2SLisandro Dalcin }
1236217044c2SLisandro Dalcin 
1237f4091ad2SBarry Smith static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm,FILE *fd)
1238f4091ad2SBarry Smith {
1239f4091ad2SBarry Smith #if defined(PETSC_USE_DEBUG)
1240f4091ad2SBarry Smith   PetscErrorCode ierr;
1241f4091ad2SBarry Smith 
1242f4091ad2SBarry Smith   PetscFunctionBegin;
1243f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr);
1244f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n");CHKERRQ(ierr);
1245f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1246f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                       WARNING!!!                       #\n");CHKERRQ(ierr);
1247f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1248217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "      #   This code was compiled with a debugging option.      #\n");CHKERRQ(ierr);
1249f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   To get timing results run ./configure                #\n");CHKERRQ(ierr);
1250f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   using --with-debugging=no, the performance will      #\n");CHKERRQ(ierr);
1251f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   be generally two or three times faster.              #\n");CHKERRQ(ierr);
1252f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1253f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n\n\n");CHKERRQ(ierr);
1254f4091ad2SBarry Smith   PetscFunctionReturn(0);
1255f4091ad2SBarry Smith #else
1256f4091ad2SBarry Smith   return 0;
1257f4091ad2SBarry Smith #endif
1258f4091ad2SBarry Smith }
1259f4091ad2SBarry Smith 
1260f14045dbSBarry Smith PetscErrorCode  PetscLogView_Default(PetscViewer viewer)
12615c6c1daeSBarry Smith {
12625c6c1daeSBarry Smith   FILE               *fd;
12635c6c1daeSBarry Smith   PetscLogDouble     zero       = 0.0;
12645c6c1daeSBarry Smith   PetscStageLog      stageLog;
12650298fd71SBarry Smith   PetscStageInfo     *stageInfo = NULL;
12660298fd71SBarry Smith   PetscEventPerfInfo *eventInfo = NULL;
12675c6c1daeSBarry Smith   PetscClassPerfInfo *classInfo;
12685c6c1daeSBarry Smith   char               arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128];
12695c6c1daeSBarry Smith   const char         *name;
12705c6c1daeSBarry Smith   PetscLogDouble     locTotalTime, TotalTime, TotalFlops;
12715c6c1daeSBarry Smith   PetscLogDouble     numMessages, messageLength, avgMessLen, numReductions;
12725c6c1daeSBarry Smith   PetscLogDouble     stageTime, flops, flopr, mem, mess, messLen, red;
12735c6c1daeSBarry Smith   PetscLogDouble     fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed;
12745c6c1daeSBarry Smith   PetscLogDouble     fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed;
12755c6c1daeSBarry Smith   PetscLogDouble     min, max, tot, ratio, avg, x, y;
1276217044c2SLisandro Dalcin   PetscLogDouble     minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr;
1277217044c2SLisandro Dalcin   PetscMPIInt        minC, maxC;
12785c6c1daeSBarry Smith   PetscMPIInt        size, rank;
12795c6c1daeSBarry Smith   PetscBool          *localStageUsed,    *stageUsed;
12805c6c1daeSBarry Smith   PetscBool          *localStageVisible, *stageVisible;
12815c6c1daeSBarry Smith   int                numStages, localNumEvents, numEvents;
128237b78d16SBarry Smith   int                stage, oclass;
12835c6c1daeSBarry Smith   PetscLogEvent      event;
12845c6c1daeSBarry Smith   PetscErrorCode     ierr;
12855c6c1daeSBarry Smith   char               version[256];
12865c6c1daeSBarry Smith   MPI_Comm           comm;
12875c6c1daeSBarry Smith 
12885c6c1daeSBarry Smith   PetscFunctionBegin;
12895c6c1daeSBarry Smith   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
12905c6c1daeSBarry Smith   ierr = PetscViewerASCIIGetPointer(viewer,&fd);CHKERRQ(ierr);
12915c6c1daeSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
12925c6c1daeSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
12935c6c1daeSBarry Smith   /* Get the total elapsed time */
12948563dfccSBarry Smith   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
12955c6c1daeSBarry Smith 
12965c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr);
12975c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "***             WIDEN YOUR WINDOW TO 120 CHARACTERS.  Use 'enscript -r -fCourier9' to print this document            ***\n");CHKERRQ(ierr);
12985c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr);
12995c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n---------------------------------------------- PETSc Performance Summary: ----------------------------------------------\n\n");CHKERRQ(ierr);
1300217044c2SLisandro Dalcin   ierr = PetscLogViewWarnSync(comm,fd);CHKERRQ(ierr);
1301f4091ad2SBarry Smith   ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr);
13025c6c1daeSBarry Smith   ierr = PetscGetArchType(arch,sizeof(arch));CHKERRQ(ierr);
13035c6c1daeSBarry Smith   ierr = PetscGetHostName(hostname,sizeof(hostname));CHKERRQ(ierr);
13045c6c1daeSBarry Smith   ierr = PetscGetUserName(username,sizeof(username));CHKERRQ(ierr);
13055c6c1daeSBarry Smith   ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr);
13065c6c1daeSBarry Smith   ierr = PetscGetDate(date,sizeof(date));CHKERRQ(ierr);
13075c6c1daeSBarry Smith   ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
13085c6c1daeSBarry Smith   if (size == 1) {
13095c6c1daeSBarry 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);
13105c6c1daeSBarry Smith   } else {
13115c6c1daeSBarry 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);
13125c6c1daeSBarry Smith   }
13135c6c1daeSBarry Smith 
13145c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Using %s\n", version);CHKERRQ(ierr);
13155c6c1daeSBarry Smith 
13165c6c1daeSBarry Smith   /* Must preserve reduction count before we go on */
13175c6c1daeSBarry Smith   red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
13185c6c1daeSBarry Smith 
13195c6c1daeSBarry Smith   /* Calculate summary information */
13205c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n                         Max       Max/Min     Avg       Total \n");CHKERRQ(ierr);
13215c6c1daeSBarry Smith   /*   Time */
1322b2566f29SBarry Smith   ierr = MPIU_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1323b2566f29SBarry Smith   ierr = MPIU_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1324b2566f29SBarry Smith   ierr = MPIU_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1325217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1326217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1327217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Time (sec):           %5.3e   %7.3f   %5.3e\n", max, ratio, avg);CHKERRQ(ierr);
13285c6c1daeSBarry Smith   TotalTime = tot;
13295c6c1daeSBarry Smith   /*   Objects */
13305c6c1daeSBarry Smith   avg  = (PetscLogDouble) petsc_numObjects;
1331b2566f29SBarry Smith   ierr = MPIU_Allreduce(&avg,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1332b2566f29SBarry Smith   ierr = MPIU_Allreduce(&avg,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1333b2566f29SBarry Smith   ierr = MPIU_Allreduce(&avg,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1334217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1335217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1336217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Objects:              %5.3e   %7.3f   %5.3e\n", max, ratio, avg);CHKERRQ(ierr);
13375c6c1daeSBarry Smith   /*   Flops */
1338b2566f29SBarry Smith   ierr = MPIU_Allreduce(&petsc_TotalFlops,  &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1339b2566f29SBarry Smith   ierr = MPIU_Allreduce(&petsc_TotalFlops,  &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1340b2566f29SBarry Smith   ierr = MPIU_Allreduce(&petsc_TotalFlops,  &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1341217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1342217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1343217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Flop:                 %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
13445c6c1daeSBarry Smith   TotalFlops = tot;
13455c6c1daeSBarry Smith   /*   Flops/sec -- Must talk to Barry here */
1346217044c2SLisandro Dalcin   if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime; else flops = 0.0;
1347b2566f29SBarry Smith   ierr = MPIU_Allreduce(&flops,        &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1348b2566f29SBarry Smith   ierr = MPIU_Allreduce(&flops,        &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1349b2566f29SBarry Smith   ierr = MPIU_Allreduce(&flops,        &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1350217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1351217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1352217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Flop/sec:             %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
13535c6c1daeSBarry Smith   /*   Memory */
13545c6c1daeSBarry Smith   ierr = PetscMallocGetMaximumUsage(&mem);CHKERRQ(ierr);
13555c6c1daeSBarry Smith   if (mem > 0.0) {
1356b2566f29SBarry Smith     ierr = MPIU_Allreduce(&mem,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1357217044c2SLisandro Dalcin     ierr = MPIU_Allreduce(&mem,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1358b2566f29SBarry Smith     ierr = MPIU_Allreduce(&mem,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1359217044c2SLisandro Dalcin     avg  = tot/((PetscLogDouble) size);
1360217044c2SLisandro Dalcin     if (min != 0.0) ratio = max/min; else ratio = 0.0;
1361217044c2SLisandro Dalcin     ierr = PetscFPrintf(comm, fd, "Memory:               %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
13625c6c1daeSBarry Smith   }
13635c6c1daeSBarry Smith   /*   Messages */
13645c6c1daeSBarry Smith   mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct);
1365b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1366b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1367b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1368217044c2SLisandro Dalcin   avg  = tot/((PetscLogDouble) size);
1369217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1370217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "MPI Messages:         %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
13715c6c1daeSBarry Smith   numMessages = tot;
13725c6c1daeSBarry Smith   /*   Message Lengths */
13735c6c1daeSBarry Smith   mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len);
1374b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1375b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1376b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1377217044c2SLisandro Dalcin   if (numMessages != 0) avg = tot/numMessages; else avg = 0.0;
1378217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1379217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "MPI Message Lengths:  %5.3e   %7.3f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
13805c6c1daeSBarry Smith   messageLength = tot;
13815c6c1daeSBarry Smith   /*   Reductions */
1382b2566f29SBarry Smith   ierr = MPIU_Allreduce(&red,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1383b2566f29SBarry Smith   ierr = MPIU_Allreduce(&red,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1384b2566f29SBarry Smith   ierr = MPIU_Allreduce(&red,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1385217044c2SLisandro Dalcin   if (min != 0.0) ratio = max/min; else ratio = 0.0;
1386217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "MPI Reductions:       %5.3e   %7.3f\n", max, ratio);CHKERRQ(ierr);
13875c6c1daeSBarry Smith   numReductions = red; /* wrong because uses count from process zero */
13885c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n");CHKERRQ(ierr);
1389d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "                            e.g., VecAXPY() for real vectors of length N --> 2N flop\n");CHKERRQ(ierr);
1390d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "                            and VecAXPY() for complex vectors of length N --> 8N flop\n");CHKERRQ(ierr);
13915c6c1daeSBarry Smith 
13925c6c1daeSBarry Smith   /* Get total number of stages --
13935c6c1daeSBarry Smith        Currently, a single processor can register more stages than another, but stages must all be registered in order.
13945c6c1daeSBarry Smith        We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID.
13955c6c1daeSBarry Smith        This seems best accomplished by assoicating a communicator with each stage.
13965c6c1daeSBarry Smith   */
139737b78d16SBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
1398b2566f29SBarry Smith   ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
1399785e854fSJed Brown   ierr = PetscMalloc1(numStages, &localStageUsed);CHKERRQ(ierr);
1400785e854fSJed Brown   ierr = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr);
1401785e854fSJed Brown   ierr = PetscMalloc1(numStages, &localStageVisible);CHKERRQ(ierr);
1402785e854fSJed Brown   ierr = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr);
14035c6c1daeSBarry Smith   if (numStages > 0) {
14045c6c1daeSBarry Smith     stageInfo = stageLog->stageInfo;
14055c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
14065c6c1daeSBarry Smith       if (stage < stageLog->numStages) {
14075c6c1daeSBarry Smith         localStageUsed[stage]    = stageInfo[stage].used;
14085c6c1daeSBarry Smith         localStageVisible[stage] = stageInfo[stage].perfInfo.visible;
14095c6c1daeSBarry Smith       } else {
14105c6c1daeSBarry Smith         localStageUsed[stage]    = PETSC_FALSE;
14115c6c1daeSBarry Smith         localStageVisible[stage] = PETSC_TRUE;
14125c6c1daeSBarry Smith       }
14135c6c1daeSBarry Smith     }
1414b2566f29SBarry Smith     ierr = MPIU_Allreduce(localStageUsed,    stageUsed,    numStages, MPIU_BOOL, MPI_LOR,  comm);CHKERRQ(ierr);
1415b2566f29SBarry Smith     ierr = MPIU_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr);
14165c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
14175c6c1daeSBarry Smith       if (stageUsed[stage]) {
1418217044c2SLisandro Dalcin         ierr = PetscFPrintf(comm, fd, "\nSummary of Stages:   ----- Time ------  ----- Flop ------  --- Messages ---  -- Message Lengths --  -- Reductions --\n");CHKERRQ(ierr);
1419217044c2SLisandro Dalcin         ierr = PetscFPrintf(comm, fd, "                        Avg     %%Total     Avg     %%Total    Count   %%Total     Avg         %%Total    Count   %%Total \n");CHKERRQ(ierr);
14205c6c1daeSBarry Smith         break;
14215c6c1daeSBarry Smith       }
14225c6c1daeSBarry Smith     }
14235c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
14245c6c1daeSBarry Smith       if (!stageUsed[stage]) continue;
142550a9567dSMatthew G. Knepley       /* CANNOT use MPIU_Allreduce() since it might fail the line number check */
14265c6c1daeSBarry Smith       if (localStageUsed[stage]) {
142750a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
142850a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
142950a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
143050a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
143150a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14325c6c1daeSBarry Smith         name = stageInfo[stage].name;
14335c6c1daeSBarry Smith       } else {
143450a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&zero,                           &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
143550a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&zero,                           &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
143650a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&zero,                           &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
143750a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&zero,                           &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
143850a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&zero,                           &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14395c6c1daeSBarry Smith         name = "";
14405c6c1daeSBarry Smith       }
14415c6c1daeSBarry Smith       mess *= 0.5; messLen *= 0.5; red /= size;
14425c6c1daeSBarry Smith       if (TotalTime     != 0.0) fracTime       = stageTime/TotalTime;    else fracTime       = 0.0;
14435c6c1daeSBarry Smith       if (TotalFlops    != 0.0) fracFlops      = flops/TotalFlops;       else fracFlops      = 0.0;
14445c6c1daeSBarry Smith       /* Talk to Barry if (stageTime     != 0.0) flops          = (size*flops)/stageTime; else flops          = 0.0; */
14455c6c1daeSBarry Smith       if (numMessages   != 0.0) fracMessages   = mess/numMessages;       else fracMessages   = 0.0;
1446e96a4d02SJunchao Zhang       if (mess          != 0.0) avgMessLen     = messLen/mess;           else avgMessLen     = 0.0;
14475c6c1daeSBarry Smith       if (messageLength != 0.0) fracLength     = messLen/messageLength;  else fracLength     = 0.0;
14485c6c1daeSBarry Smith       if (numReductions != 0.0) fracReductions = red/numReductions;      else fracReductions = 0.0;
14495c6c1daeSBarry 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",
14505c6c1daeSBarry Smith                           stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops,
14515c6c1daeSBarry Smith                           mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr);
14525c6c1daeSBarry Smith     }
14535c6c1daeSBarry Smith   }
14545c6c1daeSBarry Smith 
1455806fa848SBarry Smith   ierr = PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
14565c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n");CHKERRQ(ierr);
14575c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Phase summary info:\n");CHKERRQ(ierr);
14585c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Count: number of times phase was executed\n");CHKERRQ(ierr);
1459d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Time and Flop: Max - maximum over all processors\n");CHKERRQ(ierr);
14605c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "                  Ratio - ratio of maximum to minimum over all processors\n");CHKERRQ(ierr);
14615c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Mess: number of messages sent\n");CHKERRQ(ierr);
1462217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "   AvgLen: average message length (bytes)\n");CHKERRQ(ierr);
14635c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Reduct: number of global reductions\n");CHKERRQ(ierr);
14645c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Global: entire computation\n");CHKERRQ(ierr);
14655c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n");CHKERRQ(ierr);
1466d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%T - percent time in this phase         %%F - percent flop in this phase\n");CHKERRQ(ierr);
14675c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%M - percent messages in this phase     %%L - percent message lengths in this phase\n");CHKERRQ(ierr);
14685c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%R - percent reductions in this phase\n");CHKERRQ(ierr);
1469d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n");CHKERRQ(ierr);
1470806fa848SBarry Smith   ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
14715c6c1daeSBarry Smith 
1472f4091ad2SBarry Smith   ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr);
14735c6c1daeSBarry Smith 
14745c6c1daeSBarry Smith   /* Report events */
1475217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd,"Event                Count      Time (sec)     Flop                              --- Global ---  --- Stage ----  Total\n");CHKERRQ(ierr);
1476217044c2SLisandro Dalcin   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\n");CHKERRQ(ierr);
1477806fa848SBarry Smith   ierr = PetscFPrintf(comm,fd,"------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
14785c6c1daeSBarry Smith 
14795c6c1daeSBarry Smith   /* Problem: The stage name will not show up unless the stage executed on proc 1 */
14805c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
14815c6c1daeSBarry Smith     if (!stageVisible[stage]) continue;
148250a9567dSMatthew G. Knepley     /* CANNOT use MPIU_Allreduce() since it might fail the line number check */
14835c6c1daeSBarry Smith     if (localStageUsed[stage]) {
14845c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr);
148550a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
148650a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
148750a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
148850a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
148950a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14905c6c1daeSBarry Smith     } else {
14915c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr);
149250a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&zero,                           &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
149350a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&zero,                           &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
149450a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&zero,                           &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
149550a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&zero,                           &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
149650a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&zero,                           &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14975c6c1daeSBarry Smith     }
14985c6c1daeSBarry Smith     mess *= 0.5; messLen *= 0.5; red /= size;
14995c6c1daeSBarry Smith 
15005c6c1daeSBarry Smith     /* Get total number of events in this stage --
15015c6c1daeSBarry Smith        Currently, a single processor can register more events than another, but events must all be registered in order,
15025c6c1daeSBarry Smith        just like stages. We can removed this requirement if necessary by having a global event numbering and indirection
1503217044c2SLisandro Dalcin        on the event ID. This seems best accomplished by associating a communicator with each stage.
15045c6c1daeSBarry Smith 
15055c6c1daeSBarry Smith        Problem: If the event did not happen on proc 1, its name will not be available.
15065c6c1daeSBarry Smith        Problem: Event visibility is not implemented
15075c6c1daeSBarry Smith     */
15085c6c1daeSBarry Smith     if (localStageUsed[stage]) {
15095c6c1daeSBarry Smith       eventInfo      = stageLog->stageInfo[stage].eventLog->eventInfo;
15105c6c1daeSBarry Smith       localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents;
1511a297a907SKarl Rupp     } else localNumEvents = 0;
1512b2566f29SBarry Smith     ierr = MPIU_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
15135c6c1daeSBarry Smith     for (event = 0; event < numEvents; event++) {
151450a9567dSMatthew G. Knepley       /* CANNOT use MPIU_Allreduce() since it might fail the line number check */
15155c6c1daeSBarry Smith       if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) {
1516217044c2SLisandro Dalcin         if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; else flopr = 0.0;
151750a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&flopr,                          &minf,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
151850a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&flopr,                          &maxf,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
151950a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].flops,         &totf,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
152050a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].time,          &mint,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
152150a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].time,          &maxt,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
152250a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].time,          &tott,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
152350a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].numMessages,   &totm,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
152450a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
152550a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].numReductions, &totr,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1526217044c2SLisandro Dalcin         ierr = MPI_Allreduce(&eventInfo[event].count,         &minC,  1, MPI_INT,             MPI_MIN, comm);CHKERRQ(ierr);
1527217044c2SLisandro Dalcin         ierr = MPI_Allreduce(&eventInfo[event].count,         &maxC,  1, MPI_INT,             MPI_MAX, comm);CHKERRQ(ierr);
15285c6c1daeSBarry Smith         name = stageLog->eventLog->eventInfo[event].name;
15295c6c1daeSBarry Smith       } else {
15305c6c1daeSBarry Smith         flopr = 0.0;
153150a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&flopr,                         &minf,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
153250a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&flopr,                         &maxf,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
153350a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&zero,                          &totf,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
153450a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&zero,                          &mint,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
153550a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&zero,                          &maxt,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
153650a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&zero,                          &tott,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
153750a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&zero,                          &totm,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
153850a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&zero,                          &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
153950a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&zero,                          &totr,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1540217044c2SLisandro Dalcin         ierr  = MPI_Allreduce(&ierr,                          &minC,  1, MPI_INT,             MPI_MIN, comm);CHKERRQ(ierr);
1541217044c2SLisandro Dalcin         ierr  = MPI_Allreduce(&ierr,                          &maxC,  1, MPI_INT,             MPI_MAX, comm);CHKERRQ(ierr);
15425c6c1daeSBarry Smith         name  = "";
15435c6c1daeSBarry Smith       }
15445c6c1daeSBarry Smith       if (mint < 0.0) {
15455c6c1daeSBarry 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);
15465c6c1daeSBarry Smith         mint = 0;
15475c6c1daeSBarry Smith       }
1548d4aa7d5fSBarry 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);
15495c6c1daeSBarry Smith       totm *= 0.5; totml *= 0.5; totr /= size;
15505c6c1daeSBarry Smith 
1551217044c2SLisandro Dalcin       if (maxC != 0) {
1552217044c2SLisandro Dalcin         if (minC          != 0)   ratC             = ((PetscLogDouble)maxC)/minC;else ratC             = 0.0;
15535c6c1daeSBarry Smith         if (mint          != 0.0) ratt             = maxt/mint;                  else ratt             = 0.0;
15545c6c1daeSBarry Smith         if (minf          != 0.0) ratf             = maxf/minf;                  else ratf             = 0.0;
15555c6c1daeSBarry Smith         if (TotalTime     != 0.0) fracTime         = tott/TotalTime;             else fracTime         = 0.0;
15565c6c1daeSBarry Smith         if (TotalFlops    != 0.0) fracFlops        = totf/TotalFlops;            else fracFlops        = 0.0;
15575c6c1daeSBarry Smith         if (stageTime     != 0.0) fracStageTime    = tott/stageTime;             else fracStageTime    = 0.0;
15585c6c1daeSBarry Smith         if (flops         != 0.0) fracStageFlops   = totf/flops;                 else fracStageFlops   = 0.0;
15595c6c1daeSBarry Smith         if (numMessages   != 0.0) fracMess         = totm/numMessages;           else fracMess         = 0.0;
15605c6c1daeSBarry Smith         if (messageLength != 0.0) fracMessLen      = totml/messageLength;        else fracMessLen      = 0.0;
15615c6c1daeSBarry Smith         if (numReductions != 0.0) fracRed          = totr/numReductions;         else fracRed          = 0.0;
15625c6c1daeSBarry Smith         if (mess          != 0.0) fracStageMess    = totm/mess;                  else fracStageMess    = 0.0;
15635c6c1daeSBarry Smith         if (messLen       != 0.0) fracStageMessLen = totml/messLen;              else fracStageMessLen = 0.0;
15645c6c1daeSBarry Smith         if (red           != 0.0) fracStageRed     = totr/red;                   else fracStageRed     = 0.0;
15655c6c1daeSBarry Smith         if (totm          != 0.0) totml           /= totm;                       else totml            = 0.0;
15665c6c1daeSBarry Smith         if (maxt          != 0.0) flopr            = totf/maxt;                  else flopr            = 0.0;
1567411f5eb9SRichard 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);
15685c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd,
15695c6c1daeSBarry 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\n",
1570217044c2SLisandro Dalcin                             name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr,
15715c6c1daeSBarry Smith                             100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed,
15725c6c1daeSBarry Smith                             100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed,
1573c068d9bbSLisandro Dalcin                             PetscAbs(flopr)/1.0e6);CHKERRQ(ierr);
15745c6c1daeSBarry Smith       }
15755c6c1daeSBarry Smith     }
15765c6c1daeSBarry Smith   }
15775c6c1daeSBarry Smith 
15785c6c1daeSBarry Smith   /* Memory usage and object creation */
1579a297a907SKarl Rupp   ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
15805c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr);
15815c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n");CHKERRQ(ierr);
15825c6c1daeSBarry Smith 
15835c6c1daeSBarry Smith   /* Right now, only stages on the first processor are reported here, meaning only objects associated with
15845c6c1daeSBarry Smith      the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then
15855c6c1daeSBarry Smith      stats for stages local to processor sets.
15865c6c1daeSBarry Smith   */
15875c6c1daeSBarry Smith   /* We should figure out the longest object name here (now 20 characters) */
15885c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Object Type          Creations   Destructions     Memory  Descendants' Mem.\n");CHKERRQ(ierr);
15895c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Reports information only for process 0.\n");CHKERRQ(ierr);
15905c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
15915c6c1daeSBarry Smith     if (localStageUsed[stage]) {
15925c6c1daeSBarry Smith       classInfo = stageLog->stageInfo[stage].classLog->classInfo;
15935c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr);
15945c6c1daeSBarry Smith       for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) {
15955c6c1daeSBarry Smith         if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) {
15965c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "%20s %5d          %5d  %11.0f     %g\n", stageLog->classLog->classInfo[oclass].name,
15975c6c1daeSBarry Smith                               classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem,
15985c6c1daeSBarry Smith                               classInfo[oclass].descMem);CHKERRQ(ierr);
15995c6c1daeSBarry Smith         }
16005c6c1daeSBarry Smith       }
16015c6c1daeSBarry Smith     } else {
1602cf019ec6SStefano Zampini       if (!localStageVisible[stage]) continue;
16035c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr);
16045c6c1daeSBarry Smith     }
16055c6c1daeSBarry Smith   }
16065c6c1daeSBarry Smith 
16075c6c1daeSBarry Smith   ierr = PetscFree(localStageUsed);CHKERRQ(ierr);
16085c6c1daeSBarry Smith   ierr = PetscFree(stageUsed);CHKERRQ(ierr);
16095c6c1daeSBarry Smith   ierr = PetscFree(localStageVisible);CHKERRQ(ierr);
16105c6c1daeSBarry Smith   ierr = PetscFree(stageVisible);CHKERRQ(ierr);
16115c6c1daeSBarry Smith 
16125c6c1daeSBarry Smith   /* Information unrelated to this particular run */
1613a297a907SKarl Rupp   ierr = PetscFPrintf(comm, fd, "========================================================================================================================\n");CHKERRQ(ierr);
16148563dfccSBarry Smith   PetscTime(&y);
16158563dfccSBarry Smith   PetscTime(&x);
16168563dfccSBarry Smith   PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y);
16178563dfccSBarry Smith   PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y);
16185c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0);CHKERRQ(ierr);
16195c6c1daeSBarry Smith   /* MPI information */
16205c6c1daeSBarry Smith   if (size > 1) {
16215c6c1daeSBarry Smith     MPI_Status  status;
16225c6c1daeSBarry Smith     PetscMPIInt tag;
16235c6c1daeSBarry Smith     MPI_Comm    newcomm;
16245c6c1daeSBarry Smith 
16255c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16268563dfccSBarry Smith     PetscTime(&x);
16275c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16285c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16295c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16305c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16315c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16328563dfccSBarry Smith     PetscTime(&y);
16335c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0);CHKERRQ(ierr);
16345c6c1daeSBarry Smith     ierr = PetscCommDuplicate(comm,&newcomm, &tag);CHKERRQ(ierr);
16355c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16365c6c1daeSBarry Smith     if (rank) {
1637217044c2SLisandro Dalcin       ierr = MPI_Recv(NULL, 0, MPI_INT, rank-1,            tag, newcomm, &status);CHKERRQ(ierr);
1638217044c2SLisandro Dalcin       ierr = MPI_Send(NULL, 0, MPI_INT, (rank+1)%size, tag, newcomm);CHKERRQ(ierr);
16395c6c1daeSBarry Smith     } else {
16408563dfccSBarry Smith       PetscTime(&x);
1641217044c2SLisandro Dalcin       ierr = MPI_Send(NULL, 0, MPI_INT, 1,          tag, newcomm);CHKERRQ(ierr);
1642217044c2SLisandro Dalcin       ierr = MPI_Recv(NULL, 0, MPI_INT, size-1, tag, newcomm, &status);CHKERRQ(ierr);
16438563dfccSBarry Smith       PetscTime(&y);
16445c6c1daeSBarry Smith       ierr = PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size);CHKERRQ(ierr);
16455c6c1daeSBarry Smith     }
16465c6c1daeSBarry Smith     ierr = PetscCommDestroy(&newcomm);CHKERRQ(ierr);
16475c6c1daeSBarry Smith   }
1648c5929fdfSBarry Smith   ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
16495c6c1daeSBarry Smith 
16505c6c1daeSBarry Smith   /* Machine and compile information */
16515c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS)
16525c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n");CHKERRQ(ierr);
16535c6c1daeSBarry Smith #else
16545c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n");CHKERRQ(ierr);
16555c6c1daeSBarry Smith #endif
1656217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES)
1657217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n");CHKERRQ(ierr);
1658217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128)
1659217044c2SLisandro Dalcin   ierr = PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n");CHKERRQ(ierr);
1660217044c2SLisandro Dalcin #endif
16615c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
16625c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n");CHKERRQ(ierr);
16635f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128)
16645f27b2e0SBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n");CHKERRQ(ierr);
16655c6c1daeSBarry Smith #endif
16665c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE)
16675c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with single precision matrices\n");CHKERRQ(ierr);
16685c6c1daeSBarry Smith #else
16695c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n");CHKERRQ(ierr);
16705c6c1daeSBarry Smith #endif
16715c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n",
16725c6c1daeSBarry Smith                       (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt));CHKERRQ(ierr);
16735c6c1daeSBarry Smith 
16745c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions);CHKERRQ(ierr);
16755c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petscmachineinfo);CHKERRQ(ierr);
16765c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsccompilerinfo);CHKERRQ(ierr);
16775c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo);CHKERRQ(ierr);
16785c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsclinkerinfo);CHKERRQ(ierr);
16795c6c1daeSBarry Smith 
16805c6c1daeSBarry Smith   /* Cleanup */
16815c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr);
1682f4091ad2SBarry Smith   ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr);
16835c6c1daeSBarry Smith   PetscFunctionReturn(0);
16845c6c1daeSBarry Smith }
16855c6c1daeSBarry Smith 
16867d6c928cSSatish Balay /*@C
16877d6c928cSSatish Balay   PetscLogView - Prints a summary of the logging.
16885c6c1daeSBarry Smith 
16895c6c1daeSBarry Smith   Collective over MPI_Comm
16905c6c1daeSBarry Smith 
16915c6c1daeSBarry Smith   Input Parameter:
1692f14045dbSBarry Smith .  viewer - an ASCII viewer
16935c6c1daeSBarry Smith 
16945c6c1daeSBarry Smith   Options Database Keys:
1695bb1d7374SBarry Smith +  -log_view [:filename] - Prints summary of log information
1696bb1d7374SBarry Smith .  -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file
1697607d249eSBarry 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)
1698bb1d7374SBarry Smith .  -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation
1699bb1d7374SBarry Smith -  -log_trace [filename] - Displays a trace of what each process is doing
17005c6c1daeSBarry Smith 
17015c6c1daeSBarry Smith   Notes:
1702bb1d7374SBarry Smith   It is possible to control the logging programatically but we recommend using the options database approach whenever possible
17035c6c1daeSBarry Smith   By default the summary is printed to stdout.
17045c6c1daeSBarry Smith 
1705bb1d7374SBarry Smith   Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin()
1706bb1d7374SBarry Smith 
1707bb1d7374SBarry Smith   If PETSc is configured with --with-logging=0 then this functionality is not available
1708bb1d7374SBarry Smith 
1709607d249eSBarry Smith   To view the nested XML format filename.xml first copy  ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current
1710607d249eSBarry Smith   directory then open filename.xml with your browser. Specific notes for certain browsers
1711607d249eSBarry Smith $    Firefox and Internet explorer - simply open the file
1712607d249eSBarry Smith $    Google Chrome - you must start up Chrome with the option --allow-file-access-from-files
1713607d249eSBarry Smith $    Safari - see http://ccm.net/faq/36342-safari-how-to-enable-local-file-access
1714607d249eSBarry 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
1715607d249eSBarry Smith   your browser.
1716607d249eSBarry Smith 
1717bb1d7374SBarry Smith   The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij  MARITIME  RESEARCH  INSTITUTE  NETHERLANDS
1718bb1d7374SBarry Smith 
17195c6c1daeSBarry Smith   Level: beginner
17205c6c1daeSBarry Smith 
17215c6c1daeSBarry Smith .keywords: log, dump, print
1722bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogDump()
17235c6c1daeSBarry Smith @*/
1724f14045dbSBarry Smith PetscErrorCode  PetscLogView(PetscViewer viewer)
17255c6c1daeSBarry Smith {
17265c6c1daeSBarry Smith   PetscErrorCode    ierr;
1727f14045dbSBarry Smith   PetscBool         isascii;
1728f14045dbSBarry Smith   PetscViewerFormat format;
172937b78d16SBarry Smith   int               stage, lastStage;
173037b78d16SBarry Smith   PetscStageLog     stageLog;
17315c6c1daeSBarry Smith 
17325c6c1daeSBarry Smith   PetscFunctionBegin;
1733609bdbeeSBarry Smith   if (!PetscLogPLB) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Must use -log_view or PetscLogDefaultBegin() before calling this routine");
173437b78d16SBarry Smith   /* Pop off any stages the user forgot to remove */
173537b78d16SBarry Smith   lastStage = 0;
173637b78d16SBarry Smith   ierr      = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
173737b78d16SBarry Smith   ierr      = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
173837b78d16SBarry Smith   while (stage >= 0) {
173937b78d16SBarry Smith     lastStage = stage;
174037b78d16SBarry Smith     ierr      = PetscStageLogPop(stageLog);CHKERRQ(ierr);
174137b78d16SBarry Smith     ierr      = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
174237b78d16SBarry Smith   }
1743f14045dbSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
1744f14045dbSBarry Smith   if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Currently can only view logging to ASCII");
1745f14045dbSBarry Smith   ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
1746f14045dbSBarry Smith   if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) {
1747f14045dbSBarry Smith     ierr = PetscLogView_Default(viewer);CHKERRQ(ierr);
1748f14045dbSBarry Smith   } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
1749f14045dbSBarry Smith     ierr = PetscLogView_Detailed(viewer);CHKERRQ(ierr);
1750bb1d7374SBarry Smith   } else if (format == PETSC_VIEWER_ASCII_XML) {
1751bb1d7374SBarry Smith     ierr = PetscLogView_Nested(viewer);CHKERRQ(ierr);
17525c6c1daeSBarry Smith   }
175337b78d16SBarry Smith   ierr = PetscStageLogPush(stageLog, lastStage);CHKERRQ(ierr);
17545c6c1daeSBarry Smith   PetscFunctionReturn(0);
17555c6c1daeSBarry Smith }
17565c6c1daeSBarry Smith 
1757f14045dbSBarry Smith /*@C
1758f14045dbSBarry Smith   PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed.
1759f14045dbSBarry Smith 
1760f14045dbSBarry Smith   Collective on PETSC_COMM_WORLD
1761f14045dbSBarry Smith 
1762f14045dbSBarry Smith   Not normally called by user
1763f14045dbSBarry Smith 
1764f14045dbSBarry Smith   Level: intermediate
1765f14045dbSBarry Smith 
1766f14045dbSBarry Smith @*/
1767f14045dbSBarry Smith PetscErrorCode PetscLogViewFromOptions(void)
1768f14045dbSBarry Smith {
1769f14045dbSBarry Smith   PetscErrorCode    ierr;
1770f14045dbSBarry Smith   PetscViewer       viewer;
1771f14045dbSBarry Smith   PetscBool         flg;
1772f14045dbSBarry Smith   PetscViewerFormat format;
1773f14045dbSBarry Smith 
1774f14045dbSBarry Smith   PetscFunctionBegin;
1775f14045dbSBarry Smith   ierr   = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,"-log_view",&viewer,&format,&flg);CHKERRQ(ierr);
1776f14045dbSBarry Smith   if (flg) {
1777f14045dbSBarry Smith     ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr);
1778f14045dbSBarry Smith     ierr = PetscLogView(viewer);CHKERRQ(ierr);
1779f14045dbSBarry Smith     ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
1780f14045dbSBarry Smith     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1781f14045dbSBarry Smith   }
1782f14045dbSBarry Smith   PetscFunctionReturn(0);
1783f14045dbSBarry Smith }
1784f14045dbSBarry Smith 
1785f14045dbSBarry Smith 
1786f14045dbSBarry Smith 
17875c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/
17885c6c1daeSBarry Smith /*@C
17895c6c1daeSBarry Smith    PetscGetFlops - Returns the number of flops used on this processor
17905c6c1daeSBarry Smith    since the program began.
17915c6c1daeSBarry Smith 
17925c6c1daeSBarry Smith    Not Collective
17935c6c1daeSBarry Smith 
17945c6c1daeSBarry Smith    Output Parameter:
17955c6c1daeSBarry Smith    flops - number of floating point operations
17965c6c1daeSBarry Smith 
17975c6c1daeSBarry Smith    Notes:
17985c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
17995c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
18005c6c1daeSBarry Smith    application code.
18015c6c1daeSBarry Smith 
18025c6c1daeSBarry Smith    Level: intermediate
18035c6c1daeSBarry Smith 
18045c6c1daeSBarry Smith .keywords: log, flops, floating point operations
18055c6c1daeSBarry Smith 
18068563dfccSBarry Smith .seealso: PetscTime(), PetscLogFlops()
18075c6c1daeSBarry Smith @*/
18085c6c1daeSBarry Smith PetscErrorCode  PetscGetFlops(PetscLogDouble *flops)
18095c6c1daeSBarry Smith {
18105c6c1daeSBarry Smith   PetscFunctionBegin;
18115c6c1daeSBarry Smith   *flops = petsc_TotalFlops;
18125c6c1daeSBarry Smith   PetscFunctionReturn(0);
18135c6c1daeSBarry Smith }
18145c6c1daeSBarry Smith 
18155c6c1daeSBarry Smith PetscErrorCode  PetscLogObjectState(PetscObject obj, const char format[], ...)
18165c6c1daeSBarry Smith {
18175c6c1daeSBarry Smith   PetscErrorCode ierr;
18185c6c1daeSBarry Smith   size_t         fullLength;
18195c6c1daeSBarry Smith   va_list        Argp;
18205c6c1daeSBarry Smith 
18215c6c1daeSBarry Smith   PetscFunctionBegin;
18225c6c1daeSBarry Smith   if (!petsc_logObjects) PetscFunctionReturn(0);
18235c6c1daeSBarry Smith   va_start(Argp, format);
18245c6c1daeSBarry Smith   ierr = PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp);CHKERRQ(ierr);
18255c6c1daeSBarry Smith   va_end(Argp);
18265c6c1daeSBarry Smith   PetscFunctionReturn(0);
18275c6c1daeSBarry Smith }
18285c6c1daeSBarry Smith 
18295c6c1daeSBarry Smith 
18305c6c1daeSBarry Smith /*MC
18315c6c1daeSBarry Smith    PetscLogFlops - Adds floating point operations to the global counter.
18325c6c1daeSBarry Smith 
18335c6c1daeSBarry Smith    Synopsis:
1834aaa7dc30SBarry Smith    #include <petsclog.h>
18355c6c1daeSBarry Smith    PetscErrorCode PetscLogFlops(PetscLogDouble f)
18365c6c1daeSBarry Smith 
18375c6c1daeSBarry Smith    Not Collective
18385c6c1daeSBarry Smith 
18395c6c1daeSBarry Smith    Input Parameter:
18405c6c1daeSBarry Smith .  f - flop counter
18415c6c1daeSBarry Smith 
18425c6c1daeSBarry Smith 
18435c6c1daeSBarry Smith    Usage:
18445c6c1daeSBarry Smith .vb
18455c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
18465c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
18475c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
18485c6c1daeSBarry Smith         [code segment to monitor]
18495c6c1daeSBarry Smith         PetscLogFlops(user_flops)
18505c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
18515c6c1daeSBarry Smith .ve
18525c6c1daeSBarry Smith 
18535c6c1daeSBarry Smith    Notes:
18545c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
18555c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
18565c6c1daeSBarry Smith    application code.
18575c6c1daeSBarry Smith 
18585c6c1daeSBarry Smith    Level: intermediate
18595c6c1daeSBarry Smith 
18605c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscGetFlops()
18615c6c1daeSBarry Smith 
18625c6c1daeSBarry Smith .keywords: log, flops, floating point operations
18635c6c1daeSBarry Smith M*/
18645c6c1daeSBarry Smith 
18655c6c1daeSBarry Smith /*MC
18665c6c1daeSBarry Smith    PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice)
18675c6c1daeSBarry Smith     to get accurate timings
18685c6c1daeSBarry Smith 
18695c6c1daeSBarry Smith    Synopsis:
1870aaa7dc30SBarry Smith    #include <petsclog.h>
18715c6c1daeSBarry Smith    void PetscPreLoadBegin(PetscBool  flag,char *name);
18725c6c1daeSBarry Smith 
18735c6c1daeSBarry Smith    Not Collective
18745c6c1daeSBarry Smith 
18755c6c1daeSBarry Smith    Input Parameter:
18765c6c1daeSBarry Smith +   flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden
18775c6c1daeSBarry Smith            with command line option -preload true or -preload false
1878609bdbeeSBarry Smith -   name - name of first stage (lines of code timed separately with -log_view) to
18795c6c1daeSBarry Smith            be preloaded
18805c6c1daeSBarry Smith 
18815c6c1daeSBarry Smith    Usage:
18825c6c1daeSBarry Smith .vb
18835c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
18845c6c1daeSBarry Smith        lines of code
18855c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
18865c6c1daeSBarry Smith        lines of code
18875c6c1daeSBarry Smith      PetscPreLoadEnd();
18885c6c1daeSBarry Smith .ve
18895c6c1daeSBarry Smith 
189095452b02SPatrick Sanan    Notes:
189195452b02SPatrick Sanan     Only works in C/C++, not Fortran
18925c6c1daeSBarry Smith 
18935c6c1daeSBarry Smith      Flags available within the macro.
18945c6c1daeSBarry Smith +    PetscPreLoadingUsed - true if we are or have done preloading
18955c6c1daeSBarry Smith .    PetscPreLoadingOn - true if it is CURRENTLY doing preload
18965c6c1daeSBarry Smith .    PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second
18975c6c1daeSBarry Smith -    PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on
18985c6c1daeSBarry Smith      The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin()
18995c6c1daeSBarry Smith      and PetscPreLoadEnd()
19005c6c1daeSBarry Smith 
19015c6c1daeSBarry Smith    Level: intermediate
19025c6c1daeSBarry Smith 
19035c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage()
19045c6c1daeSBarry Smith 
19055c6c1daeSBarry Smith    Concepts: preloading
19065c6c1daeSBarry Smith    Concepts: timing^accurate
19075c6c1daeSBarry Smith    Concepts: paging^eliminating effects of
19085c6c1daeSBarry Smith 
19095c6c1daeSBarry Smith 
19105c6c1daeSBarry Smith M*/
19115c6c1daeSBarry Smith 
19125c6c1daeSBarry Smith /*MC
19135c6c1daeSBarry Smith    PetscPreLoadEnd - End a segment of code that may be preloaded (run twice)
19145c6c1daeSBarry Smith     to get accurate timings
19155c6c1daeSBarry Smith 
19165c6c1daeSBarry Smith    Synopsis:
1917aaa7dc30SBarry Smith    #include <petsclog.h>
19185c6c1daeSBarry Smith    void PetscPreLoadEnd(void);
19195c6c1daeSBarry Smith 
19205c6c1daeSBarry Smith    Not Collective
19215c6c1daeSBarry Smith 
19225c6c1daeSBarry Smith    Usage:
19235c6c1daeSBarry Smith .vb
19245c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
19255c6c1daeSBarry Smith        lines of code
19265c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
19275c6c1daeSBarry Smith        lines of code
19285c6c1daeSBarry Smith      PetscPreLoadEnd();
19295c6c1daeSBarry Smith .ve
19305c6c1daeSBarry Smith 
193195452b02SPatrick Sanan    Notes:
193295452b02SPatrick Sanan     only works in C/C++ not fortran
19335c6c1daeSBarry Smith 
19345c6c1daeSBarry Smith    Level: intermediate
19355c6c1daeSBarry Smith 
19365c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadStage()
19375c6c1daeSBarry Smith 
19385c6c1daeSBarry Smith M*/
19395c6c1daeSBarry Smith 
19405c6c1daeSBarry Smith /*MC
19415c6c1daeSBarry Smith    PetscPreLoadStage - Start a new segment of code to be timed separately.
19425c6c1daeSBarry Smith     to get accurate timings
19435c6c1daeSBarry Smith 
19445c6c1daeSBarry Smith    Synopsis:
1945aaa7dc30SBarry Smith    #include <petsclog.h>
19465c6c1daeSBarry Smith    void PetscPreLoadStage(char *name);
19475c6c1daeSBarry Smith 
19485c6c1daeSBarry Smith    Not Collective
19495c6c1daeSBarry Smith 
19505c6c1daeSBarry Smith    Usage:
19515c6c1daeSBarry Smith .vb
19525c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
19535c6c1daeSBarry Smith        lines of code
19545c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
19555c6c1daeSBarry Smith        lines of code
19565c6c1daeSBarry Smith      PetscPreLoadEnd();
19575c6c1daeSBarry Smith .ve
19585c6c1daeSBarry Smith 
195995452b02SPatrick Sanan    Notes:
196095452b02SPatrick Sanan     only works in C/C++ not fortran
19615c6c1daeSBarry Smith 
19625c6c1daeSBarry Smith    Level: intermediate
19635c6c1daeSBarry Smith 
19645c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd()
19655c6c1daeSBarry Smith 
19665c6c1daeSBarry Smith M*/
19675c6c1daeSBarry Smith 
19685c6c1daeSBarry Smith 
19695c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */
19705c6c1daeSBarry Smith 
19715c6c1daeSBarry Smith PetscErrorCode  PetscLogObjectState(PetscObject obj, const char format[], ...)
19725c6c1daeSBarry Smith {
19735c6c1daeSBarry Smith   PetscFunctionBegin;
19745c6c1daeSBarry Smith   PetscFunctionReturn(0);
19755c6c1daeSBarry Smith }
19765c6c1daeSBarry Smith 
19775c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/
19785c6c1daeSBarry Smith 
19795c6c1daeSBarry Smith 
19805c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID;
19815c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID  = 0;
19825c6c1daeSBarry Smith 
19835c6c1daeSBarry Smith /*@C
19845c6c1daeSBarry Smith   PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code.
19855c6c1daeSBarry Smith 
19865c6c1daeSBarry Smith   Not Collective
19875c6c1daeSBarry Smith 
19885c6c1daeSBarry Smith   Input Parameter:
19895c6c1daeSBarry Smith . name   - The class name
19905c6c1daeSBarry Smith 
19915c6c1daeSBarry Smith   Output Parameter:
19925c6c1daeSBarry Smith . oclass - The class id or classid
19935c6c1daeSBarry Smith 
19945c6c1daeSBarry Smith   Level: developer
19955c6c1daeSBarry Smith 
19965c6c1daeSBarry Smith .keywords: log, class, register
19975c6c1daeSBarry Smith 
19985c6c1daeSBarry Smith @*/
19995c6c1daeSBarry Smith PetscErrorCode  PetscClassIdRegister(const char name[],PetscClassId *oclass)
20005c6c1daeSBarry Smith {
20015c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
20025c6c1daeSBarry Smith   PetscStageLog  stageLog;
20035c6c1daeSBarry Smith   PetscInt       stage;
20045c6c1daeSBarry Smith   PetscErrorCode ierr;
20055c6c1daeSBarry Smith #endif
20065c6c1daeSBarry Smith 
20075c6c1daeSBarry Smith   PetscFunctionBegin;
20085c6c1daeSBarry Smith   *oclass = ++PETSC_LARGEST_CLASSID;
20095c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
20105c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
20115c6c1daeSBarry Smith   ierr = PetscClassRegLogRegister(stageLog->classLog, name, *oclass);CHKERRQ(ierr);
20125c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
20133a88037aSBarry Smith     ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
20145c6c1daeSBarry Smith   }
20155c6c1daeSBarry Smith #endif
20165c6c1daeSBarry Smith   PetscFunctionReturn(0);
20175c6c1daeSBarry Smith }
2018210b5426SBarry Smith 
2019210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE)
2020210b5426SBarry Smith #include <mpe.h>
2021210b5426SBarry Smith 
2022210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE;
2023210b5426SBarry Smith 
2024495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
2025495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
2026495fc317SBarry Smith 
2027210b5426SBarry Smith /*@C
2028210b5426SBarry Smith    PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files
2029210b5426SBarry Smith    and slows the program down.
2030210b5426SBarry Smith 
2031210b5426SBarry Smith    Collective over PETSC_COMM_WORLD
2032210b5426SBarry Smith 
2033210b5426SBarry Smith    Options Database Keys:
2034a2553e36SBarry Smith . -log_mpe - Prints extensive log information
2035210b5426SBarry Smith 
2036210b5426SBarry Smith    Notes:
2037609bdbeeSBarry Smith    A related routine is PetscLogDefaultBegin() (with the options key -log_view), which is
2038210b5426SBarry Smith    intended for production runs since it logs only flop rates and object
2039210b5426SBarry Smith    creation (and should not significantly slow the programs).
2040210b5426SBarry Smith 
2041210b5426SBarry Smith    Level: advanced
2042210b5426SBarry Smith 
2043210b5426SBarry Smith    Concepts: logging^MPE
2044210b5426SBarry Smith    Concepts: logging^message passing
2045210b5426SBarry Smith 
2046bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogEventActivate(),
2047210b5426SBarry Smith           PetscLogEventDeactivate()
2048210b5426SBarry Smith @*/
2049210b5426SBarry Smith PetscErrorCode  PetscLogMPEBegin(void)
2050210b5426SBarry Smith {
2051210b5426SBarry Smith   PetscErrorCode ierr;
2052210b5426SBarry Smith 
2053210b5426SBarry Smith   PetscFunctionBegin;
2054210b5426SBarry Smith   /* Do MPE initialization */
2055210b5426SBarry Smith   if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */
2056210b5426SBarry Smith     ierr = PetscInfo(0,"Initializing MPE.\n");CHKERRQ(ierr);
2057210b5426SBarry Smith     ierr = MPE_Init_log();CHKERRQ(ierr);
2058210b5426SBarry Smith 
2059210b5426SBarry Smith     PetscBeganMPE = PETSC_TRUE;
2060210b5426SBarry Smith   } else {
2061210b5426SBarry Smith     ierr = PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n");CHKERRQ(ierr);
2062210b5426SBarry Smith   }
2063495fc317SBarry Smith   ierr = PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE);CHKERRQ(ierr);
2064210b5426SBarry Smith   PetscFunctionReturn(0);
2065210b5426SBarry Smith }
2066210b5426SBarry Smith 
2067210b5426SBarry Smith /*@C
2068495fc317SBarry Smith    PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot.
2069210b5426SBarry Smith 
2070210b5426SBarry Smith    Collective over PETSC_COMM_WORLD
2071210b5426SBarry Smith 
2072210b5426SBarry Smith    Level: advanced
2073210b5426SBarry Smith 
2074210b5426SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogMPEBegin()
2075210b5426SBarry Smith @*/
2076210b5426SBarry Smith PetscErrorCode  PetscLogMPEDump(const char sname[])
2077210b5426SBarry Smith {
2078210b5426SBarry Smith   char           name[PETSC_MAX_PATH_LEN];
2079210b5426SBarry Smith   PetscErrorCode ierr;
2080210b5426SBarry Smith 
2081210b5426SBarry Smith   PetscFunctionBegin;
2082210b5426SBarry Smith   if (PetscBeganMPE) {
2083210b5426SBarry Smith     ierr = PetscInfo(0,"Finalizing MPE.\n");CHKERRQ(ierr);
2084210b5426SBarry Smith     if (sname) {
2085210b5426SBarry Smith       ierr = PetscStrcpy(name,sname);CHKERRQ(ierr);
2086210b5426SBarry Smith     } else {
2087210b5426SBarry Smith       ierr = PetscGetProgramName(name,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
2088210b5426SBarry Smith     }
2089210b5426SBarry Smith     ierr = MPE_Finish_log(name);CHKERRQ(ierr);
2090210b5426SBarry Smith   } else {
2091210b5426SBarry Smith     ierr = PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n");CHKERRQ(ierr);
2092210b5426SBarry Smith   }
2093210b5426SBarry Smith   PetscFunctionReturn(0);
2094210b5426SBarry Smith }
2095210b5426SBarry Smith 
2096210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39
2097210b5426SBarry Smith static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = {
2098210b5426SBarry Smith   "OliveDrab:      ",
2099210b5426SBarry Smith   "BlueViolet:     ",
2100210b5426SBarry Smith   "CadetBlue:      ",
2101210b5426SBarry Smith   "CornflowerBlue: ",
2102210b5426SBarry Smith   "DarkGoldenrod:  ",
2103210b5426SBarry Smith   "DarkGreen:      ",
2104210b5426SBarry Smith   "DarkKhaki:      ",
2105210b5426SBarry Smith   "DarkOliveGreen: ",
2106210b5426SBarry Smith   "DarkOrange:     ",
2107210b5426SBarry Smith   "DarkOrchid:     ",
2108210b5426SBarry Smith   "DarkSeaGreen:   ",
2109210b5426SBarry Smith   "DarkSlateGray:  ",
2110210b5426SBarry Smith   "DarkTurquoise:  ",
2111210b5426SBarry Smith   "DeepPink:       ",
2112210b5426SBarry Smith   "DarkKhaki:      ",
2113210b5426SBarry Smith   "DimGray:        ",
2114210b5426SBarry Smith   "DodgerBlue:     ",
2115210b5426SBarry Smith   "GreenYellow:    ",
2116210b5426SBarry Smith   "HotPink:        ",
2117210b5426SBarry Smith   "IndianRed:      ",
2118210b5426SBarry Smith   "LavenderBlush:  ",
2119210b5426SBarry Smith   "LawnGreen:      ",
2120210b5426SBarry Smith   "LemonChiffon:   ",
2121210b5426SBarry Smith   "LightCoral:     ",
2122210b5426SBarry Smith   "LightCyan:      ",
2123210b5426SBarry Smith   "LightPink:      ",
2124210b5426SBarry Smith   "LightSalmon:    ",
2125210b5426SBarry Smith   "LightSlateGray: ",
2126210b5426SBarry Smith   "LightYellow:    ",
2127210b5426SBarry Smith   "LimeGreen:      ",
2128210b5426SBarry Smith   "MediumPurple:   ",
2129210b5426SBarry Smith   "MediumSeaGreen: ",
2130210b5426SBarry Smith   "MediumSlateBlue:",
2131210b5426SBarry Smith   "MidnightBlue:   ",
2132210b5426SBarry Smith   "MintCream:      ",
2133210b5426SBarry Smith   "MistyRose:      ",
2134210b5426SBarry Smith   "NavajoWhite:    ",
2135210b5426SBarry Smith   "NavyBlue:       ",
2136210b5426SBarry Smith   "OliveDrab:      "
2137210b5426SBarry Smith };
2138210b5426SBarry Smith 
2139210b5426SBarry Smith /*@C
2140210b5426SBarry Smith   PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister()
2141210b5426SBarry Smith 
2142210b5426SBarry Smith   Not collective. Maybe it should be?
2143210b5426SBarry Smith 
2144210b5426SBarry Smith   Output Parameter
2145210b5426SBarry Smith . str - character string representing the color
2146210b5426SBarry Smith 
2147210b5426SBarry Smith   Level: developer
2148210b5426SBarry Smith 
2149210b5426SBarry Smith .keywords: log, mpe , color
2150210b5426SBarry Smith .seealso: PetscLogEventRegister
2151210b5426SBarry Smith @*/
2152210b5426SBarry Smith PetscErrorCode  PetscLogMPEGetRGBColor(const char *str[])
2153210b5426SBarry Smith {
2154210b5426SBarry Smith   static int idx = 0;
2155210b5426SBarry Smith 
2156210b5426SBarry Smith   PetscFunctionBegin;
2157210b5426SBarry Smith   *str = PetscLogMPERGBColors[idx];
2158210b5426SBarry Smith   idx  = (idx + 1)% PETSC_RGB_COLORS_MAX;
2159210b5426SBarry Smith   PetscFunctionReturn(0);
2160210b5426SBarry Smith }
2161210b5426SBarry Smith 
2162210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */
2163