GlobalContext.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2020-2026 The ESPResSo project
 *
 * This file is part of ESPResSo.
 *
 * ESPResSo is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * ESPResSo is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
/** @file
 *
 *  Infrastructure to synchronize objects created on the head node
 *  with their corresponding remote copies.
 *
 *  Implementation in @ref GlobalContext.cpp.
 */
 
#include "Context.hpp"
#include "LocalContext.hpp"
#include "ObjectHandle.hpp"
#include "ObjectId.hpp"
#include "ParallelExceptionHandler.hpp"
#include "packed_variant.hpp"
 
#include "core/MpiCallbacks.hpp"
 
#include <utils/Factory.hpp>
 
#include <boost/mpi/communicator.hpp>
#include <boost/serialization/utility.hpp>
 
#include <cstddef>
#include <memory>
#include <stdexcept>
#include <string>
#include <string_view>
#include <unordered_map>
#include <utility>
 
namespace ScriptInterface {
 
/**
 * @brief Global synchronizing context.
 *
 * Objects created in this context are synchronized
 * between multiple MPI ranks. That is, for each instance
 * created on the head node, a copy is created on all
 * other ranks. If the original copy is mutated via
 * @ref notify_set_parameter(), this change is also applied to all the
 * copies. Calls to @ref notify_call_method() are also propagated to all
 * ranks. The lifetime of the copies is tied to the original,
 * if the original copy is destroyed on the head node,
 * the remote copies are also destroyed.
 */
class GlobalContext : public Context {
  using ObjectId = ScriptInterface::ObjectId;
 
  /* Instances on this node that are managed by the
   * head node. */
  std::unordered_map<ObjectId, ObjectRef> m_local_objects;
 
  std::shared_ptr<LocalContext> m_node_local_context;
 
  boost::mpi::communicator const &m_comm;
  bool m_is_head_node;
 
  ParallelExceptionHandler m_parallel_exception_handler;
 
  Communication::CallbackHandle<ObjectId, const std::string &,
                                PackedMap const &>
      cb_make_handle;
  Communication::CallbackHandle<ObjectId, const std::string &,
                                PackedVariant const &>
      cb_set_parameter;
  Communication::CallbackHandle<ObjectId, std::string const &,
                                PackedMap const &>
      cb_call_method;
  Communication::CallbackHandle<ObjectId> cb_delete_handle;
 
public:
  GlobalContext(std::shared_ptr<Communication::MpiCallbacks> const &callbacks,
                std::shared_ptr<LocalContext> node_local_context)
      : m_local_objects(), m_node_local_context(std::move(node_local_context)),
        m_comm(callbacks->comm()), m_is_head_node(m_comm.rank() == 0),
        // NOLINTNEXTLINE(bugprone-throw-keyword-missing)
        m_parallel_exception_handler(m_comm),
        cb_make_handle(callbacks,
                       [this](ObjectId id, std::string const &name,
                              PackedMap const &parameters) {
                         make_handle(id, name, parameters);
                       }),
        cb_set_parameter(callbacks,
                         [this](ObjectId id, std::string const &name,
                                PackedVariant const &value) {
                           set_parameter(id, name, value);
                         }),
        cb_call_method(callbacks,
                       [this](ObjectId id, std::string const &name,
                              PackedMap const &arguments) {
                         call_method(id, name, arguments);
                       }),
        cb_delete_handle(callbacks,
                         [this](ObjectId id) { delete_handle(id); }) {}
 
private:
  /**
   * @brief Callback for @c cb_make_handle
   */
  void make_handle(ObjectId id, std::string const &name,
                   PackedMap const &parameters);
  /**
   * @brief Create remote instances
   *
   * @param id Internal identifier of the instance
   * @param name Class name
   * @param parameters Constructor parameters.
   */
  void remote_make_handle(ObjectId id, std::string const &name,
                          VariantMap const &parameters);
 
private:
  /**
   * @brief Callback for @c cb_set_parameter
   */
  void set_parameter(ObjectId id, std::string const &name,
                     PackedVariant const &value);
 
public:
  void notify_set_parameter(ObjectHandle const *o, std::string const &name,
                            Variant const &value) override;
 
private:
  /**
   * @brief Callback for @c cb_call_method
   */
  void call_method(ObjectId id, std::string const &name,
                   PackedMap const &arguments);
 
public:
  void notify_call_method(ObjectHandle const *o, std::string const &name,
                          VariantMap const &arguments) override;
 
private:
  /**
   * @brief Callback for @c cb_delete_handle
   */
  void delete_handle(ObjectId id) { m_local_objects.erase(id); }
 
public:
  /**
   * @brief Get a new reference counted instance of a script interface
   * object by name.
   *
   * Remote objects are automatically constructed.
   */
  std::shared_ptr<ObjectHandle>
  make_shared(std::string const &name, VariantMap const &parameters) override;
 
  std::string_view name(ObjectHandle const *o) const override;
 
  bool is_head_node() const override { return m_is_head_node; }
  void parallel_try_catch(std::function<void()> const &cb) const override {
    m_parallel_exception_handler.parallel_try_catch<std::exception>(cb);
  }
  boost::mpi::communicator const &get_comm() const override { return m_comm; }
};
} // namespace ScriptInterface