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