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 */ 83*bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 84*bec0b493Shannah_mairs PetscLogDouble petsc_ctog_ct = 0.0; /* The total number of CPU to GPU copies */ 85*bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_ct = 0.0; /* The total number of GPU to CPU copies */ 86*bec0b493Shannah_mairs PetscLogDouble petsc_ctog_sz = 0.0; /* The total size of CPU to GPU copies */ 87*bec0b493Shannah_mairs PetscLogDouble petsc_gtoc_sz = 0.0; /* The total size of GPU to CPU copies */ 88*bec0b493Shannah_mairs #endif 895c6c1daeSBarry Smith 905c6c1daeSBarry Smith /* Logging functions */ 910298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL; 920298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL; 930298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 940298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 955c6c1daeSBarry Smith 965c6c1daeSBarry Smith /* Tracing event logging variables */ 970298fd71SBarry Smith FILE *petsc_tracefile = NULL; 985c6c1daeSBarry Smith int petsc_tracelevel = 0; 995c6c1daeSBarry Smith const char *petsc_traceblanks = " "; 1005c6c1daeSBarry Smith char petsc_tracespace[128] = " "; 1015c6c1daeSBarry Smith PetscLogDouble petsc_tracetime = 0.0; 102896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE; 1035c6c1daeSBarry Smith 10495c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogInitialize(void) 105fa2bb9feSLisandro Dalcin { 106fa2bb9feSLisandro Dalcin int stage; 107fa2bb9feSLisandro Dalcin PetscBool opt; 108fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 1095c6c1daeSBarry Smith 110fa2bb9feSLisandro Dalcin PetscFunctionBegin; 111fa2bb9feSLisandro Dalcin if (PetscLogInitializeCalled) PetscFunctionReturn(0); 112fa2bb9feSLisandro Dalcin PetscLogInitializeCalled = PETSC_TRUE; 1135c6c1daeSBarry Smith 114fa2bb9feSLisandro Dalcin ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_actions", &opt);CHKERRQ(ierr); 115fa2bb9feSLisandro Dalcin if (opt) petsc_logActions = PETSC_FALSE; 116fa2bb9feSLisandro Dalcin ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_objects", &opt);CHKERRQ(ierr); 117fa2bb9feSLisandro Dalcin if (opt) petsc_logObjects = PETSC_FALSE; 118fa2bb9feSLisandro Dalcin if (petsc_logActions) { 119fa2bb9feSLisandro Dalcin ierr = PetscMalloc1(petsc_maxActions, &petsc_actions);CHKERRQ(ierr); 120fa2bb9feSLisandro Dalcin } 121fa2bb9feSLisandro Dalcin if (petsc_logObjects) { 122fa2bb9feSLisandro Dalcin ierr = PetscMalloc1(petsc_maxObjects, &petsc_objects);CHKERRQ(ierr); 123fa2bb9feSLisandro Dalcin } 124fa2bb9feSLisandro Dalcin PetscLogPHC = PetscLogObjCreateDefault; 125fa2bb9feSLisandro Dalcin PetscLogPHD = PetscLogObjDestroyDefault; 126fa2bb9feSLisandro Dalcin /* Setup default logging structures */ 127fa2bb9feSLisandro Dalcin ierr = PetscStageLogCreate(&petsc_stageLog);CHKERRQ(ierr); 128fa2bb9feSLisandro Dalcin ierr = PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage);CHKERRQ(ierr); 1295c6c1daeSBarry Smith 130fa2bb9feSLisandro Dalcin /* All processors sync here for more consistent logging */ 131fa2bb9feSLisandro Dalcin ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr); 132fa2bb9feSLisandro Dalcin PetscTime(&petsc_BaseTime); 133fa2bb9feSLisandro Dalcin ierr = PetscLogStagePush(stage);CHKERRQ(ierr); 134fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 135fa2bb9feSLisandro Dalcin } 1365c6c1daeSBarry Smith 13795c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogFinalize(void) 1385c6c1daeSBarry Smith { 1395c6c1daeSBarry Smith PetscStageLog stageLog; 1405c6c1daeSBarry Smith PetscErrorCode ierr; 1415c6c1daeSBarry Smith 1425c6c1daeSBarry Smith PetscFunctionBegin; 1435c6c1daeSBarry Smith ierr = PetscFree(petsc_actions);CHKERRQ(ierr); 1445c6c1daeSBarry Smith ierr = PetscFree(petsc_objects);CHKERRQ(ierr); 145eccbb886SLisandro Dalcin ierr = PetscLogNestedEnd();CHKERRQ(ierr); 1460298fd71SBarry Smith ierr = PetscLogSet(NULL, NULL);CHKERRQ(ierr); 1475c6c1daeSBarry Smith 1485c6c1daeSBarry Smith /* Resetting phase */ 1495c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1505c6c1daeSBarry Smith ierr = PetscStageLogDestroy(stageLog);CHKERRQ(ierr); 151a297a907SKarl Rupp 1525c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1535c6c1daeSBarry Smith petsc_numActions = 0; 1545c6c1daeSBarry Smith petsc_numObjects = 0; 1555c6c1daeSBarry Smith petsc_numObjectsDestroyed = 0; 1565c6c1daeSBarry Smith petsc_maxActions = 100; 1575c6c1daeSBarry Smith petsc_maxObjects = 100; 1580298fd71SBarry Smith petsc_actions = NULL; 1590298fd71SBarry Smith petsc_objects = NULL; 1605c6c1daeSBarry Smith petsc_logActions = PETSC_FALSE; 1615c6c1daeSBarry Smith petsc_logObjects = PETSC_FALSE; 1625c6c1daeSBarry Smith petsc_BaseTime = 0.0; 1635c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1645c6c1daeSBarry Smith petsc_tmp_flops = 0.0; 1655c6c1daeSBarry Smith petsc_send_ct = 0.0; 1665c6c1daeSBarry Smith petsc_recv_ct = 0.0; 1675c6c1daeSBarry Smith petsc_send_len = 0.0; 1685c6c1daeSBarry Smith petsc_recv_len = 0.0; 1695c6c1daeSBarry Smith petsc_isend_ct = 0.0; 1705c6c1daeSBarry Smith petsc_irecv_ct = 0.0; 1715c6c1daeSBarry Smith petsc_isend_len = 0.0; 1725c6c1daeSBarry Smith petsc_irecv_len = 0.0; 1735c6c1daeSBarry Smith petsc_wait_ct = 0.0; 1745c6c1daeSBarry Smith petsc_wait_any_ct = 0.0; 1755c6c1daeSBarry Smith petsc_wait_all_ct = 0.0; 1765c6c1daeSBarry Smith petsc_sum_of_waits_ct = 0.0; 1775c6c1daeSBarry Smith petsc_allreduce_ct = 0.0; 1785c6c1daeSBarry Smith petsc_gather_ct = 0.0; 1795c6c1daeSBarry Smith petsc_scatter_ct = 0.0; 180*bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 181*bec0b493Shannah_mairs petsc_ctog_ct = 0.0; 182*bec0b493Shannah_mairs petsc_gtoc_ct = 0.0; 183*bec0b493Shannah_mairs petsc_ctog_sz = 0.0; 184*bec0b493Shannah_mairs petsc_gtoc_sz = 0.0; 185*bec0b493Shannah_mairs #endif 1865c6c1daeSBarry Smith PETSC_LARGEST_EVENT = PETSC_EVENT; 1870298fd71SBarry Smith PetscLogPHC = NULL; 1880298fd71SBarry Smith PetscLogPHD = NULL; 1890298fd71SBarry Smith petsc_tracefile = NULL; 1905c6c1daeSBarry Smith petsc_tracelevel = 0; 1915c6c1daeSBarry Smith petsc_traceblanks = " "; 1925c6c1daeSBarry Smith petsc_tracespace[0] = ' '; petsc_tracespace[1] = 0; 1935c6c1daeSBarry Smith petsc_tracetime = 0.0; 1945c6c1daeSBarry Smith PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 1955c6c1daeSBarry Smith PETSC_OBJECT_CLASSID = 0; 1965c6c1daeSBarry Smith petsc_stageLog = 0; 197896238b9SBarry Smith PetscLogInitializeCalled = PETSC_FALSE; 1985c6c1daeSBarry Smith PetscFunctionReturn(0); 1995c6c1daeSBarry Smith } 2005c6c1daeSBarry Smith 2015c6c1daeSBarry Smith /*@C 2025c6c1daeSBarry Smith PetscLogSet - Sets the logging functions called at the beginning and ending of every event. 2035c6c1daeSBarry Smith 2045c6c1daeSBarry Smith Not Collective 2055c6c1daeSBarry Smith 2065c6c1daeSBarry Smith Input Parameters: 2075c6c1daeSBarry Smith + b - The function called at beginning of event 2085c6c1daeSBarry Smith - e - The function called at end of event 2095c6c1daeSBarry Smith 2105c6c1daeSBarry Smith Level: developer 2115c6c1daeSBarry Smith 212bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogTraceBegin() 2135c6c1daeSBarry Smith @*/ 2145c6c1daeSBarry Smith PetscErrorCode PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), 2155c6c1daeSBarry Smith PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject)) 2165c6c1daeSBarry Smith { 2175c6c1daeSBarry Smith PetscFunctionBegin; 2185c6c1daeSBarry Smith PetscLogPLB = b; 2195c6c1daeSBarry Smith PetscLogPLE = e; 2205c6c1daeSBarry Smith PetscFunctionReturn(0); 2215c6c1daeSBarry Smith } 2225c6c1daeSBarry Smith 2235c6c1daeSBarry Smith /*@C 224bb1d7374SBarry Smith PetscLogDefaultBegin - Turns on logging of objects and events. This logs flop 2255c6c1daeSBarry Smith rates and object creation and should not slow programs down too much. 2265c6c1daeSBarry Smith This routine may be called more than once. 2275c6c1daeSBarry Smith 2285c6c1daeSBarry Smith Logically Collective over PETSC_COMM_WORLD 2295c6c1daeSBarry Smith 2305c6c1daeSBarry Smith Options Database Keys: 231a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the 232a2553e36SBarry Smith screen (for code configured with --with-log=1 (which is the default)) 2335c6c1daeSBarry Smith 2345c6c1daeSBarry Smith Usage: 2355c6c1daeSBarry Smith .vb 2365c6c1daeSBarry Smith PetscInitialize(...); 237bb1d7374SBarry Smith PetscLogDefaultBegin(); 2385c6c1daeSBarry Smith ... code ... 2395c6c1daeSBarry Smith PetscLogView(viewer); or PetscLogDump(); 2405c6c1daeSBarry Smith PetscFinalize(); 2415c6c1daeSBarry Smith .ve 2425c6c1daeSBarry Smith 2435c6c1daeSBarry Smith Notes: 2445c6c1daeSBarry Smith PetscLogView(viewer) or PetscLogDump() actually cause the printing of 2455c6c1daeSBarry Smith the logging information. 2465c6c1daeSBarry Smith 2475c6c1daeSBarry Smith Level: advanced 2485c6c1daeSBarry Smith 2495c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogTraceBegin() 2505c6c1daeSBarry Smith @*/ 251bb1d7374SBarry Smith PetscErrorCode PetscLogDefaultBegin(void) 2525c6c1daeSBarry Smith { 2535c6c1daeSBarry Smith PetscErrorCode ierr; 2545c6c1daeSBarry Smith 2555c6c1daeSBarry Smith PetscFunctionBegin; 2565c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault);CHKERRQ(ierr); 2575c6c1daeSBarry Smith PetscFunctionReturn(0); 2585c6c1daeSBarry Smith } 2595c6c1daeSBarry Smith 2605c6c1daeSBarry Smith /*@C 2615c6c1daeSBarry Smith PetscLogAllBegin - Turns on extensive logging of objects and events. Logs 2625c6c1daeSBarry Smith all events. This creates large log files and slows the program down. 2635c6c1daeSBarry Smith 2645c6c1daeSBarry Smith Logically Collective on PETSC_COMM_WORLD 2655c6c1daeSBarry Smith 2665c6c1daeSBarry Smith Options Database Keys: 267a2553e36SBarry Smith . -log_all - Prints extensive log information 2685c6c1daeSBarry Smith 2695c6c1daeSBarry Smith Usage: 2705c6c1daeSBarry Smith .vb 2715c6c1daeSBarry Smith PetscInitialize(...); 2725c6c1daeSBarry Smith PetscLogAllBegin(); 2735c6c1daeSBarry Smith ... code ... 2745c6c1daeSBarry Smith PetscLogDump(filename); 2755c6c1daeSBarry Smith PetscFinalize(); 2765c6c1daeSBarry Smith .ve 2775c6c1daeSBarry Smith 2785c6c1daeSBarry Smith Notes: 279bb1d7374SBarry Smith A related routine is PetscLogDefaultBegin() (with the options key -log), which is 2805c6c1daeSBarry Smith intended for production runs since it logs only flop rates and object 2815c6c1daeSBarry Smith creation (and shouldn't significantly slow the programs). 2825c6c1daeSBarry Smith 2835c6c1daeSBarry Smith Level: advanced 2845c6c1daeSBarry Smith 285bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogTraceBegin() 2865c6c1daeSBarry Smith @*/ 2875c6c1daeSBarry Smith PetscErrorCode PetscLogAllBegin(void) 2885c6c1daeSBarry Smith { 2895c6c1daeSBarry Smith PetscErrorCode ierr; 2905c6c1daeSBarry Smith 2915c6c1daeSBarry Smith PetscFunctionBegin; 2925c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete);CHKERRQ(ierr); 2935c6c1daeSBarry Smith PetscFunctionReturn(0); 2945c6c1daeSBarry Smith } 2955c6c1daeSBarry Smith 2965c6c1daeSBarry Smith /*@ 2975c6c1daeSBarry Smith PetscLogTraceBegin - Activates trace logging. Every time a PETSc event 2985c6c1daeSBarry Smith begins or ends, the event name is printed. 2995c6c1daeSBarry Smith 3005c6c1daeSBarry Smith Logically Collective on PETSC_COMM_WORLD 3015c6c1daeSBarry Smith 3025c6c1daeSBarry Smith Input Parameter: 3035c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout) 3045c6c1daeSBarry Smith 3055c6c1daeSBarry Smith Options Database Key: 3065c6c1daeSBarry Smith . -log_trace [filename] - Activates PetscLogTraceBegin() 3075c6c1daeSBarry Smith 3085c6c1daeSBarry Smith Notes: 3095c6c1daeSBarry Smith PetscLogTraceBegin() prints the processor number, the execution time (sec), 3105c6c1daeSBarry Smith then "Event begin:" or "Event end:" followed by the event name. 3115c6c1daeSBarry Smith 3125c6c1daeSBarry Smith PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful 3135c6c1daeSBarry Smith to determine where a program is hanging without running in the 3145c6c1daeSBarry Smith debugger. Can be used in conjunction with the -info option. 3155c6c1daeSBarry Smith 3165c6c1daeSBarry Smith Level: intermediate 3175c6c1daeSBarry Smith 318bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogDefaultBegin() 3195c6c1daeSBarry Smith @*/ 3205c6c1daeSBarry Smith PetscErrorCode PetscLogTraceBegin(FILE *file) 3215c6c1daeSBarry Smith { 3225c6c1daeSBarry Smith PetscErrorCode ierr; 3235c6c1daeSBarry Smith 3245c6c1daeSBarry Smith PetscFunctionBegin; 3255c6c1daeSBarry Smith petsc_tracefile = file; 326a297a907SKarl Rupp 3275c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace);CHKERRQ(ierr); 3285c6c1daeSBarry Smith PetscFunctionReturn(0); 3295c6c1daeSBarry Smith } 3305c6c1daeSBarry Smith 3315c6c1daeSBarry Smith /*@ 3325c6c1daeSBarry Smith PetscLogActions - Determines whether actions are logged for the graphical viewer. 3335c6c1daeSBarry Smith 3345c6c1daeSBarry Smith Not Collective 3355c6c1daeSBarry Smith 3365c6c1daeSBarry Smith Input Parameter: 3375c6c1daeSBarry Smith . flag - PETSC_TRUE if actions are to be logged 3385c6c1daeSBarry Smith 3395c6c1daeSBarry Smith Level: intermediate 3405c6c1daeSBarry Smith 3415c6c1daeSBarry Smith Note: Logging of actions continues to consume more memory as the program 3425c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3435c6c1daeSBarry Smith 3445c6c1daeSBarry Smith Options Database Keys: 3455c6c1daeSBarry Smith . -log_exclude_actions - Turns off actions logging 3465c6c1daeSBarry Smith 3475c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 3485c6c1daeSBarry Smith @*/ 3495c6c1daeSBarry Smith PetscErrorCode PetscLogActions(PetscBool flag) 3505c6c1daeSBarry Smith { 3515c6c1daeSBarry Smith PetscFunctionBegin; 3525c6c1daeSBarry Smith petsc_logActions = flag; 3535c6c1daeSBarry Smith PetscFunctionReturn(0); 3545c6c1daeSBarry Smith } 3555c6c1daeSBarry Smith 3565c6c1daeSBarry Smith /*@ 3575c6c1daeSBarry Smith PetscLogObjects - Determines whether objects are logged for the graphical viewer. 3585c6c1daeSBarry Smith 3595c6c1daeSBarry Smith Not Collective 3605c6c1daeSBarry Smith 3615c6c1daeSBarry Smith Input Parameter: 3625c6c1daeSBarry Smith . flag - PETSC_TRUE if objects are to be logged 3635c6c1daeSBarry Smith 3645c6c1daeSBarry Smith Level: intermediate 3655c6c1daeSBarry Smith 3665c6c1daeSBarry Smith Note: Logging of objects continues to consume more memory as the program 3675c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3685c6c1daeSBarry Smith 3695c6c1daeSBarry Smith Options Database Keys: 3705c6c1daeSBarry Smith . -log_exclude_objects - Turns off objects logging 3715c6c1daeSBarry Smith 3725c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 3735c6c1daeSBarry Smith @*/ 3745c6c1daeSBarry Smith PetscErrorCode PetscLogObjects(PetscBool flag) 3755c6c1daeSBarry Smith { 3765c6c1daeSBarry Smith PetscFunctionBegin; 3775c6c1daeSBarry Smith petsc_logObjects = flag; 3785c6c1daeSBarry Smith PetscFunctionReturn(0); 3795c6c1daeSBarry Smith } 3805c6c1daeSBarry Smith 3815c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/ 3825c6c1daeSBarry Smith /*@C 38374c0405dSRichard Tran Mills PetscLogStageRegister - Attaches a character string name to a logging stage. 3845c6c1daeSBarry Smith 3855c6c1daeSBarry Smith Not Collective 3865c6c1daeSBarry Smith 3875c6c1daeSBarry Smith Input Parameter: 3885c6c1daeSBarry Smith . sname - The name to associate with that stage 3895c6c1daeSBarry Smith 3905c6c1daeSBarry Smith Output Parameter: 3915c6c1daeSBarry Smith . stage - The stage number 3925c6c1daeSBarry Smith 3935c6c1daeSBarry Smith Level: intermediate 3945c6c1daeSBarry Smith 3955c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 3965c6c1daeSBarry Smith @*/ 3975c6c1daeSBarry Smith PetscErrorCode PetscLogStageRegister(const char sname[],PetscLogStage *stage) 3985c6c1daeSBarry Smith { 3995c6c1daeSBarry Smith PetscStageLog stageLog; 4005c6c1daeSBarry Smith PetscLogEvent event; 4015c6c1daeSBarry Smith PetscErrorCode ierr; 4025c6c1daeSBarry Smith 4035c6c1daeSBarry Smith PetscFunctionBegin; 4045c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 4055c6c1daeSBarry Smith ierr = PetscStageLogRegister(stageLog, sname, stage);CHKERRQ(ierr); 4065c6c1daeSBarry Smith /* Copy events already changed in the main stage, this sucks */ 4073a88037aSBarry Smith ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr); 4085c6c1daeSBarry Smith for (event = 0; event < stageLog->eventLog->numEvents; event++) { 4093a88037aSBarry Smith ierr = PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event],&stageLog->stageInfo[*stage].eventLog->eventInfo[event]);CHKERRQ(ierr); 4105c6c1daeSBarry Smith } 4113a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 4125c6c1daeSBarry Smith PetscFunctionReturn(0); 4135c6c1daeSBarry Smith } 4145c6c1daeSBarry Smith 4155c6c1daeSBarry Smith /*@C 4165c6c1daeSBarry Smith PetscLogStagePush - This function pushes a stage on the stack. 4175c6c1daeSBarry Smith 4185c6c1daeSBarry Smith Not Collective 4195c6c1daeSBarry Smith 4205c6c1daeSBarry Smith Input Parameter: 4215c6c1daeSBarry Smith . stage - The stage on which to log 4225c6c1daeSBarry Smith 4235c6c1daeSBarry Smith Usage: 4245c6c1daeSBarry Smith If the option -log_sumary is used to run the program containing the 4255c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4265c6c1daeSBarry Smith PetscFinalize(). 4275c6c1daeSBarry Smith .vb 4285c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4295c6c1daeSBarry Smith [stage 0 of code] 4305c6c1daeSBarry Smith PetscLogStagePush(1); 4315c6c1daeSBarry Smith [stage 1 of code] 4325c6c1daeSBarry Smith PetscLogStagePop(); 4335c6c1daeSBarry Smith PetscBarrier(...); 4345c6c1daeSBarry Smith [more stage 0 of code] 4355c6c1daeSBarry Smith PetscFinalize(); 4365c6c1daeSBarry Smith .ve 4375c6c1daeSBarry Smith 4385c6c1daeSBarry Smith Notes: 4395c6c1daeSBarry Smith Use PetscLogStageRegister() to register a stage. 4405c6c1daeSBarry Smith 4415c6c1daeSBarry Smith Level: intermediate 4425c6c1daeSBarry Smith 4435c6c1daeSBarry Smith .seealso: PetscLogStagePop(), PetscLogStageRegister(), PetscBarrier() 4445c6c1daeSBarry Smith @*/ 4455c6c1daeSBarry Smith PetscErrorCode PetscLogStagePush(PetscLogStage stage) 4465c6c1daeSBarry Smith { 4475c6c1daeSBarry Smith PetscStageLog stageLog; 4485c6c1daeSBarry Smith PetscErrorCode ierr; 4495c6c1daeSBarry Smith 4505c6c1daeSBarry Smith PetscFunctionBegin; 4515c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 4525c6c1daeSBarry Smith ierr = PetscStageLogPush(stageLog, stage);CHKERRQ(ierr); 4535c6c1daeSBarry Smith PetscFunctionReturn(0); 4545c6c1daeSBarry Smith } 4555c6c1daeSBarry Smith 4565c6c1daeSBarry Smith /*@C 4575c6c1daeSBarry Smith PetscLogStagePop - This function pops a stage from the stack. 4585c6c1daeSBarry Smith 4595c6c1daeSBarry Smith Not Collective 4605c6c1daeSBarry Smith 4615c6c1daeSBarry Smith Usage: 4625c6c1daeSBarry Smith If the option -log_sumary is used to run the program containing the 4635c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4645c6c1daeSBarry Smith PetscFinalize(). 4655c6c1daeSBarry Smith .vb 4665c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4675c6c1daeSBarry Smith [stage 0 of code] 4685c6c1daeSBarry Smith PetscLogStagePush(1); 4695c6c1daeSBarry Smith [stage 1 of code] 4705c6c1daeSBarry Smith PetscLogStagePop(); 4715c6c1daeSBarry Smith PetscBarrier(...); 4725c6c1daeSBarry Smith [more stage 0 of code] 4735c6c1daeSBarry Smith PetscFinalize(); 4745c6c1daeSBarry Smith .ve 4755c6c1daeSBarry Smith 4765c6c1daeSBarry Smith Notes: 4775c6c1daeSBarry Smith Use PetscLogStageRegister() to register a stage. 4785c6c1daeSBarry Smith 4795c6c1daeSBarry Smith Level: intermediate 4805c6c1daeSBarry Smith 4815c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStageRegister(), PetscBarrier() 4825c6c1daeSBarry Smith @*/ 4835c6c1daeSBarry Smith PetscErrorCode PetscLogStagePop(void) 4845c6c1daeSBarry Smith { 4855c6c1daeSBarry Smith PetscStageLog stageLog; 4865c6c1daeSBarry Smith PetscErrorCode ierr; 4875c6c1daeSBarry Smith 4885c6c1daeSBarry Smith PetscFunctionBegin; 4895c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 4905c6c1daeSBarry Smith ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 4915c6c1daeSBarry Smith PetscFunctionReturn(0); 4925c6c1daeSBarry Smith } 4935c6c1daeSBarry Smith 4945c6c1daeSBarry Smith /*@ 4955c6c1daeSBarry Smith PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 4965c6c1daeSBarry Smith 4975c6c1daeSBarry Smith Not Collective 4985c6c1daeSBarry Smith 4995c6c1daeSBarry Smith Input Parameters: 5005c6c1daeSBarry Smith + stage - The stage 5015c6c1daeSBarry Smith - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 5025c6c1daeSBarry Smith 5035c6c1daeSBarry Smith Level: intermediate 5045c6c1daeSBarry Smith 5055c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 5065c6c1daeSBarry Smith @*/ 5075c6c1daeSBarry Smith PetscErrorCode PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive) 5085c6c1daeSBarry Smith { 5095c6c1daeSBarry Smith PetscStageLog stageLog; 5105c6c1daeSBarry Smith PetscErrorCode ierr; 5115c6c1daeSBarry Smith 5125c6c1daeSBarry Smith PetscFunctionBegin; 5135c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5145c6c1daeSBarry Smith ierr = PetscStageLogSetActive(stageLog, stage, isActive);CHKERRQ(ierr); 5155c6c1daeSBarry Smith PetscFunctionReturn(0); 5165c6c1daeSBarry Smith } 5175c6c1daeSBarry Smith 5185c6c1daeSBarry Smith /*@ 5195c6c1daeSBarry Smith PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 5205c6c1daeSBarry Smith 5215c6c1daeSBarry Smith Not Collective 5225c6c1daeSBarry Smith 5235c6c1daeSBarry Smith Input Parameter: 5245c6c1daeSBarry Smith . stage - The stage 5255c6c1daeSBarry Smith 5265c6c1daeSBarry Smith Output Parameter: 5275c6c1daeSBarry Smith . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 5285c6c1daeSBarry Smith 5295c6c1daeSBarry Smith Level: intermediate 5305c6c1daeSBarry Smith 5315c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 5325c6c1daeSBarry Smith @*/ 5335c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetActive(PetscLogStage stage, PetscBool *isActive) 5345c6c1daeSBarry Smith { 5355c6c1daeSBarry Smith PetscStageLog stageLog; 5365c6c1daeSBarry Smith PetscErrorCode ierr; 5375c6c1daeSBarry Smith 5385c6c1daeSBarry Smith PetscFunctionBegin; 5395c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5405c6c1daeSBarry Smith ierr = PetscStageLogGetActive(stageLog, stage, isActive);CHKERRQ(ierr); 5415c6c1daeSBarry Smith PetscFunctionReturn(0); 5425c6c1daeSBarry Smith } 5435c6c1daeSBarry Smith 5445c6c1daeSBarry Smith /*@ 5455c6c1daeSBarry Smith PetscLogStageSetVisible - Determines stage visibility in PetscLogView() 5465c6c1daeSBarry Smith 5475c6c1daeSBarry Smith Not Collective 5485c6c1daeSBarry Smith 5495c6c1daeSBarry Smith Input Parameters: 5505c6c1daeSBarry Smith + stage - The stage 5515c6c1daeSBarry Smith - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 5525c6c1daeSBarry Smith 5535c6c1daeSBarry Smith Level: intermediate 5545c6c1daeSBarry Smith 5555c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView() 5565c6c1daeSBarry Smith @*/ 5575c6c1daeSBarry Smith PetscErrorCode PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible) 5585c6c1daeSBarry Smith { 5595c6c1daeSBarry Smith PetscStageLog stageLog; 5605c6c1daeSBarry Smith PetscErrorCode ierr; 5615c6c1daeSBarry Smith 5625c6c1daeSBarry Smith PetscFunctionBegin; 5635c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5645c6c1daeSBarry Smith ierr = PetscStageLogSetVisible(stageLog, stage, isVisible);CHKERRQ(ierr); 5655c6c1daeSBarry Smith PetscFunctionReturn(0); 5665c6c1daeSBarry Smith } 5675c6c1daeSBarry Smith 5685c6c1daeSBarry Smith /*@ 5695c6c1daeSBarry Smith PetscLogStageGetVisible - Returns stage visibility in PetscLogView() 5705c6c1daeSBarry Smith 5715c6c1daeSBarry Smith Not Collective 5725c6c1daeSBarry Smith 5735c6c1daeSBarry Smith Input Parameter: 5745c6c1daeSBarry Smith . stage - The stage 5755c6c1daeSBarry Smith 5765c6c1daeSBarry Smith Output Parameter: 5775c6c1daeSBarry Smith . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 5785c6c1daeSBarry Smith 5795c6c1daeSBarry Smith Level: intermediate 5805c6c1daeSBarry Smith 5815c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView() 5825c6c1daeSBarry Smith @*/ 5835c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetVisible(PetscLogStage stage, PetscBool *isVisible) 5845c6c1daeSBarry Smith { 5855c6c1daeSBarry Smith PetscStageLog stageLog; 5865c6c1daeSBarry Smith PetscErrorCode ierr; 5875c6c1daeSBarry Smith 5885c6c1daeSBarry Smith PetscFunctionBegin; 5895c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5905c6c1daeSBarry Smith ierr = PetscStageLogGetVisible(stageLog, stage, isVisible);CHKERRQ(ierr); 5915c6c1daeSBarry Smith PetscFunctionReturn(0); 5925c6c1daeSBarry Smith } 5935c6c1daeSBarry Smith 5945c6c1daeSBarry Smith /*@C 5955c6c1daeSBarry Smith PetscLogStageGetId - Returns the stage id when given the stage name. 5965c6c1daeSBarry Smith 5975c6c1daeSBarry Smith Not Collective 5985c6c1daeSBarry Smith 5995c6c1daeSBarry Smith Input Parameter: 6005c6c1daeSBarry Smith . name - The stage name 6015c6c1daeSBarry Smith 6025c6c1daeSBarry Smith Output Parameter: 6035a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists 6045c6c1daeSBarry Smith 6055c6c1daeSBarry Smith Level: intermediate 6065c6c1daeSBarry Smith 6075c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 6085c6c1daeSBarry Smith @*/ 6095c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetId(const char name[], PetscLogStage *stage) 6105c6c1daeSBarry Smith { 6115c6c1daeSBarry Smith PetscStageLog stageLog; 6125c6c1daeSBarry Smith PetscErrorCode ierr; 6135c6c1daeSBarry Smith 6145c6c1daeSBarry Smith PetscFunctionBegin; 6155c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 6165c6c1daeSBarry Smith ierr = PetscStageLogGetStage(stageLog, name, stage);CHKERRQ(ierr); 6175c6c1daeSBarry Smith PetscFunctionReturn(0); 6185c6c1daeSBarry Smith } 6195c6c1daeSBarry Smith 6205c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/ 6215c6c1daeSBarry Smith /*@C 6225c6c1daeSBarry Smith PetscLogEventRegister - Registers an event name for logging operations in an application code. 6235c6c1daeSBarry Smith 6245c6c1daeSBarry Smith Not Collective 6255c6c1daeSBarry Smith 6265c6c1daeSBarry Smith Input Parameter: 6275c6c1daeSBarry Smith + name - The name associated with the event 6285c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with 6295c6c1daeSBarry Smith PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones 6305c6c1daeSBarry Smith are only available in C code 6315c6c1daeSBarry Smith 6325c6c1daeSBarry Smith Output Parameter: 6335c6c1daeSBarry Smith . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd(). 6345c6c1daeSBarry Smith 6355c6c1daeSBarry Smith Example of Usage: 6365c6c1daeSBarry Smith .vb 6375c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 6385c6c1daeSBarry Smith PetscClassId classid; 6395c6c1daeSBarry Smith PetscLogDouble user_event_flops; 6405c6c1daeSBarry Smith PetscClassIdRegister("class name",&classid); 6415c6c1daeSBarry Smith PetscLogEventRegister("User event name",classid,&USER_EVENT); 6425c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 6435c6c1daeSBarry Smith [code segment to monitor] 6445c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 6455c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 6465c6c1daeSBarry Smith .ve 6475c6c1daeSBarry Smith 6485c6c1daeSBarry Smith Notes: 6495c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 650a2553e36SBarry Smith configured with --with-log (which is the default) and 651a2553e36SBarry Smith -log_view or -log_all is specified. PetscLogEventRegister() is 6525c6c1daeSBarry Smith intended for logging user events to supplement this PETSc 6535c6c1daeSBarry Smith information. 6545c6c1daeSBarry Smith 655495fc317SBarry Smith PETSc can gather data for use with the utilities Jumpshot 6565c6c1daeSBarry Smith (part of the MPICH distribution). If PETSc has been compiled 6575c6c1daeSBarry Smith with flag -DPETSC_HAVE_MPE (MPE is an additional utility within 6585c6c1daeSBarry Smith MPICH), the user can employ another command line option, -log_mpe, 6595c6c1daeSBarry Smith to create a logfile, "mpe.log", which can be visualized 660495fc317SBarry Smith Jumpshot. 6615c6c1daeSBarry Smith 6625c6c1daeSBarry Smith The classid is associated with each event so that classes of events 6635c6c1daeSBarry Smith can be disabled simultaneously, such as all matrix events. The user 6645c6c1daeSBarry Smith can either use an existing classid, such as MAT_CLASSID, or create 6655c6c1daeSBarry Smith their own as shown in the example. 6665c6c1daeSBarry Smith 667c5deb1d5SJed Brown If an existing event with the same name exists, its event handle is 668c5deb1d5SJed Brown returned instead of creating a new event. 669c5deb1d5SJed Brown 6705c6c1daeSBarry Smith Level: intermediate 6715c6c1daeSBarry Smith 6725c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogFlops(), 6735c6c1daeSBarry Smith PetscLogEventActivate(), PetscLogEventDeactivate(), PetscClassIdRegister() 6745c6c1daeSBarry Smith @*/ 6755c6c1daeSBarry Smith PetscErrorCode PetscLogEventRegister(const char name[],PetscClassId classid,PetscLogEvent *event) 6765c6c1daeSBarry Smith { 6775c6c1daeSBarry Smith PetscStageLog stageLog; 6785c6c1daeSBarry Smith int stage; 6795c6c1daeSBarry Smith PetscErrorCode ierr; 6805c6c1daeSBarry Smith 6815c6c1daeSBarry Smith PetscFunctionBegin; 6825c6c1daeSBarry Smith *event = PETSC_DECIDE; 6835c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 6843a88037aSBarry Smith ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr); 685c5deb1d5SJed Brown if (*event > 0) PetscFunctionReturn(0); 6863a88037aSBarry Smith ierr = PetscEventRegLogRegister(stageLog->eventLog, name, classid, event);CHKERRQ(ierr); 6875c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 6883a88037aSBarry Smith ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr); 6893a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 6905c6c1daeSBarry Smith } 6915c6c1daeSBarry Smith PetscFunctionReturn(0); 6925c6c1daeSBarry Smith } 6935c6c1daeSBarry Smith 6945c6c1daeSBarry Smith /*@ 695217044c2SLisandro Dalcin PetscLogEventSetCollective - Indicates that a particular event is collective. 696217044c2SLisandro Dalcin 697217044c2SLisandro Dalcin Not Collective 698217044c2SLisandro Dalcin 699217044c2SLisandro Dalcin Input Parameter: 700217044c2SLisandro Dalcin + event - The event id 701217044c2SLisandro Dalcin - collective - Bolean flag indicating whether a particular event is collective 702217044c2SLisandro Dalcin 703217044c2SLisandro Dalcin Note: 704217044c2SLisandro Dalcin New events returned from PetscLogEventRegister() are collective by default. 705217044c2SLisandro Dalcin 706217044c2SLisandro Dalcin Level: developer 707217044c2SLisandro Dalcin 708217044c2SLisandro Dalcin .seealso: PetscLogEventRegister() 709217044c2SLisandro Dalcin @*/ 710217044c2SLisandro Dalcin PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event,PetscBool collective) 711217044c2SLisandro Dalcin { 712217044c2SLisandro Dalcin PetscStageLog stageLog; 713217044c2SLisandro Dalcin PetscEventRegLog eventRegLog; 714217044c2SLisandro Dalcin PetscErrorCode ierr; 715217044c2SLisandro Dalcin 716217044c2SLisandro Dalcin PetscFunctionBegin; 717217044c2SLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 718217044c2SLisandro Dalcin ierr = PetscStageLogGetEventRegLog(stageLog,&eventRegLog);CHKERRQ(ierr); 719217044c2SLisandro Dalcin if (event < 0 || event > eventRegLog->numEvents) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Invalid event id"); 720217044c2SLisandro Dalcin eventRegLog->eventInfo[event].collective = collective; 721217044c2SLisandro Dalcin PetscFunctionReturn(0); 722217044c2SLisandro Dalcin } 723217044c2SLisandro Dalcin 724217044c2SLisandro Dalcin /*@ 725fa2bb9feSLisandro Dalcin PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage. 726fa2bb9feSLisandro Dalcin 727fa2bb9feSLisandro Dalcin Not Collective 728fa2bb9feSLisandro Dalcin 729fa2bb9feSLisandro Dalcin Input Parameter: 730fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc. 731fa2bb9feSLisandro Dalcin 732fa2bb9feSLisandro Dalcin Level: developer 733fa2bb9feSLisandro Dalcin 734fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 735fa2bb9feSLisandro Dalcin @*/ 736fa2bb9feSLisandro Dalcin PetscErrorCode PetscLogEventIncludeClass(PetscClassId classid) 737fa2bb9feSLisandro Dalcin { 738fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 739fa2bb9feSLisandro Dalcin int stage; 740fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 741fa2bb9feSLisandro Dalcin 742fa2bb9feSLisandro Dalcin PetscFunctionBegin; 743fa2bb9feSLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 744fa2bb9feSLisandro Dalcin for (stage = 0; stage < stageLog->numStages; stage++) { 745fa2bb9feSLisandro Dalcin ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 746fa2bb9feSLisandro Dalcin } 747fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 748fa2bb9feSLisandro Dalcin } 749fa2bb9feSLisandro Dalcin 750fa2bb9feSLisandro Dalcin /*@ 751fa2bb9feSLisandro Dalcin PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage. 752fa2bb9feSLisandro Dalcin 753fa2bb9feSLisandro Dalcin Not Collective 754fa2bb9feSLisandro Dalcin 755fa2bb9feSLisandro Dalcin Input Parameter: 756fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc. 757fa2bb9feSLisandro Dalcin 758fa2bb9feSLisandro Dalcin Level: developer 759fa2bb9feSLisandro Dalcin 760fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivateClass(),PetscLogEventDeactivate(),PetscLogEventActivate() 761fa2bb9feSLisandro Dalcin @*/ 762fa2bb9feSLisandro Dalcin PetscErrorCode PetscLogEventExcludeClass(PetscClassId classid) 763fa2bb9feSLisandro Dalcin { 764fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 765fa2bb9feSLisandro Dalcin int stage; 766fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 767fa2bb9feSLisandro Dalcin 768fa2bb9feSLisandro Dalcin PetscFunctionBegin; 769fa2bb9feSLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 770fa2bb9feSLisandro Dalcin for (stage = 0; stage < stageLog->numStages; stage++) { 771fa2bb9feSLisandro Dalcin ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 772fa2bb9feSLisandro Dalcin } 773fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 774fa2bb9feSLisandro Dalcin } 775fa2bb9feSLisandro Dalcin 776fa2bb9feSLisandro Dalcin /*@ 7775c6c1daeSBarry Smith PetscLogEventActivate - Indicates that a particular event should be logged. 7785c6c1daeSBarry Smith 7795c6c1daeSBarry Smith Not Collective 7805c6c1daeSBarry Smith 7815c6c1daeSBarry Smith Input Parameter: 7825c6c1daeSBarry Smith . event - The event id 7835c6c1daeSBarry Smith 7845c6c1daeSBarry Smith Usage: 7855c6c1daeSBarry Smith .vb 7865c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 7875c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 7885c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 7895c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 7905c6c1daeSBarry Smith .ve 7915c6c1daeSBarry Smith 7925c6c1daeSBarry Smith Note: 7935c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in include/petsclog.h) 7945c6c1daeSBarry Smith or an event number obtained with PetscLogEventRegister(). 7955c6c1daeSBarry Smith 7965c6c1daeSBarry Smith Level: advanced 7975c6c1daeSBarry Smith 798ec303c53SPatrick Sanan .seealso: PlogEventDeactivate() 7995c6c1daeSBarry Smith @*/ 8005c6c1daeSBarry Smith PetscErrorCode PetscLogEventActivate(PetscLogEvent event) 8015c6c1daeSBarry Smith { 8025c6c1daeSBarry Smith PetscStageLog stageLog; 8035c6c1daeSBarry Smith int stage; 8045c6c1daeSBarry Smith PetscErrorCode ierr; 8055c6c1daeSBarry Smith 8065c6c1daeSBarry Smith PetscFunctionBegin; 8075c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8085c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 8093a88037aSBarry Smith ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8105c6c1daeSBarry Smith PetscFunctionReturn(0); 8115c6c1daeSBarry Smith } 8125c6c1daeSBarry Smith 8135c6c1daeSBarry Smith /*@ 8145c6c1daeSBarry Smith PetscLogEventDeactivate - Indicates that a particular event should not be logged. 8155c6c1daeSBarry Smith 8165c6c1daeSBarry Smith Not Collective 8175c6c1daeSBarry Smith 8185c6c1daeSBarry Smith Input Parameter: 8195c6c1daeSBarry Smith . event - The event id 8205c6c1daeSBarry Smith 8215c6c1daeSBarry Smith Usage: 8225c6c1daeSBarry Smith .vb 8235c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 8245c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 8255c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 8265c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 8275c6c1daeSBarry Smith .ve 8285c6c1daeSBarry Smith 8295c6c1daeSBarry Smith Note: 8305c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in 8315c6c1daeSBarry Smith include/petsclog.h) or an event number obtained with PetscLogEventRegister()). 8325c6c1daeSBarry Smith 8335c6c1daeSBarry Smith Level: advanced 8345c6c1daeSBarry Smith 835ec303c53SPatrick Sanan .seealso: PlogEventActivate() 8365c6c1daeSBarry Smith @*/ 8375c6c1daeSBarry Smith PetscErrorCode PetscLogEventDeactivate(PetscLogEvent event) 8385c6c1daeSBarry Smith { 8395c6c1daeSBarry Smith PetscStageLog stageLog; 8405c6c1daeSBarry Smith int stage; 8415c6c1daeSBarry Smith PetscErrorCode ierr; 8425c6c1daeSBarry Smith 8435c6c1daeSBarry Smith PetscFunctionBegin; 8445c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8455c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 8463a88037aSBarry Smith ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8475c6c1daeSBarry Smith PetscFunctionReturn(0); 8485c6c1daeSBarry Smith } 8495c6c1daeSBarry Smith 8505c6c1daeSBarry Smith /*@ 8515c6c1daeSBarry Smith PetscLogEventSetActiveAll - Sets the event activity in every stage. 8525c6c1daeSBarry Smith 8535c6c1daeSBarry Smith Not Collective 8545c6c1daeSBarry Smith 8555c6c1daeSBarry Smith Input Parameters: 8565c6c1daeSBarry Smith + event - The event id 8575c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged 8585c6c1daeSBarry Smith 8595c6c1daeSBarry Smith Level: advanced 8605c6c1daeSBarry Smith 861ec303c53SPatrick Sanan .seealso: PlogEventActivate(),PlogEventDeactivate() 8625c6c1daeSBarry Smith @*/ 8635c6c1daeSBarry Smith PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive) 8645c6c1daeSBarry Smith { 8655c6c1daeSBarry Smith PetscStageLog stageLog; 8665c6c1daeSBarry Smith int stage; 8675c6c1daeSBarry Smith PetscErrorCode ierr; 8685c6c1daeSBarry Smith 8695c6c1daeSBarry Smith PetscFunctionBegin; 8705c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8715c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 8725c6c1daeSBarry Smith if (isActive) { 8733a88037aSBarry Smith ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8745c6c1daeSBarry Smith } else { 8753a88037aSBarry Smith ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8765c6c1daeSBarry Smith } 8775c6c1daeSBarry Smith } 8785c6c1daeSBarry Smith PetscFunctionReturn(0); 8795c6c1daeSBarry Smith } 8805c6c1daeSBarry Smith 8815c6c1daeSBarry Smith /*@ 8825c6c1daeSBarry Smith PetscLogEventActivateClass - Activates event logging for a PETSc object class. 8835c6c1daeSBarry Smith 8845c6c1daeSBarry Smith Not Collective 8855c6c1daeSBarry Smith 8865c6c1daeSBarry Smith Input Parameter: 8875c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 8885c6c1daeSBarry Smith 8895c6c1daeSBarry Smith Level: developer 8905c6c1daeSBarry Smith 891fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 8925c6c1daeSBarry Smith @*/ 8935c6c1daeSBarry Smith PetscErrorCode PetscLogEventActivateClass(PetscClassId classid) 8945c6c1daeSBarry Smith { 8955c6c1daeSBarry Smith PetscStageLog stageLog; 8965c6c1daeSBarry Smith int stage; 8975c6c1daeSBarry Smith PetscErrorCode ierr; 8985c6c1daeSBarry Smith 8995c6c1daeSBarry Smith PetscFunctionBegin; 9005c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 9015c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 9023a88037aSBarry Smith ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 9035c6c1daeSBarry Smith PetscFunctionReturn(0); 9045c6c1daeSBarry Smith } 9055c6c1daeSBarry Smith 9065c6c1daeSBarry Smith /*@ 9075c6c1daeSBarry Smith PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class. 9085c6c1daeSBarry Smith 9095c6c1daeSBarry Smith Not Collective 9105c6c1daeSBarry Smith 9115c6c1daeSBarry Smith Input Parameter: 9125c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 9135c6c1daeSBarry Smith 9145c6c1daeSBarry Smith Level: developer 9155c6c1daeSBarry Smith 916fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 9175c6c1daeSBarry Smith @*/ 9185c6c1daeSBarry Smith PetscErrorCode PetscLogEventDeactivateClass(PetscClassId classid) 9195c6c1daeSBarry Smith { 9205c6c1daeSBarry Smith PetscStageLog stageLog; 9215c6c1daeSBarry Smith int stage; 9225c6c1daeSBarry Smith PetscErrorCode ierr; 9235c6c1daeSBarry Smith 9245c6c1daeSBarry Smith PetscFunctionBegin; 9255c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 9265c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 9273a88037aSBarry Smith ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 9285c6c1daeSBarry Smith PetscFunctionReturn(0); 9295c6c1daeSBarry Smith } 9305c6c1daeSBarry Smith 9315c6c1daeSBarry Smith /*MC 93262872c28SLisandro Dalcin PetscLogEventSync - Synchronizes the beginning of a user event. 93362872c28SLisandro Dalcin 93462872c28SLisandro Dalcin Synopsis: 93562872c28SLisandro Dalcin #include <petsclog.h> 93662872c28SLisandro Dalcin PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm) 93762872c28SLisandro Dalcin 93862872c28SLisandro Dalcin Collective 93962872c28SLisandro Dalcin 94062872c28SLisandro Dalcin Input Parameters: 94162872c28SLisandro Dalcin + e - integer associated with the event obtained from PetscLogEventRegister() 94262872c28SLisandro Dalcin - comm - an MPI communicator 94362872c28SLisandro Dalcin 94462872c28SLisandro Dalcin Usage: 94562872c28SLisandro Dalcin .vb 94662872c28SLisandro Dalcin PetscLogEvent USER_EVENT; 94762872c28SLisandro Dalcin PetscLogEventRegister("User event",0,&USER_EVENT); 94862872c28SLisandro Dalcin PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD); 94962872c28SLisandro Dalcin PetscLogEventBegin(USER_EVENT,0,0,0,0); 95062872c28SLisandro Dalcin [code segment to monitor] 95162872c28SLisandro Dalcin PetscLogEventEnd(USER_EVENT,0,0,0,0); 95262872c28SLisandro Dalcin .ve 95362872c28SLisandro Dalcin 95462872c28SLisandro Dalcin Notes: 95562872c28SLisandro Dalcin This routine should be called only if there is not a 95662872c28SLisandro Dalcin PetscObject available to pass to PetscLogEventBegin(). 95762872c28SLisandro Dalcin 95862872c28SLisandro Dalcin Level: developer 95962872c28SLisandro Dalcin 96062872c28SLisandro Dalcin .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd() 96162872c28SLisandro Dalcin 96262872c28SLisandro Dalcin M*/ 96362872c28SLisandro Dalcin 96462872c28SLisandro Dalcin /*MC 9655c6c1daeSBarry Smith PetscLogEventBegin - Logs the beginning of a user event. 9665c6c1daeSBarry Smith 9675c6c1daeSBarry Smith Synopsis: 968aaa7dc30SBarry Smith #include <petsclog.h> 969f2ba6396SBarry Smith PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 9705c6c1daeSBarry Smith 9715c6c1daeSBarry Smith Not Collective 9725c6c1daeSBarry Smith 9735c6c1daeSBarry Smith Input Parameters: 9745c6c1daeSBarry Smith + e - integer associated with the event obtained from PetscLogEventRegister() 9755c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 9765c6c1daeSBarry Smith 9775c6c1daeSBarry Smith 9785c6c1daeSBarry Smith Fortran Synopsis: 9795c6c1daeSBarry Smith void PetscLogEventBegin(int e,PetscErrorCode ierr) 9805c6c1daeSBarry Smith 9815c6c1daeSBarry Smith Usage: 9825c6c1daeSBarry Smith .vb 9835c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 9845c6c1daeSBarry Smith PetscLogDouble user_event_flops; 9855c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 9865c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 9875c6c1daeSBarry Smith [code segment to monitor] 9885c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 9895c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 9905c6c1daeSBarry Smith .ve 9915c6c1daeSBarry Smith 9925c6c1daeSBarry Smith Notes: 9935c6c1daeSBarry Smith You need to register each integer event with the command 994a2553e36SBarry Smith PetscLogEventRegister(). 9955c6c1daeSBarry Smith 9965c6c1daeSBarry Smith Level: intermediate 9975c6c1daeSBarry Smith 9985c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops() 9995c6c1daeSBarry Smith 10005c6c1daeSBarry Smith M*/ 10015c6c1daeSBarry Smith 10025c6c1daeSBarry Smith /*MC 10035c6c1daeSBarry Smith PetscLogEventEnd - Log the end of a user event. 10045c6c1daeSBarry Smith 10055c6c1daeSBarry Smith Synopsis: 1006aaa7dc30SBarry Smith #include <petsclog.h> 1007f2ba6396SBarry Smith PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 10085c6c1daeSBarry Smith 10095c6c1daeSBarry Smith Not Collective 10105c6c1daeSBarry Smith 10115c6c1daeSBarry Smith Input Parameters: 10125c6c1daeSBarry Smith + e - integer associated with the event obtained with PetscLogEventRegister() 10135c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10145c6c1daeSBarry Smith 10155c6c1daeSBarry Smith 10165c6c1daeSBarry Smith Fortran Synopsis: 10175c6c1daeSBarry Smith void PetscLogEventEnd(int e,PetscErrorCode ierr) 10185c6c1daeSBarry Smith 10195c6c1daeSBarry Smith Usage: 10205c6c1daeSBarry Smith .vb 10215c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 10225c6c1daeSBarry Smith PetscLogDouble user_event_flops; 10235c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT,); 10245c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 10255c6c1daeSBarry Smith [code segment to monitor] 10265c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 10275c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 10285c6c1daeSBarry Smith .ve 10295c6c1daeSBarry Smith 10305c6c1daeSBarry Smith Notes: 10315c6c1daeSBarry Smith You should also register each additional integer event with the command 1032a2553e36SBarry Smith PetscLogEventRegister(). 10335c6c1daeSBarry Smith 10345c6c1daeSBarry Smith Level: intermediate 10355c6c1daeSBarry Smith 10365c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogFlops() 10375c6c1daeSBarry Smith 10385c6c1daeSBarry Smith M*/ 10395c6c1daeSBarry Smith 10405c6c1daeSBarry Smith /*@C 10415c6c1daeSBarry Smith PetscLogEventGetId - Returns the event id when given the event name. 10425c6c1daeSBarry Smith 10435c6c1daeSBarry Smith Not Collective 10445c6c1daeSBarry Smith 10455c6c1daeSBarry Smith Input Parameter: 10465c6c1daeSBarry Smith . name - The event name 10475c6c1daeSBarry Smith 10485c6c1daeSBarry Smith Output Parameter: 1049c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists 10505c6c1daeSBarry Smith 10515c6c1daeSBarry Smith Level: intermediate 10525c6c1daeSBarry Smith 10535c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStageGetId() 10545c6c1daeSBarry Smith @*/ 10555c6c1daeSBarry Smith PetscErrorCode PetscLogEventGetId(const char name[], PetscLogEvent *event) 10565c6c1daeSBarry Smith { 10575c6c1daeSBarry Smith PetscStageLog stageLog; 10585c6c1daeSBarry Smith PetscErrorCode ierr; 10595c6c1daeSBarry Smith 10605c6c1daeSBarry Smith PetscFunctionBegin; 10615c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 10623a88037aSBarry Smith ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr); 10635c6c1daeSBarry Smith PetscFunctionReturn(0); 10645c6c1daeSBarry Smith } 10655c6c1daeSBarry Smith 10665c6c1daeSBarry Smith 10675c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/ 10685c6c1daeSBarry Smith /*@C 10695c6c1daeSBarry Smith PetscLogDump - Dumps logs of objects to a file. This file is intended to 10705c6c1daeSBarry Smith be read by bin/petscview. This program no longer exists. 10715c6c1daeSBarry Smith 10725c6c1daeSBarry Smith Collective on PETSC_COMM_WORLD 10735c6c1daeSBarry Smith 10745c6c1daeSBarry Smith Input Parameter: 10755c6c1daeSBarry Smith . name - an optional file name 10765c6c1daeSBarry Smith 10775c6c1daeSBarry Smith Usage: 10785c6c1daeSBarry Smith .vb 10795c6c1daeSBarry Smith PetscInitialize(...); 1080bb1d7374SBarry Smith PetscLogDefaultBegin(); or PetscLogAllBegin(); 10815c6c1daeSBarry Smith ... code ... 10825c6c1daeSBarry Smith PetscLogDump(filename); 10835c6c1daeSBarry Smith PetscFinalize(); 10845c6c1daeSBarry Smith .ve 10855c6c1daeSBarry Smith 10865c6c1daeSBarry Smith Notes: 10875c6c1daeSBarry Smith The default file name is 10885c6c1daeSBarry Smith $ Log.<rank> 10895c6c1daeSBarry Smith where <rank> is the processor number. If no name is specified, 10905c6c1daeSBarry Smith this file will be used. 10915c6c1daeSBarry Smith 10925c6c1daeSBarry Smith Level: advanced 10935c6c1daeSBarry Smith 1094bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogView() 10955c6c1daeSBarry Smith @*/ 10965c6c1daeSBarry Smith PetscErrorCode PetscLogDump(const char sname[]) 10975c6c1daeSBarry Smith { 10985c6c1daeSBarry Smith PetscStageLog stageLog; 10995c6c1daeSBarry Smith PetscEventPerfInfo *eventInfo; 11005c6c1daeSBarry Smith FILE *fd; 11015c6c1daeSBarry Smith char file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN]; 11025c6c1daeSBarry Smith PetscLogDouble flops, _TotalTime; 11035c6c1daeSBarry Smith PetscMPIInt rank; 11045c6c1daeSBarry Smith int action, object, curStage; 11055c6c1daeSBarry Smith PetscLogEvent event; 11065c6c1daeSBarry Smith PetscErrorCode ierr; 11075c6c1daeSBarry Smith 11085c6c1daeSBarry Smith PetscFunctionBegin; 11095c6c1daeSBarry Smith /* Calculate the total elapsed time */ 11108563dfccSBarry Smith PetscTime(&_TotalTime); 11115c6c1daeSBarry Smith _TotalTime -= petsc_BaseTime; 11125c6c1daeSBarry Smith /* Open log file */ 11135c6c1daeSBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank);CHKERRQ(ierr); 11147ff663adSLisandro Dalcin if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank); 1115a297a907SKarl Rupp else sprintf(file, "Log.%d", rank); 11165c6c1daeSBarry Smith ierr = PetscFixFilename(file, fname);CHKERRQ(ierr); 11175c6c1daeSBarry Smith ierr = PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd);CHKERRQ(ierr); 11185c6c1daeSBarry Smith if ((!rank) && (!fd)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname); 11195c6c1daeSBarry Smith /* Output totals */ 1120d4aa7d5fSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime);CHKERRQ(ierr); 1121a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0);CHKERRQ(ierr); 11225c6c1daeSBarry Smith /* Output actions */ 11235c6c1daeSBarry Smith if (petsc_logActions) { 1124a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions);CHKERRQ(ierr); 11255c6c1daeSBarry Smith for (action = 0; action < petsc_numActions; action++) { 11265c6c1daeSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n", 11275c6c1daeSBarry Smith petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1, 1128a2ea699eSBarry Smith petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem);CHKERRQ(ierr); 11295c6c1daeSBarry Smith } 11305c6c1daeSBarry Smith } 11315c6c1daeSBarry Smith /* Output objects */ 11325c6c1daeSBarry Smith if (petsc_logObjects) { 1133a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed);CHKERRQ(ierr); 11345c6c1daeSBarry Smith for (object = 0; object < petsc_numObjects; object++) { 1135a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int) petsc_objects[object].mem);CHKERRQ(ierr); 11365c6c1daeSBarry Smith if (!petsc_objects[object].name[0]) { 1137a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd,"No Name\n");CHKERRQ(ierr); 11385c6c1daeSBarry Smith } else { 1139a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name);CHKERRQ(ierr); 11405c6c1daeSBarry Smith } 11415c6c1daeSBarry Smith if (petsc_objects[object].info[0] != 0) { 1142a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n");CHKERRQ(ierr); 11435c6c1daeSBarry Smith } else { 1144a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info);CHKERRQ(ierr); 11455c6c1daeSBarry Smith } 11465c6c1daeSBarry Smith } 11475c6c1daeSBarry Smith } 11485c6c1daeSBarry Smith /* Output events */ 1149a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n");CHKERRQ(ierr); 11505c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 11515c6c1daeSBarry Smith ierr = PetscIntStackTop(stageLog->stack, &curStage);CHKERRQ(ierr); 11525c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo; 11535c6c1daeSBarry Smith for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) { 1154a297a907SKarl Rupp if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops/eventInfo[event].time; 1155a297a907SKarl Rupp else flops = 0.0; 11565c6c1daeSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count, 1157a2ea699eSBarry Smith eventInfo[event].flops, eventInfo[event].time, flops);CHKERRQ(ierr); 11585c6c1daeSBarry Smith } 11595c6c1daeSBarry Smith ierr = PetscFClose(PETSC_COMM_WORLD, fd);CHKERRQ(ierr); 11605c6c1daeSBarry Smith PetscFunctionReturn(0); 11615c6c1daeSBarry Smith } 11625c6c1daeSBarry Smith 1163f14045dbSBarry Smith /* 1164f14045dbSBarry Smith PetscLogView_Detailed - Each process prints the times for its own events 1165f14045dbSBarry Smith 1166f14045dbSBarry Smith */ 1167f14045dbSBarry Smith PetscErrorCode PetscLogView_Detailed(PetscViewer viewer) 1168f14045dbSBarry Smith { 11692dff6485SMatthew G. Knepley PetscStageLog stageLog; 1170217044c2SLisandro Dalcin PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL; 1171217044c2SLisandro Dalcin PetscLogDouble locTotalTime, numRed, maxMem; 11722dff6485SMatthew G. Knepley int numStages,numEvents,stage,event; 1173217044c2SLisandro Dalcin MPI_Comm comm = PetscObjectComm((PetscObject) viewer); 11742dff6485SMatthew G. Knepley PetscMPIInt rank,size; 11752dff6485SMatthew G. Knepley PetscErrorCode ierr; 1176f14045dbSBarry Smith 1177f14045dbSBarry Smith PetscFunctionBegin; 11782d1ec343SBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 11792d1ec343SBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 11802dff6485SMatthew G. Knepley /* Must preserve reduction count before we go on */ 11812dff6485SMatthew G. Knepley numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 11822d1ec343SBarry Smith /* Get the total elapsed time */ 11832d1ec343SBarry Smith PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 11849852e123SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"size = %d\n",size);CHKERRQ(ierr); 11852d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalTimes = {}\n");CHKERRQ(ierr); 11862d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalMessages = {}\n");CHKERRQ(ierr); 1187217044c2SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"LocalMessageLens = {}\n");CHKERRQ(ierr); 11882d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalReductions = {}\n");CHKERRQ(ierr); 1189217044c2SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"LocalFlop = {}\n");CHKERRQ(ierr); 11902dff6485SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer,"LocalObjects = {}\n");CHKERRQ(ierr); 11912dff6485SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer,"LocalMemory = {}\n");CHKERRQ(ierr); 11922d1ec343SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1193b2566f29SBarry Smith ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 11942d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages = {}\n");CHKERRQ(ierr); 11952d1ec343SBarry Smith for (stage=0; stage<numStages; stage++) { 11962d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr); 119761917356SPatrick Sanan ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"summary\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr); 1198b2566f29SBarry Smith ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 11992d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 12002d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"%s\"] = {}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name);CHKERRQ(ierr); 12012d1ec343SBarry Smith } 12022d1ec343SBarry Smith } 1203217044c2SLisandro Dalcin ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr); 12041575c14dSBarry Smith ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr); 12052d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalTimes[%d] = %g\n",rank,locTotalTime);CHKERRQ(ierr); 12062d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessages[%d] = %g\n",rank,(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct));CHKERRQ(ierr); 1207217044c2SLisandro Dalcin ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessageLens[%d] = %g\n",rank,(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len));CHKERRQ(ierr); 12082dff6485SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalReductions[%d] = %g\n",rank,numRed);CHKERRQ(ierr); 1209217044c2SLisandro Dalcin ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalFlop[%d] = %g\n",rank,petsc_TotalFlops);CHKERRQ(ierr); 1210ba67d37fSBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalObjects[%d] = %d\n",rank,petsc_numObjects);CHKERRQ(ierr); 12112dff6485SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMemory[%d] = %g\n",rank,maxMem);CHKERRQ(ierr); 12122d1ec343SBarry Smith ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 12132d1ec343SBarry Smith for (stage=0; stage<numStages; stage++) { 1214217044c2SLisandro Dalcin stageInfo = &stageLog->stageInfo[stage].perfInfo; 1215d4aa7d5fSBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n", 12162dff6485SMatthew G. Knepley stageLog->stageInfo[stage].name,rank, 1217217044c2SLisandro Dalcin stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr); 1218b2566f29SBarry Smith ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 12192d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 1220217044c2SLisandro Dalcin eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 1221c15bc2c4SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %D, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g", 1222217044c2SLisandro Dalcin stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name,rank, 1223217044c2SLisandro Dalcin eventInfo->count,eventInfo->time,eventInfo->syncTime,eventInfo->numMessages,eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr); 1224891e75beSMatthew G. Knepley if (eventInfo->dof[0] >= 0.) { 1225891e75beSMatthew G. Knepley PetscInt d, e; 12265d68e14cSMatthew G. Knepley 1227891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : [");CHKERRQ(ierr); 1228891e75beSMatthew G. Knepley for (d = 0; d < 8; ++d) { 1229891e75beSMatthew G. Knepley if (d > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);} 1230891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d]);CHKERRQ(ierr); 1231891e75beSMatthew G. Knepley } 1232891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr); 12335d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : [");CHKERRQ(ierr); 12345d68e14cSMatthew G. Knepley for (e = 0; e < 8; ++e) { 12355d68e14cSMatthew G. Knepley if (e > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);} 1236c15bc2c4SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e]);CHKERRQ(ierr); 12375d68e14cSMatthew G. Knepley } 12385d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr); 12395d68e14cSMatthew G. Knepley } 12405d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"}\n");CHKERRQ(ierr); 12412d1ec343SBarry Smith } 12422d1ec343SBarry Smith } 12432d1ec343SBarry Smith ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 12441575c14dSBarry Smith ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr); 1245f14045dbSBarry Smith PetscFunctionReturn(0); 1246f14045dbSBarry Smith } 1247f14045dbSBarry Smith 124838144912Sdeepblu2718 /* 124938144912Sdeepblu2718 PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format 125038144912Sdeepblu2718 */ 125138144912Sdeepblu2718 PetscErrorCode PetscLogView_CSV(PetscViewer viewer) 125238144912Sdeepblu2718 { 125338144912Sdeepblu2718 PetscStageLog stageLog; 1254669c5be0SSatish Balay PetscEventPerfInfo *eventInfo = NULL; 125538144912Sdeepblu2718 PetscLogDouble locTotalTime, maxMem; 125638144912Sdeepblu2718 int numStages,numEvents,stage,event; 125738144912Sdeepblu2718 MPI_Comm comm = PetscObjectComm((PetscObject) viewer); 125838144912Sdeepblu2718 PetscMPIInt rank,size; 125938144912Sdeepblu2718 PetscErrorCode ierr; 126038144912Sdeepblu2718 126138144912Sdeepblu2718 PetscFunctionBegin; 126238144912Sdeepblu2718 ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 126338144912Sdeepblu2718 ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 126438144912Sdeepblu2718 /* Must preserve reduction count before we go on */ 126538144912Sdeepblu2718 /* Get the total elapsed time */ 126638144912Sdeepblu2718 PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 126738144912Sdeepblu2718 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 126838144912Sdeepblu2718 ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 126938144912Sdeepblu2718 ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr); 127038144912Sdeepblu2718 ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr); 127138144912Sdeepblu2718 ierr = PetscViewerASCIIPrintf(viewer,"Stage Name,Event Name,Rank,Time,Num Messages,Message Length,Num Reductions,FLOP,dof0,dof1,dof2,dof3,dof4,dof5,dof6,dof7,e0,e1,e2,e3,e4,e5,e6,e7,%d\n", size); 127238144912Sdeepblu2718 ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 127338144912Sdeepblu2718 for (stage=0; stage<numStages; stage++) { 127438144912Sdeepblu2718 ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 127538144912Sdeepblu2718 for (event = 0; event < numEvents; event++) { 127638144912Sdeepblu2718 eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 127738144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,%s,%d,%g,%g,%g,%g,%g",stageLog->stageInfo[stage].name, 127838144912Sdeepblu2718 stageLog->eventLog->eventInfo[event].name,rank,eventInfo->time,eventInfo->numMessages, 127938144912Sdeepblu2718 eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr); 128038144912Sdeepblu2718 if (eventInfo->dof[0] >= 0.) { 128138144912Sdeepblu2718 PetscInt d, e; 128238144912Sdeepblu2718 128338144912Sdeepblu2718 for (d = 0; d < 8; ++d) { 128438144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d]);CHKERRQ(ierr); 128538144912Sdeepblu2718 } 128638144912Sdeepblu2718 for (e = 0; e < 8; ++e) { 128738144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e]);CHKERRQ(ierr); 128838144912Sdeepblu2718 } 128938144912Sdeepblu2718 } 129038144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"\n");CHKERRQ(ierr); 129138144912Sdeepblu2718 } 129238144912Sdeepblu2718 } 129338144912Sdeepblu2718 ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 129438144912Sdeepblu2718 ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr); 129538144912Sdeepblu2718 PetscFunctionReturn(0); 129638144912Sdeepblu2718 } 129738144912Sdeepblu2718 1298217044c2SLisandro Dalcin static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm,FILE *fd) 1299217044c2SLisandro Dalcin { 1300217044c2SLisandro Dalcin PetscErrorCode ierr; 1301217044c2SLisandro Dalcin PetscFunctionBegin; 1302217044c2SLisandro Dalcin if (!PetscLogSyncOn) PetscFunctionReturn(0); 1303217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1304217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1305217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1306217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1307217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1308217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This program was run with logging synchronization. #\n");CHKERRQ(ierr); 1309217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This option provides more meaningful imbalance #\n");CHKERRQ(ierr); 1310217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # figures at the expense of slowing things down and #\n");CHKERRQ(ierr); 1311217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # providing a distorted view of the overall runtime. #\n");CHKERRQ(ierr); 1312217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1313217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 1314217044c2SLisandro Dalcin PetscFunctionReturn(0); 1315217044c2SLisandro Dalcin PetscFunctionReturn(0); 1316217044c2SLisandro Dalcin } 1317217044c2SLisandro Dalcin 1318f4091ad2SBarry Smith static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm,FILE *fd) 1319f4091ad2SBarry Smith { 1320f4091ad2SBarry Smith #if defined(PETSC_USE_DEBUG) 1321f4091ad2SBarry Smith PetscErrorCode ierr; 1322f4091ad2SBarry Smith 1323f4091ad2SBarry Smith PetscFunctionBegin; 1324f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1325f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1326f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1327f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1328f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1329217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This code was compiled with a debugging option. #\n");CHKERRQ(ierr); 1330f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # To get timing results run ./configure #\n");CHKERRQ(ierr); 1331f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # using --with-debugging=no, the performance will #\n");CHKERRQ(ierr); 1332f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # be generally two or three times faster. #\n");CHKERRQ(ierr); 1333f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1334f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 1335f4091ad2SBarry Smith PetscFunctionReturn(0); 1336f4091ad2SBarry Smith #else 1337f4091ad2SBarry Smith return 0; 1338f4091ad2SBarry Smith #endif 1339f4091ad2SBarry Smith } 1340f4091ad2SBarry Smith 1341f14045dbSBarry Smith PetscErrorCode PetscLogView_Default(PetscViewer viewer) 13425c6c1daeSBarry Smith { 13435c6c1daeSBarry Smith FILE *fd; 13445c6c1daeSBarry Smith PetscLogDouble zero = 0.0; 13455c6c1daeSBarry Smith PetscStageLog stageLog; 13460298fd71SBarry Smith PetscStageInfo *stageInfo = NULL; 13470298fd71SBarry Smith PetscEventPerfInfo *eventInfo = NULL; 13485c6c1daeSBarry Smith PetscClassPerfInfo *classInfo; 13495c6c1daeSBarry Smith char arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128]; 13505c6c1daeSBarry Smith const char *name; 13515c6c1daeSBarry Smith PetscLogDouble locTotalTime, TotalTime, TotalFlops; 13525c6c1daeSBarry Smith PetscLogDouble numMessages, messageLength, avgMessLen, numReductions; 13535c6c1daeSBarry Smith PetscLogDouble stageTime, flops, flopr, mem, mess, messLen, red; 13545c6c1daeSBarry Smith PetscLogDouble fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed; 13555c6c1daeSBarry Smith PetscLogDouble fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed; 13565c6c1daeSBarry Smith PetscLogDouble min, max, tot, ratio, avg, x, y; 1357e3ed9ee7SBarry Smith PetscLogDouble minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr, mal, malmax, emalmax; 1358*bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1359*bec0b493Shannah_mairs PetscLogDouble cct, gct, csz, gsz; 1360*bec0b493Shannah_mairs #endif 1361217044c2SLisandro Dalcin PetscMPIInt minC, maxC; 13625c6c1daeSBarry Smith PetscMPIInt size, rank; 13635c6c1daeSBarry Smith PetscBool *localStageUsed, *stageUsed; 13645c6c1daeSBarry Smith PetscBool *localStageVisible, *stageVisible; 13655c6c1daeSBarry Smith int numStages, localNumEvents, numEvents; 136637b78d16SBarry Smith int stage, oclass; 13675c6c1daeSBarry Smith PetscLogEvent event; 13685c6c1daeSBarry Smith PetscErrorCode ierr; 13695c6c1daeSBarry Smith char version[256]; 13705c6c1daeSBarry Smith MPI_Comm comm; 13715c6c1daeSBarry Smith 13725c6c1daeSBarry Smith PetscFunctionBegin; 13735c6c1daeSBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 13745c6c1daeSBarry Smith ierr = PetscViewerASCIIGetPointer(viewer,&fd);CHKERRQ(ierr); 13755c6c1daeSBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 13765c6c1daeSBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 13775c6c1daeSBarry Smith /* Get the total elapsed time */ 13788563dfccSBarry Smith PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 13795c6c1daeSBarry Smith 13805c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr); 13815c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "*** WIDEN YOUR WINDOW TO 120 CHARACTERS. Use 'enscript -r -fCourier9' to print this document ***\n");CHKERRQ(ierr); 13825c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr); 13835c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n---------------------------------------------- PETSc Performance Summary: ----------------------------------------------\n\n");CHKERRQ(ierr); 1384217044c2SLisandro Dalcin ierr = PetscLogViewWarnSync(comm,fd);CHKERRQ(ierr); 1385f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 13865c6c1daeSBarry Smith ierr = PetscGetArchType(arch,sizeof(arch));CHKERRQ(ierr); 13875c6c1daeSBarry Smith ierr = PetscGetHostName(hostname,sizeof(hostname));CHKERRQ(ierr); 13885c6c1daeSBarry Smith ierr = PetscGetUserName(username,sizeof(username));CHKERRQ(ierr); 13895c6c1daeSBarry Smith ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr); 13905c6c1daeSBarry Smith ierr = PetscGetDate(date,sizeof(date));CHKERRQ(ierr); 13915c6c1daeSBarry Smith ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr); 13925c6c1daeSBarry Smith if (size == 1) { 13935c6c1daeSBarry 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); 13945c6c1daeSBarry Smith } else { 13955c6c1daeSBarry 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); 13965c6c1daeSBarry Smith } 13975c6c1daeSBarry Smith 13985c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Using %s\n", version);CHKERRQ(ierr); 13995c6c1daeSBarry Smith 14005c6c1daeSBarry Smith /* Must preserve reduction count before we go on */ 14015c6c1daeSBarry Smith red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 14025c6c1daeSBarry Smith 14035c6c1daeSBarry Smith /* Calculate summary information */ 14045c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n Max Max/Min Avg Total \n");CHKERRQ(ierr); 14055c6c1daeSBarry Smith /* Time */ 1406b2566f29SBarry Smith ierr = MPIU_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1407b2566f29SBarry Smith ierr = MPIU_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1408b2566f29SBarry Smith ierr = MPIU_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1409217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1410217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1411217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Time (sec): %5.3e %7.3f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 14125c6c1daeSBarry Smith TotalTime = tot; 14135c6c1daeSBarry Smith /* Objects */ 14145c6c1daeSBarry Smith avg = (PetscLogDouble) petsc_numObjects; 1415b2566f29SBarry Smith ierr = MPIU_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1416b2566f29SBarry Smith ierr = MPIU_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1417b2566f29SBarry Smith ierr = MPIU_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1418217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1419217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1420217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Objects: %5.3e %7.3f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 14215c6c1daeSBarry Smith /* Flops */ 1422b2566f29SBarry Smith ierr = MPIU_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1423b2566f29SBarry Smith ierr = MPIU_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1424b2566f29SBarry Smith ierr = MPIU_Allreduce(&petsc_TotalFlops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1425217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1426217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1427217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Flop: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14285c6c1daeSBarry Smith TotalFlops = tot; 14295c6c1daeSBarry Smith /* Flops/sec -- Must talk to Barry here */ 1430217044c2SLisandro Dalcin if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime; else flops = 0.0; 1431b2566f29SBarry Smith ierr = MPIU_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1432b2566f29SBarry Smith ierr = MPIU_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1433b2566f29SBarry Smith ierr = MPIU_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1434217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1435217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1436217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Flop/sec: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14375c6c1daeSBarry Smith /* Memory */ 14385c6c1daeSBarry Smith ierr = PetscMallocGetMaximumUsage(&mem);CHKERRQ(ierr); 14395c6c1daeSBarry Smith if (mem > 0.0) { 1440b2566f29SBarry Smith ierr = MPIU_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1441217044c2SLisandro Dalcin ierr = MPIU_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1442b2566f29SBarry Smith ierr = MPIU_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1443217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1444217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1445217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Memory: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14465c6c1daeSBarry Smith } 14475c6c1daeSBarry Smith /* Messages */ 14485c6c1daeSBarry Smith mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct); 1449b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1450b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1451b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1452217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1453217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1454217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Messages: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14555c6c1daeSBarry Smith numMessages = tot; 14565c6c1daeSBarry Smith /* Message Lengths */ 14575c6c1daeSBarry Smith mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len); 1458b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1459b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1460b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1461217044c2SLisandro Dalcin if (numMessages != 0) avg = tot/numMessages; else avg = 0.0; 1462217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1463217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Message Lengths: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14645c6c1daeSBarry Smith messageLength = tot; 14655c6c1daeSBarry Smith /* Reductions */ 1466b2566f29SBarry Smith ierr = MPIU_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1467b2566f29SBarry Smith ierr = MPIU_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1468b2566f29SBarry Smith ierr = MPIU_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1469217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1470217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Reductions: %5.3e %7.3f\n", max, ratio);CHKERRQ(ierr); 14715c6c1daeSBarry Smith numReductions = red; /* wrong because uses count from process zero */ 14725c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n");CHKERRQ(ierr); 1473d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " e.g., VecAXPY() for real vectors of length N --> 2N flop\n");CHKERRQ(ierr); 1474d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " and VecAXPY() for complex vectors of length N --> 8N flop\n");CHKERRQ(ierr); 14755c6c1daeSBarry Smith 14765c6c1daeSBarry Smith /* Get total number of stages -- 14775c6c1daeSBarry Smith Currently, a single processor can register more stages than another, but stages must all be registered in order. 14785c6c1daeSBarry Smith We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID. 14795c6c1daeSBarry Smith This seems best accomplished by assoicating a communicator with each stage. 14805c6c1daeSBarry Smith */ 148137b78d16SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1482b2566f29SBarry Smith ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1483785e854fSJed Brown ierr = PetscMalloc1(numStages, &localStageUsed);CHKERRQ(ierr); 1484785e854fSJed Brown ierr = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr); 1485785e854fSJed Brown ierr = PetscMalloc1(numStages, &localStageVisible);CHKERRQ(ierr); 1486785e854fSJed Brown ierr = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr); 14875c6c1daeSBarry Smith if (numStages > 0) { 14885c6c1daeSBarry Smith stageInfo = stageLog->stageInfo; 14895c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 14905c6c1daeSBarry Smith if (stage < stageLog->numStages) { 14915c6c1daeSBarry Smith localStageUsed[stage] = stageInfo[stage].used; 14925c6c1daeSBarry Smith localStageVisible[stage] = stageInfo[stage].perfInfo.visible; 14935c6c1daeSBarry Smith } else { 14945c6c1daeSBarry Smith localStageUsed[stage] = PETSC_FALSE; 14955c6c1daeSBarry Smith localStageVisible[stage] = PETSC_TRUE; 14965c6c1daeSBarry Smith } 14975c6c1daeSBarry Smith } 1498b2566f29SBarry Smith ierr = MPIU_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm);CHKERRQ(ierr); 1499b2566f29SBarry Smith ierr = MPIU_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr); 15005c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 15015c6c1daeSBarry Smith if (stageUsed[stage]) { 1502217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "\nSummary of Stages: ----- Time ------ ----- Flop ------ --- Messages --- -- Message Lengths -- -- Reductions --\n");CHKERRQ(ierr); 1503217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " Avg %%Total Avg %%Total Count %%Total Avg %%Total Count %%Total \n");CHKERRQ(ierr); 15045c6c1daeSBarry Smith break; 15055c6c1daeSBarry Smith } 15065c6c1daeSBarry Smith } 15075c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 15085c6c1daeSBarry Smith if (!stageUsed[stage]) continue; 150950a9567dSMatthew G. Knepley /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 15105c6c1daeSBarry Smith if (localStageUsed[stage]) { 151150a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 151250a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 151350a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 151450a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 151550a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15165c6c1daeSBarry Smith name = stageInfo[stage].name; 15175c6c1daeSBarry Smith } else { 151850a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 151950a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 152050a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 152150a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 152250a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15235c6c1daeSBarry Smith name = ""; 15245c6c1daeSBarry Smith } 15255c6c1daeSBarry Smith mess *= 0.5; messLen *= 0.5; red /= size; 15265c6c1daeSBarry Smith if (TotalTime != 0.0) fracTime = stageTime/TotalTime; else fracTime = 0.0; 15275c6c1daeSBarry Smith if (TotalFlops != 0.0) fracFlops = flops/TotalFlops; else fracFlops = 0.0; 15285c6c1daeSBarry Smith /* Talk to Barry if (stageTime != 0.0) flops = (size*flops)/stageTime; else flops = 0.0; */ 15295c6c1daeSBarry Smith if (numMessages != 0.0) fracMessages = mess/numMessages; else fracMessages = 0.0; 1530e96a4d02SJunchao Zhang if (mess != 0.0) avgMessLen = messLen/mess; else avgMessLen = 0.0; 15315c6c1daeSBarry Smith if (messageLength != 0.0) fracLength = messLen/messageLength; else fracLength = 0.0; 15325c6c1daeSBarry Smith if (numReductions != 0.0) fracReductions = red/numReductions; else fracReductions = 0.0; 15335c6c1daeSBarry 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", 15345c6c1daeSBarry Smith stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops, 15355c6c1daeSBarry Smith mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr); 15365c6c1daeSBarry Smith } 15375c6c1daeSBarry Smith } 15385c6c1daeSBarry Smith 1539806fa848SBarry Smith ierr = PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 15405c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n");CHKERRQ(ierr); 15415c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Phase summary info:\n");CHKERRQ(ierr); 15425c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Count: number of times phase was executed\n");CHKERRQ(ierr); 1543d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " Time and Flop: Max - maximum over all processors\n");CHKERRQ(ierr); 15445c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Ratio - ratio of maximum to minimum over all processors\n");CHKERRQ(ierr); 15455c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Mess: number of messages sent\n");CHKERRQ(ierr); 1546217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " AvgLen: average message length (bytes)\n");CHKERRQ(ierr); 15475c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Reduct: number of global reductions\n");CHKERRQ(ierr); 15485c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Global: entire computation\n");CHKERRQ(ierr); 15495c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n");CHKERRQ(ierr); 1550d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " %%T - percent time in this phase %%F - percent flop in this phase\n");CHKERRQ(ierr); 15515c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " %%M - percent messages in this phase %%L - percent message lengths in this phase\n");CHKERRQ(ierr); 15525c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " %%R - percent reductions in this phase\n");CHKERRQ(ierr); 1553d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n");CHKERRQ(ierr); 1554e3ed9ee7SBarry Smith if (PetscLogMemory) { 1555e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event)\n");CHKERRQ(ierr); 1556e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events)\n");CHKERRQ(ierr); 1557e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event)\n");CHKERRQ(ierr); 1558e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " RMI Mbytes: Increase in resident memory (sum over all calls to event)\n");CHKERRQ(ierr); 1559e3ed9ee7SBarry Smith } 1560*bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1561*bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd, " CpuToGpu Count: total number of CPU to GPU copies over all processors\n");CHKERRQ(ierr); 1562*bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd, " CpuToGpu Size (Mbytes): 10e-6 * (total size of CPU to GPU copies)\n");CHKERRQ(ierr); 1563*bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd, " GpuToCpu Count: total number of GPU to CPU copies over all processors\n");CHKERRQ(ierr); 1564*bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd, " GpuToCpu Size (Mbytes): 10e-6 * (total size of GPU to CPU copies)\n");CHKERRQ(ierr); 1565*bec0b493Shannah_mairs #endif 1566806fa848SBarry Smith ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 15675c6c1daeSBarry Smith 1568f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 15695c6c1daeSBarry Smith 15705c6c1daeSBarry Smith /* Report events */ 1571e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd,"Event Count Time (sec) Flop --- Global --- --- Stage ---- Total");CHKERRQ(ierr); 1572e3ed9ee7SBarry Smith if (PetscLogMemory) { 1573*bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd," Malloc EMalloc MMalloc RMI");CHKERRQ(ierr); 1574e3ed9ee7SBarry Smith } 1575*bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1576*bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd," - CpuToGpu - - GpuToCpu -");CHKERRQ(ierr); 1577*bec0b493Shannah_mairs #endif 1578*bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 1579e3ed9ee7SBarry 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); 1580e3ed9ee7SBarry Smith if (PetscLogMemory) { 1581*bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd," Mbytes Mbytes Mbytes Mbytes");CHKERRQ(ierr); 1582e3ed9ee7SBarry Smith } 1583*bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1584*bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd," Count Size Count Size");CHKERRQ(ierr); 1585*bec0b493Shannah_mairs #endif 1586*bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 1587806fa848SBarry Smith ierr = PetscFPrintf(comm, fd,"------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 15885c6c1daeSBarry Smith 15895c6c1daeSBarry Smith /* Problem: The stage name will not show up unless the stage executed on proc 1 */ 15905c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 15915c6c1daeSBarry Smith if (!stageVisible[stage]) continue; 159250a9567dSMatthew G. Knepley /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 15935c6c1daeSBarry Smith if (localStageUsed[stage]) { 15945c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 159550a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 159650a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 159750a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 159850a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 159950a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 16005c6c1daeSBarry Smith } else { 16015c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 160250a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 160350a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 160450a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 160550a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 160650a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 16075c6c1daeSBarry Smith } 16085c6c1daeSBarry Smith mess *= 0.5; messLen *= 0.5; red /= size; 16095c6c1daeSBarry Smith 16105c6c1daeSBarry Smith /* Get total number of events in this stage -- 16115c6c1daeSBarry Smith Currently, a single processor can register more events than another, but events must all be registered in order, 16125c6c1daeSBarry Smith just like stages. We can removed this requirement if necessary by having a global event numbering and indirection 1613217044c2SLisandro Dalcin on the event ID. This seems best accomplished by associating a communicator with each stage. 16145c6c1daeSBarry Smith 16155c6c1daeSBarry Smith Problem: If the event did not happen on proc 1, its name will not be available. 16165c6c1daeSBarry Smith Problem: Event visibility is not implemented 16175c6c1daeSBarry Smith */ 16185c6c1daeSBarry Smith if (localStageUsed[stage]) { 16195c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo; 16205c6c1daeSBarry Smith localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents; 1621a297a907SKarl Rupp } else localNumEvents = 0; 1622b2566f29SBarry Smith ierr = MPIU_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 16235c6c1daeSBarry Smith for (event = 0; event < numEvents; event++) { 162450a9567dSMatthew G. Knepley /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 16255c6c1daeSBarry Smith if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) { 1626217044c2SLisandro Dalcin if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; else flopr = 0.0; 162750a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 162850a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 162950a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 163050a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 163150a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 163250a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 163350a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 163450a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 163550a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1636217044c2SLisandro Dalcin ierr = MPI_Allreduce(&eventInfo[event].count, &minC, 1, MPI_INT, MPI_MIN, comm);CHKERRQ(ierr); 1637217044c2SLisandro Dalcin ierr = MPI_Allreduce(&eventInfo[event].count, &maxC, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1638e3ed9ee7SBarry Smith if (PetscLogMemory) { 1639e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&eventInfo[event].memIncrease, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1640e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&eventInfo[event].mallocSpace, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1641e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&eventInfo[event].mallocIncrease, &malmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1642e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1643e3ed9ee7SBarry Smith } 1644*bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1645*bec0b493Shannah_mairs ierr = MPI_Allreduce(&eventInfo[event].CpuToGpuCount, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1646*bec0b493Shannah_mairs ierr = MPI_Allreduce(&eventInfo[event].GpuToCpuCount, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1647*bec0b493Shannah_mairs ierr = MPI_Allreduce(&eventInfo[event].CpuToGpuSize, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1648*bec0b493Shannah_mairs ierr = MPI_Allreduce(&eventInfo[event].GpuToCpuSize, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1649*bec0b493Shannah_mairs #endif 16505c6c1daeSBarry Smith name = stageLog->eventLog->eventInfo[event].name; 16515c6c1daeSBarry Smith } else { 16525c6c1daeSBarry Smith flopr = 0.0; 165350a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 165450a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 165550a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 165650a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 165750a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 165850a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 165950a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 166050a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 166150a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1662217044c2SLisandro Dalcin ierr = MPI_Allreduce(&ierr, &minC, 1, MPI_INT, MPI_MIN, comm);CHKERRQ(ierr); 1663217044c2SLisandro Dalcin ierr = MPI_Allreduce(&ierr, &maxC, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1664e3ed9ee7SBarry Smith if (PetscLogMemory) { 1665e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&zero, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1666e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&zero, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1667e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&zero, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1668e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&zero, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1669e3ed9ee7SBarry Smith } 1670*bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1671*bec0b493Shannah_mairs ierr = MPI_Allreduce(&zero, &cct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1672*bec0b493Shannah_mairs ierr = MPI_Allreduce(&zero, &gct, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1673*bec0b493Shannah_mairs ierr = MPI_Allreduce(&zero, &csz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1674*bec0b493Shannah_mairs ierr = MPI_Allreduce(&zero, &gsz, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1675*bec0b493Shannah_mairs #endif 16765c6c1daeSBarry Smith name = ""; 16775c6c1daeSBarry Smith } 16785c6c1daeSBarry Smith if (mint < 0.0) { 16795c6c1daeSBarry 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); 16805c6c1daeSBarry Smith mint = 0; 16815c6c1daeSBarry Smith } 1682d4aa7d5fSBarry Smith if (minf < 0.0) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Minimum flop %g over all processors for %s is negative! Not possible!",minf,name); 16835c6c1daeSBarry Smith totm *= 0.5; totml *= 0.5; totr /= size; 16845c6c1daeSBarry Smith 1685217044c2SLisandro Dalcin if (maxC != 0) { 1686217044c2SLisandro Dalcin if (minC != 0) ratC = ((PetscLogDouble)maxC)/minC;else ratC = 0.0; 16875c6c1daeSBarry Smith if (mint != 0.0) ratt = maxt/mint; else ratt = 0.0; 16885c6c1daeSBarry Smith if (minf != 0.0) ratf = maxf/minf; else ratf = 0.0; 16895c6c1daeSBarry Smith if (TotalTime != 0.0) fracTime = tott/TotalTime; else fracTime = 0.0; 16905c6c1daeSBarry Smith if (TotalFlops != 0.0) fracFlops = totf/TotalFlops; else fracFlops = 0.0; 16915c6c1daeSBarry Smith if (stageTime != 0.0) fracStageTime = tott/stageTime; else fracStageTime = 0.0; 16925c6c1daeSBarry Smith if (flops != 0.0) fracStageFlops = totf/flops; else fracStageFlops = 0.0; 16935c6c1daeSBarry Smith if (numMessages != 0.0) fracMess = totm/numMessages; else fracMess = 0.0; 16945c6c1daeSBarry Smith if (messageLength != 0.0) fracMessLen = totml/messageLength; else fracMessLen = 0.0; 16955c6c1daeSBarry Smith if (numReductions != 0.0) fracRed = totr/numReductions; else fracRed = 0.0; 16965c6c1daeSBarry Smith if (mess != 0.0) fracStageMess = totm/mess; else fracStageMess = 0.0; 16975c6c1daeSBarry Smith if (messLen != 0.0) fracStageMessLen = totml/messLen; else fracStageMessLen = 0.0; 16985c6c1daeSBarry Smith if (red != 0.0) fracStageRed = totr/red; else fracStageRed = 0.0; 16995c6c1daeSBarry Smith if (totm != 0.0) totml /= totm; else totml = 0.0; 17005c6c1daeSBarry Smith if (maxt != 0.0) flopr = totf/maxt; else flopr = 0.0; 1701411f5eb9SRichard Tran Mills if (fracStageTime > 1.00) ierr = PetscFPrintf(comm, fd,"Warning -- total time of event greater than time of entire stage -- something is wrong with the timer\n");CHKERRQ(ierr); 17025c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, 1703e3ed9ee7SBarry 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", 1704217044c2SLisandro Dalcin name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr, 17055c6c1daeSBarry Smith 100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed, 17065c6c1daeSBarry Smith 100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed, 1707c068d9bbSLisandro Dalcin PetscAbs(flopr)/1.0e6);CHKERRQ(ierr); 1708e3ed9ee7SBarry Smith if (PetscLogMemory) { 1709*bec0b493Shannah_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); 1710e3ed9ee7SBarry Smith } 1711*bec0b493Shannah_mairs #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA) 1712*bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd," %4.0f %3.2e %4.0f %3.2e", cct, csz/1.0e6, gct, gsz/1.0e6);CHKERRQ(ierr); 1713*bec0b493Shannah_mairs #endif 1714*bec0b493Shannah_mairs ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 17155c6c1daeSBarry Smith } 17165c6c1daeSBarry Smith } 17175c6c1daeSBarry Smith } 17185c6c1daeSBarry Smith 17195c6c1daeSBarry Smith /* Memory usage and object creation */ 1720a297a907SKarl Rupp ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 17215c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 17225c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n");CHKERRQ(ierr); 17235c6c1daeSBarry Smith 17245c6c1daeSBarry Smith /* Right now, only stages on the first processor are reported here, meaning only objects associated with 17255c6c1daeSBarry Smith the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then 17265c6c1daeSBarry Smith stats for stages local to processor sets. 17275c6c1daeSBarry Smith */ 17285c6c1daeSBarry Smith /* We should figure out the longest object name here (now 20 characters) */ 17295c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Object Type Creations Destructions Memory Descendants' Mem.\n");CHKERRQ(ierr); 17305c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Reports information only for process 0.\n");CHKERRQ(ierr); 17315c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 17325c6c1daeSBarry Smith if (localStageUsed[stage]) { 17335c6c1daeSBarry Smith classInfo = stageLog->stageInfo[stage].classLog->classInfo; 17345c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 17355c6c1daeSBarry Smith for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) { 17365c6c1daeSBarry Smith if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) { 17375c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%20s %5d %5d %11.0f %g\n", stageLog->classLog->classInfo[oclass].name, 17385c6c1daeSBarry Smith classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem, 17395c6c1daeSBarry Smith classInfo[oclass].descMem);CHKERRQ(ierr); 17405c6c1daeSBarry Smith } 17415c6c1daeSBarry Smith } 17425c6c1daeSBarry Smith } else { 1743cf019ec6SStefano Zampini if (!localStageVisible[stage]) continue; 17445c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 17455c6c1daeSBarry Smith } 17465c6c1daeSBarry Smith } 17475c6c1daeSBarry Smith 17485c6c1daeSBarry Smith ierr = PetscFree(localStageUsed);CHKERRQ(ierr); 17495c6c1daeSBarry Smith ierr = PetscFree(stageUsed);CHKERRQ(ierr); 17505c6c1daeSBarry Smith ierr = PetscFree(localStageVisible);CHKERRQ(ierr); 17515c6c1daeSBarry Smith ierr = PetscFree(stageVisible);CHKERRQ(ierr); 17525c6c1daeSBarry Smith 17535c6c1daeSBarry Smith /* Information unrelated to this particular run */ 1754a297a907SKarl Rupp ierr = PetscFPrintf(comm, fd, "========================================================================================================================\n");CHKERRQ(ierr); 17558563dfccSBarry Smith PetscTime(&y); 17568563dfccSBarry Smith PetscTime(&x); 17578563dfccSBarry Smith PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 17588563dfccSBarry Smith PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 17595c6c1daeSBarry Smith ierr = PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0);CHKERRQ(ierr); 17605c6c1daeSBarry Smith /* MPI information */ 17615c6c1daeSBarry Smith if (size > 1) { 17625c6c1daeSBarry Smith MPI_Status status; 17635c6c1daeSBarry Smith PetscMPIInt tag; 17645c6c1daeSBarry Smith MPI_Comm newcomm; 17655c6c1daeSBarry Smith 17665c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 17678563dfccSBarry Smith PetscTime(&x); 17685c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 17695c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 17705c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 17715c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 17725c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 17738563dfccSBarry Smith PetscTime(&y); 17745c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0);CHKERRQ(ierr); 17755c6c1daeSBarry Smith ierr = PetscCommDuplicate(comm,&newcomm, &tag);CHKERRQ(ierr); 17765c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 17775c6c1daeSBarry Smith if (rank) { 1778217044c2SLisandro Dalcin ierr = MPI_Recv(NULL, 0, MPI_INT, rank-1, tag, newcomm, &status);CHKERRQ(ierr); 1779217044c2SLisandro Dalcin ierr = MPI_Send(NULL, 0, MPI_INT, (rank+1)%size, tag, newcomm);CHKERRQ(ierr); 17805c6c1daeSBarry Smith } else { 17818563dfccSBarry Smith PetscTime(&x); 1782217044c2SLisandro Dalcin ierr = MPI_Send(NULL, 0, MPI_INT, 1, tag, newcomm);CHKERRQ(ierr); 1783217044c2SLisandro Dalcin ierr = MPI_Recv(NULL, 0, MPI_INT, size-1, tag, newcomm, &status);CHKERRQ(ierr); 17848563dfccSBarry Smith PetscTime(&y); 17855c6c1daeSBarry Smith ierr = PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size);CHKERRQ(ierr); 17865c6c1daeSBarry Smith } 17875c6c1daeSBarry Smith ierr = PetscCommDestroy(&newcomm);CHKERRQ(ierr); 17885c6c1daeSBarry Smith } 1789c5929fdfSBarry Smith ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr); 17905c6c1daeSBarry Smith 17915c6c1daeSBarry Smith /* Machine and compile information */ 17925c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS) 17935c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n");CHKERRQ(ierr); 17945c6c1daeSBarry Smith #else 17955c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n");CHKERRQ(ierr); 17965c6c1daeSBarry Smith #endif 1797217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) 1798217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n");CHKERRQ(ierr); 1799217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128) 1800217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n");CHKERRQ(ierr); 1801217044c2SLisandro Dalcin #endif 18025c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 18035c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 18045f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128) 18055f27b2e0SBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 18065c6c1daeSBarry Smith #endif 18075c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE) 18085c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with single precision matrices\n");CHKERRQ(ierr); 18095c6c1daeSBarry Smith #else 18105c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n");CHKERRQ(ierr); 18115c6c1daeSBarry Smith #endif 18125c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n", 18135c6c1daeSBarry Smith (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt));CHKERRQ(ierr); 18145c6c1daeSBarry Smith 18155c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions);CHKERRQ(ierr); 18165c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petscmachineinfo);CHKERRQ(ierr); 18175c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsccompilerinfo);CHKERRQ(ierr); 18185c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo);CHKERRQ(ierr); 18195c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsclinkerinfo);CHKERRQ(ierr); 18205c6c1daeSBarry Smith 18215c6c1daeSBarry Smith /* Cleanup */ 18225c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 1823f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 18245c6c1daeSBarry Smith PetscFunctionReturn(0); 18255c6c1daeSBarry Smith } 18265c6c1daeSBarry Smith 18277d6c928cSSatish Balay /*@C 18287d6c928cSSatish Balay PetscLogView - Prints a summary of the logging. 18295c6c1daeSBarry Smith 18305c6c1daeSBarry Smith Collective over MPI_Comm 18315c6c1daeSBarry Smith 18325c6c1daeSBarry Smith Input Parameter: 1833f14045dbSBarry Smith . viewer - an ASCII viewer 18345c6c1daeSBarry Smith 18355c6c1daeSBarry Smith Options Database Keys: 1836bb1d7374SBarry Smith + -log_view [:filename] - Prints summary of log information 1837bb1d7374SBarry Smith . -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file 1838607d249eSBarry 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) 1839bb1d7374SBarry Smith . -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation 1840bb1d7374SBarry Smith - -log_trace [filename] - Displays a trace of what each process is doing 18415c6c1daeSBarry Smith 18425c6c1daeSBarry Smith Notes: 1843bb1d7374SBarry Smith It is possible to control the logging programatically but we recommend using the options database approach whenever possible 18445c6c1daeSBarry Smith By default the summary is printed to stdout. 18455c6c1daeSBarry Smith 1846bb1d7374SBarry Smith Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin() 1847bb1d7374SBarry Smith 1848bb1d7374SBarry Smith If PETSc is configured with --with-logging=0 then this functionality is not available 1849bb1d7374SBarry Smith 1850607d249eSBarry Smith To view the nested XML format filename.xml first copy ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current 1851607d249eSBarry Smith directory then open filename.xml with your browser. Specific notes for certain browsers 1852607d249eSBarry Smith $ Firefox and Internet explorer - simply open the file 1853607d249eSBarry Smith $ Google Chrome - you must start up Chrome with the option --allow-file-access-from-files 1854a8d69d7bSBarry Smith $ Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access 1855607d249eSBarry 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 1856607d249eSBarry Smith your browser. 18572add09c0SLisandro Dalcin Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser 18582add09c0SLisandro Dalcin window and render the XML log file contents. 1859607d249eSBarry Smith 1860bb1d7374SBarry Smith The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij MARITIME RESEARCH INSTITUTE NETHERLANDS 1861bb1d7374SBarry Smith 18625c6c1daeSBarry Smith Level: beginner 18635c6c1daeSBarry Smith 1864bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogDump() 18655c6c1daeSBarry Smith @*/ 1866f14045dbSBarry Smith PetscErrorCode PetscLogView(PetscViewer viewer) 18675c6c1daeSBarry Smith { 18685c6c1daeSBarry Smith PetscErrorCode ierr; 1869f14045dbSBarry Smith PetscBool isascii; 1870f14045dbSBarry Smith PetscViewerFormat format; 187137b78d16SBarry Smith int stage, lastStage; 187237b78d16SBarry Smith PetscStageLog stageLog; 18735c6c1daeSBarry Smith 18745c6c1daeSBarry Smith PetscFunctionBegin; 1875609bdbeeSBarry Smith if (!PetscLogPLB) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Must use -log_view or PetscLogDefaultBegin() before calling this routine"); 187637b78d16SBarry Smith /* Pop off any stages the user forgot to remove */ 187737b78d16SBarry Smith lastStage = 0; 187837b78d16SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 187937b78d16SBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 188037b78d16SBarry Smith while (stage >= 0) { 188137b78d16SBarry Smith lastStage = stage; 188237b78d16SBarry Smith ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 188337b78d16SBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 188437b78d16SBarry Smith } 1885f14045dbSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 1886f14045dbSBarry Smith if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Currently can only view logging to ASCII"); 1887f14045dbSBarry Smith ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr); 1888f14045dbSBarry Smith if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) { 1889f14045dbSBarry Smith ierr = PetscLogView_Default(viewer);CHKERRQ(ierr); 1890f14045dbSBarry Smith } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) { 1891f14045dbSBarry Smith ierr = PetscLogView_Detailed(viewer);CHKERRQ(ierr); 189238144912Sdeepblu2718 } else if (format == PETSC_VIEWER_ASCII_CSV) { 189338144912Sdeepblu2718 ierr = PetscLogView_CSV(viewer);CHKERRQ(ierr); 1894bb1d7374SBarry Smith } else if (format == PETSC_VIEWER_ASCII_XML) { 1895bb1d7374SBarry Smith ierr = PetscLogView_Nested(viewer);CHKERRQ(ierr); 18965c6c1daeSBarry Smith } 189737b78d16SBarry Smith ierr = PetscStageLogPush(stageLog, lastStage);CHKERRQ(ierr); 18985c6c1daeSBarry Smith PetscFunctionReturn(0); 18995c6c1daeSBarry Smith } 19005c6c1daeSBarry Smith 1901f14045dbSBarry Smith /*@C 1902f14045dbSBarry Smith PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed. 1903f14045dbSBarry Smith 1904f14045dbSBarry Smith Collective on PETSC_COMM_WORLD 1905f14045dbSBarry Smith 1906f14045dbSBarry Smith Not normally called by user 1907f14045dbSBarry Smith 1908f14045dbSBarry Smith Level: intermediate 1909f14045dbSBarry Smith 1910f14045dbSBarry Smith @*/ 1911f14045dbSBarry Smith PetscErrorCode PetscLogViewFromOptions(void) 1912f14045dbSBarry Smith { 1913f14045dbSBarry Smith PetscErrorCode ierr; 1914f14045dbSBarry Smith PetscViewer viewer; 1915f14045dbSBarry Smith PetscBool flg; 1916f14045dbSBarry Smith PetscViewerFormat format; 1917f14045dbSBarry Smith 1918f14045dbSBarry Smith PetscFunctionBegin; 191916413a6aSBarry Smith ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-log_view",&viewer,&format,&flg);CHKERRQ(ierr); 1920f14045dbSBarry Smith if (flg) { 1921f14045dbSBarry Smith ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 1922f14045dbSBarry Smith ierr = PetscLogView(viewer);CHKERRQ(ierr); 1923f14045dbSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 1924f14045dbSBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1925f14045dbSBarry Smith } 1926f14045dbSBarry Smith PetscFunctionReturn(0); 1927f14045dbSBarry Smith } 1928f14045dbSBarry Smith 1929f14045dbSBarry Smith 1930f14045dbSBarry Smith 19315c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/ 19325c6c1daeSBarry Smith /*@C 19335c6c1daeSBarry Smith PetscGetFlops - Returns the number of flops used on this processor 19345c6c1daeSBarry Smith since the program began. 19355c6c1daeSBarry Smith 19365c6c1daeSBarry Smith Not Collective 19375c6c1daeSBarry Smith 19385c6c1daeSBarry Smith Output Parameter: 19395c6c1daeSBarry Smith flops - number of floating point operations 19405c6c1daeSBarry Smith 19415c6c1daeSBarry Smith Notes: 19425c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 19435c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 19445c6c1daeSBarry Smith application code. 19455c6c1daeSBarry Smith 19465c6c1daeSBarry Smith Level: intermediate 19475c6c1daeSBarry Smith 19488563dfccSBarry Smith .seealso: PetscTime(), PetscLogFlops() 19495c6c1daeSBarry Smith @*/ 19505c6c1daeSBarry Smith PetscErrorCode PetscGetFlops(PetscLogDouble *flops) 19515c6c1daeSBarry Smith { 19525c6c1daeSBarry Smith PetscFunctionBegin; 19535c6c1daeSBarry Smith *flops = petsc_TotalFlops; 19545c6c1daeSBarry Smith PetscFunctionReturn(0); 19555c6c1daeSBarry Smith } 19565c6c1daeSBarry Smith 19575c6c1daeSBarry Smith PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 19585c6c1daeSBarry Smith { 19595c6c1daeSBarry Smith PetscErrorCode ierr; 19605c6c1daeSBarry Smith size_t fullLength; 19615c6c1daeSBarry Smith va_list Argp; 19625c6c1daeSBarry Smith 19635c6c1daeSBarry Smith PetscFunctionBegin; 19645c6c1daeSBarry Smith if (!petsc_logObjects) PetscFunctionReturn(0); 19655c6c1daeSBarry Smith va_start(Argp, format); 19665c6c1daeSBarry Smith ierr = PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp);CHKERRQ(ierr); 19675c6c1daeSBarry Smith va_end(Argp); 19685c6c1daeSBarry Smith PetscFunctionReturn(0); 19695c6c1daeSBarry Smith } 19705c6c1daeSBarry Smith 19715c6c1daeSBarry Smith 19725c6c1daeSBarry Smith /*MC 19735c6c1daeSBarry Smith PetscLogFlops - Adds floating point operations to the global counter. 19745c6c1daeSBarry Smith 19755c6c1daeSBarry Smith Synopsis: 1976aaa7dc30SBarry Smith #include <petsclog.h> 19775c6c1daeSBarry Smith PetscErrorCode PetscLogFlops(PetscLogDouble f) 19785c6c1daeSBarry Smith 19795c6c1daeSBarry Smith Not Collective 19805c6c1daeSBarry Smith 19815c6c1daeSBarry Smith Input Parameter: 19825c6c1daeSBarry Smith . f - flop counter 19835c6c1daeSBarry Smith 19845c6c1daeSBarry Smith 19855c6c1daeSBarry Smith Usage: 19865c6c1daeSBarry Smith .vb 19875c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 19885c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 19895c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 19905c6c1daeSBarry Smith [code segment to monitor] 19915c6c1daeSBarry Smith PetscLogFlops(user_flops) 19925c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 19935c6c1daeSBarry Smith .ve 19945c6c1daeSBarry Smith 19955c6c1daeSBarry Smith Notes: 19965c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 19975c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 19985c6c1daeSBarry Smith application code. 19995c6c1daeSBarry Smith 20005c6c1daeSBarry Smith Level: intermediate 20015c6c1daeSBarry Smith 20025c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscGetFlops() 20035c6c1daeSBarry Smith 20045c6c1daeSBarry Smith M*/ 20055c6c1daeSBarry Smith 20065c6c1daeSBarry Smith /*MC 20075c6c1daeSBarry Smith PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice) 20085c6c1daeSBarry Smith to get accurate timings 20095c6c1daeSBarry Smith 20105c6c1daeSBarry Smith Synopsis: 2011aaa7dc30SBarry Smith #include <petsclog.h> 20125c6c1daeSBarry Smith void PetscPreLoadBegin(PetscBool flag,char *name); 20135c6c1daeSBarry Smith 20145c6c1daeSBarry Smith Not Collective 20155c6c1daeSBarry Smith 20165c6c1daeSBarry Smith Input Parameter: 20175c6c1daeSBarry Smith + flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden 20185c6c1daeSBarry Smith with command line option -preload true or -preload false 2019609bdbeeSBarry Smith - name - name of first stage (lines of code timed separately with -log_view) to 20205c6c1daeSBarry Smith be preloaded 20215c6c1daeSBarry Smith 20225c6c1daeSBarry Smith Usage: 20235c6c1daeSBarry Smith .vb 20245c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 20255c6c1daeSBarry Smith lines of code 20265c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 20275c6c1daeSBarry Smith lines of code 20285c6c1daeSBarry Smith PetscPreLoadEnd(); 20295c6c1daeSBarry Smith .ve 20305c6c1daeSBarry Smith 203195452b02SPatrick Sanan Notes: 203295452b02SPatrick Sanan Only works in C/C++, not Fortran 20335c6c1daeSBarry Smith 20345c6c1daeSBarry Smith Flags available within the macro. 20355c6c1daeSBarry Smith + PetscPreLoadingUsed - true if we are or have done preloading 20365c6c1daeSBarry Smith . PetscPreLoadingOn - true if it is CURRENTLY doing preload 20375c6c1daeSBarry Smith . PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second 20385c6c1daeSBarry Smith - PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on 20395c6c1daeSBarry Smith The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin() 20405c6c1daeSBarry Smith and PetscPreLoadEnd() 20415c6c1daeSBarry Smith 20425c6c1daeSBarry Smith Level: intermediate 20435c6c1daeSBarry Smith 20445c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage() 20455c6c1daeSBarry Smith 20465c6c1daeSBarry Smith Concepts: preloading 20475c6c1daeSBarry Smith Concepts: timing^accurate 20485c6c1daeSBarry Smith Concepts: paging^eliminating effects of 20495c6c1daeSBarry Smith 20505c6c1daeSBarry Smith 20515c6c1daeSBarry Smith M*/ 20525c6c1daeSBarry Smith 20535c6c1daeSBarry Smith /*MC 20545c6c1daeSBarry Smith PetscPreLoadEnd - End a segment of code that may be preloaded (run twice) 20555c6c1daeSBarry Smith to get accurate timings 20565c6c1daeSBarry Smith 20575c6c1daeSBarry Smith Synopsis: 2058aaa7dc30SBarry Smith #include <petsclog.h> 20595c6c1daeSBarry Smith void PetscPreLoadEnd(void); 20605c6c1daeSBarry Smith 20615c6c1daeSBarry Smith Not Collective 20625c6c1daeSBarry Smith 20635c6c1daeSBarry Smith Usage: 20645c6c1daeSBarry Smith .vb 20655c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 20665c6c1daeSBarry Smith lines of code 20675c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 20685c6c1daeSBarry Smith lines of code 20695c6c1daeSBarry Smith PetscPreLoadEnd(); 20705c6c1daeSBarry Smith .ve 20715c6c1daeSBarry Smith 207295452b02SPatrick Sanan Notes: 207395452b02SPatrick Sanan only works in C/C++ not fortran 20745c6c1daeSBarry Smith 20755c6c1daeSBarry Smith Level: intermediate 20765c6c1daeSBarry Smith 20775c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadStage() 20785c6c1daeSBarry Smith 20795c6c1daeSBarry Smith M*/ 20805c6c1daeSBarry Smith 20815c6c1daeSBarry Smith /*MC 20825c6c1daeSBarry Smith PetscPreLoadStage - Start a new segment of code to be timed separately. 20835c6c1daeSBarry Smith to get accurate timings 20845c6c1daeSBarry Smith 20855c6c1daeSBarry Smith Synopsis: 2086aaa7dc30SBarry Smith #include <petsclog.h> 20875c6c1daeSBarry Smith void PetscPreLoadStage(char *name); 20885c6c1daeSBarry Smith 20895c6c1daeSBarry Smith Not Collective 20905c6c1daeSBarry Smith 20915c6c1daeSBarry Smith Usage: 20925c6c1daeSBarry Smith .vb 20935c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 20945c6c1daeSBarry Smith lines of code 20955c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 20965c6c1daeSBarry Smith lines of code 20975c6c1daeSBarry Smith PetscPreLoadEnd(); 20985c6c1daeSBarry Smith .ve 20995c6c1daeSBarry Smith 210095452b02SPatrick Sanan Notes: 210195452b02SPatrick Sanan only works in C/C++ not fortran 21025c6c1daeSBarry Smith 21035c6c1daeSBarry Smith Level: intermediate 21045c6c1daeSBarry Smith 21055c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd() 21065c6c1daeSBarry Smith 21075c6c1daeSBarry Smith M*/ 21085c6c1daeSBarry Smith 21095c6c1daeSBarry Smith 21105c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */ 21115c6c1daeSBarry Smith 21125c6c1daeSBarry Smith PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 21135c6c1daeSBarry Smith { 21145c6c1daeSBarry Smith PetscFunctionBegin; 21155c6c1daeSBarry Smith PetscFunctionReturn(0); 21165c6c1daeSBarry Smith } 21175c6c1daeSBarry Smith 21185c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/ 21195c6c1daeSBarry Smith 21205c6c1daeSBarry Smith 21215c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 21225c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID = 0; 21235c6c1daeSBarry Smith 21245c6c1daeSBarry Smith /*@C 21255c6c1daeSBarry Smith PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code. 21265c6c1daeSBarry Smith 21275c6c1daeSBarry Smith Not Collective 21285c6c1daeSBarry Smith 21295c6c1daeSBarry Smith Input Parameter: 21305c6c1daeSBarry Smith . name - The class name 21315c6c1daeSBarry Smith 21325c6c1daeSBarry Smith Output Parameter: 21335c6c1daeSBarry Smith . oclass - The class id or classid 21345c6c1daeSBarry Smith 21355c6c1daeSBarry Smith Level: developer 21365c6c1daeSBarry Smith 21375c6c1daeSBarry Smith @*/ 21385c6c1daeSBarry Smith PetscErrorCode PetscClassIdRegister(const char name[],PetscClassId *oclass) 21395c6c1daeSBarry Smith { 21405c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 21415c6c1daeSBarry Smith PetscStageLog stageLog; 21425c6c1daeSBarry Smith PetscInt stage; 21435c6c1daeSBarry Smith PetscErrorCode ierr; 21445c6c1daeSBarry Smith #endif 21455c6c1daeSBarry Smith 21465c6c1daeSBarry Smith PetscFunctionBegin; 21475c6c1daeSBarry Smith *oclass = ++PETSC_LARGEST_CLASSID; 21485c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 21495c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 21505c6c1daeSBarry Smith ierr = PetscClassRegLogRegister(stageLog->classLog, name, *oclass);CHKERRQ(ierr); 21515c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 21523a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 21535c6c1daeSBarry Smith } 21545c6c1daeSBarry Smith #endif 21555c6c1daeSBarry Smith PetscFunctionReturn(0); 21565c6c1daeSBarry Smith } 2157210b5426SBarry Smith 2158210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE) 2159210b5426SBarry Smith #include <mpe.h> 2160210b5426SBarry Smith 2161210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE; 2162210b5426SBarry Smith 2163495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2164495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2165495fc317SBarry Smith 2166210b5426SBarry Smith /*@C 2167210b5426SBarry Smith PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files 2168210b5426SBarry Smith and slows the program down. 2169210b5426SBarry Smith 2170210b5426SBarry Smith Collective over PETSC_COMM_WORLD 2171210b5426SBarry Smith 2172210b5426SBarry Smith Options Database Keys: 2173a2553e36SBarry Smith . -log_mpe - Prints extensive log information 2174210b5426SBarry Smith 2175210b5426SBarry Smith Notes: 2176609bdbeeSBarry Smith A related routine is PetscLogDefaultBegin() (with the options key -log_view), which is 2177210b5426SBarry Smith intended for production runs since it logs only flop rates and object 2178210b5426SBarry Smith creation (and should not significantly slow the programs). 2179210b5426SBarry Smith 2180210b5426SBarry Smith Level: advanced 2181210b5426SBarry Smith 2182210b5426SBarry Smith Concepts: logging^MPE 2183210b5426SBarry Smith Concepts: logging^message passing 2184210b5426SBarry Smith 2185bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogEventActivate(), 2186210b5426SBarry Smith PetscLogEventDeactivate() 2187210b5426SBarry Smith @*/ 2188210b5426SBarry Smith PetscErrorCode PetscLogMPEBegin(void) 2189210b5426SBarry Smith { 2190210b5426SBarry Smith PetscErrorCode ierr; 2191210b5426SBarry Smith 2192210b5426SBarry Smith PetscFunctionBegin; 2193210b5426SBarry Smith /* Do MPE initialization */ 2194210b5426SBarry Smith if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */ 2195210b5426SBarry Smith ierr = PetscInfo(0,"Initializing MPE.\n");CHKERRQ(ierr); 2196210b5426SBarry Smith ierr = MPE_Init_log();CHKERRQ(ierr); 2197210b5426SBarry Smith 2198210b5426SBarry Smith PetscBeganMPE = PETSC_TRUE; 2199210b5426SBarry Smith } else { 2200210b5426SBarry Smith ierr = PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n");CHKERRQ(ierr); 2201210b5426SBarry Smith } 2202495fc317SBarry Smith ierr = PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE);CHKERRQ(ierr); 2203210b5426SBarry Smith PetscFunctionReturn(0); 2204210b5426SBarry Smith } 2205210b5426SBarry Smith 2206210b5426SBarry Smith /*@C 2207495fc317SBarry Smith PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot. 2208210b5426SBarry Smith 2209210b5426SBarry Smith Collective over PETSC_COMM_WORLD 2210210b5426SBarry Smith 2211210b5426SBarry Smith Level: advanced 2212210b5426SBarry Smith 2213210b5426SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogMPEBegin() 2214210b5426SBarry Smith @*/ 2215210b5426SBarry Smith PetscErrorCode PetscLogMPEDump(const char sname[]) 2216210b5426SBarry Smith { 2217210b5426SBarry Smith char name[PETSC_MAX_PATH_LEN]; 2218210b5426SBarry Smith PetscErrorCode ierr; 2219210b5426SBarry Smith 2220210b5426SBarry Smith PetscFunctionBegin; 2221210b5426SBarry Smith if (PetscBeganMPE) { 2222210b5426SBarry Smith ierr = PetscInfo(0,"Finalizing MPE.\n");CHKERRQ(ierr); 2223210b5426SBarry Smith if (sname) { 2224210b5426SBarry Smith ierr = PetscStrcpy(name,sname);CHKERRQ(ierr); 2225210b5426SBarry Smith } else { 2226210b5426SBarry Smith ierr = PetscGetProgramName(name,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 2227210b5426SBarry Smith } 2228210b5426SBarry Smith ierr = MPE_Finish_log(name);CHKERRQ(ierr); 2229210b5426SBarry Smith } else { 2230210b5426SBarry Smith ierr = PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n");CHKERRQ(ierr); 2231210b5426SBarry Smith } 2232210b5426SBarry Smith PetscFunctionReturn(0); 2233210b5426SBarry Smith } 2234210b5426SBarry Smith 2235210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39 2236210b5426SBarry Smith static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = { 2237210b5426SBarry Smith "OliveDrab: ", 2238210b5426SBarry Smith "BlueViolet: ", 2239210b5426SBarry Smith "CadetBlue: ", 2240210b5426SBarry Smith "CornflowerBlue: ", 2241210b5426SBarry Smith "DarkGoldenrod: ", 2242210b5426SBarry Smith "DarkGreen: ", 2243210b5426SBarry Smith "DarkKhaki: ", 2244210b5426SBarry Smith "DarkOliveGreen: ", 2245210b5426SBarry Smith "DarkOrange: ", 2246210b5426SBarry Smith "DarkOrchid: ", 2247210b5426SBarry Smith "DarkSeaGreen: ", 2248210b5426SBarry Smith "DarkSlateGray: ", 2249210b5426SBarry Smith "DarkTurquoise: ", 2250210b5426SBarry Smith "DeepPink: ", 2251210b5426SBarry Smith "DarkKhaki: ", 2252210b5426SBarry Smith "DimGray: ", 2253210b5426SBarry Smith "DodgerBlue: ", 2254210b5426SBarry Smith "GreenYellow: ", 2255210b5426SBarry Smith "HotPink: ", 2256210b5426SBarry Smith "IndianRed: ", 2257210b5426SBarry Smith "LavenderBlush: ", 2258210b5426SBarry Smith "LawnGreen: ", 2259210b5426SBarry Smith "LemonChiffon: ", 2260210b5426SBarry Smith "LightCoral: ", 2261210b5426SBarry Smith "LightCyan: ", 2262210b5426SBarry Smith "LightPink: ", 2263210b5426SBarry Smith "LightSalmon: ", 2264210b5426SBarry Smith "LightSlateGray: ", 2265210b5426SBarry Smith "LightYellow: ", 2266210b5426SBarry Smith "LimeGreen: ", 2267210b5426SBarry Smith "MediumPurple: ", 2268210b5426SBarry Smith "MediumSeaGreen: ", 2269210b5426SBarry Smith "MediumSlateBlue:", 2270210b5426SBarry Smith "MidnightBlue: ", 2271210b5426SBarry Smith "MintCream: ", 2272210b5426SBarry Smith "MistyRose: ", 2273210b5426SBarry Smith "NavajoWhite: ", 2274210b5426SBarry Smith "NavyBlue: ", 2275210b5426SBarry Smith "OliveDrab: " 2276210b5426SBarry Smith }; 2277210b5426SBarry Smith 2278210b5426SBarry Smith /*@C 2279210b5426SBarry Smith PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister() 2280210b5426SBarry Smith 2281210b5426SBarry Smith Not collective. Maybe it should be? 2282210b5426SBarry Smith 2283210b5426SBarry Smith Output Parameter 2284210b5426SBarry Smith . str - character string representing the color 2285210b5426SBarry Smith 2286210b5426SBarry Smith Level: developer 2287210b5426SBarry Smith 2288210b5426SBarry Smith .seealso: PetscLogEventRegister 2289210b5426SBarry Smith @*/ 2290210b5426SBarry Smith PetscErrorCode PetscLogMPEGetRGBColor(const char *str[]) 2291210b5426SBarry Smith { 2292210b5426SBarry Smith static int idx = 0; 2293210b5426SBarry Smith 2294210b5426SBarry Smith PetscFunctionBegin; 2295210b5426SBarry Smith *str = PetscLogMPERGBColors[idx]; 2296210b5426SBarry Smith idx = (idx + 1)% PETSC_RGB_COLORS_MAX; 2297210b5426SBarry Smith PetscFunctionReturn(0); 2298210b5426SBarry Smith } 2299210b5426SBarry Smith 2300210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */ 2301