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