1.5.1 (revision 4026)
otf2/OTF2_DefReaderCallbacks.h
Go to the documentation of this file.
00001 /*
00002  * This file is part of the Score-P software (http://www.score-p.org)
00003  *
00004  * Copyright (c) 2009-2012,
00005  * RWTH Aachen University, Germany
00006  *
00007  * Copyright (c) 2009-2012,
00008  * Gesellschaft fuer numerische Simulation mbH Braunschweig, Germany
00009  *
00010  * Copyright (c) 2009-2012, 2014,
00011  * Technische Universitaet Dresden, Germany
00012  *
00013  * Copyright (c) 2009-2012,
00014  * University of Oregon, Eugene, USA
00015  *
00016  * Copyright (c) 2009-2012,
00017  * Forschungszentrum Juelich GmbH, Germany
00018  *
00019  * Copyright (c) 2009-2012,
00020  * German Research School for Simulation Sciences GmbH, Juelich/Aachen, Germany
00021  *
00022  * Copyright (c) 2009-2012,
00023  * Technische Universitaet Muenchen, Germany
00024  *
00025  * This software may be modified and distributed under the terms of
00026  * a BSD-style license.  See the COPYING file in the package base
00027  * directory for details.
00028  *
00029  */
00030 
00031 
00032 #ifndef OTF2_DEF_READER_CALLBACKS_H
00033 #define OTF2_DEF_READER_CALLBACKS_H
00034 
00035 
00044 #include <stdint.h>
00045 
00046 
00047 #include <otf2/OTF2_ErrorCodes.h>
00048 
00049 
00050 #include <otf2/OTF2_GeneralDefinitions.h>
00051 #include <otf2/OTF2_Definitions.h>
00052 #include <otf2/OTF2_IdMap.h>
00053 
00054 
00055 #ifdef __cplusplus
00056 extern "C" {
00057 #endif /* __cplusplus */
00058 
00061 typedef struct OTF2_DefReaderCallbacks_struct OTF2_DefReaderCallbacks;
00062 
00063 
00068 OTF2_DefReaderCallbacks*
00069 OTF2_DefReaderCallbacks_New( void );
00070 
00071 
00077 void
00078 OTF2_DefReaderCallbacks_Delete( OTF2_DefReaderCallbacks* defReaderCallbacks );
00079 
00080 
00086 void
00087 OTF2_DefReaderCallbacks_Clear( OTF2_DefReaderCallbacks* defReaderCallbacks );
00088 
00089 
00099 typedef OTF2_CallbackCode
00100 ( *OTF2_DefReaderCallback_Unknown )( void* userData );
00101 
00102 
00115 OTF2_ErrorCode
00116 OTF2_DefReaderCallbacks_SetUnknownCallback(
00117     OTF2_DefReaderCallbacks*       defReaderCallbacks,
00118     OTF2_DefReaderCallback_Unknown unknownCallback );
00119 
00120 
00139 typedef OTF2_CallbackCode
00140 ( *OTF2_DefReaderCallback_MappingTable )( void*             userData,
00141                                           OTF2_MappingType  mappingType,
00142                                           const OTF2_IdMap* idMap );
00143 
00144 
00159 OTF2_ErrorCode
00160 OTF2_DefReaderCallbacks_SetMappingTableCallback(
00161     OTF2_DefReaderCallbacks*            defReaderCallbacks,
00162     OTF2_DefReaderCallback_MappingTable mappingTableCallback );
00163 
00164 
00183 typedef OTF2_CallbackCode
00184 ( *OTF2_DefReaderCallback_ClockOffset )( void*          userData,
00185                                          OTF2_TimeStamp time,
00186                                          int64_t        offset,
00187                                          double         standardDeviation );
00188 
00189 
00204 OTF2_ErrorCode
00205 OTF2_DefReaderCallbacks_SetClockOffsetCallback(
00206     OTF2_DefReaderCallbacks*           defReaderCallbacks,
00207     OTF2_DefReaderCallback_ClockOffset clockOffsetCallback );
00208 
00209 
00224 typedef OTF2_CallbackCode
00225 ( *OTF2_DefReaderCallback_String )( void*          userData,
00226                                     OTF2_StringRef self,
00227                                     const char*    string );
00228 
00229 
00244 OTF2_ErrorCode
00245 OTF2_DefReaderCallbacks_SetStringCallback(
00246     OTF2_DefReaderCallbacks*      defReaderCallbacks,
00247     OTF2_DefReaderCallback_String stringCallback );
00248 
00249 
00270 typedef OTF2_CallbackCode
00271 ( *OTF2_DefReaderCallback_Attribute )( void*             userData,
00272                                        OTF2_AttributeRef self,
00273                                        OTF2_StringRef    name,
00274                                        OTF2_StringRef    description,
00275                                        OTF2_Type         type );
00276 
00277 
00292 OTF2_ErrorCode
00293 OTF2_DefReaderCallbacks_SetAttributeCallback(
00294     OTF2_DefReaderCallbacks*         defReaderCallbacks,
00295     OTF2_DefReaderCallback_Attribute attributeCallback );
00296 
00297 
00320 typedef OTF2_CallbackCode
00321 ( *OTF2_DefReaderCallback_SystemTreeNode )( void*                  userData,
00322                                             OTF2_SystemTreeNodeRef self,
00323                                             OTF2_StringRef         name,
00324                                             OTF2_StringRef         className,
00325                                             OTF2_SystemTreeNodeRef parent );
00326 
00327 
00342 OTF2_ErrorCode
00343 OTF2_DefReaderCallbacks_SetSystemTreeNodeCallback(
00344     OTF2_DefReaderCallbacks*              defReaderCallbacks,
00345     OTF2_DefReaderCallback_SystemTreeNode systemTreeNodeCallback );
00346 
00347 
00368 typedef OTF2_CallbackCode
00369 ( *OTF2_DefReaderCallback_LocationGroup )( void*                  userData,
00370                                            OTF2_LocationGroupRef  self,
00371                                            OTF2_StringRef         name,
00372                                            OTF2_LocationGroupType locationGroupType,
00373                                            OTF2_SystemTreeNodeRef systemTreeParent );
00374 
00375 
00390 OTF2_ErrorCode
00391 OTF2_DefReaderCallbacks_SetLocationGroupCallback(
00392     OTF2_DefReaderCallbacks*             defReaderCallbacks,
00393     OTF2_DefReaderCallback_LocationGroup locationGroupCallback );
00394 
00395 
00417 typedef OTF2_CallbackCode
00418 ( *OTF2_DefReaderCallback_Location )( void*                 userData,
00419                                       OTF2_LocationRef      self,
00420                                       OTF2_StringRef        name,
00421                                       OTF2_LocationType     locationType,
00422                                       uint64_t              numberOfEvents,
00423                                       OTF2_LocationGroupRef locationGroup );
00424 
00425 
00440 OTF2_ErrorCode
00441 OTF2_DefReaderCallbacks_SetLocationCallback(
00442     OTF2_DefReaderCallbacks*        defReaderCallbacks,
00443     OTF2_DefReaderCallback_Location locationCallback );
00444 
00445 
00476 typedef OTF2_CallbackCode
00477 ( *OTF2_DefReaderCallback_Region )( void*           userData,
00478                                     OTF2_RegionRef  self,
00479                                     OTF2_StringRef  name,
00480                                     OTF2_StringRef  canonicalName,
00481                                     OTF2_StringRef  description,
00482                                     OTF2_RegionRole regionRole,
00483                                     OTF2_Paradigm   paradigm,
00484                                     OTF2_RegionFlag regionFlags,
00485                                     OTF2_StringRef  sourceFile,
00486                                     uint32_t        beginLineNumber,
00487                                     uint32_t        endLineNumber );
00488 
00489 
00504 OTF2_ErrorCode
00505 OTF2_DefReaderCallbacks_SetRegionCallback(
00506     OTF2_DefReaderCallbacks*      defReaderCallbacks,
00507     OTF2_DefReaderCallback_Region regionCallback );
00508 
00509 
00532 typedef OTF2_CallbackCode
00533 ( *OTF2_DefReaderCallback_Callsite )( void*            userData,
00534                                       OTF2_CallsiteRef self,
00535                                       OTF2_StringRef   sourceFile,
00536                                       uint32_t         lineNumber,
00537                                       OTF2_RegionRef   enteredRegion,
00538                                       OTF2_RegionRef   leftRegion );
00539 
00540 
00555 OTF2_ErrorCode
00556 OTF2_DefReaderCallbacks_SetCallsiteCallback(
00557     OTF2_DefReaderCallbacks*        defReaderCallbacks,
00558     OTF2_DefReaderCallback_Callsite callsiteCallback );
00559 
00560 
00578 typedef OTF2_CallbackCode
00579 ( *OTF2_DefReaderCallback_Callpath )( void*            userData,
00580                                       OTF2_CallpathRef self,
00581                                       OTF2_CallpathRef parent,
00582                                       OTF2_RegionRef   region );
00583 
00584 
00599 OTF2_ErrorCode
00600 OTF2_DefReaderCallbacks_SetCallpathCallback(
00601     OTF2_DefReaderCallbacks*        defReaderCallbacks,
00602     OTF2_DefReaderCallback_Callpath callpathCallback );
00603 
00604 
00628 typedef OTF2_CallbackCode
00629 ( *OTF2_DefReaderCallback_Group )( void*           userData,
00630                                    OTF2_GroupRef   self,
00631                                    OTF2_StringRef  name,
00632                                    OTF2_GroupType  groupType,
00633                                    OTF2_Paradigm   paradigm,
00634                                    OTF2_GroupFlag  groupFlags,
00635                                    uint32_t        numberOfMembers,
00636                                    const uint64_t* members );
00637 
00638 
00653 OTF2_ErrorCode
00654 OTF2_DefReaderCallbacks_SetGroupCallback(
00655     OTF2_DefReaderCallbacks*     defReaderCallbacks,
00656     OTF2_DefReaderCallback_Group groupCallback );
00657 
00658 
00704 typedef OTF2_CallbackCode
00705 ( *OTF2_DefReaderCallback_MetricMember )( void*                userData,
00706                                           OTF2_MetricMemberRef self,
00707                                           OTF2_StringRef       name,
00708                                           OTF2_StringRef       description,
00709                                           OTF2_MetricType      metricType,
00710                                           OTF2_MetricMode      metricMode,
00711                                           OTF2_Type            valueType,
00712                                           OTF2_MetricBase      metricBase,
00713                                           int64_t              exponent,
00714                                           OTF2_StringRef       unit );
00715 
00716 
00731 OTF2_ErrorCode
00732 OTF2_DefReaderCallbacks_SetMetricMemberCallback(
00733     OTF2_DefReaderCallbacks*            defReaderCallbacks,
00734     OTF2_DefReaderCallback_MetricMember metricMemberCallback );
00735 
00736 
00761 typedef OTF2_CallbackCode
00762 ( *OTF2_DefReaderCallback_MetricClass )( void*                       userData,
00763                                          OTF2_MetricRef              self,
00764                                          uint8_t                     numberOfMetrics,
00765                                          const OTF2_MetricMemberRef* metricMembers,
00766                                          OTF2_MetricOccurrence       metricOccurrence,
00767                                          OTF2_RecorderKind           recorderKind );
00768 
00769 
00784 OTF2_ErrorCode
00785 OTF2_DefReaderCallbacks_SetMetricClassCallback(
00786     OTF2_DefReaderCallbacks*           defReaderCallbacks,
00787     OTF2_DefReaderCallback_MetricClass metricClassCallback );
00788 
00789 
00817 typedef OTF2_CallbackCode
00818 ( *OTF2_DefReaderCallback_MetricInstance )( void*            userData,
00819                                             OTF2_MetricRef   self,
00820                                             OTF2_MetricRef   metricClass,
00821                                             OTF2_LocationRef recorder,
00822                                             OTF2_MetricScope metricScope,
00823                                             uint64_t         scope );
00824 
00825 
00840 OTF2_ErrorCode
00841 OTF2_DefReaderCallbacks_SetMetricInstanceCallback(
00842     OTF2_DefReaderCallbacks*              defReaderCallbacks,
00843     OTF2_DefReaderCallback_MetricInstance metricInstanceCallback );
00844 
00845 
00869 typedef OTF2_CallbackCode
00870 ( *OTF2_DefReaderCallback_Comm )( void*          userData,
00871                                   OTF2_CommRef   self,
00872                                   OTF2_StringRef name,
00873                                   OTF2_GroupRef  group,
00874                                   OTF2_CommRef   parent );
00875 
00876 
00891 OTF2_ErrorCode
00892 OTF2_DefReaderCallbacks_SetCommCallback(
00893     OTF2_DefReaderCallbacks*    defReaderCallbacks,
00894     OTF2_DefReaderCallback_Comm commCallback );
00895 
00896 
00916 typedef OTF2_CallbackCode
00917 ( *OTF2_DefReaderCallback_Parameter )( void*              userData,
00918                                        OTF2_ParameterRef  self,
00919                                        OTF2_StringRef     name,
00920                                        OTF2_ParameterType parameterType );
00921 
00922 
00937 OTF2_ErrorCode
00938 OTF2_DefReaderCallbacks_SetParameterCallback(
00939     OTF2_DefReaderCallbacks*         defReaderCallbacks,
00940     OTF2_DefReaderCallback_Parameter parameterCallback );
00941 
00942 
00961 typedef OTF2_CallbackCode
00962 ( *OTF2_DefReaderCallback_RmaWin )( void*          userData,
00963                                     OTF2_RmaWinRef self,
00964                                     OTF2_StringRef name,
00965                                     OTF2_CommRef   comm );
00966 
00967 
00982 OTF2_ErrorCode
00983 OTF2_DefReaderCallbacks_SetRmaWinCallback(
00984     OTF2_DefReaderCallbacks*      defReaderCallbacks,
00985     OTF2_DefReaderCallback_RmaWin rmaWinCallback );
00986 
00987 
01006 typedef OTF2_CallbackCode
01007 ( *OTF2_DefReaderCallback_MetricClassRecorder )( void*            userData,
01008                                                  OTF2_MetricRef   metricClass,
01009                                                  OTF2_LocationRef recorder );
01010 
01011 
01027 OTF2_ErrorCode
01028 OTF2_DefReaderCallbacks_SetMetricClassRecorderCallback(
01029     OTF2_DefReaderCallbacks*                   defReaderCallbacks,
01030     OTF2_DefReaderCallback_MetricClassRecorder metricClassRecorderCallback );
01031 
01032 
01053 typedef OTF2_CallbackCode
01054 ( *OTF2_DefReaderCallback_SystemTreeNodeProperty )( void*                  userData,
01055                                                     OTF2_SystemTreeNodeRef systemTreeNode,
01056                                                     OTF2_StringRef         name,
01057                                                     OTF2_StringRef         value );
01058 
01059 
01075 OTF2_ErrorCode
01076 OTF2_DefReaderCallbacks_SetSystemTreeNodePropertyCallback(
01077     OTF2_DefReaderCallbacks*                      defReaderCallbacks,
01078     OTF2_DefReaderCallback_SystemTreeNodeProperty systemTreeNodePropertyCallback );
01079 
01080 
01099 typedef OTF2_CallbackCode
01100 ( *OTF2_DefReaderCallback_SystemTreeNodeDomain )( void*                  userData,
01101                                                   OTF2_SystemTreeNodeRef systemTreeNode,
01102                                                   OTF2_SystemTreeDomain  systemTreeDomain );
01103 
01104 
01120 OTF2_ErrorCode
01121 OTF2_DefReaderCallbacks_SetSystemTreeNodeDomainCallback(
01122     OTF2_DefReaderCallbacks*                    defReaderCallbacks,
01123     OTF2_DefReaderCallback_SystemTreeNodeDomain systemTreeNodeDomainCallback );
01124 
01125 
01145 typedef OTF2_CallbackCode
01146 ( *OTF2_DefReaderCallback_LocationGroupProperty )( void*                 userData,
01147                                                    OTF2_LocationGroupRef locationGroup,
01148                                                    OTF2_StringRef        name,
01149                                                    OTF2_StringRef        value );
01150 
01151 
01167 OTF2_ErrorCode
01168 OTF2_DefReaderCallbacks_SetLocationGroupPropertyCallback(
01169     OTF2_DefReaderCallbacks*                     defReaderCallbacks,
01170     OTF2_DefReaderCallback_LocationGroupProperty locationGroupPropertyCallback );
01171 
01172 
01190 typedef OTF2_CallbackCode
01191 ( *OTF2_DefReaderCallback_LocationProperty )( void*            userData,
01192                                               OTF2_LocationRef location,
01193                                               OTF2_StringRef   name,
01194                                               OTF2_StringRef   value );
01195 
01196 
01211 OTF2_ErrorCode
01212 OTF2_DefReaderCallbacks_SetLocationPropertyCallback(
01213     OTF2_DefReaderCallbacks*                defReaderCallbacks,
01214     OTF2_DefReaderCallback_LocationProperty locationPropertyCallback );
01215 
01216 
01237 typedef OTF2_CallbackCode
01238 ( *OTF2_DefReaderCallback_CartDimension )( void*                 userData,
01239                                            OTF2_CartDimensionRef self,
01240                                            OTF2_StringRef        name,
01241                                            uint32_t              size,
01242                                            OTF2_CartPeriodicity  cartPeriodicity );
01243 
01244 
01259 OTF2_ErrorCode
01260 OTF2_DefReaderCallbacks_SetCartDimensionCallback(
01261     OTF2_DefReaderCallbacks*             defReaderCallbacks,
01262     OTF2_DefReaderCallback_CartDimension cartDimensionCallback );
01263 
01264 
01291 typedef OTF2_CallbackCode
01292 ( *OTF2_DefReaderCallback_CartTopology )( void*                        userData,
01293                                           OTF2_CartTopologyRef         self,
01294                                           OTF2_StringRef               name,
01295                                           OTF2_CommRef                 communicator,
01296                                           uint8_t                      numberOfDimensions,
01297                                           const OTF2_CartDimensionRef* cartDimensions );
01298 
01299 
01314 OTF2_ErrorCode
01315 OTF2_DefReaderCallbacks_SetCartTopologyCallback(
01316     OTF2_DefReaderCallbacks*            defReaderCallbacks,
01317     OTF2_DefReaderCallback_CartTopology cartTopologyCallback );
01318 
01319 
01342 typedef OTF2_CallbackCode
01343 ( *OTF2_DefReaderCallback_CartCoordinate )( void*                userData,
01344                                             OTF2_CartTopologyRef cartTopology,
01345                                             uint32_t             rank,
01346                                             uint8_t              numberOfDimensions,
01347                                             const uint32_t*      coordinates );
01348 
01349 
01364 OTF2_ErrorCode
01365 OTF2_DefReaderCallbacks_SetCartCoordinateCallback(
01366     OTF2_DefReaderCallbacks*              defReaderCallbacks,
01367     OTF2_DefReaderCallback_CartCoordinate cartCoordinateCallback );
01368 
01369 
01393 typedef OTF2_CallbackCode
01394 ( *OTF2_DefReaderCallback_SourceCodeLocation )( void*                      userData,
01395                                                 OTF2_SourceCodeLocationRef self,
01396                                                 OTF2_StringRef             file,
01397                                                 uint32_t                   lineNumber );
01398 
01399 
01414 OTF2_ErrorCode
01415 OTF2_DefReaderCallbacks_SetSourceCodeLocationCallback(
01416     OTF2_DefReaderCallbacks*                  defReaderCallbacks,
01417     OTF2_DefReaderCallback_SourceCodeLocation sourceCodeLocationCallback );
01418 
01419 
01441 typedef OTF2_CallbackCode
01442 ( *OTF2_DefReaderCallback_CallingContext )( void*                  userData,
01443                                             OTF2_CallingContextRef self,
01444                                             uint64_t               ip,
01445                                             OTF2_RegionRef         region,
01446                                             uint32_t               offsetLineNumber,
01447                                             OTF2_CallingContextRef parent );
01448 
01449 
01464 OTF2_ErrorCode
01465 OTF2_DefReaderCallbacks_SetCallingContextCallback(
01466     OTF2_DefReaderCallbacks*              defReaderCallbacks,
01467     OTF2_DefReaderCallback_CallingContext callingContextCallback );
01468 
01469 
01489 typedef OTF2_CallbackCode
01490 ( *OTF2_DefReaderCallback_InterruptGenerator )( void*                      userData,
01491                                                 OTF2_InterruptGeneratorRef self,
01492                                                 OTF2_StringRef             name,
01493                                                 OTF2_StringRef             unit,
01494                                                 uint64_t                   period );
01495 
01496 
01511 OTF2_ErrorCode
01512 OTF2_DefReaderCallbacks_SetInterruptGeneratorCallback(
01513     OTF2_DefReaderCallbacks*                  defReaderCallbacks,
01514     OTF2_DefReaderCallback_InterruptGenerator interruptGeneratorCallback );
01515 
01516 
01517 #ifdef __cplusplus
01518 }
01519 #endif /* __cplusplus */
01520 
01521 
01522 #endif /* !OTF2_DEF_READER_CALLBACKS_H */