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