Date: 2013-07-02T14:39:17+00:00

Actual source code: petsclog.h
petsc-3.4.2 2013-07-02

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

    176: #if defined(PETSC_USE_LOG)  /* --- Logging is turned on --------------------------------*/
    177: PETSC_EXTERN PetscStageLog petsc_stageLog;

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

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

    192: #if defined(PETSC_USE_COMPLEX)
    193: #define PETSC_FLOPS_PER_OP 4.0
    194: #else
    195: #define PETSC_FLOPS_PER_OP 1.0
    196: #endif

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

    210: #if defined (PETSC_HAVE_MPE)
    211: PETSC_EXTERN PetscErrorCode PetscLogMPEBegin(void);
    212: PETSC_EXTERN PetscErrorCode PetscLogMPEDump(const char[]);
    213: #endif

    215: PETSC_EXTERN PetscErrorCode (*PetscLogPLB)(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
    216: PETSC_EXTERN PetscErrorCode (*PetscLogPLE)(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
    217: PETSC_EXTERN PetscErrorCode (*PetscLogPHC)(PetscObject);
    218: PETSC_EXTERN PetscErrorCode (*PetscLogPHD)(PetscObject);

    220: #define PetscLogObjectParent(p,c) \
    221:   (c && p && (((PetscObject)(c))->parent = (PetscObject)(p),((PetscObject)(c))->parentid = ((PetscObject)p)->id,0))

    223: #define PetscLogObjectParents(p,n,d)  0;{int _i; for (_i=0; _i<n; _i++) {PetscLogObjectParent(p,(d)[_i]);}}
    224: #define PetscLogObjectCreate(h)      ((PetscLogPHC) ? (*PetscLogPHC)((PetscObject)h) : 0)
    225: #define PetscLogObjectDestroy(h)     ((PetscLogPHD) ? (*PetscLogPHD)((PetscObject)h) : 0)
    226: #define PetscLogObjectMemory(p,m)    (((PetscObject)(p))->mem += (m),0)
    227: /* Initialization functions */
    228: PETSC_EXTERN PetscErrorCode PetscLogBegin(void);
    229: PETSC_EXTERN PetscErrorCode PetscLogAllBegin(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 PetscLogViewPython(PetscViewer);
    241: PETSC_EXTERN PetscErrorCode PetscLogPrintDetailed(MPI_Comm, const char[]);
    242: PETSC_EXTERN PetscErrorCode PetscLogDump(const char[]);

    244: PETSC_EXTERN PetscErrorCode PetscGetFlops(PetscLogDouble *);

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

    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/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; return  (MPI_Type_size(type,&mysize) || ((*buff += (PetscLogDouble) (count*mysize)),0));
    318: }

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

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

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

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

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

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

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

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

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

    354: #define MPI_Wait(request,status) \
    355:  ((petsc_wait_ct++,petsc_sum_of_waits_ct++,0) || MPI_Wait(request,status))

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

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

    363: #define MPI_Allreduce(sendbuf,recvbuf,count,datatype,op,comm) \
    364:  ((petsc_allreduce_ct++,0) || MPI_Allreduce(sendbuf,recvbuf,count,datatype,op,comm))

    366: #define MPI_Alltoall(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm) \
    367:  ((petsc_allreduce_ct++,0) || PetscMPITypeSize(&petsc_send_len,sendcount,sendtype) || MPI_Alltoall(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm))

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

    372: #define MPI_Allgather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm) \
    373:  ((petsc_gather_ct++,0) || MPI_Allgather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm))

    375: #define MPI_Allgatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,comm) \
    376:  ((petsc_gather_ct++,0) || MPI_Allgatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,comm))

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

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

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

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

    390: #else

    392: #define MPI_Startall_irecv(count,number,requests) \
    393:  (MPI_Startall(number,requests))

    395: #define MPI_Startall_isend(count,number,requests) \
    396:  (MPI_Startall(number,requests))

    398: #define MPI_Start_isend(count,requests) \
    399:  (MPI_Start(requests))

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

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

    405: #define PetscLogFlops(n) 0

    407: #define PetscLogEventActivate(a)   0
    408: #define PetscLogEventDeactivate(a) 0

    410: #define PetscLogEventActivateClass(a)   0
    411: #define PetscLogEventDeactivateClass(a) 0
    412: #define PetscLogEventSetActiveAll(a,b)  0

    414: #define PetscLogPLB                        0
    415: #define PetscLogPLE                        0
    416: #define PetscLogPHC                        0
    417: #define PetscLogPHD                        0
    418: #define PetscGetFlops(a)                (*(a) = 0.0,0)
    419: #define PetscLogEventBegin(e,o1,o2,o3,o4)   0
    420: #define PetscLogEventEnd(e,o1,o2,o3,o4)     0
    421: #define PetscLogEventBarrierBegin(e,o1,o2,o3,o4,cm) 0
    422: #define PetscLogEventBarrierEnd(e,o1,o2,o3,o4,cm)   0
    423: #define PetscLogObjectParent(p,c)           0
    424: #define PetscLogObjectParents(p,n,c)        0
    425: #define PetscLogObjectCreate(h)             0
    426: #define PetscLogObjectDestroy(h)            0
    427: #define PetscLogObjectMemory(p,m)           0
    428: #define PetscLogDestroy()                   0
    429: #define PetscLogStagePush(a)                0
    430: #define PetscLogStagePop()                  0
    431: #define PetscLogStageRegister(a,b)          0
    432: #define PetscLogStagePrint(a,flg)           0
    433: #define PetscLogView(viewer)                0
    434: #define PetscLogViewPython(viewer)          0
    435: #define PetscLogPrintDetailed(comm,file)    0
    436: #define PetscLogBegin()                     0
    437: #define PetscLogTraceBegin(file)            0
    438: #define PetscLogSet(lb,le)                  0
    439: #define PetscLogAllBegin()                  0
    440: #define PetscLogDump(c)                     0
    441: #define PetscLogEventRegister(a,b,c)        0
    442: #define PetscLogObjects(a)                  0
    443: #define PetscLogActions(a)                  0
    444: PETSC_EXTERN PetscErrorCode PetscLogObjectState(PetscObject,const char[],...);

    446: /* If PETSC_USE_LOG is NOT defined, these still need to be! */
    447: #define MPI_Startall_irecv(count,number,requests) MPI_Startall(number,requests)
    448: #define MPI_Startall_isend(count,number,requests) MPI_Startall(number,requests)
    449: #define MPI_Start_isend(count,requests) MPI_Start(requests)
    450: #define PetscLogStageGetId(a,b)                      (*(b)=0,0)
    451: #define PetscLogStageSetActive(a,b)                  0
    452: #define PetscLogStageGetActive(a,b)                  0
    453: #define PetscLogStageGetVisible(a,b)                 0
    454: #define PetscLogStageSetVisible(a,b)                 0

    456: #endif   /* PETSC_USE_LOG */

    458: PETSC_EXTERN PetscErrorCode PetscIntStackCreate(PetscIntStack *);
    459: PETSC_EXTERN PetscErrorCode PetscIntStackDestroy(PetscIntStack);
    460: PETSC_EXTERN PetscErrorCode PetscIntStackPush(PetscIntStack, int);
    461: PETSC_EXTERN PetscErrorCode PetscIntStackPop(PetscIntStack, int *);
    462: PETSC_EXTERN PetscErrorCode PetscIntStackTop(PetscIntStack, int *);
    463: PETSC_EXTERN PetscErrorCode PetscIntStackEmpty(PetscIntStack, PetscBool  *);

    465: /* Special support for C++ */
    466: #if defined(PETSC_CLANGUAGE_CXX) && defined(__cplusplus)
    467: #include <petsclog.hh>
    468: #endif

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

    490: #define PetscPreLoadEnd() \
    491:     _3_PetscLogStagePop();CHKERRQ(_3_ierr);\
    492:     PetscPreLoading = PETSC_FALSE;\
    493:   }\
    494: } while (0)

    496: #define PetscPreLoadStage(name) do {                                         \
    497:     _3_PetscLogStagePop();CHKERRQ(_3_ierr);                      \
    498:     if (PetscPreLoadIt>0) {                                                  \
    499:       _3_PetscLogStageGetId(name,&_stageNum);CHKERRQ(_3_ierr);   \
    500:     } else {                                                            \
    501:       _3_PetscLogStageRegister(name,&_stageNum);CHKERRQ(_3_ierr); \
    502:     }                                                                   \
    503:     _3_PetscLogStageSetActive(_stageNum,(PetscBool)(!PetscPreLoadMax || PetscPreLoadIt)); \
    504:     _3_PetscLogStagePush(_stageNum);CHKERRQ(_3_ierr);            \
    505:   } while (0)

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

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

    515: #endif