2011-12-22 16:19:25 +01:00
|
|
|
/*
|
|
|
|
|
* \brief OKL4 utilities
|
|
|
|
|
* \author Norman Feske
|
|
|
|
|
* \date 2009-03-31
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/*
|
2017-02-20 13:23:52 +01:00
|
|
|
* Copyright (C) 2009-2017 Genode Labs GmbH
|
2011-12-22 16:19:25 +01:00
|
|
|
*
|
|
|
|
|
* This file is part of the Genode OS framework, which is distributed
|
2017-02-20 13:23:52 +01:00
|
|
|
* under the terms of the GNU Affero General Public License version 3.
|
2011-12-22 16:19:25 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef _CORE__INCLUDE__UTIL_H_
|
|
|
|
|
#define _CORE__INCLUDE__UTIL_H_
|
|
|
|
|
|
|
|
|
|
/* Genode includes */
|
|
|
|
|
#include <rm_session/rm_session.h>
|
|
|
|
|
#include <base/stdint.h>
|
base: avoid use of deprecated base/printf.h
Besides adapting the components to the use of base/log.h, the patch
cleans up a few base headers, i.e., it removes unused includes from
root/component.h, specifically base/heap.h and
ram_session/ram_session.h. Hence, components that relied on the implicit
inclusion of those headers have to manually include those headers now.
While adjusting the log messages, I repeatedly stumbled over the problem
that printing char * arguments is ambiguous. It is unclear whether to
print the argument as pointer or null-terminated string. To overcome
this problem, the patch introduces a new type 'Cstring' that allows the
caller to express that the argument should be handled as null-terminated
string. As a nice side effect, with this type in place, the optional len
argument of the 'String' class could be removed. Instead of supplying a
pair of (char const *, size_t), the constructor accepts a 'Cstring'.
This, in turn, clears the way let the 'String' constructor use the new
output mechanism to assemble a string from multiple arguments (and
thereby getting rid of snprintf within Genode in the near future).
To enforce the explicit resolution of the char * ambiguity, the 'char *'
overload of the 'print' function is marked as deleted.
Issue #1987
2016-07-13 19:07:09 +02:00
|
|
|
#include <base/log.h>
|
2011-12-22 16:19:25 +01:00
|
|
|
#include <util/touch.h>
|
|
|
|
|
|
2016-04-20 21:12:57 +02:00
|
|
|
/* base-internal includes */
|
|
|
|
|
#include <base/internal/page_size.h>
|
Follow practices suggested by "Effective C++"
The patch adjust the code of the base, base-<kernel>, and os repository.
To adapt existing components to fix violations of the best practices
suggested by "Effective C++" as reported by the -Weffc++ compiler
argument. The changes follow the patterns outlined below:
* A class with virtual functions can no longer publicly inherit base
classed without a vtable. The inherited object may either be moved
to a member variable, or inherited privately. The latter would be
used for classes that inherit 'List::Element' or 'Avl_node'. In order
to enable the 'List' and 'Avl_tree' to access the meta data, the
'List' must become a friend.
* Instead of adding a virtual destructor to abstract base classes,
we inherit the new 'Interface' class, which contains a virtual
destructor. This way, single-line abstract base classes can stay
as compact as they are now. The 'Interface' utility resides in
base/include/util/interface.h.
* With the new warnings enabled, all member variables must be explicitly
initialized. Basic types may be initialized with '='. All other types
are initialized with braces '{ ... }' or as class initializers. If
basic types and non-basic types appear in a row, it is nice to only
use the brace syntax (also for basic types) and align the braces.
* If a class contains pointers as members, it must now also provide a
copy constructor and assignment operator. In the most cases, one
would make them private, effectively disallowing the objects to be
copied. Unfortunately, this warning cannot be fixed be inheriting
our existing 'Noncopyable' class (the compiler fails to detect that
the inheriting class cannot be copied and still gives the error).
For now, we have to manually add declarations for both the copy
constructor and assignment operator as private class members. Those
declarations should be prepended with a comment like this:
/*
* Noncopyable
*/
Thread(Thread const &);
Thread &operator = (Thread const &);
In the future, we should revisit these places and try to replace
the pointers with references. In the presence of at least one
reference member, the compiler would no longer implicitly generate
a copy constructor. So we could remove the manual declaration.
Issue #465
2017-12-21 15:42:15 +01:00
|
|
|
#include <base/internal/okl4.h>
|
2011-12-22 16:19:25 +01:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* 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 {
|
|
|
|
|
|
Follow practices suggested by "Effective C++"
The patch adjust the code of the base, base-<kernel>, and os repository.
To adapt existing components to fix violations of the best practices
suggested by "Effective C++" as reported by the -Weffc++ compiler
argument. The changes follow the patterns outlined below:
* A class with virtual functions can no longer publicly inherit base
classed without a vtable. The inherited object may either be moved
to a member variable, or inherited privately. The latter would be
used for classes that inherit 'List::Element' or 'Avl_node'. In order
to enable the 'List' and 'Avl_tree' to access the meta data, the
'List' must become a friend.
* Instead of adding a virtual destructor to abstract base classes,
we inherit the new 'Interface' class, which contains a virtual
destructor. This way, single-line abstract base classes can stay
as compact as they are now. The 'Interface' utility resides in
base/include/util/interface.h.
* With the new warnings enabled, all member variables must be explicitly
initialized. Basic types may be initialized with '='. All other types
are initialized with braces '{ ... }' or as class initializers. If
basic types and non-basic types appear in a row, it is nice to only
use the brace syntax (also for basic types) and align the braces.
* If a class contains pointers as members, it must now also provide a
copy constructor and assignment operator. In the most cases, one
would make them private, effectively disallowing the objects to be
copied. Unfortunately, this warning cannot be fixed be inheriting
our existing 'Noncopyable' class (the compiler fails to detect that
the inheriting class cannot be copied and still gives the error).
For now, we have to manually add declarations for both the copy
constructor and assignment operator as private class members. Those
declarations should be prepended with a comment like this:
/*
* Noncopyable
*/
Thread(Thread const &);
Thread &operator = (Thread const &);
In the future, we should revisit these places and try to replace
the pointers with references. In the presence of at least one
reference member, the compiler would no longer implicitly generate
a copy constructor. So we could remove the manual declaration.
Issue #465
2017-12-21 15:42:15 +01:00
|
|
|
inline void log_event(const char *) { }
|
|
|
|
|
inline void log_event(const char *, unsigned, unsigned, unsigned) { }
|
2011-12-22 16:19:25 +01:00
|
|
|
|
|
|
|
|
inline void panic(const char *s)
|
|
|
|
|
{
|
|
|
|
|
using namespace Okl4;
|
base: avoid use of deprecated base/printf.h
Besides adapting the components to the use of base/log.h, the patch
cleans up a few base headers, i.e., it removes unused includes from
root/component.h, specifically base/heap.h and
ram_session/ram_session.h. Hence, components that relied on the implicit
inclusion of those headers have to manually include those headers now.
While adjusting the log messages, I repeatedly stumbled over the problem
that printing char * arguments is ambiguous. It is unclear whether to
print the argument as pointer or null-terminated string. To overcome
this problem, the patch introduces a new type 'Cstring' that allows the
caller to express that the argument should be handled as null-terminated
string. As a nice side effect, with this type in place, the optional len
argument of the 'String' class could be removed. Instead of supplying a
pair of (char const *, size_t), the constructor accepts a 'Cstring'.
This, in turn, clears the way let the 'String' constructor use the new
output mechanism to assemble a string from multiple arguments (and
thereby getting rid of snprintf within Genode in the near future).
To enforce the explicit resolution of the char * ambiguity, the 'char *'
overload of the 'print' function is marked as deleted.
Issue #1987
2016-07-13 19:07:09 +02:00
|
|
|
error("Panic: ", s);
|
2011-12-22 16:19:25 +01:00
|
|
|
ENTER_KDB("> panic <");
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
inline void assert(const char *s, bool val)
|
|
|
|
|
{
|
|
|
|
|
using namespace Okl4;
|
|
|
|
|
if (!val) {
|
base: avoid use of deprecated base/printf.h
Besides adapting the components to the use of base/log.h, the patch
cleans up a few base headers, i.e., it removes unused includes from
root/component.h, specifically base/heap.h and
ram_session/ram_session.h. Hence, components that relied on the implicit
inclusion of those headers have to manually include those headers now.
While adjusting the log messages, I repeatedly stumbled over the problem
that printing char * arguments is ambiguous. It is unclear whether to
print the argument as pointer or null-terminated string. To overcome
this problem, the patch introduces a new type 'Cstring' that allows the
caller to express that the argument should be handled as null-terminated
string. As a nice side effect, with this type in place, the optional len
argument of the 'String' class could be removed. Instead of supplying a
pair of (char const *, size_t), the constructor accepts a 'Cstring'.
This, in turn, clears the way let the 'String' constructor use the new
output mechanism to assemble a string from multiple arguments (and
thereby getting rid of snprintf within Genode in the near future).
To enforce the explicit resolution of the char * ambiguity, the 'char *'
overload of the 'print' function is marked as deleted.
Issue #1987
2016-07-13 19:07:09 +02:00
|
|
|
error("assertion failed: ", s);
|
2011-12-22 16:19:25 +01:00
|
|
|
ENTER_KDB("Assertion failed");
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
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-01-24 22:00:01 +01:00
|
|
|
constexpr addr_t get_page_mask() { return ~(get_page_size() - 1); }
|
2011-12-22 16:19:25 +01:00
|
|
|
|
|
|
|
|
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);
|
|
|
|
|
}
|
|
|
|
|
|
Follow practices suggested by "Effective C++"
The patch adjust the code of the base, base-<kernel>, and os repository.
To adapt existing components to fix violations of the best practices
suggested by "Effective C++" as reported by the -Weffc++ compiler
argument. The changes follow the patterns outlined below:
* A class with virtual functions can no longer publicly inherit base
classed without a vtable. The inherited object may either be moved
to a member variable, or inherited privately. The latter would be
used for classes that inherit 'List::Element' or 'Avl_node'. In order
to enable the 'List' and 'Avl_tree' to access the meta data, the
'List' must become a friend.
* Instead of adding a virtual destructor to abstract base classes,
we inherit the new 'Interface' class, which contains a virtual
destructor. This way, single-line abstract base classes can stay
as compact as they are now. The 'Interface' utility resides in
base/include/util/interface.h.
* With the new warnings enabled, all member variables must be explicitly
initialized. Basic types may be initialized with '='. All other types
are initialized with braces '{ ... }' or as class initializers. If
basic types and non-basic types appear in a row, it is nice to only
use the brace syntax (also for basic types) and align the braces.
* If a class contains pointers as members, it must now also provide a
copy constructor and assignment operator. In the most cases, one
would make them private, effectively disallowing the objects to be
copied. Unfortunately, this warning cannot be fixed be inheriting
our existing 'Noncopyable' class (the compiler fails to detect that
the inheriting class cannot be copied and still gives the error).
For now, we have to manually add declarations for both the copy
constructor and assignment operator as private class members. Those
declarations should be prepended with a comment like this:
/*
* Noncopyable
*/
Thread(Thread const &);
Thread &operator = (Thread const &);
In the future, we should revisit these places and try to replace
the pointers with references. In the presence of at least one
reference member, the compiler would no longer implicitly generate
a copy constructor. So we could remove the manual declaration.
Issue #465
2017-12-21 15:42:15 +01:00
|
|
|
inline addr_t map_src_addr(addr_t, addr_t phys) { return phys; }
|
2011-12-22 16:19:25 +01:00
|
|
|
|
|
|
|
|
inline size_t constrain_map_size_log2(size_t size_log2) { return size_log2; }
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#endif /* _CORE__INCLUDE__UTIL_H_ */
|
