src/simix/libsmx.cpp

   1 /* libsmx.c - public interface to simix                                       */
   2 /* --------                                                                   */
   3 /* These functions are the only ones that are visible from the higher levels  */
   4 /* (most of them simply add some documentation to the generated simcall body) */
   5 /*                                                                            */
   6 /* This is somehow the "libc" of SimGrid                                      */
   7
   8 /* Copyright (c) 2010-2015. The SimGrid Team.
   9  * All rights reserved.                                                     */
  10
  11 /* This program is free software; you can redistribute it and/or modify it
  12  * under the terms of the license (GNU LGPL) which comes with this package. */
  13
  14 #include <functional>
  15
  16 #include "src/mc/mc_replay.h"
  17 #include "smx_private.h"
  18 #include "src/mc/mc_forward.h"
  19 #include "xbt/ex.h"
  20 #include <math.h>         /* isfinite() */
  21 #include "mc/mc.h"
  22
  23 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
  24
  25 #include "popping_bodies.cpp"
  26
  27 /**
  28  * \ingroup simix_host_management
  29  * \brief Start the host if it is off
  30  *
  31  * \param host A SIMIX host
  32  */
  33 void simcall_host_on(sg_host_t host)
  34 {
  35   simcall_BODY_host_on(host);
  36 }
  37
  38 /**
  39  * \ingroup simix_host_management
  40  * \brief Stop the host if it is on
  41  *
  42  * \param host A SIMIX host
  43  */
  44 void simcall_host_off(sg_host_t host)
  45 {
  46   simcall_BODY_host_off(host);
  47 }
  48
  49 /**
  50  * \ingroup simix_host_management
  51  * \brief Returns a dict of the properties assigned to a host.
  52  *
  53  * \param host A host
  54  * \return The properties of this host
  55  */
  56 xbt_dict_t simcall_host_get_properties(sg_host_t host)
  57 {
  58   return simcall_BODY_host_get_properties(host);
  59 }
  60
  61 /**
  62  * \ingroup simix_host_management
  63  * \brief Returns a dict of the properties assigned to a router or AS.
  64  *
  65  * \param name The name of the router or AS
  66  * \return The properties
  67  */
  68 xbt_dict_t simcall_asr_get_properties(const char *name)
  69 {
  70   return simcall_BODY_asr_get_properties(name);
  71 }
  72
  73 /**
  74  * \ingroup simix_host_management
  75  * \brief Returns the list of processes attached to the host.
  76  *
  77  * \param host A SIMIX host
  78  * \return the swag of attached processes
  79  */
  80 xbt_swag_t simcall_host_get_process_list(sg_host_t host)
  81 {
  82   return simcall_BODY_host_get_process_list(host);
  83 }
  84
  85 /**
  86  * \ingroup simix_host_management
  87  * \brief Returns the power peak of a host.
  88  *
  89  * \param host A SIMIX host
  90  * \return the current power peak value (double)
  91  */
  92 double simcall_host_get_current_power_peak(sg_host_t host)
  93 {
  94   return simcall_BODY_host_get_current_power_peak(host);
  95 }
  96
  97 /**
  98  * \ingroup simix_host_management
  99  * \brief Returns one power peak (in flops/s) of a host at a given pstate
 100  *
 101  * \param host A SIMIX host
 102  * \param pstate_index pstate to test
 103  * \return the current power peak value (double) for pstate_index
 104  */
 105 double simcall_host_get_power_peak_at(sg_host_t host, int pstate_index)
 106 {
 107   return simcall_BODY_host_get_power_peak_at(host, pstate_index);
 108 }
 109
 110 /**
 111  * \ingroup simix_host_management
 112  * \brief Sets the pstate at which the host should run
 113  *
 114  * \param host A SIMIX host
 115  * \param pstate_index The pstate to which the CPU power will be set
 116  */
 117 void simcall_host_set_pstate(sg_host_t host, int pstate_index)
 118 {
 119         simcall_BODY_host_set_pstate(host, pstate_index);
 120 }
 121
 122 /** \ingroup simix_host_management
 123  * \brief Returns the amount of watt dissipated at the given pstate when the host is idling
 124  */
 125 double simcall_host_get_wattmin_at(msg_host_t host, int pstate){
 126         return simcall_BODY_host_get_wattmin_at(host, pstate);
 127 }
 128 /** \ingroup simix_host_management
 129  * \brief Returns the amount of watt dissipated at the given pstate when the host burns CPU at 100%
 130  */
 131 double simcall_host_get_wattmax_at(msg_host_t host, int pstate){
 132         return simcall_BODY_host_get_wattmax_at(host, pstate);
 133 }
 134
 135
 136
 137 /**
 138  * \ingroup simix_process_management
 139  * \brief Creates a synchro that executes some computation of an host.
 140  *
 141  * This function creates a SURF action and allocates the data necessary
 142  * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
 143  *
 144  * \param name Name of the execution synchro to create
 145  * \param flops_amount amount Computation amount (in flops)
 146  * \param priority computation priority
 147  * \param bound
 148  * \param affinity_mask
 149  * \return A new SIMIX execution synchronization
 150  */
 151 smx_synchro_t simcall_process_execute(const char *name,
 152                                     double flops_amount,
 153                                     double priority, double bound, unsigned long affinity_mask)
 154 {
 155   /* checking for infinite values */
 156   xbt_assert(isfinite(flops_amount), "flops_amount is not finite!");
 157   xbt_assert(isfinite(priority), "priority is not finite!");
 158
 159   return simcall_BODY_process_execute(name, flops_amount, priority, bound, affinity_mask);
 160 }
 161
 162 /**
 163  * \ingroup simix_process_management
 164  * \brief Creates a synchro that may involve parallel computation on
 165  * several hosts and communication between them.
 166  *
 167  * \param name Name of the execution synchro to create
 168  * \param host_nb Number of hosts where the synchro will be executed
 169  * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
 170  * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
 171  * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
 172  * amount between each pair of hosts
 173  * \param amount the SURF action amount
 174  * \param rate the SURF action rate
 175  * \return A new SIMIX execution synchronization
 176  */
 177 smx_synchro_t simcall_process_parallel_execute(const char *name,
 178                                          int host_nb,
 179                                          sg_host_t *host_list,
 180                                          double *flops_amount,
 181                                          double *bytes_amount,
 182                                          double amount,
 183                                          double rate)
 184 {
 185   int i,j;
 186   /* checking for infinite values */
 187   for (i = 0 ; i < host_nb ; ++i) {
 188      xbt_assert(isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
 189      for (j = 0 ; j < host_nb ; ++j) {
 190         xbt_assert(isfinite(bytes_amount[i + host_nb * j]),
 191              "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
 192      }
 193   }
 194
 195   xbt_assert(isfinite(amount), "amount is not finite!");
 196   xbt_assert(isfinite(rate), "rate is not finite!");
 197
 198   return simcall_BODY_process_parallel_execute(name, host_nb, host_list,
 199                                             flops_amount,
 200                                             bytes_amount,
 201                                             amount, rate);
 202
 203 }
 204
 205 /**
 206  * \ingroup simix_process_management
 207  * \brief Destroys an execution synchro.
 208  *
 209  * Destroys a synchro, freeing its memory. This function cannot be called if there are a conditional waiting for it.
 210  * \param execution The execution synchro to destroy
 211  */
 212 void simcall_process_execution_destroy(smx_synchro_t execution)
 213 {
 214   simcall_BODY_process_execution_destroy(execution);
 215 }
 216
 217 /**
 218  * \ingroup simix_process_management
 219  * \brief Cancels an execution synchro.
 220  *
 221  * This functions stops the execution. It calls a surf function.
 222  * \param execution The execution synchro to cancel
 223  */
 224 void simcall_process_execution_cancel(smx_synchro_t execution)
 225 {
 226   simcall_BODY_process_execution_cancel(execution);
 227 }
 228
 229 /**
 230  * \ingroup simix_process_management
 231  * \brief Returns how much of an execution synchro remains to be done.
 232  *
 233  * \param execution The execution synchro
 234  * \return The remaining amount
 235  */
 236 double simcall_process_execution_get_remains(smx_synchro_t execution)
 237 {
 238   return simcall_BODY_process_execution_get_remains(execution);
 239 }
 240
 241 /**
 242  * \ingroup simix_process_management
 243  * \brief Returns the state of an execution synchro.
 244  *
 245  * \param execution The execution synchro
 246  * \return The state
 247  */
 248 e_smx_state_t simcall_process_execution_get_state(smx_synchro_t execution)
 249 {
 250   return simcall_BODY_process_execution_get_state(execution);
 251 }
 252
 253 /**
 254  * \ingroup simix_process_management
 255  * \brief Changes the priority of an execution synchro.
 256  *
 257  * This functions changes the priority only. It calls a surf function.
 258  * \param execution The execution synchro
 259  * \param priority The new priority
 260  */
 261 void simcall_process_execution_set_priority(smx_synchro_t execution, double priority)
 262 {
 263   /* checking for infinite values */
 264   xbt_assert(isfinite(priority), "priority is not finite!");
 265
 266   simcall_BODY_process_execution_set_priority(execution, priority);
 267 }
 268
 269 /**
 270  * \ingroup simix_process_management
 271  * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
 272  *
 273  * This functions changes the capping only. It calls a surf function.
 274  * \param execution The execution synchro
 275  * \param bound The new bound
 276  */
 277 void simcall_process_execution_set_bound(smx_synchro_t execution, double bound)
 278 {
 279   simcall_BODY_process_execution_set_bound(execution, bound);
 280 }
 281
 282 /**
 283  * \ingroup simix_process_management
 284  * \brief Changes the CPU affinity of an execution synchro.
 285  *
 286  * This functions changes the CPU affinity of an execution synchro. See taskset(1) on Linux.
 287  * \param execution The execution synchro
 288  * \param host Host
 289  * \param mask Affinity mask
 290  */
 291 void simcall_process_execution_set_affinity(smx_synchro_t execution, sg_host_t host, unsigned long mask)
 292 {
 293   simcall_BODY_process_execution_set_affinity(execution, host, mask);
 294 }
 295
 296 /**
 297  * \ingroup simix_host_management
 298  * \brief Waits for the completion of an execution synchro and destroy it.
 299  *
 300  * \param execution The execution synchro
 301  */
 302 e_smx_state_t simcall_process_execution_wait(smx_synchro_t execution)
 303 {
 304   return (e_smx_state_t) simcall_BODY_process_execution_wait(execution);
 305 }
 306
 307
 308 /**
 309  * \ingroup simix_vm_management
 310  * \brief Create a VM on the given physical host.
 311  *
 312  * \param name VM name
 313  * \param host Physical host
 314  *
 315  * \return The host object of the VM
 316  */
 317 void* simcall_vm_create(const char *name, sg_host_t phys_host){
 318   return simcall_BODY_vm_create(name, phys_host);
 319 }
 320
 321 /**
 322  * \ingroup simix_vm_management
 323  * \brief Start the given VM to the given physical host
 324  *
 325  * \param vm VM
 326  */
 327 void simcall_vm_start(sg_host_t vm)
 328 {
 329   simcall_BODY_vm_start(vm);
 330 }
 331
 332 /**
 333  * \ingroup simix_vm_management
 334  * \brief Get the state of the given VM
 335  *
 336  * \param vm VM
 337  * \return The state of the VM
 338  */
 339 int simcall_vm_get_state(sg_host_t vm)
 340 {
 341   return simcall_BODY_vm_get_state(vm);
 342 }
 343
 344 /**
 345  * \ingroup simix_vm_management
 346  * \brief Get the name of the physical host on which the given VM runs.
 347  *
 348  * \param vm VM
 349  * \return The name of the physical host
 350  */
 351 void *simcall_vm_get_pm(sg_host_t vm)
 352 {
 353   return simcall_BODY_vm_get_pm(vm);
 354 }
 355
 356 void simcall_vm_set_bound(sg_host_t vm, double bound)
 357 {
 358   simcall_BODY_vm_set_bound(vm, bound);
 359 }
 360
 361 void simcall_vm_set_affinity(sg_host_t vm, sg_host_t pm, unsigned long mask)
 362 {
 363   simcall_BODY_vm_set_affinity(vm, pm, mask);
 364 }
 365
 366 void simcall_host_get_params(sg_host_t vm, vm_params_t params)
 367 {
 368   simcall_BODY_host_get_params(vm, params);
 369 }
 370
 371 void simcall_host_set_params(sg_host_t vm, vm_params_t params)
 372 {
 373   simcall_BODY_host_set_params(vm, params);
 374 }
 375
 376 /**
 377  * \ingroup simix_vm_management
 378  * \brief Migrate the given VM to the given physical host
 379  *
 380  * \param vm VM
 381  * \param host Destination physical host
 382  */
 383 void simcall_vm_migrate(sg_host_t vm, sg_host_t host)
 384 {
 385   simcall_BODY_vm_migrate(vm, host);
 386 }
 387
 388 /**
 389  * \ingroup simix_vm_management
 390  * \brief Suspend the given VM
 391  *
 392  * \param vm VM
 393  */
 394 void simcall_vm_suspend(sg_host_t vm)
 395 {
 396   simcall_BODY_vm_suspend(vm);
 397 }
 398
 399 /**
 400  * \ingroup simix_vm_management
 401  * \brief Resume the given VM
 402  *
 403  * \param vm VM
 404  */
 405 void simcall_vm_resume(sg_host_t vm)
 406 {
 407   simcall_BODY_vm_resume(vm);
 408 }
 409
 410 /**
 411  * \ingroup simix_vm_management
 412  * \brief Save the given VM
 413  *
 414  * \param vm VM
 415  */
 416 void simcall_vm_save(sg_host_t vm)
 417 {
 418   simcall_BODY_vm_save(vm);
 419 }
 420
 421 /**
 422  * \ingroup simix_vm_management
 423  * \brief Restore the given VM
 424  *
 425  * \param vm VM
 426  */
 427 void simcall_vm_restore(sg_host_t vm)
 428 {
 429   simcall_BODY_vm_restore(vm);
 430 }
 431
 432 /**
 433  * \ingroup simix_vm_management
 434  * \brief Shutdown the given VM
 435  *
 436  * \param vm VM
 437  */
 438 void simcall_vm_shutdown(sg_host_t vm)
 439 {
 440   simcall_BODY_vm_shutdown(vm);
 441 }
 442
 443 /**
 444  * \ingroup simix_vm_management
 445  * \brief Destroy the given VM
 446  *
 447  * \param vm VM
 448  */
 449 void simcall_vm_destroy(sg_host_t vm)
 450 {
 451   simcall_BODY_vm_destroy(vm);
 452 }
 453
 454 /**
 455  * \ingroup simix_vm_management
 456  * \brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
 457  *  The simcall actually invokes the following calls:
 458  *     simcall_vm_set_affinity(vm, src_pm, 0);
 459  *     simcall_vm_migrate(vm, dst_pm);
 460  *     simcall_vm_resume(vm);
 461  *
 462  * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
 463  *
 464  * \param vm VM to migrate
 465  * \param src_pm  Source physical host
 466  * \param dst_pmt Destination physical host
 467  */
 468 void simcall_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm)
 469 {
 470   simcall_BODY_vm_migratefrom_resumeto(vm, src_pm, dst_pm);
 471 }
 472
 473 /**
 474  * \ingroup simix_process_management
 475  * \brief Creates and runs a new SIMIX process.
 476  *
 477  * The structure and the corresponding thread are created and put in the list of ready processes.
 478  *
 479  * \param name a name for the process. It is for user-level information and can be NULL.
 480  * \param code the main function of the process
 481  * \param data a pointer to any data one may want to attach to the new object. It is for user-level information and can be NULL.
 482  * It can be retrieved with the function \ref simcall_process_get_data.
 483  * \param hostname name of the host where the new agent is executed.
 484  * \param kill_time time when the process is killed
 485  * \param argc first argument passed to \a code
 486  * \param argv second argument passed to \a code
 487  * \param properties the properties of the process
 488  * \param auto_restart either it is autorestarting or not.
 489  */
 490 smx_process_t simcall_process_create(const char *name,
 491                               xbt_main_func_t code,
 492                               void *data,
 493                               const char *hostname,
 494                               double kill_time,
 495                               int argc, char **argv,
 496                               xbt_dict_t properties,
 497                               int auto_restart)
 498 {
 499   return (smx_process_t) simcall_BODY_process_create(name, code, data, hostname,
 500                               kill_time, argc, argv, properties,
 501                               auto_restart);
 502 }
 503
 504 /**
 505  * \ingroup simix_process_management
 506  * \brief Kills a SIMIX process.
 507  *
 508  * This function simply kills a  process.
 509  *
 510  * \param process poor victim
 511  */
 512 void simcall_process_kill(smx_process_t process)
 513 {
 514   simcall_BODY_process_kill(process);
 515 }
 516
 517 /**
 518  * \ingroup simix_process_management
 519  * \brief Kills all SIMIX processes.
 520  */
 521 void simcall_process_killall(int reset_pid)
 522 {
 523   simcall_BODY_process_killall(reset_pid);
 524 }
 525
 526 /**
 527  * \ingroup simix_process_management
 528  * \brief Cleans up a SIMIX process.
 529  * \param process poor victim (must have already been killed)
 530  */
 531 void simcall_process_cleanup(smx_process_t process)
 532 {
 533   simcall_BODY_process_cleanup(process);
 534 }
 535
 536 /**
 537  * \ingroup simix_process_management
 538  * \brief Migrates an agent to another location.
 539  *
 540  * This function changes the value of the host on which \a process is running.
 541  *
 542  * \param process the process to migrate
 543  * \param dest name of the new host
 544  */
 545 void simcall_process_set_host(smx_process_t process, sg_host_t dest)
 546 {
 547   simcall_BODY_process_set_host(process, dest);
 548 }
 549
 550 void simcall_process_join(smx_process_t process, double timeout)
 551 {
 552   simcall_BODY_process_join(process, timeout);
 553 }
 554
 555 /**
 556  * \ingroup simix_process_management
 557  * \brief Suspends a process.
 558  *
 559  * This function suspends the process by suspending the synchro
 560  * it was waiting for completion.
 561  *
 562  * \param process a SIMIX process
 563  */
 564 void simcall_process_suspend(smx_process_t process)
 565 {
 566   xbt_assert(process, "Invalid parameters");
 567
 568   simcall_BODY_process_suspend(process);
 569 }
 570
 571 /**
 572  * \ingroup simix_process_management
 573  * \brief Resumes a suspended process.
 574  *
 575  * This function resumes a suspended process by resuming the synchro
 576  * it was waiting for completion.
 577  *
 578  * \param process a SIMIX process
 579  */
 580 void simcall_process_resume(smx_process_t process)
 581 {
 582   simcall_BODY_process_resume(process);
 583 }
 584
 585 /**
 586  * \ingroup simix_process_management
 587  * \brief Returns the amount of SIMIX processes in the system
 588  *
 589  * Maestro internal process is not counted, only user code processes are
 590  */
 591 int simcall_process_count(void)
 592 {
 593   return simcall_BODY_process_count();
 594 }
 595
 596 /**
 597  * \ingroup simix_process_management
 598  * \brief Return the PID of a #smx_process_t.
 599  * \param process a SIMIX process
 600  * \return the PID of this process
 601  */
 602 int simcall_process_get_PID(smx_process_t process)
 603 {
 604   if (process == SIMIX_process_self()) {
 605     /* avoid a simcall if this function is called by the process itself */
 606     return SIMIX_process_get_PID(process);
 607   }
 608
 609   return simcall_BODY_process_get_PID(process);
 610 }
 611
 612 /**
 613  * \ingroup simix_process_management
 614  * \brief Return the parent PID of a #smx_process_t.
 615  * \param process a SIMIX process
 616  * \return the PID of this process parenrt
 617  */
 618 int simcall_process_get_PPID(smx_process_t process)
 619 {
 620   if (process == SIMIX_process_self()) {
 621     /* avoid a simcall if this function is called by the process itself */
 622     return SIMIX_process_get_PPID(process);
 623   }
 624
 625   return simcall_BODY_process_get_PPID(process);
 626 }
 627
 628 /**
 629  * \ingroup simix_process_management
 630  * \brief Return the user data of a #smx_process_t.
 631  * \param process a SIMIX process
 632  * \return the user data of this process
 633  */
 634 void* simcall_process_get_data(smx_process_t process)
 635 {
 636   if (process == SIMIX_process_self()) {
 637     /* avoid a simcall if this function is called by the process itself */
 638     return SIMIX_process_get_data(process);
 639   }
 640
 641   return simcall_BODY_process_get_data(process);
 642 }
 643
 644 /**
 645  * \ingroup simix_process_management
 646  * \brief Set the user data of a #smx_process_t.
 647  *
 648  * This functions sets the user data associated to \a process.
 649  * \param process SIMIX process
 650  * \param data User data
 651  */
 652 void simcall_process_set_data(smx_process_t process, void *data)
 653 {
 654   if (process == SIMIX_process_self()) {
 655     /* avoid a simcall if this function is called by the process itself */
 656     SIMIX_process_self_set_data(process, data);
 657   }
 658   else {
 659     simcall_BODY_process_set_data(process, data);
 660   }
 661 }
 662
 663 static void kill_process(void* arg)
 664 {
 665   simix_global->kill_process_function((smx_process_t) arg);
 666 }
 667
 668 /**
 669  * \ingroup simix_process_management
 670  * \brief Set the kill time of a process.
 671  */
 672 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
 673 {
 674
 675   if (kill_time > SIMIX_get_clock()) {
 676     if (simix_global->kill_process_function) {
 677       XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
 678           sg_host_get_name(process->host));
 679       process->kill_timer = SIMIX_timer_set(kill_time, kill_process, process);
 680     }
 681   }
 682 }
 683 /**
 684  * \ingroup simix_process_management
 685  * \brief Get the kill time of a process (or 0 if unset).
 686  */
 687 double simcall_process_get_kill_time(smx_process_t process) {
 688         return SIMIX_timer_get_date(process->kill_timer);
 689 }
 690
 691 /**
 692  * \ingroup simix_process_management
 693  * \brief Return the location on which an agent is running.
 694  *
 695  * This functions returns the sg_host_t corresponding to the location on which
 696  * \a process is running.
 697  * \param process SIMIX process
 698  * \return SIMIX host
 699  */
 700 sg_host_t simcall_process_get_host(smx_process_t process)
 701 {
 702   return simcall_BODY_process_get_host(process);
 703 }
 704
 705 /**
 706  * \ingroup simix_process_management
 707  * \brief Return the name of an agent.
 708  *
 709  * This functions checks whether \a process is a valid pointer or not and return its name.
 710  * \param process SIMIX process
 711  * \return The process name
 712  */
 713 const char* simcall_process_get_name(smx_process_t process)
 714 {
 715   if (process == SIMIX_process_self()) {
 716     /* avoid a simcall if this function is called by the process itself */
 717     return process->name;
 718   }
 719   return simcall_BODY_process_get_name(process);
 720 }
 721
 722 /**
 723  * \ingroup simix_process_management
 724  * \brief Returns true if the process is suspended .
 725  *
 726  * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
 727  * \param process SIMIX process
 728  * \return 1, if the process is suspended, else 0.
 729  */
 730 int simcall_process_is_suspended(smx_process_t process)
 731 {
 732   return  simcall_BODY_process_is_suspended(process);
 733 }
 734
 735 /**
 736  * \ingroup simix_process_management
 737  * \brief Return the properties
 738  *
 739  * This functions returns the properties associated with this process
 740  */
 741 xbt_dict_t simcall_process_get_properties(smx_process_t process)
 742 {
 743   return simcall_BODY_process_get_properties(process);
 744 }
 745 /**
 746  * \ingroup simix_process_management
 747  * \brief Add an on_exit function
 748  * Add an on_exit function which will be executed when the process exits/is killed.
 749  */
 750 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data)
 751 {
 752   simcall_BODY_process_on_exit(process, fun, data);
 753 }
 754 /**
 755  * \ingroup simix_process_management
 756  * \brief Sets the process to be auto-restarted or not by SIMIX when its host comes back up.
 757  * Will restart the process when the host comes back up if auto_restart is set to 1.
 758  */
 759
 760 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart)
 761 {
 762   simcall_BODY_process_auto_restart_set(process, auto_restart);
 763 }
 764
 765 /**
 766  * \ingroup simix_process_management
 767  * \brief Restarts the process, killing it and starting it again from scratch.
 768  */
 769 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process)
 770 {
 771   return (smx_process_t) simcall_BODY_process_restart(process);
 772 }
 773 /**
 774  * \ingroup simix_process_management
 775  * \brief Creates a new sleep SIMIX synchro.
 776  *
 777  * This function creates a SURF action and allocates the data necessary
 778  * to create the SIMIX synchro. It can raise a host_error exception if the
 779  * host crashed. The default SIMIX name of the synchro is "sleep".
 780  *
 781  *   \param duration Time duration of the sleep.
 782  *   \return A result telling whether the sleep was successful
 783  */
 784 e_smx_state_t simcall_process_sleep(double duration)
 785 {
 786   /* checking for infinite values */
 787   xbt_assert(isfinite(duration), "duration is not finite!");
 788   return (e_smx_state_t) simcall_BODY_process_sleep(duration);
 789 }
 790
 791 /**
 792  *  \ingroup simix_rdv_management
 793  *  \brief Creates a new rendez-vous point
 794  *  \param name The name of the rendez-vous point
 795  *  \return The created rendez-vous point
 796  */
 797 smx_rdv_t simcall_rdv_create(const char *name)
 798 {
 799   return simcall_BODY_rdv_create(name);
 800 }
 801
 802
 803 /**
 804  *  \ingroup simix_rdv_management
 805  *  \brief Destroy a rendez-vous point
 806  *  \param rdv The rendez-vous point to destroy
 807  */
 808 void simcall_rdv_destroy(smx_rdv_t rdv)
 809 {
 810   simcall_BODY_rdv_destroy(rdv);
 811 }
 812 /**
 813  *  \ingroup simix_rdv_management
 814  *  \brief Returns a rendez-vous point knowing its name
 815  */
 816 smx_rdv_t simcall_rdv_get_by_name(const char *name)
 817 {
 818   xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
 819
 820   /* FIXME: this is a horrible loss of performance, so we hack it out by
 821    * skipping the simcall (for now). It works in parallel, it won't work on
 822    * distributed but probably we will change MSG for that. */
 823
 824   return SIMIX_rdv_get_by_name(name);
 825 }
 826
 827 /**
 828  *  \ingroup simix_rdv_management
 829  *  \brief Counts the number of communication synchros of a given host pending
 830  *         on a rendez-vous point.
 831  *  \param rdv The rendez-vous point
 832  *  \param host The host to be counted
 833  *  \return The number of comm synchros pending in the rdv
 834  */
 835 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, sg_host_t host)
 836 {
 837   return simcall_BODY_rdv_comm_count_by_host(rdv, host);
 838 }
 839
 840 /**
 841  *  \ingroup simix_rdv_management
 842  *  \brief returns the communication at the head of the rendez-vous
 843  *  \param rdv The rendez-vous point
 844  *  \return The communication or NULL if empty
 845  */
 846 smx_synchro_t simcall_rdv_get_head(smx_rdv_t rdv)
 847 {
 848   return simcall_BODY_rdv_get_head(rdv);
 849 }
 850
 851 void simcall_rdv_set_receiver(smx_rdv_t rdv, smx_process_t process)
 852 {
 853   simcall_BODY_rdv_set_receiver(rdv, process);
 854 }
 855
 856 smx_process_t simcall_rdv_get_receiver(smx_rdv_t rdv)
 857 {
 858   return simcall_BODY_rdv_get_receiver(rdv);
 859 }
 860
 861 /**
 862  * \ingroup simix_comm_management
 863  */
 864 void simcall_comm_send(smx_process_t sender, smx_rdv_t rdv, double task_size, double rate,
 865                          void *src_buff, size_t src_buff_size,
 866                          int (*match_fun)(void *, void *, smx_synchro_t),
 867                          void (*copy_data_fun)(smx_synchro_t, void*, size_t), void *data,
 868                          double timeout)
 869 {
 870   /* checking for infinite values */
 871   xbt_assert(isfinite(task_size), "task_size is not finite!");
 872   xbt_assert(isfinite(rate), "rate is not finite!");
 873   xbt_assert(isfinite(timeout), "timeout is not finite!");
 874
 875   xbt_assert(rdv, "No rendez-vous point defined for send");
 876
 877   if (MC_is_active() || MC_record_replay_is_active()) {
 878     /* the model-checker wants two separate simcalls */
 879     smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
 880     comm = simcall_comm_isend(sender, rdv, task_size, rate,
 881         src_buff, src_buff_size, match_fun, NULL, copy_data_fun, data, 0);
 882     simcall_comm_wait(comm, timeout);
 883     comm = NULL;
 884   }
 885   else {
 886     simcall_BODY_comm_send(sender, rdv, task_size, rate, src_buff, src_buff_size,
 887                          match_fun, copy_data_fun, data, timeout);
 888   }
 889 }
 890
 891 /**
 892  * \ingroup simix_comm_management
 893  */
 894 smx_synchro_t simcall_comm_isend(smx_process_t sender, smx_rdv_t rdv, double task_size, double rate,
 895                               void *src_buff, size_t src_buff_size,
 896                               int (*match_fun)(void *, void *, smx_synchro_t),
 897                               void (*clean_fun)(void *),
 898                               void (*copy_data_fun)(smx_synchro_t, void*, size_t),
 899                               void *data,
 900                               int detached)
 901 {
 902   /* checking for infinite values */
 903   xbt_assert(isfinite(task_size), "task_size is not finite!");
 904   xbt_assert(isfinite(rate), "rate is not finite!");
 905
 906   xbt_assert(rdv, "No rendez-vous point defined for isend");
 907
 908   return simcall_BODY_comm_isend(sender, rdv, task_size, rate, src_buff,
 909                                  src_buff_size, match_fun,
 910                                  clean_fun, copy_data_fun, data, detached);
 911 }
 912
 913 /**
 914  * \ingroup simix_comm_management
 915  */
 916 void simcall_comm_recv(smx_process_t receiver, smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
 917                        int (*match_fun)(void *, void *, smx_synchro_t),
 918                        void (*copy_data_fun)(smx_synchro_t, void*, size_t),
 919                        void *data, double timeout, double rate)
 920 {
 921   xbt_assert(isfinite(timeout), "timeout is not finite!");
 922   xbt_assert(rdv, "No rendez-vous point defined for recv");
 923
 924   if (MC_is_active() || MC_record_replay_is_active()) {
 925     /* the model-checker wants two separate simcalls */
 926     smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
 927     comm = simcall_comm_irecv(receiver, rdv, dst_buff, dst_buff_size,
 928                               match_fun, copy_data_fun, data, rate);
 929     simcall_comm_wait(comm, timeout);
 930     comm = NULL;
 931   }
 932   else {
 933     simcall_BODY_comm_recv(receiver, rdv, dst_buff, dst_buff_size,
 934                            match_fun, copy_data_fun, data, timeout, rate);
 935   }
 936 }
 937 /**
 938  * \ingroup simix_comm_management
 939  */
 940 smx_synchro_t simcall_comm_irecv(smx_process_t receiver, smx_rdv_t rdv, void *dst_buff, size_t *dst_buff_size,
 941                                 int (*match_fun)(void *, void *, smx_synchro_t),
 942                                 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
 943                                 void *data, double rate)
 944 {
 945   xbt_assert(rdv, "No rendez-vous point defined for irecv");
 946
 947   return simcall_BODY_comm_irecv(receiver, rdv, dst_buff, dst_buff_size,
 948                                  match_fun, copy_data_fun, data, rate);
 949 }
 950
 951 /**
 952  * \ingroup simix_comm_management
 953  */
 954 smx_synchro_t simcall_comm_iprobe(smx_rdv_t rdv, int type, int src, int tag,
 955                                 int (*match_fun)(void *, void *, smx_synchro_t), void *data)
 956 {
 957   xbt_assert(rdv, "No rendez-vous point defined for iprobe");
 958
 959   return simcall_BODY_comm_iprobe(rdv, type, src, tag, match_fun, data);
 960 }
 961
 962 /**
 963  * \ingroup simix_comm_management
 964  */
 965 void simcall_comm_cancel(smx_synchro_t comm)
 966 {
 967   simcall_BODY_comm_cancel(comm);
 968 }
 969
 970 /**
 971  * \ingroup simix_comm_management
 972  */
 973 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
 974 {
 975   return simcall_BODY_comm_waitany(comms);
 976 }
 977
 978 /**
 979  * \ingroup simix_comm_management
 980  */
 981 int simcall_comm_testany(xbt_dynar_t comms)
 982 {
 983   if (xbt_dynar_is_empty(comms))
 984     return -1;
 985   return simcall_BODY_comm_testany(comms);
 986 }
 987
 988 /**
 989  * \ingroup simix_comm_management
 990  */
 991 void simcall_comm_wait(smx_synchro_t comm, double timeout)
 992 {
 993   xbt_assert(isfinite(timeout), "timeout is not finite!");
 994   simcall_BODY_comm_wait(comm, timeout);
 995 }
 996
 997 /**
 998  * \brief Set the category of an synchro.
 999  *
1000  * This functions changes the category only. It calls a surf function.
1001  * \param execution The execution synchro
1002  * \param category The tracing category
1003  */
1004 void simcall_set_category(smx_synchro_t synchro, const char *category)
1005 {
1006   if (category == NULL) {
1007     return;
1008   }
1009   simcall_BODY_set_category(synchro, category);
1010 }
1011
1012 /**
1013  * \ingroup simix_comm_management
1014  *
1015  */
1016 int simcall_comm_test(smx_synchro_t comm)
1017 {
1018   return simcall_BODY_comm_test(comm);
1019 }
1020
1021 /**
1022  * \ingroup simix_comm_management
1023  *
1024  */
1025 double simcall_comm_get_remains(smx_synchro_t comm)
1026 {
1027   return simcall_BODY_comm_get_remains(comm);
1028 }
1029
1030 /**
1031  * \ingroup simix_comm_management
1032  *
1033  */
1034 e_smx_state_t simcall_comm_get_state(smx_synchro_t comm)
1035 {
1036   return simcall_BODY_comm_get_state(comm);
1037 }
1038
1039 /**
1040  * \ingroup simix_comm_management
1041  *
1042  */
1043 void *simcall_comm_get_src_data(smx_synchro_t comm)
1044 {
1045   return simcall_BODY_comm_get_src_data(comm);
1046 }
1047
1048 /**
1049  * \ingroup simix_comm_management
1050  *
1051  */
1052 void *simcall_comm_get_dst_data(smx_synchro_t comm)
1053 {
1054   return simcall_BODY_comm_get_dst_data(comm);
1055 }
1056
1057 /**
1058  * \ingroup simix_comm_management
1059  *
1060  */
1061 smx_process_t simcall_comm_get_src_proc(smx_synchro_t comm)
1062 {
1063   return simcall_BODY_comm_get_src_proc(comm);
1064 }
1065
1066 /**
1067  * \ingroup simix_comm_management
1068  *
1069  */
1070 smx_process_t simcall_comm_get_dst_proc(smx_synchro_t comm)
1071 {
1072   return simcall_BODY_comm_get_dst_proc(comm);
1073 }
1074
1075 #ifdef HAVE_LATENCY_BOUND_TRACKING
1076 int simcall_comm_is_latency_bounded(smx_synchro_t comm)
1077 {
1078   return simcall_BODY_comm_is_latency_bounded(comm);
1079 }
1080 #endif
1081
1082 /**
1083  * \ingroup simix_synchro_management
1084  *
1085  */
1086 smx_mutex_t simcall_mutex_init(void)
1087 {
1088   if(!simix_global) {
1089     fprintf(stderr,"You must run MSG_init before using MSG\n"); // We can't use xbt_die since we may get there before the initialization
1090     xbt_abort();
1091   }
1092   return simcall_BODY_mutex_init();
1093 }
1094
1095 /**
1096  * \ingroup simix_synchro_management
1097  *
1098  */
1099 void simcall_mutex_destroy(smx_mutex_t mutex)
1100 {
1101   simcall_BODY_mutex_destroy(mutex);
1102 }
1103
1104 /**
1105  * \ingroup simix_synchro_management
1106  *
1107  */
1108 void simcall_mutex_lock(smx_mutex_t mutex)
1109 {
1110   simcall_BODY_mutex_lock(mutex);
1111 }
1112
1113 /**
1114  * \ingroup simix_synchro_management
1115  *
1116  */
1117 int simcall_mutex_trylock(smx_mutex_t mutex)
1118 {
1119   return simcall_BODY_mutex_trylock(mutex);
1120 }
1121
1122 /**
1123  * \ingroup simix_synchro_management
1124  *
1125  */
1126 void simcall_mutex_unlock(smx_mutex_t mutex)
1127 {
1128   simcall_BODY_mutex_unlock(mutex);
1129 }
1130
1131 /**
1132  * \ingroup simix_synchro_management
1133  *
1134  */
1135 smx_cond_t simcall_cond_init(void)
1136 {
1137   return simcall_BODY_cond_init();
1138 }
1139
1140 /**
1141  * \ingroup simix_synchro_management
1142  *
1143  */
1144 void simcall_cond_destroy(smx_cond_t cond)
1145 {
1146   simcall_BODY_cond_destroy(cond);
1147 }
1148
1149 /**
1150  * \ingroup simix_synchro_management
1151  *
1152  */
1153 void simcall_cond_signal(smx_cond_t cond)
1154 {
1155   simcall_BODY_cond_signal(cond);
1156 }
1157
1158 /**
1159  * \ingroup simix_synchro_management
1160  *
1161  */
1162 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1163 {
1164   simcall_BODY_cond_wait(cond, mutex);
1165 }
1166
1167 /**
1168  * \ingroup simix_synchro_management
1169  *
1170  */
1171 void simcall_cond_wait_timeout(smx_cond_t cond,
1172                                  smx_mutex_t mutex,
1173                                  double timeout)
1174 {
1175   xbt_assert(isfinite(timeout), "timeout is not finite!");
1176   simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
1177 }
1178
1179 /**
1180  * \ingroup simix_synchro_management
1181  *
1182  */
1183 void simcall_cond_broadcast(smx_cond_t cond)
1184 {
1185   simcall_BODY_cond_broadcast(cond);
1186 }
1187
1188 /**
1189  * \ingroup simix_synchro_management
1190  *
1191  */
1192 smx_sem_t simcall_sem_init(int capacity)
1193 {
1194   return simcall_BODY_sem_init(capacity);
1195 }
1196
1197 /**
1198  * \ingroup simix_synchro_management
1199  *
1200  */
1201 void simcall_sem_destroy(smx_sem_t sem)
1202 {
1203   simcall_BODY_sem_destroy(sem);
1204 }
1205
1206 /**
1207  * \ingroup simix_synchro_management
1208  *
1209  */
1210 void simcall_sem_release(smx_sem_t sem)
1211 {
1212   simcall_BODY_sem_release(sem);
1213 }
1214
1215 /**
1216  * \ingroup simix_synchro_management
1217  *
1218  */
1219 int simcall_sem_would_block(smx_sem_t sem)
1220 {
1221   return simcall_BODY_sem_would_block(sem);
1222 }
1223
1224 /**
1225  * \ingroup simix_synchro_management
1226  *
1227  */
1228 void simcall_sem_acquire(smx_sem_t sem)
1229 {
1230   simcall_BODY_sem_acquire(sem);
1231 }
1232
1233 /**
1234  * \ingroup simix_synchro_management
1235  *
1236  */
1237 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1238 {
1239   xbt_assert(isfinite(timeout), "timeout is not finite!");
1240   simcall_BODY_sem_acquire_timeout(sem, timeout);
1241 }
1242
1243 /**
1244  * \ingroup simix_synchro_management
1245  *
1246  */
1247 int simcall_sem_get_capacity(smx_sem_t sem)
1248 {
1249   return simcall_BODY_sem_get_capacity(sem);
1250 }
1251
1252 /**
1253  * \ingroup simix_file_management
1254  *
1255  */
1256 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host)
1257 {
1258   return simcall_BODY_file_read(fd, size, host);
1259 }
1260
1261 /**
1262  * \ingroup simix_file_management
1263  *
1264  */
1265 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host)
1266 {
1267   return simcall_BODY_file_write(fd, size, host);
1268 }
1269
1270 /**
1271  * \ingroup simix_file_management
1272  * \brief
1273  */
1274 smx_file_t simcall_file_open(const char* fullpath, sg_host_t host)
1275 {
1276   return simcall_BODY_file_open(fullpath, host);
1277 }
1278
1279 /**
1280  * \ingroup simix_file_management
1281  *
1282  */
1283 int simcall_file_close(smx_file_t fd, sg_host_t host)
1284 {
1285   return simcall_BODY_file_close(fd, host);
1286 }
1287
1288 /**
1289  * \ingroup simix_file_management
1290  *
1291  */
1292 int simcall_file_unlink(smx_file_t fd, sg_host_t host)
1293 {
1294   return simcall_BODY_file_unlink(fd, host);
1295 }
1296
1297 /**
1298  * \ingroup simix_file_management
1299  *
1300  */
1301 sg_size_t simcall_file_get_size(smx_file_t fd){
1302   return simcall_BODY_file_get_size(fd);
1303 }
1304
1305 /**
1306  * \ingroup simix_file_management
1307  *
1308  */
1309 sg_size_t simcall_file_tell(smx_file_t fd){
1310   return simcall_BODY_file_tell(fd);
1311 }
1312
1313 /**
1314  * \ingroup simix_file_management
1315  *
1316  */
1317 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
1318 {
1319   return simcall_BODY_file_get_info(fd);
1320 }
1321
1322 /**
1323  * \ingroup simix_file_management
1324  *
1325  */
1326 int simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin){
1327   return simcall_BODY_file_seek(fd, offset, origin);
1328 }
1329
1330 /**
1331  * \ingroup simix_file_management
1332  * \brief Move a file to another location on the *same mount point*.
1333  *
1334  */
1335 int simcall_file_move(smx_file_t fd, const char* fullpath)
1336 {
1337   return simcall_BODY_file_move(fd, fullpath);
1338 }
1339
1340 /**
1341  * \ingroup simix_storage_management
1342  * \brief Returns the free space size on a given storage element.
1343  * \param storage a storage
1344  * \return Return the free space size on a given storage element (as sg_size_t)
1345  */
1346 sg_size_t simcall_storage_get_free_size (smx_storage_t storage){
1347   return simcall_BODY_storage_get_free_size(storage);
1348 }
1349
1350 /**
1351  * \ingroup simix_storage_management
1352  * \brief Returns the used space size on a given storage element.
1353  * \param storage a storage
1354  * \return Return the used space size on a given storage element (as sg_size_t)
1355  */
1356 sg_size_t simcall_storage_get_used_size (smx_storage_t storage){
1357   return simcall_BODY_storage_get_used_size(storage);
1358 }
1359
1360 /**
1361  * \ingroup simix_storage_management
1362  * \brief Returns the list of storages mounted on an host.
1363  * \param host A SIMIX host
1364  * \return a dict containing all storages mounted on the host
1365  */
1366 xbt_dict_t simcall_host_get_mounted_storage_list(sg_host_t host)
1367 {
1368   return simcall_BODY_host_get_mounted_storage_list(host);
1369 }
1370
1371 /**
1372  * \ingroup simix_storage_management
1373  * \brief Returns the list of storages attached to an host.
1374  * \param host A SIMIX host
1375  * \return a dict containing all storages attached to the host
1376  */
1377 xbt_dynar_t simcall_host_get_attached_storage_list(sg_host_t host)
1378 {
1379   return simcall_BODY_host_get_attached_storage_list(host);
1380 }
1381
1382 /**
1383  * \ingroup simix_storage_management
1384  * \brief Returns a dict of the properties assigned to a storage element.
1385  *
1386  * \param storage A storage element
1387  * \return The properties of this storage element
1388  */
1389 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
1390 {
1391   return simcall_BODY_storage_get_properties(storage);
1392 }
1393
1394 /**
1395  * \ingroup simix_storage_management
1396  * \brief Returns a dict containing the content of a storage element.
1397  *
1398  * \param storage A storage element
1399  * \return The content of this storage element as a dict (full path file => size)
1400  */
1401 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
1402 {
1403   return simcall_BODY_storage_get_content(storage);
1404 }
1405
1406 void simcall_run_kernel(std::function<void()> const& code)
1407 {
1408   return simcall_BODY_run_kernel((void*) &code);
1409 }
1410
1411 #ifdef HAVE_MC
1412
1413 void *simcall_mc_snapshot(void) {
1414   return simcall_BODY_mc_snapshot();
1415 }
1416
1417 int simcall_mc_compare_snapshots(void *s1, void *s2) {
1418   return simcall_BODY_mc_compare_snapshots((simgrid::mc::Snapshot*)s1, (simgrid::mc::Snapshot*)s2);
1419 }
1420
1421 #endif /* HAVE_MC */
1422
1423 int simcall_mc_random(int min, int max) {
1424   return simcall_BODY_mc_random(min, max);
1425 }
1426
1427 /* ************************************************************************** */
1428
1429 /** @brief returns a printable string representing a simcall */
1430 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1431   return simcall_names[kind];
1432 }