OTF2_Definitions.h

Go to the documentation of this file.

/*
 * This file is part of the Score-P software (http://www.score-p.org)
 *
 * Copyright (c) 2009-2012,
 * RWTH Aachen University, Germany
 *
 * Copyright (c) 2009-2012,
 * Gesellschaft fuer numerische Simulation mbH Braunschweig, Germany
 *
 * Copyright (c) 2009-2012, 2021, 2024,
 * Technische Universitaet Dresden, Germany
 *
 * Copyright (c) 2009-2012,
 * University of Oregon, Eugene, USA
 *
 * Copyright (c) 2009-2012, 2024,
 * Forschungszentrum Juelich GmbH, Germany
 *
 * Copyright (c) 2009-2012,
 * German Research School for Simulation Sciences GmbH, Juelich/Aachen, Germany
 *
 * Copyright (c) 2009-2012,
 * Technische Universitaet Muenchen, Germany
 *
 * This software may be modified and distributed under the terms of
 * a BSD-style license.  See the COPYING file in the package base
 * directory for details.
 *
 */


#ifndef OTF2_DEFINITIONS_H
#define OTF2_DEFINITIONS_H


#include "otf2_compiler.h"


#include <otf2/OTF2_ErrorCodes.h>


#include <otf2/OTF2_GeneralDefinitions.h>


#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


typedef uint8_t OTF2_SystemTreeDomain;

enum OTF2_SystemTreeDomain_enum
{
    OTF2_SYSTEM_TREE_DOMAIN_MACHINE            = 0,

    OTF2_SYSTEM_TREE_DOMAIN_SHARED_MEMORY      = 1,

    OTF2_SYSTEM_TREE_DOMAIN_NUMA               = 2,

    OTF2_SYSTEM_TREE_DOMAIN_SOCKET             = 3,

    OTF2_SYSTEM_TREE_DOMAIN_CACHE              = 4,

    OTF2_SYSTEM_TREE_DOMAIN_CORE               = 5,

    OTF2_SYSTEM_TREE_DOMAIN_PU                 = 6,

    OTF2_SYSTEM_TREE_DOMAIN_ACCELERATOR_DEVICE = 7,

    OTF2_SYSTEM_TREE_DOMAIN_NETWORKING_DEVICE  = 8
};


typedef uint8_t OTF2_LocationGroupType;

enum OTF2_LocationGroupType_enum
{
    OTF2_LOCATION_GROUP_TYPE_UNKNOWN     = 0,

    OTF2_LOCATION_GROUP_TYPE_PROCESS     = 1,

    OTF2_LOCATION_GROUP_TYPE_ACCELERATOR = 2
};


typedef uint8_t OTF2_LocationType;

enum OTF2_LocationType_enum
{
    OTF2_LOCATION_TYPE_UNKNOWN                 = 0,

    OTF2_LOCATION_TYPE_CPU_THREAD              = 1,

    OTF2_LOCATION_TYPE_ACCELERATOR_STREAM      = 2,
    OTF2_LOCATION_TYPE_GPU __otf2_deprecated__ = 2,

    OTF2_LOCATION_TYPE_METRIC                  = 3
};


typedef uint8_t OTF2_RegionRole;

enum OTF2_RegionRole_enum
{
    OTF2_REGION_ROLE_UNKNOWN          = 0,

    OTF2_REGION_ROLE_FUNCTION         = 1,

    OTF2_REGION_ROLE_WRAPPER          = 2,

    OTF2_REGION_ROLE_LOOP             = 3,

    OTF2_REGION_ROLE_CODE             = 4,

    OTF2_REGION_ROLE_PARALLEL         = 5,

    OTF2_REGION_ROLE_SECTIONS         = 6,

    OTF2_REGION_ROLE_SECTION          = 7,

    OTF2_REGION_ROLE_WORKSHARE        = 8,

    OTF2_REGION_ROLE_SINGLE           = 9,

    OTF2_REGION_ROLE_SINGLE_SBLOCK    = 10,

