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