mirror of
https://github.com/genodelabs/genode.git
synced 2024-12-19 21:57:55 +00:00
eba9c15746
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
139 lines
3.7 KiB
C++
139 lines
3.7 KiB
C++
/*
|
|
* \brief Environment of a component
|
|
* \author Norman Feske
|
|
* \date 2006-07-01
|
|
*
|
|
* \deprecated This interface will be removed once all components are
|
|
* adjusted to the new API of base/component.h
|
|
*/
|
|
|
|
/*
|
|
* Copyright (C) 2006-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__DEPRECATED__ENV_H_
|
|
#define _INCLUDE__DEPRECATED__ENV_H_
|
|
|
|
#include <parent/capability.h>
|
|
#include <parent/parent.h>
|
|
#include <region_map/region_map.h>
|
|
#include <rm_session/rm_session.h> /* deprecated, kept for API compatibility only */
|
|
#include <ram_session/capability.h>
|
|
#include <cpu_session/cpu_session.h>
|
|
#include <cpu_session/capability.h>
|
|
#include <pd_session/capability.h>
|
|
#include <base/allocator.h>
|
|
#include <base/snprintf.h>
|
|
#include <base/lock.h>
|
|
|
|
namespace Genode {
|
|
|
|
struct Env_deprecated;
|
|
|
|
/**
|
|
* Return the interface to the component's environment
|
|
*
|
|
* \noapi
|
|
* \deprecated
|
|
*/
|
|
extern Env_deprecated *env_deprecated();
|
|
|
|
/**
|
|
* Return the interface to the component's environment
|
|
*
|
|
* \deprecated
|
|
*/
|
|
static inline Env_deprecated *env() __attribute__((deprecated));
|
|
static inline Env_deprecated *env()
|
|
{
|
|
return env_deprecated();
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Component runtime environment
|
|
*
|
|
* The environment of a Genode component is defined by its parent. The 'Env'
|
|
* class allows the component to interact with its environment. It is
|
|
* initialized at the startup of the component.
|
|
*/
|
|
struct Genode::Env_deprecated : Interface
|
|
{
|
|
/**
|
|
* Communication channel to our parent
|
|
*/
|
|
virtual Parent *parent() = 0;
|
|
|
|
/**
|
|
* RAM session of the component
|
|
*
|
|
* The RAM Session represents a budget of memory (quota) that is
|
|
* available to the component. This budget can be used to allocate
|
|
* RAM dataspaces.
|
|
*/
|
|
virtual Ram_session *ram_session() = 0;
|
|
virtual Ram_session_capability ram_session_cap() = 0;
|
|
|
|
/**
|
|
* CPU session of the component
|
|
*
|
|
* This session is used to create the threads of the component.
|
|
*/
|
|
virtual Cpu_session *cpu_session() = 0;
|
|
virtual Cpu_session_capability cpu_session_cap() = 0;
|
|
|
|
/**
|
|
* Region-manager session of the component as created by the parent
|
|
*
|
|
* \deprecated This function exists for API compatibility only.
|
|
* The functionality of the former RM service is now
|
|
* provided by the 'Region_map' interface.
|
|
*/
|
|
virtual Region_map *rm_session() = 0;
|
|
|
|
/**
|
|
* PD session of the component as created by the parent
|
|
*/
|
|
virtual Pd_session *pd_session() = 0;
|
|
virtual Pd_session_capability pd_session_cap() = 0;
|
|
|
|
/**
|
|
* Heap backed by the RAM session of the environment
|
|
*/
|
|
virtual Allocator *heap() = 0;
|
|
|
|
/**
|
|
* Reload parent capability and reinitialize environment resources
|
|
*
|
|
* This function is solely used for implementing fork semantics.
|
|
* After forking a process, the new child process is executed
|
|
* within a copy of the address space of the forking process.
|
|
* Thereby, the new process inherits the original 'env' object of
|
|
* the forking process, which is meaningless in the context of the
|
|
* new process. By calling this function, the new process is able
|
|
* to reinitialize its 'env' with meaningful capabilities obtained
|
|
* via its updated parent capability.
|
|
*
|
|
* \noapi
|
|
*/
|
|
virtual void reinit(Native_capability::Raw) = 0;
|
|
|
|
/**
|
|
* Reinitialize main-thread object
|
|
*
|
|
* \param stack_area_rm new RM session of the stack area
|
|
*
|
|
* This function is solely used for implementing fork semantics
|
|
* as provided by the Noux environment.
|
|
*
|
|
* \noapi
|
|
*/
|
|
virtual void reinit_main_thread(Capability<Region_map> &stack_area_rm) = 0;
|
|
};
|
|
|
|
#endif /* _INCLUDE__DEPRECATED__ENV_H_ */
|