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 233bb1ff40SBarry Smith PetscErrorCode PetscLogObjectMemory(PetscObject p,PetscLogDouble m) 243bb1ff40SBarry Smith { 25d12f57a0SLisandro Dalcin if (!p) return 0; 2627b6d19dSBarry Smith p->mem += m; 273bb1ff40SBarry Smith return 0; 283bb1ff40SBarry Smith } 293bb1ff40SBarry Smith 305c6c1daeSBarry Smith PetscLogEvent PETSC_LARGEST_EVENT = PETSC_EVENT; 315c6c1daeSBarry Smith 325c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 335c6c1daeSBarry Smith #include <petscmachineinfo.h> 345c6c1daeSBarry Smith #include <petscconfiginfo.h> 355c6c1daeSBarry Smith 365c6c1daeSBarry Smith /* used in the MPI_XXX() count macros in petsclog.h */ 375c6c1daeSBarry Smith 385c6c1daeSBarry Smith /* Action and object logging variables */ 390298fd71SBarry Smith Action *petsc_actions = NULL; 400298fd71SBarry Smith Object *petsc_objects = NULL; 415c6c1daeSBarry Smith PetscBool petsc_logActions = PETSC_FALSE; 425c6c1daeSBarry Smith PetscBool petsc_logObjects = PETSC_FALSE; 435c6c1daeSBarry Smith int petsc_numActions = 0, petsc_maxActions = 100; 445c6c1daeSBarry Smith int petsc_numObjects = 0, petsc_maxObjects = 100; 455c6c1daeSBarry Smith int petsc_numObjectsDestroyed = 0; 465c6c1daeSBarry Smith 475c6c1daeSBarry Smith /* Global counters */ 485c6c1daeSBarry Smith PetscLogDouble petsc_BaseTime = 0.0; 495c6c1daeSBarry Smith PetscLogDouble petsc_TotalFlops = 0.0; /* The number of flops */ 505c6c1daeSBarry Smith PetscLogDouble petsc_tmp_flops = 0.0; /* The incremental number of flops */ 515c6c1daeSBarry Smith PetscLogDouble petsc_send_ct = 0.0; /* The number of sends */ 525c6c1daeSBarry Smith PetscLogDouble petsc_recv_ct = 0.0; /* The number of receives */ 535c6c1daeSBarry Smith PetscLogDouble petsc_send_len = 0.0; /* The total length of all sent messages */ 545c6c1daeSBarry Smith PetscLogDouble petsc_recv_len = 0.0; /* The total length of all received messages */ 555c6c1daeSBarry Smith PetscLogDouble petsc_isend_ct = 0.0; /* The number of immediate sends */ 565c6c1daeSBarry Smith PetscLogDouble petsc_irecv_ct = 0.0; /* The number of immediate receives */ 575c6c1daeSBarry Smith PetscLogDouble petsc_isend_len = 0.0; /* The total length of all immediate send messages */ 585c6c1daeSBarry Smith PetscLogDouble petsc_irecv_len = 0.0; /* The total length of all immediate receive messages */ 595c6c1daeSBarry Smith PetscLogDouble petsc_wait_ct = 0.0; /* The number of waits */ 605c6c1daeSBarry Smith PetscLogDouble petsc_wait_any_ct = 0.0; /* The number of anywaits */ 615c6c1daeSBarry Smith PetscLogDouble petsc_wait_all_ct = 0.0; /* The number of waitalls */ 625c6c1daeSBarry Smith PetscLogDouble petsc_sum_of_waits_ct = 0.0; /* The total number of waits */ 635c6c1daeSBarry Smith PetscLogDouble petsc_allreduce_ct = 0.0; /* The number of reductions */ 645c6c1daeSBarry Smith PetscLogDouble petsc_gather_ct = 0.0; /* The number of gathers and gathervs */ 655c6c1daeSBarry Smith PetscLogDouble petsc_scatter_ct = 0.0; /* The number of scatters and scattervs */ 665c6c1daeSBarry Smith 675c6c1daeSBarry Smith /* Logging functions */ 680298fd71SBarry Smith PetscErrorCode (*PetscLogPHC)(PetscObject) = NULL; 690298fd71SBarry Smith PetscErrorCode (*PetscLogPHD)(PetscObject) = NULL; 700298fd71SBarry Smith PetscErrorCode (*PetscLogPLB)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 710298fd71SBarry Smith PetscErrorCode (*PetscLogPLE)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject) = NULL; 725c6c1daeSBarry Smith 735c6c1daeSBarry Smith /* Tracing event logging variables */ 740298fd71SBarry Smith FILE *petsc_tracefile = NULL; 755c6c1daeSBarry Smith int petsc_tracelevel = 0; 765c6c1daeSBarry Smith const char *petsc_traceblanks = " "; 775c6c1daeSBarry Smith char petsc_tracespace[128] = " "; 785c6c1daeSBarry Smith PetscLogDouble petsc_tracetime = 0.0; 79896238b9SBarry Smith static PetscBool PetscLogInitializeCalled = PETSC_FALSE; 805c6c1daeSBarry Smith 815c6c1daeSBarry Smith /*---------------------------------------------- General Functions --------------------------------------------------*/ 825c6c1daeSBarry Smith #undef __FUNCT__ 835c6c1daeSBarry Smith #define __FUNCT__ "PetscLogDestroy" 845c6c1daeSBarry Smith /*@C 855c6c1daeSBarry Smith PetscLogDestroy - Destroys the object and event logging data and resets the global counters. 865c6c1daeSBarry Smith 875c6c1daeSBarry Smith Not Collective 885c6c1daeSBarry Smith 895c6c1daeSBarry Smith Notes: 905c6c1daeSBarry Smith This routine should not usually be used by programmers. Instead employ 915c6c1daeSBarry Smith PetscLogStagePush() and PetscLogStagePop(). 925c6c1daeSBarry Smith 935c6c1daeSBarry Smith Level: developer 945c6c1daeSBarry Smith 955c6c1daeSBarry Smith .keywords: log, destroy 965c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogStagePush(), PlogStagePop() 975c6c1daeSBarry Smith @*/ 985c6c1daeSBarry Smith PetscErrorCode PetscLogDestroy(void) 995c6c1daeSBarry Smith { 1005c6c1daeSBarry Smith PetscStageLog stageLog; 1015c6c1daeSBarry Smith PetscErrorCode ierr; 1025c6c1daeSBarry Smith 1035c6c1daeSBarry Smith PetscFunctionBegin; 1045c6c1daeSBarry Smith ierr = PetscFree(petsc_actions);CHKERRQ(ierr); 1055c6c1daeSBarry Smith ierr = PetscFree(petsc_objects);CHKERRQ(ierr); 1060298fd71SBarry Smith ierr = PetscLogSet(NULL, NULL);CHKERRQ(ierr); 1075c6c1daeSBarry Smith 1085c6c1daeSBarry Smith /* Resetting phase */ 1095c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 1105c6c1daeSBarry Smith ierr = PetscStageLogDestroy(stageLog);CHKERRQ(ierr); 111a297a907SKarl Rupp 1125c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1135c6c1daeSBarry Smith petsc_numActions = 0; 1145c6c1daeSBarry Smith petsc_numObjects = 0; 1155c6c1daeSBarry Smith petsc_numObjectsDestroyed = 0; 1165c6c1daeSBarry Smith petsc_maxActions = 100; 1175c6c1daeSBarry Smith petsc_maxObjects = 100; 1180298fd71SBarry Smith petsc_actions = NULL; 1190298fd71SBarry Smith petsc_objects = NULL; 1205c6c1daeSBarry Smith petsc_logActions = PETSC_FALSE; 1215c6c1daeSBarry Smith petsc_logObjects = PETSC_FALSE; 1225c6c1daeSBarry Smith petsc_BaseTime = 0.0; 1235c6c1daeSBarry Smith petsc_TotalFlops = 0.0; 1245c6c1daeSBarry Smith petsc_tmp_flops = 0.0; 1255c6c1daeSBarry Smith petsc_send_ct = 0.0; 1265c6c1daeSBarry Smith petsc_recv_ct = 0.0; 1275c6c1daeSBarry Smith petsc_send_len = 0.0; 1285c6c1daeSBarry Smith petsc_recv_len = 0.0; 1295c6c1daeSBarry Smith petsc_isend_ct = 0.0; 1305c6c1daeSBarry Smith petsc_irecv_ct = 0.0; 1315c6c1daeSBarry Smith petsc_isend_len = 0.0; 1325c6c1daeSBarry Smith petsc_irecv_len = 0.0; 1335c6c1daeSBarry Smith petsc_wait_ct = 0.0; 1345c6c1daeSBarry Smith petsc_wait_any_ct = 0.0; 1355c6c1daeSBarry Smith petsc_wait_all_ct = 0.0; 1365c6c1daeSBarry Smith petsc_sum_of_waits_ct = 0.0; 1375c6c1daeSBarry Smith petsc_allreduce_ct = 0.0; 1385c6c1daeSBarry Smith petsc_gather_ct = 0.0; 1395c6c1daeSBarry Smith petsc_scatter_ct = 0.0; 1405c6c1daeSBarry Smith PETSC_LARGEST_EVENT = PETSC_EVENT; 1410298fd71SBarry Smith PetscLogPHC = NULL; 1420298fd71SBarry Smith PetscLogPHD = NULL; 1430298fd71SBarry Smith petsc_tracefile = NULL; 1445c6c1daeSBarry Smith petsc_tracelevel = 0; 1455c6c1daeSBarry Smith petsc_traceblanks = " "; 1465c6c1daeSBarry Smith petsc_tracespace[0] = ' '; petsc_tracespace[1] = 0; 1475c6c1daeSBarry Smith petsc_tracetime = 0.0; 1485c6c1daeSBarry Smith PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 1495c6c1daeSBarry Smith PETSC_OBJECT_CLASSID = 0; 1505c6c1daeSBarry Smith petsc_stageLog = 0; 151896238b9SBarry Smith PetscLogInitializeCalled = PETSC_FALSE; 1525c6c1daeSBarry Smith PetscFunctionReturn(0); 1535c6c1daeSBarry Smith } 1545c6c1daeSBarry Smith 1555c6c1daeSBarry Smith #undef __FUNCT__ 1565c6c1daeSBarry Smith #define __FUNCT__ "PetscLogSet" 1575c6c1daeSBarry Smith /*@C 1585c6c1daeSBarry Smith PetscLogSet - Sets the logging functions called at the beginning and ending of every event. 1595c6c1daeSBarry Smith 1605c6c1daeSBarry Smith Not Collective 1615c6c1daeSBarry Smith 1625c6c1daeSBarry Smith Input Parameters: 1635c6c1daeSBarry Smith + b - The function called at beginning of event 1645c6c1daeSBarry Smith - e - The function called at end of event 1655c6c1daeSBarry Smith 1665c6c1daeSBarry Smith Level: developer 1675c6c1daeSBarry Smith 168*bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogTraceBegin() 1695c6c1daeSBarry Smith @*/ 1705c6c1daeSBarry Smith PetscErrorCode PetscLogSet(PetscErrorCode (*b)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), 1715c6c1daeSBarry Smith PetscErrorCode (*e)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject)) 1725c6c1daeSBarry Smith { 1735c6c1daeSBarry Smith PetscFunctionBegin; 1745c6c1daeSBarry Smith PetscLogPLB = b; 1755c6c1daeSBarry Smith PetscLogPLE = e; 1765c6c1daeSBarry Smith PetscFunctionReturn(0); 1775c6c1daeSBarry Smith } 1785c6c1daeSBarry Smith 1795c6c1daeSBarry Smith #if defined(PETSC_HAVE_PAPI) 1805c6c1daeSBarry Smith #include <papi.h> 1815c6c1daeSBarry Smith int PAPIEventSet = PAPI_NULL; 1825c6c1daeSBarry Smith #endif 1835c6c1daeSBarry Smith 1845c6c1daeSBarry Smith /*------------------------------------------- Initialization Functions ----------------------------------------------*/ 1855c6c1daeSBarry Smith #undef __FUNCT__ 186896238b9SBarry Smith #define __FUNCT__ "PetscLogInitialize" 187896238b9SBarry Smith /* 188896238b9SBarry Smith The data structures for logging are always created even if no logging is turned on. This is so events etc can 189896238b9SBarry Smith be registered in the code before the actually logging is turned on. 190896238b9SBarry Smith */ 191896238b9SBarry Smith PetscErrorCode PetscLogInitialize(void) 1925c6c1daeSBarry Smith { 1935c6c1daeSBarry Smith int stage; 1945c6c1daeSBarry Smith PetscBool opt; 1955c6c1daeSBarry Smith PetscErrorCode ierr; 1965c6c1daeSBarry Smith 1975c6c1daeSBarry Smith PetscFunctionBegin; 198896238b9SBarry Smith if (PetscLogInitializeCalled) PetscFunctionReturn(0); 199896238b9SBarry Smith PetscLogInitializeCalled = PETSC_TRUE; 2005c6c1daeSBarry Smith 2010298fd71SBarry Smith ierr = PetscOptionsHasName(NULL, "-log_exclude_actions", &opt);CHKERRQ(ierr); 202a297a907SKarl Rupp if (opt) petsc_logActions = PETSC_FALSE; 2030298fd71SBarry Smith ierr = PetscOptionsHasName(NULL, "-log_exclude_objects", &opt);CHKERRQ(ierr); 204a297a907SKarl Rupp if (opt) petsc_logObjects = PETSC_FALSE; 2055c6c1daeSBarry Smith if (petsc_logActions) { 206785e854fSJed Brown ierr = PetscMalloc1(petsc_maxActions, &petsc_actions);CHKERRQ(ierr); 2075c6c1daeSBarry Smith } 2085c6c1daeSBarry Smith if (petsc_logObjects) { 209785e854fSJed Brown ierr = PetscMalloc1(petsc_maxObjects, &petsc_objects);CHKERRQ(ierr); 2105c6c1daeSBarry Smith } 2115c6c1daeSBarry Smith PetscLogPHC = PetscLogObjCreateDefault; 2125c6c1daeSBarry Smith PetscLogPHD = PetscLogObjDestroyDefault; 2135c6c1daeSBarry Smith /* Setup default logging structures */ 2145c6c1daeSBarry Smith ierr = PetscStageLogCreate(&petsc_stageLog);CHKERRQ(ierr); 2155c6c1daeSBarry Smith ierr = PetscStageLogRegister(petsc_stageLog, "Main Stage", &stage);CHKERRQ(ierr); 2165c6c1daeSBarry Smith #if defined(PETSC_HAVE_PAPI) 2175c6c1daeSBarry Smith ierr = PAPI_library_init(PAPI_VER_CURRENT); 2185c6c1daeSBarry Smith if (ierr != PAPI_VER_CURRENT) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"Cannot initialize PAPI"); 2195c6c1daeSBarry Smith ierr = PAPI_query_event(PAPI_FP_INS);CHKERRQ(ierr); 2205c6c1daeSBarry Smith ierr = PAPI_create_eventset(&PAPIEventSet);CHKERRQ(ierr); 2215c6c1daeSBarry Smith ierr = PAPI_add_event(PAPIEventSet,PAPI_FP_INS);CHKERRQ(ierr); 2225c6c1daeSBarry Smith ierr = PAPI_start(PAPIEventSet);CHKERRQ(ierr); 2235c6c1daeSBarry Smith #endif 2245c6c1daeSBarry Smith 2255c6c1daeSBarry Smith /* All processors sync here for more consistent logging */ 2265c6c1daeSBarry Smith ierr = MPI_Barrier(PETSC_COMM_WORLD);CHKERRQ(ierr); 2278563dfccSBarry Smith PetscTime(&petsc_BaseTime); 2285c6c1daeSBarry Smith ierr = PetscLogStagePush(stage);CHKERRQ(ierr); 2295c6c1daeSBarry Smith PetscFunctionReturn(0); 2305c6c1daeSBarry Smith } 2315c6c1daeSBarry Smith 2325c6c1daeSBarry Smith #undef __FUNCT__ 233*bb1d7374SBarry Smith #define __FUNCT__ "PetscLogDefaultBegin" 2345c6c1daeSBarry Smith /*@C 235*bb1d7374SBarry Smith PetscLogDefaultBegin - Turns on logging of objects and events. This logs flop 2365c6c1daeSBarry Smith rates and object creation and should not slow programs down too much. 2375c6c1daeSBarry Smith This routine may be called more than once. 2385c6c1daeSBarry Smith 2395c6c1daeSBarry Smith Logically Collective over PETSC_COMM_WORLD 2405c6c1daeSBarry Smith 2415c6c1daeSBarry Smith Options Database Keys: 2425c6c1daeSBarry Smith + -log_summary - Prints summary of flop and timing information to the 2435c6c1daeSBarry Smith screen (for code compiled with PETSC_USE_LOG) 2445c6c1daeSBarry Smith - -log - Prints detailed log information (for code compiled with PETSC_USE_LOG) 2455c6c1daeSBarry Smith 2465c6c1daeSBarry Smith Usage: 2475c6c1daeSBarry Smith .vb 2485c6c1daeSBarry Smith PetscInitialize(...); 249*bb1d7374SBarry Smith PetscLogDefaultBegin(); 2505c6c1daeSBarry Smith ... code ... 2515c6c1daeSBarry Smith PetscLogView(viewer); or PetscLogDump(); 2525c6c1daeSBarry Smith PetscFinalize(); 2535c6c1daeSBarry Smith .ve 2545c6c1daeSBarry Smith 2555c6c1daeSBarry Smith Notes: 2565c6c1daeSBarry Smith PetscLogView(viewer) or PetscLogDump() actually cause the printing of 2575c6c1daeSBarry Smith the logging information. 2585c6c1daeSBarry Smith 2595c6c1daeSBarry Smith Level: advanced 2605c6c1daeSBarry Smith 2615c6c1daeSBarry Smith .keywords: log, begin 2625c6c1daeSBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogTraceBegin() 2635c6c1daeSBarry Smith @*/ 264*bb1d7374SBarry Smith PetscErrorCode PetscLogDefaultBegin(void) 2655c6c1daeSBarry Smith { 2665c6c1daeSBarry Smith PetscErrorCode ierr; 2675c6c1daeSBarry Smith 2685c6c1daeSBarry Smith PetscFunctionBegin; 2695c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginDefault, PetscLogEventEndDefault);CHKERRQ(ierr); 2705c6c1daeSBarry Smith PetscFunctionReturn(0); 2715c6c1daeSBarry Smith } 2725c6c1daeSBarry Smith 2735c6c1daeSBarry Smith #undef __FUNCT__ 2745c6c1daeSBarry Smith #define __FUNCT__ "PetscLogAllBegin" 2755c6c1daeSBarry Smith /*@C 2765c6c1daeSBarry Smith PetscLogAllBegin - Turns on extensive logging of objects and events. Logs 2775c6c1daeSBarry Smith all events. This creates large log files and slows the program down. 2785c6c1daeSBarry Smith 2795c6c1daeSBarry Smith Logically Collective on PETSC_COMM_WORLD 2805c6c1daeSBarry Smith 2815c6c1daeSBarry Smith Options Database Keys: 2825c6c1daeSBarry Smith . -log_all - Prints extensive log information (for code compiled with PETSC_USE_LOG) 2835c6c1daeSBarry Smith 2845c6c1daeSBarry Smith Usage: 2855c6c1daeSBarry Smith .vb 2865c6c1daeSBarry Smith PetscInitialize(...); 2875c6c1daeSBarry Smith PetscLogAllBegin(); 2885c6c1daeSBarry Smith ... code ... 2895c6c1daeSBarry Smith PetscLogDump(filename); 2905c6c1daeSBarry Smith PetscFinalize(); 2915c6c1daeSBarry Smith .ve 2925c6c1daeSBarry Smith 2935c6c1daeSBarry Smith Notes: 294*bb1d7374SBarry Smith A related routine is PetscLogDefaultBegin() (with the options key -log), which is 2955c6c1daeSBarry Smith intended for production runs since it logs only flop rates and object 2965c6c1daeSBarry Smith creation (and shouldn't significantly slow the programs). 2975c6c1daeSBarry Smith 2985c6c1daeSBarry Smith Level: advanced 2995c6c1daeSBarry Smith 3005c6c1daeSBarry Smith .keywords: log, all, begin 301*bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogTraceBegin() 3025c6c1daeSBarry Smith @*/ 3035c6c1daeSBarry Smith PetscErrorCode PetscLogAllBegin(void) 3045c6c1daeSBarry Smith { 3055c6c1daeSBarry Smith PetscErrorCode ierr; 3065c6c1daeSBarry Smith 3075c6c1daeSBarry Smith PetscFunctionBegin; 3085c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginComplete, PetscLogEventEndComplete);CHKERRQ(ierr); 3095c6c1daeSBarry Smith PetscFunctionReturn(0); 3105c6c1daeSBarry Smith } 3115c6c1daeSBarry Smith 3125c6c1daeSBarry Smith #undef __FUNCT__ 3135c6c1daeSBarry Smith #define __FUNCT__ "PetscLogTraceBegin" 3145c6c1daeSBarry Smith /*@ 3155c6c1daeSBarry Smith PetscLogTraceBegin - Activates trace logging. Every time a PETSc event 3165c6c1daeSBarry Smith begins or ends, the event name is printed. 3175c6c1daeSBarry Smith 3185c6c1daeSBarry Smith Logically Collective on PETSC_COMM_WORLD 3195c6c1daeSBarry Smith 3205c6c1daeSBarry Smith Input Parameter: 3215c6c1daeSBarry Smith . file - The file to print trace in (e.g. stdout) 3225c6c1daeSBarry Smith 3235c6c1daeSBarry Smith Options Database Key: 3245c6c1daeSBarry Smith . -log_trace [filename] - Activates PetscLogTraceBegin() 3255c6c1daeSBarry Smith 3265c6c1daeSBarry Smith Notes: 3275c6c1daeSBarry Smith PetscLogTraceBegin() prints the processor number, the execution time (sec), 3285c6c1daeSBarry Smith then "Event begin:" or "Event end:" followed by the event name. 3295c6c1daeSBarry Smith 3305c6c1daeSBarry Smith PetscLogTraceBegin() allows tracing of all PETSc calls, which is useful 3315c6c1daeSBarry Smith to determine where a program is hanging without running in the 3325c6c1daeSBarry Smith debugger. Can be used in conjunction with the -info option. 3335c6c1daeSBarry Smith 3345c6c1daeSBarry Smith Level: intermediate 3355c6c1daeSBarry Smith 336*bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogView(), PetscLogDefaultBegin() 3375c6c1daeSBarry Smith @*/ 3385c6c1daeSBarry Smith PetscErrorCode PetscLogTraceBegin(FILE *file) 3395c6c1daeSBarry Smith { 3405c6c1daeSBarry Smith PetscErrorCode ierr; 3415c6c1daeSBarry Smith 3425c6c1daeSBarry Smith PetscFunctionBegin; 3435c6c1daeSBarry Smith petsc_tracefile = file; 344a297a907SKarl Rupp 3455c6c1daeSBarry Smith ierr = PetscLogSet(PetscLogEventBeginTrace, PetscLogEventEndTrace);CHKERRQ(ierr); 3465c6c1daeSBarry Smith PetscFunctionReturn(0); 3475c6c1daeSBarry Smith } 3485c6c1daeSBarry Smith 3495c6c1daeSBarry Smith #undef __FUNCT__ 3505c6c1daeSBarry Smith #define __FUNCT__ "PetscLogActions" 3515c6c1daeSBarry Smith /*@ 3525c6c1daeSBarry Smith PetscLogActions - Determines whether actions are logged for the graphical viewer. 3535c6c1daeSBarry Smith 3545c6c1daeSBarry Smith Not Collective 3555c6c1daeSBarry Smith 3565c6c1daeSBarry Smith Input Parameter: 3575c6c1daeSBarry Smith . flag - PETSC_TRUE if actions are to be logged 3585c6c1daeSBarry Smith 3595c6c1daeSBarry Smith Level: intermediate 3605c6c1daeSBarry Smith 3615c6c1daeSBarry Smith Note: Logging of actions continues to consume more memory as the program 3625c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3635c6c1daeSBarry Smith 3645c6c1daeSBarry Smith Options Database Keys: 3655c6c1daeSBarry Smith . -log_exclude_actions - Turns off actions logging 3665c6c1daeSBarry Smith 3675c6c1daeSBarry Smith .keywords: log, stage, register 3685c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 3695c6c1daeSBarry Smith @*/ 3705c6c1daeSBarry Smith PetscErrorCode PetscLogActions(PetscBool flag) 3715c6c1daeSBarry Smith { 3725c6c1daeSBarry Smith PetscFunctionBegin; 3735c6c1daeSBarry Smith petsc_logActions = flag; 3745c6c1daeSBarry Smith PetscFunctionReturn(0); 3755c6c1daeSBarry Smith } 3765c6c1daeSBarry Smith 3775c6c1daeSBarry Smith #undef __FUNCT__ 3785c6c1daeSBarry Smith #define __FUNCT__ "PetscLogObjects" 3795c6c1daeSBarry Smith /*@ 3805c6c1daeSBarry Smith PetscLogObjects - Determines whether objects are logged for the graphical viewer. 3815c6c1daeSBarry Smith 3825c6c1daeSBarry Smith Not Collective 3835c6c1daeSBarry Smith 3845c6c1daeSBarry Smith Input Parameter: 3855c6c1daeSBarry Smith . flag - PETSC_TRUE if objects are to be logged 3865c6c1daeSBarry Smith 3875c6c1daeSBarry Smith Level: intermediate 3885c6c1daeSBarry Smith 3895c6c1daeSBarry Smith Note: Logging of objects continues to consume more memory as the program 3905c6c1daeSBarry Smith runs. Long running programs should consider turning this feature off. 3915c6c1daeSBarry Smith 3925c6c1daeSBarry Smith Options Database Keys: 3935c6c1daeSBarry Smith . -log_exclude_objects - Turns off objects logging 3945c6c1daeSBarry Smith 3955c6c1daeSBarry Smith .keywords: log, stage, register 3965c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 3975c6c1daeSBarry Smith @*/ 3985c6c1daeSBarry Smith PetscErrorCode PetscLogObjects(PetscBool flag) 3995c6c1daeSBarry Smith { 4005c6c1daeSBarry Smith PetscFunctionBegin; 4015c6c1daeSBarry Smith petsc_logObjects = flag; 4025c6c1daeSBarry Smith PetscFunctionReturn(0); 4035c6c1daeSBarry Smith } 4045c6c1daeSBarry Smith 4055c6c1daeSBarry Smith /*------------------------------------------------ Stage Functions --------------------------------------------------*/ 4065c6c1daeSBarry Smith #undef __FUNCT__ 4075c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStageRegister" 4085c6c1daeSBarry Smith /*@C 4095c6c1daeSBarry Smith PetscLogStageRegister - Attaches a charactor string name to a logging stage. 4105c6c1daeSBarry Smith 4115c6c1daeSBarry Smith Not Collective 4125c6c1daeSBarry Smith 4135c6c1daeSBarry Smith Input Parameter: 4145c6c1daeSBarry Smith . sname - The name to associate with that stage 4155c6c1daeSBarry Smith 4165c6c1daeSBarry Smith Output Parameter: 4175c6c1daeSBarry Smith . stage - The stage number 4185c6c1daeSBarry Smith 4195c6c1daeSBarry Smith Level: intermediate 4205c6c1daeSBarry Smith 4215c6c1daeSBarry Smith .keywords: log, stage, register 4225c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop() 4235c6c1daeSBarry Smith @*/ 4245c6c1daeSBarry Smith PetscErrorCode PetscLogStageRegister(const char sname[],PetscLogStage *stage) 4255c6c1daeSBarry Smith { 4265c6c1daeSBarry Smith PetscStageLog stageLog; 4275c6c1daeSBarry Smith PetscLogEvent event; 4285c6c1daeSBarry Smith PetscErrorCode ierr; 4295c6c1daeSBarry Smith 4305c6c1daeSBarry Smith PetscFunctionBegin; 4315c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 4325c6c1daeSBarry Smith ierr = PetscStageLogRegister(stageLog, sname, stage);CHKERRQ(ierr); 4335c6c1daeSBarry Smith /* Copy events already changed in the main stage, this sucks */ 4345c6c1daeSBarry Smith ierr = EventPerfLogEnsureSize(stageLog->stageInfo[*stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr); 4355c6c1daeSBarry Smith for (event = 0; event < stageLog->eventLog->numEvents; event++) { 4365c6c1daeSBarry Smith ierr = EventPerfInfoCopy(&stageLog->stageInfo[0].eventLog->eventInfo[event],&stageLog->stageInfo[*stage].eventLog->eventInfo[event]);CHKERRQ(ierr); 4375c6c1daeSBarry Smith } 4385c6c1daeSBarry Smith ierr = ClassPerfLogEnsureSize(stageLog->stageInfo[*stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 4395c6c1daeSBarry Smith PetscFunctionReturn(0); 4405c6c1daeSBarry Smith } 4415c6c1daeSBarry Smith 4425c6c1daeSBarry Smith #undef __FUNCT__ 4435c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStagePush" 4445c6c1daeSBarry Smith /*@C 4455c6c1daeSBarry Smith PetscLogStagePush - This function pushes a stage on the stack. 4465c6c1daeSBarry Smith 4475c6c1daeSBarry Smith Not Collective 4485c6c1daeSBarry Smith 4495c6c1daeSBarry Smith Input Parameter: 4505c6c1daeSBarry Smith . stage - The stage on which to log 4515c6c1daeSBarry Smith 4525c6c1daeSBarry Smith Usage: 4535c6c1daeSBarry Smith If the option -log_sumary is used to run the program containing the 4545c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4555c6c1daeSBarry Smith PetscFinalize(). 4565c6c1daeSBarry Smith .vb 4575c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4585c6c1daeSBarry Smith [stage 0 of code] 4595c6c1daeSBarry Smith PetscLogStagePush(1); 4605c6c1daeSBarry Smith [stage 1 of code] 4615c6c1daeSBarry Smith PetscLogStagePop(); 4625c6c1daeSBarry Smith PetscBarrier(...); 4635c6c1daeSBarry Smith [more stage 0 of code] 4645c6c1daeSBarry Smith PetscFinalize(); 4655c6c1daeSBarry Smith .ve 4665c6c1daeSBarry Smith 4675c6c1daeSBarry Smith Notes: 4685c6c1daeSBarry Smith Use PetscLogStageRegister() to register a stage. 4695c6c1daeSBarry Smith 4705c6c1daeSBarry Smith Level: intermediate 4715c6c1daeSBarry Smith 4725c6c1daeSBarry Smith .keywords: log, push, stage 4735c6c1daeSBarry Smith .seealso: PetscLogStagePop(), PetscLogStageRegister(), PetscBarrier() 4745c6c1daeSBarry Smith @*/ 4755c6c1daeSBarry Smith PetscErrorCode PetscLogStagePush(PetscLogStage stage) 4765c6c1daeSBarry Smith { 4775c6c1daeSBarry Smith PetscStageLog stageLog; 4785c6c1daeSBarry Smith PetscErrorCode ierr; 4795c6c1daeSBarry Smith 4805c6c1daeSBarry Smith PetscFunctionBegin; 4815c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 4825c6c1daeSBarry Smith ierr = PetscStageLogPush(stageLog, stage);CHKERRQ(ierr); 4835c6c1daeSBarry Smith PetscFunctionReturn(0); 4845c6c1daeSBarry Smith } 4855c6c1daeSBarry Smith 4865c6c1daeSBarry Smith #undef __FUNCT__ 4875c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStagePop" 4885c6c1daeSBarry Smith /*@C 4895c6c1daeSBarry Smith PetscLogStagePop - This function pops a stage from the stack. 4905c6c1daeSBarry Smith 4915c6c1daeSBarry Smith Not Collective 4925c6c1daeSBarry Smith 4935c6c1daeSBarry Smith Usage: 4945c6c1daeSBarry Smith If the option -log_sumary is used to run the program containing the 4955c6c1daeSBarry Smith following code, then 2 sets of summary data will be printed during 4965c6c1daeSBarry Smith PetscFinalize(). 4975c6c1daeSBarry Smith .vb 4985c6c1daeSBarry Smith PetscInitialize(int *argc,char ***args,0,0); 4995c6c1daeSBarry Smith [stage 0 of code] 5005c6c1daeSBarry Smith PetscLogStagePush(1); 5015c6c1daeSBarry Smith [stage 1 of code] 5025c6c1daeSBarry Smith PetscLogStagePop(); 5035c6c1daeSBarry Smith PetscBarrier(...); 5045c6c1daeSBarry Smith [more stage 0 of code] 5055c6c1daeSBarry Smith PetscFinalize(); 5065c6c1daeSBarry Smith .ve 5075c6c1daeSBarry Smith 5085c6c1daeSBarry Smith Notes: 5095c6c1daeSBarry Smith Use PetscLogStageRegister() to register a stage. 5105c6c1daeSBarry Smith 5115c6c1daeSBarry Smith Level: intermediate 5125c6c1daeSBarry Smith 5135c6c1daeSBarry Smith .keywords: log, pop, stage 5145c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStageRegister(), PetscBarrier() 5155c6c1daeSBarry Smith @*/ 5165c6c1daeSBarry Smith PetscErrorCode PetscLogStagePop(void) 5175c6c1daeSBarry Smith { 5185c6c1daeSBarry Smith PetscStageLog stageLog; 5195c6c1daeSBarry Smith PetscErrorCode ierr; 5205c6c1daeSBarry Smith 5215c6c1daeSBarry Smith PetscFunctionBegin; 5225c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5235c6c1daeSBarry Smith ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 5245c6c1daeSBarry Smith PetscFunctionReturn(0); 5255c6c1daeSBarry Smith } 5265c6c1daeSBarry Smith 5275c6c1daeSBarry Smith #undef __FUNCT__ 5285c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStageSetActive" 5295c6c1daeSBarry Smith /*@ 5305c6c1daeSBarry Smith PetscLogStageSetActive - Determines stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 5315c6c1daeSBarry Smith 5325c6c1daeSBarry Smith Not Collective 5335c6c1daeSBarry Smith 5345c6c1daeSBarry Smith Input Parameters: 5355c6c1daeSBarry Smith + stage - The stage 5365c6c1daeSBarry Smith - isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 5375c6c1daeSBarry Smith 5385c6c1daeSBarry Smith Level: intermediate 5395c6c1daeSBarry Smith 5405c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 5415c6c1daeSBarry Smith @*/ 5425c6c1daeSBarry Smith PetscErrorCode PetscLogStageSetActive(PetscLogStage stage, PetscBool isActive) 5435c6c1daeSBarry Smith { 5445c6c1daeSBarry Smith PetscStageLog stageLog; 5455c6c1daeSBarry Smith PetscErrorCode ierr; 5465c6c1daeSBarry Smith 5475c6c1daeSBarry Smith PetscFunctionBegin; 5485c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5495c6c1daeSBarry Smith ierr = PetscStageLogSetActive(stageLog, stage, isActive);CHKERRQ(ierr); 5505c6c1daeSBarry Smith PetscFunctionReturn(0); 5515c6c1daeSBarry Smith } 5525c6c1daeSBarry Smith 5535c6c1daeSBarry Smith #undef __FUNCT__ 5545c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStageGetActive" 5555c6c1daeSBarry Smith /*@ 5565c6c1daeSBarry Smith PetscLogStageGetActive - Returns stage activity for PetscLogEventBegin() and PetscLogEventEnd(). 5575c6c1daeSBarry Smith 5585c6c1daeSBarry Smith Not Collective 5595c6c1daeSBarry Smith 5605c6c1daeSBarry Smith Input Parameter: 5615c6c1daeSBarry Smith . stage - The stage 5625c6c1daeSBarry Smith 5635c6c1daeSBarry Smith Output Parameter: 5645c6c1daeSBarry Smith . isActive - The activity flag, PETSC_TRUE for logging, else PETSC_FALSE (defaults to PETSC_TRUE) 5655c6c1daeSBarry Smith 5665c6c1daeSBarry Smith Level: intermediate 5675c6c1daeSBarry Smith 5685c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 5695c6c1daeSBarry Smith @*/ 5705c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetActive(PetscLogStage stage, PetscBool *isActive) 5715c6c1daeSBarry Smith { 5725c6c1daeSBarry Smith PetscStageLog stageLog; 5735c6c1daeSBarry Smith PetscErrorCode ierr; 5745c6c1daeSBarry Smith 5755c6c1daeSBarry Smith PetscFunctionBegin; 5765c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 5775c6c1daeSBarry Smith ierr = PetscStageLogGetActive(stageLog, stage, isActive);CHKERRQ(ierr); 5785c6c1daeSBarry Smith PetscFunctionReturn(0); 5795c6c1daeSBarry Smith } 5805c6c1daeSBarry Smith 5815c6c1daeSBarry Smith #undef __FUNCT__ 5825c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStageSetVisible" 5835c6c1daeSBarry Smith /*@ 5845c6c1daeSBarry Smith PetscLogStageSetVisible - Determines stage visibility in PetscLogView() 5855c6c1daeSBarry Smith 5865c6c1daeSBarry Smith Not Collective 5875c6c1daeSBarry Smith 5885c6c1daeSBarry Smith Input Parameters: 5895c6c1daeSBarry Smith + stage - The stage 5905c6c1daeSBarry Smith - isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 5915c6c1daeSBarry Smith 5925c6c1daeSBarry Smith Level: intermediate 5935c6c1daeSBarry Smith 5945c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView() 5955c6c1daeSBarry Smith @*/ 5965c6c1daeSBarry Smith PetscErrorCode PetscLogStageSetVisible(PetscLogStage stage, PetscBool isVisible) 5975c6c1daeSBarry Smith { 5985c6c1daeSBarry Smith PetscStageLog stageLog; 5995c6c1daeSBarry Smith PetscErrorCode ierr; 6005c6c1daeSBarry Smith 6015c6c1daeSBarry Smith PetscFunctionBegin; 6025c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 6035c6c1daeSBarry Smith ierr = PetscStageLogSetVisible(stageLog, stage, isVisible);CHKERRQ(ierr); 6045c6c1daeSBarry Smith PetscFunctionReturn(0); 6055c6c1daeSBarry Smith } 6065c6c1daeSBarry Smith 6075c6c1daeSBarry Smith #undef __FUNCT__ 6085c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStageGetVisible" 6095c6c1daeSBarry Smith /*@ 6105c6c1daeSBarry Smith PetscLogStageGetVisible - Returns stage visibility in PetscLogView() 6115c6c1daeSBarry Smith 6125c6c1daeSBarry Smith Not Collective 6135c6c1daeSBarry Smith 6145c6c1daeSBarry Smith Input Parameter: 6155c6c1daeSBarry Smith . stage - The stage 6165c6c1daeSBarry Smith 6175c6c1daeSBarry Smith Output Parameter: 6185c6c1daeSBarry Smith . isVisible - The visibility flag, PETSC_TRUE to print, else PETSC_FALSE (defaults to PETSC_TRUE) 6195c6c1daeSBarry Smith 6205c6c1daeSBarry Smith Level: intermediate 6215c6c1daeSBarry Smith 6225c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscLogView() 6235c6c1daeSBarry Smith @*/ 6245c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetVisible(PetscLogStage stage, PetscBool *isVisible) 6255c6c1daeSBarry Smith { 6265c6c1daeSBarry Smith PetscStageLog stageLog; 6275c6c1daeSBarry Smith PetscErrorCode ierr; 6285c6c1daeSBarry Smith 6295c6c1daeSBarry Smith PetscFunctionBegin; 6305c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 6315c6c1daeSBarry Smith ierr = PetscStageLogGetVisible(stageLog, stage, isVisible);CHKERRQ(ierr); 6325c6c1daeSBarry Smith PetscFunctionReturn(0); 6335c6c1daeSBarry Smith } 6345c6c1daeSBarry Smith 6355c6c1daeSBarry Smith #undef __FUNCT__ 6365c6c1daeSBarry Smith #define __FUNCT__ "PetscLogStageGetId" 6375c6c1daeSBarry Smith /*@C 6385c6c1daeSBarry Smith PetscLogStageGetId - Returns the stage id when given the stage name. 6395c6c1daeSBarry Smith 6405c6c1daeSBarry Smith Not Collective 6415c6c1daeSBarry Smith 6425c6c1daeSBarry Smith Input Parameter: 6435c6c1daeSBarry Smith . name - The stage name 6445c6c1daeSBarry Smith 6455c6c1daeSBarry Smith Output Parameter: 6465a4a3fabSBarry Smith . stage - The stage, , or -1 if no stage with that name exists 6475c6c1daeSBarry Smith 6485c6c1daeSBarry Smith Level: intermediate 6495c6c1daeSBarry Smith 6505c6c1daeSBarry Smith .seealso: PetscLogStagePush(), PetscLogStagePop(), PetscPreLoadBegin(), PetscPreLoadEnd(), PetscPreLoadStage() 6515c6c1daeSBarry Smith @*/ 6525c6c1daeSBarry Smith PetscErrorCode PetscLogStageGetId(const char name[], PetscLogStage *stage) 6535c6c1daeSBarry Smith { 6545c6c1daeSBarry Smith PetscStageLog stageLog; 6555c6c1daeSBarry Smith PetscErrorCode ierr; 6565c6c1daeSBarry Smith 6575c6c1daeSBarry Smith PetscFunctionBegin; 6585c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 6595c6c1daeSBarry Smith ierr = PetscStageLogGetStage(stageLog, name, stage);CHKERRQ(ierr); 6605c6c1daeSBarry Smith PetscFunctionReturn(0); 6615c6c1daeSBarry Smith } 6625c6c1daeSBarry Smith 6635c6c1daeSBarry Smith /*------------------------------------------------ Event Functions --------------------------------------------------*/ 6645c6c1daeSBarry Smith #undef __FUNCT__ 6655c6c1daeSBarry Smith #define __FUNCT__ "PetscLogEventRegister" 6665c6c1daeSBarry Smith /*@C 6675c6c1daeSBarry Smith PetscLogEventRegister - Registers an event name for logging operations in an application code. 6685c6c1daeSBarry Smith 6695c6c1daeSBarry Smith Not Collective 6705c6c1daeSBarry Smith 6715c6c1daeSBarry Smith Input Parameter: 6725c6c1daeSBarry Smith + name - The name associated with the event 6735c6c1daeSBarry Smith - classid - The classid associated to the class for this event, obtain either with 6745c6c1daeSBarry Smith PetscClassIdRegister() or use a predefined one such as KSP_CLASSID, SNES_CLASSID, the predefined ones 6755c6c1daeSBarry Smith are only available in C code 6765c6c1daeSBarry Smith 6775c6c1daeSBarry Smith Output Parameter: 6785c6c1daeSBarry Smith . event - The event id for use with PetscLogEventBegin() and PetscLogEventEnd(). 6795c6c1daeSBarry Smith 6805c6c1daeSBarry Smith Example of Usage: 6815c6c1daeSBarry Smith .vb 6825c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 6835c6c1daeSBarry Smith PetscClassId classid; 6845c6c1daeSBarry Smith PetscLogDouble user_event_flops; 6855c6c1daeSBarry Smith PetscClassIdRegister("class name",&classid); 6865c6c1daeSBarry Smith PetscLogEventRegister("User event name",classid,&USER_EVENT); 6875c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 6885c6c1daeSBarry Smith [code segment to monitor] 6895c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 6905c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 6915c6c1daeSBarry Smith .ve 6925c6c1daeSBarry Smith 6935c6c1daeSBarry Smith Notes: 6945c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 6955c6c1daeSBarry Smith compiled with -DPETSC_USE_LOG (which is the default) and -log, 6965c6c1daeSBarry Smith -log_summary, or -log_all are specified. PetscLogEventRegister() is 6975c6c1daeSBarry Smith intended for logging user events to supplement this PETSc 6985c6c1daeSBarry Smith information. 6995c6c1daeSBarry Smith 700495fc317SBarry Smith PETSc can gather data for use with the utilities Jumpshot 7015c6c1daeSBarry Smith (part of the MPICH distribution). If PETSc has been compiled 7025c6c1daeSBarry Smith with flag -DPETSC_HAVE_MPE (MPE is an additional utility within 7035c6c1daeSBarry Smith MPICH), the user can employ another command line option, -log_mpe, 7045c6c1daeSBarry Smith to create a logfile, "mpe.log", which can be visualized 705495fc317SBarry Smith Jumpshot. 7065c6c1daeSBarry Smith 7075c6c1daeSBarry Smith The classid is associated with each event so that classes of events 7085c6c1daeSBarry Smith can be disabled simultaneously, such as all matrix events. The user 7095c6c1daeSBarry Smith can either use an existing classid, such as MAT_CLASSID, or create 7105c6c1daeSBarry Smith their own as shown in the example. 7115c6c1daeSBarry Smith 712c5deb1d5SJed Brown If an existing event with the same name exists, its event handle is 713c5deb1d5SJed Brown returned instead of creating a new event. 714c5deb1d5SJed Brown 7155c6c1daeSBarry Smith Level: intermediate 7165c6c1daeSBarry Smith 7175c6c1daeSBarry Smith .keywords: log, event, register 7185c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogFlops(), 7195c6c1daeSBarry Smith PetscLogEventMPEActivate(), PetscLogEventMPEDeactivate(), 7205c6c1daeSBarry Smith PetscLogEventActivate(), PetscLogEventDeactivate(), PetscClassIdRegister() 7215c6c1daeSBarry Smith @*/ 7225c6c1daeSBarry Smith PetscErrorCode PetscLogEventRegister(const char name[],PetscClassId classid,PetscLogEvent *event) 7235c6c1daeSBarry Smith { 7245c6c1daeSBarry Smith PetscStageLog stageLog; 7255c6c1daeSBarry Smith int stage; 7265c6c1daeSBarry Smith PetscErrorCode ierr; 7275c6c1daeSBarry Smith 7285c6c1daeSBarry Smith PetscFunctionBegin; 7295c6c1daeSBarry Smith *event = PETSC_DECIDE; 7305c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 731c5deb1d5SJed Brown ierr = EventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr); 732c5deb1d5SJed Brown if (*event > 0) PetscFunctionReturn(0); 7335c6c1daeSBarry Smith ierr = EventRegLogRegister(stageLog->eventLog, name, classid, event);CHKERRQ(ierr); 7345c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 7355c6c1daeSBarry Smith ierr = EventPerfLogEnsureSize(stageLog->stageInfo[stage].eventLog, stageLog->eventLog->numEvents);CHKERRQ(ierr); 7365c6c1daeSBarry Smith ierr = ClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 7375c6c1daeSBarry Smith } 7385c6c1daeSBarry Smith PetscFunctionReturn(0); 7395c6c1daeSBarry Smith } 7405c6c1daeSBarry Smith 7415c6c1daeSBarry Smith #undef __FUNCT__ 7425c6c1daeSBarry Smith #define __FUNCT__ "PetscLogEventActivate" 7435c6c1daeSBarry Smith /*@ 7445c6c1daeSBarry Smith PetscLogEventActivate - Indicates that a particular event should be logged. 7455c6c1daeSBarry Smith 7465c6c1daeSBarry Smith Not Collective 7475c6c1daeSBarry Smith 7485c6c1daeSBarry Smith Input Parameter: 7495c6c1daeSBarry Smith . event - The event id 7505c6c1daeSBarry Smith 7515c6c1daeSBarry Smith Usage: 7525c6c1daeSBarry Smith .vb 7535c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 7545c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 7555c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 7565c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 7575c6c1daeSBarry Smith .ve 7585c6c1daeSBarry Smith 7595c6c1daeSBarry Smith Note: 7605c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in include/petsclog.h) 7615c6c1daeSBarry Smith or an event number obtained with PetscLogEventRegister(). 7625c6c1daeSBarry Smith 7635c6c1daeSBarry Smith Level: advanced 7645c6c1daeSBarry Smith 7655c6c1daeSBarry Smith .keywords: log, event, activate 7665c6c1daeSBarry Smith .seealso: PetscLogEventMPEDeactivate(),PetscLogEventMPEActivate(),PlogEventDeactivate() 7675c6c1daeSBarry Smith @*/ 7685c6c1daeSBarry Smith PetscErrorCode PetscLogEventActivate(PetscLogEvent event) 7695c6c1daeSBarry Smith { 7705c6c1daeSBarry Smith PetscStageLog stageLog; 7715c6c1daeSBarry Smith int stage; 7725c6c1daeSBarry Smith PetscErrorCode ierr; 7735c6c1daeSBarry Smith 7745c6c1daeSBarry Smith PetscFunctionBegin; 7755c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 7765c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 7775c6c1daeSBarry Smith ierr = EventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 7785c6c1daeSBarry Smith PetscFunctionReturn(0); 7795c6c1daeSBarry Smith } 7805c6c1daeSBarry Smith 7815c6c1daeSBarry Smith #undef __FUNCT__ 7825c6c1daeSBarry Smith #define __FUNCT__ "PetscLogEventDeactivate" 7835c6c1daeSBarry Smith /*@ 7845c6c1daeSBarry Smith PetscLogEventDeactivate - Indicates that a particular event should not be logged. 7855c6c1daeSBarry Smith 7865c6c1daeSBarry Smith Not Collective 7875c6c1daeSBarry Smith 7885c6c1daeSBarry Smith Input Parameter: 7895c6c1daeSBarry Smith . event - The event id 7905c6c1daeSBarry Smith 7915c6c1daeSBarry Smith Usage: 7925c6c1daeSBarry Smith .vb 7935c6c1daeSBarry Smith PetscLogEventDeactivate(VEC_SetValues); 7945c6c1daeSBarry Smith [code where you do not want to log VecSetValues()] 7955c6c1daeSBarry Smith PetscLogEventActivate(VEC_SetValues); 7965c6c1daeSBarry Smith [code where you do want to log VecSetValues()] 7975c6c1daeSBarry Smith .ve 7985c6c1daeSBarry Smith 7995c6c1daeSBarry Smith Note: 8005c6c1daeSBarry Smith The event may be either a pre-defined PETSc event (found in 8015c6c1daeSBarry Smith include/petsclog.h) or an event number obtained with PetscLogEventRegister()). 8025c6c1daeSBarry Smith 8035c6c1daeSBarry Smith Level: advanced 8045c6c1daeSBarry Smith 8055c6c1daeSBarry Smith .keywords: log, event, deactivate 8065c6c1daeSBarry Smith .seealso: PetscLogEventMPEDeactivate(),PetscLogEventMPEActivate(),PlogEventActivate() 8075c6c1daeSBarry Smith @*/ 8085c6c1daeSBarry Smith PetscErrorCode PetscLogEventDeactivate(PetscLogEvent event) 8095c6c1daeSBarry Smith { 8105c6c1daeSBarry Smith PetscStageLog stageLog; 8115c6c1daeSBarry Smith int stage; 8125c6c1daeSBarry Smith PetscErrorCode ierr; 8135c6c1daeSBarry Smith 8145c6c1daeSBarry Smith PetscFunctionBegin; 8155c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8165c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 8175c6c1daeSBarry Smith ierr = EventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8185c6c1daeSBarry Smith PetscFunctionReturn(0); 8195c6c1daeSBarry Smith } 8205c6c1daeSBarry Smith 8215c6c1daeSBarry Smith #undef __FUNCT__ 8225c6c1daeSBarry Smith #define __FUNCT__ "PetscLogEventSetActiveAll" 8235c6c1daeSBarry Smith /*@ 8245c6c1daeSBarry Smith PetscLogEventSetActiveAll - Sets the event activity in every stage. 8255c6c1daeSBarry Smith 8265c6c1daeSBarry Smith Not Collective 8275c6c1daeSBarry Smith 8285c6c1daeSBarry Smith Input Parameters: 8295c6c1daeSBarry Smith + event - The event id 8305c6c1daeSBarry Smith - isActive - The activity flag determining whether the event is logged 8315c6c1daeSBarry Smith 8325c6c1daeSBarry Smith Level: advanced 8335c6c1daeSBarry Smith 8345c6c1daeSBarry Smith .keywords: log, event, activate 8355c6c1daeSBarry Smith .seealso: PetscLogEventMPEDeactivate(),PetscLogEventMPEActivate(),PlogEventActivate(),PlogEventDeactivate() 8365c6c1daeSBarry Smith @*/ 8375c6c1daeSBarry Smith PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent event, PetscBool isActive) 8385c6c1daeSBarry Smith { 8395c6c1daeSBarry Smith PetscStageLog stageLog; 8405c6c1daeSBarry Smith int stage; 8415c6c1daeSBarry Smith PetscErrorCode ierr; 8425c6c1daeSBarry Smith 8435c6c1daeSBarry Smith PetscFunctionBegin; 8445c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8455c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 8465c6c1daeSBarry Smith if (isActive) { 8475c6c1daeSBarry Smith ierr = EventPerfLogActivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8485c6c1daeSBarry Smith } else { 8495c6c1daeSBarry Smith ierr = EventPerfLogDeactivate(stageLog->stageInfo[stage].eventLog, event);CHKERRQ(ierr); 8505c6c1daeSBarry Smith } 8515c6c1daeSBarry Smith } 8525c6c1daeSBarry Smith PetscFunctionReturn(0); 8535c6c1daeSBarry Smith } 8545c6c1daeSBarry Smith 8555c6c1daeSBarry Smith #undef __FUNCT__ 8565c6c1daeSBarry Smith #define __FUNCT__ "PetscLogEventActivateClass" 8575c6c1daeSBarry Smith /*@ 8585c6c1daeSBarry Smith PetscLogEventActivateClass - Activates event logging for a PETSc object class. 8595c6c1daeSBarry Smith 8605c6c1daeSBarry Smith Not Collective 8615c6c1daeSBarry Smith 8625c6c1daeSBarry Smith Input Parameter: 8635c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 8645c6c1daeSBarry Smith 8655c6c1daeSBarry Smith Level: developer 8665c6c1daeSBarry Smith 8675c6c1daeSBarry Smith .keywords: log, event, activate, class 8685c6c1daeSBarry Smith .seealso: PetscInfoActivate(),PetscInfo(),PetscInfoAllow(),PetscLogEventDeactivateClass(), PetscLogEventActivate(),PetscLogEventDeactivate() 8695c6c1daeSBarry Smith @*/ 8705c6c1daeSBarry Smith PetscErrorCode PetscLogEventActivateClass(PetscClassId classid) 8715c6c1daeSBarry Smith { 8725c6c1daeSBarry Smith PetscStageLog stageLog; 8735c6c1daeSBarry Smith int stage; 8745c6c1daeSBarry Smith PetscErrorCode ierr; 8755c6c1daeSBarry Smith 8765c6c1daeSBarry Smith PetscFunctionBegin; 8775c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 8785c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 8795c6c1daeSBarry Smith ierr = EventPerfLogActivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 8805c6c1daeSBarry Smith PetscFunctionReturn(0); 8815c6c1daeSBarry Smith } 8825c6c1daeSBarry Smith 8835c6c1daeSBarry Smith #undef __FUNCT__ 8845c6c1daeSBarry Smith #define __FUNCT__ "PetscLogEventDeactivateClass" 8855c6c1daeSBarry Smith /*@ 8865c6c1daeSBarry Smith PetscLogEventDeactivateClass - Deactivates event logging for a PETSc object class. 8875c6c1daeSBarry Smith 8885c6c1daeSBarry Smith Not Collective 8895c6c1daeSBarry Smith 8905c6c1daeSBarry Smith Input Parameter: 8915c6c1daeSBarry Smith . classid - The event class, for example MAT_CLASSID, SNES_CLASSID, etc. 8925c6c1daeSBarry Smith 8935c6c1daeSBarry Smith Level: developer 8945c6c1daeSBarry Smith 8955c6c1daeSBarry Smith .keywords: log, event, deactivate, class 8965c6c1daeSBarry Smith .seealso: PetscInfoActivate(),PetscInfo(),PetscInfoAllow(),PetscLogEventActivateClass(), PetscLogEventActivate(),PetscLogEventDeactivate() 8975c6c1daeSBarry Smith @*/ 8985c6c1daeSBarry Smith PetscErrorCode PetscLogEventDeactivateClass(PetscClassId classid) 8995c6c1daeSBarry Smith { 9005c6c1daeSBarry Smith PetscStageLog stageLog; 9015c6c1daeSBarry Smith int stage; 9025c6c1daeSBarry Smith PetscErrorCode ierr; 9035c6c1daeSBarry Smith 9045c6c1daeSBarry Smith PetscFunctionBegin; 9055c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 9065c6c1daeSBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 9075c6c1daeSBarry Smith ierr = EventPerfLogDeactivateClass(stageLog->stageInfo[stage].eventLog, stageLog->eventLog, classid);CHKERRQ(ierr); 9085c6c1daeSBarry Smith PetscFunctionReturn(0); 9095c6c1daeSBarry Smith } 9105c6c1daeSBarry Smith 9115c6c1daeSBarry Smith /*MC 9125c6c1daeSBarry Smith PetscLogEventBegin - Logs the beginning of a user event. 9135c6c1daeSBarry Smith 9145c6c1daeSBarry Smith Synopsis: 915aaa7dc30SBarry Smith #include <petsclog.h> 916f2ba6396SBarry Smith PetscErrorCode PetscLogEventBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 9175c6c1daeSBarry Smith 9185c6c1daeSBarry Smith Not Collective 9195c6c1daeSBarry Smith 9205c6c1daeSBarry Smith Input Parameters: 9215c6c1daeSBarry Smith + e - integer associated with the event obtained from PetscLogEventRegister() 9225c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 9235c6c1daeSBarry Smith 9245c6c1daeSBarry Smith 9255c6c1daeSBarry Smith Fortran Synopsis: 9265c6c1daeSBarry Smith void PetscLogEventBegin(int e,PetscErrorCode ierr) 9275c6c1daeSBarry Smith 9285c6c1daeSBarry Smith Usage: 9295c6c1daeSBarry Smith .vb 9305c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 9315c6c1daeSBarry Smith PetscLogDouble user_event_flops; 9325c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 9335c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 9345c6c1daeSBarry Smith [code segment to monitor] 9355c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 9365c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 9375c6c1daeSBarry Smith .ve 9385c6c1daeSBarry Smith 9395c6c1daeSBarry Smith Notes: 9405c6c1daeSBarry Smith You need to register each integer event with the command 9415c6c1daeSBarry Smith PetscLogEventRegister(). The source code must be compiled with 9425c6c1daeSBarry Smith -DPETSC_USE_LOG, which is the default. 9435c6c1daeSBarry Smith 9445c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 9455c6c1daeSBarry Smith compiled with -DPETSC_USE_LOG, and -log, -log_summary, or -log_all are 9465c6c1daeSBarry Smith specified. PetscLogEventBegin() is intended for logging user events 9475c6c1daeSBarry Smith to supplement this PETSc information. 9485c6c1daeSBarry Smith 9495c6c1daeSBarry Smith Level: intermediate 9505c6c1daeSBarry Smith 9515c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops() 9525c6c1daeSBarry Smith 9535c6c1daeSBarry Smith .keywords: log, event, begin 9545c6c1daeSBarry Smith M*/ 9555c6c1daeSBarry Smith 9565c6c1daeSBarry Smith /*MC 9575c6c1daeSBarry Smith PetscLogEventEnd - Log the end of a user event. 9585c6c1daeSBarry Smith 9595c6c1daeSBarry Smith Synopsis: 960aaa7dc30SBarry Smith #include <petsclog.h> 961f2ba6396SBarry Smith PetscErrorCode PetscLogEventEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4) 9625c6c1daeSBarry Smith 9635c6c1daeSBarry Smith Not Collective 9645c6c1daeSBarry Smith 9655c6c1daeSBarry Smith Input Parameters: 9665c6c1daeSBarry Smith + e - integer associated with the event obtained with PetscLogEventRegister() 9675c6c1daeSBarry Smith - o1,o2,o3,o4 - objects associated with the event, or 0 9685c6c1daeSBarry Smith 9695c6c1daeSBarry Smith 9705c6c1daeSBarry Smith Fortran Synopsis: 9715c6c1daeSBarry Smith void PetscLogEventEnd(int e,PetscErrorCode ierr) 9725c6c1daeSBarry Smith 9735c6c1daeSBarry Smith Usage: 9745c6c1daeSBarry Smith .vb 9755c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 9765c6c1daeSBarry Smith PetscLogDouble user_event_flops; 9775c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT,); 9785c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 9795c6c1daeSBarry Smith [code segment to monitor] 9805c6c1daeSBarry Smith PetscLogFlops(user_event_flops); 9815c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 9825c6c1daeSBarry Smith .ve 9835c6c1daeSBarry Smith 9845c6c1daeSBarry Smith Notes: 9855c6c1daeSBarry Smith You should also register each additional integer event with the command 9865c6c1daeSBarry Smith PetscLogEventRegister(). Source code must be compiled with 9875c6c1daeSBarry Smith -DPETSC_USE_LOG, which is the default. 9885c6c1daeSBarry Smith 9895c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 9905c6c1daeSBarry Smith compiled with -DPETSC_USE_LOG, and -log, -log_summary, or -log_all are 9915c6c1daeSBarry Smith specified. PetscLogEventEnd() is intended for logging user events 9925c6c1daeSBarry Smith to supplement this PETSc information. 9935c6c1daeSBarry Smith 9945c6c1daeSBarry Smith Level: intermediate 9955c6c1daeSBarry Smith 9965c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogFlops() 9975c6c1daeSBarry Smith 9985c6c1daeSBarry Smith .keywords: log, event, end 9995c6c1daeSBarry Smith M*/ 10005c6c1daeSBarry Smith 10015c6c1daeSBarry Smith /*MC 10025c6c1daeSBarry Smith PetscLogEventBarrierBegin - Logs the time in a barrier before an event. 10035c6c1daeSBarry Smith 10045c6c1daeSBarry Smith Synopsis: 1005aaa7dc30SBarry Smith #include <petsclog.h> 1006f2ba6396SBarry Smith PetscErrorCode PetscLogEventBarrierBegin(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4,MPI_Comm comm) 10075c6c1daeSBarry Smith 10085c6c1daeSBarry Smith Not Collective 10095c6c1daeSBarry Smith 10105c6c1daeSBarry Smith Input Parameters: 10115c6c1daeSBarry Smith . e - integer associated with the event obtained from PetscLogEventRegister() 10125c6c1daeSBarry Smith . o1,o2,o3,o4 - objects associated with the event, or 0 10135c6c1daeSBarry Smith . comm - communicator the barrier takes place over 10145c6c1daeSBarry Smith 10155c6c1daeSBarry Smith 10165c6c1daeSBarry Smith Usage: 10175c6c1daeSBarry Smith .vb 10185c6c1daeSBarry Smith PetscLogEventBarrierBegin(VEC_NormBarrier,0,0,0,0,comm); 10195c6c1daeSBarry Smith MPI_Allreduce() 10205c6c1daeSBarry Smith PetscLogEventBarrierEnd(VEC_NormBarrier,0,0,0,0,comm); 10215c6c1daeSBarry Smith .ve 10225c6c1daeSBarry Smith 10235c6c1daeSBarry Smith Notes: 10245c6c1daeSBarry Smith This is for logging the amount of time spent in a barrier for an event 10255c6c1daeSBarry Smith that requires synchronization. 10265c6c1daeSBarry Smith 10275c6c1daeSBarry Smith Additional Notes: 10285c6c1daeSBarry Smith Synchronization events always come in pairs; for example, VEC_NormBarrier and 10295c6c1daeSBarry Smith VEC_NormComm = VEC_NormBarrier + 1 10305c6c1daeSBarry Smith 10315c6c1daeSBarry Smith Level: advanced 10325c6c1daeSBarry Smith 10335c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops(), PetscLogEventBegin(), 10345c6c1daeSBarry Smith PetscLogEventBarrierEnd() 10355c6c1daeSBarry Smith 10365c6c1daeSBarry Smith .keywords: log, event, begin, barrier 10375c6c1daeSBarry Smith M*/ 10385c6c1daeSBarry Smith 10395c6c1daeSBarry Smith /*MC 10405c6c1daeSBarry Smith PetscLogEventBarrierEnd - Logs the time in a barrier before an event. 10415c6c1daeSBarry Smith 10425c6c1daeSBarry Smith Synopsis: 1043aaa7dc30SBarry Smith #include <petsclog.h> 1044f2ba6396SBarry Smith PetscErrorCode PetscLogEventBarrierEnd(int e,PetscObject o1,PetscObject o2,PetscObject o3,PetscObject o4,MPI_Comm comm) 10455c6c1daeSBarry Smith 10465c6c1daeSBarry Smith Logically Collective on MPI_Comm 10475c6c1daeSBarry Smith 10485c6c1daeSBarry Smith Input Parameters: 10495c6c1daeSBarry Smith . e - integer associated with the event obtained from PetscLogEventRegister() 10505c6c1daeSBarry Smith . o1,o2,o3,o4 - objects associated with the event, or 0 10515c6c1daeSBarry Smith . comm - communicator the barrier takes place over 10525c6c1daeSBarry Smith 10535c6c1daeSBarry Smith 10545c6c1daeSBarry Smith Usage: 10555c6c1daeSBarry Smith .vb 10565c6c1daeSBarry Smith PetscLogEventBarrierBegin(VEC_NormBarrier,0,0,0,0,comm); 10575c6c1daeSBarry Smith MPI_Allreduce() 10585c6c1daeSBarry Smith PetscLogEventBarrierEnd(VEC_NormBarrier,0,0,0,0,comm); 10595c6c1daeSBarry Smith .ve 10605c6c1daeSBarry Smith 10615c6c1daeSBarry Smith Notes: 10625c6c1daeSBarry Smith This is for logging the amount of time spent in a barrier for an event 10635c6c1daeSBarry Smith that requires synchronization. 10645c6c1daeSBarry Smith 10655c6c1daeSBarry Smith Additional Notes: 10665c6c1daeSBarry Smith Synchronization events always come in pairs; for example, VEC_NormBarrier and 10675c6c1daeSBarry Smith VEC_NormComm = VEC_NormBarrier + 1 10685c6c1daeSBarry Smith 10695c6c1daeSBarry Smith Level: advanced 10705c6c1daeSBarry Smith 10715c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventEnd(), PetscLogFlops(), PetscLogEventBegin(), 10725c6c1daeSBarry Smith PetscLogEventBarrierBegin() 10735c6c1daeSBarry Smith 10745c6c1daeSBarry Smith .keywords: log, event, begin, barrier 10755c6c1daeSBarry Smith M*/ 10765c6c1daeSBarry Smith 10775c6c1daeSBarry Smith #undef __FUNCT__ 10785c6c1daeSBarry Smith #define __FUNCT__ "PetscLogEventGetId" 10795c6c1daeSBarry Smith /*@C 10805c6c1daeSBarry Smith PetscLogEventGetId - Returns the event id when given the event name. 10815c6c1daeSBarry Smith 10825c6c1daeSBarry Smith Not Collective 10835c6c1daeSBarry Smith 10845c6c1daeSBarry Smith Input Parameter: 10855c6c1daeSBarry Smith . name - The event name 10865c6c1daeSBarry Smith 10875c6c1daeSBarry Smith Output Parameter: 1088c5deb1d5SJed Brown . event - The event, or -1 if no event with that name exists 10895c6c1daeSBarry Smith 10905c6c1daeSBarry Smith Level: intermediate 10915c6c1daeSBarry Smith 10925c6c1daeSBarry Smith .seealso: PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStageGetId() 10935c6c1daeSBarry Smith @*/ 10945c6c1daeSBarry Smith PetscErrorCode PetscLogEventGetId(const char name[], PetscLogEvent *event) 10955c6c1daeSBarry Smith { 10965c6c1daeSBarry Smith PetscStageLog stageLog; 10975c6c1daeSBarry Smith PetscErrorCode ierr; 10985c6c1daeSBarry Smith 10995c6c1daeSBarry Smith PetscFunctionBegin; 11005c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 11015c6c1daeSBarry Smith ierr = EventRegLogGetEvent(stageLog->eventLog, name, event);CHKERRQ(ierr); 11025c6c1daeSBarry Smith PetscFunctionReturn(0); 11035c6c1daeSBarry Smith } 11045c6c1daeSBarry Smith 11055c6c1daeSBarry Smith 11065c6c1daeSBarry Smith /*------------------------------------------------ Output Functions -------------------------------------------------*/ 11075c6c1daeSBarry Smith #undef __FUNCT__ 11085c6c1daeSBarry Smith #define __FUNCT__ "PetscLogDump" 11095c6c1daeSBarry Smith /*@C 11105c6c1daeSBarry Smith PetscLogDump - Dumps logs of objects to a file. This file is intended to 11115c6c1daeSBarry Smith be read by bin/petscview. This program no longer exists. 11125c6c1daeSBarry Smith 11135c6c1daeSBarry Smith Collective on PETSC_COMM_WORLD 11145c6c1daeSBarry Smith 11155c6c1daeSBarry Smith Input Parameter: 11165c6c1daeSBarry Smith . name - an optional file name 11175c6c1daeSBarry Smith 11185c6c1daeSBarry Smith Options Database Keys: 11195c6c1daeSBarry Smith + -log - Prints basic log information (for code compiled with PETSC_USE_LOG) 11205c6c1daeSBarry Smith - -log_all - Prints extensive log information (for code compiled with PETSC_USE_LOG) 11215c6c1daeSBarry Smith 11225c6c1daeSBarry Smith Usage: 11235c6c1daeSBarry Smith .vb 11245c6c1daeSBarry Smith PetscInitialize(...); 1125*bb1d7374SBarry Smith PetscLogDefaultBegin(); or PetscLogAllBegin(); 11265c6c1daeSBarry Smith ... code ... 11275c6c1daeSBarry Smith PetscLogDump(filename); 11285c6c1daeSBarry Smith PetscFinalize(); 11295c6c1daeSBarry Smith .ve 11305c6c1daeSBarry Smith 11315c6c1daeSBarry Smith Notes: 11325c6c1daeSBarry Smith The default file name is 11335c6c1daeSBarry Smith $ Log.<rank> 11345c6c1daeSBarry Smith where <rank> is the processor number. If no name is specified, 11355c6c1daeSBarry Smith this file will be used. 11365c6c1daeSBarry Smith 11375c6c1daeSBarry Smith Level: advanced 11385c6c1daeSBarry Smith 11395c6c1daeSBarry Smith .keywords: log, dump 1140*bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogView() 11415c6c1daeSBarry Smith @*/ 11425c6c1daeSBarry Smith PetscErrorCode PetscLogDump(const char sname[]) 11435c6c1daeSBarry Smith { 11445c6c1daeSBarry Smith PetscStageLog stageLog; 11455c6c1daeSBarry Smith PetscEventPerfInfo *eventInfo; 11465c6c1daeSBarry Smith FILE *fd; 11475c6c1daeSBarry Smith char file[PETSC_MAX_PATH_LEN], fname[PETSC_MAX_PATH_LEN]; 11485c6c1daeSBarry Smith PetscLogDouble flops, _TotalTime; 11495c6c1daeSBarry Smith PetscMPIInt rank; 11505c6c1daeSBarry Smith int action, object, curStage; 11515c6c1daeSBarry Smith PetscLogEvent event; 11525c6c1daeSBarry Smith PetscErrorCode ierr; 11535c6c1daeSBarry Smith 11545c6c1daeSBarry Smith PetscFunctionBegin; 11555c6c1daeSBarry Smith /* Calculate the total elapsed time */ 11568563dfccSBarry Smith PetscTime(&_TotalTime); 11575c6c1daeSBarry Smith _TotalTime -= petsc_BaseTime; 11585c6c1daeSBarry Smith /* Open log file */ 11595c6c1daeSBarry Smith ierr = MPI_Comm_rank(PETSC_COMM_WORLD, &rank);CHKERRQ(ierr); 1160a297a907SKarl Rupp if (sname) sprintf(file, "%s.%d", sname, rank); 1161a297a907SKarl Rupp else sprintf(file, "Log.%d", rank); 11625c6c1daeSBarry Smith ierr = PetscFixFilename(file, fname);CHKERRQ(ierr); 11635c6c1daeSBarry Smith ierr = PetscFOpen(PETSC_COMM_WORLD, fname, "w", &fd);CHKERRQ(ierr); 11645c6c1daeSBarry Smith if ((!rank) && (!fd)) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN, "Cannot open file: %s", fname); 11655c6c1daeSBarry Smith /* Output totals */ 1166a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Total Flops %14e %16.8e\n", petsc_TotalFlops, _TotalTime);CHKERRQ(ierr); 1167a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Clock Resolution %g\n", 0.0);CHKERRQ(ierr); 11685c6c1daeSBarry Smith /* Output actions */ 11695c6c1daeSBarry Smith if (petsc_logActions) { 1170a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Actions accomplished %d\n", petsc_numActions);CHKERRQ(ierr); 11715c6c1daeSBarry Smith for (action = 0; action < petsc_numActions; action++) { 11725c6c1daeSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%g %d %d %d %d %d %d %g %g %g\n", 11735c6c1daeSBarry Smith petsc_actions[action].time, petsc_actions[action].action, (int)petsc_actions[action].event, (int)petsc_actions[action].classid, petsc_actions[action].id1, 1174a2ea699eSBarry Smith petsc_actions[action].id2, petsc_actions[action].id3, petsc_actions[action].flops, petsc_actions[action].mem, petsc_actions[action].maxmem);CHKERRQ(ierr); 11755c6c1daeSBarry Smith } 11765c6c1daeSBarry Smith } 11775c6c1daeSBarry Smith /* Output objects */ 11785c6c1daeSBarry Smith if (petsc_logObjects) { 1179a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Objects created %d destroyed %d\n", petsc_numObjects, petsc_numObjectsDestroyed);CHKERRQ(ierr); 11805c6c1daeSBarry Smith for (object = 0; object < petsc_numObjects; object++) { 1181a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Parent ID: %d Memory: %d\n", petsc_objects[object].parent, (int) petsc_objects[object].mem);CHKERRQ(ierr); 11825c6c1daeSBarry Smith if (!petsc_objects[object].name[0]) { 1183a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd,"No Name\n");CHKERRQ(ierr); 11845c6c1daeSBarry Smith } else { 1185a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Name: %s\n", petsc_objects[object].name);CHKERRQ(ierr); 11865c6c1daeSBarry Smith } 11875c6c1daeSBarry Smith if (petsc_objects[object].info[0] != 0) { 1188a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "No Info\n");CHKERRQ(ierr); 11895c6c1daeSBarry Smith } else { 1190a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Info: %s\n", petsc_objects[object].info);CHKERRQ(ierr); 11915c6c1daeSBarry Smith } 11925c6c1daeSBarry Smith } 11935c6c1daeSBarry Smith } 11945c6c1daeSBarry Smith /* Output events */ 1195a2ea699eSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "Event log:\n");CHKERRQ(ierr); 11965c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 11975c6c1daeSBarry Smith ierr = PetscIntStackTop(stageLog->stack, &curStage);CHKERRQ(ierr); 11985c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[curStage].eventLog->eventInfo; 11995c6c1daeSBarry Smith for (event = 0; event < stageLog->stageInfo[curStage].eventLog->numEvents; event++) { 1200a297a907SKarl Rupp if (eventInfo[event].time != 0.0) flops = eventInfo[event].flops/eventInfo[event].time; 1201a297a907SKarl Rupp else flops = 0.0; 12025c6c1daeSBarry Smith ierr = PetscFPrintf(PETSC_COMM_WORLD, fd, "%d %16d %16g %16g %16g\n", event, eventInfo[event].count, 1203a2ea699eSBarry Smith eventInfo[event].flops, eventInfo[event].time, flops);CHKERRQ(ierr); 12045c6c1daeSBarry Smith } 12055c6c1daeSBarry Smith ierr = PetscFClose(PETSC_COMM_WORLD, fd);CHKERRQ(ierr); 12065c6c1daeSBarry Smith PetscFunctionReturn(0); 12075c6c1daeSBarry Smith } 12085c6c1daeSBarry Smith 12095c6c1daeSBarry Smith #undef __FUNCT__ 1210f14045dbSBarry Smith #define __FUNCT__ "PetscLogView_Detailed" 1211f14045dbSBarry Smith /* 1212f14045dbSBarry Smith PetscLogView_Detailed - Each process prints the times for its own events 1213f14045dbSBarry Smith 1214f14045dbSBarry Smith */ 1215f14045dbSBarry Smith PetscErrorCode PetscLogView_Detailed(PetscViewer viewer) 1216f14045dbSBarry Smith { 12172d1ec343SBarry Smith MPI_Comm comm = PetscObjectComm((PetscObject) viewer); 12182d1ec343SBarry Smith PetscEventPerfInfo *eventInfo = NULL; 12192dff6485SMatthew G. Knepley PetscLogDouble locTotalTime, numRed, maxMem; 12202dff6485SMatthew G. Knepley PetscStageLog stageLog; 12212dff6485SMatthew G. Knepley int numStages,numEvents,stage,event; 12222dff6485SMatthew G. Knepley PetscMPIInt rank,size; 12232dff6485SMatthew G. Knepley PetscErrorCode ierr; 1224f14045dbSBarry Smith 1225f14045dbSBarry Smith PetscFunctionBegin; 12262d1ec343SBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 12272d1ec343SBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 12282dff6485SMatthew G. Knepley /* Must preserve reduction count before we go on */ 12292dff6485SMatthew G. Knepley numRed = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 12302d1ec343SBarry Smith /* Get the total elapsed time */ 12312d1ec343SBarry Smith PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 12322dff6485SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer,"numProcs = %d\n",size);CHKERRQ(ierr); 12332d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalTimes = {}\n");CHKERRQ(ierr); 12342d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalFlops = {}\n");CHKERRQ(ierr); 12352d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalMessageLens = {}\n");CHKERRQ(ierr); 12362d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalMessages = {}\n");CHKERRQ(ierr); 12372d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"LocalReductions = {}\n");CHKERRQ(ierr); 12382dff6485SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer,"LocalObjects = {}\n");CHKERRQ(ierr); 12392dff6485SMatthew G. Knepley ierr = PetscViewerASCIIPrintf(viewer,"LocalMemory = {}\n");CHKERRQ(ierr); 12402d1ec343SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 12412d1ec343SBarry Smith ierr = MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 12422d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages = {}\n");CHKERRQ(ierr); 12432d1ec343SBarry Smith for (stage=0; stage<numStages; stage++) { 12442d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr); 124561917356SPatrick Sanan ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"summary\"] = {}\n",stageLog->stageInfo[stage].name);CHKERRQ(ierr); 12462d1ec343SBarry Smith ierr = MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 12472d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 12482d1ec343SBarry Smith ierr = PetscViewerASCIIPrintf(viewer,"Stages[\"%s\"][\"%s\"] = {}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name);CHKERRQ(ierr); 12492d1ec343SBarry Smith } 12502d1ec343SBarry Smith } 12511575c14dSBarry Smith ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr); 12522d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalTimes[%d] = %g\n",rank,locTotalTime);CHKERRQ(ierr); 12532d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalFlops[%d] = %g\n",rank,petsc_TotalFlops);CHKERRQ(ierr); 12542d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessageLens[%d] = %g\n",rank,(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len));CHKERRQ(ierr); 12552d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMessages[%d] = %g\n",rank,(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct));CHKERRQ(ierr); 12562dff6485SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalReductions[%d] = %g\n",rank,numRed);CHKERRQ(ierr); 12572dff6485SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalObjects[%d] = %g\n",rank,petsc_numObjects);CHKERRQ(ierr); 12582dff6485SMatthew G. Knepley ierr = PetscMallocGetMaximumUsage(&maxMem);CHKERRQ(ierr); 12592dff6485SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"LocalMemory[%d] = %g\n",rank,maxMem);CHKERRQ(ierr); 12602d1ec343SBarry Smith ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 12612d1ec343SBarry Smith for (stage=0; stage<numStages; stage++) { 12622dff6485SMatthew G. Knepley ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"summary\"][%d] = {\"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flops\" : %g}\n", 12632dff6485SMatthew G. Knepley stageLog->stageInfo[stage].name,rank, 12642dff6485SMatthew G. Knepley stageLog->stageInfo[stage].perfInfo.time,stageLog->stageInfo[stage].perfInfo.numMessages,stageLog->stageInfo[stage].perfInfo.messageLength, 12652dff6485SMatthew G. Knepley stageLog->stageInfo[stage].perfInfo.numReductions,stageLog->stageInfo[stage].perfInfo.flops);CHKERRQ(ierr); 12662d1ec343SBarry Smith ierr = MPI_Allreduce(&stageLog->stageInfo[stage].eventLog->numEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 12672d1ec343SBarry Smith for (event = 0; event < numEvents; event++) { 12682d1ec343SBarry Smith eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo; 12692d1ec343SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"Stages[\"%s\"][\"%s\"][%d] = {\"count\" : %D, \"time\" : %g, \"numMessages\" : %g, \"messageLength\" : %g, \"numReductions\" : %g, \"flops\" : %g}\n",stageLog->stageInfo[stage].name,stageLog->eventLog->eventInfo[event].name,rank, 12702d1ec343SBarry Smith eventInfo[event].count, eventInfo[event].time,eventInfo[event].numMessages, eventInfo[event].messageLength, 12712d1ec343SBarry Smith eventInfo[event].numReductions,eventInfo[event].flops);CHKERRQ(ierr); 12722d1ec343SBarry Smith } 12732d1ec343SBarry Smith } 12742d1ec343SBarry Smith ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 12751575c14dSBarry Smith ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr); 1276f14045dbSBarry Smith PetscFunctionReturn(0); 1277f14045dbSBarry Smith } 1278f14045dbSBarry Smith 1279f14045dbSBarry Smith #undef __FUNCT__ 1280f14045dbSBarry Smith #define __FUNCT__ "PetscLogView_Default" 1281f14045dbSBarry Smith PetscErrorCode PetscLogView_Default(PetscViewer viewer) 12825c6c1daeSBarry Smith { 12835c6c1daeSBarry Smith FILE *fd; 12845c6c1daeSBarry Smith PetscLogDouble zero = 0.0; 12855c6c1daeSBarry Smith PetscStageLog stageLog; 12860298fd71SBarry Smith PetscStageInfo *stageInfo = NULL; 12870298fd71SBarry Smith PetscEventPerfInfo *eventInfo = NULL; 12885c6c1daeSBarry Smith PetscClassPerfInfo *classInfo; 12895c6c1daeSBarry Smith char arch[128],hostname[128],username[128],pname[PETSC_MAX_PATH_LEN],date[128]; 12905c6c1daeSBarry Smith const char *name; 12915c6c1daeSBarry Smith PetscLogDouble locTotalTime, TotalTime, TotalFlops; 12925c6c1daeSBarry Smith PetscLogDouble numMessages, messageLength, avgMessLen, numReductions; 12935c6c1daeSBarry Smith PetscLogDouble stageTime, flops, flopr, mem, mess, messLen, red; 12945c6c1daeSBarry Smith PetscLogDouble fracTime, fracFlops, fracMessages, fracLength, fracReductions, fracMess, fracMessLen, fracRed; 12955c6c1daeSBarry Smith PetscLogDouble fracStageTime, fracStageFlops, fracStageMess, fracStageMessLen, fracStageRed; 12965c6c1daeSBarry Smith PetscLogDouble min, max, tot, ratio, avg, x, y; 12975c6c1daeSBarry Smith PetscLogDouble minf, maxf, totf, ratf, mint, maxt, tott, ratt, ratCt, totm, totml, totr; 12985c6c1daeSBarry Smith PetscMPIInt minCt, maxCt; 12995c6c1daeSBarry Smith PetscMPIInt size, rank; 13005c6c1daeSBarry Smith PetscBool *localStageUsed, *stageUsed; 13015c6c1daeSBarry Smith PetscBool *localStageVisible, *stageVisible; 13025c6c1daeSBarry Smith int numStages, localNumEvents, numEvents; 130337b78d16SBarry Smith int stage, oclass; 13045c6c1daeSBarry Smith PetscLogEvent event; 13055c6c1daeSBarry Smith PetscErrorCode ierr; 13065c6c1daeSBarry Smith char version[256]; 13075c6c1daeSBarry Smith MPI_Comm comm; 13085c6c1daeSBarry Smith 13095c6c1daeSBarry Smith PetscFunctionBegin; 13105c6c1daeSBarry Smith ierr = PetscObjectGetComm((PetscObject)viewer,&comm);CHKERRQ(ierr); 13115c6c1daeSBarry Smith ierr = PetscViewerASCIIGetPointer(viewer,&fd);CHKERRQ(ierr); 13125c6c1daeSBarry Smith ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr); 13135c6c1daeSBarry Smith ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr); 13145c6c1daeSBarry Smith /* Get the total elapsed time */ 13158563dfccSBarry Smith PetscTime(&locTotalTime); locTotalTime -= petsc_BaseTime; 13165c6c1daeSBarry Smith 13175c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr); 13185c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "*** WIDEN YOUR WINDOW TO 120 CHARACTERS. Use 'enscript -r -fCourier9' to print this document ***\n");CHKERRQ(ierr); 13195c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "************************************************************************************************************************\n");CHKERRQ(ierr); 13205c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n---------------------------------------------- PETSc Performance Summary: ----------------------------------------------\n\n");CHKERRQ(ierr); 13215c6c1daeSBarry Smith ierr = PetscGetArchType(arch,sizeof(arch));CHKERRQ(ierr); 13225c6c1daeSBarry Smith ierr = PetscGetHostName(hostname,sizeof(hostname));CHKERRQ(ierr); 13235c6c1daeSBarry Smith ierr = PetscGetUserName(username,sizeof(username));CHKERRQ(ierr); 13245c6c1daeSBarry Smith ierr = PetscGetProgramName(pname,sizeof(pname));CHKERRQ(ierr); 13255c6c1daeSBarry Smith ierr = PetscGetDate(date,sizeof(date));CHKERRQ(ierr); 13265c6c1daeSBarry Smith ierr = PetscGetVersion(version,sizeof(version));CHKERRQ(ierr); 13275c6c1daeSBarry Smith if (size == 1) { 13285c6c1daeSBarry 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); 13295c6c1daeSBarry Smith } else { 13305c6c1daeSBarry 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); 13315c6c1daeSBarry Smith } 13325c6c1daeSBarry Smith 13335c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Using %s\n", version);CHKERRQ(ierr); 13345c6c1daeSBarry Smith 13355c6c1daeSBarry Smith /* Must preserve reduction count before we go on */ 13365c6c1daeSBarry Smith red = petsc_allreduce_ct + petsc_gather_ct + petsc_scatter_ct; 13375c6c1daeSBarry Smith 13385c6c1daeSBarry Smith /* Calculate summary information */ 13395c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n Max Max/Min Avg Total \n");CHKERRQ(ierr); 13405c6c1daeSBarry Smith /* Time */ 13415c6c1daeSBarry Smith ierr = MPI_Allreduce(&locTotalTime, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 13425c6c1daeSBarry Smith ierr = MPI_Allreduce(&locTotalTime, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 13435c6c1daeSBarry Smith ierr = MPI_Allreduce(&locTotalTime, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 13445c6c1daeSBarry Smith avg = (tot)/((PetscLogDouble) size); 1345a297a907SKarl Rupp if (min != 0.0) ratio = max/min; 1346a297a907SKarl Rupp else ratio = 0.0; 13475c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Time (sec): %5.3e %10.5f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 13485c6c1daeSBarry Smith TotalTime = tot; 13495c6c1daeSBarry Smith /* Objects */ 13505c6c1daeSBarry Smith avg = (PetscLogDouble) petsc_numObjects; 13515c6c1daeSBarry Smith ierr = MPI_Allreduce(&avg, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 13525c6c1daeSBarry Smith ierr = MPI_Allreduce(&avg, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 13535c6c1daeSBarry Smith ierr = MPI_Allreduce(&avg, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 13545c6c1daeSBarry Smith avg = (tot)/((PetscLogDouble) size); 1355a297a907SKarl Rupp if (min != 0.0) ratio = max/min; 1356a297a907SKarl Rupp else ratio = 0.0; 13575c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Objects: %5.3e %10.5f %5.3e\n", max, ratio, avg);CHKERRQ(ierr); 13585c6c1daeSBarry Smith /* Flops */ 13595c6c1daeSBarry Smith ierr = MPI_Allreduce(&petsc_TotalFlops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 13605c6c1daeSBarry Smith ierr = MPI_Allreduce(&petsc_TotalFlops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 13615c6c1daeSBarry Smith ierr = MPI_Allreduce(&petsc_TotalFlops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 13625c6c1daeSBarry Smith avg = (tot)/((PetscLogDouble) size); 1363a297a907SKarl Rupp if (min != 0.0) ratio = max/min; 1364a297a907SKarl Rupp else ratio = 0.0; 13655c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Flops: %5.3e %10.5f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 13665c6c1daeSBarry Smith TotalFlops = tot; 13675c6c1daeSBarry Smith /* Flops/sec -- Must talk to Barry here */ 1368a297a907SKarl Rupp if (locTotalTime != 0.0) flops = petsc_TotalFlops/locTotalTime; 1369a297a907SKarl Rupp else flops = 0.0; 13705c6c1daeSBarry Smith ierr = MPI_Allreduce(&flops, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 13715c6c1daeSBarry Smith ierr = MPI_Allreduce(&flops, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 13725c6c1daeSBarry Smith ierr = MPI_Allreduce(&flops, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 13735c6c1daeSBarry Smith avg = (tot)/((PetscLogDouble) size); 1374a297a907SKarl Rupp if (min != 0.0) ratio = max/min; 1375a297a907SKarl Rupp else ratio = 0.0; 13765c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Flops/sec: %5.3e %10.5f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 13775c6c1daeSBarry Smith /* Memory */ 13785c6c1daeSBarry Smith ierr = PetscMallocGetMaximumUsage(&mem);CHKERRQ(ierr); 13795c6c1daeSBarry Smith if (mem > 0.0) { 13805c6c1daeSBarry Smith ierr = MPI_Allreduce(&mem, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 13815c6c1daeSBarry Smith ierr = MPI_Allreduce(&mem, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 13825c6c1daeSBarry Smith ierr = MPI_Allreduce(&mem, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 13835c6c1daeSBarry Smith avg = (tot)/((PetscLogDouble) size); 1384a297a907SKarl Rupp if (min != 0.0) ratio = max/min; 1385a297a907SKarl Rupp else ratio = 0.0; 13865c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Memory: %5.3e %10.5f %5.3e\n", max, ratio, tot);CHKERRQ(ierr); 13875c6c1daeSBarry Smith } 13885c6c1daeSBarry Smith /* Messages */ 13895c6c1daeSBarry Smith mess = 0.5*(petsc_irecv_ct + petsc_isend_ct + petsc_recv_ct + petsc_send_ct); 13905c6c1daeSBarry Smith ierr = MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 13915c6c1daeSBarry Smith ierr = MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 13925c6c1daeSBarry Smith ierr = MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 13935c6c1daeSBarry Smith avg = (tot)/((PetscLogDouble) size); 1394a297a907SKarl Rupp if (min != 0.0) ratio = max/min; 1395a297a907SKarl Rupp else ratio = 0.0; 13965c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "MPI Messages: %5.3e %10.5f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 13975c6c1daeSBarry Smith numMessages = tot; 13985c6c1daeSBarry Smith /* Message Lengths */ 13995c6c1daeSBarry Smith mess = 0.5*(petsc_irecv_len + petsc_isend_len + petsc_recv_len + petsc_send_len); 14005c6c1daeSBarry Smith ierr = MPI_Allreduce(&mess, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 14015c6c1daeSBarry Smith ierr = MPI_Allreduce(&mess, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 14025c6c1daeSBarry Smith ierr = MPI_Allreduce(&mess, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1403a297a907SKarl Rupp if (numMessages != 0) avg = (tot)/(numMessages); 1404a297a907SKarl Rupp else avg = 0.0; 1405a297a907SKarl Rupp if (min != 0.0) ratio = max/min; 1406a297a907SKarl Rupp else ratio = 0.0; 14075c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "MPI Message Lengths: %5.3e %10.5f %5.3e %5.3e\n", max, ratio, avg, tot);CHKERRQ(ierr); 14085c6c1daeSBarry Smith messageLength = tot; 14095c6c1daeSBarry Smith /* Reductions */ 14105c6c1daeSBarry Smith ierr = MPI_Allreduce(&red, &min, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 14115c6c1daeSBarry Smith ierr = MPI_Allreduce(&red, &max, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 14125c6c1daeSBarry Smith ierr = MPI_Allreduce(&red, &tot, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 1413a297a907SKarl Rupp if (min != 0.0) ratio = max/min; 1414a297a907SKarl Rupp else ratio = 0.0; 14155c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "MPI Reductions: %5.3e %10.5f\n", max, ratio);CHKERRQ(ierr); 14165c6c1daeSBarry Smith numReductions = red; /* wrong because uses count from process zero */ 14175c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\nFlop counting convention: 1 flop = 1 real number operation of type (multiply/divide/add/subtract)\n");CHKERRQ(ierr); 14185c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " e.g., VecAXPY() for real vectors of length N --> 2N flops\n");CHKERRQ(ierr); 14195c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " and VecAXPY() for complex vectors of length N --> 8N flops\n");CHKERRQ(ierr); 14205c6c1daeSBarry Smith 14215c6c1daeSBarry Smith /* Get total number of stages -- 14225c6c1daeSBarry Smith Currently, a single processor can register more stages than another, but stages must all be registered in order. 14235c6c1daeSBarry Smith We can removed this requirement if necessary by having a global stage numbering and indirection on the stage ID. 14245c6c1daeSBarry Smith This seems best accomplished by assoicating a communicator with each stage. 14255c6c1daeSBarry Smith */ 142637b78d16SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 14275c6c1daeSBarry Smith ierr = MPI_Allreduce(&stageLog->numStages, &numStages, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 1428785e854fSJed Brown ierr = PetscMalloc1(numStages, &localStageUsed);CHKERRQ(ierr); 1429785e854fSJed Brown ierr = PetscMalloc1(numStages, &stageUsed);CHKERRQ(ierr); 1430785e854fSJed Brown ierr = PetscMalloc1(numStages, &localStageVisible);CHKERRQ(ierr); 1431785e854fSJed Brown ierr = PetscMalloc1(numStages, &stageVisible);CHKERRQ(ierr); 14325c6c1daeSBarry Smith if (numStages > 0) { 14335c6c1daeSBarry Smith stageInfo = stageLog->stageInfo; 14345c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 14355c6c1daeSBarry Smith if (stage < stageLog->numStages) { 14365c6c1daeSBarry Smith localStageUsed[stage] = stageInfo[stage].used; 14375c6c1daeSBarry Smith localStageVisible[stage] = stageInfo[stage].perfInfo.visible; 14385c6c1daeSBarry Smith } else { 14395c6c1daeSBarry Smith localStageUsed[stage] = PETSC_FALSE; 14405c6c1daeSBarry Smith localStageVisible[stage] = PETSC_TRUE; 14415c6c1daeSBarry Smith } 14425c6c1daeSBarry Smith } 1443c3aae356SJed Brown ierr = MPI_Allreduce(localStageUsed, stageUsed, numStages, MPIU_BOOL, MPI_LOR, comm);CHKERRQ(ierr); 1444c3aae356SJed Brown ierr = MPI_Allreduce(localStageVisible, stageVisible, numStages, MPIU_BOOL, MPI_LAND, comm);CHKERRQ(ierr); 14455c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 14465c6c1daeSBarry Smith if (stageUsed[stage]) { 14475c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\nSummary of Stages: ----- Time ------ ----- Flops ----- --- Messages --- -- Message Lengths -- -- Reductions --\n");CHKERRQ(ierr); 14485c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Avg %%Total Avg %%Total counts %%Total Avg %%Total counts %%Total \n");CHKERRQ(ierr); 14495c6c1daeSBarry Smith break; 14505c6c1daeSBarry Smith } 14515c6c1daeSBarry Smith } 14525c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 14535c6c1daeSBarry Smith if (!stageUsed[stage]) continue; 14545c6c1daeSBarry Smith if (localStageUsed[stage]) { 14555c6c1daeSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 14565c6c1daeSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 14575c6c1daeSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 14585c6c1daeSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 14595c6c1daeSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 14605c6c1daeSBarry Smith name = stageInfo[stage].name; 14615c6c1daeSBarry Smith } else { 14625c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 14635c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 14645c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 14655c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 14665c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 14675c6c1daeSBarry Smith name = ""; 14685c6c1daeSBarry Smith } 14695c6c1daeSBarry Smith mess *= 0.5; messLen *= 0.5; red /= size; 14705c6c1daeSBarry Smith if (TotalTime != 0.0) fracTime = stageTime/TotalTime; else fracTime = 0.0; 14715c6c1daeSBarry Smith if (TotalFlops != 0.0) fracFlops = flops/TotalFlops; else fracFlops = 0.0; 14725c6c1daeSBarry Smith /* Talk to Barry if (stageTime != 0.0) flops = (size*flops)/stageTime; else flops = 0.0; */ 14735c6c1daeSBarry Smith if (numMessages != 0.0) fracMessages = mess/numMessages; else fracMessages = 0.0; 14745c6c1daeSBarry Smith if (numMessages != 0.0) avgMessLen = messLen/numMessages; else avgMessLen = 0.0; 14755c6c1daeSBarry Smith if (messageLength != 0.0) fracLength = messLen/messageLength; else fracLength = 0.0; 14765c6c1daeSBarry Smith if (numReductions != 0.0) fracReductions = red/numReductions; else fracReductions = 0.0; 14775c6c1daeSBarry 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", 14785c6c1daeSBarry Smith stage, name, stageTime/size, 100.0*fracTime, flops, 100.0*fracFlops, 14795c6c1daeSBarry Smith mess, 100.0*fracMessages, avgMessLen, 100.0*fracLength, red, 100.0*fracReductions);CHKERRQ(ierr); 14805c6c1daeSBarry Smith } 14815c6c1daeSBarry Smith } 14825c6c1daeSBarry Smith 1483806fa848SBarry Smith ierr = PetscFPrintf(comm, fd,"\n------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 14845c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "See the 'Profiling' chapter of the users' manual for details on interpreting output.\n");CHKERRQ(ierr); 14855c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Phase summary info:\n");CHKERRQ(ierr); 14865c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Count: number of times phase was executed\n");CHKERRQ(ierr); 14875c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Time and Flops: Max - maximum over all processors\n");CHKERRQ(ierr); 14885c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Ratio - ratio of maximum to minimum over all processors\n");CHKERRQ(ierr); 14895c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Mess: number of messages sent\n");CHKERRQ(ierr); 1490dac490bdSJed Brown ierr = PetscFPrintf(comm, fd, " Avg. len: average message length (bytes)\n");CHKERRQ(ierr); 14915c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Reduct: number of global reductions\n");CHKERRQ(ierr); 14925c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Global: entire computation\n");CHKERRQ(ierr); 14935c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Stage: stages of a computation. Set stages with PetscLogStagePush() and PetscLogStagePop().\n");CHKERRQ(ierr); 14945c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " %%T - percent time in this phase %%F - percent flops in this phase\n");CHKERRQ(ierr); 14955c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " %%M - percent messages in this phase %%L - percent message lengths in this phase\n");CHKERRQ(ierr); 14965c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " %%R - percent reductions in this phase\n");CHKERRQ(ierr); 14975c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " Total Mflop/s: 10e-6 * (sum of flops over all processors)/(max time over all processors)\n");CHKERRQ(ierr); 1498806fa848SBarry Smith ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 14995c6c1daeSBarry Smith 15005c6c1daeSBarry Smith #if defined(PETSC_USE_DEBUG) 15015c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 15025c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 15035c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 15045c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 15055c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 15065c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # This code was compiled with a debugging option, #\n");CHKERRQ(ierr); 15075c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # To get timing results run ./configure #\n");CHKERRQ(ierr); 15085c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # using --with-debugging=no, the performance will #\n");CHKERRQ(ierr); 15095c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # be generally two or three times faster. #\n");CHKERRQ(ierr); 15105c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 15115c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 15125c6c1daeSBarry Smith #endif 15135c6c1daeSBarry Smith #if defined(PETSC_USE_COMPLEX) && !defined(PETSC_USE_FORTRAN_KERNELS) 15145c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n\n");CHKERRQ(ierr); 15155c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " ##########################################################\n");CHKERRQ(ierr); 15165c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 15175c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # WARNING!!! #\n");CHKERRQ(ierr); 15185c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 15195c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # The code for various complex numbers numerical #\n");CHKERRQ(ierr); 15205c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # kernels uses C++, which generally is not well #\n");CHKERRQ(ierr); 15215c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # optimized. For performance that is about 4-5 times #\n");CHKERRQ(ierr); 15225c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # faster, specify --with-fortran-kernels=1 #\n");CHKERRQ(ierr); 15235c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # when running ./configure.py. #\n");CHKERRQ(ierr); 15245c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " # #\n");CHKERRQ(ierr); 15255c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, " ##########################################################\n\n\n");CHKERRQ(ierr); 15265c6c1daeSBarry Smith #endif 15275c6c1daeSBarry Smith 15285c6c1daeSBarry Smith /* Report events */ 1529806fa848SBarry Smith ierr = PetscFPrintf(comm, fd,"Event Count Time (sec) Flops --- Global --- --- Stage --- Total\n");CHKERRQ(ierr); 1530806fa848SBarry Smith ierr = PetscFPrintf(comm, fd," Max Ratio Max Ratio Max Ratio Mess Avg len Reduct %%T %%F %%M %%L %%R %%T %%F %%M %%L %%R Mflop/s\n");CHKERRQ(ierr); 1531806fa848SBarry Smith ierr = PetscFPrintf(comm,fd,"------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 15325c6c1daeSBarry Smith 15335c6c1daeSBarry Smith /* Problem: The stage name will not show up unless the stage executed on proc 1 */ 15345c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 15355c6c1daeSBarry Smith if (!stageVisible[stage]) continue; 15365c6c1daeSBarry Smith if (localStageUsed[stage]) { 15375c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 15385c6c1daeSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.time, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15395c6c1daeSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.flops, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15405c6c1daeSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numMessages, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15415c6c1daeSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.messageLength, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15425c6c1daeSBarry Smith ierr = MPI_Allreduce(&stageInfo[stage].perfInfo.numReductions, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15435c6c1daeSBarry Smith } else { 15445c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 15455c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &stageTime, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15465c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &flops, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15475c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &mess, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15485c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &messLen, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15495c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &red, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15505c6c1daeSBarry Smith } 15515c6c1daeSBarry Smith mess *= 0.5; messLen *= 0.5; red /= size; 15525c6c1daeSBarry Smith 15535c6c1daeSBarry Smith /* Get total number of events in this stage -- 15545c6c1daeSBarry Smith Currently, a single processor can register more events than another, but events must all be registered in order, 15555c6c1daeSBarry Smith just like stages. We can removed this requirement if necessary by having a global event numbering and indirection 15565c6c1daeSBarry Smith on the event ID. This seems best accomplished by assoicating a communicator with each stage. 15575c6c1daeSBarry Smith 15585c6c1daeSBarry Smith Problem: If the event did not happen on proc 1, its name will not be available. 15595c6c1daeSBarry Smith Problem: Event visibility is not implemented 15605c6c1daeSBarry Smith */ 15615c6c1daeSBarry Smith if (localStageUsed[stage]) { 15625c6c1daeSBarry Smith eventInfo = stageLog->stageInfo[stage].eventLog->eventInfo; 15635c6c1daeSBarry Smith localNumEvents = stageLog->stageInfo[stage].eventLog->numEvents; 1564a297a907SKarl Rupp } else localNumEvents = 0; 15655c6c1daeSBarry Smith ierr = MPI_Allreduce(&localNumEvents, &numEvents, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 15665c6c1daeSBarry Smith for (event = 0; event < numEvents; event++) { 15675c6c1daeSBarry Smith if (localStageUsed[stage] && (event < stageLog->stageInfo[stage].eventLog->numEvents) && (eventInfo[event].depth == 0)) { 1568a297a907SKarl Rupp if ((eventInfo[event].count > 0) && (eventInfo[event].time > 0.0)) flopr = eventInfo[event].flops; 1569a297a907SKarl Rupp else flopr = 0.0; 1570a297a907SKarl Rupp 15715c6c1daeSBarry Smith ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 15725c6c1daeSBarry Smith ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 15735c6c1daeSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].flops, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15745c6c1daeSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].time, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 15755c6c1daeSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].time, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 15765c6c1daeSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].time, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15775c6c1daeSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].numMessages, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15785c6c1daeSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].messageLength, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15795c6c1daeSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].numReductions, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15805c6c1daeSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].count, &minCt, 1, MPI_INT, MPI_MIN, comm);CHKERRQ(ierr); 15815c6c1daeSBarry Smith ierr = MPI_Allreduce(&eventInfo[event].count, &maxCt, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 15825c6c1daeSBarry Smith name = stageLog->eventLog->eventInfo[event].name; 15835c6c1daeSBarry Smith } else { 15845c6c1daeSBarry Smith flopr = 0.0; 15855c6c1daeSBarry Smith ierr = MPI_Allreduce(&flopr, &minf, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 15865c6c1daeSBarry Smith ierr = MPI_Allreduce(&flopr, &maxf, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 15875c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &totf, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15885c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &mint, 1, MPIU_PETSCLOGDOUBLE, MPI_MIN, comm);CHKERRQ(ierr); 15895c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &maxt, 1, MPIU_PETSCLOGDOUBLE, MPI_MAX, comm);CHKERRQ(ierr); 15905c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &tott, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15915c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &totm, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15925c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &totml, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15935c6c1daeSBarry Smith ierr = MPI_Allreduce(&zero, &totr, 1, MPIU_PETSCLOGDOUBLE, MPI_SUM, comm);CHKERRQ(ierr); 15945c6c1daeSBarry Smith ierr = MPI_Allreduce(&ierr, &minCt, 1, MPI_INT, MPI_MIN, comm);CHKERRQ(ierr); 15955c6c1daeSBarry Smith ierr = MPI_Allreduce(&ierr, &maxCt, 1, MPI_INT, MPI_MAX, comm);CHKERRQ(ierr); 15965c6c1daeSBarry Smith name = ""; 15975c6c1daeSBarry Smith } 15985c6c1daeSBarry Smith if (mint < 0.0) { 15995c6c1daeSBarry 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); 16005c6c1daeSBarry Smith mint = 0; 16015c6c1daeSBarry Smith } 16025c6c1daeSBarry Smith if (minf < 0.0) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Minimum flops %g over all processors for %s is negative! Not possible!",minf,name); 16035c6c1daeSBarry Smith totm *= 0.5; totml *= 0.5; totr /= size; 16045c6c1daeSBarry Smith 16055c6c1daeSBarry Smith if (maxCt != 0) { 16065c6c1daeSBarry Smith if (minCt != 0) ratCt = ((PetscLogDouble) maxCt)/minCt; else ratCt = 0.0; 16075c6c1daeSBarry Smith if (mint != 0.0) ratt = maxt/mint; else ratt = 0.0; 16085c6c1daeSBarry Smith if (minf != 0.0) ratf = maxf/minf; else ratf = 0.0; 16095c6c1daeSBarry Smith if (TotalTime != 0.0) fracTime = tott/TotalTime; else fracTime = 0.0; 16105c6c1daeSBarry Smith if (TotalFlops != 0.0) fracFlops = totf/TotalFlops; else fracFlops = 0.0; 16115c6c1daeSBarry Smith if (stageTime != 0.0) fracStageTime = tott/stageTime; else fracStageTime = 0.0; 16125c6c1daeSBarry Smith if (flops != 0.0) fracStageFlops = totf/flops; else fracStageFlops = 0.0; 16135c6c1daeSBarry Smith if (numMessages != 0.0) fracMess = totm/numMessages; else fracMess = 0.0; 16145c6c1daeSBarry Smith if (messageLength != 0.0) fracMessLen = totml/messageLength; else fracMessLen = 0.0; 16155c6c1daeSBarry Smith if (numReductions != 0.0) fracRed = totr/numReductions; else fracRed = 0.0; 16165c6c1daeSBarry Smith if (mess != 0.0) fracStageMess = totm/mess; else fracStageMess = 0.0; 16175c6c1daeSBarry Smith if (messLen != 0.0) fracStageMessLen = totml/messLen; else fracStageMessLen = 0.0; 16185c6c1daeSBarry Smith if (red != 0.0) fracStageRed = totr/red; else fracStageRed = 0.0; 16195c6c1daeSBarry Smith if (totm != 0.0) totml /= totm; else totml = 0.0; 16205c6c1daeSBarry Smith if (maxt != 0.0) flopr = totf/maxt; else flopr = 0.0; 1621aefdf039SBarry Smith if (fracStageTime > 1.00) ierr = PetscFPrintf(comm, fd,"Warning -- total time of even greater than time of entire stage -- something is wrong with the timer\n");CHKERRQ(ierr); 16225c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, 16235c6c1daeSBarry 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\n", 16245c6c1daeSBarry Smith name, maxCt, ratCt, maxt, ratt, maxf, ratf, totm, totml, totr, 16255c6c1daeSBarry Smith 100.0*fracTime, 100.0*fracFlops, 100.0*fracMess, 100.0*fracMessLen, 100.0*fracRed, 16265c6c1daeSBarry Smith 100.0*fracStageTime, 100.0*fracStageFlops, 100.0*fracStageMess, 100.0*fracStageMessLen, 100.0*fracStageRed, 16275c6c1daeSBarry Smith PetscAbsReal(flopr/1.0e6));CHKERRQ(ierr); 16285c6c1daeSBarry Smith } 16295c6c1daeSBarry Smith } 16305c6c1daeSBarry Smith } 16315c6c1daeSBarry Smith 16325c6c1daeSBarry Smith /* Memory usage and object creation */ 1633a297a907SKarl Rupp ierr = PetscFPrintf(comm, fd, "------------------------------------------------------------------------------------------------------------------------\n");CHKERRQ(ierr); 16345c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 16355c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Memory usage is given in bytes:\n\n");CHKERRQ(ierr); 16365c6c1daeSBarry Smith 16375c6c1daeSBarry Smith /* Right now, only stages on the first processor are reported here, meaning only objects associated with 16385c6c1daeSBarry Smith the global communicator, or MPI_COMM_SELF for proc 1. We really should report global stats and then 16395c6c1daeSBarry Smith stats for stages local to processor sets. 16405c6c1daeSBarry Smith */ 16415c6c1daeSBarry Smith /* We should figure out the longest object name here (now 20 characters) */ 16425c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Object Type Creations Destructions Memory Descendants' Mem.\n");CHKERRQ(ierr); 16435c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Reports information only for process 0.\n");CHKERRQ(ierr); 16445c6c1daeSBarry Smith for (stage = 0; stage < numStages; stage++) { 16455c6c1daeSBarry Smith if (localStageUsed[stage]) { 16465c6c1daeSBarry Smith classInfo = stageLog->stageInfo[stage].classLog->classInfo; 16475c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: %s\n\n", stage, stageInfo[stage].name);CHKERRQ(ierr); 16485c6c1daeSBarry Smith for (oclass = 0; oclass < stageLog->stageInfo[stage].classLog->numClasses; oclass++) { 16495c6c1daeSBarry Smith if ((classInfo[oclass].creations > 0) || (classInfo[oclass].destructions > 0)) { 16505c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%20s %5d %5d %11.0f %g\n", stageLog->classLog->classInfo[oclass].name, 16515c6c1daeSBarry Smith classInfo[oclass].creations, classInfo[oclass].destructions, classInfo[oclass].mem, 16525c6c1daeSBarry Smith classInfo[oclass].descMem);CHKERRQ(ierr); 16535c6c1daeSBarry Smith } 16545c6c1daeSBarry Smith } 16555c6c1daeSBarry Smith } else { 16565c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n--- Event Stage %d: Unknown\n\n", stage);CHKERRQ(ierr); 16575c6c1daeSBarry Smith } 16585c6c1daeSBarry Smith } 16595c6c1daeSBarry Smith 16605c6c1daeSBarry Smith ierr = PetscFree(localStageUsed);CHKERRQ(ierr); 16615c6c1daeSBarry Smith ierr = PetscFree(stageUsed);CHKERRQ(ierr); 16625c6c1daeSBarry Smith ierr = PetscFree(localStageVisible);CHKERRQ(ierr); 16635c6c1daeSBarry Smith ierr = PetscFree(stageVisible);CHKERRQ(ierr); 16645c6c1daeSBarry Smith 16655c6c1daeSBarry Smith /* Information unrelated to this particular run */ 1666a297a907SKarl Rupp ierr = PetscFPrintf(comm, fd, "========================================================================================================================\n");CHKERRQ(ierr); 16678563dfccSBarry Smith PetscTime(&y); 16688563dfccSBarry Smith PetscTime(&x); 16698563dfccSBarry Smith PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 16708563dfccSBarry Smith PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); PetscTime(&y); 16715c6c1daeSBarry Smith ierr = PetscFPrintf(comm,fd,"Average time to get PetscTime(): %g\n", (y-x)/10.0);CHKERRQ(ierr); 16725c6c1daeSBarry Smith /* MPI information */ 16735c6c1daeSBarry Smith if (size > 1) { 16745c6c1daeSBarry Smith MPI_Status status; 16755c6c1daeSBarry Smith PetscMPIInt tag; 16765c6c1daeSBarry Smith MPI_Comm newcomm; 16775c6c1daeSBarry Smith 16785c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 16798563dfccSBarry Smith PetscTime(&x); 16805c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 16815c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 16825c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 16835c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 16845c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 16858563dfccSBarry Smith PetscTime(&y); 16865c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Average time for MPI_Barrier(): %g\n", (y-x)/5.0);CHKERRQ(ierr); 16875c6c1daeSBarry Smith ierr = PetscCommDuplicate(comm,&newcomm, &tag);CHKERRQ(ierr); 16885c6c1daeSBarry Smith ierr = MPI_Barrier(comm);CHKERRQ(ierr); 16895c6c1daeSBarry Smith if (rank) { 16905c6c1daeSBarry Smith ierr = MPI_Recv(0, 0, MPI_INT, rank-1, tag, newcomm, &status);CHKERRQ(ierr); 16915c6c1daeSBarry Smith ierr = MPI_Send(0, 0, MPI_INT, (rank+1)%size, tag, newcomm);CHKERRQ(ierr); 16925c6c1daeSBarry Smith } else { 16938563dfccSBarry Smith PetscTime(&x); 16945c6c1daeSBarry Smith ierr = MPI_Send(0, 0, MPI_INT, 1, tag, newcomm);CHKERRQ(ierr); 16955c6c1daeSBarry Smith ierr = MPI_Recv(0, 0, MPI_INT, size-1, tag, newcomm, &status);CHKERRQ(ierr); 16968563dfccSBarry Smith PetscTime(&y); 16975c6c1daeSBarry Smith ierr = PetscFPrintf(comm,fd,"Average time for zero size MPI_Send(): %g\n", (y-x)/size);CHKERRQ(ierr); 16985c6c1daeSBarry Smith } 16995c6c1daeSBarry Smith ierr = PetscCommDestroy(&newcomm);CHKERRQ(ierr); 17005c6c1daeSBarry Smith } 17015c6c1daeSBarry Smith ierr = PetscOptionsView(viewer);CHKERRQ(ierr); 17025c6c1daeSBarry Smith 17035c6c1daeSBarry Smith /* Machine and compile information */ 17045c6c1daeSBarry Smith #if defined(PETSC_USE_FORTRAN_KERNELS) 17055c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with FORTRAN kernels\n");CHKERRQ(ierr); 17065c6c1daeSBarry Smith #else 17075c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled without FORTRAN kernels\n");CHKERRQ(ierr); 17085c6c1daeSBarry Smith #endif 17095c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_SINGLE) 17105c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with single precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 17115c6c1daeSBarry Smith #elif defined(PETSC_USE_LONGDOUBLE) 17125c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with long double precision PetscScalar and PetscReal\n");CHKERRQ(ierr); 17135c6c1daeSBarry Smith #endif 17145c6c1daeSBarry Smith 17155c6c1daeSBarry Smith #if defined(PETSC_USE_REAL_MAT_SINGLE) 17165c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with single precision matrices\n");CHKERRQ(ierr); 17175c6c1daeSBarry Smith #else 17185c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Compiled with full precision matrices (default)\n");CHKERRQ(ierr); 17195c6c1daeSBarry Smith #endif 17205c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "sizeof(short) %d sizeof(int) %d sizeof(long) %d sizeof(void*) %d sizeof(PetscScalar) %d sizeof(PetscInt) %d\n", 17215c6c1daeSBarry Smith (int) sizeof(short), (int) sizeof(int), (int) sizeof(long), (int) sizeof(void*),(int) sizeof(PetscScalar),(int) sizeof(PetscInt));CHKERRQ(ierr); 17225c6c1daeSBarry Smith 17235c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "Configure options: %s",petscconfigureoptions);CHKERRQ(ierr); 17245c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petscmachineinfo);CHKERRQ(ierr); 17255c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsccompilerinfo);CHKERRQ(ierr); 17265c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsccompilerflagsinfo);CHKERRQ(ierr); 17275c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "%s", petsclinkerinfo);CHKERRQ(ierr); 17285c6c1daeSBarry Smith 17295c6c1daeSBarry Smith /* Cleanup */ 17305c6c1daeSBarry Smith ierr = PetscFPrintf(comm, fd, "\n");CHKERRQ(ierr); 17315c6c1daeSBarry Smith PetscFunctionReturn(0); 17325c6c1daeSBarry Smith } 17335c6c1daeSBarry Smith 1734*bb1d7374SBarry Smith PetscErrorCode PetscLogView_Nested(PetscViewer); 1735*bb1d7374SBarry Smith 17365c6c1daeSBarry Smith #undef __FUNCT__ 1737f14045dbSBarry Smith #define __FUNCT__ "PetscLogView" 17387d6c928cSSatish Balay /*@C 17397d6c928cSSatish Balay PetscLogView - Prints a summary of the logging. 17405c6c1daeSBarry Smith 17415c6c1daeSBarry Smith Collective over MPI_Comm 17425c6c1daeSBarry Smith 17435c6c1daeSBarry Smith Input Parameter: 1744f14045dbSBarry Smith . viewer - an ASCII viewer 17455c6c1daeSBarry Smith 17465c6c1daeSBarry Smith Options Database Keys: 1747*bb1d7374SBarry Smith + -log_view [:filename] - Prints summary of log information 1748*bb1d7374SBarry Smith . -log_view :filename.py:ascii_info_detail - Saves logging information from each process as a Python file 1749*bb1d7374SBarry Smith . -log_view :filename.xml:ascii_xml - Saves a summary of the logging information in a nested format, use a browser to open this file, for example on 1750*bb1d7374SBarry Smith Apple MacOS systems use open -a Safari filename.xml 1751*bb1d7374SBarry Smith . -log_all - Saves a file Log.rank for each MPI process with details of each step of the computation 1752*bb1d7374SBarry Smith - -log_trace [filename] - Displays a trace of what each process is doing 17535c6c1daeSBarry Smith 17545c6c1daeSBarry Smith Notes: 1755*bb1d7374SBarry Smith It is possible to control the logging programatically but we recommend using the options database approach whenever possible 17565c6c1daeSBarry Smith By default the summary is printed to stdout. 17575c6c1daeSBarry Smith 1758*bb1d7374SBarry Smith Before calling this routine you must have called either PetscLogDefaultBegin() or PetscLogNestedBegin() 1759*bb1d7374SBarry Smith 1760*bb1d7374SBarry Smith If PETSc is configured with --with-logging=0 then this functionality is not available 1761*bb1d7374SBarry Smith 1762*bb1d7374SBarry Smith The nested XML format was kindly donated by Koos Huijssen and Christiaan M. Klaij MARITIME RESEARCH INSTITUTE NETHERLANDS 1763*bb1d7374SBarry Smith 17645c6c1daeSBarry Smith Level: beginner 17655c6c1daeSBarry Smith 17665c6c1daeSBarry Smith .keywords: log, dump, print 1767*bb1d7374SBarry Smith .seealso: PetscLogDefaultBegin(), PetscLogDump() 17685c6c1daeSBarry Smith @*/ 1769f14045dbSBarry Smith PetscErrorCode PetscLogView(PetscViewer viewer) 17705c6c1daeSBarry Smith { 17715c6c1daeSBarry Smith PetscErrorCode ierr; 1772f14045dbSBarry Smith PetscBool isascii; 1773f14045dbSBarry Smith PetscViewerFormat format; 177437b78d16SBarry Smith int stage, lastStage; 177537b78d16SBarry Smith PetscStageLog stageLog; 17765c6c1daeSBarry Smith 17775c6c1daeSBarry Smith PetscFunctionBegin; 1778*bb1d7374SBarry Smith if (!PetscLogPLB) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Must use -log_summary or PetscLogDefaultBegin() before calling this routine"); 177937b78d16SBarry Smith /* Pop off any stages the user forgot to remove */ 178037b78d16SBarry Smith lastStage = 0; 178137b78d16SBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 178237b78d16SBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 178337b78d16SBarry Smith while (stage >= 0) { 178437b78d16SBarry Smith lastStage = stage; 178537b78d16SBarry Smith ierr = PetscStageLogPop(stageLog);CHKERRQ(ierr); 178637b78d16SBarry Smith ierr = PetscStageLogGetCurrent(stageLog, &stage);CHKERRQ(ierr); 178737b78d16SBarry Smith } 1788f14045dbSBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&isascii);CHKERRQ(ierr); 1789f14045dbSBarry Smith if (!isascii) SETERRQ(PetscObjectComm((PetscObject)viewer),PETSC_ERR_SUP,"Currently can only view logging to ASCII"); 1790f14045dbSBarry Smith ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr); 1791f14045dbSBarry Smith if (format == PETSC_VIEWER_DEFAULT || format == PETSC_VIEWER_ASCII_INFO) { 1792f14045dbSBarry Smith ierr = PetscLogView_Default(viewer);CHKERRQ(ierr); 1793f14045dbSBarry Smith } else if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) { 1794f14045dbSBarry Smith ierr = PetscLogView_Detailed(viewer);CHKERRQ(ierr); 1795*bb1d7374SBarry Smith } else if (format == PETSC_VIEWER_ASCII_XML) { 1796*bb1d7374SBarry Smith ierr = PetscLogView_Nested(viewer);CHKERRQ(ierr); 17975c6c1daeSBarry Smith } 179837b78d16SBarry Smith ierr = PetscStageLogPush(stageLog, lastStage);CHKERRQ(ierr); 17995c6c1daeSBarry Smith PetscFunctionReturn(0); 18005c6c1daeSBarry Smith } 18015c6c1daeSBarry Smith 1802f14045dbSBarry Smith #undef __FUNCT__ 1803f14045dbSBarry Smith #define __FUNCT__ "PetscLogViewFromOptions" 1804f14045dbSBarry Smith /*@C 1805f14045dbSBarry Smith PetscLogViewFromOptions - Processes command line options to determine if/how a PetscLog is to be viewed. 1806f14045dbSBarry Smith 1807f14045dbSBarry Smith Collective on PETSC_COMM_WORLD 1808f14045dbSBarry Smith 1809f14045dbSBarry Smith Not normally called by user 1810f14045dbSBarry Smith 1811f14045dbSBarry Smith Level: intermediate 1812f14045dbSBarry Smith 1813f14045dbSBarry Smith @*/ 1814f14045dbSBarry Smith PetscErrorCode PetscLogViewFromOptions(void) 1815f14045dbSBarry Smith { 1816f14045dbSBarry Smith PetscErrorCode ierr; 1817f14045dbSBarry Smith PetscViewer viewer; 1818f14045dbSBarry Smith PetscBool flg; 1819f14045dbSBarry Smith PetscViewerFormat format; 1820f14045dbSBarry Smith 1821f14045dbSBarry Smith PetscFunctionBegin; 1822f14045dbSBarry Smith ierr = PetscOptionsGetViewer(PETSC_COMM_WORLD,NULL,"-log_view",&viewer,&format,&flg);CHKERRQ(ierr); 1823f14045dbSBarry Smith if (flg) { 1824f14045dbSBarry Smith ierr = PetscViewerPushFormat(viewer,format);CHKERRQ(ierr); 1825f14045dbSBarry Smith ierr = PetscLogView(viewer);CHKERRQ(ierr); 1826f14045dbSBarry Smith ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr); 1827f14045dbSBarry Smith ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr); 1828f14045dbSBarry Smith } 1829f14045dbSBarry Smith PetscFunctionReturn(0); 1830f14045dbSBarry Smith } 1831f14045dbSBarry Smith 1832f14045dbSBarry Smith 1833f14045dbSBarry Smith 18345c6c1daeSBarry Smith /*----------------------------------------------- Counter Functions -------------------------------------------------*/ 18355c6c1daeSBarry Smith #undef __FUNCT__ 18365c6c1daeSBarry Smith #define __FUNCT__ "PetscGetFlops" 18375c6c1daeSBarry Smith /*@C 18385c6c1daeSBarry Smith PetscGetFlops - Returns the number of flops used on this processor 18395c6c1daeSBarry Smith since the program began. 18405c6c1daeSBarry Smith 18415c6c1daeSBarry Smith Not Collective 18425c6c1daeSBarry Smith 18435c6c1daeSBarry Smith Output Parameter: 18445c6c1daeSBarry Smith flops - number of floating point operations 18455c6c1daeSBarry Smith 18465c6c1daeSBarry Smith Notes: 18475c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 18485c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 18495c6c1daeSBarry Smith application code. 18505c6c1daeSBarry Smith 18515c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 18525c6c1daeSBarry Smith compiled with -DPETSC_USE_LOG (which is the default), and -log, 18535c6c1daeSBarry Smith -log_summary, or -log_all are specified. PetscLogFlops() is 18545c6c1daeSBarry Smith intended for logging user flops to supplement this PETSc 18555c6c1daeSBarry Smith information. 18565c6c1daeSBarry Smith 18575c6c1daeSBarry Smith Level: intermediate 18585c6c1daeSBarry Smith 18595c6c1daeSBarry Smith .keywords: log, flops, floating point operations 18605c6c1daeSBarry Smith 18618563dfccSBarry Smith .seealso: PetscTime(), PetscLogFlops() 18625c6c1daeSBarry Smith @*/ 18635c6c1daeSBarry Smith PetscErrorCode PetscGetFlops(PetscLogDouble *flops) 18645c6c1daeSBarry Smith { 18655c6c1daeSBarry Smith PetscFunctionBegin; 18665c6c1daeSBarry Smith *flops = petsc_TotalFlops; 18675c6c1daeSBarry Smith PetscFunctionReturn(0); 18685c6c1daeSBarry Smith } 18695c6c1daeSBarry Smith 18705c6c1daeSBarry Smith #undef __FUNCT__ 18715c6c1daeSBarry Smith #define __FUNCT__ "PetscLogObjectState" 18725c6c1daeSBarry Smith PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 18735c6c1daeSBarry Smith { 18745c6c1daeSBarry Smith PetscErrorCode ierr; 18755c6c1daeSBarry Smith size_t fullLength; 18765c6c1daeSBarry Smith va_list Argp; 18775c6c1daeSBarry Smith 18785c6c1daeSBarry Smith PetscFunctionBegin; 18795c6c1daeSBarry Smith if (!petsc_logObjects) PetscFunctionReturn(0); 18805c6c1daeSBarry Smith va_start(Argp, format); 18815c6c1daeSBarry Smith ierr = PetscVSNPrintf(petsc_objects[obj->id].info, 64,format,&fullLength, Argp);CHKERRQ(ierr); 18825c6c1daeSBarry Smith va_end(Argp); 18835c6c1daeSBarry Smith PetscFunctionReturn(0); 18845c6c1daeSBarry Smith } 18855c6c1daeSBarry Smith 18865c6c1daeSBarry Smith 18875c6c1daeSBarry Smith /*MC 18885c6c1daeSBarry Smith PetscLogFlops - Adds floating point operations to the global counter. 18895c6c1daeSBarry Smith 18905c6c1daeSBarry Smith Synopsis: 1891aaa7dc30SBarry Smith #include <petsclog.h> 18925c6c1daeSBarry Smith PetscErrorCode PetscLogFlops(PetscLogDouble f) 18935c6c1daeSBarry Smith 18945c6c1daeSBarry Smith Not Collective 18955c6c1daeSBarry Smith 18965c6c1daeSBarry Smith Input Parameter: 18975c6c1daeSBarry Smith . f - flop counter 18985c6c1daeSBarry Smith 18995c6c1daeSBarry Smith 19005c6c1daeSBarry Smith Usage: 19015c6c1daeSBarry Smith .vb 19025c6c1daeSBarry Smith PetscLogEvent USER_EVENT; 19035c6c1daeSBarry Smith PetscLogEventRegister("User event",0,&USER_EVENT); 19045c6c1daeSBarry Smith PetscLogEventBegin(USER_EVENT,0,0,0,0); 19055c6c1daeSBarry Smith [code segment to monitor] 19065c6c1daeSBarry Smith PetscLogFlops(user_flops) 19075c6c1daeSBarry Smith PetscLogEventEnd(USER_EVENT,0,0,0,0); 19085c6c1daeSBarry Smith .ve 19095c6c1daeSBarry Smith 19105c6c1daeSBarry Smith Notes: 19115c6c1daeSBarry Smith A global counter logs all PETSc flop counts. The user can use 19125c6c1daeSBarry Smith PetscLogFlops() to increment this counter to include flops for the 19135c6c1daeSBarry Smith application code. 19145c6c1daeSBarry Smith 19155c6c1daeSBarry Smith PETSc automatically logs library events if the code has been 19165c6c1daeSBarry Smith compiled with -DPETSC_USE_LOG (which is the default), and -log, 19175c6c1daeSBarry Smith -log_summary, or -log_all are specified. PetscLogFlops() is 19185c6c1daeSBarry Smith intended for logging user flops to supplement this PETSc 19195c6c1daeSBarry Smith information. 19205c6c1daeSBarry Smith 19215c6c1daeSBarry Smith Level: intermediate 19225c6c1daeSBarry Smith 19235c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscGetFlops() 19245c6c1daeSBarry Smith 19255c6c1daeSBarry Smith .keywords: log, flops, floating point operations 19265c6c1daeSBarry Smith M*/ 19275c6c1daeSBarry Smith 19285c6c1daeSBarry Smith /*MC 19295c6c1daeSBarry Smith PetscPreLoadBegin - Begin a segment of code that may be preloaded (run twice) 19305c6c1daeSBarry Smith to get accurate timings 19315c6c1daeSBarry Smith 19325c6c1daeSBarry Smith Synopsis: 1933aaa7dc30SBarry Smith #include <petsclog.h> 19345c6c1daeSBarry Smith void PetscPreLoadBegin(PetscBool flag,char *name); 19355c6c1daeSBarry Smith 19365c6c1daeSBarry Smith Not Collective 19375c6c1daeSBarry Smith 19385c6c1daeSBarry Smith Input Parameter: 19395c6c1daeSBarry Smith + flag - PETSC_TRUE to run twice, PETSC_FALSE to run once, may be overridden 19405c6c1daeSBarry Smith with command line option -preload true or -preload false 19415c6c1daeSBarry Smith - name - name of first stage (lines of code timed separately with -log_summary) to 19425c6c1daeSBarry Smith be preloaded 19435c6c1daeSBarry Smith 19445c6c1daeSBarry Smith Usage: 19455c6c1daeSBarry Smith .vb 19465c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 19475c6c1daeSBarry Smith lines of code 19485c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 19495c6c1daeSBarry Smith lines of code 19505c6c1daeSBarry Smith PetscPreLoadEnd(); 19515c6c1daeSBarry Smith .ve 19525c6c1daeSBarry Smith 19535c6c1daeSBarry Smith Notes: Only works in C/C++, not Fortran 19545c6c1daeSBarry Smith 19555c6c1daeSBarry Smith Flags available within the macro. 19565c6c1daeSBarry Smith + PetscPreLoadingUsed - true if we are or have done preloading 19575c6c1daeSBarry Smith . PetscPreLoadingOn - true if it is CURRENTLY doing preload 19585c6c1daeSBarry Smith . PetscPreLoadIt - 0 for the first computation (with preloading turned off it is only 0) 1 for the second 19595c6c1daeSBarry Smith - PetscPreLoadMax - number of times it will do the computation, only one when preloading is turned on 19605c6c1daeSBarry Smith The first two variables are available throughout the program, the second two only between the PetscPreLoadBegin() 19615c6c1daeSBarry Smith and PetscPreLoadEnd() 19625c6c1daeSBarry Smith 19635c6c1daeSBarry Smith Level: intermediate 19645c6c1daeSBarry Smith 19655c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadEnd(), PetscPreLoadStage() 19665c6c1daeSBarry Smith 19675c6c1daeSBarry Smith Concepts: preloading 19685c6c1daeSBarry Smith Concepts: timing^accurate 19695c6c1daeSBarry Smith Concepts: paging^eliminating effects of 19705c6c1daeSBarry Smith 19715c6c1daeSBarry Smith 19725c6c1daeSBarry Smith M*/ 19735c6c1daeSBarry Smith 19745c6c1daeSBarry Smith /*MC 19755c6c1daeSBarry Smith PetscPreLoadEnd - End a segment of code that may be preloaded (run twice) 19765c6c1daeSBarry Smith to get accurate timings 19775c6c1daeSBarry Smith 19785c6c1daeSBarry Smith Synopsis: 1979aaa7dc30SBarry Smith #include <petsclog.h> 19805c6c1daeSBarry Smith void PetscPreLoadEnd(void); 19815c6c1daeSBarry Smith 19825c6c1daeSBarry Smith Not Collective 19835c6c1daeSBarry Smith 19845c6c1daeSBarry Smith Usage: 19855c6c1daeSBarry Smith .vb 19865c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 19875c6c1daeSBarry Smith lines of code 19885c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 19895c6c1daeSBarry Smith lines of code 19905c6c1daeSBarry Smith PetscPreLoadEnd(); 19915c6c1daeSBarry Smith .ve 19925c6c1daeSBarry Smith 19935c6c1daeSBarry Smith Notes: only works in C/C++ not fortran 19945c6c1daeSBarry Smith 19955c6c1daeSBarry Smith Level: intermediate 19965c6c1daeSBarry Smith 19975c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadStage() 19985c6c1daeSBarry Smith 19995c6c1daeSBarry Smith M*/ 20005c6c1daeSBarry Smith 20015c6c1daeSBarry Smith /*MC 20025c6c1daeSBarry Smith PetscPreLoadStage - Start a new segment of code to be timed separately. 20035c6c1daeSBarry Smith to get accurate timings 20045c6c1daeSBarry Smith 20055c6c1daeSBarry Smith Synopsis: 2006aaa7dc30SBarry Smith #include <petsclog.h> 20075c6c1daeSBarry Smith void PetscPreLoadStage(char *name); 20085c6c1daeSBarry Smith 20095c6c1daeSBarry Smith Not Collective 20105c6c1daeSBarry Smith 20115c6c1daeSBarry Smith Usage: 20125c6c1daeSBarry Smith .vb 20135c6c1daeSBarry Smith PetscPreLoadBegin(PETSC_TRUE,"first stage); 20145c6c1daeSBarry Smith lines of code 20155c6c1daeSBarry Smith PetscPreLoadStage("second stage"); 20165c6c1daeSBarry Smith lines of code 20175c6c1daeSBarry Smith PetscPreLoadEnd(); 20185c6c1daeSBarry Smith .ve 20195c6c1daeSBarry Smith 20205c6c1daeSBarry Smith Notes: only works in C/C++ not fortran 20215c6c1daeSBarry Smith 20225c6c1daeSBarry Smith Level: intermediate 20235c6c1daeSBarry Smith 20245c6c1daeSBarry Smith .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscPreLoadBegin(), PetscPreLoadEnd() 20255c6c1daeSBarry Smith 20265c6c1daeSBarry Smith M*/ 20275c6c1daeSBarry Smith 20285c6c1daeSBarry Smith 20295c6c1daeSBarry Smith #else /* end of -DPETSC_USE_LOG section */ 20305c6c1daeSBarry Smith 20315c6c1daeSBarry Smith #undef __FUNCT__ 20325c6c1daeSBarry Smith #define __FUNCT__ "PetscLogObjectState" 20335c6c1daeSBarry Smith PetscErrorCode PetscLogObjectState(PetscObject obj, const char format[], ...) 20345c6c1daeSBarry Smith { 20355c6c1daeSBarry Smith PetscFunctionBegin; 20365c6c1daeSBarry Smith PetscFunctionReturn(0); 20375c6c1daeSBarry Smith } 20385c6c1daeSBarry Smith 20395c6c1daeSBarry Smith #endif /* PETSC_USE_LOG*/ 20405c6c1daeSBarry Smith 20415c6c1daeSBarry Smith 20425c6c1daeSBarry Smith PetscClassId PETSC_LARGEST_CLASSID = PETSC_SMALLEST_CLASSID; 20435c6c1daeSBarry Smith PetscClassId PETSC_OBJECT_CLASSID = 0; 20445c6c1daeSBarry Smith 20455c6c1daeSBarry Smith #undef __FUNCT__ 20465c6c1daeSBarry Smith #define __FUNCT__ "PetscClassIdRegister" 20475c6c1daeSBarry Smith /*@C 20485c6c1daeSBarry Smith PetscClassIdRegister - Registers a new class name for objects and logging operations in an application code. 20495c6c1daeSBarry Smith 20505c6c1daeSBarry Smith Not Collective 20515c6c1daeSBarry Smith 20525c6c1daeSBarry Smith Input Parameter: 20535c6c1daeSBarry Smith . name - The class name 20545c6c1daeSBarry Smith 20555c6c1daeSBarry Smith Output Parameter: 20565c6c1daeSBarry Smith . oclass - The class id or classid 20575c6c1daeSBarry Smith 20585c6c1daeSBarry Smith Level: developer 20595c6c1daeSBarry Smith 20605c6c1daeSBarry Smith .keywords: log, class, register 20615c6c1daeSBarry Smith 20625c6c1daeSBarry Smith @*/ 20635c6c1daeSBarry Smith PetscErrorCode PetscClassIdRegister(const char name[],PetscClassId *oclass) 20645c6c1daeSBarry Smith { 20655c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 20665c6c1daeSBarry Smith PetscStageLog stageLog; 20675c6c1daeSBarry Smith PetscInt stage; 20685c6c1daeSBarry Smith PetscErrorCode ierr; 20695c6c1daeSBarry Smith #endif 20705c6c1daeSBarry Smith 20715c6c1daeSBarry Smith PetscFunctionBegin; 20725c6c1daeSBarry Smith *oclass = ++PETSC_LARGEST_CLASSID; 20735c6c1daeSBarry Smith #if defined(PETSC_USE_LOG) 20745c6c1daeSBarry Smith ierr = PetscLogGetStageLog(&stageLog);CHKERRQ(ierr); 20755c6c1daeSBarry Smith ierr = PetscClassRegLogRegister(stageLog->classLog, name, *oclass);CHKERRQ(ierr); 20765c6c1daeSBarry Smith for (stage = 0; stage < stageLog->numStages; stage++) { 20775c6c1daeSBarry Smith ierr = ClassPerfLogEnsureSize(stageLog->stageInfo[stage].classLog, stageLog->classLog->numClasses);CHKERRQ(ierr); 20785c6c1daeSBarry Smith } 20795c6c1daeSBarry Smith #endif 20805c6c1daeSBarry Smith PetscFunctionReturn(0); 20815c6c1daeSBarry Smith } 2082210b5426SBarry Smith 2083210b5426SBarry Smith #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_MPE) 2084210b5426SBarry Smith #include <mpe.h> 2085210b5426SBarry Smith 2086210b5426SBarry Smith PetscBool PetscBeganMPE = PETSC_FALSE; 2087210b5426SBarry Smith 2088495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventBeginMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2089495fc317SBarry Smith PETSC_INTERN PetscErrorCode PetscLogEventEndMPE(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 2090495fc317SBarry Smith 2091210b5426SBarry Smith #undef __FUNCT__ 2092210b5426SBarry Smith #define __FUNCT__ "PetscLogMPEBegin" 2093210b5426SBarry Smith /*@C 2094210b5426SBarry Smith PetscLogMPEBegin - Turns on MPE logging of events. This creates large log files 2095210b5426SBarry Smith and slows the program down. 2096210b5426SBarry Smith 2097210b5426SBarry Smith Collective over PETSC_COMM_WORLD 2098210b5426SBarry Smith 2099210b5426SBarry Smith Options Database Keys: 2100495fc317SBarry Smith . -log_mpe - Prints extensive log information (for code compiled with PETSC_USE_LOG) 2101210b5426SBarry Smith 2102210b5426SBarry Smith Notes: 2103*bb1d7374SBarry Smith A related routine is PetscLogDefaultBegin() (with the options key -log_summary), which is 2104210b5426SBarry Smith intended for production runs since it logs only flop rates and object 2105210b5426SBarry Smith creation (and should not significantly slow the programs). 2106210b5426SBarry Smith 2107210b5426SBarry Smith Level: advanced 2108210b5426SBarry Smith 2109210b5426SBarry Smith Concepts: logging^MPE 2110210b5426SBarry Smith Concepts: logging^message passing 2111210b5426SBarry Smith 2112*bb1d7374SBarry Smith .seealso: PetscLogDump(), PetscLogDefaultBegin(), PetscLogAllBegin(), PetscLogEventActivate(), 2113210b5426SBarry Smith PetscLogEventDeactivate() 2114210b5426SBarry Smith @*/ 2115210b5426SBarry Smith PetscErrorCode PetscLogMPEBegin(void) 2116210b5426SBarry Smith { 2117210b5426SBarry Smith PetscErrorCode ierr; 2118210b5426SBarry Smith 2119210b5426SBarry Smith PetscFunctionBegin; 2120210b5426SBarry Smith /* Do MPE initialization */ 2121210b5426SBarry Smith if (!MPE_Initialized_logging()) { /* This function exists in mpich 1.1.2 and higher */ 2122210b5426SBarry Smith ierr = PetscInfo(0,"Initializing MPE.\n");CHKERRQ(ierr); 2123210b5426SBarry Smith ierr = MPE_Init_log();CHKERRQ(ierr); 2124210b5426SBarry Smith 2125210b5426SBarry Smith PetscBeganMPE = PETSC_TRUE; 2126210b5426SBarry Smith } else { 2127210b5426SBarry Smith ierr = PetscInfo(0,"MPE already initialized. Not attempting to reinitialize.\n");CHKERRQ(ierr); 2128210b5426SBarry Smith } 2129495fc317SBarry Smith ierr = PetscLogSet(PetscLogEventBeginMPE, PetscLogEventEndMPE);CHKERRQ(ierr); 2130210b5426SBarry Smith PetscFunctionReturn(0); 2131210b5426SBarry Smith } 2132210b5426SBarry Smith 2133210b5426SBarry Smith #undef __FUNCT__ 2134210b5426SBarry Smith #define __FUNCT__ "PetscLogMPEDump" 2135210b5426SBarry Smith /*@C 2136495fc317SBarry Smith PetscLogMPEDump - Dumps the MPE logging info to file for later use with Jumpshot. 2137210b5426SBarry Smith 2138210b5426SBarry Smith Collective over PETSC_COMM_WORLD 2139210b5426SBarry Smith 2140210b5426SBarry Smith Level: advanced 2141210b5426SBarry Smith 2142210b5426SBarry Smith .seealso: PetscLogDump(), PetscLogAllBegin(), PetscLogMPEBegin() 2143210b5426SBarry Smith @*/ 2144210b5426SBarry Smith PetscErrorCode PetscLogMPEDump(const char sname[]) 2145210b5426SBarry Smith { 2146210b5426SBarry Smith char name[PETSC_MAX_PATH_LEN]; 2147210b5426SBarry Smith PetscErrorCode ierr; 2148210b5426SBarry Smith 2149210b5426SBarry Smith PetscFunctionBegin; 2150210b5426SBarry Smith if (PetscBeganMPE) { 2151210b5426SBarry Smith ierr = PetscInfo(0,"Finalizing MPE.\n");CHKERRQ(ierr); 2152210b5426SBarry Smith if (sname) { 2153210b5426SBarry Smith ierr = PetscStrcpy(name,sname);CHKERRQ(ierr); 2154210b5426SBarry Smith } else { 2155210b5426SBarry Smith ierr = PetscGetProgramName(name,PETSC_MAX_PATH_LEN);CHKERRQ(ierr); 2156210b5426SBarry Smith } 2157210b5426SBarry Smith ierr = MPE_Finish_log(name);CHKERRQ(ierr); 2158210b5426SBarry Smith } else { 2159210b5426SBarry Smith ierr = PetscInfo(0,"Not finalizing MPE (not started by PETSc).\n");CHKERRQ(ierr); 2160210b5426SBarry Smith } 2161210b5426SBarry Smith PetscFunctionReturn(0); 2162210b5426SBarry Smith } 2163210b5426SBarry Smith 2164210b5426SBarry Smith #define PETSC_RGB_COLORS_MAX 39 2165210b5426SBarry Smith static const char *PetscLogMPERGBColors[PETSC_RGB_COLORS_MAX] = { 2166210b5426SBarry Smith "OliveDrab: ", 2167210b5426SBarry Smith "BlueViolet: ", 2168210b5426SBarry Smith "CadetBlue: ", 2169210b5426SBarry Smith "CornflowerBlue: ", 2170210b5426SBarry Smith "DarkGoldenrod: ", 2171210b5426SBarry Smith "DarkGreen: ", 2172210b5426SBarry Smith "DarkKhaki: ", 2173210b5426SBarry Smith "DarkOliveGreen: ", 2174210b5426SBarry Smith "DarkOrange: ", 2175210b5426SBarry Smith "DarkOrchid: ", 2176210b5426SBarry Smith "DarkSeaGreen: ", 2177210b5426SBarry Smith "DarkSlateGray: ", 2178210b5426SBarry Smith "DarkTurquoise: ", 2179210b5426SBarry Smith "DeepPink: ", 2180210b5426SBarry Smith "DarkKhaki: ", 2181210b5426SBarry Smith "DimGray: ", 2182210b5426SBarry Smith "DodgerBlue: ", 2183210b5426SBarry Smith "GreenYellow: ", 2184210b5426SBarry Smith "HotPink: ", 2185210b5426SBarry Smith "IndianRed: ", 2186210b5426SBarry Smith "LavenderBlush: ", 2187210b5426SBarry Smith "LawnGreen: ", 2188210b5426SBarry Smith "LemonChiffon: ", 2189210b5426SBarry Smith "LightCoral: ", 2190210b5426SBarry Smith "LightCyan: ", 2191210b5426SBarry Smith "LightPink: ", 2192210b5426SBarry Smith "LightSalmon: ", 2193210b5426SBarry Smith "LightSlateGray: ", 2194210b5426SBarry Smith "LightYellow: ", 2195210b5426SBarry Smith "LimeGreen: ", 2196210b5426SBarry Smith "MediumPurple: ", 2197210b5426SBarry Smith "MediumSeaGreen: ", 2198210b5426SBarry Smith "MediumSlateBlue:", 2199210b5426SBarry Smith "MidnightBlue: ", 2200210b5426SBarry Smith "MintCream: ", 2201210b5426SBarry Smith "MistyRose: ", 2202210b5426SBarry Smith "NavajoWhite: ", 2203210b5426SBarry Smith "NavyBlue: ", 2204210b5426SBarry Smith "OliveDrab: " 2205210b5426SBarry Smith }; 2206210b5426SBarry Smith 2207210b5426SBarry Smith #undef __FUNCT__ 2208210b5426SBarry Smith #define __FUNCT__ "PetscLogMPEGetRGBColor" 2209210b5426SBarry Smith /*@C 2210210b5426SBarry Smith PetscLogMPEGetRGBColor - This routine returns a rgb color useable with PetscLogEventRegister() 2211210b5426SBarry Smith 2212210b5426SBarry Smith Not collective. Maybe it should be? 2213210b5426SBarry Smith 2214210b5426SBarry Smith Output Parameter 2215210b5426SBarry Smith . str - character string representing the color 2216210b5426SBarry Smith 2217210b5426SBarry Smith Level: developer 2218210b5426SBarry Smith 2219210b5426SBarry Smith .keywords: log, mpe , color 2220210b5426SBarry Smith .seealso: PetscLogEventRegister 2221210b5426SBarry Smith @*/ 2222210b5426SBarry Smith PetscErrorCode PetscLogMPEGetRGBColor(const char *str[]) 2223210b5426SBarry Smith { 2224210b5426SBarry Smith static int idx = 0; 2225210b5426SBarry Smith 2226210b5426SBarry Smith PetscFunctionBegin; 2227210b5426SBarry Smith *str = PetscLogMPERGBColors[idx]; 2228210b5426SBarry Smith idx = (idx + 1)% PETSC_RGB_COLORS_MAX; 2229210b5426SBarry Smith PetscFunctionReturn(0); 2230210b5426SBarry Smith } 2231210b5426SBarry Smith 2232210b5426SBarry Smith #endif /* PETSC_USE_LOG && PETSC_HAVE_MPE */ 2233