include/simgrid/s4u/comm.hpp

   1 /* Copyright (c) 2006-2016. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_S4U_COMM_HPP
   7 #define SIMGRID_S4U_COMM_HPP
   8
   9 #include <xbt/base.h>
  10
  11 #include <simgrid/s4u/Activity.hpp>
  12 #include <simgrid/s4u/forward.hpp>
  13 #include <simgrid/forward.h>
  14
  15
  16 namespace simgrid {
  17 namespace s4u {
  18
  19
  20 /** @brief Communication async
  21  *
  22  * Represents all asynchronous communications, that you can test or wait onto.
  23  */
  24 XBT_PUBLIC_CLASS Comm : public Activity {
  25   Comm() : Activity() {}
  26 public:
  27   ~Comm() override;
  28
  29   /*! take a range of s4u::Comm* (last excluded) and return when one of them is finished. The return value is an iterator on the finished Comms. */
  30   template<class I> static
  31   I wait_any(I first, I last)
  32   {
  33     // Map to dynar<Synchro*>:
  34     xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::ActivityImpl*), NULL);
  35     for(I iter = first; iter != last; iter++) {
  36       Comm& comm = **iter;
  37       if (comm.state_ == inited)
  38         comm.start();
  39       xbt_assert(comm.state_ == started);
  40       xbt_dynar_push_as(comms, simgrid::kernel::activity::ActivityImpl*, comm.pimpl_);
  41     }
  42     // Call the underlying simcall:
  43     int idx = simcall_comm_waitany(comms, -1);
  44     xbt_dynar_free(&comms);
  45     // Not found:
  46     if (idx == -1)
  47       return last;
  48     // Lift the index to the corresponding iterator:
  49     auto res = std::next(first, idx);
  50     (*res)->state_ = finished;
  51     return res;
  52   }
  53   /*! Same as wait_any, but with a timeout. If wait_any_for return because of the timeout last is returned.*/
  54   template<class I> static
  55   I wait_any_for(I first, I last, double timeout)
  56   {
  57     // Map to dynar<Synchro*>:
  58     xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::ActivityImpl*), NULL);
  59     for(I iter = first; iter != last; iter++) {
  60       Comm& comm = **iter;
  61       if (comm.state_ == inited)
  62         comm.start();
  63       xbt_assert(comm.state_ == started);
  64       xbt_dynar_push_as(comms, simgrid::kernel::activity::ActivityImpl*, comm.pimpl_);
  65     }
  66     // Call the underlying simcall:
  67     int idx = simcall_comm_waitany(comms, timeout);
  68     xbt_dynar_free(&comms);
  69     // Not found:
  70     if (idx == -1)
  71       return last;
  72     // Lift the index to the corresponding iterator:
  73     auto res = std::next(first, idx);
  74     (*res)->state_ = finished;
  75     return res;
  76   }
  77   /** Creates (but don't start) an async send to the mailbox @p dest */
  78   static Comm &send_init(MailboxPtr dest);
  79   /** Creates and start an async send to the mailbox @p dest */
  80   static Comm &send_async(MailboxPtr dest, void *data, int simulatedByteAmount);
  81     /** Creates (but don't start) an async recv onto the mailbox @p from */
  82   static Comm &recv_init(MailboxPtr from);
  83   /** Creates and start an async recv to the mailbox @p from */
  84   static Comm &recv_async(MailboxPtr from, void **data);
  85
  86   void start() override;
  87   void wait() override;
  88   void wait(double timeout) override;
  89
  90   /** Sets the maximal communication rate (in byte/sec). Must be done before start */
  91   void setRate(double rate);
  92
  93   /** Specify the data to send */
  94   void setSrcData(void * buff);
  95   /** Specify the size of the data to send */
  96   void setSrcDataSize(size_t size);
  97   /** Specify the data to send and its size */
  98   void setSrcData(void * buff, size_t size);
  99
 100   /** Specify where to receive the data */
 101   void setDstData(void ** buff);
 102   /** Specify the buffer in which the data should be received */
 103   void setDstData(void ** buff, size_t size);
 104   /** Retrieve the size of the received data */
 105   size_t getDstDataSize();
 106
 107   bool test();
 108
 109
 110 private:
 111   double rate_ = -1;
 112   void *dstBuff_ = nullptr;
 113   size_t dstBuffSize_ = 0;
 114   void *srcBuff_ = nullptr;
 115   size_t srcBuffSize_ = sizeof(void*);
 116
 117   /* FIXME: expose these elements in the API */
 118   int detached_ = 0;
 119   int (*matchFunction_)(void *, void *, smx_activity_t) = nullptr;
 120   void (*cleanFunction_)(void *) = nullptr;
 121   void (*copyDataFunction_)(smx_activity_t, void*, size_t) = nullptr;
 122
 123   smx_actor_t sender_ = nullptr;
 124   smx_actor_t receiver_ = nullptr;
 125   MailboxPtr mailbox_ = nullptr;
 126 };
 127
 128 }} // namespace simgrid::s4u
 129
 130 #endif /* SIMGRID_S4U_COMM_HPP */