Logo AND Algorithmique Numérique Distribuée

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