src/simix/smx_host.c

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