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/mc/mc_forward.hpp"
  24 #include "src/mc/mc_replay.hpp"
  25 #include "src/plugins/vm/VirtualMachineImpl.hpp"
  26 #include "src/simix/smx_host_private.hpp"
  27 #include "xbt/ex.h"
  28 #include "xbt/functional.hpp"
  29
  30 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
  31
  32 #include "popping_bodies.cpp"
  33
  34 void simcall_call(smx_actor_t actor)
  35 {
  36   if (actor != simix_global->maestro_process) {
  37     XBT_DEBUG("Yield actor '%s' on simcall %s (%d)", actor->getCname(), SIMIX_simcall_name(actor->simcall.call),
  38               (int)actor->simcall.call);
  39     SIMIX_process_yield(actor);
  40   } else {
  41     SIMIX_simcall_handle(&actor->simcall, 0);
  42   }
  43 }
  44
  45 /**
  46  * \ingroup simix_process_management
  47  * \brief Creates a synchro that executes some computation of an host.
  48  *
  49  * This function creates a SURF action and allocates the data necessary
  50  * to create the SIMIX synchro. It can raise a host_error exception if the host crashed.
  51  *
  52  * \param name Name of the execution synchro to create
  53  * \param flops_amount amount Computation amount (in flops)
  54  * \param priority computation priority
  55  * \param bound
  56  * \return A new SIMIX execution synchronization
  57  */
  58 smx_activity_t simcall_execution_start(const char *name,
  59                                     double flops_amount,
  60                                     double priority, double bound)
  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);
  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::simix::kernelImmediate([execution] {
 114     XBT_DEBUG("Cancel synchro %p", execution.get());
 115     simgrid::kernel::activity::ExecImplPtr exec =
 116         boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
 117
 118     if (exec->surf_exec)
 119       exec->surf_exec->cancel();
 120   });
 121 }
 122
 123 /**
 124  * \ingroup simix_process_management
 125  * \brief Changes the priority of an execution synchro.
 126  *
 127  * This functions changes the priority only. It calls a surf function.
 128  * \param execution The execution synchro
 129  * \param priority The new priority
 130  */
 131 void simcall_execution_set_priority(smx_activity_t execution, double priority)
 132 {
 133   /* checking for infinite values */
 134   xbt_assert(std::isfinite(priority), "priority is not finite!");
 135   simgrid::simix::kernelImmediate([execution, priority] {
 136
 137     simgrid::kernel::activity::ExecImplPtr exec =
 138         boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
 139     if (exec->surf_exec)
 140       exec->surf_exec->setSharingWeight(priority);
 141   });
 142 }
 143
 144 /**
 145  * \ingroup simix_process_management
 146  * \brief Changes the capping (the maximum CPU utilization) of an execution synchro.
 147  *
 148  * This functions changes the capping only. It calls a surf function.
 149  * \param execution The execution synchro
 150  * \param bound The new bound
 151  */
 152 void simcall_execution_set_bound(smx_activity_t execution, double bound)
 153 {
 154   simgrid::simix::kernelImmediate([execution, bound] {
 155     simgrid::kernel::activity::ExecImplPtr exec =
 156         boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(execution);
 157     if (exec->surf_exec)
 158       static_cast<simgrid::surf::CpuAction*>(exec->surf_exec)->setBound(bound);
 159   });
 160 }
 161
 162 /**
 163  * \ingroup simix_host_management
 164  * \brief Waits for the completion of an execution synchro and destroy it.
 165  *
 166  * \param execution The execution synchro
 167  */
 168 e_smx_state_t simcall_execution_wait(smx_activity_t execution)
 169 {
 170   return (e_smx_state_t) simcall_BODY_execution_wait(execution);
 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->getCname(), process->host->getCname());
 245   process->kill_timer = SIMIX_timer_set(kill_time, [process] {
 246     simix_global->kill_process_function(process);
 247     process->kill_timer=nullptr;
 248   });
 249 }
 250
 251 /**
 252  * \ingroup simix_process_management
 253  * \brief Add an on_exit function
 254  * Add an on_exit function which will be executed when the process exits/is killed.
 255  */
 256 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data)
 257 {
 258   simcall_BODY_process_on_exit(process, fun, data);
 259 }
 260
 261 /**
 262  * \ingroup simix_process_management
 263  * \brief Creates a new sleep SIMIX synchro.
 264  *
 265  * This function creates a SURF action and allocates the data necessary
 266  * to create the SIMIX synchro. It can raise a host_error exception if the
 267  * host crashed. The default SIMIX name of the synchro is "sleep".
 268  *
 269  *   \param duration Time duration of the sleep.
 270  *   \return A result telling whether the sleep was successful
 271  */
 272 e_smx_state_t simcall_process_sleep(double duration)
 273 {
 274   /* checking for infinite values */
 275   xbt_assert(std::isfinite(duration), "duration is not finite!");
 276   return (e_smx_state_t) simcall_BODY_process_sleep(duration);
 277 }
 278
 279 /**
 280  * \ingroup simix_comm_management
 281  */
 282 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 283                        size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 284                        void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout)
 285 {
 286   /* checking for infinite values */
 287   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 288   xbt_assert(std::isfinite(rate), "rate is not finite!");
 289   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 290
 291   xbt_assert(mbox, "No rendez-vous point defined for send");
 292
 293   if (MC_is_active() || MC_record_replay_is_active()) {
 294     /* the model-checker wants two separate simcalls */
 295     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 296     comm = simcall_comm_isend(sender, mbox, task_size, rate,
 297         src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
 298     simcall_comm_wait(comm, timeout);
 299     comm = nullptr;
 300   }
 301   else {
 302     simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
 303                          match_fun, copy_data_fun, data, timeout);
 304   }
 305 }
 306
 307 /**
 308  * \ingroup simix_comm_management
 309  */
 310 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 311                                   size_t src_buff_size,
 312                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 313                                   void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t),
 314                                   void* data, int detached)
 315 {
 316   /* checking for infinite values */
 317   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 318   xbt_assert(std::isfinite(rate), "rate is not finite!");
 319
 320   xbt_assert(mbox, "No rendez-vous point defined for isend");
 321
 322   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
 323                                  src_buff_size, match_fun,
 324                                  clean_fun, copy_data_fun, data, detached);
 325 }
 326
 327 /**
 328  * \ingroup simix_comm_management
 329  */
 330 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 331                        int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 332                        void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate)
 333 {
 334   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 335   xbt_assert(mbox, "No rendez-vous point defined for recv");
 336
 337   if (MC_is_active() || MC_record_replay_is_active()) {
 338     /* the model-checker wants two separate simcalls */
 339     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 340     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 341                               match_fun, copy_data_fun, data, rate);
 342     simcall_comm_wait(comm, timeout);
 343     comm = nullptr;
 344   }
 345   else {
 346     simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
 347                            match_fun, copy_data_fun, data, timeout, rate);
 348   }
 349 }
 350 /**
 351  * \ingroup simix_comm_management
 352  */
 353 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 354                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 355                                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate)
 356 {
 357   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 358
 359   return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 360                                  match_fun, copy_data_fun, data, rate);
 361 }
 362
 363 /**
 364  * \ingroup simix_comm_management
 365  */
 366 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
 367                                    int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
 368 {
 369   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
 370
 371   return simcall_BODY_comm_iprobe(mbox, type, match_fun, data);
 372 }
 373
 374 /**
 375  * \ingroup simix_comm_management
 376  */
 377 void simcall_comm_cancel(smx_activity_t synchro)
 378 {
 379   simgrid::simix::kernelImmediate([synchro] {
 380     simgrid::kernel::activity::CommImplPtr comm =
 381         boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
 382     comm->cancel();
 383   });
 384 }
 385
 386 /**
 387  * \ingroup simix_comm_management
 388  */
 389 unsigned int simcall_comm_waitany(xbt_dynar_t comms, double timeout)
 390 {
 391   return simcall_BODY_comm_waitany(comms, timeout);
 392 }
 393
 394 /**
 395  * \ingroup simix_comm_management
 396  */
 397 int simcall_comm_testany(smx_activity_t* comms, size_t count)
 398 {
 399   if (count == 0)
 400     return -1;
 401   return simcall_BODY_comm_testany(comms, count);
 402 }
 403
 404 /**
 405  * \ingroup simix_comm_management
 406  */
 407 void simcall_comm_wait(smx_activity_t comm, double timeout)
 408 {
 409   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 410   simcall_BODY_comm_wait(comm, timeout);
 411 }
 412
 413 /**
 414  * \brief Set the category of an synchro.
 415  *
 416  * This functions changes the category only. It calls a surf function.
 417  * \param synchro The execution synchro
 418  * \param category The tracing category
 419  */
 420 void simcall_set_category(smx_activity_t synchro, const char *category)
 421 {
 422   if (category == nullptr) {
 423     return;
 424   }
 425   simcall_BODY_set_category(synchro, category);
 426 }
 427
 428 /**
 429  * \ingroup simix_comm_management
 430  *
 431  */
 432 int simcall_comm_test(smx_activity_t comm)
 433 {
 434   return simcall_BODY_comm_test(comm);
 435 }
 436
 437 /**
 438  * \ingroup simix_synchro_management
 439  *
 440  */
 441 smx_mutex_t simcall_mutex_init()
 442 {
 443   if (not simix_global) {
 444     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
 445     xbt_abort();
 446   }
 447   return simgrid::simix::kernelImmediate([] { return new simgrid::simix::MutexImpl(); });
 448 }
 449
 450 /**
 451  * \ingroup simix_synchro_management
 452  *
 453  */
 454 void simcall_mutex_lock(smx_mutex_t mutex)
 455 {
 456   simcall_BODY_mutex_lock(mutex);
 457 }
 458
 459 /**
 460  * \ingroup simix_synchro_management
 461  *
 462  */
 463 int simcall_mutex_trylock(smx_mutex_t mutex)
 464 {
 465   return simcall_BODY_mutex_trylock(mutex);
 466 }
 467
 468 /**
 469  * \ingroup simix_synchro_management
 470  *
 471  */
 472 void simcall_mutex_unlock(smx_mutex_t mutex)
 473 {
 474   simcall_BODY_mutex_unlock(mutex);
 475 }
 476
 477 /**
 478  * \ingroup simix_synchro_management
 479  *
 480  */
 481 smx_cond_t simcall_cond_init()
 482 {
 483   return simcall_BODY_cond_init();
 484 }
 485
 486 /**
 487  * \ingroup simix_synchro_management
 488  *
 489  */
 490 void simcall_cond_signal(smx_cond_t cond)
 491 {
 492   simcall_BODY_cond_signal(cond);
 493 }
 494
 495 /**
 496  * \ingroup simix_synchro_management
 497  *
 498  */
 499 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
 500 {
 501   simcall_BODY_cond_wait(cond, mutex);
 502 }
 503
 504 /**
 505  * \ingroup simix_synchro_management
 506  *
 507  */
 508 void simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
 509 {
 510   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 511   simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
 512 }
 513
 514 /**
 515  * \ingroup simix_synchro_management
 516  *
 517  */
 518 void simcall_cond_broadcast(smx_cond_t cond)
 519 {
 520   simcall_BODY_cond_broadcast(cond);
 521 }
 522
 523 /**
 524  * \ingroup simix_synchro_management
 525  *
 526  */
 527 void simcall_sem_acquire(smx_sem_t sem)
 528 {
 529   simcall_BODY_sem_acquire(sem);
 530 }
 531
 532 /**
 533  * \ingroup simix_synchro_management
 534  *
 535  */
 536 void simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
 537 {
 538   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 539   simcall_BODY_sem_acquire_timeout(sem, timeout);
 540 }
 541
 542 sg_size_t simcall_storage_read(surf_storage_t st, sg_size_t size)
 543 {
 544   return simcall_BODY_storage_read(st, size);
 545 }
 546
 547 sg_size_t simcall_storage_write(surf_storage_t st, sg_size_t size)
 548 {
 549   return simcall_BODY_storage_write(st, size);
 550 }
 551
 552 void simcall_run_kernel(std::function<void()> const& code)
 553 {
 554   simcall_BODY_run_kernel(&code);
 555 }
 556
 557 void simcall_run_blocking(std::function<void()> const& code)
 558 {
 559   simcall_BODY_run_blocking(&code);
 560 }
 561
 562 int simcall_mc_random(int min, int max) {
 563   return simcall_BODY_mc_random(min, max);
 564 }
 565
 566 /* ************************************************************************** */
 567
 568 /** @brief returns a printable string representing a simcall */
 569 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
 570   return simcall_names[kind];
 571 }
 572
 573 namespace simgrid {
 574 namespace simix {
 575
 576 void unblock(smx_actor_t process)
 577 {
 578   xbt_assert(SIMIX_is_maestro());
 579   SIMIX_simcall_answer(&process->simcall);
 580 }
 581
 582 }
 583 }