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/instr/instr_private.hpp"
9 #include "src/simix/ActorImpl.hpp"
10 #include "src/simix/smx_private.hpp"
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
14 std::string instr_pid(msg_process_t proc)
16 return std::string(proc->get_cname()) + "-" + std::to_string(proc->get_pid());
19 /** @addtogroup m_process_management
21 * Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing
22 * your code interacting with the simulated world.
23 * A process may be defined as a <em>code</em> with some <em>private data</em>.
24 * Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
25 * that are similar to envelops containing data.
28 /******************************** Process ************************************/
30 * @brief Cleans the MSG data of an actor
31 * @param smx_actor a SIMIX actor
33 void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
35 if (TRACE_actor_is_enabled())
36 simgrid::instr::Container::by_name(instr_pid(smx_actor->ciface()))->remove_from_parent();
38 // free the data if a function was provided
39 void* userdata = smx_actor->get_user_data();
40 if (userdata && msg_global->process_data_cleanup) {
41 msg_global->process_data_cleanup(userdata);
44 SIMIX_process_cleanup(smx_actor);
47 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
48 smx_actor_t MSG_process_create_from_SIMIX(std::string name, simgrid::simix::ActorCode code, void* data, sg_host_t host,
49 std::unordered_map<std::string, std::string>* properties,
50 smx_actor_t /*parent_process*/)
52 msg_process_t p = MSG_process_create_from_stdfunc(name, std::move(code), data, host, properties);
53 return p == nullptr ? nullptr : p->get_impl();
56 /** @ingroup m_process_management
57 * @brief Creates and runs a new #msg_process_t.
59 * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
60 * (@a argc, @a argv, @a start_time, @a kill_time).
61 * @sa MSG_process_create_with_arguments
63 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
65 return MSG_process_create_with_environment(name == nullptr ? "" : name, code, data, host, 0, nullptr, nullptr);
68 /** @ingroup m_process_management
69 * @brief Creates and runs a new #msg_process_t.
71 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
72 * the corresponding thread) is created, and put in the list of ready process.
73 * @param name a name for the object. It is for user-level information and can be nullptr.
74 * @param code is a function describing the behavior of the process. It should then only use functions described
75 * in @ref m_process_management (to create a new #msg_process_t for example),
76 in @ref m_host_management (only the read-only functions i.e. whose name contains the word get),
77 in @ref m_task_management (to create or destroy some #msg_task_t for example) and
78 in @ref msg_task_usage (to handle file transfers and task processing).
79 * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and
80 * can be nullptr. It can be retrieved with the function @ref MSG_process_get_data.
81 * @param host the location where the new process is executed.
82 * @param argc first argument passed to @a code
83 * @param argv second argument passed to @a code
85 * @return The new corresponding object.
88 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
89 int argc, char **argv)
91 return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
94 /** @ingroup m_process_management
95 * @brief Creates and runs a new #msg_process_t.
97 * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
98 * the corresponding thread) is created, and put in the list of ready process.
99 * @param name a name for the object. It is for user-level information and can be nullptr.
100 * @param code is a function describing the behavior of the process. It should then only use functions described
101 * in @ref m_process_management (to create a new #msg_process_t for example),
102 in @ref m_host_management (only the read-only functions i.e. whose name contains the word get),
103 in @ref m_task_management (to create or destroy some #msg_task_t for example) and
104 in @ref msg_task_usage (to handle file transfers and task processing).
105 * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and
106 * can be nullptr. It can be retrieved with the function @ref MSG_process_get_data.
107 * @param host the location where the new process is executed.
108 * @param argc first argument passed to @a code
109 * @param argv second argument passed to @a code. WARNING, these strings are freed by the SimGrid kernel when the
110 * process exits, so they cannot be static nor shared between several processes.
111 * @param properties list a properties defined for this process
113 * @return The new corresponding object.
115 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
116 int argc, char **argv, xbt_dict_t properties)
118 simgrid::simix::ActorCode function;
120 function = simgrid::xbt::wrap_main(code, argc, static_cast<const char* const*>(argv));
122 std::unordered_map<std::string, std::string> props;
123 xbt_dict_cursor_t cursor = nullptr;
126 xbt_dict_foreach (properties, cursor, key, value)
128 xbt_dict_free(&properties);
130 msg_process_t res = MSG_process_create_from_stdfunc(name, std::move(function), data, host, &props);
131 for (int i = 0; i != argc; ++i)
137 msg_process_t MSG_process_create_from_stdfunc(std::string name, simgrid::simix::ActorCode code, void* data,
138 msg_host_t host, std::unordered_map<std::string, std::string>* properties)
140 xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
142 smx_actor_t process = simcall_process_create(name, std::move(code), data, host, properties);
144 if (process == nullptr)
148 return process->ciface();
151 /* Become a process in the simulation
153 * Currently this can only be called by the main thread (once) and only work with some thread factories
154 * (currently ThreadContextFactory).
156 * In the future, it might be extended in order to attach other threads created by a third party library.
158 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
160 xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
161 std::unordered_map<std::string, std::string> props;
162 xbt_dict_cursor_t cursor = nullptr;
165 xbt_dict_foreach (properties, cursor, key, value)
167 xbt_dict_free(&properties);
169 /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
170 smx_actor_t process = SIMIX_process_attach(name, data, host->get_cname(), &props, nullptr);
172 xbt_die("Could not attach");
174 return process->ciface();
177 /** Detach a process attached with `MSG_process_attach()`
179 * This is called when the current process has finished its job.
180 * Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
181 * simulated processes and the maestro are destroyed.
183 void MSG_process_detach()
185 SIMIX_process_detach();
188 /** @ingroup m_process_management
189 * @brief Returns the user data of a process.
191 * This function checks whether @a process is a valid pointer and returns the user data associated to this process.
193 void* MSG_process_get_data(msg_process_t process)
195 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
197 /* get from SIMIX the MSG process data, and then the user data */
198 return process->get_impl()->get_user_data();
201 /** @ingroup m_process_management
202 * @brief Sets the user data of a process.
204 * This function checks whether @a process is a valid pointer and sets the user data associated to this process.
206 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
208 xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
210 process->get_impl()->set_user_data(data);
215 /** @ingroup m_process_management
216 * @brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
217 * @param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
219 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
221 msg_global->process_data_cleanup = data_cleanup;
224 /** @brief returns a list of all currently existing processes */
225 xbt_dynar_t MSG_processes_as_dynar() {
226 xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
227 for (auto const& kv : simix_global->process_list) {
228 smx_actor_t actor = kv.second;
229 xbt_dynar_push(res, &actor);
234 /** @brief Return the current number MSG processes. */
235 int MSG_process_get_number()
237 return SIMIX_process_count();
240 /** @ingroup m_process_management
241 * @brief Return the PID of the current process.
243 * This function returns the PID of the currently running #msg_process_t.
245 int MSG_process_self_PID()
247 smx_actor_t self = SIMIX_process_self();
248 return self == nullptr ? 0 : self->pid_;
251 /** @ingroup m_process_management
252 * @brief Return the PPID of the current process.
254 * This function returns the PID of the parent of the currently running #msg_process_t.
256 int MSG_process_self_PPID()
258 return MSG_process_get_PPID(MSG_process_self());
261 /** @ingroup m_process_management
262 * @brief Return the name of the current process.
264 const char* MSG_process_self_name()
266 return SIMIX_process_self_get_name();
269 /** @ingroup m_process_management
270 * @brief Return the current process.
272 * This function returns the currently running #msg_process_t.
274 msg_process_t MSG_process_self()
276 return SIMIX_process_self()->ciface();
279 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) { // deprecated -- smx_context_t should die afterward
280 return process->get_impl()->context_;
283 * @ingroup m_process_management
284 * @brief Add a function to the list of "on_exit" functions for the current process.
285 * The on_exit functions are the functions executed when your process is killed.
286 * You should use them to free the data used by your process.
288 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
289 simgrid::s4u::this_actor::on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
292 /** @ingroup m_process_management
293 * @brief Take an extra reference on that process to prevent it to be garbage-collected
295 XBT_PUBLIC void MSG_process_ref(msg_process_t process)
297 intrusive_ptr_add_ref(process);
299 /** @ingroup m_process_management
300 * @brief Release a reference on that process so that it can get be garbage-collected
302 XBT_PUBLIC void MSG_process_unref(msg_process_t process)
304 intrusive_ptr_release(process);