xref: /petsc/src/sys/logging/plog.c (revision cf019ec6f319a509de7602f53cdadf853cfc8a83)
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 
34bb72fc59SBarry Smith    Developer Notes: Currently we do not always do a good job of associating all memory allocations with an object.
35bb72fc59SBarry Smith 
36bb72fc59SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments()
37bb72fc59SBarry Smith 
38bb72fc59SBarry Smith @*/
393bb1ff40SBarry Smith PetscErrorCode PetscLogObjectMemory(PetscObject p,PetscLogDouble m)
403bb1ff40SBarry Smith {
41d12f57a0SLisandro Dalcin   if (!p) return 0;
4227b6d19dSBarry Smith   p->mem += m;
433bb1ff40SBarry Smith   return 0;
443bb1ff40SBarry Smith }
453bb1ff40SBarry Smith 
465c6c1daeSBarry Smith PetscLogEvent PETSC_LARGEST_EVENT = PETSC_EVENT;
475c6c1daeSBarry Smith 
485c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
495c6c1daeSBarry Smith #include <petscmachineinfo.h>
505c6c1daeSBarry Smith #include <petscconfiginfo.h>
515c6c1daeSBarry Smith 
525c6c1daeSBarry Smith /* used in the MPI_XXX() count macros in petsclog.h */
535c6c1daeSBarry Smith 
545c6c1daeSBarry Smith /* Action and object logging variables */
550298fd71SBarry Smith Action    *petsc_actions            = NULL;
560298fd71SBarry Smith Object    *petsc_objects            = NULL;
575c6c1daeSBarry Smith PetscBool petsc_logActions          = PETSC_FALSE;
585c6c1daeSBarry Smith PetscBool petsc_logObjects          = PETSC_FALSE;
595c6c1daeSBarry Smith int       petsc_numActions          = 0, petsc_maxActions = 100;
605c6c1daeSBarry Smith int       petsc_numObjects          = 0, petsc_maxObjects = 100;
615c6c1daeSBarry Smith int       petsc_numObjectsDestroyed = 0;
625c6c1daeSBarry Smith 
635c6c1daeSBarry Smith /* Global counters */
645c6c1daeSBarry Smith PetscLogDouble petsc_BaseTime        = 0.0;
655c6c1daeSBarry Smith PetscLogDouble petsc_TotalFlops      = 0.0;  /* The number of flops */
665c6c1daeSBarry Smith PetscLogDouble petsc_tmp_flops       = 0.0;  /* The incremental number of flops */
675c6c1daeSBarry Smith PetscLogDouble petsc_send_ct         = 0.0;  /* The number of sends */
685c6c1daeSBarry Smith PetscLogDouble petsc_recv_ct         = 0.0;  /* The number of receives */
695c6c1daeSBarry Smith PetscLogDouble petsc_send_len        = 0.0;  /* The total length of all sent messages */
705c6c1daeSBarry Smith PetscLogDouble petsc_recv_len        = 0.0;  /* The total length of all received messages */
715c6c1daeSBarry Smith PetscLogDouble petsc_isend_ct        = 0.0;  /* The number of immediate sends */
725c6c1daeSBarry Smith PetscLogDouble petsc_irecv_ct        = 0.0;  /* The number of immediate receives */
735c6c1daeSBarry Smith PetscLogDouble petsc_isend_len       = 0.0;  /* The total length of all immediate send messages */
745c6c1daeSBarry Smith PetscLogDouble petsc_irecv_len       = 0.0;  /* The total length of all immediate receive messages */
755c6c1daeSBarry Smith PetscLogDouble petsc_wait_ct         = 0.0;  /* The number of waits */
765c6c1daeSBarry Smith PetscLogDouble petsc_wait_any_ct     = 0.0;  /* The number of anywaits */
775c6c1daeSBarry Smith PetscLogDouble petsc_wait_all_ct     = 0.0;  /* The number of waitalls */
785c6c1daeSBarry Smith PetscLogDouble petsc_sum_of_waits_ct = 0.0;  /* The total number of waits */
795c6c1daeSBarry Smith PetscLogDouble petsc_allreduce_ct    = 0.0;  /* The number of reductions */
805c6c1daeSBarry Smith PetscLogDouble petsc_gather_ct       = 0.0;  /* The number of gathers and gathervs */
815c6c1daeSBarry Smith PetscLogDouble petsc_scatter_ct      = 0.0;  /* The number of scatters and scattervs */
825c6c1daeSBarry Smith 
835c6c1daeSBarry Smith /* Logging functions */
840298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL;
850298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL;
860298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL;
870298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL;
885c6c1daeSBarry Smith 
895c6c1daeSBarry Smith /* Tracing event logging variables */
900298fd71SBarry Smith FILE             *petsc_tracefile            = NULL;
915c6c1daeSBarry Smith int              petsc_tracelevel            = 0;
925c6c1daeSBarry Smith const char       *petsc_traceblanks          = "                                                                                                    ";
935c6c1daeSBarry Smith char             petsc_tracespace[128]       = " ";
945c6c1daeSBarry Smith PetscLogDouble   petsc_tracetime             = 0.0;
95896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE;
965c6c1daeSBarry Smith 
975c6c1daeSBarry Smith /*---------------------------------------------- General Functions --------------------------------------------------*/
985c6c1daeSBarry Smith /*@C
995c6c1daeSBarry Smith   PetscLogDestroy - Destroys the object and event logging data and resets the global counters.
1005c6c1daeSBarry Smith 
1015c6c1daeSBarry Smith   Not Collective
1025c6c1daeSBarry Smith 
1035c6c1daeSBarry Smith   Notes:
1045c6c1daeSBarry Smith   This routine should not usually be used by programmers. Instead employ
1055c6c1daeSBarry Smith   PetscLogStagePush() and PetscLogStagePop().
1065c6c1daeSBarry Smith 
1075c6c1daeSBarry Smith   Level: developer
1085c6c1daeSBarry Smith 
1095c6c1daeSBarry Smith .keywords: log, destroy
1105c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogStagePush(), PlogStagePop()
1115c6c1daeSBarry Smith @*/
1125c6c1daeSBarry Smith PetscErrorCode  PetscLogDestroy(void)
1135c6c1daeSBarry Smith {
1145c6c1daeSBarry Smith   PetscStageLog  stageLog;
1155c6c1daeSBarry Smith   PetscErrorCode ierr;
1165c6c1daeSBarry Smith 
1175c6c1daeSBarry Smith   PetscFunctionBegin;
1185c6c1daeSBarry Smith   ierr = PetscFree(petsc_actions);CHKERRQ(ierr);
1195c6c1daeSBarry Smith   ierr = PetscFree(petsc_objects);CHKERRQ(ierr);
120eccbb886SLisandro Dalcin   ierr = PetscLogNestedEnd();CHKERRQ(ierr);
1210298fd71SBarry Smith   ierr = PetscLogSet(NULL, NULL);CHKERRQ(ierr);
1225c6c1daeSBarry Smith 
1235c6c1daeSBarry Smith   /* Resetting phase */
1245c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
1255c6c1daeSBarry Smith   ierr = PetscStageLogDestroy(stageLog);CHKERRQ(ierr);
126a297a907SKarl Rupp 
1275c6c1daeSBarry Smith   petsc_TotalFlops            = 0.0;
1285c6c1daeSBarry Smith   petsc_numActions            = 0;
1295c6c1daeSBarry Smith   petsc_numObjects            = 0;
1305c6c1daeSBarry Smith   petsc_numObjectsDestroyed   = 0;
1315c6c1daeSBarry Smith   petsc_maxActions            = 100;
1325c6c1daeSBarry Smith   petsc_maxObjects            = 100;
1330298fd71SBarry Smith   petsc_actions               = NULL;
1340298fd71SBarry Smith   petsc_objects               = NULL;
1355c6c1daeSBarry Smith   petsc_logActions            = PETSC_FALSE;
1365c6c1daeSBarry Smith   petsc_logObjects            = PETSC_FALSE;
1375c6c1daeSBarry Smith   petsc_BaseTime              = 0.0;
1385c6c1daeSBarry Smith   petsc_TotalFlops            = 0.0;
1395c6c1daeSBarry Smith   petsc_tmp_flops             = 0.0;
1405c6c1daeSBarry Smith   petsc_send_ct               = 0.0;
1415c6c1daeSBarry Smith   petsc_recv_ct               = 0.0;
1425c6c1daeSBarry Smith   petsc_send_len              = 0.0;
1435c6c1daeSBarry Smith   petsc_recv_len              = 0.0;
1445c6c1daeSBarry Smith   petsc_isend_ct              = 0.0;
1455c6c1daeSBarry Smith   petsc_irecv_ct              = 0.0;
1465c6c1daeSBarry Smith   petsc_isend_len             = 0.0;
1475c6c1daeSBarry Smith   petsc_irecv_len             = 0.0;
1485c6c1daeSBarry Smith   petsc_wait_ct               = 0.0;
1495c6c1daeSBarry Smith   petsc_wait_any_ct           = 0.0;
1505c6c1daeSBarry Smith   petsc_wait_all_ct           = 0.0;
1515c6c1daeSBarry Smith   petsc_sum_of_waits_ct       = 0.0;
1525c6c1daeSBarry Smith   petsc_allreduce_ct          = 0.0;
1535c6c1daeSBarry Smith   petsc_gather_ct             = 0.0;
1545c6c1daeSBarry Smith   petsc_scatter_ct            = 0.0;
1555c6c1daeSBarry Smith   PETSC_LARGEST_EVENT         = PETSC_EVENT;
1560298fd71SBarry Smith   PetscLogPHC                 = NULL;
1570298fd71SBarry Smith   PetscLogPHD                 = NULL;
1580298fd71SBarry Smith   petsc_tracefile             = NULL;
1595c6c1daeSBarry Smith   petsc_tracelevel            = 0;
1605c6c1daeSBarry Smith   petsc_traceblanks           = "                                                                                                    ";
1615c6c1daeSBarry Smith   petsc_tracespace[0]         = ' '; petsc_tracespace[1] = 0;
1625c6c1daeSBarry Smith   petsc_tracetime             = 0.0;
1635c6c1daeSBarry Smith   PETSC_LARGEST_CLASSID       = PETSC_SMALLEST_CLASSID;
1645c6c1daeSBarry Smith   PETSC_OBJECT_CLASSID        = 0;
1655c6c1daeSBarry Smith   petsc_stageLog              = 0;
166896238b9SBarry Smith   PetscLogInitializeCalled = PETSC_FALSE;
1675c6c1daeSBarry Smith   PetscFunctionReturn(0);
1685c6c1daeSBarry Smith }
1695c6c1daeSBarry Smith 
1705c6c1daeSBarry Smith /*@C
1715c6c1daeSBarry Smith   PetscLogSet - Sets the logging functions called at the beginning and ending of every event.
1725c6c1daeSBarry Smith 
1735c6c1daeSBarry Smith   Not Collective
1745c6c1daeSBarry Smith 
1755c6c1daeSBarry Smith   Input Parameters:
1765c6c1daeSBarry Smith + b - The function called at beginning of event
1775c6c1daeSBarry Smith - e - The function called at end of event
1785c6c1daeSBarry Smith 
1795c6c1daeSBarry Smith   Level: developer
1805c6c1daeSBarry Smith 
181bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogTraceBegin()
1825c6c1daeSBarry Smith @*/
1835c6c1daeSBarry Smith PetscErrorCode  PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject),
1845c6c1daeSBarry Smith                             PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject))
1855c6c1daeSBarry Smith {
1865c6c1daeSBarry Smith   PetscFunctionBegin;
1875c6c1daeSBarry Smith   PetscLogPLB = b;
1885c6c1daeSBarry Smith   PetscLogPLE = e;
1895c6c1daeSBarry Smith   PetscFunctionReturn(0);
1905c6c1daeSBarry Smith }
1915c6c1daeSBarry Smith 
1925c6c1daeSBarry Smith /*------------------------------------------- Initialization Functions ----------------------------------------------*/
193896238b9SBarry Smith /*
194896238b9SBarry Smith     The data structures for logging are always created even if no logging is turned on. This is so events etc can
195896238b9SBarry Smith   be registered in the code before the actually logging is turned on.
196896238b9SBarry Smith  */
197896238b9SBarry Smith PetscErrorCode  PetscLogInitialize(void)
1985c6c1daeSBarry Smith {
1995c6c1daeSBarry Smith   int            stage;
2005c6c1daeSBarry Smith   PetscBool      opt;
2015c6c1daeSBarry Smith   PetscErrorCode ierr;
2025c6c1daeSBarry Smith 
2035c6c1daeSBarry Smith   PetscFunctionBegin;
204896238b9SBarry Smith   if (PetscLogInitializeCalled) PetscFunctionReturn(0);
205896238b9SBarry Smith   PetscLogInitializeCalled = PETSC_TRUE;
2065c6c1daeSBarry Smith 
207c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_actions", &opt);CHKERRQ(ierr);
208a297a907SKarl Rupp   if (opt) petsc_logActions = PETSC_FALSE;
209c5929fdfSBarry Smith   ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_objects", &opt);CHKERRQ(ierr);
210a297a907SKarl Rupp   if (opt) petsc_logObjects = PETSC_FALSE;
2115c6c1daeSBarry Smith   if (petsc_logActions) {
212785e854fSJed Brown     ierr = PetscMalloc1(petsc_maxActions, &petsc_actions);CHKERRQ(ierr);
2135c6c1daeSBarry Smith   }
2145c6c1daeSBarry Smith   if (petsc_logObjects) {
215785e854fSJed Brown     ierr = PetscMalloc1(petsc_maxObjects, &petsc_objects);CHKERRQ(ierr);
2165c6c1daeSBarry Smith   }
2175c6c1daeSBarry Smith   PetscLogPHC = PetscLogObjCreateDefault;
2185c6c1daeSBarry Smith   PetscLogPHD = PetscLogObjDestroyDefault;
2195c6c1daeSBarry Smith   /* Setup default logging structures */
2205c6c1daeSBarry Smith   ierr = PetscStageLogCreate(&petsc_stageLog);CHKERRQ(ierr);
2215c6c1daeSBarry Smith   ierr = PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage);CHKERRQ(ierr);
2225c6c1daeSBarry Smith 
2235c6c1daeSBarry Smith   /* All processors sync here for more consistent logging */
2245c6c1daeSBarry Smith   ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
2258563dfccSBarry Smith   PetscTime(&petsc_BaseTime);
2265c6c1daeSBarry Smith   ierr = PetscLogStagePush(stage);CHKERRQ(ierr);
2275c6c1daeSBarry Smith   PetscFunctionReturn(0);
2285c6c1daeSBarry Smith }
2295c6c1daeSBarry Smith 
2305c6c1daeSBarry Smith /*@C
231bb1d7374SBarry Smith   PetscLogDefaultBegin - Turns on logging of objects and events. This logs flop
2325c6c1daeSBarry Smith   rates and object creation and should not slow programs down too much.
2335c6c1daeSBarry Smith   This routine may be called more than once.
2345c6c1daeSBarry Smith 
2355c6c1daeSBarry Smith   Logically Collective over PETSC_COMM_WORLD
2365c6c1daeSBarry Smith 
2375c6c1daeSBarry Smith   Options Database Keys:
238a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the
239a2553e36SBarry Smith                   screen (for code configured with --with-log=1 (which is the default))
2405c6c1daeSBarry Smith 
2415c6c1daeSBarry Smith   Usage:
2425c6c1daeSBarry Smith .vb
2435c6c1daeSBarry Smith       PetscInitialize(...);
244bb1d7374SBarry Smith       PetscLogDefaultBegin();
2455c6c1daeSBarry Smith        ... code ...
2465c6c1daeSBarry Smith       PetscLogView(viewer); or PetscLogDump();
2475c6c1daeSBarry Smith       PetscFinalize();
2485c6c1daeSBarry Smith .ve
2495c6c1daeSBarry Smith 
2505c6c1daeSBarry Smith   Notes:
2515c6c1daeSBarry Smith   PetscLogView(viewer) or PetscLogDump() actually cause the printing of
2525c6c1daeSBarry Smith   the logging information.
2535c6c1daeSBarry Smith 
2545c6c1daeSBarry Smith   Level: advanced
2555c6c1daeSBarry Smith 
2565c6c1daeSBarry Smith .keywords: log, begin
2575c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogTraceBegin()
2585c6c1daeSBarry Smith @*/
259bb1d7374SBarry Smith PetscErrorCode  PetscLogDefaultBegin(void)
2605c6c1daeSBarry Smith {
2615c6c1daeSBarry Smith   PetscErrorCode ierr;
2625c6c1daeSBarry Smith 
2635c6c1daeSBarry Smith   PetscFunctionBegin;
2645c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault);CHKERRQ(ierr);
2655c6c1daeSBarry Smith   PetscFunctionReturn(0);
2665c6c1daeSBarry Smith }
2675c6c1daeSBarry Smith 
2685c6c1daeSBarry Smith /*@C
2695c6c1daeSBarry Smith   PetscLogAllBegin - Turns on extensive logging of objects and events. Logs
2705c6c1daeSBarry Smith   all events. This creates large log files and slows the program down.
2715c6c1daeSBarry Smith 
2725c6c1daeSBarry Smith   Logically Collective on PETSC_COMM_WORLD
2735c6c1daeSBarry Smith 
2745c6c1daeSBarry Smith   Options Database Keys:
275a2553e36SBarry Smith . -log_all - Prints extensive log information
2765c6c1daeSBarry Smith 
2775c6c1daeSBarry Smith   Usage:
2785c6c1daeSBarry Smith .vb
2795c6c1daeSBarry Smith      PetscInitialize(...);
2805c6c1daeSBarry Smith      PetscLogAllBegin();
2815c6c1daeSBarry Smith      ... code ...
2825c6c1daeSBarry Smith      PetscLogDump(filename);
2835c6c1daeSBarry Smith      PetscFinalize();
2845c6c1daeSBarry Smith .ve
2855c6c1daeSBarry Smith 
2865c6c1daeSBarry Smith   Notes:
287bb1d7374SBarry Smith   A related routine is PetscLogDefaultBegin() (with the options key -log), which is
2885c6c1daeSBarry Smith   intended for production runs since it logs only flop rates and object
2895c6c1daeSBarry Smith   creation (and shouldn't significantly slow the programs).
2905c6c1daeSBarry Smith 
2915c6c1daeSBarry Smith   Level: advanced
2925c6c1daeSBarry Smith 
2935c6c1daeSBarry Smith .keywords: log, all, begin
294bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogTraceBegin()
2955c6c1daeSBarry Smith @*/
2965c6c1daeSBarry Smith PetscErrorCode  PetscLogAllBegin(void)
2975c6c1daeSBarry Smith {
2985c6c1daeSBarry Smith   PetscErrorCode ierr;
2995c6c1daeSBarry Smith 
3005c6c1daeSBarry Smith   PetscFunctionBegin;
3015c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete);CHKERRQ(ierr);
3025c6c1daeSBarry Smith   PetscFunctionReturn(0);
3035c6c1daeSBarry Smith }
3045c6c1daeSBarry Smith 
3055c6c1daeSBarry Smith /*@
3065c6c1daeSBarry Smith   PetscLogTraceBegin - Activates trace logging.  Every time a PETSc event
3075c6c1daeSBarry Smith   begins or ends, the event name is printed.
3085c6c1daeSBarry Smith 
3095c6c1daeSBarry Smith   Logically Collective on PETSC_COMM_WORLD
3105c6c1daeSBarry Smith 
3115c6c1daeSBarry Smith   Input Parameter:
3125c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout)
3135c6c1daeSBarry Smith 
3145c6c1daeSBarry Smith   Options Database Key:
3155c6c1daeSBarry Smith . -log_trace [filename] - Activates PetscLogTraceBegin()
3165c6c1daeSBarry Smith 
3175c6c1daeSBarry Smith   Notes:
3185c6c1daeSBarry Smith   PetscLogTraceBegin() prints the processor number, the execution time (sec),
3195c6c1daeSBarry Smith   then "Event begin:" or "Event end:" followed by the event name.
3205c6c1daeSBarry Smith 
3215c6c1daeSBarry Smith   PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful
3225c6c1daeSBarry Smith   to determine where a program is hanging without running in the
3235c6c1daeSBarry Smith   debugger.  Can be used in conjunction with the -info option.
3245c6c1daeSBarry Smith 
3255c6c1daeSBarry Smith   Level: intermediate
3265c6c1daeSBarry Smith 
327bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogDefaultBegin()
3285c6c1daeSBarry Smith @*/
3295c6c1daeSBarry Smith PetscErrorCode  PetscLogTraceBegin(FILE *file)
3305c6c1daeSBarry Smith {
3315c6c1daeSBarry Smith   PetscErrorCode ierr;
3325c6c1daeSBarry Smith 
3335c6c1daeSBarry Smith   PetscFunctionBegin;
3345c6c1daeSBarry Smith   petsc_tracefile = file;
335a297a907SKarl Rupp 
3365c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace);CHKERRQ(ierr);
3375c6c1daeSBarry Smith   PetscFunctionReturn(0);
3385c6c1daeSBarry Smith }
3395c6c1daeSBarry Smith 
3405c6c1daeSBarry Smith /*@
3415c6c1daeSBarry Smith   PetscLogActions - Determines whether actions are logged for the graphical viewer.
3425c6c1daeSBarry Smith 
3435c6c1daeSBarry Smith   Not Collective
3445c6c1daeSBarry Smith 
3455c6c1daeSBarry Smith   Input Parameter:
3465c6c1daeSBarry Smith . flag - PETSC_TRUE if actions are to be logged
3475c6c1daeSBarry Smith 
3485c6c1daeSBarry Smith   Level: intermediate
3495c6c1daeSBarry Smith 
3505c6c1daeSBarry Smith   Note: Logging of actions continues to consume more memory as the program
3515c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
3525c6c1daeSBarry Smith 
3535c6c1daeSBarry Smith   Options Database Keys:
3545c6c1daeSBarry Smith . -log_exclude_actions - Turns off actions logging
3555c6c1daeSBarry Smith 
3565c6c1daeSBarry Smith .keywords: log, stage, register
3575c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
3585c6c1daeSBarry Smith @*/
3595c6c1daeSBarry Smith PetscErrorCode  PetscLogActions(PetscBool flag)
3605c6c1daeSBarry Smith {
3615c6c1daeSBarry Smith   PetscFunctionBegin;
3625c6c1daeSBarry Smith   petsc_logActions = flag;
3635c6c1daeSBarry Smith   PetscFunctionReturn(0);
3645c6c1daeSBarry Smith }
3655c6c1daeSBarry Smith 
3665c6c1daeSBarry Smith /*@
3675c6c1daeSBarry Smith   PetscLogObjects - Determines whether objects are logged for the graphical viewer.
3685c6c1daeSBarry Smith 
3695c6c1daeSBarry Smith   Not Collective
3705c6c1daeSBarry Smith 
3715c6c1daeSBarry Smith   Input Parameter:
3725c6c1daeSBarry Smith . flag - PETSC_TRUE if objects are to be logged
3735c6c1daeSBarry Smith 
3745c6c1daeSBarry Smith   Level: intermediate
3755c6c1daeSBarry Smith 
3765c6c1daeSBarry Smith   Note: Logging of objects continues to consume more memory as the program
3775c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
3785c6c1daeSBarry Smith 
3795c6c1daeSBarry Smith   Options Database Keys:
3805c6c1daeSBarry Smith . -log_exclude_objects - Turns off objects logging
3815c6c1daeSBarry Smith 
3825c6c1daeSBarry Smith .keywords: log, stage, register
3835c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
3845c6c1daeSBarry Smith @*/
3855c6c1daeSBarry Smith PetscErrorCode  PetscLogObjects(PetscBool flag)
3865c6c1daeSBarry Smith {
3875c6c1daeSBarry Smith   PetscFunctionBegin;
3885c6c1daeSBarry Smith   petsc_logObjects = flag;
3895c6c1daeSBarry Smith   PetscFunctionReturn(0);
3905c6c1daeSBarry Smith }
3915c6c1daeSBarry Smith 
3925c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/
3935c6c1daeSBarry Smith /*@C
39474c0405dSRichard Tran Mills   PetscLogStageRegister - Attaches a character string name to a logging stage.
3955c6c1daeSBarry Smith 
3965c6c1daeSBarry Smith   Not Collective
3975c6c1daeSBarry Smith 
3985c6c1daeSBarry Smith   Input Parameter:
3995c6c1daeSBarry Smith . sname - The name to associate with that stage
4005c6c1daeSBarry Smith 
4015c6c1daeSBarry Smith   Output Parameter:
4025c6c1daeSBarry Smith . stage - The stage number
4035c6c1daeSBarry Smith 
4045c6c1daeSBarry Smith   Level: intermediate
4055c6c1daeSBarry Smith 
4065c6c1daeSBarry Smith .keywords: log, stage, register
4075c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
4085c6c1daeSBarry Smith @*/
4095c6c1daeSBarry Smith PetscErrorCode  PetscLogStageRegister(const char sname[],PetscLogStage *stage)
4105c6c1daeSBarry Smith {
4115c6c1daeSBarry Smith   PetscStageLog  stageLog;
4125c6c1daeSBarry Smith   PetscLogEvent  event;
4135c6c1daeSBarry Smith   PetscErrorCode ierr;
4145c6c1daeSBarry Smith 
4155c6c1daeSBarry Smith   PetscFunctionBegin;
4165c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
4175c6c1daeSBarry Smith   ierr = PetscStageLogRegister(stageLog, sname, stage);CHKERRQ(ierr);
4185c6c1daeSBarry Smith   /* Copy events already changed in the main stage, this sucks */
4193a88037aSBarry Smith   ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr);
4205c6c1daeSBarry Smith   for (event = 0; event < stageLog->eventLog->numEvents; event++) {
4213a88037aSBarry Smith     ierr = PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event],&stageLog->stageInfo[*stage].eventLog->eventInfo[event]);CHKERRQ(ierr);
4225c6c1daeSBarry Smith   }
4233a88037aSBarry Smith   ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
4245c6c1daeSBarry Smith   PetscFunctionReturn(0);
4255c6c1daeSBarry Smith }
4265c6c1daeSBarry Smith 
4275c6c1daeSBarry Smith /*@C
4285c6c1daeSBarry Smith   PetscLogStagePush - This function pushes a stage on the stack.
4295c6c1daeSBarry Smith 
4305c6c1daeSBarry Smith   Not Collective
4315c6c1daeSBarry Smith 
4325c6c1daeSBarry Smith   Input Parameter:
4335c6c1daeSBarry Smith . stage - The stage on which to log
4345c6c1daeSBarry Smith 
4355c6c1daeSBarry Smith   Usage:
4365c6c1daeSBarry Smith   If the option -log_sumary is used to run the program containing the
4375c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
4385c6c1daeSBarry Smith   PetscFinalize().
4395c6c1daeSBarry Smith .vb
4405c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
4415c6c1daeSBarry Smith       [stage 0 of code]
4425c6c1daeSBarry Smith       PetscLogStagePush(1);
4435c6c1daeSBarry Smith       [stage 1 of code]
4445c6c1daeSBarry Smith       PetscLogStagePop();
4455c6c1daeSBarry Smith       PetscBarrier(...);
4465c6c1daeSBarry Smith       [more stage 0 of code]
4475c6c1daeSBarry Smith       PetscFinalize();
4485c6c1daeSBarry Smith .ve
4495c6c1daeSBarry Smith 
4505c6c1daeSBarry Smith   Notes:
4515c6c1daeSBarry Smith   Use PetscLogStageRegister() to register a stage.
4525c6c1daeSBarry Smith 
4535c6c1daeSBarry Smith   Level: intermediate
4545c6c1daeSBarry Smith 
4555c6c1daeSBarry Smith .keywords: log, push, stage
4565c6c1daeSBarry Smith .seealso: PetscLogStagePop(), PetscLogStageRegister(), PetscBarrier()
4575c6c1daeSBarry Smith @*/
4585c6c1daeSBarry Smith PetscErrorCode  PetscLogStagePush(PetscLogStage stage)
4595c6c1daeSBarry Smith {
4605c6c1daeSBarry Smith   PetscStageLog  stageLog;
4615c6c1daeSBarry Smith   PetscErrorCode ierr;
4625c6c1daeSBarry Smith 
4635c6c1daeSBarry Smith   PetscFunctionBegin;
4645c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
4655c6c1daeSBarry Smith   ierr = PetscStageLogPush(stageLog, stage);CHKERRQ(ierr);
4665c6c1daeSBarry Smith   PetscFunctionReturn(0);
4675c6c1daeSBarry Smith }
4685c6c1daeSBarry Smith 
4695c6c1daeSBarry Smith /*@C
4705c6c1daeSBarry Smith   PetscLogStagePop - This function pops a stage from the stack.
4715c6c1daeSBarry Smith 
4725c6c1daeSBarry Smith   Not Collective
4735c6c1daeSBarry Smith 
4745c6c1daeSBarry Smith   Usage:
4755c6c1daeSBarry Smith   If the option -log_sumary is used to run the program containing the
4765c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
4775c6c1daeSBarry Smith   PetscFinalize().
4785c6c1daeSBarry Smith .vb
4795c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
4805c6c1daeSBarry Smith       [stage 0 of code]
4815c6c1daeSBarry Smith       PetscLogStagePush(1);
4825c6c1daeSBarry Smith       [stage 1 of code]
4835c6c1daeSBarry Smith       PetscLogStagePop();
4845c6c1daeSBarry Smith       PetscBarrier(...);
4855c6c1daeSBarry Smith       [more stage 0 of code]
4865c6c1daeSBarry Smith       PetscFinalize();
4875c6c1daeSBarry Smith .ve
4885c6c1daeSBarry Smith 
4895c6c1daeSBarry Smith   Notes:
4905c6c1daeSBarry Smith   Use PetscLogStageRegister() to register a stage.
4915c6c1daeSBarry Smith 
4925c6c1daeSBarry Smith   Level: intermediate
4935c6c1daeSBarry Smith 
4945c6c1daeSBarry Smith .keywords: log, pop, stage
4955c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStageRegister(), PetscBarrier()
4965c6c1daeSBarry Smith @*/
4975c6c1daeSBarry Smith PetscErrorCode  PetscLogStagePop(void)
4985c6c1daeSBarry Smith {
4995c6c1daeSBarry Smith   PetscStageLog  stageLog;
5005c6c1daeSBarry Smith   PetscErrorCode ierr;
5015c6c1daeSBarry Smith 
5025c6c1daeSBarry Smith   PetscFunctionBegin;
5035c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5045c6c1daeSBarry Smith   ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr);
5055c6c1daeSBarry Smith   PetscFunctionReturn(0);
5065c6c1daeSBarry Smith }
5075c6c1daeSBarry Smith 
5085c6c1daeSBarry Smith /*@
5095c6c1daeSBarry Smith   PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd().
5105c6c1daeSBarry Smith 
5115c6c1daeSBarry Smith   Not Collective
5125c6c1daeSBarry Smith 
5135c6c1daeSBarry Smith   Input Parameters:
5145c6c1daeSBarry Smith + stage    - The stage
5155c6c1daeSBarry Smith - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE)
5165c6c1daeSBarry Smith 
5175c6c1daeSBarry Smith   Level: intermediate
5185c6c1daeSBarry Smith 
5195c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
5205c6c1daeSBarry Smith @*/
5215c6c1daeSBarry Smith PetscErrorCode  PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive)
5225c6c1daeSBarry Smith {
5235c6c1daeSBarry Smith   PetscStageLog  stageLog;
5245c6c1daeSBarry Smith   PetscErrorCode ierr;
5255c6c1daeSBarry Smith 
5265c6c1daeSBarry Smith   PetscFunctionBegin;
5275c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5285c6c1daeSBarry Smith   ierr = PetscStageLogSetActive(stageLog, stage, isActive);CHKERRQ(ierr);
5295c6c1daeSBarry Smith   PetscFunctionReturn(0);
5305c6c1daeSBarry Smith }
5315c6c1daeSBarry Smith 
5325c6c1daeSBarry Smith /*@
5335c6c1daeSBarry Smith   PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd().
5345c6c1daeSBarry Smith 
5355c6c1daeSBarry Smith   Not Collective
5365c6c1daeSBarry Smith 
5375c6c1daeSBarry Smith   Input Parameter:
5385c6c1daeSBarry Smith . stage    - The stage
5395c6c1daeSBarry Smith 
5405c6c1daeSBarry Smith   Output Parameter:
5415c6c1daeSBarry Smith . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE)
5425c6c1daeSBarry Smith 
5435c6c1daeSBarry Smith   Level: intermediate
5445c6c1daeSBarry Smith 
5455c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
5465c6c1daeSBarry Smith @*/
5475c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetActive(PetscLogStage stage, PetscBool  *isActive)
5485c6c1daeSBarry Smith {
5495c6c1daeSBarry Smith   PetscStageLog  stageLog;
5505c6c1daeSBarry Smith   PetscErrorCode ierr;
5515c6c1daeSBarry Smith 
5525c6c1daeSBarry Smith   PetscFunctionBegin;
5535c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5545c6c1daeSBarry Smith   ierr = PetscStageLogGetActive(stageLog, stage, isActive);CHKERRQ(ierr);
5555c6c1daeSBarry Smith   PetscFunctionReturn(0);
5565c6c1daeSBarry Smith }
5575c6c1daeSBarry Smith 
5585c6c1daeSBarry Smith /*@
5595c6c1daeSBarry Smith   PetscLogStageSetVisible - Determines stage visibility in PetscLogView()
5605c6c1daeSBarry Smith 
5615c6c1daeSBarry Smith   Not Collective
5625c6c1daeSBarry Smith 
5635c6c1daeSBarry Smith   Input Parameters:
5645c6c1daeSBarry Smith + stage     - The stage
5655c6c1daeSBarry Smith - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE)
5665c6c1daeSBarry Smith 
5675c6c1daeSBarry Smith   Level: intermediate
5685c6c1daeSBarry Smith 
5695c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView()
5705c6c1daeSBarry Smith @*/
5715c6c1daeSBarry Smith PetscErrorCode  PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible)
5725c6c1daeSBarry Smith {
5735c6c1daeSBarry Smith   PetscStageLog  stageLog;
5745c6c1daeSBarry Smith   PetscErrorCode ierr;
5755c6c1daeSBarry Smith 
5765c6c1daeSBarry Smith   PetscFunctionBegin;
5775c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5785c6c1daeSBarry Smith   ierr = PetscStageLogSetVisible(stageLog, stage, isVisible);CHKERRQ(ierr);
5795c6c1daeSBarry Smith   PetscFunctionReturn(0);
5805c6c1daeSBarry Smith }
5815c6c1daeSBarry Smith 
5825c6c1daeSBarry Smith /*@
5835c6c1daeSBarry Smith   PetscLogStageGetVisible - Returns stage visibility in PetscLogView()
5845c6c1daeSBarry Smith 
5855c6c1daeSBarry Smith   Not Collective
5865c6c1daeSBarry Smith 
5875c6c1daeSBarry Smith   Input Parameter:
5885c6c1daeSBarry Smith . stage     - The stage
5895c6c1daeSBarry Smith 
5905c6c1daeSBarry Smith   Output Parameter:
5915c6c1daeSBarry Smith . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE)
5925c6c1daeSBarry Smith 
5935c6c1daeSBarry Smith   Level: intermediate
5945c6c1daeSBarry Smith 
5955c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView()
5965c6c1daeSBarry Smith @*/
5975c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetVisible(PetscLogStage stage, PetscBool  *isVisible)
5985c6c1daeSBarry Smith {
5995c6c1daeSBarry Smith   PetscStageLog  stageLog;
6005c6c1daeSBarry Smith   PetscErrorCode ierr;
6015c6c1daeSBarry Smith 
6025c6c1daeSBarry Smith   PetscFunctionBegin;
6035c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
6045c6c1daeSBarry Smith   ierr = PetscStageLogGetVisible(stageLog, stage, isVisible);CHKERRQ(ierr);
6055c6c1daeSBarry Smith   PetscFunctionReturn(0);
6065c6c1daeSBarry Smith }
6075c6c1daeSBarry Smith 
6085c6c1daeSBarry Smith /*@C
6095c6c1daeSBarry Smith   PetscLogStageGetId - Returns the stage id when given the stage name.
6105c6c1daeSBarry Smith 
6115c6c1daeSBarry Smith   Not Collective
6125c6c1daeSBarry Smith 
6135c6c1daeSBarry Smith   Input Parameter:
6145c6c1daeSBarry Smith . name  - The stage name
6155c6c1daeSBarry Smith 
6165c6c1daeSBarry Smith   Output Parameter:
6175a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists
6185c6c1daeSBarry Smith 
6195c6c1daeSBarry Smith   Level: intermediate
6205c6c1daeSBarry Smith 
6215c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
6225c6c1daeSBarry Smith @*/
6235c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetId(const char name[], PetscLogStage *stage)
6245c6c1daeSBarry Smith {
6255c6c1daeSBarry Smith   PetscStageLog  stageLog;
6265c6c1daeSBarry Smith   PetscErrorCode ierr;
6275c6c1daeSBarry Smith 
6285c6c1daeSBarry Smith   PetscFunctionBegin;
6295c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
6305c6c1daeSBarry Smith   ierr = PetscStageLogGetStage(stageLog, name, stage);CHKERRQ(ierr);
6315c6c1daeSBarry Smith   PetscFunctionReturn(0);
6325c6c1daeSBarry Smith }
6335c6c1daeSBarry Smith 
6345c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/
6355c6c1daeSBarry Smith /*@C
6365c6c1daeSBarry Smith   PetscLogEventRegister - Registers an event name for logging operations in an application code.
6375c6c1daeSBarry Smith 
6385c6c1daeSBarry Smith   Not Collective
6395c6c1daeSBarry Smith 
6405c6c1daeSBarry Smith   Input Parameter:
6415c6c1daeSBarry Smith + name   - The name associated with the event
6425c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with
6435c6c1daeSBarry Smith            PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones
6445c6c1daeSBarry Smith            are only available in C code
6455c6c1daeSBarry Smith 
6465c6c1daeSBarry Smith   Output Parameter:
6475c6c1daeSBarry Smith . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd().
6485c6c1daeSBarry Smith 
6495c6c1daeSBarry Smith   Example of Usage:
6505c6c1daeSBarry Smith .vb
6515c6c1daeSBarry Smith       PetscLogEvent USER_EVENT;
6525c6c1daeSBarry Smith       PetscClassId classid;
6535c6c1daeSBarry Smith       PetscLogDouble user_event_flops;
6545c6c1daeSBarry Smith       PetscClassIdRegister("class name",&classid);
6555c6c1daeSBarry Smith       PetscLogEventRegister("User event name",classid,&USER_EVENT);
6565c6c1daeSBarry Smith       PetscLogEventBegin(USER_EVENT,0,0,0,0);
6575c6c1daeSBarry Smith          [code segment to monitor]
6585c6c1daeSBarry Smith          PetscLogFlops(user_event_flops);
6595c6c1daeSBarry Smith       PetscLogEventEnd(USER_EVENT,0,0,0,0);
6605c6c1daeSBarry Smith .ve
6615c6c1daeSBarry Smith 
6625c6c1daeSBarry Smith   Notes:
6635c6c1daeSBarry Smith   PETSc automatically logs library events if the code has been
664a2553e36SBarry Smith   configured with --with-log (which is the default) and
665a2553e36SBarry Smith   -log_view or -log_all is specified.  PetscLogEventRegister() is
6665c6c1daeSBarry Smith   intended for logging user events to supplement this PETSc
6675c6c1daeSBarry Smith   information.
6685c6c1daeSBarry Smith 
669495fc317SBarry Smith   PETSc can gather data for use with the utilities Jumpshot
6705c6c1daeSBarry Smith   (part of the MPICH distribution).  If PETSc has been compiled
6715c6c1daeSBarry Smith   with flag -DPETSC_HAVE_MPE (MPE is an additional utility within
6725c6c1daeSBarry Smith   MPICH), the user can employ another command line option, -log_mpe,
6735c6c1daeSBarry Smith   to create a logfile, "mpe.log", which can be visualized
674495fc317SBarry Smith   Jumpshot.
6755c6c1daeSBarry Smith 
6765c6c1daeSBarry Smith   The classid is associated with each event so that classes of events
6775c6c1daeSBarry Smith   can be disabled simultaneously, such as all matrix events. The user
6785c6c1daeSBarry Smith   can either use an existing classid, such as MAT_CLASSID, or create
6795c6c1daeSBarry Smith   their own as shown in the example.
6805c6c1daeSBarry Smith 
681c5deb1d5SJed Brown   If an existing event with the same name exists, its event handle is
682c5deb1d5SJed Brown   returned instead of creating a new event.
683c5deb1d5SJed Brown 
6845c6c1daeSBarry Smith   Level: intermediate
6855c6c1daeSBarry Smith 
6865c6c1daeSBarry Smith .keywords: log, event, register
6875c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogFlops(),
6885c6c1daeSBarry Smith           PetscLogEventActivate(), PetscLogEventDeactivate(), PetscClassIdRegister()
6895c6c1daeSBarry Smith @*/
6905c6c1daeSBarry Smith PetscErrorCode  PetscLogEventRegister(const char name[],PetscClassId classid,PetscLogEvent *event)
6915c6c1daeSBarry Smith {
6925c6c1daeSBarry Smith   PetscStageLog  stageLog;
6935c6c1daeSBarry Smith   int            stage;
6945c6c1daeSBarry Smith   PetscErrorCode ierr;
6955c6c1daeSBarry Smith 
6965c6c1daeSBarry Smith   PetscFunctionBegin;
6975c6c1daeSBarry Smith   *event = PETSC_DECIDE;
6985c6c1daeSBarry Smith   ierr   = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
6993a88037aSBarry Smith   ierr   = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr);
700c5deb1d5SJed Brown   if (*event > 0) PetscFunctionReturn(0);
7013a88037aSBarry Smith   ierr   = PetscEventRegLogRegister(stageLog->eventLog, name, classid, event);CHKERRQ(ierr);
7025c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
7033a88037aSBarry Smith     ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr);
7043a88037aSBarry Smith     ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
7055c6c1daeSBarry Smith   }
7065c6c1daeSBarry Smith   PetscFunctionReturn(0);
7075c6c1daeSBarry Smith }
7085c6c1daeSBarry Smith 
7095c6c1daeSBarry Smith /*@
7105c6c1daeSBarry Smith   PetscLogEventActivate - Indicates that a particular event should be logged.
7115c6c1daeSBarry Smith 
7125c6c1daeSBarry Smith   Not Collective
7135c6c1daeSBarry Smith 
7145c6c1daeSBarry Smith   Input Parameter:
7155c6c1daeSBarry Smith . event - The event id
7165c6c1daeSBarry Smith 
7175c6c1daeSBarry Smith   Usage:
7185c6c1daeSBarry Smith .vb
7195c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
7205c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
7215c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
7225c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
7235c6c1daeSBarry Smith .ve
7245c6c1daeSBarry Smith 
7255c6c1daeSBarry Smith   Note:
7265c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in include/petsclog.h)
7275c6c1daeSBarry Smith   or an event number obtained with PetscLogEventRegister().
7285c6c1daeSBarry Smith 
7295c6c1daeSBarry Smith   Level: advanced
7305c6c1daeSBarry Smith 
7315c6c1daeSBarry Smith .keywords: log, event, activate
732ec303c53SPatrick Sanan .seealso: PlogEventDeactivate()
7335c6c1daeSBarry Smith @*/
7345c6c1daeSBarry Smith PetscErrorCode  PetscLogEventActivate(PetscLogEvent event)
7355c6c1daeSBarry Smith {
7365c6c1daeSBarry Smith   PetscStageLog  stageLog;
7375c6c1daeSBarry Smith   int            stage;
7385c6c1daeSBarry Smith   PetscErrorCode ierr;
7395c6c1daeSBarry Smith 
7405c6c1daeSBarry Smith   PetscFunctionBegin;
7415c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
7425c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
7433a88037aSBarry Smith   ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
7445c6c1daeSBarry Smith   PetscFunctionReturn(0);
7455c6c1daeSBarry Smith }
7465c6c1daeSBarry Smith 
7475c6c1daeSBarry Smith /*@
7485c6c1daeSBarry Smith   PetscLogEventDeactivate - Indicates that a particular event should not be logged.
7495c6c1daeSBarry Smith 
7505c6c1daeSBarry Smith   Not Collective
7515c6c1daeSBarry Smith 
7525c6c1daeSBarry Smith   Input Parameter:
7535c6c1daeSBarry Smith . event - The event id
7545c6c1daeSBarry Smith 
7555c6c1daeSBarry Smith   Usage:
7565c6c1daeSBarry Smith .vb
7575c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
7585c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
7595c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
7605c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
7615c6c1daeSBarry Smith .ve
7625c6c1daeSBarry Smith 
7635c6c1daeSBarry Smith   Note:
7645c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in
7655c6c1daeSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
7665c6c1daeSBarry Smith 
7675c6c1daeSBarry Smith   Level: advanced
7685c6c1daeSBarry Smith 
7695c6c1daeSBarry Smith .keywords: log, event, deactivate
770ec303c53SPatrick Sanan .seealso: PlogEventActivate()
7715c6c1daeSBarry Smith @*/
7725c6c1daeSBarry Smith PetscErrorCode  PetscLogEventDeactivate(PetscLogEvent event)
7735c6c1daeSBarry Smith {
7745c6c1daeSBarry Smith   PetscStageLog  stageLog;
7755c6c1daeSBarry Smith   int            stage;
7765c6c1daeSBarry Smith   PetscErrorCode ierr;
7775c6c1daeSBarry Smith 
7785c6c1daeSBarry Smith   PetscFunctionBegin;
7795c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
7805c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
7813a88037aSBarry Smith   ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
7825c6c1daeSBarry Smith   PetscFunctionReturn(0);
7835c6c1daeSBarry Smith }
7845c6c1daeSBarry Smith 
7855c6c1daeSBarry Smith /*@
7865c6c1daeSBarry Smith   PetscLogEventSetActiveAll - Sets the event activity in every stage.
7875c6c1daeSBarry Smith 
7885c6c1daeSBarry Smith   Not Collective
7895c6c1daeSBarry Smith 
7905c6c1daeSBarry Smith   Input Parameters:
7915c6c1daeSBarry Smith + event    - The event id
7925c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged
7935c6c1daeSBarry Smith 
7945c6c1daeSBarry Smith   Level: advanced
7955c6c1daeSBarry Smith 
7965c6c1daeSBarry Smith .keywords: log, event, activate
797ec303c53SPatrick Sanan .seealso: PlogEventActivate(),PlogEventDeactivate()
7985c6c1daeSBarry Smith @*/
7995c6c1daeSBarry Smith PetscErrorCode  PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive)
8005c6c1daeSBarry Smith {
8015c6c1daeSBarry Smith   PetscStageLog  stageLog;
8025c6c1daeSBarry Smith   int            stage;
8035c6c1daeSBarry Smith   PetscErrorCode ierr;
8045c6c1daeSBarry Smith 
8055c6c1daeSBarry Smith   PetscFunctionBegin;
8065c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
8075c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
8085c6c1daeSBarry Smith     if (isActive) {
8093a88037aSBarry Smith       ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
8105c6c1daeSBarry Smith     } else {
8113a88037aSBarry Smith       ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
8125c6c1daeSBarry Smith     }
8135c6c1daeSBarry Smith   }
8145c6c1daeSBarry Smith   PetscFunctionReturn(0);
8155c6c1daeSBarry Smith }
8165c6c1daeSBarry Smith 
8175c6c1daeSBarry Smith /*@
8185c6c1daeSBarry Smith   PetscLogEventActivateClass - Activates event logging for a PETSc object class.
8195c6c1daeSBarry Smith 
8205c6c1daeSBarry Smith   Not Collective
8215c6c1daeSBarry Smith 
8225c6c1daeSBarry Smith   Input Parameter:
8235c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc.
8245c6c1daeSBarry Smith 
8255c6c1daeSBarry Smith   Level: developer
8265c6c1daeSBarry Smith 
8275c6c1daeSBarry Smith .keywords: log, event, activate, class
8285c6c1daeSBarry Smith .seealso: PetscInfoActivate(),PetscInfo(),PetscInfoAllow(),PetscLogEventDeactivateClass(), PetscLogEventActivate(),PetscLogEventDeactivate()
8295c6c1daeSBarry Smith @*/
8305c6c1daeSBarry Smith PetscErrorCode  PetscLogEventActivateClass(PetscClassId classid)
8315c6c1daeSBarry Smith {
8325c6c1daeSBarry Smith   PetscStageLog  stageLog;
8335c6c1daeSBarry Smith   int            stage;
8345c6c1daeSBarry Smith   PetscErrorCode ierr;
8355c6c1daeSBarry Smith 
8365c6c1daeSBarry Smith   PetscFunctionBegin;
8375c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
8385c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
8393a88037aSBarry Smith   ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
8405c6c1daeSBarry Smith   PetscFunctionReturn(0);
8415c6c1daeSBarry Smith }
8425c6c1daeSBarry Smith 
8435c6c1daeSBarry Smith /*@
8445c6c1daeSBarry Smith   PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class.
8455c6c1daeSBarry Smith 
8465c6c1daeSBarry Smith   Not Collective
8475c6c1daeSBarry Smith 
8485c6c1daeSBarry Smith   Input Parameter:
8495c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc.
8505c6c1daeSBarry Smith 
8515c6c1daeSBarry Smith   Level: developer
8525c6c1daeSBarry Smith 
8535c6c1daeSBarry Smith .keywords: log, event, deactivate, class
8545c6c1daeSBarry Smith .seealso: PetscInfoActivate(),PetscInfo(),PetscInfoAllow(),PetscLogEventActivateClass(), PetscLogEventActivate(),PetscLogEventDeactivate()
8555c6c1daeSBarry Smith @*/
8565c6c1daeSBarry Smith PetscErrorCode  PetscLogEventDeactivateClass(PetscClassId classid)
8575c6c1daeSBarry Smith {
8585c6c1daeSBarry Smith   PetscStageLog  stageLog;
8595c6c1daeSBarry Smith   int            stage;
8605c6c1daeSBarry Smith   PetscErrorCode ierr;
8615c6c1daeSBarry Smith 
8625c6c1daeSBarry Smith   PetscFunctionBegin;
8635c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
8645c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
8653a88037aSBarry Smith   ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
8665c6c1daeSBarry Smith   PetscFunctionReturn(0);
8675c6c1daeSBarry Smith }
8685c6c1daeSBarry Smith 
8695c6c1daeSBarry Smith /*MC
8705c6c1daeSBarry Smith    PetscLogEventBegin - Logs the beginning of a user event.
8715c6c1daeSBarry Smith 
8725c6c1daeSBarry Smith    Synopsis:
873aaa7dc30SBarry Smith    #include <petsclog.h>
874f2ba6396SBarry Smith    PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
8755c6c1daeSBarry Smith 
8765c6c1daeSBarry Smith    Not Collective
8775c6c1daeSBarry Smith 
8785c6c1daeSBarry Smith    Input Parameters:
8795c6c1daeSBarry Smith +  e - integer associated with the event obtained from PetscLogEventRegister()
8805c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
8815c6c1daeSBarry Smith 
8825c6c1daeSBarry Smith 
8835c6c1daeSBarry Smith    Fortran Synopsis:
8845c6c1daeSBarry Smith    void PetscLogEventBegin(int e,PetscErrorCode ierr)
8855c6c1daeSBarry Smith 
8865c6c1daeSBarry Smith    Usage:
8875c6c1daeSBarry Smith .vb
8885c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
8895c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
8905c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
8915c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
8925c6c1daeSBarry Smith         [code segment to monitor]
8935c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
8945c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
8955c6c1daeSBarry Smith .ve
8965c6c1daeSBarry Smith 
8975c6c1daeSBarry Smith    Notes:
8985c6c1daeSBarry Smith    You need to register each integer event with the command
899a2553e36SBarry Smith    PetscLogEventRegister().
9005c6c1daeSBarry Smith 
9015c6c1daeSBarry Smith    Level: intermediate
9025c6c1daeSBarry Smith 
9035c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops()
9045c6c1daeSBarry Smith 
9055c6c1daeSBarry Smith .keywords: log, event, begin
9065c6c1daeSBarry Smith M*/
9075c6c1daeSBarry Smith 
9085c6c1daeSBarry Smith /*MC
9095c6c1daeSBarry Smith    PetscLogEventEnd - Log the end of a user event.
9105c6c1daeSBarry Smith 
9115c6c1daeSBarry Smith    Synopsis:
912aaa7dc30SBarry Smith    #include <petsclog.h>
913f2ba6396SBarry Smith    PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
9145c6c1daeSBarry Smith 
9155c6c1daeSBarry Smith    Not Collective
9165c6c1daeSBarry Smith 
9175c6c1daeSBarry Smith    Input Parameters:
9185c6c1daeSBarry Smith +  e - integer associated with the event obtained with PetscLogEventRegister()
9195c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
9205c6c1daeSBarry Smith 
9215c6c1daeSBarry Smith 
9225c6c1daeSBarry Smith    Fortran Synopsis:
9235c6c1daeSBarry Smith    void PetscLogEventEnd(int e,PetscErrorCode ierr)
9245c6c1daeSBarry Smith 
9255c6c1daeSBarry Smith    Usage:
9265c6c1daeSBarry Smith .vb
9275c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
9285c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
9295c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT,);
9305c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
9315c6c1daeSBarry Smith         [code segment to monitor]
9325c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
9335c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
9345c6c1daeSBarry Smith .ve
9355c6c1daeSBarry Smith 
9365c6c1daeSBarry Smith    Notes:
9375c6c1daeSBarry Smith    You should also register each additional integer event with the command
938a2553e36SBarry Smith    PetscLogEventRegister().
9395c6c1daeSBarry Smith 
9405c6c1daeSBarry Smith    Level: intermediate
9415c6c1daeSBarry Smith 
9425c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogFlops()
9435c6c1daeSBarry Smith 
9445c6c1daeSBarry Smith .keywords: log, event, end
9455c6c1daeSBarry Smith M*/
9465c6c1daeSBarry Smith 
9475c6c1daeSBarry Smith /*MC
9485c6c1daeSBarry Smith    PetscLogEventBarrierBegin - Logs the time in a barrier before an event.
9495c6c1daeSBarry Smith 
9505c6c1daeSBarry Smith    Synopsis:
951aaa7dc30SBarry Smith    #include <petsclog.h>
952f2ba6396SBarry Smith    PetscErrorCode PetscLogEventBarrierBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4,MPI_Comm comm)
9535c6c1daeSBarry Smith 
9545c6c1daeSBarry Smith    Not Collective
9555c6c1daeSBarry Smith 
9565c6c1daeSBarry Smith    Input Parameters:
9575c6c1daeSBarry Smith .  e - integer associated with the event obtained from PetscLogEventRegister()
9585c6c1daeSBarry Smith .  o1,o2,o3,o4 - objects associated with the event, or 0
9595c6c1daeSBarry Smith .  comm - communicator the barrier takes place over
9605c6c1daeSBarry Smith 
9615c6c1daeSBarry Smith 
9625c6c1daeSBarry Smith    Usage:
9635c6c1daeSBarry Smith .vb
9645c6c1daeSBarry Smith      PetscLogEventBarrierBegin(VEC_NormBarrier,0,0,0,0,comm);
965b2566f29SBarry Smith        MPIU_Allreduce()
9665c6c1daeSBarry Smith      PetscLogEventBarrierEnd(VEC_NormBarrier,0,0,0,0,comm);
9675c6c1daeSBarry Smith .ve
9685c6c1daeSBarry Smith 
9695c6c1daeSBarry Smith    Notes:
9705c6c1daeSBarry Smith    This is for logging the amount of time spent in a barrier for an event
9715c6c1daeSBarry Smith    that requires synchronization.
9725c6c1daeSBarry Smith 
9735c6c1daeSBarry Smith    Additional Notes:
9745c6c1daeSBarry Smith    Synchronization events always come in pairs; for example, VEC_NormBarrier and
9755c6c1daeSBarry Smith    VEC_NormComm = VEC_NormBarrier + 1
9765c6c1daeSBarry Smith 
9775c6c1daeSBarry Smith    Level: advanced
9785c6c1daeSBarry Smith 
9795c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops(), PetscLogEventBegin(),
9805c6c1daeSBarry Smith           PetscLogEventBarrierEnd()
9815c6c1daeSBarry Smith 
9825c6c1daeSBarry Smith .keywords: log, event, begin, barrier
9835c6c1daeSBarry Smith M*/
9845c6c1daeSBarry Smith 
9855c6c1daeSBarry Smith /*MC
9865c6c1daeSBarry Smith    PetscLogEventBarrierEnd - Logs the time in a barrier before an event.
9875c6c1daeSBarry Smith 
9885c6c1daeSBarry Smith    Synopsis:
989aaa7dc30SBarry Smith    #include <petsclog.h>
990f2ba6396SBarry Smith    PetscErrorCode PetscLogEventBarrierEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4,MPI_Comm comm)
9915c6c1daeSBarry Smith 
9925c6c1daeSBarry Smith    Logically Collective on MPI_Comm
9935c6c1daeSBarry Smith 
9945c6c1daeSBarry Smith    Input Parameters:
9955c6c1daeSBarry Smith .  e - integer associated with the event obtained from PetscLogEventRegister()
9965c6c1daeSBarry Smith .  o1,o2,o3,o4 - objects associated with the event, or 0
9975c6c1daeSBarry Smith .  comm - communicator the barrier takes place over
9985c6c1daeSBarry Smith 
9995c6c1daeSBarry Smith 
10005c6c1daeSBarry Smith     Usage:
10015c6c1daeSBarry Smith .vb
10025c6c1daeSBarry Smith      PetscLogEventBarrierBegin(VEC_NormBarrier,0,0,0,0,comm);
1003b2566f29SBarry Smith        MPIU_Allreduce()
10045c6c1daeSBarry Smith      PetscLogEventBarrierEnd(VEC_NormBarrier,0,0,0,0,comm);
10055c6c1daeSBarry Smith .ve
10065c6c1daeSBarry Smith 
10075c6c1daeSBarry Smith    Notes:
10085c6c1daeSBarry Smith    This is for logging the amount of time spent in a barrier for an event
10095c6c1daeSBarry Smith    that requires synchronization.
10105c6c1daeSBarry Smith 
10115c6c1daeSBarry Smith    Additional Notes:
10125c6c1daeSBarry Smith    Synchronization events always come in pairs; for example, VEC_NormBarrier and
10135c6c1daeSBarry Smith    VEC_NormComm = VEC_NormBarrier + 1
10145c6c1daeSBarry Smith 
10155c6c1daeSBarry Smith    Level: advanced
10165c6c1daeSBarry Smith 
10175c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops(), PetscLogEventBegin(),
10185c6c1daeSBarry Smith           PetscLogEventBarrierBegin()
10195c6c1daeSBarry Smith 
10205c6c1daeSBarry Smith .keywords: log, event, begin, barrier
10215c6c1daeSBarry Smith M*/
10225c6c1daeSBarry Smith 
10235c6c1daeSBarry Smith /*@C
10245c6c1daeSBarry Smith   PetscLogEventGetId - Returns the event id when given the event name.
10255c6c1daeSBarry Smith 
10265c6c1daeSBarry Smith   Not Collective
10275c6c1daeSBarry Smith 
10285c6c1daeSBarry Smith   Input Parameter:
10295c6c1daeSBarry Smith . name  - The event name
10305c6c1daeSBarry Smith 
10315c6c1daeSBarry Smith   Output Parameter:
1032c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists
10335c6c1daeSBarry Smith 
10345c6c1daeSBarry Smith   Level: intermediate
10355c6c1daeSBarry Smith 
10365c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStageGetId()
10375c6c1daeSBarry Smith @*/
10385c6c1daeSBarry Smith PetscErrorCode  PetscLogEventGetId(const char name[], PetscLogEvent *event)
10395c6c1daeSBarry Smith {
10405c6c1daeSBarry Smith   PetscStageLog  stageLog;
10415c6c1daeSBarry Smith   PetscErrorCode ierr;
10425c6c1daeSBarry Smith 
10435c6c1daeSBarry Smith   PetscFunctionBegin;
10445c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
10453a88037aSBarry Smith   ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr);
10465c6c1daeSBarry Smith   PetscFunctionReturn(0);
10475c6c1daeSBarry Smith }
10485c6c1daeSBarry Smith 
10495c6c1daeSBarry Smith 
10505c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/
10515c6c1daeSBarry Smith /*@C
10525c6c1daeSBarry Smith   PetscLogDump - Dumps logs of objects to a file. This file is intended to
10535c6c1daeSBarry Smith   be read by bin/petscview. This program no longer exists.
10545c6c1daeSBarry Smith 
10555c6c1daeSBarry Smith   Collective on PETSC_COMM_WORLD
10565c6c1daeSBarry Smith 
10575c6c1daeSBarry Smith   Input Parameter:
10585c6c1daeSBarry Smith . name - an optional file name
10595c6c1daeSBarry Smith 
10605c6c1daeSBarry Smith   Usage:
10615c6c1daeSBarry Smith .vb
10625c6c1daeSBarry Smith      PetscInitialize(...);
1063bb1d7374SBarry Smith      PetscLogDefaultBegin(); or PetscLogAllBegin();
10645c6c1daeSBarry Smith      ... code ...
10655c6c1daeSBarry Smith      PetscLogDump(filename);
10665c6c1daeSBarry Smith      PetscFinalize();
10675c6c1daeSBarry Smith .ve
10685c6c1daeSBarry Smith 
10695c6c1daeSBarry Smith   Notes:
10705c6c1daeSBarry Smith   The default file name is
10715c6c1daeSBarry Smith $    Log.<rank>
10725c6c1daeSBarry Smith   where <rank> is the processor number. If no name is specified,
10735c6c1daeSBarry Smith   this file will be used.
10745c6c1daeSBarry Smith 
10755c6c1daeSBarry Smith   Level: advanced
10765c6c1daeSBarry Smith 
10775c6c1daeSBarry Smith .keywords: log, dump
1078bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogView()
10795c6c1daeSBarry Smith @*/
10805c6c1daeSBarry Smith PetscErrorCode  PetscLogDump(const char sname[])
10815c6c1daeSBarry Smith {
10825c6c1daeSBarry Smith   PetscStageLog      stageLog;
10835c6c1daeSBarry Smith   PetscEventPerfInfo *eventInfo;
10845c6c1daeSBarry Smith   FILE               *fd;
10855c6c1daeSBarry Smith   char               file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN];
10865c6c1daeSBarry Smith   PetscLogDouble     flops, _TotalTime;
10875c6c1daeSBarry Smith   PetscMPIInt        rank;
10885c6c1daeSBarry Smith   int                action, object, curStage;
10895c6c1daeSBarry Smith   PetscLogEvent      event;
10905c6c1daeSBarry Smith   PetscErrorCode     ierr;
10915c6c1daeSBarry Smith 
10925c6c1daeSBarry Smith   PetscFunctionBegin;
10935c6c1daeSBarry Smith   /* Calculate the total elapsed time */
10948563dfccSBarry Smith   PetscTime(&_TotalTime);
10955c6c1daeSBarry Smith   _TotalTime -= petsc_BaseTime;
10965c6c1daeSBarry Smith   /* Open log file */
10975c6c1daeSBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank);CHKERRQ(ierr);
1098a297a907SKarl Rupp   if (sname) sprintf(file, "%s.%d", sname, rank);
1099a297a907SKarl Rupp   else sprintf(file, "Log.%d", rank);
11005c6c1daeSBarry Smith   ierr = PetscFixFilename(file, fname);CHKERRQ(ierr);
11015c6c1daeSBarry Smith   ierr = PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd);CHKERRQ(ierr);
11025c6c1daeSBarry Smith   if ((!rank) && (!fd)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname);
11035c6c1daeSBarry Smith   /* Output totals */
1104d4aa7d5fSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime);CHKERRQ(ierr);
1105a2ea699eSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0);CHKERRQ(ierr);
11065c6c1daeSBarry Smith   /* Output actions */
11075c6c1daeSBarry Smith   if (petsc_logActions) {
1108a2ea699eSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions);CHKERRQ(ierr);
11095c6c1daeSBarry Smith     for (action = 0; action < petsc_numActions; action++) {
11105c6c1daeSBarry Smith       ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n",
11115c6c1daeSBarry Smith                           petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1,
1112a2ea699eSBarry Smith                           petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem);CHKERRQ(ierr);
11135c6c1daeSBarry Smith     }
11145c6c1daeSBarry Smith   }
11155c6c1daeSBarry Smith   /* Output objects */
11165c6c1daeSBarry Smith   if (petsc_logObjects) {
1117a2ea699eSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed);CHKERRQ(ierr);
11185c6c1daeSBarry Smith     for (object = 0; object < petsc_numObjects; object++) {
1119a2ea699eSBarry Smith       ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int) petsc_objects[object].mem);CHKERRQ(ierr);
11205c6c1daeSBarry Smith       if (!petsc_objects[object].name[0]) {
1121a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd,"No Name\n");CHKERRQ(ierr);
11225c6c1daeSBarry Smith       } else {
1123a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name);CHKERRQ(ierr);
11245c6c1daeSBarry Smith       }
11255c6c1daeSBarry Smith       if (petsc_objects[object].info[0] != 0) {
1126a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n");CHKERRQ(ierr);
11275c6c1daeSBarry Smith       } else {
1128a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info);CHKERRQ(ierr);
11295c6c1daeSBarry Smith       }
11305c6c1daeSBarry Smith     }
11315c6c1daeSBarry Smith   }
11325c6c1daeSBarry Smith   /* Output events */
1133a2ea699eSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n");CHKERRQ(ierr);
11345c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
11355c6c1daeSBarry Smith   ierr = PetscIntStackTop(stageLog->stack, &curStage);CHKERRQ(ierr);
11365c6c1daeSBarry Smith   eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo;
11375c6c1daeSBarry Smith   for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) {
1138a297a907SKarl Rupp     if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops/eventInfo[event].time;
1139a297a907SKarl Rupp     else flops = 0.0;
11405c6c1daeSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count,
1141a2ea699eSBarry Smith                         eventInfo[event].flops, eventInfo[event].time, flops);CHKERRQ(ierr);
11425c6c1daeSBarry Smith   }
11435c6c1daeSBarry Smith   ierr = PetscFClose(PETSC_COMM_WORLD, fd);CHKERRQ(ierr);
11445c6c1daeSBarry Smith   PetscFunctionReturn(0);
11455c6c1daeSBarry Smith }
11465c6c1daeSBarry Smith 
1147f14045dbSBarry Smith /*
1148f14045dbSBarry Smith   PetscLogView_Detailed - Each process prints the times for its own events
1149f14045dbSBarry Smith 
1150f14045dbSBarry Smith */
1151f14045dbSBarry Smith PetscErrorCode  PetscLogView_Detailed(PetscViewer viewer)
1152f14045dbSBarry Smith {
11532d1ec343SBarry Smith   MPI_Comm           comm       = PetscObjectComm((PetscObject) viewer);
11542d1ec343SBarry Smith   PetscEventPerfInfo *eventInfo = NULL;
11552dff6485SMatthew G. Knepley   PetscLogDouble     locTotalTime, numRed, maxMem;
11562dff6485SMatthew G. Knepley   PetscStageLog      stageLog;
11572dff6485SMatthew G. Knepley   int                numStages,numEvents,stage,event;
11582dff6485SMatthew G. Knepley   PetscMPIInt        rank,size;
11592dff6485SMatthew G. Knepley   PetscErrorCode     ierr;
1160f14045dbSBarry Smith 
1161f14045dbSBarry Smith   PetscFunctionBegin;
11622d1ec343SBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
11632d1ec343SBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
11642dff6485SMatthew G. Knepley   /* Must preserve reduction count before we go on */
11652dff6485SMatthew G. Knepley   numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
11662d1ec343SBarry Smith   /* Get the total elapsed time */
11672d1ec343SBarry Smith   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
11689852e123SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"size   = %d\n",size);CHKERRQ(ierr);
11692d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"LocalTimes = {}\n");CHKERRQ(ierr);
1170d4aa7d5fSBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"LocalFlop = {}\n");CHKERRQ(ierr);
11712d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"LocalMessageLens = {}\n");CHKERRQ(ierr);
11722d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"LocalMessages = {}\n");CHKERRQ(ierr);
11732d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"LocalReductions = {}\n");CHKERRQ(ierr);
11742dff6485SMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer,"LocalObjects = {}\n");CHKERRQ(ierr);
11752dff6485SMatthew G. Knepley   ierr = PetscViewerASCIIPrintf(viewer,"LocalMemory = {}\n");CHKERRQ(ierr);
11762d1ec343SBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
1177b2566f29SBarry Smith   ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
11782d1ec343SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"Stages = {}\n");CHKERRQ(ierr);
11792d1ec343SBarry Smith   for (stage=0; stage<numStages; stage++) {
11802d1ec343SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr);
118161917356SPatrick Sanan     ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"summary\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr);
1182b2566f29SBarry Smith     ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
11832d1ec343SBarry Smith     for (event = 0; event < numEvents; event++) {
11842d1ec343SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"%s\"] = {}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name);CHKERRQ(ierr);
11852d1ec343SBarry Smith     }
11862d1ec343SBarry Smith   }
11871575c14dSBarry Smith   ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
11882d1ec343SBarry Smith   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalTimes[%d] = %g\n",rank,locTotalTime);CHKERRQ(ierr);
1189d4aa7d5fSBarry Smith   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalFlop[%d] = %g\n",rank,petsc_TotalFlops);CHKERRQ(ierr);
11902d1ec343SBarry Smith   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessageLens[%d] = %g\n",rank,(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len));CHKERRQ(ierr);
11912d1ec343SBarry Smith   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessages[%d] = %g\n",rank,(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct));CHKERRQ(ierr);
11922dff6485SMatthew G. Knepley   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalReductions[%d] = %g\n",rank,numRed);CHKERRQ(ierr);
1193ba67d37fSBarry Smith   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalObjects[%d] = %d\n",rank,petsc_numObjects);CHKERRQ(ierr);
11942dff6485SMatthew G. Knepley   ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr);
11952dff6485SMatthew G. Knepley   ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMemory[%d] = %g\n",rank,maxMem);CHKERRQ(ierr);
11962d1ec343SBarry Smith   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
11972d1ec343SBarry Smith   for (stage=0; stage<numStages; stage++) {
1198d4aa7d5fSBarry Smith     ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n",
11992dff6485SMatthew G. Knepley                                               stageLog->stageInfo[stage].name,rank,
12002dff6485SMatthew G. Knepley                                               stageLog->stageInfo[stage].perfInfo.time,stageLog->stageInfo[stage].perfInfo.numMessages,stageLog->stageInfo[stage].perfInfo.messageLength,
12012dff6485SMatthew G. Knepley                                               stageLog->stageInfo[stage].perfInfo.numReductions,stageLog->stageInfo[stage].perfInfo.flops);CHKERRQ(ierr);
1202b2566f29SBarry Smith     ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
12032d1ec343SBarry Smith     for (event = 0; event < numEvents; event++) {
12042d1ec343SBarry Smith       eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo;
1205d4aa7d5fSBarry Smith       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %D, \"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name,rank,
12062d1ec343SBarry Smith                                                 eventInfo[event].count, eventInfo[event].time,eventInfo[event].numMessages, eventInfo[event].messageLength,
12072d1ec343SBarry Smith                                                 eventInfo[event].numReductions,eventInfo[event].flops);CHKERRQ(ierr);
12082d1ec343SBarry Smith     }
12092d1ec343SBarry Smith   }
12102d1ec343SBarry Smith   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
12111575c14dSBarry Smith   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
1212f14045dbSBarry Smith   PetscFunctionReturn(0);
1213f14045dbSBarry Smith }
1214f14045dbSBarry Smith 
1215f4091ad2SBarry Smith static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm,FILE *fd)
1216f4091ad2SBarry Smith {
1217f4091ad2SBarry Smith #if defined(PETSC_USE_DEBUG)
1218f4091ad2SBarry Smith   PetscErrorCode ierr;
1219f4091ad2SBarry Smith 
1220f4091ad2SBarry Smith   PetscFunctionBegin;
1221f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr);
1222f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n");CHKERRQ(ierr);
1223f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1224f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                          WARNING!!!                    #\n");CHKERRQ(ierr);
1225f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1226f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   This code was compiled with a debugging option,      #\n");CHKERRQ(ierr);
1227f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   To get timing results run ./configure                #\n");CHKERRQ(ierr);
1228f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   using --with-debugging=no, the performance will      #\n");CHKERRQ(ierr);
1229f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   be generally two or three times faster.              #\n");CHKERRQ(ierr);
1230f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
1231f4091ad2SBarry Smith   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n\n\n");CHKERRQ(ierr);
1232f4091ad2SBarry Smith   PetscFunctionReturn(0);
1233f4091ad2SBarry Smith #else
1234f4091ad2SBarry Smith   return 0;
1235f4091ad2SBarry Smith #endif
1236f4091ad2SBarry Smith }
1237f4091ad2SBarry Smith 
1238f14045dbSBarry Smith PetscErrorCode  PetscLogView_Default(PetscViewer viewer)
12395c6c1daeSBarry Smith {
12405c6c1daeSBarry Smith   FILE               *fd;
12415c6c1daeSBarry Smith   PetscLogDouble     zero       = 0.0;
12425c6c1daeSBarry Smith   PetscStageLog      stageLog;
12430298fd71SBarry Smith   PetscStageInfo     *stageInfo = NULL;
12440298fd71SBarry Smith   PetscEventPerfInfo *eventInfo = NULL;
12455c6c1daeSBarry Smith   PetscClassPerfInfo *classInfo;
12465c6c1daeSBarry Smith   char               arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128];
12475c6c1daeSBarry Smith   const char         *name;
12485c6c1daeSBarry Smith   PetscLogDouble     locTotalTime, TotalTime, TotalFlops;
12495c6c1daeSBarry Smith   PetscLogDouble     numMessages, messageLength, avgMessLen, numReductions;
12505c6c1daeSBarry Smith   PetscLogDouble     stageTime, flops, flopr, mem, mess, messLen, red;
12515c6c1daeSBarry Smith   PetscLogDouble     fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed;
12525c6c1daeSBarry Smith   PetscLogDouble     fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed;
12535c6c1daeSBarry Smith   PetscLogDouble     min, max, tot, ratio, avg, x, y;
12545c6c1daeSBarry Smith   PetscLogDouble     minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratCt, totm, totml, totr;
12555c6c1daeSBarry Smith   PetscMPIInt        minCt, maxCt;
12565c6c1daeSBarry Smith   PetscMPIInt        size, rank;
12575c6c1daeSBarry Smith   PetscBool          *localStageUsed,    *stageUsed;
12585c6c1daeSBarry Smith   PetscBool          *localStageVisible, *stageVisible;
12595c6c1daeSBarry Smith   int                numStages, localNumEvents, numEvents;
126037b78d16SBarry Smith   int                stage, oclass;
12615c6c1daeSBarry Smith   PetscLogEvent      event;
12625c6c1daeSBarry Smith   PetscErrorCode     ierr;
12635c6c1daeSBarry Smith   char               version[256];
12645c6c1daeSBarry Smith   MPI_Comm           comm;
12655c6c1daeSBarry Smith 
12665c6c1daeSBarry Smith   PetscFunctionBegin;
12675c6c1daeSBarry Smith   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
12685c6c1daeSBarry Smith   ierr = PetscViewerASCIIGetPointer(viewer,&fd);CHKERRQ(ierr);
12695c6c1daeSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
12705c6c1daeSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
12715c6c1daeSBarry Smith   /* Get the total elapsed time */
12728563dfccSBarry Smith   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
12735c6c1daeSBarry Smith 
12745c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr);
12755c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "***             WIDEN YOUR WINDOW TO 120 CHARACTERS.  Use 'enscript -r -fCourier9' to print this document            ***\n");CHKERRQ(ierr);
12765c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr);
12775c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n---------------------------------------------- PETSc Performance Summary: ----------------------------------------------\n\n");CHKERRQ(ierr);
1278f4091ad2SBarry Smith   ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr);
12795c6c1daeSBarry Smith   ierr = PetscGetArchType(arch,sizeof(arch));CHKERRQ(ierr);
12805c6c1daeSBarry Smith   ierr = PetscGetHostName(hostname,sizeof(hostname));CHKERRQ(ierr);
12815c6c1daeSBarry Smith   ierr = PetscGetUserName(username,sizeof(username));CHKERRQ(ierr);
12825c6c1daeSBarry Smith   ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr);
12835c6c1daeSBarry Smith   ierr = PetscGetDate(date,sizeof(date));CHKERRQ(ierr);
12845c6c1daeSBarry Smith   ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
12855c6c1daeSBarry Smith   if (size == 1) {
12865c6c1daeSBarry 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);
12875c6c1daeSBarry Smith   } else {
12885c6c1daeSBarry 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);
12895c6c1daeSBarry Smith   }
12905c6c1daeSBarry Smith 
12915c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Using %s\n", version);CHKERRQ(ierr);
12925c6c1daeSBarry Smith 
12935c6c1daeSBarry Smith   /* Must preserve reduction count before we go on */
12945c6c1daeSBarry Smith   red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
12955c6c1daeSBarry Smith 
12965c6c1daeSBarry Smith   /* Calculate summary information */
12975c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n                         Max       Max/Min        Avg      Total \n");CHKERRQ(ierr);
12985c6c1daeSBarry Smith   /*   Time */
1299b2566f29SBarry Smith   ierr = MPIU_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1300b2566f29SBarry Smith   ierr = MPIU_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1301b2566f29SBarry Smith   ierr = MPIU_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
13025c6c1daeSBarry Smith   avg  = (tot)/((PetscLogDouble) size);
1303a297a907SKarl Rupp   if (min != 0.0) ratio = max/min;
1304a297a907SKarl Rupp   else ratio = 0.0;
13055c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Time (sec):           %5.3e   %10.5f   %5.3e\n", max, ratio, avg);CHKERRQ(ierr);
13065c6c1daeSBarry Smith   TotalTime = tot;
13075c6c1daeSBarry Smith   /*   Objects */
13085c6c1daeSBarry Smith   avg  = (PetscLogDouble) petsc_numObjects;
1309b2566f29SBarry Smith   ierr = MPIU_Allreduce(&avg,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1310b2566f29SBarry Smith   ierr = MPIU_Allreduce(&avg,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1311b2566f29SBarry Smith   ierr = MPIU_Allreduce(&avg,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
13125c6c1daeSBarry Smith   avg  = (tot)/((PetscLogDouble) size);
1313a297a907SKarl Rupp   if (min != 0.0) ratio = max/min;
1314a297a907SKarl Rupp   else ratio = 0.0;
13155c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Objects:              %5.3e   %10.5f   %5.3e\n", max, ratio, avg);CHKERRQ(ierr);
13165c6c1daeSBarry Smith   /*   Flops */
1317b2566f29SBarry Smith   ierr = MPIU_Allreduce(&petsc_TotalFlops,  &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1318b2566f29SBarry Smith   ierr = MPIU_Allreduce(&petsc_TotalFlops,  &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1319b2566f29SBarry Smith   ierr = MPIU_Allreduce(&petsc_TotalFlops,  &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
13205c6c1daeSBarry Smith   avg  = (tot)/((PetscLogDouble) size);
1321a297a907SKarl Rupp   if (min != 0.0) ratio = max/min;
1322a297a907SKarl Rupp   else ratio = 0.0;
1323d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "Flop:                 %5.3e   %10.5f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
13245c6c1daeSBarry Smith   TotalFlops = tot;
13255c6c1daeSBarry Smith   /*   Flops/sec -- Must talk to Barry here */
1326a297a907SKarl Rupp   if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime;
1327a297a907SKarl Rupp   else flops = 0.0;
1328b2566f29SBarry Smith   ierr = MPIU_Allreduce(&flops,        &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1329b2566f29SBarry Smith   ierr = MPIU_Allreduce(&flops,        &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1330b2566f29SBarry Smith   ierr = MPIU_Allreduce(&flops,        &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
13315c6c1daeSBarry Smith   avg  = (tot)/((PetscLogDouble) size);
1332a297a907SKarl Rupp   if (min != 0.0) ratio = max/min;
1333a297a907SKarl Rupp   else ratio = 0.0;
1334d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "Flop/sec:            %5.3e   %10.5f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
13355c6c1daeSBarry Smith   /*   Memory */
13365c6c1daeSBarry Smith   ierr = PetscMallocGetMaximumUsage(&mem);CHKERRQ(ierr);
13375c6c1daeSBarry Smith   if (mem > 0.0) {
1338b2566f29SBarry Smith     ierr = MPIU_Allreduce(&mem,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1339b2566f29SBarry Smith     ierr = MPIU_Allreduce(&mem,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1340b2566f29SBarry Smith     ierr = MPIU_Allreduce(&mem,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
13415c6c1daeSBarry Smith     avg  = (tot)/((PetscLogDouble) size);
1342a297a907SKarl Rupp     if (min != 0.0) ratio = max/min;
1343a297a907SKarl Rupp     else ratio = 0.0;
13445c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "Memory:               %5.3e   %10.5f              %5.3e\n", max, ratio, tot);CHKERRQ(ierr);
13455c6c1daeSBarry Smith   }
13465c6c1daeSBarry Smith   /*   Messages */
13475c6c1daeSBarry Smith   mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct);
1348b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1349b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1350b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
13515c6c1daeSBarry Smith   avg  = (tot)/((PetscLogDouble) size);
1352a297a907SKarl Rupp   if (min != 0.0) ratio = max/min;
1353a297a907SKarl Rupp   else ratio = 0.0;
13545c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "MPI Messages:         %5.3e   %10.5f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
13555c6c1daeSBarry Smith   numMessages = tot;
13565c6c1daeSBarry Smith   /*   Message Lengths */
13575c6c1daeSBarry Smith   mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len);
1358b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1359b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1360b2566f29SBarry Smith   ierr = MPIU_Allreduce(&mess,         &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1361a297a907SKarl Rupp   if (numMessages != 0) avg = (tot)/(numMessages);
1362a297a907SKarl Rupp   else avg = 0.0;
1363a297a907SKarl Rupp   if (min != 0.0) ratio = max/min;
1364a297a907SKarl Rupp   else ratio = 0.0;
13655c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "MPI Message Lengths:  %5.3e   %10.5f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
13665c6c1daeSBarry Smith   messageLength = tot;
13675c6c1daeSBarry Smith   /*   Reductions */
1368b2566f29SBarry Smith   ierr = MPIU_Allreduce(&red,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
1369b2566f29SBarry Smith   ierr = MPIU_Allreduce(&red,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
1370b2566f29SBarry Smith   ierr = MPIU_Allreduce(&red,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1371a297a907SKarl Rupp   if (min != 0.0) ratio = max/min;
1372a297a907SKarl Rupp   else ratio = 0.0;
13735c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "MPI Reductions:       %5.3e   %10.5f\n", max, ratio);CHKERRQ(ierr);
13745c6c1daeSBarry Smith   numReductions = red; /* wrong because uses count from process zero */
13755c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n");CHKERRQ(ierr);
1376d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "                            e.g., VecAXPY() for real vectors of length N --> 2N flop\n");CHKERRQ(ierr);
1377d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "                            and VecAXPY() for complex vectors of length N --> 8N flop\n");CHKERRQ(ierr);
13785c6c1daeSBarry Smith 
13795c6c1daeSBarry Smith   /* Get total number of stages --
13805c6c1daeSBarry Smith        Currently, a single processor can register more stages than another, but stages must all be registered in order.
13815c6c1daeSBarry Smith        We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID.
13825c6c1daeSBarry Smith        This seems best accomplished by assoicating a communicator with each stage.
13835c6c1daeSBarry Smith   */
138437b78d16SBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
1385b2566f29SBarry Smith   ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
1386785e854fSJed Brown   ierr = PetscMalloc1(numStages, &localStageUsed);CHKERRQ(ierr);
1387785e854fSJed Brown   ierr = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr);
1388785e854fSJed Brown   ierr = PetscMalloc1(numStages, &localStageVisible);CHKERRQ(ierr);
1389785e854fSJed Brown   ierr = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr);
13905c6c1daeSBarry Smith   if (numStages > 0) {
13915c6c1daeSBarry Smith     stageInfo = stageLog->stageInfo;
13925c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
13935c6c1daeSBarry Smith       if (stage < stageLog->numStages) {
13945c6c1daeSBarry Smith         localStageUsed[stage]    = stageInfo[stage].used;
13955c6c1daeSBarry Smith         localStageVisible[stage] = stageInfo[stage].perfInfo.visible;
13965c6c1daeSBarry Smith       } else {
13975c6c1daeSBarry Smith         localStageUsed[stage]    = PETSC_FALSE;
13985c6c1daeSBarry Smith         localStageVisible[stage] = PETSC_TRUE;
13995c6c1daeSBarry Smith       }
14005c6c1daeSBarry Smith     }
1401b2566f29SBarry Smith     ierr = MPIU_Allreduce(localStageUsed,    stageUsed,    numStages, MPIU_BOOL, MPI_LOR,  comm);CHKERRQ(ierr);
1402b2566f29SBarry Smith     ierr = MPIU_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr);
14035c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
14045c6c1daeSBarry Smith       if (stageUsed[stage]) {
1405d4aa7d5fSBarry Smith         ierr = PetscFPrintf(comm, fd, "\nSummary of Stages:   ----- Time ------  ----- Flop -----  --- Messages ---  -- Message Lengths --  -- Reductions --\n");CHKERRQ(ierr);
14065c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd, "                        Avg     %%Total     Avg     %%Total   counts   %%Total     Avg         %%Total   counts   %%Total \n");CHKERRQ(ierr);
14075c6c1daeSBarry Smith         break;
14085c6c1daeSBarry Smith       }
14095c6c1daeSBarry Smith     }
14105c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
14115c6c1daeSBarry Smith       if (!stageUsed[stage]) continue;
141250a9567dSMatthew G. Knepley       /* CANNOT use MPIU_Allreduce() since it might fail the line number check */
14135c6c1daeSBarry Smith       if (localStageUsed[stage]) {
141450a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
141550a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
141650a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
141750a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
141850a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14195c6c1daeSBarry Smith         name = stageInfo[stage].name;
14205c6c1daeSBarry Smith       } else {
142150a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&zero,                           &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
142250a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&zero,                           &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
142350a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&zero,                           &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
142450a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&zero,                           &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
142550a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&zero,                           &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14265c6c1daeSBarry Smith         name = "";
14275c6c1daeSBarry Smith       }
14285c6c1daeSBarry Smith       mess *= 0.5; messLen *= 0.5; red /= size;
14295c6c1daeSBarry Smith       if (TotalTime     != 0.0) fracTime       = stageTime/TotalTime;    else fracTime       = 0.0;
14305c6c1daeSBarry Smith       if (TotalFlops    != 0.0) fracFlops      = flops/TotalFlops;       else fracFlops      = 0.0;
14315c6c1daeSBarry Smith       /* Talk to Barry if (stageTime     != 0.0) flops          = (size*flops)/stageTime; else flops          = 0.0; */
14325c6c1daeSBarry Smith       if (numMessages   != 0.0) fracMessages   = mess/numMessages;       else fracMessages   = 0.0;
1433e96a4d02SJunchao Zhang       if (mess          != 0.0) avgMessLen     = messLen/mess;           else avgMessLen     = 0.0;
14345c6c1daeSBarry Smith       if (messageLength != 0.0) fracLength     = messLen/messageLength;  else fracLength     = 0.0;
14355c6c1daeSBarry Smith       if (numReductions != 0.0) fracReductions = red/numReductions;      else fracReductions = 0.0;
14365c6c1daeSBarry 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",
14375c6c1daeSBarry Smith                           stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops,
14385c6c1daeSBarry Smith                           mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr);
14395c6c1daeSBarry Smith     }
14405c6c1daeSBarry Smith   }
14415c6c1daeSBarry Smith 
1442806fa848SBarry Smith   ierr = PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
14435c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n");CHKERRQ(ierr);
14445c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Phase summary info:\n");CHKERRQ(ierr);
14455c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Count: number of times phase was executed\n");CHKERRQ(ierr);
1446d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Time and Flop: Max - maximum over all processors\n");CHKERRQ(ierr);
14475c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "                   Ratio - ratio of maximum to minimum over all processors\n");CHKERRQ(ierr);
14485c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Mess: number of messages sent\n");CHKERRQ(ierr);
1449dac490bdSJed Brown   ierr = PetscFPrintf(comm, fd, "   Avg. len: average message length (bytes)\n");CHKERRQ(ierr);
14505c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Reduct: number of global reductions\n");CHKERRQ(ierr);
14515c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Global: entire computation\n");CHKERRQ(ierr);
14525c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n");CHKERRQ(ierr);
1453d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%T - percent time in this phase         %%F - percent flop in this phase\n");CHKERRQ(ierr);
14545c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%M - percent messages in this phase     %%L - percent message lengths in this phase\n");CHKERRQ(ierr);
14555c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%R - percent reductions in this phase\n");CHKERRQ(ierr);
1456d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n");CHKERRQ(ierr);
1457806fa848SBarry Smith   ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
14585c6c1daeSBarry Smith 
1459f4091ad2SBarry Smith   ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr);
14605c6c1daeSBarry Smith 
14615c6c1daeSBarry Smith   /* Report events */
1462d4aa7d5fSBarry Smith   ierr = PetscFPrintf(comm, fd,"Event                Count      Time (sec)     Flop                             --- Global ---  --- Stage ---   Total\n");CHKERRQ(ierr);
1463806fa848SBarry Smith   ierr = PetscFPrintf(comm, fd,"                   Max Ratio  Max     Ratio   Max  Ratio  Mess   Avg len Reduct  %%T %%F %%M %%L %%R  %%T %%F %%M %%L %%R Mflop/s\n");CHKERRQ(ierr);
1464806fa848SBarry Smith   ierr = PetscFPrintf(comm,fd,"------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
14655c6c1daeSBarry Smith 
14665c6c1daeSBarry Smith   /* Problem: The stage name will not show up unless the stage executed on proc 1 */
14675c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
14685c6c1daeSBarry Smith     if (!stageVisible[stage]) continue;
146950a9567dSMatthew G. Knepley     /* CANNOT use MPIU_Allreduce() since it might fail the line number check */
14705c6c1daeSBarry Smith     if (localStageUsed[stage]) {
14715c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr);
147250a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
147350a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
147450a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
147550a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
147650a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14775c6c1daeSBarry Smith     } else {
14785c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr);
147950a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&zero,                           &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
148050a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&zero,                           &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
148150a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&zero,                           &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
148250a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&zero,                           &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
148350a9567dSMatthew G. Knepley       ierr = MPI_Allreduce(&zero,                           &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14845c6c1daeSBarry Smith     }
14855c6c1daeSBarry Smith     mess *= 0.5; messLen *= 0.5; red /= size;
14865c6c1daeSBarry Smith 
14875c6c1daeSBarry Smith     /* Get total number of events in this stage --
14885c6c1daeSBarry Smith        Currently, a single processor can register more events than another, but events must all be registered in order,
14895c6c1daeSBarry Smith        just like stages. We can removed this requirement if necessary by having a global event numbering and indirection
14905c6c1daeSBarry Smith        on the event ID. This seems best accomplished by assoicating a communicator with each stage.
14915c6c1daeSBarry Smith 
14925c6c1daeSBarry Smith        Problem: If the event did not happen on proc 1, its name will not be available.
14935c6c1daeSBarry Smith        Problem: Event visibility is not implemented
14945c6c1daeSBarry Smith     */
14955c6c1daeSBarry Smith     if (localStageUsed[stage]) {
14965c6c1daeSBarry Smith       eventInfo      = stageLog->stageInfo[stage].eventLog->eventInfo;
14975c6c1daeSBarry Smith       localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents;
1498a297a907SKarl Rupp     } else localNumEvents = 0;
1499b2566f29SBarry Smith     ierr = MPIU_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
15005c6c1daeSBarry Smith     for (event = 0; event < numEvents; event++) {
150150a9567dSMatthew G. Knepley       /* CANNOT use MPIU_Allreduce() since it might fail the line number check */
15025c6c1daeSBarry Smith       if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) {
1503a297a907SKarl Rupp         if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops;
1504a297a907SKarl Rupp         else flopr = 0.0;
1505a297a907SKarl Rupp 
150650a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&flopr,                          &minf,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
150750a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&flopr,                          &maxf,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
150850a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].flops,         &totf,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
150950a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].time,          &mint,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
151050a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].time,          &maxt,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
151150a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].time,          &tott,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
151250a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].numMessages,   &totm,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
151350a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
151450a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].numReductions, &totr,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
151550a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].count,         &minCt, 1, MPI_INT,             MPI_MIN, comm);CHKERRQ(ierr);
151650a9567dSMatthew G. Knepley         ierr = MPI_Allreduce(&eventInfo[event].count,         &maxCt, 1, MPI_INT,             MPI_MAX, comm);CHKERRQ(ierr);
15175c6c1daeSBarry Smith         name = stageLog->eventLog->eventInfo[event].name;
15185c6c1daeSBarry Smith       } else {
15195c6c1daeSBarry Smith         flopr = 0.0;
152050a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&flopr,                          &minf,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
152150a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&flopr,                          &maxf,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
152250a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&zero,                           &totf,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
152350a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&zero,                           &mint,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
152450a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&zero,                           &maxt,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
152550a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&zero,                           &tott,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
152650a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&zero,                           &totm,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
152750a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&zero,                           &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
152850a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&zero,                           &totr,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
152950a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&ierr,                           &minCt, 1, MPI_INT,             MPI_MIN, comm);CHKERRQ(ierr);
153050a9567dSMatthew G. Knepley         ierr  = MPI_Allreduce(&ierr,                           &maxCt, 1, MPI_INT,             MPI_MAX, comm);CHKERRQ(ierr);
15315c6c1daeSBarry Smith         name  = "";
15325c6c1daeSBarry Smith       }
15335c6c1daeSBarry Smith       if (mint < 0.0) {
15345c6c1daeSBarry 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);
15355c6c1daeSBarry Smith         mint = 0;
15365c6c1daeSBarry Smith       }
1537d4aa7d5fSBarry 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);
15385c6c1daeSBarry Smith       totm *= 0.5; totml *= 0.5; totr /= size;
15395c6c1daeSBarry Smith 
15405c6c1daeSBarry Smith       if (maxCt != 0) {
15415c6c1daeSBarry Smith         if (minCt         != 0)   ratCt            = ((PetscLogDouble) maxCt)/minCt; else ratCt            = 0.0;
15425c6c1daeSBarry Smith         if (mint          != 0.0) ratt             = maxt/mint;                  else ratt             = 0.0;
15435c6c1daeSBarry Smith         if (minf          != 0.0) ratf             = maxf/minf;                  else ratf             = 0.0;
15445c6c1daeSBarry Smith         if (TotalTime     != 0.0) fracTime         = tott/TotalTime;             else fracTime         = 0.0;
15455c6c1daeSBarry Smith         if (TotalFlops    != 0.0) fracFlops        = totf/TotalFlops;            else fracFlops        = 0.0;
15465c6c1daeSBarry Smith         if (stageTime     != 0.0) fracStageTime    = tott/stageTime;             else fracStageTime    = 0.0;
15475c6c1daeSBarry Smith         if (flops         != 0.0) fracStageFlops   = totf/flops;                 else fracStageFlops   = 0.0;
15485c6c1daeSBarry Smith         if (numMessages   != 0.0) fracMess         = totm/numMessages;           else fracMess         = 0.0;
15495c6c1daeSBarry Smith         if (messageLength != 0.0) fracMessLen      = totml/messageLength;        else fracMessLen      = 0.0;
15505c6c1daeSBarry Smith         if (numReductions != 0.0) fracRed          = totr/numReductions;         else fracRed          = 0.0;
15515c6c1daeSBarry Smith         if (mess          != 0.0) fracStageMess    = totm/mess;                  else fracStageMess    = 0.0;
15525c6c1daeSBarry Smith         if (messLen       != 0.0) fracStageMessLen = totml/messLen;              else fracStageMessLen = 0.0;
15535c6c1daeSBarry Smith         if (red           != 0.0) fracStageRed     = totr/red;                   else fracStageRed     = 0.0;
15545c6c1daeSBarry Smith         if (totm          != 0.0) totml           /= totm;                       else totml            = 0.0;
15555c6c1daeSBarry Smith         if (maxt          != 0.0) flopr            = totf/maxt;                  else flopr            = 0.0;
1556411f5eb9SRichard 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);
15575c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd,
15585c6c1daeSBarry 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",
15595c6c1daeSBarry Smith                             name, maxCt, ratCt, maxt, ratt, maxf, ratf, totm, totml, totr,
15605c6c1daeSBarry Smith                             100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed,
15615c6c1daeSBarry Smith                             100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed,
1562c068d9bbSLisandro Dalcin                             PetscAbs(flopr)/1.0e6);CHKERRQ(ierr);
15635c6c1daeSBarry Smith       }
15645c6c1daeSBarry Smith     }
15655c6c1daeSBarry Smith   }
15665c6c1daeSBarry Smith 
15675c6c1daeSBarry Smith   /* Memory usage and object creation */
1568a297a907SKarl Rupp   ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
15695c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr);
15705c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n");CHKERRQ(ierr);
15715c6c1daeSBarry Smith 
15725c6c1daeSBarry Smith   /* Right now, only stages on the first processor are reported here, meaning only objects associated with
15735c6c1daeSBarry Smith      the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then
15745c6c1daeSBarry Smith      stats for stages local to processor sets.
15755c6c1daeSBarry Smith   */
15765c6c1daeSBarry Smith   /* We should figure out the longest object name here (now 20 characters) */
15775c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Object Type          Creations   Destructions     Memory  Descendants' Mem.\n");CHKERRQ(ierr);
15785c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Reports information only for process 0.\n");CHKERRQ(ierr);
15795c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
15805c6c1daeSBarry Smith     if (localStageUsed[stage]) {
15815c6c1daeSBarry Smith       classInfo = stageLog->stageInfo[stage].classLog->classInfo;
15825c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr);
15835c6c1daeSBarry Smith       for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) {
15845c6c1daeSBarry Smith         if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) {
15855c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "%20s %5d          %5d  %11.0f     %g\n", stageLog->classLog->classInfo[oclass].name,
15865c6c1daeSBarry Smith                               classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem,
15875c6c1daeSBarry Smith                               classInfo[oclass].descMem);CHKERRQ(ierr);
15885c6c1daeSBarry Smith         }
15895c6c1daeSBarry Smith       }
15905c6c1daeSBarry Smith     } else {
1591*cf019ec6SStefano Zampini       if (!localStageVisible[stage]) continue;
15925c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr);
15935c6c1daeSBarry Smith     }
15945c6c1daeSBarry Smith   }
15955c6c1daeSBarry Smith 
15965c6c1daeSBarry Smith   ierr = PetscFree(localStageUsed);CHKERRQ(ierr);
15975c6c1daeSBarry Smith   ierr = PetscFree(stageUsed);CHKERRQ(ierr);
15985c6c1daeSBarry Smith   ierr = PetscFree(localStageVisible);CHKERRQ(ierr);
15995c6c1daeSBarry Smith   ierr = PetscFree(stageVisible);CHKERRQ(ierr);
16005c6c1daeSBarry Smith 
16015c6c1daeSBarry Smith   /* Information unrelated to this particular run */
1602a297a907SKarl Rupp   ierr = PetscFPrintf(comm, fd, "========================================================================================================================\n");CHKERRQ(ierr);
16038563dfccSBarry Smith   PetscTime(&y);
16048563dfccSBarry Smith   PetscTime(&x);
16058563dfccSBarry Smith   PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y);
16068563dfccSBarry Smith   PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y);
16075c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0);CHKERRQ(ierr);
16085c6c1daeSBarry Smith   /* MPI information */
16095c6c1daeSBarry Smith   if (size > 1) {
16105c6c1daeSBarry Smith     MPI_Status  status;
16115c6c1daeSBarry Smith     PetscMPIInt tag;
16125c6c1daeSBarry Smith     MPI_Comm    newcomm;
16135c6c1daeSBarry Smith 
16145c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16158563dfccSBarry Smith     PetscTime(&x);
16165c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16175c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16185c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16195c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16205c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16218563dfccSBarry Smith     PetscTime(&y);
16225c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0);CHKERRQ(ierr);
16235c6c1daeSBarry Smith     ierr = PetscCommDuplicate(comm,&newcomm, &tag);CHKERRQ(ierr);
16245c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16255c6c1daeSBarry Smith     if (rank) {
16265c6c1daeSBarry Smith       ierr = MPI_Recv(0, 0, MPI_INT, rank-1,            tag, newcomm, &status);CHKERRQ(ierr);
16275c6c1daeSBarry Smith       ierr = MPI_Send(0, 0, MPI_INT, (rank+1)%size, tag, newcomm);CHKERRQ(ierr);
16285c6c1daeSBarry Smith     } else {
16298563dfccSBarry Smith       PetscTime(&x);
16305c6c1daeSBarry Smith       ierr = MPI_Send(0, 0, MPI_INT, 1,          tag, newcomm);CHKERRQ(ierr);
16315c6c1daeSBarry Smith       ierr = MPI_Recv(0, 0, MPI_INT, size-1, tag, newcomm, &status);CHKERRQ(ierr);
16328563dfccSBarry Smith       PetscTime(&y);
16335c6c1daeSBarry Smith       ierr = PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size);CHKERRQ(ierr);
16345c6c1daeSBarry Smith     }
16355c6c1daeSBarry Smith     ierr = PetscCommDestroy(&newcomm);CHKERRQ(ierr);
16365c6c1daeSBarry Smith   }
1637c5929fdfSBarry Smith   ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr);
16385c6c1daeSBarry Smith 
16395c6c1daeSBarry Smith   /* Machine and compile information */
16405c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS)
16415c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n");CHKERRQ(ierr);
16425c6c1daeSBarry Smith #else
16435c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n");CHKERRQ(ierr);
16445c6c1daeSBarry Smith #endif
16455c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
16465c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n");CHKERRQ(ierr);
16475f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128)
16485f27b2e0SBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n");CHKERRQ(ierr);
16495c6c1daeSBarry Smith #endif
16505c6c1daeSBarry Smith 
16515c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE)
16525c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with single precision matrices\n");CHKERRQ(ierr);
16535c6c1daeSBarry Smith #else
16545c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n");CHKERRQ(ierr);
16555c6c1daeSBarry Smith #endif
16565c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n",
16575c6c1daeSBarry Smith                       (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt));CHKERRQ(ierr);
16585c6c1daeSBarry Smith 
16595c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions);CHKERRQ(ierr);
16605c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petscmachineinfo);CHKERRQ(ierr);
16615c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsccompilerinfo);CHKERRQ(ierr);
16625c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo);CHKERRQ(ierr);
16635c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsclinkerinfo);CHKERRQ(ierr);
16645c6c1daeSBarry Smith 
16655c6c1daeSBarry Smith   /* Cleanup */
16665c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr);
1667f4091ad2SBarry Smith   ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr);
16685c6c1daeSBarry Smith   PetscFunctionReturn(0);
16695c6c1daeSBarry Smith }
16705c6c1daeSBarry Smith 
16717d6c928cSSatish Balay /*@C
16727d6c928cSSatish Balay   PetscLogView - Prints a summary of the logging.
16735c6c1daeSBarry Smith 
16745c6c1daeSBarry Smith   Collective over MPI_Comm
16755c6c1daeSBarry Smith 
16765c6c1daeSBarry Smith   Input Parameter:
1677f14045dbSBarry Smith .  viewer - an ASCII viewer
16785c6c1daeSBarry Smith 
16795c6c1daeSBarry Smith   Options Database Keys:
1680bb1d7374SBarry Smith +  -log_view [:filename] - Prints summary of log information
1681bb1d7374SBarry Smith .  -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file
1682607d249eSBarry 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)
1683bb1d7374SBarry Smith .  -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation
1684bb1d7374SBarry Smith -  -log_trace [filename] - Displays a trace of what each process is doing
16855c6c1daeSBarry Smith 
16865c6c1daeSBarry Smith   Notes:
1687bb1d7374SBarry Smith   It is possible to control the logging programatically but we recommend using the options database approach whenever possible
16885c6c1daeSBarry Smith   By default the summary is printed to stdout.
16895c6c1daeSBarry Smith 
1690bb1d7374SBarry Smith   Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin()
1691bb1d7374SBarry Smith 
1692bb1d7374SBarry Smith   If PETSc is configured with --with-logging=0 then this functionality is not available
1693bb1d7374SBarry Smith 
1694607d249eSBarry Smith   To view the nested XML format filename.xml first copy  ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current
1695607d249eSBarry Smith   directory then open filename.xml with your browser. Specific notes for certain browsers
1696607d249eSBarry Smith $    Firefox and Internet explorer - simply open the file
1697607d249eSBarry Smith $    Google Chrome - you must start up Chrome with the option --allow-file-access-from-files
1698607d249eSBarry Smith $    Safari - see http://ccm.net/faq/36342-safari-how-to-enable-local-file-access
1699607d249eSBarry 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
1700607d249eSBarry Smith   your browser.
1701607d249eSBarry Smith 
1702bb1d7374SBarry Smith   The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij  MARITIME  RESEARCH  INSTITUTE  NETHERLANDS
1703bb1d7374SBarry Smith 
17045c6c1daeSBarry Smith   Level: beginner
17055c6c1daeSBarry Smith 
17065c6c1daeSBarry Smith .keywords: log, dump, print
1707bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogDump()
17085c6c1daeSBarry Smith @*/
1709f14045dbSBarry Smith PetscErrorCode  PetscLogView(PetscViewer viewer)
17105c6c1daeSBarry Smith {
17115c6c1daeSBarry Smith   PetscErrorCode    ierr;
1712f14045dbSBarry Smith   PetscBool         isascii;
1713f14045dbSBarry Smith   PetscViewerFormat format;
171437b78d16SBarry Smith   int               stage, lastStage;
171537b78d16SBarry Smith   PetscStageLog     stageLog;
17165c6c1daeSBarry Smith 
17175c6c1daeSBarry Smith   PetscFunctionBegin;
1718609bdbeeSBarry Smith   if (!PetscLogPLB) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Must use -log_view or PetscLogDefaultBegin() before calling this routine");
171937b78d16SBarry Smith   /* Pop off any stages the user forgot to remove */
172037b78d16SBarry Smith   lastStage = 0;
172137b78d16SBarry Smith   ierr      = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
172237b78d16SBarry Smith   ierr      = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
172337b78d16SBarry Smith   while (stage >= 0) {
172437b78d16SBarry Smith     lastStage = stage;
172537b78d16SBarry Smith     ierr      = PetscStageLogPop(stageLog);CHKERRQ(ierr);
172637b78d16SBarry Smith     ierr      = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
172737b78d16SBarry Smith   }
1728f14045dbSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr);
1729f14045dbSBarry Smith   if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Currently can only view logging to ASCII");
1730f14045dbSBarry Smith   ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
1731f14045dbSBarry Smith   if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) {
1732f14045dbSBarry Smith     ierr = PetscLogView_Default(viewer);CHKERRQ(ierr);
1733f14045dbSBarry Smith   } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
1734f14045dbSBarry Smith     ierr = PetscLogView_Detailed(viewer);CHKERRQ(ierr);
1735bb1d7374SBarry Smith   } else if (format == PETSC_VIEWER_ASCII_XML) {
1736bb1d7374SBarry Smith     ierr = PetscLogView_Nested(viewer);CHKERRQ(ierr);
17375c6c1daeSBarry Smith   }
173837b78d16SBarry Smith   ierr = PetscStageLogPush(stageLog, lastStage);CHKERRQ(ierr);
17395c6c1daeSBarry Smith   PetscFunctionReturn(0);
17405c6c1daeSBarry Smith }
17415c6c1daeSBarry Smith 
1742f14045dbSBarry Smith /*@C
1743f14045dbSBarry Smith   PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed.
1744f14045dbSBarry Smith 
1745f14045dbSBarry Smith   Collective on PETSC_COMM_WORLD
1746f14045dbSBarry Smith 
1747f14045dbSBarry Smith   Not normally called by user
1748f14045dbSBarry Smith 
1749f14045dbSBarry Smith   Level: intermediate
1750f14045dbSBarry Smith 
1751f14045dbSBarry Smith @*/
1752f14045dbSBarry Smith PetscErrorCode PetscLogViewFromOptions(void)
1753f14045dbSBarry Smith {
1754f14045dbSBarry Smith   PetscErrorCode    ierr;
1755f14045dbSBarry Smith   PetscViewer       viewer;
1756f14045dbSBarry Smith   PetscBool         flg;
1757f14045dbSBarry Smith   PetscViewerFormat format;
1758f14045dbSBarry Smith 
1759f14045dbSBarry Smith   PetscFunctionBegin;
1760f14045dbSBarry Smith   ierr   = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,"-log_view",&viewer,&format,&flg);CHKERRQ(ierr);
1761f14045dbSBarry Smith   if (flg) {
1762f14045dbSBarry Smith     ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr);
1763f14045dbSBarry Smith     ierr = PetscLogView(viewer);CHKERRQ(ierr);
1764f14045dbSBarry Smith     ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
1765f14045dbSBarry Smith     ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
1766f14045dbSBarry Smith   }
1767f14045dbSBarry Smith   PetscFunctionReturn(0);
1768f14045dbSBarry Smith }
1769f14045dbSBarry Smith 
1770f14045dbSBarry Smith 
1771f14045dbSBarry Smith 
17725c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/
17735c6c1daeSBarry Smith /*@C
17745c6c1daeSBarry Smith    PetscGetFlops - Returns the number of flops used on this processor
17755c6c1daeSBarry Smith    since the program began.
17765c6c1daeSBarry Smith 
17775c6c1daeSBarry Smith    Not Collective
17785c6c1daeSBarry Smith 
17795c6c1daeSBarry Smith    Output Parameter:
17805c6c1daeSBarry Smith    flops - number of floating point operations
17815c6c1daeSBarry Smith 
17825c6c1daeSBarry Smith    Notes:
17835c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
17845c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
17855c6c1daeSBarry Smith    application code.
17865c6c1daeSBarry Smith 
17875c6c1daeSBarry Smith    Level: intermediate
17885c6c1daeSBarry Smith 
17895c6c1daeSBarry Smith .keywords: log, flops, floating point operations
17905c6c1daeSBarry Smith 
17918563dfccSBarry Smith .seealso: PetscTime(), PetscLogFlops()
17925c6c1daeSBarry Smith @*/
17935c6c1daeSBarry Smith PetscErrorCode  PetscGetFlops(PetscLogDouble *flops)
17945c6c1daeSBarry Smith {
17955c6c1daeSBarry Smith   PetscFunctionBegin;
17965c6c1daeSBarry Smith   *flops = petsc_TotalFlops;
17975c6c1daeSBarry Smith   PetscFunctionReturn(0);
17985c6c1daeSBarry Smith }
17995c6c1daeSBarry Smith 
18005c6c1daeSBarry Smith PetscErrorCode  PetscLogObjectState(PetscObject obj, const char format[], ...)
18015c6c1daeSBarry Smith {
18025c6c1daeSBarry Smith   PetscErrorCode ierr;
18035c6c1daeSBarry Smith   size_t         fullLength;
18045c6c1daeSBarry Smith   va_list        Argp;
18055c6c1daeSBarry Smith 
18065c6c1daeSBarry Smith   PetscFunctionBegin;
18075c6c1daeSBarry Smith   if (!petsc_logObjects) PetscFunctionReturn(0);
18085c6c1daeSBarry Smith   va_start(Argp, format);
18095c6c1daeSBarry Smith   ierr = PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp);CHKERRQ(ierr);
18105c6c1daeSBarry Smith   va_end(Argp);
18115c6c1daeSBarry Smith   PetscFunctionReturn(0);
18125c6c1daeSBarry Smith }
18135c6c1daeSBarry Smith 
18145c6c1daeSBarry Smith 
18155c6c1daeSBarry Smith /*MC
18165c6c1daeSBarry Smith    PetscLogFlops - Adds floating point operations to the global counter.
18175c6c1daeSBarry Smith 
18185c6c1daeSBarry Smith    Synopsis:
1819aaa7dc30SBarry Smith    #include <petsclog.h>
18205c6c1daeSBarry Smith    PetscErrorCode PetscLogFlops(PetscLogDouble f)
18215c6c1daeSBarry Smith 
18225c6c1daeSBarry Smith    Not Collective
18235c6c1daeSBarry Smith 
18245c6c1daeSBarry Smith    Input Parameter:
18255c6c1daeSBarry Smith .  f - flop counter
18265c6c1daeSBarry Smith 
18275c6c1daeSBarry Smith 
18285c6c1daeSBarry Smith    Usage:
18295c6c1daeSBarry Smith .vb
18305c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
18315c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
18325c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
18335c6c1daeSBarry Smith         [code segment to monitor]
18345c6c1daeSBarry Smith         PetscLogFlops(user_flops)
18355c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
18365c6c1daeSBarry Smith .ve
18375c6c1daeSBarry Smith 
18385c6c1daeSBarry Smith    Notes:
18395c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
18405c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
18415c6c1daeSBarry Smith    application code.
18425c6c1daeSBarry Smith 
18435c6c1daeSBarry Smith    Level: intermediate
18445c6c1daeSBarry Smith 
18455c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscGetFlops()
18465c6c1daeSBarry Smith 
18475c6c1daeSBarry Smith .keywords: log, flops, floating point operations
18485c6c1daeSBarry Smith M*/
18495c6c1daeSBarry Smith 
18505c6c1daeSBarry Smith /*MC
18515c6c1daeSBarry Smith    PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice)
18525c6c1daeSBarry Smith     to get accurate timings
18535c6c1daeSBarry Smith 
18545c6c1daeSBarry Smith    Synopsis:
1855aaa7dc30SBarry Smith    #include <petsclog.h>
18565c6c1daeSBarry Smith    void PetscPreLoadBegin(PetscBool  flag,char *name);
18575c6c1daeSBarry Smith 
18585c6c1daeSBarry Smith    Not Collective
18595c6c1daeSBarry Smith 
18605c6c1daeSBarry Smith    Input Parameter:
18615c6c1daeSBarry Smith +   flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden
18625c6c1daeSBarry Smith            with command line option -preload true or -preload false
1863609bdbeeSBarry Smith -   name - name of first stage (lines of code timed separately with -log_view) to
18645c6c1daeSBarry Smith            be preloaded
18655c6c1daeSBarry Smith 
18665c6c1daeSBarry Smith    Usage:
18675c6c1daeSBarry Smith .vb
18685c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
18695c6c1daeSBarry Smith        lines of code
18705c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
18715c6c1daeSBarry Smith        lines of code
18725c6c1daeSBarry Smith      PetscPreLoadEnd();
18735c6c1daeSBarry Smith .ve
18745c6c1daeSBarry Smith 
18755c6c1daeSBarry Smith    Notes: Only works in C/C++, not Fortran
18765c6c1daeSBarry Smith 
18775c6c1daeSBarry Smith      Flags available within the macro.
18785c6c1daeSBarry Smith +    PetscPreLoadingUsed - true if we are or have done preloading
18795c6c1daeSBarry Smith .    PetscPreLoadingOn - true if it is CURRENTLY doing preload
18805c6c1daeSBarry Smith .    PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second
18815c6c1daeSBarry Smith -    PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on
18825c6c1daeSBarry Smith      The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin()
18835c6c1daeSBarry Smith      and PetscPreLoadEnd()
18845c6c1daeSBarry Smith 
18855c6c1daeSBarry Smith    Level: intermediate
18865c6c1daeSBarry Smith 
18875c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage()
18885c6c1daeSBarry Smith 
18895c6c1daeSBarry Smith    Concepts: preloading
18905c6c1daeSBarry Smith    Concepts: timing^accurate
18915c6c1daeSBarry Smith    Concepts: paging^eliminating effects of
18925c6c1daeSBarry Smith 
18935c6c1daeSBarry Smith 
18945c6c1daeSBarry Smith M*/
18955c6c1daeSBarry Smith 
18965c6c1daeSBarry Smith /*MC
18975c6c1daeSBarry Smith    PetscPreLoadEnd - End a segment of code that may be preloaded (run twice)
18985c6c1daeSBarry Smith     to get accurate timings
18995c6c1daeSBarry Smith 
19005c6c1daeSBarry Smith    Synopsis:
1901aaa7dc30SBarry Smith    #include <petsclog.h>
19025c6c1daeSBarry Smith    void PetscPreLoadEnd(void);
19035c6c1daeSBarry Smith 
19045c6c1daeSBarry Smith    Not Collective
19055c6c1daeSBarry Smith 
19065c6c1daeSBarry Smith    Usage:
19075c6c1daeSBarry Smith .vb
19085c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
19095c6c1daeSBarry Smith        lines of code
19105c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
19115c6c1daeSBarry Smith        lines of code
19125c6c1daeSBarry Smith      PetscPreLoadEnd();
19135c6c1daeSBarry Smith .ve
19145c6c1daeSBarry Smith 
19155c6c1daeSBarry Smith    Notes: only works in C/C++ not fortran
19165c6c1daeSBarry Smith 
19175c6c1daeSBarry Smith    Level: intermediate
19185c6c1daeSBarry Smith 
19195c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadStage()
19205c6c1daeSBarry Smith 
19215c6c1daeSBarry Smith M*/
19225c6c1daeSBarry Smith 
19235c6c1daeSBarry Smith /*MC
19245c6c1daeSBarry Smith    PetscPreLoadStage - Start a new segment of code to be timed separately.
19255c6c1daeSBarry Smith     to get accurate timings
19265c6c1daeSBarry Smith 
19275c6c1daeSBarry Smith    Synopsis:
1928aaa7dc30SBarry Smith    #include <petsclog.h>
19295c6c1daeSBarry Smith    void PetscPreLoadStage(char *name);
19305c6c1daeSBarry Smith 
19315c6c1daeSBarry Smith    Not Collective
19325c6c1daeSBarry Smith 
19335c6c1daeSBarry Smith    Usage:
19345c6c1daeSBarry Smith .vb
19355c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
19365c6c1daeSBarry Smith        lines of code
19375c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
19385c6c1daeSBarry Smith        lines of code
19395c6c1daeSBarry Smith      PetscPreLoadEnd();
19405c6c1daeSBarry Smith .ve
19415c6c1daeSBarry Smith 
19425c6c1daeSBarry Smith    Notes: only works in C/C++ not fortran
19435c6c1daeSBarry Smith 
19445c6c1daeSBarry Smith    Level: intermediate
19455c6c1daeSBarry Smith 
19465c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd()
19475c6c1daeSBarry Smith 
19485c6c1daeSBarry Smith M*/
19495c6c1daeSBarry Smith 
19505c6c1daeSBarry Smith 
19515c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */
19525c6c1daeSBarry Smith 
19535c6c1daeSBarry Smith PetscErrorCode  PetscLogObjectState(PetscObject obj, const char format[], ...)
19545c6c1daeSBarry Smith {
19555c6c1daeSBarry Smith   PetscFunctionBegin;
19565c6c1daeSBarry Smith   PetscFunctionReturn(0);
19575c6c1daeSBarry Smith }
19585c6c1daeSBarry Smith 
19595c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/
19605c6c1daeSBarry Smith 
19615c6c1daeSBarry Smith 
19625c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID;
19635c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID  = 0;
19645c6c1daeSBarry Smith 
19655c6c1daeSBarry Smith /*@C
19665c6c1daeSBarry Smith   PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code.
19675c6c1daeSBarry Smith 
19685c6c1daeSBarry Smith   Not Collective
19695c6c1daeSBarry Smith 
19705c6c1daeSBarry Smith   Input Parameter:
19715c6c1daeSBarry Smith . name   - The class name
19725c6c1daeSBarry Smith 
19735c6c1daeSBarry Smith   Output Parameter:
19745c6c1daeSBarry Smith . oclass - The class id or classid
19755c6c1daeSBarry Smith 
19765c6c1daeSBarry Smith   Level: developer
19775c6c1daeSBarry Smith 
19785c6c1daeSBarry Smith .keywords: log, class, register
19795c6c1daeSBarry Smith 
19805c6c1daeSBarry Smith @*/
19815c6c1daeSBarry Smith PetscErrorCode  PetscClassIdRegister(const char name[],PetscClassId *oclass)
19825c6c1daeSBarry Smith {
19835c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
19845c6c1daeSBarry Smith   PetscStageLog  stageLog;
19855c6c1daeSBarry Smith   PetscInt       stage;
19865c6c1daeSBarry Smith   PetscErrorCode ierr;
19875c6c1daeSBarry Smith #endif
19885c6c1daeSBarry Smith 
19895c6c1daeSBarry Smith   PetscFunctionBegin;
19905c6c1daeSBarry Smith   *oclass = ++PETSC_LARGEST_CLASSID;
19915c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
19925c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
19935c6c1daeSBarry Smith   ierr = PetscClassRegLogRegister(stageLog->classLog, name, *oclass);CHKERRQ(ierr);
19945c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
19953a88037aSBarry Smith     ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
19965c6c1daeSBarry Smith   }
19975c6c1daeSBarry Smith #endif
19985c6c1daeSBarry Smith   PetscFunctionReturn(0);
19995c6c1daeSBarry Smith }
2000210b5426SBarry Smith 
2001210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE)
2002210b5426SBarry Smith #include <mpe.h>
2003210b5426SBarry Smith 
2004210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE;
2005210b5426SBarry Smith 
2006495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
2007495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
2008495fc317SBarry Smith 
2009210b5426SBarry Smith /*@C
2010210b5426SBarry Smith    PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files
2011210b5426SBarry Smith    and slows the program down.
2012210b5426SBarry Smith 
2013210b5426SBarry Smith    Collective over PETSC_COMM_WORLD
2014210b5426SBarry Smith 
2015210b5426SBarry Smith    Options Database Keys:
2016a2553e36SBarry Smith . -log_mpe - Prints extensive log information
2017210b5426SBarry Smith 
2018210b5426SBarry Smith    Notes:
2019609bdbeeSBarry Smith    A related routine is PetscLogDefaultBegin() (with the options key -log_view), which is
2020210b5426SBarry Smith    intended for production runs since it logs only flop rates and object
2021210b5426SBarry Smith    creation (and should not significantly slow the programs).
2022210b5426SBarry Smith 
2023210b5426SBarry Smith    Level: advanced
2024210b5426SBarry Smith 
2025210b5426SBarry Smith    Concepts: logging^MPE
2026210b5426SBarry Smith    Concepts: logging^message passing
2027210b5426SBarry Smith 
2028bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogEventActivate(),
2029210b5426SBarry Smith           PetscLogEventDeactivate()
2030210b5426SBarry Smith @*/
2031210b5426SBarry Smith PetscErrorCode  PetscLogMPEBegin(void)
2032210b5426SBarry Smith {
2033210b5426SBarry Smith   PetscErrorCode ierr;
2034210b5426SBarry Smith 
2035210b5426SBarry Smith   PetscFunctionBegin;
2036210b5426SBarry Smith   /* Do MPE initialization */
2037210b5426SBarry Smith   if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */
2038210b5426SBarry Smith     ierr = PetscInfo(0,"Initializing MPE.\n");CHKERRQ(ierr);
2039210b5426SBarry Smith     ierr = MPE_Init_log();CHKERRQ(ierr);
2040210b5426SBarry Smith 
2041210b5426SBarry Smith     PetscBeganMPE = PETSC_TRUE;
2042210b5426SBarry Smith   } else {
2043210b5426SBarry Smith     ierr = PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n");CHKERRQ(ierr);
2044210b5426SBarry Smith   }
2045495fc317SBarry Smith   ierr = PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE);CHKERRQ(ierr);
2046210b5426SBarry Smith   PetscFunctionReturn(0);
2047210b5426SBarry Smith }
2048210b5426SBarry Smith 
2049210b5426SBarry Smith /*@C
2050495fc317SBarry Smith    PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot.
2051210b5426SBarry Smith 
2052210b5426SBarry Smith    Collective over PETSC_COMM_WORLD
2053210b5426SBarry Smith 
2054210b5426SBarry Smith    Level: advanced
2055210b5426SBarry Smith 
2056210b5426SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogMPEBegin()
2057210b5426SBarry Smith @*/
2058210b5426SBarry Smith PetscErrorCode  PetscLogMPEDump(const char sname[])
2059210b5426SBarry Smith {
2060210b5426SBarry Smith   char           name[PETSC_MAX_PATH_LEN];
2061210b5426SBarry Smith   PetscErrorCode ierr;
2062210b5426SBarry Smith 
2063210b5426SBarry Smith   PetscFunctionBegin;
2064210b5426SBarry Smith   if (PetscBeganMPE) {
2065210b5426SBarry Smith     ierr = PetscInfo(0,"Finalizing MPE.\n");CHKERRQ(ierr);
2066210b5426SBarry Smith     if (sname) {
2067210b5426SBarry Smith       ierr = PetscStrcpy(name,sname);CHKERRQ(ierr);
2068210b5426SBarry Smith     } else {
2069210b5426SBarry Smith       ierr = PetscGetProgramName(name,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
2070210b5426SBarry Smith     }
2071210b5426SBarry Smith     ierr = MPE_Finish_log(name);CHKERRQ(ierr);
2072210b5426SBarry Smith   } else {
2073210b5426SBarry Smith     ierr = PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n");CHKERRQ(ierr);
2074210b5426SBarry Smith   }
2075210b5426SBarry Smith   PetscFunctionReturn(0);
2076210b5426SBarry Smith }
2077210b5426SBarry Smith 
2078210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39
2079210b5426SBarry Smith static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = {
2080210b5426SBarry Smith   "OliveDrab:      ",
2081210b5426SBarry Smith   "BlueViolet:     ",
2082210b5426SBarry Smith   "CadetBlue:      ",
2083210b5426SBarry Smith   "CornflowerBlue: ",
2084210b5426SBarry Smith   "DarkGoldenrod:  ",
2085210b5426SBarry Smith   "DarkGreen:      ",
2086210b5426SBarry Smith   "DarkKhaki:      ",
2087210b5426SBarry Smith   "DarkOliveGreen: ",
2088210b5426SBarry Smith   "DarkOrange:     ",
2089210b5426SBarry Smith   "DarkOrchid:     ",
2090210b5426SBarry Smith   "DarkSeaGreen:   ",
2091210b5426SBarry Smith   "DarkSlateGray:  ",
2092210b5426SBarry Smith   "DarkTurquoise:  ",
2093210b5426SBarry Smith   "DeepPink:       ",
2094210b5426SBarry Smith   "DarkKhaki:      ",
2095210b5426SBarry Smith   "DimGray:        ",
2096210b5426SBarry Smith   "DodgerBlue:     ",
2097210b5426SBarry Smith   "GreenYellow:    ",
2098210b5426SBarry Smith   "HotPink:        ",
2099210b5426SBarry Smith   "IndianRed:      ",
2100210b5426SBarry Smith   "LavenderBlush:  ",
2101210b5426SBarry Smith   "LawnGreen:      ",
2102210b5426SBarry Smith   "LemonChiffon:   ",
2103210b5426SBarry Smith   "LightCoral:     ",
2104210b5426SBarry Smith   "LightCyan:      ",
2105210b5426SBarry Smith   "LightPink:      ",
2106210b5426SBarry Smith   "LightSalmon:    ",
2107210b5426SBarry Smith   "LightSlateGray: ",
2108210b5426SBarry Smith   "LightYellow:    ",
2109210b5426SBarry Smith   "LimeGreen:      ",
2110210b5426SBarry Smith   "MediumPurple:   ",
2111210b5426SBarry Smith   "MediumSeaGreen: ",
2112210b5426SBarry Smith   "MediumSlateBlue:",
2113210b5426SBarry Smith   "MidnightBlue:   ",
2114210b5426SBarry Smith   "MintCream:      ",
2115210b5426SBarry Smith   "MistyRose:      ",
2116210b5426SBarry Smith   "NavajoWhite:    ",
2117210b5426SBarry Smith   "NavyBlue:       ",
2118210b5426SBarry Smith   "OliveDrab:      "
2119210b5426SBarry Smith };
2120210b5426SBarry Smith 
2121210b5426SBarry Smith /*@C
2122210b5426SBarry Smith   PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister()
2123210b5426SBarry Smith 
2124210b5426SBarry Smith   Not collective. Maybe it should be?
2125210b5426SBarry Smith 
2126210b5426SBarry Smith   Output Parameter
2127210b5426SBarry Smith . str - character string representing the color
2128210b5426SBarry Smith 
2129210b5426SBarry Smith   Level: developer
2130210b5426SBarry Smith 
2131210b5426SBarry Smith .keywords: log, mpe , color
2132210b5426SBarry Smith .seealso: PetscLogEventRegister
2133210b5426SBarry Smith @*/
2134210b5426SBarry Smith PetscErrorCode  PetscLogMPEGetRGBColor(const char *str[])
2135210b5426SBarry Smith {
2136210b5426SBarry Smith   static int idx = 0;
2137210b5426SBarry Smith 
2138210b5426SBarry Smith   PetscFunctionBegin;
2139210b5426SBarry Smith   *str = PetscLogMPERGBColors[idx];
2140210b5426SBarry Smith   idx  = (idx + 1)% PETSC_RGB_COLORS_MAX;
2141210b5426SBarry Smith   PetscFunctionReturn(0);
2142210b5426SBarry Smith }
2143210b5426SBarry Smith 
2144210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */
2145