OTF2_DefReaderCallbacks.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, 2014,
 * Technische Universitaet Dresden, Germany
 *
 * Copyright (c) 2009-2012,
 * University of Oregon, Eugene, USA
 *
 * Copyright (c) 2009-2012,
 * 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_DEF_READER_CALLBACKS_H
#define OTF2_DEF_READER_CALLBACKS_H


#include <stdint.h>


#include <otf2/OTF2_ErrorCodes.h>


#include <otf2/OTF2_GeneralDefinitions.h>
#include <otf2/OTF2_AttributeValue.h>
#include <otf2/OTF2_Definitions.h>
#include <otf2/OTF2_IdMap.h>


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

typedef struct OTF2_DefReaderCallbacks_struct OTF2_DefReaderCallbacks;


OTF2_DefReaderCallbacks*
OTF2_DefReaderCallbacks_New( void );


void
OTF2_DefReaderCallbacks_Delete( OTF2_DefReaderCallbacks* defReaderCallbacks );


void
OTF2_DefReaderCallbacks_Clear( OTF2_DefReaderCallbacks* defReaderCallbacks );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_Unknown )( void* userData );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetUnknownCallback(
    OTF2_DefReaderCallbacks*       defReaderCallbacks,
    OTF2_DefReaderCallback_Unknown unknownCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_MappingTable )( void*             userData,
                                           OTF2_MappingType  mappingType,
                                           const OTF2_IdMap* idMap );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetMappingTableCallback(
    OTF2_DefReaderCallbacks*            defReaderCallbacks,
    OTF2_DefReaderCallback_MappingTable mappingTableCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_ClockOffset )( void*          userData,
                                          OTF2_TimeStamp time,
                                          int64_t        offset,
                                          double         standardDeviation );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetClockOffsetCallback(
    OTF2_DefReaderCallbacks*           defReaderCallbacks,
    OTF2_DefReaderCallback_ClockOffset clockOffsetCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_String )( void*          userData,
                                     OTF2_StringRef self,
                                     const char*    string );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetStringCallback(
    OTF2_DefReaderCallbacks*      defReaderCallbacks,
    OTF2_DefReaderCallback_String stringCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_Attribute )( void*             userData,
                                        OTF2_AttributeRef self,
                                        OTF2_StringRef    name,
                                        OTF2_StringRef    description,
                                        OTF2_Type         type );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetAttributeCallback(
    OTF2_DefReaderCallbacks*         defReaderCallbacks,
    OTF2_DefReaderCallback_Attribute attributeCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_SystemTreeNode )( void*                  userData,
                                             OTF2_SystemTreeNodeRef self,
                                             OTF2_StringRef         name,
                                             OTF2_StringRef         className,
                                             OTF2_SystemTreeNodeRef parent );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetSystemTreeNodeCallback(
    OTF2_DefReaderCallbacks*              defReaderCallbacks,
    OTF2_DefReaderCallback_SystemTreeNode systemTreeNodeCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_LocationGroup )( void*                  userData,
                                            OTF2_LocationGroupRef  self,
                                            OTF2_StringRef         name,
                                            OTF2_LocationGroupType locationGroupType,
                                            OTF2_SystemTreeNodeRef systemTreeParent );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetLocationGroupCallback(
    OTF2_DefReaderCallbacks*             defReaderCallbacks,
    OTF2_DefReaderCallback_LocationGroup locationGroupCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_Location )( void*                 userData,
                                       OTF2_LocationRef      self,
                                       OTF2_StringRef        name,
                                       OTF2_LocationType     locationType,
                                       uint64_t              numberOfEvents,
                                       OTF2_LocationGroupRef locationGroup );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetLocationCallback(
    OTF2_DefReaderCallbacks*        defReaderCallbacks,
    OTF2_DefReaderCallback_Location locationCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_Region )( void*           userData,
                                     OTF2_RegionRef  self,
                                     OTF2_StringRef  name,
                                     OTF2_StringRef  canonicalName,
                                     OTF2_StringRef  description,
                                     OTF2_RegionRole regionRole,
                                     OTF2_Paradigm   paradigm,
                                     OTF2_RegionFlag regionFlags,
                                     OTF2_StringRef  sourceFile,
                                     uint32_t        beginLineNumber,
                                     uint32_t        endLineNumber );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetRegionCallback(
    OTF2_DefReaderCallbacks*      defReaderCallbacks,
    OTF2_DefReaderCallback_Region regionCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_Callsite )( void*            userData,
                                       OTF2_CallsiteRef self,
                                       OTF2_StringRef   sourceFile,
                                       uint32_t         lineNumber,
                                       OTF2_RegionRef   enteredRegion,
                                       OTF2_RegionRef   leftRegion );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetCallsiteCallback(
    OTF2_DefReaderCallbacks*        defReaderCallbacks,
    OTF2_DefReaderCallback_Callsite callsiteCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_Callpath )( void*            userData,
                                       OTF2_CallpathRef self,
                                       OTF2_CallpathRef parent,
                                       OTF2_RegionRef   region );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetCallpathCallback(
    OTF2_DefReaderCallbacks*        defReaderCallbacks,
    OTF2_DefReaderCallback_Callpath callpathCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_Group )( void*           userData,
                                    OTF2_GroupRef   self,
                                    OTF2_StringRef  name,
                                    OTF2_GroupType  groupType,
                                    OTF2_Paradigm   paradigm,
                                    OTF2_GroupFlag  groupFlags,
                                    uint32_t        numberOfMembers,
                                    const uint64_t* members );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetGroupCallback(
    OTF2_DefReaderCallbacks*     defReaderCallbacks,
    OTF2_DefReaderCallback_Group groupCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_MetricMember )( void*                userData,
                                           OTF2_MetricMemberRef self,
                                           OTF2_StringRef       name,
                                           OTF2_StringRef       description,
                                           OTF2_MetricType      metricType,
                                           OTF2_MetricMode      metricMode,
                                           OTF2_Type            valueType,
                                           OTF2_Base            base,
                                           int64_t              exponent,
                                           OTF2_StringRef       unit );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetMetricMemberCallback(
    OTF2_DefReaderCallbacks*            defReaderCallbacks,
    OTF2_DefReaderCallback_MetricMember metricMemberCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_MetricClass )( void*                       userData,
                                          OTF2_MetricRef              self,
                                          uint8_t                     numberOfMetrics,
                                          const OTF2_MetricMemberRef* metricMembers,
                                          OTF2_MetricOccurrence       metricOccurrence,
                                          OTF2_RecorderKind           recorderKind );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetMetricClassCallback(
    OTF2_DefReaderCallbacks*           defReaderCallbacks,
    OTF2_DefReaderCallback_MetricClass metricClassCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_MetricInstance )( void*            userData,
                                             OTF2_MetricRef   self,
                                             OTF2_MetricRef   metricClass,
                                             OTF2_LocationRef recorder,
                                             OTF2_MetricScope metricScope,
                                             uint64_t         scope );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetMetricInstanceCallback(
    OTF2_DefReaderCallbacks*              defReaderCallbacks,
    OTF2_DefReaderCallback_MetricInstance metricInstanceCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_Comm )( void*          userData,
                                   OTF2_CommRef   self,
                                   OTF2_StringRef name,
                                   OTF2_GroupRef  group,
                                   OTF2_CommRef   parent );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetCommCallback(
    OTF2_DefReaderCallbacks*    defReaderCallbacks,
    OTF2_DefReaderCallback_Comm commCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_Parameter )( void*              userData,
                                        OTF2_ParameterRef  self,
                                        OTF2_StringRef     name,
                                        OTF2_ParameterType parameterType );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetParameterCallback(
    OTF2_DefReaderCallbacks*         defReaderCallbacks,
    OTF2_DefReaderCallback_Parameter parameterCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_RmaWin )( void*          userData,
                                     OTF2_RmaWinRef self,
                                     OTF2_StringRef name,
                                     OTF2_CommRef   comm );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetRmaWinCallback(
    OTF2_DefReaderCallbacks*      defReaderCallbacks,
    OTF2_DefReaderCallback_RmaWin rmaWinCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_MetricClassRecorder )( void*            userData,
                                                  OTF2_MetricRef   metric,
                                                  OTF2_LocationRef recorder );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetMetricClassRecorderCallback(
    OTF2_DefReaderCallbacks*                   defReaderCallbacks,
    OTF2_DefReaderCallback_MetricClassRecorder metricClassRecorderCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_SystemTreeNodeProperty )( void*                  userData,
                                                     OTF2_SystemTreeNodeRef systemTreeNode,
                                                     OTF2_StringRef         name,
                                                     OTF2_Type              type,
                                                     OTF2_AttributeValue    value );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetSystemTreeNodePropertyCallback(
    OTF2_DefReaderCallbacks*                      defReaderCallbacks,
    OTF2_DefReaderCallback_SystemTreeNodeProperty systemTreeNodePropertyCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_SystemTreeNodeDomain )( void*                  userData,
                                                   OTF2_SystemTreeNodeRef systemTreeNode,
                                                   OTF2_SystemTreeDomain  systemTreeDomain );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetSystemTreeNodeDomainCallback(
    OTF2_DefReaderCallbacks*                    defReaderCallbacks,
    OTF2_DefReaderCallback_SystemTreeNodeDomain systemTreeNodeDomainCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_LocationGroupProperty )( void*                 userData,
                                                    OTF2_LocationGroupRef locationGroup,
                                                    OTF2_StringRef        name,
                                                    OTF2_Type             type,
                                                    OTF2_AttributeValue   value );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetLocationGroupPropertyCallback(
    OTF2_DefReaderCallbacks*                     defReaderCallbacks,
    OTF2_DefReaderCallback_LocationGroupProperty locationGroupPropertyCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_LocationProperty )( void*               userData,
                                               OTF2_LocationRef    location,
                                               OTF2_StringRef      name,
                                               OTF2_Type           type,
                                               OTF2_AttributeValue value );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetLocationPropertyCallback(
    OTF2_DefReaderCallbacks*                defReaderCallbacks,
    OTF2_DefReaderCallback_LocationProperty locationPropertyCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_CartDimension )( void*                 userData,
                                            OTF2_CartDimensionRef self,
                                            OTF2_StringRef        name,
                                            uint32_t              size,
                                            OTF2_CartPeriodicity  cartPeriodicity );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetCartDimensionCallback(
    OTF2_DefReaderCallbacks*             defReaderCallbacks,
    OTF2_DefReaderCallback_CartDimension cartDimensionCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_CartTopology )( void*                        userData,
                                           OTF2_CartTopologyRef         self,
                                           OTF2_StringRef               name,
                                           OTF2_CommRef                 communicator,
                                           uint8_t                      numberOfDimensions,
                                           const OTF2_CartDimensionRef* cartDimensions );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetCartTopologyCallback(
    OTF2_DefReaderCallbacks*            defReaderCallbacks,
    OTF2_DefReaderCallback_CartTopology cartTopologyCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_CartCoordinate )( void*                userData,
                                             OTF2_CartTopologyRef cartTopology,
                                             uint32_t             rank,
                                             uint8_t              numberOfDimensions,
                                             const uint32_t*      coordinates );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetCartCoordinateCallback(
    OTF2_DefReaderCallbacks*              defReaderCallbacks,
    OTF2_DefReaderCallback_CartCoordinate cartCoordinateCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_SourceCodeLocation )( void*                      userData,
                                                 OTF2_SourceCodeLocationRef self,
                                                 OTF2_StringRef             file,
                                                 uint32_t                   lineNumber );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetSourceCodeLocationCallback(
    OTF2_DefReaderCallbacks*                  defReaderCallbacks,
    OTF2_DefReaderCallback_SourceCodeLocation sourceCodeLocationCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_CallingContext )( void*                      userData,
                                             OTF2_CallingContextRef     self,
                                             OTF2_RegionRef             region,
                                             OTF2_SourceCodeLocationRef sourceCodeLocation,
                                             OTF2_CallingContextRef     parent );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetCallingContextCallback(
    OTF2_DefReaderCallbacks*              defReaderCallbacks,
    OTF2_DefReaderCallback_CallingContext callingContextCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_CallingContextProperty )( void*                  userData,
                                                     OTF2_CallingContextRef callingContext,
                                                     OTF2_StringRef         name,
                                                     OTF2_Type              type,
                                                     OTF2_AttributeValue    value );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetCallingContextPropertyCallback(
    OTF2_DefReaderCallbacks*                      defReaderCallbacks,
    OTF2_DefReaderCallback_CallingContextProperty callingContextPropertyCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_InterruptGenerator )( void*                       userData,
                                                 OTF2_InterruptGeneratorRef  self,
                                                 OTF2_StringRef              name,
                                                 OTF2_InterruptGeneratorMode interruptGeneratorMode,
                                                 OTF2_Base                   base,
                                                 int64_t                     exponent,
                                                 uint64_t                    period );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetInterruptGeneratorCallback(
    OTF2_DefReaderCallbacks*                  defReaderCallbacks,
    OTF2_DefReaderCallback_InterruptGenerator interruptGeneratorCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_IoFileProperty )( void*               userData,
                                             OTF2_IoFileRef      ioFile,
                                             OTF2_StringRef      name,
                                             OTF2_Type           type,
                                             OTF2_AttributeValue value );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetIoFilePropertyCallback(
    OTF2_DefReaderCallbacks*              defReaderCallbacks,
    OTF2_DefReaderCallback_IoFileProperty ioFilePropertyCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_IoRegularFile )( void*                  userData,
                                            OTF2_IoFileRef         self,
                                            OTF2_StringRef         name,
                                            OTF2_SystemTreeNodeRef scope );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetIoRegularFileCallback(
    OTF2_DefReaderCallbacks*             defReaderCallbacks,
    OTF2_DefReaderCallback_IoRegularFile ioRegularFileCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_IoDirectory )( void*                  userData,
                                          OTF2_IoFileRef         self,
                                          OTF2_StringRef         name,
                                          OTF2_SystemTreeNodeRef scope );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetIoDirectoryCallback(
    OTF2_DefReaderCallbacks*           defReaderCallbacks,
    OTF2_DefReaderCallback_IoDirectory ioDirectoryCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_IoHandle )( void*              userData,
                                       OTF2_IoHandleRef   self,
                                       OTF2_StringRef     name,
                                       OTF2_IoFileRef     file,
                                       OTF2_IoParadigmRef ioParadigm,
                                       OTF2_IoHandleFlag  ioHandleFlags,
                                       OTF2_CommRef       comm,
                                       OTF2_IoHandleRef   parent );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetIoHandleCallback(
    OTF2_DefReaderCallbacks*        defReaderCallbacks,
    OTF2_DefReaderCallback_IoHandle ioHandleCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_IoPreCreatedHandleState )( void*             userData,
                                                      OTF2_IoHandleRef  ioHandle,
                                                      OTF2_IoAccessMode mode,
                                                      OTF2_IoStatusFlag statusFlags );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetIoPreCreatedHandleStateCallback(
    OTF2_DefReaderCallbacks*                       defReaderCallbacks,
    OTF2_DefReaderCallback_IoPreCreatedHandleState ioPreCreatedHandleStateCallback );


typedef OTF2_CallbackCode
( * OTF2_DefReaderCallback_CallpathParameter )( void*               userData,
                                                OTF2_CallpathRef    callpath,
                                                OTF2_ParameterRef   parameter,
                                                OTF2_Type           type,
                                                OTF2_AttributeValue value );


OTF2_ErrorCode
OTF2_DefReaderCallbacks_SetCallpathParameterCallback(
    OTF2_DefReaderCallbacks*                 defReaderCallbacks,
    OTF2_DefReaderCallback_CallpathParameter callpathParameterCallback );


#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* !OTF2_DEF_READER_CALLBACKS_H */