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