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