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_blocking(
  52         [&send_observer] {
  53           return simgrid::kernel::activity::CommImpl::isend(
  54               send_observer.get_issuer(), send_observer.get_mailbox(), send_observer.get_payload_size(),
  55               send_observer.get_rate(), send_observer.get_src_buff(), send_observer.get_src_buff_size(),
  56               send_observer.match_fun_, send_observer.clean_fun_, send_observer.copy_data_fun_,
  57               send_observer.get_payload(), send_observer.is_detached());
  58         },
  59         &send_observer);
  60
  61     simgrid::kernel::actor::ActivityWaitSimcall wait_observer{sender, comm.get(), timeout};
  62     if (simgrid::kernel::actor::simcall_blocking(
  63             [&wait_observer] {
  64               wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
  65             },
  66             &wait_observer)) {
  67       throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
  68     }
  69     comm = nullptr;
  70   }
  71   else {
  72     simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
  73                            match_fun, copy_data_fun, data, timeout);
  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   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
  93                                  match_fun, clean_fun, copy_data_fun, data, detached);
  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_blocking(
 114         [&observer] {
 115           return simgrid::kernel::activity::CommImpl::irecv(
 116               observer.get_issuer(), observer.get_mailbox(), observer.get_dst_buff(), observer.get_dst_buff_size(),
 117               observer.match_fun_, observer.copy_data_fun_, observer.get_payload(), observer.get_rate());
 118         },
 119         &observer);
 120
 121     simgrid::kernel::actor::ActivityWaitSimcall wait_observer{receiver, comm.get(), timeout};
 122     if (simgrid::kernel::actor::simcall_blocking(
 123             [&wait_observer] {
 124               wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
 125             },
 126             &wait_observer)) {
 127       throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
 128     }
 129     comm = nullptr;
 130   }
 131   else {
 132     simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
 133                            copy_data_fun, data, timeout, rate);
 134   }
 135 }
 136 /**
 137  * @ingroup simix_comm_management
 138  */
 139 simgrid::kernel::activity::ActivityImplPtr
 140 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 141                    bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 142                    void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate)
 143 {
 144   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 145
 146   return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
 147                                  copy_data_fun, data, rate);
 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   return simcall_BODY_comm_waitany(comms, count, timeout);
 157 }
 158
 159 /**
 160  * @ingroup simix_comm_management
 161  */
 162 ssize_t simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v335
 163 {
 164   if (count == 0)
 165     return -1;
 166   std::vector<simgrid::kernel::activity::ActivityImpl*> activities;
 167   for (size_t i = 0; i < count; i++)
 168     activities.push_back(static_cast<simgrid::kernel::activity::ActivityImpl*>(comms[i]));
 169
 170   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 171   simgrid::kernel::actor::ActivityTestanySimcall observer{issuer, activities};
 172   ssize_t changed_pos = simgrid::kernel::actor::simcall_blocking(
 173       [&observer] {
 174         simgrid::kernel::activity::ActivityImpl::test_any(observer.get_issuer(), observer.get_activities());
 175       },
 176       &observer);
 177   if (changed_pos != -1)
 178     comms[changed_pos]->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
 179   return changed_pos;
 180 }
 181
 182 /**
 183  * @ingroup simix_comm_management
 184  */
 185 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
 186 {
 187   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 188   simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm), timeout);
 189 }
 190
 191 /**
 192  * @ingroup simix_comm_management
 193  *
 194  */
 195 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm) // XBT_ATTRIB_DEPRECATED_v335
 196 {
 197   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 198   simgrid::kernel::actor::ActivityTestSimcall observer{issuer, comm};
 199   if (simgrid::kernel::actor::simcall_blocking([&observer] { observer.get_activity()->test(observer.get_issuer()); },
 200                                                &observer)) {
 201     comm->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
 202     return true;
 203   }
 204   return false;
 205 }
 206
 207 void simcall_run_kernel(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 208 {
 209   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 210   simcall_BODY_run_kernel(&code);
 211   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 212 }
 213
 214 void simcall_run_blocking(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 215 {
 216   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 217   simcall_BODY_run_blocking(&code);
 218   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 219 }
 220
 221 /* ************************************************************************** */
 222
 223 /** @brief returns a printable string representing a simcall */
 224 const char* SIMIX_simcall_name(const s_smx_simcall& simcall)
 225 {
 226   if (simcall.observer_ != nullptr) {
 227     static std::string name;
 228     name              = boost::core::demangle(typeid(*simcall.observer_).name());
 229     const char* cname = name.c_str();
 230     if (name.rfind("simgrid::kernel::", 0) == 0)
 231       cname += 17; // strip prefix "simgrid::kernel::"
 232     return cname;
 233   } else {
 234     return simcall_names[static_cast<int>(simcall.call_)];
 235   }
 236 }
 237
 238 namespace simgrid {
 239 namespace simix {
 240
 241 void unblock(smx_actor_t actor)
 242 {
 243   xbt_assert(s4u::Actor::is_maestro());
 244   actor->simcall_answer();
 245 }
 246 } // namespace simix
 247 } // namespace simgrid