Pavel Labath 08c94c0ac3
[lldb] Clear up GetModuleSpecifications return value confusion (#188276)
Some plugins were returning the number of specifications they have
added, while others were returning the total final number. Particularly
devious plugins (Minidump) were clearing the specification list
altogether. This resulted in nondeterministic failures (depending on
plugin ininitialization order) in TestSBModule.

This PR defines the problem away by having each plugin only return the
specifications it is responsible for. If the caller wants to merge them,
it is free to do so. This *might* be slighly less efficient, but this is
hardly hot code.

I'm not touching the ObjectFile::GetModuleSpecifications function (the
caller of all these functions) as the PR is big enough, although the
same approach might be warranted there as well.

Fixes https://github.com/llvm/llvm-project/issues/178625.
2026-03-25 15:55:04 +01:00

125 lines
4.1 KiB
C++

//===-- ObjectFileXCOFF.h --------------------------------------- -*- C++
//-*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#ifndef LLDB_SOURCE_PLUGINS_OBJECTFILE_XCOFF_OBJECTFILEXCOFF_H
#define LLDB_SOURCE_PLUGINS_OBJECTFILE_XCOFF_OBJECTFILEXCOFF_H
#include "lldb/Symbol/ObjectFile.h"
#include "lldb/Utility/ArchSpec.h"
#include "lldb/Utility/FileSpec.h"
#include "lldb/Utility/UUID.h"
#include "lldb/lldb-private.h"
#include "llvm/Object/XCOFFObjectFile.h"
#include <cstdint>
#include <vector>
/// \class ObjectFileXCOFF
/// Generic XCOFF object file reader.
///
/// This class provides a generic XCOFF (32/64 bit) reader plugin implementing
/// the ObjectFile protocol.
class ObjectFileXCOFF : public lldb_private::ObjectFile {
public:
// Static Functions
static void Initialize();
static void Terminate();
static llvm::StringRef GetPluginNameStatic() { return "xcoff"; }
static llvm::StringRef GetPluginDescriptionStatic() {
return "XCOFF object file reader.";
}
static lldb_private::ObjectFile *
CreateInstance(const lldb::ModuleSP &module_sp,
lldb::DataExtractorSP extractor_sp, lldb::offset_t data_offset,
const lldb_private::FileSpec *file, lldb::offset_t file_offset,
lldb::offset_t length);
static lldb_private::ObjectFile *CreateMemoryInstance(
const lldb::ModuleSP &module_sp, lldb::WritableDataBufferSP data_sp,
const lldb::ProcessSP &process_sp, lldb::addr_t header_addr);
static lldb_private::ModuleSpecList
GetModuleSpecifications(const lldb_private::FileSpec &file,
lldb::DataExtractorSP &extractor_sp,
lldb::offset_t data_offset,
lldb::offset_t file_offset, lldb::offset_t length);
static bool MagicBytesMatch(lldb::DataExtractorSP &extractor_sp,
lldb::addr_t offset, lldb::addr_t length);
// PluginInterface protocol
llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
// ObjectFile Protocol.
bool ParseHeader() override;
lldb::ByteOrder GetByteOrder() const override;
bool IsExecutable() const override;
uint32_t GetAddressByteSize() const override;
lldb_private::AddressClass GetAddressClass(lldb::addr_t file_addr) override;
void ParseSymtab(lldb_private::Symtab &symtab) override;
bool IsStripped() override;
void CreateSections(lldb_private::SectionList &unified_section_list) override;
void Dump(lldb_private::Stream *s) override;
lldb_private::ArchSpec GetArchitecture() override;
lldb_private::UUID GetUUID() override;
uint32_t GetDependentModules(lldb_private::FileSpecList &files) override;
ObjectFile::Type CalculateType() override;
ObjectFile::Strata CalculateStrata() override;
ObjectFileXCOFF(const lldb::ModuleSP &module_sp,
lldb::DataExtractorSP extractor_sp,
lldb::offset_t data_offset,
const lldb_private::FileSpec *file, lldb::offset_t offset,
lldb::offset_t length);
ObjectFileXCOFF(const lldb::ModuleSP &module_sp,
lldb::DataBufferSP header_data_sp,
const lldb::ProcessSP &process_sp, lldb::addr_t header_addr);
protected:
static lldb::WritableDataBufferSP
MapFileDataWritable(const lldb_private::FileSpec &file, uint64_t Size,
uint64_t Offset);
private:
bool CreateBinary();
template <typename T>
void
CreateSectionsWithBitness(lldb_private::SectionList &unified_section_list);
struct XCOFF32 {
using SectionHeader = llvm::object::XCOFFSectionHeader32;
static constexpr bool Is64Bit = false;
};
struct XCOFF64 {
using SectionHeader = llvm::object::XCOFFSectionHeader64;
static constexpr bool Is64Bit = true;
};
std::unique_ptr<llvm::object::XCOFFObjectFile> m_binary;
};
#endif // LLDB_SOURCE_PLUGINS_OBJECTFILE_XCOFF_OBJECTFILEXCOFF_H