src/simix/libsmx.cpp

   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 <cmath>         /* std::isfinite() */
  15
  16 #include <functional>
  17
  18 #include "src/mc/mc_replay.h"
  19 #include "smx_private.h"
  20 #include "src/mc/mc_forward.hpp"
  21 #include "xbt/ex.h"
  22 #include "mc/mc.h"
  23 #include "src/simix/smx_host_private.h"
  24 #include "src/simix/smx_private.hpp"
  25
  26 #include <simgrid/simix.hpp>
  27
  28 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
  29
  30 #include "popping_bodies.cpp"
  31
  32 void simcall_call(smx_process_t process)
  33 {
  34   if (process != simix_global->maestro_process) {
  35     XBT_DEBUG("Yield process '%s' on simcall %s (%d)", process->name,
  36               SIMIX_simcall_name(process->simcall.call), (int)process->simcall.call);
  37     SIMIX_process_yield(process);
  38   } else {
  39     SIMIX_simcall_handle(&process->simcall, 0);
  40   }
  41 }
  42
  43 // ***** Host simcalls
  44 // Those functions are replaced by methods on the Host object.
  45
  46 /** \ingroup simix_host_management
  47  * \deprecated */
  48 xbt_swag_t simcall_host_get_process_list(sg_host_t host)
  49 {
  50   return host->processes();
  51 }
  52
  53 /** \ingroup simix_host_management
  54  * \deprecated */
  55 double simcall_host_get_current_power_peak(sg_host_t host)
  56 {
  57   return host->currentPowerPeak();
  58 }
  59
  60 /** \ingroup simix_host_management
  61  * \deprecated */
  62 double simcall_host_get_power_peak_at(sg_host_t host, int pstate_index)
  63 {
  64   return host->powerPeakAt(pstate_index);
  65 }
  66
  67 /** \deprecated */
  68 void simcall_host_get_params(sg_host_t vm, vm_params_t params)
  69 {
  70   vm->parameters(params);
  71 }
  72
  73 /** \deprecated */
  74 void simcall_host_set_params(sg_host_t vm, vm_params_t params)
  75 {
  76   vm->setParameters(params);
  77 }
  78
  79 /** \ingroup simix_storage_management
  80  *  \deprecated */
  81 xbt_dict_t simcall_host_get_mounted_storage_list(sg_host_t host)
  82 {
  83   return host->mountedStoragesAsDict();
  84 }
  85
  86 /** \ingroup simix_storage_management
  87  *  \deprecated */
  88 xbt_dynar_t simcall_host_get_attached_storage_list(sg_host_t host)
  89 {
  90   return host->attachedStorages();
  91 }
  92
  93 // ***** Other simcalls
  94
  95 /**
  96  * \ingroup simix_host_management
  97  * \brief Returns a dict of the properties assigned to a router or AS.
  98  *
  99  * \param name The name of the router or AS
 100  * \return The properties
 101  */
 102 xbt_dict_t simcall_asr_get_properties(const char *name)
 103 {
 104   return simcall_BODY_asr_get_properties(name);
 105 }
 106
 107 /**
 108  * \ingroup simix_process_management
 109  * \brief Creates a synchro that executes some computation of an host.
 110  *
 111  * This function creates a SURF action and allocates the data necessary
 112  * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
 113  *
 114  * \param name Name of the execution synchro to create
 115  * \param flops_amount amount Computation amount (in flops)
 116  * \param priority computation priority
 117  * \param bound
 118  * \param affinity_mask
 119  * \return A new SIMIX execution synchronization
 120  */
 121 smx_synchro_t simcall_execution_start(const char *name,
 122                                     double flops_amount,
 123                                     double priority, double bound, unsigned long affinity_mask)
 124 {
 125   /* checking for infinite values */
 126   xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
 127   xbt_assert(std::isfinite(priority), "priority is not finite!");
 128
 129   return simcall_BODY_execution_start(name, flops_amount, priority, bound, affinity_mask);
 130 }
 131
 132 /**
 133  * \ingroup simix_process_management
 134  * \brief Creates a synchro that may involve parallel computation on
 135  * several hosts and communication between them.
 136  *
 137  * \param name Name of the execution synchro to create
 138  * \param host_nb Number of hosts where the synchro will be executed
 139  * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
 140  * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
 141  * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
 142  * amount between each pair of hosts
 143  * \param amount the SURF action amount
 144  * \param rate the SURF action rate
 145  * \return A new SIMIX execution synchronization
 146  */
 147 smx_synchro_t simcall_execution_parallel_start(const char *name,
 148                                          int host_nb,
 149                                          sg_host_t *host_list,
 150                                          double *flops_amount,
 151                                          double *bytes_amount,
 152                                          double amount,
 153                                          double rate)
 154 {
 155   int i,j;
 156   /* checking for infinite values */
 157   for (i = 0 ; i < host_nb ; ++i) {
 158     xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
 159     if (bytes_amount != NULL) {
 160       for (j = 0 ; j < host_nb ; ++j) {
 161         xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
 162                    "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
 163       }
 164     }
 165   }
 166
 167   xbt_assert(std::isfinite(amount), "amount is not finite!");
 168   xbt_assert(std::isfinite(rate), "rate is not finite!");
 169
 170   return simcall_BODY_execution_parallel_start(name, host_nb, host_list,
 171                                             flops_amount,
 172                                             bytes_amount,
 173                                             amount, rate);
 174
 175 }
 176
 177 /**
 178  * \ingroup simix_process_management
 179  * \brief Destroys an execution synchro.
 180  *
 181  * Destroys a synchro, freeing its memory. This function cannot be called if there are a conditional waiting for it.
 182  * \param execution The execution synchro to destroy
 183  */
 184 void simcall_execution_destroy(smx_synchro_t execution)
 185 {
 186   simcall_BODY_execution_destroy(execution);
 187 }
 188
 189 /**
 190  * \ingroup simix_process_management
 191  * \brief Cancels an execution synchro.
 192  *
 193  * This functions stops the execution. It calls a surf function.
 194  * \param execution The execution synchro to cancel
 195  */
 196 void simcall_execution_cancel(smx_synchro_t execution)
 197 {
 198   simcall_BODY_execution_cancel(execution);
 199 }
 200
 201 /**
 202  * \ingroup simix_process_management
 203  * \brief Returns how much of an execution synchro remains to be done.
 204  *
 205  * \param execution The execution synchro
 206  * \return The remaining amount
 207  */
 208 double simcall_execution_get_remains(smx_synchro_t execution)
 209 {
 210   return simcall_BODY_execution_get_remains(execution);
 211 }
 212
 213 /**
 214  * \ingroup simix_process_management
 215  * \brief Returns the state of an execution synchro.
 216  *
 217  * \param execution The execution synchro
 218  * \return The state
 219  */
 220 e_smx_state_t simcall_execution_get_state(smx_synchro_t execution)
 221 {
 222   return simcall_BODY_execution_get_state(execution);
 223 }
 224
 225 /**
 226  * \ingroup simix_process_management
 227  * \brief Changes the priority of an execution synchro.
 228  *
 229  * This functions changes the priority only. It calls a surf function.
 230  * \param execution The execution synchro
 231  * \param priority The new priority
 232  */
 233 void simcall_execution_set_priority(smx_synchro_t execution, double priority)
 234 {
 235   /* checking for infinite values */
 236   xbt_assert(std::isfinite(priority), "priority is not finite!");
 237
 238   simcall_BODY_execution_set_priority(execution, priority);
 239 }
 240
 241 /**
 242  * \ingroup simix_process_management
 243  * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
 244  *
 245  * This functions changes the capping only. It calls a surf function.
 246  * \param execution The execution synchro
 247  * \param bound The new bound
 248  */
 249 void simcall_execution_set_bound(smx_synchro_t execution, double bound)
 250 {
 251   simcall_BODY_execution_set_bound(execution, bound);
 252 }
 253
 254 /**
 255  * \ingroup simix_process_management
 256  * \brief Changes the CPU affinity of an execution synchro.
 257  *
 258  * This functions changes the CPU affinity of an execution synchro. See taskset(1) on Linux.
 259  * \param execution The execution synchro
 260  * \param host Host
 261  * \param mask Affinity mask
 262  */
 263 void simcall_execution_set_affinity(smx_synchro_t execution, sg_host_t host, unsigned long mask)
 264 {
 265   simcall_BODY_execution_set_affinity(execution, host, mask);
 266 }
 267
 268 /**
 269  * \ingroup simix_host_management
 270  * \brief Waits for the completion of an execution synchro and destroy it.
 271  *
 272  * \param execution The execution synchro
 273  */
 274 e_smx_state_t simcall_execution_wait(smx_synchro_t execution)
 275 {
 276   return (e_smx_state_t) simcall_BODY_execution_wait(execution);
 277 }
 278
 279
 280 /**
 281  * \ingroup simix_vm_management
 282  * \brief Create a VM on the given physical host.
 283  *
 284  * \param name VM name
 285  * \param host Physical host
 286  *
 287  * \return The host object of the VM
 288  */
 289 void* simcall_vm_create(const char *name, sg_host_t phys_host)
 290 {
 291   return simgrid::simix::kernel(std::bind(SIMIX_vm_create, name, phys_host));
 292 }
 293
 294 /**
 295  * \ingroup simix_vm_management
 296  * \brief Start the given VM to the given physical host
 297  *
 298  * \param vm VM
 299  */
 300 void simcall_vm_start(sg_host_t vm)
 301 {
 302   return simgrid::simix::kernel(std::bind(SIMIX_vm_start, vm));
 303 }
 304
 305 /**
 306  * \ingroup simix_vm_management
 307  * \brief Get the state of the given VM
 308  *
 309  * \param vm VM
 310  * \return The state of the VM
 311  */
 312 int simcall_vm_get_state(sg_host_t vm)
 313 {
 314   return simgrid::simix::kernel(std::bind(SIMIX_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(sg_host_t vm)
 325 {
 326   return simgrid::simix::kernel(std::bind(SIMIX_vm_get_pm, vm));
 327 }
 328
 329 void simcall_vm_set_bound(sg_host_t vm, double bound)
 330 {
 331   simgrid::simix::kernel(std::bind(SIMIX_vm_set_bound, vm, bound));
 332 }
 333
 334 void simcall_vm_set_affinity(sg_host_t vm, sg_host_t pm, unsigned long mask)
 335 {
 336   simgrid::simix::kernel(std::bind(SIMIX_vm_set_affinity, vm, pm, mask));
 337 }
 338
 339 /**
 340  * \ingroup simix_vm_management
 341  * \brief Migrate the given VM to the given physical host
 342  *
 343  * \param vm VM
 344  * \param host Destination physical host
 345  */
 346 void simcall_vm_migrate(sg_host_t vm, sg_host_t host)
 347 {
 348   return simgrid::simix::kernel(std::bind(SIMIX_vm_migrate, vm, host));
 349 }
 350
 351 /**
 352  * \ingroup simix_vm_management
 353  * \brief Suspend the given VM
 354  *
 355  * \param vm VM
 356  */
 357 void simcall_vm_suspend(sg_host_t vm)
 358 {
 359   simcall_BODY_vm_suspend(vm);
 360 }
 361
 362 /**
 363  * \ingroup simix_vm_management
 364  * \brief Resume the given VM
 365  *
 366  * \param vm VM
 367  */
 368 void simcall_vm_resume(sg_host_t vm)
 369 {
 370   simcall_BODY_vm_resume(vm);
 371 }
 372
 373 /**
 374  * \ingroup simix_vm_management
 375  * \brief Save the given VM
 376  *
 377  * \param vm VM
 378  */
 379 void simcall_vm_save(sg_host_t vm)
 380 {
 381   simcall_BODY_vm_save(vm);
 382 }
 383
 384 /**
 385  * \ingroup simix_vm_management
 386  * \brief Restore the given VM
 387  *
 388  * \param vm VM
 389  */
 390 void simcall_vm_restore(sg_host_t vm)
 391 {
 392   simcall_BODY_vm_restore(vm);
 393 }
 394
 395 /**
 396  * \ingroup simix_vm_management
 397  * \brief Shutdown the given VM
 398  *
 399  * \param vm VM
 400  */
 401 void simcall_vm_shutdown(sg_host_t vm)
 402 {
 403   simcall_BODY_vm_shutdown(vm);
 404 }
 405
 406 /**
 407  * \ingroup simix_vm_management
 408  * \brief Destroy the given VM
 409  *
 410  * \param vm VM
 411  */
 412 void simcall_vm_destroy(sg_host_t vm)
 413 {
 414   simgrid::simix::kernel(std::bind(SIMIX_vm_destroy, vm));
 415 }
 416
 417 /**
 418  * \ingroup simix_vm_management
 419  * \brief Encompassing simcall to prevent the removal of the src or the dst node at the end of a VM migration
 420  *  The simcall actually invokes the following calls:
 421  *     simcall_vm_set_affinity(vm, src_pm, 0);
 422  *     simcall_vm_migrate(vm, dst_pm);
 423  *     simcall_vm_resume(vm);
 424  *
 425  * It is called at the end of the migration_rx_fun function from msg/msg_vm.c
 426  *
 427  * \param vm VM to migrate
 428  * \param src_pm  Source physical host
 429  * \param dst_pmt Destination physical host
 430  */
 431 void simcall_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm)
 432 {
 433   simgrid::simix::kernel(std::bind(
 434     SIMIX_vm_migratefrom_resumeto, vm, src_pm, dst_pm));
 435 }
 436
 437 /**
 438  * \ingroup simix_process_management
 439  * \brief Creates and runs a new SIMIX process.
 440  *
 441  * The structure and the corresponding thread are created and put in the list of ready processes.
 442  *
 443  * \param name a name for the process. It is for user-level information and can be NULL.
 444  * \param code the main function of the process
 445  * \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.
 446  * It can be retrieved with the function \ref simcall_process_get_data.
 447  * \param hostname name of the host where the new agent is executed.
 448  * \param kill_time time when the process is killed
 449  * \param argc first argument passed to \a code
 450  * \param argv second argument passed to \a code
 451  * \param properties the properties of the process
 452  * \param auto_restart either it is autorestarting or not.
 453  */
 454 smx_process_t simcall_process_create(const char *name,
 455                               xbt_main_func_t code,
 456                               void *data,
 457                               const char *hostname,
 458                               double kill_time,
 459                               int argc, char **argv,
 460                               xbt_dict_t properties,
 461                               int auto_restart)
 462 {
 463   return (smx_process_t) simcall_BODY_process_create(name, code, data, hostname,
 464                               kill_time, argc, argv, properties,
 465                               auto_restart);
 466 }
 467
 468 /**
 469  * \ingroup simix_process_management
 470  * \brief Kills a SIMIX process.
 471  *
 472  * This function simply kills a  process.
 473  *
 474  * \param process poor victim
 475  */
 476 void simcall_process_kill(smx_process_t process)
 477 {
 478   simcall_BODY_process_kill(process);
 479 }
 480
 481 /**
 482  * \ingroup simix_process_management
 483  * \brief Kills all SIMIX processes.
 484  */
 485 void simcall_process_killall(int reset_pid)
 486 {
 487   simcall_BODY_process_killall(reset_pid);
 488 }
 489
 490 /**
 491  * \ingroup simix_process_management
 492  * \brief Cleans up a SIMIX process.
 493  * \param process poor victim (must have already been killed)
 494  */
 495 void simcall_process_cleanup(smx_process_t process)
 496 {
 497   simcall_BODY_process_cleanup(process);
 498 }
 499
 500 /**
 501  * \ingroup simix_process_management
 502  * \brief Migrates an agent to another location.
 503  *
 504  * This function changes the value of the host on which \a process is running.
 505  *
 506  * \param process the process to migrate
 507  * \param dest name of the new host
 508  */
 509 void simcall_process_set_host(smx_process_t process, sg_host_t dest)
 510 {
 511   simcall_BODY_process_set_host(process, dest);
 512 }
 513
 514 void simcall_process_join(smx_process_t process, double timeout)
 515 {
 516   simcall_BODY_process_join(process, timeout);
 517 }
 518
 519 /**
 520  * \ingroup simix_process_management
 521  * \brief Suspends a process.
 522  *
 523  * This function suspends the process by suspending the synchro
 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 synchro
 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 simgrid::simix::kernel(SIMIX_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   return SIMIX_process_get_PID(process);
 569 }
 570
 571 /**
 572  * \ingroup simix_process_management
 573  * \brief Return the parent PID of a #smx_process_t.
 574  * \param process a SIMIX process
 575  * \return the PID of this process parenrt
 576  */
 577 int simcall_process_get_PPID(smx_process_t process)
 578 {
 579   return SIMIX_process_get_PPID(process);
 580 }
 581
 582 /**
 583  * \ingroup simix_process_management
 584  * \brief Return the user data of a #smx_process_t.
 585  * \param process a SIMIX process
 586  * \return the user data of this process
 587  */
 588 void* simcall_process_get_data(smx_process_t process)
 589 {
 590   return SIMIX_process_get_data(process);
 591 }
 592
 593 /**
 594  * \ingroup simix_process_management
 595  * \brief Set the user data of a #smx_process_t.
 596  *
 597  * This functions sets the user data associated to \a process.
 598  * \param process SIMIX process
 599  * \param data User data
 600  */
 601 void simcall_process_set_data(smx_process_t process, void *data)
 602 {
 603   simgrid::simix::kernel(std::bind(SIMIX_process_set_data, process, data));
 604 }
 605
 606 static void kill_process_from_timer(void* arg)
 607 {
 608   smx_process_t process = (smx_process_t) arg;
 609   simix_global->kill_process_function(process);
 610   process->kill_timer=NULL;
 611 }
 612
 613 /**
 614  * \ingroup simix_process_management
 615  * \brief Set the kill time of a process.
 616  */
 617 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
 618 {
 619
 620   if (kill_time > SIMIX_get_clock()) {
 621     if (simix_global->kill_process_function) {
 622       XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
 623           sg_host_get_name(process->host));
 624       process->kill_timer = SIMIX_timer_set(kill_time, kill_process_from_timer, process);
 625     }
 626   }
 627 }
 628 /**
 629  * \ingroup simix_process_management
 630  * \brief Get the kill time of a process (or 0 if unset).
 631  */
 632 double simcall_process_get_kill_time(smx_process_t process) {
 633   return SIMIX_timer_get_date(process->kill_timer);
 634 }
 635
 636 /**
 637  * \ingroup simix_process_management
 638  * \brief Return the location on which an agent is running.
 639  *
 640  * This functions returns the sg_host_t corresponding to the location on which
 641  * \a process is running.
 642  * \param process SIMIX process
 643  * \return SIMIX host
 644  */
 645 sg_host_t simcall_process_get_host(smx_process_t process)
 646 {
 647   return SIMIX_process_get_host(process);
 648 }
 649
 650 /**
 651  * \ingroup simix_process_management
 652  * \brief Return the name of an agent.
 653  *
 654  * This functions checks whether \a process is a valid pointer or not and return its name.
 655  * \param process SIMIX process
 656  * \return The process name
 657  */
 658 const char* simcall_process_get_name(smx_process_t process)
 659 {
 660   return SIMIX_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 SIMIX_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_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 (smx_process_t) simcall_BODY_process_restart(process);
 713 }
 714 /**
 715  * \ingroup simix_process_management
 716  * \brief Creates a new sleep SIMIX synchro.
 717  *
 718  * This function creates a SURF action and allocates the data necessary
 719  * to create the SIMIX synchro. It can raise a host_error exception if the
 720  * host crashed. The default SIMIX name of the synchro 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(std::isfinite(duration), "duration is not finite!");
 729   return (e_smx_state_t) simcall_BODY_process_sleep(duration);
 730 }
 731
 732 /**
 733  *  \ingroup simix_mbox_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_mailbox_t simcall_mbox_create(const char *name)
 739 {
 740   return simcall_BODY_mbox_create(name);
 741 }
 742
 743 /**
 744  *  \ingroup simix_mbox_management
 745  *  \brief Returns a rendez-vous point knowing its name
 746  */
 747 smx_mailbox_t simcall_mbox_get_by_name(const char *name)
 748 {
 749   /* FIXME: this is a horrible loss of performance, so we hack it out by
 750    * skipping the simcall (for now). It works in parallel, it won't work on
 751    * distributed but probably we will change MSG for that. */
 752
 753   return SIMIX_mbox_get_by_name(name);
 754 }
 755
 756 /**
 757  *  \ingroup simix_mbox_management
 758  *  \brief returns the communication at the head of the rendez-vous
 759  *  \param mbox The rendez-vous point
 760  *  \return The communication or NULL if empty
 761  */
 762 smx_synchro_t simcall_mbox_get_head(smx_mailbox_t mbox)
 763 {
 764   return simcall_BODY_mbox_get_head(mbox);
 765 }
 766
 767 void simcall_mbox_set_receiver(smx_mailbox_t mbox, smx_process_t process)
 768 {
 769   simcall_BODY_mbox_set_receiver(mbox, process);
 770 }
 771
 772 smx_process_t simcall_mbox_get_receiver(smx_mailbox_t mbox)
 773 {
 774   return simcall_BODY_mbox_get_receiver(mbox);
 775 }
 776
 777 /**
 778  * \ingroup simix_comm_management
 779  */
 780 void simcall_comm_send(smx_process_t sender, smx_mailbox_t mbox, double task_size, double rate,
 781                          void *src_buff, size_t src_buff_size,
 782                          int (*match_fun)(void *, void *, smx_synchro_t),
 783                          void (*copy_data_fun)(smx_synchro_t, void*, size_t), void *data,
 784                          double timeout)
 785 {
 786   /* checking for infinite values */
 787   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 788   xbt_assert(std::isfinite(rate), "rate is not finite!");
 789   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 790
 791   xbt_assert(mbox, "No rendez-vous point defined for send");
 792
 793   if (MC_is_active() || MC_record_replay_is_active()) {
 794     /* the model-checker wants two separate simcalls */
 795     smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
 796     comm = simcall_comm_isend(sender, mbox, task_size, rate,
 797         src_buff, src_buff_size, match_fun, NULL, copy_data_fun, data, 0);
 798     simcall_comm_wait(comm, timeout);
 799     comm = NULL;
 800   }
 801   else {
 802     simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
 803                          match_fun, copy_data_fun, data, timeout);
 804   }
 805 }
 806
 807 /**
 808  * \ingroup simix_comm_management
 809  */
 810 smx_synchro_t simcall_comm_isend(smx_process_t sender, smx_mailbox_t mbox, double task_size, double rate,
 811                               void *src_buff, size_t src_buff_size,
 812                               int (*match_fun)(void *, void *, smx_synchro_t),
 813                               void (*clean_fun)(void *),
 814                               void (*copy_data_fun)(smx_synchro_t, void*, size_t),
 815                               void *data,
 816                               int detached)
 817 {
 818   /* checking for infinite values */
 819   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 820   xbt_assert(std::isfinite(rate), "rate is not finite!");
 821
 822   xbt_assert(mbox, "No rendez-vous point defined for isend");
 823
 824   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
 825                                  src_buff_size, match_fun,
 826                                  clean_fun, copy_data_fun, data, detached);
 827 }
 828
 829 /**
 830  * \ingroup simix_comm_management
 831  */
 832 void simcall_comm_recv(smx_process_t receiver, smx_mailbox_t mbox, void *dst_buff, size_t * dst_buff_size,
 833                        int (*match_fun)(void *, void *, smx_synchro_t),
 834                        void (*copy_data_fun)(smx_synchro_t, void*, size_t),
 835                        void *data, double timeout, double rate)
 836 {
 837   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 838   xbt_assert(mbox, "No rendez-vous point defined for recv");
 839
 840   if (MC_is_active() || MC_record_replay_is_active()) {
 841     /* the model-checker wants two separate simcalls */
 842     smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simcall */
 843     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 844                               match_fun, copy_data_fun, data, rate);
 845     simcall_comm_wait(comm, timeout);
 846     comm = NULL;
 847   }
 848   else {
 849     simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
 850                            match_fun, copy_data_fun, data, timeout, rate);
 851   }
 852 }
 853 /**
 854  * \ingroup simix_comm_management
 855  */
 856 smx_synchro_t simcall_comm_irecv(smx_process_t receiver, smx_mailbox_t mbox, void *dst_buff, size_t *dst_buff_size,
 857                                 int (*match_fun)(void *, void *, smx_synchro_t),
 858                                 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
 859                                 void *data, double rate)
 860 {
 861   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 862
 863   return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 864                                  match_fun, copy_data_fun, data, rate);
 865 }
 866
 867 /**
 868  * \ingroup simix_comm_management
 869  */
 870 smx_synchro_t simcall_comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag,
 871                                 int (*match_fun)(void *, void *, smx_synchro_t), void *data)
 872 {
 873   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
 874
 875   return simcall_BODY_comm_iprobe(mbox, type, src, tag, match_fun, data);
 876 }
 877
 878 /**
 879  * \ingroup simix_comm_management
 880  */
 881 void simcall_comm_cancel(smx_synchro_t comm)
 882 {
 883   simcall_BODY_comm_cancel(comm);
 884 }
 885
 886 /**
 887  * \ingroup simix_comm_management
 888  */
 889 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
 890 {
 891   return simcall_BODY_comm_waitany(comms);
 892 }
 893
 894 /**
 895  * \ingroup simix_comm_management
 896  */
 897 int simcall_comm_testany(xbt_dynar_t comms)
 898 {
 899   if (xbt_dynar_is_empty(comms))
 900     return -1;
 901   return simcall_BODY_comm_testany(comms);
 902 }
 903
 904 /**
 905  * \ingroup simix_comm_management
 906  */
 907 void simcall_comm_wait(smx_synchro_t comm, double timeout)
 908 {
 909   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 910   simcall_BODY_comm_wait(comm, timeout);
 911 }
 912
 913 /**
 914  * \brief Set the category of an synchro.
 915  *
 916  * This functions changes the category only. It calls a surf function.
 917  * \param execution The execution synchro
 918  * \param category The tracing category
 919  */
 920 void simcall_set_category(smx_synchro_t synchro, const char *category)
 921 {
 922   if (category == NULL) {
 923     return;
 924   }
 925   simcall_BODY_set_category(synchro, category);
 926 }
 927
 928 /**
 929  * \ingroup simix_comm_management
 930  *
 931  */
 932 int simcall_comm_test(smx_synchro_t comm)
 933 {
 934   return simcall_BODY_comm_test(comm);
 935 }
 936
 937 /**
 938  * \ingroup simix_comm_management
 939  *
 940  */
 941 double simcall_comm_get_remains(smx_synchro_t comm)
 942 {
 943   return simcall_BODY_comm_get_remains(comm);
 944 }
 945
 946 /**
 947  * \ingroup simix_comm_management
 948  *
 949  */
 950 e_smx_state_t simcall_comm_get_state(smx_synchro_t comm)
 951 {
 952   return simcall_BODY_comm_get_state(comm);
 953 }
 954
 955 /**
 956  * \ingroup simix_comm_management
 957  *
 958  */
 959 void *simcall_comm_get_src_data(smx_synchro_t comm)
 960 {
 961   return simcall_BODY_comm_get_src_data(comm);
 962 }
 963
 964 /**
 965  * \ingroup simix_comm_management
 966  *
 967  */
 968 void *simcall_comm_get_dst_data(smx_synchro_t comm)
 969 {
 970   return simcall_BODY_comm_get_dst_data(comm);
 971 }
 972
 973 /**
 974  * \ingroup simix_comm_management
 975  *
 976  */
 977 smx_process_t simcall_comm_get_src_proc(smx_synchro_t comm)
 978 {
 979   return simcall_BODY_comm_get_src_proc(comm);
 980 }
 981
 982 /**
 983  * \ingroup simix_comm_management
 984  *
 985  */
 986 smx_process_t simcall_comm_get_dst_proc(smx_synchro_t comm)
 987 {
 988   return simcall_BODY_comm_get_dst_proc(comm);
 989 }
 990
 991 /**
 992  * \ingroup simix_synchro_management
 993  *
 994  */
 995 smx_mutex_t simcall_mutex_init(void)
 996 {
 997   if(!simix_global) {
 998     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
 999     xbt_abort();
1000   }
1001   return simcall_BODY_mutex_init();
1002 }
1003
1004 /**
1005  * \ingroup simix_synchro_management
1006  *
1007  */
1008 void simcall_mutex_lock(smx_mutex_t mutex)
1009 {
1010   simcall_BODY_mutex_lock(mutex);
1011 }
1012
1013 /**
1014  * \ingroup simix_synchro_management
1015  *
1016  */
1017 int simcall_mutex_trylock(smx_mutex_t mutex)
1018 {
1019   return simcall_BODY_mutex_trylock(mutex);
1020 }
1021
1022 /**
1023  * \ingroup simix_synchro_management
1024  *
1025  */
1026 void simcall_mutex_unlock(smx_mutex_t mutex)
1027 {
1028   simcall_BODY_mutex_unlock(mutex);
1029 }
1030
1031 /**
1032  * \ingroup simix_synchro_management
1033  *
1034  */
1035 smx_cond_t simcall_cond_init(void)
1036 {
1037   return simcall_BODY_cond_init();
1038 }
1039
1040 /**
1041  * \ingroup simix_synchro_management
1042  *
1043  */
1044 void simcall_cond_signal(smx_cond_t cond)
1045 {
1046   simcall_BODY_cond_signal(cond);
1047 }
1048
1049 /**
1050  * \ingroup simix_synchro_management
1051  *
1052  */
1053 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1054 {
1055   simcall_BODY_cond_wait(cond, mutex);
1056 }
1057
1058 /**
1059  * \ingroup simix_synchro_management
1060  *
1061  */
1062 void simcall_cond_wait_timeout(smx_cond_t cond,
1063                                  smx_mutex_t mutex,
1064                                  double timeout)
1065 {
1066   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
1067   simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
1068 }
1069
1070 /**
1071  * \ingroup simix_synchro_management
1072  *
1073  */
1074 void simcall_cond_broadcast(smx_cond_t cond)
1075 {
1076   simcall_BODY_cond_broadcast(cond);
1077 }
1078
1079 /**
1080  * \ingroup simix_synchro_management
1081  *
1082  */
1083 smx_sem_t simcall_sem_init(int capacity)
1084 {
1085   return simcall_BODY_sem_init(capacity);
1086 }
1087
1088 /**
1089  * \ingroup simix_synchro_management
1090  *
1091  */
1092 void simcall_sem_release(smx_sem_t sem)
1093 {
1094   simcall_BODY_sem_release(sem);
1095 }
1096
1097 /**
1098  * \ingroup simix_synchro_management
1099  *
1100  */
1101 int simcall_sem_would_block(smx_sem_t sem)
1102 {
1103   return simcall_BODY_sem_would_block(sem);
1104 }
1105
1106 /**
1107  * \ingroup simix_synchro_management
1108  *
1109  */
1110 void simcall_sem_acquire(smx_sem_t sem)
1111 {
1112   simcall_BODY_sem_acquire(sem);
1113 }
1114
1115 /**
1116  * \ingroup simix_synchro_management
1117  *
1118  */
1119 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1120 {
1121   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
1122   simcall_BODY_sem_acquire_timeout(sem, timeout);
1123 }
1124
1125 /**
1126  * \ingroup simix_synchro_management
1127  *
1128  */
1129 int simcall_sem_get_capacity(smx_sem_t sem)
1130 {
1131   return simcall_BODY_sem_get_capacity(sem);
1132 }
1133
1134 /**
1135  * \ingroup simix_file_management
1136  *
1137  */
1138 sg_size_t simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host)
1139 {
1140   return simcall_BODY_file_read(fd, size, host);
1141 }
1142
1143 /**
1144  * \ingroup simix_file_management
1145  *
1146  */
1147 sg_size_t simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host)
1148 {
1149   return simcall_BODY_file_write(fd, size, host);
1150 }
1151
1152 /**
1153  * \ingroup simix_file_management
1154  * \brief
1155  */
1156 smx_file_t simcall_file_open(const char* fullpath, sg_host_t host)
1157 {
1158   return simcall_BODY_file_open(fullpath, host);
1159 }
1160
1161 /**
1162  * \ingroup simix_file_management
1163  *
1164  */
1165 int simcall_file_close(smx_file_t fd, sg_host_t host)
1166 {
1167   return simcall_BODY_file_close(fd, host);
1168 }
1169
1170 /**
1171  * \ingroup simix_file_management
1172  *
1173  */
1174 int simcall_file_unlink(smx_file_t fd, sg_host_t host)
1175 {
1176   return simcall_BODY_file_unlink(fd, host);
1177 }
1178
1179 /**
1180  * \ingroup simix_file_management
1181  *
1182  */
1183 sg_size_t simcall_file_get_size(smx_file_t fd){
1184   return simcall_BODY_file_get_size(fd);
1185 }
1186
1187 /**
1188  * \ingroup simix_file_management
1189  *
1190  */
1191 sg_size_t simcall_file_tell(smx_file_t fd){
1192   return simcall_BODY_file_tell(fd);
1193 }
1194
1195 /**
1196  * \ingroup simix_file_management
1197  *
1198  */
1199 xbt_dynar_t simcall_file_get_info(smx_file_t fd)
1200 {
1201   return simcall_BODY_file_get_info(fd);
1202 }
1203
1204 /**
1205  * \ingroup simix_file_management
1206  *
1207  */
1208 int simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin){
1209   return simcall_BODY_file_seek(fd, offset, origin);
1210 }
1211
1212 /**
1213  * \ingroup simix_file_management
1214  * \brief Move a file to another location on the *same mount point*.
1215  *
1216  */
1217 int simcall_file_move(smx_file_t fd, const char* fullpath)
1218 {
1219   return simcall_BODY_file_move(fd, fullpath);
1220 }
1221
1222 /**
1223  * \ingroup simix_storage_management
1224  * \brief Returns the free space size on a given storage element.
1225  * \param storage a storage
1226  * \return Return the free space size on a given storage element (as sg_size_t)
1227  */
1228 sg_size_t simcall_storage_get_free_size (smx_storage_t storage){
1229   return simcall_BODY_storage_get_free_size(storage);
1230 }
1231
1232 /**
1233  * \ingroup simix_storage_management
1234  * \brief Returns the used space size on a given storage element.
1235  * \param storage a storage
1236  * \return Return the used space size on a given storage element (as sg_size_t)
1237  */
1238 sg_size_t simcall_storage_get_used_size (smx_storage_t storage){
1239   return simcall_BODY_storage_get_used_size(storage);
1240 }
1241
1242 /**
1243  * \ingroup simix_storage_management
1244  * \brief Returns a dict of the properties assigned to a storage element.
1245  *
1246  * \param storage A storage element
1247  * \return The properties of this storage element
1248  */
1249 xbt_dict_t simcall_storage_get_properties(smx_storage_t storage)
1250 {
1251   return simcall_BODY_storage_get_properties(storage);
1252 }
1253
1254 /**
1255  * \ingroup simix_storage_management
1256  * \brief Returns a dict containing the content of a storage element.
1257  *
1258  * \param storage A storage element
1259  * \return The content of this storage element as a dict (full path file => size)
1260  */
1261 xbt_dict_t simcall_storage_get_content(smx_storage_t storage)
1262 {
1263   return simcall_BODY_storage_get_content(storage);
1264 }
1265
1266 void simcall_run_kernel(std::function<void()> const& code)
1267 {
1268   return simcall_BODY_run_kernel((void*) &code);
1269 }
1270
1271 int simcall_mc_random(int min, int max) {
1272   return simcall_BODY_mc_random(min, max);
1273 }
1274
1275 /* ************************************************************************** */
1276
1277 /** @brief returns a printable string representing a simcall */
1278 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1279   return simcall_names[kind];
1280 }