Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Doc improvement: rename GOS into task usage
[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, 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, 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,
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,
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 argc first argument passed to \a code
140  * \param argv second argument passed to \a code
141  * \param properties list a properties defined for this process
142  * \see m_process_t
143  * \return The new corresponding object.
144  */
145 m_process_t MSG_process_create_with_environment(const char *name,
146                                                 xbt_main_func_t code,
147                                                 void *data, m_host_t host,
148                                                 int argc, char **argv,
149                                                 xbt_dict_t properties)
150 {
151   xbt_assert(code != NULL && host != NULL, "Invalid parameters");
152   simdata_process_t simdata = xbt_new0(s_simdata_process_t, 1);
153   m_process_t process;
154
155   /* Simulator data for MSG */
156   simdata->PID = msg_global->PID++;
157   simdata->waiting_action = NULL;
158   simdata->waiting_task = NULL;
159   simdata->m_host = host;
160   simdata->argc = argc;
161   simdata->argv = argv;
162   simdata->data = data;
163   simdata->last_errno = MSG_OK;
164
165   if (SIMIX_process_self()) {
166     simdata->PPID = MSG_process_get_PID(MSG_process_self());
167   } else {
168     simdata->PPID = -1;
169   }
170
171 #ifdef HAVE_TRACING
172   TRACE_msg_process_create(name, simdata->PID, simdata->m_host);
173 #endif
174
175   /* Let's create the process: SIMIX may decide to start it right now,
176    * even before returning the flow control to us */
177   simcall_process_create(&process, name, code, simdata, host->name,
178                            argc, argv, properties);
179
180   if (!process) {
181     /* Undo everything we have just changed */
182     msg_global->PID--;
183     xbt_free(simdata);
184     return NULL;
185   }
186
187   return process;
188 }
189
190 void MSG_process_kill_from_SIMIX(smx_process_t p)
191 {
192 #ifdef HAVE_TRACING
193   TRACE_msg_process_kill(p);
194 #endif
195   MSG_process_kill(p);
196 }
197
198 /** \ingroup m_process_management
199  * \param process poor victim
200  *
201  * This function simply kills a \a process... scary isn't it ? :)
202  */
203 void MSG_process_kill(m_process_t process)
204 {
205 #ifdef HAVE_TRACING
206   TRACE_msg_process_kill(process);
207 #endif
208
209   /* FIXME: why do we only cancel communication actions? is this useful? */
210   simdata_process_t p_simdata = simcall_process_get_data(process);
211   if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
212     simcall_comm_cancel(p_simdata->waiting_task->simdata->comm);
213   }
214  
215   simcall_process_kill(process);
216
217   return;
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 #m_host_t on which \a process is running.
225  */
226 MSG_error_t MSG_process_migrate(m_process_t process, m_host_t host)
227 {
228   simdata_process_t simdata = simcall_process_get_data(process);
229   simdata->m_host = host;
230 #ifdef HAVE_TRACING
231   m_host_t now = simdata->m_host;
232   TRACE_msg_process_change_host(process, now, host);
233 #endif
234   simcall_process_change_host(process, host->simdata->smx_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(m_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(m_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 m_host_t corresponding to the location on which \a
284  * process is running.
285  */
286 m_host_t MSG_process_get_host(m_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 #m_process_t given its PID.
301  *
302  * This function search in the list of all the created m_process_t for a m_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 m_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
316 /** \ingroup m_process_management
317  * \brief Returns the process ID of \a process.
318  *
319  * This function checks whether \a process is a valid pointer or not
320    and return its PID (or 0 in case of problem).
321  */
322 int MSG_process_get_PID(m_process_t process)
323 {
324   /* Do not raise an exception here: this function is called by the logs
325    * and the exceptions, so it would be called back again and again */
326   if (process == NULL) {
327     return 0;
328   }
329
330   simdata_process_t simdata = simcall_process_get_data(process);
331
332   return simdata != NULL ? simdata->PID : 0;
333 }
334
335 /** \ingroup m_process_management
336  * \brief Returns the process ID of the parent of \a process.
337  *
338  * This function checks whether \a process is a valid pointer or not
339    and return its PID. Returns -1 if the process has not been created by
340    any other process.
341  */
342 int MSG_process_get_PPID(m_process_t process)
343 {
344   xbt_assert(process != NULL, "Invalid parameter");
345
346   simdata_process_t simdata = simcall_process_get_data(process);
347
348   return simdata->PPID;
349 }
350
351 /** \ingroup m_process_management
352  * \brief Return the name of a process.
353  *
354  * This function checks whether \a process is a valid pointer or not
355    and return its name.
356  */
357 const char *MSG_process_get_name(m_process_t process)
358 {
359   xbt_assert(process, "Invalid parameter");
360
361   return simcall_process_get_name(process);
362 }
363
364 /** \ingroup m_process_management
365  * \brief Returns the value of a given process property
366  *
367  * \param process a process
368  * \param name a property name
369  * \return value of a property (or NULL if the property is not set)
370  */
371 const char *MSG_process_get_property_value(m_process_t process,
372                                            const char *name)
373 {
374   return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
375 }
376
377 /** \ingroup m_process_management
378  * \brief Return the list of properties
379  *
380  * This function returns all the parameters associated with a process
381  */
382 xbt_dict_t MSG_process_get_properties(m_process_t process)
383 {
384   xbt_assert(process != NULL, "Invalid parameter");
385
386   return simcall_process_get_properties(process);
387
388 }
389
390 /** \ingroup m_process_management
391  * \brief Return the PID of the current process.
392  *
393  * This function returns the PID of the currently running #m_process_t.
394  */
395 int MSG_process_self_PID(void)
396 {
397   return MSG_process_get_PID(MSG_process_self());
398 }
399
400 /** \ingroup m_process_management
401  * \brief Return the PPID of the current process.
402  *
403  * This function returns the PID of the parent of the currently
404  * running #m_process_t.
405  */
406 int MSG_process_self_PPID(void)
407 {
408   return MSG_process_get_PPID(MSG_process_self());
409 }
410
411 /** \ingroup m_process_management
412  * \brief Return the current process.
413  *
414  * This function returns the currently running #m_process_t.
415  */
416 m_process_t MSG_process_self(void)
417 {
418   return SIMIX_process_self();
419 }
420
421 /** \ingroup m_process_management
422  * \brief Suspend the process.
423  *
424  * This function suspends the process by suspending the task on which
425  * it was waiting for the completion.
426  */
427 MSG_error_t MSG_process_suspend(m_process_t process)
428 {
429   xbt_assert(process != NULL, "Invalid parameter");
430
431 #ifdef HAVE_TRACING
432   TRACE_msg_process_suspend(process);
433 #endif
434
435   simcall_process_suspend(process);
436   MSG_RETURN(MSG_OK);
437 }
438
439 /** \ingroup m_process_management
440  * \brief Resume a suspended process.
441  *
442  * This function resumes a suspended process by resuming the task on
443  * which it was waiting for the completion.
444  */
445 MSG_error_t MSG_process_resume(m_process_t process)
446 {
447   xbt_assert(process != NULL, "Invalid parameter");
448
449 #ifdef HAVE_TRACING
450   TRACE_msg_process_resume(process);
451 #endif
452
453   simcall_process_resume(process);
454   MSG_RETURN(MSG_OK);
455 }
456
457 /** \ingroup m_process_management
458  * \brief Returns true if the process is suspended .
459  *
460  * This checks whether a process is suspended or not by inspecting the
461  * task on which it was waiting for the completion.
462  */
463 int MSG_process_is_suspended(m_process_t process)
464 {
465   xbt_assert(process != NULL, "Invalid parameter");
466   return simcall_process_is_suspended(process);
467 }
468
469 smx_context_t MSG_process_get_smx_ctx(m_process_t process) {
470   return SIMIX_process_get_context(process);
471 }