Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot//simgrid/simgrid
[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)
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   MSG_process_set_kill_time(p,kill_time);
75   *((m_process_t*) process) = p;
76 }
77
78 /** \ingroup m_process_management
79  * \brief Creates and runs a new #m_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 m_process_t MSG_process_create(const char *name,
86                                xbt_main_func_t code, void *data,
87                                m_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 #m_process_t.
95
96  * A constructor for #m_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 #m_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 #m_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 m_process_t
115  * \return The new corresponding object.
116  */
117
118 m_process_t MSG_process_create_with_arguments(const char *name,
119                                               xbt_main_func_t code,
120                                               void *data, m_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 #m_process_t.
129
130  * A constructor for #m_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 #m_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 #m_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
148  * \param properties list a properties defined for this process
149  * \see m_process_t
150  * \return The new corresponding object.
151  */
152 m_process_t MSG_process_create_with_environment(const char *name,
153                                                 xbt_main_func_t code,
154                                                 void *data, m_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   m_process_t process;
161
162   /* Simulator data for MSG */
163   simdata->PID = msg_global->PID++;
164   simdata->waiting_action = NULL;
165   simdata->waiting_task = NULL;
166   simdata->m_host = host;
167   simdata->argc = argc;
168   simdata->argv = argv;
169   simdata->data = data;
170   simdata->last_errno = MSG_OK;
171
172   if (SIMIX_process_self()) {
173     simdata->PPID = MSG_process_get_PID(MSG_process_self());
174   } else {
175     simdata->PPID = -1;
176   }
177
178 #ifdef HAVE_TRACING
179   TRACE_msg_process_create(name, simdata->PID, simdata->m_host);
180 #endif
181
182   /* Let's create the process: SIMIX may decide to start it right now,
183    * even before returning the flow control to us */
184   simcall_process_create(&process, name, code, simdata, SIMIX_host_get_name(host->smx_host), -1,
185                            argc, argv, properties);
186
187   if (!process) {
188     /* Undo everything we have just changed */
189     msg_global->PID--;
190     xbt_free(simdata);
191     return NULL;
192   }
193
194   return process;
195 }
196
197 void MSG_process_kill_from_SIMIX(smx_process_t p)
198 {
199 #ifdef HAVE_TRACING
200   TRACE_msg_process_kill(p);
201 #endif
202   MSG_process_kill(p);
203 }
204
205 /** \ingroup m_process_management
206  * \param process poor victim
207  *
208  * This function simply kills a \a process... scary isn't it ? :)
209  */
210 void MSG_process_kill(m_process_t process)
211 {
212 #ifdef HAVE_TRACING
213   TRACE_msg_process_kill(process);
214 #endif
215
216 //  /* FIXME: why do we only cancel communication actions? is this useful? */
217 //  simdata_process_t p_simdata = simcall_process_get_data(process);
218 //  if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
219 //    simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
220 //  }
221  
222   simcall_process_kill(process);
223
224   return;
225 }
226
227 /** \ingroup m_process_management
228  * \brief Migrates a process to another location.
229  *
230  * This function checks whether \a process and \a host are valid pointers
231    and change the value of the #m_host_t on which \a process is running.
232  */
233 MSG_error_t MSG_process_migrate(m_process_t process, m_host_t host)
234 {
235   simdata_process_t simdata = simcall_process_get_data(process);
236   simdata->m_host = host;
237 #ifdef HAVE_TRACING
238   m_host_t now = simdata->m_host;
239   TRACE_msg_process_change_host(process, now, host);
240 #endif
241   simcall_process_change_host(process, host->smx_host);
242   return MSG_OK;
243 }
244
245 /** \ingroup m_process_management
246  * \brief Returns the user data of a process.
247  *
248  * This function checks whether \a process is a valid pointer or not
249    and returns the user data associated to this process.
250  */
251 void* MSG_process_get_data(m_process_t process)
252 {
253   xbt_assert(process != NULL, "Invalid parameter");
254
255   /* get from SIMIX the MSG process data, and then the user data */
256   simdata_process_t simdata = simcall_process_get_data(process);
257   return simdata->data;
258 }
259
260 /** \ingroup m_process_management
261  * \brief Sets the user data of a process.
262  *
263  * This function checks whether \a process is a valid pointer or not
264    and sets the user data associated to this process.
265  */
266 MSG_error_t MSG_process_set_data(m_process_t process, void *data)
267 {
268   xbt_assert(process != NULL, "Invalid parameter");
269
270   simdata_process_t simdata = simcall_process_get_data(process);
271   simdata->data = data;
272
273   return MSG_OK;
274 }
275
276 /** \ingroup m_process_management
277  * \brief Sets a cleanup function to be called to free the userdata of a
278  * process when a process is destroyed.
279  * \param data_cleanup a cleanup function for the userdata of a process,
280  * or NULL to call no function
281  */
282 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup) {
283
284   msg_global->process_data_cleanup = data_cleanup;
285 }
286
287 /** \ingroup m_process_management
288  * \brief Return the location on which a process is running.
289  * \param process a process (NULL means the current one)
290  * \return the m_host_t corresponding to the location on which \a
291  * process is running.
292  */
293 m_host_t MSG_process_get_host(m_process_t process)
294 {
295   simdata_process_t simdata;
296   if (process == NULL) {
297     simdata = SIMIX_process_self_get_data(SIMIX_process_self());
298   }
299   else {
300     simdata = simcall_process_get_data(process);
301   }
302   return simdata->m_host;
303 }
304
305 /** \ingroup m_process_management
306  *
307  * \brief Return a #m_process_t given its PID.
308  *
309  * This function search in the list of all the created m_process_t for a m_process_t
310    whose PID is equal to \a PID. If no host is found, \c NULL is returned.
311    Note that the PID are uniq in the whole simulation, not only on a given host.
312  */
313 m_process_t MSG_process_from_PID(int PID)
314 {
315   return SIMIX_process_from_PID(PID);
316 }
317
318 /** @brief returns a list of all currently existing processes */
319 xbt_dynar_t MSG_processes_as_dynar(void) {
320   return SIMIX_processes_as_dynar();
321 }
322
323 /** \ingroup m_process_management
324  * \brief Set the kill time of a process.
325  *
326  * \param process a process
327  * \param kill_time the time when the process is killed.
328  */
329 MSG_error_t MSG_process_set_kill_time(m_process_t process, double kill_time)
330 {
331   simcall_process_set_kill_time(process,kill_time);
332   return MSG_OK;
333 }
334
335 /** \ingroup m_process_management
336  * \brief Returns the process ID of \a process.
337  *
338  * This function checks whether \a process is a valid pointer or not
339    and return its PID (or 0 in case of problem).
340  */
341 int MSG_process_get_PID(m_process_t process)
342 {
343   /* Do not raise an exception here: this function is called by the logs
344    * and the exceptions, so it would be called back again and again */
345   if (process == NULL) {
346     return 0;
347   }
348
349   simdata_process_t simdata = simcall_process_get_data(process);
350
351   return simdata != NULL ? simdata->PID : 0;
352 }
353
354 /** \ingroup m_process_management
355  * \brief Returns the process ID of the parent of \a process.
356  *
357  * This function checks whether \a process is a valid pointer or not
358    and return its PID. Returns -1 if the process has not been created by
359    any other process.
360  */
361 int MSG_process_get_PPID(m_process_t process)
362 {
363   xbt_assert(process != NULL, "Invalid parameter");
364
365   simdata_process_t simdata = simcall_process_get_data(process);
366
367   return simdata->PPID;
368 }
369
370 /** \ingroup m_process_management
371  * \brief Return the name of a process.
372  *
373  * This function checks whether \a process is a valid pointer or not
374    and return its name.
375  */
376 const char *MSG_process_get_name(m_process_t process)
377 {
378   xbt_assert(process, "Invalid parameter");
379
380   return simcall_process_get_name(process);
381 }
382
383 /** \ingroup m_process_management
384  * \brief Returns the value of a given process property
385  *
386  * \param process a process
387  * \param name a property name
388  * \return value of a property (or NULL if the property is not set)
389  */
390 const char *MSG_process_get_property_value(m_process_t process,
391                                            const char *name)
392 {
393   return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
394 }
395
396 /** \ingroup m_process_management
397  * \brief Return the list of properties
398  *
399  * This function returns all the parameters associated with a process
400  */
401 xbt_dict_t MSG_process_get_properties(m_process_t process)
402 {
403   xbt_assert(process != NULL, "Invalid parameter");
404
405   return simcall_process_get_properties(process);
406
407 }
408
409 /** \ingroup m_process_management
410  * \brief Return the PID of the current process.
411  *
412  * This function returns the PID of the currently running #m_process_t.
413  */
414 int MSG_process_self_PID(void)
415 {
416   return MSG_process_get_PID(MSG_process_self());
417 }
418
419 /** \ingroup m_process_management
420  * \brief Return the PPID of the current process.
421  *
422  * This function returns the PID of the parent of the currently
423  * running #m_process_t.
424  */
425 int MSG_process_self_PPID(void)
426 {
427   return MSG_process_get_PPID(MSG_process_self());
428 }
429
430 /** \ingroup m_process_management
431  * \brief Return the current process.
432  *
433  * This function returns the currently running #m_process_t.
434  */
435 m_process_t MSG_process_self(void)
436 {
437   return SIMIX_process_self();
438 }
439
440 /** \ingroup m_process_management
441  * \brief Suspend the process.
442  *
443  * This function suspends the process by suspending the task on which
444  * it was waiting for the completion.
445  */
446 MSG_error_t MSG_process_suspend(m_process_t process)
447 {
448   xbt_assert(process != NULL, "Invalid parameter");
449
450 #ifdef HAVE_TRACING
451   TRACE_msg_process_suspend(process);
452 #endif
453
454   simcall_process_suspend(process);
455   MSG_RETURN(MSG_OK);
456 }
457
458 /** \ingroup m_process_management
459  * \brief Resume a suspended process.
460  *
461  * This function resumes a suspended process by resuming the task on
462  * which it was waiting for the completion.
463  */
464 MSG_error_t MSG_process_resume(m_process_t process)
465 {
466   xbt_assert(process != NULL, "Invalid parameter");
467
468 #ifdef HAVE_TRACING
469   TRACE_msg_process_resume(process);
470 #endif
471
472   simcall_process_resume(process);
473   MSG_RETURN(MSG_OK);
474 }
475
476 /** \ingroup m_process_management
477  * \brief Returns true if the process is suspended .
478  *
479  * This checks whether a process is suspended or not by inspecting the
480  * task on which it was waiting for the completion.
481  */
482 int MSG_process_is_suspended(m_process_t process)
483 {
484   xbt_assert(process != NULL, "Invalid parameter");
485   return simcall_process_is_suspended(process);
486 }
487
488 smx_context_t MSG_process_get_smx_ctx(m_process_t process) {
489   return SIMIX_process_get_context(process);
490 }
491 /**
492  * \ingroup m_process_management
493  * \brief Add a function to the list of "on_exit" functions for the current process.
494  * The on_exit functions are the functions executed when your process is killed.
495  * You should use them to free the data used by your process.
496  */
497 void MSG_process_on_exit_add(int_f_pvoid_t fun, void *data) {
498   SIMIX_process_on_exit_add(fun,data);
499 }