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     simgrid::kernel::actor::CommIsendSimcall observer(sender, mbox, task_size, rate,
  66                                                       static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
  67                                                       nullptr, copy_data_fun, data, false);
  68     simgrid::kernel::actor::simcall_blocking([&observer, timeout] {
  69       simgrid::kernel::activity::ActivityImplPtr comm = simgrid::kernel::activity::CommImpl::isend(&observer);
  70       comm->wait_for(observer.get_issuer(), timeout);
  71     });
  72   }
  73 }
  74
  75 /**
  76  * @ingroup simix_comm_management
  77  */
  78 simgrid::kernel::activity::ActivityImplPtr
  79 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
  80                    size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  81                    void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
  82                    void* data, bool detached)
  83 {
  84   /* checking for infinite values */
  85   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
  86   xbt_assert(std::isfinite(rate), "rate is not finite!");
  87
  88   xbt_assert(mbox, "No rendez-vous point defined for isend");
  89
  90   simgrid::kernel::actor::CommIsendSimcall observer(sender, mbox, task_size, rate,
  91                                                     static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
  92                                                     clean_fun, copy_data_fun, data, detached);
  93   return simgrid::kernel::actor::simcall([&observer] { return simgrid::kernel::activity::CommImpl::isend(&observer); });
  94 }
  95
  96 /**
  97  * @ingroup simix_comm_management
  98  */
  99 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 100                        bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 101                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
 102                        double timeout, double rate)
 103 {
 104   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 105   xbt_assert(mbox, "No rendez-vous point defined for recv");
 106
 107   if (MC_is_active() || MC_record_replay_is_active()) {
 108     /* the model-checker wants two separate simcalls, and wants comm to be nullptr during the simcall */
 109     simgrid::kernel::activity::ActivityImplPtr comm = nullptr;
 110
 111     simgrid::kernel::actor::CommIrecvSimcall observer{
 112         receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun, copy_data_fun, data, rate};
 113     comm = simgrid::kernel::actor::simcall(
 114         [&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); }, &observer);
 115
 116     simgrid::kernel::actor::ActivityWaitSimcall wait_observer{receiver, comm.get(), timeout};
 117     if (simgrid::kernel::actor::simcall_blocking(
 118             [&wait_observer] {
 119               wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
 120             },
 121             &wait_observer)) {
 122       throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
 123     }
 124     comm = nullptr;
 125   }
 126   else {
 127     simgrid::kernel::actor::CommIrecvSimcall observer(receiver, mbox, static_cast<unsigned char*>(dst_buff),
 128                                                       dst_buff_size, match_fun, copy_data_fun, data, rate);
 129     simgrid::kernel::actor::simcall_blocking([&observer, timeout] {
 130       simgrid::kernel::activity::ActivityImplPtr comm = simgrid::kernel::activity::CommImpl::irecv(&observer);
 131       comm->wait_for(observer.get_issuer(), timeout);
 132     });
 133   }
 134 }
 135 /**
 136  * @ingroup simix_comm_management
 137  */
 138 simgrid::kernel::activity::ActivityImplPtr
 139 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 140                    bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 141                    void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate)
 142 {
 143   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 144
 145   simgrid::kernel::actor::CommIrecvSimcall observer(receiver, mbox, static_cast<unsigned char*>(dst_buff),
 146                                                     dst_buff_size, match_fun, copy_data_fun, data, rate);
 147   return simgrid::kernel::actor::simcall([&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); });
 148 }
 149
 150 /**
 151  * @ingroup simix_comm_management
 152  */
 153 ssize_t simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
 154                              double timeout) // XBT_ATTRIB_DEPRECATED_v335
 155 {
 156   std::vector<simgrid::kernel::activity::ActivityImpl*> activities;
 157   for (size_t i = 0; i < count; i++)
 158     activities.push_back(static_cast<simgrid::kernel::activity::ActivityImpl*>(comms[i]));
 159   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 160   simgrid::kernel::actor::ActivityWaitanySimcall observer{issuer, activities, timeout};
 161   ssize_t changed_pos = simgrid::kernel::actor::simcall_blocking(
 162       [&observer] {
 163         simgrid::kernel::activity::ActivityImpl::wait_any_for(observer.get_issuer(), observer.get_activities(),
 164                                                               observer.get_timeout());
 165       },
 166       &observer);
 167   if (changed_pos != -1)
 168     activities.at(changed_pos)->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
 169   return changed_pos;
 170 }
 171
 172 /**
 173  * @ingroup simix_comm_management
 174  */
 175 ssize_t simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v335
 176 {
 177   if (count == 0)
 178     return -1;
 179   std::vector<simgrid::kernel::activity::ActivityImpl*> activities;
 180   for (size_t i = 0; i < count; i++)
 181     activities.push_back(static_cast<simgrid::kernel::activity::ActivityImpl*>(comms[i]));
 182
 183   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 184   simgrid::kernel::actor::ActivityTestanySimcall observer{issuer, activities};
 185   ssize_t changed_pos = simgrid::kernel::actor::simcall_blocking(
 186       [&observer] {
 187         simgrid::kernel::activity::ActivityImpl::test_any(observer.get_issuer(), observer.get_activities());
 188       },
 189       &observer);
 190   if (changed_pos != -1)
 191     comms[changed_pos]->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
 192   return changed_pos;
 193 }
 194
 195 /**
 196  * @ingroup simix_comm_management
 197  */
 198 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
 199 {
 200   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 201
 202   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 203
 204   simgrid::kernel::actor::simcall_blocking([issuer, comm, timeout] { comm->wait_for(issuer, timeout); });
 205 }
 206
 207 /**
 208  * @ingroup simix_comm_management
 209  *
 210  */
 211 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm) // XBT_ATTRIB_DEPRECATED_v335
 212 {
 213   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 214   simgrid::kernel::actor::ActivityTestSimcall observer{issuer, comm};
 215   if (simgrid::kernel::actor::simcall_blocking([&observer] { observer.get_activity()->test(observer.get_issuer()); },
 216                                                &observer)) {
 217     comm->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
 218     return true;
 219   }
 220   return false;
 221 }
 222
 223 void simcall_run_kernel(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 224 {
 225   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 226   simcall_BODY_run_kernel(&code);
 227   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 228 }
 229
 230 void simcall_run_blocking(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 231 {
 232   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 233   simcall_BODY_run_blocking(&code);
 234   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 235 }
 236
 237 /* ************************************************************************** */
 238
 239 /** @brief returns a printable string representing a simcall */
 240 const char* SIMIX_simcall_name(const s_smx_simcall& simcall)
 241 {
 242   if (simcall.observer_ != nullptr) {
 243 #if SIMGRID_HAVE_MC
 244     if (mc_model_checker != nullptr) // Do not try to use the observer from the MCer
 245       return "(remotely observed)";
 246 #endif
 247
 248     static std::string name;
 249     name              = boost::core::demangle(typeid(*simcall.observer_).name());
 250     const char* cname = name.c_str();
 251     if (name.rfind("simgrid::kernel::", 0) == 0)
 252       cname += 17; // strip prefix "simgrid::kernel::"
 253     return cname;
 254   } else {
 255     return simcall_names.at(static_cast<int>(simcall.call_));
 256   }
 257 }
 258
 259 namespace simgrid {
 260 namespace simix {
 261
 262 void unblock(smx_actor_t actor)
 263 {
 264   xbt_assert(s4u::Actor::is_maestro());
 265   actor->simcall_answer();
 266 }
 267 } // namespace simix
 268 } // namespace simgrid