OTF2_GeneralDefinitions.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-2013,
 * RWTH Aachen University, Germany
 *
 * Copyright (c) 2009-2013,
 * Gesellschaft fuer numerische Simulation mbH Braunschweig, Germany
 *
 * Copyright (c) 2009-2014,
 * Technische Universitaet Dresden, Germany
 *
 * Copyright (c) 2009-2013,
 * University of Oregon, Eugene, USA
 *
 * Copyright (c) 2009-2013,
 * Forschungszentrum Juelich GmbH, Germany
 *
 * Copyright (c) 2009-2013,
 * German Research School for Simulation Sciences GmbH, Juelich/Aachen, Germany
 *
 * Copyright (c) 2009-2013,
 * 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_GENERAL_DEFINITIONS_H
#define OTF2_GENERAL_DEFINITIONS_H


#include <stdint.h>


#include <otf2/OTF2_ErrorCodes.h>


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


/* ___ OTF2 library version information _____________________________________ */


#define OTF2_VERSION_MAJOR  2

#define OTF2_VERSION_MINOR  2

#define OTF2_VERSION_BUGFIX 0

#define OTF2_VERSION_SUFFIX ""

#define OTF2_VERSION        "2.2"

/* ___ Symbols for undefined values _________________________________________ */


#define OTF2_UNDEFINED_UINT8  ( ( uint8_t )( ~( ( uint8_t )0u ) ) )

#define OTF2_UNDEFINED_INT8  ( ( int8_t )( ~( OTF2_UNDEFINED_UINT8 >> 1 ) ) )

#define OTF2_UNDEFINED_UINT16 ( ( uint16_t )( ~( ( uint16_t )0u ) ) )

#define OTF2_UNDEFINED_INT16  ( ( int16_t )( ~( OTF2_UNDEFINED_UINT16 >> 1 ) ) )

#define OTF2_UNDEFINED_UINT32 ( ( uint32_t )( ~( ( uint32_t )0u ) ) )

#define OTF2_UNDEFINED_INT32  ( ( int32_t )( ~( OTF2_UNDEFINED_UINT32 >> 1 ) ) )

#define OTF2_UNDEFINED_UINT64 ( ( uint64_t )( ~( ( uint64_t )0u ) ) )

#define OTF2_UNDEFINED_INT64  ( ( int64_t )( ~( OTF2_UNDEFINED_UINT64 >> 1 ) ) )

#define OTF2_UNDEFINED_TYPE OTF2_UNDEFINED_UINT8


typedef uint64_t OTF2_TimeStamp;
#define OTF2_UNDEFINED_TIMESTAMP OTF2_UNDEFINED_UINT64


typedef uint8_t OTF2_IoParadigmRef;
#define OTF2_UNDEFINED_IO_PARADIGM ( ( OTF2_IoParadigmRef )OTF2_UNDEFINED_UINT8 )


typedef uint32_t OTF2_StringRef;
#define OTF2_UNDEFINED_STRING ( ( OTF2_StringRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_AttributeRef;
#define OTF2_UNDEFINED_ATTRIBUTE ( ( OTF2_AttributeRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_SystemTreeNodeRef;
#define OTF2_UNDEFINED_SYSTEM_TREE_NODE ( ( OTF2_SystemTreeNodeRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_LocationGroupRef;
#define OTF2_UNDEFINED_LOCATION_GROUP ( ( OTF2_LocationGroupRef )OTF2_UNDEFINED_UINT32 )


typedef uint64_t OTF2_LocationRef;
#define OTF2_UNDEFINED_LOCATION ( ( OTF2_LocationRef )OTF2_UNDEFINED_UINT64 )


typedef uint32_t OTF2_RegionRef;
#define OTF2_UNDEFINED_REGION ( ( OTF2_RegionRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_CallsiteRef;
#define OTF2_UNDEFINED_CALLSITE ( ( OTF2_CallsiteRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_CallpathRef;
#define OTF2_UNDEFINED_CALLPATH ( ( OTF2_CallpathRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_GroupRef;
#define OTF2_UNDEFINED_GROUP ( ( OTF2_GroupRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_MetricMemberRef;
#define OTF2_UNDEFINED_METRIC_MEMBER ( ( OTF2_MetricMemberRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_MetricRef;
#define OTF2_UNDEFINED_METRIC ( ( OTF2_MetricRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_CommRef;
#define OTF2_UNDEFINED_COMM ( ( OTF2_CommRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_ParameterRef;
#define OTF2_UNDEFINED_PARAMETER ( ( OTF2_ParameterRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_RmaWinRef;
#define OTF2_UNDEFINED_RMA_WIN ( ( OTF2_RmaWinRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_CartDimensionRef;
#define OTF2_UNDEFINED_CART_DIMENSION ( ( OTF2_CartDimensionRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_CartTopologyRef;
#define OTF2_UNDEFINED_CART_TOPOLOGY ( ( OTF2_CartTopologyRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_SourceCodeLocationRef;
#define OTF2_UNDEFINED_SOURCE_CODE_LOCATION ( ( OTF2_SourceCodeLocationRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_CallingContextRef;
#define OTF2_UNDEFINED_CALLING_CONTEXT ( ( OTF2_CallingContextRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_InterruptGeneratorRef;
#define OTF2_UNDEFINED_INTERRUPT_GENERATOR ( ( OTF2_InterruptGeneratorRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_IoFileRef;
#define OTF2_UNDEFINED_IO_FILE ( ( OTF2_IoFileRef )OTF2_UNDEFINED_UINT32 )


