mirror of
https://github.com/genodelabs/genode.git
synced 2025-05-02 08:42:52 +00:00
eba9c15746
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
90 lines
1.9 KiB
C++
90 lines
1.9 KiB
C++
/*
|
|
* \brief Utility for synchronizing the access of interface methods
|
|
* \author Norman Feske
|
|
* \date 2013-05-16
|
|
*/
|
|
|
|
/*
|
|
* 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__BASE__SYNCED_INTERFACE_H_
|
|
#define _INCLUDE__BASE__SYNCED_INTERFACE_H_
|
|
|
|
/* Genode includes */
|
|
#include <base/lock.h>
|
|
|
|
namespace Genode {
|
|
|
|
template <typename, typename LOCK = Genode::Lock> class Synced_interface;
|
|
}
|
|
|
|
|
|
/*
|
|
* Utility for synchronizing the access of interface methods
|
|
*
|
|
* The 'Synced_interface' utility makes the serialization of interface
|
|
* method calls easy. The 'Synced_interface' is a functor that takes a lock
|
|
* and a pointer to an interface as arguments. When called, the functor
|
|
* returns a smart pointer to the interface. When this smart pointer gets
|
|
* dereferenced, the smart pointer takes care of acquiring and releasing
|
|
* the lock while the interface method is executed.
|
|
*/
|
|
template <typename IF, typename LOCK>
|
|
class Genode::Synced_interface
|
|
{
|
|
public:
|
|
|
|
class Guard
|
|
{
|
|
private:
|
|
|
|
LOCK &_lock;
|
|
IF *_interface;
|
|
|
|
Guard(LOCK &lock, IF *interface)
|
|
: _lock(lock), _interface(interface)
|
|
{
|
|
_lock.lock();
|
|
}
|
|
|
|
friend class Synced_interface;
|
|
|
|
Guard &operator = (Guard const &);
|
|
|
|
public:
|
|
|
|
~Guard() { _lock.unlock(); }
|
|
|
|
Guard(Guard const &other)
|
|
: _lock(other._lock), _interface(other._interface) { }
|
|
|
|
IF *operator -> () { return _interface; }
|
|
};
|
|
|
|
private:
|
|
|
|
LOCK &_lock;
|
|
IF *_interface;
|
|
|
|
public:
|
|
|
|
Synced_interface(LOCK &lock, IF *interface)
|
|
: _lock(lock), _interface(interface) { }
|
|
|
|
Guard operator () ()
|
|
{
|
|
return Guard(_lock, _interface);
|
|
}
|
|
|
|
Guard operator () () const
|
|
{
|
|
return Guard(_lock, _interface);
|
|
}
|
|
};
|
|
|
|
#endif /* _INCLUDE__BASE__SYNCED_INTERFACE_H_ */
|