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 155c6c1daeSBarry Smith PetscLogEvent PETSC_LARGEST_EVENT = PETSC_EVENT; 165c6c1daeSBarry Smith 175c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 185c6c1daeSBarry Smith #include <petscmachineinfo.h> 195c6c1daeSBarry Smith #include <petscconfiginfo.h> 205c6c1daeSBarry Smith 215c6c1daeSBarry Smith /* used in the MPI_XXX() count macros in petsclog.h */ 225c6c1daeSBarry Smith 235c6c1daeSBarry Smith /* Action and object logging variables */ 240298fd71SBarry Smith Action *petsc_actions = NULL; 250298fd71SBarry Smith Object *petsc_objects = NULL; 265c6c1daeSBarry Smith PetscBool petsc_logActions = PETSC_FALSE; 275c6c1daeSBarry Smith PetscBool petsc_logObjects = PETSC_FALSE; 285c6c1daeSBarry Smith int petsc_numActions = 0, petsc_maxActions = 100; 295c6c1daeSBarry Smith int petsc_numObjects = 0, petsc_maxObjects = 100; 305c6c1daeSBarry Smith int petsc_numObjectsDestroyed = 0; 315c6c1daeSBarry Smith 325c6c1daeSBarry Smith /* Global counters */ 335c6c1daeSBarry Smith PetscLogDouble petsc_BaseTime = 0.0; 345c6c1daeSBarry Smith PetscLogDouble petsc_TotalFlops = 0.0; /* The number of flops */ 355c6c1daeSBarry Smith PetscLogDouble petsc_tmp_flops = 0.0; /* The incremental number of flops */ 365c6c1daeSBarry Smith PetscLogDouble petsc_send_ct = 0.0; /* The number of sends */ 375c6c1daeSBarry Smith PetscLogDouble petsc_recv_ct = 0.0; /* The number of receives */ 385c6c1daeSBarry Smith PetscLogDouble petsc_send_len = 0.0; /* The total length of all sent messages */ 395c6c1daeSBarry Smith PetscLogDouble petsc_recv_len = 0.0; /* The total length of all received messages */ 405c6c1daeSBarry Smith PetscLogDouble petsc_isend_ct = 0.0; /* The number of immediate sends */ 415c6c1daeSBarry Smith PetscLogDouble petsc_irecv_ct = 0.0; /* The number of immediate receives */ 425c6c1daeSBarry Smith PetscLogDouble petsc_isend_len = 0.0; /* The total length of all immediate send messages */ 435c6c1daeSBarry Smith PetscLogDouble petsc_irecv_len = 0.0; /* The total length of all immediate receive messages */ 445c6c1daeSBarry Smith PetscLogDouble petsc_wait_ct = 0.0; /* The number of waits */ 455c6c1daeSBarry Smith PetscLogDouble petsc_wait_any_ct = 0.0; /* The number of anywaits */ 465c6c1daeSBarry Smith PetscLogDouble petsc_wait_all_ct = 0.0; /* The number of waitalls */ 475c6c1daeSBarry Smith PetscLogDouble petsc_sum_of_waits_ct = 0.0; /* The total number of waits */ 485c6c1daeSBarry Smith PetscLogDouble petsc_allreduce_ct = 0.0; /* The number of reductions */ 495c6c1daeSBarry Smith PetscLogDouble petsc_gather_ct = 0.0; /* The number of gathers and gathervs */ 505c6c1daeSBarry Smith PetscLogDouble petsc_scatter_ct = 0.0; /* The number of scatters and scattervs */ 5120c24465SJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 52bec0b493Shannah_mairs PetscLogDouble petsc_ctog_ct = 0.0; /* The total number of CPU to GPU copies */ 53bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_ct = 0.0; /* The total number of GPU to CPU copies */ 54bec0b493Shannah_mairs PetscLogDouble petsc_ctog_sz = 0.0; /* The total size of CPU to GPU copies */ 55bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_sz = 0.0; /* The total size of GPU to CPU copies */ 5645c4b7c1SBarry Smith PetscLogDouble petsc_ctog_ct_scalar = 0.0; /* The total number of CPU to GPU copies */ 5745c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_ct_scalar = 0.0; /* The total number of GPU to CPU copies */ 5845c4b7c1SBarry Smith PetscLogDouble petsc_ctog_sz_scalar = 0.0; /* The total size of CPU to GPU copies */ 5945c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_sz_scalar = 0.0; /* The total size of GPU to CPU copies */ 60958c4211Shannah_mairs PetscLogDouble petsc_gflops = 0.0; /* The flops done on a GPU */ 61958c4211Shannah_mairs PetscLogDouble petsc_gtime = 0.0; /* The time spent on a GPU */ 62bec0b493Shannah_mairs #endif 635c6c1daeSBarry Smith 645c6c1daeSBarry Smith /* Logging functions */ 650298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL; 660298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL; 670298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 680298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 695c6c1daeSBarry Smith 705c6c1daeSBarry Smith /* Tracing event logging variables */ 710298fd71SBarry Smith FILE *petsc_tracefile = NULL; 725c6c1daeSBarry Smith int petsc_tracelevel = 0; 735c6c1daeSBarry Smith const char *petsc_traceblanks = " "; 745c6c1daeSBarry Smith char petsc_tracespace[128] = " "; 755c6c1daeSBarry Smith PetscLogDouble petsc_tracetime = 0.0; 76896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE; 775c6c1daeSBarry Smith 787a101e5eSJacob Faibussowitsch static PetscIntStack current_log_event_stack = NULL; 797a101e5eSJacob Faibussowitsch 80d71ae5a4SJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogInitialize(void) 81d71ae5a4SJacob Faibussowitsch { 82fa2bb9feSLisandro Dalcin int stage; 83fa2bb9feSLisandro Dalcin PetscBool opt; 845c6c1daeSBarry Smith 85fa2bb9feSLisandro Dalcin PetscFunctionBegin; 86fa2bb9feSLisandro Dalcin if (PetscLogInitializeCalled) PetscFunctionReturn(0); 87fa2bb9feSLisandro Dalcin PetscLogInitializeCalled = PETSC_TRUE; 885c6c1daeSBarry Smith 897a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackCreate(¤t_log_event_stack)); 909566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL, NULL, "-log_exclude_actions", &opt)); 91fa2bb9feSLisandro Dalcin if (opt) petsc_logActions = PETSC_FALSE; 929566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL, NULL, "-log_exclude_objects", &opt)); 93fa2bb9feSLisandro Dalcin if (opt) petsc_logObjects = PETSC_FALSE; 9448a46eb9SPierre Jolivet if (petsc_logActions) PetscCall(PetscMalloc1(petsc_maxActions, &petsc_actions)); 9548a46eb9SPierre Jolivet if (petsc_logObjects) PetscCall(PetscMalloc1(petsc_maxObjects, &petsc_objects)); 96fa2bb9feSLisandro Dalcin PetscLogPHC = PetscLogObjCreateDefault; 97fa2bb9feSLisandro Dalcin PetscLogPHD = PetscLogObjDestroyDefault; 98fa2bb9feSLisandro Dalcin /* Setup default logging structures */ 999566063dSJacob Faibussowitsch PetscCall(PetscStageLogCreate(&petsc_stageLog)); 1009566063dSJacob Faibussowitsch PetscCall(PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage)); 1015c6c1daeSBarry Smith 102fa2bb9feSLisandro Dalcin /* All processors sync here for more consistent logging */ 1039566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(PETSC_COMM_WORLD)); 104fa2bb9feSLisandro Dalcin PetscTime(&petsc_BaseTime); 1059566063dSJacob Faibussowitsch PetscCall(PetscLogStagePush(stage)); 106fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 107fa2bb9feSLisandro Dalcin } 1085c6c1daeSBarry Smith 109d71ae5a4SJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogFinalize(void) 110d71ae5a4SJacob Faibussowitsch { 1115c6c1daeSBarry Smith PetscStageLog stageLog; 1125c6c1daeSBarry Smith 1135c6c1daeSBarry Smith PetscFunctionBegin; 1149566063dSJacob Faibussowitsch PetscCall(PetscFree(petsc_actions)); 1159566063dSJacob Faibussowitsch PetscCall(PetscFree(petsc_objects)); 1169566063dSJacob Faibussowitsch PetscCall(PetscLogNestedEnd()); 1179566063dSJacob Faibussowitsch PetscCall(PetscLogSet(NULL, NULL)); 1185c6c1daeSBarry Smith 1195c6c1daeSBarry Smith /* Resetting phase */ 1209566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 1219566063dSJacob Faibussowitsch PetscCall(PetscStageLogDestroy(stageLog)); 1227a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackDestroy(current_log_event_stack)); 1237a101e5eSJacob Faibussowitsch current_log_event_stack = NULL; 124a297a907SKarl Rupp 1255c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1265c6c1daeSBarry Smith petsc_numActions = 0; 1275c6c1daeSBarry Smith petsc_numObjects = 0; 1285c6c1daeSBarry Smith petsc_numObjectsDestroyed = 0; 1295c6c1daeSBarry Smith petsc_maxActions = 100; 1305c6c1daeSBarry Smith petsc_maxObjects = 100; 1310298fd71SBarry Smith petsc_actions = NULL; 1320298fd71SBarry Smith petsc_objects = NULL; 1335c6c1daeSBarry Smith petsc_logActions = PETSC_FALSE; 1345c6c1daeSBarry Smith petsc_logObjects = PETSC_FALSE; 1355c6c1daeSBarry Smith petsc_BaseTime = 0.0; 1365c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1375c6c1daeSBarry Smith petsc_tmp_flops = 0.0; 1385c6c1daeSBarry Smith petsc_send_ct = 0.0; 1395c6c1daeSBarry Smith petsc_recv_ct = 0.0; 1405c6c1daeSBarry Smith petsc_send_len = 0.0; 1415c6c1daeSBarry Smith petsc_recv_len = 0.0; 1425c6c1daeSBarry Smith petsc_isend_ct = 0.0; 1435c6c1daeSBarry Smith petsc_irecv_ct = 0.0; 1445c6c1daeSBarry Smith petsc_isend_len = 0.0; 1455c6c1daeSBarry Smith petsc_irecv_len = 0.0; 1465c6c1daeSBarry Smith petsc_wait_ct = 0.0; 1475c6c1daeSBarry Smith petsc_wait_any_ct = 0.0; 1485c6c1daeSBarry Smith petsc_wait_all_ct = 0.0; 1495c6c1daeSBarry Smith petsc_sum_of_waits_ct = 0.0; 1505c6c1daeSBarry Smith petsc_allreduce_ct = 0.0; 1515c6c1daeSBarry Smith petsc_gather_ct = 0.0; 1525c6c1daeSBarry Smith petsc_scatter_ct = 0.0; 153d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 154bec0b493Shannah_mairs petsc_ctog_ct = 0.0; 155bec0b493Shannah_mairs petsc_gtoc_ct = 0.0; 156bec0b493Shannah_mairs petsc_ctog_sz = 0.0; 157bec0b493Shannah_mairs petsc_gtoc_sz = 0.0; 158958c4211Shannah_mairs petsc_gflops = 0.0; 159958c4211Shannah_mairs petsc_gtime = 0.0; 160bec0b493Shannah_mairs #endif 1615c6c1daeSBarry Smith PETSC_LARGEST_EVENT = PETSC_EVENT; 1620298fd71SBarry Smith PetscLogPHC = NULL; 1630298fd71SBarry Smith PetscLogPHD = NULL; 1640298fd71SBarry Smith petsc_tracefile = NULL; 1655c6c1daeSBarry Smith petsc_tracelevel = 0; 1665c6c1daeSBarry Smith petsc_traceblanks = " "; 1679371c9d4SSatish Balay petsc_tracespace[0] = ' '; 1689371c9d4SSatish Balay petsc_tracespace[1] = 0; 1695c6c1daeSBarry Smith petsc_tracetime = 0.0; 1705c6c1daeSBarry Smith PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 1715c6c1daeSBarry Smith PETSC_OBJECT_CLASSID = 0; 17202c9f0b5SLisandro Dalcin petsc_stageLog = NULL; 173896238b9SBarry Smith PetscLogInitializeCalled = PETSC_FALSE; 1745c6c1daeSBarry Smith PetscFunctionReturn(0); 1755c6c1daeSBarry Smith } 1765c6c1daeSBarry Smith 1775c6c1daeSBarry Smith /*@C 1785c6c1daeSBarry Smith PetscLogSet - Sets the logging functions called at the beginning and ending of every event. 1795c6c1daeSBarry Smith 1805c6c1daeSBarry Smith Not Collective 1815c6c1daeSBarry Smith 1825c6c1daeSBarry Smith Input Parameters: 1835c6c1daeSBarry Smith + b - The function called at beginning of event 1845c6c1daeSBarry Smith - e - The function called at end of event 1855c6c1daeSBarry Smith 1865c6c1daeSBarry Smith Level: developer 1875c6c1daeSBarry Smith 188811af0c4SBarry Smith Developer Note: 189811af0c4SBarry Smith The default loggers are `PetscLogEventBeginDefault()` and `PetscLogEventEndDefault()`. 190811af0c4SBarry Smith 191811af0c4SBarry Smith .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogTraceBegin()`, `PetscLogEventBeginDefault()`, `PetscLogEventEndDefault()` 1925c6c1daeSBarry Smith @*/ 193d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject)) 194d71ae5a4SJacob Faibussowitsch { 1955c6c1daeSBarry Smith PetscFunctionBegin; 1965c6c1daeSBarry Smith PetscLogPLB = b; 1975c6c1daeSBarry Smith PetscLogPLE = e; 1985c6c1daeSBarry Smith PetscFunctionReturn(0); 1995c6c1daeSBarry Smith } 2005c6c1daeSBarry Smith 2015c6c1daeSBarry Smith /*@C 2024dd65854SConnor Ward PetscLogIsActive - Check if logging is currently in progress. 2034dd65854SConnor Ward 2044dd65854SConnor Ward Not Collective 2054dd65854SConnor Ward 2064dd65854SConnor Ward Output Parameter: 207811af0c4SBarry Smith . isActive - `PETSC_TRUE` if logging is in progress, `PETSC_FALSE` otherwise 2084dd65854SConnor Ward 2094dd65854SConnor Ward Level: beginner 2104dd65854SConnor Ward 211db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogSet()` 2124dd65854SConnor Ward @*/ 213d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogIsActive(PetscBool *isActive) 214d71ae5a4SJacob Faibussowitsch { 2154dd65854SConnor Ward PetscFunctionBegin; 2164dd65854SConnor Ward *isActive = (PetscLogPLB && PetscLogPLE) ? PETSC_TRUE : PETSC_FALSE; 2174dd65854SConnor Ward PetscFunctionReturn(0); 2184dd65854SConnor Ward } 2194dd65854SConnor Ward 2204dd65854SConnor Ward /*@C 221811af0c4SBarry Smith PetscLogDefaultBegin - Turns on logging of objects and events using the default logging functions `PetscLogEventBeginDefault()` and `PetscLogEventEndDefault()`. This logs flop 2225c6c1daeSBarry Smith rates and object creation and should not slow programs down too much. 2235c6c1daeSBarry Smith This routine may be called more than once. 2245c6c1daeSBarry Smith 225811af0c4SBarry Smith Logically Collective over `PETSC_COMM_WORLD` 2265c6c1daeSBarry Smith 227811af0c4SBarry Smith Options Database Key: 228a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the 229a2553e36SBarry Smith screen (for code configured with --with-log=1 (which is the default)) 2305c6c1daeSBarry Smith 2315c6c1daeSBarry Smith Usage: 2325c6c1daeSBarry Smith .vb 2335c6c1daeSBarry Smith PetscInitialize(...); 234bb1d7374SBarry Smith PetscLogDefaultBegin(); 2355c6c1daeSBarry Smith ... code ... 2365c6c1daeSBarry Smith PetscLogView(viewer); or PetscLogDump(); 2375c6c1daeSBarry Smith PetscFinalize(); 2385c6c1daeSBarry Smith .ve 2395c6c1daeSBarry Smith 240811af0c4SBarry Smith Note: 241811af0c4SBarry Smith `PetscLogView()` or `PetscLogDump()` actually cause the printing of 2425c6c1daeSBarry Smith the logging information. 2435c6c1daeSBarry Smith 2445c6c1daeSBarry Smith Level: advanced 2455c6c1daeSBarry Smith 246db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogView()`, `PetscLogTraceBegin()` 2475c6c1daeSBarry Smith @*/ 248d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogDefaultBegin(void) 249d71ae5a4SJacob Faibussowitsch { 2505c6c1daeSBarry Smith PetscFunctionBegin; 2519566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault)); 2525c6c1daeSBarry Smith PetscFunctionReturn(0); 2535c6c1daeSBarry Smith } 2545c6c1daeSBarry Smith 2555c6c1daeSBarry Smith /*@C 2565c6c1daeSBarry Smith PetscLogAllBegin - Turns on extensive logging of objects and events. Logs 2575c6c1daeSBarry Smith all events. This creates large log files and slows the program down. 2585c6c1daeSBarry Smith 259811af0c4SBarry Smith Logically Collective on `PETSC_COMM_WORLD` 2605c6c1daeSBarry Smith 261811af0c4SBarry Smith Options Database Key: 262a2553e36SBarry Smith . -log_all - Prints extensive log information 2635c6c1daeSBarry Smith 2645c6c1daeSBarry Smith Usage: 2655c6c1daeSBarry Smith .vb 2665c6c1daeSBarry Smith PetscInitialize(...); 2675c6c1daeSBarry Smith PetscLogAllBegin(); 2685c6c1daeSBarry Smith ... code ... 2695c6c1daeSBarry Smith PetscLogDump(filename); 2705c6c1daeSBarry Smith PetscFinalize(); 2715c6c1daeSBarry Smith .ve 2725c6c1daeSBarry Smith 273811af0c4SBarry Smith Note: 274811af0c4SBarry Smith A related routine is `PetscLogDefaultBegin()` (with the options key -log_view), which is 2755c6c1daeSBarry Smith intended for production runs since it logs only flop rates and object 2765c6c1daeSBarry Smith creation (and shouldn't significantly slow the programs). 2775c6c1daeSBarry Smith 2785c6c1daeSBarry Smith Level: advanced 2795c6c1daeSBarry Smith 280db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogTraceBegin()` 2815c6c1daeSBarry Smith @*/ 282d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogAllBegin(void) 283d71ae5a4SJacob Faibussowitsch { 2845c6c1daeSBarry Smith PetscFunctionBegin; 2859566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete)); 2865c6c1daeSBarry Smith PetscFunctionReturn(0); 2875c6c1daeSBarry Smith } 2885c6c1daeSBarry Smith 289956f8c0dSBarry Smith /*@C 2905c6c1daeSBarry Smith PetscLogTraceBegin - Activates trace logging. Every time a PETSc event 2915c6c1daeSBarry Smith begins or ends, the event name is printed. 2925c6c1daeSBarry Smith 293811af0c4SBarry Smith Logically Collective on `PETSC_COMM_WORLD` 2945c6c1daeSBarry Smith 2955c6c1daeSBarry Smith Input Parameter: 2965c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout) 2975c6c1daeSBarry Smith 2985c6c1daeSBarry Smith Options Database Key: 299811af0c4SBarry Smith . -log_trace [filename] - Activates `PetscLogTraceBegin()` 3005c6c1daeSBarry Smith 3015c6c1daeSBarry Smith Notes: 302811af0c4SBarry Smith `PetscLogTraceBegin()` prints the processor number, the execution time (sec), 3035c6c1daeSBarry Smith then "Event begin:" or "Event end:" followed by the event name. 3045c6c1daeSBarry Smith 305811af0c4SBarry Smith `PetscLogTraceBegin()` allows tracing of all PETSc calls, which is useful 3065c6c1daeSBarry Smith to determine where a program is hanging without running in the 3075c6c1daeSBarry Smith debugger. Can be used in conjunction with the -info option. 3085c6c1daeSBarry Smith 3095c6c1daeSBarry Smith Level: intermediate 3105c6c1daeSBarry Smith 311db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogView()`, `PetscLogDefaultBegin()` 3125c6c1daeSBarry Smith @*/ 313d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogTraceBegin(FILE *file) 314d71ae5a4SJacob Faibussowitsch { 3155c6c1daeSBarry Smith PetscFunctionBegin; 3165c6c1daeSBarry Smith petsc_tracefile = file; 317a297a907SKarl Rupp 3189566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace)); 3195c6c1daeSBarry Smith PetscFunctionReturn(0); 3205c6c1daeSBarry Smith } 3215c6c1daeSBarry Smith 3225c6c1daeSBarry Smith /*@ 3235c6c1daeSBarry Smith PetscLogActions - Determines whether actions are logged for the graphical viewer. 3245c6c1daeSBarry Smith 3255c6c1daeSBarry Smith Not Collective 3265c6c1daeSBarry Smith 3275c6c1daeSBarry Smith Input Parameter: 328811af0c4SBarry Smith . flag - `PETSC_TRUE` if actions are to be logged 329811af0c4SBarry Smith 330811af0c4SBarry Smith Options Database Key: 331811af0c4SBarry Smith . -log_exclude_actions - Turns off actions logging 3325c6c1daeSBarry Smith 3335c6c1daeSBarry Smith Level: intermediate 3345c6c1daeSBarry Smith 335811af0c4SBarry Smith Note: 336811af0c4SBarry Smith Logging of actions continues to consume more memory as the program 3375c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 338db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()` 3395c6c1daeSBarry Smith @*/ 340d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogActions(PetscBool flag) 341d71ae5a4SJacob Faibussowitsch { 3425c6c1daeSBarry Smith PetscFunctionBegin; 3435c6c1daeSBarry Smith petsc_logActions = flag; 3445c6c1daeSBarry Smith PetscFunctionReturn(0); 3455c6c1daeSBarry Smith } 3465c6c1daeSBarry Smith 3475c6c1daeSBarry Smith /*@ 3485c6c1daeSBarry Smith PetscLogObjects - Determines whether objects are logged for the graphical viewer. 3495c6c1daeSBarry Smith 3505c6c1daeSBarry Smith Not Collective 3515c6c1daeSBarry Smith 3525c6c1daeSBarry Smith Input Parameter: 353811af0c4SBarry Smith . flag - `PETSC_TRUE` if objects are to be logged 354811af0c4SBarry Smith 355811af0c4SBarry Smith Options Database Key: 356811af0c4SBarry Smith . -log_exclude_objects - Turns off objects logging 3575c6c1daeSBarry Smith 3585c6c1daeSBarry Smith Level: intermediate 3595c6c1daeSBarry Smith 360811af0c4SBarry Smith Note: 361811af0c4SBarry Smith Logging of objects continues to consume more memory as the program 3625c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3635c6c1daeSBarry Smith 364db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()` 3655c6c1daeSBarry Smith @*/ 366d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogObjects(PetscBool flag) 367d71ae5a4SJacob Faibussowitsch { 3685c6c1daeSBarry Smith PetscFunctionBegin; 3695c6c1daeSBarry Smith petsc_logObjects = flag; 3705c6c1daeSBarry Smith PetscFunctionReturn(0); 3715c6c1daeSBarry Smith } 3725c6c1daeSBarry Smith 3735c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/ 3745c6c1daeSBarry Smith /*@C 37574c0405dSRichard Tran Mills PetscLogStageRegister - Attaches a character string name to a logging stage. 3765c6c1daeSBarry Smith 3775c6c1daeSBarry Smith Not Collective 3785c6c1daeSBarry Smith 3795c6c1daeSBarry Smith Input Parameter: 3805c6c1daeSBarry Smith . sname - The name to associate with that stage 3815c6c1daeSBarry Smith 3825c6c1daeSBarry Smith Output Parameter: 3835c6c1daeSBarry Smith . stage - The stage number 3845c6c1daeSBarry Smith 3855c6c1daeSBarry Smith Level: intermediate 3865c6c1daeSBarry Smith 387db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()` 3885c6c1daeSBarry Smith @*/ 389d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageRegister(const char sname[], PetscLogStage *stage) 390d71ae5a4SJacob Faibussowitsch { 3915c6c1daeSBarry Smith PetscStageLog stageLog; 3925c6c1daeSBarry Smith PetscLogEvent event; 3935c6c1daeSBarry Smith 3945c6c1daeSBarry Smith PetscFunctionBegin; 3959566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 3969566063dSJacob Faibussowitsch PetscCall(PetscStageLogRegister(stageLog, sname, stage)); 3975c6c1daeSBarry Smith /* Copy events already changed in the main stage, this sucks */ 3989566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents)); 39948a46eb9SPierre Jolivet for (event = 0; event < stageLog->eventLog->numEvents; event++) PetscCall(PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event], &stageLog->stageInfo[*stage].eventLog->eventInfo[event])); 4009566063dSJacob Faibussowitsch PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses)); 4015c6c1daeSBarry Smith PetscFunctionReturn(0); 4025c6c1daeSBarry Smith } 4035c6c1daeSBarry Smith 4045c6c1daeSBarry Smith /*@C 405811af0c4SBarry Smith PetscLogStagePush - This function pushes a stage on the logging stack. Events started and stopped until `PetscLogStagePop()` will be associated with the stage 4065c6c1daeSBarry Smith 4075c6c1daeSBarry Smith Not Collective 4085c6c1daeSBarry Smith 4095c6c1daeSBarry Smith Input Parameter: 4105c6c1daeSBarry Smith . stage - The stage on which to log 4115c6c1daeSBarry Smith 4125c6c1daeSBarry Smith Usage: 413811af0c4SBarry Smith If the option -log_view is used to run the program containing the 4145c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4155c6c1daeSBarry Smith PetscFinalize(). 4165c6c1daeSBarry Smith .vb 4175c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4185c6c1daeSBarry Smith [stage 0 of code] 4195c6c1daeSBarry Smith PetscLogStagePush(1); 4205c6c1daeSBarry Smith [stage 1 of code] 4215c6c1daeSBarry Smith PetscLogStagePop(); 4225c6c1daeSBarry Smith PetscBarrier(...); 4235c6c1daeSBarry Smith [more stage 0 of code] 4245c6c1daeSBarry Smith PetscFinalize(); 4255c6c1daeSBarry Smith .ve 4265c6c1daeSBarry Smith 427811af0c4SBarry Smith Note: 428811af0c4SBarry Smith Use `PetscLogStageRegister()` to register a stage. 4295c6c1daeSBarry Smith 4305c6c1daeSBarry Smith Level: intermediate 4315c6c1daeSBarry Smith 432db781477SPatrick Sanan .seealso: `PetscLogStagePop()`, `PetscLogStageRegister()`, `PetscBarrier()` 4335c6c1daeSBarry Smith @*/ 434d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStagePush(PetscLogStage stage) 435d71ae5a4SJacob Faibussowitsch { 4365c6c1daeSBarry Smith PetscStageLog stageLog; 4375c6c1daeSBarry Smith 4385c6c1daeSBarry Smith PetscFunctionBegin; 4399566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 4409566063dSJacob Faibussowitsch PetscCall(PetscStageLogPush(stageLog, stage)); 4415c6c1daeSBarry Smith PetscFunctionReturn(0); 4425c6c1daeSBarry Smith } 4435c6c1daeSBarry Smith 4445c6c1daeSBarry Smith /*@C 445811af0c4SBarry Smith PetscLogStagePop - This function pops a stage from the logging stack that was pushed with `PetscLogStagePush()` 4465c6c1daeSBarry Smith 4475c6c1daeSBarry Smith Not Collective 4485c6c1daeSBarry Smith 4495c6c1daeSBarry Smith Usage: 450811af0c4SBarry Smith If the option -log_view is used to run the program containing the 4515c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4525c6c1daeSBarry Smith PetscFinalize(). 4535c6c1daeSBarry Smith .vb 4545c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4555c6c1daeSBarry Smith [stage 0 of code] 4565c6c1daeSBarry Smith PetscLogStagePush(1); 4575c6c1daeSBarry Smith [stage 1 of code] 4585c6c1daeSBarry Smith PetscLogStagePop(); 4595c6c1daeSBarry Smith PetscBarrier(...); 4605c6c1daeSBarry Smith [more stage 0 of code] 4615c6c1daeSBarry Smith PetscFinalize(); 4625c6c1daeSBarry Smith .ve 4635c6c1daeSBarry Smith 4645c6c1daeSBarry Smith Level: intermediate 4655c6c1daeSBarry Smith 466db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStageRegister()`, `PetscBarrier()` 4675c6c1daeSBarry Smith @*/ 468d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStagePop(void) 469d71ae5a4SJacob Faibussowitsch { 4705c6c1daeSBarry Smith PetscStageLog stageLog; 4715c6c1daeSBarry Smith 4725c6c1daeSBarry Smith PetscFunctionBegin; 4739566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 4749566063dSJacob Faibussowitsch PetscCall(PetscStageLogPop(stageLog)); 4755c6c1daeSBarry Smith PetscFunctionReturn(0); 4765c6c1daeSBarry Smith } 4775c6c1daeSBarry Smith 4785c6c1daeSBarry Smith /*@ 479811af0c4SBarry Smith PetscLogStageSetActive - Sets if a stage is used for `PetscLogEventBegin()` and `PetscLogEventEnd()`. 4805c6c1daeSBarry Smith 4815c6c1daeSBarry Smith Not Collective 4825c6c1daeSBarry Smith 4835c6c1daeSBarry Smith Input Parameters: 4845c6c1daeSBarry Smith + stage - The stage 485811af0c4SBarry Smith - isActive - The activity flag, `PETSC_TRUE` for logging, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 4865c6c1daeSBarry Smith 4875c6c1daeSBarry Smith Level: intermediate 4885c6c1daeSBarry Smith 489811af0c4SBarry Smith Note: 490811af0c4SBarry Smith If this is set to `PETSC_FALSE` the logging acts as if the stage did not exist 491811af0c4SBarry Smith 492811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 4935c6c1daeSBarry Smith @*/ 494d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive) 495d71ae5a4SJacob Faibussowitsch { 4965c6c1daeSBarry Smith PetscStageLog stageLog; 4975c6c1daeSBarry Smith 4985c6c1daeSBarry Smith PetscFunctionBegin; 4999566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5009566063dSJacob Faibussowitsch PetscCall(PetscStageLogSetActive(stageLog, stage, isActive)); 5015c6c1daeSBarry Smith PetscFunctionReturn(0); 5025c6c1daeSBarry Smith } 5035c6c1daeSBarry Smith 5045c6c1daeSBarry Smith /*@ 505811af0c4SBarry Smith PetscLogStageGetActive - Checks if a stage is used for `PetscLogEventBegin()` and `PetscLogEventEnd()`. 5065c6c1daeSBarry Smith 5075c6c1daeSBarry Smith Not Collective 5085c6c1daeSBarry Smith 5095c6c1daeSBarry Smith Input Parameter: 5105c6c1daeSBarry Smith . stage - The stage 5115c6c1daeSBarry Smith 5125c6c1daeSBarry Smith Output Parameter: 513811af0c4SBarry Smith . isActive - The activity flag, `PETSC_TRUE` for logging, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 5145c6c1daeSBarry Smith 5155c6c1daeSBarry Smith Level: intermediate 5165c6c1daeSBarry Smith 517811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 5185c6c1daeSBarry Smith @*/ 519d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageGetActive(PetscLogStage stage, PetscBool *isActive) 520d71ae5a4SJacob Faibussowitsch { 5215c6c1daeSBarry Smith PetscStageLog stageLog; 5225c6c1daeSBarry Smith 5235c6c1daeSBarry Smith PetscFunctionBegin; 5249566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5259566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetActive(stageLog, stage, isActive)); 5265c6c1daeSBarry Smith PetscFunctionReturn(0); 5275c6c1daeSBarry Smith } 5285c6c1daeSBarry Smith 5295c6c1daeSBarry Smith /*@ 530811af0c4SBarry Smith PetscLogStageSetVisible - Determines stage visibility in `PetscLogView()` 5315c6c1daeSBarry Smith 5325c6c1daeSBarry Smith Not Collective 5335c6c1daeSBarry Smith 5345c6c1daeSBarry Smith Input Parameters: 5355c6c1daeSBarry Smith + stage - The stage 536811af0c4SBarry Smith - isVisible - The visibility flag, `PETSC_TRUE` to print, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 5375c6c1daeSBarry Smith 5385c6c1daeSBarry Smith Level: intermediate 5395c6c1daeSBarry Smith 540811af0c4SBarry Smith Developer Note: 541811af0c4SBarry Smith What does visible mean, needs to be documented. 542811af0c4SBarry Smith 543811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogView()` 5445c6c1daeSBarry Smith @*/ 545d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible) 546d71ae5a4SJacob Faibussowitsch { 5475c6c1daeSBarry Smith PetscStageLog stageLog; 5485c6c1daeSBarry Smith 5495c6c1daeSBarry Smith PetscFunctionBegin; 5509566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5519566063dSJacob Faibussowitsch PetscCall(PetscStageLogSetVisible(stageLog, stage, isVisible)); 5525c6c1daeSBarry Smith PetscFunctionReturn(0); 5535c6c1daeSBarry Smith } 5545c6c1daeSBarry Smith 5555c6c1daeSBarry Smith /*@ 556811af0c4SBarry Smith PetscLogStageGetVisible - Returns stage visibility in `PetscLogView()` 5575c6c1daeSBarry Smith 5585c6c1daeSBarry Smith Not Collective 5595c6c1daeSBarry Smith 5605c6c1daeSBarry Smith Input Parameter: 5615c6c1daeSBarry Smith . stage - The stage 5625c6c1daeSBarry Smith 5635c6c1daeSBarry Smith Output Parameter: 564811af0c4SBarry Smith . isVisible - The visibility flag, `PETSC_TRUE` to print, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 5655c6c1daeSBarry Smith 5665c6c1daeSBarry Smith Level: intermediate 5675c6c1daeSBarry Smith 568811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogView()` 5695c6c1daeSBarry Smith @*/ 570d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageGetVisible(PetscLogStage stage, PetscBool *isVisible) 571d71ae5a4SJacob Faibussowitsch { 5725c6c1daeSBarry Smith PetscStageLog stageLog; 5735c6c1daeSBarry Smith 5745c6c1daeSBarry Smith PetscFunctionBegin; 5759566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5769566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetVisible(stageLog, stage, isVisible)); 5775c6c1daeSBarry Smith PetscFunctionReturn(0); 5785c6c1daeSBarry Smith } 5795c6c1daeSBarry Smith 5805c6c1daeSBarry Smith /*@C 5815c6c1daeSBarry Smith PetscLogStageGetId - Returns the stage id when given the stage name. 5825c6c1daeSBarry Smith 5835c6c1daeSBarry Smith Not Collective 5845c6c1daeSBarry Smith 5855c6c1daeSBarry Smith Input Parameter: 5865c6c1daeSBarry Smith . name - The stage name 5875c6c1daeSBarry Smith 5885c6c1daeSBarry Smith Output Parameter: 5895a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists 5905c6c1daeSBarry Smith 5915c6c1daeSBarry Smith Level: intermediate 5925c6c1daeSBarry Smith 593811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 5945c6c1daeSBarry Smith @*/ 595d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageGetId(const char name[], PetscLogStage *stage) 596d71ae5a4SJacob Faibussowitsch { 5975c6c1daeSBarry Smith PetscStageLog stageLog; 5985c6c1daeSBarry Smith 5995c6c1daeSBarry Smith PetscFunctionBegin; 6009566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 6019566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetStage(stageLog, name, stage)); 6025c6c1daeSBarry Smith PetscFunctionReturn(0); 6035c6c1daeSBarry Smith } 6045c6c1daeSBarry Smith 6055c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/ 6067a101e5eSJacob Faibussowitsch 6075c6c1daeSBarry Smith /*@C 608811af0c4SBarry Smith PetscLogEventRegister - Registers an event name for logging operations 6095c6c1daeSBarry Smith 6105c6c1daeSBarry Smith Not Collective 6115c6c1daeSBarry Smith 612d8d19677SJose E. Roman Input Parameters: 6135c6c1daeSBarry Smith + name - The name associated with the event 6145c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with 615811af0c4SBarry Smith `PetscClassIdRegister()` or use a predefined one such as `KSP_CLASSID`, `SNES_CLASSID`, the predefined ones 6165c6c1daeSBarry Smith are only available in C code 6175c6c1daeSBarry Smith 6185c6c1daeSBarry Smith Output Parameter: 619811af0c4SBarry Smith . event - The event id for use with `PetscLogEventBegin()` and `PetscLogEventEnd()`. 6205c6c1daeSBarry Smith 6215c6c1daeSBarry Smith Example of Usage: 6225c6c1daeSBarry Smith .vb 6235c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 6245c6c1daeSBarry Smith PetscClassId classid; 6255c6c1daeSBarry Smith PetscLogDouble user_event_flops; 6265c6c1daeSBarry Smith PetscClassIdRegister("class name",&classid); 6275c6c1daeSBarry Smith PetscLogEventRegister("User event name",classid,&USER_EVENT); 6285c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 6295c6c1daeSBarry Smith [code segment to monitor] 6305c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 6315c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 6325c6c1daeSBarry Smith .ve 6335c6c1daeSBarry Smith 6345c6c1daeSBarry Smith Notes: 6355c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 636a2553e36SBarry Smith configured with --with-log (which is the default) and 637811af0c4SBarry Smith -log_view or -log_all is specified. `PetscLogEventRegister()` is 6385c6c1daeSBarry Smith intended for logging user events to supplement this PETSc 6395c6c1daeSBarry Smith information. 6405c6c1daeSBarry Smith 641495fc317SBarry Smith PETSc can gather data for use with the utilities Jumpshot 6425c6c1daeSBarry Smith (part of the MPICH distribution). If PETSc has been compiled 6435c6c1daeSBarry Smith with flag -DPETSC_HAVE_MPE (MPE is an additional utility within 6445c6c1daeSBarry Smith MPICH), the user can employ another command line option, -log_mpe, 6455c6c1daeSBarry Smith to create a logfile, "mpe.log", which can be visualized 646495fc317SBarry Smith Jumpshot. 6475c6c1daeSBarry Smith 6485c6c1daeSBarry Smith The classid is associated with each event so that classes of events 6495c6c1daeSBarry Smith can be disabled simultaneously, such as all matrix events. The user 650811af0c4SBarry Smith can either use an existing classid, such as `MAT_CLASSID`, or create 6515c6c1daeSBarry Smith their own as shown in the example. 6525c6c1daeSBarry Smith 653c5deb1d5SJed Brown If an existing event with the same name exists, its event handle is 654c5deb1d5SJed Brown returned instead of creating a new event. 655c5deb1d5SJed Brown 6565c6c1daeSBarry Smith Level: intermediate 6575c6c1daeSBarry Smith 658811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogFlops()`, 659db781477SPatrick Sanan `PetscLogEventActivate()`, `PetscLogEventDeactivate()`, `PetscClassIdRegister()` 6605c6c1daeSBarry Smith @*/ 661d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventRegister(const char name[], PetscClassId classid, PetscLogEvent *event) 662d71ae5a4SJacob Faibussowitsch { 6635c6c1daeSBarry Smith PetscStageLog stageLog; 6645c6c1daeSBarry Smith int stage; 6655c6c1daeSBarry Smith 6665c6c1daeSBarry Smith PetscFunctionBegin; 6675c6c1daeSBarry Smith *event = PETSC_DECIDE; 6689566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 6699566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, event)); 670c5deb1d5SJed Brown if (*event > 0) PetscFunctionReturn(0); 6719566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogRegister(stageLog->eventLog, name, classid, event)); 6725c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 6739566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents)); 6749566063dSJacob Faibussowitsch PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses)); 6755c6c1daeSBarry Smith } 6765c6c1daeSBarry Smith PetscFunctionReturn(0); 6775c6c1daeSBarry Smith } 6785c6c1daeSBarry Smith 6795c6c1daeSBarry Smith /*@ 680217044c2SLisandro Dalcin PetscLogEventSetCollective - Indicates that a particular event is collective. 681217044c2SLisandro Dalcin 682217044c2SLisandro Dalcin Not Collective 683217044c2SLisandro Dalcin 684d8d19677SJose E. Roman Input Parameters: 685217044c2SLisandro Dalcin + event - The event id 686217044c2SLisandro Dalcin - collective - Bolean flag indicating whether a particular event is collective 687217044c2SLisandro Dalcin 688811af0c4SBarry Smith Notes: 689811af0c4SBarry Smith New events returned from `PetscLogEventRegister()` are collective by default. 690811af0c4SBarry Smith 691811af0c4SBarry Smith Collective events are handled specially if the -log_sync is used. In that case the logging saves information about 692811af0c4SBarry Smith two parts of the event; the time for all the MPI ranks to synchronize and then the time for the actual computation/communication 693811af0c4SBarry Smith to be performed. This option is useful to debug imbalance within the computations or communications 694217044c2SLisandro Dalcin 695217044c2SLisandro Dalcin Level: developer 696217044c2SLisandro Dalcin 697811af0c4SBarry Smith .seealso: `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogEventRegister()` 698217044c2SLisandro Dalcin @*/ 699d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event, PetscBool collective) 700d71ae5a4SJacob Faibussowitsch { 701217044c2SLisandro Dalcin PetscStageLog stageLog; 702217044c2SLisandro Dalcin PetscEventRegLog eventRegLog; 703217044c2SLisandro Dalcin 704217044c2SLisandro Dalcin PetscFunctionBegin; 7059566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 7069566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetEventRegLog(stageLog, &eventRegLog)); 707cc73adaaSBarry Smith PetscCheck(event >= 0 && event <= eventRegLog->numEvents, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Invalid event id"); 708217044c2SLisandro Dalcin eventRegLog->eventInfo[event].collective = collective; 709217044c2SLisandro Dalcin PetscFunctionReturn(0); 710217044c2SLisandro Dalcin } 711217044c2SLisandro Dalcin 712217044c2SLisandro Dalcin /*@ 713fa2bb9feSLisandro Dalcin PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage. 714fa2bb9feSLisandro Dalcin 715fa2bb9feSLisandro Dalcin Not Collective 716fa2bb9feSLisandro Dalcin 717fa2bb9feSLisandro Dalcin Input Parameter: 718811af0c4SBarry Smith . classid - The object class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 719fa2bb9feSLisandro Dalcin 720fa2bb9feSLisandro Dalcin Level: developer 721fa2bb9feSLisandro Dalcin 722c2e3fba1SPatrick Sanan .seealso: `PetscLogEventActivateClass()`, `PetscLogEventDeactivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 723fa2bb9feSLisandro Dalcin @*/ 724d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventIncludeClass(PetscClassId classid) 725d71ae5a4SJacob Faibussowitsch { 726fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 727fa2bb9feSLisandro Dalcin int stage; 728fa2bb9feSLisandro Dalcin 729fa2bb9feSLisandro Dalcin PetscFunctionBegin; 7309566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 73148a46eb9SPierre Jolivet for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 732fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 733fa2bb9feSLisandro Dalcin } 734fa2bb9feSLisandro Dalcin 735fa2bb9feSLisandro Dalcin /*@ 736fa2bb9feSLisandro Dalcin PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage. 737fa2bb9feSLisandro Dalcin 738fa2bb9feSLisandro Dalcin Not Collective 739fa2bb9feSLisandro Dalcin 740fa2bb9feSLisandro Dalcin Input Parameter: 741811af0c4SBarry Smith . classid - The object class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 742fa2bb9feSLisandro Dalcin 743fa2bb9feSLisandro Dalcin Level: developer 744fa2bb9feSLisandro Dalcin 745811af0c4SBarry Smith Note: 746811af0c4SBarry Smith If a class is excluded then events associated with that class are not logged. 747811af0c4SBarry Smith 748c2e3fba1SPatrick Sanan .seealso: `PetscLogEventDeactivateClass()`, `PetscLogEventActivateClass()`, `PetscLogEventDeactivate()`, `PetscLogEventActivate()` 749fa2bb9feSLisandro Dalcin @*/ 750d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventExcludeClass(PetscClassId classid) 751d71ae5a4SJacob Faibussowitsch { 752fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 753fa2bb9feSLisandro Dalcin int stage; 754fa2bb9feSLisandro Dalcin 755fa2bb9feSLisandro Dalcin PetscFunctionBegin; 7569566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 75748a46eb9SPierre Jolivet for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 758fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 759fa2bb9feSLisandro Dalcin } 760fa2bb9feSLisandro Dalcin 761fa2bb9feSLisandro Dalcin /*@ 7625c6c1daeSBarry Smith PetscLogEventActivate - Indicates that a particular event should be logged. 7635c6c1daeSBarry Smith 7645c6c1daeSBarry Smith Not Collective 7655c6c1daeSBarry Smith 7665c6c1daeSBarry Smith Input Parameter: 7675c6c1daeSBarry Smith . event - The event id 7685c6c1daeSBarry Smith 7695c6c1daeSBarry Smith Usage: 7705c6c1daeSBarry Smith .vb 7715c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 7725c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 7735c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 7745c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 7755c6c1daeSBarry Smith .ve 7765c6c1daeSBarry Smith 7775c6c1daeSBarry Smith Note: 7785c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in include/petsclog.h) 779811af0c4SBarry Smith or an event number obtained with `PetscLogEventRegister()`. 7805c6c1daeSBarry Smith 7815c6c1daeSBarry Smith Level: advanced 7825c6c1daeSBarry Smith 783db781477SPatrick Sanan .seealso: `PlogEventDeactivate()`, `PlogEventDeactivatePush()`, `PetscLogEventDeactivatePop()` 7845c6c1daeSBarry Smith @*/ 785d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventActivate(PetscLogEvent event) 786d71ae5a4SJacob Faibussowitsch { 7875c6c1daeSBarry Smith PetscStageLog stageLog; 7885c6c1daeSBarry Smith int stage; 7895c6c1daeSBarry Smith 7905c6c1daeSBarry Smith PetscFunctionBegin; 7919566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 7929566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 7939566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event)); 7945c6c1daeSBarry Smith PetscFunctionReturn(0); 7955c6c1daeSBarry Smith } 7965c6c1daeSBarry Smith 7975c6c1daeSBarry Smith /*@ 7985c6c1daeSBarry Smith PetscLogEventDeactivate - Indicates that a particular event should not be logged. 7995c6c1daeSBarry Smith 8005c6c1daeSBarry Smith Not Collective 8015c6c1daeSBarry Smith 8025c6c1daeSBarry Smith Input Parameter: 8035c6c1daeSBarry Smith . event - The event id 8045c6c1daeSBarry Smith 8055c6c1daeSBarry Smith Usage: 8065c6c1daeSBarry Smith .vb 8075c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 8085c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 8095c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 8105c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 8115c6c1daeSBarry Smith .ve 8125c6c1daeSBarry Smith 8135c6c1daeSBarry Smith Note: 8145c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in 815811af0c4SBarry Smith include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`). 8165c6c1daeSBarry Smith 8175c6c1daeSBarry Smith Level: advanced 8185c6c1daeSBarry Smith 819db781477SPatrick Sanan .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePush()`, `PetscLogEventDeactivatePop()` 8205c6c1daeSBarry Smith @*/ 821d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivate(PetscLogEvent event) 822d71ae5a4SJacob Faibussowitsch { 8235c6c1daeSBarry Smith PetscStageLog stageLog; 8245c6c1daeSBarry Smith int stage; 8255c6c1daeSBarry Smith 8265c6c1daeSBarry Smith PetscFunctionBegin; 8279566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 8289566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 8299566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event)); 8305c6c1daeSBarry Smith PetscFunctionReturn(0); 8315c6c1daeSBarry Smith } 8325c6c1daeSBarry Smith 8335c6c1daeSBarry Smith /*@ 834811af0c4SBarry Smith PetscLogEventDeactivatePush - Indicates that a particular event should not be logged until `PetscLogEventDeactivatePop()` is called 835c00cb57fSBarry Smith 836c00cb57fSBarry Smith Not Collective 837c00cb57fSBarry Smith 838c00cb57fSBarry Smith Input Parameter: 839c00cb57fSBarry Smith . event - The event id 840c00cb57fSBarry Smith 841c00cb57fSBarry Smith Usage: 842c00cb57fSBarry Smith .vb 843c00cb57fSBarry Smith PetscLogEventDeactivatePush(VEC_SetValues); 844c00cb57fSBarry Smith [code where you do not want to log VecSetValues()] 845c00cb57fSBarry Smith PetscLogEventDeactivatePop(VEC_SetValues); 846c00cb57fSBarry Smith [code where you do want to log VecSetValues()] 847c00cb57fSBarry Smith .ve 848c00cb57fSBarry Smith 849c00cb57fSBarry Smith Note: 850c00cb57fSBarry Smith The event may be either a pre-defined PETSc event (found in 851811af0c4SBarry Smith include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`). 852c00cb57fSBarry Smith 853c00cb57fSBarry Smith Level: advanced 854c00cb57fSBarry Smith 855811af0c4SBarry Smith .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePop()`, `PetscLogEventDeactivate()` 856c00cb57fSBarry Smith @*/ 857d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivatePush(PetscLogEvent event) 858d71ae5a4SJacob Faibussowitsch { 859c00cb57fSBarry Smith PetscStageLog stageLog; 860c00cb57fSBarry Smith int stage; 861c00cb57fSBarry Smith 862c00cb57fSBarry Smith PetscFunctionBegin; 8639566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 8649566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 8659566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivatePush(stageLog->stageInfo[stage].eventLog, event)); 866c00cb57fSBarry Smith PetscFunctionReturn(0); 867c00cb57fSBarry Smith } 868c00cb57fSBarry Smith 869c00cb57fSBarry Smith /*@ 870811af0c4SBarry Smith PetscLogEventDeactivatePop - Indicates that a particular event should again be logged after the logging was turned off with `PetscLogEventDeactivatePush()` 871c00cb57fSBarry Smith 872c00cb57fSBarry Smith Not Collective 873c00cb57fSBarry Smith 874c00cb57fSBarry Smith Input Parameter: 875c00cb57fSBarry Smith . event - The event id 876c00cb57fSBarry Smith 877c00cb57fSBarry Smith Usage: 878c00cb57fSBarry Smith .vb 879c00cb57fSBarry Smith PetscLogEventDeactivatePush(VEC_SetValues); 880c00cb57fSBarry Smith [code where you do not want to log VecSetValues()] 881c00cb57fSBarry Smith PetscLogEventDeactivatePop(VEC_SetValues); 882c00cb57fSBarry Smith [code where you do want to log VecSetValues()] 883c00cb57fSBarry Smith .ve 884c00cb57fSBarry Smith 885c00cb57fSBarry Smith Note: 886c00cb57fSBarry Smith The event may be either a pre-defined PETSc event (found in 887811af0c4SBarry Smith include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`). 888c00cb57fSBarry Smith 889c00cb57fSBarry Smith Level: advanced 890c00cb57fSBarry Smith 891db781477SPatrick Sanan .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePush()` 892c00cb57fSBarry Smith @*/ 893d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivatePop(PetscLogEvent event) 894d71ae5a4SJacob Faibussowitsch { 895c00cb57fSBarry Smith PetscStageLog stageLog; 896c00cb57fSBarry Smith int stage; 897c00cb57fSBarry Smith 898c00cb57fSBarry Smith PetscFunctionBegin; 8999566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9009566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 9019566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivatePop(stageLog->stageInfo[stage].eventLog, event)); 902c00cb57fSBarry Smith PetscFunctionReturn(0); 903c00cb57fSBarry Smith } 904c00cb57fSBarry Smith 905c00cb57fSBarry Smith /*@ 906811af0c4SBarry Smith PetscLogEventSetActiveAll - Turns on logging of all events 9075c6c1daeSBarry Smith 9085c6c1daeSBarry Smith Not Collective 9095c6c1daeSBarry Smith 9105c6c1daeSBarry Smith Input Parameters: 9115c6c1daeSBarry Smith + event - The event id 9125c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged 9135c6c1daeSBarry Smith 9145c6c1daeSBarry Smith Level: advanced 9155c6c1daeSBarry Smith 916c2e3fba1SPatrick Sanan .seealso: `PlogEventActivate()`, `PlogEventDeactivate()` 9175c6c1daeSBarry Smith @*/ 918d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive) 919d71ae5a4SJacob Faibussowitsch { 9205c6c1daeSBarry Smith PetscStageLog stageLog; 9215c6c1daeSBarry Smith int stage; 9225c6c1daeSBarry Smith 9235c6c1daeSBarry Smith PetscFunctionBegin; 9249566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9255c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 9265c6c1daeSBarry Smith if (isActive) { 9279566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event)); 9285c6c1daeSBarry Smith } else { 9299566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event)); 9305c6c1daeSBarry Smith } 9315c6c1daeSBarry Smith } 9325c6c1daeSBarry Smith PetscFunctionReturn(0); 9335c6c1daeSBarry Smith } 9345c6c1daeSBarry Smith 9355c6c1daeSBarry Smith /*@ 936811af0c4SBarry Smith PetscLogEventActivateClass - Activates event logging for a PETSc object class for the current stage 9375c6c1daeSBarry Smith 9385c6c1daeSBarry Smith Not Collective 9395c6c1daeSBarry Smith 9405c6c1daeSBarry Smith Input Parameter: 941811af0c4SBarry Smith . classid - The event class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 9425c6c1daeSBarry Smith 9435c6c1daeSBarry Smith Level: developer 9445c6c1daeSBarry Smith 945811af0c4SBarry Smith .seealso: `PetscLogEventIncludeClass()`, `PetscLogEventExcludeClass()`, `PetscLogEventDeactivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 9465c6c1daeSBarry Smith @*/ 947d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventActivateClass(PetscClassId classid) 948d71ae5a4SJacob Faibussowitsch { 9495c6c1daeSBarry Smith PetscStageLog stageLog; 9505c6c1daeSBarry Smith int stage; 9515c6c1daeSBarry Smith 9525c6c1daeSBarry Smith PetscFunctionBegin; 9539566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9549566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 9559566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 9565c6c1daeSBarry Smith PetscFunctionReturn(0); 9575c6c1daeSBarry Smith } 9585c6c1daeSBarry Smith 9595c6c1daeSBarry Smith /*@ 960811af0c4SBarry Smith PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class for the current stage 9615c6c1daeSBarry Smith 9625c6c1daeSBarry Smith Not Collective 9635c6c1daeSBarry Smith 9645c6c1daeSBarry Smith Input Parameter: 965811af0c4SBarry Smith . classid - The event class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 9665c6c1daeSBarry Smith 9675c6c1daeSBarry Smith Level: developer 9685c6c1daeSBarry Smith 969811af0c4SBarry Smith .seealso: `PetscLogEventIncludeClass()`, `PetscLogEventExcludeClass()`,`PetscLogEventActivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 9705c6c1daeSBarry Smith @*/ 971d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivateClass(PetscClassId classid) 972d71ae5a4SJacob Faibussowitsch { 9735c6c1daeSBarry Smith PetscStageLog stageLog; 9745c6c1daeSBarry Smith int stage; 9755c6c1daeSBarry Smith 9765c6c1daeSBarry Smith PetscFunctionBegin; 9779566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9789566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 9799566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 9805c6c1daeSBarry Smith PetscFunctionReturn(0); 9815c6c1daeSBarry Smith } 9825c6c1daeSBarry Smith 9835c6c1daeSBarry Smith /*MC 98462872c28SLisandro Dalcin PetscLogEventSync - Synchronizes the beginning of a user event. 98562872c28SLisandro Dalcin 98662872c28SLisandro Dalcin Synopsis: 98762872c28SLisandro Dalcin #include <petsclog.h> 98862872c28SLisandro Dalcin PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm) 98962872c28SLisandro Dalcin 99062872c28SLisandro Dalcin Collective 99162872c28SLisandro Dalcin 99262872c28SLisandro Dalcin Input Parameters: 99362872c28SLisandro Dalcin + e - integer associated with the event obtained from PetscLogEventRegister() 99462872c28SLisandro Dalcin - comm - an MPI communicator 99562872c28SLisandro Dalcin 99662872c28SLisandro Dalcin Usage: 99762872c28SLisandro Dalcin .vb 99862872c28SLisandro Dalcin PetscLogEvent USER_EVENT; 99962872c28SLisandro Dalcin PetscLogEventRegister("User event",0,&USER_EVENT); 100062872c28SLisandro Dalcin PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD); 100162872c28SLisandro Dalcin PetscLogEventBegin(USER_EVENT,0,0,0,0); 100262872c28SLisandro Dalcin [code segment to monitor] 100362872c28SLisandro Dalcin PetscLogEventEnd(USER_EVENT,0,0,0,0); 100462872c28SLisandro Dalcin .ve 100562872c28SLisandro Dalcin 1006811af0c4SBarry Smith Note: 100762872c28SLisandro Dalcin This routine should be called only if there is not a 1008811af0c4SBarry Smith `PetscObject` available to pass to `PetscLogEventBegin()`. 100962872c28SLisandro Dalcin 101062872c28SLisandro Dalcin Level: developer 101162872c28SLisandro Dalcin 1012db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()` 101362872c28SLisandro Dalcin M*/ 101462872c28SLisandro Dalcin 101562872c28SLisandro Dalcin /*MC 10165c6c1daeSBarry Smith PetscLogEventBegin - Logs the beginning of a user event. 10175c6c1daeSBarry Smith 10185c6c1daeSBarry Smith Synopsis: 1019aaa7dc30SBarry Smith #include <petsclog.h> 1020f2ba6396SBarry Smith PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10215c6c1daeSBarry Smith 10225c6c1daeSBarry Smith Not Collective 10235c6c1daeSBarry Smith 10245c6c1daeSBarry Smith Input Parameters: 10255c6c1daeSBarry Smith + e - integer associated with the event obtained from PetscLogEventRegister() 10265c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10275c6c1daeSBarry Smith 10285c6c1daeSBarry Smith Fortran Synopsis: 10295c6c1daeSBarry Smith void PetscLogEventBegin(int e,PetscErrorCode ierr) 10305c6c1daeSBarry Smith 10315c6c1daeSBarry Smith Usage: 10325c6c1daeSBarry Smith .vb 10335c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 10345c6c1daeSBarry Smith PetscLogDouble user_event_flops; 10355c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 10365c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 10375c6c1daeSBarry Smith [code segment to monitor] 10385c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 10395c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 10405c6c1daeSBarry Smith .ve 10415c6c1daeSBarry Smith 1042811af0c4SBarry Smith Developer Note: 1043811af0c4SBarry Smith `PetscLogEventBegin()` and `PetscLogEventBegin()` return error codes instead of explicitly handling the 1044d0609cedSBarry Smith errors that occur in the macro directly because other packages that use this macros have used them in their 1045d0609cedSBarry Smith own functions or methods that do not return error codes and it would be disruptive to change the current 1046d0609cedSBarry Smith behavior. 1047d0609cedSBarry Smith 10485c6c1daeSBarry Smith Level: intermediate 10495c6c1daeSBarry Smith 1050db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventEnd()`, `PetscLogFlops()` 10515c6c1daeSBarry Smith M*/ 10525c6c1daeSBarry Smith 10535c6c1daeSBarry Smith /*MC 10545c6c1daeSBarry Smith PetscLogEventEnd - Log the end of a user event. 10555c6c1daeSBarry Smith 10565c6c1daeSBarry Smith Synopsis: 1057aaa7dc30SBarry Smith #include <petsclog.h> 1058f2ba6396SBarry Smith PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10595c6c1daeSBarry Smith 10605c6c1daeSBarry Smith Not Collective 10615c6c1daeSBarry Smith 10625c6c1daeSBarry Smith Input Parameters: 10635c6c1daeSBarry Smith + e - integer associated with the event obtained with PetscLogEventRegister() 10645c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10655c6c1daeSBarry Smith 10665c6c1daeSBarry Smith Fortran Synopsis: 10675c6c1daeSBarry Smith void PetscLogEventEnd(int e,PetscErrorCode ierr) 10685c6c1daeSBarry Smith 10695c6c1daeSBarry Smith Usage: 10705c6c1daeSBarry Smith .vb 10715c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 10725c6c1daeSBarry Smith PetscLogDouble user_event_flops; 10735c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT,); 10745c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 10755c6c1daeSBarry Smith [code segment to monitor] 10765c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 10775c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 10785c6c1daeSBarry Smith .ve 10795c6c1daeSBarry Smith 10805c6c1daeSBarry Smith Level: intermediate 10815c6c1daeSBarry Smith 1082db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogFlops()` 10835c6c1daeSBarry Smith M*/ 10845c6c1daeSBarry Smith 10855c6c1daeSBarry Smith /*@C 10865c6c1daeSBarry Smith PetscLogEventGetId - Returns the event id when given the event name. 10875c6c1daeSBarry Smith 10885c6c1daeSBarry Smith Not Collective 10895c6c1daeSBarry Smith 10905c6c1daeSBarry Smith Input Parameter: 10915c6c1daeSBarry Smith . name - The event name 10925c6c1daeSBarry Smith 10935c6c1daeSBarry Smith Output Parameter: 1094c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists 10955c6c1daeSBarry Smith 10965c6c1daeSBarry Smith Level: intermediate 10975c6c1daeSBarry Smith 1098db781477SPatrick Sanan .seealso: `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogStageGetId()` 10995c6c1daeSBarry Smith @*/ 1100d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventGetId(const char name[], PetscLogEvent *event) 1101d71ae5a4SJacob Faibussowitsch { 11025c6c1daeSBarry Smith PetscStageLog stageLog; 11035c6c1daeSBarry Smith 11045c6c1daeSBarry Smith PetscFunctionBegin; 11059566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 11069566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, event)); 11075c6c1daeSBarry Smith PetscFunctionReturn(0); 11085c6c1daeSBarry Smith } 11095c6c1daeSBarry Smith 1110d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogPushCurrentEvent_Internal(PetscLogEvent event) 1111d71ae5a4SJacob Faibussowitsch { 11127a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11137a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackPush(current_log_event_stack, event)); 11147a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11157a101e5eSJacob Faibussowitsch } 11167a101e5eSJacob Faibussowitsch 1117d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogPopCurrentEvent_Internal(void) 1118d71ae5a4SJacob Faibussowitsch { 11197a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11207a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackPop(current_log_event_stack, NULL)); 11217a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11227a101e5eSJacob Faibussowitsch } 11237a101e5eSJacob Faibussowitsch 1124d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGetCurrentEvent_Internal(PetscLogEvent *event) 1125d71ae5a4SJacob Faibussowitsch { 11267a101e5eSJacob Faibussowitsch PetscBool empty; 11277a101e5eSJacob Faibussowitsch 11287a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11297a101e5eSJacob Faibussowitsch PetscValidIntPointer(event, 1); 11307a101e5eSJacob Faibussowitsch *event = PETSC_DECIDE; 11317a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackEmpty(current_log_event_stack, &empty)); 11327a101e5eSJacob Faibussowitsch if (!empty) PetscCall(PetscIntStackTop(current_log_event_stack, event)); 11337a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11347a101e5eSJacob Faibussowitsch } 11357a101e5eSJacob Faibussowitsch 1136d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventPause_Internal(PetscLogEvent event) 1137d71ae5a4SJacob Faibussowitsch { 11387a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11397a101e5eSJacob Faibussowitsch if (event != PETSC_DECIDE) PetscCall(PetscLogEventEnd(event, NULL, NULL, NULL, NULL)); 11407a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11417a101e5eSJacob Faibussowitsch } 11427a101e5eSJacob Faibussowitsch 1143d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventResume_Internal(PetscLogEvent event) 1144d71ae5a4SJacob Faibussowitsch { 11457a101e5eSJacob Faibussowitsch PetscStageLog stageLog; 11467a101e5eSJacob Faibussowitsch PetscEventPerfLog eventLog; 11477a101e5eSJacob Faibussowitsch int stage; 11487a101e5eSJacob Faibussowitsch 11497a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11507a101e5eSJacob Faibussowitsch if (event == PETSC_DECIDE) PetscFunctionReturn(0); 11517a101e5eSJacob Faibussowitsch PetscCall(PetscLogEventBegin(event, NULL, NULL, NULL, NULL)); 11527a101e5eSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 11537a101e5eSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 11547a101e5eSJacob Faibussowitsch PetscCall(PetscStageLogGetEventPerfLog(stageLog, stage, &eventLog)); 11557a101e5eSJacob Faibussowitsch eventLog->eventInfo[event].count--; 11567a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11577a101e5eSJacob Faibussowitsch } 11587a101e5eSJacob Faibussowitsch 11595c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/ 11605c6c1daeSBarry Smith /*@C 11615c6c1daeSBarry Smith PetscLogDump - Dumps logs of objects to a file. This file is intended to 11625c6c1daeSBarry Smith be read by bin/petscview. This program no longer exists. 11635c6c1daeSBarry Smith 1164811af0c4SBarry Smith Collective on `PETSC_COMM_WORLD` 11655c6c1daeSBarry Smith 11665c6c1daeSBarry Smith Input Parameter: 11675c6c1daeSBarry Smith . name - an optional file name 11685c6c1daeSBarry Smith 11695c6c1daeSBarry Smith Usage: 11705c6c1daeSBarry Smith .vb 11715c6c1daeSBarry Smith PetscInitialize(...); 1172bb1d7374SBarry Smith PetscLogDefaultBegin(); or PetscLogAllBegin(); 11735c6c1daeSBarry Smith ... code ... 11745c6c1daeSBarry Smith PetscLogDump(filename); 11755c6c1daeSBarry Smith PetscFinalize(); 11765c6c1daeSBarry Smith .ve 11775c6c1daeSBarry Smith 1178811af0c4SBarry Smith Note: 11795c6c1daeSBarry Smith The default file name is 11805c6c1daeSBarry Smith $ Log.<rank> 11815c6c1daeSBarry Smith where <rank> is the processor number. If no name is specified, 11825c6c1daeSBarry Smith this file will be used. 11835c6c1daeSBarry Smith 11845c6c1daeSBarry Smith Level: advanced 11855c6c1daeSBarry Smith 1186db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogView()` 11875c6c1daeSBarry Smith @*/ 1188d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogDump(const char sname[]) 1189d71ae5a4SJacob Faibussowitsch { 11905c6c1daeSBarry Smith PetscStageLog stageLog; 11915c6c1daeSBarry Smith PetscEventPerfInfo *eventInfo; 11925c6c1daeSBarry Smith FILE *fd; 11935c6c1daeSBarry Smith char file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN]; 11945c6c1daeSBarry Smith PetscLogDouble flops, _TotalTime; 11955c6c1daeSBarry Smith PetscMPIInt rank; 11965c6c1daeSBarry Smith int action, object, curStage; 11975c6c1daeSBarry Smith PetscLogEvent event; 11985c6c1daeSBarry Smith 11995c6c1daeSBarry Smith PetscFunctionBegin; 12005c6c1daeSBarry Smith /* Calculate the total elapsed time */ 12018563dfccSBarry Smith PetscTime(&_TotalTime); 12025c6c1daeSBarry Smith _TotalTime -= petsc_BaseTime; 12035c6c1daeSBarry Smith /* Open log file */ 12049566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank)); 12057ff663adSLisandro Dalcin if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank); 1206a297a907SKarl Rupp else sprintf(file, "Log.%d", rank); 12079566063dSJacob Faibussowitsch PetscCall(PetscFixFilename(file, fname)); 12089566063dSJacob Faibussowitsch PetscCall(PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd)); 120908401ef6SPierre Jolivet PetscCheck(!(rank == 0) || !(!fd), PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname); 12105c6c1daeSBarry Smith /* Output totals */ 12119566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime)); 12129566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0)); 12135c6c1daeSBarry Smith /* Output actions */ 12145c6c1daeSBarry Smith if (petsc_logActions) { 12159566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions)); 12165c6c1daeSBarry Smith for (action = 0; action < petsc_numActions; action++) { 12179371c9d4SSatish 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, 1218d0609cedSBarry Smith petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem)); 12195c6c1daeSBarry Smith } 12205c6c1daeSBarry Smith } 12215c6c1daeSBarry Smith /* Output objects */ 12225c6c1daeSBarry Smith if (petsc_logObjects) { 12239566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed)); 12245c6c1daeSBarry Smith for (object = 0; object < petsc_numObjects; object++) { 12259566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int)petsc_objects[object].mem)); 12265c6c1daeSBarry Smith if (!petsc_objects[object].name[0]) { 12279566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "No Name\n")); 12285c6c1daeSBarry Smith } else { 12299566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name)); 12305c6c1daeSBarry Smith } 12315c6c1daeSBarry Smith if (petsc_objects[object].info[0] != 0) { 12329566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n")); 12335c6c1daeSBarry Smith } else { 12349566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info)); 12355c6c1daeSBarry Smith } 12365c6c1daeSBarry Smith } 12375c6c1daeSBarry Smith } 12385c6c1daeSBarry Smith /* Output events */ 12399566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n")); 12409566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 12419566063dSJacob Faibussowitsch PetscCall(PetscIntStackTop(stageLog->stack, &curStage)); 12425c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo; 12435c6c1daeSBarry Smith for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) { 1244a297a907SKarl Rupp if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops / eventInfo[event].time; 1245a297a907SKarl Rupp else flops = 0.0; 1246d0609cedSBarry Smith PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count, eventInfo[event].flops, eventInfo[event].time, flops)); 12475c6c1daeSBarry Smith } 12489566063dSJacob Faibussowitsch PetscCall(PetscFClose(PETSC_COMM_WORLD, fd)); 12495c6c1daeSBarry Smith PetscFunctionReturn(0); 12505c6c1daeSBarry Smith } 12515c6c1daeSBarry Smith 1252f14045dbSBarry Smith /* 1253f14045dbSBarry Smith PetscLogView_Detailed - Each process prints the times for its own events 1254f14045dbSBarry Smith 1255f14045dbSBarry Smith */ 1256d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView_Detailed(PetscViewer viewer) 1257d71ae5a4SJacob Faibussowitsch { 12582dff6485SMatthew G. Knepley PetscStageLog stageLog; 1259217044c2SLisandro Dalcin PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL; 1260217044c2SLisandro Dalcin PetscLogDouble locTotalTime, numRed, maxMem; 12612dff6485SMatthew G. Knepley int numStages, numEvents, stage, event; 1262217044c2SLisandro Dalcin MPI_Comm comm = PetscObjectComm((PetscObject)viewer); 12632dff6485SMatthew G. Knepley PetscMPIInt rank, size; 1264f14045dbSBarry Smith 1265f14045dbSBarry Smith PetscFunctionBegin; 12669566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 12679566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 12682dff6485SMatthew G. Knepley /* Must preserve reduction count before we go on */ 12692dff6485SMatthew G. Knepley numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 12702d1ec343SBarry Smith /* Get the total elapsed time */ 12719371c9d4SSatish Balay PetscTime(&locTotalTime); 12729371c9d4SSatish Balay locTotalTime -= petsc_BaseTime; 12739566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "size = %d\n", size)); 12749566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalTimes = {}\n")); 12759566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMessages = {}\n")); 12769566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMessageLens = {}\n")); 12779566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalReductions = {}\n")); 12789566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalFlop = {}\n")); 12799566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalObjects = {}\n")); 12809566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMemory = {}\n")); 12819566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 12829566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 12839566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Stages = {}\n")); 12842d1ec343SBarry Smith for (stage = 0; stage < numStages; stage++) { 12859566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"] = {}\n", stageLog->stageInfo[stage].name)); 12869566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"][\"summary\"] = {}\n", stageLog->stageInfo[stage].name)); 12879566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 128848a46eb9SPierre Jolivet for (event = 0; event < numEvents; event++) PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"][\"%s\"] = {}\n", stageLog->stageInfo[stage].name, stageLog->eventLog->eventInfo[event].name)); 12892d1ec343SBarry Smith } 12909566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&maxMem)); 12919566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushSynchronized(viewer)); 12929566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalTimes[%d] = %g\n", rank, locTotalTime)); 12939566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMessages[%d] = %g\n", rank, (petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct))); 12949566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMessageLens[%d] = %g\n", rank, (petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len))); 12959566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalReductions[%d] = %g\n", rank, numRed)); 12969566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalFlop[%d] = %g\n", rank, petsc_TotalFlops)); 12979566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalObjects[%d] = %d\n", rank, petsc_numObjects)); 12989566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMemory[%d] = %g\n", rank, maxMem)); 12999566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 13002d1ec343SBarry Smith for (stage = 0; stage < numStages; stage++) { 1301217044c2SLisandro Dalcin stageInfo = &stageLog->stageInfo[stage].perfInfo; 13029371c9d4SSatish 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, 13039371c9d4SSatish Balay stageInfo->numMessages, stageInfo->messageLength, stageInfo->numReductions, stageInfo->flops)); 13049566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 13052d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 1306217044c2SLisandro Dalcin eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 1307d0609cedSBarry Smith PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %d, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g", 13089371c9d4SSatish Balay stageLog->stageInfo[stage].name, stageLog->eventLog->eventInfo[event].name, rank, eventInfo->count, eventInfo->time, eventInfo->syncTime, eventInfo->numMessages, eventInfo->messageLength, eventInfo->numReductions, 13099371c9d4SSatish Balay eventInfo->flops)); 1310891e75beSMatthew G. Knepley if (eventInfo->dof[0] >= 0.) { 1311891e75beSMatthew G. Knepley PetscInt d, e; 13125d68e14cSMatthew G. Knepley 13139566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : [")); 1314891e75beSMatthew G. Knepley for (d = 0; d < 8; ++d) { 13159566063dSJacob Faibussowitsch if (d > 0) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", ")); 13169566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d])); 1317891e75beSMatthew G. Knepley } 13189566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "]")); 13199566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : [")); 13205d68e14cSMatthew G. Knepley for (e = 0; e < 8; ++e) { 13219566063dSJacob Faibussowitsch if (e > 0) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", ")); 13229566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e])); 13235d68e14cSMatthew G. Knepley } 13249566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "]")); 13255d68e14cSMatthew G. Knepley } 13269566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "}\n")); 13272d1ec343SBarry Smith } 13282d1ec343SBarry Smith } 13299566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 13309566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopSynchronized(viewer)); 1331f14045dbSBarry Smith PetscFunctionReturn(0); 1332f14045dbSBarry Smith } 1333f14045dbSBarry Smith 133438144912Sdeepblu2718 /* 133538144912Sdeepblu2718 PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format 133638144912Sdeepblu2718 */ 1337d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView_CSV(PetscViewer viewer) 1338d71ae5a4SJacob Faibussowitsch { 133938144912Sdeepblu2718 PetscStageLog stageLog; 1340669c5be0SSatish Balay PetscEventPerfInfo *eventInfo = NULL; 134138144912Sdeepblu2718 PetscLogDouble locTotalTime, maxMem; 134238144912Sdeepblu2718 int numStages, numEvents, stage, event; 134338144912Sdeepblu2718 MPI_Comm comm = PetscObjectComm((PetscObject)viewer); 134438144912Sdeepblu2718 PetscMPIInt rank, size; 134538144912Sdeepblu2718 134638144912Sdeepblu2718 PetscFunctionBegin; 13479566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 13489566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 134938144912Sdeepblu2718 /* Must preserve reduction count before we go on */ 135038144912Sdeepblu2718 /* Get the total elapsed time */ 13519371c9d4SSatish Balay PetscTime(&locTotalTime); 13529371c9d4SSatish Balay locTotalTime -= petsc_BaseTime; 13539566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 13549566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 13559566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&maxMem)); 13569566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushSynchronized(viewer)); 1357d0609cedSBarry 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)); 13589566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 135938144912Sdeepblu2718 for (stage = 0; stage < numStages; stage++) { 13609e29573dSMatthew G. Knepley PetscEventPerfInfo *stageInfo = &stageLog->stageInfo[stage].perfInfo; 13619e29573dSMatthew G. Knepley 13629371c9d4SSatish 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)); 13639566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 136438144912Sdeepblu2718 for (event = 0; event < numEvents; event++) { 136538144912Sdeepblu2718 eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 13669371c9d4SSatish 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, 13679371c9d4SSatish Balay eventInfo->numReductions, eventInfo->flops)); 136838144912Sdeepblu2718 if (eventInfo->dof[0] >= 0.) { 136938144912Sdeepblu2718 PetscInt d, e; 137038144912Sdeepblu2718 137148a46eb9SPierre Jolivet for (d = 0; d < 8; ++d) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d])); 137248a46eb9SPierre Jolivet for (e = 0; e < 8; ++e) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e])); 137338144912Sdeepblu2718 } 13749566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n")); 137538144912Sdeepblu2718 } 137638144912Sdeepblu2718 } 13779566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 13789566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopSynchronized(viewer)); 137938144912Sdeepblu2718 PetscFunctionReturn(0); 138038144912Sdeepblu2718 } 138138144912Sdeepblu2718 1382d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm, FILE *fd) 1383d71ae5a4SJacob Faibussowitsch { 1384217044c2SLisandro Dalcin PetscFunctionBegin; 1385217044c2SLisandro Dalcin if (!PetscLogSyncOn) PetscFunctionReturn(0); 13869566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 13879566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 13889566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 13899566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 13909566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 13919566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This program was run with logging synchronization. #\n")); 13929566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This option provides more meaningful imbalance #\n")); 13939566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # figures at the expense of slowing things down and #\n")); 13949566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # providing a distorted view of the overall runtime. #\n")); 13959566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 13969566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1397217044c2SLisandro Dalcin PetscFunctionReturn(0); 1398217044c2SLisandro Dalcin } 1399217044c2SLisandro Dalcin 1400d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm, FILE *fd) 1401d71ae5a4SJacob Faibussowitsch { 1402f4091ad2SBarry Smith PetscFunctionBegin; 140376bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 14049566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 14059566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 14069566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14079566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 14089566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14099566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This code was compiled with a debugging option. #\n")); 14109566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # To get timing results run ./configure #\n")); 14119566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # using --with-debugging=no, the performance will #\n")); 14129566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # be generally two or three times faster. #\n")); 14139566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14149566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 141576bd3646SJed Brown } 1416f4091ad2SBarry Smith PetscFunctionReturn(0); 1417f4091ad2SBarry Smith } 1418f4091ad2SBarry Smith 1419d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnNoGpuAwareMpi(MPI_Comm comm, FILE *fd) 1420d71ae5a4SJacob Faibussowitsch { 1421009ab46cSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1422009ab46cSJunchao Zhang PetscMPIInt size; 1423c2a741eeSJunchao Zhang 1424c2a741eeSJunchao Zhang PetscFunctionBegin; 14259566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 1426340fe3cdSSatish Balay if (use_gpu_aware_mpi || size == 1) PetscFunctionReturn(0); 14279566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 14289566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 14299566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14309566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 14319566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14329566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This code was compiled with GPU support and you've #\n")); 14339566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # created PETSc/GPU objects, but you intentionally #\n")); 14349566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # used -use_gpu_aware_mpi 0, requiring PETSc to copy #\n")); 14359566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # additional data between the GPU and CPU. To obtain #\n")); 14369566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # meaningful timing results on multi-rank runs, use #\n")); 14379566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # GPU-aware MPI instead. #\n")); 14389566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14399566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1440c2a741eeSJunchao Zhang PetscFunctionReturn(0); 1441c2a741eeSJunchao Zhang #else 1442c2a741eeSJunchao Zhang return 0; 1443c2a741eeSJunchao Zhang #endif 1444c2a741eeSJunchao Zhang } 1445c2a741eeSJunchao Zhang 1446d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnGpuTime(MPI_Comm comm, FILE *fd) 1447d71ae5a4SJacob Faibussowitsch { 1448156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1449156b51fbSBarry Smith 1450156b51fbSBarry Smith PetscFunctionBegin; 1451156b51fbSBarry Smith if (!PetscLogGpuTimeFlag || petsc_gflops == 0) PetscFunctionReturn(0); 1452156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, "\n\n")); 1453156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 1454156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1455156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 1456156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1457156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # This code was run with -log_view_gpu_time #\n")); 1458156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # This provides accurate timing within the GPU kernels #\n")); 1459156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # but can slow down the entire computation by a #\n")); 1460156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # measurable amount. For fastest runs we recommend #\n")); 1461156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # not using this option. #\n")); 1462156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1463156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1464156b51fbSBarry Smith PetscFunctionReturn(0); 1465156b51fbSBarry Smith #else 1466156b51fbSBarry Smith return 0; 1467156b51fbSBarry Smith #endif 1468156b51fbSBarry Smith } 1469156b51fbSBarry Smith 1470d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView_Default(PetscViewer viewer) 1471d71ae5a4SJacob Faibussowitsch { 14725c6c1daeSBarry Smith FILE *fd; 14735c6c1daeSBarry Smith PetscLogDouble zero = 0.0; 14745c6c1daeSBarry Smith PetscStageLog stageLog; 14750298fd71SBarry Smith PetscStageInfo *stageInfo = NULL; 14760298fd71SBarry Smith PetscEventPerfInfo *eventInfo = NULL; 14775c6c1daeSBarry Smith PetscClassPerfInfo *classInfo; 14785c6c1daeSBarry Smith char arch[128], hostname[128], username[128], pname[PETSC_MAX_PATH_LEN], date[128]; 14795c6c1daeSBarry Smith const char *name; 14805c6c1daeSBarry Smith PetscLogDouble locTotalTime, TotalTime, TotalFlops; 14815c6c1daeSBarry Smith PetscLogDouble numMessages, messageLength, avgMessLen, numReductions; 14825c6c1daeSBarry Smith PetscLogDouble stageTime, flops, flopr, mem, mess, messLen, red; 14835c6c1daeSBarry Smith PetscLogDouble fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed; 14845c6c1daeSBarry Smith PetscLogDouble fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed; 14855c6c1daeSBarry Smith PetscLogDouble min, max, tot, ratio, avg, x, y; 1486e3ed9ee7SBarry Smith PetscLogDouble minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr, mal, malmax, emalmax; 1487d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1488156b51fbSBarry Smith PetscLogEvent KSP_Solve, SNES_Solve, TS_Step, TAO_Solve; /* These need to be fixed to be some events registered with certain objects */ 1489958c4211Shannah_mairs PetscLogDouble cct, gct, csz, gsz, gmaxt, gflops, gflopr, fracgflops; 1490bec0b493Shannah_mairs #endif 1491217044c2SLisandro Dalcin PetscMPIInt minC, maxC; 14925c6c1daeSBarry Smith PetscMPIInt size, rank; 14935c6c1daeSBarry Smith PetscBool *localStageUsed, *stageUsed; 14945c6c1daeSBarry Smith PetscBool *localStageVisible, *stageVisible; 14955c6c1daeSBarry Smith int numStages, localNumEvents, numEvents; 149637b78d16SBarry Smith int stage, oclass; 14975c6c1daeSBarry Smith PetscLogEvent event; 1498d0609cedSBarry Smith PetscErrorCode ierr = 0; 14995c6c1daeSBarry Smith char version[256]; 15005c6c1daeSBarry Smith MPI_Comm comm; 1501156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1502156b51fbSBarry Smith PetscLogEvent eventid; 1503156b51fbSBarry Smith PetscInt64 nas = 0x7FF0000000000002; 1504156b51fbSBarry Smith #endif 15055c6c1daeSBarry Smith 15065c6c1daeSBarry Smith PetscFunctionBegin; 1507156b51fbSBarry Smith PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF)); 15089566063dSJacob Faibussowitsch PetscCall(PetscObjectGetComm((PetscObject)viewer, &comm)); 15099566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIGetPointer(viewer, &fd)); 15109566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 15119566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 15125c6c1daeSBarry Smith /* Get the total elapsed time */ 15139371c9d4SSatish Balay PetscTime(&locTotalTime); 15149371c9d4SSatish Balay locTotalTime -= petsc_BaseTime; 15155c6c1daeSBarry Smith 1516faad7b01SPierre Jolivet PetscCall(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n")); 15179566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "*** WIDEN YOUR WINDOW TO 160 CHARACTERS. Use 'enscript -r -fCourier9' to print this document ***\n")); 15189566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n")); 1519faad7b01SPierre Jolivet PetscCall(PetscFPrintf(comm, fd, "\n------------------------------------------------------------------ PETSc Performance Summary: ------------------------------------------------------------------\n\n")); 15209566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnSync(comm, fd)); 15219566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm, fd)); 15229566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnNoGpuAwareMpi(comm, fd)); 1523156b51fbSBarry Smith PetscCall(PetscLogViewWarnGpuTime(comm, fd)); 15249566063dSJacob Faibussowitsch PetscCall(PetscGetArchType(arch, sizeof(arch))); 15259566063dSJacob Faibussowitsch PetscCall(PetscGetHostName(hostname, sizeof(hostname))); 15269566063dSJacob Faibussowitsch PetscCall(PetscGetUserName(username, sizeof(username))); 15279566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(pname, sizeof(pname))); 15289566063dSJacob Faibussowitsch PetscCall(PetscGetDate(date, sizeof(date))); 15299566063dSJacob Faibussowitsch PetscCall(PetscGetVersion(version, sizeof(version))); 15305c6c1daeSBarry Smith if (size == 1) { 15319566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s on a %s named %s with %d processor, by %s %s\n", pname, arch, hostname, size, username, date)); 15325c6c1daeSBarry Smith } else { 15339566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s on a %s named %s with %d processors, by %s %s\n", pname, arch, hostname, size, username, date)); 15345c6c1daeSBarry Smith } 1535f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP) 15369566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Using %" PetscInt_FMT " OpenMP threads\n", PetscNumOMPThreads)); 1537f90b075cSBarry Smith #endif 15389566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Using %s\n", version)); 15395c6c1daeSBarry Smith 15405c6c1daeSBarry Smith /* Must preserve reduction count before we go on */ 15415c6c1daeSBarry Smith red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 15425c6c1daeSBarry Smith 15435c6c1daeSBarry Smith /* Calculate summary information */ 15449566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n Max Max/Min Avg Total\n")); 15455c6c1daeSBarry Smith /* Time */ 15469566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15479566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15489566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1549217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15509371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15519371c9d4SSatish Balay else ratio = 0.0; 15529566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Time (sec): %5.3e %7.3f %5.3e\n", max, ratio, avg)); 15535c6c1daeSBarry Smith TotalTime = tot; 15545c6c1daeSBarry Smith /* Objects */ 15555c6c1daeSBarry Smith avg = (PetscLogDouble)petsc_numObjects; 15569566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15579566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15589566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1559217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15609371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15619371c9d4SSatish Balay else ratio = 0.0; 15629566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Objects: %5.3e %7.3f %5.3e\n", max, ratio, avg)); 15635c6c1daeSBarry Smith /* Flops */ 15649566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15659566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15669566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &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: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15715c6c1daeSBarry Smith TotalFlops = tot; 15725c6c1daeSBarry Smith /* Flops/sec -- Must talk to Barry here */ 15739371c9d4SSatish Balay if (locTotalTime != 0.0) flops = petsc_TotalFlops / locTotalTime; 15749371c9d4SSatish Balay else flops = 0.0; 15759566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15769566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15779566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1578217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15799371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15809371c9d4SSatish Balay else ratio = 0.0; 15819566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Flops/sec: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15825c6c1daeSBarry Smith /* Memory */ 15839566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&mem)); 15845c6c1daeSBarry Smith if (mem > 0.0) { 15859566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15869566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15879566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1588217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15899371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15909371c9d4SSatish Balay else ratio = 0.0; 15919566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Memory (bytes): %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15925c6c1daeSBarry Smith } 15935c6c1daeSBarry Smith /* Messages */ 15945c6c1daeSBarry Smith mess = 0.5 * (petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct); 15959566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15969566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15979566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1598217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15999371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 16009371c9d4SSatish Balay else ratio = 0.0; 16019566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Msg Count: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 16025c6c1daeSBarry Smith numMessages = tot; 16035c6c1daeSBarry Smith /* Message Lengths */ 16045c6c1daeSBarry Smith mess = 0.5 * (petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len); 16059566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 16069566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 16079566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16089371c9d4SSatish Balay if (numMessages != 0) avg = tot / numMessages; 16099371c9d4SSatish Balay else avg = 0.0; 16109371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 16119371c9d4SSatish Balay else ratio = 0.0; 16129566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Msg Len (bytes): %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 16135c6c1daeSBarry Smith messageLength = tot; 16145c6c1daeSBarry Smith /* Reductions */ 16159566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 16169566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 16179566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16189371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 16199371c9d4SSatish Balay else ratio = 0.0; 16209566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Reductions: %5.3e %7.3f\n", max, ratio)); 16215c6c1daeSBarry Smith numReductions = red; /* wrong because uses count from process zero */ 16229566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n")); 16239566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " e.g., VecAXPY() for real vectors of length N --> 2N flops\n")); 16249566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " and VecAXPY() for complex vectors of length N --> 8N flops\n")); 16255c6c1daeSBarry Smith 16265c6c1daeSBarry Smith /* Get total number of stages -- 16275c6c1daeSBarry Smith Currently, a single processor can register more stages than another, but stages must all be registered in order. 16285c6c1daeSBarry Smith We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID. 16295c6c1daeSBarry Smith This seems best accomplished by assoicating a communicator with each stage. 16305c6c1daeSBarry Smith */ 16319566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 16329566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 16339566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &localStageUsed)); 16349566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &stageUsed)); 16359566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &localStageVisible)); 16369566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &stageVisible)); 16375c6c1daeSBarry Smith if (numStages > 0) { 16385c6c1daeSBarry Smith stageInfo = stageLog->stageInfo; 16395c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16405c6c1daeSBarry Smith if (stage < stageLog->numStages) { 16415c6c1daeSBarry Smith localStageUsed[stage] = stageInfo[stage].used; 16425c6c1daeSBarry Smith localStageVisible[stage] = stageInfo[stage].perfInfo.visible; 16435c6c1daeSBarry Smith } else { 16445c6c1daeSBarry Smith localStageUsed[stage] = PETSC_FALSE; 16455c6c1daeSBarry Smith localStageVisible[stage] = PETSC_TRUE; 16465c6c1daeSBarry Smith } 16475c6c1daeSBarry Smith } 16489566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm)); 16499566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm)); 16505c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16515c6c1daeSBarry Smith if (stageUsed[stage]) { 16529566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\nSummary of Stages: ----- Time ------ ----- Flop ------ --- Messages --- -- Message Lengths -- -- Reductions --\n")); 16539566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Avg %%Total Avg %%Total Count %%Total Avg %%Total Count %%Total\n")); 16545c6c1daeSBarry Smith break; 16555c6c1daeSBarry Smith } 16565c6c1daeSBarry Smith } 16575c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16585c6c1daeSBarry Smith if (!stageUsed[stage]) continue; 1659820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 16605c6c1daeSBarry Smith if (localStageUsed[stage]) { 16619566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16629566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16639566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16649566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16659566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16665c6c1daeSBarry Smith name = stageInfo[stage].name; 16675c6c1daeSBarry Smith } else { 16689566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16699566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16709566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16719566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16729566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16735c6c1daeSBarry Smith name = ""; 16745c6c1daeSBarry Smith } 16759371c9d4SSatish Balay mess *= 0.5; 16769371c9d4SSatish Balay messLen *= 0.5; 16779371c9d4SSatish Balay red /= size; 16789371c9d4SSatish Balay if (TotalTime != 0.0) fracTime = stageTime / TotalTime; 16799371c9d4SSatish Balay else fracTime = 0.0; 16809371c9d4SSatish Balay if (TotalFlops != 0.0) fracFlops = flops / TotalFlops; 16819371c9d4SSatish Balay else fracFlops = 0.0; 16825c6c1daeSBarry Smith /* Talk to Barry if (stageTime != 0.0) flops = (size*flops)/stageTime; else flops = 0.0; */ 16839371c9d4SSatish Balay if (numMessages != 0.0) fracMessages = mess / numMessages; 16849371c9d4SSatish Balay else fracMessages = 0.0; 16859371c9d4SSatish Balay if (mess != 0.0) avgMessLen = messLen / mess; 16869371c9d4SSatish Balay else avgMessLen = 0.0; 16879371c9d4SSatish Balay if (messageLength != 0.0) fracLength = messLen / messageLength; 16889371c9d4SSatish Balay else fracLength = 0.0; 16899371c9d4SSatish Balay if (numReductions != 0.0) fracReductions = red / numReductions; 16909371c9d4SSatish Balay else fracReductions = 0.0; 16919371c9d4SSatish 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)); 16925c6c1daeSBarry Smith } 16935c6c1daeSBarry Smith } 16945c6c1daeSBarry Smith 16959566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n------------------------------------------------------------------------------------------------------------------------\n")); 16969566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n")); 16979566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Phase summary info:\n")); 16989566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Count: number of times phase was executed\n")); 16999566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Time and Flop: Max - maximum over all processors\n")); 17009566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Ratio - ratio of maximum to minimum over all processors\n")); 17019566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Mess: number of messages sent\n")); 17029566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " AvgLen: average message length (bytes)\n")); 17039566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Reduct: number of global reductions\n")); 17049566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Global: entire computation\n")); 17059566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n")); 17069566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%T - percent time in this phase %%F - percent flop in this phase\n")); 17079566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%M - percent messages in this phase %%L - percent message lengths in this phase\n")); 17089566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%R - percent reductions in this phase\n")); 17099566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n")); 1710e3ed9ee7SBarry Smith if (PetscLogMemory) { 171154aabf2dSBarry Smith PetscCall(PetscFPrintf(comm, fd, " Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event). May be negative\n")); 171254aabf2dSBarry Smith PetscCall(PetscFPrintf(comm, fd, " EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events). Never negative\n")); 171354aabf2dSBarry Smith PetscCall(PetscFPrintf(comm, fd, " MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event). Never negative\n")); 17149566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " RMI Mbytes: Increase in resident memory (sum over all calls to event)\n")); 1715e3ed9ee7SBarry Smith } 1716d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17179566063dSJacob 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")); 17189566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " CpuToGpu Count: total number of CPU to GPU copies per processor\n")); 17199566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " CpuToGpu Size (Mbytes): 10e-6 * (total size of CPU to GPU copies per processor)\n")); 17209566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GpuToCpu Count: total number of GPU to CPU copies per processor\n")); 17219566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GpuToCpu Size (Mbytes): 10e-6 * (total size of GPU to CPU copies per processor)\n")); 17229566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GPU %%F: percent flops on GPU in this event\n")); 1723bec0b493Shannah_mairs #endif 17249566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n")); 17255c6c1daeSBarry Smith 17269566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm, fd)); 17275c6c1daeSBarry Smith 17285c6c1daeSBarry Smith /* Report events */ 17299566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Event Count Time (sec) Flop --- Global --- --- Stage ---- Total")); 173048a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, " Malloc EMalloc MMalloc RMI")); 1731d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17329566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GPU - CpuToGpu - - GpuToCpu - GPU")); 1733bec0b493Shannah_mairs #endif 17349566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 17359566063dSJacob 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")); 173648a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, " Mbytes Mbytes Mbytes Mbytes")); 1737d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17389566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Mflop/s Count Size Count Size %%F")); 1739bec0b493Shannah_mairs #endif 17409566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 17419566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------")); 174248a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, "-----------------------------")); 1743d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17449566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "---------------------------------------")); 17454863603aSSatish Balay #endif 17469566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 17475c6c1daeSBarry Smith 1748156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1749156b51fbSBarry Smith /* this indirect way of accessing these values is needed when PETSc is build with multiple libraries since the symbols are not in libpetscsys */ 1750156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "TAOSolve", &TAO_Solve)); 1751156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "TSStep", &TS_Step)); 1752156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "SNESSolve", &SNES_Solve)); 1753156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "KSPSolve", &KSP_Solve)); 1754156b51fbSBarry Smith #endif 1755156b51fbSBarry Smith 17565c6c1daeSBarry Smith /* Problem: The stage name will not show up unless the stage executed on proc 1 */ 17575c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 17585c6c1daeSBarry Smith if (!stageVisible[stage]) continue; 1759820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 17605c6c1daeSBarry Smith if (localStageUsed[stage]) { 17619566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name)); 17629566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17639566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17649566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17659566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17669566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17675c6c1daeSBarry Smith } else { 17689566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage)); 17699566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17709566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17719566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17729566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17739566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17745c6c1daeSBarry Smith } 17759371c9d4SSatish Balay mess *= 0.5; 17769371c9d4SSatish Balay messLen *= 0.5; 17779371c9d4SSatish Balay red /= size; 17785c6c1daeSBarry Smith 17795c6c1daeSBarry Smith /* Get total number of events in this stage -- 17805c6c1daeSBarry Smith Currently, a single processor can register more events than another, but events must all be registered in order, 17815c6c1daeSBarry Smith just like stages. We can removed this requirement if necessary by having a global event numbering and indirection 1782217044c2SLisandro Dalcin on the event ID. This seems best accomplished by associating a communicator with each stage. 17835c6c1daeSBarry Smith 17845c6c1daeSBarry Smith Problem: If the event did not happen on proc 1, its name will not be available. 17855c6c1daeSBarry Smith Problem: Event visibility is not implemented 17865c6c1daeSBarry Smith */ 17875c6c1daeSBarry Smith if (localStageUsed[stage]) { 17885c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo; 17895c6c1daeSBarry Smith localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents; 1790a297a907SKarl Rupp } else localNumEvents = 0; 17919566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 17925c6c1daeSBarry Smith for (event = 0; event < numEvents; event++) { 1793820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 17945c6c1daeSBarry Smith if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) { 17959371c9d4SSatish Balay if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; 17969371c9d4SSatish Balay else flopr = 0.0; 17979566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 17989566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 17999566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18009566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18019566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18029566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18039566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18049566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18059566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18069566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].count, &minC, 1, MPI_INT, MPI_MIN, comm)); 18079566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].count, &maxC, 1, MPI_INT, MPI_MAX, comm)); 1808e3ed9ee7SBarry Smith if (PetscLogMemory) { 18099566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].memIncrease, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18109566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocSpace, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18119566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocIncrease, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18129566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1813e3ed9ee7SBarry Smith } 1814d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 18159566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].CpuToGpuCount, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18169566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuToCpuCount, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18179566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].CpuToGpuSize, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18189566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuToCpuSize, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18199566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuFlops, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18209566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuTime, &gmaxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 1821bec0b493Shannah_mairs #endif 18225c6c1daeSBarry Smith name = stageLog->eventLog->eventInfo[event].name; 18235c6c1daeSBarry Smith } else { 18245c6c1daeSBarry Smith flopr = 0.0; 18259566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18269566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18279566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18289566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18299566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18309566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18319566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18329566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18339566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18349566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&ierr, &minC, 1, MPI_INT, MPI_MIN, comm)); 18359566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&ierr, &maxC, 1, MPI_INT, MPI_MAX, comm)); 1836e3ed9ee7SBarry Smith if (PetscLogMemory) { 18379566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18389566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18399566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18409566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &emalmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1841e3ed9ee7SBarry Smith } 1842d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 18439566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18449566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18459566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18469566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18479566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18489566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gmaxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 1849bec0b493Shannah_mairs #endif 18505c6c1daeSBarry Smith name = ""; 18515c6c1daeSBarry Smith } 18525c6c1daeSBarry Smith if (mint < 0.0) { 1853d0609cedSBarry 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)); 18545c6c1daeSBarry Smith mint = 0; 18555c6c1daeSBarry Smith } 185608401ef6SPierre 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); 1857156b51fbSBarry Smith /* Put NaN into the time for all events that may not be time accurately since they may happen asynchronously on the GPU */ 1858156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1859156b51fbSBarry Smith if (!PetscLogGpuTimeFlag && petsc_gflops > 0) { 1860156b51fbSBarry Smith memcpy(&gmaxt, &nas, sizeof(PetscLogDouble)); 1861156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, &eventid)); 1862156b51fbSBarry Smith if (eventid != SNES_Solve && eventid != KSP_Solve && eventid != TS_Step && eventid != TAO_Solve) { 1863156b51fbSBarry Smith memcpy(&mint, &nas, sizeof(PetscLogDouble)); 1864156b51fbSBarry Smith memcpy(&maxt, &nas, sizeof(PetscLogDouble)); 1865156b51fbSBarry Smith } 1866156b51fbSBarry Smith } 1867156b51fbSBarry Smith #endif 18689371c9d4SSatish Balay totm *= 0.5; 18699371c9d4SSatish Balay totml *= 0.5; 18709371c9d4SSatish Balay totr /= size; 18715c6c1daeSBarry Smith 1872217044c2SLisandro Dalcin if (maxC != 0) { 18739371c9d4SSatish Balay if (minC != 0) ratC = ((PetscLogDouble)maxC) / minC; 18749371c9d4SSatish Balay else ratC = 0.0; 18759371c9d4SSatish Balay if (mint != 0.0) ratt = maxt / mint; 18769371c9d4SSatish Balay else ratt = 0.0; 18779371c9d4SSatish Balay if (minf != 0.0) ratf = maxf / minf; 18789371c9d4SSatish Balay else ratf = 0.0; 18799371c9d4SSatish Balay if (TotalTime != 0.0) fracTime = tott / TotalTime; 18809371c9d4SSatish Balay else fracTime = 0.0; 18819371c9d4SSatish Balay if (TotalFlops != 0.0) fracFlops = totf / TotalFlops; 18829371c9d4SSatish Balay else fracFlops = 0.0; 18839371c9d4SSatish Balay if (stageTime != 0.0) fracStageTime = tott / stageTime; 18849371c9d4SSatish Balay else fracStageTime = 0.0; 18859371c9d4SSatish Balay if (flops != 0.0) fracStageFlops = totf / flops; 18869371c9d4SSatish Balay else fracStageFlops = 0.0; 18879371c9d4SSatish Balay if (numMessages != 0.0) fracMess = totm / numMessages; 18889371c9d4SSatish Balay else fracMess = 0.0; 18899371c9d4SSatish Balay if (messageLength != 0.0) fracMessLen = totml / messageLength; 18909371c9d4SSatish Balay else fracMessLen = 0.0; 18919371c9d4SSatish Balay if (numReductions != 0.0) fracRed = totr / numReductions; 18929371c9d4SSatish Balay else fracRed = 0.0; 18939371c9d4SSatish Balay if (mess != 0.0) fracStageMess = totm / mess; 18949371c9d4SSatish Balay else fracStageMess = 0.0; 18959371c9d4SSatish Balay if (messLen != 0.0) fracStageMessLen = totml / messLen; 18969371c9d4SSatish Balay else fracStageMessLen = 0.0; 18979371c9d4SSatish Balay if (red != 0.0) fracStageRed = totr / red; 18989371c9d4SSatish Balay else fracStageRed = 0.0; 18999371c9d4SSatish Balay if (totm != 0.0) totml /= totm; 19009371c9d4SSatish Balay else totml = 0.0; 19019371c9d4SSatish Balay if (maxt != 0.0) flopr = totf / maxt; 19029371c9d4SSatish Balay else flopr = 0.0; 1903*68a21331SBarry Smith if (fracStageTime > 1.0 || fracStageFlops > 1.0 || fracStageMess > 1.0 || fracStageMessLen > 1.0 || fracStageRed > 1.0) 1904*68a21331SBarry Smith 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 Multiple stages %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, PetscAbs(flopr) / 1.0e6)); 1905*68a21331SBarry Smith else 1906*68a21331SBarry Smith 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)); 190748a46eb9SPierre 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)); 1908d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 19099371c9d4SSatish Balay if (totf != 0.0) fracgflops = gflops / totf; 19109371c9d4SSatish Balay else fracgflops = 0.0; 19119371c9d4SSatish Balay if (gmaxt != 0.0) gflopr = gflops / gmaxt; 19129371c9d4SSatish Balay else gflopr = 0.0; 19139566063dSJacob 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)); 1914bec0b493Shannah_mairs #endif 19159566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 19165c6c1daeSBarry Smith } 19175c6c1daeSBarry Smith } 19185c6c1daeSBarry Smith } 19195c6c1daeSBarry Smith 19205c6c1daeSBarry Smith /* Memory usage and object creation */ 19219566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------")); 192248a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, "-----------------------------")); 1923d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 19249566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "---------------------------------------")); 19254863603aSSatish Balay #endif 19269566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 19279566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 19285c6c1daeSBarry Smith 19295c6c1daeSBarry Smith /* Right now, only stages on the first processor are reported here, meaning only objects associated with 19305c6c1daeSBarry Smith the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then 19315c6c1daeSBarry Smith stats for stages local to processor sets. 19325c6c1daeSBarry Smith */ 19335c6c1daeSBarry Smith /* We should figure out the longest object name here (now 20 characters) */ 19344851f57dSBarry Smith PetscCall(PetscFPrintf(comm, fd, "Object Type Creations Destructions. Reports information only for process 0.\n")); 19355c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 19365c6c1daeSBarry Smith if (localStageUsed[stage]) { 19375c6c1daeSBarry Smith classInfo = stageLog->stageInfo[stage].classLog->classInfo; 19389566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name)); 19395c6c1daeSBarry Smith for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) { 19405c6c1daeSBarry Smith if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) { 19414851f57dSBarry Smith PetscCall(PetscFPrintf(comm, fd, "%20s %5d %5d\n", stageLog->classLog->classInfo[oclass].name, classInfo[oclass].creations, classInfo[oclass].destructions)); 19425c6c1daeSBarry Smith } 19435c6c1daeSBarry Smith } 19445c6c1daeSBarry Smith } else { 1945cf019ec6SStefano Zampini if (!localStageVisible[stage]) continue; 19469566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage)); 19475c6c1daeSBarry Smith } 19485c6c1daeSBarry Smith } 19495c6c1daeSBarry Smith 19509566063dSJacob Faibussowitsch PetscCall(PetscFree(localStageUsed)); 19519566063dSJacob Faibussowitsch PetscCall(PetscFree(stageUsed)); 19529566063dSJacob Faibussowitsch PetscCall(PetscFree(localStageVisible)); 19539566063dSJacob Faibussowitsch PetscCall(PetscFree(stageVisible)); 19545c6c1daeSBarry Smith 19555c6c1daeSBarry Smith /* Information unrelated to this particular run */ 19569566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "========================================================================================================================\n")); 19578563dfccSBarry Smith PetscTime(&y); 19588563dfccSBarry Smith PetscTime(&x); 19599371c9d4SSatish Balay PetscTime(&y); 19609371c9d4SSatish Balay PetscTime(&y); 19619371c9d4SSatish Balay PetscTime(&y); 19629371c9d4SSatish Balay PetscTime(&y); 19639371c9d4SSatish Balay PetscTime(&y); 19649371c9d4SSatish Balay PetscTime(&y); 19659371c9d4SSatish Balay PetscTime(&y); 19669371c9d4SSatish Balay PetscTime(&y); 19679371c9d4SSatish Balay PetscTime(&y); 19689371c9d4SSatish Balay PetscTime(&y); 19699566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Average time to get PetscTime(): %g\n", (y - x) / 10.0)); 19705c6c1daeSBarry Smith /* MPI information */ 19715c6c1daeSBarry Smith if (size > 1) { 19725c6c1daeSBarry Smith MPI_Status status; 19735c6c1daeSBarry Smith PetscMPIInt tag; 19745c6c1daeSBarry Smith MPI_Comm newcomm; 19755c6c1daeSBarry Smith 19769566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19778563dfccSBarry Smith PetscTime(&x); 19789566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19799566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19809566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19819566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19829566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19838563dfccSBarry Smith PetscTime(&y); 19849566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y - x) / 5.0)); 19859566063dSJacob Faibussowitsch PetscCall(PetscCommDuplicate(comm, &newcomm, &tag)); 19869566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19875c6c1daeSBarry Smith if (rank) { 19889566063dSJacob Faibussowitsch PetscCallMPI(MPI_Recv(NULL, 0, MPI_INT, rank - 1, tag, newcomm, &status)); 19899566063dSJacob Faibussowitsch PetscCallMPI(MPI_Send(NULL, 0, MPI_INT, (rank + 1) % size, tag, newcomm)); 19905c6c1daeSBarry Smith } else { 19918563dfccSBarry Smith PetscTime(&x); 19929566063dSJacob Faibussowitsch PetscCallMPI(MPI_Send(NULL, 0, MPI_INT, 1, tag, newcomm)); 19939566063dSJacob Faibussowitsch PetscCallMPI(MPI_Recv(NULL, 0, MPI_INT, size - 1, tag, newcomm, &status)); 19948563dfccSBarry Smith PetscTime(&y); 19959566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Average time for zero size MPI_Send(): %g\n", (y - x) / size)); 19965c6c1daeSBarry Smith } 19979566063dSJacob Faibussowitsch PetscCall(PetscCommDestroy(&newcomm)); 19985c6c1daeSBarry Smith } 19999566063dSJacob Faibussowitsch PetscCall(PetscOptionsView(NULL, viewer)); 20005c6c1daeSBarry Smith 20015c6c1daeSBarry Smith /* Machine and compile information */ 20025c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS) 20039566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n")); 20045c6c1daeSBarry Smith #else 20059566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n")); 20065c6c1daeSBarry Smith #endif 2007217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) 20089566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n")); 2009217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128) 20109566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n")); 2011217044c2SLisandro Dalcin #endif 20125c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 20139566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n")); 20145f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128) 20159566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n")); 20165c6c1daeSBarry Smith #endif 20175c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE) 20189566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with single precision matrices\n")); 20195c6c1daeSBarry Smith #else 20209566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n")); 20215c6c1daeSBarry Smith #endif 20229371c9d4SSatish 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))); 20235c6c1daeSBarry Smith 20249566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Configure options: %s", petscconfigureoptions)); 20259566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petscmachineinfo)); 20269566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsccompilerinfo)); 20279566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo)); 20289566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsclinkerinfo)); 20295c6c1daeSBarry Smith 20305c6c1daeSBarry Smith /* Cleanup */ 20319566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 20329566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnNoGpuAwareMpi(comm, fd)); 20339566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm, fd)); 2034156b51fbSBarry Smith PetscCall(PetscFPTrapPop()); 20355c6c1daeSBarry Smith PetscFunctionReturn(0); 20365c6c1daeSBarry Smith } 20375c6c1daeSBarry Smith 20387d6c928cSSatish Balay /*@C 20397d6c928cSSatish Balay PetscLogView - Prints a summary of the logging. 20405c6c1daeSBarry Smith 20415c6c1daeSBarry Smith Collective over MPI_Comm 20425c6c1daeSBarry Smith 20435c6c1daeSBarry Smith Input Parameter: 2044f14045dbSBarry Smith . viewer - an ASCII viewer 20455c6c1daeSBarry Smith 20465c6c1daeSBarry Smith Options Database Keys: 2047bb1d7374SBarry Smith + -log_view [:filename] - Prints summary of log information 2048bb1d7374SBarry Smith . -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file 2049607d249eSBarry 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) 2050d0a29bd7SConnor 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) 2051156b51fbSBarry Smith . -log_view_memory - Also display memory usage in each event 2052156b51fbSBarry Smith . -log_view_gpu_time - Also display time in each event for GPU kernels (Note this may slow the computation) 2053811af0c4SBarry Smith . -log_all - Saves a file Log.rank for each MPI rank with details of each step of the computation 2054bb1d7374SBarry Smith - -log_trace [filename] - Displays a trace of what each process is doing 20555c6c1daeSBarry Smith 20565c6c1daeSBarry Smith Notes: 2057bb1d7374SBarry Smith It is possible to control the logging programatically but we recommend using the options database approach whenever possible 20585c6c1daeSBarry Smith By default the summary is printed to stdout. 20595c6c1daeSBarry Smith 2060bb1d7374SBarry Smith Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin() 2061bb1d7374SBarry Smith 2062bb1d7374SBarry Smith If PETSc is configured with --with-logging=0 then this functionality is not available 2063bb1d7374SBarry Smith 2064607d249eSBarry Smith To view the nested XML format filename.xml first copy ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current 2065607d249eSBarry Smith directory then open filename.xml with your browser. Specific notes for certain browsers 2066607d249eSBarry Smith $ Firefox and Internet explorer - simply open the file 2067607d249eSBarry Smith $ Google Chrome - you must start up Chrome with the option --allow-file-access-from-files 2068a8d69d7bSBarry Smith $ Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access 2069607d249eSBarry 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 2070607d249eSBarry Smith your browser. 20712add09c0SLisandro Dalcin Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser 20722add09c0SLisandro Dalcin window and render the XML log file contents. 2073607d249eSBarry Smith 2074bb1d7374SBarry Smith The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij MARITIME RESEARCH INSTITUTE NETHERLANDS 2075bb1d7374SBarry Smith 2076d0a29bd7SConnor Ward The Flame Graph output can be visualised using either the original Flame Graph script (https://github.com/brendangregg/FlameGraph) 2077d0a29bd7SConnor Ward or using speedscope (https://www.speedscope.app). 2078d0a29bd7SConnor Ward Old XML profiles may be converted into this format using the script ${PETSC_DIR}/lib/petsc/bin/xml2flamegraph.py. 2079d0a29bd7SConnor Ward 20805c6c1daeSBarry Smith Level: beginner 20815c6c1daeSBarry Smith 2082db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogDump()` 20835c6c1daeSBarry Smith @*/ 2084d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView(PetscViewer viewer) 2085d71ae5a4SJacob Faibussowitsch { 2086f14045dbSBarry Smith PetscBool isascii; 2087f14045dbSBarry Smith PetscViewerFormat format; 208837b78d16SBarry Smith int stage, lastStage; 208937b78d16SBarry Smith PetscStageLog stageLog; 20905c6c1daeSBarry Smith 20915c6c1daeSBarry Smith PetscFunctionBegin; 209228b400f6SJacob Faibussowitsch PetscCheck(PetscLogPLB, PETSC_COMM_SELF, PETSC_ERR_SUP, "Must use -log_view or PetscLogDefaultBegin() before calling this routine"); 209337b78d16SBarry Smith /* Pop off any stages the user forgot to remove */ 209437b78d16SBarry Smith lastStage = 0; 20959566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 20969566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 209737b78d16SBarry Smith while (stage >= 0) { 209837b78d16SBarry Smith lastStage = stage; 20999566063dSJacob Faibussowitsch PetscCall(PetscStageLogPop(stageLog)); 21009566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 210137b78d16SBarry Smith } 21029566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isascii)); 210328b400f6SJacob Faibussowitsch PetscCheck(isascii, PetscObjectComm((PetscObject)viewer), PETSC_ERR_SUP, "Currently can only view logging to ASCII"); 21049566063dSJacob Faibussowitsch PetscCall(PetscViewerGetFormat(viewer, &format)); 2105f14045dbSBarry Smith if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) { 21069566063dSJacob Faibussowitsch PetscCall(PetscLogView_Default(viewer)); 2107f14045dbSBarry Smith } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) { 21089566063dSJacob Faibussowitsch PetscCall(PetscLogView_Detailed(viewer)); 210938144912Sdeepblu2718 } else if (format == PETSC_VIEWER_ASCII_CSV) { 21109566063dSJacob Faibussowitsch PetscCall(PetscLogView_CSV(viewer)); 2111bb1d7374SBarry Smith } else if (format == PETSC_VIEWER_ASCII_XML) { 21129566063dSJacob Faibussowitsch PetscCall(PetscLogView_Nested(viewer)); 2113d0a29bd7SConnor Ward } else if (format == PETSC_VIEWER_ASCII_FLAMEGRAPH) { 21149566063dSJacob Faibussowitsch PetscCall(PetscLogView_Flamegraph(viewer)); 21155c6c1daeSBarry Smith } 21169566063dSJacob Faibussowitsch PetscCall(PetscStageLogPush(stageLog, lastStage)); 21175c6c1daeSBarry Smith PetscFunctionReturn(0); 21185c6c1daeSBarry Smith } 21195c6c1daeSBarry Smith 2120f14045dbSBarry Smith /*@C 2121811af0c4SBarry Smith PetscLogViewFromOptions - Processes command line options to determine if/how a `PetscLog` is to be viewed. 2122f14045dbSBarry Smith 2123811af0c4SBarry Smith Collective on `PETSC_COMM_WORLD` 2124f14045dbSBarry Smith 2125811af0c4SBarry Smith Level: developer 2126f14045dbSBarry Smith 2127811af0c4SBarry Smith .seealso: `PetscLogView()` 2128f14045dbSBarry Smith @*/ 2129d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogViewFromOptions(void) 2130d71ae5a4SJacob Faibussowitsch { 2131f14045dbSBarry Smith PetscViewer viewer; 2132f14045dbSBarry Smith PetscBool flg; 2133f14045dbSBarry Smith PetscViewerFormat format; 2134f14045dbSBarry Smith 2135f14045dbSBarry Smith PetscFunctionBegin; 21369566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetViewer(PETSC_COMM_WORLD, NULL, NULL, "-log_view", &viewer, &format, &flg)); 2137f14045dbSBarry Smith if (flg) { 21389566063dSJacob Faibussowitsch PetscCall(PetscViewerPushFormat(viewer, format)); 21399566063dSJacob Faibussowitsch PetscCall(PetscLogView(viewer)); 21409566063dSJacob Faibussowitsch PetscCall(PetscViewerPopFormat(viewer)); 21419566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&viewer)); 2142f14045dbSBarry Smith } 2143f14045dbSBarry Smith PetscFunctionReturn(0); 2144f14045dbSBarry Smith } 2145f14045dbSBarry Smith 21465c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/ 21475c6c1daeSBarry Smith /*@C 21485c6c1daeSBarry Smith PetscGetFlops - Returns the number of flops used on this processor 21495c6c1daeSBarry Smith since the program began. 21505c6c1daeSBarry Smith 21515c6c1daeSBarry Smith Not Collective 21525c6c1daeSBarry Smith 21535c6c1daeSBarry Smith Output Parameter: 21545c6c1daeSBarry Smith flops - number of floating point operations 21555c6c1daeSBarry Smith 21565c6c1daeSBarry Smith Notes: 21575c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 2158811af0c4SBarry Smith `PetscLogFlops()` to increment this counter to include flops for the 21595c6c1daeSBarry Smith application code. 21605c6c1daeSBarry Smith 2161811af0c4SBarry Smith A separate counter `PetscLogGPUFlops()` logs the flops that occur on any GPU associated with this MPI rank 2162811af0c4SBarry Smith 21635c6c1daeSBarry Smith Level: intermediate 21645c6c1daeSBarry Smith 2165811af0c4SBarry Smith .seealso: `PetscLogGPUFlops()`, `PetscTime()`, `PetscLogFlops()` 21665c6c1daeSBarry Smith @*/ 2167d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscGetFlops(PetscLogDouble *flops) 2168d71ae5a4SJacob Faibussowitsch { 21695c6c1daeSBarry Smith PetscFunctionBegin; 21705c6c1daeSBarry Smith *flops = petsc_TotalFlops; 21715c6c1daeSBarry Smith PetscFunctionReturn(0); 21725c6c1daeSBarry Smith } 21735c6c1daeSBarry Smith 2174d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 2175d71ae5a4SJacob Faibussowitsch { 21765c6c1daeSBarry Smith size_t fullLength; 21775c6c1daeSBarry Smith va_list Argp; 21785c6c1daeSBarry Smith 21795c6c1daeSBarry Smith PetscFunctionBegin; 21805c6c1daeSBarry Smith if (!petsc_logObjects) PetscFunctionReturn(0); 21815c6c1daeSBarry Smith va_start(Argp, format); 21829566063dSJacob Faibussowitsch PetscCall(PetscVSNPrintf(petsc_objects[obj->id].info, 64, format, &fullLength, Argp)); 21835c6c1daeSBarry Smith va_end(Argp); 21845c6c1daeSBarry Smith PetscFunctionReturn(0); 21855c6c1daeSBarry Smith } 21865c6c1daeSBarry Smith 21875c6c1daeSBarry Smith /*MC 21885c6c1daeSBarry Smith PetscLogFlops - Adds floating point operations to the global counter. 21895c6c1daeSBarry Smith 21905c6c1daeSBarry Smith Synopsis: 2191aaa7dc30SBarry Smith #include <petsclog.h> 21925c6c1daeSBarry Smith PetscErrorCode PetscLogFlops(PetscLogDouble f) 21935c6c1daeSBarry Smith 21945c6c1daeSBarry Smith Not Collective 21955c6c1daeSBarry Smith 21965c6c1daeSBarry Smith Input Parameter: 21975c6c1daeSBarry Smith . f - flop counter 21985c6c1daeSBarry Smith 21995c6c1daeSBarry Smith Usage: 22005c6c1daeSBarry Smith .vb 22015c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 22025c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 22035c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 22045c6c1daeSBarry Smith [code segment to monitor] 22055c6c1daeSBarry Smith PetscLogFlops(user_flops) 22065c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 22075c6c1daeSBarry Smith .ve 22085c6c1daeSBarry Smith 2209811af0c4SBarry Smith Note: 22105c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 22115c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 22125c6c1daeSBarry Smith application code. 22135c6c1daeSBarry Smith 22145c6c1daeSBarry Smith Level: intermediate 22155c6c1daeSBarry Smith 2216811af0c4SBarry Smith .seealso: `PetscLogGPUFlops()`, `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscGetFlops()` 22175c6c1daeSBarry Smith M*/ 22185c6c1daeSBarry Smith 22195c6c1daeSBarry Smith /*MC 22205c6c1daeSBarry Smith PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice) 22215c6c1daeSBarry Smith to get accurate timings 22225c6c1daeSBarry Smith 22235c6c1daeSBarry Smith Synopsis: 2224aaa7dc30SBarry Smith #include <petsclog.h> 22255c6c1daeSBarry Smith void PetscPreLoadBegin(PetscBool flag,char *name); 22265c6c1daeSBarry Smith 22275c6c1daeSBarry Smith Not Collective 22285c6c1daeSBarry Smith 2229d8d19677SJose E. Roman Input Parameters: 2230811af0c4SBarry Smith + flag - PETSC_TRUE to run twice, `PETSC_FALSE` to run once, may be overridden 22315c6c1daeSBarry Smith with command line option -preload true or -preload false 2232609bdbeeSBarry Smith - name - name of first stage (lines of code timed separately with -log_view) to 22335c6c1daeSBarry Smith be preloaded 22345c6c1daeSBarry Smith 22355c6c1daeSBarry Smith Usage: 22365c6c1daeSBarry Smith .vb 22375c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22385c6c1daeSBarry Smith lines of code 22395c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22405c6c1daeSBarry Smith lines of code 22415c6c1daeSBarry Smith PetscPreLoadEnd(); 22425c6c1daeSBarry Smith .ve 22435c6c1daeSBarry Smith 2244811af0c4SBarry Smith Note: 224595452b02SPatrick Sanan Only works in C/C++, not Fortran 22465c6c1daeSBarry Smith 22475c6c1daeSBarry Smith Flags available within the macro. 22485c6c1daeSBarry Smith + PetscPreLoadingUsed - true if we are or have done preloading 22495c6c1daeSBarry Smith . PetscPreLoadingOn - true if it is CURRENTLY doing preload 22505c6c1daeSBarry Smith . PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second 22515c6c1daeSBarry Smith - PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on 22525c6c1daeSBarry Smith The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin() 22535c6c1daeSBarry Smith and PetscPreLoadEnd() 22545c6c1daeSBarry Smith 22555c6c1daeSBarry Smith Level: intermediate 22565c6c1daeSBarry Smith 2257db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 22585c6c1daeSBarry Smith M*/ 22595c6c1daeSBarry Smith 22605c6c1daeSBarry Smith /*MC 22615c6c1daeSBarry Smith PetscPreLoadEnd - End a segment of code that may be preloaded (run twice) 22625c6c1daeSBarry Smith to get accurate timings 22635c6c1daeSBarry Smith 22645c6c1daeSBarry Smith Synopsis: 2265aaa7dc30SBarry Smith #include <petsclog.h> 22665c6c1daeSBarry Smith void PetscPreLoadEnd(void); 22675c6c1daeSBarry Smith 22685c6c1daeSBarry Smith Not Collective 22695c6c1daeSBarry Smith 22705c6c1daeSBarry Smith Usage: 22715c6c1daeSBarry Smith .vb 22725c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22735c6c1daeSBarry Smith lines of code 22745c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22755c6c1daeSBarry Smith lines of code 22765c6c1daeSBarry Smith PetscPreLoadEnd(); 22775c6c1daeSBarry Smith .ve 22785c6c1daeSBarry Smith 2279811af0c4SBarry Smith Note: 2280811af0c4SBarry Smith Only works in C/C++ not fortran 22815c6c1daeSBarry Smith 22825c6c1daeSBarry Smith Level: intermediate 22835c6c1daeSBarry Smith 2284db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadStage()` 22855c6c1daeSBarry Smith M*/ 22865c6c1daeSBarry Smith 22875c6c1daeSBarry Smith /*MC 22885c6c1daeSBarry Smith PetscPreLoadStage - Start a new segment of code to be timed separately. 22895c6c1daeSBarry Smith to get accurate timings 22905c6c1daeSBarry Smith 22915c6c1daeSBarry Smith Synopsis: 2292aaa7dc30SBarry Smith #include <petsclog.h> 22935c6c1daeSBarry Smith void PetscPreLoadStage(char *name); 22945c6c1daeSBarry Smith 22955c6c1daeSBarry Smith Not Collective 22965c6c1daeSBarry Smith 22975c6c1daeSBarry Smith Usage: 22985c6c1daeSBarry Smith .vb 22995c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 23005c6c1daeSBarry Smith lines of code 23015c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 23025c6c1daeSBarry Smith lines of code 23035c6c1daeSBarry Smith PetscPreLoadEnd(); 23045c6c1daeSBarry Smith .ve 23055c6c1daeSBarry Smith 2306811af0c4SBarry Smith Note: 2307811af0c4SBarry Smith Only works in C/C++ not fortran 23085c6c1daeSBarry Smith 23095c6c1daeSBarry Smith Level: intermediate 23105c6c1daeSBarry Smith 2311db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()` 23125c6c1daeSBarry Smith M*/ 23135c6c1daeSBarry Smith 2314a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_DEVICE) 2315a4af0ceeSJacob Faibussowitsch #include <petsc/private/deviceimpl.h> 23169ffd0706SHong Zhang 2317156b51fbSBarry Smith PetscBool PetscLogGpuTimeFlag = PETSC_FALSE; 2318156b51fbSBarry Smith 2319156b51fbSBarry Smith /* 2320156b51fbSBarry Smith This cannot be called by users between PetscInitialize() and PetscFinalize() at any random location in the code 2321156b51fbSBarry Smith because it will result in timing results that cannot be interpreted. 2322156b51fbSBarry Smith */ 2323d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogGpuTime_Off(void) 2324d71ae5a4SJacob Faibussowitsch { 2325156b51fbSBarry Smith PetscLogGpuTimeFlag = PETSC_FALSE; 2326156b51fbSBarry Smith return 0; 2327156b51fbSBarry Smith } 2328156b51fbSBarry Smith 2329156b51fbSBarry Smith /*@C 2330156b51fbSBarry Smith PetscLogGpuTime - turn on the logging of GPU time for GPU kernels 2331156b51fbSBarry Smith 2332811af0c4SBarry Smith Options Database Key: 2333156b51fbSBarry Smith . -log_view_gpu_time - provide the GPU times in the -log_view output 2334156b51fbSBarry Smith 2335156b51fbSBarry Smith Notes: 2336811af0c4SBarry Smith Turning on the timing of the 2337156b51fbSBarry Smith GPU kernels can slow down the entire computation and should only be used when studying the performance 2338156b51fbSBarry Smith of operations on GPU such as vector operations and matrix-vector operations. 2339156b51fbSBarry Smith 2340156b51fbSBarry Smith This routine should only be called once near the beginning of the program. Once it is started it cannot be turned off. 2341156b51fbSBarry Smith 23420f8f8846SPatrick Sanan Level: advanced 23430f8f8846SPatrick Sanan 2344db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuTimeBegin()` 2345156b51fbSBarry Smith @*/ 2346d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGpuTime(void) 2347d71ae5a4SJacob Faibussowitsch { 2348156b51fbSBarry Smith if (!PetscLogGpuTimeFlag) PetscCall(PetscRegisterFinalize(PetscLogGpuTime_Off)); 2349156b51fbSBarry Smith PetscLogGpuTimeFlag = PETSC_TRUE; 2350156b51fbSBarry Smith return 0; 2351156b51fbSBarry Smith } 2352156b51fbSBarry Smith 23539ffd0706SHong Zhang /*@C 23549ffd0706SHong Zhang PetscLogGpuTimeBegin - Start timer for device 23559ffd0706SHong Zhang 23569ffd0706SHong Zhang Notes: 23579ffd0706SHong 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). 2358811af0c4SBarry Smith 23599ffd0706SHong 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). 2360811af0c4SBarry Smith 2361811af0c4SBarry Smith There is no need to call WaitForCUDA() or WaitForHIP() between `PetscLogGpuTimeBegin()` and `PetscLogGpuTimeEnd()` 2362811af0c4SBarry Smith 23639ffd0706SHong Zhang This timer should NOT include times for data transfers between the GPU and CPU, nor setup actions such as allocating space. 2364811af0c4SBarry Smith 23659ffd0706SHong Zhang The regular logging captures the time for data transfers and any CPU activites during the event 2366811af0c4SBarry Smith 23679ffd0706SHong Zhang It is used to compute the flop rate on the GPU as it is actively engaged in running a kernel. 23689ffd0706SHong Zhang 23699ffd0706SHong Zhang Developer Notes: 2370811af0c4SBarry 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()`. 2371811af0c4SBarry Smith 2372811af0c4SBarry 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 2373811af0c4SBarry Smith event when it reaches that event in the stream. The function xxxEventSynchronize() is called in `PetsLogGpuTimeEnd()` to block CPU execution, 2374811af0c4SBarry Smith but not continued GPU excution, until the timer event is recorded. 23759ffd0706SHong Zhang 23769ffd0706SHong Zhang Level: intermediate 23779ffd0706SHong Zhang 2378db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuTime()` 23799ffd0706SHong Zhang @*/ 2380d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGpuTimeBegin(void) 2381d71ae5a4SJacob Faibussowitsch { 23829ffd0706SHong Zhang PetscFunctionBegin; 2383156b51fbSBarry Smith if (!PetscLogPLB || !PetscLogGpuTimeFlag) PetscFunctionReturn(0); 2384a4af0ceeSJacob Faibussowitsch if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) { 2385a4af0ceeSJacob Faibussowitsch PetscDeviceContext dctx; 2386a4af0ceeSJacob Faibussowitsch 23879566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextGetCurrentContext(&dctx)); 23889566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextBeginTimer_Internal(dctx)); 2389a4af0ceeSJacob Faibussowitsch } else { 23909566063dSJacob Faibussowitsch PetscCall(PetscTimeSubtract(&petsc_gtime)); 2391a4af0ceeSJacob Faibussowitsch } 23929ffd0706SHong Zhang PetscFunctionReturn(0); 23939ffd0706SHong Zhang } 23949ffd0706SHong Zhang 23959ffd0706SHong Zhang /*@C 23969ffd0706SHong Zhang PetscLogGpuTimeEnd - Stop timer for device 23979ffd0706SHong Zhang 23989ffd0706SHong Zhang Level: intermediate 23999ffd0706SHong Zhang 2400db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeBegin()` 24019ffd0706SHong Zhang @*/ 2402d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGpuTimeEnd(void) 2403d71ae5a4SJacob Faibussowitsch { 24049ffd0706SHong Zhang PetscFunctionBegin; 2405156b51fbSBarry Smith if (!PetscLogPLE || !PetscLogGpuTimeFlag) PetscFunctionReturn(0); 2406a4af0ceeSJacob Faibussowitsch if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) { 2407a4af0ceeSJacob Faibussowitsch PetscDeviceContext dctx; 2408a4af0ceeSJacob Faibussowitsch PetscLogDouble elapsed; 2409a4af0ceeSJacob Faibussowitsch 24109566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextGetCurrentContext(&dctx)); 24119566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextEndTimer_Internal(dctx, &elapsed)); 2412a4af0ceeSJacob Faibussowitsch petsc_gtime += (elapsed / 1000.0); 2413a4af0ceeSJacob Faibussowitsch } else { 24149566063dSJacob Faibussowitsch PetscCall(PetscTimeAdd(&petsc_gtime)); 2415a4af0ceeSJacob Faibussowitsch } 24169ffd0706SHong Zhang PetscFunctionReturn(0); 24179ffd0706SHong Zhang } 24189ffd0706SHong Zhang #endif /* end of PETSC_HAVE_DEVICE */ 24199ffd0706SHong Zhang 24205c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */ 24215c6c1daeSBarry Smith 2422d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 2423d71ae5a4SJacob Faibussowitsch { 24245c6c1daeSBarry Smith PetscFunctionBegin; 24255c6c1daeSBarry Smith PetscFunctionReturn(0); 24265c6c1daeSBarry Smith } 24275c6c1daeSBarry Smith 24285c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/ 24295c6c1daeSBarry Smith 24305c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 24315c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID = 0; 24325c6c1daeSBarry Smith 24335c6c1daeSBarry Smith /*@C 24345c6c1daeSBarry Smith PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code. 24355c6c1daeSBarry Smith 24365c6c1daeSBarry Smith Not Collective 24375c6c1daeSBarry Smith 24385c6c1daeSBarry Smith Input Parameter: 24395c6c1daeSBarry Smith . name - The class name 24405c6c1daeSBarry Smith 24415c6c1daeSBarry Smith Output Parameter: 24425c6c1daeSBarry Smith . oclass - The class id or classid 24435c6c1daeSBarry Smith 24445c6c1daeSBarry Smith Level: developer 24455c6c1daeSBarry Smith 2446811af0c4SBarry Smith .seealso: `PetscLogEventRegister()` 24475c6c1daeSBarry Smith @*/ 2448d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscClassIdRegister(const char name[], PetscClassId *oclass) 2449d71ae5a4SJacob Faibussowitsch { 24505c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 24515c6c1daeSBarry Smith PetscStageLog stageLog; 24525c6c1daeSBarry Smith PetscInt stage; 24535c6c1daeSBarry Smith #endif 24545c6c1daeSBarry Smith 24555c6c1daeSBarry Smith PetscFunctionBegin; 24565c6c1daeSBarry Smith *oclass = ++PETSC_LARGEST_CLASSID; 24575c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 24589566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 24599566063dSJacob Faibussowitsch PetscCall(PetscClassRegLogRegister(stageLog->classLog, name, *oclass)); 246048a46eb9SPierre Jolivet for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses)); 24615c6c1daeSBarry Smith #endif 24625c6c1daeSBarry Smith PetscFunctionReturn(0); 24635c6c1daeSBarry Smith } 2464210b5426SBarry Smith 2465210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE) 2466210b5426SBarry Smith #include <mpe.h> 2467210b5426SBarry Smith 2468210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE; 2469210b5426SBarry Smith 2470495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject); 2471495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject); 2472495fc317SBarry Smith 2473210b5426SBarry Smith /*@C 2474210b5426SBarry Smith PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files 2475210b5426SBarry Smith and slows the program down. 2476210b5426SBarry Smith 2477811af0c4SBarry Smith Collective over `PETSC_COMM_WORLD` 2478210b5426SBarry Smith 2479811af0c4SBarry Smith Options Database Key: 2480a2553e36SBarry Smith . -log_mpe - Prints extensive log information 2481210b5426SBarry Smith 2482811af0c4SBarry Smith Note: 2483811af0c4SBarry Smith A related routine is `PetscLogDefaultBegin()` (with the options key -log_view), which is 2484210b5426SBarry Smith intended for production runs since it logs only flop rates and object 2485210b5426SBarry Smith creation (and should not significantly slow the programs). 2486210b5426SBarry Smith 2487210b5426SBarry Smith Level: advanced 2488210b5426SBarry Smith 2489db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogEventActivate()`, 2490db781477SPatrick Sanan `PetscLogEventDeactivate()` 2491210b5426SBarry Smith @*/ 2492d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogMPEBegin(void) 2493d71ae5a4SJacob Faibussowitsch { 2494210b5426SBarry Smith PetscFunctionBegin; 2495210b5426SBarry Smith /* Do MPE initialization */ 2496210b5426SBarry Smith if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */ 24979566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "Initializing MPE.\n")); 24989566063dSJacob Faibussowitsch PetscCall(MPE_Init_log()); 2499210b5426SBarry Smith 2500210b5426SBarry Smith PetscBeganMPE = PETSC_TRUE; 2501210b5426SBarry Smith } else { 25029566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "MPE already initialized. Not attempting to reinitialize.\n")); 2503210b5426SBarry Smith } 25049566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE)); 2505210b5426SBarry Smith PetscFunctionReturn(0); 2506210b5426SBarry Smith } 2507210b5426SBarry Smith 2508210b5426SBarry Smith /*@C 2509495fc317SBarry Smith PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot. 2510210b5426SBarry Smith 2511811af0c4SBarry Smith Collective over `PETSC_COMM_WORLD` 2512210b5426SBarry Smith 2513210b5426SBarry Smith Level: advanced 2514210b5426SBarry Smith 2515db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogMPEBegin()` 2516210b5426SBarry Smith @*/ 2517d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogMPEDump(const char sname[]) 2518d71ae5a4SJacob Faibussowitsch { 2519210b5426SBarry Smith char name[PETSC_MAX_PATH_LEN]; 2520210b5426SBarry Smith 2521210b5426SBarry Smith PetscFunctionBegin; 2522210b5426SBarry Smith if (PetscBeganMPE) { 25239566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "Finalizing MPE.\n")); 2524210b5426SBarry Smith if (sname) { 25259566063dSJacob Faibussowitsch PetscCall(PetscStrcpy(name, sname)); 2526210b5426SBarry Smith } else { 25279566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(name, sizeof(name))); 2528210b5426SBarry Smith } 25299566063dSJacob Faibussowitsch PetscCall(MPE_Finish_log(name)); 2530210b5426SBarry Smith } else { 25319566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "Not finalizing MPE (not started by PETSc).\n")); 2532210b5426SBarry Smith } 2533210b5426SBarry Smith PetscFunctionReturn(0); 2534210b5426SBarry Smith } 2535210b5426SBarry Smith 2536210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39 25379371c9d4SSatish Balay static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = {"OliveDrab: ", "BlueViolet: ", "CadetBlue: ", "CornflowerBlue: ", "DarkGoldenrod: ", "DarkGreen: ", "DarkKhaki: ", "DarkOliveGreen: ", 25389371c9d4SSatish Balay "DarkOrange: ", "DarkOrchid: ", "DarkSeaGreen: ", "DarkSlateGray: ", "DarkTurquoise: ", "DeepPink: ", "DarkKhaki: ", "DimGray: ", 25399371c9d4SSatish Balay "DodgerBlue: ", "GreenYellow: ", "HotPink: ", "IndianRed: ", "LavenderBlush: ", "LawnGreen: ", "LemonChiffon: ", "LightCoral: ", 25409371c9d4SSatish Balay "LightCyan: ", "LightPink: ", "LightSalmon: ", "LightSlateGray: ", "LightYellow: ", "LimeGreen: ", "MediumPurple: ", "MediumSeaGreen: ", 25419371c9d4SSatish Balay "MediumSlateBlue:", "MidnightBlue: ", "MintCream: ", "MistyRose: ", "NavajoWhite: ", "NavyBlue: ", "OliveDrab: "}; 2542210b5426SBarry Smith 2543210b5426SBarry Smith /*@C 2544811af0c4SBarry Smith PetscLogMPEGetRGBColor - This routine returns a rgb color useable with `PetscLogEventRegister()` 2545210b5426SBarry Smith 2546210b5426SBarry Smith Not collective. Maybe it should be? 2547210b5426SBarry Smith 25487a7aea1fSJed Brown Output Parameter: 2549210b5426SBarry Smith . str - character string representing the color 2550210b5426SBarry Smith 2551210b5426SBarry Smith Level: developer 2552210b5426SBarry Smith 2553811af0c4SBarry Smith .seealso: `PetscLogEventRegister()` 2554210b5426SBarry Smith @*/ 2555d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogMPEGetRGBColor(const char *str[]) 2556d71ae5a4SJacob Faibussowitsch { 2557210b5426SBarry Smith static int idx = 0; 2558210b5426SBarry Smith 2559210b5426SBarry Smith PetscFunctionBegin; 2560210b5426SBarry Smith *str = PetscLogMPERGBColors[idx]; 2561210b5426SBarry Smith idx = (idx + 1) % PETSC_RGB_COLORS_MAX; 2562210b5426SBarry Smith PetscFunctionReturn(0); 2563210b5426SBarry Smith } 2564210b5426SBarry Smith 2565210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */ 2566