bdca8b01d2
#pragma once is a widely supported compiler pragma, even though it is not part of the C++ standard. Many of the issues keeping #pragma once from being standardized (distributed filesystems, build farms, hard links, etc.) do not apply to CMake - it is easy to build CMake on a single machine. CMake also does not install any header files which can be consumed by other projects (though cmCPluginAPI.h has been deliberately omitted from this conversion in case anyone is still using it.) Finally, #pragma once has been required to build CMake since at least August 2017 (7f29bbe6enabled server mode unconditionally, which had been using #pragma once since September 2016 (b13d3e0d)). The fact that we now require C++11 filters out old compilers, and it is unlikely that there is a compiler which supports C++11 but does not support #pragma once.
114 lines
3.1 KiB
C++
114 lines
3.1 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <iosfwd>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
#if !defined(CMAKE_USE_ELF_PARSER)
|
|
# error "This file may be included only if CMAKE_USE_ELF_PARSER is enabled."
|
|
#endif
|
|
|
|
class cmELFInternal;
|
|
|
|
/** \class cmELF
|
|
* \brief Executable and Link Format (ELF) parser.
|
|
*/
|
|
class cmELF
|
|
{
|
|
public:
|
|
/** Construct with the name of the ELF input file to parse. */
|
|
cmELF(const char* fname);
|
|
|
|
/** Destruct. */
|
|
~cmELF();
|
|
|
|
cmELF(const cmELF&) = delete;
|
|
cmELF& operator=(const cmELF&) = delete;
|
|
|
|
/** Get the error message if any. */
|
|
std::string const& GetErrorMessage() const { return this->ErrorMessage; }
|
|
|
|
/** Boolean conversion. True if the ELF file is valid. */
|
|
explicit operator bool() const { return this->Valid(); }
|
|
|
|
/** Enumeration of ELF file types. */
|
|
enum FileType
|
|
{
|
|
FileTypeInvalid,
|
|
FileTypeRelocatableObject,
|
|
FileTypeExecutable,
|
|
FileTypeSharedLibrary,
|
|
FileTypeCore,
|
|
FileTypeSpecificOS,
|
|
FileTypeSpecificProc
|
|
};
|
|
|
|
/** Represent string table entries. */
|
|
struct StringEntry
|
|
{
|
|
// The string value itself.
|
|
std::string Value;
|
|
|
|
// The position in the file at which the string appears.
|
|
unsigned long Position;
|
|
|
|
// The size of the string table entry. This includes the space
|
|
// allocated for one or more null terminators.
|
|
unsigned long Size;
|
|
|
|
// The index of the section entry referencing the string.
|
|
int IndexInSection;
|
|
};
|
|
|
|
/** Represent entire dynamic section header */
|
|
using DynamicEntryList = std::vector<std::pair<long, unsigned long>>;
|
|
|
|
/** Get the type of the file opened. */
|
|
FileType GetFileType() const;
|
|
|
|
/** Get the number of ELF sections present. */
|
|
unsigned int GetNumberOfSections() const;
|
|
|
|
/** Get the position of a DYNAMIC section header entry. Returns
|
|
zero on error. */
|
|
unsigned long GetDynamicEntryPosition(int index) const;
|
|
|
|
/** Get a copy of all the DYNAMIC section header entries.
|
|
Returns an empty vector on error */
|
|
DynamicEntryList GetDynamicEntries() const;
|
|
|
|
/** Encodes a DYNAMIC section header entry list into a char vector according
|
|
to the type of ELF file this is */
|
|
std::vector<char> EncodeDynamicEntries(
|
|
const DynamicEntryList& entries) const;
|
|
|
|
/** Get the SONAME field if any. */
|
|
bool GetSOName(std::string& soname);
|
|
StringEntry const* GetSOName();
|
|
|
|
/** Get the RPATH field if any. */
|
|
StringEntry const* GetRPath();
|
|
|
|
/** Get the RUNPATH field if any. */
|
|
StringEntry const* GetRunPath();
|
|
|
|
/** Print human-readable information about the ELF file. */
|
|
void PrintInfo(std::ostream& os) const;
|
|
|
|
/** Interesting dynamic tags.
|
|
If the tag is 0, it does not exist in the host ELF implementation */
|
|
static const long TagRPath, TagRunPath, TagMipsRldMapRel;
|
|
|
|
private:
|
|
friend class cmELFInternal;
|
|
bool Valid() const;
|
|
std::unique_ptr<cmELFInternal> Internal;
|
|
std::string ErrorMessage;
|
|
};
|