mutex_test.h 3.52 KB
Newer Older
Michael Schmid committed
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 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
/*
 * Copyright (c) 2014-2016, Siemens AG. All rights reserved.
 *
 * 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.
 */

#ifndef BASE_C_TEST_MUTEX_TEST_H_
#define BASE_C_TEST_MUTEX_TEST_H_

#include <partest/partest.h>
#include <embb/base/c/internal/platform.h>
#include <embb/base/c/mutex.h>


namespace embb {
namespace base {
namespace test {
/**
 * Provides tests for class Mutex.
 */
class MutexTest : public partest::TestCase {
 public:
  /**
   * Constructs the test case and adds test units.
   */
  MutexTest();

 private:
  /**
   * Prepares TestMutexIncCpp.
   */
  void PreMutexInc();
  /**
   * Tests mutex locking and unlocking to protect shared counter.
   */
  void TestMutexInc();
  /**
   * Checks and tears down TestMutexIncCpp.
   */
  void PostMutexInc();

  /**
   * Tests the multiple locking and unlocking of a recursive mutex.
   */
  void TestRecursiveMutex();

  /**
   * Mutex for tests.
   */
  embb_mutex_t mutex_;

  /**
   * Shared counter to check effectiveness of mutex.
   */
  size_t counter_;

  /**
   * Number of threads used to run tests.
   */
  size_t number_threads_;

  /**
   * Number of times the test method is called by each thread.
   */
  size_t number_iterations_;
};


class SpinLockTest : public partest::TestCase {
 public:
  SpinLockTest();

 private:
  /**
   * Check that the try lock fails, when lock is already set.
   */
  void TestSpinLockTooManySpins();

  /**
   * Prepares TestMutexIncCpp.
   */
  void PreSpinLockInc();

  /**
   * Tests mutex locking and unlocking to protect shared counter.
   */
  void TestSpinLockIncUseLock();

  /**
   * Tests mutex locking and unlocking to protect shared counter using trylock.
   */
  void TestSpinLockIncUseTryLock();

  /**
   * Checks and tears down TestMutexIncCpp.
   */
  void PostSpinLockInc();

  /**
   * Shared counter to check effectiveness of mutex.
   */
  size_t counter_;

  /**
   * Number of threads used to run tests.
   */
  size_t number_threads_;

  /**
   * Number of times the test method is called by each thread.
   */
  size_t number_iterations_;

  /**
   * Number of internal iterations, for incrementing the counter.
   */
  size_t counter_iterations_;

  /**
   * The used spinlock
   */
  embb_spinlock_t spinlock_;
};


} // namespace test
} // namespace base
} // namespace embb

#endif  // BASE_C_TEST_MUTEX_TEST_H_