xref: /petsc/src/sys/logging/plog.c (revision 785e854f82a3c614b452fca2cf5ad4f2afe8bdde)
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 */
11afcb2eb5SJed Brown #include <petsc-private/logimpl.h>        /*I    "petscsys.h"   I*/
125c6c1daeSBarry Smith #include <petsctime.h>
13665c2dedSJed Brown #include <petscviewer.h>
145c6c1daeSBarry Smith #include <petscthreadcomm.h>
155c6c1daeSBarry Smith 
163bb1ff40SBarry Smith PetscErrorCode PetscLogObjectParent(PetscObject p,PetscObject c)
173bb1ff40SBarry Smith {
1827b6d19dSBarry Smith   if (!c || !p) return 0;
193bb1ff40SBarry Smith   c->parent   = p;
203bb1ff40SBarry Smith   c->parentid = p->id;
213bb1ff40SBarry Smith   return 0;
223bb1ff40SBarry Smith }
233bb1ff40SBarry Smith 
243bb1ff40SBarry Smith PetscErrorCode PetscLogObjectMemory(PetscObject p,PetscLogDouble m)
253bb1ff40SBarry Smith {
2627b6d19dSBarry Smith   p->mem += m;
273bb1ff40SBarry Smith   return 0;
283bb1ff40SBarry Smith }
293bb1ff40SBarry Smith 
305c6c1daeSBarry Smith PetscLogEvent PETSC_LARGEST_EVENT = PETSC_EVENT;
315c6c1daeSBarry Smith 
325c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
335c6c1daeSBarry Smith #include <petscmachineinfo.h>
345c6c1daeSBarry Smith #include <petscconfiginfo.h>
355c6c1daeSBarry Smith 
365c6c1daeSBarry Smith /* used in the MPI_XXX() count macros in petsclog.h */
375c6c1daeSBarry Smith 
385c6c1daeSBarry Smith /* Action and object logging variables */
390298fd71SBarry Smith Action    *petsc_actions            = NULL;
400298fd71SBarry Smith Object    *petsc_objects            = NULL;
415c6c1daeSBarry Smith PetscBool petsc_logActions          = PETSC_FALSE;
425c6c1daeSBarry Smith PetscBool petsc_logObjects          = PETSC_FALSE;
435c6c1daeSBarry Smith int       petsc_numActions          = 0, petsc_maxActions = 100;
445c6c1daeSBarry Smith int       petsc_numObjects          = 0, petsc_maxObjects = 100;
455c6c1daeSBarry Smith int       petsc_numObjectsDestroyed = 0;
465c6c1daeSBarry Smith 
475c6c1daeSBarry Smith /* Global counters */
485c6c1daeSBarry Smith PetscLogDouble petsc_BaseTime        = 0.0;
495c6c1daeSBarry Smith PetscLogDouble petsc_TotalFlops      = 0.0;  /* The number of flops */
505c6c1daeSBarry Smith PetscLogDouble petsc_tmp_flops       = 0.0;  /* The incremental number of flops */
515c6c1daeSBarry Smith PetscLogDouble petsc_send_ct         = 0.0;  /* The number of sends */
525c6c1daeSBarry Smith PetscLogDouble petsc_recv_ct         = 0.0;  /* The number of receives */
535c6c1daeSBarry Smith PetscLogDouble petsc_send_len        = 0.0;  /* The total length of all sent messages */
545c6c1daeSBarry Smith PetscLogDouble petsc_recv_len        = 0.0;  /* The total length of all received messages */
555c6c1daeSBarry Smith PetscLogDouble petsc_isend_ct        = 0.0;  /* The number of immediate sends */
565c6c1daeSBarry Smith PetscLogDouble petsc_irecv_ct        = 0.0;  /* The number of immediate receives */
575c6c1daeSBarry Smith PetscLogDouble petsc_isend_len       = 0.0;  /* The total length of all immediate send messages */
585c6c1daeSBarry Smith PetscLogDouble petsc_irecv_len       = 0.0;  /* The total length of all immediate receive messages */
595c6c1daeSBarry Smith PetscLogDouble petsc_wait_ct         = 0.0;  /* The number of waits */
605c6c1daeSBarry Smith PetscLogDouble petsc_wait_any_ct     = 0.0;  /* The number of anywaits */
615c6c1daeSBarry Smith PetscLogDouble petsc_wait_all_ct     = 0.0;  /* The number of waitalls */
625c6c1daeSBarry Smith PetscLogDouble petsc_sum_of_waits_ct = 0.0;  /* The total number of waits */
635c6c1daeSBarry Smith PetscLogDouble petsc_allreduce_ct    = 0.0;  /* The number of reductions */
645c6c1daeSBarry Smith PetscLogDouble petsc_gather_ct       = 0.0;  /* The number of gathers and gathervs */
655c6c1daeSBarry Smith PetscLogDouble petsc_scatter_ct      = 0.0;  /* The number of scatters and scattervs */
665c6c1daeSBarry Smith 
675c6c1daeSBarry Smith /* Logging functions */
680298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL;
690298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL;
700298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL;
710298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL;
725c6c1daeSBarry Smith 
735c6c1daeSBarry Smith /* Tracing event logging variables */
740298fd71SBarry Smith FILE             *petsc_tracefile            = NULL;
755c6c1daeSBarry Smith int              petsc_tracelevel            = 0;
765c6c1daeSBarry Smith const char       *petsc_traceblanks          = "                                                                                                    ";
775c6c1daeSBarry Smith char             petsc_tracespace[128]       = " ";
785c6c1daeSBarry Smith PetscLogDouble   petsc_tracetime             = 0.0;
795c6c1daeSBarry Smith static PetscBool PetscLogBegin_PrivateCalled = PETSC_FALSE;
805c6c1daeSBarry Smith 
815c6c1daeSBarry Smith /*---------------------------------------------- General Functions --------------------------------------------------*/
825c6c1daeSBarry Smith #undef __FUNCT__
835c6c1daeSBarry Smith #define __FUNCT__ "PetscLogDestroy"
845c6c1daeSBarry Smith /*@C
855c6c1daeSBarry Smith   PetscLogDestroy - Destroys the object and event logging data and resets the global counters.
865c6c1daeSBarry Smith 
875c6c1daeSBarry Smith   Not Collective
885c6c1daeSBarry Smith 
895c6c1daeSBarry Smith   Notes:
905c6c1daeSBarry Smith   This routine should not usually be used by programmers. Instead employ
915c6c1daeSBarry Smith   PetscLogStagePush() and PetscLogStagePop().
925c6c1daeSBarry Smith 
935c6c1daeSBarry Smith   Level: developer
945c6c1daeSBarry Smith 
955c6c1daeSBarry Smith .keywords: log, destroy
965c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogStagePush(), PlogStagePop()
975c6c1daeSBarry Smith @*/
985c6c1daeSBarry Smith PetscErrorCode  PetscLogDestroy(void)
995c6c1daeSBarry Smith {
1005c6c1daeSBarry Smith   PetscStageLog  stageLog;
1015c6c1daeSBarry Smith   PetscErrorCode ierr;
1025c6c1daeSBarry Smith 
1035c6c1daeSBarry Smith   PetscFunctionBegin;
1045c6c1daeSBarry Smith   ierr = PetscFree(petsc_actions);CHKERRQ(ierr);
1055c6c1daeSBarry Smith   ierr = PetscFree(petsc_objects);CHKERRQ(ierr);
1060298fd71SBarry Smith   ierr = PetscLogSet(NULL, NULL);CHKERRQ(ierr);
1075c6c1daeSBarry Smith 
1085c6c1daeSBarry Smith   /* Resetting phase */
1095c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
1105c6c1daeSBarry Smith   ierr = PetscStageLogDestroy(stageLog);CHKERRQ(ierr);
111a297a907SKarl Rupp 
1125c6c1daeSBarry Smith   petsc_TotalFlops            = 0.0;
1135c6c1daeSBarry Smith   petsc_numActions            = 0;
1145c6c1daeSBarry Smith   petsc_numObjects            = 0;
1155c6c1daeSBarry Smith   petsc_numObjectsDestroyed   = 0;
1165c6c1daeSBarry Smith   petsc_maxActions            = 100;
1175c6c1daeSBarry Smith   petsc_maxObjects            = 100;
1180298fd71SBarry Smith   petsc_actions               = NULL;
1190298fd71SBarry Smith   petsc_objects               = NULL;
1205c6c1daeSBarry Smith   petsc_logActions            = PETSC_FALSE;
1215c6c1daeSBarry Smith   petsc_logObjects            = PETSC_FALSE;
1225c6c1daeSBarry Smith   petsc_BaseTime              = 0.0;
1235c6c1daeSBarry Smith   petsc_TotalFlops            = 0.0;
1245c6c1daeSBarry Smith   petsc_tmp_flops             = 0.0;
1255c6c1daeSBarry Smith   petsc_send_ct               = 0.0;
1265c6c1daeSBarry Smith   petsc_recv_ct               = 0.0;
1275c6c1daeSBarry Smith   petsc_send_len              = 0.0;
1285c6c1daeSBarry Smith   petsc_recv_len              = 0.0;
1295c6c1daeSBarry Smith   petsc_isend_ct              = 0.0;
1305c6c1daeSBarry Smith   petsc_irecv_ct              = 0.0;
1315c6c1daeSBarry Smith   petsc_isend_len             = 0.0;
1325c6c1daeSBarry Smith   petsc_irecv_len             = 0.0;
1335c6c1daeSBarry Smith   petsc_wait_ct               = 0.0;
1345c6c1daeSBarry Smith   petsc_wait_any_ct           = 0.0;
1355c6c1daeSBarry Smith   petsc_wait_all_ct           = 0.0;
1365c6c1daeSBarry Smith   petsc_sum_of_waits_ct       = 0.0;
1375c6c1daeSBarry Smith   petsc_allreduce_ct          = 0.0;
1385c6c1daeSBarry Smith   petsc_gather_ct             = 0.0;
1395c6c1daeSBarry Smith   petsc_scatter_ct            = 0.0;
1405c6c1daeSBarry Smith   PETSC_LARGEST_EVENT         = PETSC_EVENT;
1410298fd71SBarry Smith   PetscLogPHC                 = NULL;
1420298fd71SBarry Smith   PetscLogPHD                 = NULL;
1430298fd71SBarry Smith   petsc_tracefile             = NULL;
1445c6c1daeSBarry Smith   petsc_tracelevel            = 0;
1455c6c1daeSBarry Smith   petsc_traceblanks           = "                                                                                                    ";
1465c6c1daeSBarry Smith   petsc_tracespace[0]         = ' '; petsc_tracespace[1] = 0;
1475c6c1daeSBarry Smith   petsc_tracetime             = 0.0;
1485c6c1daeSBarry Smith   PETSC_LARGEST_CLASSID       = PETSC_SMALLEST_CLASSID;
1495c6c1daeSBarry Smith   PETSC_OBJECT_CLASSID        = 0;
1505c6c1daeSBarry Smith   petsc_stageLog              = 0;
1515c6c1daeSBarry Smith   PetscLogBegin_PrivateCalled = PETSC_FALSE;
1525c6c1daeSBarry Smith   PetscFunctionReturn(0);
1535c6c1daeSBarry Smith }
1545c6c1daeSBarry Smith 
1555c6c1daeSBarry Smith #undef __FUNCT__
1565c6c1daeSBarry Smith #define __FUNCT__ "PetscLogSet"
1575c6c1daeSBarry Smith /*@C
1585c6c1daeSBarry Smith   PetscLogSet - Sets the logging functions called at the beginning and ending of every event.
1595c6c1daeSBarry Smith 
1605c6c1daeSBarry Smith   Not Collective
1615c6c1daeSBarry Smith 
1625c6c1daeSBarry Smith   Input Parameters:
1635c6c1daeSBarry Smith + b - The function called at beginning of event
1645c6c1daeSBarry Smith - e - The function called at end of event
1655c6c1daeSBarry Smith 
1665c6c1daeSBarry Smith   Level: developer
1675c6c1daeSBarry Smith 
1685c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogBegin(), PetscLogAllBegin(), PetscLogTraceBegin()
1695c6c1daeSBarry Smith @*/
1705c6c1daeSBarry Smith PetscErrorCode  PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject),
1715c6c1daeSBarry Smith                             PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject))
1725c6c1daeSBarry Smith {
1735c6c1daeSBarry Smith   PetscFunctionBegin;
1745c6c1daeSBarry Smith   PetscLogPLB = b;
1755c6c1daeSBarry Smith   PetscLogPLE = e;
1765c6c1daeSBarry Smith   PetscFunctionReturn(0);
1775c6c1daeSBarry Smith }
1785c6c1daeSBarry Smith 
1795c6c1daeSBarry Smith #if defined(PETSC_HAVE_CHUD)
1805c6c1daeSBarry Smith #include <CHUD/CHUD.h>
1815c6c1daeSBarry Smith #endif
1825c6c1daeSBarry Smith #if defined(PETSC_HAVE_PAPI)
1835c6c1daeSBarry Smith #include <papi.h>
1845c6c1daeSBarry Smith int PAPIEventSet = PAPI_NULL;
1855c6c1daeSBarry Smith #endif
1865c6c1daeSBarry Smith 
1875c6c1daeSBarry Smith /*------------------------------------------- Initialization Functions ----------------------------------------------*/
1885c6c1daeSBarry Smith #undef __FUNCT__
1895c6c1daeSBarry Smith #define __FUNCT__ "PetscLogBegin_Private"
1905c6c1daeSBarry Smith PetscErrorCode  PetscLogBegin_Private(void)
1915c6c1daeSBarry Smith {
1925c6c1daeSBarry Smith   int            stage;
1935c6c1daeSBarry Smith   PetscBool      opt;
1945c6c1daeSBarry Smith   PetscErrorCode ierr;
1955c6c1daeSBarry Smith 
1965c6c1daeSBarry Smith   PetscFunctionBegin;
1975c6c1daeSBarry Smith   if (PetscLogBegin_PrivateCalled) PetscFunctionReturn(0);
1985c6c1daeSBarry Smith   PetscLogBegin_PrivateCalled = PETSC_TRUE;
1995c6c1daeSBarry Smith 
2000298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL, "-log_exclude_actions", &opt);CHKERRQ(ierr);
201a297a907SKarl Rupp   if (opt) petsc_logActions = PETSC_FALSE;
2020298fd71SBarry Smith   ierr = PetscOptionsHasName(NULL, "-log_exclude_objects", &opt);CHKERRQ(ierr);
203a297a907SKarl Rupp   if (opt) petsc_logObjects = PETSC_FALSE;
2045c6c1daeSBarry Smith   if (petsc_logActions) {
205*785e854fSJed Brown     ierr = PetscMalloc1(petsc_maxActions, &petsc_actions);CHKERRQ(ierr);
2065c6c1daeSBarry Smith   }
2075c6c1daeSBarry Smith   if (petsc_logObjects) {
208*785e854fSJed Brown     ierr = PetscMalloc1(petsc_maxObjects, &petsc_objects);CHKERRQ(ierr);
2095c6c1daeSBarry Smith   }
2105c6c1daeSBarry Smith   PetscLogPHC = PetscLogObjCreateDefault;
2115c6c1daeSBarry Smith   PetscLogPHD = PetscLogObjDestroyDefault;
2125c6c1daeSBarry Smith   /* Setup default logging structures */
2135c6c1daeSBarry Smith   ierr = PetscStageLogCreate(&petsc_stageLog);CHKERRQ(ierr);
2145c6c1daeSBarry Smith   ierr = PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage);CHKERRQ(ierr);
2155c6c1daeSBarry Smith #if defined(PETSC_HAVE_CHUD)
2165c6c1daeSBarry Smith   ierr = chudInitialize();CHKERRQ(ierr);
2175c6c1daeSBarry Smith   ierr = chudAcquireSamplingFacility(CHUD_BLOCKING);CHKERRQ(ierr);
2185c6c1daeSBarry Smith   ierr = chudSetSamplingDevice(chudCPU1Dev);CHKERRQ(ierr);
2195c6c1daeSBarry Smith   ierr = chudSetStartDelay(0,chudNanoSeconds);CHKERRQ(ierr);
2205c6c1daeSBarry Smith   ierr = chudClearPMCMode(chudCPU1Dev,chudUnused);CHKERRQ(ierr);
2215c6c1daeSBarry Smith   ierr = chudClearPMCs();CHKERRQ(ierr);
2225c6c1daeSBarry Smith   /* ierr = chudSetPMCMuxPosition(chudCPU1Dev,0,0);CHKERRQ(ierr); */
2235c6c1daeSBarry Smith   printf("%s\n",chudGetEventName(chudCPU1Dev,PMC_1,193));
2245c6c1daeSBarry Smith   printf("%s\n",chudGetEventDescription(chudCPU1Dev,PMC_1,193));
2255c6c1daeSBarry Smith   printf("%s\n",chudGetEventNotes(chudCPU1Dev,PMC_1,193));
2265c6c1daeSBarry Smith   ierr = chudSetPMCEvent(chudCPU1Dev,PMC_1,193);CHKERRQ(ierr);
2275c6c1daeSBarry Smith   ierr = chudSetPMCMode(chudCPU1Dev,PMC_1,chudCounter);CHKERRQ(ierr);
2285c6c1daeSBarry Smith   ierr = chudSetPrivilegeFilter(chudCPU1Dev,PMC_1,chudCountUserEvents);CHKERRQ(ierr);
2295c6c1daeSBarry Smith   ierr = chudSetPMCEventMask(chudCPU1Dev,PMC_1,0xFE);CHKERRQ(ierr);
2305c6c1daeSBarry Smith   if (!chudIsEventValid(chudCPU1Dev,PMC_1,193)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"Event is not valid %d",193);
2315c6c1daeSBarry Smith   ierr = chudStartPMCs();CHKERRQ(ierr);
2325c6c1daeSBarry Smith #endif
2335c6c1daeSBarry Smith #if defined(PETSC_HAVE_PAPI)
2345c6c1daeSBarry Smith   ierr = PAPI_library_init(PAPI_VER_CURRENT);
2355c6c1daeSBarry Smith   if (ierr != PAPI_VER_CURRENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"Cannot initialize PAPI");
2365c6c1daeSBarry Smith   ierr = PAPI_query_event(PAPI_FP_INS);CHKERRQ(ierr);
2375c6c1daeSBarry Smith   ierr = PAPI_create_eventset(&PAPIEventSet);CHKERRQ(ierr);
2385c6c1daeSBarry Smith   ierr = PAPI_add_event(PAPIEventSet,PAPI_FP_INS);CHKERRQ(ierr);
2395c6c1daeSBarry Smith   ierr = PAPI_start(PAPIEventSet);CHKERRQ(ierr);
2405c6c1daeSBarry Smith #endif
2415c6c1daeSBarry Smith 
2425c6c1daeSBarry Smith   /* All processors sync here for more consistent logging */
2435c6c1daeSBarry Smith   ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr);
2448563dfccSBarry Smith   PetscTime(&petsc_BaseTime);
2455c6c1daeSBarry Smith   ierr = PetscLogStagePush(stage);CHKERRQ(ierr);
2465c6c1daeSBarry Smith   PetscFunctionReturn(0);
2475c6c1daeSBarry Smith }
2485c6c1daeSBarry Smith 
2495c6c1daeSBarry Smith #undef __FUNCT__
2505c6c1daeSBarry Smith #define __FUNCT__ "PetscLogBegin"
2515c6c1daeSBarry Smith /*@C
2525c6c1daeSBarry Smith   PetscLogBegin - Turns on logging of objects and events. This logs flop
2535c6c1daeSBarry Smith   rates and object creation and should not slow programs down too much.
2545c6c1daeSBarry Smith   This routine may be called more than once.
2555c6c1daeSBarry Smith 
2565c6c1daeSBarry Smith   Logically Collective over PETSC_COMM_WORLD
2575c6c1daeSBarry Smith 
2585c6c1daeSBarry Smith   Options Database Keys:
2595c6c1daeSBarry Smith + -log_summary - Prints summary of flop and timing information to the
2605c6c1daeSBarry Smith                   screen (for code compiled with PETSC_USE_LOG)
2615c6c1daeSBarry Smith - -log - Prints detailed log information (for code compiled with PETSC_USE_LOG)
2625c6c1daeSBarry Smith 
2635c6c1daeSBarry Smith   Usage:
2645c6c1daeSBarry Smith .vb
2655c6c1daeSBarry Smith       PetscInitialize(...);
2665c6c1daeSBarry Smith       PetscLogBegin();
2675c6c1daeSBarry Smith        ... code ...
2685c6c1daeSBarry Smith       PetscLogView(viewer); or PetscLogDump();
2695c6c1daeSBarry Smith       PetscFinalize();
2705c6c1daeSBarry Smith .ve
2715c6c1daeSBarry Smith 
2725c6c1daeSBarry Smith   Notes:
2735c6c1daeSBarry Smith   PetscLogView(viewer) or PetscLogDump() actually cause the printing of
2745c6c1daeSBarry Smith   the logging information.
2755c6c1daeSBarry Smith 
2765c6c1daeSBarry Smith   Level: advanced
2775c6c1daeSBarry Smith 
2785c6c1daeSBarry Smith .keywords: log, begin
2795c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogTraceBegin()
2805c6c1daeSBarry Smith @*/
2815c6c1daeSBarry Smith PetscErrorCode  PetscLogBegin(void)
2825c6c1daeSBarry Smith {
2835c6c1daeSBarry Smith   PetscErrorCode ierr;
2845c6c1daeSBarry Smith 
2855c6c1daeSBarry Smith   PetscFunctionBegin;
2865c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault);CHKERRQ(ierr);
2875c6c1daeSBarry Smith   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
2885c6c1daeSBarry Smith   PetscFunctionReturn(0);
2895c6c1daeSBarry Smith }
2905c6c1daeSBarry Smith 
2915c6c1daeSBarry Smith #undef __FUNCT__
2925c6c1daeSBarry Smith #define __FUNCT__ "PetscLogAllBegin"
2935c6c1daeSBarry Smith /*@C
2945c6c1daeSBarry Smith   PetscLogAllBegin - Turns on extensive logging of objects and events. Logs
2955c6c1daeSBarry Smith   all events. This creates large log files and slows the program down.
2965c6c1daeSBarry Smith 
2975c6c1daeSBarry Smith   Logically Collective on PETSC_COMM_WORLD
2985c6c1daeSBarry Smith 
2995c6c1daeSBarry Smith   Options Database Keys:
3005c6c1daeSBarry Smith . -log_all - Prints extensive log information (for code compiled with PETSC_USE_LOG)
3015c6c1daeSBarry Smith 
3025c6c1daeSBarry Smith   Usage:
3035c6c1daeSBarry Smith .vb
3045c6c1daeSBarry Smith      PetscInitialize(...);
3055c6c1daeSBarry Smith      PetscLogAllBegin();
3065c6c1daeSBarry Smith      ... code ...
3075c6c1daeSBarry Smith      PetscLogDump(filename);
3085c6c1daeSBarry Smith      PetscFinalize();
3095c6c1daeSBarry Smith .ve
3105c6c1daeSBarry Smith 
3115c6c1daeSBarry Smith   Notes:
312495fc317SBarry Smith   A related routine is PetscLogBegin() (with the options key -log), which is
3135c6c1daeSBarry Smith   intended for production runs since it logs only flop rates and object
3145c6c1daeSBarry Smith   creation (and shouldn't significantly slow the programs).
3155c6c1daeSBarry Smith 
3165c6c1daeSBarry Smith   Level: advanced
3175c6c1daeSBarry Smith 
3185c6c1daeSBarry Smith .keywords: log, all, begin
3195c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogBegin(), PetscLogTraceBegin()
3205c6c1daeSBarry Smith @*/
3215c6c1daeSBarry Smith PetscErrorCode  PetscLogAllBegin(void)
3225c6c1daeSBarry Smith {
3235c6c1daeSBarry Smith   PetscErrorCode ierr;
3245c6c1daeSBarry Smith 
3255c6c1daeSBarry Smith   PetscFunctionBegin;
3265c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete);CHKERRQ(ierr);
3275c6c1daeSBarry Smith   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
3285c6c1daeSBarry Smith   PetscFunctionReturn(0);
3295c6c1daeSBarry Smith }
3305c6c1daeSBarry Smith 
3315c6c1daeSBarry Smith #undef __FUNCT__
3325c6c1daeSBarry Smith #define __FUNCT__ "PetscLogTraceBegin"
3335c6c1daeSBarry Smith /*@
3345c6c1daeSBarry Smith   PetscLogTraceBegin - Activates trace logging.  Every time a PETSc event
3355c6c1daeSBarry Smith   begins or ends, the event name is printed.
3365c6c1daeSBarry Smith 
3375c6c1daeSBarry Smith   Logically Collective on PETSC_COMM_WORLD
3385c6c1daeSBarry Smith 
3395c6c1daeSBarry Smith   Input Parameter:
3405c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout)
3415c6c1daeSBarry Smith 
3425c6c1daeSBarry Smith   Options Database Key:
3435c6c1daeSBarry Smith . -log_trace [filename] - Activates PetscLogTraceBegin()
3445c6c1daeSBarry Smith 
3455c6c1daeSBarry Smith   Notes:
3465c6c1daeSBarry Smith   PetscLogTraceBegin() prints the processor number, the execution time (sec),
3475c6c1daeSBarry Smith   then "Event begin:" or "Event end:" followed by the event name.
3485c6c1daeSBarry Smith 
3495c6c1daeSBarry Smith   PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful
3505c6c1daeSBarry Smith   to determine where a program is hanging without running in the
3515c6c1daeSBarry Smith   debugger.  Can be used in conjunction with the -info option.
3525c6c1daeSBarry Smith 
3535c6c1daeSBarry Smith   Level: intermediate
3545c6c1daeSBarry Smith 
3555c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogBegin()
3565c6c1daeSBarry Smith @*/
3575c6c1daeSBarry Smith PetscErrorCode  PetscLogTraceBegin(FILE *file)
3585c6c1daeSBarry Smith {
3595c6c1daeSBarry Smith   PetscErrorCode ierr;
3605c6c1daeSBarry Smith 
3615c6c1daeSBarry Smith   PetscFunctionBegin;
3625c6c1daeSBarry Smith   petsc_tracefile = file;
363a297a907SKarl Rupp 
3645c6c1daeSBarry Smith   ierr = PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace);CHKERRQ(ierr);
3655c6c1daeSBarry Smith   ierr = PetscLogBegin_Private();CHKERRQ(ierr);
3665c6c1daeSBarry Smith   PetscFunctionReturn(0);
3675c6c1daeSBarry Smith }
3685c6c1daeSBarry Smith 
3695c6c1daeSBarry Smith #undef __FUNCT__
3705c6c1daeSBarry Smith #define __FUNCT__ "PetscLogActions"
3715c6c1daeSBarry Smith /*@
3725c6c1daeSBarry Smith   PetscLogActions - Determines whether actions are logged for the graphical viewer.
3735c6c1daeSBarry Smith 
3745c6c1daeSBarry Smith   Not Collective
3755c6c1daeSBarry Smith 
3765c6c1daeSBarry Smith   Input Parameter:
3775c6c1daeSBarry Smith . flag - PETSC_TRUE if actions are to be logged
3785c6c1daeSBarry Smith 
3795c6c1daeSBarry Smith   Level: intermediate
3805c6c1daeSBarry Smith 
3815c6c1daeSBarry Smith   Note: Logging of actions continues to consume more memory as the program
3825c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
3835c6c1daeSBarry Smith 
3845c6c1daeSBarry Smith   Options Database Keys:
3855c6c1daeSBarry Smith . -log_exclude_actions - Turns off actions logging
3865c6c1daeSBarry Smith 
3875c6c1daeSBarry Smith .keywords: log, stage, register
3885c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
3895c6c1daeSBarry Smith @*/
3905c6c1daeSBarry Smith PetscErrorCode  PetscLogActions(PetscBool flag)
3915c6c1daeSBarry Smith {
3925c6c1daeSBarry Smith   PetscFunctionBegin;
3935c6c1daeSBarry Smith   petsc_logActions = flag;
3945c6c1daeSBarry Smith   PetscFunctionReturn(0);
3955c6c1daeSBarry Smith }
3965c6c1daeSBarry Smith 
3975c6c1daeSBarry Smith #undef __FUNCT__
3985c6c1daeSBarry Smith #define __FUNCT__ "PetscLogObjects"
3995c6c1daeSBarry Smith /*@
4005c6c1daeSBarry Smith   PetscLogObjects - Determines whether objects are logged for the graphical viewer.
4015c6c1daeSBarry Smith 
4025c6c1daeSBarry Smith   Not Collective
4035c6c1daeSBarry Smith 
4045c6c1daeSBarry Smith   Input Parameter:
4055c6c1daeSBarry Smith . flag - PETSC_TRUE if objects are to be logged
4065c6c1daeSBarry Smith 
4075c6c1daeSBarry Smith   Level: intermediate
4085c6c1daeSBarry Smith 
4095c6c1daeSBarry Smith   Note: Logging of objects continues to consume more memory as the program
4105c6c1daeSBarry Smith   runs. Long running programs should consider turning this feature off.
4115c6c1daeSBarry Smith 
4125c6c1daeSBarry Smith   Options Database Keys:
4135c6c1daeSBarry Smith . -log_exclude_objects - Turns off objects logging
4145c6c1daeSBarry Smith 
4155c6c1daeSBarry Smith .keywords: log, stage, register
4165c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
4175c6c1daeSBarry Smith @*/
4185c6c1daeSBarry Smith PetscErrorCode  PetscLogObjects(PetscBool flag)
4195c6c1daeSBarry Smith {
4205c6c1daeSBarry Smith   PetscFunctionBegin;
4215c6c1daeSBarry Smith   petsc_logObjects = flag;
4225c6c1daeSBarry Smith   PetscFunctionReturn(0);
4235c6c1daeSBarry Smith }
4245c6c1daeSBarry Smith 
4255c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/
4265c6c1daeSBarry Smith #undef __FUNCT__
4275c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStageRegister"
4285c6c1daeSBarry Smith /*@C
4295c6c1daeSBarry Smith   PetscLogStageRegister - Attaches a charactor string name to a logging stage.
4305c6c1daeSBarry Smith 
4315c6c1daeSBarry Smith   Not Collective
4325c6c1daeSBarry Smith 
4335c6c1daeSBarry Smith   Input Parameter:
4345c6c1daeSBarry Smith . sname - The name to associate with that stage
4355c6c1daeSBarry Smith 
4365c6c1daeSBarry Smith   Output Parameter:
4375c6c1daeSBarry Smith . stage - The stage number
4385c6c1daeSBarry Smith 
4395c6c1daeSBarry Smith   Level: intermediate
4405c6c1daeSBarry Smith 
4415c6c1daeSBarry Smith .keywords: log, stage, register
4425c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop()
4435c6c1daeSBarry Smith @*/
4445c6c1daeSBarry Smith PetscErrorCode  PetscLogStageRegister(const char sname[],PetscLogStage *stage)
4455c6c1daeSBarry Smith {
4465c6c1daeSBarry Smith   PetscStageLog  stageLog;
4475c6c1daeSBarry Smith   PetscLogEvent  event;
4485c6c1daeSBarry Smith   PetscErrorCode ierr;
4495c6c1daeSBarry Smith 
4505c6c1daeSBarry Smith   PetscFunctionBegin;
4515c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
4525c6c1daeSBarry Smith   ierr = PetscStageLogRegister(stageLog, sname, stage);CHKERRQ(ierr);
4535c6c1daeSBarry Smith   /* Copy events already changed in the main stage, this sucks */
4545c6c1daeSBarry Smith   ierr = EventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr);
4555c6c1daeSBarry Smith   for (event = 0; event < stageLog->eventLog->numEvents; event++) {
4565c6c1daeSBarry Smith     ierr = EventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event],&stageLog->stageInfo[*stage].eventLog->eventInfo[event]);CHKERRQ(ierr);
4575c6c1daeSBarry Smith   }
4585c6c1daeSBarry Smith   ierr = ClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
4595c6c1daeSBarry Smith   PetscFunctionReturn(0);
4605c6c1daeSBarry Smith }
4615c6c1daeSBarry Smith 
4625c6c1daeSBarry Smith #undef __FUNCT__
4635c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStagePush"
4645c6c1daeSBarry Smith /*@C
4655c6c1daeSBarry Smith   PetscLogStagePush - This function pushes a stage on the stack.
4665c6c1daeSBarry Smith 
4675c6c1daeSBarry Smith   Not Collective
4685c6c1daeSBarry Smith 
4695c6c1daeSBarry Smith   Input Parameter:
4705c6c1daeSBarry Smith . stage - The stage on which to log
4715c6c1daeSBarry Smith 
4725c6c1daeSBarry Smith   Usage:
4735c6c1daeSBarry Smith   If the option -log_sumary is used to run the program containing the
4745c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
4755c6c1daeSBarry Smith   PetscFinalize().
4765c6c1daeSBarry Smith .vb
4775c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
4785c6c1daeSBarry Smith       [stage 0 of code]
4795c6c1daeSBarry Smith       PetscLogStagePush(1);
4805c6c1daeSBarry Smith       [stage 1 of code]
4815c6c1daeSBarry Smith       PetscLogStagePop();
4825c6c1daeSBarry Smith       PetscBarrier(...);
4835c6c1daeSBarry Smith       [more stage 0 of code]
4845c6c1daeSBarry Smith       PetscFinalize();
4855c6c1daeSBarry Smith .ve
4865c6c1daeSBarry Smith 
4875c6c1daeSBarry Smith   Notes:
4885c6c1daeSBarry Smith   Use PetscLogStageRegister() to register a stage.
4895c6c1daeSBarry Smith 
4905c6c1daeSBarry Smith   Level: intermediate
4915c6c1daeSBarry Smith 
4925c6c1daeSBarry Smith .keywords: log, push, stage
4935c6c1daeSBarry Smith .seealso: PetscLogStagePop(), PetscLogStageRegister(), PetscBarrier()
4945c6c1daeSBarry Smith @*/
4955c6c1daeSBarry Smith PetscErrorCode  PetscLogStagePush(PetscLogStage stage)
4965c6c1daeSBarry Smith {
4975c6c1daeSBarry Smith   PetscStageLog  stageLog;
4985c6c1daeSBarry Smith   PetscErrorCode ierr;
4995c6c1daeSBarry Smith 
5005c6c1daeSBarry Smith   PetscFunctionBegin;
5015c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5025c6c1daeSBarry Smith   ierr = PetscStageLogPush(stageLog, stage);CHKERRQ(ierr);
5035c6c1daeSBarry Smith   PetscFunctionReturn(0);
5045c6c1daeSBarry Smith }
5055c6c1daeSBarry Smith 
5065c6c1daeSBarry Smith #undef __FUNCT__
5075c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStagePop"
5085c6c1daeSBarry Smith /*@C
5095c6c1daeSBarry Smith   PetscLogStagePop - This function pops a stage from the stack.
5105c6c1daeSBarry Smith 
5115c6c1daeSBarry Smith   Not Collective
5125c6c1daeSBarry Smith 
5135c6c1daeSBarry Smith   Usage:
5145c6c1daeSBarry Smith   If the option -log_sumary is used to run the program containing the
5155c6c1daeSBarry Smith   following code, then 2 sets of summary data will be printed during
5165c6c1daeSBarry Smith   PetscFinalize().
5175c6c1daeSBarry Smith .vb
5185c6c1daeSBarry Smith       PetscInitialize(int *argc,char ***args,0,0);
5195c6c1daeSBarry Smith       [stage 0 of code]
5205c6c1daeSBarry Smith       PetscLogStagePush(1);
5215c6c1daeSBarry Smith       [stage 1 of code]
5225c6c1daeSBarry Smith       PetscLogStagePop();
5235c6c1daeSBarry Smith       PetscBarrier(...);
5245c6c1daeSBarry Smith       [more stage 0 of code]
5255c6c1daeSBarry Smith       PetscFinalize();
5265c6c1daeSBarry Smith .ve
5275c6c1daeSBarry Smith 
5285c6c1daeSBarry Smith   Notes:
5295c6c1daeSBarry Smith   Use PetscLogStageRegister() to register a stage.
5305c6c1daeSBarry Smith 
5315c6c1daeSBarry Smith   Level: intermediate
5325c6c1daeSBarry Smith 
5335c6c1daeSBarry Smith .keywords: log, pop, stage
5345c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStageRegister(), PetscBarrier()
5355c6c1daeSBarry Smith @*/
5365c6c1daeSBarry Smith PetscErrorCode  PetscLogStagePop(void)
5375c6c1daeSBarry Smith {
5385c6c1daeSBarry Smith   PetscStageLog  stageLog;
5395c6c1daeSBarry Smith   PetscErrorCode ierr;
5405c6c1daeSBarry Smith 
5415c6c1daeSBarry Smith   PetscFunctionBegin;
5425c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5435c6c1daeSBarry Smith   ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr);
5445c6c1daeSBarry Smith   PetscFunctionReturn(0);
5455c6c1daeSBarry Smith }
5465c6c1daeSBarry Smith 
5475c6c1daeSBarry Smith #undef __FUNCT__
5485c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStageSetActive"
5495c6c1daeSBarry Smith /*@
5505c6c1daeSBarry Smith   PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd().
5515c6c1daeSBarry Smith 
5525c6c1daeSBarry Smith   Not Collective
5535c6c1daeSBarry Smith 
5545c6c1daeSBarry Smith   Input Parameters:
5555c6c1daeSBarry Smith + stage    - The stage
5565c6c1daeSBarry Smith - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE)
5575c6c1daeSBarry Smith 
5585c6c1daeSBarry Smith   Level: intermediate
5595c6c1daeSBarry Smith 
5605c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
5615c6c1daeSBarry Smith @*/
5625c6c1daeSBarry Smith PetscErrorCode  PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive)
5635c6c1daeSBarry Smith {
5645c6c1daeSBarry Smith   PetscStageLog  stageLog;
5655c6c1daeSBarry Smith   PetscErrorCode ierr;
5665c6c1daeSBarry Smith 
5675c6c1daeSBarry Smith   PetscFunctionBegin;
5685c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5695c6c1daeSBarry Smith   ierr = PetscStageLogSetActive(stageLog, stage, isActive);CHKERRQ(ierr);
5705c6c1daeSBarry Smith   PetscFunctionReturn(0);
5715c6c1daeSBarry Smith }
5725c6c1daeSBarry Smith 
5735c6c1daeSBarry Smith #undef __FUNCT__
5745c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStageGetActive"
5755c6c1daeSBarry Smith /*@
5765c6c1daeSBarry Smith   PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd().
5775c6c1daeSBarry Smith 
5785c6c1daeSBarry Smith   Not Collective
5795c6c1daeSBarry Smith 
5805c6c1daeSBarry Smith   Input Parameter:
5815c6c1daeSBarry Smith . stage    - The stage
5825c6c1daeSBarry Smith 
5835c6c1daeSBarry Smith   Output Parameter:
5845c6c1daeSBarry Smith . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE)
5855c6c1daeSBarry Smith 
5865c6c1daeSBarry Smith   Level: intermediate
5875c6c1daeSBarry Smith 
5885c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
5895c6c1daeSBarry Smith @*/
5905c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetActive(PetscLogStage stage, PetscBool  *isActive)
5915c6c1daeSBarry Smith {
5925c6c1daeSBarry Smith   PetscStageLog  stageLog;
5935c6c1daeSBarry Smith   PetscErrorCode ierr;
5945c6c1daeSBarry Smith 
5955c6c1daeSBarry Smith   PetscFunctionBegin;
5965c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
5975c6c1daeSBarry Smith   ierr = PetscStageLogGetActive(stageLog, stage, isActive);CHKERRQ(ierr);
5985c6c1daeSBarry Smith   PetscFunctionReturn(0);
5995c6c1daeSBarry Smith }
6005c6c1daeSBarry Smith 
6015c6c1daeSBarry Smith #undef __FUNCT__
6025c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStageSetVisible"
6035c6c1daeSBarry Smith /*@
6045c6c1daeSBarry Smith   PetscLogStageSetVisible - Determines stage visibility in PetscLogView()
6055c6c1daeSBarry Smith 
6065c6c1daeSBarry Smith   Not Collective
6075c6c1daeSBarry Smith 
6085c6c1daeSBarry Smith   Input Parameters:
6095c6c1daeSBarry Smith + stage     - The stage
6105c6c1daeSBarry Smith - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE)
6115c6c1daeSBarry Smith 
6125c6c1daeSBarry Smith   Level: intermediate
6135c6c1daeSBarry Smith 
6145c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView()
6155c6c1daeSBarry Smith @*/
6165c6c1daeSBarry Smith PetscErrorCode  PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible)
6175c6c1daeSBarry Smith {
6185c6c1daeSBarry Smith   PetscStageLog  stageLog;
6195c6c1daeSBarry Smith   PetscErrorCode ierr;
6205c6c1daeSBarry Smith 
6215c6c1daeSBarry Smith   PetscFunctionBegin;
6225c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
6235c6c1daeSBarry Smith   ierr = PetscStageLogSetVisible(stageLog, stage, isVisible);CHKERRQ(ierr);
6245c6c1daeSBarry Smith   PetscFunctionReturn(0);
6255c6c1daeSBarry Smith }
6265c6c1daeSBarry Smith 
6275c6c1daeSBarry Smith #undef __FUNCT__
6285c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStageGetVisible"
6295c6c1daeSBarry Smith /*@
6305c6c1daeSBarry Smith   PetscLogStageGetVisible - Returns stage visibility in PetscLogView()
6315c6c1daeSBarry Smith 
6325c6c1daeSBarry Smith   Not Collective
6335c6c1daeSBarry Smith 
6345c6c1daeSBarry Smith   Input Parameter:
6355c6c1daeSBarry Smith . stage     - The stage
6365c6c1daeSBarry Smith 
6375c6c1daeSBarry Smith   Output Parameter:
6385c6c1daeSBarry Smith . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE)
6395c6c1daeSBarry Smith 
6405c6c1daeSBarry Smith   Level: intermediate
6415c6c1daeSBarry Smith 
6425c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView()
6435c6c1daeSBarry Smith @*/
6445c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetVisible(PetscLogStage stage, PetscBool  *isVisible)
6455c6c1daeSBarry Smith {
6465c6c1daeSBarry Smith   PetscStageLog  stageLog;
6475c6c1daeSBarry Smith   PetscErrorCode ierr;
6485c6c1daeSBarry Smith 
6495c6c1daeSBarry Smith   PetscFunctionBegin;
6505c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
6515c6c1daeSBarry Smith   ierr = PetscStageLogGetVisible(stageLog, stage, isVisible);CHKERRQ(ierr);
6525c6c1daeSBarry Smith   PetscFunctionReturn(0);
6535c6c1daeSBarry Smith }
6545c6c1daeSBarry Smith 
6555c6c1daeSBarry Smith #undef __FUNCT__
6565c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStageGetId"
6575c6c1daeSBarry Smith /*@C
6585c6c1daeSBarry Smith   PetscLogStageGetId - Returns the stage id when given the stage name.
6595c6c1daeSBarry Smith 
6605c6c1daeSBarry Smith   Not Collective
6615c6c1daeSBarry Smith 
6625c6c1daeSBarry Smith   Input Parameter:
6635c6c1daeSBarry Smith . name  - The stage name
6645c6c1daeSBarry Smith 
6655c6c1daeSBarry Smith   Output Parameter:
6665c6c1daeSBarry Smith . stage - The stage
6675c6c1daeSBarry Smith 
6685c6c1daeSBarry Smith   Level: intermediate
6695c6c1daeSBarry Smith 
6705c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage()
6715c6c1daeSBarry Smith @*/
6725c6c1daeSBarry Smith PetscErrorCode  PetscLogStageGetId(const char name[], PetscLogStage *stage)
6735c6c1daeSBarry Smith {
6745c6c1daeSBarry Smith   PetscStageLog  stageLog;
6755c6c1daeSBarry Smith   PetscErrorCode ierr;
6765c6c1daeSBarry Smith 
6775c6c1daeSBarry Smith   PetscFunctionBegin;
6785c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
6795c6c1daeSBarry Smith   ierr = PetscStageLogGetStage(stageLog, name, stage);CHKERRQ(ierr);
6805c6c1daeSBarry Smith   PetscFunctionReturn(0);
6815c6c1daeSBarry Smith }
6825c6c1daeSBarry Smith 
6835c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/
6845c6c1daeSBarry Smith #undef __FUNCT__
6855c6c1daeSBarry Smith #define __FUNCT__ "PetscLogEventRegister"
6865c6c1daeSBarry Smith /*@C
6875c6c1daeSBarry Smith   PetscLogEventRegister - Registers an event name for logging operations in an application code.
6885c6c1daeSBarry Smith 
6895c6c1daeSBarry Smith   Not Collective
6905c6c1daeSBarry Smith 
6915c6c1daeSBarry Smith   Input Parameter:
6925c6c1daeSBarry Smith + name   - The name associated with the event
6935c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with
6945c6c1daeSBarry Smith            PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones
6955c6c1daeSBarry Smith            are only available in C code
6965c6c1daeSBarry Smith 
6975c6c1daeSBarry Smith   Output Parameter:
6985c6c1daeSBarry Smith . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd().
6995c6c1daeSBarry Smith 
7005c6c1daeSBarry Smith   Example of Usage:
7015c6c1daeSBarry Smith .vb
7025c6c1daeSBarry Smith       PetscLogEvent USER_EVENT;
7035c6c1daeSBarry Smith       PetscClassId classid;
7045c6c1daeSBarry Smith       PetscLogDouble user_event_flops;
7055c6c1daeSBarry Smith       PetscClassIdRegister("class name",&classid);
7065c6c1daeSBarry Smith       PetscLogEventRegister("User event name",classid,&USER_EVENT);
7075c6c1daeSBarry Smith       PetscLogEventBegin(USER_EVENT,0,0,0,0);
7085c6c1daeSBarry Smith          [code segment to monitor]
7095c6c1daeSBarry Smith          PetscLogFlops(user_event_flops);
7105c6c1daeSBarry Smith       PetscLogEventEnd(USER_EVENT,0,0,0,0);
7115c6c1daeSBarry Smith .ve
7125c6c1daeSBarry Smith 
7135c6c1daeSBarry Smith   Notes:
7145c6c1daeSBarry Smith   PETSc automatically logs library events if the code has been
7155c6c1daeSBarry Smith   compiled with -DPETSC_USE_LOG (which is the default) and -log,
7165c6c1daeSBarry Smith   -log_summary, or -log_all are specified.  PetscLogEventRegister() is
7175c6c1daeSBarry Smith   intended for logging user events to supplement this PETSc
7185c6c1daeSBarry Smith   information.
7195c6c1daeSBarry Smith 
720495fc317SBarry Smith   PETSc can gather data for use with the utilities Jumpshot
7215c6c1daeSBarry Smith   (part of the MPICH distribution).  If PETSc has been compiled
7225c6c1daeSBarry Smith   with flag -DPETSC_HAVE_MPE (MPE is an additional utility within
7235c6c1daeSBarry Smith   MPICH), the user can employ another command line option, -log_mpe,
7245c6c1daeSBarry Smith   to create a logfile, "mpe.log", which can be visualized
725495fc317SBarry Smith   Jumpshot.
7265c6c1daeSBarry Smith 
7275c6c1daeSBarry Smith   The classid is associated with each event so that classes of events
7285c6c1daeSBarry Smith   can be disabled simultaneously, such as all matrix events. The user
7295c6c1daeSBarry Smith   can either use an existing classid, such as MAT_CLASSID, or create
7305c6c1daeSBarry Smith   their own as shown in the example.
7315c6c1daeSBarry Smith 
7325c6c1daeSBarry Smith   Level: intermediate
7335c6c1daeSBarry Smith 
7345c6c1daeSBarry Smith .keywords: log, event, register
7355c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogFlops(),
7365c6c1daeSBarry Smith           PetscLogEventMPEActivate(), PetscLogEventMPEDeactivate(),
7375c6c1daeSBarry Smith           PetscLogEventActivate(), PetscLogEventDeactivate(), PetscClassIdRegister()
7385c6c1daeSBarry Smith @*/
7395c6c1daeSBarry Smith PetscErrorCode  PetscLogEventRegister(const char name[],PetscClassId classid,PetscLogEvent *event)
7405c6c1daeSBarry Smith {
7415c6c1daeSBarry Smith   PetscStageLog  stageLog;
7425c6c1daeSBarry Smith   int            stage;
7435c6c1daeSBarry Smith   PetscErrorCode ierr;
7445c6c1daeSBarry Smith 
7455c6c1daeSBarry Smith   PetscFunctionBegin;
7465c6c1daeSBarry Smith   *event = PETSC_DECIDE;
7475c6c1daeSBarry Smith   ierr   = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
7485c6c1daeSBarry Smith   ierr   = EventRegLogRegister(stageLog->eventLog, name, classid, event);CHKERRQ(ierr);
7495c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
7505c6c1daeSBarry Smith     ierr = EventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr);
7515c6c1daeSBarry Smith     ierr = ClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
7525c6c1daeSBarry Smith   }
7535c6c1daeSBarry Smith   PetscFunctionReturn(0);
7545c6c1daeSBarry Smith }
7555c6c1daeSBarry Smith 
7565c6c1daeSBarry Smith #undef __FUNCT__
7575c6c1daeSBarry Smith #define __FUNCT__ "PetscLogEventActivate"
7585c6c1daeSBarry Smith /*@
7595c6c1daeSBarry Smith   PetscLogEventActivate - Indicates that a particular event should be logged.
7605c6c1daeSBarry Smith 
7615c6c1daeSBarry Smith   Not Collective
7625c6c1daeSBarry Smith 
7635c6c1daeSBarry Smith   Input Parameter:
7645c6c1daeSBarry Smith . event - The event id
7655c6c1daeSBarry Smith 
7665c6c1daeSBarry Smith   Usage:
7675c6c1daeSBarry Smith .vb
7685c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
7695c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
7705c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
7715c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
7725c6c1daeSBarry Smith .ve
7735c6c1daeSBarry Smith 
7745c6c1daeSBarry Smith   Note:
7755c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in include/petsclog.h)
7765c6c1daeSBarry Smith   or an event number obtained with PetscLogEventRegister().
7775c6c1daeSBarry Smith 
7785c6c1daeSBarry Smith   Level: advanced
7795c6c1daeSBarry Smith 
7805c6c1daeSBarry Smith .keywords: log, event, activate
7815c6c1daeSBarry Smith .seealso: PetscLogEventMPEDeactivate(),PetscLogEventMPEActivate(),PlogEventDeactivate()
7825c6c1daeSBarry Smith @*/
7835c6c1daeSBarry Smith PetscErrorCode  PetscLogEventActivate(PetscLogEvent event)
7845c6c1daeSBarry Smith {
7855c6c1daeSBarry Smith   PetscStageLog  stageLog;
7865c6c1daeSBarry Smith   int            stage;
7875c6c1daeSBarry Smith   PetscErrorCode ierr;
7885c6c1daeSBarry Smith 
7895c6c1daeSBarry Smith   PetscFunctionBegin;
7905c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
7915c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
7925c6c1daeSBarry Smith   ierr = EventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
7935c6c1daeSBarry Smith   PetscFunctionReturn(0);
7945c6c1daeSBarry Smith }
7955c6c1daeSBarry Smith 
7965c6c1daeSBarry Smith #undef __FUNCT__
7975c6c1daeSBarry Smith #define __FUNCT__ "PetscLogEventDeactivate"
7985c6c1daeSBarry Smith /*@
7995c6c1daeSBarry Smith   PetscLogEventDeactivate - Indicates that a particular event should not be logged.
8005c6c1daeSBarry Smith 
8015c6c1daeSBarry Smith   Not Collective
8025c6c1daeSBarry Smith 
8035c6c1daeSBarry Smith   Input Parameter:
8045c6c1daeSBarry Smith . event - The event id
8055c6c1daeSBarry Smith 
8065c6c1daeSBarry Smith   Usage:
8075c6c1daeSBarry Smith .vb
8085c6c1daeSBarry Smith       PetscLogEventDeactivate(VEC_SetValues);
8095c6c1daeSBarry Smith         [code where you do not want to log VecSetValues()]
8105c6c1daeSBarry Smith       PetscLogEventActivate(VEC_SetValues);
8115c6c1daeSBarry Smith         [code where you do want to log VecSetValues()]
8125c6c1daeSBarry Smith .ve
8135c6c1daeSBarry Smith 
8145c6c1daeSBarry Smith   Note:
8155c6c1daeSBarry Smith   The event may be either a pre-defined PETSc event (found in
8165c6c1daeSBarry Smith   include/petsclog.h) or an event number obtained with PetscLogEventRegister()).
8175c6c1daeSBarry Smith 
8185c6c1daeSBarry Smith   Level: advanced
8195c6c1daeSBarry Smith 
8205c6c1daeSBarry Smith .keywords: log, event, deactivate
8215c6c1daeSBarry Smith .seealso: PetscLogEventMPEDeactivate(),PetscLogEventMPEActivate(),PlogEventActivate()
8225c6c1daeSBarry Smith @*/
8235c6c1daeSBarry Smith PetscErrorCode  PetscLogEventDeactivate(PetscLogEvent event)
8245c6c1daeSBarry Smith {
8255c6c1daeSBarry Smith   PetscStageLog  stageLog;
8265c6c1daeSBarry Smith   int            stage;
8275c6c1daeSBarry Smith   PetscErrorCode ierr;
8285c6c1daeSBarry Smith 
8295c6c1daeSBarry Smith   PetscFunctionBegin;
8305c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
8315c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
8325c6c1daeSBarry Smith   ierr = EventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
8335c6c1daeSBarry Smith   PetscFunctionReturn(0);
8345c6c1daeSBarry Smith }
8355c6c1daeSBarry Smith 
8365c6c1daeSBarry Smith #undef __FUNCT__
8375c6c1daeSBarry Smith #define __FUNCT__ "PetscLogEventSetActiveAll"
8385c6c1daeSBarry Smith /*@
8395c6c1daeSBarry Smith   PetscLogEventSetActiveAll - Sets the event activity in every stage.
8405c6c1daeSBarry Smith 
8415c6c1daeSBarry Smith   Not Collective
8425c6c1daeSBarry Smith 
8435c6c1daeSBarry Smith   Input Parameters:
8445c6c1daeSBarry Smith + event    - The event id
8455c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged
8465c6c1daeSBarry Smith 
8475c6c1daeSBarry Smith   Level: advanced
8485c6c1daeSBarry Smith 
8495c6c1daeSBarry Smith .keywords: log, event, activate
8505c6c1daeSBarry Smith .seealso: PetscLogEventMPEDeactivate(),PetscLogEventMPEActivate(),PlogEventActivate(),PlogEventDeactivate()
8515c6c1daeSBarry Smith @*/
8525c6c1daeSBarry Smith PetscErrorCode  PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive)
8535c6c1daeSBarry Smith {
8545c6c1daeSBarry Smith   PetscStageLog  stageLog;
8555c6c1daeSBarry Smith   int            stage;
8565c6c1daeSBarry Smith   PetscErrorCode ierr;
8575c6c1daeSBarry Smith 
8585c6c1daeSBarry Smith   PetscFunctionBegin;
8595c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
8605c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
8615c6c1daeSBarry Smith     if (isActive) {
8625c6c1daeSBarry Smith       ierr = EventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
8635c6c1daeSBarry Smith     } else {
8645c6c1daeSBarry Smith       ierr = EventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr);
8655c6c1daeSBarry Smith     }
8665c6c1daeSBarry Smith   }
8675c6c1daeSBarry Smith   PetscFunctionReturn(0);
8685c6c1daeSBarry Smith }
8695c6c1daeSBarry Smith 
8705c6c1daeSBarry Smith #undef __FUNCT__
8715c6c1daeSBarry Smith #define __FUNCT__ "PetscLogEventActivateClass"
8725c6c1daeSBarry Smith /*@
8735c6c1daeSBarry Smith   PetscLogEventActivateClass - Activates event logging for a PETSc object class.
8745c6c1daeSBarry Smith 
8755c6c1daeSBarry Smith   Not Collective
8765c6c1daeSBarry Smith 
8775c6c1daeSBarry Smith   Input Parameter:
8785c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc.
8795c6c1daeSBarry Smith 
8805c6c1daeSBarry Smith   Level: developer
8815c6c1daeSBarry Smith 
8825c6c1daeSBarry Smith .keywords: log, event, activate, class
8835c6c1daeSBarry Smith .seealso: PetscInfoActivate(),PetscInfo(),PetscInfoAllow(),PetscLogEventDeactivateClass(), PetscLogEventActivate(),PetscLogEventDeactivate()
8845c6c1daeSBarry Smith @*/
8855c6c1daeSBarry Smith PetscErrorCode  PetscLogEventActivateClass(PetscClassId classid)
8865c6c1daeSBarry Smith {
8875c6c1daeSBarry Smith   PetscStageLog  stageLog;
8885c6c1daeSBarry Smith   int            stage;
8895c6c1daeSBarry Smith   PetscErrorCode ierr;
8905c6c1daeSBarry Smith 
8915c6c1daeSBarry Smith   PetscFunctionBegin;
8925c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
8935c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
8945c6c1daeSBarry Smith   ierr = EventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
8955c6c1daeSBarry Smith   PetscFunctionReturn(0);
8965c6c1daeSBarry Smith }
8975c6c1daeSBarry Smith 
8985c6c1daeSBarry Smith #undef __FUNCT__
8995c6c1daeSBarry Smith #define __FUNCT__ "PetscLogEventDeactivateClass"
9005c6c1daeSBarry Smith /*@
9015c6c1daeSBarry Smith   PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class.
9025c6c1daeSBarry Smith 
9035c6c1daeSBarry Smith   Not Collective
9045c6c1daeSBarry Smith 
9055c6c1daeSBarry Smith   Input Parameter:
9065c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc.
9075c6c1daeSBarry Smith 
9085c6c1daeSBarry Smith   Level: developer
9095c6c1daeSBarry Smith 
9105c6c1daeSBarry Smith .keywords: log, event, deactivate, class
9115c6c1daeSBarry Smith .seealso: PetscInfoActivate(),PetscInfo(),PetscInfoAllow(),PetscLogEventActivateClass(), PetscLogEventActivate(),PetscLogEventDeactivate()
9125c6c1daeSBarry Smith @*/
9135c6c1daeSBarry Smith PetscErrorCode  PetscLogEventDeactivateClass(PetscClassId classid)
9145c6c1daeSBarry Smith {
9155c6c1daeSBarry Smith   PetscStageLog  stageLog;
9165c6c1daeSBarry Smith   int            stage;
9175c6c1daeSBarry Smith   PetscErrorCode ierr;
9185c6c1daeSBarry Smith 
9195c6c1daeSBarry Smith   PetscFunctionBegin;
9205c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
9215c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
9225c6c1daeSBarry Smith   ierr = EventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr);
9235c6c1daeSBarry Smith   PetscFunctionReturn(0);
9245c6c1daeSBarry Smith }
9255c6c1daeSBarry Smith 
9265c6c1daeSBarry Smith /*MC
9275c6c1daeSBarry Smith    PetscLogEventBegin - Logs the beginning of a user event.
9285c6c1daeSBarry Smith 
9295c6c1daeSBarry Smith    Synopsis:
930f2ba6396SBarry Smith    #include "petsclog.h"
931f2ba6396SBarry Smith    PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
9325c6c1daeSBarry Smith 
9335c6c1daeSBarry Smith    Not Collective
9345c6c1daeSBarry Smith 
9355c6c1daeSBarry Smith    Input Parameters:
9365c6c1daeSBarry Smith +  e - integer associated with the event obtained from PetscLogEventRegister()
9375c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
9385c6c1daeSBarry Smith 
9395c6c1daeSBarry Smith 
9405c6c1daeSBarry Smith    Fortran Synopsis:
9415c6c1daeSBarry Smith    void PetscLogEventBegin(int e,PetscErrorCode ierr)
9425c6c1daeSBarry Smith 
9435c6c1daeSBarry Smith    Usage:
9445c6c1daeSBarry Smith .vb
9455c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
9465c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
9475c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
9485c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
9495c6c1daeSBarry Smith         [code segment to monitor]
9505c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
9515c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
9525c6c1daeSBarry Smith .ve
9535c6c1daeSBarry Smith 
9545c6c1daeSBarry Smith    Notes:
9555c6c1daeSBarry Smith    You need to register each integer event with the command
9565c6c1daeSBarry Smith    PetscLogEventRegister().  The source code must be compiled with
9575c6c1daeSBarry Smith    -DPETSC_USE_LOG, which is the default.
9585c6c1daeSBarry Smith 
9595c6c1daeSBarry Smith    PETSc automatically logs library events if the code has been
9605c6c1daeSBarry Smith    compiled with -DPETSC_USE_LOG, and -log, -log_summary, or -log_all are
9615c6c1daeSBarry Smith    specified.  PetscLogEventBegin() is intended for logging user events
9625c6c1daeSBarry Smith    to supplement this PETSc information.
9635c6c1daeSBarry Smith 
9645c6c1daeSBarry Smith    Level: intermediate
9655c6c1daeSBarry Smith 
9665c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops()
9675c6c1daeSBarry Smith 
9685c6c1daeSBarry Smith .keywords: log, event, begin
9695c6c1daeSBarry Smith M*/
9705c6c1daeSBarry Smith 
9715c6c1daeSBarry Smith /*MC
9725c6c1daeSBarry Smith    PetscLogEventEnd - Log the end of a user event.
9735c6c1daeSBarry Smith 
9745c6c1daeSBarry Smith    Synopsis:
975f2ba6396SBarry Smith    #include "petsclog.h"
976f2ba6396SBarry Smith    PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4)
9775c6c1daeSBarry Smith 
9785c6c1daeSBarry Smith    Not Collective
9795c6c1daeSBarry Smith 
9805c6c1daeSBarry Smith    Input Parameters:
9815c6c1daeSBarry Smith +  e - integer associated with the event obtained with PetscLogEventRegister()
9825c6c1daeSBarry Smith -  o1,o2,o3,o4 - objects associated with the event, or 0
9835c6c1daeSBarry Smith 
9845c6c1daeSBarry Smith 
9855c6c1daeSBarry Smith    Fortran Synopsis:
9865c6c1daeSBarry Smith    void PetscLogEventEnd(int e,PetscErrorCode ierr)
9875c6c1daeSBarry Smith 
9885c6c1daeSBarry Smith    Usage:
9895c6c1daeSBarry Smith .vb
9905c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
9915c6c1daeSBarry Smith      PetscLogDouble user_event_flops;
9925c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT,);
9935c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
9945c6c1daeSBarry Smith         [code segment to monitor]
9955c6c1daeSBarry Smith         PetscLogFlops(user_event_flops);
9965c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
9975c6c1daeSBarry Smith .ve
9985c6c1daeSBarry Smith 
9995c6c1daeSBarry Smith    Notes:
10005c6c1daeSBarry Smith    You should also register each additional integer event with the command
10015c6c1daeSBarry Smith    PetscLogEventRegister(). Source code must be compiled with
10025c6c1daeSBarry Smith    -DPETSC_USE_LOG, which is the default.
10035c6c1daeSBarry Smith 
10045c6c1daeSBarry Smith    PETSc automatically logs library events if the code has been
10055c6c1daeSBarry Smith    compiled with -DPETSC_USE_LOG, and -log, -log_summary, or -log_all are
10065c6c1daeSBarry Smith    specified.  PetscLogEventEnd() is intended for logging user events
10075c6c1daeSBarry Smith    to supplement this PETSc information.
10085c6c1daeSBarry Smith 
10095c6c1daeSBarry Smith    Level: intermediate
10105c6c1daeSBarry Smith 
10115c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogFlops()
10125c6c1daeSBarry Smith 
10135c6c1daeSBarry Smith .keywords: log, event, end
10145c6c1daeSBarry Smith M*/
10155c6c1daeSBarry Smith 
10165c6c1daeSBarry Smith /*MC
10175c6c1daeSBarry Smith    PetscLogEventBarrierBegin - Logs the time in a barrier before an event.
10185c6c1daeSBarry Smith 
10195c6c1daeSBarry Smith    Synopsis:
1020f2ba6396SBarry Smith    #include "petsclog.h"
1021f2ba6396SBarry Smith    PetscErrorCode PetscLogEventBarrierBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4,MPI_Comm comm)
10225c6c1daeSBarry Smith 
10235c6c1daeSBarry Smith    Not Collective
10245c6c1daeSBarry Smith 
10255c6c1daeSBarry Smith    Input Parameters:
10265c6c1daeSBarry Smith .  e - integer associated with the event obtained from PetscLogEventRegister()
10275c6c1daeSBarry Smith .  o1,o2,o3,o4 - objects associated with the event, or 0
10285c6c1daeSBarry Smith .  comm - communicator the barrier takes place over
10295c6c1daeSBarry Smith 
10305c6c1daeSBarry Smith 
10315c6c1daeSBarry Smith    Usage:
10325c6c1daeSBarry Smith .vb
10335c6c1daeSBarry Smith      PetscLogEventBarrierBegin(VEC_NormBarrier,0,0,0,0,comm);
10345c6c1daeSBarry Smith        MPI_Allreduce()
10355c6c1daeSBarry Smith      PetscLogEventBarrierEnd(VEC_NormBarrier,0,0,0,0,comm);
10365c6c1daeSBarry Smith .ve
10375c6c1daeSBarry Smith 
10385c6c1daeSBarry Smith    Notes:
10395c6c1daeSBarry Smith    This is for logging the amount of time spent in a barrier for an event
10405c6c1daeSBarry Smith    that requires synchronization.
10415c6c1daeSBarry Smith 
10425c6c1daeSBarry Smith    Additional Notes:
10435c6c1daeSBarry Smith    Synchronization events always come in pairs; for example, VEC_NormBarrier and
10445c6c1daeSBarry Smith    VEC_NormComm = VEC_NormBarrier + 1
10455c6c1daeSBarry Smith 
10465c6c1daeSBarry Smith    Level: advanced
10475c6c1daeSBarry Smith 
10485c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops(), PetscLogEventBegin(),
10495c6c1daeSBarry Smith           PetscLogEventBarrierEnd()
10505c6c1daeSBarry Smith 
10515c6c1daeSBarry Smith .keywords: log, event, begin, barrier
10525c6c1daeSBarry Smith M*/
10535c6c1daeSBarry Smith 
10545c6c1daeSBarry Smith /*MC
10555c6c1daeSBarry Smith    PetscLogEventBarrierEnd - Logs the time in a barrier before an event.
10565c6c1daeSBarry Smith 
10575c6c1daeSBarry Smith    Synopsis:
1058f2ba6396SBarry Smith    #include "petsclog.h"
1059f2ba6396SBarry Smith    PetscErrorCode PetscLogEventBarrierEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4,MPI_Comm comm)
10605c6c1daeSBarry Smith 
10615c6c1daeSBarry Smith    Logically Collective on MPI_Comm
10625c6c1daeSBarry Smith 
10635c6c1daeSBarry Smith    Input Parameters:
10645c6c1daeSBarry Smith .  e - integer associated with the event obtained from PetscLogEventRegister()
10655c6c1daeSBarry Smith .  o1,o2,o3,o4 - objects associated with the event, or 0
10665c6c1daeSBarry Smith .  comm - communicator the barrier takes place over
10675c6c1daeSBarry Smith 
10685c6c1daeSBarry Smith 
10695c6c1daeSBarry Smith     Usage:
10705c6c1daeSBarry Smith .vb
10715c6c1daeSBarry Smith      PetscLogEventBarrierBegin(VEC_NormBarrier,0,0,0,0,comm);
10725c6c1daeSBarry Smith        MPI_Allreduce()
10735c6c1daeSBarry Smith      PetscLogEventBarrierEnd(VEC_NormBarrier,0,0,0,0,comm);
10745c6c1daeSBarry Smith .ve
10755c6c1daeSBarry Smith 
10765c6c1daeSBarry Smith    Notes:
10775c6c1daeSBarry Smith    This is for logging the amount of time spent in a barrier for an event
10785c6c1daeSBarry Smith    that requires synchronization.
10795c6c1daeSBarry Smith 
10805c6c1daeSBarry Smith    Additional Notes:
10815c6c1daeSBarry Smith    Synchronization events always come in pairs; for example, VEC_NormBarrier and
10825c6c1daeSBarry Smith    VEC_NormComm = VEC_NormBarrier + 1
10835c6c1daeSBarry Smith 
10845c6c1daeSBarry Smith    Level: advanced
10855c6c1daeSBarry Smith 
10865c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops(), PetscLogEventBegin(),
10875c6c1daeSBarry Smith           PetscLogEventBarrierBegin()
10885c6c1daeSBarry Smith 
10895c6c1daeSBarry Smith .keywords: log, event, begin, barrier
10905c6c1daeSBarry Smith M*/
10915c6c1daeSBarry Smith 
10925c6c1daeSBarry Smith #undef __FUNCT__
10935c6c1daeSBarry Smith #define __FUNCT__ "PetscLogEventGetId"
10945c6c1daeSBarry Smith /*@C
10955c6c1daeSBarry Smith   PetscLogEventGetId - Returns the event id when given the event name.
10965c6c1daeSBarry Smith 
10975c6c1daeSBarry Smith   Not Collective
10985c6c1daeSBarry Smith 
10995c6c1daeSBarry Smith   Input Parameter:
11005c6c1daeSBarry Smith . name  - The event name
11015c6c1daeSBarry Smith 
11025c6c1daeSBarry Smith   Output Parameter:
11035c6c1daeSBarry Smith . event - The event
11045c6c1daeSBarry Smith 
11055c6c1daeSBarry Smith   Level: intermediate
11065c6c1daeSBarry Smith 
11075c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStageGetId()
11085c6c1daeSBarry Smith @*/
11095c6c1daeSBarry Smith PetscErrorCode  PetscLogEventGetId(const char name[], PetscLogEvent *event)
11105c6c1daeSBarry Smith {
11115c6c1daeSBarry Smith   PetscStageLog  stageLog;
11125c6c1daeSBarry Smith   PetscErrorCode ierr;
11135c6c1daeSBarry Smith 
11145c6c1daeSBarry Smith   PetscFunctionBegin;
11155c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
11165c6c1daeSBarry Smith   ierr = EventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr);
11175c6c1daeSBarry Smith   PetscFunctionReturn(0);
11185c6c1daeSBarry Smith }
11195c6c1daeSBarry Smith 
11205c6c1daeSBarry Smith 
11215c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/
11225c6c1daeSBarry Smith #undef __FUNCT__
11235c6c1daeSBarry Smith #define __FUNCT__ "PetscLogDump"
11245c6c1daeSBarry Smith /*@C
11255c6c1daeSBarry Smith   PetscLogDump - Dumps logs of objects to a file. This file is intended to
11265c6c1daeSBarry Smith   be read by bin/petscview. This program no longer exists.
11275c6c1daeSBarry Smith 
11285c6c1daeSBarry Smith   Collective on PETSC_COMM_WORLD
11295c6c1daeSBarry Smith 
11305c6c1daeSBarry Smith   Input Parameter:
11315c6c1daeSBarry Smith . name - an optional file name
11325c6c1daeSBarry Smith 
11335c6c1daeSBarry Smith   Options Database Keys:
11345c6c1daeSBarry Smith + -log     - Prints basic log information (for code compiled with PETSC_USE_LOG)
11355c6c1daeSBarry Smith - -log_all - Prints extensive log information (for code compiled with PETSC_USE_LOG)
11365c6c1daeSBarry Smith 
11375c6c1daeSBarry Smith   Usage:
11385c6c1daeSBarry Smith .vb
11395c6c1daeSBarry Smith      PetscInitialize(...);
11405c6c1daeSBarry Smith      PetscLogBegin(); or PetscLogAllBegin();
11415c6c1daeSBarry Smith      ... code ...
11425c6c1daeSBarry Smith      PetscLogDump(filename);
11435c6c1daeSBarry Smith      PetscFinalize();
11445c6c1daeSBarry Smith .ve
11455c6c1daeSBarry Smith 
11465c6c1daeSBarry Smith   Notes:
11475c6c1daeSBarry Smith   The default file name is
11485c6c1daeSBarry Smith $    Log.<rank>
11495c6c1daeSBarry Smith   where <rank> is the processor number. If no name is specified,
11505c6c1daeSBarry Smith   this file will be used.
11515c6c1daeSBarry Smith 
11525c6c1daeSBarry Smith   Level: advanced
11535c6c1daeSBarry Smith 
11545c6c1daeSBarry Smith .keywords: log, dump
11555c6c1daeSBarry Smith .seealso: PetscLogBegin(), PetscLogAllBegin(), PetscLogView()
11565c6c1daeSBarry Smith @*/
11575c6c1daeSBarry Smith PetscErrorCode  PetscLogDump(const char sname[])
11585c6c1daeSBarry Smith {
11595c6c1daeSBarry Smith   PetscStageLog      stageLog;
11605c6c1daeSBarry Smith   PetscEventPerfInfo *eventInfo;
11615c6c1daeSBarry Smith   FILE               *fd;
11625c6c1daeSBarry Smith   char               file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN];
11635c6c1daeSBarry Smith   PetscLogDouble     flops, _TotalTime;
11645c6c1daeSBarry Smith   PetscMPIInt        rank;
11655c6c1daeSBarry Smith   int                action, object, curStage;
11665c6c1daeSBarry Smith   PetscLogEvent      event;
11675c6c1daeSBarry Smith   PetscErrorCode     ierr;
11685c6c1daeSBarry Smith 
11695c6c1daeSBarry Smith   PetscFunctionBegin;
11705c6c1daeSBarry Smith   /* Calculate the total elapsed time */
11718563dfccSBarry Smith   PetscTime(&_TotalTime);
11725c6c1daeSBarry Smith   _TotalTime -= petsc_BaseTime;
11735c6c1daeSBarry Smith   /* Open log file */
11745c6c1daeSBarry Smith   ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank);CHKERRQ(ierr);
1175a297a907SKarl Rupp   if (sname) sprintf(file, "%s.%d", sname, rank);
1176a297a907SKarl Rupp   else sprintf(file, "Log.%d", rank);
11775c6c1daeSBarry Smith   ierr = PetscFixFilename(file, fname);CHKERRQ(ierr);
11785c6c1daeSBarry Smith   ierr = PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd);CHKERRQ(ierr);
11795c6c1daeSBarry Smith   if ((!rank) && (!fd)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname);
11805c6c1daeSBarry Smith   /* Output totals */
1181a2ea699eSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flops %14e %16.8e\n", petsc_TotalFlops, _TotalTime);CHKERRQ(ierr);
1182a2ea699eSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0);CHKERRQ(ierr);
11835c6c1daeSBarry Smith   /* Output actions */
11845c6c1daeSBarry Smith   if (petsc_logActions) {
1185a2ea699eSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions);CHKERRQ(ierr);
11865c6c1daeSBarry Smith     for (action = 0; action < petsc_numActions; action++) {
11875c6c1daeSBarry Smith       ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n",
11885c6c1daeSBarry Smith                           petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1,
1189a2ea699eSBarry Smith                           petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem);CHKERRQ(ierr);
11905c6c1daeSBarry Smith     }
11915c6c1daeSBarry Smith   }
11925c6c1daeSBarry Smith   /* Output objects */
11935c6c1daeSBarry Smith   if (petsc_logObjects) {
1194a2ea699eSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed);CHKERRQ(ierr);
11955c6c1daeSBarry Smith     for (object = 0; object < petsc_numObjects; object++) {
1196a2ea699eSBarry Smith       ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int) petsc_objects[object].mem);CHKERRQ(ierr);
11975c6c1daeSBarry Smith       if (!petsc_objects[object].name[0]) {
1198a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd,"No Name\n");CHKERRQ(ierr);
11995c6c1daeSBarry Smith       } else {
1200a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name);CHKERRQ(ierr);
12015c6c1daeSBarry Smith       }
12025c6c1daeSBarry Smith       if (petsc_objects[object].info[0] != 0) {
1203a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n");CHKERRQ(ierr);
12045c6c1daeSBarry Smith       } else {
1205a2ea699eSBarry Smith         ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info);CHKERRQ(ierr);
12065c6c1daeSBarry Smith       }
12075c6c1daeSBarry Smith     }
12085c6c1daeSBarry Smith   }
12095c6c1daeSBarry Smith   /* Output events */
1210a2ea699eSBarry Smith   ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n");CHKERRQ(ierr);
12115c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
12125c6c1daeSBarry Smith   ierr = PetscIntStackTop(stageLog->stack, &curStage);CHKERRQ(ierr);
12135c6c1daeSBarry Smith   eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo;
12145c6c1daeSBarry Smith   for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) {
1215a297a907SKarl Rupp     if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops/eventInfo[event].time;
1216a297a907SKarl Rupp     else flops = 0.0;
12175c6c1daeSBarry Smith     ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count,
1218a2ea699eSBarry Smith                         eventInfo[event].flops, eventInfo[event].time, flops);CHKERRQ(ierr);
12195c6c1daeSBarry Smith   }
12205c6c1daeSBarry Smith   ierr = PetscFClose(PETSC_COMM_WORLD, fd);CHKERRQ(ierr);
12215c6c1daeSBarry Smith   PetscFunctionReturn(0);
12225c6c1daeSBarry Smith }
12235c6c1daeSBarry Smith 
12245c6c1daeSBarry Smith #undef __FUNCT__
12255c6c1daeSBarry Smith #define __FUNCT__ "PetscLogView"
12265c6c1daeSBarry Smith /*@C
12275c6c1daeSBarry Smith   PetscLogViewer - Prints a summary of the logging.
12285c6c1daeSBarry Smith 
12295c6c1daeSBarry Smith   Collective over MPI_Comm
12305c6c1daeSBarry Smith 
12315c6c1daeSBarry Smith   Input Parameter:
12325c6c1daeSBarry Smith .  viewer - an ASCII viewer
12335c6c1daeSBarry Smith 
12345c6c1daeSBarry Smith   Options Database Keys:
12355c6c1daeSBarry Smith . -log_summary - Prints summary of log information (for code compiled with PETSC_USE_LOG)
12365c6c1daeSBarry Smith 
12375c6c1daeSBarry Smith   Usage:
12385c6c1daeSBarry Smith .vb
12395c6c1daeSBarry Smith      PetscInitialize(...);
12405c6c1daeSBarry Smith      PetscLogBegin();
12415c6c1daeSBarry Smith      ... code ...
12425c6c1daeSBarry Smith      PetscLogView(PetscViewer);
12435c6c1daeSBarry Smith      PetscFinalize(...);
12445c6c1daeSBarry Smith .ve
12455c6c1daeSBarry Smith 
12465c6c1daeSBarry Smith   Notes:
12475c6c1daeSBarry Smith   By default the summary is printed to stdout.
12485c6c1daeSBarry Smith 
12495c6c1daeSBarry Smith   Level: beginner
12505c6c1daeSBarry Smith 
12515c6c1daeSBarry Smith .keywords: log, dump, print
12525c6c1daeSBarry Smith .seealso: PetscLogBegin(), PetscLogDump()
12535c6c1daeSBarry Smith @*/
12545c6c1daeSBarry Smith PetscErrorCode  PetscLogView(PetscViewer viewer)
12555c6c1daeSBarry Smith {
12565c6c1daeSBarry Smith   FILE               *fd;
12575c6c1daeSBarry Smith   PetscLogDouble     zero       = 0.0;
12585c6c1daeSBarry Smith   PetscStageLog      stageLog;
12590298fd71SBarry Smith   PetscStageInfo     *stageInfo = NULL;
12600298fd71SBarry Smith   PetscEventPerfInfo *eventInfo = NULL;
12615c6c1daeSBarry Smith   PetscClassPerfInfo *classInfo;
12625c6c1daeSBarry Smith   char               arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128];
12635c6c1daeSBarry Smith   const char         *name;
12645c6c1daeSBarry Smith   PetscLogDouble     locTotalTime, TotalTime, TotalFlops;
12655c6c1daeSBarry Smith   PetscLogDouble     numMessages, messageLength, avgMessLen, numReductions;
12665c6c1daeSBarry Smith   PetscLogDouble     stageTime, flops, flopr, mem, mess, messLen, red;
12675c6c1daeSBarry Smith   PetscLogDouble     fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed;
12685c6c1daeSBarry Smith   PetscLogDouble     fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed;
12695c6c1daeSBarry Smith   PetscLogDouble     min, max, tot, ratio, avg, x, y;
12705c6c1daeSBarry Smith   PetscLogDouble     minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratCt, totm, totml, totr;
12715c6c1daeSBarry Smith   PetscMPIInt        minCt, maxCt;
12725c6c1daeSBarry Smith   PetscMPIInt        size, rank;
12735c6c1daeSBarry Smith   PetscBool          *localStageUsed,    *stageUsed;
12745c6c1daeSBarry Smith   PetscBool          *localStageVisible, *stageVisible;
12755c6c1daeSBarry Smith   int                numStages, localNumEvents, numEvents;
12765c6c1daeSBarry Smith   int                stage, lastStage, oclass;
12775c6c1daeSBarry Smith   PetscLogEvent      event;
12785c6c1daeSBarry Smith   PetscErrorCode     ierr;
12795c6c1daeSBarry Smith   char               version[256];
12805c6c1daeSBarry Smith   MPI_Comm           comm;
12815c6c1daeSBarry Smith   PetscInt           nthreads;
12825c6c1daeSBarry Smith 
12835c6c1daeSBarry Smith   PetscFunctionBegin;
12845c6c1daeSBarry Smith   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
12853cec8029SMatthew G Knepley   if (!PetscLogBegin_PrivateCalled) SETERRQ(comm, PETSC_ERR_ORDER, "No call to PetscLogBegin() before PetscLogView()");
12865c6c1daeSBarry Smith   ierr = PetscViewerASCIIGetPointer(viewer,&fd);CHKERRQ(ierr);
12875c6c1daeSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
12885c6c1daeSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
12895c6c1daeSBarry Smith   /* Pop off any stages the user forgot to remove */
12905c6c1daeSBarry Smith   lastStage = 0;
12915c6c1daeSBarry Smith   ierr      = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
12925c6c1daeSBarry Smith   ierr      = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
12935c6c1daeSBarry Smith   while (stage >= 0) {
12945c6c1daeSBarry Smith     lastStage = stage;
12955c6c1daeSBarry Smith     ierr      = PetscStageLogPop(stageLog);CHKERRQ(ierr);
12965c6c1daeSBarry Smith     ierr      = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
12975c6c1daeSBarry Smith   }
12985c6c1daeSBarry Smith   /* Get the total elapsed time */
12998563dfccSBarry Smith   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
13005c6c1daeSBarry Smith 
13015c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr);
13025c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "***             WIDEN YOUR WINDOW TO 120 CHARACTERS.  Use 'enscript -r -fCourier9' to print this document            ***\n");CHKERRQ(ierr);
13035c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr);
13045c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n---------------------------------------------- PETSc Performance Summary: ----------------------------------------------\n\n");CHKERRQ(ierr);
13055c6c1daeSBarry Smith   ierr = PetscGetArchType(arch,sizeof(arch));CHKERRQ(ierr);
13065c6c1daeSBarry Smith   ierr = PetscGetHostName(hostname,sizeof(hostname));CHKERRQ(ierr);
13075c6c1daeSBarry Smith   ierr = PetscGetUserName(username,sizeof(username));CHKERRQ(ierr);
13085c6c1daeSBarry Smith   ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr);
13095c6c1daeSBarry Smith   ierr = PetscGetDate(date,sizeof(date));CHKERRQ(ierr);
13105c6c1daeSBarry Smith   ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr);
13115c6c1daeSBarry Smith   if (size == 1) {
13125c6c1daeSBarry 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);
13135c6c1daeSBarry Smith   } else {
13145c6c1daeSBarry 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);
13155c6c1daeSBarry Smith   }
13165c6c1daeSBarry Smith   ierr = PetscThreadCommGetNThreads(PETSC_COMM_WORLD,&nthreads);CHKERRQ(ierr);
13175c6c1daeSBarry Smith   if (nthreads > 1) {
13185c6c1daeSBarry Smith     ierr = PetscFPrintf(comm,fd,"With %d threads per MPI_Comm\n", (int)nthreads);CHKERRQ(ierr);
13195c6c1daeSBarry Smith   }
13205c6c1daeSBarry Smith 
13215c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Using %s\n", version);CHKERRQ(ierr);
13225c6c1daeSBarry Smith 
13235c6c1daeSBarry Smith   /* Must preserve reduction count before we go on */
13245c6c1daeSBarry Smith   red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct;
13255c6c1daeSBarry Smith 
13265c6c1daeSBarry Smith   /* Calculate summary information */
13275c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n                         Max       Max/Min        Avg      Total \n");CHKERRQ(ierr);
13285c6c1daeSBarry Smith   /*   Time */
13295c6c1daeSBarry Smith   ierr = MPI_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
13305c6c1daeSBarry Smith   ierr = MPI_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
13315c6c1daeSBarry Smith   ierr = MPI_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
13325c6c1daeSBarry Smith   avg  = (tot)/((PetscLogDouble) size);
1333a297a907SKarl Rupp   if (min != 0.0) ratio = max/min;
1334a297a907SKarl Rupp   else ratio = 0.0;
13355c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Time (sec):           %5.3e   %10.5f   %5.3e\n", max, ratio, avg);CHKERRQ(ierr);
13365c6c1daeSBarry Smith   TotalTime = tot;
13375c6c1daeSBarry Smith   /*   Objects */
13385c6c1daeSBarry Smith   avg  = (PetscLogDouble) petsc_numObjects;
13395c6c1daeSBarry Smith   ierr = MPI_Allreduce(&avg,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
13405c6c1daeSBarry Smith   ierr = MPI_Allreduce(&avg,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
13415c6c1daeSBarry Smith   ierr = MPI_Allreduce(&avg,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
13425c6c1daeSBarry Smith   avg  = (tot)/((PetscLogDouble) size);
1343a297a907SKarl Rupp   if (min != 0.0) ratio = max/min;
1344a297a907SKarl Rupp   else ratio = 0.0;
13455c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Objects:              %5.3e   %10.5f   %5.3e\n", max, ratio, avg);CHKERRQ(ierr);
13465c6c1daeSBarry Smith   /*   Flops */
13475c6c1daeSBarry Smith   ierr = MPI_Allreduce(&petsc_TotalFlops,  &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
13485c6c1daeSBarry Smith   ierr = MPI_Allreduce(&petsc_TotalFlops,  &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
13495c6c1daeSBarry Smith   ierr = MPI_Allreduce(&petsc_TotalFlops,  &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
13505c6c1daeSBarry Smith   avg  = (tot)/((PetscLogDouble) size);
1351a297a907SKarl Rupp   if (min != 0.0) ratio = max/min;
1352a297a907SKarl Rupp   else ratio = 0.0;
13535c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Flops:                %5.3e   %10.5f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
13545c6c1daeSBarry Smith   TotalFlops = tot;
13555c6c1daeSBarry Smith   /*   Flops/sec -- Must talk to Barry here */
1356a297a907SKarl Rupp   if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime;
1357a297a907SKarl Rupp   else flops = 0.0;
13585c6c1daeSBarry Smith   ierr = MPI_Allreduce(&flops,        &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
13595c6c1daeSBarry Smith   ierr = MPI_Allreduce(&flops,        &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
13605c6c1daeSBarry Smith   ierr = MPI_Allreduce(&flops,        &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
13615c6c1daeSBarry Smith   avg  = (tot)/((PetscLogDouble) size);
1362a297a907SKarl Rupp   if (min != 0.0) ratio = max/min;
1363a297a907SKarl Rupp   else ratio = 0.0;
13645c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Flops/sec:            %5.3e   %10.5f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
13655c6c1daeSBarry Smith   /*   Memory */
13665c6c1daeSBarry Smith   ierr = PetscMallocGetMaximumUsage(&mem);CHKERRQ(ierr);
13675c6c1daeSBarry Smith   if (mem > 0.0) {
13685c6c1daeSBarry Smith     ierr = MPI_Allreduce(&mem,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
13695c6c1daeSBarry Smith     ierr = MPI_Allreduce(&mem,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
13705c6c1daeSBarry Smith     ierr = MPI_Allreduce(&mem,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
13715c6c1daeSBarry Smith     avg  = (tot)/((PetscLogDouble) size);
1372a297a907SKarl Rupp     if (min != 0.0) ratio = max/min;
1373a297a907SKarl Rupp     else ratio = 0.0;
13745c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "Memory:               %5.3e   %10.5f              %5.3e\n", max, ratio, tot);CHKERRQ(ierr);
13755c6c1daeSBarry Smith   }
13765c6c1daeSBarry Smith   /*   Messages */
13775c6c1daeSBarry Smith   mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct);
13785c6c1daeSBarry Smith   ierr = MPI_Allreduce(&mess,         &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
13795c6c1daeSBarry Smith   ierr = MPI_Allreduce(&mess,         &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
13805c6c1daeSBarry Smith   ierr = MPI_Allreduce(&mess,         &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
13815c6c1daeSBarry Smith   avg  = (tot)/((PetscLogDouble) size);
1382a297a907SKarl Rupp   if (min != 0.0) ratio = max/min;
1383a297a907SKarl Rupp   else ratio = 0.0;
13845c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "MPI Messages:         %5.3e   %10.5f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
13855c6c1daeSBarry Smith   numMessages = tot;
13865c6c1daeSBarry Smith   /*   Message Lengths */
13875c6c1daeSBarry Smith   mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len);
13885c6c1daeSBarry Smith   ierr = MPI_Allreduce(&mess,         &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
13895c6c1daeSBarry Smith   ierr = MPI_Allreduce(&mess,         &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
13905c6c1daeSBarry Smith   ierr = MPI_Allreduce(&mess,         &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1391a297a907SKarl Rupp   if (numMessages != 0) avg = (tot)/(numMessages);
1392a297a907SKarl Rupp   else avg = 0.0;
1393a297a907SKarl Rupp   if (min != 0.0) ratio = max/min;
1394a297a907SKarl Rupp   else ratio = 0.0;
13955c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "MPI Message Lengths:  %5.3e   %10.5f   %5.3e  %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr);
13965c6c1daeSBarry Smith   messageLength = tot;
13975c6c1daeSBarry Smith   /*   Reductions */
13985c6c1daeSBarry Smith   ierr = MPI_Allreduce(&red,          &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
13995c6c1daeSBarry Smith   ierr = MPI_Allreduce(&red,          &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
14005c6c1daeSBarry Smith   ierr = MPI_Allreduce(&red,          &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
1401a297a907SKarl Rupp   if (min != 0.0) ratio = max/min;
1402a297a907SKarl Rupp   else ratio = 0.0;
14035c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "MPI Reductions:       %5.3e   %10.5f\n", max, ratio);CHKERRQ(ierr);
14045c6c1daeSBarry Smith   numReductions = red; /* wrong because uses count from process zero */
14055c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n");CHKERRQ(ierr);
14065c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "                            e.g., VecAXPY() for real vectors of length N --> 2N flops\n");CHKERRQ(ierr);
14075c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "                            and VecAXPY() for complex vectors of length N --> 8N flops\n");CHKERRQ(ierr);
14085c6c1daeSBarry Smith 
14095c6c1daeSBarry Smith   /* Get total number of stages --
14105c6c1daeSBarry Smith        Currently, a single processor can register more stages than another, but stages must all be registered in order.
14115c6c1daeSBarry Smith        We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID.
14125c6c1daeSBarry Smith        This seems best accomplished by assoicating a communicator with each stage.
14135c6c1daeSBarry Smith   */
14145c6c1daeSBarry Smith   ierr = MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
1415*785e854fSJed Brown   ierr = PetscMalloc1(numStages, &localStageUsed);CHKERRQ(ierr);
1416*785e854fSJed Brown   ierr = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr);
1417*785e854fSJed Brown   ierr = PetscMalloc1(numStages, &localStageVisible);CHKERRQ(ierr);
1418*785e854fSJed Brown   ierr = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr);
14195c6c1daeSBarry Smith   if (numStages > 0) {
14205c6c1daeSBarry Smith     stageInfo = stageLog->stageInfo;
14215c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
14225c6c1daeSBarry Smith       if (stage < stageLog->numStages) {
14235c6c1daeSBarry Smith         localStageUsed[stage]    = stageInfo[stage].used;
14245c6c1daeSBarry Smith         localStageVisible[stage] = stageInfo[stage].perfInfo.visible;
14255c6c1daeSBarry Smith       } else {
14265c6c1daeSBarry Smith         localStageUsed[stage]    = PETSC_FALSE;
14275c6c1daeSBarry Smith         localStageVisible[stage] = PETSC_TRUE;
14285c6c1daeSBarry Smith       }
14295c6c1daeSBarry Smith     }
1430c3aae356SJed Brown     ierr = MPI_Allreduce(localStageUsed,    stageUsed,    numStages, MPIU_BOOL, MPI_LOR,  comm);CHKERRQ(ierr);
1431c3aae356SJed Brown     ierr = MPI_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr);
14325c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
14335c6c1daeSBarry Smith       if (stageUsed[stage]) {
14345c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd, "\nSummary of Stages:   ----- Time ------  ----- Flops -----  --- Messages ---  -- Message Lengths --  -- Reductions --\n");CHKERRQ(ierr);
14355c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd, "                        Avg     %%Total     Avg     %%Total   counts   %%Total     Avg         %%Total   counts   %%Total \n");CHKERRQ(ierr);
14365c6c1daeSBarry Smith         break;
14375c6c1daeSBarry Smith       }
14385c6c1daeSBarry Smith     }
14395c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
14405c6c1daeSBarry Smith       if (!stageUsed[stage]) continue;
14415c6c1daeSBarry Smith       if (localStageUsed[stage]) {
14425c6c1daeSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14435c6c1daeSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14445c6c1daeSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14455c6c1daeSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14465c6c1daeSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14475c6c1daeSBarry Smith         name = stageInfo[stage].name;
14485c6c1daeSBarry Smith       } else {
14495c6c1daeSBarry Smith         ierr = MPI_Allreduce(&zero,                           &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14505c6c1daeSBarry Smith         ierr = MPI_Allreduce(&zero,                           &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14515c6c1daeSBarry Smith         ierr = MPI_Allreduce(&zero,                           &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14525c6c1daeSBarry Smith         ierr = MPI_Allreduce(&zero,                           &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14535c6c1daeSBarry Smith         ierr = MPI_Allreduce(&zero,                           &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
14545c6c1daeSBarry Smith         name = "";
14555c6c1daeSBarry Smith       }
14565c6c1daeSBarry Smith       mess *= 0.5; messLen *= 0.5; red /= size;
14575c6c1daeSBarry Smith       if (TotalTime     != 0.0) fracTime       = stageTime/TotalTime;    else fracTime       = 0.0;
14585c6c1daeSBarry Smith       if (TotalFlops    != 0.0) fracFlops      = flops/TotalFlops;       else fracFlops      = 0.0;
14595c6c1daeSBarry Smith       /* Talk to Barry if (stageTime     != 0.0) flops          = (size*flops)/stageTime; else flops          = 0.0; */
14605c6c1daeSBarry Smith       if (numMessages   != 0.0) fracMessages   = mess/numMessages;       else fracMessages   = 0.0;
14615c6c1daeSBarry Smith       if (numMessages   != 0.0) avgMessLen     = messLen/numMessages;    else avgMessLen     = 0.0;
14625c6c1daeSBarry Smith       if (messageLength != 0.0) fracLength     = messLen/messageLength;  else fracLength     = 0.0;
14635c6c1daeSBarry Smith       if (numReductions != 0.0) fracReductions = red/numReductions;      else fracReductions = 0.0;
14645c6c1daeSBarry 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",
14655c6c1daeSBarry Smith                           stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops,
14665c6c1daeSBarry Smith                           mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr);
14675c6c1daeSBarry Smith     }
14685c6c1daeSBarry Smith   }
14695c6c1daeSBarry Smith 
1470806fa848SBarry Smith   ierr = PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
14715c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n");CHKERRQ(ierr);
14725c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Phase summary info:\n");CHKERRQ(ierr);
14735c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Count: number of times phase was executed\n");CHKERRQ(ierr);
14745c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Time and Flops: Max - maximum over all processors\n");CHKERRQ(ierr);
14755c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "                   Ratio - ratio of maximum to minimum over all processors\n");CHKERRQ(ierr);
14765c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Mess: number of messages sent\n");CHKERRQ(ierr);
1477dac490bdSJed Brown   ierr = PetscFPrintf(comm, fd, "   Avg. len: average message length (bytes)\n");CHKERRQ(ierr);
14785c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Reduct: number of global reductions\n");CHKERRQ(ierr);
14795c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Global: entire computation\n");CHKERRQ(ierr);
14805c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n");CHKERRQ(ierr);
14815c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%T - percent time in this phase         %%F - percent flops in this phase\n");CHKERRQ(ierr);
14825c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%M - percent messages in this phase     %%L - percent message lengths in this phase\n");CHKERRQ(ierr);
14835c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      %%R - percent reductions in this phase\n");CHKERRQ(ierr);
14845c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "   Total Mflop/s: 10e-6 * (sum of flops over all processors)/(max time over all processors)\n");CHKERRQ(ierr);
1485806fa848SBarry Smith   ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
14865c6c1daeSBarry Smith 
14875c6c1daeSBarry Smith #if defined(PETSC_USE_DEBUG)
14885c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr);
14895c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n");CHKERRQ(ierr);
14905c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
14915c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                          WARNING!!!                    #\n");CHKERRQ(ierr);
14925c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
14935c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   This code was compiled with a debugging option,      #\n");CHKERRQ(ierr);
14945c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   To get timing results run ./configure                #\n");CHKERRQ(ierr);
14955c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   using --with-debugging=no, the performance will      #\n");CHKERRQ(ierr);
14965c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   be generally two or three times faster.              #\n");CHKERRQ(ierr);
14975c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
14985c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n\n\n");CHKERRQ(ierr);
14995c6c1daeSBarry Smith #endif
15005c6c1daeSBarry Smith #if defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_FORTRAN_KERNELS)
15015c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr);
15025c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n");CHKERRQ(ierr);
15035c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
15045c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                          WARNING!!!                    #\n");CHKERRQ(ierr);
15055c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
15065c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   The code for various complex numbers numerical       #\n");CHKERRQ(ierr);
15075c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   kernels uses C++, which generally is not well        #\n");CHKERRQ(ierr);
15085c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   optimized.  For performance that is about 4-5 times  #\n");CHKERRQ(ierr);
15095c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   faster, specify --with-fortran-kernels=1             #\n");CHKERRQ(ierr);
15105c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #   when running ./configure.py.                         #\n");CHKERRQ(ierr);
15115c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      #                                                        #\n");CHKERRQ(ierr);
15125c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "      ##########################################################\n\n\n");CHKERRQ(ierr);
15135c6c1daeSBarry Smith #endif
15145c6c1daeSBarry Smith 
15155c6c1daeSBarry Smith   /* Report events */
1516806fa848SBarry Smith   ierr = PetscFPrintf(comm, fd,"Event                Count      Time (sec)     Flops                             --- Global ---  --- Stage ---   Total\n");CHKERRQ(ierr);
1517806fa848SBarry 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);
1518806fa848SBarry Smith   ierr = PetscFPrintf(comm,fd,"------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
15195c6c1daeSBarry Smith 
15205c6c1daeSBarry Smith   /* Problem: The stage name will not show up unless the stage executed on proc 1 */
15215c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
15225c6c1daeSBarry Smith     if (!stageVisible[stage]) continue;
15235c6c1daeSBarry Smith     if (localStageUsed[stage]) {
15245c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr);
15255c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15265c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15275c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15285c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15295c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15305c6c1daeSBarry Smith     } else {
15315c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr);
15325c6c1daeSBarry Smith       ierr = MPI_Allreduce(&zero,                           &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15335c6c1daeSBarry Smith       ierr = MPI_Allreduce(&zero,                           &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15345c6c1daeSBarry Smith       ierr = MPI_Allreduce(&zero,                           &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15355c6c1daeSBarry Smith       ierr = MPI_Allreduce(&zero,                           &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15365c6c1daeSBarry Smith       ierr = MPI_Allreduce(&zero,                           &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15375c6c1daeSBarry Smith     }
15385c6c1daeSBarry Smith     mess *= 0.5; messLen *= 0.5; red /= size;
15395c6c1daeSBarry Smith 
15405c6c1daeSBarry Smith     /* Get total number of events in this stage --
15415c6c1daeSBarry Smith        Currently, a single processor can register more events than another, but events must all be registered in order,
15425c6c1daeSBarry Smith        just like stages. We can removed this requirement if necessary by having a global event numbering and indirection
15435c6c1daeSBarry Smith        on the event ID. This seems best accomplished by assoicating a communicator with each stage.
15445c6c1daeSBarry Smith 
15455c6c1daeSBarry Smith        Problem: If the event did not happen on proc 1, its name will not be available.
15465c6c1daeSBarry Smith        Problem: Event visibility is not implemented
15475c6c1daeSBarry Smith     */
15485c6c1daeSBarry Smith     if (localStageUsed[stage]) {
15495c6c1daeSBarry Smith       eventInfo      = stageLog->stageInfo[stage].eventLog->eventInfo;
15505c6c1daeSBarry Smith       localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents;
1551a297a907SKarl Rupp     } else localNumEvents = 0;
15525c6c1daeSBarry Smith     ierr = MPI_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
15535c6c1daeSBarry Smith     for (event = 0; event < numEvents; event++) {
15545c6c1daeSBarry Smith       if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) {
1555a297a907SKarl Rupp         if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops;
1556a297a907SKarl Rupp         else flopr = 0.0;
1557a297a907SKarl Rupp 
15585c6c1daeSBarry Smith         ierr = MPI_Allreduce(&flopr,                          &minf,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
15595c6c1daeSBarry Smith         ierr = MPI_Allreduce(&flopr,                          &maxf,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
15605c6c1daeSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].flops,         &totf,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15615c6c1daeSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].time,          &mint,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
15625c6c1daeSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].time,          &maxt,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
15635c6c1daeSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].time,          &tott,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15645c6c1daeSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].numMessages,   &totm,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15655c6c1daeSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15665c6c1daeSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].numReductions, &totr,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15675c6c1daeSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].count,         &minCt, 1, MPI_INT,             MPI_MIN, comm);CHKERRQ(ierr);
15685c6c1daeSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].count,         &maxCt, 1, MPI_INT,             MPI_MAX, comm);CHKERRQ(ierr);
15695c6c1daeSBarry Smith         name = stageLog->eventLog->eventInfo[event].name;
15705c6c1daeSBarry Smith       } else {
15715c6c1daeSBarry Smith         flopr = 0.0;
15725c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&flopr,                          &minf,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
15735c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&flopr,                          &maxf,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
15745c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&zero,                           &totf,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15755c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&zero,                           &mint,  1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr);
15765c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&zero,                           &maxt,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr);
15775c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&zero,                           &tott,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15785c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&zero,                           &totm,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15795c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&zero,                           &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15805c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&zero,                           &totr,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
15815c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&ierr,                           &minCt, 1, MPI_INT,             MPI_MIN, comm);CHKERRQ(ierr);
15825c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&ierr,                           &maxCt, 1, MPI_INT,             MPI_MAX, comm);CHKERRQ(ierr);
15835c6c1daeSBarry Smith         name  = "";
15845c6c1daeSBarry Smith       }
15855c6c1daeSBarry Smith       if (mint < 0.0) {
15865c6c1daeSBarry 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);
15875c6c1daeSBarry Smith         mint = 0;
15885c6c1daeSBarry Smith       }
15895c6c1daeSBarry Smith       if (minf < 0.0) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Minimum flops %g over all processors for %s is negative! Not possible!",minf,name);
15905c6c1daeSBarry Smith       totm *= 0.5; totml *= 0.5; totr /= size;
15915c6c1daeSBarry Smith 
15925c6c1daeSBarry Smith       if (maxCt != 0) {
15935c6c1daeSBarry Smith         if (minCt         != 0)   ratCt            = ((PetscLogDouble) maxCt)/minCt; else ratCt            = 0.0;
15945c6c1daeSBarry Smith         if (mint          != 0.0) ratt             = maxt/mint;                  else ratt             = 0.0;
15955c6c1daeSBarry Smith         if (minf          != 0.0) ratf             = maxf/minf;                  else ratf             = 0.0;
15965c6c1daeSBarry Smith         if (TotalTime     != 0.0) fracTime         = tott/TotalTime;             else fracTime         = 0.0;
15975c6c1daeSBarry Smith         if (TotalFlops    != 0.0) fracFlops        = totf/TotalFlops;            else fracFlops        = 0.0;
15985c6c1daeSBarry Smith         if (stageTime     != 0.0) fracStageTime    = tott/stageTime;             else fracStageTime    = 0.0;
15995c6c1daeSBarry Smith         if (flops         != 0.0) fracStageFlops   = totf/flops;                 else fracStageFlops   = 0.0;
16005c6c1daeSBarry Smith         if (numMessages   != 0.0) fracMess         = totm/numMessages;           else fracMess         = 0.0;
16015c6c1daeSBarry Smith         if (messageLength != 0.0) fracMessLen      = totml/messageLength;        else fracMessLen      = 0.0;
16025c6c1daeSBarry Smith         if (numReductions != 0.0) fracRed          = totr/numReductions;         else fracRed          = 0.0;
16035c6c1daeSBarry Smith         if (mess          != 0.0) fracStageMess    = totm/mess;                  else fracStageMess    = 0.0;
16045c6c1daeSBarry Smith         if (messLen       != 0.0) fracStageMessLen = totml/messLen;              else fracStageMessLen = 0.0;
16055c6c1daeSBarry Smith         if (red           != 0.0) fracStageRed     = totr/red;                   else fracStageRed     = 0.0;
16065c6c1daeSBarry Smith         if (totm          != 0.0) totml           /= totm;                       else totml            = 0.0;
16075c6c1daeSBarry Smith         if (maxt          != 0.0) flopr            = totf/maxt;                  else flopr            = 0.0;
1608aefdf039SBarry Smith         if (fracStageTime > 1.00)  ierr = PetscFPrintf(comm, fd,"Warning -- total time of even greater than time of entire stage -- something is wrong with the timer\n");CHKERRQ(ierr);
16095c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd,
16105c6c1daeSBarry 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",
16115c6c1daeSBarry Smith                             name, maxCt, ratCt, maxt, ratt, maxf, ratf, totm, totml, totr,
16125c6c1daeSBarry Smith                             100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed,
16135c6c1daeSBarry Smith                             100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed,
16145c6c1daeSBarry Smith                             PetscAbsReal(flopr/1.0e6));CHKERRQ(ierr);
16155c6c1daeSBarry Smith       }
16165c6c1daeSBarry Smith     }
16175c6c1daeSBarry Smith   }
16185c6c1daeSBarry Smith 
16195c6c1daeSBarry Smith   /* Memory usage and object creation */
1620a297a907SKarl Rupp   ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr);
16215c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr);
16225c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n");CHKERRQ(ierr);
16235c6c1daeSBarry Smith 
16245c6c1daeSBarry Smith   /* Right now, only stages on the first processor are reported here, meaning only objects associated with
16255c6c1daeSBarry Smith      the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then
16265c6c1daeSBarry Smith      stats for stages local to processor sets.
16275c6c1daeSBarry Smith   */
16285c6c1daeSBarry Smith   /* We should figure out the longest object name here (now 20 characters) */
16295c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Object Type          Creations   Destructions     Memory  Descendants' Mem.\n");CHKERRQ(ierr);
16305c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Reports information only for process 0.\n");CHKERRQ(ierr);
16315c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
16325c6c1daeSBarry Smith     if (localStageUsed[stage]) {
16335c6c1daeSBarry Smith       classInfo = stageLog->stageInfo[stage].classLog->classInfo;
16345c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr);
16355c6c1daeSBarry Smith       for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) {
16365c6c1daeSBarry Smith         if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) {
16375c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "%20s %5d          %5d  %11.0f     %g\n", stageLog->classLog->classInfo[oclass].name,
16385c6c1daeSBarry Smith                               classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem,
16395c6c1daeSBarry Smith                               classInfo[oclass].descMem);CHKERRQ(ierr);
16405c6c1daeSBarry Smith         }
16415c6c1daeSBarry Smith       }
16425c6c1daeSBarry Smith     } else {
16435c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr);
16445c6c1daeSBarry Smith     }
16455c6c1daeSBarry Smith   }
16465c6c1daeSBarry Smith 
16475c6c1daeSBarry Smith   ierr = PetscFree(localStageUsed);CHKERRQ(ierr);
16485c6c1daeSBarry Smith   ierr = PetscFree(stageUsed);CHKERRQ(ierr);
16495c6c1daeSBarry Smith   ierr = PetscFree(localStageVisible);CHKERRQ(ierr);
16505c6c1daeSBarry Smith   ierr = PetscFree(stageVisible);CHKERRQ(ierr);
16515c6c1daeSBarry Smith 
16525c6c1daeSBarry Smith   /* Information unrelated to this particular run */
1653a297a907SKarl Rupp   ierr = PetscFPrintf(comm, fd, "========================================================================================================================\n");CHKERRQ(ierr);
16548563dfccSBarry Smith   PetscTime(&y);
16558563dfccSBarry Smith   PetscTime(&x);
16568563dfccSBarry Smith   PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y);
16578563dfccSBarry Smith   PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y);
16585c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0);CHKERRQ(ierr);
16595c6c1daeSBarry Smith   /* MPI information */
16605c6c1daeSBarry Smith   if (size > 1) {
16615c6c1daeSBarry Smith     MPI_Status  status;
16625c6c1daeSBarry Smith     PetscMPIInt tag;
16635c6c1daeSBarry Smith     MPI_Comm    newcomm;
16645c6c1daeSBarry Smith 
16655c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16668563dfccSBarry Smith     PetscTime(&x);
16675c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16685c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16695c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16705c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16715c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16728563dfccSBarry Smith     PetscTime(&y);
16735c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0);CHKERRQ(ierr);
16745c6c1daeSBarry Smith     ierr = PetscCommDuplicate(comm,&newcomm, &tag);CHKERRQ(ierr);
16755c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
16765c6c1daeSBarry Smith     if (rank) {
16775c6c1daeSBarry Smith       ierr = MPI_Recv(0, 0, MPI_INT, rank-1,            tag, newcomm, &status);CHKERRQ(ierr);
16785c6c1daeSBarry Smith       ierr = MPI_Send(0, 0, MPI_INT, (rank+1)%size, tag, newcomm);CHKERRQ(ierr);
16795c6c1daeSBarry Smith     } else {
16808563dfccSBarry Smith       PetscTime(&x);
16815c6c1daeSBarry Smith       ierr = MPI_Send(0, 0, MPI_INT, 1,          tag, newcomm);CHKERRQ(ierr);
16825c6c1daeSBarry Smith       ierr = MPI_Recv(0, 0, MPI_INT, size-1, tag, newcomm, &status);CHKERRQ(ierr);
16838563dfccSBarry Smith       PetscTime(&y);
16845c6c1daeSBarry Smith       ierr = PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size);CHKERRQ(ierr);
16855c6c1daeSBarry Smith     }
16865c6c1daeSBarry Smith     ierr = PetscCommDestroy(&newcomm);CHKERRQ(ierr);
16875c6c1daeSBarry Smith   }
16885c6c1daeSBarry Smith   ierr = PetscOptionsView(viewer);CHKERRQ(ierr);
16895c6c1daeSBarry Smith 
16905c6c1daeSBarry Smith   /* Machine and compile information */
16915c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS)
16925c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n");CHKERRQ(ierr);
16935c6c1daeSBarry Smith #else
16945c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n");CHKERRQ(ierr);
16955c6c1daeSBarry Smith #endif
16965c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE)
16975c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n");CHKERRQ(ierr);
16985c6c1daeSBarry Smith #elif defined(PETSC_USE_LONGDOUBLE)
16995c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with long double precision PetscScalar and PetscReal\n");CHKERRQ(ierr);
17005c6c1daeSBarry Smith #endif
17015c6c1daeSBarry Smith 
17025c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE)
17035c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with single precision matrices\n");CHKERRQ(ierr);
17045c6c1daeSBarry Smith #else
17055c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n");CHKERRQ(ierr);
17065c6c1daeSBarry Smith #endif
17075c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n",
17085c6c1daeSBarry Smith                       (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt));CHKERRQ(ierr);
17095c6c1daeSBarry Smith 
17105c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Configure run at: %s\n",petscconfigureruntime);CHKERRQ(ierr);
17115c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions);CHKERRQ(ierr);
17125c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petscmachineinfo);CHKERRQ(ierr);
17135c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsccompilerinfo);CHKERRQ(ierr);
17145c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo);CHKERRQ(ierr);
17155c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "%s", petsclinkerinfo);CHKERRQ(ierr);
17165c6c1daeSBarry Smith 
17175c6c1daeSBarry Smith   /* Cleanup */
17185c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr);
17195c6c1daeSBarry Smith   ierr = PetscStageLogPush(stageLog, lastStage);CHKERRQ(ierr);
17205c6c1daeSBarry Smith   PetscFunctionReturn(0);
17215c6c1daeSBarry Smith }
17225c6c1daeSBarry Smith 
17235c6c1daeSBarry Smith #undef __FUNCT__
17245c6c1daeSBarry Smith #define __FUNCT__ "PetscLogPrintDetailed"
17255c6c1daeSBarry Smith /*@C
17265c6c1daeSBarry Smith   PetscLogPrintDetailed - Each process prints the times for its own events
17275c6c1daeSBarry Smith 
17285c6c1daeSBarry Smith   Collective over MPI_Comm
17295c6c1daeSBarry Smith 
17305c6c1daeSBarry Smith   Input Parameter:
17315c6c1daeSBarry Smith + comm - The MPI communicator (only one processor prints output)
17325c6c1daeSBarry Smith - file - [Optional] The output file name
17335c6c1daeSBarry Smith 
17345c6c1daeSBarry Smith   Options Database Keys:
17355c6c1daeSBarry Smith . -log_summary_detailed - Prints summary of log information (for code compiled with PETSC_USE_LOG)
17365c6c1daeSBarry Smith 
17375c6c1daeSBarry Smith   Usage:
17385c6c1daeSBarry Smith .vb
17395c6c1daeSBarry Smith      PetscInitialize(...);
17405c6c1daeSBarry Smith      PetscLogBegin();
17415c6c1daeSBarry Smith      ... code ...
17425c6c1daeSBarry Smith      PetscLogPrintDetailed(MPI_Comm,filename);
17435c6c1daeSBarry Smith      PetscFinalize(...);
17445c6c1daeSBarry Smith .ve
17455c6c1daeSBarry Smith 
17465c6c1daeSBarry Smith   Notes:
17475c6c1daeSBarry Smith   By default the summary is printed to stdout.
17485c6c1daeSBarry Smith 
17495c6c1daeSBarry Smith   Level: beginner
17505c6c1daeSBarry Smith 
17515c6c1daeSBarry Smith .keywords: log, dump, print
17525c6c1daeSBarry Smith .seealso: PetscLogBegin(), PetscLogDump(), PetscLogView()
17535c6c1daeSBarry Smith @*/
17545c6c1daeSBarry Smith PetscErrorCode  PetscLogPrintDetailed(MPI_Comm comm, const char filename[])
17555c6c1daeSBarry Smith {
17565c6c1daeSBarry Smith   FILE               *fd = PETSC_STDOUT;
17575c6c1daeSBarry Smith   PetscStageLog      stageLog;
17580298fd71SBarry Smith   PetscStageInfo     *stageInfo = NULL;
17590298fd71SBarry Smith   PetscEventPerfInfo *eventInfo = NULL;
17600298fd71SBarry Smith   const char         *name      = NULL;
17615c6c1daeSBarry Smith   PetscLogDouble     TotalTime;
17625c6c1daeSBarry Smith   PetscLogDouble     stageTime, flops, flopr, mess, messLen, red;
17635c6c1daeSBarry Smith   PetscLogDouble     maxf, totf, maxt, tott, totm, totml, totr = 0.0;
17645c6c1daeSBarry Smith   PetscMPIInt        maxCt;
17655c6c1daeSBarry Smith   PetscBool          *stageUsed;
17665c6c1daeSBarry Smith   PetscBool          *stageVisible;
17675c6c1daeSBarry Smith   int                numStages, numEvents;
17685c6c1daeSBarry Smith   int                stage;
17695c6c1daeSBarry Smith   PetscLogEvent      event;
17705c6c1daeSBarry Smith   PetscErrorCode     ierr;
17715c6c1daeSBarry Smith 
17725c6c1daeSBarry Smith   PetscFunctionBegin;
17733cec8029SMatthew G Knepley   if (!PetscLogBegin_PrivateCalled) SETERRQ(comm, PETSC_ERR_ORDER, "No call to PetscLogBegin() before PetscLogPrintDetailed()");
17745c6c1daeSBarry Smith   /* Pop off any stages the user forgot to remove */
17755c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
17765c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
17775c6c1daeSBarry Smith   while (stage >= 0) {
17785c6c1daeSBarry Smith     ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr);
17795c6c1daeSBarry Smith     ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
17805c6c1daeSBarry Smith   }
17815c6c1daeSBarry Smith   /* Get the total elapsed time */
17828563dfccSBarry Smith   PetscTime(&TotalTime);  TotalTime -= petsc_BaseTime;
17835c6c1daeSBarry Smith   /* Open the summary file */
17845c6c1daeSBarry Smith   if (filename) {
17855c6c1daeSBarry Smith     ierr = PetscFOpen(comm, filename, "w", &fd);CHKERRQ(ierr);
17865c6c1daeSBarry Smith   }
17875c6c1daeSBarry Smith 
17885c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr);
17895c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "***             WIDEN YOUR WINDOW TO 120 CHARACTERS.  Use 'enscript -r -fCourier9' to print this document            ***\n");CHKERRQ(ierr);
17905c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr);
17915c6c1daeSBarry Smith 
17925c6c1daeSBarry Smith 
17935c6c1daeSBarry Smith   numStages = stageLog->numStages;
1794*785e854fSJed Brown   ierr      = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr);
1795*785e854fSJed Brown   ierr      = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr);
17965c6c1daeSBarry Smith   if (numStages > 0) {
17975c6c1daeSBarry Smith     stageInfo = stageLog->stageInfo;
17985c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
17995c6c1daeSBarry Smith       if (stage < stageLog->numStages) {
18005c6c1daeSBarry Smith         stageUsed[stage]    = stageInfo[stage].used;
18015c6c1daeSBarry Smith         stageVisible[stage] = stageInfo[stage].perfInfo.visible;
18025c6c1daeSBarry Smith       } else {
18035c6c1daeSBarry Smith         stageUsed[stage]    = PETSC_FALSE;
18045c6c1daeSBarry Smith         stageVisible[stage] = PETSC_TRUE;
18055c6c1daeSBarry Smith       }
18065c6c1daeSBarry Smith     }
18075c6c1daeSBarry Smith   }
18085c6c1daeSBarry Smith 
18095c6c1daeSBarry Smith   /* Report events */
18105c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd,"Event                Count      Time (sec)     Flops/sec                          \n");CHKERRQ(ierr);
18115c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd,"                                                            Mess   Avg len Reduct \n");CHKERRQ(ierr);
18125c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"-----------------------------------------------------------------------------------\n");CHKERRQ(ierr);
18135c6c1daeSBarry Smith   /* Problem: The stage name will not show up unless the stage executed on proc 1 */
18145c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
18155c6c1daeSBarry Smith     if (!stageVisible[stage]) continue;
18165c6c1daeSBarry Smith     if (stageUsed[stage]) {
18175c6c1daeSBarry Smith       ierr = PetscSynchronizedFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr);
18185c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, PETSC_COMM_SELF);CHKERRQ(ierr);
18195c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, PETSC_COMM_SELF);CHKERRQ(ierr);
18205c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, PETSC_COMM_SELF);CHKERRQ(ierr);
18215c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, PETSC_COMM_SELF);CHKERRQ(ierr);
18225c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, PETSC_COMM_SELF);CHKERRQ(ierr);
18235c6c1daeSBarry Smith     }
18245c6c1daeSBarry Smith     mess *= 0.5; messLen *= 0.5;
18255c6c1daeSBarry Smith 
18265c6c1daeSBarry Smith     /* Get total number of events in this stage --
18275c6c1daeSBarry Smith     */
18285c6c1daeSBarry Smith     if (stageUsed[stage]) {
18295c6c1daeSBarry Smith       eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo;
18305c6c1daeSBarry Smith       numEvents = stageLog->stageInfo[stage].eventLog->numEvents;
1831a297a907SKarl Rupp     } else numEvents = 0;
1832a297a907SKarl Rupp 
18335c6c1daeSBarry Smith     for (event = 0; event < numEvents; event++) {
18345c6c1daeSBarry Smith       if (stageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents)) {
1835a297a907SKarl Rupp         if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops/eventInfo[event].time;
1836a297a907SKarl Rupp         else flopr = 0.0;
1837a297a907SKarl Rupp 
18385c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&flopr,                          &maxf,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, PETSC_COMM_SELF);CHKERRQ(ierr);
18395c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&eventInfo[event].flops,         &totf,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, PETSC_COMM_SELF);CHKERRQ(ierr);
18405c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&eventInfo[event].time,          &maxt,  1, MPIU_PETSCLOGDOUBLE, MPI_MAX, PETSC_COMM_SELF);CHKERRQ(ierr);
18415c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&eventInfo[event].time,          &tott,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, PETSC_COMM_SELF);CHKERRQ(ierr);
18425c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&eventInfo[event].numMessages,   &totm,  1, MPIU_PETSCLOGDOUBLE, MPI_SUM, PETSC_COMM_SELF);CHKERRQ(ierr);
18435c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, PETSC_COMM_SELF);CHKERRQ(ierr);
18445c6c1daeSBarry Smith         totr  = eventInfo[event].numReductions;
18455c6c1daeSBarry Smith         ierr  = MPI_Allreduce(&eventInfo[event].count,         &maxCt, 1, MPI_INT,             MPI_MAX, PETSC_COMM_SELF);CHKERRQ(ierr);
18465c6c1daeSBarry Smith         name  = stageLog->eventLog->eventInfo[event].name;
18475c6c1daeSBarry Smith         totm *= 0.5; totml *= 0.5;
18485c6c1daeSBarry Smith       }
18495c6c1daeSBarry Smith 
18505c6c1daeSBarry Smith       if (maxCt != 0) {
1851a297a907SKarl Rupp         if (totm != 0.0) totml /= totm;
1852a297a907SKarl Rupp         else totml = 0.0;
18535c6c1daeSBarry Smith         ierr = PetscSynchronizedFPrintf(comm, fd,"%-16s %7d      %5.4e      %3.2e      %2.1e %2.1e %2.1e\n",name, maxCt,  maxt,  maxf, totm, totml, totr);CHKERRQ(ierr);
18545c6c1daeSBarry Smith       }
18555c6c1daeSBarry Smith     }
18565c6c1daeSBarry Smith   }
18570ec8b6e3SBarry Smith   ierr = PetscSynchronizedFlush(comm,fd);CHKERRQ(ierr);
18585c6c1daeSBarry Smith 
18595c6c1daeSBarry Smith   ierr = PetscFree(stageUsed);CHKERRQ(ierr);
18605c6c1daeSBarry Smith   ierr = PetscFree(stageVisible);CHKERRQ(ierr);
18615c6c1daeSBarry Smith 
18625c6c1daeSBarry Smith   ierr = PetscFClose(comm, fd);CHKERRQ(ierr);
18635c6c1daeSBarry Smith   PetscFunctionReturn(0);
18645c6c1daeSBarry Smith }
18655c6c1daeSBarry Smith 
18665c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/
18675c6c1daeSBarry Smith #undef __FUNCT__
18685c6c1daeSBarry Smith #define __FUNCT__ "PetscGetFlops"
18695c6c1daeSBarry Smith /*@C
18705c6c1daeSBarry Smith    PetscGetFlops - Returns the number of flops used on this processor
18715c6c1daeSBarry Smith    since the program began.
18725c6c1daeSBarry Smith 
18735c6c1daeSBarry Smith    Not Collective
18745c6c1daeSBarry Smith 
18755c6c1daeSBarry Smith    Output Parameter:
18765c6c1daeSBarry Smith    flops - number of floating point operations
18775c6c1daeSBarry Smith 
18785c6c1daeSBarry Smith    Notes:
18795c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
18805c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
18815c6c1daeSBarry Smith    application code.
18825c6c1daeSBarry Smith 
18835c6c1daeSBarry Smith    PETSc automatically logs library events if the code has been
18845c6c1daeSBarry Smith    compiled with -DPETSC_USE_LOG (which is the default), and -log,
18855c6c1daeSBarry Smith    -log_summary, or -log_all are specified.  PetscLogFlops() is
18865c6c1daeSBarry Smith    intended for logging user flops to supplement this PETSc
18875c6c1daeSBarry Smith    information.
18885c6c1daeSBarry Smith 
18895c6c1daeSBarry Smith    Level: intermediate
18905c6c1daeSBarry Smith 
18915c6c1daeSBarry Smith .keywords: log, flops, floating point operations
18925c6c1daeSBarry Smith 
18938563dfccSBarry Smith .seealso: PetscTime(), PetscLogFlops()
18945c6c1daeSBarry Smith @*/
18955c6c1daeSBarry Smith PetscErrorCode  PetscGetFlops(PetscLogDouble *flops)
18965c6c1daeSBarry Smith {
18975c6c1daeSBarry Smith   PetscFunctionBegin;
18985c6c1daeSBarry Smith   *flops = petsc_TotalFlops;
18995c6c1daeSBarry Smith   PetscFunctionReturn(0);
19005c6c1daeSBarry Smith }
19015c6c1daeSBarry Smith 
19025c6c1daeSBarry Smith #undef __FUNCT__
19035c6c1daeSBarry Smith #define __FUNCT__ "PetscLogObjectState"
19045c6c1daeSBarry Smith PetscErrorCode  PetscLogObjectState(PetscObject obj, const char format[], ...)
19055c6c1daeSBarry Smith {
19065c6c1daeSBarry Smith   PetscErrorCode ierr;
19075c6c1daeSBarry Smith   size_t         fullLength;
19085c6c1daeSBarry Smith   va_list        Argp;
19095c6c1daeSBarry Smith 
19105c6c1daeSBarry Smith   PetscFunctionBegin;
19115c6c1daeSBarry Smith   if (!petsc_logObjects) PetscFunctionReturn(0);
19125c6c1daeSBarry Smith   va_start(Argp, format);
19135c6c1daeSBarry Smith   ierr = PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp);CHKERRQ(ierr);
19145c6c1daeSBarry Smith   va_end(Argp);
19155c6c1daeSBarry Smith   PetscFunctionReturn(0);
19165c6c1daeSBarry Smith }
19175c6c1daeSBarry Smith 
19185c6c1daeSBarry Smith 
19195c6c1daeSBarry Smith /*MC
19205c6c1daeSBarry Smith    PetscLogFlops - Adds floating point operations to the global counter.
19215c6c1daeSBarry Smith 
19225c6c1daeSBarry Smith    Synopsis:
1923f2ba6396SBarry Smith    #include "petsclog.h"
19245c6c1daeSBarry Smith    PetscErrorCode PetscLogFlops(PetscLogDouble f)
19255c6c1daeSBarry Smith 
19265c6c1daeSBarry Smith    Not Collective
19275c6c1daeSBarry Smith 
19285c6c1daeSBarry Smith    Input Parameter:
19295c6c1daeSBarry Smith .  f - flop counter
19305c6c1daeSBarry Smith 
19315c6c1daeSBarry Smith 
19325c6c1daeSBarry Smith    Usage:
19335c6c1daeSBarry Smith .vb
19345c6c1daeSBarry Smith      PetscLogEvent USER_EVENT;
19355c6c1daeSBarry Smith      PetscLogEventRegister("User event",0,&USER_EVENT);
19365c6c1daeSBarry Smith      PetscLogEventBegin(USER_EVENT,0,0,0,0);
19375c6c1daeSBarry Smith         [code segment to monitor]
19385c6c1daeSBarry Smith         PetscLogFlops(user_flops)
19395c6c1daeSBarry Smith      PetscLogEventEnd(USER_EVENT,0,0,0,0);
19405c6c1daeSBarry Smith .ve
19415c6c1daeSBarry Smith 
19425c6c1daeSBarry Smith    Notes:
19435c6c1daeSBarry Smith    A global counter logs all PETSc flop counts.  The user can use
19445c6c1daeSBarry Smith    PetscLogFlops() to increment this counter to include flops for the
19455c6c1daeSBarry Smith    application code.
19465c6c1daeSBarry Smith 
19475c6c1daeSBarry Smith    PETSc automatically logs library events if the code has been
19485c6c1daeSBarry Smith    compiled with -DPETSC_USE_LOG (which is the default), and -log,
19495c6c1daeSBarry Smith    -log_summary, or -log_all are specified.  PetscLogFlops() is
19505c6c1daeSBarry Smith    intended for logging user flops to supplement this PETSc
19515c6c1daeSBarry Smith    information.
19525c6c1daeSBarry Smith 
19535c6c1daeSBarry Smith    Level: intermediate
19545c6c1daeSBarry Smith 
19555c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscGetFlops()
19565c6c1daeSBarry Smith 
19575c6c1daeSBarry Smith .keywords: log, flops, floating point operations
19585c6c1daeSBarry Smith M*/
19595c6c1daeSBarry Smith 
19605c6c1daeSBarry Smith /*MC
19615c6c1daeSBarry Smith    PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice)
19625c6c1daeSBarry Smith     to get accurate timings
19635c6c1daeSBarry Smith 
19645c6c1daeSBarry Smith    Synopsis:
1965f2ba6396SBarry Smith    #include "petsclog.h"
19665c6c1daeSBarry Smith    void PetscPreLoadBegin(PetscBool  flag,char *name);
19675c6c1daeSBarry Smith 
19685c6c1daeSBarry Smith    Not Collective
19695c6c1daeSBarry Smith 
19705c6c1daeSBarry Smith    Input Parameter:
19715c6c1daeSBarry Smith +   flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden
19725c6c1daeSBarry Smith            with command line option -preload true or -preload false
19735c6c1daeSBarry Smith -   name - name of first stage (lines of code timed separately with -log_summary) to
19745c6c1daeSBarry Smith            be preloaded
19755c6c1daeSBarry Smith 
19765c6c1daeSBarry Smith    Usage:
19775c6c1daeSBarry Smith .vb
19785c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
19795c6c1daeSBarry Smith        lines of code
19805c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
19815c6c1daeSBarry Smith        lines of code
19825c6c1daeSBarry Smith      PetscPreLoadEnd();
19835c6c1daeSBarry Smith .ve
19845c6c1daeSBarry Smith 
19855c6c1daeSBarry Smith    Notes: Only works in C/C++, not Fortran
19865c6c1daeSBarry Smith 
19875c6c1daeSBarry Smith      Flags available within the macro.
19885c6c1daeSBarry Smith +    PetscPreLoadingUsed - true if we are or have done preloading
19895c6c1daeSBarry Smith .    PetscPreLoadingOn - true if it is CURRENTLY doing preload
19905c6c1daeSBarry Smith .    PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second
19915c6c1daeSBarry Smith -    PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on
19925c6c1daeSBarry Smith      The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin()
19935c6c1daeSBarry Smith      and PetscPreLoadEnd()
19945c6c1daeSBarry Smith 
19955c6c1daeSBarry Smith    Level: intermediate
19965c6c1daeSBarry Smith 
19975c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage()
19985c6c1daeSBarry Smith 
19995c6c1daeSBarry Smith    Concepts: preloading
20005c6c1daeSBarry Smith    Concepts: timing^accurate
20015c6c1daeSBarry Smith    Concepts: paging^eliminating effects of
20025c6c1daeSBarry Smith 
20035c6c1daeSBarry Smith 
20045c6c1daeSBarry Smith M*/
20055c6c1daeSBarry Smith 
20065c6c1daeSBarry Smith /*MC
20075c6c1daeSBarry Smith    PetscPreLoadEnd - End a segment of code that may be preloaded (run twice)
20085c6c1daeSBarry Smith     to get accurate timings
20095c6c1daeSBarry Smith 
20105c6c1daeSBarry Smith    Synopsis:
2011f2ba6396SBarry Smith    #include "petsclog.h"
20125c6c1daeSBarry Smith    void PetscPreLoadEnd(void);
20135c6c1daeSBarry Smith 
20145c6c1daeSBarry Smith    Not Collective
20155c6c1daeSBarry Smith 
20165c6c1daeSBarry Smith    Usage:
20175c6c1daeSBarry Smith .vb
20185c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
20195c6c1daeSBarry Smith        lines of code
20205c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
20215c6c1daeSBarry Smith        lines of code
20225c6c1daeSBarry Smith      PetscPreLoadEnd();
20235c6c1daeSBarry Smith .ve
20245c6c1daeSBarry Smith 
20255c6c1daeSBarry Smith    Notes: only works in C/C++ not fortran
20265c6c1daeSBarry Smith 
20275c6c1daeSBarry Smith    Level: intermediate
20285c6c1daeSBarry Smith 
20295c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadStage()
20305c6c1daeSBarry Smith 
20315c6c1daeSBarry Smith M*/
20325c6c1daeSBarry Smith 
20335c6c1daeSBarry Smith /*MC
20345c6c1daeSBarry Smith    PetscPreLoadStage - Start a new segment of code to be timed separately.
20355c6c1daeSBarry Smith     to get accurate timings
20365c6c1daeSBarry Smith 
20375c6c1daeSBarry Smith    Synopsis:
2038f2ba6396SBarry Smith    #include "petsclog.h"
20395c6c1daeSBarry Smith    void PetscPreLoadStage(char *name);
20405c6c1daeSBarry Smith 
20415c6c1daeSBarry Smith    Not Collective
20425c6c1daeSBarry Smith 
20435c6c1daeSBarry Smith    Usage:
20445c6c1daeSBarry Smith .vb
20455c6c1daeSBarry Smith      PetscPreLoadBegin(PETSC_TRUE,"first stage);
20465c6c1daeSBarry Smith        lines of code
20475c6c1daeSBarry Smith        PetscPreLoadStage("second stage");
20485c6c1daeSBarry Smith        lines of code
20495c6c1daeSBarry Smith      PetscPreLoadEnd();
20505c6c1daeSBarry Smith .ve
20515c6c1daeSBarry Smith 
20525c6c1daeSBarry Smith    Notes: only works in C/C++ not fortran
20535c6c1daeSBarry Smith 
20545c6c1daeSBarry Smith    Level: intermediate
20555c6c1daeSBarry Smith 
20565c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd()
20575c6c1daeSBarry Smith 
20585c6c1daeSBarry Smith M*/
20595c6c1daeSBarry Smith 
20605c6c1daeSBarry Smith #undef __FUNCT__
20615c6c1daeSBarry Smith #define __FUNCT__ "PetscLogViewPython"
20625c6c1daeSBarry Smith /*@
20635c6c1daeSBarry Smith    PetscLogViewPython - Saves logging information in a Python format.
20645c6c1daeSBarry Smith 
20655c6c1daeSBarry Smith    Collective on PetscViewer
20665c6c1daeSBarry Smith 
20675c6c1daeSBarry Smith    Input Paramter:
20685c6c1daeSBarry Smith .   viewer - viewer to save Python data
20695c6c1daeSBarry Smith 
20705c6c1daeSBarry Smith   Level: intermediate
20715c6c1daeSBarry Smith 
20725c6c1daeSBarry Smith @*/
20735c6c1daeSBarry Smith PetscErrorCode  PetscLogViewPython(PetscViewer viewer)
20745c6c1daeSBarry Smith {
20755c6c1daeSBarry Smith   FILE               *fd;
20765c6c1daeSBarry Smith   PetscLogDouble     zero                    = 0.0;
20775c6c1daeSBarry Smith   PetscStageLog      stageLog;
20780298fd71SBarry Smith   PetscStageInfo     *stageInfo              = NULL;
20790298fd71SBarry Smith   PetscEventPerfInfo *eventInfo              = NULL;
20805c6c1daeSBarry Smith   const char         *name;
20815c6c1daeSBarry Smith   char               stageName[2048];
20825c6c1daeSBarry Smith   char               eventName[2048];
20835c6c1daeSBarry Smith   PetscLogDouble     locTotalTime, TotalTime = 0, TotalFlops = 0;
20845c6c1daeSBarry Smith   PetscLogDouble     numMessages             = 0, messageLength = 0, avgMessLen, numReductions = 0;
20855c6c1daeSBarry Smith   PetscLogDouble     stageTime, flops, mem, mess, messLen, red;
20865c6c1daeSBarry Smith   PetscLogDouble     fracTime, fracFlops, fracMessages, fracLength;
20875c6c1daeSBarry Smith   PetscLogDouble     fracReductions;
20885c6c1daeSBarry Smith   PetscLogDouble     tot,avg,x,y,*mydata;
20895c6c1daeSBarry Smith   PetscMPIInt        maxCt;
20905c6c1daeSBarry Smith   PetscMPIInt        size, rank, *mycount;
20915c6c1daeSBarry Smith   PetscBool          *localStageUsed,    *stageUsed;
20925c6c1daeSBarry Smith   PetscBool          *localStageVisible, *stageVisible;
20935c6c1daeSBarry Smith   int                numStages, localNumEvents, numEvents;
20945c6c1daeSBarry Smith   int                stage, lastStage;
20955c6c1daeSBarry Smith   PetscLogEvent      event;
20965c6c1daeSBarry Smith   PetscErrorCode     ierr;
20975c6c1daeSBarry Smith   PetscInt           i;
20985c6c1daeSBarry Smith   MPI_Comm           comm;
20995c6c1daeSBarry Smith 
21005c6c1daeSBarry Smith   PetscFunctionBegin;
21015c6c1daeSBarry Smith   ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr);
2102e1317eeeSBarry Smith   if (!PetscLogBegin_PrivateCalled) SETERRQ(comm, PETSC_ERR_ORDER, "No call to PetscLogBegin() before PetscLogViewPython()");
21035c6c1daeSBarry Smith   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
21045c6c1daeSBarry Smith   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
2105*785e854fSJed Brown   ierr = PetscMalloc1(size, &mydata);CHKERRQ(ierr);
2106*785e854fSJed Brown   ierr = PetscMalloc1(size, &mycount);CHKERRQ(ierr);
2107e1317eeeSBarry Smith   ierr = PetscViewerASCIIGetPointer(viewer,&fd);CHKERRQ(ierr);
21085c6c1daeSBarry Smith 
21095c6c1daeSBarry Smith   /* Pop off any stages the user forgot to remove */
21105c6c1daeSBarry Smith   lastStage = 0;
21115c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
21125c6c1daeSBarry Smith   ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
21135c6c1daeSBarry Smith   while (stage >= 0) {
21145c6c1daeSBarry Smith     lastStage = stage;
21155c6c1daeSBarry Smith     ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr);
21165c6c1daeSBarry Smith     ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr);
21175c6c1daeSBarry Smith   }
21185c6c1daeSBarry Smith   /* Get the total elapsed time */
21198563dfccSBarry Smith   PetscTime(&locTotalTime);  locTotalTime -= petsc_BaseTime;
21205c6c1daeSBarry Smith 
21215c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n#------ PETSc Performance Summary ----------\n\n");CHKERRQ(ierr);
21225c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "Nproc = %d\n",size);CHKERRQ(ierr);
21235c6c1daeSBarry Smith 
21245c6c1daeSBarry Smith   /* Must preserve reduction count before we go on */
21255c6c1daeSBarry Smith   red = (petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct)/((PetscLogDouble) size);
21265c6c1daeSBarry Smith 
21275c6c1daeSBarry Smith   /* Calculate summary information */
21285c6c1daeSBarry Smith 
21295c6c1daeSBarry Smith   /*   Time */
21305c6c1daeSBarry Smith   ierr = MPI_Gather(&locTotalTime,1,MPIU_PETSCLOGDOUBLE,mydata,1,MPIU_PETSCLOGDOUBLE,0,comm);CHKERRQ(ierr);
21315c6c1daeSBarry Smith   if (!rank) {
21325c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "Time = [ ");CHKERRQ(ierr);
21335c6c1daeSBarry Smith     tot  = 0.0;
21345c6c1daeSBarry Smith     for (i=0; i<size; i++) {
21355c6c1daeSBarry Smith       tot += mydata[i];
21365c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "  %5.3e,",mydata[i]);CHKERRQ(ierr);
21375c6c1daeSBarry Smith     }
21385c6c1daeSBarry Smith     ierr      = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
21395c6c1daeSBarry Smith     avg       = (tot)/((PetscLogDouble) size);
21405c6c1daeSBarry Smith     TotalTime = tot;
21415c6c1daeSBarry Smith   }
21425c6c1daeSBarry Smith 
21435c6c1daeSBarry Smith   /*   Objects */
21445c6c1daeSBarry Smith   avg  = (PetscLogDouble) petsc_numObjects;
21455c6c1daeSBarry Smith   ierr = MPI_Gather(&avg,1,MPIU_PETSCLOGDOUBLE,mydata,1,MPIU_PETSCLOGDOUBLE,0,comm);CHKERRQ(ierr);
21465c6c1daeSBarry Smith   if (!rank) {
21475c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "Objects = [ ");CHKERRQ(ierr);
21485c6c1daeSBarry Smith     for (i=0; i<size; i++) {
21495c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "  %5.3e,",mydata[i]);CHKERRQ(ierr);
21505c6c1daeSBarry Smith     }
21515c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
21525c6c1daeSBarry Smith   }
21535c6c1daeSBarry Smith 
21545c6c1daeSBarry Smith   /*   Flops */
21555c6c1daeSBarry Smith   ierr = MPI_Gather(&petsc_TotalFlops,1,MPIU_PETSCLOGDOUBLE,mydata,1,MPIU_PETSCLOGDOUBLE,0,comm);CHKERRQ(ierr);
21565c6c1daeSBarry Smith   if (!rank) {
21575c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "Flops = [ ");CHKERRQ(ierr);
21585c6c1daeSBarry Smith     tot  = 0.0;
21595c6c1daeSBarry Smith     for (i=0; i<size; i++) {
21605c6c1daeSBarry Smith       tot += mydata[i];
21615c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "  %5.3e,",mydata[i]);CHKERRQ(ierr);
21625c6c1daeSBarry Smith     }
21635c6c1daeSBarry Smith     ierr       = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
21645c6c1daeSBarry Smith     TotalFlops = tot;
21655c6c1daeSBarry Smith   }
21665c6c1daeSBarry Smith 
21675c6c1daeSBarry Smith   /*   Memory */
21685c6c1daeSBarry Smith   ierr = PetscMallocGetMaximumUsage(&mem);CHKERRQ(ierr);
21695c6c1daeSBarry Smith   ierr = MPI_Gather(&mem,1,MPIU_PETSCLOGDOUBLE,mydata,1,MPIU_PETSCLOGDOUBLE,0,comm);CHKERRQ(ierr);
21705c6c1daeSBarry Smith   if (!rank) {
21715c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "Memory = [ ");CHKERRQ(ierr);
21725c6c1daeSBarry Smith     for (i=0; i<size; i++) {
21735c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "  %5.3e,",mydata[i]);CHKERRQ(ierr);
21745c6c1daeSBarry Smith     }
21755c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
21765c6c1daeSBarry Smith   }
21775c6c1daeSBarry Smith 
21785c6c1daeSBarry Smith   /*   Messages */
21795c6c1daeSBarry Smith   mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct);
21805c6c1daeSBarry Smith   ierr = MPI_Gather(&mess,1,MPIU_PETSCLOGDOUBLE,mydata,1,MPIU_PETSCLOGDOUBLE,0,comm);CHKERRQ(ierr);
21815c6c1daeSBarry Smith   if (!rank) {
21825c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "MPIMessages = [ ");CHKERRQ(ierr);
21835c6c1daeSBarry Smith     tot  = 0.0;
21845c6c1daeSBarry Smith     for (i=0; i<size; i++) {
21855c6c1daeSBarry Smith       tot += mydata[i];
21865c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "  %5.3e,",mydata[i]);CHKERRQ(ierr);
21875c6c1daeSBarry Smith     }
21885c6c1daeSBarry Smith     ierr        = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
21895c6c1daeSBarry Smith     numMessages = tot;
21905c6c1daeSBarry Smith   }
21915c6c1daeSBarry Smith 
21925c6c1daeSBarry Smith   /*   Message Lengths */
21935c6c1daeSBarry Smith   mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len);
21945c6c1daeSBarry Smith   ierr = MPI_Gather(&mess,1,MPIU_PETSCLOGDOUBLE,mydata,1,MPIU_PETSCLOGDOUBLE,0,comm);CHKERRQ(ierr);
21955c6c1daeSBarry Smith   if (!rank) {
21965c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "MPIMessageLengths = [ ");CHKERRQ(ierr);
21975c6c1daeSBarry Smith     tot  = 0.0;
21985c6c1daeSBarry Smith     for (i=0; i<size; i++) {
21995c6c1daeSBarry Smith       tot += mydata[i];
22005c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "  %5.3e,",mydata[i]);CHKERRQ(ierr);
22015c6c1daeSBarry Smith     }
22025c6c1daeSBarry Smith     ierr          = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
22035c6c1daeSBarry Smith     messageLength = tot;
22045c6c1daeSBarry Smith   }
22055c6c1daeSBarry Smith 
22065c6c1daeSBarry Smith   /*   Reductions */
22075c6c1daeSBarry Smith   ierr = MPI_Gather(&red,1,MPIU_PETSCLOGDOUBLE,mydata,1,MPIU_PETSCLOGDOUBLE,0,comm);CHKERRQ(ierr);
22085c6c1daeSBarry Smith   if (!rank) {
22095c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "MPIReductions = [ ");CHKERRQ(ierr);
22105c6c1daeSBarry Smith     tot  = 0.0;
22115c6c1daeSBarry Smith     for (i=0; i<size; i++) {
22125c6c1daeSBarry Smith       tot += mydata[i];
22135c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "  %5.3e,",mydata[i]);CHKERRQ(ierr);
22145c6c1daeSBarry Smith     }
22155c6c1daeSBarry Smith     ierr          = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
22165c6c1daeSBarry Smith     numReductions = tot;
22175c6c1daeSBarry Smith   }
22185c6c1daeSBarry Smith 
22195c6c1daeSBarry Smith   /* Get total number of stages --
22205c6c1daeSBarry Smith        Currently, a single processor can register more stages than another, but stages must all be registered in order.
22215c6c1daeSBarry Smith        We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID.
22225c6c1daeSBarry Smith        This seems best accomplished by assoicating a communicator with each stage.
22235c6c1daeSBarry Smith   */
22245c6c1daeSBarry Smith   ierr = MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
2225*785e854fSJed Brown   ierr = PetscMalloc1(numStages, &localStageUsed);CHKERRQ(ierr);
2226*785e854fSJed Brown   ierr = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr);
2227*785e854fSJed Brown   ierr = PetscMalloc1(numStages, &localStageVisible);CHKERRQ(ierr);
2228*785e854fSJed Brown   ierr = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr);
22295c6c1daeSBarry Smith   if (numStages > 0) {
22305c6c1daeSBarry Smith     stageInfo = stageLog->stageInfo;
22315c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
22325c6c1daeSBarry Smith       if (stage < stageLog->numStages) {
22335c6c1daeSBarry Smith         localStageUsed[stage]    = stageInfo[stage].used;
22345c6c1daeSBarry Smith         localStageVisible[stage] = stageInfo[stage].perfInfo.visible;
22355c6c1daeSBarry Smith       } else {
22365c6c1daeSBarry Smith         localStageUsed[stage]    = PETSC_FALSE;
22375c6c1daeSBarry Smith         localStageVisible[stage] = PETSC_TRUE;
22385c6c1daeSBarry Smith       }
22395c6c1daeSBarry Smith     }
2240c3aae356SJed Brown     ierr = MPI_Allreduce(localStageUsed,    stageUsed,    numStages, MPIU_BOOL, MPI_LOR,  comm);CHKERRQ(ierr);
2241c3aae356SJed Brown     ierr = MPI_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr);
22425c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
22435c6c1daeSBarry Smith       if (stageUsed[stage]) {
22445c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd, "\n#Summary of Stages:   ----- Time ------  ----- Flops -----  --- Messages ---  -- Message Lengths --  -- Reductions --\n");CHKERRQ(ierr);
22455c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd, "#                       Avg     %%Total     Avg     %%Total   counts   %%Total     Avg         %%Total   counts   %%Total \n");CHKERRQ(ierr);
22465c6c1daeSBarry Smith         break;
22475c6c1daeSBarry Smith       }
22485c6c1daeSBarry Smith     }
22495c6c1daeSBarry Smith     for (stage = 0; stage < numStages; stage++) {
22505c6c1daeSBarry Smith       if (!stageUsed[stage]) continue;
22515c6c1daeSBarry Smith       if (localStageUsed[stage]) {
22525c6c1daeSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
22535c6c1daeSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
22545c6c1daeSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
22555c6c1daeSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
22565c6c1daeSBarry Smith         ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
22575c6c1daeSBarry Smith         name = stageInfo[stage].name;
22585c6c1daeSBarry Smith       } else {
22595c6c1daeSBarry Smith         ierr = MPI_Allreduce(&zero,                           &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
22605c6c1daeSBarry Smith         ierr = MPI_Allreduce(&zero,                           &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
22615c6c1daeSBarry Smith         ierr = MPI_Allreduce(&zero,                           &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
22625c6c1daeSBarry Smith         ierr = MPI_Allreduce(&zero,                           &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
22635c6c1daeSBarry Smith         ierr = MPI_Allreduce(&zero,                           &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
22645c6c1daeSBarry Smith         name = "";
22655c6c1daeSBarry Smith       }
22665c6c1daeSBarry Smith       mess *= 0.5; messLen *= 0.5; red /= size;
22675c6c1daeSBarry Smith       if (TotalTime     != 0.0) fracTime       = stageTime/TotalTime;    else fracTime       = 0.0;
22685c6c1daeSBarry Smith       if (TotalFlops    != 0.0) fracFlops      = flops/TotalFlops;       else fracFlops      = 0.0;
22695c6c1daeSBarry Smith       /* Talk to Barry if (stageTime     != 0.0) flops          = (size*flops)/stageTime; else flops          = 0.0; */
22705c6c1daeSBarry Smith       if (numMessages   != 0.0) fracMessages   = mess/numMessages;       else fracMessages   = 0.0;
22715c6c1daeSBarry Smith       if (numMessages   != 0.0) avgMessLen     = messLen/numMessages;    else avgMessLen     = 0.0;
22725c6c1daeSBarry Smith       if (messageLength != 0.0) fracLength     = messLen/messageLength;  else fracLength     = 0.0;
22735c6c1daeSBarry Smith       if (numReductions != 0.0) fracReductions = red/numReductions;      else fracReductions = 0.0;
22745c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "# ");
22755c6c1daeSBarry 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",
22765c6c1daeSBarry Smith                           stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops,
22775c6c1daeSBarry Smith                           mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr);
22785c6c1daeSBarry Smith     }
22795c6c1daeSBarry Smith   }
22805c6c1daeSBarry Smith 
22815c6c1daeSBarry Smith   /* Report events */
22825c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"\n# Event\n");CHKERRQ(ierr);
22835c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"# ------------------------------------------------------\n");CHKERRQ(ierr);
22845c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"class Stage(object):\n");CHKERRQ(ierr);
22855c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"    def __init__(self, name, time, flops, numMessages, messageLength, numReductions):\n");CHKERRQ(ierr);
22865c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"        # The time and flops represent totals across processes, whereas reductions are only counted once\n");CHKERRQ(ierr);
22875c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"        self.name          = name\n");CHKERRQ(ierr);
22885c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"        self.time          = time\n");CHKERRQ(ierr);
22895c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"        self.flops         = flops\n");CHKERRQ(ierr);
22905c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"        self.numMessages   = numMessages\n");CHKERRQ(ierr);
22915c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"        self.messageLength = messageLength\n");CHKERRQ(ierr);
22925c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"        self.numReductions = numReductions\n");CHKERRQ(ierr);
22935c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"        self.event         = {}\n");CHKERRQ(ierr);
22945c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd, "class Dummy(object):\n");CHKERRQ(ierr);
22955c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd, "    pass\n");CHKERRQ(ierr);
22965c6c1daeSBarry Smith   /* Problem: The stage name will not show up unless the stage executed on proc 1 */
22975c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
22985c6c1daeSBarry Smith     if (!stageVisible[stage]) continue;
22995c6c1daeSBarry Smith     if (localStageUsed[stage]) {
23005c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time,          &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
23015c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops,         &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
23025c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages,   &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
23035c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
23045c6c1daeSBarry Smith       ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
23055c6c1daeSBarry Smith     } else {
23065c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr);
23075c6c1daeSBarry Smith       ierr = MPI_Allreduce(&zero,                           &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
23085c6c1daeSBarry Smith       ierr = MPI_Allreduce(&zero,                           &flops,     1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
23095c6c1daeSBarry Smith       ierr = MPI_Allreduce(&zero,                           &mess,      1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
23105c6c1daeSBarry Smith       ierr = MPI_Allreduce(&zero,                           &messLen,   1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
23115c6c1daeSBarry Smith       ierr = MPI_Allreduce(&zero,                           &red,       1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr);
23125c6c1daeSBarry Smith     }
23135c6c1daeSBarry Smith     mess *= 0.5; messLen *= 0.5; red /= size;
23145c6c1daeSBarry Smith 
23155c6c1daeSBarry Smith     /* Get total number of events in this stage --
23165c6c1daeSBarry Smith        Currently, a single processor can register more events than another, but events must all be registered in order,
23175c6c1daeSBarry Smith        just like stages. We can removed this requirement if necessary by having a global event numbering and indirection
23185c6c1daeSBarry Smith        on the event ID. This seems best accomplished by assoicating a communicator with each stage.
23195c6c1daeSBarry Smith 
23205c6c1daeSBarry Smith        Problem: If the event did not happen on proc 1, its name will not be available.
23215c6c1daeSBarry Smith        Problem: Event visibility is not implemented
23225c6c1daeSBarry Smith     */
23235c6c1daeSBarry Smith 
23245c6c1daeSBarry Smith     {
23255c6c1daeSBarry Smith       size_t len, c;
23265c6c1daeSBarry Smith 
23275c6c1daeSBarry Smith       ierr = PetscStrcpy(stageName, stageInfo[stage].name);CHKERRQ(ierr);
23285c6c1daeSBarry Smith       ierr = PetscStrlen(stageName, &len);CHKERRQ(ierr);
23295c6c1daeSBarry Smith       for (c = 0; c < len; ++c) {
23305c6c1daeSBarry Smith         if (stageName[c] == ' ') stageName[c] = '_';
23315c6c1daeSBarry Smith       }
23325c6c1daeSBarry Smith     }
23335c6c1daeSBarry Smith     if (!rank) {
23345c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "%s = Stage('%s', %g, %g, %g, %g, %g)\n", stageName, stageName, stageTime, flops, mess, messLen, red);CHKERRQ(ierr);
23355c6c1daeSBarry Smith     }
23365c6c1daeSBarry Smith 
23375c6c1daeSBarry Smith     if (localStageUsed[stage]) {
23385c6c1daeSBarry Smith       eventInfo      = stageLog->stageInfo[stage].eventLog->eventInfo;
23395c6c1daeSBarry Smith       localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents;
2340a297a907SKarl Rupp     } else localNumEvents = 0;
2341a297a907SKarl Rupp 
23425c6c1daeSBarry Smith     ierr = MPI_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
23435c6c1daeSBarry Smith     for (event = 0; event < numEvents; event++) {
23445c6c1daeSBarry Smith       PetscBool      hasEvent = PETSC_TRUE;
23455c6c1daeSBarry Smith       PetscMPIInt    tmpI;
23465c6c1daeSBarry Smith       PetscLogDouble tmpR;
23475c6c1daeSBarry Smith 
23485c6c1daeSBarry Smith       if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) {
23495c6c1daeSBarry Smith         size_t len, c;
23505c6c1daeSBarry Smith 
23515c6c1daeSBarry Smith         ierr = MPI_Allreduce(&eventInfo[event].count, &maxCt, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
23525c6c1daeSBarry Smith         ierr = PetscStrcpy(eventName, stageLog->eventLog->eventInfo[event].name);CHKERRQ(ierr);
23535c6c1daeSBarry Smith         ierr = PetscStrlen(eventName, &len);CHKERRQ(ierr);
23545c6c1daeSBarry Smith         for (c = 0; c < len; ++c) {
23555c6c1daeSBarry Smith           if (eventName[c] == ' ') eventName[c] = '_';
23565c6c1daeSBarry Smith         }
23575c6c1daeSBarry Smith       } else {
23585c6c1daeSBarry Smith         ierr = MPI_Allreduce(&ierr, &maxCt, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr);
23595c6c1daeSBarry Smith         eventName[0] = 0;
23605c6c1daeSBarry Smith         hasEvent     = PETSC_FALSE;
23615c6c1daeSBarry Smith       }
23625c6c1daeSBarry Smith 
23635c6c1daeSBarry Smith       if (maxCt != 0) {
23645c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd,"#\n");CHKERRQ(ierr);
23655c6c1daeSBarry Smith         if (!rank) {
23665c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "%s = Dummy()\n",eventName);CHKERRQ(ierr);
23675c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "%s.event['%s'] = %s\n",stageName,eventName,eventName);CHKERRQ(ierr);
23685c6c1daeSBarry Smith         }
23695c6c1daeSBarry Smith         /* Count */
2370a297a907SKarl Rupp         if (hasEvent) tmpI = eventInfo[event].count;
2371a297a907SKarl Rupp         else          tmpI = 0;
23725c6c1daeSBarry Smith         ierr = MPI_Gather(&tmpI,1, MPI_INT, mycount, 1, MPI_INT, 0, comm);CHKERRQ(ierr);
23735c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd, "%s.Count = [ ", eventName);CHKERRQ(ierr);
23745c6c1daeSBarry Smith         if (!rank) {
23755c6c1daeSBarry Smith           for (i=0; i<size; i++) {
23765c6c1daeSBarry Smith             ierr = PetscFPrintf(comm, fd, "  %7d,",mycount[i]);CHKERRQ(ierr);
23775c6c1daeSBarry Smith           }
23785c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
23795c6c1daeSBarry Smith         }
23805c6c1daeSBarry Smith         /* Time */
2381a297a907SKarl Rupp         if (hasEvent) tmpR = eventInfo[event].time;
2382a297a907SKarl Rupp         else          tmpR = 0.0;
23835c6c1daeSBarry Smith         ierr = MPI_Gather(&tmpR, 1, MPIU_PETSCLOGDOUBLE, mydata, 1, MPIU_PETSCLOGDOUBLE, 0, comm);CHKERRQ(ierr);
23845c6c1daeSBarry Smith         if (!rank) {
23855c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "%s.Time  = [ ", eventName);CHKERRQ(ierr);
23865c6c1daeSBarry Smith           for (i=0; i<size; i++) {
23875c6c1daeSBarry Smith             ierr = PetscFPrintf(comm, fd, "  %5.3e,",mydata[i]);CHKERRQ(ierr);
23885c6c1daeSBarry Smith           }
23895c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
23905c6c1daeSBarry Smith         }
2391a297a907SKarl Rupp         if (hasEvent) tmpR = eventInfo[event].time2;
2392a297a907SKarl Rupp         else          tmpR = 0.0;
23935c6c1daeSBarry Smith         ierr = MPI_Gather(&tmpR, 1, MPIU_PETSCLOGDOUBLE, mydata, 1, MPIU_PETSCLOGDOUBLE, 0, comm);CHKERRQ(ierr);
23945c6c1daeSBarry Smith         if (!rank) {
23955c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "%s.Time2 = [ ", eventName);CHKERRQ(ierr);
23965c6c1daeSBarry Smith           for (i=0; i<size; i++) {
23975c6c1daeSBarry Smith             ierr = PetscFPrintf(comm, fd, "  %5.3e,", mydata[i]);CHKERRQ(ierr);
23985c6c1daeSBarry Smith           }
23995c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
24005c6c1daeSBarry Smith         }
24015c6c1daeSBarry Smith         /* Flops */
2402a297a907SKarl Rupp         if (hasEvent) tmpR = eventInfo[event].flops;
2403a297a907SKarl Rupp         else          tmpR = 0.0;
24045c6c1daeSBarry Smith         ierr = MPI_Gather(&tmpR, 1, MPIU_PETSCLOGDOUBLE, mydata, 1, MPIU_PETSCLOGDOUBLE, 0, comm);CHKERRQ(ierr);
24055c6c1daeSBarry Smith         if (!rank) {
24065c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "%s.Flops = [ ", eventName);CHKERRQ(ierr);
24075c6c1daeSBarry Smith           for (i=0; i<size; i++) {
24085c6c1daeSBarry Smith             ierr = PetscFPrintf(comm, fd, "  %5.3e,",mydata[i]);CHKERRQ(ierr);
24095c6c1daeSBarry Smith           }
24105c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
24115c6c1daeSBarry Smith         }
2412a297a907SKarl Rupp         if (hasEvent) tmpR = eventInfo[event].flops2;
2413a297a907SKarl Rupp         else          tmpR = 0.0;
24145c6c1daeSBarry Smith         ierr = MPI_Gather(&tmpR, 1, MPIU_PETSCLOGDOUBLE, mydata, 1, MPIU_PETSCLOGDOUBLE, 0, comm);CHKERRQ(ierr);
24155c6c1daeSBarry Smith         if (!rank) {
24165c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "%s.Flops2 = [ ", eventName);CHKERRQ(ierr);
24175c6c1daeSBarry Smith           for (i=0; i<size; i++) {
24185c6c1daeSBarry Smith             ierr = PetscFPrintf(comm, fd, "  %5.3e,", mydata[i]);CHKERRQ(ierr);
24195c6c1daeSBarry Smith           }
24205c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
24215c6c1daeSBarry Smith         }
24225c6c1daeSBarry Smith         /* Num Messages */
2423a297a907SKarl Rupp         if (hasEvent) tmpR = eventInfo[event].numMessages;
2424a297a907SKarl Rupp         else          tmpR = 0.0;
24255c6c1daeSBarry Smith         ierr = MPI_Gather(&tmpR, 1, MPIU_PETSCLOGDOUBLE, mydata, 1, MPIU_PETSCLOGDOUBLE, 0, comm);CHKERRQ(ierr);
24265c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd, "%s.NumMessages = [ ", eventName);CHKERRQ(ierr);
24275c6c1daeSBarry Smith         if (!rank) {
24285c6c1daeSBarry Smith           for (i=0; i<size; i++) {
24295c6c1daeSBarry Smith             ierr = PetscFPrintf(comm, fd, "  %7.1e,",mydata[i]);CHKERRQ(ierr);
24305c6c1daeSBarry Smith           }
24315c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
24325c6c1daeSBarry Smith         }
24335c6c1daeSBarry Smith         /* Message Length */
2434a297a907SKarl Rupp         if (hasEvent) tmpR = eventInfo[event].messageLength;
2435a297a907SKarl Rupp         else          tmpR = 0.0;
24365c6c1daeSBarry Smith         ierr = MPI_Gather(&tmpR, 1, MPIU_PETSCLOGDOUBLE, mydata, 1, MPIU_PETSCLOGDOUBLE, 0, comm);CHKERRQ(ierr);
24375c6c1daeSBarry Smith         if (!rank) {
24385c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "%s.MessageLength = [ ", eventName);CHKERRQ(ierr);
24395c6c1daeSBarry Smith           for (i=0; i<size; i++) {
24405c6c1daeSBarry Smith             ierr = PetscFPrintf(comm, fd, "  %5.3e,",mydata[i]);CHKERRQ(ierr);
24415c6c1daeSBarry Smith           }
24425c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
24435c6c1daeSBarry Smith         }
24445c6c1daeSBarry Smith         /* Num Reductions */
2445a297a907SKarl Rupp         if (hasEvent) tmpR = eventInfo[event].numReductions;
2446a297a907SKarl Rupp         else          tmpR = 0.0;
24475c6c1daeSBarry Smith         ierr = MPI_Gather(&tmpR, 1, MPIU_PETSCLOGDOUBLE, mydata, 1, MPIU_PETSCLOGDOUBLE, 0, comm);CHKERRQ(ierr);
24485c6c1daeSBarry Smith         ierr = PetscFPrintf(comm, fd, "%s.NumReductions = [ ", eventName);CHKERRQ(ierr);
24495c6c1daeSBarry Smith         if (!rank) {
24505c6c1daeSBarry Smith           for (i=0; i<size; i++) {
24515c6c1daeSBarry Smith             ierr = PetscFPrintf(comm, fd, "  %7.1e,",mydata[i]);CHKERRQ(ierr);
24525c6c1daeSBarry Smith           }
24535c6c1daeSBarry Smith           ierr = PetscFPrintf(comm, fd, "]\n");CHKERRQ(ierr);
24545c6c1daeSBarry Smith         }
24555c6c1daeSBarry Smith       }
24565c6c1daeSBarry Smith     }
24575c6c1daeSBarry Smith   }
24585c6c1daeSBarry Smith 
24595c6c1daeSBarry Smith   /* Right now, only stages on the first processor are reported here, meaning only objects associated with
24605c6c1daeSBarry Smith      the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then
24615c6c1daeSBarry Smith      stats for stages local to processor sets.
24625c6c1daeSBarry Smith   */
24635c6c1daeSBarry Smith   for (stage = 0; stage < numStages; stage++) {
24645c6c1daeSBarry Smith     if (!localStageUsed[stage]) {
24655c6c1daeSBarry Smith       ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr);
24665c6c1daeSBarry Smith     }
24675c6c1daeSBarry Smith   }
24685c6c1daeSBarry Smith 
24695c6c1daeSBarry Smith   ierr = PetscFree(localStageUsed);CHKERRQ(ierr);
24705c6c1daeSBarry Smith   ierr = PetscFree(stageUsed);CHKERRQ(ierr);
24715c6c1daeSBarry Smith   ierr = PetscFree(localStageVisible);CHKERRQ(ierr);
24725c6c1daeSBarry Smith   ierr = PetscFree(stageVisible);CHKERRQ(ierr);
24735c6c1daeSBarry Smith   ierr = PetscFree(mydata);CHKERRQ(ierr);
24745c6c1daeSBarry Smith   ierr = PetscFree(mycount);CHKERRQ(ierr);
24755c6c1daeSBarry Smith 
24765c6c1daeSBarry Smith   /* Information unrelated to this particular run */
2477a297a907SKarl Rupp   ierr = PetscFPrintf(comm, fd, "# ========================================================================================================================\n");CHKERRQ(ierr);
24788563dfccSBarry Smith   PetscTime(&y);
24798563dfccSBarry Smith   PetscTime(&x);
24808563dfccSBarry Smith   PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y);
24818563dfccSBarry Smith   PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y);
24825c6c1daeSBarry Smith   ierr = PetscFPrintf(comm,fd,"AveragetimetogetPetscTime = %g\n", (y-x)/10.0);CHKERRQ(ierr);
24835c6c1daeSBarry Smith   /* MPI information */
24845c6c1daeSBarry Smith   if (size > 1) {
24855c6c1daeSBarry Smith     MPI_Status  status;
24865c6c1daeSBarry Smith     PetscMPIInt tag;
24875c6c1daeSBarry Smith     MPI_Comm    newcomm;
24885c6c1daeSBarry Smith 
24895c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
24908563dfccSBarry Smith     PetscTime(&x);
24915c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
24925c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
24935c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
24945c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
24955c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
24968563dfccSBarry Smith     PetscTime(&y);
24975c6c1daeSBarry Smith     ierr = PetscFPrintf(comm, fd, "AveragetimeforMPI_Barrier = %g\n", (y-x)/5.0);CHKERRQ(ierr);
24985c6c1daeSBarry Smith     ierr = PetscCommDuplicate(comm,&newcomm, &tag);CHKERRQ(ierr);
24995c6c1daeSBarry Smith     ierr = MPI_Barrier(comm);CHKERRQ(ierr);
25005c6c1daeSBarry Smith     if (rank) {
25015c6c1daeSBarry Smith       ierr = MPI_Recv(0, 0, MPI_INT, rank-1,            tag, newcomm, &status);CHKERRQ(ierr);
25025c6c1daeSBarry Smith       ierr = MPI_Send(0, 0, MPI_INT, (rank+1)%size, tag, newcomm);CHKERRQ(ierr);
25035c6c1daeSBarry Smith     } else {
25048563dfccSBarry Smith       PetscTime(&x);
25055c6c1daeSBarry Smith       ierr = MPI_Send(0, 0, MPI_INT, 1,          tag, newcomm);CHKERRQ(ierr);
25065c6c1daeSBarry Smith       ierr = MPI_Recv(0, 0, MPI_INT, size-1, tag, newcomm, &status);CHKERRQ(ierr);
25078563dfccSBarry Smith       PetscTime(&y);
25085c6c1daeSBarry Smith       ierr = PetscFPrintf(comm,fd,"AveragetimforzerosizeMPI_Send = %g\n", (y-x)/size);CHKERRQ(ierr);
25095c6c1daeSBarry Smith     }
25105c6c1daeSBarry Smith     ierr = PetscCommDestroy(&newcomm);CHKERRQ(ierr);
25115c6c1daeSBarry Smith   }
25125c6c1daeSBarry Smith 
25135c6c1daeSBarry Smith   /* Cleanup */
25145c6c1daeSBarry Smith   ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr);
25155c6c1daeSBarry Smith   ierr = PetscStageLogPush(stageLog, lastStage);CHKERRQ(ierr);
25165c6c1daeSBarry Smith   PetscFunctionReturn(0);
25175c6c1daeSBarry Smith }
25185c6c1daeSBarry Smith 
25195c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */
25205c6c1daeSBarry Smith 
25215c6c1daeSBarry Smith #undef __FUNCT__
25225c6c1daeSBarry Smith #define __FUNCT__ "PetscLogObjectState"
25235c6c1daeSBarry Smith PetscErrorCode  PetscLogObjectState(PetscObject obj, const char format[], ...)
25245c6c1daeSBarry Smith {
25255c6c1daeSBarry Smith   PetscFunctionBegin;
25265c6c1daeSBarry Smith   PetscFunctionReturn(0);
25275c6c1daeSBarry Smith }
25285c6c1daeSBarry Smith 
25295c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/
25305c6c1daeSBarry Smith 
25315c6c1daeSBarry Smith 
25325c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID;
25335c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID  = 0;
25345c6c1daeSBarry Smith 
25355c6c1daeSBarry Smith #undef __FUNCT__
25365c6c1daeSBarry Smith #define __FUNCT__ "PetscClassIdRegister"
25375c6c1daeSBarry Smith /*@C
25385c6c1daeSBarry Smith   PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code.
25395c6c1daeSBarry Smith 
25405c6c1daeSBarry Smith   Not Collective
25415c6c1daeSBarry Smith 
25425c6c1daeSBarry Smith   Input Parameter:
25435c6c1daeSBarry Smith . name   - The class name
25445c6c1daeSBarry Smith 
25455c6c1daeSBarry Smith   Output Parameter:
25465c6c1daeSBarry Smith . oclass - The class id or classid
25475c6c1daeSBarry Smith 
25485c6c1daeSBarry Smith   Level: developer
25495c6c1daeSBarry Smith 
25505c6c1daeSBarry Smith .keywords: log, class, register
25515c6c1daeSBarry Smith 
25525c6c1daeSBarry Smith @*/
25535c6c1daeSBarry Smith PetscErrorCode  PetscClassIdRegister(const char name[],PetscClassId *oclass)
25545c6c1daeSBarry Smith {
25555c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
25565c6c1daeSBarry Smith   PetscStageLog  stageLog;
25575c6c1daeSBarry Smith   PetscInt       stage;
25585c6c1daeSBarry Smith   PetscErrorCode ierr;
25595c6c1daeSBarry Smith #endif
25605c6c1daeSBarry Smith 
25615c6c1daeSBarry Smith   PetscFunctionBegin;
25625c6c1daeSBarry Smith   *oclass = ++PETSC_LARGEST_CLASSID;
25635c6c1daeSBarry Smith #if defined(PETSC_USE_LOG)
25645c6c1daeSBarry Smith   ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr);
25655c6c1daeSBarry Smith   ierr = PetscClassRegLogRegister(stageLog->classLog, name, *oclass);CHKERRQ(ierr);
25665c6c1daeSBarry Smith   for (stage = 0; stage < stageLog->numStages; stage++) {
25675c6c1daeSBarry Smith     ierr = ClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr);
25685c6c1daeSBarry Smith   }
25695c6c1daeSBarry Smith #endif
25705c6c1daeSBarry Smith   PetscFunctionReturn(0);
25715c6c1daeSBarry Smith }
2572210b5426SBarry Smith 
2573210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE)
2574210b5426SBarry Smith #include <mpe.h>
2575210b5426SBarry Smith 
2576210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE;
2577210b5426SBarry Smith 
2578495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
2579495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
2580495fc317SBarry Smith 
2581210b5426SBarry Smith #undef __FUNCT__
2582210b5426SBarry Smith #define __FUNCT__ "PetscLogMPEBegin"
2583210b5426SBarry Smith /*@C
2584210b5426SBarry Smith    PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files
2585210b5426SBarry Smith    and slows the program down.
2586210b5426SBarry Smith 
2587210b5426SBarry Smith    Collective over PETSC_COMM_WORLD
2588210b5426SBarry Smith 
2589210b5426SBarry Smith    Options Database Keys:
2590495fc317SBarry Smith . -log_mpe - Prints extensive log information (for code compiled with PETSC_USE_LOG)
2591210b5426SBarry Smith 
2592210b5426SBarry Smith    Notes:
2593495fc317SBarry Smith    A related routine is PetscLogBegin() (with the options key -log_summary), which is
2594210b5426SBarry Smith    intended for production runs since it logs only flop rates and object
2595210b5426SBarry Smith    creation (and should not significantly slow the programs).
2596210b5426SBarry Smith 
2597210b5426SBarry Smith    Level: advanced
2598210b5426SBarry Smith 
2599210b5426SBarry Smith    Concepts: logging^MPE
2600210b5426SBarry Smith    Concepts: logging^message passing
2601210b5426SBarry Smith 
2602210b5426SBarry Smith .seealso: PetscLogDump(), PetscLogBegin(), PetscLogAllBegin(), PetscLogEventActivate(),
2603210b5426SBarry Smith           PetscLogEventDeactivate()
2604210b5426SBarry Smith @*/
2605210b5426SBarry Smith PetscErrorCode  PetscLogMPEBegin(void)
2606210b5426SBarry Smith {
2607210b5426SBarry Smith   PetscErrorCode ierr;
2608210b5426SBarry Smith 
2609210b5426SBarry Smith   PetscFunctionBegin;
2610210b5426SBarry Smith   /* Do MPE initialization */
2611210b5426SBarry Smith   if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */
2612210b5426SBarry Smith     ierr = PetscInfo(0,"Initializing MPE.\n");CHKERRQ(ierr);
2613210b5426SBarry Smith     ierr = MPE_Init_log();CHKERRQ(ierr);
2614210b5426SBarry Smith 
2615210b5426SBarry Smith     PetscBeganMPE = PETSC_TRUE;
2616210b5426SBarry Smith   } else {
2617210b5426SBarry Smith     ierr = PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n");CHKERRQ(ierr);
2618210b5426SBarry Smith   }
2619495fc317SBarry Smith   ierr = PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE);CHKERRQ(ierr);
2620210b5426SBarry Smith   PetscFunctionReturn(0);
2621210b5426SBarry Smith }
2622210b5426SBarry Smith 
2623210b5426SBarry Smith #undef __FUNCT__
2624210b5426SBarry Smith #define __FUNCT__ "PetscLogMPEDump"
2625210b5426SBarry Smith /*@C
2626495fc317SBarry Smith    PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot.
2627210b5426SBarry Smith 
2628210b5426SBarry Smith    Collective over PETSC_COMM_WORLD
2629210b5426SBarry Smith 
2630210b5426SBarry Smith    Level: advanced
2631210b5426SBarry Smith 
2632210b5426SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogMPEBegin()
2633210b5426SBarry Smith @*/
2634210b5426SBarry Smith PetscErrorCode  PetscLogMPEDump(const char sname[])
2635210b5426SBarry Smith {
2636210b5426SBarry Smith   char           name[PETSC_MAX_PATH_LEN];
2637210b5426SBarry Smith   PetscErrorCode ierr;
2638210b5426SBarry Smith 
2639210b5426SBarry Smith   PetscFunctionBegin;
2640210b5426SBarry Smith   if (PetscBeganMPE) {
2641210b5426SBarry Smith     ierr = PetscInfo(0,"Finalizing MPE.\n");CHKERRQ(ierr);
2642210b5426SBarry Smith     if (sname) {
2643210b5426SBarry Smith       ierr = PetscStrcpy(name,sname);CHKERRQ(ierr);
2644210b5426SBarry Smith     } else {
2645210b5426SBarry Smith       ierr = PetscGetProgramName(name,PETSC_MAX_PATH_LEN);CHKERRQ(ierr);
2646210b5426SBarry Smith     }
2647210b5426SBarry Smith     ierr = MPE_Finish_log(name);CHKERRQ(ierr);
2648210b5426SBarry Smith   } else {
2649210b5426SBarry Smith     ierr = PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n");CHKERRQ(ierr);
2650210b5426SBarry Smith   }
2651210b5426SBarry Smith   PetscFunctionReturn(0);
2652210b5426SBarry Smith }
2653210b5426SBarry Smith 
2654210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39
2655210b5426SBarry Smith static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = {
2656210b5426SBarry Smith   "OliveDrab:      ",
2657210b5426SBarry Smith   "BlueViolet:     ",
2658210b5426SBarry Smith   "CadetBlue:      ",
2659210b5426SBarry Smith   "CornflowerBlue: ",
2660210b5426SBarry Smith   "DarkGoldenrod:  ",
2661210b5426SBarry Smith   "DarkGreen:      ",
2662210b5426SBarry Smith   "DarkKhaki:      ",
2663210b5426SBarry Smith   "DarkOliveGreen: ",
2664210b5426SBarry Smith   "DarkOrange:     ",
2665210b5426SBarry Smith   "DarkOrchid:     ",
2666210b5426SBarry Smith   "DarkSeaGreen:   ",
2667210b5426SBarry Smith   "DarkSlateGray:  ",
2668210b5426SBarry Smith   "DarkTurquoise:  ",
2669210b5426SBarry Smith   "DeepPink:       ",
2670210b5426SBarry Smith   "DarkKhaki:      ",
2671210b5426SBarry Smith   "DimGray:        ",
2672210b5426SBarry Smith   "DodgerBlue:     ",
2673210b5426SBarry Smith   "GreenYellow:    ",
2674210b5426SBarry Smith   "HotPink:        ",
2675210b5426SBarry Smith   "IndianRed:      ",
2676210b5426SBarry Smith   "LavenderBlush:  ",
2677210b5426SBarry Smith   "LawnGreen:      ",
2678210b5426SBarry Smith   "LemonChiffon:   ",
2679210b5426SBarry Smith   "LightCoral:     ",
2680210b5426SBarry Smith   "LightCyan:      ",
2681210b5426SBarry Smith   "LightPink:      ",
2682210b5426SBarry Smith   "LightSalmon:    ",
2683210b5426SBarry Smith   "LightSlateGray: ",
2684210b5426SBarry Smith   "LightYellow:    ",
2685210b5426SBarry Smith   "LimeGreen:      ",
2686210b5426SBarry Smith   "MediumPurple:   ",
2687210b5426SBarry Smith   "MediumSeaGreen: ",
2688210b5426SBarry Smith   "MediumSlateBlue:",
2689210b5426SBarry Smith   "MidnightBlue:   ",
2690210b5426SBarry Smith   "MintCream:      ",
2691210b5426SBarry Smith   "MistyRose:      ",
2692210b5426SBarry Smith   "NavajoWhite:    ",
2693210b5426SBarry Smith   "NavyBlue:       ",
2694210b5426SBarry Smith   "OliveDrab:      "
2695210b5426SBarry Smith };
2696210b5426SBarry Smith 
2697210b5426SBarry Smith #undef __FUNCT__
2698210b5426SBarry Smith #define __FUNCT__ "PetscLogMPEGetRGBColor"
2699210b5426SBarry Smith /*@C
2700210b5426SBarry Smith   PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister()
2701210b5426SBarry Smith 
2702210b5426SBarry Smith   Not collective. Maybe it should be?
2703210b5426SBarry Smith 
2704210b5426SBarry Smith   Output Parameter
2705210b5426SBarry Smith . str - character string representing the color
2706210b5426SBarry Smith 
2707210b5426SBarry Smith   Level: developer
2708210b5426SBarry Smith 
2709210b5426SBarry Smith .keywords: log, mpe , color
2710210b5426SBarry Smith .seealso: PetscLogEventRegister
2711210b5426SBarry Smith @*/
2712210b5426SBarry Smith PetscErrorCode  PetscLogMPEGetRGBColor(const char *str[])
2713210b5426SBarry Smith {
2714210b5426SBarry Smith   static int idx = 0;
2715210b5426SBarry Smith 
2716210b5426SBarry Smith   PetscFunctionBegin;
2717210b5426SBarry Smith   *str = PetscLogMPERGBColors[idx];
2718210b5426SBarry Smith   idx  = (idx + 1)% PETSC_RGB_COLORS_MAX;
2719210b5426SBarry Smith   PetscFunctionReturn(0);
2720210b5426SBarry Smith }
2721210b5426SBarry Smith 
2722210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */
2723