1/* SPDX-License-Identifier: GPL-2.0 */
 2#ifndef __PERF_LLVM_C_HELPERS
 3#define __PERF_LLVM_C_HELPERS 1
 4
 5/*
 6 * Helpers to call into LLVM C++ code from C, for the parts that do not have
 7 * C APIs.
 8 */
 9
10#include <linux/compiler.h>
11
12#ifdef __cplusplus
13extern "C" {
14#endif
15
16struct dso;
17
18struct llvm_a2l_frame {
19  char* filename;
20  char* funcname;
21  unsigned int line;
22};
23
24/*
25 * Implement addr2line() using libLLVM. LLVM is a C++ API, and
26 * many of the linux/ headers cannot be included in a C++ compile unit,
27 * so we need to make a little bridge code here. llvm_addr2line() will
28 * convert the inline frame information from LLVM's internal structures
29 * and put them into a flat array given in inline_frames. The caller
30 * is then responsible for taking that array and convert it into perf's
31 * regular inline frame structures (which depend on e.g. struct list_head).
32 *
33 * If the address could not be resolved, or an error occurred (e.g. OOM),
34 * returns 0. Otherwise, returns the number of inline frames (which means 1
35 * if the address was not part of an inlined function). If unwind_inlines
36 * is set and the return code is nonzero, inline_frames will be set to
37 * a newly allocated array with that length. The caller is then responsible
38 * for freeing both the strings and the array itself.
39 */
40int llvm_addr2line(const char* dso_name,
41                   u64 addr,
42                   char** file,
43                   unsigned int* line,
44                   bool unwind_inlines,
45                   struct llvm_a2l_frame** inline_frames);
46
47/*
48 * Simple symbolizers for addresses; will convert something like
49 * 0x12345 to "func+0x123". Will return NULL if no symbol was found.
50 *
51 * The returned value must be freed by the caller, with free().
52 */
53char *llvm_name_for_code(struct dso *dso, const char *dso_name, u64 addr);
54char *llvm_name_for_data(struct dso *dso, const char *dso_name, u64 addr);
55
56#ifdef __cplusplus
57}
58#endif
59
60#endif /* __PERF_LLVM_C_HELPERS */