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