236 lines
6.2 KiB
C++
236 lines
6.2 KiB
C++
/*
|
|
* \brief Back end used for obtaining multi-boot modules
|
|
* \author Norman Feske
|
|
* \author Markus Partheymueller
|
|
* \date 2011-11-20
|
|
*/
|
|
|
|
/*
|
|
* Copyright (C) 2011-2017 Genode Labs GmbH
|
|
* Copyright (C) 2012 Intel Corporation
|
|
*
|
|
* This file is distributed under the terms of the GNU General Public License
|
|
* version 2.
|
|
*
|
|
* The code is partially based on the Vancouver VMM, which is distributed
|
|
* under the terms of the GNU General Public License version 2.
|
|
*
|
|
* Modifications by Intel Corporation are contributed under the terms and
|
|
* conditions of the GNU General Public License version 2.
|
|
*/
|
|
|
|
#ifndef _BOOT_MODULE_PROVIDER_H_
|
|
#define _BOOT_MODULE_PROVIDER_H_
|
|
|
|
/* Genode includes */
|
|
#include <util/string.h>
|
|
#include <util/misc_math.h>
|
|
#include <util/xml_node.h>
|
|
#include <base/log.h>
|
|
#include <rom_session/connection.h>
|
|
|
|
|
|
class Boot_module_provider
|
|
{
|
|
private:
|
|
|
|
Genode::Xml_node _multiboot_node;
|
|
|
|
enum { MODULE_NAME_MAX_LEN = 48 };
|
|
|
|
typedef Genode::String<MODULE_NAME_MAX_LEN> Name;
|
|
|
|
public:
|
|
|
|
/**
|
|
* Exception class
|
|
*/
|
|
class Destination_buffer_too_small { };
|
|
class Module_loading_failed { };
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* \param multiboot_node XML node containing the list of boot modules
|
|
* as sub nodes
|
|
*/
|
|
Boot_module_provider(Genode::Xml_node multiboot_node)
|
|
:
|
|
_multiboot_node(multiboot_node)
|
|
{ }
|
|
|
|
|
|
/************************************
|
|
** Boot_module_provider interface **
|
|
************************************/
|
|
|
|
/**
|
|
* Copy module data to specified buffer
|
|
*
|
|
* \return module size in bytes, or 0 if module does not exist
|
|
* \throw Destination_buffer_too_small
|
|
*/
|
|
Genode::size_t data(Genode::Env &env, int module_index,
|
|
void *dst, Genode::size_t dst_len) const
|
|
{
|
|
using namespace Genode;
|
|
|
|
try {
|
|
Xml_node mod_node = _multiboot_node.sub_node(module_index);
|
|
|
|
if (mod_node.has_type("rom")) {
|
|
|
|
/*
|
|
* Determine ROM file name, which is specified as 'label'
|
|
* attribute of the 'rom' node. If no 'label' argument is
|
|
* provided, use the 'name' attribute as file name.
|
|
*/
|
|
Name const label = mod_node.has_attribute("label")
|
|
? mod_node.attribute_value("label", Name())
|
|
: mod_node.attribute_value("name", Name());
|
|
/*
|
|
* Open ROM session
|
|
*/
|
|
Rom_connection rom(env, label.string());
|
|
Dataspace_capability ds = rom.dataspace();
|
|
Genode::size_t const src_len = Dataspace_client(ds).size();
|
|
|
|
if (src_len > dst_len) {
|
|
warning(__func__, ": src_len=", src_len, " dst_len=", dst_len);
|
|
throw Destination_buffer_too_small();
|
|
}
|
|
|
|
void * const src = env.rm().attach(ds);
|
|
|
|
/*
|
|
* Copy content to destination buffer
|
|
*/
|
|
Genode::memcpy(dst, src, src_len);
|
|
|
|
/*
|
|
* Detach ROM dataspace from local address space. The ROM
|
|
* session will be closed automatically when we leave the
|
|
* current scope and the 'rom' object gets destructed.
|
|
*/
|
|
env.rm().detach(src);
|
|
|
|
return src_len;
|
|
|
|
} else if (mod_node.has_type("inline")) {
|
|
|
|
/*
|
|
* Copy inline content directly to destination buffer
|
|
*/
|
|
mod_node.with_raw_content([&] (char const *ptr, size_t size) {
|
|
Genode::memcpy(dst, ptr, size); });
|
|
|
|
return mod_node.content_size();
|
|
}
|
|
|
|
warning("XML node ", module_index, " in multiboot node has unexpected type");
|
|
|
|
throw Module_loading_failed();
|
|
}
|
|
catch (Xml_node::Nonexistent_sub_node) { }
|
|
catch (Xml_node::Nonexistent_attribute) { }
|
|
catch (Destination_buffer_too_small) {
|
|
error("Boot_module_provider: destination buffer too small"); }
|
|
catch (Region_map::Region_conflict) {
|
|
error("Boot_module_provider: Region_map::Region_conflict");
|
|
throw Module_loading_failed(); }
|
|
catch (Region_map::Invalid_dataspace) {
|
|
error("Boot_module_provider: Region_map::Invalid_dataspace");
|
|
throw Module_loading_failed(); }
|
|
catch (Rom_connection::Rom_connection_failed) {
|
|
error("Boot_module_provider: Rom_connection_failed"); }
|
|
catch (...) {
|
|
error("Boot_module_provider: Spurious exception");
|
|
throw Module_loading_failed();
|
|
}
|
|
|
|
/*
|
|
* We should get here only if there are XML parsing errors
|
|
*/
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* Copy command line to specified buffer
|
|
*
|
|
* \return length of command line in bytes, or 0 if module does not exist
|
|
*/
|
|
Genode::size_t cmdline(int module_index,
|
|
char *dst, Genode::size_t dst_len) const
|
|
{
|
|
using namespace Genode;
|
|
|
|
try {
|
|
Xml_node mod_node = _multiboot_node.sub_node(module_index);
|
|
|
|
if (mod_node.has_type("rom") || mod_node.has_type("inline")) {
|
|
|
|
Genode::size_t cmd_len = 0;
|
|
|
|
Name const name = mod_node.attribute_value("name", Name());
|
|
|
|
Genode::size_t const name_len = Genode::strlen(name.string());
|
|
|
|
/*
|
|
* Check if destination buffer can hold the name including
|
|
* the zero termination.
|
|
*/
|
|
if (name_len + 1 >= dst_len)
|
|
return 0;
|
|
|
|
/* copy name to command line */
|
|
copy_cstring(&dst[cmd_len], name.string(), name_len + 1);
|
|
cmd_len += name_len;
|
|
|
|
/* check if name fills entire destination buffer */
|
|
if (cmd_len + 1 == dst_len) {
|
|
dst[cmd_len++] = 0;
|
|
return cmd_len;
|
|
}
|
|
|
|
if (mod_node.has_attribute("cmdline")) {
|
|
|
|
typedef String<256> Cmdline;
|
|
Cmdline const cmdline = mod_node.attribute_value("cmdline", Cmdline());
|
|
|
|
/* add single space between name and arguments */
|
|
dst[cmd_len++] = ' ';
|
|
if (cmd_len + 1 == dst_len) {
|
|
dst[cmd_len++] = 0;
|
|
return cmd_len;
|
|
}
|
|
|
|
/* copy 'cmdline' attribute to destination buffer */
|
|
copy_cstring(&dst[cmd_len], cmdline.string(), dst_len - cmd_len);
|
|
|
|
/*
|
|
* The string returned by the 'value' function is
|
|
* zero-terminated. Count and return the total number
|
|
* of command-line characters.
|
|
*/
|
|
return Genode::strlen(dst);
|
|
|
|
}
|
|
|
|
return cmd_len;
|
|
}
|
|
|
|
warning("XML node ", module_index, " in multiboot node has unexpected type");
|
|
|
|
return 0;
|
|
}
|
|
catch (Xml_node::Nonexistent_sub_node) { }
|
|
|
|
/*
|
|
* We should get here only if there are XML parsing errors
|
|
*/
|
|
return 0;
|
|
}
|
|
};
|
|
|
|
#endif /* _BOOT_MODULE_PROVIDER_H_ */
|