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