    OTF2_REGION_ROLE_MASTER           = 11,

    OTF2_REGION_ROLE_CRITICAL         = 12,

    OTF2_REGION_ROLE_CRITICAL_SBLOCK  = 13,

    OTF2_REGION_ROLE_ATOMIC           = 14,

    OTF2_REGION_ROLE_BARRIER          = 15,

    OTF2_REGION_ROLE_IMPLICIT_BARRIER = 16,

    OTF2_REGION_ROLE_FLUSH            = 17,

    OTF2_REGION_ROLE_ORDERED          = 18,

    OTF2_REGION_ROLE_ORDERED_SBLOCK   = 19,

    OTF2_REGION_ROLE_TASK             = 20,

    OTF2_REGION_ROLE_TASK_CREATE      = 21,

    OTF2_REGION_ROLE_TASK_WAIT        = 22,

    OTF2_REGION_ROLE_COLL_ONE2ALL     = 23,

    OTF2_REGION_ROLE_COLL_ALL2ONE     = 24,

    OTF2_REGION_ROLE_COLL_ALL2ALL     = 25,

    OTF2_REGION_ROLE_COLL_OTHER       = 26,

    OTF2_REGION_ROLE_FILE_IO          = 27,

    OTF2_REGION_ROLE_POINT2POINT      = 28,

    OTF2_REGION_ROLE_RMA              = 29,

    OTF2_REGION_ROLE_DATA_TRANSFER    = 30,

    OTF2_REGION_ROLE_ARTIFICIAL       = 31,

    OTF2_REGION_ROLE_THREAD_CREATE    = 32,

    OTF2_REGION_ROLE_THREAD_WAIT      = 33,

    OTF2_REGION_ROLE_TASK_UNTIED      = 34,

    OTF2_REGION_ROLE_ALLOCATE         = 35,

    OTF2_REGION_ROLE_DEALLOCATE       = 36,

    OTF2_REGION_ROLE_REALLOCATE       = 37,

    OTF2_REGION_ROLE_FILE_IO_METADATA = 38,

    OTF2_REGION_ROLE_CANCEL           = 39,

    OTF2_REGION_ROLE_KERNEL           = 40
};


typedef uint32_t OTF2_RegionFlag;

enum OTF2_RegionFlag_enum
{
    OTF2_REGION_FLAG_NONE    = 0,

    OTF2_REGION_FLAG_DYNAMIC = ( 1 << 0 ),

    OTF2_REGION_FLAG_PHASE   = ( 1 << 1 )
};


typedef uint8_t OTF2_GroupType;

enum OTF2_GroupType_enum
{
    OTF2_GROUP_TYPE_UNKNOWN              = 0,

    OTF2_GROUP_TYPE_LOCATIONS            = 1,

    OTF2_GROUP_TYPE_REGIONS              = 2,

    OTF2_GROUP_TYPE_METRIC               = 3,

    OTF2_GROUP_TYPE_COMM_LOCATIONS       = 4,

    OTF2_GROUP_TYPE_COMM_GROUP           = 5,

    OTF2_GROUP_TYPE_COMM_SELF            = 6,

    OTF2_GROUP_TYPE_COMM_LOCATION_GROUPS = 7
};


typedef uint32_t OTF2_GroupFlag;

enum OTF2_GroupFlag_enum
{
    OTF2_GROUP_FLAG_NONE           = 0,

    OTF2_GROUP_FLAG_GLOBAL_MEMBERS = ( 1 << 0 )
};


typedef uint8_t OTF2_Base;

enum OTF2_Base_enum
{
    OTF2_BASE_BINARY  = 0,

    OTF2_BASE_DECIMAL = 1
};


typedef uint8_t OTF2_MetricOccurrence;

enum OTF2_MetricOccurrence_enum
{
    OTF2_METRIC_SYNCHRONOUS_STRICT = 0,

    OTF2_METRIC_SYNCHRONOUS        = 1,

