Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
kill another old-fashioned simcall
[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 an actor
26  * \param smx_actor a SIMIX actor
27  */
28 void MSG_process_cleanup_from_SIMIX(smx_actor_t smx_actor)
29 {
30   simgrid::msg::ActorExt* 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::msg::ActorExt*)SIMIX_process_self_get_data();
36     SIMIX_process_self_set_data(nullptr);
37   } else {
38     msg_actor = (simgrid::msg::ActorExt*)smx_actor->userdata;
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::msg::ActorExt* msgExt = new simgrid::msg::ActorExt(data);
140
141   smx_actor_t process = simcall_process_create(name, std::move(code), msgExt, host, properties);
142
143   if (not 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 =
167       SIMIX_process_attach(name, new simgrid::msg::ActorExt(data), host->getCname(), properties, nullptr);
168   if (not process)
169     xbt_die("Could not attach");
170   simcall_process_on_exit(process,(int_f_pvoid_pvoid_t)TRACE_msg_process_kill,process);
171   return process->ciface();
172 }
173
174 /** Detach a process attached with `MSG_process_attach()`
175  *
176  *  This is called when the current process has finished its job.
177  *  Used in the main thread, it waits for the simulation to finish before  returning. When it returns, the other
178  *  simulated processes and the maestro are destroyed.
179  */
180 void MSG_process_detach()
181 {
182   SIMIX_process_detach();
183 }
184
185 /** \ingroup m_process_management
186  * \param process poor victim
187  *
188  * This function simply kills a \a process... scary isn't it ? :)
189  */
190 void MSG_process_kill(msg_process_t process)
191 {
192   simcall_process_kill(process->getImpl());
193 }
194
195 /**
196 * \brief Wait for the completion of a #msg_process_t.
197 *
198 * \param process the process to wait for
199 * \param timeout wait until the process is over, or the timeout occurs
200 */
201 msg_error_t MSG_process_join(msg_process_t process, double timeout){
202   simcall_process_join(process->getImpl(), timeout);
203   return MSG_OK;
204 }
205
206 /** \ingroup m_process_management
207  * \brief Migrates a process to another location.
208  *
209  * This function checks whether \a process and \a host are valid pointers and change the value of the #msg_host_t on
210  * which \a process is running.
211  */
212 msg_error_t MSG_process_migrate(msg_process_t process, msg_host_t host)
213 {
214   TRACE_msg_process_change_host(process, MSG_process_get_host(process), host);
215   process->migrate(host);
216   return MSG_OK;
217 }
218
219 /** Yield the current actor; let the other actors execute first */
220 void MSG_process_yield()
221 {
222   simgrid::simix::kernelImmediate([] { /* do nothing*/ });
223 }
224
225 /** \ingroup m_process_management
226  * \brief Returns the user data of a process.
227  *
228  * This function checks whether \a process is a valid pointer and returns the user data associated to this process.
229  */
230 void* MSG_process_get_data(msg_process_t process)
231 {
232   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
233
234   /* get from SIMIX the MSG process data, and then the user data */
235   simgrid::msg::ActorExt* msgExt = (simgrid::msg::ActorExt*)process->getImpl()->userdata;
236   if (msgExt)
237     return msgExt->data;
238   else
239     return nullptr;
240 }
241
242 /** \ingroup m_process_management
243  * \brief Sets the user data of a process.
244  *
245  * This function checks whether \a process is a valid pointer and sets the user data associated to this process.
246  */
247 msg_error_t MSG_process_set_data(msg_process_t process, void *data)
248 {
249   xbt_assert(process != nullptr, "Invalid parameter: first parameter must not be nullptr!");
250
251   static_cast<simgrid::msg::ActorExt*>(process->getImpl()->userdata)->data = data;
252
253   return MSG_OK;
254 }
255
256 /** \ingroup m_process_management
257  * \brief Sets a cleanup function to be called to free the userdata of a process when a process is destroyed.
258  * \param data_cleanup a cleanup function for the userdata of a process, or nullptr to call no function
259  */
260 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
261   msg_global->process_data_cleanup = data_cleanup;
262 }
263
264 /** \ingroup m_process_management
265  * \brief Return the location on which a process is running.
266  * \param process a process (nullptr means the current one)
267  * \return the msg_host_t corresponding to the location on which \a process is running.
268  */
269 msg_host_t MSG_process_get_host(msg_process_t process)
270 {
271   if (process == nullptr) {
272     return SIMIX_process_self()->host;
273   } else {
274     return process->getImpl()->host;
275   }
276 }
277
278 /** \ingroup m_process_management
279  *
280  * \brief Return a #msg_process_t given its PID.
281  *
282  * 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.
283  * If no host is found, \c nullptr is returned.
284    Note that the PID are uniq in the whole simulation, not only on a given host.
285  */
286 msg_process_t MSG_process_from_PID(int PID)
287 {
288   return SIMIX_process_from_PID(PID)->ciface();
289 }
290
291 /** @brief returns a list of all currently existing processes */
292 xbt_dynar_t MSG_processes_as_dynar() {
293   return SIMIX_processes_as_dynar();
294 }
295
296 /** @brief Return the current number MSG processes. */
297 int MSG_process_get_number()
298 {
299   return SIMIX_process_count();
300 }
301
302 /** \ingroup m_process_management
303  * \brief Set the kill time of a process.
304  *
305  * \param process a process
306  * \param kill_time the time when the process is killed.
307  */
308 msg_error_t MSG_process_set_kill_time(msg_process_t process, double kill_time)
309 {
310   simcall_process_set_kill_time(process->getImpl(), kill_time);
311   return MSG_OK;
312 }
313
314 /** \ingroup m_process_management
315  * \brief Returns the process ID of \a process.
316  *
317  * This function checks whether \a process is a valid pointer and return its PID (or 0 in case of problem).
318  */
319 int MSG_process_get_PID(msg_process_t process)
320 {
321   /* Do not raise an exception here: this function is called by the logs
322    * and the exceptions, so it would be called back again and again */
323   if (process == nullptr || process->getImpl() == nullptr)
324     return 0;
325   return process->getImpl()->pid;
326 }
327
328 /** \ingroup m_process_management
329  * \brief Returns the process ID of the parent of \a process.
330  *
331  * This function checks whether \a process is a valid pointer and return its PID.
332  * Returns -1 if the process has not been created by any other process.
333  */
334 int MSG_process_get_PPID(msg_process_t process)
335 {
336   return process->getImpl()->ppid;
337 }
338
339 /** \ingroup m_process_management
340  * \brief Return the name of a process.
341  *
342  * This function checks whether \a process is a valid pointer and return its name.
343  */
344 const char *MSG_process_get_name(msg_process_t process)
345 {
346   return process->getCname();
347 }
348
349 /** \ingroup m_process_management
350  * \brief Returns the value of a given process property
351  *
352  * \param process a process
353  * \param name a property name
354  * \return value of a property (or nullptr if the property is not set)
355  */
356 const char *MSG_process_get_property_value(msg_process_t process, const char *name)
357 {
358   return (char*) xbt_dict_get_or_null(MSG_process_get_properties(process), name);
359 }
360
361 /** \ingroup m_process_management
362  * \brief Return the list of properties
363  *
364  * This function returns all the parameters associated with a process
365  */
366 xbt_dict_t MSG_process_get_properties(msg_process_t process)
367 {
368   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
369   return simcall_process_get_properties(process->getImpl());
370 }
371
372 /** \ingroup m_process_management
373  * \brief Return the PID of the current process.
374  *
375  * This function returns the PID of the currently running #msg_process_t.
376  */
377 int MSG_process_self_PID()
378 {
379   smx_actor_t self = SIMIX_process_self();
380   return self == nullptr ? 0 : self->pid;
381 }
382
383 /** \ingroup m_process_management
384  * \brief Return the PPID of the current process.
385  *
386  * This function returns the PID of the parent of the currently running #msg_process_t.
387  */
388 int MSG_process_self_PPID()
389 {
390   return MSG_process_get_PPID(MSG_process_self());
391 }
392
393 /** \ingroup m_process_management
394  * \brief Return the name of the current process.
395  */
396 const char* MSG_process_self_name()
397 {
398   return SIMIX_process_self_get_name();
399 }
400
401 /** \ingroup m_process_management
402  * \brief Return the current process.
403  *
404  * This function returns the currently running #msg_process_t.
405  */
406 msg_process_t MSG_process_self()
407 {
408   return SIMIX_process_self()->ciface();
409 }
410
411 /** \ingroup m_process_management
412  * \brief Suspend the process.
413  *
414  * This function suspends the process by suspending the task on which it was waiting for the completion.
415  */
416 msg_error_t MSG_process_suspend(msg_process_t process)
417 {
418   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
419
420   TRACE_msg_process_suspend(process);
421   simcall_process_suspend(process->getImpl());
422   return MSG_OK;
423 }
424
425 /** \ingroup m_process_management
426  * \brief Resume a suspended process.
427  *
428  * This function resumes a suspended process by resuming the task on which it was waiting for the completion.
429  */
430 msg_error_t MSG_process_resume(msg_process_t process)
431 {
432   xbt_assert(process != nullptr, "Invalid parameter: First argument must not be nullptr");
433
434   TRACE_msg_process_resume(process);
435   process->resume();
436   return MSG_OK;
437 }
438
439 /** \ingroup m_process_management
440  * \brief Returns true if the process is suspended .
441  *
442  * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
443  */
444 int MSG_process_is_suspended(msg_process_t process)
445 {
446   return process->isSuspended();
447 }
448
449 smx_context_t MSG_process_get_smx_ctx(msg_process_t process) {
450   return process->getImpl()->context;
451 }
452 /**
453  * \ingroup m_process_management
454  * \brief Add a function to the list of "on_exit" functions for the current process.
455  * The on_exit functions are the functions executed when your process is killed.
456  * You should use them to free the data used by your process.
457  */
458 void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data) {
459   simcall_process_on_exit(SIMIX_process_self(), fun, data);
460 }
461 /**
462  * \ingroup m_process_management
463  * \brief Sets the "auto-restart" flag of the process.
464  * If the flag is set to 1, the process will be automatically restarted when its host comes back up.
465  */
466 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart) {
467   simgrid::simix::kernelImmediate([process, auto_restart]() { process->getImpl()->auto_restart = auto_restart; });
468 }
469 /**
470  * \ingroup m_process_management
471  * \brief Restarts a process from the beginning.
472  */
473 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process) {
474   return simcall_process_restart(process->getImpl())->ciface();
475 }
476
477 /** @ingroup m_process_management
478  * @brief This process will be terminated automatically when the last non-daemon process finishes
479  */
480 XBT_PUBLIC(void) MSG_process_daemonize(msg_process_t process)
481 {
482   simgrid::simix::kernelImmediate([process]() { process->getImpl()->daemonize(); });
483 }
484
485 /** @ingroup m_process_management
486  * @brief Take an extra reference on that process to prevent it to be garbage-collected
487  */
488 XBT_PUBLIC(void) MSG_process_ref(msg_process_t process)
489 {
490   intrusive_ptr_add_ref(process);
491 }
492 /** @ingroup m_process_management
493  * @brief Release a reference on that process so that it can get be garbage-collected
494  */
495 XBT_PUBLIC(void) MSG_process_unref(msg_process_t process)
496 {
497   intrusive_ptr_release(process);
498 }
499
500 SG_END_DECL()