-/* Copyright (c) 2006-2016. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#ifndef SIMGRID_S4U_COMM_HPP
#define SIMGRID_S4U_COMM_HPP
+#include <xbt/asserts.h>
#include <xbt/base.h>
+#include <xbt/dynar.h>
#include <simgrid/forward.h>
#include <simgrid/s4u/Activity.hpp>
-#include <simgrid/s4u/Mailbox.hpp> // DEPRECATED 3.17
#include <simgrid/s4u/forward.hpp>
+#include <simgrid/simix.h>
+#include <atomic>
#include <vector>
namespace simgrid {
*
* Represents all asynchronous communications, that you can test or wait onto.
*/
-XBT_PUBLIC_CLASS Comm : public Activity
-{
+class XBT_PUBLIC Comm : public Activity {
Comm() : Activity() {}
public:
- friend void intrusive_ptr_release(simgrid::s4u::Comm * c);
- friend void intrusive_ptr_add_ref(simgrid::s4u::Comm * c);
+ friend XBT_PUBLIC void intrusive_ptr_release(simgrid::s4u::Comm * c);
+ friend XBT_PUBLIC void intrusive_ptr_add_ref(simgrid::s4u::Comm * c);
friend Mailbox; // Factory of comms
virtual ~Comm();
- /*! take a range of s4u::CommPtr (last excluded) and return when one of them is finished. The return value is an
- * iterator on the finished Comms. */
+ /*! take a vector s4u::CommPtr and return when one of them is finished.
+ * The return value is the rank of the first finished CommPtr. */
static int wait_any(std::vector<CommPtr> * comms) { return wait_any_for(comms, -1); }
/*! Same as wait_any, but with a timeout. If the timeout occurs, parameter last is returned.*/
static int wait_any_for(std::vector<CommPtr> * comms_in, double timeout)
xbt_dynar_t comms = xbt_dynar_new(sizeof(simgrid::kernel::activity::ActivityImpl*), [](void*ptr){
intrusive_ptr_release(*(simgrid::kernel::activity::ActivityImpl**)ptr);
});
- for (auto comm : *comms_in) {
+ for (auto const& comm : *comms_in) {
if (comm->state_ == inited)
comm->start();
xbt_assert(comm->state_ == started);
xbt_dynar_free(&comms);
return idx;
}
- /** Creates (but don't start) an async send to the mailbox @p dest */
- static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::put_init") // 3.17
- send_init(MailboxPtr dest)
- {
- return dest->put_init();
- }
- /** Creates (but don't start) an async send to the mailbox @p dest */
- static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::put_init") // 3.17
- send_init(MailboxPtr dest, void* data, int simulatedByteAmount)
- {
- return dest->put_init(data, simulatedByteAmount);
- }
- /** Creates and start an async send to the mailbox @p dest */
- static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::put_async") // 3.17
- send_async(MailboxPtr dest, void* data, int simulatedByteAmount)
- {
- return dest->put_async(data, simulatedByteAmount);
- }
- /** Creates (but don't start) an async recv onto the mailbox @p from */
- static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::get_init") // 3.17
- recv_init(MailboxPtr from)
- {
- return from->get_init();
- }
- /** Creates and start an async recv to the mailbox @p from */
- static CommPtr XBT_ATTRIB_DEPRECATED("please use Mailbox::get_async") // 3.17
- recv_async(MailboxPtr from, void** data)
+
+ /*! take a vector s4u::CommPtr and return when all of them is finished. */
+ static void wait_all(std::vector<CommPtr> * comms)
{
- return from->get_async(data);
+ // TODO: this should be a simcall or something
+ // TODO: we are missing a version with timeout
+ for (CommPtr comm : *comms) {
+ comm->wait();
+ }
}
+ /*! take a vector s4u::CommPtr and return the rank of the first finished one (or -1 if none is done). */
+ static int test_any(std::vector<CommPtr> * comms);
- void start() override;
- void wait() override;
- void wait(double timeout) override;
+ Activity* start() override;
+ Activity* wait() override;
+ Activity* wait(double timeout) override;
/** Start the comm, and ignore its result. It can be completely forgotten after that. */
- void detach();
+ Activity* detach();
+ /** Start the comm, and ignore its result. It can be completely forgotten after that. */
+ Activity* detach(void (*cleanFunction)(void*))
+ {
+ cleanFunction_ = cleanFunction;
+ return detach();
+ }
/** Sets the maximal communication rate (in byte/sec). Must be done before start */
- void setRate(double rate);
+ Activity* setRate(double rate);
/** Specify the data to send */
- void setSrcData(void* buff);
+ Activity* setSrcData(void* buff);
/** Specify the size of the data to send */
- void setSrcDataSize(size_t size);
+ Activity* setSrcDataSize(size_t size);
/** Specify the data to send and its size */
- void setSrcData(void* buff, size_t size);
+ Activity* setSrcData(void* buff, size_t size);
/** Specify where to receive the data */
- void setDstData(void** buff);
+ Activity* setDstData(void** buff);
/** Specify the buffer in which the data should be received */
- void setDstData(void** buff, size_t size);
+ Activity* setDstData(void** buff, size_t size);
/** Retrieve the size of the received data */
size_t getDstDataSize();
bool test();
- void cancel();
+ Activity* cancel();
/** Retrieve the mailbox on which this comm acts */
- MailboxPtr mailbox();
+ MailboxPtr getMailbox();
private:
double rate_ = -1;