Actual source code: petsclog.h

petsc-master 2016-02-11
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(), PetscLogStageBegin(), PetscLogStageEnd(), 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:     PetscClassRegInfo, PetscClassPerfInfo - Each class has two data structures associated with it. The first has
 70:        static information about it, the second collects statistics on how many objects of the class are created,
 71:        how much memory they use, etc.

 73:     PetscClassRegLog, PetscClassPerfLog - arrays of the PetscClassRegInfo and PetscClassPerfInfo for all classes.
 74: */
 75: typedef struct  {
 76:   char           *name;   /* The class name */
 77:   PetscClassId   classid; /* The integer identifying this class */
 78: } PetscClassRegInfo;

 80: typedef struct {
 81:   PetscClassId   id;           /* The integer identifying this class */
 82:   int            creations;    /* The number of objects of this class created */
 83:   int            destructions; /* The number of objects of this class destroyed */
 84:   PetscLogDouble mem;          /* The total memory allocated by objects of this class */
 85:   PetscLogDouble descMem;      /* The total memory allocated by descendents of these objects */
 86: } PetscClassPerfInfo;

 88: typedef struct _n_PetscClassRegLog *PetscClassRegLog;
 89: struct _n_PetscClassRegLog {
 90:   int               numClasses; /* The number of classes registered */
 91:   int               maxClasses; /* The maximum number of classes */
 92:   PetscClassRegInfo *classInfo; /* The structure for class information (classids are monotonicly increasing) */
 93: };

 95: typedef struct _n_PetscClassPerfLog *PetscClassPerfLog;
 96: struct _n_PetscClassPerfLog {
 97:   int                numClasses; /* The number of logging classes */
 98:   int                maxClasses; /* The maximum number of classes */
 99:   PetscClassPerfInfo *classInfo; /* The structure for class information (classids are monotonicly increasing) */
100: };
101: /* -----------------------------------------------------------------------------------------------------*/
102: /*
103:     PetscEventRegInfo, PetscEventPerfInfo - Each event has two data structures associated with it. The first has
104:        static information about it, the second collects statistics on how many times the event is used, how
105:        much time it takes, etc.

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

110: */
111: typedef struct {
112:   char         *name;         /* The name of this event */
113:   PetscClassId classid;       /* The class the event is associated with */
114: #if defined (PETSC_HAVE_MPE)
115:   int          mpe_id_begin; /* MPE IDs that define the event */
116:   int          mpe_id_end;
117: #endif
118: } PetscEventRegInfo;

120: typedef struct {
121:   int            id;            /* The integer identifying this event */
122:   PetscBool      active;        /* The flag to activate logging */
123:   PetscBool      visible;       /* The flag to print info in summary */
124:   int            depth;         /* The nesting depth of the event call */
125:   int            count;         /* The number of times this event was executed */
126:   PetscLogDouble flops, flops2,flopsTmp; /* The flops and flops^2 used in this event */
127:   PetscLogDouble time, time2, timeTmp;   /* The time and time^2 taken for this event */
128:   PetscLogDouble numMessages;   /* The number of messages in this event */
129:   PetscLogDouble messageLength; /* The total message lengths in this event */
130:   PetscLogDouble numReductions; /* The number of reductions in this event */
131: } PetscEventPerfInfo;

133: typedef struct _n_PetscEventRegLog *PetscEventRegLog;
134: struct _n_PetscEventRegLog {
135:   int               numEvents;  /* The number of registered events */
136:   int               maxEvents;  /* The maximum number of events */
137:   PetscEventRegInfo *eventInfo; /* The registration information for each event */
138: };

140: typedef struct _n_PetscEventPerfLog *PetscEventPerfLog;
141: struct _n_PetscEventPerfLog {
142:   int                numEvents;  /* The number of logging events */
143:   int                maxEvents;  /* The maximum number of events */
144:   PetscEventPerfInfo *eventInfo; /* The performance information for each event */
145: };
146: /* ------------------------------------------------------------------------------------------------------------*/
147: /*
148:    PetscStageInfo - Contains all the information about a particular stage.

150:    PetscStageLog - An array of PetscStageInfo for each registered stage. There is a single one of these in the code.
151: */
152: typedef struct _PetscStageInfo {
153:   char               *name;     /* The stage name */
154:   PetscBool          used;      /* The stage was pushed on this processor */
155:   PetscEventPerfInfo perfInfo;  /* The stage performance information */
156:   PetscEventPerfLog  eventLog;  /* The event information for this stage */
157:   PetscClassPerfLog  classLog;  /* The class information for this stage */
158: } PetscStageInfo;

