ProfilingHooks.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright (C) 2021 Stellar Science; U.S. Government has Unlimited Rights.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef PROFILINGHOOKS_HPP
#define PROFILINGHOOKS_HPP

 
#include "profiling_export.h"
 
#include <cstdint>
#include <string>
 
#include <UtOptional.hpp>
 
#include "ProfilingCommon.hpp"
 
namespace profiling
{
using ProfilingInterfaceVersionFunc = uint64_t (*)();

constexpr const char cPROFILING_INTERFACE_VERSION_SYMBOL[] = "AfsimProfilingInterfaceVersion";

using ProfilingInitializeFunc = int32_t (*)(const char*);

constexpr const char cPROFILING_INITIALIZE_SYMBOL[] = "AfsimProfilingInitialize";

using BeginProfilingRegionFunc = void (*)(const char*);

constexpr const char cPROFILING_BEGIN_REGION_SYMBOL[] = "AfsimProfilingBeginRegion";

using EndProfilingRegionFunc = void (*)();

constexpr const char cPROFILING_END_REGION_SYMBOL[] = "AfsimProfilingEndRegion";

using CreateProfilingSectionFunc = uint32_t (*)(const char*);

constexpr const char cPROFILING_CREATE_SECTION_SYMBOL[] = "AfsimProfilingCreateSection";

using DestroyProfilingSectionFunc = void (*)(uint32_t);

constexpr const char cPROFILING_DESTROY_SECTION_SYMBOL[] = "AfsimProfilingDestroySection";

using BeginProfilingSectionFunc = void (*)(uint32_t);

constexpr const char cPROFILING_BEGIN_SECTION_SYMBOL[] = "AfsimProfilingBeginSection";

using EndProfilingSectionFunc = void (*)(uint32_t);

constexpr const char cPROFILING_END_SECTION_SYMBOL[] = "AfsimProfilingEndSection";

using ProfilingFinalizeFunc = void (*)();

constexpr const char cPROFILING_FINALIZE_SYMBOL[] = "AfsimProfilingFinalize";

struct PROFILING_EXPORT ProfilingHooks
{
   ProfilingInterfaceVersionFunc mInterfaceVersion = nullptr;

   ProfilingInitializeFunc mInitialize = nullptr;

   BeginProfilingRegionFunc mBeginRegion = nullptr;

   EndProfilingRegionFunc mEndRegion = nullptr;

   CreateProfilingSectionFunc mCreateSection = nullptr;

   DestroyProfilingSectionFunc mDestroySection = nullptr;

   BeginProfilingSectionFunc mBeginSection = nullptr;

   EndProfilingSectionFunc mEndSection = nullptr;

   ProfilingFinalizeFunc mFinalize = nullptr;
};
 
} // namespace profiling
 
#endif // PROFILINGHOOKS_HPP