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
  22 #include "popping_bodies.cpp"
  23
  24 #include <boost/core/demangle.hpp>
  25 #include <string>
  26 #include <typeinfo>
  27
  28 unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
  29                                            double timeout) // XBT_ATTRIB_DEPRECATED_v331
  30 {
  31   std::vector<simgrid::kernel::activity::ExecImpl*> execs_vec(execs, execs + count);
  32   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
  33   simgrid::kernel::actor::ExecutionWaitanySimcall observer{issuer, execs_vec, timeout};
  34   return simgrid::kernel::actor::simcall_blocking(
  35       [&observer] {
  36         simgrid::kernel::activity::ExecImpl::wait_any_for(observer.get_issuer(), observer.get_execs(),
  37                                                           observer.get_timeout());
  38       },
  39       &observer);
  40 }
  41
  42 /**
  43  * @ingroup simix_comm_management
  44  */
  45 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
  46                        size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  47                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
  48                        double timeout)
  49 {
  50   /* checking for infinite values */
  51   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
  52   xbt_assert(std::isfinite(rate), "rate is not finite!");
  53   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
  54
  55   xbt_assert(mbox, "No rendez-vous point defined for send");
  56
  57   if (MC_is_active() || MC_record_replay_is_active()) {
  58     /* the model-checker wants two separate simcalls */
  59     simgrid::kernel::activity::ActivityImplPtr comm =
  60         nullptr; /* MC needs the comm to be set to nullptr during the simcall */
  61     comm = simcall_comm_isend(sender, mbox, task_size, rate, src_buff, src_buff_size, match_fun, nullptr, copy_data_fun,
  62                               data, false);
  63     simcall_comm_wait(comm.get(), timeout);
  64     comm = nullptr;
  65   }
  66   else {
  67     simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
  68                            match_fun, copy_data_fun, data, timeout);
  69   }
  70 }
  71
  72 /**
  73  * @ingroup simix_comm_management
  74  */
  75 simgrid::kernel::activity::ActivityImplPtr
  76 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
  77                    size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  78                    void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
  79                    void* data, bool detached)
  80 {
  81   /* checking for infinite values */
  82   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
  83   xbt_assert(std::isfinite(rate), "rate is not finite!");
  84
  85   xbt_assert(mbox, "No rendez-vous point defined for isend");
  86
  87   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
  88                                  match_fun, clean_fun, copy_data_fun, data, detached);
  89 }
  90
  91 /**
  92  * @ingroup simix_comm_management
  93  */
  94 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
  95                        bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  96                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
  97                        double timeout, double rate)
  98 {
  99   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 100   xbt_assert(mbox, "No rendez-vous point defined for recv");
 101
 102   if (MC_is_active() || MC_record_replay_is_active()) {
 103     /* the model-checker wants two separate simcalls */
 104     simgrid::kernel::activity::ActivityImplPtr comm =
 105         nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 106     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 107                               match_fun, copy_data_fun, data, rate);
 108     simcall_comm_wait(comm.get(), timeout);
 109     comm = nullptr;
 110   }
 111   else {
 112     simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
 113                            copy_data_fun, data, timeout, rate);
 114   }
 115 }
 116 /**
 117  * @ingroup simix_comm_management
 118  */
 119 simgrid::kernel::activity::ActivityImplPtr
 120 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 121                    bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 122                    void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate)
 123 {
 124   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 125
 126   return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
 127                                  copy_data_fun, data, rate);
 128 }
 129
 130 /**
 131  * @ingroup simix_comm_management
 132  */
 133 ssize_t simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout)
 134 {
 135   return simcall_BODY_comm_waitany(comms, count, timeout);
 136 }
 137
 138 /**
 139  * @ingroup simix_comm_management
 140  */
 141 ssize_t simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count)
 142 {
 143   if (count == 0)
 144     return -1;
 145   return simcall_BODY_comm_testany(comms, count);
 146 }
 147
 148 /**
 149  * @ingroup simix_comm_management
 150  */
 151 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
 152 {
 153   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 154   simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm), timeout);
 155 }
 156
 157 /**
 158  * @ingroup simix_comm_management
 159  *
 160  */
 161 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm)
 162 {
 163   return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm));
 164 }
 165
 166 /**
 167  * @ingroup simix_synchro_management
 168  *
 169  */
 170 void simcall_mutex_lock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
 171 {
 172   mutex->mutex().lock();
 173 }
 174
 175 /**
 176  * @ingroup simix_synchro_management
 177  *
 178  */
 179 int simcall_mutex_trylock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
 180 {
 181   return mutex->mutex().try_lock();
 182 }
 183
 184 /**
 185  * @ingroup simix_synchro_management
 186  *
 187  */
 188 void simcall_mutex_unlock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
 189 {
 190   mutex->mutex().unlock();
 191 }
 192
 193 /**
 194  * @ingroup simix_synchro_management
 195  *
 196  */
 197 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATED_v331
 198 {
 199   cond->get_iface()->wait(std::unique_lock<simgrid::s4u::Mutex>(mutex->mutex()));
 200 }
 201
 202 /**
 203  * @ingroup simix_synchro_management
 204  *
 205  */
 206 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout) // XBT_ATTRIB_DEPRECATD_v331
 207 {
 208   return cond->get_iface()->wait_for(std::unique_lock<simgrid::s4u::Mutex>(mutex->mutex()), timeout) ==
 209          std::cv_status::timeout;
 210 }
 211
 212 /**
 213  * @ingroup simix_synchro_management
 214  *
 215  */
 216 void simcall_sem_acquire(smx_sem_t sem) // XBT_ATTRIB_DEPRECATD_v331
 217 {
 218   return sem->sem().acquire();
 219 }
 220
 221 /**
 222  * @ingroup simix_synchro_management
 223  *
 224  */
 225 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout) // XBT_ATTRIB_DEPRECATD_v331
 226 {
 227   return sem->sem().acquire_timeout(timeout);
 228 }
 229
 230 void simcall_run_kernel(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 231 {
 232   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 233   simcall_BODY_run_kernel(&code);
 234   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 235 }
 236
 237 void simcall_run_blocking(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 238 {
 239   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 240   simcall_BODY_run_blocking(&code);
 241   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 242 }
 243
 244 int simcall_mc_random(int min, int max) // XBT_ATTRIB_DEPRECATD_v331
 245 {
 246   return MC_random(min, max);
 247 }
 248
 249 /* ************************************************************************** */
 250
 251 /** @brief returns a printable string representing a simcall */
 252 const char* SIMIX_simcall_name(const s_smx_simcall& simcall)
 253 {
 254   if (simcall.observer_ != nullptr) {
 255     static std::string name;
 256     name              = boost::core::demangle(typeid(*simcall.observer_).name());
 257     const char* cname = name.c_str();
 258     if (name.rfind("simgrid::kernel::", 0) == 0)
 259       cname += 17; // strip prefix "simgrid::kernel::"
 260     return cname;
 261   } else {
 262     return simcall_names[static_cast<int>(simcall.call_)];
 263   }
 264 }
 265
 266 namespace simgrid {
 267 namespace simix {
 268
 269 void unblock(smx_actor_t actor)
 270 {
 271   xbt_assert(s4u::Actor::is_maestro());
 272   actor->simcall_answer();
 273 }
 274 } // namespace simix
 275 } // namespace simgrid