xref: /petsc/include/petsclog.h (revision b72fa766f129fc2bd79867a41d61fdbe3fc875c4)
1 /*
2     Defines profile/logging in PETSc.
3 */
4 
5 #if !defined(__PetscLog_H)
6 #define __PetscLog_H
7 #include <petscsys.h>
8 
9 /* General logging of information; different from event logging */
10 PETSC_EXTERN PetscErrorCode PetscInfo_Private(const char[],void*,const char[],...);
11 #if defined(PETSC_USE_INFO)
12 #define PetscInfo(A,S)                       PetscInfo_Private(PETSC_FUNCTION_NAME,A,S)
13 #define PetscInfo1(A,S,a1)                   PetscInfo_Private(PETSC_FUNCTION_NAME,A,S,a1)
14 #define PetscInfo2(A,S,a1,a2)                PetscInfo_Private(PETSC_FUNCTION_NAME,A,S,a1,a2)
15 #define PetscInfo3(A,S,a1,a2,a3)             PetscInfo_Private(PETSC_FUNCTION_NAME,A,S,a1,a2,a3)
16 #define PetscInfo4(A,S,a1,a2,a3,a4)          PetscInfo_Private(PETSC_FUNCTION_NAME,A,S,a1,a2,a3,a4)
17 #define PetscInfo5(A,S,a1,a2,a3,a4,a5)       PetscInfo_Private(PETSC_FUNCTION_NAME,A,S,a1,a2,a3,a4,a5)
18 #define PetscInfo6(A,S,a1,a2,a3,a4,a5,a6)    PetscInfo_Private(PETSC_FUNCTION_NAME,A,S,a1,a2,a3,a4,a5,a6)
19 #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)
20 #else
21 #define PetscInfo(A,S)                       0
22 #define PetscInfo1(A,S,a1)                   0
23 #define PetscInfo2(A,S,a1,a2)                0
24 #define PetscInfo3(A,S,a1,a2,a3)             0
25 #define PetscInfo4(A,S,a1,a2,a3,a4)          0
26 #define PetscInfo5(A,S,a1,a2,a3,a4,a5)       0
27 #define PetscInfo6(A,S,a1,a2,a3,a4,a5,a6)    0
28 #define PetscInfo7(A,S,a1,a2,a3,a4,a5,a6,a7) 0
29 #endif
30 PETSC_EXTERN PetscErrorCode PetscInfoDeactivateClass(PetscClassId);
31 PETSC_EXTERN PetscErrorCode PetscInfoActivateClass(PetscClassId);
32 PETSC_EXTERN PetscBool PetscLogPrintInfo;  /* if true, indicates PetscInfo() is turned on */
33 
34 /*MC
35     PetscLogEvent - id used to identify PETSc or user events which timed portions (blocks of executable)
36      code.
37 
38     Level: intermediate
39 
40 .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStage
41 M*/
42 typedef int PetscLogEvent;
43 
44 /*MC
45     PetscLogStage - id used to identify user stages (phases, sections) of runs - for logging
46 
47     Level: intermediate
48 
49 .seealso: PetscLogStageRegister(), PetscLogStagePush(), PetscLogStagePop(), PetscLogEvent
50 M*/
51 typedef int PetscLogStage;
52 
53 #define PETSC_EVENT  1311311
54 PETSC_EXTERN PetscLogEvent PETSC_LARGEST_EVENT;
55 
56 /* Global flop counter */
57 PETSC_EXTERN PetscLogDouble petsc_TotalFlops;
58 PETSC_EXTERN PetscLogDouble petsc_tmp_flops;
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/logging/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 dof[8];        /* The number of degrees of freedom associated with this event */
132   PetscLogDouble errors[8];     /* The errors (user-defined) associated with this event */
133   PetscLogDouble numMessages;   /* The number of messages in this event */
134   PetscLogDouble messageLength; /* The total message lengths in this event */
135   PetscLogDouble numReductions; /* The number of reductions in this event */
136 } PetscEventPerfInfo;
137 
138 typedef struct _n_PetscEventRegLog *PetscEventRegLog;
139 struct _n_PetscEventRegLog {
140   int               numEvents;  /* The number of registered events */
141   int               maxEvents;  /* The maximum number of events */
142   PetscEventRegInfo *eventInfo; /* The registration information for each event */
143 };
144 
145 typedef struct _n_PetscEventPerfLog *PetscEventPerfLog;
146 struct _n_PetscEventPerfLog {
147   int                numEvents;  /* The number of logging events */
148   int                maxEvents;  /* The maximum number of events */
149   PetscEventPerfInfo *eventInfo; /* The performance information for each event */
150 };
151 /* ------------------------------------------------------------------------------------------------------------*/
152 /*
153    PetscStageInfo - Contains all the information about a particular stage.
154 
155    PetscStageLog - An array of PetscStageInfo for each registered stage. There is a single one of these in the code.
156 */
157 typedef struct _PetscStageInfo {
158   char               *name;     /* The stage name */
159   PetscBool          used;      /* The stage was pushed on this processor */
160   PetscEventPerfInfo perfInfo;  /* The stage performance information */
161   PetscEventPerfLog  eventLog;  /* The event information for this stage */
162   PetscClassPerfLog  classLog;  /* The class information for this stage */
163 } PetscStageInfo;
164 
165 typedef struct _n_PetscStageLog *PetscStageLog;
166 struct _n_PetscStageLog {
167   int              numStages;   /* The number of registered stages */
168   int              maxStages;   /* The maximum number of stages */
169   PetscIntStack    stack;       /* The stack for active stages */
170   int              curStage;    /* The current stage (only used in macros so we don't call PetscIntStackTop) */
171   PetscStageInfo   *stageInfo;  /* The information for each stage */
172   PetscEventRegLog eventLog;    /* The registered events */
173   PetscClassRegLog classLog;    /* The registered classes */
174 };
175 /* -----------------------------------------------------------------------------------------------------*/
176 
177 PETSC_EXTERN PetscErrorCode PetscLogObjectParent(PetscObject,PetscObject);
178 PETSC_EXTERN PetscErrorCode PetscLogObjectMemory(PetscObject,PetscLogDouble);
179 
180 #if defined(PETSC_USE_LOG)  /* --- Logging is turned on --------------------------------*/
181 PETSC_EXTERN PetscStageLog petsc_stageLog;
182 PETSC_EXTERN PetscErrorCode PetscLogGetStageLog(PetscStageLog*);
183 PETSC_EXTERN PetscErrorCode PetscStageLogGetCurrent(PetscStageLog,int*);
184 PETSC_EXTERN PetscErrorCode PetscStageLogGetEventPerfLog(PetscStageLog,int,PetscEventPerfLog*);
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 
215 PETSC_EXTERN PetscErrorCode PetscGetFlops(PetscLogDouble *);
216 
217 #if defined (PETSC_HAVE_MPE)
218 PETSC_EXTERN PetscErrorCode PetscLogMPEBegin(void);
219 PETSC_EXTERN PetscErrorCode PetscLogMPEDump(const char[]);
220 #endif
221 
222 PETSC_EXTERN PetscErrorCode (*PetscLogPLB)(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
223 PETSC_EXTERN PetscErrorCode (*PetscLogPLE)(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
224 PETSC_EXTERN PetscErrorCode (*PetscLogPHC)(PetscObject);
225 PETSC_EXTERN PetscErrorCode (*PetscLogPHD)(PetscObject);
226 
227 #define PetscLogObjectParents(p,n,d)  0;do{int _i; for (_i=0; _i<(n); _i++) {ierr = PetscLogObjectParent((PetscObject)(p),(PetscObject)(d)[_i]);CHKERRQ(ierr);}}while(0)
228 #define PetscLogObjectCreate(h)      ((PetscLogPHC) ? (*PetscLogPHC)((PetscObject)(h)) : 0)
229 #define PetscLogObjectDestroy(h)     ((PetscLogPHD) ? (*PetscLogPHD)((PetscObject)(h)) : 0)
230 PETSC_EXTERN PetscErrorCode PetscLogObjectState(PetscObject, const char[], ...);
231 
232 /* Initialization functions */
233 PETSC_EXTERN PetscErrorCode PetscLogDefaultBegin(void);
234 PETSC_EXTERN PetscErrorCode PetscLogAllBegin(void);
235 PETSC_EXTERN PetscErrorCode PetscLogNestedBegin(void);
236 PETSC_EXTERN PetscErrorCode PetscLogTraceBegin(FILE *);
237 PETSC_EXTERN PetscErrorCode PetscLogActions(PetscBool);
238 PETSC_EXTERN PetscErrorCode PetscLogObjects(PetscBool);
239 PETSC_EXTERN PetscErrorCode PetscLogSetThreshold(PetscLogDouble,PetscLogDouble*);
240 PETSC_EXTERN PetscErrorCode PetscLogSet(PetscErrorCode (*)(int, int, PetscObject, PetscObject, PetscObject, PetscObject),
241                                         PetscErrorCode (*)(int, int, PetscObject, PetscObject, PetscObject, PetscObject));
242 
243 /* Output functions */
244 PETSC_EXTERN PetscErrorCode PetscLogView(PetscViewer);
245 PETSC_EXTERN PetscErrorCode PetscLogViewFromOptions(void);
246 PETSC_EXTERN PetscErrorCode PetscLogDump(const char[]);
247 
248 /* Stage functions */
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 
258 /* Event functions */
259 PETSC_EXTERN PetscErrorCode PetscLogEventRegister(const char[],PetscClassId,PetscLogEvent*);
260 PETSC_EXTERN PetscErrorCode PetscLogEventSetCollective(PetscLogEvent,PetscBool);
261 PETSC_EXTERN PetscErrorCode PetscLogEventIncludeClass(PetscClassId);
262 PETSC_EXTERN PetscErrorCode PetscLogEventExcludeClass(PetscClassId);
263 PETSC_EXTERN PetscErrorCode PetscLogEventActivate(PetscLogEvent);
264 PETSC_EXTERN PetscErrorCode PetscLogEventDeactivate(PetscLogEvent);
265 PETSC_EXTERN PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent,PetscBool);
266 PETSC_EXTERN PetscErrorCode PetscLogEventActivateClass(PetscClassId);
267 PETSC_EXTERN PetscErrorCode PetscLogEventDeactivateClass(PetscClassId);
268 PETSC_EXTERN PetscErrorCode PetscLogEventGetId(const char[],PetscLogEvent*);
269 PETSC_EXTERN PetscErrorCode PetscLogEventGetPerfInfo(int,PetscLogEvent,PetscEventPerfInfo*);
270 PETSC_EXTERN PetscErrorCode PetscLogEventSetDof(PetscLogEvent, PetscInt, PetscLogDouble);
271 PETSC_EXTERN PetscErrorCode PetscLogEventSetError(PetscLogEvent, PetscInt, PetscLogDouble);
272 
273 /* Global counters */
274 PETSC_EXTERN PetscLogDouble petsc_irecv_ct;
275 PETSC_EXTERN PetscLogDouble petsc_isend_ct;
276 PETSC_EXTERN PetscLogDouble petsc_recv_ct;
277 PETSC_EXTERN PetscLogDouble petsc_send_ct;
278 PETSC_EXTERN PetscLogDouble petsc_irecv_len;
279 PETSC_EXTERN PetscLogDouble petsc_isend_len;
280 PETSC_EXTERN PetscLogDouble petsc_recv_len;
281 PETSC_EXTERN PetscLogDouble petsc_send_len;
282 PETSC_EXTERN PetscLogDouble petsc_allreduce_ct;
283 PETSC_EXTERN PetscLogDouble petsc_gather_ct;
284 PETSC_EXTERN PetscLogDouble petsc_scatter_ct;
285 PETSC_EXTERN PetscLogDouble petsc_wait_ct;
286 PETSC_EXTERN PetscLogDouble petsc_wait_any_ct;
287 PETSC_EXTERN PetscLogDouble petsc_wait_all_ct;
288 PETSC_EXTERN PetscLogDouble petsc_sum_of_waits_ct;
289 
290 PETSC_EXTERN PetscBool PetscLogSyncOn;  /* true if logging synchronization is enabled */
291 PETSC_EXTERN PetscErrorCode PetscLogEventSynchronize(PetscLogEvent, MPI_Comm);
292 
293 #define PetscLogEventSync(e,comm) \
294   (((PetscLogPLB && petsc_stageLog->stageInfo[petsc_stageLog->curStage].perfInfo.active && petsc_stageLog->stageInfo[petsc_stageLog->curStage].eventLog->eventInfo[e].active) ? \
295     PetscLogEventSynchronize((e),(comm)) : 0 ))
296 
297 #define PetscLogEventBegin(e,o1,o2,o3,o4) \
298   (((PetscLogPLB && petsc_stageLog->stageInfo[petsc_stageLog->curStage].perfInfo.active && petsc_stageLog->stageInfo[petsc_stageLog->curStage].eventLog->eventInfo[e].active) ? \
299     (*PetscLogPLB)((e),0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4)) : 0 ))
300 
301 #define PetscLogEventEnd(e,o1,o2,o3,o4) \
302   (((PetscLogPLE && petsc_stageLog->stageInfo[petsc_stageLog->curStage].perfInfo.active && petsc_stageLog->stageInfo[petsc_stageLog->curStage].eventLog->eventInfo[e].active) ? \
303     (*PetscLogPLE)((e),0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4)) : 0 ))
304 
305 PETSC_EXTERN PetscErrorCode PetscLogEventGetFlops(PetscLogEvent,PetscLogDouble*);
306 PETSC_EXTERN PetscErrorCode PetscLogEventZeroFlops(PetscLogEvent);
307 
308 /*
309      These are used internally in the PETSc routines to keep a count of MPI messages and
310    their sizes.
311 
312      This does not work for MPI-Uni because our include/petsc/mpiuni/mpi.h file
313    uses macros to defined the MPI operations.
314 
315      It does not work correctly from HP-UX because it processes the
316    macros in a way that sometimes it double counts, hence
317    PETSC_HAVE_BROKEN_RECURSIVE_MACRO
318 
319      It does not work with Windows because winmpich lacks MPI_Type_size()
320 */
321 #if !defined(__MPIUNI_H) && !defined(PETSC_HAVE_BROKEN_RECURSIVE_MACRO) && !defined (PETSC_HAVE_MPI_MISSING_TYPESIZE)
322 /*
323    Logging of MPI activities
324 */
325 PETSC_STATIC_INLINE PetscErrorCode PetscMPITypeSize(PetscLogDouble *buff,PetscMPIInt count,MPI_Datatype type)
326 {
327   PetscMPIInt mysize;
328   PetscErrorCode _myierr;
329   if (type == MPI_DATATYPE_NULL) return 0;
330   _myierr = MPI_Type_size(type,&mysize);CHKERRQ(_myierr);
331   *buff += (PetscLogDouble) (count*mysize);
332   return 0;
333 }
334 
335 PETSC_STATIC_INLINE PetscErrorCode PetscMPITypeSizeComm(MPI_Comm comm, PetscLogDouble *buff,PetscMPIInt *counts,MPI_Datatype type)
336 {
337   PetscMPIInt mysize, commsize, p;
338   PetscErrorCode _myierr;
339 
340   if (type == MPI_DATATYPE_NULL) return 0;
341   _myierr = MPI_Comm_size(comm,&commsize);CHKERRQ(_myierr);
342   _myierr = MPI_Type_size(type,&mysize);CHKERRQ(_myierr);
343   for (p = 0; p < commsize; ++p) {
344     *buff += (PetscLogDouble) (counts[p]*mysize);
345   }
346   return 0;
347 }
348 
349 /*
350     Returns 1 if the communicator is parallel else zero
351 */
352 PETSC_STATIC_INLINE int PetscMPIParallelComm(MPI_Comm comm)
353 {
354   PetscMPIInt size; MPI_Comm_size(comm,&size); return size > 1;
355 }
356 
357 #define MPI_Irecv(buf,count,datatype,source,tag,comm,request) \
358   ((petsc_irecv_ct++,0) || PetscMPITypeSize(&(petsc_irecv_len),(count),(datatype)) || MPI_Irecv((buf),(count),(datatype),(source),(tag),(comm),(request)))
359 
360 #define MPI_Isend(buf,count,datatype,dest,tag,comm,request) \
361   ((petsc_isend_ct++,0) || PetscMPITypeSize(&(petsc_isend_len),(count),(datatype)) || MPI_Isend((buf),(count),(datatype),(dest),(tag),(comm),(request)))
362 
363 #define MPI_Startall_irecv(count,datatype,number,requests) \
364   ((petsc_irecv_ct += (PetscLogDouble)(number),0) || PetscMPITypeSize(&(petsc_irecv_len),(count),(datatype)) || ((number) && MPI_Startall((number),(requests))))
365 
366 #define MPI_Startall_isend(count,datatype,number,requests) \
367   ((petsc_isend_ct += (PetscLogDouble)(number),0) || PetscMPITypeSize(&(petsc_isend_len),(count),(datatype)) || ((number) && MPI_Startall((number),(requests))))
368 
369 #define MPI_Start_isend(count,datatype,requests) \
370   ((petsc_isend_ct++,0) || PetscMPITypeSize((&petsc_isend_len),(count),(datatype)) || MPI_Start((requests)))
371 
372 #define MPI_Recv(buf,count,datatype,source,tag,comm,status) \
373   ((petsc_recv_ct++,0) || PetscMPITypeSize((&petsc_recv_len),(count),(datatype)) || MPI_Recv((buf),(count),(datatype),(source),(tag),(comm),(status)))
374 
375 #define MPI_Send(buf,count,datatype,dest,tag,comm) \
376   ((petsc_send_ct++,0) || PetscMPITypeSize((&petsc_send_len),(count),(datatype)) || MPI_Send((buf),(count),(datatype),(dest),(tag),(comm)))
377 
378 #define MPI_Wait(request,status) \
379   ((petsc_wait_ct++,petsc_sum_of_waits_ct++,0) || MPI_Wait((request),(status)))
380 
381 #define MPI_Waitany(a,b,c,d) \
382   ((petsc_wait_any_ct++,petsc_sum_of_waits_ct++,0) || MPI_Waitany((a),(b),(c),(d)))
383 
384 #define MPI_Waitall(count,array_of_requests,array_of_statuses) \
385   ((petsc_wait_all_ct++,petsc_sum_of_waits_ct += (PetscLogDouble) (count),0) || MPI_Waitall((count),(array_of_requests),(array_of_statuses)))
386 
387 #define MPI_Allreduce(sendbuf,recvbuf,count,datatype,op,comm) \
388   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || MPI_Allreduce((sendbuf),(recvbuf),(count),(datatype),(op),(comm)))
389 
390 #define MPI_Bcast(buffer,count,datatype,root,comm) \
391   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || MPI_Bcast((buffer),(count),(datatype),(root),(comm)))
392 
393 #define MPI_Reduce_scatter_block(sendbuf,recvbuf,recvcount,datatype,op,comm) \
394   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || MPI_Reduce_scatter_block((sendbuf),(recvbuf),(recvcount),(datatype),(op),(comm)))
395 
396 #define MPI_Alltoall(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm) \
397   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || PetscMPITypeSize((&petsc_send_len),(sendcount),(sendtype)) || MPI_Alltoall((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(comm)))
398 
399 #define MPI_Alltoallv(sendbuf,sendcnts,sdispls,sendtype,recvbuf,recvcnts,rdispls,recvtype,comm) \
400   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || PetscMPITypeSizeComm((comm),(&petsc_send_len),(sendcnts),(sendtype)) || MPI_Alltoallv((sendbuf),(sendcnts),(sdispls),(sendtype),(recvbuf),(recvcnts),(rdispls),(recvtype),(comm)))
401 
402 #define MPI_Allgather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm) \
403   ((petsc_gather_ct += PetscMPIParallelComm((comm)),0) || MPI_Allgather((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(comm)))
404 
405 #define MPI_Allgatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,comm) \
406   ((petsc_gather_ct += PetscMPIParallelComm((comm)),0) || MPI_Allgatherv((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(displs),(recvtype),(comm)))
407 
408 #define MPI_Gather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm) \
409   ((petsc_gather_ct++,0) || PetscMPITypeSize((&petsc_send_len),(sendcount),(sendtype)) || MPI_Gather((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(root),(comm)))
410 
411 #define MPI_Gatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,root,comm) \
412   ((petsc_gather_ct++,0) || PetscMPITypeSize((&petsc_send_len),(sendcount),(sendtype)) || MPI_Gatherv((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(displs),(recvtype),(root),(comm)))
413 
414 #define MPI_Scatter(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm) \
415   ((petsc_scatter_ct++,0) || PetscMPITypeSize((&petsc_recv_len),(recvcount),(recvtype)) || MPI_Scatter((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(root),(comm)))
416 
417 #define MPI_Scatterv(sendbuf,sendcount,displs,sendtype,recvbuf,recvcount,recvtype,root,comm) \
418   ((petsc_scatter_ct++,0) || PetscMPITypeSize((&petsc_recv_len),(recvcount),(recvtype)) || MPI_Scatterv((sendbuf),(sendcount),(displs),(sendtype),(recvbuf),(recvcount),(recvtype),(root),(comm)))
419 
420 #else
421 
422 #define MPI_Startall_irecv(count,datatype,number,requests) \
423   ((number) && MPI_Startall((number),(requests)))
424 
425 #define MPI_Startall_isend(count,datatype,number,requests) \
426   ((number) && MPI_Startall((number),(requests)))
427 
428 #define MPI_Start_isend(count,datatype,requests) \
429   (MPI_Start((requests)))
430 
431 #endif /* !__MPIUNI_H && ! PETSC_HAVE_BROKEN_RECURSIVE_MACRO */
432 
433 #else  /* ---Logging is turned off --------------------------------------------*/
434 
435 #define PetscLogFlops(n)                   0
436 #define PetscGetFlops(a)                   (*(a) = 0.0,0)
437 
438 #define PetscLogStageRegister(a,b)         0
439 #define PetscLogStagePush(a)               0
440 #define PetscLogStagePop()                 0
441 #define PetscLogStageSetActive(a,b)        0
442 #define PetscLogStageGetActive(a,b)        0
443 #define PetscLogStageGetVisible(a,b)       0
444 #define PetscLogStageSetVisible(a,b)       0
445 #define PetscLogStageGetId(a,b)            (*(b)=0,0)
446 
447 #define PetscLogEventRegister(a,b,c)       0
448 #define PetscLogEventSetCollective(a,b)    0
449 #define PetscLogEventIncludeClass(a)       0
450 #define PetscLogEventExcludeClass(a)       0
451 #define PetscLogEventActivate(a)           0
452 #define PetscLogEventDeactivate(a)         0
453 #define PetscLogEventActivateClass(a)      0
454 #define PetscLogEventDeactivateClass(a)    0
455 #define PetscLogEventSetActiveAll(a,b)     0
456 #define PetscLogEventGetId(a,b)            (*(b)=0,0)
457 #define PetscLogEventGetPerfInfo(a,b,c)    0
458 #define PetscLogEventSetDof(a,b,c)         0
459 #define PetscLogEventSetError(a,b,c)       0
460 
461 #define PetscLogPLB                        0
462 #define PetscLogPLE                        0
463 #define PetscLogPHC                        0
464 #define PetscLogPHD                        0
465 
466 #define PetscLogObjectParents(p,n,c)       0
467 #define PetscLogObjectCreate(h)            0
468 #define PetscLogObjectDestroy(h)           0
469 PETSC_EXTERN PetscErrorCode PetscLogObjectState(PetscObject,const char[],...);
470 
471 #define PetscLogDefaultBegin()             0
472 #define PetscLogAllBegin()                 0
473 #define PetscLogNestedBegin()              0
474 #define PetscLogTraceBegin(file)           0
475 #define PetscLogActions(a)                 0
476 #define PetscLogObjects(a)                 0
477 #define PetscLogSetThreshold(a,b)          0
478 #define PetscLogSet(lb,le)                 0
479 
480 #define PetscLogView(viewer)               0
481 #define PetscLogViewFromOptions()          0
482 #define PetscLogDump(c)                    0
483 
484 #define PetscLogEventSync(e,comm)          0
485 #define PetscLogEventBegin(e,o1,o2,o3,o4)  0
486 #define PetscLogEventEnd(e,o1,o2,o3,o4)    0
487 
488 /* If PETSC_USE_LOG is NOT defined, these still need to be! */
489 #define MPI_Startall_irecv(count,datatype,number,requests) ((number) && MPI_Startall(number,requests))
490 #define MPI_Startall_isend(count,datatype,number,requests) ((number) && MPI_Startall(number,requests))
491 #define MPI_Start_isend(count,datatype,requests)           MPI_Start(requests)
492 
493 #endif   /* PETSC_USE_LOG */
494 
495 #define PetscPreLoadBegin(flag,name) \
496 do {\
497   PetscBool      PetscPreLoading = flag;\
498   int            PetscPreLoadMax,PetscPreLoadIt;\
499   PetscLogStage  _stageNum;\
500   PetscErrorCode _3_ierr; \
501   _3_ierr = PetscOptionsGetBool(NULL,NULL,"-preload",&PetscPreLoading,NULL);CHKERRQ(_3_ierr); \
502   PetscPreLoadMax = (int)(PetscPreLoading);\
503   PetscPreLoadingUsed = PetscPreLoading ? PETSC_TRUE : PetscPreLoadingUsed;\
504   for (PetscPreLoadIt=0; PetscPreLoadIt<=PetscPreLoadMax; PetscPreLoadIt++) {\
505     PetscPreLoadingOn = PetscPreLoading;\
506     _3_ierr = PetscBarrier(NULL);CHKERRQ(_3_ierr);\
507     if (PetscPreLoadIt>0) {\
508       _3_ierr = PetscLogStageGetId(name,&_stageNum);CHKERRQ(_3_ierr);\
509     } else {\
510       _3_ierr = PetscLogStageRegister(name,&_stageNum);CHKERRQ(_3_ierr); \
511     }\
512     _3_ierr = PetscLogStageSetActive(_stageNum,(PetscBool)(!PetscPreLoadMax || PetscPreLoadIt));\
513     _3_ierr = PetscLogStagePush(_stageNum);CHKERRQ(_3_ierr);
514 
515 #define PetscPreLoadEnd() \
516     _3_ierr = PetscLogStagePop();CHKERRQ(_3_ierr);\
517     PetscPreLoading = PETSC_FALSE;\
518   }\
519 } while (0)
520 
521 #define PetscPreLoadStage(name) do {                                         \
522     _3_ierr = PetscLogStagePop();CHKERRQ(_3_ierr);                      \
523     if (PetscPreLoadIt>0) {                                                  \
524       _3_ierr = PetscLogStageGetId(name,&_stageNum);CHKERRQ(_3_ierr);   \
525     } else {                                                            \
526       _3_ierr = PetscLogStageRegister(name,&_stageNum);CHKERRQ(_3_ierr); \
527     }                                                                   \
528     _3_ierr = PetscLogStageSetActive(_stageNum,(PetscBool)(!PetscPreLoadMax || PetscPreLoadIt)); \
529     _3_ierr = PetscLogStagePush(_stageNum);CHKERRQ(_3_ierr);            \
530   } while (0)
531 
532 /* some vars for logging */
533 PETSC_EXTERN PetscBool PetscPreLoadingUsed;       /* true if we are or have done preloading */
534 PETSC_EXTERN PetscBool PetscPreLoadingOn;         /* true if we are currently in a preloading calculation */
535 
536 #endif
537