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 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
|
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/351564777): Remove this and convert code to safer constructs.
#pragma allow_unsafe_buffers
#endif
#include "mojo/public/cpp/base/big_buffer.h"
#include <algorithm>
#include <utility>
#include "base/check.h"
#include "base/containers/heap_array.h"
#include "base/notreached.h"
namespace mojo_base {
namespace internal {
BigBufferSharedMemoryRegion::BigBufferSharedMemoryRegion() : size_(0) {}
BigBufferSharedMemoryRegion::BigBufferSharedMemoryRegion(
mojo::ScopedSharedBufferHandle buffer_handle,
size_t size)
: size_(size),
buffer_handle_(std::move(buffer_handle)),
buffer_mapping_(buffer_handle_->Map(size)) {}
BigBufferSharedMemoryRegion::BigBufferSharedMemoryRegion(
BigBufferSharedMemoryRegion&& other) = default;
BigBufferSharedMemoryRegion::~BigBufferSharedMemoryRegion() = default;
BigBufferSharedMemoryRegion& BigBufferSharedMemoryRegion::operator=(
BigBufferSharedMemoryRegion&& other) = default;
mojo::ScopedSharedBufferHandle BigBufferSharedMemoryRegion::TakeBufferHandle() {
DCHECK(buffer_handle_.is_valid());
buffer_mapping_.reset();
return std::move(buffer_handle_);
}
} // namespace internal
namespace {
void TryCreateSharedMemory(
size_t size,
BigBuffer::StorageType* storage_type,
std::optional<internal::BigBufferSharedMemoryRegion>* shared_memory) {
if (size > BigBuffer::kMaxInlineBytes) {
auto buffer = mojo::SharedBufferHandle::Create(size);
if (buffer.is_valid()) {
internal::BigBufferSharedMemoryRegion shm_region(std::move(buffer), size);
if (shm_region.memory()) {
*storage_type = BigBuffer::StorageType::kSharedMemory;
shared_memory->emplace(std::move(shm_region));
return;
}
}
}
// We can use inline memory, either because the data was small or shared
// memory allocation failed.
*storage_type = BigBuffer::StorageType::kBytes;
}
} // namespace
BigBuffer::BigBuffer() = default;
BigBuffer::BigBuffer(base::span<const uint8_t> data) {
*this = BigBufferView::ToBigBuffer(BigBufferView(data));
}
BigBuffer::BigBuffer(internal::BigBufferSharedMemoryRegion shared_memory)
: storage_type_(StorageType::kSharedMemory),
shared_memory_(std::move(shared_memory)) {}
BigBuffer::BigBuffer(size_t size) {
TryCreateSharedMemory(size, &storage_type_, &shared_memory_);
if (storage_type_ == BigBuffer::StorageType::kBytes) {
// Either |size| is small enough or shared memory allocation failed, and
// fallback to inline allocation is feasible.
bytes_ = base::HeapArray<uint8_t>::Uninit(size);
}
}
BigBuffer::BigBuffer(BigBuffer&& other)
// Make sure |other| looks empty.
: storage_type_(
std::exchange(other.storage_type_, StorageType::kInvalidBuffer)),
bytes_(std::move(other.bytes_)),
shared_memory_(std::move(other.shared_memory_)) {}
BigBuffer& BigBuffer::operator=(BigBuffer&& other) {
// Make sure |other| looks empty.
storage_type_ =
std::exchange(other.storage_type_, StorageType::kInvalidBuffer);
bytes_ = std::move(other.bytes_);
shared_memory_ = std::move(other.shared_memory_);
return *this;
}
BigBuffer::~BigBuffer() = default;
BigBuffer BigBuffer::Clone() const {
return BigBuffer(base::span(*this));
}
const uint8_t* BigBuffer::data() const {
switch (storage_type_) {
case StorageType::kBytes:
return bytes_.data();
case StorageType::kSharedMemory:
DCHECK(shared_memory_->buffer_mapping_);
return static_cast<const uint8_t*>(
const_cast<const void*>(shared_memory_->buffer_mapping_.get()));
case StorageType::kInvalidBuffer:
// We return null here but do not assert unlike the default case. No
// consumer is allowed to dereference this when |size()| is zero anyway.
return nullptr;
default:
NOTREACHED();
}
}
size_t BigBuffer::size() const {
switch (storage_type_) {
case StorageType::kBytes:
return bytes_.size();
case StorageType::kSharedMemory:
return shared_memory_->size();
case StorageType::kInvalidBuffer:
return 0;
default:
NOTREACHED();
}
}
BigBufferView::BigBufferView() = default;
BigBufferView::BigBufferView(BigBufferView&& other) = default;
BigBufferView::BigBufferView(base::span<const uint8_t> bytes) {
TryCreateSharedMemory(bytes.size(), &storage_type_, &shared_memory_);
if (storage_type_ == BigBuffer::StorageType::kSharedMemory) {
DCHECK(shared_memory_->memory());
std::ranges::copy(bytes, static_cast<uint8_t*>(shared_memory_->memory()));
return;
}
if (storage_type_ == BigBuffer::StorageType::kBytes) {
// Either the data is small enough or shared memory allocation failed.
// Either way we fall back to directly referencing the input bytes.
bytes_ = bytes;
}
}
BigBufferView::~BigBufferView() = default;
BigBufferView& BigBufferView::operator=(BigBufferView&& other) = default;
void BigBufferView::SetBytes(base::span<const uint8_t> bytes) {
DCHECK(bytes_.empty());
DCHECK(!shared_memory_);
storage_type_ = BigBuffer::StorageType::kBytes;
bytes_ = bytes;
}
void BigBufferView::SetSharedMemory(
internal::BigBufferSharedMemoryRegion shared_memory) {
DCHECK(bytes_.empty());
DCHECK(!shared_memory_);
storage_type_ = BigBuffer::StorageType::kSharedMemory;
shared_memory_ = std::move(shared_memory);
}
base::span<const uint8_t> BigBufferView::data() const {
if (storage_type_ == BigBuffer::StorageType::kBytes) {
return bytes_;
} else if (storage_type_ == BigBuffer::StorageType::kSharedMemory) {
DCHECK(shared_memory_.has_value());
return base::span(static_cast<const uint8_t*>(
const_cast<const void*>(shared_memory_->memory())),
shared_memory_->size());
}
return base::span<const uint8_t>();
}
// static
BigBuffer BigBufferView::ToBigBuffer(BigBufferView view) {
BigBuffer buffer;
buffer.storage_type_ = view.storage_type_;
if (view.storage_type_ == BigBuffer::StorageType::kBytes) {
buffer.bytes_ = base::HeapArray<uint8_t>::CopiedFrom(view.bytes_);
} else if (view.storage_type_ == BigBuffer::StorageType::kSharedMemory) {
buffer.shared_memory_ = std::move(*view.shared_memory_);
}
return buffer;
}
// static
BigBufferView BigBufferView::CreateInvalidForTest() {
BigBufferView view;
view.storage_type_ = BigBuffer::StorageType::kInvalidBuffer;
return view;
}
} // namespace mojo_base
|