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 37bb72fc59SBarry Smith .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 */ 88*45c4b7c1SBarry Smith PetscLogDouble petsc_ctog_ct_scalar = 0.0; /* The total number of CPU to GPU copies */ 89*45c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_ct_scalar = 0.0; /* The total number of GPU to CPU copies */ 90*45c4b7c1SBarry Smith PetscLogDouble petsc_ctog_sz_scalar = 0.0; /* The total size of CPU to GPU copies */ 91*45c4b7c1SBarry 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 */ 949ffd0706SHong Zhang 958df2f0b1SJunchao Zhang #if defined(PETSC_USE_DEBUG) 968df2f0b1SJunchao Zhang PetscBool petsc_gtime_inuse = PETSC_FALSE; 978df2f0b1SJunchao Zhang #endif 98bec0b493Shannah_mairs #endif 995c6c1daeSBarry Smith 1005c6c1daeSBarry Smith /* Logging functions */ 1010298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL; 1020298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL; 1030298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 1040298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 1055c6c1daeSBarry Smith 1065c6c1daeSBarry Smith /* Tracing event logging variables */ 1070298fd71SBarry Smith FILE *petsc_tracefile = NULL; 1085c6c1daeSBarry Smith int petsc_tracelevel = 0; 1095c6c1daeSBarry Smith const char *petsc_traceblanks = " "; 1105c6c1daeSBarry Smith char petsc_tracespace[128] = " "; 1115c6c1daeSBarry Smith PetscLogDouble petsc_tracetime = 0.0; 112896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE; 1135c6c1daeSBarry Smith 11495c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogInitialize(void) 115fa2bb9feSLisandro Dalcin { 116fa2bb9feSLisandro Dalcin int stage; 117fa2bb9feSLisandro Dalcin PetscBool opt; 118fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 1195c6c1daeSBarry Smith 120fa2bb9feSLisandro Dalcin PetscFunctionBegin; 121fa2bb9feSLisandro Dalcin if (PetscLogInitializeCalled) PetscFunctionReturn(0); 122fa2bb9feSLisandro Dalcin PetscLogInitializeCalled = PETSC_TRUE; 1235c6c1daeSBarry Smith 124fa2bb9feSLisandro Dalcin ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_actions", &opt);CHKERRQ(ierr); 125fa2bb9feSLisandro Dalcin if (opt) petsc_logActions = PETSC_FALSE; 126fa2bb9feSLisandro Dalcin ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_objects", &opt);CHKERRQ(ierr); 127fa2bb9feSLisandro Dalcin if (opt) petsc_logObjects = PETSC_FALSE; 128fa2bb9feSLisandro Dalcin if (petsc_logActions) { 129fa2bb9feSLisandro Dalcin ierr = PetscMalloc1(petsc_maxActions, &petsc_actions);CHKERRQ(ierr); 130fa2bb9feSLisandro Dalcin } 131fa2bb9feSLisandro Dalcin if (petsc_logObjects) { 132fa2bb9feSLisandro Dalcin ierr = PetscMalloc1(petsc_maxObjects, &petsc_objects);CHKERRQ(ierr); 133fa2bb9feSLisandro Dalcin } 134fa2bb9feSLisandro Dalcin PetscLogPHC = PetscLogObjCreateDefault; 135fa2bb9feSLisandro Dalcin PetscLogPHD = PetscLogObjDestroyDefault; 136fa2bb9feSLisandro Dalcin /* Setup default logging structures */ 137fa2bb9feSLisandro Dalcin ierr = PetscStageLogCreate(&petsc_stageLog);CHKERRQ(ierr); 138fa2bb9feSLisandro Dalcin ierr = PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage);CHKERRQ(ierr); 1395c6c1daeSBarry Smith 140fa2bb9feSLisandro Dalcin /* All processors sync here for more consistent logging */ 141ffc4695bSBarry Smith ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRMPI(ierr); 142fa2bb9feSLisandro Dalcin PetscTime(&petsc_BaseTime); 143fa2bb9feSLisandro Dalcin ierr = PetscLogStagePush(stage);CHKERRQ(ierr); 144fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 145fa2bb9feSLisandro Dalcin } 1465c6c1daeSBarry Smith 14795c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogFinalize(void) 1485c6c1daeSBarry Smith { 1495c6c1daeSBarry Smith PetscStageLog stageLog; 1505c6c1daeSBarry Smith PetscErrorCode ierr; 1515c6c1daeSBarry Smith 1525c6c1daeSBarry Smith PetscFunctionBegin; 1535c6c1daeSBarry Smith ierr = PetscFree(petsc_actions);CHKERRQ(ierr); 1545c6c1daeSBarry Smith ierr = PetscFree(petsc_objects);CHKERRQ(ierr); 155eccbb886SLisandro Dalcin ierr = PetscLogNestedEnd();CHKERRQ(ierr); 1560298fd71SBarry Smith ierr = PetscLogSet(NULL, NULL);CHKERRQ(ierr); 1575c6c1daeSBarry Smith 1585c6c1daeSBarry Smith /* Resetting phase */ 1595c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1605c6c1daeSBarry Smith ierr = PetscStageLogDestroy(stageLog);CHKERRQ(ierr); 161a297a907SKarl Rupp 1625c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1635c6c1daeSBarry Smith petsc_numActions = 0; 1645c6c1daeSBarry Smith petsc_numObjects = 0; 1655c6c1daeSBarry Smith petsc_numObjectsDestroyed = 0; 1665c6c1daeSBarry Smith petsc_maxActions = 100; 1675c6c1daeSBarry Smith petsc_maxObjects = 100; 1680298fd71SBarry Smith petsc_actions = NULL; 1690298fd71SBarry Smith petsc_objects = NULL; 1705c6c1daeSBarry Smith petsc_logActions = PETSC_FALSE; 1715c6c1daeSBarry Smith petsc_logObjects = PETSC_FALSE; 1725c6c1daeSBarry Smith petsc_BaseTime = 0.0; 1735c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1745c6c1daeSBarry Smith petsc_tmp_flops = 0.0; 1755c6c1daeSBarry Smith petsc_send_ct = 0.0; 1765c6c1daeSBarry Smith petsc_recv_ct = 0.0; 1775c6c1daeSBarry Smith petsc_send_len = 0.0; 1785c6c1daeSBarry Smith petsc_recv_len = 0.0; 1795c6c1daeSBarry Smith petsc_isend_ct = 0.0; 1805c6c1daeSBarry Smith petsc_irecv_ct = 0.0; 1815c6c1daeSBarry Smith petsc_isend_len = 0.0; 1825c6c1daeSBarry Smith petsc_irecv_len = 0.0; 1835c6c1daeSBarry Smith petsc_wait_ct = 0.0; 1845c6c1daeSBarry Smith petsc_wait_any_ct = 0.0; 1855c6c1daeSBarry Smith petsc_wait_all_ct = 0.0; 1865c6c1daeSBarry Smith petsc_sum_of_waits_ct = 0.0; 1875c6c1daeSBarry Smith petsc_allreduce_ct = 0.0; 1885c6c1daeSBarry Smith petsc_gather_ct = 0.0; 1895c6c1daeSBarry Smith petsc_scatter_ct = 0.0; 190d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 191bec0b493Shannah_mairs petsc_ctog_ct = 0.0; 192bec0b493Shannah_mairs petsc_gtoc_ct = 0.0; 193bec0b493Shannah_mairs petsc_ctog_sz = 0.0; 194bec0b493Shannah_mairs petsc_gtoc_sz = 0.0; 195958c4211Shannah_mairs petsc_gflops = 0.0; 196958c4211Shannah_mairs petsc_gtime = 0.0; 197bec0b493Shannah_mairs #endif 1985c6c1daeSBarry Smith PETSC_LARGEST_EVENT = PETSC_EVENT; 1990298fd71SBarry Smith PetscLogPHC = NULL; 2000298fd71SBarry Smith PetscLogPHD = NULL; 2010298fd71SBarry Smith petsc_tracefile = NULL; 2025c6c1daeSBarry Smith petsc_tracelevel = 0; 2035c6c1daeSBarry Smith petsc_traceblanks = " "; 2045c6c1daeSBarry Smith petsc_tracespace[0] = ' '; petsc_tracespace[1] = 0; 2055c6c1daeSBarry Smith petsc_tracetime = 0.0; 2065c6c1daeSBarry Smith PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 2075c6c1daeSBarry Smith PETSC_OBJECT_CLASSID = 0; 20802c9f0b5SLisandro Dalcin petsc_stageLog = NULL; 209896238b9SBarry Smith PetscLogInitializeCalled = PETSC_FALSE; 2105c6c1daeSBarry Smith PetscFunctionReturn(0); 2115c6c1daeSBarry Smith } 2125c6c1daeSBarry Smith 2135c6c1daeSBarry Smith /*@C 2145c6c1daeSBarry Smith PetscLogSet - Sets the logging functions called at the beginning and ending of every event. 2155c6c1daeSBarry Smith 2165c6c1daeSBarry Smith Not Collective 2175c6c1daeSBarry Smith 2185c6c1daeSBarry Smith Input Parameters: 2195c6c1daeSBarry Smith + b - The function called at beginning of event 2205c6c1daeSBarry Smith - e - The function called at end of event 2215c6c1daeSBarry Smith 2225c6c1daeSBarry Smith Level: developer 2235c6c1daeSBarry Smith 224bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogTraceBegin() 2255c6c1daeSBarry Smith @*/ 2265c6c1daeSBarry Smith PetscErrorCode PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), 2275c6c1daeSBarry Smith PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject)) 2285c6c1daeSBarry Smith { 2295c6c1daeSBarry Smith PetscFunctionBegin; 2305c6c1daeSBarry Smith PetscLogPLB = b; 2315c6c1daeSBarry Smith PetscLogPLE = e; 2325c6c1daeSBarry Smith PetscFunctionReturn(0); 2335c6c1daeSBarry Smith } 2345c6c1daeSBarry Smith 2355c6c1daeSBarry Smith /*@C 236bb1d7374SBarry Smith PetscLogDefaultBegin - Turns on logging of objects and events. This logs flop 2375c6c1daeSBarry Smith rates and object creation and should not slow programs down too much. 2385c6c1daeSBarry Smith This routine may be called more than once. 2395c6c1daeSBarry Smith 2405c6c1daeSBarry Smith Logically Collective over PETSC_COMM_WORLD 2415c6c1daeSBarry Smith 2425c6c1daeSBarry Smith Options Database Keys: 243a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the 244a2553e36SBarry Smith screen (for code configured with --with-log=1 (which is the default)) 2455c6c1daeSBarry Smith 2465c6c1daeSBarry Smith Usage: 2475c6c1daeSBarry Smith .vb 2485c6c1daeSBarry Smith PetscInitialize(...); 249bb1d7374SBarry Smith PetscLogDefaultBegin(); 2505c6c1daeSBarry Smith ... code ... 2515c6c1daeSBarry Smith PetscLogView(viewer); or PetscLogDump(); 2525c6c1daeSBarry Smith PetscFinalize(); 2535c6c1daeSBarry Smith .ve 2545c6c1daeSBarry Smith 2555c6c1daeSBarry Smith Notes: 2565c6c1daeSBarry Smith PetscLogView(viewer) or PetscLogDump() actually cause the printing of 2575c6c1daeSBarry Smith the logging information. 2585c6c1daeSBarry Smith 2595c6c1daeSBarry Smith Level: advanced 2605c6c1daeSBarry Smith 2615c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogTraceBegin() 2625c6c1daeSBarry Smith @*/ 263bb1d7374SBarry Smith PetscErrorCode PetscLogDefaultBegin(void) 2645c6c1daeSBarry Smith { 2655c6c1daeSBarry Smith PetscErrorCode ierr; 2665c6c1daeSBarry Smith 2675c6c1daeSBarry Smith PetscFunctionBegin; 2685c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault);CHKERRQ(ierr); 2695c6c1daeSBarry Smith PetscFunctionReturn(0); 2705c6c1daeSBarry Smith } 2715c6c1daeSBarry Smith 2725c6c1daeSBarry Smith /*@C 2735c6c1daeSBarry Smith PetscLogAllBegin - Turns on extensive logging of objects and events. Logs 2745c6c1daeSBarry Smith all events. This creates large log files and slows the program down. 2755c6c1daeSBarry Smith 2765c6c1daeSBarry Smith Logically Collective on PETSC_COMM_WORLD 2775c6c1daeSBarry Smith 2785c6c1daeSBarry Smith Options Database Keys: 279a2553e36SBarry Smith . -log_all - Prints extensive log information 2805c6c1daeSBarry Smith 2815c6c1daeSBarry Smith Usage: 2825c6c1daeSBarry Smith .vb 2835c6c1daeSBarry Smith PetscInitialize(...); 2845c6c1daeSBarry Smith PetscLogAllBegin(); 2855c6c1daeSBarry Smith ... code ... 2865c6c1daeSBarry Smith PetscLogDump(filename); 2875c6c1daeSBarry Smith PetscFinalize(); 2885c6c1daeSBarry Smith .ve 2895c6c1daeSBarry Smith 2905c6c1daeSBarry Smith Notes: 291bb1d7374SBarry Smith A related routine is PetscLogDefaultBegin() (with the options key -log), which is 2925c6c1daeSBarry Smith intended for production runs since it logs only flop rates and object 2935c6c1daeSBarry Smith creation (and shouldn't significantly slow the programs). 2945c6c1daeSBarry Smith 2955c6c1daeSBarry Smith Level: advanced 2965c6c1daeSBarry Smith 297bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogTraceBegin() 2985c6c1daeSBarry Smith @*/ 2995c6c1daeSBarry Smith PetscErrorCode PetscLogAllBegin(void) 3005c6c1daeSBarry Smith { 3015c6c1daeSBarry Smith PetscErrorCode ierr; 3025c6c1daeSBarry Smith 3035c6c1daeSBarry Smith PetscFunctionBegin; 3045c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete);CHKERRQ(ierr); 3055c6c1daeSBarry Smith PetscFunctionReturn(0); 3065c6c1daeSBarry Smith } 3075c6c1daeSBarry Smith 308956f8c0dSBarry Smith /*@C 3095c6c1daeSBarry Smith PetscLogTraceBegin - Activates trace logging. Every time a PETSc event 3105c6c1daeSBarry Smith begins or ends, the event name is printed. 3115c6c1daeSBarry Smith 3125c6c1daeSBarry Smith Logically Collective on PETSC_COMM_WORLD 3135c6c1daeSBarry Smith 3145c6c1daeSBarry Smith Input Parameter: 3155c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout) 3165c6c1daeSBarry Smith 3175c6c1daeSBarry Smith Options Database Key: 3185c6c1daeSBarry Smith . -log_trace [filename] - Activates PetscLogTraceBegin() 3195c6c1daeSBarry Smith 3205c6c1daeSBarry Smith Notes: 3215c6c1daeSBarry Smith PetscLogTraceBegin() prints the processor number, the execution time (sec), 3225c6c1daeSBarry Smith then "Event begin:" or "Event end:" followed by the event name. 3235c6c1daeSBarry Smith 3245c6c1daeSBarry Smith PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful 3255c6c1daeSBarry Smith to determine where a program is hanging without running in the 3265c6c1daeSBarry Smith debugger. Can be used in conjunction with the -info option. 3275c6c1daeSBarry Smith 3285c6c1daeSBarry Smith Level: intermediate 3295c6c1daeSBarry Smith 330bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogDefaultBegin() 3315c6c1daeSBarry Smith @*/ 3325c6c1daeSBarry Smith PetscErrorCode PetscLogTraceBegin(FILE *file) 3335c6c1daeSBarry Smith { 3345c6c1daeSBarry Smith PetscErrorCode ierr; 3355c6c1daeSBarry Smith 3365c6c1daeSBarry Smith PetscFunctionBegin; 3375c6c1daeSBarry Smith petsc_tracefile = file; 338a297a907SKarl Rupp 3395c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace);CHKERRQ(ierr); 3405c6c1daeSBarry Smith PetscFunctionReturn(0); 3415c6c1daeSBarry Smith } 3425c6c1daeSBarry Smith 3435c6c1daeSBarry Smith /*@ 3445c6c1daeSBarry Smith PetscLogActions - Determines whether actions are logged for the graphical viewer. 3455c6c1daeSBarry Smith 3465c6c1daeSBarry Smith Not Collective 3475c6c1daeSBarry Smith 3485c6c1daeSBarry Smith Input Parameter: 3495c6c1daeSBarry Smith . flag - PETSC_TRUE if actions are to be logged 3505c6c1daeSBarry Smith 3515c6c1daeSBarry Smith Level: intermediate 3525c6c1daeSBarry Smith 3535c6c1daeSBarry Smith Note: Logging of actions continues to consume more memory as the program 3545c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3555c6c1daeSBarry Smith 3565c6c1daeSBarry Smith Options Database Keys: 3575c6c1daeSBarry Smith . -log_exclude_actions - Turns off actions logging 3585c6c1daeSBarry Smith 3595c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 3605c6c1daeSBarry Smith @*/ 3615c6c1daeSBarry Smith PetscErrorCode PetscLogActions(PetscBool flag) 3625c6c1daeSBarry Smith { 3635c6c1daeSBarry Smith PetscFunctionBegin; 3645c6c1daeSBarry Smith petsc_logActions = flag; 3655c6c1daeSBarry Smith PetscFunctionReturn(0); 3665c6c1daeSBarry Smith } 3675c6c1daeSBarry Smith 3685c6c1daeSBarry Smith /*@ 3695c6c1daeSBarry Smith PetscLogObjects - Determines whether objects are logged for the graphical viewer. 3705c6c1daeSBarry Smith 3715c6c1daeSBarry Smith Not Collective 3725c6c1daeSBarry Smith 3735c6c1daeSBarry Smith Input Parameter: 3745c6c1daeSBarry Smith . flag - PETSC_TRUE if objects are to be logged 3755c6c1daeSBarry Smith 3765c6c1daeSBarry Smith Level: intermediate 3775c6c1daeSBarry Smith 3785c6c1daeSBarry Smith Note: Logging of objects continues to consume more memory as the program 3795c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3805c6c1daeSBarry Smith 3815c6c1daeSBarry Smith Options Database Keys: 3825c6c1daeSBarry Smith . -log_exclude_objects - Turns off objects logging 3835c6c1daeSBarry Smith 3845c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 3855c6c1daeSBarry Smith @*/ 3865c6c1daeSBarry Smith PetscErrorCode PetscLogObjects(PetscBool flag) 3875c6c1daeSBarry Smith { 3885c6c1daeSBarry Smith PetscFunctionBegin; 3895c6c1daeSBarry Smith petsc_logObjects = flag; 3905c6c1daeSBarry Smith PetscFunctionReturn(0); 3915c6c1daeSBarry Smith } 3925c6c1daeSBarry Smith 3935c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/ 3945c6c1daeSBarry Smith /*@C 39574c0405dSRichard Tran Mills PetscLogStageRegister - Attaches a character string name to a logging stage. 3965c6c1daeSBarry Smith 3975c6c1daeSBarry Smith Not Collective 3985c6c1daeSBarry Smith 3995c6c1daeSBarry Smith Input Parameter: 4005c6c1daeSBarry Smith . sname - The name to associate with that stage 4015c6c1daeSBarry Smith 4025c6c1daeSBarry Smith Output Parameter: 4035c6c1daeSBarry Smith . stage - The stage number 4045c6c1daeSBarry Smith 4055c6c1daeSBarry Smith Level: intermediate 4065c6c1daeSBarry Smith 4075c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 4085c6c1daeSBarry Smith @*/ 4095c6c1daeSBarry Smith PetscErrorCode PetscLogStageRegister(const char sname[],PetscLogStage *stage) 4105c6c1daeSBarry Smith { 4115c6c1daeSBarry Smith PetscStageLog stageLog; 4125c6c1daeSBarry Smith PetscLogEvent event; 4135c6c1daeSBarry Smith PetscErrorCode ierr; 4145c6c1daeSBarry Smith 4155c6c1daeSBarry Smith PetscFunctionBegin; 4165c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 4175c6c1daeSBarry Smith ierr = PetscStageLogRegister(stageLog, sname, stage);CHKERRQ(ierr); 4185c6c1daeSBarry Smith /* Copy events already changed in the main stage, this sucks */ 4193a88037aSBarry Smith ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr); 4205c6c1daeSBarry Smith for (event = 0; event < stageLog->eventLog->numEvents; event++) { 4213a88037aSBarry Smith ierr = PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event],&stageLog->stageInfo[*stage].eventLog->eventInfo[event]);CHKERRQ(ierr); 4225c6c1daeSBarry Smith } 4233a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 4245c6c1daeSBarry Smith PetscFunctionReturn(0); 4255c6c1daeSBarry Smith } 4265c6c1daeSBarry Smith 4275c6c1daeSBarry Smith /*@C 4285c6c1daeSBarry Smith PetscLogStagePush - This function pushes a stage on the stack. 4295c6c1daeSBarry Smith 4305c6c1daeSBarry Smith Not Collective 4315c6c1daeSBarry Smith 4325c6c1daeSBarry Smith Input Parameter: 4335c6c1daeSBarry Smith . stage - The stage on which to log 4345c6c1daeSBarry Smith 4355c6c1daeSBarry Smith Usage: 4365c6c1daeSBarry Smith If the option -log_sumary is used to run the program containing the 4375c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4385c6c1daeSBarry Smith PetscFinalize(). 4395c6c1daeSBarry Smith .vb 4405c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4415c6c1daeSBarry Smith [stage 0 of code] 4425c6c1daeSBarry Smith PetscLogStagePush(1); 4435c6c1daeSBarry Smith [stage 1 of code] 4445c6c1daeSBarry Smith PetscLogStagePop(); 4455c6c1daeSBarry Smith PetscBarrier(...); 4465c6c1daeSBarry Smith [more stage 0 of code] 4475c6c1daeSBarry Smith PetscFinalize(); 4485c6c1daeSBarry Smith .ve 4495c6c1daeSBarry Smith 4505c6c1daeSBarry Smith Notes: 4515c6c1daeSBarry Smith Use PetscLogStageRegister() to register a stage. 4525c6c1daeSBarry Smith 4535c6c1daeSBarry Smith Level: intermediate 4545c6c1daeSBarry Smith 4555c6c1daeSBarry Smith .seealso: PetscLogStagePop(), PetscLogStageRegister(), PetscBarrier() 4565c6c1daeSBarry Smith @*/ 4575c6c1daeSBarry Smith PetscErrorCode PetscLogStagePush(PetscLogStage stage) 4585c6c1daeSBarry Smith { 4595c6c1daeSBarry Smith PetscStageLog stageLog; 4605c6c1daeSBarry Smith PetscErrorCode ierr; 4615c6c1daeSBarry Smith 4625c6c1daeSBarry Smith PetscFunctionBegin; 4635c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 4645c6c1daeSBarry Smith ierr = PetscStageLogPush(stageLog, stage);CHKERRQ(ierr); 4655c6c1daeSBarry Smith PetscFunctionReturn(0); 4665c6c1daeSBarry Smith } 4675c6c1daeSBarry Smith 4685c6c1daeSBarry Smith /*@C 4695c6c1daeSBarry Smith PetscLogStagePop - This function pops a stage from the stack. 4705c6c1daeSBarry Smith 4715c6c1daeSBarry Smith Not Collective 4725c6c1daeSBarry Smith 4735c6c1daeSBarry Smith Usage: 4745c6c1daeSBarry Smith If the option -log_sumary is used to run the program containing the 4755c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4765c6c1daeSBarry Smith PetscFinalize(). 4775c6c1daeSBarry Smith .vb 4785c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4795c6c1daeSBarry Smith [stage 0 of code] 4805c6c1daeSBarry Smith PetscLogStagePush(1); 4815c6c1daeSBarry Smith [stage 1 of code] 4825c6c1daeSBarry Smith PetscLogStagePop(); 4835c6c1daeSBarry Smith PetscBarrier(...); 4845c6c1daeSBarry Smith [more stage 0 of code] 4855c6c1daeSBarry Smith PetscFinalize(); 4865c6c1daeSBarry Smith .ve 4875c6c1daeSBarry Smith 4885c6c1daeSBarry Smith Notes: 4895c6c1daeSBarry Smith Use PetscLogStageRegister() to register a stage. 4905c6c1daeSBarry Smith 4915c6c1daeSBarry Smith Level: intermediate 4925c6c1daeSBarry Smith 4935c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStageRegister(), PetscBarrier() 4945c6c1daeSBarry Smith @*/ 4955c6c1daeSBarry Smith PetscErrorCode PetscLogStagePop(void) 4965c6c1daeSBarry Smith { 4975c6c1daeSBarry Smith PetscStageLog stageLog; 4985c6c1daeSBarry Smith PetscErrorCode ierr; 4995c6c1daeSBarry Smith 5005c6c1daeSBarry Smith PetscFunctionBegin; 5015c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5025c6c1daeSBarry Smith ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 5035c6c1daeSBarry Smith PetscFunctionReturn(0); 5045c6c1daeSBarry Smith } 5055c6c1daeSBarry Smith 5065c6c1daeSBarry Smith /*@ 5075c6c1daeSBarry Smith PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 5085c6c1daeSBarry Smith 5095c6c1daeSBarry Smith Not Collective 5105c6c1daeSBarry Smith 5115c6c1daeSBarry Smith Input Parameters: 5125c6c1daeSBarry Smith + stage - The stage 5135c6c1daeSBarry Smith - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 5145c6c1daeSBarry Smith 5155c6c1daeSBarry Smith Level: intermediate 5165c6c1daeSBarry Smith 5175c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 5185c6c1daeSBarry Smith @*/ 5195c6c1daeSBarry Smith PetscErrorCode PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive) 5205c6c1daeSBarry Smith { 5215c6c1daeSBarry Smith PetscStageLog stageLog; 5225c6c1daeSBarry Smith PetscErrorCode ierr; 5235c6c1daeSBarry Smith 5245c6c1daeSBarry Smith PetscFunctionBegin; 5255c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5265c6c1daeSBarry Smith ierr = PetscStageLogSetActive(stageLog, stage, isActive);CHKERRQ(ierr); 5275c6c1daeSBarry Smith PetscFunctionReturn(0); 5285c6c1daeSBarry Smith } 5295c6c1daeSBarry Smith 5305c6c1daeSBarry Smith /*@ 5315c6c1daeSBarry Smith PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 5325c6c1daeSBarry Smith 5335c6c1daeSBarry Smith Not Collective 5345c6c1daeSBarry Smith 5355c6c1daeSBarry Smith Input Parameter: 5365c6c1daeSBarry Smith . stage - The stage 5375c6c1daeSBarry Smith 5385c6c1daeSBarry Smith Output Parameter: 5395c6c1daeSBarry Smith . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 5405c6c1daeSBarry Smith 5415c6c1daeSBarry Smith Level: intermediate 5425c6c1daeSBarry Smith 5435c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 5445c6c1daeSBarry Smith @*/ 5455c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetActive(PetscLogStage stage, PetscBool *isActive) 5465c6c1daeSBarry Smith { 5475c6c1daeSBarry Smith PetscStageLog stageLog; 5485c6c1daeSBarry Smith PetscErrorCode ierr; 5495c6c1daeSBarry Smith 5505c6c1daeSBarry Smith PetscFunctionBegin; 5515c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5525c6c1daeSBarry Smith ierr = PetscStageLogGetActive(stageLog, stage, isActive);CHKERRQ(ierr); 5535c6c1daeSBarry Smith PetscFunctionReturn(0); 5545c6c1daeSBarry Smith } 5555c6c1daeSBarry Smith 5565c6c1daeSBarry Smith /*@ 5575c6c1daeSBarry Smith PetscLogStageSetVisible - Determines stage visibility in PetscLogView() 5585c6c1daeSBarry Smith 5595c6c1daeSBarry Smith Not Collective 5605c6c1daeSBarry Smith 5615c6c1daeSBarry Smith Input Parameters: 5625c6c1daeSBarry Smith + stage - The stage 5635c6c1daeSBarry Smith - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 5645c6c1daeSBarry Smith 5655c6c1daeSBarry Smith Level: intermediate 5665c6c1daeSBarry Smith 5675c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView() 5685c6c1daeSBarry Smith @*/ 5695c6c1daeSBarry Smith PetscErrorCode PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible) 5705c6c1daeSBarry Smith { 5715c6c1daeSBarry Smith PetscStageLog stageLog; 5725c6c1daeSBarry Smith PetscErrorCode ierr; 5735c6c1daeSBarry Smith 5745c6c1daeSBarry Smith PetscFunctionBegin; 5755c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5765c6c1daeSBarry Smith ierr = PetscStageLogSetVisible(stageLog, stage, isVisible);CHKERRQ(ierr); 5775c6c1daeSBarry Smith PetscFunctionReturn(0); 5785c6c1daeSBarry Smith } 5795c6c1daeSBarry Smith 5805c6c1daeSBarry Smith /*@ 5815c6c1daeSBarry Smith PetscLogStageGetVisible - Returns stage visibility in PetscLogView() 5825c6c1daeSBarry Smith 5835c6c1daeSBarry Smith Not Collective 5845c6c1daeSBarry Smith 5855c6c1daeSBarry Smith Input Parameter: 5865c6c1daeSBarry Smith . stage - The stage 5875c6c1daeSBarry Smith 5885c6c1daeSBarry Smith Output Parameter: 5895c6c1daeSBarry Smith . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 5905c6c1daeSBarry Smith 5915c6c1daeSBarry Smith Level: intermediate 5925c6c1daeSBarry Smith 5935c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView() 5945c6c1daeSBarry Smith @*/ 5955c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetVisible(PetscLogStage stage, PetscBool *isVisible) 5965c6c1daeSBarry Smith { 5975c6c1daeSBarry Smith PetscStageLog stageLog; 5985c6c1daeSBarry Smith PetscErrorCode ierr; 5995c6c1daeSBarry Smith 6005c6c1daeSBarry Smith PetscFunctionBegin; 6015c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 6025c6c1daeSBarry Smith ierr = PetscStageLogGetVisible(stageLog, stage, isVisible);CHKERRQ(ierr); 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 6195c6c1daeSBarry Smith .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 PetscErrorCode ierr; 6255c6c1daeSBarry Smith 6265c6c1daeSBarry Smith PetscFunctionBegin; 6275c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 6285c6c1daeSBarry Smith ierr = PetscStageLogGetStage(stageLog, name, stage);CHKERRQ(ierr); 6295c6c1daeSBarry Smith PetscFunctionReturn(0); 6305c6c1daeSBarry Smith } 6315c6c1daeSBarry Smith 6325c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/ 6335c6c1daeSBarry Smith /*@C 6345c6c1daeSBarry Smith PetscLogEventRegister - Registers an event name for logging operations in an application code. 6355c6c1daeSBarry Smith 6365c6c1daeSBarry Smith Not Collective 6375c6c1daeSBarry Smith 6385c6c1daeSBarry Smith Input Parameter: 6395c6c1daeSBarry Smith + name - The name associated with the event 6405c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with 6415c6c1daeSBarry Smith PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones 6425c6c1daeSBarry Smith are only available in C code 6435c6c1daeSBarry Smith 6445c6c1daeSBarry Smith Output Parameter: 6455c6c1daeSBarry Smith . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd(). 6465c6c1daeSBarry Smith 6475c6c1daeSBarry Smith Example of Usage: 6485c6c1daeSBarry Smith .vb 6495c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 6505c6c1daeSBarry Smith PetscClassId classid; 6515c6c1daeSBarry Smith PetscLogDouble user_event_flops; 6525c6c1daeSBarry Smith PetscClassIdRegister("class name",&classid); 6535c6c1daeSBarry Smith PetscLogEventRegister("User event name",classid,&USER_EVENT); 6545c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 6555c6c1daeSBarry Smith [code segment to monitor] 6565c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 6575c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 6585c6c1daeSBarry Smith .ve 6595c6c1daeSBarry Smith 6605c6c1daeSBarry Smith Notes: 6615c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 662a2553e36SBarry Smith configured with --with-log (which is the default) and 663a2553e36SBarry Smith -log_view or -log_all is specified. PetscLogEventRegister() is 6645c6c1daeSBarry Smith intended for logging user events to supplement this PETSc 6655c6c1daeSBarry Smith information. 6665c6c1daeSBarry Smith 667495fc317SBarry Smith PETSc can gather data for use with the utilities Jumpshot 6685c6c1daeSBarry Smith (part of the MPICH distribution). If PETSc has been compiled 6695c6c1daeSBarry Smith with flag -DPETSC_HAVE_MPE (MPE is an additional utility within 6705c6c1daeSBarry Smith MPICH), the user can employ another command line option, -log_mpe, 6715c6c1daeSBarry Smith to create a logfile, "mpe.log", which can be visualized 672495fc317SBarry Smith Jumpshot. 6735c6c1daeSBarry Smith 6745c6c1daeSBarry Smith The classid is associated with each event so that classes of events 6755c6c1daeSBarry Smith can be disabled simultaneously, such as all matrix events. The user 6765c6c1daeSBarry Smith can either use an existing classid, such as MAT_CLASSID, or create 6775c6c1daeSBarry Smith their own as shown in the example. 6785c6c1daeSBarry Smith 679c5deb1d5SJed Brown If an existing event with the same name exists, its event handle is 680c5deb1d5SJed Brown returned instead of creating a new event. 681c5deb1d5SJed Brown 6825c6c1daeSBarry Smith Level: intermediate 6835c6c1daeSBarry Smith 6845c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogFlops(), 6855c6c1daeSBarry Smith PetscLogEventActivate(), PetscLogEventDeactivate(), PetscClassIdRegister() 6865c6c1daeSBarry Smith @*/ 6875c6c1daeSBarry Smith PetscErrorCode PetscLogEventRegister(const char name[],PetscClassId classid,PetscLogEvent *event) 6885c6c1daeSBarry Smith { 6895c6c1daeSBarry Smith PetscStageLog stageLog; 6905c6c1daeSBarry Smith int stage; 6915c6c1daeSBarry Smith PetscErrorCode ierr; 6925c6c1daeSBarry Smith 6935c6c1daeSBarry Smith PetscFunctionBegin; 6945c6c1daeSBarry Smith *event = PETSC_DECIDE; 6955c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 6963a88037aSBarry Smith ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr); 697c5deb1d5SJed Brown if (*event > 0) PetscFunctionReturn(0); 6983a88037aSBarry Smith ierr = PetscEventRegLogRegister(stageLog->eventLog, name, classid, event);CHKERRQ(ierr); 6995c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 7003a88037aSBarry Smith ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr); 7013a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 7025c6c1daeSBarry Smith } 7035c6c1daeSBarry Smith PetscFunctionReturn(0); 7045c6c1daeSBarry Smith } 7055c6c1daeSBarry Smith 7065c6c1daeSBarry Smith /*@ 707217044c2SLisandro Dalcin PetscLogEventSetCollective - Indicates that a particular event is collective. 708217044c2SLisandro Dalcin 709217044c2SLisandro Dalcin Not Collective 710217044c2SLisandro Dalcin 711217044c2SLisandro Dalcin Input Parameter: 712217044c2SLisandro Dalcin + event - The event id 713217044c2SLisandro Dalcin - collective - Bolean flag indicating whether a particular event is collective 714217044c2SLisandro Dalcin 715217044c2SLisandro Dalcin Note: 716217044c2SLisandro Dalcin New events returned from PetscLogEventRegister() are collective by default. 717217044c2SLisandro Dalcin 718217044c2SLisandro Dalcin Level: developer 719217044c2SLisandro Dalcin 720217044c2SLisandro Dalcin .seealso: PetscLogEventRegister() 721217044c2SLisandro Dalcin @*/ 722217044c2SLisandro Dalcin PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event,PetscBool collective) 723217044c2SLisandro Dalcin { 724217044c2SLisandro Dalcin PetscStageLog stageLog; 725217044c2SLisandro Dalcin PetscEventRegLog eventRegLog; 726217044c2SLisandro Dalcin PetscErrorCode ierr; 727217044c2SLisandro Dalcin 728217044c2SLisandro Dalcin PetscFunctionBegin; 729217044c2SLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 730217044c2SLisandro Dalcin ierr = PetscStageLogGetEventRegLog(stageLog,&eventRegLog);CHKERRQ(ierr); 731217044c2SLisandro Dalcin if (event < 0 || event > eventRegLog->numEvents) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Invalid event id"); 732217044c2SLisandro Dalcin eventRegLog->eventInfo[event].collective = collective; 733217044c2SLisandro Dalcin PetscFunctionReturn(0); 734217044c2SLisandro Dalcin } 735217044c2SLisandro Dalcin 736217044c2SLisandro Dalcin /*@ 737fa2bb9feSLisandro Dalcin PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage. 738fa2bb9feSLisandro Dalcin 739fa2bb9feSLisandro Dalcin Not Collective 740fa2bb9feSLisandro Dalcin 741fa2bb9feSLisandro Dalcin Input Parameter: 742fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc. 743fa2bb9feSLisandro Dalcin 744fa2bb9feSLisandro Dalcin Level: developer 745fa2bb9feSLisandro Dalcin 746fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 747fa2bb9feSLisandro Dalcin @*/ 748fa2bb9feSLisandro Dalcin PetscErrorCode PetscLogEventIncludeClass(PetscClassId classid) 749fa2bb9feSLisandro Dalcin { 750fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 751fa2bb9feSLisandro Dalcin int stage; 752fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 753fa2bb9feSLisandro Dalcin 754fa2bb9feSLisandro Dalcin PetscFunctionBegin; 755fa2bb9feSLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 756fa2bb9feSLisandro Dalcin for (stage = 0; stage < stageLog->numStages; stage++) { 757fa2bb9feSLisandro Dalcin ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 758fa2bb9feSLisandro Dalcin } 759fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 760fa2bb9feSLisandro Dalcin } 761fa2bb9feSLisandro Dalcin 762fa2bb9feSLisandro Dalcin /*@ 763fa2bb9feSLisandro Dalcin PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage. 764fa2bb9feSLisandro Dalcin 765fa2bb9feSLisandro Dalcin Not Collective 766fa2bb9feSLisandro Dalcin 767fa2bb9feSLisandro Dalcin Input Parameter: 768fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc. 769fa2bb9feSLisandro Dalcin 770fa2bb9feSLisandro Dalcin Level: developer 771fa2bb9feSLisandro Dalcin 772fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivateClass(),PetscLogEventDeactivate(),PetscLogEventActivate() 773fa2bb9feSLisandro Dalcin @*/ 774fa2bb9feSLisandro Dalcin PetscErrorCode PetscLogEventExcludeClass(PetscClassId classid) 775fa2bb9feSLisandro Dalcin { 776fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 777fa2bb9feSLisandro Dalcin int stage; 778fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 779fa2bb9feSLisandro Dalcin 780fa2bb9feSLisandro Dalcin PetscFunctionBegin; 781fa2bb9feSLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 782fa2bb9feSLisandro Dalcin for (stage = 0; stage < stageLog->numStages; stage++) { 783fa2bb9feSLisandro Dalcin ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 784fa2bb9feSLisandro Dalcin } 785fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 786fa2bb9feSLisandro Dalcin } 787fa2bb9feSLisandro Dalcin 788fa2bb9feSLisandro Dalcin /*@ 7895c6c1daeSBarry Smith PetscLogEventActivate - Indicates that a particular event should be logged. 7905c6c1daeSBarry Smith 7915c6c1daeSBarry Smith Not Collective 7925c6c1daeSBarry Smith 7935c6c1daeSBarry Smith Input Parameter: 7945c6c1daeSBarry Smith . event - The event id 7955c6c1daeSBarry Smith 7965c6c1daeSBarry Smith Usage: 7975c6c1daeSBarry Smith .vb 7985c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 7995c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 8005c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 8015c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 8025c6c1daeSBarry Smith .ve 8035c6c1daeSBarry Smith 8045c6c1daeSBarry Smith Note: 8055c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in include/petsclog.h) 8065c6c1daeSBarry Smith or an event number obtained with PetscLogEventRegister(). 8075c6c1daeSBarry Smith 8085c6c1daeSBarry Smith Level: advanced 8095c6c1daeSBarry Smith 810c00cb57fSBarry Smith .seealso: PlogEventDeactivate(), PlogEventDeactivatePush(), PetscLogEventDeactivatePop() 8115c6c1daeSBarry Smith @*/ 8125c6c1daeSBarry Smith PetscErrorCode PetscLogEventActivate(PetscLogEvent event) 8135c6c1daeSBarry Smith { 8145c6c1daeSBarry Smith PetscStageLog stageLog; 8155c6c1daeSBarry Smith int stage; 8165c6c1daeSBarry Smith PetscErrorCode ierr; 8175c6c1daeSBarry Smith 8185c6c1daeSBarry Smith PetscFunctionBegin; 8195c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8205c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 8213a88037aSBarry Smith ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8225c6c1daeSBarry Smith PetscFunctionReturn(0); 8235c6c1daeSBarry Smith } 8245c6c1daeSBarry Smith 8255c6c1daeSBarry Smith /*@ 8265c6c1daeSBarry Smith PetscLogEventDeactivate - Indicates that a particular event should not be logged. 8275c6c1daeSBarry Smith 8285c6c1daeSBarry Smith Not Collective 8295c6c1daeSBarry Smith 8305c6c1daeSBarry Smith Input Parameter: 8315c6c1daeSBarry Smith . event - The event id 8325c6c1daeSBarry Smith 8335c6c1daeSBarry Smith Usage: 8345c6c1daeSBarry Smith .vb 8355c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 8365c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 8375c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 8385c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 8395c6c1daeSBarry Smith .ve 8405c6c1daeSBarry Smith 8415c6c1daeSBarry Smith Note: 8425c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in 8435c6c1daeSBarry Smith include/petsclog.h) or an event number obtained with PetscLogEventRegister()). 8445c6c1daeSBarry Smith 8455c6c1daeSBarry Smith Level: advanced 8465c6c1daeSBarry Smith 847c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePush(), PetscLogEventDeactivatePop() 8485c6c1daeSBarry Smith @*/ 8495c6c1daeSBarry Smith PetscErrorCode PetscLogEventDeactivate(PetscLogEvent event) 8505c6c1daeSBarry Smith { 8515c6c1daeSBarry Smith PetscStageLog stageLog; 8525c6c1daeSBarry Smith int stage; 8535c6c1daeSBarry Smith PetscErrorCode ierr; 8545c6c1daeSBarry Smith 8555c6c1daeSBarry Smith PetscFunctionBegin; 8565c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8575c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 8583a88037aSBarry Smith ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8595c6c1daeSBarry Smith PetscFunctionReturn(0); 8605c6c1daeSBarry Smith } 8615c6c1daeSBarry Smith 8625c6c1daeSBarry Smith /*@ 863c00cb57fSBarry Smith PetscLogEventDeactivatePush - Indicates that a particular event should not be logged. 864c00cb57fSBarry Smith 865c00cb57fSBarry Smith Not Collective 866c00cb57fSBarry Smith 867c00cb57fSBarry Smith Input Parameter: 868c00cb57fSBarry Smith . event - The event id 869c00cb57fSBarry Smith 870c00cb57fSBarry Smith Usage: 871c00cb57fSBarry Smith .vb 872c00cb57fSBarry Smith PetscLogEventDeactivatePush(VEC_SetValues); 873c00cb57fSBarry Smith [code where you do not want to log VecSetValues()] 874c00cb57fSBarry Smith PetscLogEventDeactivatePop(VEC_SetValues); 875c00cb57fSBarry Smith [code where you do want to log VecSetValues()] 876c00cb57fSBarry Smith .ve 877c00cb57fSBarry Smith 878c00cb57fSBarry Smith Note: 879c00cb57fSBarry Smith The event may be either a pre-defined PETSc event (found in 880c00cb57fSBarry Smith include/petsclog.h) or an event number obtained with PetscLogEventRegister()). 881c00cb57fSBarry Smith 882c00cb57fSBarry Smith Level: advanced 883c00cb57fSBarry Smith 884c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePop() 885c00cb57fSBarry Smith @*/ 886c00cb57fSBarry Smith PetscErrorCode PetscLogEventDeactivatePush(PetscLogEvent event) 887c00cb57fSBarry Smith { 888c00cb57fSBarry Smith PetscStageLog stageLog; 889c00cb57fSBarry Smith int stage; 890c00cb57fSBarry Smith PetscErrorCode ierr; 891c00cb57fSBarry Smith 892c00cb57fSBarry Smith PetscFunctionBegin; 893c00cb57fSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 894c00cb57fSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 895c00cb57fSBarry Smith ierr = PetscEventPerfLogDeactivatePush(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 896c00cb57fSBarry Smith PetscFunctionReturn(0); 897c00cb57fSBarry Smith } 898c00cb57fSBarry Smith 899c00cb57fSBarry Smith /*@ 900c00cb57fSBarry Smith PetscLogEventDeactivatePop - Indicates that a particular event shouldbe logged. 901c00cb57fSBarry Smith 902c00cb57fSBarry Smith Not Collective 903c00cb57fSBarry Smith 904c00cb57fSBarry Smith Input Parameter: 905c00cb57fSBarry Smith . event - The event id 906c00cb57fSBarry Smith 907c00cb57fSBarry Smith Usage: 908c00cb57fSBarry Smith .vb 909c00cb57fSBarry Smith PetscLogEventDeactivatePush(VEC_SetValues); 910c00cb57fSBarry Smith [code where you do not want to log VecSetValues()] 911c00cb57fSBarry Smith PetscLogEventDeactivatePop(VEC_SetValues); 912c00cb57fSBarry Smith [code where you do want to log VecSetValues()] 913c00cb57fSBarry Smith .ve 914c00cb57fSBarry Smith 915c00cb57fSBarry Smith Note: 916c00cb57fSBarry Smith The event may be either a pre-defined PETSc event (found in 917c00cb57fSBarry Smith include/petsclog.h) or an event number obtained with PetscLogEventRegister()). 918c00cb57fSBarry Smith 919c00cb57fSBarry Smith Level: advanced 920c00cb57fSBarry Smith 921c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePush() 922c00cb57fSBarry Smith @*/ 923c00cb57fSBarry Smith PetscErrorCode PetscLogEventDeactivatePop(PetscLogEvent event) 924c00cb57fSBarry Smith { 925c00cb57fSBarry Smith PetscStageLog stageLog; 926c00cb57fSBarry Smith int stage; 927c00cb57fSBarry Smith PetscErrorCode ierr; 928c00cb57fSBarry Smith 929c00cb57fSBarry Smith PetscFunctionBegin; 930c00cb57fSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 931c00cb57fSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 932c00cb57fSBarry Smith ierr = PetscEventPerfLogDeactivatePop(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 933c00cb57fSBarry Smith PetscFunctionReturn(0); 934c00cb57fSBarry Smith } 935c00cb57fSBarry Smith 936c00cb57fSBarry Smith /*@ 9375c6c1daeSBarry Smith PetscLogEventSetActiveAll - Sets the event activity in every stage. 9385c6c1daeSBarry Smith 9395c6c1daeSBarry Smith Not Collective 9405c6c1daeSBarry Smith 9415c6c1daeSBarry Smith Input Parameters: 9425c6c1daeSBarry Smith + event - The event id 9435c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged 9445c6c1daeSBarry Smith 9455c6c1daeSBarry Smith Level: advanced 9465c6c1daeSBarry Smith 947ec303c53SPatrick Sanan .seealso: PlogEventActivate(),PlogEventDeactivate() 9485c6c1daeSBarry Smith @*/ 9495c6c1daeSBarry Smith PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive) 9505c6c1daeSBarry Smith { 9515c6c1daeSBarry Smith PetscStageLog stageLog; 9525c6c1daeSBarry Smith int stage; 9535c6c1daeSBarry Smith PetscErrorCode ierr; 9545c6c1daeSBarry Smith 9555c6c1daeSBarry Smith PetscFunctionBegin; 9565c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 9575c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 9585c6c1daeSBarry Smith if (isActive) { 9593a88037aSBarry Smith ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 9605c6c1daeSBarry Smith } else { 9613a88037aSBarry Smith ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 9625c6c1daeSBarry Smith } 9635c6c1daeSBarry Smith } 9645c6c1daeSBarry Smith PetscFunctionReturn(0); 9655c6c1daeSBarry Smith } 9665c6c1daeSBarry Smith 9675c6c1daeSBarry Smith /*@ 9685c6c1daeSBarry Smith PetscLogEventActivateClass - Activates event logging for a PETSc object class. 9695c6c1daeSBarry Smith 9705c6c1daeSBarry Smith Not Collective 9715c6c1daeSBarry Smith 9725c6c1daeSBarry Smith Input Parameter: 9735c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 9745c6c1daeSBarry Smith 9755c6c1daeSBarry Smith Level: developer 9765c6c1daeSBarry Smith 977fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 9785c6c1daeSBarry Smith @*/ 9795c6c1daeSBarry Smith PetscErrorCode PetscLogEventActivateClass(PetscClassId classid) 9805c6c1daeSBarry Smith { 9815c6c1daeSBarry Smith PetscStageLog stageLog; 9825c6c1daeSBarry Smith int stage; 9835c6c1daeSBarry Smith PetscErrorCode ierr; 9845c6c1daeSBarry Smith 9855c6c1daeSBarry Smith PetscFunctionBegin; 9865c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 9875c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 9883a88037aSBarry Smith ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 9895c6c1daeSBarry Smith PetscFunctionReturn(0); 9905c6c1daeSBarry Smith } 9915c6c1daeSBarry Smith 9925c6c1daeSBarry Smith /*@ 9935c6c1daeSBarry Smith PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class. 9945c6c1daeSBarry Smith 9955c6c1daeSBarry Smith Not Collective 9965c6c1daeSBarry Smith 9975c6c1daeSBarry Smith Input Parameter: 9985c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 9995c6c1daeSBarry Smith 10005c6c1daeSBarry Smith Level: developer 10015c6c1daeSBarry Smith 1002fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 10035c6c1daeSBarry Smith @*/ 10045c6c1daeSBarry Smith PetscErrorCode PetscLogEventDeactivateClass(PetscClassId classid) 10055c6c1daeSBarry Smith { 10065c6c1daeSBarry Smith PetscStageLog stageLog; 10075c6c1daeSBarry Smith int stage; 10085c6c1daeSBarry Smith PetscErrorCode ierr; 10095c6c1daeSBarry Smith 10105c6c1daeSBarry Smith PetscFunctionBegin; 10115c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 10125c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 10133a88037aSBarry Smith ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 10145c6c1daeSBarry Smith PetscFunctionReturn(0); 10155c6c1daeSBarry Smith } 10165c6c1daeSBarry Smith 10175c6c1daeSBarry Smith /*MC 101862872c28SLisandro Dalcin PetscLogEventSync - Synchronizes the beginning of a user event. 101962872c28SLisandro Dalcin 102062872c28SLisandro Dalcin Synopsis: 102162872c28SLisandro Dalcin #include <petsclog.h> 102262872c28SLisandro Dalcin PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm) 102362872c28SLisandro Dalcin 102462872c28SLisandro Dalcin Collective 102562872c28SLisandro Dalcin 102662872c28SLisandro Dalcin Input Parameters: 102762872c28SLisandro Dalcin + e - integer associated with the event obtained from PetscLogEventRegister() 102862872c28SLisandro Dalcin - comm - an MPI communicator 102962872c28SLisandro Dalcin 103062872c28SLisandro Dalcin Usage: 103162872c28SLisandro Dalcin .vb 103262872c28SLisandro Dalcin PetscLogEvent USER_EVENT; 103362872c28SLisandro Dalcin PetscLogEventRegister("User event",0,&USER_EVENT); 103462872c28SLisandro Dalcin PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD); 103562872c28SLisandro Dalcin PetscLogEventBegin(USER_EVENT,0,0,0,0); 103662872c28SLisandro Dalcin [code segment to monitor] 103762872c28SLisandro Dalcin PetscLogEventEnd(USER_EVENT,0,0,0,0); 103862872c28SLisandro Dalcin .ve 103962872c28SLisandro Dalcin 104062872c28SLisandro Dalcin Notes: 104162872c28SLisandro Dalcin This routine should be called only if there is not a 104262872c28SLisandro Dalcin PetscObject available to pass to PetscLogEventBegin(). 104362872c28SLisandro Dalcin 104462872c28SLisandro Dalcin Level: developer 104562872c28SLisandro Dalcin 104662872c28SLisandro Dalcin .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd() 104762872c28SLisandro Dalcin 104862872c28SLisandro Dalcin M*/ 104962872c28SLisandro Dalcin 105062872c28SLisandro Dalcin /*MC 10515c6c1daeSBarry Smith PetscLogEventBegin - Logs the beginning of a user event. 10525c6c1daeSBarry Smith 10535c6c1daeSBarry Smith Synopsis: 1054aaa7dc30SBarry Smith #include <petsclog.h> 1055f2ba6396SBarry Smith PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10565c6c1daeSBarry Smith 10575c6c1daeSBarry Smith Not Collective 10585c6c1daeSBarry Smith 10595c6c1daeSBarry Smith Input Parameters: 10605c6c1daeSBarry Smith + e - integer associated with the event obtained from PetscLogEventRegister() 10615c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10625c6c1daeSBarry Smith 10635c6c1daeSBarry Smith Fortran Synopsis: 10645c6c1daeSBarry Smith void PetscLogEventBegin(int e,PetscErrorCode ierr) 10655c6c1daeSBarry Smith 10665c6c1daeSBarry Smith Usage: 10675c6c1daeSBarry Smith .vb 10685c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 10695c6c1daeSBarry Smith PetscLogDouble user_event_flops; 10705c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 10715c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 10725c6c1daeSBarry Smith [code segment to monitor] 10735c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 10745c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 10755c6c1daeSBarry Smith .ve 10765c6c1daeSBarry Smith 10775c6c1daeSBarry Smith Notes: 10785c6c1daeSBarry Smith You need to register each integer event with the command 1079a2553e36SBarry Smith PetscLogEventRegister(). 10805c6c1daeSBarry Smith 10815c6c1daeSBarry Smith Level: intermediate 10825c6c1daeSBarry Smith 10835c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops() 10845c6c1daeSBarry Smith 10855c6c1daeSBarry Smith M*/ 10865c6c1daeSBarry Smith 10875c6c1daeSBarry Smith /*MC 10885c6c1daeSBarry Smith PetscLogEventEnd - Log the end of a user event. 10895c6c1daeSBarry Smith 10905c6c1daeSBarry Smith Synopsis: 1091aaa7dc30SBarry Smith #include <petsclog.h> 1092f2ba6396SBarry Smith PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10935c6c1daeSBarry Smith 10945c6c1daeSBarry Smith Not Collective 10955c6c1daeSBarry Smith 10965c6c1daeSBarry Smith Input Parameters: 10975c6c1daeSBarry Smith + e - integer associated with the event obtained with PetscLogEventRegister() 10985c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10995c6c1daeSBarry Smith 11005c6c1daeSBarry Smith Fortran Synopsis: 11015c6c1daeSBarry Smith void PetscLogEventEnd(int e,PetscErrorCode ierr) 11025c6c1daeSBarry Smith 11035c6c1daeSBarry Smith Usage: 11045c6c1daeSBarry Smith .vb 11055c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 11065c6c1daeSBarry Smith PetscLogDouble user_event_flops; 11075c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT,); 11085c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 11095c6c1daeSBarry Smith [code segment to monitor] 11105c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 11115c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 11125c6c1daeSBarry Smith .ve 11135c6c1daeSBarry Smith 11145c6c1daeSBarry Smith Notes: 11155c6c1daeSBarry Smith You should also register each additional integer event with the command 1116a2553e36SBarry Smith PetscLogEventRegister(). 11175c6c1daeSBarry Smith 11185c6c1daeSBarry Smith Level: intermediate 11195c6c1daeSBarry Smith 11205c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogFlops() 11215c6c1daeSBarry Smith 11225c6c1daeSBarry Smith M*/ 11235c6c1daeSBarry Smith 11245c6c1daeSBarry Smith /*@C 11255c6c1daeSBarry Smith PetscLogEventGetId - Returns the event id when given the event name. 11265c6c1daeSBarry Smith 11275c6c1daeSBarry Smith Not Collective 11285c6c1daeSBarry Smith 11295c6c1daeSBarry Smith Input Parameter: 11305c6c1daeSBarry Smith . name - The event name 11315c6c1daeSBarry Smith 11325c6c1daeSBarry Smith Output Parameter: 1133c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists 11345c6c1daeSBarry Smith 11355c6c1daeSBarry Smith Level: intermediate 11365c6c1daeSBarry Smith 11375c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStageGetId() 11385c6c1daeSBarry Smith @*/ 11395c6c1daeSBarry Smith PetscErrorCode PetscLogEventGetId(const char name[], PetscLogEvent *event) 11405c6c1daeSBarry Smith { 11415c6c1daeSBarry Smith PetscStageLog stageLog; 11425c6c1daeSBarry Smith PetscErrorCode ierr; 11435c6c1daeSBarry Smith 11445c6c1daeSBarry Smith PetscFunctionBegin; 11455c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 11463a88037aSBarry Smith ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr); 11475c6c1daeSBarry Smith PetscFunctionReturn(0); 11485c6c1daeSBarry Smith } 11495c6c1daeSBarry Smith 11505c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/ 11515c6c1daeSBarry Smith /*@C 11525c6c1daeSBarry Smith PetscLogDump - Dumps logs of objects to a file. This file is intended to 11535c6c1daeSBarry Smith be read by bin/petscview. This program no longer exists. 11545c6c1daeSBarry Smith 11555c6c1daeSBarry Smith Collective on PETSC_COMM_WORLD 11565c6c1daeSBarry Smith 11575c6c1daeSBarry Smith Input Parameter: 11585c6c1daeSBarry Smith . name - an optional file name 11595c6c1daeSBarry Smith 11605c6c1daeSBarry Smith Usage: 11615c6c1daeSBarry Smith .vb 11625c6c1daeSBarry Smith PetscInitialize(...); 1163bb1d7374SBarry Smith PetscLogDefaultBegin(); or PetscLogAllBegin(); 11645c6c1daeSBarry Smith ... code ... 11655c6c1daeSBarry Smith PetscLogDump(filename); 11665c6c1daeSBarry Smith PetscFinalize(); 11675c6c1daeSBarry Smith .ve 11685c6c1daeSBarry Smith 11695c6c1daeSBarry Smith Notes: 11705c6c1daeSBarry Smith The default file name is 11715c6c1daeSBarry Smith $ Log.<rank> 11725c6c1daeSBarry Smith where <rank> is the processor number. If no name is specified, 11735c6c1daeSBarry Smith this file will be used. 11745c6c1daeSBarry Smith 11755c6c1daeSBarry Smith Level: advanced 11765c6c1daeSBarry Smith 1177bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogView() 11785c6c1daeSBarry Smith @*/ 11795c6c1daeSBarry Smith PetscErrorCode PetscLogDump(const char sname[]) 11805c6c1daeSBarry Smith { 11815c6c1daeSBarry Smith PetscStageLog stageLog; 11825c6c1daeSBarry Smith PetscEventPerfInfo *eventInfo; 11835c6c1daeSBarry Smith FILE *fd; 11845c6c1daeSBarry Smith char file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN]; 11855c6c1daeSBarry Smith PetscLogDouble flops, _TotalTime; 11865c6c1daeSBarry Smith PetscMPIInt rank; 11875c6c1daeSBarry Smith int action, object, curStage; 11885c6c1daeSBarry Smith PetscLogEvent event; 11895c6c1daeSBarry Smith PetscErrorCode ierr; 11905c6c1daeSBarry Smith 11915c6c1daeSBarry Smith PetscFunctionBegin; 11925c6c1daeSBarry Smith /* Calculate the total elapsed time */ 11938563dfccSBarry Smith PetscTime(&_TotalTime); 11945c6c1daeSBarry Smith _TotalTime -= petsc_BaseTime; 11955c6c1daeSBarry Smith /* Open log file */ 1196ffc4695bSBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank);CHKERRMPI(ierr); 11977ff663adSLisandro Dalcin if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank); 1198a297a907SKarl Rupp else sprintf(file, "Log.%d", rank); 11995c6c1daeSBarry Smith ierr = PetscFixFilename(file, fname);CHKERRQ(ierr); 12005c6c1daeSBarry Smith ierr = PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd);CHKERRQ(ierr); 12015c6c1daeSBarry Smith if ((!rank) && (!fd)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname); 12025c6c1daeSBarry Smith /* Output totals */ 1203d4aa7d5fSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime);CHKERRQ(ierr); 1204a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0);CHKERRQ(ierr); 12055c6c1daeSBarry Smith /* Output actions */ 12065c6c1daeSBarry Smith if (petsc_logActions) { 1207a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions);CHKERRQ(ierr); 12085c6c1daeSBarry Smith for (action = 0; action < petsc_numActions; action++) { 12095c6c1daeSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n", 12105c6c1daeSBarry Smith petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1, 1211a2ea699eSBarry Smith petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem);CHKERRQ(ierr); 12125c6c1daeSBarry Smith } 12135c6c1daeSBarry Smith } 12145c6c1daeSBarry Smith /* Output objects */ 12155c6c1daeSBarry Smith if (petsc_logObjects) { 1216a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed);CHKERRQ(ierr); 12175c6c1daeSBarry Smith for (object = 0; object < petsc_numObjects; object++) { 1218a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int) petsc_objects[object].mem);CHKERRQ(ierr); 12195c6c1daeSBarry Smith if (!petsc_objects[object].name[0]) { 1220a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd,"No Name\n");CHKERRQ(ierr); 12215c6c1daeSBarry Smith } else { 1222a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name);CHKERRQ(ierr); 12235c6c1daeSBarry Smith } 12245c6c1daeSBarry Smith if (petsc_objects[object].info[0] != 0) { 1225a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n");CHKERRQ(ierr); 12265c6c1daeSBarry Smith } else { 1227a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info);CHKERRQ(ierr); 12285c6c1daeSBarry Smith } 12295c6c1daeSBarry Smith } 12305c6c1daeSBarry Smith } 12315c6c1daeSBarry Smith /* Output events */ 1232a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n");CHKERRQ(ierr); 12335c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 12345c6c1daeSBarry Smith ierr = PetscIntStackTop(stageLog->stack, &curStage);CHKERRQ(ierr); 12355c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo; 12365c6c1daeSBarry Smith for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) { 1237a297a907SKarl Rupp if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops/eventInfo[event].time; 1238a297a907SKarl Rupp else flops = 0.0; 12395c6c1daeSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count, 1240a2ea699eSBarry Smith eventInfo[event].flops, eventInfo[event].time, flops);CHKERRQ(ierr); 12415c6c1daeSBarry Smith } 12425c6c1daeSBarry Smith ierr = PetscFClose(PETSC_COMM_WORLD, fd);CHKERRQ(ierr); 12435c6c1daeSBarry Smith PetscFunctionReturn(0); 12445c6c1daeSBarry Smith } 12455c6c1daeSBarry Smith 1246f14045dbSBarry Smith /* 1247f14045dbSBarry Smith PetscLogView_Detailed - Each process prints the times for its own events 1248f14045dbSBarry Smith 1249f14045dbSBarry Smith */ 1250f14045dbSBarry Smith PetscErrorCode PetscLogView_Detailed(PetscViewer viewer) 1251f14045dbSBarry Smith { 12522dff6485SMatthew G. Knepley PetscStageLog stageLog; 1253217044c2SLisandro Dalcin PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL; 1254217044c2SLisandro Dalcin PetscLogDouble locTotalTime, numRed, maxMem; 12552dff6485SMatthew G. Knepley int numStages,numEvents,stage,event; 1256217044c2SLisandro Dalcin MPI_Comm comm = PetscObjectComm((PetscObject) viewer); 12572dff6485SMatthew G. Knepley PetscMPIInt rank,size; 12582dff6485SMatthew G. Knepley PetscErrorCode ierr; 1259f14045dbSBarry Smith 1260f14045dbSBarry Smith PetscFunctionBegin; 1261ffc4695bSBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr); 1262ffc4695bSBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr); 12632dff6485SMatthew G. Knepley /* Must preserve reduction count before we go on */ 12642dff6485SMatthew G. Knepley numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 12652d1ec343SBarry Smith /* Get the total elapsed time */ 12662d1ec343SBarry Smith PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 12679852e123SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"size = %d\n",size);CHKERRQ(ierr); 12682d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalTimes = {}\n");CHKERRQ(ierr); 12692d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalMessages = {}\n");CHKERRQ(ierr); 1270217044c2SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"LocalMessageLens = {}\n");CHKERRQ(ierr); 12712d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalReductions = {}\n");CHKERRQ(ierr); 1272217044c2SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"LocalFlop = {}\n");CHKERRQ(ierr); 12732dff6485SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer,"LocalObjects = {}\n");CHKERRQ(ierr); 12742dff6485SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer,"LocalMemory = {}\n");CHKERRQ(ierr); 12752d1ec343SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1276820f2d46SBarry Smith ierr = MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 12772d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages = {}\n");CHKERRQ(ierr); 12782d1ec343SBarry Smith for (stage=0; stage<numStages; stage++) { 12792d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr); 128061917356SPatrick Sanan ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"summary\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr); 1281820f2d46SBarry Smith ierr = MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 12822d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 12832d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"%s\"] = {}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name);CHKERRQ(ierr); 12842d1ec343SBarry Smith } 12852d1ec343SBarry Smith } 1286217044c2SLisandro Dalcin ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr); 12871575c14dSBarry Smith ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr); 12882d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalTimes[%d] = %g\n",rank,locTotalTime);CHKERRQ(ierr); 12892d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessages[%d] = %g\n",rank,(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct));CHKERRQ(ierr); 1290217044c2SLisandro Dalcin ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessageLens[%d] = %g\n",rank,(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len));CHKERRQ(ierr); 12912dff6485SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalReductions[%d] = %g\n",rank,numRed);CHKERRQ(ierr); 1292217044c2SLisandro Dalcin ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalFlop[%d] = %g\n",rank,petsc_TotalFlops);CHKERRQ(ierr); 1293ba67d37fSBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalObjects[%d] = %d\n",rank,petsc_numObjects);CHKERRQ(ierr); 12942dff6485SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMemory[%d] = %g\n",rank,maxMem);CHKERRQ(ierr); 12952d1ec343SBarry Smith ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 12962d1ec343SBarry Smith for (stage=0; stage<numStages; stage++) { 1297217044c2SLisandro Dalcin stageInfo = &stageLog->stageInfo[stage].perfInfo; 1298d4aa7d5fSBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n", 12992dff6485SMatthew G. Knepley stageLog->stageInfo[stage].name,rank, 1300217044c2SLisandro Dalcin stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr); 1301820f2d46SBarry Smith ierr = MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 13022d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 1303217044c2SLisandro Dalcin eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 1304c15bc2c4SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %D, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g", 1305217044c2SLisandro Dalcin stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name,rank, 1306217044c2SLisandro Dalcin eventInfo->count,eventInfo->time,eventInfo->syncTime,eventInfo->numMessages,eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr); 1307891e75beSMatthew G. Knepley if (eventInfo->dof[0] >= 0.) { 1308891e75beSMatthew G. Knepley PetscInt d, e; 13095d68e14cSMatthew G. Knepley 1310891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : [");CHKERRQ(ierr); 1311891e75beSMatthew G. Knepley for (d = 0; d < 8; ++d) { 1312891e75beSMatthew G. Knepley if (d > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);} 1313891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d]);CHKERRQ(ierr); 1314891e75beSMatthew G. Knepley } 1315891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr); 13165d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : [");CHKERRQ(ierr); 13175d68e14cSMatthew G. Knepley for (e = 0; e < 8; ++e) { 13185d68e14cSMatthew G. Knepley if (e > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);} 1319c15bc2c4SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e]);CHKERRQ(ierr); 13205d68e14cSMatthew G. Knepley } 13215d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr); 13225d68e14cSMatthew G. Knepley } 13235d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"}\n");CHKERRQ(ierr); 13242d1ec343SBarry Smith } 13252d1ec343SBarry Smith } 13262d1ec343SBarry Smith ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 13271575c14dSBarry Smith ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr); 1328f14045dbSBarry Smith PetscFunctionReturn(0); 1329f14045dbSBarry Smith } 1330f14045dbSBarry Smith 133138144912Sdeepblu2718 /* 133238144912Sdeepblu2718 PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format 133338144912Sdeepblu2718 */ 133438144912Sdeepblu2718 PetscErrorCode PetscLogView_CSV(PetscViewer viewer) 133538144912Sdeepblu2718 { 133638144912Sdeepblu2718 PetscStageLog stageLog; 1337669c5be0SSatish Balay PetscEventPerfInfo *eventInfo = NULL; 133838144912Sdeepblu2718 PetscLogDouble locTotalTime, maxMem; 133938144912Sdeepblu2718 int numStages,numEvents,stage,event; 134038144912Sdeepblu2718 MPI_Comm comm = PetscObjectComm((PetscObject) viewer); 134138144912Sdeepblu2718 PetscMPIInt rank,size; 134238144912Sdeepblu2718 PetscErrorCode ierr; 134338144912Sdeepblu2718 134438144912Sdeepblu2718 PetscFunctionBegin; 1345ffc4695bSBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr); 1346ffc4695bSBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr); 134738144912Sdeepblu2718 /* Must preserve reduction count before we go on */ 134838144912Sdeepblu2718 /* Get the total elapsed time */ 134938144912Sdeepblu2718 PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 135038144912Sdeepblu2718 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1351820f2d46SBarry Smith ierr = MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 135238144912Sdeepblu2718 ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr); 135338144912Sdeepblu2718 ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr); 135438144912Sdeepblu2718 ierr = PetscViewerASCIIPrintf(viewer,"Stage Name,Event Name,Rank,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); 135538144912Sdeepblu2718 ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 135638144912Sdeepblu2718 for (stage=0; stage<numStages; stage++) { 13579e29573dSMatthew G. Knepley PetscEventPerfInfo *stageInfo = &stageLog->stageInfo[stage].perfInfo; 13589e29573dSMatthew G. Knepley 13599e29573dSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,summary,%d,%g,%g,%g,%g,%g\n", 13609e29573dSMatthew G. Knepley stageLog->stageInfo[stage].name,rank,stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr); 1361820f2d46SBarry Smith ierr = MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 136238144912Sdeepblu2718 for (event = 0; event < numEvents; event++) { 136338144912Sdeepblu2718 eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 136438144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,%s,%d,%g,%g,%g,%g,%g",stageLog->stageInfo[stage].name, 136538144912Sdeepblu2718 stageLog->eventLog->eventInfo[event].name,rank,eventInfo->time,eventInfo->numMessages, 136638144912Sdeepblu2718 eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr); 136738144912Sdeepblu2718 if (eventInfo->dof[0] >= 0.) { 136838144912Sdeepblu2718 PetscInt d, e; 136938144912Sdeepblu2718 137038144912Sdeepblu2718 for (d = 0; d < 8; ++d) { 137138144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d]);CHKERRQ(ierr); 137238144912Sdeepblu2718 } 137338144912Sdeepblu2718 for (e = 0; e < 8; ++e) { 137438144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e]);CHKERRQ(ierr); 137538144912Sdeepblu2718 } 137638144912Sdeepblu2718 } 137738144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"\n");CHKERRQ(ierr); 137838144912Sdeepblu2718 } 137938144912Sdeepblu2718 } 138038144912Sdeepblu2718 ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 138138144912Sdeepblu2718 ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr); 138238144912Sdeepblu2718 PetscFunctionReturn(0); 138338144912Sdeepblu2718 } 138438144912Sdeepblu2718 1385217044c2SLisandro Dalcin static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm,FILE *fd) 1386217044c2SLisandro Dalcin { 1387217044c2SLisandro Dalcin PetscErrorCode ierr; 1388217044c2SLisandro Dalcin PetscFunctionBegin; 1389217044c2SLisandro Dalcin if (!PetscLogSyncOn) PetscFunctionReturn(0); 1390217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1391217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1392217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1393217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1394217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1395217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This program was run with logging synchronization. #\n");CHKERRQ(ierr); 1396217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This option provides more meaningful imbalance #\n");CHKERRQ(ierr); 1397217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # figures at the expense of slowing things down and #\n");CHKERRQ(ierr); 1398217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # providing a distorted view of the overall runtime. #\n");CHKERRQ(ierr); 1399217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1400217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 1401217044c2SLisandro Dalcin PetscFunctionReturn(0); 1402217044c2SLisandro Dalcin } 1403217044c2SLisandro Dalcin 1404f4091ad2SBarry Smith static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm,FILE *fd) 1405f4091ad2SBarry Smith { 1406f4091ad2SBarry Smith PetscErrorCode ierr; 1407f4091ad2SBarry Smith 1408f4091ad2SBarry Smith PetscFunctionBegin; 140976bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1410f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1411f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1412f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1413f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1414f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1415217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This code was compiled with a debugging option. #\n");CHKERRQ(ierr); 1416f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # To get timing results run ./configure #\n");CHKERRQ(ierr); 1417f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # using --with-debugging=no, the performance will #\n");CHKERRQ(ierr); 1418f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # be generally two or three times faster. #\n");CHKERRQ(ierr); 1419f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1420f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 142176bd3646SJed Brown } 1422f4091ad2SBarry Smith PetscFunctionReturn(0); 1423f4091ad2SBarry Smith } 1424f4091ad2SBarry Smith 1425c2a741eeSJunchao Zhang static PetscErrorCode PetscLogViewWarnNoGpuAwareMpi(MPI_Comm comm,FILE *fd) 1426c2a741eeSJunchao Zhang { 142759af0bd3SScott Kruger #if defined(PETSC_HAVE_CUDA) || defined(PETSC_HAVE_HIP) 1428c2a741eeSJunchao Zhang PetscErrorCode ierr; 1429c2a741eeSJunchao Zhang 1430c2a741eeSJunchao Zhang PetscFunctionBegin; 1431928a6601SJunchao Zhang if (use_gpu_aware_mpi || !PetscCreatedGpuObjects) PetscFunctionReturn(0); 1432c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1433c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1434c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1435c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1436c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1437928a6601SJunchao Zhang ierr = PetscFPrintf(comm, fd, " # This code was compiled with GPU support and you've #\n");CHKERRQ(ierr); 1438928a6601SJunchao Zhang ierr = PetscFPrintf(comm, fd, " # created PETSc/GPU objects, but you intentionally used #\n");CHKERRQ(ierr); 1439928a6601SJunchao Zhang ierr = PetscFPrintf(comm, fd, " # -use_gpu_aware_mpi 0, such that PETSc had to copy data #\n");CHKERRQ(ierr); 1440928a6601SJunchao Zhang ierr = PetscFPrintf(comm, fd, " # from GPU to CPU for communication. To get meaningfull #\n");CHKERRQ(ierr); 1441928a6601SJunchao Zhang ierr = PetscFPrintf(comm, fd, " # timing results, please use GPU-aware MPI instead. #\n");CHKERRQ(ierr); 1442c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 1443c2a741eeSJunchao Zhang PetscFunctionReturn(0); 1444c2a741eeSJunchao Zhang #else 1445c2a741eeSJunchao Zhang return 0; 1446c2a741eeSJunchao Zhang #endif 1447c2a741eeSJunchao Zhang } 1448c2a741eeSJunchao Zhang 1449f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP) 1450f90b075cSBarry Smith extern PetscInt PetscNumOMPThreads; 1451f90b075cSBarry Smith #endif 1452f90b075cSBarry Smith 1453f14045dbSBarry Smith PetscErrorCode PetscLogView_Default(PetscViewer viewer) 14545c6c1daeSBarry Smith { 14555c6c1daeSBarry Smith FILE *fd; 14565c6c1daeSBarry Smith PetscLogDouble zero = 0.0; 14575c6c1daeSBarry Smith PetscStageLog stageLog; 14580298fd71SBarry Smith PetscStageInfo *stageInfo = NULL; 14590298fd71SBarry Smith PetscEventPerfInfo *eventInfo = NULL; 14605c6c1daeSBarry Smith PetscClassPerfInfo *classInfo; 14615c6c1daeSBarry Smith char arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128]; 14625c6c1daeSBarry Smith const char *name; 14635c6c1daeSBarry Smith PetscLogDouble locTotalTime, TotalTime, TotalFlops; 14645c6c1daeSBarry Smith PetscLogDouble numMessages, messageLength, avgMessLen, numReductions; 14655c6c1daeSBarry Smith PetscLogDouble stageTime, flops, flopr, mem, mess, messLen, red; 14665c6c1daeSBarry Smith PetscLogDouble fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed; 14675c6c1daeSBarry Smith PetscLogDouble fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed; 14685c6c1daeSBarry Smith PetscLogDouble min, max, tot, ratio, avg, x, y; 1469e3ed9ee7SBarry Smith PetscLogDouble minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr, mal, malmax, emalmax; 1470d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1471958c4211Shannah_mairs PetscLogDouble cct, gct, csz, gsz, gmaxt, gflops, gflopr, fracgflops; 1472bec0b493Shannah_mairs #endif 1473217044c2SLisandro Dalcin PetscMPIInt minC, maxC; 14745c6c1daeSBarry Smith PetscMPIInt size, rank; 14755c6c1daeSBarry Smith PetscBool *localStageUsed, *stageUsed; 14765c6c1daeSBarry Smith PetscBool *localStageVisible, *stageVisible; 14775c6c1daeSBarry Smith int numStages, localNumEvents, numEvents; 147837b78d16SBarry Smith int stage, oclass; 14795c6c1daeSBarry Smith PetscLogEvent event; 14805c6c1daeSBarry Smith PetscErrorCode ierr; 14815c6c1daeSBarry Smith char version[256]; 14825c6c1daeSBarry Smith MPI_Comm comm; 14835c6c1daeSBarry Smith 14845c6c1daeSBarry Smith PetscFunctionBegin; 14855c6c1daeSBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 14865c6c1daeSBarry Smith ierr = PetscViewerASCIIGetPointer(viewer,&fd);CHKERRQ(ierr); 1487ffc4695bSBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr); 1488ffc4695bSBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr); 14895c6c1daeSBarry Smith /* Get the total elapsed time */ 14908563dfccSBarry Smith PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 14915c6c1daeSBarry Smith 14925c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr); 14935c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "*** WIDEN YOUR WINDOW TO 120 CHARACTERS. Use 'enscript -r -fCourier9' to print this document ***\n");CHKERRQ(ierr); 14945c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr); 14955c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n---------------------------------------------- PETSc Performance Summary: ----------------------------------------------\n\n");CHKERRQ(ierr); 1496217044c2SLisandro Dalcin ierr = PetscLogViewWarnSync(comm,fd);CHKERRQ(ierr); 1497f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 1498c2a741eeSJunchao Zhang ierr = PetscLogViewWarnNoGpuAwareMpi(comm,fd);CHKERRQ(ierr); 14995c6c1daeSBarry Smith ierr = PetscGetArchType(arch,sizeof(arch));CHKERRQ(ierr); 15005c6c1daeSBarry Smith ierr = PetscGetHostName(hostname,sizeof(hostname));CHKERRQ(ierr); 15015c6c1daeSBarry Smith ierr = PetscGetUserName(username,sizeof(username));CHKERRQ(ierr); 15025c6c1daeSBarry Smith ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr); 15035c6c1daeSBarry Smith ierr = PetscGetDate(date,sizeof(date));CHKERRQ(ierr); 15045c6c1daeSBarry Smith ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr); 15055c6c1daeSBarry Smith if (size == 1) { 15065c6c1daeSBarry Smith ierr = PetscFPrintf(comm,fd,"%s on a %s named %s with %d processor, by %s %s\n", pname, arch, hostname, size, username, date);CHKERRQ(ierr); 15075c6c1daeSBarry Smith } else { 15085c6c1daeSBarry Smith ierr = PetscFPrintf(comm,fd,"%s on a %s named %s with %d processors, by %s %s\n", pname, arch, hostname, size, username, date);CHKERRQ(ierr); 15095c6c1daeSBarry Smith } 1510f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP) 1511f90b075cSBarry Smith ierr = PetscFPrintf(comm,fd,"Using %D OpenMP threads\n", PetscNumOMPThreads);CHKERRQ(ierr); 1512f90b075cSBarry Smith #endif 15135c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Using %s\n", version);CHKERRQ(ierr); 15145c6c1daeSBarry Smith 15155c6c1daeSBarry Smith /* Must preserve reduction count before we go on */ 15165c6c1daeSBarry Smith red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 15175c6c1daeSBarry Smith 15185c6c1daeSBarry Smith /* Calculate summary information */ 15195c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n Max Max/Min Avg Total\n");CHKERRQ(ierr); 15205c6c1daeSBarry Smith /* Time */ 1521820f2d46SBarry Smith ierr = MPI_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1522820f2d46SBarry Smith ierr = MPI_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1523820f2d46SBarry Smith ierr = MPI_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1524217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1525217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1526217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Time (sec): %5.3e %7.3f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 15275c6c1daeSBarry Smith TotalTime = tot; 15285c6c1daeSBarry Smith /* Objects */ 15295c6c1daeSBarry Smith avg = (PetscLogDouble) petsc_numObjects; 1530820f2d46SBarry Smith ierr = MPI_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1531820f2d46SBarry Smith ierr = MPI_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1532820f2d46SBarry Smith ierr = MPI_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1533217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1534217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1535217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Objects: %5.3e %7.3f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 15365c6c1daeSBarry Smith /* Flops */ 1537820f2d46SBarry Smith ierr = MPI_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1538820f2d46SBarry Smith ierr = MPI_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1539820f2d46SBarry Smith ierr = MPI_Allreduce(&petsc_TotalFlops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1540217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1541217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1542217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Flop: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 15435c6c1daeSBarry Smith TotalFlops = tot; 15445c6c1daeSBarry Smith /* Flops/sec -- Must talk to Barry here */ 1545217044c2SLisandro Dalcin if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime; else flops = 0.0; 1546820f2d46SBarry Smith ierr = MPI_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1547820f2d46SBarry Smith ierr = MPI_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1548820f2d46SBarry Smith ierr = MPI_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1549217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1550217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1551217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Flop/sec: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 15525c6c1daeSBarry Smith /* Memory */ 15535c6c1daeSBarry Smith ierr = PetscMallocGetMaximumUsage(&mem);CHKERRQ(ierr); 15545c6c1daeSBarry Smith if (mem > 0.0) { 1555820f2d46SBarry Smith ierr = MPI_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1556820f2d46SBarry Smith ierr = MPI_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1557820f2d46SBarry Smith ierr = MPI_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1558217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1559217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1560217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Memory: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 15615c6c1daeSBarry Smith } 15625c6c1daeSBarry Smith /* Messages */ 15635c6c1daeSBarry Smith mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct); 1564820f2d46SBarry Smith ierr = MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1565820f2d46SBarry Smith ierr = MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1566820f2d46SBarry Smith ierr = MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1567217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1568217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1569217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Messages: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 15705c6c1daeSBarry Smith numMessages = tot; 15715c6c1daeSBarry Smith /* Message Lengths */ 15725c6c1daeSBarry Smith mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len); 1573820f2d46SBarry Smith ierr = MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1574820f2d46SBarry Smith ierr = MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1575820f2d46SBarry Smith ierr = MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1576217044c2SLisandro Dalcin if (numMessages != 0) avg = tot/numMessages; else avg = 0.0; 1577217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1578217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Message Lengths: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 15795c6c1daeSBarry Smith messageLength = tot; 15805c6c1daeSBarry Smith /* Reductions */ 1581820f2d46SBarry Smith ierr = MPI_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1582820f2d46SBarry Smith ierr = MPI_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1583820f2d46SBarry Smith ierr = MPI_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1584217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1585217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Reductions: %5.3e %7.3f\n", max, ratio);CHKERRQ(ierr); 15865c6c1daeSBarry Smith numReductions = red; /* wrong because uses count from process zero */ 15875c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n");CHKERRQ(ierr); 1588d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " e.g., VecAXPY() for real vectors of length N --> 2N flop\n");CHKERRQ(ierr); 1589d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " and VecAXPY() for complex vectors of length N --> 8N flop\n");CHKERRQ(ierr); 15905c6c1daeSBarry Smith 15915c6c1daeSBarry Smith /* Get total number of stages -- 15925c6c1daeSBarry Smith Currently, a single processor can register more stages than another, but stages must all be registered in order. 15935c6c1daeSBarry Smith We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID. 15945c6c1daeSBarry Smith This seems best accomplished by assoicating a communicator with each stage. 15955c6c1daeSBarry Smith */ 159637b78d16SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1597820f2d46SBarry Smith ierr = MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 1598785e854fSJed Brown ierr = PetscMalloc1(numStages, &localStageUsed);CHKERRQ(ierr); 1599785e854fSJed Brown ierr = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr); 1600785e854fSJed Brown ierr = PetscMalloc1(numStages, &localStageVisible);CHKERRQ(ierr); 1601785e854fSJed Brown ierr = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr); 16025c6c1daeSBarry Smith if (numStages > 0) { 16035c6c1daeSBarry Smith stageInfo = stageLog->stageInfo; 16045c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16055c6c1daeSBarry Smith if (stage < stageLog->numStages) { 16065c6c1daeSBarry Smith localStageUsed[stage] = stageInfo[stage].used; 16075c6c1daeSBarry Smith localStageVisible[stage] = stageInfo[stage].perfInfo.visible; 16085c6c1daeSBarry Smith } else { 16095c6c1daeSBarry Smith localStageUsed[stage] = PETSC_FALSE; 16105c6c1daeSBarry Smith localStageVisible[stage] = PETSC_TRUE; 16115c6c1daeSBarry Smith } 16125c6c1daeSBarry Smith } 1613820f2d46SBarry Smith ierr = MPI_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm);CHKERRMPI(ierr); 1614820f2d46SBarry Smith ierr = MPI_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr); 16155c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16165c6c1daeSBarry Smith if (stageUsed[stage]) { 1617217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "\nSummary of Stages: ----- Time ------ ----- Flop ------ --- Messages --- -- Message Lengths -- -- Reductions --\n");CHKERRQ(ierr); 1618217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " Avg %%Total Avg %%Total Count %%Total Avg %%Total Count %%Total\n");CHKERRQ(ierr); 16195c6c1daeSBarry Smith break; 16205c6c1daeSBarry Smith } 16215c6c1daeSBarry Smith } 16225c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16235c6c1daeSBarry Smith if (!stageUsed[stage]) continue; 1624820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 16255c6c1daeSBarry Smith if (localStageUsed[stage]) { 1626ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1627ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1628ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1629ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1630ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 16315c6c1daeSBarry Smith name = stageInfo[stage].name; 16325c6c1daeSBarry Smith } else { 1633ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1634ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1635ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1636ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1637ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 16385c6c1daeSBarry Smith name = ""; 16395c6c1daeSBarry Smith } 16405c6c1daeSBarry Smith mess *= 0.5; messLen *= 0.5; red /= size; 16415c6c1daeSBarry Smith if (TotalTime != 0.0) fracTime = stageTime/TotalTime; else fracTime = 0.0; 16425c6c1daeSBarry Smith if (TotalFlops != 0.0) fracFlops = flops/TotalFlops; else fracFlops = 0.0; 16435c6c1daeSBarry Smith /* Talk to Barry if (stageTime != 0.0) flops = (size*flops)/stageTime; else flops = 0.0; */ 16445c6c1daeSBarry Smith if (numMessages != 0.0) fracMessages = mess/numMessages; else fracMessages = 0.0; 1645e96a4d02SJunchao Zhang if (mess != 0.0) avgMessLen = messLen/mess; else avgMessLen = 0.0; 16465c6c1daeSBarry Smith if (messageLength != 0.0) fracLength = messLen/messageLength; else fracLength = 0.0; 16475c6c1daeSBarry Smith if (numReductions != 0.0) fracReductions = red/numReductions; else fracReductions = 0.0; 16485c6c1daeSBarry Smith ierr = 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", 16495c6c1daeSBarry Smith stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops, 16505c6c1daeSBarry Smith mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr); 16515c6c1daeSBarry Smith } 16525c6c1daeSBarry Smith } 16535c6c1daeSBarry Smith 1654806fa848SBarry Smith ierr = PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 16555c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n");CHKERRQ(ierr); 16565c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Phase summary info:\n");CHKERRQ(ierr); 16575c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Count: number of times phase was executed\n");CHKERRQ(ierr); 1658d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " Time and Flop: Max - maximum over all processors\n");CHKERRQ(ierr); 16595c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Ratio - ratio of maximum to minimum over all processors\n");CHKERRQ(ierr); 16605c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Mess: number of messages sent\n");CHKERRQ(ierr); 1661217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " AvgLen: average message length (bytes)\n");CHKERRQ(ierr); 16625c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Reduct: number of global reductions\n");CHKERRQ(ierr); 16635c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Global: entire computation\n");CHKERRQ(ierr); 16645c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n");CHKERRQ(ierr); 1665d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " %%T - percent time in this phase %%F - percent flop in this phase\n");CHKERRQ(ierr); 16665c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " %%M - percent messages in this phase %%L - percent message lengths in this phase\n");CHKERRQ(ierr); 16675c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " %%R - percent reductions in this phase\n");CHKERRQ(ierr); 1668d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n");CHKERRQ(ierr); 1669e3ed9ee7SBarry Smith if (PetscLogMemory) { 1670e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event)\n");CHKERRQ(ierr); 1671e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events)\n");CHKERRQ(ierr); 1672e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event)\n");CHKERRQ(ierr); 1673e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " RMI Mbytes: Increase in resident memory (sum over all calls to event)\n");CHKERRQ(ierr); 1674e3ed9ee7SBarry Smith } 1675d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1676958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd, " GPU Mflop/s: 10e-6 * (sum of flop on GPU over all processors)/(max GPU time over all processors)\n");CHKERRQ(ierr); 16774863603aSSatish Balay ierr = PetscFPrintf(comm, fd, " CpuToGpu Count: total number of CPU to GPU copies per processor\n");CHKERRQ(ierr); 16784863603aSSatish Balay ierr = PetscFPrintf(comm, fd, " CpuToGpu Size (Mbytes): 10e-6 * (total size of CPU to GPU copies per processor)\n");CHKERRQ(ierr); 16794863603aSSatish Balay ierr = PetscFPrintf(comm, fd, " GpuToCpu Count: total number of GPU to CPU copies per processor\n");CHKERRQ(ierr); 16804863603aSSatish Balay ierr = PetscFPrintf(comm, fd, " GpuToCpu Size (Mbytes): 10e-6 * (total size of GPU to CPU copies per processor)\n");CHKERRQ(ierr); 1681958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd, " GPU %%F: percent flops on GPU in this event\n");CHKERRQ(ierr); 1682bec0b493Shannah_mairs #endif 1683806fa848SBarry Smith ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 16845c6c1daeSBarry Smith 1685f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 16865c6c1daeSBarry Smith 16875c6c1daeSBarry Smith /* Report events */ 1688e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd,"Event Count Time (sec) Flop --- Global --- --- Stage ---- Total");CHKERRQ(ierr); 1689e3ed9ee7SBarry Smith if (PetscLogMemory) { 1690bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd," Malloc EMalloc MMalloc RMI");CHKERRQ(ierr); 1691e3ed9ee7SBarry Smith } 1692d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1693958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd," GPU - CpuToGpu - - GpuToCpu - GPU");CHKERRQ(ierr); 1694bec0b493Shannah_mairs #endif 1695bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 1696e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd," Max Ratio Max Ratio Max Ratio Mess AvgLen Reduct %%T %%F %%M %%L %%R %%T %%F %%M %%L %%R Mflop/s");CHKERRQ(ierr); 1697e3ed9ee7SBarry Smith if (PetscLogMemory) { 1698bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd," Mbytes Mbytes Mbytes Mbytes");CHKERRQ(ierr); 1699e3ed9ee7SBarry Smith } 1700d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1701958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd," Mflop/s Count Size Count Size %%F");CHKERRQ(ierr); 1702bec0b493Shannah_mairs #endif 1703bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 17044863603aSSatish Balay ierr = PetscFPrintf(comm, fd,"------------------------------------------------------------------------------------------------------------------------");CHKERRQ(ierr); 17054863603aSSatish Balay if (PetscLogMemory) { 17064863603aSSatish Balay ierr = PetscFPrintf(comm, fd,"-----------------------------");CHKERRQ(ierr); 17074863603aSSatish Balay } 1708d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1709958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd,"---------------------------------------");CHKERRQ(ierr); 17104863603aSSatish Balay #endif 17114863603aSSatish Balay ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 17125c6c1daeSBarry Smith 17135c6c1daeSBarry Smith /* Problem: The stage name will not show up unless the stage executed on proc 1 */ 17145c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 17155c6c1daeSBarry Smith if (!stageVisible[stage]) continue; 1716820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 17175c6c1daeSBarry Smith if (localStageUsed[stage]) { 17185c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 1719ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1720ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1721ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1722ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1723ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 17245c6c1daeSBarry Smith } else { 17255c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 1726ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1727ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1728ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1729ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1730ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 17315c6c1daeSBarry Smith } 17325c6c1daeSBarry Smith mess *= 0.5; messLen *= 0.5; red /= size; 17335c6c1daeSBarry Smith 17345c6c1daeSBarry Smith /* Get total number of events in this stage -- 17355c6c1daeSBarry Smith Currently, a single processor can register more events than another, but events must all be registered in order, 17365c6c1daeSBarry Smith just like stages. We can removed this requirement if necessary by having a global event numbering and indirection 1737217044c2SLisandro Dalcin on the event ID. This seems best accomplished by associating a communicator with each stage. 17385c6c1daeSBarry Smith 17395c6c1daeSBarry Smith Problem: If the event did not happen on proc 1, its name will not be available. 17405c6c1daeSBarry Smith Problem: Event visibility is not implemented 17415c6c1daeSBarry Smith */ 17425c6c1daeSBarry Smith if (localStageUsed[stage]) { 17435c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo; 17445c6c1daeSBarry Smith localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents; 1745a297a907SKarl Rupp } else localNumEvents = 0; 1746820f2d46SBarry Smith ierr = MPI_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 17475c6c1daeSBarry Smith for (event = 0; event < numEvents; event++) { 1748820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 17495c6c1daeSBarry Smith if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) { 1750217044c2SLisandro Dalcin if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; else flopr = 0.0; 1751ffc4695bSBarry Smith ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1752ffc4695bSBarry Smith ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1753ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1754ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1755ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1756ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1757ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1758ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1759ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1760ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].count, &minC, 1, MPI_INT, MPI_MIN, comm);CHKERRMPI(ierr); 1761ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].count, &maxC, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 1762e3ed9ee7SBarry Smith if (PetscLogMemory) { 176355b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].memIncrease, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 176455b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].mallocSpace, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 176555b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].mallocIncrease, &malmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 176655b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1767e3ed9ee7SBarry Smith } 1768d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 176955b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].CpuToGpuCount, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 177055b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].GpuToCpuCount, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 177155b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].CpuToGpuSize, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 177255b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].GpuToCpuSize, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 177355b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].GpuFlops, &gflops,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 177455b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].GpuTime, &gmaxt ,1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1775bec0b493Shannah_mairs #endif 17765c6c1daeSBarry Smith name = stageLog->eventLog->eventInfo[event].name; 17775c6c1daeSBarry Smith } else { 17785c6c1daeSBarry Smith flopr = 0.0; 177955b25c41SPierre Jolivet ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 178055b25c41SPierre Jolivet ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 178155b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 178255b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 178355b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 178455b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 178555b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 178655b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 178755b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 178855b25c41SPierre Jolivet ierr = MPI_Allreduce(&ierr, &minC, 1, MPI_INT, MPI_MIN, comm);CHKERRMPI(ierr); 178955b25c41SPierre Jolivet ierr = MPI_Allreduce(&ierr, &maxC, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 1790e3ed9ee7SBarry Smith if (PetscLogMemory) { 179155b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 179255b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 179355b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 179455b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1795e3ed9ee7SBarry Smith } 1796d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 179755b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 179855b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 179955b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 180055b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 180155b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 180255b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &gmaxt , 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1803bec0b493Shannah_mairs #endif 18045c6c1daeSBarry Smith name = ""; 18055c6c1daeSBarry Smith } 18065c6c1daeSBarry Smith if (mint < 0.0) { 18075c6c1daeSBarry Smith ierr = 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); 18085c6c1daeSBarry Smith mint = 0; 18095c6c1daeSBarry Smith } 1810d4aa7d5fSBarry Smith if (minf < 0.0) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Minimum flop %g over all processors for %s is negative! Not possible!",minf,name); 18115c6c1daeSBarry Smith totm *= 0.5; totml *= 0.5; totr /= size; 18125c6c1daeSBarry Smith 1813217044c2SLisandro Dalcin if (maxC != 0) { 1814217044c2SLisandro Dalcin if (minC != 0) ratC = ((PetscLogDouble)maxC)/minC;else ratC = 0.0; 18155c6c1daeSBarry Smith if (mint != 0.0) ratt = maxt/mint; else ratt = 0.0; 18165c6c1daeSBarry Smith if (minf != 0.0) ratf = maxf/minf; else ratf = 0.0; 18175c6c1daeSBarry Smith if (TotalTime != 0.0) fracTime = tott/TotalTime; else fracTime = 0.0; 18185c6c1daeSBarry Smith if (TotalFlops != 0.0) fracFlops = totf/TotalFlops; else fracFlops = 0.0; 18195c6c1daeSBarry Smith if (stageTime != 0.0) fracStageTime = tott/stageTime; else fracStageTime = 0.0; 18205c6c1daeSBarry Smith if (flops != 0.0) fracStageFlops = totf/flops; else fracStageFlops = 0.0; 18215c6c1daeSBarry Smith if (numMessages != 0.0) fracMess = totm/numMessages; else fracMess = 0.0; 18225c6c1daeSBarry Smith if (messageLength != 0.0) fracMessLen = totml/messageLength; else fracMessLen = 0.0; 18235c6c1daeSBarry Smith if (numReductions != 0.0) fracRed = totr/numReductions; else fracRed = 0.0; 18245c6c1daeSBarry Smith if (mess != 0.0) fracStageMess = totm/mess; else fracStageMess = 0.0; 18255c6c1daeSBarry Smith if (messLen != 0.0) fracStageMessLen = totml/messLen; else fracStageMessLen = 0.0; 18265c6c1daeSBarry Smith if (red != 0.0) fracStageRed = totr/red; else fracStageRed = 0.0; 18275c6c1daeSBarry Smith if (totm != 0.0) totml /= totm; else totml = 0.0; 18285c6c1daeSBarry Smith if (maxt != 0.0) flopr = totf/maxt; else flopr = 0.0; 1829411f5eb9SRichard Tran Mills if (fracStageTime > 1.00) ierr = PetscFPrintf(comm, fd,"Warning -- total time of event greater than time of entire stage -- something is wrong with the timer\n");CHKERRQ(ierr); 18305c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, 1831e3ed9ee7SBarry 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", 1832217044c2SLisandro Dalcin name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr, 18335c6c1daeSBarry Smith 100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed, 18345c6c1daeSBarry Smith 100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed, 1835c068d9bbSLisandro Dalcin PetscAbs(flopr)/1.0e6);CHKERRQ(ierr); 1836e3ed9ee7SBarry Smith if (PetscLogMemory) { 1837bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd," %5.0f %5.0f %5.0f %5.0f",mal/1.0e6,emalmax/1.0e6,malmax/1.0e6,mem/1.0e6);CHKERRQ(ierr); 1838e3ed9ee7SBarry Smith } 1839d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1840958c4211Shannah_mairs if (totf != 0.0) fracgflops = gflops/totf; else fracgflops = 0.0; 1841958c4211Shannah_mairs if (gmaxt != 0.0) gflopr = gflops/gmaxt; else gflopr = 0.0; 1842958c4211Shannah_mairs ierr = 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);CHKERRQ(ierr); 1843bec0b493Shannah_mairs #endif 1844bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 18455c6c1daeSBarry Smith } 18465c6c1daeSBarry Smith } 18475c6c1daeSBarry Smith } 18485c6c1daeSBarry Smith 18495c6c1daeSBarry Smith /* Memory usage and object creation */ 18504863603aSSatish Balay ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------");CHKERRQ(ierr); 18514863603aSSatish Balay if (PetscLogMemory) { 18524863603aSSatish Balay ierr = PetscFPrintf(comm, fd, "-----------------------------");CHKERRQ(ierr); 18534863603aSSatish Balay } 1854d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1855958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd, "---------------------------------------");CHKERRQ(ierr); 18564863603aSSatish Balay #endif 18574863603aSSatish Balay ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 18585c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 18595c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n");CHKERRQ(ierr); 18605c6c1daeSBarry Smith 18615c6c1daeSBarry Smith /* Right now, only stages on the first processor are reported here, meaning only objects associated with 18625c6c1daeSBarry Smith the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then 18635c6c1daeSBarry Smith stats for stages local to processor sets. 18645c6c1daeSBarry Smith */ 18655c6c1daeSBarry Smith /* We should figure out the longest object name here (now 20 characters) */ 18665c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Object Type Creations Destructions Memory Descendants' Mem.\n");CHKERRQ(ierr); 18675c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Reports information only for process 0.\n");CHKERRQ(ierr); 18685c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 18695c6c1daeSBarry Smith if (localStageUsed[stage]) { 18705c6c1daeSBarry Smith classInfo = stageLog->stageInfo[stage].classLog->classInfo; 18715c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 18725c6c1daeSBarry Smith for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) { 18735c6c1daeSBarry Smith if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) { 18745c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%20s %5d %5d %11.0f %g\n", stageLog->classLog->classInfo[oclass].name, 18755c6c1daeSBarry Smith classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem, 18765c6c1daeSBarry Smith classInfo[oclass].descMem);CHKERRQ(ierr); 18775c6c1daeSBarry Smith } 18785c6c1daeSBarry Smith } 18795c6c1daeSBarry Smith } else { 1880cf019ec6SStefano Zampini if (!localStageVisible[stage]) continue; 18815c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 18825c6c1daeSBarry Smith } 18835c6c1daeSBarry Smith } 18845c6c1daeSBarry Smith 18855c6c1daeSBarry Smith ierr = PetscFree(localStageUsed);CHKERRQ(ierr); 18865c6c1daeSBarry Smith ierr = PetscFree(stageUsed);CHKERRQ(ierr); 18875c6c1daeSBarry Smith ierr = PetscFree(localStageVisible);CHKERRQ(ierr); 18885c6c1daeSBarry Smith ierr = PetscFree(stageVisible);CHKERRQ(ierr); 18895c6c1daeSBarry Smith 18905c6c1daeSBarry Smith /* Information unrelated to this particular run */ 1891a297a907SKarl Rupp ierr = PetscFPrintf(comm, fd, "========================================================================================================================\n");CHKERRQ(ierr); 18928563dfccSBarry Smith PetscTime(&y); 18938563dfccSBarry Smith PetscTime(&x); 18948563dfccSBarry Smith PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 18958563dfccSBarry Smith PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 18965c6c1daeSBarry Smith ierr = PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0);CHKERRQ(ierr); 18975c6c1daeSBarry Smith /* MPI information */ 18985c6c1daeSBarry Smith if (size > 1) { 18995c6c1daeSBarry Smith MPI_Status status; 19005c6c1daeSBarry Smith PetscMPIInt tag; 19015c6c1daeSBarry Smith MPI_Comm newcomm; 19025c6c1daeSBarry Smith 1903ffc4695bSBarry Smith ierr = MPI_Barrier(comm);CHKERRMPI(ierr); 19048563dfccSBarry Smith PetscTime(&x); 1905ffc4695bSBarry Smith ierr = MPI_Barrier(comm);CHKERRMPI(ierr); 1906ffc4695bSBarry Smith ierr = MPI_Barrier(comm);CHKERRMPI(ierr); 1907ffc4695bSBarry Smith ierr = MPI_Barrier(comm);CHKERRMPI(ierr); 1908ffc4695bSBarry Smith ierr = MPI_Barrier(comm);CHKERRMPI(ierr); 1909ffc4695bSBarry Smith ierr = MPI_Barrier(comm);CHKERRMPI(ierr); 19108563dfccSBarry Smith PetscTime(&y); 19115c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0);CHKERRQ(ierr); 19125c6c1daeSBarry Smith ierr = PetscCommDuplicate(comm,&newcomm, &tag);CHKERRQ(ierr); 1913ffc4695bSBarry Smith ierr = MPI_Barrier(comm);CHKERRMPI(ierr); 19145c6c1daeSBarry Smith if (rank) { 1915ffc4695bSBarry Smith ierr = MPI_Recv(NULL, 0, MPI_INT, rank-1, tag, newcomm, &status);CHKERRMPI(ierr); 1916ffc4695bSBarry Smith ierr = MPI_Send(NULL, 0, MPI_INT, (rank+1)%size, tag, newcomm);CHKERRMPI(ierr); 19175c6c1daeSBarry Smith } else { 19188563dfccSBarry Smith PetscTime(&x); 1919ffc4695bSBarry Smith ierr = MPI_Send(NULL, 0, MPI_INT, 1, tag, newcomm);CHKERRMPI(ierr); 1920ffc4695bSBarry Smith ierr = MPI_Recv(NULL, 0, MPI_INT, size-1, tag, newcomm, &status);CHKERRMPI(ierr); 19218563dfccSBarry Smith PetscTime(&y); 19225c6c1daeSBarry Smith ierr = PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size);CHKERRQ(ierr); 19235c6c1daeSBarry Smith } 19245c6c1daeSBarry Smith ierr = PetscCommDestroy(&newcomm);CHKERRQ(ierr); 19255c6c1daeSBarry Smith } 1926c5929fdfSBarry Smith ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr); 19275c6c1daeSBarry Smith 19285c6c1daeSBarry Smith /* Machine and compile information */ 19295c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS) 19305c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n");CHKERRQ(ierr); 19315c6c1daeSBarry Smith #else 19325c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n");CHKERRQ(ierr); 19335c6c1daeSBarry Smith #endif 1934217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) 1935217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n");CHKERRQ(ierr); 1936217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128) 1937217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n");CHKERRQ(ierr); 1938217044c2SLisandro Dalcin #endif 19395c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 19405c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 19415f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128) 19425f27b2e0SBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 19435c6c1daeSBarry Smith #endif 19445c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE) 19455c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with single precision matrices\n");CHKERRQ(ierr); 19465c6c1daeSBarry Smith #else 19475c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n");CHKERRQ(ierr); 19485c6c1daeSBarry Smith #endif 19495c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n", 19505c6c1daeSBarry Smith (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt));CHKERRQ(ierr); 19515c6c1daeSBarry Smith 19525c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions);CHKERRQ(ierr); 19535c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petscmachineinfo);CHKERRQ(ierr); 19545c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsccompilerinfo);CHKERRQ(ierr); 19555c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo);CHKERRQ(ierr); 19565c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsclinkerinfo);CHKERRQ(ierr); 19575c6c1daeSBarry Smith 19585c6c1daeSBarry Smith /* Cleanup */ 19595c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 1960c2a741eeSJunchao Zhang ierr = PetscLogViewWarnNoGpuAwareMpi(comm,fd);CHKERRQ(ierr); 1961f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 19625c6c1daeSBarry Smith PetscFunctionReturn(0); 19635c6c1daeSBarry Smith } 19645c6c1daeSBarry Smith 19657d6c928cSSatish Balay /*@C 19667d6c928cSSatish Balay PetscLogView - Prints a summary of the logging. 19675c6c1daeSBarry Smith 19685c6c1daeSBarry Smith Collective over MPI_Comm 19695c6c1daeSBarry Smith 19705c6c1daeSBarry Smith Input Parameter: 1971f14045dbSBarry Smith . viewer - an ASCII viewer 19725c6c1daeSBarry Smith 19735c6c1daeSBarry Smith Options Database Keys: 1974bb1d7374SBarry Smith + -log_view [:filename] - Prints summary of log information 1975bb1d7374SBarry Smith . -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file 1976607d249eSBarry 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) 1977d0a29bd7SConnor 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) 1978bb1d7374SBarry Smith . -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation 1979bb1d7374SBarry Smith - -log_trace [filename] - Displays a trace of what each process is doing 19805c6c1daeSBarry Smith 19815c6c1daeSBarry Smith Notes: 1982bb1d7374SBarry Smith It is possible to control the logging programatically but we recommend using the options database approach whenever possible 19835c6c1daeSBarry Smith By default the summary is printed to stdout. 19845c6c1daeSBarry Smith 1985bb1d7374SBarry Smith Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin() 1986bb1d7374SBarry Smith 1987bb1d7374SBarry Smith If PETSc is configured with --with-logging=0 then this functionality is not available 1988bb1d7374SBarry Smith 1989607d249eSBarry Smith To view the nested XML format filename.xml first copy ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current 1990607d249eSBarry Smith directory then open filename.xml with your browser. Specific notes for certain browsers 1991607d249eSBarry Smith $ Firefox and Internet explorer - simply open the file 1992607d249eSBarry Smith $ Google Chrome - you must start up Chrome with the option --allow-file-access-from-files 1993a8d69d7bSBarry Smith $ Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access 1994607d249eSBarry 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 1995607d249eSBarry Smith your browser. 19962add09c0SLisandro Dalcin Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser 19972add09c0SLisandro Dalcin window and render the XML log file contents. 1998607d249eSBarry Smith 1999bb1d7374SBarry Smith The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij MARITIME RESEARCH INSTITUTE NETHERLANDS 2000bb1d7374SBarry Smith 2001d0a29bd7SConnor Ward The Flame Graph output can be visualised using either the original Flame Graph script (https://github.com/brendangregg/FlameGraph) 2002d0a29bd7SConnor Ward or using speedscope (https://www.speedscope.app). 2003d0a29bd7SConnor Ward Old XML profiles may be converted into this format using the script ${PETSC_DIR}/lib/petsc/bin/xml2flamegraph.py. 2004d0a29bd7SConnor Ward 20055c6c1daeSBarry Smith Level: beginner 20065c6c1daeSBarry Smith 2007bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogDump() 20085c6c1daeSBarry Smith @*/ 2009f14045dbSBarry Smith PetscErrorCode PetscLogView(PetscViewer viewer) 20105c6c1daeSBarry Smith { 20115c6c1daeSBarry Smith PetscErrorCode ierr; 2012f14045dbSBarry Smith PetscBool isascii; 2013f14045dbSBarry Smith PetscViewerFormat format; 201437b78d16SBarry Smith int stage, lastStage; 201537b78d16SBarry Smith PetscStageLog stageLog; 20165c6c1daeSBarry Smith 20175c6c1daeSBarry Smith PetscFunctionBegin; 2018609bdbeeSBarry Smith if (!PetscLogPLB) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Must use -log_view or PetscLogDefaultBegin() before calling this routine"); 201937b78d16SBarry Smith /* Pop off any stages the user forgot to remove */ 202037b78d16SBarry Smith lastStage = 0; 202137b78d16SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 202237b78d16SBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 202337b78d16SBarry Smith while (stage >= 0) { 202437b78d16SBarry Smith lastStage = stage; 202537b78d16SBarry Smith ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 202637b78d16SBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 202737b78d16SBarry Smith } 2028f14045dbSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 2029f14045dbSBarry Smith if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Currently can only view logging to ASCII"); 2030f14045dbSBarry Smith ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr); 2031f14045dbSBarry Smith if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) { 2032f14045dbSBarry Smith ierr = PetscLogView_Default(viewer);CHKERRQ(ierr); 2033f14045dbSBarry Smith } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) { 2034f14045dbSBarry Smith ierr = PetscLogView_Detailed(viewer);CHKERRQ(ierr); 203538144912Sdeepblu2718 } else if (format == PETSC_VIEWER_ASCII_CSV) { 203638144912Sdeepblu2718 ierr = PetscLogView_CSV(viewer);CHKERRQ(ierr); 2037bb1d7374SBarry Smith } else if (format == PETSC_VIEWER_ASCII_XML) { 2038bb1d7374SBarry Smith ierr = PetscLogView_Nested(viewer);CHKERRQ(ierr); 2039d0a29bd7SConnor Ward } else if (format == PETSC_VIEWER_ASCII_FLAMEGRAPH) { 2040d0a29bd7SConnor Ward ierr = PetscLogView_Flamegraph(viewer);CHKERRQ(ierr); 20415c6c1daeSBarry Smith } 204237b78d16SBarry Smith ierr = PetscStageLogPush(stageLog, lastStage);CHKERRQ(ierr); 20435c6c1daeSBarry Smith PetscFunctionReturn(0); 20445c6c1daeSBarry Smith } 20455c6c1daeSBarry Smith 2046f14045dbSBarry Smith /*@C 2047f14045dbSBarry Smith PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed. 2048f14045dbSBarry Smith 2049f14045dbSBarry Smith Collective on PETSC_COMM_WORLD 2050f14045dbSBarry Smith 2051f14045dbSBarry Smith Not normally called by user 2052f14045dbSBarry Smith 2053f14045dbSBarry Smith Level: intermediate 2054f14045dbSBarry Smith 2055f14045dbSBarry Smith @*/ 2056f14045dbSBarry Smith PetscErrorCode PetscLogViewFromOptions(void) 2057f14045dbSBarry Smith { 2058f14045dbSBarry Smith PetscErrorCode ierr; 2059f14045dbSBarry Smith PetscViewer viewer; 2060f14045dbSBarry Smith PetscBool flg; 2061f14045dbSBarry Smith PetscViewerFormat format; 2062f14045dbSBarry Smith 2063f14045dbSBarry Smith PetscFunctionBegin; 206416413a6aSBarry Smith ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-log_view",&viewer,&format,&flg);CHKERRQ(ierr); 2065f14045dbSBarry Smith if (flg) { 2066f14045dbSBarry Smith ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 2067f14045dbSBarry Smith ierr = PetscLogView(viewer);CHKERRQ(ierr); 2068f14045dbSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 2069f14045dbSBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 2070f14045dbSBarry Smith } 2071f14045dbSBarry Smith PetscFunctionReturn(0); 2072f14045dbSBarry Smith } 2073f14045dbSBarry Smith 20745c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/ 20755c6c1daeSBarry Smith /*@C 20765c6c1daeSBarry Smith PetscGetFlops - Returns the number of flops used on this processor 20775c6c1daeSBarry Smith since the program began. 20785c6c1daeSBarry Smith 20795c6c1daeSBarry Smith Not Collective 20805c6c1daeSBarry Smith 20815c6c1daeSBarry Smith Output Parameter: 20825c6c1daeSBarry Smith flops - number of floating point operations 20835c6c1daeSBarry Smith 20845c6c1daeSBarry Smith Notes: 20855c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 20865c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 20875c6c1daeSBarry Smith application code. 20885c6c1daeSBarry Smith 20895c6c1daeSBarry Smith Level: intermediate 20905c6c1daeSBarry Smith 20918563dfccSBarry Smith .seealso: PetscTime(), PetscLogFlops() 20925c6c1daeSBarry Smith @*/ 20935c6c1daeSBarry Smith PetscErrorCode PetscGetFlops(PetscLogDouble *flops) 20945c6c1daeSBarry Smith { 20955c6c1daeSBarry Smith PetscFunctionBegin; 20965c6c1daeSBarry Smith *flops = petsc_TotalFlops; 20975c6c1daeSBarry Smith PetscFunctionReturn(0); 20985c6c1daeSBarry Smith } 20995c6c1daeSBarry Smith 21005c6c1daeSBarry Smith PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 21015c6c1daeSBarry Smith { 21025c6c1daeSBarry Smith PetscErrorCode ierr; 21035c6c1daeSBarry Smith size_t fullLength; 21045c6c1daeSBarry Smith va_list Argp; 21055c6c1daeSBarry Smith 21065c6c1daeSBarry Smith PetscFunctionBegin; 21075c6c1daeSBarry Smith if (!petsc_logObjects) PetscFunctionReturn(0); 21085c6c1daeSBarry Smith va_start(Argp, format); 21095c6c1daeSBarry Smith ierr = PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp);CHKERRQ(ierr); 21105c6c1daeSBarry Smith va_end(Argp); 21115c6c1daeSBarry Smith PetscFunctionReturn(0); 21125c6c1daeSBarry Smith } 21135c6c1daeSBarry Smith 21145c6c1daeSBarry Smith /*MC 21155c6c1daeSBarry Smith PetscLogFlops - Adds floating point operations to the global counter. 21165c6c1daeSBarry Smith 21175c6c1daeSBarry Smith Synopsis: 2118aaa7dc30SBarry Smith #include <petsclog.h> 21195c6c1daeSBarry Smith PetscErrorCode PetscLogFlops(PetscLogDouble f) 21205c6c1daeSBarry Smith 21215c6c1daeSBarry Smith Not Collective 21225c6c1daeSBarry Smith 21235c6c1daeSBarry Smith Input Parameter: 21245c6c1daeSBarry Smith . f - flop counter 21255c6c1daeSBarry Smith 21265c6c1daeSBarry Smith Usage: 21275c6c1daeSBarry Smith .vb 21285c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 21295c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 21305c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 21315c6c1daeSBarry Smith [code segment to monitor] 21325c6c1daeSBarry Smith PetscLogFlops(user_flops) 21335c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 21345c6c1daeSBarry Smith .ve 21355c6c1daeSBarry Smith 21365c6c1daeSBarry Smith Notes: 21375c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 21385c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 21395c6c1daeSBarry Smith application code. 21405c6c1daeSBarry Smith 21415c6c1daeSBarry Smith Level: intermediate 21425c6c1daeSBarry Smith 21435c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscGetFlops() 21445c6c1daeSBarry Smith 21455c6c1daeSBarry Smith M*/ 21465c6c1daeSBarry Smith 21475c6c1daeSBarry Smith /*MC 21485c6c1daeSBarry Smith PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice) 21495c6c1daeSBarry Smith to get accurate timings 21505c6c1daeSBarry Smith 21515c6c1daeSBarry Smith Synopsis: 2152aaa7dc30SBarry Smith #include <petsclog.h> 21535c6c1daeSBarry Smith void PetscPreLoadBegin(PetscBool flag,char *name); 21545c6c1daeSBarry Smith 21555c6c1daeSBarry Smith Not Collective 21565c6c1daeSBarry Smith 21575c6c1daeSBarry Smith Input Parameter: 21585c6c1daeSBarry Smith + flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden 21595c6c1daeSBarry Smith with command line option -preload true or -preload false 2160609bdbeeSBarry Smith - name - name of first stage (lines of code timed separately with -log_view) to 21615c6c1daeSBarry Smith be preloaded 21625c6c1daeSBarry Smith 21635c6c1daeSBarry Smith Usage: 21645c6c1daeSBarry Smith .vb 21655c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 21665c6c1daeSBarry Smith lines of code 21675c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 21685c6c1daeSBarry Smith lines of code 21695c6c1daeSBarry Smith PetscPreLoadEnd(); 21705c6c1daeSBarry Smith .ve 21715c6c1daeSBarry Smith 217295452b02SPatrick Sanan Notes: 217395452b02SPatrick Sanan Only works in C/C++, not Fortran 21745c6c1daeSBarry Smith 21755c6c1daeSBarry Smith Flags available within the macro. 21765c6c1daeSBarry Smith + PetscPreLoadingUsed - true if we are or have done preloading 21775c6c1daeSBarry Smith . PetscPreLoadingOn - true if it is CURRENTLY doing preload 21785c6c1daeSBarry Smith . PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second 21795c6c1daeSBarry Smith - PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on 21805c6c1daeSBarry Smith The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin() 21815c6c1daeSBarry Smith and PetscPreLoadEnd() 21825c6c1daeSBarry Smith 21835c6c1daeSBarry Smith Level: intermediate 21845c6c1daeSBarry Smith 21855c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage() 21865c6c1daeSBarry Smith 21875c6c1daeSBarry Smith M*/ 21885c6c1daeSBarry Smith 21895c6c1daeSBarry Smith /*MC 21905c6c1daeSBarry Smith PetscPreLoadEnd - End a segment of code that may be preloaded (run twice) 21915c6c1daeSBarry Smith to get accurate timings 21925c6c1daeSBarry Smith 21935c6c1daeSBarry Smith Synopsis: 2194aaa7dc30SBarry Smith #include <petsclog.h> 21955c6c1daeSBarry Smith void PetscPreLoadEnd(void); 21965c6c1daeSBarry Smith 21975c6c1daeSBarry Smith Not Collective 21985c6c1daeSBarry Smith 21995c6c1daeSBarry Smith Usage: 22005c6c1daeSBarry Smith .vb 22015c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22025c6c1daeSBarry Smith lines of code 22035c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22045c6c1daeSBarry Smith lines of code 22055c6c1daeSBarry Smith PetscPreLoadEnd(); 22065c6c1daeSBarry Smith .ve 22075c6c1daeSBarry Smith 220895452b02SPatrick Sanan Notes: 220995452b02SPatrick Sanan only works in C/C++ not fortran 22105c6c1daeSBarry Smith 22115c6c1daeSBarry Smith Level: intermediate 22125c6c1daeSBarry Smith 22135c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadStage() 22145c6c1daeSBarry Smith 22155c6c1daeSBarry Smith M*/ 22165c6c1daeSBarry Smith 22175c6c1daeSBarry Smith /*MC 22185c6c1daeSBarry Smith PetscPreLoadStage - Start a new segment of code to be timed separately. 22195c6c1daeSBarry Smith to get accurate timings 22205c6c1daeSBarry Smith 22215c6c1daeSBarry Smith Synopsis: 2222aaa7dc30SBarry Smith #include <petsclog.h> 22235c6c1daeSBarry Smith void PetscPreLoadStage(char *name); 22245c6c1daeSBarry Smith 22255c6c1daeSBarry Smith Not Collective 22265c6c1daeSBarry Smith 22275c6c1daeSBarry Smith Usage: 22285c6c1daeSBarry Smith .vb 22295c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22305c6c1daeSBarry Smith lines of code 22315c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22325c6c1daeSBarry Smith lines of code 22335c6c1daeSBarry Smith PetscPreLoadEnd(); 22345c6c1daeSBarry Smith .ve 22355c6c1daeSBarry Smith 223695452b02SPatrick Sanan Notes: 223795452b02SPatrick Sanan only works in C/C++ not fortran 22385c6c1daeSBarry Smith 22395c6c1daeSBarry Smith Level: intermediate 22405c6c1daeSBarry Smith 22415c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd() 22425c6c1daeSBarry Smith 22435c6c1daeSBarry Smith M*/ 22445c6c1daeSBarry Smith 22459ffd0706SHong Zhang #if defined(PETSC_HAVE_DEVICE) 22469ffd0706SHong Zhang 22479ffd0706SHong Zhang #if defined(PETSC_HAVE_CUDA) 22489ffd0706SHong Zhang #include <cuda_runtime.h> 22499ffd0706SHong Zhang #include <petsccublas.h> 22509ffd0706SHong Zhang PETSC_EXTERN cudaEvent_t petsc_gputimer_begin; 22519ffd0706SHong Zhang PETSC_EXTERN cudaEvent_t petsc_gputimer_end; 22529ffd0706SHong Zhang #endif 22539ffd0706SHong Zhang 22549ffd0706SHong Zhang #if defined(PETSC_HAVE_HIP) 22559ffd0706SHong Zhang #include <hip/hip_runtime.h> 22569ffd0706SHong Zhang #include <petschipblas.h> 22579ffd0706SHong Zhang PETSC_EXTERN hipEvent_t petsc_gputimer_begin; 22589ffd0706SHong Zhang PETSC_EXTERN hipEvent_t petsc_gputimer_end; 22599ffd0706SHong Zhang #endif 22609ffd0706SHong Zhang 22619ffd0706SHong Zhang /*-------------------------------------------- GPU event Functions ----------------------------------------------*/ 22629ffd0706SHong Zhang /*@C 22639ffd0706SHong Zhang PetscLogGpuTimeBegin - Start timer for device 22649ffd0706SHong Zhang 22659ffd0706SHong Zhang Notes: 22669ffd0706SHong 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). 22679ffd0706SHong 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). 22689ffd0706SHong Zhang There is no need to call WaitForCUDA() or WaitForHIP() between PetscLogGpuTimeBegin and PetscLogGpuTimeEnd 22699ffd0706SHong Zhang This timer should NOT include times for data transfers between the GPU and CPU, nor setup actions such as allocating space. 22709ffd0706SHong Zhang The regular logging captures the time for data transfers and any CPU activites during the event 22719ffd0706SHong Zhang It is used to compute the flop rate on the GPU as it is actively engaged in running a kernel. 22729ffd0706SHong Zhang 22739ffd0706SHong Zhang Developer Notes: 22749ffd0706SHong 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(). 22759ffd0706SHong 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. 22769ffd0706SHong Zhang 22779ffd0706SHong Zhang Level: intermediate 22789ffd0706SHong Zhang 22799ffd0706SHong Zhang .seealso: PetscLogView(), PetscLogGpuFlops(), PetscLogGpuTimeEnd() 22809ffd0706SHong Zhang @*/ 22819ffd0706SHong Zhang PetscErrorCode PetscLogGpuTimeBegin(void) 22829ffd0706SHong Zhang { 22839ffd0706SHong Zhang #if defined(PETSC_HAVE_CUDA) 22849ffd0706SHong Zhang cudaError_t cerr; 22859ffd0706SHong Zhang #elif defined(PETSC_HAVE_HIP) 22869ffd0706SHong Zhang hipError_t cerr; 22879ffd0706SHong Zhang #else 22889ffd0706SHong Zhang PetscErrorCode ierr; 22899ffd0706SHong Zhang #endif 22909ffd0706SHong Zhang PetscFunctionBegin; 22919ffd0706SHong Zhang #if defined(PETSC_USE_DEBUG) 22929ffd0706SHong Zhang if (petsc_gtime_inuse) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Forgot to call PetscLogGpuTimeEnd()?"); 22939ffd0706SHong Zhang petsc_gtime_inuse = PETSC_TRUE; 22949ffd0706SHong Zhang #endif 22959ffd0706SHong Zhang #if defined(PETSC_HAVE_CUDA) 22969ffd0706SHong Zhang cerr = cudaEventRecord(petsc_gputimer_begin,PetscDefaultCudaStream);CHKERRCUDA(cerr); 22979ffd0706SHong Zhang #elif defined(PETSC_HAVE_HIP) 22989ffd0706SHong Zhang cerr = hipEventRecord(petsc_gputimer_begin,PetscDefaultHipStream);CHKERRHIP(cerr); 22999ffd0706SHong Zhang #else 23009ffd0706SHong Zhang ierr = PetscTimeSubtract(&petsc_gtime);CHKERRQ(ierr); 23019ffd0706SHong Zhang #endif 23029ffd0706SHong Zhang PetscFunctionReturn(0); 23039ffd0706SHong Zhang } 23049ffd0706SHong Zhang 23059ffd0706SHong Zhang /*@C 23069ffd0706SHong Zhang PetscLogGpuTimeEnd - Stop timer for device 23079ffd0706SHong Zhang 23089ffd0706SHong Zhang Level: intermediate 23099ffd0706SHong Zhang 23109ffd0706SHong Zhang .seealso: PetscLogView(), PetscLogGpuFlops(), PetscLogGpuTimeBegin() 23119ffd0706SHong Zhang @*/ 23129ffd0706SHong Zhang PetscErrorCode PetscLogGpuTimeEnd(void) 23139ffd0706SHong Zhang { 23149ffd0706SHong Zhang #if defined(PETSC_HAVE_CUDA) 23159ffd0706SHong Zhang float gtime; 23169ffd0706SHong Zhang cudaError_t cerr; 23179ffd0706SHong Zhang #elif defined(PETSC_HAVE_HIP) 23189ffd0706SHong Zhang float gtime; 23199ffd0706SHong Zhang hipError_t cerr; 23209ffd0706SHong Zhang #else 23219ffd0706SHong Zhang PetscErrorCode ierr; 23229ffd0706SHong Zhang #endif 23239ffd0706SHong Zhang PetscFunctionBegin; 23249ffd0706SHong Zhang #if defined(PETSC_USE_DEBUG) 23259ffd0706SHong Zhang if (!petsc_gtime_inuse) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Forgot to call PetscLogGpuTimeBegin()?"); 23269ffd0706SHong Zhang petsc_gtime_inuse = PETSC_FALSE; 23279ffd0706SHong Zhang #endif 23289ffd0706SHong Zhang #if defined(PETSC_HAVE_CUDA) 23299ffd0706SHong Zhang cerr = cudaEventRecord(petsc_gputimer_end,PetscDefaultCudaStream);CHKERRCUDA(cerr); 23309ffd0706SHong Zhang cerr = cudaEventSynchronize(petsc_gputimer_end);CHKERRCUDA(cerr); 23319ffd0706SHong Zhang cerr = cudaEventElapsedTime(>ime,petsc_gputimer_begin,petsc_gputimer_end);CHKERRCUDA(cerr); 23329ffd0706SHong Zhang petsc_gtime += (PetscLogDouble)gtime/1000.0; /* convert milliseconds to seconds */ 23339ffd0706SHong Zhang #elif defined(PETSC_HAVE_HIP) 23349ffd0706SHong Zhang cerr = hipEventRecord(petsc_gputimer_end,PetscDefaultHipStream);CHKERRHIP(cerr); 23359ffd0706SHong Zhang cerr = hipEventSynchronize(petsc_gputimer_end);CHKERRHIP(cerr); 23369ffd0706SHong Zhang cerr = hipEventElapsedTime(>ime,petsc_gputimer_begin,petsc_gputimer_end);CHKERRHIP(cerr); 23379ffd0706SHong Zhang petsc_gtime += (PetscLogDouble)gtime/1000.0; /* convert milliseconds to seconds */ 23389ffd0706SHong Zhang #else 23399ffd0706SHong Zhang ierr = PetscTimeAdd(&petsc_gtime);CHKERRQ(ierr); 23409ffd0706SHong Zhang #endif 23419ffd0706SHong Zhang PetscFunctionReturn(0); 23429ffd0706SHong Zhang } 23439ffd0706SHong Zhang #endif /* end of PETSC_HAVE_DEVICE */ 23449ffd0706SHong Zhang 23455c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */ 23465c6c1daeSBarry Smith 23475c6c1daeSBarry Smith PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 23485c6c1daeSBarry Smith { 23495c6c1daeSBarry Smith PetscFunctionBegin; 23505c6c1daeSBarry Smith PetscFunctionReturn(0); 23515c6c1daeSBarry Smith } 23525c6c1daeSBarry Smith 23535c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/ 23545c6c1daeSBarry Smith 23555c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 23565c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID = 0; 23575c6c1daeSBarry Smith 23585c6c1daeSBarry Smith /*@C 23595c6c1daeSBarry Smith PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code. 23605c6c1daeSBarry Smith 23615c6c1daeSBarry Smith Not Collective 23625c6c1daeSBarry Smith 23635c6c1daeSBarry Smith Input Parameter: 23645c6c1daeSBarry Smith . name - The class name 23655c6c1daeSBarry Smith 23665c6c1daeSBarry Smith Output Parameter: 23675c6c1daeSBarry Smith . oclass - The class id or classid 23685c6c1daeSBarry Smith 23695c6c1daeSBarry Smith Level: developer 23705c6c1daeSBarry Smith 23715c6c1daeSBarry Smith @*/ 23725c6c1daeSBarry Smith PetscErrorCode PetscClassIdRegister(const char name[],PetscClassId *oclass) 23735c6c1daeSBarry Smith { 23745c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 23755c6c1daeSBarry Smith PetscStageLog stageLog; 23765c6c1daeSBarry Smith PetscInt stage; 23775c6c1daeSBarry Smith PetscErrorCode ierr; 23785c6c1daeSBarry Smith #endif 23795c6c1daeSBarry Smith 23805c6c1daeSBarry Smith PetscFunctionBegin; 23815c6c1daeSBarry Smith *oclass = ++PETSC_LARGEST_CLASSID; 23825c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 23835c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 23845c6c1daeSBarry Smith ierr = PetscClassRegLogRegister(stageLog->classLog, name, *oclass);CHKERRQ(ierr); 23855c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 23863a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 23875c6c1daeSBarry Smith } 23885c6c1daeSBarry Smith #endif 23895c6c1daeSBarry Smith PetscFunctionReturn(0); 23905c6c1daeSBarry Smith } 2391210b5426SBarry Smith 2392210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE) 2393210b5426SBarry Smith #include <mpe.h> 2394210b5426SBarry Smith 2395210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE; 2396210b5426SBarry Smith 2397495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2398495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2399495fc317SBarry Smith 2400210b5426SBarry Smith /*@C 2401210b5426SBarry Smith PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files 2402210b5426SBarry Smith and slows the program down. 2403210b5426SBarry Smith 2404210b5426SBarry Smith Collective over PETSC_COMM_WORLD 2405210b5426SBarry Smith 2406210b5426SBarry Smith Options Database Keys: 2407a2553e36SBarry Smith . -log_mpe - Prints extensive log information 2408210b5426SBarry Smith 2409210b5426SBarry Smith Notes: 2410609bdbeeSBarry Smith A related routine is PetscLogDefaultBegin() (with the options key -log_view), which is 2411210b5426SBarry Smith intended for production runs since it logs only flop rates and object 2412210b5426SBarry Smith creation (and should not significantly slow the programs). 2413210b5426SBarry Smith 2414210b5426SBarry Smith Level: advanced 2415210b5426SBarry Smith 2416bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogEventActivate(), 2417210b5426SBarry Smith PetscLogEventDeactivate() 2418210b5426SBarry Smith @*/ 2419210b5426SBarry Smith PetscErrorCode PetscLogMPEBegin(void) 2420210b5426SBarry Smith { 2421210b5426SBarry Smith PetscErrorCode ierr; 2422210b5426SBarry Smith 2423210b5426SBarry Smith PetscFunctionBegin; 2424210b5426SBarry Smith /* Do MPE initialization */ 2425210b5426SBarry Smith if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */ 2426210b5426SBarry Smith ierr = PetscInfo(0,"Initializing MPE.\n");CHKERRQ(ierr); 2427210b5426SBarry Smith ierr = MPE_Init_log();CHKERRQ(ierr); 2428210b5426SBarry Smith 2429210b5426SBarry Smith PetscBeganMPE = PETSC_TRUE; 2430210b5426SBarry Smith } else { 2431210b5426SBarry Smith ierr = PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n");CHKERRQ(ierr); 2432210b5426SBarry Smith } 2433495fc317SBarry Smith ierr = PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE);CHKERRQ(ierr); 2434210b5426SBarry Smith PetscFunctionReturn(0); 2435210b5426SBarry Smith } 2436210b5426SBarry Smith 2437210b5426SBarry Smith /*@C 2438495fc317SBarry Smith PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot. 2439210b5426SBarry Smith 2440210b5426SBarry Smith Collective over PETSC_COMM_WORLD 2441210b5426SBarry Smith 2442210b5426SBarry Smith Level: advanced 2443210b5426SBarry Smith 2444210b5426SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogMPEBegin() 2445210b5426SBarry Smith @*/ 2446210b5426SBarry Smith PetscErrorCode PetscLogMPEDump(const char sname[]) 2447210b5426SBarry Smith { 2448210b5426SBarry Smith char name[PETSC_MAX_PATH_LEN]; 2449210b5426SBarry Smith PetscErrorCode ierr; 2450210b5426SBarry Smith 2451210b5426SBarry Smith PetscFunctionBegin; 2452210b5426SBarry Smith if (PetscBeganMPE) { 2453210b5426SBarry Smith ierr = PetscInfo(0,"Finalizing MPE.\n");CHKERRQ(ierr); 2454210b5426SBarry Smith if (sname) { 2455210b5426SBarry Smith ierr = PetscStrcpy(name,sname);CHKERRQ(ierr); 2456210b5426SBarry Smith } else { 2457589a23caSBarry Smith ierr = PetscGetProgramName(name,sizeof(name));CHKERRQ(ierr); 2458210b5426SBarry Smith } 2459210b5426SBarry Smith ierr = MPE_Finish_log(name);CHKERRQ(ierr); 2460210b5426SBarry Smith } else { 2461210b5426SBarry Smith ierr = PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n");CHKERRQ(ierr); 2462210b5426SBarry Smith } 2463210b5426SBarry Smith PetscFunctionReturn(0); 2464210b5426SBarry Smith } 2465210b5426SBarry Smith 2466210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39 2467210b5426SBarry Smith static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = { 2468210b5426SBarry Smith "OliveDrab: ", 2469210b5426SBarry Smith "BlueViolet: ", 2470210b5426SBarry Smith "CadetBlue: ", 2471210b5426SBarry Smith "CornflowerBlue: ", 2472210b5426SBarry Smith "DarkGoldenrod: ", 2473210b5426SBarry Smith "DarkGreen: ", 2474210b5426SBarry Smith "DarkKhaki: ", 2475210b5426SBarry Smith "DarkOliveGreen: ", 2476210b5426SBarry Smith "DarkOrange: ", 2477210b5426SBarry Smith "DarkOrchid: ", 2478210b5426SBarry Smith "DarkSeaGreen: ", 2479210b5426SBarry Smith "DarkSlateGray: ", 2480210b5426SBarry Smith "DarkTurquoise: ", 2481210b5426SBarry Smith "DeepPink: ", 2482210b5426SBarry Smith "DarkKhaki: ", 2483210b5426SBarry Smith "DimGray: ", 2484210b5426SBarry Smith "DodgerBlue: ", 2485210b5426SBarry Smith "GreenYellow: ", 2486210b5426SBarry Smith "HotPink: ", 2487210b5426SBarry Smith "IndianRed: ", 2488210b5426SBarry Smith "LavenderBlush: ", 2489210b5426SBarry Smith "LawnGreen: ", 2490210b5426SBarry Smith "LemonChiffon: ", 2491210b5426SBarry Smith "LightCoral: ", 2492210b5426SBarry Smith "LightCyan: ", 2493210b5426SBarry Smith "LightPink: ", 2494210b5426SBarry Smith "LightSalmon: ", 2495210b5426SBarry Smith "LightSlateGray: ", 2496210b5426SBarry Smith "LightYellow: ", 2497210b5426SBarry Smith "LimeGreen: ", 2498210b5426SBarry Smith "MediumPurple: ", 2499210b5426SBarry Smith "MediumSeaGreen: ", 2500210b5426SBarry Smith "MediumSlateBlue:", 2501210b5426SBarry Smith "MidnightBlue: ", 2502210b5426SBarry Smith "MintCream: ", 2503210b5426SBarry Smith "MistyRose: ", 2504210b5426SBarry Smith "NavajoWhite: ", 2505210b5426SBarry Smith "NavyBlue: ", 2506210b5426SBarry Smith "OliveDrab: " 2507210b5426SBarry Smith }; 2508210b5426SBarry Smith 2509210b5426SBarry Smith /*@C 2510210b5426SBarry Smith PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister() 2511210b5426SBarry Smith 2512210b5426SBarry Smith Not collective. Maybe it should be? 2513210b5426SBarry Smith 25147a7aea1fSJed Brown Output Parameter: 2515210b5426SBarry Smith . str - character string representing the color 2516210b5426SBarry Smith 2517210b5426SBarry Smith Level: developer 2518210b5426SBarry Smith 2519210b5426SBarry Smith .seealso: PetscLogEventRegister 2520210b5426SBarry Smith @*/ 2521210b5426SBarry Smith PetscErrorCode PetscLogMPEGetRGBColor(const char *str[]) 2522210b5426SBarry Smith { 2523210b5426SBarry Smith static int idx = 0; 2524210b5426SBarry Smith 2525210b5426SBarry Smith PetscFunctionBegin; 2526210b5426SBarry Smith *str = PetscLogMPERGBColors[idx]; 2527210b5426SBarry Smith idx = (idx + 1)% PETSC_RGB_COLORS_MAX; 2528210b5426SBarry Smith PetscFunctionReturn(0); 2529210b5426SBarry Smith } 2530210b5426SBarry Smith 2531210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */ 2532