2011-12-22 15:19:25 +00:00
|
|
|
/*
|
|
|
|
* \brief Connection to ROM file service
|
|
|
|
* \author Norman Feske
|
|
|
|
* \date 2008-08-22
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
2017-02-20 12:23:52 +00:00
|
|
|
* Copyright (C) 2008-2017 Genode Labs GmbH
|
2011-12-22 15:19:25 +00:00
|
|
|
*
|
|
|
|
* This file is part of the Genode OS framework, which is distributed
|
2017-02-20 12:23:52 +00:00
|
|
|
* under the terms of the GNU Affero General Public License version 3.
|
2011-12-22 15:19:25 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _INCLUDE__ROM_SESSION__CONNECTION_H_
|
|
|
|
#define _INCLUDE__ROM_SESSION__CONNECTION_H_
|
|
|
|
|
|
|
|
#include <rom_session/client.h>
|
|
|
|
#include <base/connection.h>
|
2016-05-12 12:58:51 +00:00
|
|
|
#include <base/log.h>
|
2011-12-22 15:19:25 +00:00
|
|
|
|
2015-03-04 20:12:14 +00:00
|
|
|
namespace Genode { class Rom_connection; }
|
|
|
|
|
|
|
|
|
|
|
|
class Genode::Rom_connection : public Connection<Rom_session>,
|
|
|
|
public Rom_session_client
|
|
|
|
{
|
|
|
|
public:
|
2011-12-22 15:19:25 +00: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 20:03:22 +00:00
|
|
|
class Rom_connection_failed : public Service_denied { };
|
2015-03-04 20:12:14 +00:00
|
|
|
|
base: remove Child::heap
This patch improves the accounting for the backing store of
session-state meta data. Originally, the session state used to be
allocated by a child-local heap partition fed from the child's RAM
session. However, whereas this approach was somehow practical from a
runtime's (parent's) point of view, the child component could not count
on the quota in its own RAM session. I.e., if the Child::heap grew at
the parent side, the child's RAM session would magically diminish. This
caused two problems. First, it violates assumptions of components like
init that carefully manage their RAM resources (and giving most of them
away their children). Second, if a child transfers most of its RAM
session quota to another RAM session (like init does), the child's RAM
session may actually not allow the parent's heap to grow, which is a
very difficult error condition to deal with.
In the new version, there is no Child::heap anymore. Instead, session
states are allocated from the runtime's RAM session. In order to let
children pay for these costs, the parent withdraws the local session
costs from the session quota donated from the child when the child
initiates a new session. Hence, in principle, all components on the
route of the session request take a small bite from the session quota to
pay for their local book keeping
Consequently, the session quota that ends up at the server may become
depleted more or less, depending on the route. In the case where the
remaining quota is insufficient for the server, the server responds with
'QUOTA_EXCEEDED'. Since this behavior must generally be expected, this
patch equips the client-side 'Env::session' implementation with the
ability to re-issue session requests with successively growing quota
donations.
For several of core's services (ROM, IO_MEM, IRQ), the default session
quota has now increased by 2 KiB, which should suffice for session
requests to up to 3 hops as is the common case for most run scripts. For
longer routes, the retry mechanism as described above comes into effect.
For the time being, we give a warning whenever the server-side quota
check triggers the retry mechanism. The warning may eventually be
removed at a later stage.
2017-02-19 09:31:50 +00:00
|
|
|
enum { RAM_QUOTA = 6*1024UL };
|
2016-11-06 13:26:34 +00:00
|
|
|
|
2015-03-04 20:12:14 +00:00
|
|
|
private:
|
|
|
|
|
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 14:42:15 +00:00
|
|
|
Rom_session_capability _session(Parent &, char const *label)
|
2015-03-04 20:12:14 +00:00
|
|
|
{
|
2017-05-07 20:03:25 +00:00
|
|
|
return session("ram_quota=%ld, cap_quota=%ld, label=\"%s\"",
|
|
|
|
RAM_QUOTA, CAP_QUOTA, label);
|
2015-03-04 20:12:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
public:
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor
|
|
|
|
*
|
2016-05-12 12:58:51 +00:00
|
|
|
* \param label request label and name of ROM module
|
2015-03-04 20:12:14 +00:00
|
|
|
*
|
|
|
|
* \throw Rom_connection_failed
|
|
|
|
*/
|
2016-05-12 12:58:51 +00:00
|
|
|
Rom_connection(Env &env, const char *label)
|
2016-11-08 15:37:27 +00:00
|
|
|
try :
|
2016-05-12 12:58:51 +00:00
|
|
|
Connection<Rom_session>(env, _session(env.parent(), label)),
|
2016-05-09 13:55:12 +00:00
|
|
|
Rom_session_client(cap())
|
|
|
|
{ }
|
2016-11-08 15:37:27 +00:00
|
|
|
catch (...) {
|
|
|
|
error("Could not open ROM session for \"", label, "\"");
|
|
|
|
throw Rom_connection_failed();
|
|
|
|
}
|
2016-05-09 13:55:12 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor
|
|
|
|
*
|
|
|
|
* \noapi
|
|
|
|
* \deprecated Use the constructor with 'Env &' as first
|
|
|
|
* argument instead
|
|
|
|
*/
|
2017-01-09 14:18:49 +00:00
|
|
|
Rom_connection(const char *label) __attribute__((deprecated))
|
2016-11-08 15:37:27 +00:00
|
|
|
try :
|
2017-01-09 14:18:49 +00:00
|
|
|
Connection<Rom_session>(_session(*env_deprecated()->parent(), label)),
|
|
|
|
Rom_session_client(cap())
|
|
|
|
{ }
|
|
|
|
catch (...) {
|
|
|
|
error("Could not open ROM session for \"", label, "\"");
|
|
|
|
throw Rom_connection_failed();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor
|
|
|
|
*
|
|
|
|
* \noapi
|
|
|
|
* \deprecated Use the constructor with 'Env &' as first
|
|
|
|
* argument instead
|
|
|
|
*
|
|
|
|
* This version is deliberately used by functions that are marked as
|
|
|
|
* deprecated. If such a function called directly the
|
|
|
|
* __attribute__((deprecate)) version, we would always get a warning,
|
|
|
|
* even if the outer deprecated function is not called.
|
|
|
|
*
|
|
|
|
* It will be removed as soon as they are gone.
|
|
|
|
*/
|
|
|
|
Rom_connection(bool, const char *label)
|
|
|
|
try :
|
|
|
|
Connection<Rom_session>(_session(*env_deprecated()->parent(), label)),
|
2015-03-04 20:12:14 +00:00
|
|
|
Rom_session_client(cap())
|
|
|
|
{ }
|
2016-11-08 15:37:27 +00:00
|
|
|
catch (...) {
|
|
|
|
error("Could not open ROM session for \"", label, "\"");
|
|
|
|
throw Rom_connection_failed();
|
|
|
|
}
|
2015-03-04 20:12:14 +00:00
|
|
|
};
|
2011-12-22 15:19:25 +00:00
|
|
|
|
|
|
|
#endif /* _INCLUDE__ROM_SESSION__CONNECTION_H_ */
|