ladybird/Kernel/Coredump.h
kleines Filmröllchen a6a439243f Kernel: Turn lock ranks into template parameters
This step would ideally not have been necessary (increases amount of
refactoring and templates necessary, which in turn increases build
times), but it gives us a couple of nice properties:
- SpinlockProtected inside Singleton (a very common combination) can now
  obtain any lock rank just via the template parameter. It was not
  previously possible to do this with SingletonInstanceCreator magic.
- SpinlockProtected's lock rank is now mandatory; this is the majority
  of cases and allows us to see where we're still missing proper ranks.
- The type already informs us what lock rank a lock has, which aids code
  readability and (possibly, if gdb cooperates) lock mismatch debugging.
- The rank of a lock can no longer be dynamic, which is not something we
  wanted in the first place (or made use of). Locks randomly changing
  their rank sounds like a disaster waiting to happen.
- In some places, we might be able to statically check that locks are
  taken in the right order (with the right lock rank checking
  implementation) as rank information is fully statically known.

This refactoring even more exposes the fact that Mutex has no lock rank
capabilites, which is not fixed here.
2023-01-02 18:15:27 -05:00

88 lines
3 KiB
C++

/*
* Copyright (c) 2019-2020, Jesse Buhagiar <jooster669@gmail.com>
* Copyright (c) 2020, Itamar S. <itamar8910@gmail.com>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/OwnPtr.h>
#include <AK/Vector.h>
#include <Kernel/Forward.h>
#include <Kernel/Library/NonnullLockRefPtr.h>
#include <Kernel/Locking/SpinlockProtected.h>
#include <Kernel/Memory/Region.h>
namespace Kernel {
class Coredump {
public:
static ErrorOr<NonnullOwnPtr<Coredump>> try_create(NonnullLockRefPtr<Process>, StringView output_path);
static SpinlockProtected<OwnPtr<KString>, LockRank::None>& directory_path();
~Coredump() = default;
ErrorOr<void> write();
private:
class FlatRegionData {
public:
explicit FlatRegionData(Memory::Region const& region, NonnullOwnPtr<KString> name)
: m_access(region.access())
, m_is_executable(region.is_executable())
, m_is_kernel(region.is_kernel())
, m_is_readable(region.is_readable())
, m_is_writable(region.is_writable())
, m_name(move(name))
, m_page_count(region.page_count())
, m_size(region.size())
, m_vaddr(region.vaddr())
{
}
auto access() const { return m_access; }
auto name() const { return m_name->view(); }
auto is_executable() const { return m_is_executable; }
auto is_kernel() const { return m_is_kernel; }
auto is_readable() const { return m_is_readable; }
auto is_writable() const { return m_is_writable; }
auto page_count() const { return m_page_count; }
auto size() const { return m_size; }
auto vaddr() const { return m_vaddr; }
bool looks_like_userspace_heap_region() const;
bool is_consistent_with_region(Memory::Region const& region) const;
private:
Memory::Region::Access m_access;
bool m_is_executable;
bool m_is_kernel;
bool m_is_readable;
bool m_is_writable;
NonnullOwnPtr<KString> m_name;
size_t m_page_count;
size_t m_size;
VirtualAddress m_vaddr;
};
Coredump(NonnullLockRefPtr<Process>, NonnullLockRefPtr<OpenFileDescription>, Vector<FlatRegionData>);
static ErrorOr<NonnullLockRefPtr<OpenFileDescription>> try_create_target_file(Process const&, StringView output_path);
ErrorOr<void> write_elf_header();
ErrorOr<void> write_program_headers(size_t notes_size);
ErrorOr<void> write_regions();
ErrorOr<void> write_notes_segment(ReadonlyBytes);
ErrorOr<void> create_notes_segment_data(auto&) const;
ErrorOr<void> create_notes_process_data(auto&) const;
ErrorOr<void> create_notes_threads_data(auto&) const;
ErrorOr<void> create_notes_regions_data(auto&) const;
ErrorOr<void> create_notes_metadata_data(auto&) const;
NonnullLockRefPtr<Process> m_process;
NonnullLockRefPtr<OpenFileDescription> m_description;
size_t m_num_program_headers { 0 };
Vector<FlatRegionData> m_regions;
};
}