typedef uint32_t OTF2_IoHandleRef;
#define OTF2_UNDEFINED_IO_HANDLE ( ( OTF2_IoHandleRef )OTF2_UNDEFINED_UINT32 )


/* ___ Declarations of opaque OTF2 objects __________________________________ */


typedef struct OTF2_EvtReader_struct OTF2_EvtReader;


typedef struct OTF2_GlobalEvtReader_struct OTF2_GlobalEvtReader;


typedef struct OTF2_DefReader_struct OTF2_DefReader;


typedef struct OTF2_GlobalDefReader_struct OTF2_GlobalDefReader;


typedef struct OTF2_SnapReader_struct OTF2_SnapReader;


typedef struct OTF2_GlobalSnapReader_struct OTF2_GlobalSnapReader;


typedef struct OTF2_MarkerReader_struct OTF2_MarkerReader;


/* ___ Definitions related to the file interaction __________________________ */


#define OTF2_CHUNK_SIZE_MIN ( uint64_t )( 256 * 1024 )


#define OTF2_CHUNK_SIZE_MAX ( uint64_t )( 1024 * 1024 * 16 )


typedef uint8_t OTF2_FileMode;


enum OTF2_FileMode_enum
{
    OTF2_FILEMODE_WRITE  = 0,
    OTF2_FILEMODE_READ   = 1,
    OTF2_FILEMODE_MODIFY = 2
};


typedef uint8_t OTF2_Compression;


enum OTF2_Compression_enum
{
    OTF2_COMPRESSION_UNDEFINED = 0,
    OTF2_COMPRESSION_NONE      = 1,
    OTF2_COMPRESSION_ZLIB      = 2
};


typedef enum OTF2_CallbackCode_enum
{
    OTF2_CALLBACK_SUCCESS   = 0,

    OTF2_CALLBACK_INTERRUPT = !OTF2_CALLBACK_SUCCESS,

    OTF2_CALLBACK_ERROR     = !OTF2_CALLBACK_SUCCESS
} OTF2_CallbackCode;


/* ___ Definitions related to the memory buffer ______________________________ */


typedef uint8_t OTF2_FlushType;


enum OTF2_FlushType_enum
{
    OTF2_NO_FLUSH = 0,
    OTF2_FLUSH    = 1
};


typedef uint8_t OTF2_Hint;

enum OTF2_Hint_enum
{
    OTF2_HINT_GLOBAL_READER = 0
};


typedef uint8_t OTF2_Boolean;

enum OTF2_Boolean_enum
{
    OTF2_FALSE = 0,
    OTF2_TRUE  = !OTF2_FALSE
};


typedef uint8_t OTF2_FileType;

enum OTF2_FileType_enum
{
    OTF2_FILETYPE_ANCHOR      = 0,
    OTF2_FILETYPE_GLOBAL_DEFS = 1,
    OTF2_FILETYPE_LOCAL_DEFS  = 2,
    OTF2_FILETYPE_EVENTS      = 3,
    OTF2_FILETYPE_SNAPSHOTS   = 4,
    OTF2_FILETYPE_THUMBNAIL   = 5,
    OTF2_FILETYPE_MARKER      = 6,
    OTF2_FILETYPE_SIONRANKMAP = 7
};


typedef uint8_t OTF2_FileSubstrate;

enum OTF2_FileSubstrate_enum
{
    OTF2_SUBSTRATE_UNDEFINED = 0,
    OTF2_SUBSTRATE_POSIX     = 1,
    OTF2_SUBSTRATE_SION      = 2,
    OTF2_SUBSTRATE_NONE      = 3
};


typedef uint8_t OTF2_MappingType;

