mirror of
https://github.com/genodelabs/genode.git
synced 2024-12-24 15:56:41 +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
162 lines
4.8 KiB
C++
162 lines
4.8 KiB
C++
/*
|
|
* \brief Server::Entrypoint based NIC session component
|
|
* \author Norman Feske
|
|
* \author Sebastian Sumpf
|
|
* \date 2015-06-22
|
|
*/
|
|
|
|
/*
|
|
* Copyright (C) 2015-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__NIC__COMPONENT_H_
|
|
#define _INCLUDE__NIC__COMPONENT_H_
|
|
|
|
#include <base/attached_ram_dataspace.h>
|
|
#include <base/env.h>
|
|
#include <nic/packet_allocator.h>
|
|
#include <nic_session/rpc_object.h>
|
|
|
|
namespace Nic {
|
|
|
|
class Communication_buffers;
|
|
class Session_component;
|
|
}
|
|
|
|
|
|
class Nic::Communication_buffers
|
|
{
|
|
protected:
|
|
|
|
Nic::Packet_allocator _rx_packet_alloc;
|
|
Genode::Attached_ram_dataspace _tx_ds, _rx_ds;
|
|
|
|
Communication_buffers(Genode::Allocator &rx_block_md_alloc,
|
|
Genode::Ram_session &ram_session,
|
|
Genode::Region_map ®ion_map,
|
|
Genode::size_t tx_size,
|
|
Genode::size_t rx_size)
|
|
:
|
|
_rx_packet_alloc(&rx_block_md_alloc),
|
|
_tx_ds(ram_session, region_map, tx_size),
|
|
_rx_ds(ram_session, region_map, rx_size)
|
|
{ }
|
|
};
|
|
|
|
|
|
class Nic::Session_component : Communication_buffers, public Session_rpc_object
|
|
{
|
|
protected:
|
|
|
|
Genode::Entrypoint &_ep;
|
|
Genode::Signal_context_capability _link_state_sigh { };
|
|
|
|
|
|
/**
|
|
* Signal link-state change to client
|
|
*/
|
|
void _link_state_changed()
|
|
{
|
|
if (_link_state_sigh.valid())
|
|
Genode::Signal_transmitter(_link_state_sigh).submit();
|
|
}
|
|
|
|
/**
|
|
* Sub-classes must implement this function, it is called upon all
|
|
* packet-stream signals.
|
|
*/
|
|
virtual void _handle_packet_stream() = 0;
|
|
|
|
void _dispatch() { _handle_packet_stream(); }
|
|
|
|
Genode::Signal_handler<Session_component> _packet_stream_dispatcher {
|
|
_ep, *this, &Session_component::_dispatch };
|
|
|
|
public:
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* \param tx_buf_size buffer size for tx channel
|
|
* \param rx_buf_size buffer size for rx channel
|
|
* \param rx_block_md_alloc backing store of the meta data of the
|
|
* rx block allocator
|
|
* \param env Genode environment needed to access
|
|
* resources and open connections from
|
|
* within the Session_component
|
|
*/
|
|
Session_component(Genode::size_t const tx_buf_size,
|
|
Genode::size_t const rx_buf_size,
|
|
Genode::Allocator &rx_block_md_alloc,
|
|
Genode::Env &env)
|
|
:
|
|
Communication_buffers(rx_block_md_alloc, env.ram(), env.rm(),
|
|
tx_buf_size, rx_buf_size),
|
|
Session_rpc_object(env.rm(),
|
|
_tx_ds.cap(),
|
|
_rx_ds.cap(),
|
|
&_rx_packet_alloc, env.ep().rpc_ep()),
|
|
_ep(env.ep())
|
|
{
|
|
/* install data-flow signal handlers for both packet streams */
|
|
_tx.sigh_ready_to_ack(_packet_stream_dispatcher);
|
|
_tx.sigh_packet_avail(_packet_stream_dispatcher);
|
|
_rx.sigh_ready_to_submit(_packet_stream_dispatcher);
|
|
_rx.sigh_ack_avail(_packet_stream_dispatcher);
|
|
}
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* \param tx_buf_size buffer size for tx channel
|
|
* \param rx_buf_size buffer size for rx channel
|
|
* \param rx_block_md_alloc backing store of the meta data of the
|
|
* rx block allocator
|
|
* \param env Genode environment needed to access
|
|
* resources and open connections from
|
|
* within the Session_component
|
|
* \param ep entrypoint for RPC
|
|
*/
|
|
Session_component(Genode::size_t const tx_buf_size,
|
|
Genode::size_t const rx_buf_size,
|
|
Genode::Allocator &rx_block_md_alloc,
|
|
Genode::Env &env,
|
|
Genode::Entrypoint &ep)
|
|
:
|
|
Communication_buffers(rx_block_md_alloc, env.ram(), env.rm(),
|
|
tx_buf_size, rx_buf_size),
|
|
Session_rpc_object(env.rm(),
|
|
_tx_ds.cap(),
|
|
_rx_ds.cap(),
|
|
&_rx_packet_alloc, ep.rpc_ep()),
|
|
_ep(ep)
|
|
{
|
|
/* install data-flow signal handlers for both packet streams */
|
|
_tx.sigh_ready_to_ack(_packet_stream_dispatcher);
|
|
_tx.sigh_packet_avail(_packet_stream_dispatcher);
|
|
_rx.sigh_ready_to_submit(_packet_stream_dispatcher);
|
|
_rx.sigh_ack_avail(_packet_stream_dispatcher);
|
|
}
|
|
|
|
void link_state_sigh(Genode::Signal_context_capability sigh)
|
|
{
|
|
_link_state_sigh = sigh;
|
|
}
|
|
|
|
/**
|
|
* Return the current link state
|
|
*/
|
|
virtual bool link_state() = 0;
|
|
|
|
/**
|
|
* Return the MAC address of the device
|
|
*/
|
|
virtual Mac_address mac_address() = 0;
|
|
};
|
|
|
|
|
|
#endif /* _INCLUDE__NIC__COMPONENT_H_ */
|