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> 148fe3844cSJunchao Zhang #include <petscdevice.h> 158fe3844cSJunchao Zhang #include <petsc/private/deviceimpl.h> 165c6c1daeSBarry Smith 175c6c1daeSBarry Smith PetscLogEvent PETSC_LARGEST_EVENT = PETSC_EVENT; 185c6c1daeSBarry Smith 195c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 205c6c1daeSBarry Smith #include <petscmachineinfo.h> 215c6c1daeSBarry Smith #include <petscconfiginfo.h> 225c6c1daeSBarry Smith 235c6c1daeSBarry Smith /* used in the MPI_XXX() count macros in petsclog.h */ 245c6c1daeSBarry Smith 255c6c1daeSBarry Smith /* Action and object logging variables */ 260298fd71SBarry Smith Action *petsc_actions = NULL; 270298fd71SBarry Smith Object *petsc_objects = NULL; 285c6c1daeSBarry Smith PetscBool petsc_logActions = PETSC_FALSE; 295c6c1daeSBarry Smith PetscBool petsc_logObjects = PETSC_FALSE; 305c6c1daeSBarry Smith int petsc_numActions = 0, petsc_maxActions = 100; 315c6c1daeSBarry Smith int petsc_numObjects = 0, petsc_maxObjects = 100; 325c6c1daeSBarry Smith int petsc_numObjectsDestroyed = 0; 335c6c1daeSBarry Smith 345c6c1daeSBarry Smith /* Global counters */ 355c6c1daeSBarry Smith PetscLogDouble petsc_BaseTime = 0.0; 365c6c1daeSBarry Smith PetscLogDouble petsc_TotalFlops = 0.0; /* The number of flops */ 375c6c1daeSBarry Smith PetscLogDouble petsc_tmp_flops = 0.0; /* The incremental number of flops */ 385c6c1daeSBarry Smith PetscLogDouble petsc_send_ct = 0.0; /* The number of sends */ 395c6c1daeSBarry Smith PetscLogDouble petsc_recv_ct = 0.0; /* The number of receives */ 405c6c1daeSBarry Smith PetscLogDouble petsc_send_len = 0.0; /* The total length of all sent messages */ 415c6c1daeSBarry Smith PetscLogDouble petsc_recv_len = 0.0; /* The total length of all received messages */ 425c6c1daeSBarry Smith PetscLogDouble petsc_isend_ct = 0.0; /* The number of immediate sends */ 435c6c1daeSBarry Smith PetscLogDouble petsc_irecv_ct = 0.0; /* The number of immediate receives */ 445c6c1daeSBarry Smith PetscLogDouble petsc_isend_len = 0.0; /* The total length of all immediate send messages */ 455c6c1daeSBarry Smith PetscLogDouble petsc_irecv_len = 0.0; /* The total length of all immediate receive messages */ 465c6c1daeSBarry Smith PetscLogDouble petsc_wait_ct = 0.0; /* The number of waits */ 475c6c1daeSBarry Smith PetscLogDouble petsc_wait_any_ct = 0.0; /* The number of anywaits */ 485c6c1daeSBarry Smith PetscLogDouble petsc_wait_all_ct = 0.0; /* The number of waitalls */ 495c6c1daeSBarry Smith PetscLogDouble petsc_sum_of_waits_ct = 0.0; /* The total number of waits */ 505c6c1daeSBarry Smith PetscLogDouble petsc_allreduce_ct = 0.0; /* The number of reductions */ 515c6c1daeSBarry Smith PetscLogDouble petsc_gather_ct = 0.0; /* The number of gathers and gathervs */ 525c6c1daeSBarry Smith PetscLogDouble petsc_scatter_ct = 0.0; /* The number of scatters and scattervs */ 5320c24465SJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 54bec0b493Shannah_mairs PetscLogDouble petsc_ctog_ct = 0.0; /* The total number of CPU to GPU copies */ 55bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_ct = 0.0; /* The total number of GPU to CPU copies */ 56bec0b493Shannah_mairs PetscLogDouble petsc_ctog_sz = 0.0; /* The total size of CPU to GPU copies */ 57bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_sz = 0.0; /* The total size of GPU to CPU copies */ 5845c4b7c1SBarry Smith PetscLogDouble petsc_ctog_ct_scalar = 0.0; /* The total number of CPU to GPU copies */ 5945c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_ct_scalar = 0.0; /* The total number of GPU to CPU copies */ 6045c4b7c1SBarry Smith PetscLogDouble petsc_ctog_sz_scalar = 0.0; /* The total size of CPU to GPU copies */ 6145c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_sz_scalar = 0.0; /* The total size of GPU to CPU copies */ 62958c4211Shannah_mairs PetscLogDouble petsc_gflops = 0.0; /* The flops done on a GPU */ 63958c4211Shannah_mairs PetscLogDouble petsc_gtime = 0.0; /* The time spent on a GPU */ 64bec0b493Shannah_mairs #endif 655c6c1daeSBarry Smith 665c6c1daeSBarry Smith /* Logging functions */ 670298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL; 680298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL; 690298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 700298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 715c6c1daeSBarry Smith 725c6c1daeSBarry Smith /* Tracing event logging variables */ 730298fd71SBarry Smith FILE *petsc_tracefile = NULL; 745c6c1daeSBarry Smith int petsc_tracelevel = 0; 755c6c1daeSBarry Smith const char *petsc_traceblanks = " "; 765c6c1daeSBarry Smith char petsc_tracespace[128] = " "; 775c6c1daeSBarry Smith PetscLogDouble petsc_tracetime = 0.0; 78896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE; 795c6c1daeSBarry Smith 807a101e5eSJacob Faibussowitsch static PetscIntStack current_log_event_stack = NULL; 817a101e5eSJacob Faibussowitsch 82d71ae5a4SJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogInitialize(void) 83d71ae5a4SJacob Faibussowitsch { 84fa2bb9feSLisandro Dalcin int stage; 85fa2bb9feSLisandro Dalcin PetscBool opt; 865c6c1daeSBarry Smith 87fa2bb9feSLisandro Dalcin PetscFunctionBegin; 88fa2bb9feSLisandro Dalcin if (PetscLogInitializeCalled) PetscFunctionReturn(0); 89fa2bb9feSLisandro Dalcin PetscLogInitializeCalled = PETSC_TRUE; 905c6c1daeSBarry Smith 917a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackCreate(¤t_log_event_stack)); 929566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL, NULL, "-log_exclude_actions", &opt)); 93fa2bb9feSLisandro Dalcin if (opt) petsc_logActions = PETSC_FALSE; 949566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL, NULL, "-log_exclude_objects", &opt)); 95fa2bb9feSLisandro Dalcin if (opt) petsc_logObjects = PETSC_FALSE; 9648a46eb9SPierre Jolivet if (petsc_logActions) PetscCall(PetscMalloc1(petsc_maxActions, &petsc_actions)); 9748a46eb9SPierre Jolivet if (petsc_logObjects) PetscCall(PetscMalloc1(petsc_maxObjects, &petsc_objects)); 98fa2bb9feSLisandro Dalcin PetscLogPHC = PetscLogObjCreateDefault; 99fa2bb9feSLisandro Dalcin PetscLogPHD = PetscLogObjDestroyDefault; 100fa2bb9feSLisandro Dalcin /* Setup default logging structures */ 1019566063dSJacob Faibussowitsch PetscCall(PetscStageLogCreate(&petsc_stageLog)); 1029566063dSJacob Faibussowitsch PetscCall(PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage)); 1035c6c1daeSBarry Smith 104fa2bb9feSLisandro Dalcin /* All processors sync here for more consistent logging */ 1059566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(PETSC_COMM_WORLD)); 106fa2bb9feSLisandro Dalcin PetscTime(&petsc_BaseTime); 1079566063dSJacob Faibussowitsch PetscCall(PetscLogStagePush(stage)); 108fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 109fa2bb9feSLisandro Dalcin } 1105c6c1daeSBarry Smith 111d71ae5a4SJacob Faibussowitsch PETSC_INTERN PetscErrorCode PetscLogFinalize(void) 112d71ae5a4SJacob Faibussowitsch { 1135c6c1daeSBarry Smith PetscStageLog stageLog; 1145c6c1daeSBarry Smith 1155c6c1daeSBarry Smith PetscFunctionBegin; 1169566063dSJacob Faibussowitsch PetscCall(PetscFree(petsc_actions)); 1179566063dSJacob Faibussowitsch PetscCall(PetscFree(petsc_objects)); 1189566063dSJacob Faibussowitsch PetscCall(PetscLogNestedEnd()); 1199566063dSJacob Faibussowitsch PetscCall(PetscLogSet(NULL, NULL)); 1205c6c1daeSBarry Smith 1215c6c1daeSBarry Smith /* Resetting phase */ 1229566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 1239566063dSJacob Faibussowitsch PetscCall(PetscStageLogDestroy(stageLog)); 1247a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackDestroy(current_log_event_stack)); 1257a101e5eSJacob Faibussowitsch current_log_event_stack = NULL; 126a297a907SKarl Rupp 1275c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1285c6c1daeSBarry Smith petsc_numActions = 0; 1295c6c1daeSBarry Smith petsc_numObjects = 0; 1305c6c1daeSBarry Smith petsc_numObjectsDestroyed = 0; 1315c6c1daeSBarry Smith petsc_maxActions = 100; 1325c6c1daeSBarry Smith petsc_maxObjects = 100; 1330298fd71SBarry Smith petsc_actions = NULL; 1340298fd71SBarry Smith petsc_objects = NULL; 1355c6c1daeSBarry Smith petsc_logActions = PETSC_FALSE; 1365c6c1daeSBarry Smith petsc_logObjects = PETSC_FALSE; 1375c6c1daeSBarry Smith petsc_BaseTime = 0.0; 1385c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1395c6c1daeSBarry Smith petsc_tmp_flops = 0.0; 1405c6c1daeSBarry Smith petsc_send_ct = 0.0; 1415c6c1daeSBarry Smith petsc_recv_ct = 0.0; 1425c6c1daeSBarry Smith petsc_send_len = 0.0; 1435c6c1daeSBarry Smith petsc_recv_len = 0.0; 1445c6c1daeSBarry Smith petsc_isend_ct = 0.0; 1455c6c1daeSBarry Smith petsc_irecv_ct = 0.0; 1465c6c1daeSBarry Smith petsc_isend_len = 0.0; 1475c6c1daeSBarry Smith petsc_irecv_len = 0.0; 1485c6c1daeSBarry Smith petsc_wait_ct = 0.0; 1495c6c1daeSBarry Smith petsc_wait_any_ct = 0.0; 1505c6c1daeSBarry Smith petsc_wait_all_ct = 0.0; 1515c6c1daeSBarry Smith petsc_sum_of_waits_ct = 0.0; 1525c6c1daeSBarry Smith petsc_allreduce_ct = 0.0; 1535c6c1daeSBarry Smith petsc_gather_ct = 0.0; 1545c6c1daeSBarry Smith petsc_scatter_ct = 0.0; 155d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 156bec0b493Shannah_mairs petsc_ctog_ct = 0.0; 157bec0b493Shannah_mairs petsc_gtoc_ct = 0.0; 158bec0b493Shannah_mairs petsc_ctog_sz = 0.0; 159bec0b493Shannah_mairs petsc_gtoc_sz = 0.0; 160958c4211Shannah_mairs petsc_gflops = 0.0; 161958c4211Shannah_mairs petsc_gtime = 0.0; 162bec0b493Shannah_mairs #endif 1635c6c1daeSBarry Smith PETSC_LARGEST_EVENT = PETSC_EVENT; 1640298fd71SBarry Smith PetscLogPHC = NULL; 1650298fd71SBarry Smith PetscLogPHD = NULL; 1660298fd71SBarry Smith petsc_tracefile = NULL; 1675c6c1daeSBarry Smith petsc_tracelevel = 0; 1685c6c1daeSBarry Smith petsc_traceblanks = " "; 1699371c9d4SSatish Balay petsc_tracespace[0] = ' '; 1709371c9d4SSatish Balay petsc_tracespace[1] = 0; 1715c6c1daeSBarry Smith petsc_tracetime = 0.0; 1725c6c1daeSBarry Smith PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 1735c6c1daeSBarry Smith PETSC_OBJECT_CLASSID = 0; 17402c9f0b5SLisandro Dalcin petsc_stageLog = NULL; 175896238b9SBarry Smith PetscLogInitializeCalled = PETSC_FALSE; 1765c6c1daeSBarry Smith PetscFunctionReturn(0); 1775c6c1daeSBarry Smith } 1785c6c1daeSBarry Smith 1795c6c1daeSBarry Smith /*@C 1805c6c1daeSBarry Smith PetscLogSet - Sets the logging functions called at the beginning and ending of every event. 1815c6c1daeSBarry Smith 1825c6c1daeSBarry Smith Not Collective 1835c6c1daeSBarry Smith 1845c6c1daeSBarry Smith Input Parameters: 1855c6c1daeSBarry Smith + b - The function called at beginning of event 1865c6c1daeSBarry Smith - e - The function called at end of event 1875c6c1daeSBarry Smith 1885c6c1daeSBarry Smith Level: developer 1895c6c1daeSBarry Smith 190811af0c4SBarry Smith Developer Note: 191811af0c4SBarry Smith The default loggers are `PetscLogEventBeginDefault()` and `PetscLogEventEndDefault()`. 192811af0c4SBarry Smith 193d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogTraceBegin()`, `PetscLogEventBeginDefault()`, `PetscLogEventEndDefault()` 1945c6c1daeSBarry Smith @*/ 195d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject)) 196d71ae5a4SJacob Faibussowitsch { 1975c6c1daeSBarry Smith PetscFunctionBegin; 1985c6c1daeSBarry Smith PetscLogPLB = b; 1995c6c1daeSBarry Smith PetscLogPLE = e; 2005c6c1daeSBarry Smith PetscFunctionReturn(0); 2015c6c1daeSBarry Smith } 2025c6c1daeSBarry Smith 2035c6c1daeSBarry Smith /*@C 2044dd65854SConnor Ward PetscLogIsActive - Check if logging is currently in progress. 2054dd65854SConnor Ward 2064dd65854SConnor Ward Not Collective 2074dd65854SConnor Ward 2084dd65854SConnor Ward Output Parameter: 209811af0c4SBarry Smith . isActive - `PETSC_TRUE` if logging is in progress, `PETSC_FALSE` otherwise 2104dd65854SConnor Ward 2114dd65854SConnor Ward Level: beginner 2124dd65854SConnor Ward 213d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogSet()` 2144dd65854SConnor Ward @*/ 215d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogIsActive(PetscBool *isActive) 216d71ae5a4SJacob Faibussowitsch { 2174dd65854SConnor Ward PetscFunctionBegin; 2184dd65854SConnor Ward *isActive = (PetscLogPLB && PetscLogPLE) ? PETSC_TRUE : PETSC_FALSE; 2194dd65854SConnor Ward PetscFunctionReturn(0); 2204dd65854SConnor Ward } 2214dd65854SConnor Ward 2224dd65854SConnor Ward /*@C 223811af0c4SBarry Smith PetscLogDefaultBegin - Turns on logging of objects and events using the default logging functions `PetscLogEventBeginDefault()` and `PetscLogEventEndDefault()`. This logs flop 2245c6c1daeSBarry Smith rates and object creation and should not slow programs down too much. 2255c6c1daeSBarry Smith This routine may be called more than once. 2265c6c1daeSBarry Smith 227811af0c4SBarry Smith Logically Collective over `PETSC_COMM_WORLD` 2285c6c1daeSBarry Smith 229811af0c4SBarry Smith Options Database Key: 230a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the 231a2553e36SBarry Smith screen (for code configured with --with-log=1 (which is the default)) 2325c6c1daeSBarry Smith 2335c6c1daeSBarry Smith Usage: 2345c6c1daeSBarry Smith .vb 2355c6c1daeSBarry Smith PetscInitialize(...); 236bb1d7374SBarry Smith PetscLogDefaultBegin(); 2375c6c1daeSBarry Smith ... code ... 2385c6c1daeSBarry Smith PetscLogView(viewer); or PetscLogDump(); 2395c6c1daeSBarry Smith PetscFinalize(); 2405c6c1daeSBarry Smith .ve 2415c6c1daeSBarry Smith 242d1f92df0SBarry Smith Level: advanced 243d1f92df0SBarry Smith 244811af0c4SBarry Smith Note: 245811af0c4SBarry Smith `PetscLogView()` or `PetscLogDump()` actually cause the printing of 2465c6c1daeSBarry Smith the logging information. 2475c6c1daeSBarry Smith 248d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogView()`, `PetscLogTraceBegin()` 2495c6c1daeSBarry Smith @*/ 250d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogDefaultBegin(void) 251d71ae5a4SJacob Faibussowitsch { 2525c6c1daeSBarry Smith PetscFunctionBegin; 2539566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault)); 2545c6c1daeSBarry Smith PetscFunctionReturn(0); 2555c6c1daeSBarry Smith } 2565c6c1daeSBarry Smith 2575c6c1daeSBarry Smith /*@C 2585c6c1daeSBarry Smith PetscLogAllBegin - Turns on extensive logging of objects and events. Logs 2595c6c1daeSBarry Smith all events. This creates large log files and slows the program down. 2605c6c1daeSBarry Smith 261811af0c4SBarry Smith Logically Collective on `PETSC_COMM_WORLD` 2625c6c1daeSBarry Smith 263811af0c4SBarry Smith Options Database Key: 264a2553e36SBarry Smith . -log_all - Prints extensive log information 2655c6c1daeSBarry Smith 2665c6c1daeSBarry Smith Usage: 2675c6c1daeSBarry Smith .vb 2685c6c1daeSBarry Smith PetscInitialize(...); 2695c6c1daeSBarry Smith PetscLogAllBegin(); 2705c6c1daeSBarry Smith ... code ... 2715c6c1daeSBarry Smith PetscLogDump(filename); 2725c6c1daeSBarry Smith PetscFinalize(); 2735c6c1daeSBarry Smith .ve 2745c6c1daeSBarry Smith 275d1f92df0SBarry Smith Level: advanced 276d1f92df0SBarry Smith 277811af0c4SBarry Smith Note: 278811af0c4SBarry Smith A related routine is `PetscLogDefaultBegin()` (with the options key -log_view), which is 2795c6c1daeSBarry Smith intended for production runs since it logs only flop rates and object 2805c6c1daeSBarry Smith creation (and shouldn't significantly slow the programs). 2815c6c1daeSBarry Smith 282d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogTraceBegin()` 2835c6c1daeSBarry Smith @*/ 284d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogAllBegin(void) 285d71ae5a4SJacob Faibussowitsch { 2865c6c1daeSBarry Smith PetscFunctionBegin; 2879566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete)); 2885c6c1daeSBarry Smith PetscFunctionReturn(0); 2895c6c1daeSBarry Smith } 2905c6c1daeSBarry Smith 291956f8c0dSBarry Smith /*@C 2925c6c1daeSBarry Smith PetscLogTraceBegin - Activates trace logging. Every time a PETSc event 2935c6c1daeSBarry Smith begins or ends, the event name is printed. 2945c6c1daeSBarry Smith 295811af0c4SBarry Smith Logically Collective on `PETSC_COMM_WORLD` 2965c6c1daeSBarry Smith 2975c6c1daeSBarry Smith Input Parameter: 2985c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout) 2995c6c1daeSBarry Smith 3005c6c1daeSBarry Smith Options Database Key: 301811af0c4SBarry Smith . -log_trace [filename] - Activates `PetscLogTraceBegin()` 3025c6c1daeSBarry Smith 303d1f92df0SBarry Smith Level: intermediate 304d1f92df0SBarry Smith 3055c6c1daeSBarry Smith Notes: 306811af0c4SBarry Smith `PetscLogTraceBegin()` prints the processor number, the execution time (sec), 3075c6c1daeSBarry Smith then "Event begin:" or "Event end:" followed by the event name. 3085c6c1daeSBarry Smith 309811af0c4SBarry Smith `PetscLogTraceBegin()` allows tracing of all PETSc calls, which is useful 3105c6c1daeSBarry Smith to determine where a program is hanging without running in the 3115c6c1daeSBarry Smith debugger. Can be used in conjunction with the -info option. 3125c6c1daeSBarry Smith 313d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogView()`, `PetscLogDefaultBegin()` 3145c6c1daeSBarry Smith @*/ 315d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogTraceBegin(FILE *file) 316d71ae5a4SJacob Faibussowitsch { 3175c6c1daeSBarry Smith PetscFunctionBegin; 3185c6c1daeSBarry Smith petsc_tracefile = file; 319a297a907SKarl Rupp 3209566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace)); 3215c6c1daeSBarry Smith PetscFunctionReturn(0); 3225c6c1daeSBarry Smith } 3235c6c1daeSBarry Smith 3245c6c1daeSBarry Smith /*@ 3255c6c1daeSBarry Smith PetscLogActions - Determines whether actions are logged for the graphical viewer. 3265c6c1daeSBarry Smith 3275c6c1daeSBarry Smith Not Collective 3285c6c1daeSBarry Smith 3295c6c1daeSBarry Smith Input Parameter: 330811af0c4SBarry Smith . flag - `PETSC_TRUE` if actions are to be logged 331811af0c4SBarry Smith 332811af0c4SBarry Smith Options Database Key: 333811af0c4SBarry Smith . -log_exclude_actions - Turns off actions logging 3345c6c1daeSBarry Smith 3355c6c1daeSBarry Smith Level: intermediate 3365c6c1daeSBarry Smith 337811af0c4SBarry Smith Note: 338811af0c4SBarry Smith Logging of actions continues to consume more memory as the program 3395c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 340d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStagePush()`, `PetscLogStagePop()` 3415c6c1daeSBarry Smith @*/ 342d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogActions(PetscBool flag) 343d71ae5a4SJacob Faibussowitsch { 3445c6c1daeSBarry Smith PetscFunctionBegin; 3455c6c1daeSBarry Smith petsc_logActions = flag; 3465c6c1daeSBarry Smith PetscFunctionReturn(0); 3475c6c1daeSBarry Smith } 3485c6c1daeSBarry Smith 3495c6c1daeSBarry Smith /*@ 3505c6c1daeSBarry Smith PetscLogObjects - Determines whether objects are logged for the graphical viewer. 3515c6c1daeSBarry Smith 3525c6c1daeSBarry Smith Not Collective 3535c6c1daeSBarry Smith 3545c6c1daeSBarry Smith Input Parameter: 355811af0c4SBarry Smith . flag - `PETSC_TRUE` if objects are to be logged 356811af0c4SBarry Smith 357811af0c4SBarry Smith Options Database Key: 358811af0c4SBarry Smith . -log_exclude_objects - Turns off objects logging 3595c6c1daeSBarry Smith 3605c6c1daeSBarry Smith Level: intermediate 3615c6c1daeSBarry Smith 362811af0c4SBarry Smith Note: 363811af0c4SBarry Smith Logging of objects continues to consume more memory as the program 3645c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3655c6c1daeSBarry Smith 366d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStagePush()`, `PetscLogStagePop()` 3675c6c1daeSBarry Smith @*/ 368d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogObjects(PetscBool flag) 369d71ae5a4SJacob Faibussowitsch { 3705c6c1daeSBarry Smith PetscFunctionBegin; 3715c6c1daeSBarry Smith petsc_logObjects = flag; 3725c6c1daeSBarry Smith PetscFunctionReturn(0); 3735c6c1daeSBarry Smith } 3745c6c1daeSBarry Smith 3755c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/ 3765c6c1daeSBarry Smith /*@C 37774c0405dSRichard Tran Mills PetscLogStageRegister - Attaches a character string name to a logging stage. 3785c6c1daeSBarry Smith 3795c6c1daeSBarry Smith Not Collective 3805c6c1daeSBarry Smith 3815c6c1daeSBarry Smith Input Parameter: 3825c6c1daeSBarry Smith . sname - The name to associate with that stage 3835c6c1daeSBarry Smith 3845c6c1daeSBarry Smith Output Parameter: 3855c6c1daeSBarry Smith . stage - The stage number 3865c6c1daeSBarry Smith 3875c6c1daeSBarry Smith Level: intermediate 3885c6c1daeSBarry Smith 389d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStagePush()`, `PetscLogStagePop()` 3905c6c1daeSBarry Smith @*/ 391d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageRegister(const char sname[], PetscLogStage *stage) 392d71ae5a4SJacob Faibussowitsch { 3935c6c1daeSBarry Smith PetscStageLog stageLog; 3945c6c1daeSBarry Smith PetscLogEvent event; 3955c6c1daeSBarry Smith 3965c6c1daeSBarry Smith PetscFunctionBegin; 3979566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 3989566063dSJacob Faibussowitsch PetscCall(PetscStageLogRegister(stageLog, sname, stage)); 3995c6c1daeSBarry Smith /* Copy events already changed in the main stage, this sucks */ 4009566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents)); 40148a46eb9SPierre Jolivet for (event = 0; event < stageLog->eventLog->numEvents; event++) PetscCall(PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event], &stageLog->stageInfo[*stage].eventLog->eventInfo[event])); 4029566063dSJacob Faibussowitsch PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses)); 4035c6c1daeSBarry Smith PetscFunctionReturn(0); 4045c6c1daeSBarry Smith } 4055c6c1daeSBarry Smith 4065c6c1daeSBarry Smith /*@C 407811af0c4SBarry Smith PetscLogStagePush - This function pushes a stage on the logging stack. Events started and stopped until `PetscLogStagePop()` will be associated with the stage 4085c6c1daeSBarry Smith 4095c6c1daeSBarry Smith Not Collective 4105c6c1daeSBarry Smith 4115c6c1daeSBarry Smith Input Parameter: 4125c6c1daeSBarry Smith . stage - The stage on which to log 4135c6c1daeSBarry Smith 4145c6c1daeSBarry Smith Usage: 415811af0c4SBarry Smith If the option -log_view is used to run the program containing the 4165c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4175c6c1daeSBarry Smith PetscFinalize(). 4185c6c1daeSBarry Smith .vb 4195c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4205c6c1daeSBarry Smith [stage 0 of code] 4215c6c1daeSBarry Smith PetscLogStagePush(1); 4225c6c1daeSBarry Smith [stage 1 of code] 4235c6c1daeSBarry Smith PetscLogStagePop(); 4245c6c1daeSBarry Smith PetscBarrier(...); 4255c6c1daeSBarry Smith [more stage 0 of code] 4265c6c1daeSBarry Smith PetscFinalize(); 4275c6c1daeSBarry Smith .ve 4285c6c1daeSBarry Smith 429d1f92df0SBarry Smith Level: intermediate 430d1f92df0SBarry Smith 431811af0c4SBarry Smith Note: 432811af0c4SBarry Smith Use `PetscLogStageRegister()` to register a stage. 4335c6c1daeSBarry Smith 434d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStagePop()`, `PetscLogStageRegister()`, `PetscBarrier()` 4355c6c1daeSBarry Smith @*/ 436d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStagePush(PetscLogStage stage) 437d71ae5a4SJacob Faibussowitsch { 4385c6c1daeSBarry Smith PetscStageLog stageLog; 4395c6c1daeSBarry Smith 4405c6c1daeSBarry Smith PetscFunctionBegin; 4419566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 4429566063dSJacob Faibussowitsch PetscCall(PetscStageLogPush(stageLog, stage)); 4435c6c1daeSBarry Smith PetscFunctionReturn(0); 4445c6c1daeSBarry Smith } 4455c6c1daeSBarry Smith 4465c6c1daeSBarry Smith /*@C 447811af0c4SBarry Smith PetscLogStagePop - This function pops a stage from the logging stack that was pushed with `PetscLogStagePush()` 4485c6c1daeSBarry Smith 4495c6c1daeSBarry Smith Not Collective 4505c6c1daeSBarry Smith 4515c6c1daeSBarry Smith Usage: 452811af0c4SBarry Smith If the option -log_view is used to run the program containing the 4535c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4545c6c1daeSBarry Smith PetscFinalize(). 4555c6c1daeSBarry Smith .vb 4565c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4575c6c1daeSBarry Smith [stage 0 of code] 4585c6c1daeSBarry Smith PetscLogStagePush(1); 4595c6c1daeSBarry Smith [stage 1 of code] 4605c6c1daeSBarry Smith PetscLogStagePop(); 4615c6c1daeSBarry Smith PetscBarrier(...); 4625c6c1daeSBarry Smith [more stage 0 of code] 4635c6c1daeSBarry Smith PetscFinalize(); 4645c6c1daeSBarry Smith .ve 4655c6c1daeSBarry Smith 4665c6c1daeSBarry Smith Level: intermediate 4675c6c1daeSBarry Smith 468d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStagePush()`, `PetscLogStageRegister()`, `PetscBarrier()` 4695c6c1daeSBarry Smith @*/ 470d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStagePop(void) 471d71ae5a4SJacob Faibussowitsch { 4725c6c1daeSBarry Smith PetscStageLog stageLog; 4735c6c1daeSBarry Smith 4745c6c1daeSBarry Smith PetscFunctionBegin; 4759566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 4769566063dSJacob Faibussowitsch PetscCall(PetscStageLogPop(stageLog)); 4775c6c1daeSBarry Smith PetscFunctionReturn(0); 4785c6c1daeSBarry Smith } 4795c6c1daeSBarry Smith 4805c6c1daeSBarry Smith /*@ 481811af0c4SBarry Smith PetscLogStageSetActive - Sets if a stage is used for `PetscLogEventBegin()` and `PetscLogEventEnd()`. 4825c6c1daeSBarry Smith 4835c6c1daeSBarry Smith Not Collective 4845c6c1daeSBarry Smith 4855c6c1daeSBarry Smith Input Parameters: 4865c6c1daeSBarry Smith + stage - The stage 487811af0c4SBarry Smith - isActive - The activity flag, `PETSC_TRUE` for logging, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 4885c6c1daeSBarry Smith 4895c6c1daeSBarry Smith Level: intermediate 4905c6c1daeSBarry Smith 491811af0c4SBarry Smith Note: 492811af0c4SBarry Smith If this is set to `PETSC_FALSE` the logging acts as if the stage did not exist 493811af0c4SBarry Smith 494d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 4955c6c1daeSBarry Smith @*/ 496d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive) 497d71ae5a4SJacob Faibussowitsch { 4985c6c1daeSBarry Smith PetscStageLog stageLog; 4995c6c1daeSBarry Smith 5005c6c1daeSBarry Smith PetscFunctionBegin; 5019566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5029566063dSJacob Faibussowitsch PetscCall(PetscStageLogSetActive(stageLog, stage, isActive)); 5035c6c1daeSBarry Smith PetscFunctionReturn(0); 5045c6c1daeSBarry Smith } 5055c6c1daeSBarry Smith 5065c6c1daeSBarry Smith /*@ 507811af0c4SBarry Smith PetscLogStageGetActive - Checks if a stage is used for `PetscLogEventBegin()` and `PetscLogEventEnd()`. 5085c6c1daeSBarry Smith 5095c6c1daeSBarry Smith Not Collective 5105c6c1daeSBarry Smith 5115c6c1daeSBarry Smith Input Parameter: 5125c6c1daeSBarry Smith . stage - The stage 5135c6c1daeSBarry Smith 5145c6c1daeSBarry Smith Output Parameter: 515811af0c4SBarry Smith . isActive - The activity flag, `PETSC_TRUE` for logging, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 5165c6c1daeSBarry Smith 5175c6c1daeSBarry Smith Level: intermediate 5185c6c1daeSBarry Smith 519d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 5205c6c1daeSBarry Smith @*/ 521d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageGetActive(PetscLogStage stage, PetscBool *isActive) 522d71ae5a4SJacob Faibussowitsch { 5235c6c1daeSBarry Smith PetscStageLog stageLog; 5245c6c1daeSBarry Smith 5255c6c1daeSBarry Smith PetscFunctionBegin; 5269566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5279566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetActive(stageLog, stage, isActive)); 5285c6c1daeSBarry Smith PetscFunctionReturn(0); 5295c6c1daeSBarry Smith } 5305c6c1daeSBarry Smith 5315c6c1daeSBarry Smith /*@ 532811af0c4SBarry Smith PetscLogStageSetVisible - Determines stage visibility in `PetscLogView()` 5335c6c1daeSBarry Smith 5345c6c1daeSBarry Smith Not Collective 5355c6c1daeSBarry Smith 5365c6c1daeSBarry Smith Input Parameters: 5375c6c1daeSBarry Smith + stage - The stage 538811af0c4SBarry Smith - isVisible - The visibility flag, `PETSC_TRUE` to print, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 5395c6c1daeSBarry Smith 5405c6c1daeSBarry Smith Level: intermediate 5415c6c1daeSBarry Smith 542811af0c4SBarry Smith Developer Note: 543811af0c4SBarry Smith What does visible mean, needs to be documented. 544811af0c4SBarry Smith 545d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogView()` 5465c6c1daeSBarry Smith @*/ 547d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible) 548d71ae5a4SJacob Faibussowitsch { 5495c6c1daeSBarry Smith PetscStageLog stageLog; 5505c6c1daeSBarry Smith 5515c6c1daeSBarry Smith PetscFunctionBegin; 5529566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5539566063dSJacob Faibussowitsch PetscCall(PetscStageLogSetVisible(stageLog, stage, isVisible)); 5545c6c1daeSBarry Smith PetscFunctionReturn(0); 5555c6c1daeSBarry Smith } 5565c6c1daeSBarry Smith 5575c6c1daeSBarry Smith /*@ 558811af0c4SBarry Smith PetscLogStageGetVisible - Returns stage visibility in `PetscLogView()` 5595c6c1daeSBarry Smith 5605c6c1daeSBarry Smith Not Collective 5615c6c1daeSBarry Smith 5625c6c1daeSBarry Smith Input Parameter: 5635c6c1daeSBarry Smith . stage - The stage 5645c6c1daeSBarry Smith 5655c6c1daeSBarry Smith Output Parameter: 566811af0c4SBarry Smith . isVisible - The visibility flag, `PETSC_TRUE` to print, else `PETSC_FALSE` (defaults to `PETSC_TRUE`) 5675c6c1daeSBarry Smith 5685c6c1daeSBarry Smith Level: intermediate 5695c6c1daeSBarry Smith 570d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogView()` 5715c6c1daeSBarry Smith @*/ 572d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageGetVisible(PetscLogStage stage, PetscBool *isVisible) 573d71ae5a4SJacob Faibussowitsch { 5745c6c1daeSBarry Smith PetscStageLog stageLog; 5755c6c1daeSBarry Smith 5765c6c1daeSBarry Smith PetscFunctionBegin; 5779566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5789566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetVisible(stageLog, stage, isVisible)); 5795c6c1daeSBarry Smith PetscFunctionReturn(0); 5805c6c1daeSBarry Smith } 5815c6c1daeSBarry Smith 5825c6c1daeSBarry Smith /*@C 5835c6c1daeSBarry Smith PetscLogStageGetId - Returns the stage id when given the stage name. 5845c6c1daeSBarry Smith 5855c6c1daeSBarry Smith Not Collective 5865c6c1daeSBarry Smith 5875c6c1daeSBarry Smith Input Parameter: 5885c6c1daeSBarry Smith . name - The stage name 5895c6c1daeSBarry Smith 5905c6c1daeSBarry Smith Output Parameter: 5915a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists 5925c6c1daeSBarry Smith 5935c6c1daeSBarry Smith Level: intermediate 5945c6c1daeSBarry Smith 595d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 5965c6c1daeSBarry Smith @*/ 597d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogStageGetId(const char name[], PetscLogStage *stage) 598d71ae5a4SJacob Faibussowitsch { 5995c6c1daeSBarry Smith PetscStageLog stageLog; 6005c6c1daeSBarry Smith 6015c6c1daeSBarry Smith PetscFunctionBegin; 6029566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 6039566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetStage(stageLog, name, stage)); 6045c6c1daeSBarry Smith PetscFunctionReturn(0); 6055c6c1daeSBarry Smith } 6065c6c1daeSBarry Smith 6075c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/ 6087a101e5eSJacob Faibussowitsch 6095c6c1daeSBarry Smith /*@C 610811af0c4SBarry Smith PetscLogEventRegister - Registers an event name for logging operations 6115c6c1daeSBarry Smith 6125c6c1daeSBarry Smith Not Collective 6135c6c1daeSBarry Smith 614d8d19677SJose E. Roman Input Parameters: 6155c6c1daeSBarry Smith + name - The name associated with the event 6165c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with 617811af0c4SBarry Smith `PetscClassIdRegister()` or use a predefined one such as `KSP_CLASSID`, `SNES_CLASSID`, the predefined ones 6185c6c1daeSBarry Smith are only available in C code 6195c6c1daeSBarry Smith 6205c6c1daeSBarry Smith Output Parameter: 621811af0c4SBarry Smith . event - The event id for use with `PetscLogEventBegin()` and `PetscLogEventEnd()`. 6225c6c1daeSBarry Smith 6235c6c1daeSBarry Smith Example of Usage: 6245c6c1daeSBarry Smith .vb 6255c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 6265c6c1daeSBarry Smith PetscClassId classid; 6275c6c1daeSBarry Smith PetscLogDouble user_event_flops; 6285c6c1daeSBarry Smith PetscClassIdRegister("class name",&classid); 6295c6c1daeSBarry Smith PetscLogEventRegister("User event name",classid,&USER_EVENT); 6305c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 6315c6c1daeSBarry Smith [code segment to monitor] 6325c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 6335c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 6345c6c1daeSBarry Smith .ve 6355c6c1daeSBarry Smith 636d1f92df0SBarry Smith Level: intermediate 637d1f92df0SBarry Smith 6385c6c1daeSBarry Smith Notes: 6395c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 640a2553e36SBarry Smith configured with --with-log (which is the default) and 641811af0c4SBarry Smith -log_view or -log_all is specified. `PetscLogEventRegister()` is 6425c6c1daeSBarry Smith intended for logging user events to supplement this PETSc 6435c6c1daeSBarry Smith information. 6445c6c1daeSBarry Smith 645495fc317SBarry Smith PETSc can gather data for use with the utilities Jumpshot 6465c6c1daeSBarry Smith (part of the MPICH distribution). If PETSc has been compiled 6475c6c1daeSBarry Smith with flag -DPETSC_HAVE_MPE (MPE is an additional utility within 6485c6c1daeSBarry Smith MPICH), the user can employ another command line option, -log_mpe, 6495c6c1daeSBarry Smith to create a logfile, "mpe.log", which can be visualized 650495fc317SBarry Smith Jumpshot. 6515c6c1daeSBarry Smith 6525c6c1daeSBarry Smith The classid is associated with each event so that classes of events 6535c6c1daeSBarry Smith can be disabled simultaneously, such as all matrix events. The user 654811af0c4SBarry Smith can either use an existing classid, such as `MAT_CLASSID`, or create 6555c6c1daeSBarry Smith their own as shown in the example. 6565c6c1daeSBarry Smith 657c5deb1d5SJed Brown If an existing event with the same name exists, its event handle is 658c5deb1d5SJed Brown returned instead of creating a new event. 659c5deb1d5SJed Brown 660d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogStageRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogFlops()`, 661db781477SPatrick Sanan `PetscLogEventActivate()`, `PetscLogEventDeactivate()`, `PetscClassIdRegister()` 6625c6c1daeSBarry Smith @*/ 663d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventRegister(const char name[], PetscClassId classid, PetscLogEvent *event) 664d71ae5a4SJacob Faibussowitsch { 6655c6c1daeSBarry Smith PetscStageLog stageLog; 6665c6c1daeSBarry Smith int stage; 6675c6c1daeSBarry Smith 6685c6c1daeSBarry Smith PetscFunctionBegin; 6695c6c1daeSBarry Smith *event = PETSC_DECIDE; 6709566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 6719566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, event)); 672c5deb1d5SJed Brown if (*event > 0) PetscFunctionReturn(0); 6739566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogRegister(stageLog->eventLog, name, classid, event)); 6745c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 6759566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents)); 6769566063dSJacob Faibussowitsch PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses)); 6775c6c1daeSBarry Smith } 6785c6c1daeSBarry Smith PetscFunctionReturn(0); 6795c6c1daeSBarry Smith } 6805c6c1daeSBarry Smith 6815c6c1daeSBarry Smith /*@ 682217044c2SLisandro Dalcin PetscLogEventSetCollective - Indicates that a particular event is collective. 683217044c2SLisandro Dalcin 684217044c2SLisandro Dalcin Not Collective 685217044c2SLisandro Dalcin 686d8d19677SJose E. Roman Input Parameters: 687217044c2SLisandro Dalcin + event - The event id 688d5b43468SJose E. Roman - collective - Boolean flag indicating whether a particular event is collective 689217044c2SLisandro Dalcin 690d1f92df0SBarry Smith Level: developer 691d1f92df0SBarry Smith 692811af0c4SBarry Smith Notes: 693811af0c4SBarry Smith New events returned from `PetscLogEventRegister()` are collective by default. 694811af0c4SBarry Smith 695811af0c4SBarry Smith Collective events are handled specially if the -log_sync is used. In that case the logging saves information about 696811af0c4SBarry Smith two parts of the event; the time for all the MPI ranks to synchronize and then the time for the actual computation/communication 697811af0c4SBarry Smith to be performed. This option is useful to debug imbalance within the computations or communications 698217044c2SLisandro Dalcin 699d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogEventRegister()` 700217044c2SLisandro Dalcin @*/ 701d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event, PetscBool collective) 702d71ae5a4SJacob Faibussowitsch { 703217044c2SLisandro Dalcin PetscStageLog stageLog; 704217044c2SLisandro Dalcin PetscEventRegLog eventRegLog; 705217044c2SLisandro Dalcin 706217044c2SLisandro Dalcin PetscFunctionBegin; 7079566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 7089566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetEventRegLog(stageLog, &eventRegLog)); 709cc73adaaSBarry Smith PetscCheck(event >= 0 && event <= eventRegLog->numEvents, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Invalid event id"); 710217044c2SLisandro Dalcin eventRegLog->eventInfo[event].collective = collective; 711217044c2SLisandro Dalcin PetscFunctionReturn(0); 712217044c2SLisandro Dalcin } 713217044c2SLisandro Dalcin 714217044c2SLisandro Dalcin /*@ 715fa2bb9feSLisandro Dalcin PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage. 716fa2bb9feSLisandro Dalcin 717fa2bb9feSLisandro Dalcin Not Collective 718fa2bb9feSLisandro Dalcin 719fa2bb9feSLisandro Dalcin Input Parameter: 720811af0c4SBarry Smith . classid - The object class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 721fa2bb9feSLisandro Dalcin 722fa2bb9feSLisandro Dalcin Level: developer 723fa2bb9feSLisandro Dalcin 724d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventActivateClass()`, `PetscLogEventDeactivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 725fa2bb9feSLisandro Dalcin @*/ 726d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventIncludeClass(PetscClassId classid) 727d71ae5a4SJacob Faibussowitsch { 728fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 729fa2bb9feSLisandro Dalcin int stage; 730fa2bb9feSLisandro Dalcin 731fa2bb9feSLisandro Dalcin PetscFunctionBegin; 7329566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 73348a46eb9SPierre Jolivet for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 734fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 735fa2bb9feSLisandro Dalcin } 736fa2bb9feSLisandro Dalcin 737fa2bb9feSLisandro Dalcin /*@ 738fa2bb9feSLisandro Dalcin PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage. 739fa2bb9feSLisandro Dalcin 740fa2bb9feSLisandro Dalcin Not Collective 741fa2bb9feSLisandro Dalcin 742fa2bb9feSLisandro Dalcin Input Parameter: 743811af0c4SBarry Smith . classid - The object class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 744fa2bb9feSLisandro Dalcin 745fa2bb9feSLisandro Dalcin Level: developer 746fa2bb9feSLisandro Dalcin 747811af0c4SBarry Smith Note: 748811af0c4SBarry Smith If a class is excluded then events associated with that class are not logged. 749811af0c4SBarry Smith 750d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventDeactivateClass()`, `PetscLogEventActivateClass()`, `PetscLogEventDeactivate()`, `PetscLogEventActivate()` 751fa2bb9feSLisandro Dalcin @*/ 752d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventExcludeClass(PetscClassId classid) 753d71ae5a4SJacob Faibussowitsch { 754fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 755fa2bb9feSLisandro Dalcin int stage; 756fa2bb9feSLisandro Dalcin 757fa2bb9feSLisandro Dalcin PetscFunctionBegin; 7589566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 75948a46eb9SPierre Jolivet for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 760fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 761fa2bb9feSLisandro Dalcin } 762fa2bb9feSLisandro Dalcin 763fa2bb9feSLisandro Dalcin /*@ 7645c6c1daeSBarry Smith PetscLogEventActivate - Indicates that a particular event should be logged. 7655c6c1daeSBarry Smith 7665c6c1daeSBarry Smith Not Collective 7675c6c1daeSBarry Smith 7685c6c1daeSBarry Smith Input Parameter: 7695c6c1daeSBarry Smith . event - The event id 7705c6c1daeSBarry Smith 7715c6c1daeSBarry Smith Usage: 7725c6c1daeSBarry Smith .vb 7735c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 7745c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 7755c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 7765c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 7775c6c1daeSBarry Smith .ve 7785c6c1daeSBarry Smith 779d1f92df0SBarry Smith Level: advanced 780d1f92df0SBarry Smith 7815c6c1daeSBarry Smith Note: 7825c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in include/petsclog.h) 783811af0c4SBarry Smith or an event number obtained with `PetscLogEventRegister()`. 7845c6c1daeSBarry Smith 785d1f92df0SBarry Smith .seealso: [](ch_profiling), `PlogEventDeactivate()`, `PlogEventDeactivatePush()`, `PetscLogEventDeactivatePop()` 7865c6c1daeSBarry Smith @*/ 787d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventActivate(PetscLogEvent event) 788d71ae5a4SJacob Faibussowitsch { 7895c6c1daeSBarry Smith PetscStageLog stageLog; 7905c6c1daeSBarry Smith int stage; 7915c6c1daeSBarry Smith 7925c6c1daeSBarry Smith PetscFunctionBegin; 7939566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 7949566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 7959566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event)); 7965c6c1daeSBarry Smith PetscFunctionReturn(0); 7975c6c1daeSBarry Smith } 7985c6c1daeSBarry Smith 7995c6c1daeSBarry Smith /*@ 8005c6c1daeSBarry Smith PetscLogEventDeactivate - Indicates that a particular event should not be logged. 8015c6c1daeSBarry Smith 8025c6c1daeSBarry Smith Not Collective 8035c6c1daeSBarry Smith 8045c6c1daeSBarry Smith Input Parameter: 8055c6c1daeSBarry Smith . event - The event id 8065c6c1daeSBarry Smith 8075c6c1daeSBarry Smith Usage: 8085c6c1daeSBarry Smith .vb 8095c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 8105c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 8115c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 8125c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 8135c6c1daeSBarry Smith .ve 8145c6c1daeSBarry Smith 815d1f92df0SBarry Smith Level: advanced 816d1f92df0SBarry Smith 8175c6c1daeSBarry Smith Note: 8185c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in 819811af0c4SBarry Smith include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`). 8205c6c1daeSBarry Smith 821d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventActivate()`, `PetscLogEventDeactivatePush()`, `PetscLogEventDeactivatePop()` 8225c6c1daeSBarry Smith @*/ 823d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivate(PetscLogEvent event) 824d71ae5a4SJacob Faibussowitsch { 8255c6c1daeSBarry Smith PetscStageLog stageLog; 8265c6c1daeSBarry Smith int stage; 8275c6c1daeSBarry Smith 8285c6c1daeSBarry Smith PetscFunctionBegin; 8299566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 8309566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 8319566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event)); 8325c6c1daeSBarry Smith PetscFunctionReturn(0); 8335c6c1daeSBarry Smith } 8345c6c1daeSBarry Smith 8355c6c1daeSBarry Smith /*@ 836811af0c4SBarry Smith PetscLogEventDeactivatePush - Indicates that a particular event should not be logged until `PetscLogEventDeactivatePop()` is called 837c00cb57fSBarry Smith 838c00cb57fSBarry Smith Not Collective 839c00cb57fSBarry Smith 840c00cb57fSBarry Smith Input Parameter: 841c00cb57fSBarry Smith . event - The event id 842c00cb57fSBarry Smith 843c00cb57fSBarry Smith Usage: 844c00cb57fSBarry Smith .vb 845c00cb57fSBarry Smith PetscLogEventDeactivatePush(VEC_SetValues); 846c00cb57fSBarry Smith [code where you do not want to log VecSetValues()] 847c00cb57fSBarry Smith PetscLogEventDeactivatePop(VEC_SetValues); 848c00cb57fSBarry Smith [code where you do want to log VecSetValues()] 849c00cb57fSBarry Smith .ve 850c00cb57fSBarry Smith 851d1f92df0SBarry Smith Level: advanced 852d1f92df0SBarry Smith 853c00cb57fSBarry Smith Note: 854c00cb57fSBarry Smith The event may be either a pre-defined PETSc event (found in 855811af0c4SBarry Smith include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`). 856c00cb57fSBarry Smith 857d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventActivate()`, `PetscLogEventDeactivatePop()`, `PetscLogEventDeactivate()` 858c00cb57fSBarry Smith @*/ 859d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivatePush(PetscLogEvent event) 860d71ae5a4SJacob Faibussowitsch { 861c00cb57fSBarry Smith PetscStageLog stageLog; 862c00cb57fSBarry Smith int stage; 863c00cb57fSBarry Smith 864c00cb57fSBarry Smith PetscFunctionBegin; 8659566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 8669566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 8679566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivatePush(stageLog->stageInfo[stage].eventLog, event)); 868c00cb57fSBarry Smith PetscFunctionReturn(0); 869c00cb57fSBarry Smith } 870c00cb57fSBarry Smith 871c00cb57fSBarry Smith /*@ 872811af0c4SBarry Smith PetscLogEventDeactivatePop - Indicates that a particular event should again be logged after the logging was turned off with `PetscLogEventDeactivatePush()` 873c00cb57fSBarry Smith 874c00cb57fSBarry Smith Not Collective 875c00cb57fSBarry Smith 876c00cb57fSBarry Smith Input Parameter: 877c00cb57fSBarry Smith . event - The event id 878c00cb57fSBarry Smith 879c00cb57fSBarry Smith Usage: 880c00cb57fSBarry Smith .vb 881c00cb57fSBarry Smith PetscLogEventDeactivatePush(VEC_SetValues); 882c00cb57fSBarry Smith [code where you do not want to log VecSetValues()] 883c00cb57fSBarry Smith PetscLogEventDeactivatePop(VEC_SetValues); 884c00cb57fSBarry Smith [code where you do want to log VecSetValues()] 885c00cb57fSBarry Smith .ve 886c00cb57fSBarry Smith 887d1f92df0SBarry Smith Level: advanced 888d1f92df0SBarry Smith 889c00cb57fSBarry Smith Note: 890c00cb57fSBarry Smith The event may be either a pre-defined PETSc event (found in 891811af0c4SBarry Smith include/petsclog.h) or an event number obtained with `PetscLogEventRegister()`). 892c00cb57fSBarry Smith 893d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventActivate()`, `PetscLogEventDeactivatePush()` 894c00cb57fSBarry Smith @*/ 895d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivatePop(PetscLogEvent event) 896d71ae5a4SJacob Faibussowitsch { 897c00cb57fSBarry Smith PetscStageLog stageLog; 898c00cb57fSBarry Smith int stage; 899c00cb57fSBarry Smith 900c00cb57fSBarry Smith PetscFunctionBegin; 9019566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9029566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 9039566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivatePop(stageLog->stageInfo[stage].eventLog, event)); 904c00cb57fSBarry Smith PetscFunctionReturn(0); 905c00cb57fSBarry Smith } 906c00cb57fSBarry Smith 907c00cb57fSBarry Smith /*@ 908811af0c4SBarry Smith PetscLogEventSetActiveAll - Turns on logging of all events 9095c6c1daeSBarry Smith 9105c6c1daeSBarry Smith Not Collective 9115c6c1daeSBarry Smith 9125c6c1daeSBarry Smith Input Parameters: 9135c6c1daeSBarry Smith + event - The event id 9145c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged 9155c6c1daeSBarry Smith 9165c6c1daeSBarry Smith Level: advanced 9175c6c1daeSBarry Smith 918d1f92df0SBarry Smith .seealso: [](ch_profiling), `PlogEventActivate()`, `PlogEventDeactivate()` 9195c6c1daeSBarry Smith @*/ 920d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive) 921d71ae5a4SJacob Faibussowitsch { 9225c6c1daeSBarry Smith PetscStageLog stageLog; 9235c6c1daeSBarry Smith int stage; 9245c6c1daeSBarry Smith 9255c6c1daeSBarry Smith PetscFunctionBegin; 9269566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9275c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 9285c6c1daeSBarry Smith if (isActive) { 9299566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event)); 9305c6c1daeSBarry Smith } else { 9319566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event)); 9325c6c1daeSBarry Smith } 9335c6c1daeSBarry Smith } 9345c6c1daeSBarry Smith PetscFunctionReturn(0); 9355c6c1daeSBarry Smith } 9365c6c1daeSBarry Smith 9375c6c1daeSBarry Smith /*@ 938811af0c4SBarry Smith PetscLogEventActivateClass - Activates event logging for a PETSc object class for the current stage 9395c6c1daeSBarry Smith 9405c6c1daeSBarry Smith Not Collective 9415c6c1daeSBarry Smith 9425c6c1daeSBarry Smith Input Parameter: 943811af0c4SBarry Smith . classid - The event class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 9445c6c1daeSBarry Smith 9455c6c1daeSBarry Smith Level: developer 9465c6c1daeSBarry Smith 947d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventIncludeClass()`, `PetscLogEventExcludeClass()`, `PetscLogEventDeactivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 9485c6c1daeSBarry Smith @*/ 949d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventActivateClass(PetscClassId classid) 950d71ae5a4SJacob Faibussowitsch { 9515c6c1daeSBarry Smith PetscStageLog stageLog; 9525c6c1daeSBarry Smith int stage; 9535c6c1daeSBarry Smith 9545c6c1daeSBarry Smith PetscFunctionBegin; 9559566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9569566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 9579566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 9585c6c1daeSBarry Smith PetscFunctionReturn(0); 9595c6c1daeSBarry Smith } 9605c6c1daeSBarry Smith 9615c6c1daeSBarry Smith /*@ 962811af0c4SBarry Smith PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class for the current stage 9635c6c1daeSBarry Smith 9645c6c1daeSBarry Smith Not Collective 9655c6c1daeSBarry Smith 9665c6c1daeSBarry Smith Input Parameter: 967811af0c4SBarry Smith . classid - The event class, for example `MAT_CLASSID`, `SNES_CLASSID`, etc. 9685c6c1daeSBarry Smith 9695c6c1daeSBarry Smith Level: developer 9705c6c1daeSBarry Smith 971d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventIncludeClass()`, `PetscLogEventExcludeClass()`, `PetscLogEventActivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 9725c6c1daeSBarry Smith @*/ 973d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventDeactivateClass(PetscClassId classid) 974d71ae5a4SJacob Faibussowitsch { 9755c6c1daeSBarry Smith PetscStageLog stageLog; 9765c6c1daeSBarry Smith int stage; 9775c6c1daeSBarry Smith 9785c6c1daeSBarry Smith PetscFunctionBegin; 9799566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9809566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 9819566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 9825c6c1daeSBarry Smith PetscFunctionReturn(0); 9835c6c1daeSBarry Smith } 9845c6c1daeSBarry Smith 9855c6c1daeSBarry Smith /*MC 98662872c28SLisandro Dalcin PetscLogEventSync - Synchronizes the beginning of a user event. 98762872c28SLisandro Dalcin 98862872c28SLisandro Dalcin Synopsis: 98962872c28SLisandro Dalcin #include <petsclog.h> 99062872c28SLisandro Dalcin PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm) 99162872c28SLisandro Dalcin 99262872c28SLisandro Dalcin Collective 99362872c28SLisandro Dalcin 99462872c28SLisandro Dalcin Input Parameters: 99562872c28SLisandro Dalcin + e - integer associated with the event obtained from PetscLogEventRegister() 99662872c28SLisandro Dalcin - comm - an MPI communicator 99762872c28SLisandro Dalcin 99862872c28SLisandro Dalcin Usage: 99962872c28SLisandro Dalcin .vb 100062872c28SLisandro Dalcin PetscLogEvent USER_EVENT; 100162872c28SLisandro Dalcin PetscLogEventRegister("User event",0,&USER_EVENT); 100262872c28SLisandro Dalcin PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD); 100362872c28SLisandro Dalcin PetscLogEventBegin(USER_EVENT,0,0,0,0); 100462872c28SLisandro Dalcin [code segment to monitor] 100562872c28SLisandro Dalcin PetscLogEventEnd(USER_EVENT,0,0,0,0); 100662872c28SLisandro Dalcin .ve 100762872c28SLisandro Dalcin 1008d1f92df0SBarry Smith Level: developer 1009d1f92df0SBarry Smith 1010811af0c4SBarry Smith Note: 101162872c28SLisandro Dalcin This routine should be called only if there is not a 1012811af0c4SBarry Smith `PetscObject` available to pass to `PetscLogEventBegin()`. 101362872c28SLisandro Dalcin 1014d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()` 101562872c28SLisandro Dalcin M*/ 101662872c28SLisandro Dalcin 101762872c28SLisandro Dalcin /*MC 10185c6c1daeSBarry Smith PetscLogEventBegin - Logs the beginning of a user event. 10195c6c1daeSBarry Smith 10205c6c1daeSBarry Smith Synopsis: 1021aaa7dc30SBarry Smith #include <petsclog.h> 1022f2ba6396SBarry Smith PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10235c6c1daeSBarry Smith 10245c6c1daeSBarry Smith Not Collective 10255c6c1daeSBarry Smith 10265c6c1daeSBarry Smith Input Parameters: 10275c6c1daeSBarry Smith + e - integer associated with the event obtained from PetscLogEventRegister() 10285c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10295c6c1daeSBarry Smith 10305c6c1daeSBarry Smith Fortran Synopsis: 10315c6c1daeSBarry Smith void PetscLogEventBegin(int e,PetscErrorCode ierr) 10325c6c1daeSBarry Smith 10335c6c1daeSBarry Smith Usage: 10345c6c1daeSBarry Smith .vb 10355c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 10365c6c1daeSBarry Smith PetscLogDouble user_event_flops; 10375c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 10385c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 10395c6c1daeSBarry Smith [code segment to monitor] 10405c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 10415c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 10425c6c1daeSBarry Smith .ve 10435c6c1daeSBarry Smith 1044d1f92df0SBarry Smith Level: intermediate 1045d1f92df0SBarry Smith 1046811af0c4SBarry Smith Developer Note: 1047811af0c4SBarry Smith `PetscLogEventBegin()` and `PetscLogEventBegin()` return error codes instead of explicitly handling the 1048d0609cedSBarry Smith errors that occur in the macro directly because other packages that use this macros have used them in their 1049d0609cedSBarry Smith own functions or methods that do not return error codes and it would be disruptive to change the current 1050d0609cedSBarry Smith behavior. 1051d0609cedSBarry Smith 1052d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()`, `PetscLogEventEnd()`, `PetscLogFlops()` 10535c6c1daeSBarry Smith M*/ 10545c6c1daeSBarry Smith 10555c6c1daeSBarry Smith /*MC 10565c6c1daeSBarry Smith PetscLogEventEnd - Log the end of a user event. 10575c6c1daeSBarry Smith 10585c6c1daeSBarry Smith Synopsis: 1059aaa7dc30SBarry Smith #include <petsclog.h> 1060f2ba6396SBarry Smith PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10615c6c1daeSBarry Smith 10625c6c1daeSBarry Smith Not Collective 10635c6c1daeSBarry Smith 10645c6c1daeSBarry Smith Input Parameters: 10655c6c1daeSBarry Smith + e - integer associated with the event obtained with PetscLogEventRegister() 10665c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10675c6c1daeSBarry Smith 10685c6c1daeSBarry Smith Fortran Synopsis: 10695c6c1daeSBarry Smith void PetscLogEventEnd(int e,PetscErrorCode ierr) 10705c6c1daeSBarry Smith 10715c6c1daeSBarry Smith Usage: 10725c6c1daeSBarry Smith .vb 10735c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 10745c6c1daeSBarry Smith PetscLogDouble user_event_flops; 10755c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT,); 10765c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 10775c6c1daeSBarry Smith [code segment to monitor] 10785c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 10795c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 10805c6c1daeSBarry Smith .ve 10815c6c1daeSBarry Smith 10825c6c1daeSBarry Smith Level: intermediate 10835c6c1daeSBarry Smith 1084d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogFlops()` 10855c6c1daeSBarry Smith M*/ 10865c6c1daeSBarry Smith 10875c6c1daeSBarry Smith /*@C 10885c6c1daeSBarry Smith PetscLogEventGetId - Returns the event id when given the event name. 10895c6c1daeSBarry Smith 10905c6c1daeSBarry Smith Not Collective 10915c6c1daeSBarry Smith 10925c6c1daeSBarry Smith Input Parameter: 10935c6c1daeSBarry Smith . name - The event name 10945c6c1daeSBarry Smith 10955c6c1daeSBarry Smith Output Parameter: 1096c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists 10975c6c1daeSBarry Smith 10985c6c1daeSBarry Smith Level: intermediate 10995c6c1daeSBarry Smith 1100d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogStageGetId()` 11015c6c1daeSBarry Smith @*/ 1102d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventGetId(const char name[], PetscLogEvent *event) 1103d71ae5a4SJacob Faibussowitsch { 11045c6c1daeSBarry Smith PetscStageLog stageLog; 11055c6c1daeSBarry Smith 11065c6c1daeSBarry Smith PetscFunctionBegin; 11079566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 11089566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, event)); 11095c6c1daeSBarry Smith PetscFunctionReturn(0); 11105c6c1daeSBarry Smith } 11115c6c1daeSBarry Smith 1112d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogPushCurrentEvent_Internal(PetscLogEvent event) 1113d71ae5a4SJacob Faibussowitsch { 11147a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11157a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackPush(current_log_event_stack, event)); 11167a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11177a101e5eSJacob Faibussowitsch } 11187a101e5eSJacob Faibussowitsch 1119d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogPopCurrentEvent_Internal(void) 1120d71ae5a4SJacob Faibussowitsch { 11217a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11227a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackPop(current_log_event_stack, NULL)); 11237a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11247a101e5eSJacob Faibussowitsch } 11257a101e5eSJacob Faibussowitsch 1126d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGetCurrentEvent_Internal(PetscLogEvent *event) 1127d71ae5a4SJacob Faibussowitsch { 11287a101e5eSJacob Faibussowitsch PetscBool empty; 11297a101e5eSJacob Faibussowitsch 11307a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11317a101e5eSJacob Faibussowitsch PetscValidIntPointer(event, 1); 11327a101e5eSJacob Faibussowitsch *event = PETSC_DECIDE; 11337a101e5eSJacob Faibussowitsch PetscCall(PetscIntStackEmpty(current_log_event_stack, &empty)); 11347a101e5eSJacob Faibussowitsch if (!empty) PetscCall(PetscIntStackTop(current_log_event_stack, event)); 11357a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11367a101e5eSJacob Faibussowitsch } 11377a101e5eSJacob Faibussowitsch 1138d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventPause_Internal(PetscLogEvent event) 1139d71ae5a4SJacob Faibussowitsch { 11407a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11417a101e5eSJacob Faibussowitsch if (event != PETSC_DECIDE) PetscCall(PetscLogEventEnd(event, NULL, NULL, NULL, NULL)); 11427a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11437a101e5eSJacob Faibussowitsch } 11447a101e5eSJacob Faibussowitsch 1145d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogEventResume_Internal(PetscLogEvent event) 1146d71ae5a4SJacob Faibussowitsch { 11477a101e5eSJacob Faibussowitsch PetscStageLog stageLog; 11487a101e5eSJacob Faibussowitsch PetscEventPerfLog eventLog; 11497a101e5eSJacob Faibussowitsch int stage; 11507a101e5eSJacob Faibussowitsch 11517a101e5eSJacob Faibussowitsch PetscFunctionBegin; 11527a101e5eSJacob Faibussowitsch if (event == PETSC_DECIDE) PetscFunctionReturn(0); 11537a101e5eSJacob Faibussowitsch PetscCall(PetscLogEventBegin(event, NULL, NULL, NULL, NULL)); 11547a101e5eSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 11557a101e5eSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 11567a101e5eSJacob Faibussowitsch PetscCall(PetscStageLogGetEventPerfLog(stageLog, stage, &eventLog)); 11577a101e5eSJacob Faibussowitsch eventLog->eventInfo[event].count--; 11587a101e5eSJacob Faibussowitsch PetscFunctionReturn(0); 11597a101e5eSJacob Faibussowitsch } 11607a101e5eSJacob Faibussowitsch 11615c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/ 11625c6c1daeSBarry Smith /*@C 11635c6c1daeSBarry Smith PetscLogDump - Dumps logs of objects to a file. This file is intended to 11645c6c1daeSBarry Smith be read by bin/petscview. This program no longer exists. 11655c6c1daeSBarry Smith 1166811af0c4SBarry Smith Collective on `PETSC_COMM_WORLD` 11675c6c1daeSBarry Smith 11685c6c1daeSBarry Smith Input Parameter: 11695c6c1daeSBarry Smith . name - an optional file name 11705c6c1daeSBarry Smith 11715c6c1daeSBarry Smith Usage: 11725c6c1daeSBarry Smith .vb 11735c6c1daeSBarry Smith PetscInitialize(...); 1174bb1d7374SBarry Smith PetscLogDefaultBegin(); or PetscLogAllBegin(); 11755c6c1daeSBarry Smith ... code ... 11765c6c1daeSBarry Smith PetscLogDump(filename); 11775c6c1daeSBarry Smith PetscFinalize(); 11785c6c1daeSBarry Smith .ve 11795c6c1daeSBarry Smith 1180d1f92df0SBarry Smith Level: advanced 1181d1f92df0SBarry Smith 1182811af0c4SBarry Smith Note: 11835c6c1daeSBarry Smith The default file name is 11845c6c1daeSBarry Smith $ Log.<rank> 11855c6c1daeSBarry Smith where <rank> is the processor number. If no name is specified, 11865c6c1daeSBarry Smith this file will be used. 11875c6c1daeSBarry Smith 1188d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogView()` 11895c6c1daeSBarry Smith @*/ 1190d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogDump(const char sname[]) 1191d71ae5a4SJacob Faibussowitsch { 11925c6c1daeSBarry Smith PetscStageLog stageLog; 11935c6c1daeSBarry Smith PetscEventPerfInfo *eventInfo; 11945c6c1daeSBarry Smith FILE *fd; 11955c6c1daeSBarry Smith char file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN]; 11965c6c1daeSBarry Smith PetscLogDouble flops, _TotalTime; 11975c6c1daeSBarry Smith PetscMPIInt rank; 11985c6c1daeSBarry Smith int action, object, curStage; 11995c6c1daeSBarry Smith PetscLogEvent event; 12005c6c1daeSBarry Smith 12015c6c1daeSBarry Smith PetscFunctionBegin; 12025c6c1daeSBarry Smith /* Calculate the total elapsed time */ 12038563dfccSBarry Smith PetscTime(&_TotalTime); 12045c6c1daeSBarry Smith _TotalTime -= petsc_BaseTime; 12055c6c1daeSBarry Smith /* Open log file */ 12069566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank)); 12077ff663adSLisandro Dalcin if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank); 1208a297a907SKarl Rupp else sprintf(file, "Log.%d", rank); 12099566063dSJacob Faibussowitsch PetscCall(PetscFixFilename(file, fname)); 12109566063dSJacob Faibussowitsch PetscCall(PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd)); 121108401ef6SPierre Jolivet PetscCheck(!(rank == 0) || !(!fd), PETSC_COMM_SELF, PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname); 12125c6c1daeSBarry Smith /* Output totals */ 12139566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime)); 12149566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0)); 12155c6c1daeSBarry Smith /* Output actions */ 12165c6c1daeSBarry Smith if (petsc_logActions) { 12179566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions)); 12185c6c1daeSBarry Smith for (action = 0; action < petsc_numActions; action++) { 12199371c9d4SSatish 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, 1220d0609cedSBarry Smith petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem)); 12215c6c1daeSBarry Smith } 12225c6c1daeSBarry Smith } 12235c6c1daeSBarry Smith /* Output objects */ 12245c6c1daeSBarry Smith if (petsc_logObjects) { 12259566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed)); 12265c6c1daeSBarry Smith for (object = 0; object < petsc_numObjects; object++) { 12279566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int)petsc_objects[object].mem)); 12285c6c1daeSBarry Smith if (!petsc_objects[object].name[0]) { 12299566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "No Name\n")); 12305c6c1daeSBarry Smith } else { 12319566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name)); 12325c6c1daeSBarry Smith } 12335c6c1daeSBarry Smith if (petsc_objects[object].info[0] != 0) { 12349566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n")); 12355c6c1daeSBarry Smith } else { 12369566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info)); 12375c6c1daeSBarry Smith } 12385c6c1daeSBarry Smith } 12395c6c1daeSBarry Smith } 12405c6c1daeSBarry Smith /* Output events */ 12419566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n")); 12429566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 12439566063dSJacob Faibussowitsch PetscCall(PetscIntStackTop(stageLog->stack, &curStage)); 12445c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo; 12455c6c1daeSBarry Smith for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) { 1246a297a907SKarl Rupp if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops / eventInfo[event].time; 1247a297a907SKarl Rupp else flops = 0.0; 1248d0609cedSBarry Smith PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count, eventInfo[event].flops, eventInfo[event].time, flops)); 12495c6c1daeSBarry Smith } 12509566063dSJacob Faibussowitsch PetscCall(PetscFClose(PETSC_COMM_WORLD, fd)); 12515c6c1daeSBarry Smith PetscFunctionReturn(0); 12525c6c1daeSBarry Smith } 12535c6c1daeSBarry Smith 1254f14045dbSBarry Smith /* 1255f14045dbSBarry Smith PetscLogView_Detailed - Each process prints the times for its own events 1256f14045dbSBarry Smith 1257f14045dbSBarry Smith */ 1258d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView_Detailed(PetscViewer viewer) 1259d71ae5a4SJacob Faibussowitsch { 12602dff6485SMatthew G. Knepley PetscStageLog stageLog; 1261217044c2SLisandro Dalcin PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL; 1262217044c2SLisandro Dalcin PetscLogDouble locTotalTime, numRed, maxMem; 12632dff6485SMatthew G. Knepley int numStages, numEvents, stage, event; 1264217044c2SLisandro Dalcin MPI_Comm comm = PetscObjectComm((PetscObject)viewer); 12652dff6485SMatthew G. Knepley PetscMPIInt rank, size; 1266f14045dbSBarry Smith 1267f14045dbSBarry Smith PetscFunctionBegin; 12689566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 12699566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 12702dff6485SMatthew G. Knepley /* Must preserve reduction count before we go on */ 12712dff6485SMatthew G. Knepley numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 12722d1ec343SBarry Smith /* Get the total elapsed time */ 12739371c9d4SSatish Balay PetscTime(&locTotalTime); 12749371c9d4SSatish Balay locTotalTime -= petsc_BaseTime; 12759566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "size = %d\n", size)); 12769566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalTimes = {}\n")); 12779566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMessages = {}\n")); 12789566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMessageLens = {}\n")); 12799566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalReductions = {}\n")); 12809566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalFlop = {}\n")); 12819566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalObjects = {}\n")); 12829566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "LocalMemory = {}\n")); 12839566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 12849566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 12859566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Stages = {}\n")); 12862d1ec343SBarry Smith for (stage = 0; stage < numStages; stage++) { 12879566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"] = {}\n", stageLog->stageInfo[stage].name)); 12889566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"][\"summary\"] = {}\n", stageLog->stageInfo[stage].name)); 12899566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 129048a46eb9SPierre Jolivet for (event = 0; event < numEvents; event++) PetscCall(PetscViewerASCIIPrintf(viewer, "Stages[\"%s\"][\"%s\"] = {}\n", stageLog->stageInfo[stage].name, stageLog->eventLog->eventInfo[event].name)); 12912d1ec343SBarry Smith } 12929566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&maxMem)); 12939566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushSynchronized(viewer)); 12949566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalTimes[%d] = %g\n", rank, locTotalTime)); 12959566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMessages[%d] = %g\n", rank, (petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct))); 12969566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMessageLens[%d] = %g\n", rank, (petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len))); 12979566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalReductions[%d] = %g\n", rank, numRed)); 12989566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalFlop[%d] = %g\n", rank, petsc_TotalFlops)); 12999566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalObjects[%d] = %d\n", rank, petsc_numObjects)); 13009566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "LocalMemory[%d] = %g\n", rank, maxMem)); 13019566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 13022d1ec343SBarry Smith for (stage = 0; stage < numStages; stage++) { 1303217044c2SLisandro Dalcin stageInfo = &stageLog->stageInfo[stage].perfInfo; 13049371c9d4SSatish 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, 13059371c9d4SSatish Balay stageInfo->numMessages, stageInfo->messageLength, stageInfo->numReductions, stageInfo->flops)); 13069566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 13072d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 1308217044c2SLisandro Dalcin eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 1309d0609cedSBarry Smith PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %d, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g", 13109371c9d4SSatish Balay stageLog->stageInfo[stage].name, stageLog->eventLog->eventInfo[event].name, rank, eventInfo->count, eventInfo->time, eventInfo->syncTime, eventInfo->numMessages, eventInfo->messageLength, eventInfo->numReductions, 13119371c9d4SSatish Balay eventInfo->flops)); 1312891e75beSMatthew G. Knepley if (eventInfo->dof[0] >= 0.) { 1313891e75beSMatthew G. Knepley PetscInt d, e; 13145d68e14cSMatthew G. Knepley 13159566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : [")); 1316891e75beSMatthew G. Knepley for (d = 0; d < 8; ++d) { 13179566063dSJacob Faibussowitsch if (d > 0) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", ")); 13189566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d])); 1319891e75beSMatthew G. Knepley } 13209566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "]")); 13219566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : [")); 13225d68e14cSMatthew G. Knepley for (e = 0; e < 8; ++e) { 13239566063dSJacob Faibussowitsch if (e > 0) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", ")); 13249566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e])); 13255d68e14cSMatthew G. Knepley } 13269566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "]")); 13275d68e14cSMatthew G. Knepley } 13289566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "}\n")); 13292d1ec343SBarry Smith } 13302d1ec343SBarry Smith } 13319566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 13329566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopSynchronized(viewer)); 1333f14045dbSBarry Smith PetscFunctionReturn(0); 1334f14045dbSBarry Smith } 1335f14045dbSBarry Smith 133638144912Sdeepblu2718 /* 133738144912Sdeepblu2718 PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format 133838144912Sdeepblu2718 */ 1339d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView_CSV(PetscViewer viewer) 1340d71ae5a4SJacob Faibussowitsch { 134138144912Sdeepblu2718 PetscStageLog stageLog; 1342669c5be0SSatish Balay PetscEventPerfInfo *eventInfo = NULL; 134338144912Sdeepblu2718 PetscLogDouble locTotalTime, maxMem; 134438144912Sdeepblu2718 int numStages, numEvents, stage, event; 134538144912Sdeepblu2718 MPI_Comm comm = PetscObjectComm((PetscObject)viewer); 134638144912Sdeepblu2718 PetscMPIInt rank, size; 134738144912Sdeepblu2718 134838144912Sdeepblu2718 PetscFunctionBegin; 13499566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 13509566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 135138144912Sdeepblu2718 /* Must preserve reduction count before we go on */ 135238144912Sdeepblu2718 /* Get the total elapsed time */ 13539371c9d4SSatish Balay PetscTime(&locTotalTime); 13549371c9d4SSatish Balay locTotalTime -= petsc_BaseTime; 13559566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 13569566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 13579566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&maxMem)); 13589566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushSynchronized(viewer)); 1359d0609cedSBarry 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)); 13609566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 136138144912Sdeepblu2718 for (stage = 0; stage < numStages; stage++) { 13629e29573dSMatthew G. Knepley PetscEventPerfInfo *stageInfo = &stageLog->stageInfo[stage].perfInfo; 13639e29573dSMatthew G. Knepley 13649371c9d4SSatish 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)); 13659566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 136638144912Sdeepblu2718 for (event = 0; event < numEvents; event++) { 136738144912Sdeepblu2718 eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 13689371c9d4SSatish 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, 13699371c9d4SSatish Balay eventInfo->numReductions, eventInfo->flops)); 137038144912Sdeepblu2718 if (eventInfo->dof[0] >= 0.) { 137138144912Sdeepblu2718 PetscInt d, e; 137238144912Sdeepblu2718 137348a46eb9SPierre Jolivet for (d = 0; d < 8; ++d) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d])); 137448a46eb9SPierre Jolivet for (e = 0; e < 8; ++e) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e])); 137538144912Sdeepblu2718 } 13769566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "\n")); 137738144912Sdeepblu2718 } 137838144912Sdeepblu2718 } 13799566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 13809566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopSynchronized(viewer)); 138138144912Sdeepblu2718 PetscFunctionReturn(0); 138238144912Sdeepblu2718 } 138338144912Sdeepblu2718 1384d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm, FILE *fd) 1385d71ae5a4SJacob Faibussowitsch { 1386217044c2SLisandro Dalcin PetscFunctionBegin; 1387217044c2SLisandro Dalcin if (!PetscLogSyncOn) PetscFunctionReturn(0); 13889566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 13899566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 13909566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 13919566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 13929566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 13939566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This program was run with logging synchronization. #\n")); 13949566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This option provides more meaningful imbalance #\n")); 13959566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # figures at the expense of slowing things down and #\n")); 13969566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # providing a distorted view of the overall runtime. #\n")); 13979566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 13989566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1399217044c2SLisandro Dalcin PetscFunctionReturn(0); 1400217044c2SLisandro Dalcin } 1401217044c2SLisandro Dalcin 1402d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm, FILE *fd) 1403d71ae5a4SJacob Faibussowitsch { 1404f4091ad2SBarry Smith PetscFunctionBegin; 140576bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 14069566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 14079566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 14089566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14099566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 14109566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14119566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This code was compiled with a debugging option. #\n")); 14129566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # To get timing results run ./configure #\n")); 14139566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # using --with-debugging=no, the performance will #\n")); 14149566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # be generally two or three times faster. #\n")); 14159566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14169566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 141776bd3646SJed Brown } 1418f4091ad2SBarry Smith PetscFunctionReturn(0); 1419f4091ad2SBarry Smith } 1420f4091ad2SBarry Smith 1421d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnNoGpuAwareMpi(MPI_Comm comm, FILE *fd) 1422d71ae5a4SJacob Faibussowitsch { 1423009ab46cSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1424009ab46cSJunchao Zhang PetscMPIInt size; 14258fe3844cSJunchao Zhang PetscBool deviceInitialized = PETSC_FALSE; 1426c2a741eeSJunchao Zhang 1427c2a741eeSJunchao Zhang PetscFunctionBegin; 14289566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 14298fe3844cSJunchao Zhang for (int i = PETSC_DEVICE_HOST + 1; i < PETSC_DEVICE_MAX; ++i) { 14308fe3844cSJunchao Zhang const PetscDeviceType dtype = PetscDeviceTypeCast(i); 14318fe3844cSJunchao Zhang if (PetscDeviceInitialized(dtype)) { /* a non-host device was initialized */ 14328fe3844cSJunchao Zhang deviceInitialized = PETSC_TRUE; 14338fe3844cSJunchao Zhang break; 14348fe3844cSJunchao Zhang } 14358fe3844cSJunchao Zhang } 14368fe3844cSJunchao Zhang /* the last condition says petsc is configured with device but it is a pure CPU run, so don't print misleading warnings */ 14378fe3844cSJunchao Zhang if (use_gpu_aware_mpi || size == 1 || !deviceInitialized) PetscFunctionReturn(0); 14389566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 14399566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 14409566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14419566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 14429566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14439566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This code was compiled with GPU support and you've #\n")); 14449566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # created PETSc/GPU objects, but you intentionally #\n")); 14459566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # used -use_gpu_aware_mpi 0, requiring PETSc to copy #\n")); 14469566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # additional data between the GPU and CPU. To obtain #\n")); 14479566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # meaningful timing results on multi-rank runs, use #\n")); 14489566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # GPU-aware MPI instead. #\n")); 14499566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14509566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1451c2a741eeSJunchao Zhang PetscFunctionReturn(0); 1452c2a741eeSJunchao Zhang #else 1453c2a741eeSJunchao Zhang return 0; 1454c2a741eeSJunchao Zhang #endif 1455c2a741eeSJunchao Zhang } 1456c2a741eeSJunchao Zhang 1457d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogViewWarnGpuTime(MPI_Comm comm, FILE *fd) 1458d71ae5a4SJacob Faibussowitsch { 1459156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1460156b51fbSBarry Smith 1461156b51fbSBarry Smith PetscFunctionBegin; 1462156b51fbSBarry Smith if (!PetscLogGpuTimeFlag || petsc_gflops == 0) PetscFunctionReturn(0); 1463156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, "\n\n")); 1464156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 1465156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1466156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 1467156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1468156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # This code was run with -log_view_gpu_time #\n")); 1469156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # This provides accurate timing within the GPU kernels #\n")); 1470156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # but can slow down the entire computation by a #\n")); 1471156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # measurable amount. For fastest runs we recommend #\n")); 1472156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # not using this option. #\n")); 1473156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1474156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1475156b51fbSBarry Smith PetscFunctionReturn(0); 1476156b51fbSBarry Smith #else 1477156b51fbSBarry Smith return 0; 1478156b51fbSBarry Smith #endif 1479156b51fbSBarry Smith } 1480156b51fbSBarry Smith 1481d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView_Default(PetscViewer viewer) 1482d71ae5a4SJacob Faibussowitsch { 14835c6c1daeSBarry Smith FILE *fd; 14845c6c1daeSBarry Smith PetscLogDouble zero = 0.0; 14855c6c1daeSBarry Smith PetscStageLog stageLog; 14860298fd71SBarry Smith PetscStageInfo *stageInfo = NULL; 14870298fd71SBarry Smith PetscEventPerfInfo *eventInfo = NULL; 14885c6c1daeSBarry Smith PetscClassPerfInfo *classInfo; 14895c6c1daeSBarry Smith char arch[128], hostname[128], username[128], pname[PETSC_MAX_PATH_LEN], date[128]; 14905c6c1daeSBarry Smith const char *name; 14915c6c1daeSBarry Smith PetscLogDouble locTotalTime, TotalTime, TotalFlops; 14925c6c1daeSBarry Smith PetscLogDouble numMessages, messageLength, avgMessLen, numReductions; 14935c6c1daeSBarry Smith PetscLogDouble stageTime, flops, flopr, mem, mess, messLen, red; 14945c6c1daeSBarry Smith PetscLogDouble fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed; 14955c6c1daeSBarry Smith PetscLogDouble fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed; 14965c6c1daeSBarry Smith PetscLogDouble min, max, tot, ratio, avg, x, y; 1497e3ed9ee7SBarry Smith PetscLogDouble minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr, mal, malmax, emalmax; 1498d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1499156b51fbSBarry Smith PetscLogEvent KSP_Solve, SNES_Solve, TS_Step, TAO_Solve; /* These need to be fixed to be some events registered with certain objects */ 1500958c4211Shannah_mairs PetscLogDouble cct, gct, csz, gsz, gmaxt, gflops, gflopr, fracgflops; 1501bec0b493Shannah_mairs #endif 1502217044c2SLisandro Dalcin PetscMPIInt minC, maxC; 15035c6c1daeSBarry Smith PetscMPIInt size, rank; 15045c6c1daeSBarry Smith PetscBool *localStageUsed, *stageUsed; 15055c6c1daeSBarry Smith PetscBool *localStageVisible, *stageVisible; 15065c6c1daeSBarry Smith int numStages, localNumEvents, numEvents; 150737b78d16SBarry Smith int stage, oclass; 15085c6c1daeSBarry Smith PetscLogEvent event; 1509d0609cedSBarry Smith PetscErrorCode ierr = 0; 15105c6c1daeSBarry Smith char version[256]; 15115c6c1daeSBarry Smith MPI_Comm comm; 1512156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1513156b51fbSBarry Smith PetscLogEvent eventid; 1514156b51fbSBarry Smith PetscInt64 nas = 0x7FF0000000000002; 1515156b51fbSBarry Smith #endif 15165c6c1daeSBarry Smith 15175c6c1daeSBarry Smith PetscFunctionBegin; 1518156b51fbSBarry Smith PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF)); 15199566063dSJacob Faibussowitsch PetscCall(PetscObjectGetComm((PetscObject)viewer, &comm)); 15209566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIGetPointer(viewer, &fd)); 15219566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 15229566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 15235c6c1daeSBarry Smith /* Get the total elapsed time */ 15249371c9d4SSatish Balay PetscTime(&locTotalTime); 15259371c9d4SSatish Balay locTotalTime -= petsc_BaseTime; 15265c6c1daeSBarry Smith 1527faad7b01SPierre Jolivet PetscCall(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n")); 15289566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "*** WIDEN YOUR WINDOW TO 160 CHARACTERS. Use 'enscript -r -fCourier9' to print this document ***\n")); 15299566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n")); 1530faad7b01SPierre Jolivet PetscCall(PetscFPrintf(comm, fd, "\n------------------------------------------------------------------ PETSc Performance Summary: ------------------------------------------------------------------\n\n")); 15319566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnSync(comm, fd)); 15329566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm, fd)); 15339566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnNoGpuAwareMpi(comm, fd)); 1534156b51fbSBarry Smith PetscCall(PetscLogViewWarnGpuTime(comm, fd)); 15359566063dSJacob Faibussowitsch PetscCall(PetscGetArchType(arch, sizeof(arch))); 15369566063dSJacob Faibussowitsch PetscCall(PetscGetHostName(hostname, sizeof(hostname))); 15379566063dSJacob Faibussowitsch PetscCall(PetscGetUserName(username, sizeof(username))); 15389566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(pname, sizeof(pname))); 15399566063dSJacob Faibussowitsch PetscCall(PetscGetDate(date, sizeof(date))); 15409566063dSJacob Faibussowitsch PetscCall(PetscGetVersion(version, sizeof(version))); 15415c6c1daeSBarry Smith if (size == 1) { 15429566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s on a %s named %s with %d processor, by %s %s\n", pname, arch, hostname, size, username, date)); 15435c6c1daeSBarry Smith } else { 15449566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s on a %s named %s with %d processors, by %s %s\n", pname, arch, hostname, size, username, date)); 15455c6c1daeSBarry Smith } 1546f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP) 15479566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Using %" PetscInt_FMT " OpenMP threads\n", PetscNumOMPThreads)); 1548f90b075cSBarry Smith #endif 15499566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Using %s\n", version)); 15505c6c1daeSBarry Smith 15515c6c1daeSBarry Smith /* Must preserve reduction count before we go on */ 15525c6c1daeSBarry Smith red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 15535c6c1daeSBarry Smith 15545c6c1daeSBarry Smith /* Calculate summary information */ 15559566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n Max Max/Min Avg Total\n")); 15565c6c1daeSBarry Smith /* Time */ 15579566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15589566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15599566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1560217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15619371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15629371c9d4SSatish Balay else ratio = 0.0; 15639566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Time (sec): %5.3e %7.3f %5.3e\n", max, ratio, avg)); 15645c6c1daeSBarry Smith TotalTime = tot; 15655c6c1daeSBarry Smith /* Objects */ 15665c6c1daeSBarry Smith avg = (PetscLogDouble)petsc_numObjects; 15679566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15689566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15699566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1570217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15719371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15729371c9d4SSatish Balay else ratio = 0.0; 15739566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Objects: %5.3e %7.3f %5.3e\n", max, ratio, avg)); 15745c6c1daeSBarry Smith /* Flops */ 15759566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15769566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15779566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1578217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15799371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15809371c9d4SSatish Balay else ratio = 0.0; 15819566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Flops: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15825c6c1daeSBarry Smith TotalFlops = tot; 15835c6c1daeSBarry Smith /* Flops/sec -- Must talk to Barry here */ 15849371c9d4SSatish Balay if (locTotalTime != 0.0) flops = petsc_TotalFlops / locTotalTime; 15859371c9d4SSatish Balay else flops = 0.0; 15869566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15879566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15889566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1589217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 15909371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 15919371c9d4SSatish Balay else ratio = 0.0; 15929566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Flops/sec: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15935c6c1daeSBarry Smith /* Memory */ 15949566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&mem)); 15955c6c1daeSBarry Smith if (mem > 0.0) { 15969566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15979566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15989566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1599217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 16009371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 16019371c9d4SSatish Balay else ratio = 0.0; 16029566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Memory (bytes): %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 16035c6c1daeSBarry Smith } 16045c6c1daeSBarry Smith /* Messages */ 16055c6c1daeSBarry Smith mess = 0.5 * (petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct); 16069566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 16079566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 16089566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1609217044c2SLisandro Dalcin avg = tot / ((PetscLogDouble)size); 16109371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 16119371c9d4SSatish Balay else ratio = 0.0; 16129566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Msg Count: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 16135c6c1daeSBarry Smith numMessages = tot; 16145c6c1daeSBarry Smith /* Message Lengths */ 16155c6c1daeSBarry Smith mess = 0.5 * (petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len); 16169566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 16179566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 16189566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16199371c9d4SSatish Balay if (numMessages != 0) avg = tot / numMessages; 16209371c9d4SSatish Balay else avg = 0.0; 16219371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 16229371c9d4SSatish Balay else ratio = 0.0; 16239566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Msg Len (bytes): %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 16245c6c1daeSBarry Smith messageLength = tot; 16255c6c1daeSBarry Smith /* Reductions */ 16269566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 16279566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 16289566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16299371c9d4SSatish Balay if (min != 0.0) ratio = max / min; 16309371c9d4SSatish Balay else ratio = 0.0; 16319566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Reductions: %5.3e %7.3f\n", max, ratio)); 16325c6c1daeSBarry Smith numReductions = red; /* wrong because uses count from process zero */ 16339566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n")); 16349566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " e.g., VecAXPY() for real vectors of length N --> 2N flops\n")); 16359566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " and VecAXPY() for complex vectors of length N --> 8N flops\n")); 16365c6c1daeSBarry Smith 16375c6c1daeSBarry Smith /* Get total number of stages -- 16385c6c1daeSBarry Smith Currently, a single processor can register more stages than another, but stages must all be registered in order. 16395c6c1daeSBarry Smith We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID. 16405c6c1daeSBarry Smith This seems best accomplished by assoicating a communicator with each stage. 16415c6c1daeSBarry Smith */ 16429566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 16439566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 16449566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &localStageUsed)); 16459566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &stageUsed)); 16469566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &localStageVisible)); 16479566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &stageVisible)); 16485c6c1daeSBarry Smith if (numStages > 0) { 16495c6c1daeSBarry Smith stageInfo = stageLog->stageInfo; 16505c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16515c6c1daeSBarry Smith if (stage < stageLog->numStages) { 16525c6c1daeSBarry Smith localStageUsed[stage] = stageInfo[stage].used; 16535c6c1daeSBarry Smith localStageVisible[stage] = stageInfo[stage].perfInfo.visible; 16545c6c1daeSBarry Smith } else { 16555c6c1daeSBarry Smith localStageUsed[stage] = PETSC_FALSE; 16565c6c1daeSBarry Smith localStageVisible[stage] = PETSC_TRUE; 16575c6c1daeSBarry Smith } 16585c6c1daeSBarry Smith } 16599566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm)); 16609566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm)); 16615c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16625c6c1daeSBarry Smith if (stageUsed[stage]) { 16639566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\nSummary of Stages: ----- Time ------ ----- Flop ------ --- Messages --- -- Message Lengths -- -- Reductions --\n")); 16649566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Avg %%Total Avg %%Total Count %%Total Avg %%Total Count %%Total\n")); 16655c6c1daeSBarry Smith break; 16665c6c1daeSBarry Smith } 16675c6c1daeSBarry Smith } 16685c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16695c6c1daeSBarry Smith if (!stageUsed[stage]) continue; 1670820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 16715c6c1daeSBarry Smith if (localStageUsed[stage]) { 16729566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16739566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16749566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16759566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16769566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16775c6c1daeSBarry Smith name = stageInfo[stage].name; 16785c6c1daeSBarry Smith } else { 16799566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16809566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16819566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16829566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16839566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16845c6c1daeSBarry Smith name = ""; 16855c6c1daeSBarry Smith } 16869371c9d4SSatish Balay mess *= 0.5; 16879371c9d4SSatish Balay messLen *= 0.5; 16889371c9d4SSatish Balay red /= size; 16899371c9d4SSatish Balay if (TotalTime != 0.0) fracTime = stageTime / TotalTime; 16909371c9d4SSatish Balay else fracTime = 0.0; 16919371c9d4SSatish Balay if (TotalFlops != 0.0) fracFlops = flops / TotalFlops; 16929371c9d4SSatish Balay else fracFlops = 0.0; 16935c6c1daeSBarry Smith /* Talk to Barry if (stageTime != 0.0) flops = (size*flops)/stageTime; else flops = 0.0; */ 16949371c9d4SSatish Balay if (numMessages != 0.0) fracMessages = mess / numMessages; 16959371c9d4SSatish Balay else fracMessages = 0.0; 16969371c9d4SSatish Balay if (mess != 0.0) avgMessLen = messLen / mess; 16979371c9d4SSatish Balay else avgMessLen = 0.0; 16989371c9d4SSatish Balay if (messageLength != 0.0) fracLength = messLen / messageLength; 16999371c9d4SSatish Balay else fracLength = 0.0; 17009371c9d4SSatish Balay if (numReductions != 0.0) fracReductions = red / numReductions; 17019371c9d4SSatish Balay else fracReductions = 0.0; 17029371c9d4SSatish 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)); 17035c6c1daeSBarry Smith } 17045c6c1daeSBarry Smith } 17055c6c1daeSBarry Smith 17069566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n------------------------------------------------------------------------------------------------------------------------\n")); 17079566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n")); 17089566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Phase summary info:\n")); 17099566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Count: number of times phase was executed\n")); 17109566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Time and Flop: Max - maximum over all processors\n")); 17119566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Ratio - ratio of maximum to minimum over all processors\n")); 17129566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Mess: number of messages sent\n")); 17139566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " AvgLen: average message length (bytes)\n")); 17149566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Reduct: number of global reductions\n")); 17159566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Global: entire computation\n")); 17169566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n")); 17179566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%T - percent time in this phase %%F - percent flop in this phase\n")); 17189566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%M - percent messages in this phase %%L - percent message lengths in this phase\n")); 17199566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%R - percent reductions in this phase\n")); 17209566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n")); 1721e3ed9ee7SBarry Smith if (PetscLogMemory) { 172254aabf2dSBarry Smith PetscCall(PetscFPrintf(comm, fd, " Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event). May be negative\n")); 172354aabf2dSBarry Smith PetscCall(PetscFPrintf(comm, fd, " EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events). Never negative\n")); 172454aabf2dSBarry Smith PetscCall(PetscFPrintf(comm, fd, " MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event). Never negative\n")); 17259566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " RMI Mbytes: Increase in resident memory (sum over all calls to event)\n")); 1726e3ed9ee7SBarry Smith } 1727d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17289566063dSJacob 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")); 17299566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " CpuToGpu Count: total number of CPU to GPU copies per processor\n")); 17309566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " CpuToGpu Size (Mbytes): 10e-6 * (total size of CPU to GPU copies per processor)\n")); 17319566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GpuToCpu Count: total number of GPU to CPU copies per processor\n")); 17329566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GpuToCpu Size (Mbytes): 10e-6 * (total size of GPU to CPU copies per processor)\n")); 17339566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GPU %%F: percent flops on GPU in this event\n")); 1734bec0b493Shannah_mairs #endif 17359566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n")); 17365c6c1daeSBarry Smith 17379566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm, fd)); 17385c6c1daeSBarry Smith 17395c6c1daeSBarry Smith /* Report events */ 17409566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Event Count Time (sec) Flop --- Global --- --- Stage ---- Total")); 174148a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, " Malloc EMalloc MMalloc RMI")); 1742d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17439566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GPU - CpuToGpu - - GpuToCpu - GPU")); 1744bec0b493Shannah_mairs #endif 17459566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 17469566063dSJacob 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")); 174748a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, " Mbytes Mbytes Mbytes Mbytes")); 1748d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17499566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Mflop/s Count Size Count Size %%F")); 1750bec0b493Shannah_mairs #endif 17519566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 17529566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------")); 175348a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, "-----------------------------")); 1754d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17559566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "---------------------------------------")); 17564863603aSSatish Balay #endif 17579566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 17585c6c1daeSBarry Smith 1759156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1760156b51fbSBarry Smith /* this indirect way of accessing these values is needed when PETSc is build with multiple libraries since the symbols are not in libpetscsys */ 1761156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "TAOSolve", &TAO_Solve)); 1762156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "TSStep", &TS_Step)); 1763156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "SNESSolve", &SNES_Solve)); 1764156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "KSPSolve", &KSP_Solve)); 1765156b51fbSBarry Smith #endif 1766156b51fbSBarry Smith 17675c6c1daeSBarry Smith /* Problem: The stage name will not show up unless the stage executed on proc 1 */ 17685c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 17695c6c1daeSBarry Smith if (!stageVisible[stage]) continue; 1770820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 17715c6c1daeSBarry Smith if (localStageUsed[stage]) { 17729566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name)); 17739566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17749566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17759566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17769566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17779566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17785c6c1daeSBarry Smith } else { 17799566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage)); 17809566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17819566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17829566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17839566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17849566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17855c6c1daeSBarry Smith } 17869371c9d4SSatish Balay mess *= 0.5; 17879371c9d4SSatish Balay messLen *= 0.5; 17889371c9d4SSatish Balay red /= size; 17895c6c1daeSBarry Smith 17905c6c1daeSBarry Smith /* Get total number of events in this stage -- 17915c6c1daeSBarry Smith Currently, a single processor can register more events than another, but events must all be registered in order, 17925c6c1daeSBarry Smith just like stages. We can removed this requirement if necessary by having a global event numbering and indirection 1793217044c2SLisandro Dalcin on the event ID. This seems best accomplished by associating a communicator with each stage. 17945c6c1daeSBarry Smith 17955c6c1daeSBarry Smith Problem: If the event did not happen on proc 1, its name will not be available. 17965c6c1daeSBarry Smith Problem: Event visibility is not implemented 17975c6c1daeSBarry Smith */ 17985c6c1daeSBarry Smith if (localStageUsed[stage]) { 17995c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo; 18005c6c1daeSBarry Smith localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents; 1801a297a907SKarl Rupp } else localNumEvents = 0; 18029566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 18035c6c1daeSBarry Smith for (event = 0; event < numEvents; event++) { 1804820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 18055c6c1daeSBarry Smith if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) { 18069371c9d4SSatish Balay if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; 18079371c9d4SSatish Balay else flopr = 0.0; 18089566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18099566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18109566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18119566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18129566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18139566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18149566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18159566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18169566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18179566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].count, &minC, 1, MPI_INT, MPI_MIN, comm)); 18189566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].count, &maxC, 1, MPI_INT, MPI_MAX, comm)); 1819e3ed9ee7SBarry Smith if (PetscLogMemory) { 18209566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].memIncrease, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18219566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocSpace, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18229566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocIncrease, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18239566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1824e3ed9ee7SBarry Smith } 1825d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 18269566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].CpuToGpuCount, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18279566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuToCpuCount, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18289566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].CpuToGpuSize, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18299566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuToCpuSize, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18309566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuFlops, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18319566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuTime, &gmaxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 1832bec0b493Shannah_mairs #endif 18335c6c1daeSBarry Smith name = stageLog->eventLog->eventInfo[event].name; 18345c6c1daeSBarry Smith } else { 18355c6c1daeSBarry Smith flopr = 0.0; 18369566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18379566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18389566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18399566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18409566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18419566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18429566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18439566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18449566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18459566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&ierr, &minC, 1, MPI_INT, MPI_MIN, comm)); 18469566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&ierr, &maxC, 1, MPI_INT, MPI_MAX, comm)); 1847e3ed9ee7SBarry Smith if (PetscLogMemory) { 18489566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18499566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18509566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18519566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &emalmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1852e3ed9ee7SBarry Smith } 1853d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 18549566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18559566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18569566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18579566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18589566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18599566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gmaxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 1860bec0b493Shannah_mairs #endif 18615c6c1daeSBarry Smith name = ""; 18625c6c1daeSBarry Smith } 18635c6c1daeSBarry Smith if (mint < 0.0) { 1864d0609cedSBarry 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)); 18655c6c1daeSBarry Smith mint = 0; 18665c6c1daeSBarry Smith } 186708401ef6SPierre 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); 1868156b51fbSBarry Smith /* Put NaN into the time for all events that may not be time accurately since they may happen asynchronously on the GPU */ 1869156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1870156b51fbSBarry Smith if (!PetscLogGpuTimeFlag && petsc_gflops > 0) { 1871156b51fbSBarry Smith memcpy(&gmaxt, &nas, sizeof(PetscLogDouble)); 1872156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, &eventid)); 1873156b51fbSBarry Smith if (eventid != SNES_Solve && eventid != KSP_Solve && eventid != TS_Step && eventid != TAO_Solve) { 1874156b51fbSBarry Smith memcpy(&mint, &nas, sizeof(PetscLogDouble)); 1875156b51fbSBarry Smith memcpy(&maxt, &nas, sizeof(PetscLogDouble)); 1876156b51fbSBarry Smith } 1877156b51fbSBarry Smith } 1878156b51fbSBarry Smith #endif 18799371c9d4SSatish Balay totm *= 0.5; 18809371c9d4SSatish Balay totml *= 0.5; 18819371c9d4SSatish Balay totr /= size; 18825c6c1daeSBarry Smith 1883217044c2SLisandro Dalcin if (maxC != 0) { 18849371c9d4SSatish Balay if (minC != 0) ratC = ((PetscLogDouble)maxC) / minC; 18859371c9d4SSatish Balay else ratC = 0.0; 18869371c9d4SSatish Balay if (mint != 0.0) ratt = maxt / mint; 18879371c9d4SSatish Balay else ratt = 0.0; 18889371c9d4SSatish Balay if (minf != 0.0) ratf = maxf / minf; 18899371c9d4SSatish Balay else ratf = 0.0; 18909371c9d4SSatish Balay if (TotalTime != 0.0) fracTime = tott / TotalTime; 18919371c9d4SSatish Balay else fracTime = 0.0; 18929371c9d4SSatish Balay if (TotalFlops != 0.0) fracFlops = totf / TotalFlops; 18939371c9d4SSatish Balay else fracFlops = 0.0; 18949371c9d4SSatish Balay if (stageTime != 0.0) fracStageTime = tott / stageTime; 18959371c9d4SSatish Balay else fracStageTime = 0.0; 18969371c9d4SSatish Balay if (flops != 0.0) fracStageFlops = totf / flops; 18979371c9d4SSatish Balay else fracStageFlops = 0.0; 18989371c9d4SSatish Balay if (numMessages != 0.0) fracMess = totm / numMessages; 18999371c9d4SSatish Balay else fracMess = 0.0; 19009371c9d4SSatish Balay if (messageLength != 0.0) fracMessLen = totml / messageLength; 19019371c9d4SSatish Balay else fracMessLen = 0.0; 19029371c9d4SSatish Balay if (numReductions != 0.0) fracRed = totr / numReductions; 19039371c9d4SSatish Balay else fracRed = 0.0; 19049371c9d4SSatish Balay if (mess != 0.0) fracStageMess = totm / mess; 19059371c9d4SSatish Balay else fracStageMess = 0.0; 19069371c9d4SSatish Balay if (messLen != 0.0) fracStageMessLen = totml / messLen; 19079371c9d4SSatish Balay else fracStageMessLen = 0.0; 19089371c9d4SSatish Balay if (red != 0.0) fracStageRed = totr / red; 19099371c9d4SSatish Balay else fracStageRed = 0.0; 19109371c9d4SSatish Balay if (totm != 0.0) totml /= totm; 19119371c9d4SSatish Balay else totml = 0.0; 19129371c9d4SSatish Balay if (maxt != 0.0) flopr = totf / maxt; 19139371c9d4SSatish Balay else flopr = 0.0; 191468a21331SBarry Smith if (fracStageTime > 1.0 || fracStageFlops > 1.0 || fracStageMess > 1.0 || fracStageMessLen > 1.0 || fracStageRed > 1.0) 1915a76edefcSRicardo 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)); 191668a21331SBarry Smith else 1917a76edefcSRicardo 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)); 191848a46eb9SPierre 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)); 1919d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 19209371c9d4SSatish Balay if (totf != 0.0) fracgflops = gflops / totf; 19219371c9d4SSatish Balay else fracgflops = 0.0; 19229371c9d4SSatish Balay if (gmaxt != 0.0) gflopr = gflops / gmaxt; 19239371c9d4SSatish Balay else gflopr = 0.0; 1924a76edefcSRicardo 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)); 1925bec0b493Shannah_mairs #endif 19269566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 19275c6c1daeSBarry Smith } 19285c6c1daeSBarry Smith } 19295c6c1daeSBarry Smith } 19305c6c1daeSBarry Smith 19315c6c1daeSBarry Smith /* Memory usage and object creation */ 19329566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------")); 193348a46eb9SPierre Jolivet if (PetscLogMemory) PetscCall(PetscFPrintf(comm, fd, "-----------------------------")); 1934d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 19359566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "---------------------------------------")); 19364863603aSSatish Balay #endif 19379566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 19389566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 19395c6c1daeSBarry Smith 19405c6c1daeSBarry Smith /* Right now, only stages on the first processor are reported here, meaning only objects associated with 19415c6c1daeSBarry Smith the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then 19425c6c1daeSBarry Smith stats for stages local to processor sets. 19435c6c1daeSBarry Smith */ 19445c6c1daeSBarry Smith /* We should figure out the longest object name here (now 20 characters) */ 19454851f57dSBarry Smith PetscCall(PetscFPrintf(comm, fd, "Object Type Creations Destructions. Reports information only for process 0.\n")); 19465c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 19475c6c1daeSBarry Smith if (localStageUsed[stage]) { 19485c6c1daeSBarry Smith classInfo = stageLog->stageInfo[stage].classLog->classInfo; 19499566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name)); 19505c6c1daeSBarry Smith for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) { 19515c6c1daeSBarry Smith if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) { 19524851f57dSBarry Smith PetscCall(PetscFPrintf(comm, fd, "%20s %5d %5d\n", stageLog->classLog->classInfo[oclass].name, classInfo[oclass].creations, classInfo[oclass].destructions)); 19535c6c1daeSBarry Smith } 19545c6c1daeSBarry Smith } 19555c6c1daeSBarry Smith } else { 1956cf019ec6SStefano Zampini if (!localStageVisible[stage]) continue; 19579566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage)); 19585c6c1daeSBarry Smith } 19595c6c1daeSBarry Smith } 19605c6c1daeSBarry Smith 19619566063dSJacob Faibussowitsch PetscCall(PetscFree(localStageUsed)); 19629566063dSJacob Faibussowitsch PetscCall(PetscFree(stageUsed)); 19639566063dSJacob Faibussowitsch PetscCall(PetscFree(localStageVisible)); 19649566063dSJacob Faibussowitsch PetscCall(PetscFree(stageVisible)); 19655c6c1daeSBarry Smith 19665c6c1daeSBarry Smith /* Information unrelated to this particular run */ 19679566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "========================================================================================================================\n")); 19688563dfccSBarry Smith PetscTime(&y); 19698563dfccSBarry Smith PetscTime(&x); 19709371c9d4SSatish Balay PetscTime(&y); 19719371c9d4SSatish Balay PetscTime(&y); 19729371c9d4SSatish Balay PetscTime(&y); 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); 19809566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Average time to get PetscTime(): %g\n", (y - x) / 10.0)); 19815c6c1daeSBarry Smith /* MPI information */ 19825c6c1daeSBarry Smith if (size > 1) { 19835c6c1daeSBarry Smith MPI_Status status; 19845c6c1daeSBarry Smith PetscMPIInt tag; 19855c6c1daeSBarry Smith MPI_Comm newcomm; 19865c6c1daeSBarry Smith 19879566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19888563dfccSBarry Smith PetscTime(&x); 19899566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19909566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19919566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19929566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19939566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19948563dfccSBarry Smith PetscTime(&y); 19959566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y - x) / 5.0)); 19969566063dSJacob Faibussowitsch PetscCall(PetscCommDuplicate(comm, &newcomm, &tag)); 19979566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19985c6c1daeSBarry Smith if (rank) { 19999566063dSJacob Faibussowitsch PetscCallMPI(MPI_Recv(NULL, 0, MPI_INT, rank - 1, tag, newcomm, &status)); 20009566063dSJacob Faibussowitsch PetscCallMPI(MPI_Send(NULL, 0, MPI_INT, (rank + 1) % size, tag, newcomm)); 20015c6c1daeSBarry Smith } else { 20028563dfccSBarry Smith PetscTime(&x); 20039566063dSJacob Faibussowitsch PetscCallMPI(MPI_Send(NULL, 0, MPI_INT, 1, tag, newcomm)); 20049566063dSJacob Faibussowitsch PetscCallMPI(MPI_Recv(NULL, 0, MPI_INT, size - 1, tag, newcomm, &status)); 20058563dfccSBarry Smith PetscTime(&y); 20069566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Average time for zero size MPI_Send(): %g\n", (y - x) / size)); 20075c6c1daeSBarry Smith } 20089566063dSJacob Faibussowitsch PetscCall(PetscCommDestroy(&newcomm)); 20095c6c1daeSBarry Smith } 20109566063dSJacob Faibussowitsch PetscCall(PetscOptionsView(NULL, viewer)); 20115c6c1daeSBarry Smith 20125c6c1daeSBarry Smith /* Machine and compile information */ 20135c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS) 20149566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n")); 20155c6c1daeSBarry Smith #else 20169566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n")); 20175c6c1daeSBarry Smith #endif 2018217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) 20199566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n")); 2020217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128) 20219566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n")); 2022217044c2SLisandro Dalcin #endif 20235c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 20249566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n")); 20255f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128) 20269566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n")); 20275c6c1daeSBarry Smith #endif 20285c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE) 20299566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with single precision matrices\n")); 20305c6c1daeSBarry Smith #else 20319566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n")); 20325c6c1daeSBarry Smith #endif 20339371c9d4SSatish 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))); 20345c6c1daeSBarry Smith 20359566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Configure options: %s", petscconfigureoptions)); 20369566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petscmachineinfo)); 20379566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsccompilerinfo)); 20389566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo)); 20399566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsclinkerinfo)); 20405c6c1daeSBarry Smith 20415c6c1daeSBarry Smith /* Cleanup */ 20429566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 20439566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnNoGpuAwareMpi(comm, fd)); 20449566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm, fd)); 2045156b51fbSBarry Smith PetscCall(PetscFPTrapPop()); 20465c6c1daeSBarry Smith PetscFunctionReturn(0); 20475c6c1daeSBarry Smith } 20485c6c1daeSBarry Smith 20497d6c928cSSatish Balay /*@C 20507d6c928cSSatish Balay PetscLogView - Prints a summary of the logging. 20515c6c1daeSBarry Smith 20525c6c1daeSBarry Smith Collective over MPI_Comm 20535c6c1daeSBarry Smith 20545c6c1daeSBarry Smith Input Parameter: 2055f14045dbSBarry Smith . viewer - an ASCII viewer 20565c6c1daeSBarry Smith 20575c6c1daeSBarry Smith Options Database Keys: 2058bb1d7374SBarry Smith + -log_view [:filename] - Prints summary of log information 2059bb1d7374SBarry Smith . -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file 2060607d249eSBarry 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) 2061d0a29bd7SConnor 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) 2062156b51fbSBarry Smith . -log_view_memory - Also display memory usage in each event 2063156b51fbSBarry Smith . -log_view_gpu_time - Also display time in each event for GPU kernels (Note this may slow the computation) 2064811af0c4SBarry Smith . -log_all - Saves a file Log.rank for each MPI rank with details of each step of the computation 2065bb1d7374SBarry Smith - -log_trace [filename] - Displays a trace of what each process is doing 20665c6c1daeSBarry Smith 2067d1f92df0SBarry Smith Level: beginner 2068d1f92df0SBarry Smith 20695c6c1daeSBarry Smith Notes: 2070*da81f932SPierre Jolivet It is possible to control the logging programmatically but we recommend using the options database approach whenever possible 20715c6c1daeSBarry Smith By default the summary is printed to stdout. 20725c6c1daeSBarry Smith 2073bb1d7374SBarry Smith Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin() 2074bb1d7374SBarry Smith 2075bb1d7374SBarry Smith If PETSc is configured with --with-logging=0 then this functionality is not available 2076bb1d7374SBarry Smith 2077607d249eSBarry Smith To view the nested XML format filename.xml first copy ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current 2078607d249eSBarry Smith directory then open filename.xml with your browser. Specific notes for certain browsers 2079607d249eSBarry Smith $ Firefox and Internet explorer - simply open the file 2080607d249eSBarry Smith $ Google Chrome - you must start up Chrome with the option --allow-file-access-from-files 2081a8d69d7bSBarry Smith $ Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access 2082607d249eSBarry 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 2083607d249eSBarry Smith your browser. 20842add09c0SLisandro Dalcin Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser 20852add09c0SLisandro Dalcin window and render the XML log file contents. 2086607d249eSBarry Smith 2087bb1d7374SBarry Smith The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij MARITIME RESEARCH INSTITUTE NETHERLANDS 2088bb1d7374SBarry Smith 2089d0a29bd7SConnor Ward The Flame Graph output can be visualised using either the original Flame Graph script (https://github.com/brendangregg/FlameGraph) 2090d0a29bd7SConnor Ward or using speedscope (https://www.speedscope.app). 2091d0a29bd7SConnor Ward Old XML profiles may be converted into this format using the script ${PETSC_DIR}/lib/petsc/bin/xml2flamegraph.py. 2092d0a29bd7SConnor Ward 2093d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDefaultBegin()`, `PetscLogDump()` 20945c6c1daeSBarry Smith @*/ 2095d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogView(PetscViewer viewer) 2096d71ae5a4SJacob Faibussowitsch { 2097f14045dbSBarry Smith PetscBool isascii; 2098f14045dbSBarry Smith PetscViewerFormat format; 209937b78d16SBarry Smith int stage, lastStage; 210037b78d16SBarry Smith PetscStageLog stageLog; 21015c6c1daeSBarry Smith 21025c6c1daeSBarry Smith PetscFunctionBegin; 210328b400f6SJacob Faibussowitsch PetscCheck(PetscLogPLB, PETSC_COMM_SELF, PETSC_ERR_SUP, "Must use -log_view or PetscLogDefaultBegin() before calling this routine"); 210437b78d16SBarry Smith /* Pop off any stages the user forgot to remove */ 210537b78d16SBarry Smith lastStage = 0; 21069566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 21079566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 210837b78d16SBarry Smith while (stage >= 0) { 210937b78d16SBarry Smith lastStage = stage; 21109566063dSJacob Faibussowitsch PetscCall(PetscStageLogPop(stageLog)); 21119566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 211237b78d16SBarry Smith } 21139566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &isascii)); 211428b400f6SJacob Faibussowitsch PetscCheck(isascii, PetscObjectComm((PetscObject)viewer), PETSC_ERR_SUP, "Currently can only view logging to ASCII"); 21159566063dSJacob Faibussowitsch PetscCall(PetscViewerGetFormat(viewer, &format)); 2116f14045dbSBarry Smith if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) { 21179566063dSJacob Faibussowitsch PetscCall(PetscLogView_Default(viewer)); 2118f14045dbSBarry Smith } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) { 21199566063dSJacob Faibussowitsch PetscCall(PetscLogView_Detailed(viewer)); 212038144912Sdeepblu2718 } else if (format == PETSC_VIEWER_ASCII_CSV) { 21219566063dSJacob Faibussowitsch PetscCall(PetscLogView_CSV(viewer)); 2122bb1d7374SBarry Smith } else if (format == PETSC_VIEWER_ASCII_XML) { 21239566063dSJacob Faibussowitsch PetscCall(PetscLogView_Nested(viewer)); 2124d0a29bd7SConnor Ward } else if (format == PETSC_VIEWER_ASCII_FLAMEGRAPH) { 21259566063dSJacob Faibussowitsch PetscCall(PetscLogView_Flamegraph(viewer)); 21265c6c1daeSBarry Smith } 21279566063dSJacob Faibussowitsch PetscCall(PetscStageLogPush(stageLog, lastStage)); 21285c6c1daeSBarry Smith PetscFunctionReturn(0); 21295c6c1daeSBarry Smith } 21305c6c1daeSBarry Smith 2131f14045dbSBarry Smith /*@C 2132811af0c4SBarry Smith PetscLogViewFromOptions - Processes command line options to determine if/how a `PetscLog` is to be viewed. 2133f14045dbSBarry Smith 2134811af0c4SBarry Smith Collective on `PETSC_COMM_WORLD` 2135f14045dbSBarry Smith 2136811af0c4SBarry Smith Level: developer 2137f14045dbSBarry Smith 2138d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogView()` 2139f14045dbSBarry Smith @*/ 2140d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogViewFromOptions(void) 2141d71ae5a4SJacob Faibussowitsch { 2142f14045dbSBarry Smith PetscViewer viewer; 2143f14045dbSBarry Smith PetscBool flg; 2144f14045dbSBarry Smith PetscViewerFormat format; 2145f14045dbSBarry Smith 2146f14045dbSBarry Smith PetscFunctionBegin; 21479566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetViewer(PETSC_COMM_WORLD, NULL, NULL, "-log_view", &viewer, &format, &flg)); 2148f14045dbSBarry Smith if (flg) { 21499566063dSJacob Faibussowitsch PetscCall(PetscViewerPushFormat(viewer, format)); 21509566063dSJacob Faibussowitsch PetscCall(PetscLogView(viewer)); 21519566063dSJacob Faibussowitsch PetscCall(PetscViewerPopFormat(viewer)); 21529566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&viewer)); 2153f14045dbSBarry Smith } 2154f14045dbSBarry Smith PetscFunctionReturn(0); 2155f14045dbSBarry Smith } 2156f14045dbSBarry Smith 21575c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/ 21585c6c1daeSBarry Smith /*@C 21595c6c1daeSBarry Smith PetscGetFlops - Returns the number of flops used on this processor 21605c6c1daeSBarry Smith since the program began. 21615c6c1daeSBarry Smith 21625c6c1daeSBarry Smith Not Collective 21635c6c1daeSBarry Smith 21645c6c1daeSBarry Smith Output Parameter: 21655c6c1daeSBarry Smith flops - number of floating point operations 21665c6c1daeSBarry Smith 2167d1f92df0SBarry Smith Level: intermediate 2168d1f92df0SBarry Smith 21695c6c1daeSBarry Smith Notes: 21705c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 2171811af0c4SBarry Smith `PetscLogFlops()` to increment this counter to include flops for the 21725c6c1daeSBarry Smith application code. 21735c6c1daeSBarry Smith 2174811af0c4SBarry Smith A separate counter `PetscLogGPUFlops()` logs the flops that occur on any GPU associated with this MPI rank 2175811af0c4SBarry Smith 2176d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogGPUFlops()`, `PetscTime()`, `PetscLogFlops()` 21775c6c1daeSBarry Smith @*/ 2178d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscGetFlops(PetscLogDouble *flops) 2179d71ae5a4SJacob Faibussowitsch { 21805c6c1daeSBarry Smith PetscFunctionBegin; 21815c6c1daeSBarry Smith *flops = petsc_TotalFlops; 21825c6c1daeSBarry Smith PetscFunctionReturn(0); 21835c6c1daeSBarry Smith } 21845c6c1daeSBarry Smith 2185d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 2186d71ae5a4SJacob Faibussowitsch { 21875c6c1daeSBarry Smith size_t fullLength; 21885c6c1daeSBarry Smith va_list Argp; 21895c6c1daeSBarry Smith 21905c6c1daeSBarry Smith PetscFunctionBegin; 21915c6c1daeSBarry Smith if (!petsc_logObjects) PetscFunctionReturn(0); 21925c6c1daeSBarry Smith va_start(Argp, format); 21939566063dSJacob Faibussowitsch PetscCall(PetscVSNPrintf(petsc_objects[obj->id].info, 64, format, &fullLength, Argp)); 21945c6c1daeSBarry Smith va_end(Argp); 21955c6c1daeSBarry Smith PetscFunctionReturn(0); 21965c6c1daeSBarry Smith } 21975c6c1daeSBarry Smith 21985c6c1daeSBarry Smith /*MC 21995c6c1daeSBarry Smith PetscLogFlops - Adds floating point operations to the global counter. 22005c6c1daeSBarry Smith 22015c6c1daeSBarry Smith Synopsis: 2202aaa7dc30SBarry Smith #include <petsclog.h> 22035c6c1daeSBarry Smith PetscErrorCode PetscLogFlops(PetscLogDouble f) 22045c6c1daeSBarry Smith 22055c6c1daeSBarry Smith Not Collective 22065c6c1daeSBarry Smith 22075c6c1daeSBarry Smith Input Parameter: 22085c6c1daeSBarry Smith . f - flop counter 22095c6c1daeSBarry Smith 22105c6c1daeSBarry Smith Usage: 22115c6c1daeSBarry Smith .vb 22125c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 22135c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 22145c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 22155c6c1daeSBarry Smith [code segment to monitor] 22165c6c1daeSBarry Smith PetscLogFlops(user_flops) 22175c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 22185c6c1daeSBarry Smith .ve 22195c6c1daeSBarry Smith 2220d1f92df0SBarry Smith Level: intermediate 2221d1f92df0SBarry Smith 2222811af0c4SBarry Smith Note: 22235c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 22245c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 22255c6c1daeSBarry Smith application code. 22265c6c1daeSBarry Smith 2227d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogGPUFlops()`, `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscGetFlops()` 22285c6c1daeSBarry Smith M*/ 22295c6c1daeSBarry Smith 22305c6c1daeSBarry Smith /*MC 22315c6c1daeSBarry Smith PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice) 22325c6c1daeSBarry Smith to get accurate timings 22335c6c1daeSBarry Smith 22345c6c1daeSBarry Smith Synopsis: 2235aaa7dc30SBarry Smith #include <petsclog.h> 22365c6c1daeSBarry Smith void PetscPreLoadBegin(PetscBool flag,char *name); 22375c6c1daeSBarry Smith 22385c6c1daeSBarry Smith Not Collective 22395c6c1daeSBarry Smith 2240d8d19677SJose E. Roman Input Parameters: 2241811af0c4SBarry Smith + flag - PETSC_TRUE to run twice, `PETSC_FALSE` to run once, may be overridden 22425c6c1daeSBarry Smith with command line option -preload true or -preload false 2243609bdbeeSBarry Smith - name - name of first stage (lines of code timed separately with -log_view) to 22445c6c1daeSBarry Smith be preloaded 22455c6c1daeSBarry Smith 22465c6c1daeSBarry Smith Usage: 22475c6c1daeSBarry Smith .vb 22485c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22495c6c1daeSBarry Smith lines of code 22505c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22515c6c1daeSBarry Smith lines of code 22525c6c1daeSBarry Smith PetscPreLoadEnd(); 22535c6c1daeSBarry Smith .ve 22545c6c1daeSBarry Smith 2255d1f92df0SBarry Smith Level: intermediate 2256d1f92df0SBarry Smith 2257811af0c4SBarry Smith Note: 225895452b02SPatrick Sanan Only works in C/C++, not Fortran 22595c6c1daeSBarry Smith 22605c6c1daeSBarry Smith Flags available within the macro. 22615c6c1daeSBarry Smith + PetscPreLoadingUsed - true if we are or have done preloading 22625c6c1daeSBarry Smith . PetscPreLoadingOn - true if it is CURRENTLY doing preload 22635c6c1daeSBarry Smith . PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second 22645c6c1daeSBarry Smith - PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on 22655c6c1daeSBarry Smith The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin() 22665c6c1daeSBarry Smith and PetscPreLoadEnd() 22675c6c1daeSBarry Smith 2268d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 22695c6c1daeSBarry Smith M*/ 22705c6c1daeSBarry Smith 22715c6c1daeSBarry Smith /*MC 22725c6c1daeSBarry Smith PetscPreLoadEnd - End a segment of code that may be preloaded (run twice) 22735c6c1daeSBarry Smith to get accurate timings 22745c6c1daeSBarry Smith 22755c6c1daeSBarry Smith Synopsis: 2276aaa7dc30SBarry Smith #include <petsclog.h> 22775c6c1daeSBarry Smith void PetscPreLoadEnd(void); 22785c6c1daeSBarry Smith 22795c6c1daeSBarry Smith Not Collective 22805c6c1daeSBarry Smith 22815c6c1daeSBarry Smith Usage: 22825c6c1daeSBarry Smith .vb 22835c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22845c6c1daeSBarry Smith lines of code 22855c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22865c6c1daeSBarry Smith lines of code 22875c6c1daeSBarry Smith PetscPreLoadEnd(); 22885c6c1daeSBarry Smith .ve 22895c6c1daeSBarry Smith 2290d1f92df0SBarry Smith Level: intermediate 2291d1f92df0SBarry Smith 2292811af0c4SBarry Smith Note: 2293811af0c4SBarry Smith Only works in C/C++ not fortran 22945c6c1daeSBarry Smith 2295d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadStage()` 22965c6c1daeSBarry Smith M*/ 22975c6c1daeSBarry Smith 22985c6c1daeSBarry Smith /*MC 22995c6c1daeSBarry Smith PetscPreLoadStage - Start a new segment of code to be timed separately. 23005c6c1daeSBarry Smith to get accurate timings 23015c6c1daeSBarry Smith 23025c6c1daeSBarry Smith Synopsis: 2303aaa7dc30SBarry Smith #include <petsclog.h> 23045c6c1daeSBarry Smith void PetscPreLoadStage(char *name); 23055c6c1daeSBarry Smith 23065c6c1daeSBarry Smith Not Collective 23075c6c1daeSBarry Smith 23085c6c1daeSBarry Smith Usage: 23095c6c1daeSBarry Smith .vb 23105c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 23115c6c1daeSBarry Smith lines of code 23125c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 23135c6c1daeSBarry Smith lines of code 23145c6c1daeSBarry Smith PetscPreLoadEnd(); 23155c6c1daeSBarry Smith .ve 23165c6c1daeSBarry Smith 2317d1f92df0SBarry Smith Level: intermediate 2318d1f92df0SBarry Smith 2319811af0c4SBarry Smith Note: 2320811af0c4SBarry Smith Only works in C/C++ not fortran 23215c6c1daeSBarry Smith 2322d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()` 23235c6c1daeSBarry Smith M*/ 23245c6c1daeSBarry Smith 2325a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_DEVICE) 2326a4af0ceeSJacob Faibussowitsch #include <petsc/private/deviceimpl.h> 23279ffd0706SHong Zhang 2328156b51fbSBarry Smith PetscBool PetscLogGpuTimeFlag = PETSC_FALSE; 2329156b51fbSBarry Smith 2330156b51fbSBarry Smith /* 2331156b51fbSBarry Smith This cannot be called by users between PetscInitialize() and PetscFinalize() at any random location in the code 2332156b51fbSBarry Smith because it will result in timing results that cannot be interpreted. 2333156b51fbSBarry Smith */ 2334d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscLogGpuTime_Off(void) 2335d71ae5a4SJacob Faibussowitsch { 2336156b51fbSBarry Smith PetscLogGpuTimeFlag = PETSC_FALSE; 2337156b51fbSBarry Smith return 0; 2338156b51fbSBarry Smith } 2339156b51fbSBarry Smith 2340156b51fbSBarry Smith /*@C 2341156b51fbSBarry Smith PetscLogGpuTime - turn on the logging of GPU time for GPU kernels 2342156b51fbSBarry Smith 2343811af0c4SBarry Smith Options Database Key: 2344156b51fbSBarry Smith . -log_view_gpu_time - provide the GPU times in the -log_view output 2345156b51fbSBarry Smith 2346d1f92df0SBarry Smith Level: advanced 2347d1f92df0SBarry Smith 2348156b51fbSBarry Smith Notes: 2349811af0c4SBarry Smith Turning on the timing of the 2350156b51fbSBarry Smith GPU kernels can slow down the entire computation and should only be used when studying the performance 2351156b51fbSBarry Smith of operations on GPU such as vector operations and matrix-vector operations. 2352156b51fbSBarry Smith 2353156b51fbSBarry Smith This routine should only be called once near the beginning of the program. Once it is started it cannot be turned off. 2354156b51fbSBarry Smith 2355d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuTimeBegin()` 2356156b51fbSBarry Smith @*/ 2357d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGpuTime(void) 2358d71ae5a4SJacob Faibussowitsch { 2359156b51fbSBarry Smith if (!PetscLogGpuTimeFlag) PetscCall(PetscRegisterFinalize(PetscLogGpuTime_Off)); 2360156b51fbSBarry Smith PetscLogGpuTimeFlag = PETSC_TRUE; 2361156b51fbSBarry Smith return 0; 2362156b51fbSBarry Smith } 2363156b51fbSBarry Smith 23649ffd0706SHong Zhang /*@C 23659ffd0706SHong Zhang PetscLogGpuTimeBegin - Start timer for device 23669ffd0706SHong Zhang 2367d1f92df0SBarry Smith Level: intermediate 2368d1f92df0SBarry Smith 23699ffd0706SHong Zhang Notes: 23709ffd0706SHong 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). 2371811af0c4SBarry Smith 23729ffd0706SHong 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). 2373811af0c4SBarry Smith 2374811af0c4SBarry Smith There is no need to call WaitForCUDA() or WaitForHIP() between `PetscLogGpuTimeBegin()` and `PetscLogGpuTimeEnd()` 2375811af0c4SBarry Smith 23769ffd0706SHong Zhang This timer should NOT include times for data transfers between the GPU and CPU, nor setup actions such as allocating space. 2377811af0c4SBarry Smith 2378*da81f932SPierre Jolivet The regular logging captures the time for data transfers and any CPU activities during the event 2379811af0c4SBarry Smith 23809ffd0706SHong Zhang It is used to compute the flop rate on the GPU as it is actively engaged in running a kernel. 23819ffd0706SHong Zhang 23829ffd0706SHong Zhang Developer Notes: 2383811af0c4SBarry 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()`. 2384811af0c4SBarry Smith 2385811af0c4SBarry 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 2386811af0c4SBarry Smith event when it reaches that event in the stream. The function xxxEventSynchronize() is called in `PetsLogGpuTimeEnd()` to block CPU execution, 2387*da81f932SPierre Jolivet but not continued GPU execution, until the timer event is recorded. 23889ffd0706SHong Zhang 2389d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuTime()` 23909ffd0706SHong Zhang @*/ 2391d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGpuTimeBegin(void) 2392d71ae5a4SJacob Faibussowitsch { 23939ffd0706SHong Zhang PetscFunctionBegin; 2394156b51fbSBarry Smith if (!PetscLogPLB || !PetscLogGpuTimeFlag) PetscFunctionReturn(0); 2395a4af0ceeSJacob Faibussowitsch if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) { 2396a4af0ceeSJacob Faibussowitsch PetscDeviceContext dctx; 2397a4af0ceeSJacob Faibussowitsch 23989566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextGetCurrentContext(&dctx)); 23999566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextBeginTimer_Internal(dctx)); 2400a4af0ceeSJacob Faibussowitsch } else { 24019566063dSJacob Faibussowitsch PetscCall(PetscTimeSubtract(&petsc_gtime)); 2402a4af0ceeSJacob Faibussowitsch } 24039ffd0706SHong Zhang PetscFunctionReturn(0); 24049ffd0706SHong Zhang } 24059ffd0706SHong Zhang 24069ffd0706SHong Zhang /*@C 24079ffd0706SHong Zhang PetscLogGpuTimeEnd - Stop timer for device 24089ffd0706SHong Zhang 24099ffd0706SHong Zhang Level: intermediate 24109ffd0706SHong Zhang 2411d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeBegin()` 24129ffd0706SHong Zhang @*/ 2413d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogGpuTimeEnd(void) 2414d71ae5a4SJacob Faibussowitsch { 24159ffd0706SHong Zhang PetscFunctionBegin; 2416156b51fbSBarry Smith if (!PetscLogPLE || !PetscLogGpuTimeFlag) PetscFunctionReturn(0); 2417a4af0ceeSJacob Faibussowitsch if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) { 2418a4af0ceeSJacob Faibussowitsch PetscDeviceContext dctx; 2419a4af0ceeSJacob Faibussowitsch PetscLogDouble elapsed; 2420a4af0ceeSJacob Faibussowitsch 24219566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextGetCurrentContext(&dctx)); 24229566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextEndTimer_Internal(dctx, &elapsed)); 2423a4af0ceeSJacob Faibussowitsch petsc_gtime += (elapsed / 1000.0); 2424a4af0ceeSJacob Faibussowitsch } else { 24259566063dSJacob Faibussowitsch PetscCall(PetscTimeAdd(&petsc_gtime)); 2426a4af0ceeSJacob Faibussowitsch } 24279ffd0706SHong Zhang PetscFunctionReturn(0); 24289ffd0706SHong Zhang } 24299ffd0706SHong Zhang #endif /* end of PETSC_HAVE_DEVICE */ 24309ffd0706SHong Zhang 24315c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */ 24325c6c1daeSBarry Smith 2433d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 2434d71ae5a4SJacob Faibussowitsch { 24355c6c1daeSBarry Smith PetscFunctionBegin; 24365c6c1daeSBarry Smith PetscFunctionReturn(0); 24375c6c1daeSBarry Smith } 24385c6c1daeSBarry Smith 24395c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/ 24405c6c1daeSBarry Smith 24415c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 24425c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID = 0; 24435c6c1daeSBarry Smith 24445c6c1daeSBarry Smith /*@C 24455c6c1daeSBarry Smith PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code. 24465c6c1daeSBarry Smith 24475c6c1daeSBarry Smith Not Collective 24485c6c1daeSBarry Smith 24495c6c1daeSBarry Smith Input Parameter: 24505c6c1daeSBarry Smith . name - The class name 24515c6c1daeSBarry Smith 24525c6c1daeSBarry Smith Output Parameter: 24535c6c1daeSBarry Smith . oclass - The class id or classid 24545c6c1daeSBarry Smith 24555c6c1daeSBarry Smith Level: developer 24565c6c1daeSBarry Smith 2457d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()` 24585c6c1daeSBarry Smith @*/ 2459d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscClassIdRegister(const char name[], PetscClassId *oclass) 2460d71ae5a4SJacob Faibussowitsch { 24615c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 24625c6c1daeSBarry Smith PetscStageLog stageLog; 24635c6c1daeSBarry Smith PetscInt stage; 24645c6c1daeSBarry Smith #endif 24655c6c1daeSBarry Smith 24665c6c1daeSBarry Smith PetscFunctionBegin; 24675c6c1daeSBarry Smith *oclass = ++PETSC_LARGEST_CLASSID; 24685c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 24699566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 24709566063dSJacob Faibussowitsch PetscCall(PetscClassRegLogRegister(stageLog->classLog, name, *oclass)); 247148a46eb9SPierre Jolivet for (stage = 0; stage < stageLog->numStages; stage++) PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses)); 24725c6c1daeSBarry Smith #endif 24735c6c1daeSBarry Smith PetscFunctionReturn(0); 24745c6c1daeSBarry Smith } 2475210b5426SBarry Smith 2476210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE) 2477210b5426SBarry Smith #include <mpe.h> 2478210b5426SBarry Smith 2479210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE; 2480210b5426SBarry Smith 2481495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject); 2482495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject); 2483495fc317SBarry Smith 2484210b5426SBarry Smith /*@C 2485210b5426SBarry Smith PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files 2486210b5426SBarry Smith and slows the program down. 2487210b5426SBarry Smith 2488811af0c4SBarry Smith Collective over `PETSC_COMM_WORLD` 2489210b5426SBarry Smith 2490811af0c4SBarry Smith Options Database Key: 2491a2553e36SBarry Smith . -log_mpe - Prints extensive log information 2492210b5426SBarry Smith 2493d1f92df0SBarry Smith Level: advanced 2494d1f92df0SBarry Smith 2495811af0c4SBarry Smith Note: 2496811af0c4SBarry Smith A related routine is `PetscLogDefaultBegin()` (with the options key -log_view), which is 2497210b5426SBarry Smith intended for production runs since it logs only flop rates and object 2498210b5426SBarry Smith creation (and should not significantly slow the programs). 2499210b5426SBarry Smith 2500d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogEventActivate()`, 2501db781477SPatrick Sanan `PetscLogEventDeactivate()` 2502210b5426SBarry Smith @*/ 2503d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogMPEBegin(void) 2504d71ae5a4SJacob Faibussowitsch { 2505210b5426SBarry Smith PetscFunctionBegin; 2506210b5426SBarry Smith /* Do MPE initialization */ 2507210b5426SBarry Smith if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */ 25089566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "Initializing MPE.\n")); 25099566063dSJacob Faibussowitsch PetscCall(MPE_Init_log()); 2510210b5426SBarry Smith 2511210b5426SBarry Smith PetscBeganMPE = PETSC_TRUE; 2512210b5426SBarry Smith } else { 25139566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "MPE already initialized. Not attempting to reinitialize.\n")); 2514210b5426SBarry Smith } 25159566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE)); 2516210b5426SBarry Smith PetscFunctionReturn(0); 2517210b5426SBarry Smith } 2518210b5426SBarry Smith 2519210b5426SBarry Smith /*@C 2520495fc317SBarry Smith PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot. 2521210b5426SBarry Smith 2522811af0c4SBarry Smith Collective over `PETSC_COMM_WORLD` 2523210b5426SBarry Smith 2524210b5426SBarry Smith Level: advanced 2525210b5426SBarry Smith 2526d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogMPEBegin()` 2527210b5426SBarry Smith @*/ 2528d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogMPEDump(const char sname[]) 2529d71ae5a4SJacob Faibussowitsch { 2530210b5426SBarry Smith char name[PETSC_MAX_PATH_LEN]; 2531210b5426SBarry Smith 2532210b5426SBarry Smith PetscFunctionBegin; 2533210b5426SBarry Smith if (PetscBeganMPE) { 25349566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "Finalizing MPE.\n")); 2535210b5426SBarry Smith if (sname) { 25369566063dSJacob Faibussowitsch PetscCall(PetscStrcpy(name, sname)); 2537210b5426SBarry Smith } else { 25389566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(name, sizeof(name))); 2539210b5426SBarry Smith } 25409566063dSJacob Faibussowitsch PetscCall(MPE_Finish_log(name)); 2541210b5426SBarry Smith } else { 25429566063dSJacob Faibussowitsch PetscCall(PetscInfo(0, "Not finalizing MPE (not started by PETSc).\n")); 2543210b5426SBarry Smith } 2544210b5426SBarry Smith PetscFunctionReturn(0); 2545210b5426SBarry Smith } 2546210b5426SBarry Smith 2547210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39 25489371c9d4SSatish Balay static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = {"OliveDrab: ", "BlueViolet: ", "CadetBlue: ", "CornflowerBlue: ", "DarkGoldenrod: ", "DarkGreen: ", "DarkKhaki: ", "DarkOliveGreen: ", 25499371c9d4SSatish Balay "DarkOrange: ", "DarkOrchid: ", "DarkSeaGreen: ", "DarkSlateGray: ", "DarkTurquoise: ", "DeepPink: ", "DarkKhaki: ", "DimGray: ", 25509371c9d4SSatish Balay "DodgerBlue: ", "GreenYellow: ", "HotPink: ", "IndianRed: ", "LavenderBlush: ", "LawnGreen: ", "LemonChiffon: ", "LightCoral: ", 25519371c9d4SSatish Balay "LightCyan: ", "LightPink: ", "LightSalmon: ", "LightSlateGray: ", "LightYellow: ", "LimeGreen: ", "MediumPurple: ", "MediumSeaGreen: ", 25529371c9d4SSatish Balay "MediumSlateBlue:", "MidnightBlue: ", "MintCream: ", "MistyRose: ", "NavajoWhite: ", "NavyBlue: ", "OliveDrab: "}; 2553210b5426SBarry Smith 2554210b5426SBarry Smith /*@C 2555811af0c4SBarry Smith PetscLogMPEGetRGBColor - This routine returns a rgb color useable with `PetscLogEventRegister()` 2556210b5426SBarry Smith 2557210b5426SBarry Smith Not collective. Maybe it should be? 2558210b5426SBarry Smith 25597a7aea1fSJed Brown Output Parameter: 2560210b5426SBarry Smith . str - character string representing the color 2561210b5426SBarry Smith 2562210b5426SBarry Smith Level: developer 2563210b5426SBarry Smith 2564d1f92df0SBarry Smith .seealso: [](ch_profiling), `PetscLogEventRegister()` 2565210b5426SBarry Smith @*/ 2566d71ae5a4SJacob Faibussowitsch PetscErrorCode PetscLogMPEGetRGBColor(const char *str[]) 2567d71ae5a4SJacob Faibussowitsch { 2568210b5426SBarry Smith static int idx = 0; 2569210b5426SBarry Smith 2570210b5426SBarry Smith PetscFunctionBegin; 2571210b5426SBarry Smith *str = PetscLogMPERGBColors[idx]; 2572210b5426SBarry Smith idx = (idx + 1) % PETSC_RGB_COLORS_MAX; 2573210b5426SBarry Smith PetscFunctionReturn(0); 2574210b5426SBarry Smith } 2575210b5426SBarry Smith 2576210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */ 2577