Logo AND Algorithmique Numérique Distribuée

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