xref: /petsc/include/petsclog.h (revision 589a23caa660d2a5f330cc8d1ed213e9cfaf51a7)
1 /*
2     Defines profile/logging in PETSc.
3 */
4 
5 #if !defined(PETSCLOG_H)
6 #define PETSCLOG_H
7 #include <petscsys.h>
8 #include <petsctime.h>
9 
10 /* General logging of information; different from event logging */
11 PETSC_EXTERN PetscErrorCode PetscInfo_Private(const char[],PetscObject,const char[],...);
12 #if defined(PETSC_USE_INFO)
13 #define PetscInfo(A,S)                       PetscInfo_Private(PETSC_FUNCTION_NAME,((PetscObject)A),S)
14 #define PetscInfo1(A,S,a1)                   PetscInfo_Private(PETSC_FUNCTION_NAME,((PetscObject)A),S,a1)
15 #define PetscInfo2(A,S,a1,a2)                PetscInfo_Private(PETSC_FUNCTION_NAME,((PetscObject)A),S,a1,a2)
16 #define PetscInfo3(A,S,a1,a2,a3)             PetscInfo_Private(PETSC_FUNCTION_NAME,((PetscObject)A),S,a1,a2,a3)
17 #define PetscInfo4(A,S,a1,a2,a3,a4)          PetscInfo_Private(PETSC_FUNCTION_NAME,((PetscObject)A),S,a1,a2,a3,a4)
18 #define PetscInfo5(A,S,a1,a2,a3,a4,a5)       PetscInfo_Private(PETSC_FUNCTION_NAME,((PetscObject)A),S,a1,a2,a3,a4,a5)
19 #define PetscInfo6(A,S,a1,a2,a3,a4,a5,a6)    PetscInfo_Private(PETSC_FUNCTION_NAME,((PetscObject)A),S,a1,a2,a3,a4,a5,a6)
20 #define PetscInfo7(A,S,a1,a2,a3,a4,a5,a6,a7) PetscInfo_Private(PETSC_FUNCTION_NAME,((PetscObject)A),S,a1,a2,a3,a4,a5,a6,a7)
21 #else
22 #define PetscInfo(A,S)                       0
23 #define PetscInfo1(A,S,a1)                   0
24 #define PetscInfo2(A,S,a1,a2)                0
25 #define PetscInfo3(A,S,a1,a2,a3)             0
26 #define PetscInfo4(A,S,a1,a2,a3,a4)          0
27 #define PetscInfo5(A,S,a1,a2,a3,a4,a5)       0
28 #define PetscInfo6(A,S,a1,a2,a3,a4,a5,a6)    0
29 #define PetscInfo7(A,S,a1,a2,a3,a4,a5,a6,a7) 0
30 #endif
31 
32 /*E
33     PetscInfoCommFlag - Describes the method by which to filter PetscInfo() by communicator size
34 
35     Used as an input for PetscInfoSetFilterCommSelf()
36 
37 $   PETSC_INFO_COMM_ALL - Default uninitialized value. PetscInfo() will not filter based on communicator size (i.e. will
38 print for all communicators)
39 $   PETSC_INFO_COMM_NO_SELF - PetscInfo() will NOT print for communicators with size = 1 (i.e. *_COMM_SELF)
40 $   PETSC_INFO_COMM_ONLY_SELF - PetscInfo will ONLY print for communicators with size = 1
41 
42     Level: intermediate
43 
44 .seealso: PetscInfo(), PetscInfoSetFromOptions(), PetscInfoSetFilterCommSelf()
45 E*/
46 typedef enum {
47   PETSC_INFO_COMM_ALL = -1,
48   PETSC_INFO_COMM_NO_SELF = 0,
49   PETSC_INFO_COMM_ONLY_SELF = 1
50 } PetscInfoCommFlag;
51 
52 PETSC_EXTERN const char * const PetscInfoCommFlags[];
53 PETSC_EXTERN PetscErrorCode PetscInfoDeactivateClass(PetscClassId);
54 PETSC_EXTERN PetscErrorCode PetscInfoActivateClass(PetscClassId);
55 PETSC_EXTERN PetscErrorCode PetscInfoEnabled(PetscClassId, PetscBool *);
56 PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool);
57 PETSC_EXTERN PetscErrorCode PetscInfoSetFile(const char[],const char[]);
58 PETSC_EXTERN PetscErrorCode PetscInfoGetFile(char **,FILE **);
59 PETSC_EXTERN PetscErrorCode PetscInfoSetClasses(PetscBool,PetscInt,const char *const *);
60 PETSC_EXTERN PetscErrorCode PetscInfoGetClass(const char *, PetscBool *);
61 PETSC_EXTERN PetscErrorCode PetscInfoGetInfo(PetscBool *,PetscBool *,PetscBool *,PetscBool *,PetscInfoCommFlag *);
62 PETSC_EXTERN PetscErrorCode PetscInfoProcessClass(const char[],PetscInt,PetscClassId[]);
63 PETSC_EXTERN PetscErrorCode PetscInfoSetFilterCommSelf(PetscInfoCommFlag);
64 PETSC_EXTERN PetscErrorCode PetscInfoSetFromOptions(PetscOptions);
65 PETSC_EXTERN PetscErrorCode PetscInfoDestroy(void);
66 PETSC_EXTERN PetscBool      PetscLogPrintInfo;  /* if true, indicates PetscInfo() is turned on */
67 
68 /*MC
69     PetscLogEvent - id used to identify PETSc or user events which timed portions (blocks of executable)
70      code.
71 
72     Level: intermediate
73 
74 .seealso: PetscLogEventRegister(), PetscLogEventBegin(), PetscLogEventEnd(), PetscLogStage
75 M*/
76 typedef int PetscLogEvent;
77 
78 /*MC
79     PetscLogStage - id used to identify user stages (phases, sections) of runs - for logging
80 
81     Level: intermediate
82 
83 .seealso: PetscLogStageRegister(), PetscLogStagePush(), PetscLogStagePop(), PetscLogEvent
84 M*/
85 typedef int PetscLogStage;
86 
87 #define PETSC_EVENT  1311311
88 PETSC_EXTERN PetscLogEvent PETSC_LARGEST_EVENT;
89 
90 /* Global flop counter */
91 PETSC_EXTERN PetscLogDouble petsc_TotalFlops;
92 PETSC_EXTERN PetscLogDouble petsc_tmp_flops;
93 
94 /* Global GPU counters */
95 #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
96 PETSC_EXTERN PetscLogDouble petsc_ctog_ct;
97 PETSC_EXTERN PetscLogDouble petsc_gtoc_ct;
98 PETSC_EXTERN PetscLogDouble petsc_ctog_sz;
99 PETSC_EXTERN PetscLogDouble petsc_gtoc_sz;
100 PETSC_EXTERN PetscLogDouble petsc_gflops;
101 PETSC_EXTERN PetscLogDouble petsc_gtime;
102 #endif
103 
104 /* We must make the following structures available to access the event
105      activation flags in the PetscLogEventBegin/End() macros. These are not part of the PETSc public
106      API and are not intended to be used by other parts of PETSc or by users.
107 
108      The code that manipulates these structures is in src/sys/logging/utils.
109 */
110 typedef struct _n_PetscIntStack *PetscIntStack;
111 
112 /* -----------------------------------------------------------------------------------------------------*/
113 /*
114     PetscClassRegInfo, PetscClassPerfInfo - Each class has two data structures associated with it. The first has
115        static information about it, the second collects statistics on how many objects of the class are created,
116        how much memory they use, etc.
117 
118     PetscClassRegLog, PetscClassPerfLog - arrays of the PetscClassRegInfo and PetscClassPerfInfo for all classes.
119 */
120 typedef struct  {
121   char           *name;   /* The class name */
122   PetscClassId   classid; /* The integer identifying this class */
123 } PetscClassRegInfo;
124 
125 typedef struct {
126   PetscClassId   id;           /* The integer identifying this class */
127   int            creations;    /* The number of objects of this class created */
128   int            destructions; /* The number of objects of this class destroyed */
129   PetscLogDouble mem;          /* The total memory allocated by objects of this class */
130   PetscLogDouble descMem;      /* The total memory allocated by descendents of these objects */
131 } PetscClassPerfInfo;
132 
133 typedef struct _n_PetscClassRegLog *PetscClassRegLog;
134 struct _n_PetscClassRegLog {
135   int               numClasses; /* The number of classes registered */
136   int               maxClasses; /* The maximum number of classes */
137   PetscClassRegInfo *classInfo; /* The structure for class information (classids are monotonicly increasing) */
138 };
139 
140 typedef struct _n_PetscClassPerfLog *PetscClassPerfLog;
141 struct _n_PetscClassPerfLog {
142   int                numClasses; /* The number of logging classes */
143   int                maxClasses; /* The maximum number of classes */
144   PetscClassPerfInfo *classInfo; /* The structure for class information (classids are monotonicly increasing) */
145 };
146 /* -----------------------------------------------------------------------------------------------------*/
147 /*
148     PetscEventRegInfo, PetscEventPerfInfo - Each event has two data structures associated with it. The first has
149        static information about it, the second collects statistics on how many times the event is used, how
150        much time it takes, etc.
151 
152     PetscEventRegLog, PetscEventPerfLog - an array of all PetscEventRegInfo and PetscEventPerfInfo for all events. There is one
153       of these for each stage.
154 
155 */
156 typedef struct {
157   char         *name;         /* The name of this event */
158   PetscClassId classid;       /* The class the event is associated with */
159   PetscBool    collective;    /* Flag this event as collective */
160 #if defined (PETSC_HAVE_MPE)
161   int          mpe_id_begin;  /* MPE IDs that define the event */
162   int          mpe_id_end;
163 #endif
164 } PetscEventRegInfo;
165 
166 typedef struct {
167   int            id;            /* The integer identifying this event */
168   PetscBool      active;        /* The flag to activate logging */
169   PetscBool      visible;       /* The flag to print info in summary */
170   int            depth;         /* The nesting depth of the event call */
171   int            count;         /* The number of times this event was executed */
172   PetscLogDouble flops, flops2, flopsTmp; /* The flops and flops^2 used in this event */
173   PetscLogDouble time, time2, timeTmp;    /* The time and time^2 taken for this event */
174   PetscLogDouble syncTime;                /* The synchronization barrier time */
175   PetscLogDouble dof[8];        /* The number of degrees of freedom associated with this event */
176   PetscLogDouble errors[8];     /* The errors (user-defined) associated with this event */
177   PetscLogDouble numMessages;   /* The number of messages in this event */
178   PetscLogDouble messageLength; /* The total message lengths in this event */
179   PetscLogDouble numReductions; /* The number of reductions in this event */
180   PetscLogDouble memIncrease;   /* How much the resident memory has increased in this event */
181   PetscLogDouble mallocIncrease;/* How much the maximum malloced space has increased in this event */
182   PetscLogDouble mallocSpace;   /* How much the space was malloced and kept during this event */
183   PetscLogDouble mallocIncreaseEvent;  /* Maximum of the high water mark with in event minus memory available at the end of the event */
184   #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
185   PetscLogDouble CpuToGpuCount; /* The total number of CPU to GPU copies */
186   PetscLogDouble GpuToCpuCount; /* The total number of GPU to CPU copies */
187   PetscLogDouble CpuToGpuSize;  /* The total size of CPU to GPU copies */
188   PetscLogDouble GpuToCpuSize;  /* The total size of GPU to CPU copies */
189   PetscLogDouble GpuFlops;      /* The flops done on a GPU in this event */
190   PetscLogDouble GpuTime;       /* The time spent on a GPU in this event */
191   #endif
192 } PetscEventPerfInfo;
193 
194 typedef struct _n_PetscEventRegLog *PetscEventRegLog;
195 struct _n_PetscEventRegLog {
196   int               numEvents;  /* The number of registered events */
197   int               maxEvents;  /* The maximum number of events */
198   PetscEventRegInfo *eventInfo; /* The registration information for each event */
199 };
200 
201 typedef struct _n_PetscEventPerfLog *PetscEventPerfLog;
202 struct _n_PetscEventPerfLog {
203   int                numEvents;  /* The number of logging events */
204   int                maxEvents;  /* The maximum number of events */
205   PetscEventPerfInfo *eventInfo; /* The performance information for each event */
206 };
207 /* ------------------------------------------------------------------------------------------------------------*/
208 /*
209    PetscStageInfo - Contains all the information about a particular stage.
210 
211    PetscStageLog - An array of PetscStageInfo for each registered stage. There is a single one of these in the code.
212 */
213 typedef struct _PetscStageInfo {
214   char               *name;     /* The stage name */
215   PetscBool          used;      /* The stage was pushed on this processor */
216   PetscEventPerfInfo perfInfo;  /* The stage performance information */
217   PetscEventPerfLog  eventLog;  /* The event information for this stage */
218   PetscClassPerfLog  classLog;  /* The class information for this stage */
219 } PetscStageInfo;
220 
221 typedef struct _n_PetscStageLog *PetscStageLog;
222 struct _n_PetscStageLog {
223   int              numStages;   /* The number of registered stages */
224   int              maxStages;   /* The maximum number of stages */
225   PetscIntStack    stack;       /* The stack for active stages */
226   int              curStage;    /* The current stage (only used in macros so we don't call PetscIntStackTop) */
227   PetscStageInfo   *stageInfo;  /* The information for each stage */
228   PetscEventRegLog eventLog;    /* The registered events */
229   PetscClassRegLog classLog;    /* The registered classes */
230 };
231 /* -----------------------------------------------------------------------------------------------------*/
232 
233 PETSC_EXTERN PetscErrorCode PetscLogObjectParent(PetscObject,PetscObject);
234 PETSC_EXTERN PetscErrorCode PetscLogObjectMemory(PetscObject,PetscLogDouble);
235 
236 #if defined(PETSC_USE_LOG)  /* --- Logging is turned on --------------------------------*/
237 PETSC_EXTERN PetscStageLog petsc_stageLog;
238 PETSC_EXTERN PetscErrorCode PetscLogGetStageLog(PetscStageLog*);
239 PETSC_EXTERN PetscErrorCode PetscStageLogGetCurrent(PetscStageLog,int*);
240 PETSC_EXTERN PetscErrorCode PetscStageLogGetEventPerfLog(PetscStageLog,int,PetscEventPerfLog*);
241 
242 /*
243    Flop counting:  We count each arithmetic operation (e.g., addition, multiplication) separately.
244 
245    For the complex numbers version, note that
246        1 complex addition = 2 flops
247        1 complex multiplication = 6 flops,
248    where we define 1 flop as that for a double precision scalar.  We roughly approximate
249    flop counting for complex numbers by multiplying the total flops by 4; this corresponds
250    to the assumption that we're counting mostly additions and multiplications -- and
251    roughly the same number of each.  More accurate counting could be done by distinguishing
252    among the various arithmetic operations.
253  */
254 
255 #if defined(PETSC_USE_COMPLEX)
256 #define PETSC_FLOPS_PER_OP 4.0
257 #else
258 #define PETSC_FLOPS_PER_OP 1.0
259 #endif
260 
261 PETSC_STATIC_INLINE PetscErrorCode PetscLogFlops(PetscLogDouble n)
262 {
263   PetscFunctionBegin;
264 #if defined(PETSC_USE_DEBUG)
265   if (n < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Cannot log negative flops");
266 #endif
267   petsc_TotalFlops += PETSC_FLOPS_PER_OP*n;
268   PetscFunctionReturn(0);
269 }
270 
271 #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
272 PETSC_STATIC_INLINE PetscErrorCode PetscLogCpuToGpu(PetscLogDouble size)
273 {
274   PetscFunctionBegin;
275   petsc_ctog_ct += 1;
276   petsc_ctog_sz += size;
277   PetscFunctionReturn(0);
278 }
279 
280 PETSC_STATIC_INLINE PetscErrorCode PetscLogGpuToCpu(PetscLogDouble size)
281 {
282   PetscFunctionBegin;
283   petsc_gtoc_ct += 1;
284   petsc_gtoc_sz += size;
285   PetscFunctionReturn(0);
286 }
287 
288 PETSC_STATIC_INLINE PetscErrorCode PetscLogGpuFlops(PetscLogDouble n)
289 {
290   PetscFunctionBegin;
291 #if defined(PETSC_USE_DEBUG)
292   if (n < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Cannot log negative flops");
293 #endif
294   petsc_TotalFlops += PETSC_FLOPS_PER_OP*n;
295   petsc_gflops += PETSC_FLOPS_PER_OP*n;
296   PetscFunctionReturn(0);
297 }
298 
299 #if defined(PETSC_USE_DEBUG)
300 static PetscBool petsc_gtime_inuse = PETSC_FALSE;
301 #endif
302 
303 PETSC_STATIC_INLINE PetscErrorCode PetscLogGpuTimeBegin()
304 {
305   PetscErrorCode ierr;
306   PetscFunctionBegin;
307 #if defined(PETSC_USE_DEBUG)
308   if (petsc_gtime_inuse) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Forgot to call PetscLogGpuTimeEnd()?");
309   petsc_gtime_inuse = PETSC_TRUE;
310 #endif
311   ierr = PetscTimeSubtract(&petsc_gtime);CHKERRQ(ierr);
312   PetscFunctionReturn(0);
313 }
314 
315 PETSC_STATIC_INLINE PetscErrorCode PetscLogGpuTimeEnd()
316 {
317   PetscErrorCode ierr;
318   PetscFunctionBegin;
319 #if defined(PETSC_USE_DEBUG)
320   if (!petsc_gtime_inuse) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Forgot to call PetscLogGpuTimeBegin()?");
321   petsc_gtime_inuse = PETSC_FALSE;
322 #endif
323   ierr = PetscTimeAdd(&petsc_gtime);CHKERRQ(ierr);
324   PetscFunctionReturn(0);
325 }
326 
327 PETSC_STATIC_INLINE PetscErrorCode PetscLogGpuTimeAdd(PetscLogDouble t)
328 {
329   PetscFunctionBegin;
330   petsc_gtime += t;
331   PetscFunctionReturn(0);
332 }
333 #endif
334 
335 PETSC_EXTERN PetscErrorCode PetscGetFlops(PetscLogDouble *);
336 
337 #if defined (PETSC_HAVE_MPE)
338 PETSC_EXTERN PetscErrorCode PetscLogMPEBegin(void);
339 PETSC_EXTERN PetscErrorCode PetscLogMPEDump(const char[]);
340 #endif
341 
342 PETSC_EXTERN PetscErrorCode (*PetscLogPLB)(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
343 PETSC_EXTERN PetscErrorCode (*PetscLogPLE)(PetscLogEvent,int,PetscObject,PetscObject,PetscObject,PetscObject);
344 PETSC_EXTERN PetscErrorCode (*PetscLogPHC)(PetscObject);
345 PETSC_EXTERN PetscErrorCode (*PetscLogPHD)(PetscObject);
346 
347 #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)
348 #define PetscLogObjectCreate(h)      ((PetscLogPHC) ? (*PetscLogPHC)((PetscObject)(h)) : 0)
349 #define PetscLogObjectDestroy(h)     ((PetscLogPHD) ? (*PetscLogPHD)((PetscObject)(h)) : 0)
350 PETSC_EXTERN PetscErrorCode PetscLogObjectState(PetscObject, const char[], ...);
351 
352 /* Initialization functions */
353 PETSC_EXTERN PetscErrorCode PetscLogDefaultBegin(void);
354 PETSC_EXTERN PetscErrorCode PetscLogAllBegin(void);
355 PETSC_EXTERN PetscErrorCode PetscLogNestedBegin(void);
356 PETSC_EXTERN PetscErrorCode PetscLogTraceBegin(FILE *);
357 PETSC_EXTERN PetscErrorCode PetscLogActions(PetscBool);
358 PETSC_EXTERN PetscErrorCode PetscLogObjects(PetscBool);
359 PETSC_EXTERN PetscErrorCode PetscLogSetThreshold(PetscLogDouble,PetscLogDouble*);
360 PETSC_EXTERN PetscErrorCode PetscLogSet(PetscErrorCode (*)(int, int, PetscObject, PetscObject, PetscObject, PetscObject),
361                                         PetscErrorCode (*)(int, int, PetscObject, PetscObject, PetscObject, PetscObject));
362 
363 /* Output functions */
364 PETSC_EXTERN PetscErrorCode PetscLogView(PetscViewer);
365 PETSC_EXTERN PetscErrorCode PetscLogViewFromOptions(void);
366 PETSC_EXTERN PetscErrorCode PetscLogDump(const char[]);
367 
368 /* Stage functions */
369 PETSC_EXTERN PetscErrorCode PetscLogStageRegister(const char[],PetscLogStage*);
370 PETSC_EXTERN PetscErrorCode PetscLogStagePush(PetscLogStage);
371 PETSC_EXTERN PetscErrorCode PetscLogStagePop(void);
372 PETSC_EXTERN PetscErrorCode PetscLogStageSetActive(PetscLogStage,PetscBool);
373 PETSC_EXTERN PetscErrorCode PetscLogStageGetActive(PetscLogStage,PetscBool*);
374 PETSC_EXTERN PetscErrorCode PetscLogStageSetVisible(PetscLogStage,PetscBool);
375 PETSC_EXTERN PetscErrorCode PetscLogStageGetVisible(PetscLogStage,PetscBool*);
376 PETSC_EXTERN PetscErrorCode PetscLogStageGetId(const char[],PetscLogStage*);
377 
378 /* Event functions */
379 PETSC_EXTERN PetscErrorCode PetscLogEventRegister(const char[],PetscClassId,PetscLogEvent*);
380 PETSC_EXTERN PetscErrorCode PetscLogEventSetCollective(PetscLogEvent,PetscBool);
381 PETSC_EXTERN PetscErrorCode PetscLogEventIncludeClass(PetscClassId);
382 PETSC_EXTERN PetscErrorCode PetscLogEventExcludeClass(PetscClassId);
383 PETSC_EXTERN PetscErrorCode PetscLogEventActivate(PetscLogEvent);
384 PETSC_EXTERN PetscErrorCode PetscLogEventDeactivate(PetscLogEvent);
385 PETSC_EXTERN PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent,PetscBool);
386 PETSC_EXTERN PetscErrorCode PetscLogEventActivateClass(PetscClassId);
387 PETSC_EXTERN PetscErrorCode PetscLogEventDeactivateClass(PetscClassId);
388 PETSC_EXTERN PetscErrorCode PetscLogEventGetId(const char[],PetscLogEvent*);
389 PETSC_EXTERN PetscErrorCode PetscLogEventGetPerfInfo(int,PetscLogEvent,PetscEventPerfInfo*);
390 PETSC_EXTERN PetscErrorCode PetscLogEventSetDof(PetscLogEvent, PetscInt, PetscLogDouble);
391 PETSC_EXTERN PetscErrorCode PetscLogEventSetError(PetscLogEvent, PetscInt, PetscLogDouble);
392 
393 /* Global counters */
394 PETSC_EXTERN PetscLogDouble petsc_irecv_ct;
395 PETSC_EXTERN PetscLogDouble petsc_isend_ct;
396 PETSC_EXTERN PetscLogDouble petsc_recv_ct;
397 PETSC_EXTERN PetscLogDouble petsc_send_ct;
398 PETSC_EXTERN PetscLogDouble petsc_irecv_len;
399 PETSC_EXTERN PetscLogDouble petsc_isend_len;
400 PETSC_EXTERN PetscLogDouble petsc_recv_len;
401 PETSC_EXTERN PetscLogDouble petsc_send_len;
402 PETSC_EXTERN PetscLogDouble petsc_allreduce_ct;
403 PETSC_EXTERN PetscLogDouble petsc_gather_ct;
404 PETSC_EXTERN PetscLogDouble petsc_scatter_ct;
405 PETSC_EXTERN PetscLogDouble petsc_wait_ct;
406 PETSC_EXTERN PetscLogDouble petsc_wait_any_ct;
407 PETSC_EXTERN PetscLogDouble petsc_wait_all_ct;
408 PETSC_EXTERN PetscLogDouble petsc_sum_of_waits_ct;
409 
410 PETSC_EXTERN PetscBool      PetscLogMemory;
411 
412 PETSC_EXTERN PetscBool PetscLogSyncOn;  /* true if logging synchronization is enabled */
413 PETSC_EXTERN PetscErrorCode PetscLogEventSynchronize(PetscLogEvent, MPI_Comm);
414 
415 #define PetscLogEventSync(e,comm) \
416   (((PetscLogPLB && petsc_stageLog->stageInfo[petsc_stageLog->curStage].perfInfo.active && petsc_stageLog->stageInfo[petsc_stageLog->curStage].eventLog->eventInfo[e].active) ? \
417     PetscLogEventSynchronize((e),(comm)) : 0 ))
418 
419 #define PetscLogEventBegin(e,o1,o2,o3,o4) \
420   (((PetscLogPLB && petsc_stageLog->stageInfo[petsc_stageLog->curStage].perfInfo.active && petsc_stageLog->stageInfo[petsc_stageLog->curStage].eventLog->eventInfo[e].active) ? \
421     (*PetscLogPLB)((e),0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4)) : 0 ))
422 
423 #define PetscLogEventEnd(e,o1,o2,o3,o4) \
424   (((PetscLogPLE && petsc_stageLog->stageInfo[petsc_stageLog->curStage].perfInfo.active && petsc_stageLog->stageInfo[petsc_stageLog->curStage].eventLog->eventInfo[e].active) ? \
425     (*PetscLogPLE)((e),0,(PetscObject)(o1),(PetscObject)(o2),(PetscObject)(o3),(PetscObject)(o4)) : 0 ))
426 
427 PETSC_EXTERN PetscErrorCode PetscLogEventGetFlops(PetscLogEvent,PetscLogDouble*);
428 PETSC_EXTERN PetscErrorCode PetscLogEventZeroFlops(PetscLogEvent);
429 
430 /*
431      These are used internally in the PETSc routines to keep a count of MPI messages and
432    their sizes.
433 
434      This does not work for MPI-Uni because our include/petsc/mpiuni/mpi.h file
435    uses macros to defined the MPI operations.
436 
437      It does not work correctly from HP-UX because it processes the
438    macros in a way that sometimes it double counts, hence
439    PETSC_HAVE_BROKEN_RECURSIVE_MACRO
440 
441      It does not work with Windows because winmpich lacks MPI_Type_size()
442 */
443 #if !defined(MPIUNI_H) && !defined(PETSC_HAVE_BROKEN_RECURSIVE_MACRO) && !defined (PETSC_HAVE_MPI_MISSING_TYPESIZE)
444 /*
445    Logging of MPI activities
446 */
447 PETSC_STATIC_INLINE PetscErrorCode PetscMPITypeSize(PetscInt count,MPI_Datatype type,PetscLogDouble *length)
448 {
449   PetscMPIInt    typesize;
450   PetscErrorCode ierr;
451   if (type == MPI_DATATYPE_NULL) return 0;
452   ierr     = MPI_Type_size(type,&typesize);CHKERRQ(ierr);
453   *length += (PetscLogDouble) (count*typesize);
454   return 0;
455 }
456 
457 PETSC_STATIC_INLINE PetscErrorCode PetscMPITypeSizeComm(MPI_Comm comm,const PetscMPIInt *counts,MPI_Datatype type,PetscLogDouble *length)
458 {
459   PetscMPIInt    typesize,size,p;
460   PetscErrorCode ierr;
461 
462   if (type == MPI_DATATYPE_NULL) return 0;
463   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
464   ierr = MPI_Type_size(type,&typesize);CHKERRQ(ierr);
465   for (p=0; p<size; ++p) {
466     *length += (PetscLogDouble) (counts[p]*typesize);
467   }
468   return 0;
469 }
470 
471 PETSC_STATIC_INLINE PetscErrorCode PetscMPITypeSizeCount(PetscInt n,const PetscMPIInt *counts,MPI_Datatype type,PetscLogDouble *length)
472 {
473   PetscMPIInt    typesize,p;
474   PetscErrorCode ierr;
475 
476   if (type == MPI_DATATYPE_NULL) return 0;
477   ierr = MPI_Type_size(type,&typesize);CHKERRQ(ierr);
478   for (p=0; p<n; ++p) {
479     *length += (PetscLogDouble) (counts[p]*typesize);
480   }
481   return 0;
482 }
483 
484 /*
485     Returns 1 if the communicator is parallel else zero
486 */
487 PETSC_STATIC_INLINE int PetscMPIParallelComm(MPI_Comm comm)
488 {
489   PetscMPIInt size; MPI_Comm_size(comm,&size); return size > 1;
490 }
491 
492 #define MPI_Irecv(buf,count,datatype,source,tag,comm,request) \
493   ((petsc_irecv_ct++,0) || PetscMPITypeSize((count),(datatype),&(petsc_irecv_len)) || MPI_Irecv((buf),(count),(datatype),(source),(tag),(comm),(request)))
494 
495 #define MPI_Isend(buf,count,datatype,dest,tag,comm,request) \
496   ((petsc_isend_ct++,0) || PetscMPITypeSize((count),(datatype),&(petsc_isend_len)) || MPI_Isend((buf),(count),(datatype),(dest),(tag),(comm),(request)))
497 
498 #define MPI_Startall_irecv(count,datatype,number,requests) \
499   ((petsc_irecv_ct += (PetscLogDouble)(number),0) || PetscMPITypeSize((count),(datatype),&(petsc_irecv_len)) || ((number) && MPI_Startall((number),(requests))))
500 
501 #define MPI_Startall_isend(count,datatype,number,requests) \
502   ((petsc_isend_ct += (PetscLogDouble)(number),0) || PetscMPITypeSize((count),(datatype),&(petsc_isend_len)) || ((number) && MPI_Startall((number),(requests))))
503 
504 #define MPI_Start_isend(count,datatype,requests) \
505   ((petsc_isend_ct++,0) || PetscMPITypeSize((count),(datatype),(&petsc_isend_len)) || MPI_Start((requests)))
506 
507 #define MPI_Recv(buf,count,datatype,source,tag,comm,status) \
508   ((petsc_recv_ct++,0) || PetscMPITypeSize((count),(datatype),(&petsc_recv_len)) || MPI_Recv((buf),(count),(datatype),(source),(tag),(comm),(status)))
509 
510 #define MPI_Send(buf,count,datatype,dest,tag,comm) \
511   ((petsc_send_ct++,0) || PetscMPITypeSize((count),(datatype),(&petsc_send_len)) || MPI_Send((buf),(count),(datatype),(dest),(tag),(comm)))
512 
513 #define MPI_Wait(request,status) \
514   ((petsc_wait_ct++,petsc_sum_of_waits_ct++,0) || MPI_Wait((request),(status)))
515 
516 #define MPI_Waitany(a,b,c,d) \
517   ((petsc_wait_any_ct++,petsc_sum_of_waits_ct++,0) || MPI_Waitany((a),(b),(c),(d)))
518 
519 #define MPI_Waitall(count,array_of_requests,array_of_statuses) \
520   ((petsc_wait_all_ct++,petsc_sum_of_waits_ct += (PetscLogDouble) (count),0) || MPI_Waitall((count),(array_of_requests),(array_of_statuses)))
521 
522 #define MPI_Allreduce(sendbuf,recvbuf,count,datatype,op,comm) \
523   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || MPI_Allreduce((sendbuf),(recvbuf),(count),(datatype),(op),(comm)))
524 
525 #define MPI_Bcast(buffer,count,datatype,root,comm) \
526   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || MPI_Bcast((buffer),(count),(datatype),(root),(comm)))
527 
528 #define MPI_Reduce_scatter_block(sendbuf,recvbuf,recvcount,datatype,op,comm) \
529   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || MPI_Reduce_scatter_block((sendbuf),(recvbuf),(recvcount),(datatype),(op),(comm)))
530 
531 #define MPI_Alltoall(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm) \
532   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || PetscMPITypeSize((sendcount),(sendtype),(&petsc_send_len)) || MPI_Alltoall((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(comm)))
533 
534 #define MPI_Alltoallv(sendbuf,sendcnts,sdispls,sendtype,recvbuf,recvcnts,rdispls,recvtype,comm) \
535   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || PetscMPITypeSizeComm((comm),(sendcnts),(sendtype),(&petsc_send_len)) || MPI_Alltoallv((sendbuf),(sendcnts),(sdispls),(sendtype),(recvbuf),(recvcnts),(rdispls),(recvtype),(comm)))
536 
537 #define MPI_Allgather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm) \
538   ((petsc_gather_ct += PetscMPIParallelComm((comm)),0) || MPI_Allgather((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(comm)))
539 
540 #define MPI_Allgatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,comm) \
541   ((petsc_gather_ct += PetscMPIParallelComm((comm)),0) || MPI_Allgatherv((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(displs),(recvtype),(comm)))
542 
543 #define MPI_Gather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm) \
544   ((petsc_gather_ct++,0) || PetscMPITypeSize((sendcount),(sendtype),(&petsc_send_len)) || MPI_Gather((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(root),(comm)))
545 
546 #define MPI_Gatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,root,comm) \
547   ((petsc_gather_ct++,0) || PetscMPITypeSize((sendcount),(sendtype),(&petsc_send_len)) || MPI_Gatherv((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(displs),(recvtype),(root),(comm)))
548 
549 #define MPI_Scatter(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm) \
550   ((petsc_scatter_ct++,0) || PetscMPITypeSize((recvcount),(recvtype),(&petsc_recv_len)) || MPI_Scatter((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(root),(comm)))
551 
552 #define MPI_Scatterv(sendbuf,sendcount,displs,sendtype,recvbuf,recvcount,recvtype,root,comm) \
553   ((petsc_scatter_ct++,0) || PetscMPITypeSize((recvcount),(recvtype),(&petsc_recv_len)) || MPI_Scatterv((sendbuf),(sendcount),(displs),(sendtype),(recvbuf),(recvcount),(recvtype),(root),(comm)))
554 
555 #define MPI_Ialltoall(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm,request) \
556   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || PetscMPITypeSize((sendcount),(sendtype),(&petsc_send_len)) || MPI_Ialltoall((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(comm),(request)))
557 
558 #define MPI_Ialltoallv(sendbuf,sendcnts,sdispls,sendtype,recvbuf,recvcnts,rdispls,recvtype,comm,request) \
559   ((petsc_allreduce_ct += PetscMPIParallelComm((comm)),0) || PetscMPITypeSizeComm((comm),(sendcnts),(sendtype),(&petsc_send_len)) || MPI_Ialltoallv((sendbuf),(sendcnts),(sdispls),(sendtype),(recvbuf),(recvcnts),(rdispls),(recvtype),(comm),(request)))
560 
561 #define MPI_Iallgather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,comm,request) \
562   ((petsc_gather_ct += PetscMPIParallelComm((comm)),0) || MPI_Iallgather((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(comm),(request)))
563 
564 #define MPI_Iallgatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,comm,request) \
565   ((petsc_gather_ct += PetscMPIParallelComm((comm)),0) || MPI_Iallgatherv((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(displs),(recvtype),(comm),(request)))
566 
567 #define MPI_Igather(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm,request) \
568   ((petsc_gather_ct++,0) || PetscMPITypeSize((sendcount),(sendtype),(&petsc_send_len)) || MPI_Igather((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(root),(comm),(request)))
569 
570 #define MPI_Igatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount,displs,recvtype,root,comm,request) \
571   ((petsc_gather_ct++,0) || PetscMPITypeSize((sendcount),(sendtype),(&petsc_send_len)) || MPI_Igatherv((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(displs),(recvtype),(root),(comm),(request)))
572 
573 #define MPI_Iscatter(sendbuf,sendcount,sendtype,recvbuf,recvcount,recvtype,root,comm,request) \
574   ((petsc_scatter_ct++,0) || PetscMPITypeSize((recvcount),(recvtype),(&petsc_recv_len)) || MPI_Iscatter((sendbuf),(sendcount),(sendtype),(recvbuf),(recvcount),(recvtype),(root),(comm),(request)))
575 
576 #define MPI_Iscatterv(sendbuf,sendcount,displs,sendtype,recvbuf,recvcount,recvtype,root,comm,request) \
577   ((petsc_scatter_ct++,0) || PetscMPITypeSize((recvcount),(recvtype),(&petsc_recv_len)) || MPI_Iscatterv((sendbuf),(sendcount),(displs),(sendtype),(recvbuf),(recvcount),(recvtype),(root),(comm),(request)))
578 
579 /* We treat MPI_Ineighbor_alltoallv as a set of isend/irecv instead of a traditional MPI collective.
580    OpenMPI-3.0 ran into error with outdegree = indegree = 0, so we use ((outdegree) || (indegree)) as a workaround.
581  */
582 #define MPI_Start_ineighbor_alltoallv(outdegree,indegree,sendbuf,sendcnts,sdispls,sendtype,recvbuf,recvcnts,rdispls,recvtype,comm,request) \
583   ((petsc_isend_ct += (PetscLogDouble)(outdegree),0) || (petsc_irecv_ct += (PetscLogDouble)(indegree),0) || PetscMPITypeSizeCount((outdegree),(sendcnts),(sendtype),(&petsc_isend_len)) || PetscMPITypeSizeCount((indegree),(recvcnts),(recvtype),(&petsc_irecv_len)) || (((outdegree) || (indegree)) && MPI_Ineighbor_alltoallv((sendbuf),(sendcnts),(sdispls),(sendtype),(recvbuf),(recvcnts),(rdispls),(recvtype),(comm),(request))))
584 
585 #define MPI_Start_neighbor_alltoallv(outdegree,indegree,sendbuf,sendcnts,sdispls,sendtype,recvbuf,recvcnts,rdispls,recvtype,comm) \
586   ((petsc_isend_ct += (PetscLogDouble)(outdegree),0) || (petsc_irecv_ct += (PetscLogDouble)(indegree),0) || PetscMPITypeSizeCount((outdegree),(sendcnts),(sendtype),(&petsc_isend_len)) || PetscMPITypeSizeCount((indegree),(recvcnts),(recvtype),(&petsc_irecv_len)) || (((outdegree) || (indegree)) && MPI_Neighbor_alltoallv((sendbuf),(sendcnts),(sdispls),(sendtype),(recvbuf),(recvcnts),(rdispls),(recvtype),(comm))))
587 
588 #else
589 
590 #define MPI_Startall_irecv(count,datatype,number,requests) \
591   ((number) && MPI_Startall((number),(requests)))
592 
593 #define MPI_Startall_isend(count,datatype,number,requests) \
594   ((number) && MPI_Startall((number),(requests)))
595 
596 #define MPI_Start_isend(count,datatype,requests) \
597   (MPI_Start((requests)))
598 
599 #define MPI_Start_ineighbor_alltoallv(outdegree,indegree,sendbuf,sendcnts,sdispls,sendtype,recvbuf,recvcnts,rdispls,recvtype,comm,request) \
600   (((outdegree) || (indegree)) && MPI_Ineighbor_alltoallv((sendbuf),(sendcnts),(sdispls),(sendtype),(recvbuf),(recvcnts),(rdispls),(recvtype),(comm),(request)))
601 
602 #define MPI_Start_neighbor_alltoallv(outdegree,indegree,sendbuf,sendcnts,sdispls,sendtype,recvbuf,recvcnts,rdispls,recvtype,comm) \
603   (((outdegree) || (indegree)) && MPI_Neighbor_alltoallv((sendbuf),(sendcnts),(sdispls),(sendtype),(recvbuf),(recvcnts),(rdispls),(recvtype),(comm)))
604 #endif /* !MPIUNI_H && ! PETSC_HAVE_BROKEN_RECURSIVE_MACRO */
605 
606 #else  /* ---Logging is turned off --------------------------------------------*/
607 
608 #define PetscLogMemory                     PETSC_FALSE
609 
610 #define PetscLogFlops(n)                   0
611 #define PetscGetFlops(a)                   (*(a) = 0.0,0)
612 
613 #define PetscLogStageRegister(a,b)         0
614 #define PetscLogStagePush(a)               0
615 #define PetscLogStagePop()                 0
616 #define PetscLogStageSetActive(a,b)        0
617 #define PetscLogStageGetActive(a,b)        0
618 #define PetscLogStageGetVisible(a,b)       0
619 #define PetscLogStageSetVisible(a,b)       0
620 #define PetscLogStageGetId(a,b)            (*(b)=0,0)
621 
622 #define PetscLogEventRegister(a,b,c)       0
623 #define PetscLogEventSetCollective(a,b)    0
624 #define PetscLogEventIncludeClass(a)       0
625 #define PetscLogEventExcludeClass(a)       0
626 #define PetscLogEventActivate(a)           0
627 #define PetscLogEventDeactivate(a)         0
628 #define PetscLogEventActivateClass(a)      0
629 #define PetscLogEventDeactivateClass(a)    0
630 #define PetscLogEventSetActiveAll(a,b)     0
631 #define PetscLogEventGetId(a,b)            (*(b)=0,0)
632 #define PetscLogEventGetPerfInfo(a,b,c)    0
633 #define PetscLogEventSetDof(a,b,c)         0
634 #define PetscLogEventSetError(a,b,c)       0
635 
636 #define PetscLogPLB                        0
637 #define PetscLogPLE                        0
638 #define PetscLogPHC                        0
639 #define PetscLogPHD                        0
640 
641 #define PetscLogObjectParents(p,n,c)       0
642 #define PetscLogObjectCreate(h)            0
643 #define PetscLogObjectDestroy(h)           0
644 PETSC_EXTERN PetscErrorCode PetscLogObjectState(PetscObject,const char[],...);
645 
646 #define PetscLogDefaultBegin()             0
647 #define PetscLogAllBegin()                 0
648 #define PetscLogNestedBegin()              0
649 #define PetscLogTraceBegin(file)           0
650 #define PetscLogActions(a)                 0
651 #define PetscLogObjects(a)                 0
652 #define PetscLogSetThreshold(a,b)          0
653 #define PetscLogSet(lb,le)                 0
654 
655 #define PetscLogView(viewer)               0
656 #define PetscLogViewFromOptions()          0
657 #define PetscLogDump(c)                    0
658 
659 #define PetscLogEventSync(e,comm)          0
660 #define PetscLogEventBegin(e,o1,o2,o3,o4)  0
661 #define PetscLogEventEnd(e,o1,o2,o3,o4)    0
662 
663 #define PetscLogCpuToGpu(a)                0
664 #define PetscLogGpuToCpu(a)                0
665 #define PetscLogGpuFlops(a)                0
666 #define PetscLogGpuTimeBegin()             0
667 #define PetscLogGpuTimeEnd()               0
668 #define PetscLogGpuTimeAdd(a)              0
669 
670 /* If PETSC_USE_LOG is NOT defined, these still need to be! */
671 #define MPI_Startall_irecv(count,datatype,number,requests) ((number) && MPI_Startall(number,requests))
672 #define MPI_Startall_isend(count,datatype,number,requests) ((number) && MPI_Startall(number,requests))
673 #define MPI_Start_isend(count,datatype,requests)           MPI_Start(requests)
674 #define MPI_Start_ineighbor_alltoallv(outdegree,indegree,sendbuf,sendcnts,sdispls,sendtype,recvbuf,recvcnts,rdispls,recvtype,comm,request) \
675   (((outdegree) || (indegree)) && MPI_Ineighbor_alltoallv((sendbuf),(sendcnts),(sdispls),(sendtype),(recvbuf),(recvcnts),(rdispls),(recvtype),(comm),(request)))
676 #define MPI_Start_neighbor_alltoallv(outdegree,indegree,sendbuf,sendcnts,sdispls,sendtype,recvbuf,recvcnts,rdispls,recvtype,comm) \
677   (((outdegree) || (indegree)) && MPI_Neighbor_alltoallv((sendbuf),(sendcnts),(sdispls),(sendtype),(recvbuf),(recvcnts),(rdispls),(recvtype),(comm)))
678 
679 #endif   /* PETSC_USE_LOG */
680 
681 #define PetscPreLoadBegin(flag,name) \
682 do {\
683   PetscBool      PetscPreLoading = flag;\
684   int            PetscPreLoadMax,PetscPreLoadIt;\
685   PetscLogStage  _stageNum;\
686   PetscErrorCode _3_ierr; \
687   _3_ierr = PetscOptionsGetBool(NULL,NULL,"-preload",&PetscPreLoading,NULL);CHKERRQ(_3_ierr); \
688   PetscPreLoadMax = (int)(PetscPreLoading);\
689   PetscPreLoadingUsed = PetscPreLoading ? PETSC_TRUE : PetscPreLoadingUsed;\
690   for (PetscPreLoadIt=0; PetscPreLoadIt<=PetscPreLoadMax; PetscPreLoadIt++) {\
691     PetscPreLoadingOn = PetscPreLoading;\
692     _3_ierr = PetscBarrier(NULL);CHKERRQ(_3_ierr);\
693     if (PetscPreLoadIt>0) {\
694       _3_ierr = PetscLogStageGetId(name,&_stageNum);CHKERRQ(_3_ierr);\
695     } else {\
696       _3_ierr = PetscLogStageRegister(name,&_stageNum);CHKERRQ(_3_ierr); \
697     }\
698     _3_ierr = PetscLogStageSetActive(_stageNum,(PetscBool)(!PetscPreLoadMax || PetscPreLoadIt));\
699     _3_ierr = PetscLogStagePush(_stageNum);CHKERRQ(_3_ierr);
700 
701 #define PetscPreLoadEnd() \
702     _3_ierr = PetscLogStagePop();CHKERRQ(_3_ierr);\
703     PetscPreLoading = PETSC_FALSE;\
704   }\
705 } while (0)
706 
707 #define PetscPreLoadStage(name) do {                                         \
708     _3_ierr = PetscLogStagePop();CHKERRQ(_3_ierr);                      \
709     if (PetscPreLoadIt>0) {                                                  \
710       _3_ierr = PetscLogStageGetId(name,&_stageNum);CHKERRQ(_3_ierr);   \
711     } else {                                                            \
712       _3_ierr = PetscLogStageRegister(name,&_stageNum);CHKERRQ(_3_ierr); \
713     }                                                                   \
714     _3_ierr = PetscLogStageSetActive(_stageNum,(PetscBool)(!PetscPreLoadMax || PetscPreLoadIt)); \
715     _3_ierr = PetscLogStagePush(_stageNum);CHKERRQ(_3_ierr);            \
716   } while (0)
717 
718 /* some vars for logging */
719 PETSC_EXTERN PetscBool PetscPreLoadingUsed;       /* true if we are or have done preloading */
720 PETSC_EXTERN PetscBool PetscPreLoadingOn;         /* true if we are currently in a preloading calculation */
721 
722 #endif
723