2016-05-09 15:55:12 +02:00
|
|
|
/*
|
|
|
|
* \brief I/O MEM dataspace utility
|
|
|
|
* \author Norman Feske
|
|
|
|
* \date 2011-05-19
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
2017-02-20 13:23:52 +01:00
|
|
|
* Copyright (C) 2011-2017 Genode Labs GmbH
|
2016-05-09 15:55:12 +02:00
|
|
|
*
|
|
|
|
* This file is part of the Genode OS framework, which is distributed
|
2017-02-20 13:23:52 +01:00
|
|
|
* under the terms of the GNU Affero General Public License version 3.
|
2016-05-09 15:55:12 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _INCLUDE__BASE__ATTACHED_IO_MEM_DATASPACE_H_
|
|
|
|
#define _INCLUDE__BASE__ATTACHED_IO_MEM_DATASPACE_H_
|
|
|
|
|
|
|
|
#include <io_mem_session/connection.h>
|
|
|
|
#include <base/env.h>
|
|
|
|
|
|
|
|
namespace Genode { class Attached_io_mem_dataspace; }
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Request and locally attach a memory-mapped I/O resource
|
|
|
|
*
|
|
|
|
* This class is a wrapper for a typical sequence of operations performed
|
|
|
|
* by device drivers to access memory-mapped device resources. Its sole
|
|
|
|
* purpose is to avoid duplicated code.
|
|
|
|
*/
|
|
|
|
class Genode::Attached_io_mem_dataspace
|
|
|
|
{
|
|
|
|
private:
|
|
|
|
|
|
|
|
Region_map &_env_rm;
|
|
|
|
Io_mem_connection _mmio;
|
|
|
|
Io_mem_dataspace_capability _ds;
|
|
|
|
void *_local_addr;
|
|
|
|
|
|
|
|
public:
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor
|
|
|
|
*
|
|
|
|
* \param base base address of memory-mapped I/O resource
|
|
|
|
* \param size size of resource
|
|
|
|
* \param write_combined enable write combining for the resource
|
|
|
|
*
|
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-05-08 14:32:03 +02:00
|
|
|
* \throw Insufficient_ram_quota
|
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-08 21:35:43 +02:00
|
|
|
* \throw Insufficient_cap_quota
|
2017-05-08 19:55:54 +02:00
|
|
|
* \throw Out_of_ram
|
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-08 21:35:43 +02:00
|
|
|
* \throw Out_of_caps
|
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 Region_map::Region_conflict
|
|
|
|
* \throw Region_map::Invalid_dataspace
|
2016-05-09 15:55:12 +02:00
|
|
|
*/
|
|
|
|
Attached_io_mem_dataspace(Env &env, Genode::addr_t base, Genode::size_t size,
|
|
|
|
bool write_combined = false)
|
|
|
|
:
|
|
|
|
_env_rm(env.rm()),
|
|
|
|
_mmio(env, base, size, write_combined),
|
|
|
|
_ds(_mmio.dataspace()),
|
|
|
|
_local_addr(env.rm().attach(_ds))
|
|
|
|
{
|
|
|
|
/* apply sub-page offset to virtual address */
|
|
|
|
_local_addr = (void *)((addr_t)_local_addr | (base & (addr_t)0xfff));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor
|
|
|
|
*
|
|
|
|
* \noapi
|
|
|
|
* \deprecated Use the constructor with 'Env &' as first
|
|
|
|
* argument instead
|
|
|
|
*/
|
|
|
|
Attached_io_mem_dataspace(Genode::addr_t base, Genode::size_t size,
|
2017-01-09 15:18:49 +01:00
|
|
|
bool write_combined = false) __attribute__((deprecated))
|
2016-05-09 15:55:12 +02:00
|
|
|
:
|
2017-01-09 15:18:49 +01:00
|
|
|
_env_rm(*env_deprecated()->rm_session()),
|
|
|
|
_mmio(false, base, size, write_combined),
|
2016-05-09 15:55:12 +02:00
|
|
|
_ds(_mmio.dataspace()),
|
|
|
|
_local_addr(_env_rm.attach(_ds))
|
|
|
|
{
|
|
|
|
/* apply sub-page offset to virtual address */
|
|
|
|
_local_addr = (void *)((addr_t)_local_addr | (base & (addr_t)0xfff));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Destructor
|
|
|
|
*/
|
|
|
|
~Attached_io_mem_dataspace() { _env_rm.detach(_local_addr); }
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Return capability of the used RAM dataspace
|
|
|
|
*/
|
|
|
|
Io_mem_dataspace_capability cap() { return _ds; }
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Request local address
|
|
|
|
*
|
|
|
|
* This is a template to avoid inconvenient casts at the caller.
|
|
|
|
* A newly allocated I/O MEM dataspace is untyped memory anyway.
|
|
|
|
*/
|
|
|
|
template <typename T>
|
|
|
|
T *local_addr() { return static_cast<T *>(_local_addr); }
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif /* _INCLUDE__BASE__ATTACHED_IO_MEM_DATASPACE_H_ */
|