xref: /freebsd/contrib/llvm-project/llvm/include/llvm/DebugInfo/GSYM/ObjectFileTransformer.h (revision 700637cbb5e582861067a11aaca4d053546871d2)
1 //===- ObjectFileTransformer.h ----------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_DEBUGINFO_GSYM_OBJECTFILETRANSFORMER_H
10 #define LLVM_DEBUGINFO_GSYM_OBJECTFILETRANSFORMER_H
11 
12 #include "llvm/Support/Compiler.h"
13 #include "llvm/Support/Error.h"
14 
15 namespace llvm {
16 
17 namespace object {
18 class ObjectFile;
19 }
20 
21 namespace gsym {
22 
23 class GsymCreator;
24 class OutputAggregator;
25 
26 class ObjectFileTransformer {
27 public:
28   /// Extract any object file data that is needed by the GsymCreator.
29   ///
30   /// The extracted information includes the UUID of the binary and converting
31   /// all function symbols from any symbol tables into FunctionInfo objects.
32   ///
33   /// \param Obj The object file that contains the DWARF debug info.
34   ///
35   /// \param Log The stream to log warnings and non fatal issues to. If NULL,
36   ///            don't log.
37   ///
38   /// \param Gsym The GSYM creator to populate with the function information
39   /// from the debug info.
40   ///
41   /// \returns An error indicating any fatal issues that happen when parsing
42   /// the DWARF, or Error::success() if all goes well.
43   LLVM_ABI static llvm::Error convert(const object::ObjectFile &Obj,
44                                       OutputAggregator &Output,
45                                       GsymCreator &Gsym);
46 };
47 
48 } // namespace gsym
49 } // namespace llvm
50 
51 #endif // LLVM_DEBUGINFO_GSYM_OBJECTFILETRANSFORMER_H
52