2011-12-22 15:19:25 +00:00
|
|
|
/*
|
|
|
|
* \brief file descriptor allocator interface
|
|
|
|
* \author Christian Prochaska
|
|
|
|
* \date 2010-01-21
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
2017-02-20 12:23:52 +00:00
|
|
|
* Copyright (C) 2010-2017 Genode Labs GmbH
|
2011-12-22 15:19:25 +00:00
|
|
|
*
|
|
|
|
* This file is part of the Genode OS framework, which is distributed
|
2017-02-20 12:23:52 +00:00
|
|
|
* under the terms of the GNU Affero General Public License version 3.
|
2011-12-22 15:19:25 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _LIBC_PLUGIN__FD_ALLOC_H_
|
|
|
|
#define _LIBC_PLUGIN__FD_ALLOC_H_
|
|
|
|
|
2020-07-01 07:05:47 +00:00
|
|
|
/* Genode includes */
|
|
|
|
#include <base/mutex.h>
|
base: avoid use of deprecated base/printf.h
Besides adapting the components to the use of base/log.h, the patch
cleans up a few base headers, i.e., it removes unused includes from
root/component.h, specifically base/heap.h and
ram_session/ram_session.h. Hence, components that relied on the implicit
inclusion of those headers have to manually include those headers now.
While adjusting the log messages, I repeatedly stumbled over the problem
that printing char * arguments is ambiguous. It is unclear whether to
print the argument as pointer or null-terminated string. To overcome
this problem, the patch introduces a new type 'Cstring' that allows the
caller to express that the argument should be handled as null-terminated
string. As a nice side effect, with this type in place, the optional len
argument of the 'String' class could be removed. Instead of supplying a
pair of (char const *, size_t), the constructor accepts a 'Cstring'.
This, in turn, clears the way let the 'String' constructor use the new
output mechanism to assemble a string from multiple arguments (and
thereby getting rid of snprintf within Genode in the near future).
To enforce the explicit resolution of the char * ambiguity, the 'char *'
overload of the 'print' function is marked as deleted.
Issue #1987
2016-07-13 17:07:09 +00:00
|
|
|
#include <base/log.h>
|
2012-10-08 12:44:31 +00:00
|
|
|
#include <os/path.h>
|
2019-08-16 09:42:27 +00:00
|
|
|
#include <base/allocator.h>
|
|
|
|
#include <base/id_space.h>
|
2019-12-04 14:13:16 +00:00
|
|
|
#include <util/bit_allocator.h>
|
2019-08-14 15:34:09 +00:00
|
|
|
#include <util/xml_generator.h>
|
2012-10-08 12:44:31 +00:00
|
|
|
|
|
|
|
/* libc includes */
|
|
|
|
#include <stdlib.h>
|
|
|
|
#include <string.h>
|
2011-12-22 15:19:25 +00:00
|
|
|
|
|
|
|
#include <libc-plugin/plugin.h>
|
|
|
|
|
|
|
|
enum { MAX_NUM_FDS = 1024 };
|
|
|
|
|
|
|
|
namespace Libc {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Plugin-specific file-descriptor context
|
|
|
|
*/
|
2016-04-04 19:13:18 +00:00
|
|
|
struct Plugin_context { virtual ~Plugin_context() { } };
|
2011-12-22 15:19:25 +00:00
|
|
|
|
2012-10-08 12:44:31 +00:00
|
|
|
enum { ANY_FD = -1 };
|
2011-12-22 15:19:25 +00:00
|
|
|
|
|
|
|
struct File_descriptor
|
|
|
|
{
|
2020-07-01 07:05:47 +00:00
|
|
|
Genode::Mutex mutex { };
|
2019-08-16 09:42:27 +00:00
|
|
|
|
|
|
|
typedef Genode::Id_space<File_descriptor> Id_space;
|
|
|
|
Id_space::Element _elem;
|
|
|
|
|
|
|
|
int const libc_fd = _elem.id().value;
|
|
|
|
|
|
|
|
char const *fd_path = nullptr; /* for 'fchdir', 'fstat' */
|
|
|
|
|
|
|
|
Plugin *plugin;
|
|
|
|
Plugin_context *context;
|
|
|
|
|
2019-04-18 13:15:13 +00:00
|
|
|
int flags = 0; /* for 'fcntl' */
|
|
|
|
bool cloexec = 0; /* for 'fcntl' */
|
|
|
|
bool modified = false;
|
2019-08-16 09:42:27 +00:00
|
|
|
|
|
|
|
File_descriptor(Id_space &id_space, Plugin &plugin, Plugin_context &context,
|
|
|
|
Id_space::Id id)
|
|
|
|
: _elem(*this, id_space, id), plugin(&plugin), context(&context) { }
|
2012-10-08 12:44:31 +00:00
|
|
|
|
2019-08-20 10:18:54 +00:00
|
|
|
void path(char const *newpath);
|
2011-12-22 15:19:25 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
2019-08-16 09:42:27 +00:00
|
|
|
class File_descriptor_allocator
|
2011-12-22 15:19:25 +00:00
|
|
|
{
|
2017-08-15 16:32:40 +00:00
|
|
|
private:
|
|
|
|
|
2020-07-01 07:05:47 +00:00
|
|
|
Genode::Mutex _mutex;
|
2017-08-15 16:32:40 +00:00
|
|
|
|
2019-08-16 09:42:27 +00:00
|
|
|
Genode::Allocator &_alloc;
|
|
|
|
|
|
|
|
typedef File_descriptor::Id_space Id_space;
|
|
|
|
|
|
|
|
Id_space _id_space;
|
|
|
|
|
2019-12-04 14:13:16 +00:00
|
|
|
Genode::Bit_allocator<MAX_NUM_FDS> _id_allocator;
|
|
|
|
|
2011-12-22 15:19:25 +00:00
|
|
|
public:
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Constructor
|
|
|
|
*/
|
2019-08-16 09:42:27 +00:00
|
|
|
File_descriptor_allocator(Genode::Allocator &_alloc);
|
2011-12-22 15:19:25 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Allocate file descriptor
|
|
|
|
*/
|
|
|
|
File_descriptor *alloc(Plugin *plugin, Plugin_context *context, int libc_fd = -1);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Release file descriptor
|
|
|
|
*/
|
|
|
|
void free(File_descriptor *fdo);
|
|
|
|
|
2019-08-16 17:04:04 +00:00
|
|
|
/**
|
|
|
|
* Prevent the use of the specified file descriptor
|
|
|
|
*/
|
|
|
|
void preserve(int libc_fd);
|
|
|
|
|
2011-12-22 15:19:25 +00:00
|
|
|
File_descriptor *find_by_libc_fd(int libc_fd);
|
2019-08-14 15:34:09 +00:00
|
|
|
|
2019-12-03 17:38:07 +00:00
|
|
|
/**
|
|
|
|
* Return any file descriptor with close-on-execve flag set
|
|
|
|
*
|
|
|
|
* \return pointer to file descriptor, or
|
|
|
|
* nullptr is no such file descriptor exists
|
|
|
|
*/
|
|
|
|
File_descriptor *any_cloexec_libc_fd();
|
|
|
|
|
2019-12-06 16:11:17 +00:00
|
|
|
/**
|
|
|
|
* Return file-descriptor ID of any open file, or -1 if no file is
|
|
|
|
* open
|
|
|
|
*/
|
|
|
|
int any_open_fd();
|
|
|
|
|
2019-08-14 15:34:09 +00:00
|
|
|
void generate_info(Genode::Xml_generator &);
|
2011-12-22 15:19:25 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Return singleton instance of file-descriptor allocator
|
|
|
|
*/
|
|
|
|
extern File_descriptor_allocator *file_descriptor_allocator();
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif /* _LIBC_PLUGIN__FD_ALLOC_H_ */
|