mirror of
https://github.com/genodelabs/genode.git
synced 2025-06-12 20:28:20 +00:00
committed by
Christian Helmuth
parent
a6fb61dbf2
commit
149bd999f3
227
repos/os/include/vfs/value_file_system.h
Normal file
227
repos/os/include/vfs/value_file_system.h
Normal file
@ -0,0 +1,227 @@
|
||||
/*
|
||||
* \brief File system for providing a value as a file
|
||||
* \author Josef Soentgen
|
||||
* \author Sebastian Sumpf
|
||||
* \date 2018-11-24
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2018-2019 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 _VALUE_FILE_SYSTEM_H_
|
||||
#define _VALUE_FILE_SYSTEM_H_
|
||||
|
||||
/* Genode includes */
|
||||
#include <util/xml_generator.h>
|
||||
#include <vfs/single_file_system.h>
|
||||
|
||||
namespace Vfs {
|
||||
template <typename, unsigned BUF_SIZE = 64>
|
||||
class Value_file_system;
|
||||
}
|
||||
|
||||
|
||||
template <typename T, unsigned BUF_SIZE>
|
||||
class Vfs::Value_file_system : public Vfs::Single_file_system
|
||||
{
|
||||
public:
|
||||
|
||||
typedef Genode::String<64> Name;
|
||||
|
||||
private:
|
||||
|
||||
typedef Genode::String<BUF_SIZE + 1> Buffer;
|
||||
|
||||
Name const _file_name;
|
||||
|
||||
Buffer _buffer { };
|
||||
|
||||
struct Vfs_handle : Single_vfs_handle
|
||||
{
|
||||
Value_file_system &_value_fs;
|
||||
Buffer &_buffer{ _value_fs._buffer };
|
||||
|
||||
Vfs_handle(Value_file_system &value_fs,
|
||||
Allocator &alloc)
|
||||
:
|
||||
Single_vfs_handle(value_fs, value_fs, alloc, 0),
|
||||
_value_fs(value_fs)
|
||||
{ }
|
||||
|
||||
Read_result read(char *dst, file_size count,
|
||||
file_size &out_count) override
|
||||
{
|
||||
out_count = 0;
|
||||
|
||||
if (seek() > _buffer.length())
|
||||
return READ_ERR_INVALID;
|
||||
|
||||
char const * const src = _buffer.string() + seek();
|
||||
Genode::size_t const len = min(_buffer.length() - seek(), count);
|
||||
Genode::memcpy(dst, src, len);
|
||||
|
||||
out_count = len;
|
||||
return READ_OK;
|
||||
}
|
||||
|
||||
Write_result write(char const *src, file_size count, file_size &out_count) override
|
||||
{
|
||||
out_count = 0;
|
||||
if (seek() > BUF_SIZE)
|
||||
return WRITE_ERR_INVALID;
|
||||
|
||||
Genode::size_t const len = min(BUF_SIZE- seek(), count);
|
||||
_buffer = Buffer(Genode::Cstring(src, len));
|
||||
out_count = len;
|
||||
|
||||
/* inform watchers */
|
||||
_value_fs._watch_response();
|
||||
|
||||
return WRITE_OK;
|
||||
}
|
||||
|
||||
bool read_ready() override { return true; }
|
||||
|
||||
private:
|
||||
|
||||
Vfs_handle(Vfs_handle const &);
|
||||
Vfs_handle &operator = (Vfs_handle const &);
|
||||
};
|
||||
|
||||
struct Watch_handle;
|
||||
using Watch_handle_registry = Genode::Registry<Watch_handle>;
|
||||
|
||||
struct Watch_handle : Vfs_watch_handle
|
||||
{
|
||||
typename Watch_handle_registry::Element elem;
|
||||
|
||||
Watch_handle(Watch_handle_registry ®istry,
|
||||
Vfs::File_system &fs,
|
||||
Allocator &alloc)
|
||||
: Vfs_watch_handle(fs, alloc), elem(registry, *this) { }
|
||||
};
|
||||
|
||||
Watch_handle_registry _watch_handle_registry { };
|
||||
|
||||
|
||||
void _watch_response() {
|
||||
_watch_handle_registry.for_each([&] (Watch_handle &h) {
|
||||
h.watch_response();
|
||||
});
|
||||
}
|
||||
|
||||
typedef Genode::String<200> Config;
|
||||
Config _config(Name const &name) const
|
||||
{
|
||||
char buf[Config::capacity()] { };
|
||||
Genode::Xml_generator xml(buf, sizeof(buf), type_name(), [&] () {
|
||||
xml.attribute("name", name); });
|
||||
return Config(Genode::Cstring(buf));
|
||||
}
|
||||
|
||||
|
||||
public:
|
||||
|
||||
Value_file_system(Name const &name, Buffer const &initial_value)
|
||||
:
|
||||
Single_file_system(Node_type::TRANSACTIONAL_FILE, type(),
|
||||
Node_rwx::rw(), Xml_node(_config(name).string())),
|
||||
_file_name(name)
|
||||
{
|
||||
value(initial_value);
|
||||
}
|
||||
|
||||
static char const *type_name() { return "value"; }
|
||||
|
||||
char const *type() override { return type_name(); }
|
||||
|
||||
void value(Buffer const &value)
|
||||
{
|
||||
_buffer = Buffer(value);
|
||||
}
|
||||
|
||||
T value()
|
||||
{
|
||||
T val { 0 };
|
||||
Genode::ascii_to(_buffer.string(), val);
|
||||
|
||||
return val;
|
||||
}
|
||||
|
||||
Buffer buffer() const { return _buffer; }
|
||||
|
||||
bool matches(Xml_node node) const
|
||||
{
|
||||
return node.has_type(type_name()) &&
|
||||
node.attribute_value("name", Name()) == _file_name;
|
||||
}
|
||||
|
||||
|
||||
/********************************
|
||||
** File I/O service interface **
|
||||
********************************/
|
||||
|
||||
Ftruncate_result ftruncate(Vfs::Vfs_handle *, file_size size) override
|
||||
{
|
||||
if (size >= BUF_SIZE)
|
||||
return FTRUNCATE_ERR_NO_SPACE;
|
||||
|
||||
return FTRUNCATE_OK;
|
||||
}
|
||||
|
||||
|
||||
/*********************************
|
||||
** Directory-service interface **
|
||||
*********************************/
|
||||
|
||||
Open_result open(char const *path, unsigned,
|
||||
Vfs::Vfs_handle **out_handle,
|
||||
Allocator &alloc) override
|
||||
{
|
||||
if (!_single_file(path))
|
||||
return OPEN_ERR_UNACCESSIBLE;
|
||||
|
||||
try {
|
||||
*out_handle = new (alloc) Vfs_handle(*this, alloc);
|
||||
return OPEN_OK;
|
||||
}
|
||||
catch (Genode::Out_of_ram) { Genode::error("out of ram"); return OPEN_ERR_OUT_OF_RAM; }
|
||||
catch (Genode::Out_of_caps) { Genode::error("out of caps");return OPEN_ERR_OUT_OF_CAPS; }
|
||||
}
|
||||
|
||||
Stat_result stat(char const *path, Stat &out) override
|
||||
{
|
||||
Stat_result result = Single_file_system::stat(path, out);
|
||||
out.size = _buffer.length();
|
||||
return result;
|
||||
}
|
||||
|
||||
Watch_result watch(char const *path,
|
||||
Vfs_watch_handle **handle,
|
||||
Allocator &alloc) override
|
||||
{
|
||||
if (!_single_file(path))
|
||||
return WATCH_ERR_UNACCESSIBLE;
|
||||
|
||||
try {
|
||||
Watch_handle *wh = new (alloc)
|
||||
Watch_handle(_watch_handle_registry, *this, alloc);
|
||||
*handle = wh;
|
||||
return WATCH_OK;
|
||||
}
|
||||
catch (Genode::Out_of_ram) { return WATCH_ERR_OUT_OF_RAM; }
|
||||
catch (Genode::Out_of_caps) { return WATCH_ERR_OUT_OF_CAPS; }
|
||||
}
|
||||
|
||||
void close(Vfs_watch_handle *handle) override
|
||||
{
|
||||
if (handle && (&handle->fs() == this))
|
||||
destroy(handle->alloc(), handle);
|
||||
}
|
||||
};
|
||||
|
||||
#endif /* _VALUE_FILE_SYSTEM_H_ */
|
Reference in New Issue
Block a user