Actual source code: petsclog.h

petsc-master 2018-06-18
Report Typos and Errors
  1: /*
  2:     Defines profile/logging in PETSc.
  3: */

  7:  #include <petscsys.h>

  9: /*MC
 10:     PetscLogEvent - id used to identify PETSc or user events which timed portions (blocks of executable)
 11:      code.

 13:     Level: intermediate

 15: .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStage
 16: M*/
 17: typedef int PetscLogEvent;

 19: /*MC
 20:     PetscLogStage - id used to identify user stages (phases, sections) of runs - for logging

 22:     Level: intermediate

 24: .seealso: PetscLogStageRegister(), PetscLogStagePush(), PetscLogStagePop(), PetscLogEvent
 25: M*/
 26: typedef int PetscLogStage;

 28: #define PETSC_EVENT  1311311
 29: PETSC_EXTERN PetscLogEvent PETSC_LARGEST_EVENT;

 31: /* Global flop counter */
 32: PETSC_EXTERN PetscLogDouble petsc_TotalFlops;
 33: PETSC_EXTERN PetscLogDouble petsc_tmp_flops;

 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 */

 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.

 64:      The code that manipulates these structures is in src/sys/plog/utils.
 65: */
 66: typedef struct _n_PetscIntStack *PetscIntStack;

 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.

 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;

 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;

 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: };

 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.

108:     PetscEventRegLog, PetscEventPerfLog - an array of all PetscEventRegInfo and PetscEventPerfInfo for all events. There is one
109:       of these for each stage.

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;

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;

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: };

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.

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;

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: /* -----------------------------------------------------------------------------------------------------*/

175: PETSC_EXTERN PetscErrorCode PetscLogObjectParent(PetscObject,PetscObject);
176: PETSC_EXTERN PetscErrorCode PetscLogObjectMemory(PetscObject,PetscLogDouble);


179: #if defined(PETSC_USE_LOG)  /* --- Logging is turned on --------------------------------*/
180: PETSC_EXTERN PetscStageLog petsc_stageLog;
181: PETSC_EXTERN PetscErrorCode PetscLogGetStageLog(PetscStageLog*);
182: PETSC_EXTERN PetscErrorCode PetscStageLogGetCurrent(PetscStageLog,int*);
183: PETSC_EXTERN PetscErrorCode PetscStageLogGetEventPerfLog(PetscStageLog,int,PetscEventPerfLog*);

185: /*
186:    Flop counting:  We count each arithmetic operation (e.g., addition, multiplication) separately.

188:    For the complex numbers version, note that
189:        1 complex addition = 2 flops
190:        1 complex multiplication = 6 flops,
191:    where we define 1 flop as that for a double precision scalar.  We roughly approximate
192:    flop counting for complex numbers by multiplying the total flops by 4; this corresponds
193:    to the assumption that we're counting mostly additions and multiplications -- and
194:    roughly the same number of each.  More accurate counting could be done by distinguishing
195:    among the various arithmetic operations.
196:  */

198: #if defined(PETSC_USE_COMPLEX)
199: #define PETSC_FLOPS_PER_OP 4.0
200: #else
201: #define PETSC_FLOPS_PER_OP 1.0
202: #endif

