Date: 2025-03-29T05:58:17+00:00

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 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

     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 *);
     79: PETSC_EXTERN PetscErrorCode PetscLogStateGetRegistry(PetscLogState, PetscLogRegistry *);

     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);

     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 *);

     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 *);

     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 *);

    109: PETSC_EXTERN PetscClassId PETSCLOGHANDLER_CLASSID;

    111: PETSC_EXTERN PetscFunctionList PetscLogHandlerList;

    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);

    129: PETSC_EXTERN PetscErrorCode PetscLogHandlerGetEventPerfInfo(PetscLogHandler, PetscLogStage, PetscLogEvent, PetscEventPerfInfo **);
    130: PETSC_EXTERN PetscErrorCode PetscLogHandlerGetStagePerfInfo(PetscLogHandler, PetscLogStage, PetscEventPerfInfo **);
    131: PETSC_EXTERN PetscErrorCode PetscLogHandlerSetLogActions(PetscLogHandler, PetscBool);
    132: PETSC_EXTERN PetscErrorCode PetscLogHandlerSetLogObjects(PetscLogHandler, PetscBool);
    133: PETSC_EXTERN PetscErrorCode PetscLogHandlerLogObjectState(PetscLogHandler, PetscObject, const char[], ...);
    134: PETSC_EXTERN PetscErrorCode PetscLogHandlerGetNumObjects(PetscLogHandler, PetscInt *);
    135: PETSC_EXTERN PetscErrorCode PetscLogHandlerEventDeactivatePush(PetscLogHandler, PetscLogStage, PetscLogEvent);
    136: PETSC_EXTERN PetscErrorCode PetscLogHandlerEventDeactivatePop(PetscLogHandler, PetscLogStage, PetscLogEvent);
    137: PETSC_EXTERN PetscErrorCode PetscLogHandlerEventsPause(PetscLogHandler);
    138: PETSC_EXTERN PetscErrorCode PetscLogHandlerEventsResume(PetscLogHandler);
    139: PETSC_EXTERN PetscErrorCode PetscLogHandlerDump(PetscLogHandler, const char[]);
    140: PETSC_EXTERN PetscErrorCode PetscLogHandlerStageSetVisible(PetscLogHandler, PetscLogStage, PetscBool);
    141: PETSC_EXTERN PetscErrorCode PetscLogHandlerStageGetVisible(PetscLogHandler, PetscLogStage, PetscBool *);

    143: PETSC_EXTERN PetscErrorCode PetscLogHandlerCreateTrace(MPI_Comm, FILE *, PetscLogHandler *);
    144: 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 *);

    146: /* All events are inactive if an invalid stage is set, like if there have been more stage pops than stage pushes */
    147: #define PetscLogStateStageEventIsActive(state, stage, event) ((stage >= 0) && PetscBTLookup((state)->active, (stage)) && PetscBTLookup((state)->active, (stage) + (event + 1) * (state)->bt_num_stages))
    148: #define PetscLogStateEventCurrentlyActive(state, event)      ((state) && PetscLogStateStageEventIsActive(state, (state)->current_stage, event))

    150: /* PetscLogHandler with critical methods exposed for speed */
    151: typedef struct _n_PetscLogHandlerHot {
    152:   PetscLogHandler handler;
    153:   PetscErrorCode (*eventBegin)(PetscLogHandler, PetscLogEvent, PetscObject, PetscObject, PetscObject, PetscObject);
    154:   PetscErrorCode (*eventEnd)(PetscLogHandler, PetscLogEvent, PetscObject, PetscObject, PetscObject, PetscObject);
    155:   PetscErrorCode (*eventSync)(PetscLogHandler, PetscLogEvent, MPI_Comm);
    156:   PetscErrorCode (*objectCreate)(PetscLogHandler, PetscObject);
    157:   PetscErrorCode (*objectDestroy)(PetscLogHandler, PetscObject);
    158: } PetscLogHandlerHot;

    160: /* Handle multithreading */
    161: #if defined(PETSC_HAVE_THREADSAFETY)
    162:   #if defined(__cplusplus)
    163:     #define PETSC_TLS thread_local
    164:   #else
    165:     #define PETSC_TLS _Thread_local
    166:   #endif
    167:   #define PETSC_EXTERN_TLS extern PETSC_TLS PETSC_VISIBILITY_PUBLIC
    168: PETSC_EXTERN PetscErrorCode PetscAddLogDouble(PetscLogDouble *, PetscLogDouble *, PetscLogDouble);
    169: PETSC_EXTERN PetscErrorCode PetscAddLogDoubleCnt(PetscLogDouble *, PetscLogDouble *, PetscLogDouble *, PetscLogDouble *, PetscLogDouble);
    170: #else
    171:   #define PETSC_EXTERN_TLS PETSC_EXTERN
    172:   #define PETSC_TLS
    173:   #define PetscAddLogDouble(a, b, c)          ((PetscErrorCode)((*(a) += (c), PETSC_SUCCESS) || ((*(b) += (c)), PETSC_SUCCESS)))
    174:   #define PetscAddLogDoubleCnt(a, b, c, d, e) ((PetscErrorCode)(PetscAddLogDouble(a, c, 1) || PetscAddLogDouble(b, d, e)))
    175: #endif

    177: PETSC_DEPRECATED_FUNCTION(3, 18, 0, "PetscLogObjectParent()", ) static inline PetscErrorCode PetscLogObjectParent(PetscObject o, PetscObject p)
    178: {
    179:   (void)o;
    180:   (void)p;
    181:   return PETSC_SUCCESS;
    182: }
    183: #define PetscLogObjectParents(p, n, d) PetscMacroReturnStandard(for (int _i = 0; _i < (n); ++_i) PetscCall(PetscLogObjectParent((PetscObject)(p), (PetscObject)(d)[_i]));)

    185: PETSC_DEPRECATED_FUNCTION(3, 18, 0, "PetscLogObjectMemory()", ) static inline PetscErrorCode PetscLogObjectMemory(PetscObject o, PetscLogDouble m)
    186: {
    187:   (void)o;
    188:   (void)m;
    189:   return PETSC_SUCCESS;
    190: }

    192: /* Global flop counter */
    193: PETSC_EXTERN PetscLogDouble petsc_TotalFlops;
    194: PETSC_EXTERN PetscLogDouble petsc_irecv_ct;
    195: PETSC_EXTERN PetscLogDouble petsc_isend_ct;
    196: PETSC_EXTERN PetscLogDouble petsc_recv_ct;
    197: PETSC_EXTERN PetscLogDouble petsc_send_ct;
    198: PETSC_EXTERN PetscLogDouble petsc_irecv_len;
    199: PETSC_EXTERN PetscLogDouble petsc_isend_len;
    200: PETSC_EXTERN PetscLogDouble petsc_recv_len;
    201: PETSC_EXTERN PetscLogDouble petsc_send_len;
    202: PETSC_EXTERN PetscLogDouble petsc_allreduce_ct;
    203: PETSC_EXTERN PetscLogDouble petsc_gather_ct;
    204: PETSC_EXTERN PetscLogDouble petsc_scatter_ct;
    205: PETSC_EXTERN PetscLogDouble petsc_wait_ct;
    206: PETSC_EXTERN PetscLogDouble petsc_wait_any_ct;
    207: PETSC_EXTERN PetscLogDouble petsc_wait_all_ct;
    208: PETSC_EXTERN PetscLogDouble petsc_sum_of_waits_ct;

    210: /* Thread local storage */
    211: PETSC_EXTERN_TLS PetscLogDouble petsc_TotalFlops_th;
    212: PETSC_EXTERN_TLS PetscLogDouble petsc_irecv_ct_th;
    213: PETSC_EXTERN_TLS PetscLogDouble petsc_isend_ct_th;
    214: PETSC_EXTERN_TLS PetscLogDouble petsc_recv_ct_th;
    215: PETSC_EXTERN_TLS PetscLogDouble petsc_send_ct_th;
    216: PETSC_EXTERN_TLS PetscLogDouble petsc_irecv_len_th;
    217: PETSC_EXTERN_TLS PetscLogDouble petsc_isend_len_th;
    218: PETSC_EXTERN_TLS PetscLogDouble petsc_recv_len_th;
    219: PETSC_EXTERN_TLS PetscLogDouble petsc_send_len_th;
    220: PETSC_EXTERN_TLS PetscLogDouble petsc_allreduce_ct_th;
    221: PETSC_EXTERN_TLS PetscLogDouble petsc_gather_ct_th;
    222: PETSC_EXTERN_TLS PetscLogDouble petsc_scatter_ct_th;
    223: PETSC_EXTERN_TLS PetscLogDouble petsc_wait_ct_th;
    224: PETSC_EXTERN_TLS PetscLogDouble petsc_wait_any_ct_th;
    225: PETSC_EXTERN_TLS PetscLogDouble petsc_wait_all_ct_th;
    226: PETSC_EXTERN_TLS PetscLogDouble petsc_sum_of_waits_ct_th;

    228: /* Global GPU counters */
    229: PETSC_EXTERN PetscLogDouble petsc_ctog_ct;
    230: PETSC_EXTERN PetscLogDouble petsc_gtoc_ct;
    231: PETSC_EXTERN PetscLogDouble petsc_ctog_sz;
    232: PETSC_EXTERN PetscLogDouble petsc_gtoc_sz;
    233: PETSC_EXTERN PetscLogDouble petsc_ctog_ct_scalar;
    234: PETSC_EXTERN PetscLogDouble petsc_gtoc_ct_scalar;
    235: PETSC_EXTERN PetscLogDouble petsc_ctog_sz_scalar;
    236: PETSC_EXTERN PetscLogDouble petsc_gtoc_sz_scalar;
    237: PETSC_EXTERN PetscLogDouble petsc_gflops;
    238: PETSC_EXTERN PetscLogDouble petsc_gtime;

    240: /* Thread local storage */
    241: PETSC_EXTERN_TLS PetscLogDouble petsc_ctog_ct_th;
    242: PETSC_EXTERN_TLS PetscLogDouble petsc_gtoc_ct_th;
    243: PETSC_EXTERN_TLS PetscLogDouble petsc_ctog_sz_th;
    244: PETSC_EXTERN_TLS PetscLogDouble petsc_gtoc_sz_th;
    245: PETSC_EXTERN_TLS PetscLogDouble petsc_ctog_ct_scalar_th;
    246: PETSC_EXTERN_TLS PetscLogDouble petsc_gtoc_ct_scalar_th;
    247: PETSC_EXTERN_TLS PetscLogDouble petsc_ctog_sz_scalar_th;
    248: PETSC_EXTERN_TLS PetscLogDouble petsc_gtoc_sz_scalar_th;
    249: PETSC_EXTERN_TLS PetscLogDouble petsc_gflops_th;
    250: PETSC_EXTERN_TLS PetscLogDouble petsc_gtime_th;

    252: PETSC_EXTERN PetscBool PetscLogMemory;
    253: PETSC_EXTERN PetscBool PetscLogSyncOn; /* true if logging synchronization is enabled */

    255: PETSC_EXTERN PetscLogState petsc_log_state;

    257: #define PETSC_LOG_HANDLER_MAX 4
    258: PETSC_EXTERN PetscLogHandlerHot PetscLogHandlers[PETSC_LOG_HANDLER_MAX];

    260: #if defined(PETSC_USE_LOG) /* --- Logging is turned on --------------------------------*/
    261: PETSC_EXTERN PetscErrorCode PetscGetFlops(PetscLogDouble *);

    263: PETSC_EXTERN PetscErrorCode PetscLogObjectState(PetscObject, const char[], ...) PETSC_ATTRIBUTE_FORMAT(2, 3);

    265: /* Initialization functions */
    266: PETSC_EXTERN PetscErrorCode PetscLogDefaultBegin(void);
    267: PETSC_EXTERN PetscErrorCode PetscLogNestedBegin(void);
    268: PETSC_EXTERN PetscErrorCode PetscLogTraceBegin(FILE *);
    269: PETSC_EXTERN PetscErrorCode PetscLogMPEBegin(void);
    270: PETSC_EXTERN PetscErrorCode PetscLogPerfstubsBegin(void);
    271: PETSC_EXTERN PetscErrorCode PetscLogLegacyCallbacksBegin(PetscErrorCode (*)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), PetscErrorCode (*)(PetscLogEvent, int, PetscObject, PetscObject, PetscObject, PetscObject), PetscErrorCode (*)(PetscObject), PetscErrorCode (*)(PetscObject));
    272: PETSC_EXTERN PetscErrorCode PetscLogActions(PetscBool);
    273: PETSC_EXTERN PetscErrorCode PetscLogObjects(PetscBool);
    274: PETSC_EXTERN PetscErrorCode PetscLogSetThreshold(PetscLogDouble, PetscLogDouble *);

    276: /* Output functions */
    277: PETSC_EXTERN PetscErrorCode PetscLogView(PetscViewer);
    278: PETSC_EXTERN PetscErrorCode PetscLogViewFromOptions(void);
    279: PETSC_EXTERN PetscErrorCode PetscLogDump(const char[]);
    280: PETSC_EXTERN PetscErrorCode PetscLogMPEDump(const char[]);

    282: PETSC_EXTERN PetscErrorCode PetscLogGetState(PetscLogState *);
    283: PETSC_EXTERN PetscErrorCode PetscLogGetDefaultHandler(PetscLogHandler *);
    284: PETSC_EXTERN PetscErrorCode PetscLogHandlerStart(PetscLogHandler);
    285: PETSC_EXTERN PetscErrorCode PetscLogHandlerStop(PetscLogHandler);

    287: /* Status checking functions */
    288: PETSC_EXTERN PetscErrorCode PetscLogIsActive(PetscBool *);

    290: /* Stage functions */
    291: PETSC_EXTERN PetscErrorCode PetscLogStageRegister(const char[], PetscLogStage *);
    292: PETSC_EXTERN PetscErrorCode PetscLogStagePush(PetscLogStage);
    293: PETSC_EXTERN PetscErrorCode PetscLogStagePop(void);
    294: PETSC_EXTERN PetscErrorCode PetscLogStageSetActive(PetscLogStage, PetscBool);
    295: PETSC_EXTERN PetscErrorCode PetscLogStageGetActive(PetscLogStage, PetscBool *);
    296: PETSC_EXTERN PetscErrorCode PetscLogStageSetVisible(PetscLogStage, PetscBool);
    297: PETSC_EXTERN PetscErrorCode PetscLogStageGetVisible(PetscLogStage, PetscBool *);
    298: PETSC_EXTERN PetscErrorCode PetscLogStageGetId(const char[], PetscLogStage *);
    299: PETSC_EXTERN PetscErrorCode PetscLogStageGetName(PetscLogEvent, const char **);
    300: PETSC_EXTERN PetscErrorCode PetscLogStageGetPerfInfo(PetscLogStage, PetscEventPerfInfo *);

    302: /* Event functions */
    303: PETSC_EXTERN PetscErrorCode PetscLogEventRegister(const char[], PetscClassId, PetscLogEvent *);
    304: PETSC_EXTERN PetscErrorCode PetscLogEventSetCollective(PetscLogEvent, PetscBool);
    305: PETSC_EXTERN PetscErrorCode PetscLogEventIncludeClass(PetscClassId);
    306: PETSC_EXTERN PetscErrorCode PetscLogEventExcludeClass(PetscClassId);
    307: PETSC_EXTERN PetscErrorCode PetscLogEventActivate(PetscLogEvent);
    308: PETSC_EXTERN PetscErrorCode PetscLogEventDeactivate(PetscLogEvent);
    309: PETSC_EXTERN PetscErrorCode PetscLogEventDeactivatePush(PetscLogEvent);
    310: PETSC_EXTERN PetscErrorCode PetscLogEventDeactivatePop(PetscLogEvent);
    311: PETSC_EXTERN PetscErrorCode PetscLogEventSetActiveAll(PetscLogEvent, PetscBool);
    312: PETSC_EXTERN PetscErrorCode PetscLogEventActivateClass(PetscClassId);
    313: PETSC_EXTERN PetscErrorCode PetscLogEventDeactivateClass(PetscClassId);
    314: PETSC_EXTERN PetscErrorCode PetscLogEventGetId(const char[], PetscLogEvent *);
    315: PETSC_EXTERN PetscErrorCode PetscLogEventGetName(PetscLogEvent, const char **);
    316: PETSC_EXTERN PetscErrorCode PetscLogEventGetPerfInfo(PetscLogStage, PetscLogEvent, PetscEventPerfInfo *);
    317: PETSC_EXTERN PetscErrorCode PetscLogEventSetDof(PetscLogEvent, PetscInt, PetscLogDouble);
    318: PETSC_EXTERN PetscErrorCode PetscLogEventSetError(PetscLogEvent, PetscInt, PetscLogDouble);
    319: PETSC_EXTERN PetscErrorCode PetscLogEventsPause(void);
    320: PETSC_EXTERN PetscErrorCode PetscLogEventsResume(void);

    322: /* Class functions */
    323: PETSC_EXTERN PetscErrorCode PetscLogClassGetClassId(const char[], PetscClassId *);
    324: PETSC_EXTERN PetscErrorCode PetscLogClassIdGetName(PetscClassId, const char **);

    326: static inline PetscErrorCode PetscLogEventSync(PetscLogEvent e, MPI_Comm comm)
    327: {
    328:   if (PetscLogStateEventCurrentlyActive(petsc_log_state, e)) {
    329:     for (int i = 0; i < PETSC_LOG_HANDLER_MAX; i++) {
    330:       PetscLogHandlerHot *h = &PetscLogHandlers[i];
    331:       if (h->eventSync) {
    332:         PetscErrorCode err = (*h->eventSync)(h->handler, e, comm);
    333:         if (err != PETSC_SUCCESS) return err;
    334:       }
    335:     }
    336:   }
    337:   return PETSC_SUCCESS;
    338: }

    340: static inline PetscErrorCode PetscLogEventBegin_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->eventBegin) {
    346:         PetscErrorCode err = (*h->eventBegin)(h->handler, e, o1, o2, o3, o4);
    347:         if (err != PETSC_SUCCESS) return err;
    348:       }
    349:     }
    350:   }
    351:   return PETSC_SUCCESS;
    352: }
    353:   #define PetscLogEventBegin(e, o1, o2, o3, o4) PetscLogEventBegin_Internal(e, (PetscObject)(o1), (PetscObject)(o2), (PetscObject)(o3), (PetscObject)(o4))

    355: static inline PetscErrorCode PetscLogEventEnd_Internal(PetscLogEvent e, PetscObject o1, PetscObject o2, PetscObject o3, PetscObject o4)
    356: {
    357:   if (PetscLogStateEventCurrentlyActive(petsc_log_state, e)) {
    358:     for (int i = 0; i < PETSC_LOG_HANDLER_MAX; i++) {
    359:       PetscLogHandlerHot *h = &PetscLogHandlers[i];
    360:       if (h->eventEnd) {
    361:         PetscErrorCode err = (*h->eventEnd)(h->handler, e, o1, o2, o3, o4);
    362:         if (err != PETSC_SUCCESS) return err;
    363:       }
    364:     }
    365:   }
    366:   return PETSC_SUCCESS;
    367: }
    368:   #define PetscLogEventEnd(e, o1, o2, o3, o4) PetscLogEventEnd_Internal(e, (PetscObject)(o1), (PetscObject)(o2), (PetscObject)(o3), (PetscObject)(o4))

    370: /* Object functions */
    371: static inline PetscErrorCode PetscLogObjectCreate(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->objectCreate) {
    377:         PetscErrorCode err = (*h->objectCreate)(h->handler, o);
    378:         if (err != PETSC_SUCCESS) return err;
    379:       }
    380:     }
    381:   }
    382:   return PETSC_SUCCESS;
    383: }

    385: static inline PetscErrorCode PetscLogObjectDestroy(PetscObject o)
    386: {
    387:   if (petsc_log_state) {
    388:     for (int i = 0; i < PETSC_LOG_HANDLER_MAX; i++) {
    389:       PetscLogHandlerHot *h = &PetscLogHandlers[i];
    390:       if (h->objectDestroy) {
    391:         PetscErrorCode err = (*h->objectDestroy)(h->handler, o);
    392:         if (err != PETSC_SUCCESS) return err;
    393:       }
    394:     }
    395:   }
    396:   return PETSC_SUCCESS;
    397: }

    399: /*
    400:    Flop counting:  We count each arithmetic operation (e.g., addition, multiplication) separately.

    402:    For the complex numbers version, note that
    403:        1 complex addition = 2 flops
    404:        1 complex multiplication = 6 flops,
    405:    where we define 1 flop as that for a double precision scalar.  We roughly approximate
    406:    flop counting for complex numbers by multiplying the total flops by 4; this corresponds
    407:    to the assumption that we're counting mostly additions and multiplications -- and
    408:    roughly the same number of each.  More accurate counting could be done by distinguishing
    409:    among the various arithmetic operations.
    410:  */

    412:   #if defined(PETSC_USE_COMPLEX)
    413:     #define PETSC_FLOPS_PER_OP 4.0
    414:   #else
    415:     #define PETSC_FLOPS_PER_OP 1.0
    416:   #endif

    418: /*@
    419:    PetscLogFlops - Log how many flops are performed in a calculation

    421:    Input Parameter:
    422: .   flops - the number of flops

    424:    Level: intermediate

    426:    Note:
    427:    To limit the chance of integer overflow when multiplying by a constant, represent the constant as a double,
    428:    not an integer. Use `PetscLogFlops`(4.0*n) not `PetscLogFlops`(4*n)

    430: .seealso: [](ch_profiling), `PetscLogView()`, `PetscLogGpuFlops()`
    431: @*/
    432: static inline PetscErrorCode PetscLogFlops(PetscLogDouble n)
    433: {
    434:   PetscAssert(n >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Cannot log negative flops");
    435:   return PetscAddLogDouble(&petsc_TotalFlops, &petsc_TotalFlops_th, PETSC_FLOPS_PER_OP * n);
    436: }

    438:   /*
    439:      These are used internally in the PETSc routines to keep a count of MPI messages and
    440:    their sizes.

    442:      This does not work for MPI-Uni because our include/petsc/mpiuni/mpi.h file
    443:    uses macros to defined the MPI operations.

    445:      It does not work correctly from HP-UX because it processes the
    446:    macros in a way that sometimes it double counts, hence
    447:    PETSC_HAVE_BROKEN_RECURSIVE_MACRO

    449:      It does not work with Windows because winmpich lacks MPI_Type_size()
    450: */
    451:   #if !defined(MPIUNI_H) && !defined(PETSC_HAVE_BROKEN_RECURSIVE_MACRO)
    452: /*
    453:    Logging of MPI activities
    454: */
    455: static inline PetscErrorCode PetscMPITypeSize(PetscCount count, MPI_Datatype type, PetscLogDouble *length, PetscLogDouble *length_th)
    456: {
    457:   PetscMPIInt typesize;

    459:   if (type == MPI_DATATYPE_NULL) return PETSC_SUCCESS;
    460:   PetscCallMPI(MPI_Type_size(type, &typesize));
    461:   return PetscAddLogDouble(length, length_th, (PetscLogDouble)(count * typesize));
    462: }

    464: static inline PetscErrorCode PetscMPITypeSizeComm(MPI_Comm comm, const PetscMPIInt *counts, MPI_Datatype type, PetscLogDouble *length, PetscLogDouble *length_th)
    465: {
    466:   PetscMPIInt    typesize, size, p;
    467:   PetscLogDouble l;

    469:   if (type == MPI_DATATYPE_NULL) return PETSC_SUCCESS;
    470:   PetscCallMPI(MPI_Comm_size(comm, &size));
    471:   PetscCallMPI(MPI_Type_size(type, &typesize));
    472:   for (p = 0, l = 0.0; p < size; ++p) l += (PetscLogDouble)(counts[p] * typesize);
    473:   return PetscAddLogDouble(length, length_th, l);
    474: }

    476: /*
    477:     Returns 1 if the communicator is parallel else zero
    478: */
    479: static inline int PetscMPIParallelComm(MPI_Comm comm)
    480: {
    481:   PetscMPIInt size;
    482:   MPI_Comm_size(comm, &size);
    483:   return size > 1;
    484: }

    486:     #define MPI_Irecv(buf, count, datatype, source, tag, comm, request) \
    487:       (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)))

    489:     #define MPI_Irecv_c(buf, count, datatype, source, tag, comm, request) \
    490:       (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)))

    492:     #define MPI_Isend(buf, count, datatype, dest, tag, comm, request) \
    493:       (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)))

    495:     #define MPI_Isend_c(buf, count, datatype, dest, tag, comm, request) \
    496:       (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)))

    498:     #define MPI_Startall_irecv(count, datatype, number, requests) \
    499:       (PetscAddLogDouble(&petsc_irecv_ct, &petsc_irecv_ct_th, number) || PetscMPITypeSize((count), (datatype), &(petsc_irecv_len), &(petsc_irecv_len_th)) || ((number) && MPI_Startall((number), (requests))))

    501:     #define MPI_Startall_isend(count, datatype, number, requests) \
    502:       (PetscAddLogDouble(&petsc_isend_ct, &petsc_isend_ct_th, number) || PetscMPITypeSize((count), (datatype), &(petsc_isend_len), &(petsc_isend_len_th)) || ((number) && MPI_Startall((number), (requests))))

    504:     #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))

    506:     #define MPI_Recv(buf, count, datatype, source, tag, comm, status) \
    507:       (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)))

    509:     #define MPI_Recv_c(buf, count, datatype, source, tag, comm, status) \
    510:       (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)))

    512:     #define MPI_Send(buf, count, datatype, dest, tag, comm) \
    513:       (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)))

    515:     #define MPI_Send_c(buf, count, datatype, dest, tag, comm) \
    516:       (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)))

    518:     #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)))

    520:     #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)))

    522:     #define MPI_Waitall(count, array_of_requests, array_of_statuses) \
    523:       (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)))

    525:     #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)))

    527:     #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)))

    529:     #define MPI_Reduce_scatter_block(sendbuf, recvbuf, recvcount, datatype, op, comm) \
    530:       (PetscAddLogDouble(&petsc_allreduce_ct, &petsc_allreduce_ct_th, PetscMPIParallelComm(comm)) || MPI_Reduce_scatter_block((sendbuf), (recvbuf), (recvcount), (datatype), (op), (comm)))

    532:     #define MPI_Alltoall(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, comm) \
    533:       (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)))

    535:     #define MPI_Alltoallv(sendbuf, sendcnts, sdispls, sendtype, recvbuf, recvcnts, rdispls, recvtype, comm) \
    536:       (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)))

    538:     #define MPI_Allgather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, comm) \
    539:       (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, PetscMPIParallelComm(comm)) || MPI_Allgather((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (recvtype), (comm)))

    541:     #define MPI_Allgatherv(sendbuf, sendcount, sendtype, recvbuf, recvcount, displs, recvtype, comm) \
    542:       (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, PetscMPIParallelComm(comm)) || MPI_Allgatherv((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (displs), (recvtype), (comm)))

    544:     #define MPI_Gather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, root, comm) \
    545:       (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)))

    547:     #define MPI_Gatherv(sendbuf, sendcount, sendtype, recvbuf, recvcount, displs, recvtype, root, comm) \
    548:       (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)))

    550:     #define MPI_Scatter(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, root, comm) \
    551:       (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)))

    553:     #define MPI_Scatterv(sendbuf, sendcount, displs, sendtype, recvbuf, recvcount, recvtype, root, comm) \
    554:       (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)))

    556:     #define MPI_Ialltoall(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, comm, request) \
    557:       (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)))

    559:     #define MPI_Ialltoallv(sendbuf, sendcnts, sdispls, sendtype, recvbuf, recvcnts, rdispls, recvtype, comm, request) \
    560:       (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)))

    562:     #define MPI_Iallgather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, comm, request) \
    563:       (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, PetscMPIParallelComm(comm)) || MPI_Iallgather((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (recvtype), (comm), (request)))

    565:     #define MPI_Iallgatherv(sendbuf, sendcount, sendtype, recvbuf, recvcount, displs, recvtype, comm, request) \
    566:       (PetscAddLogDouble(&petsc_gather_ct, &petsc_gather_ct_th, PetscMPIParallelComm(comm)) || MPI_Iallgatherv((sendbuf), (sendcount), (sendtype), (recvbuf), (recvcount), (displs), (recvtype), (comm), (request)))

    568:     #define MPI_Igather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, root, comm, request) \
    569:       (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)))

    571:     #define MPI_Igatherv(sendbuf, sendcount, sendtype, recvbuf, recvcount, displs, recvtype, root, comm, request) \
    572:       (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)))

    574:     #define MPI_Iscatter(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype, root, comm, request) \
    575:       (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)))

    577:     #define MPI_Iscatterv(sendbuf, sendcount, displs, sendtype, recvbuf, recvcount, recvtype, root, comm, request) \
    578:       (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)))

    580:     #define MPIX_Send_enqueue(buf, count, datatype, dest, tag, comm) \
    581:       (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)))

    583:     #define MPIX_Recv_enqueue(buf, count, datatype, source, tag, comm, status) \
    584:       (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)))

    586:     #define MPIX_Isend_enqueue(buf, count, datatype, dest, tag, comm, request) \
    587:       (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)))

    589:     #define MPIX_Irecv_enqueue(buf, count, datatype, source, tag, comm, request) \
    590:       (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)))

    592:     #define MPIX_Allreduce_enqueue(sendbuf, recvbuf, count, datatype, op, comm) \
    593:       (PetscAddLogDouble(&petsc_allreduce_ct, &petsc_allreduce_ct_th, PetscMPIParallelComm(comm)) || MPIX_Allreduce_enqueue((sendbuf), (recvbuf), (count), (datatype), (op), (comm)))

    595:     #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)))

    597:     #define MPIX_Waitall_enqueue(count, array_of_requests, array_of_statuses) \
    598:       (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)))
    599:   #else

    601:     #define MPI_Startall_irecv(count, datatype, number, requests) ((number) && MPI_Startall((number), (requests)))

    603:     #define MPI_Startall_isend(count, datatype, number, requests) ((number) && MPI_Startall((number), (requests)))

    605:     #define MPI_Start_isend(count, datatype, requests) (MPI_Start(requests))

    607:   #endif /* !MPIUNI_H && ! PETSC_HAVE_BROKEN_RECURSIVE_MACRO */

    609: #else /* ---Logging is turned off --------------------------------------------*/

    611:   #define PetscLogGetState(a)          (*(a) = NULL, PETSC_SUCCESS)
    612:   #define PetscLogGetDefaultHandler(a) (*(a) = NULL, PETSC_SUCCESS)
    613:   #define PetscLogHandlerStart(a)      ((void)(a), PETSC_SUCCESS)
    614:   #define PetscLogHandlerStop(a)       ((void)(a), PETSC_SUCCESS)

    616:   #define PetscLogFlops(n) ((void)(n), PETSC_SUCCESS)
    617:   #define PetscGetFlops(a) (*(a) = 0.0, PETSC_SUCCESS)

    619:   #define PetscLogStageRegister(a, b)    ((void)(a), *(b) = -1, PETSC_SUCCESS)
    620:   #define PetscLogStagePush(a)           ((void)(a), PETSC_SUCCESS)
    621:   #define PetscLogStagePop()             PETSC_SUCCESS
    622:   #define PetscLogStageSetActive(a, b)   ((void)(a), (void)(b), PETSC_SUCCESS)
    623:   #define PetscLogStageGetActive(a, b)   ((void)(a), *(b) = PETSC_FALSE, PETSC_SUCCESS)
    624:   #define PetscLogStageGetVisible(a, b)  ((void)(a), *(b) = PETSC_FALSE, PETSC_SUCCESS)
    625:   #define PetscLogStageSetVisible(a, b)  ((void)(a), (void)(b), PETSC_SUCCESS)
    626:   #define PetscLogStageGetId(a, b)       ((void)(a), *(b) = -1, PETSC_SUCCESS)
    627:   #define PetscLogStageGetName(a, b)     ((void)(a), *(b) = NULL, PETSC_SUCCESS)
    628:   #define PetscLogStageGetPerfInfo(a, b) ((void)(a), *(b) = (const PetscEventPerfInfo){0}, PETSC_SUCCESS)

    630:   #define PetscLogEventRegister(a, b, c)    ((void)(a), (void)(b), *(c) = -1, PETSC_SUCCESS)
    631:   #define PetscLogEventSetCollective(a, b)  ((void)(a), (void)(b), PETSC_SUCCESS)
    632:   #define PetscLogEventIncludeClass(a)      ((void)(a), PETSC_SUCCESS)
    633:   #define PetscLogEventExcludeClass(a)      ((void)(a), PETSC_SUCCESS)
    634:   #define PetscLogEventActivate(a)          ((void)(a), PETSC_SUCCESS)
    635:   #define PetscLogEventDeactivate(a)        ((void)(a), PETSC_SUCCESS)
    636:   #define PetscLogEventDeactivatePush(a)    ((void)(a), PETSC_SUCCESS)
    637:   #define PetscLogEventDeactivatePop(a)     ((void)(a), PETSC_SUCCESS)
    638:   #define PetscLogEventActivateClass(a)     ((void)(a), PETSC_SUCCESS)
    639:   #define PetscLogEventDeactivateClass(a)   ((void)(a), PETSC_SUCCESS)
    640:   #define PetscLogEventSetActiveAll(a, b)   ((void)(a), PETSC_SUCCESS)
    641:   #define PetscLogEventGetId(a, b)          ((void)(a), *(b) = -1, PETSC_SUCCESS)
    642:   #define PetscLogEventGetName(a, b)        ((void)(a), *(b) = NULL, PETSC_SUCCESS)
    643:   #define PetscLogEventGetPerfInfo(a, b, c) ((void)(a), (void)(b), *(c) = (const PetscEventPerfInfo){0}, PETSC_SUCCESS)

    645:   #define PetscLogEventSetDof(a, b, c)   ((void)(a), (void)(b), (void)(c), PETSC_SUCCESS)
    646:   #define PetscLogEventSetError(a, b, c) ((void)(a), (void)(b), (void)(c), PETSC_SUCCESS)
    647:   #define PetscLogEventsPause()          PETSC_SUCCESS
    648:   #define PetscLogEventsResume()         PETSC_SUCCESS

    650:   #define PetscLogClassGetClassId(a, b) (*(b) = -1, PETSC_SUCCESS)
    651:   #define PetscLogClassIdGetName(a, b)  (*(b) = NULL, PETSC_SUCCESS)

    653:   #define PetscLogObjectCreate(h)        ((void)(h), PETSC_SUCCESS)
    654:   #define PetscLogObjectDestroy(h)       ((void)(h), PETSC_SUCCESS)
    655:   #define PetscLogObjectState(h, c, ...) ((void)(h), (void)(c), PETSC_SUCCESS)

    657:   #define PetscLogDefaultBegin()                   PETSC_SUCCESS
    658:   #define PetscLogNestedBegin()                    PETSC_SUCCESS
    659:   #define PetscLogTraceBegin(file)                 ((void)(file), PETSC_SUCCESS)
    660:   #define PetscLogMPEBegin()                       PETSC_SUCCESS
    661:   #define PetscLogPerfstubsBegin()                 PETSC_SUCCESS
    662:   #define PetscLogLegacyCallbacksBegin(a, b, c, d) ((void)(a), (void)(b), (void)(c), (void)(d), PETSC_SUCCESS)
    663:   #define PetscLogActions(a)                       ((void)(a), PETSC_SUCCESS)
    664:   #define PetscLogObjects(a)                       ((void)(a), PETSC_SUCCESS)
    665:   #define PetscLogSetThreshold(a, b)               ((void)(a), (void)(b), PETSC_SUCCESS)

    667:   #define PetscLogIsActive(flag) (*(flag) = PETSC_FALSE, PETSC_SUCCESS)

    669:   #define PetscLogView(viewer)      ((void)(viewer), PETSC_SUCCESS)
    670:   #define PetscLogViewFromOptions() PETSC_SUCCESS
    671:   #define PetscLogDump(c)           ((void)(c), PETSC_SUCCESS)
    672:   #define PetscLogMPEDump(c)        ((void)(c), PETSC_SUCCESS)

    674:   #define PetscLogEventSync(e, comm)                            ((void)(e), (void)(comm), PETSC_SUCCESS)
    675:   #define PetscLogEventBegin(e, o1, o2, o3, o4)                 ((void)(e), (void)(o1), (void)(o2), (void)(o3), PETSC_SUCCESS)
    676:   #define PetscLogEventEnd(e, o1, o2, o3, o4)                   ((void)(e), (void)(o1), (void)(o2), (void)(o3), PETSC_SUCCESS)

    678:   /* If PETSC_USE_LOG is NOT defined, these still need to be! */
    679:   #define MPI_Startall_irecv(count, datatype, number, requests) ((number) && MPI_Startall(number, requests))
    680:   #define MPI_Startall_isend(count, datatype, number, requests) ((number) && MPI_Startall(number, requests))
    681:   #define MPI_Start_isend(count, datatype, requests)            MPI_Start(requests)

    683: #endif /* PETSC_USE_LOG */

    685: #define PetscPreLoadBegin(flag, name) \
    686:   do { \
    687:     PetscBool     PetscPreLoading = flag; \
    688:     int           PetscPreLoadMax, PetscPreLoadIt; \
    689:     PetscLogStage _stageNum; \
    690:     PetscCall(PetscOptionsGetBool(NULL, NULL, "-preload", &PetscPreLoading, NULL)); \
    691:     PetscPreLoadMax     = (int)(PetscPreLoading); \
    692:     PetscPreLoadingUsed = PetscPreLoading ? PETSC_TRUE : PetscPreLoadingUsed; \
    693:     PetscCall(PetscLogStageGetId(name, &_stageNum)); \
    694:     for (PetscPreLoadIt = (_stageNum == -1) ? 0 : PetscPreLoadMax; PetscPreLoadIt <= PetscPreLoadMax; PetscPreLoadIt++) { \
    695:       PetscPreLoadingOn = (PetscBool)(PetscPreLoadIt < PetscPreLoadMax); \
    696:       PetscCall(PetscBarrier(NULL)); \
    697:       if (_stageNum == -1) PetscCall(PetscLogStageRegister(name, &_stageNum)); \
    698:       PetscCall(PetscLogStageSetActive(_stageNum, (PetscBool)(PetscPreLoadIt == PetscPreLoadMax))); \
    699:       PetscCall(PetscLogStagePush(_stageNum))

    701: #define PetscPreLoadEnd() \
    702:   PetscCall(PetscLogStagePop()); \
    703:   } \
    704:   } \
    705:   while (0)

    707: #define PetscPreLoadStage(name) \
    708:   do { \
    709:     PetscCall(PetscLogStagePop()); \
    710:     PetscCall(PetscLogStageGetId(name, &_stageNum)); \
    711:     if (_stageNum == -1) PetscCall(PetscLogStageRegister(name, &_stageNum)); \
    712:     PetscCall(PetscLogStageSetActive(_stageNum, (PetscBool)(!PetscPreLoadMax || PetscPreLoadIt))); \
    713:     PetscCall(PetscLogStagePush(_stageNum)); \
    714:   } while (0)

    716: /* some vars for logging */
    717: PETSC_EXTERN PetscBool PetscPreLoadingUsed; /* true if we are or have done preloading */
    718: PETSC_EXTERN PetscBool PetscPreLoadingOn;   /* true if we are currently in a preloading calculation */

    720: #if defined(PETSC_USE_LOG) && defined(PETSC_HAVE_DEVICE)

    722: PETSC_EXTERN PetscErrorCode PetscLogGpuTime(void);
    723: PETSC_EXTERN PetscErrorCode PetscLogGpuTimeBegin(void);
    724: PETSC_EXTERN PetscErrorCode PetscLogGpuTimeEnd(void);

    726: /*@
    727:    PetscLogGpuFlops - Log how many flops are performed in a calculation on the device

    729:    Input Parameter:
    730: .  flops - the number of flops

    732:    Level: intermediate

    734:    Notes:
    735:    To limit the chance of integer overflow when multiplying by a constant, represent the constant as a double,
    736:    not an integer. Use `PetscLogFlops`(4.0*n) not `PetscLogFlops`(4*n)

    738:    The values are also added to the total flop count for the MPI rank that is set with `PetscLogFlops()`; hence the number of flops
    739:    just on the CPU would be the value from set from `PetscLogFlops()` minus the value set from `PetscLogGpuFlops()`

    741:    Developer Note:
    742:    Currently Fortran stub generator cannot run through files in include

    744: .seealso: [](ch_profiling), `PetscLogView()`, `PetscLogFlops()`, `PetscLogGpuTimeBegin()`, `PetscLogGpuTimeEnd()`
    745: @*/
    746: static inline PetscErrorCode PetscLogGpuFlops(PetscLogDouble n)
    747: {
    748:   PetscAssert(n >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Cannot log negative flops");
    749:   PetscCall(PetscAddLogDouble(&petsc_TotalFlops, &petsc_TotalFlops_th, PETSC_FLOPS_PER_OP * n));
    750:   PetscCall(PetscAddLogDouble(&petsc_gflops, &petsc_gflops_th, PETSC_FLOPS_PER_OP * n));
    751:   return PETSC_SUCCESS;
    752: }

    754: static inline PetscErrorCode PetscLogGpuTimeAdd(PetscLogDouble t)
    755: {
    756:   return PetscAddLogDouble(&petsc_gtime, &petsc_gtime_th, t);
    757: }

    759: static inline PetscErrorCode PetscLogCpuToGpu(PetscLogDouble size)
    760: {
    761:   return PetscAddLogDoubleCnt(&petsc_ctog_ct, &petsc_ctog_sz, &petsc_ctog_ct_th, &petsc_ctog_sz_th, size);
    762: }

    764: static inline PetscErrorCode PetscLogGpuToCpu(PetscLogDouble size)
    765: {
    766:   return PetscAddLogDoubleCnt(&petsc_gtoc_ct, &petsc_gtoc_sz, &petsc_gtoc_ct_th, &petsc_gtoc_sz_th, size);
    767: }

    769: static inline PetscErrorCode PetscLogCpuToGpuScalar(PetscLogDouble size)
    770: {
    771:   return PetscAddLogDoubleCnt(&petsc_ctog_ct_scalar, &petsc_ctog_sz_scalar, &petsc_ctog_ct_scalar_th, &petsc_ctog_sz_scalar_th, size);
    772: }

    774: static inline PetscErrorCode PetscLogGpuToCpuScalar(PetscLogDouble size)
    775: {
    776:   return PetscAddLogDoubleCnt(&petsc_gtoc_ct_scalar, &petsc_gtoc_sz_scalar, &petsc_gtoc_ct_scalar_th, &petsc_gtoc_sz_scalar_th, size);
    777: }
    778: #else

    780:   #define PetscLogCpuToGpu(a)       PETSC_SUCCESS
    781:   #define PetscLogGpuToCpu(a)       PETSC_SUCCESS
    782:   #define PetscLogCpuToGpuScalar(a) PETSC_SUCCESS
    783:   #define PetscLogGpuToCpuScalar(a) PETSC_SUCCESS
    784:   #define PetscLogGpuFlops(a)       PETSC_SUCCESS
    785:   #define PetscLogGpuTime()         PETSC_SUCCESS
    786:   #define PetscLogGpuTimeAdd(a)     PETSC_SUCCESS
    787:   #define PetscLogGpuTimeBegin()    PETSC_SUCCESS
    788:   #define PetscLogGpuTimeEnd()      PETSC_SUCCESS

    790: #endif /* PETSC_USE_LOG && PETSC_HAVE_DEVICE */

    792: /* remove TLS defines */
    793: #undef PETSC_EXTERN_TLS
    794: #undef PETSC_TLS

    796: #include <petsclogdeprecated.h>