    OTF2_METRIC_ASYNCHRONOUS       = 2
};


typedef uint8_t OTF2_MetricType;

enum OTF2_MetricType_enum
{
    OTF2_METRIC_TYPE_OTHER  = 0,

    OTF2_METRIC_TYPE_PAPI   = 1,

    OTF2_METRIC_TYPE_RUSAGE = 2,

    OTF2_METRIC_TYPE_USER   = 3
};


typedef uint8_t OTF2_MetricValueProperty;

enum OTF2_MetricValueProperty_enum
{
    OTF2_METRIC_VALUE_ACCUMULATED = 0,

    OTF2_METRIC_VALUE_ABSOLUTE    = 1,

    OTF2_METRIC_VALUE_RELATIVE    = 2,

    OTF2_METRIC_VALUE_MASK        = 15
};


typedef uint8_t OTF2_MetricTiming;

enum OTF2_MetricTiming_enum
{
    OTF2_METRIC_TIMING_START = 0,

    OTF2_METRIC_TIMING_POINT = 1 << 4,

    OTF2_METRIC_TIMING_LAST  = 2 << 4,

    OTF2_METRIC_TIMING_NEXT  = 3 << 4,

    OTF2_METRIC_TIMING_MASK  = 240
};


typedef uint8_t OTF2_MetricMode;

enum OTF2_MetricMode_enum
{
    OTF2_METRIC_ACCUMULATED_START = OTF2_METRIC_VALUE_ACCUMULATED | OTF2_METRIC_TIMING_START,

    OTF2_METRIC_ACCUMULATED_POINT = OTF2_METRIC_VALUE_ACCUMULATED | OTF2_METRIC_TIMING_POINT,

    OTF2_METRIC_ACCUMULATED_LAST  = OTF2_METRIC_VALUE_ACCUMULATED | OTF2_METRIC_TIMING_LAST,

    OTF2_METRIC_ACCUMULATED_NEXT  = OTF2_METRIC_VALUE_ACCUMULATED | OTF2_METRIC_TIMING_NEXT,

    OTF2_METRIC_ABSOLUTE_POINT    = OTF2_METRIC_VALUE_ABSOLUTE | OTF2_METRIC_TIMING_POINT,

    OTF2_METRIC_ABSOLUTE_LAST     = OTF2_METRIC_VALUE_ABSOLUTE | OTF2_METRIC_TIMING_LAST,

    OTF2_METRIC_ABSOLUTE_NEXT     = OTF2_METRIC_VALUE_ABSOLUTE | OTF2_METRIC_TIMING_NEXT,

    OTF2_METRIC_RELATIVE_POINT    = OTF2_METRIC_VALUE_RELATIVE | OTF2_METRIC_TIMING_POINT,

    OTF2_METRIC_RELATIVE_LAST     = OTF2_METRIC_VALUE_RELATIVE | OTF2_METRIC_TIMING_LAST,

    OTF2_METRIC_RELATIVE_NEXT     = OTF2_METRIC_VALUE_RELATIVE | OTF2_METRIC_TIMING_NEXT
};


typedef uint8_t OTF2_MetricScope;

enum OTF2_MetricScope_enum
{
    OTF2_SCOPE_LOCATION         = 0,

    OTF2_SCOPE_LOCATION_GROUP   = 1,

    OTF2_SCOPE_SYSTEM_TREE_NODE = 2,

    OTF2_SCOPE_GROUP            = 3
};


typedef uint8_t OTF2_RecorderKind;

enum OTF2_RecorderKind_enum
{
    OTF2_RECORDER_KIND_UNKNOWN  = 0,

    OTF2_RECORDER_KIND_ABSTRACT = 1,

    OTF2_RECORDER_KIND_CPU      = 2,

    OTF2_RECORDER_KIND_GPU      = 3
};


typedef uint8_t OTF2_ParameterType;

enum OTF2_ParameterType_enum
{
    OTF2_PARAMETER_TYPE_STRING = 0,

    OTF2_PARAMETER_TYPE_INT64  = 1,

