Logo AND Algorithmique Numérique Distribuée

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