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