src/mc/transition/TransitionSynchro.cpp

   1 /* Copyright (c) 2015-2023. 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/mc/transition/TransitionSynchro.hpp"
   7 #include "xbt/asserts.h"
   8 #include "xbt/ex.h"
   9 #include "xbt/string.hpp"
  10
  11 #include <inttypes.h>
  12 #include <sstream>
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_trans_synchro, mc_transition, "Logging specific to MC synchronization transitions");
  15
  16 namespace simgrid::mc {
  17
  18 std::string BarrierTransition::to_string(bool verbose) const
  19 {
  20   return xbt::string_printf("%s(barrier: %u)", Transition::to_c_str(type_), bar_);
  21 }
  22 BarrierTransition::BarrierTransition(aid_t issuer, int times_considered, Type type, std::stringstream& stream)
  23     : Transition(type, issuer, times_considered)
  24 {
  25   xbt_assert(stream >> bar_);
  26 }
  27 bool BarrierTransition::depends(const Transition* o) const
  28 {
  29   if (o->type_ < type_)
  30     return o->depends(this);
  31
  32   if (auto* other = dynamic_cast<const BarrierTransition*>(o)) {
  33     if (bar_ != other->bar_)
  34       return false;
  35
  36     // LOCK indep LOCK: requests are not ordered in a barrier
  37     if (type_ == Type::BARRIER_ASYNC_LOCK && other->type_ == Type::BARRIER_ASYNC_LOCK)
  38       return false;
  39
  40     // WAIT indep WAIT: requests are not ordered
  41     if (type_ == Type::BARRIER_WAIT && other->type_ == Type::BARRIER_WAIT)
  42       return false;
  43
  44     return true; // LOCK/WAIT is dependent because lock may enable wait
  45   }
  46
  47   return false; // barriers are INDEP with non-barrier transitions
  48 }
  49
  50 std::string MutexTransition::to_string(bool verbose) const
  51 {
  52   return xbt::string_printf("%s(mutex: %" PRIxPTR ", owner: %ld)", Transition::to_c_str(type_), mutex_, owner_);
  53 }
  54
  55 MutexTransition::MutexTransition(aid_t issuer, int times_considered, Type type, std::stringstream& stream)
  56     : Transition(type, issuer, times_considered)
  57 {
  58   xbt_assert(stream >> mutex_ >> owner_);
  59 }
  60
  61 bool MutexTransition::depends(const Transition* o) const
  62 {
  63   if (o->type_ < type_)
  64     return o->depends(this);
  65
  66   // type_ <= other->type_ in  MUTEX_LOCK, MUTEX_TEST, MUTEX_TRYLOCK, MUTEX_UNLOCK, MUTEX_WAIT,
  67
  68   if (auto* other = dynamic_cast<const MutexTransition*>(o)) {
  69     // Theorem 4.4.7: Any pair of synchronization actions of distinct actors concerning distinct mutexes are independent
  70     if (mutex_ != other->mutex_)
  71       return false;
  72
  73     // Theorem 4.4.11: LOCK indep TEST/WAIT.
  74     //  If both enabled, the result does not depend on their order. If WAIT is not enabled, LOCK won't enable it.
  75     if (type_ == Type::MUTEX_ASYNC_LOCK && (other->type_ == Type::MUTEX_TEST || other->type_ == Type::MUTEX_WAIT))
  76       return false;
  77
  78     // Theorem 4.4.8: LOCK indep UNLOCK.
  79     //  pop_front and push_back are independent.
  80     if (type_ == Type::MUTEX_ASYNC_LOCK && other->type_ == Type::MUTEX_UNLOCK)
  81       return false;
  82
  83     // TEST is a pure function; TEST/WAIT won't change the owner; TRYLOCK will always fail if TEST is enabled (because a
  84     // request is queued)
  85     if (type_ == Type::MUTEX_TEST &&
  86         (other->type_ == Type::MUTEX_TEST || other->type_ == Type::MUTEX_TRYLOCK || other->type_ == Type::MUTEX_WAIT))
  87       return false;
  88
  89     // TRYLOCK will always fail if TEST is enabled (because a request is queued), and may not overpass the WAITed
  90     // request in the queue
  91     if (type_ == Type::MUTEX_TRYLOCK && other->type_ == Type::MUTEX_WAIT)
  92       return false;
  93
  94     // FIXME: UNLOCK indep WAIT/TEST iff wait/test are not first in the waiting queue
  95     return true;
  96   }
  97
  98   return false; // mutexes are INDEP with non-mutex transitions
  99 }
 100
 101 std::string SemaphoreTransition::to_string(bool verbose) const
 102 {
 103   if (type_ == Type::SEM_ASYNC_LOCK || type_ == Type::SEM_UNLOCK)
 104     return xbt::string_printf("%s(semaphore: %" PRIxPTR ")", Transition::to_c_str(type_), sem_);
 105   if (type_ == Type::SEM_WAIT)
 106     return xbt::string_printf("%s(semaphore: %" PRIxPTR ", granted: %s)", Transition::to_c_str(type_), sem_,
 107                               granted_ ? "yes" : "no");
 108   THROW_IMPOSSIBLE;
 109 }
 110 SemaphoreTransition::SemaphoreTransition(aid_t issuer, int times_considered, Type type, std::stringstream& stream)
 111     : Transition(type, issuer, times_considered)
 112 {
 113   xbt_assert(stream >> sem_ >> granted_);
 114 }
 115 bool SemaphoreTransition::depends(const Transition* o) const
 116 {
 117   if (o->type_ < type_)
 118     return o->depends(this);
 119
 120   if (auto* other = dynamic_cast<const SemaphoreTransition*>(o)) {
 121     if (sem_ != other->sem_)
 122       return false;
 123
 124     // LOCK indep UNLOCK: pop_front and push_back are independent.
 125     if (type_ == Type::SEM_ASYNC_LOCK && other->type_ == Type::SEM_UNLOCK)
 126       return false;
 127
 128     // LOCK indep WAIT: If both enabled, ordering has no impact on the result. If WAIT is not enabled, LOCK won't enable
 129     // it.
 130     if (type_ == Type::SEM_ASYNC_LOCK && other->type_ == Type::SEM_WAIT)
 131       return false;
 132
 133     // UNLOCK indep UNLOCK: ordering of two pop_front has no impact
 134     if (type_ == Type::SEM_UNLOCK && other->type_ == Type::SEM_UNLOCK)
 135       return false;
 136
 137     // WAIT indep WAIT:
 138     // if both enabled (may happen in the initial value is sufficient), the ordering has no impact on the result.
 139     // If only one enabled, the other won't be enabled by the first one.
 140     // If none enabled, well, nothing will change.
 141     if (type_ == Type::SEM_WAIT && other->type_ == Type::SEM_WAIT)
 142       return false;
 143
 144     return true; // Other semaphore cases are dependent
 145   }
 146
 147   return false; // semaphores are INDEP with non-semaphore transitions
 148 }
 149
 150 } // namespace simgrid::mc