diff --git a/mfbt/Saturate.h b/mfbt/Saturate.h new file mode 100644 index 00000000000..5d3315e17be --- /dev/null +++ b/mfbt/Saturate.h @@ -0,0 +1,287 @@ +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim: set ts=8 sts=2 et sw=2 tw=80: */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +/* Provides saturation arithmetics for scalar types. */ + +#ifndef mozilla_Saturate_h +#define mozilla_Saturate_h + +#include "mozilla/Attributes.h" +#include "mozilla/Move.h" +#include "mozilla/NumericLimits.h" +#include "mozilla/TypeTraits.h" + +namespace mozilla { +namespace detail { + +/** + * |SaturateOp| wraps scalar values for saturation arithmetics. Usage: + * + * uint32_t value = 1; + * + * ++SaturateOp(value); // value is 2 + * --SaturateOp(value); // value is 1 + * --SaturateOp(value); // value is 0 + * --SaturateOp(value); // value is still 0 + * + * Please add new operators when required. + * + * |SaturateOp| will saturate at the minimum and maximum values of + * type T. If you need other bounds, implement a clamped-type class and + * specialize the type traits accordingly. + */ +template +class SaturateOp +{ +public: + explicit SaturateOp(T& aValue) + : mValue(aValue) + { + // We should actually check for |std::is_scalar::value| to be + // true, but this type trait is not available everywhere. Relax + // this assertion if you want to use floating point values as well. + static_assert(IsIntegral::value, + "Integral type required in instantiation"); + } + + // Add and subtract operators + + T operator+(const T& aRhs) const + { + return T(mValue) += aRhs; + } + + T operator-(const T& aRhs) const + { + return T(mValue) -= aRhs; + } + + // Compound operators + + const T& operator+=(const T& aRhs) const + { + const T min = NumericLimits::min(); + const T max = NumericLimits::max(); + + if (aRhs > static_cast(0)) { + mValue = (max - aRhs) < mValue ? max : mValue + aRhs; + } else { + mValue = (min - aRhs) > mValue ? min : mValue + aRhs; + } + return mValue; + } + + const T& operator-=(const T& aRhs) const + { + const T min = NumericLimits::min(); + const T max = NumericLimits::max(); + + if (aRhs > static_cast(0)) { + mValue = (min + aRhs) > mValue ? min : mValue - aRhs; + } else { + mValue = (max + aRhs) < mValue ? max : mValue - aRhs; + } + return mValue; + } + + // Increment and decrement operators + + const T& operator++() const // prefix + { + return operator+=(static_cast(1)); + } + + T operator++(int) const // postfix + { + const T value(mValue); + operator++(); + return value; + } + + const T& operator--() const // prefix + { + return operator-=(static_cast(1)); + } + + T operator--(int) const // postfix + { + const T value(mValue); + operator--(); + return value; + } + +private: + SaturateOp(const SaturateOp&) = delete; + SaturateOp(SaturateOp&&) = delete; + SaturateOp& operator=(const SaturateOp&) = delete; + SaturateOp& operator=(SaturateOp&&) = delete; + + T& mValue; +}; + +/** + * |Saturate| is a value type for saturation arithmetics. It's + * build on top of |SaturateOp|. + */ +template +class Saturate +{ +public: + Saturate() = default; + MOZ_IMPLICIT Saturate(const Saturate&) = default; + + MOZ_IMPLICIT Saturate(Saturate&& aValue) + { + mValue = Move(aValue.mValue); + } + + explicit Saturate(const T& aValue) + : mValue(aValue) + { } + + const T& value() const + { + return mValue; + } + + // Compare operators + + bool operator==(const Saturate& aRhs) const + { + return mValue == aRhs.mValue; + } + + bool operator!=(const Saturate& aRhs) const + { + return !operator==(aRhs); + } + + bool operator==(const T& aRhs) const + { + return mValue == aRhs; + } + + bool operator!=(const T& aRhs) const + { + return !operator==(aRhs); + } + + // Assignment operators + + Saturate& operator=(const Saturate&) = default; + + Saturate& operator=(Saturate&& aRhs) + { + mValue = Move(aRhs.mValue); + return *this; + } + + // Add and subtract operators + + Saturate operator+(const Saturate& aRhs) const + { + Saturate lhs(mValue); + return lhs += aRhs.mValue; + } + + Saturate operator+(const T& aRhs) const + { + Saturate lhs(mValue); + return lhs += aRhs; + } + + Saturate operator-(const Saturate& aRhs) const + { + Saturate lhs(mValue); + return lhs -= aRhs.mValue; + } + + Saturate operator-(const T& aRhs) const + { + Saturate lhs(mValue); + return lhs -= aRhs; + } + + // Compound operators + + Saturate& operator+=(const Saturate& aRhs) + { + SaturateOp(mValue) += aRhs.mValue; + return *this; + } + + Saturate& operator+=(const T& aRhs) + { + SaturateOp(mValue) += aRhs; + return *this; + } + + Saturate& operator-=(const Saturate& aRhs) + { + SaturateOp(mValue) -= aRhs.mValue; + return *this; + } + + Saturate& operator-=(const T& aRhs) + { + SaturateOp(mValue) -= aRhs; + return *this; + } + + // Increment and decrement operators + + Saturate& operator++() // prefix + { + ++SaturateOp(mValue); + return *this; + } + + Saturate operator++(int) // postfix + { + return Saturate(SaturateOp(mValue)++); + } + + Saturate& operator--() // prefix + { + --SaturateOp(mValue); + return *this; + } + + Saturate operator--(int) // postfix + { + return Saturate(SaturateOp(mValue)--); + } + +private: + T mValue; +}; + +} // namespace detail + +typedef detail::Saturate SaturateInt8; +typedef detail::Saturate SaturateInt16; +typedef detail::Saturate SaturateInt32; +typedef detail::Saturate SaturateUint8; +typedef detail::Saturate SaturateUint16; +typedef detail::Saturate SaturateUint32; + +} // namespace mozilla + +template +bool +operator==(LhsT aLhs, const mozilla::detail::Saturate& aRhs) +{ + return aRhs.operator==(static_cast(aLhs)); +} + +template +bool +operator!=(LhsT aLhs, const mozilla::detail::Saturate& aRhs) +{ + return !(aLhs == aRhs); +} + +#endif // mozilla_Saturate_h diff --git a/mfbt/moz.build b/mfbt/moz.build index f6acbe8d5c5..38d424dd2ed 100644 --- a/mfbt/moz.build +++ b/mfbt/moz.build @@ -73,6 +73,7 @@ EXPORTS.mozilla = [ 'RefPtr.h', 'ReverseIterator.h', 'RollingMean.h', + 'Saturate.h', 'Scoped.h', 'ScopeExit.h', 'SegmentedVector.h', diff --git a/mfbt/tests/TestSaturate.cpp b/mfbt/tests/TestSaturate.cpp new file mode 100644 index 00000000000..cd1208ff8f3 --- /dev/null +++ b/mfbt/tests/TestSaturate.cpp @@ -0,0 +1,215 @@ +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim: set ts=8 sts=2 et sw=2 tw=80: */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this file, + * You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#include + +#include +#include + +using mozilla::detail::Saturate; +using mozilla::NumericLimits; + +#define A(a) MOZ_RELEASE_ASSERT(a, "Test \'" #a "\' failed.") + +static const unsigned long sNumOps = 32; + +template +static T +StartValue() +{ + // Specialize |StartValue| for the given type. + A(false); +} + +template<> +int8_t +StartValue() +{ + return 0; +} + +template<> +int16_t +StartValue() +{ + return 0; +} + +template<> +int32_t +StartValue() +{ + return 0; +} + +template<> +uint8_t +StartValue() +{ + // Picking a value near middle of uint8_t's range. + return static_cast(NumericLimits::max()); +} + +template<> +uint16_t +StartValue() +{ + // Picking a value near middle of uint16_t's range. + return static_cast(NumericLimits::max()); +} + +template<> +uint32_t +StartValue() +{ + // Picking a value near middle of uint32_t's range. + return static_cast(NumericLimits::max()); +} + +// Add +// + +template +static void +TestPrefixIncr() +{ + T value = StartValue(); + Saturate satValue(value); + + for (T i = 0; i < static_cast(sNumOps); ++i) { + A(++value == ++satValue); + } +} + +template +static void +TestPostfixIncr() +{ + T value = StartValue(); + Saturate satValue(value); + + for (T i = 0; i < static_cast(sNumOps); ++i) { + A(value++ == satValue++); + } +} + +template +static void +TestAdd() +{ + T value = StartValue(); + Saturate satValue(value); + + for (T i = 0; i < static_cast(sNumOps); ++i) { + A((value + i) == (satValue + i)); + } +} + +// Subtract +// + +template +static void +TestPrefixDecr() +{ + T value = StartValue(); + Saturate satValue(value); + + for (T i = 0; i < static_cast(sNumOps); ++i) { + A(--value == --satValue); + } +} + +template +static void +TestPostfixDecr() +{ + T value = StartValue(); + Saturate satValue(value); + + for (T i = 0; i < static_cast(sNumOps); ++i) { + A(value-- == satValue--); + } +} + +template +static void +TestSub() +{ + T value = StartValue(); + Saturate satValue(value); + + for (T i = 0; i < static_cast(sNumOps); ++i) { + A((value - i) == (satValue - i)); + } +} + +// Corner cases near bounds +// + +template +static void +TestUpperBound() +{ + Saturate satValue(NumericLimits::max()); + + A(--satValue == (NumericLimits::max() - 1)); + A(++satValue == (NumericLimits::max())); + A(++satValue == (NumericLimits::max())); // don't overflow here + A(++satValue == (NumericLimits::max())); // don't overflow here + A(--satValue == (NumericLimits::max() - 1)); // back at (max - 1) + A(--satValue == (NumericLimits::max() - 2)); +} + +template +static void +TestLowerBound() +{ + Saturate satValue(NumericLimits::min()); + + A(++satValue == (NumericLimits::min() + 1)); + A(--satValue == (NumericLimits::min())); + A(--satValue == (NumericLimits::min())); // don't overflow here + A(--satValue == (NumericLimits::min())); // don't overflow here + A(++satValue == (NumericLimits::min() + 1)); // back at (max + 1) + A(++satValue == (NumericLimits::min() + 2)); +} + +// Framework +// + +template +static void +TestAll() +{ + // Assert that we don't accidently hit type's range limits in tests. + const T value = StartValue(); + A(NumericLimits::min() + static_cast(sNumOps) <= value); + A(NumericLimits::max() - static_cast(sNumOps) >= value); + + TestPrefixIncr(); + TestPostfixIncr(); + TestAdd(); + + TestPrefixDecr(); + TestPostfixDecr(); + TestSub(); + + TestUpperBound(); + TestLowerBound(); +} + +int +main() +{ + TestAll(); + TestAll(); + TestAll(); + TestAll(); + TestAll(); + TestAll(); + return 0; +} diff --git a/mfbt/tests/moz.build b/mfbt/tests/moz.build index c75ee8eec15..499cd730de4 100644 --- a/mfbt/tests/moz.build +++ b/mfbt/tests/moz.build @@ -31,6 +31,7 @@ CppUnitTests([ 'TestPair', 'TestRefPtr', 'TestRollingMean', + 'TestSaturate', 'TestScopeExit', 'TestSegmentedVector', 'TestSHA1', diff --git a/testing/cppunittest.ini b/testing/cppunittest.ini index 05899358c4b..a3e5da5d317 100644 --- a/testing/cppunittest.ini +++ b/testing/cppunittest.ini @@ -67,6 +67,7 @@ skip-if = os == 'android' # Bug 1147630 [TestRollingMean] [TestSHA1] [TestSTSParser] +[TestSaturate] [TestSplayTree] [TestStartupCache] skip-if = os == 'b2g' || os == 'android' # Bug 929655