Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Rewrite the kill_time mecanism.
[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   // free the MSG process
55   xbt_free(msg_proc);
56 }
57
58 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
59 void MSG_process_create_from_SIMIX(smx_process_t* process, const char *name,
60                                     xbt_main_func_t code, void *data,
61                                     const char *hostname, double kill_time, int argc, char **argv,
62                                     xbt_dict_t properties)
63 {
64   m_host_t host = MSG_get_host_by_name(hostname);
65   m_process_t p = MSG_process_create_with_environment(name, code, data,
66                                                       host, kill_time, argc, argv,
67                                                       properties);
68   *((m_process_t*) process) = p;
69 }
70
71 /** \ingroup m_process_management
72  * \brief Creates and runs a new #m_process_t.
73  *
74  * Does exactly the same as #MSG_process_create_with_arguments but without
75    providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
76  * \sa MSG_process_create_with_arguments
77  */
78 m_process_t MSG_process_create(const char *name,
79                                xbt_main_func_t code, void *data,
80                                m_host_t host)
81 {
82   return MSG_process_create_with_environment(name, code, data, host, -1, -1,
83                                              NULL, NULL);
84 }
85
86 /** \ingroup m_process_management
87  * \brief Creates and runs a new #m_process_t.
88
89  * A constructor for #m_process_t taking four arguments and returning the
90  * corresponding object. The structure (and the corresponding thread) is
91  * created, and put in the list of ready process.
92  * \param name a name for the object. It is for user-level information
93    and can be NULL.
94  * \param code is a function describing the behavior of the process. It
95    should then only use functions described in \ref
96    m_process_management (to create a new #m_process_t for example),
97    in \ref m_host_management (only the read-only functions i.e. whose
98    name contains the word get), in \ref m_task_management (to create
99    or destroy some #m_task_t for example) and in \ref
100    msg_task_usage (to handle file transfers and task processing).
101  * \param data a pointer to any data one may want to attach to the new
102    object.  It is for user-level information and can be NULL. It can
103    be retrieved with the function \ref MSG_process_get_data.
104  * \param host the location where the new process is executed.
105  * \param argc first argument passed to \a code
106  * \param argv second argument passed to \a code
107  * \see m_process_t
108  * \return The new corresponding object.
109  */
110
111 m_process_t MSG_process_create_with_arguments(const char *name,
112                                               xbt_main_func_t code,
113                                               void *data, m_host_t host,
114                                               int argc, char **argv)
115 {
116   return MSG_process_create_with_environment(name, code, data, host, -1.0,
117                                              argc, argv, NULL);
118 }
119
120 /** \ingroup m_process_management
121  * \brief Creates and runs a new #m_process_t.
122
123  * A constructor for #m_process_t taking four arguments and returning the
124  * corresponding object. The structure (and the corresponding thread) is
125  * created, and put in the list of ready process.
126  * \param name a name for the object. It is for user-level information
127    and can be NULL.
128  * \param code is a function describing the behavior of the process. It
129    should then only use functions described in \ref
130    m_process_management (to create a new #m_process_t for example),
131    in \ref m_host_management (only the read-only functions i.e. whose
132    name contains the word get), in \ref m_task_management (to create
133    or destroy some #m_task_t for example) and in \ref
134    msg_task_usage (to handle file transfers and task processing).
135  * \param data a pointer to any data one may want to attach to the new
136    object.  It is for user-level information and can be NULL. It can
137    be retrieved with the function \ref MSG_process_get_data.
138  * \param host the location where the new process is executed.
139  * \param kill_time the time when the process is killed.
140  * \param argc first argument passed to \a code
141  * \param argv second argument passed to \a code
142  * \param properties list a properties defined for this process
143  * \see m_process_t
144  * \return The new corresponding object.
145  */
146 m_process_t MSG_process_create_with_environment(const char *name,
147                                                 xbt_main_func_t code,
148                                                 void *data, m_host_t host,
149                                                 double kill_time,
150                                                 int argc, char **argv,
151                                                 xbt_dict_t properties)
152 {
153   xbt_assert(code != NULL && host != NULL, "Invalid parameters");
154   simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
155   m_process_t process;
156
157   /* Simulator data for MSG */
158   simdata->PID = msg_global->PID++;
159   simdata->waiting_action = NULL;
160   simdata->waiting_task = NULL;
161   simdata->m_host = host;
162   simdata->argc = argc;
163   simdata->argv = argv;
164   simdata->data = data;
165   simdata->last_errno = MSG_OK;
166
167   if (SIMIX_process_self()) {
168     simdata->PPID = MSG_process_get_PID(MSG_process_self());
169   } else {
170     simdata->PPID = -1;
171   }
172
173 #ifdef HAVE_TRACING
174   TRACE_msg_process_create(name, simdata->PID, simdata->m_host);
175 #endif
176
177   /* Let's create the process: SIMIX may decide to start it right now,
178    * even before returning the flow control to us */
179   simcall_process_create(&process, name, code, simdata, host->name, kill_time,
180                            argc, argv, properties);
181
182   if (!process) {
183     /* Undo everything we have just changed */
184     msg_global->PID--;
185     xbt_free(simdata);
186     return NULL;
187   }
188
189   return process;
190 }
191
192 void MSG_process_kill_from_SIMIX(smx_process_t p)
193 {
194 #ifdef HAVE_TRACING
195   TRACE_msg_process_kill(p);
196 #endif
197   MSG_process_kill(p);
198 }
199
200 /** \ingroup m_process_management
201  * \param process poor victim
202  *
203  * This function simply kills a \a process... scary isn't it ? :)
204  */
205 void MSG_process_kill(m_process_t process)
206 {
207 #ifdef HAVE_TRACING
208   TRACE_msg_process_kill(process);
209 #endif
210
211 //  /* FIXME: why do we only cancel communication actions? is this useful? */
212 //  simdata_process_t p_simdata = simcall_process_get_data(process);
213 //  if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
214 //    simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
215 //  }
216  
217   simcall_process_kill(process);
218
219   return;
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 #m_host_t on which \a process is running.
227  */
228 MSG_error_t MSG_process_migrate(m_process_t process, m_host_t host)
229 {
230   simdata_process_t simdata = simcall_process_get_data(process);
231   simdata->m_host = host;
232 #ifdef HAVE_TRACING
233   m_host_t now = simdata->m_host;
234   TRACE_msg_process_change_host(process, now, host);
235 #endif
236   simcall_process_change_host(process, host->simdata->smx_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(m_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(m_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 m_host_t corresponding to the location on which \a
286  * process is running.
287  */
288 m_host_t MSG_process_get_host(m_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 #m_process_t given its PID.
303  *
304  * This function search in the list of all the created m_process_t for a m_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 m_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
318 /** \ingroup m_process_management
319  * \brief Returns the process ID of \a process.
320  *
321  * This function checks whether \a process is a valid pointer or not
322    and return its PID (or 0 in case of problem).
323  */
324 int MSG_process_get_PID(m_process_t process)
325 {
326   /* Do not raise an exception here: this function is called by the logs
327    * and the exceptions, so it would be called back again and again */
328   if (process == NULL) {
329     return 0;
330   }
331
332   simdata_process_t simdata = simcall_process_get_data(process);
333
334   return simdata != NULL ? simdata->PID : 0;
335 }
336
337 /** \ingroup m_process_management
338  * \brief Returns the process ID of the parent of \a process.
339  *
340  * This function checks whether \a process is a valid pointer or not
341    and return its PID. Returns -1 if the process has not been created by
342    any other process.
343  */
344 int MSG_process_get_PPID(m_process_t process)
345 {
346   xbt_assert(process != NULL, "Invalid parameter");
347
348   simdata_process_t simdata = simcall_process_get_data(process);
349
350   return simdata->PPID;
351 }
352
353 /** \ingroup m_process_management
354  * \brief Return the name of a process.
355  *
356  * This function checks whether \a process is a valid pointer or not
357    and return its name.
358  */
359 const char *MSG_process_get_name(m_process_t process)
360 {
361   xbt_assert(process, "Invalid parameter");
362
363   return simcall_process_get_name(process);
364 }
365
366 /** \ingroup m_process_management
367  * \brief Returns the value of a given process property
368  *
369  * \param process a process
370  * \param name a property name
371  * \return value of a property (or NULL if the property is not set)
372  */
373 const char *MSG_process_get_property_value(m_process_t process,
374                                            const char *name)
375 {
376   return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
377 }
378
379 /** \ingroup m_process_management
380  * \brief Return the list of properties
381  *
382  * This function returns all the parameters associated with a process
383  */
384 xbt_dict_t MSG_process_get_properties(m_process_t process)
385 {
386   xbt_assert(process != NULL, "Invalid parameter");
387
388   return simcall_process_get_properties(process);
389
390 }
391
392 /** \ingroup m_process_management
393  * \brief Return the PID of the current process.
394  *
395  * This function returns the PID of the currently running #m_process_t.
396  */
397 int MSG_process_self_PID(void)
398 {
399   return MSG_process_get_PID(MSG_process_self());
400 }
401
402 /** \ingroup m_process_management
403  * \brief Return the PPID of the current process.
404  *
405  * This function returns the PID of the parent of the currently
406  * running #m_process_t.
407  */
408 int MSG_process_self_PPID(void)
409 {
410   return MSG_process_get_PPID(MSG_process_self());
411 }
412
413 /** \ingroup m_process_management
414  * \brief Return the current process.
415  *
416  * This function returns the currently running #m_process_t.
417  */
418 m_process_t MSG_process_self(void)
419 {
420   return SIMIX_process_self();
421 }
422
423 /** \ingroup m_process_management
424  * \brief Suspend the process.
425  *
426  * This function suspends the process by suspending the task on which
427  * it was waiting for the completion.
428  */
429 MSG_error_t MSG_process_suspend(m_process_t process)
430 {
431   xbt_assert(process != NULL, "Invalid parameter");
432
433 #ifdef HAVE_TRACING
434   TRACE_msg_process_suspend(process);
435 #endif
436
437   simcall_process_suspend(process);
438   MSG_RETURN(MSG_OK);
439 }
440
441 /** \ingroup m_process_management
442  * \brief Resume a suspended process.
443  *
444  * This function resumes a suspended process by resuming the task on
445  * which it was waiting for the completion.
446  */
447 MSG_error_t MSG_process_resume(m_process_t process)
448 {
449   xbt_assert(process != NULL, "Invalid parameter");
450
451 #ifdef HAVE_TRACING
452   TRACE_msg_process_resume(process);
453 #endif
454
455   simcall_process_resume(process);
456   MSG_RETURN(MSG_OK);
457 }
458
459 /** \ingroup m_process_management
460  * \brief Returns true if the process is suspended .
461  *
462  * This checks whether a process is suspended or not by inspecting the
463  * task on which it was waiting for the completion.
464  */
465 int MSG_process_is_suspended(m_process_t process)
466 {
467   xbt_assert(process != NULL, "Invalid parameter");
468   return simcall_process_is_suspended(process);
469 }
470
471 smx_context_t MSG_process_get_smx_ctx(m_process_t process) {
472   return SIMIX_process_get_context(process);
473 }