Logo AND Algorithmique Numérique Distribuée

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