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-2021. 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 "simgrid/simix/blocking_simcall.hpp"
  15 #include "src/kernel/activity/CommImpl.hpp"
  16 #include "src/kernel/activity/ConditionVariableImpl.hpp"
  17 #include "src/kernel/activity/ExecImpl.hpp"
  18 #include "src/kernel/activity/IoImpl.hpp"
  19 #include "src/kernel/activity/MailboxImpl.hpp"
  20 #include "src/kernel/activity/MutexImpl.hpp"
  21 #include "src/kernel/activity/SemaphoreImpl.hpp"
  22 #include "src/mc/checker/SimcallObserver.hpp"
  23 #include "src/mc/mc_replay.hpp"
  24 #include "src/plugins/vm/VirtualMachineImpl.hpp"
  25 #include "xbt/random.hpp"
  26
  27 #include "popping_bodies.cpp"
  28
  29 /**
  30  * @ingroup simix_host_management
  31  * @brief Waits for the completion of an execution synchro and destroy it.
  32  *
  33  * @param execution The execution synchro
  34  */
  35 simgrid::kernel::activity::State simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution,
  36                                                         double timeout) // XBT_ATTRIB_DEPRECATED_v330
  37 {
  38   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
  39   simgrid::kernel::actor::simcall_blocking<void>(
  40       [execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
  41   return simgrid::kernel::activity::State::DONE;
  42 }
  43
  44 simgrid::kernel::activity::State simcall_execution_wait(const simgrid::kernel::activity::ActivityImplPtr& execution,
  45                                                         double timeout) // XBT_ATTRIB_DEPRECATED_v330
  46 {
  47   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
  48   simgrid::kernel::actor::simcall_blocking<void>(
  49       [execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
  50   return simgrid::kernel::activity::State::DONE;
  51 }
  52
  53 bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution) // XBT_ATTRIB_DEPRECATED_v330
  54 {
  55   return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
  56 }
  57
  58 bool simcall_execution_test(const simgrid::kernel::activity::ActivityImplPtr& execution) // XBT_ATTRIB_DEPRECATED_v330
  59 {
  60   return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
  61 }
  62
  63 unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count,
  64                                            double timeout) // XBT_ATTRIB_DEPRECATED_v331
  65 {
  66   std::vector<simgrid::kernel::activity::ExecImpl*> execsv(execs, execs + count);
  67   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
  68   simgrid::mc::ExecutionWaitanySimcall observer{issuer, &execsv, timeout};
  69   simgrid::kernel::actor::simcall_blocking<void>(
  70       [&observer] {
  71         simgrid::kernel::activity::ExecImpl::wait_any_for(observer.get_issuer(), observer.get_execs(),
  72                                                           observer.get_timeout());
  73       },
  74       &observer);
  75   return observer.get_result();
  76 }
  77
  78 void simcall_process_join(smx_actor_t process, double timeout) // XBT_ATTRIB_DEPRECATED_v328
  79 {
  80   simgrid::kernel::actor::ActorImpl::self()->join(process, timeout);
  81 }
  82
  83 void simcall_process_suspend(smx_actor_t process) // XBT_ATTRIB_DEPRECATED_v328
  84 {
  85   process->get_iface()->suspend();
  86 }
  87
  88 simgrid::kernel::activity::State simcall_process_sleep(double duration) // XBT_ATTRIB_DEPRECATED_v329
  89 {
  90   simgrid::kernel::actor::ActorImpl::self()->sleep(duration);
  91   return simgrid::kernel::activity::State::DONE;
  92 }
  93
  94 /**
  95  * @ingroup simix_comm_management
  96  */
  97 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
  98                        size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  99                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
 100                        double timeout)
 101 {
 102   /* checking for infinite values */
 103   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 104   xbt_assert(std::isfinite(rate), "rate is not finite!");
 105   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 106
 107   xbt_assert(mbox, "No rendez-vous point defined for send");
 108
 109   if (MC_is_active() || MC_record_replay_is_active()) {
 110     /* the model-checker wants two separate simcalls */
 111     simgrid::kernel::activity::ActivityImplPtr comm =
 112         nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 113     comm = simcall_comm_isend(sender, mbox, task_size, rate, src_buff, src_buff_size, match_fun, nullptr, copy_data_fun,
 114                               data, false);
 115     simcall_comm_wait(comm.get(), timeout);
 116     comm = nullptr;
 117   }
 118   else {
 119     simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
 120                            match_fun, copy_data_fun, data, timeout);
 121   }
 122 }
 123
 124 /**
 125  * @ingroup simix_comm_management
 126  */
 127 simgrid::kernel::activity::ActivityImplPtr
 128 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
 129                    size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 130                    void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 131                    void* data, bool detached)
 132 {
 133   /* checking for infinite values */
 134   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
 135   xbt_assert(std::isfinite(rate), "rate is not finite!");
 136
 137   xbt_assert(mbox, "No rendez-vous point defined for isend");
 138
 139   return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
 140                                  match_fun, clean_fun, copy_data_fun, data, detached);
 141 }
 142
 143 /**
 144  * @ingroup simix_comm_management
 145  */
 146 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 147                        bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 148                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
 149                        double timeout, double rate)
 150 {
 151   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 152   xbt_assert(mbox, "No rendez-vous point defined for recv");
 153
 154   if (MC_is_active() || MC_record_replay_is_active()) {
 155     /* the model-checker wants two separate simcalls */
 156     simgrid::kernel::activity::ActivityImplPtr comm =
 157         nullptr; /* MC needs the comm to be set to nullptr during the simcall */
 158     comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
 159                               match_fun, copy_data_fun, data, rate);
 160     simcall_comm_wait(comm.get(), timeout);
 161     comm = nullptr;
 162   }
 163   else {
 164     simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
 165                            copy_data_fun, data, timeout, rate);
 166   }
 167 }
 168 /**
 169  * @ingroup simix_comm_management
 170  */
 171 simgrid::kernel::activity::ActivityImplPtr
 172 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
 173                    bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 174                    void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate)
 175 {
 176   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 177
 178   return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
 179                                  copy_data_fun, data, rate);
 180 }
 181
 182 /**
 183  * @ingroup simix_comm_management
 184  */
 185 simgrid::kernel::activity::ActivityImplPtr
 186 simcall_comm_iprobe(smx_mailbox_t mbox, int type, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 187                     void* data) // XBT_ATTRIB_DEPRECATED_v330
 188 {
 189   xbt_assert(mbox, "No rendez-vous point defined for iprobe");
 190
 191   return simgrid::kernel::actor::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
 192 }
 193
 194 /**
 195  * @ingroup simix_comm_management
 196  */
 197 unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count,
 198                                   double timeout) // XBT_ATTRIB_DEPRECATED_v330
 199 {
 200   std::vector<simgrid::kernel::activity::CommImpl*> rcomms(count);
 201   std::transform(comms, comms + count, begin(rcomms), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
 202     return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
 203   });
 204   return simcall_BODY_comm_waitany(rcomms.data(), rcomms.size(), timeout);
 205 }
 206
 207 unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout)
 208 {
 209   return simcall_BODY_comm_waitany(comms, count, timeout);
 210 }
 211
 212 /**
 213  * @ingroup simix_comm_management
 214  */
 215 int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v330
 216 {
 217   if (count == 0)
 218     return -1;
 219   std::vector<simgrid::kernel::activity::CommImpl*> rcomms(count);
 220   std::transform(comms, comms + count, begin(rcomms), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
 221     return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
 222   });
 223   return simcall_BODY_comm_testany(rcomms.data(), rcomms.size());
 224 }
 225
 226 int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count)
 227 {
 228   if (count == 0)
 229     return -1;
 230   return simcall_BODY_comm_testany(comms, count);
 231 }
 232
 233 /**
 234  * @ingroup simix_comm_management
 235  */
 236 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
 237 {
 238   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 239   simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm), timeout);
 240 }
 241
 242 /**
 243  * @ingroup simix_comm_management
 244  *
 245  */
 246 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm)
 247 {
 248   return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm));
 249 }
 250
 251 /**
 252  * @ingroup simix_synchro_management
 253  *
 254  */
 255 smx_mutex_t simcall_mutex_init() // XBT_ATTRIB_DEPRECATED_v330
 256 {
 257   if (simix_global == nullptr) {
 258     fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
 259                                                                                  // get there before the initialization
 260     xbt_abort();
 261   }
 262   return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
 263 }
 264
 265 /**
 266  * @ingroup simix_synchro_management
 267  *
 268  */
 269 void simcall_mutex_lock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
 270 {
 271   mutex->mutex().lock();
 272 }
 273
 274 /**
 275  * @ingroup simix_synchro_management
 276  *
 277  */
 278 int simcall_mutex_trylock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
 279 {
 280   return mutex->mutex().try_lock();
 281 }
 282
 283 /**
 284  * @ingroup simix_synchro_management
 285  *
 286  */
 287 void simcall_mutex_unlock(smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATD_v331
 288 {
 289   mutex->mutex().unlock();
 290 }
 291
 292 /**
 293  * @ingroup simix_synchro_management
 294  *
 295  */
 296 smx_cond_t simcall_cond_init() // XBT_ATTRIB_DEPRECATED_v330
 297 {
 298   return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
 299 }
 300
 301 /**
 302  * @ingroup simix_synchro_management
 303  *
 304  */
 305 void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex) // XBT_ATTRIB_DEPRECATED_v331
 306 {
 307   cond->get_iface()->wait(std::unique_lock<simgrid::s4u::Mutex>(mutex->mutex()));
 308 }
 309
 310 /**
 311  * @ingroup simix_synchro_management
 312  *
 313  */
 314 int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout) // XBT_ATTRIB_DEPRECATD_v331
 315 {
 316   return cond->get_iface()->wait_for(std::unique_lock<simgrid::s4u::Mutex>(mutex->mutex()), timeout) ==
 317          std::cv_status::timeout;
 318 }
 319
 320 /**
 321  * @ingroup simix_synchro_management
 322  *
 323  */
 324 void simcall_sem_acquire(smx_sem_t sem) // XBT_ATTRIB_DEPRECATD_v331
 325 {
 326   return sem->sem().acquire();
 327 }
 328
 329 /**
 330  * @ingroup simix_synchro_management
 331  *
 332  */
 333 int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout) // XBT_ATTRIB_DEPRECATD_v331
 334 {
 335   return sem->sem().acquire_timeout(timeout);
 336 }
 337
 338 simgrid::kernel::activity::State simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io,
 339                                                  double timeout) // XBT_ATTRIB_DEPRECATED_v330
 340 {
 341   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 342   simgrid::kernel::actor::simcall_blocking<void>([io, issuer, timeout] { io->wait_for(issuer, timeout); });
 343   return simgrid::kernel::activity::State::DONE;
 344 }
 345
 346 simgrid::kernel::activity::State simcall_io_wait(const simgrid::kernel::activity::ActivityImplPtr& io,
 347                                                  double timeout) // XBT_ATTRIB_DEPRECATED_v330
 348 {
 349   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 350   simgrid::kernel::actor::simcall_blocking<void>([io, issuer, timeout] { io->wait_for(issuer, timeout); });
 351   return simgrid::kernel::activity::State::DONE;
 352 }
 353
 354 bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io) // XBT_ATTRIB_DEPRECATED_v330
 355 {
 356   return simgrid::kernel::actor::simcall([io] { return io->test(); });
 357 }
 358
 359 bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io) // XBT_ATTRIB_DEPRECATD_v330
 360 {
 361   return simgrid::kernel::actor::simcall([io] { return io->test(); });
 362 }
 363
 364 void simcall_run_kernel(std::function<void()> const& code, simgrid::mc::SimcallObserver* observer)
 365 {
 366   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 367   simcall_BODY_run_kernel(&code);
 368   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 369 }
 370
 371 void simcall_run_blocking(std::function<void()> const& code, simgrid::mc::SimcallObserver* observer)
 372 {
 373   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 374   simcall_BODY_run_blocking(&code);
 375   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 376 }
 377
 378 int simcall_mc_random(int min, int max) // XBT_ATTRIB_DEPRECATD_v331
 379 {
 380   return MC_random(min, max);
 381 }
 382
 383 /* ************************************************************************** */
 384
 385 /** @brief returns a printable string representing a simcall */
 386 const char* SIMIX_simcall_name(Simcall kind)
 387 {
 388   return simcall_names[static_cast<int>(kind)];
 389 }
 390
 391 namespace simgrid {
 392 namespace simix {
 393
 394 void unblock(smx_actor_t actor)
 395 {
 396   xbt_assert(SIMIX_is_maestro());
 397   actor->simcall_answer();
 398 }
 399 } // namespace simix
 400 } // namespace simgrid