    OTF2_PARAMETER_TYPE_UINT64 = 2
};


typedef uint8_t OTF2_CartPeriodicity;

enum OTF2_CartPeriodicity_enum
{
    OTF2_CART_PERIODIC_FALSE = 0,

    OTF2_CART_PERIODIC_TRUE  = 1
};


typedef uint8_t OTF2_InterruptGeneratorMode;

enum OTF2_InterruptGeneratorMode_enum
{
    OTF2_INTERRUPT_GENERATOR_MODE_TIME  = 0,

    OTF2_INTERRUPT_GENERATOR_MODE_COUNT = 1
};


typedef uint8_t OTF2_IoParadigmClass;

enum OTF2_IoParadigmClass_enum
{
    OTF2_IO_PARADIGM_CLASS_SERIAL   = 0,

    OTF2_IO_PARADIGM_CLASS_PARALLEL = 1
};


typedef uint32_t OTF2_IoParadigmFlag;

enum OTF2_IoParadigmFlag_enum
{
    OTF2_IO_PARADIGM_FLAG_NONE = 0,

    OTF2_IO_PARADIGM_FLAG_OS   = ( 1 << 0 )
};


typedef uint8_t OTF2_IoParadigmProperty;

enum OTF2_IoParadigmProperty_enum
{
    OTF2_IO_PARADIGM_PROPERTY_VERSION = 0
};


typedef uint32_t OTF2_IoHandleFlag;

enum OTF2_IoHandleFlag_enum
{
    OTF2_IO_HANDLE_FLAG_NONE        = 0,

    OTF2_IO_HANDLE_FLAG_PRE_CREATED = ( 1 << 0 ),

    OTF2_IO_HANDLE_FLAG_ALL_PROXY   = ( 1 << 1 )
};


typedef uint8_t OTF2_IoAccessMode;

enum OTF2_IoAccessMode_enum
{
    OTF2_IO_ACCESS_MODE_READ_ONLY    = 0,

    OTF2_IO_ACCESS_MODE_WRITE_ONLY   = 1,

    OTF2_IO_ACCESS_MODE_READ_WRITE   = 2,

    OTF2_IO_ACCESS_MODE_EXECUTE_ONLY = 3,

    OTF2_IO_ACCESS_MODE_SEARCH_ONLY  = 4
};


typedef uint32_t OTF2_IoStatusFlag;

enum OTF2_IoStatusFlag_enum
{
    OTF2_IO_STATUS_FLAG_NONE            = 0,

    OTF2_IO_STATUS_FLAG_CLOSE_ON_EXEC   = 1 << 0,

    OTF2_IO_STATUS_FLAG_APPEND          = 1 << 1,

    OTF2_IO_STATUS_FLAG_NON_BLOCKING    = 1 << 2,

    OTF2_IO_STATUS_FLAG_ASYNC           = 1 << 3,

    OTF2_IO_STATUS_FLAG_SYNC            = 1 << 4,

    OTF2_IO_STATUS_FLAG_DATA_SYNC       = 1 << 5,

    OTF2_IO_STATUS_FLAG_AVOID_CACHING   = 1 << 6,

    OTF2_IO_STATUS_FLAG_NO_ACCESS_TIME  = 1 << 7,

    OTF2_IO_STATUS_FLAG_DELETE_ON_CLOSE = 1 << 8
};


typedef uint32_t OTF2_CommFlag;

enum OTF2_CommFlag_enum
{
    OTF2_COMM_FLAG_NONE                  = 0,

    OTF2_COMM_FLAG_CREATE_DESTROY_EVENTS = 1 << 0
};


typedef uint32_t OTF2_RmaWinFlag;

enum OTF2_RmaWinFlag_enum
{
    OTF2_RMA_WIN_FLAG_NONE                  = 0,

    OTF2_RMA_WIN_FLAG_CREATE_DESTROY_EVENTS = 1 << 0
};


#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* OTF2_DEFINITIONS_H */