1.5.1 (revision 4026)
otf2/OTF2_GlobalDefReaderCallbacks.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_GLOBAL_DEF_READER_CALLBACKS_H
00033 #define OTF2_GLOBAL_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_AttributeValue.h>
00052 #include <otf2/OTF2_Definitions.h>
00053 
00054 
00055 #ifdef __cplusplus
00056 extern "C" {
00057 #endif /* __cplusplus */
00058 
00059 
00062 typedef struct OTF2_GlobalDefReaderCallbacks_struct OTF2_GlobalDefReaderCallbacks;
00063 
00064 
00069 OTF2_GlobalDefReaderCallbacks*
00070 OTF2_GlobalDefReaderCallbacks_New( void );
00071 
00072 
00078 void
00079 OTF2_GlobalDefReaderCallbacks_Delete( OTF2_GlobalDefReaderCallbacks* globalDefReaderCallbacks );
00080 
00081 
00087 void
00088 OTF2_GlobalDefReaderCallbacks_Clear( OTF2_GlobalDefReaderCallbacks* globalDefReaderCallbacks );
00089 
00090 
00100 typedef OTF2_CallbackCode
00101 ( *OTF2_GlobalDefReaderCallback_Unknown )( void* userData );
00102 
00103 
00115 OTF2_ErrorCode
00116 OTF2_GlobalDefReaderCallbacks_SetUnknownCallback(
00117     OTF2_GlobalDefReaderCallbacks*       globalDefReaderCallbacks,
00118     OTF2_GlobalDefReaderCallback_Unknown unknownCallback );
00119 
00120 
00142 typedef OTF2_CallbackCode
00143 ( *OTF2_GlobalDefReaderCallback_ClockProperties )( void*    userData,
00144                                                    uint64_t timerResolution,
00145                                                    uint64_t globalOffset,
00146                                                    uint64_t traceLength );
00147 
00148 
00163 OTF2_ErrorCode
00164 OTF2_GlobalDefReaderCallbacks_SetClockPropertiesCallback(
00165     OTF2_GlobalDefReaderCallbacks*               globalDefReaderCallbacks,
00166     OTF2_GlobalDefReaderCallback_ClockProperties clockPropertiesCallback );
00167 
00168 
00191 typedef OTF2_CallbackCode
00192 ( *OTF2_GlobalDefReaderCallback_Paradigm )( void*              userData,
00193                                             OTF2_Paradigm      paradigm,
00194                                             OTF2_StringRef     name,
00195                                             OTF2_ParadigmClass paradigmClass );
00196 
00197 
00212 OTF2_ErrorCode
00213 OTF2_GlobalDefReaderCallbacks_SetParadigmCallback(
00214     OTF2_GlobalDefReaderCallbacks*        globalDefReaderCallbacks,
00215     OTF2_GlobalDefReaderCallback_Paradigm paradigmCallback );
00216 
00217 
00238 typedef OTF2_CallbackCode
00239 ( *OTF2_GlobalDefReaderCallback_ParadigmProperty )( void*                 userData,
00240                                                     OTF2_Paradigm         paradigm,
00241                                                     OTF2_ParadigmProperty property,
00242                                                     OTF2_Type             type,
00243                                                     OTF2_AttributeValue   attributeValue );
00244 
00245 
00260 OTF2_ErrorCode
00261 OTF2_GlobalDefReaderCallbacks_SetParadigmPropertyCallback(
00262     OTF2_GlobalDefReaderCallbacks*                globalDefReaderCallbacks,
00263     OTF2_GlobalDefReaderCallback_ParadigmProperty paradigmPropertyCallback );
00264 
00265 
00281 typedef OTF2_CallbackCode
00282 ( *OTF2_GlobalDefReaderCallback_String )( void*          userData,
00283                                           OTF2_StringRef self,
00284                                           const char*    string );
00285 
00286 
00301 OTF2_ErrorCode
00302 OTF2_GlobalDefReaderCallbacks_SetStringCallback(
00303     OTF2_GlobalDefReaderCallbacks*      globalDefReaderCallbacks,
00304     OTF2_GlobalDefReaderCallback_String stringCallback );
00305 
00306 
00327 typedef OTF2_CallbackCode
00328 ( *OTF2_GlobalDefReaderCallback_Attribute )( void*             userData,
00329                                              OTF2_AttributeRef self,
00330                                              OTF2_StringRef    name,
00331                                              OTF2_StringRef    description,
00332                                              OTF2_Type         type );
00333 
00334 
00349 OTF2_ErrorCode
00350 OTF2_GlobalDefReaderCallbacks_SetAttributeCallback(
00351     OTF2_GlobalDefReaderCallbacks*         globalDefReaderCallbacks,
00352     OTF2_GlobalDefReaderCallback_Attribute attributeCallback );
00353 
00354 
00378 typedef OTF2_CallbackCode
00379 ( *OTF2_GlobalDefReaderCallback_SystemTreeNode )( void*                  userData,
00380                                                   OTF2_SystemTreeNodeRef self,
00381                                                   OTF2_StringRef         name,
00382                                                   OTF2_StringRef         className,
00383                                                   OTF2_SystemTreeNodeRef parent );
00384 
00385 
00400 OTF2_ErrorCode
00401 OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodeCallback(
00402     OTF2_GlobalDefReaderCallbacks*              globalDefReaderCallbacks,
00403     OTF2_GlobalDefReaderCallback_SystemTreeNode systemTreeNodeCallback );
00404 
00405 
00426 typedef OTF2_CallbackCode
00427 ( *OTF2_GlobalDefReaderCallback_LocationGroup )( void*                  userData,
00428                                                  OTF2_LocationGroupRef  self,
00429                                                  OTF2_StringRef         name,
00430                                                  OTF2_LocationGroupType locationGroupType,
00431                                                  OTF2_SystemTreeNodeRef systemTreeParent );
00432 
00433 
00448 OTF2_ErrorCode
00449 OTF2_GlobalDefReaderCallbacks_SetLocationGroupCallback(
00450     OTF2_GlobalDefReaderCallbacks*             globalDefReaderCallbacks,
00451     OTF2_GlobalDefReaderCallback_LocationGroup locationGroupCallback );
00452 
00453 
00475 typedef OTF2_CallbackCode
00476 ( *OTF2_GlobalDefReaderCallback_Location )( void*                 userData,
00477                                             OTF2_LocationRef      self,
00478                                             OTF2_StringRef        name,
00479                                             OTF2_LocationType     locationType,
00480                                             uint64_t              numberOfEvents,
00481                                             OTF2_LocationGroupRef locationGroup );
00482 
00483 
00498 OTF2_ErrorCode
00499 OTF2_GlobalDefReaderCallbacks_SetLocationCallback(
00500     OTF2_GlobalDefReaderCallbacks*        globalDefReaderCallbacks,
00501     OTF2_GlobalDefReaderCallback_Location locationCallback );
00502 
00503 
00534 typedef OTF2_CallbackCode
00535 ( *OTF2_GlobalDefReaderCallback_Region )( void*           userData,
00536                                           OTF2_RegionRef  self,
00537                                           OTF2_StringRef  name,
00538                                           OTF2_StringRef  canonicalName,
00539                                           OTF2_StringRef  description,
00540                                           OTF2_RegionRole regionRole,
00541                                           OTF2_Paradigm   paradigm,
00542                                           OTF2_RegionFlag regionFlags,
00543                                           OTF2_StringRef  sourceFile,
00544                                           uint32_t        beginLineNumber,
00545                                           uint32_t        endLineNumber );
00546 
00547 
00562 OTF2_ErrorCode
00563 OTF2_GlobalDefReaderCallbacks_SetRegionCallback(
00564     OTF2_GlobalDefReaderCallbacks*      globalDefReaderCallbacks,
00565     OTF2_GlobalDefReaderCallback_Region regionCallback );
00566 
00567 
00590 typedef OTF2_CallbackCode
00591 ( *OTF2_GlobalDefReaderCallback_Callsite )( void*            userData,
00592                                             OTF2_CallsiteRef self,
00593                                             OTF2_StringRef   sourceFile,
00594                                             uint32_t         lineNumber,
00595                                             OTF2_RegionRef   enteredRegion,
00596                                             OTF2_RegionRef   leftRegion );
00597 
00598 
00613 OTF2_ErrorCode
00614 OTF2_GlobalDefReaderCallbacks_SetCallsiteCallback(
00615     OTF2_GlobalDefReaderCallbacks*        globalDefReaderCallbacks,
00616     OTF2_GlobalDefReaderCallback_Callsite callsiteCallback );
00617 
00618 
00637 typedef OTF2_CallbackCode
00638 ( *OTF2_GlobalDefReaderCallback_Callpath )( void*            userData,
00639                                             OTF2_CallpathRef self,
00640                                             OTF2_CallpathRef parent,
00641                                             OTF2_RegionRef   region );
00642 
00643 
00658 OTF2_ErrorCode
00659 OTF2_GlobalDefReaderCallbacks_SetCallpathCallback(
00660     OTF2_GlobalDefReaderCallbacks*        globalDefReaderCallbacks,
00661     OTF2_GlobalDefReaderCallback_Callpath callpathCallback );
00662 
00663 
00687 typedef OTF2_CallbackCode
00688 ( *OTF2_GlobalDefReaderCallback_Group )( void*           userData,
00689                                          OTF2_GroupRef   self,
00690                                          OTF2_StringRef  name,
00691                                          OTF2_GroupType  groupType,
00692                                          OTF2_Paradigm   paradigm,
00693                                          OTF2_GroupFlag  groupFlags,
00694                                          uint32_t        numberOfMembers,
00695                                          const uint64_t* members );
00696 
00697 
00712 OTF2_ErrorCode
00713 OTF2_GlobalDefReaderCallbacks_SetGroupCallback(
00714     OTF2_GlobalDefReaderCallbacks*     globalDefReaderCallbacks,
00715     OTF2_GlobalDefReaderCallback_Group groupCallback );
00716 
00717 
00763 typedef OTF2_CallbackCode
00764 ( *OTF2_GlobalDefReaderCallback_MetricMember )( void*                userData,
00765                                                 OTF2_MetricMemberRef self,
00766                                                 OTF2_StringRef       name,
00767                                                 OTF2_StringRef       description,
00768                                                 OTF2_MetricType      metricType,
00769                                                 OTF2_MetricMode      metricMode,
00770                                                 OTF2_Type            valueType,
00771                                                 OTF2_MetricBase      metricBase,
00772                                                 int64_t              exponent,
00773                                                 OTF2_StringRef       unit );
00774 
00775 
00790 OTF2_ErrorCode
00791 OTF2_GlobalDefReaderCallbacks_SetMetricMemberCallback(
00792     OTF2_GlobalDefReaderCallbacks*            globalDefReaderCallbacks,
00793     OTF2_GlobalDefReaderCallback_MetricMember metricMemberCallback );
00794 
00795 
00820 typedef OTF2_CallbackCode
00821 ( *OTF2_GlobalDefReaderCallback_MetricClass )( void*                       userData,
00822                                                OTF2_MetricRef              self,
00823                                                uint8_t                     numberOfMetrics,
00824                                                const OTF2_MetricMemberRef* metricMembers,
00825                                                OTF2_MetricOccurrence       metricOccurrence,
00826                                                OTF2_RecorderKind           recorderKind );
00827 
00828 
00843 OTF2_ErrorCode
00844 OTF2_GlobalDefReaderCallbacks_SetMetricClassCallback(
00845     OTF2_GlobalDefReaderCallbacks*           globalDefReaderCallbacks,
00846     OTF2_GlobalDefReaderCallback_MetricClass metricClassCallback );
00847 
00848 
00876 typedef OTF2_CallbackCode
00877 ( *OTF2_GlobalDefReaderCallback_MetricInstance )( void*            userData,
00878                                                   OTF2_MetricRef   self,
00879                                                   OTF2_MetricRef   metricClass,
00880                                                   OTF2_LocationRef recorder,
00881                                                   OTF2_MetricScope metricScope,
00882                                                   uint64_t         scope );
00883 
00884 
00899 OTF2_ErrorCode
00900 OTF2_GlobalDefReaderCallbacks_SetMetricInstanceCallback(
00901     OTF2_GlobalDefReaderCallbacks*              globalDefReaderCallbacks,
00902     OTF2_GlobalDefReaderCallback_MetricInstance metricInstanceCallback );
00903 
00904 
00929 typedef OTF2_CallbackCode
00930 ( *OTF2_GlobalDefReaderCallback_Comm )( void*          userData,
00931                                         OTF2_CommRef   self,
00932                                         OTF2_StringRef name,
00933                                         OTF2_GroupRef  group,
00934                                         OTF2_CommRef   parent );
00935 
00936 
00951 OTF2_ErrorCode
00952 OTF2_GlobalDefReaderCallbacks_SetCommCallback(
00953     OTF2_GlobalDefReaderCallbacks*    globalDefReaderCallbacks,
00954     OTF2_GlobalDefReaderCallback_Comm commCallback );
00955 
00956 
00976 typedef OTF2_CallbackCode
00977 ( *OTF2_GlobalDefReaderCallback_Parameter )( void*              userData,
00978                                              OTF2_ParameterRef  self,
00979                                              OTF2_StringRef     name,
00980                                              OTF2_ParameterType parameterType );
00981 
00982 
00997 OTF2_ErrorCode
00998 OTF2_GlobalDefReaderCallbacks_SetParameterCallback(
00999     OTF2_GlobalDefReaderCallbacks*         globalDefReaderCallbacks,
01000     OTF2_GlobalDefReaderCallback_Parameter parameterCallback );
01001 
01002 
01022 typedef OTF2_CallbackCode
01023 ( *OTF2_GlobalDefReaderCallback_RmaWin )( void*          userData,
01024                                           OTF2_RmaWinRef self,
01025                                           OTF2_StringRef name,
01026                                           OTF2_CommRef   comm );
01027 
01028 
01043 OTF2_ErrorCode
01044 OTF2_GlobalDefReaderCallbacks_SetRmaWinCallback(
01045     OTF2_GlobalDefReaderCallbacks*      globalDefReaderCallbacks,
01046     OTF2_GlobalDefReaderCallback_RmaWin rmaWinCallback );
01047 
01048 
01067 typedef OTF2_CallbackCode
01068 ( *OTF2_GlobalDefReaderCallback_MetricClassRecorder )( void*            userData,
01069                                                        OTF2_MetricRef   metricClass,
01070                                                        OTF2_LocationRef recorder );
01071 
01072 
01088 OTF2_ErrorCode
01089 OTF2_GlobalDefReaderCallbacks_SetMetricClassRecorderCallback(
01090     OTF2_GlobalDefReaderCallbacks*                   globalDefReaderCallbacks,
01091     OTF2_GlobalDefReaderCallback_MetricClassRecorder metricClassRecorderCallback );
01092 
01093 
01114 typedef OTF2_CallbackCode
01115 ( *OTF2_GlobalDefReaderCallback_SystemTreeNodeProperty )( void*                  userData,
01116                                                           OTF2_SystemTreeNodeRef systemTreeNode,
01117                                                           OTF2_StringRef         name,
01118                                                           OTF2_StringRef         value );
01119 
01120 
01136 OTF2_ErrorCode
01137 OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodePropertyCallback(
01138     OTF2_GlobalDefReaderCallbacks*                      globalDefReaderCallbacks,
01139     OTF2_GlobalDefReaderCallback_SystemTreeNodeProperty systemTreeNodePropertyCallback );
01140 
01141 
01160 typedef OTF2_CallbackCode
01161 ( *OTF2_GlobalDefReaderCallback_SystemTreeNodeDomain )( void*                  userData,
01162                                                         OTF2_SystemTreeNodeRef systemTreeNode,
01163                                                         OTF2_SystemTreeDomain  systemTreeDomain );
01164 
01165 
01181 OTF2_ErrorCode
01182 OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodeDomainCallback(
01183     OTF2_GlobalDefReaderCallbacks*                    globalDefReaderCallbacks,
01184     OTF2_GlobalDefReaderCallback_SystemTreeNodeDomain systemTreeNodeDomainCallback );
01185 
01186 
01206 typedef OTF2_CallbackCode
01207 ( *OTF2_GlobalDefReaderCallback_LocationGroupProperty )( void*                 userData,
01208                                                          OTF2_LocationGroupRef locationGroup,
01209                                                          OTF2_StringRef        name,
01210                                                          OTF2_StringRef        value );
01211 
01212 
01228 OTF2_ErrorCode
01229 OTF2_GlobalDefReaderCallbacks_SetLocationGroupPropertyCallback(
01230     OTF2_GlobalDefReaderCallbacks*                     globalDefReaderCallbacks,
01231     OTF2_GlobalDefReaderCallback_LocationGroupProperty locationGroupPropertyCallback );
01232 
01233 
01252 typedef OTF2_CallbackCode
01253 ( *OTF2_GlobalDefReaderCallback_LocationProperty )( void*            userData,
01254                                                     OTF2_LocationRef location,
01255                                                     OTF2_StringRef   name,
01256                                                     OTF2_StringRef   value );
01257 
01258 
01273 OTF2_ErrorCode
01274 OTF2_GlobalDefReaderCallbacks_SetLocationPropertyCallback(
01275     OTF2_GlobalDefReaderCallbacks*                globalDefReaderCallbacks,
01276     OTF2_GlobalDefReaderCallback_LocationProperty locationPropertyCallback );
01277 
01278 
01299 typedef OTF2_CallbackCode
01300 ( *OTF2_GlobalDefReaderCallback_CartDimension )( void*                 userData,
01301                                                  OTF2_CartDimensionRef self,
01302                                                  OTF2_StringRef        name,
01303                                                  uint32_t              size,
01304                                                  OTF2_CartPeriodicity  cartPeriodicity );
01305 
01306 
01321 OTF2_ErrorCode
01322 OTF2_GlobalDefReaderCallbacks_SetCartDimensionCallback(
01323     OTF2_GlobalDefReaderCallbacks*             globalDefReaderCallbacks,
01324     OTF2_GlobalDefReaderCallback_CartDimension cartDimensionCallback );
01325 
01326 
01353 typedef OTF2_CallbackCode
01354 ( *OTF2_GlobalDefReaderCallback_CartTopology )( void*                        userData,
01355                                                 OTF2_CartTopologyRef         self,
01356                                                 OTF2_StringRef               name,
01357                                                 OTF2_CommRef                 communicator,
01358                                                 uint8_t                      numberOfDimensions,
01359                                                 const OTF2_CartDimensionRef* cartDimensions );
01360 
01361 
01376 OTF2_ErrorCode
01377 OTF2_GlobalDefReaderCallbacks_SetCartTopologyCallback(
01378     OTF2_GlobalDefReaderCallbacks*            globalDefReaderCallbacks,
01379     OTF2_GlobalDefReaderCallback_CartTopology cartTopologyCallback );
01380 
01381 
01404 typedef OTF2_CallbackCode
01405 ( *OTF2_GlobalDefReaderCallback_CartCoordinate )( void*                userData,
01406                                                   OTF2_CartTopologyRef cartTopology,
01407                                                   uint32_t             rank,
01408                                                   uint8_t              numberOfDimensions,
01409                                                   const uint32_t*      coordinates );
01410 
01411 
01426 OTF2_ErrorCode
01427 OTF2_GlobalDefReaderCallbacks_SetCartCoordinateCallback(
01428     OTF2_GlobalDefReaderCallbacks*              globalDefReaderCallbacks,
01429     OTF2_GlobalDefReaderCallback_CartCoordinate cartCoordinateCallback );
01430 
01431 
01456 typedef OTF2_CallbackCode
01457 ( *OTF2_GlobalDefReaderCallback_SourceCodeLocation )( void*                      userData,
01458                                                       OTF2_SourceCodeLocationRef self,
01459                                                       OTF2_StringRef             file,
01460                                                       uint32_t                   lineNumber );
01461 
01462 
01477 OTF2_ErrorCode
01478 OTF2_GlobalDefReaderCallbacks_SetSourceCodeLocationCallback(
01479     OTF2_GlobalDefReaderCallbacks*                  globalDefReaderCallbacks,
01480     OTF2_GlobalDefReaderCallback_SourceCodeLocation sourceCodeLocationCallback );
01481 
01482 
01504 typedef OTF2_CallbackCode
01505 ( *OTF2_GlobalDefReaderCallback_CallingContext )( void*                  userData,
01506                                                   OTF2_CallingContextRef self,
01507                                                   uint64_t               ip,
01508                                                   OTF2_RegionRef         region,
01509                                                   uint32_t               offsetLineNumber,
01510                                                   OTF2_CallingContextRef parent );
01511 
01512 
01527 OTF2_ErrorCode
01528 OTF2_GlobalDefReaderCallbacks_SetCallingContextCallback(
01529     OTF2_GlobalDefReaderCallbacks*              globalDefReaderCallbacks,
01530     OTF2_GlobalDefReaderCallback_CallingContext callingContextCallback );
01531 
01532 
01553 typedef OTF2_CallbackCode
01554 ( *OTF2_GlobalDefReaderCallback_InterruptGenerator )( void*                      userData,
01555                                                       OTF2_InterruptGeneratorRef self,
01556                                                       OTF2_StringRef             name,
01557                                                       OTF2_StringRef             unit,
01558                                                       uint64_t                   period );
01559 
01560 
01575 OTF2_ErrorCode
01576 OTF2_GlobalDefReaderCallbacks_SetInterruptGeneratorCallback(
01577     OTF2_GlobalDefReaderCallbacks*                  globalDefReaderCallbacks,
01578     OTF2_GlobalDefReaderCallback_InterruptGenerator interruptGeneratorCallback );
01579 
01580 
01581 #ifdef __cplusplus
01582 }
01583 #endif /* __cplusplus */
01584 
01585 
01586 #endif /* !OTF2_GLOBAL_DEF_READER_CALLBACKS_H */