LibCore: Make MappedFile OwnPtr-based

Since it will become a stream in a little bit, it should behave like all
non-trivial stream classes, who are not primarily intended to have
shared ownership to make closing behavior more predictable. Across all
uses of MappedFile, there is only one use case of shared mapped files in
LibVideo, which now uses the thin SharedMappedFile wrapper.

Userland/Libraries/LibCompress/Gzip.cpp

@@ -266,7 +266,7 @@ ErrorOr<void> GzipCompressor::compress_file(StringView input_filename, NonnullOw
 {
     // We map the whole file instead of streaming to reduce size overhead (gzip header) and increase the deflate block size (better compression)
     // TODO: automatically fallback to buffered streaming for very large files
-    RefPtr<Core::MappedFile> file;
+    OwnPtr<Core::MappedFile> file;
     ReadonlyBytes input_bytes;
 
     if (TRY(Core::System::stat(input_filename)).st_size > 0) {

Userland/Libraries/LibCore/MappedFile.cpp

@@ -14,18 +14,18 @@
 
 namespace Core {
 
-ErrorOr<NonnullRefPtr<MappedFile>> MappedFile::map(StringView path)
+ErrorOr<NonnullOwnPtr<MappedFile>> MappedFile::map(StringView path)
 {
     auto fd = TRY(Core::System::open(path, O_RDONLY | O_CLOEXEC, 0));
     return map_from_fd_and_close(fd, path);
 }
 
-ErrorOr<NonnullRefPtr<MappedFile>> MappedFile::map_from_file(NonnullOwnPtr<Core::File> stream, StringView path)
+ErrorOr<NonnullOwnPtr<MappedFile>> MappedFile::map_from_file(NonnullOwnPtr<Core::File> stream, StringView path)
 {
     return map_from_fd_and_close(stream->leak_fd(Badge<MappedFile> {}), path);
 }
 
-ErrorOr<NonnullRefPtr<MappedFile>> MappedFile::map_from_fd_and_close(int fd, [[maybe_unused]] StringView path)
+ErrorOr<NonnullOwnPtr<MappedFile>> MappedFile::map_from_fd_and_close(int fd, [[maybe_unused]] StringView path)
 {
     TRY(Core::System::fcntl(fd, F_SETFD, FD_CLOEXEC));
 
@@ -38,7 +38,7 @@ ErrorOr<NonnullRefPtr<MappedFile>> MappedFile::map_from_fd_and_close(int fd, [[m
 
     auto* ptr = TRY(Core::System::mmap(nullptr, size, PROT_READ, MAP_SHARED, fd, 0, 0, path));
 
-    return adopt_ref(*new MappedFile(ptr, size));
+    return adopt_own(*new MappedFile(ptr, size));
 }
 
 MappedFile::MappedFile(void* ptr, size_t size)

Userland/Libraries/LibCore/MappedFile.h

@@ -1,5 +1,6 @@
 /*
  * Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
+ * Copyright (c) 2023, kleines Filmröllchen <filmroellchen@serenityos.org>
  *
  * SPDX-License-Identifier: BSD-2-Clause
  */
@@ -8,20 +9,20 @@
 
 #include <AK/Error.h>
 #include <AK/Noncopyable.h>
-#include <AK/NonnullRefPtr.h>
+#include <AK/NonnullOwnPtr.h>
 #include <AK/RefCounted.h>
 #include <LibCore/Forward.h>
 
 namespace Core {
 
-class MappedFile : public RefCounted<MappedFile> {
+class MappedFile {
     AK_MAKE_NONCOPYABLE(MappedFile);
     AK_MAKE_NONMOVABLE(MappedFile);
 
 public:
-    static ErrorOr<NonnullRefPtr<MappedFile>> map(StringView path);
-    static ErrorOr<NonnullRefPtr<MappedFile>> map_from_file(NonnullOwnPtr<Core::File>, StringView path);
-    static ErrorOr<NonnullRefPtr<MappedFile>> map_from_fd_and_close(int fd, StringView path);
+    static ErrorOr<NonnullOwnPtr<MappedFile>> map(StringView path);
+    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);
     ~MappedFile();
 
     void* data() { return m_data; }
@@ -38,4 +39,18 @@ private:
     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;
+};
+
 }

Userland/Libraries/LibCoredump/Backtrace.h

@@ -15,14 +15,14 @@
 namespace Coredump {
 
 struct ELFObjectInfo {
-    ELFObjectInfo(NonnullRefPtr<Core::MappedFile> file, NonnullOwnPtr<Debug::DebugInfo>&& debug_info, NonnullOwnPtr<ELF::Image> image)
+    ELFObjectInfo(NonnullOwnPtr<Core::MappedFile> file, NonnullOwnPtr<Debug::DebugInfo>&& debug_info, NonnullOwnPtr<ELF::Image> image)
         : file(move(file))
         , debug_info(move(debug_info))
         , image(move(image))
     {
     }
 
-    NonnullRefPtr<Core::MappedFile> file;
+    NonnullOwnPtr<Core::MappedFile> file;
     NonnullOwnPtr<Debug::DebugInfo> debug_info;
     NonnullOwnPtr<ELF::Image> image;
 };

Userland/Libraries/LibCoredump/Inspector.cpp

@@ -47,7 +47,7 @@ void Inspector::parse_loaded_libraries(Function<void(float)> on_progress)
 
         auto image = make<ELF::Image>(file_or_error.value()->bytes());
         auto debug_info = make<Debug::DebugInfo>(*image, DeprecatedString {}, library.base_address);
-        m_loaded_libraries.append(make<Debug::LoadedLibrary>(library.name, file_or_error.value(), move(image), move(debug_info), library.base_address));
+        m_loaded_libraries.append(make<Debug::LoadedLibrary>(library.name, file_or_error.release_value(), move(image), move(debug_info), library.base_address));
     });
 }
 

Userland/Libraries/LibCoredump/Reader.cpp

@@ -43,7 +43,7 @@ Reader::Reader(ByteBuffer buffer)
     m_coredump_buffer = move(buffer);
 }
 
-Reader::Reader(NonnullRefPtr<Core::MappedFile> file)
+Reader::Reader(NonnullOwnPtr<Core::MappedFile> file)
     : Reader(file->bytes())
 {
     m_mapped_file = move(file);

Userland/Libraries/LibCoredump/Reader.h

@@ -66,7 +66,7 @@ public:
     struct LibraryData {
         DeprecatedString name;
         FlatPtr base_address { 0 };
-        NonnullRefPtr<Core::MappedFile> file;
+        NonnullOwnPtr<Core::MappedFile> file;
         ELF::Image lib_elf;
     };
     LibraryData const* library_containing(FlatPtr address) const;
@@ -83,7 +83,7 @@ public:
 private:
     explicit Reader(ReadonlyBytes);
     explicit Reader(ByteBuffer);
-    explicit Reader(NonnullRefPtr<Core::MappedFile>);
+    explicit Reader(NonnullOwnPtr<Core::MappedFile>);
 
     static Optional<ByteBuffer> decompress_coredump(ReadonlyBytes);
 
@@ -108,7 +108,7 @@ private:
     const JsonObject process_info() const;
 
     // For uncompressed coredumps, we keep the MappedFile
-    RefPtr<Core::MappedFile> m_mapped_file;
+    OwnPtr<Core::MappedFile> m_mapped_file;
 
     // For compressed coredumps, we decompress them into a ByteBuffer
     ByteBuffer m_coredump_buffer;

Userland/Libraries/LibDebug/LoadedLibrary.h

@@ -14,12 +14,12 @@
 namespace Debug {
 struct LoadedLibrary {
     DeprecatedString name;
-    NonnullRefPtr<Core::MappedFile> file;
+    NonnullOwnPtr<Core::MappedFile> file;
     NonnullOwnPtr<ELF::Image> image;
     NonnullOwnPtr<DebugInfo> debug_info;
     FlatPtr base_address {};
 
-    LoadedLibrary(DeprecatedString const& name, NonnullRefPtr<Core::MappedFile> file, NonnullOwnPtr<ELF::Image> image, NonnullOwnPtr<DebugInfo>&& debug_info, FlatPtr base_address)
+    LoadedLibrary(DeprecatedString const& name, NonnullOwnPtr<Core::MappedFile> file, NonnullOwnPtr<ELF::Image> image, NonnullOwnPtr<DebugInfo>&& debug_info, FlatPtr base_address)
         : name(name)
         , file(move(file))
         , image(move(image))

Userland/Libraries/LibGfx/Font/BitmapFont.cpp

@@ -239,10 +239,10 @@ ErrorOr<NonnullRefPtr<BitmapFont>> BitmapFont::try_load_from_file(DeprecatedStri
     return try_load_from_mapped_file(move(mapped_file));
 }
 
-ErrorOr<NonnullRefPtr<BitmapFont>> BitmapFont::try_load_from_mapped_file(RefPtr<Core::MappedFile> const& mapped_file)
+ErrorOr<NonnullRefPtr<BitmapFont>> BitmapFont::try_load_from_mapped_file(OwnPtr<Core::MappedFile> mapped_file)
 {
     auto font = TRY(load_from_memory((u8 const*)mapped_file->data()));
-    font->m_mapped_file = mapped_file;
+    font->m_mapped_file = move(mapped_file);
     return font;
 }
 

Userland/Libraries/LibGfx/Font/BitmapFont.h

@@ -32,7 +32,7 @@ public:
 
     static RefPtr<BitmapFont> load_from_file(DeprecatedString const& path);
     static ErrorOr<NonnullRefPtr<BitmapFont>> try_load_from_file(DeprecatedString const& path);
-    static ErrorOr<NonnullRefPtr<BitmapFont>> try_load_from_mapped_file(RefPtr<Core::MappedFile> const&);
+    static ErrorOr<NonnullRefPtr<BitmapFont>> try_load_from_mapped_file(OwnPtr<Core::MappedFile>);
 
     ErrorOr<void> write_to_file(DeprecatedString const& path);
     ErrorOr<void> write_to_file(NonnullOwnPtr<Core::File> file);
@@ -156,7 +156,7 @@ private:
 
     u8* m_rows { nullptr };
     u8* m_glyph_widths { nullptr };
-    RefPtr<Core::MappedFile> m_mapped_file;
+    OwnPtr<Core::MappedFile> m_mapped_file;
 
     u8 m_glyph_width { 0 };
     u8 m_glyph_height { 0 };

Userland/Libraries/LibGfx/Font/OpenType/Font.h

@@ -107,7 +107,7 @@ private:
     {
     }
 
-    RefPtr<Core::MappedFile> m_mapped_file;
+    OwnPtr<Core::MappedFile> m_mapped_file;
 
     ReadonlyBytes m_buffer;
 

Userland/Libraries/LibPCIDB/Database.h

@@ -64,7 +64,7 @@ public:
     const StringView get_programming_interface(u8 class_id, u8 subclass_id, u8 programming_interface_id) const;
 
 private:
-    explicit Database(NonnullRefPtr<Core::MappedFile> file)
+    explicit Database(NonnullOwnPtr<Core::MappedFile> file)
         : m_file(move(file))
     {
     }
@@ -77,7 +77,7 @@ private:
         ClassMode,
     };
 
-    NonnullRefPtr<Core::MappedFile> m_file;
+    NonnullOwnPtr<Core::MappedFile> m_file;
     StringView m_view {};
     HashMap<int, NonnullOwnPtr<Vendor>> m_vendors;
     HashMap<int, NonnullOwnPtr<Class>> m_classes;

Userland/Libraries/LibSymbolication/Symbolication.cpp

@@ -19,7 +19,7 @@
 namespace Symbolication {
 
 struct CachedELF {
-    NonnullRefPtr<Core::MappedFile> mapped_file;
+    NonnullOwnPtr<Core::MappedFile> mapped_file;
     NonnullOwnPtr<Debug::DebugInfo> debug_info;
     NonnullOwnPtr<ELF::Image> image;
 };

Userland/Libraries/LibUSBDB/Database.h

@@ -63,7 +63,7 @@ public:
     const StringView get_protocol(u8 class_id, u8 subclass_id, u8 protocol_id) const;
 
 private:
-    explicit Database(NonnullRefPtr<Core::MappedFile> file)
+    explicit Database(NonnullOwnPtr<Core::MappedFile> file)
         : m_file(move(file))
     {
     }
@@ -76,7 +76,7 @@ private:
         ClassMode,
     };
 
-    NonnullRefPtr<Core::MappedFile> m_file;
+    NonnullOwnPtr<Core::MappedFile> m_file;
     StringView m_view {};
     HashMap<int, NonnullOwnPtr<Vendor>> m_vendors;
     HashMap<int, NonnullOwnPtr<Class>> m_classes;

Userland/Libraries/LibVideo/Containers/Matroska/MatroskaDemuxer.cpp

@@ -14,7 +14,7 @@ DecoderErrorOr<NonnullOwnPtr<MatroskaDemuxer>> MatroskaDemuxer::from_file(String
     return make<MatroskaDemuxer>(TRY(Reader::from_file(filename)));
 }
 
-DecoderErrorOr<NonnullOwnPtr<MatroskaDemuxer>> MatroskaDemuxer::from_mapped_file(NonnullRefPtr<Core::MappedFile> mapped_file)
+DecoderErrorOr<NonnullOwnPtr<MatroskaDemuxer>> MatroskaDemuxer::from_mapped_file(NonnullOwnPtr<Core::MappedFile> mapped_file)
 {
     return make<MatroskaDemuxer>(TRY(Reader::from_mapped_file(move(mapped_file))));
 }

Userland/Libraries/LibVideo/Containers/Matroska/MatroskaDemuxer.h

@@ -18,7 +18,7 @@ public:
     // FIXME: We should instead accept some abstract data streaming type so that the demuxer
     //        can work with non-contiguous data.
     static DecoderErrorOr<NonnullOwnPtr<MatroskaDemuxer>> from_file(StringView filename);
-    static DecoderErrorOr<NonnullOwnPtr<MatroskaDemuxer>> from_mapped_file(NonnullRefPtr<Core::MappedFile> mapped_file);
+    static DecoderErrorOr<NonnullOwnPtr<MatroskaDemuxer>> from_mapped_file(NonnullOwnPtr<Core::MappedFile> mapped_file);
 
     static DecoderErrorOr<NonnullOwnPtr<MatroskaDemuxer>> from_data(ReadonlyBytes data);
 

Userland/Libraries/LibVideo/Containers/Matroska/Reader.cpp

@@ -86,13 +86,13 @@ constexpr u32 CUE_REFERENCE_ID = 0xDB;
 DecoderErrorOr<Reader> Reader::from_file(StringView path)
 {
     auto mapped_file = DECODER_TRY(DecoderErrorCategory::IO, Core::MappedFile::map(path));
-    return from_mapped_file(mapped_file);
+    return from_mapped_file(move(mapped_file));
 }
 
-DecoderErrorOr<Reader> Reader::from_mapped_file(NonnullRefPtr<Core::MappedFile> mapped_file)
+DecoderErrorOr<Reader> Reader::from_mapped_file(NonnullOwnPtr<Core::MappedFile> mapped_file)
 {
     auto reader = TRY(from_data(mapped_file->bytes()));
-    reader.m_mapped_file = move(mapped_file);
+    reader.m_mapped_file = make_ref_counted<Core::SharedMappedFile>(move(mapped_file));
     return reader;
 }
 

Userland/Libraries/LibVideo/Containers/Matroska/Reader.h

@@ -25,7 +25,7 @@ public:
     typedef Function<DecoderErrorOr<IterationDecision>(TrackEntry const&)> TrackEntryCallback;
 
     static DecoderErrorOr<Reader> from_file(StringView path);
-    static DecoderErrorOr<Reader> from_mapped_file(NonnullRefPtr<Core::MappedFile> mapped_file);
+    static DecoderErrorOr<Reader> from_mapped_file(NonnullOwnPtr<Core::MappedFile> mapped_file);
 
     static DecoderErrorOr<Reader> from_data(ReadonlyBytes data);
 
@@ -60,7 +60,7 @@ private:
     DecoderErrorOr<void> ensure_cues_are_parsed();
     DecoderErrorOr<void> seek_to_cue_for_timestamp(SampleIterator&, Duration const&);
 
-    RefPtr<Core::MappedFile> m_mapped_file;
+    RefPtr<Core::SharedMappedFile> m_mapped_file;
     ReadonlyBytes m_data;
 
     Optional<EBMLHeader> m_header;
@@ -89,7 +89,7 @@ public:
 private:
     friend class Reader;
 
-    SampleIterator(RefPtr<Core::MappedFile> file, ReadonlyBytes data, TrackEntry track, u64 timestamp_scale, size_t position)
+    SampleIterator(RefPtr<Core::SharedMappedFile> file, ReadonlyBytes data, TrackEntry track, u64 timestamp_scale, size_t position)
         : m_file(move(file))
         , m_data(data)
         , m_track(move(track))
@@ -100,7 +100,7 @@ private:
 
     DecoderErrorOr<void> seek_to_cue_point(CuePoint const& cue_point);
 
-    RefPtr<Core::MappedFile> m_file;
+    RefPtr<Core::SharedMappedFile> m_file;
     ReadonlyBytes m_data;
     TrackEntry m_track;
     u64 m_segment_timestamp_scale { 0 };

Userland/Libraries/LibVideo/PlaybackManager.cpp

@@ -31,7 +31,7 @@ DecoderErrorOr<NonnullOwnPtr<PlaybackManager>> PlaybackManager::from_file(String
     return create(move(demuxer));
 }
 
-DecoderErrorOr<NonnullOwnPtr<PlaybackManager>> PlaybackManager::from_mapped_file(NonnullRefPtr<Core::MappedFile> mapped_file)
+DecoderErrorOr<NonnullOwnPtr<PlaybackManager>> PlaybackManager::from_mapped_file(NonnullOwnPtr<Core::MappedFile> mapped_file)
 {
     auto demuxer = TRY(Matroska::MatroskaDemuxer::from_mapped_file(move(mapped_file)));
     return create(move(demuxer));

Userland/Libraries/LibVideo/PlaybackManager.h

@@ -112,7 +112,7 @@ public:
     static constexpr SeekMode DEFAULT_SEEK_MODE = SeekMode::Accurate;
 
     static DecoderErrorOr<NonnullOwnPtr<PlaybackManager>> from_file(StringView file);
-    static DecoderErrorOr<NonnullOwnPtr<PlaybackManager>> from_mapped_file(NonnullRefPtr<Core::MappedFile> file);
+    static DecoderErrorOr<NonnullOwnPtr<PlaybackManager>> from_mapped_file(NonnullOwnPtr<Core::MappedFile> file);
 
     static DecoderErrorOr<NonnullOwnPtr<PlaybackManager>> from_data(ReadonlyBytes data);