Actual source code: petsclog.h
1: /*
2: Defines profile/logging in PETSc.
3: */
4: #pragma once
6: #include <petscsys.h>
7: #include <petsctime.h>
8: #include <petscbt.h>
9: #include <petsclogtypes.h>
11: /* MANSEC = Sys */
12: /* SUBMANSEC = Log */
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 PetscDefined(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
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__)
32: /*E
33: PetscInfoCommFlag - Describes the method by which to filter information displayed by `PetscInfo()` by communicator size
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
41: Level: intermediate
43: Note:
44: Used as an input for `PetscInfoSetFilterCommSelf()`
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;
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 */
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 *);
77: PETSC_EXTERN PetscErrorCode PetscLogStateCreate(PetscLogState *);
78: PETSC_EXTERN PetscErrorCode PetscLogStateDestroy(PetscLogState *);
80: PETSC_EXTERN PetscErrorCode PetscLogStateClassRegister(PetscLogState, const char[], PetscClassId, PetscLogStage *);
81: PETSC_EXTERN PetscErrorCode PetscLogStateClassSetActive(PetscLogState, PetscLogStage, PetscClassId, PetscBool);
82: PETSC_EXTERN PetscErrorCode PetscLogStateClassSetActiveAll(PetscLogState, PetscClassId, PetscBool);
84: PETSC_EXTERN PetscErrorCode PetscLogStateStageRegister(PetscLogState, const char[], PetscLogStage *);
85: PETSC_EXTERN PetscErrorCode PetscLogStateStagePush(PetscLogState, PetscLogStage);
86: PETSC_EXTERN PetscErrorCode PetscLogStateStagePop(PetscLogState);
87: PETSC_EXTERN PetscErrorCode PetscLogStateStageSetActive(PetscLogState, PetscLogStage, PetscBool);
88: PETSC_EXTERN PetscErrorCode PetscLogStateStageGetActive(PetscLogState, PetscLogStage, PetscBool *);
89: PETSC_EXTERN PetscErrorCode PetscLogStateGetCurrentStage(PetscLogState, PetscLogStage *);
91: PETSC_EXTERN PetscErrorCode PetscLogStateEventRegister(PetscLogState, const char[], PetscClassId, PetscLogEvent *);
92: PETSC_EXTERN PetscErrorCode PetscLogStateEventSetCollective(PetscLogState, PetscLogEvent, PetscBool);
93: PETSC_EXTERN PetscErrorCode PetscLogStateEventSetActive(PetscLogState, PetscLogStage, PetscLogEvent, PetscBool);
94: PETSC_EXTERN PetscErrorCode PetscLogStateEventSetActiveAll(PetscLogState, PetscLogEvent, PetscBool);
95: PETSC_EXTERN PetscErrorCode PetscLogStateEventGetActive(PetscLogState, PetscLogStage, PetscLogEvent, PetscBool *);
97: PETSC_EXTERN PetscErrorCode PetscLogStateGetEventFromName(PetscLogState, const char[], PetscLogEvent *);
98: PETSC_EXTERN PetscErrorCode PetscLogStateGetStageFromName(PetscLogState, const char[], PetscLogStage *);
99: PETSC_EXTERN PetscErrorCode PetscLogStateGetClassFromName(PetscLogState, const char[], PetscLogClass *);
100: PETSC_EXTERN PetscErrorCode PetscLogStateGetClassFromClassId(PetscLogState, PetscClassId, PetscLogClass *);
101: PETSC_EXTERN PetscErrorCode PetscLogStateGetNumEvents(PetscLogState, PetscInt *);
102: PETSC_EXTERN PetscErrorCode PetscLogStateGetNumStages(PetscLogState, PetscInt *);
103: PETSC_EXTERN PetscErrorCode PetscLogStateGetNumClasses(PetscLogState, PetscInt *);
104: PETSC_EXTERN PetscErrorCode PetscLogStateEventGetInfo(PetscLogState, PetscLogEvent, PetscLogEventInfo *);
105: PETSC_EXTERN PetscErrorCode PetscLogStateStageGetInfo(PetscLogState, PetscLogStage, PetscLogStageInfo *);
106: PETSC_EXTERN PetscErrorCode PetscLogStateClassGetInfo(PetscLogState, PetscLogClass, PetscLogClassInfo *);
108: PETSC_EXTERN PetscClassId PETSCLOGHANDLER_CLASSID;
110: PETSC_EXTERN PetscFunctionList PetscLogHandlerList;
112: PETSC_EXTERN PetscErrorCode PetscLogHandlerRegister(const char[], PetscErrorCode (*)(PetscLogHandler));
113: PETSC_EXTERN PetscErrorCode PetscLogHandlerCreate(MPI_Comm, PetscLogHandler *);
114: PETSC_EXTERN PetscErrorCode PetscLogHandlerSetType(PetscLogHandler, PetscLogHandlerType);
115: PETSC_EXTERN PetscErrorCode PetscLogHandlerGetType(PetscLogHandler, PetscLogHandlerType *);
116: PETSC_EXTERN PetscErrorCode PetscLogHandlerDestroy(PetscLogHandler *);
117: PETSC_EXTERN PetscErrorCode PetscLogHandlerSetState(PetscLogHandler, PetscLogState);
118: PETSC_EXTERN PetscErrorCode PetscLogHandlerGetState(PetscLogHandler, PetscLogState *);
119: PETSC_EXTERN PetscErrorCode PetscLogHandlerEventBegin(PetscLogHandler, PetscLogEvent, PetscObject, PetscObject, PetscObject, PetscObject);
120: PETSC_EXTERN PetscErrorCode PetscLogHandlerEventEnd(PetscLogHandler, PetscLogEvent, PetscObject, PetscObject, PetscObject, PetscObject);
121: PETSC_EXTERN PetscErrorCode PetscLogHandlerEventSync(PetscLogHandler, PetscLogEvent, MPI_Comm);
122: PETSC_EXTERN PetscErrorCode PetscLogHandlerObjectCreate(PetscLogHandler, PetscObject);
123: PETSC_EXTERN PetscErrorCode PetscLogHandlerObjectDestroy(PetscLogHandler, PetscObject);
124: PETSC_EXTERN PetscErrorCode PetscLogHandlerStagePush(PetscLogHandler, PetscLogStage);
125: PETSC_EXTERN PetscErrorCode PetscLogHandlerStagePop(PetscLogHandler, PetscLogStage);
126: PETSC_EXTERN PetscErrorCode PetscLogHandlerView(PetscLogHandler, PetscViewer);
128: PETSC_EXTERN PetscErrorCode PetscLogHandlerGetEventPerfInfo(PetscLogHandler, PetscLogStage, PetscLogEvent, PetscEventPerfInfo **);
129: PETSC_EXTERN PetscErrorCode PetscLogHandlerGetStagePerfInfo(PetscLogHandler, PetscLogStage, PetscEventPerfInfo **);
130: PETSC_EXTERN PetscErrorCode PetscLogHandlerSetLogActions(PetscLogHandler, PetscBool);
131: PETSC_EXTERN PetscErrorCode PetscLogHandlerSetLogObjects(PetscLogHandler, PetscBool);
132: PETSC_EXTERN PetscErrorCode PetscLogHandlerLogObjectState(PetscLogHandler, PetscObject, const char[], ...);
133: PETSC_EXTERN PetscErrorCode PetscLogHandlerGetNumObjects(PetscLogHandler, PetscInt *);
134: PETSC_EXTERN PetscErrorCode PetscLogHandlerEventDeactivatePush(PetscLogHandler, PetscLogStage, PetscLogEvent);
135: PETSC_EXTERN PetscErrorCode PetscLogHandlerEventDeactivatePop(PetscLogHandler, PetscLogStage, PetscLogEvent);
136: PETSC_EXTERN PetscErrorCode PetscLogHandlerEventsPause(PetscLogHandler);
137: PETSC_EXTERN PetscErrorCode PetscLogHandlerEventsResume(PetscLogHandler);
138: PETSC_EXTERN PetscErrorCode PetscLogHandlerDump(PetscLogHandler, const char[]);
139: PETSC_EXTERN PetscErrorCode PetscLogHandlerStageSetVisible(PetscLogHandler, PetscLogStage, PetscBool);
140: PETSC_EXTERN PetscErrorCode PetscLogHandlerStageGetVisible(PetscLogHandler, PetscLogStage, PetscBool *);
142: PETSC_EXTERN PetscErrorCode PetscLogHandlerCreateTrace(MPI_Comm, FILE *, PetscLogHandler *);
143: 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 *);
145: /*MC
146: PetscLogStateStageEventIsActive - Returns whether a specific `PetscLogEvent` is active in a specific stage of a `PetscLogState`
148: Synopsis:
149: #include <petsclog.h>
150: PetscBool PetscLogStateStageEventIsActive(PetscLogState state, PetscLogStage stage, PetscLogEvent event)
152: Not Collective; No Fortran Support
154: Input Parameters:
155: + state - the `PetscLogState`
156: . stage - the stage index
157: - event - the event index
159: Level: developer
161: Note:
162: Returns `PETSC_FALSE` when `stage` is negative, which indicates that there have been more stage pops than pushes.
164: .seealso: `PetscLogState`, `PetscLogStage`, `PetscLogEvent`, `PetscLogStateEventCurrentlyActive()`, `PetscLogStateStageGetActive()`
165: M*/
166: /* All events are inactive if an invalid stage is set, like if there have been more stage pops than stage pushes */
167: #define PetscLogStateStageEventIsActive(state, stage, event) ((stage >= 0) && PetscBTLookup((state)->active, (stage)) && PetscBTLookup((state)->active, (stage) + (event + 1) * (state)->bt_num_stages))
169: /*MC
170: PetscLogStateEventCurrentlyActive - Returns whether a specific `PetscLogEvent` is active in the currently active stage of a `PetscLogState`
172: Synopsis:
173: #include <petsclog.h>
174: PetscBool PetscLogStateEventCurrentlyActive(PetscLogState state, PetscLogEvent event)
176: Not Collective; No Fortran Support
178: Input Parameters:
179: + state - the `PetscLogState` (may be `NULL`, in which case `PETSC_FALSE` is returned)
180: - event - the event index
182: Level: developer
184: .seealso: `PetscLogState`, `PetscLogEvent`, `PetscLogStateStageEventIsActive()`
185: M*/
186: #define PetscLogStateEventCurrentlyActive(state, event) ((state) && PetscLogStateStageEventIsActive(state, (state)->current_stage, event))
188: /* PetscLogHandler with critical methods exposed for speed */
189: typedef struct _n_PetscLogHandlerHot {
190: PetscLogHandler handler;
191: PetscErrorCode (*eventBegin)(PetscLogHandler, PetscLogEvent, PetscObject, PetscObject, PetscObject, PetscObject);
192: PetscErrorCode (*eventEnd)(PetscLogHandler, PetscLogEvent, PetscObject, PetscObject, PetscObject, PetscObject);
193: PetscErrorCode (*eventSync)(PetscLogHandler, PetscLogEvent, MPI_Comm);
194: PetscErrorCode (*objectCreate)(PetscLogHandler, PetscObject);
195: PetscErrorCode (*objectDestroy)(PetscLogHandler, PetscObject);
196: } PetscLogHandlerHot;
198: /* Handle multithreading */
199: #if PetscDefined(HAVE_THREADSAFETY)
200: #if defined(__cplusplus)
201: #define PETSC_TLS thread_local
202: #else
203: #define PETSC_TLS _Thread_local
204: #endif
205: #define PETSC_EXTERN_TLS extern PETSC_TLS PETSC_VISIBILITY_PUBLIC
206: #else
207: #define PETSC_EXTERN_TLS PETSC_EXTERN
208: #define PETSC_TLS
209: #endif
210: #if PetscDefined(HAVE_THREADSAFETY) && PetscDefined(USE_LOG)
211: PETSC_EXTERN PetscErrorCode PetscAddLogDouble(PetscLogDouble *, PetscLogDouble *, PetscLogDouble);
212: PETSC_EXTERN PetscErrorCode PetscAddLogDoubleCnt(PetscLogDouble *, PetscLogDouble *, PetscLogDouble *, PetscLogDouble *, PetscLogDouble);
213: #else
214: #define PetscAddLogDouble(a, b, c) ((PetscErrorCode)((*(a) += (c), PETSC_SUCCESS) || ((*(b) += (c)), PETSC_SUCCESS)))
215: #define PetscAddLogDoubleCnt(a, b, c, d, e) ((PetscErrorCode)(PetscAddLogDouble(a, c, 1) || PetscAddLogDouble(b, d, e)))
216: #endif
218: PETSC_DEPRECATED_FUNCTION(3, 18, 0, "PetscLogObjectParent()", ) static inline PetscErrorCode PetscLogObjectParent(PetscObject o, PetscObject p)
219: {
220: (void)o;
221: (void)p;
222: return PETSC_SUCCESS;
223: }
224: /*MC
225: PetscLogObjectParents - Record a parent/child relationship between a `PetscObject` and an array of `PetscObject`s for performance logging
227: Synopsis:
228: #include <petsclog.h>
229: PetscErrorCode PetscLogObjectParents(PetscObject p, int n, PetscObject d[])
231: Not Collective; No Fortran Support
233: Input Parameters:
234: + p - the parent `PetscObject`
235: . n - the number of child objects
236: - d - array of child `PetscObject`s
238: Level: developer
240: Note:
241: This routine is a no-op unless PETSc is configured with logging enabled.
243: .seealso: `PetscLogObjectParent()`, `PetscLogObjectCreate()`, `PetscLogObjectDestroy()`
244: M*/
245: #define PetscLogObjectParents(p, n, d) PetscMacroReturnStandard(for (int _i = 0; _i < (n); ++_i) PetscCall(PetscLogObjectParent((PetscObject)(p), (PetscObject)(d)[_i]));)
247: PETSC_DEPRECATED_FUNCTION(3, 18, 0, "PetscLogObjectMemory()", ) static inline PetscErrorCode PetscLogObjectMemory(PetscObject o, PetscLogDouble m)
248: {
249: (void)o;
250: (void)m;
251: return PETSC_SUCCESS;
252: }
254: /* Global flop counter */
255: PETSC_EXTERN PetscLogDouble petsc_TotalFlops;
256: PETSC_EXTERN PetscLogDouble petsc_irecv_ct;
257: PETSC_EXTERN PetscLogDouble petsc_isend_ct;
258: PETSC_EXTERN PetscLogDouble petsc_recv_ct;
259: PETSC_EXTERN PetscLogDouble petsc_send_ct;
260: PETSC_EXTERN PetscLogDouble petsc_irecv_len;
261: PETSC_EXTERN PetscLogDouble petsc_isend_len;
262: PETSC_EXTERN PetscLogDouble petsc_recv_len;
263: PETSC_EXTERN PetscLogDouble petsc_send_len;
264: PETSC_EXTERN PetscLogDouble petsc_allreduce_ct;
265: PETSC_EXTERN PetscLogDouble petsc_gather_ct;
266: PETSC_EXTERN PetscLogDouble petsc_scatter_ct;
267: PETSC_EXTERN PetscLogDouble petsc_wait_ct;
268: PETSC_EXTERN PetscLogDouble petsc_wait_any_ct;
269: PETSC_EXTERN PetscLogDouble petsc_wait_all_ct;
270: PETSC_EXTERN PetscLogDouble petsc_sum_of_waits_ct;
272: /* Thread local storage */
273: PETSC_EXTERN_TLS PetscLogDouble petsc_TotalFlops_th;
274: PETSC_EXTERN_TLS PetscLogDouble petsc_irecv_ct_th;
275: PETSC_EXTERN_TLS PetscLogDouble petsc_isend_ct_th;
276: PETSC_EXTERN_TLS PetscLogDouble petsc_recv_ct_th;
277: PETSC_EXTERN_TLS PetscLogDouble petsc_send_ct_th;
278: PETSC_EXTERN_TLS PetscLogDouble petsc_irecv_len_th;
279: PETSC_EXTERN_TLS PetscLogDouble petsc_isend_len_th;
280: PETSC_EXTERN_TLS PetscLogDouble petsc_recv_len_th;
281: PETSC_EXTERN_TLS PetscLogDouble petsc_send_len_th;
282: PETSC_EXTERN_TLS PetscLogDouble petsc_allreduce_ct_th;
283: PETSC_EXTERN_TLS PetscLogDouble petsc_gather_ct_th;
284: PETSC_EXTERN_TLS PetscLogDouble petsc_scatter_ct_th;
285: PETSC_EXTERN_TLS PetscLogDouble petsc_wait_ct_th;
286: PETSC_EXTERN_TLS PetscLogDouble petsc_wait_any_ct_th;
287: PETSC_EXTERN_TLS PetscLogDouble petsc_wait_all_ct_th;
288: PETSC_EXTERN_TLS PetscLogDouble petsc_sum_of_waits_ct_th;
290: /* Global GPU counters */
291: PETSC_EXTERN PetscLogDouble petsc_ctog_ct;
292: PETSC_EXTERN PetscLogDouble petsc_gtoc_ct;
293: PETSC_EXTERN PetscLogDouble petsc_ctog_sz;
294: PETSC_EXTERN PetscLogDouble petsc_gtoc_sz;
295: PETSC_EXTERN PetscLogDouble petsc_ctog_ct_scalar;
296: PETSC_EXTERN PetscLogDouble petsc_gtoc_ct_scalar;
297: PETSC_EXTERN PetscLogDouble petsc_ctog_sz_scalar;
298: PETSC_EXTERN PetscLogDouble petsc_gtoc_sz_scalar;
299: PETSC_EXTERN PetscLogDouble petsc_gflops;
300: PETSC_EXTERN PetscLogDouble petsc_gtime;
301: PETSC_EXTERN PetscLogDouble petsc_genergy;
302: PETSC_EXTERN PetscLogDouble petsc_genergy_meter;
304: /* Thread local storage */
305: PETSC_EXTERN_TLS PetscLogDouble petsc_ctog_ct_th;
306: PETSC_EXTERN_TLS PetscLogDouble petsc_gtoc_ct_th;
307: PETSC_EXTERN_TLS PetscLogDouble petsc_ctog_sz_th;
308: PETSC_EXTERN_TLS PetscLogDouble petsc_gtoc_sz_th;
309: PETSC_EXTERN_TLS PetscLogDouble petsc_ctog_ct_scalar_th;
310: PETSC_EXTERN_TLS PetscLogDouble petsc_gtoc_ct_scalar_th;
311: PETSC_EXTERN_TLS PetscLogDouble petsc_ctog_sz_scalar_th;
312: PETSC_EXTERN_TLS PetscLogDouble petsc_gtoc_sz_scalar_th;
313: PETSC_EXTERN_TLS PetscLogDouble petsc_gflops_th;
314: PETSC_EXTERN_TLS PetscLogDouble petsc_gtime_th;
316: PETSC_EXTERN PetscBool PetscLogMemory;
317: PETSC_EXTERN PetscBool PetscLogSyncOn; /* true if logging synchronization is enabled */
319: PETSC_EXTERN PetscLogState petsc_log_state;
321: #define PETSC_LOG_HANDLER_MAX 4
322: PETSC_EXTERN PetscLogHandlerHot PetscLogHandlers[PETSC_LOG_HANDLER_MAX];
324: #if PetscDefined(USE_LOG) /* --- Logging is turned on --------------------------------*/
325: PETSC_EXTERN PetscErrorCode PetscGetFlops(PetscLogDouble *);
327: PETSC_EXTERN PetscErrorCode PetscLogObjectState(PetscObject, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);
329: /* Initialization functions */
330: PETSC_EXTERN PetscErrorCode PetscLogDefaultBegin(void);
331: PETSC_EXTERN PetscErrorCode PetscLogNestedBegin(void);
332: PETSC_EXTERN PetscErrorCode PetscLogTraceBegin(FILE *);
333: PETSC_EXTERN PetscErrorCode PetscLogMPEBegin(void);
334: PETSC_EXTERN PetscErrorCode PetscLogPerfstubsBegin(void);
335: PETSC_EXTERN PetscErrorCode PetscLogLegacyCallbacksBegin(PetscErrorCode (*)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), PetscErrorCode (*)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), PetscErrorCode (*)(PetscObject), PetscErrorCode (*)(PetscObject));
336: PETSC_EXTERN PetscErrorCode PetscLogActions(PetscBool);
337: PETSC_EXTERN PetscErrorCode PetscLogObjects(PetscBool);
338: PETSC_EXTERN PetscErrorCode PetscLogSetThreshold(PetscLogDouble, PetscLogDouble *);
340: /* Output functions */
341: PETSC_EXTERN PetscErrorCode PetscLogView(PetscViewer);
342: PETSC_EXTERN PetscErrorCode PetscLogViewFromOptions(void);
343: PETSC_EXTERN PetscErrorCode PetscLogDump(const char[]);
344: PETSC_EXTERN PetscErrorCode PetscLogMPEDump(const char[]);
346: PETSC_EXTERN PetscErrorCode PetscLogGetState(PetscLogState *);
347: PETSC_EXTERN PetscErrorCode PetscLogGetDefaultHandler(PetscLogHandler *);
348: PETSC_EXTERN PetscErrorCode PetscLogHandlerStart(PetscLogHandler);
349: PETSC_EXTERN PetscErrorCode PetscLogHandlerStop(PetscLogHandler);
351: /* Status checking functions */
352: PETSC_EXTERN PetscErrorCode PetscLogIsActive(PetscBool *);
354: /* Stage functions */
355: PETSC_EXTERN PetscErrorCode PetscLogStageRegister(const char[], PetscLogStage *);
356: PETSC_EXTERN PetscErrorCode PetscLogStagePush(PetscLogStage);
357: PETSC_EXTERN PetscErrorCode PetscLogStagePop(void);
358: PETSC_EXTERN PetscErrorCode PetscLogStageSetActive(PetscLogStage, PetscBool);
359: PETSC_EXTERN PetscErrorCode PetscLogStageGetActive(PetscLogStage, PetscBool *);
360: PETSC_EXTERN PetscErrorCode PetscLogStageSetVisible(PetscLogStage, PetscBool);
361: PETSC_EXTERN PetscErrorCode PetscLogStageGetVisible(PetscLogStage, PetscBool *);
362: PETSC_EXTERN PetscErrorCode PetscLogStageGetId(const char[], PetscLogStage *);
363: PETSC_EXTERN PetscErrorCode PetscLogStageGetName(PetscLogEvent, const char *[]);
364: PETSC_EXTERN PetscErrorCode PetscLogStageGetPerfInfo(PetscLogStage, PetscEventPerfInfo *);
366: /* Event functions */
367: PETSC_EXTERN PetscErrorCode PetscLogEventRegister(const char[], PetscClassId, PetscLogEvent *);
368: PETSC_EXTERN PetscErrorCode PetscLogEventSetCollective(PetscLogEvent, PetscBool);
369: PETSC_EXTERN PetscErrorCode PetscLogEventIncludeClass(PetscClassId);
370: PETSC_EXTERN PetscErrorCode PetscLogEventExcludeClass(PetscClassId);
371: PETSC_EXTERN PetscErrorCode PetscLogEventActivate(PetscLogEvent);
372: PETSC_EXTERN PetscErrorCode PetscLogEventDeactivate(PetscLogEvent);
373: PETSC_EXTERN PetscErrorCode PetscLogEventDeactivatePush(PetscLogEvent);
374: PETSC_EXTERN PetscErrorCode PetscLogEventDeactivatePop(PetscLogEvent);
375: PETSC_EXTERN PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent, PetscBool);
376: PETSC_EXTERN PetscErrorCode PetscLogEventActivateClass(PetscClassId);
377: PETSC_EXTERN PetscErrorCode PetscLogEventDeactivateClass(PetscClassId);
378: PETSC_EXTERN PetscErrorCode PetscLogEventGetId(const char[], PetscLogEvent *);
379: PETSC_EXTERN PetscErrorCode PetscLogEventGetName(PetscLogEvent, const char *[]);
380: PETSC_EXTERN PetscErrorCode PetscLogEventGetPerfInfo(PetscLogStage, PetscLogEvent, PetscEventPerfInfo *);
381: PETSC_EXTERN PetscErrorCode PetscLogEventSetDof(PetscLogEvent, PetscInt, PetscLogDouble);
382: PETSC_EXTERN PetscErrorCode PetscLogEventSetError(PetscLogEvent, PetscInt, PetscLogDouble);
383: PETSC_EXTERN PetscErrorCode PetscLogEventsPause(void);
384: PETSC_EXTERN PetscErrorCode PetscLogEventsResume(void);
386: /* Class functions */
387: PETSC_EXTERN PetscErrorCode PetscLogClassGetClassId(const char[], PetscClassId *);
388: PETSC_EXTERN PetscErrorCode PetscLogClassIdGetName(PetscClassId, const char *[]);
390: /*@
391: PetscLogEventSync - Synchronize an `MPI_Comm` so that the wall-clock time spent waiting at the implicit barrier is not attributed to a subsequent event
393: Logically Collective on `comm`; No Fortran Support
395: Input Parameters:
396: + e - the `PetscLogEvent` to associate with the synchronization
397: - comm - the `MPI_Comm` whose ranks are synchronized
399: Level: developer
401: Notes:
402: Forwards the call to every active `PetscLogHandler` that implements an `eventSync` method.
404: Has no effect when logging is not active or when the event is not active in the current stage.
406: .seealso: `PetscLogEvent`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogHandler`
407: @*/
408: static inline PetscErrorCode PetscLogEventSync(PetscLogEvent e, MPI_Comm comm)
409: {
410: if (PetscLogStateEventCurrentlyActive(petsc_log_state, e)) {
411: for (int i = 0; i < PETSC_LOG_HANDLER_MAX; i++) {
412: PetscLogHandlerHot *h = &PetscLogHandlers[i];
413: if (h->eventSync) {
414: PetscErrorCode err = (*h->eventSync)(h->handler, e, comm);
415: if (err != PETSC_SUCCESS) return err;
416: }
417: }
418: }
419: return PETSC_SUCCESS;
420: }
422: static inline PetscErrorCode PetscLogEventBegin_Internal(PetscLogEvent e, PetscObject o1, PetscObject o2, PetscObject o3, PetscObject o4)
423: {
424: if (PetscLogStateEventCurrentlyActive(petsc_log_state, e)) {
425: for (int i = 0; i < PETSC_LOG_HANDLER_MAX; i++) {
426: PetscLogHandlerHot *h = &PetscLogHandlers[i];
427: if (h->eventBegin) {
428: PetscErrorCode err = (*h->eventBegin)(h->handler, e, o1, o2, o3, o4);
429: if (err != PETSC_SUCCESS) return err;
430: }
431: }
432: }
433: return PETSC_SUCCESS;
434: }
435: /*MC
436: PetscLogEventBegin - Log the start of an instance of a `PetscLogEvent`
438: Synopsis:
439: #include <petsclog.h>
440: PetscErrorCode PetscLogEventBegin(PetscLogEvent e, PetscObject o1, PetscObject o2, PetscObject o3, PetscObject o4)
442: Not Collective; No Fortran Support
444: Input Parameters:
445: + e - the `PetscLogEvent`
446: . o1 - first object involved in the event (may be `NULL`)
447: . o2 - second object involved in the event (may be `NULL`)
448: . o3 - third object involved in the event (may be `NULL`)
449: - o4 - fourth object involved in the event (may be `NULL`)
451: Level: intermediate
453: Note:
454: Forwards the call to every active `PetscLogHandler` that implements an `eventBegin` method. Use
455: `PetscLogEventEnd()` to log the end of the same event.
457: .seealso: `PetscLogEvent`, `PetscLogEventRegister()`, `PetscLogEventEnd()`, `PetscLogEventSync()`
458: M*/
459: #define PetscLogEventBegin(e, o1, o2, o3, o4) PetscLogEventBegin_Internal(e, (PetscObject)(o1), (PetscObject)(o2), (PetscObject)(o3), (PetscObject)(o4))
461: static inline PetscErrorCode PetscLogEventEnd_Internal(PetscLogEvent e, PetscObject o1, PetscObject o2, PetscObject o3, PetscObject o4)
462: {
463: if (PetscLogStateEventCurrentlyActive(petsc_log_state, e)) {
464: for (int i = 0; i < PETSC_LOG_HANDLER_MAX; i++) {
465: PetscLogHandlerHot *h = &PetscLogHandlers[i];
466: if (h->eventEnd) {
467: PetscErrorCode err = (*h->eventEnd)(h->handler, e, o1, o2, o3, o4);
468: if (err != PETSC_SUCCESS) return err;
469: }
470: }
471: }
472: return PETSC_SUCCESS;
473: }
474: /*MC
475: PetscLogEventEnd - Log the end of an instance of a `PetscLogEvent`
477: Synopsis:
478: #include <petsclog.h>
479: PetscErrorCode PetscLogEventEnd(PetscLogEvent e, PetscObject o1, PetscObject o2, PetscObject o3, PetscObject o4)
481: Not Collective; No Fortran Support
483: Input Parameters:
484: + e - the `PetscLogEvent`
485: . o1 - first object involved in the event (may be `NULL`)
486: . o2 - second object involved in the event (may be `NULL`)
487: . o3 - third object involved in the event (may be `NULL`)
488: - o4 - fourth object involved in the event (may be `NULL`)
490: Level: intermediate
492: Note:
493: Must be paired with a prior `PetscLogEventBegin()` for the same event.
495: .seealso: `PetscLogEvent`, `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventSync()`
496: M*/
497: #define PetscLogEventEnd(e, o1, o2, o3, o4) PetscLogEventEnd_Internal(e, (PetscObject)(o1), (PetscObject)(o2), (PetscObject)(o3), (PetscObject)(o4))
499: /* Object functions */
500: /*@
501: PetscLogObjectCreate - Notify the active `PetscLogHandler`s that a new `PetscObject` has been created
503: Not Collective; No Fortran Support
505: Input Parameter:
506: . o - the newly created `PetscObject`
508: Level: developer
510: Note:
511: Called internally by PETSc object constructors; users normally do not need to call this directly.
513: .seealso: `PetscLogObjectDestroy()`, `PetscLogHandler`, `PetscObject`
514: @*/
515: static inline PetscErrorCode PetscLogObjectCreate(PetscObject o)
516: {
517: if (petsc_log_state) {
518: for (int i = 0; i < PETSC_LOG_HANDLER_MAX; i++) {
519: PetscLogHandlerHot *h = &PetscLogHandlers[i];
520: if (h->objectCreate) {
521: PetscErrorCode err = (*h->objectCreate)(h->handler, o);
522: if (err != PETSC_SUCCESS) return err;
523: }
524: }
525: }
526: return PETSC_SUCCESS;
527: }
529: /*@
530: PetscLogObjectDestroy - Notify the active `PetscLogHandler`s that a `PetscObject` is being destroyed
532: Not Collective; No Fortran Support
534: Input Parameter:
535: . o - the `PetscObject` that is being destroyed
537: Level: developer
539: Note:
540: Called internally by PETSc object destructors; users normally do not need to call this directly.
542: .seealso: `PetscLogObjectCreate()`, `PetscLogHandler`, `PetscObject`
543: @*/
544: static inline PetscErrorCode PetscLogObjectDestroy(PetscObject o)
545: {
546: if (petsc_log_state) {
547: for (int i = 0; i < PETSC_LOG_HANDLER_MAX; i++) {
548: PetscLogHandlerHot *h = &PetscLogHandlers[i];
549: if (h->objectDestroy) {
550: PetscErrorCode err = (*h->objectDestroy)(h->handler, o);
551: if (err != PETSC_SUCCESS) return err;
552: }
553: }
554: }
555: return PETSC_SUCCESS;
556: }
558: /*
559: Flop counting: We count each arithmetic operation (e.g., addition, multiplication) separately.
561: For the complex numbers version, note that
562: 1 complex addition = 2 flops
563: 1 complex multiplication = 6 flops,
564: where we define 1 flop as that for a double precision scalar. We roughly approximate
565: flop counting for complex numbers by multiplying the total flops by 4; this corresponds
566: to the assumption that we're counting mostly additions and multiplications -- and
567: roughly the same number of each. More accurate counting could be done by distinguishing
568: among the various arithmetic operations.
569: */
571: #if PetscDefined(USE_COMPLEX)
572: #define PETSC_FLOPS_PER_OP 4.0
573: #else
574: #define PETSC_FLOPS_PER_OP 1.0
575: #endif
577: /*@
578: PetscLogFlops - Log how many flops are performed in a calculation
580: Not Collective
582: Input Parameter:
583: . n - the number of flops
585: Level: intermediate
587: Note:
588: To limit the chance of integer overflow when multiplying by a constant, represent the constant as a double,
589: not an integer. Use `PetscLogFlops`(4.0*n) not `PetscLogFlops`(4*n)
591: .seealso: [](ch_profiling), `PetscLogView()`, `PetscLogGpuFlops()`
592: @*/
593: static inline PetscErrorCode PetscLogFlops(PetscLogDouble n)
594: {
595: PetscAssert(n >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Cannot log negative flops");
596: return PetscAddLogDouble(&petsc_TotalFlops, &petsc_TotalFlops_th, PETSC_FLOPS_PER_OP * n);
597: }
599: /*
600: These are used internally in the PETSc routines to keep a count of MPI messages and
601: their sizes.
603: This does not work for MPI-Uni because our include/petsc/mpiuni/mpi.h file
604: uses macros to defined the MPI operations.
606: It does not work correctly from HP-UX because it processes the
607: macros in a way that sometimes it double counts, hence
608: PETSC_HAVE_BROKEN_RECURSIVE_MACRO
610: It does not work with Windows because winmpich lacks MPI_Type_size()
611: */
612: #if !defined(MPIUNI_H) && !PetscDefined(HAVE_BROKEN_RECURSIVE_MACRO)
613: /*
614: Logging of MPI activities
615: */
616: static inline PetscErrorCode PetscMPITypeSize(PetscCount count, MPI_Datatype type, PetscLogDouble *length, PetscLogDouble *length_th)
617: {
618: PetscMPIInt typesize;
620: if (type == MPI_DATATYPE_NULL) return PETSC_SUCCESS;
621: PetscCallMPI(MPI_Type_size(type, &typesize));
622: return PetscAddLogDouble(length, length_th, (PetscLogDouble)(count * typesize));
623: }
625: static inline PetscErrorCode PetscMPITypeSizeComm(MPI_Comm comm, const PetscMPIInt *counts, MPI_Datatype type, PetscLogDouble *length, PetscLogDouble *length_th)
626: {
627: PetscMPIInt typesize, size, p;
628: PetscLogDouble l;
630: if (type == MPI_DATATYPE_NULL) return PETSC_SUCCESS;
631: PetscCallMPI(MPI_Comm_size(comm, &size));
632: PetscCallMPI(MPI_Type_size(type, &typesize));
633: for (p = 0, l = 0.0; p < size; ++p) l += (PetscLogDouble)(counts[p] * typesize);
634: return PetscAddLogDouble(length, length_th, l);
635: }
637: /*
638: Returns 1 if the communicator is parallel else zero
639: */
640: static inline int PetscMPIParallelComm(MPI_Comm comm)
641: {
642: PetscMPIInt size;
643: MPI_Comm_size(comm, &size);
644: return size > 1;
645: }
647: #define MPI_Irecv(buf, count, datatype, source, tag, comm, request) \
648: (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)))
650: #define MPI_Irecv_c(buf, count, datatype, source, tag, comm, request) \
651: (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)))
653: #define MPI_Isend(buf, count, datatype, dest, tag, comm, request) \
654: (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)))
656: #define MPI_Isend_c(buf, count, datatype, dest, tag, comm, request) \
657: (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)))
659: #define MPI_Startall_irecv(count, datatype, number, requests) \
660: (PetscAddLogDouble(&petsc_irecv_ct, &petsc_irecv_ct_th, number) || PetscMPITypeSize((count), (datatype), &(petsc_irecv_len), &(petsc_irecv_len_th)) || ((number) && MPI_Startall((number), (requests))))
662: #define MPI_Startall_isend(count, datatype, number, requests) \
663: (PetscAddLogDouble(&petsc_isend_ct, &petsc_isend_ct_th, number) || PetscMPITypeSize((count), (datatype), &(petsc_isend_len), &(petsc_isend_len_th)) || ((number) && MPI_Startall((number), (requests))))
665: #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))
667: #define MPI_Recv(buf, count, datatype, source, tag, comm, status) \
668: (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)))
670: #define MPI_Recv_c(buf, count, datatype, source, tag, comm, status) \
671: (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)))
673: #define MPI_Send(buf, count, datatype, dest, tag, comm) \
674: (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)))
676: #define MPI_Send_c(buf, count, datatype, dest, tag, comm) \
677: (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)))
679: #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)))
681: #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)))
683: #define MPI_Waitall(count, array_of_requests, array_of_statuses) \
684: (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)))
686: #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)))
688: #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)))
690: #define MPI_Reduce_scatter_block(sendbuf, recvbuf, recvcount, datatype, op, comm) \
691: (PetscAddLogDouble(&petsc_allreduce_ct, &petsc_allreduce_ct_th, PetscMPIParallelComm(comm)) || MPI_Reduce_scatter_block((sendbuf), (recvbuf), (recvcount), (datatype), (op), (comm)))
693: #define MPI_Alltoall(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, comm) \
694: (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)))
696: #define MPI_Alltoallv(sendbuf, sendcnts, sdispls, sendtype, recvbuf, recvcnts, rdispls, recvtype, comm) \
697: (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)))
699: #define MPI_Allgather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, comm) \
700: (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, PetscMPIParallelComm(comm)) || MPI_Allgather((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (recvtype), (comm)))
702: #define MPI_Allgatherv(sendbuf, sendcount, sendtype, recvbuf, recvcount, displs, recvtype, comm) \
703: (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, PetscMPIParallelComm(comm)) || MPI_Allgatherv((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (displs), (recvtype), (comm)))
705: #define MPI_Gather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, root, comm) \
706: (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)))
708: #define MPI_Gatherv(sendbuf, sendcount, sendtype, recvbuf, recvcount, displs, recvtype, root, comm) \
709: (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)))
711: #define MPI_Scatter(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, root, comm) \
712: (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)))
714: #define MPI_Scatterv(sendbuf, sendcount, displs, sendtype, recvbuf, recvcount, recvtype, root, comm) \
715: (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)))
717: #define MPI_Ialltoall(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, comm, request) \
718: (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)))
720: #define MPI_Ialltoallv(sendbuf, sendcnts, sdispls, sendtype, recvbuf, recvcnts, rdispls, recvtype, comm, request) \
721: (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)))
723: #define MPI_Iallgather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, comm, request) \
724: (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, PetscMPIParallelComm(comm)) || MPI_Iallgather((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (recvtype), (comm), (request)))
726: #define MPI_Iallgatherv(sendbuf, sendcount, sendtype, recvbuf, recvcount, displs, recvtype, comm, request) \
727: (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, PetscMPIParallelComm(comm)) || MPI_Iallgatherv((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (displs), (recvtype), (comm), (request)))
729: #define MPI_Igather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, root, comm, request) \
730: (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)))
732: #define MPI_Igatherv(sendbuf, sendcount, sendtype, recvbuf, recvcount, displs, recvtype, root, comm, request) \
733: (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)))
735: #define MPI_Iscatter(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, root, comm, request) \
736: (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)))
738: #define MPI_Iscatterv(sendbuf, sendcount, displs, sendtype, recvbuf, recvcount, recvtype, root, comm, request) \
739: (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)))
741: #define MPIX_Send_enqueue(buf, count, datatype, dest, tag, comm) \
742: (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)))
744: #define MPIX_Recv_enqueue(buf, count, datatype, source, tag, comm, status) \
745: (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)))
747: #define MPIX_Isend_enqueue(buf, count, datatype, dest, tag, comm, request) \
748: (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)))
750: #define MPIX_Irecv_enqueue(buf, count, datatype, source, tag, comm, request) \
751: (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)))
753: #define MPIX_Allreduce_enqueue(sendbuf, recvbuf, count, datatype, op, comm) \
754: (PetscAddLogDouble(&petsc_allreduce_ct, &petsc_allreduce_ct_th, PetscMPIParallelComm(comm)) || MPIX_Allreduce_enqueue((sendbuf), (recvbuf), (count), (datatype), (op), (comm)))
756: #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)))
758: #define MPIX_Waitall_enqueue(count, array_of_requests, array_of_statuses) \
759: (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)))
760: #else
762: #define MPI_Startall_irecv(count, datatype, number, requests) ((number) && MPI_Startall((number), (requests)))
764: #define MPI_Startall_isend(count, datatype, number, requests) ((number) && MPI_Startall((number), (requests)))
766: #define MPI_Start_isend(count, datatype, requests) (MPI_Start(requests))
768: #endif /* !MPIUNI_H && ! PETSC_HAVE_BROKEN_RECURSIVE_MACRO */
770: #else /* ---Logging is turned off --------------------------------------------*/
772: #define PetscLogGetState(a) (*(a) = NULL, PETSC_SUCCESS)
773: #define PetscLogGetDefaultHandler(a) (*(a) = NULL, PETSC_SUCCESS)
774: #define PetscLogHandlerStart(a) ((void)(a), PETSC_SUCCESS)
775: #define PetscLogHandlerStop(a) ((void)(a), PETSC_SUCCESS)
777: #define PetscLogFlops(n) ((void)(n), PETSC_SUCCESS)
778: #define PetscGetFlops(a) (*(a) = 0.0, PETSC_SUCCESS)
780: #define PetscLogStageRegister(a, b) ((void)(a), *(b) = -1, PETSC_SUCCESS)
781: #define PetscLogStagePush(a) ((void)(a), PETSC_SUCCESS)
782: #define PetscLogStagePop() PETSC_SUCCESS
783: #define PetscLogStageSetActive(a, b) ((void)(a), (void)(b), PETSC_SUCCESS)
784: #define PetscLogStageGetActive(a, b) ((void)(a), *(b) = PETSC_FALSE, PETSC_SUCCESS)
785: #define PetscLogStageGetVisible(a, b) ((void)(a), *(b) = PETSC_FALSE, PETSC_SUCCESS)
786: #define PetscLogStageSetVisible(a, b) ((void)(a), (void)(b), PETSC_SUCCESS)
787: #define PetscLogStageGetId(a, b) ((void)(a), *(b) = -1, PETSC_SUCCESS)
788: #define PetscLogStageGetName(a, b) ((void)(a), *(b) = NULL, PETSC_SUCCESS)
789: #define PetscLogStageGetPerfInfo(a, b) ((void)(a), *(b) = (const PetscEventPerfInfo){0}, PETSC_SUCCESS)
791: #define PetscLogEventRegister(a, b, c) ((void)(a), (void)(b), *(c) = -1, PETSC_SUCCESS)
792: #define PetscLogEventSetCollective(a, b) ((void)(a), (void)(b), PETSC_SUCCESS)
793: #define PetscLogEventIncludeClass(a) ((void)(a), PETSC_SUCCESS)
794: #define PetscLogEventExcludeClass(a) ((void)(a), PETSC_SUCCESS)
795: #define PetscLogEventActivate(a) ((void)(a), PETSC_SUCCESS)
796: #define PetscLogEventDeactivate(a) ((void)(a), PETSC_SUCCESS)
797: #define PetscLogEventDeactivatePush(a) ((void)(a), PETSC_SUCCESS)
798: #define PetscLogEventDeactivatePop(a) ((void)(a), PETSC_SUCCESS)
799: #define PetscLogEventActivateClass(a) ((void)(a), PETSC_SUCCESS)
800: #define PetscLogEventDeactivateClass(a) ((void)(a), PETSC_SUCCESS)
801: #define PetscLogEventSetActiveAll(a, b) ((void)(a), PETSC_SUCCESS)
802: #define PetscLogEventGetId(a, b) ((void)(a), *(b) = -1, PETSC_SUCCESS)
803: #define PetscLogEventGetName(a, b) ((void)(a), *(b) = NULL, PETSC_SUCCESS)
804: #define PetscLogEventGetPerfInfo(a, b, c) ((void)(a), (void)(b), *(c) = (const PetscEventPerfInfo){0}, PETSC_SUCCESS)
806: #define PetscLogEventSetDof(a, b, c) ((void)(a), (void)(b), (void)(c), PETSC_SUCCESS)
807: #define PetscLogEventSetError(a, b, c) ((void)(a), (void)(b), (void)(c), PETSC_SUCCESS)
808: #define PetscLogEventsPause() PETSC_SUCCESS
809: #define PetscLogEventsResume() PETSC_SUCCESS
811: #define PetscLogClassGetClassId(a, b) (*(b) = -1, PETSC_SUCCESS)
812: #define PetscLogClassIdGetName(a, b) (*(b) = NULL, PETSC_SUCCESS)
814: #define PetscLogObjectCreate(h) ((void)(h), PETSC_SUCCESS)
815: #define PetscLogObjectDestroy(h) ((void)(h), PETSC_SUCCESS)
816: #define PetscLogObjectState(h, c, ...) ((void)(h), (void)(c), PETSC_SUCCESS)
818: #define PetscLogDefaultBegin() PETSC_SUCCESS
819: #define PetscLogNestedBegin() PETSC_SUCCESS
820: #define PetscLogTraceBegin(file) ((void)(file), PETSC_SUCCESS)
821: #define PetscLogMPEBegin() PETSC_SUCCESS
822: #define PetscLogPerfstubsBegin() PETSC_SUCCESS
823: #define PetscLogLegacyCallbacksBegin(a, b, c, d) ((void)(a), (void)(b), (void)(c), (void)(d), PETSC_SUCCESS)
824: #define PetscLogActions(a) ((void)(a), PETSC_SUCCESS)
825: #define PetscLogObjects(a) ((void)(a), PETSC_SUCCESS)
826: #define PetscLogSetThreshold(a, b) ((void)(a), (void)(b), PETSC_SUCCESS)
828: #define PetscLogIsActive(flag) (*(flag) = PETSC_FALSE, PETSC_SUCCESS)
830: #define PetscLogView(viewer) ((void)(viewer), PETSC_SUCCESS)
831: #define PetscLogViewFromOptions() PETSC_SUCCESS
832: #define PetscLogDump(c) ((void)(c), PETSC_SUCCESS)
833: #define PetscLogMPEDump(c) ((void)(c), PETSC_SUCCESS)
835: #define PetscLogEventSync(e, comm) ((void)(e), (void)(comm), PETSC_SUCCESS)
836: #define PetscLogEventBegin(e, o1, o2, o3, o4) ((void)(e), (void)(o1), (void)(o2), (void)(o3), PETSC_SUCCESS)
837: #define PetscLogEventEnd(e, o1, o2, o3, o4) ((void)(e), (void)(o1), (void)(o2), (void)(o3), PETSC_SUCCESS)
839: /* If PETSC_USE_LOG is NOT defined, these still need to be! */
840: #define MPI_Startall_irecv(count, datatype, number, requests) ((number) && MPI_Startall(number, requests))
841: #define MPI_Startall_isend(count, datatype, number, requests) ((number) && MPI_Startall(number, requests))
842: #define MPI_Start_isend(count, datatype, requests) MPI_Start(requests)
844: #endif /* PETSC_USE_LOG */
846: /*MC
847: PetscPreLoadBegin - Begin a block of code that is timed twice so that startup costs (such as JIT or first-touch allocation) are not attributed to the measured run
849: Synopsis:
850: #include <petsclog.h>
851: PetscPreLoadBegin(PetscBool flag, const char name[])
853: Not Collective; No Fortran Support
855: Input Parameters:
856: + flag - whether preloading is desired (may be overridden by the command-line option `-preload`)
857: - name - name to use for the `PetscLogStage` created for the measured run
859: Level: intermediate
861: Note:
862: Use this macro in the form
863: .vb
864: PetscPreLoadBegin(PETSC_TRUE, "Compute");
865: // ... code to be timed
866: PetscPreLoadEnd();
867: .ve
868: It expands to a loop that runs the enclosed code twice when preloading is enabled and once otherwise.
869: Pair with `PetscPreLoadEnd()`. Use `PetscPreLoadStage()` to advance to a new named stage between phases.
871: .seealso: `PetscPreLoadEnd`, `PetscPreLoadStage`, `PetscLogStageRegister()`, `PetscLogStagePush()`
872: M*/
873: #define PetscPreLoadBegin(flag, name) \
874: do { \
875: PetscBool PetscPreLoading = flag; \
876: int PetscPreLoadMax, PetscPreLoadIt; \
877: PetscLogStage _stageNum; \
878: PetscCall(PetscOptionsGetBool(NULL, NULL, "-preload", &PetscPreLoading, NULL)); \
879: PetscPreLoadMax = (int)(PetscPreLoading); \
880: PetscPreLoadingUsed = PetscPreLoading ? PETSC_TRUE : PetscPreLoadingUsed; \
881: PetscCall(PetscLogStageGetId(name, &_stageNum)); \
882: for (PetscPreLoadIt = (_stageNum == -1) ? 0 : PetscPreLoadMax; PetscPreLoadIt <= PetscPreLoadMax; PetscPreLoadIt++) { \
883: PetscPreLoadingOn = (PetscBool)(PetscPreLoadIt < PetscPreLoadMax); \
884: PetscCall(PetscBarrier(NULL)); \
885: if (_stageNum == -1) PetscCall(PetscLogStageRegister(name, &_stageNum)); \
886: PetscCall(PetscLogStageSetActive(_stageNum, (PetscBool)(PetscPreLoadIt == PetscPreLoadMax))); \
887: PetscCall(PetscLogStagePush(_stageNum))
889: /*MC
890: PetscPreLoadEnd - Close a preload block started with `PetscPreLoadBegin()`
892: Synopsis:
893: #include <petsclog.h>
894: PetscPreLoadEnd()
896: Not Collective; No Fortran Support
898: Level: intermediate
900: .seealso: `PetscPreLoadBegin`, `PetscPreLoadStage`
901: M*/
902: #define PetscPreLoadEnd() \
903: PetscCall(PetscLogStagePop()); \
904: } \
905: } \
906: while (0)
908: /*MC
909: PetscPreLoadStage - Advance to a new named stage inside a `PetscPreLoadBegin()` / `PetscPreLoadEnd()` block
911: Synopsis:
912: #include <petsclog.h>
913: PetscPreLoadStage(const char name[])
915: Not Collective; No Fortran Support
917: Input Parameter:
918: . name - name for the new `PetscLogStage`
920: Level: intermediate
922: Note:
923: Pops the previous stage, registers (or reuses) the new stage, and pushes it. Only valid between
924: `PetscPreLoadBegin()` and `PetscPreLoadEnd()`.
926: .seealso: `PetscPreLoadBegin`, `PetscPreLoadEnd`, `PetscLogStagePush()`, `PetscLogStagePop()`
927: M*/
928: #define PetscPreLoadStage(name) \
929: do { \
930: PetscCall(PetscLogStagePop()); \
931: PetscCall(PetscLogStageGetId(name, &_stageNum)); \
932: if (_stageNum == -1) PetscCall(PetscLogStageRegister(name, &_stageNum)); \
933: PetscCall(PetscLogStageSetActive(_stageNum, (PetscBool)(!PetscPreLoadMax || PetscPreLoadIt))); \
934: PetscCall(PetscLogStagePush(_stageNum)); \
935: } while (0)
937: /* some vars for logging */
938: PETSC_EXTERN PetscBool PetscPreLoadingUsed; /* true if we are or have done preloading */
939: PETSC_EXTERN PetscBool PetscPreLoadingOn; /* true if we are currently in a preloading calculation */
941: #if PetscDefined(USE_LOG) && PetscDefined(HAVE_DEVICE)
943: PETSC_EXTERN PetscErrorCode PetscLogGpuTime(void);
944: PETSC_EXTERN PetscErrorCode PetscLogGpuTimeBegin(void);
945: PETSC_EXTERN PetscErrorCode PetscLogGpuTimeEnd(void);
946: PETSC_EXTERN PetscErrorCode PetscLogGpuEnergy(void);
947: PETSC_EXTERN PetscErrorCode PetscLogGpuEnergyMeter(void);
948: PETSC_EXTERN PetscErrorCode PetscLogGpuEnergyMeterBegin(void);
949: PETSC_EXTERN PetscErrorCode PetscLogGpuEnergyMeterEnd(void);
951: /*@
952: PetscLogGpuFlops - Log how many flops are performed in a calculation on the device
954: Not Collective
956: Input Parameter:
957: . n - the number of flops
959: Level: intermediate
961: Notes:
962: To limit the chance of integer overflow when multiplying by a constant, represent the constant as a double,
963: not an integer. Use `PetscLogFlops`(4.0*n) not `PetscLogFlops`(4*n)
965: The values are also added to the total flop count for the MPI rank that is set with `PetscLogFlops()`; hence the number of flops
966: just on the CPU would be the value from set from `PetscLogFlops()` minus the value set from `PetscLogGpuFlops()`
968: .seealso: [](ch_profiling), `PetscLogView()`, `PetscLogFlops()`, `PetscLogGpuTimeBegin()`, `PetscLogGpuTimeEnd()`
969: @*/
970: static inline PetscErrorCode PetscLogGpuFlops(PetscLogDouble n)
971: {
972: PetscAssert(n >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Cannot log negative flops");
973: PetscCall(PetscAddLogDouble(&petsc_TotalFlops, &petsc_TotalFlops_th, PETSC_FLOPS_PER_OP * n));
974: PetscCall(PetscAddLogDouble(&petsc_gflops, &petsc_gflops_th, PETSC_FLOPS_PER_OP * n));
975: return PETSC_SUCCESS;
976: }
978: /*@
979: PetscLogGpuTimeAdd - Add elapsed GPU computation time to PETSc's GPU time counter
981: Not Collective; No Fortran Support
983: Input Parameter:
984: . t - the elapsed time, in seconds, to add to the GPU time counter
986: Level: developer
988: Note:
989: Used internally by GPU backends to report the time spent in a kernel or library call.
991: .seealso: `PetscLogGpuTime()`, `PetscLogGpuTimeBegin()`, `PetscLogGpuTimeEnd()`, `PetscLogGpuFlops()`
992: @*/
993: static inline PetscErrorCode PetscLogGpuTimeAdd(PetscLogDouble t)
994: {
995: return PetscAddLogDouble(&petsc_gtime, &petsc_gtime_th, t);
996: }
998: /*@
999: PetscLogCpuToGpu - Log a CPU-to-GPU memory transfer for performance reporting
1001: Not Collective; No Fortran Support
1003: Input Parameter:
1004: . size - number of bytes transferred from CPU to GPU
1006: Level: developer
1008: Note:
1009: Updates both the transfer-count and transfer-size counters used by `PetscLogView()`.
1011: .seealso: `PetscLogGpuToCpu()`, `PetscLogCpuToGpuScalar()`, `PetscLogGpuFlops()`
1012: @*/
1013: static inline PetscErrorCode PetscLogCpuToGpu(PetscLogDouble size)
1014: {
1015: return PetscAddLogDoubleCnt(&petsc_ctog_ct, &petsc_ctog_sz, &petsc_ctog_ct_th, &petsc_ctog_sz_th, size);
1016: }
1018: /*@
1019: PetscLogGpuToCpu - Log a GPU-to-CPU memory transfer for performance reporting
1021: Not Collective; No Fortran Support
1023: Input Parameter:
1024: . size - number of bytes transferred from GPU to CPU
1026: Level: developer
1028: .seealso: `PetscLogCpuToGpu()`, `PetscLogGpuToCpuScalar()`, `PetscLogGpuFlops()`
1029: @*/
1030: static inline PetscErrorCode PetscLogGpuToCpu(PetscLogDouble size)
1031: {
1032: return PetscAddLogDoubleCnt(&petsc_gtoc_ct, &petsc_gtoc_sz, &petsc_gtoc_ct_th, &petsc_gtoc_sz_th, size);
1033: }
1035: /*@
1036: PetscLogCpuToGpuScalar - Log a CPU-to-GPU memory transfer of `PetscScalar` data for performance reporting
1038: Not Collective; No Fortran Support
1040: Input Parameter:
1041: . size - number of bytes of scalar data transferred from CPU to GPU
1043: Level: developer
1045: Note:
1046: Tracks scalar-only transfers separately from generic byte counters tracked by `PetscLogCpuToGpu()`.
1048: .seealso: `PetscLogCpuToGpu()`, `PetscLogGpuToCpuScalar()`
1049: @*/
1050: static inline PetscErrorCode PetscLogCpuToGpuScalar(PetscLogDouble size)
1051: {
1052: return PetscAddLogDoubleCnt(&petsc_ctog_ct_scalar, &petsc_ctog_sz_scalar, &petsc_ctog_ct_scalar_th, &petsc_ctog_sz_scalar_th, size);
1053: }
1055: /*@
1056: PetscLogGpuToCpuScalar - Log a GPU-to-CPU memory transfer of `PetscScalar` data for performance reporting
1058: Not Collective; No Fortran Support
1060: Input Parameter:
1061: . size - number of bytes of scalar data transferred from GPU to CPU
1063: Level: developer
1065: .seealso: `PetscLogGpuToCpu()`, `PetscLogCpuToGpuScalar()`
1066: @*/
1067: static inline PetscErrorCode PetscLogGpuToCpuScalar(PetscLogDouble size)
1068: {
1069: return PetscAddLogDoubleCnt(&petsc_gtoc_ct_scalar, &petsc_gtoc_sz_scalar, &petsc_gtoc_ct_scalar_th, &petsc_gtoc_sz_scalar_th, size);
1070: }
1071: #else
1073: #define PetscLogCpuToGpu(a) ((void)(a), PETSC_SUCCESS)
1074: #define PetscLogGpuToCpu(a) ((void)(a), PETSC_SUCCESS)
1075: #define PetscLogCpuToGpuScalar(a) ((void)(a), PETSC_SUCCESS)
1076: #define PetscLogGpuToCpuScalar(a) ((void)(a), PETSC_SUCCESS)
1077: #define PetscLogGpuFlops(a) ((void)(a), PETSC_SUCCESS)
1078: #define PetscLogGpuTimeAdd(a) ((void)(a), PETSC_SUCCESS)
1079: #define PetscLogGpuTime() PETSC_SUCCESS
1080: #define PetscLogGpuTimeBegin() PETSC_SUCCESS
1081: #define PetscLogGpuTimeEnd() PETSC_SUCCESS
1083: #define PetscLogGpuEnergy() PETSC_SUCCESS
1084: #define PetscLogGpuEnergyMeter() PETSC_SUCCESS
1085: #define PetscLogGpuEnergyMeterBegin() PETSC_SUCCESS
1086: #define PetscLogGpuEnergyMeterEnd() PETSC_SUCCESS
1088: #endif /* PETSC_USE_LOG && PETSC_HAVE_DEVICE */
1090: /* remove TLS defines */
1091: #undef PETSC_EXTERN_TLS
1092: #undef PETSC_TLS
1094: #include <petsclogdeprecated.h>