-/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#define SIMGRID_S4U_ENGINE_HPP
#include <xbt/base.h>
-#include <xbt/functional.hpp>
#include <simgrid/forward.h>
-#include <simgrid/simix.hpp>
+#include <simgrid/kernel/resource/Model.hpp>
#include <simgrid/s4u/NetZone.hpp>
#include <string>
* This is a singleton containing all the main functions of the simulation.
*/
class XBT_PUBLIC Engine {
+#ifndef DOXYGEN
friend simgrid::kernel::EngineImpl;
+#endif
public:
+ /** Constructor, taking only the name of your main function */
+ explicit Engine(std::string name);
/** Constructor, taking the command line parameters of your main function */
explicit Engine(int* argc, char** argv);
/* Currently, only one instance is allowed to exist. This is why you can't copy or move it */
#endif
/** Finalize the default engine and all its dependencies */
- static void shutdown();
+ void shutdown();
- /** Run the simulation after initialization */
+ /** Run the simulation until its end */
void run() const;
+ /** Run the simulation until the specified date */
+ void run_until(double max_date) const;
+
/** @brief Retrieve the simulation time (in seconds) */
static double get_clock();
/** @brief Retrieve the engine singleton */
static s4u::Engine* get_instance();
+ static s4u::Engine* get_instance(int* argc, char** argv);
+ static bool has_instance() { return instance_ != nullptr; }
void load_platform(const std::string& platf) const;
- XBT_ATTRIB_DEPRECATED_v330("Please change the return code of your actors to void") void register_function(
- const std::string& name, int (*code)(int, char**));
-
void register_function(const std::string& name, const std::function<void(int, char**)>& code);
void register_function(const std::string& name, const std::function<void(std::vector<std::string>)>& code);
+ void register_function(const std::string& name, const kernel::actor::ActorCodeFactory& factory);
- XBT_ATTRIB_DEPRECATED_v330("Please change the return code of your actors to void") void register_default(
- int (*code)(int, char**));
void register_default(const std::function<void(int, char**)>& code);
void register_default(const kernel::actor::ActorCodeFactory& factory);
- void register_function(const std::string& name, const kernel::actor::ActorCodeFactory& factory);
template <class F> void register_actor(const std::string& name)
{
kernel::actor::ActorCodeFactory code_factory = [](std::vector<std::string> args) {
- return kernel::actor::ActorCode([args] {
+ return kernel::actor::ActorCode([args = std::move(args)]() mutable {
F code(std::move(args));
code();
});
};
- register_function(name, std::move(code_factory));
+ register_function(name, code_factory);
}
template <class F> void register_actor(const std::string& name, F code)
{
kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
- return kernel::actor::ActorCode([code, args] { code(std::move(args)); });
+ return kernel::actor::ActorCode([code, args = std::move(args)]() mutable { code(std::move(args)); });
};
- register_function(name, std::move(code_factory));
+ register_function(name, code_factory);
}
- void load_deployment(const std::string& deploy);
+ void load_deployment(const std::string& deploy) const;
protected:
#ifndef DOXYGEN
friend Host;
friend Link;
friend Disk;
- friend Storage;
friend kernel::routing::NetPoint;
friend kernel::routing::NetZoneImpl;
+ friend kernel::resource::HostImpl;
friend kernel::resource::LinkImpl;
void host_register(const std::string& name, Host* host);
void host_unregister(const std::string& name);
void link_register(const std::string& name, const Link* link);
void link_unregister(const std::string& name);
- void storage_register(const std::string& name, const Storage* storage);
- void storage_unregister(const std::string& name);
void netpoint_register(simgrid::kernel::routing::NetPoint* card);
void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
#endif /*DOXYGEN*/
std::vector<Link*> get_all_links() const;
std::vector<Link*> get_filtered_links(const std::function<bool(Link*)>& filter) const;
Link* link_by_name(const std::string& name) const;
+ /**
+ * @brief Find a split-duplex link from its name.
+ * @throw std::invalid_argument if the searched link does not exist.
+ */
+ SplitDuplexLink* split_duplex_link_by_name(const std::string& name) const;
Link* link_by_name_or_null(const std::string& name) const;
+ Mailbox* mailbox_by_name_or_create(const std::string& name) const;
+
size_t get_actor_count() const;
std::vector<ActorPtr> get_all_actors() const;
std::vector<ActorPtr> get_filtered_actors(const std::function<bool(ActorPtr)>& filter) const;
-#ifndef DOXYGEN
- size_t get_storage_count() const;
- std::vector<Storage*> get_all_storages() const;
- Storage* storage_by_name(const std::string& name) const;
- Storage* storage_by_name_or_null(const std::string& name) const;
-#endif
-
std::vector<kernel::routing::NetPoint*> get_all_netpoints() const;
kernel::routing::NetPoint* netpoint_by_name_or_null(const std::string& name) const;
+ /**
+ * @brief Get netpoint by its name
+ *
+ * @param name Netpoint name
+ * @throw std::invalid_argument if netpoint doesn't exist
+ */
+ kernel::routing::NetPoint* netpoint_by_name(const std::string& name) const;
NetZone* get_netzone_root() const;
void set_netzone_root(const NetZone* netzone);
NetZone* netzone_by_name_or_null(const std::string& name) const;
+ /**
+ * @brief Add a model to engine list
+ *
+ * @param model Pointer to model
+ * @param dependencies List of dependencies for this model (optional)
+ */
+ void add_model(std::shared_ptr<simgrid::kernel::resource::Model> model,
+ const std::vector<kernel::resource::Model*>& dependencies = {});
+
+ /** @brief Get list of all models managed by this engine */
+ const std::vector<simgrid::kernel::resource::Model*>& get_all_models() const;
+
/** @brief Retrieves all netzones of the type indicated by the template argument */
template <class T> std::vector<T*> get_filtered_netzones() const
{
return res;
}
+ kernel::EngineImpl* get_impl() const { return pimpl; }
+
/** Returns whether SimGrid was initialized yet -- mostly for internal use */
static bool is_initialized();
/** @brief set a configuration variable
* @endrst
*
* Example:
- * e->set_config("host/model:ptask_L07");
+ * simgrid::s4u::Engine::set_config("host/model:ptask_L07");
*/
- void set_config(const std::string& str);
- void set_config(const std::string& name, int value);
- void set_config(const std::string& name, bool value);
- void set_config(const std::string& name, double value);
- void set_config(const std::string& name, const std::string& value);
+ static void set_config(const std::string& str);
+ static void set_config(const std::string& name, int value);
+ static void set_config(const std::string& name, bool value);
+ static void set_config(const std::string& name, double value);
+ static void set_config(const std::string& name, const std::string& value);
+ Engine* set_default_comm_data_copy_callback(void (*callback)(kernel::activity::CommImpl*, void*, size_t));
/** Callback fired when the platform is created (ie, the xml file parsed),
* right before the actual simulation starts. */
static xbt::signal<void()> on_platform_created;
private:
kernel::EngineImpl* const pimpl;
static Engine* instance_;
+ void initialize(int* argc, char** argv);
};
#ifndef DOXYGEN /* Internal use only, no need to expose it */
"Filtering netzones is only possible for subclasses of kernel::routing::NetZoneImpl");
for (auto const& elem : current->get_children()) {
get_filtered_netzones_recursive(elem, whereto);
- T* elem_impl = dynamic_cast<T*>(elem->get_impl());
+ auto* elem_impl = dynamic_cast<T*>(elem->get_impl());
if (elem_impl != nullptr)
whereto->push_back(elem_impl);
}
