OTF2_Callbacks.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-2014, 2021,
 * 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_CALLBACKS_H
#define OTF2_CALLBACKS_H


#ifndef __cplusplus
#include <stdbool.h>
#endif


#include <otf2/OTF2_ErrorCodes.h>


#include <otf2/OTF2_GeneralDefinitions.h>


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


typedef OTF2_FlushType
( * OTF2_PreFlushCallback )( void*            userData,
                             OTF2_FileType    fileType,
                             OTF2_LocationRef location,
                             void*            callerData,
                             bool final );


typedef OTF2_TimeStamp
( * OTF2_PostFlushCallback )( void*            userData,
                              OTF2_FileType    fileType,
                              OTF2_LocationRef location );


typedef struct OTF2_FlushCallbacks
{
    OTF2_PreFlushCallback  otf2_pre_flush;
    OTF2_PostFlushCallback otf2_post_flush;
} OTF2_FlushCallbacks;


typedef void*
( * OTF2_MemoryAllocate )( void*            userData,
                           OTF2_FileType    fileType,
                           OTF2_LocationRef location,
                           void**           perBufferData,
                           uint64_t         chunkSize );


typedef void
( * OTF2_MemoryFreeAll )( void*            userData,
                          OTF2_FileType    fileType,
                          OTF2_LocationRef location,
                          void**           perBufferData,
                          bool final );


typedef struct OTF2_MemoryCallbacks
{
    OTF2_MemoryAllocate otf2_allocate;
    OTF2_MemoryFreeAll  otf2_free_all;
} OTF2_MemoryCallbacks;


typedef struct OTF2_CollectiveContext OTF2_CollectiveContext;

#define OTF2_COLLECTIVES_ROOT 0


typedef OTF2_CallbackCode
( * OTF2_Collectives_GetSize )( void*                   userData,
                                OTF2_CollectiveContext* commContext,
                                uint32_t*               size );


typedef OTF2_CallbackCode
( * OTF2_Collectives_GetRank )( void*                   userData,
                                OTF2_CollectiveContext* commContext,
                                uint32_t*               rank );


typedef OTF2_CallbackCode
( * OTF2_Collectives_CreateLocalComm )( void*                    userData,
                                        OTF2_CollectiveContext** localCommContext,
                                        OTF2_CollectiveContext*  globalCommContext,
                                        uint32_t                 globalRank,
                                        uint32_t                 globalSize,
                                        uint32_t                 localRank,
                                        uint32_t                 localSize,
                                        uint32_t                 fileNumber,
                                        uint32_t                 numberOfFiles );


typedef OTF2_CallbackCode
( * OTF2_Collectives_FreeLocalComm )( void*                   userData,
                                      OTF2_CollectiveContext* localCommContext );


typedef OTF2_CallbackCode
( * OTF2_Collectives_Barrier )( void*                   userData,
                                OTF2_CollectiveContext* commContext );


typedef OTF2_CallbackCode
( * OTF2_Collectives_Bcast )( void*                   userData,
                              OTF2_CollectiveContext* commContext,
                              void*                   data,
                              uint32_t                numberElements,
                              OTF2_Type               type,
                              uint32_t                root );


typedef OTF2_CallbackCode
( * OTF2_Collectives_Gather )( void*                   userData,
                               OTF2_CollectiveContext* commContext,
                               const void*             inData,
                               void*                   outData,
                               uint32_t                numberElements,
                               OTF2_Type               type,
                               uint32_t                root );


typedef OTF2_CallbackCode
( * OTF2_Collectives_Gatherv )( void*                   userData,
                                OTF2_CollectiveContext* commContext,
                                const void*             inData,
                                uint32_t                inElements,
                                void*                   outData,
                                const uint32_t*         outElements,
                                OTF2_Type               type,
                                uint32_t                root );


typedef OTF2_CallbackCode
( * OTF2_Collectives_Scatter )( void*                   userData,
                                OTF2_CollectiveContext* commContext,
                                const void*             inData,
                                void*                   outData,
                                uint32_t                numberElements,
                                OTF2_Type               type,
                                uint32_t                root );


typedef OTF2_CallbackCode
( * OTF2_Collectives_Scatterv )( void*                   userData,
                                 OTF2_CollectiveContext* commContext,
                                 const void*             inData,
                                 const uint32_t*         inElements,
                                 void*                   outData,
                                 uint32_t                outElements,
                                 OTF2_Type               type,
                                 uint32_t                root );


typedef void
( * OTF2_Collectives_Release )( void*                   userData,
                                OTF2_CollectiveContext* globalCommContext,
                                OTF2_CollectiveContext* localCommContext );


typedef struct OTF2_CollectiveCallbacks
{
    OTF2_Collectives_Release         otf2_release;
    OTF2_Collectives_GetSize         otf2_get_size;
    OTF2_Collectives_GetRank         otf2_get_rank;
    OTF2_Collectives_CreateLocalComm otf2_create_local_comm;
    OTF2_Collectives_FreeLocalComm   otf2_free_local_comm;
    OTF2_Collectives_Barrier         otf2_barrier;
    OTF2_Collectives_Bcast           otf2_bcast;
    OTF2_Collectives_Gather          otf2_gather;
    OTF2_Collectives_Gatherv         otf2_gatherv;
    OTF2_Collectives_Scatter         otf2_scatter;
    OTF2_Collectives_Scatterv        otf2_scatterv;
} OTF2_CollectiveCallbacks;


typedef struct OTF2_LockObject* OTF2_Lock;


typedef OTF2_CallbackCode
( * OTF2_Locking_Create )( void*      userData,
                           OTF2_Lock* lock );


typedef OTF2_CallbackCode
( * OTF2_Locking_Destroy )( void*     userData,
                            OTF2_Lock lock );


typedef OTF2_CallbackCode
( * OTF2_Locking_Lock )( void*     userData,
                         OTF2_Lock lock );


typedef OTF2_CallbackCode
( * OTF2_Locking_Unlock )( void*     userData,
                           OTF2_Lock lock );


typedef void
( * OTF2_Locking_Release )( void* userData );


typedef struct OTF2_LockingCallbacks
{
    OTF2_Locking_Release otf2_release;
    OTF2_Locking_Create  otf2_create;
    OTF2_Locking_Destroy otf2_destroy;
    OTF2_Locking_Lock    otf2_lock;
    OTF2_Locking_Unlock  otf2_unlock;
} OTF2_LockingCallbacks;


#ifdef __cplusplus
}
#endif /* __cplusplus */


#endif /* !OTF2_CALLBACKS_H */