160: typedef struct _n_PetscStageLog *PetscStageLog;
161: struct _n_PetscStageLog {
162:   int              numStages;   /* The number of registered stages */
163:   int              maxStages;   /* The maximum number of stages */
164:   PetscIntStack    stack;       /* The stack for active stages */
165:   int              curStage;    /* The current stage (only used in macros so we don't call PetscIntStackTop) */
166:   PetscStageInfo   *stageInfo;  /* The information for each stage */
167:   PetscEventRegLog eventLog;    /* The registered events */
168:   PetscClassRegLog classLog;    /* The registered classes */
169: };

171: PETSC_EXTERN PetscErrorCode PetscLogGetStageLog(PetscStageLog*);
172: PETSC_EXTERN PetscErrorCode PetscStageLogGetCurrent(PetscStageLog,int*);
173: PETSC_EXTERN PetscErrorCode PetscStageLogGetEventPerfLog(PetscStageLog,int,PetscEventPerfLog*);

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;

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

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

195: #if defined(PETSC_USE_COMPLEX)
196: #define PETSC_FLOPS_PER_OP 4.0
197: #else
198: #define PETSC_FLOPS_PER_OP 1.0
199: #endif

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

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

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

223: #define PetscLogObjectParents(p,n,d)  0;{int _i; for (_i=0; _i<n; _i++) {PetscLogObjectParent((PetscObject)p,(PetscObject)(d)[_i]);}}
224: #define PetscLogObjectCreate(h)      ((PetscLogPHC) ? (*PetscLogPHC)((PetscObject)h) : 0)
225: #define PetscLogObjectDestroy(h)     ((PetscLogPHD) ? (*PetscLogPHD)((PetscObject)h) : 0)
226: /* Initialization functions */
227: PETSC_EXTERN PetscErrorCode PetscLogDefaultBegin(void);
228: PETSC_EXTERN PetscErrorCode PetscLogAllBegin(void);
229: PETSC_EXTERN PetscErrorCode PetscLogNestedBegin(void);
230: PETSC_EXTERN PetscErrorCode PetscLogTraceBegin(FILE *);
231: PETSC_EXTERN PetscErrorCode PetscLogActions(PetscBool);
232: PETSC_EXTERN PetscErrorCode PetscLogObjects(PetscBool);
233: /* General functions */
234: PETSC_EXTERN PetscErrorCode PetscLogDestroy(void);
235: PETSC_EXTERN PetscErrorCode PetscLogSet(PetscErrorCode (*)(int, int, PetscObject, PetscObject, PetscObject, PetscObject),
236:                                    PetscErrorCode (*)(int, int, PetscObject, PetscObject, PetscObject, PetscObject));
237: PETSC_EXTERN PetscErrorCode PetscLogObjectState(PetscObject, const char[], ...);
238: /* Output functions */
239: PETSC_EXTERN PetscErrorCode PetscLogView(PetscViewer);
240: PETSC_EXTERN PetscErrorCode PetscLogViewFromOptions(void);
241: PETSC_EXTERN PetscErrorCode PetscLogDump(const char[]);

243: PETSC_EXTERN PetscErrorCode PetscGetFlops(PetscLogDouble *);

