xref: /freebsd-src/contrib/llvm-project/llvm/include/llvm/DebugInfo/GSYM/ObjectFileTransformer.h (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
15ffd83dbSDimitry Andric //===- ObjectFileTransformer.h ----------------------------------*- C++ -*-===//
25ffd83dbSDimitry Andric //
35ffd83dbSDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
45ffd83dbSDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
55ffd83dbSDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
65ffd83dbSDimitry Andric //
75ffd83dbSDimitry Andric //===----------------------------------------------------------------------===//
85ffd83dbSDimitry Andric 
95ffd83dbSDimitry Andric #ifndef LLVM_DEBUGINFO_GSYM_OBJECTFILETRANSFORMER_H
105ffd83dbSDimitry Andric #define LLVM_DEBUGINFO_GSYM_OBJECTFILETRANSFORMER_H
115ffd83dbSDimitry Andric 
125ffd83dbSDimitry Andric #include "llvm/Support/Error.h"
135ffd83dbSDimitry Andric 
145ffd83dbSDimitry Andric namespace llvm {
155ffd83dbSDimitry Andric 
165ffd83dbSDimitry Andric namespace object {
175ffd83dbSDimitry Andric class ObjectFile;
185ffd83dbSDimitry Andric }
195ffd83dbSDimitry Andric 
205ffd83dbSDimitry Andric namespace gsym {
215ffd83dbSDimitry Andric 
225ffd83dbSDimitry Andric class GsymCreator;
23*0fca6ea1SDimitry Andric class OutputAggregator;
245ffd83dbSDimitry Andric 
255ffd83dbSDimitry Andric class ObjectFileTransformer {
265ffd83dbSDimitry Andric public:
275ffd83dbSDimitry Andric   /// Extract any object file data that is needed by the GsymCreator.
285ffd83dbSDimitry Andric   ///
295ffd83dbSDimitry Andric   /// The extracted information includes the UUID of the binary and converting
305ffd83dbSDimitry Andric   /// all function symbols from any symbol tables into FunctionInfo objects.
315ffd83dbSDimitry Andric   ///
325ffd83dbSDimitry Andric   /// \param Obj The object file that contains the DWARF debug info.
335ffd83dbSDimitry Andric   ///
345f757f3fSDimitry Andric   /// \param Log The stream to log warnings and non fatal issues to. If NULL,
355f757f3fSDimitry Andric   ///            don't log.
365ffd83dbSDimitry Andric   ///
375ffd83dbSDimitry Andric   /// \param Gsym The GSYM creator to populate with the function information
385ffd83dbSDimitry Andric   /// from the debug info.
395ffd83dbSDimitry Andric   ///
405ffd83dbSDimitry Andric   /// \returns An error indicating any fatal issues that happen when parsing
415ffd83dbSDimitry Andric   /// the DWARF, or Error::success() if all goes well.
42*0fca6ea1SDimitry Andric   static llvm::Error convert(const object::ObjectFile &Obj,
43*0fca6ea1SDimitry Andric                              OutputAggregator &Output, GsymCreator &Gsym);
445ffd83dbSDimitry Andric };
455ffd83dbSDimitry Andric 
465ffd83dbSDimitry Andric } // namespace gsym
475ffd83dbSDimitry Andric } // namespace llvm
485ffd83dbSDimitry Andric 
49fe6060f1SDimitry Andric #endif // LLVM_DEBUGINFO_GSYM_OBJECTFILETRANSFORMER_H
50