123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439 |
- // Copyright 2018 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.
- #include "base/memory/platform_shared_memory_region.h"
- #include <tuple>
- #include "base/check.h"
- #include "base/memory/shared_memory_mapping.h"
- #include "base/process/process_metrics.h"
- #include "base/ranges/algorithm.h"
- #include "base/system/sys_info.h"
- #include "base/test/gtest_util.h"
- #include "base/test/test_shared_memory_util.h"
- #include "build/build_config.h"
- #include "testing/gtest/include/gtest/gtest.h"
- #if BUILDFLAG(IS_APPLE)
- #include <mach/vm_map.h>
- #include <sys/mman.h>
- #elif BUILDFLAG(IS_POSIX)
- #include <sys/mman.h>
- #include "base/debug/proc_maps_linux.h"
- #elif BUILDFLAG(IS_WIN)
- #include <windows.h>
- #include "base/logging.h"
- #elif BUILDFLAG(IS_FUCHSIA)
- #include <lib/zx/object.h>
- #include <lib/zx/process.h>
- #include "base/fuchsia/fuchsia_logging.h"
- #endif
- namespace base {
- namespace subtle {
- const size_t kRegionSize = 1024;
- class PlatformSharedMemoryRegionTest : public ::testing::Test {};
- // Tests that a default constructed region is invalid and produces invalid
- // mappings.
- TEST_F(PlatformSharedMemoryRegionTest, DefaultConstructedRegionIsInvalid) {
- PlatformSharedMemoryRegion region;
- EXPECT_FALSE(region.IsValid());
- WritableSharedMemoryMapping mapping = MapForTesting(®ion);
- EXPECT_FALSE(mapping.IsValid());
- PlatformSharedMemoryRegion duplicate = region.Duplicate();
- EXPECT_FALSE(duplicate.IsValid());
- EXPECT_FALSE(region.ConvertToReadOnly());
- }
- // Tests that creating a region of 0 size returns an invalid region.
- TEST_F(PlatformSharedMemoryRegionTest, CreateRegionOfZeroSizeIsInvalid) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(0);
- EXPECT_FALSE(region.IsValid());
- PlatformSharedMemoryRegion region2 =
- PlatformSharedMemoryRegion::CreateUnsafe(0);
- EXPECT_FALSE(region2.IsValid());
- }
- // Tests that creating a region of size bigger than the integer max value
- // returns an invalid region.
- TEST_F(PlatformSharedMemoryRegionTest, CreateTooLargeRegionIsInvalid) {
- size_t too_large_region_size =
- static_cast<size_t>(std::numeric_limits<int>::max()) + 1;
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(too_large_region_size);
- EXPECT_FALSE(region.IsValid());
- PlatformSharedMemoryRegion region2 =
- PlatformSharedMemoryRegion::CreateUnsafe(too_large_region_size);
- EXPECT_FALSE(region2.IsValid());
- }
- // Tests that creating a region of maximum possible value returns an invalid
- // region.
- TEST_F(PlatformSharedMemoryRegionTest, CreateMaxSizeRegionIsInvalid) {
- size_t max_region_size = std::numeric_limits<size_t>::max();
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(max_region_size);
- EXPECT_FALSE(region.IsValid());
- PlatformSharedMemoryRegion region2 =
- PlatformSharedMemoryRegion::CreateUnsafe(max_region_size);
- EXPECT_FALSE(region2.IsValid());
- }
- // Tests that regions consistently report their size as the size requested at
- // creation time even if their allocation size is larger due to platform
- // constraints.
- TEST_F(PlatformSharedMemoryRegionTest, ReportedSizeIsRequestedSize) {
- constexpr size_t kTestSizes[] = {1, 2, 3, 64, 4096, 1024 * 1024};
- for (size_t size : kTestSizes) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(size);
- EXPECT_EQ(region.GetSize(), size);
- region.ConvertToReadOnly();
- EXPECT_EQ(region.GetSize(), size);
- }
- }
- // Tests that a writable region can be converted to read-only.
- TEST_F(PlatformSharedMemoryRegionTest, ConvertWritableToReadOnly) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- EXPECT_EQ(region.GetMode(), PlatformSharedMemoryRegion::Mode::kWritable);
- ASSERT_TRUE(region.ConvertToReadOnly());
- EXPECT_EQ(region.GetMode(), PlatformSharedMemoryRegion::Mode::kReadOnly);
- }
- // Tests that a writable region can be converted to unsafe.
- TEST_F(PlatformSharedMemoryRegionTest, ConvertWritableToUnsafe) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- EXPECT_EQ(region.GetMode(), PlatformSharedMemoryRegion::Mode::kWritable);
- ASSERT_TRUE(region.ConvertToUnsafe());
- EXPECT_EQ(region.GetMode(), PlatformSharedMemoryRegion::Mode::kUnsafe);
- }
- // Tests that the platform-specific handle converted to read-only cannot be used
- // to perform a writable mapping with low-level system APIs like mmap().
- TEST_F(PlatformSharedMemoryRegionTest, ReadOnlyHandleIsNotWritable) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- EXPECT_TRUE(region.ConvertToReadOnly());
- EXPECT_EQ(region.GetMode(), PlatformSharedMemoryRegion::Mode::kReadOnly);
- EXPECT_TRUE(
- CheckReadOnlyPlatformSharedMemoryRegionForTesting(std::move(region)));
- }
- // Tests that the PassPlatformHandle() call invalidates the region.
- TEST_F(PlatformSharedMemoryRegionTest, InvalidAfterPass) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- std::ignore = region.PassPlatformHandle();
- EXPECT_FALSE(region.IsValid());
- }
- // Tests that the region is invalid after move.
- TEST_F(PlatformSharedMemoryRegionTest, InvalidAfterMove) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- PlatformSharedMemoryRegion moved_region = std::move(region);
- EXPECT_FALSE(region.IsValid());
- EXPECT_TRUE(moved_region.IsValid());
- }
- // Tests that calling Take() with the size parameter equal to zero returns an
- // invalid region.
- TEST_F(PlatformSharedMemoryRegionTest, TakeRegionOfZeroSizeIsInvalid) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- PlatformSharedMemoryRegion region2 = PlatformSharedMemoryRegion::Take(
- region.PassPlatformHandle(), region.GetMode(), 0, region.GetGUID());
- EXPECT_FALSE(region2.IsValid());
- }
- // Tests that calling Take() with the size parameter bigger than the integer max
- // value returns an invalid region.
- TEST_F(PlatformSharedMemoryRegionTest, TakeTooLargeRegionIsInvalid) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- PlatformSharedMemoryRegion region2 = PlatformSharedMemoryRegion::Take(
- region.PassPlatformHandle(), region.GetMode(),
- static_cast<size_t>(std::numeric_limits<int>::max()) + 1,
- region.GetGUID());
- EXPECT_FALSE(region2.IsValid());
- }
- // Tests that mapping zero bytes fails.
- TEST_F(PlatformSharedMemoryRegionTest, MapAtZeroBytesTest) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- WritableSharedMemoryMapping mapping = MapAtForTesting(®ion, 0, 0);
- EXPECT_FALSE(mapping.IsValid());
- }
- // Tests that mapping bytes out of the region limits fails.
- TEST_F(PlatformSharedMemoryRegionTest, MapAtOutOfTheRegionLimitsTest) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- WritableSharedMemoryMapping mapping =
- MapAtForTesting(®ion, 0, region.GetSize() + 1);
- EXPECT_FALSE(mapping.IsValid());
- }
- // Tests that mapping with a size and offset causing overflow fails.
- TEST_F(PlatformSharedMemoryRegionTest, MapAtWithOverflowTest) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(
- SysInfo::VMAllocationGranularity() * 2);
- ASSERT_TRUE(region.IsValid());
- size_t size = std::numeric_limits<size_t>::max();
- size_t offset = SysInfo::VMAllocationGranularity();
- // |size| + |offset| should be below the region size due to overflow but
- // mapping a region with these parameters should be invalid.
- EXPECT_LT(size + offset, region.GetSize());
- WritableSharedMemoryMapping mapping = MapAtForTesting(®ion, offset, size);
- EXPECT_FALSE(mapping.IsValid());
- }
- #if BUILDFLAG(IS_POSIX) && !BUILDFLAG(IS_ANDROID) && !BUILDFLAG(IS_APPLE)
- // Tests that the second handle is closed after a conversion to read-only on
- // POSIX.
- TEST_F(PlatformSharedMemoryRegionTest,
- ConvertToReadOnlyInvalidatesSecondHandle) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- ASSERT_TRUE(region.ConvertToReadOnly());
- FDPair fds = region.GetPlatformHandle();
- EXPECT_LT(fds.readonly_fd, 0);
- }
- // Tests that the second handle is closed after a conversion to unsafe on
- // POSIX.
- TEST_F(PlatformSharedMemoryRegionTest, ConvertToUnsafeInvalidatesSecondHandle) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- ASSERT_TRUE(region.ConvertToUnsafe());
- FDPair fds = region.GetPlatformHandle();
- EXPECT_LT(fds.readonly_fd, 0);
- }
- #endif
- void CheckReadOnlyMapProtection(void* addr) {
- #if BUILDFLAG(IS_APPLE)
- vm_region_basic_info_64 basic_info;
- vm_size_t dummy_size = 0;
- mach_msg_type_number_t info_count = VM_REGION_BASIC_INFO_COUNT_64;
- mach_port_t object_name;
- kern_return_t kr = vm_region_64(
- mach_task_self(), reinterpret_cast<vm_address_t*>(&addr), &dummy_size,
- VM_REGION_BASIC_INFO_64, reinterpret_cast<vm_region_info_t>(&basic_info),
- &info_count, &object_name);
- mach_port_deallocate(mach_task_self(), object_name);
- ASSERT_EQ(kr, KERN_SUCCESS);
- EXPECT_EQ(basic_info.protection & VM_PROT_ALL, VM_PROT_READ);
- EXPECT_EQ(basic_info.max_protection & VM_PROT_ALL, VM_PROT_READ);
- #elif BUILDFLAG(IS_POSIX)
- std::string proc_maps;
- ASSERT_TRUE(base::debug::ReadProcMaps(&proc_maps));
- std::vector<base::debug::MappedMemoryRegion> regions;
- ASSERT_TRUE(base::debug::ParseProcMaps(proc_maps, ®ions));
- auto it = ranges::find_if(
- regions, [addr](const base::debug::MappedMemoryRegion& region) {
- return region.start == reinterpret_cast<uintptr_t>(addr);
- });
- ASSERT_TRUE(it != regions.end());
- // PROT_READ may imply PROT_EXEC on some architectures, so just check that
- // permissions don't contain PROT_WRITE bit.
- EXPECT_FALSE(it->permissions & base::debug::MappedMemoryRegion::WRITE);
- #elif BUILDFLAG(IS_WIN)
- MEMORY_BASIC_INFORMATION memory_info;
- size_t result = VirtualQueryEx(GetCurrentProcess(), addr, &memory_info,
- sizeof(memory_info));
- ASSERT_GT(result, 0ULL) << "Failed executing VirtualQueryEx "
- << logging::SystemErrorCodeToString(
- logging::GetLastSystemErrorCode());
- EXPECT_EQ(memory_info.AllocationProtect, static_cast<DWORD>(PAGE_READONLY));
- EXPECT_EQ(memory_info.Protect, static_cast<DWORD>(PAGE_READONLY));
- #elif BUILDFLAG(IS_FUCHSIA)
- // TODO(alexilin): We cannot call zx_object_get_info ZX_INFO_PROCESS_MAPS in
- // this process. Consider to create an auxiliary process that will read the
- // test process maps.
- #endif
- }
- bool TryToRestoreWritablePermissions(void* addr, size_t len) {
- #if BUILDFLAG(IS_POSIX) && !BUILDFLAG(IS_IOS)
- int result = mprotect(addr, len, PROT_READ | PROT_WRITE);
- return result != -1;
- #elif BUILDFLAG(IS_WIN)
- DWORD old_protection;
- return VirtualProtect(addr, len, PAGE_READWRITE, &old_protection);
- #elif BUILDFLAG(IS_FUCHSIA)
- zx_status_t status =
- zx::vmar::root_self()->protect(ZX_VM_PERM_READ | ZX_VM_PERM_WRITE,
- reinterpret_cast<uintptr_t>(addr), len);
- return status == ZX_OK;
- #else
- return false;
- #endif
- }
- // Tests that protection bits are set correctly for read-only region.
- TEST_F(PlatformSharedMemoryRegionTest, MappingProtectionSetCorrectly) {
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- ASSERT_TRUE(region.ConvertToReadOnly());
- WritableSharedMemoryMapping ro_mapping = MapForTesting(®ion);
- ASSERT_TRUE(ro_mapping.IsValid());
- CheckReadOnlyMapProtection(ro_mapping.memory());
- EXPECT_FALSE(TryToRestoreWritablePermissions(ro_mapping.memory(),
- ro_mapping.mapped_size()));
- CheckReadOnlyMapProtection(ro_mapping.memory());
- }
- // Tests that platform handle permissions are checked correctly.
- TEST_F(PlatformSharedMemoryRegionTest,
- CheckPlatformHandlePermissionsCorrespondToMode) {
- using Mode = PlatformSharedMemoryRegion::Mode;
- auto check = [](const PlatformSharedMemoryRegion& region,
- PlatformSharedMemoryRegion::Mode mode) {
- return PlatformSharedMemoryRegion::
- CheckPlatformHandlePermissionsCorrespondToMode(
- region.GetPlatformHandle(), mode, region.GetSize());
- };
- // Check kWritable region.
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- EXPECT_TRUE(check(region, Mode::kWritable));
- EXPECT_FALSE(check(region, Mode::kReadOnly));
- // Check kReadOnly region.
- ASSERT_TRUE(region.ConvertToReadOnly());
- EXPECT_TRUE(check(region, Mode::kReadOnly));
- EXPECT_FALSE(check(region, Mode::kWritable));
- EXPECT_FALSE(check(region, Mode::kUnsafe));
- // Check kUnsafe region.
- PlatformSharedMemoryRegion region2 =
- PlatformSharedMemoryRegion::CreateUnsafe(kRegionSize);
- ASSERT_TRUE(region2.IsValid());
- EXPECT_TRUE(check(region2, Mode::kUnsafe));
- EXPECT_FALSE(check(region2, Mode::kReadOnly));
- }
- // Tests that it's impossible to create read-only platform shared memory region.
- TEST_F(PlatformSharedMemoryRegionTest, CreateReadOnlyRegionDeathTest) {
- #ifdef OFFICIAL_BUILD
- // The official build does not print the reason a CHECK failed.
- const char kErrorRegex[] = "";
- #else
- const char kErrorRegex[] =
- "Creating a region in read-only mode will lead to this region being "
- "non-modifiable";
- #endif
- EXPECT_DEATH_IF_SUPPORTED(
- PlatformSharedMemoryRegion::Create(
- PlatformSharedMemoryRegion::Mode::kReadOnly, kRegionSize),
- kErrorRegex);
- }
- // Tests that it's prohibited to duplicate a writable region.
- TEST_F(PlatformSharedMemoryRegionTest, DuplicateWritableRegionDeathTest) {
- #ifdef OFFICIAL_BUILD
- const char kErrorRegex[] = "";
- #else
- const char kErrorRegex[] =
- "Duplicating a writable shared memory region is prohibited";
- #endif
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- EXPECT_DEATH_IF_SUPPORTED(region.Duplicate(), kErrorRegex);
- }
- // Tests that it's prohibited to convert an unsafe region to read-only.
- TEST_F(PlatformSharedMemoryRegionTest, UnsafeRegionConvertToReadOnlyDeathTest) {
- #ifdef OFFICIAL_BUILD
- const char kErrorRegex[] = "";
- #else
- const char kErrorRegex[] =
- "Only writable shared memory region can be converted to read-only";
- #endif
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateUnsafe(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- EXPECT_DEATH_IF_SUPPORTED(region.ConvertToReadOnly(), kErrorRegex);
- }
- // Tests that it's prohibited to convert a read-only region to read-only.
- TEST_F(PlatformSharedMemoryRegionTest,
- ReadOnlyRegionConvertToReadOnlyDeathTest) {
- #ifdef OFFICIAL_BUILD
- const char kErrorRegex[] = "";
- #else
- const char kErrorRegex[] =
- "Only writable shared memory region can be converted to read-only";
- #endif
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- EXPECT_TRUE(region.ConvertToReadOnly());
- EXPECT_DEATH_IF_SUPPORTED(region.ConvertToReadOnly(), kErrorRegex);
- }
- // Tests that it's prohibited to convert a read-only region to unsafe.
- TEST_F(PlatformSharedMemoryRegionTest, ReadOnlyRegionConvertToUnsafeDeathTest) {
- #ifdef OFFICIAL_BUILD
- const char kErrorRegex[] = "";
- #else
- const char kErrorRegex[] =
- "Only writable shared memory region can be converted to unsafe";
- #endif
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateWritable(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- ASSERT_TRUE(region.ConvertToReadOnly());
- EXPECT_DEATH_IF_SUPPORTED(region.ConvertToUnsafe(), kErrorRegex);
- }
- // Tests that it's prohibited to convert an unsafe region to unsafe.
- TEST_F(PlatformSharedMemoryRegionTest, UnsafeRegionConvertToUnsafeDeathTest) {
- #ifdef OFFICIAL_BUILD
- const char kErrorRegex[] = "";
- #else
- const char kErrorRegex[] =
- "Only writable shared memory region can be converted to unsafe";
- #endif
- PlatformSharedMemoryRegion region =
- PlatformSharedMemoryRegion::CreateUnsafe(kRegionSize);
- ASSERT_TRUE(region.IsValid());
- EXPECT_DEATH_IF_SUPPORTED(region.ConvertToUnsafe(), kErrorRegex);
- }
- } // namespace subtle
- } // namespace base
|