enum OTF2_MappingType_enum
{
    OTF2_MAPPING_STRING               = 0,
    OTF2_MAPPING_ATTRIBUTE            = 1,
    OTF2_MAPPING_LOCATION             = 2,
    OTF2_MAPPING_REGION               = 3,
    OTF2_MAPPING_GROUP                = 4,
    OTF2_MAPPING_METRIC               = 5,
    OTF2_MAPPING_COMM                 = 6,
    OTF2_MAPPING_PARAMETER            = 7,
    OTF2_MAPPING_RMA_WIN              = 8,
    OTF2_MAPPING_SOURCE_CODE_LOCATION = 9,
    OTF2_MAPPING_CALLING_CONTEXT      = 10,
    OTF2_MAPPING_INTERRUPT_GENERATOR  = 11,
    OTF2_MAPPING_IO_FILE              = 12,
    OTF2_MAPPING_IO_HANDLE            = 13,

    OTF2_MAPPING_MAX                  = 14
};


typedef uint8_t OTF2_Type;

enum OTF2_Type_enum
{
    OTF2_TYPE_NONE                 = 0,
    OTF2_TYPE_UINT8                = 1,
    OTF2_TYPE_UINT16               = 2,
    OTF2_TYPE_UINT32               = 3,
    OTF2_TYPE_UINT64               = 4,
    OTF2_TYPE_INT8                 = 5,
    OTF2_TYPE_INT16                = 6,
    OTF2_TYPE_INT32                = 7,
    OTF2_TYPE_INT64                = 8,
    OTF2_TYPE_FLOAT                = 9,
    OTF2_TYPE_DOUBLE               = 10,
    OTF2_TYPE_STRING               = 11,
    OTF2_TYPE_ATTRIBUTE            = 12,
    OTF2_TYPE_LOCATION             = 13,
    OTF2_TYPE_REGION               = 14,
    OTF2_TYPE_GROUP                = 15,
    OTF2_TYPE_METRIC               = 16,
    OTF2_TYPE_COMM                 = 17,
    OTF2_TYPE_PARAMETER            = 18,
    OTF2_TYPE_RMA_WIN              = 19,
    OTF2_TYPE_SOURCE_CODE_LOCATION = 20,
    OTF2_TYPE_CALLING_CONTEXT      = 21,
    OTF2_TYPE_INTERRUPT_GENERATOR  = 22,
    OTF2_TYPE_IO_FILE              = 23,
    OTF2_TYPE_IO_HANDLE            = 24
};


typedef uint8_t OTF2_Paradigm;

enum OTF2_Paradigm_enum
{
    OTF2_PARADIGM_UNKNOWN            = 0,
    OTF2_PARADIGM_USER               = 1,
    OTF2_PARADIGM_COMPILER           = 2,
    OTF2_PARADIGM_OPENMP             = 3,
    OTF2_PARADIGM_MPI                = 4,
    OTF2_PARADIGM_CUDA               = 5,
    OTF2_PARADIGM_MEASUREMENT_SYSTEM = 6,
    OTF2_PARADIGM_PTHREAD            = 7,
    OTF2_PARADIGM_HMPP               = 8,
    OTF2_PARADIGM_OMPSS              = 9,
    OTF2_PARADIGM_HARDWARE           = 10,
    OTF2_PARADIGM_GASPI              = 11,
    OTF2_PARADIGM_UPC                = 12,
    OTF2_PARADIGM_SHMEM              = 13,
    OTF2_PARADIGM_WINTHREAD          = 14,
    OTF2_PARADIGM_QTTHREAD           = 15,
    OTF2_PARADIGM_ACETHREAD          = 16,
    OTF2_PARADIGM_TBBTHREAD          = 17,
    OTF2_PARADIGM_OPENACC            = 18,
    OTF2_PARADIGM_OPENCL             = 19,
    OTF2_PARADIGM_MTAPI              = 20,
    OTF2_PARADIGM_SAMPLING           = 21,
    OTF2_PARADIGM_NONE               = 22
};


typedef uint8_t OTF2_ParadigmClass;

enum OTF2_ParadigmClass_enum
{
    OTF2_PARADIGM_CLASS_PROCESS            = 0,
    OTF2_PARADIGM_CLASS_THREAD_FORK_JOIN   = 1,
    OTF2_PARADIGM_CLASS_THREAD_CREATE_WAIT = 2,
    OTF2_PARADIGM_CLASS_ACCELERATOR        = 3
};


typedef uint8_t OTF2_ParadigmProperty;

enum OTF2_ParadigmProperty_enum
{
    OTF2_PARADIGM_PROPERTY_COMM_NAME_TEMPLATE    = 0,
    OTF2_PARADIGM_PROPERTY_RMA_WIN_NAME_TEMPLATE = 1,
    OTF2_PARADIGM_PROPERTY_RMA_ONLY              = 2
};


typedef uint8_t OTF2_ThumbnailType;

enum OTF2_ThumbnailType_enum
{
    OTF2_THUMBNAIL_TYPE_REGION     = 0,
    OTF2_THUMBNAIL_TYPE_METRIC     = 1,
    OTF2_THUMBNAIL_TYPE_ATTRIBUTES = 2
};


#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* !OTF2_GENERAL_DEFINITIONS_H */