1 /*******************************************************************************
2 * Copyright (c) 2015 EfficiOS Inc., Alexandre Montplaisir
4 * All rights reserved. This program and the accompanying materials
5 * are made available under the terms of the Eclipse Public License v1.0
6 * which accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
8 *******************************************************************************/
10 package org
.eclipse
.tracecompass
.internal
.lttng2
.ust
.core
.analysis
.debuginfo
;
12 import static org
.eclipse
.tracecompass
.common
.core
.NonNullUtils
.checkNotNull
;
14 import java
.io
.BufferedReader
;
16 import java
.io
.IOException
;
17 import java
.io
.InputStreamReader
;
18 import java
.nio
.file
.Files
;
19 import java
.util
.Arrays
;
20 import java
.util
.Collections
;
21 import java
.util
.LinkedList
;
22 import java
.util
.List
;
23 import java
.util
.logging
.Logger
;
24 import java
.util
.stream
.Collectors
;
26 import org
.eclipse
.jdt
.annotation
.NonNull
;
27 import org
.eclipse
.jdt
.annotation
.Nullable
;
28 import org
.eclipse
.tracecompass
.common
.core
.log
.TraceCompassLog
;
29 import org
.eclipse
.tracecompass
.tmf
.core
.event
.lookup
.TmfCallsite
;
31 import com
.google
.common
.base
.Objects
;
32 import com
.google
.common
.cache
.CacheBuilder
;
33 import com
.google
.common
.cache
.CacheLoader
;
34 import com
.google
.common
.cache
.LoadingCache
;
35 import com
.google
.common
.collect
.Iterables
;
38 * Utility class to get file name, function/symbol name and line number from a
39 * given offset. In TMF this is represented as a {@link TmfCallsite}.
41 * @author Alexandre Montplaisir
43 public final class FileOffsetMapper
{
45 private static final Logger LOGGER
= TraceCompassLog
.getLogger(FileOffsetMapper
.class);
47 private static final String DISCRIMINATOR
= "\\(discriminator.*\\)"; //$NON-NLS-1$
48 private static final String ADDR2LINE_EXECUTABLE
= "addr2line"; //$NON-NLS-1$
50 private static final long CACHE_SIZE
= 1000;
52 private FileOffsetMapper() {}
55 * Class representing an offset in a specific file
57 private static class FileOffset
{
59 private final String fFilePath
;
60 private final @Nullable String fBuildId
;
61 private final long fOffset
;
63 public FileOffset(String filePath
, @Nullable String buildId
, long offset
) {
70 public int hashCode() {
71 return Objects
.hashCode(fFilePath
, fBuildId
, fOffset
);
75 public boolean equals(@Nullable Object obj
) {
82 if (getClass() != obj
.getClass()) {
85 FileOffset other
= (FileOffset
) obj
;
86 return Objects
.equal(fFilePath
, other
.fFilePath
) &&
87 Objects
.equal(fBuildId
, other
.fBuildId
) &&
88 Objects
.equal(fOffset
, other
.fOffset
);
92 public String
toString() {
93 return Objects
.toStringHelper(this)
94 .add("fFilePath", fFilePath
) //$NON-NLS-1$
95 .add("fBuildId", fBuildId
) //$NON-NLS-1$
96 .add("fOffset", String
.format("0x%h", fOffset
)) //$NON-NLS-1$ //$NON-NLS-2$
103 * Generate the callsite from a given binary file and address offset.
105 * Due to function inlining, it is possible for one offset to actually have
106 * multiple call sites. We will return the most precise one (inner-most) we
110 * The binary file to look at
112 * The expected buildId of the binary file (is not verified at
115 * The memory offset in the file
116 * @return The corresponding call site
118 public static @Nullable TmfCallsite
getCallsiteFromOffset(File file
, @Nullable String buildId
, long offset
) {
119 Iterable
<Addr2lineInfo
> output
= getAddr2lineInfo(file
, buildId
, offset
);
120 if (output
== null || Iterables
.isEmpty(output
)) {
123 Addr2lineInfo info
= Iterables
.getLast(output
);
124 String sourceFile
= info
.fSourceFileName
;
125 Long sourceLine
= info
.fSourceLineNumber
;
127 if (sourceFile
== null) {
128 /* Not enough information to provide a callsite */
131 return new TmfCallsite(sourceFile
, sourceLine
);
135 * Get the function/symbol name corresponding to binary file and offset.
138 * The binary file to look at
140 * The expected buildId of the binary file (is not verified at
143 * The memory offset in the file
144 * @return The corresponding function/symbol name
146 public static @Nullable String
getFunctionNameFromOffset(File file
, @Nullable String buildId
, long offset
) {
148 * TODO We are currently also using 'addr2line' to resolve function
149 * names, which requires the binary's DWARF information to be available.
150 * A better approach would be to use the binary's symbol table (if it is
151 * not stripped), since this is usually more readily available than
154 Iterable
<Addr2lineInfo
> output
= getAddr2lineInfo(file
, buildId
, offset
);
155 if (output
== null || Iterables
.isEmpty(output
)) {
158 Addr2lineInfo info
= Iterables
.getLast(output
);
159 return info
.fFunctionName
;
162 // ------------------------------------------------------------------------
163 // Utility methods making use of 'addr2line'
164 // ------------------------------------------------------------------------
167 * Value used in addr2line output to represent unknown function names or
170 private static final String UNKNOWN_VALUE
= "??"; //$NON-NLS-1$
173 * Cache of all calls to 'addr2line', so that we can avoid recalling the
174 * external process repeatedly.
176 * It is static, meaning one cache for the whole application, since the
177 * symbols in a file on disk are independent from the trace referring to it.
179 private static final LoadingCache
<FileOffset
, @NonNull Iterable
<Addr2lineInfo
>> ADDR2LINE_INFO_CACHE
;
181 ADDR2LINE_INFO_CACHE
= checkNotNull(CacheBuilder
.newBuilder()
182 .maximumSize(CACHE_SIZE
)
183 .build(new CacheLoader
<FileOffset
, @NonNull Iterable
<Addr2lineInfo
>>() {
185 public @NonNull Iterable
<Addr2lineInfo
> load(FileOffset fo
) {
186 LOGGER
.fine(() -> "[FileOffsetMapper:CacheMiss] file/offset=" + fo
.toString()); //$NON-NLS-1$
187 return callAddr2line(fo
);
192 private static class Addr2lineInfo
{
194 private final @Nullable String fSourceFileName
;
195 private final @Nullable Long fSourceLineNumber
;
196 private final @Nullable String fFunctionName
;
198 public Addr2lineInfo(@Nullable String sourceFileName
, @Nullable String functionName
, @Nullable Long sourceLineNumber
) {
199 fSourceFileName
= sourceFileName
;
200 fSourceLineNumber
= sourceLineNumber
;
201 fFunctionName
= functionName
;
205 public String
toString() {
206 return Objects
.toStringHelper(this)
207 .add("fSourceFileName", fSourceFileName
) //$NON-NLS-1$
208 .add("fSourceLineNumber", fSourceLineNumber
) //$NON-NLS-1$
209 .add("fFunctionName", fFunctionName
) //$NON-NLS-1$
214 private static @Nullable Iterable
<Addr2lineInfo
> getAddr2lineInfo(File file
, @Nullable String buildId
, long offset
) {
215 LOGGER
.finer(() -> String
.format("[FileOffsetMapper:Addr2lineRequest] file=%s, buildId=%s, offset=0x%h", //$NON-NLS-1$
216 file
.toString(), buildId
, offset
));
218 if (!Files
.exists((file
.toPath()))) {
219 LOGGER
.finer(() -> "[FileOffsetMapper:RequestFailed] File not found"); //$NON-NLS-1$
222 // TODO We should also eventually verify that the passed buildId matches
223 // the file we are attempting to open.
224 FileOffset fo
= new FileOffset(checkNotNull(file
.toString()), buildId
, offset
);
226 @Nullable Iterable
<Addr2lineInfo
> callsites
= ADDR2LINE_INFO_CACHE
.getUnchecked(fo
);
227 LOGGER
.finer(() -> String
.format("[FileOffsetMapper:RequestComplete] callsites=%s", callsites
)); //$NON-NLS-1$
231 private static Iterable
<Addr2lineInfo
> callAddr2line(FileOffset fo
) {
232 String filePath
= fo
.fFilePath
;
233 long offset
= fo
.fOffset
;
235 List
<Addr2lineInfo
> callsites
= new LinkedList
<>();
237 // FIXME Could eventually use CDT's Addr2line class once it implements --inlines
238 List
<String
> output
= getOutputFromCommand(Arrays
.asList(
239 ADDR2LINE_EXECUTABLE
, "-i", "-f", "-C", "-e", filePath
, "0x" + Long
.toHexString(offset
))); //$NON-NLS-1$//$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$
241 if (output
== null) {
242 /* Command returned an error */
243 return Collections
.EMPTY_SET
;
247 * When passing the -f flag, the output alternates between function
248 * names and file/line location.
250 boolean oddLine
= false; // We flip at the start, first loop will be odd
251 String currentFunctionName
= null;
252 for (String outputLine
: output
) {
253 /* Flip the boolean for the following line */
256 // Remove discriminator part, for example: /build/buildd/glibc-2.21/elf/dl-object.c:78 (discriminator 8)
257 outputLine
= outputLine
.replaceFirst(DISCRIMINATOR
, "").trim(); //$NON-NLS-1$
260 /* This is a line indicating the function name */
261 if (outputLine
.equals(UNKNOWN_VALUE
)) {
262 currentFunctionName
= null;
264 currentFunctionName
= outputLine
;
267 /* This is a line indicating a call site */
268 String
[] elems
= outputLine
.split(":"); //$NON-NLS-1$
269 String fileName
= elems
[0];
270 if (fileName
.equals(UNKNOWN_VALUE
)) {
275 lineNumber
= Long
.valueOf(elems
[1]);
276 } catch (NumberFormatException e
) {
277 /* Probably a '?' output, meaning unknown line number. */
280 callsites
.add(new Addr2lineInfo(fileName
, currentFunctionName
, lineNumber
));
287 private static @Nullable List
<String
> getOutputFromCommand(List
<String
> command
) {
289 ProcessBuilder builder
= new ProcessBuilder(command
);
290 builder
.redirectErrorStream(true);
292 Process p
= builder
.start();
293 try (BufferedReader br
= new BufferedReader(new InputStreamReader(p
.getInputStream()));) {
294 int ret
= p
.waitFor();
295 List
<String
> lines
= br
.lines().collect(Collectors
.toList());
297 return (ret
== 0 ? lines
: null);
299 } catch (IOException
| InterruptedException e
) {