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/EngineImpl.hpp"
  15 #include "src/kernel/activity/CommImpl.hpp"
  16 #include "src/kernel/activity/ConditionVariableImpl.hpp"
  17 #include "src/kernel/activity/MutexImpl.hpp"
  18 #include "src/kernel/activity/SemaphoreImpl.hpp"
  19 #include "src/kernel/actor/SimcallObserver.hpp"
  20 #include "src/mc/mc_replay.hpp"
  21 #include "xbt/random.hpp"
  22 #include <simgrid/Exception.hpp>
  23 #include <simgrid/s4u/Activity.hpp>
  24
  25 #include <boost/core/demangle.hpp>
  26 #include <string>
  27 #include <typeinfo>
  28
  29 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
  30
  31 /**
  32  * @ingroup simix_comm_management
  33  */
  34 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
  35                        size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  36                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
  37                        double timeout)
  38 {
  39   /* checking for infinite values */
  40   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
  41   xbt_assert(std::isfinite(rate), "rate is not finite!");
  42   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
  43
  44   xbt_assert(mbox, "No rendez-vous point defined for send");
  45
  46   if (MC_is_active() || MC_record_replay_is_active()) {
  47     /* the model-checker wants two separate simcalls, and wants comm to be nullptr during the simcall */
  48     simgrid::kernel::activity::ActivityImplPtr comm = nullptr;
  49
  50     simgrid::kernel::actor::CommIsendSimcall send_observer{
  51         sender,  mbox,          task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
  52         nullptr, copy_data_fun, data,      false};
  53     comm = simgrid::kernel::actor::simcall(
  54         [&send_observer] { return simgrid::kernel::activity::CommImpl::isend(&send_observer); }, &send_observer);
  55
  56     simgrid::kernel::actor::ActivityWaitSimcall wait_observer{sender, comm.get(), timeout};
  57     if (simgrid::kernel::actor::simcall_blocking(
  58             [&wait_observer] {
  59               wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
  60             },
  61             &wait_observer)) {
  62       throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
  63     }
  64     comm = nullptr;
  65   }
  66   else {
  67     simgrid::kernel::actor::CommIsendSimcall observer(sender, mbox, task_size, rate,
  68                                                       static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
  69                                                       nullptr, copy_data_fun, data, false);
  70     simgrid::kernel::actor::simcall_blocking([&observer, timeout] {
  71       simgrid::kernel::activity::ActivityImplPtr comm = simgrid::kernel::activity::CommImpl::isend(&observer);
  72       comm->wait_for(observer.get_issuer(), timeout);
  73     });
  74   }
  75 }
  76
  77 /**
  78  * @ingroup simix_comm_management
  79  */
  80 simgrid::kernel::activity::ActivityImplPtr
  81 simcall_comm_isend(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 (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
  84                    void* data, bool detached)
  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
  90   xbt_assert(mbox, "No rendez-vous point defined for isend");
  91
  92   simgrid::kernel::actor::CommIsendSimcall observer(sender, mbox, task_size, rate,
  93                                                     static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
  94                                                     clean_fun, copy_data_fun, data, detached);
  95   return simgrid::kernel::actor::simcall([&observer] { return simgrid::kernel::activity::CommImpl::isend(&observer); });
  96 }
  97
  98 /**
  99  * @ingroup simix_comm_management
 100  */
 101 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 102                        bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 103                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
 104                        double timeout, double rate)
 105 {
 106   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 107   xbt_assert(mbox, "No rendez-vous point defined for recv");
 108
 109   if (MC_is_active() || MC_record_replay_is_active()) {
 110     /* the model-checker wants two separate simcalls, and wants comm to be nullptr during the simcall */
 111     simgrid::kernel::activity::ActivityImplPtr comm = nullptr;
 112
 113     simgrid::kernel::actor::CommIrecvSimcall observer{
 114         receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun, copy_data_fun, data, rate};
 115     comm = simgrid::kernel::actor::simcall(
 116         [&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); }, &observer);
 117
 118     simgrid::kernel::actor::ActivityWaitSimcall wait_observer{receiver, comm.get(), timeout};
 119     if (simgrid::kernel::actor::simcall_blocking(
 120             [&wait_observer] {
 121               wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
 122             },
 123             &wait_observer)) {
 124       throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
 125     }
 126     comm = nullptr;
 127   }
 128   else {
 129     simgrid::kernel::actor::CommIrecvSimcall observer(receiver, mbox, static_cast<unsigned char*>(dst_buff),
 130                                                       dst_buff_size, match_fun, copy_data_fun, data, rate);
 131     simgrid::kernel::actor::simcall_blocking([&observer, timeout] {
 132       simgrid::kernel::activity::ActivityImplPtr comm = simgrid::kernel::activity::CommImpl::irecv(&observer);
 133       comm->wait_for(observer.get_issuer(), timeout);
 134     });
 135   }
 136 }
 137 /**
 138  * @ingroup simix_comm_management
 139  */
 140 simgrid::kernel::activity::ActivityImplPtr
 141 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 142                    bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 143                    void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate)
 144 {
 145   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 146
 147   simgrid::kernel::actor::CommIrecvSimcall observer(receiver, mbox, static_cast<unsigned char*>(dst_buff),
 148                                                     dst_buff_size, match_fun, copy_data_fun, data, rate);
 149   return simgrid::kernel::actor::simcall([&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); });
 150 }
 151
 152 /**
 153  * @ingroup simix_comm_management
 154  */
 155 ssize_t simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
 156                              double timeout) // XBT_ATTRIB_DEPRECATED_v335
 157 {
 158   std::vector<simgrid::kernel::activity::ActivityImpl*> activities;
 159   for (size_t i = 0; i < count; i++)
 160     activities.push_back(static_cast<simgrid::kernel::activity::ActivityImpl*>(comms[i]));
 161   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 162   simgrid::kernel::actor::ActivityWaitanySimcall observer{issuer, activities, timeout};
 163   ssize_t changed_pos = simgrid::kernel::actor::simcall_blocking(
 164       [&observer] {
 165         simgrid::kernel::activity::ActivityImpl::wait_any_for(observer.get_issuer(), observer.get_activities(),
 166                                                               observer.get_timeout());
 167       },
 168       &observer);
 169   if (changed_pos != -1)
 170     activities.at(changed_pos)->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
 171   return changed_pos;
 172 }
 173
 174 /**
 175  * @ingroup simix_comm_management
 176  */
 177 ssize_t simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v335
 178 {
 179   if (count == 0)
 180     return -1;
 181   std::vector<simgrid::kernel::activity::ActivityImpl*> activities;
 182   for (size_t i = 0; i < count; i++)
 183     activities.push_back(static_cast<simgrid::kernel::activity::ActivityImpl*>(comms[i]));
 184
 185   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 186   simgrid::kernel::actor::ActivityTestanySimcall observer{issuer, activities};
 187   ssize_t changed_pos = simgrid::kernel::actor::simcall_blocking(
 188       [&observer] {
 189         simgrid::kernel::activity::ActivityImpl::test_any(observer.get_issuer(), observer.get_activities());
 190       },
 191       &observer);
 192   if (changed_pos != -1)
 193     comms[changed_pos]->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
 194   return changed_pos;
 195 }
 196
 197 /**
 198  * @ingroup simix_comm_management
 199  */
 200 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
 201 {
 202   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 203
 204   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 205
 206   simgrid::kernel::actor::simcall_blocking([issuer, comm, timeout] { comm->wait_for(issuer, timeout); });
 207 }
 208
 209 /**
 210  * @ingroup simix_comm_management
 211  *
 212  */
 213 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm) // XBT_ATTRIB_DEPRECATED_v335
 214 {
 215   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 216   simgrid::kernel::actor::ActivityTestSimcall observer{issuer, comm};
 217   if (simgrid::kernel::actor::simcall_blocking([&observer] { observer.get_activity()->test(observer.get_issuer()); },
 218                                                &observer)) {
 219     comm->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
 220     return true;
 221   }
 222   return false;
 223 }
 224
 225 static void simcall(simgrid::simix::Simcall call, std::function<void()> const& code)
 226 {
 227   auto self = simgrid::kernel::actor::ActorImpl::self();
 228   self->simcall_.call_ = call;
 229   self->simcall_.code_ = &code;
 230   if (not simgrid::kernel::EngineImpl::get_instance()->is_maestro(self)) {
 231     XBT_DEBUG("Yield process '%s' on simcall %s", self->get_cname(), SIMIX_simcall_name(self->simcall_));
 232     self->yield();
 233   } else {
 234     self->simcall_handle(0);
 235   }
 236 }
 237
 238 void simcall_run_kernel(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 239 {
 240   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 241   // The function `code` is called in kernel mode (either because we are already in maestor or after a context switch)
 242   // and simcall_answer() is called
 243   simcall(simgrid::simix::Simcall::RUN_ANSWERED, code);
 244   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 245 }
 246
 247 void simcall_run_blocking(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 248 {
 249   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 250   // The function `code` is called in kernel mode (either because we are already in maestor or after a context switch)
 251   // BUT simcall_answer IS NOT CALLED
 252   simcall(simgrid::simix::Simcall::RUN_BLOCKING, code);
 253   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 254 }
 255
 256 /* ************************************************************************** */
 257
 258 namespace simgrid {
 259 namespace simix {
 260
 261 void unblock(smx_actor_t actor)
 262 {
 263   xbt_assert(s4u::Actor::is_maestro());
 264   actor->simcall_answer();
 265 }
 266 } // namespace simix
 267 } // namespace simgrid