genode/repos/base-sel4/src/core/include/map_local.h
Norman Feske 6b289a1423 base/core: use references instead of pointers
This patch replaces the former prominent use of pointers by references
wherever feasible. This has the following benefits:

* The contract between caller and callee becomes more obvious. When
  passing a reference, the contract says that the argument cannot be
  a null pointer. The caller is responsible to ensure that. Therefore,
  the use of reference eliminates the need to add defensive null-pointer
  checks at the callee site, which sometimes merely exist to be on the
  safe side. The bottom line is that the code becomes easier to follow.

* Reference members must be initialized via an object initializer,
  which promotes a programming style that avoids intermediate object-
  construction states. Within core, there are still a few pointers
  as member variables left though. E.g., caused by the late association
  of 'Platform_thread' objects with their 'Platform_pd' objects.

* If no pointers are present as member variables, we don't need to
  manually provide declarations of a private copy constructor and
  an assignment operator to avoid -Weffc++ errors "class ... has
  pointer data members [-Werror=effc++]".

This patch also changes a few system bindings on NOVA and Fiasco.OC,
e.g., the return value of the global 'cap_map' accessor has become a
reference. Hence, the patch touches a few places outside of core.

Fixes #3135
2019-02-12 10:33:13 +01:00

66 lines
1.9 KiB
C++

/*
* \brief Core-local memory mapping
* \author Norman Feske
* \date 2015-05-01
*/
/*
* Copyright (C) 2015-2017 Genode Labs GmbH
*
* This file is part of the Genode OS framework, which is distributed
* under the terms of the GNU Affero General Public License version 3.
*/
#ifndef _CORE__INCLUDE__MAP_LOCAL_H_
#define _CORE__INCLUDE__MAP_LOCAL_H_
/* core includes */
#include <util.h>
#include <platform.h>
namespace Genode {
/**
* Map physical pages to core-local virtual address range
*
* \param from_phys physical source address
* \param to_virt core-local destination address
* \param num_pages number of pages to map
* \param platform pointer to platform object (to avoid deadlocks during
* early Platform() construction caused by nested calls
* of platform_specific())
*
* \return true on success
*/
inline bool map_local(addr_t from_phys, addr_t to_virt, size_t num_pages,
Platform * platform = nullptr)
{
enum { DONT_FLUSH = false, WRITEABLE = true, NON_EXECUTABLE = false };
try {
platform = platform ? platform : &platform_specific();
platform->core_vm_space().map(from_phys, to_virt, num_pages,
Cache_attribute::CACHED,
WRITEABLE, NON_EXECUTABLE,
DONT_FLUSH);
} catch (Page_table_registry::Mapping_cache_full) {
return false;
}
return true;
}
/**
* Flush memory mappings from core-local virtual address range
*/
inline bool unmap_local(addr_t const virt_addr, size_t const num_pages,
Platform * platform = nullptr,
bool const invalidate = false)
{
platform = platform ? platform : &platform_specific();
return platform->core_vm_space().unmap(virt_addr, num_pages, invalidate);
}
}
#endif /* _CORE__INCLUDE__MAP_LOCAL_H_ */