Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] remove old source file with functions that are no longer used
[simgrid.git] / src / simix / smx_process.c
1 /* Copyright (c) 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 "private.h"
8 #include "xbt/sysdep.h"
9 #include "xbt/log.h"
10 #include "xbt/dict.h"
11 #include "msg/mailbox.h"
12 #include "mc/mc.h"
13
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix,
15                                 "Logging specific to SIMIX (process)");
16
17 unsigned long simix_process_maxpid = 0;
18
19 /**
20  * \brief Returns the current agent.
21  *
22  * This functions returns the currently running SIMIX process.
23  *
24  * \return The SIMIX process
25  */
26 XBT_INLINE smx_process_t SIMIX_process_self(void)
27 {
28   smx_context_t self_context = SIMIX_context_self();
29
30   return self_context ? SIMIX_context_get_data(self_context) : NULL;
31 }
32
33 /**
34  * \brief Move a process to the list of processes to destroy.
35  */
36 void SIMIX_process_cleanup(smx_process_t process)
37 {
38   XBT_DEBUG("Cleanup process %s", process->name);
39   /*xbt_swag_remove(process, simix_global->process_to_run);*/
40   xbt_swag_remove(process, simix_global->process_list);
41   xbt_swag_remove(process, process->smx_host->process_list);
42   xbt_swag_insert(process, simix_global->process_to_destroy);
43 }
44
45 /** 
46  * Garbage collection
47  *
48  * Should be called some time to time to free the memory allocated for processes
49  * that have finished (or killed).
50  */
51 void SIMIX_process_empty_trash(void)
52 {
53   smx_process_t process = NULL;
54
55   while ((process = xbt_swag_extract(simix_global->process_to_destroy))) {
56     SIMIX_context_free(process->context);
57
58     /* Free the exception allocated at creation time */
59     if (process->running_ctx)
60       free(process->running_ctx);
61     if (process->properties)
62       xbt_dict_free(&process->properties);
63
64     free(process->name);
65     process->name = NULL;
66     free(process);
67   }
68 }
69
70 /**
71  * \brief Creates and runs the maestro process
72  */
73 void SIMIX_create_maestro_process()
74 {
75   smx_process_t maestro = NULL;
76
77   /* Create maestro process and intilialize it */
78   maestro = xbt_new0(s_smx_process_t, 1);
79   maestro->pid = simix_process_maxpid++;
80   maestro->name = (char *) "";
81   maestro->running_ctx = xbt_new(xbt_running_ctx_t, 1);
82   XBT_RUNNING_CTX_INITIALIZE(maestro->running_ctx);
83   maestro->context = SIMIX_context_new(NULL, 0, NULL, NULL, maestro);
84   maestro->request.issuer = maestro;
85
86   simix_global->maestro_process = maestro;
87   return;
88 }
89
90 /**
91  * \brief Same as SIMIX_process_create() but with only one argument (used by timers).
92  * \return the process created
93  */
94 smx_process_t SIMIX_process_create_from_wrapper(smx_process_arg_t args) {
95
96   smx_process_t process;
97   simix_global->create_process_function(
98       &process,
99       args->name,
100       args->code,
101       args->data,
102       args->hostname,
103       args->argc,
104       args->argv,
105       args->properties);
106
107   return process;
108 }
109
110 /**
111  * \brief Internal function to create a process.
112  *
113  * This function actually creates the process.
114  * It may be called when a REQ_PROCESS_CREATE request occurs,
115  * or directly for SIMIX internal purposes.
116  *
117  * \return the process created
118  */
119 void SIMIX_process_create(smx_process_t *process,
120                           const char *name,
121                           xbt_main_func_t code,
122                           void *data,
123                           const char *hostname,
124                           int argc, char **argv,
125                           xbt_dict_t properties) {
126
127   *process = NULL;
128   smx_host_t host = SIMIX_host_get_by_name(hostname);
129
130   XBT_DEBUG("Start process %s on host %s", name, hostname);
131
132   if (!SIMIX_host_get_state(host)) {
133     XBT_WARN("Cannot launch process '%s' on failed host '%s'", name,
134           hostname);
135   }
136   else {
137     *process = xbt_new0(s_smx_process_t, 1);
138
139     xbt_assert(((code != NULL) && (host != NULL)), "Invalid parameters");
140
141     /* Process data */
142     (*process)->pid = simix_process_maxpid++;
143     (*process)->name = xbt_strdup(name);
144     (*process)->smx_host = host;
145     (*process)->data = data;
146
147     XBT_VERB("Create context %s", (*process)->name);
148     (*process)->context = SIMIX_context_new(code, argc, argv,
149         simix_global->cleanup_process_function, *process);
150
151     (*process)->running_ctx = xbt_new(xbt_running_ctx_t, 1);
152     XBT_RUNNING_CTX_INITIALIZE((*process)->running_ctx);
153
154     /* Add properties */
155     (*process)->properties = properties;
156
157     /* Add the process to it's host process list */
158     xbt_swag_insert(*process, host->process_list);
159
160     XBT_DEBUG("Start context '%s'", (*process)->name);
161
162     /* Now insert it in the global process list and in the process to run list */
163     xbt_swag_insert(*process, simix_global->process_list);
164     XBT_DEBUG("Inserting %s(%s) in the to_run list", (*process)->name, host->name);
165     xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, *process);
166   }
167 }
168
169 /**
170  * \brief Executes the processes from simix_global->process_to_run.
171  *
172  * The processes of simix_global->process_to_run are run (in parallel if
173  * possible).  On exit, simix_global->process_to_run is empty, and
174  * simix_global->process_that_ran contains the list of processes that just ran.
175  * The two lists are swapped so, be careful when using them before and after a
176  * call to this function.
177  */
178 void SIMIX_process_runall(void)
179 {
180   SIMIX_context_runall(simix_global->process_to_run);
181   xbt_dynar_t tmp = simix_global->process_that_ran;
182   simix_global->process_that_ran = simix_global->process_to_run;
183   simix_global->process_to_run = tmp;
184   xbt_dynar_reset(simix_global->process_to_run);
185 }
186
187 /**
188  * \brief Internal function to kill a SIMIX process.
189  *
190  * This function may be called when a REQ_PROCESS_KILL request occurs,
191  * or directly for SIMIX internal purposes.
192  *
193  * \param process poor victim
194  */
195 void SIMIX_process_kill(smx_process_t process) {
196
197   XBT_DEBUG("Killing process %s on %s", process->name, process->smx_host->name);
198
199   process->context->iwannadie = 1;
200   process->blocked = 0;
201   process->suspended = 0;
202   /* FIXME: set doexception to 0 also? */
203
204   if (process->waiting_action) {
205
206     switch (process->waiting_action->type) {
207
208       case SIMIX_ACTION_EXECUTE:          
209       case SIMIX_ACTION_PARALLEL_EXECUTE:
210         SIMIX_host_execution_destroy(process->waiting_action);
211         break;
212
213       case SIMIX_ACTION_COMMUNICATE:
214         SIMIX_comm_destroy(process->waiting_action);
215         break;
216
217       case SIMIX_ACTION_SLEEP:
218         SIMIX_process_sleep_destroy(process->waiting_action);
219         break;
220
221       case SIMIX_ACTION_SYNCHRO:
222         SIMIX_synchro_stop_waiting(process, &process->request);
223         SIMIX_synchro_destroy(process->waiting_action);
224         break;
225
226       case SIMIX_ACTION_IO:
227         THROW_UNIMPLEMENTED;
228         break;
229     }
230   }
231
232   xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, process);
233 }
234
235 /**
236  * \brief Kills all running processes.
237  * \param issuer this one will not be killed
238  */
239 void SIMIX_process_killall(smx_process_t issuer)
240 {
241   smx_process_t p = NULL;
242
243   while ((p = xbt_swag_extract(simix_global->process_list))) {
244     if (p != issuer) {
245       SIMIX_process_kill(p);
246     }
247   }
248
249   SIMIX_context_runall(simix_global->process_to_run);
250
251   SIMIX_process_empty_trash();
252 }
253
254 void SIMIX_process_change_host(smx_process_t process,
255                                smx_host_t dest)
256 {
257   xbt_assert((process != NULL), "Invalid parameters");
258   xbt_swag_remove(process, process->smx_host->process_list);
259   process->smx_host = dest;
260   xbt_swag_insert(process, dest->process_list);
261 }
262
263 void SIMIX_pre_process_change_host(smx_process_t process, smx_host_t dest)
264 {
265   process->new_host = dest;
266 }
267
268 void SIMIX_pre_process_suspend(smx_req_t req)
269 {
270   smx_process_t process = req->process_suspend.process;
271   SIMIX_process_suspend(process, req->issuer);
272
273   if (process != req->issuer) {
274     SIMIX_request_answer(req);
275   }
276   /* If we are suspending ourselves, then just do not replay the request. */
277 }
278
279 void SIMIX_process_suspend(smx_process_t process, smx_process_t issuer)
280 {
281   process->suspended = 1;
282
283   /* If we are suspending another process, and it is waiting on an action,
284      suspend it's action. */
285   if (process != issuer) {
286
287     if (process->waiting_action) {
288
289       switch (process->waiting_action->type) {
290
291         case SIMIX_ACTION_EXECUTE:
292         case SIMIX_ACTION_PARALLEL_EXECUTE:
293           SIMIX_host_execution_suspend(process->waiting_action);
294           break;
295
296         case SIMIX_ACTION_COMMUNICATE:
297           SIMIX_comm_suspend(process->waiting_action);
298           break;
299
300         case SIMIX_ACTION_SLEEP:
301           SIMIX_process_sleep_suspend(process->waiting_action);
302           break;
303
304         default:
305           THROW_IMPOSSIBLE;
306       }
307     }
308   }
309 }
310
311 void SIMIX_process_resume(smx_process_t process, smx_process_t issuer)
312 {
313   xbt_assert((process != NULL), "Invalid parameters");
314
315   process->suspended = 0;
316
317   /* If we are resuming another process, resume the action it was waiting for
318      if any. Otherwise add it to the list of process to run in the next round. */
319   if (process != issuer) {
320
321     if (process->waiting_action) {
322
323       switch (process->waiting_action->type) {
324
325         case SIMIX_ACTION_EXECUTE:          
326         case SIMIX_ACTION_PARALLEL_EXECUTE:
327           SIMIX_host_execution_resume(process->waiting_action);
328           break;
329
330         case SIMIX_ACTION_COMMUNICATE:
331           SIMIX_comm_resume(process->waiting_action);
332           break;
333
334         case SIMIX_ACTION_SLEEP:
335           SIMIX_process_sleep_resume(process->waiting_action);
336           break;
337
338         default:
339           THROW_IMPOSSIBLE;
340       }
341     }
342     else {
343       xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, process);
344     }
345   }
346 }
347
348 int SIMIX_process_get_maxpid(void) {
349   return simix_process_maxpid;
350 }
351
352 int SIMIX_process_count(void)
353 {
354   return xbt_swag_size(simix_global->process_list);
355 }
356
357 void* SIMIX_process_self_get_data(void)
358 {
359   smx_process_t me = SIMIX_process_self();
360   if (!me) {
361     return NULL;
362   }
363   return SIMIX_process_get_data(me);
364 }
365
366 void SIMIX_process_self_set_data(void *data)
367 {
368   SIMIX_process_set_data(SIMIX_process_self(), data);
369 }
370
371 void* SIMIX_process_get_data(smx_process_t process)
372 {
373   return process->data;
374 }
375
376 void SIMIX_process_set_data(smx_process_t process, void *data)
377 {
378   process->data = data;
379 }
380
381 smx_host_t SIMIX_process_get_host(smx_process_t process)
382 {
383   return process->smx_host;
384 }
385
386 /* needs to be public and without request because it is called
387    by exceptions and logging events */
388 const char* SIMIX_process_self_get_name(void) {
389
390   smx_process_t process = SIMIX_process_self();
391   if (process == NULL || process == simix_global->maestro_process)
392     return "";
393
394   return SIMIX_process_get_name(process);
395 }
396
397 const char* SIMIX_process_get_name(smx_process_t process)
398 {
399   return process->name;
400 }
401
402 smx_process_t SIMIX_process_get_by_name(const char* name)
403 {
404   smx_process_t proc;
405
406   xbt_swag_foreach(proc, simix_global->process_list)
407   {
408     if(!strcmp(name, proc->name))
409       return proc;
410   }
411   return NULL;
412 }
413
414 int SIMIX_process_is_suspended(smx_process_t process)
415 {
416   return process->suspended;
417 }
418
419 xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
420 {
421   return process->properties;
422 }
423
424 void SIMIX_pre_process_sleep(smx_req_t req)
425 {
426   if (MC_IS_ENABLED) {
427     MC_process_clock_add(req->issuer, req->process_sleep.duration);
428     req->process_sleep.result = SIMIX_DONE;
429     SIMIX_request_answer(req);
430     return;
431   }
432   smx_action_t action = SIMIX_process_sleep(req->issuer, req->process_sleep.duration);
433   xbt_fifo_push(action->request_list, req);
434   req->issuer->waiting_action = action;
435 }
436
437 smx_action_t SIMIX_process_sleep(smx_process_t process, double duration)
438 {
439   smx_action_t action;
440   smx_host_t host = process->smx_host;
441
442   /* check if the host is active */
443   if (surf_workstation_model->extension.
444       workstation.get_state(host->host) != SURF_RESOURCE_ON) {
445     THROWF(host_error, 0, "Host %s failed, you cannot call this function",
446            host->name);
447   }
448
449   action = xbt_mallocator_get(simix_global->action_mallocator);
450   action->type = SIMIX_ACTION_SLEEP;
451   action->name = NULL;
452 #ifdef HAVE_TRACING
453   action->category = NULL;
454 #endif
455
456   action->sleep.host = host;
457   action->sleep.surf_sleep =
458       surf_workstation_model->extension.workstation.sleep(host->host, duration);
459
460   surf_workstation_model->action_data_set(action->sleep.surf_sleep, action);
461   XBT_DEBUG("Create sleep action %p", action);
462
463   return action;
464 }
465
466 void SIMIX_post_process_sleep(smx_action_t action)
467 {
468   smx_req_t req;
469   e_smx_state_t state;
470
471   while ((req = xbt_fifo_shift(action->request_list))) {
472
473     switch(surf_workstation_model->action_state_get(action->sleep.surf_sleep)){
474       case SURF_ACTION_FAILED:
475         state = SIMIX_SRC_HOST_FAILURE;
476         break;
477
478       case SURF_ACTION_DONE:
479         state = SIMIX_DONE;
480         break;
481
482       default:
483         THROW_IMPOSSIBLE;
484         break;
485     }
486     req->process_sleep.result = state;
487     req->issuer->waiting_action = NULL;
488     SIMIX_request_answer(req);
489   }
490   SIMIX_process_sleep_destroy(action);
491 }
492
493 void SIMIX_process_sleep_destroy(smx_action_t action)
494 {
495   XBT_DEBUG("Destroy action %p", action);
496   if (action->sleep.surf_sleep)
497     action->sleep.surf_sleep->model_type->action_unref(action->sleep.surf_sleep);
498   xbt_mallocator_release(simix_global->action_mallocator, action);
499 }
500
501 void SIMIX_process_sleep_suspend(smx_action_t action)
502 {
503   surf_workstation_model->suspend(action->sleep.surf_sleep);
504 }
505
506 void SIMIX_process_sleep_resume(smx_action_t action)
507 {
508   surf_workstation_model->resume(action->sleep.surf_sleep);
509 }
510
511 /** 
512  * Calling this function makes the process to yield.
513  * Only the processes can call this function, giving back the control to maestro
514  */
515 void SIMIX_process_yield(void)
516 {
517   smx_process_t self = SIMIX_process_self();
518
519   XBT_DEBUG("Yield process '%s'", self->name);
520
521   /* Go into sleep and return control to maestro */
522   SIMIX_context_suspend(self->context);
523
524   /* Ok, maestro returned control to us */
525   XBT_DEBUG("Maestro returned control to me: '%s'", self->name);
526
527   if (self->context->iwannadie){
528     XBT_DEBUG("I wanna die!");
529     SIMIX_context_stop(self->context);
530   }
531
532   if (self->doexception) {
533     XBT_DEBUG("Wait, maestro left me an exception");
534     self->doexception = 0;
535     RETHROW;
536   }
537   
538   if (self->new_host) {
539     SIMIX_process_change_host(self, self->new_host);
540     self->new_host = NULL;
541   }
542 }
543
544 /* callback: context fetching */
545 xbt_running_ctx_t *SIMIX_process_get_running_context(void)
546 {
547   return SIMIX_process_self()->running_ctx;
548 }
549
550 /* callback: termination */
551 void SIMIX_process_exception_terminate(xbt_ex_t * e)
552 {
553   xbt_ex_display(e);
554   abort();
555 }
556
557 smx_context_t SIMIX_process_get_context(smx_process_t p) {
558   return p->context;
559 }
560
561 void SIMIX_process_set_context(smx_process_t p,smx_context_t c) {
562   p->context = c;
563 }