204: PETSC_STATIC_INLINE PetscErrorCode PetscLogFlops(PetscLogDouble n)
205: {
207: #if defined(PETSC_USE_DEBUG)
208:   if (n < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Cannot log negative flops");
209: #endif
210:   petsc_TotalFlops += PETSC_FLOPS_PER_OP*n;
211:   return(0);
212: }
213: PETSC_EXTERN PetscErrorCode PetscLogSetThreshold(PetscLogDouble,PetscLogDouble*);

215: #if defined (PETSC_HAVE_MPE)
216: PETSC_EXTERN PetscErrorCode PetscLogMPEBegin(void);
217: PETSC_EXTERN PetscErrorCode PetscLogMPEDump(const char[]);
218: #endif

220: PETSC_EXTERN PetscErrorCode (*PetscLogPLB)(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
221: PETSC_EXTERN PetscErrorCode (*PetscLogPLE)(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
222: PETSC_EXTERN PetscErrorCode (*PetscLogPHC)(PetscObject);
223: PETSC_EXTERN PetscErrorCode (*PetscLogPHD)(PetscObject);

225: #define PetscLogObjectParents(p,n,d)  0;{int _i; for (_i=0; _i<n; _i++) {PetscLogObjectParent((PetscObject)p,(PetscObject)(d)[_i]);}}
226: #define PetscLogObjectCreate(h)      ((PetscLogPHC) ? (*PetscLogPHC)((PetscObject)h) : 0)
227: #define PetscLogObjectDestroy(h)     ((PetscLogPHD) ? (*PetscLogPHD)((PetscObject)h) : 0)
228: /* Initialization functions */
229: PETSC_EXTERN PetscErrorCode PetscLogDefaultBegin(void);
230: PETSC_EXTERN PetscErrorCode PetscLogAllBegin(void);
231: PETSC_EXTERN PetscErrorCode PetscLogNestedBegin(void);
232: PETSC_EXTERN PetscErrorCode PetscLogTraceBegin(FILE *);
233: PETSC_EXTERN PetscErrorCode PetscLogActions(PetscBool);
234: PETSC_EXTERN PetscErrorCode PetscLogObjects(PetscBool);

236: /* General functions */
237: PETSC_EXTERN PetscErrorCode PetscLogDestroy(void);
238: PETSC_EXTERN PetscErrorCode PetscLogSet(PetscErrorCode (*)(int, int, PetscObject, PetscObject, PetscObject, PetscObject),
239:                                         PetscErrorCode (*)(int, int, PetscObject, PetscObject, PetscObject, PetscObject));
240: PETSC_EXTERN PetscErrorCode PetscLogObjectState(PetscObject, const char[], ...);
241: /* Output functions */
242: PETSC_EXTERN PetscErrorCode PetscLogView(PetscViewer);
243: PETSC_EXTERN PetscErrorCode PetscLogViewFromOptions(void);
244: PETSC_EXTERN PetscErrorCode PetscLogDump(const char[]);

246: PETSC_EXTERN PetscErrorCode PetscGetFlops(PetscLogDouble *);

248: PETSC_EXTERN PetscErrorCode PetscLogStageRegister(const char[],PetscLogStage*);
249: PETSC_EXTERN PetscErrorCode PetscLogStagePush(PetscLogStage);
250: PETSC_EXTERN PetscErrorCode PetscLogStagePop(void);
251: PETSC_EXTERN PetscErrorCode PetscLogStageSetActive(PetscLogStage, PetscBool );
252: PETSC_EXTERN PetscErrorCode PetscLogStageGetActive(PetscLogStage, PetscBool  *);
253: PETSC_EXTERN PetscErrorCode PetscLogStageSetVisible(PetscLogStage, PetscBool );
254: PETSC_EXTERN PetscErrorCode PetscLogStageGetVisible(PetscLogStage, PetscBool  *);
255: 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 *);

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;

285: PETSC_EXTERN PetscBool PetscLogSyncOn;

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 ))

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 ))

295: PETSC_EXTERN PetscErrorCode PetscLogEventGetFlops(PetscLogEvent, PetscLogDouble*);
296: PETSC_EXTERN PetscErrorCode PetscLogEventZeroFlops(PetscLogEvent);

298: /*
299:      These are used internally in the PETSc routines to keep a count of MPI messages and
300:    their sizes.

302:      This does not work for MPI-Uni because our include/petsc/mpiuni/mpi.h file
303:    uses macros to defined the MPI operations.

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

309:      It does not work with Windows because winmpich lacks MPI_Type_size()
310: */
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:   _myMPI_Type_size(type,&mysize);CHKERRQ(_myierr);
321:   *buff += (PetscLogDouble) (count*mysize);
322:   return 0;
323: }

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;

330:   if (type == MPI_DATATYPE_NULL) return 0;
331:   _myMPI_Comm_size(comm,&commsize);CHKERRQ(_myierr);
332:   _myMPI_Type_size(type,&mysize);CHKERRQ(_myierr);
333:   for (p = 0; p < commsize; ++p) {
334:     *buff += (PetscLogDouble) (counts[p]*mysize);
335:   }
336:   return 0;
337: }

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: }

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)))

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)))

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)))

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)))

359: #define MPI_Start_isend(count,requests) \
360:   ((petsc_isend_ct++,0) || PetscMPITypeSize((&petsc_isend_len),(count),(MPIU_SCALAR)) || MPI_Start((requests)))

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)))

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)))

368: #define MPI_Wait(request,status) \
369:   ((petsc_wait_ct++,petsc_sum_of_waits_ct++,0) || MPI_Wait((request),(status)))

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)))

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)))

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)))

380: #define MPI_Bcast(buffer,count,datatype,root,comm) \
381:   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || MPI_Bcast((buffer),(count),(datatype),(root),(comm)))

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)))

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)))

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)))

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)))

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)))

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)))

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)))

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)))

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)))

410: #else

412: #define MPI_Startall_irecv(count,number,requests) \
413:   (MPI_Startall((number),(requests)))

415: #define MPI_Startall_isend(count,number,requests) \
416:   (MPI_Startall((number),(requests)))

418: #define MPI_Start_isend(count,requests) \
419:   (MPI_Start((requests)))

421: #endif /* !__MPIUNI_H && ! PETSC_HAVE_BROKEN_RECURSIVE_MACRO */

423: #else  /* ---Logging is turned off --------------------------------------------*/

425: #define PetscLogFlops(n)                   0
426: #define PetscLogSetThreshold(a,b)          0

428: #define PetscLogStageSetActive(a,b)        0
429: #define PetscLogStageGetActive(a,b)        0
430: #define PetscLogStageGetVisible(a,b)       0
431: #define PetscLogStageSetVisible(a,b)       0
432: #define PetscLogStageGetId(a,b)            (*(b)=0,0)

