genode/repos/base-pistachio/src/core/include/util.h
Norman Feske eba9c15746 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
2018-01-17 12:14:35 +01:00

118 lines
2.8 KiB
C++

/*
* \brief Pistachio utilities
* \author Christian Helmuth
* \date 2006-04-11
*/
/*
* Copyright (C) 2006-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 <base/stdint.h>
#include <base/log.h>
#include <rm_session/rm_session.h>
#include <util/touch.h>
/* base-internal includes */
#include <base/internal/page_size.h>
/* core-local includes */
#include <kip.h>
#include <print_l4_thread_id.h>
/* Pistachio includes */
namespace Pistachio {
#include <l4/types.h>
#include <l4/ipc.h>
#include <l4/kdebug.h>
}
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 Pistachio;
raw("Panic: ", s);
L4_KDB_Enter("> panic <");
}
inline void assert(const char *s, bool val)
{
using namespace Pistachio;
if (!val) {
error("Assertion failed: ", s);
L4_KDB_Enter("Assertion failed.");
}
}
inline void touch_ro(const void *addr, unsigned size)
{
using namespace Pistachio;
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 Pistachio;
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);
}
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 size_t get_super_page_size() { return 1 << get_super_page_size_log2(); }
inline addr_t trunc_page(addr_t addr)
{
return addr & get_page_mask();
}
inline addr_t round_page(addr_t addr)
{
return trunc_page(addr + get_page_size() - 1);
}
inline addr_t map_src_addr(addr_t core_local_addr, addr_t) {
return core_local_addr; }
inline size_t constrain_map_size_log2(size_t size_log2) {
return size_log2; }
}
#endif /* _CORE__INCLUDE__UTIL_H_ */