src/s4u/s4u_mailbox.cpp

   1 /* Copyright (c) 2006-2017. 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 #include "simgrid/s4u/Comm.hpp"
   7 #include "simgrid/s4u/Mailbox.hpp"
   8 #include "src/msg/msg_private.h"
   9 #include "src/simix/ActorImpl.hpp"
  10 #include "src/simix/smx_network_private.h"
  11 #include "xbt/log.h"
  12
  13 XBT_LOG_EXTERNAL_CATEGORY(s4u);
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_channel,s4u,"S4U Communication Mailboxes");
  15
  16 namespace simgrid {
  17 namespace s4u {
  18
  19 const char* Mailbox::getName()
  20 {
  21   return pimpl_->name_;
  22 }
  23
  24 MailboxPtr Mailbox::byName(const char*name)
  25 {
  26   kernel::activity::MailboxImpl* mbox = kernel::activity::MailboxImpl::byNameOrNull(name);
  27   if (mbox == nullptr) {
  28     mbox = simix::kernelImmediate([name] {
  29       return kernel::activity::MailboxImpl::byNameOrCreate(name);
  30     });
  31   }
  32   return MailboxPtr(&mbox->piface_, true);
  33 }
  34
  35 MailboxPtr Mailbox::byName(std::string name)
  36 {
  37   return byName(name.c_str());
  38 }
  39
  40 bool Mailbox::empty()
  41 {
  42   return pimpl_->comm_queue.empty();
  43 }
  44
  45 bool Mailbox::listen()
  46 {
  47   return not this->empty() || (pimpl_->permanent_receiver && not pimpl_->done_comm_queue.empty());
  48 }
  49
  50 smx_activity_t Mailbox::front()
  51 {
  52   return pimpl_->comm_queue.empty() ? nullptr : pimpl_->comm_queue.front();
  53 }
  54
  55 void Mailbox::setReceiver(ActorPtr actor) {
  56   simix::kernelImmediate([this, actor]() { this->pimpl_->setReceiver(actor); });
  57 }
  58
  59 /** @brief get the receiver (process associated to the mailbox) */
  60 ActorPtr Mailbox::getReceiver()
  61 {
  62   if (pimpl_->permanent_receiver == nullptr)
  63     return ActorPtr();
  64   return pimpl_->permanent_receiver->iface();
  65 }
  66
  67 CommPtr Mailbox::put_init()
  68 {
  69   CommPtr res   = CommPtr(new s4u::Comm());
  70   res->sender_  = SIMIX_process_self();
  71   res->mailbox_ = this;
  72   return res;
  73 }
  74 s4u::CommPtr Mailbox::put_init(void* data, uint64_t simulatedSize)
  75 {
  76   s4u::CommPtr res = put_init();
  77   res->setRemains(simulatedSize);
  78   res->srcBuff_     = data;
  79   res->srcBuffSize_ = sizeof(void*);
  80   return res;
  81 }
  82 s4u::CommPtr Mailbox::put_async(void* payload, uint64_t simulatedSize)
  83 {
  84   xbt_assert(payload != nullptr, "You cannot send nullptr");
  85
  86   s4u::CommPtr res = put_init(payload, simulatedSize);
  87   res->start();
  88   return res;
  89 }
  90 void Mailbox::put(void* payload, uint64_t simulatedSize)
  91 {
  92   xbt_assert(payload != nullptr, "You cannot send nullptr");
  93
  94   CommPtr c = put_init();
  95   c->setRemains(simulatedSize);
  96   c->setSrcData(payload);
  97   c->wait();
  98 }
  99 /** Blocking send with timeout */
 100 void Mailbox::put(void* payload, uint64_t simulatedSize, double timeout)
 101 {
 102   xbt_assert(payload != nullptr, "You cannot send nullptr");
 103
 104   CommPtr c = put_init();
 105   c->setRemains(simulatedSize);
 106   c->setSrcData(payload);
 107   // c->start() is optional.
 108   c->wait(timeout);
 109 }
 110
 111 s4u::CommPtr Mailbox::get_init()
 112 {
 113   CommPtr res    = CommPtr(new s4u::Comm());
 114   res->receiver_ = SIMIX_process_self();
 115   res->mailbox_  = this;
 116   return res;
 117 }
 118 s4u::CommPtr Mailbox::get_async(void** data)
 119 {
 120   s4u::CommPtr res = get_init();
 121   res->setDstData(data, sizeof(*data));
 122   res->start();
 123   return res;
 124 }
 125
 126 void* Mailbox::get()
 127 {
 128   void* res = nullptr;
 129   CommPtr c = get_init();
 130   c->setDstData(&res, sizeof(res));
 131   c->wait();
 132   return res;
 133 }
 134 void* Mailbox::get(double timeout)
 135 {
 136   void* res = nullptr;
 137   CommPtr c = get_init();
 138   c->setDstData(&res, sizeof(res));
 139   c->wait(timeout);
 140   return res;
 141 }
 142 }
 143 }