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