genode/repos/base-okl4/src/core/include/util.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

117 lines
2.9 KiB
C++

/*
* \brief OKL4 utilities
* \author Norman Feske
* \date 2009-03-31
*/
/*
* Copyright (C) 2009-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__UTIL_H_
#define _CORE__INCLUDE__UTIL_H_
/* Genode includes */
#include <rm_session/rm_session.h>
#include <base/stdint.h>
#include <base/log.h>
#include <util/touch.h>
/* base-internal includes */
#include <base/internal/page_size.h>
#include <base/internal/okl4.h>
/*
* The binding for 'L4_KDB_Enter' on ARM takes a 'char *' as argument, which
* prevents us from passing a plain const "string". However, on x86, the
* binding is a preprocessor macro accepting only a "string" as argument.
* Unless the OKL4 bindings get fixed, we have to handle both cases separately.
*/
#ifdef __L4__X86__KDEBUG_H__
#define ENTER_KDB(msg) L4_KDB_Enter(msg);
#else
#define ENTER_KDB(msg) L4_KDB_Enter((char *)msg);
#endif
namespace Genode {
inline void log_event(const char *) { }
inline void log_event(const char *, unsigned, unsigned, unsigned) { }
inline void panic(const char *s)
{
using namespace Okl4;
error("Panic: ", s);
ENTER_KDB("> panic <");
}
inline void assert(const char *s, bool val)
{
using namespace Okl4;
if (!val) {
error("assertion failed: ", s);
ENTER_KDB("Assertion failed");
}
}
constexpr addr_t get_page_mask() { return ~(get_page_size() - 1); }
inline size_t get_super_page_size_log2()
{
enum { SUPER_PAGE_SIZE_LOG2 = 22 };
if (get_page_mask() & (1 << SUPER_PAGE_SIZE_LOG2))
return SUPER_PAGE_SIZE_LOG2;
/* if super pages are not supported, return default page size */
return get_page_size();
}
inline void touch_ro(const void *addr, unsigned size)
{
using namespace Okl4;
unsigned char const volatile *bptr;
unsigned char const *eptr;
L4_Word_t mask = get_page_mask();
L4_Word_t psize = get_page_size();
bptr = (unsigned char const volatile *)(((unsigned)addr) & mask);
eptr = (unsigned char const *)(((unsigned)addr + size - 1) & mask);
for ( ; bptr <= eptr; bptr += psize)
touch_read(bptr);
}
inline void touch_rw(const void *addr, unsigned size)
{
using namespace Okl4;
unsigned char volatile *bptr;
unsigned char const *eptr;
L4_Word_t mask = get_page_mask();
L4_Word_t psize = get_page_size();
bptr = (unsigned char volatile *)(((unsigned)addr) & mask);
eptr = (unsigned char const *)(((unsigned)addr + size - 1) & mask);
for(; bptr <= eptr; bptr += psize)
touch_read_write(bptr);
}
inline addr_t trunc_page(addr_t page)
{
return page & get_page_mask();
}
inline addr_t round_page(addr_t page)
{
return trunc_page(page + get_page_size() - 1);
}
inline addr_t map_src_addr(addr_t, addr_t phys) { return phys; }
inline size_t constrain_map_size_log2(size_t size_log2) { return size_log2; }
}
#endif /* _CORE__INCLUDE__UTIL_H_ */