197bb86f7SLois Curfman McInnes /* 27588ac45SBarry Smith Defines profile/logging in PETSc. 397bb86f7SLois Curfman McInnes */ 497bb86f7SLois Curfman McInnes 5b0a32e0cSBarry Smith #if !defined(__PetscLog_H) 6b0a32e0cSBarry Smith #define __PetscLog_H 797bb86f7SLois Curfman McInnes #include "petsc.h" 8e9fa29b7SSatish Balay PETSC_EXTERN_CXX_BEGIN 9c8d78d4dSSatish Balay 108ba1e511SMatthew Knepley #define PETSC_EVENT 1311311 11166c7f25SBarry Smith extern PetscLogEvent PETSC_LARGEST_EVENT; 1297bb86f7SLois Curfman McInnes 1319b02663SBarry Smith /* Global flop counter */ 14ff73aad6SKris Buschelman extern PetscLogDouble PETSC_DLLEXPORT _TotalFlops; 1590fdf44cSMatthew Knepley extern PetscLogDouble petsc_tmp_flops; 1619b02663SBarry Smith 17edde42fcSLois Curfman McInnes /* General logging of information; different from event logging */ 18ae15b995SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInfo_Private(const char[],void*,const char[],...) PETSC_PRINTF_FORMAT_CHECK(3,4); 196cf91177SBarry Smith #if defined(PETSC_USE_INFO) 20ae15b995SBarry Smith #define PetscInfo(A,S) PetscInfo_Private(__FUNCT__,A,S) 21ae15b995SBarry Smith #define PetscInfo1(A,S,a1) PetscInfo_Private(__FUNCT__,A,S,a1) 22ae15b995SBarry Smith #define PetscInfo2(A,S,a1,a2) PetscInfo_Private(__FUNCT__,A,S,a1,a2) 23ae15b995SBarry Smith #define PetscInfo3(A,S,a1,a2,a3) PetscInfo_Private(__FUNCT__,A,S,a1,a2,a3) 24ae15b995SBarry Smith #define PetscInfo4(A,S,a1,a2,a3,a4) PetscInfo_Private(__FUNCT__,A,S,a1,a2,a3,a4) 25ae15b995SBarry Smith #define PetscInfo5(A,S,a1,a2,a3,a4,a5) PetscInfo_Private(__FUNCT__,A,S,a1,a2,a3,a4,a5) 26ae15b995SBarry Smith #define PetscInfo6(A,S,a1,a2,a3,a4,a5,a6) PetscInfo_Private(__FUNCT__,A,S,a1,a2,a3,a4,a5,a6) 27ae15b995SBarry Smith #define PetscInfo7(A,S,a1,a2,a3,a4,a5,a6,a7) PetscInfo_Private(__FUNCT__,A,S,a1,a2,a3,a4,a5,a6,a7) 2863ba0a88SBarry Smith #else 29ae15b995SBarry Smith #define PetscInfo(A,S) 0 30ae15b995SBarry Smith #define PetscInfo1(A,S,a1) 0 31ae15b995SBarry Smith #define PetscInfo2(A,S,a1,a2) 0 32ae15b995SBarry Smith #define PetscInfo3(A,S,a1,a2,a3) 0 33ae15b995SBarry Smith #define PetscInfo4(A,S,a1,a2,a3,a4) 0 34ae15b995SBarry Smith #define PetscInfo5(A,S,a1,a2,a3,a4,a5) 0 35ae15b995SBarry Smith #define PetscInfo6(A,S,a1,a2,a3,a4,a5,a6) 0 36ae15b995SBarry Smith #define PetscInfo7(A,S,a1,a2,a3,a4,a5,a6,a7) 0 3763ba0a88SBarry Smith #endif 386cf91177SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInfoDeactivateClass(PetscCookie); 396cf91177SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInfoActivateClass(PetscCookie); 406cf91177SBarry Smith extern PetscTruth PETSC_DLLEXPORT PetscLogPrintInfo; /* if true, indicates PetscInfo() is turned on */ 41614700edSBarry Smith 426a6a9b46SSatish Balay /* We must make these structures available if we are to access the event 436a6a9b46SSatish Balay activation flags in the PetscLogEventBegin/End() macros. If we forced a 446a6a9b46SSatish Balay function call each time, we could make these private. 456a6a9b46SSatish Balay */ 466a6a9b46SSatish Balay /* Default log */ 476a6a9b46SSatish Balay typedef struct _n_StageLog *StageLog; 486a6a9b46SSatish Balay extern PETSC_DLLEXPORT StageLog _stageLog; 496a6a9b46SSatish Balay 506a6a9b46SSatish Balay /* A simple stack (should replace) */ 516a6a9b46SSatish Balay typedef struct _n_IntStack *IntStack; 526a6a9b46SSatish Balay 536a6a9b46SSatish Balay /* The structures for logging performance */ 546a6a9b46SSatish Balay typedef struct { 556a6a9b46SSatish Balay int id; /* The integer identifying this section */ 566a6a9b46SSatish Balay PetscTruth active; /* The flag to activate logging */ 576a6a9b46SSatish Balay PetscTruth visible; /* The flag to print info in summary */ 586a6a9b46SSatish Balay int depth; /* The nesting depth of the event call */ 596a6a9b46SSatish Balay int count; /* The number of times this section was executed */ 606a6a9b46SSatish Balay PetscLogDouble flops; /* The flops used in this section */ 616a6a9b46SSatish Balay PetscLogDouble time; /* The time taken for this section */ 626a6a9b46SSatish Balay PetscLogDouble numMessages; /* The number of messages in this section */ 636a6a9b46SSatish Balay PetscLogDouble messageLength; /* The total message lengths in this section */ 646a6a9b46SSatish Balay PetscLogDouble numReductions; /* The number of reductions in this section */ 656a6a9b46SSatish Balay } EventPerfInfo; 666a6a9b46SSatish Balay 676a6a9b46SSatish Balay typedef struct { 686a6a9b46SSatish Balay int id; /* The integer identifying this class */ 696a6a9b46SSatish Balay int creations; /* The number of objects of this class created */ 706a6a9b46SSatish Balay int destructions; /* The number of objects of this class destroyed */ 716a6a9b46SSatish Balay PetscLogDouble mem; /* The total memory allocated by objects of this class */ 726a6a9b46SSatish Balay PetscLogDouble descMem; /* The total memory allocated by descendents of these objects */ 736a6a9b46SSatish Balay } ClassPerfInfo; 746a6a9b46SSatish Balay 756a6a9b46SSatish Balay /* The structures for logging registration */ 766a6a9b46SSatish Balay typedef struct { 776a6a9b46SSatish Balay char *name; /* The class name */ 786a6a9b46SSatish Balay PetscCookie cookie; /* The integer identifying this class */ 796a6a9b46SSatish Balay } ClassRegInfo; 806a6a9b46SSatish Balay 816a6a9b46SSatish Balay typedef struct { 826a6a9b46SSatish Balay char *name; /* The name of this event */ 836a6a9b46SSatish Balay PetscCookie cookie; /* The class id for this event (should maybe give class ID instead) */ 846a6a9b46SSatish Balay #if defined (PETSC_HAVE_MPE) 856a6a9b46SSatish Balay int mpe_id_begin; /* MPE IDs that define the event */ 866a6a9b46SSatish Balay int mpe_id_end; 876a6a9b46SSatish Balay #endif 886a6a9b46SSatish Balay } EventRegInfo; 896a6a9b46SSatish Balay 906a6a9b46SSatish Balay typedef struct _n_EventRegLog *EventRegLog; 916a6a9b46SSatish Balay struct _n_EventRegLog { 926a6a9b46SSatish Balay int numEvents; /* The number of registered events */ 936a6a9b46SSatish Balay int maxEvents; /* The maximum number of events */ 946a6a9b46SSatish Balay EventRegInfo *eventInfo; /* The registration information for each event */ 956a6a9b46SSatish Balay }; 966a6a9b46SSatish Balay 976a6a9b46SSatish Balay typedef struct _n_EventPerfLog *EventPerfLog; 986a6a9b46SSatish Balay struct _n_EventPerfLog { 996a6a9b46SSatish Balay int numEvents; /* The number of logging events */ 1006a6a9b46SSatish Balay int maxEvents; /* The maximum number of events */ 1016a6a9b46SSatish Balay EventPerfInfo *eventInfo; /* The performance information for each event */ 1026a6a9b46SSatish Balay }; 1036a6a9b46SSatish Balay 1046a6a9b46SSatish Balay /* The structure for logging class information */ 1056a6a9b46SSatish Balay typedef struct _n_ClassRegLog *ClassRegLog; 1066a6a9b46SSatish Balay struct _n_ClassRegLog { 1076a6a9b46SSatish Balay int numClasses; /* The number of classes registered */ 1086a6a9b46SSatish Balay int maxClasses; /* The maximum number of classes */ 1096a6a9b46SSatish Balay ClassRegInfo *classInfo; /* The structure for class information (cookies are monotonicly increasing) */ 1106a6a9b46SSatish Balay }; 1116a6a9b46SSatish Balay 1126a6a9b46SSatish Balay typedef struct _n_ClassPerfLog *ClassPerfLog; 1136a6a9b46SSatish Balay struct _n_ClassPerfLog { 1146a6a9b46SSatish Balay int numClasses; /* The number of logging classes */ 1156a6a9b46SSatish Balay int maxClasses; /* The maximum number of classes */ 1166a6a9b46SSatish Balay ClassPerfInfo *classInfo; /* The structure for class information (cookies are monotonicly increasing) */ 1176a6a9b46SSatish Balay }; 1186a6a9b46SSatish Balay 1196a6a9b46SSatish Balay /* The structures for logging in stages */ 1206a6a9b46SSatish Balay typedef struct _StageInfo { 1216a6a9b46SSatish Balay char *name; /* The stage name */ 1226a6a9b46SSatish Balay PetscTruth used; /* The stage was pushed on this processor */ 1236a6a9b46SSatish Balay EventPerfInfo perfInfo; /* The stage performance information */ 1246a6a9b46SSatish Balay EventPerfLog eventLog; /* The event information for this stage */ 1256a6a9b46SSatish Balay ClassPerfLog classLog; /* The class information for this stage */ 1266a6a9b46SSatish Balay } StageInfo; 1276a6a9b46SSatish Balay 1286a6a9b46SSatish Balay struct _n_StageLog { 1296a6a9b46SSatish Balay /* Size information */ 1306a6a9b46SSatish Balay int numStages; /* The number of registered stages */ 1316a6a9b46SSatish Balay int maxStages; /* The maximum number of stages */ 1326a6a9b46SSatish Balay /* Runtime information */ 1336a6a9b46SSatish Balay IntStack stack; /* The stack for active stages */ 1346a6a9b46SSatish Balay int curStage; /* The current stage (only used in macros so we don't call StackTop) */ 1356a6a9b46SSatish Balay /* Stage specific information */ 1366a6a9b46SSatish Balay StageInfo *stageInfo; /* The information for each stage */ 1376a6a9b46SSatish Balay EventRegLog eventLog; /* The registered events */ 1386a6a9b46SSatish Balay ClassRegLog classLog; /* The registered classes */ 1396a6a9b46SSatish Balay }; 1406a6a9b46SSatish Balay 141aa482453SBarry Smith #if defined(PETSC_USE_LOG) /* --- Logging is turned on --------------------------------*/ 142614700edSBarry Smith 143da63de55SLois Curfman McInnes /* 144da63de55SLois Curfman McInnes Flop counting: We count each arithmetic operation (e.g., addition, multiplication) separately. 145da63de55SLois Curfman McInnes 146da63de55SLois Curfman McInnes For the complex numbers version, note that 147da63de55SLois Curfman McInnes 1 complex addition = 2 flops 148da63de55SLois Curfman McInnes 1 complex multiplication = 6 flops, 149da63de55SLois Curfman McInnes where we define 1 flop as that for a double precision scalar. We roughly approximate 150da63de55SLois Curfman McInnes flop counting for complex numbers by multiplying the total flops by 4; this corresponds 151da63de55SLois Curfman McInnes to the assumption that we're counting mostly additions and multiplications -- and 152da63de55SLois Curfman McInnes roughly the same number of each. More accurate counting could be done by distinguishing 153da63de55SLois Curfman McInnes among the various arithmetic operations. 154da63de55SLois Curfman McInnes */ 155da63de55SLois Curfman McInnes 156aa482453SBarry Smith #if defined(PETSC_USE_COMPLEX) 157bf3909cdSBarry Smith #define PETSC_FLOPS_PER_OP 4 158da63de55SLois Curfman McInnes #else 159bf3909cdSBarry Smith #define PETSC_FLOPS_PER_OP 1 160bf3909cdSBarry Smith #endif 161bf3909cdSBarry Smith 162bf3909cdSBarry Smith #if defined(PETSC_USE_DEBUG) 163bf3909cdSBarry Smith #define PetscLogFlops(n) (petsc_tmp_flops = (PETSC_FLOPS_PER_OP*(n)), ((petsc_tmp_flops < 0) ? PETSC_ERR_FLOP_COUNT : (_TotalFlops += petsc_tmp_flops,0))) 164bf3909cdSBarry Smith #else 165bf3909cdSBarry Smith #define PetscLogFlops(n) (_TotalFlops += PETSC_FLOPS_PER_OP*(n),0) 166da63de55SLois Curfman McInnes #endif 16777c4ece6SBarry Smith 168aa482453SBarry Smith #if defined (PETSC_HAVE_MPE) 16977c4ece6SBarry Smith #include "mpe.h" 170ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogMPEBegin(void); 171ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogMPEDump(const char[]); 17235d8aa7fSBarry Smith extern PetscTruth UseMPE; 173043328b6SSatish Balay #define PETSC_LOG_EVENT_MPE_BEGIN(e) \ 174335e4f37SSatish Balay ((UseMPE && _stageLog->stageInfo[_stageLog->curStage].eventLog->eventInfo[e].active) ? \ 175a1b71033SSatish Balay MPE_Log_event(_stageLog->eventLog->eventInfo[e].mpe_id_begin,0,NULL) : 0) 176043328b6SSatish Balay 177043328b6SSatish Balay #define PETSC_LOG_EVENT_MPE_END(e) \ 178335e4f37SSatish Balay ((UseMPE && _stageLog->stageInfo[_stageLog->curStage].eventLog->eventInfo[e].active) ? \ 179a1b71033SSatish Balay MPE_Log_event(_stageLog->eventLog->eventInfo[e].mpe_id_end,0,NULL) : 0) 180043328b6SSatish Balay 181614700edSBarry Smith #else 18252e6d16bSBarry Smith #define PETSC_LOG_EVENT_MPE_BEGIN(e) 0 18352e6d16bSBarry Smith #define PETSC_LOG_EVENT_MPE_END(e) 0 18477c4ece6SBarry Smith #endif 18577c4ece6SBarry Smith 186166c7f25SBarry Smith EXTERN PETSC_DLLEXPORT PetscErrorCode (*_PetscLogPLB)(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 187166c7f25SBarry Smith EXTERN PETSC_DLLEXPORT PetscErrorCode (*_PetscLogPLE)(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject); 188ff73aad6SKris Buschelman EXTERN PETSC_DLLEXPORT PetscErrorCode (*_PetscLogPHC)(PetscObject); 189ff73aad6SKris Buschelman EXTERN PETSC_DLLEXPORT PetscErrorCode (*_PetscLogPHD)(PetscObject); 19077c4ece6SBarry Smith 191043328b6SSatish Balay #define PetscLogObjectParent(p,c) \ 19252e6d16bSBarry Smith ((c && p) ? ((PetscObject)(c))->parent = (PetscObject)(p),((PetscObject)(c))->parentid = ((PetscObject)p)->id : 0, 0) 19352e6d16bSBarry Smith 194efee365bSSatish Balay #define PetscLogObjectParents(p,n,d) 0;{int _i; for (_i=0; _i<n; _i++) {ierr = PetscLogObjectParent(p,(d)[_i]);CHKERRQ(ierr);}} 195d38fa0fbSBarry Smith #define PetscLogObjectCreate(h) ((_PetscLogPHC) ? (*_PetscLogPHC)((PetscObject)h) : 0) 196d38fa0fbSBarry Smith #define PetscLogObjectDestroy(h) ((_PetscLogPHD) ? (*_PetscLogPHD)((PetscObject)h) : 0) 19752e6d16bSBarry Smith #define PetscLogObjectMemory(p,m) (((PetscObject)(p))->mem += (m),0) 1988ba1e511SMatthew Knepley /* Initialization functions */ 199ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogBegin(void); 200ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogAllBegin(void); 201ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogTraceBegin(FILE *); 202ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogActions(PetscTruth); 203ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogObjects(PetscTruth); 2048ba1e511SMatthew Knepley /* General functions */ 205ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogGetRGBColor(const char*[]); 206ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogDestroy(void); 207ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogSet(PetscErrorCode (*)(int, int, PetscObject, PetscObject, PetscObject, PetscObject), 2086849ba73SBarry Smith PetscErrorCode (*)(int, int, PetscObject, PetscObject, PetscObject, PetscObject)); 209ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogObjectState(PetscObject, const char[], ...) PETSC_PRINTF_FORMAT_CHECK(2,3); 2108ba1e511SMatthew Knepley /* Output functions */ 211ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogPrintSummary(MPI_Comm, const char[]); 21278392ef1SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogPrintDetailed(MPI_Comm, const char[]); 213ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogDump(const char[]); 2148ba1e511SMatthew Knepley /* Counter functions */ 215ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetFlops(PetscLogDouble *); 2168ba1e511SMatthew Knepley /* Stage functions */ 217166c7f25SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStageRegister(const char[],PetscLogStage*); 218166c7f25SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStagePush(PetscLogStage); 219ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStagePop(void); 220166c7f25SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStageSetActive(PetscLogStage, PetscTruth); 221166c7f25SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStageGetActive(PetscLogStage, PetscTruth *); 222166c7f25SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStageSetVisible(PetscLogStage, PetscTruth); 223166c7f25SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStageGetVisible(PetscLogStage, PetscTruth *); 224166c7f25SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStageGetId(const char [], PetscLogStage *); 2258ba1e511SMatthew Knepley /* Event functions */ 226166c7f25SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogEventRegister(const char[], PetscCookie,PetscLogEvent*); 227166c7f25SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogEventActivate(PetscLogEvent); 228166c7f25SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogEventDeactivate(PetscLogEvent); 229166c7f25SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogEventSetActiveAll(PetscLogEvent, PetscTruth); 230ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogEventActivateClass(PetscCookie); 231ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogEventDeactivateClass(PetscCookie); 2329afaeae2SBarry Smith 2338ba1e511SMatthew Knepley 2348ba1e511SMatthew Knepley /* Global counters */ 235ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble irecv_ct; 236ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble isend_ct; 237ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble recv_ct; 238ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble send_ct; 239ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble irecv_len; 240ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble isend_len; 241ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble recv_len; 242ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble send_len; 243ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble allreduce_ct; 244*01faf4e4SMatthew Knepley extern PETSC_DLLEXPORT PetscLogDouble gather_ct; 245*01faf4e4SMatthew Knepley extern PETSC_DLLEXPORT PetscLogDouble scatter_ct; 246ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble wait_ct; 247ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble wait_any_ct; 248ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble wait_all_ct; 249ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble sum_of_waits_ct; 250ff73aad6SKris Buschelman extern PETSC_DLLEXPORT int PETSC_DUMMY_SIZE; 251ff73aad6SKris Buschelman extern PETSC_DLLEXPORT int PETSC_DUMMY_COUNT; 2528ba1e511SMatthew Knepley 25352e6d16bSBarry Smith #define PetscLogEventBarrierBegin(e,o1,o2,o3,o4,cm) \ 25452e6d16bSBarry Smith (((_PetscLogPLB && _stageLog->stageInfo[_stageLog->curStage].perfInfo.active && _stageLog->stageInfo[_stageLog->curStage].eventLog->eventInfo[e].active) ? \ 25552e6d16bSBarry Smith (PetscLogEventBegin((e),o1,o2,o3,o4) || MPI_Barrier(cm) || PetscLogEventEnd((e),o1,o2,o3,o4)) : 0 ) || \ 25652e6d16bSBarry Smith PetscLogEventBegin((e)+1,o1,o2,o3,o4)) 25777c4ece6SBarry Smith 25852e6d16bSBarry Smith #define PetscLogEventBegin(e,o1,o2,o3,o4) \ 25952e6d16bSBarry Smith (((_PetscLogPLB && _stageLog->stageInfo[_stageLog->curStage].perfInfo.active && _stageLog->stageInfo[_stageLog->curStage].eventLog->eventInfo[e].active) ? \ 26052e6d16bSBarry Smith (*_PetscLogPLB)((e),0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4)) : 0 ) || \ 26152e6d16bSBarry Smith PETSC_LOG_EVENT_MPE_BEGIN(e)) 262043328b6SSatish Balay 263b0a32e0cSBarry Smith #define PetscLogEventBarrierEnd(e,o1,o2,o3,o4,cm) PetscLogEventEnd(e+1,o1,o2,o3,o4) 264043328b6SSatish Balay 26552e6d16bSBarry Smith #define PetscLogEventEnd(e,o1,o2,o3,o4) \ 26652e6d16bSBarry Smith (((_PetscLogPLE && _stageLog->stageInfo[_stageLog->curStage].perfInfo.active && _stageLog->stageInfo[_stageLog->curStage].eventLog->eventInfo[e].active) ? \ 26752e6d16bSBarry Smith (*_PetscLogPLE)((e),0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4)) : 0 ) || \ 26852e6d16bSBarry Smith PETSC_LOG_EVENT_MPE_END(e)) 26977c4ece6SBarry Smith 270f141ce34SMatthew Knepley /* Creation and destruction functions */ 271ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogCreate(StageLog *); 272ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogDestroy(StageLog); 273f141ce34SMatthew Knepley /* Registration functions */ 274ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogRegister(StageLog, const char [], int *); 275f141ce34SMatthew Knepley /* Runtime functions */ 276ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogGetStageLog(StageLog *); 277ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogPush(StageLog, int); 278ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogPop(StageLog); 279ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetCurrent(StageLog, int *); 280ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogSetActive(StageLog, int, PetscTruth); 281ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetActive(StageLog, int, PetscTruth *); 282ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogSetVisible(StageLog, int, PetscTruth); 283ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetVisible(StageLog, int, PetscTruth *); 284ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetStage(StageLog, const char [], int *); 285ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetClassRegLog(StageLog, ClassRegLog *); 286ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetEventRegLog(StageLog, EventRegLog *); 287ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetClassPerfLog(StageLog, int, ClassPerfLog *); 288ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetEventPerfLog(StageLog, int, EventPerfLog *); 289f141ce34SMatthew Knepley 290ce85283eSBarry Smith /* 291f621e05eSBarry Smith These are used internally in the PETSc routines to keep a count of MPI messages and 292f621e05eSBarry Smith their sizes. 293f621e05eSBarry Smith 2943c94ec11SBarry Smith This does not work for MPI-Uni because our include/mpiuni/mpi.h file 295ce85283eSBarry Smith uses macros to defined the MPI operations. 29615308354SBarry Smith 29715308354SBarry Smith It does not work correctly from HP-UX because it processes the 298bb4af37aSBarry Smith macros in a way that sometimes it double counts, hence 299b6410449SSatish Balay PETSC_HAVE_BROKEN_RECURSIVE_MACRO 3007c1e34a4SSatish Balay 301f569fd43SBarry Smith It does not work with Windows because winmpich lacks MPI_Type_size() 302ce85283eSBarry Smith */ 303c8217ed5SSatish Balay #if !defined(__MPIUNI_H) && !defined(PETSC_HAVE_BROKEN_RECURSIVE_MACRO) && !defined (PETSC_HAVE_MPI_MISSING_TYPESIZE) 30477a39924SBarry Smith /* 30577a39924SBarry Smith Logging of MPI activities 30677a39924SBarry Smith */ 30777a39924SBarry Smith #define TypeSize(buff,count,type) \ 3085e3723c6SSatish Balay (MPI_Type_size(type,&PETSC_DUMMY_SIZE) || (buff += (PetscLogDouble) ((count)*PETSC_DUMMY_SIZE),0)) 30977a39924SBarry Smith 31077a39924SBarry Smith #define MPI_Irecv(buf,count,datatype,source,tag,comm,request) \ 3115e3723c6SSatish Balay ((PETSC_DUMMY_COUNT = count,irecv_ct++,0) || TypeSize(irecv_len,PETSC_DUMMY_COUNT,datatype) || MPI_Irecv(buf,PETSC_DUMMY_COUNT,datatype,source,tag,comm,request)) 31215308354SBarry Smith 31377a39924SBarry Smith #define MPI_Isend(buf,count,datatype,dest,tag,comm,request) \ 3145e3723c6SSatish Balay ((PETSC_DUMMY_COUNT = count,isend_ct++,0) || TypeSize(isend_len,PETSC_DUMMY_COUNT,datatype) || MPI_Isend(buf,PETSC_DUMMY_COUNT,datatype,dest,tag,comm,request)) 31515308354SBarry Smith 3160d4b0b6cSBarry Smith #define MPI_Startall_irecv(count,number,requests) \ 3175e3723c6SSatish Balay ((irecv_ct += (PetscLogDouble)(number),0) || TypeSize(irecv_len,count,MPIU_SCALAR) || MPI_Startall(number,requests)) 3180d4b0b6cSBarry Smith 3190d4b0b6cSBarry Smith #define MPI_Startall_isend(count,number,requests) \ 3205e3723c6SSatish Balay ((isend_ct += (PetscLogDouble)(number),0) || TypeSize(isend_len,count,MPIU_SCALAR) || MPI_Startall(number,requests)) 3210d4b0b6cSBarry Smith 3220d4b0b6cSBarry Smith #define MPI_Start_isend(count,requests) \ 3235e3723c6SSatish Balay ((isend_ct++,0) || TypeSize(isend_len,count,MPIU_SCALAR) || MPI_Start(requests)) 3240d4b0b6cSBarry Smith 325ce85283eSBarry Smith #define MPI_Recv(buf,count,datatype,source,tag,comm,status) \ 3265e3723c6SSatish Balay ((PETSC_DUMMY_COUNT = count,recv_ct++,0) || TypeSize(recv_len,PETSC_DUMMY_COUNT,datatype) || MPI_Recv(buf,PETSC_DUMMY_COUNT,datatype,source,tag,comm,status)) 32715308354SBarry Smith 32877a39924SBarry Smith #define MPI_Send(buf,count,datatype,dest,tag,comm) \ 3295e3723c6SSatish Balay ((PETSC_DUMMY_COUNT = count,send_ct++,0) || TypeSize(send_len,PETSC_DUMMY_COUNT,datatype) || MPI_Send(buf,PETSC_DUMMY_COUNT,datatype,dest,tag,comm)) 33077a39924SBarry Smith 33177a39924SBarry Smith #define MPI_Wait(request,status) \ 3325e3723c6SSatish Balay ((wait_ct++,sum_of_waits_ct++,0) || MPI_Wait(request,status)) 33377a39924SBarry Smith 33477a39924SBarry Smith #define MPI_Waitany(a,b,c,d) \ 3355e3723c6SSatish Balay ((wait_any_ct++,sum_of_waits_ct++,0) || MPI_Waitany(a,b,c,d)) 33677a39924SBarry Smith 33777a39924SBarry Smith #define MPI_Waitall(count,array_of_requests,array_of_statuses) \ 3385e3723c6SSatish Balay ((PETSC_DUMMY_COUNT = count,wait_all_ct++,sum_of_waits_ct += (PetscLogDouble) (PETSC_DUMMY_COUNT),0) || MPI_Waitall(PETSC_DUMMY_COUNT,array_of_requests,array_of_statuses)) 33977a39924SBarry Smith 34077a39924SBarry Smith #define MPI_Allreduce(sendbuf,recvbuf,count,datatype,op,comm) \ 3415e3723c6SSatish Balay ((allreduce_ct++,0) || MPI_Allreduce(sendbuf,recvbuf,count,datatype,op,comm)) 3423914022bSBarry Smith 343*01faf4e4SMatthew Knepley #define MPI_Allgather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm) \ 344*01faf4e4SMatthew Knepley ((gather_ct++,0) || MPI_Allgather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm)) 345*01faf4e4SMatthew Knepley 346*01faf4e4SMatthew Knepley #define MPI_Allgatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,comm) \ 347*01faf4e4SMatthew Knepley ((gather_ct++,0) || MPI_Allgatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,comm)) 348*01faf4e4SMatthew Knepley 349*01faf4e4SMatthew Knepley #define MPI_Gather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm) \ 350*01faf4e4SMatthew Knepley ((PETSC_DUMMY_COUNT = sendcount,gather_ct++,0) || TypeSize(send_len,PETSC_DUMMY_COUNT,sendtype) || MPI_Gather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm)) 351*01faf4e4SMatthew Knepley 352*01faf4e4SMatthew Knepley #define MPI_Gatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,root,comm) \ 353*01faf4e4SMatthew Knepley ((PETSC_DUMMY_COUNT = sendcount,gather_ct++,0) || TypeSize(send_len,PETSC_DUMMY_COUNT,sendtype) || MPI_Gatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,root,comm)) 354*01faf4e4SMatthew Knepley 355*01faf4e4SMatthew Knepley #define MPI_Scatter(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm) \ 356*01faf4e4SMatthew Knepley ((PETSC_DUMMY_COUNT = recvcount,scatter_ct++,0) || TypeSize(recv_len,PETSC_DUMMY_COUNT,recvtype) || MPI_Scatter(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm)) 357*01faf4e4SMatthew Knepley 358*01faf4e4SMatthew Knepley #define MPI_Scatterv(sendbuf,sendcount,displs,sendtype,recvbuf,recvcount,recvtype,root,comm) \ 359*01faf4e4SMatthew Knepley ((PETSC_DUMMY_COUNT = recvcount,scatter_ct++,0) || TypeSize(recv_len,PETSC_DUMMY_COUNT,recvtype) || MPI_Scatterv(sendbuf,sendcount,displs,sendtype,recvbuf,recvcount,recvtype,root,comm)) 360*01faf4e4SMatthew Knepley 3610d4b0b6cSBarry Smith #else 3620d4b0b6cSBarry Smith 3630d4b0b6cSBarry Smith #define MPI_Startall_irecv(count,number,requests) \ 3645e3723c6SSatish Balay (MPI_Startall(number,requests)) 3650d4b0b6cSBarry Smith 3660d4b0b6cSBarry Smith #define MPI_Startall_isend(count,number,requests) \ 3675e3723c6SSatish Balay (MPI_Startall(number,requests)) 3680d4b0b6cSBarry Smith 3690d4b0b6cSBarry Smith #define MPI_Start_isend(count,requests) \ 3705e3723c6SSatish Balay (MPI_Start(requests)) 3710d4b0b6cSBarry Smith 372c8217ed5SSatish Balay #endif /* !__MPIUNI_H && ! PETSC_HAVE_BROKEN_RECURSIVE_MACRO */ 373614700edSBarry Smith 374df8cf0b5SBarry Smith #else /* ---Logging is turned off --------------------------------------------*/ 375614700edSBarry Smith 376b0a32e0cSBarry Smith #define PetscLogFlops(n) 0 377614700edSBarry Smith 378df8cf0b5SBarry Smith /* 379df8cf0b5SBarry Smith With logging turned off, then MPE has to be turned off 380df8cf0b5SBarry Smith */ 381b0a32e0cSBarry Smith #define PetscLogMPEBegin() 0 382b0a32e0cSBarry Smith #define PetscLogMPEDump(a) 0 383614700edSBarry Smith 384b0a32e0cSBarry Smith #define PetscLogEventActivate(a) 0 385b0a32e0cSBarry Smith #define PetscLogEventDeactivate(a) 0 386614700edSBarry Smith 387b0a32e0cSBarry Smith #define PetscLogEventActivateClass(a) 0 388b0a32e0cSBarry Smith #define PetscLogEventDeactivateClass(a) 0 389e8e7597cSSatish Balay #define PetscLogEventSetActiveAll(a,b) 0 39077c4ece6SBarry Smith 391b0a32e0cSBarry Smith #define _PetscLogPLB 0 392b0a32e0cSBarry Smith #define _PetscLogPLE 0 393b0a32e0cSBarry Smith #define _PetscLogPHC 0 394b0a32e0cSBarry Smith #define _PetscLogPHD 0 39599de4ba8SSatish Balay #define PetscGetFlops(a) (*(a) = 0.0,0) 396b0a32e0cSBarry Smith #define PetscLogEventBegin(e,o1,o2,o3,o4) 0 397b0a32e0cSBarry Smith #define PetscLogEventEnd(e,o1,o2,o3,o4) 0 398b0a32e0cSBarry Smith #define PetscLogEventBarrierBegin(e,o1,o2,o3,o4,cm) 0 399b0a32e0cSBarry Smith #define PetscLogEventBarrierEnd(e,o1,o2,o3,o4,cm) 0 40052e6d16bSBarry Smith #define PetscLogObjectParent(p,c) 0 401efee365bSSatish Balay #define PetscLogObjectParents(p,n,c) 0 40252e6d16bSBarry Smith #define PetscLogObjectCreate(h) 0 40352e6d16bSBarry Smith #define PetscLogObjectDestroy(h) 0 40452e6d16bSBarry Smith #define PetscLogObjectMemory(p,m) 0 405b0a32e0cSBarry Smith #define PetscLogDestroy() 0 406b0a32e0cSBarry Smith #define PetscLogStagePush(a) 0 407b0a32e0cSBarry Smith #define PetscLogStagePop() 0 408b0a32e0cSBarry Smith #define PetscLogStageRegister(a,b) 0 409b0a32e0cSBarry Smith #define PetscLogStagePrint(a,flg) 0 410b0a32e0cSBarry Smith #define PetscLogPrintSummary(comm,file) 0 41178392ef1SBarry Smith #define PetscLogPrintDetailed(comm,file) 0 412b0a32e0cSBarry Smith #define PetscLogBegin() 0 413b0a32e0cSBarry Smith #define PetscLogTraceBegin(file) 0 414b0a32e0cSBarry Smith #define PetscLogSet(lb,le) 0 415b0a32e0cSBarry Smith #define PetscLogAllBegin() 0 416b0a32e0cSBarry Smith #define PetscLogDump(c) 0 417043328b6SSatish Balay #define PetscLogEventRegister(a,b,c) 0 41873fda44aSBarry Smith #define PetscLogObjects(a) 0 41973fda44aSBarry Smith #define PetscLogActions(a) 0 420ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogObjectState(PetscObject,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3); 421ce6058e1SBarry Smith 422aa482453SBarry Smith /* If PETSC_USE_LOG is NOT defined, these still need to be! */ 423ca161407SBarry Smith #define MPI_Startall_irecv(count,number,requests) MPI_Startall(number,requests) 424ca161407SBarry Smith #define MPI_Startall_isend(count,number,requests) MPI_Startall(number,requests) 425ca161407SBarry Smith #define MPI_Start_isend(count,requests) MPI_Start(requests) 426ca161407SBarry Smith 427f141ce34SMatthew Knepley /* Creation and destruction functions */ 428f141ce34SMatthew Knepley #define StageLogCreate(stageLog) 0 429f141ce34SMatthew Knepley #define StageLogDestroy(stageLog) 0 430f141ce34SMatthew Knepley /* Registration functions */ 431f141ce34SMatthew Knepley #define StageLogRegister(stageLog, name, stage) 0 432f141ce34SMatthew Knepley /* Runtime functions */ 433f141ce34SMatthew Knepley #define PetscLogGetStageLog(stageLog) 0 434f141ce34SMatthew Knepley #define StageLogPush(stageLog, stage) 0 435f141ce34SMatthew Knepley #define StageLogPop(stageLog) 0 436f141ce34SMatthew Knepley #define StageLogGetCurrent(stageLog, stage) 0 437f141ce34SMatthew Knepley #define StageLogSetActive(stageLog, stage, active) 0 438f141ce34SMatthew Knepley #define StageLogGetActive(stageLog, stage, active) 0 439f141ce34SMatthew Knepley #define StageLogSetVisible(stageLog, stage, visible) 0 440f141ce34SMatthew Knepley #define StageLogGetVisible(stageLog, stage, visible) 0 441f141ce34SMatthew Knepley #define StageLogGetStage(stageLog, name, stage) 0 442fad68dfaSSatish Balay #define PetscLogStageGetId(a,b) (*(b)=0,0) 443fad68dfaSSatish Balay #define PetscLogStageSetActive(a,b) 0 4446a6a9b46SSatish Balay #define PetscLogStageGetActive(a,b) 0 4456a6a9b46SSatish Balay #define PetscLogStageGetVisible(a,b) 0 4466a6a9b46SSatish Balay #define PetscLogStageSetVisible(a,b) 0 447f141ce34SMatthew Knepley 448aa482453SBarry Smith #endif /* PETSC_USE_LOG */ 4496daaf66cSBarry Smith 450043328b6SSatish Balay #define PreLoadBegin(flag,name) \ 451043328b6SSatish Balay {\ 452c4411e17SBarry Smith PetscTruth PreLoading = flag;\ 4538cbcd9ccSBarry Smith int PreLoadMax,PreLoadIt;\ 454166c7f25SBarry Smith PetscLogStage _stageNum;\ 4558cbcd9ccSBarry Smith PetscErrorCode _3_ierr; \ 4564dc4c822SBarry Smith _3_ierr = PetscOptionsGetTruth(PETSC_NULL,"-preload",&PreLoading,PETSC_NULL);CHKERRQ(_3_ierr);\ 457043328b6SSatish Balay PreLoadMax = (int)(PreLoading);\ 458043328b6SSatish Balay PetscPreLoadingUsed = PreLoading ? PETSC_TRUE : PetscPreLoadingUsed;\ 459e7592fafSBarry Smith for (PreLoadIt=0; PreLoadIt<=PreLoadMax; PreLoadIt++) {\ 460435da068SBarry Smith PetscPreLoadingOn = PreLoading;\ 4616e491fe6SBarry Smith _3_ierr = PetscBarrier(PETSC_NULL);CHKERRQ(_3_ierr);\ 4628e58c17dSMatthew Knepley if (PreLoadIt>0) {\ 4638e58c17dSMatthew Knepley _3_ierr = PetscLogStageGetId(name,&_stageNum);CHKERRQ(_3_ierr);\ 4648e58c17dSMatthew Knepley } else {\ 465a3bc4eb9SBarry Smith _3_ierr = PetscLogStageRegister(name,&_stageNum);CHKERRQ(_3_ierr); \ 4668e58c17dSMatthew Knepley }\ 467773a6509SMatthew Knepley _3_ierr = PetscLogStageSetActive(_stageNum,(PetscTruth)(!PreLoadMax || PreLoadIt));\ 4688e58c17dSMatthew Knepley _3_ierr = PetscLogStagePush(_stageNum);CHKERRQ(_3_ierr); 4698e58c17dSMatthew Knepley 470043328b6SSatish Balay #define PreLoadEnd() \ 471043328b6SSatish Balay _3_ierr = PetscLogStagePop();CHKERRQ(_3_ierr);\ 472043328b6SSatish Balay PreLoading = PETSC_FALSE;\ 473043328b6SSatish Balay }\ 474043328b6SSatish Balay } 4758e58c17dSMatthew Knepley 476043328b6SSatish Balay #define PreLoadStage(name) \ 477043328b6SSatish Balay _3_ierr = PetscLogStagePop();CHKERRQ(_3_ierr);\ 4788e58c17dSMatthew Knepley if (PreLoadIt>0) {\ 4798e58c17dSMatthew Knepley _3_ierr = PetscLogStageGetId(name,&_stageNum);CHKERRQ(_3_ierr);\ 4808e58c17dSMatthew Knepley } else {\ 481a3bc4eb9SBarry Smith _3_ierr = PetscLogStageRegister(name,&_stageNum);CHKERRQ(_3_ierr); \ 4828e58c17dSMatthew Knepley }\ 483773a6509SMatthew Knepley _3_ierr = PetscLogStageSetActive(_stageNum,(PetscTruth)(!PreLoadMax || PreLoadIt));\ 4848e58c17dSMatthew Knepley _3_ierr = PetscLogStagePush(_stageNum);CHKERRQ(_3_ierr); 485e9fa29b7SSatish Balay 486e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END 48797bb86f7SLois Curfman McInnes #endif 488