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-2022. 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/MutexImpl.hpp"
  17 #include "src/kernel/activity/SemaphoreImpl.hpp"
  18 #include "src/kernel/actor/SimcallObserver.hpp"
  19 #include "src/mc/mc_replay.hpp"
  20 #include "xbt/random.hpp"
  21 #include <simgrid/Exception.hpp>
  22
  23 #include "popping_bodies.cpp"
  24
  25 #include <boost/core/demangle.hpp>
  26 #include <string>
  27 #include <typeinfo>
  28
  29 /**
  30  * @ingroup simix_comm_management
  31  */
  32 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
  33                        size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  34                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
  35                        double timeout)
  36 {
  37   /* checking for infinite values */
  38   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
  39   xbt_assert(std::isfinite(rate), "rate is not finite!");
  40   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
  41
  42   xbt_assert(mbox, "No rendez-vous point defined for send");
  43
  44   if (MC_is_active() || MC_record_replay_is_active()) {
  45     /* the model-checker wants two separate simcalls, and wants comm to be nullptr during the simcall */
  46     simgrid::kernel::activity::ActivityImplPtr comm = nullptr;
  47
  48     simgrid::kernel::actor::CommIsendSimcall send_observer{
  49         sender,  mbox,          task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
  50         nullptr, copy_data_fun, data,      false};
  51     comm = simgrid::kernel::actor::simcall(
  52         [&send_observer] { return simgrid::kernel::activity::CommImpl::isend(&send_observer); }, &send_observer);
  53
  54     simgrid::kernel::actor::ActivityWaitSimcall wait_observer{sender, comm.get(), timeout};
  55     if (simgrid::kernel::actor::simcall_blocking(
  56             [&wait_observer] {
  57               wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
  58             },
  59             &wait_observer)) {
  60       throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
  61     }
  62     comm = nullptr;
  63   }
  64   else {
  65     simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
  66                            match_fun, copy_data_fun, data, timeout);
  67   }
  68 }
  69
  70 /**
  71  * @ingroup simix_comm_management
  72  */
  73 simgrid::kernel::activity::ActivityImplPtr
  74 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
  75                    size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  76                    void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
  77                    void* data, bool detached)
  78 {
  79   /* checking for infinite values */
  80   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
  81   xbt_assert(std::isfinite(rate), "rate is not finite!");
  82
  83   xbt_assert(mbox, "No rendez-vous point defined for isend");
  84
  85   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
  86                                  match_fun, clean_fun, copy_data_fun, data, detached);
  87 }
  88
  89 /**
  90  * @ingroup simix_comm_management
  91  */
  92 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
  93                        bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  94                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
  95                        double timeout, double rate)
  96 {
  97   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
  98   xbt_assert(mbox, "No rendez-vous point defined for recv");
  99
 100   if (MC_is_active() || MC_record_replay_is_active()) {
 101     /* the model-checker wants two separate simcalls, and wants comm to be nullptr during the simcall */
 102     simgrid::kernel::activity::ActivityImplPtr comm = nullptr;
 103
 104     simgrid::kernel::actor::CommIrecvSimcall observer{
 105         receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun, copy_data_fun, data, rate};
 106     comm = simgrid::kernel::actor::simcall(
 107         [&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); }, &observer);
 108
 109     simgrid::kernel::actor::ActivityWaitSimcall wait_observer{receiver, comm.get(), timeout};
 110     if (simgrid::kernel::actor::simcall_blocking(
 111             [&wait_observer] {
 112               wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
 113             },
 114             &wait_observer)) {
 115       throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
 116     }
 117     comm = nullptr;
 118   }
 119   else {
 120     simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
 121                            copy_data_fun, data, timeout, rate);
 122   }
 123 }
 124 /**
 125  * @ingroup simix_comm_management
 126  */
 127 simgrid::kernel::activity::ActivityImplPtr
 128 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 129                    bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 130                    void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate)
 131 {
 132   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 133
 134   return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
 135                                  copy_data_fun, data, rate);
 136 }
 137
 138 /**
 139  * @ingroup simix_comm_management
 140  */
 141 ssize_t simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
 142                              double timeout) // XBT_ATTRIB_DEPRECATED_v335
 143 {
 144   return simcall_BODY_comm_waitany(comms, count, timeout);
 145 }
 146
 147 /**
 148  * @ingroup simix_comm_management
 149  */
 150 ssize_t simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v335
 151 {
 152   if (count == 0)
 153     return -1;
 154   std::vector<simgrid::kernel::activity::ActivityImpl*> activities;
 155   for (size_t i = 0; i < count; i++)
 156     activities.push_back(static_cast<simgrid::kernel::activity::ActivityImpl*>(comms[i]));
 157
 158   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 159   simgrid::kernel::actor::ActivityTestanySimcall observer{issuer, activities};
 160   ssize_t changed_pos = simgrid::kernel::actor::simcall_blocking(
 161       [&observer] {
 162         simgrid::kernel::activity::ActivityImpl::test_any(observer.get_issuer(), observer.get_activities());
 163       },
 164       &observer);
 165   if (changed_pos != -1)
 166     comms[changed_pos]->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
 167   return changed_pos;
 168 }
 169
 170 /**
 171  * @ingroup simix_comm_management
 172  */
 173 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
 174 {
 175   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 176   simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm), timeout);
 177 }
 178
 179 /**
 180  * @ingroup simix_comm_management
 181  *
 182  */
 183 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm) // XBT_ATTRIB_DEPRECATED_v335
 184 {
 185   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 186   simgrid::kernel::actor::ActivityTestSimcall observer{issuer, comm};
 187   if (simgrid::kernel::actor::simcall_blocking([&observer] { observer.get_activity()->test(observer.get_issuer()); },
 188                                                &observer)) {
 189     comm->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
 190     return true;
 191   }
 192   return false;
 193 }
 194
 195 void simcall_run_kernel(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 196 {
 197   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 198   simcall_BODY_run_kernel(&code);
 199   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 200 }
 201
 202 void simcall_run_blocking(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 203 {
 204   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 205   simcall_BODY_run_blocking(&code);
 206   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 207 }
 208
 209 /* ************************************************************************** */
 210
 211 /** @brief returns a printable string representing a simcall */
 212 const char* SIMIX_simcall_name(const s_smx_simcall& simcall)
 213 {
 214   if (simcall.observer_ != nullptr) {
 215 #if SIMGRID_HAVE_MC
 216     if (mc_model_checker != nullptr) // Do not try to use the observer from the MCer
 217       return "(remotely observed)";
 218 #endif
 219
 220     static std::string name;
 221     name              = boost::core::demangle(typeid(*simcall.observer_).name());
 222     const char* cname = name.c_str();
 223     if (name.rfind("simgrid::kernel::", 0) == 0)
 224       cname += 17; // strip prefix "simgrid::kernel::"
 225     return cname;
 226   } else {
 227     return simcall_names.at(static_cast<int>(simcall.call_));
 228   }
 229 }
 230
 231 namespace simgrid {
 232 namespace simix {
 233
 234 void unblock(smx_actor_t actor)
 235 {
 236   xbt_assert(s4u::Actor::is_maestro());
 237   actor->simcall_answer();
 238 }
 239 } // namespace simix
 240 } // namespace simgrid