Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Not using set/get functions is bad, but raising an errer when a set
[simgrid.git] / src / msg / m_process.c
1 /*     $Id$      */
2
3 /* Copyright (c) 2002-2007 Arnaud Legrand.                                  */
4 /* Copyright (c) 2007 Bruno Donassolo.                                      */
5 /* All rights reserved.                                                     */
6
7 /* This program is free software; you can redistribute it and/or modify it
8  * under the terms of the license (GNU LGPL) which comes with this package. */
9
10 #include "msg/private.h"
11 #include "xbt/sysdep.h"
12 #include "xbt/log.h"
13 #include "../simix/private.h"
14
15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_process, msg,
16                                 "Logging specific to MSG (process)");
17
18 /** \defgroup m_process_management Management Functions of Agents
19  *  \brief This section describes the agent structure of MSG
20  *  (#m_process_t) and the functions for managing it.
21  */
22 /** @addtogroup m_process_management
23  *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Agents" --> \endhtmlonly
24  *
25  *  We need to simulate many independent scheduling decisions, so
26  *  the concept of <em>process</em> is at the heart of the
27  *  simulator. A process may be defined as a <em>code</em>, with
28  *  some <em>private data</em>, executing in a <em>location</em>.
29  *  \see m_process_t
30  */
31
32 /******************************** Process ************************************/
33 void __MSG_process_cleanup(void *arg)
34 {
35   /* arg is a pointer to a simix process, we can get the msg process with the field data */
36   m_process_t proc = ((smx_process_t) arg)->data;
37   xbt_fifo_remove(msg_global->process_list, proc);
38   SIMIX_process_cleanup(arg);
39   free(proc->name);
40   proc->name = NULL;
41   free(proc->simdata);
42   proc->simdata = NULL;
43   free(proc);
44
45   return;
46 }
47
48 /* This function creates a MSG process. It has the prototype enforced by SIMIX_function_register_process_create */
49 void *_MSG_process_create_from_SIMIX(const char *name,
50                                      xbt_main_func_t code, void *data,
51                                      char *hostname, int argc, char **argv,
52                                      xbt_dict_t properties)
53 {
54   m_host_t host = MSG_get_host_by_name(hostname);
55   return (void *) MSG_process_create_with_environment(name, code, data, host,
56                                                       argc, argv, properties);
57 }
58
59 /** \ingroup m_process_management
60  * \brief Creates and runs a new #m_process_t.
61  *
62  * Does exactly the same as #MSG_process_create_with_arguments but without
63    providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
64  * \sa MSG_process_create_with_arguments
65  */
66 m_process_t MSG_process_create(const char *name,
67                                xbt_main_func_t code, void *data,
68                                m_host_t host)
69 {
70   return MSG_process_create_with_environment(name, code, data, host, -1,
71                                              NULL, NULL);
72 }
73
74 /** \ingroup m_process_management
75  * \brief Creates and runs a new #m_process_t.
76
77  * A constructor for #m_process_t taking four arguments and returning the
78  * corresponding object. The structure (and the corresponding thread) is
79  * created, and put in the list of ready process.
80  * \param name a name for the object. It is for user-level information
81    and can be NULL.
82  * \param code is a function describing the behavior of the agent. It
83    should then only use functions described in \ref
84    m_process_management (to create a new #m_process_t for example),
85    in \ref m_host_management (only the read-only functions i.e. whose
86    name contains the word get), in \ref m_task_management (to create
87    or destroy some #m_task_t for example) and in \ref
88    msg_gos_functions (to handle file transfers and task processing).
89  * \param data a pointer to any data one may want to attach to the new
90    object.  It is for user-level information and can be NULL. It can
91    be retrieved with the function \ref MSG_process_get_data.
92  * \param host the location where the new agent is executed.
93  * \param argc first argument passed to \a code
94  * \param argv second argument passed to \a code
95  * \see m_process_t
96  * \return The new corresponding object.
97  */
98
99 m_process_t MSG_process_create_with_arguments(const char *name,
100                                               xbt_main_func_t code,
101                                               void *data, m_host_t host,
102                                               int argc, char **argv)
103 {
104   return MSG_process_create_with_environment(name, code, data, host,
105                                              argc, argv, NULL);
106 }
107
108 /** \ingroup m_process_management
109  * \brief Creates and runs a new #m_process_t.
110
111  * A constructor for #m_process_t taking four arguments and returning the
112  * corresponding object. The structure (and the corresponding thread) is
113  * created, and put in the list of ready process.
114  * \param name a name for the object. It is for user-level information
115    and can be NULL.
116  * \param code is a function describing the behavior of the agent. It
117    should then only use functions described in \ref
118    m_process_management (to create a new #m_process_t for example),
119    in \ref m_host_management (only the read-only functions i.e. whose
120    name contains the word get), in \ref m_task_management (to create
121    or destroy some #m_task_t for example) and in \ref
122    msg_gos_functions (to handle file transfers and task processing).
123  * \param data a pointer to any data one may want to attach to the new
124    object.  It is for user-level information and can be NULL. It can
125    be retrieved with the function \ref MSG_process_get_data.
126  * \param host the location where the new agent is executed.
127  * \param argc first argument passed to \a code
128  * \param argv second argument passed to \a code
129  * \param properties list a properties defined for this process
130  * \see m_process_t
131  * \return The new corresponding object.
132  */
133 m_process_t MSG_process_create_with_environment(const char *name,
134                                                 xbt_main_func_t code,
135                                                 void *data, m_host_t host,
136                                                 int argc, char **argv,
137                                                 xbt_dict_t properties)
138 {
139   simdata_process_t simdata = NULL;
140   m_process_t process = xbt_new0(s_m_process_t, 1);
141   smx_process_t smx_process = NULL;
142   xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
143
144   smx_process = SIMIX_process_create(name, code,
145                                      (void *) process, host->name,
146                                      argc, argv, properties);
147   if (!smx_process) {
148     xbt_free(process);
149     return NULL;
150   }
151
152   simdata = xbt_new0(s_simdata_process_t, 1);
153
154   /* Simulator Data */
155   simdata->PID = msg_global->PID++;
156   simdata->waiting_action = NULL;
157   simdata->waiting_task = NULL;
158   simdata->m_host = host;
159   simdata->argc = argc;
160   simdata->argv = argv;
161   simdata->s_process = smx_process;
162
163   if (SIMIX_process_self()) {
164     simdata->PPID = MSG_process_get_PID(SIMIX_process_self()->data);
165   } else {
166     simdata->PPID = -1;
167   }
168   simdata->last_errno = MSG_OK;
169
170
171   /* Process structure */
172   process->name = xbt_strdup(name);
173   process->simdata = simdata;
174   process->data = data;
175
176   xbt_fifo_unshift(msg_global->process_list, process);
177
178   return process;
179
180 }
181
182 void _MSG_process_kill_from_SIMIX(void *p)
183 {
184   MSG_process_kill((m_process_t) p);
185 }
186
187 /** \ingroup m_process_management
188  * \param process poor victim
189  *
190  * This function simply kills a \a process... scarry isn't it ? :)
191  */
192 void MSG_process_kill(m_process_t process)
193 {
194   simdata_process_t p_simdata = process->simdata;
195
196   DEBUG3("Killing %s(%d) on %s",
197          process->name, p_simdata->PID, p_simdata->m_host->name);
198
199   if (p_simdata->waiting_task && p_simdata->waiting_task->simdata->comm) {
200       SIMIX_communication_cancel(p_simdata->waiting_task->simdata->comm);
201   }
202  
203   if (p_simdata->waiting_action) {
204     DEBUG1("Canceling waiting task %s",
205            SIMIX_action_get_name(p_simdata->waiting_action));
206     SIMIX_action_cancel(p_simdata->waiting_action);
207    }
208   
209   xbt_fifo_remove(msg_global->process_list, process);
210   SIMIX_process_kill(process->simdata->s_process);
211
212   return;
213 }
214
215 /** \ingroup m_process_management
216  * \brief Migrates an agent to another location.
217  *
218  * This function checks whether \a process and \a host are valid pointers
219    and change the value of the #m_host_t on which \a process is running.
220  */
221 MSG_error_t MSG_process_change_host(m_host_t host)
222 {
223   m_process_t process = MSG_process_self();
224   m_host_t now = process->simdata->m_host;
225   process->simdata->m_host = host;
226   SIMIX_process_change_host(process->simdata->s_process, now->name,
227                             host->name);
228   return MSG_OK;
229 }
230
231 /** \ingroup m_process_management
232  * \brief Return the user data of a #m_process_t.
233  *
234  * This function checks whether \a process is a valid pointer or not
235    and return the user data associated to \a process if it is possible.
236  */
237 void *MSG_process_get_data(m_process_t process)
238 {
239   xbt_assert0((process != NULL), "Invalid parameters");
240
241   return (process->data);
242 }
243
244 /** \ingroup m_process_management
245  * \brief Set the user data of a #m_process_t.
246  *
247  * This function checks whether \a process is a valid pointer or not
248    and set the user data associated to \a process if it is possible.
249  */
250 MSG_error_t MSG_process_set_data(m_process_t process, void *data)
251 {
252   xbt_assert0((process != NULL), "Invalid parameters");
253
254   process->data = data;
255
256   return MSG_OK;
257 }
258
259 /** \ingroup m_process_management
260  * \brief Return the location on which an agent is running.
261  *
262  * This function checks whether \a process is a valid pointer or not
263    and return the m_host_t corresponding to the location on which \a
264    process is running.
265  */
266 m_host_t MSG_process_get_host(m_process_t process)
267 {
268   xbt_assert0(((process != NULL)
269                && (process->simdata)), "Invalid parameters");
270
271   return (((simdata_process_t) process->simdata)->m_host);
272 }
273
274 /** \ingroup m_process_management
275  *
276  * \brief Return a #m_process_t given its PID.
277  *
278  * This function search in the list of all the created m_process_t for a m_process_t
279    whose PID is equal to \a PID. If no host is found, \c NULL is returned.
280    Note that the PID are uniq in the whole simulation, not only on a given host.
281  */
282 m_process_t MSG_process_from_PID(int PID)
283 {
284   xbt_fifo_item_t i = NULL;
285   m_process_t process = NULL;
286
287   xbt_fifo_foreach(msg_global->process_list, i, process, m_process_t) {
288     if (MSG_process_get_PID(process) == PID)
289       return process;
290   }
291   return NULL;
292 }
293
294 /** \ingroup m_process_management
295  * \brief Returns the process ID of \a process.
296  *
297  * This function checks whether \a process is a valid pointer or not
298    and return its PID (or 0 in case of problem).
299  */
300 int MSG_process_get_PID(m_process_t process)
301 {
302   /* Do not raise an exception here: this function is used in the logs,
303      and it will be called back by the exception handling stuff */
304   if (process == NULL || process->simdata == NULL)
305     return 0;
306
307   return (((simdata_process_t) process->simdata)->PID);
308 }
309
310 /** \ingroup m_process_management
311  * \brief Returns the process ID of the parent of \a process.
312  *
313  * This function checks whether \a process is a valid pointer or not
314    and return its PID. Returns -1 if the agent has not been created by
315    another agent.
316  */
317 int MSG_process_get_PPID(m_process_t process)
318 {
319   xbt_assert0(((process != NULL)
320                && (process->simdata)), "Invalid parameters");
321
322   return (((simdata_process_t) process->simdata)->PPID);
323 }
324
325 /** \ingroup m_process_management
326  * \brief Return the name of an agent.
327  *
328  * This function checks whether \a process is a valid pointer or not
329    and return its name.
330  */
331 const char *MSG_process_get_name(m_process_t process)
332 {
333   xbt_assert0(process, "Invalid parameter: process is NULL");
334   xbt_assert0(process->simdata,
335               "Invalid parameter: process->simdata is NULL");
336
337   return (process->name);
338 }
339
340 /** \ingroup m_process_management
341  * \brief Returns the value of a given process property
342  *
343  * \param process a process
344  * \param name a property name
345  * \return value of a property (or NULL if the property is not set)
346  */
347 const char *MSG_process_get_property_value(m_process_t process,
348                                            const char *name)
349 {
350   return xbt_dict_get_or_null(MSG_process_get_properties(process), name);
351 }
352
353 /** \ingroup m_process_management
354  * \brief Return the list of properties
355  *
356  * This function returns all the parameters associated with a process
357  */
358 xbt_dict_t MSG_process_get_properties(m_process_t process)
359 {
360   xbt_assert0((process != NULL), "Invalid parameters");
361
362   return (SIMIX_process_get_properties
363           (((simdata_process_t) process->simdata)->s_process));
364
365 }
366
367 /** \ingroup m_process_management
368  * \brief Return the PID of the current agent.
369  *
370  * This function returns the PID of the currently running #m_process_t.
371  */
372 int MSG_process_self_PID(void)
373 {
374   return (MSG_process_get_PID(MSG_process_self()));
375 }
376
377 /** \ingroup m_process_management
378  * \brief Return the PPID of the current agent.
379  *
380  * This function returns the PID of the parent of the currently
381  * running #m_process_t.
382  */
383 int MSG_process_self_PPID(void)
384 {
385   return (MSG_process_get_PPID(MSG_process_self()));
386 }
387
388 /** \ingroup m_process_management
389  * \brief Return the current agent.
390  *
391  * This function returns the currently running #m_process_t.
392  */
393 m_process_t MSG_process_self(void)
394 {
395   smx_process_t proc = SIMIX_process_self();
396   if (proc != NULL) {
397     return (m_process_t) proc->data;
398   } else {
399     return NULL;
400   }
401
402 }
403
404 /** \ingroup m_process_management
405  * \brief Suspend the process.
406  *
407  * This function suspends the process by suspending the task on which
408  * it was waiting for the completion.
409  */
410 MSG_error_t MSG_process_suspend(m_process_t process)
411 {
412   xbt_assert0(((process != NULL)
413                && (process->simdata)), "Invalid parameters");
414   CHECK_HOST();
415
416   SIMIX_process_suspend(process->simdata->s_process);
417   MSG_RETURN(MSG_OK);
418 }
419
420 /** \ingroup m_process_management
421  * \brief Resume a suspended process.
422  *
423  * This function resumes a suspended process by resuming the task on
424  * which it was waiting for the completion.
425  */
426 MSG_error_t MSG_process_resume(m_process_t process)
427 {
428
429   xbt_assert0(((process != NULL)
430                && (process->simdata)), "Invalid parameters");
431   CHECK_HOST();
432
433   SIMIX_process_resume(process->simdata->s_process);
434   MSG_RETURN(MSG_OK);
435 }
436
437 /** \ingroup m_process_management
438  * \brief Returns true if the process is suspended .
439  *
440  * This checks whether a process is suspended or not by inspecting the
441  * task on which it was waiting for the completion.
442  */
443 int MSG_process_is_suspended(m_process_t process)
444 {
445   xbt_assert0(((process != NULL)
446                && (process->simdata)), "Invalid parameters");
447   return SIMIX_process_is_suspended(process->simdata->s_process);
448 }