Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
jedule: obey our coding standards
[simgrid.git] / src / msg / msg_process.cpp
1 /* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved.          */
2
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. */
5
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"
11
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
13
14 std::string instr_pid(msg_process_t proc)
15 {
16   return std::string(proc->get_cname()) + "-" + std::to_string(proc->get_pid());
17 }
18
19 /** @addtogroup m_process_management
20  *
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.
26  */
27
28 /******************************** Process ************************************/
29 /**
30  * \brief Cleans the MSG data of an actor
31  * \param smx_actor a SIMIX actor
32  */
33 void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
34 {
35   simgrid::msg::ActorExt* msg_actor;
36
37   // get the MSG process from the SIMIX process
38   if (smx_actor == SIMIX_process_self()) {
39     /* avoid a SIMIX request if this function is called by the process itself */
40     msg_actor = (simgrid::msg::ActorExt*)SIMIX_process_self_get_data();
41     SIMIX_process_self_set_data(nullptr);
42   } else {
43     msg_actor = (simgrid::msg::ActorExt*)smx_actor->getUserData();
44     simcall_process_set_data(smx_actor, nullptr);
45   }
46
47   if (TRACE_actor_is_enabled())
48     simgrid::instr::Container::by_name(instr_pid(smx_actor->ciface()))->remove_from_parent();
49
50   // free the data if a function was provided
51   if (msg_actor && msg_actor->data && msg_global->process_data_cleanup) {
52     msg_global->process_data_cleanup(msg_actor->data);
53   }
54
55   delete msg_actor;
56   SIMIX_process_cleanup(smx_actor);
57 }
58
59 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
60 smx_actor_t MSG_process_create_from_SIMIX(const char* name, std::function<void()> code, void* data, sg_host_t host,
61                                           std::unordered_map<std::string, std::string>* properties,
62                                           smx_actor_t /*parent_process*/)
63 {
64   msg_process_t p = MSG_process_create_from_stdfunc(name, std::move(code), data, host, properties);
65   return p == nullptr ? nullptr : p->get_impl();
66 }
67
68 /** \ingroup m_process_management
69  * \brief Creates and runs a new #msg_process_t.
70  *
71  * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
72  * (\a argc, \a argv, \a start_time, \a kill_time).
73  * \sa MSG_process_create_with_arguments
74  */
75 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
76 {
77   return MSG_process_create_with_environment(name, code, data, host, 0, nullptr, nullptr);
78 }
79
80 /** \ingroup m_process_management
81  * \brief Creates and runs a new #msg_process_t.
82
83  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
84  * the corresponding thread) is created, and put in the list of ready process.
85  * \param name a name for the object. It is for user-level information and can be nullptr.
86  * \param code is a function describing the behavior of the process. It should then only use functions described
87  * in \ref m_process_management (to create a new #msg_process_t for example),
88    in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
89    in \ref m_task_management (to create or destroy some #msg_task_t for example) and
90    in \ref msg_task_usage (to handle file transfers and task processing).
91  * \param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
92  *        can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
93  * \param host the location where the new process is executed.
94  * \param argc first argument passed to \a code
95  * \param argv second argument passed to \a code
96  * \see msg_process_t
97  * \return The new corresponding object.
98  */
99
100 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
101                                               int argc, char **argv)
102 {
103   return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
104 }
105
106 /** \ingroup m_process_management
107  * \brief Creates and runs a new #msg_process_t.
108
109  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
110  * the corresponding thread) is created, and put in the list of ready process.
111  * \param name a name for the object. It is for user-level information and can be nullptr.
112  * \param code is a function describing the behavior of the process. It should then only use functions described
113  * in \ref m_process_management (to create a new #msg_process_t for example),
114    in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
115    in \ref m_task_management (to create or destroy some #msg_task_t for example) and
116    in \ref msg_task_usage (to handle file transfers and task processing).
117  * \param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
118  *        can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
119  * \param host the location where the new process is executed.
120  * \param argc first argument passed to \a code
121  * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the
122  *             process exits, so they cannot be static nor shared between several processes.
123  * \param properties list a properties defined for this process
124  * \see msg_process_t
125  * \return The new corresponding object.
126  */
127 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
128                                                   int argc, char **argv, xbt_dict_t properties)
129 {
130   std::function<void()> function;
131   if (code)
132     function = simgrid::xbt::wrap_main(code, argc, static_cast<const char* const*>(argv));
133
134   std::unordered_map<std::string, std::string> props;
135   xbt_dict_cursor_t cursor = nullptr;
136   char* key;
137   char* value;
138   xbt_dict_foreach (properties, cursor, key, value)
139     props[key] = value;
140   xbt_dict_free(&properties);
141
142   msg_process_t res = MSG_process_create_from_stdfunc(name, std::move(function), data, host, &props);
143   for (int i = 0; i != argc; ++i)
144     xbt_free(argv[i]);
145   xbt_free(argv);
146   return res;
147 }
148
149 msg_process_t MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data, msg_host_t host,
150                                               std::unordered_map<std::string, std::string>* properties)
151 {
152   xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
153   simgrid::msg::ActorExt* msgExt = new simgrid::msg::ActorExt(data);
154
155   smx_actor_t process = simcall_process_create(name, std::move(code), msgExt, host, properties);
156
157   if (not process) { /* Undo everything */
158     delete msgExt;
159     return nullptr;
160   }
161   MSG_process_yield();
162   return process->ciface();
163 }
164
165 /* Become a process in the simulation
166  *
167  * Currently this can only be called by the main thread (once) and only work with some thread factories
168  * (currently ThreadContextFactory).
169  *
170  * In the future, it might be extended in order to attach other threads created by a third party library.
171  */
172 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
173 {
174   xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
175   std::unordered_map<std::string, std::string> props;
176   xbt_dict_cursor_t cursor = nullptr;
177   char* key;
178   char* value;
179   xbt_dict_foreach (properties, cursor, key, value)
180     props[key] = value;
181   xbt_dict_free(&properties);
182
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 =
185       SIMIX_process_attach(name, new simgrid::msg::ActorExt(data), host->get_cname(), &props, nullptr);
186   if (not process)
187     xbt_die("Could not attach");
188   MSG_process_yield();
189   return process->ciface();
190 }
191
192 /** Detach a process attached with `MSG_process_attach()`
193  *
194  *  This is called when the current process has finished its job.
195  *  Used in the main thread, it waits for the simulation to finish before  returning. When it returns, the other
196  *  simulated processes and the maestro are destroyed.
197  */
198 void MSG_process_detach()
199 {
200   SIMIX_process_detach();
201 }
202
203 /** \ingroup m_process_management
204  * \brief Returns the user data of a process.
205  *
206  * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
207  */
208 void* MSG_process_get_data(msg_process_t process)
209 {
210   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
211
212   /* get from SIMIX the MSG process data, and then the user data */
213   simgrid::msg::ActorExt* msgExt = (simgrid::msg::ActorExt*)process->get_impl()->getUserData();
214   if (msgExt)
215     return msgExt->data;
216   else
217     return nullptr;
218 }
219
220 /** \ingroup m_process_management
221  * \brief Sets the user data of a process.
222  *
223  * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
224  */
225 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
226 {
227   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
228
229   static_cast<simgrid::msg::ActorExt*>(process->get_impl()->getUserData())->data = data;
230
231   return MSG_OK;
232 }
233
234 /** \ingroup m_process_management
235  * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
236  * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
237  */
238 XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup)
239 {
240   msg_global->process_data_cleanup = data_cleanup;
241 }
242
243 /** @brief returns a list of all currently existing processes */
244 xbt_dynar_t MSG_processes_as_dynar() {
245   xbt_dynar_t res = xbt_dynar_new(sizeof(smx_actor_t), nullptr);
246   for (auto const& kv : simix_global->process_list) {
247     smx_actor_t actor = kv.second;
248     xbt_dynar_push(res, &actor);
249   }
250   return res;
251 }
252
253 /** @brief Return the current number MSG processes. */
254 int MSG_process_get_number()
255 {
256   return SIMIX_process_count();
257 }
258
259 /** \ingroup m_process_management
260  * \brief Return the PID of the current process.
261  *
262  * This function returns the PID of the currently running #msg_process_t.
263  */
264 int MSG_process_self_PID()
265 {
266   smx_actor_t self = SIMIX_process_self();
267   return self == nullptr ? 0 : self->pid;
268 }
269
270 /** \ingroup m_process_management
271  * \brief Return the PPID of the current process.
272  *
273  * This function returns the PID of the parent of the currently running #msg_process_t.
274  */
275 int MSG_process_self_PPID()
276 {
277   return MSG_process_get_PPID(MSG_process_self());
278 }
279
280 /** \ingroup m_process_management
281  * \brief Return the name of the current process.
282  */
283 const char* MSG_process_self_name()
284 {
285   return SIMIX_process_self_get_name();
286 }
287
288 /** \ingroup m_process_management
289  * \brief Return the current process.
290  *
291  * This function returns the currently running #msg_process_t.
292  */
293 msg_process_t MSG_process_self()
294 {
295   return SIMIX_process_self()->ciface();
296 }
297
298 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) { // deprecated -- smx_context_t should die afterward
299   return process->get_impl()->context;
300 }
301 /**
302  * \ingroup m_process_management
303  * \brief Add a function to the list of "on_exit" functions for the current process.
304  * The on_exit functions are the functions executed when your process is killed.
305  * You should use them to free the data used by your process.
306  */
307 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
308   simgrid::s4u::this_actor::on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
309 }
310
311 /** @ingroup m_process_management
312  * @brief Take an extra reference on that process to prevent it to be garbage-collected
313  */
314 XBT_PUBLIC void MSG_process_ref(msg_process_t process)
315 {
316   intrusive_ptr_add_ref(process);
317 }
318 /** @ingroup m_process_management
319  * @brief Release a reference on that process so that it can get be garbage-collected
320  */
321 XBT_PUBLIC void MSG_process_unref(msg_process_t process)
322 {
323   intrusive_ptr_release(process);
324 }