245: PETSC_EXTERN PetscErrorCode PetscLogStageRegister(const char[],PetscLogStage*);
246: PETSC_EXTERN PetscErrorCode PetscLogStagePush(PetscLogStage);
247: PETSC_EXTERN PetscErrorCode PetscLogStagePop(void);
248: PETSC_EXTERN PetscErrorCode PetscLogStageSetActive(PetscLogStage, PetscBool );
249: PETSC_EXTERN PetscErrorCode PetscLogStageGetActive(PetscLogStage, PetscBool  *);
250: PETSC_EXTERN PetscErrorCode PetscLogStageSetVisible(PetscLogStage, PetscBool );
251: PETSC_EXTERN PetscErrorCode PetscLogStageGetVisible(PetscLogStage, PetscBool  *);
252: PETSC_EXTERN PetscErrorCode PetscLogStageGetId(const char [], PetscLogStage *);
253: /* Event functions */
254: PETSC_EXTERN PetscErrorCode PetscLogEventRegister(const char[], PetscClassId,PetscLogEvent*);
255: PETSC_EXTERN PetscErrorCode PetscLogEventActivate(PetscLogEvent);
256: PETSC_EXTERN PetscErrorCode PetscLogEventDeactivate(PetscLogEvent);
257: PETSC_EXTERN PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent, PetscBool );
258: PETSC_EXTERN PetscErrorCode PetscLogEventActivateClass(PetscClassId);
259: PETSC_EXTERN PetscErrorCode PetscLogEventDeactivateClass(PetscClassId);
260: PETSC_EXTERN PetscErrorCode PetscLogEventGetId(const char[],PetscLogEvent*);
261: PETSC_EXTERN PetscErrorCode PetscLogEventGetPerfInfo(int, PetscLogEvent, PetscEventPerfInfo *);

263: /* Global counters */
264: PETSC_EXTERN PetscLogDouble petsc_irecv_ct;
265: PETSC_EXTERN PetscLogDouble petsc_isend_ct;
266: PETSC_EXTERN PetscLogDouble petsc_recv_ct;
267: PETSC_EXTERN PetscLogDouble petsc_send_ct;
268: PETSC_EXTERN PetscLogDouble petsc_irecv_len;
269: PETSC_EXTERN PetscLogDouble petsc_isend_len;
270: PETSC_EXTERN PetscLogDouble petsc_recv_len;
271: PETSC_EXTERN PetscLogDouble petsc_send_len;
272: PETSC_EXTERN PetscLogDouble petsc_allreduce_ct;
273: PETSC_EXTERN PetscLogDouble petsc_gather_ct;
274: PETSC_EXTERN PetscLogDouble petsc_scatter_ct;
275: PETSC_EXTERN PetscLogDouble petsc_wait_ct;
276: PETSC_EXTERN PetscLogDouble petsc_wait_any_ct;
277: PETSC_EXTERN PetscLogDouble petsc_wait_all_ct;
278: PETSC_EXTERN PetscLogDouble petsc_sum_of_waits_ct;

280: #define PetscLogEventBarrierBegin(e,o1,o2,o3,o4,cm) \
281:   (((PetscLogPLB && petsc_stageLog->stageInfo[petsc_stageLog->curStage].perfInfo.active &&  petsc_stageLog->stageInfo[petsc_stageLog->curStage].eventLog->eventInfo[e].active) ? \
282:     (PetscLogEventBegin((e),o1,o2,o3,o4) || MPI_Barrier(cm) || PetscLogEventEnd((e),o1,o2,o3,o4)) : 0 ) || \
283:    PetscLogEventBegin((e)+1,o1,o2,o3,o4))

285: #define PetscLogEventBegin(e,o1,o2,o3,o4) \
286:   (((PetscLogPLB && petsc_stageLog->stageInfo[petsc_stageLog->curStage].perfInfo.active && petsc_stageLog->stageInfo[petsc_stageLog->curStage].eventLog->eventInfo[e].active) ? \
287:     (*PetscLogPLB)((e),0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4)) : 0 ))

289: #define PetscLogEventBarrierEnd(e,o1,o2,o3,o4,cm) PetscLogEventEnd(e+1,o1,o2,o3,o4)

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:   if (type == MPI_DATATYPE_NULL) return 0;
319:   else return  (MPI_Type_size(type,&mysize) || ((*buff += (PetscLogDouble) (count*mysize)),0));
320: }

