src/simix/libsmx.c

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