Logo AND Algorithmique Numérique Distribuée

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