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