Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fix example (bummer)
[simgrid.git] / src / msg / msg_process.cpp
1 /* Copyright (c) 2004-2017. 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.h"
7 #include "simgrid/s4u/host.hpp"
8 #include "src/simix/ActorImpl.hpp"
9
10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg, "Logging specific to MSG (process)");
11
12 SG_BEGIN_DECL()
13
14 /** @addtogroup m_process_management
15  *
16  *  Processes (#msg_process_t) are independent agents that can do stuff on their own. They are in charge of executing
17  *  your code interacting with the simulated world.
18  *  A process may be defined as a <em>code</em> with some <em>private data</em>.
19  *  Processes must be located on <em>hosts</em> (#msg_host_t), and they exchange data by sending tasks (#msg_task_t)
20  *  that are similar to envelops containing data.
21  */
22
23 /******************************** Process ************************************/
24 /**
25  * \brief Cleans the MSG data of a process.
26  * \param smx_proc a SIMIX process
27  */
28 void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
29 {
30   simgrid::MsgActorExt* msg_actor;
31
32   // get the MSG process from the SIMIX process
33   if (smx_actor == SIMIX_process_self()) {
34     /* avoid a SIMIX request if this function is called by the process itself */
35     msg_actor = (simgrid::MsgActorExt*)SIMIX_process_self_get_data();
36     SIMIX_process_self_set_data(nullptr);
37   } else {
38     msg_actor = (simgrid::MsgActorExt*)smx_actor->data;
39     simcall_process_set_data(smx_actor, nullptr);
40   }
41
42   TRACE_msg_process_destroy(smx_actor->name.c_str(), smx_actor->pid);
43   // free the data if a function was provided
44   if (msg_actor && msg_actor->data && msg_global->process_data_cleanup) {
45     msg_global->process_data_cleanup(msg_actor->data);
46   }
47
48   delete 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_from_stdfunc(name, std::move(code), data, host, properties);
57   return p == nullptr ? nullptr : p->getImpl();
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, static_cast<const char* const*>(argv));
125
126   msg_process_t res = MSG_process_create_from_stdfunc(name, 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 SG_END_DECL()
134
135 msg_process_t MSG_process_create_from_stdfunc(const char* name, std::function<void()> code, void* data, msg_host_t host,
136                                               xbt_dict_t properties)
137 {
138   xbt_assert(code != nullptr && host != nullptr, "Invalid parameters: host and code params must not be nullptr");
139   simgrid::MsgActorExt* msgExt = new simgrid::MsgActorExt(data);
140
141   smx_actor_t process = simcall_process_create(name, std::move(code), msgExt, host, properties);
142
143   if (!process) { /* Undo everything */
144     delete msgExt;
145     return nullptr;
146   }
147
148   simcall_process_on_exit(process, (int_f_pvoid_pvoid_t)TRACE_msg_process_kill, process);
149   return process->ciface();
150 }
151
152 SG_BEGIN_DECL()
153
154 /* Become a process in the simulation
155  *
156  * Currently this can only be called by the main thread (once) and only work with some thread factories
157  * (currently ThreadContextFactory).
158  *
159  * In the future, it might be extended in order to attach other threads created by a third party library.
160  */
161 msg_process_t MSG_process_attach(const char *name, void *data, msg_host_t host, xbt_dict_t properties)
162 {
163   xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
164
165   /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
166   smx_actor_t process = SIMIX_process_attach(name, new simgrid::MsgActorExt(data), host->cname(), properties, nullptr);
167   if (!process)
168     xbt_die("Could not attach");
169   simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
170   return process->ciface();
171 }
172
173 /** Detach a process attached with `MSG_process_attach()`
174  *
175  *  This is called when the current process has finished its job.
176  *  Used in the main thread, it waits for the simulation to finish before  returning. When it returns, the other
177  *  simulated processes and the maestro are destroyed.
178  */
179 void MSG_process_detach()
180 {
181   SIMIX_process_detach();
182 }
183
184 /** \ingroup m_process_management
185  * \param process poor victim
186  *
187  * This function simply kills a \a process... scary isn't it ? :)
188  */
189 void MSG_process_kill(msg_process_t process)
190 {
191   simcall_process_kill(process->getImpl());
192 }
193
194 /**
195 * \brief Wait for the completion of a #msg_process_t.
196 *
197 * \param process the process to wait for
198 * \param timeout wait until the process is over, or the timeout occurs
199 */
200 msg_error_t MSG_process_join(msg_process_t process, double timeout){
201   simcall_process_join(process->getImpl(), timeout);
202   return MSG_OK;
203 }
204
205 /** \ingroup m_process_management
206  * \brief Migrates a process to another location.
207  *
208  * This function checks whether \a process and \a host are valid pointers and change the value of the #msg_host_t on
209  * which \a process is running.
210  */
211 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
212 {
213   TRACE_msg_process_change_host(process, MSG_process_get_host(process), host);
214   simcall_process_set_host(process->getImpl(), host);
215   return MSG_OK;
216 }
217
218 /** Yield the current actor; let the other actors execute first */
219 void MSG_process_yield()
220 {
221   simgrid::simix::kernelImmediate([] { /* do nothing*/ });
222 }
223
224 /** \ingroup m_process_management
225  * \brief Returns the user data of a process.
226  *
227  * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
228  */
229 void* MSG_process_get_data(msg_process_t process)
230 {
231   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
232
233   /* get from SIMIX the MSG process data, and then the user data */
234   simgrid::MsgActorExt* msgExt = (simgrid::MsgActorExt*)process->getImpl()->data;
235   if (msgExt)
236     return msgExt->data;
237   else
238     return nullptr;
239 }
240
241 /** \ingroup m_process_management
242  * \brief Sets the user data of a process.
243  *
244  * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
245  */
246 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
247 {
248   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
249
250   static_cast<simgrid::MsgActorExt*>(process->getImpl()->data)->data = data;
251
252   return MSG_OK;
253 }
254
255 /** \ingroup m_process_management
256  * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
257  * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
258  */
259 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
260   msg_global->process_data_cleanup = data_cleanup;
261 }
262
263 /** \ingroup m_process_management
264  * \brief Return the location on which a process is running.
265  * \param process a process (nullptr means the current one)
266  * \return the msg_host_t corresponding to the location on which \a process is running.
267  */
268 msg_host_t MSG_process_get_host(msg_process_t process)
269 {
270   if (process == nullptr) {
271     return SIMIX_process_self()->host;
272   } else {
273     return process->getImpl()->host;
274   }
275 }
276
277 /** \ingroup m_process_management
278  *
279  * \brief Return a #msg_process_t given its PID.
280  *
281  * 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.
282  * If no host is found, \c nullptr is returned.
283    Note that the PID are uniq in the whole simulation, not only on a given host.
284  */
285 msg_process_t MSG_process_from_PID(int PID)
286 {
287   return SIMIX_process_from_PID(PID)->ciface();
288 }
289
290 /** @brief returns a list of all currently existing processes */
291 xbt_dynar_t MSG_processes_as_dynar() {
292   return SIMIX_processes_as_dynar();
293 }
294
295 /** @brief Return the current number MSG processes. */
296 int MSG_process_get_number()
297 {
298   return SIMIX_process_count();
299 }
300
301 /** \ingroup m_process_management
302  * \brief Set the kill time of a process.
303  *
304  * \param process a process
305  * \param kill_time the time when the process is killed.
306  */
307 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
308 {
309   simcall_process_set_kill_time(process->getImpl(), kill_time);
310   return MSG_OK;
311 }
312
313 /** \ingroup m_process_management
314  * \brief Returns the process ID of \a process.
315  *
316  * This function checks whether \a process is a valid pointer and return its PID (or 0 in case of problem).
317  */
318 int MSG_process_get_PID(msg_process_t process)
319 {
320   /* Do not raise an exception here: this function is called by the logs
321    * and the exceptions, so it would be called back again and again */
322   if (process == nullptr || process->getImpl() == nullptr)
323     return 0;
324   return process->getImpl()->pid;
325 }
326
327 /** \ingroup m_process_management
328  * \brief Returns the process ID of the parent of \a process.
329  *
330  * This function checks whether \a process is a valid pointer and return its PID.
331  * Returns -1 if the process has not been created by any other process.
332  */
333 int MSG_process_get_PPID(msg_process_t process)
334 {
335   return process->getImpl()->ppid;
336 }
337
338 /** \ingroup m_process_management
339  * \brief Return the name of a process.
340  *
341  * This function checks whether \a process is a valid pointer and return its name.
342  */
343 const char *MSG_process_get_name(msg_process_t process)
344 {
345   return process->cname();
346 }
347
348 /** \ingroup m_process_management
349  * \brief Returns the value of a given process property
350  *
351  * \param process a process
352  * \param name a property name
353  * \return value of a property (or nullptr if the property is not set)
354  */
355 const char *MSG_process_get_property_value(msg_process_t process, const char *name)
356 {
357   return (char*) xbt_dict_get_or_null(MSG_process_get_properties(process), name);
358 }
359
360 /** \ingroup m_process_management
361  * \brief Return the list of properties
362  *
363  * This function returns all the parameters associated with a process
364  */
365 xbt_dict_t MSG_process_get_properties(msg_process_t process)
366 {
367   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
368   return simcall_process_get_properties(process->getImpl());
369 }
370
371 /** \ingroup m_process_management
372  * \brief Return the PID of the current process.
373  *
374  * This function returns the PID of the currently running #msg_process_t.
375  */
376 int MSG_process_self_PID()
377 {
378   smx_actor_t self = SIMIX_process_self();
379   return self == nullptr ? 0 : self->pid;
380 }
381
382 /** \ingroup m_process_management
383  * \brief Return the PPID of the current process.
384  *
385  * This function returns the PID of the parent of the currently running #msg_process_t.
386  */
387 int MSG_process_self_PPID()
388 {
389   return MSG_process_get_PPID(MSG_process_self());
390 }
391
392 /** \ingroup m_process_management
393  * \brief Return the current process.
394  *
395  * This function returns the currently running #msg_process_t.
396  */
397 msg_process_t MSG_process_self()
398 {
399   return SIMIX_process_self()->ciface();
400 }
401
402 /** \ingroup m_process_management
403  * \brief Suspend the process.
404  *
405  * This function suspends the process by suspending the task on which it was waiting for the completion.
406  */
407 msg_error_t MSG_process_suspend(msg_process_t process)
408 {
409   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
410
411   TRACE_msg_process_suspend(process);
412   simcall_process_suspend(process->getImpl());
413   return MSG_OK;
414 }
415
416 /** \ingroup m_process_management
417  * \brief Resume a suspended process.
418  *
419  * This function resumes a suspended process by resuming the task on which it was waiting for the completion.
420  */
421 msg_error_t MSG_process_resume(msg_process_t process)
422 {
423   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
424
425   TRACE_msg_process_resume(process);
426   simcall_process_resume(process->getImpl());
427   return MSG_OK;
428 }
429
430 /** \ingroup m_process_management
431  * \brief Returns true if the process is suspended .
432  *
433  * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
434  */
435 int MSG_process_is_suspended(msg_process_t process)
436 {
437   return simcall_process_is_suspended(process->getImpl());
438 }
439
440 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
441   return SIMIX_process_get_context(process->getImpl());
442 }
443 /**
444  * \ingroup m_process_management
445  * \brief Add a function to the list of "on_exit" functions for the current process.
446  * The on_exit functions are the functions executed when your process is killed.
447  * You should use them to free the data used by your process.
448  */
449 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
450   simcall_process_on_exit(SIMIX_process_self(), fun, data);
451 }
452 /**
453  * \ingroup m_process_management
454  * \brief Sets the "auto-restart" flag of the process.
455  * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
456  */
457 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
458   simcall_process_auto_restart_set(process->getImpl(), auto_restart);
459 }
460 /**
461  * \ingroup m_process_management
462  * \brief Restarts a process from the beginning.
463  */
464 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
465   return simcall_process_restart(process->getImpl())->ciface();
466 }
467
468 /** @ingroup m_process_management
469  * @brief This process will be terminated automatically when the last non-daemon process finishes
470  */
471 XBT_PUBLIC(void) MSG_process_daemonize(msg_process_t process)
472 {
473   simgrid::simix::kernelImmediate([process]() {
474     process->getImpl()->daemonize();
475   });
476 }
477
478 /** @ingroup m_process_management
479  * @brief Take an extra reference on that process to prevent it to be garbage-collected
480  */
481 XBT_PUBLIC(void) MSG_process_ref(msg_process_t process)
482 {
483   intrusive_ptr_add_ref(process);
484 }
485 /** @ingroup m_process_management
486  * @brief Release a reference on that process so that it can get be garbage-collected
487  */
488 XBT_PUBLIC(void) MSG_process_unref(msg_process_t process)
489 {
490   intrusive_ptr_release(process);
491 }
492
493 SG_END_DECL()