1 /* Copyright (c) 2016-2022. 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"
22 #include "src/kernel/resource/SplitDuplexLinkImpl.hpp"
24 #include <boost/intrusive/list.hpp>
29 #include <unordered_map>
36 std::map<std::string, s4u::Host*, std::less<>> hosts_;
37 std::map<std::string, resource::StandardLinkImpl*, std::less<>> links_;
38 /* save split-duplex links separately, keep links_ with only LinkImpl* seen by the user
39 * members of a split-duplex are saved in the links_ */
40 std::map<std::string, std::unique_ptr<resource::SplitDuplexLinkImpl>, std::less<>> split_duplex_links_;
41 std::unordered_map<std::string, routing::NetPoint*> netpoints_;
42 std::unordered_map<std::string, activity::MailboxImpl*> mailboxes_;
44 std::unordered_map<std::string, actor::ActorCodeFactory> registered_functions; // Maps function names to actor code
45 actor::ActorCodeFactory default_function; // Function to use as a fallback when the provided name matches nothing
46 std::vector<resource::Model*> models_;
47 std::unordered_map<std::string, std::shared_ptr<resource::Model>> models_prio_;
48 routing::NetZoneImpl* netzone_root_ = nullptr;
49 std::set<actor::ActorImpl*> daemons_;
50 std::vector<actor::ActorImpl*> actors_to_run_;
51 std::vector<actor::ActorImpl*> actors_that_ran_;
52 std::map<aid_t, actor::ActorImpl*> actor_list_;
53 boost::intrusive::list<actor::ActorImpl,
54 boost::intrusive::member_hook<actor::ActorImpl, boost::intrusive::list_member_hook<>,
55 &actor::ActorImpl::kernel_destroy_list_hook>>
58 /* MCer cannot read members actor_list_ above in the remote process, so we copy the info it needs in a dynar.
59 * FIXME: This is supposed to be a temporary hack.
60 * A better solution would be to change the split between MCer and MCed, where the responsibility
61 * to compute the list of the enabled transitions goes to the MCed.
62 * That way, the MCer would not need to have the list of actors on its side.
63 * These info could be published by the MCed to the MCer in a way inspired of vd.so
65 xbt_dynar_t actors_vector_ = xbt_dynar_new(sizeof(actor::ActorImpl*), nullptr);
69 static EngineImpl* instance_;
70 actor::ActorImpl* maestro_ = nullptr;
71 context::ContextFactory* context_factory_ = nullptr;
73 std::unique_ptr<void, std::function<int(void*)>> platf_handle_; //!< handle for platform library
77 EngineImpl() = default;
79 /* Currently, only one instance is allowed to exist. This is why you can't copy or move it */
81 EngineImpl(const EngineImpl&) = delete;
82 EngineImpl& operator=(const EngineImpl&) = delete;
83 virtual ~EngineImpl();
84 static void shutdown();
87 void initialize(int* argc, char** argv);
88 void load_platform(const std::string& platf);
89 void load_deployment(const std::string& file) const;
90 void seal_platform() const;
91 void register_function(const std::string& name, const actor::ActorCodeFactory& code);
92 void register_default(const actor::ActorCodeFactory& code);
94 bool is_maestro(const actor::ActorImpl* actor) const { return actor == maestro_; }
95 void set_maestro(actor::ActorImpl* actor) { maestro_ = actor; }
96 actor::ActorImpl* get_maestro() const { return maestro_; }
98 context::ContextFactory* get_context_factory() const { return context_factory_; }
99 void set_context_factory(context::ContextFactory* factory) { context_factory_ = factory; }
100 bool has_context_factory() const { return context_factory_ != nullptr; }
102 void context_mod_init() const;
104 * @brief Add a model to engine list
106 * @param model Pointer to model
107 * @param list List of dependencies for this model
109 void add_model(std::shared_ptr<simgrid::kernel::resource::Model> model,
110 const std::vector<resource::Model*>& dep_models = {});
112 /** @brief Get list of all models managed by this engine */
113 const std::vector<resource::Model*>& get_all_models() const { return models_; }
115 static bool has_instance() { return s4u::Engine::has_instance(); }
116 static EngineImpl* get_instance() { return s4u::Engine::get_instance()->pimpl; }
117 static EngineImpl* get_instance(int* argc, char** argv) { return s4u::Engine::get_instance(argc, argv)->pimpl; }
119 actor::ActorCodeFactory get_function(const std::string& name)
121 auto res = registered_functions.find(name);
122 if (res == registered_functions.end())
123 return default_function;
128 routing::NetZoneImpl* get_netzone_root() const { return netzone_root_; }
130 void add_daemon(actor::ActorImpl* d) { daemons_.insert(d); }
131 void remove_daemon(actor::ActorImpl* d);
132 void add_actor_to_run_list(actor::ActorImpl* actor);
133 void add_actor_to_run_list_no_check(actor::ActorImpl* actor);
134 void add_actor_to_destroy_list(actor::ActorImpl& actor) { actors_to_destroy_.push_back(actor); }
136 bool has_actors_to_run() const { return not actors_to_run_.empty(); }
137 const actor::ActorImpl* get_first_actor_to_run() const { return actors_to_run_.front(); }
138 const actor::ActorImpl* get_actor_to_run_at(unsigned long int i) const { return actors_to_run_[i]; }
139 unsigned long int get_actor_to_run_count() const { return actors_to_run_.size(); }
140 size_t get_actor_count() const { return actor_list_.size(); }
141 actor::ActorImpl* get_actor_by_pid(aid_t pid);
142 void add_actor(aid_t pid, actor::ActorImpl* actor) { actor_list_[pid] = actor; }
143 void remove_actor(aid_t pid) { actor_list_.erase(pid); }
144 void add_split_duplex_link(const std::string& name, std::unique_ptr<resource::SplitDuplexLinkImpl> link);
147 void reset_actor_dynar() { xbt_dynar_reset(actors_vector_); }
148 void add_actor_to_dynar(actor::ActorImpl* actor) { xbt_dynar_push_as(actors_vector_, actor::ActorImpl*, actor); }
151 const std::map<aid_t, actor::ActorImpl*>& get_actor_list() const { return actor_list_; }
152 const std::vector<actor::ActorImpl*>& get_actors_to_run() const { return actors_to_run_; }
153 const std::vector<actor::ActorImpl*>& get_actors_that_ran() const { return actors_that_ran_; }
155 void handle_ended_actions() const;
159 * Should be called some time to time to free the memory allocated for actors that have finished (or killed).
162 void display_all_actor_status() const;
163 void run_all_actors();
165 /* @brief Finish simulation initialization
166 * This function must be called before the first call to solve()
168 void presolve() const;
169 /** @brief Performs a part of the simulation
170 * @param max_date Maximum date to update the simulation to, or -1
171 * @return the elapsed time, or -1.0 if no event could be executed
173 * This function execute all possible events, update the action states and returns the time elapsed.
174 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
175 * when you call solve().
176 * Note that the returned elapsed time can be zero.
178 double solve(double max_date) const;
180 /** @brief Run the main simulation loop until the specified date (or infinitly if max_date is negative). */
181 void run(double max_date);
183 /** @brief Return the current time in milliseconds. */
184 static double get_clock();
187 } // namespace kernel
188 } // namespace simgrid