-/* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2023. 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. */
#endif
/** Finalize the default engine and all its dependencies */
- void shutdown();
+ XBT_ATTRIB_DEPRECATED_v335("Users are not supposed to shutdown the Engine") void shutdown();
/** Run the simulation until its end */
void run() const;
static s4u::Engine* get_instance();
static s4u::Engine* get_instance(int* argc, char** argv);
static bool has_instance() { return instance_ != nullptr; }
+ const std::vector<std::string>& get_cmdline() const;
+ /**
+ * Creates a new platform, including hosts, links, and the routing table.
+ *
+ * @beginrst
+ * See also: :ref:`platform`.
+ * @endrst
+ */
void load_platform(const std::string& platf) const;
+ /**
+ * @brief Seals the platform, finishing the creation of its resources.
+ *
+ * This method is optional. The seal() is done automatically when you call Engine::run.
+ */
void seal_platform() const;
+ /** @brief Get a debug output of the platform.
+ *
+ * It looks like a XML platform file, but it may be very different from the input platform file: All netzones are
+ * flatified into a unique zone. This representation is mostly useful to debug your platform configuration and ensure
+ * that your assumptions over your configuration hold. This enables you to verify the exact list of links traversed
+ * between any two hosts, and the characteristics of every host and link. But you should not use the resulting file as
+ * an input platform file: it is very verbose, and thus much less efficient (in parsing time and runtime performance)
+ * than a regular platform file with the sufficient amount of intermediary netzones. Even if you use one zone only,
+ * specialized zones (such as clusters) are more efficient than the one with fully explicit routing used here.
+ */
+ std::string flatify_platform() const;
+ /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function taking classical argc/argv parameters. See the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
void register_function(const std::string& name, const std::function<void(int, char**)>& code);
+ /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function taking a vector of strings as a parameter. See the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
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);
+ /** @verbatim embed:rst:inline Provide a default function to be used when the name used in a :ref:`pf_tag_actor` tag was not binded with ``register_function`` nor ``register_actor``. @endverbatim */
void register_default(const std::function<void(int, char**)>& code);
void register_default(const kernel::actor::ActorCodeFactory& factory);
+ /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a class name passed as a template parameter. See the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
template <class F> void register_actor(const std::string& name)
{
kernel::actor::ActorCodeFactory code_factory = [](std::vector<std::string> args) {
};
register_function(name, code_factory);
}
+ /** @verbatim embed:rst:inline Bind an actor name that could be found in :ref:`pf_tag_actor` tag to a function name passed as a parameter. See the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
template <class F> void register_actor(const std::string& name, F code)
{
kernel::actor::ActorCodeFactory code_factory = [code](std::vector<std::string> args) {
/** If non-null, the provided set will be filled with all activities that fail to start because of a veto */
void track_vetoed_activities(std::set<Activity*>* vetoed_activities) const;
+ /** @verbatim embed:rst:inline Load a deployment file. See:ref:`deploy` and the :ref:`example <s4u_ex_actors_create>`. @endverbatim */
void load_deployment(const std::string& deploy) const;
protected:
friend kernel::routing::NetZoneImpl;
friend kernel::resource::HostImpl;
friend kernel::resource::StandardLinkImpl;
- 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 netpoint_register(simgrid::kernel::routing::NetPoint* card);
void netpoint_unregister(simgrid::kernel::routing::NetPoint* card);
+ void set_netzone_root(const NetZone* netzone);
#endif /*DOXYGEN*/
public:
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;
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));
+ Engine*
+ set_default_comm_data_copy_callback(const std::function<void(kernel::activity::CommImpl*, void*, size_t)>& callback);
/** Add a callback fired when the platform is created (ie, the xml file parsed),
* right before the actual simulation starts. */
/** Add a callback fired when the platform is about to be created
* (ie, after any configuration change and just before the resource creation) */
static void on_platform_creation_cb(const std::function<void()>& cb) { on_platform_creation.connect(cb); }
+ /** Add a callback fired when the main simulation loop starts, at the beginning of the first call to Engine::run() */
+ static void on_simulation_start_cb(const std::function<void()>& cb) { on_simulation_start.connect(cb); }
/** Add a callback fired when the main simulation loop ends, just before the end of Engine::run() */
static void on_simulation_end_cb(const std::function<void()>& cb) { on_simulation_end.connect(cb); }
- /** Add a callback fired when the time jumps into the future */
+ /** Add a callback fired when the time jumps into the future.
+ *
+ * It is fired right after the time change (use get_clock() to get the new timestamp).
+ * The callback parameter is the time delta since previous timestamp. */
static void on_time_advance_cb(const std::function<void(double)>& cb) { on_time_advance.connect(cb); }
/** Add a callback fired when the time cannot advance because of inter-actors deadlock. Note that the on_exit of each
static xbt::signal<void()> on_platform_created;
static xbt::signal<void()> on_platform_creation;
#endif
+
private:
- static xbt::signal<void()> on_simulation_end;
+ static xbt::signal<void()> on_simulation_start;
static xbt::signal<void(double)> on_time_advance;
static xbt::signal<void(void)> on_deadlock;
+ static xbt::signal<void()> on_simulation_end;
+
kernel::EngineImpl* const pimpl;
static Engine* instance_;
void initialize(int* argc, char** argv);
