xref: /aosp_15_r20/art/runtime/interpreter/safe_math.h (revision 795d594fd825385562da6b089ea9b2033f3abf5a)

/*
 * Copyright (C) 2014 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef ART_RUNTIME_INTERPRETER_SAFE_MATH_H_
#define ART_RUNTIME_INTERPRETER_SAFE_MATH_H_

#include <functional>
#include <type_traits>

#include "base/macros.h"

namespace art HIDDEN {
namespace interpreter {

// Declares a type which is the larger in bit size of the two template parameters.
template <typename T1, typename T2>
struct select_bigger {
  using type = std::conditional_t<sizeof(T1) >= sizeof(T2), T1, T2>;
};
template <typename T1, typename T2>
using select_bigger_t = typename select_bigger<T1, T2>::type;

// Perform signed arithmetic Op on 'a' and 'b' with defined wrapping behavior.
template<template <typename OpT> class Op, typename T1, typename T2>
static inline select_bigger_t<T1, T2> SafeMath(T1 a, T2 b) {
  using biggest_T = select_bigger_t<T1, T2>;
  using unsigned_biggest_T = std::make_unsigned_t<biggest_T>;
  static_assert(std::is_signed_v<T1>, "Expected T1 to be signed");
  static_assert(std::is_signed_v<T2>, "Expected T2 to be signed");
  unsigned_biggest_T val1 = static_cast<unsigned_biggest_T>(static_cast<biggest_T>(a));
  unsigned_biggest_T val2 = static_cast<unsigned_biggest_T>(b);
  return static_cast<biggest_T>(Op<unsigned_biggest_T>()(val1, val2));
}

// Perform a signed add on 'a' and 'b' with defined wrapping behavior.
template<typename T1, typename T2>
static inline select_bigger_t<T1, T2> SafeAdd(T1 a, T2 b) {
  return SafeMath<std::plus>(a, b);
}

// Perform a signed substract on 'a' and 'b' with defined wrapping behavior.
template<typename T1, typename T2>
static inline select_bigger_t<T1, T2> SafeSub(T1 a, T2 b) {
  return SafeMath<std::minus>(a, b);
}

// Perform a signed multiply on 'a' and 'b' with defined wrapping behavior.
template<typename T1, typename T2>
static inline select_bigger_t<T1, T2> SafeMul(T1 a, T2 b) {
  return SafeMath<std::multiplies>(a, b);
}

}  // namespace interpreter
}  // namespace art

#endif  // ART_RUNTIME_INTERPRETER_SAFE_MATH_H_