Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'dvfs'
[simgrid.git] / src / simix / smx_host.c
1 /* Copyright (c) 2007-2012. 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 "smx_private.h"
8 #include "xbt/sysdep.h"
9 #include "xbt/log.h"
10 #include "xbt/dict.h"
11 #include "mc/mc.h"
12
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_host, simix,
14                                 "Logging specific to SIMIX (hosts)");
15
16 static void SIMIX_execution_finish(smx_action_t action);
17
18 /**
19  * \brief Internal function to create a SIMIX host.
20  * \param name name of the host to create
21  * \param workstation the SURF workstation to encapsulate
22  * \param data some user data (may be NULL)
23  */
24 smx_host_t SIMIX_host_create(const char *name,
25                                void *workstation, void *data)
26 {
27   smx_host_priv_t smx_host = xbt_new0(s_smx_host_priv_t, 1);
28   s_smx_process_t proc;
29
30   /* Host structure */
31   smx_host->data = data;
32   smx_host->process_list =
33       xbt_swag_new(xbt_swag_offset(proc, host_proc_hookup));
34
35   /* Update global variables */
36   xbt_lib_set(host_lib,name,SIMIX_HOST_LEVEL,smx_host);
37   
38   return xbt_lib_get_elm_or_null(host_lib, name);
39 }
40
41 /**
42  * \brief Internal function to destroy a SIMIX host.
43  *
44  * \param h the host to destroy (a smx_host_t)
45  */
46 void SIMIX_host_destroy(void *h)
47 {
48   smx_host_priv_t host = (smx_host_priv_t) h;
49
50   xbt_assert((host != NULL), "Invalid parameters");
51
52   /* Clean Simulator data */
53   if (xbt_swag_size(host->process_list) != 0) {
54     char *msg = xbt_strdup("Shutting down host, but it's not empty:");
55     char *tmp;
56     smx_process_t process = NULL;
57
58     xbt_swag_foreach(process, host->process_list) {
59       tmp = bprintf("%s\n\t%s", msg, process->name);
60       free(msg);
61       msg = tmp;
62     }
63     SIMIX_display_process_status();
64     THROWF(arg_error, 0, "%s", msg);
65   }
66   xbt_dynar_free(&host->auto_restart_processes);
67   xbt_swag_free(host->process_list);
68
69   /* Clean host structure */
70   free(host); 
71   return;
72 }
73
74 ///**
75 // * \brief Returns a dict of all hosts.
76 // *
77 // * \return List of all hosts (as a #xbt_dict_t)
78 // */
79 //xbt_dict_t SIMIX_host_get_dict(void)
80 //{
81 //  xbt_dict_t host_dict = xbt_dict_new_homogeneous(NULL);
82 //  xbt_lib_cursor_t cursor = NULL;
83 //  char *name = NULL;
84 //  void **host = NULL;
85 //
86 //  xbt_lib_foreach(host_lib, cursor, name, host){
87 //    if(host[SIMIX_HOST_LEVEL])
88 //            xbt_dict_set(host_dict,name,host[SIMIX_HOST_LEVEL], NULL);
89 //  }
90 //  return host_dict;
91 //}
92 smx_host_t SIMIX_pre_host_get_by_name(smx_simcall_t simcall, const char *name){
93    return SIMIX_host_get_by_name(name);
94 }
95 smx_host_t SIMIX_host_get_by_name(const char *name){
96   xbt_assert(((simix_global != NULL)
97                && (host_lib != NULL)),
98               "Environment not set yet");
99
100   return xbt_lib_get_elm_or_null(host_lib, name);
101 }
102
103 smx_host_t SIMIX_host_self(void)
104 {
105   smx_process_t process = SIMIX_process_self();
106   return (process == NULL) ? NULL : SIMIX_process_get_host(process);
107 }
108
109 const char* SIMIX_pre_host_self_get_name(smx_simcall_t simcall){
110    return SIMIX_host_self_get_name();
111 }
112 /* needs to be public and without simcall because it is called
113    by exceptions and logging events */
114 const char* SIMIX_host_self_get_name(void)
115 {
116   smx_host_t host = SIMIX_host_self();
117   if (host == NULL || SIMIX_process_self() == simix_global->maestro_process)
118     return "";
119
120   return SIMIX_host_get_name(host);
121 }
122
123 const char* SIMIX_pre_host_get_name(smx_simcall_t simcall, smx_host_t host){
124    return SIMIX_host_get_name(host);
125 }
126 const char* SIMIX_host_get_name(smx_host_t host){
127   xbt_assert((host != NULL), "Invalid parameters");
128
129   return sg_host_name(host);
130 }
131
132 xbt_dict_t SIMIX_pre_host_get_properties(smx_simcall_t simcall, smx_host_t host){
133   return SIMIX_host_get_properties(host);
134 }
135 xbt_dict_t SIMIX_host_get_properties(smx_host_t host){
136   xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
137
138   return surf_workstation_model->extension.workstation.get_properties(host);
139 }
140
141 double SIMIX_pre_host_get_speed(smx_simcall_t simcall, smx_host_t host){
142   return SIMIX_host_get_speed(host);
143 }
144 double SIMIX_host_get_speed(smx_host_t host){
145   xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
146
147   return surf_workstation_model->extension.workstation.
148       get_speed(host, 1.0);
149 }
150
151 int SIMIX_pre_host_get_core(smx_simcall_t simcall, smx_host_t host){
152   return SIMIX_host_get_core(host);
153 }
154 int SIMIX_host_get_core(smx_host_t host){
155   xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
156
157   return surf_workstation_model->extension.workstation.
158       get_core(host);
159 }
160
161 xbt_swag_t SIMIX_pre_host_get_process_list(smx_simcall_t simcall, smx_host_t host){
162   return SIMIX_host_get_process_list(host);
163 }
164
165 xbt_swag_t SIMIX_host_get_process_list(smx_host_t host){
166   xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
167   smx_host_priv_t host_priv = SIMIX_host_priv(host);
168
169   return host_priv->process_list;
170 }
171
172
173 double SIMIX_pre_host_get_available_speed(smx_simcall_t simcall, smx_host_t host){
174   return SIMIX_host_get_available_speed(host);
175 }
176 double SIMIX_host_get_available_speed(smx_host_t host){
177   xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
178
179   return surf_workstation_model->extension.workstation.
180       get_available_speed(host);
181 }
182
183 double SIMIX_pre_host_get_current_power_peak(smx_simcall_t simcall, smx_host_t host){
184   return SIMIX_host_get_current_power_peak(host);
185 }
186 double SIMIX_host_get_current_power_peak(smx_host_t host) {
187           xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
188           return surf_workstation_model->extension.workstation.
189                       get_current_power_peak(host);
190 }
191
192 double SIMIX_pre_host_get_power_peak_at(smx_simcall_t simcall, smx_host_t host, int pstate_index){
193   return SIMIX_host_get_power_peak_at(host, pstate_index);
194 }
195 double SIMIX_host_get_power_peak_at(smx_host_t host, int pstate_index) {
196           xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
197
198           return surf_workstation_model->extension.workstation.
199               get_power_peak_at(host, pstate_index);
200 }
201
202 int SIMIX_pre_host_get_nb_pstates(smx_simcall_t simcall, smx_host_t host){
203   return SIMIX_host_get_nb_pstates(host);
204 }
205 int SIMIX_host_get_nb_pstates(smx_host_t host) {
206           xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
207
208           return surf_workstation_model->extension.workstation.
209               get_nb_pstates(host);
210 }
211
212
213 void SIMIX_pre_host_set_power_peak_at(smx_simcall_t simcall, smx_host_t host, int pstate_index){
214   SIMIX_host_set_power_peak_at(host, pstate_index);
215 }
216 void SIMIX_host_set_power_peak_at(smx_host_t host, int pstate_index) {
217           xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
218
219           surf_workstation_model->extension.workstation.
220               set_power_peak_at(host, pstate_index);
221 }
222
223 double SIMIX_pre_host_get_consumed_energy(smx_simcall_t simcall, smx_host_t host){
224   return SIMIX_host_get_consumed_energy(host);
225 }
226 double SIMIX_host_get_consumed_energy(smx_host_t host) {
227           xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
228           return surf_workstation_model->extension.workstation.
229                       get_consumed_energy(host);
230 }
231
232 int SIMIX_pre_host_get_state(smx_simcall_t simcall, smx_host_t host){
233   return SIMIX_host_get_state(host);
234 }
235 int SIMIX_host_get_state(smx_host_t host){
236   xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
237
238   return surf_workstation_model->extension.workstation.
239       get_state(host);
240 }
241
242 void* SIMIX_pre_host_self_get_data(smx_simcall_t simcall){
243   return SIMIX_host_self_get_data();
244 }
245 void* SIMIX_host_self_get_data(void)
246 {
247   smx_host_t self = SIMIX_host_self();
248   return SIMIX_host_get_data(self);
249 }
250
251 void SIMIX_host_self_set_data(void *data)
252 {
253   smx_host_t self = SIMIX_host_self();
254   SIMIX_host_set_data(self, data);
255 }
256
257 void* SIMIX_pre_host_get_data(smx_simcall_t simcall,smx_host_t host){
258   return SIMIX_host_get_data(host);
259 }
260 void* SIMIX_host_get_data(smx_host_t host){
261   xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
262
263   return SIMIX_host_priv(host)->data;
264 }
265 void _SIMIX_host_free_process_arg(void *);
266 void _SIMIX_host_free_process_arg(void *data)
267 {
268   smx_process_arg_t arg = *(void**)data;
269   xbt_free(arg->name);
270   xbt_free(arg);
271 }
272 /**
273  * \brief Add a process to the list of the processes that the host will restart when it comes back
274  * This function add a process to the list of the processes that will be restarted when the host comes
275  * back. It is expected that this function is called when the host is down.
276  * The processes will only be restarted once, meaning that you will have to register the process
277  * again to restart the process again.
278  */
279 void SIMIX_host_add_auto_restart_process(smx_host_t host,
280                                          const char *name,
281                                          xbt_main_func_t code,
282                                          void *data,
283                                          const char *hostname,
284                                          double kill_time,
285                                          int argc, char **argv,
286                                          xbt_dict_t properties,
287                                          int auto_restart)
288 {
289   if (!SIMIX_host_priv(host)->auto_restart_processes) {
290     SIMIX_host_priv(host)->auto_restart_processes = xbt_dynar_new(sizeof(smx_process_arg_t),_SIMIX_host_free_process_arg);
291   }
292   smx_process_arg_t arg = xbt_new(s_smx_process_arg_t,1);
293   arg->name = xbt_strdup(name);
294   arg->code = code;
295   arg->data = data;
296   arg->hostname = hostname;
297   arg->kill_time = kill_time;
298   arg->argc = argc;
299
300   arg->argv = xbt_new(char*,argc + 1);
301
302   int i;
303   for (i = 0; i < argc; i++) {
304     arg->argv[i] = xbt_strdup(argv[i]);
305   }
306   arg->argv[argc] = NULL;
307
308   arg->properties = properties;
309   arg->auto_restart = auto_restart;
310
311   if( SIMIX_host_get_state(host) == SURF_RESOURCE_OFF
312       && !xbt_dict_get_or_null(watched_hosts_lib,sg_host_name(host))){
313     xbt_dict_set(watched_hosts_lib,sg_host_name(host),host,NULL);
314     XBT_DEBUG("Have push host %s to watched_hosts_lib because state == SURF_RESOURCE_OFF",sg_host_name(host));
315   }
316   xbt_dynar_push_as(SIMIX_host_priv(host)->auto_restart_processes,smx_process_arg_t,arg);
317 }
318 /**
319  * \brief Restart the list of processes that have been registered to the host
320  */
321 void SIMIX_host_restart_processes(smx_host_t host)
322 {
323   unsigned int cpt;
324   smx_process_arg_t arg;
325   xbt_dynar_foreach(SIMIX_host_priv(host)->auto_restart_processes,cpt,arg) {
326
327     smx_process_t process;
328
329     XBT_DEBUG("Restarting Process %s(%s) right now", arg->argv[0], arg->hostname);
330     if (simix_global->create_process_function) {
331       simix_global->create_process_function(&process,
332                                             arg->argv[0],
333                                             arg->code,
334                                             NULL,
335                                             arg->hostname,
336                                             arg->kill_time,
337                                             arg->argc,
338                                             arg->argv,
339                                             arg->properties,
340                                             arg->auto_restart);
341     }
342     else {
343       simcall_process_create(&process,
344                                             arg->argv[0],
345                                             arg->code,
346                                             NULL,
347                                             arg->hostname,
348                                             arg->kill_time,
349                                             arg->argc,
350                                             arg->argv,
351                                             arg->properties,
352                                             arg->auto_restart);
353
354     }
355   }
356   xbt_dynar_reset(SIMIX_host_priv(host)->auto_restart_processes);
357 }
358
359 void SIMIX_host_autorestart(smx_host_t host)
360 {
361   if(simix_global->autorestart)
362     simix_global->autorestart(host);
363   else
364     xbt_die("No function for simix_global->autorestart");
365 }
366
367 void SIMIX_pre_host_set_data(smx_simcall_t simcall, smx_host_t host, void *data) {
368   SIMIX_host_set_data(host, data);
369 }
370 void SIMIX_host_set_data(smx_host_t host, void *data){
371   xbt_assert((host != NULL), "Invalid parameters");
372   xbt_assert((SIMIX_host_priv(host)->data == NULL), "Data already set");
373
374   SIMIX_host_priv(host)->data = data;
375 }
376
377 smx_action_t SIMIX_pre_host_execute(smx_simcall_t simcall,const char *name,
378     smx_host_t host, double computation_amount, double priority){
379   return SIMIX_host_execute(name, host, computation_amount, priority);
380 }
381 smx_action_t SIMIX_host_execute(const char *name,
382     smx_host_t host, double computation_amount, double priority){
383
384   /* alloc structures and initialize */
385   smx_action_t action = xbt_mallocator_get(simix_global->action_mallocator);
386   action->type = SIMIX_ACTION_EXECUTE;
387   action->name = xbt_strdup(name);
388   action->state = SIMIX_RUNNING;
389   action->execution.host = host;
390
391 #ifdef HAVE_TRACING
392   action->category = NULL;
393 #endif
394
395   /* set surf's action */
396   if (!MC_is_active()) {
397     action->execution.surf_exec =
398       surf_workstation_model->extension.workstation.execute(host,
399     computation_amount);
400     surf_workstation_model->action_data_set(action->execution.surf_exec, action);
401     surf_workstation_model->set_priority(action->execution.surf_exec, priority);
402   }
403
404   XBT_DEBUG("Create execute action %p", action);
405
406   return action;
407 }
408
409 smx_action_t SIMIX_pre_host_parallel_execute(smx_simcall_t simcall, const char *name,
410     int host_nb, smx_host_t *host_list,
411     double *computation_amount, double *communication_amount,
412     double amount, double rate){
413   return SIMIX_host_parallel_execute(name, host_nb, host_list, computation_amount,
414                                      communication_amount, amount, rate);
415 }
416 smx_action_t SIMIX_host_parallel_execute(const char *name,
417     int host_nb, smx_host_t *host_list,
418     double *computation_amount, double *communication_amount,
419     double amount, double rate){
420
421   void **workstation_list = NULL;
422   int i;
423
424   /* alloc structures and initialize */
425   smx_action_t action = xbt_mallocator_get(simix_global->action_mallocator);
426   action->type = SIMIX_ACTION_PARALLEL_EXECUTE;
427   action->name = xbt_strdup(name);
428   action->state = SIMIX_RUNNING;
429   action->execution.host = NULL; /* FIXME: do we need the list of hosts? */
430
431 #ifdef HAVE_TRACING
432   action->category = NULL;
433 #endif
434
435   /* set surf's action */
436   workstation_list = xbt_new0(void *, host_nb);
437   for (i = 0; i < host_nb; i++)
438     workstation_list[i] = host_list[i];
439
440   /* set surf's action */
441   if (!MC_is_active()) {
442     action->execution.surf_exec =
443       surf_workstation_model->extension.workstation.
444       execute_parallel_task(host_nb, workstation_list, computation_amount,
445                       communication_amount, rate);
446
447     surf_workstation_model->action_data_set(action->execution.surf_exec, action);
448   }
449   XBT_DEBUG("Create parallel execute action %p", action);
450
451   return action;
452 }
453
454 void SIMIX_pre_host_execution_destroy(smx_simcall_t simcall, smx_action_t action){
455   SIMIX_host_execution_destroy(action);
456 }
457 void SIMIX_host_execution_destroy(smx_action_t action){
458   XBT_DEBUG("Destroy action %p", action);
459
460   if (action->execution.surf_exec) {
461     surf_workstation_model->action_unref(action->execution.surf_exec);
462     action->execution.surf_exec = NULL;
463   }
464   xbt_free(action->name);
465   xbt_mallocator_release(simix_global->action_mallocator, action);
466 }
467
468 void SIMIX_pre_host_execution_cancel(smx_simcall_t simcall, smx_action_t action){
469   SIMIX_host_execution_cancel(action);
470 }
471 void SIMIX_host_execution_cancel(smx_action_t action){
472   XBT_DEBUG("Cancel action %p", action);
473
474   if (action->execution.surf_exec)
475     surf_workstation_model->action_cancel(action->execution.surf_exec);
476 }
477
478 double SIMIX_pre_host_execution_get_remains(smx_simcall_t simcall, smx_action_t action){
479   return SIMIX_host_execution_get_remains(action);
480 }
481 double SIMIX_host_execution_get_remains(smx_action_t action){
482   double result = 0.0;
483
484   if (action->state == SIMIX_RUNNING)
485     result = surf_workstation_model->get_remains(action->execution.surf_exec);
486
487   return result;
488 }
489
490 e_smx_state_t SIMIX_pre_host_execution_get_state(smx_simcall_t simcall, smx_action_t action){
491   return SIMIX_host_execution_get_state(action);
492 }
493 e_smx_state_t SIMIX_host_execution_get_state(smx_action_t action){
494   return action->state;
495 }
496
497 void SIMIX_pre_host_execution_set_priority(smx_simcall_t simcall, smx_action_t action,
498                                         double priority){
499   return SIMIX_host_execution_set_priority(action, priority);
500 }
501 void SIMIX_host_execution_set_priority(smx_action_t action, double priority){
502   if(action->execution.surf_exec)
503     surf_workstation_model->set_priority(action->execution.surf_exec, priority);
504 }
505
506 void SIMIX_pre_host_execution_wait(smx_simcall_t simcall, smx_action_t action){
507
508   XBT_DEBUG("Wait for execution of action %p, state %d", action, (int)action->state);
509
510   /* Associate this simcall to the action */
511   xbt_fifo_push(action->simcalls, simcall);
512   simcall->issuer->waiting_action = action;
513
514   /* set surf's action */
515   if (MC_is_active()) {
516     action->state = SIMIX_DONE;
517     SIMIX_execution_finish(action);
518     return;
519   }
520
521   /* If the action is already finished then perform the error handling */
522   if (action->state != SIMIX_RUNNING)
523     SIMIX_execution_finish(action);
524 }
525
526 void SIMIX_host_execution_suspend(smx_action_t action)
527 {
528   if(action->execution.surf_exec)
529     surf_workstation_model->suspend(action->execution.surf_exec);
530 }
531
532 void SIMIX_host_execution_resume(smx_action_t action)
533 {
534   if(action->execution.surf_exec)
535     surf_workstation_model->resume(action->execution.surf_exec);
536 }
537
538 void SIMIX_execution_finish(smx_action_t action)
539 {
540   xbt_fifo_item_t item;
541   smx_simcall_t simcall;
542
543   xbt_fifo_foreach(action->simcalls, item, simcall, smx_simcall_t) {
544
545     switch (action->state) {
546
547       case SIMIX_DONE:
548         /* do nothing, action done */
549   XBT_DEBUG("SIMIX_execution_finished: execution successful");
550         break;
551
552       case SIMIX_FAILED:
553         XBT_DEBUG("SIMIX_execution_finished: host '%s' failed", sg_host_name(simcall->issuer->smx_host));
554         simcall->issuer->context->iwannadie = 1;
555         //SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
556         break;
557
558       case SIMIX_CANCELED:
559         XBT_DEBUG("SIMIX_execution_finished: execution canceled");
560         SMX_EXCEPTION(simcall->issuer, cancel_error, 0, "Canceled");
561         break;
562
563       default:
564         xbt_die("Internal error in SIMIX_execution_finish: unexpected action state %d",
565             (int)action->state);
566     }
567     /* check if the host is down */
568     if (surf_workstation_model->extension.
569         workstation.get_state(simcall->issuer->smx_host) != SURF_RESOURCE_ON) {
570       simcall->issuer->context->iwannadie = 1;
571     }
572
573     simcall->issuer->waiting_action =    NULL;
574     simcall_host_execution_wait__set__result(simcall, action->state);
575     SIMIX_simcall_answer(simcall);
576   }
577
578   /* We no longer need it */
579   SIMIX_host_execution_destroy(action);
580 }
581
582 void SIMIX_post_host_execute(smx_action_t action)
583 {
584   if (action->type == SIMIX_ACTION_EXECUTE && /* FIMXE: handle resource failure
585                                                * for parallel tasks too */
586       surf_workstation_model->extension.workstation.get_state(action->execution.host) == SURF_RESOURCE_OFF) {
587     /* If the host running the action failed, notice it so that the asking
588      * process can be killed if it runs on that host itself */
589     action->state = SIMIX_FAILED;
590   } else if (surf_workstation_model->action_state_get(action->execution.surf_exec) == SURF_ACTION_FAILED) {
591     /* If the host running the action didn't fail, then the action was
592      * canceled */
593     action->state = SIMIX_CANCELED;
594   } else {
595     action->state = SIMIX_DONE;
596   }
597
598   if (action->execution.surf_exec) {
599     surf_workstation_model->action_unref(action->execution.surf_exec);
600     action->execution.surf_exec = NULL;
601   }
602
603   /* If there are simcalls associated with the action, then answer them */
604   if (xbt_fifo_size(action->simcalls)) {
605     SIMIX_execution_finish(action);
606   }
607 }
608
609
610 #ifdef HAVE_TRACING
611 void SIMIX_pre_set_category(smx_simcall_t simcall, smx_action_t action,
612                             const char *category){
613   SIMIX_set_category(action, category);
614 }
615 void SIMIX_set_category(smx_action_t action, const char *category)
616 {
617   if (action->state != SIMIX_RUNNING) return;
618   if (action->type == SIMIX_ACTION_EXECUTE){
619     surf_workstation_model->set_category(action->execution.surf_exec, category);
620   }else if (action->type == SIMIX_ACTION_COMMUNICATE){
621     surf_workstation_model->set_category(action->comm.surf_comm, category);
622   }
623 }
624 #endif
625