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-2019. The SimGrid Team. All rights reserved.          */
   9
  10 /* This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the license (GNU LGPL) which comes with this package. */
  12
  13 #include "mc/mc.h"
  14 #include "simgrid/simix/blocking_simcall.hpp"
  15 #include "src/kernel/activity/CommImpl.hpp"
  16 #include "src/kernel/activity/ConditionVariableImpl.hpp"
  17 #include "src/kernel/activity/ExecImpl.hpp"
  18 #include "src/kernel/activity/IoImpl.hpp"
  19 #include "src/kernel/activity/MailboxImpl.hpp"
  20 #include "src/kernel/activity/MutexImpl.hpp"
  21 #include "src/mc/mc_replay.hpp"
  22 #include "src/plugins/vm/VirtualMachineImpl.hpp"
  23 #include "src/simix/smx_host_private.hpp"
  24
  25 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
  26
  27 #include "popping_bodies.cpp"
  28
  29 /**
  30  * @ingroup simix_process_management
  31  * @brief Creates a synchro that may involve parallel computation on
  32  * several hosts and communication between them.
  33  *
  34  * @param name Name of the execution synchro to create
  35  * @param host_nb Number of hosts where the synchro will be executed
  36  * @param host_list Array (of size host_nb) of hosts where the synchro will be executed
  37  * @param flops_amount Array (of size host_nb) of computation amount of hosts (in bytes)
  38  * @param bytes_amount Array (of size host_nb * host_nb) representing the communication
  39  * amount between each pair of hosts
  40  * @param rate the SURF action rate
  41  * @param timeout timeout
  42  * @return A new SIMIX execution synchronization
  43  */
  44 smx_activity_t simcall_execution_parallel_start(const std::string& name, int host_nb, const sg_host_t* host_list,
  45                                                 const double* flops_amount, const double* bytes_amount, double rate,
  46                                                 double timeout)
  47 {
  48   /* Check that we are not mixing VMs and PMs in the parallel task */
  49   bool is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(host_list[0]));
  50   for (int i = 1; i < host_nb; i++) {
  51     bool tmp_is_a_vm = (nullptr != dynamic_cast<simgrid::s4u::VirtualMachine*>(host_list[i]));
  52     xbt_assert(is_a_vm == tmp_is_a_vm, "parallel_execute: mixing VMs and PMs is not supported (yet).");
  53   }
  54
  55   /* checking for infinite values */
  56   for (int i = 0 ; i < host_nb ; ++i) {
  57     if (flops_amount != nullptr)
  58       xbt_assert(std::isfinite(flops_amount[i]), "flops_amount[%d] is not finite!", i);
  59     if (bytes_amount != nullptr) {
  60       for (int j = 0 ; j < host_nb ; ++j) {
  61         xbt_assert(std::isfinite(bytes_amount[i + host_nb * j]),
  62                    "bytes_amount[%d+%d*%d] is not finite!", i, host_nb, j);
  63       }
  64     }
  65   }
  66
  67   xbt_assert(std::isfinite(rate), "rate is not finite!");
  68   return simgrid::simix::simcall([name, host_nb, host_list, flops_amount, bytes_amount, rate, timeout] {
  69     return SIMIX_execution_parallel_start(std::move(name), host_nb, host_list, flops_amount, bytes_amount, rate,
  70                                           timeout);
  71   });
  72 }
  73
  74 /**
  75  * @ingroup simix_host_management
  76  * @brief Waits for the completion of an execution synchro and destroy it.
  77  *
  78  * @param execution The execution synchro
  79  */
  80 e_smx_state_t simcall_execution_wait(const smx_activity_t& execution)
  81 {
  82   return (e_smx_state_t)simcall_BODY_execution_wait(static_cast<simgrid::kernel::activity::ExecImpl*>(execution.get()));
  83 }
  84
  85 e_smx_state_t simcall_execution_test(const smx_activity_t& execution)
  86 {
  87   return (e_smx_state_t)simcall_BODY_execution_test(static_cast<simgrid::kernel::activity::ExecImpl*>(execution.get()));
  88 }
  89
  90 void simcall_process_join(smx_actor_t process, double timeout)
  91 {
  92   simcall_BODY_process_join(process, timeout);
  93 }
  94
  95 /**
  96  * @ingroup simix_process_management
  97  * @brief Suspends an actor
  98  */
  99 void simcall_process_suspend(smx_actor_t process)
 100 {
 101   simcall_BODY_process_suspend(process);
 102 }
 103
 104 /**
 105  * @ingroup simix_process_management
 106  * @brief Creates a new sleep SIMIX synchro.
 107  *
 108  * This function creates a SURF action and allocates the data necessary
 109  * to create the SIMIX synchro. It can raise a HostFailureException if the
 110  * host crashed. The default SIMIX name of the synchro is "sleep".
 111  *
 112  *   @param duration Time duration of the sleep.
 113  *   @return A result telling whether the sleep was successful
 114  */
 115 e_smx_state_t simcall_process_sleep(double duration)
 116 {
 117   /* checking for infinite values */
 118   xbt_assert(std::isfinite(duration), "duration is not finite!");
 119   return (e_smx_state_t) simcall_BODY_process_sleep(duration);
 120 }
 121
 122 /**
 123  * @ingroup simix_comm_management
 124  */
 125 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 126                        size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 127                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
 128                        double timeout)
 129 {
 130   /* checking for infinite values */
 131   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 132   xbt_assert(std::isfinite(rate), "rate is not finite!");
 133   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 134
 135   xbt_assert(mbox, "No rendez-vous point defined for send");
 136
 137   if (MC_is_active() || MC_record_replay_is_active()) {
 138     /* the model-checker wants two separate simcalls */
 139     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 140     comm = simcall_comm_isend(sender, mbox, task_size, rate,
 141         src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, 0);
 142     simcall_comm_wait(comm, timeout);
 143     comm = nullptr;
 144   }
 145   else {
 146     simcall_BODY_comm_send(sender, mbox, task_size, rate, src_buff, src_buff_size,
 147                          match_fun, copy_data_fun, data, timeout);
 148   }
 149 }
 150
 151 /**
 152  * @ingroup simix_comm_management
 153  */
 154 smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 155                                   size_t src_buff_size,
 156                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 157                                   void (*clean_fun)(void*),
 158                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 159                                   void* data, int detached)
 160 {
 161   /* checking for infinite values */
 162   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 163   xbt_assert(std::isfinite(rate), "rate is not finite!");
 164
 165   xbt_assert(mbox, "No rendez-vous point defined for isend");
 166
 167   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, src_buff,
 168                                  src_buff_size, match_fun,
 169                                  clean_fun, copy_data_fun, data, detached);
 170 }
 171
 172 /**
 173  * @ingroup simix_comm_management
 174  */
 175 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 176                        int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 177                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
 178                        double timeout, double rate)
 179 {
 180   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 181   xbt_assert(mbox, "No rendez-vous point defined for recv");
 182
 183   if (MC_is_active() || MC_record_replay_is_active()) {
 184     /* the model-checker wants two separate simcalls */
 185     smx_activity_t comm = nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 186     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 187                               match_fun, copy_data_fun, data, rate);
 188     simcall_comm_wait(comm, timeout);
 189     comm = nullptr;
 190   }
 191   else {
 192     simcall_BODY_comm_recv(receiver, mbox, dst_buff, dst_buff_size,
 193                            match_fun, copy_data_fun, data, timeout, rate);
 194   }
 195 }
 196 /**
 197  * @ingroup simix_comm_management
 198  */
 199 smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 200                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 201                                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 202                                   void* data, double rate)
 203 {
 204   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 205
 206   return simcall_BODY_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 207                                  match_fun, copy_data_fun, data, rate);
 208 }
 209
 210 /**
 211  * @ingroup simix_comm_management
 212  */
 213 smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
 214                                    int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
 215 {
 216   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
 217
 218   return simgrid::simix::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
 219 }
 220
 221 /**
 222  * @ingroup simix_comm_management
 223  */
 224 unsigned int simcall_comm_waitany(smx_activity_t comms[], size_t count, double timeout)
 225 {
 226   std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
 227   std::transform(comms, comms + count, rcomms.get(), [](const smx_activity_t& comm) {
 228     return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
 229   });
 230   return simcall_BODY_comm_waitany(rcomms.get(), count, timeout);
 231 }
 232
 233 unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout)
 234 {
 235   return simcall_BODY_comm_waitany(comms, count, timeout);
 236 }
 237
 238 /**
 239  * @ingroup simix_comm_management
 240  */
 241 int simcall_comm_testany(smx_activity_t comms[], size_t count)
 242 {
 243   if (count == 0)
 244     return -1;
 245   std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
 246   std::transform(comms, comms + count, rcomms.get(), [](const smx_activity_t& comm) {
 247     return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
 248   });
 249   return simcall_BODY_comm_testany(rcomms.get(), count);
 250 }
 251
 252 int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count)
 253 {
 254   if (count == 0)
 255     return -1;
 256   return simcall_BODY_comm_testany(comms, count);
 257 }
 258
 259 /**
 260  * @ingroup simix_comm_management
 261  */
 262 void simcall_comm_wait(const smx_activity_t& comm, double timeout)
 263 {
 264   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 265   simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()), timeout);
 266 }
 267
 268 /**
 269  * @ingroup simix_comm_management
 270  *
 271  */
 272 int simcall_comm_test(const smx_activity_t& comm)
 273 {
 274   return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()));
 275 }
 276
 277 /**
 278  * @ingroup simix_synchro_management
 279  *
 280  */
 281 smx_mutex_t simcall_mutex_init()
 282 {
 283   if (simix_global == nullptr) {
 284     fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
 285                                                                                  // get there before the initialization
 286     xbt_abort();
 287   }
 288   return simgrid::simix::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
 289 }
 290
 291 /**
 292  * @ingroup simix_synchro_management
 293  *
 294  */
 295 void simcall_mutex_lock(smx_mutex_t mutex)
 296 {
 297   simcall_BODY_mutex_lock(mutex);
 298 }
 299
 300 /**
 301  * @ingroup simix_synchro_management
 302  *
 303  */
 304 int simcall_mutex_trylock(smx_mutex_t mutex)
 305 {
 306   return simcall_BODY_mutex_trylock(mutex);
 307 }
 308
 309 /**
 310  * @ingroup simix_synchro_management
 311  *
 312  */
 313 void simcall_mutex_unlock(smx_mutex_t mutex)
 314 {
 315   simcall_BODY_mutex_unlock(mutex);
 316 }
 317
 318 /**
 319  * @ingroup simix_synchro_management
 320  *
 321  */
 322 smx_cond_t simcall_cond_init()
 323 {
 324   return simgrid::simix::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
 325 }
 326
 327 /**
 328  * @ingroup simix_synchro_management
 329  *
 330  */
 331 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
 332 {
 333   simcall_BODY_cond_wait(cond, mutex);
 334 }
 335
 336 /**
 337  * @ingroup simix_synchro_management
 338  *
 339  */
 340 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
 341 {
 342   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 343   return simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
 344 }
 345
 346 /**
 347  * @ingroup simix_synchro_management
 348  *
 349  */
 350 void simcall_sem_acquire(smx_sem_t sem)
 351 {
 352   simcall_BODY_sem_acquire(sem);
 353 }
 354
 355 /**
 356  * @ingroup simix_synchro_management
 357  *
 358  */
 359 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
 360 {
 361   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 362   return simcall_BODY_sem_acquire_timeout(sem, timeout);
 363 }
 364
 365 e_smx_state_t simcall_io_wait(const smx_activity_t& io)
 366 {
 367   return (e_smx_state_t)simcall_BODY_io_wait(static_cast<simgrid::kernel::activity::IoImpl*>(io.get()));
 368 }
 369
 370 void simcall_run_kernel(std::function<void()> const& code)
 371 {
 372   simcall_BODY_run_kernel(&code);
 373 }
 374
 375 void simcall_run_blocking(std::function<void()> const& code)
 376 {
 377   simcall_BODY_run_blocking(&code);
 378 }
 379
 380 int simcall_mc_random(int min, int max) {
 381   return simcall_BODY_mc_random(min, max);
 382 }
 383
 384 /* ************************************************************************** */
 385
 386 /** @brief returns a printable string representing a simcall */
 387 const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
 388   return simcall_names[kind];
 389 }
 390
 391 namespace simgrid {
 392 namespace simix {
 393
 394 void unblock(smx_actor_t process)
 395 {
 396   xbt_assert(SIMIX_is_maestro());
 397   SIMIX_simcall_answer(&process->simcall);
 398 }
 399 } // namespace simix
 400 } // namespace simgrid
 401
 402 /* ****************************DEPRECATED CALLS******************************* */
 403 void simcall_process_set_kill_time(smx_actor_t process, double kill_time)
 404 {
 405   simgrid::simix::simcall([process, kill_time] { process->set_kill_time(kill_time); });
 406 }
 407 void simcall_comm_cancel(smx_activity_t comm)
 408 {
 409   simgrid::simix::simcall([comm] { boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(comm)->cancel(); });
 410 }
 411 void simcall_execution_cancel(smx_activity_t exec)
 412 {
 413   simgrid::simix::simcall([exec] { boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->cancel(); });
 414 }
 415 void simcall_execution_set_priority(smx_activity_t exec, double priority)
 416 {
 417   simgrid::simix::simcall([exec, priority] {
 418     boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->set_priority(priority);
 419   });
 420 }
 421
 422 void simcall_execution_set_bound(smx_activity_t exec, double bound)
 423 {
 424   simgrid::simix::simcall(
 425       [exec, bound] { boost::static_pointer_cast<simgrid::kernel::activity::ExecImpl>(exec)->set_bound(bound); });
 426 }
 427
 428 smx_activity_t simcall_execution_start(const std::string& name, const std::string& category, double flops_amount,
 429                                        double priority, double bound, sg_host_t host)
 430 {
 431   return simgrid::simix::simcall([name, category, flops_amount, priority, bound, host] {
 432     return simgrid::kernel::activity::ExecImplPtr(
 433                new simgrid::kernel::activity::ExecImpl(std::move(name), std::move(category)))
 434         ->set_host(host)
 435         ->start(flops_amount, priority, bound);
 436   });
 437 }
 438
 439 // deprecated
 440 void SIMIX_comm_finish(smx_activity_t synchro)
 441 {
 442   boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro)->finish();
 443 }