src/simix/smx_user.c

   1 /* smx_user.c - public interface to simix                                   */
   2
   3 /* Copyright (c) 2010, 2011. 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 #ifndef _SVID_SOURCE
   8 #  define _SVID_SOURCE    /* strdup() */
   9 #endif
  10 #ifndef _ISOC99_SOURCE
  11 #  define _ISOC99_SOURCE  /* isfinite() */
  12 #endif
  13 #ifndef _ISO_C99_SOURCE
  14 #  define _ISO_C99_SOURCE /* isfinite() */
  15 #endif
  16 #include <math.h>         /* isfinite() */
  17
  18 #include "smx_private.h"
  19 #include "mc/mc.h"
  20 #include "xbt/ex.h"
  21
  22 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
  23
  24 static const char* simcall_names[] = {
  25 #undef SIMCALL_ENUM_ELEMENT
  26 #define SIMCALL_ENUM_ELEMENT(x) #x /* generate strings from the enumeration values */
  27 SIMCALL_LIST
  28 #undef SIMCALL_ENUM_ELEMENT
  29 };
  30
  31 /**
  32  * \brief Returns a host given its name.
  33  *
  34  * \param name The name of the host to get
  35  * \return The corresponding host
  36  */
  37 smx_host_t simcall_host_get_by_name(const char *name)
  38 {
  39   smx_simcall_t simcall = SIMIX_simcall_mine();
  40
  41   simcall->call = SIMCALL_HOST_GET_BY_NAME;
  42   simcall->host_get_by_name.name = name;
  43   SIMIX_simcall_push(simcall->issuer);
  44   return simcall->host_get_by_name.result;
  45 }
  46
  47 /**
  48  * \brief Returns the name of a host.
  49  *
  50  * \param host A SIMIX host
  51  * \return The name of this host
  52  */
  53 const char* simcall_host_get_name(smx_host_t host)
  54 {
  55   smx_simcall_t simcall = SIMIX_simcall_mine();
  56
  57   simcall->call = SIMCALL_HOST_GET_NAME;
  58   simcall->host_get_name.host = host;
  59   SIMIX_simcall_push(simcall->issuer);
  60   return simcall->host_get_name.result;
  61 }
  62
  63 /**
  64  * \brief Returns a dict of the properties assigned to a host.
  65  *
  66  * \param host A host
  67  * \return The properties of this host
  68  */
  69 xbt_dict_t simcall_host_get_properties(smx_host_t host)
  70 {
  71   smx_simcall_t simcall = SIMIX_simcall_mine();
  72
  73   simcall->call = SIMCALL_HOST_GET_PROPERTIES;
  74   simcall->host_get_properties.host = host;
  75   SIMIX_simcall_push(simcall->issuer);
  76   return simcall->host_get_properties.result;
  77 }
  78
  79 /**
  80  * \brief Returns the speed of the processor.
  81  *
  82  * The speed returned does not take into account the current load on the machine.
  83  * \param host A SIMIX host
  84  * \return The speed of this host (in Mflop/s)
  85  */
  86 double simcall_host_get_speed(smx_host_t host)
  87 {
  88   smx_simcall_t simcall = SIMIX_simcall_mine();
  89
  90   simcall->call = SIMCALL_HOST_GET_SPEED;
  91   simcall->host_get_speed.host = host;
  92   SIMIX_simcall_push(simcall->issuer);
  93   return simcall->host_get_speed.result;
  94 }
  95
  96 /**
  97  * \brief Returns the available speed of the processor.
  98  *
  99  * \return Speed currently available (in Mflop/s)
 100  */
 101 double simcall_host_get_available_speed(smx_host_t host)
 102 {
 103   smx_simcall_t simcall = SIMIX_simcall_mine();
 104
 105   simcall->call = SIMCALL_HOST_GET_AVAILABLE_SPEED;
 106   simcall->host_get_available_speed.host = host;
 107   SIMIX_simcall_push(simcall->issuer);
 108   return simcall->host_get_available_speed.result;
 109 }
 110
 111 /**
 112  * \brief Returns the state of a host.
 113  *
 114  * Two states are possible: 1 if the host is active or 0 if it has crashed.
 115  * \param host A SIMIX host
 116  * \return 1 if the host is available, 0 otherwise
 117  */
 118 int simcall_host_get_state(smx_host_t host)
 119 {
 120   smx_simcall_t simcall = SIMIX_simcall_mine();
 121
 122   simcall->call = SIMCALL_HOST_GET_STATE;
 123   simcall->host_get_state.host = host;
 124   SIMIX_simcall_push(simcall->issuer);
 125   return simcall->host_get_state.result;
 126 }
 127
 128 /**
 129  * \brief Returns the user data associated to a host.
 130  *
 131  * \param host SIMIX host
 132  * \return the user data of this host
 133  */
 134 void* simcall_host_get_data(smx_host_t host)
 135 {
 136   smx_simcall_t simcall = SIMIX_simcall_mine();
 137
 138   simcall->call = SIMCALL_HOST_GET_DATA;
 139   simcall->host_get_data.host = host;
 140   SIMIX_simcall_push(simcall->issuer);
 141   return simcall->host_get_data.result;
 142 }
 143
 144 /**
 145  * \brief Sets the user data associated to a host.
 146  *
 147  * The host must not have previous user data associated to it.
 148  * \param A host SIMIX host
 149  * \param data The user data to set
 150  */
 151 void simcall_host_set_data(smx_host_t host, void *data)
 152 {
 153   smx_simcall_t simcall = SIMIX_simcall_mine();
 154
 155   simcall->call = SIMCALL_HOST_SET_DATA;
 156   simcall->host_set_data.host = host;
 157   simcall->host_set_data.data = data;
 158   SIMIX_simcall_push(simcall->issuer);
 159 }
 160
 161 /** \brief Creates an action that executes some computation of an host.
 162  *
 163  * This function creates a SURF action and allocates the data necessary
 164  * to create the SIMIX action. It can raise a host_error exception if the host crashed.
 165  *
 166  * \param name Name of the execution action to create
 167  * \param host SIMIX host where the action will be executed
 168  * \param amount Computation amount (in bytes)
 169  * \return A new SIMIX execution action
 170  */
 171 smx_action_t simcall_host_execute(const char *name, smx_host_t host,
 172                                     double computation_amount,
 173                                     double priority)
 174 {
 175   /* checking for infinite values */
 176   xbt_assert(isfinite(computation_amount), "computation_amount is not finite!");
 177   xbt_assert(isfinite(priority), "priority is not finite!");
 178
 179   smx_simcall_t simcall = SIMIX_simcall_mine();
 180
 181   simcall->call = SIMCALL_HOST_EXECUTE;
 182   simcall->host_execute.name = name;
 183   simcall->host_execute.host = host;
 184   simcall->host_execute.computation_amount = computation_amount;
 185   simcall->host_execute.priority = priority;
 186   SIMIX_simcall_push(simcall->issuer);
 187   return simcall->host_execute.result;
 188 }
 189
 190 /** \brief Creates an action that may involve parallel computation on
 191  * several hosts and communication between them.
 192  *
 193  * \param name Name of the execution action to create
 194  * \param host_nb Number of hosts where the action will be executed
 195  * \param host_list Array (of size host_nb) of hosts where the action will be executed
 196  * \param computation_amount Array (of size host_nb) of computation amount of hosts (in bytes)
 197  * \param communication_amount Array (of size host_nb * host_nb) representing the communication
 198  * amount between each pair of hosts
 199  * \param amount the SURF action amount
 200  * \param rate the SURF action rate
 201  * \return A new SIMIX execution action
 202  */
 203 smx_action_t simcall_host_parallel_execute(const char *name,
 204                                          int host_nb,
 205                                          smx_host_t *host_list,
 206                                          double *computation_amount,
 207                                          double *communication_amount,
 208                                          double amount,
 209                                          double rate)
 210 {
 211   int i,j;
 212   /* checking for infinite values */
 213   for (i = 0 ; i < host_nb ; ++i) {
 214      xbt_assert(isfinite(computation_amount[i]), "computation_amount[%d] is not finite!", i);
 215      for (j = 0 ; j < host_nb ; ++j) {
 216         xbt_assert(isfinite(communication_amount[i + host_nb * j]),
 217                    "communication_amount[%d+%d*%d] is not finite!", i, host_nb, j);
 218      }
 219   }
 220
 221   xbt_assert(isfinite(amount), "amount is not finite!");
 222   xbt_assert(isfinite(rate), "rate is not finite!");
 223
 224   smx_simcall_t simcall = SIMIX_simcall_mine();
 225
 226   simcall->call = SIMCALL_HOST_PARALLEL_EXECUTE;
 227   simcall->host_parallel_execute.name = name;
 228   simcall->host_parallel_execute.host_nb = host_nb;
 229   simcall->host_parallel_execute.host_list = host_list;
 230   simcall->host_parallel_execute.computation_amount = computation_amount;
 231   simcall->host_parallel_execute.communication_amount = communication_amount;
 232   simcall->host_parallel_execute.amount = amount;
 233   simcall->host_parallel_execute.rate = rate;
 234   SIMIX_simcall_push(simcall->issuer);
 235   return simcall->host_parallel_execute.result;
 236 }
 237
 238 /**
 239  * \brief Destroys an execution action.
 240  *
 241  * Destroys an action, freing its memory. This function cannot be called if there are a conditional waiting for it.
 242  * \param action The execution action to destroy
 243  */
 244 void simcall_host_execution_destroy(smx_action_t execution)
 245 {
 246   smx_simcall_t simcall = SIMIX_simcall_mine();
 247
 248   simcall->call = SIMCALL_HOST_EXECUTION_DESTROY;
 249   simcall->host_execution_destroy.execution = execution;
 250   SIMIX_simcall_push(simcall->issuer);
 251 }
 252
 253 /**
 254  * \brief Cancels an execution action.
 255  *
 256  * This functions stops the execution. It calls a surf function.
 257  * \param action The execution action to cancel
 258  */
 259 void simcall_host_execution_cancel(smx_action_t execution)
 260 {
 261   smx_simcall_t simcall = SIMIX_simcall_mine();
 262
 263   simcall->call = SIMCALL_HOST_EXECUTION_CANCEL;
 264   simcall->host_execution_cancel.execution = execution;
 265   SIMIX_simcall_push(simcall->issuer);
 266 }
 267
 268 /**
 269  * \brief Returns how much of an execution action remains to be done.
 270  *
 271  * \param Action The execution action
 272  * \return The remaining amount
 273  */
 274 double simcall_host_execution_get_remains(smx_action_t execution)
 275 {
 276   smx_simcall_t simcall = SIMIX_simcall_mine();
 277
 278   simcall->call = SIMCALL_HOST_EXECUTION_GET_REMAINS;
 279   simcall->host_execution_get_remains.execution = execution;
 280   SIMIX_simcall_push(simcall->issuer);
 281   return simcall->host_execution_get_remains.result;
 282 }
 283
 284 /**
 285  * \brief Returns the state of an execution action.
 286  *
 287  * \param execution The execution action
 288  * \return The state
 289  */
 290 e_smx_state_t simcall_host_execution_get_state(smx_action_t execution)
 291 {
 292   smx_simcall_t simcall = SIMIX_simcall_mine();
 293
 294   simcall->call = SIMCALL_HOST_EXECUTION_GET_STATE;
 295   simcall->host_execution_get_state.execution = execution;
 296   SIMIX_simcall_push(simcall->issuer);
 297   return simcall->host_execution_get_state.result;
 298 }
 299
 300 /**
 301  * \brief Changes the priority of an execution action.
 302  *
 303  * This functions changes the priority only. It calls a surf function.
 304  * \param execution The execution action
 305  * \param priority The new priority
 306  */
 307 void simcall_host_execution_set_priority(smx_action_t execution, double priority)
 308 {
 309   /* checking for infinite values */
 310   xbt_assert(isfinite(priority), "priority is not finite!");
 311
 312   smx_simcall_t simcall = SIMIX_simcall_mine();
 313
 314   simcall->call = SIMCALL_HOST_EXECUTION_SET_PRIORITY;
 315   simcall->host_execution_set_priority.execution = execution;
 316   simcall->host_execution_set_priority.priority = priority;
 317   SIMIX_simcall_push(simcall->issuer);
 318 }
 319
 320 /**
 321  * \brief Waits for the completion of an execution action and destroy it.
 322  *
 323  * \param execution The execution action
 324  */
 325 e_smx_state_t simcall_host_execution_wait(smx_action_t execution)
 326 {
 327   smx_simcall_t simcall = SIMIX_simcall_mine();
 328
 329   simcall->call = SIMCALL_HOST_EXECUTION_WAIT;
 330   simcall->host_execution_wait.execution = execution;
 331   SIMIX_simcall_push(simcall->issuer);
 332   return simcall->host_execution_wait.result;
 333 }
 334
 335 /**
 336  * \brief Creates and runs a new SIMIX process.
 337  *
 338  * The structure and the corresponding thread are created and put in the list of ready processes.
 339  *
 340  * \param process the process created will be stored in this pointer
 341  * \param name a name for the process. It is for user-level information and can be NULL.
 342  * \param code the main function of the process
 343  * \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.
 344  * It can be retrieved with the function \ref simcall_process_get_data.
 345  * \param hostname name of the host where the new agent is executed.
 346  * \param kill_time time when the process is killed
 347  * \param argc first argument passed to \a code
 348  * \param argv second argument passed to \a code
 349  * \param properties the properties of the process
 350  */
 351 void simcall_process_create(smx_process_t *process, const char *name,
 352                               xbt_main_func_t code,
 353                               void *data,
 354                               const char *hostname,
 355                               double kill_time,
 356                               int argc, char **argv,
 357                               xbt_dict_t properties)
 358 {
 359   smx_simcall_t simcall = SIMIX_simcall_mine();
 360
 361   simcall->call = SIMCALL_PROCESS_CREATE;
 362   simcall->process_create.process = process;
 363   simcall->process_create.name = name;
 364   simcall->process_create.code = code;
 365   simcall->process_create.data = data;
 366   simcall->process_create.hostname = hostname;
 367   simcall->process_create.kill_time = kill_time;
 368   simcall->process_create.argc = argc;
 369   simcall->process_create.argv = argv;
 370   simcall->process_create.properties = properties;
 371   SIMIX_simcall_push(simcall->issuer);
 372 }
 373
 374 /** \brief Kills a SIMIX process.
 375  *
 376  * This function simply kills a  process.
 377  *
 378  * \param process poor victim
 379  */
 380 void simcall_process_kill(smx_process_t process)
 381 {
 382   smx_simcall_t simcall = SIMIX_simcall_mine();
 383
 384   simcall->call = SIMCALL_PROCESS_KILL;
 385   simcall->process_kill.process = process;
 386   SIMIX_simcall_push(simcall->issuer);
 387 }
 388
 389 /** \brief Kills all SIMIX processes.
 390  */
 391 void simcall_process_killall(void)
 392 {
 393   smx_simcall_t simcall = SIMIX_simcall_mine();
 394
 395   simcall->call = SIMCALL_PROCESS_KILLALL;
 396   SIMIX_simcall_push(simcall->issuer);
 397 }
 398
 399 /** \brief Cleans up a SIMIX process.
 400  * \param process poor victim (must have already been killed)
 401  */
 402 void simcall_process_cleanup(smx_process_t process)
 403 {
 404   smx_simcall_t simcall = SIMIX_simcall_mine();
 405
 406   simcall->call = SIMCALL_PROCESS_CLEANUP;
 407   simcall->process_cleanup.process = process;
 408   SIMIX_simcall_push(simcall->issuer);
 409 }
 410
 411 /**
 412  * \brief Migrates an agent to another location.
 413  *
 414  * This function changes the value of the host on which \a process is running.
 415  *
 416  * \param process the process to migrate
 417  * \param source name of the previous host
 418  * \param dest name of the new host
 419  */
 420 void simcall_process_change_host(smx_process_t process, smx_host_t dest)
 421 {
 422   smx_simcall_t simcall = SIMIX_simcall_mine();
 423
 424   simcall->call = SIMCALL_PROCESS_CHANGE_HOST;
 425   simcall->process_change_host.process = process;
 426   simcall->process_change_host.dest = dest;
 427   SIMIX_simcall_push(simcall->issuer);
 428 }
 429
 430 /**
 431  * \brief Suspends a process.
 432  *
 433  * This function suspends the process by suspending the action
 434  * it was waiting for completion.
 435  *
 436  * \param process a SIMIX process
 437  */
 438 void simcall_process_suspend(smx_process_t process)
 439 {
 440   xbt_assert(process, "Invalid parameters");
 441
 442   smx_simcall_t simcall = SIMIX_simcall_mine();
 443
 444   simcall->call = SIMCALL_PROCESS_SUSPEND;
 445   simcall->process_suspend.process = process;
 446   SIMIX_simcall_push(simcall->issuer);
 447 }
 448
 449 /**
 450  * \brief Resumes a suspended process.
 451  *
 452  * This function resumes a suspended process by resuming the action
 453  * it was waiting for completion.
 454  *
 455  * \param process a SIMIX process
 456  */
 457 void simcall_process_resume(smx_process_t process)
 458 {
 459   smx_simcall_t simcall = SIMIX_simcall_mine();
 460
 461   simcall->call = SIMCALL_PROCESS_RESUME;
 462   simcall->process_resume.process = process;
 463   SIMIX_simcall_push(simcall->issuer);
 464 }
 465
 466 /**
 467  * \brief Returns the amount of SIMIX processes in the system
 468  *
 469  * Maestro internal process is not counted, only user code processes are
 470  */
 471 int simcall_process_count(void)
 472 {
 473   smx_simcall_t simcall = SIMIX_simcall_mine();
 474
 475   simcall->call = SIMCALL_PROCESS_COUNT;
 476   SIMIX_simcall_push(simcall->issuer);
 477   return simcall->process_count.result;
 478 }
 479
 480 /**
 481  * \brief Return the user data of a #smx_process_t.
 482  * \param process a SIMIX process
 483  * \return the user data of this process
 484  */
 485 void* simcall_process_get_data(smx_process_t process)
 486 {
 487   if (process == SIMIX_process_self()) {
 488     /* avoid a simcall if this function is called by the process itself */
 489     return SIMIX_process_get_data(process);
 490   }
 491
 492   smx_simcall_t simcall = SIMIX_simcall_mine();
 493
 494   simcall->call = SIMCALL_PROCESS_GET_DATA;
 495   simcall->process_get_data.process = process;
 496   SIMIX_simcall_push(simcall->issuer);
 497   return simcall->process_get_data.result;
 498 }
 499
 500 /**
 501  * \brief Set the user data of a #m_process_t.
 502  *
 503  * This functions checks whether \a process is a valid pointer or not and set the user data associated to \a process if it is possible.
 504  * \param process SIMIX process
 505  * \param data User data
 506  */
 507 void simcall_process_set_data(smx_process_t process, void *data)
 508 {
 509   if (process == SIMIX_process_self()) {
 510     /* avoid a simcall if this function is called by the process itself */
 511     SIMIX_process_self_set_data(process, data);
 512   }
 513   else {
 514
 515     smx_simcall_t simcall = SIMIX_simcall_mine();
 516
 517     simcall->call = SIMCALL_PROCESS_SET_DATA;
 518     simcall->process_set_data.process = process;
 519     simcall->process_set_data.data = data;
 520     SIMIX_simcall_push(simcall->issuer);
 521   }
 522 }
 523
 524 /** \ingroup m_process_management
 525  * \brief Set the kill time of a process.
 526  *
 527  * \param process a process
 528  * \param kill_time a double
 529  */
 530 void simcall_process_set_kill_time(smx_process_t process, double kill_time)
 531 {
 532
 533   if (kill_time > SIMIX_get_clock()) {
 534     if (simix_global->kill_process_function) {
 535       XBT_DEBUG("Set kill time %f for process %s(%s)",kill_time, process->name,
 536           process->smx_host->name);
 537       SIMIX_timer_set(kill_time, simix_global->kill_process_function, process);
 538     }
 539   }
 540 }
 541
 542 /**
 543  * \brief Return the location on which an agent is running.
 544  *
 545  * This functions checks whether \a process is a valid pointer or not and return the m_host_t corresponding to the location on which \a process is running.
 546  * \param process SIMIX process
 547  * \return SIMIX host
 548  */
 549 smx_host_t simcall_process_get_host(smx_process_t process)
 550 {
 551   smx_simcall_t simcall = SIMIX_simcall_mine();
 552
 553   simcall->call = SIMCALL_PROCESS_GET_HOST;
 554   simcall->process_get_host.process = process;
 555   SIMIX_simcall_push(simcall->issuer);
 556   return simcall->process_get_host.result;
 557 }
 558
 559 /**
 560  * \brief Return the name of an agent.
 561  *
 562  * This functions checks whether \a process is a valid pointer or not and return its name.
 563  * \param process SIMIX process
 564  * \return The process name
 565  */
 566 const char* simcall_process_get_name(smx_process_t process)
 567 {
 568   if (process == SIMIX_process_self()) {
 569     /* avoid a simcall if this function is called by the process itself */
 570     return process->name;
 571   }
 572
 573   smx_simcall_t simcall = SIMIX_simcall_mine();
 574
 575   simcall->call = SIMCALL_PROCESS_GET_NAME;
 576   simcall->process_get_name.process = process;
 577   SIMIX_simcall_push(simcall->issuer);
 578   return simcall->process_get_name.result;
 579 }
 580
 581 /**
 582  * \brief Returns true if the process is suspended .
 583  *
 584  * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
 585  * \param process SIMIX process
 586  * \return 1, if the process is suspended, else 0.
 587  */
 588 int simcall_process_is_suspended(smx_process_t process)
 589 {
 590   smx_simcall_t simcall = SIMIX_simcall_mine();
 591
 592   simcall->call = SIMCALL_PROCESS_IS_SUSPENDED;
 593   simcall->process_is_suspended.process = process;
 594   SIMIX_simcall_push(simcall->issuer);
 595   return simcall->process_is_suspended.result;
 596 }
 597
 598 /** \ingroup m_process_management
 599  * \brief Return the properties
 600  *
 601  * This functions returns the properties associated with this process
 602  */
 603 xbt_dict_t simcall_process_get_properties(smx_process_t process)
 604 {
 605   smx_simcall_t simcall = SIMIX_simcall_mine();
 606
 607   simcall->call = SIMCALL_PROCESS_GET_PROPERTIES;
 608   simcall->process_get_properties.process = process;
 609   SIMIX_simcall_push(simcall->issuer);
 610   return simcall->process_get_properties.result;
 611 }
 612
 613 /** \brief Creates a new sleep SIMIX action.
 614  *
 615  * This function creates a SURF action and allocates the data necessary
 616  * to create the SIMIX action. It can raise a host_error exception if the
 617  * host crashed. The default SIMIX name of the action is "sleep".
 618  *
 619  *      \param duration Time duration of the sleep.
 620  *      \return A result telling whether the sleep was successful
 621  */
 622 e_smx_state_t simcall_process_sleep(double duration)
 623 {
 624   /* checking for infinite values */
 625   xbt_assert(isfinite(duration), "duration is not finite!");
 626
 627   smx_simcall_t simcall = SIMIX_simcall_mine();
 628
 629   simcall->call = SIMCALL_PROCESS_SLEEP;
 630   simcall->process_sleep.duration = duration;
 631   SIMIX_simcall_push(simcall->issuer);
 632   return simcall->process_sleep.result;
 633 }
 634
 635 /**
 636  *  \brief Creates a new rendez-vous point
 637  *  \param name The name of the rendez-vous point
 638  *  \return The created rendez-vous point
 639  */
 640 smx_rdv_t simcall_rdv_create(const char *name)
 641 {
 642   smx_simcall_t simcall = SIMIX_simcall_mine();
 643
 644   simcall->call = SIMCALL_RDV_CREATE;
 645   simcall->rdv_create.name = name;
 646
 647   SIMIX_simcall_push(simcall->issuer);
 648   return simcall->rdv_create.result;
 649 }
 650
 651
 652 /**
 653  *  \brief Destroy a rendez-vous point
 654  *  \param name The rendez-vous point to destroy
 655  */
 656 void simcall_rdv_destroy(smx_rdv_t rdv)
 657 {
 658   smx_simcall_t simcall = SIMIX_simcall_mine();
 659
 660   simcall->call = SIMCALL_RDV_DESTROY;
 661   simcall->rdv_destroy.rdv = rdv;
 662
 663   SIMIX_simcall_push(simcall->issuer);
 664 }
 665
 666 smx_rdv_t simcall_rdv_get_by_name(const char *name)
 667 {
 668   xbt_assert(name != NULL, "Invalid parameter for simcall_rdv_get_by_name (name is NULL)");
 669
 670   /* FIXME: this is a horrible lost of performance, so we hack it out by
 671    * skipping the simcall (for now). It works in parallel, it won't work on
 672    * distributed but probably we will change MSG for that. */
 673
 674   /*
 675   smx_simcall_t simcall = simcall_mine();
 676   simcall->call = SIMCALL_RDV_GEY_BY_NAME;
 677   simcall->rdv_get_by_name.name = name;
 678   SIMIX_simcall_push(simcall->issuer);
 679   return simcall->rdv_get_by_name.result;*/
 680
 681   return SIMIX_rdv_get_by_name(name);
 682 }
 683
 684 /**
 685  *  \brief Counts the number of communication actions of a given host pending
 686  *         on a rendez-vous point.
 687  *  \param rdv The rendez-vous point
 688  *  \param host The host to be counted
 689  *  \return The number of comm actions pending in the rdv
 690  */
 691 int simcall_rdv_comm_count_by_host(smx_rdv_t rdv, smx_host_t host)
 692 {
 693   smx_simcall_t simcall = SIMIX_simcall_mine();
 694
 695   simcall->call = SIMCALL_RDV_COMM_COUNT_BY_HOST;
 696   simcall->rdv_comm_count_by_host.rdv = rdv;
 697   simcall->rdv_comm_count_by_host.host = host;
 698
 699   SIMIX_simcall_push(simcall->issuer);
 700   return simcall->rdv_comm_count_by_host.result;
 701 }
 702
 703 /**
 704  *  \brief returns the communication at the head of the rendez-vous
 705  *  \param rdv The rendez-vous point
 706  *  \return The communication or NULL if empty
 707  */
 708 smx_action_t simcall_rdv_get_head(smx_rdv_t rdv)
 709 {
 710   smx_simcall_t simcall = SIMIX_simcall_mine();
 711
 712   simcall->call = SIMCALL_RDV_GET_HEAD;
 713   simcall->rdv_get_head.rdv = rdv;
 714
 715   SIMIX_simcall_push(simcall->issuer);
 716   return simcall->rdv_get_head.result;
 717 }
 718
 719 void simcall_comm_send(smx_rdv_t rdv, double task_size, double rate,
 720                          void *src_buff, size_t src_buff_size,
 721                          int (*match_fun)(void *, void *, smx_action_t), void *data,
 722                          double timeout)
 723 {
 724   /* checking for infinite values */
 725   xbt_assert(isfinite(task_size), "task_size is not finite!");
 726   xbt_assert(isfinite(rate), "rate is not finite!");
 727   xbt_assert(isfinite(timeout), "timeout is not finite!");
 728
 729   xbt_assert(rdv, "No rendez-vous point defined for send");
 730
 731   if (MC_IS_ENABLED) {
 732     /* the model-checker wants two separate simcalls */
 733     smx_action_t comm = simcall_comm_isend(rdv, task_size, rate,
 734         src_buff, src_buff_size, match_fun, NULL, data, 0);
 735     simcall_comm_wait(comm, timeout);
 736   }
 737   else {
 738     smx_simcall_t simcall = SIMIX_simcall_mine();
 739
 740     simcall->call = SIMCALL_COMM_SEND;
 741     simcall->comm_send.rdv = rdv;
 742     simcall->comm_send.task_size = task_size;
 743     simcall->comm_send.rate = rate;
 744     simcall->comm_send.src_buff = src_buff;
 745     simcall->comm_send.src_buff_size = src_buff_size;
 746     simcall->comm_send.match_fun = match_fun;
 747     simcall->comm_send.data = data;
 748     simcall->comm_send.timeout = timeout;
 749
 750     SIMIX_simcall_push(simcall->issuer);
 751   }
 752 }
 753
 754 smx_action_t simcall_comm_isend(smx_rdv_t rdv, double task_size, double rate,
 755                               void *src_buff, size_t src_buff_size,
 756                               int (*match_fun)(void *, void *, smx_action_t),
 757                               void (*clean_fun)(void *),
 758                               void *data,
 759                               int detached)
 760 {
 761   /* checking for infinite values */
 762   xbt_assert(isfinite(task_size), "task_size is not finite!");
 763   xbt_assert(isfinite(rate), "rate is not finite!");
 764
 765   xbt_assert(rdv, "No rendez-vous point defined for isend");
 766
 767   smx_simcall_t simcall = SIMIX_simcall_mine();
 768
 769   simcall->call = SIMCALL_COMM_ISEND;
 770   simcall->comm_isend.rdv = rdv;
 771   simcall->comm_isend.task_size = task_size;
 772   simcall->comm_isend.rate = rate;
 773   simcall->comm_isend.src_buff = src_buff;
 774   simcall->comm_isend.src_buff_size = src_buff_size;
 775   simcall->comm_isend.match_fun = match_fun;
 776   simcall->comm_isend.clean_fun = clean_fun;
 777   simcall->comm_isend.data = data;
 778   simcall->comm_isend.detached = detached;
 779
 780   SIMIX_simcall_push(simcall->issuer);
 781   return simcall->comm_isend.result;
 782 }
 783
 784 void simcall_comm_recv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
 785                          int (*match_fun)(void *, void *, smx_action_t), void *data, double timeout)
 786 {
 787   xbt_assert(isfinite(timeout), "timeout is not finite!");
 788   xbt_assert(rdv, "No rendez-vous point defined for recv");
 789
 790   if (MC_IS_ENABLED) {
 791     /* the model-checker wants two separate simcalls */
 792     smx_action_t comm = simcall_comm_irecv(rdv, dst_buff, dst_buff_size,
 793         match_fun, data);
 794     simcall_comm_wait(comm, timeout);
 795   }
 796   else {
 797     smx_simcall_t simcall = SIMIX_simcall_mine();
 798
 799     simcall->call = SIMCALL_COMM_RECV;
 800     simcall->comm_recv.rdv = rdv;
 801     simcall->comm_recv.dst_buff = dst_buff;
 802     simcall->comm_recv.dst_buff_size = dst_buff_size;
 803     simcall->comm_recv.match_fun = match_fun;
 804     simcall->comm_recv.data = data;
 805     simcall->comm_recv.timeout = timeout;
 806
 807     SIMIX_simcall_push(simcall->issuer);
 808   }
 809 }
 810
 811 smx_action_t simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff, size_t * dst_buff_size,
 812                                   int (*match_fun)(void *, void *, smx_action_t), void *data)
 813 {
 814   xbt_assert(rdv, "No rendez-vous point defined for irecv");
 815
 816   smx_simcall_t simcall = SIMIX_simcall_mine();
 817
 818   simcall->call = SIMCALL_COMM_IRECV;
 819   simcall->comm_irecv.rdv = rdv;
 820   simcall->comm_irecv.dst_buff = dst_buff;
 821   simcall->comm_irecv.dst_buff_size = dst_buff_size;
 822   simcall->comm_irecv.match_fun = match_fun;
 823   simcall->comm_irecv.data = data;
 824
 825   SIMIX_simcall_push(simcall->issuer);
 826   return simcall->comm_irecv.result;
 827 }
 828
 829 void simcall_comm_destroy(smx_action_t comm)
 830 {
 831   xbt_assert(comm, "Invalid parameter");
 832
 833   /* FIXME remove this simcall type: comms are auto-destroyed now */
 834
 835   /*
 836   smx_simcall_t simcall = simcall_mine();
 837
 838   simcall->call = SIMCALL_COMM_DESTROY;
 839   simcall->comm_destroy.comm = comm;
 840
 841   SIMIX_simcall_push(simcall->issuer);
 842   */
 843 }
 844
 845 void simcall_comm_cancel(smx_action_t comm)
 846 {
 847   smx_simcall_t simcall = SIMIX_simcall_mine();
 848
 849   simcall->call = SIMCALL_COMM_CANCEL;
 850   simcall->comm_cancel.comm = comm;
 851
 852   SIMIX_simcall_push(simcall->issuer);
 853 }
 854
 855 unsigned int simcall_comm_waitany(xbt_dynar_t comms)
 856 {
 857   smx_simcall_t simcall = SIMIX_simcall_mine();
 858
 859   simcall->call = SIMCALL_COMM_WAITANY;
 860   simcall->comm_waitany.comms = comms;
 861
 862   SIMIX_simcall_push(simcall->issuer);
 863   return simcall->comm_waitany.result;
 864 }
 865
 866 int simcall_comm_testany(xbt_dynar_t comms)
 867 {
 868   smx_simcall_t simcall = SIMIX_simcall_mine();
 869   if (xbt_dynar_is_empty(comms))
 870     return -1;
 871
 872   simcall->call = SIMCALL_COMM_TESTANY;
 873   simcall->comm_testany.comms = comms;
 874
 875   SIMIX_simcall_push(simcall->issuer);
 876   return simcall->comm_testany.result;
 877 }
 878
 879 void simcall_comm_wait(smx_action_t comm, double timeout)
 880 {
 881   xbt_assert(isfinite(timeout), "timeout is not finite!");
 882
 883   smx_simcall_t simcall = SIMIX_simcall_mine();
 884
 885   simcall->call = SIMCALL_COMM_WAIT;
 886   simcall->comm_wait.comm = comm;
 887   simcall->comm_wait.timeout = timeout;
 888
 889   SIMIX_simcall_push(simcall->issuer);
 890 }
 891
 892 #ifdef HAVE_TRACING
 893 /**
 894  * \brief Set the category of an action.
 895  *
 896  * This functions changes the category only. It calls a surf function.
 897  * \param execution The execution action
 898  * \param category The tracing category
 899  */
 900 void simcall_set_category(smx_action_t action, const char *category)
 901 {
 902   if (category == NULL) {
 903     return;
 904   }
 905
 906   smx_simcall_t simcall = SIMIX_simcall_mine();
 907
 908   simcall->call = SIMCALL_SET_CATEGORY;
 909   simcall->set_category.action = action;
 910   simcall->set_category.category = category;
 911
 912   SIMIX_simcall_push(simcall->issuer);
 913 }
 914 #endif
 915
 916 int simcall_comm_test(smx_action_t comm)
 917 {
 918   smx_simcall_t simcall = SIMIX_simcall_mine();
 919
 920   simcall->call = SIMCALL_COMM_TEST;
 921   simcall->comm_test.comm = comm;
 922
 923   SIMIX_simcall_push(simcall->issuer);
 924   return simcall->comm_test.result;
 925 }
 926
 927 double simcall_comm_get_remains(smx_action_t comm)
 928 {
 929   smx_simcall_t simcall = SIMIX_simcall_mine();
 930
 931   simcall->call = SIMCALL_COMM_GET_REMAINS;
 932   simcall->comm_get_remains.comm = comm;
 933
 934   SIMIX_simcall_push(simcall->issuer);
 935   return simcall->comm_get_remains.result;
 936 }
 937
 938 e_smx_state_t simcall_comm_get_state(smx_action_t comm)
 939 {
 940   smx_simcall_t simcall = SIMIX_simcall_mine();
 941
 942   simcall->call = SIMCALL_COMM_GET_STATE;
 943   simcall->comm_get_state.comm = comm;
 944
 945   SIMIX_simcall_push(simcall->issuer);
 946   return simcall->comm_get_state.result;
 947 }
 948
 949 void *simcall_comm_get_src_data(smx_action_t comm)
 950 {
 951   smx_simcall_t simcall = SIMIX_simcall_mine();
 952
 953   simcall->call = SIMCALL_COMM_GET_SRC_DATA;
 954   simcall->comm_get_src_data.comm = comm;
 955
 956   SIMIX_simcall_push(simcall->issuer);
 957   return simcall->comm_get_src_data.result;
 958 }
 959
 960 void *simcall_comm_get_dst_data(smx_action_t comm)
 961 {
 962   smx_simcall_t simcall = SIMIX_simcall_mine();
 963
 964   simcall->call = SIMCALL_COMM_GET_DST_DATA;
 965   simcall->comm_get_dst_data.comm = comm;
 966
 967   SIMIX_simcall_push(simcall->issuer);
 968   return simcall->comm_get_dst_data.result;
 969 }
 970
 971 smx_process_t simcall_comm_get_src_proc(smx_action_t comm)
 972 {
 973   smx_simcall_t simcall = SIMIX_simcall_mine();
 974
 975   simcall->call = SIMCALL_COMM_GET_SRC_PROC;
 976   simcall->comm_get_src_proc.comm = comm;
 977
 978   SIMIX_simcall_push(simcall->issuer);
 979   return simcall->comm_get_src_proc.result;
 980 }
 981
 982 smx_process_t simcall_comm_get_dst_proc(smx_action_t comm)
 983 {
 984   smx_simcall_t simcall = SIMIX_simcall_mine();
 985
 986   simcall->call = SIMCALL_COMM_GET_DST_PROC;
 987   simcall->comm_get_dst_proc.comm = comm;
 988
 989   SIMIX_simcall_push(simcall->issuer);
 990   return simcall->comm_get_dst_proc.result;
 991 }
 992
 993 #ifdef HAVE_LATENCY_BOUND_TRACKING
 994 int simcall_comm_is_latency_bounded(smx_action_t comm)
 995 {
 996   smx_simcall_t simcall = SIMIX_simcall_mine();
 997
 998   simcall->call = SIMCALL_COMM_IS_LATENCY_BOUNDED;
 999   simcall->comm_is_latency_bounded.comm = comm;
1000
1001   SIMIX_simcall_push(simcall->issuer);
1002   return simcall->comm_is_latency_bounded.result;
1003 }
1004 #endif
1005
1006 smx_mutex_t simcall_mutex_init(void)
1007 {
1008   smx_simcall_t simcall = SIMIX_simcall_mine();
1009
1010   simcall->call = SIMCALL_MUTEX_INIT;
1011
1012   SIMIX_simcall_push(simcall->issuer);
1013   return simcall->mutex_init.result;
1014 }
1015
1016 void simcall_mutex_destroy(smx_mutex_t mutex)
1017 {
1018   smx_simcall_t simcall = SIMIX_simcall_mine();
1019
1020   simcall->call = SIMCALL_MUTEX_DESTROY;
1021   simcall->mutex_destroy.mutex = mutex;
1022
1023   SIMIX_simcall_push(simcall->issuer);
1024 }
1025
1026 void simcall_mutex_lock(smx_mutex_t mutex)
1027 {
1028   smx_simcall_t simcall = SIMIX_simcall_mine();
1029
1030   simcall->call = SIMCALL_MUTEX_LOCK;
1031   simcall->mutex_lock.mutex = mutex;
1032
1033   SIMIX_simcall_push(simcall->issuer);
1034 }
1035
1036 int simcall_mutex_trylock(smx_mutex_t mutex)
1037 {
1038   smx_simcall_t simcall = SIMIX_simcall_mine();
1039
1040   simcall->call = SIMCALL_MUTEX_TRYLOCK;
1041   simcall->mutex_trylock.mutex = mutex;
1042
1043   SIMIX_simcall_push(simcall->issuer);
1044   return simcall->mutex_trylock.result;
1045 }
1046
1047 void simcall_mutex_unlock(smx_mutex_t mutex)
1048 {
1049   smx_simcall_t simcall = SIMIX_simcall_mine();
1050
1051   simcall->call = SIMCALL_MUTEX_UNLOCK;
1052   simcall->mutex_unlock.mutex = mutex;
1053
1054   SIMIX_simcall_push(simcall->issuer);
1055 }
1056
1057
1058 smx_cond_t simcall_cond_init(void)
1059 {
1060   smx_simcall_t simcall = SIMIX_simcall_mine();
1061
1062   simcall->call = SIMCALL_COND_INIT;
1063
1064   SIMIX_simcall_push(simcall->issuer);
1065   return simcall->cond_init.result;
1066 }
1067
1068 void simcall_cond_destroy(smx_cond_t cond)
1069 {
1070   smx_simcall_t simcall = SIMIX_simcall_mine();
1071
1072   simcall->call = SIMCALL_COND_DESTROY;
1073   simcall->cond_destroy.cond = cond;
1074
1075   SIMIX_simcall_push(simcall->issuer);
1076 }
1077
1078 void simcall_cond_signal(smx_cond_t cond)
1079 {
1080   smx_simcall_t simcall = SIMIX_simcall_mine();
1081
1082   simcall->call = SIMCALL_COND_SIGNAL;
1083   simcall->cond_signal.cond = cond;
1084
1085   SIMIX_simcall_push(simcall->issuer);
1086 }
1087
1088 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
1089 {
1090   smx_simcall_t simcall = SIMIX_simcall_mine();
1091
1092   simcall->call = SIMCALL_COND_WAIT;
1093   simcall->cond_wait.cond = cond;
1094   simcall->cond_wait.mutex = mutex;
1095
1096   SIMIX_simcall_push(simcall->issuer);
1097 }
1098
1099 void simcall_cond_wait_timeout(smx_cond_t cond,
1100                                  smx_mutex_t mutex,
1101                                  double timeout)
1102 {
1103   xbt_assert(isfinite(timeout), "timeout is not finite!");
1104
1105   smx_simcall_t simcall = SIMIX_simcall_mine();
1106
1107   simcall->call = SIMCALL_COND_WAIT_TIMEOUT;
1108   simcall->cond_wait_timeout.cond = cond;
1109   simcall->cond_wait_timeout.mutex = mutex;
1110   simcall->cond_wait_timeout.timeout = timeout;
1111
1112   SIMIX_simcall_push(simcall->issuer);
1113 }
1114
1115 void simcall_cond_broadcast(smx_cond_t cond)
1116 {
1117   smx_simcall_t simcall = SIMIX_simcall_mine();
1118
1119   simcall->call = SIMCALL_COND_BROADCAST;
1120   simcall->cond_broadcast.cond = cond;
1121
1122   SIMIX_simcall_push(simcall->issuer);
1123 }
1124
1125
1126 smx_sem_t simcall_sem_init(int capacity)
1127 {
1128   smx_simcall_t simcall = SIMIX_simcall_mine();
1129
1130   simcall->call = SIMCALL_SEM_INIT;
1131   simcall->sem_init.capacity = capacity;
1132
1133   SIMIX_simcall_push(simcall->issuer);
1134   return simcall->sem_init.result;
1135 }
1136
1137 void simcall_sem_destroy(smx_sem_t sem)
1138 {
1139   smx_simcall_t simcall = SIMIX_simcall_mine();
1140
1141   simcall->call = SIMCALL_SEM_DESTROY;
1142   simcall->sem_destroy.sem = sem;
1143
1144   SIMIX_simcall_push(simcall->issuer);
1145 }
1146
1147 void simcall_sem_release(smx_sem_t sem)
1148 {
1149   smx_simcall_t simcall = SIMIX_simcall_mine();
1150
1151   simcall->call = SIMCALL_SEM_RELEASE;
1152   simcall->sem_release.sem = sem;
1153
1154   SIMIX_simcall_push(simcall->issuer);
1155 }
1156
1157 int simcall_sem_would_block(smx_sem_t sem)
1158 {
1159   smx_simcall_t simcall = SIMIX_simcall_mine();
1160
1161   simcall->call = SIMCALL_SEM_WOULD_BLOCK;
1162   simcall->sem_would_block.sem = sem;
1163
1164   SIMIX_simcall_push(simcall->issuer);
1165   return simcall->sem_would_block.result;
1166 }
1167
1168 void simcall_sem_acquire(smx_sem_t sem)
1169 {
1170   smx_simcall_t simcall = SIMIX_simcall_mine();
1171
1172   simcall->call = SIMCALL_SEM_ACQUIRE;
1173   simcall->sem_acquire.sem = sem;
1174
1175   SIMIX_simcall_push(simcall->issuer);
1176 }
1177
1178 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
1179 {
1180   xbt_assert(isfinite(timeout), "timeout is not finite!");
1181
1182   smx_simcall_t simcall = SIMIX_simcall_mine();
1183
1184   simcall->call = SIMCALL_SEM_ACQUIRE_TIMEOUT;
1185   simcall->sem_acquire_timeout.sem = sem;
1186   simcall->sem_acquire_timeout.timeout = timeout;
1187
1188   SIMIX_simcall_push(simcall->issuer);
1189 }
1190
1191 int simcall_sem_get_capacity(smx_sem_t sem)
1192 {
1193   smx_simcall_t simcall = SIMIX_simcall_mine();
1194
1195   simcall->call = SIMCALL_SEM_GET_CAPACITY;
1196   simcall->sem_get_capacity.sem = sem;
1197
1198   SIMIX_simcall_push(simcall->issuer);
1199   return simcall->sem_get_capacity.result;
1200 }
1201
1202 size_t simcall_file_read(const char* storage, void* ptr, size_t size, size_t nmemb, smx_file_t stream)
1203 {
1204   smx_simcall_t simcall = SIMIX_simcall_mine();
1205
1206   simcall->call = SIMCALL_FILE_READ;
1207   simcall->file_read.storage = storage;
1208   simcall->file_read.ptr = ptr;
1209   simcall->file_read.size = size;
1210   simcall->file_read.nmemb = nmemb;
1211   simcall->file_read.stream = stream;
1212   SIMIX_simcall_push(simcall->issuer);
1213
1214   return simcall->file_read.result;
1215 }
1216
1217 size_t simcall_file_write(const char* storage, const void* ptr, size_t size, size_t nmemb, smx_file_t stream)
1218 {
1219   smx_simcall_t simcall = SIMIX_simcall_mine();
1220
1221   simcall->call = SIMCALL_FILE_WRITE;
1222   simcall->file_write.storage = storage;
1223   simcall->file_write.ptr = ptr;
1224   simcall->file_write.size = size;
1225   simcall->file_write.nmemb = nmemb;
1226   simcall->file_write.stream = stream;
1227   SIMIX_simcall_push(simcall->issuer);
1228
1229   return simcall->file_write.result;
1230 }
1231
1232 smx_file_t simcall_file_open(const char* storage, const char* path, const char* mode)
1233 {
1234   smx_simcall_t simcall = SIMIX_simcall_mine();
1235
1236   simcall->call = SIMCALL_FILE_OPEN;
1237   simcall->file_open.storage = storage;
1238   simcall->file_open.path = path;
1239   simcall->file_open.mode = mode;
1240   SIMIX_simcall_push(simcall->issuer);
1241
1242   return simcall->file_open.result;
1243 }
1244
1245 int simcall_file_close(const char* storage, smx_file_t fp)
1246 {
1247   smx_simcall_t simcall = SIMIX_simcall_mine();
1248
1249   simcall->call = SIMCALL_FILE_CLOSE;
1250   simcall->file_close.storage = storage;
1251   simcall->file_close.fp = fp;
1252   SIMIX_simcall_push(simcall->issuer);
1253
1254   return simcall->file_close.result;
1255 }
1256
1257 int simcall_file_stat(const char* storage, smx_file_t fd, s_file_stat_t *buf)
1258 {
1259   smx_simcall_t simcall = SIMIX_simcall_mine();
1260   simcall->call = SIMCALL_FILE_STAT;
1261   simcall->file_stat.storage = storage;
1262   simcall->file_stat.fd = fd;
1263
1264   SIMIX_simcall_push(simcall->issuer);
1265
1266   *buf = simcall->file_stat.buf;
1267
1268   return simcall->file_stat.result;
1269 }
1270
1271 /* ************************************************************************** */
1272
1273 /** @brief returns a printable string representing a simcall */
1274 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
1275   return simcall_names[kind];
1276 }