EntryPoint.h

// -*- tab-width: 2; indent-tabs-mode: nil; coding: utf-8-with-signature -*-
//-----------------------------------------------------------------------------
// Copyright 2000-2026 CEA (www.cea.fr) IFPEN (www.ifpenergiesnouvelles.com)
// See the top-level COPYRIGHT file for details.
// SPDX-License-Identifier: Apache-2.0
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* EntryPoint.h                                                (C) 2000-2025 */
/*                                                                           */
/* Module entry point.                                                       */
/*---------------------------------------------------------------------------*/
#ifndef ARCANE_CORE_ENTRYPOINT_H
#define ARCANE_CORE_ENTRYPOINT_H
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/utils/String.h"
#include "arcane/utils/FunctorWithAddress.h"
#include "arcane/core/IEntryPoint.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
class Timer;
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT EntryPointBuildInfo
{
 public:

  EntryPointBuildInfo(IModule* module, const String& name,
                      IFunctor* caller, const String& where, int property,
                      bool is_destroy_caller)
  : m_module(module)
  , m_name(name)
  , m_caller(caller)
  , m_where(where)
  , m_property(property)
  , m_is_destroy_caller(is_destroy_caller)
  {
  }
 
 public:
 
  IModule* module() const { return m_module; }
  const String& name() const { return m_name; }
  IFunctor* caller() const { return m_caller; }
  const String& where() const { return m_where; }
  int property() const { return m_property; }
  bool isDestroyCaller() const { return m_is_destroy_caller; }
 
 private:
 
  IModule* m_module;
  String m_name;
  IFunctor* m_caller;
  String m_where;
  int m_property;
  bool m_is_destroy_caller;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

class ARCANE_CORE_EXPORT EntryPoint
: public IEntryPoint
{
 public:

  ~EntryPoint() override;
 
 public:

  static EntryPoint* create(const EntryPointBuildInfo& bi);
 
 public:
 
  String name() const override { return m_name; }
  String fullName() const override { return m_full_name; }
  ISubDomain* subDomain() const override { return m_sub_domain; }
  IModule* module() const override { return m_module; }
  void executeEntryPoint() override;
  Real totalCPUTime() const override;
  Real lastCPUTime() const override;
  Real totalElapsedTime() const override;
  Real lastElapsedTime() const override;
  Real totalTime(Timer::eTimerType type) const override;
  Real lastTime(Timer::eTimerType type) const override;
  Integer nbCall() const override { return m_nb_call; }
  String where() const override { return m_where; }
  int property() const override { return m_property; }
 
 private:
 
  ISubDomain* m_sub_domain = nullptr; 
  IFunctor* m_caller = nullptr; 
  Timer* m_elapsed_timer = nullptr; 
  String m_name; 
  String m_full_name; 
  IModule* m_module = nullptr; 
  String m_where; 
  int m_property = 0; 
  Integer m_nb_call = 0; 
  bool m_is_destroy_caller = false; 
 
 private:
 
  explicit EntryPoint(const EntryPointBuildInfo& build_info);
 
 public:
 
  EntryPoint(const EntryPoint&) = delete;
  void operator=(const EntryPoint&) = delete;
 
 private:
 
  void _getAddressForHyoda(void* = nullptr);
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <typename ModuleType> inline void
addEntryPoint(ModuleType* module, const char* name, void (ModuleType::*func)(),
              const String& where = IEntryPoint::WComputeLoop,
              int property = IEntryPoint::PNone)
{
  IFunctorWithAddress* caller = new FunctorWithAddressT<ModuleType>(module, func);
  EntryPoint::create(EntryPointBuildInfo(module, name, caller, where, property, true));
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

template <typename ModuleType> inline void
addEntryPoint(ModuleType* module, const String& name, void (ModuleType::*func)(),
              const String& where = IEntryPoint::WComputeLoop,
              int property = IEntryPoint::PNone)
{
  IFunctorWithAddress* caller = new FunctorWithAddressT<ModuleType>(module, func);
  EntryPoint::create(EntryPointBuildInfo(module, name, caller, where, property, true));
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#endif