15c6c1daeSBarry Smith 25c6c1daeSBarry Smith /* 35c6c1daeSBarry Smith PETSc code to log object creation and destruction and PETSc events. 45c6c1daeSBarry Smith 55c6c1daeSBarry Smith This provides the public API used by the rest of PETSc and by users. 65c6c1daeSBarry Smith 75c6c1daeSBarry Smith These routines use a private API that is not used elsewhere in PETSc and is not 85c6c1daeSBarry Smith accessible to users. The private API is defined in logimpl.h and the utils directory. 95c6c1daeSBarry Smith 105c6c1daeSBarry Smith */ 11af0996ceSBarry Smith #include <petsc/private/logimpl.h> /*I "petscsys.h" I*/ 125c6c1daeSBarry Smith #include <petsctime.h> 13665c2dedSJed Brown #include <petscviewer.h> 145c6c1daeSBarry Smith 153bb1ff40SBarry Smith PetscErrorCode PetscLogObjectParent(PetscObject p,PetscObject c) 163bb1ff40SBarry Smith { 1727b6d19dSBarry Smith if (!c || !p) return 0; 183bb1ff40SBarry Smith c->parent = p; 193bb1ff40SBarry Smith c->parentid = p->id; 203bb1ff40SBarry Smith return 0; 213bb1ff40SBarry Smith } 223bb1ff40SBarry Smith 23bb72fc59SBarry Smith /*@C 24bb72fc59SBarry Smith PetscLogObjectMemory - Adds to an object a count of additional amount of memory that is used by the object. 25bb72fc59SBarry Smith 26bb72fc59SBarry Smith Not collective. 27bb72fc59SBarry Smith 28bb72fc59SBarry Smith Input Parameters: 29bb72fc59SBarry Smith + obj - the PETSc object 30bb72fc59SBarry Smith - mem - the amount of memory that is being added to the object 31bb72fc59SBarry Smith 32bb72fc59SBarry Smith Level: developer 33bb72fc59SBarry Smith 3495452b02SPatrick Sanan Developer Notes: 3595452b02SPatrick Sanan Currently we do not always do a good job of associating all memory allocations with an object. 36bb72fc59SBarry Smith 37bb72fc59SBarry Smith .seealso: PetscFinalize(), PetscInitializeFortran(), PetscGetArgs(), PetscInitializeNoArguments() 38bb72fc59SBarry Smith 39bb72fc59SBarry Smith @*/ 403bb1ff40SBarry Smith PetscErrorCode PetscLogObjectMemory(PetscObject p,PetscLogDouble m) 413bb1ff40SBarry Smith { 42d12f57a0SLisandro Dalcin if (!p) return 0; 4327b6d19dSBarry Smith p->mem += m; 443bb1ff40SBarry Smith return 0; 453bb1ff40SBarry Smith } 463bb1ff40SBarry Smith 475c6c1daeSBarry Smith PetscLogEvent PETSC_LARGEST_EVENT = PETSC_EVENT; 485c6c1daeSBarry Smith 495c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 505c6c1daeSBarry Smith #include <petscmachineinfo.h> 515c6c1daeSBarry Smith #include <petscconfiginfo.h> 525c6c1daeSBarry Smith 535c6c1daeSBarry Smith /* used in the MPI_XXX() count macros in petsclog.h */ 545c6c1daeSBarry Smith 555c6c1daeSBarry Smith /* Action and object logging variables */ 560298fd71SBarry Smith Action *petsc_actions = NULL; 570298fd71SBarry Smith Object *petsc_objects = NULL; 585c6c1daeSBarry Smith PetscBool petsc_logActions = PETSC_FALSE; 595c6c1daeSBarry Smith PetscBool petsc_logObjects = PETSC_FALSE; 605c6c1daeSBarry Smith int petsc_numActions = 0, petsc_maxActions = 100; 615c6c1daeSBarry Smith int petsc_numObjects = 0, petsc_maxObjects = 100; 625c6c1daeSBarry Smith int petsc_numObjectsDestroyed = 0; 635c6c1daeSBarry Smith 645c6c1daeSBarry Smith /* Global counters */ 655c6c1daeSBarry Smith PetscLogDouble petsc_BaseTime = 0.0; 665c6c1daeSBarry Smith PetscLogDouble petsc_TotalFlops = 0.0; /* The number of flops */ 675c6c1daeSBarry Smith PetscLogDouble petsc_tmp_flops = 0.0; /* The incremental number of flops */ 685c6c1daeSBarry Smith PetscLogDouble petsc_send_ct = 0.0; /* The number of sends */ 695c6c1daeSBarry Smith PetscLogDouble petsc_recv_ct = 0.0; /* The number of receives */ 705c6c1daeSBarry Smith PetscLogDouble petsc_send_len = 0.0; /* The total length of all sent messages */ 715c6c1daeSBarry Smith PetscLogDouble petsc_recv_len = 0.0; /* The total length of all received messages */ 725c6c1daeSBarry Smith PetscLogDouble petsc_isend_ct = 0.0; /* The number of immediate sends */ 735c6c1daeSBarry Smith PetscLogDouble petsc_irecv_ct = 0.0; /* The number of immediate receives */ 745c6c1daeSBarry Smith PetscLogDouble petsc_isend_len = 0.0; /* The total length of all immediate send messages */ 755c6c1daeSBarry Smith PetscLogDouble petsc_irecv_len = 0.0; /* The total length of all immediate receive messages */ 765c6c1daeSBarry Smith PetscLogDouble petsc_wait_ct = 0.0; /* The number of waits */ 775c6c1daeSBarry Smith PetscLogDouble petsc_wait_any_ct = 0.0; /* The number of anywaits */ 785c6c1daeSBarry Smith PetscLogDouble petsc_wait_all_ct = 0.0; /* The number of waitalls */ 795c6c1daeSBarry Smith PetscLogDouble petsc_sum_of_waits_ct = 0.0; /* The total number of waits */ 805c6c1daeSBarry Smith PetscLogDouble petsc_allreduce_ct = 0.0; /* The number of reductions */ 815c6c1daeSBarry Smith PetscLogDouble petsc_gather_ct = 0.0; /* The number of gathers and gathervs */ 825c6c1daeSBarry Smith PetscLogDouble petsc_scatter_ct = 0.0; /* The number of scatters and scattervs */ 83bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 84bec0b493Shannah_mairs PetscLogDouble petsc_ctog_ct = 0.0; /* The total number of CPU to GPU copies */ 85bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_ct = 0.0; /* The total number of GPU to CPU copies */ 86bec0b493Shannah_mairs PetscLogDouble petsc_ctog_sz = 0.0; /* The total size of CPU to GPU copies */ 87bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_sz = 0.0; /* The total size of GPU to CPU copies */ 88958c4211Shannah_mairs PetscLogDouble petsc_gflops = 0.0; /* The flops done on a GPU */ 89958c4211Shannah_mairs PetscLogDouble petsc_gtime = 0.0; /* The time spent on a GPU */ 90*8df2f0b1SJunchao Zhang #if defined(PETSC_USE_DEBUG) 91*8df2f0b1SJunchao Zhang PetscBool petsc_gtime_inuse = PETSC_FALSE; 92*8df2f0b1SJunchao Zhang #endif 93bec0b493Shannah_mairs #endif 945c6c1daeSBarry Smith 955c6c1daeSBarry Smith /* Logging functions */ 960298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL; 970298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL; 980298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 990298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 1005c6c1daeSBarry Smith 1015c6c1daeSBarry Smith /* Tracing event logging variables */ 1020298fd71SBarry Smith FILE *petsc_tracefile = NULL; 1035c6c1daeSBarry Smith int petsc_tracelevel = 0; 1045c6c1daeSBarry Smith const char *petsc_traceblanks = " "; 1055c6c1daeSBarry Smith char petsc_tracespace[128] = " "; 1065c6c1daeSBarry Smith PetscLogDouble petsc_tracetime = 0.0; 107896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE; 1085c6c1daeSBarry Smith 10995c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogInitialize(void) 110fa2bb9feSLisandro Dalcin { 111fa2bb9feSLisandro Dalcin int stage; 112fa2bb9feSLisandro Dalcin PetscBool opt; 113fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 1145c6c1daeSBarry Smith 115fa2bb9feSLisandro Dalcin PetscFunctionBegin; 116fa2bb9feSLisandro Dalcin if (PetscLogInitializeCalled) PetscFunctionReturn(0); 117fa2bb9feSLisandro Dalcin PetscLogInitializeCalled = PETSC_TRUE; 1185c6c1daeSBarry Smith 119fa2bb9feSLisandro Dalcin ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_actions", &opt);CHKERRQ(ierr); 120fa2bb9feSLisandro Dalcin if (opt) petsc_logActions = PETSC_FALSE; 121fa2bb9feSLisandro Dalcin ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_objects", &opt);CHKERRQ(ierr); 122fa2bb9feSLisandro Dalcin if (opt) petsc_logObjects = PETSC_FALSE; 123fa2bb9feSLisandro Dalcin if (petsc_logActions) { 124fa2bb9feSLisandro Dalcin ierr = PetscMalloc1(petsc_maxActions, &petsc_actions);CHKERRQ(ierr); 125fa2bb9feSLisandro Dalcin } 126fa2bb9feSLisandro Dalcin if (petsc_logObjects) { 127fa2bb9feSLisandro Dalcin ierr = PetscMalloc1(petsc_maxObjects, &petsc_objects);CHKERRQ(ierr); 128fa2bb9feSLisandro Dalcin } 129fa2bb9feSLisandro Dalcin PetscLogPHC = PetscLogObjCreateDefault; 130fa2bb9feSLisandro Dalcin PetscLogPHD = PetscLogObjDestroyDefault; 131fa2bb9feSLisandro Dalcin /* Setup default logging structures */ 132fa2bb9feSLisandro Dalcin ierr = PetscStageLogCreate(&petsc_stageLog);CHKERRQ(ierr); 133fa2bb9feSLisandro Dalcin ierr = PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage);CHKERRQ(ierr); 1345c6c1daeSBarry Smith 135fa2bb9feSLisandro Dalcin /* All processors sync here for more consistent logging */ 136fa2bb9feSLisandro Dalcin ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr); 137fa2bb9feSLisandro Dalcin PetscTime(&petsc_BaseTime); 138fa2bb9feSLisandro Dalcin ierr = PetscLogStagePush(stage);CHKERRQ(ierr); 139fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 140fa2bb9feSLisandro Dalcin } 1415c6c1daeSBarry Smith 14295c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogFinalize(void) 1435c6c1daeSBarry Smith { 1445c6c1daeSBarry Smith PetscStageLog stageLog; 1455c6c1daeSBarry Smith PetscErrorCode ierr; 1465c6c1daeSBarry Smith 1475c6c1daeSBarry Smith PetscFunctionBegin; 1485c6c1daeSBarry Smith ierr = PetscFree(petsc_actions);CHKERRQ(ierr); 1495c6c1daeSBarry Smith ierr = PetscFree(petsc_objects);CHKERRQ(ierr); 150eccbb886SLisandro Dalcin ierr = PetscLogNestedEnd();CHKERRQ(ierr); 1510298fd71SBarry Smith ierr = PetscLogSet(NULL, NULL);CHKERRQ(ierr); 1525c6c1daeSBarry Smith 1535c6c1daeSBarry Smith /* Resetting phase */ 1545c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1555c6c1daeSBarry Smith ierr = PetscStageLogDestroy(stageLog);CHKERRQ(ierr); 156a297a907SKarl Rupp 1575c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1585c6c1daeSBarry Smith petsc_numActions = 0; 1595c6c1daeSBarry Smith petsc_numObjects = 0; 1605c6c1daeSBarry Smith petsc_numObjectsDestroyed = 0; 1615c6c1daeSBarry Smith petsc_maxActions = 100; 1625c6c1daeSBarry Smith petsc_maxObjects = 100; 1630298fd71SBarry Smith petsc_actions = NULL; 1640298fd71SBarry Smith petsc_objects = NULL; 1655c6c1daeSBarry Smith petsc_logActions = PETSC_FALSE; 1665c6c1daeSBarry Smith petsc_logObjects = PETSC_FALSE; 1675c6c1daeSBarry Smith petsc_BaseTime = 0.0; 1685c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1695c6c1daeSBarry Smith petsc_tmp_flops = 0.0; 1705c6c1daeSBarry Smith petsc_send_ct = 0.0; 1715c6c1daeSBarry Smith petsc_recv_ct = 0.0; 1725c6c1daeSBarry Smith petsc_send_len = 0.0; 1735c6c1daeSBarry Smith petsc_recv_len = 0.0; 1745c6c1daeSBarry Smith petsc_isend_ct = 0.0; 1755c6c1daeSBarry Smith petsc_irecv_ct = 0.0; 1765c6c1daeSBarry Smith petsc_isend_len = 0.0; 1775c6c1daeSBarry Smith petsc_irecv_len = 0.0; 1785c6c1daeSBarry Smith petsc_wait_ct = 0.0; 1795c6c1daeSBarry Smith petsc_wait_any_ct = 0.0; 1805c6c1daeSBarry Smith petsc_wait_all_ct = 0.0; 1815c6c1daeSBarry Smith petsc_sum_of_waits_ct = 0.0; 1825c6c1daeSBarry Smith petsc_allreduce_ct = 0.0; 1835c6c1daeSBarry Smith petsc_gather_ct = 0.0; 1845c6c1daeSBarry Smith petsc_scatter_ct = 0.0; 185bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 186bec0b493Shannah_mairs petsc_ctog_ct = 0.0; 187bec0b493Shannah_mairs petsc_gtoc_ct = 0.0; 188bec0b493Shannah_mairs petsc_ctog_sz = 0.0; 189bec0b493Shannah_mairs petsc_gtoc_sz = 0.0; 190958c4211Shannah_mairs petsc_gflops = 0.0; 191958c4211Shannah_mairs petsc_gtime = 0.0; 192bec0b493Shannah_mairs #endif 1935c6c1daeSBarry Smith PETSC_LARGEST_EVENT = PETSC_EVENT; 1940298fd71SBarry Smith PetscLogPHC = NULL; 1950298fd71SBarry Smith PetscLogPHD = NULL; 1960298fd71SBarry Smith petsc_tracefile = NULL; 1975c6c1daeSBarry Smith petsc_tracelevel = 0; 1985c6c1daeSBarry Smith petsc_traceblanks = " "; 1995c6c1daeSBarry Smith petsc_tracespace[0] = ' '; petsc_tracespace[1] = 0; 2005c6c1daeSBarry Smith petsc_tracetime = 0.0; 2015c6c1daeSBarry Smith PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 2025c6c1daeSBarry Smith PETSC_OBJECT_CLASSID = 0; 20302c9f0b5SLisandro Dalcin petsc_stageLog = NULL; 204896238b9SBarry Smith PetscLogInitializeCalled = PETSC_FALSE; 2055c6c1daeSBarry Smith PetscFunctionReturn(0); 2065c6c1daeSBarry Smith } 2075c6c1daeSBarry Smith 2085c6c1daeSBarry Smith /*@C 2095c6c1daeSBarry Smith PetscLogSet - Sets the logging functions called at the beginning and ending of every event. 2105c6c1daeSBarry Smith 2115c6c1daeSBarry Smith Not Collective 2125c6c1daeSBarry Smith 2135c6c1daeSBarry Smith Input Parameters: 2145c6c1daeSBarry Smith + b - The function called at beginning of event 2155c6c1daeSBarry Smith - e - The function called at end of event 2165c6c1daeSBarry Smith 2175c6c1daeSBarry Smith Level: developer 2185c6c1daeSBarry Smith 219bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogTraceBegin() 2205c6c1daeSBarry Smith @*/ 2215c6c1daeSBarry Smith PetscErrorCode PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), 2225c6c1daeSBarry Smith PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject)) 2235c6c1daeSBarry Smith { 2245c6c1daeSBarry Smith PetscFunctionBegin; 2255c6c1daeSBarry Smith PetscLogPLB = b; 2265c6c1daeSBarry Smith PetscLogPLE = e; 2275c6c1daeSBarry Smith PetscFunctionReturn(0); 2285c6c1daeSBarry Smith } 2295c6c1daeSBarry Smith 2305c6c1daeSBarry Smith /*@C 231bb1d7374SBarry Smith PetscLogDefaultBegin - Turns on logging of objects and events. This logs flop 2325c6c1daeSBarry Smith rates and object creation and should not slow programs down too much. 2335c6c1daeSBarry Smith This routine may be called more than once. 2345c6c1daeSBarry Smith 2355c6c1daeSBarry Smith Logically Collective over PETSC_COMM_WORLD 2365c6c1daeSBarry Smith 2375c6c1daeSBarry Smith Options Database Keys: 238a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the 239a2553e36SBarry Smith screen (for code configured with --with-log=1 (which is the default)) 2405c6c1daeSBarry Smith 2415c6c1daeSBarry Smith Usage: 2425c6c1daeSBarry Smith .vb 2435c6c1daeSBarry Smith PetscInitialize(...); 244bb1d7374SBarry Smith PetscLogDefaultBegin(); 2455c6c1daeSBarry Smith ... code ... 2465c6c1daeSBarry Smith PetscLogView(viewer); or PetscLogDump(); 2475c6c1daeSBarry Smith PetscFinalize(); 2485c6c1daeSBarry Smith .ve 2495c6c1daeSBarry Smith 2505c6c1daeSBarry Smith Notes: 2515c6c1daeSBarry Smith PetscLogView(viewer) or PetscLogDump() actually cause the printing of 2525c6c1daeSBarry Smith the logging information. 2535c6c1daeSBarry Smith 2545c6c1daeSBarry Smith Level: advanced 2555c6c1daeSBarry Smith 2565c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogTraceBegin() 2575c6c1daeSBarry Smith @*/ 258bb1d7374SBarry Smith PetscErrorCode PetscLogDefaultBegin(void) 2595c6c1daeSBarry Smith { 2605c6c1daeSBarry Smith PetscErrorCode ierr; 2615c6c1daeSBarry Smith 2625c6c1daeSBarry Smith PetscFunctionBegin; 2635c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault);CHKERRQ(ierr); 2645c6c1daeSBarry Smith PetscFunctionReturn(0); 2655c6c1daeSBarry Smith } 2665c6c1daeSBarry Smith 2675c6c1daeSBarry Smith /*@C 2685c6c1daeSBarry Smith PetscLogAllBegin - Turns on extensive logging of objects and events. Logs 2695c6c1daeSBarry Smith all events. This creates large log files and slows the program down. 2705c6c1daeSBarry Smith 2715c6c1daeSBarry Smith Logically Collective on PETSC_COMM_WORLD 2725c6c1daeSBarry Smith 2735c6c1daeSBarry Smith Options Database Keys: 274a2553e36SBarry Smith . -log_all - Prints extensive log information 2755c6c1daeSBarry Smith 2765c6c1daeSBarry Smith Usage: 2775c6c1daeSBarry Smith .vb 2785c6c1daeSBarry Smith PetscInitialize(...); 2795c6c1daeSBarry Smith PetscLogAllBegin(); 2805c6c1daeSBarry Smith ... code ... 2815c6c1daeSBarry Smith PetscLogDump(filename); 2825c6c1daeSBarry Smith PetscFinalize(); 2835c6c1daeSBarry Smith .ve 2845c6c1daeSBarry Smith 2855c6c1daeSBarry Smith Notes: 286bb1d7374SBarry Smith A related routine is PetscLogDefaultBegin() (with the options key -log), which is 2875c6c1daeSBarry Smith intended for production runs since it logs only flop rates and object 2885c6c1daeSBarry Smith creation (and shouldn't significantly slow the programs). 2895c6c1daeSBarry Smith 2905c6c1daeSBarry Smith Level: advanced 2915c6c1daeSBarry Smith 292bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogTraceBegin() 2935c6c1daeSBarry Smith @*/ 2945c6c1daeSBarry Smith PetscErrorCode PetscLogAllBegin(void) 2955c6c1daeSBarry Smith { 2965c6c1daeSBarry Smith PetscErrorCode ierr; 2975c6c1daeSBarry Smith 2985c6c1daeSBarry Smith PetscFunctionBegin; 2995c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete);CHKERRQ(ierr); 3005c6c1daeSBarry Smith PetscFunctionReturn(0); 3015c6c1daeSBarry Smith } 3025c6c1daeSBarry Smith 3035c6c1daeSBarry Smith /*@ 3045c6c1daeSBarry Smith PetscLogTraceBegin - Activates trace logging. Every time a PETSc event 3055c6c1daeSBarry Smith begins or ends, the event name is printed. 3065c6c1daeSBarry Smith 3075c6c1daeSBarry Smith Logically Collective on PETSC_COMM_WORLD 3085c6c1daeSBarry Smith 3095c6c1daeSBarry Smith Input Parameter: 3105c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout) 3115c6c1daeSBarry Smith 3125c6c1daeSBarry Smith Options Database Key: 3135c6c1daeSBarry Smith . -log_trace [filename] - Activates PetscLogTraceBegin() 3145c6c1daeSBarry Smith 3155c6c1daeSBarry Smith Notes: 3165c6c1daeSBarry Smith PetscLogTraceBegin() prints the processor number, the execution time (sec), 3175c6c1daeSBarry Smith then "Event begin:" or "Event end:" followed by the event name. 3185c6c1daeSBarry Smith 3195c6c1daeSBarry Smith PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful 3205c6c1daeSBarry Smith to determine where a program is hanging without running in the 3215c6c1daeSBarry Smith debugger. Can be used in conjunction with the -info option. 3225c6c1daeSBarry Smith 3235c6c1daeSBarry Smith Level: intermediate 3245c6c1daeSBarry Smith 325bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogDefaultBegin() 3265c6c1daeSBarry Smith @*/ 3275c6c1daeSBarry Smith PetscErrorCode PetscLogTraceBegin(FILE *file) 3285c6c1daeSBarry Smith { 3295c6c1daeSBarry Smith PetscErrorCode ierr; 3305c6c1daeSBarry Smith 3315c6c1daeSBarry Smith PetscFunctionBegin; 3325c6c1daeSBarry Smith petsc_tracefile = file; 333a297a907SKarl Rupp 3345c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace);CHKERRQ(ierr); 3355c6c1daeSBarry Smith PetscFunctionReturn(0); 3365c6c1daeSBarry Smith } 3375c6c1daeSBarry Smith 3385c6c1daeSBarry Smith /*@ 3395c6c1daeSBarry Smith PetscLogActions - Determines whether actions are logged for the graphical viewer. 3405c6c1daeSBarry Smith 3415c6c1daeSBarry Smith Not Collective 3425c6c1daeSBarry Smith 3435c6c1daeSBarry Smith Input Parameter: 3445c6c1daeSBarry Smith . flag - PETSC_TRUE if actions are to be logged 3455c6c1daeSBarry Smith 3465c6c1daeSBarry Smith Level: intermediate 3475c6c1daeSBarry Smith 3485c6c1daeSBarry Smith Note: Logging of actions continues to consume more memory as the program 3495c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3505c6c1daeSBarry Smith 3515c6c1daeSBarry Smith Options Database Keys: 3525c6c1daeSBarry Smith . -log_exclude_actions - Turns off actions logging 3535c6c1daeSBarry Smith 3545c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 3555c6c1daeSBarry Smith @*/ 3565c6c1daeSBarry Smith PetscErrorCode PetscLogActions(PetscBool flag) 3575c6c1daeSBarry Smith { 3585c6c1daeSBarry Smith PetscFunctionBegin; 3595c6c1daeSBarry Smith petsc_logActions = flag; 3605c6c1daeSBarry Smith PetscFunctionReturn(0); 3615c6c1daeSBarry Smith } 3625c6c1daeSBarry Smith 3635c6c1daeSBarry Smith /*@ 3645c6c1daeSBarry Smith PetscLogObjects - Determines whether objects are logged for the graphical viewer. 3655c6c1daeSBarry Smith 3665c6c1daeSBarry Smith Not Collective 3675c6c1daeSBarry Smith 3685c6c1daeSBarry Smith Input Parameter: 3695c6c1daeSBarry Smith . flag - PETSC_TRUE if objects are to be logged 3705c6c1daeSBarry Smith 3715c6c1daeSBarry Smith Level: intermediate 3725c6c1daeSBarry Smith 3735c6c1daeSBarry Smith Note: Logging of objects continues to consume more memory as the program 3745c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3755c6c1daeSBarry Smith 3765c6c1daeSBarry Smith Options Database Keys: 3775c6c1daeSBarry Smith . -log_exclude_objects - Turns off objects logging 3785c6c1daeSBarry Smith 3795c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 3805c6c1daeSBarry Smith @*/ 3815c6c1daeSBarry Smith PetscErrorCode PetscLogObjects(PetscBool flag) 3825c6c1daeSBarry Smith { 3835c6c1daeSBarry Smith PetscFunctionBegin; 3845c6c1daeSBarry Smith petsc_logObjects = flag; 3855c6c1daeSBarry Smith PetscFunctionReturn(0); 3865c6c1daeSBarry Smith } 3875c6c1daeSBarry Smith 3885c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/ 3895c6c1daeSBarry Smith /*@C 39074c0405dSRichard Tran Mills PetscLogStageRegister - Attaches a character string name to a logging stage. 3915c6c1daeSBarry Smith 3925c6c1daeSBarry Smith Not Collective 3935c6c1daeSBarry Smith 3945c6c1daeSBarry Smith Input Parameter: 3955c6c1daeSBarry Smith . sname - The name to associate with that stage 3965c6c1daeSBarry Smith 3975c6c1daeSBarry Smith Output Parameter: 3985c6c1daeSBarry Smith . stage - The stage number 3995c6c1daeSBarry Smith 4005c6c1daeSBarry Smith Level: intermediate 4015c6c1daeSBarry Smith 4025c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 4035c6c1daeSBarry Smith @*/ 4045c6c1daeSBarry Smith PetscErrorCode PetscLogStageRegister(const char sname[],PetscLogStage *stage) 4055c6c1daeSBarry Smith { 4065c6c1daeSBarry Smith PetscStageLog stageLog; 4075c6c1daeSBarry Smith PetscLogEvent event; 4085c6c1daeSBarry Smith PetscErrorCode ierr; 4095c6c1daeSBarry Smith 4105c6c1daeSBarry Smith PetscFunctionBegin; 4115c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 4125c6c1daeSBarry Smith ierr = PetscStageLogRegister(stageLog, sname, stage);CHKERRQ(ierr); 4135c6c1daeSBarry Smith /* Copy events already changed in the main stage, this sucks */ 4143a88037aSBarry Smith ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr); 4155c6c1daeSBarry Smith for (event = 0; event < stageLog->eventLog->numEvents; event++) { 4163a88037aSBarry Smith ierr = PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event],&stageLog->stageInfo[*stage].eventLog->eventInfo[event]);CHKERRQ(ierr); 4175c6c1daeSBarry Smith } 4183a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 4195c6c1daeSBarry Smith PetscFunctionReturn(0); 4205c6c1daeSBarry Smith } 4215c6c1daeSBarry Smith 4225c6c1daeSBarry Smith /*@C 4235c6c1daeSBarry Smith PetscLogStagePush - This function pushes a stage on the stack. 4245c6c1daeSBarry Smith 4255c6c1daeSBarry Smith Not Collective 4265c6c1daeSBarry Smith 4275c6c1daeSBarry Smith Input Parameter: 4285c6c1daeSBarry Smith . stage - The stage on which to log 4295c6c1daeSBarry Smith 4305c6c1daeSBarry Smith Usage: 4315c6c1daeSBarry Smith If the option -log_sumary is used to run the program containing the 4325c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4335c6c1daeSBarry Smith PetscFinalize(). 4345c6c1daeSBarry Smith .vb 4355c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4365c6c1daeSBarry Smith [stage 0 of code] 4375c6c1daeSBarry Smith PetscLogStagePush(1); 4385c6c1daeSBarry Smith [stage 1 of code] 4395c6c1daeSBarry Smith PetscLogStagePop(); 4405c6c1daeSBarry Smith PetscBarrier(...); 4415c6c1daeSBarry Smith [more stage 0 of code] 4425c6c1daeSBarry Smith PetscFinalize(); 4435c6c1daeSBarry Smith .ve 4445c6c1daeSBarry Smith 4455c6c1daeSBarry Smith Notes: 4465c6c1daeSBarry Smith Use PetscLogStageRegister() to register a stage. 4475c6c1daeSBarry Smith 4485c6c1daeSBarry Smith Level: intermediate 4495c6c1daeSBarry Smith 4505c6c1daeSBarry Smith .seealso: PetscLogStagePop(), PetscLogStageRegister(), PetscBarrier() 4515c6c1daeSBarry Smith @*/ 4525c6c1daeSBarry Smith PetscErrorCode PetscLogStagePush(PetscLogStage stage) 4535c6c1daeSBarry Smith { 4545c6c1daeSBarry Smith PetscStageLog stageLog; 4555c6c1daeSBarry Smith PetscErrorCode ierr; 4565c6c1daeSBarry Smith 4575c6c1daeSBarry Smith PetscFunctionBegin; 4585c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 4595c6c1daeSBarry Smith ierr = PetscStageLogPush(stageLog, stage);CHKERRQ(ierr); 4605c6c1daeSBarry Smith PetscFunctionReturn(0); 4615c6c1daeSBarry Smith } 4625c6c1daeSBarry Smith 4635c6c1daeSBarry Smith /*@C 4645c6c1daeSBarry Smith PetscLogStagePop - This function pops a stage from the stack. 4655c6c1daeSBarry Smith 4665c6c1daeSBarry Smith Not Collective 4675c6c1daeSBarry Smith 4685c6c1daeSBarry Smith Usage: 4695c6c1daeSBarry Smith If the option -log_sumary is used to run the program containing the 4705c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4715c6c1daeSBarry Smith PetscFinalize(). 4725c6c1daeSBarry Smith .vb 4735c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4745c6c1daeSBarry Smith [stage 0 of code] 4755c6c1daeSBarry Smith PetscLogStagePush(1); 4765c6c1daeSBarry Smith [stage 1 of code] 4775c6c1daeSBarry Smith PetscLogStagePop(); 4785c6c1daeSBarry Smith PetscBarrier(...); 4795c6c1daeSBarry Smith [more stage 0 of code] 4805c6c1daeSBarry Smith PetscFinalize(); 4815c6c1daeSBarry Smith .ve 4825c6c1daeSBarry Smith 4835c6c1daeSBarry Smith Notes: 4845c6c1daeSBarry Smith Use PetscLogStageRegister() to register a stage. 4855c6c1daeSBarry Smith 4865c6c1daeSBarry Smith Level: intermediate 4875c6c1daeSBarry Smith 4885c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStageRegister(), PetscBarrier() 4895c6c1daeSBarry Smith @*/ 4905c6c1daeSBarry Smith PetscErrorCode PetscLogStagePop(void) 4915c6c1daeSBarry Smith { 4925c6c1daeSBarry Smith PetscStageLog stageLog; 4935c6c1daeSBarry Smith PetscErrorCode ierr; 4945c6c1daeSBarry Smith 4955c6c1daeSBarry Smith PetscFunctionBegin; 4965c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 4975c6c1daeSBarry Smith ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 4985c6c1daeSBarry Smith PetscFunctionReturn(0); 4995c6c1daeSBarry Smith } 5005c6c1daeSBarry Smith 5015c6c1daeSBarry Smith /*@ 5025c6c1daeSBarry Smith PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 5035c6c1daeSBarry Smith 5045c6c1daeSBarry Smith Not Collective 5055c6c1daeSBarry Smith 5065c6c1daeSBarry Smith Input Parameters: 5075c6c1daeSBarry Smith + stage - The stage 5085c6c1daeSBarry Smith - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 5095c6c1daeSBarry Smith 5105c6c1daeSBarry Smith Level: intermediate 5115c6c1daeSBarry Smith 5125c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 5135c6c1daeSBarry Smith @*/ 5145c6c1daeSBarry Smith PetscErrorCode PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive) 5155c6c1daeSBarry Smith { 5165c6c1daeSBarry Smith PetscStageLog stageLog; 5175c6c1daeSBarry Smith PetscErrorCode ierr; 5185c6c1daeSBarry Smith 5195c6c1daeSBarry Smith PetscFunctionBegin; 5205c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5215c6c1daeSBarry Smith ierr = PetscStageLogSetActive(stageLog, stage, isActive);CHKERRQ(ierr); 5225c6c1daeSBarry Smith PetscFunctionReturn(0); 5235c6c1daeSBarry Smith } 5245c6c1daeSBarry Smith 5255c6c1daeSBarry Smith /*@ 5265c6c1daeSBarry Smith PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 5275c6c1daeSBarry Smith 5285c6c1daeSBarry Smith Not Collective 5295c6c1daeSBarry Smith 5305c6c1daeSBarry Smith Input Parameter: 5315c6c1daeSBarry Smith . stage - The stage 5325c6c1daeSBarry Smith 5335c6c1daeSBarry Smith Output Parameter: 5345c6c1daeSBarry Smith . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 5355c6c1daeSBarry Smith 5365c6c1daeSBarry Smith Level: intermediate 5375c6c1daeSBarry Smith 5385c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 5395c6c1daeSBarry Smith @*/ 5405c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetActive(PetscLogStage stage, PetscBool *isActive) 5415c6c1daeSBarry Smith { 5425c6c1daeSBarry Smith PetscStageLog stageLog; 5435c6c1daeSBarry Smith PetscErrorCode ierr; 5445c6c1daeSBarry Smith 5455c6c1daeSBarry Smith PetscFunctionBegin; 5465c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5475c6c1daeSBarry Smith ierr = PetscStageLogGetActive(stageLog, stage, isActive);CHKERRQ(ierr); 5485c6c1daeSBarry Smith PetscFunctionReturn(0); 5495c6c1daeSBarry Smith } 5505c6c1daeSBarry Smith 5515c6c1daeSBarry Smith /*@ 5525c6c1daeSBarry Smith PetscLogStageSetVisible - Determines stage visibility in PetscLogView() 5535c6c1daeSBarry Smith 5545c6c1daeSBarry Smith Not Collective 5555c6c1daeSBarry Smith 5565c6c1daeSBarry Smith Input Parameters: 5575c6c1daeSBarry Smith + stage - The stage 5585c6c1daeSBarry Smith - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 5595c6c1daeSBarry Smith 5605c6c1daeSBarry Smith Level: intermediate 5615c6c1daeSBarry Smith 5625c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView() 5635c6c1daeSBarry Smith @*/ 5645c6c1daeSBarry Smith PetscErrorCode PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible) 5655c6c1daeSBarry Smith { 5665c6c1daeSBarry Smith PetscStageLog stageLog; 5675c6c1daeSBarry Smith PetscErrorCode ierr; 5685c6c1daeSBarry Smith 5695c6c1daeSBarry Smith PetscFunctionBegin; 5705c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5715c6c1daeSBarry Smith ierr = PetscStageLogSetVisible(stageLog, stage, isVisible);CHKERRQ(ierr); 5725c6c1daeSBarry Smith PetscFunctionReturn(0); 5735c6c1daeSBarry Smith } 5745c6c1daeSBarry Smith 5755c6c1daeSBarry Smith /*@ 5765c6c1daeSBarry Smith PetscLogStageGetVisible - Returns stage visibility in PetscLogView() 5775c6c1daeSBarry Smith 5785c6c1daeSBarry Smith Not Collective 5795c6c1daeSBarry Smith 5805c6c1daeSBarry Smith Input Parameter: 5815c6c1daeSBarry Smith . stage - The stage 5825c6c1daeSBarry Smith 5835c6c1daeSBarry Smith Output Parameter: 5845c6c1daeSBarry Smith . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 5855c6c1daeSBarry Smith 5865c6c1daeSBarry Smith Level: intermediate 5875c6c1daeSBarry Smith 5885c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView() 5895c6c1daeSBarry Smith @*/ 5905c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetVisible(PetscLogStage stage, PetscBool *isVisible) 5915c6c1daeSBarry Smith { 5925c6c1daeSBarry Smith PetscStageLog stageLog; 5935c6c1daeSBarry Smith PetscErrorCode ierr; 5945c6c1daeSBarry Smith 5955c6c1daeSBarry Smith PetscFunctionBegin; 5965c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5975c6c1daeSBarry Smith ierr = PetscStageLogGetVisible(stageLog, stage, isVisible);CHKERRQ(ierr); 5985c6c1daeSBarry Smith PetscFunctionReturn(0); 5995c6c1daeSBarry Smith } 6005c6c1daeSBarry Smith 6015c6c1daeSBarry Smith /*@C 6025c6c1daeSBarry Smith PetscLogStageGetId - Returns the stage id when given the stage name. 6035c6c1daeSBarry Smith 6045c6c1daeSBarry Smith Not Collective 6055c6c1daeSBarry Smith 6065c6c1daeSBarry Smith Input Parameter: 6075c6c1daeSBarry Smith . name - The stage name 6085c6c1daeSBarry Smith 6095c6c1daeSBarry Smith Output Parameter: 6105a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists 6115c6c1daeSBarry Smith 6125c6c1daeSBarry Smith Level: intermediate 6135c6c1daeSBarry Smith 6145c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 6155c6c1daeSBarry Smith @*/ 6165c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetId(const char name[], PetscLogStage *stage) 6175c6c1daeSBarry Smith { 6185c6c1daeSBarry Smith PetscStageLog stageLog; 6195c6c1daeSBarry Smith PetscErrorCode ierr; 6205c6c1daeSBarry Smith 6215c6c1daeSBarry Smith PetscFunctionBegin; 6225c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 6235c6c1daeSBarry Smith ierr = PetscStageLogGetStage(stageLog, name, stage);CHKERRQ(ierr); 6245c6c1daeSBarry Smith PetscFunctionReturn(0); 6255c6c1daeSBarry Smith } 6265c6c1daeSBarry Smith 6275c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/ 6285c6c1daeSBarry Smith /*@C 6295c6c1daeSBarry Smith PetscLogEventRegister - Registers an event name for logging operations in an application code. 6305c6c1daeSBarry Smith 6315c6c1daeSBarry Smith Not Collective 6325c6c1daeSBarry Smith 6335c6c1daeSBarry Smith Input Parameter: 6345c6c1daeSBarry Smith + name - The name associated with the event 6355c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with 6365c6c1daeSBarry Smith PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones 6375c6c1daeSBarry Smith are only available in C code 6385c6c1daeSBarry Smith 6395c6c1daeSBarry Smith Output Parameter: 6405c6c1daeSBarry Smith . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd(). 6415c6c1daeSBarry Smith 6425c6c1daeSBarry Smith Example of Usage: 6435c6c1daeSBarry Smith .vb 6445c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 6455c6c1daeSBarry Smith PetscClassId classid; 6465c6c1daeSBarry Smith PetscLogDouble user_event_flops; 6475c6c1daeSBarry Smith PetscClassIdRegister("class name",&classid); 6485c6c1daeSBarry Smith PetscLogEventRegister("User event name",classid,&USER_EVENT); 6495c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 6505c6c1daeSBarry Smith [code segment to monitor] 6515c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 6525c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 6535c6c1daeSBarry Smith .ve 6545c6c1daeSBarry Smith 6555c6c1daeSBarry Smith Notes: 6565c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 657a2553e36SBarry Smith configured with --with-log (which is the default) and 658a2553e36SBarry Smith -log_view or -log_all is specified. PetscLogEventRegister() is 6595c6c1daeSBarry Smith intended for logging user events to supplement this PETSc 6605c6c1daeSBarry Smith information. 6615c6c1daeSBarry Smith 662495fc317SBarry Smith PETSc can gather data for use with the utilities Jumpshot 6635c6c1daeSBarry Smith (part of the MPICH distribution). If PETSc has been compiled 6645c6c1daeSBarry Smith with flag -DPETSC_HAVE_MPE (MPE is an additional utility within 6655c6c1daeSBarry Smith MPICH), the user can employ another command line option, -log_mpe, 6665c6c1daeSBarry Smith to create a logfile, "mpe.log", which can be visualized 667495fc317SBarry Smith Jumpshot. 6685c6c1daeSBarry Smith 6695c6c1daeSBarry Smith The classid is associated with each event so that classes of events 6705c6c1daeSBarry Smith can be disabled simultaneously, such as all matrix events. The user 6715c6c1daeSBarry Smith can either use an existing classid, such as MAT_CLASSID, or create 6725c6c1daeSBarry Smith their own as shown in the example. 6735c6c1daeSBarry Smith 674c5deb1d5SJed Brown If an existing event with the same name exists, its event handle is 675c5deb1d5SJed Brown returned instead of creating a new event. 676c5deb1d5SJed Brown 6775c6c1daeSBarry Smith Level: intermediate 6785c6c1daeSBarry Smith 6795c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogFlops(), 6805c6c1daeSBarry Smith PetscLogEventActivate(), PetscLogEventDeactivate(), PetscClassIdRegister() 6815c6c1daeSBarry Smith @*/ 6825c6c1daeSBarry Smith PetscErrorCode PetscLogEventRegister(const char name[],PetscClassId classid,PetscLogEvent *event) 6835c6c1daeSBarry Smith { 6845c6c1daeSBarry Smith PetscStageLog stageLog; 6855c6c1daeSBarry Smith int stage; 6865c6c1daeSBarry Smith PetscErrorCode ierr; 6875c6c1daeSBarry Smith 6885c6c1daeSBarry Smith PetscFunctionBegin; 6895c6c1daeSBarry Smith *event = PETSC_DECIDE; 6905c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 6913a88037aSBarry Smith ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr); 692c5deb1d5SJed Brown if (*event > 0) PetscFunctionReturn(0); 6933a88037aSBarry Smith ierr = PetscEventRegLogRegister(stageLog->eventLog, name, classid, event);CHKERRQ(ierr); 6945c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 6953a88037aSBarry Smith ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr); 6963a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 6975c6c1daeSBarry Smith } 6985c6c1daeSBarry Smith PetscFunctionReturn(0); 6995c6c1daeSBarry Smith } 7005c6c1daeSBarry Smith 7015c6c1daeSBarry Smith /*@ 702217044c2SLisandro Dalcin PetscLogEventSetCollective - Indicates that a particular event is collective. 703217044c2SLisandro Dalcin 704217044c2SLisandro Dalcin Not Collective 705217044c2SLisandro Dalcin 706217044c2SLisandro Dalcin Input Parameter: 707217044c2SLisandro Dalcin + event - The event id 708217044c2SLisandro Dalcin - collective - Bolean flag indicating whether a particular event is collective 709217044c2SLisandro Dalcin 710217044c2SLisandro Dalcin Note: 711217044c2SLisandro Dalcin New events returned from PetscLogEventRegister() are collective by default. 712217044c2SLisandro Dalcin 713217044c2SLisandro Dalcin Level: developer 714217044c2SLisandro Dalcin 715217044c2SLisandro Dalcin .seealso: PetscLogEventRegister() 716217044c2SLisandro Dalcin @*/ 717217044c2SLisandro Dalcin PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event,PetscBool collective) 718217044c2SLisandro Dalcin { 719217044c2SLisandro Dalcin PetscStageLog stageLog; 720217044c2SLisandro Dalcin PetscEventRegLog eventRegLog; 721217044c2SLisandro Dalcin PetscErrorCode ierr; 722217044c2SLisandro Dalcin 723217044c2SLisandro Dalcin PetscFunctionBegin; 724217044c2SLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 725217044c2SLisandro Dalcin ierr = PetscStageLogGetEventRegLog(stageLog,&eventRegLog);CHKERRQ(ierr); 726217044c2SLisandro Dalcin if (event < 0 || event > eventRegLog->numEvents) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Invalid event id"); 727217044c2SLisandro Dalcin eventRegLog->eventInfo[event].collective = collective; 728217044c2SLisandro Dalcin PetscFunctionReturn(0); 729217044c2SLisandro Dalcin } 730217044c2SLisandro Dalcin 731217044c2SLisandro Dalcin /*@ 732fa2bb9feSLisandro Dalcin PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage. 733fa2bb9feSLisandro Dalcin 734fa2bb9feSLisandro Dalcin Not Collective 735fa2bb9feSLisandro Dalcin 736fa2bb9feSLisandro Dalcin Input Parameter: 737fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc. 738fa2bb9feSLisandro Dalcin 739fa2bb9feSLisandro Dalcin Level: developer 740fa2bb9feSLisandro Dalcin 741fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 742fa2bb9feSLisandro Dalcin @*/ 743fa2bb9feSLisandro Dalcin PetscErrorCode PetscLogEventIncludeClass(PetscClassId classid) 744fa2bb9feSLisandro Dalcin { 745fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 746fa2bb9feSLisandro Dalcin int stage; 747fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 748fa2bb9feSLisandro Dalcin 749fa2bb9feSLisandro Dalcin PetscFunctionBegin; 750fa2bb9feSLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 751fa2bb9feSLisandro Dalcin for (stage = 0; stage < stageLog->numStages; stage++) { 752fa2bb9feSLisandro Dalcin ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 753fa2bb9feSLisandro Dalcin } 754fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 755fa2bb9feSLisandro Dalcin } 756fa2bb9feSLisandro Dalcin 757fa2bb9feSLisandro Dalcin /*@ 758fa2bb9feSLisandro Dalcin PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage. 759fa2bb9feSLisandro Dalcin 760fa2bb9feSLisandro Dalcin Not Collective 761fa2bb9feSLisandro Dalcin 762fa2bb9feSLisandro Dalcin Input Parameter: 763fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc. 764fa2bb9feSLisandro Dalcin 765fa2bb9feSLisandro Dalcin Level: developer 766fa2bb9feSLisandro Dalcin 767fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivateClass(),PetscLogEventDeactivate(),PetscLogEventActivate() 768fa2bb9feSLisandro Dalcin @*/ 769fa2bb9feSLisandro Dalcin PetscErrorCode PetscLogEventExcludeClass(PetscClassId classid) 770fa2bb9feSLisandro Dalcin { 771fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 772fa2bb9feSLisandro Dalcin int stage; 773fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 774fa2bb9feSLisandro Dalcin 775fa2bb9feSLisandro Dalcin PetscFunctionBegin; 776fa2bb9feSLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 777fa2bb9feSLisandro Dalcin for (stage = 0; stage < stageLog->numStages; stage++) { 778fa2bb9feSLisandro Dalcin ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 779fa2bb9feSLisandro Dalcin } 780fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 781fa2bb9feSLisandro Dalcin } 782fa2bb9feSLisandro Dalcin 783fa2bb9feSLisandro Dalcin /*@ 7845c6c1daeSBarry Smith PetscLogEventActivate - Indicates that a particular event should be logged. 7855c6c1daeSBarry Smith 7865c6c1daeSBarry Smith Not Collective 7875c6c1daeSBarry Smith 7885c6c1daeSBarry Smith Input Parameter: 7895c6c1daeSBarry Smith . event - The event id 7905c6c1daeSBarry Smith 7915c6c1daeSBarry Smith Usage: 7925c6c1daeSBarry Smith .vb 7935c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 7945c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 7955c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 7965c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 7975c6c1daeSBarry Smith .ve 7985c6c1daeSBarry Smith 7995c6c1daeSBarry Smith Note: 8005c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in include/petsclog.h) 8015c6c1daeSBarry Smith or an event number obtained with PetscLogEventRegister(). 8025c6c1daeSBarry Smith 8035c6c1daeSBarry Smith Level: advanced 8045c6c1daeSBarry Smith 805ec303c53SPatrick Sanan .seealso: PlogEventDeactivate() 8065c6c1daeSBarry Smith @*/ 8075c6c1daeSBarry Smith PetscErrorCode PetscLogEventActivate(PetscLogEvent event) 8085c6c1daeSBarry Smith { 8095c6c1daeSBarry Smith PetscStageLog stageLog; 8105c6c1daeSBarry Smith int stage; 8115c6c1daeSBarry Smith PetscErrorCode ierr; 8125c6c1daeSBarry Smith 8135c6c1daeSBarry Smith PetscFunctionBegin; 8145c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8155c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 8163a88037aSBarry Smith ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8175c6c1daeSBarry Smith PetscFunctionReturn(0); 8185c6c1daeSBarry Smith } 8195c6c1daeSBarry Smith 8205c6c1daeSBarry Smith /*@ 8215c6c1daeSBarry Smith PetscLogEventDeactivate - Indicates that a particular event should not be logged. 8225c6c1daeSBarry Smith 8235c6c1daeSBarry Smith Not Collective 8245c6c1daeSBarry Smith 8255c6c1daeSBarry Smith Input Parameter: 8265c6c1daeSBarry Smith . event - The event id 8275c6c1daeSBarry Smith 8285c6c1daeSBarry Smith Usage: 8295c6c1daeSBarry Smith .vb 8305c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 8315c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 8325c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 8335c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 8345c6c1daeSBarry Smith .ve 8355c6c1daeSBarry Smith 8365c6c1daeSBarry Smith Note: 8375c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in 8385c6c1daeSBarry Smith include/petsclog.h) or an event number obtained with PetscLogEventRegister()). 8395c6c1daeSBarry Smith 8405c6c1daeSBarry Smith Level: advanced 8415c6c1daeSBarry Smith 842ec303c53SPatrick Sanan .seealso: PlogEventActivate() 8435c6c1daeSBarry Smith @*/ 8445c6c1daeSBarry Smith PetscErrorCode PetscLogEventDeactivate(PetscLogEvent event) 8455c6c1daeSBarry Smith { 8465c6c1daeSBarry Smith PetscStageLog stageLog; 8475c6c1daeSBarry Smith int stage; 8485c6c1daeSBarry Smith PetscErrorCode ierr; 8495c6c1daeSBarry Smith 8505c6c1daeSBarry Smith PetscFunctionBegin; 8515c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8525c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 8533a88037aSBarry Smith ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8545c6c1daeSBarry Smith PetscFunctionReturn(0); 8555c6c1daeSBarry Smith } 8565c6c1daeSBarry Smith 8575c6c1daeSBarry Smith /*@ 8585c6c1daeSBarry Smith PetscLogEventSetActiveAll - Sets the event activity in every stage. 8595c6c1daeSBarry Smith 8605c6c1daeSBarry Smith Not Collective 8615c6c1daeSBarry Smith 8625c6c1daeSBarry Smith Input Parameters: 8635c6c1daeSBarry Smith + event - The event id 8645c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged 8655c6c1daeSBarry Smith 8665c6c1daeSBarry Smith Level: advanced 8675c6c1daeSBarry Smith 868ec303c53SPatrick Sanan .seealso: PlogEventActivate(),PlogEventDeactivate() 8695c6c1daeSBarry Smith @*/ 8705c6c1daeSBarry Smith PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive) 8715c6c1daeSBarry Smith { 8725c6c1daeSBarry Smith PetscStageLog stageLog; 8735c6c1daeSBarry Smith int stage; 8745c6c1daeSBarry Smith PetscErrorCode ierr; 8755c6c1daeSBarry Smith 8765c6c1daeSBarry Smith PetscFunctionBegin; 8775c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8785c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 8795c6c1daeSBarry Smith if (isActive) { 8803a88037aSBarry Smith ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8815c6c1daeSBarry Smith } else { 8823a88037aSBarry Smith ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8835c6c1daeSBarry Smith } 8845c6c1daeSBarry Smith } 8855c6c1daeSBarry Smith PetscFunctionReturn(0); 8865c6c1daeSBarry Smith } 8875c6c1daeSBarry Smith 8885c6c1daeSBarry Smith /*@ 8895c6c1daeSBarry Smith PetscLogEventActivateClass - Activates event logging for a PETSc object class. 8905c6c1daeSBarry Smith 8915c6c1daeSBarry Smith Not Collective 8925c6c1daeSBarry Smith 8935c6c1daeSBarry Smith Input Parameter: 8945c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 8955c6c1daeSBarry Smith 8965c6c1daeSBarry Smith Level: developer 8975c6c1daeSBarry Smith 898fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 8995c6c1daeSBarry Smith @*/ 9005c6c1daeSBarry Smith PetscErrorCode PetscLogEventActivateClass(PetscClassId classid) 9015c6c1daeSBarry Smith { 9025c6c1daeSBarry Smith PetscStageLog stageLog; 9035c6c1daeSBarry Smith int stage; 9045c6c1daeSBarry Smith PetscErrorCode ierr; 9055c6c1daeSBarry Smith 9065c6c1daeSBarry Smith PetscFunctionBegin; 9075c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 9085c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 9093a88037aSBarry Smith ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 9105c6c1daeSBarry Smith PetscFunctionReturn(0); 9115c6c1daeSBarry Smith } 9125c6c1daeSBarry Smith 9135c6c1daeSBarry Smith /*@ 9145c6c1daeSBarry Smith PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class. 9155c6c1daeSBarry Smith 9165c6c1daeSBarry Smith Not Collective 9175c6c1daeSBarry Smith 9185c6c1daeSBarry Smith Input Parameter: 9195c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 9205c6c1daeSBarry Smith 9215c6c1daeSBarry Smith Level: developer 9225c6c1daeSBarry Smith 923fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 9245c6c1daeSBarry Smith @*/ 9255c6c1daeSBarry Smith PetscErrorCode PetscLogEventDeactivateClass(PetscClassId classid) 9265c6c1daeSBarry Smith { 9275c6c1daeSBarry Smith PetscStageLog stageLog; 9285c6c1daeSBarry Smith int stage; 9295c6c1daeSBarry Smith PetscErrorCode ierr; 9305c6c1daeSBarry Smith 9315c6c1daeSBarry Smith PetscFunctionBegin; 9325c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 9335c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 9343a88037aSBarry Smith ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 9355c6c1daeSBarry Smith PetscFunctionReturn(0); 9365c6c1daeSBarry Smith } 9375c6c1daeSBarry Smith 9385c6c1daeSBarry Smith /*MC 93962872c28SLisandro Dalcin PetscLogEventSync - Synchronizes the beginning of a user event. 94062872c28SLisandro Dalcin 94162872c28SLisandro Dalcin Synopsis: 94262872c28SLisandro Dalcin #include <petsclog.h> 94362872c28SLisandro Dalcin PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm) 94462872c28SLisandro Dalcin 94562872c28SLisandro Dalcin Collective 94662872c28SLisandro Dalcin 94762872c28SLisandro Dalcin Input Parameters: 94862872c28SLisandro Dalcin + e - integer associated with the event obtained from PetscLogEventRegister() 94962872c28SLisandro Dalcin - comm - an MPI communicator 95062872c28SLisandro Dalcin 95162872c28SLisandro Dalcin Usage: 95262872c28SLisandro Dalcin .vb 95362872c28SLisandro Dalcin PetscLogEvent USER_EVENT; 95462872c28SLisandro Dalcin PetscLogEventRegister("User event",0,&USER_EVENT); 95562872c28SLisandro Dalcin PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD); 95662872c28SLisandro Dalcin PetscLogEventBegin(USER_EVENT,0,0,0,0); 95762872c28SLisandro Dalcin [code segment to monitor] 95862872c28SLisandro Dalcin PetscLogEventEnd(USER_EVENT,0,0,0,0); 95962872c28SLisandro Dalcin .ve 96062872c28SLisandro Dalcin 96162872c28SLisandro Dalcin Notes: 96262872c28SLisandro Dalcin This routine should be called only if there is not a 96362872c28SLisandro Dalcin PetscObject available to pass to PetscLogEventBegin(). 96462872c28SLisandro Dalcin 96562872c28SLisandro Dalcin Level: developer 96662872c28SLisandro Dalcin 96762872c28SLisandro Dalcin .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd() 96862872c28SLisandro Dalcin 96962872c28SLisandro Dalcin M*/ 97062872c28SLisandro Dalcin 97162872c28SLisandro Dalcin /*MC 9725c6c1daeSBarry Smith PetscLogEventBegin - Logs the beginning of a user event. 9735c6c1daeSBarry Smith 9745c6c1daeSBarry Smith Synopsis: 975aaa7dc30SBarry Smith #include <petsclog.h> 976f2ba6396SBarry Smith PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 9775c6c1daeSBarry Smith 9785c6c1daeSBarry Smith Not Collective 9795c6c1daeSBarry Smith 9805c6c1daeSBarry Smith Input Parameters: 9815c6c1daeSBarry Smith + e - integer associated with the event obtained from PetscLogEventRegister() 9825c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 9835c6c1daeSBarry Smith 9845c6c1daeSBarry Smith 9855c6c1daeSBarry Smith Fortran Synopsis: 9865c6c1daeSBarry Smith void PetscLogEventBegin(int e,PetscErrorCode ierr) 9875c6c1daeSBarry Smith 9885c6c1daeSBarry Smith Usage: 9895c6c1daeSBarry Smith .vb 9905c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 9915c6c1daeSBarry Smith PetscLogDouble user_event_flops; 9925c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 9935c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 9945c6c1daeSBarry Smith [code segment to monitor] 9955c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 9965c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 9975c6c1daeSBarry Smith .ve 9985c6c1daeSBarry Smith 9995c6c1daeSBarry Smith Notes: 10005c6c1daeSBarry Smith You need to register each integer event with the command 1001a2553e36SBarry Smith PetscLogEventRegister(). 10025c6c1daeSBarry Smith 10035c6c1daeSBarry Smith Level: intermediate 10045c6c1daeSBarry Smith 10055c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops() 10065c6c1daeSBarry Smith 10075c6c1daeSBarry Smith M*/ 10085c6c1daeSBarry Smith 10095c6c1daeSBarry Smith /*MC 10105c6c1daeSBarry Smith PetscLogEventEnd - Log the end of a user event. 10115c6c1daeSBarry Smith 10125c6c1daeSBarry Smith Synopsis: 1013aaa7dc30SBarry Smith #include <petsclog.h> 1014f2ba6396SBarry Smith PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10155c6c1daeSBarry Smith 10165c6c1daeSBarry Smith Not Collective 10175c6c1daeSBarry Smith 10185c6c1daeSBarry Smith Input Parameters: 10195c6c1daeSBarry Smith + e - integer associated with the event obtained with PetscLogEventRegister() 10205c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10215c6c1daeSBarry Smith 10225c6c1daeSBarry Smith 10235c6c1daeSBarry Smith Fortran Synopsis: 10245c6c1daeSBarry Smith void PetscLogEventEnd(int e,PetscErrorCode ierr) 10255c6c1daeSBarry Smith 10265c6c1daeSBarry Smith Usage: 10275c6c1daeSBarry Smith .vb 10285c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 10295c6c1daeSBarry Smith PetscLogDouble user_event_flops; 10305c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT,); 10315c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 10325c6c1daeSBarry Smith [code segment to monitor] 10335c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 10345c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 10355c6c1daeSBarry Smith .ve 10365c6c1daeSBarry Smith 10375c6c1daeSBarry Smith Notes: 10385c6c1daeSBarry Smith You should also register each additional integer event with the command 1039a2553e36SBarry Smith PetscLogEventRegister(). 10405c6c1daeSBarry Smith 10415c6c1daeSBarry Smith Level: intermediate 10425c6c1daeSBarry Smith 10435c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogFlops() 10445c6c1daeSBarry Smith 10455c6c1daeSBarry Smith M*/ 10465c6c1daeSBarry Smith 10475c6c1daeSBarry Smith /*@C 10485c6c1daeSBarry Smith PetscLogEventGetId - Returns the event id when given the event name. 10495c6c1daeSBarry Smith 10505c6c1daeSBarry Smith Not Collective 10515c6c1daeSBarry Smith 10525c6c1daeSBarry Smith Input Parameter: 10535c6c1daeSBarry Smith . name - The event name 10545c6c1daeSBarry Smith 10555c6c1daeSBarry Smith Output Parameter: 1056c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists 10575c6c1daeSBarry Smith 10585c6c1daeSBarry Smith Level: intermediate 10595c6c1daeSBarry Smith 10605c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStageGetId() 10615c6c1daeSBarry Smith @*/ 10625c6c1daeSBarry Smith PetscErrorCode PetscLogEventGetId(const char name[], PetscLogEvent *event) 10635c6c1daeSBarry Smith { 10645c6c1daeSBarry Smith PetscStageLog stageLog; 10655c6c1daeSBarry Smith PetscErrorCode ierr; 10665c6c1daeSBarry Smith 10675c6c1daeSBarry Smith PetscFunctionBegin; 10685c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 10693a88037aSBarry Smith ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr); 10705c6c1daeSBarry Smith PetscFunctionReturn(0); 10715c6c1daeSBarry Smith } 10725c6c1daeSBarry Smith 10735c6c1daeSBarry Smith 10745c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/ 10755c6c1daeSBarry Smith /*@C 10765c6c1daeSBarry Smith PetscLogDump - Dumps logs of objects to a file. This file is intended to 10775c6c1daeSBarry Smith be read by bin/petscview. This program no longer exists. 10785c6c1daeSBarry Smith 10795c6c1daeSBarry Smith Collective on PETSC_COMM_WORLD 10805c6c1daeSBarry Smith 10815c6c1daeSBarry Smith Input Parameter: 10825c6c1daeSBarry Smith . name - an optional file name 10835c6c1daeSBarry Smith 10845c6c1daeSBarry Smith Usage: 10855c6c1daeSBarry Smith .vb 10865c6c1daeSBarry Smith PetscInitialize(...); 1087bb1d7374SBarry Smith PetscLogDefaultBegin(); or PetscLogAllBegin(); 10885c6c1daeSBarry Smith ... code ... 10895c6c1daeSBarry Smith PetscLogDump(filename); 10905c6c1daeSBarry Smith PetscFinalize(); 10915c6c1daeSBarry Smith .ve 10925c6c1daeSBarry Smith 10935c6c1daeSBarry Smith Notes: 10945c6c1daeSBarry Smith The default file name is 10955c6c1daeSBarry Smith $ Log.<rank> 10965c6c1daeSBarry Smith where <rank> is the processor number. If no name is specified, 10975c6c1daeSBarry Smith this file will be used. 10985c6c1daeSBarry Smith 10995c6c1daeSBarry Smith Level: advanced 11005c6c1daeSBarry Smith 1101bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogView() 11025c6c1daeSBarry Smith @*/ 11035c6c1daeSBarry Smith PetscErrorCode PetscLogDump(const char sname[]) 11045c6c1daeSBarry Smith { 11055c6c1daeSBarry Smith PetscStageLog stageLog; 11065c6c1daeSBarry Smith PetscEventPerfInfo *eventInfo; 11075c6c1daeSBarry Smith FILE *fd; 11085c6c1daeSBarry Smith char file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN]; 11095c6c1daeSBarry Smith PetscLogDouble flops, _TotalTime; 11105c6c1daeSBarry Smith PetscMPIInt rank; 11115c6c1daeSBarry Smith int action, object, curStage; 11125c6c1daeSBarry Smith PetscLogEvent event; 11135c6c1daeSBarry Smith PetscErrorCode ierr; 11145c6c1daeSBarry Smith 11155c6c1daeSBarry Smith PetscFunctionBegin; 11165c6c1daeSBarry Smith /* Calculate the total elapsed time */ 11178563dfccSBarry Smith PetscTime(&_TotalTime); 11185c6c1daeSBarry Smith _TotalTime -= petsc_BaseTime; 11195c6c1daeSBarry Smith /* Open log file */ 11205c6c1daeSBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank);CHKERRQ(ierr); 11217ff663adSLisandro Dalcin if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank); 1122a297a907SKarl Rupp else sprintf(file, "Log.%d", rank); 11235c6c1daeSBarry Smith ierr = PetscFixFilename(file, fname);CHKERRQ(ierr); 11245c6c1daeSBarry Smith ierr = PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd);CHKERRQ(ierr); 11255c6c1daeSBarry Smith if ((!rank) && (!fd)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname); 11265c6c1daeSBarry Smith /* Output totals */ 1127d4aa7d5fSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime);CHKERRQ(ierr); 1128a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0);CHKERRQ(ierr); 11295c6c1daeSBarry Smith /* Output actions */ 11305c6c1daeSBarry Smith if (petsc_logActions) { 1131a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions);CHKERRQ(ierr); 11325c6c1daeSBarry Smith for (action = 0; action < petsc_numActions; action++) { 11335c6c1daeSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n", 11345c6c1daeSBarry Smith petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1, 1135a2ea699eSBarry Smith petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem);CHKERRQ(ierr); 11365c6c1daeSBarry Smith } 11375c6c1daeSBarry Smith } 11385c6c1daeSBarry Smith /* Output objects */ 11395c6c1daeSBarry Smith if (petsc_logObjects) { 1140a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed);CHKERRQ(ierr); 11415c6c1daeSBarry Smith for (object = 0; object < petsc_numObjects; object++) { 1142a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int) petsc_objects[object].mem);CHKERRQ(ierr); 11435c6c1daeSBarry Smith if (!petsc_objects[object].name[0]) { 1144a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd,"No Name\n");CHKERRQ(ierr); 11455c6c1daeSBarry Smith } else { 1146a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name);CHKERRQ(ierr); 11475c6c1daeSBarry Smith } 11485c6c1daeSBarry Smith if (petsc_objects[object].info[0] != 0) { 1149a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n");CHKERRQ(ierr); 11505c6c1daeSBarry Smith } else { 1151a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info);CHKERRQ(ierr); 11525c6c1daeSBarry Smith } 11535c6c1daeSBarry Smith } 11545c6c1daeSBarry Smith } 11555c6c1daeSBarry Smith /* Output events */ 1156a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n");CHKERRQ(ierr); 11575c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 11585c6c1daeSBarry Smith ierr = PetscIntStackTop(stageLog->stack, &curStage);CHKERRQ(ierr); 11595c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo; 11605c6c1daeSBarry Smith for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) { 1161a297a907SKarl Rupp if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops/eventInfo[event].time; 1162a297a907SKarl Rupp else flops = 0.0; 11635c6c1daeSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count, 1164a2ea699eSBarry Smith eventInfo[event].flops, eventInfo[event].time, flops);CHKERRQ(ierr); 11655c6c1daeSBarry Smith } 11665c6c1daeSBarry Smith ierr = PetscFClose(PETSC_COMM_WORLD, fd);CHKERRQ(ierr); 11675c6c1daeSBarry Smith PetscFunctionReturn(0); 11685c6c1daeSBarry Smith } 11695c6c1daeSBarry Smith 1170f14045dbSBarry Smith /* 1171f14045dbSBarry Smith PetscLogView_Detailed - Each process prints the times for its own events 1172f14045dbSBarry Smith 1173f14045dbSBarry Smith */ 1174f14045dbSBarry Smith PetscErrorCode PetscLogView_Detailed(PetscViewer viewer) 1175f14045dbSBarry Smith { 11762dff6485SMatthew G. Knepley PetscStageLog stageLog; 1177217044c2SLisandro Dalcin PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL; 1178217044c2SLisandro Dalcin PetscLogDouble locTotalTime, numRed, maxMem; 11792dff6485SMatthew G. Knepley int numStages,numEvents,stage,event; 1180217044c2SLisandro Dalcin MPI_Comm comm = PetscObjectComm((PetscObject) viewer); 11812dff6485SMatthew G. Knepley PetscMPIInt rank,size; 11822dff6485SMatthew G. Knepley PetscErrorCode ierr; 1183f14045dbSBarry Smith 1184f14045dbSBarry Smith PetscFunctionBegin; 11852d1ec343SBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 11862d1ec343SBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 11872dff6485SMatthew G. Knepley /* Must preserve reduction count before we go on */ 11882dff6485SMatthew G. Knepley numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 11892d1ec343SBarry Smith /* Get the total elapsed time */ 11902d1ec343SBarry Smith PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 11919852e123SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"size = %d\n",size);CHKERRQ(ierr); 11922d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalTimes = {}\n");CHKERRQ(ierr); 11932d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalMessages = {}\n");CHKERRQ(ierr); 1194217044c2SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"LocalMessageLens = {}\n");CHKERRQ(ierr); 11952d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalReductions = {}\n");CHKERRQ(ierr); 1196217044c2SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"LocalFlop = {}\n");CHKERRQ(ierr); 11972dff6485SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer,"LocalObjects = {}\n");CHKERRQ(ierr); 11982dff6485SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer,"LocalMemory = {}\n");CHKERRQ(ierr); 11992d1ec343SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1200b2566f29SBarry Smith ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 12012d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages = {}\n");CHKERRQ(ierr); 12022d1ec343SBarry Smith for (stage=0; stage<numStages; stage++) { 12032d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr); 120461917356SPatrick Sanan ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"summary\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr); 1205b2566f29SBarry Smith ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 12062d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 12072d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"%s\"] = {}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name);CHKERRQ(ierr); 12082d1ec343SBarry Smith } 12092d1ec343SBarry Smith } 1210217044c2SLisandro Dalcin ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr); 12111575c14dSBarry Smith ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr); 12122d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalTimes[%d] = %g\n",rank,locTotalTime);CHKERRQ(ierr); 12132d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessages[%d] = %g\n",rank,(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct));CHKERRQ(ierr); 1214217044c2SLisandro Dalcin ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessageLens[%d] = %g\n",rank,(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len));CHKERRQ(ierr); 12152dff6485SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalReductions[%d] = %g\n",rank,numRed);CHKERRQ(ierr); 1216217044c2SLisandro Dalcin ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalFlop[%d] = %g\n",rank,petsc_TotalFlops);CHKERRQ(ierr); 1217ba67d37fSBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalObjects[%d] = %d\n",rank,petsc_numObjects);CHKERRQ(ierr); 12182dff6485SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMemory[%d] = %g\n",rank,maxMem);CHKERRQ(ierr); 12192d1ec343SBarry Smith ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 12202d1ec343SBarry Smith for (stage=0; stage<numStages; stage++) { 1221217044c2SLisandro Dalcin stageInfo = &stageLog->stageInfo[stage].perfInfo; 1222d4aa7d5fSBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n", 12232dff6485SMatthew G. Knepley stageLog->stageInfo[stage].name,rank, 1224217044c2SLisandro Dalcin stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr); 1225b2566f29SBarry Smith ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 12262d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 1227217044c2SLisandro Dalcin eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 1228c15bc2c4SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %D, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g", 1229217044c2SLisandro Dalcin stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name,rank, 1230217044c2SLisandro Dalcin eventInfo->count,eventInfo->time,eventInfo->syncTime,eventInfo->numMessages,eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr); 1231891e75beSMatthew G. Knepley if (eventInfo->dof[0] >= 0.) { 1232891e75beSMatthew G. Knepley PetscInt d, e; 12335d68e14cSMatthew G. Knepley 1234891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : [");CHKERRQ(ierr); 1235891e75beSMatthew G. Knepley for (d = 0; d < 8; ++d) { 1236891e75beSMatthew G. Knepley if (d > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);} 1237891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d]);CHKERRQ(ierr); 1238891e75beSMatthew G. Knepley } 1239891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr); 12405d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : [");CHKERRQ(ierr); 12415d68e14cSMatthew G. Knepley for (e = 0; e < 8; ++e) { 12425d68e14cSMatthew G. Knepley if (e > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);} 1243c15bc2c4SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e]);CHKERRQ(ierr); 12445d68e14cSMatthew G. Knepley } 12455d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr); 12465d68e14cSMatthew G. Knepley } 12475d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"}\n");CHKERRQ(ierr); 12482d1ec343SBarry Smith } 12492d1ec343SBarry Smith } 12502d1ec343SBarry Smith ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 12511575c14dSBarry Smith ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr); 1252f14045dbSBarry Smith PetscFunctionReturn(0); 1253f14045dbSBarry Smith } 1254f14045dbSBarry Smith 125538144912Sdeepblu2718 /* 125638144912Sdeepblu2718 PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format 125738144912Sdeepblu2718 */ 125838144912Sdeepblu2718 PetscErrorCode PetscLogView_CSV(PetscViewer viewer) 125938144912Sdeepblu2718 { 126038144912Sdeepblu2718 PetscStageLog stageLog; 1261669c5be0SSatish Balay PetscEventPerfInfo *eventInfo = NULL; 126238144912Sdeepblu2718 PetscLogDouble locTotalTime, maxMem; 126338144912Sdeepblu2718 int numStages,numEvents,stage,event; 126438144912Sdeepblu2718 MPI_Comm comm = PetscObjectComm((PetscObject) viewer); 126538144912Sdeepblu2718 PetscMPIInt rank,size; 126638144912Sdeepblu2718 PetscErrorCode ierr; 126738144912Sdeepblu2718 126838144912Sdeepblu2718 PetscFunctionBegin; 126938144912Sdeepblu2718 ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 127038144912Sdeepblu2718 ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 127138144912Sdeepblu2718 /* Must preserve reduction count before we go on */ 127238144912Sdeepblu2718 /* Get the total elapsed time */ 127338144912Sdeepblu2718 PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 127438144912Sdeepblu2718 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 127538144912Sdeepblu2718 ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 127638144912Sdeepblu2718 ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr); 127738144912Sdeepblu2718 ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr); 127838144912Sdeepblu2718 ierr = PetscViewerASCIIPrintf(viewer,"Stage Name,Event Name,Rank,Time,Num Messages,Message Length,Num Reductions,FLOP,dof0,dof1,dof2,dof3,dof4,dof5,dof6,dof7,e0,e1,e2,e3,e4,e5,e6,e7,%d\n", size); 127938144912Sdeepblu2718 ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 128038144912Sdeepblu2718 for (stage=0; stage<numStages; stage++) { 12819e29573dSMatthew G. Knepley PetscEventPerfInfo *stageInfo = &stageLog->stageInfo[stage].perfInfo; 12829e29573dSMatthew G. Knepley 12839e29573dSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,summary,%d,%g,%g,%g,%g,%g\n", 12849e29573dSMatthew G. Knepley stageLog->stageInfo[stage].name,rank,stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr); 128538144912Sdeepblu2718 ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 128638144912Sdeepblu2718 for (event = 0; event < numEvents; event++) { 128738144912Sdeepblu2718 eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 128838144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,%s,%d,%g,%g,%g,%g,%g",stageLog->stageInfo[stage].name, 128938144912Sdeepblu2718 stageLog->eventLog->eventInfo[event].name,rank,eventInfo->time,eventInfo->numMessages, 129038144912Sdeepblu2718 eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr); 129138144912Sdeepblu2718 if (eventInfo->dof[0] >= 0.) { 129238144912Sdeepblu2718 PetscInt d, e; 129338144912Sdeepblu2718 129438144912Sdeepblu2718 for (d = 0; d < 8; ++d) { 129538144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d]);CHKERRQ(ierr); 129638144912Sdeepblu2718 } 129738144912Sdeepblu2718 for (e = 0; e < 8; ++e) { 129838144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e]);CHKERRQ(ierr); 129938144912Sdeepblu2718 } 130038144912Sdeepblu2718 } 130138144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"\n");CHKERRQ(ierr); 130238144912Sdeepblu2718 } 130338144912Sdeepblu2718 } 130438144912Sdeepblu2718 ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 130538144912Sdeepblu2718 ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr); 130638144912Sdeepblu2718 PetscFunctionReturn(0); 130738144912Sdeepblu2718 } 130838144912Sdeepblu2718 1309217044c2SLisandro Dalcin static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm,FILE *fd) 1310217044c2SLisandro Dalcin { 1311217044c2SLisandro Dalcin PetscErrorCode ierr; 1312217044c2SLisandro Dalcin PetscFunctionBegin; 1313217044c2SLisandro Dalcin if (!PetscLogSyncOn) PetscFunctionReturn(0); 1314217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1315217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1316217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1317217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1318217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1319217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This program was run with logging synchronization. #\n");CHKERRQ(ierr); 1320217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This option provides more meaningful imbalance #\n");CHKERRQ(ierr); 1321217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # figures at the expense of slowing things down and #\n");CHKERRQ(ierr); 1322217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # providing a distorted view of the overall runtime. #\n");CHKERRQ(ierr); 1323217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1324217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 1325217044c2SLisandro Dalcin PetscFunctionReturn(0); 1326217044c2SLisandro Dalcin PetscFunctionReturn(0); 1327217044c2SLisandro Dalcin } 1328217044c2SLisandro Dalcin 1329f4091ad2SBarry Smith static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm,FILE *fd) 1330f4091ad2SBarry Smith { 1331f4091ad2SBarry Smith PetscErrorCode ierr; 1332f4091ad2SBarry Smith 1333f4091ad2SBarry Smith PetscFunctionBegin; 133476bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1335f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1336f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1337f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1338f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1339f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1340217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This code was compiled with a debugging option. #\n");CHKERRQ(ierr); 1341f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # To get timing results run ./configure #\n");CHKERRQ(ierr); 1342f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # using --with-debugging=no, the performance will #\n");CHKERRQ(ierr); 1343f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # be generally two or three times faster. #\n");CHKERRQ(ierr); 1344f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1345f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 134676bd3646SJed Brown } 1347f4091ad2SBarry Smith PetscFunctionReturn(0); 1348f4091ad2SBarry Smith } 1349f4091ad2SBarry Smith 1350c2a741eeSJunchao Zhang static PetscErrorCode PetscLogViewWarnNoGpuAwareMpi(MPI_Comm comm,FILE *fd) 1351c2a741eeSJunchao Zhang { 1352c2a741eeSJunchao Zhang #if defined(PETSC_HAVE_CUDA) 1353c2a741eeSJunchao Zhang PetscErrorCode ierr; 1354c2a741eeSJunchao Zhang 1355c2a741eeSJunchao Zhang PetscFunctionBegin; 1356c2a741eeSJunchao Zhang if (use_gpu_aware_mpi) PetscFunctionReturn(0); 1357c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1358c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1359c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1360c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1361c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1362c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " # This code was compiled with GPU support but you used #\n");CHKERRQ(ierr); 1363c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " # an MPI that's not GPU-aware, such Petsc had to copy #\n");CHKERRQ(ierr); 1364c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " # data from GPU to CPU for MPI communication. To get #\n");CHKERRQ(ierr); 1365c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " # meaningfull timing results, please use a GPU-aware #\n");CHKERRQ(ierr); 1366c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " # MPI instead. #\n");CHKERRQ(ierr); 1367c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 1368c2a741eeSJunchao Zhang PetscFunctionReturn(0); 1369c2a741eeSJunchao Zhang #else 1370c2a741eeSJunchao Zhang return 0; 1371c2a741eeSJunchao Zhang #endif 1372c2a741eeSJunchao Zhang } 1373c2a741eeSJunchao Zhang 1374f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP) 1375f90b075cSBarry Smith extern PetscInt PetscNumOMPThreads; 1376f90b075cSBarry Smith #endif 1377f90b075cSBarry Smith 1378f14045dbSBarry Smith PetscErrorCode PetscLogView_Default(PetscViewer viewer) 13795c6c1daeSBarry Smith { 13805c6c1daeSBarry Smith FILE *fd; 13815c6c1daeSBarry Smith PetscLogDouble zero = 0.0; 13825c6c1daeSBarry Smith PetscStageLog stageLog; 13830298fd71SBarry Smith PetscStageInfo *stageInfo = NULL; 13840298fd71SBarry Smith PetscEventPerfInfo *eventInfo = NULL; 13855c6c1daeSBarry Smith PetscClassPerfInfo *classInfo; 13865c6c1daeSBarry Smith char arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128]; 13875c6c1daeSBarry Smith const char *name; 13885c6c1daeSBarry Smith PetscLogDouble locTotalTime, TotalTime, TotalFlops; 13895c6c1daeSBarry Smith PetscLogDouble numMessages, messageLength, avgMessLen, numReductions; 13905c6c1daeSBarry Smith PetscLogDouble stageTime, flops, flopr, mem, mess, messLen, red; 13915c6c1daeSBarry Smith PetscLogDouble fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed; 13925c6c1daeSBarry Smith PetscLogDouble fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed; 13935c6c1daeSBarry Smith PetscLogDouble min, max, tot, ratio, avg, x, y; 1394e3ed9ee7SBarry Smith PetscLogDouble minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr, mal, malmax, emalmax; 1395bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1396958c4211Shannah_mairs PetscLogDouble cct, gct, csz, gsz, gmaxt, gflops, gflopr, fracgflops; 1397bec0b493Shannah_mairs #endif 1398217044c2SLisandro Dalcin PetscMPIInt minC, maxC; 13995c6c1daeSBarry Smith PetscMPIInt size, rank; 14005c6c1daeSBarry Smith PetscBool *localStageUsed, *stageUsed; 14015c6c1daeSBarry Smith PetscBool *localStageVisible, *stageVisible; 14025c6c1daeSBarry Smith int numStages, localNumEvents, numEvents; 140337b78d16SBarry Smith int stage, oclass; 14045c6c1daeSBarry Smith PetscLogEvent event; 14055c6c1daeSBarry Smith PetscErrorCode ierr; 14065c6c1daeSBarry Smith char version[256]; 14075c6c1daeSBarry Smith MPI_Comm comm; 14085c6c1daeSBarry Smith 14095c6c1daeSBarry Smith PetscFunctionBegin; 14105c6c1daeSBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 14115c6c1daeSBarry Smith ierr = PetscViewerASCIIGetPointer(viewer,&fd);CHKERRQ(ierr); 14125c6c1daeSBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 14135c6c1daeSBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 14145c6c1daeSBarry Smith /* Get the total elapsed time */ 14158563dfccSBarry Smith PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 14165c6c1daeSBarry Smith 14175c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr); 14185c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "*** WIDEN YOUR WINDOW TO 120 CHARACTERS. Use 'enscript -r -fCourier9' to print this document ***\n");CHKERRQ(ierr); 14195c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr); 14205c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n---------------------------------------------- PETSc Performance Summary: ----------------------------------------------\n\n");CHKERRQ(ierr); 1421217044c2SLisandro Dalcin ierr = PetscLogViewWarnSync(comm,fd);CHKERRQ(ierr); 1422f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 1423c2a741eeSJunchao Zhang ierr = PetscLogViewWarnNoGpuAwareMpi(comm,fd);CHKERRQ(ierr); 14245c6c1daeSBarry Smith ierr = PetscGetArchType(arch,sizeof(arch));CHKERRQ(ierr); 14255c6c1daeSBarry Smith ierr = PetscGetHostName(hostname,sizeof(hostname));CHKERRQ(ierr); 14265c6c1daeSBarry Smith ierr = PetscGetUserName(username,sizeof(username));CHKERRQ(ierr); 14275c6c1daeSBarry Smith ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr); 14285c6c1daeSBarry Smith ierr = PetscGetDate(date,sizeof(date));CHKERRQ(ierr); 14295c6c1daeSBarry Smith ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr); 14305c6c1daeSBarry Smith if (size == 1) { 14315c6c1daeSBarry 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); 14325c6c1daeSBarry Smith } else { 14335c6c1daeSBarry 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); 14345c6c1daeSBarry Smith } 1435f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP) 1436f90b075cSBarry Smith ierr = PetscFPrintf(comm,fd,"Using %D OpenMP threads\n", PetscNumOMPThreads);CHKERRQ(ierr); 1437f90b075cSBarry Smith #endif 14385c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Using %s\n", version);CHKERRQ(ierr); 14395c6c1daeSBarry Smith 14405c6c1daeSBarry Smith /* Must preserve reduction count before we go on */ 14415c6c1daeSBarry Smith red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 14425c6c1daeSBarry Smith 14435c6c1daeSBarry Smith /* Calculate summary information */ 14445c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n Max Max/Min Avg Total\n");CHKERRQ(ierr); 14455c6c1daeSBarry Smith /* Time */ 1446b2566f29SBarry Smith ierr = MPIU_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1447b2566f29SBarry Smith ierr = MPIU_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1448b2566f29SBarry Smith ierr = MPIU_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1449217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1450217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1451217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Time (sec): %5.3e %7.3f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 14525c6c1daeSBarry Smith TotalTime = tot; 14535c6c1daeSBarry Smith /* Objects */ 14545c6c1daeSBarry Smith avg = (PetscLogDouble) petsc_numObjects; 1455b2566f29SBarry Smith ierr = MPIU_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1456b2566f29SBarry Smith ierr = MPIU_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1457b2566f29SBarry Smith ierr = MPIU_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1458217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1459217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1460217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Objects: %5.3e %7.3f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 14615c6c1daeSBarry Smith /* Flops */ 1462b2566f29SBarry Smith ierr = MPIU_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1463b2566f29SBarry Smith ierr = MPIU_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1464b2566f29SBarry Smith ierr = MPIU_Allreduce(&petsc_TotalFlops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1465217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1466217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1467217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Flop: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14685c6c1daeSBarry Smith TotalFlops = tot; 14695c6c1daeSBarry Smith /* Flops/sec -- Must talk to Barry here */ 1470217044c2SLisandro Dalcin if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime; else flops = 0.0; 1471b2566f29SBarry Smith ierr = MPIU_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1472b2566f29SBarry Smith ierr = MPIU_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1473b2566f29SBarry Smith ierr = MPIU_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1474217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1475217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1476217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Flop/sec: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14775c6c1daeSBarry Smith /* Memory */ 14785c6c1daeSBarry Smith ierr = PetscMallocGetMaximumUsage(&mem);CHKERRQ(ierr); 14795c6c1daeSBarry Smith if (mem > 0.0) { 1480b2566f29SBarry Smith ierr = MPIU_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1481217044c2SLisandro Dalcin ierr = MPIU_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1482b2566f29SBarry Smith ierr = MPIU_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1483217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1484217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1485217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Memory: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14865c6c1daeSBarry Smith } 14875c6c1daeSBarry Smith /* Messages */ 14885c6c1daeSBarry Smith mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct); 1489b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1490b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1491b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1492217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1493217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1494217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Messages: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14955c6c1daeSBarry Smith numMessages = tot; 14965c6c1daeSBarry Smith /* Message Lengths */ 14975c6c1daeSBarry Smith mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len); 1498b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1499b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1500b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1501217044c2SLisandro Dalcin if (numMessages != 0) avg = tot/numMessages; else avg = 0.0; 1502217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1503217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Message Lengths: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 15045c6c1daeSBarry Smith messageLength = tot; 15055c6c1daeSBarry Smith /* Reductions */ 1506b2566f29SBarry Smith ierr = MPIU_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1507b2566f29SBarry Smith ierr = MPIU_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1508b2566f29SBarry Smith ierr = MPIU_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1509217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1510217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Reductions: %5.3e %7.3f\n", max, ratio);CHKERRQ(ierr); 15115c6c1daeSBarry Smith numReductions = red; /* wrong because uses count from process zero */ 15125c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n");CHKERRQ(ierr); 1513d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " e.g., VecAXPY() for real vectors of length N --> 2N flop\n");CHKERRQ(ierr); 1514d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " and VecAXPY() for complex vectors of length N --> 8N flop\n");CHKERRQ(ierr); 15155c6c1daeSBarry Smith 15165c6c1daeSBarry Smith /* Get total number of stages -- 15175c6c1daeSBarry Smith Currently, a single processor can register more stages than another, but stages must all be registered in order. 15185c6c1daeSBarry Smith We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID. 15195c6c1daeSBarry Smith This seems best accomplished by assoicating a communicator with each stage. 15205c6c1daeSBarry Smith */ 152137b78d16SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1522b2566f29SBarry Smith ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1523785e854fSJed Brown ierr = PetscMalloc1(numStages, &localStageUsed);CHKERRQ(ierr); 1524785e854fSJed Brown ierr = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr); 1525785e854fSJed Brown ierr = PetscMalloc1(numStages, &localStageVisible);CHKERRQ(ierr); 1526785e854fSJed Brown ierr = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr); 15275c6c1daeSBarry Smith if (numStages > 0) { 15285c6c1daeSBarry Smith stageInfo = stageLog->stageInfo; 15295c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 15305c6c1daeSBarry Smith if (stage < stageLog->numStages) { 15315c6c1daeSBarry Smith localStageUsed[stage] = stageInfo[stage].used; 15325c6c1daeSBarry Smith localStageVisible[stage] = stageInfo[stage].perfInfo.visible; 15335c6c1daeSBarry Smith } else { 15345c6c1daeSBarry Smith localStageUsed[stage] = PETSC_FALSE; 15355c6c1daeSBarry Smith localStageVisible[stage] = PETSC_TRUE; 15365c6c1daeSBarry Smith } 15375c6c1daeSBarry Smith } 1538b2566f29SBarry Smith ierr = MPIU_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm);CHKERRQ(ierr); 1539b2566f29SBarry Smith ierr = MPIU_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr); 15405c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 15415c6c1daeSBarry Smith if (stageUsed[stage]) { 1542217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "\nSummary of Stages: ----- Time ------ ----- Flop ------ --- Messages --- -- Message Lengths -- -- Reductions --\n");CHKERRQ(ierr); 1543217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " Avg %%Total Avg %%Total Count %%Total Avg %%Total Count %%Total\n");CHKERRQ(ierr); 15445c6c1daeSBarry Smith break; 15455c6c1daeSBarry Smith } 15465c6c1daeSBarry Smith } 15475c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 15485c6c1daeSBarry Smith if (!stageUsed[stage]) continue; 154950a9567dSMatthew G. Knepley /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 15505c6c1daeSBarry Smith if (localStageUsed[stage]) { 155150a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 155250a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 155350a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 155450a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 155550a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15565c6c1daeSBarry Smith name = stageInfo[stage].name; 15575c6c1daeSBarry Smith } else { 155850a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 155950a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 156050a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 156150a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 156250a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15635c6c1daeSBarry Smith name = ""; 15645c6c1daeSBarry Smith } 15655c6c1daeSBarry Smith mess *= 0.5; messLen *= 0.5; red /= size; 15665c6c1daeSBarry Smith if (TotalTime != 0.0) fracTime = stageTime/TotalTime; else fracTime = 0.0; 15675c6c1daeSBarry Smith if (TotalFlops != 0.0) fracFlops = flops/TotalFlops; else fracFlops = 0.0; 15685c6c1daeSBarry Smith /* Talk to Barry if (stageTime != 0.0) flops = (size*flops)/stageTime; else flops = 0.0; */ 15695c6c1daeSBarry Smith if (numMessages != 0.0) fracMessages = mess/numMessages; else fracMessages = 0.0; 1570e96a4d02SJunchao Zhang if (mess != 0.0) avgMessLen = messLen/mess; else avgMessLen = 0.0; 15715c6c1daeSBarry Smith if (messageLength != 0.0) fracLength = messLen/messageLength; else fracLength = 0.0; 15725c6c1daeSBarry Smith if (numReductions != 0.0) fracReductions = red/numReductions; else fracReductions = 0.0; 15735c6c1daeSBarry 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", 15745c6c1daeSBarry Smith stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops, 15755c6c1daeSBarry Smith mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr); 15765c6c1daeSBarry Smith } 15775c6c1daeSBarry Smith } 15785c6c1daeSBarry Smith 1579806fa848SBarry Smith ierr = PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 15805c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n");CHKERRQ(ierr); 15815c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Phase summary info:\n");CHKERRQ(ierr); 15825c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Count: number of times phase was executed\n");CHKERRQ(ierr); 1583d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " Time and Flop: Max - maximum over all processors\n");CHKERRQ(ierr); 15845c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Ratio - ratio of maximum to minimum over all processors\n");CHKERRQ(ierr); 15855c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Mess: number of messages sent\n");CHKERRQ(ierr); 1586217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " AvgLen: average message length (bytes)\n");CHKERRQ(ierr); 15875c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Reduct: number of global reductions\n");CHKERRQ(ierr); 15885c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Global: entire computation\n");CHKERRQ(ierr); 15895c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n");CHKERRQ(ierr); 1590d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " %%T - percent time in this phase %%F - percent flop in this phase\n");CHKERRQ(ierr); 15915c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " %%M - percent messages in this phase %%L - percent message lengths in this phase\n");CHKERRQ(ierr); 15925c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " %%R - percent reductions in this phase\n");CHKERRQ(ierr); 1593d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n");CHKERRQ(ierr); 1594e3ed9ee7SBarry Smith if (PetscLogMemory) { 1595e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event)\n");CHKERRQ(ierr); 1596e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events)\n");CHKERRQ(ierr); 1597e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event)\n");CHKERRQ(ierr); 1598e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " RMI Mbytes: Increase in resident memory (sum over all calls to event)\n");CHKERRQ(ierr); 1599e3ed9ee7SBarry Smith } 1600bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1601958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd, " GPU Mflop/s: 10e-6 * (sum of flop on GPU over all processors)/(max GPU time over all processors)\n");CHKERRQ(ierr); 16024863603aSSatish Balay ierr = PetscFPrintf(comm, fd, " CpuToGpu Count: total number of CPU to GPU copies per processor\n");CHKERRQ(ierr); 16034863603aSSatish Balay ierr = PetscFPrintf(comm, fd, " CpuToGpu Size (Mbytes): 10e-6 * (total size of CPU to GPU copies per processor)\n");CHKERRQ(ierr); 16044863603aSSatish Balay ierr = PetscFPrintf(comm, fd, " GpuToCpu Count: total number of GPU to CPU copies per processor\n");CHKERRQ(ierr); 16054863603aSSatish Balay ierr = PetscFPrintf(comm, fd, " GpuToCpu Size (Mbytes): 10e-6 * (total size of GPU to CPU copies per processor)\n");CHKERRQ(ierr); 1606958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd, " GPU %%F: percent flops on GPU in this event\n");CHKERRQ(ierr); 1607bec0b493Shannah_mairs #endif 1608806fa848SBarry Smith ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 16095c6c1daeSBarry Smith 1610f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 16115c6c1daeSBarry Smith 16125c6c1daeSBarry Smith /* Report events */ 1613e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd,"Event Count Time (sec) Flop --- Global --- --- Stage ---- Total");CHKERRQ(ierr); 1614e3ed9ee7SBarry Smith if (PetscLogMemory) { 1615bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd," Malloc EMalloc MMalloc RMI");CHKERRQ(ierr); 1616e3ed9ee7SBarry Smith } 1617bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1618958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd," GPU - CpuToGpu - - GpuToCpu - GPU");CHKERRQ(ierr); 1619bec0b493Shannah_mairs #endif 1620bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 1621e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd," Max Ratio Max Ratio Max Ratio Mess AvgLen Reduct %%T %%F %%M %%L %%R %%T %%F %%M %%L %%R Mflop/s");CHKERRQ(ierr); 1622e3ed9ee7SBarry Smith if (PetscLogMemory) { 1623bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd," Mbytes Mbytes Mbytes Mbytes");CHKERRQ(ierr); 1624e3ed9ee7SBarry Smith } 1625bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1626958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd," Mflop/s Count Size Count Size %%F");CHKERRQ(ierr); 1627bec0b493Shannah_mairs #endif 1628bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 16294863603aSSatish Balay ierr = PetscFPrintf(comm, fd,"------------------------------------------------------------------------------------------------------------------------");CHKERRQ(ierr); 16304863603aSSatish Balay if (PetscLogMemory) { 16314863603aSSatish Balay ierr = PetscFPrintf(comm, fd,"-----------------------------");CHKERRQ(ierr); 16324863603aSSatish Balay } 16334863603aSSatish Balay #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1634958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd,"---------------------------------------");CHKERRQ(ierr); 16354863603aSSatish Balay #endif 16364863603aSSatish Balay ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 16375c6c1daeSBarry Smith 16385c6c1daeSBarry Smith /* Problem: The stage name will not show up unless the stage executed on proc 1 */ 16395c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16405c6c1daeSBarry Smith if (!stageVisible[stage]) continue; 164150a9567dSMatthew G. Knepley /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 16425c6c1daeSBarry Smith if (localStageUsed[stage]) { 16435c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 164450a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 164550a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 164650a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 164750a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 164850a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 16495c6c1daeSBarry Smith } else { 16505c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 165150a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 165250a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 165350a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 165450a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 165550a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 16565c6c1daeSBarry Smith } 16575c6c1daeSBarry Smith mess *= 0.5; messLen *= 0.5; red /= size; 16585c6c1daeSBarry Smith 16595c6c1daeSBarry Smith /* Get total number of events in this stage -- 16605c6c1daeSBarry Smith Currently, a single processor can register more events than another, but events must all be registered in order, 16615c6c1daeSBarry Smith just like stages. We can removed this requirement if necessary by having a global event numbering and indirection 1662217044c2SLisandro Dalcin on the event ID. This seems best accomplished by associating a communicator with each stage. 16635c6c1daeSBarry Smith 16645c6c1daeSBarry Smith Problem: If the event did not happen on proc 1, its name will not be available. 16655c6c1daeSBarry Smith Problem: Event visibility is not implemented 16665c6c1daeSBarry Smith */ 16675c6c1daeSBarry Smith if (localStageUsed[stage]) { 16685c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo; 16695c6c1daeSBarry Smith localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents; 1670a297a907SKarl Rupp } else localNumEvents = 0; 1671b2566f29SBarry Smith ierr = MPIU_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 16725c6c1daeSBarry Smith for (event = 0; event < numEvents; event++) { 167350a9567dSMatthew G. Knepley /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 16745c6c1daeSBarry Smith if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) { 1675217044c2SLisandro Dalcin if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; else flopr = 0.0; 167650a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 167750a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 167850a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 167950a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 168050a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 168150a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 168250a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 168350a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 168450a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1685217044c2SLisandro Dalcin ierr = MPI_Allreduce(&eventInfo[event].count, &minC, 1, MPI_INT, MPI_MIN, comm);CHKERRQ(ierr); 1686217044c2SLisandro Dalcin ierr = MPI_Allreduce(&eventInfo[event].count, &maxC, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1687e3ed9ee7SBarry Smith if (PetscLogMemory) { 1688e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&eventInfo[event].memIncrease, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1689e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&eventInfo[event].mallocSpace, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1690e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&eventInfo[event].mallocIncrease, &malmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1691e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1692e3ed9ee7SBarry Smith } 1693bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1694bec0b493Shannah_mairs ierr = MPI_Allreduce(&eventInfo[event].CpuToGpuCount, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1695bec0b493Shannah_mairs ierr = MPI_Allreduce(&eventInfo[event].GpuToCpuCount, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1696bec0b493Shannah_mairs ierr = MPI_Allreduce(&eventInfo[event].CpuToGpuSize, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1697bec0b493Shannah_mairs ierr = MPI_Allreduce(&eventInfo[event].GpuToCpuSize, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1698958c4211Shannah_mairs ierr = MPI_Allreduce(&eventInfo[event].GpuFlops, &gflops,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1699958c4211Shannah_mairs ierr = MPI_Allreduce(&eventInfo[event].GpuTime, &gmaxt ,1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1700bec0b493Shannah_mairs #endif 17015c6c1daeSBarry Smith name = stageLog->eventLog->eventInfo[event].name; 17025c6c1daeSBarry Smith } else { 17035c6c1daeSBarry Smith flopr = 0.0; 170450a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 170550a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 170650a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 170750a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 170850a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 170950a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 171050a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 171150a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 171250a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1713217044c2SLisandro Dalcin ierr = MPI_Allreduce(&ierr, &minC, 1, MPI_INT, MPI_MIN, comm);CHKERRQ(ierr); 1714217044c2SLisandro Dalcin ierr = MPI_Allreduce(&ierr, &maxC, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1715e3ed9ee7SBarry Smith if (PetscLogMemory) { 1716e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&zero, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1717e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&zero, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1718e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&zero, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1719e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&zero, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1720e3ed9ee7SBarry Smith } 1721bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1722bec0b493Shannah_mairs ierr = MPI_Allreduce(&zero, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1723bec0b493Shannah_mairs ierr = MPI_Allreduce(&zero, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1724bec0b493Shannah_mairs ierr = MPI_Allreduce(&zero, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1725bec0b493Shannah_mairs ierr = MPI_Allreduce(&zero, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1726958c4211Shannah_mairs ierr = MPI_Allreduce(&zero, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1727958c4211Shannah_mairs ierr = MPI_Allreduce(&zero, &gmaxt , 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1728bec0b493Shannah_mairs #endif 17295c6c1daeSBarry Smith name = ""; 17305c6c1daeSBarry Smith } 17315c6c1daeSBarry Smith if (mint < 0.0) { 17325c6c1daeSBarry 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); 17335c6c1daeSBarry Smith mint = 0; 17345c6c1daeSBarry Smith } 1735d4aa7d5fSBarry Smith if (minf < 0.0) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Minimum flop %g over all processors for %s is negative! Not possible!",minf,name); 17365c6c1daeSBarry Smith totm *= 0.5; totml *= 0.5; totr /= size; 17375c6c1daeSBarry Smith 1738217044c2SLisandro Dalcin if (maxC != 0) { 1739217044c2SLisandro Dalcin if (minC != 0) ratC = ((PetscLogDouble)maxC)/minC;else ratC = 0.0; 17405c6c1daeSBarry Smith if (mint != 0.0) ratt = maxt/mint; else ratt = 0.0; 17415c6c1daeSBarry Smith if (minf != 0.0) ratf = maxf/minf; else ratf = 0.0; 17425c6c1daeSBarry Smith if (TotalTime != 0.0) fracTime = tott/TotalTime; else fracTime = 0.0; 17435c6c1daeSBarry Smith if (TotalFlops != 0.0) fracFlops = totf/TotalFlops; else fracFlops = 0.0; 17445c6c1daeSBarry Smith if (stageTime != 0.0) fracStageTime = tott/stageTime; else fracStageTime = 0.0; 17455c6c1daeSBarry Smith if (flops != 0.0) fracStageFlops = totf/flops; else fracStageFlops = 0.0; 17465c6c1daeSBarry Smith if (numMessages != 0.0) fracMess = totm/numMessages; else fracMess = 0.0; 17475c6c1daeSBarry Smith if (messageLength != 0.0) fracMessLen = totml/messageLength; else fracMessLen = 0.0; 17485c6c1daeSBarry Smith if (numReductions != 0.0) fracRed = totr/numReductions; else fracRed = 0.0; 17495c6c1daeSBarry Smith if (mess != 0.0) fracStageMess = totm/mess; else fracStageMess = 0.0; 17505c6c1daeSBarry Smith if (messLen != 0.0) fracStageMessLen = totml/messLen; else fracStageMessLen = 0.0; 17515c6c1daeSBarry Smith if (red != 0.0) fracStageRed = totr/red; else fracStageRed = 0.0; 17525c6c1daeSBarry Smith if (totm != 0.0) totml /= totm; else totml = 0.0; 17535c6c1daeSBarry Smith if (maxt != 0.0) flopr = totf/maxt; else flopr = 0.0; 1754411f5eb9SRichard Tran Mills if (fracStageTime > 1.00) ierr = PetscFPrintf(comm, fd,"Warning -- total time of event greater than time of entire stage -- something is wrong with the timer\n");CHKERRQ(ierr); 17555c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, 1756e3ed9ee7SBarry 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", 1757217044c2SLisandro Dalcin name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr, 17585c6c1daeSBarry Smith 100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed, 17595c6c1daeSBarry Smith 100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed, 1760c068d9bbSLisandro Dalcin PetscAbs(flopr)/1.0e6);CHKERRQ(ierr); 1761e3ed9ee7SBarry Smith if (PetscLogMemory) { 1762bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd," %5.0f %5.0f %5.0f %5.0f",mal/1.0e6,emalmax/1.0e6,malmax/1.0e6,mem/1.0e6);CHKERRQ(ierr); 1763e3ed9ee7SBarry Smith } 1764bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1765958c4211Shannah_mairs if (totf != 0.0) fracgflops = gflops/totf; else fracgflops = 0.0; 1766958c4211Shannah_mairs if (gmaxt != 0.0) gflopr = gflops/gmaxt; else gflopr = 0.0; 1767958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd," %5.0f %4.0f %3.2e %4.0f %3.2e% 3.0f",PetscAbs(gflopr)/1.0e6,cct/size,csz/(1.0e6*size),gct/size,gsz/(1.0e6*size),100.0*fracgflops);CHKERRQ(ierr); 1768bec0b493Shannah_mairs #endif 1769bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 17705c6c1daeSBarry Smith } 17715c6c1daeSBarry Smith } 17725c6c1daeSBarry Smith } 17735c6c1daeSBarry Smith 17745c6c1daeSBarry Smith /* Memory usage and object creation */ 17754863603aSSatish Balay ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------");CHKERRQ(ierr); 17764863603aSSatish Balay if (PetscLogMemory) { 17774863603aSSatish Balay ierr = PetscFPrintf(comm, fd, "-----------------------------");CHKERRQ(ierr); 17784863603aSSatish Balay } 17794863603aSSatish Balay #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1780958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd, "---------------------------------------");CHKERRQ(ierr); 17814863603aSSatish Balay #endif 17824863603aSSatish Balay ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 17835c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 17845c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n");CHKERRQ(ierr); 17855c6c1daeSBarry Smith 17865c6c1daeSBarry Smith /* Right now, only stages on the first processor are reported here, meaning only objects associated with 17875c6c1daeSBarry Smith the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then 17885c6c1daeSBarry Smith stats for stages local to processor sets. 17895c6c1daeSBarry Smith */ 17905c6c1daeSBarry Smith /* We should figure out the longest object name here (now 20 characters) */ 17915c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Object Type Creations Destructions Memory Descendants' Mem.\n");CHKERRQ(ierr); 17925c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Reports information only for process 0.\n");CHKERRQ(ierr); 17935c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 17945c6c1daeSBarry Smith if (localStageUsed[stage]) { 17955c6c1daeSBarry Smith classInfo = stageLog->stageInfo[stage].classLog->classInfo; 17965c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 17975c6c1daeSBarry Smith for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) { 17985c6c1daeSBarry Smith if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) { 17995c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%20s %5d %5d %11.0f %g\n", stageLog->classLog->classInfo[oclass].name, 18005c6c1daeSBarry Smith classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem, 18015c6c1daeSBarry Smith classInfo[oclass].descMem);CHKERRQ(ierr); 18025c6c1daeSBarry Smith } 18035c6c1daeSBarry Smith } 18045c6c1daeSBarry Smith } else { 1805cf019ec6SStefano Zampini if (!localStageVisible[stage]) continue; 18065c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 18075c6c1daeSBarry Smith } 18085c6c1daeSBarry Smith } 18095c6c1daeSBarry Smith 18105c6c1daeSBarry Smith ierr = PetscFree(localStageUsed);CHKERRQ(ierr); 18115c6c1daeSBarry Smith ierr = PetscFree(stageUsed);CHKERRQ(ierr); 18125c6c1daeSBarry Smith ierr = PetscFree(localStageVisible);CHKERRQ(ierr); 18135c6c1daeSBarry Smith ierr = PetscFree(stageVisible);CHKERRQ(ierr); 18145c6c1daeSBarry Smith 18155c6c1daeSBarry Smith /* Information unrelated to this particular run */ 1816a297a907SKarl Rupp ierr = PetscFPrintf(comm, fd, "========================================================================================================================\n");CHKERRQ(ierr); 18178563dfccSBarry Smith PetscTime(&y); 18188563dfccSBarry Smith PetscTime(&x); 18198563dfccSBarry Smith PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 18208563dfccSBarry Smith PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 18215c6c1daeSBarry Smith ierr = PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0);CHKERRQ(ierr); 18225c6c1daeSBarry Smith /* MPI information */ 18235c6c1daeSBarry Smith if (size > 1) { 18245c6c1daeSBarry Smith MPI_Status status; 18255c6c1daeSBarry Smith PetscMPIInt tag; 18265c6c1daeSBarry Smith MPI_Comm newcomm; 18275c6c1daeSBarry Smith 18285c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 18298563dfccSBarry Smith PetscTime(&x); 18305c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 18315c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 18325c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 18335c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 18345c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 18358563dfccSBarry Smith PetscTime(&y); 18365c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0);CHKERRQ(ierr); 18375c6c1daeSBarry Smith ierr = PetscCommDuplicate(comm,&newcomm, &tag);CHKERRQ(ierr); 18385c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 18395c6c1daeSBarry Smith if (rank) { 1840217044c2SLisandro Dalcin ierr = MPI_Recv(NULL, 0, MPI_INT, rank-1, tag, newcomm, &status);CHKERRQ(ierr); 1841217044c2SLisandro Dalcin ierr = MPI_Send(NULL, 0, MPI_INT, (rank+1)%size, tag, newcomm);CHKERRQ(ierr); 18425c6c1daeSBarry Smith } else { 18438563dfccSBarry Smith PetscTime(&x); 1844217044c2SLisandro Dalcin ierr = MPI_Send(NULL, 0, MPI_INT, 1, tag, newcomm);CHKERRQ(ierr); 1845217044c2SLisandro Dalcin ierr = MPI_Recv(NULL, 0, MPI_INT, size-1, tag, newcomm, &status);CHKERRQ(ierr); 18468563dfccSBarry Smith PetscTime(&y); 18475c6c1daeSBarry Smith ierr = PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size);CHKERRQ(ierr); 18485c6c1daeSBarry Smith } 18495c6c1daeSBarry Smith ierr = PetscCommDestroy(&newcomm);CHKERRQ(ierr); 18505c6c1daeSBarry Smith } 1851c5929fdfSBarry Smith ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr); 18525c6c1daeSBarry Smith 18535c6c1daeSBarry Smith /* Machine and compile information */ 18545c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS) 18555c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n");CHKERRQ(ierr); 18565c6c1daeSBarry Smith #else 18575c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n");CHKERRQ(ierr); 18585c6c1daeSBarry Smith #endif 1859217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) 1860217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n");CHKERRQ(ierr); 1861217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128) 1862217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n");CHKERRQ(ierr); 1863217044c2SLisandro Dalcin #endif 18645c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 18655c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 18665f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128) 18675f27b2e0SBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 18685c6c1daeSBarry Smith #endif 18695c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE) 18705c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with single precision matrices\n");CHKERRQ(ierr); 18715c6c1daeSBarry Smith #else 18725c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n");CHKERRQ(ierr); 18735c6c1daeSBarry Smith #endif 18745c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n", 18755c6c1daeSBarry Smith (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt));CHKERRQ(ierr); 18765c6c1daeSBarry Smith 18775c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions);CHKERRQ(ierr); 18785c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petscmachineinfo);CHKERRQ(ierr); 18795c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsccompilerinfo);CHKERRQ(ierr); 18805c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo);CHKERRQ(ierr); 18815c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsclinkerinfo);CHKERRQ(ierr); 18825c6c1daeSBarry Smith 18835c6c1daeSBarry Smith /* Cleanup */ 18845c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 1885c2a741eeSJunchao Zhang ierr = PetscLogViewWarnNoGpuAwareMpi(comm,fd);CHKERRQ(ierr); 1886f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 18875c6c1daeSBarry Smith PetscFunctionReturn(0); 18885c6c1daeSBarry Smith } 18895c6c1daeSBarry Smith 18907d6c928cSSatish Balay /*@C 18917d6c928cSSatish Balay PetscLogView - Prints a summary of the logging. 18925c6c1daeSBarry Smith 18935c6c1daeSBarry Smith Collective over MPI_Comm 18945c6c1daeSBarry Smith 18955c6c1daeSBarry Smith Input Parameter: 1896f14045dbSBarry Smith . viewer - an ASCII viewer 18975c6c1daeSBarry Smith 18985c6c1daeSBarry Smith Options Database Keys: 1899bb1d7374SBarry Smith + -log_view [:filename] - Prints summary of log information 1900bb1d7374SBarry Smith . -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file 1901607d249eSBarry Smith . -log_view :filename.xml:ascii_xml - Saves a summary of the logging information in a nested format (see below for how to view it) 1902bb1d7374SBarry Smith . -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation 1903bb1d7374SBarry Smith - -log_trace [filename] - Displays a trace of what each process is doing 19045c6c1daeSBarry Smith 19055c6c1daeSBarry Smith Notes: 1906bb1d7374SBarry Smith It is possible to control the logging programatically but we recommend using the options database approach whenever possible 19075c6c1daeSBarry Smith By default the summary is printed to stdout. 19085c6c1daeSBarry Smith 1909bb1d7374SBarry Smith Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin() 1910bb1d7374SBarry Smith 1911bb1d7374SBarry Smith If PETSc is configured with --with-logging=0 then this functionality is not available 1912bb1d7374SBarry Smith 1913607d249eSBarry Smith To view the nested XML format filename.xml first copy ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current 1914607d249eSBarry Smith directory then open filename.xml with your browser. Specific notes for certain browsers 1915607d249eSBarry Smith $ Firefox and Internet explorer - simply open the file 1916607d249eSBarry Smith $ Google Chrome - you must start up Chrome with the option --allow-file-access-from-files 1917a8d69d7bSBarry Smith $ Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access 1918607d249eSBarry Smith or one can use the package http://xmlsoft.org/XSLT/xsltproc2.html to translate the xml file to html and then open it with 1919607d249eSBarry Smith your browser. 19202add09c0SLisandro Dalcin Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser 19212add09c0SLisandro Dalcin window and render the XML log file contents. 1922607d249eSBarry Smith 1923bb1d7374SBarry Smith The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij MARITIME RESEARCH INSTITUTE NETHERLANDS 1924bb1d7374SBarry Smith 19255c6c1daeSBarry Smith Level: beginner 19265c6c1daeSBarry Smith 1927bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogDump() 19285c6c1daeSBarry Smith @*/ 1929f14045dbSBarry Smith PetscErrorCode PetscLogView(PetscViewer viewer) 19305c6c1daeSBarry Smith { 19315c6c1daeSBarry Smith PetscErrorCode ierr; 1932f14045dbSBarry Smith PetscBool isascii; 1933f14045dbSBarry Smith PetscViewerFormat format; 193437b78d16SBarry Smith int stage, lastStage; 193537b78d16SBarry Smith PetscStageLog stageLog; 19365c6c1daeSBarry Smith 19375c6c1daeSBarry Smith PetscFunctionBegin; 1938609bdbeeSBarry Smith if (!PetscLogPLB) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Must use -log_view or PetscLogDefaultBegin() before calling this routine"); 193937b78d16SBarry Smith /* Pop off any stages the user forgot to remove */ 194037b78d16SBarry Smith lastStage = 0; 194137b78d16SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 194237b78d16SBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 194337b78d16SBarry Smith while (stage >= 0) { 194437b78d16SBarry Smith lastStage = stage; 194537b78d16SBarry Smith ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 194637b78d16SBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 194737b78d16SBarry Smith } 1948f14045dbSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 1949f14045dbSBarry Smith if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Currently can only view logging to ASCII"); 1950f14045dbSBarry Smith ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr); 1951f14045dbSBarry Smith if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) { 1952f14045dbSBarry Smith ierr = PetscLogView_Default(viewer);CHKERRQ(ierr); 1953f14045dbSBarry Smith } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) { 1954f14045dbSBarry Smith ierr = PetscLogView_Detailed(viewer);CHKERRQ(ierr); 195538144912Sdeepblu2718 } else if (format == PETSC_VIEWER_ASCII_CSV) { 195638144912Sdeepblu2718 ierr = PetscLogView_CSV(viewer);CHKERRQ(ierr); 1957bb1d7374SBarry Smith } else if (format == PETSC_VIEWER_ASCII_XML) { 1958bb1d7374SBarry Smith ierr = PetscLogView_Nested(viewer);CHKERRQ(ierr); 19595c6c1daeSBarry Smith } 196037b78d16SBarry Smith ierr = PetscStageLogPush(stageLog, lastStage);CHKERRQ(ierr); 19615c6c1daeSBarry Smith PetscFunctionReturn(0); 19625c6c1daeSBarry Smith } 19635c6c1daeSBarry Smith 1964f14045dbSBarry Smith /*@C 1965f14045dbSBarry Smith PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed. 1966f14045dbSBarry Smith 1967f14045dbSBarry Smith Collective on PETSC_COMM_WORLD 1968f14045dbSBarry Smith 1969f14045dbSBarry Smith Not normally called by user 1970f14045dbSBarry Smith 1971f14045dbSBarry Smith Level: intermediate 1972f14045dbSBarry Smith 1973f14045dbSBarry Smith @*/ 1974f14045dbSBarry Smith PetscErrorCode PetscLogViewFromOptions(void) 1975f14045dbSBarry Smith { 1976f14045dbSBarry Smith PetscErrorCode ierr; 1977f14045dbSBarry Smith PetscViewer viewer; 1978f14045dbSBarry Smith PetscBool flg; 1979f14045dbSBarry Smith PetscViewerFormat format; 1980f14045dbSBarry Smith 1981f14045dbSBarry Smith PetscFunctionBegin; 198216413a6aSBarry Smith ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-log_view",&viewer,&format,&flg);CHKERRQ(ierr); 1983f14045dbSBarry Smith if (flg) { 1984f14045dbSBarry Smith ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 1985f14045dbSBarry Smith ierr = PetscLogView(viewer);CHKERRQ(ierr); 1986f14045dbSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 1987f14045dbSBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1988f14045dbSBarry Smith } 1989f14045dbSBarry Smith PetscFunctionReturn(0); 1990f14045dbSBarry Smith } 1991f14045dbSBarry Smith 1992f14045dbSBarry Smith 1993f14045dbSBarry Smith 19945c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/ 19955c6c1daeSBarry Smith /*@C 19965c6c1daeSBarry Smith PetscGetFlops - Returns the number of flops used on this processor 19975c6c1daeSBarry Smith since the program began. 19985c6c1daeSBarry Smith 19995c6c1daeSBarry Smith Not Collective 20005c6c1daeSBarry Smith 20015c6c1daeSBarry Smith Output Parameter: 20025c6c1daeSBarry Smith flops - number of floating point operations 20035c6c1daeSBarry Smith 20045c6c1daeSBarry Smith Notes: 20055c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 20065c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 20075c6c1daeSBarry Smith application code. 20085c6c1daeSBarry Smith 20095c6c1daeSBarry Smith Level: intermediate 20105c6c1daeSBarry Smith 20118563dfccSBarry Smith .seealso: PetscTime(), PetscLogFlops() 20125c6c1daeSBarry Smith @*/ 20135c6c1daeSBarry Smith PetscErrorCode PetscGetFlops(PetscLogDouble *flops) 20145c6c1daeSBarry Smith { 20155c6c1daeSBarry Smith PetscFunctionBegin; 20165c6c1daeSBarry Smith *flops = petsc_TotalFlops; 20175c6c1daeSBarry Smith PetscFunctionReturn(0); 20185c6c1daeSBarry Smith } 20195c6c1daeSBarry Smith 20205c6c1daeSBarry Smith PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 20215c6c1daeSBarry Smith { 20225c6c1daeSBarry Smith PetscErrorCode ierr; 20235c6c1daeSBarry Smith size_t fullLength; 20245c6c1daeSBarry Smith va_list Argp; 20255c6c1daeSBarry Smith 20265c6c1daeSBarry Smith PetscFunctionBegin; 20275c6c1daeSBarry Smith if (!petsc_logObjects) PetscFunctionReturn(0); 20285c6c1daeSBarry Smith va_start(Argp, format); 20295c6c1daeSBarry Smith ierr = PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp);CHKERRQ(ierr); 20305c6c1daeSBarry Smith va_end(Argp); 20315c6c1daeSBarry Smith PetscFunctionReturn(0); 20325c6c1daeSBarry Smith } 20335c6c1daeSBarry Smith 20345c6c1daeSBarry Smith 20355c6c1daeSBarry Smith /*MC 20365c6c1daeSBarry Smith PetscLogFlops - Adds floating point operations to the global counter. 20375c6c1daeSBarry Smith 20385c6c1daeSBarry Smith Synopsis: 2039aaa7dc30SBarry Smith #include <petsclog.h> 20405c6c1daeSBarry Smith PetscErrorCode PetscLogFlops(PetscLogDouble f) 20415c6c1daeSBarry Smith 20425c6c1daeSBarry Smith Not Collective 20435c6c1daeSBarry Smith 20445c6c1daeSBarry Smith Input Parameter: 20455c6c1daeSBarry Smith . f - flop counter 20465c6c1daeSBarry Smith 20475c6c1daeSBarry Smith 20485c6c1daeSBarry Smith Usage: 20495c6c1daeSBarry Smith .vb 20505c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 20515c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 20525c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 20535c6c1daeSBarry Smith [code segment to monitor] 20545c6c1daeSBarry Smith PetscLogFlops(user_flops) 20555c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 20565c6c1daeSBarry Smith .ve 20575c6c1daeSBarry Smith 20585c6c1daeSBarry Smith Notes: 20595c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 20605c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 20615c6c1daeSBarry Smith application code. 20625c6c1daeSBarry Smith 20635c6c1daeSBarry Smith Level: intermediate 20645c6c1daeSBarry Smith 20655c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscGetFlops() 20665c6c1daeSBarry Smith 20675c6c1daeSBarry Smith M*/ 20685c6c1daeSBarry Smith 20695c6c1daeSBarry Smith /*MC 20705c6c1daeSBarry Smith PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice) 20715c6c1daeSBarry Smith to get accurate timings 20725c6c1daeSBarry Smith 20735c6c1daeSBarry Smith Synopsis: 2074aaa7dc30SBarry Smith #include <petsclog.h> 20755c6c1daeSBarry Smith void PetscPreLoadBegin(PetscBool flag,char *name); 20765c6c1daeSBarry Smith 20775c6c1daeSBarry Smith Not Collective 20785c6c1daeSBarry Smith 20795c6c1daeSBarry Smith Input Parameter: 20805c6c1daeSBarry Smith + flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden 20815c6c1daeSBarry Smith with command line option -preload true or -preload false 2082609bdbeeSBarry Smith - name - name of first stage (lines of code timed separately with -log_view) to 20835c6c1daeSBarry Smith be preloaded 20845c6c1daeSBarry Smith 20855c6c1daeSBarry Smith Usage: 20865c6c1daeSBarry Smith .vb 20875c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 20885c6c1daeSBarry Smith lines of code 20895c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 20905c6c1daeSBarry Smith lines of code 20915c6c1daeSBarry Smith PetscPreLoadEnd(); 20925c6c1daeSBarry Smith .ve 20935c6c1daeSBarry Smith 209495452b02SPatrick Sanan Notes: 209595452b02SPatrick Sanan Only works in C/C++, not Fortran 20965c6c1daeSBarry Smith 20975c6c1daeSBarry Smith Flags available within the macro. 20985c6c1daeSBarry Smith + PetscPreLoadingUsed - true if we are or have done preloading 20995c6c1daeSBarry Smith . PetscPreLoadingOn - true if it is CURRENTLY doing preload 21005c6c1daeSBarry Smith . PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second 21015c6c1daeSBarry Smith - PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on 21025c6c1daeSBarry Smith The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin() 21035c6c1daeSBarry Smith and PetscPreLoadEnd() 21045c6c1daeSBarry Smith 21055c6c1daeSBarry Smith Level: intermediate 21065c6c1daeSBarry Smith 21075c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage() 21085c6c1daeSBarry Smith 21095c6c1daeSBarry Smith 21105c6c1daeSBarry Smith M*/ 21115c6c1daeSBarry Smith 21125c6c1daeSBarry Smith /*MC 21135c6c1daeSBarry Smith PetscPreLoadEnd - End a segment of code that may be preloaded (run twice) 21145c6c1daeSBarry Smith to get accurate timings 21155c6c1daeSBarry Smith 21165c6c1daeSBarry Smith Synopsis: 2117aaa7dc30SBarry Smith #include <petsclog.h> 21185c6c1daeSBarry Smith void PetscPreLoadEnd(void); 21195c6c1daeSBarry Smith 21205c6c1daeSBarry Smith Not Collective 21215c6c1daeSBarry Smith 21225c6c1daeSBarry Smith Usage: 21235c6c1daeSBarry Smith .vb 21245c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 21255c6c1daeSBarry Smith lines of code 21265c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 21275c6c1daeSBarry Smith lines of code 21285c6c1daeSBarry Smith PetscPreLoadEnd(); 21295c6c1daeSBarry Smith .ve 21305c6c1daeSBarry Smith 213195452b02SPatrick Sanan Notes: 213295452b02SPatrick Sanan only works in C/C++ not fortran 21335c6c1daeSBarry Smith 21345c6c1daeSBarry Smith Level: intermediate 21355c6c1daeSBarry Smith 21365c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadStage() 21375c6c1daeSBarry Smith 21385c6c1daeSBarry Smith M*/ 21395c6c1daeSBarry Smith 21405c6c1daeSBarry Smith /*MC 21415c6c1daeSBarry Smith PetscPreLoadStage - Start a new segment of code to be timed separately. 21425c6c1daeSBarry Smith to get accurate timings 21435c6c1daeSBarry Smith 21445c6c1daeSBarry Smith Synopsis: 2145aaa7dc30SBarry Smith #include <petsclog.h> 21465c6c1daeSBarry Smith void PetscPreLoadStage(char *name); 21475c6c1daeSBarry Smith 21485c6c1daeSBarry Smith Not Collective 21495c6c1daeSBarry Smith 21505c6c1daeSBarry Smith Usage: 21515c6c1daeSBarry Smith .vb 21525c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 21535c6c1daeSBarry Smith lines of code 21545c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 21555c6c1daeSBarry Smith lines of code 21565c6c1daeSBarry Smith PetscPreLoadEnd(); 21575c6c1daeSBarry Smith .ve 21585c6c1daeSBarry Smith 215995452b02SPatrick Sanan Notes: 216095452b02SPatrick Sanan only works in C/C++ not fortran 21615c6c1daeSBarry Smith 21625c6c1daeSBarry Smith Level: intermediate 21635c6c1daeSBarry Smith 21645c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd() 21655c6c1daeSBarry Smith 21665c6c1daeSBarry Smith M*/ 21675c6c1daeSBarry Smith 21685c6c1daeSBarry Smith 21695c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */ 21705c6c1daeSBarry Smith 21715c6c1daeSBarry Smith PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 21725c6c1daeSBarry Smith { 21735c6c1daeSBarry Smith PetscFunctionBegin; 21745c6c1daeSBarry Smith PetscFunctionReturn(0); 21755c6c1daeSBarry Smith } 21765c6c1daeSBarry Smith 21775c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/ 21785c6c1daeSBarry Smith 21795c6c1daeSBarry Smith 21805c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 21815c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID = 0; 21825c6c1daeSBarry Smith 21835c6c1daeSBarry Smith /*@C 21845c6c1daeSBarry Smith PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code. 21855c6c1daeSBarry Smith 21865c6c1daeSBarry Smith Not Collective 21875c6c1daeSBarry Smith 21885c6c1daeSBarry Smith Input Parameter: 21895c6c1daeSBarry Smith . name - The class name 21905c6c1daeSBarry Smith 21915c6c1daeSBarry Smith Output Parameter: 21925c6c1daeSBarry Smith . oclass - The class id or classid 21935c6c1daeSBarry Smith 21945c6c1daeSBarry Smith Level: developer 21955c6c1daeSBarry Smith 21965c6c1daeSBarry Smith @*/ 21975c6c1daeSBarry Smith PetscErrorCode PetscClassIdRegister(const char name[],PetscClassId *oclass) 21985c6c1daeSBarry Smith { 21995c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 22005c6c1daeSBarry Smith PetscStageLog stageLog; 22015c6c1daeSBarry Smith PetscInt stage; 22025c6c1daeSBarry Smith PetscErrorCode ierr; 22035c6c1daeSBarry Smith #endif 22045c6c1daeSBarry Smith 22055c6c1daeSBarry Smith PetscFunctionBegin; 22065c6c1daeSBarry Smith *oclass = ++PETSC_LARGEST_CLASSID; 22075c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 22085c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 22095c6c1daeSBarry Smith ierr = PetscClassRegLogRegister(stageLog->classLog, name, *oclass);CHKERRQ(ierr); 22105c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 22113a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 22125c6c1daeSBarry Smith } 22135c6c1daeSBarry Smith #endif 22145c6c1daeSBarry Smith PetscFunctionReturn(0); 22155c6c1daeSBarry Smith } 2216210b5426SBarry Smith 2217210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE) 2218210b5426SBarry Smith #include <mpe.h> 2219210b5426SBarry Smith 2220210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE; 2221210b5426SBarry Smith 2222495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2223495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2224495fc317SBarry Smith 2225210b5426SBarry Smith /*@C 2226210b5426SBarry Smith PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files 2227210b5426SBarry Smith and slows the program down. 2228210b5426SBarry Smith 2229210b5426SBarry Smith Collective over PETSC_COMM_WORLD 2230210b5426SBarry Smith 2231210b5426SBarry Smith Options Database Keys: 2232a2553e36SBarry Smith . -log_mpe - Prints extensive log information 2233210b5426SBarry Smith 2234210b5426SBarry Smith Notes: 2235609bdbeeSBarry Smith A related routine is PetscLogDefaultBegin() (with the options key -log_view), which is 2236210b5426SBarry Smith intended for production runs since it logs only flop rates and object 2237210b5426SBarry Smith creation (and should not significantly slow the programs). 2238210b5426SBarry Smith 2239210b5426SBarry Smith Level: advanced 2240210b5426SBarry Smith 2241210b5426SBarry Smith 2242bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogEventActivate(), 2243210b5426SBarry Smith PetscLogEventDeactivate() 2244210b5426SBarry Smith @*/ 2245210b5426SBarry Smith PetscErrorCode PetscLogMPEBegin(void) 2246210b5426SBarry Smith { 2247210b5426SBarry Smith PetscErrorCode ierr; 2248210b5426SBarry Smith 2249210b5426SBarry Smith PetscFunctionBegin; 2250210b5426SBarry Smith /* Do MPE initialization */ 2251210b5426SBarry Smith if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */ 2252210b5426SBarry Smith ierr = PetscInfo(0,"Initializing MPE.\n");CHKERRQ(ierr); 2253210b5426SBarry Smith ierr = MPE_Init_log();CHKERRQ(ierr); 2254210b5426SBarry Smith 2255210b5426SBarry Smith PetscBeganMPE = PETSC_TRUE; 2256210b5426SBarry Smith } else { 2257210b5426SBarry Smith ierr = PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n");CHKERRQ(ierr); 2258210b5426SBarry Smith } 2259495fc317SBarry Smith ierr = PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE);CHKERRQ(ierr); 2260210b5426SBarry Smith PetscFunctionReturn(0); 2261210b5426SBarry Smith } 2262210b5426SBarry Smith 2263210b5426SBarry Smith /*@C 2264495fc317SBarry Smith PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot. 2265210b5426SBarry Smith 2266210b5426SBarry Smith Collective over PETSC_COMM_WORLD 2267210b5426SBarry Smith 2268210b5426SBarry Smith Level: advanced 2269210b5426SBarry Smith 2270210b5426SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogMPEBegin() 2271210b5426SBarry Smith @*/ 2272210b5426SBarry Smith PetscErrorCode PetscLogMPEDump(const char sname[]) 2273210b5426SBarry Smith { 2274210b5426SBarry Smith char name[PETSC_MAX_PATH_LEN]; 2275210b5426SBarry Smith PetscErrorCode ierr; 2276210b5426SBarry Smith 2277210b5426SBarry Smith PetscFunctionBegin; 2278210b5426SBarry Smith if (PetscBeganMPE) { 2279210b5426SBarry Smith ierr = PetscInfo(0,"Finalizing MPE.\n");CHKERRQ(ierr); 2280210b5426SBarry Smith if (sname) { 2281210b5426SBarry Smith ierr = PetscStrcpy(name,sname);CHKERRQ(ierr); 2282210b5426SBarry Smith } else { 2283589a23caSBarry Smith ierr = PetscGetProgramName(name,sizeof(name));CHKERRQ(ierr); 2284210b5426SBarry Smith } 2285210b5426SBarry Smith ierr = MPE_Finish_log(name);CHKERRQ(ierr); 2286210b5426SBarry Smith } else { 2287210b5426SBarry Smith ierr = PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n");CHKERRQ(ierr); 2288210b5426SBarry Smith } 2289210b5426SBarry Smith PetscFunctionReturn(0); 2290210b5426SBarry Smith } 2291210b5426SBarry Smith 2292210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39 2293210b5426SBarry Smith static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = { 2294210b5426SBarry Smith "OliveDrab: ", 2295210b5426SBarry Smith "BlueViolet: ", 2296210b5426SBarry Smith "CadetBlue: ", 2297210b5426SBarry Smith "CornflowerBlue: ", 2298210b5426SBarry Smith "DarkGoldenrod: ", 2299210b5426SBarry Smith "DarkGreen: ", 2300210b5426SBarry Smith "DarkKhaki: ", 2301210b5426SBarry Smith "DarkOliveGreen: ", 2302210b5426SBarry Smith "DarkOrange: ", 2303210b5426SBarry Smith "DarkOrchid: ", 2304210b5426SBarry Smith "DarkSeaGreen: ", 2305210b5426SBarry Smith "DarkSlateGray: ", 2306210b5426SBarry Smith "DarkTurquoise: ", 2307210b5426SBarry Smith "DeepPink: ", 2308210b5426SBarry Smith "DarkKhaki: ", 2309210b5426SBarry Smith "DimGray: ", 2310210b5426SBarry Smith "DodgerBlue: ", 2311210b5426SBarry Smith "GreenYellow: ", 2312210b5426SBarry Smith "HotPink: ", 2313210b5426SBarry Smith "IndianRed: ", 2314210b5426SBarry Smith "LavenderBlush: ", 2315210b5426SBarry Smith "LawnGreen: ", 2316210b5426SBarry Smith "LemonChiffon: ", 2317210b5426SBarry Smith "LightCoral: ", 2318210b5426SBarry Smith "LightCyan: ", 2319210b5426SBarry Smith "LightPink: ", 2320210b5426SBarry Smith "LightSalmon: ", 2321210b5426SBarry Smith "LightSlateGray: ", 2322210b5426SBarry Smith "LightYellow: ", 2323210b5426SBarry Smith "LimeGreen: ", 2324210b5426SBarry Smith "MediumPurple: ", 2325210b5426SBarry Smith "MediumSeaGreen: ", 2326210b5426SBarry Smith "MediumSlateBlue:", 2327210b5426SBarry Smith "MidnightBlue: ", 2328210b5426SBarry Smith "MintCream: ", 2329210b5426SBarry Smith "MistyRose: ", 2330210b5426SBarry Smith "NavajoWhite: ", 2331210b5426SBarry Smith "NavyBlue: ", 2332210b5426SBarry Smith "OliveDrab: " 2333210b5426SBarry Smith }; 2334210b5426SBarry Smith 2335210b5426SBarry Smith /*@C 2336210b5426SBarry Smith PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister() 2337210b5426SBarry Smith 2338210b5426SBarry Smith Not collective. Maybe it should be? 2339210b5426SBarry Smith 23407a7aea1fSJed Brown Output Parameter: 2341210b5426SBarry Smith . str - character string representing the color 2342210b5426SBarry Smith 2343210b5426SBarry Smith Level: developer 2344210b5426SBarry Smith 2345210b5426SBarry Smith .seealso: PetscLogEventRegister 2346210b5426SBarry Smith @*/ 2347210b5426SBarry Smith PetscErrorCode PetscLogMPEGetRGBColor(const char *str[]) 2348210b5426SBarry Smith { 2349210b5426SBarry Smith static int idx = 0; 2350210b5426SBarry Smith 2351210b5426SBarry Smith PetscFunctionBegin; 2352210b5426SBarry Smith *str = PetscLogMPERGBColors[idx]; 2353210b5426SBarry Smith idx = (idx + 1)% PETSC_RGB_COLORS_MAX; 2354210b5426SBarry Smith PetscFunctionReturn(0); 2355210b5426SBarry Smith } 2356210b5426SBarry Smith 2357210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */ 2358