1 /* 2 Defines profile/logging in PETSc. 3 */ 4 #ifndef PETSCLOG_H 5 #define PETSCLOG_H 6 7 #include <petscsys.h> 8 #include <petsctime.h> 9 #include <petscbt.h> 10 #include <petsclogtypes.h> 11 12 /* SUBMANSEC = Profiling */ 13 14 /* General logging of information; different from event logging */ 15 PETSC_EXTERN PetscErrorCode PetscInfo_Private(const char[], PetscObject, const char[], ...) PETSC_ATTRIBUTE_FORMAT(3, 4); 16 #if defined(PETSC_USE_INFO) 17 #define PetscInfo(A, ...) PetscInfo_Private(PETSC_FUNCTION_NAME, ((PetscObject)A), __VA_ARGS__) 18 #else 19 #define PetscInfo(A, ...) PETSC_SUCCESS 20 #endif 21 22 #define PetscInfo1(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "PetscInfo()", ) PetscInfo(__VA_ARGS__) 23 #define PetscInfo2(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "PetscInfo()", ) PetscInfo(__VA_ARGS__) 24 #define PetscInfo3(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "PetscInfo()", ) PetscInfo(__VA_ARGS__) 25 #define PetscInfo4(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "PetscInfo()", ) PetscInfo(__VA_ARGS__) 26 #define PetscInfo5(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "PetscInfo()", ) PetscInfo(__VA_ARGS__) 27 #define PetscInfo6(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "PetscInfo()", ) PetscInfo(__VA_ARGS__) 28 #define PetscInfo7(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "PetscInfo()", ) PetscInfo(__VA_ARGS__) 29 #define PetscInfo8(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "PetscInfo()", ) PetscInfo(__VA_ARGS__) 30 #define PetscInfo9(...) PETSC_DEPRECATED_MACRO(3, 17, 0, "PetscInfo()", ) PetscInfo(__VA_ARGS__) 31 32 /*E 33 PetscInfoCommFlag - Describes the method by which to filter information displayed by `PetscInfo()` by communicator size 34 35 Values: 36 + `PETSC_INFO_COMM_ALL` - Default uninitialized value. `PetscInfo()` will not filter based on 37 communicator size (i.e. will print for all communicators) 38 . `PETSC_INFO_COMM_NO_SELF` - `PetscInfo()` will NOT print for communicators with size = 1 (i.e. *_COMM_SELF) 39 - `PETSC_INFO_COMM_ONLY_SELF` - `PetscInfo()` will ONLY print for communicators with size = 1 40 41 Level: intermediate 42 43 Note: 44 Used as an input for `PetscInfoSetFilterCommSelf()` 45 46 .seealso: `PetscInfo()`, `PetscInfoSetFromOptions()`, `PetscInfoSetFilterCommSelf()` 47 E*/ 48 typedef enum { 49 PETSC_INFO_COMM_ALL = -1, 50 PETSC_INFO_COMM_NO_SELF = 0, 51 PETSC_INFO_COMM_ONLY_SELF = 1 52 } PetscInfoCommFlag; 53 54 PETSC_EXTERN const char *const PetscInfoCommFlags[]; 55 PETSC_EXTERN PetscErrorCode PetscInfoDeactivateClass(PetscClassId); 56 PETSC_EXTERN PetscErrorCode PetscInfoActivateClass(PetscClassId); 57 PETSC_EXTERN PetscErrorCode PetscInfoEnabled(PetscClassId, PetscBool *); 58 PETSC_EXTERN PetscErrorCode PetscInfoAllow(PetscBool); 59 PETSC_EXTERN PetscErrorCode PetscInfoSetFile(const char[], const char[]); 60 PETSC_EXTERN PetscErrorCode PetscInfoGetFile(char **, FILE **); 61 PETSC_EXTERN PetscErrorCode PetscInfoSetClasses(PetscBool, PetscInt, const char *const *); 62 PETSC_EXTERN PetscErrorCode PetscInfoGetClass(const char *, PetscBool *); 63 PETSC_EXTERN PetscErrorCode PetscInfoGetInfo(PetscBool *, PetscBool *, PetscBool *, PetscBool *, PetscInfoCommFlag *); 64 PETSC_EXTERN PetscErrorCode PetscInfoProcessClass(const char[], PetscInt, const PetscClassId[]); 65 PETSC_EXTERN PetscErrorCode PetscInfoSetFilterCommSelf(PetscInfoCommFlag); 66 PETSC_EXTERN PetscErrorCode PetscInfoSetFromOptions(PetscOptions); 67 PETSC_EXTERN PetscErrorCode PetscInfoDestroy(void); 68 PETSC_EXTERN PetscBool PetscLogPrintInfo; /* if true, indicates PetscInfo() is turned on */ 69 70 PETSC_EXTERN PetscErrorCode PetscIntStackCreate(PetscIntStack *); 71 PETSC_EXTERN PetscErrorCode PetscIntStackDestroy(PetscIntStack); 72 PETSC_EXTERN PetscErrorCode PetscIntStackPush(PetscIntStack, int); 73 PETSC_EXTERN PetscErrorCode PetscIntStackPop(PetscIntStack, int *); 74 PETSC_EXTERN PetscErrorCode PetscIntStackTop(PetscIntStack, int *); 75 PETSC_EXTERN PetscErrorCode PetscIntStackEmpty(PetscIntStack, PetscBool *); 76 77 PETSC_EXTERN PetscErrorCode PetscLogStateCreate(PetscLogState *); 78 PETSC_EXTERN PetscErrorCode PetscLogStateDestroy(PetscLogState *); 79 PETSC_EXTERN PetscErrorCode PetscLogStateGetRegistry(PetscLogState, PetscLogRegistry *); 80 81 PETSC_EXTERN PetscErrorCode PetscLogStateClassRegister(PetscLogState, const char[], PetscClassId, PetscLogStage *); 82 PETSC_EXTERN PetscErrorCode PetscLogStateClassSetActive(PetscLogState, PetscLogStage, PetscClassId, PetscBool); 83 PETSC_EXTERN PetscErrorCode PetscLogStateClassSetActiveAll(PetscLogState, PetscClassId, PetscBool); 84 85 PETSC_EXTERN PetscErrorCode PetscLogStateStageRegister(PetscLogState, const char[], PetscLogStage *); 86 PETSC_EXTERN PetscErrorCode PetscLogStateStagePush(PetscLogState, PetscLogStage); 87 PETSC_EXTERN PetscErrorCode PetscLogStateStagePop(PetscLogState); 88 PETSC_EXTERN PetscErrorCode PetscLogStateStageSetActive(PetscLogState, PetscLogStage, PetscBool); 89 PETSC_EXTERN PetscErrorCode PetscLogStateStageGetActive(PetscLogState, PetscLogStage, PetscBool *); 90 PETSC_EXTERN PetscErrorCode PetscLogStateGetCurrentStage(PetscLogState, PetscLogStage *); 91 92 PETSC_EXTERN PetscErrorCode PetscLogStateEventRegister(PetscLogState, const char[], PetscClassId, PetscLogEvent *); 93 PETSC_EXTERN PetscErrorCode PetscLogStateEventSetCollective(PetscLogState, PetscLogEvent, PetscBool); 94 PETSC_EXTERN PetscErrorCode PetscLogStateEventSetActive(PetscLogState, PetscLogStage, PetscLogEvent, PetscBool); 95 PETSC_EXTERN PetscErrorCode PetscLogStateEventSetActiveAll(PetscLogState, PetscLogEvent, PetscBool); 96 PETSC_EXTERN PetscErrorCode PetscLogStateEventGetActive(PetscLogState, PetscLogStage, PetscLogEvent, PetscBool *); 97 98 PETSC_EXTERN PetscErrorCode PetscLogStateGetEventFromName(PetscLogState, const char[], PetscLogEvent *); 99 PETSC_EXTERN PetscErrorCode PetscLogStateGetStageFromName(PetscLogState, const char[], PetscLogStage *); 100 PETSC_EXTERN PetscErrorCode PetscLogStateGetClassFromName(PetscLogState, const char[], PetscLogClass *); 101 PETSC_EXTERN PetscErrorCode PetscLogStateGetClassFromClassId(PetscLogState, PetscClassId, PetscLogClass *); 102 PETSC_EXTERN PetscErrorCode PetscLogStateGetNumEvents(PetscLogState, PetscInt *); 103 PETSC_EXTERN PetscErrorCode PetscLogStateGetNumStages(PetscLogState, PetscInt *); 104 PETSC_EXTERN PetscErrorCode PetscLogStateGetNumClasses(PetscLogState, PetscInt *); 105 PETSC_EXTERN PetscErrorCode PetscLogStateEventGetInfo(PetscLogState, PetscLogEvent, PetscLogEventInfo *); 106 PETSC_EXTERN PetscErrorCode PetscLogStateStageGetInfo(PetscLogState, PetscLogStage, PetscLogStageInfo *); 107 PETSC_EXTERN PetscErrorCode PetscLogStateClassGetInfo(PetscLogState, PetscLogClass, PetscLogClassInfo *); 108 109 PETSC_EXTERN PetscClassId PETSCLOGHANDLER_CLASSID; 110 111 PETSC_EXTERN PetscFunctionList PetscLogHandlerList; 112 113 PETSC_EXTERN PetscErrorCode PetscLogHandlerRegister(const char[], PetscErrorCode (*)(PetscLogHandler)); 114 PETSC_EXTERN PetscErrorCode PetscLogHandlerCreate(MPI_Comm, PetscLogHandler *); 115 PETSC_EXTERN PetscErrorCode PetscLogHandlerSetType(PetscLogHandler, PetscLogHandlerType); 116 PETSC_EXTERN PetscErrorCode PetscLogHandlerGetType(PetscLogHandler, PetscLogHandlerType *); 117 PETSC_EXTERN PetscErrorCode PetscLogHandlerDestroy(PetscLogHandler *); 118 PETSC_EXTERN PetscErrorCode PetscLogHandlerSetState(PetscLogHandler, PetscLogState); 119 PETSC_EXTERN PetscErrorCode PetscLogHandlerGetState(PetscLogHandler, PetscLogState *); 120 PETSC_EXTERN PetscErrorCode PetscLogHandlerEventBegin(PetscLogHandler, PetscLogEvent, PetscObject, PetscObject, PetscObject, PetscObject); 121 PETSC_EXTERN PetscErrorCode PetscLogHandlerEventEnd(PetscLogHandler, PetscLogEvent, PetscObject, PetscObject, PetscObject, PetscObject); 122 PETSC_EXTERN PetscErrorCode PetscLogHandlerEventSync(PetscLogHandler, PetscLogEvent, MPI_Comm); 123 PETSC_EXTERN PetscErrorCode PetscLogHandlerObjectCreate(PetscLogHandler, PetscObject); 124 PETSC_EXTERN PetscErrorCode PetscLogHandlerObjectDestroy(PetscLogHandler, PetscObject); 125 PETSC_EXTERN PetscErrorCode PetscLogHandlerStagePush(PetscLogHandler, PetscLogStage); 126 PETSC_EXTERN PetscErrorCode PetscLogHandlerStagePop(PetscLogHandler, PetscLogStage); 127 PETSC_EXTERN PetscErrorCode PetscLogHandlerView(PetscLogHandler, PetscViewer); 128 129 PETSC_EXTERN PetscErrorCode PetscLogHandlerCreateTrace(MPI_Comm, FILE *, PetscLogHandler *); 130 PETSC_EXTERN PetscErrorCode PetscLogHandlerCreateLegacy(MPI_Comm, PetscErrorCode (*)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), PetscErrorCode (*)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), PetscErrorCode (*)(PetscObject), PetscErrorCode (*)(PetscObject), PetscLogHandler *); 131 132 /* All events are inactive if an invalid stage is set, like if there have been more stage pops than stage pushes */ 133 #define PetscLogStateStageEventIsActive(state, stage, event) ((stage >= 0) && PetscBTLookup((state)->active, (stage)) && PetscBTLookup((state)->active, (stage) + (event + 1) * (state)->bt_num_stages)) 134 #define PetscLogStateEventCurrentlyActive(state, event) ((state) && PetscLogStateStageEventIsActive(state, (state)->current_stage, event)) 135 136 /* PetscLogHandler with critical methods exposed for speed */ 137 typedef struct _n_PetscLogHandlerHot { 138 PetscLogHandler handler; 139 PetscErrorCode (*eventBegin)(PetscLogHandler, PetscLogEvent, PetscObject, PetscObject, PetscObject, PetscObject); 140 PetscErrorCode (*eventEnd)(PetscLogHandler, PetscLogEvent, PetscObject, PetscObject, PetscObject, PetscObject); 141 PetscErrorCode (*eventSync)(PetscLogHandler, PetscLogEvent, MPI_Comm); 142 PetscErrorCode (*objectCreate)(PetscLogHandler, PetscObject); 143 PetscErrorCode (*objectDestroy)(PetscLogHandler, PetscObject); 144 } PetscLogHandlerHot; 145 146 /* Handle multithreading */ 147 #if defined(PETSC_HAVE_THREADSAFETY) 148 #if defined(__cplusplus) 149 #define PETSC_TLS thread_local 150 #else 151 #define PETSC_TLS _Thread_local 152 #endif 153 #define PETSC_EXTERN_TLS extern PETSC_TLS PETSC_VISIBILITY_PUBLIC 154 PETSC_EXTERN PetscErrorCode PetscAddLogDouble(PetscLogDouble *, PetscLogDouble *, PetscLogDouble); 155 PETSC_EXTERN PetscErrorCode PetscAddLogDoubleCnt(PetscLogDouble *, PetscLogDouble *, PetscLogDouble *, PetscLogDouble *, PetscLogDouble); 156 #else 157 #define PETSC_EXTERN_TLS PETSC_EXTERN 158 #define PETSC_TLS 159 #define PetscAddLogDouble(a, b, c) ((PetscErrorCode)((*(a) += (c), PETSC_SUCCESS) || ((*(b) += (c)), PETSC_SUCCESS))) 160 #define PetscAddLogDoubleCnt(a, b, c, d, e) ((PetscErrorCode)(PetscAddLogDouble(a, c, 1) || PetscAddLogDouble(b, d, e))) 161 #endif 162 163 PETSC_DEPRECATED_FUNCTION(3, 18, 0, "PetscLogObjectParent()", ) static inline PetscErrorCode PetscLogObjectParent(PetscObject o, PetscObject p) 164 { 165 (void)o; 166 (void)p; 167 return PETSC_SUCCESS; 168 } 169 #define PetscLogObjectParents(p, n, d) PetscMacroReturnStandard(for (int _i = 0; _i < (n); ++_i) PetscCall(PetscLogObjectParent((PetscObject)(p), (PetscObject)(d)[_i]));) 170 171 PETSC_DEPRECATED_FUNCTION(3, 18, 0, "PetscLogObjectMemory()", ) static inline PetscErrorCode PetscLogObjectMemory(PetscObject o, PetscLogDouble m) 172 { 173 (void)o; 174 (void)m; 175 return PETSC_SUCCESS; 176 } 177 178 /* Global flop counter */ 179 PETSC_EXTERN PetscLogDouble petsc_TotalFlops; 180 PETSC_EXTERN PetscLogDouble petsc_irecv_ct; 181 PETSC_EXTERN PetscLogDouble petsc_isend_ct; 182 PETSC_EXTERN PetscLogDouble petsc_recv_ct; 183 PETSC_EXTERN PetscLogDouble petsc_send_ct; 184 PETSC_EXTERN PetscLogDouble petsc_irecv_len; 185 PETSC_EXTERN PetscLogDouble petsc_isend_len; 186 PETSC_EXTERN PetscLogDouble petsc_recv_len; 187 PETSC_EXTERN PetscLogDouble petsc_send_len; 188 PETSC_EXTERN PetscLogDouble petsc_allreduce_ct; 189 PETSC_EXTERN PetscLogDouble petsc_gather_ct; 190 PETSC_EXTERN PetscLogDouble petsc_scatter_ct; 191 PETSC_EXTERN PetscLogDouble petsc_wait_ct; 192 PETSC_EXTERN PetscLogDouble petsc_wait_any_ct; 193 PETSC_EXTERN PetscLogDouble petsc_wait_all_ct; 194 PETSC_EXTERN PetscLogDouble petsc_sum_of_waits_ct; 195 196 /* Thread local storage */ 197 PETSC_EXTERN_TLS PetscLogDouble petsc_TotalFlops_th; 198 PETSC_EXTERN_TLS PetscLogDouble petsc_irecv_ct_th; 199 PETSC_EXTERN_TLS PetscLogDouble petsc_isend_ct_th; 200 PETSC_EXTERN_TLS PetscLogDouble petsc_recv_ct_th; 201 PETSC_EXTERN_TLS PetscLogDouble petsc_send_ct_th; 202 PETSC_EXTERN_TLS PetscLogDouble petsc_irecv_len_th; 203 PETSC_EXTERN_TLS PetscLogDouble petsc_isend_len_th; 204 PETSC_EXTERN_TLS PetscLogDouble petsc_recv_len_th; 205 PETSC_EXTERN_TLS PetscLogDouble petsc_send_len_th; 206 PETSC_EXTERN_TLS PetscLogDouble petsc_allreduce_ct_th; 207 PETSC_EXTERN_TLS PetscLogDouble petsc_gather_ct_th; 208 PETSC_EXTERN_TLS PetscLogDouble petsc_scatter_ct_th; 209 PETSC_EXTERN_TLS PetscLogDouble petsc_wait_ct_th; 210 PETSC_EXTERN_TLS PetscLogDouble petsc_wait_any_ct_th; 211 PETSC_EXTERN_TLS PetscLogDouble petsc_wait_all_ct_th; 212 PETSC_EXTERN_TLS PetscLogDouble petsc_sum_of_waits_ct_th; 213 214 /* Global GPU counters */ 215 PETSC_EXTERN PetscLogDouble petsc_ctog_ct; 216 PETSC_EXTERN PetscLogDouble petsc_gtoc_ct; 217 PETSC_EXTERN PetscLogDouble petsc_ctog_sz; 218 PETSC_EXTERN PetscLogDouble petsc_gtoc_sz; 219 PETSC_EXTERN PetscLogDouble petsc_ctog_ct_scalar; 220 PETSC_EXTERN PetscLogDouble petsc_gtoc_ct_scalar; 221 PETSC_EXTERN PetscLogDouble petsc_ctog_sz_scalar; 222 PETSC_EXTERN PetscLogDouble petsc_gtoc_sz_scalar; 223 PETSC_EXTERN PetscLogDouble petsc_gflops; 224 PETSC_EXTERN PetscLogDouble petsc_gtime; 225 226 /* Thread local storage */ 227 PETSC_EXTERN_TLS PetscLogDouble petsc_ctog_ct_th; 228 PETSC_EXTERN_TLS PetscLogDouble petsc_gtoc_ct_th; 229 PETSC_EXTERN_TLS PetscLogDouble petsc_ctog_sz_th; 230 PETSC_EXTERN_TLS PetscLogDouble petsc_gtoc_sz_th; 231 PETSC_EXTERN_TLS PetscLogDouble petsc_ctog_ct_scalar_th; 232 PETSC_EXTERN_TLS PetscLogDouble petsc_gtoc_ct_scalar_th; 233 PETSC_EXTERN_TLS PetscLogDouble petsc_ctog_sz_scalar_th; 234 PETSC_EXTERN_TLS PetscLogDouble petsc_gtoc_sz_scalar_th; 235 PETSC_EXTERN_TLS PetscLogDouble petsc_gflops_th; 236 PETSC_EXTERN_TLS PetscLogDouble petsc_gtime_th; 237 238 PETSC_EXTERN PetscBool PetscLogMemory; 239 PETSC_EXTERN PetscBool PetscLogSyncOn; /* true if logging synchronization is enabled */ 240 241 PETSC_EXTERN PetscLogState petsc_log_state; 242 243 #define PETSC_LOG_HANDLER_MAX 4 244 PETSC_EXTERN PetscLogHandlerHot PetscLogHandlers[PETSC_LOG_HANDLER_MAX]; 245 246 #if defined(PETSC_USE_LOG) /* --- Logging is turned on --------------------------------*/ 247 PETSC_EXTERN PetscErrorCode PetscGetFlops(PetscLogDouble *); 248 249 PETSC_EXTERN PetscErrorCode PetscLogObjectState(PetscObject, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3); 250 251 /* Initialization functions */ 252 PETSC_EXTERN PetscErrorCode PetscLogDefaultBegin(void); 253 PETSC_EXTERN PetscErrorCode PetscLogNestedBegin(void); 254 PETSC_EXTERN PetscErrorCode PetscLogTraceBegin(FILE *); 255 PETSC_EXTERN PetscErrorCode PetscLogMPEBegin(void); 256 PETSC_EXTERN PetscErrorCode PetscLogPerfstubsBegin(void); 257 PETSC_EXTERN PetscErrorCode PetscLogLegacyCallbacksBegin(PetscErrorCode (*)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), PetscErrorCode (*)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), PetscErrorCode (*)(PetscObject), PetscErrorCode (*)(PetscObject)); 258 PETSC_EXTERN PetscErrorCode PetscLogActions(PetscBool); 259 PETSC_EXTERN PetscErrorCode PetscLogObjects(PetscBool); 260 PETSC_EXTERN PetscErrorCode PetscLogSetThreshold(PetscLogDouble, PetscLogDouble *); 261 262 /* Output functions */ 263 PETSC_EXTERN PetscErrorCode PetscLogView(PetscViewer); 264 PETSC_EXTERN PetscErrorCode PetscLogViewFromOptions(void); 265 PETSC_EXTERN PetscErrorCode PetscLogDump(const char[]); 266 PETSC_EXTERN PetscErrorCode PetscLogMPEDump(const char[]); 267 268 PETSC_EXTERN PetscErrorCode PetscLogGetState(PetscLogState *); 269 PETSC_EXTERN PetscErrorCode PetscLogGetDefaultHandler(PetscLogHandler *); 270 PETSC_EXTERN PetscErrorCode PetscLogHandlerStart(PetscLogHandler); 271 PETSC_EXTERN PetscErrorCode PetscLogHandlerStop(PetscLogHandler); 272 273 /* Status checking functions */ 274 PETSC_EXTERN PetscErrorCode PetscLogIsActive(PetscBool *); 275 276 /* Stage functions */ 277 PETSC_EXTERN PetscErrorCode PetscLogStageRegister(const char[], PetscLogStage *); 278 PETSC_EXTERN PetscErrorCode PetscLogStagePush(PetscLogStage); 279 PETSC_EXTERN PetscErrorCode PetscLogStagePop(void); 280 PETSC_EXTERN PetscErrorCode PetscLogStageSetActive(PetscLogStage, PetscBool); 281 PETSC_EXTERN PetscErrorCode PetscLogStageGetActive(PetscLogStage, PetscBool *); 282 PETSC_EXTERN PetscErrorCode PetscLogStageSetVisible(PetscLogStage, PetscBool); 283 PETSC_EXTERN PetscErrorCode PetscLogStageGetVisible(PetscLogStage, PetscBool *); 284 PETSC_EXTERN PetscErrorCode PetscLogStageGetId(const char[], PetscLogStage *); 285 PETSC_EXTERN PetscErrorCode PetscLogStageGetName(PetscLogEvent, const char **); 286 287 /* Event functions */ 288 PETSC_EXTERN PetscErrorCode PetscLogEventRegister(const char[], PetscClassId, PetscLogEvent *); 289 PETSC_EXTERN PetscErrorCode PetscLogEventSetCollective(PetscLogEvent, PetscBool); 290 PETSC_EXTERN PetscErrorCode PetscLogEventIncludeClass(PetscClassId); 291 PETSC_EXTERN PetscErrorCode PetscLogEventExcludeClass(PetscClassId); 292 PETSC_EXTERN PetscErrorCode PetscLogEventActivate(PetscLogEvent); 293 PETSC_EXTERN PetscErrorCode PetscLogEventDeactivate(PetscLogEvent); 294 PETSC_EXTERN PetscErrorCode PetscLogEventDeactivatePush(PetscLogEvent); 295 PETSC_EXTERN PetscErrorCode PetscLogEventDeactivatePop(PetscLogEvent); 296 PETSC_EXTERN PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent, PetscBool); 297 PETSC_EXTERN PetscErrorCode PetscLogEventActivateClass(PetscClassId); 298 PETSC_EXTERN PetscErrorCode PetscLogEventDeactivateClass(PetscClassId); 299 PETSC_EXTERN PetscErrorCode PetscLogEventGetId(const char[], PetscLogEvent *); 300 PETSC_EXTERN PetscErrorCode PetscLogEventGetName(PetscLogEvent, const char **); 301 PETSC_EXTERN PetscErrorCode PetscLogEventGetPerfInfo(PetscLogStage, PetscLogEvent, PetscEventPerfInfo *); 302 PETSC_EXTERN PetscErrorCode PetscLogEventSetDof(PetscLogEvent, PetscInt, PetscLogDouble); 303 PETSC_EXTERN PetscErrorCode PetscLogEventSetError(PetscLogEvent, PetscInt, PetscLogDouble); 304 PETSC_EXTERN PetscErrorCode PetscLogEventsPause(void); 305 PETSC_EXTERN PetscErrorCode PetscLogEventsResume(void); 306 307 /* Class functions */ 308 PETSC_EXTERN PetscErrorCode PetscLogClassGetClassId(const char[], PetscClassId *); 309 PETSC_EXTERN PetscErrorCode PetscLogClassIdGetName(PetscClassId, const char **); 310 311 static inline PETSC_UNUSED PetscErrorCode PetscLogEventSync(PetscLogEvent e, MPI_Comm comm) 312 { 313 if (PetscLogStateEventCurrentlyActive(petsc_log_state, e)) { 314 for (int i = 0; i < PETSC_LOG_HANDLER_MAX; i++) { 315 PetscLogHandlerHot *h = &PetscLogHandlers[i]; 316 if (h->eventSync) { 317 PetscErrorCode err = (*(h->eventSync))(h->handler, e, comm); 318 if (err != PETSC_SUCCESS) return err; 319 } 320 } 321 } 322 return PETSC_SUCCESS; 323 } 324 325 static inline PETSC_UNUSED PetscErrorCode PetscLogEventBegin_Internal(PetscLogEvent e, PetscObject o1, PetscObject o2, PetscObject o3, PetscObject o4) 326 { 327 if (PetscLogStateEventCurrentlyActive(petsc_log_state, e)) { 328 for (int i = 0; i < PETSC_LOG_HANDLER_MAX; i++) { 329 PetscLogHandlerHot *h = &PetscLogHandlers[i]; 330 if (h->eventBegin) { 331 PetscErrorCode err = (*(h->eventBegin))(h->handler, e, o1, o2, o3, o4); 332 if (err != PETSC_SUCCESS) return err; 333 } 334 } 335 } 336 return PETSC_SUCCESS; 337 } 338 #define PetscLogEventBegin(e, o1, o2, o3, o4) PetscLogEventBegin_Internal(e, (PetscObject)(o1), (PetscObject)(o2), (PetscObject)(o3), (PetscObject)(o4)) 339 340 static inline PETSC_UNUSED PetscErrorCode PetscLogEventEnd_Internal(PetscLogEvent e, PetscObject o1, PetscObject o2, PetscObject o3, PetscObject o4) 341 { 342 if (PetscLogStateEventCurrentlyActive(petsc_log_state, e)) { 343 for (int i = 0; i < PETSC_LOG_HANDLER_MAX; i++) { 344 PetscLogHandlerHot *h = &PetscLogHandlers[i]; 345 if (h->eventEnd) { 346 PetscErrorCode err = (*(h->eventEnd))(h->handler, e, o1, o2, o3, o4); 347 if (err != PETSC_SUCCESS) return err; 348 } 349 } 350 } 351 return PETSC_SUCCESS; 352 } 353 #define PetscLogEventEnd(e, o1, o2, o3, o4) PetscLogEventEnd_Internal(e, (PetscObject)(o1), (PetscObject)(o2), (PetscObject)(o3), (PetscObject)(o4)) 354 355 /* Object functions */ 356 static inline PETSC_UNUSED PetscErrorCode PetscLogObjectCreate_Internal(PetscObject o) 357 { 358 if (petsc_log_state) { 359 for (int i = 0; i < PETSC_LOG_HANDLER_MAX; i++) { 360 PetscLogHandlerHot *h = &PetscLogHandlers[i]; 361 if (h->objectCreate) { 362 PetscErrorCode err = (*(h->objectCreate))(h->handler, o); 363 if (err != PETSC_SUCCESS) return err; 364 } 365 } 366 } 367 return PETSC_SUCCESS; 368 } 369 #define PetscLogObjectCreate(o) PetscLogObjectCreate_Internal((PetscObject)(o)) 370 371 static inline PETSC_UNUSED PetscErrorCode PetscLogObjectDestroy_Internal(PetscObject o) 372 { 373 if (petsc_log_state) { 374 for (int i = 0; i < PETSC_LOG_HANDLER_MAX; i++) { 375 PetscLogHandlerHot *h = &PetscLogHandlers[i]; 376 if (h->objectDestroy) { 377 PetscErrorCode err = (*(h->objectDestroy))(h->handler, o); 378 if (err != PETSC_SUCCESS) return err; 379 } 380 } 381 } 382 return PETSC_SUCCESS; 383 } 384 #define PetscLogObjectDestroy(o) PetscLogObjectDestroy_Internal((PetscObject)(o)) 385 386 /* 387 Flop counting: We count each arithmetic operation (e.g., addition, multiplication) separately. 388 389 For the complex numbers version, note that 390 1 complex addition = 2 flops 391 1 complex multiplication = 6 flops, 392 where we define 1 flop as that for a double precision scalar. We roughly approximate 393 flop counting for complex numbers by multiplying the total flops by 4; this corresponds 394 to the assumption that we're counting mostly additions and multiplications -- and 395 roughly the same number of each. More accurate counting could be done by distinguishing 396 among the various arithmetic operations. 397 */ 398 399 #if defined(PETSC_USE_COMPLEX) 400 #define PETSC_FLOPS_PER_OP 4.0 401 #else 402 #define PETSC_FLOPS_PER_OP 1.0 403 #endif 404 405 /*@C 406 PetscLogFlops - Log how many flops are performed in a calculation 407 408 Input Parameter: 409 . flops - the number of flops 410 411 Level: intermediate 412 413 Note: 414 To limit the chance of integer overflow when multiplying by a constant, represent the constant as a double, 415 not an integer. Use `PetscLogFlops`(4.0*n) not `PetscLogFlops`(4*n) 416 417 .seealso: [](ch_profiling), `PetscLogView()`, `PetscLogGpuFlops()` 418 @*/ 419 static inline PetscErrorCode PetscLogFlops(PetscLogDouble n) 420 { 421 PetscAssert(n >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Cannot log negative flops"); 422 return PetscAddLogDouble(&petsc_TotalFlops, &petsc_TotalFlops_th, PETSC_FLOPS_PER_OP * n); 423 } 424 425 /* 426 These are used internally in the PETSc routines to keep a count of MPI messages and 427 their sizes. 428 429 This does not work for MPI-Uni because our include/petsc/mpiuni/mpi.h file 430 uses macros to defined the MPI operations. 431 432 It does not work correctly from HP-UX because it processes the 433 macros in a way that sometimes it double counts, hence 434 PETSC_HAVE_BROKEN_RECURSIVE_MACRO 435 436 It does not work with Windows because winmpich lacks MPI_Type_size() 437 */ 438 #if !defined(MPIUNI_H) && !defined(PETSC_HAVE_BROKEN_RECURSIVE_MACRO) 439 /* 440 Logging of MPI activities 441 */ 442 static inline PetscErrorCode PetscMPITypeSize(PetscInt count, MPI_Datatype type, PetscLogDouble *length, PetscLogDouble *length_th) 443 { 444 PetscMPIInt typesize; 445 446 if (type == MPI_DATATYPE_NULL) return PETSC_SUCCESS; 447 PetscCallMPI(MPI_Type_size(type, &typesize)); 448 return PetscAddLogDouble(length, length_th, (PetscLogDouble)(count * typesize)); 449 } 450 451 static inline PetscErrorCode PetscMPITypeSizeComm(MPI_Comm comm, const PetscMPIInt *counts, MPI_Datatype type, PetscLogDouble *length, PetscLogDouble *length_th) 452 { 453 PetscMPIInt typesize, size, p; 454 PetscLogDouble l; 455 456 if (type == MPI_DATATYPE_NULL) return PETSC_SUCCESS; 457 PetscCallMPI(MPI_Comm_size(comm, &size)); 458 PetscCallMPI(MPI_Type_size(type, &typesize)); 459 for (p = 0, l = 0.0; p < size; ++p) l += (PetscLogDouble)(counts[p] * typesize); 460 return PetscAddLogDouble(length, length_th, l); 461 } 462 463 /* 464 Returns 1 if the communicator is parallel else zero 465 */ 466 static inline int PetscMPIParallelComm(MPI_Comm comm) 467 { 468 PetscMPIInt size; 469 MPI_Comm_size(comm, &size); 470 return size > 1; 471 } 472 473 #define MPI_Irecv(buf, count, datatype, source, tag, comm, request) \ 474 (PetscAddLogDouble(&petsc_irecv_ct, &petsc_irecv_ct_th, 1) || PetscMPITypeSize((count), (datatype), &(petsc_irecv_len), &(petsc_irecv_len_th)) || MPI_Irecv((buf), (count), (datatype), (source), (tag), (comm), (request))) 475 476 #define MPI_Irecv_c(buf, count, datatype, source, tag, comm, request) \ 477 (PetscAddLogDouble(&petsc_irecv_ct, &petsc_irecv_ct_th, 1) || PetscMPITypeSize((count), (datatype), &(petsc_irecv_len), &(petsc_irecv_len_th)) || MPI_Irecv_c((buf), (count), (datatype), (source), (tag), (comm), (request))) 478 479 #define MPI_Isend(buf, count, datatype, dest, tag, comm, request) \ 480 (PetscAddLogDouble(&petsc_isend_ct, &petsc_isend_ct_th, 1) || PetscMPITypeSize((count), (datatype), &(petsc_isend_len), &(petsc_isend_len_th)) || MPI_Isend((buf), (count), (datatype), (dest), (tag), (comm), (request))) 481 482 #define MPI_Isend_c(buf, count, datatype, dest, tag, comm, request) \ 483 (PetscAddLogDouble(&petsc_isend_ct, &petsc_isend_ct_th, 1) || PetscMPITypeSize((count), (datatype), &(petsc_isend_len), &(petsc_isend_len_th)) || MPI_Isend_c((buf), (count), (datatype), (dest), (tag), (comm), (request))) 484 485 #define MPI_Startall_irecv(count, datatype, number, requests) \ 486 (PetscAddLogDouble(&petsc_irecv_ct, &petsc_irecv_ct_th, number) || PetscMPITypeSize((count), (datatype), &(petsc_irecv_len), &(petsc_irecv_len_th)) || ((number) && MPI_Startall((number), (requests)))) 487 488 #define MPI_Startall_isend(count, datatype, number, requests) \ 489 (PetscAddLogDouble(&petsc_isend_ct, &petsc_isend_ct_th, number) || PetscMPITypeSize((count), (datatype), &(petsc_isend_len), &(petsc_isend_len_th)) || ((number) && MPI_Startall((number), (requests)))) 490 491 #define MPI_Start_isend(count, datatype, requests) (PetscAddLogDouble(&petsc_isend_ct, &petsc_isend_ct_th, 1) || PetscMPITypeSize((count), (datatype), (&petsc_isend_len), (&petsc_isend_len_th)) || MPI_Start((requests))) 492 493 #define MPI_Recv(buf, count, datatype, source, tag, comm, status) \ 494 (PetscAddLogDouble(&petsc_recv_ct, &petsc_recv_ct_th, 1) || PetscMPITypeSize((count), (datatype), (&petsc_recv_len), (&petsc_recv_len_th)) || MPI_Recv((buf), (count), (datatype), (source), (tag), (comm), (status))) 495 496 #define MPI_Recv_c(buf, count, datatype, source, tag, comm, status) \ 497 (PetscAddLogDouble(&petsc_recv_ct, &petsc_recv_ct_th, 1) || PetscMPITypeSize((count), (datatype), (&petsc_recv_len), &(petsc_recv_len_th)) || MPI_Recv_c((buf), (count), (datatype), (source), (tag), (comm), (status))) 498 499 #define MPI_Send(buf, count, datatype, dest, tag, comm) \ 500 (PetscAddLogDouble(&petsc_send_ct, &petsc_send_ct_th, 1) || PetscMPITypeSize((count), (datatype), (&petsc_send_len), (&petsc_send_len_th)) || MPI_Send((buf), (count), (datatype), (dest), (tag), (comm))) 501 502 #define MPI_Send_c(buf, count, datatype, dest, tag, comm) \ 503 (PetscAddLogDouble(&petsc_send_ct, &petsc_send_ct_th, 1) || PetscMPITypeSize((count), (datatype), (&petsc_send_len), (&petsc_send_len_th)) || MPI_Send_c((buf), (count), (datatype), (dest), (tag), (comm))) 504 505 #define MPI_Wait(request, status) (PetscAddLogDouble(&petsc_wait_ct, &petsc_wait_ct_th, 1) || PetscAddLogDouble(&petsc_sum_of_waits_ct, &petsc_sum_of_waits_ct_th, 1) || MPI_Wait((request), (status))) 506 507 #define MPI_Waitany(a, b, c, d) (PetscAddLogDouble(&petsc_wait_any_ct, &petsc_wait_any_ct_th, 1) || PetscAddLogDouble(&petsc_sum_of_waits_ct, &petsc_sum_of_waits_ct_th, 1) || MPI_Waitany((a), (b), (c), (d))) 508 509 #define MPI_Waitall(count, array_of_requests, array_of_statuses) \ 510 (PetscAddLogDouble(&petsc_wait_all_ct, &petsc_wait_all_ct_th, 1) || PetscAddLogDouble(&petsc_sum_of_waits_ct, &petsc_sum_of_waits_ct_th, count) || MPI_Waitall((count), (array_of_requests), (array_of_statuses))) 511 512 #define MPI_Allreduce(sendbuf, recvbuf, count, datatype, op, comm) (PetscAddLogDouble(&petsc_allreduce_ct, &petsc_allreduce_ct_th, PetscMPIParallelComm(comm)) || MPI_Allreduce((sendbuf), (recvbuf), (count), (datatype), (op), (comm))) 513 514 #define MPI_Bcast(buffer, count, datatype, root, comm) (PetscAddLogDouble(&petsc_allreduce_ct, &petsc_allreduce_ct_th, PetscMPIParallelComm(comm)) || MPI_Bcast((buffer), (count), (datatype), (root), (comm))) 515 516 #define MPI_Reduce_scatter_block(sendbuf, recvbuf, recvcount, datatype, op, comm) \ 517 (PetscAddLogDouble(&petsc_allreduce_ct, &petsc_allreduce_ct_th, PetscMPIParallelComm(comm)) || MPI_Reduce_scatter_block((sendbuf), (recvbuf), (recvcount), (datatype), (op), (comm))) 518 519 #define MPI_Alltoall(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, comm) \ 520 (PetscAddLogDouble(&petsc_allreduce_ct, &petsc_allreduce_ct_th, PetscMPIParallelComm(comm)) || PetscMPITypeSize((sendcount), (sendtype), (&petsc_send_len), (&petsc_send_len_th)) || MPI_Alltoall((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (recvtype), (comm))) 521 522 #define MPI_Alltoallv(sendbuf, sendcnts, sdispls, sendtype, recvbuf, recvcnts, rdispls, recvtype, comm) \ 523 (PetscAddLogDouble(&petsc_allreduce_ct, &petsc_allreduce_ct_th, PetscMPIParallelComm(comm)) || PetscMPITypeSizeComm((comm), (sendcnts), (sendtype), (&petsc_send_len), (&petsc_send_len_th)) || MPI_Alltoallv((sendbuf), (sendcnts), (sdispls), (sendtype), (recvbuf), (recvcnts), (rdispls), (recvtype), (comm))) 524 525 #define MPI_Allgather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, comm) \ 526 (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, PetscMPIParallelComm(comm)) || MPI_Allgather((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (recvtype), (comm))) 527 528 #define MPI_Allgatherv(sendbuf, sendcount, sendtype, recvbuf, recvcount, displs, recvtype, comm) \ 529 (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, PetscMPIParallelComm(comm)) || MPI_Allgatherv((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (displs), (recvtype), (comm))) 530 531 #define MPI_Gather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, root, comm) \ 532 (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, 1) || PetscMPITypeSize((sendcount), (sendtype), (&petsc_send_len), (&petsc_send_len_th)) || MPI_Gather((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (recvtype), (root), (comm))) 533 534 #define MPI_Gatherv(sendbuf, sendcount, sendtype, recvbuf, recvcount, displs, recvtype, root, comm) \ 535 (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, 1) || PetscMPITypeSize((sendcount), (sendtype), (&petsc_send_len), (&petsc_send_len_th)) || MPI_Gatherv((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (displs), (recvtype), (root), (comm))) 536 537 #define MPI_Scatter(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, root, comm) \ 538 (PetscAddLogDouble(&petsc_scatter_ct, &petsc_scatter_ct_th, 1) || PetscMPITypeSize((recvcount), (recvtype), (&petsc_recv_len), &(petsc_recv_len_th)) || MPI_Scatter((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (recvtype), (root), (comm))) 539 540 #define MPI_Scatterv(sendbuf, sendcount, displs, sendtype, recvbuf, recvcount, recvtype, root, comm) \ 541 (PetscAddLogDouble(&petsc_scatter_ct, &petsc_scatter_ct_th, 1) || PetscMPITypeSize((recvcount), (recvtype), (&petsc_recv_len), &(petsc_recv_len_th)) || MPI_Scatterv((sendbuf), (sendcount), (displs), (sendtype), (recvbuf), (recvcount), (recvtype), (root), (comm))) 542 543 #define MPI_Ialltoall(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, comm, request) \ 544 (PetscAddLogDouble(&petsc_allreduce_ct, &petsc_allreduce_ct_th, PetscMPIParallelComm(comm)) || PetscMPITypeSize((sendcount), (sendtype), (&petsc_send_len), (&petsc_send_len_th)) || MPI_Ialltoall((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (recvtype), (comm), (request))) 545 546 #define MPI_Ialltoallv(sendbuf, sendcnts, sdispls, sendtype, recvbuf, recvcnts, rdispls, recvtype, comm, request) \ 547 (PetscAddLogDouble(&petsc_allreduce_ct, &petsc_allreduce_ct_th, PetscMPIParallelComm(comm)) || PetscMPITypeSizeComm((comm), (sendcnts), (sendtype), (&petsc_send_len), (&petsc_send_len_th)) || MPI_Ialltoallv((sendbuf), (sendcnts), (sdispls), (sendtype), (recvbuf), (recvcnts), (rdispls), (recvtype), (comm), (request))) 548 549 #define MPI_Iallgather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, comm, request) \ 550 (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, PetscMPIParallelComm(comm)) || MPI_Iallgather((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (recvtype), (comm), (request))) 551 552 #define MPI_Iallgatherv(sendbuf, sendcount, sendtype, recvbuf, recvcount, displs, recvtype, comm, request) \ 553 (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, PetscMPIParallelComm(comm)) || MPI_Iallgatherv((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (displs), (recvtype), (comm), (request))) 554 555 #define MPI_Igather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, root, comm, request) \ 556 (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, 1) || PetscMPITypeSize((sendcount), (sendtype), (&petsc_send_len), (&petsc_send_len_th)) || MPI_Igather((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (recvtype), (root), (comm), (request))) 557 558 #define MPI_Igatherv(sendbuf, sendcount, sendtype, recvbuf, recvcount, displs, recvtype, root, comm, request) \ 559 (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, 1) || PetscMPITypeSize((sendcount), (sendtype), (&petsc_send_len), (&petsc_send_len_th)) || MPI_Igatherv((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (displs), (recvtype), (root), (comm), (request))) 560 561 #define MPI_Iscatter(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, root, comm, request) \ 562 (PetscAddLogDouble(&petsc_scatter_ct, &petsc_scatter_ct_th, 1) || PetscMPITypeSize((recvcount), (recvtype), (&petsc_recv_len), (&petsc_recv_len_th)) || MPI_Iscatter((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (recvtype), (root), (comm), (request))) 563 564 #define MPI_Iscatterv(sendbuf, sendcount, displs, sendtype, recvbuf, recvcount, recvtype, root, comm, request) \ 565 (PetscAddLogDouble(&petsc_scatter_ct, &petsc_scatter_ct_th, 1) || PetscMPITypeSize((recvcount), (recvtype), (&petsc_recv_len), (&petsc_recv_len_th)) || MPI_Iscatterv((sendbuf), (sendcount), (displs), (sendtype), (recvbuf), (recvcount), (recvtype), (root), (comm), (request))) 566 567 #define MPIX_Send_enqueue(buf, count, datatype, dest, tag, comm) \ 568 (PetscAddLogDouble(&petsc_send_ct, &petsc_send_ct_th, 1) || PetscMPITypeSize((count), (datatype), (&petsc_send_len), (&petsc_send_len_th)) || MPIX_Send_enqueue((buf), (count), (datatype), (dest), (tag), (comm))) 569 570 #define MPIX_Recv_enqueue(buf, count, datatype, source, tag, comm, status) \ 571 (PetscAddLogDouble(&petsc_recv_ct, &petsc_recv_ct_th, 1) || PetscMPITypeSize((count), (datatype), (&petsc_recv_len), (&petsc_recv_len_th)) || MPIX_Recv_enqueue((buf), (count), (datatype), (source), (tag), (comm), (status))) 572 573 #define MPIX_Isend_enqueue(buf, count, datatype, dest, tag, comm, request) \ 574 (PetscAddLogDouble(&petsc_isend_ct, &petsc_isend_ct_th, 1) || PetscMPITypeSize((count), (datatype), &(petsc_isend_len), &(petsc_isend_len_th)) || MPIX_Isend_enqueue((buf), (count), (datatype), (dest), (tag), (comm), (request))) 575 576 #define MPIX_Irecv_enqueue(buf, count, datatype, source, tag, comm, request) \ 577 (PetscAddLogDouble(&petsc_irecv_ct, &petsc_irecv_ct_th, 1) || PetscMPITypeSize((count), (datatype), &(petsc_irecv_len), &(petsc_irecv_len_th)) || MPIX_Irecv_enqueue((buf), (count), (datatype), (source), (tag), (comm), (request))) 578 579 #define MPIX_Allreduce_enqueue(sendbuf, recvbuf, count, datatype, op, comm) \ 580 (PetscAddLogDouble(&petsc_allreduce_ct, &petsc_allreduce_ct_th, PetscMPIParallelComm(comm)) || MPIX_Allreduce_enqueue((sendbuf), (recvbuf), (count), (datatype), (op), (comm))) 581 582 #define MPIX_Wait_enqueue(request, status) (PetscAddLogDouble(&petsc_wait_ct, &petsc_wait_ct_th, 1) || PetscAddLogDouble(&petsc_sum_of_waits_ct, &petsc_sum_of_waits_ct_th, 1) || MPIX_Wait_enqueue((request), (status))) 583 584 #define MPIX_Waitall_enqueue(count, array_of_requests, array_of_statuses) \ 585 (PetscAddLogDouble(&petsc_wait_all_ct, &petsc_wait_all_ct_th, 1) || PetscAddLogDouble(&petsc_sum_of_waits_ct, &petsc_sum_of_waits_ct_th, count) || MPIX_Waitall_enqueue((count), (array_of_requests), (array_of_statuses))) 586 #else 587 588 #define MPI_Startall_irecv(count, datatype, number, requests) ((number) && MPI_Startall((number), (requests))) 589 590 #define MPI_Startall_isend(count, datatype, number, requests) ((number) && MPI_Startall((number), (requests))) 591 592 #define MPI_Start_isend(count, datatype, requests) (MPI_Start((requests))) 593 594 #endif /* !MPIUNI_H && ! PETSC_HAVE_BROKEN_RECURSIVE_MACRO */ 595 596 #else /* ---Logging is turned off --------------------------------------------*/ 597 598 #define PetscLogGetState(a) (*(a) = NULL, PETSC_SUCCESS) 599 #define PetscLogGetDefaultHandler(a) (*(a) = NULL, PETSC_SUCCESS) 600 #define PetscLogHandlerStart(a) ((void)(a), PETSC_SUCCESS) 601 #define PetscLogHandlerStop(a) ((void)(a), PETSC_SUCCESS) 602 603 #define PetscLogFlops(n) ((void)(n), PETSC_SUCCESS) 604 #define PetscGetFlops(a) (*(a) = 0.0, PETSC_SUCCESS) 605 606 #define PetscLogStageRegister(a, b) ((void)(a), *(b) = -1, PETSC_SUCCESS) 607 #define PetscLogStagePush(a) ((void)(a), PETSC_SUCCESS) 608 #define PetscLogStagePop() PETSC_SUCCESS 609 #define PetscLogStageSetActive(a, b) ((void)(a), (void)(b), PETSC_SUCCESS) 610 #define PetscLogStageGetActive(a, b) ((void)(a), *(b) = PETSC_FALSE, PETSC_SUCCESS) 611 #define PetscLogStageGetVisible(a, b) ((void)(a), *(b) = PETSC_FALSE, PETSC_SUCCESS) 612 #define PetscLogStageSetVisible(a, b) ((void)(a), (void)(b), PETSC_SUCCESS) 613 #define PetscLogStageGetId(a, b) ((void)(a), *(b) = -1, PETSC_SUCCESS) 614 #define PetscLogStageGetName(a, b) ((void)(a), *(b) = NULL, PETSC_SUCCESS) 615 616 #define PetscLogEventRegister(a, b, c) ((void)(a), (void)(b), *(c) = -1, PETSC_SUCCESS) 617 #define PetscLogEventSetCollective(a, b) ((void)(a), (void)(b), PETSC_SUCCESS) 618 #define PetscLogEventIncludeClass(a) ((void)(a), PETSC_SUCCESS) 619 #define PetscLogEventExcludeClass(a) ((void)(a), PETSC_SUCCESS) 620 #define PetscLogEventActivate(a) ((void)(a), PETSC_SUCCESS) 621 #define PetscLogEventDeactivate(a) ((void)(a), PETSC_SUCCESS) 622 #define PetscLogEventDeactivatePush(a) ((void)(a), PETSC_SUCCESS) 623 #define PetscLogEventDeactivatePop(a) ((void)(a), PETSC_SUCCESS) 624 #define PetscLogEventActivateClass(a) ((void)(a), PETSC_SUCCESS) 625 #define PetscLogEventDeactivateClass(a) ((void)(a), PETSC_SUCCESS) 626 #define PetscLogEventSetActiveAll(a, b) ((void)(a), PETSC_SUCCESS) 627 #define PetscLogEventGetId(a, b) ((void)(a), *(b) = -1, PETSC_SUCCESS) 628 #define PetscLogEventGetName(a, b) ((void)(a), *(b) = NULL, PETSC_SUCCESS) 629 #define PetscLogEventGetPerfInfo(a, b, c) ((void)(a), (void)(b), *(c) = (const PetscEventPerfInfo){0}, PETSC_SUCCESS) 630 631 #define PetscLogEventSetDof(a, b, c) ((void)(a), (void)(b), (void)(c), PETSC_SUCCESS) 632 #define PetscLogEventSetError(a, b, c) ((void)(a), (void)(b), (void)(c), PETSC_SUCCESS) 633 #define PetscLogEventsPause() PETSC_SUCCESS 634 #define PetscLogEventsResume() PETSC_SUCCESS 635 636 #define PetscLogClassGetClassId(a, b) (*(b) = -1, PETSC_SUCCESS) 637 #define PetscLogClassIdGetName(a, b) (*(b) = NULL, PETSC_SUCCESS) 638 639 #define PetscLogObjectCreate(h) ((void)(h), PETSC_SUCCESS) 640 #define PetscLogObjectDestroy(h) ((void)(h), PETSC_SUCCESS) 641 #define PetscLogObjectState(h, c, ...) ((void)(h), (void)(c), PETSC_SUCCESS) 642 643 #define PetscLogDefaultBegin() PETSC_SUCCESS 644 #define PetscLogNestedBegin() PETSC_SUCCESS 645 #define PetscLogTraceBegin(file) ((void)(file), PETSC_SUCCESS) 646 #define PetscLogMPEBegin() PETSC_SUCCESS 647 #define PetscLogPerfstubsBegin() PETSC_SUCCESS 648 #define PetscLogLegacyCallbacksBegin(a, b, c, d) ((void)(a), (void)(b), (void)(c), (void)(d), PETSC_SUCCESS) 649 #define PetscLogActions(a) ((void)(a), PETSC_SUCCESS) 650 #define PetscLogObjects(a) ((void)(a), PETSC_SUCCESS) 651 #define PetscLogSetThreshold(a, b) ((void)(a), (void)(b), PETSC_SUCCESS) 652 653 #define PetscLogIsActive(flag) (*(flag) = PETSC_FALSE, PETSC_SUCCESS) 654 655 #define PetscLogView(viewer) ((void)(viewer), PETSC_SUCCESS) 656 #define PetscLogViewFromOptions() PETSC_SUCCESS 657 #define PetscLogDump(c) ((void)(c), PETSC_SUCCESS) 658 #define PetscLogMPEDump(c) ((void)(c), PETSC_SUCCESS) 659 660 #define PetscLogEventSync(e, comm) ((void)(e), (void)(comm), PETSC_SUCCESS) 661 #define PetscLogEventBegin(e, o1, o2, o3, o4) ((void)(e), (void)(o1), (void)(o2), (void)(o3), PETSC_SUCCESS) 662 #define PetscLogEventEnd(e, o1, o2, o3, o4) ((void)(e), (void)(o1), (void)(o2), (void)(o3), PETSC_SUCCESS) 663 664 /* If PETSC_USE_LOG is NOT defined, these still need to be! */ 665 #define MPI_Startall_irecv(count, datatype, number, requests) ((number) && MPI_Startall(number, requests)) 666 #define MPI_Startall_isend(count, datatype, number, requests) ((number) && MPI_Startall(number, requests)) 667 #define MPI_Start_isend(count, datatype, requests) MPI_Start(requests) 668 669 #endif /* PETSC_USE_LOG */ 670 671 #define PetscPreLoadBegin(flag, name) \ 672 do { \ 673 PetscBool PetscPreLoading = flag; \ 674 int PetscPreLoadMax, PetscPreLoadIt; \ 675 PetscLogStage _stageNum; \ 676 PetscCall(PetscOptionsGetBool(NULL, NULL, "-preload", &PetscPreLoading, NULL)); \ 677 PetscPreLoadMax = (int)(PetscPreLoading); \ 678 PetscPreLoadingUsed = PetscPreLoading ? PETSC_TRUE : PetscPreLoadingUsed; \ 679 for (PetscPreLoadIt = 0; PetscPreLoadIt <= PetscPreLoadMax; PetscPreLoadIt++) { \ 680 PetscPreLoadingOn = PetscPreLoading; \ 681 PetscCall(PetscBarrier(NULL)); \ 682 if (PetscPreLoadIt > 0) PetscCall(PetscLogStageGetId(name, &_stageNum)); \ 683 else PetscCall(PetscLogStageRegister(name, &_stageNum)); \ 684 PetscCall(PetscLogStageSetActive(_stageNum, (PetscBool)(!PetscPreLoadMax || PetscPreLoadIt))); \ 685 PetscCall(PetscLogStagePush(_stageNum)) 686 687 #define PetscPreLoadEnd() \ 688 PetscCall(PetscLogStagePop()); \ 689 PetscPreLoading = PETSC_FALSE; \ 690 } \ 691 } \ 692 while (0) 693 694 #define PetscPreLoadStage(name) \ 695 do { \ 696 PetscCall(PetscLogStagePop()); \ 697 if (PetscPreLoadIt > 0) PetscCall(PetscLogStageGetId(name, &_stageNum)); \ 698 else PetscCall(PetscLogStageRegister(name, &_stageNum)); \ 699 PetscCall(PetscLogStageSetActive(_stageNum, (PetscBool)(!PetscPreLoadMax || PetscPreLoadIt))); \ 700 PetscCall(PetscLogStagePush(_stageNum)); \ 701 } while (0) 702 703 /* some vars for logging */ 704 PETSC_EXTERN PetscBool PetscPreLoadingUsed; /* true if we are or have done preloading */ 705 PETSC_EXTERN PetscBool PetscPreLoadingOn; /* true if we are currently in a preloading calculation */ 706 707 #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_DEVICE) 708 709 PETSC_EXTERN PetscErrorCode PetscLogGpuTime(void); 710 PETSC_EXTERN PetscErrorCode PetscLogGpuTimeBegin(void); 711 PETSC_EXTERN PetscErrorCode PetscLogGpuTimeEnd(void); 712 713 /*@C 714 PetscLogGpuFlops - Log how many flops are performed in a calculation on the device 715 716 Input Parameter: 717 . flops - the number of flops 718 719 Level: intermediate 720 721 Notes: 722 To limit the chance of integer overflow when multiplying by a constant, represent the constant as a double, 723 not an integer. Use `PetscLogFlops`(4.0*n) not `PetscLogFlops`(4*n) 724 725 The values are also added to the total flop count for the MPI rank that is set with `PetscLogFlops()`; hence the number of flops 726 just on the CPU would be the value from set from `PetscLogFlops()` minus the value set from `PetscLogGpuFlops()` 727 728 .seealso: [](ch_profiling), `PetscLogView()`, `PetscLogFlops()`, `PetscLogGpuTimeBegin()`, `PetscLogGpuTimeEnd()` 729 @*/ 730 static inline PetscErrorCode PetscLogGpuFlops(PetscLogDouble n) 731 { 732 PetscAssert(n >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Cannot log negative flops"); 733 PetscCall(PetscAddLogDouble(&petsc_TotalFlops, &petsc_TotalFlops_th, PETSC_FLOPS_PER_OP * n)); 734 PetscCall(PetscAddLogDouble(&petsc_gflops, &petsc_gflops_th, PETSC_FLOPS_PER_OP * n)); 735 return PETSC_SUCCESS; 736 } 737 738 static inline PetscErrorCode PetscLogGpuTimeAdd(PetscLogDouble t) 739 { 740 return PetscAddLogDouble(&petsc_gtime, &petsc_gtime_th, t); 741 } 742 743 static inline PetscErrorCode PetscLogCpuToGpu(PetscLogDouble size) 744 { 745 return PetscAddLogDoubleCnt(&petsc_ctog_ct, &petsc_ctog_sz, &petsc_ctog_ct_th, &petsc_ctog_sz_th, size); 746 } 747 748 static inline PetscErrorCode PetscLogGpuToCpu(PetscLogDouble size) 749 { 750 return PetscAddLogDoubleCnt(&petsc_gtoc_ct, &petsc_gtoc_sz, &petsc_gtoc_ct_th, &petsc_gtoc_sz_th, size); 751 } 752 753 static inline PetscErrorCode PetscLogCpuToGpuScalar(PetscLogDouble size) 754 { 755 return PetscAddLogDoubleCnt(&petsc_ctog_ct_scalar, &petsc_ctog_sz_scalar, &petsc_ctog_ct_scalar_th, &petsc_ctog_sz_scalar_th, size); 756 } 757 758 static inline PetscErrorCode PetscLogGpuToCpuScalar(PetscLogDouble size) 759 { 760 return PetscAddLogDoubleCnt(&petsc_gtoc_ct_scalar, &petsc_gtoc_sz_scalar, &petsc_gtoc_ct_scalar_th, &petsc_gtoc_sz_scalar_th, size); 761 } 762 #else 763 764 #define PetscLogCpuToGpu(a) PETSC_SUCCESS 765 #define PetscLogGpuToCpu(a) PETSC_SUCCESS 766 #define PetscLogCpuToGpuScalar(a) PETSC_SUCCESS 767 #define PetscLogGpuToCpuScalar(a) PETSC_SUCCESS 768 #define PetscLogGpuFlops(a) PETSC_SUCCESS 769 #define PetscLogGpuTime() PETSC_SUCCESS 770 #define PetscLogGpuTimeAdd(a) PETSC_SUCCESS 771 #define PetscLogGpuTimeBegin() PETSC_SUCCESS 772 #define PetscLogGpuTimeEnd() PETSC_SUCCESS 773 774 #endif /* PETSC_USE_LOG && PETSC_HAVE_DEVICE */ 775 776 /* remove TLS defines */ 777 #undef PETSC_EXTERN_TLS 778 #undef PETSC_TLS 779 780 #include <petsclogdeprecated.h> 781 782 #endif 783