xref: /petsc/include/petsclog.h (revision 6cf91177622bd3d3e4d9f7c593ec388633359851)
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
116849ba73SBarry Smith extern PetscEvent PETSC_LARGEST_EVENT;
1297bb86f7SLois Curfman McInnes 
1319b02663SBarry Smith /* Global flop counter */
14ff73aad6SKris Buschelman extern PetscLogDouble PETSC_DLLEXPORT _TotalFlops;
1519b02663SBarry Smith 
16edde42fcSLois Curfman McInnes /* General logging of information; different from event logging */
17*6cf91177SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInfo_Private(void*,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
18*6cf91177SBarry Smith #if defined(PETSC_USE_INFO)
19*6cf91177SBarry Smith #define PetscInfo(A)      PetscInfo_Private A
2063ba0a88SBarry Smith #else
21*6cf91177SBarry Smith #define PetscInfo(A)      0
2263ba0a88SBarry Smith #endif
23*6cf91177SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInfoDeactivateClass(PetscCookie);
24*6cf91177SBarry Smith EXTERN PetscErrorCode PETSC_DLLEXPORT PetscInfoActivateClass(PetscCookie);
25*6cf91177SBarry Smith extern PetscTruth     PETSC_DLLEXPORT PetscLogPrintInfo;  /* if true, indicates PetscInfo() is turned on */
26614700edSBarry Smith 
27aa482453SBarry Smith #if defined(PETSC_USE_LOG)  /* --- Logging is turned on --------------------------------*/
28614700edSBarry Smith 
29da63de55SLois Curfman McInnes /*
30da63de55SLois Curfman McInnes    Flop counting:  We count each arithmetic operation (e.g., addition, multiplication) separately.
31da63de55SLois Curfman McInnes 
32da63de55SLois Curfman McInnes    For the complex numbers version, note that
33da63de55SLois Curfman McInnes        1 complex addition = 2 flops
34da63de55SLois Curfman McInnes        1 complex multiplication = 6 flops,
35da63de55SLois Curfman McInnes    where we define 1 flop as that for a double precision scalar.  We roughly approximate
36da63de55SLois Curfman McInnes    flop counting for complex numbers by multiplying the total flops by 4; this corresponds
37da63de55SLois Curfman McInnes    to the assumption that we're counting mostly additions and multiplications -- and
38da63de55SLois Curfman McInnes    roughly the same number of each.  More accurate counting could be done by distinguishing
39da63de55SLois Curfman McInnes    among the various arithmetic operations.
40da63de55SLois Curfman McInnes  */
41da63de55SLois Curfman McInnes 
42aa482453SBarry Smith #if defined(PETSC_USE_COMPLEX)
43b0a32e0cSBarry Smith #define PetscLogFlops(n) (_TotalFlops += (4*n),0)
44da63de55SLois Curfman McInnes #else
45b0a32e0cSBarry Smith #define PetscLogFlops(n) (_TotalFlops += (n),0)
46da63de55SLois Curfman McInnes #endif
4777c4ece6SBarry Smith 
48aa482453SBarry Smith #if defined (PETSC_HAVE_MPE)
4977c4ece6SBarry Smith #include "mpe.h"
50ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT        PetscLogMPEBegin(void);
51ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT        PetscLogMPEDump(const char[]);
5235d8aa7fSBarry Smith extern PetscTruth UseMPE;
53043328b6SSatish Balay #define PETSC_LOG_EVENT_MPE_BEGIN(e) \
54335e4f37SSatish Balay   ((UseMPE && _stageLog->stageInfo[_stageLog->curStage].eventLog->eventInfo[e].active) ? \
55a1b71033SSatish Balay    MPE_Log_event(_stageLog->eventLog->eventInfo[e].mpe_id_begin,0,NULL) : 0)
56043328b6SSatish Balay 
57043328b6SSatish Balay #define PETSC_LOG_EVENT_MPE_END(e) \
58335e4f37SSatish Balay   ((UseMPE && _stageLog->stageInfo[_stageLog->curStage].eventLog->eventInfo[e].active) ? \
59a1b71033SSatish Balay    MPE_Log_event(_stageLog->eventLog->eventInfo[e].mpe_id_end,0,NULL) : 0)
60043328b6SSatish Balay 
61614700edSBarry Smith #else
6252e6d16bSBarry Smith #define PETSC_LOG_EVENT_MPE_BEGIN(e) 0
6352e6d16bSBarry Smith #define PETSC_LOG_EVENT_MPE_END(e)   0
6477c4ece6SBarry Smith #endif
6577c4ece6SBarry Smith 
66ff73aad6SKris Buschelman EXTERN PETSC_DLLEXPORT PetscErrorCode (*_PetscLogPLB)(PetscEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
67ff73aad6SKris Buschelman EXTERN PETSC_DLLEXPORT PetscErrorCode (*_PetscLogPLE)(PetscEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
68ff73aad6SKris Buschelman EXTERN PETSC_DLLEXPORT PetscErrorCode (*_PetscLogPHC)(PetscObject);
69ff73aad6SKris Buschelman EXTERN PETSC_DLLEXPORT PetscErrorCode (*_PetscLogPHD)(PetscObject);
7077c4ece6SBarry Smith 
71043328b6SSatish Balay #define PetscLogObjectParent(p,c) \
7252e6d16bSBarry Smith   ((c && p) ? ((PetscObject)(c))->parent = (PetscObject)(p),((PetscObject)(c))->parentid = ((PetscObject)p)->id : 0, 0)
7352e6d16bSBarry Smith 
74efee365bSSatish Balay #define PetscLogObjectParents(p,n,d)  0;{int _i; for (_i=0; _i<n; _i++) {ierr = PetscLogObjectParent(p,(d)[_i]);CHKERRQ(ierr);}}
75d38fa0fbSBarry Smith #define PetscLogObjectCreate(h)      ((_PetscLogPHC) ? (*_PetscLogPHC)((PetscObject)h) : 0)
76d38fa0fbSBarry Smith #define PetscLogObjectDestroy(h)     ((_PetscLogPHD) ? (*_PetscLogPHD)((PetscObject)h) : 0)
7752e6d16bSBarry Smith #define PetscLogObjectMemory(p,m)    (((PetscObject)(p))->mem += (m),0)
788ba1e511SMatthew Knepley /* Initialization functions */
79ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogBegin(void);
80ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogAllBegin(void);
81ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogTraceBegin(FILE *);
82ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogActions(PetscTruth);
83ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogObjects(PetscTruth);
848ba1e511SMatthew Knepley /* General functions */
85ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogGetRGBColor(const char*[]);
86ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogDestroy(void);
87ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogSet(PetscErrorCode (*)(int, int, PetscObject, PetscObject, PetscObject, PetscObject),
886849ba73SBarry Smith                    PetscErrorCode (*)(int, int, PetscObject, PetscObject, PetscObject, PetscObject));
89ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogObjectState(PetscObject, const char[], ...)  PETSC_PRINTF_FORMAT_CHECK(2,3);
908ba1e511SMatthew Knepley /* Output functions */
91ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogPrintSummary(MPI_Comm, const char[]);
92ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogDump(const char[]);
938ba1e511SMatthew Knepley /* Counter functions */
94ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscGetFlops(PetscLogDouble *);
958ba1e511SMatthew Knepley /* Stage functions */
96ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStageRegister(int*, const char[]);
97ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStagePush(int);
98ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStagePop(void);
99ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStageSetActive(int, PetscTruth);
100ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStageGetActive(int, PetscTruth *);
101ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStageSetVisible(int, PetscTruth);
102ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStageGetVisible(int, PetscTruth *);
103ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogStageGetId(const char [], int *);
1048ba1e511SMatthew Knepley /* Event functions */
105ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogEventRegister(PetscEvent*, const char[], PetscCookie);
106ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogEventActivate(PetscEvent);
107ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogEventDeactivate(PetscEvent);
108ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogEventSetActiveAll(PetscEvent, PetscTruth);
109ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogEventActivateClass(PetscCookie);
110ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogEventDeactivateClass(PetscCookie);
1118ba1e511SMatthew Knepley /* Class functions */
112ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogClassRegister(PetscCookie*, const char []);
1138ba1e511SMatthew Knepley 
1148ba1e511SMatthew Knepley /* Global counters */
115ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble irecv_ct;
116ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble isend_ct;
117ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble recv_ct;
118ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble send_ct;
119ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble irecv_len;
120ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble isend_len;
121ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble recv_len;
122ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble send_len;
123ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble allreduce_ct;
124ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble wait_ct;
125ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble wait_any_ct;
126ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble wait_all_ct;
127ff73aad6SKris Buschelman extern PETSC_DLLEXPORT PetscLogDouble sum_of_waits_ct;
128ff73aad6SKris Buschelman extern PETSC_DLLEXPORT int            PETSC_DUMMY_SIZE;
129ff73aad6SKris Buschelman extern PETSC_DLLEXPORT int            PETSC_DUMMY_COUNT;
1308ba1e511SMatthew Knepley 
1318ba1e511SMatthew Knepley /* We must make these structures available if we are to access the event
1328ba1e511SMatthew Knepley    activation flags in the PetscLogEventBegin/End() macros. If we forced a
133f621e05eSBarry Smith    function call each time, we could make these private.
1348ba1e511SMatthew Knepley */
135e855f6f8SMatthew Knepley /* Default log */
13695fbd943SSatish Balay typedef struct _n_StageLog *StageLog;
137ff73aad6SKris Buschelman extern PETSC_DLLEXPORT StageLog _stageLog;
138e855f6f8SMatthew Knepley 
139e855f6f8SMatthew Knepley /* A simple stack (should replace) */
14095fbd943SSatish Balay typedef struct _n_IntStack *IntStack;
141e855f6f8SMatthew Knepley 
142e855f6f8SMatthew Knepley /* The structures for logging performance */
143af80a1fbSMatthew Knepley typedef struct _EventPerfInfo {
144e855f6f8SMatthew Knepley   int            id;            /* The integer identifying this section */
145800883a5SMatthew Knepley   PetscTruth     active;        /* The flag to activate logging */
146800883a5SMatthew Knepley   PetscTruth     visible;       /* The flag to print info in summary */
1478ba1e511SMatthew Knepley   int            depth;         /* The nesting depth of the event call */
1488ba1e511SMatthew Knepley   int            count;         /* The number of times this section was executed */
1498ba1e511SMatthew Knepley   PetscLogDouble flops;         /* The flops used in this section */
1508ba1e511SMatthew Knepley   PetscLogDouble time;          /* The time taken for this section */
1518ba1e511SMatthew Knepley   PetscLogDouble numMessages;   /* The number of messages in this section */
1528ba1e511SMatthew Knepley   PetscLogDouble messageLength; /* The total message lengths in this section */
1538ba1e511SMatthew Knepley   PetscLogDouble numReductions; /* The number of reductions in this section */
154af80a1fbSMatthew Knepley } EventPerfInfo;
1558ba1e511SMatthew Knepley 
156e855f6f8SMatthew Knepley typedef struct _ClassPerfInfo {
157e855f6f8SMatthew Knepley   int            id;           /* The integer identifying this class */
1588ba1e511SMatthew Knepley   int            creations;    /* The number of objects of this class created */
1598ba1e511SMatthew Knepley   int            destructions; /* The number of objects of this class destroyed */
1608ba1e511SMatthew Knepley   PetscLogDouble mem;          /* The total memory allocated by objects of this class */
1618ba1e511SMatthew Knepley   PetscLogDouble descMem;      /* The total memory allocated by descendents of these objects */
162e855f6f8SMatthew Knepley } ClassPerfInfo;
1638ba1e511SMatthew Knepley 
164e855f6f8SMatthew Knepley /* The structures for logging registration */
165e855f6f8SMatthew Knepley typedef struct _ClassRegInfo {
166e855f6f8SMatthew Knepley   char            *name;   /* The class name */
1676849ba73SBarry Smith   PetscCookie cookie; /* The integer identifying this class */
168e855f6f8SMatthew Knepley } ClassRegInfo;
169e855f6f8SMatthew Knepley 
170e855f6f8SMatthew Knepley typedef struct _EventRegInfo {
171e855f6f8SMatthew Knepley   char            *name;   /* The name of this event */
1726849ba73SBarry Smith   PetscCookie cookie; /* The class id for this event (should maybe give class ID instead) */
17344451550SSatish Balay #if defined (PETSC_HAVE_MPE)
17444451550SSatish Balay   int             mpe_id_begin; /* MPE IDs that define the event */
17544451550SSatish Balay   int             mpe_id_end;
17644451550SSatish Balay #endif
177e855f6f8SMatthew Knepley } EventRegInfo;
178e855f6f8SMatthew Knepley 
17995fbd943SSatish Balay typedef struct _n_EventRegLog *EventRegLog;
18095fbd943SSatish Balay struct _n_EventRegLog {
181e855f6f8SMatthew Knepley   int           numEvents; /* The number of registered events */
182e855f6f8SMatthew Knepley   int           maxEvents; /* The maximum number of events */
183e855f6f8SMatthew Knepley   EventRegInfo *eventInfo; /* The registration information for each event */
1848ba1e511SMatthew Knepley };
1858ba1e511SMatthew Knepley 
18695fbd943SSatish Balay typedef struct _n_EventPerfLog *EventPerfLog;
18795fbd943SSatish Balay struct _n_EventPerfLog {
188e855f6f8SMatthew Knepley   int            numEvents; /* The number of logging events */
189e855f6f8SMatthew Knepley   int            maxEvents; /* The maximum number of events */
190af80a1fbSMatthew Knepley   EventPerfInfo *eventInfo; /* The performance information for each event */
191e855f6f8SMatthew Knepley };
1928ba1e511SMatthew Knepley 
193e855f6f8SMatthew Knepley /* The structure for logging class information */
19495fbd943SSatish Balay typedef struct _n_ClassRegLog *ClassRegLog;
19595fbd943SSatish Balay struct _n_ClassRegLog {
196e855f6f8SMatthew Knepley   int           numClasses; /* The number of classes registered */
197e855f6f8SMatthew Knepley   int           maxClasses; /* The maximum number of classes */
198e855f6f8SMatthew Knepley   ClassRegInfo *classInfo;  /* The structure for class information (cookies are monotonicly increasing) */
199e855f6f8SMatthew Knepley };
200e855f6f8SMatthew Knepley 
20195fbd943SSatish Balay typedef struct _n_ClassPerfLog *ClassPerfLog;
20295fbd943SSatish Balay struct _n_ClassPerfLog {
203e855f6f8SMatthew Knepley   int            numClasses; /* The number of logging classes */
204e855f6f8SMatthew Knepley   int            maxClasses; /* The maximum number of classes */
205e855f6f8SMatthew Knepley   ClassPerfInfo *classInfo;  /* The structure for class information (cookies are monotonicly increasing) */
206e855f6f8SMatthew Knepley };
207e855f6f8SMatthew Knepley 
208e855f6f8SMatthew Knepley /* The structures for logging in stages */
209e855f6f8SMatthew Knepley typedef struct _StageInfo {
210e855f6f8SMatthew Knepley   char         *name;     /* The stage name */
211773a6509SMatthew Knepley   PetscTruth    used;     /* The stage was pushed on this processor */
212af80a1fbSMatthew Knepley   EventPerfInfo perfInfo; /* The stage performance information */
213e855f6f8SMatthew Knepley   EventPerfLog  eventLog; /* The event information for this stage */
214e855f6f8SMatthew Knepley   ClassPerfLog  classLog; /* The class information for this stage */
215e855f6f8SMatthew Knepley } StageInfo;
216e855f6f8SMatthew Knepley 
21795fbd943SSatish Balay struct _n_StageLog {
2188ba1e511SMatthew Knepley   /* Size information */
2198ba1e511SMatthew Knepley   int         numStages; /* The number of registered stages */
2208ba1e511SMatthew Knepley   int         maxStages; /* The maximum number of stages */
2218ba1e511SMatthew Knepley   /* Runtime information */
2228ba1e511SMatthew Knepley   IntStack    stack;     /* The stack for active stages */
2238ba1e511SMatthew Knepley   int         curStage;  /* The current stage (only used in macros so we don't call StackTop) */
2248ba1e511SMatthew Knepley   /* Stage specific information */
225e855f6f8SMatthew Knepley   StageInfo  *stageInfo; /* The information for each stage */
226e855f6f8SMatthew Knepley   EventRegLog eventLog;  /* The registered events */
227e855f6f8SMatthew Knepley   ClassRegLog classLog;  /* The registered classes */
2288ba1e511SMatthew Knepley };
2298ba1e511SMatthew Knepley 
23052e6d16bSBarry Smith #define PetscLogEventBarrierBegin(e,o1,o2,o3,o4,cm) \
23152e6d16bSBarry Smith   (((_PetscLogPLB && _stageLog->stageInfo[_stageLog->curStage].perfInfo.active &&  _stageLog->stageInfo[_stageLog->curStage].eventLog->eventInfo[e].active) ? \
23252e6d16bSBarry Smith     (PetscLogEventBegin((e),o1,o2,o3,o4) || MPI_Barrier(cm) || PetscLogEventEnd((e),o1,o2,o3,o4)) : 0 ) || \
23352e6d16bSBarry Smith    PetscLogEventBegin((e)+1,o1,o2,o3,o4))
23477c4ece6SBarry Smith 
23552e6d16bSBarry Smith #define PetscLogEventBegin(e,o1,o2,o3,o4) \
23652e6d16bSBarry Smith   (((_PetscLogPLB && _stageLog->stageInfo[_stageLog->curStage].perfInfo.active && _stageLog->stageInfo[_stageLog->curStage].eventLog->eventInfo[e].active) ? \
23752e6d16bSBarry Smith     (*_PetscLogPLB)((e),0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4)) : 0 ) || \
23852e6d16bSBarry Smith   PETSC_LOG_EVENT_MPE_BEGIN(e))
239043328b6SSatish Balay 
240b0a32e0cSBarry Smith #define PetscLogEventBarrierEnd(e,o1,o2,o3,o4,cm) PetscLogEventEnd(e+1,o1,o2,o3,o4)
241043328b6SSatish Balay 
24252e6d16bSBarry Smith #define PetscLogEventEnd(e,o1,o2,o3,o4) \
24352e6d16bSBarry Smith   (((_PetscLogPLE && _stageLog->stageInfo[_stageLog->curStage].perfInfo.active && _stageLog->stageInfo[_stageLog->curStage].eventLog->eventInfo[e].active) ? \
24452e6d16bSBarry Smith     (*_PetscLogPLE)((e),0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4)) : 0 ) || \
24552e6d16bSBarry Smith   PETSC_LOG_EVENT_MPE_END(e))
24677c4ece6SBarry Smith 
247f141ce34SMatthew Knepley /* Creation and destruction functions */
248ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogCreate(StageLog *);
249ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogDestroy(StageLog);
250f141ce34SMatthew Knepley /* Registration functions */
251ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogRegister(StageLog, const char [], int *);
252f141ce34SMatthew Knepley /* Runtime functions */
253ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogGetStageLog(StageLog *);
254ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogPush(StageLog, int);
255ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogPop(StageLog);
256ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetCurrent(StageLog, int *);
257ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogSetActive(StageLog, int, PetscTruth);
258ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetActive(StageLog, int, PetscTruth *);
259ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogSetVisible(StageLog, int, PetscTruth);
260ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetVisible(StageLog, int, PetscTruth *);
261ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetStage(StageLog, const char [], int *);
262ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetClassRegLog(StageLog, ClassRegLog *);
263ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetEventRegLog(StageLog, EventRegLog *);
264ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetClassPerfLog(StageLog, int, ClassPerfLog *);
265ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT StageLogGetEventPerfLog(StageLog, int, EventPerfLog *);
266f141ce34SMatthew Knepley 
267ce85283eSBarry Smith /*
268f621e05eSBarry Smith      These are used internally in the PETSc routines to keep a count of MPI messages and
269f621e05eSBarry Smith    their sizes.
270f621e05eSBarry Smith 
2713c94ec11SBarry Smith      This does not work for MPI-Uni because our include/mpiuni/mpi.h file
272ce85283eSBarry Smith    uses macros to defined the MPI operations.
27315308354SBarry Smith 
27415308354SBarry Smith      It does not work correctly from HP-UX because it processes the
275bb4af37aSBarry Smith    macros in a way that sometimes it double counts, hence
276b6410449SSatish Balay    PETSC_HAVE_BROKEN_RECURSIVE_MACRO
2777c1e34a4SSatish Balay 
278f569fd43SBarry Smith      It does not work with Windows because winmpich lacks MPI_Type_size()
279ce85283eSBarry Smith */
280f35a08a5SSatish Balay #if !defined(_petsc_mpi_uni) && !defined(PETSC_HAVE_BROKEN_RECURSIVE_MACRO) && !defined (PETSC_HAVE_MPI_MISSING_TYPESIZE)
28177a39924SBarry Smith /*
28277a39924SBarry Smith    Logging of MPI activities
28377a39924SBarry Smith */
28477a39924SBarry Smith #define TypeSize(buff,count,type) \
2855e3723c6SSatish Balay  (MPI_Type_size(type,&PETSC_DUMMY_SIZE) || (buff += (PetscLogDouble) ((count)*PETSC_DUMMY_SIZE),0))
28677a39924SBarry Smith 
28777a39924SBarry Smith #define MPI_Irecv(buf,count,datatype,source,tag,comm,request) \
2885e3723c6SSatish 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))
28915308354SBarry Smith 
29077a39924SBarry Smith #define MPI_Isend(buf,count,datatype,dest,tag,comm,request) \
2915e3723c6SSatish 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))
29215308354SBarry Smith 
2930d4b0b6cSBarry Smith #define MPI_Startall_irecv(count,number,requests) \
2945e3723c6SSatish Balay  ((irecv_ct += (PetscLogDouble)(number),0) || TypeSize(irecv_len,count,MPIU_SCALAR) || MPI_Startall(number,requests))
2950d4b0b6cSBarry Smith 
2960d4b0b6cSBarry Smith #define MPI_Startall_isend(count,number,requests) \
2975e3723c6SSatish Balay  ((isend_ct += (PetscLogDouble)(number),0) || TypeSize(isend_len,count,MPIU_SCALAR) || MPI_Startall(number,requests))
2980d4b0b6cSBarry Smith 
2990d4b0b6cSBarry Smith #define MPI_Start_isend(count,requests) \
3005e3723c6SSatish Balay  ((isend_ct++,0) || TypeSize(isend_len,count,MPIU_SCALAR) || MPI_Start(requests))
3010d4b0b6cSBarry Smith 
302ce85283eSBarry Smith #define MPI_Recv(buf,count,datatype,source,tag,comm,status) \
3035e3723c6SSatish 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))
30415308354SBarry Smith 
30577a39924SBarry Smith #define MPI_Send(buf,count,datatype,dest,tag,comm) \
3065e3723c6SSatish 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))
30777a39924SBarry Smith 
30877a39924SBarry Smith #define MPI_Wait(request,status) \
3095e3723c6SSatish Balay  ((wait_ct++,sum_of_waits_ct++,0) || MPI_Wait(request,status))
31077a39924SBarry Smith 
31177a39924SBarry Smith #define MPI_Waitany(a,b,c,d) \
3125e3723c6SSatish Balay  ((wait_any_ct++,sum_of_waits_ct++,0) || MPI_Waitany(a,b,c,d))
31377a39924SBarry Smith 
31477a39924SBarry Smith #define MPI_Waitall(count,array_of_requests,array_of_statuses) \
3155e3723c6SSatish 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))
31677a39924SBarry Smith 
31777a39924SBarry Smith #define MPI_Allreduce(sendbuf,recvbuf,count,datatype,op,comm) \
3185e3723c6SSatish Balay  ((allreduce_ct++,0) || MPI_Allreduce(sendbuf,recvbuf,count,datatype,op,comm))
3193914022bSBarry Smith 
3200d4b0b6cSBarry Smith #else
3210d4b0b6cSBarry Smith 
3220d4b0b6cSBarry Smith #define MPI_Startall_irecv(count,number,requests) \
3235e3723c6SSatish Balay  (MPI_Startall(number,requests))
3240d4b0b6cSBarry Smith 
3250d4b0b6cSBarry Smith #define MPI_Startall_isend(count,number,requests) \
3265e3723c6SSatish Balay  (MPI_Startall(number,requests))
3270d4b0b6cSBarry Smith 
3280d4b0b6cSBarry Smith #define MPI_Start_isend(count,requests) \
3295e3723c6SSatish Balay  (MPI_Start(requests))
3300d4b0b6cSBarry Smith 
331f35a08a5SSatish Balay #endif /* !_petsc_mpi_uni && ! PETSC_HAVE_BROKEN_RECURSIVE_MACRO */
332614700edSBarry Smith 
333df8cf0b5SBarry Smith #else  /* ---Logging is turned off --------------------------------------------*/
334614700edSBarry Smith 
335b0a32e0cSBarry Smith #define PetscLogFlops(n) 0
336614700edSBarry Smith 
337df8cf0b5SBarry Smith /*
338df8cf0b5SBarry Smith      With logging turned off, then MPE has to be turned off
339df8cf0b5SBarry Smith */
340b0a32e0cSBarry Smith #define PetscLogMPEBegin()         0
341b0a32e0cSBarry Smith #define PetscLogMPEDump(a)         0
342614700edSBarry Smith 
343b0a32e0cSBarry Smith #define PetscLogEventActivate(a)   0
344b0a32e0cSBarry Smith #define PetscLogEventDeactivate(a) 0
345614700edSBarry Smith 
346b0a32e0cSBarry Smith #define PetscLogEventActivateClass(a)   0
347b0a32e0cSBarry Smith #define PetscLogEventDeactivateClass(a) 0
34861867fcfSSatish Balay #define PetscLogClassRegister(a,b)      PetscCookieRegister(a)
349e8e7597cSSatish Balay #define PetscLogEventSetActiveAll(a,b)  0
35077c4ece6SBarry Smith 
351b0a32e0cSBarry Smith #define _PetscLogPLB                        0
352b0a32e0cSBarry Smith #define _PetscLogPLE                        0
353b0a32e0cSBarry Smith #define _PetscLogPHC                        0
354b0a32e0cSBarry Smith #define _PetscLogPHD                        0
35599de4ba8SSatish Balay #define PetscGetFlops(a)                (*(a) = 0.0,0)
356b0a32e0cSBarry Smith #define PetscLogEventBegin(e,o1,o2,o3,o4)   0
357b0a32e0cSBarry Smith #define PetscLogEventEnd(e,o1,o2,o3,o4)     0
358b0a32e0cSBarry Smith #define PetscLogEventBarrierBegin(e,o1,o2,o3,o4,cm) 0
359b0a32e0cSBarry Smith #define PetscLogEventBarrierEnd(e,o1,o2,o3,o4,cm)   0
36052e6d16bSBarry Smith #define PetscLogObjectParent(p,c)           0
361efee365bSSatish Balay #define PetscLogObjectParents(p,n,c)        0
36252e6d16bSBarry Smith #define PetscLogObjectCreate(h)             0
36352e6d16bSBarry Smith #define PetscLogObjectDestroy(h)            0
36452e6d16bSBarry Smith #define PetscLogObjectMemory(p,m)           0
365b0a32e0cSBarry Smith #define PetscLogDestroy()                   0
366b0a32e0cSBarry Smith #define PetscLogStagePush(a)                0
367b0a32e0cSBarry Smith #define PetscLogStagePop()                  0
368b0a32e0cSBarry Smith #define PetscLogStageRegister(a,b)          0
369b0a32e0cSBarry Smith #define PetscLogStagePrint(a,flg)           0
370b0a32e0cSBarry Smith #define PetscLogPrintSummary(comm,file)     0
371b0a32e0cSBarry Smith #define PetscLogBegin()                     0
372b0a32e0cSBarry Smith #define PetscLogTraceBegin(file)            0
373b0a32e0cSBarry Smith #define PetscLogSet(lb,le)                  0
374b0a32e0cSBarry Smith #define PetscLogAllBegin()                  0
375b0a32e0cSBarry Smith #define PetscLogDump(c)                     0
376043328b6SSatish Balay #define PetscLogEventRegister(a,b,c)        0
37773fda44aSBarry Smith #define PetscLogObjects(a)                  0
37873fda44aSBarry Smith #define PetscLogActions(a)                  0
379ff73aad6SKris Buschelman EXTERN PetscErrorCode PETSC_DLLEXPORT PetscLogObjectState(PetscObject,const char[],...) PETSC_PRINTF_FORMAT_CHECK(2,3);
380ce6058e1SBarry Smith 
381aa482453SBarry Smith /* If PETSC_USE_LOG is NOT defined, these still need to be! */
382ca161407SBarry Smith #define MPI_Startall_irecv(count,number,requests) MPI_Startall(number,requests)
383ca161407SBarry Smith #define MPI_Startall_isend(count,number,requests) MPI_Startall(number,requests)
384ca161407SBarry Smith #define MPI_Start_isend(count,requests) MPI_Start(requests)
385ca161407SBarry Smith 
386f141ce34SMatthew Knepley /* Creation and destruction functions */
387f141ce34SMatthew Knepley #define StageLogCreate(stageLog)                     0
388f141ce34SMatthew Knepley #define StageLogDestroy(stageLog)                    0
389f141ce34SMatthew Knepley /* Registration functions */
390f141ce34SMatthew Knepley #define StageLogRegister(stageLog, name, stage)      0
391f141ce34SMatthew Knepley /* Runtime functions */
392f141ce34SMatthew Knepley #define PetscLogGetStageLog(stageLog)                0
393f141ce34SMatthew Knepley #define StageLogPush(stageLog, stage)                0
394f141ce34SMatthew Knepley #define StageLogPop(stageLog)                        0
395f141ce34SMatthew Knepley #define StageLogGetCurrent(stageLog, stage)          0
396f141ce34SMatthew Knepley #define StageLogSetActive(stageLog, stage, active)   0
397f141ce34SMatthew Knepley #define StageLogGetActive(stageLog, stage, active)   0
398f141ce34SMatthew Knepley #define StageLogSetVisible(stageLog, stage, visible) 0
399f141ce34SMatthew Knepley #define StageLogGetVisible(stageLog, stage, visible) 0
400f141ce34SMatthew Knepley #define StageLogGetStage(stageLog, name, stage)      0
401fad68dfaSSatish Balay #define PetscLogStageGetId(a,b)                      (*(b)=0,0)
402fad68dfaSSatish Balay #define PetscLogStageSetActive(a,b)                  0
403f141ce34SMatthew Knepley 
404aa482453SBarry Smith #endif   /* PETSC_USE_LOG */
4056daaf66cSBarry Smith 
406043328b6SSatish Balay #define PreLoadBegin(flag,name) \
407043328b6SSatish Balay {\
408c4411e17SBarry Smith   PetscTruth PreLoading = flag;\
4098e58c17dSMatthew Knepley   int        PreLoadMax,PreLoadIt,_stageNum,_3_ierr;\
4104dc4c822SBarry Smith   _3_ierr = PetscOptionsGetTruth(PETSC_NULL,"-preload",&PreLoading,PETSC_NULL);CHKERRQ(_3_ierr);\
411043328b6SSatish Balay   PreLoadMax = (int)(PreLoading);\
412043328b6SSatish Balay   PetscPreLoadingUsed = PreLoading ? PETSC_TRUE : PetscPreLoadingUsed;\
413e7592fafSBarry Smith   for (PreLoadIt=0; PreLoadIt<=PreLoadMax; PreLoadIt++) {\
414435da068SBarry Smith     PetscPreLoadingOn = PreLoading;\
4156e491fe6SBarry Smith     _3_ierr = PetscBarrier(PETSC_NULL);CHKERRQ(_3_ierr);\
4168e58c17dSMatthew Knepley     if (PreLoadIt>0) {\
4178e58c17dSMatthew Knepley       _3_ierr = PetscLogStageGetId(name,&_stageNum);CHKERRQ(_3_ierr);\
4188e58c17dSMatthew Knepley     } else {\
4198e58c17dSMatthew Knepley       _3_ierr = PetscLogStageRegister(&_stageNum,name);CHKERRQ(_3_ierr);\
4208e58c17dSMatthew Knepley     }\
421773a6509SMatthew Knepley     _3_ierr = PetscLogStageSetActive(_stageNum,(PetscTruth)(!PreLoadMax || PreLoadIt));\
4228e58c17dSMatthew Knepley     _3_ierr = PetscLogStagePush(_stageNum);CHKERRQ(_3_ierr);
4238e58c17dSMatthew Knepley 
424043328b6SSatish Balay #define PreLoadEnd() \
425043328b6SSatish Balay     _3_ierr = PetscLogStagePop();CHKERRQ(_3_ierr);\
426043328b6SSatish Balay     PreLoading = PETSC_FALSE;\
427043328b6SSatish Balay   }\
428043328b6SSatish Balay }
4298e58c17dSMatthew Knepley 
430043328b6SSatish Balay #define PreLoadStage(name) \
431043328b6SSatish Balay   _3_ierr = PetscLogStagePop();CHKERRQ(_3_ierr);\
4328e58c17dSMatthew Knepley   if (PreLoadIt>0) {\
4338e58c17dSMatthew Knepley     _3_ierr = PetscLogStageGetId(name,&_stageNum);CHKERRQ(_3_ierr);\
4348e58c17dSMatthew Knepley   } else {\
4358e58c17dSMatthew Knepley     _3_ierr = PetscLogStageRegister(&_stageNum,name);CHKERRQ(_3_ierr);\
4368e58c17dSMatthew Knepley   }\
437773a6509SMatthew Knepley   _3_ierr = PetscLogStageSetActive(_stageNum,(PetscTruth)(!PreLoadMax || PreLoadIt));\
4388e58c17dSMatthew Knepley   _3_ierr = PetscLogStagePush(_stageNum);CHKERRQ(_3_ierr);
439e9fa29b7SSatish Balay 
440e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END
44197bb86f7SLois Curfman McInnes #endif
442