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 154851f57dSBarry Smith /* this is not consistently used and is difficult to keep correct if done manually, possibly it should be removed */ 169371c9d4SSatish Balay PetscErrorCode PetscLogObjectParent(PetscObject p, PetscObject c) { 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 34*811af0c4SBarry Smith Developer Note: 354851f57dSBarry Smith This is not used consistently. It is very difficult to manually track the memory usage per object so this should 364851f57dSBarry Smith likely be removed and replaced with an automated system. 37bb72fc59SBarry Smith 38db781477SPatrick Sanan .seealso: `PetscFinalize()`, `PetscInitializeFortran()`, `PetscGetArgs()`, `PetscInitializeNoArguments()` 39bb72fc59SBarry Smith @*/ 409371c9d4SSatish Balay PetscErrorCode PetscLogObjectMemory(PetscObject p, PetscLogDouble m) { 41d12f57a0SLisandro Dalcin if (!p) return 0; 4227b6d19dSBarry Smith p->mem += m; 433bb1ff40SBarry Smith return 0; 443bb1ff40SBarry Smith } 453bb1ff40SBarry Smith 465c6c1daeSBarry Smith PetscLogEvent PETSC_LARGEST_EVENT = PETSC_EVENT; 475c6c1daeSBarry Smith 485c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 495c6c1daeSBarry Smith #include <petscmachineinfo.h> 505c6c1daeSBarry Smith #include <petscconfiginfo.h> 515c6c1daeSBarry Smith 525c6c1daeSBarry Smith /* used in the MPI_XXX() count macros in petsclog.h */ 535c6c1daeSBarry Smith 545c6c1daeSBarry Smith /* Action and object logging variables */ 550298fd71SBarry Smith Action *petsc_actions = NULL; 560298fd71SBarry Smith Object *petsc_objects = NULL; 575c6c1daeSBarry Smith PetscBool petsc_logActions = PETSC_FALSE; 585c6c1daeSBarry Smith PetscBool petsc_logObjects = PETSC_FALSE; 595c6c1daeSBarry Smith int petsc_numActions = 0, petsc_maxActions = 100; 605c6c1daeSBarry Smith int petsc_numObjects = 0, petsc_maxObjects = 100; 615c6c1daeSBarry Smith int petsc_numObjectsDestroyed = 0; 625c6c1daeSBarry Smith 635c6c1daeSBarry Smith /* Global counters */ 645c6c1daeSBarry Smith PetscLogDouble petsc_BaseTime = 0.0; 655c6c1daeSBarry Smith PetscLogDouble petsc_TotalFlops = 0.0; /* The number of flops */ 665c6c1daeSBarry Smith PetscLogDouble petsc_tmp_flops = 0.0; /* The incremental number of flops */ 675c6c1daeSBarry Smith PetscLogDouble petsc_send_ct = 0.0; /* The number of sends */ 685c6c1daeSBarry Smith PetscLogDouble petsc_recv_ct = 0.0; /* The number of receives */ 695c6c1daeSBarry Smith PetscLogDouble petsc_send_len = 0.0; /* The total length of all sent messages */ 705c6c1daeSBarry Smith PetscLogDouble petsc_recv_len = 0.0; /* The total length of all received messages */ 715c6c1daeSBarry Smith PetscLogDouble petsc_isend_ct = 0.0; /* The number of immediate sends */ 725c6c1daeSBarry Smith PetscLogDouble petsc_irecv_ct = 0.0; /* The number of immediate receives */ 735c6c1daeSBarry Smith PetscLogDouble petsc_isend_len = 0.0; /* The total length of all immediate send messages */ 745c6c1daeSBarry Smith PetscLogDouble petsc_irecv_len = 0.0; /* The total length of all immediate receive messages */ 755c6c1daeSBarry Smith PetscLogDouble petsc_wait_ct = 0.0; /* The number of waits */ 765c6c1daeSBarry Smith PetscLogDouble petsc_wait_any_ct = 0.0; /* The number of anywaits */ 775c6c1daeSBarry Smith PetscLogDouble petsc_wait_all_ct = 0.0; /* The number of waitalls */ 785c6c1daeSBarry Smith PetscLogDouble petsc_sum_of_waits_ct = 0.0; /* The total number of waits */ 795c6c1daeSBarry Smith PetscLogDouble petsc_allreduce_ct = 0.0; /* The number of reductions */ 805c6c1daeSBarry Smith PetscLogDouble petsc_gather_ct = 0.0; /* The number of gathers and gathervs */ 815c6c1daeSBarry Smith PetscLogDouble petsc_scatter_ct = 0.0; /* The number of scatters and scattervs */ 8220c24465SJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 83bec0b493Shannah_mairs PetscLogDouble petsc_ctog_ct = 0.0; /* The total number of CPU to GPU copies */ 84bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_ct = 0.0; /* The total number of GPU to CPU copies */ 85bec0b493Shannah_mairs PetscLogDouble petsc_ctog_sz = 0.0; /* The total size of CPU to GPU copies */ 86bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_sz = 0.0; /* The total size of GPU to CPU copies */ 8745c4b7c1SBarry Smith PetscLogDouble petsc_ctog_ct_scalar = 0.0; /* The total number of CPU to GPU copies */ 8845c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_ct_scalar = 0.0; /* The total number of GPU to CPU copies */ 8945c4b7c1SBarry Smith PetscLogDouble petsc_ctog_sz_scalar = 0.0; /* The total size of CPU to GPU copies */ 9045c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_sz_scalar = 0.0; /* The total size of GPU to CPU copies */ 91958c4211Shannah_mairs PetscLogDouble petsc_gflops = 0.0; /* The flops done on a GPU */ 92958c4211Shannah_mairs PetscLogDouble petsc_gtime = 0.0; /* The time spent on a GPU */ 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 1097a101e5eSJacob Faibussowitsch static PetscIntStack current_log_event_stack = NULL; 1107a101e5eSJacob Faibussowitsch 1119371c9d4SSatish Balay PETSC_INTERN PetscErrorCode PetscLogInitialize(void) { 112fa2bb9feSLisandro Dalcin int stage; 113fa2bb9feSLisandro Dalcin PetscBool opt; 1145c6c1daeSBarry Smith 115fa2bb9feSLisandro Dalcin PetscFunctionBegin; 116fa2bb9feSLisandro Dalcin if (PetscLogInitializeCalled) PetscFunctionReturn(0); 117fa2bb9feSLisandro Dalcin PetscLogInitializeCalled = PETSC_TRUE; 1185c6c1daeSBarry Smith 1197a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackCreate(¤t_log_event_stack)); 1209566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL, NULL, "-log_exclude_actions", &opt)); 121fa2bb9feSLisandro Dalcin if (opt) petsc_logActions = PETSC_FALSE; 1229566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL, NULL, "-log_exclude_objects", &opt)); 123fa2bb9feSLisandro Dalcin if (opt) petsc_logObjects = PETSC_FALSE; 12448a46eb9SPierre Jolivet if (petsc_logActions) PetscCall(PetscMalloc1(petsc_maxActions, &petsc_actions)); 12548a46eb9SPierre Jolivet if (petsc_logObjects) PetscCall(PetscMalloc1(petsc_maxObjects, &petsc_objects)); 126fa2bb9feSLisandro Dalcin PetscLogPHC = PetscLogObjCreateDefault; 127fa2bb9feSLisandro Dalcin PetscLogPHD = PetscLogObjDestroyDefault; 128fa2bb9feSLisandro Dalcin /* Setup default logging structures */ 1299566063dSJacob Faibussowitsch PetscCall(PetscStageLogCreate(&petsc_stageLog)); 1309566063dSJacob Faibussowitsch PetscCall(PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage)); 1315c6c1daeSBarry Smith 132fa2bb9feSLisandro Dalcin /* All processors sync here for more consistent logging */ 1339566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(PETSC_COMM_WORLD)); 134fa2bb9feSLisandro Dalcin PetscTime(&petsc_BaseTime); 1359566063dSJacob Faibussowitsch PetscCall(PetscLogStagePush(stage)); 136fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 137fa2bb9feSLisandro Dalcin } 1385c6c1daeSBarry Smith 1399371c9d4SSatish Balay PETSC_INTERN PetscErrorCode PetscLogFinalize(void) { 1405c6c1daeSBarry Smith PetscStageLog stageLog; 1415c6c1daeSBarry Smith 1425c6c1daeSBarry Smith PetscFunctionBegin; 1439566063dSJacob Faibussowitsch PetscCall(PetscFree(petsc_actions)); 1449566063dSJacob Faibussowitsch PetscCall(PetscFree(petsc_objects)); 1459566063dSJacob Faibussowitsch PetscCall(PetscLogNestedEnd()); 1469566063dSJacob Faibussowitsch PetscCall(PetscLogSet(NULL, NULL)); 1475c6c1daeSBarry Smith 1485c6c1daeSBarry Smith /* Resetting phase */ 1499566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 1509566063dSJacob Faibussowitsch PetscCall(PetscStageLogDestroy(stageLog)); 1517a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackDestroy(current_log_event_stack)); 1527a101e5eSJacob Faibussowitsch current_log_event_stack = NULL; 153a297a907SKarl Rupp 1545c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1555c6c1daeSBarry Smith petsc_numActions = 0; 1565c6c1daeSBarry Smith petsc_numObjects = 0; 1575c6c1daeSBarry Smith petsc_numObjectsDestroyed = 0; 1585c6c1daeSBarry Smith petsc_maxActions = 100; 1595c6c1daeSBarry Smith petsc_maxObjects = 100; 1600298fd71SBarry Smith petsc_actions = NULL; 1610298fd71SBarry Smith petsc_objects = NULL; 1625c6c1daeSBarry Smith petsc_logActions = PETSC_FALSE; 1635c6c1daeSBarry Smith petsc_logObjects = PETSC_FALSE; 1645c6c1daeSBarry Smith petsc_BaseTime = 0.0; 1655c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1665c6c1daeSBarry Smith petsc_tmp_flops = 0.0; 1675c6c1daeSBarry Smith petsc_send_ct = 0.0; 1685c6c1daeSBarry Smith petsc_recv_ct = 0.0; 1695c6c1daeSBarry Smith petsc_send_len = 0.0; 1705c6c1daeSBarry Smith petsc_recv_len = 0.0; 1715c6c1daeSBarry Smith petsc_isend_ct = 0.0; 1725c6c1daeSBarry Smith petsc_irecv_ct = 0.0; 1735c6c1daeSBarry Smith petsc_isend_len = 0.0; 1745c6c1daeSBarry Smith petsc_irecv_len = 0.0; 1755c6c1daeSBarry Smith petsc_wait_ct = 0.0; 1765c6c1daeSBarry Smith petsc_wait_any_ct = 0.0; 1775c6c1daeSBarry Smith petsc_wait_all_ct = 0.0; 1785c6c1daeSBarry Smith petsc_sum_of_waits_ct = 0.0; 1795c6c1daeSBarry Smith petsc_allreduce_ct = 0.0; 1805c6c1daeSBarry Smith petsc_gather_ct = 0.0; 1815c6c1daeSBarry Smith petsc_scatter_ct = 0.0; 182d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 183bec0b493Shannah_mairs petsc_ctog_ct = 0.0; 184bec0b493Shannah_mairs petsc_gtoc_ct = 0.0; 185bec0b493Shannah_mairs petsc_ctog_sz = 0.0; 186bec0b493Shannah_mairs petsc_gtoc_sz = 0.0; 187958c4211Shannah_mairs petsc_gflops = 0.0; 188958c4211Shannah_mairs petsc_gtime = 0.0; 189bec0b493Shannah_mairs #endif 1905c6c1daeSBarry Smith PETSC_LARGEST_EVENT = PETSC_EVENT; 1910298fd71SBarry Smith PetscLogPHC = NULL; 1920298fd71SBarry Smith PetscLogPHD = NULL; 1930298fd71SBarry Smith petsc_tracefile = NULL; 1945c6c1daeSBarry Smith petsc_tracelevel = 0; 1955c6c1daeSBarry Smith petsc_traceblanks = " "; 1969371c9d4SSatish Balay petsc_tracespace[0] = ' '; 1979371c9d4SSatish Balay petsc_tracespace[1] = 0; 1985c6c1daeSBarry Smith petsc_tracetime = 0.0; 1995c6c1daeSBarry Smith PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 2005c6c1daeSBarry Smith PETSC_OBJECT_CLASSID = 0; 20102c9f0b5SLisandro Dalcin petsc_stageLog = NULL; 202896238b9SBarry Smith PetscLogInitializeCalled = PETSC_FALSE; 2035c6c1daeSBarry Smith PetscFunctionReturn(0); 2045c6c1daeSBarry Smith } 2055c6c1daeSBarry Smith 2065c6c1daeSBarry Smith /*@C 2075c6c1daeSBarry Smith PetscLogSet - Sets the logging functions called at the beginning and ending of every event. 2085c6c1daeSBarry Smith 2095c6c1daeSBarry Smith Not Collective 2105c6c1daeSBarry Smith 2115c6c1daeSBarry Smith Input Parameters: 2125c6c1daeSBarry Smith + b - The function called at beginning of event 2135c6c1daeSBarry Smith - e - The function called at end of event 2145c6c1daeSBarry Smith 2155c6c1daeSBarry Smith Level: developer 2165c6c1daeSBarry Smith 217*811af0c4SBarry Smith Developer Note: 218*811af0c4SBarry Smith The default loggers are `PetscLogEventBeginDefault()` and `PetscLogEventEndDefault()`. 219*811af0c4SBarry Smith 220*811af0c4SBarry Smith .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogTraceBegin()`, `PetscLogEventBeginDefault()`, `PetscLogEventEndDefault()` 2215c6c1daeSBarry Smith @*/ 2229371c9d4SSatish Balay PetscErrorCode PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject)) { 2235c6c1daeSBarry Smith PetscFunctionBegin; 2245c6c1daeSBarry Smith PetscLogPLB = b; 2255c6c1daeSBarry Smith PetscLogPLE = e; 2265c6c1daeSBarry Smith PetscFunctionReturn(0); 2275c6c1daeSBarry Smith } 2285c6c1daeSBarry Smith 2295c6c1daeSBarry Smith /*@C 2304dd65854SConnor Ward PetscLogIsActive - Check if logging is currently in progress. 2314dd65854SConnor Ward 2324dd65854SConnor Ward Not Collective 2334dd65854SConnor Ward 2344dd65854SConnor Ward Output Parameter: 235*811af0c4SBarry Smith . isActive - `PETSC_TRUE` if logging is in progress, `PETSC_FALSE` otherwise 2364dd65854SConnor Ward 2374dd65854SConnor Ward Level: beginner 2384dd65854SConnor Ward 239db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogSet()` 2404dd65854SConnor Ward @*/ 2419371c9d4SSatish Balay PetscErrorCode PetscLogIsActive(PetscBool *isActive) { 2424dd65854SConnor Ward PetscFunctionBegin; 2434dd65854SConnor Ward *isActive = (PetscLogPLB && PetscLogPLE) ? PETSC_TRUE : PETSC_FALSE; 2444dd65854SConnor Ward PetscFunctionReturn(0); 2454dd65854SConnor Ward } 2464dd65854SConnor Ward 2474dd65854SConnor Ward /*@C 248*811af0c4SBarry Smith PetscLogDefaultBegin - Turns on logging of objects and events using the default logging functions `PetscLogEventBeginDefault()` and `PetscLogEventEndDefault()`. This logs flop 2495c6c1daeSBarry Smith rates and object creation and should not slow programs down too much. 2505c6c1daeSBarry Smith This routine may be called more than once. 2515c6c1daeSBarry Smith 252*811af0c4SBarry Smith Logically Collective over `PETSC_COMM_WORLD` 2535c6c1daeSBarry Smith 254*811af0c4SBarry Smith Options Database Key: 255a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the 256a2553e36SBarry Smith screen (for code configured with --with-log=1 (which is the default)) 2575c6c1daeSBarry Smith 2585c6c1daeSBarry Smith Usage: 2595c6c1daeSBarry Smith .vb 2605c6c1daeSBarry Smith PetscInitialize(...); 261bb1d7374SBarry Smith PetscLogDefaultBegin(); 2625c6c1daeSBarry Smith ... code ... 2635c6c1daeSBarry Smith PetscLogView(viewer); or PetscLogDump(); 2645c6c1daeSBarry Smith PetscFinalize(); 2655c6c1daeSBarry Smith .ve 2665c6c1daeSBarry Smith 267*811af0c4SBarry Smith Note: 268*811af0c4SBarry Smith `PetscLogView()` or `PetscLogDump()` actually cause the printing of 2695c6c1daeSBarry Smith the logging information. 2705c6c1daeSBarry Smith 2715c6c1daeSBarry Smith Level: advanced 2725c6c1daeSBarry Smith 273db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogView()`, `PetscLogTraceBegin()` 2745c6c1daeSBarry Smith @*/ 2759371c9d4SSatish Balay PetscErrorCode PetscLogDefaultBegin(void) { 2765c6c1daeSBarry Smith PetscFunctionBegin; 2779566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault)); 2785c6c1daeSBarry Smith PetscFunctionReturn(0); 2795c6c1daeSBarry Smith } 2805c6c1daeSBarry Smith 2815c6c1daeSBarry Smith /*@C 2825c6c1daeSBarry Smith PetscLogAllBegin - Turns on extensive logging of objects and events. Logs 2835c6c1daeSBarry Smith all events. This creates large log files and slows the program down. 2845c6c1daeSBarry Smith 285*811af0c4SBarry Smith Logically Collective on `PETSC_COMM_WORLD` 2865c6c1daeSBarry Smith 287*811af0c4SBarry Smith Options Database Key: 288a2553e36SBarry Smith . -log_all - Prints extensive log information 2895c6c1daeSBarry Smith 2905c6c1daeSBarry Smith Usage: 2915c6c1daeSBarry Smith .vb 2925c6c1daeSBarry Smith PetscInitialize(...); 2935c6c1daeSBarry Smith PetscLogAllBegin(); 2945c6c1daeSBarry Smith ... code ... 2955c6c1daeSBarry Smith PetscLogDump(filename); 2965c6c1daeSBarry Smith PetscFinalize(); 2975c6c1daeSBarry Smith .ve 2985c6c1daeSBarry Smith 299*811af0c4SBarry Smith Note: 300*811af0c4SBarry Smith A related routine is `PetscLogDefaultBegin()` (with the options key -log_view), which is 3015c6c1daeSBarry Smith intended for production runs since it logs only flop rates and object 3025c6c1daeSBarry Smith creation (and shouldn't significantly slow the programs). 3035c6c1daeSBarry Smith 3045c6c1daeSBarry Smith Level: advanced 3055c6c1daeSBarry Smith 306db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogTraceBegin()` 3075c6c1daeSBarry Smith @*/ 3089371c9d4SSatish Balay PetscErrorCode PetscLogAllBegin(void) { 3095c6c1daeSBarry Smith PetscFunctionBegin; 3109566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete)); 3115c6c1daeSBarry Smith PetscFunctionReturn(0); 3125c6c1daeSBarry Smith } 3135c6c1daeSBarry Smith 314956f8c0dSBarry Smith /*@C 3155c6c1daeSBarry Smith PetscLogTraceBegin - Activates trace logging. Every time a PETSc event 3165c6c1daeSBarry Smith begins or ends, the event name is printed. 3175c6c1daeSBarry Smith 318*811af0c4SBarry Smith Logically Collective on `PETSC_COMM_WORLD` 3195c6c1daeSBarry Smith 3205c6c1daeSBarry Smith Input Parameter: 3215c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout) 3225c6c1daeSBarry Smith 3235c6c1daeSBarry Smith Options Database Key: 324*811af0c4SBarry Smith . -log_trace [filename] - Activates `PetscLogTraceBegin()` 3255c6c1daeSBarry Smith 3265c6c1daeSBarry Smith Notes: 327*811af0c4SBarry Smith `PetscLogTraceBegin()` prints the processor number, the execution time (sec), 3285c6c1daeSBarry Smith then "Event begin:" or "Event end:" followed by the event name. 3295c6c1daeSBarry Smith 330*811af0c4SBarry Smith `PetscLogTraceBegin()` allows tracing of all PETSc calls, which is useful 3315c6c1daeSBarry Smith to determine where a program is hanging without running in the 3325c6c1daeSBarry Smith debugger. Can be used in conjunction with the -info option. 3335c6c1daeSBarry Smith 3345c6c1daeSBarry Smith Level: intermediate 3355c6c1daeSBarry Smith 336db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogView()`, `PetscLogDefaultBegin()` 3375c6c1daeSBarry Smith @*/ 3389371c9d4SSatish Balay PetscErrorCode PetscLogTraceBegin(FILE *file) { 3395c6c1daeSBarry Smith PetscFunctionBegin; 3405c6c1daeSBarry Smith petsc_tracefile = file; 341a297a907SKarl Rupp 3429566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace)); 3435c6c1daeSBarry Smith PetscFunctionReturn(0); 3445c6c1daeSBarry Smith } 3455c6c1daeSBarry Smith 3465c6c1daeSBarry Smith /*@ 3475c6c1daeSBarry Smith PetscLogActions - Determines whether actions are logged for the graphical viewer. 3485c6c1daeSBarry Smith 3495c6c1daeSBarry Smith Not Collective 3505c6c1daeSBarry Smith 3515c6c1daeSBarry Smith Input Parameter: 352*811af0c4SBarry Smith . flag - `PETSC_TRUE` if actions are to be logged 353*811af0c4SBarry Smith 354*811af0c4SBarry Smith Options Database Key: 355*811af0c4SBarry Smith . -log_exclude_actions - Turns off actions logging 3565c6c1daeSBarry Smith 3575c6c1daeSBarry Smith Level: intermediate 3585c6c1daeSBarry Smith 359*811af0c4SBarry Smith Note: 360*811af0c4SBarry Smith Logging of actions continues to consume more memory as the program 3615c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 362db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()` 3635c6c1daeSBarry Smith @*/ 3649371c9d4SSatish Balay PetscErrorCode PetscLogActions(PetscBool flag) { 3655c6c1daeSBarry Smith PetscFunctionBegin; 3665c6c1daeSBarry Smith petsc_logActions = flag; 3675c6c1daeSBarry Smith PetscFunctionReturn(0); 3685c6c1daeSBarry Smith } 3695c6c1daeSBarry Smith 3705c6c1daeSBarry Smith /*@ 3715c6c1daeSBarry Smith PetscLogObjects - Determines whether objects are logged for the graphical viewer. 3725c6c1daeSBarry Smith 3735c6c1daeSBarry Smith Not Collective 3745c6c1daeSBarry Smith 3755c6c1daeSBarry Smith Input Parameter: 376*811af0c4SBarry Smith . flag - `PETSC_TRUE` if objects are to be logged 377*811af0c4SBarry Smith 378*811af0c4SBarry Smith Options Database Key: 379*811af0c4SBarry Smith . -log_exclude_objects - Turns off objects logging 3805c6c1daeSBarry Smith 3815c6c1daeSBarry Smith Level: intermediate 3825c6c1daeSBarry Smith 383*811af0c4SBarry Smith Note: 384*811af0c4SBarry Smith Logging of objects continues to consume more memory as the program 3855c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3865c6c1daeSBarry Smith 387db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()` 3885c6c1daeSBarry Smith @*/ 3899371c9d4SSatish Balay PetscErrorCode PetscLogObjects(PetscBool flag) { 3905c6c1daeSBarry Smith PetscFunctionBegin; 3915c6c1daeSBarry Smith petsc_logObjects = flag; 3925c6c1daeSBarry Smith PetscFunctionReturn(0); 3935c6c1daeSBarry Smith } 3945c6c1daeSBarry Smith 3955c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/ 3965c6c1daeSBarry Smith /*@C 39774c0405dSRichard Tran Mills PetscLogStageRegister - Attaches a character string name to a logging stage. 3985c6c1daeSBarry Smith 3995c6c1daeSBarry Smith Not Collective 4005c6c1daeSBarry Smith 4015c6c1daeSBarry Smith Input Parameter: 4025c6c1daeSBarry Smith . sname - The name to associate with that stage 4035c6c1daeSBarry Smith 4045c6c1daeSBarry Smith Output Parameter: 4055c6c1daeSBarry Smith . stage - The stage number 4065c6c1daeSBarry Smith 4075c6c1daeSBarry Smith Level: intermediate 4085c6c1daeSBarry Smith 409db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()` 4105c6c1daeSBarry Smith @*/ 4119371c9d4SSatish Balay PetscErrorCode PetscLogStageRegister(const char sname[], PetscLogStage *stage) { 4125c6c1daeSBarry Smith PetscStageLog stageLog; 4135c6c1daeSBarry Smith PetscLogEvent event; 4145c6c1daeSBarry Smith 4155c6c1daeSBarry Smith PetscFunctionBegin; 4169566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 4179566063dSJacob Faibussowitsch PetscCall(PetscStageLogRegister(stageLog, sname, stage)); 4185c6c1daeSBarry Smith /* Copy events already changed in the main stage, this sucks */ 4199566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents)); 42048a46eb9SPierre Jolivet for (event = 0; event < stageLog->eventLog->numEvents; event++) PetscCall(PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event], &stageLog->stageInfo[*stage].eventLog->eventInfo[event])); 4219566063dSJacob Faibussowitsch PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses)); 4225c6c1daeSBarry Smith PetscFunctionReturn(0); 4235c6c1daeSBarry Smith } 4245c6c1daeSBarry Smith 4255c6c1daeSBarry Smith /*@C 426*811af0c4SBarry Smith PetscLogStagePush - This function pushes a stage on the logging stack. Events started and stopped until `PetscLogStagePop()` will be associated with the stage 4275c6c1daeSBarry Smith 4285c6c1daeSBarry Smith Not Collective 4295c6c1daeSBarry Smith 4305c6c1daeSBarry Smith Input Parameter: 4315c6c1daeSBarry Smith . stage - The stage on which to log 4325c6c1daeSBarry Smith 4335c6c1daeSBarry Smith Usage: 434*811af0c4SBarry Smith If the option -log_view is used to run the program containing the 4355c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4365c6c1daeSBarry Smith PetscFinalize(). 4375c6c1daeSBarry Smith .vb 4385c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4395c6c1daeSBarry Smith [stage 0 of code] 4405c6c1daeSBarry Smith PetscLogStagePush(1); 4415c6c1daeSBarry Smith [stage 1 of code] 4425c6c1daeSBarry Smith PetscLogStagePop(); 4435c6c1daeSBarry Smith PetscBarrier(...); 4445c6c1daeSBarry Smith [more stage 0 of code] 4455c6c1daeSBarry Smith PetscFinalize(); 4465c6c1daeSBarry Smith .ve 4475c6c1daeSBarry Smith 448*811af0c4SBarry Smith Note: 449*811af0c4SBarry Smith Use `PetscLogStageRegister()` to register a stage. 4505c6c1daeSBarry Smith 4515c6c1daeSBarry Smith Level: intermediate 4525c6c1daeSBarry Smith 453db781477SPatrick Sanan .seealso: `PetscLogStagePop()`, `PetscLogStageRegister()`, `PetscBarrier()` 4545c6c1daeSBarry Smith @*/ 4559371c9d4SSatish Balay PetscErrorCode PetscLogStagePush(PetscLogStage stage) { 4565c6c1daeSBarry Smith PetscStageLog stageLog; 4575c6c1daeSBarry Smith 4585c6c1daeSBarry Smith PetscFunctionBegin; 4599566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 4609566063dSJacob Faibussowitsch PetscCall(PetscStageLogPush(stageLog, stage)); 4615c6c1daeSBarry Smith PetscFunctionReturn(0); 4625c6c1daeSBarry Smith } 4635c6c1daeSBarry Smith 4645c6c1daeSBarry Smith /*@C 465*811af0c4SBarry Smith PetscLogStagePop - This function pops a stage from the logging stack that was pushed with `PetscLogStagePush()` 4665c6c1daeSBarry Smith 4675c6c1daeSBarry Smith Not Collective 4685c6c1daeSBarry Smith 4695c6c1daeSBarry Smith Usage: 470*811af0c4SBarry Smith If the option -log_view is used to run the program containing the 4715c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4725c6c1daeSBarry Smith PetscFinalize(). 4735c6c1daeSBarry Smith .vb 4745c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4755c6c1daeSBarry Smith [stage 0 of code] 4765c6c1daeSBarry Smith PetscLogStagePush(1); 4775c6c1daeSBarry Smith [stage 1 of code] 4785c6c1daeSBarry Smith PetscLogStagePop(); 4795c6c1daeSBarry Smith PetscBarrier(...); 4805c6c1daeSBarry Smith [more stage 0 of code] 4815c6c1daeSBarry Smith PetscFinalize(); 4825c6c1daeSBarry Smith .ve 4835c6c1daeSBarry Smith 4845c6c1daeSBarry Smith Level: intermediate 4855c6c1daeSBarry Smith 486db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStageRegister()`, `PetscBarrier()` 4875c6c1daeSBarry Smith @*/ 4889371c9d4SSatish Balay PetscErrorCode PetscLogStagePop(void) { 4895c6c1daeSBarry Smith PetscStageLog stageLog; 4905c6c1daeSBarry Smith 4915c6c1daeSBarry Smith PetscFunctionBegin; 4929566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 4939566063dSJacob Faibussowitsch PetscCall(PetscStageLogPop(stageLog)); 4945c6c1daeSBarry Smith PetscFunctionReturn(0); 4955c6c1daeSBarry Smith } 4965c6c1daeSBarry Smith 4975c6c1daeSBarry Smith /*@ 498*811af0c4SBarry Smith PetscLogStageSetActive - Sets if a stage is used for `PetscLogEventBegin()` and `PetscLogEventEnd()`. 4995c6c1daeSBarry Smith 5005c6c1daeSBarry Smith Not Collective 5015c6c1daeSBarry Smith 5025c6c1daeSBarry Smith Input Parameters: 5035c6c1daeSBarry Smith + stage - The stage 504*811af0c4SBarry Smith - isActive - The activity flag, `PETSC_TRUE` for logging, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 5055c6c1daeSBarry Smith 5065c6c1daeSBarry Smith Level: intermediate 5075c6c1daeSBarry Smith 508*811af0c4SBarry Smith Note: 509*811af0c4SBarry Smith If this is set to `PETSC_FALSE` the logging acts as if the stage did not exist 510*811af0c4SBarry Smith 511*811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 5125c6c1daeSBarry Smith @*/ 5139371c9d4SSatish Balay PetscErrorCode PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive) { 5145c6c1daeSBarry Smith PetscStageLog stageLog; 5155c6c1daeSBarry Smith 5165c6c1daeSBarry Smith PetscFunctionBegin; 5179566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5189566063dSJacob Faibussowitsch PetscCall(PetscStageLogSetActive(stageLog, stage, isActive)); 5195c6c1daeSBarry Smith PetscFunctionReturn(0); 5205c6c1daeSBarry Smith } 5215c6c1daeSBarry Smith 5225c6c1daeSBarry Smith /*@ 523*811af0c4SBarry Smith PetscLogStageGetActive - Checks if a stage is used for `PetscLogEventBegin()` and `PetscLogEventEnd()`. 5245c6c1daeSBarry Smith 5255c6c1daeSBarry Smith Not Collective 5265c6c1daeSBarry Smith 5275c6c1daeSBarry Smith Input Parameter: 5285c6c1daeSBarry Smith . stage - The stage 5295c6c1daeSBarry Smith 5305c6c1daeSBarry Smith Output Parameter: 531*811af0c4SBarry Smith . isActive - The activity flag, `PETSC_TRUE` for logging, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 5325c6c1daeSBarry Smith 5335c6c1daeSBarry Smith Level: intermediate 5345c6c1daeSBarry Smith 535*811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 5365c6c1daeSBarry Smith @*/ 5379371c9d4SSatish Balay PetscErrorCode PetscLogStageGetActive(PetscLogStage stage, PetscBool *isActive) { 5385c6c1daeSBarry Smith PetscStageLog stageLog; 5395c6c1daeSBarry Smith 5405c6c1daeSBarry Smith PetscFunctionBegin; 5419566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5429566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetActive(stageLog, stage, isActive)); 5435c6c1daeSBarry Smith PetscFunctionReturn(0); 5445c6c1daeSBarry Smith } 5455c6c1daeSBarry Smith 5465c6c1daeSBarry Smith /*@ 547*811af0c4SBarry Smith PetscLogStageSetVisible - Determines stage visibility in `PetscLogView()` 5485c6c1daeSBarry Smith 5495c6c1daeSBarry Smith Not Collective 5505c6c1daeSBarry Smith 5515c6c1daeSBarry Smith Input Parameters: 5525c6c1daeSBarry Smith + stage - The stage 553*811af0c4SBarry Smith - isVisible - The visibility flag, `PETSC_TRUE` to print, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 5545c6c1daeSBarry Smith 5555c6c1daeSBarry Smith Level: intermediate 5565c6c1daeSBarry Smith 557*811af0c4SBarry Smith Developer Note: 558*811af0c4SBarry Smith What does visible mean, needs to be documented. 559*811af0c4SBarry Smith 560*811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogView()` 5615c6c1daeSBarry Smith @*/ 5629371c9d4SSatish Balay PetscErrorCode PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible) { 5635c6c1daeSBarry Smith PetscStageLog stageLog; 5645c6c1daeSBarry Smith 5655c6c1daeSBarry Smith PetscFunctionBegin; 5669566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5679566063dSJacob Faibussowitsch PetscCall(PetscStageLogSetVisible(stageLog, stage, isVisible)); 5685c6c1daeSBarry Smith PetscFunctionReturn(0); 5695c6c1daeSBarry Smith } 5705c6c1daeSBarry Smith 5715c6c1daeSBarry Smith /*@ 572*811af0c4SBarry Smith PetscLogStageGetVisible - Returns stage visibility in `PetscLogView()` 5735c6c1daeSBarry Smith 5745c6c1daeSBarry Smith Not Collective 5755c6c1daeSBarry Smith 5765c6c1daeSBarry Smith Input Parameter: 5775c6c1daeSBarry Smith . stage - The stage 5785c6c1daeSBarry Smith 5795c6c1daeSBarry Smith Output Parameter: 580*811af0c4SBarry Smith . isVisible - The visibility flag, `PETSC_TRUE` to print, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 5815c6c1daeSBarry Smith 5825c6c1daeSBarry Smith Level: intermediate 5835c6c1daeSBarry Smith 584*811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogView()` 5855c6c1daeSBarry Smith @*/ 5869371c9d4SSatish Balay PetscErrorCode PetscLogStageGetVisible(PetscLogStage stage, PetscBool *isVisible) { 5875c6c1daeSBarry Smith PetscStageLog stageLog; 5885c6c1daeSBarry Smith 5895c6c1daeSBarry Smith PetscFunctionBegin; 5909566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5919566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetVisible(stageLog, stage, isVisible)); 5925c6c1daeSBarry Smith PetscFunctionReturn(0); 5935c6c1daeSBarry Smith } 5945c6c1daeSBarry Smith 5955c6c1daeSBarry Smith /*@C 5965c6c1daeSBarry Smith PetscLogStageGetId - Returns the stage id when given the stage name. 5975c6c1daeSBarry Smith 5985c6c1daeSBarry Smith Not Collective 5995c6c1daeSBarry Smith 6005c6c1daeSBarry Smith Input Parameter: 6015c6c1daeSBarry Smith . name - The stage name 6025c6c1daeSBarry Smith 6035c6c1daeSBarry Smith Output Parameter: 6045a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists 6055c6c1daeSBarry Smith 6065c6c1daeSBarry Smith Level: intermediate 6075c6c1daeSBarry Smith 608*811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 6095c6c1daeSBarry Smith @*/ 6109371c9d4SSatish Balay PetscErrorCode PetscLogStageGetId(const char name[], PetscLogStage *stage) { 6115c6c1daeSBarry Smith PetscStageLog stageLog; 6125c6c1daeSBarry Smith 6135c6c1daeSBarry Smith PetscFunctionBegin; 6149566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 6159566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetStage(stageLog, name, stage)); 6165c6c1daeSBarry Smith PetscFunctionReturn(0); 6175c6c1daeSBarry Smith } 6185c6c1daeSBarry Smith 6195c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/ 6207a101e5eSJacob Faibussowitsch 6215c6c1daeSBarry Smith /*@C 622*811af0c4SBarry Smith PetscLogEventRegister - Registers an event name for logging operations 6235c6c1daeSBarry Smith 6245c6c1daeSBarry Smith Not Collective 6255c6c1daeSBarry Smith 626d8d19677SJose E. Roman Input Parameters: 6275c6c1daeSBarry Smith + name - The name associated with the event 6285c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with 629*811af0c4SBarry Smith `PetscClassIdRegister()` or use a predefined one such as `KSP_CLASSID`, `SNES_CLASSID`, the predefined ones 6305c6c1daeSBarry Smith are only available in C code 6315c6c1daeSBarry Smith 6325c6c1daeSBarry Smith Output Parameter: 633*811af0c4SBarry Smith . event - The event id for use with `PetscLogEventBegin()` and `PetscLogEventEnd()`. 6345c6c1daeSBarry Smith 6355c6c1daeSBarry Smith Example of Usage: 6365c6c1daeSBarry Smith .vb 6375c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 6385c6c1daeSBarry Smith PetscClassId classid; 6395c6c1daeSBarry Smith PetscLogDouble user_event_flops; 6405c6c1daeSBarry Smith PetscClassIdRegister("class name",&classid); 6415c6c1daeSBarry Smith PetscLogEventRegister("User event name",classid,&USER_EVENT); 6425c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 6435c6c1daeSBarry Smith [code segment to monitor] 6445c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 6455c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 6465c6c1daeSBarry Smith .ve 6475c6c1daeSBarry Smith 6485c6c1daeSBarry Smith Notes: 6495c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 650a2553e36SBarry Smith configured with --with-log (which is the default) and 651*811af0c4SBarry Smith -log_view or -log_all is specified. `PetscLogEventRegister()` is 6525c6c1daeSBarry Smith intended for logging user events to supplement this PETSc 6535c6c1daeSBarry Smith information. 6545c6c1daeSBarry Smith 655495fc317SBarry Smith PETSc can gather data for use with the utilities Jumpshot 6565c6c1daeSBarry Smith (part of the MPICH distribution). If PETSc has been compiled 6575c6c1daeSBarry Smith with flag -DPETSC_HAVE_MPE (MPE is an additional utility within 6585c6c1daeSBarry Smith MPICH), the user can employ another command line option, -log_mpe, 6595c6c1daeSBarry Smith to create a logfile, "mpe.log", which can be visualized 660495fc317SBarry Smith Jumpshot. 6615c6c1daeSBarry Smith 6625c6c1daeSBarry Smith The classid is associated with each event so that classes of events 6635c6c1daeSBarry Smith can be disabled simultaneously, such as all matrix events. The user 664*811af0c4SBarry Smith can either use an existing classid, such as `MAT_CLASSID`, or create 6655c6c1daeSBarry Smith their own as shown in the example. 6665c6c1daeSBarry Smith 667c5deb1d5SJed Brown If an existing event with the same name exists, its event handle is 668c5deb1d5SJed Brown returned instead of creating a new event. 669c5deb1d5SJed Brown 6705c6c1daeSBarry Smith Level: intermediate 6715c6c1daeSBarry Smith 672*811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogFlops()`, 673db781477SPatrick Sanan `PetscLogEventActivate()`, `PetscLogEventDeactivate()`, `PetscClassIdRegister()` 6745c6c1daeSBarry Smith @*/ 6759371c9d4SSatish Balay PetscErrorCode PetscLogEventRegister(const char name[], PetscClassId classid, PetscLogEvent *event) { 6765c6c1daeSBarry Smith PetscStageLog stageLog; 6775c6c1daeSBarry Smith int stage; 6785c6c1daeSBarry Smith 6795c6c1daeSBarry Smith PetscFunctionBegin; 6805c6c1daeSBarry Smith *event = PETSC_DECIDE; 6819566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 6829566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, event)); 683c5deb1d5SJed Brown if (*event > 0) PetscFunctionReturn(0); 6849566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogRegister(stageLog->eventLog, name, classid, event)); 6855c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 6869566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents)); 6879566063dSJacob Faibussowitsch PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses)); 6885c6c1daeSBarry Smith } 6895c6c1daeSBarry Smith PetscFunctionReturn(0); 6905c6c1daeSBarry Smith } 6915c6c1daeSBarry Smith 6925c6c1daeSBarry Smith /*@ 693217044c2SLisandro Dalcin PetscLogEventSetCollective - Indicates that a particular event is collective. 694217044c2SLisandro Dalcin 695217044c2SLisandro Dalcin Not Collective 696217044c2SLisandro Dalcin 697d8d19677SJose E. Roman Input Parameters: 698217044c2SLisandro Dalcin + event - The event id 699217044c2SLisandro Dalcin - collective - Bolean flag indicating whether a particular event is collective 700217044c2SLisandro Dalcin 701*811af0c4SBarry Smith Notes: 702*811af0c4SBarry Smith New events returned from `PetscLogEventRegister()` are collective by default. 703*811af0c4SBarry Smith 704*811af0c4SBarry Smith Collective events are handled specially if the -log_sync is used. In that case the logging saves information about 705*811af0c4SBarry Smith two parts of the event; the time for all the MPI ranks to synchronize and then the time for the actual computation/communication 706*811af0c4SBarry Smith to be performed. This option is useful to debug imbalance within the computations or communications 707217044c2SLisandro Dalcin 708217044c2SLisandro Dalcin Level: developer 709217044c2SLisandro Dalcin 710*811af0c4SBarry Smith .seealso: `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogEventRegister()` 711217044c2SLisandro Dalcin @*/ 7129371c9d4SSatish Balay PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event, PetscBool collective) { 713217044c2SLisandro Dalcin PetscStageLog stageLog; 714217044c2SLisandro Dalcin PetscEventRegLog eventRegLog; 715217044c2SLisandro Dalcin 716217044c2SLisandro Dalcin PetscFunctionBegin; 7179566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 7189566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetEventRegLog(stageLog, &eventRegLog)); 719cc73adaaSBarry Smith PetscCheck(event >= 0 && event <= eventRegLog->numEvents, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Invalid event id"); 720217044c2SLisandro Dalcin eventRegLog->eventInfo[event].collective = collective; 721217044c2SLisandro Dalcin PetscFunctionReturn(0); 722217044c2SLisandro Dalcin } 723217044c2SLisandro Dalcin 724217044c2SLisandro Dalcin /*@ 725fa2bb9feSLisandro Dalcin PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage. 726fa2bb9feSLisandro Dalcin 727fa2bb9feSLisandro Dalcin Not Collective 728fa2bb9feSLisandro Dalcin 729fa2bb9feSLisandro Dalcin Input Parameter: 730*811af0c4SBarry Smith . classid - The object class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 731fa2bb9feSLisandro Dalcin 732fa2bb9feSLisandro Dalcin Level: developer 733fa2bb9feSLisandro Dalcin 734c2e3fba1SPatrick Sanan .seealso: `PetscLogEventActivateClass()`, `PetscLogEventDeactivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 735fa2bb9feSLisandro Dalcin @*/ 7369371c9d4SSatish Balay PetscErrorCode PetscLogEventIncludeClass(PetscClassId classid) { 737fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 738fa2bb9feSLisandro Dalcin int stage; 739fa2bb9feSLisandro Dalcin 740fa2bb9feSLisandro Dalcin PetscFunctionBegin; 7419566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 74248a46eb9SPierre Jolivet for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 743fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 744fa2bb9feSLisandro Dalcin } 745fa2bb9feSLisandro Dalcin 746fa2bb9feSLisandro Dalcin /*@ 747fa2bb9feSLisandro Dalcin PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage. 748fa2bb9feSLisandro Dalcin 749fa2bb9feSLisandro Dalcin Not Collective 750fa2bb9feSLisandro Dalcin 751fa2bb9feSLisandro Dalcin Input Parameter: 752*811af0c4SBarry Smith . classid - The object class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 753fa2bb9feSLisandro Dalcin 754fa2bb9feSLisandro Dalcin Level: developer 755fa2bb9feSLisandro Dalcin 756*811af0c4SBarry Smith Note: 757*811af0c4SBarry Smith If a class is excluded then events associated with that class are not logged. 758*811af0c4SBarry Smith 759c2e3fba1SPatrick Sanan .seealso: `PetscLogEventDeactivateClass()`, `PetscLogEventActivateClass()`, `PetscLogEventDeactivate()`, `PetscLogEventActivate()` 760fa2bb9feSLisandro Dalcin @*/ 7619371c9d4SSatish Balay PetscErrorCode PetscLogEventExcludeClass(PetscClassId classid) { 762fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 763fa2bb9feSLisandro Dalcin int stage; 764fa2bb9feSLisandro Dalcin 765fa2bb9feSLisandro Dalcin PetscFunctionBegin; 7669566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 76748a46eb9SPierre Jolivet for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 768fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 769fa2bb9feSLisandro Dalcin } 770fa2bb9feSLisandro Dalcin 771fa2bb9feSLisandro Dalcin /*@ 7725c6c1daeSBarry Smith PetscLogEventActivate - Indicates that a particular event should be logged. 7735c6c1daeSBarry Smith 7745c6c1daeSBarry Smith Not Collective 7755c6c1daeSBarry Smith 7765c6c1daeSBarry Smith Input Parameter: 7775c6c1daeSBarry Smith . event - The event id 7785c6c1daeSBarry Smith 7795c6c1daeSBarry Smith Usage: 7805c6c1daeSBarry Smith .vb 7815c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 7825c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 7835c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 7845c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 7855c6c1daeSBarry Smith .ve 7865c6c1daeSBarry Smith 7875c6c1daeSBarry Smith Note: 7885c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in include/petsclog.h) 789*811af0c4SBarry Smith or an event number obtained with `PetscLogEventRegister()`. 7905c6c1daeSBarry Smith 7915c6c1daeSBarry Smith Level: advanced 7925c6c1daeSBarry Smith 793db781477SPatrick Sanan .seealso: `PlogEventDeactivate()`, `PlogEventDeactivatePush()`, `PetscLogEventDeactivatePop()` 7945c6c1daeSBarry Smith @*/ 7959371c9d4SSatish Balay PetscErrorCode PetscLogEventActivate(PetscLogEvent event) { 7965c6c1daeSBarry Smith PetscStageLog stageLog; 7975c6c1daeSBarry Smith int stage; 7985c6c1daeSBarry Smith 7995c6c1daeSBarry Smith PetscFunctionBegin; 8009566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 8019566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 8029566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event)); 8035c6c1daeSBarry Smith PetscFunctionReturn(0); 8045c6c1daeSBarry Smith } 8055c6c1daeSBarry Smith 8065c6c1daeSBarry Smith /*@ 8075c6c1daeSBarry Smith PetscLogEventDeactivate - Indicates that a particular event should not be logged. 8085c6c1daeSBarry Smith 8095c6c1daeSBarry Smith Not Collective 8105c6c1daeSBarry Smith 8115c6c1daeSBarry Smith Input Parameter: 8125c6c1daeSBarry Smith . event - The event id 8135c6c1daeSBarry Smith 8145c6c1daeSBarry Smith Usage: 8155c6c1daeSBarry Smith .vb 8165c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 8175c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 8185c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 8195c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 8205c6c1daeSBarry Smith .ve 8215c6c1daeSBarry Smith 8225c6c1daeSBarry Smith Note: 8235c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in 824*811af0c4SBarry Smith include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`). 8255c6c1daeSBarry Smith 8265c6c1daeSBarry Smith Level: advanced 8275c6c1daeSBarry Smith 828db781477SPatrick Sanan .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePush()`, `PetscLogEventDeactivatePop()` 8295c6c1daeSBarry Smith @*/ 8309371c9d4SSatish Balay PetscErrorCode PetscLogEventDeactivate(PetscLogEvent event) { 8315c6c1daeSBarry Smith PetscStageLog stageLog; 8325c6c1daeSBarry Smith int stage; 8335c6c1daeSBarry Smith 8345c6c1daeSBarry Smith PetscFunctionBegin; 8359566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 8369566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 8379566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event)); 8385c6c1daeSBarry Smith PetscFunctionReturn(0); 8395c6c1daeSBarry Smith } 8405c6c1daeSBarry Smith 8415c6c1daeSBarry Smith /*@ 842*811af0c4SBarry Smith PetscLogEventDeactivatePush - Indicates that a particular event should not be logged until `PetscLogEventDeactivatePop()` is called 843c00cb57fSBarry Smith 844c00cb57fSBarry Smith Not Collective 845c00cb57fSBarry Smith 846c00cb57fSBarry Smith Input Parameter: 847c00cb57fSBarry Smith . event - The event id 848c00cb57fSBarry Smith 849c00cb57fSBarry Smith Usage: 850c00cb57fSBarry Smith .vb 851c00cb57fSBarry Smith PetscLogEventDeactivatePush(VEC_SetValues); 852c00cb57fSBarry Smith [code where you do not want to log VecSetValues()] 853c00cb57fSBarry Smith PetscLogEventDeactivatePop(VEC_SetValues); 854c00cb57fSBarry Smith [code where you do want to log VecSetValues()] 855c00cb57fSBarry Smith .ve 856c00cb57fSBarry Smith 857c00cb57fSBarry Smith Note: 858c00cb57fSBarry Smith The event may be either a pre-defined PETSc event (found in 859*811af0c4SBarry Smith include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`). 860c00cb57fSBarry Smith 861c00cb57fSBarry Smith Level: advanced 862c00cb57fSBarry Smith 863*811af0c4SBarry Smith .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePop()`, `PetscLogEventDeactivate()` 864c00cb57fSBarry Smith @*/ 8659371c9d4SSatish Balay PetscErrorCode PetscLogEventDeactivatePush(PetscLogEvent event) { 866c00cb57fSBarry Smith PetscStageLog stageLog; 867c00cb57fSBarry Smith int stage; 868c00cb57fSBarry Smith 869c00cb57fSBarry Smith PetscFunctionBegin; 8709566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 8719566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 8729566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivatePush(stageLog->stageInfo[stage].eventLog, event)); 873c00cb57fSBarry Smith PetscFunctionReturn(0); 874c00cb57fSBarry Smith } 875c00cb57fSBarry Smith 876c00cb57fSBarry Smith /*@ 877*811af0c4SBarry Smith PetscLogEventDeactivatePop - Indicates that a particular event should again be logged after the logging was turned off with `PetscLogEventDeactivatePush()` 878c00cb57fSBarry Smith 879c00cb57fSBarry Smith Not Collective 880c00cb57fSBarry Smith 881c00cb57fSBarry Smith Input Parameter: 882c00cb57fSBarry Smith . event - The event id 883c00cb57fSBarry Smith 884c00cb57fSBarry Smith Usage: 885c00cb57fSBarry Smith .vb 886c00cb57fSBarry Smith PetscLogEventDeactivatePush(VEC_SetValues); 887c00cb57fSBarry Smith [code where you do not want to log VecSetValues()] 888c00cb57fSBarry Smith PetscLogEventDeactivatePop(VEC_SetValues); 889c00cb57fSBarry Smith [code where you do want to log VecSetValues()] 890c00cb57fSBarry Smith .ve 891c00cb57fSBarry Smith 892c00cb57fSBarry Smith Note: 893c00cb57fSBarry Smith The event may be either a pre-defined PETSc event (found in 894*811af0c4SBarry Smith include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`). 895c00cb57fSBarry Smith 896c00cb57fSBarry Smith Level: advanced 897c00cb57fSBarry Smith 898db781477SPatrick Sanan .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePush()` 899c00cb57fSBarry Smith @*/ 9009371c9d4SSatish Balay PetscErrorCode PetscLogEventDeactivatePop(PetscLogEvent event) { 901c00cb57fSBarry Smith PetscStageLog stageLog; 902c00cb57fSBarry Smith int stage; 903c00cb57fSBarry Smith 904c00cb57fSBarry Smith PetscFunctionBegin; 9059566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9069566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 9079566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivatePop(stageLog->stageInfo[stage].eventLog, event)); 908c00cb57fSBarry Smith PetscFunctionReturn(0); 909c00cb57fSBarry Smith } 910c00cb57fSBarry Smith 911c00cb57fSBarry Smith /*@ 912*811af0c4SBarry Smith PetscLogEventSetActiveAll - Turns on logging of all events 9135c6c1daeSBarry Smith 9145c6c1daeSBarry Smith Not Collective 9155c6c1daeSBarry Smith 9165c6c1daeSBarry Smith Input Parameters: 9175c6c1daeSBarry Smith + event - The event id 9185c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged 9195c6c1daeSBarry Smith 9205c6c1daeSBarry Smith Level: advanced 9215c6c1daeSBarry Smith 922c2e3fba1SPatrick Sanan .seealso: `PlogEventActivate()`, `PlogEventDeactivate()` 9235c6c1daeSBarry Smith @*/ 9249371c9d4SSatish Balay PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive) { 9255c6c1daeSBarry Smith PetscStageLog stageLog; 9265c6c1daeSBarry Smith int stage; 9275c6c1daeSBarry Smith 9285c6c1daeSBarry Smith PetscFunctionBegin; 9299566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9305c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 9315c6c1daeSBarry Smith if (isActive) { 9329566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event)); 9335c6c1daeSBarry Smith } else { 9349566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event)); 9355c6c1daeSBarry Smith } 9365c6c1daeSBarry Smith } 9375c6c1daeSBarry Smith PetscFunctionReturn(0); 9385c6c1daeSBarry Smith } 9395c6c1daeSBarry Smith 9405c6c1daeSBarry Smith /*@ 941*811af0c4SBarry Smith PetscLogEventActivateClass - Activates event logging for a PETSc object class for the current stage 9425c6c1daeSBarry Smith 9435c6c1daeSBarry Smith Not Collective 9445c6c1daeSBarry Smith 9455c6c1daeSBarry Smith Input Parameter: 946*811af0c4SBarry Smith . classid - The event class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 9475c6c1daeSBarry Smith 9485c6c1daeSBarry Smith Level: developer 9495c6c1daeSBarry Smith 950*811af0c4SBarry Smith .seealso: `PetscLogEventIncludeClass()`, `PetscLogEventExcludeClass()`, `PetscLogEventDeactivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 9515c6c1daeSBarry Smith @*/ 9529371c9d4SSatish Balay PetscErrorCode PetscLogEventActivateClass(PetscClassId classid) { 9535c6c1daeSBarry Smith PetscStageLog stageLog; 9545c6c1daeSBarry Smith int stage; 9555c6c1daeSBarry Smith 9565c6c1daeSBarry Smith PetscFunctionBegin; 9579566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9589566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 9599566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 9605c6c1daeSBarry Smith PetscFunctionReturn(0); 9615c6c1daeSBarry Smith } 9625c6c1daeSBarry Smith 9635c6c1daeSBarry Smith /*@ 964*811af0c4SBarry Smith PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class for the current stage 9655c6c1daeSBarry Smith 9665c6c1daeSBarry Smith Not Collective 9675c6c1daeSBarry Smith 9685c6c1daeSBarry Smith Input Parameter: 969*811af0c4SBarry Smith . classid - The event class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 9705c6c1daeSBarry Smith 9715c6c1daeSBarry Smith Level: developer 9725c6c1daeSBarry Smith 973*811af0c4SBarry Smith .seealso: `PetscLogEventIncludeClass()`, `PetscLogEventExcludeClass()`,`PetscLogEventActivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 9745c6c1daeSBarry Smith @*/ 9759371c9d4SSatish Balay PetscErrorCode PetscLogEventDeactivateClass(PetscClassId classid) { 9765c6c1daeSBarry Smith PetscStageLog stageLog; 9775c6c1daeSBarry Smith int stage; 9785c6c1daeSBarry Smith 9795c6c1daeSBarry Smith PetscFunctionBegin; 9809566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9819566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 9829566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 9835c6c1daeSBarry Smith PetscFunctionReturn(0); 9845c6c1daeSBarry Smith } 9855c6c1daeSBarry Smith 9865c6c1daeSBarry Smith /*MC 98762872c28SLisandro Dalcin PetscLogEventSync - Synchronizes the beginning of a user event. 98862872c28SLisandro Dalcin 98962872c28SLisandro Dalcin Synopsis: 99062872c28SLisandro Dalcin #include <petsclog.h> 99162872c28SLisandro Dalcin PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm) 99262872c28SLisandro Dalcin 99362872c28SLisandro Dalcin Collective 99462872c28SLisandro Dalcin 99562872c28SLisandro Dalcin Input Parameters: 99662872c28SLisandro Dalcin + e - integer associated with the event obtained from PetscLogEventRegister() 99762872c28SLisandro Dalcin - comm - an MPI communicator 99862872c28SLisandro Dalcin 99962872c28SLisandro Dalcin Usage: 100062872c28SLisandro Dalcin .vb 100162872c28SLisandro Dalcin PetscLogEvent USER_EVENT; 100262872c28SLisandro Dalcin PetscLogEventRegister("User event",0,&USER_EVENT); 100362872c28SLisandro Dalcin PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD); 100462872c28SLisandro Dalcin PetscLogEventBegin(USER_EVENT,0,0,0,0); 100562872c28SLisandro Dalcin [code segment to monitor] 100662872c28SLisandro Dalcin PetscLogEventEnd(USER_EVENT,0,0,0,0); 100762872c28SLisandro Dalcin .ve 100862872c28SLisandro Dalcin 1009*811af0c4SBarry Smith Note: 101062872c28SLisandro Dalcin This routine should be called only if there is not a 1011*811af0c4SBarry Smith `PetscObject` available to pass to `PetscLogEventBegin()`. 101262872c28SLisandro Dalcin 101362872c28SLisandro Dalcin Level: developer 101462872c28SLisandro Dalcin 1015db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()` 101662872c28SLisandro Dalcin M*/ 101762872c28SLisandro Dalcin 101862872c28SLisandro Dalcin /*MC 10195c6c1daeSBarry Smith PetscLogEventBegin - Logs the beginning of a user event. 10205c6c1daeSBarry Smith 10215c6c1daeSBarry Smith Synopsis: 1022aaa7dc30SBarry Smith #include <petsclog.h> 1023f2ba6396SBarry Smith PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10245c6c1daeSBarry Smith 10255c6c1daeSBarry Smith Not Collective 10265c6c1daeSBarry Smith 10275c6c1daeSBarry Smith Input Parameters: 10285c6c1daeSBarry Smith + e - integer associated with the event obtained from PetscLogEventRegister() 10295c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10305c6c1daeSBarry Smith 10315c6c1daeSBarry Smith Fortran Synopsis: 10325c6c1daeSBarry Smith void PetscLogEventBegin(int e,PetscErrorCode ierr) 10335c6c1daeSBarry Smith 10345c6c1daeSBarry Smith Usage: 10355c6c1daeSBarry Smith .vb 10365c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 10375c6c1daeSBarry Smith PetscLogDouble user_event_flops; 10385c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 10395c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 10405c6c1daeSBarry Smith [code segment to monitor] 10415c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 10425c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 10435c6c1daeSBarry Smith .ve 10445c6c1daeSBarry Smith 1045*811af0c4SBarry Smith Developer Note: 1046*811af0c4SBarry Smith `PetscLogEventBegin()` and `PetscLogEventBegin()` return error codes instead of explicitly handling the 1047d0609cedSBarry Smith errors that occur in the macro directly because other packages that use this macros have used them in their 1048d0609cedSBarry Smith own functions or methods that do not return error codes and it would be disruptive to change the current 1049d0609cedSBarry Smith behavior. 1050d0609cedSBarry Smith 10515c6c1daeSBarry Smith Level: intermediate 10525c6c1daeSBarry Smith 1053db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventEnd()`, `PetscLogFlops()` 10545c6c1daeSBarry Smith M*/ 10555c6c1daeSBarry Smith 10565c6c1daeSBarry Smith /*MC 10575c6c1daeSBarry Smith PetscLogEventEnd - Log the end of a user event. 10585c6c1daeSBarry Smith 10595c6c1daeSBarry Smith Synopsis: 1060aaa7dc30SBarry Smith #include <petsclog.h> 1061f2ba6396SBarry Smith PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10625c6c1daeSBarry Smith 10635c6c1daeSBarry Smith Not Collective 10645c6c1daeSBarry Smith 10655c6c1daeSBarry Smith Input Parameters: 10665c6c1daeSBarry Smith + e - integer associated with the event obtained with PetscLogEventRegister() 10675c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10685c6c1daeSBarry Smith 10695c6c1daeSBarry Smith Fortran Synopsis: 10705c6c1daeSBarry Smith void PetscLogEventEnd(int e,PetscErrorCode ierr) 10715c6c1daeSBarry Smith 10725c6c1daeSBarry Smith Usage: 10735c6c1daeSBarry Smith .vb 10745c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 10755c6c1daeSBarry Smith PetscLogDouble user_event_flops; 10765c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT,); 10775c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 10785c6c1daeSBarry Smith [code segment to monitor] 10795c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 10805c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 10815c6c1daeSBarry Smith .ve 10825c6c1daeSBarry Smith 10835c6c1daeSBarry Smith Level: intermediate 10845c6c1daeSBarry Smith 1085db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogFlops()` 10865c6c1daeSBarry Smith M*/ 10875c6c1daeSBarry Smith 10885c6c1daeSBarry Smith /*@C 10895c6c1daeSBarry Smith PetscLogEventGetId - Returns the event id when given the event name. 10905c6c1daeSBarry Smith 10915c6c1daeSBarry Smith Not Collective 10925c6c1daeSBarry Smith 10935c6c1daeSBarry Smith Input Parameter: 10945c6c1daeSBarry Smith . name - The event name 10955c6c1daeSBarry Smith 10965c6c1daeSBarry Smith Output Parameter: 1097c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists 10985c6c1daeSBarry Smith 10995c6c1daeSBarry Smith Level: intermediate 11005c6c1daeSBarry Smith 1101db781477SPatrick Sanan .seealso: `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogStageGetId()` 11025c6c1daeSBarry Smith @*/ 11039371c9d4SSatish Balay PetscErrorCode PetscLogEventGetId(const char name[], PetscLogEvent *event) { 11045c6c1daeSBarry Smith PetscStageLog stageLog; 11055c6c1daeSBarry Smith 11065c6c1daeSBarry Smith PetscFunctionBegin; 11079566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 11089566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, event)); 11095c6c1daeSBarry Smith PetscFunctionReturn(0); 11105c6c1daeSBarry Smith } 11115c6c1daeSBarry Smith 11129371c9d4SSatish Balay PetscErrorCode PetscLogPushCurrentEvent_Internal(PetscLogEvent event) { 11137a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11147a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackPush(current_log_event_stack, event)); 11157a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11167a101e5eSJacob Faibussowitsch } 11177a101e5eSJacob Faibussowitsch 11189371c9d4SSatish Balay PetscErrorCode PetscLogPopCurrentEvent_Internal(void) { 11197a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11207a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackPop(current_log_event_stack, NULL)); 11217a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11227a101e5eSJacob Faibussowitsch } 11237a101e5eSJacob Faibussowitsch 11249371c9d4SSatish Balay PetscErrorCode PetscLogGetCurrentEvent_Internal(PetscLogEvent *event) { 11257a101e5eSJacob Faibussowitsch PetscBool empty; 11267a101e5eSJacob Faibussowitsch 11277a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11287a101e5eSJacob Faibussowitsch PetscValidIntPointer(event, 1); 11297a101e5eSJacob Faibussowitsch *event = PETSC_DECIDE; 11307a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackEmpty(current_log_event_stack, &empty)); 11317a101e5eSJacob Faibussowitsch if (!empty) PetscCall(PetscIntStackTop(current_log_event_stack, event)); 11327a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11337a101e5eSJacob Faibussowitsch } 11347a101e5eSJacob Faibussowitsch 11359371c9d4SSatish Balay PetscErrorCode PetscLogEventPause_Internal(PetscLogEvent event) { 11367a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11377a101e5eSJacob Faibussowitsch if (event != PETSC_DECIDE) PetscCall(PetscLogEventEnd(event, NULL, NULL, NULL, NULL)); 11387a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11397a101e5eSJacob Faibussowitsch } 11407a101e5eSJacob Faibussowitsch 11419371c9d4SSatish Balay PetscErrorCode PetscLogEventResume_Internal(PetscLogEvent event) { 11427a101e5eSJacob Faibussowitsch PetscStageLog stageLog; 11437a101e5eSJacob Faibussowitsch PetscEventPerfLog eventLog; 11447a101e5eSJacob Faibussowitsch int stage; 11457a101e5eSJacob Faibussowitsch 11467a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11477a101e5eSJacob Faibussowitsch if (event == PETSC_DECIDE) PetscFunctionReturn(0); 11487a101e5eSJacob Faibussowitsch PetscCall(PetscLogEventBegin(event, NULL, NULL, NULL, NULL)); 11497a101e5eSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 11507a101e5eSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 11517a101e5eSJacob Faibussowitsch PetscCall(PetscStageLogGetEventPerfLog(stageLog, stage, &eventLog)); 11527a101e5eSJacob Faibussowitsch eventLog->eventInfo[event].count--; 11537a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11547a101e5eSJacob Faibussowitsch } 11557a101e5eSJacob Faibussowitsch 11565c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/ 11575c6c1daeSBarry Smith /*@C 11585c6c1daeSBarry Smith PetscLogDump - Dumps logs of objects to a file. This file is intended to 11595c6c1daeSBarry Smith be read by bin/petscview. This program no longer exists. 11605c6c1daeSBarry Smith 1161*811af0c4SBarry Smith Collective on `PETSC_COMM_WORLD` 11625c6c1daeSBarry Smith 11635c6c1daeSBarry Smith Input Parameter: 11645c6c1daeSBarry Smith . name - an optional file name 11655c6c1daeSBarry Smith 11665c6c1daeSBarry Smith Usage: 11675c6c1daeSBarry Smith .vb 11685c6c1daeSBarry Smith PetscInitialize(...); 1169bb1d7374SBarry Smith PetscLogDefaultBegin(); or PetscLogAllBegin(); 11705c6c1daeSBarry Smith ... code ... 11715c6c1daeSBarry Smith PetscLogDump(filename); 11725c6c1daeSBarry Smith PetscFinalize(); 11735c6c1daeSBarry Smith .ve 11745c6c1daeSBarry Smith 1175*811af0c4SBarry Smith Note: 11765c6c1daeSBarry Smith The default file name is 11775c6c1daeSBarry Smith $ Log.<rank> 11785c6c1daeSBarry Smith where <rank> is the processor number. If no name is specified, 11795c6c1daeSBarry Smith this file will be used. 11805c6c1daeSBarry Smith 11815c6c1daeSBarry Smith Level: advanced 11825c6c1daeSBarry Smith 1183db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogView()` 11845c6c1daeSBarry Smith @*/ 11859371c9d4SSatish Balay PetscErrorCode PetscLogDump(const char sname[]) { 11865c6c1daeSBarry Smith PetscStageLog stageLog; 11875c6c1daeSBarry Smith PetscEventPerfInfo *eventInfo; 11885c6c1daeSBarry Smith FILE *fd; 11895c6c1daeSBarry Smith char file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN]; 11905c6c1daeSBarry Smith PetscLogDouble flops, _TotalTime; 11915c6c1daeSBarry Smith PetscMPIInt rank; 11925c6c1daeSBarry Smith int action, object, curStage; 11935c6c1daeSBarry Smith PetscLogEvent event; 11945c6c1daeSBarry Smith 11955c6c1daeSBarry Smith PetscFunctionBegin; 11965c6c1daeSBarry Smith /* Calculate the total elapsed time */ 11978563dfccSBarry Smith PetscTime(&_TotalTime); 11985c6c1daeSBarry Smith _TotalTime -= petsc_BaseTime; 11995c6c1daeSBarry Smith /* Open log file */ 12009566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank)); 12017ff663adSLisandro Dalcin if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank); 1202a297a907SKarl Rupp else sprintf(file, "Log.%d", rank); 12039566063dSJacob Faibussowitsch PetscCall(PetscFixFilename(file, fname)); 12049566063dSJacob Faibussowitsch PetscCall(PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd)); 120508401ef6SPierre Jolivet PetscCheck(!(rank == 0) || !(!fd), PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname); 12065c6c1daeSBarry Smith /* Output totals */ 12079566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime)); 12089566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0)); 12095c6c1daeSBarry Smith /* Output actions */ 12105c6c1daeSBarry Smith if (petsc_logActions) { 12119566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions)); 12125c6c1daeSBarry Smith for (action = 0; action < petsc_numActions; action++) { 12139371c9d4SSatish Balay PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n", petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1, 1214d0609cedSBarry Smith petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem)); 12155c6c1daeSBarry Smith } 12165c6c1daeSBarry Smith } 12175c6c1daeSBarry Smith /* Output objects */ 12185c6c1daeSBarry Smith if (petsc_logObjects) { 12199566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed)); 12205c6c1daeSBarry Smith for (object = 0; object < petsc_numObjects; object++) { 12219566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int)petsc_objects[object].mem)); 12225c6c1daeSBarry Smith if (!petsc_objects[object].name[0]) { 12239566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "No Name\n")); 12245c6c1daeSBarry Smith } else { 12259566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name)); 12265c6c1daeSBarry Smith } 12275c6c1daeSBarry Smith if (petsc_objects[object].info[0] != 0) { 12289566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n")); 12295c6c1daeSBarry Smith } else { 12309566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info)); 12315c6c1daeSBarry Smith } 12325c6c1daeSBarry Smith } 12335c6c1daeSBarry Smith } 12345c6c1daeSBarry Smith /* Output events */ 12359566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n")); 12369566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 12379566063dSJacob Faibussowitsch PetscCall(PetscIntStackTop(stageLog->stack, &curStage)); 12385c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo; 12395c6c1daeSBarry Smith for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) { 1240a297a907SKarl Rupp if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops / eventInfo[event].time; 1241a297a907SKarl Rupp else flops = 0.0; 1242d0609cedSBarry Smith PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count, eventInfo[event].flops, eventInfo[event].time, flops)); 12435c6c1daeSBarry Smith } 12449566063dSJacob Faibussowitsch PetscCall(PetscFClose(PETSC_COMM_WORLD, fd)); 12455c6c1daeSBarry Smith PetscFunctionReturn(0); 12465c6c1daeSBarry Smith } 12475c6c1daeSBarry Smith 1248f14045dbSBarry Smith /* 1249f14045dbSBarry Smith PetscLogView_Detailed - Each process prints the times for its own events 1250f14045dbSBarry Smith 1251f14045dbSBarry Smith */ 12529371c9d4SSatish Balay PetscErrorCode PetscLogView_Detailed(PetscViewer viewer) { 12532dff6485SMatthew G. Knepley PetscStageLog stageLog; 1254217044c2SLisandro Dalcin PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL; 1255217044c2SLisandro Dalcin PetscLogDouble locTotalTime, numRed, maxMem; 12562dff6485SMatthew G. Knepley int numStages, numEvents, stage, event; 1257217044c2SLisandro Dalcin MPI_Comm comm = PetscObjectComm((PetscObject)viewer); 12582dff6485SMatthew G. Knepley PetscMPIInt rank, size; 1259f14045dbSBarry Smith 1260f14045dbSBarry Smith PetscFunctionBegin; 12619566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 12629566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 12632dff6485SMatthew G. Knepley /* Must preserve reduction count before we go on */ 12642dff6485SMatthew G. Knepley numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 12652d1ec343SBarry Smith /* Get the total elapsed time */ 12669371c9d4SSatish Balay PetscTime(&locTotalTime); 12679371c9d4SSatish Balay locTotalTime -= petsc_BaseTime; 12689566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "size = %d\n", size)); 12699566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalTimes = {}\n")); 12709566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMessages = {}\n")); 12719566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMessageLens = {}\n")); 12729566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalReductions = {}\n")); 12739566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalFlop = {}\n")); 12749566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalObjects = {}\n")); 12759566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMemory = {}\n")); 12769566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 12779566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 12789566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Stages = {}\n")); 12792d1ec343SBarry Smith for (stage = 0; stage < numStages; stage++) { 12809566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"] = {}\n", stageLog->stageInfo[stage].name)); 12819566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"][\"summary\"] = {}\n", stageLog->stageInfo[stage].name)); 12829566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 128348a46eb9SPierre Jolivet for (event = 0; event < numEvents; event++) PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"][\"%s\"] = {}\n", stageLog->stageInfo[stage].name, stageLog->eventLog->eventInfo[event].name)); 12842d1ec343SBarry Smith } 12859566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&maxMem)); 12869566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushSynchronized(viewer)); 12879566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalTimes[%d] = %g\n", rank, locTotalTime)); 12889566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMessages[%d] = %g\n", rank, (petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct))); 12899566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMessageLens[%d] = %g\n", rank, (petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len))); 12909566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalReductions[%d] = %g\n", rank, numRed)); 12919566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalFlop[%d] = %g\n", rank, petsc_TotalFlops)); 12929566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalObjects[%d] = %d\n", rank, petsc_numObjects)); 12939566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMemory[%d] = %g\n", rank, maxMem)); 12949566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 12952d1ec343SBarry Smith for (stage = 0; stage < numStages; stage++) { 1296217044c2SLisandro Dalcin stageInfo = &stageLog->stageInfo[stage].perfInfo; 12979371c9d4SSatish Balay PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n", stageLog->stageInfo[stage].name, rank, stageInfo->time, 12989371c9d4SSatish Balay stageInfo->numMessages, stageInfo->messageLength, stageInfo->numReductions, stageInfo->flops)); 12999566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 13002d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 1301217044c2SLisandro Dalcin eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 1302d0609cedSBarry Smith PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %d, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g", 13039371c9d4SSatish Balay stageLog->stageInfo[stage].name, stageLog->eventLog->eventInfo[event].name, rank, eventInfo->count, eventInfo->time, eventInfo->syncTime, eventInfo->numMessages, eventInfo->messageLength, eventInfo->numReductions, 13049371c9d4SSatish Balay eventInfo->flops)); 1305891e75beSMatthew G. Knepley if (eventInfo->dof[0] >= 0.) { 1306891e75beSMatthew G. Knepley PetscInt d, e; 13075d68e14cSMatthew G. Knepley 13089566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : [")); 1309891e75beSMatthew G. Knepley for (d = 0; d < 8; ++d) { 13109566063dSJacob Faibussowitsch if (d > 0) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", ")); 13119566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d])); 1312891e75beSMatthew G. Knepley } 13139566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "]")); 13149566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : [")); 13155d68e14cSMatthew G. Knepley for (e = 0; e < 8; ++e) { 13169566063dSJacob Faibussowitsch if (e > 0) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", ")); 13179566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e])); 13185d68e14cSMatthew G. Knepley } 13199566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "]")); 13205d68e14cSMatthew G. Knepley } 13219566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "}\n")); 13222d1ec343SBarry Smith } 13232d1ec343SBarry Smith } 13249566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 13259566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopSynchronized(viewer)); 1326f14045dbSBarry Smith PetscFunctionReturn(0); 1327f14045dbSBarry Smith } 1328f14045dbSBarry Smith 132938144912Sdeepblu2718 /* 133038144912Sdeepblu2718 PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format 133138144912Sdeepblu2718 */ 13329371c9d4SSatish Balay PetscErrorCode PetscLogView_CSV(PetscViewer viewer) { 133338144912Sdeepblu2718 PetscStageLog stageLog; 1334669c5be0SSatish Balay PetscEventPerfInfo *eventInfo = NULL; 133538144912Sdeepblu2718 PetscLogDouble locTotalTime, maxMem; 133638144912Sdeepblu2718 int numStages, numEvents, stage, event; 133738144912Sdeepblu2718 MPI_Comm comm = PetscObjectComm((PetscObject)viewer); 133838144912Sdeepblu2718 PetscMPIInt rank, size; 133938144912Sdeepblu2718 134038144912Sdeepblu2718 PetscFunctionBegin; 13419566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 13429566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 134338144912Sdeepblu2718 /* Must preserve reduction count before we go on */ 134438144912Sdeepblu2718 /* Get the total elapsed time */ 13459371c9d4SSatish Balay PetscTime(&locTotalTime); 13469371c9d4SSatish Balay locTotalTime -= petsc_BaseTime; 13479566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 13489566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 13499566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&maxMem)); 13509566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushSynchronized(viewer)); 1351d0609cedSBarry Smith PetscCall(PetscViewerASCIIPrintf(viewer, "Stage Name,Event Name,Rank,Count,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)); 13529566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 135338144912Sdeepblu2718 for (stage = 0; stage < numStages; stage++) { 13549e29573dSMatthew G. Knepley PetscEventPerfInfo *stageInfo = &stageLog->stageInfo[stage].perfInfo; 13559e29573dSMatthew G. Knepley 13569371c9d4SSatish Balay PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%s,summary,%d,1,%g,%g,%g,%g,%g\n", stageLog->stageInfo[stage].name, rank, stageInfo->time, stageInfo->numMessages, stageInfo->messageLength, stageInfo->numReductions, stageInfo->flops)); 13579566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 135838144912Sdeepblu2718 for (event = 0; event < numEvents; event++) { 135938144912Sdeepblu2718 eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 13609371c9d4SSatish Balay PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%s,%s,%d,%d,%g,%g,%g,%g,%g", stageLog->stageInfo[stage].name, stageLog->eventLog->eventInfo[event].name, rank, eventInfo->count, eventInfo->time, eventInfo->numMessages, eventInfo->messageLength, 13619371c9d4SSatish Balay eventInfo->numReductions, eventInfo->flops)); 136238144912Sdeepblu2718 if (eventInfo->dof[0] >= 0.) { 136338144912Sdeepblu2718 PetscInt d, e; 136438144912Sdeepblu2718 136548a46eb9SPierre Jolivet for (d = 0; d < 8; ++d) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d])); 136648a46eb9SPierre Jolivet for (e = 0; e < 8; ++e) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e])); 136738144912Sdeepblu2718 } 13689566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n")); 136938144912Sdeepblu2718 } 137038144912Sdeepblu2718 } 13719566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 13729566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopSynchronized(viewer)); 137338144912Sdeepblu2718 PetscFunctionReturn(0); 137438144912Sdeepblu2718 } 137538144912Sdeepblu2718 13769371c9d4SSatish Balay static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm, FILE *fd) { 1377217044c2SLisandro Dalcin PetscFunctionBegin; 1378217044c2SLisandro Dalcin if (!PetscLogSyncOn) PetscFunctionReturn(0); 13799566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 13809566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 13819566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 13829566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 13839566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 13849566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This program was run with logging synchronization. #\n")); 13859566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This option provides more meaningful imbalance #\n")); 13869566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # figures at the expense of slowing things down and #\n")); 13879566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # providing a distorted view of the overall runtime. #\n")); 13889566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 13899566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1390217044c2SLisandro Dalcin PetscFunctionReturn(0); 1391217044c2SLisandro Dalcin } 1392217044c2SLisandro Dalcin 13939371c9d4SSatish Balay static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm, FILE *fd) { 1394f4091ad2SBarry Smith PetscFunctionBegin; 139576bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 13969566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 13979566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 13989566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 13999566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 14009566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14019566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This code was compiled with a debugging option. #\n")); 14029566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # To get timing results run ./configure #\n")); 14039566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # using --with-debugging=no, the performance will #\n")); 14049566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # be generally two or three times faster. #\n")); 14059566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14069566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 140776bd3646SJed Brown } 1408f4091ad2SBarry Smith PetscFunctionReturn(0); 1409f4091ad2SBarry Smith } 1410f4091ad2SBarry Smith 14119371c9d4SSatish Balay static PetscErrorCode PetscLogViewWarnNoGpuAwareMpi(MPI_Comm comm, FILE *fd) { 1412009ab46cSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1413009ab46cSJunchao Zhang PetscMPIInt size; 1414c2a741eeSJunchao Zhang 1415c2a741eeSJunchao Zhang PetscFunctionBegin; 14169566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 1417340fe3cdSSatish Balay if (use_gpu_aware_mpi || size == 1) PetscFunctionReturn(0); 14189566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 14199566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 14209566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14219566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 14229566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14239566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This code was compiled with GPU support and you've #\n")); 14249566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # created PETSc/GPU objects, but you intentionally #\n")); 14259566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # used -use_gpu_aware_mpi 0, requiring PETSc to copy #\n")); 14269566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # additional data between the GPU and CPU. To obtain #\n")); 14279566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # meaningful timing results on multi-rank runs, use #\n")); 14289566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # GPU-aware MPI instead. #\n")); 14299566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14309566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1431c2a741eeSJunchao Zhang PetscFunctionReturn(0); 1432c2a741eeSJunchao Zhang #else 1433c2a741eeSJunchao Zhang return 0; 1434c2a741eeSJunchao Zhang #endif 1435c2a741eeSJunchao Zhang } 1436c2a741eeSJunchao Zhang 14379371c9d4SSatish Balay static PetscErrorCode PetscLogViewWarnGpuTime(MPI_Comm comm, FILE *fd) { 1438156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1439156b51fbSBarry Smith 1440156b51fbSBarry Smith PetscFunctionBegin; 1441156b51fbSBarry Smith if (!PetscLogGpuTimeFlag || petsc_gflops == 0) PetscFunctionReturn(0); 1442156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, "\n\n")); 1443156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 1444156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1445156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 1446156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1447156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # This code was run with -log_view_gpu_time #\n")); 1448156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # This provides accurate timing within the GPU kernels #\n")); 1449156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # but can slow down the entire computation by a #\n")); 1450156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # measurable amount. For fastest runs we recommend #\n")); 1451156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # not using this option. #\n")); 1452156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1453156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1454156b51fbSBarry Smith PetscFunctionReturn(0); 1455156b51fbSBarry Smith #else 1456156b51fbSBarry Smith return 0; 1457156b51fbSBarry Smith #endif 1458156b51fbSBarry Smith } 1459156b51fbSBarry Smith 14609371c9d4SSatish Balay PetscErrorCode PetscLogView_Default(PetscViewer viewer) { 14615c6c1daeSBarry Smith FILE *fd; 14625c6c1daeSBarry Smith PetscLogDouble zero = 0.0; 14635c6c1daeSBarry Smith PetscStageLog stageLog; 14640298fd71SBarry Smith PetscStageInfo *stageInfo = NULL; 14650298fd71SBarry Smith PetscEventPerfInfo *eventInfo = NULL; 14665c6c1daeSBarry Smith PetscClassPerfInfo *classInfo; 14675c6c1daeSBarry Smith char arch[128], hostname[128], username[128], pname[PETSC_MAX_PATH_LEN], date[128]; 14685c6c1daeSBarry Smith const char *name; 14695c6c1daeSBarry Smith PetscLogDouble locTotalTime, TotalTime, TotalFlops; 14705c6c1daeSBarry Smith PetscLogDouble numMessages, messageLength, avgMessLen, numReductions; 14715c6c1daeSBarry Smith PetscLogDouble stageTime, flops, flopr, mem, mess, messLen, red; 14725c6c1daeSBarry Smith PetscLogDouble fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed; 14735c6c1daeSBarry Smith PetscLogDouble fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed; 14745c6c1daeSBarry Smith PetscLogDouble min, max, tot, ratio, avg, x, y; 1475e3ed9ee7SBarry Smith PetscLogDouble minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr, mal, malmax, emalmax; 1476d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1477156b51fbSBarry Smith PetscLogEvent KSP_Solve, SNES_Solve, TS_Step, TAO_Solve; /* These need to be fixed to be some events registered with certain objects */ 1478958c4211Shannah_mairs PetscLogDouble cct, gct, csz, gsz, gmaxt, gflops, gflopr, fracgflops; 1479bec0b493Shannah_mairs #endif 1480217044c2SLisandro Dalcin PetscMPIInt minC, maxC; 14815c6c1daeSBarry Smith PetscMPIInt size, rank; 14825c6c1daeSBarry Smith PetscBool *localStageUsed, *stageUsed; 14835c6c1daeSBarry Smith PetscBool *localStageVisible, *stageVisible; 14845c6c1daeSBarry Smith int numStages, localNumEvents, numEvents; 148537b78d16SBarry Smith int stage, oclass; 14865c6c1daeSBarry Smith PetscLogEvent event; 1487d0609cedSBarry Smith PetscErrorCode ierr = 0; 14885c6c1daeSBarry Smith char version[256]; 14895c6c1daeSBarry Smith MPI_Comm comm; 1490156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1491156b51fbSBarry Smith PetscLogEvent eventid; 1492156b51fbSBarry Smith PetscInt64 nas = 0x7FF0000000000002; 1493156b51fbSBarry Smith #endif 14945c6c1daeSBarry Smith 14955c6c1daeSBarry Smith PetscFunctionBegin; 1496156b51fbSBarry Smith PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF)); 14979566063dSJacob Faibussowitsch PetscCall(PetscObjectGetComm((PetscObject)viewer, &comm)); 14989566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIGetPointer(viewer, &fd)); 14999566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 15009566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 15015c6c1daeSBarry Smith /* Get the total elapsed time */ 15029371c9d4SSatish Balay PetscTime(&locTotalTime); 15039371c9d4SSatish Balay locTotalTime -= petsc_BaseTime; 15045c6c1daeSBarry Smith 1505faad7b01SPierre Jolivet PetscCall(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n")); 15069566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "*** WIDEN YOUR WINDOW TO 160 CHARACTERS. Use 'enscript -r -fCourier9' to print this document ***\n")); 15079566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n")); 1508faad7b01SPierre Jolivet PetscCall(PetscFPrintf(comm, fd, "\n------------------------------------------------------------------ PETSc Performance Summary: ------------------------------------------------------------------\n\n")); 15099566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnSync(comm, fd)); 15109566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm, fd)); 15119566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnNoGpuAwareMpi(comm, fd)); 1512156b51fbSBarry Smith PetscCall(PetscLogViewWarnGpuTime(comm, fd)); 15139566063dSJacob Faibussowitsch PetscCall(PetscGetArchType(arch, sizeof(arch))); 15149566063dSJacob Faibussowitsch PetscCall(PetscGetHostName(hostname, sizeof(hostname))); 15159566063dSJacob Faibussowitsch PetscCall(PetscGetUserName(username, sizeof(username))); 15169566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(pname, sizeof(pname))); 15179566063dSJacob Faibussowitsch PetscCall(PetscGetDate(date, sizeof(date))); 15189566063dSJacob Faibussowitsch PetscCall(PetscGetVersion(version, sizeof(version))); 15195c6c1daeSBarry Smith if (size == 1) { 15209566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s on a %s named %s with %d processor, by %s %s\n", pname, arch, hostname, size, username, date)); 15215c6c1daeSBarry Smith } else { 15229566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s on a %s named %s with %d processors, by %s %s\n", pname, arch, hostname, size, username, date)); 15235c6c1daeSBarry Smith } 1524f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP) 15259566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Using %" PetscInt_FMT " OpenMP threads\n", PetscNumOMPThreads)); 1526f90b075cSBarry Smith #endif 15279566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Using %s\n", version)); 15285c6c1daeSBarry Smith 15295c6c1daeSBarry Smith /* Must preserve reduction count before we go on */ 15305c6c1daeSBarry Smith red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 15315c6c1daeSBarry Smith 15325c6c1daeSBarry Smith /* Calculate summary information */ 15339566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n Max Max/Min Avg Total\n")); 15345c6c1daeSBarry Smith /* Time */ 15359566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15369566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15379566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1538217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15399371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15409371c9d4SSatish Balay else ratio = 0.0; 15419566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Time (sec): %5.3e %7.3f %5.3e\n", max, ratio, avg)); 15425c6c1daeSBarry Smith TotalTime = tot; 15435c6c1daeSBarry Smith /* Objects */ 15445c6c1daeSBarry Smith avg = (PetscLogDouble)petsc_numObjects; 15459566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15469566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15479566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1548217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15499371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15509371c9d4SSatish Balay else ratio = 0.0; 15519566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Objects: %5.3e %7.3f %5.3e\n", max, ratio, avg)); 15525c6c1daeSBarry Smith /* Flops */ 15539566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15549566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15559566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1556217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15579371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15589371c9d4SSatish Balay else ratio = 0.0; 15599566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Flops: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15605c6c1daeSBarry Smith TotalFlops = tot; 15615c6c1daeSBarry Smith /* Flops/sec -- Must talk to Barry here */ 15629371c9d4SSatish Balay if (locTotalTime != 0.0) flops = petsc_TotalFlops / locTotalTime; 15639371c9d4SSatish Balay else flops = 0.0; 15649566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15659566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15669566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1567217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15689371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15699371c9d4SSatish Balay else ratio = 0.0; 15709566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Flops/sec: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15715c6c1daeSBarry Smith /* Memory */ 15729566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&mem)); 15735c6c1daeSBarry Smith if (mem > 0.0) { 15749566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15759566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15769566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1577217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15789371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15799371c9d4SSatish Balay else ratio = 0.0; 15809566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Memory (bytes): %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15815c6c1daeSBarry Smith } 15825c6c1daeSBarry Smith /* Messages */ 15835c6c1daeSBarry Smith mess = 0.5 * (petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct); 15849566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15859566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15869566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1587217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15889371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15899371c9d4SSatish Balay else ratio = 0.0; 15909566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Msg Count: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15915c6c1daeSBarry Smith numMessages = tot; 15925c6c1daeSBarry Smith /* Message Lengths */ 15935c6c1daeSBarry Smith mess = 0.5 * (petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len); 15949566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15959566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15969566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 15979371c9d4SSatish Balay if (numMessages != 0) avg = tot / numMessages; 15989371c9d4SSatish Balay else avg = 0.0; 15999371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 16009371c9d4SSatish Balay else ratio = 0.0; 16019566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Msg Len (bytes): %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 16025c6c1daeSBarry Smith messageLength = tot; 16035c6c1daeSBarry Smith /* Reductions */ 16049566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 16059566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 16069566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16079371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 16089371c9d4SSatish Balay else ratio = 0.0; 16099566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Reductions: %5.3e %7.3f\n", max, ratio)); 16105c6c1daeSBarry Smith numReductions = red; /* wrong because uses count from process zero */ 16119566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n")); 16129566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " e.g., VecAXPY() for real vectors of length N --> 2N flops\n")); 16139566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " and VecAXPY() for complex vectors of length N --> 8N flops\n")); 16145c6c1daeSBarry Smith 16155c6c1daeSBarry Smith /* Get total number of stages -- 16165c6c1daeSBarry Smith Currently, a single processor can register more stages than another, but stages must all be registered in order. 16175c6c1daeSBarry Smith We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID. 16185c6c1daeSBarry Smith This seems best accomplished by assoicating a communicator with each stage. 16195c6c1daeSBarry Smith */ 16209566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 16219566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 16229566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &localStageUsed)); 16239566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &stageUsed)); 16249566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &localStageVisible)); 16259566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &stageVisible)); 16265c6c1daeSBarry Smith if (numStages > 0) { 16275c6c1daeSBarry Smith stageInfo = stageLog->stageInfo; 16285c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16295c6c1daeSBarry Smith if (stage < stageLog->numStages) { 16305c6c1daeSBarry Smith localStageUsed[stage] = stageInfo[stage].used; 16315c6c1daeSBarry Smith localStageVisible[stage] = stageInfo[stage].perfInfo.visible; 16325c6c1daeSBarry Smith } else { 16335c6c1daeSBarry Smith localStageUsed[stage] = PETSC_FALSE; 16345c6c1daeSBarry Smith localStageVisible[stage] = PETSC_TRUE; 16355c6c1daeSBarry Smith } 16365c6c1daeSBarry Smith } 16379566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm)); 16389566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm)); 16395c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16405c6c1daeSBarry Smith if (stageUsed[stage]) { 16419566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\nSummary of Stages: ----- Time ------ ----- Flop ------ --- Messages --- -- Message Lengths -- -- Reductions --\n")); 16429566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Avg %%Total Avg %%Total Count %%Total Avg %%Total Count %%Total\n")); 16435c6c1daeSBarry Smith break; 16445c6c1daeSBarry Smith } 16455c6c1daeSBarry Smith } 16465c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16475c6c1daeSBarry Smith if (!stageUsed[stage]) continue; 1648820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 16495c6c1daeSBarry Smith if (localStageUsed[stage]) { 16509566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16519566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16529566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16539566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16549566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16555c6c1daeSBarry Smith name = stageInfo[stage].name; 16565c6c1daeSBarry Smith } else { 16579566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16589566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16599566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16609566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16619566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16625c6c1daeSBarry Smith name = ""; 16635c6c1daeSBarry Smith } 16649371c9d4SSatish Balay mess *= 0.5; 16659371c9d4SSatish Balay messLen *= 0.5; 16669371c9d4SSatish Balay red /= size; 16679371c9d4SSatish Balay if (TotalTime != 0.0) fracTime = stageTime / TotalTime; 16689371c9d4SSatish Balay else fracTime = 0.0; 16699371c9d4SSatish Balay if (TotalFlops != 0.0) fracFlops = flops / TotalFlops; 16709371c9d4SSatish Balay else fracFlops = 0.0; 16715c6c1daeSBarry Smith /* Talk to Barry if (stageTime != 0.0) flops = (size*flops)/stageTime; else flops = 0.0; */ 16729371c9d4SSatish Balay if (numMessages != 0.0) fracMessages = mess / numMessages; 16739371c9d4SSatish Balay else fracMessages = 0.0; 16749371c9d4SSatish Balay if (mess != 0.0) avgMessLen = messLen / mess; 16759371c9d4SSatish Balay else avgMessLen = 0.0; 16769371c9d4SSatish Balay if (messageLength != 0.0) fracLength = messLen / messageLength; 16779371c9d4SSatish Balay else fracLength = 0.0; 16789371c9d4SSatish Balay if (numReductions != 0.0) fracReductions = red / numReductions; 16799371c9d4SSatish Balay else fracReductions = 0.0; 16809371c9d4SSatish Balay PetscCall(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", stage, name, stageTime / size, 100.0 * fracTime, flops, 100.0 * fracFlops, mess, 100.0 * fracMessages, avgMessLen, 100.0 * fracLength, red, 100.0 * fracReductions)); 16815c6c1daeSBarry Smith } 16825c6c1daeSBarry Smith } 16835c6c1daeSBarry Smith 16849566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n------------------------------------------------------------------------------------------------------------------------\n")); 16859566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n")); 16869566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Phase summary info:\n")); 16879566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Count: number of times phase was executed\n")); 16889566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Time and Flop: Max - maximum over all processors\n")); 16899566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Ratio - ratio of maximum to minimum over all processors\n")); 16909566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Mess: number of messages sent\n")); 16919566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " AvgLen: average message length (bytes)\n")); 16929566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Reduct: number of global reductions\n")); 16939566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Global: entire computation\n")); 16949566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n")); 16959566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%T - percent time in this phase %%F - percent flop in this phase\n")); 16969566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%M - percent messages in this phase %%L - percent message lengths in this phase\n")); 16979566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%R - percent reductions in this phase\n")); 16989566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n")); 1699e3ed9ee7SBarry Smith if (PetscLogMemory) { 170054aabf2dSBarry Smith PetscCall(PetscFPrintf(comm, fd, " Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event). May be negative\n")); 170154aabf2dSBarry Smith PetscCall(PetscFPrintf(comm, fd, " EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events). Never negative\n")); 170254aabf2dSBarry Smith PetscCall(PetscFPrintf(comm, fd, " MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event). Never negative\n")); 17039566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " RMI Mbytes: Increase in resident memory (sum over all calls to event)\n")); 1704e3ed9ee7SBarry Smith } 1705d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17069566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GPU Mflop/s: 10e-6 * (sum of flop on GPU over all processors)/(max GPU time over all processors)\n")); 17079566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " CpuToGpu Count: total number of CPU to GPU copies per processor\n")); 17089566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " CpuToGpu Size (Mbytes): 10e-6 * (total size of CPU to GPU copies per processor)\n")); 17099566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GpuToCpu Count: total number of GPU to CPU copies per processor\n")); 17109566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GpuToCpu Size (Mbytes): 10e-6 * (total size of GPU to CPU copies per processor)\n")); 17119566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GPU %%F: percent flops on GPU in this event\n")); 1712bec0b493Shannah_mairs #endif 17139566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n")); 17145c6c1daeSBarry Smith 17159566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm, fd)); 17165c6c1daeSBarry Smith 17175c6c1daeSBarry Smith /* Report events */ 17189566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Event Count Time (sec) Flop --- Global --- --- Stage ---- Total")); 171948a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, " Malloc EMalloc MMalloc RMI")); 1720d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17219566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GPU - CpuToGpu - - GpuToCpu - GPU")); 1722bec0b493Shannah_mairs #endif 17239566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 17249566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Max Ratio Max Ratio Max Ratio Mess AvgLen Reduct %%T %%F %%M %%L %%R %%T %%F %%M %%L %%R Mflop/s")); 172548a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, " Mbytes Mbytes Mbytes Mbytes")); 1726d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17279566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Mflop/s Count Size Count Size %%F")); 1728bec0b493Shannah_mairs #endif 17299566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 17309566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------")); 173148a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, "-----------------------------")); 1732d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17339566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "---------------------------------------")); 17344863603aSSatish Balay #endif 17359566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 17365c6c1daeSBarry Smith 1737156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1738156b51fbSBarry Smith /* this indirect way of accessing these values is needed when PETSc is build with multiple libraries since the symbols are not in libpetscsys */ 1739156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "TAOSolve", &TAO_Solve)); 1740156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "TSStep", &TS_Step)); 1741156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "SNESSolve", &SNES_Solve)); 1742156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "KSPSolve", &KSP_Solve)); 1743156b51fbSBarry Smith #endif 1744156b51fbSBarry Smith 17455c6c1daeSBarry Smith /* Problem: The stage name will not show up unless the stage executed on proc 1 */ 17465c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 17475c6c1daeSBarry Smith if (!stageVisible[stage]) continue; 1748820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 17495c6c1daeSBarry Smith if (localStageUsed[stage]) { 17509566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name)); 17519566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17529566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17539566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17549566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17559566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17565c6c1daeSBarry Smith } else { 17579566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage)); 17589566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17599566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17609566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17619566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17629566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17635c6c1daeSBarry Smith } 17649371c9d4SSatish Balay mess *= 0.5; 17659371c9d4SSatish Balay messLen *= 0.5; 17669371c9d4SSatish Balay red /= size; 17675c6c1daeSBarry Smith 17685c6c1daeSBarry Smith /* Get total number of events in this stage -- 17695c6c1daeSBarry Smith Currently, a single processor can register more events than another, but events must all be registered in order, 17705c6c1daeSBarry Smith just like stages. We can removed this requirement if necessary by having a global event numbering and indirection 1771217044c2SLisandro Dalcin on the event ID. This seems best accomplished by associating a communicator with each stage. 17725c6c1daeSBarry Smith 17735c6c1daeSBarry Smith Problem: If the event did not happen on proc 1, its name will not be available. 17745c6c1daeSBarry Smith Problem: Event visibility is not implemented 17755c6c1daeSBarry Smith */ 17765c6c1daeSBarry Smith if (localStageUsed[stage]) { 17775c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo; 17785c6c1daeSBarry Smith localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents; 1779a297a907SKarl Rupp } else localNumEvents = 0; 17809566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 17815c6c1daeSBarry Smith for (event = 0; event < numEvents; event++) { 1782820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 17835c6c1daeSBarry Smith if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) { 17849371c9d4SSatish Balay if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; 17859371c9d4SSatish Balay else flopr = 0.0; 17869566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 17879566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 17889566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17899566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 17909566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 17919566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17929566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17939566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17949566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17959566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].count, &minC, 1, MPI_INT, MPI_MIN, comm)); 17969566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].count, &maxC, 1, MPI_INT, MPI_MAX, comm)); 1797e3ed9ee7SBarry Smith if (PetscLogMemory) { 17989566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].memIncrease, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17999566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocSpace, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18009566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocIncrease, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18019566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1802e3ed9ee7SBarry Smith } 1803d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 18049566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].CpuToGpuCount, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18059566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuToCpuCount, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18069566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].CpuToGpuSize, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18079566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuToCpuSize, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18089566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuFlops, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18099566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuTime, &gmaxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 1810bec0b493Shannah_mairs #endif 18115c6c1daeSBarry Smith name = stageLog->eventLog->eventInfo[event].name; 18125c6c1daeSBarry Smith } else { 18135c6c1daeSBarry Smith flopr = 0.0; 18149566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18159566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18169566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18179566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18189566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18199566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18209566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18219566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18229566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18239566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&ierr, &minC, 1, MPI_INT, MPI_MIN, comm)); 18249566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&ierr, &maxC, 1, MPI_INT, MPI_MAX, comm)); 1825e3ed9ee7SBarry Smith if (PetscLogMemory) { 18269566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18279566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18289566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18299566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &emalmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1830e3ed9ee7SBarry Smith } 1831d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 18329566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18339566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18349566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18359566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18369566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18379566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gmaxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 1838bec0b493Shannah_mairs #endif 18395c6c1daeSBarry Smith name = ""; 18405c6c1daeSBarry Smith } 18415c6c1daeSBarry Smith if (mint < 0.0) { 1842d0609cedSBarry Smith PetscCall(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)); 18435c6c1daeSBarry Smith mint = 0; 18445c6c1daeSBarry Smith } 184508401ef6SPierre Jolivet PetscCheck(minf >= 0.0, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Minimum flop %g over all processors for %s is negative! Not possible!", minf, name); 1846156b51fbSBarry Smith /* Put NaN into the time for all events that may not be time accurately since they may happen asynchronously on the GPU */ 1847156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1848156b51fbSBarry Smith if (!PetscLogGpuTimeFlag && petsc_gflops > 0) { 1849156b51fbSBarry Smith memcpy(&gmaxt, &nas, sizeof(PetscLogDouble)); 1850156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, &eventid)); 1851156b51fbSBarry Smith if (eventid != SNES_Solve && eventid != KSP_Solve && eventid != TS_Step && eventid != TAO_Solve) { 1852156b51fbSBarry Smith memcpy(&mint, &nas, sizeof(PetscLogDouble)); 1853156b51fbSBarry Smith memcpy(&maxt, &nas, sizeof(PetscLogDouble)); 1854156b51fbSBarry Smith } 1855156b51fbSBarry Smith } 1856156b51fbSBarry Smith #endif 18579371c9d4SSatish Balay totm *= 0.5; 18589371c9d4SSatish Balay totml *= 0.5; 18599371c9d4SSatish Balay totr /= size; 18605c6c1daeSBarry Smith 1861217044c2SLisandro Dalcin if (maxC != 0) { 18629371c9d4SSatish Balay if (minC != 0) ratC = ((PetscLogDouble)maxC) / minC; 18639371c9d4SSatish Balay else ratC = 0.0; 18649371c9d4SSatish Balay if (mint != 0.0) ratt = maxt / mint; 18659371c9d4SSatish Balay else ratt = 0.0; 18669371c9d4SSatish Balay if (minf != 0.0) ratf = maxf / minf; 18679371c9d4SSatish Balay else ratf = 0.0; 18689371c9d4SSatish Balay if (TotalTime != 0.0) fracTime = tott / TotalTime; 18699371c9d4SSatish Balay else fracTime = 0.0; 18709371c9d4SSatish Balay if (TotalFlops != 0.0) fracFlops = totf / TotalFlops; 18719371c9d4SSatish Balay else fracFlops = 0.0; 18729371c9d4SSatish Balay if (stageTime != 0.0) fracStageTime = tott / stageTime; 18739371c9d4SSatish Balay else fracStageTime = 0.0; 18749371c9d4SSatish Balay if (flops != 0.0) fracStageFlops = totf / flops; 18759371c9d4SSatish Balay else fracStageFlops = 0.0; 18769371c9d4SSatish Balay if (numMessages != 0.0) fracMess = totm / numMessages; 18779371c9d4SSatish Balay else fracMess = 0.0; 18789371c9d4SSatish Balay if (messageLength != 0.0) fracMessLen = totml / messageLength; 18799371c9d4SSatish Balay else fracMessLen = 0.0; 18809371c9d4SSatish Balay if (numReductions != 0.0) fracRed = totr / numReductions; 18819371c9d4SSatish Balay else fracRed = 0.0; 18829371c9d4SSatish Balay if (mess != 0.0) fracStageMess = totm / mess; 18839371c9d4SSatish Balay else fracStageMess = 0.0; 18849371c9d4SSatish Balay if (messLen != 0.0) fracStageMessLen = totml / messLen; 18859371c9d4SSatish Balay else fracStageMessLen = 0.0; 18869371c9d4SSatish Balay if (red != 0.0) fracStageRed = totr / red; 18879371c9d4SSatish Balay else fracStageRed = 0.0; 18889371c9d4SSatish Balay if (totm != 0.0) totml /= totm; 18899371c9d4SSatish Balay else totml = 0.0; 18909371c9d4SSatish Balay if (maxt != 0.0) flopr = totf / maxt; 18919371c9d4SSatish Balay else flopr = 0.0; 18929566063dSJacob Faibussowitsch if (fracStageTime > 1.00) PetscCall(PetscFPrintf(comm, fd, "Warning -- total time of event greater than time of entire stage -- something is wrong with the timer\n")); 18939371c9d4SSatish Balay PetscCall(PetscFPrintf(comm, fd, "%-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", name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr, 100.0 * fracTime, 100.0 * fracFlops, 100.0 * fracMess, 100.0 * fracMessLen, 100.0 * fracRed, 100.0 * fracStageTime, 100.0 * fracStageFlops, 100.0 * fracStageMess, 100.0 * fracStageMessLen, 100.0 * fracStageRed, PetscAbs(flopr) / 1.0e6)); 189448a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, " %5.0f %5.0f %5.0f %5.0f", mal / 1.0e6, emalmax / 1.0e6, malmax / 1.0e6, mem / 1.0e6)); 1895d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 18969371c9d4SSatish Balay if (totf != 0.0) fracgflops = gflops / totf; 18979371c9d4SSatish Balay else fracgflops = 0.0; 18989371c9d4SSatish Balay if (gmaxt != 0.0) gflopr = gflops / gmaxt; 18999371c9d4SSatish Balay else gflopr = 0.0; 19009566063dSJacob Faibussowitsch PetscCall(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)); 1901bec0b493Shannah_mairs #endif 19029566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 19035c6c1daeSBarry Smith } 19045c6c1daeSBarry Smith } 19055c6c1daeSBarry Smith } 19065c6c1daeSBarry Smith 19075c6c1daeSBarry Smith /* Memory usage and object creation */ 19089566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------")); 190948a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, "-----------------------------")); 1910d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 19119566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "---------------------------------------")); 19124863603aSSatish Balay #endif 19139566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 19149566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 19155c6c1daeSBarry Smith 19165c6c1daeSBarry Smith /* Right now, only stages on the first processor are reported here, meaning only objects associated with 19175c6c1daeSBarry Smith the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then 19185c6c1daeSBarry Smith stats for stages local to processor sets. 19195c6c1daeSBarry Smith */ 19205c6c1daeSBarry Smith /* We should figure out the longest object name here (now 20 characters) */ 19214851f57dSBarry Smith PetscCall(PetscFPrintf(comm, fd, "Object Type Creations Destructions. Reports information only for process 0.\n")); 19225c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 19235c6c1daeSBarry Smith if (localStageUsed[stage]) { 19245c6c1daeSBarry Smith classInfo = stageLog->stageInfo[stage].classLog->classInfo; 19259566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name)); 19265c6c1daeSBarry Smith for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) { 19275c6c1daeSBarry Smith if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) { 19284851f57dSBarry Smith PetscCall(PetscFPrintf(comm, fd, "%20s %5d %5d\n", stageLog->classLog->classInfo[oclass].name, classInfo[oclass].creations, classInfo[oclass].destructions)); 19295c6c1daeSBarry Smith } 19305c6c1daeSBarry Smith } 19315c6c1daeSBarry Smith } else { 1932cf019ec6SStefano Zampini if (!localStageVisible[stage]) continue; 19339566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage)); 19345c6c1daeSBarry Smith } 19355c6c1daeSBarry Smith } 19365c6c1daeSBarry Smith 19379566063dSJacob Faibussowitsch PetscCall(PetscFree(localStageUsed)); 19389566063dSJacob Faibussowitsch PetscCall(PetscFree(stageUsed)); 19399566063dSJacob Faibussowitsch PetscCall(PetscFree(localStageVisible)); 19409566063dSJacob Faibussowitsch PetscCall(PetscFree(stageVisible)); 19415c6c1daeSBarry Smith 19425c6c1daeSBarry Smith /* Information unrelated to this particular run */ 19439566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "========================================================================================================================\n")); 19448563dfccSBarry Smith PetscTime(&y); 19458563dfccSBarry Smith PetscTime(&x); 19469371c9d4SSatish Balay PetscTime(&y); 19479371c9d4SSatish Balay PetscTime(&y); 19489371c9d4SSatish Balay PetscTime(&y); 19499371c9d4SSatish Balay PetscTime(&y); 19509371c9d4SSatish Balay PetscTime(&y); 19519371c9d4SSatish Balay PetscTime(&y); 19529371c9d4SSatish Balay PetscTime(&y); 19539371c9d4SSatish Balay PetscTime(&y); 19549371c9d4SSatish Balay PetscTime(&y); 19559371c9d4SSatish Balay PetscTime(&y); 19569566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Average time to get PetscTime(): %g\n", (y - x) / 10.0)); 19575c6c1daeSBarry Smith /* MPI information */ 19585c6c1daeSBarry Smith if (size > 1) { 19595c6c1daeSBarry Smith MPI_Status status; 19605c6c1daeSBarry Smith PetscMPIInt tag; 19615c6c1daeSBarry Smith MPI_Comm newcomm; 19625c6c1daeSBarry Smith 19639566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19648563dfccSBarry Smith PetscTime(&x); 19659566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19669566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19679566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19689566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19699566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19708563dfccSBarry Smith PetscTime(&y); 19719566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y - x) / 5.0)); 19729566063dSJacob Faibussowitsch PetscCall(PetscCommDuplicate(comm, &newcomm, &tag)); 19739566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19745c6c1daeSBarry Smith if (rank) { 19759566063dSJacob Faibussowitsch PetscCallMPI(MPI_Recv(NULL, 0, MPI_INT, rank - 1, tag, newcomm, &status)); 19769566063dSJacob Faibussowitsch PetscCallMPI(MPI_Send(NULL, 0, MPI_INT, (rank + 1) % size, tag, newcomm)); 19775c6c1daeSBarry Smith } else { 19788563dfccSBarry Smith PetscTime(&x); 19799566063dSJacob Faibussowitsch PetscCallMPI(MPI_Send(NULL, 0, MPI_INT, 1, tag, newcomm)); 19809566063dSJacob Faibussowitsch PetscCallMPI(MPI_Recv(NULL, 0, MPI_INT, size - 1, tag, newcomm, &status)); 19818563dfccSBarry Smith PetscTime(&y); 19829566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Average time for zero size MPI_Send(): %g\n", (y - x) / size)); 19835c6c1daeSBarry Smith } 19849566063dSJacob Faibussowitsch PetscCall(PetscCommDestroy(&newcomm)); 19855c6c1daeSBarry Smith } 19869566063dSJacob Faibussowitsch PetscCall(PetscOptionsView(NULL, viewer)); 19875c6c1daeSBarry Smith 19885c6c1daeSBarry Smith /* Machine and compile information */ 19895c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS) 19909566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n")); 19915c6c1daeSBarry Smith #else 19929566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n")); 19935c6c1daeSBarry Smith #endif 1994217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) 19959566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n")); 1996217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128) 19979566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n")); 1998217044c2SLisandro Dalcin #endif 19995c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 20009566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n")); 20015f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128) 20029566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n")); 20035c6c1daeSBarry Smith #endif 20045c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE) 20059566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with single precision matrices\n")); 20065c6c1daeSBarry Smith #else 20079566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n")); 20085c6c1daeSBarry Smith #endif 20099371c9d4SSatish Balay PetscCall(PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n", (int)sizeof(short), (int)sizeof(int), (int)sizeof(long), (int)sizeof(void *), (int)sizeof(PetscScalar), (int)sizeof(PetscInt))); 20105c6c1daeSBarry Smith 20119566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Configure options: %s", petscconfigureoptions)); 20129566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petscmachineinfo)); 20139566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsccompilerinfo)); 20149566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo)); 20159566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsclinkerinfo)); 20165c6c1daeSBarry Smith 20175c6c1daeSBarry Smith /* Cleanup */ 20189566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 20199566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnNoGpuAwareMpi(comm, fd)); 20209566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm, fd)); 2021156b51fbSBarry Smith PetscCall(PetscFPTrapPop()); 20225c6c1daeSBarry Smith PetscFunctionReturn(0); 20235c6c1daeSBarry Smith } 20245c6c1daeSBarry Smith 20257d6c928cSSatish Balay /*@C 20267d6c928cSSatish Balay PetscLogView - Prints a summary of the logging. 20275c6c1daeSBarry Smith 20285c6c1daeSBarry Smith Collective over MPI_Comm 20295c6c1daeSBarry Smith 20305c6c1daeSBarry Smith Input Parameter: 2031f14045dbSBarry Smith . viewer - an ASCII viewer 20325c6c1daeSBarry Smith 20335c6c1daeSBarry Smith Options Database Keys: 2034bb1d7374SBarry Smith + -log_view [:filename] - Prints summary of log information 2035bb1d7374SBarry Smith . -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file 2036607d249eSBarry 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) 2037d0a29bd7SConnor Ward . -log_view :filename.txt:ascii_flamegraph - Saves logging information in a format suitable for visualising as a Flame Graph (see below for how to view it) 2038156b51fbSBarry Smith . -log_view_memory - Also display memory usage in each event 2039156b51fbSBarry Smith . -log_view_gpu_time - Also display time in each event for GPU kernels (Note this may slow the computation) 2040*811af0c4SBarry Smith . -log_all - Saves a file Log.rank for each MPI rank with details of each step of the computation 2041bb1d7374SBarry Smith - -log_trace [filename] - Displays a trace of what each process is doing 20425c6c1daeSBarry Smith 20435c6c1daeSBarry Smith Notes: 2044bb1d7374SBarry Smith It is possible to control the logging programatically but we recommend using the options database approach whenever possible 20455c6c1daeSBarry Smith By default the summary is printed to stdout. 20465c6c1daeSBarry Smith 2047bb1d7374SBarry Smith Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin() 2048bb1d7374SBarry Smith 2049bb1d7374SBarry Smith If PETSc is configured with --with-logging=0 then this functionality is not available 2050bb1d7374SBarry Smith 2051607d249eSBarry Smith To view the nested XML format filename.xml first copy ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current 2052607d249eSBarry Smith directory then open filename.xml with your browser. Specific notes for certain browsers 2053607d249eSBarry Smith $ Firefox and Internet explorer - simply open the file 2054607d249eSBarry Smith $ Google Chrome - you must start up Chrome with the option --allow-file-access-from-files 2055a8d69d7bSBarry Smith $ Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access 2056607d249eSBarry 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 2057607d249eSBarry Smith your browser. 20582add09c0SLisandro Dalcin Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser 20592add09c0SLisandro Dalcin window and render the XML log file contents. 2060607d249eSBarry Smith 2061bb1d7374SBarry Smith The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij MARITIME RESEARCH INSTITUTE NETHERLANDS 2062bb1d7374SBarry Smith 2063d0a29bd7SConnor Ward The Flame Graph output can be visualised using either the original Flame Graph script (https://github.com/brendangregg/FlameGraph) 2064d0a29bd7SConnor Ward or using speedscope (https://www.speedscope.app). 2065d0a29bd7SConnor Ward Old XML profiles may be converted into this format using the script ${PETSC_DIR}/lib/petsc/bin/xml2flamegraph.py. 2066d0a29bd7SConnor Ward 20675c6c1daeSBarry Smith Level: beginner 20685c6c1daeSBarry Smith 2069db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogDump()` 20705c6c1daeSBarry Smith @*/ 20719371c9d4SSatish Balay PetscErrorCode PetscLogView(PetscViewer viewer) { 2072f14045dbSBarry Smith PetscBool isascii; 2073f14045dbSBarry Smith PetscViewerFormat format; 207437b78d16SBarry Smith int stage, lastStage; 207537b78d16SBarry Smith PetscStageLog stageLog; 20765c6c1daeSBarry Smith 20775c6c1daeSBarry Smith PetscFunctionBegin; 207828b400f6SJacob Faibussowitsch PetscCheck(PetscLogPLB, PETSC_COMM_SELF, PETSC_ERR_SUP, "Must use -log_view or PetscLogDefaultBegin() before calling this routine"); 207937b78d16SBarry Smith /* Pop off any stages the user forgot to remove */ 208037b78d16SBarry Smith lastStage = 0; 20819566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 20829566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 208337b78d16SBarry Smith while (stage >= 0) { 208437b78d16SBarry Smith lastStage = stage; 20859566063dSJacob Faibussowitsch PetscCall(PetscStageLogPop(stageLog)); 20869566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 208737b78d16SBarry Smith } 20889566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isascii)); 208928b400f6SJacob Faibussowitsch PetscCheck(isascii, PetscObjectComm((PetscObject)viewer), PETSC_ERR_SUP, "Currently can only view logging to ASCII"); 20909566063dSJacob Faibussowitsch PetscCall(PetscViewerGetFormat(viewer, &format)); 2091f14045dbSBarry Smith if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) { 20929566063dSJacob Faibussowitsch PetscCall(PetscLogView_Default(viewer)); 2093f14045dbSBarry Smith } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) { 20949566063dSJacob Faibussowitsch PetscCall(PetscLogView_Detailed(viewer)); 209538144912Sdeepblu2718 } else if (format == PETSC_VIEWER_ASCII_CSV) { 20969566063dSJacob Faibussowitsch PetscCall(PetscLogView_CSV(viewer)); 2097bb1d7374SBarry Smith } else if (format == PETSC_VIEWER_ASCII_XML) { 20989566063dSJacob Faibussowitsch PetscCall(PetscLogView_Nested(viewer)); 2099d0a29bd7SConnor Ward } else if (format == PETSC_VIEWER_ASCII_FLAMEGRAPH) { 21009566063dSJacob Faibussowitsch PetscCall(PetscLogView_Flamegraph(viewer)); 21015c6c1daeSBarry Smith } 21029566063dSJacob Faibussowitsch PetscCall(PetscStageLogPush(stageLog, lastStage)); 21035c6c1daeSBarry Smith PetscFunctionReturn(0); 21045c6c1daeSBarry Smith } 21055c6c1daeSBarry Smith 2106f14045dbSBarry Smith /*@C 2107*811af0c4SBarry Smith PetscLogViewFromOptions - Processes command line options to determine if/how a `PetscLog` is to be viewed. 2108f14045dbSBarry Smith 2109*811af0c4SBarry Smith Collective on `PETSC_COMM_WORLD` 2110f14045dbSBarry Smith 2111*811af0c4SBarry Smith Level: developer 2112f14045dbSBarry Smith 2113*811af0c4SBarry Smith .seealso: `PetscLogView()` 2114f14045dbSBarry Smith @*/ 21159371c9d4SSatish Balay PetscErrorCode PetscLogViewFromOptions(void) { 2116f14045dbSBarry Smith PetscViewer viewer; 2117f14045dbSBarry Smith PetscBool flg; 2118f14045dbSBarry Smith PetscViewerFormat format; 2119f14045dbSBarry Smith 2120f14045dbSBarry Smith PetscFunctionBegin; 21219566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetViewer(PETSC_COMM_WORLD, NULL, NULL, "-log_view", &viewer, &format, &flg)); 2122f14045dbSBarry Smith if (flg) { 21239566063dSJacob Faibussowitsch PetscCall(PetscViewerPushFormat(viewer, format)); 21249566063dSJacob Faibussowitsch PetscCall(PetscLogView(viewer)); 21259566063dSJacob Faibussowitsch PetscCall(PetscViewerPopFormat(viewer)); 21269566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&viewer)); 2127f14045dbSBarry Smith } 2128f14045dbSBarry Smith PetscFunctionReturn(0); 2129f14045dbSBarry Smith } 2130f14045dbSBarry Smith 21315c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/ 21325c6c1daeSBarry Smith /*@C 21335c6c1daeSBarry Smith PetscGetFlops - Returns the number of flops used on this processor 21345c6c1daeSBarry Smith since the program began. 21355c6c1daeSBarry Smith 21365c6c1daeSBarry Smith Not Collective 21375c6c1daeSBarry Smith 21385c6c1daeSBarry Smith Output Parameter: 21395c6c1daeSBarry Smith flops - number of floating point operations 21405c6c1daeSBarry Smith 21415c6c1daeSBarry Smith Notes: 21425c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 2143*811af0c4SBarry Smith `PetscLogFlops()` to increment this counter to include flops for the 21445c6c1daeSBarry Smith application code. 21455c6c1daeSBarry Smith 2146*811af0c4SBarry Smith A separate counter `PetscLogGPUFlops()` logs the flops that occur on any GPU associated with this MPI rank 2147*811af0c4SBarry Smith 21485c6c1daeSBarry Smith Level: intermediate 21495c6c1daeSBarry Smith 2150*811af0c4SBarry Smith .seealso: `PetscLogGPUFlops()`, `PetscTime()`, `PetscLogFlops()` 21515c6c1daeSBarry Smith @*/ 21529371c9d4SSatish Balay PetscErrorCode PetscGetFlops(PetscLogDouble *flops) { 21535c6c1daeSBarry Smith PetscFunctionBegin; 21545c6c1daeSBarry Smith *flops = petsc_TotalFlops; 21555c6c1daeSBarry Smith PetscFunctionReturn(0); 21565c6c1daeSBarry Smith } 21575c6c1daeSBarry Smith 21589371c9d4SSatish Balay PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) { 21595c6c1daeSBarry Smith size_t fullLength; 21605c6c1daeSBarry Smith va_list Argp; 21615c6c1daeSBarry Smith 21625c6c1daeSBarry Smith PetscFunctionBegin; 21635c6c1daeSBarry Smith if (!petsc_logObjects) PetscFunctionReturn(0); 21645c6c1daeSBarry Smith va_start(Argp, format); 21659566063dSJacob Faibussowitsch PetscCall(PetscVSNPrintf(petsc_objects[obj->id].info, 64, format, &fullLength, Argp)); 21665c6c1daeSBarry Smith va_end(Argp); 21675c6c1daeSBarry Smith PetscFunctionReturn(0); 21685c6c1daeSBarry Smith } 21695c6c1daeSBarry Smith 21705c6c1daeSBarry Smith /*MC 21715c6c1daeSBarry Smith PetscLogFlops - Adds floating point operations to the global counter. 21725c6c1daeSBarry Smith 21735c6c1daeSBarry Smith Synopsis: 2174aaa7dc30SBarry Smith #include <petsclog.h> 21755c6c1daeSBarry Smith PetscErrorCode PetscLogFlops(PetscLogDouble f) 21765c6c1daeSBarry Smith 21775c6c1daeSBarry Smith Not Collective 21785c6c1daeSBarry Smith 21795c6c1daeSBarry Smith Input Parameter: 21805c6c1daeSBarry Smith . f - flop counter 21815c6c1daeSBarry Smith 21825c6c1daeSBarry Smith Usage: 21835c6c1daeSBarry Smith .vb 21845c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 21855c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 21865c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 21875c6c1daeSBarry Smith [code segment to monitor] 21885c6c1daeSBarry Smith PetscLogFlops(user_flops) 21895c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 21905c6c1daeSBarry Smith .ve 21915c6c1daeSBarry Smith 2192*811af0c4SBarry Smith Note: 21935c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 21945c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 21955c6c1daeSBarry Smith application code. 21965c6c1daeSBarry Smith 21975c6c1daeSBarry Smith Level: intermediate 21985c6c1daeSBarry Smith 2199*811af0c4SBarry Smith .seealso: `PetscLogGPUFlops()`, `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscGetFlops()` 22005c6c1daeSBarry Smith M*/ 22015c6c1daeSBarry Smith 22025c6c1daeSBarry Smith /*MC 22035c6c1daeSBarry Smith PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice) 22045c6c1daeSBarry Smith to get accurate timings 22055c6c1daeSBarry Smith 22065c6c1daeSBarry Smith Synopsis: 2207aaa7dc30SBarry Smith #include <petsclog.h> 22085c6c1daeSBarry Smith void PetscPreLoadBegin(PetscBool flag,char *name); 22095c6c1daeSBarry Smith 22105c6c1daeSBarry Smith Not Collective 22115c6c1daeSBarry Smith 2212d8d19677SJose E. Roman Input Parameters: 2213*811af0c4SBarry Smith + flag - PETSC_TRUE to run twice, `PETSC_FALSE` to run once, may be overridden 22145c6c1daeSBarry Smith with command line option -preload true or -preload false 2215609bdbeeSBarry Smith - name - name of first stage (lines of code timed separately with -log_view) to 22165c6c1daeSBarry Smith be preloaded 22175c6c1daeSBarry Smith 22185c6c1daeSBarry Smith Usage: 22195c6c1daeSBarry Smith .vb 22205c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22215c6c1daeSBarry Smith lines of code 22225c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22235c6c1daeSBarry Smith lines of code 22245c6c1daeSBarry Smith PetscPreLoadEnd(); 22255c6c1daeSBarry Smith .ve 22265c6c1daeSBarry Smith 2227*811af0c4SBarry Smith Note: 222895452b02SPatrick Sanan Only works in C/C++, not Fortran 22295c6c1daeSBarry Smith 22305c6c1daeSBarry Smith Flags available within the macro. 22315c6c1daeSBarry Smith + PetscPreLoadingUsed - true if we are or have done preloading 22325c6c1daeSBarry Smith . PetscPreLoadingOn - true if it is CURRENTLY doing preload 22335c6c1daeSBarry Smith . PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second 22345c6c1daeSBarry Smith - PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on 22355c6c1daeSBarry Smith The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin() 22365c6c1daeSBarry Smith and PetscPreLoadEnd() 22375c6c1daeSBarry Smith 22385c6c1daeSBarry Smith Level: intermediate 22395c6c1daeSBarry Smith 2240db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 22415c6c1daeSBarry Smith M*/ 22425c6c1daeSBarry Smith 22435c6c1daeSBarry Smith /*MC 22445c6c1daeSBarry Smith PetscPreLoadEnd - End a segment of code that may be preloaded (run twice) 22455c6c1daeSBarry Smith to get accurate timings 22465c6c1daeSBarry Smith 22475c6c1daeSBarry Smith Synopsis: 2248aaa7dc30SBarry Smith #include <petsclog.h> 22495c6c1daeSBarry Smith void PetscPreLoadEnd(void); 22505c6c1daeSBarry Smith 22515c6c1daeSBarry Smith Not Collective 22525c6c1daeSBarry Smith 22535c6c1daeSBarry Smith Usage: 22545c6c1daeSBarry Smith .vb 22555c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22565c6c1daeSBarry Smith lines of code 22575c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22585c6c1daeSBarry Smith lines of code 22595c6c1daeSBarry Smith PetscPreLoadEnd(); 22605c6c1daeSBarry Smith .ve 22615c6c1daeSBarry Smith 2262*811af0c4SBarry Smith Note: 2263*811af0c4SBarry Smith Only works in C/C++ not fortran 22645c6c1daeSBarry Smith 22655c6c1daeSBarry Smith Level: intermediate 22665c6c1daeSBarry Smith 2267db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadStage()` 22685c6c1daeSBarry Smith M*/ 22695c6c1daeSBarry Smith 22705c6c1daeSBarry Smith /*MC 22715c6c1daeSBarry Smith PetscPreLoadStage - Start a new segment of code to be timed separately. 22725c6c1daeSBarry Smith to get accurate timings 22735c6c1daeSBarry Smith 22745c6c1daeSBarry Smith Synopsis: 2275aaa7dc30SBarry Smith #include <petsclog.h> 22765c6c1daeSBarry Smith void PetscPreLoadStage(char *name); 22775c6c1daeSBarry Smith 22785c6c1daeSBarry Smith Not Collective 22795c6c1daeSBarry Smith 22805c6c1daeSBarry Smith Usage: 22815c6c1daeSBarry Smith .vb 22825c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22835c6c1daeSBarry Smith lines of code 22845c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22855c6c1daeSBarry Smith lines of code 22865c6c1daeSBarry Smith PetscPreLoadEnd(); 22875c6c1daeSBarry Smith .ve 22885c6c1daeSBarry Smith 2289*811af0c4SBarry Smith Note: 2290*811af0c4SBarry Smith Only works in C/C++ not fortran 22915c6c1daeSBarry Smith 22925c6c1daeSBarry Smith Level: intermediate 22935c6c1daeSBarry Smith 2294db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()` 22955c6c1daeSBarry Smith M*/ 22965c6c1daeSBarry Smith 2297a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_DEVICE) 2298a4af0ceeSJacob Faibussowitsch #include <petsc/private/deviceimpl.h> 22999ffd0706SHong Zhang 2300156b51fbSBarry Smith PetscBool PetscLogGpuTimeFlag = PETSC_FALSE; 2301156b51fbSBarry Smith 2302156b51fbSBarry Smith /* 2303156b51fbSBarry Smith This cannot be called by users between PetscInitialize() and PetscFinalize() at any random location in the code 2304156b51fbSBarry Smith because it will result in timing results that cannot be interpreted. 2305156b51fbSBarry Smith */ 23069371c9d4SSatish Balay static PetscErrorCode PetscLogGpuTime_Off(void) { 2307156b51fbSBarry Smith PetscLogGpuTimeFlag = PETSC_FALSE; 2308156b51fbSBarry Smith return 0; 2309156b51fbSBarry Smith } 2310156b51fbSBarry Smith 2311156b51fbSBarry Smith /*@C 2312156b51fbSBarry Smith PetscLogGpuTime - turn on the logging of GPU time for GPU kernels 2313156b51fbSBarry Smith 2314*811af0c4SBarry Smith Options Database Key: 2315156b51fbSBarry Smith . -log_view_gpu_time - provide the GPU times in the -log_view output 2316156b51fbSBarry Smith 2317156b51fbSBarry Smith Notes: 2318*811af0c4SBarry Smith Turning on the timing of the 2319156b51fbSBarry Smith GPU kernels can slow down the entire computation and should only be used when studying the performance 2320156b51fbSBarry Smith of operations on GPU such as vector operations and matrix-vector operations. 2321156b51fbSBarry Smith 2322156b51fbSBarry Smith This routine should only be called once near the beginning of the program. Once it is started it cannot be turned off. 2323156b51fbSBarry Smith 23240f8f8846SPatrick Sanan Level: advanced 23250f8f8846SPatrick Sanan 2326db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuTimeBegin()` 2327156b51fbSBarry Smith @*/ 23289371c9d4SSatish Balay PetscErrorCode PetscLogGpuTime(void) { 2329156b51fbSBarry Smith if (!PetscLogGpuTimeFlag) PetscCall(PetscRegisterFinalize(PetscLogGpuTime_Off)); 2330156b51fbSBarry Smith PetscLogGpuTimeFlag = PETSC_TRUE; 2331156b51fbSBarry Smith return 0; 2332156b51fbSBarry Smith } 2333156b51fbSBarry Smith 23349ffd0706SHong Zhang /*@C 23359ffd0706SHong Zhang PetscLogGpuTimeBegin - Start timer for device 23369ffd0706SHong Zhang 23379ffd0706SHong Zhang Notes: 23389ffd0706SHong Zhang When CUDA or HIP is enabled, the timer is run on the GPU, it is a separate logging of time devoted to GPU computations (excluding kernel launch times). 2339*811af0c4SBarry Smith 23409ffd0706SHong Zhang When CUDA or HIP is not available, the timer is run on the CPU, it is a separate logging of time devoted to GPU computations (including kernel launch times). 2341*811af0c4SBarry Smith 2342*811af0c4SBarry Smith There is no need to call WaitForCUDA() or WaitForHIP() between `PetscLogGpuTimeBegin()` and `PetscLogGpuTimeEnd()` 2343*811af0c4SBarry Smith 23449ffd0706SHong Zhang This timer should NOT include times for data transfers between the GPU and CPU, nor setup actions such as allocating space. 2345*811af0c4SBarry Smith 23469ffd0706SHong Zhang The regular logging captures the time for data transfers and any CPU activites during the event 2347*811af0c4SBarry Smith 23489ffd0706SHong Zhang It is used to compute the flop rate on the GPU as it is actively engaged in running a kernel. 23499ffd0706SHong Zhang 23509ffd0706SHong Zhang Developer Notes: 2351*811af0c4SBarry Smith The GPU event timer captures the execution time of all the kernels launched in the default stream by the CPU between `PetscLogGpuTimeBegin()` and `PetsLogGpuTimeEnd()`. 2352*811af0c4SBarry Smith 2353*811af0c4SBarry Smith `PetscLogGpuTimeBegin()` and `PetsLogGpuTimeEnd()` insert the begin and end events into the default stream (stream 0). The device will record a time stamp for the 2354*811af0c4SBarry Smith event when it reaches that event in the stream. The function xxxEventSynchronize() is called in `PetsLogGpuTimeEnd()` to block CPU execution, 2355*811af0c4SBarry Smith but not continued GPU excution, until the timer event is recorded. 23569ffd0706SHong Zhang 23579ffd0706SHong Zhang Level: intermediate 23589ffd0706SHong Zhang 2359db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuTime()` 23609ffd0706SHong Zhang @*/ 23619371c9d4SSatish Balay PetscErrorCode PetscLogGpuTimeBegin(void) { 23629ffd0706SHong Zhang PetscFunctionBegin; 2363156b51fbSBarry Smith if (!PetscLogPLB || !PetscLogGpuTimeFlag) PetscFunctionReturn(0); 2364a4af0ceeSJacob Faibussowitsch if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) { 2365a4af0ceeSJacob Faibussowitsch PetscDeviceContext dctx; 2366a4af0ceeSJacob Faibussowitsch 23679566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextGetCurrentContext(&dctx)); 23689566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextBeginTimer_Internal(dctx)); 2369a4af0ceeSJacob Faibussowitsch } else { 23709566063dSJacob Faibussowitsch PetscCall(PetscTimeSubtract(&petsc_gtime)); 2371a4af0ceeSJacob Faibussowitsch } 23729ffd0706SHong Zhang PetscFunctionReturn(0); 23739ffd0706SHong Zhang } 23749ffd0706SHong Zhang 23759ffd0706SHong Zhang /*@C 23769ffd0706SHong Zhang PetscLogGpuTimeEnd - Stop timer for device 23779ffd0706SHong Zhang 23789ffd0706SHong Zhang Level: intermediate 23799ffd0706SHong Zhang 2380db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeBegin()` 23819ffd0706SHong Zhang @*/ 23829371c9d4SSatish Balay PetscErrorCode PetscLogGpuTimeEnd(void) { 23839ffd0706SHong Zhang PetscFunctionBegin; 2384156b51fbSBarry Smith if (!PetscLogPLE || !PetscLogGpuTimeFlag) PetscFunctionReturn(0); 2385a4af0ceeSJacob Faibussowitsch if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) { 2386a4af0ceeSJacob Faibussowitsch PetscDeviceContext dctx; 2387a4af0ceeSJacob Faibussowitsch PetscLogDouble elapsed; 2388a4af0ceeSJacob Faibussowitsch 23899566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextGetCurrentContext(&dctx)); 23909566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextEndTimer_Internal(dctx, &elapsed)); 2391a4af0ceeSJacob Faibussowitsch petsc_gtime += (elapsed / 1000.0); 2392a4af0ceeSJacob Faibussowitsch } else { 23939566063dSJacob Faibussowitsch PetscCall(PetscTimeAdd(&petsc_gtime)); 2394a4af0ceeSJacob Faibussowitsch } 23959ffd0706SHong Zhang PetscFunctionReturn(0); 23969ffd0706SHong Zhang } 23979ffd0706SHong Zhang #endif /* end of PETSC_HAVE_DEVICE */ 23989ffd0706SHong Zhang 23995c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */ 24005c6c1daeSBarry Smith 24019371c9d4SSatish Balay PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) { 24025c6c1daeSBarry Smith PetscFunctionBegin; 24035c6c1daeSBarry Smith PetscFunctionReturn(0); 24045c6c1daeSBarry Smith } 24055c6c1daeSBarry Smith 24065c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/ 24075c6c1daeSBarry Smith 24085c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 24095c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID = 0; 24105c6c1daeSBarry Smith 24115c6c1daeSBarry Smith /*@C 24125c6c1daeSBarry Smith PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code. 24135c6c1daeSBarry Smith 24145c6c1daeSBarry Smith Not Collective 24155c6c1daeSBarry Smith 24165c6c1daeSBarry Smith Input Parameter: 24175c6c1daeSBarry Smith . name - The class name 24185c6c1daeSBarry Smith 24195c6c1daeSBarry Smith Output Parameter: 24205c6c1daeSBarry Smith . oclass - The class id or classid 24215c6c1daeSBarry Smith 24225c6c1daeSBarry Smith Level: developer 24235c6c1daeSBarry Smith 2424*811af0c4SBarry Smith .seealso: `PetscLogEventRegister()` 24255c6c1daeSBarry Smith @*/ 24269371c9d4SSatish Balay PetscErrorCode PetscClassIdRegister(const char name[], PetscClassId *oclass) { 24275c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 24285c6c1daeSBarry Smith PetscStageLog stageLog; 24295c6c1daeSBarry Smith PetscInt stage; 24305c6c1daeSBarry Smith #endif 24315c6c1daeSBarry Smith 24325c6c1daeSBarry Smith PetscFunctionBegin; 24335c6c1daeSBarry Smith *oclass = ++PETSC_LARGEST_CLASSID; 24345c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 24359566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 24369566063dSJacob Faibussowitsch PetscCall(PetscClassRegLogRegister(stageLog->classLog, name, *oclass)); 243748a46eb9SPierre Jolivet for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses)); 24385c6c1daeSBarry Smith #endif 24395c6c1daeSBarry Smith PetscFunctionReturn(0); 24405c6c1daeSBarry Smith } 2441210b5426SBarry Smith 2442210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE) 2443210b5426SBarry Smith #include <mpe.h> 2444210b5426SBarry Smith 2445210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE; 2446210b5426SBarry Smith 2447495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject); 2448495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject); 2449495fc317SBarry Smith 2450210b5426SBarry Smith /*@C 2451210b5426SBarry Smith PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files 2452210b5426SBarry Smith and slows the program down. 2453210b5426SBarry Smith 2454*811af0c4SBarry Smith Collective over `PETSC_COMM_WORLD` 2455210b5426SBarry Smith 2456*811af0c4SBarry Smith Options Database Key: 2457a2553e36SBarry Smith . -log_mpe - Prints extensive log information 2458210b5426SBarry Smith 2459*811af0c4SBarry Smith Note: 2460*811af0c4SBarry Smith A related routine is `PetscLogDefaultBegin()` (with the options key -log_view), which is 2461210b5426SBarry Smith intended for production runs since it logs only flop rates and object 2462210b5426SBarry Smith creation (and should not significantly slow the programs). 2463210b5426SBarry Smith 2464210b5426SBarry Smith Level: advanced 2465210b5426SBarry Smith 2466db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogEventActivate()`, 2467db781477SPatrick Sanan `PetscLogEventDeactivate()` 2468210b5426SBarry Smith @*/ 24699371c9d4SSatish Balay PetscErrorCode PetscLogMPEBegin(void) { 2470210b5426SBarry Smith PetscFunctionBegin; 2471210b5426SBarry Smith /* Do MPE initialization */ 2472210b5426SBarry Smith if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */ 24739566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "Initializing MPE.\n")); 24749566063dSJacob Faibussowitsch PetscCall(MPE_Init_log()); 2475210b5426SBarry Smith 2476210b5426SBarry Smith PetscBeganMPE = PETSC_TRUE; 2477210b5426SBarry Smith } else { 24789566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "MPE already initialized. Not attempting to reinitialize.\n")); 2479210b5426SBarry Smith } 24809566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE)); 2481210b5426SBarry Smith PetscFunctionReturn(0); 2482210b5426SBarry Smith } 2483210b5426SBarry Smith 2484210b5426SBarry Smith /*@C 2485495fc317SBarry Smith PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot. 2486210b5426SBarry Smith 2487*811af0c4SBarry Smith Collective over `PETSC_COMM_WORLD` 2488210b5426SBarry Smith 2489210b5426SBarry Smith Level: advanced 2490210b5426SBarry Smith 2491db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogMPEBegin()` 2492210b5426SBarry Smith @*/ 24939371c9d4SSatish Balay PetscErrorCode PetscLogMPEDump(const char sname[]) { 2494210b5426SBarry Smith char name[PETSC_MAX_PATH_LEN]; 2495210b5426SBarry Smith 2496210b5426SBarry Smith PetscFunctionBegin; 2497210b5426SBarry Smith if (PetscBeganMPE) { 24989566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "Finalizing MPE.\n")); 2499210b5426SBarry Smith if (sname) { 25009566063dSJacob Faibussowitsch PetscCall(PetscStrcpy(name, sname)); 2501210b5426SBarry Smith } else { 25029566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(name, sizeof(name))); 2503210b5426SBarry Smith } 25049566063dSJacob Faibussowitsch PetscCall(MPE_Finish_log(name)); 2505210b5426SBarry Smith } else { 25069566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "Not finalizing MPE (not started by PETSc).\n")); 2507210b5426SBarry Smith } 2508210b5426SBarry Smith PetscFunctionReturn(0); 2509210b5426SBarry Smith } 2510210b5426SBarry Smith 2511210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39 25129371c9d4SSatish Balay static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = {"OliveDrab: ", "BlueViolet: ", "CadetBlue: ", "CornflowerBlue: ", "DarkGoldenrod: ", "DarkGreen: ", "DarkKhaki: ", "DarkOliveGreen: ", 25139371c9d4SSatish Balay "DarkOrange: ", "DarkOrchid: ", "DarkSeaGreen: ", "DarkSlateGray: ", "DarkTurquoise: ", "DeepPink: ", "DarkKhaki: ", "DimGray: ", 25149371c9d4SSatish Balay "DodgerBlue: ", "GreenYellow: ", "HotPink: ", "IndianRed: ", "LavenderBlush: ", "LawnGreen: ", "LemonChiffon: ", "LightCoral: ", 25159371c9d4SSatish Balay "LightCyan: ", "LightPink: ", "LightSalmon: ", "LightSlateGray: ", "LightYellow: ", "LimeGreen: ", "MediumPurple: ", "MediumSeaGreen: ", 25169371c9d4SSatish Balay "MediumSlateBlue:", "MidnightBlue: ", "MintCream: ", "MistyRose: ", "NavajoWhite: ", "NavyBlue: ", "OliveDrab: "}; 2517210b5426SBarry Smith 2518210b5426SBarry Smith /*@C 2519*811af0c4SBarry Smith PetscLogMPEGetRGBColor - This routine returns a rgb color useable with `PetscLogEventRegister()` 2520210b5426SBarry Smith 2521210b5426SBarry Smith Not collective. Maybe it should be? 2522210b5426SBarry Smith 25237a7aea1fSJed Brown Output Parameter: 2524210b5426SBarry Smith . str - character string representing the color 2525210b5426SBarry Smith 2526210b5426SBarry Smith Level: developer 2527210b5426SBarry Smith 2528*811af0c4SBarry Smith .seealso: `PetscLogEventRegister()` 2529210b5426SBarry Smith @*/ 25309371c9d4SSatish Balay PetscErrorCode PetscLogMPEGetRGBColor(const char *str[]) { 2531210b5426SBarry Smith static int idx = 0; 2532210b5426SBarry Smith 2533210b5426SBarry Smith PetscFunctionBegin; 2534210b5426SBarry Smith *str = PetscLogMPERGBColors[idx]; 2535210b5426SBarry Smith idx = (idx + 1) % PETSC_RGB_COLORS_MAX; 2536210b5426SBarry Smith PetscFunctionReturn(0); 2537210b5426SBarry Smith } 2538210b5426SBarry Smith 2539210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */ 2540