3.0.1 (revision 9160da48)
|
Data types used in the definition records. More...
#include "otf2_compiler.h"
#include <otf2/OTF2_ErrorCodes.h>
#include <otf2/OTF2_GeneralDefinitions.h>
Go to the source code of this file.
Data types used in the definition records.
List of available system tree node domains.
List of possible definitions of type LocationGroup.
Enumerator | |
---|---|
OTF2_LOCATION_GROUP_TYPE_UNKNOWN |
A location group of unknown type. |
OTF2_LOCATION_GROUP_TYPE_PROCESS |
A process. Must contain at least one location of type OTF2_LOCATION_TYPE_CPU_THREAD, any number of locations of type OTF2_LOCATION_TYPE_METRIC, and no locations of type OTF2_LOCATION_TYPE_ACCELERATOR_STREAM. The |
OTF2_LOCATION_GROUP_TYPE_ACCELERATOR |
A group of accelerator locations which executed on the same device and have the same controlling location group. Must contain at least one location of type OTF2_LOCATION_TYPE_ACCELERATOR_STREAM, any number of locations of type OTF2_LOCATION_TYPE_METRIC, and may not no locations of type OTF2_LOCATION_TYPE_CPU_THREAD. The
|
List of possible definitions of type Location.
Enumerator | |
---|---|
OTF2_LOCATION_TYPE_UNKNOWN |
A location of unknown type. |
OTF2_LOCATION_TYPE_CPU_THREAD |
A CPU thread. |
OTF2_LOCATION_TYPE_ACCELERATOR_STREAM |
An activity queue on an accelerator device. The previous entry OTF2_LOCATION_TYPE_GPU is still available. |
OTF2_LOCATION_TYPE_GPU |
A GPU location. Alias for, and superseded by, OTF2_LOCATION_TYPE_ACCELERATOR_STREAM.
|
OTF2_LOCATION_TYPE_METRIC |
A metric only location e.g. an external device. |
enum OTF2_RegionRole_enum |
List of possible roles of a Region.
Enumerator | |
---|---|
OTF2_REGION_ROLE_UNKNOWN |
A region of unknown role. |
OTF2_REGION_ROLE_FUNCTION |
An entire function/subroutine. |
OTF2_REGION_ROLE_WRAPPER |
An API function wrapped by Score-P. |
OTF2_REGION_ROLE_LOOP |
A loop in the code. |
OTF2_REGION_ROLE_CODE |
An arbitrary section of code. |
OTF2_REGION_ROLE_PARALLEL |
E.g. OpenMP "parallel" construct (structured block) |
OTF2_REGION_ROLE_SECTIONS |
E.g. OpenMP "sections" construct. |
OTF2_REGION_ROLE_SECTION |
Individual "section" inside an OpenMP "sections" construct. |
OTF2_REGION_ROLE_WORKSHARE |
E.g. OpenMP "workshare" construct. |
OTF2_REGION_ROLE_SINGLE |
E.g. OpenMP "single" construct. |
OTF2_REGION_ROLE_SINGLE_SBLOCK |
E.g. OpenMP "single" construct (structured block) |
OTF2_REGION_ROLE_MASTER |
E.g. OpenMP "master" construct. |
OTF2_REGION_ROLE_CRITICAL |
E.g. OpenMP "critical" construct. |
OTF2_REGION_ROLE_CRITICAL_SBLOCK |
E.g. OpenMP "critical" construct (structured block) |
OTF2_REGION_ROLE_ATOMIC |
E.g. OpenMP "atomic" construct. |
OTF2_REGION_ROLE_BARRIER |
Explicit barrier. |
OTF2_REGION_ROLE_IMPLICIT_BARRIER |
Implicit barrier. |
OTF2_REGION_ROLE_FLUSH |
E.g. OpenMP "flush" construct. |
OTF2_REGION_ROLE_ORDERED |
E.g. OpenMP "ordered" construct. |
OTF2_REGION_ROLE_ORDERED_SBLOCK |
E.g. OpenMP "ordered" construct (structured block) |
OTF2_REGION_ROLE_TASK |
"task" construct (structured block) |
OTF2_REGION_ROLE_TASK_CREATE |
"task" construct (creation) |
OTF2_REGION_ROLE_TASK_WAIT |
"taskwait" construct |
OTF2_REGION_ROLE_COLL_ONE2ALL |
Collective 1:N communication operation. |
OTF2_REGION_ROLE_COLL_ALL2ONE |
Collective N:1 communication operation. |
OTF2_REGION_ROLE_COLL_ALL2ALL |
Collective N:N communication operation. |
OTF2_REGION_ROLE_COLL_OTHER |
Collective M:N communication operation. |
OTF2_REGION_ROLE_FILE_IO |
A data file I/O operation. |
OTF2_REGION_ROLE_POINT2POINT |
A point-to-point communication function. |
OTF2_REGION_ROLE_RMA |
A remote memory access communication operation. |
OTF2_REGION_ROLE_DATA_TRANSFER |
A data transfer operation in memory. |
OTF2_REGION_ROLE_ARTIFICIAL |
An artificial region, mostly used by the monitor software.
|
OTF2_REGION_ROLE_THREAD_CREATE |
A function which creates one thread.
|
OTF2_REGION_ROLE_THREAD_WAIT |
A function which waits for the completion of one thread.
|
OTF2_REGION_ROLE_TASK_UNTIED |
"untied task" construct (structured block)
|
OTF2_REGION_ROLE_ALLOCATE |
A function which allocates memory.
|
OTF2_REGION_ROLE_DEALLOCATE |
A function which deallocates memory.
|
OTF2_REGION_ROLE_REALLOCATE |
A function which changes a previous memory allocation to either increase or decrease the amount.
|
OTF2_REGION_ROLE_FILE_IO_METADATA |
A metadata-only file I/O operation (e.g., IoSeek, IoChangeStatusFlags event).
|
enum OTF2_RegionFlag_enum |
List of possible flags to specify special characteristics of a Region.
This enumeration is treated as a bit field; that is, a set of flags.
enum OTF2_GroupType_enum |
List of possible types of a Group.
Enumerator | |
---|---|
OTF2_GROUP_TYPE_UNKNOWN |
Group of unknown type. |
OTF2_GROUP_TYPE_LOCATIONS |
Group of locations. |
OTF2_GROUP_TYPE_REGIONS |
Group of regions. |
OTF2_GROUP_TYPE_METRIC |
Group of metrics. |
OTF2_GROUP_TYPE_COMM_LOCATIONS |
List of locations which participated in the paradigm specified by the group definition. For example: In case of MPI, the size of this group should match the size of MPI_COMM_WORLD. Each entry in the list is a Location reference, where the index of the entry is equal to the rank in MPI_COMM_WORLD (i.e., rank i corresponds to location members[i]). Also, if this definition is present and all location groups are of type OTF2_LOCATION_GROUP_TYPE_PROCESS, the location group IDs of locations with type OTF2_LOCATION_TYPE_CPU_THREAD should match the MPI rank. This group needs to be defined, before any group of type OTF2_GROUP_TYPE_COMM_GROUP and the same paradigm. Note: This does not makes sense in local definitions. |
OTF2_GROUP_TYPE_COMM_GROUP |
A sub-group of the corresponding group definition with type OTF2_GROUP_TYPE_COMM_LOCATIONS and the same paradigm. The sub-group is formed by listing the indexes of the OTF2_GROUP_TYPE_COMM_LOCATIONS group. |
OTF2_GROUP_TYPE_COMM_SELF |
Special group type to efficiently handle self-like communicators (i.e., MPI_COMM_SELF and friends). At most one definition of this type is allowed to exist per paradigm. |
enum OTF2_GroupFlag_enum |
List of possible flags to specify special characteristics of a Group.
This enumeration is treated as a bit field; that is, a set of flags.
Enumerator | |
---|---|
OTF2_GROUP_FLAG_NONE |
A group without special characterization. |
OTF2_GROUP_FLAG_GLOBAL_MEMBERS |
No translation of ranks in event records needs to be done when a group of type OTF2_GROUP_TYPE_COMM_GROUP has this flag. I.e., the ranks are indexes into the OTF2_GROUP_TYPE_COMM_LOCATIONS group. |
enum OTF2_Base_enum |
MetricMember base types.
Enumerator | |
---|---|
OTF2_BASE_BINARY |
Binary base. |
OTF2_BASE_DECIMAL |
Decimal base. |
List of possible occurrences of a MetricClass.
enum OTF2_MetricType_enum |
List of possible types of a MetricMember.
Information about whether the metric value is accumulated, absolute, or relative. Used for the lower half-byte of OTF2_MetricMode.
Enumerator | |
---|---|
OTF2_METRIC_VALUE_ACCUMULATED |
Accumulated metric is monotonously increasing (i.e., PAPI counter for number of executed floating point operations). |
OTF2_METRIC_VALUE_ABSOLUTE |
Absolute metric (i.e., temperature, rate, mean value, etc.). |
OTF2_METRIC_VALUE_RELATIVE |
Relative metric. |
OTF2_METRIC_VALUE_MASK |
This mask can be used to get lower half-byte in OTF2_MetricMode that is used to indicate metric value property. xxxx1111. |
Determines when the values have been collected or for which interval of time they are valid. Used for the upper half-byte of OTF2_MetricMode.
Enumerator | |
---|---|
OTF2_METRIC_TIMING_START |
Metric value belongs to the time interval since the beginning of the measurement. |
OTF2_METRIC_TIMING_POINT |
Metric value is only valid at a point in time but not necessarily for any interval of time. |
OTF2_METRIC_TIMING_LAST |
Metric value is related to the time interval since the last counter sample of the same metric, i.e. the immediate past. |
OTF2_METRIC_TIMING_NEXT |
Metric value is valid from now until the next counter sample, i.e. the future right ahead. |
OTF2_METRIC_TIMING_MASK |
This mask can be used to get the upper half-byte in OTF2_MetricMode that is used to indicate metric timing information. 1111xxxx. |
enum OTF2_MetricMode_enum |
The OTF2_MetricMode is a combination of OTF2_MetricValueProperty and OTF2_MetricTiming.
List of possible scopes of a MetricInstance.
List of possible kinds a MetricClass can be recorded by.
Enumerator | |
---|---|
OTF2_RECORDER_KIND_UNKNOWN |
No specific kind of recorder. |
OTF2_RECORDER_KIND_ABSTRACT |
The metric class will only be recorded via a MetricInstance definitions. |
OTF2_RECORDER_KIND_CPU |
This metric class will only be recorded by locations of type OTF2_LOCATION_TYPE_CPU_THREAD. |
OTF2_RECORDER_KIND_GPU |
This metric class will only be recorded by locations of type OTF2_LOCATION_TYPE_GPU. |
List of possible for definitions of type Parameter.
Periodicity types of a CartDimension.
Enumerator | |
---|---|
OTF2_CART_PERIODIC_FALSE |
Dimension is not periodic. |
OTF2_CART_PERIODIC_TRUE |
Dimension is periodic. |
List of possible modes of an InterruptGenerator.
Enumerator | |
---|---|
OTF2_INTERRUPT_GENERATOR_MODE_TIME |
Denotes that the interrupts generated are time based. |
OTF2_INTERRUPT_GENERATOR_MODE_COUNT |
Denotes that the interrupts generated are count based. |
List of I/O paradigm classes.
Enumerator | |
---|---|
OTF2_IO_PARADIGM_CLASS_SERIAL |
Serial. No I/O operations allowed with the OTF2_IO_OPERATION_FLAG_COLLECTIVE flag set and the Comm attribute of the IoHandle definition is always OTF2_UNDEFINED_COMM. |
OTF2_IO_PARADIGM_CLASS_PARALLEL |
Parallel. Collective I/O operations are allowed if the Comm attribute of the IoHandle definition is not OTF2_UNDEFINED_COMM. |
List of I/O paradigm flags.
This enumeration is treated as a bit field; that is, a set of flags.
Enumerator | |
---|---|
OTF2_IO_PARADIGM_FLAG_NONE |
No flags set. |
OTF2_IO_PARADIGM_FLAG_OS |
This I/O paradigm denotes an interface to the operating system. Thus, no further I/O paradigms below can exist. |
List of I/O paradigm properties.
Enumerator | |
---|---|
OTF2_IO_PARADIGM_PROPERTY_VERSION |
Version of the implementation. Optional for all I/O paradigms. Type: String |
List of possible flags to specify special characteristics of an IoHandle definition.
This enumeration is treated as a bit field; that is, a set of flags.
Enumerator | |
---|---|
OTF2_IO_HANDLE_FLAG_NONE |
No flags set. |
OTF2_IO_HANDLE_FLAG_PRE_CREATED |
This I/O handle was already created by the system. No IoCreateHandle event occurs with the handle to operate on it, thus it is already active without such event. The IoHandle definition should be supplemented with an IoPreCreatedHandleState definition to state the access mode and status flags for this pre-created IoHandle. |
OTF2_IO_HANDLE_FLAG_ALL_PROXY |
This I/O handle is a proxy to a group of I/O paradigm specific handles. The referenced IoFile definition of such an IoHandle should be OTF2_UNDEFINED_IO_FILE. No IoCreateHandle, IoDestroyHandle, IoDuplicateHandle, IoChangeStatusFlags events are allowed with such an IoHandle. Examples are, a call to |
Determines how the resulting I/O handle can be accessed with subsequent I/O operations.
Enumerator | |
---|---|
OTF2_IO_ACCESS_MODE_READ_ONLY |
Read-only access.
|
OTF2_IO_ACCESS_MODE_WRITE_ONLY |
Write-only access.
|
OTF2_IO_ACCESS_MODE_READ_WRITE |
Read-write access.
|
OTF2_IO_ACCESS_MODE_EXECUTE_ONLY |
Execute only.
|
OTF2_IO_ACCESS_MODE_SEARCH_ONLY |
Search only.
|
Special characteristics associated to an IoHandle at the time the handle was created with the IoCreateHandle event or later changed with the IoChangeStatusFlags event.
This enumeration is treated as a bit field; that is, a set of flags.
Enumerator | |
---|---|
OTF2_IO_STATUS_FLAG_NONE |
No flag is set. |
OTF2_IO_STATUS_FLAG_CLOSE_ON_EXEC |
Enable close-on-exec flag.
|
OTF2_IO_STATUS_FLAG_APPEND |
I/O write operations are automatically performed at the end of the file.
|
OTF2_IO_STATUS_FLAG_NON_BLOCKING |
I/O operations (including the creation) will fail if they would block the issuing process.
|
OTF2_IO_STATUS_FLAG_ASYNC |
Enable signal-driven I/O.
|
OTF2_IO_STATUS_FLAG_SYNC |
Write operations on the file will complete according to the requirements of synchronized I/O file integrity completion (data and metadata).
|
OTF2_IO_STATUS_FLAG_DATA_SYNC |
Write operations on the file will complete according to the requirements of synchronized I/O data integrity completion.
|
OTF2_IO_STATUS_FLAG_AVOID_CACHING |
Instruct I/O operations to reduce caching effects.
|
OTF2_IO_STATUS_FLAG_NO_ACCESS_TIME |
Read access to a file won't update its last access time.
|
OTF2_IO_STATUS_FLAG_DELETE_ON_CLOSE |
Delete the file when closing the IoHandle. Though the IoDestroyHandle event does not imply the deletion. A separate IoDeleteFile event must be issued for this.
|
enum OTF2_CommFlag_enum |
Special characteristics associated to an Comm or InterComm definition.
This enumeration is treated as a bit field; that is, a set of flags.
Enumerator | |
---|---|
OTF2_COMM_FLAG_NONE |
No flag is set. |
OTF2_COMM_FLAG_CREATE_DESTROY_EVENTS |
If set, the corresponding definition does have create/destroy events. |
enum OTF2_RmaWinFlag_enum |