1 /* Copyright (c) 2016-2023. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
6 #ifndef SIMGRID_KERNEL_ENGINEIMPL_HPP
7 #define SIMGRID_KERNEL_ENGINEIMPL_HPP
9 #include <simgrid/kernel/resource/Model.hpp>
10 #include <simgrid/s4u/Engine.hpp>
11 #include <simgrid/s4u/NetZone.hpp>
12 #include <simgrid/simix.hpp>
13 #include <xbt/dynar.h>
14 #include <xbt/functional.hpp>
16 #include "src/kernel/activity/ExecImpl.hpp"
17 #include "src/kernel/activity/IoImpl.hpp"
18 #include "src/kernel/activity/MailboxImpl.hpp"
19 #include "src/kernel/activity/SleepImpl.hpp"
20 #include "src/kernel/activity/Synchro.hpp"
21 #include "src/kernel/actor/ActorImpl.hpp"
23 #include <boost/intrusive/list.hpp>
28 #include <unordered_map>
31 namespace simgrid::kernel {
34 std::unordered_map<std::string, routing::NetPoint*> netpoints_;
35 std::unordered_map<std::string, activity::MailboxImpl*> mailboxes_;
37 std::unordered_map<std::string, actor::ActorCodeFactory> registered_functions; // Maps function names to actor code
38 actor::ActorCodeFactory default_function; // Function to use as a fallback when the provided name matches nothing
39 std::vector<resource::Model*> models_;
40 std::unordered_map<std::string, std::shared_ptr<resource::Model>> models_prio_;
41 routing::NetZoneImpl* netzone_root_ = nullptr;
42 std::set<actor::ActorImpl*> daemons_;
43 std::vector<actor::ActorImpl*> actors_to_run_;
44 std::vector<actor::ActorImpl*> actors_that_ran_;
45 std::map<aid_t, actor::ActorImpl*> actor_list_;
46 boost::intrusive::list<actor::ActorImpl,
47 boost::intrusive::member_hook<actor::ActorImpl, boost::intrusive::list_member_hook<>,
48 &actor::ActorImpl::kernel_destroy_list_hook>>
52 static EngineImpl* instance_;
53 actor::ActorImpl* maestro_ = nullptr;
54 context::ContextFactory* context_factory_ = nullptr;
56 std::unique_ptr<void, std::function<int(void*)>> platf_handle_; //!< handle for platform library
59 std::vector<std::string> cmdline_; // Copy of the argv we got (including argv[0])
62 EngineImpl() = default;
64 /* Currently, only one instance is allowed to exist. This is why you can't copy or move it */
66 EngineImpl(const EngineImpl&) = delete;
67 EngineImpl& operator=(const EngineImpl&) = delete;
68 virtual ~EngineImpl();
69 static void shutdown();
72 void initialize(int* argc, char** argv);
73 const std::vector<std::string>& get_cmdline() const
77 void load_platform(const std::string& platf);
78 void load_deployment(const std::string& file) const;
79 void seal_platform() const;
80 void register_function(const std::string& name, const actor::ActorCodeFactory& code);
81 void register_default(const actor::ActorCodeFactory& code);
83 bool is_maestro(const actor::ActorImpl* actor) const { return actor == maestro_; }
84 void set_maestro(actor::ActorImpl* actor) { maestro_ = actor; }
85 actor::ActorImpl* get_maestro() const { return maestro_; }
87 context::ContextFactory* get_context_factory() const { return context_factory_; }
88 void set_context_factory(context::ContextFactory* factory) { context_factory_ = factory; }
89 bool has_context_factory() const { return context_factory_ != nullptr; }
91 void context_mod_init() const;
93 * @brief Add a model to engine list
95 * @param model Pointer to model
96 * @param list List of dependencies for this model
98 void add_model(std::shared_ptr<simgrid::kernel::resource::Model> model,
99 const std::vector<resource::Model*>& dep_models = {});
101 /** @brief Get list of all models managed by this engine */
102 const std::vector<resource::Model*>& get_all_models() const { return models_; }
104 static bool has_instance() { return s4u::Engine::has_instance(); }
105 static EngineImpl* get_instance()
107 return s4u::Engine::get_instance()->pimpl_;
109 static EngineImpl* get_instance(int* argc, char** argv)
111 return s4u::Engine::get_instance(argc, argv)->pimpl_;
114 actor::ActorCodeFactory get_function(const std::string& name)
116 auto res = registered_functions.find(name);
117 if (res == registered_functions.end())
118 return default_function;
123 routing::NetZoneImpl* get_netzone_root() const { return netzone_root_; }
125 void add_daemon(actor::ActorImpl* d) { daemons_.insert(d); }
126 void remove_daemon(actor::ActorImpl* d);
127 void add_actor_to_run_list(actor::ActorImpl* actor);
128 void add_actor_to_run_list_no_check(actor::ActorImpl* actor);
129 void add_actor_to_destroy_list(actor::ActorImpl& actor) { actors_to_destroy_.push_back(actor); }
131 bool has_actors_to_run() const { return not actors_to_run_.empty(); }
132 const actor::ActorImpl* get_first_actor_to_run() const { return actors_to_run_.front(); }
133 const actor::ActorImpl* get_actor_to_run_at(unsigned long int i) const { return actors_to_run_[i]; }
134 unsigned long int get_actor_to_run_count() const { return actors_to_run_.size(); }
135 size_t get_actor_count() const { return actor_list_.size(); }
136 actor::ActorImpl* get_actor_by_pid(aid_t pid);
137 void add_actor(aid_t pid, actor::ActorImpl* actor) { actor_list_[pid] = actor; }
138 void remove_actor(aid_t pid) { actor_list_.erase(pid); }
140 const std::map<aid_t, actor::ActorImpl*>& get_actor_list() const { return actor_list_; }
141 const std::vector<actor::ActorImpl*>& get_actors_to_run() const { return actors_to_run_; }
142 const std::vector<actor::ActorImpl*>& get_actors_that_ran() const { return actors_that_ran_; }
144 void handle_ended_actions() const;
148 * Should be called some time to time to free the memory allocated for actors that have finished (or killed).
151 void display_all_actor_status() const;
152 void run_all_actors();
154 /** @brief Performs a part of the simulation
155 * @param max_date Maximum date to update the simulation to, or -1
156 * @return the elapsed time, or -1.0 if no event could be executed
158 * This function execute all possible events, update the action states and returns the time elapsed.
159 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
160 * when you call solve().
161 * Note that the returned elapsed time can be zero.
163 double solve(double max_date) const;
165 /** @brief Run the main simulation loop until the specified date (or infinitly if max_date is negative). */
166 void run(double max_date);
168 /** @brief Return the current time in milliseconds. */
169 static double get_clock();
172 } // namespace simgrid::kernel