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-2021. 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 "src/kernel/activity/CommImpl.hpp"
  15 #include "src/kernel/activity/ConditionVariableImpl.hpp"
  16 #include "src/kernel/activity/ExecImpl.hpp"
  17 #include "src/kernel/activity/IoImpl.hpp"
  18 #include "src/kernel/activity/MailboxImpl.hpp"
  19 #include "src/kernel/activity/MutexImpl.hpp"
  20 #include "src/kernel/activity/SemaphoreImpl.hpp"
  21 #include "src/kernel/actor/SimcallObserver.hpp"
  22 #include "src/mc/mc_replay.hpp"
  23 #include "src/plugins/vm/VirtualMachineImpl.hpp"
  24 #include "xbt/random.hpp"
  25
  26 #include "popping_bodies.cpp"
  27
  28 #include <boost/core/demangle.hpp>
  29 #include <string>
  30 #include <typeinfo>
  31
  32 /**
  33  * @ingroup simix_host_management
  34  * @brief Waits for the completion of an execution synchro and destroy it.
  35  *
  36  * @param execution The execution synchro
  37  */
  38 simgrid::kernel::activity::State simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution,
  39                                                         double timeout) // XBT_ATTRIB_DEPRECATED_v330
  40 {
  41   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
  42   simgrid::kernel::actor::simcall_blocking([execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
  43   return simgrid::kernel::activity::State::DONE;
  44 }
  45
  46 simgrid::kernel::activity::State simcall_execution_wait(const simgrid::kernel::activity::ActivityImplPtr& execution,
  47                                                         double timeout) // XBT_ATTRIB_DEPRECATED_v330
  48 {
  49   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
  50   simgrid::kernel::actor::simcall_blocking([execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
  51   return simgrid::kernel::activity::State::DONE;
  52 }
  53
  54 bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution) // XBT_ATTRIB_DEPRECATED_v330
  55 {
  56   return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
  57 }
  58
  59 bool simcall_execution_test(const simgrid::kernel::activity::ActivityImplPtr& execution) // XBT_ATTRIB_DEPRECATED_v330
  60 {
  61   return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
  62 }
  63
  64 unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
  65                                            double timeout) // XBT_ATTRIB_DEPRECATED_v331
  66 {
  67   std::vector<simgrid::kernel::activity::ExecImpl*> execs_vec(execs, execs + count);
  68   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
  69   simgrid::kernel::actor::ExecutionWaitanySimcall observer{issuer, execs_vec, timeout};
  70   return simgrid::kernel::actor::simcall_blocking(
  71       [&observer] {
  72         simgrid::kernel::activity::ExecImpl::wait_any_for(observer.get_issuer(), observer.get_execs(),
  73                                                           observer.get_timeout());
  74       },
  75       &observer);
  76 }
  77
  78 /**
  79  * @ingroup simix_comm_management
  80  */
  81 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
  82                        size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  83                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
  84                        double timeout)
  85 {
  86   /* checking for infinite values */
  87   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
  88   xbt_assert(std::isfinite(rate), "rate is not finite!");
  89   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
  90
  91   xbt_assert(mbox, "No rendez-vous point defined for send");
  92
  93   if (MC_is_active() || MC_record_replay_is_active()) {
  94     /* the model-checker wants two separate simcalls */
  95     simgrid::kernel::activity::ActivityImplPtr comm =
  96         nullptr; /* MC needs the comm to be set to nullptr during the simcall */
  97     comm = simcall_comm_isend(sender, mbox, task_size, rate, src_buff, src_buff_size, match_fun, nullptr, copy_data_fun,
  98                               data, false);
  99     simcall_comm_wait(comm.get(), timeout);
 100     comm = nullptr;
 101   }
 102   else {
 103     simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
 104                            match_fun, copy_data_fun, data, timeout);
 105   }
 106 }
 107
 108 /**
 109  * @ingroup simix_comm_management
 110  */
 111 simgrid::kernel::activity::ActivityImplPtr
 112 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 113                    size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 114                    void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 115                    void* data, bool detached)
 116 {
 117   /* checking for infinite values */
 118   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 119   xbt_assert(std::isfinite(rate), "rate is not finite!");
 120
 121   xbt_assert(mbox, "No rendez-vous point defined for isend");
 122
 123   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
 124                                  match_fun, clean_fun, copy_data_fun, data, detached);
 125 }
 126
 127 /**
 128  * @ingroup simix_comm_management
 129  */
 130 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 131                        bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 132                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
 133                        double timeout, double rate)
 134 {
 135   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 136   xbt_assert(mbox, "No rendez-vous point defined for recv");
 137
 138   if (MC_is_active() || MC_record_replay_is_active()) {
 139     /* the model-checker wants two separate simcalls */
 140     simgrid::kernel::activity::ActivityImplPtr comm =
 141         nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 142     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 143                               match_fun, copy_data_fun, data, rate);
 144     simcall_comm_wait(comm.get(), timeout);
 145     comm = nullptr;
 146   }
 147   else {
 148     simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
 149                            copy_data_fun, data, timeout, rate);
 150   }
 151 }
 152 /**
 153  * @ingroup simix_comm_management
 154  */
 155 simgrid::kernel::activity::ActivityImplPtr
 156 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 157                    bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 158                    void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate)
 159 {
 160   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 161
 162   return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
 163                                  copy_data_fun, data, rate);
 164 }
 165
 166 /**
 167  * @ingroup simix_comm_management
 168  */
 169 simgrid::kernel::activity::ActivityImplPtr
 170 simcall_comm_iprobe(smx_mailbox_t mbox, int type, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 171                     void* data) // XBT_ATTRIB_DEPRECATED_v330
 172 {
 173   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
 174
 175   return simgrid::kernel::actor::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
 176 }
 177
 178 /**
 179  * @ingroup simix_comm_management
 180  */
 181 unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count,
 182                                   double timeout) // XBT_ATTRIB_DEPRECATED_v330
 183 {
 184   std::vector<simgrid::kernel::activity::CommImpl*> rcomms(count);
 185   std::transform(comms, comms + count, begin(rcomms), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
 186     return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
 187   });
 188   return static_cast<unsigned int>(simcall_BODY_comm_waitany(rcomms.data(), rcomms.size(), timeout));
 189 }
 190
 191 ssize_t simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout)
 192 {
 193   return simcall_BODY_comm_waitany(comms, count, timeout);
 194 }
 195
 196 /**
 197  * @ingroup simix_comm_management
 198  */
 199 int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v330
 200 {
 201   if (count == 0)
 202     return -1;
 203   std::vector<simgrid::kernel::activity::CommImpl*> rcomms(count);
 204   std::transform(comms, comms + count, begin(rcomms), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
 205     return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
 206   });
 207   return static_cast<int>(simcall_BODY_comm_testany(rcomms.data(), rcomms.size()));
 208 }
 209
 210 ssize_t simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count)
 211 {
 212   if (count == 0)
 213     return -1;
 214   return simcall_BODY_comm_testany(comms, count);
 215 }
 216
 217 /**
 218  * @ingroup simix_comm_management
 219  */
 220 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
 221 {
 222   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 223   simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm), timeout);
 224 }
 225
 226 /**
 227  * @ingroup simix_comm_management
 228  *
 229  */
 230 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm)
 231 {
 232   return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm));
 233 }
 234
 235 /**
 236  * @ingroup simix_synchro_management
 237  *
 238  */
 239 smx_mutex_t simcall_mutex_init() // XBT_ATTRIB_DEPRECATED_v330
 240 {
 241   return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
 242 }
 243
 244 /**
 245  * @ingroup simix_synchro_management
 246  *
 247  */
 248 void simcall_mutex_lock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
 249 {
 250   mutex->mutex().lock();
 251 }
 252
 253 /**
 254  * @ingroup simix_synchro_management
 255  *
 256  */
 257 int simcall_mutex_trylock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
 258 {
 259   return mutex->mutex().try_lock();
 260 }
 261
 262 /**
 263  * @ingroup simix_synchro_management
 264  *
 265  */
 266 void simcall_mutex_unlock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
 267 {
 268   mutex->mutex().unlock();
 269 }
 270
 271 /**
 272  * @ingroup simix_synchro_management
 273  *
 274  */
 275 smx_cond_t simcall_cond_init() // XBT_ATTRIB_DEPRECATED_v330
 276 {
 277   return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
 278 }
 279
 280 /**
 281  * @ingroup simix_synchro_management
 282  *
 283  */
 284 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATED_v331
 285 {
 286   cond->get_iface()->wait(std::unique_lock<simgrid::s4u::Mutex>(mutex->mutex()));
 287 }
 288
 289 /**
 290  * @ingroup simix_synchro_management
 291  *
 292  */
 293 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout) // XBT_ATTRIB_DEPRECATD_v331
 294 {
 295   return cond->get_iface()->wait_for(std::unique_lock<simgrid::s4u::Mutex>(mutex->mutex()), timeout) ==
 296          std::cv_status::timeout;
 297 }
 298
 299 /**
 300  * @ingroup simix_synchro_management
 301  *
 302  */
 303 void simcall_sem_acquire(smx_sem_t sem) // XBT_ATTRIB_DEPRECATD_v331
 304 {
 305   return sem->sem().acquire();
 306 }
 307
 308 /**
 309  * @ingroup simix_synchro_management
 310  *
 311  */
 312 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout) // XBT_ATTRIB_DEPRECATD_v331
 313 {
 314   return sem->sem().acquire_timeout(timeout);
 315 }
 316
 317 simgrid::kernel::activity::State simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io,
 318                                                  double timeout) // XBT_ATTRIB_DEPRECATED_v330
 319 {
 320   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 321   simgrid::kernel::actor::simcall_blocking([io, issuer, timeout] { io->wait_for(issuer, timeout); });
 322   return simgrid::kernel::activity::State::DONE;
 323 }
 324
 325 simgrid::kernel::activity::State simcall_io_wait(const simgrid::kernel::activity::ActivityImplPtr& io,
 326                                                  double timeout) // XBT_ATTRIB_DEPRECATED_v330
 327 {
 328   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 329   simgrid::kernel::actor::simcall_blocking([io, issuer, timeout] { io->wait_for(issuer, timeout); });
 330   return simgrid::kernel::activity::State::DONE;
 331 }
 332
 333 bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io) // XBT_ATTRIB_DEPRECATED_v330
 334 {
 335   return simgrid::kernel::actor::simcall([io] { return io->test(); });
 336 }
 337
 338 bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io) // XBT_ATTRIB_DEPRECATD_v330
 339 {
 340   return simgrid::kernel::actor::simcall([io] { return io->test(); });
 341 }
 342
 343 void simcall_run_kernel(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 344 {
 345   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 346   simcall_BODY_run_kernel(&code);
 347   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 348 }
 349
 350 void simcall_run_blocking(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 351 {
 352   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 353   simcall_BODY_run_blocking(&code);
 354   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 355 }
 356
 357 int simcall_mc_random(int min, int max) // XBT_ATTRIB_DEPRECATD_v331
 358 {
 359   return MC_random(min, max);
 360 }
 361
 362 /* ************************************************************************** */
 363
 364 /** @brief returns a printable string representing a simcall */
 365 const char* SIMIX_simcall_name(const s_smx_simcall& simcall)
 366 {
 367   if (simcall.observer_ != nullptr) {
 368     static std::string name;
 369     name              = boost::core::demangle(typeid(*simcall.observer_).name());
 370     const char* cname = name.c_str();
 371     if (name.rfind("simgrid::kernel::", 0) == 0)
 372       cname += 17; // strip prefix "simgrid::kernel::"
 373     return cname;
 374   } else {
 375     return simcall_names[static_cast<int>(simcall.call_)];
 376   }
 377 }
 378
 379 namespace simgrid {
 380 namespace simix {
 381
 382 void unblock(smx_actor_t actor)
 383 {
 384   xbt_assert(SIMIX_is_maestro());
 385   actor->simcall_answer();
 386 }
 387 } // namespace simix
 388 } // namespace simgrid