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 "mc/mc.h"
  19 #include "simgrid/s4u/VirtualMachine.hpp"
  20 #include "simgrid/simix.hpp"
  21 #include "simgrid/simix/blocking_simcall.hpp"
  22 #include "smx_private.h"
  23 #include "src/kernel/activity/CommImpl.hpp"
  24 #include "src/mc/mc_forward.hpp"
  25 #include "src/mc/mc_replay.h"
  26 #include "src/plugins/vm/VirtualMachineImpl.hpp"
  27 #include "src/simix/smx_host_private.h"
  28 #include "xbt/ex.h"
  29 #include "xbt/functional.hpp"
  30
  31 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
  32
  33 #include "popping_bodies.cpp"
  34
  35 void simcall_call(smx_actor_t actor)
  36 {
  37   if (actor != simix_global->maestro_process) {
  38     XBT_DEBUG("Yield actor '%s' on simcall %s (%d)", actor->cname(), SIMIX_simcall_name(actor->simcall.call),
  39               (int)actor->simcall.call);
  40     SIMIX_process_yield(actor);
  41   } else {
  42     SIMIX_simcall_handle(&actor->simcall, 0);
  43   }
  44 }
  45
  46 /**
  47  * \ingroup simix_process_management
  48  * \brief Creates a synchro that executes some computation of an host.
  49  *
  50  * This function creates a SURF action and allocates the data necessary
  51  * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
  52  *
  53  * \param name Name of the execution synchro to create
  54  * \param flops_amount amount Computation amount (in flops)
  55  * \param priority computation priority
  56  * \param bound
  57  * \return A new SIMIX execution synchronization
  58  */
  59 smx_activity_t simcall_execution_start(const char *name,
  60                                     double flops_amount,
  61                                     double priority, double bound)
  62 {
  63   /* checking for infinite values */
  64   xbt_assert(std::isfinite(flops_amount), "flops_amount is not finite!");
  65   xbt_assert(std::isfinite(priority), "priority is not finite!");
  66
  67   return simcall_BODY_execution_start(name, flops_amount, priority, bound);
  68 }
  69
  70 /**
  71  * \ingroup simix_process_management
  72  * \brief Creates a synchro that may involve parallel computation on
  73  * several hosts and communication between them.
  74  *
  75  * \param name Name of the execution synchro to create
  76  * \param host_nb Number of hosts where the synchro will be executed
  77  * \param host_list Array (of size host_nb) of hosts where the synchro will be executed
  78  * \param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
  79  * \param bytes_amount Array (of size host_nb * host_nb) representing the communication
  80  * amount between each pair of hosts
  81  * \param amount the SURF action amount
  82  * \param rate the SURF action rate
  83  * \param timeout timeout
  84  * \return A new SIMIX execution synchronization
  85  */
  86 smx_activity_t simcall_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list,
  87                                                 double* flops_amount, double* bytes_amount, double amount, double rate,
  88                                                 double timeout)
  89 {
  90   /* checking for infinite values */
  91   for (int i = 0 ; i < host_nb ; ++i) {
  92     xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
  93     if (bytes_amount != nullptr) {
  94       for (int j = 0 ; j < host_nb ; ++j) {
  95         xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
  96                    "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
  97       }
  98     }
  99   }
 100
 101   xbt_assert(std::isfinite(amount), "amount is not finite!");
 102   xbt_assert(std::isfinite(rate), "rate is not finite!");
 103
 104   return simcall_BODY_execution_parallel_start(name, host_nb, host_list, flops_amount, bytes_amount, amount, rate,
 105                                                timeout);
 106 }
 107
 108 /**
 109  * \ingroup simix_process_management
 110  * \brief Cancels an execution synchro.
 111  *
 112  * This functions stops the execution. It calls a surf function.
 113  * \param execution The execution synchro to cancel
 114  */
 115 void simcall_execution_cancel(smx_activity_t execution)
 116 {
 117   simcall_BODY_execution_cancel(execution);
 118 }
 119
 120 /**
 121  * \ingroup simix_process_management
 122  * \brief Changes the priority of an execution synchro.
 123  *
 124  * This functions changes the priority only. It calls a surf function.
 125  * \param execution The execution synchro
 126  * \param priority The new priority
 127  */
 128 void simcall_execution_set_priority(smx_activity_t execution, double priority)
 129 {
 130   /* checking for infinite values */
 131   xbt_assert(std::isfinite(priority), "priority is not finite!");
 132
 133   simcall_BODY_execution_set_priority(execution, priority);
 134 }
 135
 136 /**
 137  * \ingroup simix_process_management
 138  * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
 139  *
 140  * This functions changes the capping only. It calls a surf function.
 141  * \param execution The execution synchro
 142  * \param bound The new bound
 143  */
 144 void simcall_execution_set_bound(smx_activity_t execution, double bound)
 145 {
 146   simcall_BODY_execution_set_bound(execution, bound);
 147 }
 148
 149 /**
 150  * \ingroup simix_host_management
 151  * \brief Waits for the completion of an execution synchro and destroy it.
 152  *
 153  * \param execution The execution synchro
 154  */
 155 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
 156 {
 157   return (e_smx_state_t) simcall_BODY_execution_wait(execution);
 158 }
 159
 160 /**
 161  * \ingroup simix_process_management
 162  * \brief Kills a SIMIX process.
 163  *
 164  * This function simply kills a  process.
 165  *
 166  * \param process poor victim
 167  */
 168 void simcall_process_kill(smx_actor_t process)
 169 {
 170   simcall_BODY_process_kill(process);
 171 }
 172
 173 /**
 174  * \ingroup simix_process_management
 175  * \brief Kills all SIMIX processes.
 176  */
 177 void simcall_process_killall(int reset_pid)
 178 {
 179   simcall_BODY_process_killall(reset_pid);
 180 }
 181
 182 /**
 183  * \ingroup simix_process_management
 184  * \brief Cleans up a SIMIX process.
 185  * \param process poor victim (must have already been killed)
 186  */
 187 void simcall_process_cleanup(smx_actor_t process)
 188 {
 189   simcall_BODY_process_cleanup(process);
 190 }
 191
 192 void simcall_process_join(smx_actor_t process, double timeout)
 193 {
 194   simcall_BODY_process_join(process, timeout);
 195 }
 196
 197 /**
 198  * \ingroup simix_process_management
 199  * \brief Suspends a process.
 200  *
 201  * This function suspends the process by suspending the synchro
 202  * it was waiting for completion.
 203  *
 204  * \param process a SIMIX process
 205  */
 206 void simcall_process_suspend(smx_actor_t process)
 207 {
 208   simcall_BODY_process_suspend(process);
 209 }
 210
 211 /**
 212  * \ingroup simix_process_management
 213  * \brief Returns the amount of SIMIX processes in the system
 214  *
 215  * Maestro internal process is not counted, only user code processes are
 216  */
 217 int simcall_process_count()
 218 {
 219   return simgrid::simix::kernelImmediate(SIMIX_process_count);
 220 }
 221
 222 /**
 223  * \ingroup simix_process_management
 224  * \brief Set the user data of a #smx_actor_t.
 225  *
 226  * This functions sets the user data associated to \a process.
 227  * \param process SIMIX process
 228  * \param data User data
 229  */
 230 void simcall_process_set_data(smx_actor_t process, void *data)
 231 {
 232   simgrid::simix::kernelImmediate([process, data] { process->setUserData(data); });
 233 }
 234
 235 /**
 236  * \ingroup simix_process_management
 237  * \brief Set the kill time of a process.
 238  */
 239 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
 240 {
 241
 242   if (kill_time <= SIMIX_get_clock() || simix_global->kill_process_function == nullptr)
 243     return;
 244   XBT_DEBUG("Set kill time %f for process %s@%s", kill_time, process->cname(), process->host->getCname());
 245   process->kill_timer = SIMIX_timer_set(kill_time, [=] {
 246     simix_global->kill_process_function(process);
 247     process->kill_timer=nullptr;
 248   });
 249 }
 250
 251 /**
 252  * \ingroup simix_process_management
 253  * \brief Return the properties
 254  *
 255  * This function returns the properties associated with this process
 256  */
 257 xbt_dict_t simcall_process_get_properties(smx_actor_t process)
 258 {
 259   return process->properties;
 260 }
 261 /**
 262  * \ingroup simix_process_management
 263  * \brief Add an on_exit function
 264  * Add an on_exit function which will be executed when the process exits/is killed.
 265  */
 266 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data)
 267 {
 268   simcall_BODY_process_on_exit(process, fun, data);
 269 }
 270
 271 /**
 272  * \ingroup simix_process_management
 273  * \brief Restarts the process, killing it and starting it again from scratch.
 274  */
 275 XBT_PUBLIC(smx_actor_t) simcall_process_restart(smx_actor_t process)
 276 {
 277   return (smx_actor_t) simcall_BODY_process_restart(process);
 278 }
 279 /**
 280  * \ingroup simix_process_management
 281  * \brief Creates a new sleep SIMIX synchro.
 282  *
 283  * This function creates a SURF action and allocates the data necessary
 284  * to create the SIMIX synchro. It can raise a host_error exception if the
 285  * host crashed. The default SIMIX name of the synchro is "sleep".
 286  *
 287  *   \param duration Time duration of the sleep.
 288  *   \return A result telling whether the sleep was successful
 289  */
 290 e_smx_state_t simcall_process_sleep(double duration)
 291 {
 292   /* checking for infinite values */
 293   xbt_assert(std::isfinite(duration), "duration is not finite!");
 294   return (e_smx_state_t) simcall_BODY_process_sleep(duration);
 295 }
 296
 297 /**
 298  * \ingroup simix_comm_management
 299  */
 300 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 301                        size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 302                        void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout)
 303 {
 304   /* checking for infinite values */
 305   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 306   xbt_assert(std::isfinite(rate), "rate is not finite!");
 307   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 308
 309   xbt_assert(mbox, "No rendez-vous point defined for send");
 310
 311   if (MC_is_active() || MC_record_replay_is_active()) {
 312     /* the model-checker wants two separate simcalls */
 313     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 314     comm = simcall_comm_isend(sender, mbox, task_size, rate,
 315         src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
 316     simcall_comm_wait(comm, timeout);
 317     comm = nullptr;
 318   }
 319   else {
 320     simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
 321                          match_fun, copy_data_fun, data, timeout);
 322   }
 323 }
 324
 325 /**
 326  * \ingroup simix_comm_management
 327  */
 328 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 329                                   size_t src_buff_size,
 330                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 331                                   void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t),
 332                                   void* data, int detached)
 333 {
 334   /* checking for infinite values */
 335   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 336   xbt_assert(std::isfinite(rate), "rate is not finite!");
 337
 338   xbt_assert(mbox, "No rendez-vous point defined for isend");
 339
 340   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
 341                                  src_buff_size, match_fun,
 342                                  clean_fun, copy_data_fun, data, detached);
 343 }
 344
 345 /**
 346  * \ingroup simix_comm_management
 347  */
 348 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 349                        int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 350                        void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate)
 351 {
 352   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 353   xbt_assert(mbox, "No rendez-vous point defined for recv");
 354
 355   if (MC_is_active() || MC_record_replay_is_active()) {
 356     /* the model-checker wants two separate simcalls */
 357     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 358     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 359                               match_fun, copy_data_fun, data, rate);
 360     simcall_comm_wait(comm, timeout);
 361     comm = nullptr;
 362   }
 363   else {
 364     simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
 365                            match_fun, copy_data_fun, data, timeout, rate);
 366   }
 367 }
 368 /**
 369  * \ingroup simix_comm_management
 370  */
 371 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 372                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 373                                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate)
 374 {
 375   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 376
 377   return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 378                                  match_fun, copy_data_fun, data, rate);
 379 }
 380
 381 /**
 382  * \ingroup simix_comm_management
 383  */
 384 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
 385                                    int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
 386 {
 387   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
 388
 389   return simcall_BODY_comm_iprobe(mbox, type, match_fun, data);
 390 }
 391
 392 /**
 393  * \ingroup simix_comm_management
 394  */
 395 void simcall_comm_cancel(smx_activity_t synchro)
 396 {
 397   simgrid::simix::kernelImmediate([synchro] {
 398     simgrid::kernel::activity::CommImplPtr comm =
 399         boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
 400     comm->cancel();
 401   });
 402 }
 403
 404 /**
 405  * \ingroup simix_comm_management
 406  */
 407 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
 408 {
 409   return simcall_BODY_comm_waitany(comms, timeout);
 410 }
 411
 412 /**
 413  * \ingroup simix_comm_management
 414  */
 415 int simcall_comm_testany(smx_activity_t* comms, size_t count)
 416 {
 417   if (count == 0)
 418     return -1;
 419   return simcall_BODY_comm_testany(comms, count);
 420 }
 421
 422 /**
 423  * \ingroup simix_comm_management
 424  */
 425 void simcall_comm_wait(smx_activity_t comm, double timeout)
 426 {
 427   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 428   simcall_BODY_comm_wait(comm, timeout);
 429 }
 430
 431 /**
 432  * \brief Set the category of an synchro.
 433  *
 434  * This functions changes the category only. It calls a surf function.
 435  * \param synchro The execution synchro
 436  * \param category The tracing category
 437  */
 438 void simcall_set_category(smx_activity_t synchro, const char *category)
 439 {
 440   if (category == nullptr) {
 441     return;
 442   }
 443   simcall_BODY_set_category(synchro, category);
 444 }
 445
 446 /**
 447  * \ingroup simix_comm_management
 448  *
 449  */
 450 int simcall_comm_test(smx_activity_t comm)
 451 {
 452   return simcall_BODY_comm_test(comm);
 453 }
 454
 455 /**
 456  * \ingroup simix_synchro_management
 457  *
 458  */
 459 smx_mutex_t simcall_mutex_init()
 460 {
 461   if (not simix_global) {
 462     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
 463     xbt_abort();
 464   }
 465   return simcall_BODY_mutex_init();
 466 }
 467
 468 /**
 469  * \ingroup simix_synchro_management
 470  *
 471  */
 472 void simcall_mutex_lock(smx_mutex_t mutex)
 473 {
 474   simcall_BODY_mutex_lock(mutex);
 475 }
 476
 477 /**
 478  * \ingroup simix_synchro_management
 479  *
 480  */
 481 int simcall_mutex_trylock(smx_mutex_t mutex)
 482 {
 483   return simcall_BODY_mutex_trylock(mutex);
 484 }
 485
 486 /**
 487  * \ingroup simix_synchro_management
 488  *
 489  */
 490 void simcall_mutex_unlock(smx_mutex_t mutex)
 491 {
 492   simcall_BODY_mutex_unlock(mutex);
 493 }
 494
 495 /**
 496  * \ingroup simix_synchro_management
 497  *
 498  */
 499 smx_cond_t simcall_cond_init()
 500 {
 501   return simcall_BODY_cond_init();
 502 }
 503
 504 /**
 505  * \ingroup simix_synchro_management
 506  *
 507  */
 508 void simcall_cond_signal(smx_cond_t cond)
 509 {
 510   simcall_BODY_cond_signal(cond);
 511 }
 512
 513 /**
 514  * \ingroup simix_synchro_management
 515  *
 516  */
 517 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
 518 {
 519   simcall_BODY_cond_wait(cond, mutex);
 520 }
 521
 522 /**
 523  * \ingroup simix_synchro_management
 524  *
 525  */
 526 void simcall_cond_wait_timeout(smx_cond_t cond,
 527                                  smx_mutex_t mutex,
 528                                  double timeout)
 529 {
 530   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 531   simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
 532 }
 533
 534 /**
 535  * \ingroup simix_synchro_management
 536  *
 537  */
 538 void simcall_cond_broadcast(smx_cond_t cond)
 539 {
 540   simcall_BODY_cond_broadcast(cond);
 541 }
 542
 543 /**
 544  * \ingroup simix_synchro_management
 545  *
 546  */
 547 smx_sem_t simcall_sem_init(int capacity)
 548 {
 549   return simcall_BODY_sem_init(capacity);
 550 }
 551
 552 /**
 553  * \ingroup simix_synchro_management
 554  *
 555  */
 556 void simcall_sem_release(smx_sem_t sem)
 557 {
 558   simcall_BODY_sem_release(sem);
 559 }
 560
 561 /**
 562  * \ingroup simix_synchro_management
 563  *
 564  */
 565 int simcall_sem_would_block(smx_sem_t sem)
 566 {
 567   return simcall_BODY_sem_would_block(sem);
 568 }
 569
 570 /**
 571  * \ingroup simix_synchro_management
 572  *
 573  */
 574 void simcall_sem_acquire(smx_sem_t sem)
 575 {
 576   simcall_BODY_sem_acquire(sem);
 577 }
 578
 579 /**
 580  * \ingroup simix_synchro_management
 581  *
 582  */
 583 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
 584 {
 585   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 586   simcall_BODY_sem_acquire_timeout(sem, timeout);
 587 }
 588
 589 /**
 590  * \ingroup simix_synchro_management
 591  *
 592  */
 593 int simcall_sem_get_capacity(smx_sem_t sem)
 594 {
 595   return simcall_BODY_sem_get_capacity(sem);
 596 }
 597
 598 /**
 599  * \ingroup simix_file_management
 600  *
 601  */
 602 sg_size_t simcall_file_read(surf_file_t fd, sg_size_t size)
 603 {
 604   return simcall_BODY_file_read(fd, size);
 605 }
 606
 607 /**
 608  * \ingroup simix_file_management
 609  *
 610  */
 611 sg_size_t simcall_file_write(surf_file_t fd, sg_size_t size)
 612 {
 613   return simcall_BODY_file_write(fd, size);
 614 }
 615
 616 void simcall_run_kernel(std::function<void()> const& code)
 617 {
 618   simcall_BODY_run_kernel(&code);
 619 }
 620
 621 void simcall_run_blocking(std::function<void()> const& code)
 622 {
 623   simcall_BODY_run_blocking(&code);
 624 }
 625
 626 int simcall_mc_random(int min, int max) {
 627   return simcall_BODY_mc_random(min, max);
 628 }
 629
 630 /* ************************************************************************** */
 631
 632 /** @brief returns a printable string representing a simcall */
 633 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
 634   return simcall_names[kind];
 635 }
 636
 637 namespace simgrid {
 638 namespace simix {
 639
 640 void unblock(smx_actor_t process)
 641 {
 642   xbt_assert(SIMIX_is_maestro());
 643   SIMIX_simcall_answer(&process->simcall);
 644 }
 645
 646 }
 647 }