src/simix/libsmx.c

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