diff options
-rw-r--r-- | llvm/tools/dsymutil/BinaryHolder.h | 18 | ||||
-rw-r--r-- | llvm/tools/dsymutil/DebugMap.h | 20 | ||||
-rw-r--r-- | llvm/tools/dsymutil/MachODebugMapParser.cpp | 5 | ||||
-rw-r--r-- | llvm/tools/dsymutil/dsymutil.h | 9 |
4 files changed, 23 insertions, 29 deletions
diff --git a/llvm/tools/dsymutil/BinaryHolder.h b/llvm/tools/dsymutil/BinaryHolder.h index 0d3c6d2b69a..f3ab7f6726a 100644 --- a/llvm/tools/dsymutil/BinaryHolder.h +++ b/llvm/tools/dsymutil/BinaryHolder.h @@ -26,17 +26,15 @@ namespace llvm { namespace dsymutil { -/// \brief The BinaryHolder class is responsible for creating and -/// owning ObjectFile objects and their underlying MemoryBuffer. This -/// is different from a simple OwningBinary in that it handles -/// accessing to archive members. +/// The BinaryHolder class is responsible for creating and owning ObjectFile +/// objects and their underlying MemoryBuffer. This is different from a simple +/// OwningBinary in that it handles accessing to archive members. /// -/// As an optimization, this class will reuse an already mapped and -/// parsed Archive object if 2 successive requests target the same -/// archive file (Which is always the case in debug maps). -/// Currently it only owns one memory buffer at any given time, -/// meaning that a mapping request will invalidate the previous memory -/// mapping. +/// As an optimization, this class will reuse an already mapped and parsed +/// Archive object if 2 successive requests target the same archive file (Which +/// is always the case in debug maps). +/// Currently it only owns one memory buffer at any given time, meaning that a +/// mapping request will invalidate the previous memory mapping. class BinaryHolder { std::vector<std::unique_ptr<object::Archive>> CurrentArchives; std::unique_ptr<MemoryBuffer> CurrentMemoryBuffer; diff --git a/llvm/tools/dsymutil/DebugMap.h b/llvm/tools/dsymutil/DebugMap.h index 0a38657b9b8..b30385fefba 100644 --- a/llvm/tools/dsymutil/DebugMap.h +++ b/llvm/tools/dsymutil/DebugMap.h @@ -48,10 +48,9 @@ namespace dsymutil { class DebugMapObject; -/// \brief The DebugMap object stores the list of object files to -/// query for debug information along with the mapping between the -/// symbols' addresses in the object file to their linked address in -/// the linked binary. +/// The DebugMap object stores the list of object files to query for debug +/// information along with the mapping between the symbols' addresses in the +/// object file to their linked address in the linked binary. /// /// A DebugMap producer could look like this: /// DebugMap *DM = new DebugMap(); @@ -125,10 +124,9 @@ public: parseYAMLDebugMap(StringRef InputFile, StringRef PrependPath, bool Verbose); }; -/// \brief The DebugMapObject represents one object file described by -/// the DebugMap. It contains a list of mappings between addresses in -/// the object file and in the linked binary for all the linked atoms -/// in this object file. +/// The DebugMapObject represents one object file described by the DebugMap. It +/// contains a list of mappings between addresses in the object file and in the +/// linked binary for all the linked atoms in this object file. class DebugMapObject { public: struct SymbolMapping { @@ -150,17 +148,17 @@ public: using YAMLSymbolMapping = std::pair<std::string, SymbolMapping>; using DebugMapEntry = StringMapEntry<SymbolMapping>; - /// \brief Adds a symbol mapping to this DebugMapObject. + /// Adds a symbol mapping to this DebugMapObject. /// \returns false if the symbol was already registered. The request /// is discarded in this case. bool addSymbol(StringRef SymName, Optional<uint64_t> ObjectAddress, uint64_t LinkedAddress, uint32_t Size); - /// \brief Lookup a symbol mapping. + /// Lookup a symbol mapping. /// \returns null if the symbol isn't found. const DebugMapEntry *lookupSymbol(StringRef SymbolName) const; - /// \brief Lookup an objectfile address. + /// Lookup an object file address. /// \returns null if the address isn't found. const DebugMapEntry *lookupObjectAddress(uint64_t Address) const; diff --git a/llvm/tools/dsymutil/MachODebugMapParser.cpp b/llvm/tools/dsymutil/MachODebugMapParser.cpp index e75a41a699c..2b16b0c7457 100644 --- a/llvm/tools/dsymutil/MachODebugMapParser.cpp +++ b/llvm/tools/dsymutil/MachODebugMapParser.cpp @@ -27,9 +27,8 @@ public: PathPrefix(PathPrefix), MainBinaryHolder(Verbose), CurrentObjectHolder(Verbose), CurrentDebugMapObject(nullptr) {} - /// \brief Parses and returns the DebugMaps of the input binary. - /// The binary contains multiple maps in case it is a universal - /// binary. + /// Parses and returns the DebugMaps of the input binary. The binary contains + /// multiple maps in case it is a universal binary. /// \returns an error in case the provided BinaryPath doesn't exist /// or isn't of a supported type. ErrorOr<std::vector<std::unique_ptr<DebugMap>>> parse(); diff --git a/llvm/tools/dsymutil/dsymutil.h b/llvm/tools/dsymutil/dsymutil.h index 10ae5646737..709a480e1e2 100644 --- a/llvm/tools/dsymutil/dsymutil.h +++ b/llvm/tools/dsymutil/dsymutil.h @@ -54,20 +54,19 @@ struct LinkOptions { LinkOptions() = default; }; -/// \brief Extract the DebugMaps from the given file. +/// Extract the DebugMaps from the given file. /// The file has to be a MachO object file. Multiple debug maps can be /// returned when the file is universal (aka fat) binary. ErrorOr<std::vector<std::unique_ptr<DebugMap>>> parseDebugMap(StringRef InputFile, ArrayRef<std::string> Archs, StringRef PrependPath, bool Verbose, bool InputIsYAML); -/// \brief Dump the symbol table +/// Dump the symbol table bool dumpStab(StringRef InputFile, ArrayRef<std::string> Archs, StringRef PrependPath = ""); -/// \brief Link the Dwarf debug info as directed by the passed DebugMap -/// \p DM into a DwarfFile named \p OutputFilename. -/// \returns false if the link failed. +/// Link the Dwarf debug info as directed by the passed DebugMap \p DM into a +/// DwarfFile named \p OutputFilename. \returns false if the link failed. bool linkDwarf(raw_fd_ostream &OutFile, const DebugMap &DM, const LinkOptions &Options); |