Skip to content

Commit

Permalink
partition_alloc: Copy base/bits.h to the PA library
Browse files Browse the repository at this point in the history
- Copied base/bits.h and base/bits_unittest.cc to
//base/allocator/partition_allocator/base, and introduced
partition_alloc::internal::base namespace.
- Added migration_adapter.h to make base:: inside partition_alloc
namespace to use ::base instead of ::partition_alloc::internal::base.
- Replaced some base:: with ::base because of typedef or not to update
DEPS.

Bug: 1151236

Change-Id: Ibfffcace7a55a7cc740c1229b8d6f4621d23e2f6
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3564028
Reviewed-by: Kalvin Lee <kdlee@chromium.org>
Reviewed-by: Kentaro Hara <haraken@chromium.org>
Reviewed-by: Yuki Shiino <yukishiino@chromium.org>
Commit-Queue: Kentaro Hara <haraken@chromium.org>
Owners-Override: Kentaro Hara <haraken@chromium.org>
Cr-Commit-Position: refs/heads/main@{#989885}
  • Loading branch information
tasak authored and Chromium LUCI CQ committed Apr 7, 2022
1 parent 4c7e528 commit b0ba4bf
Show file tree
Hide file tree
Showing 31 changed files with 793 additions and 87 deletions.
1 change: 1 addition & 0 deletions base/BUILD.gn
Expand Up @@ -3616,6 +3616,7 @@ test("base_unittests") {
sources += [
"allocator/partition_allocator/address_pool_manager_unittest.cc",
"allocator/partition_allocator/address_space_randomization_unittest.cc",
"allocator/partition_allocator/base/bits_pa_unittest.cc",
"allocator/partition_allocator/hardening_unittest.cc",
"allocator/partition_allocator/memory_reclaimer_unittest.cc",
"allocator/partition_allocator/page_allocator_unittest.cc",
Expand Down
2 changes: 2 additions & 0 deletions base/allocator/partition_allocator/BUILD.gn
Expand Up @@ -55,6 +55,8 @@ target(partition_alloc_target_type, "partition_alloc") {
"address_space_stats.h",
"allocation_guard.cc",
"allocation_guard.h",
"base/bits.h",
"base/migration_adapter.h",
"dangling_raw_ptr_checks.cc",
"dangling_raw_ptr_checks.h",
"extended_api.cc",
Expand Down
1 change: 0 additions & 1 deletion base/allocator/partition_allocator/DEPS
Expand Up @@ -8,7 +8,6 @@ include_rules = [
"+base/allocator/buildflags.h",
"+base/base_export.h",
"+base/bind.h",
"+base/bits.h",
"+base/callback.h",
"+base/check.h",
"+base/check_op.h",
Expand Down
Expand Up @@ -7,9 +7,9 @@
#include <cstdint>

#include "base/allocator/partition_allocator/address_space_stats.h"
#include "base/allocator/partition_allocator/base/bits.h"
#include "base/allocator/partition_allocator/page_allocator.h"
#include "base/allocator/partition_allocator/partition_alloc_constants.h"
#include "base/bits.h"
#include "build/build_config.h"
#include "testing/gtest/include/gtest/gtest.h"

Expand Down Expand Up @@ -131,7 +131,7 @@ TEST_F(PartitionAllocAddressPoolManagerTest, GetUsedSuperpages) {
}
EXPECT_EQ(GetAddressPoolManager()->Reserve(pool_, 0, kSuperPageSize), 0u);

std::bitset<base::kMaxSuperPagesInPool> used_super_pages;
std::bitset<kMaxSuperPagesInPool> used_super_pages;
GetAddressPoolManager()->GetPoolUsedSuperPages(pool_, used_super_pages);

// We expect every bit to be set.
Expand Down
240 changes: 240 additions & 0 deletions base/allocator/partition_allocator/base/bits.h
@@ -0,0 +1,240 @@
// Copyright (c) 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// This file defines some bit utilities.

#ifndef BASE_ALLOCATOR_PARTITION_ALLOCATOR_BASE_BITS_H_
#define BASE_ALLOCATOR_PARTITION_ALLOCATOR_BASE_BITS_H_

#include <climits>
#include <cstddef>
#include <cstdint>
#include <type_traits>

#include "base/allocator/partition_allocator/base/migration_adapter.h"
#include "base/allocator/partition_allocator/partition_alloc_check.h"
#include "base/compiler_specific.h"
#include "build/build_config.h"

#if defined(COMPILER_MSVC)
#include <intrin.h>
#endif

namespace partition_alloc::internal::base::bits {

// Returns true iff |value| is a power of 2.
template <typename T, typename = std::enable_if_t<std::is_integral<T>::value>>
constexpr bool IsPowerOfTwo(T value) {
// From "Hacker's Delight": Section 2.1 Manipulating Rightmost Bits.
//
// Only positive integers with a single bit set are powers of two. If only one
// bit is set in x (e.g. 0b00000100000000) then |x-1| will have that bit set
// to zero and all bits to its right set to 1 (e.g. 0b00000011111111). Hence
// |x & (x-1)| is 0 iff x is a power of two.
return value > 0 && (value & (value - 1)) == 0;
}

// Round down |size| to a multiple of alignment, which must be a power of two.
inline constexpr size_t AlignDown(size_t size, size_t alignment) {
PA_DCHECK(IsPowerOfTwo(alignment));
return size & ~(alignment - 1);
}

// Move |ptr| back to the previous multiple of alignment, which must be a power
// of two. Defined for types where sizeof(T) is one byte.
template <typename T, typename = typename std::enable_if<sizeof(T) == 1>::type>
inline T* AlignDown(T* ptr, size_t alignment) {
return reinterpret_cast<T*>(
AlignDown(reinterpret_cast<size_t>(ptr), alignment));
}

// Round up |size| to a multiple of alignment, which must be a power of two.
inline constexpr size_t AlignUp(size_t size, size_t alignment) {
PA_DCHECK(IsPowerOfTwo(alignment));
return (size + alignment - 1) & ~(alignment - 1);
}

// Advance |ptr| to the next multiple of alignment, which must be a power of
// two. Defined for types where sizeof(T) is one byte.
template <typename T, typename = typename std::enable_if<sizeof(T) == 1>::type>
inline T* AlignUp(T* ptr, size_t alignment) {
return reinterpret_cast<T*>(
AlignUp(reinterpret_cast<size_t>(ptr), alignment));
}

// CountLeadingZeroBits(value) returns the number of zero bits following the
// most significant 1 bit in |value| if |value| is non-zero, otherwise it
// returns {sizeof(T) * 8}.
// Example: 00100010 -> 2
//
// CountTrailingZeroBits(value) returns the number of zero bits preceding the
// least significant 1 bit in |value| if |value| is non-zero, otherwise it
// returns {sizeof(T) * 8}.
// Example: 00100010 -> 1
//
// C does not have an operator to do this, but fortunately the various
// compilers have built-ins that map to fast underlying processor instructions.
//
// Prefer the clang path on Windows, as _BitScanReverse() and friends are not
// constexpr.
#if defined(COMPILER_MSVC) && !defined(__clang__)

template <typename T, unsigned bits = sizeof(T) * 8>
ALWAYS_INLINE
typename std::enable_if<std::is_unsigned<T>::value && sizeof(T) <= 4,
unsigned>::type
CountLeadingZeroBits(T x) {
static_assert(bits > 0, "invalid instantiation");
unsigned long index;
return LIKELY(_BitScanReverse(&index, static_cast<uint32_t>(x)))
? (31 - index - (32 - bits))
: bits;
}

template <typename T, unsigned bits = sizeof(T) * 8>
ALWAYS_INLINE
typename std::enable_if<std::is_unsigned<T>::value && sizeof(T) == 8,
unsigned>::type
CountLeadingZeroBits(T x) {
static_assert(bits > 0, "invalid instantiation");
unsigned long index;
// MSVC only supplies _BitScanReverse64 when building for a 64-bit target.
#if defined(ARCH_CPU_64_BITS)
return LIKELY(_BitScanReverse64(&index, static_cast<uint64_t>(x)))
? (63 - index)
: 64;
#else
uint32_t left = static_cast<uint32_t>(x >> 32);
if (LIKELY(_BitScanReverse(&index, left)))
return 31 - index;

uint32_t right = static_cast<uint32_t>(x);
if (LIKELY(_BitScanReverse(&index, right)))
return 63 - index;

return 64;
#endif
}

template <typename T, unsigned bits = sizeof(T) * 8>
ALWAYS_INLINE
typename std::enable_if<std::is_unsigned<T>::value && sizeof(T) <= 4,
unsigned>::type
CountTrailingZeroBits(T x) {
static_assert(bits > 0, "invalid instantiation");
unsigned long index;
return LIKELY(_BitScanForward(&index, static_cast<uint32_t>(x))) ? index
: bits;
}

template <typename T, unsigned bits = sizeof(T) * 8>
ALWAYS_INLINE
typename std::enable_if<std::is_unsigned<T>::value && sizeof(T) == 8,
unsigned>::type
CountTrailingZeroBits(T x) {
static_assert(bits > 0, "invalid instantiation");
unsigned long index;
// MSVC only supplies _BitScanForward64 when building for a 64-bit target.
#if defined(ARCH_CPU_64_BITS)
return LIKELY(_BitScanForward64(&index, static_cast<uint64_t>(x))) ? index
: 64;
#else
uint32_t right = static_cast<uint32_t>(x);
if (LIKELY(_BitScanForward(&index, right)))
return index;

uint32_t left = static_cast<uint32_t>(x >> 32);
if (LIKELY(_BitScanForward(&index, left)))
return 32 + index;

return 64;
#endif
}

ALWAYS_INLINE uint32_t CountLeadingZeroBits32(uint32_t x) {
return CountLeadingZeroBits(x);
}

ALWAYS_INLINE uint64_t CountLeadingZeroBits64(uint64_t x) {
return CountLeadingZeroBits(x);
}

#elif defined(COMPILER_GCC) || defined(__clang__)

// __builtin_clz has undefined behaviour for an input of 0, even though there's
// clearly a return value that makes sense, and even though some processor clz
// instructions have defined behaviour for 0. We could drop to raw __asm__ to
// do better, but we'll avoid doing that unless we see proof that we need to.
template <typename T, unsigned bits = sizeof(T) * 8>
ALWAYS_INLINE constexpr
typename std::enable_if<std::is_unsigned<T>::value && sizeof(T) <= 8,
unsigned>::type
CountLeadingZeroBits(T value) {
static_assert(bits > 0, "invalid instantiation");
return LIKELY(value)
? bits == 64
? __builtin_clzll(static_cast<uint64_t>(value))
: __builtin_clz(static_cast<uint32_t>(value)) - (32 - bits)
: bits;
}

template <typename T, unsigned bits = sizeof(T) * 8>
ALWAYS_INLINE constexpr
typename std::enable_if<std::is_unsigned<T>::value && sizeof(T) <= 8,
unsigned>::type
CountTrailingZeroBits(T value) {
return LIKELY(value) ? bits == 64
? __builtin_ctzll(static_cast<uint64_t>(value))
: __builtin_ctz(static_cast<uint32_t>(value))
: bits;
}

ALWAYS_INLINE constexpr uint32_t CountLeadingZeroBits32(uint32_t x) {
return CountLeadingZeroBits(x);
}

ALWAYS_INLINE constexpr uint64_t CountLeadingZeroBits64(uint64_t x) {
return CountLeadingZeroBits(x);
}

#endif

ALWAYS_INLINE constexpr size_t CountLeadingZeroBitsSizeT(size_t x) {
return CountLeadingZeroBits(x);
}

ALWAYS_INLINE constexpr size_t CountTrailingZeroBitsSizeT(size_t x) {
return CountTrailingZeroBits(x);
}

// Returns the integer i such as 2^i <= n < 2^(i+1).
//
// There is a common `BitLength` function, which returns the number of bits
// required to represent a value. Rather than implement that function,
// use `Log2Floor` and add 1 to the result.
constexpr int Log2Floor(uint32_t n) {
return 31 - CountLeadingZeroBits(n);
}

// Returns the integer i such as 2^(i-1) < n <= 2^i.
constexpr int Log2Ceiling(uint32_t n) {
// When n == 0, we want the function to return -1.
// When n == 0, (n - 1) will underflow to 0xFFFFFFFF, which is
// why the statement below starts with (n ? 32 : -1).
return (n ? 32 : -1) - CountLeadingZeroBits(n - 1);
}

// Returns a value of type T with a single bit set in the left-most position.
// Can be used instead of manually shifting a 1 to the left.
template <typename T>
constexpr T LeftmostBit() {
static_assert(std::is_integral<T>::value,
"This function can only be used with integral types.");
T one(1u);
return one << ((CHAR_BIT * sizeof(T) - 1));
}

} // namespace partition_alloc::internal::base::bits

#endif // BASE_ALLOCATOR_PARTITION_ALLOCATOR_BASE_BITS_H_

0 comments on commit b0ba4bf

Please sign in to comment.