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 "src/kernel/EngineImpl.hpp"
  14 #include "src/kernel/activity/CommImpl.hpp"
  15 #include "src/kernel/actor/SimcallObserver.hpp"
  16 #include <simgrid/s4u/Activity.hpp>
  17
  18 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
  19
  20 /**
  21  * @ingroup simix_comm_management
  22  */
  23 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
  24                        size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  25                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
  26                        double timeout) // XBT_ATTRIB_DEPRECATED_v335
  27 {
  28   xbt_assert(mbox, "No rendez-vous point defined for send");
  29   simgrid::s4u::Comm::send(sender, mbox->get_iface(), task_size, rate, src_buff, src_buff_size, match_fun,
  30                            copy_data_fun, data, timeout);
  31 }
  32
  33 /**
  34  * @ingroup simix_comm_management
  35  */
  36 simgrid::kernel::activity::ActivityImplPtr
  37 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
  38                    size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  39                    void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
  40                    void* data, bool detached) // XBT_ATTRIB_DEPRECATED_v335
  41 {
  42   /* checking for infinite values */
  43   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
  44   xbt_assert(std::isfinite(rate), "rate is not finite!");
  45
  46   xbt_assert(mbox, "No rendez-vous point defined for isend");
  47
  48   simgrid::kernel::actor::CommIsendSimcall observer(sender, mbox, task_size, rate,
  49                                                     static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
  50                                                     clean_fun, copy_data_fun, data, detached);
  51   return simgrid::kernel::actor::simcall_answered(
  52       [&observer] { return simgrid::kernel::activity::CommImpl::isend(&observer); });
  53 }
  54
  55 /**
  56  * @ingroup simix_comm_management
  57  */
  58 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
  59                        bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  60                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
  61                        double timeout, double rate) // XBT_ATTRIB_DEPRECATED_v335
  62 {
  63   xbt_assert(mbox, "No rendez-vous point defined for recv");
  64   simgrid::s4u::Comm::recv(receiver, mbox->get_iface(), dst_buff, dst_buff_size, match_fun, copy_data_fun, data,
  65                            timeout, rate);
  66 }
  67
  68 /**
  69  * @ingroup simix_comm_management
  70  */
  71 simgrid::kernel::activity::ActivityImplPtr
  72 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
  73                    bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  74                    void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
  75                    double rate) // XBT_ATTRIB_DEPRECATED_v335
  76 {
  77   xbt_assert(mbox, "No rendez-vous point defined for irecv");
  78
  79   simgrid::kernel::actor::CommIrecvSimcall observer(receiver, mbox, static_cast<unsigned char*>(dst_buff),
  80                                                     dst_buff_size, match_fun, copy_data_fun, data, rate);
  81   return simgrid::kernel::actor::simcall_answered(
  82       [&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); });
  83 }
  84
  85 /**
  86  * @ingroup simix_comm_management
  87  */
  88 ssize_t simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
  89                              double timeout) // XBT_ATTRIB_DEPRECATED_v335
  90 {
  91   std::vector<simgrid::kernel::activity::ActivityImpl*> activities;
  92   for (size_t i = 0; i < count; i++)
  93     activities.push_back(static_cast<simgrid::kernel::activity::ActivityImpl*>(comms[i]));
  94   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
  95   simgrid::kernel::actor::ActivityWaitanySimcall observer{issuer, activities, timeout};
  96   ssize_t changed_pos = simgrid::kernel::actor::simcall_blocking(
  97       [&observer] {
  98         simgrid::kernel::activity::ActivityImpl::wait_any_for(observer.get_issuer(), observer.get_activities(),
  99                                                               observer.get_timeout());
 100       },
 101       &observer);
 102   if (changed_pos != -1)
 103     activities.at(changed_pos)->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
 104   return changed_pos;
 105 }
 106
 107 /**
 108  * @ingroup simix_comm_management
 109  */
 110 ssize_t simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v335
 111 {
 112   if (count == 0)
 113     return -1;
 114   std::vector<simgrid::kernel::activity::ActivityImpl*> activities;
 115   for (size_t i = 0; i < count; i++)
 116     activities.push_back(static_cast<simgrid::kernel::activity::ActivityImpl*>(comms[i]));
 117
 118   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 119   simgrid::kernel::actor::ActivityTestanySimcall observer{issuer, activities};
 120   ssize_t changed_pos = simgrid::kernel::actor::simcall_blocking(
 121       [&observer] {
 122         simgrid::kernel::activity::ActivityImpl::test_any(observer.get_issuer(), observer.get_activities());
 123       },
 124       &observer);
 125   if (changed_pos != -1)
 126     comms[changed_pos]->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
 127   return changed_pos;
 128 }
 129
 130 /**
 131  * @ingroup simix_comm_management
 132  */
 133 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout) // XBT_ATTRIB_DEPRECATED_v335
 134 {
 135   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
 136   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 137   simgrid::kernel::actor::simcall_blocking([issuer, comm, timeout] { comm->wait_for(issuer, timeout); });
 138 }
 139
 140 /**
 141  * @ingroup simix_comm_management
 142  *
 143  */
 144 bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm) // XBT_ATTRIB_DEPRECATED_v335
 145 {
 146   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 147   simgrid::kernel::actor::ActivityTestSimcall observer{issuer, comm};
 148   if (simgrid::kernel::actor::simcall_blocking([&observer] { observer.get_activity()->test(observer.get_issuer()); },
 149                                                &observer)) {
 150     comm->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
 151     return true;
 152   }
 153   return false;
 154 }
 155
 156 static void simcall(simgrid::simix::Simcall call, std::function<void()> const& code)
 157 {
 158   auto self = simgrid::kernel::actor::ActorImpl::self();
 159   self->simcall_.call_ = call;
 160   self->simcall_.code_ = &code;
 161   if (not simgrid::kernel::EngineImpl::get_instance()->is_maestro(self)) {
 162     XBT_DEBUG("Yield process '%s' on simcall %s", self->get_cname(), SIMIX_simcall_name(self->simcall_));
 163     self->yield();
 164   } else {
 165     self->simcall_handle(0);
 166   }
 167 }
 168
 169 void simcall_run_answered(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 170 {
 171   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 172   // The function `code` is called in kernel mode (either because we are already in maestor or after a context switch)
 173   // and simcall_answer() is called
 174   simcall(simgrid::simix::Simcall::RUN_ANSWERED, code);
 175   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 176 }
 177
 178 void simcall_run_blocking(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 179 {
 180   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
 181   // The function `code` is called in kernel mode (either because we are already in maestor or after a context switch)
 182   // BUT simcall_answer IS NOT CALLED
 183   simcall(simgrid::simix::Simcall::RUN_BLOCKING, code);
 184   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 185 }