1 /* Copyright (c) 2004-2018. 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 #include "msg_private.hpp"
7 #include "simgrid/s4u/Host.hpp"
8 #include "src/simix/ActorImpl.hpp"
9 #include "src/simix/smx_private.hpp"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
15 /** @addtogroup m_process_management
17 * Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing
18 * your code interacting with the simulated world.
19 * A process may be defined as a <em>code</em> with some <em>private data</em>.
20 * Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
21 * that are similar to envelops containing data.
24 /******************************** Process ************************************/
26 * \brief Cleans the MSG data of an actor
27 * \param smx_actor a SIMIX actor
29 void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
31 simgrid::msg::ActorExt* msg_actor;
33 // get the MSG process from the SIMIX process
34 if (smx_actor == SIMIX_process_self()) {
35 /* avoid a SIMIX request if this function is called by the process itself */
36 msg_actor = (simgrid::msg::ActorExt*)SIMIX_process_self_get_data();
37 SIMIX_process_self_set_data(nullptr);
39 msg_actor = (simgrid::msg::ActorExt*)smx_actor->userdata;
40 simcall_process_set_data(smx_actor, nullptr);
43 if (TRACE_actor_is_enabled())
44 simgrid::instr::Container::byName(instr_pid(smx_actor->ciface()))->removeFromParent();
46 // free the data if a function was provided
47 if (msg_actor && msg_actor->data && msg_global->process_data_cleanup) {
48 msg_global->process_data_cleanup(msg_actor->data);
52 SIMIX_process_cleanup(smx_actor);
55 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
56 smx_actor_t MSG_process_create_from_SIMIX(const char* name, std::function<void()> code, void* data, sg_host_t host,
57 std::map<std::string, std::string>* properties,
58 smx_actor_t /*parent_process*/)
60 msg_process_t p = MSG_process_create_from_stdfunc(name, std::move(code), data, host, properties);
61 return p == nullptr ? nullptr : p->getImpl();
64 /** \ingroup m_process_management
65 * \brief Creates and runs a new #msg_process_t.
67 * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
68 * (\a argc, \a argv, \a start_time, \a kill_time).
69 * \sa MSG_process_create_with_arguments
71 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
73 return MSG_process_create_with_environment(name, code, data, host, 0, nullptr, nullptr);
76 /** \ingroup m_process_management
77 * \brief Creates and runs a new #msg_process_t.
79 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
80 * the corresponding thread) is created, and put in the list of ready process.
81 * \param name a name for the object. It is for user-level information and can be nullptr.
82 * \param code is a function describing the behavior of the process. It should then only use functions described
83 * in \ref m_process_management (to create a new #msg_process_t for example),
84 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
85 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
86 in \ref msg_task_usage (to handle file transfers and task processing).
87 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
88 * can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
89 * \param host the location where the new process is executed.
90 * \param argc first argument passed to \a code
91 * \param argv second argument passed to \a code
93 * \return The new corresponding object.
96 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
97 int argc, char **argv)
99 return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
102 /** \ingroup m_process_management
103 * \brief Creates and runs a new #msg_process_t.
105 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
106 * the corresponding thread) is created, and put in the list of ready process.
107 * \param name a name for the object. It is for user-level information and can be nullptr.
108 * \param code is a function describing the behavior of the process. It should then only use functions described
109 * in \ref m_process_management (to create a new #msg_process_t for example),
110 in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
111 in \ref m_task_management (to create or destroy some #msg_task_t for example) and
112 in \ref msg_task_usage (to handle file transfers and task processing).
113 * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and
114 * can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
115 * \param host the location where the new process is executed.
116 * \param argc first argument passed to \a code
117 * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the
118 * process exits, so they cannot be static nor shared between several processes.
119 * \param properties list a properties defined for this process
121 * \return The new corresponding object.
123 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
124 int argc, char **argv, xbt_dict_t properties)
126 std::function<void()> function;
128 function = simgrid::xbt::wrapMain(code, argc, static_cast<const char* const*>(argv));
130 std::map<std::string, std::string> props;
131 xbt_dict_cursor_t cursor = nullptr;
134 xbt_dict_foreach (properties, cursor, key, value)
136 xbt_dict_free(&properties);
138 msg_process_t res = MSG_process_create_from_stdfunc(name, std::move(function), data, host, &props);
139 for (int i = 0; i != argc; ++i)
146 msg_process_t MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data, msg_host_t host,
147 std::map<std::string, std::string>* properties)
149 xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
150 simgrid::msg::ActorExt* msgExt = new simgrid::msg::ActorExt(data);
152 smx_actor_t process = simcall_process_create(name, std::move(code), msgExt, host, properties);
154 if (not process) { /* Undo everything */
159 simcall_process_on_exit(process, (int_f_pvoid_pvoid_t)TRACE_msg_process_kill, process);
160 return process->ciface();
165 /* Become a process in the simulation
167 * Currently this can only be called by the main thread (once) and only work with some thread factories
168 * (currently ThreadContextFactory).
170 * In the future, it might be extended in order to attach other threads created by a third party library.
172 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
174 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
175 std::map<std::string, std::string> props;
176 xbt_dict_cursor_t cursor = nullptr;
179 xbt_dict_foreach (properties, cursor, key, value)
181 xbt_dict_free(&properties);
183 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
184 smx_actor_t process = SIMIX_process_attach(name, new simgrid::msg::ActorExt(data), host->getCname(), &props, nullptr);
186 xbt_die("Could not attach");
187 simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
188 return process->ciface();
191 /** Detach a process attached with `MSG_process_attach()`
193 * This is called when the current process has finished its job.
194 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
195 * simulated processes and the maestro are destroyed.
197 void MSG_process_detach()
199 SIMIX_process_detach();
202 /** \ingroup m_process_management
203 * \param process poor victim
205 * This function simply kills a \a process... scary isn't it ? :)
207 void MSG_process_kill(msg_process_t process)
213 * \brief Wait for the completion of a #msg_process_t.
215 * \param process the process to wait for
216 * \param timeout wait until the process is over, or the timeout occurs
218 msg_error_t MSG_process_join(msg_process_t process, double timeout){
219 process->join(timeout);
223 /** Yield the current actor; let the other actors execute first */
224 void MSG_process_yield()
226 simgrid::simix::kernelImmediate([] { /* do nothing*/ });
229 /** \ingroup m_process_management
230 * \brief Returns the user data of a process.
232 * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
234 void* MSG_process_get_data(msg_process_t process)
236 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
238 /* get from SIMIX the MSG process data, and then the user data */
239 simgrid::msg::ActorExt* msgExt = (simgrid::msg::ActorExt*)process->getImpl()->userdata;
246 /** \ingroup m_process_management
247 * \brief Sets the user data of a process.
249 * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
251 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
253 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
255 static_cast<simgrid::msg::ActorExt*>(process->getImpl()->userdata)->data = data;
260 /** \ingroup m_process_management
261 * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
262 * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
264 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
266 msg_global->process_data_cleanup = data_cleanup;
269 /** \ingroup m_process_management
271 * \brief Return a #msg_process_t given its PID.
273 * This function search in the list of all the created msg_process_t for a msg_process_t whose PID is equal to \a PID.
274 * If no host is found, \c nullptr is returned.
275 Note that the PID are uniq in the whole simulation, not only on a given host.
277 msg_process_t MSG_process_from_PID(int PID)
279 return SIMIX_process_from_PID(PID)->ciface();
282 /** @brief returns a list of all currently existing processes */
283 xbt_dynar_t MSG_processes_as_dynar() {
284 xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
285 for (auto const& kv : simix_global->process_list) {
286 smx_actor_t actor = kv.second;
287 xbt_dynar_push(res, &actor);
292 /** @brief Return the current number MSG processes. */
293 int MSG_process_get_number()
295 return SIMIX_process_count();
298 /** \ingroup m_process_management
299 * \brief Set the kill time of a process.
301 * \param process a process
302 * \param kill_time the time when the process is killed.
304 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
306 process->setKillTime(kill_time);
311 /** \ingroup m_process_management
312 * \brief Return the PID of the current process.
314 * This function returns the PID of the currently running #msg_process_t.
316 int MSG_process_self_PID()
318 smx_actor_t self = SIMIX_process_self();
319 return self == nullptr ? 0 : self->pid;
322 /** \ingroup m_process_management
323 * \brief Return the PPID of the current process.
325 * This function returns the PID of the parent of the currently running #msg_process_t.
327 int MSG_process_self_PPID()
329 return MSG_process_get_PPID(MSG_process_self());
332 /** \ingroup m_process_management
333 * \brief Return the name of the current process.
335 const char* MSG_process_self_name()
337 return SIMIX_process_self_get_name();
340 /** \ingroup m_process_management
341 * \brief Return the current process.
343 * This function returns the currently running #msg_process_t.
345 msg_process_t MSG_process_self()
347 return SIMIX_process_self()->ciface();
350 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
351 return process->getImpl()->context;
354 * \ingroup m_process_management
355 * \brief Add a function to the list of "on_exit" functions for the current process.
356 * The on_exit functions are the functions executed when your process is killed.
357 * You should use them to free the data used by your process.
359 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
360 simcall_process_on_exit(SIMIX_process_self(), fun, data);
363 * \ingroup m_process_management
364 * \brief Sets the "auto-restart" flag of the process.
365 * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
367 XBT_PUBLIC void MSG_process_auto_restart_set(msg_process_t process, int auto_restart)
369 process->setAutoRestart(auto_restart);
372 /** @ingroup m_process_management
373 * @brief Take an extra reference on that process to prevent it to be garbage-collected
375 XBT_PUBLIC void MSG_process_ref(msg_process_t process)
377 intrusive_ptr_add_ref(process);
379 /** @ingroup m_process_management
380 * @brief Release a reference on that process so that it can get be garbage-collected
382 XBT_PUBLIC void MSG_process_unref(msg_process_t process)
384 intrusive_ptr_release(process);