Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
even more C++ style
[simgrid.git] / src / msg / msg_process.cpp
1 /* Copyright (c) 2004-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #include "msg_private.h"
8 #include "simgrid/s4u/host.hpp"
9 #include "src/simix/ActorImpl.hpp"
10
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
12
13 /** @addtogroup m_process_management
14  *
15  *  Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing
16  *  your code interacting with the simulated world.
17  *  A process may be defined as a <em>code</em> with some <em>private data</em>.
18  *  Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
19  *  that are similar to envelops containing data.
20  */
21
22 /******************************** Process ************************************/
23 /**
24  * \brief Cleans the MSG data of a process.
25  * \param smx_proc a SIMIX process
26  */
27 void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
28 {
29   MsgActorExt* msg_actor;
30
31   // get the MSG process from the SIMIX process
32   if (smx_actor == SIMIX_process_self()) {
33     /* avoid a SIMIX request if this function is called by the process itself */
34     msg_actor = (MsgActorExt*)SIMIX_process_self_get_data();
35     SIMIX_process_self_set_data(nullptr);
36   } else {
37     msg_actor = (MsgActorExt*)smx_actor->data;
38     simcall_process_set_data(smx_actor, nullptr);
39   }
40
41   TRACE_msg_process_destroy(smx_actor->name.c_str(), smx_actor->pid);
42   // free the data if a function was provided
43   if (msg_actor && msg_actor->data && msg_global->process_data_cleanup) {
44     msg_global->process_data_cleanup(msg_actor->data);
45   }
46
47   // free the MSG process
48   xbt_free(msg_actor);
49   SIMIX_process_cleanup(smx_actor);
50 }
51
52 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
53 smx_actor_t MSG_process_create_from_SIMIX(
54   const char *name, std::function<void()> code, void *data, sg_host_t host,
55   double kill_time, xbt_dict_t properties,
56   int auto_restart, smx_actor_t parent_process)
57 {
58   msg_process_t p = MSG_process_create_with_environment(name, std::move(code), data, host, properties);
59   if (p) {
60     MSG_process_set_kill_time(p,kill_time);
61     MSG_process_auto_restart_set(p,auto_restart);
62   }
63   return p;
64 }
65
66 /** \ingroup m_process_management
67  * \brief Creates and runs a new #msg_process_t.
68  *
69  * Does exactly the same as #MSG_process_create_with_arguments but without providing standard arguments
70  * (\a argc, \a argv, \a start_time, \a kill_time).
71  * \sa MSG_process_create_with_arguments
72  */
73 msg_process_t MSG_process_create(const char *name, xbt_main_func_t code, void *data, msg_host_t host)
74 {
75   return MSG_process_create_with_environment(name, code, data, host, 0, nullptr, nullptr);
76 }
77
78 /** \ingroup m_process_management
79  * \brief Creates and runs a new #msg_process_t.
80
81  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
82  * the corresponding thread) is created, and put in the list of ready process.
83  * \param name a name for the object. It is for user-level information and can be nullptr.
84  * \param code is a function describing the behavior of the process. It should then only use functions described
85  * in \ref m_process_management (to create a new #msg_process_t for example),
86    in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
87    in \ref m_task_management (to create or destroy some #msg_task_t for example) and
88    in \ref msg_task_usage (to handle file transfers and task processing).
89  * \param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
90  *        can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
91  * \param host the location where the new process is executed.
92  * \param argc first argument passed to \a code
93  * \param argv second argument passed to \a code
94  * \see msg_process_t
95  * \return The new corresponding object.
96  */
97
98 msg_process_t MSG_process_create_with_arguments(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
99                                               int argc, char **argv)
100 {
101   return MSG_process_create_with_environment(name, code, data, host, argc, argv, nullptr);
102 }
103
104 /** \ingroup m_process_management
105  * \brief Creates and runs a new #msg_process_t.
106
107  * A constructor for #msg_process_t taking four arguments and returning the corresponding object. The structure (and
108  * the corresponding thread) is created, and put in the list of ready process.
109  * \param name a name for the object. It is for user-level information and can be nullptr.
110  * \param code is a function describing the behavior of the process. It should then only use functions described
111  * in \ref m_process_management (to create a new #msg_process_t for example),
112    in \ref m_host_management (only the read-only functions i.e. whose name contains the word get),
113    in \ref m_task_management (to create or destroy some #msg_task_t for example) and
114    in \ref msg_task_usage (to handle file transfers and task processing).
115  * \param data a pointer to any data one may want to attach to the new object.  It is for user-level information and
116  *        can be nullptr. It can be retrieved with the function \ref MSG_process_get_data.
117  * \param host the location where the new process is executed.
118  * \param argc first argument passed to \a code
119  * \param argv second argument passed to \a code. WARNING, these strings are freed by the SimGrid kernel when the
120  *             process exits, so they cannot be static nor shared between several processes.
121  * \param properties list a properties defined for this process
122  * \see msg_process_t
123  * \return The new corresponding object.
124  */
125 msg_process_t MSG_process_create_with_environment(const char *name, xbt_main_func_t code, void *data, msg_host_t host,
126                                                   int argc, char **argv, xbt_dict_t properties)
127 {
128   std::function<void()> function;
129   if (code)
130     function = simgrid::xbt::wrapMain(code, argc, const_cast<const char*const*>(argv));
131   msg_process_t res = MSG_process_create_with_environment(name,
132     std::move(function), data, host, properties);
133   for (int i = 0; i != argc; ++i)
134     xbt_free(argv[i]);
135   xbt_free(argv);
136   return res;
137 }
138
139 msg_process_t MSG_process_create_with_environment(
140   const char *name, std::function<void()> code, void *data,
141   msg_host_t host, xbt_dict_t properties)
142 {
143   xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
144   MsgActorExt* msgExt = new MsgActorExt(data);
145
146   /* Let's create the process: SIMIX may decide to start it right now,
147    * even before returning the flow control to us */
148   msg_process_t process = simcall_process_create(name, std::move(code), msgExt, host, -1, properties, 0);
149
150   if (!process) { /* Undo everything */
151     delete msgExt;
152     return nullptr;
153   }
154   else {
155     simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
156   }
157   return process;
158 }
159
160 /* Become a process in the simulation
161  *
162  * Currently this can only be called by the main thread (once) and only work with some thread factories
163  * (currently ThreadContextFactory).
164  *
165  * In the future, it might be extended in order to attach other threads created by a third party library.
166  */
167 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
168 {
169   xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
170
171   /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
172   msg_process_t process = SIMIX_process_attach(name, new MsgActorExt(data), host->cname(), properties, nullptr);
173   if (!process)
174     xbt_die("Could not attach");
175   simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
176   return process;
177 }
178
179 /** Detach a process attached with `MSG_process_attach()`
180  *
181  *  This is called when the current process has finished its job.
182  *  Used in the main thread, it waits for the simulation to finish before  returning. When it returns, the other
183  *  simulated processes and the maestro are destroyed.
184  */
185 void MSG_process_detach()
186 {
187   SIMIX_process_detach();
188 }
189
190 /** \ingroup m_process_management
191  * \param process poor victim
192  *
193  * This function simply kills a \a process... scary isn't it ? :)
194  */
195 void MSG_process_kill(msg_process_t process)
196 {
197   simcall_process_kill(process);
198 }
199
200 /**
201 * \brief Wait for the completion of a #msg_process_t.
202 *
203 * \param process the process to wait for
204 * \param timeout wait until the process is over, or the timeout occurs
205 */
206 msg_error_t MSG_process_join(msg_process_t process, double timeout){
207   simcall_process_join(process, timeout);
208   return MSG_OK;
209 }
210
211 /** \ingroup m_process_management
212  * \brief Migrates a process to another location.
213  *
214  * This function checks whether \a process and \a host are valid pointers and change the value of the #msg_host_t on
215  * which \a process is running.
216  */
217 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
218 {
219   TRACE_msg_process_change_host(process, MSG_process_get_host(process), host);
220   simcall_process_set_host(process, host);
221   return MSG_OK;
222 }
223
224 /** Yield the current actor; let the other actors execute first */
225 void MSG_process_yield()
226 {
227   simgrid::simix::kernelImmediate([] { /* do nothing*/ });
228 }
229
230 /** \ingroup m_process_management
231  * \brief Returns the user data of a process.
232  *
233  * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
234  */
235 void* MSG_process_get_data(msg_process_t process)
236 {
237   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
238
239   /* get from SIMIX the MSG process data, and then the user data */
240   MsgActorExt* msgExt = (MsgActorExt*)process->data;
241   if (msgExt)
242     return msgExt->data;
243   else
244     return nullptr;
245 }
246
247 /** \ingroup m_process_management
248  * \brief Sets the user data of a process.
249  *
250  * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
251  */
252 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
253 {
254   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
255
256   MsgActorExt* msgExt = (MsgActorExt*)process->data;
257   msgExt->data        = data;
258
259   return MSG_OK;
260 }
261
262 /** \ingroup m_process_management
263  * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
264  * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
265  */
266 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
267   msg_global->process_data_cleanup = data_cleanup;
268 }
269
270 /** \ingroup m_process_management
271  * \brief Return the location on which a process is running.
272  * \param process a process (nullptr means the current one)
273  * \return the msg_host_t corresponding to the location on which \a process is running.
274  */
275 msg_host_t MSG_process_get_host(msg_process_t process)
276 {
277   if (process == nullptr) {
278     return MSG_process_self()->host;
279   } else {
280     return process->host;
281   }
282 }
283
284 /** \ingroup m_process_management
285  *
286  * \brief Return a #msg_process_t given its PID.
287  *
288  * 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.
289  * If no host is found, \c nullptr is returned.
290    Note that the PID are uniq in the whole simulation, not only on a given host.
291  */
292 msg_process_t MSG_process_from_PID(int PID)
293 {
294   return SIMIX_process_from_PID(PID);
295 }
296
297 /** @brief returns a list of all currently existing processes */
298 xbt_dynar_t MSG_processes_as_dynar() {
299   return SIMIX_processes_as_dynar();
300 }
301
302 /** @brief Return the current number MSG processes. */
303 int MSG_process_get_number()
304 {
305   return SIMIX_process_count();
306 }
307
308 /** \ingroup m_process_management
309  * \brief Set the kill time of a process.
310  *
311  * \param process a process
312  * \param kill_time the time when the process is killed.
313  */
314 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
315 {
316   simcall_process_set_kill_time(process,kill_time);
317   return MSG_OK;
318 }
319
320 /** \ingroup m_process_management
321  * \brief Returns the process ID of \a process.
322  *
323  * This function checks whether \a process is a valid pointer and return its PID (or 0 in case of problem).
324  */
325 int MSG_process_get_PID(msg_process_t process)
326 {
327   /* Do not raise an exception here: this function is called by the logs
328    * and the exceptions, so it would be called back again and again */
329   if (process == nullptr)
330     return 0;
331   return process->pid;
332 }
333
334 /** \ingroup m_process_management
335  * \brief Returns the process ID of the parent of \a process.
336  *
337  * This function checks whether \a process is a valid pointer and return its PID.
338  * Returns -1 if the process has not been created by any other process.
339  */
340 int MSG_process_get_PPID(msg_process_t process)
341 {
342   return process->ppid;
343 }
344
345 /** \ingroup m_process_management
346  * \brief Return the name of a process.
347  *
348  * This function checks whether \a process is a valid pointer and return its name.
349  */
350 const char *MSG_process_get_name(msg_process_t process)
351 {
352   return process->name.c_str();
353 }
354
355 /** \ingroup m_process_management
356  * \brief Returns the value of a given process property
357  *
358  * \param process a process
359  * \param name a property name
360  * \return value of a property (or nullptr if the property is not set)
361  */
362 const char *MSG_process_get_property_value(msg_process_t process, const char *name)
363 {
364   return (char*) xbt_dict_get_or_null(MSG_process_get_properties(process), name);
365 }
366
367 /** \ingroup m_process_management
368  * \brief Return the list of properties
369  *
370  * This function returns all the parameters associated with a process
371  */
372 xbt_dict_t MSG_process_get_properties(msg_process_t process)
373 {
374   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
375   return simcall_process_get_properties(process);
376 }
377
378 /** \ingroup m_process_management
379  * \brief Return the PID of the current process.
380  *
381  * This function returns the PID of the currently running #msg_process_t.
382  */
383 int MSG_process_self_PID()
384 {
385   return MSG_process_get_PID(MSG_process_self());
386 }
387
388 /** \ingroup m_process_management
389  * \brief Return the PPID of the current process.
390  *
391  * This function returns the PID of the parent of the currently running #msg_process_t.
392  */
393 int MSG_process_self_PPID()
394 {
395   return MSG_process_get_PPID(MSG_process_self());
396 }
397
398 /** \ingroup m_process_management
399  * \brief Return the current process.
400  *
401  * This function returns the currently running #msg_process_t.
402  */
403 msg_process_t MSG_process_self()
404 {
405   return SIMIX_process_self();
406 }
407
408 /** \ingroup m_process_management
409  * \brief Suspend the process.
410  *
411  * This function suspends the process by suspending the task on which it was waiting for the completion.
412  */
413 msg_error_t MSG_process_suspend(msg_process_t process)
414 {
415   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
416
417   TRACE_msg_process_suspend(process);
418   simcall_process_suspend(process);
419   return MSG_OK;
420 }
421
422 /** \ingroup m_process_management
423  * \brief Resume a suspended process.
424  *
425  * This function resumes a suspended process by resuming the task on which it was waiting for the completion.
426  */
427 msg_error_t MSG_process_resume(msg_process_t process)
428 {
429   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
430
431   TRACE_msg_process_resume(process);
432   simcall_process_resume(process);
433   return MSG_OK;
434 }
435
436 /** \ingroup m_process_management
437  * \brief Returns true if the process is suspended .
438  *
439  * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
440  */
441 int MSG_process_is_suspended(msg_process_t process)
442 {
443   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
444   return simcall_process_is_suspended(process);
445 }
446
447 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
448   return SIMIX_process_get_context(process);
449 }
450 /**
451  * \ingroup m_process_management
452  * \brief Add a function to the list of "on_exit" functions for the current process.
453  * The on_exit functions are the functions executed when your process is killed.
454  * You should use them to free the data used by your process.
455  */
456 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
457   simcall_process_on_exit(MSG_process_self(),fun,data);
458 }
459 /**
460  * \ingroup m_process_management
461  * \brief Sets the "auto-restart" flag of the process.
462  * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
463  */
464 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
465   simcall_process_auto_restart_set(process,auto_restart);
466 }
467 /*
468  * \ingroup m_process_management
469  * \brief Restarts a process from the beginning.
470  */
471 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
472   return simcall_process_restart(process);
473 }