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