genode/repos/base-nova/include/nova/cap_map.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

133 lines
2.7 KiB
C++

/*
* \brief Mapping of Genode's capability names to capabilities selectors.
* \author Alexander Boettcher
* \date 2013-08-26
*
* This header is public to allow user-level VMMs to manually allocate windows
* of consecutive selectors (for virtualization event portals) in the
* component's capability space.
*/
/*
* Copyright (C) 2013-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 _INCLUDE__NOVA__CAP_MAP_H_
#define _INCLUDE__NOVA__CAP_MAP_H_
/* Genode includes */
#include <base/stdint.h>
#include <base/lock.h>
#include <util/avl_tree.h>
#include <util/noncopyable.h>
namespace Genode {
class Cap_range : public Avl_node<Cap_range> {
private:
Lock _lock { };
addr_t _base = 0;
addr_t _last = 0;
enum {
HEADER = sizeof(_base) + sizeof(_lock) + sizeof(_last),
CAP_RANGE_SIZE = 4096,
WORDS = (CAP_RANGE_SIZE - HEADER - sizeof(Avl_node<Cap_range>)) / sizeof(addr_t),
};
uint16_t _cap_array[WORDS * sizeof(addr_t) / 2];
bool _match(addr_t id) {
return _base <= id && id < _base + elements(); };
public:
Cap_range(addr_t base) : _base(base)
{
static_assert(sizeof(*this) == CAP_RANGE_SIZE,
"Cap_range misconfigured");
for (unsigned i = 0; i < elements(); i++)
_cap_array[i] = 0;
}
addr_t base() const { return _base; }
unsigned elements() const { return sizeof(_cap_array) / sizeof(_cap_array[0]); }
Cap_range *find_by_id(addr_t);
void inc(unsigned id);
void dec(unsigned id, bool revoke = true, unsigned num_log2 = 0);
addr_t alloc(size_t const num_log2);
/************************
** Avl node interface **
************************/
bool higher(Cap_range *n) { return n->_base > _base; }
};
class Cap_index
{
private:
Cap_range * _range;
addr_t _local_name;
public:
Cap_index(Cap_range *range, addr_t local_name)
: _range(range), _local_name(local_name) {}
bool valid() const { return _range; }
inline void inc()
{
if (_range)
_range->inc(_local_name - _range->base());
}
inline void dec()
{
if (_range)
_range->dec(_local_name - _range->base());
}
};
class Capability_map : private Noncopyable
{
private:
Avl_tree<Cap_range> _tree { };
public:
Cap_index find(addr_t local_sel);
void insert(Cap_range &range) { _tree.insert(&range); }
addr_t insert(size_t num_log_2 = 0, addr_t cap = ~0UL);
void remove(addr_t sel, uint8_t num_log_2 = 0, bool revoke = true);
};
/**
* Get the global Capability_map of the process.
*/
Capability_map &cap_map();
}
#endif /* _INCLUDE__NOVA__CAP_MAP_H_ */