Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[SGpp] make SIMIX_HOST_LEVEL private
[simgrid.git] / src / simix / smx_host.c
1 /* Copyright (c) 2007-2014. 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 #include "mc/mc_replay.h"
13
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_host, simix,
15                                 "SIMIX hosts");
16
17 static void SIMIX_execution_finish(smx_synchro_t synchro);
18
19 /**
20  * \brief Internal function to create a SIMIX host.
21  * \param name name of the host to create
22  * \param data some user data (may be NULL)
23  */
24 sg_host_t SIMIX_host_create(const char *name, void *killme) // FIXME: braindead prototype. Take sg_host as first arg
25 {
26   sg_host_t host = xbt_lib_get_elm_or_null(host_lib, name);
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->process_list =
32       xbt_swag_new(xbt_swag_offset(proc, host_proc_hookup));
33
34   /* Update global variables */
35   sg_host_simix_set(host, smx_host);
36
37   return host;
38 }
39
40 /**
41  * \brief Start the host if it is off
42  *
43  */
44 void SIMIX_host_on(sg_host_t h)
45 {
46   smx_host_priv_t host = sg_host_simix(h);
47
48   xbt_assert((host != NULL), "Invalid parameters");
49
50   if (surf_host_get_state(surf_host_resource_priv(h))==SURF_RESOURCE_OFF) {
51     surf_host_set_state(surf_host_resource_priv(h), SURF_RESOURCE_ON);
52
53     unsigned int cpt;
54     smx_process_arg_t arg;
55     xbt_dynar_foreach(host->boot_processes,cpt,arg) {
56       smx_process_t process;
57
58       char** argv = xbt_new(char*, arg->argc);
59       for (int i=0; i<arg->argc; i++)
60         argv[i] = xbt_strdup(arg->argv[i]);
61
62       XBT_DEBUG("Booting Process %s(%s) right now", arg->argv[0], arg->hostname);
63       if (simix_global->create_process_function) {
64         simix_global->create_process_function(&process,
65                                               argv[0],
66                                               arg->code,
67                                               NULL,
68                                               arg->hostname,
69                                               arg->kill_time,
70                                               arg->argc,
71                                               argv,
72                                               arg->properties,
73                                               arg->auto_restart,
74                                               NULL);
75       } else {
76         simcall_process_create(&process,
77                                arg->argv[0],
78                                arg->code,
79                                NULL,
80                                arg->hostname,
81                                arg->kill_time,
82                                arg->argc,
83                                argv,
84                                arg->properties,
85                                arg->auto_restart);
86       }
87     }
88   }
89 }
90
91 void simcall_HANDLER_host_off(smx_simcall_t simcall, sg_host_t h)
92 {
93  SIMIX_host_off(h, simcall->issuer);
94 }
95
96 /**
97  * \brief Stop the host if it is on
98  *
99  */
100 void SIMIX_host_off(sg_host_t h, smx_process_t issuer)
101 {
102   smx_host_priv_t host = sg_host_simix(h);
103
104   xbt_assert((host != NULL), "Invalid parameters");
105
106   if (surf_host_get_state(surf_host_resource_priv(h))==SURF_RESOURCE_ON) {
107         surf_host_set_state(surf_host_resource_priv(h), SURF_RESOURCE_OFF);
108
109     /* Clean Simulator data */
110     if (xbt_swag_size(host->process_list) != 0) {
111       smx_process_t process = NULL;
112       xbt_swag_foreach(process, host->process_list) {
113         SIMIX_process_kill(process, issuer);
114         XBT_DEBUG("Killing %s on %s by %s", process->name,  sg_host_name(process->host), issuer->name);
115       }
116     }
117   }
118 }
119
120 /**
121  * \brief Internal function to destroy a SIMIX host.
122  *
123  * \param h the host to destroy (a sg_host_t)
124  */
125 void SIMIX_host_destroy(void *h)
126 {
127   smx_host_priv_t host = (smx_host_priv_t) h;
128
129   xbt_assert((host != NULL), "Invalid parameters");
130
131   /* Clean Simulator data */
132   if (xbt_swag_size(host->process_list) != 0) {
133     char *msg = xbt_strdup("Shutting down host, but it's not empty:");
134     char *tmp;
135     smx_process_t process = NULL;
136
137     xbt_swag_foreach(process, host->process_list) {
138       tmp = bprintf("%s\n\t%s", msg, process->name);
139       free(msg);
140       msg = tmp;
141     }
142     SIMIX_display_process_status();
143     THROWF(arg_error, 0, "%s", msg);
144   }
145   xbt_dynar_free(&host->auto_restart_processes);
146   xbt_dynar_free(&host->boot_processes);
147   xbt_swag_free(host->process_list);
148
149   /* Clean host structure */
150   free(host);
151   return;
152 }
153
154 sg_host_t SIMIX_host_get_by_name(const char *name){
155   xbt_assert(((simix_global != NULL)
156                && (host_lib != NULL)),
157               "Environment not set yet");
158
159   return xbt_lib_get_elm_or_null(host_lib, name);
160 }
161
162 sg_host_t SIMIX_host_self(void)
163 {
164   smx_process_t process = SIMIX_process_self();
165   return (process == NULL) ? NULL : SIMIX_process_get_host(process);
166 }
167
168 /* needs to be public and without simcall because it is called
169    by exceptions and logging events */
170 const char* SIMIX_host_self_get_name(void)
171 {
172   sg_host_t host = SIMIX_host_self();
173   if (host == NULL || SIMIX_process_self() == simix_global->maestro_process)
174     return "";
175
176   return SIMIX_host_get_name(host);
177 }
178
179 xbt_dict_t SIMIX_host_get_properties(sg_host_t host){
180   return surf_host_get_properties(surf_host_resource_priv(host));
181 }
182
183 double SIMIX_host_get_speed(sg_host_t host){
184   return surf_host_get_speed(host, 1.0);
185 }
186
187 int SIMIX_host_get_core(sg_host_t host){
188   return surf_host_get_core(host);
189 }
190
191 xbt_swag_t SIMIX_host_get_process_list(sg_host_t host){
192   smx_host_priv_t host_priv = sg_host_simix(host);
193
194   return host_priv->process_list;
195 }
196
197
198 double SIMIX_host_get_available_speed(sg_host_t host){
199   return surf_host_get_available_speed(host);
200 }
201
202 double SIMIX_host_get_current_power_peak(sg_host_t host) {
203           return surf_host_get_current_power_peak(host);
204 }
205
206 double SIMIX_host_get_power_peak_at(sg_host_t host, int pstate_index) {
207           return surf_host_get_power_peak_at(host, pstate_index);
208 }
209
210 int SIMIX_host_get_nb_pstates(sg_host_t host) {
211           return surf_host_get_nb_pstates(host);
212 }
213
214
215 void SIMIX_host_set_pstate(sg_host_t host, int pstate_index) {
216           surf_host_set_pstate(host, pstate_index);
217 }
218 int SIMIX_host_get_pstate(sg_host_t host) {
219           return surf_host_get_pstate(host);
220 }
221
222 double SIMIX_host_get_consumed_energy(sg_host_t host) {
223           return surf_host_get_consumed_energy(host);
224 }
225 double SIMIX_host_get_wattmin_at(sg_host_t host,int pstate) {
226           return surf_host_get_wattmin_at(host,pstate);
227 }
228 double SIMIX_host_get_wattmax_at(sg_host_t host,int pstate) {
229           return surf_host_get_wattmax_at(host,pstate);
230 }
231
232 int SIMIX_host_get_state(sg_host_t host){
233   return surf_host_get_state(surf_host_resource_priv(host));
234 }
235
236 void _SIMIX_host_free_process_arg(void *data)
237 {
238   smx_process_arg_t arg = *(void**)data;
239   int i;
240   for (i = 0; i < arg->argc; i++)
241     xbt_free(arg->argv[i]);
242   xbt_free(arg->argv);
243   xbt_free(arg->name);
244   xbt_free(arg);
245 }
246 /**
247  * \brief Add a process to the list of the processes that the host will restart when it comes back
248  * This function add a process to the list of the processes that will be restarted when the host comes
249  * back. It is expected that this function is called when the host is down.
250  * The processes will only be restarted once, meaning that you will have to register the process
251  * again to restart the process again.
252  */
253 void SIMIX_host_add_auto_restart_process(sg_host_t host,
254                                          const char *name,
255                                          xbt_main_func_t code,
256                                          void *data,
257                                          const char *hostname,
258                                          double kill_time,
259                                          int argc, char **argv,
260                                          xbt_dict_t properties,
261                                          int auto_restart)
262 {
263   if (!sg_host_simix(host)->auto_restart_processes) {
264     sg_host_simix(host)->auto_restart_processes = xbt_dynar_new(sizeof(smx_process_arg_t),_SIMIX_host_free_process_arg);
265   }
266   smx_process_arg_t arg = xbt_new(s_smx_process_arg_t,1);
267   arg->name = xbt_strdup(name);
268   arg->code = code;
269   arg->data = data;
270   arg->hostname = hostname;
271   arg->kill_time = kill_time;
272   arg->argc = argc;
273
274   arg->argv = xbt_new(char*,argc + 1);
275
276   int i;
277   for (i = 0; i < argc; i++) {
278     arg->argv[i] = xbt_strdup(argv[i]);
279   }
280   arg->argv[argc] = NULL;
281
282   arg->properties = properties;
283   arg->auto_restart = auto_restart;
284
285   if( SIMIX_host_get_state(host) == SURF_RESOURCE_OFF
286       && !xbt_dict_get_or_null(watched_hosts_lib,sg_host_name(host))){
287     xbt_dict_set(watched_hosts_lib,sg_host_name(host),host,NULL);
288     XBT_DEBUG("Have pushed host %s to watched_hosts_lib because state == SURF_RESOURCE_OFF",sg_host_name(host));
289   }
290   xbt_dynar_push_as(sg_host_simix(host)->auto_restart_processes,smx_process_arg_t,arg);
291 }
292 /**
293  * \brief Restart the list of processes that have been registered to the host
294  */
295 void SIMIX_host_restart_processes(sg_host_t host)
296 {
297   unsigned int cpt;
298   smx_process_arg_t arg;
299   xbt_dynar_t process_list = sg_host_simix(host)->auto_restart_processes;
300   if (!process_list)
301     return;
302
303   xbt_dynar_foreach (process_list, cpt, arg) {
304
305     smx_process_t process;
306
307     XBT_DEBUG("Restarting Process %s(%s) right now", arg->argv[0], arg->hostname);
308     if (simix_global->create_process_function) {
309       simix_global->create_process_function(&process,
310                                             arg->argv[0],
311                                             arg->code,
312                                             NULL,
313                                             arg->hostname,
314                                             arg->kill_time,
315                                             arg->argc,
316                                             arg->argv,
317                                             arg->properties,
318                                             arg->auto_restart,
319                                             NULL);
320     } else {
321       simcall_process_create(&process,
322                              arg->argv[0],
323                              arg->code,
324                              NULL,
325                              arg->hostname,
326                              arg->kill_time,
327                              arg->argc,
328                              arg->argv,
329                              arg->properties,
330                              arg->auto_restart);
331
332     }
333     /* arg->argv is used by the process created above.  Hide it to
334      * _SIMIX_host_free_process_arg() which is called by xbt_dynar_reset()
335      * below. */
336     arg->argc = 0;
337     arg->argv = NULL;
338   }
339   xbt_dynar_reset(process_list);
340 }
341
342 void SIMIX_host_autorestart(sg_host_t host)
343 {
344   if(simix_global->autorestart)
345     simix_global->autorestart(host);
346   else
347     xbt_die("No function for simix_global->autorestart");
348 }
349
350 smx_synchro_t SIMIX_host_execute(const char *name,
351     sg_host_t host, double flops_amount, double priority, double bound, unsigned long affinity_mask){
352
353   /* alloc structures and initialize */
354   smx_synchro_t synchro = xbt_mallocator_get(simix_global->synchro_mallocator);
355   synchro->type = SIMIX_SYNC_EXECUTE;
356   synchro->name = xbt_strdup(name);
357   synchro->state = SIMIX_RUNNING;
358   synchro->execution.host = host;
359   synchro->category = NULL;
360
361   /* set surf's action */
362   if (!MC_is_active() && !MC_record_replay_is_active()) {
363
364     synchro->execution.surf_exec = surf_host_execute(host, flops_amount);
365     surf_action_set_data(synchro->execution.surf_exec, synchro);
366     surf_action_set_priority(synchro->execution.surf_exec, priority);
367
368     /* Note (hypervisor): for multicore, the bound value being passed to the
369      * surf layer should not be zero (i.e., unlimited). It should be the
370      * capacity of a CPU core. */
371     if (bound == 0)
372       surf_cpu_action_set_bound(synchro->execution.surf_exec, SIMIX_host_get_speed(host));
373     else
374       surf_cpu_action_set_bound(synchro->execution.surf_exec, bound);
375
376     if (affinity_mask != 0) {
377       /* just a double check to confirm that this host is the host where this task is running. */
378       xbt_assert(synchro->execution.host == host);
379       surf_cpu_action_set_affinity(synchro->execution.surf_exec, host, affinity_mask);
380     }
381   }
382
383   XBT_DEBUG("Create execute synchro %p: %s", synchro, synchro->name);
384
385   return synchro;
386 }
387
388 smx_synchro_t SIMIX_host_parallel_execute(const char *name,
389     int host_nb, sg_host_t *host_list,
390     double *flops_amount, double *bytes_amount,
391     double amount, double rate){
392
393   void **surf_host_list = NULL;
394   int i;
395
396   /* alloc structures and initialize */
397   smx_synchro_t synchro = xbt_mallocator_get(simix_global->synchro_mallocator);
398   synchro->type = SIMIX_SYNC_PARALLEL_EXECUTE;
399   synchro->name = xbt_strdup(name);
400   synchro->state = SIMIX_RUNNING;
401   synchro->execution.host = NULL; /* FIXME: do we need the list of hosts? */
402   synchro->category = NULL;
403
404   /* set surf's synchro */
405   surf_host_list = xbt_new0(void *, host_nb);
406   for (i = 0; i < host_nb; i++)
407     surf_host_list[i] = surf_host_resource_priv(host_list[i]);
408
409
410   /* FIXME: what happens if host_list contains VMs and PMs. If
411    * execute_parallel_task() does not change the state of the model, we can mix
412    * them. */
413   surf_model_t ws_model = surf_resource_model(host_list[0], SURF_HOST_LEVEL);
414   for (i = 1; i < host_nb; i++) {
415     surf_model_t ws_model_tmp = surf_resource_model(host_list[i], SURF_HOST_LEVEL);
416     if (ws_model_tmp != ws_model) {
417       XBT_CRITICAL("mixing VMs and PMs is not supported");
418       DIE_IMPOSSIBLE;
419     }
420   }
421
422   /* set surf's synchro */
423   if (!MC_is_active() && !MC_record_replay_is_active()) {
424     synchro->execution.surf_exec =
425       surf_host_model_execute_parallel_task((surf_host_model_t)surf_host_model,
426                   host_nb, surf_host_list, flops_amount, bytes_amount, rate);
427
428     surf_action_set_data(synchro->execution.surf_exec, synchro);
429   }
430   XBT_DEBUG("Create parallel execute synchro %p", synchro);
431
432   return synchro;
433 }
434
435 void SIMIX_host_execution_destroy(smx_synchro_t synchro){
436   XBT_DEBUG("Destroy synchro %p", synchro);
437
438   if (synchro->execution.surf_exec) {
439     surf_action_unref(synchro->execution.surf_exec);
440     synchro->execution.surf_exec = NULL;
441   }
442   xbt_free(synchro->name);
443   xbt_mallocator_release(simix_global->synchro_mallocator, synchro);
444 }
445
446 void SIMIX_host_execution_cancel(smx_synchro_t synchro){
447   XBT_DEBUG("Cancel synchro %p", synchro);
448
449   if (synchro->execution.surf_exec)
450     surf_action_cancel(synchro->execution.surf_exec);
451 }
452
453 double SIMIX_host_execution_get_remains(smx_synchro_t synchro){
454   double result = 0.0;
455
456   if (synchro->state == SIMIX_RUNNING)
457     result = surf_action_get_remains(synchro->execution.surf_exec);
458
459   return result;
460 }
461
462 e_smx_state_t SIMIX_host_execution_get_state(smx_synchro_t synchro){
463   return synchro->state;
464 }
465
466 void SIMIX_host_execution_set_priority(smx_synchro_t synchro, double priority){
467
468   if(synchro->execution.surf_exec)
469         surf_action_set_priority(synchro->execution.surf_exec, priority);
470 }
471
472 void SIMIX_host_execution_set_bound(smx_synchro_t synchro, double bound){
473
474   if(synchro->execution.surf_exec)
475         surf_cpu_action_set_bound(synchro->execution.surf_exec, bound);
476 }
477
478 void SIMIX_host_execution_set_affinity(smx_synchro_t synchro, sg_host_t host, unsigned long mask){
479   xbt_assert(synchro->type == SIMIX_SYNC_EXECUTE);
480
481   if (synchro->execution.surf_exec) {
482     /* just a double check to confirm that this host is the host where this task is running. */
483     xbt_assert(synchro->execution.host == host);
484     surf_cpu_action_set_affinity(synchro->execution.surf_exec, host, mask);
485   }
486 }
487
488 void simcall_HANDLER_host_execution_wait(smx_simcall_t simcall, smx_synchro_t synchro){
489
490   XBT_DEBUG("Wait for execution of synchro %p, state %d", synchro, (int)synchro->state);
491
492   /* Associate this simcall to the synchro */
493   xbt_fifo_push(synchro->simcalls, simcall);
494   simcall->issuer->waiting_synchro = synchro;
495
496   /* set surf's synchro */
497   if (MC_is_active() || MC_record_replay_is_active()) {
498     synchro->state = SIMIX_DONE;
499     SIMIX_execution_finish(synchro);
500     return;
501   }
502
503   /* If the synchro is already finished then perform the error handling */
504   if (synchro->state != SIMIX_RUNNING)
505     SIMIX_execution_finish(synchro);
506 }
507
508 void SIMIX_host_execution_suspend(smx_synchro_t synchro)
509 {
510   if(synchro->execution.surf_exec)
511     surf_action_suspend(synchro->execution.surf_exec);
512 }
513
514 void SIMIX_host_execution_resume(smx_synchro_t synchro)
515 {
516   if(synchro->execution.surf_exec)
517     surf_action_resume(synchro->execution.surf_exec);
518 }
519
520 void SIMIX_execution_finish(smx_synchro_t synchro)
521 {
522   xbt_fifo_item_t item;
523   smx_simcall_t simcall;
524
525   xbt_fifo_foreach(synchro->simcalls, item, simcall, smx_simcall_t) {
526
527     switch (synchro->state) {
528
529       case SIMIX_DONE:
530         /* do nothing, synchro done */
531         XBT_DEBUG("SIMIX_execution_finished: execution successful");
532         break;
533
534       case SIMIX_FAILED:
535         XBT_DEBUG("SIMIX_execution_finished: host '%s' failed", sg_host_name(simcall->issuer->host));
536         simcall->issuer->context->iwannadie = 1;
537         SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
538         break;
539
540       case SIMIX_CANCELED:
541         XBT_DEBUG("SIMIX_execution_finished: execution canceled");
542         SMX_EXCEPTION(simcall->issuer, cancel_error, 0, "Canceled");
543         break;
544
545       default:
546         xbt_die("Internal error in SIMIX_execution_finish: unexpected synchro state %d",
547             (int)synchro->state);
548     }
549     /* check if the host is down */
550     if (surf_host_get_state(surf_host_resource_priv(simcall->issuer->host)) != SURF_RESOURCE_ON) {
551       simcall->issuer->context->iwannadie = 1;
552     }
553
554     simcall->issuer->waiting_synchro =    NULL;
555     simcall_host_execution_wait__set__result(simcall, synchro->state);
556     SIMIX_simcall_answer(simcall);
557   }
558
559   /* We no longer need it */
560   SIMIX_host_execution_destroy(synchro);
561 }
562
563
564 void SIMIX_post_host_execute(smx_synchro_t synchro)
565 {
566   if (synchro->type == SIMIX_SYNC_EXECUTE && /* FIMXE: handle resource failure
567                                                * for parallel tasks too */
568       surf_host_get_state(surf_host_resource_priv(synchro->execution.host)) == SURF_RESOURCE_OFF) {
569     /* If the host running the synchro failed, notice it so that the asking
570      * process can be killed if it runs on that host itself */
571     synchro->state = SIMIX_FAILED;
572   } else if (surf_action_get_state(synchro->execution.surf_exec) == SURF_ACTION_FAILED) {
573     /* If the host running the synchro didn't fail, then the synchro was
574      * canceled */
575     synchro->state = SIMIX_CANCELED;
576   } else {
577     synchro->state = SIMIX_DONE;
578   }
579
580   if (synchro->execution.surf_exec) {
581     surf_action_unref(synchro->execution.surf_exec);
582     synchro->execution.surf_exec = NULL;
583   }
584
585   /* If there are simcalls associated with the synchro, then answer them */
586   if (xbt_fifo_size(synchro->simcalls)) {
587     SIMIX_execution_finish(synchro);
588   }
589 }
590
591
592 void SIMIX_set_category(smx_synchro_t synchro, const char *category)
593 {
594   if (synchro->state != SIMIX_RUNNING) return;
595   if (synchro->type == SIMIX_SYNC_EXECUTE){
596     surf_action_set_category(synchro->execution.surf_exec, category);
597   }else if (synchro->type == SIMIX_SYNC_COMMUNICATE){
598     surf_action_set_category(synchro->comm.surf_comm, category);
599   }
600 }
601
602 /**
603  * \brief Function to get the parameters of the given the SIMIX host.
604  *
605  * \param host the host to get_phys_host (a sg_host_t)
606  * \param param the parameter object space to be overwritten (a ws_params_t)
607  */
608 void SIMIX_host_get_params(sg_host_t ind_vm, ws_params_t params)
609 {
610   /* jump to ws_get_params(). */
611   surf_host_get_params(ind_vm, params);
612 }
613
614 void SIMIX_host_set_params(sg_host_t ind_vm, ws_params_t params)
615 {
616   /* jump to ws_set_params(). */
617   surf_host_set_params(ind_vm, params);
618 }
619
620 xbt_dict_t SIMIX_host_get_mounted_storage_list(sg_host_t host){
621   xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
622
623   return surf_host_get_mounted_storage_list(host);
624 }
625
626 xbt_dynar_t SIMIX_host_get_attached_storage_list(sg_host_t host){
627   xbt_assert((host != NULL), "Invalid parameters (simix host is NULL)");
628
629   return surf_host_get_attached_storage_list(host);
630 }