434: #define PetscLogEventActivate(a)           0
435: #define PetscLogEventDeactivate(a)         0
436: #define PetscLogEventActivateClass(a)      0
437: #define PetscLogEventDeactivateClass(a)    0
438: #define PetscLogEventSetActiveAll(a,b)     0
439: #define PetscLogEventGetId(a,b)            (*(b)=0,0)
440: #define PetscLogEventGetPerfInfo(a,b,c)    0

442: #define PetscLogPLB                        0
443: #define PetscLogPLE                        0
444: #define PetscLogPHC                        0
445: #define PetscLogPHD                        0

447: #define PetscGetFlops(a)                   (*(a) = 0.0,0)
448: #define PetscLogEventBegin(e,o1,o2,o3,o4)  0
449: #define PetscLogEventEnd(e,o1,o2,o3,o4)    0
450: #define PetscLogObjectParents(p,n,c)       0
451: #define PetscLogObjectCreate(h)            0
452: #define PetscLogObjectDestroy(h)           0
453: #define PetscLogDestroy()                  0
454: #define PetscLogStageRegister(a,b)         0
455: #define PetscLogStagePush(a)               0
456: #define PetscLogStagePop()                 0
457: #define PetscLogView(viewer)               0
458: #define PetscLogViewFromOptions()          0
459: #define PetscLogDefaultBegin()             0
460: #define PetscLogTraceBegin(file)           0
461: #define PetscLogSet(lb,le)                 0
462: #define PetscLogAllBegin()                 0
463: #define PetscLogNestedBegin()              0
464: #define PetscLogDump(c)                    0
465: #define PetscLogEventRegister(a,b,c)       0
466: #define PetscLogEventSetCollective(a,b)    0
467: #define PetscLogObjects(a)                 0
468: #define PetscLogActions(a)                 0
469: PETSC_EXTERN PetscErrorCode PetscLogObjectState(PetscObject,const char[],...);

471: /* If PETSC_USE_LOG is NOT defined, these still need to be! */
472: #define MPI_Startall_irecv(count,number,requests) MPI_Startall(number,requests)
473: #define MPI_Startall_isend(count,number,requests) MPI_Startall(number,requests)
474: #define MPI_Start_isend(count,requests)           MPI_Start(requests)

476: #endif   /* PETSC_USE_LOG */

478: #define PetscPreLoadBegin(flag,name) \
479: do {\
480:   PetscBool      PetscPreLoading = flag;\
481:   int            PetscPreLoadMax,PetscPreLoadIt;\
482:   PetscLogStage  _stageNum;\
483:   PetscErrorCode _3_ierr; \
484:   _3_PetscOptionsGetBool(NULL,NULL,"-preload",&PetscPreLoading,NULL);CHKERRQ(_3_ierr); \
485:   PetscPreLoadMax = (int)(PetscPreLoading);\
486:   PetscPreLoadingUsed = PetscPreLoading ? PETSC_TRUE : PetscPreLoadingUsed;\
487:   for (PetscPreLoadIt=0; PetscPreLoadIt<=PetscPreLoadMax; PetscPreLoadIt++) {\
488:     PetscPreLoadingOn = PetscPreLoading;\
489:     _3_PetscBarrier(NULL);CHKERRQ(_3_ierr);\
490:     if (PetscPreLoadIt>0) {\
491:       _3_PetscLogStageGetId(name,&_stageNum);CHKERRQ(_3_ierr);\
492:     } else {\
493:       _3_PetscLogStageRegister(name,&_stageNum);CHKERRQ(_3_ierr); \
494:     }\
495:     _3_PetscLogStageSetActive(_stageNum,(PetscBool)(!PetscPreLoadMax || PetscPreLoadIt));\
496:     _3_PetscLogStagePush(_stageNum);CHKERRQ(_3_ierr);

498: #define PetscPreLoadEnd() \
499:     _3_PetscLogStagePop();CHKERRQ(_3_ierr);\
500:     PetscPreLoading = PETSC_FALSE;\
501:   }\
502: } while (0)

504: #define PetscPreLoadStage(name) do {                                         \
505:     _3_PetscLogStagePop();CHKERRQ(_3_ierr);                      \
506:     if (PetscPreLoadIt>0) {                                                  \
507:       _3_PetscLogStageGetId(name,&_stageNum);CHKERRQ(_3_ierr);   \
508:     } else {                                                            \
509:       _3_PetscLogStageRegister(name,&_stageNum);CHKERRQ(_3_ierr); \
510:     }                                                                   \
511:     _3_PetscLogStageSetActive(_stageNum,(PetscBool)(!PetscPreLoadMax || PetscPreLoadIt)); \
512:     _3_PetscLogStagePush(_stageNum);CHKERRQ(_3_ierr);            \
513:   } while (0)

515: /* some vars for logging */
516: PETSC_EXTERN PetscBool PetscPreLoadingUsed;       /* true if we are or have done preloading */
517: PETSC_EXTERN PetscBool PetscPreLoadingOn;         /* true if we are currently in a preloading calculation */

519: #endif