genode/repos/base-hw/src/core/kernel/irq.h
Norman Feske 6b289a1423 base/core: use references instead of pointers
This patch replaces the former prominent use of pointers by references
wherever feasible. This has the following benefits:

* The contract between caller and callee becomes more obvious. When
  passing a reference, the contract says that the argument cannot be
  a null pointer. The caller is responsible to ensure that. Therefore,
  the use of reference eliminates the need to add defensive null-pointer
  checks at the callee site, which sometimes merely exist to be on the
  safe side. The bottom line is that the code becomes easier to follow.

* Reference members must be initialized via an object initializer,
  which promotes a programming style that avoids intermediate object-
  construction states. Within core, there are still a few pointers
  as member variables left though. E.g., caused by the late association
  of 'Platform_thread' objects with their 'Platform_pd' objects.

* If no pointers are present as member variables, we don't need to
  manually provide declarations of a private copy constructor and
  an assignment operator to avoid -Weffc++ errors "class ... has
  pointer data members [-Werror=effc++]".

This patch also changes a few system bindings on NOVA and Fiasco.OC,
e.g., the return value of the global 'cap_map' accessor has become a
reference. Hence, the patch touches a few places outside of core.

Fixes #3135
2019-02-12 10:33:13 +01:00

163 lines
2.9 KiB
C++

/*
* \brief Kernel back-end and core front-end for user interrupts
* \author Martin Stein
* \author Stefan Kalkowski
* \date 2013-10-28
*/
/*
* Copyright (C) 2013-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 _CORE__KERNEL__IRQ_H_
#define _CORE__KERNEL__IRQ_H_
/* Genode includes */
#include <irq_session/irq_session.h>
#include <util/avl_tree.h>
/* base-internal includes */
#include <base/internal/unmanaged_singleton.h>
/* core includes */
#include <kernel/signal_receiver.h>
namespace Kernel
{
/**
* Kernel back-end interface of an interrupt
*/
class Irq;
/**
* Kernel back-end of a user interrupt
*/
class User_irq;
}
namespace Genode
{
/**
* Core front-end of a user interrupt
*/
class Irq;
}
class Kernel::Irq : Genode::Avl_node<Irq>
{
friend class Genode::Avl_tree<Irq>;
friend class Genode::Avl_node<Irq>;
public:
struct Pool : Genode::Avl_tree<Irq>
{
Irq * object(unsigned const id) const
{
Irq * const irq = first();
if (!irq) return nullptr;
return irq->find(id);
}
};
protected:
unsigned _irq_nr; /* kernel name of the interrupt */
Pool &_pool;
public:
/**
* Constructor
*
* \param irq interrupt number
* \param pool pool this interrupt shall belong to
*/
Irq(unsigned const irq, Pool &pool)
: _irq_nr(irq), _pool(pool) { _pool.insert(this); }
virtual ~Irq() { _pool.remove(this); }
/**
* Handle occurence of the interrupt
*/
virtual void occurred() { }
/**
* Prevent interrupt from occurring
*/
void disable() const;
/**
* Allow interrupt to occur
*/
void enable() const;
unsigned irq_number() { return _irq_nr; }
/************************
* 'Avl_node' interface *
************************/
bool higher(Irq * i) const { return i->_irq_nr > _irq_nr; }
/**
* Find irq with 'nr' within this AVL subtree
*/
Irq * find(unsigned const nr)
{
if (nr == _irq_nr) return this;
Irq * const subtree = Genode::Avl_node<Irq>::child(nr > _irq_nr);
return (subtree) ? subtree->find(nr): nullptr;
}
};
class Kernel::User_irq : public Kernel::Irq, public Kernel::Object
{
private:
Signal_context &_context;
/**
* Get map that provides all user interrupts by their kernel names
*/
static Irq::Pool &_pool();
public:
/**
* Construct object that signals interrupt 'irq' via signal 'context'
*/
User_irq(unsigned const irq, Signal_context &context)
: Irq(irq, _pool()), _context(context) { disable(); }
/**
* Destructor
*/
~User_irq() { disable(); }
/**
* Handle occurence of the interrupt
*/
void occurred()
{
_context.submit(1);
disable();
}
/**
* Handle occurence of interrupt 'irq'
*/
static User_irq * object(unsigned const irq) {
return dynamic_cast<User_irq*>(_pool().object(irq)); }
};
#endif /* _CORE__KERNEL__IRQ_H_ */