26504d84bb
Allow MappedFile to expose a byte range within an fd. It maps the page-aligned region required by mmap internally. Add ImmutableBytes as a small shared holder for either owned bytes or a mapped file. This lets cache code thread file-backed response bodies through without copying response data into anonymous memory. Cover non-page-aligned ranges, empty ranges, invalid ranges, and mapped ImmutableBytes in TestLibCoreMappedFile.
59 lines
1.8 KiB
C++
59 lines
1.8 KiB
C++
/*
|
|
* Copyright (c) 2018-2021, Andreas Kling <andreas@ladybird.org>
|
|
* Copyright (c) 2023, kleines Filmröllchen <filmroellchen@serenityos.org>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/Error.h>
|
|
#include <AK/MemoryStream.h>
|
|
#include <AK/Noncopyable.h>
|
|
#include <AK/NonnullOwnPtr.h>
|
|
#include <AK/RefCounted.h>
|
|
#include <LibCore/Export.h>
|
|
#include <LibCore/Forward.h>
|
|
|
|
namespace Core {
|
|
|
|
class CORE_API MappedFile : public FixedMemoryStream {
|
|
AK_MAKE_NONCOPYABLE(MappedFile);
|
|
AK_MAKE_NONMOVABLE(MappedFile);
|
|
|
|
public:
|
|
static ErrorOr<NonnullOwnPtr<MappedFile>> map(StringView path, Mode mode = Mode::ReadOnly);
|
|
static ErrorOr<NonnullOwnPtr<MappedFile>> map_from_file(NonnullOwnPtr<Core::File>, StringView path);
|
|
static ErrorOr<NonnullOwnPtr<MappedFile>> map_from_fd_and_close(int fd, StringView path, Mode mode = Mode::ReadOnly);
|
|
static ErrorOr<NonnullOwnPtr<MappedFile>> map_from_fd_range_and_close(int fd, StringView path, off_t offset, size_t size, Mode mode = Mode::ReadOnly);
|
|
virtual ~MappedFile();
|
|
|
|
// Non-stream APIs for using MappedFile as a simple POSIX API wrapper.
|
|
void* data() { return m_data; }
|
|
void const* data() const { return m_data; }
|
|
ReadonlyBytes bytes() const LIFETIME_BOUND { return { m_data, m_size }; }
|
|
|
|
private:
|
|
explicit MappedFile(void* mapping, size_t mapping_size, void* data, size_t size, Mode);
|
|
|
|
void* m_mapping { nullptr };
|
|
size_t m_mapping_size { 0 };
|
|
void* m_data { nullptr };
|
|
size_t m_size { 0 };
|
|
};
|
|
|
|
class SharedMappedFile : public RefCounted<SharedMappedFile> {
|
|
public:
|
|
explicit SharedMappedFile(NonnullOwnPtr<MappedFile> file)
|
|
: m_file(move(file))
|
|
{
|
|
}
|
|
|
|
MappedFile const& operator->() const { return *m_file; }
|
|
MappedFile& operator->() { return *m_file; }
|
|
|
|
private:
|
|
NonnullOwnPtr<MappedFile> m_file;
|
|
};
|
|
|
|
}
|