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::unordered_map<std::string, routing::NetPoint*> netpoints_;
37 std::unordered_map<std::string, activity::MailboxImpl*> mailboxes_;
39 std::unordered_map<std::string, actor::ActorCodeFactory> registered_functions; // Maps function names to actor code
40 actor::ActorCodeFactory default_function; // Function to use as a fallback when the provided name matches nothing
41 std::vector<resource::Model*> models_;
42 std::unordered_map<std::string, std::shared_ptr<resource::Model>> models_prio_;
43 routing::NetZoneImpl* netzone_root_ = nullptr;
44 std::set<actor::ActorImpl*> daemons_;
45 std::vector<actor::ActorImpl*> actors_to_run_;
46 std::vector<actor::ActorImpl*> actors_that_ran_;
47 std::map<aid_t, actor::ActorImpl*> actor_list_;
48 boost::intrusive::list<actor::ActorImpl,
49 boost::intrusive::member_hook<actor::ActorImpl, boost::intrusive::list_member_hook<>,
50 &actor::ActorImpl::kernel_destroy_list_hook>>
53 /* MCer cannot read members actor_list_ above in the remote process, so we copy the info it needs in a dynar.
54 * FIXME: This is supposed to be a temporary hack.
55 * A better solution would be to change the split between MCer and MCed, where the responsibility
56 * to compute the list of the enabled transitions goes to the MCed.
57 * That way, the MCer would not need to have the list of actors on its side.
58 * These info could be published by the MCed to the MCer in a way inspired of vd.so
60 xbt_dynar_t actors_vector_ = xbt_dynar_new(sizeof(actor::ActorImpl*), nullptr);
64 static EngineImpl* instance_;
65 actor::ActorImpl* maestro_ = nullptr;
66 context::ContextFactory* context_factory_ = nullptr;
68 std::unique_ptr<void, std::function<int(void*)>> platf_handle_; //!< handle for platform library
72 EngineImpl() = default;
74 /* Currently, only one instance is allowed to exist. This is why you can't copy or move it */
76 EngineImpl(const EngineImpl&) = delete;
77 EngineImpl& operator=(const EngineImpl&) = delete;
78 virtual ~EngineImpl();
79 static void shutdown();
82 void initialize(int* argc, char** argv);
83 void load_platform(const std::string& platf);
84 void load_deployment(const std::string& file) const;
85 void seal_platform() const;
86 void register_function(const std::string& name, const actor::ActorCodeFactory& code);
87 void register_default(const actor::ActorCodeFactory& code);
89 bool is_maestro(const actor::ActorImpl* actor) const { return actor == maestro_; }
90 void set_maestro(actor::ActorImpl* actor) { maestro_ = actor; }
91 actor::ActorImpl* get_maestro() const { return maestro_; }
93 context::ContextFactory* get_context_factory() const { return context_factory_; }
94 void set_context_factory(context::ContextFactory* factory) { context_factory_ = factory; }
95 bool has_context_factory() const { return context_factory_ != nullptr; }
97 void context_mod_init() const;
99 * @brief Add a model to engine list
101 * @param model Pointer to model
102 * @param list List of dependencies for this model
104 void add_model(std::shared_ptr<simgrid::kernel::resource::Model> model,
105 const std::vector<resource::Model*>& dep_models = {});
107 /** @brief Get list of all models managed by this engine */
108 const std::vector<resource::Model*>& get_all_models() const { return models_; }
110 static bool has_instance() { return s4u::Engine::has_instance(); }
111 static EngineImpl* get_instance() { return s4u::Engine::get_instance()->pimpl; }
112 static EngineImpl* get_instance(int* argc, char** argv) { 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); }
141 void reset_actor_dynar() { xbt_dynar_reset(actors_vector_); }
142 void add_actor_to_dynar(actor::ActorImpl* actor) { xbt_dynar_push_as(actors_vector_, actor::ActorImpl*, actor); }
145 const std::map<aid_t, actor::ActorImpl*>& get_actor_list() const { return actor_list_; }
146 const std::vector<actor::ActorImpl*>& get_actors_to_run() const { return actors_to_run_; }
147 const std::vector<actor::ActorImpl*>& get_actors_that_ran() const { return actors_that_ran_; }
149 void handle_ended_actions() const;
153 * Should be called some time to time to free the memory allocated for actors that have finished (or killed).
156 void display_all_actor_status() const;
157 void run_all_actors();
159 /* @brief Finish simulation initialization
160 * This function must be called before the first call to solve()
162 void presolve() const;
163 /** @brief Performs a part of the simulation
164 * @param max_date Maximum date to update the simulation to, or -1
165 * @return the elapsed time, or -1.0 if no event could be executed
167 * This function execute all possible events, update the action states and returns the time elapsed.
168 * When you call execute or communicate on a model, the corresponding actions are not executed immediately but only
169 * when you call solve().
170 * Note that the returned elapsed time can be zero.
172 double solve(double max_date) const;
174 /** @brief Run the main simulation loop until the specified date (or infinitly if max_date is negative). */
175 void run(double max_date);
177 /** @brief Return the current time in milliseconds. */
178 static double get_clock();
181 } // namespace kernel
182 } // namespace simgrid