Logo AND Algorithmique Numérique Distribuée

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