15c6c1daeSBarry Smith 25c6c1daeSBarry Smith /* 35c6c1daeSBarry Smith PETSc code to log object creation and destruction and PETSc events. 45c6c1daeSBarry Smith 55c6c1daeSBarry Smith This provides the public API used by the rest of PETSc and by users. 65c6c1daeSBarry Smith 75c6c1daeSBarry Smith These routines use a private API that is not used elsewhere in PETSc and is not 85c6c1daeSBarry Smith accessible to users. The private API is defined in logimpl.h and the utils directory. 95c6c1daeSBarry Smith 105c6c1daeSBarry Smith */ 11af0996ceSBarry Smith #include <petsc/private/logimpl.h> /*I "petscsys.h" I*/ 125c6c1daeSBarry Smith #include <petsctime.h> 13665c2dedSJed Brown #include <petscviewer.h> 145c6c1daeSBarry Smith 153bb1ff40SBarry Smith PetscErrorCode PetscLogObjectParent(PetscObject p,PetscObject c) 163bb1ff40SBarry Smith { 1727b6d19dSBarry Smith if (!c || !p) return 0; 183bb1ff40SBarry Smith c->parent = p; 193bb1ff40SBarry Smith c->parentid = p->id; 203bb1ff40SBarry Smith return 0; 213bb1ff40SBarry Smith } 223bb1ff40SBarry Smith 23bb72fc59SBarry Smith /*@C 24bb72fc59SBarry Smith PetscLogObjectMemory - Adds to an object a count of additional amount of memory that is used by the object. 25bb72fc59SBarry Smith 26bb72fc59SBarry Smith Not collective. 27bb72fc59SBarry Smith 28bb72fc59SBarry Smith Input Parameters: 29bb72fc59SBarry Smith + obj - the PETSc object 30bb72fc59SBarry Smith - mem - the amount of memory that is being added to the object 31bb72fc59SBarry Smith 32bb72fc59SBarry Smith Level: developer 33bb72fc59SBarry Smith 3495452b02SPatrick Sanan Developer Notes: 3595452b02SPatrick Sanan Currently we do not always do a good job of associating all memory allocations with an object. 36bb72fc59SBarry Smith 37db781477SPatrick Sanan .seealso: `PetscFinalize()`, `PetscInitializeFortran()`, `PetscGetArgs()`, `PetscInitializeNoArguments()` 38bb72fc59SBarry Smith 39bb72fc59SBarry Smith @*/ 403bb1ff40SBarry Smith PetscErrorCode PetscLogObjectMemory(PetscObject p,PetscLogDouble m) 413bb1ff40SBarry Smith { 42d12f57a0SLisandro Dalcin if (!p) return 0; 4327b6d19dSBarry Smith p->mem += m; 443bb1ff40SBarry Smith return 0; 453bb1ff40SBarry Smith } 463bb1ff40SBarry Smith 475c6c1daeSBarry Smith PetscLogEvent PETSC_LARGEST_EVENT = PETSC_EVENT; 485c6c1daeSBarry Smith 495c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 505c6c1daeSBarry Smith #include <petscmachineinfo.h> 515c6c1daeSBarry Smith #include <petscconfiginfo.h> 525c6c1daeSBarry Smith 535c6c1daeSBarry Smith /* used in the MPI_XXX() count macros in petsclog.h */ 545c6c1daeSBarry Smith 555c6c1daeSBarry Smith /* Action and object logging variables */ 560298fd71SBarry Smith Action *petsc_actions = NULL; 570298fd71SBarry Smith Object *petsc_objects = NULL; 585c6c1daeSBarry Smith PetscBool petsc_logActions = PETSC_FALSE; 595c6c1daeSBarry Smith PetscBool petsc_logObjects = PETSC_FALSE; 605c6c1daeSBarry Smith int petsc_numActions = 0, petsc_maxActions = 100; 615c6c1daeSBarry Smith int petsc_numObjects = 0, petsc_maxObjects = 100; 625c6c1daeSBarry Smith int petsc_numObjectsDestroyed = 0; 635c6c1daeSBarry Smith 645c6c1daeSBarry Smith /* Global counters */ 655c6c1daeSBarry Smith PetscLogDouble petsc_BaseTime = 0.0; 665c6c1daeSBarry Smith PetscLogDouble petsc_TotalFlops = 0.0; /* The number of flops */ 675c6c1daeSBarry Smith PetscLogDouble petsc_tmp_flops = 0.0; /* The incremental number of flops */ 685c6c1daeSBarry Smith PetscLogDouble petsc_send_ct = 0.0; /* The number of sends */ 695c6c1daeSBarry Smith PetscLogDouble petsc_recv_ct = 0.0; /* The number of receives */ 705c6c1daeSBarry Smith PetscLogDouble petsc_send_len = 0.0; /* The total length of all sent messages */ 715c6c1daeSBarry Smith PetscLogDouble petsc_recv_len = 0.0; /* The total length of all received messages */ 725c6c1daeSBarry Smith PetscLogDouble petsc_isend_ct = 0.0; /* The number of immediate sends */ 735c6c1daeSBarry Smith PetscLogDouble petsc_irecv_ct = 0.0; /* The number of immediate receives */ 745c6c1daeSBarry Smith PetscLogDouble petsc_isend_len = 0.0; /* The total length of all immediate send messages */ 755c6c1daeSBarry Smith PetscLogDouble petsc_irecv_len = 0.0; /* The total length of all immediate receive messages */ 765c6c1daeSBarry Smith PetscLogDouble petsc_wait_ct = 0.0; /* The number of waits */ 775c6c1daeSBarry Smith PetscLogDouble petsc_wait_any_ct = 0.0; /* The number of anywaits */ 785c6c1daeSBarry Smith PetscLogDouble petsc_wait_all_ct = 0.0; /* The number of waitalls */ 795c6c1daeSBarry Smith PetscLogDouble petsc_sum_of_waits_ct = 0.0; /* The total number of waits */ 805c6c1daeSBarry Smith PetscLogDouble petsc_allreduce_ct = 0.0; /* The number of reductions */ 815c6c1daeSBarry Smith PetscLogDouble petsc_gather_ct = 0.0; /* The number of gathers and gathervs */ 825c6c1daeSBarry Smith PetscLogDouble petsc_scatter_ct = 0.0; /* The number of scatters and scattervs */ 8320c24465SJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 84bec0b493Shannah_mairs PetscLogDouble petsc_ctog_ct = 0.0; /* The total number of CPU to GPU copies */ 85bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_ct = 0.0; /* The total number of GPU to CPU copies */ 86bec0b493Shannah_mairs PetscLogDouble petsc_ctog_sz = 0.0; /* The total size of CPU to GPU copies */ 87bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_sz = 0.0; /* The total size of GPU to CPU copies */ 8845c4b7c1SBarry Smith PetscLogDouble petsc_ctog_ct_scalar = 0.0; /* The total number of CPU to GPU copies */ 8945c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_ct_scalar = 0.0; /* The total number of GPU to CPU copies */ 9045c4b7c1SBarry Smith PetscLogDouble petsc_ctog_sz_scalar = 0.0; /* The total size of CPU to GPU copies */ 9145c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_sz_scalar = 0.0; /* The total size of GPU to CPU copies */ 92958c4211Shannah_mairs PetscLogDouble petsc_gflops = 0.0; /* The flops done on a GPU */ 93958c4211Shannah_mairs PetscLogDouble petsc_gtime = 0.0; /* The time spent on a GPU */ 94bec0b493Shannah_mairs #endif 955c6c1daeSBarry Smith 965c6c1daeSBarry Smith /* Logging functions */ 970298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL; 980298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL; 990298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 1000298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 1015c6c1daeSBarry Smith 1025c6c1daeSBarry Smith /* Tracing event logging variables */ 1030298fd71SBarry Smith FILE *petsc_tracefile = NULL; 1045c6c1daeSBarry Smith int petsc_tracelevel = 0; 1055c6c1daeSBarry Smith const char *petsc_traceblanks = " "; 1065c6c1daeSBarry Smith char petsc_tracespace[128] = " "; 1075c6c1daeSBarry Smith PetscLogDouble petsc_tracetime = 0.0; 108896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE; 1095c6c1daeSBarry Smith 11095c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogInitialize(void) 111fa2bb9feSLisandro Dalcin { 112fa2bb9feSLisandro Dalcin int stage; 113fa2bb9feSLisandro Dalcin PetscBool opt; 1145c6c1daeSBarry Smith 115fa2bb9feSLisandro Dalcin PetscFunctionBegin; 116fa2bb9feSLisandro Dalcin if (PetscLogInitializeCalled) PetscFunctionReturn(0); 117fa2bb9feSLisandro Dalcin PetscLogInitializeCalled = PETSC_TRUE; 1185c6c1daeSBarry Smith 1199566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL, "-log_exclude_actions", &opt)); 120fa2bb9feSLisandro Dalcin if (opt) petsc_logActions = PETSC_FALSE; 1219566063dSJacob Faibussowitsch PetscCall(PetscOptionsHasName(NULL,NULL, "-log_exclude_objects", &opt)); 122fa2bb9feSLisandro Dalcin if (opt) petsc_logObjects = PETSC_FALSE; 123fa2bb9feSLisandro Dalcin if (petsc_logActions) { 1249566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(petsc_maxActions, &petsc_actions)); 125fa2bb9feSLisandro Dalcin } 126fa2bb9feSLisandro Dalcin if (petsc_logObjects) { 1279566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(petsc_maxObjects, &petsc_objects)); 128fa2bb9feSLisandro Dalcin } 129fa2bb9feSLisandro Dalcin PetscLogPHC = PetscLogObjCreateDefault; 130fa2bb9feSLisandro Dalcin PetscLogPHD = PetscLogObjDestroyDefault; 131fa2bb9feSLisandro Dalcin /* Setup default logging structures */ 1329566063dSJacob Faibussowitsch PetscCall(PetscStageLogCreate(&petsc_stageLog)); 1339566063dSJacob Faibussowitsch PetscCall(PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage)); 1345c6c1daeSBarry Smith 135fa2bb9feSLisandro Dalcin /* All processors sync here for more consistent logging */ 1369566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(PETSC_COMM_WORLD)); 137fa2bb9feSLisandro Dalcin PetscTime(&petsc_BaseTime); 1389566063dSJacob Faibussowitsch PetscCall(PetscLogStagePush(stage)); 139fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 140fa2bb9feSLisandro Dalcin } 1415c6c1daeSBarry Smith 14295c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogFinalize(void) 1435c6c1daeSBarry Smith { 1445c6c1daeSBarry Smith PetscStageLog stageLog; 1455c6c1daeSBarry Smith 1465c6c1daeSBarry Smith PetscFunctionBegin; 1479566063dSJacob Faibussowitsch PetscCall(PetscFree(petsc_actions)); 1489566063dSJacob Faibussowitsch PetscCall(PetscFree(petsc_objects)); 1499566063dSJacob Faibussowitsch PetscCall(PetscLogNestedEnd()); 1509566063dSJacob Faibussowitsch PetscCall(PetscLogSet(NULL, NULL)); 1515c6c1daeSBarry Smith 1525c6c1daeSBarry Smith /* Resetting phase */ 1539566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 1549566063dSJacob Faibussowitsch PetscCall(PetscStageLogDestroy(stageLog)); 155a297a907SKarl Rupp 1565c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1575c6c1daeSBarry Smith petsc_numActions = 0; 1585c6c1daeSBarry Smith petsc_numObjects = 0; 1595c6c1daeSBarry Smith petsc_numObjectsDestroyed = 0; 1605c6c1daeSBarry Smith petsc_maxActions = 100; 1615c6c1daeSBarry Smith petsc_maxObjects = 100; 1620298fd71SBarry Smith petsc_actions = NULL; 1630298fd71SBarry Smith petsc_objects = NULL; 1645c6c1daeSBarry Smith petsc_logActions = PETSC_FALSE; 1655c6c1daeSBarry Smith petsc_logObjects = PETSC_FALSE; 1665c6c1daeSBarry Smith petsc_BaseTime = 0.0; 1675c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1685c6c1daeSBarry Smith petsc_tmp_flops = 0.0; 1695c6c1daeSBarry Smith petsc_send_ct = 0.0; 1705c6c1daeSBarry Smith petsc_recv_ct = 0.0; 1715c6c1daeSBarry Smith petsc_send_len = 0.0; 1725c6c1daeSBarry Smith petsc_recv_len = 0.0; 1735c6c1daeSBarry Smith petsc_isend_ct = 0.0; 1745c6c1daeSBarry Smith petsc_irecv_ct = 0.0; 1755c6c1daeSBarry Smith petsc_isend_len = 0.0; 1765c6c1daeSBarry Smith petsc_irecv_len = 0.0; 1775c6c1daeSBarry Smith petsc_wait_ct = 0.0; 1785c6c1daeSBarry Smith petsc_wait_any_ct = 0.0; 1795c6c1daeSBarry Smith petsc_wait_all_ct = 0.0; 1805c6c1daeSBarry Smith petsc_sum_of_waits_ct = 0.0; 1815c6c1daeSBarry Smith petsc_allreduce_ct = 0.0; 1825c6c1daeSBarry Smith petsc_gather_ct = 0.0; 1835c6c1daeSBarry Smith petsc_scatter_ct = 0.0; 184d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 185bec0b493Shannah_mairs petsc_ctog_ct = 0.0; 186bec0b493Shannah_mairs petsc_gtoc_ct = 0.0; 187bec0b493Shannah_mairs petsc_ctog_sz = 0.0; 188bec0b493Shannah_mairs petsc_gtoc_sz = 0.0; 189958c4211Shannah_mairs petsc_gflops = 0.0; 190958c4211Shannah_mairs petsc_gtime = 0.0; 191bec0b493Shannah_mairs #endif 1925c6c1daeSBarry Smith PETSC_LARGEST_EVENT = PETSC_EVENT; 1930298fd71SBarry Smith PetscLogPHC = NULL; 1940298fd71SBarry Smith PetscLogPHD = NULL; 1950298fd71SBarry Smith petsc_tracefile = NULL; 1965c6c1daeSBarry Smith petsc_tracelevel = 0; 1975c6c1daeSBarry Smith petsc_traceblanks = " "; 1985c6c1daeSBarry Smith petsc_tracespace[0] = ' '; petsc_tracespace[1] = 0; 1995c6c1daeSBarry Smith petsc_tracetime = 0.0; 2005c6c1daeSBarry Smith PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 2015c6c1daeSBarry Smith PETSC_OBJECT_CLASSID = 0; 20202c9f0b5SLisandro Dalcin petsc_stageLog = NULL; 203896238b9SBarry Smith PetscLogInitializeCalled = PETSC_FALSE; 2045c6c1daeSBarry Smith PetscFunctionReturn(0); 2055c6c1daeSBarry Smith } 2065c6c1daeSBarry Smith 2075c6c1daeSBarry Smith /*@C 2085c6c1daeSBarry Smith PetscLogSet - Sets the logging functions called at the beginning and ending of every event. 2095c6c1daeSBarry Smith 2105c6c1daeSBarry Smith Not Collective 2115c6c1daeSBarry Smith 2125c6c1daeSBarry Smith Input Parameters: 2135c6c1daeSBarry Smith + b - The function called at beginning of event 2145c6c1daeSBarry Smith - e - The function called at end of event 2155c6c1daeSBarry Smith 2165c6c1daeSBarry Smith Level: developer 2175c6c1daeSBarry Smith 218db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogTraceBegin()` 2195c6c1daeSBarry Smith @*/ 2205c6c1daeSBarry Smith PetscErrorCode PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), 2215c6c1daeSBarry Smith PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject)) 2225c6c1daeSBarry Smith { 2235c6c1daeSBarry Smith PetscFunctionBegin; 2245c6c1daeSBarry Smith PetscLogPLB = b; 2255c6c1daeSBarry Smith PetscLogPLE = e; 2265c6c1daeSBarry Smith PetscFunctionReturn(0); 2275c6c1daeSBarry Smith } 2285c6c1daeSBarry Smith 2295c6c1daeSBarry Smith /*@C 2304dd65854SConnor Ward PetscLogIsActive - Check if logging is currently in progress. 2314dd65854SConnor Ward 2324dd65854SConnor Ward Not Collective 2334dd65854SConnor Ward 2344dd65854SConnor Ward Output Parameter: 2354dd65854SConnor Ward . isActive - PETSC_TRUE if logging is in progress, PETSC_FALSE otherwise 2364dd65854SConnor Ward 2374dd65854SConnor Ward Level: beginner 2384dd65854SConnor Ward 239db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogSet()` 2404dd65854SConnor Ward @*/ 2414dd65854SConnor Ward PetscErrorCode PetscLogIsActive(PetscBool *isActive) 2424dd65854SConnor Ward { 2434dd65854SConnor Ward PetscFunctionBegin; 2444dd65854SConnor Ward *isActive = (PetscLogPLB && PetscLogPLE) ? PETSC_TRUE : PETSC_FALSE; 2454dd65854SConnor Ward PetscFunctionReturn(0); 2464dd65854SConnor Ward } 2474dd65854SConnor Ward 2484dd65854SConnor Ward /*@C 249bb1d7374SBarry Smith PetscLogDefaultBegin - Turns on logging of objects and events. This logs flop 2505c6c1daeSBarry Smith rates and object creation and should not slow programs down too much. 2515c6c1daeSBarry Smith This routine may be called more than once. 2525c6c1daeSBarry Smith 2535c6c1daeSBarry Smith Logically Collective over PETSC_COMM_WORLD 2545c6c1daeSBarry Smith 2555c6c1daeSBarry Smith Options Database Keys: 256a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the 257a2553e36SBarry Smith screen (for code configured with --with-log=1 (which is the default)) 2585c6c1daeSBarry Smith 2595c6c1daeSBarry Smith Usage: 2605c6c1daeSBarry Smith .vb 2615c6c1daeSBarry Smith PetscInitialize(...); 262bb1d7374SBarry Smith PetscLogDefaultBegin(); 2635c6c1daeSBarry Smith ... code ... 2645c6c1daeSBarry Smith PetscLogView(viewer); or PetscLogDump(); 2655c6c1daeSBarry Smith PetscFinalize(); 2665c6c1daeSBarry Smith .ve 2675c6c1daeSBarry Smith 2685c6c1daeSBarry Smith Notes: 2695c6c1daeSBarry Smith PetscLogView(viewer) or PetscLogDump() actually cause the printing of 2705c6c1daeSBarry Smith the logging information. 2715c6c1daeSBarry Smith 2725c6c1daeSBarry Smith Level: advanced 2735c6c1daeSBarry Smith 274db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogView()`, `PetscLogTraceBegin()` 2755c6c1daeSBarry Smith @*/ 276bb1d7374SBarry Smith PetscErrorCode PetscLogDefaultBegin(void) 2775c6c1daeSBarry Smith { 2785c6c1daeSBarry Smith PetscFunctionBegin; 2799566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault)); 2805c6c1daeSBarry Smith PetscFunctionReturn(0); 2815c6c1daeSBarry Smith } 2825c6c1daeSBarry Smith 2835c6c1daeSBarry Smith /*@C 2845c6c1daeSBarry Smith PetscLogAllBegin - Turns on extensive logging of objects and events. Logs 2855c6c1daeSBarry Smith all events. This creates large log files and slows the program down. 2865c6c1daeSBarry Smith 2875c6c1daeSBarry Smith Logically Collective on PETSC_COMM_WORLD 2885c6c1daeSBarry Smith 2895c6c1daeSBarry Smith Options Database Keys: 290a2553e36SBarry Smith . -log_all - Prints extensive log information 2915c6c1daeSBarry Smith 2925c6c1daeSBarry Smith Usage: 2935c6c1daeSBarry Smith .vb 2945c6c1daeSBarry Smith PetscInitialize(...); 2955c6c1daeSBarry Smith PetscLogAllBegin(); 2965c6c1daeSBarry Smith ... code ... 2975c6c1daeSBarry Smith PetscLogDump(filename); 2985c6c1daeSBarry Smith PetscFinalize(); 2995c6c1daeSBarry Smith .ve 3005c6c1daeSBarry Smith 3015c6c1daeSBarry Smith Notes: 302bb1d7374SBarry Smith A related routine is PetscLogDefaultBegin() (with the options key -log), which is 3035c6c1daeSBarry Smith intended for production runs since it logs only flop rates and object 3045c6c1daeSBarry Smith creation (and shouldn't significantly slow the programs). 3055c6c1daeSBarry Smith 3065c6c1daeSBarry Smith Level: advanced 3075c6c1daeSBarry Smith 308db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogTraceBegin()` 3095c6c1daeSBarry Smith @*/ 3105c6c1daeSBarry Smith PetscErrorCode PetscLogAllBegin(void) 3115c6c1daeSBarry Smith { 3125c6c1daeSBarry Smith PetscFunctionBegin; 3139566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete)); 3145c6c1daeSBarry Smith PetscFunctionReturn(0); 3155c6c1daeSBarry Smith } 3165c6c1daeSBarry Smith 317956f8c0dSBarry Smith /*@C 3185c6c1daeSBarry Smith PetscLogTraceBegin - Activates trace logging. Every time a PETSc event 3195c6c1daeSBarry Smith begins or ends, the event name is printed. 3205c6c1daeSBarry Smith 3215c6c1daeSBarry Smith Logically Collective on PETSC_COMM_WORLD 3225c6c1daeSBarry Smith 3235c6c1daeSBarry Smith Input Parameter: 3245c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout) 3255c6c1daeSBarry Smith 3265c6c1daeSBarry Smith Options Database Key: 3275c6c1daeSBarry Smith . -log_trace [filename] - Activates PetscLogTraceBegin() 3285c6c1daeSBarry Smith 3295c6c1daeSBarry Smith Notes: 3305c6c1daeSBarry Smith PetscLogTraceBegin() prints the processor number, the execution time (sec), 3315c6c1daeSBarry Smith then "Event begin:" or "Event end:" followed by the event name. 3325c6c1daeSBarry Smith 3335c6c1daeSBarry Smith PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful 3345c6c1daeSBarry Smith to determine where a program is hanging without running in the 3355c6c1daeSBarry Smith debugger. Can be used in conjunction with the -info option. 3365c6c1daeSBarry Smith 3375c6c1daeSBarry Smith Level: intermediate 3385c6c1daeSBarry Smith 339db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogView()`, `PetscLogDefaultBegin()` 3405c6c1daeSBarry Smith @*/ 3415c6c1daeSBarry Smith PetscErrorCode PetscLogTraceBegin(FILE *file) 3425c6c1daeSBarry Smith { 3435c6c1daeSBarry Smith PetscFunctionBegin; 3445c6c1daeSBarry Smith petsc_tracefile = file; 345a297a907SKarl Rupp 3469566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace)); 3475c6c1daeSBarry Smith PetscFunctionReturn(0); 3485c6c1daeSBarry Smith } 3495c6c1daeSBarry Smith 3505c6c1daeSBarry Smith /*@ 3515c6c1daeSBarry Smith PetscLogActions - Determines whether actions are logged for the graphical viewer. 3525c6c1daeSBarry Smith 3535c6c1daeSBarry Smith Not Collective 3545c6c1daeSBarry Smith 3555c6c1daeSBarry Smith Input Parameter: 3565c6c1daeSBarry Smith . flag - PETSC_TRUE if actions are to be logged 3575c6c1daeSBarry Smith 3585c6c1daeSBarry Smith Level: intermediate 3595c6c1daeSBarry Smith 3605c6c1daeSBarry Smith Note: Logging of actions continues to consume more memory as the program 3615c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3625c6c1daeSBarry Smith 3635c6c1daeSBarry Smith Options Database Keys: 3645c6c1daeSBarry Smith . -log_exclude_actions - Turns off actions logging 3655c6c1daeSBarry Smith 366db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()` 3675c6c1daeSBarry Smith @*/ 3685c6c1daeSBarry Smith PetscErrorCode PetscLogActions(PetscBool flag) 3695c6c1daeSBarry Smith { 3705c6c1daeSBarry Smith PetscFunctionBegin; 3715c6c1daeSBarry Smith petsc_logActions = flag; 3725c6c1daeSBarry Smith PetscFunctionReturn(0); 3735c6c1daeSBarry Smith } 3745c6c1daeSBarry Smith 3755c6c1daeSBarry Smith /*@ 3765c6c1daeSBarry Smith PetscLogObjects - Determines whether objects are logged for the graphical viewer. 3775c6c1daeSBarry Smith 3785c6c1daeSBarry Smith Not Collective 3795c6c1daeSBarry Smith 3805c6c1daeSBarry Smith Input Parameter: 3815c6c1daeSBarry Smith . flag - PETSC_TRUE if objects are to be logged 3825c6c1daeSBarry Smith 3835c6c1daeSBarry Smith Level: intermediate 3845c6c1daeSBarry Smith 3855c6c1daeSBarry Smith Note: Logging of objects continues to consume more memory as the program 3865c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3875c6c1daeSBarry Smith 3885c6c1daeSBarry Smith Options Database Keys: 3895c6c1daeSBarry Smith . -log_exclude_objects - Turns off objects logging 3905c6c1daeSBarry Smith 391db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()` 3925c6c1daeSBarry Smith @*/ 3935c6c1daeSBarry Smith PetscErrorCode PetscLogObjects(PetscBool flag) 3945c6c1daeSBarry Smith { 3955c6c1daeSBarry Smith PetscFunctionBegin; 3965c6c1daeSBarry Smith petsc_logObjects = flag; 3975c6c1daeSBarry Smith PetscFunctionReturn(0); 3985c6c1daeSBarry Smith } 3995c6c1daeSBarry Smith 4005c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/ 4015c6c1daeSBarry Smith /*@C 40274c0405dSRichard Tran Mills PetscLogStageRegister - Attaches a character string name to a logging stage. 4035c6c1daeSBarry Smith 4045c6c1daeSBarry Smith Not Collective 4055c6c1daeSBarry Smith 4065c6c1daeSBarry Smith Input Parameter: 4075c6c1daeSBarry Smith . sname - The name to associate with that stage 4085c6c1daeSBarry Smith 4095c6c1daeSBarry Smith Output Parameter: 4105c6c1daeSBarry Smith . stage - The stage number 4115c6c1daeSBarry Smith 4125c6c1daeSBarry Smith Level: intermediate 4135c6c1daeSBarry Smith 414db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()` 4155c6c1daeSBarry Smith @*/ 4165c6c1daeSBarry Smith PetscErrorCode PetscLogStageRegister(const char sname[],PetscLogStage *stage) 4175c6c1daeSBarry Smith { 4185c6c1daeSBarry Smith PetscStageLog stageLog; 4195c6c1daeSBarry Smith PetscLogEvent event; 4205c6c1daeSBarry Smith 4215c6c1daeSBarry Smith PetscFunctionBegin; 4229566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 4239566063dSJacob Faibussowitsch PetscCall(PetscStageLogRegister(stageLog, sname, stage)); 4245c6c1daeSBarry Smith /* Copy events already changed in the main stage, this sucks */ 4259566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents)); 4265c6c1daeSBarry Smith for (event = 0; event < stageLog->eventLog->numEvents; event++) { 4279566063dSJacob Faibussowitsch PetscCall(PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event],&stageLog->stageInfo[*stage].eventLog->eventInfo[event])); 4285c6c1daeSBarry Smith } 4299566063dSJacob Faibussowitsch PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses)); 4305c6c1daeSBarry Smith PetscFunctionReturn(0); 4315c6c1daeSBarry Smith } 4325c6c1daeSBarry Smith 4335c6c1daeSBarry Smith /*@C 4345c6c1daeSBarry Smith PetscLogStagePush - This function pushes a stage on the stack. 4355c6c1daeSBarry Smith 4365c6c1daeSBarry Smith Not Collective 4375c6c1daeSBarry Smith 4385c6c1daeSBarry Smith Input Parameter: 4395c6c1daeSBarry Smith . stage - The stage on which to log 4405c6c1daeSBarry Smith 4415c6c1daeSBarry Smith Usage: 4425c6c1daeSBarry Smith If the option -log_sumary is used to run the program containing the 4435c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4445c6c1daeSBarry Smith PetscFinalize(). 4455c6c1daeSBarry Smith .vb 4465c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4475c6c1daeSBarry Smith [stage 0 of code] 4485c6c1daeSBarry Smith PetscLogStagePush(1); 4495c6c1daeSBarry Smith [stage 1 of code] 4505c6c1daeSBarry Smith PetscLogStagePop(); 4515c6c1daeSBarry Smith PetscBarrier(...); 4525c6c1daeSBarry Smith [more stage 0 of code] 4535c6c1daeSBarry Smith PetscFinalize(); 4545c6c1daeSBarry Smith .ve 4555c6c1daeSBarry Smith 4565c6c1daeSBarry Smith Notes: 4575c6c1daeSBarry Smith Use PetscLogStageRegister() to register a stage. 4585c6c1daeSBarry Smith 4595c6c1daeSBarry Smith Level: intermediate 4605c6c1daeSBarry Smith 461db781477SPatrick Sanan .seealso: `PetscLogStagePop()`, `PetscLogStageRegister()`, `PetscBarrier()` 4625c6c1daeSBarry Smith @*/ 4635c6c1daeSBarry Smith PetscErrorCode PetscLogStagePush(PetscLogStage stage) 4645c6c1daeSBarry Smith { 4655c6c1daeSBarry Smith PetscStageLog stageLog; 4665c6c1daeSBarry Smith 4675c6c1daeSBarry Smith PetscFunctionBegin; 4689566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 4699566063dSJacob Faibussowitsch PetscCall(PetscStageLogPush(stageLog, stage)); 4705c6c1daeSBarry Smith PetscFunctionReturn(0); 4715c6c1daeSBarry Smith } 4725c6c1daeSBarry Smith 4735c6c1daeSBarry Smith /*@C 4745c6c1daeSBarry Smith PetscLogStagePop - This function pops a stage from the stack. 4755c6c1daeSBarry Smith 4765c6c1daeSBarry Smith Not Collective 4775c6c1daeSBarry Smith 4785c6c1daeSBarry Smith Usage: 4795c6c1daeSBarry Smith If the option -log_sumary is used to run the program containing the 4805c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4815c6c1daeSBarry Smith PetscFinalize(). 4825c6c1daeSBarry Smith .vb 4835c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4845c6c1daeSBarry Smith [stage 0 of code] 4855c6c1daeSBarry Smith PetscLogStagePush(1); 4865c6c1daeSBarry Smith [stage 1 of code] 4875c6c1daeSBarry Smith PetscLogStagePop(); 4885c6c1daeSBarry Smith PetscBarrier(...); 4895c6c1daeSBarry Smith [more stage 0 of code] 4905c6c1daeSBarry Smith PetscFinalize(); 4915c6c1daeSBarry Smith .ve 4925c6c1daeSBarry Smith 4935c6c1daeSBarry Smith Notes: 4945c6c1daeSBarry Smith Use PetscLogStageRegister() to register a stage. 4955c6c1daeSBarry Smith 4965c6c1daeSBarry Smith Level: intermediate 4975c6c1daeSBarry Smith 498db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStageRegister()`, `PetscBarrier()` 4995c6c1daeSBarry Smith @*/ 5005c6c1daeSBarry Smith PetscErrorCode PetscLogStagePop(void) 5015c6c1daeSBarry Smith { 5025c6c1daeSBarry Smith PetscStageLog stageLog; 5035c6c1daeSBarry Smith 5045c6c1daeSBarry Smith PetscFunctionBegin; 5059566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5069566063dSJacob Faibussowitsch PetscCall(PetscStageLogPop(stageLog)); 5075c6c1daeSBarry Smith PetscFunctionReturn(0); 5085c6c1daeSBarry Smith } 5095c6c1daeSBarry Smith 5105c6c1daeSBarry Smith /*@ 5115c6c1daeSBarry Smith PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 5125c6c1daeSBarry Smith 5135c6c1daeSBarry Smith Not Collective 5145c6c1daeSBarry Smith 5155c6c1daeSBarry Smith Input Parameters: 5165c6c1daeSBarry Smith + stage - The stage 5175c6c1daeSBarry Smith - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 5185c6c1daeSBarry Smith 5195c6c1daeSBarry Smith Level: intermediate 5205c6c1daeSBarry Smith 521db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 5225c6c1daeSBarry Smith @*/ 5235c6c1daeSBarry Smith PetscErrorCode PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive) 5245c6c1daeSBarry Smith { 5255c6c1daeSBarry Smith PetscStageLog stageLog; 5265c6c1daeSBarry Smith 5275c6c1daeSBarry Smith PetscFunctionBegin; 5289566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5299566063dSJacob Faibussowitsch PetscCall(PetscStageLogSetActive(stageLog, stage, isActive)); 5305c6c1daeSBarry Smith PetscFunctionReturn(0); 5315c6c1daeSBarry Smith } 5325c6c1daeSBarry Smith 5335c6c1daeSBarry Smith /*@ 5345c6c1daeSBarry Smith PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 5355c6c1daeSBarry Smith 5365c6c1daeSBarry Smith Not Collective 5375c6c1daeSBarry Smith 5385c6c1daeSBarry Smith Input Parameter: 5395c6c1daeSBarry Smith . stage - The stage 5405c6c1daeSBarry Smith 5415c6c1daeSBarry Smith Output Parameter: 5425c6c1daeSBarry Smith . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 5435c6c1daeSBarry Smith 5445c6c1daeSBarry Smith Level: intermediate 5455c6c1daeSBarry Smith 546db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 5475c6c1daeSBarry Smith @*/ 5485c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetActive(PetscLogStage stage, PetscBool *isActive) 5495c6c1daeSBarry Smith { 5505c6c1daeSBarry Smith PetscStageLog stageLog; 5515c6c1daeSBarry Smith 5525c6c1daeSBarry Smith PetscFunctionBegin; 5539566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5549566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetActive(stageLog, stage, isActive)); 5555c6c1daeSBarry Smith PetscFunctionReturn(0); 5565c6c1daeSBarry Smith } 5575c6c1daeSBarry Smith 5585c6c1daeSBarry Smith /*@ 5595c6c1daeSBarry Smith PetscLogStageSetVisible - Determines stage visibility in PetscLogView() 5605c6c1daeSBarry Smith 5615c6c1daeSBarry Smith Not Collective 5625c6c1daeSBarry Smith 5635c6c1daeSBarry Smith Input Parameters: 5645c6c1daeSBarry Smith + stage - The stage 5655c6c1daeSBarry Smith - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 5665c6c1daeSBarry Smith 5675c6c1daeSBarry Smith Level: intermediate 5685c6c1daeSBarry Smith 569db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogView()` 5705c6c1daeSBarry Smith @*/ 5715c6c1daeSBarry Smith PetscErrorCode PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible) 5725c6c1daeSBarry Smith { 5735c6c1daeSBarry Smith PetscStageLog stageLog; 5745c6c1daeSBarry Smith 5755c6c1daeSBarry Smith PetscFunctionBegin; 5769566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 5779566063dSJacob Faibussowitsch PetscCall(PetscStageLogSetVisible(stageLog, stage, isVisible)); 5785c6c1daeSBarry Smith PetscFunctionReturn(0); 5795c6c1daeSBarry Smith } 5805c6c1daeSBarry Smith 5815c6c1daeSBarry Smith /*@ 5825c6c1daeSBarry Smith PetscLogStageGetVisible - Returns stage visibility in PetscLogView() 5835c6c1daeSBarry Smith 5845c6c1daeSBarry Smith Not Collective 5855c6c1daeSBarry Smith 5865c6c1daeSBarry Smith Input Parameter: 5875c6c1daeSBarry Smith . stage - The stage 5885c6c1daeSBarry Smith 5895c6c1daeSBarry Smith Output Parameter: 5905c6c1daeSBarry Smith . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 5915c6c1daeSBarry Smith 5925c6c1daeSBarry Smith Level: intermediate 5935c6c1daeSBarry Smith 594db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogView()` 5955c6c1daeSBarry Smith @*/ 5965c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetVisible(PetscLogStage stage, PetscBool *isVisible) 5975c6c1daeSBarry Smith { 5985c6c1daeSBarry Smith PetscStageLog stageLog; 5995c6c1daeSBarry Smith 6005c6c1daeSBarry Smith PetscFunctionBegin; 6019566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 6029566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetVisible(stageLog, stage, isVisible)); 6035c6c1daeSBarry Smith PetscFunctionReturn(0); 6045c6c1daeSBarry Smith } 6055c6c1daeSBarry Smith 6065c6c1daeSBarry Smith /*@C 6075c6c1daeSBarry Smith PetscLogStageGetId - Returns the stage id when given the stage name. 6085c6c1daeSBarry Smith 6095c6c1daeSBarry Smith Not Collective 6105c6c1daeSBarry Smith 6115c6c1daeSBarry Smith Input Parameter: 6125c6c1daeSBarry Smith . name - The stage name 6135c6c1daeSBarry Smith 6145c6c1daeSBarry Smith Output Parameter: 6155a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists 6165c6c1daeSBarry Smith 6175c6c1daeSBarry Smith Level: intermediate 6185c6c1daeSBarry Smith 619db781477SPatrick Sanan .seealso: `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 6205c6c1daeSBarry Smith @*/ 6215c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetId(const char name[], PetscLogStage *stage) 6225c6c1daeSBarry Smith { 6235c6c1daeSBarry Smith PetscStageLog stageLog; 6245c6c1daeSBarry Smith 6255c6c1daeSBarry Smith PetscFunctionBegin; 6269566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 6279566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetStage(stageLog, name, stage)); 6285c6c1daeSBarry Smith PetscFunctionReturn(0); 6295c6c1daeSBarry Smith } 6305c6c1daeSBarry Smith 6315c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/ 6325c6c1daeSBarry Smith /*@C 6335c6c1daeSBarry Smith PetscLogEventRegister - Registers an event name for logging operations in an application code. 6345c6c1daeSBarry Smith 6355c6c1daeSBarry Smith Not Collective 6365c6c1daeSBarry Smith 637d8d19677SJose E. Roman Input Parameters: 6385c6c1daeSBarry Smith + name - The name associated with the event 6395c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with 6405c6c1daeSBarry Smith PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones 6415c6c1daeSBarry Smith are only available in C code 6425c6c1daeSBarry Smith 6435c6c1daeSBarry Smith Output Parameter: 6445c6c1daeSBarry Smith . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd(). 6455c6c1daeSBarry Smith 6465c6c1daeSBarry Smith Example of Usage: 6475c6c1daeSBarry Smith .vb 6485c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 6495c6c1daeSBarry Smith PetscClassId classid; 6505c6c1daeSBarry Smith PetscLogDouble user_event_flops; 6515c6c1daeSBarry Smith PetscClassIdRegister("class name",&classid); 6525c6c1daeSBarry Smith PetscLogEventRegister("User event name",classid,&USER_EVENT); 6535c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 6545c6c1daeSBarry Smith [code segment to monitor] 6555c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 6565c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 6575c6c1daeSBarry Smith .ve 6585c6c1daeSBarry Smith 6595c6c1daeSBarry Smith Notes: 6605c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 661a2553e36SBarry Smith configured with --with-log (which is the default) and 662a2553e36SBarry Smith -log_view or -log_all is specified. PetscLogEventRegister() is 6635c6c1daeSBarry Smith intended for logging user events to supplement this PETSc 6645c6c1daeSBarry Smith information. 6655c6c1daeSBarry Smith 666495fc317SBarry Smith PETSc can gather data for use with the utilities Jumpshot 6675c6c1daeSBarry Smith (part of the MPICH distribution). If PETSc has been compiled 6685c6c1daeSBarry Smith with flag -DPETSC_HAVE_MPE (MPE is an additional utility within 6695c6c1daeSBarry Smith MPICH), the user can employ another command line option, -log_mpe, 6705c6c1daeSBarry Smith to create a logfile, "mpe.log", which can be visualized 671495fc317SBarry Smith Jumpshot. 6725c6c1daeSBarry Smith 6735c6c1daeSBarry Smith The classid is associated with each event so that classes of events 6745c6c1daeSBarry Smith can be disabled simultaneously, such as all matrix events. The user 6755c6c1daeSBarry Smith can either use an existing classid, such as MAT_CLASSID, or create 6765c6c1daeSBarry Smith their own as shown in the example. 6775c6c1daeSBarry Smith 678c5deb1d5SJed Brown If an existing event with the same name exists, its event handle is 679c5deb1d5SJed Brown returned instead of creating a new event. 680c5deb1d5SJed Brown 6815c6c1daeSBarry Smith Level: intermediate 6825c6c1daeSBarry Smith 683db781477SPatrick Sanan .seealso: `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogFlops()`, 684db781477SPatrick Sanan `PetscLogEventActivate()`, `PetscLogEventDeactivate()`, `PetscClassIdRegister()` 6855c6c1daeSBarry Smith @*/ 6865c6c1daeSBarry Smith PetscErrorCode PetscLogEventRegister(const char name[],PetscClassId classid,PetscLogEvent *event) 6875c6c1daeSBarry Smith { 6885c6c1daeSBarry Smith PetscStageLog stageLog; 6895c6c1daeSBarry Smith int stage; 6905c6c1daeSBarry Smith 6915c6c1daeSBarry Smith PetscFunctionBegin; 6925c6c1daeSBarry Smith *event = PETSC_DECIDE; 6939566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 6949566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, event)); 695c5deb1d5SJed Brown if (*event > 0) PetscFunctionReturn(0); 6969566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogRegister(stageLog->eventLog, name, classid, event)); 6975c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 6989566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents)); 6999566063dSJacob Faibussowitsch PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses)); 7005c6c1daeSBarry Smith } 7015c6c1daeSBarry Smith PetscFunctionReturn(0); 7025c6c1daeSBarry Smith } 7035c6c1daeSBarry Smith 7045c6c1daeSBarry Smith /*@ 705217044c2SLisandro Dalcin PetscLogEventSetCollective - Indicates that a particular event is collective. 706217044c2SLisandro Dalcin 707217044c2SLisandro Dalcin Not Collective 708217044c2SLisandro Dalcin 709d8d19677SJose E. Roman Input Parameters: 710217044c2SLisandro Dalcin + event - The event id 711217044c2SLisandro Dalcin - collective - Bolean flag indicating whether a particular event is collective 712217044c2SLisandro Dalcin 713217044c2SLisandro Dalcin Note: 714217044c2SLisandro Dalcin New events returned from PetscLogEventRegister() are collective by default. 715217044c2SLisandro Dalcin 716217044c2SLisandro Dalcin Level: developer 717217044c2SLisandro Dalcin 718db781477SPatrick Sanan .seealso: `PetscLogEventRegister()` 719217044c2SLisandro Dalcin @*/ 720217044c2SLisandro Dalcin PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event,PetscBool collective) 721217044c2SLisandro Dalcin { 722217044c2SLisandro Dalcin PetscStageLog stageLog; 723217044c2SLisandro Dalcin PetscEventRegLog eventRegLog; 724217044c2SLisandro Dalcin 725217044c2SLisandro Dalcin PetscFunctionBegin; 7269566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 7279566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetEventRegLog(stageLog,&eventRegLog)); 728cc73adaaSBarry Smith PetscCheck(event >= 0 && event <= eventRegLog->numEvents,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Invalid event id"); 729217044c2SLisandro Dalcin eventRegLog->eventInfo[event].collective = collective; 730217044c2SLisandro Dalcin PetscFunctionReturn(0); 731217044c2SLisandro Dalcin } 732217044c2SLisandro Dalcin 733217044c2SLisandro Dalcin /*@ 734fa2bb9feSLisandro Dalcin PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage. 735fa2bb9feSLisandro Dalcin 736fa2bb9feSLisandro Dalcin Not Collective 737fa2bb9feSLisandro Dalcin 738fa2bb9feSLisandro Dalcin Input Parameter: 739fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc. 740fa2bb9feSLisandro Dalcin 741fa2bb9feSLisandro Dalcin Level: developer 742fa2bb9feSLisandro Dalcin 743c2e3fba1SPatrick Sanan .seealso: `PetscLogEventActivateClass()`, `PetscLogEventDeactivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 744fa2bb9feSLisandro Dalcin @*/ 745fa2bb9feSLisandro Dalcin PetscErrorCode PetscLogEventIncludeClass(PetscClassId classid) 746fa2bb9feSLisandro Dalcin { 747fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 748fa2bb9feSLisandro Dalcin int stage; 749fa2bb9feSLisandro Dalcin 750fa2bb9feSLisandro Dalcin PetscFunctionBegin; 7519566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 752fa2bb9feSLisandro Dalcin for (stage = 0; stage < stageLog->numStages; stage++) { 7539566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 754fa2bb9feSLisandro Dalcin } 755fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 756fa2bb9feSLisandro Dalcin } 757fa2bb9feSLisandro Dalcin 758fa2bb9feSLisandro Dalcin /*@ 759fa2bb9feSLisandro Dalcin PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage. 760fa2bb9feSLisandro Dalcin 761fa2bb9feSLisandro Dalcin Not Collective 762fa2bb9feSLisandro Dalcin 763fa2bb9feSLisandro Dalcin Input Parameter: 764fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc. 765fa2bb9feSLisandro Dalcin 766fa2bb9feSLisandro Dalcin Level: developer 767fa2bb9feSLisandro Dalcin 768c2e3fba1SPatrick Sanan .seealso: `PetscLogEventDeactivateClass()`, `PetscLogEventActivateClass()`, `PetscLogEventDeactivate()`, `PetscLogEventActivate()` 769fa2bb9feSLisandro Dalcin @*/ 770fa2bb9feSLisandro Dalcin PetscErrorCode PetscLogEventExcludeClass(PetscClassId classid) 771fa2bb9feSLisandro Dalcin { 772fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 773fa2bb9feSLisandro Dalcin int stage; 774fa2bb9feSLisandro Dalcin 775fa2bb9feSLisandro Dalcin PetscFunctionBegin; 7769566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 777fa2bb9feSLisandro Dalcin for (stage = 0; stage < stageLog->numStages; stage++) { 7789566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 779fa2bb9feSLisandro Dalcin } 780fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 781fa2bb9feSLisandro Dalcin } 782fa2bb9feSLisandro Dalcin 783fa2bb9feSLisandro Dalcin /*@ 7845c6c1daeSBarry Smith PetscLogEventActivate - Indicates that a particular event should be logged. 7855c6c1daeSBarry Smith 7865c6c1daeSBarry Smith Not Collective 7875c6c1daeSBarry Smith 7885c6c1daeSBarry Smith Input Parameter: 7895c6c1daeSBarry Smith . event - The event id 7905c6c1daeSBarry Smith 7915c6c1daeSBarry Smith Usage: 7925c6c1daeSBarry Smith .vb 7935c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 7945c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 7955c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 7965c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 7975c6c1daeSBarry Smith .ve 7985c6c1daeSBarry Smith 7995c6c1daeSBarry Smith Note: 8005c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in include/petsclog.h) 8015c6c1daeSBarry Smith or an event number obtained with PetscLogEventRegister(). 8025c6c1daeSBarry Smith 8035c6c1daeSBarry Smith Level: advanced 8045c6c1daeSBarry Smith 805db781477SPatrick Sanan .seealso: `PlogEventDeactivate()`, `PlogEventDeactivatePush()`, `PetscLogEventDeactivatePop()` 8065c6c1daeSBarry Smith @*/ 8075c6c1daeSBarry Smith PetscErrorCode PetscLogEventActivate(PetscLogEvent event) 8085c6c1daeSBarry Smith { 8095c6c1daeSBarry Smith PetscStageLog stageLog; 8105c6c1daeSBarry Smith int stage; 8115c6c1daeSBarry Smith 8125c6c1daeSBarry Smith PetscFunctionBegin; 8139566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 8149566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 8159566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event)); 8165c6c1daeSBarry Smith PetscFunctionReturn(0); 8175c6c1daeSBarry Smith } 8185c6c1daeSBarry Smith 8195c6c1daeSBarry Smith /*@ 8205c6c1daeSBarry Smith PetscLogEventDeactivate - Indicates that a particular event should not be logged. 8215c6c1daeSBarry Smith 8225c6c1daeSBarry Smith Not Collective 8235c6c1daeSBarry Smith 8245c6c1daeSBarry Smith Input Parameter: 8255c6c1daeSBarry Smith . event - The event id 8265c6c1daeSBarry Smith 8275c6c1daeSBarry Smith Usage: 8285c6c1daeSBarry Smith .vb 8295c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 8305c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 8315c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 8325c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 8335c6c1daeSBarry Smith .ve 8345c6c1daeSBarry Smith 8355c6c1daeSBarry Smith Note: 8365c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in 8375c6c1daeSBarry Smith include/petsclog.h) or an event number obtained with PetscLogEventRegister()). 8385c6c1daeSBarry Smith 8395c6c1daeSBarry Smith Level: advanced 8405c6c1daeSBarry Smith 841db781477SPatrick Sanan .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePush()`, `PetscLogEventDeactivatePop()` 8425c6c1daeSBarry Smith @*/ 8435c6c1daeSBarry Smith PetscErrorCode PetscLogEventDeactivate(PetscLogEvent event) 8445c6c1daeSBarry Smith { 8455c6c1daeSBarry Smith PetscStageLog stageLog; 8465c6c1daeSBarry Smith int stage; 8475c6c1daeSBarry Smith 8485c6c1daeSBarry Smith PetscFunctionBegin; 8499566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 8509566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 8519566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event)); 8525c6c1daeSBarry Smith PetscFunctionReturn(0); 8535c6c1daeSBarry Smith } 8545c6c1daeSBarry Smith 8555c6c1daeSBarry Smith /*@ 856c00cb57fSBarry Smith PetscLogEventDeactivatePush - Indicates that a particular event should not be logged. 857c00cb57fSBarry Smith 858c00cb57fSBarry Smith Not Collective 859c00cb57fSBarry Smith 860c00cb57fSBarry Smith Input Parameter: 861c00cb57fSBarry Smith . event - The event id 862c00cb57fSBarry Smith 863c00cb57fSBarry Smith Usage: 864c00cb57fSBarry Smith .vb 865c00cb57fSBarry Smith PetscLogEventDeactivatePush(VEC_SetValues); 866c00cb57fSBarry Smith [code where you do not want to log VecSetValues()] 867c00cb57fSBarry Smith PetscLogEventDeactivatePop(VEC_SetValues); 868c00cb57fSBarry Smith [code where you do want to log VecSetValues()] 869c00cb57fSBarry Smith .ve 870c00cb57fSBarry Smith 871c00cb57fSBarry Smith Note: 872c00cb57fSBarry Smith The event may be either a pre-defined PETSc event (found in 873c00cb57fSBarry Smith include/petsclog.h) or an event number obtained with PetscLogEventRegister()). 874c00cb57fSBarry Smith 875c00cb57fSBarry Smith Level: advanced 876c00cb57fSBarry Smith 877db781477SPatrick Sanan .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePop()` 878c00cb57fSBarry Smith @*/ 879c00cb57fSBarry Smith PetscErrorCode PetscLogEventDeactivatePush(PetscLogEvent event) 880c00cb57fSBarry Smith { 881c00cb57fSBarry Smith PetscStageLog stageLog; 882c00cb57fSBarry Smith int stage; 883c00cb57fSBarry Smith 884c00cb57fSBarry Smith PetscFunctionBegin; 8859566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 8869566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 8879566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivatePush(stageLog->stageInfo[stage].eventLog, event)); 888c00cb57fSBarry Smith PetscFunctionReturn(0); 889c00cb57fSBarry Smith } 890c00cb57fSBarry Smith 891c00cb57fSBarry Smith /*@ 892c00cb57fSBarry Smith PetscLogEventDeactivatePop - Indicates that a particular event shouldbe logged. 893c00cb57fSBarry Smith 894c00cb57fSBarry Smith Not Collective 895c00cb57fSBarry Smith 896c00cb57fSBarry Smith Input Parameter: 897c00cb57fSBarry Smith . event - The event id 898c00cb57fSBarry Smith 899c00cb57fSBarry Smith Usage: 900c00cb57fSBarry Smith .vb 901c00cb57fSBarry Smith PetscLogEventDeactivatePush(VEC_SetValues); 902c00cb57fSBarry Smith [code where you do not want to log VecSetValues()] 903c00cb57fSBarry Smith PetscLogEventDeactivatePop(VEC_SetValues); 904c00cb57fSBarry Smith [code where you do want to log VecSetValues()] 905c00cb57fSBarry Smith .ve 906c00cb57fSBarry Smith 907c00cb57fSBarry Smith Note: 908c00cb57fSBarry Smith The event may be either a pre-defined PETSc event (found in 909c00cb57fSBarry Smith include/petsclog.h) or an event number obtained with PetscLogEventRegister()). 910c00cb57fSBarry Smith 911c00cb57fSBarry Smith Level: advanced 912c00cb57fSBarry Smith 913db781477SPatrick Sanan .seealso: `PetscLogEventActivate()`, `PetscLogEventDeactivatePush()` 914c00cb57fSBarry Smith @*/ 915c00cb57fSBarry Smith PetscErrorCode PetscLogEventDeactivatePop(PetscLogEvent event) 916c00cb57fSBarry Smith { 917c00cb57fSBarry Smith PetscStageLog stageLog; 918c00cb57fSBarry Smith int stage; 919c00cb57fSBarry Smith 920c00cb57fSBarry Smith PetscFunctionBegin; 9219566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9229566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 9239566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivatePop(stageLog->stageInfo[stage].eventLog, event)); 924c00cb57fSBarry Smith PetscFunctionReturn(0); 925c00cb57fSBarry Smith } 926c00cb57fSBarry Smith 927c00cb57fSBarry Smith /*@ 9285c6c1daeSBarry Smith PetscLogEventSetActiveAll - Sets the event activity in every stage. 9295c6c1daeSBarry Smith 9305c6c1daeSBarry Smith Not Collective 9315c6c1daeSBarry Smith 9325c6c1daeSBarry Smith Input Parameters: 9335c6c1daeSBarry Smith + event - The event id 9345c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged 9355c6c1daeSBarry Smith 9365c6c1daeSBarry Smith Level: advanced 9375c6c1daeSBarry Smith 938c2e3fba1SPatrick Sanan .seealso: `PlogEventActivate()`, `PlogEventDeactivate()` 9395c6c1daeSBarry Smith @*/ 9405c6c1daeSBarry Smith PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive) 9415c6c1daeSBarry Smith { 9425c6c1daeSBarry Smith PetscStageLog stageLog; 9435c6c1daeSBarry Smith int stage; 9445c6c1daeSBarry Smith 9455c6c1daeSBarry Smith PetscFunctionBegin; 9469566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9475c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 9485c6c1daeSBarry Smith if (isActive) { 9499566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event)); 9505c6c1daeSBarry Smith } else { 9519566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event)); 9525c6c1daeSBarry Smith } 9535c6c1daeSBarry Smith } 9545c6c1daeSBarry Smith PetscFunctionReturn(0); 9555c6c1daeSBarry Smith } 9565c6c1daeSBarry Smith 9575c6c1daeSBarry Smith /*@ 9585c6c1daeSBarry Smith PetscLogEventActivateClass - Activates event logging for a PETSc object class. 9595c6c1daeSBarry Smith 9605c6c1daeSBarry Smith Not Collective 9615c6c1daeSBarry Smith 9625c6c1daeSBarry Smith Input Parameter: 9635c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 9645c6c1daeSBarry Smith 9655c6c1daeSBarry Smith Level: developer 9665c6c1daeSBarry Smith 967c2e3fba1SPatrick Sanan .seealso: `PetscLogEventDeactivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 9685c6c1daeSBarry Smith @*/ 9695c6c1daeSBarry Smith PetscErrorCode PetscLogEventActivateClass(PetscClassId classid) 9705c6c1daeSBarry Smith { 9715c6c1daeSBarry Smith PetscStageLog stageLog; 9725c6c1daeSBarry Smith int stage; 9735c6c1daeSBarry Smith 9745c6c1daeSBarry Smith PetscFunctionBegin; 9759566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 9769566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 9779566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 9785c6c1daeSBarry Smith PetscFunctionReturn(0); 9795c6c1daeSBarry Smith } 9805c6c1daeSBarry Smith 9815c6c1daeSBarry Smith /*@ 9825c6c1daeSBarry Smith PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class. 9835c6c1daeSBarry Smith 9845c6c1daeSBarry Smith Not Collective 9855c6c1daeSBarry Smith 9865c6c1daeSBarry Smith Input Parameter: 9875c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 9885c6c1daeSBarry Smith 9895c6c1daeSBarry Smith Level: developer 9905c6c1daeSBarry Smith 991c2e3fba1SPatrick Sanan .seealso: `PetscLogEventActivateClass()`, `PetscLogEventActivate()`, `PetscLogEventDeactivate()` 9925c6c1daeSBarry Smith @*/ 9935c6c1daeSBarry Smith PetscErrorCode PetscLogEventDeactivateClass(PetscClassId classid) 9945c6c1daeSBarry Smith { 9955c6c1daeSBarry Smith PetscStageLog stageLog; 9965c6c1daeSBarry Smith int stage; 9975c6c1daeSBarry Smith 9985c6c1daeSBarry Smith PetscFunctionBegin; 9999566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 10009566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 10019566063dSJacob Faibussowitsch PetscCall(PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid)); 10025c6c1daeSBarry Smith PetscFunctionReturn(0); 10035c6c1daeSBarry Smith } 10045c6c1daeSBarry Smith 10055c6c1daeSBarry Smith /*MC 100662872c28SLisandro Dalcin PetscLogEventSync - Synchronizes the beginning of a user event. 100762872c28SLisandro Dalcin 100862872c28SLisandro Dalcin Synopsis: 100962872c28SLisandro Dalcin #include <petsclog.h> 101062872c28SLisandro Dalcin PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm) 101162872c28SLisandro Dalcin 101262872c28SLisandro Dalcin Collective 101362872c28SLisandro Dalcin 101462872c28SLisandro Dalcin Input Parameters: 101562872c28SLisandro Dalcin + e - integer associated with the event obtained from PetscLogEventRegister() 101662872c28SLisandro Dalcin - comm - an MPI communicator 101762872c28SLisandro Dalcin 101862872c28SLisandro Dalcin Usage: 101962872c28SLisandro Dalcin .vb 102062872c28SLisandro Dalcin PetscLogEvent USER_EVENT; 102162872c28SLisandro Dalcin PetscLogEventRegister("User event",0,&USER_EVENT); 102262872c28SLisandro Dalcin PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD); 102362872c28SLisandro Dalcin PetscLogEventBegin(USER_EVENT,0,0,0,0); 102462872c28SLisandro Dalcin [code segment to monitor] 102562872c28SLisandro Dalcin PetscLogEventEnd(USER_EVENT,0,0,0,0); 102662872c28SLisandro Dalcin .ve 102762872c28SLisandro Dalcin 102862872c28SLisandro Dalcin Notes: 102962872c28SLisandro Dalcin This routine should be called only if there is not a 103062872c28SLisandro Dalcin PetscObject available to pass to PetscLogEventBegin(). 103162872c28SLisandro Dalcin 103262872c28SLisandro Dalcin Level: developer 103362872c28SLisandro Dalcin 1034db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()` 103562872c28SLisandro Dalcin 103662872c28SLisandro Dalcin M*/ 103762872c28SLisandro Dalcin 103862872c28SLisandro Dalcin /*MC 10395c6c1daeSBarry Smith PetscLogEventBegin - Logs the beginning of a user event. 10405c6c1daeSBarry Smith 10415c6c1daeSBarry Smith Synopsis: 1042aaa7dc30SBarry Smith #include <petsclog.h> 1043f2ba6396SBarry Smith PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10445c6c1daeSBarry Smith 10455c6c1daeSBarry Smith Not Collective 10465c6c1daeSBarry Smith 10475c6c1daeSBarry Smith Input Parameters: 10485c6c1daeSBarry Smith + e - integer associated with the event obtained from PetscLogEventRegister() 10495c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10505c6c1daeSBarry Smith 10515c6c1daeSBarry Smith Fortran Synopsis: 10525c6c1daeSBarry Smith void PetscLogEventBegin(int e,PetscErrorCode ierr) 10535c6c1daeSBarry Smith 10545c6c1daeSBarry Smith Usage: 10555c6c1daeSBarry Smith .vb 10565c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 10575c6c1daeSBarry Smith PetscLogDouble user_event_flops; 10585c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 10595c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 10605c6c1daeSBarry Smith [code segment to monitor] 10615c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 10625c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 10635c6c1daeSBarry Smith .ve 10645c6c1daeSBarry Smith 10655c6c1daeSBarry Smith Notes: 10665c6c1daeSBarry Smith You need to register each integer event with the command 1067a2553e36SBarry Smith PetscLogEventRegister(). 10685c6c1daeSBarry Smith 1069d0609cedSBarry Smith Developer Notes: 1070d0609cedSBarry Smith PetscLogEventBegin() and PetscLogEventBegin() return error codes instead of explicitly handling the 1071d0609cedSBarry Smith errors that occur in the macro directly because other packages that use this macros have used them in their 1072d0609cedSBarry Smith own functions or methods that do not return error codes and it would be disruptive to change the current 1073d0609cedSBarry Smith behavior. 1074d0609cedSBarry Smith 10755c6c1daeSBarry Smith Level: intermediate 10765c6c1daeSBarry Smith 1077db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventEnd()`, `PetscLogFlops()` 10785c6c1daeSBarry Smith 10795c6c1daeSBarry Smith M*/ 10805c6c1daeSBarry Smith 10815c6c1daeSBarry Smith /*MC 10825c6c1daeSBarry Smith PetscLogEventEnd - Log the end of a user event. 10835c6c1daeSBarry Smith 10845c6c1daeSBarry Smith Synopsis: 1085aaa7dc30SBarry Smith #include <petsclog.h> 1086f2ba6396SBarry Smith PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10875c6c1daeSBarry Smith 10885c6c1daeSBarry Smith Not Collective 10895c6c1daeSBarry Smith 10905c6c1daeSBarry Smith Input Parameters: 10915c6c1daeSBarry Smith + e - integer associated with the event obtained with PetscLogEventRegister() 10925c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10935c6c1daeSBarry Smith 10945c6c1daeSBarry Smith Fortran Synopsis: 10955c6c1daeSBarry Smith void PetscLogEventEnd(int e,PetscErrorCode ierr) 10965c6c1daeSBarry Smith 10975c6c1daeSBarry Smith Usage: 10985c6c1daeSBarry Smith .vb 10995c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 11005c6c1daeSBarry Smith PetscLogDouble user_event_flops; 11015c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT,); 11025c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 11035c6c1daeSBarry Smith [code segment to monitor] 11045c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 11055c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 11065c6c1daeSBarry Smith .ve 11075c6c1daeSBarry Smith 11085c6c1daeSBarry Smith Notes: 11095c6c1daeSBarry Smith You should also register each additional integer event with the command 1110a2553e36SBarry Smith PetscLogEventRegister(). 11115c6c1daeSBarry Smith 11125c6c1daeSBarry Smith Level: intermediate 11135c6c1daeSBarry Smith 1114db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogFlops()` 11155c6c1daeSBarry Smith 11165c6c1daeSBarry Smith M*/ 11175c6c1daeSBarry Smith 11185c6c1daeSBarry Smith /*@C 11195c6c1daeSBarry Smith PetscLogEventGetId - Returns the event id when given the event name. 11205c6c1daeSBarry Smith 11215c6c1daeSBarry Smith Not Collective 11225c6c1daeSBarry Smith 11235c6c1daeSBarry Smith Input Parameter: 11245c6c1daeSBarry Smith . name - The event name 11255c6c1daeSBarry Smith 11265c6c1daeSBarry Smith Output Parameter: 1127c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists 11285c6c1daeSBarry Smith 11295c6c1daeSBarry Smith Level: intermediate 11305c6c1daeSBarry Smith 1131db781477SPatrick Sanan .seealso: `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogStageGetId()` 11325c6c1daeSBarry Smith @*/ 11335c6c1daeSBarry Smith PetscErrorCode PetscLogEventGetId(const char name[], PetscLogEvent *event) 11345c6c1daeSBarry Smith { 11355c6c1daeSBarry Smith PetscStageLog stageLog; 11365c6c1daeSBarry Smith 11375c6c1daeSBarry Smith PetscFunctionBegin; 11389566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 11399566063dSJacob Faibussowitsch PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, event)); 11405c6c1daeSBarry Smith PetscFunctionReturn(0); 11415c6c1daeSBarry Smith } 11425c6c1daeSBarry Smith 11435c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/ 11445c6c1daeSBarry Smith /*@C 11455c6c1daeSBarry Smith PetscLogDump - Dumps logs of objects to a file. This file is intended to 11465c6c1daeSBarry Smith be read by bin/petscview. This program no longer exists. 11475c6c1daeSBarry Smith 11485c6c1daeSBarry Smith Collective on PETSC_COMM_WORLD 11495c6c1daeSBarry Smith 11505c6c1daeSBarry Smith Input Parameter: 11515c6c1daeSBarry Smith . name - an optional file name 11525c6c1daeSBarry Smith 11535c6c1daeSBarry Smith Usage: 11545c6c1daeSBarry Smith .vb 11555c6c1daeSBarry Smith PetscInitialize(...); 1156bb1d7374SBarry Smith PetscLogDefaultBegin(); or PetscLogAllBegin(); 11575c6c1daeSBarry Smith ... code ... 11585c6c1daeSBarry Smith PetscLogDump(filename); 11595c6c1daeSBarry Smith PetscFinalize(); 11605c6c1daeSBarry Smith .ve 11615c6c1daeSBarry Smith 11625c6c1daeSBarry Smith Notes: 11635c6c1daeSBarry Smith The default file name is 11645c6c1daeSBarry Smith $ Log.<rank> 11655c6c1daeSBarry Smith where <rank> is the processor number. If no name is specified, 11665c6c1daeSBarry Smith this file will be used. 11675c6c1daeSBarry Smith 11685c6c1daeSBarry Smith Level: advanced 11695c6c1daeSBarry Smith 1170db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogView()` 11715c6c1daeSBarry Smith @*/ 11725c6c1daeSBarry Smith PetscErrorCode PetscLogDump(const char sname[]) 11735c6c1daeSBarry Smith { 11745c6c1daeSBarry Smith PetscStageLog stageLog; 11755c6c1daeSBarry Smith PetscEventPerfInfo *eventInfo; 11765c6c1daeSBarry Smith FILE *fd; 11775c6c1daeSBarry Smith char file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN]; 11785c6c1daeSBarry Smith PetscLogDouble flops, _TotalTime; 11795c6c1daeSBarry Smith PetscMPIInt rank; 11805c6c1daeSBarry Smith int action, object, curStage; 11815c6c1daeSBarry Smith PetscLogEvent event; 11825c6c1daeSBarry Smith 11835c6c1daeSBarry Smith PetscFunctionBegin; 11845c6c1daeSBarry Smith /* Calculate the total elapsed time */ 11858563dfccSBarry Smith PetscTime(&_TotalTime); 11865c6c1daeSBarry Smith _TotalTime -= petsc_BaseTime; 11875c6c1daeSBarry Smith /* Open log file */ 11889566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank)); 11897ff663adSLisandro Dalcin if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank); 1190a297a907SKarl Rupp else sprintf(file, "Log.%d", rank); 11919566063dSJacob Faibussowitsch PetscCall(PetscFixFilename(file, fname)); 11929566063dSJacob Faibussowitsch PetscCall(PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd)); 119308401ef6SPierre Jolivet PetscCheck(!(rank == 0) || !(!fd),PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname); 11945c6c1daeSBarry Smith /* Output totals */ 11959566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime)); 11969566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0)); 11975c6c1daeSBarry Smith /* Output actions */ 11985c6c1daeSBarry Smith if (petsc_logActions) { 11999566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions)); 12005c6c1daeSBarry Smith for (action = 0; action < petsc_numActions; action++) { 1201d0609cedSBarry Smith PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n", 12025c6c1daeSBarry Smith petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1, 1203d0609cedSBarry Smith petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem)); 12045c6c1daeSBarry Smith } 12055c6c1daeSBarry Smith } 12065c6c1daeSBarry Smith /* Output objects */ 12075c6c1daeSBarry Smith if (petsc_logObjects) { 12089566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed)); 12095c6c1daeSBarry Smith for (object = 0; object < petsc_numObjects; object++) { 12109566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int) petsc_objects[object].mem)); 12115c6c1daeSBarry Smith if (!petsc_objects[object].name[0]) { 12129566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd,"No Name\n")); 12135c6c1daeSBarry Smith } else { 12149566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name)); 12155c6c1daeSBarry Smith } 12165c6c1daeSBarry Smith if (petsc_objects[object].info[0] != 0) { 12179566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n")); 12185c6c1daeSBarry Smith } else { 12199566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info)); 12205c6c1daeSBarry Smith } 12215c6c1daeSBarry Smith } 12225c6c1daeSBarry Smith } 12235c6c1daeSBarry Smith /* Output events */ 12249566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n")); 12259566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 12269566063dSJacob Faibussowitsch PetscCall(PetscIntStackTop(stageLog->stack, &curStage)); 12275c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo; 12285c6c1daeSBarry Smith for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) { 1229a297a907SKarl Rupp if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops/eventInfo[event].time; 1230a297a907SKarl Rupp else flops = 0.0; 1231d0609cedSBarry Smith PetscCall(PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count,eventInfo[event].flops, eventInfo[event].time, flops)); 12325c6c1daeSBarry Smith } 12339566063dSJacob Faibussowitsch PetscCall(PetscFClose(PETSC_COMM_WORLD, fd)); 12345c6c1daeSBarry Smith PetscFunctionReturn(0); 12355c6c1daeSBarry Smith } 12365c6c1daeSBarry Smith 1237f14045dbSBarry Smith /* 1238f14045dbSBarry Smith PetscLogView_Detailed - Each process prints the times for its own events 1239f14045dbSBarry Smith 1240f14045dbSBarry Smith */ 1241f14045dbSBarry Smith PetscErrorCode PetscLogView_Detailed(PetscViewer viewer) 1242f14045dbSBarry Smith { 12432dff6485SMatthew G. Knepley PetscStageLog stageLog; 1244217044c2SLisandro Dalcin PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL; 1245217044c2SLisandro Dalcin PetscLogDouble locTotalTime, numRed, maxMem; 12462dff6485SMatthew G. Knepley int numStages,numEvents,stage,event; 1247217044c2SLisandro Dalcin MPI_Comm comm = PetscObjectComm((PetscObject) viewer); 12482dff6485SMatthew G. Knepley PetscMPIInt rank,size; 1249f14045dbSBarry Smith 1250f14045dbSBarry Smith PetscFunctionBegin; 12519566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 12529566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 12532dff6485SMatthew G. Knepley /* Must preserve reduction count before we go on */ 12542dff6485SMatthew G. Knepley numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 12552d1ec343SBarry Smith /* Get the total elapsed time */ 12562d1ec343SBarry Smith PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 12579566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer,"size = %d\n",size)); 12589566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer,"LocalTimes = {}\n")); 12599566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer,"LocalMessages = {}\n")); 12609566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer,"LocalMessageLens = {}\n")); 12619566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer,"LocalReductions = {}\n")); 12629566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer,"LocalFlop = {}\n")); 12639566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer,"LocalObjects = {}\n")); 12649566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer,"LocalMemory = {}\n")); 12659566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 12669566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 12679566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer,"Stages = {}\n")); 12682d1ec343SBarry Smith for (stage=0; stage<numStages; stage++) { 12699566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"] = {}\n",stageLog->stageInfo[stage].name)); 12709566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"summary\"] = {}\n",stageLog->stageInfo[stage].name)); 12719566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 12722d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 12739566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"%s\"] = {}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name)); 12742d1ec343SBarry Smith } 12752d1ec343SBarry Smith } 12769566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&maxMem)); 12779566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushSynchronized(viewer)); 12789566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"LocalTimes[%d] = %g\n",rank,locTotalTime)); 12799566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessages[%d] = %g\n",rank,(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct))); 12809566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessageLens[%d] = %g\n",rank,(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len))); 12819566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"LocalReductions[%d] = %g\n",rank,numRed)); 12829566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"LocalFlop[%d] = %g\n",rank,petsc_TotalFlops)); 12839566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"LocalObjects[%d] = %d\n",rank,petsc_numObjects)); 12849566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"LocalMemory[%d] = %g\n",rank,maxMem)); 12859566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 12862d1ec343SBarry Smith for (stage=0; stage<numStages; stage++) { 1287217044c2SLisandro Dalcin stageInfo = &stageLog->stageInfo[stage].perfInfo; 1288d0609cedSBarry Smith PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n", 12892dff6485SMatthew G. Knepley stageLog->stageInfo[stage].name,rank, 1290d0609cedSBarry Smith stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops)); 12919566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 12922d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 1293217044c2SLisandro Dalcin eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 1294d0609cedSBarry Smith PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %d, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g", 1295217044c2SLisandro Dalcin stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name,rank, 1296d0609cedSBarry Smith eventInfo->count,eventInfo->time,eventInfo->syncTime,eventInfo->numMessages,eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops)); 1297891e75beSMatthew G. Knepley if (eventInfo->dof[0] >= 0.) { 1298891e75beSMatthew G. Knepley PetscInt d, e; 12995d68e14cSMatthew G. Knepley 13009566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : [")); 1301891e75beSMatthew G. Knepley for (d = 0; d < 8; ++d) { 13029566063dSJacob Faibussowitsch if (d > 0) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", ")); 13039566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d])); 1304891e75beSMatthew G. Knepley } 13059566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "]")); 13069566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : [")); 13075d68e14cSMatthew G. Knepley for (e = 0; e < 8; ++e) { 13089566063dSJacob Faibussowitsch if (e > 0) PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ", ")); 13099566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e])); 13105d68e14cSMatthew G. Knepley } 13119566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "]")); 13125d68e14cSMatthew G. Knepley } 13139566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"}\n")); 13142d1ec343SBarry Smith } 13152d1ec343SBarry Smith } 13169566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 13179566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopSynchronized(viewer)); 1318f14045dbSBarry Smith PetscFunctionReturn(0); 1319f14045dbSBarry Smith } 1320f14045dbSBarry Smith 132138144912Sdeepblu2718 /* 132238144912Sdeepblu2718 PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format 132338144912Sdeepblu2718 */ 132438144912Sdeepblu2718 PetscErrorCode PetscLogView_CSV(PetscViewer viewer) 132538144912Sdeepblu2718 { 132638144912Sdeepblu2718 PetscStageLog stageLog; 1327669c5be0SSatish Balay PetscEventPerfInfo *eventInfo = NULL; 132838144912Sdeepblu2718 PetscLogDouble locTotalTime, maxMem; 132938144912Sdeepblu2718 int numStages,numEvents,stage,event; 133038144912Sdeepblu2718 MPI_Comm comm = PetscObjectComm((PetscObject) viewer); 133138144912Sdeepblu2718 PetscMPIInt rank,size; 133238144912Sdeepblu2718 133338144912Sdeepblu2718 PetscFunctionBegin; 13349566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 13359566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 133638144912Sdeepblu2718 /* Must preserve reduction count before we go on */ 133738144912Sdeepblu2718 /* Get the total elapsed time */ 133838144912Sdeepblu2718 PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 13399566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 13409566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 13419566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&maxMem)); 13429566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPushSynchronized(viewer)); 1343d0609cedSBarry 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)); 13449566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 134538144912Sdeepblu2718 for (stage=0; stage<numStages; stage++) { 13469e29573dSMatthew G. Knepley PetscEventPerfInfo *stageInfo = &stageLog->stageInfo[stage].perfInfo; 13479e29573dSMatthew G. Knepley 1348d0609cedSBarry Smith PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"%s,summary,%d,1,%g,%g,%g,%g,%g\n", 1349d0609cedSBarry Smith stageLog->stageInfo[stage].name,rank,stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops)); 13509566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 135138144912Sdeepblu2718 for (event = 0; event < numEvents; event++) { 135238144912Sdeepblu2718 eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 1353d0609cedSBarry Smith PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"%s,%s,%d,%d,%g,%g,%g,%g,%g",stageLog->stageInfo[stage].name, 1354a2fddd78SAlbert Cowie stageLog->eventLog->eventInfo[event].name,rank,eventInfo->count,eventInfo->time,eventInfo->numMessages, 1355d0609cedSBarry Smith eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops)); 135638144912Sdeepblu2718 if (eventInfo->dof[0] >= 0.) { 135738144912Sdeepblu2718 PetscInt d, e; 135838144912Sdeepblu2718 135938144912Sdeepblu2718 for (d = 0; d < 8; ++d) { 13609566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d])); 136138144912Sdeepblu2718 } 136238144912Sdeepblu2718 for (e = 0; e < 8; ++e) { 13639566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e])); 136438144912Sdeepblu2718 } 136538144912Sdeepblu2718 } 13669566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"\n")); 136738144912Sdeepblu2718 } 136838144912Sdeepblu2718 } 13699566063dSJacob Faibussowitsch PetscCall(PetscViewerFlush(viewer)); 13709566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIPopSynchronized(viewer)); 137138144912Sdeepblu2718 PetscFunctionReturn(0); 137238144912Sdeepblu2718 } 137338144912Sdeepblu2718 1374217044c2SLisandro Dalcin static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm,FILE *fd) 1375217044c2SLisandro Dalcin { 1376217044c2SLisandro Dalcin PetscFunctionBegin; 1377217044c2SLisandro Dalcin if (!PetscLogSyncOn) PetscFunctionReturn(0); 13789566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 13799566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 13809566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 13819566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 13829566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 13839566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This program was run with logging synchronization. #\n")); 13849566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This option provides more meaningful imbalance #\n")); 13859566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # figures at the expense of slowing things down and #\n")); 13869566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # providing a distorted view of the overall runtime. #\n")); 13879566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 13889566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1389217044c2SLisandro Dalcin PetscFunctionReturn(0); 1390217044c2SLisandro Dalcin } 1391217044c2SLisandro Dalcin 1392f4091ad2SBarry Smith static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm,FILE *fd) 1393f4091ad2SBarry Smith { 1394f4091ad2SBarry Smith PetscFunctionBegin; 139576bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 13969566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 13979566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 13989566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 13999566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 14009566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14019566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This code was compiled with a debugging option. #\n")); 14029566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # To get timing results run ./configure #\n")); 14039566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # using --with-debugging=no, the performance will #\n")); 14049566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # be generally two or three times faster. #\n")); 14059566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14069566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 140776bd3646SJed Brown } 1408f4091ad2SBarry Smith PetscFunctionReturn(0); 1409f4091ad2SBarry Smith } 1410f4091ad2SBarry Smith 1411c2a741eeSJunchao Zhang static PetscErrorCode PetscLogViewWarnNoGpuAwareMpi(MPI_Comm comm,FILE *fd) 1412c2a741eeSJunchao Zhang { 1413009ab46cSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1414009ab46cSJunchao Zhang PetscMPIInt size; 1415c2a741eeSJunchao Zhang 1416c2a741eeSJunchao Zhang PetscFunctionBegin; 14179566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 1418340fe3cdSSatish Balay if (use_gpu_aware_mpi || size == 1) PetscFunctionReturn(0); 14199566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n\n")); 14209566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 14219566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14229566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 14239566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14249566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # This code was compiled with GPU support and you've #\n")); 14259566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # created PETSc/GPU objects, but you intentionally #\n")); 14269566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # used -use_gpu_aware_mpi 0, requiring PETSc to copy #\n")); 14279566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # additional data between the GPU and CPU. To obtain #\n")); 14289566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # meaningful timing results on multi-rank runs, use #\n")); 14299566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # GPU-aware MPI instead. #\n")); 14309566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " # #\n")); 14319566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1432c2a741eeSJunchao Zhang PetscFunctionReturn(0); 1433c2a741eeSJunchao Zhang #else 1434c2a741eeSJunchao Zhang return 0; 1435c2a741eeSJunchao Zhang #endif 1436c2a741eeSJunchao Zhang } 1437c2a741eeSJunchao Zhang 1438156b51fbSBarry Smith static PetscErrorCode PetscLogViewWarnGpuTime(MPI_Comm comm,FILE *fd) 1439156b51fbSBarry Smith { 1440156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1441156b51fbSBarry Smith 1442156b51fbSBarry Smith PetscFunctionBegin; 1443156b51fbSBarry Smith if (!PetscLogGpuTimeFlag || petsc_gflops == 0) PetscFunctionReturn(0); 1444156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, "\n\n")); 1445156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n")); 1446156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1447156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # WARNING!!! #\n")); 1448156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1449156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # This code was run with -log_view_gpu_time #\n")); 1450156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # This provides accurate timing within the GPU kernels #\n")); 1451156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # but can slow down the entire computation by a #\n")); 1452156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # measurable amount. For fastest runs we recommend #\n")); 1453156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # not using this option. #\n")); 1454156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " # #\n")); 1455156b51fbSBarry Smith PetscCall(PetscFPrintf(comm, fd, " ##########################################################\n\n\n")); 1456156b51fbSBarry Smith PetscFunctionReturn(0); 1457156b51fbSBarry Smith #else 1458156b51fbSBarry Smith return 0; 1459156b51fbSBarry Smith #endif 1460156b51fbSBarry Smith } 1461156b51fbSBarry Smith 1462f14045dbSBarry Smith PetscErrorCode PetscLogView_Default(PetscViewer viewer) 14635c6c1daeSBarry Smith { 14645c6c1daeSBarry Smith FILE *fd; 14655c6c1daeSBarry Smith PetscLogDouble zero = 0.0; 14665c6c1daeSBarry Smith PetscStageLog stageLog; 14670298fd71SBarry Smith PetscStageInfo *stageInfo = NULL; 14680298fd71SBarry Smith PetscEventPerfInfo *eventInfo = NULL; 14695c6c1daeSBarry Smith PetscClassPerfInfo *classInfo; 14705c6c1daeSBarry Smith char arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128]; 14715c6c1daeSBarry Smith const char *name; 14725c6c1daeSBarry Smith PetscLogDouble locTotalTime, TotalTime, TotalFlops; 14735c6c1daeSBarry Smith PetscLogDouble numMessages, messageLength, avgMessLen, numReductions; 14745c6c1daeSBarry Smith PetscLogDouble stageTime, flops, flopr, mem, mess, messLen, red; 14755c6c1daeSBarry Smith PetscLogDouble fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed; 14765c6c1daeSBarry Smith PetscLogDouble fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed; 14775c6c1daeSBarry Smith PetscLogDouble min, max, tot, ratio, avg, x, y; 1478e3ed9ee7SBarry Smith PetscLogDouble minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr, mal, malmax, emalmax; 1479d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1480156b51fbSBarry Smith PetscLogEvent KSP_Solve, SNES_Solve, TS_Step, TAO_Solve; /* These need to be fixed to be some events registered with certain objects */ 1481958c4211Shannah_mairs PetscLogDouble cct, gct, csz, gsz, gmaxt, gflops, gflopr, fracgflops; 1482bec0b493Shannah_mairs #endif 1483217044c2SLisandro Dalcin PetscMPIInt minC, maxC; 14845c6c1daeSBarry Smith PetscMPIInt size, rank; 14855c6c1daeSBarry Smith PetscBool *localStageUsed, *stageUsed; 14865c6c1daeSBarry Smith PetscBool *localStageVisible, *stageVisible; 14875c6c1daeSBarry Smith int numStages, localNumEvents, numEvents; 148837b78d16SBarry Smith int stage, oclass; 14895c6c1daeSBarry Smith PetscLogEvent event; 1490d0609cedSBarry Smith PetscErrorCode ierr = 0; 14915c6c1daeSBarry Smith char version[256]; 14925c6c1daeSBarry Smith MPI_Comm comm; 1493156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1494156b51fbSBarry Smith PetscLogEvent eventid; 1495156b51fbSBarry Smith PetscInt64 nas = 0x7FF0000000000002; 1496156b51fbSBarry Smith #endif 14975c6c1daeSBarry Smith 14985c6c1daeSBarry Smith PetscFunctionBegin; 1499156b51fbSBarry Smith PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF)); 15009566063dSJacob Faibussowitsch PetscCall(PetscObjectGetComm((PetscObject)viewer,&comm)); 15019566063dSJacob Faibussowitsch PetscCall(PetscViewerASCIIGetPointer(viewer,&fd)); 15029566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_size(comm, &size)); 15039566063dSJacob Faibussowitsch PetscCallMPI(MPI_Comm_rank(comm, &rank)); 15045c6c1daeSBarry Smith /* Get the total elapsed time */ 15058563dfccSBarry Smith PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 15065c6c1daeSBarry Smith 1507*faad7b01SPierre Jolivet PetscCall(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n")); 15089566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "*** WIDEN YOUR WINDOW TO 160 CHARACTERS. Use 'enscript -r -fCourier9' to print this document ***\n")); 15099566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n")); 1510*faad7b01SPierre Jolivet PetscCall(PetscFPrintf(comm, fd, "\n------------------------------------------------------------------ PETSc Performance Summary: ------------------------------------------------------------------\n\n")); 15119566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnSync(comm,fd)); 15129566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm,fd)); 15139566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnNoGpuAwareMpi(comm,fd)); 1514156b51fbSBarry Smith PetscCall(PetscLogViewWarnGpuTime(comm,fd)); 15159566063dSJacob Faibussowitsch PetscCall(PetscGetArchType(arch,sizeof(arch))); 15169566063dSJacob Faibussowitsch PetscCall(PetscGetHostName(hostname,sizeof(hostname))); 15179566063dSJacob Faibussowitsch PetscCall(PetscGetUserName(username,sizeof(username))); 15189566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(pname,sizeof(pname))); 15199566063dSJacob Faibussowitsch PetscCall(PetscGetDate(date,sizeof(date))); 15209566063dSJacob Faibussowitsch PetscCall(PetscGetVersion(version,sizeof(version))); 15215c6c1daeSBarry Smith if (size == 1) { 15229566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm,fd,"%s on a %s named %s with %d processor, by %s %s\n", pname, arch, hostname, size, username, date)); 15235c6c1daeSBarry Smith } else { 15249566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm,fd,"%s on a %s named %s with %d processors, by %s %s\n", pname, arch, hostname, size, username, date)); 15255c6c1daeSBarry Smith } 1526f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP) 15279566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm,fd,"Using %" PetscInt_FMT " OpenMP threads\n", PetscNumOMPThreads)); 1528f90b075cSBarry Smith #endif 15299566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Using %s\n", version)); 15305c6c1daeSBarry Smith 15315c6c1daeSBarry Smith /* Must preserve reduction count before we go on */ 15325c6c1daeSBarry Smith red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 15335c6c1daeSBarry Smith 15345c6c1daeSBarry Smith /* Calculate summary information */ 15359566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n Max Max/Min Avg Total\n")); 15365c6c1daeSBarry Smith /* Time */ 15379566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15389566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15399566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1540217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1541217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 15429566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Time (sec): %5.3e %7.3f %5.3e\n", max, ratio, avg)); 15435c6c1daeSBarry Smith TotalTime = tot; 15445c6c1daeSBarry Smith /* Objects */ 15455c6c1daeSBarry Smith avg = (PetscLogDouble) petsc_numObjects; 15469566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15479566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15489566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1549217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1550217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 15519566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Objects: %5.3e %7.3f %5.3e\n", max, ratio, avg)); 15525c6c1daeSBarry Smith /* Flops */ 15539566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15549566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15559566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&petsc_TotalFlops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1556217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1557217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 15589566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Flops: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15595c6c1daeSBarry Smith TotalFlops = tot; 15605c6c1daeSBarry Smith /* Flops/sec -- Must talk to Barry here */ 1561217044c2SLisandro Dalcin if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime; else flops = 0.0; 15629566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15639566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15649566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1565217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1566217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 15679566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Flops/sec: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15685c6c1daeSBarry Smith /* Memory */ 15699566063dSJacob Faibussowitsch PetscCall(PetscMallocGetMaximumUsage(&mem)); 15705c6c1daeSBarry Smith if (mem > 0.0) { 15719566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15729566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15739566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1574217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1575217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 15769566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Memory (bytes): %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15775c6c1daeSBarry Smith } 15785c6c1daeSBarry Smith /* Messages */ 15795c6c1daeSBarry Smith mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct); 15809566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15819566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15829566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1583217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1584217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 15859566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Msg Count: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15865c6c1daeSBarry Smith numMessages = tot; 15875c6c1daeSBarry Smith /* Message Lengths */ 15885c6c1daeSBarry Smith mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len); 15899566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15909566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15919566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1592217044c2SLisandro Dalcin if (numMessages != 0) avg = tot/numMessages; else avg = 0.0; 1593217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 15949566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Msg Len (bytes): %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot)); 15955c6c1daeSBarry Smith messageLength = tot; 15965c6c1daeSBarry Smith /* Reductions */ 15979566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 15989566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 15999566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1600217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 16019566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "MPI Reductions: %5.3e %7.3f\n", max, ratio)); 16025c6c1daeSBarry Smith numReductions = red; /* wrong because uses count from process zero */ 16039566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n")); 16049566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " e.g., VecAXPY() for real vectors of length N --> 2N flops\n")); 16059566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " and VecAXPY() for complex vectors of length N --> 8N flops\n")); 16065c6c1daeSBarry Smith 16075c6c1daeSBarry Smith /* Get total number of stages -- 16085c6c1daeSBarry Smith Currently, a single processor can register more stages than another, but stages must all be registered in order. 16095c6c1daeSBarry Smith We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID. 16105c6c1daeSBarry Smith This seems best accomplished by assoicating a communicator with each stage. 16115c6c1daeSBarry Smith */ 16129566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 16139566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm)); 16149566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &localStageUsed)); 16159566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &stageUsed)); 16169566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &localStageVisible)); 16179566063dSJacob Faibussowitsch PetscCall(PetscMalloc1(numStages, &stageVisible)); 16185c6c1daeSBarry Smith if (numStages > 0) { 16195c6c1daeSBarry Smith stageInfo = stageLog->stageInfo; 16205c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16215c6c1daeSBarry Smith if (stage < stageLog->numStages) { 16225c6c1daeSBarry Smith localStageUsed[stage] = stageInfo[stage].used; 16235c6c1daeSBarry Smith localStageVisible[stage] = stageInfo[stage].perfInfo.visible; 16245c6c1daeSBarry Smith } else { 16255c6c1daeSBarry Smith localStageUsed[stage] = PETSC_FALSE; 16265c6c1daeSBarry Smith localStageVisible[stage] = PETSC_TRUE; 16275c6c1daeSBarry Smith } 16285c6c1daeSBarry Smith } 16299566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm)); 16309566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm)); 16315c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16325c6c1daeSBarry Smith if (stageUsed[stage]) { 16339566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\nSummary of Stages: ----- Time ------ ----- Flop ------ --- Messages --- -- Message Lengths -- -- Reductions --\n")); 16349566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Avg %%Total Avg %%Total Count %%Total Avg %%Total Count %%Total\n")); 16355c6c1daeSBarry Smith break; 16365c6c1daeSBarry Smith } 16375c6c1daeSBarry Smith } 16385c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16395c6c1daeSBarry Smith if (!stageUsed[stage]) continue; 1640820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 16415c6c1daeSBarry Smith if (localStageUsed[stage]) { 16429566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16439566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16449566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16459566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16469566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16475c6c1daeSBarry Smith name = stageInfo[stage].name; 16485c6c1daeSBarry Smith } else { 16499566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16509566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16519566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16529566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16539566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 16545c6c1daeSBarry Smith name = ""; 16555c6c1daeSBarry Smith } 16565c6c1daeSBarry Smith mess *= 0.5; messLen *= 0.5; red /= size; 16575c6c1daeSBarry Smith if (TotalTime != 0.0) fracTime = stageTime/TotalTime; else fracTime = 0.0; 16585c6c1daeSBarry Smith if (TotalFlops != 0.0) fracFlops = flops/TotalFlops; else fracFlops = 0.0; 16595c6c1daeSBarry Smith /* Talk to Barry if (stageTime != 0.0) flops = (size*flops)/stageTime; else flops = 0.0; */ 16605c6c1daeSBarry Smith if (numMessages != 0.0) fracMessages = mess/numMessages; else fracMessages = 0.0; 1661e96a4d02SJunchao Zhang if (mess != 0.0) avgMessLen = messLen/mess; else avgMessLen = 0.0; 16625c6c1daeSBarry Smith if (messageLength != 0.0) fracLength = messLen/messageLength; else fracLength = 0.0; 16635c6c1daeSBarry Smith if (numReductions != 0.0) fracReductions = red/numReductions; else fracReductions = 0.0; 1664d0609cedSBarry Smith 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", 16655c6c1daeSBarry Smith stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops, 1666d0609cedSBarry Smith mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions)); 16675c6c1daeSBarry Smith } 16685c6c1daeSBarry Smith } 16695c6c1daeSBarry Smith 16709566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n")); 16719566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n")); 16729566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Phase summary info:\n")); 16739566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Count: number of times phase was executed\n")); 16749566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Time and Flop: Max - maximum over all processors\n")); 16759566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Ratio - ratio of maximum to minimum over all processors\n")); 16769566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Mess: number of messages sent\n")); 16779566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " AvgLen: average message length (bytes)\n")); 16789566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Reduct: number of global reductions\n")); 16799566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Global: entire computation\n")); 16809566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n")); 16819566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%T - percent time in this phase %%F - percent flop in this phase\n")); 16829566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%M - percent messages in this phase %%L - percent message lengths in this phase\n")); 16839566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " %%R - percent reductions in this phase\n")); 16849566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n")); 1685e3ed9ee7SBarry Smith if (PetscLogMemory) { 16869566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event)\n")); 16879566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events)\n")); 16889566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event)\n")); 16899566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " RMI Mbytes: Increase in resident memory (sum over all calls to event)\n")); 1690e3ed9ee7SBarry Smith } 1691d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 16929566063dSJacob 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")); 16939566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " CpuToGpu Count: total number of CPU to GPU copies per processor\n")); 16949566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " CpuToGpu Size (Mbytes): 10e-6 * (total size of CPU to GPU copies per processor)\n")); 16959566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GpuToCpu Count: total number of GPU to CPU copies per processor\n")); 16969566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GpuToCpu Size (Mbytes): 10e-6 * (total size of GPU to CPU copies per processor)\n")); 16979566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, " GPU %%F: percent flops on GPU in this event\n")); 1698bec0b493Shannah_mairs #endif 16999566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n")); 17005c6c1daeSBarry Smith 17019566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm,fd)); 17025c6c1daeSBarry Smith 17035c6c1daeSBarry Smith /* Report events */ 17049566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd,"Event Count Time (sec) Flop --- Global --- --- Stage ---- Total")); 1705e3ed9ee7SBarry Smith if (PetscLogMemory) { 17069566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd," Malloc EMalloc MMalloc RMI")); 1707e3ed9ee7SBarry Smith } 1708d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17099566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd," GPU - CpuToGpu - - GpuToCpu - GPU")); 1710bec0b493Shannah_mairs #endif 17119566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd,"\n")); 17129566063dSJacob 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")); 1713e3ed9ee7SBarry Smith if (PetscLogMemory) { 17149566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd," Mbytes Mbytes Mbytes Mbytes")); 1715e3ed9ee7SBarry Smith } 1716d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17179566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd," Mflop/s Count Size Count Size %%F")); 1718bec0b493Shannah_mairs #endif 17199566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd,"\n")); 17209566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd,"------------------------------------------------------------------------------------------------------------------------")); 17214863603aSSatish Balay if (PetscLogMemory) { 17229566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd,"-----------------------------")); 17234863603aSSatish Balay } 1724d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17259566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd,"---------------------------------------")); 17264863603aSSatish Balay #endif 17279566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd,"\n")); 17285c6c1daeSBarry Smith 1729156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1730156b51fbSBarry Smith /* this indirect way of accessing these values is needed when PETSc is build with multiple libraries since the symbols are not in libpetscsys */ 1731156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "TAOSolve", &TAO_Solve)); 1732156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "TSStep", &TS_Step)); 1733156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "SNESSolve", &SNES_Solve)); 1734156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, "KSPSolve", &KSP_Solve)); 1735156b51fbSBarry Smith #endif 1736156b51fbSBarry Smith 17375c6c1daeSBarry Smith /* Problem: The stage name will not show up unless the stage executed on proc 1 */ 17385c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 17395c6c1daeSBarry Smith if (!stageVisible[stage]) continue; 1740820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 17415c6c1daeSBarry Smith if (localStageUsed[stage]) { 17429566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name)); 17439566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17449566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17459566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17469566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17479566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17485c6c1daeSBarry Smith } else { 17499566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage)); 17509566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17519566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17529566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17539566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17549566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17555c6c1daeSBarry Smith } 17565c6c1daeSBarry Smith mess *= 0.5; messLen *= 0.5; red /= size; 17575c6c1daeSBarry Smith 17585c6c1daeSBarry Smith /* Get total number of events in this stage -- 17595c6c1daeSBarry Smith Currently, a single processor can register more events than another, but events must all be registered in order, 17605c6c1daeSBarry Smith just like stages. We can removed this requirement if necessary by having a global event numbering and indirection 1761217044c2SLisandro Dalcin on the event ID. This seems best accomplished by associating a communicator with each stage. 17625c6c1daeSBarry Smith 17635c6c1daeSBarry Smith Problem: If the event did not happen on proc 1, its name will not be available. 17645c6c1daeSBarry Smith Problem: Event visibility is not implemented 17655c6c1daeSBarry Smith */ 17665c6c1daeSBarry Smith if (localStageUsed[stage]) { 17675c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo; 17685c6c1daeSBarry Smith localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents; 1769a297a907SKarl Rupp } else localNumEvents = 0; 17709566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm)); 17715c6c1daeSBarry Smith for (event = 0; event < numEvents; event++) { 1772820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 17735c6c1daeSBarry Smith if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) { 1774217044c2SLisandro Dalcin if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; else flopr = 0.0; 17759566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 17769566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 17779566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17789566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 17799566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 17809566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17819566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17829566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17839566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17849566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].count, &minC, 1, MPI_INT, MPI_MIN, comm)); 17859566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].count, &maxC, 1, MPI_INT, MPI_MAX, comm)); 1786e3ed9ee7SBarry Smith if (PetscLogMemory) { 17879566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].memIncrease, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17889566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocSpace, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17899566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocIncrease, &malmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17909566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1791e3ed9ee7SBarry Smith } 1792d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 17939566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].CpuToGpuCount, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17949566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuToCpuCount, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17959566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].CpuToGpuSize, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17969566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuToCpuSize, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17979566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuFlops, &gflops,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 17989566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&eventInfo[event].GpuTime, &gmaxt ,1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 1799bec0b493Shannah_mairs #endif 18005c6c1daeSBarry Smith name = stageLog->eventLog->eventInfo[event].name; 18015c6c1daeSBarry Smith } else { 18025c6c1daeSBarry Smith flopr = 0.0; 18039566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18049566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18059566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18069566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm)); 18079566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 18089566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18099566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18109566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18119566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18129566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&ierr, &minC, 1, MPI_INT, MPI_MIN, comm)); 18139566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&ierr, &maxC, 1, MPI_INT, MPI_MAX, comm)); 1814e3ed9ee7SBarry Smith if (PetscLogMemory) { 18159566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18169566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18179566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18189566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 1819e3ed9ee7SBarry Smith } 1820d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 18219566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18229566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18239566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18249566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18259566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm)); 18269566063dSJacob Faibussowitsch PetscCallMPI(MPI_Allreduce(&zero, &gmaxt , 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm)); 1827bec0b493Shannah_mairs #endif 18285c6c1daeSBarry Smith name = ""; 18295c6c1daeSBarry Smith } 18305c6c1daeSBarry Smith if (mint < 0.0) { 1831d0609cedSBarry 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)); 18325c6c1daeSBarry Smith mint = 0; 18335c6c1daeSBarry Smith } 183408401ef6SPierre 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); 1835156b51fbSBarry Smith /* Put NaN into the time for all events that may not be time accurately since they may happen asynchronously on the GPU */ 1836156b51fbSBarry Smith #if defined(PETSC_HAVE_DEVICE) 1837156b51fbSBarry Smith if (!PetscLogGpuTimeFlag && petsc_gflops > 0) { 1838156b51fbSBarry Smith memcpy(&gmaxt,&nas,sizeof(PetscLogDouble)); 1839156b51fbSBarry Smith PetscCall(PetscEventRegLogGetEvent(stageLog->eventLog, name, &eventid)); 1840156b51fbSBarry Smith if (eventid != SNES_Solve && eventid != KSP_Solve && eventid != TS_Step && eventid != TAO_Solve) { 1841156b51fbSBarry Smith memcpy(&mint,&nas,sizeof(PetscLogDouble)); 1842156b51fbSBarry Smith memcpy(&maxt,&nas,sizeof(PetscLogDouble)); 1843156b51fbSBarry Smith } 1844156b51fbSBarry Smith } 1845156b51fbSBarry Smith #endif 18465c6c1daeSBarry Smith totm *= 0.5; totml *= 0.5; totr /= size; 18475c6c1daeSBarry Smith 1848217044c2SLisandro Dalcin if (maxC != 0) { 1849217044c2SLisandro Dalcin if (minC != 0) ratC = ((PetscLogDouble)maxC)/minC;else ratC = 0.0; 18505c6c1daeSBarry Smith if (mint != 0.0) ratt = maxt/mint; else ratt = 0.0; 18515c6c1daeSBarry Smith if (minf != 0.0) ratf = maxf/minf; else ratf = 0.0; 18525c6c1daeSBarry Smith if (TotalTime != 0.0) fracTime = tott/TotalTime; else fracTime = 0.0; 18535c6c1daeSBarry Smith if (TotalFlops != 0.0) fracFlops = totf/TotalFlops; else fracFlops = 0.0; 18545c6c1daeSBarry Smith if (stageTime != 0.0) fracStageTime = tott/stageTime; else fracStageTime = 0.0; 18555c6c1daeSBarry Smith if (flops != 0.0) fracStageFlops = totf/flops; else fracStageFlops = 0.0; 18565c6c1daeSBarry Smith if (numMessages != 0.0) fracMess = totm/numMessages; else fracMess = 0.0; 18575c6c1daeSBarry Smith if (messageLength != 0.0) fracMessLen = totml/messageLength; else fracMessLen = 0.0; 18585c6c1daeSBarry Smith if (numReductions != 0.0) fracRed = totr/numReductions; else fracRed = 0.0; 18595c6c1daeSBarry Smith if (mess != 0.0) fracStageMess = totm/mess; else fracStageMess = 0.0; 18605c6c1daeSBarry Smith if (messLen != 0.0) fracStageMessLen = totml/messLen; else fracStageMessLen = 0.0; 18615c6c1daeSBarry Smith if (red != 0.0) fracStageRed = totr/red; else fracStageRed = 0.0; 18625c6c1daeSBarry Smith if (totm != 0.0) totml /= totm; else totml = 0.0; 18635c6c1daeSBarry Smith if (maxt != 0.0) flopr = totf/maxt; else flopr = 0.0; 18649566063dSJacob Faibussowitsch if (fracStageTime > 1.00) PetscCall(PetscFPrintf(comm, fd,"Warning -- total time of event greater than time of entire stage -- something is wrong with the timer\n")); 1865d0609cedSBarry Smith PetscCall(PetscFPrintf(comm, fd, 1866e3ed9ee7SBarry Smith "%-16s %7d%4.1f %5.4e%4.1f %3.2e%4.1f %2.1e %2.1e %2.1e%3.0f%3.0f%3.0f%3.0f%3.0f %3.0f%3.0f%3.0f%3.0f%3.0f %5.0f", 1867217044c2SLisandro Dalcin name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr, 18685c6c1daeSBarry Smith 100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed, 18695c6c1daeSBarry Smith 100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed, 1870d0609cedSBarry Smith PetscAbs(flopr)/1.0e6)); 1871e3ed9ee7SBarry Smith if (PetscLogMemory) { 18729566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd," %5.0f %5.0f %5.0f %5.0f",mal/1.0e6,emalmax/1.0e6,malmax/1.0e6,mem/1.0e6)); 1873e3ed9ee7SBarry Smith } 1874d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1875958c4211Shannah_mairs if (totf != 0.0) fracgflops = gflops/totf; else fracgflops = 0.0; 1876958c4211Shannah_mairs if (gmaxt != 0.0) gflopr = gflops/gmaxt; else gflopr = 0.0; 18779566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd," %5.0f %4.0f %3.2e %4.0f %3.2e% 3.0f",PetscAbs(gflopr)/1.0e6,cct/size,csz/(1.0e6*size),gct/size,gsz/(1.0e6*size),100.0*fracgflops)); 1878bec0b493Shannah_mairs #endif 18799566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd,"\n")); 18805c6c1daeSBarry Smith } 18815c6c1daeSBarry Smith } 18825c6c1daeSBarry Smith } 18835c6c1daeSBarry Smith 18845c6c1daeSBarry Smith /* Memory usage and object creation */ 18859566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------")); 18864863603aSSatish Balay if (PetscLogMemory) { 18879566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "-----------------------------")); 18884863603aSSatish Balay } 1889d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 18909566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "---------------------------------------")); 18914863603aSSatish Balay #endif 18929566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 18939566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 18949566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n")); 18955c6c1daeSBarry Smith 18965c6c1daeSBarry Smith /* Right now, only stages on the first processor are reported here, meaning only objects associated with 18975c6c1daeSBarry Smith the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then 18985c6c1daeSBarry Smith stats for stages local to processor sets. 18995c6c1daeSBarry Smith */ 19005c6c1daeSBarry Smith /* We should figure out the longest object name here (now 20 characters) */ 19019566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Object Type Creations Destructions Memory Descendants' Mem.\n")); 19029566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Reports information only for process 0.\n")); 19035c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 19045c6c1daeSBarry Smith if (localStageUsed[stage]) { 19055c6c1daeSBarry Smith classInfo = stageLog->stageInfo[stage].classLog->classInfo; 19069566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name)); 19075c6c1daeSBarry Smith for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) { 19085c6c1daeSBarry Smith if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) { 1909d0609cedSBarry Smith PetscCall(PetscFPrintf(comm, fd, "%20s %5d %5d %11.0f %g\n", stageLog->classLog->classInfo[oclass].name, 19105c6c1daeSBarry Smith classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem, 1911d0609cedSBarry Smith classInfo[oclass].descMem)); 19125c6c1daeSBarry Smith } 19135c6c1daeSBarry Smith } 19145c6c1daeSBarry Smith } else { 1915cf019ec6SStefano Zampini if (!localStageVisible[stage]) continue; 19169566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage)); 19175c6c1daeSBarry Smith } 19185c6c1daeSBarry Smith } 19195c6c1daeSBarry Smith 19209566063dSJacob Faibussowitsch PetscCall(PetscFree(localStageUsed)); 19219566063dSJacob Faibussowitsch PetscCall(PetscFree(stageUsed)); 19229566063dSJacob Faibussowitsch PetscCall(PetscFree(localStageVisible)); 19239566063dSJacob Faibussowitsch PetscCall(PetscFree(stageVisible)); 19245c6c1daeSBarry Smith 19255c6c1daeSBarry Smith /* Information unrelated to this particular run */ 19269566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "========================================================================================================================\n")); 19278563dfccSBarry Smith PetscTime(&y); 19288563dfccSBarry Smith PetscTime(&x); 19298563dfccSBarry Smith PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 19308563dfccSBarry Smith PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 19319566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0)); 19325c6c1daeSBarry Smith /* MPI information */ 19335c6c1daeSBarry Smith if (size > 1) { 19345c6c1daeSBarry Smith MPI_Status status; 19355c6c1daeSBarry Smith PetscMPIInt tag; 19365c6c1daeSBarry Smith MPI_Comm newcomm; 19375c6c1daeSBarry Smith 19389566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19398563dfccSBarry Smith PetscTime(&x); 19409566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19419566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19429566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19439566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19449566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19458563dfccSBarry Smith PetscTime(&y); 19469566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0)); 19479566063dSJacob Faibussowitsch PetscCall(PetscCommDuplicate(comm,&newcomm, &tag)); 19489566063dSJacob Faibussowitsch PetscCallMPI(MPI_Barrier(comm)); 19495c6c1daeSBarry Smith if (rank) { 19509566063dSJacob Faibussowitsch PetscCallMPI(MPI_Recv(NULL, 0, MPI_INT, rank-1, tag, newcomm, &status)); 19519566063dSJacob Faibussowitsch PetscCallMPI(MPI_Send(NULL, 0, MPI_INT, (rank+1)%size, tag, newcomm)); 19525c6c1daeSBarry Smith } else { 19538563dfccSBarry Smith PetscTime(&x); 19549566063dSJacob Faibussowitsch PetscCallMPI(MPI_Send(NULL, 0, MPI_INT, 1, tag, newcomm)); 19559566063dSJacob Faibussowitsch PetscCallMPI(MPI_Recv(NULL, 0, MPI_INT, size-1, tag, newcomm, &status)); 19568563dfccSBarry Smith PetscTime(&y); 19579566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size)); 19585c6c1daeSBarry Smith } 19599566063dSJacob Faibussowitsch PetscCall(PetscCommDestroy(&newcomm)); 19605c6c1daeSBarry Smith } 19619566063dSJacob Faibussowitsch PetscCall(PetscOptionsView(NULL,viewer)); 19625c6c1daeSBarry Smith 19635c6c1daeSBarry Smith /* Machine and compile information */ 19645c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS) 19659566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n")); 19665c6c1daeSBarry Smith #else 19679566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n")); 19685c6c1daeSBarry Smith #endif 1969217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) 19709566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n")); 1971217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128) 19729566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n")); 1973217044c2SLisandro Dalcin #endif 19745c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 19759566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n")); 19765f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128) 19779566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n")); 19785c6c1daeSBarry Smith #endif 19795c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE) 19809566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with single precision matrices\n")); 19815c6c1daeSBarry Smith #else 19829566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n")); 19835c6c1daeSBarry Smith #endif 1984d0609cedSBarry Smith PetscCall(PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n", 1985d0609cedSBarry Smith (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt))); 19865c6c1daeSBarry Smith 19879566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions)); 19889566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petscmachineinfo)); 19899566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsccompilerinfo)); 19909566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo)); 19919566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "%s", petsclinkerinfo)); 19925c6c1daeSBarry Smith 19935c6c1daeSBarry Smith /* Cleanup */ 19949566063dSJacob Faibussowitsch PetscCall(PetscFPrintf(comm, fd, "\n")); 19959566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnNoGpuAwareMpi(comm,fd)); 19969566063dSJacob Faibussowitsch PetscCall(PetscLogViewWarnDebugging(comm,fd)); 1997156b51fbSBarry Smith PetscCall(PetscFPTrapPop()); 19985c6c1daeSBarry Smith PetscFunctionReturn(0); 19995c6c1daeSBarry Smith } 20005c6c1daeSBarry Smith 20017d6c928cSSatish Balay /*@C 20027d6c928cSSatish Balay PetscLogView - Prints a summary of the logging. 20035c6c1daeSBarry Smith 20045c6c1daeSBarry Smith Collective over MPI_Comm 20055c6c1daeSBarry Smith 20065c6c1daeSBarry Smith Input Parameter: 2007f14045dbSBarry Smith . viewer - an ASCII viewer 20085c6c1daeSBarry Smith 20095c6c1daeSBarry Smith Options Database Keys: 2010bb1d7374SBarry Smith + -log_view [:filename] - Prints summary of log information 2011bb1d7374SBarry Smith . -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file 2012607d249eSBarry 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) 2013d0a29bd7SConnor 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) 2014156b51fbSBarry Smith . -log_view_memory - Also display memory usage in each event 2015156b51fbSBarry Smith . -log_view_gpu_time - Also display time in each event for GPU kernels (Note this may slow the computation) 2016bb1d7374SBarry Smith . -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation 2017bb1d7374SBarry Smith - -log_trace [filename] - Displays a trace of what each process is doing 20185c6c1daeSBarry Smith 20195c6c1daeSBarry Smith Notes: 2020bb1d7374SBarry Smith It is possible to control the logging programatically but we recommend using the options database approach whenever possible 20215c6c1daeSBarry Smith By default the summary is printed to stdout. 20225c6c1daeSBarry Smith 2023bb1d7374SBarry Smith Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin() 2024bb1d7374SBarry Smith 2025bb1d7374SBarry Smith If PETSc is configured with --with-logging=0 then this functionality is not available 2026bb1d7374SBarry Smith 2027607d249eSBarry Smith To view the nested XML format filename.xml first copy ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current 2028607d249eSBarry Smith directory then open filename.xml with your browser. Specific notes for certain browsers 2029607d249eSBarry Smith $ Firefox and Internet explorer - simply open the file 2030607d249eSBarry Smith $ Google Chrome - you must start up Chrome with the option --allow-file-access-from-files 2031a8d69d7bSBarry Smith $ Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access 2032607d249eSBarry 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 2033607d249eSBarry Smith your browser. 20342add09c0SLisandro Dalcin Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser 20352add09c0SLisandro Dalcin window and render the XML log file contents. 2036607d249eSBarry Smith 2037bb1d7374SBarry Smith The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij MARITIME RESEARCH INSTITUTE NETHERLANDS 2038bb1d7374SBarry Smith 2039d0a29bd7SConnor Ward The Flame Graph output can be visualised using either the original Flame Graph script (https://github.com/brendangregg/FlameGraph) 2040d0a29bd7SConnor Ward or using speedscope (https://www.speedscope.app). 2041d0a29bd7SConnor Ward Old XML profiles may be converted into this format using the script ${PETSC_DIR}/lib/petsc/bin/xml2flamegraph.py. 2042d0a29bd7SConnor Ward 20435c6c1daeSBarry Smith Level: beginner 20445c6c1daeSBarry Smith 2045db781477SPatrick Sanan .seealso: `PetscLogDefaultBegin()`, `PetscLogDump()` 20465c6c1daeSBarry Smith @*/ 2047f14045dbSBarry Smith PetscErrorCode PetscLogView(PetscViewer viewer) 20485c6c1daeSBarry Smith { 2049f14045dbSBarry Smith PetscBool isascii; 2050f14045dbSBarry Smith PetscViewerFormat format; 205137b78d16SBarry Smith int stage, lastStage; 205237b78d16SBarry Smith PetscStageLog stageLog; 20535c6c1daeSBarry Smith 20545c6c1daeSBarry Smith PetscFunctionBegin; 205528b400f6SJacob Faibussowitsch PetscCheck(PetscLogPLB,PETSC_COMM_SELF,PETSC_ERR_SUP,"Must use -log_view or PetscLogDefaultBegin() before calling this routine"); 205637b78d16SBarry Smith /* Pop off any stages the user forgot to remove */ 205737b78d16SBarry Smith lastStage = 0; 20589566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 20599566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 206037b78d16SBarry Smith while (stage >= 0) { 206137b78d16SBarry Smith lastStage = stage; 20629566063dSJacob Faibussowitsch PetscCall(PetscStageLogPop(stageLog)); 20639566063dSJacob Faibussowitsch PetscCall(PetscStageLogGetCurrent(stageLog, &stage)); 206437b78d16SBarry Smith } 20659566063dSJacob Faibussowitsch PetscCall(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii)); 206628b400f6SJacob Faibussowitsch PetscCheck(isascii,PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Currently can only view logging to ASCII"); 20679566063dSJacob Faibussowitsch PetscCall(PetscViewerGetFormat(viewer,&format)); 2068f14045dbSBarry Smith if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) { 20699566063dSJacob Faibussowitsch PetscCall(PetscLogView_Default(viewer)); 2070f14045dbSBarry Smith } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) { 20719566063dSJacob Faibussowitsch PetscCall(PetscLogView_Detailed(viewer)); 207238144912Sdeepblu2718 } else if (format == PETSC_VIEWER_ASCII_CSV) { 20739566063dSJacob Faibussowitsch PetscCall(PetscLogView_CSV(viewer)); 2074bb1d7374SBarry Smith } else if (format == PETSC_VIEWER_ASCII_XML) { 20759566063dSJacob Faibussowitsch PetscCall(PetscLogView_Nested(viewer)); 2076d0a29bd7SConnor Ward } else if (format == PETSC_VIEWER_ASCII_FLAMEGRAPH) { 20779566063dSJacob Faibussowitsch PetscCall(PetscLogView_Flamegraph(viewer)); 20785c6c1daeSBarry Smith } 20799566063dSJacob Faibussowitsch PetscCall(PetscStageLogPush(stageLog, lastStage)); 20805c6c1daeSBarry Smith PetscFunctionReturn(0); 20815c6c1daeSBarry Smith } 20825c6c1daeSBarry Smith 2083f14045dbSBarry Smith /*@C 2084f14045dbSBarry Smith PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed. 2085f14045dbSBarry Smith 2086f14045dbSBarry Smith Collective on PETSC_COMM_WORLD 2087f14045dbSBarry Smith 2088f14045dbSBarry Smith Not normally called by user 2089f14045dbSBarry Smith 2090f14045dbSBarry Smith Level: intermediate 2091f14045dbSBarry Smith 2092f14045dbSBarry Smith @*/ 2093f14045dbSBarry Smith PetscErrorCode PetscLogViewFromOptions(void) 2094f14045dbSBarry Smith { 2095f14045dbSBarry Smith PetscViewer viewer; 2096f14045dbSBarry Smith PetscBool flg; 2097f14045dbSBarry Smith PetscViewerFormat format; 2098f14045dbSBarry Smith 2099f14045dbSBarry Smith PetscFunctionBegin; 21009566063dSJacob Faibussowitsch PetscCall(PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-log_view",&viewer,&format,&flg)); 2101f14045dbSBarry Smith if (flg) { 21029566063dSJacob Faibussowitsch PetscCall(PetscViewerPushFormat(viewer,format)); 21039566063dSJacob Faibussowitsch PetscCall(PetscLogView(viewer)); 21049566063dSJacob Faibussowitsch PetscCall(PetscViewerPopFormat(viewer)); 21059566063dSJacob Faibussowitsch PetscCall(PetscViewerDestroy(&viewer)); 2106f14045dbSBarry Smith } 2107f14045dbSBarry Smith PetscFunctionReturn(0); 2108f14045dbSBarry Smith } 2109f14045dbSBarry Smith 21105c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/ 21115c6c1daeSBarry Smith /*@C 21125c6c1daeSBarry Smith PetscGetFlops - Returns the number of flops used on this processor 21135c6c1daeSBarry Smith since the program began. 21145c6c1daeSBarry Smith 21155c6c1daeSBarry Smith Not Collective 21165c6c1daeSBarry Smith 21175c6c1daeSBarry Smith Output Parameter: 21185c6c1daeSBarry Smith flops - number of floating point operations 21195c6c1daeSBarry Smith 21205c6c1daeSBarry Smith Notes: 21215c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 21225c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 21235c6c1daeSBarry Smith application code. 21245c6c1daeSBarry Smith 21255c6c1daeSBarry Smith Level: intermediate 21265c6c1daeSBarry Smith 2127db781477SPatrick Sanan .seealso: `PetscTime()`, `PetscLogFlops()` 21285c6c1daeSBarry Smith @*/ 21295c6c1daeSBarry Smith PetscErrorCode PetscGetFlops(PetscLogDouble *flops) 21305c6c1daeSBarry Smith { 21315c6c1daeSBarry Smith PetscFunctionBegin; 21325c6c1daeSBarry Smith *flops = petsc_TotalFlops; 21335c6c1daeSBarry Smith PetscFunctionReturn(0); 21345c6c1daeSBarry Smith } 21355c6c1daeSBarry Smith 21365c6c1daeSBarry Smith PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 21375c6c1daeSBarry Smith { 21385c6c1daeSBarry Smith size_t fullLength; 21395c6c1daeSBarry Smith va_list Argp; 21405c6c1daeSBarry Smith 21415c6c1daeSBarry Smith PetscFunctionBegin; 21425c6c1daeSBarry Smith if (!petsc_logObjects) PetscFunctionReturn(0); 21435c6c1daeSBarry Smith va_start(Argp, format); 21449566063dSJacob Faibussowitsch PetscCall(PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp)); 21455c6c1daeSBarry Smith va_end(Argp); 21465c6c1daeSBarry Smith PetscFunctionReturn(0); 21475c6c1daeSBarry Smith } 21485c6c1daeSBarry Smith 21495c6c1daeSBarry Smith /*MC 21505c6c1daeSBarry Smith PetscLogFlops - Adds floating point operations to the global counter. 21515c6c1daeSBarry Smith 21525c6c1daeSBarry Smith Synopsis: 2153aaa7dc30SBarry Smith #include <petsclog.h> 21545c6c1daeSBarry Smith PetscErrorCode PetscLogFlops(PetscLogDouble f) 21555c6c1daeSBarry Smith 21565c6c1daeSBarry Smith Not Collective 21575c6c1daeSBarry Smith 21585c6c1daeSBarry Smith Input Parameter: 21595c6c1daeSBarry Smith . f - flop counter 21605c6c1daeSBarry Smith 21615c6c1daeSBarry Smith Usage: 21625c6c1daeSBarry Smith .vb 21635c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 21645c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 21655c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 21665c6c1daeSBarry Smith [code segment to monitor] 21675c6c1daeSBarry Smith PetscLogFlops(user_flops) 21685c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 21695c6c1daeSBarry Smith .ve 21705c6c1daeSBarry Smith 21715c6c1daeSBarry Smith Notes: 21725c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 21735c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 21745c6c1daeSBarry Smith application code. 21755c6c1daeSBarry Smith 21765c6c1daeSBarry Smith Level: intermediate 21775c6c1daeSBarry Smith 2178db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscGetFlops()` 21795c6c1daeSBarry Smith 21805c6c1daeSBarry Smith M*/ 21815c6c1daeSBarry Smith 21825c6c1daeSBarry Smith /*MC 21835c6c1daeSBarry Smith PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice) 21845c6c1daeSBarry Smith to get accurate timings 21855c6c1daeSBarry Smith 21865c6c1daeSBarry Smith Synopsis: 2187aaa7dc30SBarry Smith #include <petsclog.h> 21885c6c1daeSBarry Smith void PetscPreLoadBegin(PetscBool flag,char *name); 21895c6c1daeSBarry Smith 21905c6c1daeSBarry Smith Not Collective 21915c6c1daeSBarry Smith 2192d8d19677SJose E. Roman Input Parameters: 21935c6c1daeSBarry Smith + flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden 21945c6c1daeSBarry Smith with command line option -preload true or -preload false 2195609bdbeeSBarry Smith - name - name of first stage (lines of code timed separately with -log_view) to 21965c6c1daeSBarry Smith be preloaded 21975c6c1daeSBarry Smith 21985c6c1daeSBarry Smith Usage: 21995c6c1daeSBarry Smith .vb 22005c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22015c6c1daeSBarry Smith lines of code 22025c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22035c6c1daeSBarry Smith lines of code 22045c6c1daeSBarry Smith PetscPreLoadEnd(); 22055c6c1daeSBarry Smith .ve 22065c6c1daeSBarry Smith 220795452b02SPatrick Sanan Notes: 220895452b02SPatrick Sanan Only works in C/C++, not Fortran 22095c6c1daeSBarry Smith 22105c6c1daeSBarry Smith Flags available within the macro. 22115c6c1daeSBarry Smith + PetscPreLoadingUsed - true if we are or have done preloading 22125c6c1daeSBarry Smith . PetscPreLoadingOn - true if it is CURRENTLY doing preload 22135c6c1daeSBarry Smith . PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second 22145c6c1daeSBarry Smith - PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on 22155c6c1daeSBarry Smith The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin() 22165c6c1daeSBarry Smith and PetscPreLoadEnd() 22175c6c1daeSBarry Smith 22185c6c1daeSBarry Smith Level: intermediate 22195c6c1daeSBarry Smith 2220db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadEnd()`, `PetscPreLoadStage()` 22215c6c1daeSBarry Smith 22225c6c1daeSBarry Smith M*/ 22235c6c1daeSBarry Smith 22245c6c1daeSBarry Smith /*MC 22255c6c1daeSBarry Smith PetscPreLoadEnd - End a segment of code that may be preloaded (run twice) 22265c6c1daeSBarry Smith to get accurate timings 22275c6c1daeSBarry Smith 22285c6c1daeSBarry Smith Synopsis: 2229aaa7dc30SBarry Smith #include <petsclog.h> 22305c6c1daeSBarry Smith void PetscPreLoadEnd(void); 22315c6c1daeSBarry Smith 22325c6c1daeSBarry Smith Not Collective 22335c6c1daeSBarry Smith 22345c6c1daeSBarry Smith Usage: 22355c6c1daeSBarry Smith .vb 22365c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22375c6c1daeSBarry Smith lines of code 22385c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22395c6c1daeSBarry Smith lines of code 22405c6c1daeSBarry Smith PetscPreLoadEnd(); 22415c6c1daeSBarry Smith .ve 22425c6c1daeSBarry Smith 224395452b02SPatrick Sanan Notes: 224495452b02SPatrick Sanan only works in C/C++ not fortran 22455c6c1daeSBarry Smith 22465c6c1daeSBarry Smith Level: intermediate 22475c6c1daeSBarry Smith 2248db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadStage()` 22495c6c1daeSBarry Smith 22505c6c1daeSBarry Smith M*/ 22515c6c1daeSBarry Smith 22525c6c1daeSBarry Smith /*MC 22535c6c1daeSBarry Smith PetscPreLoadStage - Start a new segment of code to be timed separately. 22545c6c1daeSBarry Smith to get accurate timings 22555c6c1daeSBarry Smith 22565c6c1daeSBarry Smith Synopsis: 2257aaa7dc30SBarry Smith #include <petsclog.h> 22585c6c1daeSBarry Smith void PetscPreLoadStage(char *name); 22595c6c1daeSBarry Smith 22605c6c1daeSBarry Smith Not Collective 22615c6c1daeSBarry Smith 22625c6c1daeSBarry Smith Usage: 22635c6c1daeSBarry Smith .vb 22645c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22655c6c1daeSBarry Smith lines of code 22665c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22675c6c1daeSBarry Smith lines of code 22685c6c1daeSBarry Smith PetscPreLoadEnd(); 22695c6c1daeSBarry Smith .ve 22705c6c1daeSBarry Smith 227195452b02SPatrick Sanan Notes: 227295452b02SPatrick Sanan only works in C/C++ not fortran 22735c6c1daeSBarry Smith 22745c6c1daeSBarry Smith Level: intermediate 22755c6c1daeSBarry Smith 2276db781477SPatrick Sanan .seealso: `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscPreLoadBegin()`, `PetscPreLoadEnd()` 22775c6c1daeSBarry Smith 22785c6c1daeSBarry Smith M*/ 22795c6c1daeSBarry Smith 2280a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_DEVICE) 2281a4af0ceeSJacob Faibussowitsch #include <petsc/private/deviceimpl.h> 22829ffd0706SHong Zhang 2283156b51fbSBarry Smith PetscBool PetscLogGpuTimeFlag = PETSC_FALSE; 2284156b51fbSBarry Smith 2285156b51fbSBarry Smith /* 2286156b51fbSBarry Smith This cannot be called by users between PetscInitialize() and PetscFinalize() at any random location in the code 2287156b51fbSBarry Smith because it will result in timing results that cannot be interpreted. 2288156b51fbSBarry Smith */ 2289156b51fbSBarry Smith static PetscErrorCode PetscLogGpuTime_Off(void) 2290156b51fbSBarry Smith { 2291156b51fbSBarry Smith PetscLogGpuTimeFlag = PETSC_FALSE; 2292156b51fbSBarry Smith return 0; 2293156b51fbSBarry Smith } 2294156b51fbSBarry Smith 2295156b51fbSBarry Smith /*@C 2296156b51fbSBarry Smith PetscLogGpuTime - turn on the logging of GPU time for GPU kernels 2297156b51fbSBarry Smith 2298156b51fbSBarry Smith Options Database: 2299156b51fbSBarry Smith . -log_view_gpu_time - provide the GPU times in the -log_view output 2300156b51fbSBarry Smith 2301156b51fbSBarry Smith Notes: 2302156b51fbSBarry Smith Because the logging of GPU time requires blocking the CPU execution for each kernel, turning on the timing of the 2303156b51fbSBarry Smith GPU kernels can slow down the entire computation and should only be used when studying the performance 2304156b51fbSBarry Smith of operations on GPU such as vector operations and matrix-vector operations. 2305156b51fbSBarry Smith 2306156b51fbSBarry Smith This routine should only be called once near the beginning of the program. Once it is started it cannot be turned off. 2307156b51fbSBarry Smith 23080f8f8846SPatrick Sanan Level: advanced 23090f8f8846SPatrick Sanan 2310db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuTimeBegin()` 2311156b51fbSBarry Smith @*/ 2312156b51fbSBarry Smith PetscErrorCode PetscLogGpuTime(void) 2313156b51fbSBarry Smith { 2314156b51fbSBarry Smith if (!PetscLogGpuTimeFlag) PetscCall(PetscRegisterFinalize(PetscLogGpuTime_Off)); 2315156b51fbSBarry Smith PetscLogGpuTimeFlag = PETSC_TRUE; 2316156b51fbSBarry Smith return 0; 2317156b51fbSBarry Smith } 2318156b51fbSBarry Smith 23199ffd0706SHong Zhang /*@C 23209ffd0706SHong Zhang PetscLogGpuTimeBegin - Start timer for device 23219ffd0706SHong Zhang 23229ffd0706SHong Zhang Notes: 23239ffd0706SHong 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). 23249ffd0706SHong 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). 23259ffd0706SHong Zhang There is no need to call WaitForCUDA() or WaitForHIP() between PetscLogGpuTimeBegin and PetscLogGpuTimeEnd 23269ffd0706SHong Zhang This timer should NOT include times for data transfers between the GPU and CPU, nor setup actions such as allocating space. 23279ffd0706SHong Zhang The regular logging captures the time for data transfers and any CPU activites during the event 23289ffd0706SHong Zhang It is used to compute the flop rate on the GPU as it is actively engaged in running a kernel. 23299ffd0706SHong Zhang 23309ffd0706SHong Zhang Developer Notes: 23319ffd0706SHong Zhang The GPU event timer captures the execution time of all the kernels launched in the default stream by the CPU between PetscLogGpuTimeBegin() and PetsLogGpuTimeEnd(). 23329ffd0706SHong Zhang PetscLogGpuTimeBegin() and PetsLogGpuTimeEnd() insert the begin and end events into the default stream (stream 0). The device will record a time stamp for the event when it reaches that event in the stream. The function xxxEventSynchronize() is called in PetsLogGpuTimeEnd() to block CPU execution, but not continued GPU excution, until the timer event is recorded. 23339ffd0706SHong Zhang 23349ffd0706SHong Zhang Level: intermediate 23359ffd0706SHong Zhang 2336db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuTime()` 23379ffd0706SHong Zhang @*/ 23389ffd0706SHong Zhang PetscErrorCode PetscLogGpuTimeBegin(void) 23399ffd0706SHong Zhang { 23409ffd0706SHong Zhang PetscFunctionBegin; 2341156b51fbSBarry Smith if (!PetscLogPLB || !PetscLogGpuTimeFlag) PetscFunctionReturn(0); 2342a4af0ceeSJacob Faibussowitsch if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) { 2343a4af0ceeSJacob Faibussowitsch PetscDeviceContext dctx; 2344a4af0ceeSJacob Faibussowitsch 23459566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextGetCurrentContext(&dctx)); 23469566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextBeginTimer_Internal(dctx)); 2347a4af0ceeSJacob Faibussowitsch } else { 23489566063dSJacob Faibussowitsch PetscCall(PetscTimeSubtract(&petsc_gtime)); 2349a4af0ceeSJacob Faibussowitsch } 23509ffd0706SHong Zhang PetscFunctionReturn(0); 23519ffd0706SHong Zhang } 23529ffd0706SHong Zhang 23539ffd0706SHong Zhang /*@C 23549ffd0706SHong Zhang PetscLogGpuTimeEnd - Stop timer for device 23559ffd0706SHong Zhang 23569ffd0706SHong Zhang Level: intermediate 23579ffd0706SHong Zhang 2358db781477SPatrick Sanan .seealso: `PetscLogView()`, `PetscLogGpuFlops()`, `PetscLogGpuTimeBegin()` 23599ffd0706SHong Zhang @*/ 23609ffd0706SHong Zhang PetscErrorCode PetscLogGpuTimeEnd(void) 23619ffd0706SHong Zhang { 23629ffd0706SHong Zhang PetscFunctionBegin; 2363156b51fbSBarry Smith if (!PetscLogPLE || !PetscLogGpuTimeFlag) PetscFunctionReturn(0); 2364a4af0ceeSJacob Faibussowitsch if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) { 2365a4af0ceeSJacob Faibussowitsch PetscDeviceContext dctx; 2366a4af0ceeSJacob Faibussowitsch PetscLogDouble elapsed; 2367a4af0ceeSJacob Faibussowitsch 23689566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextGetCurrentContext(&dctx)); 23699566063dSJacob Faibussowitsch PetscCall(PetscDeviceContextEndTimer_Internal(dctx,&elapsed)); 2370a4af0ceeSJacob Faibussowitsch petsc_gtime += (elapsed/1000.0); 2371a4af0ceeSJacob Faibussowitsch } else { 23729566063dSJacob Faibussowitsch PetscCall(PetscTimeAdd(&petsc_gtime)); 2373a4af0ceeSJacob Faibussowitsch } 23749ffd0706SHong Zhang PetscFunctionReturn(0); 23759ffd0706SHong Zhang } 23769ffd0706SHong Zhang #endif /* end of PETSC_HAVE_DEVICE */ 23779ffd0706SHong Zhang 23785c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */ 23795c6c1daeSBarry Smith 23805c6c1daeSBarry Smith PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 23815c6c1daeSBarry Smith { 23825c6c1daeSBarry Smith PetscFunctionBegin; 23835c6c1daeSBarry Smith PetscFunctionReturn(0); 23845c6c1daeSBarry Smith } 23855c6c1daeSBarry Smith 23865c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/ 23875c6c1daeSBarry Smith 23885c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 23895c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID = 0; 23905c6c1daeSBarry Smith 23915c6c1daeSBarry Smith /*@C 23925c6c1daeSBarry Smith PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code. 23935c6c1daeSBarry Smith 23945c6c1daeSBarry Smith Not Collective 23955c6c1daeSBarry Smith 23965c6c1daeSBarry Smith Input Parameter: 23975c6c1daeSBarry Smith . name - The class name 23985c6c1daeSBarry Smith 23995c6c1daeSBarry Smith Output Parameter: 24005c6c1daeSBarry Smith . oclass - The class id or classid 24015c6c1daeSBarry Smith 24025c6c1daeSBarry Smith Level: developer 24035c6c1daeSBarry Smith 24045c6c1daeSBarry Smith @*/ 24055c6c1daeSBarry Smith PetscErrorCode PetscClassIdRegister(const char name[],PetscClassId *oclass) 24065c6c1daeSBarry Smith { 24075c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 24085c6c1daeSBarry Smith PetscStageLog stageLog; 24095c6c1daeSBarry Smith PetscInt stage; 24105c6c1daeSBarry Smith #endif 24115c6c1daeSBarry Smith 24125c6c1daeSBarry Smith PetscFunctionBegin; 24135c6c1daeSBarry Smith *oclass = ++PETSC_LARGEST_CLASSID; 24145c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 24159566063dSJacob Faibussowitsch PetscCall(PetscLogGetStageLog(&stageLog)); 24169566063dSJacob Faibussowitsch PetscCall(PetscClassRegLogRegister(stageLog->classLog, name, *oclass)); 24175c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 24189566063dSJacob Faibussowitsch PetscCall(PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses)); 24195c6c1daeSBarry Smith } 24205c6c1daeSBarry Smith #endif 24215c6c1daeSBarry Smith PetscFunctionReturn(0); 24225c6c1daeSBarry Smith } 2423210b5426SBarry Smith 2424210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE) 2425210b5426SBarry Smith #include <mpe.h> 2426210b5426SBarry Smith 2427210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE; 2428210b5426SBarry Smith 2429495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2430495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2431495fc317SBarry Smith 2432210b5426SBarry Smith /*@C 2433210b5426SBarry Smith PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files 2434210b5426SBarry Smith and slows the program down. 2435210b5426SBarry Smith 2436210b5426SBarry Smith Collective over PETSC_COMM_WORLD 2437210b5426SBarry Smith 2438210b5426SBarry Smith Options Database Keys: 2439a2553e36SBarry Smith . -log_mpe - Prints extensive log information 2440210b5426SBarry Smith 2441210b5426SBarry Smith Notes: 2442609bdbeeSBarry Smith A related routine is PetscLogDefaultBegin() (with the options key -log_view), which is 2443210b5426SBarry Smith intended for production runs since it logs only flop rates and object 2444210b5426SBarry Smith creation (and should not significantly slow the programs). 2445210b5426SBarry Smith 2446210b5426SBarry Smith Level: advanced 2447210b5426SBarry Smith 2448db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogDefaultBegin()`, `PetscLogAllBegin()`, `PetscLogEventActivate()`, 2449db781477SPatrick Sanan `PetscLogEventDeactivate()` 2450210b5426SBarry Smith @*/ 2451210b5426SBarry Smith PetscErrorCode PetscLogMPEBegin(void) 2452210b5426SBarry Smith { 2453210b5426SBarry Smith PetscFunctionBegin; 2454210b5426SBarry Smith /* Do MPE initialization */ 2455210b5426SBarry Smith if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */ 24569566063dSJacob Faibussowitsch PetscCall(PetscInfo(0,"Initializing MPE.\n")); 24579566063dSJacob Faibussowitsch PetscCall(MPE_Init_log()); 2458210b5426SBarry Smith 2459210b5426SBarry Smith PetscBeganMPE = PETSC_TRUE; 2460210b5426SBarry Smith } else { 24619566063dSJacob Faibussowitsch PetscCall(PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n")); 2462210b5426SBarry Smith } 24639566063dSJacob Faibussowitsch PetscCall(PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE)); 2464210b5426SBarry Smith PetscFunctionReturn(0); 2465210b5426SBarry Smith } 2466210b5426SBarry Smith 2467210b5426SBarry Smith /*@C 2468495fc317SBarry Smith PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot. 2469210b5426SBarry Smith 2470210b5426SBarry Smith Collective over PETSC_COMM_WORLD 2471210b5426SBarry Smith 2472210b5426SBarry Smith Level: advanced 2473210b5426SBarry Smith 2474db781477SPatrick Sanan .seealso: `PetscLogDump()`, `PetscLogAllBegin()`, `PetscLogMPEBegin()` 2475210b5426SBarry Smith @*/ 2476210b5426SBarry Smith PetscErrorCode PetscLogMPEDump(const char sname[]) 2477210b5426SBarry Smith { 2478210b5426SBarry Smith char name[PETSC_MAX_PATH_LEN]; 2479210b5426SBarry Smith 2480210b5426SBarry Smith PetscFunctionBegin; 2481210b5426SBarry Smith if (PetscBeganMPE) { 24829566063dSJacob Faibussowitsch PetscCall(PetscInfo(0,"Finalizing MPE.\n")); 2483210b5426SBarry Smith if (sname) { 24849566063dSJacob Faibussowitsch PetscCall(PetscStrcpy(name,sname)); 2485210b5426SBarry Smith } else { 24869566063dSJacob Faibussowitsch PetscCall(PetscGetProgramName(name,sizeof(name))); 2487210b5426SBarry Smith } 24889566063dSJacob Faibussowitsch PetscCall(MPE_Finish_log(name)); 2489210b5426SBarry Smith } else { 24909566063dSJacob Faibussowitsch PetscCall(PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n")); 2491210b5426SBarry Smith } 2492210b5426SBarry Smith PetscFunctionReturn(0); 2493210b5426SBarry Smith } 2494210b5426SBarry Smith 2495210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39 2496210b5426SBarry Smith static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = { 2497210b5426SBarry Smith "OliveDrab: ", 2498210b5426SBarry Smith "BlueViolet: ", 2499210b5426SBarry Smith "CadetBlue: ", 2500210b5426SBarry Smith "CornflowerBlue: ", 2501210b5426SBarry Smith "DarkGoldenrod: ", 2502210b5426SBarry Smith "DarkGreen: ", 2503210b5426SBarry Smith "DarkKhaki: ", 2504210b5426SBarry Smith "DarkOliveGreen: ", 2505210b5426SBarry Smith "DarkOrange: ", 2506210b5426SBarry Smith "DarkOrchid: ", 2507210b5426SBarry Smith "DarkSeaGreen: ", 2508210b5426SBarry Smith "DarkSlateGray: ", 2509210b5426SBarry Smith "DarkTurquoise: ", 2510210b5426SBarry Smith "DeepPink: ", 2511210b5426SBarry Smith "DarkKhaki: ", 2512210b5426SBarry Smith "DimGray: ", 2513210b5426SBarry Smith "DodgerBlue: ", 2514210b5426SBarry Smith "GreenYellow: ", 2515210b5426SBarry Smith "HotPink: ", 2516210b5426SBarry Smith "IndianRed: ", 2517210b5426SBarry Smith "LavenderBlush: ", 2518210b5426SBarry Smith "LawnGreen: ", 2519210b5426SBarry Smith "LemonChiffon: ", 2520210b5426SBarry Smith "LightCoral: ", 2521210b5426SBarry Smith "LightCyan: ", 2522210b5426SBarry Smith "LightPink: ", 2523210b5426SBarry Smith "LightSalmon: ", 2524210b5426SBarry Smith "LightSlateGray: ", 2525210b5426SBarry Smith "LightYellow: ", 2526210b5426SBarry Smith "LimeGreen: ", 2527210b5426SBarry Smith "MediumPurple: ", 2528210b5426SBarry Smith "MediumSeaGreen: ", 2529210b5426SBarry Smith "MediumSlateBlue:", 2530210b5426SBarry Smith "MidnightBlue: ", 2531210b5426SBarry Smith "MintCream: ", 2532210b5426SBarry Smith "MistyRose: ", 2533210b5426SBarry Smith "NavajoWhite: ", 2534210b5426SBarry Smith "NavyBlue: ", 2535210b5426SBarry Smith "OliveDrab: " 2536210b5426SBarry Smith }; 2537210b5426SBarry Smith 2538210b5426SBarry Smith /*@C 2539210b5426SBarry Smith PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister() 2540210b5426SBarry Smith 2541210b5426SBarry Smith Not collective. Maybe it should be? 2542210b5426SBarry Smith 25437a7aea1fSJed Brown Output Parameter: 2544210b5426SBarry Smith . str - character string representing the color 2545210b5426SBarry Smith 2546210b5426SBarry Smith Level: developer 2547210b5426SBarry Smith 2548db781477SPatrick Sanan .seealso: `PetscLogEventRegister` 2549210b5426SBarry Smith @*/ 2550210b5426SBarry Smith PetscErrorCode PetscLogMPEGetRGBColor(const char *str[]) 2551210b5426SBarry Smith { 2552210b5426SBarry Smith static int idx = 0; 2553210b5426SBarry Smith 2554210b5426SBarry Smith PetscFunctionBegin; 2555210b5426SBarry Smith *str = PetscLogMPERGBColors[idx]; 2556210b5426SBarry Smith idx = (idx + 1)% PETSC_RGB_COLORS_MAX; 2557210b5426SBarry Smith PetscFunctionReturn(0); 2558210b5426SBarry Smith } 2559210b5426SBarry Smith 2560210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */ 2561