1 #ifndef PETSCLOGTYPES_H 2 #define PETSCLOGTYPES_H 3 #include <petscsystypes.h> 4 5 /* SUBMANSEC = Profiling */ 6 7 /*S 8 PetscEventPerfInfo - statistics on how many times the event is used, how much time it takes, etc. 9 10 Level: advanced 11 12 Note: 13 This is the data structure that describes profiling statsitics collected for an event from 14 the default log handler (`PetscLogDefaultBegin()`) using `PetscLogEventGetPerfInfo()`. 15 16 .seealso(): [](ch_profiling) 17 S*/ 18 typedef struct { 19 int id; /* The integer identifying this event / stage */ 20 PetscBool active; /* Deprecated */ 21 PetscBool visible; /* The flag to print info in summary */ 22 int depth; /* The nesting depth of the event call */ 23 int count; /* The number of times this event was executed */ 24 PetscLogDouble flops; /* The flops used in this event */ 25 PetscLogDouble flops2; /* The square of flops used in this event */ 26 PetscLogDouble flopsTmp; /* The accumulator for flops used in this event */ 27 PetscLogDouble time; /* The time taken for this event */ 28 PetscLogDouble time2; /* The square of time taken for this event */ 29 PetscLogDouble timeTmp; /* The accumulator for time taken for this event */ 30 PetscLogDouble syncTime; /* The synchronization barrier time */ 31 PetscLogDouble dof[8]; /* The number of degrees of freedom associated with this event */ 32 PetscLogDouble errors[8]; /* The errors (user-defined) associated with this event */ 33 PetscLogDouble numMessages; /* The number of messages in this event */ 34 PetscLogDouble messageLength; /* The total message lengths in this event */ 35 PetscLogDouble numReductions; /* The number of reductions in this event */ 36 PetscLogDouble memIncrease; /* How much the resident memory has increased in this event */ 37 PetscLogDouble mallocIncrease; /* How much the maximum malloced space has increased in this event */ 38 PetscLogDouble mallocSpace; /* How much the space was malloced and kept during this event */ 39 PetscLogDouble mallocIncreaseEvent; /* Maximum of the high water mark with in event minus memory available at the end of the event */ 40 #if defined(PETSC_HAVE_DEVICE) 41 PetscLogDouble CpuToGpuCount; /* The total number of CPU to GPU copies */ 42 PetscLogDouble GpuToCpuCount; /* The total number of GPU to CPU copies */ 43 PetscLogDouble CpuToGpuSize; /* The total size of CPU to GPU copies */ 44 PetscLogDouble GpuToCpuSize; /* The total size of GPU to CPU copies */ 45 PetscLogDouble GpuFlops; /* The flops done on a GPU in this event */ 46 PetscLogDouble GpuTime; /* The time spent on a GPU in this event */ 47 #endif 48 } PetscEventPerfInfo; 49 50 typedef struct _n_PetscIntStack *PetscIntStack; 51 52 /*MC 53 PetscLogEvent - id used to identify PETSc or user events which timed portions (blocks of executable) 54 code. 55 56 Level: intermediate 57 58 .seealso: [](ch_profiling), `PetscLogEventRegister()`, `PetscLogEventBegin()`, `PetscLogEventEnd()`, `PetscLogStage` 59 M*/ 60 typedef int PetscLogEvent; 61 62 /*MC 63 PetscLogStage - id used to identify user stages (phases, sections) of runs - for logging 64 65 Level: intermediate 66 67 .seealso: [](ch_profiling), `PetscLogStageRegister()`, `PetscLogStagePush()`, `PetscLogStagePop()`, `PetscLogEvent` 68 M*/ 69 typedef int PetscLogStage; 70 71 /*MC 72 PetscLogClass - id used to identify classes for logging purposes only. It 73 is not equal to its `PetscClassId`, which is the identifier used for other 74 purposes. 75 76 Level: developer 77 78 .seealso: [](ch_profiling), `PetscLogStateClassRegister()` 79 M*/ 80 typedef int PetscLogClass; 81 82 typedef struct _n_PetscLogRegistry *PetscLogRegistry; 83 84 /*S 85 PetscLogState - Interface for the shared state information used by log handlers. It holds 86 a registry of events (`PetscLogStateEventRegister()`), stages (`PetscLogStateStageRegister()`), and 87 classes (`PetscLogStateClassRegister()`). It keeps track of when the user has activated 88 events (`PetscLogStateEventSetActive()`) and stages (`PetscLogStateStageSetActive()`). It 89 also keeps a stack of running stages (`PetscLogStateStagePush()`, `PetscLogStateStagePop()`). 90 91 Level: developer 92 93 Note: 94 The struct defining `PetscLogState` is in a public header so that `PetscLogEventBegin()`, 95 `PetscLogEventEnd()`, `PetscLogObjectCreate()`, and `PetscLogObjectDestroy()` can be defined 96 as macros rather than function calls, but users are discouraged from directly accessing 97 the struct's fields, which are subject to change. 98 99 .seealso: [](ch_profiling), `PetscLogStateCreate()`, `PetscLogStateDestroy()` 100 S*/ 101 typedef struct _n_PetscLogState *PetscLogState; 102 struct _n_PetscLogState { 103 PetscLogRegistry registry; 104 PetscBT active; 105 PetscIntStack stage_stack; 106 int current_stage; 107 int bt_num_stages; 108 int bt_num_events; 109 int refct; 110 }; 111 112 /*S 113 PetscLogEventInfo - A registry entry about a logging event for `PetscLogState`. 114 115 Level: developer 116 117 .seealso: [](ch_profiling), `PetscLogEvent`, `PetscLogState`, `PetscLogStateEventGetInfo()` 118 S*/ 119 typedef struct { 120 char *name; /* The name of this event */ 121 PetscClassId classid; /* The class the event is associated with */ 122 PetscBool collective; /* Flag this event as collective */ 123 } PetscLogEventInfo; 124 125 /*S 126 PetscLogClassInfo - A registry entry about a class for `PetscLogState`. 127 128 Level: developer 129 130 .seealso: [](ch_profiling), `PetscLogClass`, `PetscLogState`, `PetscLogStateStageGetInfo()` 131 S*/ 132 typedef struct { 133 char *name; /* The class name */ 134 PetscClassId classid; /* The integer identifying this class */ 135 } PetscLogClassInfo; 136 137 /*S 138 PetscLogStageInfo - A registry entry about a class for `PetscLogState`. 139 140 Level: developer 141 142 .seealso: [](ch_profiling), `PetscLogStage`, `PetscLogState`, `PetscLogStateClassGetInfo()` 143 S*/ 144 typedef struct _PetscLogStageInfo { 145 char *name; /* The stage name */ 146 } PetscLogStageInfo; 147 148 #endif 149