genode/repos/os/src/server/nic_dump/component.h

145 lines
3.6 KiB
C
Raw Normal View History

/*
* \brief Downlink interface in form of a NIC session component
* \author Martin Stein
* \date 2017-03-08
*/
/*
* Copyright (C) 2016-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 _COMPONENT_H_
#define _COMPONENT_H_
/* Genode includes */
#include <root/component.h>
#include <nic/packet_allocator.h>
#include <nic_session/rpc_object.h>
#include <base/heap.h>
/* local includes */
#include <interface.h>
#include <uplink.h>
namespace Net {
class Communication_buffer;
class Session_component_base;
class Session_component;
class Root;
}
class Net::Communication_buffer : public Genode::Ram_dataspace_capability
{
private:
Genode::Ram_allocator &_ram;
public:
Communication_buffer(Genode::Ram_allocator &ram,
Genode::size_t const size);
~Communication_buffer() { _ram.free(*this); }
};
class Net::Session_component_base
{
protected:
Genode::Ram_quota_guard _ram_quota_guard;
Genode::Cap_quota_guard _cap_quota_guard;
Genode::Constrained_ram_allocator _ram;
Genode::Sliced_heap _alloc;
Nic::Packet_allocator _range_alloc;
Communication_buffer _tx_buf;
Communication_buffer _rx_buf;
public:
Session_component_base(Genode::Ram_allocator &ram,
Genode::Region_map &local_rm,
Genode::Ram_quota ram_quota,
Genode::Cap_quota cap_quota,
Genode::size_t const tx_buf_size,
Genode::size_t const rx_buf_size);
};
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
class Net::Session_component : private Session_component_base,
public ::Nic::Session_rpc_object,
private Interface
{
private:
Uplink _uplink;
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
Genode::Signal_context_capability _link_state_sigh { };
Genode::Signal_handler<Session_component> _link_state_handler;
void _handle_link_state();
void _print_state();
/********************
** Net::Interface **
********************/
Packet_stream_sink &_sink() override { return *_tx.sink(); }
Packet_stream_source &_source() override { return *_rx.source(); }
public:
Session_component(Genode::Ram_quota ram_quota,
Genode::Cap_quota cap_quota,
Genode::size_t tx_buf_size,
Genode::size_t rx_buf_size,
Genode::Xml_node config,
Timer::Connection &timer,
Genode::Duration &curr_time,
Genode::Env &env);
/******************
** Nic::Session **
******************/
Mac_address mac_address() override { return _uplink.mac_address(); }
bool link_state() override { return _uplink.link_state(); }
void link_state_sigh(Genode::Signal_context_capability sigh) override {
_link_state_sigh = sigh; }
};
class Net::Root : public Genode::Root_component<Session_component,
Genode::Single_client>
{
private:
Genode::Env &_env;
Genode::Xml_node _config;
Timer::Connection &_timer;
Genode::Duration &_curr_time;
/********************
** Root_component **
********************/
Session_component *_create_session(char const *args) override;
public:
Root(Genode::Env &env,
Genode::Allocator &alloc,
Genode::Xml_node config,
Timer::Connection &timer,
Genode::Duration &curr_time);
};
#endif /* _COMPONENT_H_ */