xref: /petsc/include/petsclog.h (revision 217044c2fa7ae23423a3a4756ec431a235346ff3)
1 /*
2     Defines profile/logging in PETSc.
3 */
4 
5 #if !defined(__PetscLog_H)
6 #define __PetscLog_H
7 #include <petscsys.h>
8 
9 /*MC
10     PetscLogEvent - id used to identify PETSc or user events which timed portions (blocks of executable)
11      code.
12 
13     Level: intermediate
14 
15 .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStage
16 M*/
17 typedef int PetscLogEvent;
18 
19 /*MC
20     PetscLogStage - id used to identify user stages (phases, sections) of runs - for logging
21 
22     Level: intermediate
23 
24 .seealso: PetscLogStageRegister(), PetscLogStagePush(), PetscLogStagePop(), PetscLogEvent
25 M*/
26 typedef int PetscLogStage;
27 
28 #define PETSC_EVENT  1311311
29 PETSC_EXTERN PetscLogEvent PETSC_LARGEST_EVENT;
30 
31 /* Global flop counter */
32 PETSC_EXTERN PetscLogDouble petsc_TotalFlops;
33 PETSC_EXTERN PetscLogDouble petsc_tmp_flops;
34 
35 /* General logging of information; different from event logging */
36 PETSC_EXTERN PetscErrorCode PetscInfo_Private(const char[],void*,const char[],...);
37 #if defined(PETSC_USE_INFO)
38 #define PetscInfo(A,S)                       PetscInfo_Private(PETSC_FUNCTION_NAME,A,S)
39 #define PetscInfo1(A,S,a1)                   PetscInfo_Private(PETSC_FUNCTION_NAME,A,S,a1)
40 #define PetscInfo2(A,S,a1,a2)                PetscInfo_Private(PETSC_FUNCTION_NAME,A,S,a1,a2)
41 #define PetscInfo3(A,S,a1,a2,a3)             PetscInfo_Private(PETSC_FUNCTION_NAME,A,S,a1,a2,a3)
42 #define PetscInfo4(A,S,a1,a2,a3,a4)          PetscInfo_Private(PETSC_FUNCTION_NAME,A,S,a1,a2,a3,a4)
43 #define PetscInfo5(A,S,a1,a2,a3,a4,a5)       PetscInfo_Private(PETSC_FUNCTION_NAME,A,S,a1,a2,a3,a4,a5)
44 #define PetscInfo6(A,S,a1,a2,a3,a4,a5,a6)    PetscInfo_Private(PETSC_FUNCTION_NAME,A,S,a1,a2,a3,a4,a5,a6)
45 #define PetscInfo7(A,S,a1,a2,a3,a4,a5,a6,a7) PetscInfo_Private(PETSC_FUNCTION_NAME,A,S,a1,a2,a3,a4,a5,a6,a7)
46 #else
47 #define PetscInfo(A,S)                       0
48 #define PetscInfo1(A,S,a1)                   0
49 #define PetscInfo2(A,S,a1,a2)                0
50 #define PetscInfo3(A,S,a1,a2,a3)             0
51 #define PetscInfo4(A,S,a1,a2,a3,a4)          0
52 #define PetscInfo5(A,S,a1,a2,a3,a4,a5)       0
53 #define PetscInfo6(A,S,a1,a2,a3,a4,a5,a6)    0
54 #define PetscInfo7(A,S,a1,a2,a3,a4,a5,a6,a7) 0
55 #endif
56 PETSC_EXTERN PetscErrorCode PetscInfoDeactivateClass(PetscClassId);
57 PETSC_EXTERN PetscErrorCode PetscInfoActivateClass(PetscClassId);
58 PETSC_EXTERN PetscBool PetscLogPrintInfo;  /* if true, indicates PetscInfo() is turned on */
59 
60 /* We must make the following structures available to access the event
61      activation flags in the PetscLogEventBegin/End() macros. These are not part of the PETSc public
62      API and are not intended to be used by other parts of PETSc or by users.
63 
64      The code that manipulates these structures is in src/sys/plog/utils.
65 */
66 typedef struct _n_PetscIntStack *PetscIntStack;
67 
68 /* -----------------------------------------------------------------------------------------------------*/
69 /*
70     PetscClassRegInfo, PetscClassPerfInfo - Each class has two data structures associated with it. The first has
71        static information about it, the second collects statistics on how many objects of the class are created,
72        how much memory they use, etc.
73 
74     PetscClassRegLog, PetscClassPerfLog - arrays of the PetscClassRegInfo and PetscClassPerfInfo for all classes.
75 */
76 typedef struct  {
77   char           *name;   /* The class name */
78   PetscClassId   classid; /* The integer identifying this class */
79 } PetscClassRegInfo;
80 
81 typedef struct {
82   PetscClassId   id;           /* The integer identifying this class */
83   int            creations;    /* The number of objects of this class created */
84   int            destructions; /* The number of objects of this class destroyed */
85   PetscLogDouble mem;          /* The total memory allocated by objects of this class */
86   PetscLogDouble descMem;      /* The total memory allocated by descendents of these objects */
87 } PetscClassPerfInfo;
88 
89 typedef struct _n_PetscClassRegLog *PetscClassRegLog;
90 struct _n_PetscClassRegLog {
91   int               numClasses; /* The number of classes registered */
92   int               maxClasses; /* The maximum number of classes */
93   PetscClassRegInfo *classInfo; /* The structure for class information (classids are monotonicly increasing) */
94 };
95 
96 typedef struct _n_PetscClassPerfLog *PetscClassPerfLog;
97 struct _n_PetscClassPerfLog {
98   int                numClasses; /* The number of logging classes */
99   int                maxClasses; /* The maximum number of classes */
100   PetscClassPerfInfo *classInfo; /* The structure for class information (classids are monotonicly increasing) */
101 };
102 /* -----------------------------------------------------------------------------------------------------*/
103 /*
104     PetscEventRegInfo, PetscEventPerfInfo - Each event has two data structures associated with it. The first has
105        static information about it, the second collects statistics on how many times the event is used, how
106        much time it takes, etc.
107 
108     PetscEventRegLog, PetscEventPerfLog - an array of all PetscEventRegInfo and PetscEventPerfInfo for all events. There is one
109       of these for each stage.
110 
111 */
112 typedef struct {
113   char         *name;         /* The name of this event */
114   PetscClassId classid;       /* The class the event is associated with */
115   PetscBool    collective;    /* Flag this event as collective */
116 #if defined (PETSC_HAVE_MPE)
117   int          mpe_id_begin; /* MPE IDs that define the event */
118   int          mpe_id_end;
119 #endif
120 } PetscEventRegInfo;
121 
122 typedef struct {
123   int            id;            /* The integer identifying this event */
124   PetscBool      active;        /* The flag to activate logging */
125   PetscBool      visible;       /* The flag to print info in summary */
126   int            depth;         /* The nesting depth of the event call */
127   int            count;         /* The number of times this event was executed */
128   PetscLogDouble flops, flops2, flopsTmp; /* The flops and flops^2 used in this event */
129   PetscLogDouble time, time2, timeTmp;    /* The time and time^2 taken for this event */
130   PetscLogDouble syncTime;                /* The synchronization barrier time */
131   PetscLogDouble numMessages;   /* The number of messages in this event */
132   PetscLogDouble messageLength; /* The total message lengths in this event */
133   PetscLogDouble numReductions; /* The number of reductions in this event */
134 } PetscEventPerfInfo;
135 
136 typedef struct _n_PetscEventRegLog *PetscEventRegLog;
137 struct _n_PetscEventRegLog {
138   int               numEvents;  /* The number of registered events */
139   int               maxEvents;  /* The maximum number of events */
140   PetscEventRegInfo *eventInfo; /* The registration information for each event */
141 };
142 
143 typedef struct _n_PetscEventPerfLog *PetscEventPerfLog;
144 struct _n_PetscEventPerfLog {
145   int                numEvents;  /* The number of logging events */
146   int                maxEvents;  /* The maximum number of events */
147   PetscEventPerfInfo *eventInfo; /* The performance information for each event */
148 };
149 /* ------------------------------------------------------------------------------------------------------------*/
150 /*
151    PetscStageInfo - Contains all the information about a particular stage.
152 
153    PetscStageLog - An array of PetscStageInfo for each registered stage. There is a single one of these in the code.
154 */
155 typedef struct _PetscStageInfo {
156   char               *name;     /* The stage name */
157   PetscBool          used;      /* The stage was pushed on this processor */
158   PetscEventPerfInfo perfInfo;  /* The stage performance information */
159   PetscEventPerfLog  eventLog;  /* The event information for this stage */
160   PetscClassPerfLog  classLog;  /* The class information for this stage */
161 } PetscStageInfo;
162 
163 typedef struct _n_PetscStageLog *PetscStageLog;
164 struct _n_PetscStageLog {
165   int              numStages;   /* The number of registered stages */
166   int              maxStages;   /* The maximum number of stages */
167   PetscIntStack    stack;       /* The stack for active stages */
168   int              curStage;    /* The current stage (only used in macros so we don't call PetscIntStackTop) */
169   PetscStageInfo   *stageInfo;  /* The information for each stage */
170   PetscEventRegLog eventLog;    /* The registered events */
171   PetscClassRegLog classLog;    /* The registered classes */
172 };
173 /* -----------------------------------------------------------------------------------------------------*/
174 
175 PETSC_EXTERN PetscErrorCode PetscLogGetStageLog(PetscStageLog*);
176 PETSC_EXTERN PetscErrorCode PetscStageLogGetCurrent(PetscStageLog,int*);
177 PETSC_EXTERN PetscErrorCode PetscStageLogGetEventPerfLog(PetscStageLog,int,PetscEventPerfLog*);
178 
179 PETSC_EXTERN PetscErrorCode PetscLogObjectParent(PetscObject,PetscObject);
180 PETSC_EXTERN PetscErrorCode PetscLogObjectMemory(PetscObject,PetscLogDouble);
181 
182 
183 #if defined(PETSC_USE_LOG)  /* --- Logging is turned on --------------------------------*/
184 PETSC_EXTERN PetscStageLog petsc_stageLog;
185 
186 /*
187    Flop counting:  We count each arithmetic operation (e.g., addition, multiplication) separately.
188 
189    For the complex numbers version, note that
190        1 complex addition = 2 flops
191        1 complex multiplication = 6 flops,
192    where we define 1 flop as that for a double precision scalar.  We roughly approximate
193    flop counting for complex numbers by multiplying the total flops by 4; this corresponds
194    to the assumption that we're counting mostly additions and multiplications -- and
195    roughly the same number of each.  More accurate counting could be done by distinguishing
196    among the various arithmetic operations.
197  */
198 
199 #if defined(PETSC_USE_COMPLEX)
200 #define PETSC_FLOPS_PER_OP 4.0
201 #else
202 #define PETSC_FLOPS_PER_OP 1.0
203 #endif
204 
205 PETSC_STATIC_INLINE PetscErrorCode PetscLogFlops(PetscLogDouble n)
206 {
207   PetscFunctionBegin;
208 #if defined(PETSC_USE_DEBUG)
209   if (n < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Cannot log negative flops");
210 #endif
211   petsc_TotalFlops += PETSC_FLOPS_PER_OP*n;
212   PetscFunctionReturn(0);
213 }
214 PETSC_EXTERN PetscErrorCode PetscLogSetThreshold(PetscLogDouble,PetscLogDouble*);
215 
216 #if defined (PETSC_HAVE_MPE)
217 PETSC_EXTERN PetscErrorCode PetscLogMPEBegin(void);
218 PETSC_EXTERN PetscErrorCode PetscLogMPEDump(const char[]);
219 #endif
220 
221 PETSC_EXTERN PetscErrorCode (*PetscLogPLB)(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
222 PETSC_EXTERN PetscErrorCode (*PetscLogPLE)(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
223 PETSC_EXTERN PetscErrorCode (*PetscLogPHC)(PetscObject);
224 PETSC_EXTERN PetscErrorCode (*PetscLogPHD)(PetscObject);
225 
226 #define PetscLogObjectParents(p,n,d)  0;{int _i; for (_i=0; _i<n; _i++) {ierr = PetscLogObjectParent((PetscObject)p,(PetscObject)(d)[_i]);CHKERRQ(ierr);}}
227 #define PetscLogObjectCreate(h)      ((PetscLogPHC) ? (*PetscLogPHC)((PetscObject)h) : 0)
228 #define PetscLogObjectDestroy(h)     ((PetscLogPHD) ? (*PetscLogPHD)((PetscObject)h) : 0)
229 /* Initialization functions */
230 PETSC_EXTERN PetscErrorCode PetscLogDefaultBegin(void);
231 PETSC_EXTERN PetscErrorCode PetscLogAllBegin(void);
232 PETSC_EXTERN PetscErrorCode PetscLogNestedBegin(void);
233 PETSC_EXTERN PetscErrorCode PetscLogTraceBegin(FILE *);
234 PETSC_EXTERN PetscErrorCode PetscLogActions(PetscBool);
235 PETSC_EXTERN PetscErrorCode PetscLogObjects(PetscBool);
236 
237 /* General functions */
238 PETSC_EXTERN PetscErrorCode PetscLogDestroy(void);
239 PETSC_EXTERN PetscErrorCode PetscLogSet(PetscErrorCode (*)(int, int, PetscObject, PetscObject, PetscObject, PetscObject),
240                                         PetscErrorCode (*)(int, int, PetscObject, PetscObject, PetscObject, PetscObject));
241 PETSC_EXTERN PetscErrorCode PetscLogObjectState(PetscObject, const char[], ...);
242 /* Output functions */
243 PETSC_EXTERN PetscErrorCode PetscLogView(PetscViewer);
244 PETSC_EXTERN PetscErrorCode PetscLogViewFromOptions(void);
245 PETSC_EXTERN PetscErrorCode PetscLogDump(const char[]);
246 
247 PETSC_EXTERN PetscErrorCode PetscGetFlops(PetscLogDouble *);
248 
249 PETSC_EXTERN PetscErrorCode PetscLogStageRegister(const char[],PetscLogStage*);
250 PETSC_EXTERN PetscErrorCode PetscLogStagePush(PetscLogStage);
251 PETSC_EXTERN PetscErrorCode PetscLogStagePop(void);
252 PETSC_EXTERN PetscErrorCode PetscLogStageSetActive(PetscLogStage, PetscBool );
253 PETSC_EXTERN PetscErrorCode PetscLogStageGetActive(PetscLogStage, PetscBool  *);
254 PETSC_EXTERN PetscErrorCode PetscLogStageSetVisible(PetscLogStage, PetscBool );
255 PETSC_EXTERN PetscErrorCode PetscLogStageGetVisible(PetscLogStage, PetscBool  *);
256 PETSC_EXTERN PetscErrorCode PetscLogStageGetId(const char [], PetscLogStage *);
257 /* Event functions */
258 PETSC_EXTERN PetscErrorCode PetscLogEventRegister(const char[], PetscClassId,PetscLogEvent*);
259 PETSC_EXTERN PetscErrorCode PetscLogEventSetCollective(PetscLogEvent,PetscBool);
260 PETSC_EXTERN PetscErrorCode PetscLogEventActivate(PetscLogEvent);
261 PETSC_EXTERN PetscErrorCode PetscLogEventDeactivate(PetscLogEvent);
262 PETSC_EXTERN PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent, PetscBool );
263 PETSC_EXTERN PetscErrorCode PetscLogEventActivateClass(PetscClassId);
264 PETSC_EXTERN PetscErrorCode PetscLogEventDeactivateClass(PetscClassId);
265 PETSC_EXTERN PetscErrorCode PetscLogEventGetId(const char[],PetscLogEvent*);
266 PETSC_EXTERN PetscErrorCode PetscLogEventGetPerfInfo(int, PetscLogEvent, PetscEventPerfInfo *);
267 
268 /* Global counters */
269 PETSC_EXTERN PetscLogDouble petsc_irecv_ct;
270 PETSC_EXTERN PetscLogDouble petsc_isend_ct;
271 PETSC_EXTERN PetscLogDouble petsc_recv_ct;
272 PETSC_EXTERN PetscLogDouble petsc_send_ct;
273 PETSC_EXTERN PetscLogDouble petsc_irecv_len;
274 PETSC_EXTERN PetscLogDouble petsc_isend_len;
275 PETSC_EXTERN PetscLogDouble petsc_recv_len;
276 PETSC_EXTERN PetscLogDouble petsc_send_len;
277 PETSC_EXTERN PetscLogDouble petsc_allreduce_ct;
278 PETSC_EXTERN PetscLogDouble petsc_gather_ct;
279 PETSC_EXTERN PetscLogDouble petsc_scatter_ct;
280 PETSC_EXTERN PetscLogDouble petsc_wait_ct;
281 PETSC_EXTERN PetscLogDouble petsc_wait_any_ct;
282 PETSC_EXTERN PetscLogDouble petsc_wait_all_ct;
283 PETSC_EXTERN PetscLogDouble petsc_sum_of_waits_ct;
284 
285 PETSC_EXTERN PetscBool PetscLogSyncOn;
286 
287 #define PetscLogEventBegin(e,o1,o2,o3,o4) \
288   (((PetscLogPLB && petsc_stageLog->stageInfo[petsc_stageLog->curStage].perfInfo.active && petsc_stageLog->stageInfo[petsc_stageLog->curStage].eventLog->eventInfo[e].active) ? \
289     (*PetscLogPLB)((e),0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4)) : 0 ))
290 
291 #define PetscLogEventEnd(e,o1,o2,o3,o4) \
292   (((PetscLogPLE && petsc_stageLog->stageInfo[petsc_stageLog->curStage].perfInfo.active && petsc_stageLog->stageInfo[petsc_stageLog->curStage].eventLog->eventInfo[e].active) ? \
293     (*PetscLogPLE)((e),0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4)) : 0 ))
294 
295 PETSC_EXTERN PetscErrorCode PetscLogEventGetFlops(PetscLogEvent, PetscLogDouble*);
296 PETSC_EXTERN PetscErrorCode PetscLogEventZeroFlops(PetscLogEvent);
297 
298 /*
299      These are used internally in the PETSc routines to keep a count of MPI messages and
300    their sizes.
301 
302      This does not work for MPI-Uni because our include/petsc/mpiuni/mpi.h file
303    uses macros to defined the MPI operations.
304 
305      It does not work correctly from HP-UX because it processes the
306    macros in a way that sometimes it double counts, hence
307    PETSC_HAVE_BROKEN_RECURSIVE_MACRO
308 
309      It does not work with Windows because winmpich lacks MPI_Type_size()
310 */
311 #if !defined(__MPIUNI_H) && !defined(PETSC_HAVE_BROKEN_RECURSIVE_MACRO) && !defined (PETSC_HAVE_MPI_MISSING_TYPESIZE)
312 /*
313    Logging of MPI activities
314 */
315 PETSC_STATIC_INLINE PetscErrorCode PetscMPITypeSize(PetscLogDouble *buff,PetscMPIInt count,MPI_Datatype type)
316 {
317   PetscMPIInt mysize;
318   PetscErrorCode _myierr;
319   if (type == MPI_DATATYPE_NULL) return 0;
320   _myierr = MPI_Type_size(type,&mysize);CHKERRQ(_myierr);
321   *buff += (PetscLogDouble) (count*mysize);
322   return 0;
323 }
324 
325 PETSC_STATIC_INLINE PetscErrorCode PetscMPITypeSizeComm(MPI_Comm comm, PetscLogDouble *buff,PetscMPIInt *counts,MPI_Datatype type)
326 {
327   PetscMPIInt mysize, commsize, p;
328   PetscErrorCode _myierr;
329 
330   if (type == MPI_DATATYPE_NULL) return 0;
331   _myierr = MPI_Comm_size(comm,&commsize);CHKERRQ(_myierr);
332   _myierr = MPI_Type_size(type,&mysize);CHKERRQ(_myierr);
333   for (p = 0; p < commsize; ++p) {
334     *buff += (PetscLogDouble) (counts[p]*mysize);
335   }
336   return 0;
337 }
338 
339 /*
340     Returns 1 if the communicator is parallel else zero
341 */
342 PETSC_STATIC_INLINE int PetscMPIParallelComm(MPI_Comm comm)
343 {
344   PetscMPIInt size; MPI_Comm_size(comm,&size); return size > 1;
345 }
346 
347 #define MPI_Irecv(buf,count,datatype,source,tag,comm,request) \
348   ((petsc_irecv_ct++,0) || PetscMPITypeSize(&(petsc_irecv_len),(count),(datatype)) || MPI_Irecv((buf),(count),(datatype),(source),(tag),(comm),(request)))
349 
350 #define MPI_Isend(buf,count,datatype,dest,tag,comm,request) \
351   ((petsc_isend_ct++,0) || PetscMPITypeSize(&(petsc_isend_len),(count),(datatype)) || MPI_Isend((buf),(count),(datatype),(dest),(tag),(comm),(request)))
352 
353 #define MPI_Startall_irecv(count,number,requests) \
354   ((petsc_irecv_ct += (PetscLogDouble)(number),0) || PetscMPITypeSize(&(petsc_irecv_len),(count),(MPIU_SCALAR)) || MPI_Startall((number),(requests)))
355 
356 #define MPI_Startall_isend(count,number,requests) \
357   ((petsc_isend_ct += (PetscLogDouble)(number),0) || PetscMPITypeSize(&(petsc_isend_len),(count),(MPIU_SCALAR)) || MPI_Startall((number),(requests)))
358 
359 #define MPI_Start_isend(count,requests) \
360   ((petsc_isend_ct++,0) || PetscMPITypeSize((&petsc_isend_len),(count),(MPIU_SCALAR)) || MPI_Start((requests)))
361 
362 #define MPI_Recv(buf,count,datatype,source,tag,comm,status) \
363   ((petsc_recv_ct++,0) || PetscMPITypeSize((&petsc_recv_len),(count),(datatype)) || MPI_Recv((buf),(count),(datatype),(source),(tag),(comm),(status)))
364 
365 #define MPI_Send(buf,count,datatype,dest,tag,comm) \
366   ((petsc_send_ct++,0) || PetscMPITypeSize((&petsc_send_len),(count),(datatype)) || MPI_Send((buf),(count),(datatype),(dest),(tag),(comm)))
367 
368 #define MPI_Wait(request,status) \
369   ((petsc_wait_ct++,petsc_sum_of_waits_ct++,0) || MPI_Wait((request),(status)))
370 
371 #define MPI_Waitany(a,b,c,d) \
372   ((petsc_wait_any_ct++,petsc_sum_of_waits_ct++,0) || MPI_Waitany((a),(b),(c),(d)))
373 
374 #define MPI_Waitall(count,array_of_requests,array_of_statuses) \
375   ((petsc_wait_all_ct++,petsc_sum_of_waits_ct += (PetscLogDouble) (count),0) || MPI_Waitall((count),(array_of_requests),(array_of_statuses)))
376 
377 #define MPI_Allreduce(sendbuf,recvbuf,count,datatype,op,comm) \
378   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || MPI_Allreduce((sendbuf),(recvbuf),(count),(datatype),(op),(comm)))
379 
380 #define MPI_Bcast(buffer,count,datatype,root,comm) \
381   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || MPI_Bcast((buffer),(count),(datatype),(root),(comm)))
382 
383 #define MPI_Reduce_scatter_block(sendbuf,recvbuf,recvcount,datatype,op,comm) \
384   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || MPI_Reduce_scatter_block((sendbuf),(recvbuf),(recvcount),(datatype),(op),(comm)))
385 
386 #define MPI_Alltoall(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm) \
387   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || PetscMPITypeSize((&petsc_send_len),(sendcount),(sendtype)) || MPI_Alltoall((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(comm)))
388 
389 #define MPI_Alltoallv(sendbuf,sendcnts,sdispls,sendtype,recvbuf,recvcnts,rdispls,recvtype,comm) \
390   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || PetscMPITypeSizeComm((comm),(&petsc_send_len),(sendcnts),(sendtype)) || MPI_Alltoallv((sendbuf),(sendcnts),(sdispls),(sendtype),(recvbuf),(recvcnts),(rdispls),(recvtype),(comm)))
391 
392 #define MPI_Allgather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm) \
393   ((petsc_gather_ct += PetscMPIParallelComm((comm)),0) || MPI_Allgather((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(comm)))
394 
395 #define MPI_Allgatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,comm) \
396   ((petsc_gather_ct += PetscMPIParallelComm((comm)),0) || MPI_Allgatherv((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(displs),(recvtype),(comm)))
397 
398 #define MPI_Gather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm) \
399   ((petsc_gather_ct++,0) || PetscMPITypeSize((&petsc_send_len),(sendcount),(sendtype)) || MPI_Gather((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(root),(comm)))
400 
401 #define MPI_Gatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,root,comm) \
402   ((petsc_gather_ct++,0) || PetscMPITypeSize((&petsc_send_len),(sendcount),(sendtype)) || MPI_Gatherv((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(displs),(recvtype),(root),(comm)))
403 
404 #define MPI_Scatter(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm) \
405   ((petsc_scatter_ct++,0) || PetscMPITypeSize((&petsc_recv_len),(recvcount),(recvtype)) || MPI_Scatter((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(root),(comm)))
406 
407 #define MPI_Scatterv(sendbuf,sendcount,displs,sendtype,recvbuf,recvcount,recvtype,root,comm) \
408   ((petsc_scatter_ct++,0) || PetscMPITypeSize((&petsc_recv_len),(recvcount),(recvtype)) || MPI_Scatterv((sendbuf),(sendcount),(displs),(sendtype),(recvbuf),(recvcount),(recvtype),(root),(comm)))
409 
410 #else
411 
412 #define MPI_Startall_irecv(count,number,requests) \
413   (MPI_Startall((number),(requests)))
414 
415 #define MPI_Startall_isend(count,number,requests) \
416   (MPI_Startall((number),(requests)))
417 
418 #define MPI_Start_isend(count,requests) \
419   (MPI_Start((requests)))
420 
421 #endif /* !__MPIUNI_H && ! PETSC_HAVE_BROKEN_RECURSIVE_MACRO */
422 
423 #else  /* ---Logging is turned off --------------------------------------------*/
424 
425 #define PetscLogFlops(n) 0
426 #define PetscLogSetThreshold(a,b) 0
427 
428 #define PetscLogEventActivate(a)   0
429 #define PetscLogEventDeactivate(a) 0
430 
431 #define PetscLogEventActivateClass(a)   0
432 #define PetscLogEventDeactivateClass(a) 0
433 #define PetscLogEventSetActiveAll(a,b)  0
434 #define PetscLogEventGetId(a,b)         (*(b)=0,0)
435 #define PetscLogEventGetPerfInfo(a,b,c) 0
436 
437 #define PetscLogPLB                        0
438 #define PetscLogPLE                        0
439 #define PetscLogPHC                        0
440 #define PetscLogPHD                        0
441 #define PetscGetFlops(a)                (*(a) = 0.0,0)
442 #define PetscLogEventBegin(e,o1,o2,o3,o4)   0
443 #define PetscLogEventEnd(e,o1,o2,o3,o4)     0
444 #define PetscLogEventBarrierBegin(e,o1,o2,o3,o4,cm) 0
445 #define PetscLogEventBarrierEnd(e,o1,o2,o3,o4,cm)   0
446 #define PetscLogObjectParents(p,n,c)        0
447 #define PetscLogObjectCreate(h)             0
448 #define PetscLogObjectDestroy(h)            0
449 #define PetscLogDestroy()                   0
450 #define PetscLogStagePush(a)                0
451 #define PetscLogStagePop()                  0
452 #define PetscLogStageRegister(a,b)          0
453 #define PetscLogStagePrint(a,flg)           0
454 #define PetscLogView(viewer)                0
455 #define PetscLogViewFromOptions()           0
456 #define PetscLogDefaultBegin()                     0
457 #define PetscLogTraceBegin(file)            0
458 #define PetscLogSet(lb,le)                  0
459 #define PetscLogAllBegin()                  0
460 #define PetscLogNestedBegin()               0
461 #define PetscLogDump(c)                     0
462 #define PetscLogEventRegister(a,b,c)        0
463 #define PetscLogEventSetCollective(a,b)     0
464 #define PetscLogObjects(a)                  0
465 #define PetscLogActions(a)                  0
466 PETSC_EXTERN PetscErrorCode PetscLogObjectState(PetscObject,const char[],...);
467 
468 /* If PETSC_USE_LOG is NOT defined, these still need to be! */
469 #define MPI_Startall_irecv(count,number,requests) MPI_Startall(number,requests)
470 #define MPI_Startall_isend(count,number,requests) MPI_Startall(number,requests)
471 #define MPI_Start_isend(count,requests) MPI_Start(requests)
472 #define PetscLogStageGetId(a,b)                      (*(b)=0,0)
473 #define PetscLogStageSetActive(a,b)                  0
474 #define PetscLogStageGetActive(a,b)                  0
475 #define PetscLogStageGetVisible(a,b)                 0
476 #define PetscLogStageSetVisible(a,b)                 0
477 
478 #endif   /* PETSC_USE_LOG */
479 
480 PETSC_EXTERN PetscErrorCode PetscIntStackCreate(PetscIntStack *);
481 PETSC_EXTERN PetscErrorCode PetscIntStackDestroy(PetscIntStack);
482 PETSC_EXTERN PetscErrorCode PetscIntStackPush(PetscIntStack, int);
483 PETSC_EXTERN PetscErrorCode PetscIntStackPop(PetscIntStack, int *);
484 PETSC_EXTERN PetscErrorCode PetscIntStackTop(PetscIntStack, int *);
485 PETSC_EXTERN PetscErrorCode PetscIntStackEmpty(PetscIntStack, PetscBool  *);
486 
487 #define PetscPreLoadBegin(flag,name) \
488 do {\
489   PetscBool      PetscPreLoading = flag;\
490   int            PetscPreLoadMax,PetscPreLoadIt;\
491   PetscLogStage  _stageNum;\
492   PetscErrorCode _3_ierr; \
493   _3_ierr = PetscOptionsGetBool(NULL,NULL,"-preload",&PetscPreLoading,NULL);CHKERRQ(_3_ierr); \
494   PetscPreLoadMax = (int)(PetscPreLoading);\
495   PetscPreLoadingUsed = PetscPreLoading ? PETSC_TRUE : PetscPreLoadingUsed;\
496   for (PetscPreLoadIt=0; PetscPreLoadIt<=PetscPreLoadMax; PetscPreLoadIt++) {\
497     PetscPreLoadingOn = PetscPreLoading;\
498     _3_ierr = PetscBarrier(NULL);CHKERRQ(_3_ierr);\
499     if (PetscPreLoadIt>0) {\
500       _3_ierr = PetscLogStageGetId(name,&_stageNum);CHKERRQ(_3_ierr);\
501     } else {\
502       _3_ierr = PetscLogStageRegister(name,&_stageNum);CHKERRQ(_3_ierr); \
503     }\
504     _3_ierr = PetscLogStageSetActive(_stageNum,(PetscBool)(!PetscPreLoadMax || PetscPreLoadIt));\
505     _3_ierr = PetscLogStagePush(_stageNum);CHKERRQ(_3_ierr);
506 
507 #define PetscPreLoadEnd() \
508     _3_ierr = PetscLogStagePop();CHKERRQ(_3_ierr);\
509     PetscPreLoading = PETSC_FALSE;\
510   }\
511 } while (0)
512 
513 #define PetscPreLoadStage(name) do {                                         \
514     _3_ierr = PetscLogStagePop();CHKERRQ(_3_ierr);                      \
515     if (PetscPreLoadIt>0) {                                                  \
516       _3_ierr = PetscLogStageGetId(name,&_stageNum);CHKERRQ(_3_ierr);   \
517     } else {                                                            \
518       _3_ierr = PetscLogStageRegister(name,&_stageNum);CHKERRQ(_3_ierr); \
519     }                                                                   \
520     _3_ierr = PetscLogStageSetActive(_stageNum,(PetscBool)(!PetscPreLoadMax || PetscPreLoadIt)); \
521     _3_ierr = PetscLogStagePush(_stageNum);CHKERRQ(_3_ierr);            \
522   } while (0)
523 
524 /* some vars for logging */
525 PETSC_EXTERN PetscBool PetscPreLoadingUsed;       /* true if we are or have done preloading */
526 PETSC_EXTERN PetscBool PetscPreLoadingOn;         /* true if we are currently in a preloading calculation */
527 
528 #endif
529