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> 14*a0c7f9aaSSamuel Khuvis #if defined(PETSC_HAVE_TAU_PERFSTUBS) 15*a0c7f9aaSSamuel Khuvis #include <../src/sys/perfstubs/timer.h> 16*a0c7f9aaSSamuel Khuvis #endif 175c6c1daeSBarry Smith 185c6c1daeSBarry Smith PetscLogEvent PETSC_LARGEST_EVENT = PETSC_EVENT; 195c6c1daeSBarry Smith 205c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 215c6c1daeSBarry Smith #include <petscmachineinfo.h> 225c6c1daeSBarry Smith #include <petscconfiginfo.h> 235c6c1daeSBarry Smith 245c6c1daeSBarry Smith /* used in the MPI_XXX() count macros in petsclog.h */ 255c6c1daeSBarry Smith 265c6c1daeSBarry Smith /* Action and object logging variables */ 270298fd71SBarry Smith Action *petsc_actions = NULL; 280298fd71SBarry Smith Object *petsc_objects = NULL; 295c6c1daeSBarry Smith PetscBool petsc_logActions = PETSC_FALSE; 305c6c1daeSBarry Smith PetscBool petsc_logObjects = PETSC_FALSE; 315c6c1daeSBarry Smith int petsc_numActions = 0, petsc_maxActions = 100; 325c6c1daeSBarry Smith int petsc_numObjects = 0, petsc_maxObjects = 100; 335c6c1daeSBarry Smith int petsc_numObjectsDestroyed = 0; 345c6c1daeSBarry Smith 355c6c1daeSBarry Smith /* Global counters */ 365c6c1daeSBarry Smith PetscLogDouble petsc_BaseTime = 0.0; 375c6c1daeSBarry Smith PetscLogDouble petsc_TotalFlops = 0.0; /* The number of flops */ 385c6c1daeSBarry Smith PetscLogDouble petsc_tmp_flops = 0.0; /* The incremental number of flops */ 395c6c1daeSBarry Smith PetscLogDouble petsc_send_ct = 0.0; /* The number of sends */ 405c6c1daeSBarry Smith PetscLogDouble petsc_recv_ct = 0.0; /* The number of receives */ 415c6c1daeSBarry Smith PetscLogDouble petsc_send_len = 0.0; /* The total length of all sent messages */ 425c6c1daeSBarry Smith PetscLogDouble petsc_recv_len = 0.0; /* The total length of all received messages */ 435c6c1daeSBarry Smith PetscLogDouble petsc_isend_ct = 0.0; /* The number of immediate sends */ 445c6c1daeSBarry Smith PetscLogDouble petsc_irecv_ct = 0.0; /* The number of immediate receives */ 455c6c1daeSBarry Smith PetscLogDouble petsc_isend_len = 0.0; /* The total length of all immediate send messages */ 465c6c1daeSBarry Smith PetscLogDouble petsc_irecv_len = 0.0; /* The total length of all immediate receive messages */ 475c6c1daeSBarry Smith PetscLogDouble petsc_wait_ct = 0.0; /* The number of waits */ 485c6c1daeSBarry Smith PetscLogDouble petsc_wait_any_ct = 0.0; /* The number of anywaits */ 495c6c1daeSBarry Smith PetscLogDouble petsc_wait_all_ct = 0.0; /* The number of waitalls */ 505c6c1daeSBarry Smith PetscLogDouble petsc_sum_of_waits_ct = 0.0; /* The total number of waits */ 515c6c1daeSBarry Smith PetscLogDouble petsc_allreduce_ct = 0.0; /* The number of reductions */ 525c6c1daeSBarry Smith PetscLogDouble petsc_gather_ct = 0.0; /* The number of gathers and gathervs */ 535c6c1daeSBarry Smith PetscLogDouble petsc_scatter_ct = 0.0; /* The number of scatters and scattervs */ 5420c24465SJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 55bec0b493Shannah_mairs PetscLogDouble petsc_ctog_ct = 0.0; /* The total number of CPU to GPU copies */ 56bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_ct = 0.0; /* The total number of GPU to CPU copies */ 57bec0b493Shannah_mairs PetscLogDouble petsc_ctog_sz = 0.0; /* The total size of CPU to GPU copies */ 58bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_sz = 0.0; /* The total size of GPU to CPU copies */ 5945c4b7c1SBarry Smith PetscLogDouble petsc_ctog_ct_scalar = 0.0; /* The total number of CPU to GPU copies */ 6045c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_ct_scalar = 0.0; /* The total number of GPU to CPU copies */ 6145c4b7c1SBarry Smith PetscLogDouble petsc_ctog_sz_scalar = 0.0; /* The total size of CPU to GPU copies */ 6245c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_sz_scalar = 0.0; /* The total size of GPU to CPU copies */ 63958c4211Shannah_mairs PetscLogDouble petsc_gflops = 0.0; /* The flops done on a GPU */ 64958c4211Shannah_mairs PetscLogDouble petsc_gtime = 0.0; /* The time spent on a GPU */ 65bec0b493Shannah_mairs #endif 665c6c1daeSBarry Smith 675c6c1daeSBarry Smith /* Logging functions */ 680298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL; 690298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL; 700298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 710298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 725c6c1daeSBarry Smith 735c6c1daeSBarry Smith /* Tracing event logging variables */ 740298fd71SBarry Smith FILE *petsc_tracefile = NULL; 755c6c1daeSBarry Smith int petsc_tracelevel = 0; 765c6c1daeSBarry Smith const char *petsc_traceblanks = " "; 775c6c1daeSBarry Smith char petsc_tracespace[128] = " "; 785c6c1daeSBarry Smith PetscLogDouble petsc_tracetime = 0.0; 79896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE; 805c6c1daeSBarry Smith 817a101e5eSJacob Faibussowitsch static PetscIntStack current_log_event_stack = NULL; 827a101e5eSJacob Faibussowitsch 83d71ae5a4SJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogInitialize(void) 84d71ae5a4SJacob Faibussowitsch { 85fa2bb9feSLisandro Dalcin int stage; 86fa2bb9feSLisandro Dalcin PetscBool opt; 875c6c1daeSBarry Smith 88fa2bb9feSLisandro Dalcin PetscFunctionBegin; 89fa2bb9feSLisandro Dalcin if (PetscLogInitializeCalled) PetscFunctionReturn(0); 90fa2bb9feSLisandro Dalcin PetscLogInitializeCalled = PETSC_TRUE; 915c6c1daeSBarry Smith 927a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackCreate(¤t_log_event_stack)); 939566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL, NULL, "-log_exclude_actions", &opt)); 94fa2bb9feSLisandro Dalcin if (opt) petsc_logActions = PETSC_FALSE; 959566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL, NULL, "-log_exclude_objects", &opt)); 96fa2bb9feSLisandro Dalcin if (opt) petsc_logObjects = PETSC_FALSE; 9748a46eb9SPierre Jolivet if (petsc_logActions) PetscCall(PetscMalloc1(petsc_maxActions, &petsc_actions)); 9848a46eb9SPierre Jolivet if (petsc_logObjects) PetscCall(PetscMalloc1(petsc_maxObjects, &petsc_objects)); 99fa2bb9feSLisandro Dalcin PetscLogPHC = PetscLogObjCreateDefault; 100fa2bb9feSLisandro Dalcin PetscLogPHD = PetscLogObjDestroyDefault; 101fa2bb9feSLisandro Dalcin /* Setup default logging structures */ 1029566063dSJacob Faibussowitsch PetscCall(PetscStageLogCreate(&petsc_stageLog)); 1039566063dSJacob Faibussowitsch PetscCall(PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage)); 1045c6c1daeSBarry Smith 105fa2bb9feSLisandro Dalcin /* All processors sync here for more consistent logging */ 1069566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(PETSC_COMM_WORLD)); 107fa2bb9feSLisandro Dalcin PetscTime(&petsc_BaseTime); 1089566063dSJacob Faibussowitsch PetscCall(PetscLogStagePush(stage)); 109*a0c7f9aaSSamuel Khuvis #if defined(PETSC_HAVE_TAU_PERFSTUBS) 110*a0c7f9aaSSamuel Khuvis PetscStackCallExternalVoid("ps_initialize_", ps_initialize_()); 111*a0c7f9aaSSamuel Khuvis #endif 112fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 113fa2bb9feSLisandro Dalcin } 1145c6c1daeSBarry Smith 115d71ae5a4SJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogFinalize(void) 116d71ae5a4SJacob Faibussowitsch { 1175c6c1daeSBarry Smith PetscStageLog stageLog; 1185c6c1daeSBarry Smith 1195c6c1daeSBarry Smith PetscFunctionBegin; 1209566063dSJacob Faibussowitsch PetscCall(PetscFree(petsc_actions)); 1219566063dSJacob Faibussowitsch PetscCall(PetscFree(petsc_objects)); 1229566063dSJacob Faibussowitsch PetscCall(PetscLogNestedEnd()); 1239566063dSJacob Faibussowitsch PetscCall(PetscLogSet(NULL, NULL)); 1245c6c1daeSBarry Smith 1255c6c1daeSBarry Smith /* Resetting phase */ 1269566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 1279566063dSJacob Faibussowitsch PetscCall(PetscStageLogDestroy(stageLog)); 1287a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackDestroy(current_log_event_stack)); 1297a101e5eSJacob Faibussowitsch current_log_event_stack = NULL; 130a297a907SKarl Rupp 1315c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1325c6c1daeSBarry Smith petsc_numActions = 0; 1335c6c1daeSBarry Smith petsc_numObjects = 0; 1345c6c1daeSBarry Smith petsc_numObjectsDestroyed = 0; 1355c6c1daeSBarry Smith petsc_maxActions = 100; 1365c6c1daeSBarry Smith petsc_maxObjects = 100; 1370298fd71SBarry Smith petsc_actions = NULL; 1380298fd71SBarry Smith petsc_objects = NULL; 1395c6c1daeSBarry Smith petsc_logActions = PETSC_FALSE; 1405c6c1daeSBarry Smith petsc_logObjects = PETSC_FALSE; 1415c6c1daeSBarry Smith petsc_BaseTime = 0.0; 1425c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1435c6c1daeSBarry Smith petsc_tmp_flops = 0.0; 1445c6c1daeSBarry Smith petsc_send_ct = 0.0; 1455c6c1daeSBarry Smith petsc_recv_ct = 0.0; 1465c6c1daeSBarry Smith petsc_send_len = 0.0; 1475c6c1daeSBarry Smith petsc_recv_len = 0.0; 1485c6c1daeSBarry Smith petsc_isend_ct = 0.0; 1495c6c1daeSBarry Smith petsc_irecv_ct = 0.0; 1505c6c1daeSBarry Smith petsc_isend_len = 0.0; 1515c6c1daeSBarry Smith petsc_irecv_len = 0.0; 1525c6c1daeSBarry Smith petsc_wait_ct = 0.0; 1535c6c1daeSBarry Smith petsc_wait_any_ct = 0.0; 1545c6c1daeSBarry Smith petsc_wait_all_ct = 0.0; 1555c6c1daeSBarry Smith petsc_sum_of_waits_ct = 0.0; 1565c6c1daeSBarry Smith petsc_allreduce_ct = 0.0; 1575c6c1daeSBarry Smith petsc_gather_ct = 0.0; 1585c6c1daeSBarry Smith petsc_scatter_ct = 0.0; 159d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 160bec0b493Shannah_mairs petsc_ctog_ct = 0.0; 161bec0b493Shannah_mairs petsc_gtoc_ct = 0.0; 162bec0b493Shannah_mairs petsc_ctog_sz = 0.0; 163bec0b493Shannah_mairs petsc_gtoc_sz = 0.0; 164958c4211Shannah_mairs petsc_gflops = 0.0; 165958c4211Shannah_mairs petsc_gtime = 0.0; 166bec0b493Shannah_mairs #endif 1675c6c1daeSBarry Smith PETSC_LARGEST_EVENT = PETSC_EVENT; 1680298fd71SBarry Smith PetscLogPHC = NULL; 1690298fd71SBarry Smith PetscLogPHD = NULL; 1700298fd71SBarry Smith petsc_tracefile = NULL; 1715c6c1daeSBarry Smith petsc_tracelevel = 0; 1725c6c1daeSBarry Smith petsc_traceblanks = " "; 1739371c9d4SSatish Balay petsc_tracespace[0] = ' '; 1749371c9d4SSatish Balay petsc_tracespace[1] = 0; 1755c6c1daeSBarry Smith petsc_tracetime = 0.0; 1765c6c1daeSBarry Smith PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 1775c6c1daeSBarry Smith PETSC_OBJECT_CLASSID = 0; 17802c9f0b5SLisandro Dalcin petsc_stageLog = NULL; 179896238b9SBarry Smith PetscLogInitializeCalled = PETSC_FALSE; 1805c6c1daeSBarry Smith PetscFunctionReturn(0); 1815c6c1daeSBarry Smith } 1825c6c1daeSBarry Smith 1835c6c1daeSBarry Smith /*@C 1845c6c1daeSBarry Smith PetscLogSet - Sets the logging functions called at the beginning and ending of every event. 1855c6c1daeSBarry Smith 1865c6c1daeSBarry Smith Not Collective 1875c6c1daeSBarry Smith 1885c6c1daeSBarry Smith Input Parameters: 1895c6c1daeSBarry Smith + b - The function called at beginning of event 1905c6c1daeSBarry Smith - e - The function called at end of event 1915c6c1daeSBarry Smith 1925c6c1daeSBarry Smith Level: developer 1935c6c1daeSBarry Smith 194811af0c4SBarry Smith Developer Note: 195811af0c4SBarry Smith The default loggers are `PetscLogEventBeginDefault()` and `PetscLogEventEndDefault()`. 196811af0c4SBarry Smith 197811af0c4SBarry Smith .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogTraceBegin()`, `PetscLogEventBeginDefault()`, `PetscLogEventEndDefault()` 1985c6c1daeSBarry Smith @*/ 199d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject)) 200d71ae5a4SJacob Faibussowitsch { 2015c6c1daeSBarry Smith PetscFunctionBegin; 2025c6c1daeSBarry Smith PetscLogPLB = b; 2035c6c1daeSBarry Smith PetscLogPLE = e; 2045c6c1daeSBarry Smith PetscFunctionReturn(0); 2055c6c1daeSBarry Smith } 2065c6c1daeSBarry Smith 2075c6c1daeSBarry Smith /*@C 2084dd65854SConnor Ward PetscLogIsActive - Check if logging is currently in progress. 2094dd65854SConnor Ward 2104dd65854SConnor Ward Not Collective 2114dd65854SConnor Ward 2124dd65854SConnor Ward Output Parameter: 213811af0c4SBarry Smith . isActive - `PETSC_TRUE` if logging is in progress, `PETSC_FALSE` otherwise 2144dd65854SConnor Ward 2154dd65854SConnor Ward Level: beginner 2164dd65854SConnor Ward 217db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogSet()` 2184dd65854SConnor Ward @*/ 219d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogIsActive(PetscBool *isActive) 220d71ae5a4SJacob Faibussowitsch { 2214dd65854SConnor Ward PetscFunctionBegin; 2224dd65854SConnor Ward *isActive = (PetscLogPLB && PetscLogPLE) ? PETSC_TRUE : PETSC_FALSE; 2234dd65854SConnor Ward PetscFunctionReturn(0); 2244dd65854SConnor Ward } 2254dd65854SConnor Ward 2264dd65854SConnor Ward /*@C 227811af0c4SBarry Smith PetscLogDefaultBegin - Turns on logging of objects and events using the default logging functions `PetscLogEventBeginDefault()` and `PetscLogEventEndDefault()`. This logs flop 2285c6c1daeSBarry Smith rates and object creation and should not slow programs down too much. 2295c6c1daeSBarry Smith This routine may be called more than once. 2305c6c1daeSBarry Smith 231811af0c4SBarry Smith Logically Collective over `PETSC_COMM_WORLD` 2325c6c1daeSBarry Smith 233811af0c4SBarry Smith Options Database Key: 234a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the 235a2553e36SBarry Smith screen (for code configured with --with-log=1 (which is the default)) 2365c6c1daeSBarry Smith 2375c6c1daeSBarry Smith Usage: 2385c6c1daeSBarry Smith .vb 2395c6c1daeSBarry Smith PetscInitialize(...); 240bb1d7374SBarry Smith PetscLogDefaultBegin(); 2415c6c1daeSBarry Smith ... code ... 2425c6c1daeSBarry Smith PetscLogView(viewer); or PetscLogDump(); 2435c6c1daeSBarry Smith PetscFinalize(); 2445c6c1daeSBarry Smith .ve 2455c6c1daeSBarry Smith 246811af0c4SBarry Smith Note: 247811af0c4SBarry Smith `PetscLogView()` or `PetscLogDump()` actually cause the printing of 2485c6c1daeSBarry Smith the logging information. 2495c6c1daeSBarry Smith 2505c6c1daeSBarry Smith Level: advanced 2515c6c1daeSBarry Smith 252db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogView()`, `PetscLogTraceBegin()` 2535c6c1daeSBarry Smith @*/ 254d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogDefaultBegin(void) 255d71ae5a4SJacob Faibussowitsch { 2565c6c1daeSBarry Smith PetscFunctionBegin; 2579566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault)); 2585c6c1daeSBarry Smith PetscFunctionReturn(0); 2595c6c1daeSBarry Smith } 2605c6c1daeSBarry Smith 2615c6c1daeSBarry Smith /*@C 2625c6c1daeSBarry Smith PetscLogAllBegin - Turns on extensive logging of objects and events. Logs 2635c6c1daeSBarry Smith all events. This creates large log files and slows the program down. 2645c6c1daeSBarry Smith 265811af0c4SBarry Smith Logically Collective on `PETSC_COMM_WORLD` 2665c6c1daeSBarry Smith 267811af0c4SBarry Smith Options Database Key: 268a2553e36SBarry Smith . -log_all - Prints extensive log information 2695c6c1daeSBarry Smith 2705c6c1daeSBarry Smith Usage: 2715c6c1daeSBarry Smith .vb 2725c6c1daeSBarry Smith PetscInitialize(...); 2735c6c1daeSBarry Smith PetscLogAllBegin(); 2745c6c1daeSBarry Smith ... code ... 2755c6c1daeSBarry Smith PetscLogDump(filename); 2765c6c1daeSBarry Smith PetscFinalize(); 2775c6c1daeSBarry Smith .ve 2785c6c1daeSBarry Smith 279811af0c4SBarry Smith Note: 280811af0c4SBarry Smith A related routine is `PetscLogDefaultBegin()` (with the options key -log_view), which is 2815c6c1daeSBarry Smith intended for production runs since it logs only flop rates and object 2825c6c1daeSBarry Smith creation (and shouldn't significantly slow the programs). 2835c6c1daeSBarry Smith 2845c6c1daeSBarry Smith Level: advanced 2855c6c1daeSBarry Smith 286db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogTraceBegin()` 2875c6c1daeSBarry Smith @*/ 288d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogAllBegin(void) 289d71ae5a4SJacob Faibussowitsch { 2905c6c1daeSBarry Smith PetscFunctionBegin; 2919566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete)); 2925c6c1daeSBarry Smith PetscFunctionReturn(0); 2935c6c1daeSBarry Smith } 2945c6c1daeSBarry Smith 295956f8c0dSBarry Smith /*@C 2965c6c1daeSBarry Smith PetscLogTraceBegin - Activates trace logging. Every time a PETSc event 2975c6c1daeSBarry Smith begins or ends, the event name is printed. 2985c6c1daeSBarry Smith 299811af0c4SBarry Smith Logically Collective on `PETSC_COMM_WORLD` 3005c6c1daeSBarry Smith 3015c6c1daeSBarry Smith Input Parameter: 3025c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout) 3035c6c1daeSBarry Smith 3045c6c1daeSBarry Smith Options Database Key: 305811af0c4SBarry Smith . -log_trace [filename] - Activates `PetscLogTraceBegin()` 3065c6c1daeSBarry Smith 3075c6c1daeSBarry Smith Notes: 308811af0c4SBarry Smith `PetscLogTraceBegin()` prints the processor number, the execution time (sec), 3095c6c1daeSBarry Smith then "Event begin:" or "Event end:" followed by the event name. 3105c6c1daeSBarry Smith 311811af0c4SBarry Smith `PetscLogTraceBegin()` allows tracing of all PETSc calls, which is useful 3125c6c1daeSBarry Smith to determine where a program is hanging without running in the 3135c6c1daeSBarry Smith debugger. Can be used in conjunction with the -info option. 3145c6c1daeSBarry Smith 3155c6c1daeSBarry Smith Level: intermediate 3165c6c1daeSBarry Smith 317db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogView()`, `PetscLogDefaultBegin()` 3185c6c1daeSBarry Smith @*/ 319d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogTraceBegin(FILE *file) 320d71ae5a4SJacob Faibussowitsch { 3215c6c1daeSBarry Smith PetscFunctionBegin; 3225c6c1daeSBarry Smith petsc_tracefile = file; 323a297a907SKarl Rupp 3249566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace)); 3255c6c1daeSBarry Smith PetscFunctionReturn(0); 3265c6c1daeSBarry Smith } 3275c6c1daeSBarry Smith 3285c6c1daeSBarry Smith /*@ 3295c6c1daeSBarry Smith PetscLogActions - Determines whether actions are logged for the graphical viewer. 3305c6c1daeSBarry Smith 3315c6c1daeSBarry Smith Not Collective 3325c6c1daeSBarry Smith 3335c6c1daeSBarry Smith Input Parameter: 334811af0c4SBarry Smith . flag - `PETSC_TRUE` if actions are to be logged 335811af0c4SBarry Smith 336811af0c4SBarry Smith Options Database Key: 337811af0c4SBarry Smith . -log_exclude_actions - Turns off actions logging 3385c6c1daeSBarry Smith 3395c6c1daeSBarry Smith Level: intermediate 3405c6c1daeSBarry Smith 341811af0c4SBarry Smith Note: 342811af0c4SBarry Smith Logging of actions continues to consume more memory as the program 3435c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 344db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()` 3455c6c1daeSBarry Smith @*/ 346d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogActions(PetscBool flag) 347d71ae5a4SJacob Faibussowitsch { 3485c6c1daeSBarry Smith PetscFunctionBegin; 3495c6c1daeSBarry Smith petsc_logActions = flag; 3505c6c1daeSBarry Smith PetscFunctionReturn(0); 3515c6c1daeSBarry Smith } 3525c6c1daeSBarry Smith 3535c6c1daeSBarry Smith /*@ 3545c6c1daeSBarry Smith PetscLogObjects - Determines whether objects are logged for the graphical viewer. 3555c6c1daeSBarry Smith 3565c6c1daeSBarry Smith Not Collective 3575c6c1daeSBarry Smith 3585c6c1daeSBarry Smith Input Parameter: 359811af0c4SBarry Smith . flag - `PETSC_TRUE` if objects are to be logged 360811af0c4SBarry Smith 361811af0c4SBarry Smith Options Database Key: 362811af0c4SBarry Smith . -log_exclude_objects - Turns off objects logging 3635c6c1daeSBarry Smith 3645c6c1daeSBarry Smith Level: intermediate 3655c6c1daeSBarry Smith 366811af0c4SBarry Smith Note: 367811af0c4SBarry Smith Logging of objects continues to consume more memory as the program 3685c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3695c6c1daeSBarry Smith 370db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()` 3715c6c1daeSBarry Smith @*/ 372d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogObjects(PetscBool flag) 373d71ae5a4SJacob Faibussowitsch { 3745c6c1daeSBarry Smith PetscFunctionBegin; 3755c6c1daeSBarry Smith petsc_logObjects = flag; 3765c6c1daeSBarry Smith PetscFunctionReturn(0); 3775c6c1daeSBarry Smith } 3785c6c1daeSBarry Smith 3795c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/ 3805c6c1daeSBarry Smith /*@C 38174c0405dSRichard Tran Mills PetscLogStageRegister - Attaches a character string name to a logging stage. 3825c6c1daeSBarry Smith 3835c6c1daeSBarry Smith Not Collective 3845c6c1daeSBarry Smith 3855c6c1daeSBarry Smith Input Parameter: 3865c6c1daeSBarry Smith . sname - The name to associate with that stage 3875c6c1daeSBarry Smith 3885c6c1daeSBarry Smith Output Parameter: 3895c6c1daeSBarry Smith . stage - The stage number 3905c6c1daeSBarry Smith 3915c6c1daeSBarry Smith Level: intermediate 3925c6c1daeSBarry Smith 393db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()` 3945c6c1daeSBarry Smith @*/ 395d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageRegister(const char sname[], PetscLogStage *stage) 396d71ae5a4SJacob Faibussowitsch { 3975c6c1daeSBarry Smith PetscStageLog stageLog; 3985c6c1daeSBarry Smith PetscLogEvent event; 3995c6c1daeSBarry Smith 4005c6c1daeSBarry Smith PetscFunctionBegin; 4019566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 4029566063dSJacob Faibussowitsch PetscCall(PetscStageLogRegister(stageLog, sname, stage)); 4035c6c1daeSBarry Smith /* Copy events already changed in the main stage, this sucks */ 4049566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents)); 40548a46eb9SPierre Jolivet for (event = 0; event < stageLog->eventLog->numEvents; event++) PetscCall(PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event], &stageLog->stageInfo[*stage].eventLog->eventInfo[event])); 4069566063dSJacob Faibussowitsch PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses)); 407*a0c7f9aaSSamuel Khuvis #if defined(PETSC_HAVE_TAU_PERFSTUBS) 408*a0c7f9aaSSamuel Khuvis if (perfstubs_initialized == PERFSTUBS_SUCCESS) PetscStackCallExternalVoid("ps_timer_create_", stageLog->stageInfo[*stage].timer = ps_timer_create_(sname)); 409*a0c7f9aaSSamuel Khuvis #endif 4105c6c1daeSBarry Smith PetscFunctionReturn(0); 4115c6c1daeSBarry Smith } 4125c6c1daeSBarry Smith 4135c6c1daeSBarry Smith /*@C 414811af0c4SBarry Smith PetscLogStagePush - This function pushes a stage on the logging stack. Events started and stopped until `PetscLogStagePop()` will be associated with the stage 4155c6c1daeSBarry Smith 4165c6c1daeSBarry Smith Not Collective 4175c6c1daeSBarry Smith 4185c6c1daeSBarry Smith Input Parameter: 4195c6c1daeSBarry Smith . stage - The stage on which to log 4205c6c1daeSBarry Smith 4215c6c1daeSBarry Smith Usage: 422811af0c4SBarry Smith If the option -log_view is used to run the program containing the 4235c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4245c6c1daeSBarry Smith PetscFinalize(). 4255c6c1daeSBarry Smith .vb 4265c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4275c6c1daeSBarry Smith [stage 0 of code] 4285c6c1daeSBarry Smith PetscLogStagePush(1); 4295c6c1daeSBarry Smith [stage 1 of code] 4305c6c1daeSBarry Smith PetscLogStagePop(); 4315c6c1daeSBarry Smith PetscBarrier(...); 4325c6c1daeSBarry Smith [more stage 0 of code] 4335c6c1daeSBarry Smith PetscFinalize(); 4345c6c1daeSBarry Smith .ve 4355c6c1daeSBarry Smith 436811af0c4SBarry Smith Note: 437811af0c4SBarry Smith Use `PetscLogStageRegister()` to register a stage. 4385c6c1daeSBarry Smith 4395c6c1daeSBarry Smith Level: intermediate 4405c6c1daeSBarry Smith 441db781477SPatrick Sanan .seealso: `PetscLogStagePop()`, `PetscLogStageRegister()`, `PetscBarrier()` 4425c6c1daeSBarry Smith @*/ 443d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStagePush(PetscLogStage stage) 444d71ae5a4SJacob Faibussowitsch { 4455c6c1daeSBarry Smith PetscStageLog stageLog; 4465c6c1daeSBarry Smith 4475c6c1daeSBarry Smith PetscFunctionBegin; 4489566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 4499566063dSJacob Faibussowitsch PetscCall(PetscStageLogPush(stageLog, stage)); 450*a0c7f9aaSSamuel Khuvis #if defined(PETSC_HAVE_TAU_PERFSTUBS) 451*a0c7f9aaSSamuel Khuvis if (perfstubs_initialized == PERFSTUBS_SUCCESS && stageLog->stageInfo[stage].timer != NULL) PetscStackCallExternalVoid("ps_timer_start_", ps_timer_start_(stageLog->stageInfo[stage].timer)); 452*a0c7f9aaSSamuel Khuvis #endif 4535c6c1daeSBarry Smith PetscFunctionReturn(0); 4545c6c1daeSBarry Smith } 4555c6c1daeSBarry Smith 4565c6c1daeSBarry Smith /*@C 457811af0c4SBarry Smith PetscLogStagePop - This function pops a stage from the logging stack that was pushed with `PetscLogStagePush()` 4585c6c1daeSBarry Smith 4595c6c1daeSBarry Smith Not Collective 4605c6c1daeSBarry Smith 4615c6c1daeSBarry Smith Usage: 462811af0c4SBarry Smith If the option -log_view is used to run the program containing the 4635c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4645c6c1daeSBarry Smith PetscFinalize(). 4655c6c1daeSBarry Smith .vb 4665c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4675c6c1daeSBarry Smith [stage 0 of code] 4685c6c1daeSBarry Smith PetscLogStagePush(1); 4695c6c1daeSBarry Smith [stage 1 of code] 4705c6c1daeSBarry Smith PetscLogStagePop(); 4715c6c1daeSBarry Smith PetscBarrier(...); 4725c6c1daeSBarry Smith [more stage 0 of code] 4735c6c1daeSBarry Smith PetscFinalize(); 4745c6c1daeSBarry Smith .ve 4755c6c1daeSBarry Smith 4765c6c1daeSBarry Smith Level: intermediate 4775c6c1daeSBarry Smith 478db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStageRegister()`, `PetscBarrier()` 4795c6c1daeSBarry Smith @*/ 480d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStagePop(void) 481d71ae5a4SJacob Faibussowitsch { 4825c6c1daeSBarry Smith PetscStageLog stageLog; 4835c6c1daeSBarry Smith 4845c6c1daeSBarry Smith PetscFunctionBegin; 4859566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 486*a0c7f9aaSSamuel Khuvis #if defined(PETSC_HAVE_TAU_PERFSTUBS) 487*a0c7f9aaSSamuel Khuvis if (perfstubs_initialized == PERFSTUBS_SUCCESS && stageLog->stageInfo[stageLog->curStage].timer != NULL) PetscStackCallExternalVoid("ps_timer_stop_", ps_timer_stop_(stageLog->stageInfo[stageLog->curStage].timer)); 488*a0c7f9aaSSamuel Khuvis #endif 4899566063dSJacob Faibussowitsch PetscCall(PetscStageLogPop(stageLog)); 4905c6c1daeSBarry Smith PetscFunctionReturn(0); 4915c6c1daeSBarry Smith } 4925c6c1daeSBarry Smith 4935c6c1daeSBarry Smith /*@ 494811af0c4SBarry Smith PetscLogStageSetActive - Sets if a stage is used for `PetscLogEventBegin()` and `PetscLogEventEnd()`. 4955c6c1daeSBarry Smith 4965c6c1daeSBarry Smith Not Collective 4975c6c1daeSBarry Smith 4985c6c1daeSBarry Smith Input Parameters: 4995c6c1daeSBarry Smith + stage - The stage 500811af0c4SBarry Smith - isActive - The activity flag, `PETSC_TRUE` for logging, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 5015c6c1daeSBarry Smith 5025c6c1daeSBarry Smith Level: intermediate 5035c6c1daeSBarry Smith 504811af0c4SBarry Smith Note: 505811af0c4SBarry Smith If this is set to `PETSC_FALSE` the logging acts as if the stage did not exist 506811af0c4SBarry Smith 507811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 5085c6c1daeSBarry Smith @*/ 509d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive) 510d71ae5a4SJacob Faibussowitsch { 5115c6c1daeSBarry Smith PetscStageLog stageLog; 5125c6c1daeSBarry Smith 5135c6c1daeSBarry Smith PetscFunctionBegin; 5149566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5159566063dSJacob Faibussowitsch PetscCall(PetscStageLogSetActive(stageLog, stage, isActive)); 5165c6c1daeSBarry Smith PetscFunctionReturn(0); 5175c6c1daeSBarry Smith } 5185c6c1daeSBarry Smith 5195c6c1daeSBarry Smith /*@ 520811af0c4SBarry Smith PetscLogStageGetActive - Checks if a stage is used for `PetscLogEventBegin()` and `PetscLogEventEnd()`. 5215c6c1daeSBarry Smith 5225c6c1daeSBarry Smith Not Collective 5235c6c1daeSBarry Smith 5245c6c1daeSBarry Smith Input Parameter: 5255c6c1daeSBarry Smith . stage - The stage 5265c6c1daeSBarry Smith 5275c6c1daeSBarry Smith Output Parameter: 528811af0c4SBarry Smith . isActive - The activity flag, `PETSC_TRUE` for logging, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 5295c6c1daeSBarry Smith 5305c6c1daeSBarry Smith Level: intermediate 5315c6c1daeSBarry Smith 532811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 5335c6c1daeSBarry Smith @*/ 534d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageGetActive(PetscLogStage stage, PetscBool *isActive) 535d71ae5a4SJacob Faibussowitsch { 5365c6c1daeSBarry Smith PetscStageLog stageLog; 5375c6c1daeSBarry Smith 5385c6c1daeSBarry Smith PetscFunctionBegin; 5399566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5409566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetActive(stageLog, stage, isActive)); 5415c6c1daeSBarry Smith PetscFunctionReturn(0); 5425c6c1daeSBarry Smith } 5435c6c1daeSBarry Smith 5445c6c1daeSBarry Smith /*@ 545811af0c4SBarry Smith PetscLogStageSetVisible - Determines stage visibility in `PetscLogView()` 5465c6c1daeSBarry Smith 5475c6c1daeSBarry Smith Not Collective 5485c6c1daeSBarry Smith 5495c6c1daeSBarry Smith Input Parameters: 5505c6c1daeSBarry Smith + stage - The stage 551811af0c4SBarry Smith - isVisible - The visibility flag, `PETSC_TRUE` to print, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 5525c6c1daeSBarry Smith 5535c6c1daeSBarry Smith Level: intermediate 5545c6c1daeSBarry Smith 555811af0c4SBarry Smith Developer Note: 556811af0c4SBarry Smith What does visible mean, needs to be documented. 557811af0c4SBarry Smith 558811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogView()` 5595c6c1daeSBarry Smith @*/ 560d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible) 561d71ae5a4SJacob Faibussowitsch { 5625c6c1daeSBarry Smith PetscStageLog stageLog; 5635c6c1daeSBarry Smith 5645c6c1daeSBarry Smith PetscFunctionBegin; 5659566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5669566063dSJacob Faibussowitsch PetscCall(PetscStageLogSetVisible(stageLog, stage, isVisible)); 5675c6c1daeSBarry Smith PetscFunctionReturn(0); 5685c6c1daeSBarry Smith } 5695c6c1daeSBarry Smith 5705c6c1daeSBarry Smith /*@ 571811af0c4SBarry Smith PetscLogStageGetVisible - Returns stage visibility in `PetscLogView()` 5725c6c1daeSBarry Smith 5735c6c1daeSBarry Smith Not Collective 5745c6c1daeSBarry Smith 5755c6c1daeSBarry Smith Input Parameter: 5765c6c1daeSBarry Smith . stage - The stage 5775c6c1daeSBarry Smith 5785c6c1daeSBarry Smith Output Parameter: 579811af0c4SBarry Smith . isVisible - The visibility flag, `PETSC_TRUE` to print, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 5805c6c1daeSBarry Smith 5815c6c1daeSBarry Smith Level: intermediate 5825c6c1daeSBarry Smith 583811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogView()` 5845c6c1daeSBarry Smith @*/ 585d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageGetVisible(PetscLogStage stage, PetscBool *isVisible) 586d71ae5a4SJacob Faibussowitsch { 5875c6c1daeSBarry Smith PetscStageLog stageLog; 5885c6c1daeSBarry Smith 5895c6c1daeSBarry Smith PetscFunctionBegin; 5909566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5919566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetVisible(stageLog, stage, isVisible)); 5925c6c1daeSBarry Smith PetscFunctionReturn(0); 5935c6c1daeSBarry Smith } 5945c6c1daeSBarry Smith 5955c6c1daeSBarry Smith /*@C 5965c6c1daeSBarry Smith PetscLogStageGetId - Returns the stage id when given the stage name. 5975c6c1daeSBarry Smith 5985c6c1daeSBarry Smith Not Collective 5995c6c1daeSBarry Smith 6005c6c1daeSBarry Smith Input Parameter: 6015c6c1daeSBarry Smith . name - The stage name 6025c6c1daeSBarry Smith 6035c6c1daeSBarry Smith Output Parameter: 6045a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists 6055c6c1daeSBarry Smith 6065c6c1daeSBarry Smith Level: intermediate 6075c6c1daeSBarry Smith 608811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 6095c6c1daeSBarry Smith @*/ 610d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageGetId(const char name[], PetscLogStage *stage) 611d71ae5a4SJacob Faibussowitsch { 6125c6c1daeSBarry Smith PetscStageLog stageLog; 6135c6c1daeSBarry Smith 6145c6c1daeSBarry Smith PetscFunctionBegin; 6159566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 6169566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetStage(stageLog, name, stage)); 6175c6c1daeSBarry Smith PetscFunctionReturn(0); 6185c6c1daeSBarry Smith } 6195c6c1daeSBarry Smith 6205c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/ 6217a101e5eSJacob Faibussowitsch 6225c6c1daeSBarry Smith /*@C 623811af0c4SBarry Smith PetscLogEventRegister - Registers an event name for logging operations 6245c6c1daeSBarry Smith 6255c6c1daeSBarry Smith Not Collective 6265c6c1daeSBarry Smith 627d8d19677SJose E. Roman Input Parameters: 6285c6c1daeSBarry Smith + name - The name associated with the event 6295c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with 630811af0c4SBarry Smith `PetscClassIdRegister()` or use a predefined one such as `KSP_CLASSID`, `SNES_CLASSID`, the predefined ones 6315c6c1daeSBarry Smith are only available in C code 6325c6c1daeSBarry Smith 6335c6c1daeSBarry Smith Output Parameter: 634811af0c4SBarry Smith . event - The event id for use with `PetscLogEventBegin()` and `PetscLogEventEnd()`. 6355c6c1daeSBarry Smith 6365c6c1daeSBarry Smith Example of Usage: 6375c6c1daeSBarry Smith .vb 6385c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 6395c6c1daeSBarry Smith PetscClassId classid; 6405c6c1daeSBarry Smith PetscLogDouble user_event_flops; 6415c6c1daeSBarry Smith PetscClassIdRegister("class name",&classid); 6425c6c1daeSBarry Smith PetscLogEventRegister("User event name",classid,&USER_EVENT); 6435c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 6445c6c1daeSBarry Smith [code segment to monitor] 6455c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 6465c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 6475c6c1daeSBarry Smith .ve 6485c6c1daeSBarry Smith 6495c6c1daeSBarry Smith Notes: 6505c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 651a2553e36SBarry Smith configured with --with-log (which is the default) and 652811af0c4SBarry Smith -log_view or -log_all is specified. `PetscLogEventRegister()` is 6535c6c1daeSBarry Smith intended for logging user events to supplement this PETSc 6545c6c1daeSBarry Smith information. 6555c6c1daeSBarry Smith 656495fc317SBarry Smith PETSc can gather data for use with the utilities Jumpshot 6575c6c1daeSBarry Smith (part of the MPICH distribution). If PETSc has been compiled 6585c6c1daeSBarry Smith with flag -DPETSC_HAVE_MPE (MPE is an additional utility within 6595c6c1daeSBarry Smith MPICH), the user can employ another command line option, -log_mpe, 6605c6c1daeSBarry Smith to create a logfile, "mpe.log", which can be visualized 661495fc317SBarry Smith Jumpshot. 6625c6c1daeSBarry Smith 6635c6c1daeSBarry Smith The classid is associated with each event so that classes of events 6645c6c1daeSBarry Smith can be disabled simultaneously, such as all matrix events. The user 665811af0c4SBarry Smith can either use an existing classid, such as `MAT_CLASSID`, or create 6665c6c1daeSBarry Smith their own as shown in the example. 6675c6c1daeSBarry Smith 668c5deb1d5SJed Brown If an existing event with the same name exists, its event handle is 669c5deb1d5SJed Brown returned instead of creating a new event. 670c5deb1d5SJed Brown 6715c6c1daeSBarry Smith Level: intermediate 6725c6c1daeSBarry Smith 673811af0c4SBarry Smith .seealso: `PetscLogStageRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogFlops()`, 674db781477SPatrick Sanan `PetscLogEventActivate()`, `PetscLogEventDeactivate()`, `PetscClassIdRegister()` 6755c6c1daeSBarry Smith @*/ 676d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventRegister(const char name[], PetscClassId classid, PetscLogEvent *event) 677d71ae5a4SJacob Faibussowitsch { 6785c6c1daeSBarry Smith PetscStageLog stageLog; 6795c6c1daeSBarry Smith int stage; 6805c6c1daeSBarry Smith 6815c6c1daeSBarry Smith PetscFunctionBegin; 6825c6c1daeSBarry Smith *event = PETSC_DECIDE; 6839566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 6849566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, event)); 685c5deb1d5SJed Brown if (*event > 0) PetscFunctionReturn(0); 6869566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogRegister(stageLog->eventLog, name, classid, event)); 6875c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 6889566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents)); 6899566063dSJacob Faibussowitsch PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses)); 6905c6c1daeSBarry Smith } 6915c6c1daeSBarry Smith PetscFunctionReturn(0); 6925c6c1daeSBarry Smith } 6935c6c1daeSBarry Smith 6945c6c1daeSBarry Smith /*@ 695217044c2SLisandro Dalcin PetscLogEventSetCollective - Indicates that a particular event is collective. 696217044c2SLisandro Dalcin 697217044c2SLisandro Dalcin Not Collective 698217044c2SLisandro Dalcin 699d8d19677SJose E. Roman Input Parameters: 700217044c2SLisandro Dalcin + event - The event id 701d5b43468SJose E. Roman - collective - Boolean flag indicating whether a particular event is collective 702217044c2SLisandro Dalcin 703811af0c4SBarry Smith Notes: 704811af0c4SBarry Smith New events returned from `PetscLogEventRegister()` are collective by default. 705811af0c4SBarry Smith 706811af0c4SBarry Smith Collective events are handled specially if the -log_sync is used. In that case the logging saves information about 707811af0c4SBarry Smith two parts of the event; the time for all the MPI ranks to synchronize and then the time for the actual computation/communication 708811af0c4SBarry Smith to be performed. This option is useful to debug imbalance within the computations or communications 709217044c2SLisandro Dalcin 710217044c2SLisandro Dalcin Level: developer 711217044c2SLisandro Dalcin 712811af0c4SBarry Smith .seealso: `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogEventRegister()` 713217044c2SLisandro Dalcin @*/ 714d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event, PetscBool collective) 715d71ae5a4SJacob Faibussowitsch { 716217044c2SLisandro Dalcin PetscStageLog stageLog; 717217044c2SLisandro Dalcin PetscEventRegLog eventRegLog; 718217044c2SLisandro Dalcin 719217044c2SLisandro Dalcin PetscFunctionBegin; 7209566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 7219566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetEventRegLog(stageLog, &eventRegLog)); 722cc73adaaSBarry Smith PetscCheck(event >= 0 && event <= eventRegLog->numEvents, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Invalid event id"); 723217044c2SLisandro Dalcin eventRegLog->eventInfo[event].collective = collective; 724217044c2SLisandro Dalcin PetscFunctionReturn(0); 725217044c2SLisandro Dalcin } 726217044c2SLisandro Dalcin 727217044c2SLisandro Dalcin /*@ 728fa2bb9feSLisandro Dalcin PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage. 729fa2bb9feSLisandro Dalcin 730fa2bb9feSLisandro Dalcin Not Collective 731fa2bb9feSLisandro Dalcin 732fa2bb9feSLisandro Dalcin Input Parameter: 733811af0c4SBarry Smith . classid - The object class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 734fa2bb9feSLisandro Dalcin 735fa2bb9feSLisandro Dalcin Level: developer 736fa2bb9feSLisandro Dalcin 737c2e3fba1SPatrick Sanan .seealso: `PetscLogEventActivateClass()`, `PetscLogEventDeactivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 738fa2bb9feSLisandro Dalcin @*/ 739d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventIncludeClass(PetscClassId classid) 740d71ae5a4SJacob Faibussowitsch { 741fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 742fa2bb9feSLisandro Dalcin int stage; 743fa2bb9feSLisandro Dalcin 744fa2bb9feSLisandro Dalcin PetscFunctionBegin; 7459566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 74648a46eb9SPierre Jolivet for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 747fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 748fa2bb9feSLisandro Dalcin } 749fa2bb9feSLisandro Dalcin 750fa2bb9feSLisandro Dalcin /*@ 751fa2bb9feSLisandro Dalcin PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage. 752fa2bb9feSLisandro Dalcin 753fa2bb9feSLisandro Dalcin Not Collective 754fa2bb9feSLisandro Dalcin 755fa2bb9feSLisandro Dalcin Input Parameter: 756811af0c4SBarry Smith . classid - The object class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 757fa2bb9feSLisandro Dalcin 758fa2bb9feSLisandro Dalcin Level: developer 759fa2bb9feSLisandro Dalcin 760811af0c4SBarry Smith Note: 761811af0c4SBarry Smith If a class is excluded then events associated with that class are not logged. 762811af0c4SBarry Smith 763c2e3fba1SPatrick Sanan .seealso: `PetscLogEventDeactivateClass()`, `PetscLogEventActivateClass()`, `PetscLogEventDeactivate()`, `PetscLogEventActivate()` 764fa2bb9feSLisandro Dalcin @*/ 765d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventExcludeClass(PetscClassId classid) 766d71ae5a4SJacob Faibussowitsch { 767fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 768fa2bb9feSLisandro Dalcin int stage; 769fa2bb9feSLisandro Dalcin 770fa2bb9feSLisandro Dalcin PetscFunctionBegin; 7719566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 77248a46eb9SPierre Jolivet for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 773fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 774fa2bb9feSLisandro Dalcin } 775fa2bb9feSLisandro Dalcin 776fa2bb9feSLisandro Dalcin /*@ 7775c6c1daeSBarry Smith PetscLogEventActivate - Indicates that a particular event should be logged. 7785c6c1daeSBarry Smith 7795c6c1daeSBarry Smith Not Collective 7805c6c1daeSBarry Smith 7815c6c1daeSBarry Smith Input Parameter: 7825c6c1daeSBarry Smith . event - The event id 7835c6c1daeSBarry Smith 7845c6c1daeSBarry Smith Usage: 7855c6c1daeSBarry Smith .vb 7865c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 7875c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 7885c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 7895c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 7905c6c1daeSBarry Smith .ve 7915c6c1daeSBarry Smith 7925c6c1daeSBarry Smith Note: 7935c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in include/petsclog.h) 794811af0c4SBarry Smith or an event number obtained with `PetscLogEventRegister()`. 7955c6c1daeSBarry Smith 7965c6c1daeSBarry Smith Level: advanced 7975c6c1daeSBarry Smith 798db781477SPatrick Sanan .seealso: `PlogEventDeactivate()`, `PlogEventDeactivatePush()`, `PetscLogEventDeactivatePop()` 7995c6c1daeSBarry Smith @*/ 800d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventActivate(PetscLogEvent event) 801d71ae5a4SJacob Faibussowitsch { 8025c6c1daeSBarry Smith PetscStageLog stageLog; 8035c6c1daeSBarry Smith int stage; 8045c6c1daeSBarry Smith 8055c6c1daeSBarry Smith PetscFunctionBegin; 8069566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 8079566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 8089566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event)); 8095c6c1daeSBarry Smith PetscFunctionReturn(0); 8105c6c1daeSBarry Smith } 8115c6c1daeSBarry Smith 8125c6c1daeSBarry Smith /*@ 8135c6c1daeSBarry Smith PetscLogEventDeactivate - Indicates that a particular event should not be logged. 8145c6c1daeSBarry Smith 8155c6c1daeSBarry Smith Not Collective 8165c6c1daeSBarry Smith 8175c6c1daeSBarry Smith Input Parameter: 8185c6c1daeSBarry Smith . event - The event id 8195c6c1daeSBarry Smith 8205c6c1daeSBarry Smith Usage: 8215c6c1daeSBarry Smith .vb 8225c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 8235c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 8245c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 8255c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 8265c6c1daeSBarry Smith .ve 8275c6c1daeSBarry Smith 8285c6c1daeSBarry Smith Note: 8295c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in 830811af0c4SBarry Smith include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`). 8315c6c1daeSBarry Smith 8325c6c1daeSBarry Smith Level: advanced 8335c6c1daeSBarry Smith 834db781477SPatrick Sanan .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePush()`, `PetscLogEventDeactivatePop()` 8355c6c1daeSBarry Smith @*/ 836d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivate(PetscLogEvent event) 837d71ae5a4SJacob Faibussowitsch { 8385c6c1daeSBarry Smith PetscStageLog stageLog; 8395c6c1daeSBarry Smith int stage; 8405c6c1daeSBarry Smith 8415c6c1daeSBarry Smith PetscFunctionBegin; 8429566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 8439566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 8449566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event)); 8455c6c1daeSBarry Smith PetscFunctionReturn(0); 8465c6c1daeSBarry Smith } 8475c6c1daeSBarry Smith 8485c6c1daeSBarry Smith /*@ 849811af0c4SBarry Smith PetscLogEventDeactivatePush - Indicates that a particular event should not be logged until `PetscLogEventDeactivatePop()` is called 850c00cb57fSBarry Smith 851c00cb57fSBarry Smith Not Collective 852c00cb57fSBarry Smith 853c00cb57fSBarry Smith Input Parameter: 854c00cb57fSBarry Smith . event - The event id 855c00cb57fSBarry Smith 856c00cb57fSBarry Smith Usage: 857c00cb57fSBarry Smith .vb 858c00cb57fSBarry Smith PetscLogEventDeactivatePush(VEC_SetValues); 859c00cb57fSBarry Smith [code where you do not want to log VecSetValues()] 860c00cb57fSBarry Smith PetscLogEventDeactivatePop(VEC_SetValues); 861c00cb57fSBarry Smith [code where you do want to log VecSetValues()] 862c00cb57fSBarry Smith .ve 863c00cb57fSBarry Smith 864c00cb57fSBarry Smith Note: 865c00cb57fSBarry Smith The event may be either a pre-defined PETSc event (found in 866811af0c4SBarry Smith include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`). 867c00cb57fSBarry Smith 868c00cb57fSBarry Smith Level: advanced 869c00cb57fSBarry Smith 870811af0c4SBarry Smith .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePop()`, `PetscLogEventDeactivate()` 871c00cb57fSBarry Smith @*/ 872d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivatePush(PetscLogEvent event) 873d71ae5a4SJacob Faibussowitsch { 874c00cb57fSBarry Smith PetscStageLog stageLog; 875c00cb57fSBarry Smith int stage; 876c00cb57fSBarry Smith 877c00cb57fSBarry Smith PetscFunctionBegin; 8789566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 8799566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 8809566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivatePush(stageLog->stageInfo[stage].eventLog, event)); 881c00cb57fSBarry Smith PetscFunctionReturn(0); 882c00cb57fSBarry Smith } 883c00cb57fSBarry Smith 884c00cb57fSBarry Smith /*@ 885811af0c4SBarry Smith PetscLogEventDeactivatePop - Indicates that a particular event should again be logged after the logging was turned off with `PetscLogEventDeactivatePush()` 886c00cb57fSBarry Smith 887c00cb57fSBarry Smith Not Collective 888c00cb57fSBarry Smith 889c00cb57fSBarry Smith Input Parameter: 890c00cb57fSBarry Smith . event - The event id 891c00cb57fSBarry Smith 892c00cb57fSBarry Smith Usage: 893c00cb57fSBarry Smith .vb 894c00cb57fSBarry Smith PetscLogEventDeactivatePush(VEC_SetValues); 895c00cb57fSBarry Smith [code where you do not want to log VecSetValues()] 896c00cb57fSBarry Smith PetscLogEventDeactivatePop(VEC_SetValues); 897c00cb57fSBarry Smith [code where you do want to log VecSetValues()] 898c00cb57fSBarry Smith .ve 899c00cb57fSBarry Smith 900c00cb57fSBarry Smith Note: 901c00cb57fSBarry Smith The event may be either a pre-defined PETSc event (found in 902811af0c4SBarry Smith include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`). 903c00cb57fSBarry Smith 904c00cb57fSBarry Smith Level: advanced 905c00cb57fSBarry Smith 906db781477SPatrick Sanan .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePush()` 907c00cb57fSBarry Smith @*/ 908d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivatePop(PetscLogEvent event) 909d71ae5a4SJacob Faibussowitsch { 910c00cb57fSBarry Smith PetscStageLog stageLog; 911c00cb57fSBarry Smith int stage; 912c00cb57fSBarry Smith 913c00cb57fSBarry Smith PetscFunctionBegin; 9149566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9159566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 9169566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivatePop(stageLog->stageInfo[stage].eventLog, event)); 917c00cb57fSBarry Smith PetscFunctionReturn(0); 918c00cb57fSBarry Smith } 919c00cb57fSBarry Smith 920c00cb57fSBarry Smith /*@ 921811af0c4SBarry Smith PetscLogEventSetActiveAll - Turns on logging of all events 9225c6c1daeSBarry Smith 9235c6c1daeSBarry Smith Not Collective 9245c6c1daeSBarry Smith 9255c6c1daeSBarry Smith Input Parameters: 9265c6c1daeSBarry Smith + event - The event id 9275c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged 9285c6c1daeSBarry Smith 9295c6c1daeSBarry Smith Level: advanced 9305c6c1daeSBarry Smith 931c2e3fba1SPatrick Sanan .seealso: `PlogEventActivate()`, `PlogEventDeactivate()` 9325c6c1daeSBarry Smith @*/ 933d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive) 934d71ae5a4SJacob Faibussowitsch { 9355c6c1daeSBarry Smith PetscStageLog stageLog; 9365c6c1daeSBarry Smith int stage; 9375c6c1daeSBarry Smith 9385c6c1daeSBarry Smith PetscFunctionBegin; 9399566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9405c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 9415c6c1daeSBarry Smith if (isActive) { 9429566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event)); 9435c6c1daeSBarry Smith } else { 9449566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event)); 9455c6c1daeSBarry Smith } 9465c6c1daeSBarry Smith } 9475c6c1daeSBarry Smith PetscFunctionReturn(0); 9485c6c1daeSBarry Smith } 9495c6c1daeSBarry Smith 9505c6c1daeSBarry Smith /*@ 951811af0c4SBarry Smith PetscLogEventActivateClass - Activates event logging for a PETSc object class for the current stage 9525c6c1daeSBarry Smith 9535c6c1daeSBarry Smith Not Collective 9545c6c1daeSBarry Smith 9555c6c1daeSBarry Smith Input Parameter: 956811af0c4SBarry Smith . classid - The event class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 9575c6c1daeSBarry Smith 9585c6c1daeSBarry Smith Level: developer 9595c6c1daeSBarry Smith 960811af0c4SBarry Smith .seealso: `PetscLogEventIncludeClass()`, `PetscLogEventExcludeClass()`, `PetscLogEventDeactivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 9615c6c1daeSBarry Smith @*/ 962d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventActivateClass(PetscClassId classid) 963d71ae5a4SJacob Faibussowitsch { 9645c6c1daeSBarry Smith PetscStageLog stageLog; 9655c6c1daeSBarry Smith int stage; 9665c6c1daeSBarry Smith 9675c6c1daeSBarry Smith PetscFunctionBegin; 9689566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9699566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 9709566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 9715c6c1daeSBarry Smith PetscFunctionReturn(0); 9725c6c1daeSBarry Smith } 9735c6c1daeSBarry Smith 9745c6c1daeSBarry Smith /*@ 975811af0c4SBarry Smith PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class for the current stage 9765c6c1daeSBarry Smith 9775c6c1daeSBarry Smith Not Collective 9785c6c1daeSBarry Smith 9795c6c1daeSBarry Smith Input Parameter: 980811af0c4SBarry Smith . classid - The event class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 9815c6c1daeSBarry Smith 9825c6c1daeSBarry Smith Level: developer 9835c6c1daeSBarry Smith 984811af0c4SBarry Smith .seealso: `PetscLogEventIncludeClass()`, `PetscLogEventExcludeClass()`, `PetscLogEventActivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 9855c6c1daeSBarry Smith @*/ 986d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivateClass(PetscClassId classid) 987d71ae5a4SJacob Faibussowitsch { 9885c6c1daeSBarry Smith PetscStageLog stageLog; 9895c6c1daeSBarry Smith int stage; 9905c6c1daeSBarry Smith 9915c6c1daeSBarry Smith PetscFunctionBegin; 9929566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9939566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 9949566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 9955c6c1daeSBarry Smith PetscFunctionReturn(0); 9965c6c1daeSBarry Smith } 9975c6c1daeSBarry Smith 9985c6c1daeSBarry Smith /*MC 99962872c28SLisandro Dalcin PetscLogEventSync - Synchronizes the beginning of a user event. 100062872c28SLisandro Dalcin 100162872c28SLisandro Dalcin Synopsis: 100262872c28SLisandro Dalcin #include <petsclog.h> 100362872c28SLisandro Dalcin PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm) 100462872c28SLisandro Dalcin 100562872c28SLisandro Dalcin Collective 100662872c28SLisandro Dalcin 100762872c28SLisandro Dalcin Input Parameters: 100862872c28SLisandro Dalcin + e - integer associated with the event obtained from PetscLogEventRegister() 100962872c28SLisandro Dalcin - comm - an MPI communicator 101062872c28SLisandro Dalcin 101162872c28SLisandro Dalcin Usage: 101262872c28SLisandro Dalcin .vb 101362872c28SLisandro Dalcin PetscLogEvent USER_EVENT; 101462872c28SLisandro Dalcin PetscLogEventRegister("User event",0,&USER_EVENT); 101562872c28SLisandro Dalcin PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD); 101662872c28SLisandro Dalcin PetscLogEventBegin(USER_EVENT,0,0,0,0); 101762872c28SLisandro Dalcin [code segment to monitor] 101862872c28SLisandro Dalcin PetscLogEventEnd(USER_EVENT,0,0,0,0); 101962872c28SLisandro Dalcin .ve 102062872c28SLisandro Dalcin 1021811af0c4SBarry Smith Note: 102262872c28SLisandro Dalcin This routine should be called only if there is not a 1023811af0c4SBarry Smith `PetscObject` available to pass to `PetscLogEventBegin()`. 102462872c28SLisandro Dalcin 102562872c28SLisandro Dalcin Level: developer 102662872c28SLisandro Dalcin 1027db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()` 102862872c28SLisandro Dalcin M*/ 102962872c28SLisandro Dalcin 103062872c28SLisandro Dalcin /*MC 10315c6c1daeSBarry Smith PetscLogEventBegin - Logs the beginning of a user event. 10325c6c1daeSBarry Smith 10335c6c1daeSBarry Smith Synopsis: 1034aaa7dc30SBarry Smith #include <petsclog.h> 1035f2ba6396SBarry Smith PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10365c6c1daeSBarry Smith 10375c6c1daeSBarry Smith Not Collective 10385c6c1daeSBarry Smith 10395c6c1daeSBarry Smith Input Parameters: 10405c6c1daeSBarry Smith + e - integer associated with the event obtained from PetscLogEventRegister() 10415c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10425c6c1daeSBarry Smith 10435c6c1daeSBarry Smith Fortran Synopsis: 10445c6c1daeSBarry Smith void PetscLogEventBegin(int e,PetscErrorCode ierr) 10455c6c1daeSBarry Smith 10465c6c1daeSBarry Smith Usage: 10475c6c1daeSBarry Smith .vb 10485c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 10495c6c1daeSBarry Smith PetscLogDouble user_event_flops; 10505c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 10515c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 10525c6c1daeSBarry Smith [code segment to monitor] 10535c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 10545c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 10555c6c1daeSBarry Smith .ve 10565c6c1daeSBarry Smith 1057811af0c4SBarry Smith Developer Note: 1058811af0c4SBarry Smith `PetscLogEventBegin()` and `PetscLogEventBegin()` return error codes instead of explicitly handling the 1059d0609cedSBarry Smith errors that occur in the macro directly because other packages that use this macros have used them in their 1060d0609cedSBarry Smith own functions or methods that do not return error codes and it would be disruptive to change the current 1061d0609cedSBarry Smith behavior. 1062d0609cedSBarry Smith 10635c6c1daeSBarry Smith Level: intermediate 10645c6c1daeSBarry Smith 1065db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventEnd()`, `PetscLogFlops()` 10665c6c1daeSBarry Smith M*/ 10675c6c1daeSBarry Smith 10685c6c1daeSBarry Smith /*MC 10695c6c1daeSBarry Smith PetscLogEventEnd - Log the end of a user event. 10705c6c1daeSBarry Smith 10715c6c1daeSBarry Smith Synopsis: 1072aaa7dc30SBarry Smith #include <petsclog.h> 1073f2ba6396SBarry Smith PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10745c6c1daeSBarry Smith 10755c6c1daeSBarry Smith Not Collective 10765c6c1daeSBarry Smith 10775c6c1daeSBarry Smith Input Parameters: 10785c6c1daeSBarry Smith + e - integer associated with the event obtained with PetscLogEventRegister() 10795c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10805c6c1daeSBarry Smith 10815c6c1daeSBarry Smith Fortran Synopsis: 10825c6c1daeSBarry Smith void PetscLogEventEnd(int e,PetscErrorCode ierr) 10835c6c1daeSBarry Smith 10845c6c1daeSBarry Smith Usage: 10855c6c1daeSBarry Smith .vb 10865c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 10875c6c1daeSBarry Smith PetscLogDouble user_event_flops; 10885c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT,); 10895c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 10905c6c1daeSBarry Smith [code segment to monitor] 10915c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 10925c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 10935c6c1daeSBarry Smith .ve 10945c6c1daeSBarry Smith 10955c6c1daeSBarry Smith Level: intermediate 10965c6c1daeSBarry Smith 1097db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogFlops()` 10985c6c1daeSBarry Smith M*/ 10995c6c1daeSBarry Smith 11005c6c1daeSBarry Smith /*@C 11015c6c1daeSBarry Smith PetscLogEventGetId - Returns the event id when given the event name. 11025c6c1daeSBarry Smith 11035c6c1daeSBarry Smith Not Collective 11045c6c1daeSBarry Smith 11055c6c1daeSBarry Smith Input Parameter: 11065c6c1daeSBarry Smith . name - The event name 11075c6c1daeSBarry Smith 11085c6c1daeSBarry Smith Output Parameter: 1109c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists 11105c6c1daeSBarry Smith 11115c6c1daeSBarry Smith Level: intermediate 11125c6c1daeSBarry Smith 1113db781477SPatrick Sanan .seealso: `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogStageGetId()` 11145c6c1daeSBarry Smith @*/ 1115d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventGetId(const char name[], PetscLogEvent *event) 1116d71ae5a4SJacob Faibussowitsch { 11175c6c1daeSBarry Smith PetscStageLog stageLog; 11185c6c1daeSBarry Smith 11195c6c1daeSBarry Smith PetscFunctionBegin; 11209566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 11219566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, event)); 11225c6c1daeSBarry Smith PetscFunctionReturn(0); 11235c6c1daeSBarry Smith } 11245c6c1daeSBarry Smith 1125d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogPushCurrentEvent_Internal(PetscLogEvent event) 1126d71ae5a4SJacob Faibussowitsch { 11277a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11287a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackPush(current_log_event_stack, event)); 11297a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11307a101e5eSJacob Faibussowitsch } 11317a101e5eSJacob Faibussowitsch 1132d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogPopCurrentEvent_Internal(void) 1133d71ae5a4SJacob Faibussowitsch { 11347a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11357a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackPop(current_log_event_stack, NULL)); 11367a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11377a101e5eSJacob Faibussowitsch } 11387a101e5eSJacob Faibussowitsch 1139d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGetCurrentEvent_Internal(PetscLogEvent *event) 1140d71ae5a4SJacob Faibussowitsch { 11417a101e5eSJacob Faibussowitsch PetscBool empty; 11427a101e5eSJacob Faibussowitsch 11437a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11447a101e5eSJacob Faibussowitsch PetscValidIntPointer(event, 1); 11457a101e5eSJacob Faibussowitsch *event = PETSC_DECIDE; 11467a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackEmpty(current_log_event_stack, &empty)); 11477a101e5eSJacob Faibussowitsch if (!empty) PetscCall(PetscIntStackTop(current_log_event_stack, event)); 11487a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11497a101e5eSJacob Faibussowitsch } 11507a101e5eSJacob Faibussowitsch 1151d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventPause_Internal(PetscLogEvent event) 1152d71ae5a4SJacob Faibussowitsch { 11537a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11547a101e5eSJacob Faibussowitsch if (event != PETSC_DECIDE) PetscCall(PetscLogEventEnd(event, NULL, NULL, NULL, NULL)); 11557a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11567a101e5eSJacob Faibussowitsch } 11577a101e5eSJacob Faibussowitsch 1158d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventResume_Internal(PetscLogEvent event) 1159d71ae5a4SJacob Faibussowitsch { 11607a101e5eSJacob Faibussowitsch PetscStageLog stageLog; 11617a101e5eSJacob Faibussowitsch PetscEventPerfLog eventLog; 11627a101e5eSJacob Faibussowitsch int stage; 11637a101e5eSJacob Faibussowitsch 11647a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11657a101e5eSJacob Faibussowitsch if (event == PETSC_DECIDE) PetscFunctionReturn(0); 11667a101e5eSJacob Faibussowitsch PetscCall(PetscLogEventBegin(event, NULL, NULL, NULL, NULL)); 11677a101e5eSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 11687a101e5eSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 11697a101e5eSJacob Faibussowitsch PetscCall(PetscStageLogGetEventPerfLog(stageLog, stage, &eventLog)); 11707a101e5eSJacob Faibussowitsch eventLog->eventInfo[event].count--; 11717a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11727a101e5eSJacob Faibussowitsch } 11737a101e5eSJacob Faibussowitsch 11745c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/ 11755c6c1daeSBarry Smith /*@C 11765c6c1daeSBarry Smith PetscLogDump - Dumps logs of objects to a file. This file is intended to 11775c6c1daeSBarry Smith be read by bin/petscview. This program no longer exists. 11785c6c1daeSBarry Smith 1179811af0c4SBarry Smith Collective on `PETSC_COMM_WORLD` 11805c6c1daeSBarry Smith 11815c6c1daeSBarry Smith Input Parameter: 11825c6c1daeSBarry Smith . name - an optional file name 11835c6c1daeSBarry Smith 11845c6c1daeSBarry Smith Usage: 11855c6c1daeSBarry Smith .vb 11865c6c1daeSBarry Smith PetscInitialize(...); 1187bb1d7374SBarry Smith PetscLogDefaultBegin(); or PetscLogAllBegin(); 11885c6c1daeSBarry Smith ... code ... 11895c6c1daeSBarry Smith PetscLogDump(filename); 11905c6c1daeSBarry Smith PetscFinalize(); 11915c6c1daeSBarry Smith .ve 11925c6c1daeSBarry Smith 1193811af0c4SBarry Smith Note: 11945c6c1daeSBarry Smith The default file name is 11955c6c1daeSBarry Smith $ Log.<rank> 11965c6c1daeSBarry Smith where <rank> is the processor number. If no name is specified, 11975c6c1daeSBarry Smith this file will be used. 11985c6c1daeSBarry Smith 11995c6c1daeSBarry Smith Level: advanced 12005c6c1daeSBarry Smith 1201db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogView()` 12025c6c1daeSBarry Smith @*/ 1203d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogDump(const char sname[]) 1204d71ae5a4SJacob Faibussowitsch { 12055c6c1daeSBarry Smith PetscStageLog stageLog; 12065c6c1daeSBarry Smith PetscEventPerfInfo *eventInfo; 12075c6c1daeSBarry Smith FILE *fd; 12085c6c1daeSBarry Smith char file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN]; 12095c6c1daeSBarry Smith PetscLogDouble flops, _TotalTime; 12105c6c1daeSBarry Smith PetscMPIInt rank; 12115c6c1daeSBarry Smith int action, object, curStage; 12125c6c1daeSBarry Smith PetscLogEvent event; 12135c6c1daeSBarry Smith 12145c6c1daeSBarry Smith PetscFunctionBegin; 12155c6c1daeSBarry Smith /* Calculate the total elapsed time */ 12168563dfccSBarry Smith PetscTime(&_TotalTime); 12175c6c1daeSBarry Smith _TotalTime -= petsc_BaseTime; 12185c6c1daeSBarry Smith /* Open log file */ 12199566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank)); 1220a364092eSJacob Faibussowitsch PetscCall(PetscSNPrintf(file, PETSC_STATIC_ARRAY_LENGTH(file), "%s.%d", sname && sname[0] ? sname : "Log", rank)); 12219566063dSJacob Faibussowitsch PetscCall(PetscFixFilename(file, fname)); 12229566063dSJacob Faibussowitsch PetscCall(PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd)); 122308401ef6SPierre Jolivet PetscCheck(!(rank == 0) || !(!fd), PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname); 12245c6c1daeSBarry Smith /* Output totals */ 12259566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime)); 12269566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0)); 12275c6c1daeSBarry Smith /* Output actions */ 12285c6c1daeSBarry Smith if (petsc_logActions) { 12299566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions)); 12305c6c1daeSBarry Smith for (action = 0; action < petsc_numActions; action++) { 12319371c9d4SSatish 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, 1232d0609cedSBarry Smith petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem)); 12335c6c1daeSBarry Smith } 12345c6c1daeSBarry Smith } 12355c6c1daeSBarry Smith /* Output objects */ 12365c6c1daeSBarry Smith if (petsc_logObjects) { 12379566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed)); 12385c6c1daeSBarry Smith for (object = 0; object < petsc_numObjects; object++) { 12399566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int)petsc_objects[object].mem)); 12405c6c1daeSBarry Smith if (!petsc_objects[object].name[0]) { 12419566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "No Name\n")); 12425c6c1daeSBarry Smith } else { 12439566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name)); 12445c6c1daeSBarry Smith } 12455c6c1daeSBarry Smith if (petsc_objects[object].info[0] != 0) { 12469566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n")); 12475c6c1daeSBarry Smith } else { 12489566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info)); 12495c6c1daeSBarry Smith } 12505c6c1daeSBarry Smith } 12515c6c1daeSBarry Smith } 12525c6c1daeSBarry Smith /* Output events */ 12539566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n")); 12549566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 12559566063dSJacob Faibussowitsch PetscCall(PetscIntStackTop(stageLog->stack, &curStage)); 12565c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo; 12575c6c1daeSBarry Smith for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) { 1258a297a907SKarl Rupp if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops / eventInfo[event].time; 1259a297a907SKarl Rupp else flops = 0.0; 1260d0609cedSBarry Smith PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count, eventInfo[event].flops, eventInfo[event].time, flops)); 12615c6c1daeSBarry Smith } 12629566063dSJacob Faibussowitsch PetscCall(PetscFClose(PETSC_COMM_WORLD, fd)); 12635c6c1daeSBarry Smith PetscFunctionReturn(0); 12645c6c1daeSBarry Smith } 12655c6c1daeSBarry Smith 1266f14045dbSBarry Smith /* 1267f14045dbSBarry Smith PetscLogView_Detailed - Each process prints the times for its own events 1268f14045dbSBarry Smith 1269f14045dbSBarry Smith */ 1270d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView_Detailed(PetscViewer viewer) 1271d71ae5a4SJacob Faibussowitsch { 12722dff6485SMatthew G. Knepley PetscStageLog stageLog; 1273217044c2SLisandro Dalcin PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL; 1274217044c2SLisandro Dalcin PetscLogDouble locTotalTime, numRed, maxMem; 12752dff6485SMatthew G. Knepley int numStages, numEvents, stage, event; 1276217044c2SLisandro Dalcin MPI_Comm comm = PetscObjectComm((PetscObject)viewer); 12772dff6485SMatthew G. Knepley PetscMPIInt rank, size; 1278f14045dbSBarry Smith 1279f14045dbSBarry Smith PetscFunctionBegin; 12809566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 12819566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 12822dff6485SMatthew G. Knepley /* Must preserve reduction count before we go on */ 12832dff6485SMatthew G. Knepley numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 12842d1ec343SBarry Smith /* Get the total elapsed time */ 12859371c9d4SSatish Balay PetscTime(&locTotalTime); 12869371c9d4SSatish Balay locTotalTime -= petsc_BaseTime; 12879566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "size = %d\n", size)); 12889566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalTimes = {}\n")); 12899566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMessages = {}\n")); 12909566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMessageLens = {}\n")); 12919566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalReductions = {}\n")); 12929566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalFlop = {}\n")); 12939566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalObjects = {}\n")); 12949566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMemory = {}\n")); 12959566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 12969566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 12979566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Stages = {}\n")); 12982d1ec343SBarry Smith for (stage = 0; stage < numStages; stage++) { 12999566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"] = {}\n", stageLog->stageInfo[stage].name)); 13009566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"][\"summary\"] = {}\n", stageLog->stageInfo[stage].name)); 13019566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 130248a46eb9SPierre Jolivet for (event = 0; event < numEvents; event++) PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"][\"%s\"] = {}\n", stageLog->stageInfo[stage].name, stageLog->eventLog->eventInfo[event].name)); 13032d1ec343SBarry Smith } 13049566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&maxMem)); 13059566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushSynchronized(viewer)); 13069566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalTimes[%d] = %g\n", rank, locTotalTime)); 13079566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMessages[%d] = %g\n", rank, (petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct))); 13089566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMessageLens[%d] = %g\n", rank, (petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len))); 13099566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalReductions[%d] = %g\n", rank, numRed)); 13109566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalFlop[%d] = %g\n", rank, petsc_TotalFlops)); 13119566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalObjects[%d] = %d\n", rank, petsc_numObjects)); 13129566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMemory[%d] = %g\n", rank, maxMem)); 13139566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 13142d1ec343SBarry Smith for (stage = 0; stage < numStages; stage++) { 1315217044c2SLisandro Dalcin stageInfo = &stageLog->stageInfo[stage].perfInfo; 13169371c9d4SSatish 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, 13179371c9d4SSatish Balay stageInfo->numMessages, stageInfo->messageLength, stageInfo->numReductions, stageInfo->flops)); 13189566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 13192d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 1320217044c2SLisandro Dalcin eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 1321d0609cedSBarry Smith PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %d, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g", 13229371c9d4SSatish Balay stageLog->stageInfo[stage].name, stageLog->eventLog->eventInfo[event].name, rank, eventInfo->count, eventInfo->time, eventInfo->syncTime, eventInfo->numMessages, eventInfo->messageLength, eventInfo->numReductions, 13239371c9d4SSatish Balay eventInfo->flops)); 1324891e75beSMatthew G. Knepley if (eventInfo->dof[0] >= 0.) { 1325891e75beSMatthew G. Knepley PetscInt d, e; 13265d68e14cSMatthew G. Knepley 13279566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : [")); 1328891e75beSMatthew G. Knepley for (d = 0; d < 8; ++d) { 13299566063dSJacob Faibussowitsch if (d > 0) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", ")); 13309566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d])); 1331891e75beSMatthew G. Knepley } 13329566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "]")); 13339566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : [")); 13345d68e14cSMatthew G. Knepley for (e = 0; e < 8; ++e) { 13359566063dSJacob Faibussowitsch if (e > 0) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", ")); 13369566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e])); 13375d68e14cSMatthew G. Knepley } 13389566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "]")); 13395d68e14cSMatthew G. Knepley } 13409566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "}\n")); 13412d1ec343SBarry Smith } 13422d1ec343SBarry Smith } 13439566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 13449566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopSynchronized(viewer)); 1345f14045dbSBarry Smith PetscFunctionReturn(0); 1346f14045dbSBarry Smith } 1347f14045dbSBarry Smith 134838144912Sdeepblu2718 /* 134938144912Sdeepblu2718 PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format 135038144912Sdeepblu2718 */ 1351d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView_CSV(PetscViewer viewer) 1352d71ae5a4SJacob Faibussowitsch { 135338144912Sdeepblu2718 PetscStageLog stageLog; 1354669c5be0SSatish Balay PetscEventPerfInfo *eventInfo = NULL; 135538144912Sdeepblu2718 PetscLogDouble locTotalTime, maxMem; 135638144912Sdeepblu2718 int numStages, numEvents, stage, event; 135738144912Sdeepblu2718 MPI_Comm comm = PetscObjectComm((PetscObject)viewer); 135838144912Sdeepblu2718 PetscMPIInt rank, size; 135938144912Sdeepblu2718 136038144912Sdeepblu2718 PetscFunctionBegin; 13619566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 13629566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 136338144912Sdeepblu2718 /* Must preserve reduction count before we go on */ 136438144912Sdeepblu2718 /* Get the total elapsed time */ 13659371c9d4SSatish Balay PetscTime(&locTotalTime); 13669371c9d4SSatish Balay locTotalTime -= petsc_BaseTime; 13679566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 13689566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 13699566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&maxMem)); 13709566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushSynchronized(viewer)); 1371d0609cedSBarry 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)); 13729566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 137338144912Sdeepblu2718 for (stage = 0; stage < numStages; stage++) { 13749e29573dSMatthew G. Knepley PetscEventPerfInfo *stageInfo = &stageLog->stageInfo[stage].perfInfo; 13759e29573dSMatthew G. Knepley 13769371c9d4SSatish 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)); 13779566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 137838144912Sdeepblu2718 for (event = 0; event < numEvents; event++) { 137938144912Sdeepblu2718 eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 13809371c9d4SSatish 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, 13819371c9d4SSatish Balay eventInfo->numReductions, eventInfo->flops)); 138238144912Sdeepblu2718 if (eventInfo->dof[0] >= 0.) { 138338144912Sdeepblu2718 PetscInt d, e; 138438144912Sdeepblu2718 138548a46eb9SPierre Jolivet for (d = 0; d < 8; ++d) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d])); 138648a46eb9SPierre Jolivet for (e = 0; e < 8; ++e) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e])); 138738144912Sdeepblu2718 } 13889566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n")); 138938144912Sdeepblu2718 } 139038144912Sdeepblu2718 } 13919566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 13929566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopSynchronized(viewer)); 139338144912Sdeepblu2718 PetscFunctionReturn(0); 139438144912Sdeepblu2718 } 139538144912Sdeepblu2718 1396d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm, FILE *fd) 1397d71ae5a4SJacob Faibussowitsch { 1398217044c2SLisandro Dalcin PetscFunctionBegin; 1399217044c2SLisandro Dalcin if (!PetscLogSyncOn) PetscFunctionReturn(0); 14009566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 14019566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 14029566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14039566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 14049566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14059566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This program was run with logging synchronization. #\n")); 14069566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This option provides more meaningful imbalance #\n")); 14079566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # figures at the expense of slowing things down and #\n")); 14089566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # providing a distorted view of the overall runtime. #\n")); 14099566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14109566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1411217044c2SLisandro Dalcin PetscFunctionReturn(0); 1412217044c2SLisandro Dalcin } 1413217044c2SLisandro Dalcin 1414d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm, FILE *fd) 1415d71ae5a4SJacob Faibussowitsch { 1416f4091ad2SBarry Smith PetscFunctionBegin; 141776bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 14189566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 14199566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 14209566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14219566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 14229566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14239566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This code was compiled with a debugging option. #\n")); 14249566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # To get timing results run ./configure #\n")); 14259566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # using --with-debugging=no, the performance will #\n")); 14269566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # be generally two or three times faster. #\n")); 14279566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14289566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 142976bd3646SJed Brown } 1430f4091ad2SBarry Smith PetscFunctionReturn(0); 1431f4091ad2SBarry Smith } 1432f4091ad2SBarry Smith 1433d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnNoGpuAwareMpi(MPI_Comm comm, FILE *fd) 1434d71ae5a4SJacob Faibussowitsch { 1435009ab46cSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1436009ab46cSJunchao Zhang PetscMPIInt size; 1437c2a741eeSJunchao Zhang 1438c2a741eeSJunchao Zhang PetscFunctionBegin; 14399566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 1440340fe3cdSSatish Balay if (use_gpu_aware_mpi || size == 1) PetscFunctionReturn(0); 14419566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 14429566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 14439566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14449566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 14459566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14469566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This code was compiled with GPU support and you've #\n")); 14479566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # created PETSc/GPU objects, but you intentionally #\n")); 14489566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # used -use_gpu_aware_mpi 0, requiring PETSc to copy #\n")); 14499566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # additional data between the GPU and CPU. To obtain #\n")); 14509566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # meaningful timing results on multi-rank runs, use #\n")); 14519566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # GPU-aware MPI instead. #\n")); 14529566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14539566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1454c2a741eeSJunchao Zhang PetscFunctionReturn(0); 1455c2a741eeSJunchao Zhang #else 1456c2a741eeSJunchao Zhang return 0; 1457c2a741eeSJunchao Zhang #endif 1458c2a741eeSJunchao Zhang } 1459c2a741eeSJunchao Zhang 1460d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnGpuTime(MPI_Comm comm, FILE *fd) 1461d71ae5a4SJacob Faibussowitsch { 1462156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1463156b51fbSBarry Smith 1464156b51fbSBarry Smith PetscFunctionBegin; 1465156b51fbSBarry Smith if (!PetscLogGpuTimeFlag || petsc_gflops == 0) PetscFunctionReturn(0); 1466156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, "\n\n")); 1467156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 1468156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1469156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 1470156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1471156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # This code was run with -log_view_gpu_time #\n")); 1472156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # This provides accurate timing within the GPU kernels #\n")); 1473156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # but can slow down the entire computation by a #\n")); 1474156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # measurable amount. For fastest runs we recommend #\n")); 1475156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # not using this option. #\n")); 1476156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1477156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1478156b51fbSBarry Smith PetscFunctionReturn(0); 1479156b51fbSBarry Smith #else 1480156b51fbSBarry Smith return 0; 1481156b51fbSBarry Smith #endif 1482156b51fbSBarry Smith } 1483156b51fbSBarry Smith 1484d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView_Default(PetscViewer viewer) 1485d71ae5a4SJacob Faibussowitsch { 14865c6c1daeSBarry Smith FILE *fd; 14875c6c1daeSBarry Smith PetscLogDouble zero = 0.0; 14885c6c1daeSBarry Smith PetscStageLog stageLog; 14890298fd71SBarry Smith PetscStageInfo *stageInfo = NULL; 14900298fd71SBarry Smith PetscEventPerfInfo *eventInfo = NULL; 14915c6c1daeSBarry Smith PetscClassPerfInfo *classInfo; 14925c6c1daeSBarry Smith char arch[128], hostname[128], username[128], pname[PETSC_MAX_PATH_LEN], date[128]; 14935c6c1daeSBarry Smith const char *name; 14945c6c1daeSBarry Smith PetscLogDouble locTotalTime, TotalTime, TotalFlops; 14955c6c1daeSBarry Smith PetscLogDouble numMessages, messageLength, avgMessLen, numReductions; 14965c6c1daeSBarry Smith PetscLogDouble stageTime, flops, flopr, mem, mess, messLen, red; 14975c6c1daeSBarry Smith PetscLogDouble fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed; 14985c6c1daeSBarry Smith PetscLogDouble fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed; 14995c6c1daeSBarry Smith PetscLogDouble min, max, tot, ratio, avg, x, y; 1500e3ed9ee7SBarry Smith PetscLogDouble minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr, mal, malmax, emalmax; 1501d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1502156b51fbSBarry Smith PetscLogEvent KSP_Solve, SNES_Solve, TS_Step, TAO_Solve; /* These need to be fixed to be some events registered with certain objects */ 1503958c4211Shannah_mairs PetscLogDouble cct, gct, csz, gsz, gmaxt, gflops, gflopr, fracgflops; 1504bec0b493Shannah_mairs #endif 1505217044c2SLisandro Dalcin PetscMPIInt minC, maxC; 15065c6c1daeSBarry Smith PetscMPIInt size, rank; 15075c6c1daeSBarry Smith PetscBool *localStageUsed, *stageUsed; 15085c6c1daeSBarry Smith PetscBool *localStageVisible, *stageVisible; 15095c6c1daeSBarry Smith int numStages, localNumEvents, numEvents; 151037b78d16SBarry Smith int stage, oclass; 15115c6c1daeSBarry Smith PetscLogEvent event; 1512d0609cedSBarry Smith PetscErrorCode ierr = 0; 15135c6c1daeSBarry Smith char version[256]; 15145c6c1daeSBarry Smith MPI_Comm comm; 1515156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1516156b51fbSBarry Smith PetscLogEvent eventid; 1517156b51fbSBarry Smith PetscInt64 nas = 0x7FF0000000000002; 1518156b51fbSBarry Smith #endif 15195c6c1daeSBarry Smith 15205c6c1daeSBarry Smith PetscFunctionBegin; 1521156b51fbSBarry Smith PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF)); 15229566063dSJacob Faibussowitsch PetscCall(PetscObjectGetComm((PetscObject)viewer, &comm)); 15239566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIGetPointer(viewer, &fd)); 15249566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 15259566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 15265c6c1daeSBarry Smith /* Get the total elapsed time */ 15279371c9d4SSatish Balay PetscTime(&locTotalTime); 15289371c9d4SSatish Balay locTotalTime -= petsc_BaseTime; 15295c6c1daeSBarry Smith 1530faad7b01SPierre Jolivet PetscCall(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n")); 15319566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "*** WIDEN YOUR WINDOW TO 160 CHARACTERS. Use 'enscript -r -fCourier9' to print this document ***\n")); 15329566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n")); 1533faad7b01SPierre Jolivet PetscCall(PetscFPrintf(comm, fd, "\n------------------------------------------------------------------ PETSc Performance Summary: ------------------------------------------------------------------\n\n")); 15349566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnSync(comm, fd)); 15359566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm, fd)); 15369566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnNoGpuAwareMpi(comm, fd)); 1537156b51fbSBarry Smith PetscCall(PetscLogViewWarnGpuTime(comm, fd)); 15389566063dSJacob Faibussowitsch PetscCall(PetscGetArchType(arch, sizeof(arch))); 15399566063dSJacob Faibussowitsch PetscCall(PetscGetHostName(hostname, sizeof(hostname))); 15409566063dSJacob Faibussowitsch PetscCall(PetscGetUserName(username, sizeof(username))); 15419566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(pname, sizeof(pname))); 15429566063dSJacob Faibussowitsch PetscCall(PetscGetDate(date, sizeof(date))); 15439566063dSJacob Faibussowitsch PetscCall(PetscGetVersion(version, sizeof(version))); 15445c6c1daeSBarry Smith if (size == 1) { 15459566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s on a %s named %s with %d processor, by %s %s\n", pname, arch, hostname, size, username, date)); 15465c6c1daeSBarry Smith } else { 15479566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s on a %s named %s with %d processors, by %s %s\n", pname, arch, hostname, size, username, date)); 15485c6c1daeSBarry Smith } 1549f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP) 15509566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Using %" PetscInt_FMT " OpenMP threads\n", PetscNumOMPThreads)); 1551f90b075cSBarry Smith #endif 15529566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Using %s\n", version)); 15535c6c1daeSBarry Smith 15545c6c1daeSBarry Smith /* Must preserve reduction count before we go on */ 15555c6c1daeSBarry Smith red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 15565c6c1daeSBarry Smith 15575c6c1daeSBarry Smith /* Calculate summary information */ 15589566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n Max Max/Min Avg Total\n")); 15595c6c1daeSBarry Smith /* Time */ 15609566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15619566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15629566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1563217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15649371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15659371c9d4SSatish Balay else ratio = 0.0; 15669566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Time (sec): %5.3e %7.3f %5.3e\n", max, ratio, avg)); 15675c6c1daeSBarry Smith TotalTime = tot; 15685c6c1daeSBarry Smith /* Objects */ 15695c6c1daeSBarry Smith avg = (PetscLogDouble)petsc_numObjects; 15709566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15719566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15729566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1573217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15749371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15759371c9d4SSatish Balay else ratio = 0.0; 15769566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Objects: %5.3e %7.3f %5.3e\n", max, ratio, avg)); 15775c6c1daeSBarry Smith /* Flops */ 15789566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15799566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15809566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1581217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15829371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15839371c9d4SSatish Balay else ratio = 0.0; 15849566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Flops: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15855c6c1daeSBarry Smith TotalFlops = tot; 15865c6c1daeSBarry Smith /* Flops/sec -- Must talk to Barry here */ 15879371c9d4SSatish Balay if (locTotalTime != 0.0) flops = petsc_TotalFlops / locTotalTime; 15889371c9d4SSatish Balay else flops = 0.0; 15899566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15909566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15919566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1592217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15939371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15949371c9d4SSatish Balay else ratio = 0.0; 15959566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Flops/sec: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15965c6c1daeSBarry Smith /* Memory */ 15979566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&mem)); 15985c6c1daeSBarry Smith if (mem > 0.0) { 15999566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 16009566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 16019566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1602217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 16039371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 16049371c9d4SSatish Balay else ratio = 0.0; 16059566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Memory (bytes): %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 16065c6c1daeSBarry Smith } 16075c6c1daeSBarry Smith /* Messages */ 16085c6c1daeSBarry Smith mess = 0.5 * (petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct); 16099566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 16109566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 16119566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1612217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 16139371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 16149371c9d4SSatish Balay else ratio = 0.0; 16159566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Msg Count: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 16165c6c1daeSBarry Smith numMessages = tot; 16175c6c1daeSBarry Smith /* Message Lengths */ 16185c6c1daeSBarry Smith mess = 0.5 * (petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len); 16199566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 16209566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 16219566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16229371c9d4SSatish Balay if (numMessages != 0) avg = tot / numMessages; 16239371c9d4SSatish Balay else avg = 0.0; 16249371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 16259371c9d4SSatish Balay else ratio = 0.0; 16269566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Msg Len (bytes): %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 16275c6c1daeSBarry Smith messageLength = tot; 16285c6c1daeSBarry Smith /* Reductions */ 16299566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 16309566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 16319566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16329371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 16339371c9d4SSatish Balay else ratio = 0.0; 16349566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Reductions: %5.3e %7.3f\n", max, ratio)); 16355c6c1daeSBarry Smith numReductions = red; /* wrong because uses count from process zero */ 16369566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n")); 16379566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " e.g., VecAXPY() for real vectors of length N --> 2N flops\n")); 16389566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " and VecAXPY() for complex vectors of length N --> 8N flops\n")); 16395c6c1daeSBarry Smith 16405c6c1daeSBarry Smith /* Get total number of stages -- 16415c6c1daeSBarry Smith Currently, a single processor can register more stages than another, but stages must all be registered in order. 16425c6c1daeSBarry Smith We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID. 16435c6c1daeSBarry Smith This seems best accomplished by assoicating a communicator with each stage. 16445c6c1daeSBarry Smith */ 16459566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 16469566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 16479566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &localStageUsed)); 16489566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &stageUsed)); 16499566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &localStageVisible)); 16509566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &stageVisible)); 16515c6c1daeSBarry Smith if (numStages > 0) { 16525c6c1daeSBarry Smith stageInfo = stageLog->stageInfo; 16535c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16545c6c1daeSBarry Smith if (stage < stageLog->numStages) { 16555c6c1daeSBarry Smith localStageUsed[stage] = stageInfo[stage].used; 16565c6c1daeSBarry Smith localStageVisible[stage] = stageInfo[stage].perfInfo.visible; 16575c6c1daeSBarry Smith } else { 16585c6c1daeSBarry Smith localStageUsed[stage] = PETSC_FALSE; 16595c6c1daeSBarry Smith localStageVisible[stage] = PETSC_TRUE; 16605c6c1daeSBarry Smith } 16615c6c1daeSBarry Smith } 16629566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm)); 16639566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm)); 16645c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16655c6c1daeSBarry Smith if (stageUsed[stage]) { 16669566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\nSummary of Stages: ----- Time ------ ----- Flop ------ --- Messages --- -- Message Lengths -- -- Reductions --\n")); 16679566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Avg %%Total Avg %%Total Count %%Total Avg %%Total Count %%Total\n")); 16685c6c1daeSBarry Smith break; 16695c6c1daeSBarry Smith } 16705c6c1daeSBarry Smith } 16715c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16725c6c1daeSBarry Smith if (!stageUsed[stage]) continue; 1673820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 16745c6c1daeSBarry Smith if (localStageUsed[stage]) { 16759566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16769566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16779566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16789566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16799566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16805c6c1daeSBarry Smith name = stageInfo[stage].name; 16815c6c1daeSBarry Smith } else { 16829566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16839566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16849566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16859566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16869566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16875c6c1daeSBarry Smith name = ""; 16885c6c1daeSBarry Smith } 16899371c9d4SSatish Balay mess *= 0.5; 16909371c9d4SSatish Balay messLen *= 0.5; 16919371c9d4SSatish Balay red /= size; 16929371c9d4SSatish Balay if (TotalTime != 0.0) fracTime = stageTime / TotalTime; 16939371c9d4SSatish Balay else fracTime = 0.0; 16949371c9d4SSatish Balay if (TotalFlops != 0.0) fracFlops = flops / TotalFlops; 16959371c9d4SSatish Balay else fracFlops = 0.0; 16965c6c1daeSBarry Smith /* Talk to Barry if (stageTime != 0.0) flops = (size*flops)/stageTime; else flops = 0.0; */ 16979371c9d4SSatish Balay if (numMessages != 0.0) fracMessages = mess / numMessages; 16989371c9d4SSatish Balay else fracMessages = 0.0; 16999371c9d4SSatish Balay if (mess != 0.0) avgMessLen = messLen / mess; 17009371c9d4SSatish Balay else avgMessLen = 0.0; 17019371c9d4SSatish Balay if (messageLength != 0.0) fracLength = messLen / messageLength; 17029371c9d4SSatish Balay else fracLength = 0.0; 17039371c9d4SSatish Balay if (numReductions != 0.0) fracReductions = red / numReductions; 17049371c9d4SSatish Balay else fracReductions = 0.0; 17059371c9d4SSatish 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)); 17065c6c1daeSBarry Smith } 17075c6c1daeSBarry Smith } 17085c6c1daeSBarry Smith 17099566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n------------------------------------------------------------------------------------------------------------------------\n")); 17109566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n")); 17119566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Phase summary info:\n")); 17129566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Count: number of times phase was executed\n")); 17139566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Time and Flop: Max - maximum over all processors\n")); 17149566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Ratio - ratio of maximum to minimum over all processors\n")); 17159566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Mess: number of messages sent\n")); 17169566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " AvgLen: average message length (bytes)\n")); 17179566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Reduct: number of global reductions\n")); 17189566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Global: entire computation\n")); 17199566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n")); 17209566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%T - percent time in this phase %%F - percent flop in this phase\n")); 17219566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%M - percent messages in this phase %%L - percent message lengths in this phase\n")); 17229566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%R - percent reductions in this phase\n")); 17239566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n")); 1724e3ed9ee7SBarry Smith if (PetscLogMemory) { 172554aabf2dSBarry Smith PetscCall(PetscFPrintf(comm, fd, " Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event). May be negative\n")); 172654aabf2dSBarry Smith PetscCall(PetscFPrintf(comm, fd, " EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events). Never negative\n")); 172754aabf2dSBarry Smith PetscCall(PetscFPrintf(comm, fd, " MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event). Never negative\n")); 17289566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " RMI Mbytes: Increase in resident memory (sum over all calls to event)\n")); 1729e3ed9ee7SBarry Smith } 1730d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17319566063dSJacob 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")); 17329566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " CpuToGpu Count: total number of CPU to GPU copies per processor\n")); 17339566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " CpuToGpu Size (Mbytes): 10e-6 * (total size of CPU to GPU copies per processor)\n")); 17349566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GpuToCpu Count: total number of GPU to CPU copies per processor\n")); 17359566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GpuToCpu Size (Mbytes): 10e-6 * (total size of GPU to CPU copies per processor)\n")); 17369566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GPU %%F: percent flops on GPU in this event\n")); 1737bec0b493Shannah_mairs #endif 17389566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n")); 17395c6c1daeSBarry Smith 17409566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm, fd)); 17415c6c1daeSBarry Smith 17425c6c1daeSBarry Smith /* Report events */ 17439566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Event Count Time (sec) Flop --- Global --- --- Stage ---- Total")); 174448a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, " Malloc EMalloc MMalloc RMI")); 1745d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17469566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GPU - CpuToGpu - - GpuToCpu - GPU")); 1747bec0b493Shannah_mairs #endif 17489566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 17499566063dSJacob 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")); 175048a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, " Mbytes Mbytes Mbytes Mbytes")); 1751d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17529566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Mflop/s Count Size Count Size %%F")); 1753bec0b493Shannah_mairs #endif 17549566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 17559566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------")); 175648a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, "-----------------------------")); 1757d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17589566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "---------------------------------------")); 17594863603aSSatish Balay #endif 17609566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 17615c6c1daeSBarry Smith 1762156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1763156b51fbSBarry Smith /* this indirect way of accessing these values is needed when PETSc is build with multiple libraries since the symbols are not in libpetscsys */ 1764156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "TAOSolve", &TAO_Solve)); 1765156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "TSStep", &TS_Step)); 1766156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "SNESSolve", &SNES_Solve)); 1767156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "KSPSolve", &KSP_Solve)); 1768156b51fbSBarry Smith #endif 1769156b51fbSBarry Smith 17705c6c1daeSBarry Smith /* Problem: The stage name will not show up unless the stage executed on proc 1 */ 17715c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 17725c6c1daeSBarry Smith if (!stageVisible[stage]) continue; 1773820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 17745c6c1daeSBarry Smith if (localStageUsed[stage]) { 17759566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name)); 17769566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17779566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17789566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17799566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17809566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17815c6c1daeSBarry Smith } else { 17829566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage)); 17839566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17849566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17859566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17869566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17879566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17885c6c1daeSBarry Smith } 17899371c9d4SSatish Balay mess *= 0.5; 17909371c9d4SSatish Balay messLen *= 0.5; 17919371c9d4SSatish Balay red /= size; 17925c6c1daeSBarry Smith 17935c6c1daeSBarry Smith /* Get total number of events in this stage -- 17945c6c1daeSBarry Smith Currently, a single processor can register more events than another, but events must all be registered in order, 17955c6c1daeSBarry Smith just like stages. We can removed this requirement if necessary by having a global event numbering and indirection 1796217044c2SLisandro Dalcin on the event ID. This seems best accomplished by associating a communicator with each stage. 17975c6c1daeSBarry Smith 17985c6c1daeSBarry Smith Problem: If the event did not happen on proc 1, its name will not be available. 17995c6c1daeSBarry Smith Problem: Event visibility is not implemented 18005c6c1daeSBarry Smith */ 18015c6c1daeSBarry Smith if (localStageUsed[stage]) { 18025c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo; 18035c6c1daeSBarry Smith localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents; 1804a297a907SKarl Rupp } else localNumEvents = 0; 18059566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 18065c6c1daeSBarry Smith for (event = 0; event < numEvents; event++) { 1807820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 18085c6c1daeSBarry Smith if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) { 18099371c9d4SSatish Balay if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; 18109371c9d4SSatish Balay else flopr = 0.0; 18119566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18129566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18139566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18149566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18159566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18169566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18179566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18189566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18199566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18209566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].count, &minC, 1, MPI_INT, MPI_MIN, comm)); 18219566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].count, &maxC, 1, MPI_INT, MPI_MAX, comm)); 1822e3ed9ee7SBarry Smith if (PetscLogMemory) { 18239566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].memIncrease, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18249566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocSpace, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18259566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocIncrease, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18269566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1827e3ed9ee7SBarry Smith } 1828d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 18299566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].CpuToGpuCount, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18309566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuToCpuCount, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18319566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].CpuToGpuSize, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18329566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuToCpuSize, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18339566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuFlops, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18349566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuTime, &gmaxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 1835bec0b493Shannah_mairs #endif 18365c6c1daeSBarry Smith name = stageLog->eventLog->eventInfo[event].name; 18375c6c1daeSBarry Smith } else { 18385c6c1daeSBarry Smith flopr = 0.0; 18399566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18409566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18419566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18429566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18439566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18449566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18459566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18469566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18479566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18489566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&ierr, &minC, 1, MPI_INT, MPI_MIN, comm)); 18499566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&ierr, &maxC, 1, MPI_INT, MPI_MAX, comm)); 1850e3ed9ee7SBarry Smith if (PetscLogMemory) { 18519566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18529566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18539566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18549566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &emalmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1855e3ed9ee7SBarry Smith } 1856d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 18579566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18589566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18599566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18609566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18619566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18629566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gmaxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 1863bec0b493Shannah_mairs #endif 18645c6c1daeSBarry Smith name = ""; 18655c6c1daeSBarry Smith } 18665c6c1daeSBarry Smith if (mint < 0.0) { 1867d0609cedSBarry 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)); 18685c6c1daeSBarry Smith mint = 0; 18695c6c1daeSBarry Smith } 187008401ef6SPierre 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); 1871156b51fbSBarry Smith /* Put NaN into the time for all events that may not be time accurately since they may happen asynchronously on the GPU */ 1872156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1873156b51fbSBarry Smith if (!PetscLogGpuTimeFlag && petsc_gflops > 0) { 1874156b51fbSBarry Smith memcpy(&gmaxt, &nas, sizeof(PetscLogDouble)); 1875156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, &eventid)); 1876156b51fbSBarry Smith if (eventid != SNES_Solve && eventid != KSP_Solve && eventid != TS_Step && eventid != TAO_Solve) { 1877156b51fbSBarry Smith memcpy(&mint, &nas, sizeof(PetscLogDouble)); 1878156b51fbSBarry Smith memcpy(&maxt, &nas, sizeof(PetscLogDouble)); 1879156b51fbSBarry Smith } 1880156b51fbSBarry Smith } 1881156b51fbSBarry Smith #endif 18829371c9d4SSatish Balay totm *= 0.5; 18839371c9d4SSatish Balay totml *= 0.5; 18849371c9d4SSatish Balay totr /= size; 18855c6c1daeSBarry Smith 1886217044c2SLisandro Dalcin if (maxC != 0) { 18879371c9d4SSatish Balay if (minC != 0) ratC = ((PetscLogDouble)maxC) / minC; 18889371c9d4SSatish Balay else ratC = 0.0; 18899371c9d4SSatish Balay if (mint != 0.0) ratt = maxt / mint; 18909371c9d4SSatish Balay else ratt = 0.0; 18919371c9d4SSatish Balay if (minf != 0.0) ratf = maxf / minf; 18929371c9d4SSatish Balay else ratf = 0.0; 18939371c9d4SSatish Balay if (TotalTime != 0.0) fracTime = tott / TotalTime; 18949371c9d4SSatish Balay else fracTime = 0.0; 18959371c9d4SSatish Balay if (TotalFlops != 0.0) fracFlops = totf / TotalFlops; 18969371c9d4SSatish Balay else fracFlops = 0.0; 18979371c9d4SSatish Balay if (stageTime != 0.0) fracStageTime = tott / stageTime; 18989371c9d4SSatish Balay else fracStageTime = 0.0; 18999371c9d4SSatish Balay if (flops != 0.0) fracStageFlops = totf / flops; 19009371c9d4SSatish Balay else fracStageFlops = 0.0; 19019371c9d4SSatish Balay if (numMessages != 0.0) fracMess = totm / numMessages; 19029371c9d4SSatish Balay else fracMess = 0.0; 19039371c9d4SSatish Balay if (messageLength != 0.0) fracMessLen = totml / messageLength; 19049371c9d4SSatish Balay else fracMessLen = 0.0; 19059371c9d4SSatish Balay if (numReductions != 0.0) fracRed = totr / numReductions; 19069371c9d4SSatish Balay else fracRed = 0.0; 19079371c9d4SSatish Balay if (mess != 0.0) fracStageMess = totm / mess; 19089371c9d4SSatish Balay else fracStageMess = 0.0; 19099371c9d4SSatish Balay if (messLen != 0.0) fracStageMessLen = totml / messLen; 19109371c9d4SSatish Balay else fracStageMessLen = 0.0; 19119371c9d4SSatish Balay if (red != 0.0) fracStageRed = totr / red; 19129371c9d4SSatish Balay else fracStageRed = 0.0; 19139371c9d4SSatish Balay if (totm != 0.0) totml /= totm; 19149371c9d4SSatish Balay else totml = 0.0; 19159371c9d4SSatish Balay if (maxt != 0.0) flopr = totf / maxt; 19169371c9d4SSatish Balay else flopr = 0.0; 191768a21331SBarry Smith if (fracStageTime > 1.0 || fracStageFlops > 1.0 || fracStageMess > 1.0 || fracStageMessLen > 1.0 || fracStageRed > 1.0) 1918a76edefcSRicardo Jesus PetscCall(PetscFPrintf(comm, fd, "%-16s %7d %3.1f %5.4e %3.1f %3.2e %3.1f %2.1e %2.1e %2.1e %2.0f %2.0f %2.0f %2.0f %2.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)); 191968a21331SBarry Smith else 1920a76edefcSRicardo Jesus PetscCall(PetscFPrintf(comm, fd, "%-16s %7d %3.1f %5.4e %3.1f %3.2e %3.1f %2.1e %2.1e %2.1e %2.0f %2.0f %2.0f %2.0f %2.0f %3.0f %2.0f %2.0f %2.0f %2.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)); 192148a46eb9SPierre 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)); 1922d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 19239371c9d4SSatish Balay if (totf != 0.0) fracgflops = gflops / totf; 19249371c9d4SSatish Balay else fracgflops = 0.0; 19259371c9d4SSatish Balay if (gmaxt != 0.0) gflopr = gflops / gmaxt; 19269371c9d4SSatish Balay else gflopr = 0.0; 1927a76edefcSRicardo Jesus PetscCall(PetscFPrintf(comm, fd, " %5.0f %4.0f %3.2e %4.0f %3.2e % 2.0f", PetscAbs(gflopr) / 1.0e6, cct / size, csz / (1.0e6 * size), gct / size, gsz / (1.0e6 * size), 100.0 * fracgflops)); 1928bec0b493Shannah_mairs #endif 19299566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 19305c6c1daeSBarry Smith } 19315c6c1daeSBarry Smith } 19325c6c1daeSBarry Smith } 19335c6c1daeSBarry Smith 19345c6c1daeSBarry Smith /* Memory usage and object creation */ 19359566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------")); 193648a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, "-----------------------------")); 1937d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 19389566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "---------------------------------------")); 19394863603aSSatish Balay #endif 19409566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 19419566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 19425c6c1daeSBarry Smith 19435c6c1daeSBarry Smith /* Right now, only stages on the first processor are reported here, meaning only objects associated with 19445c6c1daeSBarry Smith the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then 19455c6c1daeSBarry Smith stats for stages local to processor sets. 19465c6c1daeSBarry Smith */ 19475c6c1daeSBarry Smith /* We should figure out the longest object name here (now 20 characters) */ 19484851f57dSBarry Smith PetscCall(PetscFPrintf(comm, fd, "Object Type Creations Destructions. Reports information only for process 0.\n")); 19495c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 19505c6c1daeSBarry Smith if (localStageUsed[stage]) { 19515c6c1daeSBarry Smith classInfo = stageLog->stageInfo[stage].classLog->classInfo; 19529566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name)); 19535c6c1daeSBarry Smith for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) { 19545c6c1daeSBarry Smith if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) { 19554851f57dSBarry Smith PetscCall(PetscFPrintf(comm, fd, "%20s %5d %5d\n", stageLog->classLog->classInfo[oclass].name, classInfo[oclass].creations, classInfo[oclass].destructions)); 19565c6c1daeSBarry Smith } 19575c6c1daeSBarry Smith } 19585c6c1daeSBarry Smith } else { 1959cf019ec6SStefano Zampini if (!localStageVisible[stage]) continue; 19609566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage)); 19615c6c1daeSBarry Smith } 19625c6c1daeSBarry Smith } 19635c6c1daeSBarry Smith 19649566063dSJacob Faibussowitsch PetscCall(PetscFree(localStageUsed)); 19659566063dSJacob Faibussowitsch PetscCall(PetscFree(stageUsed)); 19669566063dSJacob Faibussowitsch PetscCall(PetscFree(localStageVisible)); 19679566063dSJacob Faibussowitsch PetscCall(PetscFree(stageVisible)); 19685c6c1daeSBarry Smith 19695c6c1daeSBarry Smith /* Information unrelated to this particular run */ 19709566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "========================================================================================================================\n")); 19718563dfccSBarry Smith PetscTime(&y); 19728563dfccSBarry Smith PetscTime(&x); 19739371c9d4SSatish Balay PetscTime(&y); 19749371c9d4SSatish Balay PetscTime(&y); 19759371c9d4SSatish Balay PetscTime(&y); 19769371c9d4SSatish Balay PetscTime(&y); 19779371c9d4SSatish Balay PetscTime(&y); 19789371c9d4SSatish Balay PetscTime(&y); 19799371c9d4SSatish Balay PetscTime(&y); 19809371c9d4SSatish Balay PetscTime(&y); 19819371c9d4SSatish Balay PetscTime(&y); 19829371c9d4SSatish Balay PetscTime(&y); 19839566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Average time to get PetscTime(): %g\n", (y - x) / 10.0)); 19845c6c1daeSBarry Smith /* MPI information */ 19855c6c1daeSBarry Smith if (size > 1) { 19865c6c1daeSBarry Smith MPI_Status status; 19875c6c1daeSBarry Smith PetscMPIInt tag; 19885c6c1daeSBarry Smith MPI_Comm newcomm; 19895c6c1daeSBarry Smith 19909566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19918563dfccSBarry Smith PetscTime(&x); 19929566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19939566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19949566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19959566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19969566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19978563dfccSBarry Smith PetscTime(&y); 19989566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y - x) / 5.0)); 19999566063dSJacob Faibussowitsch PetscCall(PetscCommDuplicate(comm, &newcomm, &tag)); 20009566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 20015c6c1daeSBarry Smith if (rank) { 20029566063dSJacob Faibussowitsch PetscCallMPI(MPI_Recv(NULL, 0, MPI_INT, rank - 1, tag, newcomm, &status)); 20039566063dSJacob Faibussowitsch PetscCallMPI(MPI_Send(NULL, 0, MPI_INT, (rank + 1) % size, tag, newcomm)); 20045c6c1daeSBarry Smith } else { 20058563dfccSBarry Smith PetscTime(&x); 20069566063dSJacob Faibussowitsch PetscCallMPI(MPI_Send(NULL, 0, MPI_INT, 1, tag, newcomm)); 20079566063dSJacob Faibussowitsch PetscCallMPI(MPI_Recv(NULL, 0, MPI_INT, size - 1, tag, newcomm, &status)); 20088563dfccSBarry Smith PetscTime(&y); 20099566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Average time for zero size MPI_Send(): %g\n", (y - x) / size)); 20105c6c1daeSBarry Smith } 20119566063dSJacob Faibussowitsch PetscCall(PetscCommDestroy(&newcomm)); 20125c6c1daeSBarry Smith } 20139566063dSJacob Faibussowitsch PetscCall(PetscOptionsView(NULL, viewer)); 20145c6c1daeSBarry Smith 20155c6c1daeSBarry Smith /* Machine and compile information */ 20165c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS) 20179566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n")); 20185c6c1daeSBarry Smith #else 20199566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n")); 20205c6c1daeSBarry Smith #endif 2021217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) 20229566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n")); 2023217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128) 20249566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n")); 2025217044c2SLisandro Dalcin #endif 20265c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 20279566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n")); 20285f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128) 20299566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n")); 20305c6c1daeSBarry Smith #endif 20315c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE) 20329566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with single precision matrices\n")); 20335c6c1daeSBarry Smith #else 20349566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n")); 20355c6c1daeSBarry Smith #endif 20369371c9d4SSatish 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))); 20375c6c1daeSBarry Smith 20389566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Configure options: %s", petscconfigureoptions)); 20399566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petscmachineinfo)); 20409566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsccompilerinfo)); 20419566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo)); 20429566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsclinkerinfo)); 20435c6c1daeSBarry Smith 20445c6c1daeSBarry Smith /* Cleanup */ 20459566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 20469566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnNoGpuAwareMpi(comm, fd)); 20479566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm, fd)); 2048156b51fbSBarry Smith PetscCall(PetscFPTrapPop()); 20495c6c1daeSBarry Smith PetscFunctionReturn(0); 20505c6c1daeSBarry Smith } 20515c6c1daeSBarry Smith 20527d6c928cSSatish Balay /*@C 20537d6c928cSSatish Balay PetscLogView - Prints a summary of the logging. 20545c6c1daeSBarry Smith 20555c6c1daeSBarry Smith Collective over MPI_Comm 20565c6c1daeSBarry Smith 20575c6c1daeSBarry Smith Input Parameter: 2058f14045dbSBarry Smith . viewer - an ASCII viewer 20595c6c1daeSBarry Smith 20605c6c1daeSBarry Smith Options Database Keys: 2061bb1d7374SBarry Smith + -log_view [:filename] - Prints summary of log information 2062bb1d7374SBarry Smith . -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file 2063607d249eSBarry 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) 2064d0a29bd7SConnor 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) 2065156b51fbSBarry Smith . -log_view_memory - Also display memory usage in each event 2066156b51fbSBarry Smith . -log_view_gpu_time - Also display time in each event for GPU kernels (Note this may slow the computation) 2067811af0c4SBarry Smith . -log_all - Saves a file Log.rank for each MPI rank with details of each step of the computation 2068bb1d7374SBarry Smith - -log_trace [filename] - Displays a trace of what each process is doing 20695c6c1daeSBarry Smith 20705c6c1daeSBarry Smith Notes: 2071bb1d7374SBarry Smith It is possible to control the logging programatically but we recommend using the options database approach whenever possible 20725c6c1daeSBarry Smith By default the summary is printed to stdout. 20735c6c1daeSBarry Smith 2074bb1d7374SBarry Smith Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin() 2075bb1d7374SBarry Smith 2076bb1d7374SBarry Smith If PETSc is configured with --with-logging=0 then this functionality is not available 2077bb1d7374SBarry Smith 2078607d249eSBarry Smith To view the nested XML format filename.xml first copy ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current 2079607d249eSBarry Smith directory then open filename.xml with your browser. Specific notes for certain browsers 2080607d249eSBarry Smith $ Firefox and Internet explorer - simply open the file 2081607d249eSBarry Smith $ Google Chrome - you must start up Chrome with the option --allow-file-access-from-files 2082a8d69d7bSBarry Smith $ Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access 2083607d249eSBarry 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 2084607d249eSBarry Smith your browser. 20852add09c0SLisandro Dalcin Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser 20862add09c0SLisandro Dalcin window and render the XML log file contents. 2087607d249eSBarry Smith 2088bb1d7374SBarry Smith The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij MARITIME RESEARCH INSTITUTE NETHERLANDS 2089bb1d7374SBarry Smith 2090d0a29bd7SConnor Ward The Flame Graph output can be visualised using either the original Flame Graph script (https://github.com/brendangregg/FlameGraph) 2091d0a29bd7SConnor Ward or using speedscope (https://www.speedscope.app). 2092d0a29bd7SConnor Ward Old XML profiles may be converted into this format using the script ${PETSC_DIR}/lib/petsc/bin/xml2flamegraph.py. 2093d0a29bd7SConnor Ward 20945c6c1daeSBarry Smith Level: beginner 20955c6c1daeSBarry Smith 2096db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogDump()` 20975c6c1daeSBarry Smith @*/ 2098d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView(PetscViewer viewer) 2099d71ae5a4SJacob Faibussowitsch { 2100f14045dbSBarry Smith PetscBool isascii; 2101f14045dbSBarry Smith PetscViewerFormat format; 210237b78d16SBarry Smith int stage, lastStage; 210337b78d16SBarry Smith PetscStageLog stageLog; 21045c6c1daeSBarry Smith 21055c6c1daeSBarry Smith PetscFunctionBegin; 210628b400f6SJacob Faibussowitsch PetscCheck(PetscLogPLB, PETSC_COMM_SELF, PETSC_ERR_SUP, "Must use -log_view or PetscLogDefaultBegin() before calling this routine"); 210737b78d16SBarry Smith /* Pop off any stages the user forgot to remove */ 210837b78d16SBarry Smith lastStage = 0; 21099566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 21109566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 211137b78d16SBarry Smith while (stage >= 0) { 211237b78d16SBarry Smith lastStage = stage; 21139566063dSJacob Faibussowitsch PetscCall(PetscStageLogPop(stageLog)); 21149566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 211537b78d16SBarry Smith } 21169566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isascii)); 211728b400f6SJacob Faibussowitsch PetscCheck(isascii, PetscObjectComm((PetscObject)viewer), PETSC_ERR_SUP, "Currently can only view logging to ASCII"); 21189566063dSJacob Faibussowitsch PetscCall(PetscViewerGetFormat(viewer, &format)); 2119f14045dbSBarry Smith if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) { 21209566063dSJacob Faibussowitsch PetscCall(PetscLogView_Default(viewer)); 2121f14045dbSBarry Smith } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) { 21229566063dSJacob Faibussowitsch PetscCall(PetscLogView_Detailed(viewer)); 212338144912Sdeepblu2718 } else if (format == PETSC_VIEWER_ASCII_CSV) { 21249566063dSJacob Faibussowitsch PetscCall(PetscLogView_CSV(viewer)); 2125bb1d7374SBarry Smith } else if (format == PETSC_VIEWER_ASCII_XML) { 21269566063dSJacob Faibussowitsch PetscCall(PetscLogView_Nested(viewer)); 2127d0a29bd7SConnor Ward } else if (format == PETSC_VIEWER_ASCII_FLAMEGRAPH) { 21289566063dSJacob Faibussowitsch PetscCall(PetscLogView_Flamegraph(viewer)); 21295c6c1daeSBarry Smith } 21309566063dSJacob Faibussowitsch PetscCall(PetscStageLogPush(stageLog, lastStage)); 21315c6c1daeSBarry Smith PetscFunctionReturn(0); 21325c6c1daeSBarry Smith } 21335c6c1daeSBarry Smith 2134f14045dbSBarry Smith /*@C 2135811af0c4SBarry Smith PetscLogViewFromOptions - Processes command line options to determine if/how a `PetscLog` is to be viewed. 2136f14045dbSBarry Smith 2137811af0c4SBarry Smith Collective on `PETSC_COMM_WORLD` 2138f14045dbSBarry Smith 2139811af0c4SBarry Smith Level: developer 2140f14045dbSBarry Smith 2141811af0c4SBarry Smith .seealso: `PetscLogView()` 2142f14045dbSBarry Smith @*/ 2143d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogViewFromOptions(void) 2144d71ae5a4SJacob Faibussowitsch { 2145f14045dbSBarry Smith PetscViewer viewer; 2146f14045dbSBarry Smith PetscBool flg; 2147f14045dbSBarry Smith PetscViewerFormat format; 2148f14045dbSBarry Smith 2149f14045dbSBarry Smith PetscFunctionBegin; 21509566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetViewer(PETSC_COMM_WORLD, NULL, NULL, "-log_view", &viewer, &format, &flg)); 2151f14045dbSBarry Smith if (flg) { 21529566063dSJacob Faibussowitsch PetscCall(PetscViewerPushFormat(viewer, format)); 21539566063dSJacob Faibussowitsch PetscCall(PetscLogView(viewer)); 21549566063dSJacob Faibussowitsch PetscCall(PetscViewerPopFormat(viewer)); 21559566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&viewer)); 2156f14045dbSBarry Smith } 2157f14045dbSBarry Smith PetscFunctionReturn(0); 2158f14045dbSBarry Smith } 2159f14045dbSBarry Smith 21605c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/ 21615c6c1daeSBarry Smith /*@C 21625c6c1daeSBarry Smith PetscGetFlops - Returns the number of flops used on this processor 21635c6c1daeSBarry Smith since the program began. 21645c6c1daeSBarry Smith 21655c6c1daeSBarry Smith Not Collective 21665c6c1daeSBarry Smith 21675c6c1daeSBarry Smith Output Parameter: 21685c6c1daeSBarry Smith flops - number of floating point operations 21695c6c1daeSBarry Smith 21705c6c1daeSBarry Smith Notes: 21715c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 2172811af0c4SBarry Smith `PetscLogFlops()` to increment this counter to include flops for the 21735c6c1daeSBarry Smith application code. 21745c6c1daeSBarry Smith 2175811af0c4SBarry Smith A separate counter `PetscLogGPUFlops()` logs the flops that occur on any GPU associated with this MPI rank 2176811af0c4SBarry Smith 21775c6c1daeSBarry Smith Level: intermediate 21785c6c1daeSBarry Smith 2179811af0c4SBarry Smith .seealso: `PetscLogGPUFlops()`, `PetscTime()`, `PetscLogFlops()` 21805c6c1daeSBarry Smith @*/ 2181d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscGetFlops(PetscLogDouble *flops) 2182d71ae5a4SJacob Faibussowitsch { 21835c6c1daeSBarry Smith PetscFunctionBegin; 21845c6c1daeSBarry Smith *flops = petsc_TotalFlops; 21855c6c1daeSBarry Smith PetscFunctionReturn(0); 21865c6c1daeSBarry Smith } 21875c6c1daeSBarry Smith 2188d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 2189d71ae5a4SJacob Faibussowitsch { 21905c6c1daeSBarry Smith size_t fullLength; 21915c6c1daeSBarry Smith va_list Argp; 21925c6c1daeSBarry Smith 21935c6c1daeSBarry Smith PetscFunctionBegin; 21945c6c1daeSBarry Smith if (!petsc_logObjects) PetscFunctionReturn(0); 21955c6c1daeSBarry Smith va_start(Argp, format); 21969566063dSJacob Faibussowitsch PetscCall(PetscVSNPrintf(petsc_objects[obj->id].info, 64, format, &fullLength, Argp)); 21975c6c1daeSBarry Smith va_end(Argp); 21985c6c1daeSBarry Smith PetscFunctionReturn(0); 21995c6c1daeSBarry Smith } 22005c6c1daeSBarry Smith 22015c6c1daeSBarry Smith /*MC 22025c6c1daeSBarry Smith PetscLogFlops - Adds floating point operations to the global counter. 22035c6c1daeSBarry Smith 22045c6c1daeSBarry Smith Synopsis: 2205aaa7dc30SBarry Smith #include <petsclog.h> 22065c6c1daeSBarry Smith PetscErrorCode PetscLogFlops(PetscLogDouble f) 22075c6c1daeSBarry Smith 22085c6c1daeSBarry Smith Not Collective 22095c6c1daeSBarry Smith 22105c6c1daeSBarry Smith Input Parameter: 22115c6c1daeSBarry Smith . f - flop counter 22125c6c1daeSBarry Smith 22135c6c1daeSBarry Smith Usage: 22145c6c1daeSBarry Smith .vb 22155c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 22165c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 22175c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 22185c6c1daeSBarry Smith [code segment to monitor] 22195c6c1daeSBarry Smith PetscLogFlops(user_flops) 22205c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 22215c6c1daeSBarry Smith .ve 22225c6c1daeSBarry Smith 2223811af0c4SBarry Smith Note: 22245c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 22255c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 22265c6c1daeSBarry Smith application code. 22275c6c1daeSBarry Smith 22285c6c1daeSBarry Smith Level: intermediate 22295c6c1daeSBarry Smith 2230811af0c4SBarry Smith .seealso: `PetscLogGPUFlops()`, `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscGetFlops()` 22315c6c1daeSBarry Smith M*/ 22325c6c1daeSBarry Smith 22335c6c1daeSBarry Smith /*MC 22345c6c1daeSBarry Smith PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice) 22355c6c1daeSBarry Smith to get accurate timings 22365c6c1daeSBarry Smith 22375c6c1daeSBarry Smith Synopsis: 2238aaa7dc30SBarry Smith #include <petsclog.h> 22395c6c1daeSBarry Smith void PetscPreLoadBegin(PetscBool flag,char *name); 22405c6c1daeSBarry Smith 22415c6c1daeSBarry Smith Not Collective 22425c6c1daeSBarry Smith 2243d8d19677SJose E. Roman Input Parameters: 2244811af0c4SBarry Smith + flag - PETSC_TRUE to run twice, `PETSC_FALSE` to run once, may be overridden 22455c6c1daeSBarry Smith with command line option -preload true or -preload false 2246609bdbeeSBarry Smith - name - name of first stage (lines of code timed separately with -log_view) to 22475c6c1daeSBarry Smith be preloaded 22485c6c1daeSBarry Smith 22495c6c1daeSBarry Smith Usage: 22505c6c1daeSBarry Smith .vb 22515c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22525c6c1daeSBarry Smith lines of code 22535c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22545c6c1daeSBarry Smith lines of code 22555c6c1daeSBarry Smith PetscPreLoadEnd(); 22565c6c1daeSBarry Smith .ve 22575c6c1daeSBarry Smith 2258811af0c4SBarry Smith Note: 225995452b02SPatrick Sanan Only works in C/C++, not Fortran 22605c6c1daeSBarry Smith 22615c6c1daeSBarry Smith Flags available within the macro. 22625c6c1daeSBarry Smith + PetscPreLoadingUsed - true if we are or have done preloading 22635c6c1daeSBarry Smith . PetscPreLoadingOn - true if it is CURRENTLY doing preload 22645c6c1daeSBarry Smith . PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second 22655c6c1daeSBarry Smith - PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on 22665c6c1daeSBarry Smith The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin() 22675c6c1daeSBarry Smith and PetscPreLoadEnd() 22685c6c1daeSBarry Smith 22695c6c1daeSBarry Smith Level: intermediate 22705c6c1daeSBarry Smith 2271db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 22725c6c1daeSBarry Smith M*/ 22735c6c1daeSBarry Smith 22745c6c1daeSBarry Smith /*MC 22755c6c1daeSBarry Smith PetscPreLoadEnd - End a segment of code that may be preloaded (run twice) 22765c6c1daeSBarry Smith to get accurate timings 22775c6c1daeSBarry Smith 22785c6c1daeSBarry Smith Synopsis: 2279aaa7dc30SBarry Smith #include <petsclog.h> 22805c6c1daeSBarry Smith void PetscPreLoadEnd(void); 22815c6c1daeSBarry Smith 22825c6c1daeSBarry Smith Not Collective 22835c6c1daeSBarry Smith 22845c6c1daeSBarry Smith Usage: 22855c6c1daeSBarry Smith .vb 22865c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22875c6c1daeSBarry Smith lines of code 22885c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22895c6c1daeSBarry Smith lines of code 22905c6c1daeSBarry Smith PetscPreLoadEnd(); 22915c6c1daeSBarry Smith .ve 22925c6c1daeSBarry Smith 2293811af0c4SBarry Smith Note: 2294811af0c4SBarry Smith Only works in C/C++ not fortran 22955c6c1daeSBarry Smith 22965c6c1daeSBarry Smith Level: intermediate 22975c6c1daeSBarry Smith 2298db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadStage()` 22995c6c1daeSBarry Smith M*/ 23005c6c1daeSBarry Smith 23015c6c1daeSBarry Smith /*MC 23025c6c1daeSBarry Smith PetscPreLoadStage - Start a new segment of code to be timed separately. 23035c6c1daeSBarry Smith to get accurate timings 23045c6c1daeSBarry Smith 23055c6c1daeSBarry Smith Synopsis: 2306aaa7dc30SBarry Smith #include <petsclog.h> 23075c6c1daeSBarry Smith void PetscPreLoadStage(char *name); 23085c6c1daeSBarry Smith 23095c6c1daeSBarry Smith Not Collective 23105c6c1daeSBarry Smith 23115c6c1daeSBarry Smith Usage: 23125c6c1daeSBarry Smith .vb 23135c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 23145c6c1daeSBarry Smith lines of code 23155c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 23165c6c1daeSBarry Smith lines of code 23175c6c1daeSBarry Smith PetscPreLoadEnd(); 23185c6c1daeSBarry Smith .ve 23195c6c1daeSBarry Smith 2320811af0c4SBarry Smith Note: 2321811af0c4SBarry Smith Only works in C/C++ not fortran 23225c6c1daeSBarry Smith 23235c6c1daeSBarry Smith Level: intermediate 23245c6c1daeSBarry Smith 2325db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()` 23265c6c1daeSBarry Smith M*/ 23275c6c1daeSBarry Smith 2328a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_DEVICE) 2329a4af0ceeSJacob Faibussowitsch #include <petsc/private/deviceimpl.h> 23309ffd0706SHong Zhang 2331156b51fbSBarry Smith PetscBool PetscLogGpuTimeFlag = PETSC_FALSE; 2332156b51fbSBarry Smith 2333156b51fbSBarry Smith /* 2334156b51fbSBarry Smith This cannot be called by users between PetscInitialize() and PetscFinalize() at any random location in the code 2335156b51fbSBarry Smith because it will result in timing results that cannot be interpreted. 2336156b51fbSBarry Smith */ 2337d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogGpuTime_Off(void) 2338d71ae5a4SJacob Faibussowitsch { 2339156b51fbSBarry Smith PetscLogGpuTimeFlag = PETSC_FALSE; 2340156b51fbSBarry Smith return 0; 2341156b51fbSBarry Smith } 2342156b51fbSBarry Smith 2343156b51fbSBarry Smith /*@C 2344156b51fbSBarry Smith PetscLogGpuTime - turn on the logging of GPU time for GPU kernels 2345156b51fbSBarry Smith 2346811af0c4SBarry Smith Options Database Key: 2347156b51fbSBarry Smith . -log_view_gpu_time - provide the GPU times in the -log_view output 2348156b51fbSBarry Smith 2349156b51fbSBarry Smith Notes: 2350811af0c4SBarry Smith Turning on the timing of the 2351156b51fbSBarry Smith GPU kernels can slow down the entire computation and should only be used when studying the performance 2352156b51fbSBarry Smith of operations on GPU such as vector operations and matrix-vector operations. 2353156b51fbSBarry Smith 2354156b51fbSBarry Smith This routine should only be called once near the beginning of the program. Once it is started it cannot be turned off. 2355156b51fbSBarry Smith 23560f8f8846SPatrick Sanan Level: advanced 23570f8f8846SPatrick Sanan 2358db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuTimeBegin()` 2359156b51fbSBarry Smith @*/ 2360d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGpuTime(void) 2361d71ae5a4SJacob Faibussowitsch { 2362156b51fbSBarry Smith if (!PetscLogGpuTimeFlag) PetscCall(PetscRegisterFinalize(PetscLogGpuTime_Off)); 2363156b51fbSBarry Smith PetscLogGpuTimeFlag = PETSC_TRUE; 2364156b51fbSBarry Smith return 0; 2365156b51fbSBarry Smith } 2366156b51fbSBarry Smith 23679ffd0706SHong Zhang /*@C 23689ffd0706SHong Zhang PetscLogGpuTimeBegin - Start timer for device 23699ffd0706SHong Zhang 23709ffd0706SHong Zhang Notes: 23719ffd0706SHong 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). 2372811af0c4SBarry Smith 23739ffd0706SHong 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). 2374811af0c4SBarry Smith 2375811af0c4SBarry Smith There is no need to call WaitForCUDA() or WaitForHIP() between `PetscLogGpuTimeBegin()` and `PetscLogGpuTimeEnd()` 2376811af0c4SBarry Smith 23779ffd0706SHong Zhang This timer should NOT include times for data transfers between the GPU and CPU, nor setup actions such as allocating space. 2378811af0c4SBarry Smith 23799ffd0706SHong Zhang The regular logging captures the time for data transfers and any CPU activites during the event 2380811af0c4SBarry Smith 23819ffd0706SHong Zhang It is used to compute the flop rate on the GPU as it is actively engaged in running a kernel. 23829ffd0706SHong Zhang 23839ffd0706SHong Zhang Developer Notes: 2384811af0c4SBarry 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()`. 2385811af0c4SBarry Smith 2386811af0c4SBarry 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 2387811af0c4SBarry Smith event when it reaches that event in the stream. The function xxxEventSynchronize() is called in `PetsLogGpuTimeEnd()` to block CPU execution, 2388811af0c4SBarry Smith but not continued GPU excution, until the timer event is recorded. 23899ffd0706SHong Zhang 23909ffd0706SHong Zhang Level: intermediate 23919ffd0706SHong Zhang 2392db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuTime()` 23939ffd0706SHong Zhang @*/ 2394d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGpuTimeBegin(void) 2395d71ae5a4SJacob Faibussowitsch { 23969ffd0706SHong Zhang PetscFunctionBegin; 2397156b51fbSBarry Smith if (!PetscLogPLB || !PetscLogGpuTimeFlag) PetscFunctionReturn(0); 2398a4af0ceeSJacob Faibussowitsch if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) { 2399a4af0ceeSJacob Faibussowitsch PetscDeviceContext dctx; 2400a4af0ceeSJacob Faibussowitsch 24019566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextGetCurrentContext(&dctx)); 24029566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextBeginTimer_Internal(dctx)); 2403a4af0ceeSJacob Faibussowitsch } else { 24049566063dSJacob Faibussowitsch PetscCall(PetscTimeSubtract(&petsc_gtime)); 2405a4af0ceeSJacob Faibussowitsch } 24069ffd0706SHong Zhang PetscFunctionReturn(0); 24079ffd0706SHong Zhang } 24089ffd0706SHong Zhang 24099ffd0706SHong Zhang /*@C 24109ffd0706SHong Zhang PetscLogGpuTimeEnd - Stop timer for device 24119ffd0706SHong Zhang 24129ffd0706SHong Zhang Level: intermediate 24139ffd0706SHong Zhang 2414db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeBegin()` 24159ffd0706SHong Zhang @*/ 2416d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGpuTimeEnd(void) 2417d71ae5a4SJacob Faibussowitsch { 24189ffd0706SHong Zhang PetscFunctionBegin; 2419156b51fbSBarry Smith if (!PetscLogPLE || !PetscLogGpuTimeFlag) PetscFunctionReturn(0); 2420a4af0ceeSJacob Faibussowitsch if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) { 2421a4af0ceeSJacob Faibussowitsch PetscDeviceContext dctx; 2422a4af0ceeSJacob Faibussowitsch PetscLogDouble elapsed; 2423a4af0ceeSJacob Faibussowitsch 24249566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextGetCurrentContext(&dctx)); 24259566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextEndTimer_Internal(dctx, &elapsed)); 2426a4af0ceeSJacob Faibussowitsch petsc_gtime += (elapsed / 1000.0); 2427a4af0ceeSJacob Faibussowitsch } else { 24289566063dSJacob Faibussowitsch PetscCall(PetscTimeAdd(&petsc_gtime)); 2429a4af0ceeSJacob Faibussowitsch } 24309ffd0706SHong Zhang PetscFunctionReturn(0); 24319ffd0706SHong Zhang } 24329ffd0706SHong Zhang #endif /* end of PETSC_HAVE_DEVICE */ 24339ffd0706SHong Zhang 24345c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */ 24355c6c1daeSBarry Smith 2436d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 2437d71ae5a4SJacob Faibussowitsch { 24385c6c1daeSBarry Smith PetscFunctionBegin; 24395c6c1daeSBarry Smith PetscFunctionReturn(0); 24405c6c1daeSBarry Smith } 24415c6c1daeSBarry Smith 24425c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/ 24435c6c1daeSBarry Smith 24445c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 24455c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID = 0; 24465c6c1daeSBarry Smith 24475c6c1daeSBarry Smith /*@C 24485c6c1daeSBarry Smith PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code. 24495c6c1daeSBarry Smith 24505c6c1daeSBarry Smith Not Collective 24515c6c1daeSBarry Smith 24525c6c1daeSBarry Smith Input Parameter: 24535c6c1daeSBarry Smith . name - The class name 24545c6c1daeSBarry Smith 24555c6c1daeSBarry Smith Output Parameter: 24565c6c1daeSBarry Smith . oclass - The class id or classid 24575c6c1daeSBarry Smith 24585c6c1daeSBarry Smith Level: developer 24595c6c1daeSBarry Smith 2460811af0c4SBarry Smith .seealso: `PetscLogEventRegister()` 24615c6c1daeSBarry Smith @*/ 2462d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscClassIdRegister(const char name[], PetscClassId *oclass) 2463d71ae5a4SJacob Faibussowitsch { 24645c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 24655c6c1daeSBarry Smith PetscStageLog stageLog; 24665c6c1daeSBarry Smith PetscInt stage; 24675c6c1daeSBarry Smith #endif 24685c6c1daeSBarry Smith 24695c6c1daeSBarry Smith PetscFunctionBegin; 24705c6c1daeSBarry Smith *oclass = ++PETSC_LARGEST_CLASSID; 24715c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 24729566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 24739566063dSJacob Faibussowitsch PetscCall(PetscClassRegLogRegister(stageLog->classLog, name, *oclass)); 247448a46eb9SPierre Jolivet for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses)); 24755c6c1daeSBarry Smith #endif 24765c6c1daeSBarry Smith PetscFunctionReturn(0); 24775c6c1daeSBarry Smith } 2478210b5426SBarry Smith 2479210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE) 2480210b5426SBarry Smith #include <mpe.h> 2481210b5426SBarry Smith 2482210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE; 2483210b5426SBarry Smith 2484495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject); 2485495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject); 2486495fc317SBarry Smith 2487210b5426SBarry Smith /*@C 2488210b5426SBarry Smith PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files 2489210b5426SBarry Smith and slows the program down. 2490210b5426SBarry Smith 2491811af0c4SBarry Smith Collective over `PETSC_COMM_WORLD` 2492210b5426SBarry Smith 2493811af0c4SBarry Smith Options Database Key: 2494a2553e36SBarry Smith . -log_mpe - Prints extensive log information 2495210b5426SBarry Smith 2496811af0c4SBarry Smith Note: 2497811af0c4SBarry Smith A related routine is `PetscLogDefaultBegin()` (with the options key -log_view), which is 2498210b5426SBarry Smith intended for production runs since it logs only flop rates and object 2499210b5426SBarry Smith creation (and should not significantly slow the programs). 2500210b5426SBarry Smith 2501210b5426SBarry Smith Level: advanced 2502210b5426SBarry Smith 2503db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogEventActivate()`, 2504db781477SPatrick Sanan `PetscLogEventDeactivate()` 2505210b5426SBarry Smith @*/ 2506d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogMPEBegin(void) 2507d71ae5a4SJacob Faibussowitsch { 2508210b5426SBarry Smith PetscFunctionBegin; 2509210b5426SBarry Smith /* Do MPE initialization */ 2510210b5426SBarry Smith if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */ 25119566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "Initializing MPE.\n")); 25129566063dSJacob Faibussowitsch PetscCall(MPE_Init_log()); 2513210b5426SBarry Smith 2514210b5426SBarry Smith PetscBeganMPE = PETSC_TRUE; 2515210b5426SBarry Smith } else { 25169566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "MPE already initialized. Not attempting to reinitialize.\n")); 2517210b5426SBarry Smith } 25189566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE)); 2519210b5426SBarry Smith PetscFunctionReturn(0); 2520210b5426SBarry Smith } 2521210b5426SBarry Smith 2522210b5426SBarry Smith /*@C 2523495fc317SBarry Smith PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot. 2524210b5426SBarry Smith 2525811af0c4SBarry Smith Collective over `PETSC_COMM_WORLD` 2526210b5426SBarry Smith 2527210b5426SBarry Smith Level: advanced 2528210b5426SBarry Smith 2529db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogMPEBegin()` 2530210b5426SBarry Smith @*/ 2531d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogMPEDump(const char sname[]) 2532d71ae5a4SJacob Faibussowitsch { 2533210b5426SBarry Smith char name[PETSC_MAX_PATH_LEN]; 2534210b5426SBarry Smith 2535210b5426SBarry Smith PetscFunctionBegin; 2536210b5426SBarry Smith if (PetscBeganMPE) { 25379566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "Finalizing MPE.\n")); 2538210b5426SBarry Smith if (sname) { 25399566063dSJacob Faibussowitsch PetscCall(PetscStrcpy(name, sname)); 2540210b5426SBarry Smith } else { 25419566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(name, sizeof(name))); 2542210b5426SBarry Smith } 25439566063dSJacob Faibussowitsch PetscCall(MPE_Finish_log(name)); 2544210b5426SBarry Smith } else { 25459566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "Not finalizing MPE (not started by PETSc).\n")); 2546210b5426SBarry Smith } 2547210b5426SBarry Smith PetscFunctionReturn(0); 2548210b5426SBarry Smith } 2549210b5426SBarry Smith 2550210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39 25519371c9d4SSatish Balay static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = {"OliveDrab: ", "BlueViolet: ", "CadetBlue: ", "CornflowerBlue: ", "DarkGoldenrod: ", "DarkGreen: ", "DarkKhaki: ", "DarkOliveGreen: ", 25529371c9d4SSatish Balay "DarkOrange: ", "DarkOrchid: ", "DarkSeaGreen: ", "DarkSlateGray: ", "DarkTurquoise: ", "DeepPink: ", "DarkKhaki: ", "DimGray: ", 25539371c9d4SSatish Balay "DodgerBlue: ", "GreenYellow: ", "HotPink: ", "IndianRed: ", "LavenderBlush: ", "LawnGreen: ", "LemonChiffon: ", "LightCoral: ", 25549371c9d4SSatish Balay "LightCyan: ", "LightPink: ", "LightSalmon: ", "LightSlateGray: ", "LightYellow: ", "LimeGreen: ", "MediumPurple: ", "MediumSeaGreen: ", 25559371c9d4SSatish Balay "MediumSlateBlue:", "MidnightBlue: ", "MintCream: ", "MistyRose: ", "NavajoWhite: ", "NavyBlue: ", "OliveDrab: "}; 2556210b5426SBarry Smith 2557210b5426SBarry Smith /*@C 2558811af0c4SBarry Smith PetscLogMPEGetRGBColor - This routine returns a rgb color useable with `PetscLogEventRegister()` 2559210b5426SBarry Smith 2560210b5426SBarry Smith Not collective. Maybe it should be? 2561210b5426SBarry Smith 25627a7aea1fSJed Brown Output Parameter: 2563210b5426SBarry Smith . str - character string representing the color 2564210b5426SBarry Smith 2565210b5426SBarry Smith Level: developer 2566210b5426SBarry Smith 2567811af0c4SBarry Smith .seealso: `PetscLogEventRegister()` 2568210b5426SBarry Smith @*/ 2569d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogMPEGetRGBColor(const char *str[]) 2570d71ae5a4SJacob Faibussowitsch { 2571210b5426SBarry Smith static int idx = 0; 2572210b5426SBarry Smith 2573210b5426SBarry Smith PetscFunctionBegin; 2574210b5426SBarry Smith *str = PetscLogMPERGBColors[idx]; 2575210b5426SBarry Smith idx = (idx + 1) % PETSC_RGB_COLORS_MAX; 2576210b5426SBarry Smith PetscFunctionReturn(0); 2577210b5426SBarry Smith } 2578210b5426SBarry Smith 2579210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */ 2580