Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add a clock per process when running in MC mode.
[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   DEBUG1("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
98   if (simix_global->create_process_function) {
99     process = simix_global->create_process_function(args->name,
100         args->code,
101         args->data,
102         args->hostname,
103         args->argc,
104         args->argv,
105         args->properties);
106   }
107   else {
108     process = SIMIX_process_create(args->name,
109         args->code,
110         args->data,
111         args->hostname,
112         args->argc,
113         args->argv,
114         args->properties);
115   }
116   // FIXME: to simplify this, simix_global->create_process_function could just
117   // be SIMIX_process_create() by default (and the same thing in smx_deployment.c)
118
119   return process;
120 }
121
122 /**
123  * \brief Internal function to create a process.
124  *
125  * This function actually creates the process.
126  * It may be called when a REQ_PROCESS_CREATE request occurs,
127  * or directly for SIMIX internal purposes.
128  *
129  * \return the process created
130  */
131 smx_process_t SIMIX_process_create(const char *name,
132                                    xbt_main_func_t code,
133                                    void *data,
134                                    const char *hostname,
135                                    int argc, char **argv,
136                                    xbt_dict_t properties) {
137
138   smx_process_t process = NULL;
139   smx_host_t host = SIMIX_host_get_by_name(hostname);
140
141   DEBUG2("Start process %s on host %s", name, hostname);
142
143   if (!SIMIX_host_get_state(host)) {
144     WARN2("Cannot launch process '%s' on failed host '%s'", name,
145           hostname);
146   }
147   else {
148     process = xbt_new0(s_smx_process_t, 1);
149
150     xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
151
152     /* Process data */
153     process->pid = simix_process_maxpid++;
154     process->name = xbt_strdup(name);
155     process->smx_host = host;
156     process->data = data;
157
158     VERB1("Create context %s", process->name);
159     process->context = SIMIX_context_new(code, argc, argv,
160         simix_global->cleanup_process_function, process);
161
162     process->running_ctx = xbt_new(xbt_running_ctx_t, 1);
163     XBT_RUNNING_CTX_INITIALIZE(process->running_ctx);
164
165     /* Add properties */
166     process->properties = properties;
167
168     /* Add the process to it's host process list */
169     xbt_swag_insert(process, host->process_list);
170
171     DEBUG1("Start context '%s'", process->name);
172
173     /* Now insert it in the global process list and in the process to run list */
174     xbt_swag_insert(process, simix_global->process_list);
175     DEBUG2("Inserting %s(%s) in the to_run list", process->name, host->name);
176     xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, process);
177   }
178
179   return process;
180 }
181
182 /**
183  * \brief Internal function to kill a SIMIX process.
184  *
185  * This function may be called when a REQ_PROCESS_KILL request occurs,
186  * or directly for SIMIX internal purposes.
187  *
188  * \param process poor victim
189  */
190 void SIMIX_process_kill(smx_process_t process, smx_process_t killer) {
191
192   DEBUG2("Killing process %s on %s", process->name, process->smx_host->name);
193
194   process->context->iwannadie = 1;
195   process->blocked = 0;
196   process->suspended = 0;
197   /* FIXME: set doexception to 0 also? */
198
199   if (process->waiting_action) {
200
201     switch (process->waiting_action->type) {
202
203       case SIMIX_ACTION_EXECUTE:          
204       case SIMIX_ACTION_PARALLEL_EXECUTE:
205         SIMIX_host_execution_destroy(process->waiting_action);
206         break;
207
208       case SIMIX_ACTION_COMMUNICATE:
209         SIMIX_comm_destroy(process->waiting_action);
210         break;
211
212       case SIMIX_ACTION_SLEEP:
213         SIMIX_process_sleep_destroy(process->waiting_action);
214         break;
215
216       case SIMIX_ACTION_SYNCHRO:
217         SIMIX_synchro_stop_waiting(process, &process->request);
218         SIMIX_synchro_destroy(process->waiting_action);
219         break;
220
221       case SIMIX_ACTION_IO:
222         THROW_UNIMPLEMENTED;
223         break;
224     }
225   }
226
227   /* If I'm killing myself then stop, otherwise schedule the process to kill. */
228   if (process == killer) {
229     SIMIX_context_stop(process->context);
230   }
231   else {
232     xbt_dynar_push_as(simix_global->process_to_run, smx_process_t, process);
233   }
234 }
235
236 /**
237  * \brief Kills all running processes.
238  *
239  * Only maestro can kill everyone.
240  */
241 void SIMIX_process_killall(void)
242 {
243   smx_process_t p = NULL;
244
245   while ((p = xbt_swag_extract(simix_global->process_list)))
246     SIMIX_process_kill(p, SIMIX_process_self());
247
248   SIMIX_context_runall(simix_global->process_to_run);
249
250   SIMIX_process_empty_trash();
251 }
252
253 void SIMIX_process_change_host(smx_process_t process,
254     const char *source, const char *dest)
255 {
256   smx_host_t h1 = NULL;
257   smx_host_t h2 = NULL;
258   xbt_assert0((process != NULL), "Invalid parameters");
259   h1 = SIMIX_host_get_by_name(source);
260   h2 = SIMIX_host_get_by_name(dest);
261   process->smx_host = h2;
262   xbt_swag_remove(process, h1->process_list);
263   xbt_swag_insert(process, h2->process_list);
264 }
265
266 void SIMIX_pre_process_suspend(smx_req_t req)
267 {
268   smx_process_t process = req->process_suspend.process;
269   SIMIX_process_suspend(process, req->issuer);
270
271   if (process != req->issuer) {
272     SIMIX_request_answer(req);
273   }
274   /* If we are suspending ourselves, then just do not replay the request. */
275 }
276
277 void SIMIX_process_suspend(smx_process_t process, smx_process_t issuer)
278 {
279   xbt_assert0(process, "Invalid parameters");
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_assert0((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 int SIMIX_process_count(void)
352 {
353   return xbt_swag_size(simix_global->process_list);
354 }
355
356 void* SIMIX_process_self_get_data(void)
357 {
358   smx_process_t me = SIMIX_process_self();
359   if (!me) {
360     return NULL;
361   }
362   return SIMIX_process_get_data(me);
363 }
364
365 void SIMIX_process_self_set_data(void *data)
366 {
367   SIMIX_process_set_data(SIMIX_process_self(), data);
368 }
369
370 void* SIMIX_process_get_data(smx_process_t process)
371 {
372   return process->data;
373 }
374
375 void SIMIX_process_set_data(smx_process_t process, void *data)
376 {
377   process->data = data;
378 }
379
380 smx_host_t SIMIX_process_get_host(smx_process_t process)
381 {
382   return process->smx_host;
383 }
384
385 /* needs to be public and without request because it is called
386    by exceptions and logging events */
387 const char* SIMIX_process_self_get_name(void) {
388
389   smx_process_t process = SIMIX_process_self();
390   if (process == NULL || process == simix_global->maestro_process)
391     return "";
392
393   return SIMIX_process_get_name(process);
394 }
395
396 const char* SIMIX_process_get_name(smx_process_t process)
397 {
398   return process->name;
399 }
400
401 int SIMIX_process_is_suspended(smx_process_t process)
402 {
403   return process->suspended;
404 }
405
406 xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
407 {
408   return process->properties;
409 }
410
411 void SIMIX_pre_process_sleep(smx_req_t req)
412 {
413   if (MC_IS_ENABLED) {
414     MC_process_clock_add(req->issuer, req->process_sleep.duration);
415     req->process_sleep.result = SIMIX_DONE;
416     SIMIX_request_answer(req);
417     return;
418   }
419   smx_action_t action = SIMIX_process_sleep(req->issuer, req->process_sleep.duration);
420   xbt_fifo_push(action->request_list, req);
421   req->issuer->waiting_action = action;
422 }
423
424 smx_action_t SIMIX_process_sleep(smx_process_t process, double duration)
425 {
426   smx_action_t action;
427   smx_host_t host = process->smx_host;
428
429   /* check if the host is active */
430   if (surf_workstation_model->extension.
431       workstation.get_state(host->host) != SURF_RESOURCE_ON) {
432     THROW1(host_error, 0, "Host %s failed, you cannot call this function",
433            host->name);
434   }
435
436   action = xbt_new0(s_smx_action_t, 1);
437   action->type = SIMIX_ACTION_SLEEP;
438   action->request_list = xbt_fifo_new();
439   action->name = xbt_strdup("sleep");
440 #ifdef HAVE_TRACING
441   action->category = NULL;
442 #endif
443
444   action->sleep.host = host;
445   action->sleep.surf_sleep =
446       surf_workstation_model->extension.workstation.sleep(host->host, duration);
447
448   surf_workstation_model->action_data_set(action->sleep.surf_sleep, action);
449   DEBUG1("Create sleep action %p", action);
450
451   return action;
452 }
453
454 void SIMIX_post_process_sleep(smx_action_t action)
455 {
456   e_smx_state_t state = SIMIX_action_map_state(surf_workstation_model->action_state_get(action->sleep.surf_sleep));
457   smx_req_t req;
458
459   while ((req = xbt_fifo_shift(action->request_list))) {
460     req->process_sleep.result = state;
461     req->issuer->waiting_action = NULL;
462     SIMIX_request_answer(req);
463   }
464
465   SIMIX_process_sleep_destroy(action);
466 }
467
468 void SIMIX_process_sleep_destroy(smx_action_t action)
469 {
470   DEBUG1("Destroy action %p", action);
471   if (action->name)
472     xbt_free(action->name);
473   if (action->sleep.surf_sleep)
474     action->sleep.surf_sleep->model_type->action_unref(action->sleep.surf_sleep);
475 #ifdef HAVE_TRACING
476   TRACE_smx_action_destroy(action);
477 #endif
478   xbt_fifo_free(action->request_list);
479   xbt_free(action);
480 }
481
482 void SIMIX_process_sleep_suspend(smx_action_t action)
483 {
484   surf_workstation_model->suspend(action->sleep.surf_sleep);
485 }
486
487 void SIMIX_process_sleep_resume(smx_action_t action)
488 {
489   surf_workstation_model->resume(action->sleep.surf_sleep);
490 }
491
492 /** 
493  * Calling this function makes the process to yield.
494  * Only the processes can call this function, giving back the control to maestro
495  */
496 void SIMIX_process_yield(void)
497 {
498   smx_process_t self = SIMIX_process_self();
499
500   DEBUG1("Yield process '%s'", self->name);
501
502   /* Go into sleep and return control to maestro */
503   SIMIX_context_suspend(self->context);
504
505   /* Ok, maestro returned control to us */
506   DEBUG1("Maestro returned control to me: '%s'", self->name);
507
508   if (self->context->iwannadie){
509     DEBUG0("I wanna die!");
510     SIMIX_context_stop(self->context);
511   }
512
513   if (self->doexception) {
514     DEBUG0("Wait, maestro left me an exception");
515     self->doexception = 0;
516     RETHROW;
517   }
518 }
519
520 /* callback: context fetching */
521 xbt_running_ctx_t *SIMIX_process_get_running_context(void)
522 {
523   return SIMIX_process_self()->running_ctx;
524 }
525
526 /* callback: termination */
527 void SIMIX_process_exception_terminate(xbt_ex_t * e)
528 {
529   xbt_ex_display(e);
530   abort();
531 }
532
533 smx_context_t SIMIX_process_get_context(smx_process_t p) {
534   return p->context;
535 }
536 void SIMIX_process_set_context(smx_process_t p,smx_context_t c) {
537   p->context = c;
538 }