mutex_test.cc 7.37 KB
Newer Older
1
/*
2
 * Copyright (c) 2014-2015, Siemens AG. All rights reserved.
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
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include <mutex_test.h>
#include <embb/base/mutex.h>
#include <embb/base/thread.h>
#include <iostream>

namespace embb {
namespace base {
namespace test {
MutexTest::MutexTest() : mutex_(), counter_(0),
    number_threads_(partest::TestSuite::GetDefaultNumThreads()),
    number_iterations_(partest::TestSuite::GetDefaultNumIterations()) {
  CreateUnit("Mutex protected counter")
      .Pre(&MutexTest::PreMutexCount, this)
      .Add(&MutexTest::TestMutexCount, this, number_threads_,
          number_iterations_)
      .Post(&MutexTest::PostMutexCount, this);
  CreateUnit("Recursive mutex")
      .Add(&MutexTest::TestRecursiveMutex, this);
  CreateUnit("Lock guard protected counter")
      .Pre(&MutexTest::PreLockGuardCount, this)
      .Add(&MutexTest::TestLockGuardCount, this, number_threads_,
          number_iterations_)
      .Post(&MutexTest::PostLockGuardCount, this);
  CreateUnit("Unique Lock").Add(&MutexTest::TestUniqueLock, this);
}

void MutexTest::PreMutexCount() {
  counter_ = 0;
}

void MutexTest::TestMutexCount() {
  mutex_.Lock();
  ++counter_;
  mutex_.Unlock();
}

void MutexTest::PostMutexCount() {
  PT_EXPECT_EQ((size_t)counter_, number_iterations_ * number_threads_);
}

void MutexTest::TestRecursiveMutex() {
  embb::base::RecursiveMutex mutex;
  int number = 5;
  for (int i = 0; i < number; i++) {
    mutex.Lock();
    bool obtained = mutex.TryLock();
    PT_EXPECT_EQ(obtained, true);
  }
  for (int i = 0; i < number; i++) {
    mutex.Unlock();
    mutex.Unlock();
  }
}

void MutexTest::PreLockGuardCount() {
  counter_ = 0;
}

void MutexTest::TestLockGuardCount() {
  LockGuard<Mutex> guard(mutex_);
  ++counter_;
}

void MutexTest::PostLockGuardCount() {
  PT_EXPECT_EQ((size_t)counter_, number_iterations_ * number_threads_);
}

void MutexTest::TestUniqueLock() {
95
  { // Test standard usage and releasing
96
#ifdef EMBB_USE_EXCEPTIONS
97
    bool exception_thrown = false;
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 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
#endif
    UniqueLock<Mutex> lock(mutex_);
    PT_EXPECT_EQ(lock.OwnsLock(), true);

#ifdef EMBB_USE_EXCEPTIONS
    // Locked lock should not by re-lockable
    EMBB_TRY {
      lock.Lock();
    }
    EMBB_CATCH(ErrorException&) {
      exception_thrown = true;
    }
    PT_EXPECT_EQ(exception_thrown, true);

    // Locked lock should not by re-try-lockable
    EMBB_TRY {
      lock.TryLock();
    }
    EMBB_CATCH(ErrorException&) {
      exception_thrown = true;
    }
    PT_EXPECT_EQ(exception_thrown, true);
#endif // EMBB_USE_EXCEPTIONS

    lock.Unlock();
    PT_EXPECT_EQ(lock.OwnsLock(), false);

#ifdef EMBB_USE_EXCEPTIONS
    // Unlocked lock should not by re-unlockable
    exception_thrown = false;
    EMBB_TRY {
      lock.Unlock();
    }
    EMBB_CATCH(ErrorException&) {
      exception_thrown = true;
    }
    PT_EXPECT_EQ(exception_thrown, true);
#endif // EMBB_USE_EXCEPTIONS

    lock.Lock();
    PT_EXPECT_EQ(lock.OwnsLock(), true);

    lock.Release()->Unlock();
    PT_EXPECT_EQ(lock.OwnsLock(), false);

#ifdef EMBB_USE_EXCEPTIONS
    // Released lock should not by lockable
    exception_thrown = false;
    EMBB_TRY {
      lock.Lock();
    }
    EMBB_CATCH(ErrorException&) {
      exception_thrown = true;
    }
    PT_EXPECT_EQ(exception_thrown, true);

    // Released lock should not by try-lockable
    exception_thrown = false;
    EMBB_TRY {
      lock.TryLock();
    }
    EMBB_CATCH(ErrorException&) {
      exception_thrown = true;
    }
    PT_EXPECT_EQ(exception_thrown, true);

    // Released lock should not by unlockable
    exception_thrown = false;
    EMBB_TRY {
      lock.Unlock();
    }
    EMBB_CATCH(ErrorException&) {
      exception_thrown = true;
    }
    PT_EXPECT_EQ(exception_thrown, true);
#endif // EMBB_USE_EXCEPTIONS
  }

  { // Test deferred lock construction
    UniqueLock<> lock(mutex_, embb::base::defer_lock);
    PT_EXPECT_EQ(lock.OwnsLock(), false);
  }

  { // Test try-lock construction
    UniqueLock<> lock(mutex_, embb::base::try_lock);
    PT_EXPECT_EQ(lock.OwnsLock(), true);
  }

  { // Test adopt lock construction
    mutex_.Lock();
    UniqueLock<> lock(mutex_, embb::base::adopt_lock);
    PT_EXPECT_EQ(lock.OwnsLock(), true);
  }

  { // Test lock swapping
193
    UniqueLock<> lock1(mutex_);
194
    PT_EXPECT_EQ(lock1.OwnsLock(), true);
195 196

    {
197 198
      UniqueLock<> lock2;
      PT_EXPECT_EQ(lock2.OwnsLock(), false);
199 200

      lock1.Swap(lock2);
201
      PT_EXPECT_EQ(lock1.OwnsLock(), false);
202 203 204
      PT_EXPECT_EQ(lock2.OwnsLock(), true);
    }

205 206
    // At this point, "lock2" was destroyed and "mutex_" must be unlocked.
    UniqueLock<> lock3(mutex_, embb::base::try_lock);
207
    PT_EXPECT_EQ(lock3.OwnsLock(), true);
208 209 210
  }
}

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
SpinLockTest::SpinLockTest() : spinlock_(), counter_(0),
number_threads_(partest::TestSuite::GetDefaultNumThreads()),
  number_iterations_(partest::TestSuite::GetDefaultNumIterations()),
  counter_iterations_(10000) {
  CreateUnit("Spinlock protected counter (using Lock)")
    .Add(&SpinLockTest::TestSpinlockCountLock, this, number_threads_,
        number_iterations_)
    .Post(&SpinLockTest::PostSpinlockCount, this);

  CreateUnit("Spinlock protected counter (using Trylock)")
    .Add(&SpinLockTest::TestSpinlockCountLockTryLock, this, number_threads_,
        number_iterations_)
    .Post(&SpinLockTest::PostSpinlockCount, this);

  CreateUnit("Test spinning (too many spins), single thread")
    .Add(&SpinLockTest::TestSpinLockTooManySpins, this, 1, 1);
}

void SpinLockTest::TestSpinlockCountLock() {
230
  for (unsigned int i = 0; i != counter_iterations_; ++i) {
231 232 233 234 235 236 237
    spinlock_.Lock();
    counter_++;
    spinlock_.Unlock();
  }
}

void SpinLockTest::TestSpinlockCountLockTryLock() {
238
  for (unsigned int i = 0; i != counter_iterations_; ++i) {
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
    while (!spinlock_.TryLock()) {}
    counter_++;
    spinlock_.Unlock();
  }
}

void SpinLockTest::PostSpinlockCount() {
  PT_EXPECT_EQ(counter_,
    number_iterations_ *
    number_threads_*
    counter_iterations_);
  counter_ = 0;
}

void SpinLockTest::TestSpinLockTooManySpins() {
  Spinlock lock;
  lock.Lock();
  bool success = lock.TryLock(100);
  PT_ASSERT(!success);
  lock.Unlock();
  success = lock.TryLock(100);
  PT_ASSERT(success);
}
262 263 264
} // namespace test
} // namespace base
} // namespace embb