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