1.4 (revision 3771)
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_Definitions.h>
00052 
00053 
00054 #ifdef __cplusplus
00055 extern "C" {
00056 #endif /* __cplusplus */
00057 
00058 
00061 typedef struct OTF2_GlobalDefReaderCallbacks_struct OTF2_GlobalDefReaderCallbacks;
00062 
00063 
00068 OTF2_GlobalDefReaderCallbacks*
00069 OTF2_GlobalDefReaderCallbacks_New( void );
00070 
00071 
00077 void
00078 OTF2_GlobalDefReaderCallbacks_Delete( OTF2_GlobalDefReaderCallbacks* globalDefReaderCallbacks );
00079 
00080 
00086 void
00087 OTF2_GlobalDefReaderCallbacks_Clear( OTF2_GlobalDefReaderCallbacks* globalDefReaderCallbacks );
00088 
00089 
00099 typedef OTF2_CallbackCode
00100 ( *OTF2_GlobalDefReaderCallback_Unknown )( void* userData );
00101 
00102 
00114 OTF2_ErrorCode
00115 OTF2_GlobalDefReaderCallbacks_SetUnknownCallback(
00116     OTF2_GlobalDefReaderCallbacks*       globalDefReaderCallbacks,
00117     OTF2_GlobalDefReaderCallback_Unknown unknownCallback );
00118 
00119 
00141 typedef OTF2_CallbackCode
00142 ( *OTF2_GlobalDefReaderCallback_ClockProperties )( void*    userData,
00143                                                    uint64_t timerResolution,
00144                                                    uint64_t globalOffset,
00145                                                    uint64_t traceLength );
00146 
00147 
00162 OTF2_ErrorCode
00163 OTF2_GlobalDefReaderCallbacks_SetClockPropertiesCallback(
00164     OTF2_GlobalDefReaderCallbacks*               globalDefReaderCallbacks,
00165     OTF2_GlobalDefReaderCallback_ClockProperties clockPropertiesCallback );
00166 
00167 
00183 typedef OTF2_CallbackCode
00184 ( *OTF2_GlobalDefReaderCallback_String )( void*          userData,
00185                                           OTF2_StringRef self,
00186                                           const char*    string );
00187 
00188 
00203 OTF2_ErrorCode
00204 OTF2_GlobalDefReaderCallbacks_SetStringCallback(
00205     OTF2_GlobalDefReaderCallbacks*      globalDefReaderCallbacks,
00206     OTF2_GlobalDefReaderCallback_String stringCallback );
00207 
00208 
00229 typedef OTF2_CallbackCode
00230 ( *OTF2_GlobalDefReaderCallback_Attribute )( void*             userData,
00231                                              OTF2_AttributeRef self,
00232                                              OTF2_StringRef    name,
00233                                              OTF2_StringRef    description,
00234                                              OTF2_Type         type );
00235 
00236 
00251 OTF2_ErrorCode
00252 OTF2_GlobalDefReaderCallbacks_SetAttributeCallback(
00253     OTF2_GlobalDefReaderCallbacks*         globalDefReaderCallbacks,
00254     OTF2_GlobalDefReaderCallback_Attribute attributeCallback );
00255 
00256 
00280 typedef OTF2_CallbackCode
00281 ( *OTF2_GlobalDefReaderCallback_SystemTreeNode )( void*                  userData,
00282                                                   OTF2_SystemTreeNodeRef self,
00283                                                   OTF2_StringRef         name,
00284                                                   OTF2_StringRef         className,
00285                                                   OTF2_SystemTreeNodeRef parent );
00286 
00287 
00302 OTF2_ErrorCode
00303 OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodeCallback(
00304     OTF2_GlobalDefReaderCallbacks*              globalDefReaderCallbacks,
00305     OTF2_GlobalDefReaderCallback_SystemTreeNode systemTreeNodeCallback );
00306 
00307 
00328 typedef OTF2_CallbackCode
00329 ( *OTF2_GlobalDefReaderCallback_LocationGroup )( void*                  userData,
00330                                                  OTF2_LocationGroupRef  self,
00331                                                  OTF2_StringRef         name,
00332                                                  OTF2_LocationGroupType locationGroupType,
00333                                                  OTF2_SystemTreeNodeRef systemTreeParent );
00334 
00335 
00350 OTF2_ErrorCode
00351 OTF2_GlobalDefReaderCallbacks_SetLocationGroupCallback(
00352     OTF2_GlobalDefReaderCallbacks*             globalDefReaderCallbacks,
00353     OTF2_GlobalDefReaderCallback_LocationGroup locationGroupCallback );
00354 
00355 
00377 typedef OTF2_CallbackCode
00378 ( *OTF2_GlobalDefReaderCallback_Location )( void*                 userData,
00379                                             OTF2_LocationRef      self,
00380                                             OTF2_StringRef        name,
00381                                             OTF2_LocationType     locationType,
00382                                             uint64_t              numberOfEvents,
00383                                             OTF2_LocationGroupRef locationGroup );
00384 
00385 
00400 OTF2_ErrorCode
00401 OTF2_GlobalDefReaderCallbacks_SetLocationCallback(
00402     OTF2_GlobalDefReaderCallbacks*        globalDefReaderCallbacks,
00403     OTF2_GlobalDefReaderCallback_Location locationCallback );
00404 
00405 
00436 typedef OTF2_CallbackCode
00437 ( *OTF2_GlobalDefReaderCallback_Region )( void*           userData,
00438                                           OTF2_RegionRef  self,
00439                                           OTF2_StringRef  name,
00440                                           OTF2_StringRef  canonicalName,
00441                                           OTF2_StringRef  description,
00442                                           OTF2_RegionRole regionRole,
00443                                           OTF2_Paradigm   paradigm,
00444                                           OTF2_RegionFlag regionFlags,
00445                                           OTF2_StringRef  sourceFile,
00446                                           uint32_t        beginLineNumber,
00447                                           uint32_t        endLineNumber );
00448 
00449 
00464 OTF2_ErrorCode
00465 OTF2_GlobalDefReaderCallbacks_SetRegionCallback(
00466     OTF2_GlobalDefReaderCallbacks*      globalDefReaderCallbacks,
00467     OTF2_GlobalDefReaderCallback_Region regionCallback );
00468 
00469 
00492 typedef OTF2_CallbackCode
00493 ( *OTF2_GlobalDefReaderCallback_Callsite )( void*            userData,
00494                                             OTF2_CallsiteRef self,
00495                                             OTF2_StringRef   sourceFile,
00496                                             uint32_t         lineNumber,
00497                                             OTF2_RegionRef   enteredRegion,
00498                                             OTF2_RegionRef   leftRegion );
00499 
00500 
00515 OTF2_ErrorCode
00516 OTF2_GlobalDefReaderCallbacks_SetCallsiteCallback(
00517     OTF2_GlobalDefReaderCallbacks*        globalDefReaderCallbacks,
00518     OTF2_GlobalDefReaderCallback_Callsite callsiteCallback );
00519 
00520 
00539 typedef OTF2_CallbackCode
00540 ( *OTF2_GlobalDefReaderCallback_Callpath )( void*            userData,
00541                                             OTF2_CallpathRef self,
00542                                             OTF2_CallpathRef parent,
00543                                             OTF2_RegionRef   region );
00544 
00545 
00560 OTF2_ErrorCode
00561 OTF2_GlobalDefReaderCallbacks_SetCallpathCallback(
00562     OTF2_GlobalDefReaderCallbacks*        globalDefReaderCallbacks,
00563     OTF2_GlobalDefReaderCallback_Callpath callpathCallback );
00564 
00565 
00589 typedef OTF2_CallbackCode
00590 ( *OTF2_GlobalDefReaderCallback_Group )( void*           userData,
00591                                          OTF2_GroupRef   self,
00592                                          OTF2_StringRef  name,
00593                                          OTF2_GroupType  groupType,
00594                                          OTF2_Paradigm   paradigm,
00595                                          OTF2_GroupFlag  groupFlags,
00596                                          uint32_t        numberOfMembers,
00597                                          const uint64_t* members );
00598 
00599 
00614 OTF2_ErrorCode
00615 OTF2_GlobalDefReaderCallbacks_SetGroupCallback(
00616     OTF2_GlobalDefReaderCallbacks*     globalDefReaderCallbacks,
00617     OTF2_GlobalDefReaderCallback_Group groupCallback );
00618 
00619 
00665 typedef OTF2_CallbackCode
00666 ( *OTF2_GlobalDefReaderCallback_MetricMember )( void*                userData,
00667                                                 OTF2_MetricMemberRef self,
00668                                                 OTF2_StringRef       name,
00669                                                 OTF2_StringRef       description,
00670                                                 OTF2_MetricType      metricType,
00671                                                 OTF2_MetricMode      metricMode,
00672                                                 OTF2_Type            valueType,
00673                                                 OTF2_MetricBase      metricBase,
00674                                                 int64_t              exponent,
00675                                                 OTF2_StringRef       unit );
00676 
00677 
00692 OTF2_ErrorCode
00693 OTF2_GlobalDefReaderCallbacks_SetMetricMemberCallback(
00694     OTF2_GlobalDefReaderCallbacks*            globalDefReaderCallbacks,
00695     OTF2_GlobalDefReaderCallback_MetricMember metricMemberCallback );
00696 
00697 
00722 typedef OTF2_CallbackCode
00723 ( *OTF2_GlobalDefReaderCallback_MetricClass )( void*                       userData,
00724                                                OTF2_MetricRef              self,
00725                                                uint8_t                     numberOfMetrics,
00726                                                const OTF2_MetricMemberRef* metricMembers,
00727                                                OTF2_MetricOccurrence       metricOccurrence,
00728                                                OTF2_RecorderKind           recorderKind );
00729 
00730 
00745 OTF2_ErrorCode
00746 OTF2_GlobalDefReaderCallbacks_SetMetricClassCallback(
00747     OTF2_GlobalDefReaderCallbacks*           globalDefReaderCallbacks,
00748     OTF2_GlobalDefReaderCallback_MetricClass metricClassCallback );
00749 
00750 
00778 typedef OTF2_CallbackCode
00779 ( *OTF2_GlobalDefReaderCallback_MetricInstance )( void*            userData,
00780                                                   OTF2_MetricRef   self,
00781                                                   OTF2_MetricRef   metricClass,
00782                                                   OTF2_LocationRef recorder,
00783                                                   OTF2_MetricScope metricScope,
00784                                                   uint64_t         scope );
00785 
00786 
00801 OTF2_ErrorCode
00802 OTF2_GlobalDefReaderCallbacks_SetMetricInstanceCallback(
00803     OTF2_GlobalDefReaderCallbacks*              globalDefReaderCallbacks,
00804     OTF2_GlobalDefReaderCallback_MetricInstance metricInstanceCallback );
00805 
00806 
00831 typedef OTF2_CallbackCode
00832 ( *OTF2_GlobalDefReaderCallback_Comm )( void*          userData,
00833                                         OTF2_CommRef   self,
00834                                         OTF2_StringRef name,
00835                                         OTF2_GroupRef  group,
00836                                         OTF2_CommRef   parent );
00837 
00838 
00853 OTF2_ErrorCode
00854 OTF2_GlobalDefReaderCallbacks_SetCommCallback(
00855     OTF2_GlobalDefReaderCallbacks*    globalDefReaderCallbacks,
00856     OTF2_GlobalDefReaderCallback_Comm commCallback );
00857 
00858 
00878 typedef OTF2_CallbackCode
00879 ( *OTF2_GlobalDefReaderCallback_Parameter )( void*              userData,
00880                                              OTF2_ParameterRef  self,
00881                                              OTF2_StringRef     name,
00882                                              OTF2_ParameterType parameterType );
00883 
00884 
00899 OTF2_ErrorCode
00900 OTF2_GlobalDefReaderCallbacks_SetParameterCallback(
00901     OTF2_GlobalDefReaderCallbacks*         globalDefReaderCallbacks,
00902     OTF2_GlobalDefReaderCallback_Parameter parameterCallback );
00903 
00904 
00924 typedef OTF2_CallbackCode
00925 ( *OTF2_GlobalDefReaderCallback_RmaWin )( void*          userData,
00926                                           OTF2_RmaWinRef self,
00927                                           OTF2_StringRef name,
00928                                           OTF2_CommRef   comm );
00929 
00930 
00945 OTF2_ErrorCode
00946 OTF2_GlobalDefReaderCallbacks_SetRmaWinCallback(
00947     OTF2_GlobalDefReaderCallbacks*      globalDefReaderCallbacks,
00948     OTF2_GlobalDefReaderCallback_RmaWin rmaWinCallback );
00949 
00950 
00969 typedef OTF2_CallbackCode
00970 ( *OTF2_GlobalDefReaderCallback_MetricClassRecorder )( void*            userData,
00971                                                        OTF2_MetricRef   metricClass,
00972                                                        OTF2_LocationRef recorder );
00973 
00974 
00989 OTF2_ErrorCode
00990 OTF2_GlobalDefReaderCallbacks_SetMetricClassRecorderCallback(
00991     OTF2_GlobalDefReaderCallbacks*                   globalDefReaderCallbacks,
00992     OTF2_GlobalDefReaderCallback_MetricClassRecorder metricClassRecorderCallback );
00993 
00994 
01015 typedef OTF2_CallbackCode
01016 ( *OTF2_GlobalDefReaderCallback_SystemTreeNodeProperty )( void*                  userData,
01017                                                           OTF2_SystemTreeNodeRef systemTreeNode,
01018                                                           OTF2_StringRef         name,
01019                                                           OTF2_StringRef         value );
01020 
01021 
01036 OTF2_ErrorCode
01037 OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodePropertyCallback(
01038     OTF2_GlobalDefReaderCallbacks*                      globalDefReaderCallbacks,
01039     OTF2_GlobalDefReaderCallback_SystemTreeNodeProperty systemTreeNodePropertyCallback );
01040 
01041 
01060 typedef OTF2_CallbackCode
01061 ( *OTF2_GlobalDefReaderCallback_SystemTreeNodeDomain )( void*                  userData,
01062                                                         OTF2_SystemTreeNodeRef systemTreeNode,
01063                                                         OTF2_SystemTreeDomain  systemTreeDomain );
01064 
01065 
01080 OTF2_ErrorCode
01081 OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodeDomainCallback(
01082     OTF2_GlobalDefReaderCallbacks*                    globalDefReaderCallbacks,
01083     OTF2_GlobalDefReaderCallback_SystemTreeNodeDomain systemTreeNodeDomainCallback );
01084 
01085 
01105 typedef OTF2_CallbackCode
01106 ( *OTF2_GlobalDefReaderCallback_LocationGroupProperty )( void*                 userData,
01107                                                          OTF2_LocationGroupRef locationGroup,
01108                                                          OTF2_StringRef        name,
01109                                                          OTF2_StringRef        value );
01110 
01111 
01126 OTF2_ErrorCode
01127 OTF2_GlobalDefReaderCallbacks_SetLocationGroupPropertyCallback(
01128     OTF2_GlobalDefReaderCallbacks*                     globalDefReaderCallbacks,
01129     OTF2_GlobalDefReaderCallback_LocationGroupProperty locationGroupPropertyCallback );
01130 
01131 
01150 typedef OTF2_CallbackCode
01151 ( *OTF2_GlobalDefReaderCallback_LocationProperty )( void*            userData,
01152                                                     OTF2_LocationRef location,
01153                                                     OTF2_StringRef   name,
01154                                                     OTF2_StringRef   value );
01155 
01156 
01171 OTF2_ErrorCode
01172 OTF2_GlobalDefReaderCallbacks_SetLocationPropertyCallback(
01173     OTF2_GlobalDefReaderCallbacks*                globalDefReaderCallbacks,
01174     OTF2_GlobalDefReaderCallback_LocationProperty locationPropertyCallback );
01175 
01176 
01197 typedef OTF2_CallbackCode
01198 ( *OTF2_GlobalDefReaderCallback_CartDimension )( void*                 userData,
01199                                                  OTF2_CartDimensionRef self,
01200                                                  OTF2_StringRef        name,
01201                                                  uint32_t              size,
01202                                                  OTF2_CartPeriodicity  cartPeriodicity );
01203 
01204 
01219 OTF2_ErrorCode
01220 OTF2_GlobalDefReaderCallbacks_SetCartDimensionCallback(
01221     OTF2_GlobalDefReaderCallbacks*             globalDefReaderCallbacks,
01222     OTF2_GlobalDefReaderCallback_CartDimension cartDimensionCallback );
01223 
01224 
01251 typedef OTF2_CallbackCode
01252 ( *OTF2_GlobalDefReaderCallback_CartTopology )( void*                        userData,
01253                                                 OTF2_CartTopologyRef         self,
01254                                                 OTF2_StringRef               name,
01255                                                 OTF2_CommRef                 communicator,
01256                                                 uint8_t                      numberOfDimensions,
01257                                                 const OTF2_CartDimensionRef* cartDimensions );
01258 
01259 
01274 OTF2_ErrorCode
01275 OTF2_GlobalDefReaderCallbacks_SetCartTopologyCallback(
01276     OTF2_GlobalDefReaderCallbacks*            globalDefReaderCallbacks,
01277     OTF2_GlobalDefReaderCallback_CartTopology cartTopologyCallback );
01278 
01279 
01302 typedef OTF2_CallbackCode
01303 ( *OTF2_GlobalDefReaderCallback_CartCoordinate )( void*                userData,
01304                                                   OTF2_CartTopologyRef cartTopology,
01305                                                   uint32_t             rank,
01306                                                   uint8_t              numberOfDimensions,
01307                                                   const uint32_t*      coordinates );
01308 
01309 
01324 OTF2_ErrorCode
01325 OTF2_GlobalDefReaderCallbacks_SetCartCoordinateCallback(
01326     OTF2_GlobalDefReaderCallbacks*              globalDefReaderCallbacks,
01327     OTF2_GlobalDefReaderCallback_CartCoordinate cartCoordinateCallback );
01328 
01329 
01330 #ifdef __cplusplus
01331 }
01332 #endif /* __cplusplus */
01333 
01334 
01335 #endif /* !OTF2_GLOBAL_DEF_READER_CALLBACKS_H */