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