2016-01-19 20:24:22 +01:00
|
|
|
/*
|
|
|
|
* \brief Core implementation of the PD session interface
|
|
|
|
* \author Norman Feske
|
|
|
|
* \date 2012-08-15
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
2017-02-20 13:23:52 +01:00
|
|
|
* Copyright (C) 2012-2017 Genode Labs GmbH
|
2016-01-19 20:24:22 +01: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-01-19 20:24:22 +01:00
|
|
|
*/
|
|
|
|
|
|
|
|
/* Genode includes */
|
|
|
|
#include <util/arg_string.h>
|
base: avoid use of deprecated base/printf.h
Besides adapting the components to the use of base/log.h, the patch
cleans up a few base headers, i.e., it removes unused includes from
root/component.h, specifically base/heap.h and
ram_session/ram_session.h. Hence, components that relied on the implicit
inclusion of those headers have to manually include those headers now.
While adjusting the log messages, I repeatedly stumbled over the problem
that printing char * arguments is ambiguous. It is unclear whether to
print the argument as pointer or null-terminated string. To overcome
this problem, the patch introduces a new type 'Cstring' that allows the
caller to express that the argument should be handled as null-terminated
string. As a nice side effect, with this type in place, the optional len
argument of the 'String' class could be removed. Instead of supplying a
pair of (char const *, size_t), the constructor accepts a 'Cstring'.
This, in turn, clears the way let the 'String' constructor use the new
output mechanism to assemble a string from multiple arguments (and
thereby getting rid of snprintf within Genode in the near future).
To enforce the explicit resolution of the char * ambiguity, the 'char *'
overload of the 'print' function is marked as deleted.
Issue #1987
2016-07-13 19:07:09 +02:00
|
|
|
#include <base/log.h>
|
2016-01-19 20:24:22 +01:00
|
|
|
#include <base/snprintf.h>
|
|
|
|
|
|
|
|
/* core-local includes */
|
|
|
|
#include <pd_session_component.h>
|
|
|
|
#include <dataspace_component.h>
|
|
|
|
|
2016-06-13 13:53:58 +02:00
|
|
|
/* base-internal includes */
|
|
|
|
#include <base/internal/parent_socket_handle.h>
|
2016-06-15 15:04:54 +02:00
|
|
|
#include <base/internal/capability_space_tpl.h>
|
2016-06-13 13:53:58 +02:00
|
|
|
|
2016-01-19 20:24:22 +01:00
|
|
|
/* Linux includes */
|
|
|
|
#include <core_linux_syscalls.h>
|
|
|
|
|
|
|
|
using namespace Genode;
|
|
|
|
|
|
|
|
|
|
|
|
/***************
|
|
|
|
** Utilities **
|
|
|
|
***************/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Argument frame for passing 'execve' paremeters through 'clone'
|
|
|
|
*/
|
|
|
|
struct Execve_args
|
|
|
|
{
|
|
|
|
char const *filename;
|
|
|
|
char * const *argv;
|
|
|
|
char * const *envp;
|
|
|
|
int const parent_sd;
|
|
|
|
|
|
|
|
Execve_args(char const *filename,
|
|
|
|
char * const *argv,
|
|
|
|
char * const *envp,
|
|
|
|
int parent_sd)
|
|
|
|
:
|
2016-03-08 15:58:05 +01:00
|
|
|
filename(filename), argv(argv), envp(envp), parent_sd(parent_sd)
|
2016-01-19 20:24:22 +01:00
|
|
|
{ }
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Startup code of the new child process
|
|
|
|
*/
|
|
|
|
static int _exec_child(Execve_args *arg)
|
|
|
|
{
|
|
|
|
lx_dup2(arg->parent_sd, PARENT_SOCKET_HANDLE);
|
|
|
|
|
|
|
|
return lx_execve(arg->filename, arg->argv, arg->envp);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* List of Unix environment variables, initialized by the startup code
|
|
|
|
*/
|
|
|
|
extern char **lx_environ;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Read environment variable as string
|
|
|
|
*
|
|
|
|
* If no matching key exists, return an empty string.
|
|
|
|
*/
|
|
|
|
static const char *get_env(const char *key)
|
|
|
|
{
|
|
|
|
Genode::size_t key_len = Genode::strlen(key);
|
|
|
|
for (char **curr = lx_environ; curr && *curr; curr++)
|
|
|
|
if ((Genode::strcmp(*curr, key, key_len) == 0) && (*curr)[key_len] == '=')
|
|
|
|
return (const char *)(*curr + key_len + 1);
|
|
|
|
|
|
|
|
return "";
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**************************
|
|
|
|
** PD session interface **
|
|
|
|
**************************/
|
|
|
|
|
|
|
|
void Native_pd_component::_start(Dataspace_component &ds)
|
|
|
|
{
|
|
|
|
const char *tmp_filename = "temporary_executable_elf_dataspace_file_for_execve";
|
|
|
|
|
|
|
|
/* we need 's' on stack to make it an lvalue with an lvalue member we use the pointer to */
|
|
|
|
Linux_dataspace::Filename s = ds.fname();
|
|
|
|
const char *filename = s.buf;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* In order to be executable via 'execve', a program must be represented as
|
|
|
|
* a file on the Linux file system. However, this is not the case for a
|
|
|
|
* plain RAM dataspace that contains an ELF image. In this case, we copy
|
|
|
|
* the dataspace content into a temporary file whose path is passed to
|
|
|
|
* 'execve()'.
|
|
|
|
*/
|
|
|
|
if (strcmp(filename, "") == 0) {
|
|
|
|
|
|
|
|
filename = tmp_filename;
|
|
|
|
|
|
|
|
int tmp_binary_fd = lx_open(filename, O_CREAT | O_EXCL | O_WRONLY, S_IRWXU);
|
|
|
|
if (tmp_binary_fd < 0) {
|
base: avoid use of deprecated base/printf.h
Besides adapting the components to the use of base/log.h, the patch
cleans up a few base headers, i.e., it removes unused includes from
root/component.h, specifically base/heap.h and
ram_session/ram_session.h. Hence, components that relied on the implicit
inclusion of those headers have to manually include those headers now.
While adjusting the log messages, I repeatedly stumbled over the problem
that printing char * arguments is ambiguous. It is unclear whether to
print the argument as pointer or null-terminated string. To overcome
this problem, the patch introduces a new type 'Cstring' that allows the
caller to express that the argument should be handled as null-terminated
string. As a nice side effect, with this type in place, the optional len
argument of the 'String' class could be removed. Instead of supplying a
pair of (char const *, size_t), the constructor accepts a 'Cstring'.
This, in turn, clears the way let the 'String' constructor use the new
output mechanism to assemble a string from multiple arguments (and
thereby getting rid of snprintf within Genode in the near future).
To enforce the explicit resolution of the char * ambiguity, the 'char *'
overload of the 'print' function is marked as deleted.
Issue #1987
2016-07-13 19:07:09 +02:00
|
|
|
error("Could not create file '", filename, "'");
|
2016-01-19 20:24:22 +01:00
|
|
|
return; /* XXX reflect error to client */
|
|
|
|
}
|
|
|
|
|
|
|
|
char buf[4096];
|
|
|
|
int num_bytes = 0;
|
2016-06-15 15:04:54 +02:00
|
|
|
int const fd_socket = Capability_space::ipc_cap_data(ds.fd()).dst.socket;
|
|
|
|
while ((num_bytes = lx_read(fd_socket, buf, sizeof(buf))) != 0)
|
2016-01-19 20:24:22 +01:00
|
|
|
lx_write(tmp_binary_fd, buf, num_bytes);
|
|
|
|
|
|
|
|
lx_close(tmp_binary_fd);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* pass parent capability as environment variable to the child */
|
|
|
|
enum { ENV_STR_LEN = 256 };
|
|
|
|
static char envbuf[5][ENV_STR_LEN];
|
|
|
|
Genode::snprintf(envbuf[1], ENV_STR_LEN, "parent_local_name=%lu",
|
|
|
|
_pd_session._parent.local_name());
|
|
|
|
Genode::snprintf(envbuf[2], ENV_STR_LEN, "DISPLAY=%s",
|
|
|
|
get_env("DISPLAY"));
|
|
|
|
Genode::snprintf(envbuf[3], ENV_STR_LEN, "HOME=%s",
|
|
|
|
get_env("HOME"));
|
|
|
|
Genode::snprintf(envbuf[4], ENV_STR_LEN, "LD_LIBRARY_PATH=%s",
|
|
|
|
get_env("LD_LIBRARY_PATH"));
|
|
|
|
|
|
|
|
char *env[] = { &envbuf[0][0], &envbuf[1][0], &envbuf[2][0],
|
|
|
|
&envbuf[3][0], &envbuf[4][0], 0 };
|
|
|
|
|
|
|
|
/* prefix name of Linux program (helps killing some zombies) */
|
|
|
|
char const *prefix = "[Genode] ";
|
|
|
|
char pname_buf[sizeof(_pd_session._label) + sizeof(prefix)];
|
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
|
|
|
snprintf(pname_buf, sizeof(pname_buf), "%s%s", prefix, _pd_session._label.string());
|
2016-01-19 20:24:22 +01:00
|
|
|
char *argv_buf[2];
|
|
|
|
argv_buf[0] = pname_buf;
|
|
|
|
argv_buf[1] = 0;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* We cannot create the new process via 'fork()' because all our used
|
|
|
|
* memory including stack memory is backed by dataspaces, which had been
|
|
|
|
* mapped with the 'MAP_SHARED' flag. Therefore, after being created, the
|
|
|
|
* new process starts using the stack with the same physical memory pages
|
|
|
|
* as used by parent process. This would ultimately lead to stack
|
|
|
|
* corruption. To prevent both processes from concurrently accessing the
|
|
|
|
* same stack, we pause the execution of the parent until the child calls
|
|
|
|
* 'execve'. From then on, the child has its private memory layout. The
|
|
|
|
* desired behaviour is normally provided by 'vfork' but we use the more
|
|
|
|
* modern 'clone' call for this purpose.
|
|
|
|
*/
|
|
|
|
enum { STACK_SIZE = 4096 };
|
|
|
|
static char stack[STACK_SIZE]; /* initial stack used by the child until
|
|
|
|
calling 'execve' */
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Argument frame as passed to 'clone'. Because, we can only pass a single
|
|
|
|
* pointer, all arguments are embedded within the 'execve_args' struct.
|
|
|
|
*/
|
2016-03-08 15:58:05 +01:00
|
|
|
Execve_args arg(filename, argv_buf, env,
|
2016-06-15 15:04:54 +02:00
|
|
|
Capability_space::ipc_cap_data(_pd_session._parent).dst.socket);
|
2016-01-19 20:24:22 +01:00
|
|
|
|
|
|
|
_pid = lx_create_process((int (*)(void *))_exec_child,
|
|
|
|
stack + STACK_SIZE - sizeof(umword_t), &arg);
|
|
|
|
|
|
|
|
if (strcmp(filename, tmp_filename) == 0)
|
|
|
|
lx_unlink(filename);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
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
|
|
|
Native_pd_component::Native_pd_component(Pd_session_component &pd, const char *)
|
2016-01-19 20:24:22 +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
|
|
|
_pd_session(pd)
|
2016-01-19 20:24:22 +01:00
|
|
|
{
|
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
|
|
|
_pd_session._ep.manage(this);
|
2016-01-19 20:24:22 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
Native_pd_component::~Native_pd_component()
|
|
|
|
{
|
|
|
|
if (_pid)
|
|
|
|
lx_kill(_pid, 9);
|
|
|
|
|
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
|
|
|
_pd_session._ep.dissolve(this);
|
2016-01-19 20:24:22 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
void Native_pd_component::start(Capability<Dataspace> binary)
|
|
|
|
{
|
|
|
|
/* lookup binary dataspace */
|
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
|
|
|
_pd_session._ep.apply(binary, [&] (Dataspace_component *ds) {
|
2016-01-19 20:24:22 +01:00
|
|
|
|
|
|
|
if (ds)
|
|
|
|
_start(*ds);
|
|
|
|
else
|
base: avoid use of deprecated base/printf.h
Besides adapting the components to the use of base/log.h, the patch
cleans up a few base headers, i.e., it removes unused includes from
root/component.h, specifically base/heap.h and
ram_session/ram_session.h. Hence, components that relied on the implicit
inclusion of those headers have to manually include those headers now.
While adjusting the log messages, I repeatedly stumbled over the problem
that printing char * arguments is ambiguous. It is unclear whether to
print the argument as pointer or null-terminated string. To overcome
this problem, the patch introduces a new type 'Cstring' that allows the
caller to express that the argument should be handled as null-terminated
string. As a nice side effect, with this type in place, the optional len
argument of the 'String' class could be removed. Instead of supplying a
pair of (char const *, size_t), the constructor accepts a 'Cstring'.
This, in turn, clears the way let the 'String' constructor use the new
output mechanism to assemble a string from multiple arguments (and
thereby getting rid of snprintf within Genode in the near future).
To enforce the explicit resolution of the char * ambiguity, the 'char *'
overload of the 'print' function is marked as deleted.
Issue #1987
2016-07-13 19:07:09 +02:00
|
|
|
error("failed to lookup binary to start");
|
2016-01-19 20:24:22 +01:00
|
|
|
});
|
|
|
|
};
|