Martin Stein 1336b0a751 mmio: upper-bounds checks
The classes Genode::Mmio, Genode::Register_set, Genode::Attached_mmio, and
Platform::Device::Mmio now receive a template parameter 'size_t SIZE'. In each
type that derives from one of these classes, it is now statically checked that
the range of each Genode::Register::Register- and
Genode::Register_set::Register_array-deriving sub-type is within [0..SIZE).

That said, SIZE is the minimum size of the memory region provided to the above
mentioned Mmio classes in order to avoid page faults or memory corruption when
accessing the registers and register arrays declared inside.

Note, that the range end of a register array is not the end of the last item
but the end of integer access that is used for accessing the last bit in the
last item.

The constructors of Genode::Mmio, Genode::Attached_mmio, and
Platform::Device::Mmio now receive an argument 'Byte_range_ptr range' that is
expected to be the range of the backing memory region. In each type that derives
from on of these classes, it is now dynamically checked that 'range.num_bytes
>= SIZE', thereby implementing the above mention protection against page faults
and memory corruption.

The rest of the commit adapts the code throughout the Genode Labs repositories
regarding the changes. Note that for that code inside Core, the commits mostly
uses a simplified approach by constructing MMIO objects with range
[base..base+SIZE) and not with a mapping- or specification-related range size.
This should be fixed in the future.

Furthermore, there are types that derive from an MMIO class but don't declare
any registers or register arrays (especially with Platform::Device::Mmio). In
this case SIZE is set to 0. This way, the parameters must be actively corrected
by someone who later wants to add registers or register arrays, plus the places
can be easily found by grep'ing for Mmio<0>.

Fix #4081
2024-02-26 08:59:07 +01:00

120 lines
3.1 KiB
C++

/*
* \brief Platform driver - PCI Virtio utilities
* \author Stefan Kalkowski
* \date 2022-09-19
*/
/*
* Copyright (C) 2022 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.
*/
#include <util/mmio.h>
#include <pci/config.h>
#include <device.h>
namespace Driver {
void pci_virtio_info(Device const &, Device::Pci_config const &, Env &,
Xml_generator &);
}
void Driver::pci_virtio_info(Device const & dev,
Device::Pci_config const & cfg,
Env & env,
Xml_generator & xml)
{
enum { VENDOR_RED_HAT = 0x1af4 };
if (cfg.vendor_id != VENDOR_RED_HAT)
return;
struct Virtio : Pci::Config
{
struct Capability : Pci::Config::Pci_capability<0x14>
{
enum { COMMON = 1, NOTIFY = 2, ISR = 3, DEVICE = 4 };
struct Type : Register<0x3, 8> {};
struct Bar : Register<0x4, 8> {};
struct Offset : Register<0x8, 32> {};
struct Length : Register<0xc, 32> {};
struct Offset_factor : Register<0x10, 32> {};
using Pci_capability::Pci_capability;
bool valid()
{
switch (read<Type>()) {
case COMMON:
case NOTIFY:
case ISR:
case DEVICE:
return true;
};
return false;
}
String<16> name()
{
switch (read<Type>()) {
case COMMON: return "common";
case NOTIFY: return "notify";
case ISR: return "irq_status";
case DEVICE: return "device";
};
return "unknown";
}
};
using Pci::Config::Config;
void capability(Capability & cap,
Driver::Device const & dev,
Xml_generator & xml)
{
unsigned idx = ~0U;
dev.for_each_io_mem([&] (unsigned i,
Driver::Device::Io_mem::Range,
Driver::Device::Pci_bar bar, bool) {
if (bar.number == cap.read<Capability::Bar>()) idx = i; });
xml.node("virtio_range", [&] () {
xml.attribute("type", cap.name());
xml.attribute("index", idx);
xml.attribute("offset", cap.read<Capability::Offset>());
xml.attribute("size", cap.read<Capability::Length>());
if (cap.read<Capability::Type>() == Capability::NOTIFY)
xml.attribute("factor",
cap.read<Capability::Offset_factor>());
});
}
void for_each_capability(Driver::Device const & dev,
Xml_generator & xml)
{
if (!read<Status::Capabilities>())
return;
uint16_t off = read<Capability_pointer>();
while (off) {
Capability cap(Mmio::range_at(off));
if (cap.read<Capability::Id>() ==
Capability::Id::VENDOR &&
cap.valid())
capability(cap, dev, xml);
off = cap.read<Capability::Pointer>();
}
}
};
static constexpr size_t IO_MEM_SIZE = 0x1000;
Attached_io_mem_dataspace io_mem(env, cfg.addr, IO_MEM_SIZE);
Virtio config({io_mem.local_addr<char>(), IO_MEM_SIZE});
config.for_each_capability(dev, xml);
}