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