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 */ 8845c4b7c1SBarry Smith PetscLogDouble petsc_ctog_ct_scalar = 0.0; /* The total number of CPU to GPU copies */ 8945c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_ct_scalar = 0.0; /* The total number of GPU to CPU copies */ 9045c4b7c1SBarry Smith PetscLogDouble petsc_ctog_sz_scalar = 0.0; /* The total size of CPU to GPU copies */ 9145c4b7c1SBarry Smith PetscLogDouble petsc_gtoc_sz_scalar = 0.0; /* The total size of GPU to CPU copies */ 92958c4211Shannah_mairs PetscLogDouble petsc_gflops = 0.0; /* The flops done on a GPU */ 93958c4211Shannah_mairs PetscLogDouble petsc_gtime = 0.0; /* The time spent on a GPU */ 94bec0b493Shannah_mairs #endif 955c6c1daeSBarry Smith 965c6c1daeSBarry Smith /* Logging functions */ 970298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL; 980298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL; 990298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 1000298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 1015c6c1daeSBarry Smith 1025c6c1daeSBarry Smith /* Tracing event logging variables */ 1030298fd71SBarry Smith FILE *petsc_tracefile = NULL; 1045c6c1daeSBarry Smith int petsc_tracelevel = 0; 1055c6c1daeSBarry Smith const char *petsc_traceblanks = " "; 1065c6c1daeSBarry Smith char petsc_tracespace[128] = " "; 1075c6c1daeSBarry Smith PetscLogDouble petsc_tracetime = 0.0; 108896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE; 1095c6c1daeSBarry Smith 11095c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogInitialize(void) 111fa2bb9feSLisandro Dalcin { 112fa2bb9feSLisandro Dalcin int stage; 113fa2bb9feSLisandro Dalcin PetscBool opt; 114fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 1155c6c1daeSBarry Smith 116fa2bb9feSLisandro Dalcin PetscFunctionBegin; 117fa2bb9feSLisandro Dalcin if (PetscLogInitializeCalled) PetscFunctionReturn(0); 118fa2bb9feSLisandro Dalcin PetscLogInitializeCalled = PETSC_TRUE; 1195c6c1daeSBarry Smith 120fa2bb9feSLisandro Dalcin ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_actions", &opt);CHKERRQ(ierr); 121fa2bb9feSLisandro Dalcin if (opt) petsc_logActions = PETSC_FALSE; 122fa2bb9feSLisandro Dalcin ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_objects", &opt);CHKERRQ(ierr); 123fa2bb9feSLisandro Dalcin if (opt) petsc_logObjects = PETSC_FALSE; 124fa2bb9feSLisandro Dalcin if (petsc_logActions) { 125fa2bb9feSLisandro Dalcin ierr = PetscMalloc1(petsc_maxActions, &petsc_actions);CHKERRQ(ierr); 126fa2bb9feSLisandro Dalcin } 127fa2bb9feSLisandro Dalcin if (petsc_logObjects) { 128fa2bb9feSLisandro Dalcin ierr = PetscMalloc1(petsc_maxObjects, &petsc_objects);CHKERRQ(ierr); 129fa2bb9feSLisandro Dalcin } 130fa2bb9feSLisandro Dalcin PetscLogPHC = PetscLogObjCreateDefault; 131fa2bb9feSLisandro Dalcin PetscLogPHD = PetscLogObjDestroyDefault; 132fa2bb9feSLisandro Dalcin /* Setup default logging structures */ 133fa2bb9feSLisandro Dalcin ierr = PetscStageLogCreate(&petsc_stageLog);CHKERRQ(ierr); 134fa2bb9feSLisandro Dalcin ierr = PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage);CHKERRQ(ierr); 1355c6c1daeSBarry Smith 136fa2bb9feSLisandro Dalcin /* All processors sync here for more consistent logging */ 137ffc4695bSBarry Smith ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRMPI(ierr); 138fa2bb9feSLisandro Dalcin PetscTime(&petsc_BaseTime); 139fa2bb9feSLisandro Dalcin ierr = PetscLogStagePush(stage);CHKERRQ(ierr); 140fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 141fa2bb9feSLisandro Dalcin } 1425c6c1daeSBarry Smith 14395c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogFinalize(void) 1445c6c1daeSBarry Smith { 1455c6c1daeSBarry Smith PetscStageLog stageLog; 1465c6c1daeSBarry Smith PetscErrorCode ierr; 1475c6c1daeSBarry Smith 1485c6c1daeSBarry Smith PetscFunctionBegin; 1495c6c1daeSBarry Smith ierr = PetscFree(petsc_actions);CHKERRQ(ierr); 1505c6c1daeSBarry Smith ierr = PetscFree(petsc_objects);CHKERRQ(ierr); 151eccbb886SLisandro Dalcin ierr = PetscLogNestedEnd();CHKERRQ(ierr); 1520298fd71SBarry Smith ierr = PetscLogSet(NULL, NULL);CHKERRQ(ierr); 1535c6c1daeSBarry Smith 1545c6c1daeSBarry Smith /* Resetting phase */ 1555c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1565c6c1daeSBarry Smith ierr = PetscStageLogDestroy(stageLog);CHKERRQ(ierr); 157a297a907SKarl Rupp 1585c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1595c6c1daeSBarry Smith petsc_numActions = 0; 1605c6c1daeSBarry Smith petsc_numObjects = 0; 1615c6c1daeSBarry Smith petsc_numObjectsDestroyed = 0; 1625c6c1daeSBarry Smith petsc_maxActions = 100; 1635c6c1daeSBarry Smith petsc_maxObjects = 100; 1640298fd71SBarry Smith petsc_actions = NULL; 1650298fd71SBarry Smith petsc_objects = NULL; 1665c6c1daeSBarry Smith petsc_logActions = PETSC_FALSE; 1675c6c1daeSBarry Smith petsc_logObjects = PETSC_FALSE; 1685c6c1daeSBarry Smith petsc_BaseTime = 0.0; 1695c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1705c6c1daeSBarry Smith petsc_tmp_flops = 0.0; 1715c6c1daeSBarry Smith petsc_send_ct = 0.0; 1725c6c1daeSBarry Smith petsc_recv_ct = 0.0; 1735c6c1daeSBarry Smith petsc_send_len = 0.0; 1745c6c1daeSBarry Smith petsc_recv_len = 0.0; 1755c6c1daeSBarry Smith petsc_isend_ct = 0.0; 1765c6c1daeSBarry Smith petsc_irecv_ct = 0.0; 1775c6c1daeSBarry Smith petsc_isend_len = 0.0; 1785c6c1daeSBarry Smith petsc_irecv_len = 0.0; 1795c6c1daeSBarry Smith petsc_wait_ct = 0.0; 1805c6c1daeSBarry Smith petsc_wait_any_ct = 0.0; 1815c6c1daeSBarry Smith petsc_wait_all_ct = 0.0; 1825c6c1daeSBarry Smith petsc_sum_of_waits_ct = 0.0; 1835c6c1daeSBarry Smith petsc_allreduce_ct = 0.0; 1845c6c1daeSBarry Smith petsc_gather_ct = 0.0; 1855c6c1daeSBarry Smith petsc_scatter_ct = 0.0; 186d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 187bec0b493Shannah_mairs petsc_ctog_ct = 0.0; 188bec0b493Shannah_mairs petsc_gtoc_ct = 0.0; 189bec0b493Shannah_mairs petsc_ctog_sz = 0.0; 190bec0b493Shannah_mairs petsc_gtoc_sz = 0.0; 191958c4211Shannah_mairs petsc_gflops = 0.0; 192958c4211Shannah_mairs petsc_gtime = 0.0; 193bec0b493Shannah_mairs #endif 1945c6c1daeSBarry Smith PETSC_LARGEST_EVENT = PETSC_EVENT; 1950298fd71SBarry Smith PetscLogPHC = NULL; 1960298fd71SBarry Smith PetscLogPHD = NULL; 1970298fd71SBarry Smith petsc_tracefile = NULL; 1985c6c1daeSBarry Smith petsc_tracelevel = 0; 1995c6c1daeSBarry Smith petsc_traceblanks = " "; 2005c6c1daeSBarry Smith petsc_tracespace[0] = ' '; petsc_tracespace[1] = 0; 2015c6c1daeSBarry Smith petsc_tracetime = 0.0; 2025c6c1daeSBarry Smith PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 2035c6c1daeSBarry Smith PETSC_OBJECT_CLASSID = 0; 20402c9f0b5SLisandro Dalcin petsc_stageLog = NULL; 205896238b9SBarry Smith PetscLogInitializeCalled = PETSC_FALSE; 2065c6c1daeSBarry Smith PetscFunctionReturn(0); 2075c6c1daeSBarry Smith } 2085c6c1daeSBarry Smith 2095c6c1daeSBarry Smith /*@C 2105c6c1daeSBarry Smith PetscLogSet - Sets the logging functions called at the beginning and ending of every event. 2115c6c1daeSBarry Smith 2125c6c1daeSBarry Smith Not Collective 2135c6c1daeSBarry Smith 2145c6c1daeSBarry Smith Input Parameters: 2155c6c1daeSBarry Smith + b - The function called at beginning of event 2165c6c1daeSBarry Smith - e - The function called at end of event 2175c6c1daeSBarry Smith 2185c6c1daeSBarry Smith Level: developer 2195c6c1daeSBarry Smith 220bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogTraceBegin() 2215c6c1daeSBarry Smith @*/ 2225c6c1daeSBarry Smith PetscErrorCode PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), 2235c6c1daeSBarry Smith PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject)) 2245c6c1daeSBarry Smith { 2255c6c1daeSBarry Smith PetscFunctionBegin; 2265c6c1daeSBarry Smith PetscLogPLB = b; 2275c6c1daeSBarry Smith PetscLogPLE = e; 2285c6c1daeSBarry Smith PetscFunctionReturn(0); 2295c6c1daeSBarry Smith } 2305c6c1daeSBarry Smith 2315c6c1daeSBarry Smith /*@C 2324dd65854SConnor Ward PetscLogIsActive - Check if logging is currently in progress. 2334dd65854SConnor Ward 2344dd65854SConnor Ward Not Collective 2354dd65854SConnor Ward 2364dd65854SConnor Ward Output Parameter: 2374dd65854SConnor Ward . isActive - PETSC_TRUE if logging is in progress, PETSC_FALSE otherwise 2384dd65854SConnor Ward 2394dd65854SConnor Ward Level: beginner 2404dd65854SConnor Ward 2414dd65854SConnor Ward .seealso: PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogSet() 2424dd65854SConnor Ward @*/ 2434dd65854SConnor Ward PetscErrorCode PetscLogIsActive(PetscBool *isActive) 2444dd65854SConnor Ward { 2454dd65854SConnor Ward PetscFunctionBegin; 2464dd65854SConnor Ward *isActive = (PetscLogPLB && PetscLogPLE) ? PETSC_TRUE : PETSC_FALSE; 2474dd65854SConnor Ward PetscFunctionReturn(0); 2484dd65854SConnor Ward } 2494dd65854SConnor Ward 2504dd65854SConnor Ward /*@C 251bb1d7374SBarry Smith PetscLogDefaultBegin - Turns on logging of objects and events. This logs flop 2525c6c1daeSBarry Smith rates and object creation and should not slow programs down too much. 2535c6c1daeSBarry Smith This routine may be called more than once. 2545c6c1daeSBarry Smith 2555c6c1daeSBarry Smith Logically Collective over PETSC_COMM_WORLD 2565c6c1daeSBarry Smith 2575c6c1daeSBarry Smith Options Database Keys: 258a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the 259a2553e36SBarry Smith screen (for code configured with --with-log=1 (which is the default)) 2605c6c1daeSBarry Smith 2615c6c1daeSBarry Smith Usage: 2625c6c1daeSBarry Smith .vb 2635c6c1daeSBarry Smith PetscInitialize(...); 264bb1d7374SBarry Smith PetscLogDefaultBegin(); 2655c6c1daeSBarry Smith ... code ... 2665c6c1daeSBarry Smith PetscLogView(viewer); or PetscLogDump(); 2675c6c1daeSBarry Smith PetscFinalize(); 2685c6c1daeSBarry Smith .ve 2695c6c1daeSBarry Smith 2705c6c1daeSBarry Smith Notes: 2715c6c1daeSBarry Smith PetscLogView(viewer) or PetscLogDump() actually cause the printing of 2725c6c1daeSBarry Smith the logging information. 2735c6c1daeSBarry Smith 2745c6c1daeSBarry Smith Level: advanced 2755c6c1daeSBarry Smith 2765c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogTraceBegin() 2775c6c1daeSBarry Smith @*/ 278bb1d7374SBarry Smith PetscErrorCode PetscLogDefaultBegin(void) 2795c6c1daeSBarry Smith { 2805c6c1daeSBarry Smith PetscErrorCode ierr; 2815c6c1daeSBarry Smith 2825c6c1daeSBarry Smith PetscFunctionBegin; 2835c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault);CHKERRQ(ierr); 2845c6c1daeSBarry Smith PetscFunctionReturn(0); 2855c6c1daeSBarry Smith } 2865c6c1daeSBarry Smith 2875c6c1daeSBarry Smith /*@C 2885c6c1daeSBarry Smith PetscLogAllBegin - Turns on extensive logging of objects and events. Logs 2895c6c1daeSBarry Smith all events. This creates large log files and slows the program down. 2905c6c1daeSBarry Smith 2915c6c1daeSBarry Smith Logically Collective on PETSC_COMM_WORLD 2925c6c1daeSBarry Smith 2935c6c1daeSBarry Smith Options Database Keys: 294a2553e36SBarry Smith . -log_all - Prints extensive log information 2955c6c1daeSBarry Smith 2965c6c1daeSBarry Smith Usage: 2975c6c1daeSBarry Smith .vb 2985c6c1daeSBarry Smith PetscInitialize(...); 2995c6c1daeSBarry Smith PetscLogAllBegin(); 3005c6c1daeSBarry Smith ... code ... 3015c6c1daeSBarry Smith PetscLogDump(filename); 3025c6c1daeSBarry Smith PetscFinalize(); 3035c6c1daeSBarry Smith .ve 3045c6c1daeSBarry Smith 3055c6c1daeSBarry Smith Notes: 306bb1d7374SBarry Smith A related routine is PetscLogDefaultBegin() (with the options key -log), which is 3075c6c1daeSBarry Smith intended for production runs since it logs only flop rates and object 3085c6c1daeSBarry Smith creation (and shouldn't significantly slow the programs). 3095c6c1daeSBarry Smith 3105c6c1daeSBarry Smith Level: advanced 3115c6c1daeSBarry Smith 312bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogTraceBegin() 3135c6c1daeSBarry Smith @*/ 3145c6c1daeSBarry Smith PetscErrorCode PetscLogAllBegin(void) 3155c6c1daeSBarry Smith { 3165c6c1daeSBarry Smith PetscErrorCode ierr; 3175c6c1daeSBarry Smith 3185c6c1daeSBarry Smith PetscFunctionBegin; 3195c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete);CHKERRQ(ierr); 3205c6c1daeSBarry Smith PetscFunctionReturn(0); 3215c6c1daeSBarry Smith } 3225c6c1daeSBarry Smith 323956f8c0dSBarry Smith /*@C 3245c6c1daeSBarry Smith PetscLogTraceBegin - Activates trace logging. Every time a PETSc event 3255c6c1daeSBarry Smith begins or ends, the event name is printed. 3265c6c1daeSBarry Smith 3275c6c1daeSBarry Smith Logically Collective on PETSC_COMM_WORLD 3285c6c1daeSBarry Smith 3295c6c1daeSBarry Smith Input Parameter: 3305c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout) 3315c6c1daeSBarry Smith 3325c6c1daeSBarry Smith Options Database Key: 3335c6c1daeSBarry Smith . -log_trace [filename] - Activates PetscLogTraceBegin() 3345c6c1daeSBarry Smith 3355c6c1daeSBarry Smith Notes: 3365c6c1daeSBarry Smith PetscLogTraceBegin() prints the processor number, the execution time (sec), 3375c6c1daeSBarry Smith then "Event begin:" or "Event end:" followed by the event name. 3385c6c1daeSBarry Smith 3395c6c1daeSBarry Smith PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful 3405c6c1daeSBarry Smith to determine where a program is hanging without running in the 3415c6c1daeSBarry Smith debugger. Can be used in conjunction with the -info option. 3425c6c1daeSBarry Smith 3435c6c1daeSBarry Smith Level: intermediate 3445c6c1daeSBarry Smith 345bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogDefaultBegin() 3465c6c1daeSBarry Smith @*/ 3475c6c1daeSBarry Smith PetscErrorCode PetscLogTraceBegin(FILE *file) 3485c6c1daeSBarry Smith { 3495c6c1daeSBarry Smith PetscErrorCode ierr; 3505c6c1daeSBarry Smith 3515c6c1daeSBarry Smith PetscFunctionBegin; 3525c6c1daeSBarry Smith petsc_tracefile = file; 353a297a907SKarl Rupp 3545c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace);CHKERRQ(ierr); 3555c6c1daeSBarry Smith PetscFunctionReturn(0); 3565c6c1daeSBarry Smith } 3575c6c1daeSBarry Smith 3585c6c1daeSBarry Smith /*@ 3595c6c1daeSBarry Smith PetscLogActions - Determines whether actions are logged for the graphical viewer. 3605c6c1daeSBarry Smith 3615c6c1daeSBarry Smith Not Collective 3625c6c1daeSBarry Smith 3635c6c1daeSBarry Smith Input Parameter: 3645c6c1daeSBarry Smith . flag - PETSC_TRUE if actions are to be logged 3655c6c1daeSBarry Smith 3665c6c1daeSBarry Smith Level: intermediate 3675c6c1daeSBarry Smith 3685c6c1daeSBarry Smith Note: Logging of actions continues to consume more memory as the program 3695c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3705c6c1daeSBarry Smith 3715c6c1daeSBarry Smith Options Database Keys: 3725c6c1daeSBarry Smith . -log_exclude_actions - Turns off actions logging 3735c6c1daeSBarry Smith 3745c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 3755c6c1daeSBarry Smith @*/ 3765c6c1daeSBarry Smith PetscErrorCode PetscLogActions(PetscBool flag) 3775c6c1daeSBarry Smith { 3785c6c1daeSBarry Smith PetscFunctionBegin; 3795c6c1daeSBarry Smith petsc_logActions = flag; 3805c6c1daeSBarry Smith PetscFunctionReturn(0); 3815c6c1daeSBarry Smith } 3825c6c1daeSBarry Smith 3835c6c1daeSBarry Smith /*@ 3845c6c1daeSBarry Smith PetscLogObjects - Determines whether objects are logged for the graphical viewer. 3855c6c1daeSBarry Smith 3865c6c1daeSBarry Smith Not Collective 3875c6c1daeSBarry Smith 3885c6c1daeSBarry Smith Input Parameter: 3895c6c1daeSBarry Smith . flag - PETSC_TRUE if objects are to be logged 3905c6c1daeSBarry Smith 3915c6c1daeSBarry Smith Level: intermediate 3925c6c1daeSBarry Smith 3935c6c1daeSBarry Smith Note: Logging of objects continues to consume more memory as the program 3945c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3955c6c1daeSBarry Smith 3965c6c1daeSBarry Smith Options Database Keys: 3975c6c1daeSBarry Smith . -log_exclude_objects - Turns off objects logging 3985c6c1daeSBarry Smith 3995c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 4005c6c1daeSBarry Smith @*/ 4015c6c1daeSBarry Smith PetscErrorCode PetscLogObjects(PetscBool flag) 4025c6c1daeSBarry Smith { 4035c6c1daeSBarry Smith PetscFunctionBegin; 4045c6c1daeSBarry Smith petsc_logObjects = flag; 4055c6c1daeSBarry Smith PetscFunctionReturn(0); 4065c6c1daeSBarry Smith } 4075c6c1daeSBarry Smith 4085c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/ 4095c6c1daeSBarry Smith /*@C 41074c0405dSRichard Tran Mills PetscLogStageRegister - Attaches a character string name to a logging stage. 4115c6c1daeSBarry Smith 4125c6c1daeSBarry Smith Not Collective 4135c6c1daeSBarry Smith 4145c6c1daeSBarry Smith Input Parameter: 4155c6c1daeSBarry Smith . sname - The name to associate with that stage 4165c6c1daeSBarry Smith 4175c6c1daeSBarry Smith Output Parameter: 4185c6c1daeSBarry Smith . stage - The stage number 4195c6c1daeSBarry Smith 4205c6c1daeSBarry Smith Level: intermediate 4215c6c1daeSBarry Smith 4225c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 4235c6c1daeSBarry Smith @*/ 4245c6c1daeSBarry Smith PetscErrorCode PetscLogStageRegister(const char sname[],PetscLogStage *stage) 4255c6c1daeSBarry Smith { 4265c6c1daeSBarry Smith PetscStageLog stageLog; 4275c6c1daeSBarry Smith PetscLogEvent event; 4285c6c1daeSBarry Smith PetscErrorCode ierr; 4295c6c1daeSBarry Smith 4305c6c1daeSBarry Smith PetscFunctionBegin; 4315c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 4325c6c1daeSBarry Smith ierr = PetscStageLogRegister(stageLog, sname, stage);CHKERRQ(ierr); 4335c6c1daeSBarry Smith /* Copy events already changed in the main stage, this sucks */ 4343a88037aSBarry Smith ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr); 4355c6c1daeSBarry Smith for (event = 0; event < stageLog->eventLog->numEvents; event++) { 4363a88037aSBarry Smith ierr = PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event],&stageLog->stageInfo[*stage].eventLog->eventInfo[event]);CHKERRQ(ierr); 4375c6c1daeSBarry Smith } 4383a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 4395c6c1daeSBarry Smith PetscFunctionReturn(0); 4405c6c1daeSBarry Smith } 4415c6c1daeSBarry Smith 4425c6c1daeSBarry Smith /*@C 4435c6c1daeSBarry Smith PetscLogStagePush - This function pushes a stage on the stack. 4445c6c1daeSBarry Smith 4455c6c1daeSBarry Smith Not Collective 4465c6c1daeSBarry Smith 4475c6c1daeSBarry Smith Input Parameter: 4485c6c1daeSBarry Smith . stage - The stage on which to log 4495c6c1daeSBarry Smith 4505c6c1daeSBarry Smith Usage: 4515c6c1daeSBarry Smith If the option -log_sumary is used to run the program containing the 4525c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4535c6c1daeSBarry Smith PetscFinalize(). 4545c6c1daeSBarry Smith .vb 4555c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4565c6c1daeSBarry Smith [stage 0 of code] 4575c6c1daeSBarry Smith PetscLogStagePush(1); 4585c6c1daeSBarry Smith [stage 1 of code] 4595c6c1daeSBarry Smith PetscLogStagePop(); 4605c6c1daeSBarry Smith PetscBarrier(...); 4615c6c1daeSBarry Smith [more stage 0 of code] 4625c6c1daeSBarry Smith PetscFinalize(); 4635c6c1daeSBarry Smith .ve 4645c6c1daeSBarry Smith 4655c6c1daeSBarry Smith Notes: 4665c6c1daeSBarry Smith Use PetscLogStageRegister() to register a stage. 4675c6c1daeSBarry Smith 4685c6c1daeSBarry Smith Level: intermediate 4695c6c1daeSBarry Smith 4705c6c1daeSBarry Smith .seealso: PetscLogStagePop(), PetscLogStageRegister(), PetscBarrier() 4715c6c1daeSBarry Smith @*/ 4725c6c1daeSBarry Smith PetscErrorCode PetscLogStagePush(PetscLogStage stage) 4735c6c1daeSBarry Smith { 4745c6c1daeSBarry Smith PetscStageLog stageLog; 4755c6c1daeSBarry Smith PetscErrorCode ierr; 4765c6c1daeSBarry Smith 4775c6c1daeSBarry Smith PetscFunctionBegin; 4785c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 4795c6c1daeSBarry Smith ierr = PetscStageLogPush(stageLog, stage);CHKERRQ(ierr); 4805c6c1daeSBarry Smith PetscFunctionReturn(0); 4815c6c1daeSBarry Smith } 4825c6c1daeSBarry Smith 4835c6c1daeSBarry Smith /*@C 4845c6c1daeSBarry Smith PetscLogStagePop - This function pops a stage from the stack. 4855c6c1daeSBarry Smith 4865c6c1daeSBarry Smith Not Collective 4875c6c1daeSBarry Smith 4885c6c1daeSBarry Smith Usage: 4895c6c1daeSBarry Smith If the option -log_sumary is used to run the program containing the 4905c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4915c6c1daeSBarry Smith PetscFinalize(). 4925c6c1daeSBarry Smith .vb 4935c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4945c6c1daeSBarry Smith [stage 0 of code] 4955c6c1daeSBarry Smith PetscLogStagePush(1); 4965c6c1daeSBarry Smith [stage 1 of code] 4975c6c1daeSBarry Smith PetscLogStagePop(); 4985c6c1daeSBarry Smith PetscBarrier(...); 4995c6c1daeSBarry Smith [more stage 0 of code] 5005c6c1daeSBarry Smith PetscFinalize(); 5015c6c1daeSBarry Smith .ve 5025c6c1daeSBarry Smith 5035c6c1daeSBarry Smith Notes: 5045c6c1daeSBarry Smith Use PetscLogStageRegister() to register a stage. 5055c6c1daeSBarry Smith 5065c6c1daeSBarry Smith Level: intermediate 5075c6c1daeSBarry Smith 5085c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStageRegister(), PetscBarrier() 5095c6c1daeSBarry Smith @*/ 5105c6c1daeSBarry Smith PetscErrorCode PetscLogStagePop(void) 5115c6c1daeSBarry Smith { 5125c6c1daeSBarry Smith PetscStageLog stageLog; 5135c6c1daeSBarry Smith PetscErrorCode ierr; 5145c6c1daeSBarry Smith 5155c6c1daeSBarry Smith PetscFunctionBegin; 5165c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5175c6c1daeSBarry Smith ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 5185c6c1daeSBarry Smith PetscFunctionReturn(0); 5195c6c1daeSBarry Smith } 5205c6c1daeSBarry Smith 5215c6c1daeSBarry Smith /*@ 5225c6c1daeSBarry Smith PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 5235c6c1daeSBarry Smith 5245c6c1daeSBarry Smith Not Collective 5255c6c1daeSBarry Smith 5265c6c1daeSBarry Smith Input Parameters: 5275c6c1daeSBarry Smith + stage - The stage 5285c6c1daeSBarry Smith - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 5295c6c1daeSBarry Smith 5305c6c1daeSBarry Smith Level: intermediate 5315c6c1daeSBarry Smith 5325c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 5335c6c1daeSBarry Smith @*/ 5345c6c1daeSBarry Smith PetscErrorCode PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive) 5355c6c1daeSBarry Smith { 5365c6c1daeSBarry Smith PetscStageLog stageLog; 5375c6c1daeSBarry Smith PetscErrorCode ierr; 5385c6c1daeSBarry Smith 5395c6c1daeSBarry Smith PetscFunctionBegin; 5405c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5415c6c1daeSBarry Smith ierr = PetscStageLogSetActive(stageLog, stage, isActive);CHKERRQ(ierr); 5425c6c1daeSBarry Smith PetscFunctionReturn(0); 5435c6c1daeSBarry Smith } 5445c6c1daeSBarry Smith 5455c6c1daeSBarry Smith /*@ 5465c6c1daeSBarry Smith PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 5475c6c1daeSBarry Smith 5485c6c1daeSBarry Smith Not Collective 5495c6c1daeSBarry Smith 5505c6c1daeSBarry Smith Input Parameter: 5515c6c1daeSBarry Smith . stage - The stage 5525c6c1daeSBarry Smith 5535c6c1daeSBarry Smith Output Parameter: 5545c6c1daeSBarry Smith . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 5555c6c1daeSBarry Smith 5565c6c1daeSBarry Smith Level: intermediate 5575c6c1daeSBarry Smith 5585c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 5595c6c1daeSBarry Smith @*/ 5605c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetActive(PetscLogStage stage, PetscBool *isActive) 5615c6c1daeSBarry Smith { 5625c6c1daeSBarry Smith PetscStageLog stageLog; 5635c6c1daeSBarry Smith PetscErrorCode ierr; 5645c6c1daeSBarry Smith 5655c6c1daeSBarry Smith PetscFunctionBegin; 5665c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5675c6c1daeSBarry Smith ierr = PetscStageLogGetActive(stageLog, stage, isActive);CHKERRQ(ierr); 5685c6c1daeSBarry Smith PetscFunctionReturn(0); 5695c6c1daeSBarry Smith } 5705c6c1daeSBarry Smith 5715c6c1daeSBarry Smith /*@ 5725c6c1daeSBarry Smith PetscLogStageSetVisible - Determines stage visibility in PetscLogView() 5735c6c1daeSBarry Smith 5745c6c1daeSBarry Smith Not Collective 5755c6c1daeSBarry Smith 5765c6c1daeSBarry Smith Input Parameters: 5775c6c1daeSBarry Smith + stage - The stage 5785c6c1daeSBarry Smith - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 5795c6c1daeSBarry Smith 5805c6c1daeSBarry Smith Level: intermediate 5815c6c1daeSBarry Smith 5825c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView() 5835c6c1daeSBarry Smith @*/ 5845c6c1daeSBarry Smith PetscErrorCode PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible) 5855c6c1daeSBarry Smith { 5865c6c1daeSBarry Smith PetscStageLog stageLog; 5875c6c1daeSBarry Smith PetscErrorCode ierr; 5885c6c1daeSBarry Smith 5895c6c1daeSBarry Smith PetscFunctionBegin; 5905c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5915c6c1daeSBarry Smith ierr = PetscStageLogSetVisible(stageLog, stage, isVisible);CHKERRQ(ierr); 5925c6c1daeSBarry Smith PetscFunctionReturn(0); 5935c6c1daeSBarry Smith } 5945c6c1daeSBarry Smith 5955c6c1daeSBarry Smith /*@ 5965c6c1daeSBarry Smith PetscLogStageGetVisible - Returns stage visibility in PetscLogView() 5975c6c1daeSBarry Smith 5985c6c1daeSBarry Smith Not Collective 5995c6c1daeSBarry Smith 6005c6c1daeSBarry Smith Input Parameter: 6015c6c1daeSBarry Smith . stage - The stage 6025c6c1daeSBarry Smith 6035c6c1daeSBarry Smith Output Parameter: 6045c6c1daeSBarry Smith . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 6055c6c1daeSBarry Smith 6065c6c1daeSBarry Smith Level: intermediate 6075c6c1daeSBarry Smith 6085c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView() 6095c6c1daeSBarry Smith @*/ 6105c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetVisible(PetscLogStage stage, PetscBool *isVisible) 6115c6c1daeSBarry Smith { 6125c6c1daeSBarry Smith PetscStageLog stageLog; 6135c6c1daeSBarry Smith PetscErrorCode ierr; 6145c6c1daeSBarry Smith 6155c6c1daeSBarry Smith PetscFunctionBegin; 6165c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 6175c6c1daeSBarry Smith ierr = PetscStageLogGetVisible(stageLog, stage, isVisible);CHKERRQ(ierr); 6185c6c1daeSBarry Smith PetscFunctionReturn(0); 6195c6c1daeSBarry Smith } 6205c6c1daeSBarry Smith 6215c6c1daeSBarry Smith /*@C 6225c6c1daeSBarry Smith PetscLogStageGetId - Returns the stage id when given the stage name. 6235c6c1daeSBarry Smith 6245c6c1daeSBarry Smith Not Collective 6255c6c1daeSBarry Smith 6265c6c1daeSBarry Smith Input Parameter: 6275c6c1daeSBarry Smith . name - The stage name 6285c6c1daeSBarry Smith 6295c6c1daeSBarry Smith Output Parameter: 6305a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists 6315c6c1daeSBarry Smith 6325c6c1daeSBarry Smith Level: intermediate 6335c6c1daeSBarry Smith 6345c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 6355c6c1daeSBarry Smith @*/ 6365c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetId(const char name[], PetscLogStage *stage) 6375c6c1daeSBarry Smith { 6385c6c1daeSBarry Smith PetscStageLog stageLog; 6395c6c1daeSBarry Smith PetscErrorCode ierr; 6405c6c1daeSBarry Smith 6415c6c1daeSBarry Smith PetscFunctionBegin; 6425c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 6435c6c1daeSBarry Smith ierr = PetscStageLogGetStage(stageLog, name, stage);CHKERRQ(ierr); 6445c6c1daeSBarry Smith PetscFunctionReturn(0); 6455c6c1daeSBarry Smith } 6465c6c1daeSBarry Smith 6475c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/ 6485c6c1daeSBarry Smith /*@C 6495c6c1daeSBarry Smith PetscLogEventRegister - Registers an event name for logging operations in an application code. 6505c6c1daeSBarry Smith 6515c6c1daeSBarry Smith Not Collective 6525c6c1daeSBarry Smith 653d8d19677SJose E. Roman Input Parameters: 6545c6c1daeSBarry Smith + name - The name associated with the event 6555c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with 6565c6c1daeSBarry Smith PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones 6575c6c1daeSBarry Smith are only available in C code 6585c6c1daeSBarry Smith 6595c6c1daeSBarry Smith Output Parameter: 6605c6c1daeSBarry Smith . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd(). 6615c6c1daeSBarry Smith 6625c6c1daeSBarry Smith Example of Usage: 6635c6c1daeSBarry Smith .vb 6645c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 6655c6c1daeSBarry Smith PetscClassId classid; 6665c6c1daeSBarry Smith PetscLogDouble user_event_flops; 6675c6c1daeSBarry Smith PetscClassIdRegister("class name",&classid); 6685c6c1daeSBarry Smith PetscLogEventRegister("User event name",classid,&USER_EVENT); 6695c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 6705c6c1daeSBarry Smith [code segment to monitor] 6715c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 6725c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 6735c6c1daeSBarry Smith .ve 6745c6c1daeSBarry Smith 6755c6c1daeSBarry Smith Notes: 6765c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 677a2553e36SBarry Smith configured with --with-log (which is the default) and 678a2553e36SBarry Smith -log_view or -log_all is specified. PetscLogEventRegister() is 6795c6c1daeSBarry Smith intended for logging user events to supplement this PETSc 6805c6c1daeSBarry Smith information. 6815c6c1daeSBarry Smith 682495fc317SBarry Smith PETSc can gather data for use with the utilities Jumpshot 6835c6c1daeSBarry Smith (part of the MPICH distribution). If PETSc has been compiled 6845c6c1daeSBarry Smith with flag -DPETSC_HAVE_MPE (MPE is an additional utility within 6855c6c1daeSBarry Smith MPICH), the user can employ another command line option, -log_mpe, 6865c6c1daeSBarry Smith to create a logfile, "mpe.log", which can be visualized 687495fc317SBarry Smith Jumpshot. 6885c6c1daeSBarry Smith 6895c6c1daeSBarry Smith The classid is associated with each event so that classes of events 6905c6c1daeSBarry Smith can be disabled simultaneously, such as all matrix events. The user 6915c6c1daeSBarry Smith can either use an existing classid, such as MAT_CLASSID, or create 6925c6c1daeSBarry Smith their own as shown in the example. 6935c6c1daeSBarry Smith 694c5deb1d5SJed Brown If an existing event with the same name exists, its event handle is 695c5deb1d5SJed Brown returned instead of creating a new event. 696c5deb1d5SJed Brown 6975c6c1daeSBarry Smith Level: intermediate 6985c6c1daeSBarry Smith 6995c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogFlops(), 7005c6c1daeSBarry Smith PetscLogEventActivate(), PetscLogEventDeactivate(), PetscClassIdRegister() 7015c6c1daeSBarry Smith @*/ 7025c6c1daeSBarry Smith PetscErrorCode PetscLogEventRegister(const char name[],PetscClassId classid,PetscLogEvent *event) 7035c6c1daeSBarry Smith { 7045c6c1daeSBarry Smith PetscStageLog stageLog; 7055c6c1daeSBarry Smith int stage; 7065c6c1daeSBarry Smith PetscErrorCode ierr; 7075c6c1daeSBarry Smith 7085c6c1daeSBarry Smith PetscFunctionBegin; 7095c6c1daeSBarry Smith *event = PETSC_DECIDE; 7105c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 7113a88037aSBarry Smith ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr); 712c5deb1d5SJed Brown if (*event > 0) PetscFunctionReturn(0); 7133a88037aSBarry Smith ierr = PetscEventRegLogRegister(stageLog->eventLog, name, classid, event);CHKERRQ(ierr); 7145c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 7153a88037aSBarry Smith ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr); 7163a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 7175c6c1daeSBarry Smith } 7185c6c1daeSBarry Smith PetscFunctionReturn(0); 7195c6c1daeSBarry Smith } 7205c6c1daeSBarry Smith 7215c6c1daeSBarry Smith /*@ 722217044c2SLisandro Dalcin PetscLogEventSetCollective - Indicates that a particular event is collective. 723217044c2SLisandro Dalcin 724217044c2SLisandro Dalcin Not Collective 725217044c2SLisandro Dalcin 726d8d19677SJose E. Roman Input Parameters: 727217044c2SLisandro Dalcin + event - The event id 728217044c2SLisandro Dalcin - collective - Bolean flag indicating whether a particular event is collective 729217044c2SLisandro Dalcin 730217044c2SLisandro Dalcin Note: 731217044c2SLisandro Dalcin New events returned from PetscLogEventRegister() are collective by default. 732217044c2SLisandro Dalcin 733217044c2SLisandro Dalcin Level: developer 734217044c2SLisandro Dalcin 735217044c2SLisandro Dalcin .seealso: PetscLogEventRegister() 736217044c2SLisandro Dalcin @*/ 737217044c2SLisandro Dalcin PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event,PetscBool collective) 738217044c2SLisandro Dalcin { 739217044c2SLisandro Dalcin PetscStageLog stageLog; 740217044c2SLisandro Dalcin PetscEventRegLog eventRegLog; 741217044c2SLisandro Dalcin PetscErrorCode ierr; 742217044c2SLisandro Dalcin 743217044c2SLisandro Dalcin PetscFunctionBegin; 744217044c2SLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 745217044c2SLisandro Dalcin ierr = PetscStageLogGetEventRegLog(stageLog,&eventRegLog);CHKERRQ(ierr); 7462c71b3e2SJacob Faibussowitsch PetscCheckFalse(event < 0 || event > eventRegLog->numEvents,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Invalid event id"); 747217044c2SLisandro Dalcin eventRegLog->eventInfo[event].collective = collective; 748217044c2SLisandro Dalcin PetscFunctionReturn(0); 749217044c2SLisandro Dalcin } 750217044c2SLisandro Dalcin 751217044c2SLisandro Dalcin /*@ 752fa2bb9feSLisandro Dalcin PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage. 753fa2bb9feSLisandro Dalcin 754fa2bb9feSLisandro Dalcin Not Collective 755fa2bb9feSLisandro Dalcin 756fa2bb9feSLisandro Dalcin Input Parameter: 757fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc. 758fa2bb9feSLisandro Dalcin 759fa2bb9feSLisandro Dalcin Level: developer 760fa2bb9feSLisandro Dalcin 761fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 762fa2bb9feSLisandro Dalcin @*/ 763fa2bb9feSLisandro Dalcin PetscErrorCode PetscLogEventIncludeClass(PetscClassId classid) 764fa2bb9feSLisandro Dalcin { 765fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 766fa2bb9feSLisandro Dalcin int stage; 767fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 768fa2bb9feSLisandro Dalcin 769fa2bb9feSLisandro Dalcin PetscFunctionBegin; 770fa2bb9feSLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 771fa2bb9feSLisandro Dalcin for (stage = 0; stage < stageLog->numStages; stage++) { 772fa2bb9feSLisandro Dalcin ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 773fa2bb9feSLisandro Dalcin } 774fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 775fa2bb9feSLisandro Dalcin } 776fa2bb9feSLisandro Dalcin 777fa2bb9feSLisandro Dalcin /*@ 778fa2bb9feSLisandro Dalcin PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage. 779fa2bb9feSLisandro Dalcin 780fa2bb9feSLisandro Dalcin Not Collective 781fa2bb9feSLisandro Dalcin 782fa2bb9feSLisandro Dalcin Input Parameter: 783fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc. 784fa2bb9feSLisandro Dalcin 785fa2bb9feSLisandro Dalcin Level: developer 786fa2bb9feSLisandro Dalcin 787fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivateClass(),PetscLogEventDeactivate(),PetscLogEventActivate() 788fa2bb9feSLisandro Dalcin @*/ 789fa2bb9feSLisandro Dalcin PetscErrorCode PetscLogEventExcludeClass(PetscClassId classid) 790fa2bb9feSLisandro Dalcin { 791fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 792fa2bb9feSLisandro Dalcin int stage; 793fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 794fa2bb9feSLisandro Dalcin 795fa2bb9feSLisandro Dalcin PetscFunctionBegin; 796fa2bb9feSLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 797fa2bb9feSLisandro Dalcin for (stage = 0; stage < stageLog->numStages; stage++) { 798fa2bb9feSLisandro Dalcin ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 799fa2bb9feSLisandro Dalcin } 800fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 801fa2bb9feSLisandro Dalcin } 802fa2bb9feSLisandro Dalcin 803fa2bb9feSLisandro Dalcin /*@ 8045c6c1daeSBarry Smith PetscLogEventActivate - Indicates that a particular event should be logged. 8055c6c1daeSBarry Smith 8065c6c1daeSBarry Smith Not Collective 8075c6c1daeSBarry Smith 8085c6c1daeSBarry Smith Input Parameter: 8095c6c1daeSBarry Smith . event - The event id 8105c6c1daeSBarry Smith 8115c6c1daeSBarry Smith Usage: 8125c6c1daeSBarry Smith .vb 8135c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 8145c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 8155c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 8165c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 8175c6c1daeSBarry Smith .ve 8185c6c1daeSBarry Smith 8195c6c1daeSBarry Smith Note: 8205c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in include/petsclog.h) 8215c6c1daeSBarry Smith or an event number obtained with PetscLogEventRegister(). 8225c6c1daeSBarry Smith 8235c6c1daeSBarry Smith Level: advanced 8245c6c1daeSBarry Smith 825c00cb57fSBarry Smith .seealso: PlogEventDeactivate(), PlogEventDeactivatePush(), PetscLogEventDeactivatePop() 8265c6c1daeSBarry Smith @*/ 8275c6c1daeSBarry Smith PetscErrorCode PetscLogEventActivate(PetscLogEvent event) 8285c6c1daeSBarry Smith { 8295c6c1daeSBarry Smith PetscStageLog stageLog; 8305c6c1daeSBarry Smith int stage; 8315c6c1daeSBarry Smith PetscErrorCode ierr; 8325c6c1daeSBarry Smith 8335c6c1daeSBarry Smith PetscFunctionBegin; 8345c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8355c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 8363a88037aSBarry Smith ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8375c6c1daeSBarry Smith PetscFunctionReturn(0); 8385c6c1daeSBarry Smith } 8395c6c1daeSBarry Smith 8405c6c1daeSBarry Smith /*@ 8415c6c1daeSBarry Smith PetscLogEventDeactivate - Indicates that a particular event should not be logged. 8425c6c1daeSBarry Smith 8435c6c1daeSBarry Smith Not Collective 8445c6c1daeSBarry Smith 8455c6c1daeSBarry Smith Input Parameter: 8465c6c1daeSBarry Smith . event - The event id 8475c6c1daeSBarry Smith 8485c6c1daeSBarry Smith Usage: 8495c6c1daeSBarry Smith .vb 8505c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 8515c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 8525c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 8535c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 8545c6c1daeSBarry Smith .ve 8555c6c1daeSBarry Smith 8565c6c1daeSBarry Smith Note: 8575c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in 8585c6c1daeSBarry Smith include/petsclog.h) or an event number obtained with PetscLogEventRegister()). 8595c6c1daeSBarry Smith 8605c6c1daeSBarry Smith Level: advanced 8615c6c1daeSBarry Smith 862c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePush(), PetscLogEventDeactivatePop() 8635c6c1daeSBarry Smith @*/ 8645c6c1daeSBarry Smith PetscErrorCode PetscLogEventDeactivate(PetscLogEvent event) 8655c6c1daeSBarry Smith { 8665c6c1daeSBarry Smith PetscStageLog stageLog; 8675c6c1daeSBarry Smith int stage; 8685c6c1daeSBarry Smith PetscErrorCode ierr; 8695c6c1daeSBarry Smith 8705c6c1daeSBarry Smith PetscFunctionBegin; 8715c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8725c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 8733a88037aSBarry Smith ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8745c6c1daeSBarry Smith PetscFunctionReturn(0); 8755c6c1daeSBarry Smith } 8765c6c1daeSBarry Smith 8775c6c1daeSBarry Smith /*@ 878c00cb57fSBarry Smith PetscLogEventDeactivatePush - Indicates that a particular event should not be logged. 879c00cb57fSBarry Smith 880c00cb57fSBarry Smith Not Collective 881c00cb57fSBarry Smith 882c00cb57fSBarry Smith Input Parameter: 883c00cb57fSBarry Smith . event - The event id 884c00cb57fSBarry Smith 885c00cb57fSBarry Smith Usage: 886c00cb57fSBarry Smith .vb 887c00cb57fSBarry Smith PetscLogEventDeactivatePush(VEC_SetValues); 888c00cb57fSBarry Smith [code where you do not want to log VecSetValues()] 889c00cb57fSBarry Smith PetscLogEventDeactivatePop(VEC_SetValues); 890c00cb57fSBarry Smith [code where you do want to log VecSetValues()] 891c00cb57fSBarry Smith .ve 892c00cb57fSBarry Smith 893c00cb57fSBarry Smith Note: 894c00cb57fSBarry Smith The event may be either a pre-defined PETSc event (found in 895c00cb57fSBarry Smith include/petsclog.h) or an event number obtained with PetscLogEventRegister()). 896c00cb57fSBarry Smith 897c00cb57fSBarry Smith Level: advanced 898c00cb57fSBarry Smith 899c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePop() 900c00cb57fSBarry Smith @*/ 901c00cb57fSBarry Smith PetscErrorCode PetscLogEventDeactivatePush(PetscLogEvent event) 902c00cb57fSBarry Smith { 903c00cb57fSBarry Smith PetscStageLog stageLog; 904c00cb57fSBarry Smith int stage; 905c00cb57fSBarry Smith PetscErrorCode ierr; 906c00cb57fSBarry Smith 907c00cb57fSBarry Smith PetscFunctionBegin; 908c00cb57fSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 909c00cb57fSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 910c00cb57fSBarry Smith ierr = PetscEventPerfLogDeactivatePush(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 911c00cb57fSBarry Smith PetscFunctionReturn(0); 912c00cb57fSBarry Smith } 913c00cb57fSBarry Smith 914c00cb57fSBarry Smith /*@ 915c00cb57fSBarry Smith PetscLogEventDeactivatePop - Indicates that a particular event shouldbe logged. 916c00cb57fSBarry Smith 917c00cb57fSBarry Smith Not Collective 918c00cb57fSBarry Smith 919c00cb57fSBarry Smith Input Parameter: 920c00cb57fSBarry Smith . event - The event id 921c00cb57fSBarry Smith 922c00cb57fSBarry Smith Usage: 923c00cb57fSBarry Smith .vb 924c00cb57fSBarry Smith PetscLogEventDeactivatePush(VEC_SetValues); 925c00cb57fSBarry Smith [code where you do not want to log VecSetValues()] 926c00cb57fSBarry Smith PetscLogEventDeactivatePop(VEC_SetValues); 927c00cb57fSBarry Smith [code where you do want to log VecSetValues()] 928c00cb57fSBarry Smith .ve 929c00cb57fSBarry Smith 930c00cb57fSBarry Smith Note: 931c00cb57fSBarry Smith The event may be either a pre-defined PETSc event (found in 932c00cb57fSBarry Smith include/petsclog.h) or an event number obtained with PetscLogEventRegister()). 933c00cb57fSBarry Smith 934c00cb57fSBarry Smith Level: advanced 935c00cb57fSBarry Smith 936c00cb57fSBarry Smith .seealso: PetscLogEventActivate(), PetscLogEventDeactivatePush() 937c00cb57fSBarry Smith @*/ 938c00cb57fSBarry Smith PetscErrorCode PetscLogEventDeactivatePop(PetscLogEvent event) 939c00cb57fSBarry Smith { 940c00cb57fSBarry Smith PetscStageLog stageLog; 941c00cb57fSBarry Smith int stage; 942c00cb57fSBarry Smith PetscErrorCode ierr; 943c00cb57fSBarry Smith 944c00cb57fSBarry Smith PetscFunctionBegin; 945c00cb57fSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 946c00cb57fSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 947c00cb57fSBarry Smith ierr = PetscEventPerfLogDeactivatePop(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 948c00cb57fSBarry Smith PetscFunctionReturn(0); 949c00cb57fSBarry Smith } 950c00cb57fSBarry Smith 951c00cb57fSBarry Smith /*@ 9525c6c1daeSBarry Smith PetscLogEventSetActiveAll - Sets the event activity in every stage. 9535c6c1daeSBarry Smith 9545c6c1daeSBarry Smith Not Collective 9555c6c1daeSBarry Smith 9565c6c1daeSBarry Smith Input Parameters: 9575c6c1daeSBarry Smith + event - The event id 9585c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged 9595c6c1daeSBarry Smith 9605c6c1daeSBarry Smith Level: advanced 9615c6c1daeSBarry Smith 962ec303c53SPatrick Sanan .seealso: PlogEventActivate(),PlogEventDeactivate() 9635c6c1daeSBarry Smith @*/ 9645c6c1daeSBarry Smith PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive) 9655c6c1daeSBarry Smith { 9665c6c1daeSBarry Smith PetscStageLog stageLog; 9675c6c1daeSBarry Smith int stage; 9685c6c1daeSBarry Smith PetscErrorCode ierr; 9695c6c1daeSBarry Smith 9705c6c1daeSBarry Smith PetscFunctionBegin; 9715c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 9725c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 9735c6c1daeSBarry Smith if (isActive) { 9743a88037aSBarry Smith ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 9755c6c1daeSBarry Smith } else { 9763a88037aSBarry Smith ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 9775c6c1daeSBarry Smith } 9785c6c1daeSBarry Smith } 9795c6c1daeSBarry Smith PetscFunctionReturn(0); 9805c6c1daeSBarry Smith } 9815c6c1daeSBarry Smith 9825c6c1daeSBarry Smith /*@ 9835c6c1daeSBarry Smith PetscLogEventActivateClass - Activates event logging for a PETSc object class. 9845c6c1daeSBarry Smith 9855c6c1daeSBarry Smith Not Collective 9865c6c1daeSBarry Smith 9875c6c1daeSBarry Smith Input Parameter: 9885c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 9895c6c1daeSBarry Smith 9905c6c1daeSBarry Smith Level: developer 9915c6c1daeSBarry Smith 992fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 9935c6c1daeSBarry Smith @*/ 9945c6c1daeSBarry Smith PetscErrorCode PetscLogEventActivateClass(PetscClassId classid) 9955c6c1daeSBarry Smith { 9965c6c1daeSBarry Smith PetscStageLog stageLog; 9975c6c1daeSBarry Smith int stage; 9985c6c1daeSBarry Smith PetscErrorCode ierr; 9995c6c1daeSBarry Smith 10005c6c1daeSBarry Smith PetscFunctionBegin; 10015c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 10025c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 10033a88037aSBarry Smith ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 10045c6c1daeSBarry Smith PetscFunctionReturn(0); 10055c6c1daeSBarry Smith } 10065c6c1daeSBarry Smith 10075c6c1daeSBarry Smith /*@ 10085c6c1daeSBarry Smith PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class. 10095c6c1daeSBarry Smith 10105c6c1daeSBarry Smith Not Collective 10115c6c1daeSBarry Smith 10125c6c1daeSBarry Smith Input Parameter: 10135c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 10145c6c1daeSBarry Smith 10155c6c1daeSBarry Smith Level: developer 10165c6c1daeSBarry Smith 1017fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 10185c6c1daeSBarry Smith @*/ 10195c6c1daeSBarry Smith PetscErrorCode PetscLogEventDeactivateClass(PetscClassId classid) 10205c6c1daeSBarry Smith { 10215c6c1daeSBarry Smith PetscStageLog stageLog; 10225c6c1daeSBarry Smith int stage; 10235c6c1daeSBarry Smith PetscErrorCode ierr; 10245c6c1daeSBarry Smith 10255c6c1daeSBarry Smith PetscFunctionBegin; 10265c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 10275c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 10283a88037aSBarry Smith ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 10295c6c1daeSBarry Smith PetscFunctionReturn(0); 10305c6c1daeSBarry Smith } 10315c6c1daeSBarry Smith 10325c6c1daeSBarry Smith /*MC 103362872c28SLisandro Dalcin PetscLogEventSync - Synchronizes the beginning of a user event. 103462872c28SLisandro Dalcin 103562872c28SLisandro Dalcin Synopsis: 103662872c28SLisandro Dalcin #include <petsclog.h> 103762872c28SLisandro Dalcin PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm) 103862872c28SLisandro Dalcin 103962872c28SLisandro Dalcin Collective 104062872c28SLisandro Dalcin 104162872c28SLisandro Dalcin Input Parameters: 104262872c28SLisandro Dalcin + e - integer associated with the event obtained from PetscLogEventRegister() 104362872c28SLisandro Dalcin - comm - an MPI communicator 104462872c28SLisandro Dalcin 104562872c28SLisandro Dalcin Usage: 104662872c28SLisandro Dalcin .vb 104762872c28SLisandro Dalcin PetscLogEvent USER_EVENT; 104862872c28SLisandro Dalcin PetscLogEventRegister("User event",0,&USER_EVENT); 104962872c28SLisandro Dalcin PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD); 105062872c28SLisandro Dalcin PetscLogEventBegin(USER_EVENT,0,0,0,0); 105162872c28SLisandro Dalcin [code segment to monitor] 105262872c28SLisandro Dalcin PetscLogEventEnd(USER_EVENT,0,0,0,0); 105362872c28SLisandro Dalcin .ve 105462872c28SLisandro Dalcin 105562872c28SLisandro Dalcin Notes: 105662872c28SLisandro Dalcin This routine should be called only if there is not a 105762872c28SLisandro Dalcin PetscObject available to pass to PetscLogEventBegin(). 105862872c28SLisandro Dalcin 105962872c28SLisandro Dalcin Level: developer 106062872c28SLisandro Dalcin 106162872c28SLisandro Dalcin .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd() 106262872c28SLisandro Dalcin 106362872c28SLisandro Dalcin M*/ 106462872c28SLisandro Dalcin 106562872c28SLisandro Dalcin /*MC 10665c6c1daeSBarry Smith PetscLogEventBegin - Logs the beginning of a user event. 10675c6c1daeSBarry Smith 10685c6c1daeSBarry Smith Synopsis: 1069aaa7dc30SBarry Smith #include <petsclog.h> 1070f2ba6396SBarry Smith PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10715c6c1daeSBarry Smith 10725c6c1daeSBarry Smith Not Collective 10735c6c1daeSBarry Smith 10745c6c1daeSBarry Smith Input Parameters: 10755c6c1daeSBarry Smith + e - integer associated with the event obtained from PetscLogEventRegister() 10765c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10775c6c1daeSBarry Smith 10785c6c1daeSBarry Smith Fortran Synopsis: 10795c6c1daeSBarry Smith void PetscLogEventBegin(int e,PetscErrorCode ierr) 10805c6c1daeSBarry Smith 10815c6c1daeSBarry Smith Usage: 10825c6c1daeSBarry Smith .vb 10835c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 10845c6c1daeSBarry Smith PetscLogDouble user_event_flops; 10855c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 10865c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 10875c6c1daeSBarry Smith [code segment to monitor] 10885c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 10895c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 10905c6c1daeSBarry Smith .ve 10915c6c1daeSBarry Smith 10925c6c1daeSBarry Smith Notes: 10935c6c1daeSBarry Smith You need to register each integer event with the command 1094a2553e36SBarry Smith PetscLogEventRegister(). 10955c6c1daeSBarry Smith 10965c6c1daeSBarry Smith Level: intermediate 10975c6c1daeSBarry Smith 10985c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops() 10995c6c1daeSBarry Smith 11005c6c1daeSBarry Smith M*/ 11015c6c1daeSBarry Smith 11025c6c1daeSBarry Smith /*MC 11035c6c1daeSBarry Smith PetscLogEventEnd - Log the end of a user event. 11045c6c1daeSBarry Smith 11055c6c1daeSBarry Smith Synopsis: 1106aaa7dc30SBarry Smith #include <petsclog.h> 1107f2ba6396SBarry Smith PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 11085c6c1daeSBarry Smith 11095c6c1daeSBarry Smith Not Collective 11105c6c1daeSBarry Smith 11115c6c1daeSBarry Smith Input Parameters: 11125c6c1daeSBarry Smith + e - integer associated with the event obtained with PetscLogEventRegister() 11135c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 11145c6c1daeSBarry Smith 11155c6c1daeSBarry Smith Fortran Synopsis: 11165c6c1daeSBarry Smith void PetscLogEventEnd(int e,PetscErrorCode ierr) 11175c6c1daeSBarry Smith 11185c6c1daeSBarry Smith Usage: 11195c6c1daeSBarry Smith .vb 11205c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 11215c6c1daeSBarry Smith PetscLogDouble user_event_flops; 11225c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT,); 11235c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 11245c6c1daeSBarry Smith [code segment to monitor] 11255c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 11265c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 11275c6c1daeSBarry Smith .ve 11285c6c1daeSBarry Smith 11295c6c1daeSBarry Smith Notes: 11305c6c1daeSBarry Smith You should also register each additional integer event with the command 1131a2553e36SBarry Smith PetscLogEventRegister(). 11325c6c1daeSBarry Smith 11335c6c1daeSBarry Smith Level: intermediate 11345c6c1daeSBarry Smith 11355c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogFlops() 11365c6c1daeSBarry Smith 11375c6c1daeSBarry Smith M*/ 11385c6c1daeSBarry Smith 11395c6c1daeSBarry Smith /*@C 11405c6c1daeSBarry Smith PetscLogEventGetId - Returns the event id when given the event name. 11415c6c1daeSBarry Smith 11425c6c1daeSBarry Smith Not Collective 11435c6c1daeSBarry Smith 11445c6c1daeSBarry Smith Input Parameter: 11455c6c1daeSBarry Smith . name - The event name 11465c6c1daeSBarry Smith 11475c6c1daeSBarry Smith Output Parameter: 1148c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists 11495c6c1daeSBarry Smith 11505c6c1daeSBarry Smith Level: intermediate 11515c6c1daeSBarry Smith 11525c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStageGetId() 11535c6c1daeSBarry Smith @*/ 11545c6c1daeSBarry Smith PetscErrorCode PetscLogEventGetId(const char name[], PetscLogEvent *event) 11555c6c1daeSBarry Smith { 11565c6c1daeSBarry Smith PetscStageLog stageLog; 11575c6c1daeSBarry Smith PetscErrorCode ierr; 11585c6c1daeSBarry Smith 11595c6c1daeSBarry Smith PetscFunctionBegin; 11605c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 11613a88037aSBarry Smith ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr); 11625c6c1daeSBarry Smith PetscFunctionReturn(0); 11635c6c1daeSBarry Smith } 11645c6c1daeSBarry Smith 11655c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/ 11665c6c1daeSBarry Smith /*@C 11675c6c1daeSBarry Smith PetscLogDump - Dumps logs of objects to a file. This file is intended to 11685c6c1daeSBarry Smith be read by bin/petscview. This program no longer exists. 11695c6c1daeSBarry Smith 11705c6c1daeSBarry Smith Collective on PETSC_COMM_WORLD 11715c6c1daeSBarry Smith 11725c6c1daeSBarry Smith Input Parameter: 11735c6c1daeSBarry Smith . name - an optional file name 11745c6c1daeSBarry Smith 11755c6c1daeSBarry Smith Usage: 11765c6c1daeSBarry Smith .vb 11775c6c1daeSBarry Smith PetscInitialize(...); 1178bb1d7374SBarry Smith PetscLogDefaultBegin(); or PetscLogAllBegin(); 11795c6c1daeSBarry Smith ... code ... 11805c6c1daeSBarry Smith PetscLogDump(filename); 11815c6c1daeSBarry Smith PetscFinalize(); 11825c6c1daeSBarry Smith .ve 11835c6c1daeSBarry Smith 11845c6c1daeSBarry Smith Notes: 11855c6c1daeSBarry Smith The default file name is 11865c6c1daeSBarry Smith $ Log.<rank> 11875c6c1daeSBarry Smith where <rank> is the processor number. If no name is specified, 11885c6c1daeSBarry Smith this file will be used. 11895c6c1daeSBarry Smith 11905c6c1daeSBarry Smith Level: advanced 11915c6c1daeSBarry Smith 1192bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogView() 11935c6c1daeSBarry Smith @*/ 11945c6c1daeSBarry Smith PetscErrorCode PetscLogDump(const char sname[]) 11955c6c1daeSBarry Smith { 11965c6c1daeSBarry Smith PetscStageLog stageLog; 11975c6c1daeSBarry Smith PetscEventPerfInfo *eventInfo; 11985c6c1daeSBarry Smith FILE *fd; 11995c6c1daeSBarry Smith char file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN]; 12005c6c1daeSBarry Smith PetscLogDouble flops, _TotalTime; 12015c6c1daeSBarry Smith PetscMPIInt rank; 12025c6c1daeSBarry Smith int action, object, curStage; 12035c6c1daeSBarry Smith PetscLogEvent event; 12045c6c1daeSBarry Smith PetscErrorCode ierr; 12055c6c1daeSBarry Smith 12065c6c1daeSBarry Smith PetscFunctionBegin; 12075c6c1daeSBarry Smith /* Calculate the total elapsed time */ 12088563dfccSBarry Smith PetscTime(&_TotalTime); 12095c6c1daeSBarry Smith _TotalTime -= petsc_BaseTime; 12105c6c1daeSBarry Smith /* Open log file */ 1211ffc4695bSBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank);CHKERRMPI(ierr); 12127ff663adSLisandro Dalcin if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank); 1213a297a907SKarl Rupp else sprintf(file, "Log.%d", rank); 12145c6c1daeSBarry Smith ierr = PetscFixFilename(file, fname);CHKERRQ(ierr); 12155c6c1daeSBarry Smith ierr = PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd);CHKERRQ(ierr); 12162c71b3e2SJacob Faibussowitsch PetscCheckFalse((rank == 0) && (!fd),PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname); 12175c6c1daeSBarry Smith /* Output totals */ 1218d4aa7d5fSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime);CHKERRQ(ierr); 1219a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0);CHKERRQ(ierr); 12205c6c1daeSBarry Smith /* Output actions */ 12215c6c1daeSBarry Smith if (petsc_logActions) { 1222a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions);CHKERRQ(ierr); 12235c6c1daeSBarry Smith for (action = 0; action < petsc_numActions; action++) { 12245c6c1daeSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n", 12255c6c1daeSBarry Smith petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1, 1226a2ea699eSBarry Smith petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem);CHKERRQ(ierr); 12275c6c1daeSBarry Smith } 12285c6c1daeSBarry Smith } 12295c6c1daeSBarry Smith /* Output objects */ 12305c6c1daeSBarry Smith if (petsc_logObjects) { 1231a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed);CHKERRQ(ierr); 12325c6c1daeSBarry Smith for (object = 0; object < petsc_numObjects; object++) { 1233a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int) petsc_objects[object].mem);CHKERRQ(ierr); 12345c6c1daeSBarry Smith if (!petsc_objects[object].name[0]) { 1235a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd,"No Name\n");CHKERRQ(ierr); 12365c6c1daeSBarry Smith } else { 1237a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name);CHKERRQ(ierr); 12385c6c1daeSBarry Smith } 12395c6c1daeSBarry Smith if (petsc_objects[object].info[0] != 0) { 1240a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n");CHKERRQ(ierr); 12415c6c1daeSBarry Smith } else { 1242a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info);CHKERRQ(ierr); 12435c6c1daeSBarry Smith } 12445c6c1daeSBarry Smith } 12455c6c1daeSBarry Smith } 12465c6c1daeSBarry Smith /* Output events */ 1247a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n");CHKERRQ(ierr); 12485c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 12495c6c1daeSBarry Smith ierr = PetscIntStackTop(stageLog->stack, &curStage);CHKERRQ(ierr); 12505c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo; 12515c6c1daeSBarry Smith for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) { 1252a297a907SKarl Rupp if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops/eventInfo[event].time; 1253a297a907SKarl Rupp else flops = 0.0; 12545c6c1daeSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count, 1255a2ea699eSBarry Smith eventInfo[event].flops, eventInfo[event].time, flops);CHKERRQ(ierr); 12565c6c1daeSBarry Smith } 12575c6c1daeSBarry Smith ierr = PetscFClose(PETSC_COMM_WORLD, fd);CHKERRQ(ierr); 12585c6c1daeSBarry Smith PetscFunctionReturn(0); 12595c6c1daeSBarry Smith } 12605c6c1daeSBarry Smith 1261f14045dbSBarry Smith /* 1262f14045dbSBarry Smith PetscLogView_Detailed - Each process prints the times for its own events 1263f14045dbSBarry Smith 1264f14045dbSBarry Smith */ 1265f14045dbSBarry Smith PetscErrorCode PetscLogView_Detailed(PetscViewer viewer) 1266f14045dbSBarry Smith { 12672dff6485SMatthew G. Knepley PetscStageLog stageLog; 1268217044c2SLisandro Dalcin PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL; 1269217044c2SLisandro Dalcin PetscLogDouble locTotalTime, numRed, maxMem; 12702dff6485SMatthew G. Knepley int numStages,numEvents,stage,event; 1271217044c2SLisandro Dalcin MPI_Comm comm = PetscObjectComm((PetscObject) viewer); 12722dff6485SMatthew G. Knepley PetscMPIInt rank,size; 12732dff6485SMatthew G. Knepley PetscErrorCode ierr; 1274f14045dbSBarry Smith 1275f14045dbSBarry Smith PetscFunctionBegin; 1276ffc4695bSBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr); 1277ffc4695bSBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr); 12782dff6485SMatthew G. Knepley /* Must preserve reduction count before we go on */ 12792dff6485SMatthew G. Knepley numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 12802d1ec343SBarry Smith /* Get the total elapsed time */ 12812d1ec343SBarry Smith PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 12829852e123SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"size = %d\n",size);CHKERRQ(ierr); 12832d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalTimes = {}\n");CHKERRQ(ierr); 12842d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalMessages = {}\n");CHKERRQ(ierr); 1285217044c2SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"LocalMessageLens = {}\n");CHKERRQ(ierr); 12862d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalReductions = {}\n");CHKERRQ(ierr); 1287217044c2SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"LocalFlop = {}\n");CHKERRQ(ierr); 12882dff6485SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer,"LocalObjects = {}\n");CHKERRQ(ierr); 12892dff6485SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer,"LocalMemory = {}\n");CHKERRQ(ierr); 12902d1ec343SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1291820f2d46SBarry Smith ierr = MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 12922d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages = {}\n");CHKERRQ(ierr); 12932d1ec343SBarry Smith for (stage=0; stage<numStages; stage++) { 12942d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr); 129561917356SPatrick Sanan ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"summary\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr); 1296820f2d46SBarry Smith ierr = MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 12972d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 12982d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"%s\"] = {}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name);CHKERRQ(ierr); 12992d1ec343SBarry Smith } 13002d1ec343SBarry Smith } 1301217044c2SLisandro Dalcin ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr); 13021575c14dSBarry Smith ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr); 13032d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalTimes[%d] = %g\n",rank,locTotalTime);CHKERRQ(ierr); 13042d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessages[%d] = %g\n",rank,(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct));CHKERRQ(ierr); 1305217044c2SLisandro Dalcin ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessageLens[%d] = %g\n",rank,(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len));CHKERRQ(ierr); 13062dff6485SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalReductions[%d] = %g\n",rank,numRed);CHKERRQ(ierr); 1307217044c2SLisandro Dalcin ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalFlop[%d] = %g\n",rank,petsc_TotalFlops);CHKERRQ(ierr); 1308ba67d37fSBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalObjects[%d] = %d\n",rank,petsc_numObjects);CHKERRQ(ierr); 13092dff6485SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMemory[%d] = %g\n",rank,maxMem);CHKERRQ(ierr); 13102d1ec343SBarry Smith ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 13112d1ec343SBarry Smith for (stage=0; stage<numStages; stage++) { 1312217044c2SLisandro Dalcin stageInfo = &stageLog->stageInfo[stage].perfInfo; 1313d4aa7d5fSBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n", 13142dff6485SMatthew G. Knepley stageLog->stageInfo[stage].name,rank, 1315217044c2SLisandro Dalcin stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr); 1316820f2d46SBarry Smith ierr = MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 13172d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 1318217044c2SLisandro Dalcin eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 13193ca90d2dSJacob Faibussowitsch ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %d, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g", 1320217044c2SLisandro Dalcin stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name,rank, 1321217044c2SLisandro Dalcin eventInfo->count,eventInfo->time,eventInfo->syncTime,eventInfo->numMessages,eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr); 1322891e75beSMatthew G. Knepley if (eventInfo->dof[0] >= 0.) { 1323891e75beSMatthew G. Knepley PetscInt d, e; 13245d68e14cSMatthew G. Knepley 1325891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : [");CHKERRQ(ierr); 1326891e75beSMatthew G. Knepley for (d = 0; d < 8; ++d) { 1327891e75beSMatthew G. Knepley if (d > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);} 1328891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d]);CHKERRQ(ierr); 1329891e75beSMatthew G. Knepley } 1330891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr); 13315d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : [");CHKERRQ(ierr); 13325d68e14cSMatthew G. Knepley for (e = 0; e < 8; ++e) { 13335d68e14cSMatthew G. Knepley if (e > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);} 1334c15bc2c4SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e]);CHKERRQ(ierr); 13355d68e14cSMatthew G. Knepley } 13365d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr); 13375d68e14cSMatthew G. Knepley } 13385d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"}\n");CHKERRQ(ierr); 13392d1ec343SBarry Smith } 13402d1ec343SBarry Smith } 13412d1ec343SBarry Smith ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 13421575c14dSBarry Smith ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr); 1343f14045dbSBarry Smith PetscFunctionReturn(0); 1344f14045dbSBarry Smith } 1345f14045dbSBarry Smith 134638144912Sdeepblu2718 /* 134738144912Sdeepblu2718 PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format 134838144912Sdeepblu2718 */ 134938144912Sdeepblu2718 PetscErrorCode PetscLogView_CSV(PetscViewer viewer) 135038144912Sdeepblu2718 { 135138144912Sdeepblu2718 PetscStageLog stageLog; 1352669c5be0SSatish Balay PetscEventPerfInfo *eventInfo = NULL; 135338144912Sdeepblu2718 PetscLogDouble locTotalTime, maxMem; 135438144912Sdeepblu2718 int numStages,numEvents,stage,event; 135538144912Sdeepblu2718 MPI_Comm comm = PetscObjectComm((PetscObject) viewer); 135638144912Sdeepblu2718 PetscMPIInt rank,size; 135738144912Sdeepblu2718 PetscErrorCode ierr; 135838144912Sdeepblu2718 135938144912Sdeepblu2718 PetscFunctionBegin; 1360ffc4695bSBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr); 1361ffc4695bSBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr); 136238144912Sdeepblu2718 /* Must preserve reduction count before we go on */ 136338144912Sdeepblu2718 /* Get the total elapsed time */ 136438144912Sdeepblu2718 PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 136538144912Sdeepblu2718 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1366820f2d46SBarry Smith ierr = MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 136738144912Sdeepblu2718 ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr); 136838144912Sdeepblu2718 ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr); 1369a2fddd78SAlbert Cowie ierr = PetscViewerASCIIPrintf(viewer,"Stage Name,Event Name,Rank,Count,Time,Num Messages,Message Length,Num Reductions,FLOP,dof0,dof1,dof2,dof3,dof4,dof5,dof6,dof7,e0,e1,e2,e3,e4,e5,e6,e7,%d\n", size); 137038144912Sdeepblu2718 ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 137138144912Sdeepblu2718 for (stage=0; stage<numStages; stage++) { 13729e29573dSMatthew G. Knepley PetscEventPerfInfo *stageInfo = &stageLog->stageInfo[stage].perfInfo; 13739e29573dSMatthew G. Knepley 1374a2fddd78SAlbert Cowie ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,summary,%d,1,%g,%g,%g,%g,%g\n", 13759e29573dSMatthew G. Knepley stageLog->stageInfo[stage].name,rank,stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr); 1376820f2d46SBarry Smith ierr = MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 137738144912Sdeepblu2718 for (event = 0; event < numEvents; event++) { 137838144912Sdeepblu2718 eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 13793ca90d2dSJacob Faibussowitsch ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,%s,%d,%d,%g,%g,%g,%g,%g",stageLog->stageInfo[stage].name, 1380a2fddd78SAlbert Cowie stageLog->eventLog->eventInfo[event].name,rank,eventInfo->count,eventInfo->time,eventInfo->numMessages, 138138144912Sdeepblu2718 eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr); 138238144912Sdeepblu2718 if (eventInfo->dof[0] >= 0.) { 138338144912Sdeepblu2718 PetscInt d, e; 138438144912Sdeepblu2718 138538144912Sdeepblu2718 for (d = 0; d < 8; ++d) { 138638144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d]);CHKERRQ(ierr); 138738144912Sdeepblu2718 } 138838144912Sdeepblu2718 for (e = 0; e < 8; ++e) { 138938144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e]);CHKERRQ(ierr); 139038144912Sdeepblu2718 } 139138144912Sdeepblu2718 } 139238144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"\n");CHKERRQ(ierr); 139338144912Sdeepblu2718 } 139438144912Sdeepblu2718 } 139538144912Sdeepblu2718 ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 139638144912Sdeepblu2718 ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr); 139738144912Sdeepblu2718 PetscFunctionReturn(0); 139838144912Sdeepblu2718 } 139938144912Sdeepblu2718 1400217044c2SLisandro Dalcin static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm,FILE *fd) 1401217044c2SLisandro Dalcin { 1402217044c2SLisandro Dalcin PetscErrorCode ierr; 1403217044c2SLisandro Dalcin PetscFunctionBegin; 1404217044c2SLisandro Dalcin if (!PetscLogSyncOn) PetscFunctionReturn(0); 1405217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1406217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1407217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1408217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1409217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1410217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This program was run with logging synchronization. #\n");CHKERRQ(ierr); 1411217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This option provides more meaningful imbalance #\n");CHKERRQ(ierr); 1412217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # figures at the expense of slowing things down and #\n");CHKERRQ(ierr); 1413217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # providing a distorted view of the overall runtime. #\n");CHKERRQ(ierr); 1414217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1415217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 1416217044c2SLisandro Dalcin PetscFunctionReturn(0); 1417217044c2SLisandro Dalcin } 1418217044c2SLisandro Dalcin 1419f4091ad2SBarry Smith static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm,FILE *fd) 1420f4091ad2SBarry Smith { 1421f4091ad2SBarry Smith PetscErrorCode ierr; 1422f4091ad2SBarry Smith 1423f4091ad2SBarry Smith PetscFunctionBegin; 142476bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { 1425f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1426f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1427f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1428f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1429f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1430217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This code was compiled with a debugging option. #\n");CHKERRQ(ierr); 1431f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # To get timing results run ./configure #\n");CHKERRQ(ierr); 1432f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # using --with-debugging=no, the performance will #\n");CHKERRQ(ierr); 1433f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # be generally two or three times faster. #\n");CHKERRQ(ierr); 1434f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1435f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 143676bd3646SJed Brown } 1437f4091ad2SBarry Smith PetscFunctionReturn(0); 1438f4091ad2SBarry Smith } 1439f4091ad2SBarry Smith 1440c2a741eeSJunchao Zhang static PetscErrorCode PetscLogViewWarnNoGpuAwareMpi(MPI_Comm comm,FILE *fd) 1441c2a741eeSJunchao Zhang { 1442009ab46cSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1443c2a741eeSJunchao Zhang PetscErrorCode ierr; 1444009ab46cSJunchao Zhang PetscMPIInt size; 1445c2a741eeSJunchao Zhang 1446c2a741eeSJunchao Zhang PetscFunctionBegin; 1447009ab46cSJunchao Zhang ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr); 1448*340fe3cdSSatish Balay if (use_gpu_aware_mpi || size == 1) PetscFunctionReturn(0); 1449c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1450c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1451c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1452c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1453c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1454928a6601SJunchao Zhang ierr = PetscFPrintf(comm, fd, " # This code was compiled with GPU support and you've #\n");CHKERRQ(ierr); 145501c619d5SPatrick Sanan ierr = PetscFPrintf(comm, fd, " # created PETSc/GPU objects, but you intentionally #\n");CHKERRQ(ierr); 145601c619d5SPatrick Sanan ierr = PetscFPrintf(comm, fd, " # used -use_gpu_aware_mpi 0, requiring PETSc to copy #\n");CHKERRQ(ierr); 145701c619d5SPatrick Sanan ierr = PetscFPrintf(comm, fd, " # additional data between the GPU and CPU. To obtain #\n");CHKERRQ(ierr); 145801c619d5SPatrick Sanan ierr = PetscFPrintf(comm, fd, " # meaningful timing results on multi-rank runs, use #\n");CHKERRQ(ierr); 145901c619d5SPatrick Sanan ierr = PetscFPrintf(comm, fd, " # GPU-aware MPI instead. #\n");CHKERRQ(ierr); 146001c619d5SPatrick Sanan ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1461c2a741eeSJunchao Zhang ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 1462c2a741eeSJunchao Zhang PetscFunctionReturn(0); 1463c2a741eeSJunchao Zhang #else 1464c2a741eeSJunchao Zhang return 0; 1465c2a741eeSJunchao Zhang #endif 1466c2a741eeSJunchao Zhang } 1467c2a741eeSJunchao Zhang 1468f14045dbSBarry Smith PetscErrorCode PetscLogView_Default(PetscViewer viewer) 14695c6c1daeSBarry Smith { 14705c6c1daeSBarry Smith FILE *fd; 14715c6c1daeSBarry Smith PetscLogDouble zero = 0.0; 14725c6c1daeSBarry Smith PetscStageLog stageLog; 14730298fd71SBarry Smith PetscStageInfo *stageInfo = NULL; 14740298fd71SBarry Smith PetscEventPerfInfo *eventInfo = NULL; 14755c6c1daeSBarry Smith PetscClassPerfInfo *classInfo; 14765c6c1daeSBarry Smith char arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128]; 14775c6c1daeSBarry Smith const char *name; 14785c6c1daeSBarry Smith PetscLogDouble locTotalTime, TotalTime, TotalFlops; 14795c6c1daeSBarry Smith PetscLogDouble numMessages, messageLength, avgMessLen, numReductions; 14805c6c1daeSBarry Smith PetscLogDouble stageTime, flops, flopr, mem, mess, messLen, red; 14815c6c1daeSBarry Smith PetscLogDouble fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed; 14825c6c1daeSBarry Smith PetscLogDouble fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed; 14835c6c1daeSBarry Smith PetscLogDouble min, max, tot, ratio, avg, x, y; 1484e3ed9ee7SBarry Smith PetscLogDouble minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr, mal, malmax, emalmax; 1485d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1486958c4211Shannah_mairs PetscLogDouble cct, gct, csz, gsz, gmaxt, gflops, gflopr, fracgflops; 1487bec0b493Shannah_mairs #endif 1488217044c2SLisandro Dalcin PetscMPIInt minC, maxC; 14895c6c1daeSBarry Smith PetscMPIInt size, rank; 14905c6c1daeSBarry Smith PetscBool *localStageUsed, *stageUsed; 14915c6c1daeSBarry Smith PetscBool *localStageVisible, *stageVisible; 14925c6c1daeSBarry Smith int numStages, localNumEvents, numEvents; 149337b78d16SBarry Smith int stage, oclass; 14945c6c1daeSBarry Smith PetscLogEvent event; 14955c6c1daeSBarry Smith PetscErrorCode ierr; 14965c6c1daeSBarry Smith char version[256]; 14975c6c1daeSBarry Smith MPI_Comm comm; 14985c6c1daeSBarry Smith 14995c6c1daeSBarry Smith PetscFunctionBegin; 15005c6c1daeSBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 15015c6c1daeSBarry Smith ierr = PetscViewerASCIIGetPointer(viewer,&fd);CHKERRQ(ierr); 1502ffc4695bSBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRMPI(ierr); 1503ffc4695bSBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRMPI(ierr); 15045c6c1daeSBarry Smith /* Get the total elapsed time */ 15058563dfccSBarry Smith PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 15065c6c1daeSBarry Smith 1507a6f03b2cSMark Adams ierr = PetscFPrintf(comm, fd, "**************************************** ***********************************************************************************************************************\n");CHKERRQ(ierr); 1508a6f03b2cSMark Adams ierr = PetscFPrintf(comm, fd, "*** WIDEN YOUR WINDOW TO 160 CHARACTERS. Use 'enscript -r -fCourier9' to print this document ***\n");CHKERRQ(ierr); 1509a6f03b2cSMark Adams ierr = PetscFPrintf(comm, fd, "****************************************************************************************************************************************************************\n");CHKERRQ(ierr); 1510a6f03b2cSMark Adams ierr = PetscFPrintf(comm, fd, "\n------------------------------------------------------------------ PETSc Performance Summary: -------------------------------------------------------------------\n\n");CHKERRQ(ierr); 1511217044c2SLisandro Dalcin ierr = PetscLogViewWarnSync(comm,fd);CHKERRQ(ierr); 1512f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 1513c2a741eeSJunchao Zhang ierr = PetscLogViewWarnNoGpuAwareMpi(comm,fd);CHKERRQ(ierr); 15145c6c1daeSBarry Smith ierr = PetscGetArchType(arch,sizeof(arch));CHKERRQ(ierr); 15155c6c1daeSBarry Smith ierr = PetscGetHostName(hostname,sizeof(hostname));CHKERRQ(ierr); 15165c6c1daeSBarry Smith ierr = PetscGetUserName(username,sizeof(username));CHKERRQ(ierr); 15175c6c1daeSBarry Smith ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr); 15185c6c1daeSBarry Smith ierr = PetscGetDate(date,sizeof(date));CHKERRQ(ierr); 15195c6c1daeSBarry Smith ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr); 15205c6c1daeSBarry Smith if (size == 1) { 15215c6c1daeSBarry 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); 15225c6c1daeSBarry Smith } else { 15235c6c1daeSBarry 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); 15245c6c1daeSBarry Smith } 1525f90b075cSBarry Smith #if defined(PETSC_HAVE_OPENMP) 15263ca90d2dSJacob Faibussowitsch ierr = PetscFPrintf(comm,fd,"Using %" PetscInt_FMT " OpenMP threads\n", PetscNumOMPThreads);CHKERRQ(ierr); 1527f90b075cSBarry Smith #endif 15285c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Using %s\n", version);CHKERRQ(ierr); 15295c6c1daeSBarry Smith 15305c6c1daeSBarry Smith /* Must preserve reduction count before we go on */ 15315c6c1daeSBarry Smith red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 15325c6c1daeSBarry Smith 15335c6c1daeSBarry Smith /* Calculate summary information */ 15345c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n Max Max/Min Avg Total\n");CHKERRQ(ierr); 15355c6c1daeSBarry Smith /* Time */ 1536820f2d46SBarry Smith ierr = MPI_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1537820f2d46SBarry Smith ierr = MPI_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1538820f2d46SBarry Smith ierr = MPI_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1539217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1540217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1541217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Time (sec): %5.3e %7.3f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 15425c6c1daeSBarry Smith TotalTime = tot; 15435c6c1daeSBarry Smith /* Objects */ 15445c6c1daeSBarry Smith avg = (PetscLogDouble) petsc_numObjects; 1545820f2d46SBarry Smith ierr = MPI_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1546820f2d46SBarry Smith ierr = MPI_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1547820f2d46SBarry Smith ierr = MPI_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1548217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1549217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1550217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Objects: %5.3e %7.3f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 15515c6c1daeSBarry Smith /* Flops */ 1552820f2d46SBarry Smith ierr = MPI_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1553820f2d46SBarry Smith ierr = MPI_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1554820f2d46SBarry Smith ierr = MPI_Allreduce(&petsc_TotalFlops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1555217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1556217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1557217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Flop: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 15585c6c1daeSBarry Smith TotalFlops = tot; 15595c6c1daeSBarry Smith /* Flops/sec -- Must talk to Barry here */ 1560217044c2SLisandro Dalcin if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime; else flops = 0.0; 1561820f2d46SBarry Smith ierr = MPI_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1562820f2d46SBarry Smith ierr = MPI_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1563820f2d46SBarry Smith ierr = MPI_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1564217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1565217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1566217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Flop/sec: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 15675c6c1daeSBarry Smith /* Memory */ 15685c6c1daeSBarry Smith ierr = PetscMallocGetMaximumUsage(&mem);CHKERRQ(ierr); 15695c6c1daeSBarry Smith if (mem > 0.0) { 1570820f2d46SBarry Smith ierr = MPI_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1571820f2d46SBarry Smith ierr = MPI_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1572820f2d46SBarry Smith ierr = MPI_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1573217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1574217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1575217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Memory: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 15765c6c1daeSBarry Smith } 15775c6c1daeSBarry Smith /* Messages */ 15785c6c1daeSBarry Smith mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct); 1579820f2d46SBarry Smith ierr = MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1580820f2d46SBarry Smith ierr = MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1581820f2d46SBarry Smith ierr = MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1582217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1583217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1584217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Messages: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 15855c6c1daeSBarry Smith numMessages = tot; 15865c6c1daeSBarry Smith /* Message Lengths */ 15875c6c1daeSBarry Smith mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len); 1588820f2d46SBarry Smith ierr = MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1589820f2d46SBarry Smith ierr = MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1590820f2d46SBarry Smith ierr = MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1591217044c2SLisandro Dalcin if (numMessages != 0) avg = tot/numMessages; else avg = 0.0; 1592217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1593217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Message Lengths: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 15945c6c1daeSBarry Smith messageLength = tot; 15955c6c1daeSBarry Smith /* Reductions */ 1596820f2d46SBarry Smith ierr = MPI_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1597820f2d46SBarry Smith ierr = MPI_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1598820f2d46SBarry Smith ierr = MPI_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1599217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1600217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Reductions: %5.3e %7.3f\n", max, ratio);CHKERRQ(ierr); 16015c6c1daeSBarry Smith numReductions = red; /* wrong because uses count from process zero */ 16025c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n");CHKERRQ(ierr); 1603d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " e.g., VecAXPY() for real vectors of length N --> 2N flop\n");CHKERRQ(ierr); 1604d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " and VecAXPY() for complex vectors of length N --> 8N flop\n");CHKERRQ(ierr); 16055c6c1daeSBarry Smith 16065c6c1daeSBarry Smith /* Get total number of stages -- 16075c6c1daeSBarry Smith Currently, a single processor can register more stages than another, but stages must all be registered in order. 16085c6c1daeSBarry Smith We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID. 16095c6c1daeSBarry Smith This seems best accomplished by assoicating a communicator with each stage. 16105c6c1daeSBarry Smith */ 161137b78d16SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1612820f2d46SBarry Smith ierr = MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 1613785e854fSJed Brown ierr = PetscMalloc1(numStages, &localStageUsed);CHKERRQ(ierr); 1614785e854fSJed Brown ierr = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr); 1615785e854fSJed Brown ierr = PetscMalloc1(numStages, &localStageVisible);CHKERRQ(ierr); 1616785e854fSJed Brown ierr = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr); 16175c6c1daeSBarry Smith if (numStages > 0) { 16185c6c1daeSBarry Smith stageInfo = stageLog->stageInfo; 16195c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16205c6c1daeSBarry Smith if (stage < stageLog->numStages) { 16215c6c1daeSBarry Smith localStageUsed[stage] = stageInfo[stage].used; 16225c6c1daeSBarry Smith localStageVisible[stage] = stageInfo[stage].perfInfo.visible; 16235c6c1daeSBarry Smith } else { 16245c6c1daeSBarry Smith localStageUsed[stage] = PETSC_FALSE; 16255c6c1daeSBarry Smith localStageVisible[stage] = PETSC_TRUE; 16265c6c1daeSBarry Smith } 16275c6c1daeSBarry Smith } 1628820f2d46SBarry Smith ierr = MPI_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm);CHKERRMPI(ierr); 1629820f2d46SBarry Smith ierr = MPI_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm);CHKERRMPI(ierr); 16305c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16315c6c1daeSBarry Smith if (stageUsed[stage]) { 1632217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "\nSummary of Stages: ----- Time ------ ----- Flop ------ --- Messages --- -- Message Lengths -- -- Reductions --\n");CHKERRQ(ierr); 1633217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " Avg %%Total Avg %%Total Count %%Total Avg %%Total Count %%Total\n");CHKERRQ(ierr); 16345c6c1daeSBarry Smith break; 16355c6c1daeSBarry Smith } 16365c6c1daeSBarry Smith } 16375c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16385c6c1daeSBarry Smith if (!stageUsed[stage]) continue; 1639820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 16405c6c1daeSBarry Smith if (localStageUsed[stage]) { 1641ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1642ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1643ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1644ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1645ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 16465c6c1daeSBarry Smith name = stageInfo[stage].name; 16475c6c1daeSBarry Smith } else { 1648ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1649ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1650ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1651ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1652ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 16535c6c1daeSBarry Smith name = ""; 16545c6c1daeSBarry Smith } 16555c6c1daeSBarry Smith mess *= 0.5; messLen *= 0.5; red /= size; 16565c6c1daeSBarry Smith if (TotalTime != 0.0) fracTime = stageTime/TotalTime; else fracTime = 0.0; 16575c6c1daeSBarry Smith if (TotalFlops != 0.0) fracFlops = flops/TotalFlops; else fracFlops = 0.0; 16585c6c1daeSBarry Smith /* Talk to Barry if (stageTime != 0.0) flops = (size*flops)/stageTime; else flops = 0.0; */ 16595c6c1daeSBarry Smith if (numMessages != 0.0) fracMessages = mess/numMessages; else fracMessages = 0.0; 1660e96a4d02SJunchao Zhang if (mess != 0.0) avgMessLen = messLen/mess; else avgMessLen = 0.0; 16615c6c1daeSBarry Smith if (messageLength != 0.0) fracLength = messLen/messageLength; else fracLength = 0.0; 16625c6c1daeSBarry Smith if (numReductions != 0.0) fracReductions = red/numReductions; else fracReductions = 0.0; 16635c6c1daeSBarry 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", 16645c6c1daeSBarry Smith stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops, 16655c6c1daeSBarry Smith mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr); 16665c6c1daeSBarry Smith } 16675c6c1daeSBarry Smith } 16685c6c1daeSBarry Smith 1669806fa848SBarry Smith ierr = PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 16705c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n");CHKERRQ(ierr); 16715c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Phase summary info:\n");CHKERRQ(ierr); 16725c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Count: number of times phase was executed\n");CHKERRQ(ierr); 1673d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " Time and Flop: Max - maximum over all processors\n");CHKERRQ(ierr); 16745c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Ratio - ratio of maximum to minimum over all processors\n");CHKERRQ(ierr); 16755c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Mess: number of messages sent\n");CHKERRQ(ierr); 1676217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " AvgLen: average message length (bytes)\n");CHKERRQ(ierr); 16775c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Reduct: number of global reductions\n");CHKERRQ(ierr); 16785c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Global: entire computation\n");CHKERRQ(ierr); 16795c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n");CHKERRQ(ierr); 1680d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " %%T - percent time in this phase %%F - percent flop in this phase\n");CHKERRQ(ierr); 16815c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " %%M - percent messages in this phase %%L - percent message lengths in this phase\n");CHKERRQ(ierr); 16825c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " %%R - percent reductions in this phase\n");CHKERRQ(ierr); 1683d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n");CHKERRQ(ierr); 1684e3ed9ee7SBarry Smith if (PetscLogMemory) { 1685e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event)\n");CHKERRQ(ierr); 1686e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events)\n");CHKERRQ(ierr); 1687e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event)\n");CHKERRQ(ierr); 1688e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " RMI Mbytes: Increase in resident memory (sum over all calls to event)\n");CHKERRQ(ierr); 1689e3ed9ee7SBarry Smith } 1690d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1691958c4211Shannah_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); 16924863603aSSatish Balay ierr = PetscFPrintf(comm, fd, " CpuToGpu Count: total number of CPU to GPU copies per processor\n");CHKERRQ(ierr); 16934863603aSSatish Balay ierr = PetscFPrintf(comm, fd, " CpuToGpu Size (Mbytes): 10e-6 * (total size of CPU to GPU copies per processor)\n");CHKERRQ(ierr); 16944863603aSSatish Balay ierr = PetscFPrintf(comm, fd, " GpuToCpu Count: total number of GPU to CPU copies per processor\n");CHKERRQ(ierr); 16954863603aSSatish Balay ierr = PetscFPrintf(comm, fd, " GpuToCpu Size (Mbytes): 10e-6 * (total size of GPU to CPU copies per processor)\n");CHKERRQ(ierr); 1696958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd, " GPU %%F: percent flops on GPU in this event\n");CHKERRQ(ierr); 1697bec0b493Shannah_mairs #endif 1698806fa848SBarry Smith ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 16995c6c1daeSBarry Smith 1700f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 17015c6c1daeSBarry Smith 17025c6c1daeSBarry Smith /* Report events */ 1703e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd,"Event Count Time (sec) Flop --- Global --- --- Stage ---- Total");CHKERRQ(ierr); 1704e3ed9ee7SBarry Smith if (PetscLogMemory) { 1705bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd," Malloc EMalloc MMalloc RMI");CHKERRQ(ierr); 1706e3ed9ee7SBarry Smith } 1707d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1708958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd," GPU - CpuToGpu - - GpuToCpu - GPU");CHKERRQ(ierr); 1709bec0b493Shannah_mairs #endif 1710bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 1711e3ed9ee7SBarry 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); 1712e3ed9ee7SBarry Smith if (PetscLogMemory) { 1713bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd," Mbytes Mbytes Mbytes Mbytes");CHKERRQ(ierr); 1714e3ed9ee7SBarry Smith } 1715d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1716958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd," Mflop/s Count Size Count Size %%F");CHKERRQ(ierr); 1717bec0b493Shannah_mairs #endif 1718bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 17194863603aSSatish Balay ierr = PetscFPrintf(comm, fd,"------------------------------------------------------------------------------------------------------------------------");CHKERRQ(ierr); 17204863603aSSatish Balay if (PetscLogMemory) { 17214863603aSSatish Balay ierr = PetscFPrintf(comm, fd,"-----------------------------");CHKERRQ(ierr); 17224863603aSSatish Balay } 1723d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1724958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd,"---------------------------------------");CHKERRQ(ierr); 17254863603aSSatish Balay #endif 17264863603aSSatish Balay ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 17275c6c1daeSBarry Smith 17285c6c1daeSBarry Smith /* Problem: The stage name will not show up unless the stage executed on proc 1 */ 17295c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 17305c6c1daeSBarry Smith if (!stageVisible[stage]) continue; 1731820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 17325c6c1daeSBarry Smith if (localStageUsed[stage]) { 17335c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 1734ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1735ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1736ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1737ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1738ffc4695bSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 17395c6c1daeSBarry Smith } else { 17405c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 1741ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1742ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1743ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1744ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1745ffc4695bSBarry Smith ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 17465c6c1daeSBarry Smith } 17475c6c1daeSBarry Smith mess *= 0.5; messLen *= 0.5; red /= size; 17485c6c1daeSBarry Smith 17495c6c1daeSBarry Smith /* Get total number of events in this stage -- 17505c6c1daeSBarry Smith Currently, a single processor can register more events than another, but events must all be registered in order, 17515c6c1daeSBarry Smith just like stages. We can removed this requirement if necessary by having a global event numbering and indirection 1752217044c2SLisandro Dalcin on the event ID. This seems best accomplished by associating a communicator with each stage. 17535c6c1daeSBarry Smith 17545c6c1daeSBarry Smith Problem: If the event did not happen on proc 1, its name will not be available. 17555c6c1daeSBarry Smith Problem: Event visibility is not implemented 17565c6c1daeSBarry Smith */ 17575c6c1daeSBarry Smith if (localStageUsed[stage]) { 17585c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo; 17595c6c1daeSBarry Smith localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents; 1760a297a907SKarl Rupp } else localNumEvents = 0; 1761820f2d46SBarry Smith ierr = MPI_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 17625c6c1daeSBarry Smith for (event = 0; event < numEvents; event++) { 1763820f2d46SBarry Smith /* CANNOT use MPI_Allreduce() since it might fail the line number check */ 17645c6c1daeSBarry Smith if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) { 1765217044c2SLisandro Dalcin if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; else flopr = 0.0; 1766ffc4695bSBarry Smith ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1767ffc4695bSBarry Smith ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1768ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1769ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 1770ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1771ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1772ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1773ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1774ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1775ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].count, &minC, 1, MPI_INT, MPI_MIN, comm);CHKERRMPI(ierr); 1776ffc4695bSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].count, &maxC, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 1777e3ed9ee7SBarry Smith if (PetscLogMemory) { 177855b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].memIncrease, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 177955b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].mallocSpace, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 178055b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].mallocIncrease, &malmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 178155b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1782e3ed9ee7SBarry Smith } 1783d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 178455b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].CpuToGpuCount, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 178555b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].GpuToCpuCount, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 178655b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].CpuToGpuSize, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 178755b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].GpuToCpuSize, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 178855b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].GpuFlops, &gflops,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 178955b25c41SPierre Jolivet ierr = MPI_Allreduce(&eventInfo[event].GpuTime, &gmaxt ,1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1790bec0b493Shannah_mairs #endif 17915c6c1daeSBarry Smith name = stageLog->eventLog->eventInfo[event].name; 17925c6c1daeSBarry Smith } else { 17935c6c1daeSBarry Smith flopr = 0.0; 179455b25c41SPierre Jolivet ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 179555b25c41SPierre Jolivet ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 179655b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 179755b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRMPI(ierr); 179855b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 179955b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 180055b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 180155b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 180255b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 180355b25c41SPierre Jolivet ierr = MPI_Allreduce(&ierr, &minC, 1, MPI_INT, MPI_MIN, comm);CHKERRMPI(ierr); 180455b25c41SPierre Jolivet ierr = MPI_Allreduce(&ierr, &maxC, 1, MPI_INT, MPI_MAX, comm);CHKERRMPI(ierr); 1805e3ed9ee7SBarry Smith if (PetscLogMemory) { 180655b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 180755b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 180855b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 180955b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 1810e3ed9ee7SBarry Smith } 1811d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 181255b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 181355b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 181455b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 181555b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 181655b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &gflops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRMPI(ierr); 181755b25c41SPierre Jolivet ierr = MPI_Allreduce(&zero, &gmaxt , 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRMPI(ierr); 1818bec0b493Shannah_mairs #endif 18195c6c1daeSBarry Smith name = ""; 18205c6c1daeSBarry Smith } 18215c6c1daeSBarry Smith if (mint < 0.0) { 18225c6c1daeSBarry 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); 18235c6c1daeSBarry Smith mint = 0; 18245c6c1daeSBarry Smith } 18252c71b3e2SJacob Faibussowitsch PetscCheckFalse(minf < 0.0,PETSC_COMM_SELF,PETSC_ERR_PLIB,"Minimum flop %g over all processors for %s is negative! Not possible!",minf,name); 18265c6c1daeSBarry Smith totm *= 0.5; totml *= 0.5; totr /= size; 18275c6c1daeSBarry Smith 1828217044c2SLisandro Dalcin if (maxC != 0) { 1829217044c2SLisandro Dalcin if (minC != 0) ratC = ((PetscLogDouble)maxC)/minC;else ratC = 0.0; 18305c6c1daeSBarry Smith if (mint != 0.0) ratt = maxt/mint; else ratt = 0.0; 18315c6c1daeSBarry Smith if (minf != 0.0) ratf = maxf/minf; else ratf = 0.0; 18325c6c1daeSBarry Smith if (TotalTime != 0.0) fracTime = tott/TotalTime; else fracTime = 0.0; 18335c6c1daeSBarry Smith if (TotalFlops != 0.0) fracFlops = totf/TotalFlops; else fracFlops = 0.0; 18345c6c1daeSBarry Smith if (stageTime != 0.0) fracStageTime = tott/stageTime; else fracStageTime = 0.0; 18355c6c1daeSBarry Smith if (flops != 0.0) fracStageFlops = totf/flops; else fracStageFlops = 0.0; 18365c6c1daeSBarry Smith if (numMessages != 0.0) fracMess = totm/numMessages; else fracMess = 0.0; 18375c6c1daeSBarry Smith if (messageLength != 0.0) fracMessLen = totml/messageLength; else fracMessLen = 0.0; 18385c6c1daeSBarry Smith if (numReductions != 0.0) fracRed = totr/numReductions; else fracRed = 0.0; 18395c6c1daeSBarry Smith if (mess != 0.0) fracStageMess = totm/mess; else fracStageMess = 0.0; 18405c6c1daeSBarry Smith if (messLen != 0.0) fracStageMessLen = totml/messLen; else fracStageMessLen = 0.0; 18415c6c1daeSBarry Smith if (red != 0.0) fracStageRed = totr/red; else fracStageRed = 0.0; 18425c6c1daeSBarry Smith if (totm != 0.0) totml /= totm; else totml = 0.0; 18435c6c1daeSBarry Smith if (maxt != 0.0) flopr = totf/maxt; else flopr = 0.0; 184460d4fc61SSatish Balay 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);} 18455c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, 1846e3ed9ee7SBarry 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", 1847217044c2SLisandro Dalcin name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr, 18485c6c1daeSBarry Smith 100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed, 18495c6c1daeSBarry Smith 100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed, 1850c068d9bbSLisandro Dalcin PetscAbs(flopr)/1.0e6);CHKERRQ(ierr); 1851e3ed9ee7SBarry Smith if (PetscLogMemory) { 1852bec0b493Shannah_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); 1853e3ed9ee7SBarry Smith } 1854d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1855958c4211Shannah_mairs if (totf != 0.0) fracgflops = gflops/totf; else fracgflops = 0.0; 1856958c4211Shannah_mairs if (gmaxt != 0.0) gflopr = gflops/gmaxt; else gflopr = 0.0; 1857958c4211Shannah_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); 1858bec0b493Shannah_mairs #endif 1859bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 18605c6c1daeSBarry Smith } 18615c6c1daeSBarry Smith } 18625c6c1daeSBarry Smith } 18635c6c1daeSBarry Smith 18645c6c1daeSBarry Smith /* Memory usage and object creation */ 18654863603aSSatish Balay ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------");CHKERRQ(ierr); 18664863603aSSatish Balay if (PetscLogMemory) { 18674863603aSSatish Balay ierr = PetscFPrintf(comm, fd, "-----------------------------");CHKERRQ(ierr); 18684863603aSSatish Balay } 1869d9c66bfbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 1870958c4211Shannah_mairs ierr = PetscFPrintf(comm, fd, "---------------------------------------");CHKERRQ(ierr); 18714863603aSSatish Balay #endif 18724863603aSSatish Balay ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 18735c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 18745c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n");CHKERRQ(ierr); 18755c6c1daeSBarry Smith 18765c6c1daeSBarry Smith /* Right now, only stages on the first processor are reported here, meaning only objects associated with 18775c6c1daeSBarry Smith the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then 18785c6c1daeSBarry Smith stats for stages local to processor sets. 18795c6c1daeSBarry Smith */ 18805c6c1daeSBarry Smith /* We should figure out the longest object name here (now 20 characters) */ 18815c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Object Type Creations Destructions Memory Descendants' Mem.\n");CHKERRQ(ierr); 18825c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Reports information only for process 0.\n");CHKERRQ(ierr); 18835c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 18845c6c1daeSBarry Smith if (localStageUsed[stage]) { 18855c6c1daeSBarry Smith classInfo = stageLog->stageInfo[stage].classLog->classInfo; 18865c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 18875c6c1daeSBarry Smith for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) { 18885c6c1daeSBarry Smith if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) { 18895c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%20s %5d %5d %11.0f %g\n", stageLog->classLog->classInfo[oclass].name, 18905c6c1daeSBarry Smith classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem, 18915c6c1daeSBarry Smith classInfo[oclass].descMem);CHKERRQ(ierr); 18925c6c1daeSBarry Smith } 18935c6c1daeSBarry Smith } 18945c6c1daeSBarry Smith } else { 1895cf019ec6SStefano Zampini if (!localStageVisible[stage]) continue; 18965c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 18975c6c1daeSBarry Smith } 18985c6c1daeSBarry Smith } 18995c6c1daeSBarry Smith 19005c6c1daeSBarry Smith ierr = PetscFree(localStageUsed);CHKERRQ(ierr); 19015c6c1daeSBarry Smith ierr = PetscFree(stageUsed);CHKERRQ(ierr); 19025c6c1daeSBarry Smith ierr = PetscFree(localStageVisible);CHKERRQ(ierr); 19035c6c1daeSBarry Smith ierr = PetscFree(stageVisible);CHKERRQ(ierr); 19045c6c1daeSBarry Smith 19055c6c1daeSBarry Smith /* Information unrelated to this particular run */ 1906a297a907SKarl Rupp ierr = PetscFPrintf(comm, fd, "========================================================================================================================\n");CHKERRQ(ierr); 19078563dfccSBarry Smith PetscTime(&y); 19088563dfccSBarry Smith PetscTime(&x); 19098563dfccSBarry Smith PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 19108563dfccSBarry Smith PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 19115c6c1daeSBarry Smith ierr = PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0);CHKERRQ(ierr); 19125c6c1daeSBarry Smith /* MPI information */ 19135c6c1daeSBarry Smith if (size > 1) { 19145c6c1daeSBarry Smith MPI_Status status; 19155c6c1daeSBarry Smith PetscMPIInt tag; 19165c6c1daeSBarry Smith MPI_Comm newcomm; 19175c6c1daeSBarry Smith 1918ffc4695bSBarry Smith ierr = MPI_Barrier(comm);CHKERRMPI(ierr); 19198563dfccSBarry Smith PetscTime(&x); 1920ffc4695bSBarry Smith ierr = MPI_Barrier(comm);CHKERRMPI(ierr); 1921ffc4695bSBarry Smith ierr = MPI_Barrier(comm);CHKERRMPI(ierr); 1922ffc4695bSBarry Smith ierr = MPI_Barrier(comm);CHKERRMPI(ierr); 1923ffc4695bSBarry Smith ierr = MPI_Barrier(comm);CHKERRMPI(ierr); 1924ffc4695bSBarry Smith ierr = MPI_Barrier(comm);CHKERRMPI(ierr); 19258563dfccSBarry Smith PetscTime(&y); 19265c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0);CHKERRQ(ierr); 19275c6c1daeSBarry Smith ierr = PetscCommDuplicate(comm,&newcomm, &tag);CHKERRQ(ierr); 1928ffc4695bSBarry Smith ierr = MPI_Barrier(comm);CHKERRMPI(ierr); 19295c6c1daeSBarry Smith if (rank) { 1930ffc4695bSBarry Smith ierr = MPI_Recv(NULL, 0, MPI_INT, rank-1, tag, newcomm, &status);CHKERRMPI(ierr); 1931ffc4695bSBarry Smith ierr = MPI_Send(NULL, 0, MPI_INT, (rank+1)%size, tag, newcomm);CHKERRMPI(ierr); 19325c6c1daeSBarry Smith } else { 19338563dfccSBarry Smith PetscTime(&x); 1934ffc4695bSBarry Smith ierr = MPI_Send(NULL, 0, MPI_INT, 1, tag, newcomm);CHKERRMPI(ierr); 1935ffc4695bSBarry Smith ierr = MPI_Recv(NULL, 0, MPI_INT, size-1, tag, newcomm, &status);CHKERRMPI(ierr); 19368563dfccSBarry Smith PetscTime(&y); 19375c6c1daeSBarry Smith ierr = PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size);CHKERRQ(ierr); 19385c6c1daeSBarry Smith } 19395c6c1daeSBarry Smith ierr = PetscCommDestroy(&newcomm);CHKERRQ(ierr); 19405c6c1daeSBarry Smith } 1941c5929fdfSBarry Smith ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr); 19425c6c1daeSBarry Smith 19435c6c1daeSBarry Smith /* Machine and compile information */ 19445c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS) 19455c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n");CHKERRQ(ierr); 19465c6c1daeSBarry Smith #else 19475c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n");CHKERRQ(ierr); 19485c6c1daeSBarry Smith #endif 1949217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) 1950217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n");CHKERRQ(ierr); 1951217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128) 1952217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n");CHKERRQ(ierr); 1953217044c2SLisandro Dalcin #endif 19545c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 19555c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 19565f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128) 19575f27b2e0SBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 19585c6c1daeSBarry Smith #endif 19595c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE) 19605c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with single precision matrices\n");CHKERRQ(ierr); 19615c6c1daeSBarry Smith #else 19625c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n");CHKERRQ(ierr); 19635c6c1daeSBarry Smith #endif 19645c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n", 19655c6c1daeSBarry Smith (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt));CHKERRQ(ierr); 19665c6c1daeSBarry Smith 19675c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions);CHKERRQ(ierr); 19685c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petscmachineinfo);CHKERRQ(ierr); 19695c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsccompilerinfo);CHKERRQ(ierr); 19705c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo);CHKERRQ(ierr); 19715c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsclinkerinfo);CHKERRQ(ierr); 19725c6c1daeSBarry Smith 19735c6c1daeSBarry Smith /* Cleanup */ 19745c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 1975c2a741eeSJunchao Zhang ierr = PetscLogViewWarnNoGpuAwareMpi(comm,fd);CHKERRQ(ierr); 1976f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 19775c6c1daeSBarry Smith PetscFunctionReturn(0); 19785c6c1daeSBarry Smith } 19795c6c1daeSBarry Smith 19807d6c928cSSatish Balay /*@C 19817d6c928cSSatish Balay PetscLogView - Prints a summary of the logging. 19825c6c1daeSBarry Smith 19835c6c1daeSBarry Smith Collective over MPI_Comm 19845c6c1daeSBarry Smith 19855c6c1daeSBarry Smith Input Parameter: 1986f14045dbSBarry Smith . viewer - an ASCII viewer 19875c6c1daeSBarry Smith 19885c6c1daeSBarry Smith Options Database Keys: 1989bb1d7374SBarry Smith + -log_view [:filename] - Prints summary of log information 1990bb1d7374SBarry Smith . -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file 1991607d249eSBarry 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) 1992d0a29bd7SConnor 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) 1993bb1d7374SBarry Smith . -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation 1994bb1d7374SBarry Smith - -log_trace [filename] - Displays a trace of what each process is doing 19955c6c1daeSBarry Smith 19965c6c1daeSBarry Smith Notes: 1997bb1d7374SBarry Smith It is possible to control the logging programatically but we recommend using the options database approach whenever possible 19985c6c1daeSBarry Smith By default the summary is printed to stdout. 19995c6c1daeSBarry Smith 2000bb1d7374SBarry Smith Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin() 2001bb1d7374SBarry Smith 2002bb1d7374SBarry Smith If PETSc is configured with --with-logging=0 then this functionality is not available 2003bb1d7374SBarry Smith 2004607d249eSBarry Smith To view the nested XML format filename.xml first copy ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current 2005607d249eSBarry Smith directory then open filename.xml with your browser. Specific notes for certain browsers 2006607d249eSBarry Smith $ Firefox and Internet explorer - simply open the file 2007607d249eSBarry Smith $ Google Chrome - you must start up Chrome with the option --allow-file-access-from-files 2008a8d69d7bSBarry Smith $ Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access 2009607d249eSBarry 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 2010607d249eSBarry Smith your browser. 20112add09c0SLisandro Dalcin Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser 20122add09c0SLisandro Dalcin window and render the XML log file contents. 2013607d249eSBarry Smith 2014bb1d7374SBarry Smith The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij MARITIME RESEARCH INSTITUTE NETHERLANDS 2015bb1d7374SBarry Smith 2016d0a29bd7SConnor Ward The Flame Graph output can be visualised using either the original Flame Graph script (https://github.com/brendangregg/FlameGraph) 2017d0a29bd7SConnor Ward or using speedscope (https://www.speedscope.app). 2018d0a29bd7SConnor Ward Old XML profiles may be converted into this format using the script ${PETSC_DIR}/lib/petsc/bin/xml2flamegraph.py. 2019d0a29bd7SConnor Ward 20205c6c1daeSBarry Smith Level: beginner 20215c6c1daeSBarry Smith 2022bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogDump() 20235c6c1daeSBarry Smith @*/ 2024f14045dbSBarry Smith PetscErrorCode PetscLogView(PetscViewer viewer) 20255c6c1daeSBarry Smith { 20265c6c1daeSBarry Smith PetscErrorCode ierr; 2027f14045dbSBarry Smith PetscBool isascii; 2028f14045dbSBarry Smith PetscViewerFormat format; 202937b78d16SBarry Smith int stage, lastStage; 203037b78d16SBarry Smith PetscStageLog stageLog; 20315c6c1daeSBarry Smith 20325c6c1daeSBarry Smith PetscFunctionBegin; 20332c71b3e2SJacob Faibussowitsch PetscCheckFalse(!PetscLogPLB,PETSC_COMM_SELF,PETSC_ERR_SUP,"Must use -log_view or PetscLogDefaultBegin() before calling this routine"); 203437b78d16SBarry Smith /* Pop off any stages the user forgot to remove */ 203537b78d16SBarry Smith lastStage = 0; 203637b78d16SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 203737b78d16SBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 203837b78d16SBarry Smith while (stage >= 0) { 203937b78d16SBarry Smith lastStage = stage; 204037b78d16SBarry Smith ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 204137b78d16SBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 204237b78d16SBarry Smith } 2043f14045dbSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 20442c71b3e2SJacob Faibussowitsch PetscCheckFalse(!isascii,PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Currently can only view logging to ASCII"); 2045f14045dbSBarry Smith ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr); 2046f14045dbSBarry Smith if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) { 2047f14045dbSBarry Smith ierr = PetscLogView_Default(viewer);CHKERRQ(ierr); 2048f14045dbSBarry Smith } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) { 2049f14045dbSBarry Smith ierr = PetscLogView_Detailed(viewer);CHKERRQ(ierr); 205038144912Sdeepblu2718 } else if (format == PETSC_VIEWER_ASCII_CSV) { 205138144912Sdeepblu2718 ierr = PetscLogView_CSV(viewer);CHKERRQ(ierr); 2052bb1d7374SBarry Smith } else if (format == PETSC_VIEWER_ASCII_XML) { 2053bb1d7374SBarry Smith ierr = PetscLogView_Nested(viewer);CHKERRQ(ierr); 2054d0a29bd7SConnor Ward } else if (format == PETSC_VIEWER_ASCII_FLAMEGRAPH) { 2055d0a29bd7SConnor Ward ierr = PetscLogView_Flamegraph(viewer);CHKERRQ(ierr); 20565c6c1daeSBarry Smith } 205737b78d16SBarry Smith ierr = PetscStageLogPush(stageLog, lastStage);CHKERRQ(ierr); 20585c6c1daeSBarry Smith PetscFunctionReturn(0); 20595c6c1daeSBarry Smith } 20605c6c1daeSBarry Smith 2061f14045dbSBarry Smith /*@C 2062f14045dbSBarry Smith PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed. 2063f14045dbSBarry Smith 2064f14045dbSBarry Smith Collective on PETSC_COMM_WORLD 2065f14045dbSBarry Smith 2066f14045dbSBarry Smith Not normally called by user 2067f14045dbSBarry Smith 2068f14045dbSBarry Smith Level: intermediate 2069f14045dbSBarry Smith 2070f14045dbSBarry Smith @*/ 2071f14045dbSBarry Smith PetscErrorCode PetscLogViewFromOptions(void) 2072f14045dbSBarry Smith { 2073f14045dbSBarry Smith PetscErrorCode ierr; 2074f14045dbSBarry Smith PetscViewer viewer; 2075f14045dbSBarry Smith PetscBool flg; 2076f14045dbSBarry Smith PetscViewerFormat format; 2077f14045dbSBarry Smith 2078f14045dbSBarry Smith PetscFunctionBegin; 207916413a6aSBarry Smith ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-log_view",&viewer,&format,&flg);CHKERRQ(ierr); 2080f14045dbSBarry Smith if (flg) { 2081f14045dbSBarry Smith ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 2082f14045dbSBarry Smith ierr = PetscLogView(viewer);CHKERRQ(ierr); 2083f14045dbSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 2084f14045dbSBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 2085f14045dbSBarry Smith } 2086f14045dbSBarry Smith PetscFunctionReturn(0); 2087f14045dbSBarry Smith } 2088f14045dbSBarry Smith 20895c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/ 20905c6c1daeSBarry Smith /*@C 20915c6c1daeSBarry Smith PetscGetFlops - Returns the number of flops used on this processor 20925c6c1daeSBarry Smith since the program began. 20935c6c1daeSBarry Smith 20945c6c1daeSBarry Smith Not Collective 20955c6c1daeSBarry Smith 20965c6c1daeSBarry Smith Output Parameter: 20975c6c1daeSBarry Smith flops - number of floating point operations 20985c6c1daeSBarry Smith 20995c6c1daeSBarry Smith Notes: 21005c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 21015c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 21025c6c1daeSBarry Smith application code. 21035c6c1daeSBarry Smith 21045c6c1daeSBarry Smith Level: intermediate 21055c6c1daeSBarry Smith 21068563dfccSBarry Smith .seealso: PetscTime(), PetscLogFlops() 21075c6c1daeSBarry Smith @*/ 21085c6c1daeSBarry Smith PetscErrorCode PetscGetFlops(PetscLogDouble *flops) 21095c6c1daeSBarry Smith { 21105c6c1daeSBarry Smith PetscFunctionBegin; 21115c6c1daeSBarry Smith *flops = petsc_TotalFlops; 21125c6c1daeSBarry Smith PetscFunctionReturn(0); 21135c6c1daeSBarry Smith } 21145c6c1daeSBarry Smith 21155c6c1daeSBarry Smith PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 21165c6c1daeSBarry Smith { 21175c6c1daeSBarry Smith PetscErrorCode ierr; 21185c6c1daeSBarry Smith size_t fullLength; 21195c6c1daeSBarry Smith va_list Argp; 21205c6c1daeSBarry Smith 21215c6c1daeSBarry Smith PetscFunctionBegin; 21225c6c1daeSBarry Smith if (!petsc_logObjects) PetscFunctionReturn(0); 21235c6c1daeSBarry Smith va_start(Argp, format); 21245c6c1daeSBarry Smith ierr = PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp);CHKERRQ(ierr); 21255c6c1daeSBarry Smith va_end(Argp); 21265c6c1daeSBarry Smith PetscFunctionReturn(0); 21275c6c1daeSBarry Smith } 21285c6c1daeSBarry Smith 21295c6c1daeSBarry Smith /*MC 21305c6c1daeSBarry Smith PetscLogFlops - Adds floating point operations to the global counter. 21315c6c1daeSBarry Smith 21325c6c1daeSBarry Smith Synopsis: 2133aaa7dc30SBarry Smith #include <petsclog.h> 21345c6c1daeSBarry Smith PetscErrorCode PetscLogFlops(PetscLogDouble f) 21355c6c1daeSBarry Smith 21365c6c1daeSBarry Smith Not Collective 21375c6c1daeSBarry Smith 21385c6c1daeSBarry Smith Input Parameter: 21395c6c1daeSBarry Smith . f - flop counter 21405c6c1daeSBarry Smith 21415c6c1daeSBarry Smith Usage: 21425c6c1daeSBarry Smith .vb 21435c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 21445c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 21455c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 21465c6c1daeSBarry Smith [code segment to monitor] 21475c6c1daeSBarry Smith PetscLogFlops(user_flops) 21485c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 21495c6c1daeSBarry Smith .ve 21505c6c1daeSBarry Smith 21515c6c1daeSBarry Smith Notes: 21525c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 21535c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 21545c6c1daeSBarry Smith application code. 21555c6c1daeSBarry Smith 21565c6c1daeSBarry Smith Level: intermediate 21575c6c1daeSBarry Smith 21585c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscGetFlops() 21595c6c1daeSBarry Smith 21605c6c1daeSBarry Smith M*/ 21615c6c1daeSBarry Smith 21625c6c1daeSBarry Smith /*MC 21635c6c1daeSBarry Smith PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice) 21645c6c1daeSBarry Smith to get accurate timings 21655c6c1daeSBarry Smith 21665c6c1daeSBarry Smith Synopsis: 2167aaa7dc30SBarry Smith #include <petsclog.h> 21685c6c1daeSBarry Smith void PetscPreLoadBegin(PetscBool flag,char *name); 21695c6c1daeSBarry Smith 21705c6c1daeSBarry Smith Not Collective 21715c6c1daeSBarry Smith 2172d8d19677SJose E. Roman Input Parameters: 21735c6c1daeSBarry Smith + flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden 21745c6c1daeSBarry Smith with command line option -preload true or -preload false 2175609bdbeeSBarry Smith - name - name of first stage (lines of code timed separately with -log_view) to 21765c6c1daeSBarry Smith be preloaded 21775c6c1daeSBarry Smith 21785c6c1daeSBarry Smith Usage: 21795c6c1daeSBarry Smith .vb 21805c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 21815c6c1daeSBarry Smith lines of code 21825c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 21835c6c1daeSBarry Smith lines of code 21845c6c1daeSBarry Smith PetscPreLoadEnd(); 21855c6c1daeSBarry Smith .ve 21865c6c1daeSBarry Smith 218795452b02SPatrick Sanan Notes: 218895452b02SPatrick Sanan Only works in C/C++, not Fortran 21895c6c1daeSBarry Smith 21905c6c1daeSBarry Smith Flags available within the macro. 21915c6c1daeSBarry Smith + PetscPreLoadingUsed - true if we are or have done preloading 21925c6c1daeSBarry Smith . PetscPreLoadingOn - true if it is CURRENTLY doing preload 21935c6c1daeSBarry Smith . PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second 21945c6c1daeSBarry Smith - PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on 21955c6c1daeSBarry Smith The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin() 21965c6c1daeSBarry Smith and PetscPreLoadEnd() 21975c6c1daeSBarry Smith 21985c6c1daeSBarry Smith Level: intermediate 21995c6c1daeSBarry Smith 22005c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage() 22015c6c1daeSBarry Smith 22025c6c1daeSBarry Smith M*/ 22035c6c1daeSBarry Smith 22045c6c1daeSBarry Smith /*MC 22055c6c1daeSBarry Smith PetscPreLoadEnd - End a segment of code that may be preloaded (run twice) 22065c6c1daeSBarry Smith to get accurate timings 22075c6c1daeSBarry Smith 22085c6c1daeSBarry Smith Synopsis: 2209aaa7dc30SBarry Smith #include <petsclog.h> 22105c6c1daeSBarry Smith void PetscPreLoadEnd(void); 22115c6c1daeSBarry Smith 22125c6c1daeSBarry Smith Not Collective 22135c6c1daeSBarry Smith 22145c6c1daeSBarry Smith Usage: 22155c6c1daeSBarry Smith .vb 22165c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22175c6c1daeSBarry Smith lines of code 22185c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22195c6c1daeSBarry Smith lines of code 22205c6c1daeSBarry Smith PetscPreLoadEnd(); 22215c6c1daeSBarry Smith .ve 22225c6c1daeSBarry Smith 222395452b02SPatrick Sanan Notes: 222495452b02SPatrick Sanan only works in C/C++ not fortran 22255c6c1daeSBarry Smith 22265c6c1daeSBarry Smith Level: intermediate 22275c6c1daeSBarry Smith 22285c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadStage() 22295c6c1daeSBarry Smith 22305c6c1daeSBarry Smith M*/ 22315c6c1daeSBarry Smith 22325c6c1daeSBarry Smith /*MC 22335c6c1daeSBarry Smith PetscPreLoadStage - Start a new segment of code to be timed separately. 22345c6c1daeSBarry Smith to get accurate timings 22355c6c1daeSBarry Smith 22365c6c1daeSBarry Smith Synopsis: 2237aaa7dc30SBarry Smith #include <petsclog.h> 22385c6c1daeSBarry Smith void PetscPreLoadStage(char *name); 22395c6c1daeSBarry Smith 22405c6c1daeSBarry Smith Not Collective 22415c6c1daeSBarry Smith 22425c6c1daeSBarry Smith Usage: 22435c6c1daeSBarry Smith .vb 22445c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 22455c6c1daeSBarry Smith lines of code 22465c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 22475c6c1daeSBarry Smith lines of code 22485c6c1daeSBarry Smith PetscPreLoadEnd(); 22495c6c1daeSBarry Smith .ve 22505c6c1daeSBarry Smith 225195452b02SPatrick Sanan Notes: 225295452b02SPatrick Sanan only works in C/C++ not fortran 22535c6c1daeSBarry Smith 22545c6c1daeSBarry Smith Level: intermediate 22555c6c1daeSBarry Smith 22565c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd() 22575c6c1daeSBarry Smith 22585c6c1daeSBarry Smith M*/ 22595c6c1daeSBarry Smith 2260a4af0ceeSJacob Faibussowitsch #if PetscDefined(HAVE_DEVICE) 2261a4af0ceeSJacob Faibussowitsch #include <petsc/private/deviceimpl.h> 22629ffd0706SHong Zhang 22639ffd0706SHong Zhang /*-------------------------------------------- GPU event Functions ----------------------------------------------*/ 22649ffd0706SHong Zhang /*@C 22659ffd0706SHong Zhang PetscLogGpuTimeBegin - Start timer for device 22669ffd0706SHong Zhang 22679ffd0706SHong Zhang Notes: 22689ffd0706SHong 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). 22699ffd0706SHong 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). 22709ffd0706SHong Zhang There is no need to call WaitForCUDA() or WaitForHIP() between PetscLogGpuTimeBegin and PetscLogGpuTimeEnd 22719ffd0706SHong Zhang This timer should NOT include times for data transfers between the GPU and CPU, nor setup actions such as allocating space. 22729ffd0706SHong Zhang The regular logging captures the time for data transfers and any CPU activites during the event 22739ffd0706SHong Zhang It is used to compute the flop rate on the GPU as it is actively engaged in running a kernel. 22749ffd0706SHong Zhang 22759ffd0706SHong Zhang Developer Notes: 22769ffd0706SHong 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(). 22779ffd0706SHong 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. 22789ffd0706SHong Zhang 22799ffd0706SHong Zhang Level: intermediate 22809ffd0706SHong Zhang 22819ffd0706SHong Zhang .seealso: PetscLogView(), PetscLogGpuFlops(), PetscLogGpuTimeEnd() 22829ffd0706SHong Zhang @*/ 22839ffd0706SHong Zhang PetscErrorCode PetscLogGpuTimeBegin(void) 22849ffd0706SHong Zhang { 22859ffd0706SHong Zhang PetscErrorCode ierr; 2286a4af0ceeSJacob Faibussowitsch 22879ffd0706SHong Zhang PetscFunctionBegin; 22881e8be873SJed Brown if (!PetscLogPLB) PetscFunctionReturn(0); 2289a4af0ceeSJacob Faibussowitsch if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) { 2290a4af0ceeSJacob Faibussowitsch PetscDeviceContext dctx; 2291a4af0ceeSJacob Faibussowitsch 2292a4af0ceeSJacob Faibussowitsch ierr = PetscDeviceContextGetCurrentContext(&dctx);CHKERRQ(ierr); 2293a4af0ceeSJacob Faibussowitsch ierr = PetscDeviceContextBeginTimer_Internal(dctx);CHKERRQ(ierr); 2294a4af0ceeSJacob Faibussowitsch } else { 22959ffd0706SHong Zhang ierr = PetscTimeSubtract(&petsc_gtime);CHKERRQ(ierr); 2296a4af0ceeSJacob Faibussowitsch } 22979ffd0706SHong Zhang PetscFunctionReturn(0); 22989ffd0706SHong Zhang } 22999ffd0706SHong Zhang 23009ffd0706SHong Zhang /*@C 23019ffd0706SHong Zhang PetscLogGpuTimeEnd - Stop timer for device 23029ffd0706SHong Zhang 23039ffd0706SHong Zhang Level: intermediate 23049ffd0706SHong Zhang 23059ffd0706SHong Zhang .seealso: PetscLogView(), PetscLogGpuFlops(), PetscLogGpuTimeBegin() 23069ffd0706SHong Zhang @*/ 23079ffd0706SHong Zhang PetscErrorCode PetscLogGpuTimeEnd(void) 23089ffd0706SHong Zhang { 23099ffd0706SHong Zhang PetscErrorCode ierr; 2310a4af0ceeSJacob Faibussowitsch 23119ffd0706SHong Zhang PetscFunctionBegin; 23121e8be873SJed Brown if (!PetscLogPLE) PetscFunctionReturn(0); 2313a4af0ceeSJacob Faibussowitsch if (PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)) { 2314a4af0ceeSJacob Faibussowitsch PetscDeviceContext dctx; 2315a4af0ceeSJacob Faibussowitsch PetscLogDouble elapsed; 2316a4af0ceeSJacob Faibussowitsch 2317a4af0ceeSJacob Faibussowitsch ierr = PetscDeviceContextGetCurrentContext(&dctx);CHKERRQ(ierr); 2318a4af0ceeSJacob Faibussowitsch ierr = PetscDeviceContextEndTimer_Internal(dctx,&elapsed);CHKERRQ(ierr); 2319a4af0ceeSJacob Faibussowitsch petsc_gtime += (elapsed/1000.0); 2320a4af0ceeSJacob Faibussowitsch } else { 23219ffd0706SHong Zhang ierr = PetscTimeAdd(&petsc_gtime);CHKERRQ(ierr); 2322a4af0ceeSJacob Faibussowitsch } 23239ffd0706SHong Zhang PetscFunctionReturn(0); 23249ffd0706SHong Zhang } 23259ffd0706SHong Zhang #endif /* end of PETSC_HAVE_DEVICE */ 23269ffd0706SHong Zhang 23275c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */ 23285c6c1daeSBarry Smith 23295c6c1daeSBarry Smith PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 23305c6c1daeSBarry Smith { 23315c6c1daeSBarry Smith PetscFunctionBegin; 23325c6c1daeSBarry Smith PetscFunctionReturn(0); 23335c6c1daeSBarry Smith } 23345c6c1daeSBarry Smith 23355c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/ 23365c6c1daeSBarry Smith 23375c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 23385c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID = 0; 23395c6c1daeSBarry Smith 23405c6c1daeSBarry Smith /*@C 23415c6c1daeSBarry Smith PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code. 23425c6c1daeSBarry Smith 23435c6c1daeSBarry Smith Not Collective 23445c6c1daeSBarry Smith 23455c6c1daeSBarry Smith Input Parameter: 23465c6c1daeSBarry Smith . name - The class name 23475c6c1daeSBarry Smith 23485c6c1daeSBarry Smith Output Parameter: 23495c6c1daeSBarry Smith . oclass - The class id or classid 23505c6c1daeSBarry Smith 23515c6c1daeSBarry Smith Level: developer 23525c6c1daeSBarry Smith 23535c6c1daeSBarry Smith @*/ 23545c6c1daeSBarry Smith PetscErrorCode PetscClassIdRegister(const char name[],PetscClassId *oclass) 23555c6c1daeSBarry Smith { 23565c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 23575c6c1daeSBarry Smith PetscStageLog stageLog; 23585c6c1daeSBarry Smith PetscInt stage; 23595c6c1daeSBarry Smith PetscErrorCode ierr; 23605c6c1daeSBarry Smith #endif 23615c6c1daeSBarry Smith 23625c6c1daeSBarry Smith PetscFunctionBegin; 23635c6c1daeSBarry Smith *oclass = ++PETSC_LARGEST_CLASSID; 23645c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 23655c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 23665c6c1daeSBarry Smith ierr = PetscClassRegLogRegister(stageLog->classLog, name, *oclass);CHKERRQ(ierr); 23675c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 23683a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 23695c6c1daeSBarry Smith } 23705c6c1daeSBarry Smith #endif 23715c6c1daeSBarry Smith PetscFunctionReturn(0); 23725c6c1daeSBarry Smith } 2373210b5426SBarry Smith 2374210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE) 2375210b5426SBarry Smith #include <mpe.h> 2376210b5426SBarry Smith 2377210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE; 2378210b5426SBarry Smith 2379495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2380495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2381495fc317SBarry Smith 2382210b5426SBarry Smith /*@C 2383210b5426SBarry Smith PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files 2384210b5426SBarry Smith and slows the program down. 2385210b5426SBarry Smith 2386210b5426SBarry Smith Collective over PETSC_COMM_WORLD 2387210b5426SBarry Smith 2388210b5426SBarry Smith Options Database Keys: 2389a2553e36SBarry Smith . -log_mpe - Prints extensive log information 2390210b5426SBarry Smith 2391210b5426SBarry Smith Notes: 2392609bdbeeSBarry Smith A related routine is PetscLogDefaultBegin() (with the options key -log_view), which is 2393210b5426SBarry Smith intended for production runs since it logs only flop rates and object 2394210b5426SBarry Smith creation (and should not significantly slow the programs). 2395210b5426SBarry Smith 2396210b5426SBarry Smith Level: advanced 2397210b5426SBarry Smith 2398bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogEventActivate(), 2399210b5426SBarry Smith PetscLogEventDeactivate() 2400210b5426SBarry Smith @*/ 2401210b5426SBarry Smith PetscErrorCode PetscLogMPEBegin(void) 2402210b5426SBarry Smith { 2403210b5426SBarry Smith PetscErrorCode ierr; 2404210b5426SBarry Smith 2405210b5426SBarry Smith PetscFunctionBegin; 2406210b5426SBarry Smith /* Do MPE initialization */ 2407210b5426SBarry Smith if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */ 2408210b5426SBarry Smith ierr = PetscInfo(0,"Initializing MPE.\n");CHKERRQ(ierr); 2409210b5426SBarry Smith ierr = MPE_Init_log();CHKERRQ(ierr); 2410210b5426SBarry Smith 2411210b5426SBarry Smith PetscBeganMPE = PETSC_TRUE; 2412210b5426SBarry Smith } else { 2413210b5426SBarry Smith ierr = PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n");CHKERRQ(ierr); 2414210b5426SBarry Smith } 2415495fc317SBarry Smith ierr = PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE);CHKERRQ(ierr); 2416210b5426SBarry Smith PetscFunctionReturn(0); 2417210b5426SBarry Smith } 2418210b5426SBarry Smith 2419210b5426SBarry Smith /*@C 2420495fc317SBarry Smith PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot. 2421210b5426SBarry Smith 2422210b5426SBarry Smith Collective over PETSC_COMM_WORLD 2423210b5426SBarry Smith 2424210b5426SBarry Smith Level: advanced 2425210b5426SBarry Smith 2426210b5426SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogMPEBegin() 2427210b5426SBarry Smith @*/ 2428210b5426SBarry Smith PetscErrorCode PetscLogMPEDump(const char sname[]) 2429210b5426SBarry Smith { 2430210b5426SBarry Smith char name[PETSC_MAX_PATH_LEN]; 2431210b5426SBarry Smith PetscErrorCode ierr; 2432210b5426SBarry Smith 2433210b5426SBarry Smith PetscFunctionBegin; 2434210b5426SBarry Smith if (PetscBeganMPE) { 2435210b5426SBarry Smith ierr = PetscInfo(0,"Finalizing MPE.\n");CHKERRQ(ierr); 2436210b5426SBarry Smith if (sname) { 2437210b5426SBarry Smith ierr = PetscStrcpy(name,sname);CHKERRQ(ierr); 2438210b5426SBarry Smith } else { 2439589a23caSBarry Smith ierr = PetscGetProgramName(name,sizeof(name));CHKERRQ(ierr); 2440210b5426SBarry Smith } 2441210b5426SBarry Smith ierr = MPE_Finish_log(name);CHKERRQ(ierr); 2442210b5426SBarry Smith } else { 2443210b5426SBarry Smith ierr = PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n");CHKERRQ(ierr); 2444210b5426SBarry Smith } 2445210b5426SBarry Smith PetscFunctionReturn(0); 2446210b5426SBarry Smith } 2447210b5426SBarry Smith 2448210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39 2449210b5426SBarry Smith static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = { 2450210b5426SBarry Smith "OliveDrab: ", 2451210b5426SBarry Smith "BlueViolet: ", 2452210b5426SBarry Smith "CadetBlue: ", 2453210b5426SBarry Smith "CornflowerBlue: ", 2454210b5426SBarry Smith "DarkGoldenrod: ", 2455210b5426SBarry Smith "DarkGreen: ", 2456210b5426SBarry Smith "DarkKhaki: ", 2457210b5426SBarry Smith "DarkOliveGreen: ", 2458210b5426SBarry Smith "DarkOrange: ", 2459210b5426SBarry Smith "DarkOrchid: ", 2460210b5426SBarry Smith "DarkSeaGreen: ", 2461210b5426SBarry Smith "DarkSlateGray: ", 2462210b5426SBarry Smith "DarkTurquoise: ", 2463210b5426SBarry Smith "DeepPink: ", 2464210b5426SBarry Smith "DarkKhaki: ", 2465210b5426SBarry Smith "DimGray: ", 2466210b5426SBarry Smith "DodgerBlue: ", 2467210b5426SBarry Smith "GreenYellow: ", 2468210b5426SBarry Smith "HotPink: ", 2469210b5426SBarry Smith "IndianRed: ", 2470210b5426SBarry Smith "LavenderBlush: ", 2471210b5426SBarry Smith "LawnGreen: ", 2472210b5426SBarry Smith "LemonChiffon: ", 2473210b5426SBarry Smith "LightCoral: ", 2474210b5426SBarry Smith "LightCyan: ", 2475210b5426SBarry Smith "LightPink: ", 2476210b5426SBarry Smith "LightSalmon: ", 2477210b5426SBarry Smith "LightSlateGray: ", 2478210b5426SBarry Smith "LightYellow: ", 2479210b5426SBarry Smith "LimeGreen: ", 2480210b5426SBarry Smith "MediumPurple: ", 2481210b5426SBarry Smith "MediumSeaGreen: ", 2482210b5426SBarry Smith "MediumSlateBlue:", 2483210b5426SBarry Smith "MidnightBlue: ", 2484210b5426SBarry Smith "MintCream: ", 2485210b5426SBarry Smith "MistyRose: ", 2486210b5426SBarry Smith "NavajoWhite: ", 2487210b5426SBarry Smith "NavyBlue: ", 2488210b5426SBarry Smith "OliveDrab: " 2489210b5426SBarry Smith }; 2490210b5426SBarry Smith 2491210b5426SBarry Smith /*@C 2492210b5426SBarry Smith PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister() 2493210b5426SBarry Smith 2494210b5426SBarry Smith Not collective. Maybe it should be? 2495210b5426SBarry Smith 24967a7aea1fSJed Brown Output Parameter: 2497210b5426SBarry Smith . str - character string representing the color 2498210b5426SBarry Smith 2499210b5426SBarry Smith Level: developer 2500210b5426SBarry Smith 2501210b5426SBarry Smith .seealso: PetscLogEventRegister 2502210b5426SBarry Smith @*/ 2503210b5426SBarry Smith PetscErrorCode PetscLogMPEGetRGBColor(const char *str[]) 2504210b5426SBarry Smith { 2505210b5426SBarry Smith static int idx = 0; 2506210b5426SBarry Smith 2507210b5426SBarry Smith PetscFunctionBegin; 2508210b5426SBarry Smith *str = PetscLogMPERGBColors[idx]; 2509210b5426SBarry Smith idx = (idx + 1)% PETSC_RGB_COLORS_MAX; 2510210b5426SBarry Smith PetscFunctionReturn(0); 2511210b5426SBarry Smith } 2512210b5426SBarry Smith 2513210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */ 2514