blob: 8c35bdc0bd1e0b6e14da5f98bf825adbec8c56e5 [file] [log] [blame]
// Copyright 2016 The Fuchsia Authors
//
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file or at
// https://opensource.org/licenses/MIT
#include "vm/vm_object.h"
#include "vm_priv.h"
#include <assert.h>
#include <err.h>
#include <fbl/auto_lock.h>
#include <fbl/mutex.h>
#include <fbl/ref_ptr.h>
#include <inttypes.h>
#include <ktl/move.h>
#include <lib/console.h>
#include <stdlib.h>
#include <string.h>
#include <trace.h>
#include <vm/physmap.h>
#include <vm/vm.h>
#include <vm/vm_address_region.h>
#include <vm/vm_object_paged.h>
#include <zircon/types.h>
#define LOCAL_TRACE MAX(VM_GLOBAL_TRACE, 0)
VmObject::GlobalList VmObject::all_vmos_ = {};
VmObject::VmObject(fbl::RefPtr<vm_lock_t> lock_ptr)
: lock_(lock_ptr->lock), lock_ptr_(ktl::move(lock_ptr)) {
LTRACEF("%p\n", this);
}
VmObject::~VmObject() {
canary_.Assert();
LTRACEF("%p\n", this);
DEBUG_ASSERT(global_list_state_.InContainer() == false);
DEBUG_ASSERT(mapping_list_.is_empty());
DEBUG_ASSERT(children_list_.is_empty());
}
void VmObject::AddToGlobalList() {
Guard<Mutex> guard{AllVmosLock::Get()};
all_vmos_.push_back(this);
}
void VmObject::RemoveFromGlobalList() {
Guard<Mutex> guard{AllVmosLock::Get()};
DEBUG_ASSERT(global_list_state_.InContainer() == true);
all_vmos_.erase(*this);
}
void VmObject::get_name(char* out_name, size_t len) const {
canary_.Assert();
name_.get(len, out_name);
}
zx_status_t VmObject::set_name(const char* name, size_t len) {
canary_.Assert();
return name_.set(name, len);
}
void VmObject::set_user_id(uint64_t user_id) {
canary_.Assert();
Guard<fbl::Mutex> guard{&lock_};
DEBUG_ASSERT(user_id_ == 0);
user_id_ = user_id;
}
uint64_t VmObject::user_id() const {
canary_.Assert();
Guard<fbl::Mutex> guard{&lock_};
return user_id_;
}
uint64_t VmObject::user_id_locked() const {
return user_id_;
}
void VmObject::AddMappingLocked(VmMapping* r) {
canary_.Assert();
DEBUG_ASSERT(lock_.lock().IsHeld());
mapping_list_.push_front(r);
mapping_list_len_++;
}
void VmObject::RemoveMappingLocked(VmMapping* r) {
canary_.Assert();
DEBUG_ASSERT(lock_.lock().IsHeld());
mapping_list_.erase(*r);
DEBUG_ASSERT(mapping_list_len_ > 0);
mapping_list_len_--;
}
uint32_t VmObject::num_mappings() const {
canary_.Assert();
Guard<fbl::Mutex> guard{&lock_};
return mapping_list_len_;
}
bool VmObject::IsMappedByUser() const {
canary_.Assert();
Guard<fbl::Mutex> guard{&lock_};
for (const auto& m : mapping_list_) {
if (m.aspace()->is_user()) {
return true;
}
}
return false;
}
uint32_t VmObject::share_count() const {
canary_.Assert();
Guard<fbl::Mutex> guard{&lock_};
if (mapping_list_len_ < 2) {
return 1;
}
// Find the number of unique VmAspaces that we're mapped into.
// Use this buffer to hold VmAspace pointers.
static constexpr int kAspaceBuckets = 64;
uintptr_t aspaces[kAspaceBuckets];
unsigned int num_mappings = 0; // Number of mappings we've visited
unsigned int num_aspaces = 0; // Unique aspaces we've seen
for (const auto& m : mapping_list_) {
uintptr_t as = reinterpret_cast<uintptr_t>(m.aspace().get());
// Simple O(n^2) should be fine.
for (unsigned int i = 0; i < num_aspaces; i++) {
if (aspaces[i] == as) {
goto found;
}
}
if (num_aspaces < kAspaceBuckets) {
aspaces[num_aspaces++] = as;
} else {
// Maxed out the buffer. Estimate the remaining number of aspaces.
num_aspaces +=
// The number of mappings we haven't visited yet
(mapping_list_len_ - num_mappings)
// Scaled down by the ratio of unique aspaces we've seen so far.
* num_aspaces / num_mappings;
break;
}
found:
num_mappings++;
}
DEBUG_ASSERT_MSG(num_aspaces <= mapping_list_len_,
"num_aspaces %u should be <= mapping_list_len_ %" PRIu32,
num_aspaces, mapping_list_len_);
// TODO: Cache this value as long as the set of mappings doesn't change.
// Or calculate it when adding/removing a new mapping under an aspace
// not in the list.
return num_aspaces;
}
void VmObject::SetChildObserver(VmObjectChildObserver* child_observer) {
Guard<fbl::Mutex> guard{&child_observer_lock_};
child_observer_ = child_observer;
}
bool VmObject::AddChildLocked(VmObjectPaged* o) {
canary_.Assert();
DEBUG_ASSERT(lock_.lock().IsHeld());
children_list_.push_front(o);
children_list_len_++;
return OnChildAddedLocked();
}
bool VmObject::OnChildAddedLocked() {
++user_child_count_;
return user_child_count_ == 1;
}
void VmObject::NotifyOneChild() {
canary_.Assert();
// Make sure we're not holding the shared lock while notifying the observer in case it calls
// back into this object.
DEBUG_ASSERT(!lock_.lock().IsHeld());
Guard<fbl::Mutex> observer_guard{&child_observer_lock_};
// Signal the dispatcher that there are child VMOS
if (child_observer_ != nullptr) {
child_observer_->OnOneChild();
}
}
void VmObject::ReplaceChildLocked(VmObjectPaged* old, VmObjectPaged* new_child) {
canary_.Assert();
children_list_.replace(*old, new_child);
}
void VmObject::DropChildLocked(VmObjectPaged* c) {
canary_.Assert();
DEBUG_ASSERT(children_list_len_ > 0);
children_list_.erase(*c);
--children_list_len_;
}
void VmObject::RemoveChild(VmObjectPaged* o, Guard<Mutex>&& adopt) {
canary_.Assert();
DEBUG_ASSERT(adopt.wraps_lock(lock_ptr_->lock.lock()));
Guard<fbl::Mutex> guard{AdoptLock, ktl::move(adopt)};
DropChildLocked(o);
OnChildRemoved(guard.take());
}
void VmObject::OnChildRemoved(Guard<fbl::Mutex>&& adopt) {
DEBUG_ASSERT(adopt.wraps_lock(lock_ptr_->lock.lock()));
Guard<fbl::Mutex> guard{AdoptLock, ktl::move(adopt)};
DEBUG_ASSERT(user_child_count_ > 0);
--user_child_count_;
if (user_child_count_ != 0) {
return;
}
Guard<fbl::Mutex> observer_guard{&child_observer_lock_};
// Drop shared lock before calling out to the observer to reduce the risk of self-deadlock in
// case it calls back into this object.
guard.Release();
// Signal the dispatcher that there are no more child VMOS
if (child_observer_ != nullptr) {
child_observer_->OnZeroChild();
}
}
uint32_t VmObject::num_children() const {
canary_.Assert();
Guard<fbl::Mutex> guard{&lock_};
return children_list_len_;
}
uint32_t VmObject::num_user_children() const {
canary_.Assert();
Guard<fbl::Mutex> guard{&lock_};
return user_child_count_;
}
void VmObject::RangeChangeUpdateLocked(uint64_t offset, uint64_t len) {
canary_.Assert();
DEBUG_ASSERT(lock_.lock().IsHeld());
// offsets for vmos needn't be aligned, but vmars use aligned offsets
const uint64_t aligned_offset = ROUNDDOWN(offset, PAGE_SIZE);
const uint64_t aligned_len = ROUNDUP(offset + len, PAGE_SIZE) - aligned_offset;
// other mappings may have covered this offset into the vmo, so unmap those ranges
for (auto& m : mapping_list_) {
m.UnmapVmoRangeLocked(aligned_offset, aligned_len);
}
// inform all our children this as well, so they can inform their mappings
for (auto& child : children_list_) {
child.RangeChangeUpdateFromParentLocked(offset, len);
}
}
zx_status_t VmObject::InvalidateCache(const uint64_t offset, const uint64_t len) {
return CacheOp(offset, len, CacheOpType::Invalidate);
}
zx_status_t VmObject::CleanCache(const uint64_t offset, const uint64_t len) {
return CacheOp(offset, len, CacheOpType::Clean);
}
zx_status_t VmObject::CleanInvalidateCache(const uint64_t offset, const uint64_t len) {
return CacheOp(offset, len, CacheOpType::CleanInvalidate);
}
zx_status_t VmObject::SyncCache(const uint64_t offset, const uint64_t len) {
return CacheOp(offset, len, CacheOpType::Sync);
}
zx_status_t VmObject::CacheOp(const uint64_t start_offset, const uint64_t len,
const CacheOpType type) {
canary_.Assert();
if (unlikely(len == 0)) {
return ZX_ERR_INVALID_ARGS;
}
Guard<fbl::Mutex> guard{&lock_};
if (unlikely(!InRange(start_offset, len, size()))) {
return ZX_ERR_OUT_OF_RANGE;
}
const size_t end_offset = static_cast<size_t>(start_offset + len);
size_t op_start_offset = static_cast<size_t>(start_offset);
while (op_start_offset != end_offset) {
// Offset at the end of the current page.
const size_t page_end_offset = ROUNDUP(op_start_offset + 1, PAGE_SIZE);
// This cache op will either terminate at the end of the current page or
// at the end of the whole op range -- whichever comes first.
const size_t op_end_offset = MIN(page_end_offset, end_offset);
const size_t cache_op_len = op_end_offset - op_start_offset;
const size_t page_offset = op_start_offset % PAGE_SIZE;
// lookup the physical address of the page, careful not to fault in a new one
paddr_t pa;
auto status = GetPageLocked(op_start_offset, 0, nullptr, nullptr, nullptr, &pa);
if (likely(status == ZX_OK)) {
// This check is here for the benefit of VmObjectPhysical VMOs,
// which can potentially have pa(s) outside physmap, in contrast to
// VmObjectPaged whose pa(s) are always in physmap.
if (unlikely(!is_physmap_phys_addr(pa))) {
// TODO(ZX-4071): Consider whether to keep or remove op_range
// for cache ops for phsyical VMOs. If we keep, possibly we'd
// want to obtain a mapping somehow here instead of failing.
return ZX_ERR_NOT_SUPPORTED;
}
// Convert the page address to a Kernel virtual address.
const void* ptr = paddr_to_physmap(pa);
const addr_t cache_op_addr = reinterpret_cast<addr_t>(ptr) + page_offset;
LTRACEF("ptr %p op %d\n", ptr, (int)type);
// Perform the necessary cache op against this page.
switch (type) {
case CacheOpType::Invalidate:
arch_invalidate_cache_range(cache_op_addr, cache_op_len);
break;
case CacheOpType::Clean:
arch_clean_cache_range(cache_op_addr, cache_op_len);
break;
case CacheOpType::CleanInvalidate:
arch_clean_invalidate_cache_range(cache_op_addr, cache_op_len);
break;
case CacheOpType::Sync:
arch_sync_cache_range(cache_op_addr, cache_op_len);
break;
}
}
op_start_offset += cache_op_len;
}
return ZX_OK;
}
static int cmd_vm_object(int argc, const cmd_args* argv, uint32_t flags) {
if (argc < 2) {
notenoughargs:
printf("not enough arguments\n");
usage:
printf("usage:\n");
printf("%s dump <address>\n", argv[0].str);
printf("%s dump_pages <address>\n", argv[0].str);
return ZX_ERR_INTERNAL;
}
if (!strcmp(argv[1].str, "dump")) {
if (argc < 2) {
goto notenoughargs;
}
VmObject* o = reinterpret_cast<VmObject*>(argv[2].u);
o->Dump(0, false);
} else if (!strcmp(argv[1].str, "dump_pages")) {
if (argc < 2) {
goto notenoughargs;
}
VmObject* o = reinterpret_cast<VmObject*>(argv[2].u);
o->Dump(0, true);
} else {
printf("unknown command\n");
goto usage;
}
return ZX_OK;
}
STATIC_COMMAND_START
#if LK_DEBUGLEVEL > 0
STATIC_COMMAND("vm_object", "vm object debug commands", &cmd_vm_object)
#endif
STATIC_COMMAND_END(vm_object)