Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Modified some functions and datatypes. Simix API changed too.
[simgrid.git] / src / simix / smx_process.c
1 /*      $Id$     */
2
3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved.        */
4
5 /* This program is free software; you can redistribute it and/or modify it
6  * under the terms of the license (GNU LGPL) which comes with this package. */
7
8 #include "private.h"
9 #include "xbt/sysdep.h"
10 #include "xbt/log.h"
11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix,
12                                 "Logging specific to SIMIX (process)");
13 /** \defgroup m_process_management Management Functions of Agents
14  *  \brief This section describes the agent structure of MSG
15  *  (#m_process_t) and the functions for managing it.
16  *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Agents" --> \endhtmlonly
17  * 
18  *  We need to simulate many independent scheduling decisions, so
19  *  the concept of <em>process</em> is at the heart of the
20  *  simulator. A process may be defined as a <em>code</em>, with
21  *  some <em>private data</em>, executing in a <em>location</em>.
22  *  \see m_process_t
23  */
24
25 /******************************** Process ************************************/
26 /** \ingroup m_process_management
27  * \brief Creates and runs a new #m_process_t.
28  *
29  * Does exactly the same as #MSG_process_create_with_arguments but without 
30    providing standard arguments (\a argc, \a argv, \a start_time, \a kill_time).
31  * \sa MSG_process_create_with_arguments
32  */
33 smx_process_t SIMIX_process_create(const char *name,
34                                smx_process_code_t code, void *data,
35                                smx_host_t host)
36 {
37   return SIMIX_process_create_with_arguments(name, code, data, host, -1, NULL);
38 }
39
40 static void SIMIX_process_cleanup(void *arg)
41 {
42   xbt_swag_remove(arg, simix_global->process_list);
43   xbt_swag_remove(arg, simix_global->process_to_run);
44   xbt_swag_remove(arg, ((smx_process_t) arg)->simdata->host->simdata->process_list);
45   free(((smx_process_t) arg)->name);
46   ((smx_process_t) arg)->name = NULL;
47   free(((smx_process_t) arg)->simdata);
48   ((smx_process_t) arg)->simdata = NULL;
49   free(arg);
50 }
51
52 /** \ingroup m_process_management
53  * \brief Creates and runs a new #m_process_t.
54
55  * A constructor for #m_process_t taking four arguments and returning the 
56  * corresponding object. The structure (and the corresponding thread) is
57  * created, and put in the list of ready process.
58  * \param name a name for the object. It is for user-level information
59    and can be NULL.
60  * \param code is a function describing the behavior of the agent. It
61    should then only use functions described in \ref
62    m_process_management (to create a new #m_process_t for example),
63    in \ref m_host_management (only the read-only functions i.e. whose
64    name contains the word get), in \ref m_task_management (to create
65    or destroy some #m_task_t for example) and in \ref
66    msg_gos_functions (to handle file transfers and task processing).
67  * \param data a pointer to any data one may want to attach to the new
68    object.  It is for user-level information and can be NULL. It can
69    be retrieved with the function \ref MSG_process_get_data.
70  * \param host the location where the new agent is executed.
71  * \param argc first argument passed to \a code
72  * \param argv second argument passed to \a code
73  * \see m_process_t
74  * \return The new corresponding object.
75  */
76 smx_process_t SIMIX_process_create_with_arguments(const char *name,
77                                               smx_process_code_t code, void *data,
78                                               smx_host_t host, int argc, char **argv)
79 {
80   simdata_process_t simdata = xbt_new0(s_simdata_process_t,1);
81   smx_process_t process = xbt_new0(s_smx_process_t,1);
82   smx_process_t self = NULL;
83
84   xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
85   /* Simulator Data */
86
87   simdata->host = host;
88   simdata->argc = argc;
89   simdata->argv = argv;
90   simdata->context = xbt_context_new(code, NULL, NULL, 
91                                      SIMIX_process_cleanup, process, 
92                                      simdata->argc, simdata->argv);
93
94   //simdata->last_errno=SIMIX_OK;
95
96
97   /* Process structure */
98   process->name = xbt_strdup(name);
99   process->simdata = simdata;
100   process->data = data;
101
102   xbt_swag_insert(process, host->simdata->process_list);
103
104   /* *************** FIX du current_process !!! *************** */
105   self = simix_global->current_process;
106   xbt_context_start(process->simdata->context);
107   simix_global->current_process = self;
108
109   xbt_swag_insert(process,simix_global->process_list);
110   DEBUG2("Inserting %s(%s) in the to_run list",process->name,
111          host->name);
112   xbt_swag_insert(process,simix_global->process_to_run);
113
114   return process;
115 }
116
117 /** \ingroup m_process_management
118  * \param process poor victim
119  *
120  * This function simply kills a \a process... scarry isn't it ? :)
121  */
122 void SIMIX_process_kill(smx_process_t process)
123 {
124   //int i;
125   simdata_process_t p_simdata = process->simdata;
126   //simdata_host_t h_simdata= p_simdata->host->simdata;
127   //int _cursor;
128   //smx_process_t proc = NULL;
129
130   DEBUG2("Killing %s on %s",process->name, p_simdata->host->name);
131   
132   /*
133   
134   if(p_simdata->waiting_task) {
135     xbt_dynar_foreach(p_simdata->waiting_task->simdata->sleeping,_cursor,proc) {
136       if(proc==process) 
137         xbt_dynar_remove_at(p_simdata->waiting_task->simdata->sleeping,_cursor,&proc);
138     }
139     if(p_simdata->waiting_task->simdata->compute)
140       surf_workstation_resource->common_public->
141         action_free(p_simdata->waiting_task->simdata->compute);
142     else if (p_simdata->waiting_task->simdata->comm) {
143       surf_workstation_resource->common_public->
144         action_change_state(p_simdata->waiting_task->simdata->comm,SURF_ACTION_FAILED);
145       surf_workstation_resource->common_public->
146         action_free(p_simdata->waiting_task->simdata->comm);
147     } else {
148       xbt_die("UNKNOWN STATUS. Please report this bug.");
149     }
150   }
151
152   if ((i==msg_global->max_channel) && (process!=MSG_process_self()) && 
153       (!p_simdata->waiting_task)) {
154     xbt_die("UNKNOWN STATUS. Please report this bug.");
155   }
156 */
157   xbt_swag_remove(process,simix_global->process_to_run);
158   xbt_swag_remove(process,simix_global->process_list);
159   xbt_context_free(process->simdata->context);
160
161   if(process==SIMIX_process_self()) {
162     /* I just killed myself */
163     xbt_context_yield();
164   }
165 }
166
167 /** \ingroup m_process_management
168  * \brief Return the user data of a #m_process_t.
169  *
170  * This functions checks whether \a process is a valid pointer or not 
171    and return the user data associated to \a process if it is possible.
172  */
173 void *SIMIX_process_get_data(smx_process_t process)
174 {
175   xbt_assert0((process != NULL), "Invalid parameters");
176
177   return (process->data);
178 }
179
180 /** \ingroup m_process_management
181  * \brief Set the user data of a #m_process_t.
182  *
183  * This functions checks whether \a process is a valid pointer or not 
184    and set the user data associated to \a process if it is possible.
185  */
186 void SIMIX_process_set_data(smx_process_t process,void *data)
187 {
188   xbt_assert0((process != NULL), "Invalid parameters");
189   xbt_assert0((process->data == NULL), "Data already set");
190   
191   process->data = data;
192    
193   return ;
194 }
195
196 /** \ingroup m_process_management
197  * \brief Return the location on which an agent is running.
198  *
199  * This functions checks whether \a process is a valid pointer or not 
200    and return the m_host_t corresponding to the location on which \a 
201    process is running.
202  */
203 smx_host_t SIMIX_process_get_host(smx_process_t process)
204 {
205   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
206
207   return (process->simdata->host);
208 }
209
210 /** \ingroup m_process_management
211  * \brief Return the name of an agent.
212  *
213  * This functions checks whether \a process is a valid pointer or not 
214    and return its name.
215  */
216 const char *SIMIX_process_get_name(smx_process_t process)
217 {
218   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
219
220   return (process->name);
221 }
222
223 /** \ingroup m_process_management
224  * \brief Return the current agent.
225  *
226  * This functions returns the currently running #m_process_t.
227  */
228 smx_process_t SIMIX_process_self(void)
229 {
230   return simix_global ? simix_global->current_process : NULL;
231 }
232
233 /** \ingroup m_process_management
234  * \brief Suspend the process.
235  *
236  * This functions suspend the process by suspending the task on which
237  * it was waiting for the completion.
238  */
239 void SIMIX_process_suspend(smx_process_t process)
240 {
241   simdata_process_t simdata = NULL;
242         
243   xbt_assert0(((process) && (process->simdata)), "Invalid parameters");
244
245   if(process!=SIMIX_process_self()) {
246     simdata = process->simdata;
247     
248                 if (simdata->mutex) {
249                         /* process blocked on a mutex, only set suspend=1 */
250                         simdata->suspended = 1;
251                 }
252                 else if (simdata->cond){
253                         /* process blocked cond, suspend all actions */
254
255                         /* temporaries variables */ 
256                         smx_cond_t c;
257                         xbt_fifo_item_t i;
258                         smx_action_t act;
259
260                         simdata->suspended = 1;
261                         c = simdata->cond;
262                         xbt_fifo_foreach(c->actions,i,act, smx_action_t) {
263                                 surf_workstation_resource->common_public->suspend(act->simdata->surf_action);
264                         }
265                 }
266                 else {
267                         simdata->suspended = 1;
268                 }
269   }
270         else {
271                 /* process executing, I can create an action and suspend it */
272                 process->simdata->suspended = 1;
273                 smx_action_t dummy;
274                 smx_cond_t cond;
275                 char name[] = "dummy";
276
277                 cond = SIMIX_cond_init();
278                 dummy = SIMIX_action_execute(SIMIX_process_get_host(process), name, 0);
279                 surf_workstation_resource->common_public->set_priority(dummy->simdata->surf_action,0.0);
280                 SIMIX_register_condition_to_action(dummy,cond);
281                 SIMIX_register_action_to_condition(dummy,cond);
282                 __SIMIX_cond_wait(cond);        
283                 //SIMIX_action_destroy(dummy);
284                 //SIMIX_cond_destroy(cond);
285         }
286   return ;
287 }
288
289 /** \ingroup m_process_management
290  * \brief Resume a suspended process.
291  *
292  * This functions resume a suspended process by resuming the task on
293  * which it was waiting for the completion.
294  */
295 void SIMIX_process_resume(smx_process_t process)
296 {
297   simdata_process_t simdata = NULL;
298
299   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
300   CHECK_HOST();
301
302   if(process == SIMIX_process_self()) {
303                 return; 
304   }
305
306   simdata = process->simdata;
307   if(simdata->mutex) {
308                 DEBUG0("Resume process blocked on a mutex");
309     simdata->suspended = 0; /* He'll wake up by itself */
310                 return; 
311   }
312         else if (simdata->cond) {
313                 DEBUG0("Resume process blocked on a conditional");
314                 /* temporaries variables */ 
315                 smx_cond_t c;
316                 xbt_fifo_item_t i;
317                 smx_action_t act;
318                 simdata->suspended = 0;
319                 c = simdata->cond;
320                 xbt_fifo_foreach(c->actions,i,act, smx_action_t) {
321                         surf_workstation_resource->common_public->resume(act->simdata->surf_action);
322                 }
323                 return;
324         }
325         else {
326                 simdata->suspended = 0;
327                 xbt_swag_insert(process,simix_global->process_to_run);
328         }
329
330 }
331
332 /** \ingroup m_process_management
333  * \brief Returns true if the process is suspended .
334  *
335  * This checks whether a process is suspended or not by inspecting the
336  * task on which it was waiting for the completion.
337  */
338 int SIMIX_process_is_suspended(smx_process_t process)
339 {
340   xbt_assert0(((process != NULL) && (process->simdata)), "Invalid parameters");
341
342   return (process->simdata->suspended);
343 }
344
345
346