ArcaneSimpleExecutor.cc

// -*- 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
//-----------------------------------------------------------------------------
/*---------------------------------------------------------------------------*/
/* ArcaneSimpleExecutor.cc                                     (C) 2000-2026 */
/*                                                                           */
/* Class allowing code to be executed directly via Arcane.                   */
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
#include "arcane/impl/ArcaneSimpleExecutor.h"
 
#include "arcane/utils/NotImplementedException.h"
#include "arcane/utils/FatalErrorException.h"
#include "arcane/utils/TraceClassConfig.h"
#include "arcane/utils/ITraceMng.h"
#include "arcane/utils/ApplicationInfo.h"
 
#include "arcane/core/Parallel.h"
 
#include "arcane/impl/ArcaneMain.h"
#include "arcane/impl/MainFactory.h"
#include "arcane/impl/internal/ArcaneMainExecInfo.h"
 
#include "arcane/core/SubDomainBuildInfo.h"
#include "arcane/core/ISession.h"
#include "arcane/core/ICodeService.h"
#include "arcane/core/IApplication.h"
#include "arcane/core/IParallelSuperMng.h"
#include "arcane/core/IParallelMng.h"
#include "arcane/core/ITimeStats.h"
#include "arcane/core/IIOMng.h"
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
namespace Arcane
{
extern "C++" ARCANE_IMPL_EXPORT Ref<ICodeService>
createArcaneCodeService(IApplication* app);
 
class ArcaneSimpleExecutorMainFactory
: public MainFactory
{
 public:
 
  // NOTE: This method must be implemented to inherit from MainFactory
  // but it will not be used in the case of direct execution
  // (it is always an instance of ArcaneMain() that will be created)
  IArcaneMain* createArcaneMain(const ApplicationInfo& app_info) override
  {
    return new ArcaneMain(app_info, this);
  }
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
class ArcaneSimpleExecutor::Impl
{
 public:
 
  Impl()
  {
    ArcaneMain::arcaneInitialize();
  }
  ~Impl() noexcept(false)
  {
    for (ITimeStats* ts : m_time_stats_list) {
      ts->endGatherStats();
      delete ts;
    }
    if (m_arcane_main) {
      m_arcane_main->finalize();
      delete m_arcane_main;
    }
    delete m_main_factory;
    ArcaneMain::arcaneFinalize();
  }
 
 public:
 
  ArcaneMainExecInfo* m_arcane_main = nullptr;
  ArcaneSimpleExecutorMainFactory* m_main_factory = nullptr;
  ApplicationBuildInfo m_application_build_info;
  bool m_has_minimal_verbosity_level = false;
  bool m_has_output_level = false;
  UniqueArray<ITimeStats*> m_time_stats_list;
};
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
ArcaneSimpleExecutor::
ArcaneSimpleExecutor()
: m_p(new Impl())
{
  const ApplicationInfo& app_info = ArcaneMain::defaultApplicationInfo();
  const CommandLineArguments& cmd_line_args = app_info.commandLineArguments();
  auto& build_info = m_p->m_application_build_info;
  build_info.parseArguments(cmd_line_args);
  // By default, there are no configuration files in the case
  // of direct execution.
  build_info.setConfigFileName(String());
 
  // By default, limit the verbosity level of the initialization
  // This prevents displaying version information.
  _setDefaultVerbosityLevel(1);
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
ArcaneSimpleExecutor::
~ArcaneSimpleExecutor() noexcept(false)
{
  delete m_p;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
void ArcaneSimpleExecutor::
_checkInit()
{
  if (!m_p->m_arcane_main)
    ARCANE_FATAL("This instance is not initialized. Call initialize() method");
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/

void ArcaneSimpleExecutor::
_setDefaultVerbosityLevel(Integer level)
{
  auto& build_info = m_p->m_application_build_info;
 
  m_p->m_has_minimal_verbosity_level = (build_info.minimalVerbosityLevel() != Trace::UNSPECIFIED_VERBOSITY_LEVEL);
  m_p->m_has_output_level = (build_info.outputLevel() != Trace::UNSPECIFIED_VERBOSITY_LEVEL);
 
  if (!m_p->m_has_minimal_verbosity_level)
    build_info.setMinimalVerbosityLevel(level);
  if (!m_p->m_has_output_level)
    build_info.setOutputLevel(level);
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
int ArcaneSimpleExecutor::
initialize()
{
  if (m_p->m_arcane_main)
    ARCANE_FATAL("This instance is already initialized");
 
  const ApplicationInfo& app_info = ArcaneMain::defaultApplicationInfo();
  auto factory = new ArcaneSimpleExecutorMainFactory();
  m_p->m_main_factory = factory;
  m_p->m_arcane_main = new ArcaneMainExecInfo(app_info, m_p->m_application_build_info, factory);
 
  int r = m_p->m_arcane_main->initialize();
  return r;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
int ArcaneSimpleExecutor::
runCode(IFunctor* f)
{
  if (!m_p->m_arcane_main)
    ARCANE_FATAL("This instance is not yet initialized");
  if (!f)
    return 0;
  IArcaneMain* am = m_p->m_arcane_main->arcaneMainClass();
  bool clean_abort = false;
  bool is_print = true;
  return ArcaneMain::callFunctorWithCatchedException(f, am, &clean_abort, is_print);
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
ApplicationBuildInfo& ArcaneSimpleExecutor::
applicationBuildInfo()
{
  return m_p->m_application_build_info;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
const ApplicationBuildInfo& ArcaneSimpleExecutor::
applicationBuildInfo() const
{
  return m_p->m_application_build_info;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
ISubDomain* ArcaneSimpleExecutor::
createSubDomain(const String& case_file_name, Span<const std::byte> file_content)
{
  _checkInit();
  IApplication* app = m_p->m_arcane_main->arcaneMainClass()->application();
  ITraceMng* tr = app->traceMng();
  if (!m_p->m_has_minimal_verbosity_level)
    tr->setVerbosityLevel(Trace::DEFAULT_VERBOSITY_LEVEL);
  if (!m_p->m_has_output_level)
    tr->setStandardOutputVerbosityLevel(Trace::DEFAULT_VERBOSITY_LEVEL);
  IMainFactory* main_factory = app->mainFactory();
  // TODO: use the code service specified in ApplicationInfo.
  Ref<ICodeService> code_service = createArcaneCodeService(app);
  ISession* session(code_service->createSession());
  IParallelSuperMng* psm = app->parallelSuperMng();
  Ref<IParallelMng> world_pm = psm->internalCreateWorldParallelMng(0);
 
  SubDomainBuildInfo sdbi(world_pm, 0);
  UniqueArray<Byte> case_bytes;
  bool has_case_file = !case_file_name.empty();
  if (has_case_file) {
    sdbi.setCaseFileName(case_file_name);
    if (file_content.empty()) {
      bool is_bad = app->ioMng()->collectiveRead(case_file_name, case_bytes);
      if (is_bad)
        ARCANE_FATAL("Can not read case file '{0}'", case_file_name);
      sdbi.setCaseBytes(case_bytes);
      tr->info() << "Create sub domain with case file '" << case_file_name << "'";
    }
    else {
      sdbi.setCaseContent(file_content);
    }
  }
  else {
    sdbi.setCaseFileName({});
    if (file_content.empty())
      sdbi.setCaseBytes({});
    else
      sdbi.setCaseContent(file_content);
  }
  // The statistics service must be explicitly destroyed
  ITimeStats* time_stat = main_factory->createTimeStats(world_pm->timerMng(), tr, "Stats");
  time_stat->beginGatherStats();
  m_p->m_time_stats_list.add(time_stat);
  world_pm->setTimeStats(time_stat);
 
  ISubDomain* sub_domain(session->createSubDomain(sdbi));
  if (has_case_file) {
    code_service->initCase(sub_domain, false);
  }
  return sub_domain;
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
ISubDomain* ArcaneSimpleExecutor::
createSubDomain(const String& case_file_name)
{
  return createSubDomain(case_file_name, {});
}
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
 
} // End namespace Arcane
 
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/