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