ExternalVendorCode/genode
1
0
Fork 0
mirror of https://github.com/genodelabs/genode.git synced 2025-06-23 17:17:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Follow practices suggested by "Effective C++"

Browse Source 
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
This commit is contained in:
Norman Feske
2017-12-21 15:42:15 +01:00
committed by Christian Helmuth
parent 2a33d9aa76
commit eba9c15746
763 changed files with 4936 additions and 3288 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
repos/os/include/block/component.h
View File

@ -72,9 +72,9 @@ class Block::Session_component : public Block::Session_component_base,
addr_t _rq_phys;
Signal_handler<Session_component> _sink_ack;
Signal_handler<Session_component> _sink_submit;
bool _req_queue_full;
bool _ack_queue_full;
Packet_descriptor _p_to_handle;
bool _req_queue_full = false;
bool _ack_queue_full = false;
Packet_descriptor _p_to_handle { };
unsigned _p_in_fly;
bool _writeable;

44
repos/os/include/block/driver.h
View File

@ -31,7 +31,7 @@ namespace Block {
};
struct Block::Driver_session_base
struct Block::Driver_session_base : Genode::Interface
{
/**
* Acknowledges a packet processed by the driver to the client
@ -79,10 +79,16 @@ class Block::Driver_session : public Driver_session_base,
/**
* Interface to be implemented by the device-specific driver code
*/
class Block::Driver
class Block::Driver : Genode::Interface
{
private:
/*
* Noncopyable
*/
Driver(Driver const &);
Driver &operator = (Driver const &);
Genode::Ram_session &_ram_session;
Driver_session_base *_session = nullptr;
@ -133,10 +139,10 @@ class Block::Driver
*
* Note: should be overridden by DMA non-capable devices
*/
virtual void read(sector_t block_number,
Genode::size_t block_count,
char * buffer,
Packet_descriptor &packet) {
virtual void read(sector_t /* block_number */,
Genode::size_t /* block_count */,
char * /* buffer */,
Packet_descriptor & /* packet */) {
throw Io_error(); }
/**
@ -151,10 +157,10 @@ class Block::Driver
*
* Note: should be overridden by DMA non-capable, non-ROM devices
*/
virtual void write(sector_t block_number,
Genode::size_t block_count,
const char * buffer,
Packet_descriptor &packet) {
virtual void write(sector_t /* block_number */,
Genode::size_t /* block_count */,
const char * /* buffer */,
Packet_descriptor & /* packet */) {
throw Io_error(); }
/**
@ -169,10 +175,10 @@ class Block::Driver
*
* Note: should be overridden by DMA capable devices
*/
virtual void read_dma(sector_t block_number,
Genode::size_t block_count,
Genode::addr_t phys,
Packet_descriptor &packet) {
virtual void read_dma(sector_t /* block_number */,
Genode::size_t /* block_count */,
Genode::addr_t /* phys */,
Packet_descriptor & /* packet */) {
throw Io_error(); }
/**
@ -187,10 +193,10 @@ class Block::Driver
*
* Note: should be overridden by DMA capable, non-ROM devices
*/
virtual void write_dma(sector_t block_number,
Genode::size_t block_count,
Genode::addr_t phys,
Packet_descriptor &packet) {
virtual void write_dma(sector_t /* block_number */,
Genode::size_t /* block_count */,
Genode::addr_t /* phys */,
Packet_descriptor & /* packet */) {
throw Io_error(); }
/**
@ -256,7 +262,7 @@ class Block::Driver
/**
* Interface for constructing the driver object
*/
struct Block::Driver_factory
struct Block::Driver_factory : Genode::Interface
{
/**
* Construct new driver