322: PETSC_STATIC_INLINE PetscErrorCode PetscMPITypeSizeComm(MPI_Comm comm, PetscLogDouble *buff,PetscMPIInt *counts,MPI_Datatype type)
323: {
324:   PetscMPIInt mysize, commsize, p;
325:   PetscErrorCode _myierr;

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

336: /*
337:     Returns 1 if the communicator is parallel else zero 
338: */
339: PETSC_STATIC_INLINE int PetscMPIParallelComm(MPI_Comm comm)
340: {
341:   PetscMPIInt size; MPI_Comm_size(comm,&size); return size > 1;
342: }

344: #define MPI_Irecv(buf,count,datatype,source,tag,comm,request) \
345:  ((petsc_irecv_ct++,0) || PetscMPITypeSize(&petsc_irecv_len,count,datatype) || MPI_Irecv(buf,count,datatype,source,tag,comm,request))

347: #define MPI_Isend(buf,count,datatype,dest,tag,comm,request) \
348:  ((petsc_isend_ct++,0) || PetscMPITypeSize(&petsc_isend_len,count,datatype) || MPI_Isend(buf,count,datatype,dest,tag,comm,request))

350: #define MPI_Startall_irecv(count,number,requests) \
351:  ((petsc_irecv_ct += (PetscLogDouble)(number),0) || PetscMPITypeSize(&petsc_irecv_len,count,MPIU_SCALAR) || MPI_Startall(number,requests))

353: #define MPI_Startall_isend(count,number,requests) \
354:  ((petsc_isend_ct += (PetscLogDouble)(number),0) || PetscMPITypeSize(&petsc_isend_len,count,MPIU_SCALAR) || MPI_Startall(number,requests))

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

359: #define MPI_Recv(buf,count,datatype,source,tag,comm,status) \
360:  ((petsc_recv_ct++,0) || PetscMPITypeSize(&petsc_recv_len,count,datatype) || MPI_Recv(buf,count,datatype,source,tag,comm,status))

362: #define MPI_Send(buf,count,datatype,dest,tag,comm) \
363:  ((petsc_send_ct++,0) || PetscMPITypeSize(&petsc_send_len,count,datatype) || MPI_Send(buf,count,datatype,dest,tag,comm))

365: #define MPI_Wait(request,status) \
366:  ((petsc_wait_ct++,petsc_sum_of_waits_ct++,0) || MPI_Wait(request,status))

368: #define MPI_Waitany(a,b,c,d) \
369:  ((petsc_wait_any_ct++,petsc_sum_of_waits_ct++,0) || MPI_Waitany(a,b,c,d))

371: #define MPI_Waitall(count,array_of_requests,array_of_statuses) \
372:  ((petsc_wait_all_ct++,petsc_sum_of_waits_ct += (PetscLogDouble) (count),0) || MPI_Waitall(count,array_of_requests,array_of_statuses))

374: #define MPI_Allreduce(sendbuf,recvbuf,count,datatype,op,comm) \
375:   ((petsc_allreduce_ct += PetscMPIParallelComm(comm),0) || MPI_Allreduce(sendbuf,recvbuf,count,datatype,op,comm))

377: #define MPI_Reduce_scatter_block(sendbuf,recvbuf,recvcount,datatype,op,comm) \
378:   ((petsc_allreduce_ct += PetscMPIParallelComm(comm),0) || MPI_Reduce_scatter_block(sendbuf,recvbuf,recvcount,datatype,op,comm))

380: #define MPI_Alltoall(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm) \
381:  ((petsc_allreduce_ct += PetscMPIParallelComm(comm),0) || PetscMPITypeSize(&petsc_send_len,sendcount,sendtype) || MPI_Alltoall(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm))

383: #define MPI_Alltoallv(sendbuf,sendcnts,sdispls,sendtype,recvbuf,recvcnts,rdispls,recvtype,comm) \
384:  ((petsc_allreduce_ct += PetscMPIParallelComm(comm),0) || PetscMPITypeSizeComm(comm,&petsc_send_len,sendcnts,sendtype) || MPI_Alltoallv(sendbuf,sendcnts,sdispls,sendtype,recvbuf,recvcnts,rdispls,recvtype,comm))

386: #define MPI_Allgather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm) \
387:  ((petsc_gather_ct += PetscMPIParallelComm(comm),0) || MPI_Allgather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm))

389: #define MPI_Allgatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,comm) \
390:  ((petsc_gather_ct += PetscMPIParallelComm(comm),0) || MPI_Allgatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,comm))

392: #define MPI_Gather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm) \
393:  ((petsc_gather_ct++,0) || PetscMPITypeSize(&petsc_send_len,sendcount,sendtype) || MPI_Gather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm))

395: #define MPI_Gatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,root,comm) \
396:  ((petsc_gather_ct++,0) || PetscMPITypeSize(&petsc_send_len,sendcount,sendtype) || MPI_Gatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,root,comm))

