genode/repos/base/include/base/session_object.h
Norman Feske 1f4f119b1e Capability quota accounting and trading
This patch mirrors the accounting and trading scheme that Genode employs
for physical memory to the accounting of capability allocations.

Capability quotas must now be explicitly assigned to subsystems by
specifying a 'caps=<amount>' attribute to init's start nodes.
Analogously to RAM quotas, cap quotas can be traded between clients and
servers as part of the session protocol. The capability budget of each
component is maintained by the component's corresponding PD session at
core.

At the current stage, the accounting is applied to RPC capabilities,
signal-context capabilities, and dataspace capabilities. Capabilities
that are dynamically allocated via core's CPU and TRACE service are not
yet covered. Also, the capabilities allocated by resource multiplexers
outside of core (like nitpicker) must be accounted by the respective
servers, which is not covered yet.

If a component runs out of capabilities, core's PD service prints a
warning to the log. To observe the consumption of capabilities per
component in detail, the PD service is equipped with a diagnostic
mode, which can be enabled via the 'diag' attribute in the target
node of init's routing rules. E.g., the following route enables the
diagnostic mode for the PD session of the "timer" component:

  <default-route>
    <service name="PD" unscoped_label="timer">
      <parent diag="yes"/>
    </service>
    ...
  </default-route>

For subsystems based on a sub-init instance, init can be configured
to report the capability-quota information of its subsystems by
adding the attribute 'child_caps="yes"' to init's '<report>'
config node. Init's own capability quota can be reported by adding
the attribute 'init_caps="yes"'.

Fixes #2398
2017-05-31 13:16:06 +02:00

121 lines
2.8 KiB
C++

/*
* \brief RPC object that owns client-provided RAM and capability quotas
* \author Norman Feske
* \date 2017-04-28
*/
/*
* 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.
*/
#ifndef _INCLUDE__BASE__SESSION_OBJECT_H_
#define _INCLUDE__BASE__SESSION_OBJECT_H_
#include <util/arg_string.h>
#include <base/entrypoint.h>
#include <session/session.h>
namespace Genode { template <typename, typename> struct Session_object; }
template <typename RPC_INTERFACE, typename SERVER = RPC_INTERFACE>
class Genode::Session_object : public Ram_quota_guard,
public Cap_quota_guard,
public Rpc_object<RPC_INTERFACE, SERVER>
{
public:
typedef Session::Label Label;
typedef Session::Diag Diag;
typedef Session::Resources Resources;
private:
Rpc_entrypoint &_ep;
Diag _diag;
protected:
Label const _label;
public:
/**
* Constructor
*/
Session_object(Entrypoint &ep, Resources const &resources,
Label const &label, Diag diag)
:
Session_object(ep.rpc_ep(), resources, label, diag)
{ }
/**
* Constructor
*
* \deprecated This constructor exists for backward compatibility only
* and will eventually be removed.
*/
Session_object(Rpc_entrypoint &ep, Resources const &resources,
Label const &label, Diag diag)
:
Ram_quota_guard(resources.ram_quota),
Cap_quota_guard(resources.cap_quota),
_ep(ep), _diag(diag), _label(label)
{
Cap_quota_guard::withdraw(Cap_quota{1});
_ep.manage(this);
}
~Session_object()
{
_ep.dissolve(this);
Cap_quota_guard::replenish(Cap_quota{1});
}
/**
* Hook called whenever the session quota was upgraded by the client
*/
virtual void session_quota_upgraded() { }
/**
* Return client-specific session label
*/
Label label() const { return _label; }
/**
* Output label-prefixed diagnostic message conditionally
*
* The method produces output only if the session is in diagnostic
* mode (defined via the 'diag' session argument).
*/
template <typename... ARGS>
void diag(ARGS &&... args)
{
if (_diag.enabled)
log(RPC_INTERFACE::service_name(), " (", _label, ") ", args...);
}
/**
* Output label-prefixed error message
*/
template <typename... ARGS>
void error(ARGS &&... args)
{
Genode::error(RPC_INTERFACE::service_name(), " (", _label, ") ", args...);
}
/**
* Output label-prefixed error message
*/
template <typename... ARGS>
void warning(ARGS &&... args)
{
Genode::warning(RPC_INTERFACE::service_name(), " (", _label, ") ", args...);
}
};
#endif /* _INCLUDE__BASE__SESSION_OBJECT_H_ */