2017-03-08 10:21:49 +01:00
|
|
|
/*
|
|
|
|
* \brief Server role of init, forwarding session requests to children
|
|
|
|
* \author Norman Feske
|
|
|
|
* \date 2017-03-07
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Copyright (C) 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.
|
|
|
|
*/
|
|
|
|
|
2020-01-09 21:23:19 +01:00
|
|
|
#ifndef _LIB__SANDBOX__SERVER_H_
|
|
|
|
#define _LIB__SANDBOX__SERVER_H_
|
2017-03-08 10:21:49 +01:00
|
|
|
|
|
|
|
/* Genode includes */
|
|
|
|
#include <base/attached_rom_dataspace.h>
|
2018-01-23 14:40:34 +01:00
|
|
|
#include <os/buffered_xml.h>
|
2017-03-08 10:21:49 +01:00
|
|
|
|
|
|
|
/* local includes */
|
2017-11-13 16:25:37 +01:00
|
|
|
#include "types.h"
|
|
|
|
#include "service.h"
|
|
|
|
#include "state_reporter.h"
|
2017-03-08 10:21:49 +01:00
|
|
|
|
2020-01-09 21:23:19 +01:00
|
|
|
namespace Sandbox { class Server; }
|
2017-03-08 10:21:49 +01:00
|
|
|
|
|
|
|
|
2020-01-09 21:23:19 +01:00
|
|
|
class Sandbox::Server : Session_state::Ready_callback,
|
|
|
|
Session_state::Closed_callback
|
2017-03-08 10:21:49 +01:00
|
|
|
{
|
|
|
|
private:
|
|
|
|
|
|
|
|
struct Route
|
|
|
|
{
|
|
|
|
Routed_service &service;
|
|
|
|
Session_label label;
|
|
|
|
};
|
|
|
|
|
|
|
|
Env &_env;
|
|
|
|
|
|
|
|
Allocator &_alloc;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* ID space of requests originating from the parent
|
|
|
|
*/
|
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
|
|
|
Id_space<Parent::Server> _server_id_space { };
|
2017-03-08 10:21:49 +01:00
|
|
|
|
|
|
|
/*
|
2020-01-09 21:23:19 +01:00
|
|
|
* ID space of requests issued to the children
|
2017-03-08 10:21:49 +01:00
|
|
|
*/
|
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
|
|
|
Id_space<Parent::Client> _client_id_space { };
|
2017-03-08 10:21:49 +01:00
|
|
|
|
2017-06-30 15:21:29 +02:00
|
|
|
/**
|
|
|
|
* Exception type
|
|
|
|
*/
|
|
|
|
class Service_not_present : Exception { };
|
|
|
|
|
2017-03-08 10:21:49 +01:00
|
|
|
/**
|
|
|
|
* Meta data of service provided to our parent
|
|
|
|
*/
|
|
|
|
struct Service;
|
|
|
|
|
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
|
|
|
Registry<Service> _services { };
|
2017-03-08 10:21:49 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Services provided by our children
|
|
|
|
*/
|
|
|
|
Registry<Routed_service> &_child_services;
|
|
|
|
|
|
|
|
Report_update_trigger &_report_update_trigger;
|
|
|
|
|
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
|
|
|
Constructible<Attached_rom_dataspace> _session_requests { };
|
|
|
|
Constructible<Signal_handler<Server> > _session_request_handler { };
|
2017-03-08 10:21:49 +01:00
|
|
|
|
|
|
|
/**
|
Streamline exception types
This patch reduces the number of exception types by facilitating
globally defined exceptions for common usage patterns shared by most
services. In particular, RPC functions that demand a session-resource
upgrade not longer reflect this condition via a session-specific
exception but via the 'Out_of_ram' or 'Out_of_caps' types.
Furthermore, the 'Parent::Service_denied', 'Parent::Unavailable',
'Root::Invalid_args', 'Root::Unavailable', 'Service::Invalid_args',
'Service::Unavailable', and 'Local_service::Factory::Denied' types have
been replaced by the single 'Service_denied' exception type defined in
'session/session.h'.
This consolidation eases the error handling (there are fewer exceptions
to handle), alleviates the need to convert exceptions along the
session-creation call chain, and avoids possible aliasing problems
(catching the wrong type with the same name but living in a different
scope).
2017-05-07 22:03:22 +02:00
|
|
|
* \throw Service_denied
|
2017-03-08 10:21:49 +01:00
|
|
|
*/
|
|
|
|
Route _resolve_session_request(Genode::Service::Name const &,
|
|
|
|
Session_label const &);
|
|
|
|
|
|
|
|
void _handle_create_session_request (Xml_node, Parent::Client::Id);
|
|
|
|
void _handle_upgrade_session_request(Xml_node, Parent::Client::Id);
|
|
|
|
void _handle_close_session_request (Xml_node, Parent::Client::Id);
|
|
|
|
|
|
|
|
void _handle_session_request(Xml_node);
|
|
|
|
void _handle_session_requests();
|
|
|
|
|
2017-10-19 16:07:28 +02:00
|
|
|
void _close_session(Session_state &, Parent::Session_response response);
|
|
|
|
|
2017-03-08 10:21:49 +01:00
|
|
|
/**
|
|
|
|
* Session_state::Closed_callback interface
|
|
|
|
*/
|
|
|
|
void session_closed(Session_state &) override;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Session_state::Ready_callback interface
|
|
|
|
*/
|
|
|
|
void session_ready(Session_state &) override;
|
|
|
|
|
|
|
|
public:
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor
|
|
|
|
*
|
|
|
|
* \param alloc allocator used for buffering XML config data and
|
|
|
|
* for allocating per-service meta data
|
|
|
|
*/
|
|
|
|
Server(Env &env, Allocator &alloc, Registry<Routed_service> &services,
|
|
|
|
Report_update_trigger &report_update_trigger)
|
|
|
|
:
|
|
|
|
_env(env), _alloc(alloc), _child_services(services),
|
|
|
|
_report_update_trigger(report_update_trigger)
|
|
|
|
{ }
|
|
|
|
|
|
|
|
void apply_config(Xml_node);
|
|
|
|
};
|
|
|
|
|
2020-01-09 21:23:19 +01:00
|
|
|
#endif /* _LIB__SANDBOX__SERVER_H_ */
|