398: #define MPI_Scatter(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm) \
399:  ((petsc_scatter_ct++,0) || PetscMPITypeSize(&petsc_recv_len,recvcount,recvtype) || MPI_Scatter(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm))

401: #define MPI_Scatterv(sendbuf,sendcount,displs,sendtype,recvbuf,recvcount,recvtype,root,comm) \
402:   ((petsc_scatter_ct++,0) || PetscMPITypeSize(&petsc_recv_len,recvcount,recvtype) || MPI_Scatterv(sendbuf,sendcount,displs,sendtype,recvbuf,recvcount,recvtype,root,comm))

404: #else

406: #define MPI_Startall_irecv(count,number,requests) \
407:  (MPI_Startall(number,requests))

409: #define MPI_Startall_isend(count,number,requests) \
410:  (MPI_Startall(number,requests))

412: #define MPI_Start_isend(count,requests) \
413:  (MPI_Start(requests))

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

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

419: #define PetscLogFlops(n) 0

421: #define PetscLogEventActivate(a)   0
422: #define PetscLogEventDeactivate(a) 0

424: #define PetscLogEventActivateClass(a)   0
425: #define PetscLogEventDeactivateClass(a) 0
426: #define PetscLogEventSetActiveAll(a,b)  0

428: #define PetscLogPLB                        0
429: #define PetscLogPLE                        0
430: #define PetscLogPHC                        0
431: #define PetscLogPHD                        0
432: #define PetscGetFlops(a)                (*(a) = 0.0,0)
433: #define PetscLogEventBegin(e,o1,o2,o3,o4)   0
434: #define PetscLogEventEnd(e,o1,o2,o3,o4)     0
435: #define PetscLogEventBarrierBegin(e,o1,o2,o3,o4,cm) 0
436: #define PetscLogEventBarrierEnd(e,o1,o2,o3,o4,cm)   0
437: #define PetscLogObjectParents(p,n,c)        0
438: #define PetscLogObjectCreate(h)             0
439: #define PetscLogObjectDestroy(h)            0
440: #define PetscLogDestroy()                   0
441: #define PetscLogStagePush(a)                0
442: #define PetscLogStagePop()                  0
443: #define PetscLogStageRegister(a,b)          0
444: #define PetscLogStagePrint(a,flg)           0
445: #define PetscLogView(viewer)                0
446: #define PetscLogViewFromOptions()           0
447: #define PetscLogDefaultBegin()                     0
448: #define PetscLogTraceBegin(file)            0
449: #define PetscLogSet(lb,le)                  0
450: #define PetscLogAllBegin()                  0
451: #define PetscLogNestedBegin()               0
452: #define PetscLogDump(c)                     0
453: #define PetscLogEventRegister(a,b,c)        0
454: #define PetscLogObjects(a)                  0
455: #define PetscLogActions(a)                  0
456: PETSC_EXTERN PetscErrorCode PetscLogObjectState(PetscObject,const char[],...);

458: /* If PETSC_USE_LOG is NOT defined, these still need to be! */
459: #define MPI_Startall_irecv(count,number,requests) MPI_Startall(number,requests)
460: #define MPI_Startall_isend(count,number,requests) MPI_Startall(number,requests)
461: #define MPI_Start_isend(count,requests) MPI_Start(requests)
462: #define PetscLogStageGetId(a,b)                      (*(b)=0,0)
463: #define PetscLogStageSetActive(a,b)                  0
464: #define PetscLogStageGetActive(a,b)                  0
465: #define PetscLogStageGetVisible(a,b)                 0
466: #define PetscLogStageSetVisible(a,b)                 0

468: #endif   /* PETSC_USE_LOG */

470: PETSC_EXTERN PetscErrorCode PetscIntStackCreate(PetscIntStack *);
471: PETSC_EXTERN PetscErrorCode PetscIntStackDestroy(PetscIntStack);
472: PETSC_EXTERN PetscErrorCode PetscIntStackPush(PetscIntStack, int);
473: PETSC_EXTERN PetscErrorCode PetscIntStackPop(PetscIntStack, int *);
474: PETSC_EXTERN PetscErrorCode PetscIntStackTop(PetscIntStack, int *);
475: PETSC_EXTERN PetscErrorCode PetscIntStackEmpty(PetscIntStack, PetscBool  *);

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

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

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

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

518: /* Reset __FUNCT__ in case the user does not define it themselves */

522: #endif