Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
8da8fac97298b23969618e020119632f2fe3dc9e
[simgrid.git] / src / msg / msg_process.c
1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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 m_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
49   // free the data if a function was provided
50   if (msg_proc->data && msg_global->process_data_cleanup) {
51     msg_global->process_data_cleanup(msg_proc->data);
52   }
53
54   // remove the process from its virtual machine
55   if (msg_proc->vm) {
56     int pos = xbt_dynar_search(msg_proc->vm->processes,&smx_proc);
57     xbt_dynar_remove_at(msg_proc->vm->processes,pos, NULL);
58   }
59
60   // free the MSG process
61   xbt_free(msg_proc);
62 }
63
64 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
65 void MSG_process_create_from_SIMIX(smx_process_t* process, const char *name,
66                                     xbt_main_func_t code, void *data,
67                                     const char *hostname, double kill_time, int argc, char **argv,
68                                     xbt_dict_t properties, int auto_restart)
69 {
70   m_host_t host = MSG_get_host_by_name(hostname);
71   m_process_t p = MSG_process_create_with_environment(name, code, data,
72                                                       host, argc, argv,
73                                                       properties);
74   if (p) {
75     MSG_process_set_kill_time(p,kill_time);
76     MSG_process_auto_restart_set(p,auto_restart);
77   }
78   *((m_process_t*) process) = p;
79 }
80
81 /** \ingroup m_process_management
82  * \brief Creates and runs a new #m_process_t.
83  *
84  * Does exactly the same as #MSG_process_create_with_arguments but without
85    providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
86  * \sa MSG_process_create_with_arguments
87  */
88 m_process_t MSG_process_create(const char *name,
89                                xbt_main_func_t code, void *data,
90                                m_host_t host)
91 {
92   return MSG_process_create_with_environment(name, code, data, host, -1,
93                                              NULL, NULL);
94 }
95
96 /** \ingroup m_process_management
97  * \brief Creates and runs a new #m_process_t.
98
99  * A constructor for #m_process_t taking four arguments and returning the
100  * corresponding object. The structure (and the corresponding thread) is
101  * created, and put in the list of ready process.
102  * \param name a name for the object. It is for user-level information
103    and can be NULL.
104  * \param code is a function describing the behavior of the process. It
105    should then only use functions described in \ref
106    m_process_management (to create a new #m_process_t for example),
107    in \ref m_host_management (only the read-only functions i.e. whose
108    name contains the word get), in \ref m_task_management (to create
109    or destroy some #m_task_t for example) and in \ref
110    msg_task_usage (to handle file transfers and task processing).
111  * \param data a pointer to any data one may want to attach to the new
112    object.  It is for user-level information and can be NULL. It can
113    be retrieved with the function \ref MSG_process_get_data.
114  * \param host the location where the new process is executed.
115  * \param argc first argument passed to \a code
116  * \param argv second argument passed to \a code
117  * \see m_process_t
118  * \return The new corresponding object.
119  */
120
121 m_process_t MSG_process_create_with_arguments(const char *name,
122                                               xbt_main_func_t code,
123                                               void *data, m_host_t host,
124                                               int argc, char **argv)
125 {
126   return MSG_process_create_with_environment(name, code, data, host,
127                                              argc, argv, NULL);
128 }
129
130 /** \ingroup m_process_management
131  * \brief Creates and runs a new #m_process_t.
132
133  * A constructor for #m_process_t taking four arguments and returning the
134  * corresponding object. The structure (and the corresponding thread) is
135  * created, and put in the list of ready process.
136  * \param name a name for the object. It is for user-level information
137    and can be NULL.
138  * \param code is a function describing the behavior of the process. It
139    should then only use functions described in \ref
140    m_process_management (to create a new #m_process_t for example),
141    in \ref m_host_management (only the read-only functions i.e. whose
142    name contains the word get), in \ref m_task_management (to create
143    or destroy some #m_task_t for example) and in \ref
144    msg_task_usage (to handle file transfers and task processing).
145  * \param data a pointer to any data one may want to attach to the new
146    object.  It is for user-level information and can be NULL. It can
147    be retrieved with the function \ref MSG_process_get_data.
148  * \param host the location where the new process is executed.
149  * \param argc first argument passed to \a code
150  * \param argv second argument passed to \a code
151  * \param properties list a properties defined for this process
152  * \see m_process_t
153  * \return The new corresponding object.
154  */
155 m_process_t MSG_process_create_with_environment(const char *name,
156                                                 xbt_main_func_t code,
157                                                 void *data, m_host_t host,
158                                                 int argc, char **argv,
159                                                 xbt_dict_t properties)
160 {
161   xbt_assert(code != NULL && host != NULL, "Invalid parameters");
162   simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
163   m_process_t process;
164
165   /* Simulator data for MSG */
166   simdata->PID = msg_global->PID++;
167   simdata->waiting_action = NULL;
168   simdata->waiting_task = NULL;
169   simdata->m_host = host;
170   simdata->argc = argc;
171   simdata->argv = argv;
172   simdata->data = data;
173   simdata->last_errno = MSG_OK;
174
175   if (SIMIX_process_self()) {
176     simdata->PPID = MSG_process_get_PID(MSG_process_self());
177   } else {
178     simdata->PPID = -1;
179   }
180
181 #ifdef HAVE_TRACING
182   TRACE_msg_process_create(name, simdata->PID, simdata->m_host);
183   #endif
184   /* Let's create the process: SIMIX may decide to start it right now,
185    * even before returning the flow control to us */
186   simcall_process_create(&process, name, code, simdata, SIMIX_host_get_name(host->smx_host), -1,
187                            argc, argv, properties,0);
188
189   if (!process) {
190     /* Undo everything we have just changed */
191     msg_global->PID--;
192     xbt_free(simdata);
193     return NULL;
194   }
195   else {
196     #ifdef HAVE_TRACING
197     simcall_process_on_exit(process,(int_f_pvoid_t)TRACE_msg_process_kill,MSG_process_self());
198     #endif
199   }
200   return process;
201 }
202
203 /** \ingroup m_process_management
204  * \param process poor victim
205  *
206  * This function simply kills a \a process... scary isn't it ? :)
207  */
208 void MSG_process_kill(m_process_t process)
209 {
210 //  /* FIXME: why do we only cancel communication actions? is this useful? */
211 //  simdata_process_t p_simdata = simcall_process_get_data(process);
212 //  if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
213 //    simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
214 //  }
215  
216   simcall_process_kill(process);
217
218   return;
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 #m_host_t on which \a process is running.
226  */
227 MSG_error_t MSG_process_migrate(m_process_t process, m_host_t host)
228 {
229   simdata_process_t simdata = simcall_process_get_data(process);
230   simdata->m_host = host;
231 #ifdef HAVE_TRACING
232   m_host_t now = simdata->m_host;
233   TRACE_msg_process_change_host(process, now, host);
234 #endif
235   simcall_process_change_host(process, host->smx_host);
236   return MSG_OK;
237 }
238
239 /** \ingroup m_process_management
240  * \brief Returns the user data of a process.
241  *
242  * This function checks whether \a process is a valid pointer or not
243    and returns the user data associated to this process.
244  */
245 void* MSG_process_get_data(m_process_t process)
246 {
247   xbt_assert(process != NULL, "Invalid parameter");
248
249   /* get from SIMIX the MSG process data, and then the user data */
250   simdata_process_t simdata = simcall_process_get_data(process);
251   return simdata->data;
252 }
253
254 /** \ingroup m_process_management
255  * \brief Sets the user data of a process.
256  *
257  * This function checks whether \a process is a valid pointer or not
258    and sets the user data associated to this process.
259  */
260 MSG_error_t MSG_process_set_data(m_process_t process, void *data)
261 {
262   xbt_assert(process != NULL, "Invalid parameter");
263
264   simdata_process_t simdata = simcall_process_get_data(process);
265   simdata->data = data;
266
267   return MSG_OK;
268 }
269
270 /** \ingroup m_process_management
271  * \brief Sets a cleanup function to be called to free the userdata of a
272  * process when a process is destroyed.
273  * \param data_cleanup a cleanup function for the userdata of a process,
274  * or NULL to call no function
275  */
276 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
277
278   msg_global->process_data_cleanup = data_cleanup;
279 }
280
281 /** \ingroup m_process_management
282  * \brief Return the location on which a process is running.
283  * \param process a process (NULL means the current one)
284  * \return the m_host_t corresponding to the location on which \a
285  * process is running.
286  */
287 m_host_t MSG_process_get_host(m_process_t process)
288 {
289   simdata_process_t simdata;
290   if (process == NULL) {
291     simdata = SIMIX_process_self_get_data(SIMIX_process_self());
292   }
293   else {
294     simdata = simcall_process_get_data(process);
295   }
296   return simdata->m_host;
297 }
298
299 /** \ingroup m_process_management
300  *
301  * \brief Return a #m_process_t given its PID.
302  *
303  * This function search in the list of all the created m_process_t for a m_process_t
304    whose PID is equal to \a PID. If no host is found, \c NULL is returned.
305    Note that the PID are uniq in the whole simulation, not only on a given host.
306  */
307 m_process_t MSG_process_from_PID(int PID)
308 {
309   return SIMIX_process_from_PID(PID);
310 }
311
312 /** @brief returns a list of all currently existing processes */
313 xbt_dynar_t MSG_processes_as_dynar(void) {
314   return SIMIX_processes_as_dynar();
315 }
316
317 /** \ingroup m_process_management
318  * \brief Set the kill time of a process.
319  *
320  * \param process a process
321  * \param kill_time the time when the process is killed.
322  */
323 MSG_error_t MSG_process_set_kill_time(m_process_t process, double kill_time)
324 {
325   simcall_process_set_kill_time(process,kill_time);
326   return MSG_OK;
327 }
328
329 /** \ingroup m_process_management
330  * \brief Returns the process ID of \a process.
331  *
332  * This function checks whether \a process is a valid pointer or not
333    and return its PID (or 0 in case of problem).
334  */
335 int MSG_process_get_PID(m_process_t process)
336 {
337   /* Do not raise an exception here: this function is called by the logs
338    * and the exceptions, so it would be called back again and again */
339   if (process == NULL) {
340     return 0;
341   }
342
343   simdata_process_t simdata = simcall_process_get_data(process);
344
345   return simdata != NULL ? simdata->PID : 0;
346 }
347
348 /** \ingroup m_process_management
349  * \brief Returns the process ID of the parent of \a process.
350  *
351  * This function checks whether \a process is a valid pointer or not
352    and return its PID. Returns -1 if the process has not been created by
353    any other process.
354  */
355 int MSG_process_get_PPID(m_process_t process)
356 {
357   xbt_assert(process != NULL, "Invalid parameter");
358
359   simdata_process_t simdata = simcall_process_get_data(process);
360
361   return simdata->PPID;
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(m_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(m_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(m_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 #m_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 #m_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 #m_process_t.
428  */
429 m_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(m_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(m_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(m_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(m_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_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(m_process_t process, int auto_restart) {
501   simcall_process_auto_restart_set(process,auto_restart);
502 }