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 */ 835c6c1daeSBarry Smith 845c6c1daeSBarry Smith /* Logging functions */ 850298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL; 860298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL; 870298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 880298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 895c6c1daeSBarry Smith 905c6c1daeSBarry Smith /* Tracing event logging variables */ 910298fd71SBarry Smith FILE *petsc_tracefile = NULL; 925c6c1daeSBarry Smith int petsc_tracelevel = 0; 935c6c1daeSBarry Smith const char *petsc_traceblanks = " "; 945c6c1daeSBarry Smith char petsc_tracespace[128] = " "; 955c6c1daeSBarry Smith PetscLogDouble petsc_tracetime = 0.0; 96896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE; 975c6c1daeSBarry Smith 9895c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogInitialize(void) 99fa2bb9feSLisandro Dalcin { 100fa2bb9feSLisandro Dalcin int stage; 101fa2bb9feSLisandro Dalcin PetscBool opt; 102fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 1035c6c1daeSBarry Smith 104fa2bb9feSLisandro Dalcin PetscFunctionBegin; 105fa2bb9feSLisandro Dalcin if (PetscLogInitializeCalled) PetscFunctionReturn(0); 106fa2bb9feSLisandro Dalcin PetscLogInitializeCalled = PETSC_TRUE; 1075c6c1daeSBarry Smith 108fa2bb9feSLisandro Dalcin ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_actions", &opt);CHKERRQ(ierr); 109fa2bb9feSLisandro Dalcin if (opt) petsc_logActions = PETSC_FALSE; 110fa2bb9feSLisandro Dalcin ierr = PetscOptionsHasName(NULL,NULL, "-log_exclude_objects", &opt);CHKERRQ(ierr); 111fa2bb9feSLisandro Dalcin if (opt) petsc_logObjects = PETSC_FALSE; 112fa2bb9feSLisandro Dalcin if (petsc_logActions) { 113fa2bb9feSLisandro Dalcin ierr = PetscMalloc1(petsc_maxActions, &petsc_actions);CHKERRQ(ierr); 114fa2bb9feSLisandro Dalcin } 115fa2bb9feSLisandro Dalcin if (petsc_logObjects) { 116fa2bb9feSLisandro Dalcin ierr = PetscMalloc1(petsc_maxObjects, &petsc_objects);CHKERRQ(ierr); 117fa2bb9feSLisandro Dalcin } 118fa2bb9feSLisandro Dalcin PetscLogPHC = PetscLogObjCreateDefault; 119fa2bb9feSLisandro Dalcin PetscLogPHD = PetscLogObjDestroyDefault; 120fa2bb9feSLisandro Dalcin /* Setup default logging structures */ 121fa2bb9feSLisandro Dalcin ierr = PetscStageLogCreate(&petsc_stageLog);CHKERRQ(ierr); 122fa2bb9feSLisandro Dalcin ierr = PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage);CHKERRQ(ierr); 1235c6c1daeSBarry Smith 124fa2bb9feSLisandro Dalcin /* All processors sync here for more consistent logging */ 125fa2bb9feSLisandro Dalcin ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr); 126fa2bb9feSLisandro Dalcin PetscTime(&petsc_BaseTime); 127fa2bb9feSLisandro Dalcin ierr = PetscLogStagePush(stage);CHKERRQ(ierr); 128fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 129fa2bb9feSLisandro Dalcin } 1305c6c1daeSBarry Smith 13195c0884eSLisandro Dalcin PETSC_INTERN PetscErrorCode PetscLogFinalize(void) 1325c6c1daeSBarry Smith { 1335c6c1daeSBarry Smith PetscStageLog stageLog; 1345c6c1daeSBarry Smith PetscErrorCode ierr; 1355c6c1daeSBarry Smith 1365c6c1daeSBarry Smith PetscFunctionBegin; 1375c6c1daeSBarry Smith ierr = PetscFree(petsc_actions);CHKERRQ(ierr); 1385c6c1daeSBarry Smith ierr = PetscFree(petsc_objects);CHKERRQ(ierr); 139eccbb886SLisandro Dalcin ierr = PetscLogNestedEnd();CHKERRQ(ierr); 1400298fd71SBarry Smith ierr = PetscLogSet(NULL, NULL);CHKERRQ(ierr); 1415c6c1daeSBarry Smith 1425c6c1daeSBarry Smith /* Resetting phase */ 1435c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1445c6c1daeSBarry Smith ierr = PetscStageLogDestroy(stageLog);CHKERRQ(ierr); 145a297a907SKarl Rupp 1465c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1475c6c1daeSBarry Smith petsc_numActions = 0; 1485c6c1daeSBarry Smith petsc_numObjects = 0; 1495c6c1daeSBarry Smith petsc_numObjectsDestroyed = 0; 1505c6c1daeSBarry Smith petsc_maxActions = 100; 1515c6c1daeSBarry Smith petsc_maxObjects = 100; 1520298fd71SBarry Smith petsc_actions = NULL; 1530298fd71SBarry Smith petsc_objects = NULL; 1545c6c1daeSBarry Smith petsc_logActions = PETSC_FALSE; 1555c6c1daeSBarry Smith petsc_logObjects = PETSC_FALSE; 1565c6c1daeSBarry Smith petsc_BaseTime = 0.0; 1575c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1585c6c1daeSBarry Smith petsc_tmp_flops = 0.0; 1595c6c1daeSBarry Smith petsc_send_ct = 0.0; 1605c6c1daeSBarry Smith petsc_recv_ct = 0.0; 1615c6c1daeSBarry Smith petsc_send_len = 0.0; 1625c6c1daeSBarry Smith petsc_recv_len = 0.0; 1635c6c1daeSBarry Smith petsc_isend_ct = 0.0; 1645c6c1daeSBarry Smith petsc_irecv_ct = 0.0; 1655c6c1daeSBarry Smith petsc_isend_len = 0.0; 1665c6c1daeSBarry Smith petsc_irecv_len = 0.0; 1675c6c1daeSBarry Smith petsc_wait_ct = 0.0; 1685c6c1daeSBarry Smith petsc_wait_any_ct = 0.0; 1695c6c1daeSBarry Smith petsc_wait_all_ct = 0.0; 1705c6c1daeSBarry Smith petsc_sum_of_waits_ct = 0.0; 1715c6c1daeSBarry Smith petsc_allreduce_ct = 0.0; 1725c6c1daeSBarry Smith petsc_gather_ct = 0.0; 1735c6c1daeSBarry Smith petsc_scatter_ct = 0.0; 1745c6c1daeSBarry Smith PETSC_LARGEST_EVENT = PETSC_EVENT; 1750298fd71SBarry Smith PetscLogPHC = NULL; 1760298fd71SBarry Smith PetscLogPHD = NULL; 1770298fd71SBarry Smith petsc_tracefile = NULL; 1785c6c1daeSBarry Smith petsc_tracelevel = 0; 1795c6c1daeSBarry Smith petsc_traceblanks = " "; 1805c6c1daeSBarry Smith petsc_tracespace[0] = ' '; petsc_tracespace[1] = 0; 1815c6c1daeSBarry Smith petsc_tracetime = 0.0; 1825c6c1daeSBarry Smith PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 1835c6c1daeSBarry Smith PETSC_OBJECT_CLASSID = 0; 1845c6c1daeSBarry Smith petsc_stageLog = 0; 185896238b9SBarry Smith PetscLogInitializeCalled = PETSC_FALSE; 1865c6c1daeSBarry Smith PetscFunctionReturn(0); 1875c6c1daeSBarry Smith } 1885c6c1daeSBarry Smith 1895c6c1daeSBarry Smith /*@C 1905c6c1daeSBarry Smith PetscLogSet - Sets the logging functions called at the beginning and ending of every event. 1915c6c1daeSBarry Smith 1925c6c1daeSBarry Smith Not Collective 1935c6c1daeSBarry Smith 1945c6c1daeSBarry Smith Input Parameters: 1955c6c1daeSBarry Smith + b - The function called at beginning of event 1965c6c1daeSBarry Smith - e - The function called at end of event 1975c6c1daeSBarry Smith 1985c6c1daeSBarry Smith Level: developer 1995c6c1daeSBarry Smith 200bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogTraceBegin() 2015c6c1daeSBarry Smith @*/ 2025c6c1daeSBarry Smith PetscErrorCode PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), 2035c6c1daeSBarry Smith PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject)) 2045c6c1daeSBarry Smith { 2055c6c1daeSBarry Smith PetscFunctionBegin; 2065c6c1daeSBarry Smith PetscLogPLB = b; 2075c6c1daeSBarry Smith PetscLogPLE = e; 2085c6c1daeSBarry Smith PetscFunctionReturn(0); 2095c6c1daeSBarry Smith } 2105c6c1daeSBarry Smith 2115c6c1daeSBarry Smith /*@C 212bb1d7374SBarry Smith PetscLogDefaultBegin - Turns on logging of objects and events. This logs flop 2135c6c1daeSBarry Smith rates and object creation and should not slow programs down too much. 2145c6c1daeSBarry Smith This routine may be called more than once. 2155c6c1daeSBarry Smith 2165c6c1daeSBarry Smith Logically Collective over PETSC_COMM_WORLD 2175c6c1daeSBarry Smith 2185c6c1daeSBarry Smith Options Database Keys: 219a2553e36SBarry Smith . -log_view [viewertype:filename:viewerformat] - Prints summary of flop and timing information to the 220a2553e36SBarry Smith screen (for code configured with --with-log=1 (which is the default)) 2215c6c1daeSBarry Smith 2225c6c1daeSBarry Smith Usage: 2235c6c1daeSBarry Smith .vb 2245c6c1daeSBarry Smith PetscInitialize(...); 225bb1d7374SBarry Smith PetscLogDefaultBegin(); 2265c6c1daeSBarry Smith ... code ... 2275c6c1daeSBarry Smith PetscLogView(viewer); or PetscLogDump(); 2285c6c1daeSBarry Smith PetscFinalize(); 2295c6c1daeSBarry Smith .ve 2305c6c1daeSBarry Smith 2315c6c1daeSBarry Smith Notes: 2325c6c1daeSBarry Smith PetscLogView(viewer) or PetscLogDump() actually cause the printing of 2335c6c1daeSBarry Smith the logging information. 2345c6c1daeSBarry Smith 2355c6c1daeSBarry Smith Level: advanced 2365c6c1daeSBarry Smith 2375c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogTraceBegin() 2385c6c1daeSBarry Smith @*/ 239bb1d7374SBarry Smith PetscErrorCode PetscLogDefaultBegin(void) 2405c6c1daeSBarry Smith { 2415c6c1daeSBarry Smith PetscErrorCode ierr; 2425c6c1daeSBarry Smith 2435c6c1daeSBarry Smith PetscFunctionBegin; 2445c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault);CHKERRQ(ierr); 2455c6c1daeSBarry Smith PetscFunctionReturn(0); 2465c6c1daeSBarry Smith } 2475c6c1daeSBarry Smith 2485c6c1daeSBarry Smith /*@C 2495c6c1daeSBarry Smith PetscLogAllBegin - Turns on extensive logging of objects and events. Logs 2505c6c1daeSBarry Smith all events. This creates large log files and slows the program down. 2515c6c1daeSBarry Smith 2525c6c1daeSBarry Smith Logically Collective on PETSC_COMM_WORLD 2535c6c1daeSBarry Smith 2545c6c1daeSBarry Smith Options Database Keys: 255a2553e36SBarry Smith . -log_all - Prints extensive log information 2565c6c1daeSBarry Smith 2575c6c1daeSBarry Smith Usage: 2585c6c1daeSBarry Smith .vb 2595c6c1daeSBarry Smith PetscInitialize(...); 2605c6c1daeSBarry Smith PetscLogAllBegin(); 2615c6c1daeSBarry Smith ... code ... 2625c6c1daeSBarry Smith PetscLogDump(filename); 2635c6c1daeSBarry Smith PetscFinalize(); 2645c6c1daeSBarry Smith .ve 2655c6c1daeSBarry Smith 2665c6c1daeSBarry Smith Notes: 267bb1d7374SBarry Smith A related routine is PetscLogDefaultBegin() (with the options key -log), which is 2685c6c1daeSBarry Smith intended for production runs since it logs only flop rates and object 2695c6c1daeSBarry Smith creation (and shouldn't significantly slow the programs). 2705c6c1daeSBarry Smith 2715c6c1daeSBarry Smith Level: advanced 2725c6c1daeSBarry Smith 273bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogTraceBegin() 2745c6c1daeSBarry Smith @*/ 2755c6c1daeSBarry Smith PetscErrorCode PetscLogAllBegin(void) 2765c6c1daeSBarry Smith { 2775c6c1daeSBarry Smith PetscErrorCode ierr; 2785c6c1daeSBarry Smith 2795c6c1daeSBarry Smith PetscFunctionBegin; 2805c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete);CHKERRQ(ierr); 2815c6c1daeSBarry Smith PetscFunctionReturn(0); 2825c6c1daeSBarry Smith } 2835c6c1daeSBarry Smith 2845c6c1daeSBarry Smith /*@ 2855c6c1daeSBarry Smith PetscLogTraceBegin - Activates trace logging. Every time a PETSc event 2865c6c1daeSBarry Smith begins or ends, the event name is printed. 2875c6c1daeSBarry Smith 2885c6c1daeSBarry Smith Logically Collective on PETSC_COMM_WORLD 2895c6c1daeSBarry Smith 2905c6c1daeSBarry Smith Input Parameter: 2915c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout) 2925c6c1daeSBarry Smith 2935c6c1daeSBarry Smith Options Database Key: 2945c6c1daeSBarry Smith . -log_trace [filename] - Activates PetscLogTraceBegin() 2955c6c1daeSBarry Smith 2965c6c1daeSBarry Smith Notes: 2975c6c1daeSBarry Smith PetscLogTraceBegin() prints the processor number, the execution time (sec), 2985c6c1daeSBarry Smith then "Event begin:" or "Event end:" followed by the event name. 2995c6c1daeSBarry Smith 3005c6c1daeSBarry Smith PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful 3015c6c1daeSBarry Smith to determine where a program is hanging without running in the 3025c6c1daeSBarry Smith debugger. Can be used in conjunction with the -info option. 3035c6c1daeSBarry Smith 3045c6c1daeSBarry Smith Level: intermediate 3055c6c1daeSBarry Smith 306bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogDefaultBegin() 3075c6c1daeSBarry Smith @*/ 3085c6c1daeSBarry Smith PetscErrorCode PetscLogTraceBegin(FILE *file) 3095c6c1daeSBarry Smith { 3105c6c1daeSBarry Smith PetscErrorCode ierr; 3115c6c1daeSBarry Smith 3125c6c1daeSBarry Smith PetscFunctionBegin; 3135c6c1daeSBarry Smith petsc_tracefile = file; 314a297a907SKarl Rupp 3155c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace);CHKERRQ(ierr); 3165c6c1daeSBarry Smith PetscFunctionReturn(0); 3175c6c1daeSBarry Smith } 3185c6c1daeSBarry Smith 3195c6c1daeSBarry Smith /*@ 3205c6c1daeSBarry Smith PetscLogActions - Determines whether actions are logged for the graphical viewer. 3215c6c1daeSBarry Smith 3225c6c1daeSBarry Smith Not Collective 3235c6c1daeSBarry Smith 3245c6c1daeSBarry Smith Input Parameter: 3255c6c1daeSBarry Smith . flag - PETSC_TRUE if actions are to be logged 3265c6c1daeSBarry Smith 3275c6c1daeSBarry Smith Level: intermediate 3285c6c1daeSBarry Smith 3295c6c1daeSBarry Smith Note: Logging of actions continues to consume more memory as the program 3305c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3315c6c1daeSBarry Smith 3325c6c1daeSBarry Smith Options Database Keys: 3335c6c1daeSBarry Smith . -log_exclude_actions - Turns off actions logging 3345c6c1daeSBarry Smith 3355c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 3365c6c1daeSBarry Smith @*/ 3375c6c1daeSBarry Smith PetscErrorCode PetscLogActions(PetscBool flag) 3385c6c1daeSBarry Smith { 3395c6c1daeSBarry Smith PetscFunctionBegin; 3405c6c1daeSBarry Smith petsc_logActions = flag; 3415c6c1daeSBarry Smith PetscFunctionReturn(0); 3425c6c1daeSBarry Smith } 3435c6c1daeSBarry Smith 3445c6c1daeSBarry Smith /*@ 3455c6c1daeSBarry Smith PetscLogObjects - Determines whether objects are logged for the graphical viewer. 3465c6c1daeSBarry Smith 3475c6c1daeSBarry Smith Not Collective 3485c6c1daeSBarry Smith 3495c6c1daeSBarry Smith Input Parameter: 3505c6c1daeSBarry Smith . flag - PETSC_TRUE if objects are to be logged 3515c6c1daeSBarry Smith 3525c6c1daeSBarry Smith Level: intermediate 3535c6c1daeSBarry Smith 3545c6c1daeSBarry Smith Note: Logging of objects continues to consume more memory as the program 3555c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3565c6c1daeSBarry Smith 3575c6c1daeSBarry Smith Options Database Keys: 3585c6c1daeSBarry Smith . -log_exclude_objects - Turns off objects logging 3595c6c1daeSBarry Smith 3605c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 3615c6c1daeSBarry Smith @*/ 3625c6c1daeSBarry Smith PetscErrorCode PetscLogObjects(PetscBool flag) 3635c6c1daeSBarry Smith { 3645c6c1daeSBarry Smith PetscFunctionBegin; 3655c6c1daeSBarry Smith petsc_logObjects = flag; 3665c6c1daeSBarry Smith PetscFunctionReturn(0); 3675c6c1daeSBarry Smith } 3685c6c1daeSBarry Smith 3695c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/ 3705c6c1daeSBarry Smith /*@C 37174c0405dSRichard Tran Mills PetscLogStageRegister - Attaches a character string name to a logging stage. 3725c6c1daeSBarry Smith 3735c6c1daeSBarry Smith Not Collective 3745c6c1daeSBarry Smith 3755c6c1daeSBarry Smith Input Parameter: 3765c6c1daeSBarry Smith . sname - The name to associate with that stage 3775c6c1daeSBarry Smith 3785c6c1daeSBarry Smith Output Parameter: 3795c6c1daeSBarry Smith . stage - The stage number 3805c6c1daeSBarry Smith 3815c6c1daeSBarry Smith Level: intermediate 3825c6c1daeSBarry Smith 3835c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 3845c6c1daeSBarry Smith @*/ 3855c6c1daeSBarry Smith PetscErrorCode PetscLogStageRegister(const char sname[],PetscLogStage *stage) 3865c6c1daeSBarry Smith { 3875c6c1daeSBarry Smith PetscStageLog stageLog; 3885c6c1daeSBarry Smith PetscLogEvent event; 3895c6c1daeSBarry Smith PetscErrorCode ierr; 3905c6c1daeSBarry Smith 3915c6c1daeSBarry Smith PetscFunctionBegin; 3925c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 3935c6c1daeSBarry Smith ierr = PetscStageLogRegister(stageLog, sname, stage);CHKERRQ(ierr); 3945c6c1daeSBarry Smith /* Copy events already changed in the main stage, this sucks */ 3953a88037aSBarry Smith ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr); 3965c6c1daeSBarry Smith for (event = 0; event < stageLog->eventLog->numEvents; event++) { 3973a88037aSBarry Smith ierr = PetscEventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event],&stageLog->stageInfo[*stage].eventLog->eventInfo[event]);CHKERRQ(ierr); 3985c6c1daeSBarry Smith } 3993a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 4005c6c1daeSBarry Smith PetscFunctionReturn(0); 4015c6c1daeSBarry Smith } 4025c6c1daeSBarry Smith 4035c6c1daeSBarry Smith /*@C 4045c6c1daeSBarry Smith PetscLogStagePush - This function pushes a stage on the stack. 4055c6c1daeSBarry Smith 4065c6c1daeSBarry Smith Not Collective 4075c6c1daeSBarry Smith 4085c6c1daeSBarry Smith Input Parameter: 4095c6c1daeSBarry Smith . stage - The stage on which to log 4105c6c1daeSBarry Smith 4115c6c1daeSBarry Smith Usage: 4125c6c1daeSBarry Smith If the option -log_sumary is used to run the program containing the 4135c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4145c6c1daeSBarry Smith PetscFinalize(). 4155c6c1daeSBarry Smith .vb 4165c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4175c6c1daeSBarry Smith [stage 0 of code] 4185c6c1daeSBarry Smith PetscLogStagePush(1); 4195c6c1daeSBarry Smith [stage 1 of code] 4205c6c1daeSBarry Smith PetscLogStagePop(); 4215c6c1daeSBarry Smith PetscBarrier(...); 4225c6c1daeSBarry Smith [more stage 0 of code] 4235c6c1daeSBarry Smith PetscFinalize(); 4245c6c1daeSBarry Smith .ve 4255c6c1daeSBarry Smith 4265c6c1daeSBarry Smith Notes: 4275c6c1daeSBarry Smith Use PetscLogStageRegister() to register a stage. 4285c6c1daeSBarry Smith 4295c6c1daeSBarry Smith Level: intermediate 4305c6c1daeSBarry Smith 4315c6c1daeSBarry Smith .seealso: PetscLogStagePop(), PetscLogStageRegister(), PetscBarrier() 4325c6c1daeSBarry Smith @*/ 4335c6c1daeSBarry Smith PetscErrorCode PetscLogStagePush(PetscLogStage stage) 4345c6c1daeSBarry Smith { 4355c6c1daeSBarry Smith PetscStageLog stageLog; 4365c6c1daeSBarry Smith PetscErrorCode ierr; 4375c6c1daeSBarry Smith 4385c6c1daeSBarry Smith PetscFunctionBegin; 4395c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 4405c6c1daeSBarry Smith ierr = PetscStageLogPush(stageLog, stage);CHKERRQ(ierr); 4415c6c1daeSBarry Smith PetscFunctionReturn(0); 4425c6c1daeSBarry Smith } 4435c6c1daeSBarry Smith 4445c6c1daeSBarry Smith /*@C 4455c6c1daeSBarry Smith PetscLogStagePop - This function pops a stage from the stack. 4465c6c1daeSBarry Smith 4475c6c1daeSBarry Smith Not Collective 4485c6c1daeSBarry Smith 4495c6c1daeSBarry Smith Usage: 4505c6c1daeSBarry Smith If the option -log_sumary is used to run the program containing the 4515c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4525c6c1daeSBarry Smith PetscFinalize(). 4535c6c1daeSBarry Smith .vb 4545c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4555c6c1daeSBarry Smith [stage 0 of code] 4565c6c1daeSBarry Smith PetscLogStagePush(1); 4575c6c1daeSBarry Smith [stage 1 of code] 4585c6c1daeSBarry Smith PetscLogStagePop(); 4595c6c1daeSBarry Smith PetscBarrier(...); 4605c6c1daeSBarry Smith [more stage 0 of code] 4615c6c1daeSBarry Smith PetscFinalize(); 4625c6c1daeSBarry Smith .ve 4635c6c1daeSBarry Smith 4645c6c1daeSBarry Smith Notes: 4655c6c1daeSBarry Smith Use PetscLogStageRegister() to register a stage. 4665c6c1daeSBarry Smith 4675c6c1daeSBarry Smith Level: intermediate 4685c6c1daeSBarry Smith 4695c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStageRegister(), PetscBarrier() 4705c6c1daeSBarry Smith @*/ 4715c6c1daeSBarry Smith PetscErrorCode PetscLogStagePop(void) 4725c6c1daeSBarry Smith { 4735c6c1daeSBarry Smith PetscStageLog stageLog; 4745c6c1daeSBarry Smith PetscErrorCode ierr; 4755c6c1daeSBarry Smith 4765c6c1daeSBarry Smith PetscFunctionBegin; 4775c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 4785c6c1daeSBarry Smith ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 4795c6c1daeSBarry Smith PetscFunctionReturn(0); 4805c6c1daeSBarry Smith } 4815c6c1daeSBarry Smith 4825c6c1daeSBarry Smith /*@ 4835c6c1daeSBarry Smith PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 4845c6c1daeSBarry Smith 4855c6c1daeSBarry Smith Not Collective 4865c6c1daeSBarry Smith 4875c6c1daeSBarry Smith Input Parameters: 4885c6c1daeSBarry Smith + stage - The stage 4895c6c1daeSBarry Smith - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 4905c6c1daeSBarry Smith 4915c6c1daeSBarry Smith Level: intermediate 4925c6c1daeSBarry Smith 4935c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 4945c6c1daeSBarry Smith @*/ 4955c6c1daeSBarry Smith PetscErrorCode PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive) 4965c6c1daeSBarry Smith { 4975c6c1daeSBarry Smith PetscStageLog stageLog; 4985c6c1daeSBarry Smith PetscErrorCode ierr; 4995c6c1daeSBarry Smith 5005c6c1daeSBarry Smith PetscFunctionBegin; 5015c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5025c6c1daeSBarry Smith ierr = PetscStageLogSetActive(stageLog, stage, isActive);CHKERRQ(ierr); 5035c6c1daeSBarry Smith PetscFunctionReturn(0); 5045c6c1daeSBarry Smith } 5055c6c1daeSBarry Smith 5065c6c1daeSBarry Smith /*@ 5075c6c1daeSBarry Smith PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 5085c6c1daeSBarry Smith 5095c6c1daeSBarry Smith Not Collective 5105c6c1daeSBarry Smith 5115c6c1daeSBarry Smith Input Parameter: 5125c6c1daeSBarry Smith . stage - The stage 5135c6c1daeSBarry Smith 5145c6c1daeSBarry Smith Output Parameter: 5155c6c1daeSBarry Smith . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 5165c6c1daeSBarry Smith 5175c6c1daeSBarry Smith Level: intermediate 5185c6c1daeSBarry Smith 5195c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 5205c6c1daeSBarry Smith @*/ 5215c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetActive(PetscLogStage stage, PetscBool *isActive) 5225c6c1daeSBarry Smith { 5235c6c1daeSBarry Smith PetscStageLog stageLog; 5245c6c1daeSBarry Smith PetscErrorCode ierr; 5255c6c1daeSBarry Smith 5265c6c1daeSBarry Smith PetscFunctionBegin; 5275c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5285c6c1daeSBarry Smith ierr = PetscStageLogGetActive(stageLog, stage, isActive);CHKERRQ(ierr); 5295c6c1daeSBarry Smith PetscFunctionReturn(0); 5305c6c1daeSBarry Smith } 5315c6c1daeSBarry Smith 5325c6c1daeSBarry Smith /*@ 5335c6c1daeSBarry Smith PetscLogStageSetVisible - Determines stage visibility in PetscLogView() 5345c6c1daeSBarry Smith 5355c6c1daeSBarry Smith Not Collective 5365c6c1daeSBarry Smith 5375c6c1daeSBarry Smith Input Parameters: 5385c6c1daeSBarry Smith + stage - The stage 5395c6c1daeSBarry Smith - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 5405c6c1daeSBarry Smith 5415c6c1daeSBarry Smith Level: intermediate 5425c6c1daeSBarry Smith 5435c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView() 5445c6c1daeSBarry Smith @*/ 5455c6c1daeSBarry Smith PetscErrorCode PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible) 5465c6c1daeSBarry Smith { 5475c6c1daeSBarry Smith PetscStageLog stageLog; 5485c6c1daeSBarry Smith PetscErrorCode ierr; 5495c6c1daeSBarry Smith 5505c6c1daeSBarry Smith PetscFunctionBegin; 5515c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5525c6c1daeSBarry Smith ierr = PetscStageLogSetVisible(stageLog, stage, isVisible);CHKERRQ(ierr); 5535c6c1daeSBarry Smith PetscFunctionReturn(0); 5545c6c1daeSBarry Smith } 5555c6c1daeSBarry Smith 5565c6c1daeSBarry Smith /*@ 5575c6c1daeSBarry Smith PetscLogStageGetVisible - Returns stage visibility in PetscLogView() 5585c6c1daeSBarry Smith 5595c6c1daeSBarry Smith Not Collective 5605c6c1daeSBarry Smith 5615c6c1daeSBarry Smith Input Parameter: 5625c6c1daeSBarry Smith . stage - The stage 5635c6c1daeSBarry Smith 5645c6c1daeSBarry Smith Output Parameter: 5655c6c1daeSBarry Smith . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 5665c6c1daeSBarry Smith 5675c6c1daeSBarry Smith Level: intermediate 5685c6c1daeSBarry Smith 5695c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView() 5705c6c1daeSBarry Smith @*/ 5715c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetVisible(PetscLogStage stage, PetscBool *isVisible) 5725c6c1daeSBarry Smith { 5735c6c1daeSBarry Smith PetscStageLog stageLog; 5745c6c1daeSBarry Smith PetscErrorCode ierr; 5755c6c1daeSBarry Smith 5765c6c1daeSBarry Smith PetscFunctionBegin; 5775c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5785c6c1daeSBarry Smith ierr = PetscStageLogGetVisible(stageLog, stage, isVisible);CHKERRQ(ierr); 5795c6c1daeSBarry Smith PetscFunctionReturn(0); 5805c6c1daeSBarry Smith } 5815c6c1daeSBarry Smith 5825c6c1daeSBarry Smith /*@C 5835c6c1daeSBarry Smith PetscLogStageGetId - Returns the stage id when given the stage name. 5845c6c1daeSBarry Smith 5855c6c1daeSBarry Smith Not Collective 5865c6c1daeSBarry Smith 5875c6c1daeSBarry Smith Input Parameter: 5885c6c1daeSBarry Smith . name - The stage name 5895c6c1daeSBarry Smith 5905c6c1daeSBarry Smith Output Parameter: 5915a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists 5925c6c1daeSBarry Smith 5935c6c1daeSBarry Smith Level: intermediate 5945c6c1daeSBarry Smith 5955c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 5965c6c1daeSBarry Smith @*/ 5975c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetId(const char name[], PetscLogStage *stage) 5985c6c1daeSBarry Smith { 5995c6c1daeSBarry Smith PetscStageLog stageLog; 6005c6c1daeSBarry Smith PetscErrorCode ierr; 6015c6c1daeSBarry Smith 6025c6c1daeSBarry Smith PetscFunctionBegin; 6035c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 6045c6c1daeSBarry Smith ierr = PetscStageLogGetStage(stageLog, name, stage);CHKERRQ(ierr); 6055c6c1daeSBarry Smith PetscFunctionReturn(0); 6065c6c1daeSBarry Smith } 6075c6c1daeSBarry Smith 6085c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/ 6095c6c1daeSBarry Smith /*@C 6105c6c1daeSBarry Smith PetscLogEventRegister - Registers an event name for logging operations in an application code. 6115c6c1daeSBarry Smith 6125c6c1daeSBarry Smith Not Collective 6135c6c1daeSBarry Smith 6145c6c1daeSBarry Smith Input Parameter: 6155c6c1daeSBarry Smith + name - The name associated with the event 6165c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with 6175c6c1daeSBarry Smith PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones 6185c6c1daeSBarry Smith are only available in C code 6195c6c1daeSBarry Smith 6205c6c1daeSBarry Smith Output Parameter: 6215c6c1daeSBarry Smith . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd(). 6225c6c1daeSBarry Smith 6235c6c1daeSBarry Smith Example of Usage: 6245c6c1daeSBarry Smith .vb 6255c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 6265c6c1daeSBarry Smith PetscClassId classid; 6275c6c1daeSBarry Smith PetscLogDouble user_event_flops; 6285c6c1daeSBarry Smith PetscClassIdRegister("class name",&classid); 6295c6c1daeSBarry Smith PetscLogEventRegister("User event name",classid,&USER_EVENT); 6305c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 6315c6c1daeSBarry Smith [code segment to monitor] 6325c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 6335c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 6345c6c1daeSBarry Smith .ve 6355c6c1daeSBarry Smith 6365c6c1daeSBarry Smith Notes: 6375c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 638a2553e36SBarry Smith configured with --with-log (which is the default) and 639a2553e36SBarry Smith -log_view or -log_all is specified. PetscLogEventRegister() is 6405c6c1daeSBarry Smith intended for logging user events to supplement this PETSc 6415c6c1daeSBarry Smith information. 6425c6c1daeSBarry Smith 643495fc317SBarry Smith PETSc can gather data for use with the utilities Jumpshot 6445c6c1daeSBarry Smith (part of the MPICH distribution). If PETSc has been compiled 6455c6c1daeSBarry Smith with flag -DPETSC_HAVE_MPE (MPE is an additional utility within 6465c6c1daeSBarry Smith MPICH), the user can employ another command line option, -log_mpe, 6475c6c1daeSBarry Smith to create a logfile, "mpe.log", which can be visualized 648495fc317SBarry Smith Jumpshot. 6495c6c1daeSBarry Smith 6505c6c1daeSBarry Smith The classid is associated with each event so that classes of events 6515c6c1daeSBarry Smith can be disabled simultaneously, such as all matrix events. The user 6525c6c1daeSBarry Smith can either use an existing classid, such as MAT_CLASSID, or create 6535c6c1daeSBarry Smith their own as shown in the example. 6545c6c1daeSBarry Smith 655c5deb1d5SJed Brown If an existing event with the same name exists, its event handle is 656c5deb1d5SJed Brown returned instead of creating a new event. 657c5deb1d5SJed Brown 6585c6c1daeSBarry Smith Level: intermediate 6595c6c1daeSBarry Smith 6605c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogFlops(), 6615c6c1daeSBarry Smith PetscLogEventActivate(), PetscLogEventDeactivate(), PetscClassIdRegister() 6625c6c1daeSBarry Smith @*/ 6635c6c1daeSBarry Smith PetscErrorCode PetscLogEventRegister(const char name[],PetscClassId classid,PetscLogEvent *event) 6645c6c1daeSBarry Smith { 6655c6c1daeSBarry Smith PetscStageLog stageLog; 6665c6c1daeSBarry Smith int stage; 6675c6c1daeSBarry Smith PetscErrorCode ierr; 6685c6c1daeSBarry Smith 6695c6c1daeSBarry Smith PetscFunctionBegin; 6705c6c1daeSBarry Smith *event = PETSC_DECIDE; 6715c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 6723a88037aSBarry Smith ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr); 673c5deb1d5SJed Brown if (*event > 0) PetscFunctionReturn(0); 6743a88037aSBarry Smith ierr = PetscEventRegLogRegister(stageLog->eventLog, name, classid, event);CHKERRQ(ierr); 6755c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 6763a88037aSBarry Smith ierr = PetscEventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr); 6773a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 6785c6c1daeSBarry Smith } 6795c6c1daeSBarry Smith PetscFunctionReturn(0); 6805c6c1daeSBarry Smith } 6815c6c1daeSBarry Smith 6825c6c1daeSBarry Smith /*@ 683217044c2SLisandro Dalcin PetscLogEventSetCollective - Indicates that a particular event is collective. 684217044c2SLisandro Dalcin 685217044c2SLisandro Dalcin Not Collective 686217044c2SLisandro Dalcin 687217044c2SLisandro Dalcin Input Parameter: 688217044c2SLisandro Dalcin + event - The event id 689217044c2SLisandro Dalcin - collective - Bolean flag indicating whether a particular event is collective 690217044c2SLisandro Dalcin 691217044c2SLisandro Dalcin Note: 692217044c2SLisandro Dalcin New events returned from PetscLogEventRegister() are collective by default. 693217044c2SLisandro Dalcin 694217044c2SLisandro Dalcin Level: developer 695217044c2SLisandro Dalcin 696217044c2SLisandro Dalcin .seealso: PetscLogEventRegister() 697217044c2SLisandro Dalcin @*/ 698217044c2SLisandro Dalcin PetscErrorCode PetscLogEventSetCollective(PetscLogEvent event,PetscBool collective) 699217044c2SLisandro Dalcin { 700217044c2SLisandro Dalcin PetscStageLog stageLog; 701217044c2SLisandro Dalcin PetscEventRegLog eventRegLog; 702217044c2SLisandro Dalcin PetscErrorCode ierr; 703217044c2SLisandro Dalcin 704217044c2SLisandro Dalcin PetscFunctionBegin; 705217044c2SLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 706217044c2SLisandro Dalcin ierr = PetscStageLogGetEventRegLog(stageLog,&eventRegLog);CHKERRQ(ierr); 707217044c2SLisandro Dalcin if (event < 0 || event > eventRegLog->numEvents) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Invalid event id"); 708217044c2SLisandro Dalcin eventRegLog->eventInfo[event].collective = collective; 709217044c2SLisandro Dalcin PetscFunctionReturn(0); 710217044c2SLisandro Dalcin } 711217044c2SLisandro Dalcin 712217044c2SLisandro Dalcin /*@ 713fa2bb9feSLisandro Dalcin PetscLogEventIncludeClass - Activates event logging for a PETSc object class in every stage. 714fa2bb9feSLisandro Dalcin 715fa2bb9feSLisandro Dalcin Not Collective 716fa2bb9feSLisandro Dalcin 717fa2bb9feSLisandro Dalcin Input Parameter: 718fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc. 719fa2bb9feSLisandro Dalcin 720fa2bb9feSLisandro Dalcin Level: developer 721fa2bb9feSLisandro Dalcin 722fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 723fa2bb9feSLisandro Dalcin @*/ 724fa2bb9feSLisandro Dalcin PetscErrorCode PetscLogEventIncludeClass(PetscClassId classid) 725fa2bb9feSLisandro Dalcin { 726fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 727fa2bb9feSLisandro Dalcin int stage; 728fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 729fa2bb9feSLisandro Dalcin 730fa2bb9feSLisandro Dalcin PetscFunctionBegin; 731fa2bb9feSLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 732fa2bb9feSLisandro Dalcin for (stage = 0; stage < stageLog->numStages; stage++) { 733fa2bb9feSLisandro Dalcin ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 734fa2bb9feSLisandro Dalcin } 735fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 736fa2bb9feSLisandro Dalcin } 737fa2bb9feSLisandro Dalcin 738fa2bb9feSLisandro Dalcin /*@ 739fa2bb9feSLisandro Dalcin PetscLogEventExcludeClass - Deactivates event logging for a PETSc object class in every stage. 740fa2bb9feSLisandro Dalcin 741fa2bb9feSLisandro Dalcin Not Collective 742fa2bb9feSLisandro Dalcin 743fa2bb9feSLisandro Dalcin Input Parameter: 744fa2bb9feSLisandro Dalcin . classid - The object class, for example MAT_CLASSID, SNES_CLASSID, etc. 745fa2bb9feSLisandro Dalcin 746fa2bb9feSLisandro Dalcin Level: developer 747fa2bb9feSLisandro Dalcin 748fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivateClass(),PetscLogEventDeactivate(),PetscLogEventActivate() 749fa2bb9feSLisandro Dalcin @*/ 750fa2bb9feSLisandro Dalcin PetscErrorCode PetscLogEventExcludeClass(PetscClassId classid) 751fa2bb9feSLisandro Dalcin { 752fa2bb9feSLisandro Dalcin PetscStageLog stageLog; 753fa2bb9feSLisandro Dalcin int stage; 754fa2bb9feSLisandro Dalcin PetscErrorCode ierr; 755fa2bb9feSLisandro Dalcin 756fa2bb9feSLisandro Dalcin PetscFunctionBegin; 757fa2bb9feSLisandro Dalcin ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 758fa2bb9feSLisandro Dalcin for (stage = 0; stage < stageLog->numStages; stage++) { 759fa2bb9feSLisandro Dalcin ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 760fa2bb9feSLisandro Dalcin } 761fa2bb9feSLisandro Dalcin PetscFunctionReturn(0); 762fa2bb9feSLisandro Dalcin } 763fa2bb9feSLisandro Dalcin 764fa2bb9feSLisandro Dalcin /*@ 7655c6c1daeSBarry Smith PetscLogEventActivate - Indicates that a particular event should be logged. 7665c6c1daeSBarry Smith 7675c6c1daeSBarry Smith Not Collective 7685c6c1daeSBarry Smith 7695c6c1daeSBarry Smith Input Parameter: 7705c6c1daeSBarry Smith . event - The event id 7715c6c1daeSBarry Smith 7725c6c1daeSBarry Smith Usage: 7735c6c1daeSBarry Smith .vb 7745c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 7755c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 7765c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 7775c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 7785c6c1daeSBarry Smith .ve 7795c6c1daeSBarry Smith 7805c6c1daeSBarry Smith Note: 7815c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in include/petsclog.h) 7825c6c1daeSBarry Smith or an event number obtained with PetscLogEventRegister(). 7835c6c1daeSBarry Smith 7845c6c1daeSBarry Smith Level: advanced 7855c6c1daeSBarry Smith 786ec303c53SPatrick Sanan .seealso: PlogEventDeactivate() 7875c6c1daeSBarry Smith @*/ 7885c6c1daeSBarry Smith PetscErrorCode PetscLogEventActivate(PetscLogEvent event) 7895c6c1daeSBarry Smith { 7905c6c1daeSBarry Smith PetscStageLog stageLog; 7915c6c1daeSBarry Smith int stage; 7925c6c1daeSBarry Smith PetscErrorCode ierr; 7935c6c1daeSBarry Smith 7945c6c1daeSBarry Smith PetscFunctionBegin; 7955c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 7965c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 7973a88037aSBarry Smith ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 7985c6c1daeSBarry Smith PetscFunctionReturn(0); 7995c6c1daeSBarry Smith } 8005c6c1daeSBarry Smith 8015c6c1daeSBarry Smith /*@ 8025c6c1daeSBarry Smith PetscLogEventDeactivate - Indicates that a particular event should not be logged. 8035c6c1daeSBarry Smith 8045c6c1daeSBarry Smith Not Collective 8055c6c1daeSBarry Smith 8065c6c1daeSBarry Smith Input Parameter: 8075c6c1daeSBarry Smith . event - The event id 8085c6c1daeSBarry Smith 8095c6c1daeSBarry Smith Usage: 8105c6c1daeSBarry Smith .vb 8115c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 8125c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 8135c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 8145c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 8155c6c1daeSBarry Smith .ve 8165c6c1daeSBarry Smith 8175c6c1daeSBarry Smith Note: 8185c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in 8195c6c1daeSBarry Smith include/petsclog.h) or an event number obtained with PetscLogEventRegister()). 8205c6c1daeSBarry Smith 8215c6c1daeSBarry Smith Level: advanced 8225c6c1daeSBarry Smith 823ec303c53SPatrick Sanan .seealso: PlogEventActivate() 8245c6c1daeSBarry Smith @*/ 8255c6c1daeSBarry Smith PetscErrorCode PetscLogEventDeactivate(PetscLogEvent event) 8265c6c1daeSBarry Smith { 8275c6c1daeSBarry Smith PetscStageLog stageLog; 8285c6c1daeSBarry Smith int stage; 8295c6c1daeSBarry Smith PetscErrorCode ierr; 8305c6c1daeSBarry Smith 8315c6c1daeSBarry Smith PetscFunctionBegin; 8325c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8335c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 8343a88037aSBarry Smith ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8355c6c1daeSBarry Smith PetscFunctionReturn(0); 8365c6c1daeSBarry Smith } 8375c6c1daeSBarry Smith 8385c6c1daeSBarry Smith /*@ 8395c6c1daeSBarry Smith PetscLogEventSetActiveAll - Sets the event activity in every stage. 8405c6c1daeSBarry Smith 8415c6c1daeSBarry Smith Not Collective 8425c6c1daeSBarry Smith 8435c6c1daeSBarry Smith Input Parameters: 8445c6c1daeSBarry Smith + event - The event id 8455c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged 8465c6c1daeSBarry Smith 8475c6c1daeSBarry Smith Level: advanced 8485c6c1daeSBarry Smith 849ec303c53SPatrick Sanan .seealso: PlogEventActivate(),PlogEventDeactivate() 8505c6c1daeSBarry Smith @*/ 8515c6c1daeSBarry Smith PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive) 8525c6c1daeSBarry Smith { 8535c6c1daeSBarry Smith PetscStageLog stageLog; 8545c6c1daeSBarry Smith int stage; 8555c6c1daeSBarry Smith PetscErrorCode ierr; 8565c6c1daeSBarry Smith 8575c6c1daeSBarry Smith PetscFunctionBegin; 8585c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8595c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 8605c6c1daeSBarry Smith if (isActive) { 8613a88037aSBarry Smith ierr = PetscEventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8625c6c1daeSBarry Smith } else { 8633a88037aSBarry Smith ierr = PetscEventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8645c6c1daeSBarry Smith } 8655c6c1daeSBarry Smith } 8665c6c1daeSBarry Smith PetscFunctionReturn(0); 8675c6c1daeSBarry Smith } 8685c6c1daeSBarry Smith 8695c6c1daeSBarry Smith /*@ 8705c6c1daeSBarry Smith PetscLogEventActivateClass - Activates event logging for a PETSc object class. 8715c6c1daeSBarry Smith 8725c6c1daeSBarry Smith Not Collective 8735c6c1daeSBarry Smith 8745c6c1daeSBarry Smith Input Parameter: 8755c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 8765c6c1daeSBarry Smith 8775c6c1daeSBarry Smith Level: developer 8785c6c1daeSBarry Smith 879fa2bb9feSLisandro Dalcin .seealso: PetscLogEventDeactivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 8805c6c1daeSBarry Smith @*/ 8815c6c1daeSBarry Smith PetscErrorCode PetscLogEventActivateClass(PetscClassId classid) 8825c6c1daeSBarry Smith { 8835c6c1daeSBarry Smith PetscStageLog stageLog; 8845c6c1daeSBarry Smith int stage; 8855c6c1daeSBarry Smith PetscErrorCode ierr; 8865c6c1daeSBarry Smith 8875c6c1daeSBarry Smith PetscFunctionBegin; 8885c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8895c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 8903a88037aSBarry Smith ierr = PetscEventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 8915c6c1daeSBarry Smith PetscFunctionReturn(0); 8925c6c1daeSBarry Smith } 8935c6c1daeSBarry Smith 8945c6c1daeSBarry Smith /*@ 8955c6c1daeSBarry Smith PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class. 8965c6c1daeSBarry Smith 8975c6c1daeSBarry Smith Not Collective 8985c6c1daeSBarry Smith 8995c6c1daeSBarry Smith Input Parameter: 9005c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 9015c6c1daeSBarry Smith 9025c6c1daeSBarry Smith Level: developer 9035c6c1daeSBarry Smith 904fa2bb9feSLisandro Dalcin .seealso: PetscLogEventActivateClass(),PetscLogEventActivate(),PetscLogEventDeactivate() 9055c6c1daeSBarry Smith @*/ 9065c6c1daeSBarry Smith PetscErrorCode PetscLogEventDeactivateClass(PetscClassId classid) 9075c6c1daeSBarry Smith { 9085c6c1daeSBarry Smith PetscStageLog stageLog; 9095c6c1daeSBarry Smith int stage; 9105c6c1daeSBarry Smith PetscErrorCode ierr; 9115c6c1daeSBarry Smith 9125c6c1daeSBarry Smith PetscFunctionBegin; 9135c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 9145c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 9153a88037aSBarry Smith ierr = PetscEventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 9165c6c1daeSBarry Smith PetscFunctionReturn(0); 9175c6c1daeSBarry Smith } 9185c6c1daeSBarry Smith 9195c6c1daeSBarry Smith /*MC 92062872c28SLisandro Dalcin PetscLogEventSync - Synchronizes the beginning of a user event. 92162872c28SLisandro Dalcin 92262872c28SLisandro Dalcin Synopsis: 92362872c28SLisandro Dalcin #include <petsclog.h> 92462872c28SLisandro Dalcin PetscErrorCode PetscLogEventSync(int e,MPI_Comm comm) 92562872c28SLisandro Dalcin 92662872c28SLisandro Dalcin Collective 92762872c28SLisandro Dalcin 92862872c28SLisandro Dalcin Input Parameters: 92962872c28SLisandro Dalcin + e - integer associated with the event obtained from PetscLogEventRegister() 93062872c28SLisandro Dalcin - comm - an MPI communicator 93162872c28SLisandro Dalcin 93262872c28SLisandro Dalcin Usage: 93362872c28SLisandro Dalcin .vb 93462872c28SLisandro Dalcin PetscLogEvent USER_EVENT; 93562872c28SLisandro Dalcin PetscLogEventRegister("User event",0,&USER_EVENT); 93662872c28SLisandro Dalcin PetscLogEventSync(USER_EVENT,PETSC_COMM_WORLD); 93762872c28SLisandro Dalcin PetscLogEventBegin(USER_EVENT,0,0,0,0); 93862872c28SLisandro Dalcin [code segment to monitor] 93962872c28SLisandro Dalcin PetscLogEventEnd(USER_EVENT,0,0,0,0); 94062872c28SLisandro Dalcin .ve 94162872c28SLisandro Dalcin 94262872c28SLisandro Dalcin Notes: 94362872c28SLisandro Dalcin This routine should be called only if there is not a 94462872c28SLisandro Dalcin PetscObject available to pass to PetscLogEventBegin(). 94562872c28SLisandro Dalcin 94662872c28SLisandro Dalcin Level: developer 94762872c28SLisandro Dalcin 94862872c28SLisandro Dalcin .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd() 94962872c28SLisandro Dalcin 95062872c28SLisandro Dalcin M*/ 95162872c28SLisandro Dalcin 95262872c28SLisandro Dalcin /*MC 9535c6c1daeSBarry Smith PetscLogEventBegin - Logs the beginning of a user event. 9545c6c1daeSBarry Smith 9555c6c1daeSBarry Smith Synopsis: 956aaa7dc30SBarry Smith #include <petsclog.h> 957f2ba6396SBarry Smith PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 9585c6c1daeSBarry Smith 9595c6c1daeSBarry Smith Not Collective 9605c6c1daeSBarry Smith 9615c6c1daeSBarry Smith Input Parameters: 9625c6c1daeSBarry Smith + e - integer associated with the event obtained from PetscLogEventRegister() 9635c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 9645c6c1daeSBarry Smith 9655c6c1daeSBarry Smith 9665c6c1daeSBarry Smith Fortran Synopsis: 9675c6c1daeSBarry Smith void PetscLogEventBegin(int e,PetscErrorCode ierr) 9685c6c1daeSBarry Smith 9695c6c1daeSBarry Smith Usage: 9705c6c1daeSBarry Smith .vb 9715c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 9725c6c1daeSBarry Smith PetscLogDouble user_event_flops; 9735c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 9745c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 9755c6c1daeSBarry Smith [code segment to monitor] 9765c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 9775c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 9785c6c1daeSBarry Smith .ve 9795c6c1daeSBarry Smith 9805c6c1daeSBarry Smith Notes: 9815c6c1daeSBarry Smith You need to register each integer event with the command 982a2553e36SBarry Smith PetscLogEventRegister(). 9835c6c1daeSBarry Smith 9845c6c1daeSBarry Smith Level: intermediate 9855c6c1daeSBarry Smith 9865c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops() 9875c6c1daeSBarry Smith 9885c6c1daeSBarry Smith M*/ 9895c6c1daeSBarry Smith 9905c6c1daeSBarry Smith /*MC 9915c6c1daeSBarry Smith PetscLogEventEnd - Log the end of a user event. 9925c6c1daeSBarry Smith 9935c6c1daeSBarry Smith Synopsis: 994aaa7dc30SBarry Smith #include <petsclog.h> 995f2ba6396SBarry Smith PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 9965c6c1daeSBarry Smith 9975c6c1daeSBarry Smith Not Collective 9985c6c1daeSBarry Smith 9995c6c1daeSBarry Smith Input Parameters: 10005c6c1daeSBarry Smith + e - integer associated with the event obtained with PetscLogEventRegister() 10015c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 10025c6c1daeSBarry Smith 10035c6c1daeSBarry Smith 10045c6c1daeSBarry Smith Fortran Synopsis: 10055c6c1daeSBarry Smith void PetscLogEventEnd(int e,PetscErrorCode ierr) 10065c6c1daeSBarry Smith 10075c6c1daeSBarry Smith Usage: 10085c6c1daeSBarry Smith .vb 10095c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 10105c6c1daeSBarry Smith PetscLogDouble user_event_flops; 10115c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT,); 10125c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 10135c6c1daeSBarry Smith [code segment to monitor] 10145c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 10155c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 10165c6c1daeSBarry Smith .ve 10175c6c1daeSBarry Smith 10185c6c1daeSBarry Smith Notes: 10195c6c1daeSBarry Smith You should also register each additional integer event with the command 1020a2553e36SBarry Smith PetscLogEventRegister(). 10215c6c1daeSBarry Smith 10225c6c1daeSBarry Smith Level: intermediate 10235c6c1daeSBarry Smith 10245c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogFlops() 10255c6c1daeSBarry Smith 10265c6c1daeSBarry Smith M*/ 10275c6c1daeSBarry Smith 10285c6c1daeSBarry Smith /*@C 10295c6c1daeSBarry Smith PetscLogEventGetId - Returns the event id when given the event name. 10305c6c1daeSBarry Smith 10315c6c1daeSBarry Smith Not Collective 10325c6c1daeSBarry Smith 10335c6c1daeSBarry Smith Input Parameter: 10345c6c1daeSBarry Smith . name - The event name 10355c6c1daeSBarry Smith 10365c6c1daeSBarry Smith Output Parameter: 1037c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists 10385c6c1daeSBarry Smith 10395c6c1daeSBarry Smith Level: intermediate 10405c6c1daeSBarry Smith 10415c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStageGetId() 10425c6c1daeSBarry Smith @*/ 10435c6c1daeSBarry Smith PetscErrorCode PetscLogEventGetId(const char name[], PetscLogEvent *event) 10445c6c1daeSBarry Smith { 10455c6c1daeSBarry Smith PetscStageLog stageLog; 10465c6c1daeSBarry Smith PetscErrorCode ierr; 10475c6c1daeSBarry Smith 10485c6c1daeSBarry Smith PetscFunctionBegin; 10495c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 10503a88037aSBarry Smith ierr = PetscEventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr); 10515c6c1daeSBarry Smith PetscFunctionReturn(0); 10525c6c1daeSBarry Smith } 10535c6c1daeSBarry Smith 10545c6c1daeSBarry Smith 10555c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/ 10565c6c1daeSBarry Smith /*@C 10575c6c1daeSBarry Smith PetscLogDump - Dumps logs of objects to a file. This file is intended to 10585c6c1daeSBarry Smith be read by bin/petscview. This program no longer exists. 10595c6c1daeSBarry Smith 10605c6c1daeSBarry Smith Collective on PETSC_COMM_WORLD 10615c6c1daeSBarry Smith 10625c6c1daeSBarry Smith Input Parameter: 10635c6c1daeSBarry Smith . name - an optional file name 10645c6c1daeSBarry Smith 10655c6c1daeSBarry Smith Usage: 10665c6c1daeSBarry Smith .vb 10675c6c1daeSBarry Smith PetscInitialize(...); 1068bb1d7374SBarry Smith PetscLogDefaultBegin(); or PetscLogAllBegin(); 10695c6c1daeSBarry Smith ... code ... 10705c6c1daeSBarry Smith PetscLogDump(filename); 10715c6c1daeSBarry Smith PetscFinalize(); 10725c6c1daeSBarry Smith .ve 10735c6c1daeSBarry Smith 10745c6c1daeSBarry Smith Notes: 10755c6c1daeSBarry Smith The default file name is 10765c6c1daeSBarry Smith $ Log.<rank> 10775c6c1daeSBarry Smith where <rank> is the processor number. If no name is specified, 10785c6c1daeSBarry Smith this file will be used. 10795c6c1daeSBarry Smith 10805c6c1daeSBarry Smith Level: advanced 10815c6c1daeSBarry Smith 1082bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogView() 10835c6c1daeSBarry Smith @*/ 10845c6c1daeSBarry Smith PetscErrorCode PetscLogDump(const char sname[]) 10855c6c1daeSBarry Smith { 10865c6c1daeSBarry Smith PetscStageLog stageLog; 10875c6c1daeSBarry Smith PetscEventPerfInfo *eventInfo; 10885c6c1daeSBarry Smith FILE *fd; 10895c6c1daeSBarry Smith char file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN]; 10905c6c1daeSBarry Smith PetscLogDouble flops, _TotalTime; 10915c6c1daeSBarry Smith PetscMPIInt rank; 10925c6c1daeSBarry Smith int action, object, curStage; 10935c6c1daeSBarry Smith PetscLogEvent event; 10945c6c1daeSBarry Smith PetscErrorCode ierr; 10955c6c1daeSBarry Smith 10965c6c1daeSBarry Smith PetscFunctionBegin; 10975c6c1daeSBarry Smith /* Calculate the total elapsed time */ 10988563dfccSBarry Smith PetscTime(&_TotalTime); 10995c6c1daeSBarry Smith _TotalTime -= petsc_BaseTime; 11005c6c1daeSBarry Smith /* Open log file */ 11015c6c1daeSBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank);CHKERRQ(ierr); 11027ff663adSLisandro Dalcin if (sname && sname[0]) sprintf(file, "%s.%d", sname, rank); 1103a297a907SKarl Rupp else sprintf(file, "Log.%d", rank); 11045c6c1daeSBarry Smith ierr = PetscFixFilename(file, fname);CHKERRQ(ierr); 11055c6c1daeSBarry Smith ierr = PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd);CHKERRQ(ierr); 11065c6c1daeSBarry Smith if ((!rank) && (!fd)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname); 11075c6c1daeSBarry Smith /* Output totals */ 1108d4aa7d5fSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flop %14e %16.8e\n", petsc_TotalFlops, _TotalTime);CHKERRQ(ierr); 1109a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0);CHKERRQ(ierr); 11105c6c1daeSBarry Smith /* Output actions */ 11115c6c1daeSBarry Smith if (petsc_logActions) { 1112a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions);CHKERRQ(ierr); 11135c6c1daeSBarry Smith for (action = 0; action < petsc_numActions; action++) { 11145c6c1daeSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n", 11155c6c1daeSBarry Smith petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1, 1116a2ea699eSBarry Smith petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem);CHKERRQ(ierr); 11175c6c1daeSBarry Smith } 11185c6c1daeSBarry Smith } 11195c6c1daeSBarry Smith /* Output objects */ 11205c6c1daeSBarry Smith if (petsc_logObjects) { 1121a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed);CHKERRQ(ierr); 11225c6c1daeSBarry Smith for (object = 0; object < petsc_numObjects; object++) { 1123a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int) petsc_objects[object].mem);CHKERRQ(ierr); 11245c6c1daeSBarry Smith if (!petsc_objects[object].name[0]) { 1125a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd,"No Name\n");CHKERRQ(ierr); 11265c6c1daeSBarry Smith } else { 1127a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name);CHKERRQ(ierr); 11285c6c1daeSBarry Smith } 11295c6c1daeSBarry Smith if (petsc_objects[object].info[0] != 0) { 1130a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n");CHKERRQ(ierr); 11315c6c1daeSBarry Smith } else { 1132a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info);CHKERRQ(ierr); 11335c6c1daeSBarry Smith } 11345c6c1daeSBarry Smith } 11355c6c1daeSBarry Smith } 11365c6c1daeSBarry Smith /* Output events */ 1137a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n");CHKERRQ(ierr); 11385c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 11395c6c1daeSBarry Smith ierr = PetscIntStackTop(stageLog->stack, &curStage);CHKERRQ(ierr); 11405c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo; 11415c6c1daeSBarry Smith for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) { 1142a297a907SKarl Rupp if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops/eventInfo[event].time; 1143a297a907SKarl Rupp else flops = 0.0; 11445c6c1daeSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count, 1145a2ea699eSBarry Smith eventInfo[event].flops, eventInfo[event].time, flops);CHKERRQ(ierr); 11465c6c1daeSBarry Smith } 11475c6c1daeSBarry Smith ierr = PetscFClose(PETSC_COMM_WORLD, fd);CHKERRQ(ierr); 11485c6c1daeSBarry Smith PetscFunctionReturn(0); 11495c6c1daeSBarry Smith } 11505c6c1daeSBarry Smith 1151f14045dbSBarry Smith /* 1152f14045dbSBarry Smith PetscLogView_Detailed - Each process prints the times for its own events 1153f14045dbSBarry Smith 1154f14045dbSBarry Smith */ 1155f14045dbSBarry Smith PetscErrorCode PetscLogView_Detailed(PetscViewer viewer) 1156f14045dbSBarry Smith { 11572dff6485SMatthew G. Knepley PetscStageLog stageLog; 1158217044c2SLisandro Dalcin PetscEventPerfInfo *eventInfo = NULL, *stageInfo = NULL; 1159217044c2SLisandro Dalcin PetscLogDouble locTotalTime, numRed, maxMem; 11602dff6485SMatthew G. Knepley int numStages,numEvents,stage,event; 1161217044c2SLisandro Dalcin MPI_Comm comm = PetscObjectComm((PetscObject) viewer); 11622dff6485SMatthew G. Knepley PetscMPIInt rank,size; 11632dff6485SMatthew G. Knepley PetscErrorCode ierr; 1164f14045dbSBarry Smith 1165f14045dbSBarry Smith PetscFunctionBegin; 11662d1ec343SBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 11672d1ec343SBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 11682dff6485SMatthew G. Knepley /* Must preserve reduction count before we go on */ 11692dff6485SMatthew G. Knepley numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 11702d1ec343SBarry Smith /* Get the total elapsed time */ 11712d1ec343SBarry Smith PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 11729852e123SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"size = %d\n",size);CHKERRQ(ierr); 11732d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalTimes = {}\n");CHKERRQ(ierr); 11742d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalMessages = {}\n");CHKERRQ(ierr); 1175217044c2SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"LocalMessageLens = {}\n");CHKERRQ(ierr); 11762d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalReductions = {}\n");CHKERRQ(ierr); 1177217044c2SLisandro Dalcin ierr = PetscViewerASCIIPrintf(viewer,"LocalFlop = {}\n");CHKERRQ(ierr); 11782dff6485SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer,"LocalObjects = {}\n");CHKERRQ(ierr); 11792dff6485SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer,"LocalMemory = {}\n");CHKERRQ(ierr); 11802d1ec343SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1181b2566f29SBarry Smith ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 11822d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages = {}\n");CHKERRQ(ierr); 11832d1ec343SBarry Smith for (stage=0; stage<numStages; stage++) { 11842d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr); 118561917356SPatrick Sanan ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"summary\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr); 1186b2566f29SBarry Smith ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 11872d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 11882d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"%s\"] = {}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name);CHKERRQ(ierr); 11892d1ec343SBarry Smith } 11902d1ec343SBarry Smith } 1191217044c2SLisandro Dalcin ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr); 11921575c14dSBarry Smith ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr); 11932d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalTimes[%d] = %g\n",rank,locTotalTime);CHKERRQ(ierr); 11942d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessages[%d] = %g\n",rank,(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct));CHKERRQ(ierr); 1195217044c2SLisandro Dalcin ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessageLens[%d] = %g\n",rank,(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len));CHKERRQ(ierr); 11962dff6485SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalReductions[%d] = %g\n",rank,numRed);CHKERRQ(ierr); 1197217044c2SLisandro Dalcin ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalFlop[%d] = %g\n",rank,petsc_TotalFlops);CHKERRQ(ierr); 1198ba67d37fSBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalObjects[%d] = %d\n",rank,petsc_numObjects);CHKERRQ(ierr); 11992dff6485SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMemory[%d] = %g\n",rank,maxMem);CHKERRQ(ierr); 12002d1ec343SBarry Smith ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 12012d1ec343SBarry Smith for (stage=0; stage<numStages; stage++) { 1202217044c2SLisandro Dalcin stageInfo = &stageLog->stageInfo[stage].perfInfo; 1203d4aa7d5fSBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g}\n", 12042dff6485SMatthew G. Knepley stageLog->stageInfo[stage].name,rank, 1205217044c2SLisandro Dalcin stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr); 1206b2566f29SBarry Smith ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 12072d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 1208217044c2SLisandro Dalcin eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 1209c15bc2c4SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %D, \"time\" : %g, \"syncTime\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flop\" : %g", 1210217044c2SLisandro Dalcin stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name,rank, 1211217044c2SLisandro Dalcin eventInfo->count,eventInfo->time,eventInfo->syncTime,eventInfo->numMessages,eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr); 1212891e75beSMatthew G. Knepley if (eventInfo->dof[0] >= 0.) { 1213891e75beSMatthew G. Knepley PetscInt d, e; 12145d68e14cSMatthew G. Knepley 1215891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"dof\" : [");CHKERRQ(ierr); 1216891e75beSMatthew G. Knepley for (d = 0; d < 8; ++d) { 1217891e75beSMatthew G. Knepley if (d > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);} 1218891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->dof[d]);CHKERRQ(ierr); 1219891e75beSMatthew G. Knepley } 1220891e75beSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr); 12215d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", \"error\" : [");CHKERRQ(ierr); 12225d68e14cSMatthew G. Knepley for (e = 0; e < 8; ++e) { 12235d68e14cSMatthew G. Knepley if (e > 0) {ierr = PetscViewerASCIISynchronizedPrintf(viewer, ", ");CHKERRQ(ierr);} 1224c15bc2c4SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%g", eventInfo->errors[e]);CHKERRQ(ierr); 12255d68e14cSMatthew G. Knepley } 12265d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer, "]");CHKERRQ(ierr); 12275d68e14cSMatthew G. Knepley } 12285d68e14cSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"}\n");CHKERRQ(ierr); 12292d1ec343SBarry Smith } 12302d1ec343SBarry Smith } 12312d1ec343SBarry Smith ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 12321575c14dSBarry Smith ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr); 1233f14045dbSBarry Smith PetscFunctionReturn(0); 1234f14045dbSBarry Smith } 1235f14045dbSBarry Smith 123638144912Sdeepblu2718 /* 123738144912Sdeepblu2718 PetscLogView_CSV - Each process prints the times for its own events in Comma-Separated Value Format 123838144912Sdeepblu2718 */ 123938144912Sdeepblu2718 PetscErrorCode PetscLogView_CSV(PetscViewer viewer) 124038144912Sdeepblu2718 { 124138144912Sdeepblu2718 PetscStageLog stageLog; 1242669c5be0SSatish Balay PetscEventPerfInfo *eventInfo = NULL; 124338144912Sdeepblu2718 PetscLogDouble locTotalTime, maxMem; 124438144912Sdeepblu2718 int numStages,numEvents,stage,event; 124538144912Sdeepblu2718 MPI_Comm comm = PetscObjectComm((PetscObject) viewer); 124638144912Sdeepblu2718 PetscMPIInt rank,size; 124738144912Sdeepblu2718 PetscErrorCode ierr; 124838144912Sdeepblu2718 124938144912Sdeepblu2718 PetscFunctionBegin; 125038144912Sdeepblu2718 ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 125138144912Sdeepblu2718 ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 125238144912Sdeepblu2718 /* Must preserve reduction count before we go on */ 125338144912Sdeepblu2718 /* Get the total elapsed time */ 125438144912Sdeepblu2718 PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 125538144912Sdeepblu2718 ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 125638144912Sdeepblu2718 ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 125738144912Sdeepblu2718 ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr); 125838144912Sdeepblu2718 ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr); 125938144912Sdeepblu2718 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); 126038144912Sdeepblu2718 ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 126138144912Sdeepblu2718 for (stage=0; stage<numStages; stage++) { 1262*9e29573dSMatthew G. Knepley PetscEventPerfInfo *stageInfo = &stageLog->stageInfo[stage].perfInfo; 1263*9e29573dSMatthew G. Knepley 1264*9e29573dSMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,summary,%d,%g,%g,%g,%g,%g\n", 1265*9e29573dSMatthew G. Knepley stageLog->stageInfo[stage].name,rank,stageInfo->time,stageInfo->numMessages,stageInfo->messageLength,stageInfo->numReductions,stageInfo->flops);CHKERRQ(ierr); 126638144912Sdeepblu2718 ierr = MPIU_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 126738144912Sdeepblu2718 for (event = 0; event < numEvents; event++) { 126838144912Sdeepblu2718 eventInfo = &stageLog->stageInfo[stage].eventLog->eventInfo[event]; 126938144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"%s,%s,%d,%g,%g,%g,%g,%g",stageLog->stageInfo[stage].name, 127038144912Sdeepblu2718 stageLog->eventLog->eventInfo[event].name,rank,eventInfo->time,eventInfo->numMessages, 127138144912Sdeepblu2718 eventInfo->messageLength,eventInfo->numReductions,eventInfo->flops);CHKERRQ(ierr); 127238144912Sdeepblu2718 if (eventInfo->dof[0] >= 0.) { 127338144912Sdeepblu2718 PetscInt d, e; 127438144912Sdeepblu2718 127538144912Sdeepblu2718 for (d = 0; d < 8; ++d) { 127638144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->dof[d]);CHKERRQ(ierr); 127738144912Sdeepblu2718 } 127838144912Sdeepblu2718 for (e = 0; e < 8; ++e) { 127938144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer, ",%g", eventInfo->errors[e]);CHKERRQ(ierr); 128038144912Sdeepblu2718 } 128138144912Sdeepblu2718 } 128238144912Sdeepblu2718 ierr = PetscViewerASCIISynchronizedPrintf(viewer,"\n");CHKERRQ(ierr); 128338144912Sdeepblu2718 } 128438144912Sdeepblu2718 } 128538144912Sdeepblu2718 ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 128638144912Sdeepblu2718 ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr); 128738144912Sdeepblu2718 PetscFunctionReturn(0); 128838144912Sdeepblu2718 } 128938144912Sdeepblu2718 1290217044c2SLisandro Dalcin static PetscErrorCode PetscLogViewWarnSync(MPI_Comm comm,FILE *fd) 1291217044c2SLisandro Dalcin { 1292217044c2SLisandro Dalcin PetscErrorCode ierr; 1293217044c2SLisandro Dalcin PetscFunctionBegin; 1294217044c2SLisandro Dalcin if (!PetscLogSyncOn) PetscFunctionReturn(0); 1295217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1296217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1297217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1298217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1299217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1300217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This program was run with logging synchronization. #\n");CHKERRQ(ierr); 1301217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This option provides more meaningful imbalance #\n");CHKERRQ(ierr); 1302217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # figures at the expense of slowing things down and #\n");CHKERRQ(ierr); 1303217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # providing a distorted view of the overall runtime. #\n");CHKERRQ(ierr); 1304217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1305217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 1306217044c2SLisandro Dalcin PetscFunctionReturn(0); 1307217044c2SLisandro Dalcin PetscFunctionReturn(0); 1308217044c2SLisandro Dalcin } 1309217044c2SLisandro Dalcin 1310f4091ad2SBarry Smith static PetscErrorCode PetscLogViewWarnDebugging(MPI_Comm comm,FILE *fd) 1311f4091ad2SBarry Smith { 1312f4091ad2SBarry Smith #if defined(PETSC_USE_DEBUG) 1313f4091ad2SBarry Smith PetscErrorCode ierr; 1314f4091ad2SBarry Smith 1315f4091ad2SBarry Smith PetscFunctionBegin; 1316f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 1317f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 1318f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1319f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 1320f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1321217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " # This code was compiled with a debugging option. #\n");CHKERRQ(ierr); 1322f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # To get timing results run ./configure #\n");CHKERRQ(ierr); 1323f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # using --with-debugging=no, the performance will #\n");CHKERRQ(ierr); 1324f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # be generally two or three times faster. #\n");CHKERRQ(ierr); 1325f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 1326f4091ad2SBarry Smith ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 1327f4091ad2SBarry Smith PetscFunctionReturn(0); 1328f4091ad2SBarry Smith #else 1329f4091ad2SBarry Smith return 0; 1330f4091ad2SBarry Smith #endif 1331f4091ad2SBarry Smith } 1332f4091ad2SBarry Smith 1333f14045dbSBarry Smith PetscErrorCode PetscLogView_Default(PetscViewer viewer) 13345c6c1daeSBarry Smith { 13355c6c1daeSBarry Smith FILE *fd; 13365c6c1daeSBarry Smith PetscLogDouble zero = 0.0; 13375c6c1daeSBarry Smith PetscStageLog stageLog; 13380298fd71SBarry Smith PetscStageInfo *stageInfo = NULL; 13390298fd71SBarry Smith PetscEventPerfInfo *eventInfo = NULL; 13405c6c1daeSBarry Smith PetscClassPerfInfo *classInfo; 13415c6c1daeSBarry Smith char arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128]; 13425c6c1daeSBarry Smith const char *name; 13435c6c1daeSBarry Smith PetscLogDouble locTotalTime, TotalTime, TotalFlops; 13445c6c1daeSBarry Smith PetscLogDouble numMessages, messageLength, avgMessLen, numReductions; 13455c6c1daeSBarry Smith PetscLogDouble stageTime, flops, flopr, mem, mess, messLen, red; 13465c6c1daeSBarry Smith PetscLogDouble fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed; 13475c6c1daeSBarry Smith PetscLogDouble fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed; 13485c6c1daeSBarry Smith PetscLogDouble min, max, tot, ratio, avg, x, y; 1349e3ed9ee7SBarry Smith PetscLogDouble minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratC, totm, totml, totr,mal,malmax,emalmax; 1350217044c2SLisandro Dalcin PetscMPIInt minC, maxC; 13515c6c1daeSBarry Smith PetscMPIInt size, rank; 13525c6c1daeSBarry Smith PetscBool *localStageUsed, *stageUsed; 13535c6c1daeSBarry Smith PetscBool *localStageVisible, *stageVisible; 13545c6c1daeSBarry Smith int numStages, localNumEvents, numEvents; 135537b78d16SBarry Smith int stage, oclass; 13565c6c1daeSBarry Smith PetscLogEvent event; 13575c6c1daeSBarry Smith PetscErrorCode ierr; 13585c6c1daeSBarry Smith char version[256]; 13595c6c1daeSBarry Smith MPI_Comm comm; 13605c6c1daeSBarry Smith 13615c6c1daeSBarry Smith PetscFunctionBegin; 13625c6c1daeSBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 13635c6c1daeSBarry Smith ierr = PetscViewerASCIIGetPointer(viewer,&fd);CHKERRQ(ierr); 13645c6c1daeSBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 13655c6c1daeSBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 13665c6c1daeSBarry Smith /* Get the total elapsed time */ 13678563dfccSBarry Smith PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 13685c6c1daeSBarry Smith 13695c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr); 13705c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "*** WIDEN YOUR WINDOW TO 120 CHARACTERS. Use 'enscript -r -fCourier9' to print this document ***\n");CHKERRQ(ierr); 13715c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr); 13725c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n---------------------------------------------- PETSc Performance Summary: ----------------------------------------------\n\n");CHKERRQ(ierr); 1373217044c2SLisandro Dalcin ierr = PetscLogViewWarnSync(comm,fd);CHKERRQ(ierr); 1374f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 13755c6c1daeSBarry Smith ierr = PetscGetArchType(arch,sizeof(arch));CHKERRQ(ierr); 13765c6c1daeSBarry Smith ierr = PetscGetHostName(hostname,sizeof(hostname));CHKERRQ(ierr); 13775c6c1daeSBarry Smith ierr = PetscGetUserName(username,sizeof(username));CHKERRQ(ierr); 13785c6c1daeSBarry Smith ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr); 13795c6c1daeSBarry Smith ierr = PetscGetDate(date,sizeof(date));CHKERRQ(ierr); 13805c6c1daeSBarry Smith ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr); 13815c6c1daeSBarry Smith if (size == 1) { 13825c6c1daeSBarry 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); 13835c6c1daeSBarry Smith } else { 13845c6c1daeSBarry 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); 13855c6c1daeSBarry Smith } 13865c6c1daeSBarry Smith 13875c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Using %s\n", version);CHKERRQ(ierr); 13885c6c1daeSBarry Smith 13895c6c1daeSBarry Smith /* Must preserve reduction count before we go on */ 13905c6c1daeSBarry Smith red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 13915c6c1daeSBarry Smith 13925c6c1daeSBarry Smith /* Calculate summary information */ 13935c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n Max Max/Min Avg Total \n");CHKERRQ(ierr); 13945c6c1daeSBarry Smith /* Time */ 1395b2566f29SBarry Smith ierr = MPIU_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1396b2566f29SBarry Smith ierr = MPIU_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1397b2566f29SBarry Smith ierr = MPIU_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1398217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1399217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1400217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Time (sec): %5.3e %7.3f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 14015c6c1daeSBarry Smith TotalTime = tot; 14025c6c1daeSBarry Smith /* Objects */ 14035c6c1daeSBarry Smith avg = (PetscLogDouble) petsc_numObjects; 1404b2566f29SBarry Smith ierr = MPIU_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1405b2566f29SBarry Smith ierr = MPIU_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1406b2566f29SBarry Smith ierr = MPIU_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1407217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1408217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1409217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Objects: %5.3e %7.3f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 14105c6c1daeSBarry Smith /* Flops */ 1411b2566f29SBarry Smith ierr = MPIU_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1412b2566f29SBarry Smith ierr = MPIU_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1413b2566f29SBarry Smith ierr = MPIU_Allreduce(&petsc_TotalFlops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1414217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1415217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1416217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Flop: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14175c6c1daeSBarry Smith TotalFlops = tot; 14185c6c1daeSBarry Smith /* Flops/sec -- Must talk to Barry here */ 1419217044c2SLisandro Dalcin if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime; else flops = 0.0; 1420b2566f29SBarry Smith ierr = MPIU_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1421b2566f29SBarry Smith ierr = MPIU_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1422b2566f29SBarry Smith ierr = MPIU_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1423217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1424217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1425217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Flop/sec: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14265c6c1daeSBarry Smith /* Memory */ 14275c6c1daeSBarry Smith ierr = PetscMallocGetMaximumUsage(&mem);CHKERRQ(ierr); 14285c6c1daeSBarry Smith if (mem > 0.0) { 1429b2566f29SBarry Smith ierr = MPIU_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1430217044c2SLisandro Dalcin ierr = MPIU_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1431b2566f29SBarry Smith ierr = MPIU_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1432217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1433217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1434217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Memory: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14355c6c1daeSBarry Smith } 14365c6c1daeSBarry Smith /* Messages */ 14375c6c1daeSBarry Smith mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct); 1438b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1439b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1440b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1441217044c2SLisandro Dalcin avg = tot/((PetscLogDouble) size); 1442217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1443217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Messages: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14445c6c1daeSBarry Smith numMessages = tot; 14455c6c1daeSBarry Smith /* Message Lengths */ 14465c6c1daeSBarry Smith mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len); 1447b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1448b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1449b2566f29SBarry Smith ierr = MPIU_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1450217044c2SLisandro Dalcin if (numMessages != 0) avg = tot/numMessages; else avg = 0.0; 1451217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1452217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Message Lengths: %5.3e %7.3f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14535c6c1daeSBarry Smith messageLength = tot; 14545c6c1daeSBarry Smith /* Reductions */ 1455b2566f29SBarry Smith ierr = MPIU_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 1456b2566f29SBarry Smith ierr = MPIU_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 1457b2566f29SBarry Smith ierr = MPIU_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1458217044c2SLisandro Dalcin if (min != 0.0) ratio = max/min; else ratio = 0.0; 1459217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "MPI Reductions: %5.3e %7.3f\n", max, ratio);CHKERRQ(ierr); 14605c6c1daeSBarry Smith numReductions = red; /* wrong because uses count from process zero */ 14615c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n");CHKERRQ(ierr); 1462d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " e.g., VecAXPY() for real vectors of length N --> 2N flop\n");CHKERRQ(ierr); 1463d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " and VecAXPY() for complex vectors of length N --> 8N flop\n");CHKERRQ(ierr); 14645c6c1daeSBarry Smith 14655c6c1daeSBarry Smith /* Get total number of stages -- 14665c6c1daeSBarry Smith Currently, a single processor can register more stages than another, but stages must all be registered in order. 14675c6c1daeSBarry Smith We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID. 14685c6c1daeSBarry Smith This seems best accomplished by assoicating a communicator with each stage. 14695c6c1daeSBarry Smith */ 147037b78d16SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1471b2566f29SBarry Smith ierr = MPIU_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1472785e854fSJed Brown ierr = PetscMalloc1(numStages, &localStageUsed);CHKERRQ(ierr); 1473785e854fSJed Brown ierr = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr); 1474785e854fSJed Brown ierr = PetscMalloc1(numStages, &localStageVisible);CHKERRQ(ierr); 1475785e854fSJed Brown ierr = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr); 14765c6c1daeSBarry Smith if (numStages > 0) { 14775c6c1daeSBarry Smith stageInfo = stageLog->stageInfo; 14785c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 14795c6c1daeSBarry Smith if (stage < stageLog->numStages) { 14805c6c1daeSBarry Smith localStageUsed[stage] = stageInfo[stage].used; 14815c6c1daeSBarry Smith localStageVisible[stage] = stageInfo[stage].perfInfo.visible; 14825c6c1daeSBarry Smith } else { 14835c6c1daeSBarry Smith localStageUsed[stage] = PETSC_FALSE; 14845c6c1daeSBarry Smith localStageVisible[stage] = PETSC_TRUE; 14855c6c1daeSBarry Smith } 14865c6c1daeSBarry Smith } 1487b2566f29SBarry Smith ierr = MPIU_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm);CHKERRQ(ierr); 1488b2566f29SBarry Smith ierr = MPIU_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr); 14895c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 14905c6c1daeSBarry Smith if (stageUsed[stage]) { 1491217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "\nSummary of Stages: ----- Time ------ ----- Flop ------ --- Messages --- -- Message Lengths -- -- Reductions --\n");CHKERRQ(ierr); 1492217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " Avg %%Total Avg %%Total Count %%Total Avg %%Total Count %%Total \n");CHKERRQ(ierr); 14935c6c1daeSBarry Smith break; 14945c6c1daeSBarry Smith } 14955c6c1daeSBarry Smith } 14965c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 14975c6c1daeSBarry Smith if (!stageUsed[stage]) continue; 149850a9567dSMatthew G. Knepley /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 14995c6c1daeSBarry Smith if (localStageUsed[stage]) { 150050a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 150150a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 150250a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 150350a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 150450a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15055c6c1daeSBarry Smith name = stageInfo[stage].name; 15065c6c1daeSBarry Smith } else { 150750a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 150850a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 150950a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 151050a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 151150a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15125c6c1daeSBarry Smith name = ""; 15135c6c1daeSBarry Smith } 15145c6c1daeSBarry Smith mess *= 0.5; messLen *= 0.5; red /= size; 15155c6c1daeSBarry Smith if (TotalTime != 0.0) fracTime = stageTime/TotalTime; else fracTime = 0.0; 15165c6c1daeSBarry Smith if (TotalFlops != 0.0) fracFlops = flops/TotalFlops; else fracFlops = 0.0; 15175c6c1daeSBarry Smith /* Talk to Barry if (stageTime != 0.0) flops = (size*flops)/stageTime; else flops = 0.0; */ 15185c6c1daeSBarry Smith if (numMessages != 0.0) fracMessages = mess/numMessages; else fracMessages = 0.0; 1519e96a4d02SJunchao Zhang if (mess != 0.0) avgMessLen = messLen/mess; else avgMessLen = 0.0; 15205c6c1daeSBarry Smith if (messageLength != 0.0) fracLength = messLen/messageLength; else fracLength = 0.0; 15215c6c1daeSBarry Smith if (numReductions != 0.0) fracReductions = red/numReductions; else fracReductions = 0.0; 15225c6c1daeSBarry 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", 15235c6c1daeSBarry Smith stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops, 15245c6c1daeSBarry Smith mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr); 15255c6c1daeSBarry Smith } 15265c6c1daeSBarry Smith } 15275c6c1daeSBarry Smith 1528806fa848SBarry Smith ierr = PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 15295c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n");CHKERRQ(ierr); 15305c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Phase summary info:\n");CHKERRQ(ierr); 15315c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Count: number of times phase was executed\n");CHKERRQ(ierr); 1532d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " Time and Flop: Max - maximum over all processors\n");CHKERRQ(ierr); 15335c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Ratio - ratio of maximum to minimum over all processors\n");CHKERRQ(ierr); 15345c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Mess: number of messages sent\n");CHKERRQ(ierr); 1535217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, " AvgLen: average message length (bytes)\n");CHKERRQ(ierr); 15365c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Reduct: number of global reductions\n");CHKERRQ(ierr); 15375c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Global: entire computation\n");CHKERRQ(ierr); 15385c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n");CHKERRQ(ierr); 1539d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " %%T - percent time in this phase %%F - percent flop in this phase\n");CHKERRQ(ierr); 15405c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " %%M - percent messages in this phase %%L - percent message lengths in this phase\n");CHKERRQ(ierr); 15415c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " %%R - percent reductions in this phase\n");CHKERRQ(ierr); 1542d4aa7d5fSBarry Smith ierr = PetscFPrintf(comm, fd, " Total Mflop/s: 10e-6 * (sum of flop over all processors)/(max time over all processors)\n");CHKERRQ(ierr); 1543e3ed9ee7SBarry Smith if (PetscLogMemory) { 1544e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " Malloc Mbytes: Memory allocated and kept during event (sum over all calls to event)\n");CHKERRQ(ierr); 1545e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " EMalloc Mbytes: extra memory allocated during event and then freed (maximum over all calls to events)\n");CHKERRQ(ierr); 1546e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " MMalloc Mbytes: Increase in high water mark of allocated memory (sum over all calls to event)\n");CHKERRQ(ierr); 1547e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd, " RMI Mbytes: Increase in resident memory (sum over all calls to event)\n");CHKERRQ(ierr); 1548e3ed9ee7SBarry Smith } 1549806fa848SBarry Smith ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 15505c6c1daeSBarry Smith 1551f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 15525c6c1daeSBarry Smith 15535c6c1daeSBarry Smith /* Report events */ 1554e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd,"Event Count Time (sec) Flop --- Global --- --- Stage ---- Total");CHKERRQ(ierr); 1555e3ed9ee7SBarry Smith if (PetscLogMemory) { 1556e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd," Malloc EMalloc MMalloc RMI\n");CHKERRQ(ierr); 1557e3ed9ee7SBarry Smith } else { 1558e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 1559e3ed9ee7SBarry Smith } 1560e3ed9ee7SBarry 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); 1561e3ed9ee7SBarry Smith if (PetscLogMemory) { 1562e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd," Mbytes Mbytes Mbytes Mbytes\n");CHKERRQ(ierr); 1563e3ed9ee7SBarry Smith } else { 1564e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 1565e3ed9ee7SBarry Smith } 1566806fa848SBarry Smith ierr = PetscFPrintf(comm,fd,"------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 15675c6c1daeSBarry Smith 15685c6c1daeSBarry Smith /* Problem: The stage name will not show up unless the stage executed on proc 1 */ 15695c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 15705c6c1daeSBarry Smith if (!stageVisible[stage]) continue; 157150a9567dSMatthew G. Knepley /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 15725c6c1daeSBarry Smith if (localStageUsed[stage]) { 15735c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 157450a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 157550a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 157650a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 157750a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 157850a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15795c6c1daeSBarry Smith } else { 15805c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 158150a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 158250a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 158350a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 158450a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 158550a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15865c6c1daeSBarry Smith } 15875c6c1daeSBarry Smith mess *= 0.5; messLen *= 0.5; red /= size; 15885c6c1daeSBarry Smith 15895c6c1daeSBarry Smith /* Get total number of events in this stage -- 15905c6c1daeSBarry Smith Currently, a single processor can register more events than another, but events must all be registered in order, 15915c6c1daeSBarry Smith just like stages. We can removed this requirement if necessary by having a global event numbering and indirection 1592217044c2SLisandro Dalcin on the event ID. This seems best accomplished by associating a communicator with each stage. 15935c6c1daeSBarry Smith 15945c6c1daeSBarry Smith Problem: If the event did not happen on proc 1, its name will not be available. 15955c6c1daeSBarry Smith Problem: Event visibility is not implemented 15965c6c1daeSBarry Smith */ 15975c6c1daeSBarry Smith if (localStageUsed[stage]) { 15985c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo; 15995c6c1daeSBarry Smith localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents; 1600a297a907SKarl Rupp } else localNumEvents = 0; 1601b2566f29SBarry Smith ierr = MPIU_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 16025c6c1daeSBarry Smith for (event = 0; event < numEvents; event++) { 160350a9567dSMatthew G. Knepley /* CANNOT use MPIU_Allreduce() since it might fail the line number check */ 16045c6c1daeSBarry Smith if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) { 1605217044c2SLisandro Dalcin if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; else flopr = 0.0; 160650a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 160750a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 160850a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 160950a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 161050a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 161150a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 161250a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 161350a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 161450a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1615217044c2SLisandro Dalcin ierr = MPI_Allreduce(&eventInfo[event].count, &minC, 1, MPI_INT, MPI_MIN, comm);CHKERRQ(ierr); 1616217044c2SLisandro Dalcin ierr = MPI_Allreduce(&eventInfo[event].count, &maxC, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1617e3ed9ee7SBarry Smith if (PetscLogMemory) { 1618e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&eventInfo[event].memIncrease, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1619e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&eventInfo[event].mallocSpace, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1620e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&eventInfo[event].mallocIncrease, &malmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1621e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&eventInfo[event].mallocIncreaseEvent, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1622e3ed9ee7SBarry Smith } 16235c6c1daeSBarry Smith name = stageLog->eventLog->eventInfo[event].name; 16245c6c1daeSBarry Smith } else { 16255c6c1daeSBarry Smith flopr = 0.0; 162650a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 162750a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 162850a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 162950a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 163050a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 163150a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 163250a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 163350a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 163450a9567dSMatthew G. Knepley ierr = MPI_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1635217044c2SLisandro Dalcin ierr = MPI_Allreduce(&ierr, &minC, 1, MPI_INT, MPI_MIN, comm);CHKERRQ(ierr); 1636217044c2SLisandro Dalcin ierr = MPI_Allreduce(&ierr, &maxC, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1637e3ed9ee7SBarry Smith if (PetscLogMemory) { 1638e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&zero, &mem, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1639e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&zero, &mal, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1640e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&zero, &malmax, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1641e3ed9ee7SBarry Smith ierr = MPI_Allreduce(&zero, &emalmax,1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1642e3ed9ee7SBarry Smith } 16435c6c1daeSBarry Smith name = ""; 16445c6c1daeSBarry Smith } 16455c6c1daeSBarry Smith if (mint < 0.0) { 16465c6c1daeSBarry 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); 16475c6c1daeSBarry Smith mint = 0; 16485c6c1daeSBarry Smith } 1649d4aa7d5fSBarry 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); 16505c6c1daeSBarry Smith totm *= 0.5; totml *= 0.5; totr /= size; 16515c6c1daeSBarry Smith 1652217044c2SLisandro Dalcin if (maxC != 0) { 1653217044c2SLisandro Dalcin if (minC != 0) ratC = ((PetscLogDouble)maxC)/minC;else ratC = 0.0; 16545c6c1daeSBarry Smith if (mint != 0.0) ratt = maxt/mint; else ratt = 0.0; 16555c6c1daeSBarry Smith if (minf != 0.0) ratf = maxf/minf; else ratf = 0.0; 16565c6c1daeSBarry Smith if (TotalTime != 0.0) fracTime = tott/TotalTime; else fracTime = 0.0; 16575c6c1daeSBarry Smith if (TotalFlops != 0.0) fracFlops = totf/TotalFlops; else fracFlops = 0.0; 16585c6c1daeSBarry Smith if (stageTime != 0.0) fracStageTime = tott/stageTime; else fracStageTime = 0.0; 16595c6c1daeSBarry Smith if (flops != 0.0) fracStageFlops = totf/flops; else fracStageFlops = 0.0; 16605c6c1daeSBarry Smith if (numMessages != 0.0) fracMess = totm/numMessages; else fracMess = 0.0; 16615c6c1daeSBarry Smith if (messageLength != 0.0) fracMessLen = totml/messageLength; else fracMessLen = 0.0; 16625c6c1daeSBarry Smith if (numReductions != 0.0) fracRed = totr/numReductions; else fracRed = 0.0; 16635c6c1daeSBarry Smith if (mess != 0.0) fracStageMess = totm/mess; else fracStageMess = 0.0; 16645c6c1daeSBarry Smith if (messLen != 0.0) fracStageMessLen = totml/messLen; else fracStageMessLen = 0.0; 16655c6c1daeSBarry Smith if (red != 0.0) fracStageRed = totr/red; else fracStageRed = 0.0; 16665c6c1daeSBarry Smith if (totm != 0.0) totml /= totm; else totml = 0.0; 16675c6c1daeSBarry Smith if (maxt != 0.0) flopr = totf/maxt; else flopr = 0.0; 1668411f5eb9SRichard 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); 16695c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, 1670e3ed9ee7SBarry 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", 1671217044c2SLisandro Dalcin name, maxC, ratC, maxt, ratt, maxf, ratf, totm, totml, totr, 16725c6c1daeSBarry Smith 100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed, 16735c6c1daeSBarry Smith 100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed, 1674c068d9bbSLisandro Dalcin PetscAbs(flopr)/1.0e6);CHKERRQ(ierr); 1675e3ed9ee7SBarry Smith if (PetscLogMemory) { 1676e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd," %5.0f %5.0f %5.0f %5.0f\n",mal/1.0e6,emalmax/1.0e6,malmax/1.0e6,mem/1.0e6);CHKERRQ(ierr); 1677e3ed9ee7SBarry Smith } else { 1678e3ed9ee7SBarry Smith ierr = PetscFPrintf(comm, fd,"\n");CHKERRQ(ierr); 1679e3ed9ee7SBarry Smith } 16805c6c1daeSBarry Smith } 16815c6c1daeSBarry Smith } 16825c6c1daeSBarry Smith } 16835c6c1daeSBarry Smith 16845c6c1daeSBarry Smith /* Memory usage and object creation */ 1685a297a907SKarl Rupp ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 16865c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 16875c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n");CHKERRQ(ierr); 16885c6c1daeSBarry Smith 16895c6c1daeSBarry Smith /* Right now, only stages on the first processor are reported here, meaning only objects associated with 16905c6c1daeSBarry Smith the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then 16915c6c1daeSBarry Smith stats for stages local to processor sets. 16925c6c1daeSBarry Smith */ 16935c6c1daeSBarry Smith /* We should figure out the longest object name here (now 20 characters) */ 16945c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Object Type Creations Destructions Memory Descendants' Mem.\n");CHKERRQ(ierr); 16955c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Reports information only for process 0.\n");CHKERRQ(ierr); 16965c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16975c6c1daeSBarry Smith if (localStageUsed[stage]) { 16985c6c1daeSBarry Smith classInfo = stageLog->stageInfo[stage].classLog->classInfo; 16995c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 17005c6c1daeSBarry Smith for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) { 17015c6c1daeSBarry Smith if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) { 17025c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%20s %5d %5d %11.0f %g\n", stageLog->classLog->classInfo[oclass].name, 17035c6c1daeSBarry Smith classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem, 17045c6c1daeSBarry Smith classInfo[oclass].descMem);CHKERRQ(ierr); 17055c6c1daeSBarry Smith } 17065c6c1daeSBarry Smith } 17075c6c1daeSBarry Smith } else { 1708cf019ec6SStefano Zampini if (!localStageVisible[stage]) continue; 17095c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 17105c6c1daeSBarry Smith } 17115c6c1daeSBarry Smith } 17125c6c1daeSBarry Smith 17135c6c1daeSBarry Smith ierr = PetscFree(localStageUsed);CHKERRQ(ierr); 17145c6c1daeSBarry Smith ierr = PetscFree(stageUsed);CHKERRQ(ierr); 17155c6c1daeSBarry Smith ierr = PetscFree(localStageVisible);CHKERRQ(ierr); 17165c6c1daeSBarry Smith ierr = PetscFree(stageVisible);CHKERRQ(ierr); 17175c6c1daeSBarry Smith 17185c6c1daeSBarry Smith /* Information unrelated to this particular run */ 1719a297a907SKarl Rupp ierr = PetscFPrintf(comm, fd, "========================================================================================================================\n");CHKERRQ(ierr); 17208563dfccSBarry Smith PetscTime(&y); 17218563dfccSBarry Smith PetscTime(&x); 17228563dfccSBarry Smith PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 17238563dfccSBarry Smith PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 17245c6c1daeSBarry Smith ierr = PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0);CHKERRQ(ierr); 17255c6c1daeSBarry Smith /* MPI information */ 17265c6c1daeSBarry Smith if (size > 1) { 17275c6c1daeSBarry Smith MPI_Status status; 17285c6c1daeSBarry Smith PetscMPIInt tag; 17295c6c1daeSBarry Smith MPI_Comm newcomm; 17305c6c1daeSBarry Smith 17315c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 17328563dfccSBarry Smith PetscTime(&x); 17335c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 17345c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 17355c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 17365c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 17375c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 17388563dfccSBarry Smith PetscTime(&y); 17395c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0);CHKERRQ(ierr); 17405c6c1daeSBarry Smith ierr = PetscCommDuplicate(comm,&newcomm, &tag);CHKERRQ(ierr); 17415c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 17425c6c1daeSBarry Smith if (rank) { 1743217044c2SLisandro Dalcin ierr = MPI_Recv(NULL, 0, MPI_INT, rank-1, tag, newcomm, &status);CHKERRQ(ierr); 1744217044c2SLisandro Dalcin ierr = MPI_Send(NULL, 0, MPI_INT, (rank+1)%size, tag, newcomm);CHKERRQ(ierr); 17455c6c1daeSBarry Smith } else { 17468563dfccSBarry Smith PetscTime(&x); 1747217044c2SLisandro Dalcin ierr = MPI_Send(NULL, 0, MPI_INT, 1, tag, newcomm);CHKERRQ(ierr); 1748217044c2SLisandro Dalcin ierr = MPI_Recv(NULL, 0, MPI_INT, size-1, tag, newcomm, &status);CHKERRQ(ierr); 17498563dfccSBarry Smith PetscTime(&y); 17505c6c1daeSBarry Smith ierr = PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size);CHKERRQ(ierr); 17515c6c1daeSBarry Smith } 17525c6c1daeSBarry Smith ierr = PetscCommDestroy(&newcomm);CHKERRQ(ierr); 17535c6c1daeSBarry Smith } 1754c5929fdfSBarry Smith ierr = PetscOptionsView(NULL,viewer);CHKERRQ(ierr); 17555c6c1daeSBarry Smith 17565c6c1daeSBarry Smith /* Machine and compile information */ 17575c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS) 17585c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n");CHKERRQ(ierr); 17595c6c1daeSBarry Smith #else 17605c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n");CHKERRQ(ierr); 17615c6c1daeSBarry Smith #endif 1762217044c2SLisandro Dalcin #if defined(PETSC_USE_64BIT_INDICES) 1763217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Compiled with 64 bit PetscInt\n");CHKERRQ(ierr); 1764217044c2SLisandro Dalcin #elif defined(PETSC_USE___FLOAT128) 1765217044c2SLisandro Dalcin ierr = PetscFPrintf(comm, fd, "Compiled with 32 bit PetscInt\n");CHKERRQ(ierr); 1766217044c2SLisandro Dalcin #endif 17675c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 17685c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 17695f27b2e0SBarry Smith #elif defined(PETSC_USE___FLOAT128) 17705f27b2e0SBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with 128 bit precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 17715c6c1daeSBarry Smith #endif 17725c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE) 17735c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with single precision matrices\n");CHKERRQ(ierr); 17745c6c1daeSBarry Smith #else 17755c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n");CHKERRQ(ierr); 17765c6c1daeSBarry Smith #endif 17775c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n", 17785c6c1daeSBarry Smith (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt));CHKERRQ(ierr); 17795c6c1daeSBarry Smith 17805c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions);CHKERRQ(ierr); 17815c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petscmachineinfo);CHKERRQ(ierr); 17825c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsccompilerinfo);CHKERRQ(ierr); 17835c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo);CHKERRQ(ierr); 17845c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsclinkerinfo);CHKERRQ(ierr); 17855c6c1daeSBarry Smith 17865c6c1daeSBarry Smith /* Cleanup */ 17875c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 1788f4091ad2SBarry Smith ierr = PetscLogViewWarnDebugging(comm,fd);CHKERRQ(ierr); 17895c6c1daeSBarry Smith PetscFunctionReturn(0); 17905c6c1daeSBarry Smith } 17915c6c1daeSBarry Smith 17927d6c928cSSatish Balay /*@C 17937d6c928cSSatish Balay PetscLogView - Prints a summary of the logging. 17945c6c1daeSBarry Smith 17955c6c1daeSBarry Smith Collective over MPI_Comm 17965c6c1daeSBarry Smith 17975c6c1daeSBarry Smith Input Parameter: 1798f14045dbSBarry Smith . viewer - an ASCII viewer 17995c6c1daeSBarry Smith 18005c6c1daeSBarry Smith Options Database Keys: 1801bb1d7374SBarry Smith + -log_view [:filename] - Prints summary of log information 1802bb1d7374SBarry Smith . -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file 1803607d249eSBarry 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) 1804bb1d7374SBarry Smith . -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation 1805bb1d7374SBarry Smith - -log_trace [filename] - Displays a trace of what each process is doing 18065c6c1daeSBarry Smith 18075c6c1daeSBarry Smith Notes: 1808bb1d7374SBarry Smith It is possible to control the logging programatically but we recommend using the options database approach whenever possible 18095c6c1daeSBarry Smith By default the summary is printed to stdout. 18105c6c1daeSBarry Smith 1811bb1d7374SBarry Smith Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin() 1812bb1d7374SBarry Smith 1813bb1d7374SBarry Smith If PETSc is configured with --with-logging=0 then this functionality is not available 1814bb1d7374SBarry Smith 1815607d249eSBarry Smith To view the nested XML format filename.xml first copy ${PETSC_DIR}/share/petsc/xml/performance_xml2html.xsl to the current 1816607d249eSBarry Smith directory then open filename.xml with your browser. Specific notes for certain browsers 1817607d249eSBarry Smith $ Firefox and Internet explorer - simply open the file 1818607d249eSBarry Smith $ Google Chrome - you must start up Chrome with the option --allow-file-access-from-files 1819a8d69d7bSBarry Smith $ Safari - see https://ccm.net/faq/36342-safari-how-to-enable-local-file-access 1820607d249eSBarry 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 1821607d249eSBarry Smith your browser. 18222add09c0SLisandro Dalcin Alternatively, use the script ${PETSC_DIR}/lib/petsc/bin/petsc-performance-view to automatically open a new browser 18232add09c0SLisandro Dalcin window and render the XML log file contents. 1824607d249eSBarry Smith 1825bb1d7374SBarry Smith The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij MARITIME RESEARCH INSTITUTE NETHERLANDS 1826bb1d7374SBarry Smith 18275c6c1daeSBarry Smith Level: beginner 18285c6c1daeSBarry Smith 1829bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogDump() 18305c6c1daeSBarry Smith @*/ 1831f14045dbSBarry Smith PetscErrorCode PetscLogView(PetscViewer viewer) 18325c6c1daeSBarry Smith { 18335c6c1daeSBarry Smith PetscErrorCode ierr; 1834f14045dbSBarry Smith PetscBool isascii; 1835f14045dbSBarry Smith PetscViewerFormat format; 183637b78d16SBarry Smith int stage, lastStage; 183737b78d16SBarry Smith PetscStageLog stageLog; 18385c6c1daeSBarry Smith 18395c6c1daeSBarry Smith PetscFunctionBegin; 1840609bdbeeSBarry Smith if (!PetscLogPLB) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Must use -log_view or PetscLogDefaultBegin() before calling this routine"); 184137b78d16SBarry Smith /* Pop off any stages the user forgot to remove */ 184237b78d16SBarry Smith lastStage = 0; 184337b78d16SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 184437b78d16SBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 184537b78d16SBarry Smith while (stage >= 0) { 184637b78d16SBarry Smith lastStage = stage; 184737b78d16SBarry Smith ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 184837b78d16SBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 184937b78d16SBarry Smith } 1850f14045dbSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 1851f14045dbSBarry Smith if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Currently can only view logging to ASCII"); 1852f14045dbSBarry Smith ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr); 1853f14045dbSBarry Smith if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) { 1854f14045dbSBarry Smith ierr = PetscLogView_Default(viewer);CHKERRQ(ierr); 1855f14045dbSBarry Smith } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) { 1856f14045dbSBarry Smith ierr = PetscLogView_Detailed(viewer);CHKERRQ(ierr); 185738144912Sdeepblu2718 } else if (format == PETSC_VIEWER_ASCII_CSV) { 185838144912Sdeepblu2718 ierr = PetscLogView_CSV(viewer);CHKERRQ(ierr); 1859bb1d7374SBarry Smith } else if (format == PETSC_VIEWER_ASCII_XML) { 1860bb1d7374SBarry Smith ierr = PetscLogView_Nested(viewer);CHKERRQ(ierr); 18615c6c1daeSBarry Smith } 186237b78d16SBarry Smith ierr = PetscStageLogPush(stageLog, lastStage);CHKERRQ(ierr); 18635c6c1daeSBarry Smith PetscFunctionReturn(0); 18645c6c1daeSBarry Smith } 18655c6c1daeSBarry Smith 1866f14045dbSBarry Smith /*@C 1867f14045dbSBarry Smith PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed. 1868f14045dbSBarry Smith 1869f14045dbSBarry Smith Collective on PETSC_COMM_WORLD 1870f14045dbSBarry Smith 1871f14045dbSBarry Smith Not normally called by user 1872f14045dbSBarry Smith 1873f14045dbSBarry Smith Level: intermediate 1874f14045dbSBarry Smith 1875f14045dbSBarry Smith @*/ 1876f14045dbSBarry Smith PetscErrorCode PetscLogViewFromOptions(void) 1877f14045dbSBarry Smith { 1878f14045dbSBarry Smith PetscErrorCode ierr; 1879f14045dbSBarry Smith PetscViewer viewer; 1880f14045dbSBarry Smith PetscBool flg; 1881f14045dbSBarry Smith PetscViewerFormat format; 1882f14045dbSBarry Smith 1883f14045dbSBarry Smith PetscFunctionBegin; 188416413a6aSBarry Smith ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,NULL,"-log_view",&viewer,&format,&flg);CHKERRQ(ierr); 1885f14045dbSBarry Smith if (flg) { 1886f14045dbSBarry Smith ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 1887f14045dbSBarry Smith ierr = PetscLogView(viewer);CHKERRQ(ierr); 1888f14045dbSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 1889f14045dbSBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1890f14045dbSBarry Smith } 1891f14045dbSBarry Smith PetscFunctionReturn(0); 1892f14045dbSBarry Smith } 1893f14045dbSBarry Smith 1894f14045dbSBarry Smith 1895f14045dbSBarry Smith 18965c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/ 18975c6c1daeSBarry Smith /*@C 18985c6c1daeSBarry Smith PetscGetFlops - Returns the number of flops used on this processor 18995c6c1daeSBarry Smith since the program began. 19005c6c1daeSBarry Smith 19015c6c1daeSBarry Smith Not Collective 19025c6c1daeSBarry Smith 19035c6c1daeSBarry Smith Output Parameter: 19045c6c1daeSBarry Smith flops - number of floating point operations 19055c6c1daeSBarry Smith 19065c6c1daeSBarry Smith Notes: 19075c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 19085c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 19095c6c1daeSBarry Smith application code. 19105c6c1daeSBarry Smith 19115c6c1daeSBarry Smith Level: intermediate 19125c6c1daeSBarry Smith 19138563dfccSBarry Smith .seealso: PetscTime(), PetscLogFlops() 19145c6c1daeSBarry Smith @*/ 19155c6c1daeSBarry Smith PetscErrorCode PetscGetFlops(PetscLogDouble *flops) 19165c6c1daeSBarry Smith { 19175c6c1daeSBarry Smith PetscFunctionBegin; 19185c6c1daeSBarry Smith *flops = petsc_TotalFlops; 19195c6c1daeSBarry Smith PetscFunctionReturn(0); 19205c6c1daeSBarry Smith } 19215c6c1daeSBarry Smith 19225c6c1daeSBarry Smith PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 19235c6c1daeSBarry Smith { 19245c6c1daeSBarry Smith PetscErrorCode ierr; 19255c6c1daeSBarry Smith size_t fullLength; 19265c6c1daeSBarry Smith va_list Argp; 19275c6c1daeSBarry Smith 19285c6c1daeSBarry Smith PetscFunctionBegin; 19295c6c1daeSBarry Smith if (!petsc_logObjects) PetscFunctionReturn(0); 19305c6c1daeSBarry Smith va_start(Argp, format); 19315c6c1daeSBarry Smith ierr = PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp);CHKERRQ(ierr); 19325c6c1daeSBarry Smith va_end(Argp); 19335c6c1daeSBarry Smith PetscFunctionReturn(0); 19345c6c1daeSBarry Smith } 19355c6c1daeSBarry Smith 19365c6c1daeSBarry Smith 19375c6c1daeSBarry Smith /*MC 19385c6c1daeSBarry Smith PetscLogFlops - Adds floating point operations to the global counter. 19395c6c1daeSBarry Smith 19405c6c1daeSBarry Smith Synopsis: 1941aaa7dc30SBarry Smith #include <petsclog.h> 19425c6c1daeSBarry Smith PetscErrorCode PetscLogFlops(PetscLogDouble f) 19435c6c1daeSBarry Smith 19445c6c1daeSBarry Smith Not Collective 19455c6c1daeSBarry Smith 19465c6c1daeSBarry Smith Input Parameter: 19475c6c1daeSBarry Smith . f - flop counter 19485c6c1daeSBarry Smith 19495c6c1daeSBarry Smith 19505c6c1daeSBarry Smith Usage: 19515c6c1daeSBarry Smith .vb 19525c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 19535c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 19545c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 19555c6c1daeSBarry Smith [code segment to monitor] 19565c6c1daeSBarry Smith PetscLogFlops(user_flops) 19575c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 19585c6c1daeSBarry Smith .ve 19595c6c1daeSBarry Smith 19605c6c1daeSBarry Smith Notes: 19615c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 19625c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 19635c6c1daeSBarry Smith application code. 19645c6c1daeSBarry Smith 19655c6c1daeSBarry Smith Level: intermediate 19665c6c1daeSBarry Smith 19675c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscGetFlops() 19685c6c1daeSBarry Smith 19695c6c1daeSBarry Smith M*/ 19705c6c1daeSBarry Smith 19715c6c1daeSBarry Smith /*MC 19725c6c1daeSBarry Smith PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice) 19735c6c1daeSBarry Smith to get accurate timings 19745c6c1daeSBarry Smith 19755c6c1daeSBarry Smith Synopsis: 1976aaa7dc30SBarry Smith #include <petsclog.h> 19775c6c1daeSBarry Smith void PetscPreLoadBegin(PetscBool flag,char *name); 19785c6c1daeSBarry Smith 19795c6c1daeSBarry Smith Not Collective 19805c6c1daeSBarry Smith 19815c6c1daeSBarry Smith Input Parameter: 19825c6c1daeSBarry Smith + flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden 19835c6c1daeSBarry Smith with command line option -preload true or -preload false 1984609bdbeeSBarry Smith - name - name of first stage (lines of code timed separately with -log_view) to 19855c6c1daeSBarry Smith be preloaded 19865c6c1daeSBarry Smith 19875c6c1daeSBarry Smith Usage: 19885c6c1daeSBarry Smith .vb 19895c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 19905c6c1daeSBarry Smith lines of code 19915c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 19925c6c1daeSBarry Smith lines of code 19935c6c1daeSBarry Smith PetscPreLoadEnd(); 19945c6c1daeSBarry Smith .ve 19955c6c1daeSBarry Smith 199695452b02SPatrick Sanan Notes: 199795452b02SPatrick Sanan Only works in C/C++, not Fortran 19985c6c1daeSBarry Smith 19995c6c1daeSBarry Smith Flags available within the macro. 20005c6c1daeSBarry Smith + PetscPreLoadingUsed - true if we are or have done preloading 20015c6c1daeSBarry Smith . PetscPreLoadingOn - true if it is CURRENTLY doing preload 20025c6c1daeSBarry Smith . PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second 20035c6c1daeSBarry Smith - PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on 20045c6c1daeSBarry Smith The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin() 20055c6c1daeSBarry Smith and PetscPreLoadEnd() 20065c6c1daeSBarry Smith 20075c6c1daeSBarry Smith Level: intermediate 20085c6c1daeSBarry Smith 20095c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage() 20105c6c1daeSBarry Smith 20115c6c1daeSBarry Smith 20125c6c1daeSBarry Smith M*/ 20135c6c1daeSBarry Smith 20145c6c1daeSBarry Smith /*MC 20155c6c1daeSBarry Smith PetscPreLoadEnd - End a segment of code that may be preloaded (run twice) 20165c6c1daeSBarry Smith to get accurate timings 20175c6c1daeSBarry Smith 20185c6c1daeSBarry Smith Synopsis: 2019aaa7dc30SBarry Smith #include <petsclog.h> 20205c6c1daeSBarry Smith void PetscPreLoadEnd(void); 20215c6c1daeSBarry Smith 20225c6c1daeSBarry Smith Not Collective 20235c6c1daeSBarry Smith 20245c6c1daeSBarry Smith Usage: 20255c6c1daeSBarry Smith .vb 20265c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 20275c6c1daeSBarry Smith lines of code 20285c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 20295c6c1daeSBarry Smith lines of code 20305c6c1daeSBarry Smith PetscPreLoadEnd(); 20315c6c1daeSBarry Smith .ve 20325c6c1daeSBarry Smith 203395452b02SPatrick Sanan Notes: 203495452b02SPatrick Sanan only works in C/C++ not fortran 20355c6c1daeSBarry Smith 20365c6c1daeSBarry Smith Level: intermediate 20375c6c1daeSBarry Smith 20385c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadStage() 20395c6c1daeSBarry Smith 20405c6c1daeSBarry Smith M*/ 20415c6c1daeSBarry Smith 20425c6c1daeSBarry Smith /*MC 20435c6c1daeSBarry Smith PetscPreLoadStage - Start a new segment of code to be timed separately. 20445c6c1daeSBarry Smith to get accurate timings 20455c6c1daeSBarry Smith 20465c6c1daeSBarry Smith Synopsis: 2047aaa7dc30SBarry Smith #include <petsclog.h> 20485c6c1daeSBarry Smith void PetscPreLoadStage(char *name); 20495c6c1daeSBarry Smith 20505c6c1daeSBarry Smith Not Collective 20515c6c1daeSBarry Smith 20525c6c1daeSBarry Smith Usage: 20535c6c1daeSBarry Smith .vb 20545c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 20555c6c1daeSBarry Smith lines of code 20565c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 20575c6c1daeSBarry Smith lines of code 20585c6c1daeSBarry Smith PetscPreLoadEnd(); 20595c6c1daeSBarry Smith .ve 20605c6c1daeSBarry Smith 206195452b02SPatrick Sanan Notes: 206295452b02SPatrick Sanan only works in C/C++ not fortran 20635c6c1daeSBarry Smith 20645c6c1daeSBarry Smith Level: intermediate 20655c6c1daeSBarry Smith 20665c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd() 20675c6c1daeSBarry Smith 20685c6c1daeSBarry Smith M*/ 20695c6c1daeSBarry Smith 20705c6c1daeSBarry Smith 20715c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */ 20725c6c1daeSBarry Smith 20735c6c1daeSBarry Smith PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 20745c6c1daeSBarry Smith { 20755c6c1daeSBarry Smith PetscFunctionBegin; 20765c6c1daeSBarry Smith PetscFunctionReturn(0); 20775c6c1daeSBarry Smith } 20785c6c1daeSBarry Smith 20795c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/ 20805c6c1daeSBarry Smith 20815c6c1daeSBarry Smith 20825c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 20835c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID = 0; 20845c6c1daeSBarry Smith 20855c6c1daeSBarry Smith /*@C 20865c6c1daeSBarry Smith PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code. 20875c6c1daeSBarry Smith 20885c6c1daeSBarry Smith Not Collective 20895c6c1daeSBarry Smith 20905c6c1daeSBarry Smith Input Parameter: 20915c6c1daeSBarry Smith . name - The class name 20925c6c1daeSBarry Smith 20935c6c1daeSBarry Smith Output Parameter: 20945c6c1daeSBarry Smith . oclass - The class id or classid 20955c6c1daeSBarry Smith 20965c6c1daeSBarry Smith Level: developer 20975c6c1daeSBarry Smith 20985c6c1daeSBarry Smith @*/ 20995c6c1daeSBarry Smith PetscErrorCode PetscClassIdRegister(const char name[],PetscClassId *oclass) 21005c6c1daeSBarry Smith { 21015c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 21025c6c1daeSBarry Smith PetscStageLog stageLog; 21035c6c1daeSBarry Smith PetscInt stage; 21045c6c1daeSBarry Smith PetscErrorCode ierr; 21055c6c1daeSBarry Smith #endif 21065c6c1daeSBarry Smith 21075c6c1daeSBarry Smith PetscFunctionBegin; 21085c6c1daeSBarry Smith *oclass = ++PETSC_LARGEST_CLASSID; 21095c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 21105c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 21115c6c1daeSBarry Smith ierr = PetscClassRegLogRegister(stageLog->classLog, name, *oclass);CHKERRQ(ierr); 21125c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 21133a88037aSBarry Smith ierr = PetscClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 21145c6c1daeSBarry Smith } 21155c6c1daeSBarry Smith #endif 21165c6c1daeSBarry Smith PetscFunctionReturn(0); 21175c6c1daeSBarry Smith } 2118210b5426SBarry Smith 2119210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE) 2120210b5426SBarry Smith #include <mpe.h> 2121210b5426SBarry Smith 2122210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE; 2123210b5426SBarry Smith 2124495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2125495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2126495fc317SBarry Smith 2127210b5426SBarry Smith /*@C 2128210b5426SBarry Smith PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files 2129210b5426SBarry Smith and slows the program down. 2130210b5426SBarry Smith 2131210b5426SBarry Smith Collective over PETSC_COMM_WORLD 2132210b5426SBarry Smith 2133210b5426SBarry Smith Options Database Keys: 2134a2553e36SBarry Smith . -log_mpe - Prints extensive log information 2135210b5426SBarry Smith 2136210b5426SBarry Smith Notes: 2137609bdbeeSBarry Smith A related routine is PetscLogDefaultBegin() (with the options key -log_view), which is 2138210b5426SBarry Smith intended for production runs since it logs only flop rates and object 2139210b5426SBarry Smith creation (and should not significantly slow the programs). 2140210b5426SBarry Smith 2141210b5426SBarry Smith Level: advanced 2142210b5426SBarry Smith 2143210b5426SBarry Smith 2144bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogEventActivate(), 2145210b5426SBarry Smith PetscLogEventDeactivate() 2146210b5426SBarry Smith @*/ 2147210b5426SBarry Smith PetscErrorCode PetscLogMPEBegin(void) 2148210b5426SBarry Smith { 2149210b5426SBarry Smith PetscErrorCode ierr; 2150210b5426SBarry Smith 2151210b5426SBarry Smith PetscFunctionBegin; 2152210b5426SBarry Smith /* Do MPE initialization */ 2153210b5426SBarry Smith if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */ 2154210b5426SBarry Smith ierr = PetscInfo(0,"Initializing MPE.\n");CHKERRQ(ierr); 2155210b5426SBarry Smith ierr = MPE_Init_log();CHKERRQ(ierr); 2156210b5426SBarry Smith 2157210b5426SBarry Smith PetscBeganMPE = PETSC_TRUE; 2158210b5426SBarry Smith } else { 2159210b5426SBarry Smith ierr = PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n");CHKERRQ(ierr); 2160210b5426SBarry Smith } 2161495fc317SBarry Smith ierr = PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE);CHKERRQ(ierr); 2162210b5426SBarry Smith PetscFunctionReturn(0); 2163210b5426SBarry Smith } 2164210b5426SBarry Smith 2165210b5426SBarry Smith /*@C 2166495fc317SBarry Smith PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot. 2167210b5426SBarry Smith 2168210b5426SBarry Smith Collective over PETSC_COMM_WORLD 2169210b5426SBarry Smith 2170210b5426SBarry Smith Level: advanced 2171210b5426SBarry Smith 2172210b5426SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogMPEBegin() 2173210b5426SBarry Smith @*/ 2174210b5426SBarry Smith PetscErrorCode PetscLogMPEDump(const char sname[]) 2175210b5426SBarry Smith { 2176210b5426SBarry Smith char name[PETSC_MAX_PATH_LEN]; 2177210b5426SBarry Smith PetscErrorCode ierr; 2178210b5426SBarry Smith 2179210b5426SBarry Smith PetscFunctionBegin; 2180210b5426SBarry Smith if (PetscBeganMPE) { 2181210b5426SBarry Smith ierr = PetscInfo(0,"Finalizing MPE.\n");CHKERRQ(ierr); 2182210b5426SBarry Smith if (sname) { 2183210b5426SBarry Smith ierr = PetscStrcpy(name,sname);CHKERRQ(ierr); 2184210b5426SBarry Smith } else { 2185210b5426SBarry Smith ierr = PetscGetProgramName(name,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 2186210b5426SBarry Smith } 2187210b5426SBarry Smith ierr = MPE_Finish_log(name);CHKERRQ(ierr); 2188210b5426SBarry Smith } else { 2189210b5426SBarry Smith ierr = PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n");CHKERRQ(ierr); 2190210b5426SBarry Smith } 2191210b5426SBarry Smith PetscFunctionReturn(0); 2192210b5426SBarry Smith } 2193210b5426SBarry Smith 2194210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39 2195210b5426SBarry Smith static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = { 2196210b5426SBarry Smith "OliveDrab: ", 2197210b5426SBarry Smith "BlueViolet: ", 2198210b5426SBarry Smith "CadetBlue: ", 2199210b5426SBarry Smith "CornflowerBlue: ", 2200210b5426SBarry Smith "DarkGoldenrod: ", 2201210b5426SBarry Smith "DarkGreen: ", 2202210b5426SBarry Smith "DarkKhaki: ", 2203210b5426SBarry Smith "DarkOliveGreen: ", 2204210b5426SBarry Smith "DarkOrange: ", 2205210b5426SBarry Smith "DarkOrchid: ", 2206210b5426SBarry Smith "DarkSeaGreen: ", 2207210b5426SBarry Smith "DarkSlateGray: ", 2208210b5426SBarry Smith "DarkTurquoise: ", 2209210b5426SBarry Smith "DeepPink: ", 2210210b5426SBarry Smith "DarkKhaki: ", 2211210b5426SBarry Smith "DimGray: ", 2212210b5426SBarry Smith "DodgerBlue: ", 2213210b5426SBarry Smith "GreenYellow: ", 2214210b5426SBarry Smith "HotPink: ", 2215210b5426SBarry Smith "IndianRed: ", 2216210b5426SBarry Smith "LavenderBlush: ", 2217210b5426SBarry Smith "LawnGreen: ", 2218210b5426SBarry Smith "LemonChiffon: ", 2219210b5426SBarry Smith "LightCoral: ", 2220210b5426SBarry Smith "LightCyan: ", 2221210b5426SBarry Smith "LightPink: ", 2222210b5426SBarry Smith "LightSalmon: ", 2223210b5426SBarry Smith "LightSlateGray: ", 2224210b5426SBarry Smith "LightYellow: ", 2225210b5426SBarry Smith "LimeGreen: ", 2226210b5426SBarry Smith "MediumPurple: ", 2227210b5426SBarry Smith "MediumSeaGreen: ", 2228210b5426SBarry Smith "MediumSlateBlue:", 2229210b5426SBarry Smith "MidnightBlue: ", 2230210b5426SBarry Smith "MintCream: ", 2231210b5426SBarry Smith "MistyRose: ", 2232210b5426SBarry Smith "NavajoWhite: ", 2233210b5426SBarry Smith "NavyBlue: ", 2234210b5426SBarry Smith "OliveDrab: " 2235210b5426SBarry Smith }; 2236210b5426SBarry Smith 2237210b5426SBarry Smith /*@C 2238210b5426SBarry Smith PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister() 2239210b5426SBarry Smith 2240210b5426SBarry Smith Not collective. Maybe it should be? 2241210b5426SBarry Smith 2242210b5426SBarry Smith Output Parameter 2243210b5426SBarry Smith . str - character string representing the color 2244210b5426SBarry Smith 2245210b5426SBarry Smith Level: developer 2246210b5426SBarry Smith 2247210b5426SBarry Smith .seealso: PetscLogEventRegister 2248210b5426SBarry Smith @*/ 2249210b5426SBarry Smith PetscErrorCode PetscLogMPEGetRGBColor(const char *str[]) 2250210b5426SBarry Smith { 2251210b5426SBarry Smith static int idx = 0; 2252210b5426SBarry Smith 2253210b5426SBarry Smith PetscFunctionBegin; 2254210b5426SBarry Smith *str = PetscLogMPERGBColors[idx]; 2255210b5426SBarry Smith idx = (idx + 1)% PETSC_RGB_COLORS_MAX; 2256210b5426SBarry Smith PetscFunctionReturn(0); 2257210b5426SBarry Smith } 2258210b5426SBarry Smith 2259210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */ 2260