src/kernel/activity/SynchroComm.cpp

   1 /* Copyright (c) 2007-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 #include "src/kernel/activity/SynchroComm.hpp"
   7 #include "src/surf/surf_interface.hpp"
   8 #include "src/simix/smx_network_private.h"
   9 #include "simgrid/modelchecker.h"
  10 #include "src/mc/mc_replay.h"
  11
  12 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_network);
  13
  14 simgrid::kernel::activity::Comm::Comm(e_smx_comm_type_t _type) : type(_type)
  15 {
  16   state = SIMIX_WAITING;
  17   src_data=nullptr;
  18   dst_data=nullptr;
  19
  20   XBT_DEBUG("Create communicate synchro %p", this);
  21 }
  22
  23 simgrid::kernel::activity::Comm::~Comm()
  24 {
  25   XBT_DEBUG("Really free communication %p", this);
  26
  27   cleanupSurf();
  28
  29   if (detached && state != SIMIX_DONE) {
  30     /* the communication has failed and was detached:
  31      * we have to free the buffer */
  32     if (clean_fun)
  33       clean_fun(src_buff);
  34     src_buff = nullptr;
  35   }
  36
  37   if(mbox)
  38     SIMIX_mbox_remove(mbox, this);
  39
  40 }
  41 void simgrid::kernel::activity::Comm::suspend()
  42 {
  43   /* FIXME: shall we suspend also the timeout synchro? */
  44   if (surf_comm)
  45     surf_comm->suspend();
  46   /* in the other case, the action will be suspended on creation, in SIMIX_comm_start() */
  47
  48 }
  49
  50 void simgrid::kernel::activity::Comm::resume()
  51 {
  52   /*FIXME: check what happen with the timeouts */
  53   if (surf_comm)
  54     surf_comm->resume();
  55   /* in the other case, the synchro were not really suspended yet, see SIMIX_comm_suspend() and SIMIX_comm_start() */
  56 }
  57
  58 void simgrid::kernel::activity::Comm::cancel()
  59 {
  60   /* if the synchro is a waiting state means that it is still in a mbox */
  61   /* so remove from it and delete it */
  62   if (state == SIMIX_WAITING) {
  63     SIMIX_mbox_remove(mbox, this);
  64     state = SIMIX_CANCELED;
  65   }
  66   else if (!MC_is_active() /* when running the MC there are no surf actions */
  67            && !MC_record_replay_is_active()
  68            && (state == SIMIX_READY || state == SIMIX_RUNNING)) {
  69
  70     surf_comm->cancel();
  71   }
  72 }
  73
  74 /**  @brief get the amount remaining from the communication */
  75 double simgrid::kernel::activity::Comm::remains()
  76 {
  77   switch (state) {
  78
  79   case SIMIX_RUNNING:
  80     return surf_comm->getRemains();
  81
  82   case SIMIX_WAITING:
  83   case SIMIX_READY:
  84   default:
  85     return 0; /*FIXME: check what should be returned */
  86   }
  87 }
  88
  89 /** @brief This is part of the cleanup process, probably an internal command */
  90 void simgrid::kernel::activity::Comm::cleanupSurf()
  91 {
  92   if (surf_comm){
  93     surf_comm->unref();
  94     surf_comm = nullptr;
  95   }
  96
  97   if (src_timeout){
  98     src_timeout->unref();
  99     src_timeout = nullptr;
 100   }
 101
 102   if (dst_timeout){
 103     dst_timeout->unref();
 104     dst_timeout = nullptr;
 105   }
 106 }
 107
 108 void simgrid::kernel::activity::Comm::post()
 109 {
 110   /* Update synchro state */
 111   if (src_timeout &&  src_timeout->getState() == simgrid::surf::Action::State::done)
 112     state = SIMIX_SRC_TIMEOUT;
 113   else if (dst_timeout && dst_timeout->getState() == simgrid::surf::Action::State::done)
 114     state = SIMIX_DST_TIMEOUT;
 115   else if (src_timeout && src_timeout->getState() == simgrid::surf::Action::State::failed)
 116     state = SIMIX_SRC_HOST_FAILURE;
 117   else if (dst_timeout && dst_timeout->getState() == simgrid::surf::Action::State::failed)
 118     state = SIMIX_DST_HOST_FAILURE;
 119   else if (surf_comm && surf_comm->getState() == simgrid::surf::Action::State::failed) {
 120     state = SIMIX_LINK_FAILURE;
 121   } else
 122     state = SIMIX_DONE;
 123
 124   XBT_DEBUG("SIMIX_post_comm: comm %p, state %d, src_proc %p, dst_proc %p, detached: %d",
 125             this, (int)state, src_proc, dst_proc, detached);
 126
 127   /* destroy the surf actions associated with the Simix communication */
 128   cleanupSurf();
 129
 130   /* if there are simcalls associated with the synchro, then answer them */
 131   if (!simcalls.empty())
 132     SIMIX_comm_finish(this);
 133 }