src/simix/smx_user.c

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