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