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